\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename python.info
@documentencoding UTF-8
@ifinfo
@*Generated by Sphinx 8.1.3.@*
@end ifinfo
@settitle Python
@defindex ge
@paragraphindent 0
@exampleindent 4
@finalout
@dircategory Miscellaneous
@direntry
* python: (python.info). One line description of project
@end direntry

@c %**end of header

@copying
@quotation
Python 3.14.0a1, noviembre 17, 2024

Author name not set

Copyright @copyright{} 2001 Python Software Foundation
@end quotation

@end copying

@titlepage
@title Python
@insertcopying
@end titlepage
@contents

@c %** start of user preamble

@c %** end of user preamble

@ifnottex
@node Top
@top Python
@insertcopying
@end ifnottex

@c %**start of body
@anchor{contents doc}@anchor{134}
@menu
* Qué hay de nuevo en Python:: 
* El tutorial de Python:: 
* Configuración y uso de Python:: 
* Referencia del Lenguaje Python:: 
* La biblioteca estándar de Python:: 
* Ampliación e incrustación del intérprete de Python:: 
* Manual de referencia de la API en C de Python:: 
* Instalando módulos de Python:: 
* Comos (HOWTOs) de Python: Comos HOWTOs de Python. 
* Preguntas más frecuentes de Python:: 
* Deprecations:: 
* Glosario:: 
* Acerca de estos documentos:: 
* Lidiar con errores:: 
* Derechos de autor:: 
* Historia y Licencia:: 
* Índice de Módulos Python:: 
* Índice:: 

@detailmenu
 --- The Detailed Node Listing ---

Qué hay de nuevo en Python

* What’s new in Python 3.14: What’s new in Python 3 14. 
* What’s New In Python 3.13: What’s New In Python 3 13. 
* Novedades de Python 3.12: Novedades de Python 3 12. 
* Qué hay de nuevo en Python 3.11: Qué hay de nuevo en Python 3 11. 
* Qué hay de nuevo en Python 3.10: Qué hay de nuevo en Python 3 10. 
* Qué hay de nuevo en Python 3.9: Qué hay de nuevo en Python 3 9. 
* Qué hay de nuevo en Python 3.8: Qué hay de nuevo en Python 3 8. 
* Qué hay de nuevo en Python 3.7: Qué hay de nuevo en Python 3 7. 
* Qué hay de nuevo en Python 3.6: Qué hay de nuevo en Python 3 6. 
* Qué hay de nuevo en Python 3.5: Qué hay de nuevo en Python 3 5. 
* Qué hay de nuevo en Python 3.4: Qué hay de nuevo en Python 3 4. 
* Qué hay de nuevo en Python 3.3: Qué hay de nuevo en Python 3 3. 
* Qué hay de nuevo en Python 3.2: Qué hay de nuevo en Python 3 2. 
* Qué hay de nuevo en Python 3.1: Qué hay de nuevo en Python 3 1. 
* Qué hay de nuevo en Python 3.0: Qué hay de nuevo en Python 3 0. 
* Qué hay de nuevo en Python 2.7: Qué hay de nuevo en Python 2 7. 
* Qué hay de nuevo en Python 2.6: Qué hay de nuevo en Python 2 6. 
* Qué hay de nuevo en Python 2.5: Qué hay de nuevo en Python 2 5. 
* Qué hay de nuevo en Python 2.4: Qué hay de nuevo en Python 2 4. 
* Qué hay de nuevo en Python 2.3: Qué hay de nuevo en Python 2 3. 
* Qué hay de nuevo en Python 2.2: Qué hay de nuevo en Python 2 2. 
* Qué hay de nuevo en Python 2.1: Qué hay de nuevo en Python 2 1. 
* Qué hay de nuevo en Python 2.0: Qué hay de nuevo en Python 2 0. 
* Registro de cambios:: 

What’s new in Python 3.14

* Summary – release highlights:: 
* New features:: 
* Other language changes:: 
* New modules:: 
* Improved modules:: 
* Optimizations:: 
* Deprecated:: 
* Removed:: 
* Porting to Python 3.14: Porting to Python 3 14. 
* Build changes:: 
* C API changes:: 

New features

* PEP 649; deferred evaluation of annotations: PEP 649 deferred evaluation of annotations. 
* Improved error messages:: 

PEP 649: deferred evaluation of annotations

* Implications for annotated code:: 
* Implications for readers of __annotations__:: 
* Related changes:: 
* from __future__ import annotations:: 

Improved modules

* argparse:: 
* ast:: 
* concurrent.futures: concurrent futures. 
* ctypes:: 
* decimal:: 
* datetime:: 
* dis:: 
* fractions:: 
* functools:: 
* getopt:: 
* http:: 
* inspect:: 
* json:: 
* mimetypes:: 
* multiprocessing:: 
* operator:: 
* os:: 
* pathlib:: 
* platform:: 
* pdb:: 
* pickle:: 
* pydoc:: 
* symtable:: 
* sys:: 
* unicodedata:: 
* unittest:: 
* uuid:: 

Optimizations

* asyncio:: 
* io:: 

Deprecated

* Pending removal in Python 3.15: Pending removal in Python 3 15. 
* Pending removal in Python 3.16: Pending removal in Python 3 16. 
* Pending removal in future versions:: 

Removed

* argparse: argparse<2>. 
* ast: ast<2>. 
* asyncio: asyncio<2>. 
* collections.abc: collections abc. 
* email:: 
* importlib:: 
* itertools:: 
* pathlib: pathlib<2>. 
* pkgutil:: 
* pty:: 
* sqlite3:: 
* typing:: 
* urllib:: 
* Others:: 

Porting to Python 3.14

* Changes in the Python API:: 

Build changes

* PEP 761; Discontinuation of PGP signatures: PEP 761 Discontinuation of PGP signatures. 

C API changes

* New features: New features<2>. 
* Porting to Python 3.14: Porting to Python 3 14<2>. 
* Deprecated: Deprecated<2>. 
* Removed: Removed<2>. 

Deprecated

* Pending removal in Python 3.15: Pending removal in Python 3 15<2>. 
* Pending removal in future versions: Pending removal in future versions<2>. 

What’s New In Python 3.13

* Summary – Release Highlights:: 
* New Features:: 
* Other Language Changes:: 
* New Modules:: 
* Improved Modules:: 
* Optimizations: Optimizations<2>. 
* Removed Modules And APIs:: 
* New Deprecations:: 
* CPython Bytecode Changes:: 
* C API Changes:: 
* Build Changes:: 
* Porting to Python 3.13: Porting to Python 3 13. 
* Regression Test Changes:: 

New Features

* A better interactive interpreter:: 
* Improved error messages: Improved error messages<2>. 
* Free-threaded CPython:: 
* An experimental just-in-time (JIT) compiler: An experimental just-in-time JIT compiler. 
* Defined mutation semantics for locals(): Defined mutation semantics for locals. 
* Support for mobile platforms:: 

Improved Modules

* argparse: argparse<3>. 
* array:: 
* ast: ast<3>. 
* asyncio: asyncio<3>. 
* base64:: 
* compileall:: 
* concurrent.futures: concurrent futures<2>. 
* configparser:: 
* copy:: 
* ctypes: ctypes<2>. 
* dbm:: 
* dis: dis<2>. 
* doctest:: 
* email: email<2>. 
* fractions: fractions<2>. 
* glob:: 
* importlib: importlib<2>. 
* io: io<2>. 
* ipaddress:: 
* itertools: itertools<2>. 
* marshal:: 
* math:: 
* mimetypes: mimetypes<2>. 
* mmap:: 
* multiprocessing: multiprocessing<2>. 
* os: os<2>. 
* os.path: os path. 
* pathlib: pathlib<3>. 
* pdb: pdb<2>. 
* queue:: 
* random:: 
* re:: 
* shutil:: 
* site:: 
* sqlite3: sqlite3<2>. 
* ssl:: 
* statistics:: 
* subprocess:: 
* sys: sys<2>. 
* tempfile:: 
* time:: 
* tkinter:: 
* traceback:: 
* types:: 
* typing: typing<2>. 
* unicodedata: unicodedata<2>. 
* venv:: 
* warnings:: 
* xml:: 
* zipimport:: 

Removed Modules And APIs

* PEP 594; Remove «dead batteries» from the standard library: PEP 594 Remove «dead batteries» from the standard library. 
* 2to3:: 
* builtins:: 
* configparser: configparser<2>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* pathlib: pathlib<4>. 
* re: re<2>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<3>. 
* unittest: unittest<2>. 
* urllib: urllib<2>. 
* webbrowser:: 

New Deprecations

* Pending removal in Python 3.14: Pending removal in Python 3 14. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<3>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<2>. 
* Pending removal in future versions: Pending removal in future versions<3>. 

C API Changes

* New Features: New Features<2>. 
* Changed C APIs:: 
* Limited C API Changes:: 
* Removed C APIs:: 
* Deprecated C APIs:: 

Deprecated C APIs

* Pending removal in Python 3.14: Pending removal in Python 3 14<2>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<4>. 
* Pending removal in future versions: Pending removal in future versions<4>. 

Porting to Python 3.13

* Changes in the Python API: Changes in the Python API<2>. 
* Changes in the C API:: 

Novedades de Python 3.12

* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión. 
* Nuevas características:: 
* Nuevas funciones relacionadas con las sugerencias de escritura:: 
* Otros cambios del lenguaje:: 
* Nuevos módulos:: 
* Módulos mejorados:: 
* Optimizaciones:: 
* Cambios en el código de bytes de CPython:: 
* Demostraciones y herramientas:: 
* Obsoleto:: 
* Eliminado:: 
* Portar a Python 3.12: Portar a Python 3 12. 
* Cambios de compilación:: 
* Cambios en la API de C:: 

Nuevas características

* PEP 695; Sintaxis de parámetro de tipo: PEP 695 Sintaxis de parámetro de tipo. 
* PEP 701; Formalización sintáctica de cadenas f: PEP 701 Formalización sintáctica de cadenas f. 
* PEP 684; un GIL por intérprete: PEP 684 un GIL por intérprete. 
* PEP 669; Monitoreo de bajo impacto para CPython: PEP 669 Monitoreo de bajo impacto para CPython. 
* PEP 688; Hacer accesible el protocolo de búfer en Python: PEP 688 Hacer accesible el protocolo de búfer en Python. 
* PEP 709; Integración de la comprensión: PEP 709 Integración de la comprensión. 
* Mensajes de error mejorados:: 

Nuevas funciones relacionadas con las sugerencias de escritura

* PEP 692; uso de TypedDict para una escritura **kwargs más precisa: PEP 692 uso de TypedDict para una escritura **kwargs más precisa. 
* PEP 698; Decorador override para escritura estática: PEP 698 Decorador override para escritura estática. 

Módulos mejorados

* array: array<2>. 
* asincio:: 
* calendar:: 
* csv:: 
* dis: dis<3>. 
* fractions: fractions<3>. 
* importlib.resources: importlib resources. 
* inspect: inspect<2>. 
* itertools: itertools<3>. 
* math: math<2>. 
* os: os<3>. 
* os.path: os path<2>. 
* pathlib: pathlib<5>. 
* pbd:: 
* random: random<2>. 
* shutil: shutil<2>. 
* sqlite3: sqlite3<3>. 
* statistics: statistics<2>. 
* sys: sys<3>. 
* tempfile: tempfile<2>. 
* threading:: 
* tkinter: tkinter<2>. 
* tokenize:: 
* types: types<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<3>. 
* uuid: uuid<2>. 

Obsoleto

* Pending removal in Python 3.13: Pending removal in Python 3 13. 
* Pending removal in Python 3.14: Pending removal in Python 3 14<3>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<5>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<3>. 
* Pending removal in future versions: Pending removal in future versions<5>. 

Eliminado

* asynchat y asyncore:: 
* configparser: configparser<3>. 
* distutils:: 
* ensurepip:: 
* enum:: 
* ftplib:: 
* gzip:: 
* hashlib:: 
* importlib: importlib<3>. 
* imp:: 
* io: io<3>. 
* locale: locale<2>. 
* smtpd:: 
* sqlite3: sqlite3<4>. 
* ssl: ssl<2>. 
* unittest: unittest<4>. 
* webbrowser: webbrowser<2>. 
* xml.etree.ElementTree: xml etree ElementTree. 
* zipimport: zipimport<2>. 
* Otros:: 

Portar a Python 3.12

* Cambios en la API de Python:: 

Cambios en la API de C

* Nuevas características: Nuevas características<2>. 
* Portar a Python 3.12: Portar a Python 3 12<2>. 
* Obsoleto: Obsoleto<2>. 
* Eliminado: Eliminado<2>. 

Obsoleto

* Pending removal in Python 3.14: Pending removal in Python 3 14<4>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<6>. 
* Pending removal in future versions: Pending removal in future versions<6>. 

Qué hay de nuevo en Python 3.11

* Resumen – Aspectos destacados de la versión:: 
* Nuevas características: Nuevas características<3>. 
* Nuevas funciones relacionadas con las sugerencias de tipo:: 
* Otros cambios de idioma:: 
* Otros cambios en la implementación de CPython:: 
* Nuevos Módulos:: 
* Módulos mejorados: Módulos mejorados<2>. 
* Optimizaciones: Optimizaciones<2>. 
* CPython más rápido:: 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<2>. 
* Obsoleto: Obsoleto<3>. 
* Eliminación pendiente en Python 3.12: Eliminación pendiente en Python 3 12. 
* Remoto:: 
* Migración a Python 3.11: Migración a Python 3 11. 
* Construir cambios:: 
* Cambios en la API de C: Cambios en la API de C<2>. 
* Notable changes in 3.11.4: Notable changes in 3 11 4. 
* Notable changes in 3.11.5: Notable changes in 3 11 5. 

Nuevas características

* PEP 657; Ubicaciones de errores detallados en rastreos: PEP 657 Ubicaciones de errores detallados en rastreos. 
* PEP 654; Grupos de excepción y except*: PEP 654 Grupos de excepción y except*. 
* PEP 678; Las excepciones se pueden enriquecer con notas: PEP 678 Las excepciones se pueden enriquecer con notas. 
* Mejoras en el iniciador de Windows py.exe: Mejoras en el iniciador de Windows py exe. 

Nuevas funciones relacionadas con las sugerencias de tipo

* PEP 646; Genéricos Variádicos: PEP 646 Genéricos Variádicos. 
* PEP 655; Marcado de elementos TypedDict individuales como requeridos o no requeridos: PEP 655 Marcado de elementos TypedDict individuales como requeridos o no requeridos. 
* PEP 673; tipo Self: PEP 673 tipo Self. 
* PEP 675; tipo de cadena literal arbitraria: PEP 675 tipo de cadena literal arbitraria. 
* PEP 681; Transformaciones de clases de datos: PEP 681 Transformaciones de clases de datos. 
* PEP 563 puede no ser el futuro:: 

Módulos mejorados

* asíncio:: 
* contextlib:: 
* clases de datos:: 
* fecha y hora:: 
* enumeración:: 
* fcntl:: 
* fracciones:: 
* herramientas funcionales:: 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE y libre de inactividad:: 
* inspeccionar:: 
* lugar:: 
* Inicio sesión:: 
* Matemáticas:: 
* operador:: 
* sistema operativo:: 
* rutalib:: 
* re: re<3>. 
* cerrar:: 
* enchufe:: 
* sqlite3: sqlite3<5>. 
* cuerda:: 
* sistema:: 
* configuración del sistema:: 
* archivo temporal:: 
* enhebrar:: 
* tiempo:: 
* tkinter: tkinter<3>. 
* rastrear:: 
* mecanografía:: 
* unicodedata: unicodedata<4>. 
* prueba de unidad:: 
* venv: venv<2>. 
* advertencias:: 
* archivo zip:: 

CPython más rápido

* Inicio más rápido:: 
* Tiempo de ejecución más rápido:: 
* Varios:: 
* Preguntas más frecuentes:: 
* Sobre:: 

Inicio más rápido

* Importaciones congeladas / Objetos de código estático:: 

Tiempo de ejecución más rápido

* Marcos de Python más baratos y perezosos:: 
* Llamadas a funciones de Python en línea:: 
* PEP 659; Intérprete Adaptativo Especializado: PEP 659 Intérprete Adaptativo Especializado. 

Preguntas más frecuentes

* ¿Cómo debo escribir mi código para utilizar estas aceleraciones?:: 
* ¿CPython 3.11 usará más memoria?: ¿CPython 3 11 usará más memoria?. 
* No veo ninguna aceleración en mi carga de trabajo. ¿Por qué?: No veo ninguna aceleración en mi carga de trabajo ¿Por qué?. 
* ¿Existe un compilador JIT?:: 

Cambios en el código de bytes de CPython

* Nuevos códigos de operación:: 
* Códigos de operación reemplazados:: 
* Códigos de operación cambiados/eliminados:: 

Obsoleto

* Idioma/Construidos:: 
* Módulos:: 
* Biblioteca estándar:: 

Cambios en la API de C

* Nuevas características: Nuevas características<4>. 
* Migración a Python 3.11: Migración a Python 3 11<2>. 
* Obsoleto: Obsoleto<4>. 
* Eliminación pendiente en Python 3.12: Eliminación pendiente en Python 3 12<2>. 
* Remoto: Remoto<2>. 

Notable changes in 3.11.4

* tarfile:: 

Notable changes in 3.11.5

* OpenSSL:: 

Qué hay de nuevo en Python 3.10

* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<2>. 
* Nuevas características: Nuevas características<5>. 
* Nuevas funciones relacionadas con las sugerencias de tipos:: 
* Otros cambios de idioma: Otros cambios de idioma<2>. 
* Nuevos módulos: Nuevos módulos<2>. 
* Módulos mejorados: Módulos mejorados<3>. 
* Optimizaciones: Optimizaciones<3>. 
* Obsoleto: Obsoleto<5>. 
* Eliminado: Eliminado<3>. 
* Portar a Python 3.10: Portar a Python 3 10. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<3>. 
* Construir cambios: Construir cambios<2>. 
* Cambios en la API de C: Cambios en la API de C<4>. 
* Notable security feature in 3.10.7: Notable security feature in 3 10 7. 
* Notable security feature in 3.10.8: Notable security feature in 3 10 8. 
* Notable changes in 3.10.12: Notable changes in 3 10 12. 

Nuevas características

* Administradores de contexto entre paréntesis:: 
* Mejores mensajes de error:: 
* PEP 626; números de línea precisos para depuración y otras herramientas: PEP 626 números de línea precisos para depuración y otras herramientas. 
* PEP 634; Coincidencia de patrones estructurales: PEP 634 Coincidencia de patrones estructurales. 
* Opción opcional EncodingWarning y encoding="locale":: 

Mejores mensajes de error

* SyntaxErrors:: 
* Errores de sangría:: 
* AttributeErrors:: 
* NameErrors:: 

PEP 634: Coincidencia de patrones estructurales

* Sintaxis y operaciones:: 
* Enfoque declarativo:: 
* Patrón simple; coincidir con un literal: Patrón simple coincidir con un literal. 
* Patrones con un literal y una variable:: 
* Patrones y clases:: 
* Patrones anidados:: 
* Patrones complejos y el comodín:: 
* Guardia:: 
* Otras características clave:: 

Patrón simple: coincidir con un literal

* Comportamiento sin el comodín:: 

Patrones y clases

* Patrones con parámetros posicionales:: 

Nuevas funciones relacionadas con las sugerencias de tipos

* PEP 604; Nuevo tipo de operador unión: PEP 604 Nuevo tipo de operador unión. 
* PEP 612; Variables de especificación de parámetros: PEP 612 Variables de especificación de parámetros. 
* PEP 613; TypeAlias: PEP 613 TypeAlias. 
* PEP 647; protectores de tipo definidos por el usuario: PEP 647 protectores de tipo definidos por el usuario. 

Módulos mejorados

* asyncio: asyncio<4>. 
* argumentar:: 
* formación:: 
* asynchat@comma{} asyncore@comma{} smtpd: asynchat asyncore smtpd. 
* base64: base64<2>. 
* bdb:: 
* bisecar:: 
* códecs:: 
* colecciones.abc: colecciones abc. 
* contextlib: contextlib<2>. 
* maldiciones:: 
* clases de datos: clases de datos<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* codificaciones:: 
* enum: enum<2>. 
* entrada de archivo:: 
* manipulador de faltas:: 
* GC:: 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac:: 
* IDLE e idlelib:: 
* importlib.metadata: importlib metadata<2>. 
* inspeccionar: inspeccionar<2>. 
* itertools: itertools<4>. 
* caché de línea:: 
* os: os<4>. 
* os.path: os path<3>. 
* Pathlib:: 
* plataforma:: 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* dejar de lado:: 
* Estadísticas:: 
* sitio:: 
* enchufe: enchufe<2>. 
* ssl: ssl<3>. 
* sqlite3: sqlite3<6>. 
* sys: sys<4>. 
* _hilo:: 
* enhebrar: enhebrar<2>. 
* rastrear: rastrear<2>. 
* tipos:: 
* mecanografía: mecanografía<2>. 
* prueba de unidad: prueba de unidad<2>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

clases de datos

* __slots__:: 
* Campos solo de palabras clave:: 

Portar a Python 3.10

* Cambios en la sintaxis de Python:: 
* Cambios en la API de Python: Cambios en la API de Python<2>. 
* Cambios en la API de C: Cambios en la API de C<3>. 

Cambios en la API de C

* PEP 652; Mantenimiento del ABI estable: PEP 652 Mantenimiento del ABI estable. 
* Nuevas características: Nuevas características<6>. 
* Portar a Python 3.10: Portar a Python 3 10<2>. 
* Obsoleto: Obsoleto<6>. 
* Eliminado: Eliminado<4>. 

Notable changes in 3.10.12

* tarfile: tarfile<2>. 

Qué hay de nuevo en Python 3.9

* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<3>. 
* Debe verificar DeprecationWarning en su código:: 
* Nuevas características: Nuevas características<7>. 
* Otros cambios de idioma: Otros cambios de idioma<3>. 
* Nuevos módulos: Nuevos módulos<3>. 
* Módulos mejorados: Módulos mejorados<4>. 
* Optimizaciones: Optimizaciones<4>. 
* Obsoleto: Obsoleto<7>. 
* Remoto: Remoto<3>. 
* Portar a Python 3.9: Portar a Python 3 9. 
* Construir cambios: Construir cambios<3>. 
* Cambios en la API de C: Cambios en la API de C<6>. 
* Cambios notables en Python 3.9.1: Cambios notables en Python 3 9 1. 
* Cambios notables en Python 3.9.2: Cambios notables en Python 3 9 2. 
* Notable changes in Python 3.9.3: Notable changes in Python 3 9 3. 
* Notable changes in Python 3.9.5: Notable changes in Python 3 9 5. 
* Notable security feature in 3.9.14: Notable security feature in 3 9 14. 
* Notable changes in 3.9.17: Notable changes in 3 9 17. 

Nuevas características

* Operadores de combinación y actualización de diccionarios:: 
* Nuevos métodos de cadena para eliminar prefijos y sufijos:: 
* Tipos genéricos de sugerencia en colecciones estándar:: 
* Nuevo analizador:: 

Nuevos módulos

* zoneinfo:: 
* Graphlib:: 

Módulos mejorados

* ast: ast<4>. 
* asyncio: asyncio<5>. 
* compilar todo:: 
* Futuros concurrentes:: 
* maldiciones: maldiciones<2>. 
* fecha y hora: fecha y hora<2>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* GC: GC<2>. 
* hashlib: hashlib<4>. 
* http: http<2>. 
* IDLE e idlelib: IDLE e idlelib<2>. 
* imaplib:: 
* importlib: importlib<4>. 
* inspeccionar: inspeccionar<3>. 
* dirección IP:: 
* Matemáticas: Matemáticas<2>. 
* multiprocesamiento:: 
* nntplib:: 
* os: os<5>. 
* Pathlib: Pathlib<2>. 
* pdb: pdb<3>. 
* poplib:: 
* pprint: pprint<2>. 
* Pydoc:: 
* aleatorio:: 
* señal:: 
* smtplib:: 
* enchufe: enchufe<3>. 
* tiempo: tiempo<2>. 
* sys: sys<5>. 
* tracemalloc:: 
* mecanografía: mecanografía<3>. 
* unicodedata: unicodedata<5>. 
* venv: venv<3>. 
* xml: xml<3>. 

Portar a Python 3.9

* Cambios en la API de Python: Cambios en la API de Python<3>. 
* Cambios en la API de C: Cambios en la API de C<5>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<4>. 

Cambios en la API de C

* Nuevas características: Nuevas características<8>. 
* Portar a Python 3.9: Portar a Python 3 9<2>. 
* Remoto: Remoto<4>. 

Cambios notables en Python 3.9.1

* mecanografía: mecanografía<4>. 
* Compatibilidad con macOS 11.0 (Big Sur) y Apple Silicon Mac: Compatibilidad con macOS 11 0 Big Sur y Apple Silicon Mac. 

Cambios notables en Python 3.9.2

* colecciones.abc: colecciones abc<2>. 
* urllib.parse: urllib parse<2>. 

Notable changes in Python 3.9.5

* urllib.parse: urllib parse<3>. 

Notable changes in 3.9.17

* tarfile: tarfile<3>. 

Qué hay de nuevo en Python 3.8

* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<2>. 
* Nuevas características: Nuevas características<9>. 
* Otros cambios en el lenguaje:: 
* Nuevos módulos: Nuevos módulos<4>. 
* Módulos mejorados: Módulos mejorados<5>. 
* Optimizaciones: Optimizaciones<5>. 
* Cambios en la compilación y la API de C:: 
* Obsoleto: Obsoleto<8>. 
* APIs y características eliminadas:: 
* Portando a Python 3.8: Portando a Python 3 8. 
* Cambios notables en Python 3.8.1: Cambios notables en Python 3 8 1. 
* Notable changes in Python 3.8.2: Notable changes in Python 3 8 2. 
* Notable changes in Python 3.8.3: Notable changes in Python 3 8 3. 
* Cambios notables en Python 3.8.8: Cambios notables en Python 3 8 8. 
* Notable changes in Python 3.8.9: Notable changes in Python 3 8 9. 
* Notable changes in Python 3.8.10: Notable changes in Python 3 8 10. 
* Notable changes in Python 3.8.10: Notable changes in Python 3 8 10<2>. 
* Cambios notables en Python 3.8.1: Cambios notables en Python 3 8 1<2>. 
* Notable security feature in 3.8.14: Notable security feature in 3 8 14. 
* Notable changes in 3.8.17: Notable changes in 3 8 17. 

Nuevas características

* Expresiones de asignación:: 
* Parámetros solo posicionales:: 
* Caché del sistema de archivos paralelo para archivos de bytecode compilados:: 
* La compilación de depuración usa la misma ABI que la compilación de lanzamiento:: 
* los f-strings soportan = para expresiones autodocumentadas y depuración:: 
* PEP 578; Ganchos de auditoría en tiempo de ejecución de Python: PEP 578 Ganchos de auditoría en tiempo de ejecución de Python. 
* PEP 587; Configuración de inicialización de Python: PEP 587 Configuración de inicialización de Python. 
* PEP 590; Vectorcall; un protocolo de llamada rápida para CPython: PEP 590 Vectorcall un protocolo de llamada rápida para CPython. 
* Protocolo 5 de Pickle con búferes de datos fuera de banda:: 

Módulos mejorados

* ast: ast<5>. 
* asyncio: asyncio<6>. 
* builtins: builtins<2>. 
* collections:: 
* cProfile:: 
* csv: csv<2>. 
* curses:: 
* ctypes: ctypes<3>. 
* datetime: datetime<2>. 
* functools: functools<2>. 
* gc:: 
* gettext:: 
* gzip: gzip<3>. 
* IDLE e idlelib: IDLE e idlelib<3>. 
* inspect: inspect<3>. 
* io: io<4>. 
* itertools: itertools<5>. 
* json.tool: json tool. 
* logging:: 
* math: math<3>. 
* mmap: mmap<2>. 
* multiprocessing: multiprocessing<3>. 
* os: os<6>. 
* os.path: os path<4>. 
* pathlib: pathlib<6>. 
* pickle: pickle<2>. 
* plistlib:: 
* pprint: pprint<3>. 
* py_compile: py_compile<2>. 
* shlex:: 
* shutil: shutil<3>. 
* socket:: 
* ssl: ssl<4>. 
* statistics: statistics<3>. 
* sys: sys<6>. 
* tarfile: tarfile<4>. 
* threading: threading<2>. 
* tokenize: tokenize<2>. 
* tkinter: tkinter<4>. 
* time: time<2>. 
* typing: typing<5>. 
* unicodedata: unicodedata<6>. 
* unittest: unittest<5>. 
* venv: venv<4>. 
* weakref:: 
* xml: xml<4>. 
* xmlrpc:: 

Portando a Python 3.8

* Cambios en el comportamiento de Python:: 
* Cambios en la API de Python: Cambios en la API de Python<4>. 
* Cambios en la API de C: Cambios en la API de C<7>. 
* Cambios en el bytecode de CPython:: 
* Demos y herramientas:: 

Notable changes in Python 3.8.10

* macOS 11.0 (Big Sur) and Apple Silicon Mac support: macOS 11 0 Big Sur and Apple Silicon Mac support. 

Notable changes in Python 3.8.10

* urllib.parse: urllib parse<4>. 

Cambios notables en Python 3.8.1

* Cambios en la API de Python: Cambios en la API de Python<5>. 

Notable changes in 3.8.17

* tarfile: tarfile<5>. 

Qué hay de nuevo en Python 3.7

* Resumen – Lanzamientos Destacados:: 
* Nuevas Características:: 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<2>. 
* Nuevos módulos: Nuevos módulos<5>. 
* Módulos mejorados: Módulos mejorados<6>. 
* Cambios en la API C:: 
* Construir cambios: Construir cambios<4>. 
* Optimizaciones: Optimizaciones<6>. 
* Otros cambios de implementación de CPython:: 
* Comportamiento obsoleto de Python:: 
* Módulos@comma{} funciones y métodos de Python obsoletos: Módulos funciones y métodos de Python obsoletos. 
* Funciones y tipos obsoletos de la API C:: 
* Eliminación de soporte de plataforma:: 
* Eliminaciones de API y funciones:: 
* Eliminaciones de módulos:: 
* Cambios solo en Windows:: 
* Portando a Python 3.7: Portando a Python 3 7. 
* Cambios notables en Python 3.7.1: Cambios notables en Python 3 7 1. 
* Cambios notables en Python 3.7.2: Cambios notables en Python 3 7 2. 
* Cambios notables en Python 3.7.6: Cambios notables en Python 3 7 6. 
* Cambios notables en Python 3.7.10: Cambios notables en Python 3 7 10. 
* Notable changes in Python 3.7.11: Notable changes in Python 3 7 11. 
* Notable security feature in 3.7.14: Notable security feature in 3 7 14. 

Nuevas Características

* PEP 563; Evaluación pospuesta de anotaciones: PEP 563 Evaluación pospuesta de anotaciones. 
* PEP 538; Coerción de configuración regional del Legado de C: PEP 538 Coerción de configuración regional del Legado de C. 
* PEP 540; Modo de tiempo de ejecución UTF-8 forzado: PEP 540 Modo de tiempo de ejecución UTF-8 forzado. 
* PEP 553; Incorporada en breakpoint(): PEP 553 Incorporada en breakpoint. 
* PEP 539; Nueva API C para almacenamiento local de subprocesos: PEP 539 Nueva API C para almacenamiento local de subprocesos. 
* PEP 562; Personalización del acceso a los atributos del módulo: PEP 562 Personalización del acceso a los atributos del módulo. 
* PEP 564; Nuevas funciones de tiempo con resolución de nanosegundos: PEP 564 Nuevas funciones de tiempo con resolución de nanosegundos. 
* PEP 565; Mostrar DeprecationWarning en __main__: PEP 565 Mostrar DeprecationWarning en __main__. 
* PEP 560; Soporte básico para el módulo de typing y tipos genéricos: PEP 560 Soporte básico para el módulo de typing y tipos genéricos. 
* PEP 552; Archivos .pyc basados en hash: PEP 552 Archivos pyc basados en hash. 
* PEP 545; Traducciones de Documentaciones de Python: PEP 545 Traducciones de Documentaciones de Python. 
* Modo de desarrollo de Python (-X dev): Modo de desarrollo de Python -X dev. 

Nuevos módulos

* contextvars:: 
* dataclasses:: 
* importlib.resources: importlib resources<2>. 

Módulos mejorados

* argparse: argparse<4>. 
* asyncio: asyncio<7>. 
* binascii:: 
* calendar: calendar<2>. 
* collections: collections<2>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<3>. 
* contextlib: contextlib<3>. 
* cProfile: cProfile<2>. 
* crypt:: 
* datetime: datetime<3>. 
* dbm: dbm<2>. 
* decimal: decimal<2>. 
* dis: dis<4>. 
* distutils: distutils<4>. 
* enum: enum<3>. 
* functools: functools<3>. 
* gc: gc<2>. 
* hmac: hmac<2>. 
* http.client: http client. 
* http.server: http server. 
* idlelib and IDLE:: 
* importlib: importlib<5>. 
* io: io<5>. 
* ipaddress: ipaddress<2>. 
* itertools: itertools<6>. 
* locale: locale<3>. 
* logging: logging<2>. 
* math: math<4>. 
* mimetypes: mimetypes<3>. 
* msilib:: 
* multiprocessing: multiprocessing<4>. 
* os: os<7>. 
* pathlib: pathlib<7>. 
* pdb: pdb<4>. 
* py_compile: py_compile<3>. 
* pydoc: pydoc<2>. 
* queue: queue<2>. 
* re: re<4>. 
* signal:: 
* socket: socket<2>. 
* socketserver:: 
* sqlite3: sqlite3<7>. 
* ssl: ssl<5>. 
* string:: 
* subprocess: subprocess<2>. 
* sys: sys<7>. 
* time: time<3>. 
* tkinter: tkinter<5>. 
* tracemalloc: tracemalloc<2>. 
* types: types<3>. 
* unicodedata: unicodedata<7>. 
* unittest: unittest<6>. 
* unittest.mock: unittest mock. 
* urllib.parse: urllib parse<5>. 
* uu:: 
* uuid: uuid<3>. 
* warnings: warnings<2>. 
* xml: xml<5>. 
* xml.etree: xml etree. 
* xmlrpc.server: xmlrpc server. 
* zipapp:: 
* zipfile:: 

Módulos, funciones y métodos de Python obsoletos

* aifc:: 
* asyncio: asyncio<8>. 
* collections: collections<3>. 
* dbm: dbm<3>. 
* enum: enum<4>. 
* gettext: gettext<2>. 
* importlib: importlib<6>. 
* locale: locale<4>. 
* macpath:: 
* threading: threading<3>. 
* socket: socket<3>. 
* ssl: ssl<6>. 
* sunau:: 
* sys: sys<8>. 
* wave:: 

Portando a Python 3.7

* Cambios en el comportamiento de Python: Cambios en el comportamiento de Python<2>. 
* Cambios en la API Python:: 
* Cambios en la API de C: Cambios en la API de C<8>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<5>. 
* Cambios solo en Windows: Cambios solo en Windows<2>. 
* Otra implementación de cambios en CPython:: 

Qué hay de nuevo en Python 3.6

* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<4>. 
* Nuevas características: Nuevas características<10>. 
* Otros cambios de idioma: Otros cambios de idioma<4>. 
* Nuevos módulos: Nuevos módulos<6>. 
* Módulos mejorados: Módulos mejorados<7>. 
* Optimizaciones: Optimizaciones<7>. 
* Cambios en la API de Build y C:: 
* Otras mejoras:: 
* Obsoleto: Obsoleto<9>. 
* Remoto: Remoto<5>. 
* Portar a Python 3.6: Portar a Python 3 6. 
* Cambios notables en Python 3.6.2: Cambios notables en Python 3 6 2. 
* Cambios notables en Python 3.6.4: Cambios notables en Python 3 6 4. 
* Cambios notables en Python 3.6.5: Cambios notables en Python 3 6 5. 
* Cambios notables en Python 3.6.7: Cambios notables en Python 3 6 7. 
* Cambios notables en Python 3.6.10: Cambios notables en Python 3 6 10. 
* Cambios notables en Python 3.6.13: Cambios notables en Python 3 6 13. 
* Notable changes in Python 3.6.14: Notable changes in Python 3 6 14. 

Nuevas características

* PEP 498; Literales de cadena formateados: PEP 498 Literales de cadena formateados. 
* PEP 526; Sintaxis para anotaciones de variables: PEP 526 Sintaxis para anotaciones de variables. 
* PEP 515; subrayados en literales numéricos: PEP 515 subrayados en literales numéricos. 
* PEP 525; Generadores asíncronos: PEP 525 Generadores asíncronos. 
* PEP 530; Comprensiones asincrónicas: PEP 530 Comprensiones asincrónicas. 
* PEP 487; personalización más sencilla de la creación de clases: PEP 487 personalización más sencilla de la creación de clases. 
* PEP 487; Mejoras en el protocolo descriptor: PEP 487 Mejoras en el protocolo descriptor. 
* PEP 519; Agregar un protocolo de ruta del sistema de archivos: PEP 519 Agregar un protocolo de ruta del sistema de archivos. 
* PEP 495; desambiguación de la hora local: PEP 495 desambiguación de la hora local. 
* PEP 529; cambie la codificación del sistema de archivos de Windows a UTF-8: PEP 529 cambie la codificación del sistema de archivos de Windows a UTF-8. 
* PEP 528; cambie la codificación de la consola de Windows a UTF-8: PEP 528 cambie la codificación de la consola de Windows a UTF-8. 
* PEP 520; Conservación del orden de definición de atributos de clase: PEP 520 Conservación del orden de definición de atributos de clase. 
* PEP 468; Conservación del orden de los argumentos de las palabras clave: PEP 468 Conservación del orden de los argumentos de las palabras clave. 
* Nueva implementación de dict:: 
* PEP 523; Agregar una API de evaluación de marcos a CPython: PEP 523 Agregar una API de evaluación de marcos a CPython. 
* Variable de entorno PYTHONMALLOC:: 
* Soporte de sondeo DTrace y SystemTap:: 

Nuevos módulos

* misterios:: 

Módulos mejorados

* formación: formación<2>. 
* ast: ast<6>. 
* asyncio: asyncio<9>. 
* binascii: binascii<2>. 
* cmath:: 
* colecciones:: 
* Futuros concurrentes: Futuros concurrentes<2>. 
* contextlib: contextlib<4>. 
* fecha y hora: fecha y hora<3>. 
* decimal: decimal<3>. 
* distutils: distutils<5>. 
* Email:: 
* codificaciones: codificaciones<2>. 
* enumeración: enumeración<2>. 
* manipulador de faltas: manipulador de faltas<2>. 
* entrada de archivo: entrada de archivo<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib y IDLE:: 
* importlib: importlib<7>. 
* inspeccionar: inspeccionar<4>. 
* json: json<2>. 
* Inicio sesión: Inicio sesión<2>. 
* Matemáticas: Matemáticas<3>. 
* multiprocesamiento: multiprocesamiento<2>. 
* os: os<8>. 
* Pathlib: Pathlib<3>. 
* pdb: pdb<5>. 
* pepinillo:: 
* pepinillos:: 
* Pydoc: Pydoc<2>. 
* aleatorio: aleatorio<2>. 
* re: re<5>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* sitio: sitio<2>. 
* sqlite3: sqlite3<8>. 
* enchufe: enchufe<4>. 
* servidor de sockets:: 
* ssl: ssl<7>. 
* Estadísticas: Estadísticas<2>. 
* estructura:: 
* subproceso:: 
* sys: sys<9>. 
* telnetlib:: 
* tiempo: tiempo<3>. 
* cronométralo:: 
* tkinter: tkinter<6>. 
* rastrear: rastrear<3>. 
* tracemalloc: tracemalloc<3>. 
* mecanografía: mecanografía<5>. 
* unicodedata: unicodedata<8>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* advertencias: advertencias<2>. 
* winreg:: 
* winsonido:: 
* xmlrpc.client: xmlrpc client. 
* archivo zip: archivo zip<2>. 
* zlib:: 

Obsoleto

* Nuevas palabras clave:: 
* Comportamiento de Python obsoleto:: 
* Módulos@comma{} funciones y métodos de Python obsoletos: Módulos funciones y métodos de Python obsoletos<2>. 
* xml: xml<6>. 
* Funciones y tipos obsoletos de la API de C:: 
* Opciones de compilación obsoletas:: 

Módulos, funciones y métodos de Python obsoletos

* asynchat:: 
* asyncore:: 
* dbm: dbm<4>. 
* distutils: distutils<6>. 
* grp:: 
* importlib: importlib<8>. 
* os: os<9>. 
* re: re<6>. 
* ssl: ssl<8>. 
* tkinter: tkinter<7>. 
* venv: venv<6>. 

Remoto

* Eliminaciones de API y funciones: Eliminaciones de API y funciones<2>. 

Portar a Python 3.6

* Cambios en el comportamiento del comando “python”:: 
* Cambios en la API de Python: Cambios en la API de Python<6>. 
* Cambios en la API de C: Cambios en la API de C<9>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<6>. 

Cambios notables en Python 3.6.2

* Nuevo objetivo de compilación make regen-all:: 
* Eliminación del objetivo de compilación make touch:: 

Qué hay de nuevo en Python 3.5

* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<3>. 
* Nuevas características: Nuevas características<11>. 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<3>. 
* Nuevos módulos: Nuevos módulos<7>. 
* Módulos mejorados: Módulos mejorados<8>. 
* Otros cambios a nivel de módulo:: 
* Optimizaciones: Optimizaciones<8>. 
* Cambios en la compilación y la API de C: Cambios en la compilación y la API de C<2>. 
* Obsoleto: Obsoleto<10>. 
* Eliminado: Eliminado<5>. 
* Portando a Python 3.5: Portando a Python 3 5. 
* Cambios notables en Python 3.5.4: Cambios notables en Python 3 5 4. 

Nuevas características

* PEP 492 - Corrutinas con sintaxis async y await:: 
* PEP 465 - Un operador infijo dedicado para la multiplicación de matrices:: 
* PEP 448 - Generalizaciones de desembalaje adicionales:: 
* PEP 461 - soporte de formateo porcentual para bytes y bytearray:: 
* PEP 484 - Indicador de tipos:: 
* PEP 471 - Función os.scandir() – un iterador de directorio mejor y más rápido: PEP 471 - Función os scandir – un iterador de directorio mejor y más rápido. 
* PEP 475; Reintentar las llamadas al sistema que fallan con EINTR: PEP 475 Reintentar las llamadas al sistema que fallan con EINTR. 
* PEP 479; Cambiar el gestor de StopIteration dentro de generadores: PEP 479 Cambiar el gestor de StopIteration dentro de generadores. 
* PEP 485; Una función para probar la igualdad aproximada: PEP 485 Una función para probar la igualdad aproximada. 
* PEP 486; Hacer que el launcher de Python sea consciente de los entornos virtuales: PEP 486 Hacer que el launcher de Python sea consciente de los entornos virtuales. 
* PEP 488; Eliminación de archivos PYO: PEP 488 Eliminación de archivos PYO. 
* PEP 489; Inicialización del módulo de extensión multifase: PEP 489 Inicialización del módulo de extensión multifase. 

Nuevos módulos

* typing: typing<6>. 
* zipapp: zipapp<2>. 

Módulos mejorados

* argparse: argparse<5>. 
* asyncio: asyncio<10>. 
* bz2:: 
* cgi:: 
* cmath: cmath<2>. 
* code:: 
* collections: collections<4>. 
* collections.abc: collections abc<2>. 
* compileall: compileall<3>. 
* concurrent.futures: concurrent futures<4>. 
* configparser: configparser<4>. 
* contextlib: contextlib<5>. 
* csv: csv<3>. 
* curses: curses<2>. 
* dbm: dbm<5>. 
* difflib:: 
* distutils: distutils<7>. 
* doctest: doctest<3>. 
* email: email<3>. 
* enum: enum<5>. 
* faulthandler:: 
* functools: functools<4>. 
* glob: glob<3>. 
* gzip: gzip<4>. 
* heapq:: 
* http: http<3>. 
* http.client: http client<3>. 
* idlelib e IDLE:: 
* imaplib: imaplib<2>. 
* imghdr:: 
* importlib: importlib<9>. 
* inspect: inspect<4>. 
* io: io<6>. 
* ipaddress: ipaddress<3>. 
* json: json<3>. 
* linecache:: 
* locale: locale<5>. 
* logging: logging<3>. 
* lzma:: 
* math: math<5>. 
* multiprocessing: multiprocessing<5>. 
* operator: operator<2>. 
* os: os<10>. 
* pathlib: pathlib<8>. 
* pickle: pickle<3>. 
* poplib: poplib<2>. 
* re: re<7>. 
* readline: readline<2>. 
* selectors:: 
* shutil: shutil<4>. 
* signal: signal<2>. 
* smtpd: smtpd<2>. 
* smtplib: smtplib<2>. 
* sndhdr:: 
* socket: socket<4>. 
* ssl: ssl<9>. 
* sqlite3: sqlite3<9>. 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* sysconfig:: 
* tarfile: tarfile<6>. 
* threading: threading<4>. 
* time: time<4>. 
* timeit:: 
* tkinter: tkinter<8>. 
* traceback: traceback<2>. 
* types: types<4>. 
* unicodedata: unicodedata<9>. 
* unittest: unittest<7>. 
* unittest.mock: unittest mock<3>. 
* urllib: urllib<3>. 
* wsgiref:: 
* xmlrpc: xmlrpc<2>. 
* xml.sax: xml sax. 
* zipfile: zipfile<2>. 

ssl

* Soporte de memoria BIO:: 
* Soporte de negociación de protocolo de capa de aplicación:: 
* Otros cambios:: 

Obsoleto

* Nuevas palabras clave: Nuevas palabras clave<2>. 
* Comportamiento obsoleto de Python: Comportamiento obsoleto de Python<2>. 
* Sistemas operativos no compatibles:: 
* Módulos@comma{} funciones y métodos obsoletos de Python: Módulos funciones y métodos obsoletos de Python. 

Eliminado

* APIs y características eliminadas: APIs y características eliminadas<2>. 

Portando a Python 3.5

* Cambios en el comportamiento de Python: Cambios en el comportamiento de Python<3>. 
* Cambios en la API de Python: Cambios en la API de Python<7>. 
* Cambios en la API de C: Cambios en la API de C<10>. 

Cambios notables en Python 3.5.4

* Nuevo objetivo de compilación make regen-all: Nuevo objetivo de compilación make regen-all<2>. 
* Eliminación del objetivo de compilación make touch: Eliminación del objetivo de compilación make touch<2>. 

Qué hay de nuevo en Python 3.4

* Resumen – Puntos destacados del lanzamiento:: 
* Nuevas Funciones:: 
* Nuevos Módulos: Nuevos Módulos<2>. 
* Módulos mejorados: Módulos mejorados<9>. 
* Cambios en la implementación de CPython:: 
* Obsoleto: Obsoleto<11>. 
* Removido:: 
* Adaptación a Python 3.4: Adaptación a Python 3 4. 
* Cambiado en 3.4.3: Cambiado en 3 4 3. 

Nuevas Funciones

* PEP 453; Arranque explícito de PIP en instalaciones de Python: PEP 453 Arranque explícito de PIP en instalaciones de Python. 
* PEP 446; Los descriptores de archivos recién creados no son heredables: PEP 446 Los descriptores de archivos recién creados no son heredables. 
* Mejoras en el manejo de códecs:: 
* PEP 451; Un tipo ModuleSpec para el sistema de importación: PEP 451 Un tipo ModuleSpec para el sistema de importación. 
* Otros cambios de lenguaje:: 

PEP 453: Arranque explícito de PIP en instalaciones de Python

* Puesta en marcha de pip por defecto:: 
* Cambios en la documentación:: 

Nuevos Módulos

* asyncio: asyncio<11>. 
* ensurepip: ensurepip<2>. 
* enum: enum<6>. 
* pathlib: pathlib<9>. 
* selectores:: 
* estadísticas:: 
* tracemalloc: tracemalloc<4>. 

Módulos mejorados

* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<6>. 
* audioop:: 
* base64: base64<3>. 
* colecciones: colecciones<2>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<5>. 
* doctest: doctest<4>. 
* email: email<4>. 
* archivoecmp:: 
* functools: functools<5>. 
* gc: gc<3>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<3>. 
* html:: 
* http: http<4>. 
* idlelib y IDLE: idlelib y IDLE<2>. 
* importlib: importlib<10>. 
* inspeccionar: inspeccionar<5>. 
* dirección IP: dirección IP<2>. 
* Tres mejoras más pequeñas en el módulo logging@comma{} todas implementadas por Vinay Sajip@comma{} son;: Tres mejoras más pequeñas en el módulo logging todas implementadas por Vinay Sajip son. 
* mariscal:: 
* mmap: mmap<3>. 
* multiprocesamiento: multiprocesamiento<3>. 
* PEP 465@comma{} un nuevo operador de multiplicación de matrices; a @@ b.: PEP 465 un nuevo operador de multiplicación de matrices a @@ b. 
* os: os<11>. 
* pdb: pdb<6>. 
* pepinillo: pepinillo<2>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty: pty<2>. 
* pydoc: pydoc<3>. 
* re: re<8>. 
* recurso:: 
* seleccionar:: 
* estante:: 
* shutil: shutil<5>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* enchufe: enchufe<5>. 
* sqlite3: sqlite3<10>. 
* ssl: ssl<10>. 
* stat:: 
* struct:: 
* subproceso: subproceso<2>. 
* sunau: sunau<2>. 
* sys: sys<11>. 
* tarfile: tarfile<7>. 
* textwrap:: 
* roscado:: 
* traceback: traceback<3>. 
* tipos: tipos<2>. 
* urllib: urllib<4>. 
* unittest: unittest<8>. 
* venv: venv<7>. 
* onda:: 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* archivo zip: archivo zip<3>. 

Cambios en la implementación de CPython

* PEP 445; Personalización de los Asignadores de Memoria de CPython: PEP 445 Personalización de los Asignadores de Memoria de CPython. 
* PEP 442; Finalización segura de objetos: PEP 442 Finalización segura de objetos. 
* PEP 456; Algoritmo Hash seguro e intercambiable: PEP 456 Algoritmo Hash seguro e intercambiable. 
* PEP 436; Clínica de Argumentación: PEP 436 Clínica de Argumentación. 
* Otros cambios en la API de construcción y C:: 
* Otras mejoras: Otras mejoras<2>. 
* Optimizaciones significativas:: 

Obsoleto

* Desapariciones en la API de Python:: 
* Funciones obsoletas:: 

Removido

* Sistemas operativos que ya no son compatibles:: 
* Eliminación de la API y de las funciones:: 
* Limpieza del código:: 

Adaptación a Python 3.4

* Cambios en el comportamiento del comando “python”: Cambios en el comportamiento del comando “python”<2>. 
* Cambios en la API de Python: Cambios en la API de Python<8>. 
* Cambios en la API de C: Cambios en la API de C<11>. 

Cambiado en 3.4.3

* PEP 476; Habilitar la verificación de certificados por defecto para los clientes http stdlib: PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib. 

Qué hay de nuevo en Python 3.3

* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<4>. 
* PEP 405; Entornos virtuales: PEP 405 Entornos virtuales. 
* PEP 420; Paquetes para espacios de nombres implícitos: PEP 420 Paquetes para espacios de nombres implícitos. 
* PEP 3118; Nueva implementación de vista de memoria y en la documentación del protocolo del buffer: PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer. 
* PEP 393; Representación flexible de cadenas de caracteres: PEP 393 Representación flexible de cadenas de caracteres. 
* PEP 397; Lanzador de python para windows: PEP 397 Lanzador de python para windows. 
* PEP 3151; Reelaborando de la jerarquía de excepciones de IO y OS: PEP 3151 Reelaborando de la jerarquía de excepciones de IO y OS. 
* PEP 380; Sintaxis para delegar en un subgenerador: PEP 380 Sintaxis para delegar en un subgenerador. 
* PEP 409; Suprimir el contexto de excepción: PEP 409 Suprimir el contexto de excepción. 
* PEP 414; Literales Unicode explícitos: PEP 414 Literales Unicode explícitos. 
* PEP 3155; Nombres calificados para clases y funciones: PEP 3155 Nombres calificados para clases y funciones. 
* PEP 412; Diccionario de intercambio de claves: PEP 412 Diccionario de intercambio de claves. 
* PEP 362; Objeto de firma de función: PEP 362 Objeto de firma de función. 
* PEP 421; Agregar sys.implementation: PEP 421 Agregar sys implementation. 
* Usar importlib como implementación de Import:: 
* Otros cambios de idioma: Otros cambios de idioma<5>. 
* Un bloqueo de importación más detallado:: 
* Funciones y tipos incorporados:: 
* Nuevos módulos: Nuevos módulos<8>. 
* Módulos mejorados: Módulos mejorados<10>. 
* Optimizaciones: Optimizaciones<9>. 
* Construcción y cambios en la API de C:: 
* Obsoleto: Obsoleto<12>. 
* Migración a Python 3.3: Migración a Python 3 3. 

PEP 3118: Nueva implementación de vista de memoria y en la documentación del protocolo del buffer

* Características:: 
* Cambios en la API:: 

PEP 393: Representación flexible de cadenas de caracteres

* Funcionalidad:: 
* Rendimiento y uso de recursos:: 

PEP 421: Agregar sys.implementation

* SimpleNamespace:: 

Usar importlib como implementación de Import

* Nuevas APIs:: 
* Cambios visibles:: 

Nuevos módulos

* faulthandler: faulthandler<2>. 
* ipaddress: ipaddress<4>. 
* lzma: lzma<2>. 

Módulos mejorados

* abc: abc<2>. 
* array: array<3>. 
* base64: base64<4>. 
* binascii: binascii<3>. 
* bz2: bz2<2>. 
* códecs: códecs<2>. 
* colecciones: colecciones<3>. 
* contextlib: contextlib<7>. 
* crypt: crypt<2>. 
* curses: curses<3>. 
* datetime: datetime<4>. 
* decimal: decimal<4>. 
* email: email<5>. 
* ftplib: ftplib<3>. 
* functools: functools<6>. 
* gc: gc<4>. 
* hmac: hmac<4>. 
* http: http<5>. 
* html: html<2>. 
* imaplib: imaplib<3>. 
* inspect: inspect<5>. 
* io: io<7>. 
* itertools: itertools<7>. 
* logging: logging<4>. 
* math: math<6>. 
* mmap: mmap<4>. 
* multiprocesamiento: multiprocesamiento<4>. 
* nntplib: nntplib<2>. 
* os: os<12>. 
* pdb: pdb<7>. 
* pickle: pickle<4>. 
* pydoc: pydoc<4>. 
* re: re<9>. 
* sched:: 
* select:: 
* shlex: shlex<3>. 
* shutil: shutil<6>. 
* signal: signal<3>. 
* smtpd: smtpd<4>. 
* smtplib: smtplib<4>. 
* socket: socket<5>. 
* socketserver: socketserver<2>. 
* sqlite3: sqlite3<11>. 
* ssl: ssl<11>. 
* stat: stat<2>. 
* struct: struct<2>. 
* subprocess: subprocess<4>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* tempfile: tempfile<3>. 
* textwrap: textwrap<2>. 
* threading: threading<5>. 
* time: time<5>. 
* types: types<5>. 
* unittest: unittest<9>. 
* urllib: urllib<5>. 
* webbrowser: webbrowser<3>. 
* xml.etree.ElementTree: xml etree ElementTree<2>. 
* zlib: zlib<2>. 

decimal

* Características: Características<2>. 
* Cambios en la API: Cambios en la API<2>. 

email

* Marco de políticas:: 
* Política provisional con nueva API de encabezado:: 
* Otros cambios en la API:: 

Obsoleto

* Sistemas operativos no compatibles: Sistemas operativos no compatibles<2>. 
* Módulos @comma{} funciones y métodos obsoletos en Python: Módulos funciones y métodos obsoletos en Python. 
* Funciones y tipos obsoletos en la API de C:: 
* Características obsoletas:: 

Migración a Python 3.3

* Portando código Python:: 
* Portando código C:: 
* Construyendo extensiones C:: 
* Cambios en el conmutador de línea de comandos:: 

Qué hay de nuevo en Python 3.2

* PEP 384; Definición de un ABI estable: PEP 384 Definición de un ABI estable. 
* PEP 389; Módulo de análisis sintáctico (Parser) de línea de comandos Argparse: PEP 389 Módulo de análisis sintáctico Parser de línea de comandos Argparse. 
* PEP 391; Configuración basada en diccionario para Logging: PEP 391 Configuración basada en diccionario para Logging. 
* PEP 3148; El módulo concurrent.futures: PEP 3148 El módulo concurrent futures. 
* PEP 3147; Directorios del repositorio de PYC: PEP 3147 Directorios del repositorio de PYC. 
* PEP 3149; Archivos .so con etiquetado de versión para ABI: PEP 3149 Archivos so con etiquetado de versión para ABI. 
* PEP 3333; Interfaz de puerta de enlace del servidor web Python v1.0.1: PEP 3333 Interfaz de puerta de enlace del servidor web Python v1 0 1. 
* Otros cambios de lenguaje: Otros cambios de lenguaje<2>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos. 
* Multi-threading:: 
* Optimizations: Optimizations<3>. 
* Unicode:: 
* Codecs:: 
* Documentación:: 
* IDLE:: 
* Repositorio de código:: 
* Cambios en la API de construcción y C:: 
* Portar a Python 3.2: Portar a Python 3 2. 

Módulos nuevos, mejorados y obsoletos

* email: email<6>. 
* elementtree:: 
* functools: functools<7>. 
* itertools: itertools<8>. 
* collections: collections<5>. 
* threading: threading<6>. 
* datetime and time:: 
* math: math<7>. 
* abc: abc<3>. 
* io: io<8>. 
* reprlib:: 
* logging: logging<5>. 
* csv: csv<4>. 
* contextlib: contextlib<8>. 
* decimal and fractions:: 
* ftp:: 
* popen:: 
* select: select<2>. 
* gzip y zipfile:: 
* tarfile: tarfile<9>. 
* hashlib: hashlib<7>. 
* ast: ast<7>. 
* os: os<13>. 
* shutil: shutil<7>. 
* sqlite3: sqlite3<12>. 
* html: html<3>. 
* socket: socket<6>. 
* ssl: ssl<12>. 
* nntp:: 
* certificados:: 
* imaplib: imaplib<4>. 
* http.client: http client<4>. 
* unittest: unittest<10>. 
* random: random<3>. 
* poplib: poplib<4>. 
* asyncore: asyncore<2>. 
* tempfile: tempfile<4>. 
* inspect: inspect<6>. 
* pydoc: pydoc<5>. 
* dis: dis<6>. 
* dbm: dbm<7>. 
* ctypes: ctypes<4>. 
* site: site<2>. 
* sysconfig: sysconfig<2>. 
* pdb: pdb<8>. 
* configparser: configparser<5>. 
* urllib.parse: urllib parse<6>. 
* mailbox:: 
* turtledemo:: 

Qué hay de nuevo en Python 3.1

* PEP 372; Diccionarios ordenados: PEP 372 Diccionarios ordenados. 
* PEP 378; Especificador de formato para el separador de miles: PEP 378 Especificador de formato para el separador de miles. 
* Otros cambios del lenguaje: Otros cambios del lenguaje<2>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<2>. 
* Optimizaciones: Optimizaciones<10>. 
* IDLE: IDLE<2>. 
* Cambios en la compilación y la API de C: Cambios en la compilación y la API de C<3>. 
* Portando a Python 3.1: Portando a Python 3 1. 

Qué hay de nuevo en Python 3.0

* Escollos comunes:: 
* Descripción general de los cambios de sintaxis:: 
* Cambios ya presentes en Python 2.6: Cambios ya presentes en Python 2 6. 
* Cambios de biblioteca:: 
* PEP 3101; Un nuevo enfoque al formateo de cadena de caracteres: PEP 3101 Un nuevo enfoque al formateo de cadena de caracteres. 
* Cambios a excepciones:: 
* Otros cambios diversos:: 
* Construcción y cambios a la API de C:: 
* Rendimiento:: 
* Migración a Python 3.0: Migración a Python 3 0. 

Escollos comunes

* Print es una función:: 
* Vistas e iteradores en lugar de listas:: 
* Comparaciones de ordenamiento:: 
* Enteros:: 
* Texto vs. datos en lugar de unicode vs. 8 bits: Texto vs datos en lugar de unicode vs 8 bits. 

Descripción general de los cambios de sintaxis

* Nueva sintaxis:: 
* Sintaxis modificada:: 
* Sintaxis eliminada:: 

Otros cambios diversos

* Operadores y métodos especiales:: 
* Incorporados:: 

Qué hay de nuevo en Python 2.7

* El futuro de Python 2.x: El futuro de Python 2 x. 
* Cambios en el manejo de las advertencias de desuso:: 
* Características de Python 3.1: Características de Python 3 1. 
* PEP 372; Adición de un diccionario ordenado a las colecciones: PEP 372 Adición de un diccionario ordenado a las colecciones. 
* PEP 378; Especificador de formato para separador de miles: PEP 378 Especificador de formato para separador de miles. 
* PEP 389; El módulo argparse para el análisis de líneas de comando: PEP 389 El módulo argparse para el análisis de líneas de comando. 
* PEP 391; Configuración basada en diccionarios para el registro: PEP 391 Configuración basada en diccionarios para el registro. 
* PEP 3106; Vistas de diccionario: PEP 3106 Vistas de diccionario. 
* PEP 3137; El objeto memoryview: PEP 3137 El objeto memoryview. 
* Otros cambios de lenguaje: Otros cambios de lenguaje<3>. 
* Módulos nuevos y mejorados:: 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<2>. 
* Otros cambios y correcciones:: 
* Adaptación a Python 2.7: Adaptación a Python 2 7. 
* Nuevas funciones añadidas a las versiones de mantenimiento de Python 2.7: Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7. 
* Agradecimientos:: 

Otros cambios de lenguaje

* Cambios en el intérprete:: 
* Optimizaciones: Optimizaciones<11>. 

Módulos nuevos y mejorados

* Nuevo módulo; importlib: Nuevo módulo importlib. 
* Nuevo módulo; sysconfig: Nuevo módulo sysconfig. 
* ttk; Widgets temáticos para Tk: ttk Widgets temáticos para Tk. 
* Módulo actualizado; unittest: Módulo actualizado unittest. 
* Módulo actualizado; ElementTree 1.3: Módulo actualizado ElementTree 1 3. 

Cambios en la API de construcción y C

* Cápsulas:: 
* Cambios específicos en los puertos; Windows: Cambios específicos en los puertos Windows. 
* Cambios específicos en los puertos; Mac OS X: Cambios específicos en los puertos Mac OS X. 
* Cambios específicos en los puertos; FreeBSD: Cambios específicos en los puertos FreeBSD. 

Nuevas funciones añadidas a las versiones de mantenimiento de Python 2.7

* Dos nuevas variables de entorno para el modo de depuración:: 
* PEP 434; Excepción de mejora de IDLE para todas las ramas: PEP 434 Excepción de mejora de IDLE para todas las ramas. 
* PEP 466; Mejoras en la seguridad de la red para Python 2.7: PEP 466 Mejoras en la seguridad de la red para Python 2 7. 
* PEP 477; Backport ensurepip (PEP 453) a Python 2.7: PEP 477 Backport ensurepip PEP 453 a Python 2 7. 
* PEP 476; Habilitar la verificación de certificados por defecto para los clientes http stdlib: PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib<2>. 
* PEP 493; Herramientas de migración de verificación HTTPS para Python 2.7: PEP 493 Herramientas de migración de verificación HTTPS para Python 2 7. 
* Nuevo objetivo de construcción make regen-all:: 
* Eliminación del objetivo de construcción make touch:: 

PEP 477: Backport ensurepip (PEP 453) a Python 2.7

* Puesta en marcha de pip por defecto: Puesta en marcha de pip por defecto<2>. 
* Cambios en la documentación: Cambios en la documentación<2>. 

Qué hay de nuevo en Python 2.6

* Python 3.0: Python 3 0. 
* Cambios en el proceso de desarrollo:: 
* PEP 343; La sentencia “with”: PEP 343 La sentencia “with”. 
* PEP 366; Importaciones relativas explícitas desde un módulo principal: PEP 366 Importaciones relativas explícitas desde un módulo principal. 
* PEP 370; Directorio de site-packages por usuario: PEP 370 Directorio de site-packages por usuario. 
* PEP 371; El paquete multiprocessing: PEP 371 El paquete multiprocessing. 
* PEP 3101; Formateo avanzado de cadena de caracteres: PEP 3101 Formateo avanzado de cadena de caracteres. 
* PEP 3105; print como función: PEP 3105 print como función. 
* PEP 3110; Cambios en el manejo de excepciones: PEP 3110 Cambios en el manejo de excepciones. 
* PEP 3112; Literales de bytes: PEP 3112 Literales de bytes. 
* PEP 3116; Nueva biblioteca de E/S: PEP 3116 Nueva biblioteca de E/S. 
* PEP 3118; Protocolo revisado de la memoria intermedia: PEP 3118 Protocolo revisado de la memoria intermedia. 
* PEP 3119; Clases base abstractas: PEP 3119 Clases base abstractas. 
* PEP 3127; Soporte y sintaxis de literales enteros: PEP 3127 Soporte y sintaxis de literales enteros. 
* PEP 3129; Decoradores de clase: PEP 3129 Decoradores de clase. 
* PEP 3141; Una jerarquía de tipos para los números: PEP 3141 Una jerarquía de tipos para los números. 
* Otros cambios lingüísticos:: 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<2>. 
* Cancelaciones y eliminaciones:: 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<3>. 
* Adaptación a Python 2.6: Adaptación a Python 2 6. 
* Agradecimientos: Agradecimientos<2>. 

Cambios en el proceso de desarrollo

* Nuevo seguidor de incidentes; Roundup: Nuevo seguidor de incidentes Roundup. 
* Nuevo formato de documentación; texto reestructurado con Sphinx: Nuevo formato de documentación texto reestructurado con Sphinx. 

PEP 343: La sentencia “with”

* Escribiendo gestores de contexto:: 
* El módulo contextlib:: 

PEP 3141: Una jerarquía de tipos para los números

* El módulo fractions:: 

Otros cambios lingüísticos

* Optimizaciones: Optimizaciones<12>. 
* Cambios de intérprete:: 

Módulos nuevos y mejorados

* El módulo ast:: 
* El módulo future_builtins:: 
* El módulo json; Notación de objetos de JavaScript: El módulo json Notación de objetos de JavaScript. 
* El módulo plistlib; Un analizador de listas de propiedades: El módulo plistlib Un analizador de listas de propiedades. 
* mejoras en ctypes:: 
* Mejora de la compatibilidad con SSL:: 

Cambios en la API de construcción y C

* Cambios específicos en los puertos; Windows: Cambios específicos en los puertos Windows<2>. 
* Cambios específicos en los puertos; Mac OS X: Cambios específicos en los puertos Mac OS X<2>. 
* Cambios específicos en los puertos; IRIX: Cambios específicos en los puertos IRIX. 

Qué hay de nuevo en Python 2.5

* PEP 308; Expresiones condicionales: PEP 308 Expresiones condicionales. 
* PEP 309; Aplicación parcial de funciones: PEP 309 Aplicación parcial de funciones. 
* PEP 314; Metadatos para paquetes de software Python v1.1: PEP 314 Metadatos para paquetes de software Python v1 1. 
* PEP 328; Importaciones absolutas y relativas: PEP 328 Importaciones absolutas y relativas. 
* PEP 338; Ejecutando Módulos como Scripts: PEP 338 Ejecutando Módulos como Scripts. 
* PEP 341; Try/except/finally unificados: PEP 341 Try/except/finally unificados. 
* PEP 342; Nuevas funciones del generador: PEP 342 Nuevas funciones del generador. 
* PEP 343; La declaración «con: PEP 343 La declaración «con. 
* PEP 352; Las excepciones como clases de nuevo estilo: PEP 352 Las excepciones como clases de nuevo estilo. 
* PEP 353; Uso de ssize_t como tipo de índice: PEP 353 Uso de ssize_t como tipo de índice. 
* PEP 357; El método “__index__”: PEP 357 El método “__index__”. 
* Otros cambios lingüísticos: Otros cambios lingüísticos<2>. 
* Módulos nuevos@comma{} mejorados y eliminados: Módulos nuevos mejorados y eliminados. 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<4>. 
* Adaptación a Python 2.5: Adaptación a Python 2 5. 
* Agradecimientos: Agradecimientos<3>. 

PEP 343: La declaración «con

* Redacción de Gestores de Contexto:: 
* El módulo contextlib: El módulo contextlib<2>. 

Otros cambios lingüísticos

* Cambios en el intérprete interactivo:: 
* Optimizaciones: Optimizaciones<13>. 

Módulos nuevos, mejorados y eliminados

* El paquete ctypes:: 
* El paquete ElementTree:: 
* El paquete hashlib:: 
* El paquete sqlite3:: 
* El paquete wsgiref:: 

Cambios en la API de construcción y C

* Cambios específicos en los puertos:: 

Qué hay de nuevo en Python 2.4

* PEP 218; Objetos conjunto integrados: PEP 218 Objetos conjunto integrados. 
* PEP 237; Unificando enteros largos y enteros: PEP 237 Unificando enteros largos y enteros. 
* PEP 289; Expresiones generadoras: PEP 289 Expresiones generadoras. 
* PEP 292; Sustituciones simples de cadenas de caracteres: PEP 292 Sustituciones simples de cadenas de caracteres. 
* PEP 318; Decoradores para funciones y métodos: PEP 318 Decoradores para funciones y métodos. 
* PEP 322; Iteración inversa: PEP 322 Iteración inversa. 
* PEP 324; Nuevo módulo de subproceso: PEP 324 Nuevo módulo de subproceso. 
* PEP 327; Tipo de dato decimal: PEP 327 Tipo de dato decimal. 
* PEP 328; Importaciones multilínea: PEP 328 Importaciones multilínea. 
* PEP 331; Conversiones locales-independientes números flotantes/cadenas de texto: PEP 331 Conversiones locales-independientes números flotantes/cadenas de texto. 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<4>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<3>. 
* Cambios en la API de Build y C: Cambios en la API de Build y C<2>. 
* Portar a Python 2.4: Portar a Python 2 4. 
* Agradecimientos: Agradecimientos<4>. 

PEP 327: Tipo de dato decimal

* ¿Por qué se necesita Decimal?:: 
* El tipo de clase Decimal:: 
* El tipo de clase Context:: 

Otros cambios en el lenguaje

* Optimizaciones: Optimizaciones<14>. 

Módulos nuevos, mejorados y obsoletos

* cookielib:: 
* doctest: doctest<5>. 

Cambios en la API de Build y C

* Cambios específicos del puerto:: 

Qué hay de nuevo en Python 2.3

* PEP 218; Un tipo de datos de conjunto estándar: PEP 218 Un tipo de datos de conjunto estándar. 
* PEP 255; Generadores simples: PEP 255 Generadores simples. 
* PEP 263; Codificación del código fuente: PEP 263 Codificación del código fuente. 
* PEP 273; Importar módulos desde archivos ZIP: PEP 273 Importar módulos desde archivos ZIP. 
* PEP 277; Soporte de nombres de archivo Unicode para Windows NT: PEP 277 Soporte de nombres de archivo Unicode para Windows NT. 
* PEP 278; Soporte universal de nuevas líneas: PEP 278 Soporte universal de nuevas líneas. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; El paquete de registro: PEP 282 El paquete de registro. 
* PEP 285; Un tipo booleano: PEP 285 Un tipo booleano. 
* PEP 293; Llamadas de retorno para el manejo de errores del códec: PEP 293 Llamadas de retorno para el manejo de errores del códec. 
* PEP 301; Índice de paquetes y metadatos para Distutils: PEP 301 Índice de paquetes y metadatos para Distutils. 
* PEP 302; Nuevos ganchos de importación: PEP 302 Nuevos ganchos de importación. 
* PEP 305; Archivos separados por comas: PEP 305 Archivos separados por comas. 
* PEP 307; Mejoras en Pickle: PEP 307 Mejoras en Pickle. 
* Rebanadas ampliadas:: 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<5>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<4>. 
* Pymalloc; un asignador de objetos especializado: Pymalloc un asignador de objetos especializado. 
* Cambios en la API de Build y C: Cambios en la API de Build y C<3>. 
* Otros cambios y correcciones: Otros cambios y correcciones<2>. 
* Portar a Python 2.3: Portar a Python 2 3. 
* Agradecimientos: Agradecimientos<5>. 

Otros cambios en el lenguaje

* Cambios en las cadenas de texto:: 
* Optimizaciones: Optimizaciones<15>. 

Módulos nuevos, mejorados y obsoletos

* Tipo de fecha / hora:: 
* El módulo optparse:: 

Cambios en la API de Build y C

* Cambios específicos del puerto: Cambios específicos del puerto<2>. 

Qué hay de nuevo en Python 2.2

* Introducción:: 
* PEPs 252 y 253; Cambios de tipo y clase: PEPs 252 y 253 Cambios de tipo y clase. 
* PEP 234; Iteradores: PEP 234 Iteradores. 
* PEP 255; Generadores simples: PEP 255 Generadores simples<2>. 
* PEP 237; Unificación de enteros largos y enteros: PEP 237 Unificación de enteros largos y enteros. 
* PEP 238; Cambio del operador de división: PEP 238 Cambio del operador de división. 
* Cambios en Unicode:: 
* PEP 227; Ámbitos anidados: PEP 227 Ámbitos anidados. 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<3>. 
* Cambios y correcciones en el intérprete:: 
* Otros cambios y correcciones: Otros cambios y correcciones<3>. 
* Agradecimientos: Agradecimientos<6>. 

PEPs 252 y 253: Cambios de tipo y clase

* Clases antiguas y nuevas:: 
* Descriptores:: 
* Herencia múltiple; la regla del diamante: Herencia múltiple la regla del diamante. 
* Acceso a atributos:: 
* Enlaces relacionados:: 

Qué hay de nuevo en Python 2.1

* Introducción: Introducción<2>. 
* PEP 227; Ámbitos anidados: PEP 227 Ámbitos anidados<2>. 
* PEP 236; Directivas __future__: PEP 236 Directivas __future__. 
* PEP 207; Comparaciones Enriquecidas: PEP 207 Comparaciones Enriquecidas. 
* PEP 230; Marco de advertencia: PEP 230 Marco de advertencia. 
* PEP 229; Sistema de construcción nuevo: PEP 229 Sistema de construcción nuevo. 
* PEP 205; Referencias débiles: PEP 205 Referencias débiles. 
* PEP 232; Atributos de la función: PEP 232 Atributos de la función. 
* PEP 235; Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas: PEP 235 Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas. 
* PEP 217; Gancho de pantalla interactivo: PEP 217 Gancho de pantalla interactivo. 
* PEP 208; Nuevo modelo de coerción: PEP 208 Nuevo modelo de coerción. 
* PEP 241; Metadatos en paquetes de Python: PEP 241 Metadatos en paquetes de Python. 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<4>. 
* Otros cambios y correcciones: Otros cambios y correcciones<4>. 
* Agradecimientos: Agradecimientos<7>. 

Qué hay de nuevo en Python 2.0

* Introducción: Introducción<3>. 
* ¿Qué pasa con Python 1.6?: ¿Qué pasa con Python 1 6?. 
* Nuevo proceso de desarrollo:: 
* Unicode: Unicode<2>. 
* Comprensión de listas:: 
* Asignación aumentada:: 
* Métodos de cadena de caracteres:: 
* Recogida de basura de los ciclos:: 
* Otros cambios en el núcleo:: 
* Adaptación a la versión 2.0: Adaptación a la versión 2 0. 
* Extensión/Incorporación de cambios:: 
* Distutils; Facilitando la instalación de módulos: Distutils Facilitando la instalación de módulos. 
* Módulos XML:: 
* Cambios en los módulos:: 
* Nuevos módulos: Nuevos módulos<9>. 
* Mejoras en IDLE:: 
* Módulos eliminados y obsoletos:: 
* Agradecimientos: Agradecimientos<8>. 

Otros cambios en el núcleo

* Cambios menores del lenguaje:: 
* Cambios en las funciones incorporadas:: 

Módulos XML

* Soporte de SAX2:: 
* Soporte DOM:: 
* Relación con PyXML:: 

Registro de cambios

* Python next:: 
* Python 3.14.0 alpha 1: Python 3 14 0 alpha 1. 
* Python 3.13.0 beta 1: Python 3 13 0 beta 1. 
* Python 3.13.0 alpha 6: Python 3 13 0 alpha 6. 
* Python 3.13.0 alpha 5: Python 3 13 0 alpha 5. 
* Python 3.13.0 alpha 4: Python 3 13 0 alpha 4. 
* Python 3.13.0 alpha 3: Python 3 13 0 alpha 3. 
* Python 3.13.0 alpha 2: Python 3 13 0 alpha 2. 
* Python 3.13.0 alpha 1: Python 3 13 0 alpha 1. 
* Python 3.12.0 beta 1: Python 3 12 0 beta 1. 
* Python 3.12.0 alpha 7: Python 3 12 0 alpha 7. 
* Python 3.12.0 alpha 6: Python 3 12 0 alpha 6. 
* Python 3.12.0 alpha 5: Python 3 12 0 alpha 5. 
* Python 3.12.0 alpha 4: Python 3 12 0 alpha 4. 
* Python 3.12.0 alpha 3: Python 3 12 0 alpha 3. 
* Python 3.12.0 alpha 2: Python 3 12 0 alpha 2. 
* Python 3.12.0 alpha 1: Python 3 12 0 alpha 1. 
* Python 3.11.0 beta 1: Python 3 11 0 beta 1. 
* Python 3.11.0 alpha 7: Python 3 11 0 alpha 7. 
* Python 3.11.0 alpha 6: Python 3 11 0 alpha 6. 
* Python 3.11.0 alpha 5: Python 3 11 0 alpha 5. 
* Python 3.11.0 alpha 4: Python 3 11 0 alpha 4. 
* Python 3.11.0 alpha 3: Python 3 11 0 alpha 3. 
* Python 3.11.0 alpha 2: Python 3 11 0 alpha 2. 
* Python 3.11.0 alpha 1: Python 3 11 0 alpha 1. 
* Python 3.10.0 beta 1: Python 3 10 0 beta 1. 
* Python 3.10.0 alpha 7: Python 3 10 0 alpha 7. 
* Python 3.10.0 alpha 6: Python 3 10 0 alpha 6. 
* Python 3.10.0 alpha 5: Python 3 10 0 alpha 5. 
* Python 3.10.0 alpha 4: Python 3 10 0 alpha 4. 
* Python 3.10.0 alpha 3: Python 3 10 0 alpha 3. 
* Python 3.10.0 alpha 2: Python 3 10 0 alpha 2. 
* Python 3.10.0 alpha 1: Python 3 10 0 alpha 1. 
* Python 3.9.0 beta 1: Python 3 9 0 beta 1. 
* Python 3.9.0 alpha 6: Python 3 9 0 alpha 6. 
* Python 3.9.0 alpha 5: Python 3 9 0 alpha 5. 
* Python 3.9.0 alpha 4: Python 3 9 0 alpha 4. 
* Python 3.9.0 alpha 3: Python 3 9 0 alpha 3. 
* Python 3.9.0 alpha 2: Python 3 9 0 alpha 2. 
* Python 3.9.0 alpha 1: Python 3 9 0 alpha 1. 
* Python 3.8.0 beta 1: Python 3 8 0 beta 1. 
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4. 
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3. 
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2. 
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1. 
* Python 3.7.0 final: Python 3 7 0 final. 
* Python 3.7.0 release candidate 1: Python 3 7 0 release candidate 1. 
* Python 3.7.0 beta 5: Python 3 7 0 beta 5. 
* Python 3.7.0 beta 4: Python 3 7 0 beta 4. 
* Python 3.7.0 beta 3: Python 3 7 0 beta 3. 
* Python 3.7.0 beta 2: Python 3 7 0 beta 2. 
* Python 3.7.0 beta 1: Python 3 7 0 beta 1. 
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4. 
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3. 
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2. 
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1. 
* Python 3.6.6 final: Python 3 6 6 final. 
* Python 3.6.6 release candidate 1: Python 3 6 6 release candidate 1. 
* Python 3.6.5 final: Python 3 6 5 final. 
* Python 3.6.5 release candidate 1: Python 3 6 5 release candidate 1. 
* Python 3.6.4 final: Python 3 6 4 final. 
* Python 3.6.4 release candidate 1: Python 3 6 4 release candidate 1. 
* Python 3.6.3 final: Python 3 6 3 final. 
* Python 3.6.3 release candidate 1: Python 3 6 3 release candidate 1. 
* Python 3.6.2 final: Python 3 6 2 final. 
* Python 3.6.2 release candidate 2: Python 3 6 2 release candidate 2. 
* Python 3.6.2 release candidate 1: Python 3 6 2 release candidate 1. 
* Python 3.6.1 final: Python 3 6 1 final. 
* Python 3.6.1 release candidate 1: Python 3 6 1 release candidate 1. 
* Python 3.6.0 final: Python 3 6 0 final. 
* Python 3.6.0 release candidate 2: Python 3 6 0 release candidate 2. 
* Python 3.6.0 release candidate 1: Python 3 6 0 release candidate 1. 
* Python 3.6.0 beta 4: Python 3 6 0 beta 4. 
* Python 3.6.0 beta 3: Python 3 6 0 beta 3. 
* Python 3.6.0 beta 2: Python 3 6 0 beta 2. 
* Python 3.6.0 beta 1: Python 3 6 0 beta 1. 
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4. 
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3. 
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2. 
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1. 
* Python 3.5.5 final: Python 3 5 5 final. 
* Python 3.5.5 release candidate 1: Python 3 5 5 release candidate 1. 
* Python 3.5.4 final: Python 3 5 4 final. 
* Python 3.5.4 release candidate 1: Python 3 5 4 release candidate 1. 
* Python 3.5.3 final: Python 3 5 3 final. 
* Python 3.5.3 release candidate 1: Python 3 5 3 release candidate 1. 
* Python 3.5.2 final: Python 3 5 2 final. 
* Python 3.5.2 release candidate 1: Python 3 5 2 release candidate 1. 
* Python 3.5.1 final: Python 3 5 1 final. 
* Python 3.5.1 release candidate 1: Python 3 5 1 release candidate 1. 
* Python 3.5.0 final: Python 3 5 0 final. 
* Python 3.5.0 release candidate 4: Python 3 5 0 release candidate 4. 
* Python 3.5.0 release candidate 3: Python 3 5 0 release candidate 3. 
* Python 3.5.0 release candidate 2: Python 3 5 0 release candidate 2. 
* Python 3.5.0 release candidate 1: Python 3 5 0 release candidate 1. 
* Python 3.5.0 beta 4: Python 3 5 0 beta 4. 
* Python 3.5.0 beta 3: Python 3 5 0 beta 3. 
* Python 3.5.0 beta 2: Python 3 5 0 beta 2. 
* Python 3.5.0 beta 1: Python 3 5 0 beta 1. 
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4. 
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3. 
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2. 
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1. 

Python next

* Windows:: 
* Tools/Demos:: 
* Tests:: 
* Security:: 
* Library:: 
* Documentation:: 
* Core and Builtins:: 
* C API:: 
* Build:: 

Python 3.14.0 alpha 1

* macOS:: 
* Windows: Windows<2>. 
* Tools/Demos: Tools/Demos<2>. 
* Tests: Tests<2>. 
* Security: Security<2>. 
* Library: Library<2>. 
* IDLE: IDLE<3>. 
* Documentation: Documentation<2>. 
* Core and Builtins: Core and Builtins<2>. 
* C API: C API<2>. 
* Build: Build<2>. 

Python 3.13.0 beta 1

* Security: Security<3>. 
* Core and Builtins: Core and Builtins<3>. 
* Library: Library<3>. 
* Documentation: Documentation<3>. 
* Build: Build<3>. 
* Windows: Windows<3>. 
* macOS: macOS<2>. 
* IDLE: IDLE<4>. 
* C API: C API<3>. 

Python 3.13.0 alpha 6

* Core and Builtins: Core and Builtins<4>. 
* Library: Library<4>. 
* Documentation: Documentation<4>. 
* Tests: Tests<3>. 
* Build: Build<4>. 
* Windows: Windows<4>. 
* C API: C API<4>. 

Python 3.13.0 alpha 5

* Security: Security<4>. 
* Core and Builtins: Core and Builtins<5>. 
* Library: Library<5>. 
* Documentation: Documentation<5>. 
* Tests: Tests<4>. 
* Build: Build<5>. 
* Windows: Windows<5>. 
* macOS: macOS<3>. 
* IDLE: IDLE<5>. 
* Tools/Demos: Tools/Demos<3>. 
* C API: C API<5>. 

Python 3.13.0 alpha 4

* Security: Security<5>. 
* Core and Builtins: Core and Builtins<6>. 
* Library: Library<6>. 
* Documentation: Documentation<6>. 
* Tests: Tests<5>. 
* Build: Build<6>. 
* Windows: Windows<6>. 
* macOS: macOS<4>. 
* IDLE: IDLE<6>. 
* Tools/Demos: Tools/Demos<4>. 
* C API: C API<6>. 

Python 3.13.0 alpha 3

* Security: Security<6>. 
* Core and Builtins: Core and Builtins<7>. 
* Library: Library<7>. 
* Documentation: Documentation<7>. 
* Tests: Tests<6>. 
* Build: Build<7>. 
* Windows: Windows<7>. 
* macOS: macOS<5>. 
* IDLE: IDLE<7>. 
* C API: C API<7>. 

Python 3.13.0 alpha 2

* Core and Builtins: Core and Builtins<8>. 
* Library: Library<8>. 
* Tests: Tests<7>. 
* Build: Build<8>. 
* Windows: Windows<8>. 
* macOS: macOS<6>. 
* IDLE: IDLE<8>. 
* Tools/Demos: Tools/Demos<5>. 
* C API: C API<8>. 

Python 3.13.0 alpha 1

* Security: Security<7>. 
* Core and Builtins: Core and Builtins<9>. 
* Library: Library<9>. 
* Documentation: Documentation<8>. 
* Tests: Tests<8>. 
* Build: Build<9>. 
* Windows: Windows<9>. 
* macOS: macOS<7>. 
* IDLE: IDLE<9>. 
* Tools/Demos: Tools/Demos<6>. 
* C API: C API<9>. 

Python 3.12.0 beta 1

* Security: Security<8>. 
* Core and Builtins: Core and Builtins<10>. 
* Library: Library<10>. 
* Documentation: Documentation<9>. 
* Tests: Tests<9>. 
* Build: Build<10>. 
* Windows: Windows<10>. 
* macOS: macOS<8>. 
* IDLE: IDLE<10>. 
* Tools/Demos: Tools/Demos<7>. 
* C API: C API<10>. 

Python 3.12.0 alpha 7

* Core and Builtins: Core and Builtins<11>. 
* Library: Library<11>. 
* Documentation: Documentation<10>. 
* Tests: Tests<10>. 
* Build: Build<11>. 
* Windows: Windows<11>. 
* Tools/Demos: Tools/Demos<8>. 
* C API: C API<11>. 

Python 3.12.0 alpha 6

* Security: Security<9>. 
* Core and Builtins: Core and Builtins<12>. 
* Library: Library<12>. 
* Documentation: Documentation<11>. 
* Tests: Tests<11>. 
* Build: Build<12>. 
* Windows: Windows<12>. 
* macOS: macOS<9>. 
* C API: C API<12>. 

Python 3.12.0 alpha 5

* Security: Security<10>. 
* Core and Builtins: Core and Builtins<13>. 
* Library: Library<13>. 
* Documentation: Documentation<12>. 
* Tests: Tests<12>. 
* Build: Build<13>. 
* Windows: Windows<13>. 

Python 3.12.0 alpha 4

* Core and Builtins: Core and Builtins<14>. 
* Library: Library<14>. 
* Documentation: Documentation<13>. 
* Tests: Tests<13>. 
* Build: Build<14>. 
* Windows: Windows<14>. 
* macOS: macOS<10>. 
* Tools/Demos: Tools/Demos<9>. 
* C API: C API<13>. 

Python 3.12.0 alpha 3

* Security: Security<11>. 
* Core and Builtins: Core and Builtins<15>. 
* Library: Library<15>. 
* Documentation: Documentation<14>. 
* Tests: Tests<14>. 
* Build: Build<15>. 
* Windows: Windows<15>. 
* macOS: macOS<11>. 
* Tools/Demos: Tools/Demos<10>. 
* C API: C API<14>. 

Python 3.12.0 alpha 2

* Security: Security<12>. 
* Core and Builtins: Core and Builtins<16>. 
* Library: Library<16>. 
* Documentation: Documentation<15>. 
* Tests: Tests<15>. 
* Build: Build<16>. 
* Windows: Windows<16>. 
* macOS: macOS<12>. 
* C API: C API<15>. 

Python 3.12.0 alpha 1

* Security: Security<13>. 
* Core and Builtins: Core and Builtins<17>. 
* Library: Library<17>. 
* Documentation: Documentation<16>. 
* Tests: Tests<16>. 
* Build: Build<17>. 
* Windows: Windows<17>. 
* macOS: macOS<13>. 
* IDLE: IDLE<11>. 
* Tools/Demos: Tools/Demos<11>. 
* C API: C API<16>. 

Python 3.11.0 beta 1

* Security: Security<14>. 
* Core and Builtins: Core and Builtins<18>. 
* Library: Library<18>. 
* Documentation: Documentation<17>. 
* Tests: Tests<17>. 
* Build: Build<18>. 
* Windows: Windows<18>. 
* macOS: macOS<14>. 
* Tools/Demos: Tools/Demos<12>. 
* C API: C API<17>. 

Python 3.11.0 alpha 7

* Core and Builtins: Core and Builtins<19>. 
* Library: Library<19>. 
* Documentation: Documentation<18>. 
* Tests: Tests<18>. 
* Build: Build<19>. 
* Windows: Windows<19>. 
* macOS: macOS<15>. 
* Tools/Demos: Tools/Demos<13>. 
* C API: C API<18>. 

Python 3.11.0 alpha 6

* Core and Builtins: Core and Builtins<20>. 
* Library: Library<20>. 
* Documentation: Documentation<19>. 
* Tests: Tests<19>. 
* Build: Build<20>. 
* Windows: Windows<20>. 
* IDLE: IDLE<12>. 
* C API: C API<19>. 

Python 3.11.0 alpha 5

* Core and Builtins: Core and Builtins<21>. 
* Library: Library<21>. 
* Documentation: Documentation<20>. 
* Tests: Tests<20>. 
* Build: Build<21>. 
* Windows: Windows<21>. 
* macOS: macOS<16>. 
* IDLE: IDLE<13>. 
* C API: C API<20>. 

Python 3.11.0 alpha 4

* Core and Builtins: Core and Builtins<22>. 
* Library: Library<22>. 
* Documentation: Documentation<21>. 
* Tests: Tests<21>. 
* Build: Build<22>. 
* Windows: Windows<22>. 
* macOS: macOS<17>. 
* C API: C API<21>. 

Python 3.11.0 alpha 3

* Core and Builtins: Core and Builtins<23>. 
* Library: Library<23>. 
* Documentation: Documentation<22>. 
* Tests: Tests<22>. 
* Build: Build<23>. 
* Windows: Windows<23>. 
* macOS: macOS<18>. 
* C API: C API<22>. 

Python 3.11.0 alpha 2

* Core and Builtins: Core and Builtins<24>. 
* Library: Library<24>. 
* Documentation: Documentation<23>. 
* Tests: Tests<23>. 
* Build: Build<24>. 
* Windows: Windows<24>. 
* macOS: macOS<19>. 
* IDLE: IDLE<14>. 
* C API: C API<23>. 

Python 3.11.0 alpha 1

* Security: Security<15>. 
* Core and Builtins: Core and Builtins<25>. 
* Library: Library<25>. 
* Documentation: Documentation<24>. 
* Tests: Tests<24>. 
* Build: Build<25>. 
* Windows: Windows<25>. 
* macOS: macOS<20>. 
* IDLE: IDLE<15>. 
* Tools/Demos: Tools/Demos<14>. 
* C API: C API<24>. 

Python 3.10.0 beta 1

* Security: Security<16>. 
* Core and Builtins: Core and Builtins<26>. 
* Library: Library<26>. 
* Documentation: Documentation<25>. 
* Tests: Tests<25>. 
* Build: Build<26>. 
* Windows: Windows<26>. 
* macOS: macOS<21>. 
* IDLE: IDLE<16>. 
* C API: C API<25>. 

Python 3.10.0 alpha 7

* Security: Security<17>. 
* Core and Builtins: Core and Builtins<27>. 
* Library: Library<27>. 
* Documentation: Documentation<26>. 
* Tests: Tests<26>. 
* Build: Build<27>. 
* Windows: Windows<27>. 
* IDLE: IDLE<17>. 
* C API: C API<26>. 

Python 3.10.0 alpha 6

* Security: Security<18>. 
* Core and Builtins: Core and Builtins<28>. 
* Library: Library<28>. 
* Documentation: Documentation<27>. 
* Tests: Tests<27>. 
* Build: Build<28>. 
* Windows: Windows<28>. 
* macOS: macOS<22>. 
* IDLE: IDLE<18>. 
* C API: C API<27>. 

Python 3.10.0 alpha 5

* Security: Security<19>. 
* Core and Builtins: Core and Builtins<29>. 
* Library: Library<29>. 
* Documentation: Documentation<28>. 
* Tests: Tests<28>. 
* Build: Build<29>. 
* Windows: Windows<29>. 
* macOS: macOS<23>. 
* IDLE: IDLE<19>. 
* C API: C API<28>. 

Python 3.10.0 alpha 4

* Core and Builtins: Core and Builtins<30>. 
* Library: Library<30>. 
* Documentation: Documentation<29>. 
* Tests: Tests<29>. 
* Build: Build<30>. 
* macOS: macOS<24>. 
* Tools/Demos: Tools/Demos<15>. 
* C API: C API<29>. 

Python 3.10.0 alpha 3

* Security: Security<20>. 
* Core and Builtins: Core and Builtins<31>. 
* Library: Library<31>. 
* Documentation: Documentation<30>. 
* Tests: Tests<30>. 
* Build: Build<31>. 
* Windows: Windows<30>. 
* macOS: macOS<25>. 
* IDLE: IDLE<20>. 
* Tools/Demos: Tools/Demos<16>. 
* C API: C API<30>. 

Python 3.10.0 alpha 2

* Security: Security<21>. 
* Core and Builtins: Core and Builtins<32>. 
* Library: Library<32>. 
* Documentation: Documentation<31>. 
* Tests: Tests<31>. 
* Build: Build<32>. 
* Windows: Windows<31>. 
* macOS: macOS<26>. 
* IDLE: IDLE<21>. 
* C API: C API<31>. 

Python 3.10.0 alpha 1

* Security: Security<22>. 
* Core and Builtins: Core and Builtins<33>. 
* Library: Library<33>. 
* Documentation: Documentation<32>. 
* Tests: Tests<32>. 
* Build: Build<33>. 
* Windows: Windows<32>. 
* macOS: macOS<27>. 
* IDLE: IDLE<22>. 
* C API: C API<32>. 

Python 3.9.0 beta 1

* Security: Security<23>. 
* Core and Builtins: Core and Builtins<34>. 
* Library: Library<34>. 
* Documentation: Documentation<33>. 
* Tests: Tests<33>. 
* Build: Build<34>. 
* Windows: Windows<33>. 
* macOS: macOS<28>. 
* Tools/Demos: Tools/Demos<17>. 
* C API: C API<33>. 

Python 3.9.0 alpha 6

* Security: Security<24>. 
* Core and Builtins: Core and Builtins<35>. 
* Library: Library<35>. 
* Documentation: Documentation<34>. 
* Tests: Tests<34>. 
* Build: Build<35>. 
* Windows: Windows<34>. 
* macOS: macOS<29>. 
* IDLE: IDLE<23>. 
* Tools/Demos: Tools/Demos<18>. 
* C API: C API<34>. 

Python 3.9.0 alpha 5

* Security: Security<25>. 
* Core and Builtins: Core and Builtins<36>. 
* Library: Library<36>. 
* Documentation: Documentation<35>. 
* Tests: Tests<35>. 
* Build: Build<36>. 
* Windows: Windows<35>. 
* macOS: macOS<30>. 
* IDLE: IDLE<24>. 
* Tools/Demos: Tools/Demos<19>. 
* C API: C API<35>. 

Python 3.9.0 alpha 4

* Security: Security<26>. 
* Core and Builtins: Core and Builtins<37>. 
* Library: Library<37>. 
* Documentation: Documentation<36>. 
* Tests: Tests<36>. 
* Build: Build<37>. 
* Windows: Windows<36>. 
* IDLE: IDLE<25>. 
* C API: C API<36>. 

Python 3.9.0 alpha 3

* Core and Builtins: Core and Builtins<38>. 
* Library: Library<38>. 
* Documentation: Documentation<37>. 
* Build: Build<38>. 
* IDLE: IDLE<26>. 
* C API: C API<37>. 

Python 3.9.0 alpha 2

* Security: Security<27>. 
* Core and Builtins: Core and Builtins<39>. 
* Library: Library<39>. 
* Documentation: Documentation<38>. 
* Tests: Tests<37>. 
* Build: Build<39>. 
* Windows: Windows<37>. 
* macOS: macOS<31>. 
* IDLE: IDLE<27>. 
* C API: C API<38>. 

Python 3.9.0 alpha 1

* Security: Security<28>. 
* Core and Builtins: Core and Builtins<40>. 
* Library: Library<40>. 
* Documentation: Documentation<39>. 
* Tests: Tests<38>. 
* Build: Build<40>. 
* Windows: Windows<38>. 
* macOS: macOS<32>. 
* IDLE: IDLE<28>. 
* Tools/Demos: Tools/Demos<20>. 
* C API: C API<39>. 

Python 3.8.0 beta 1

* Security: Security<29>. 
* Core and Builtins: Core and Builtins<41>. 
* Library: Library<41>. 
* Documentation: Documentation<40>. 
* Tests: Tests<39>. 
* Build: Build<41>. 
* Windows: Windows<39>. 
* macOS: macOS<33>. 
* IDLE: IDLE<29>. 
* Tools/Demos: Tools/Demos<21>. 
* C API: C API<40>. 

Python 3.8.0 alpha 4

* Security: Security<30>. 
* Core and Builtins: Core and Builtins<42>. 
* Library: Library<42>. 
* Documentation: Documentation<41>. 
* Tests: Tests<40>. 
* Build: Build<42>. 
* Windows: Windows<40>. 
* macOS: macOS<34>. 
* IDLE: IDLE<30>. 
* Tools/Demos: Tools/Demos<22>. 
* C API: C API<41>. 

Python 3.8.0 alpha 3

* Security: Security<31>. 
* Core and Builtins: Core and Builtins<43>. 
* Library: Library<43>. 
* Documentation: Documentation<42>. 
* Tests: Tests<41>. 
* Build: Build<43>. 
* Windows: Windows<41>. 
* IDLE: IDLE<31>. 
* Tools/Demos: Tools/Demos<23>. 
* C API: C API<42>. 

Python 3.8.0 alpha 2

* Core and Builtins: Core and Builtins<44>. 
* Library: Library<44>. 
* Documentation: Documentation<43>. 
* Tests: Tests<42>. 
* Windows: Windows<42>. 
* IDLE: IDLE<32>. 

Python 3.8.0 alpha 1

* Security: Security<32>. 
* Core and Builtins: Core and Builtins<45>. 
* Library: Library<45>. 
* Documentation: Documentation<44>. 
* Tests: Tests<43>. 
* Build: Build<44>. 
* Windows: Windows<43>. 
* macOS: macOS<35>. 
* IDLE: IDLE<33>. 
* Tools/Demos: Tools/Demos<24>. 
* C API: C API<43>. 

Python 3.7.0 final

* Library: Library<46>. 
* C API: C API<44>. 

Python 3.7.0 release candidate 1

* Core and Builtins: Core and Builtins<46>. 
* Library: Library<47>. 
* Documentation: Documentation<45>. 
* Build: Build<45>. 
* Windows: Windows<44>. 
* IDLE: IDLE<34>. 

Python 3.7.0 beta 5

* Core and Builtins: Core and Builtins<47>. 
* Library: Library<48>. 
* Documentation: Documentation<46>. 
* Tests: Tests<44>. 
* Build: Build<46>. 
* macOS: macOS<36>. 
* IDLE: IDLE<35>. 

Python 3.7.0 beta 4

* Core and Builtins: Core and Builtins<48>. 
* Library: Library<49>. 
* Documentation: Documentation<47>. 
* Tests: Tests<45>. 
* Build: Build<47>. 
* Windows: Windows<45>. 
* macOS: macOS<37>. 
* IDLE: IDLE<36>. 
* Tools/Demos: Tools/Demos<25>. 

Python 3.7.0 beta 3

* Security: Security<33>. 
* Core and Builtins: Core and Builtins<49>. 
* Library: Library<50>. 
* Documentation: Documentation<48>. 
* Tests: Tests<46>. 
* Build: Build<48>. 
* Windows: Windows<46>. 
* macOS: macOS<38>. 
* IDLE: IDLE<37>. 
* Tools/Demos: Tools/Demos<26>. 
* C API: C API<45>. 

Python 3.7.0 beta 2

* Security: Security<34>. 
* Core and Builtins: Core and Builtins<50>. 
* Library: Library<51>. 
* Documentation: Documentation<49>. 
* Tests: Tests<47>. 
* Build: Build<49>. 
* Windows: Windows<47>. 
* macOS: macOS<39>. 
* IDLE: IDLE<38>. 
* Tools/Demos: Tools/Demos<27>. 

Python 3.7.0 beta 1

* Core and Builtins: Core and Builtins<51>. 
* Library: Library<52>. 
* Documentation: Documentation<50>. 
* Tests: Tests<48>. 
* Build: Build<50>. 
* Windows: Windows<48>. 
* macOS: macOS<40>. 
* C API: C API<46>. 

Python 3.7.0 alpha 4

* Core and Builtins: Core and Builtins<52>. 
* Library: Library<53>. 
* Documentation: Documentation<51>. 
* Tests: Tests<49>. 
* Windows: Windows<49>. 
* Tools/Demos: Tools/Demos<28>. 
* C API: C API<47>. 

Python 3.7.0 alpha 3

* Core and Builtins: Core and Builtins<53>. 
* Library: Library<54>. 
* Documentation: Documentation<52>. 
* Tests: Tests<50>. 
* Build: Build<51>. 
* Windows: Windows<50>. 
* macOS: macOS<41>. 
* IDLE: IDLE<39>. 
* Tools/Demos: Tools/Demos<29>. 
* C API: C API<48>. 

Python 3.7.0 alpha 2

* Core and Builtins: Core and Builtins<54>. 
* Library: Library<55>. 
* Documentation: Documentation<53>. 
* Build: Build<52>. 
* IDLE: IDLE<40>. 
* C API: C API<49>. 

Python 3.7.0 alpha 1

* Security: Security<35>. 
* Core and Builtins: Core and Builtins<55>. 
* Library: Library<56>. 
* Documentation: Documentation<54>. 
* Tests: Tests<51>. 
* Build: Build<53>. 
* Windows: Windows<51>. 
* IDLE: IDLE<41>. 
* Tools/Demos: Tools/Demos<30>. 
* C API: C API<50>. 

Python 3.6.6 release candidate 1

* Core and Builtins: Core and Builtins<56>. 
* Library: Library<57>. 
* Documentation: Documentation<55>. 
* Tests: Tests<52>. 
* Build: Build<54>. 
* Windows: Windows<52>. 
* macOS: macOS<42>. 
* IDLE: IDLE<42>. 
* Tools/Demos: Tools/Demos<31>. 
* C API: C API<51>. 

Python 3.6.5 final

* Tests: Tests<53>. 
* Build: Build<55>. 

Python 3.6.5 release candidate 1

* Security: Security<36>. 
* Core and Builtins: Core and Builtins<57>. 
* Library: Library<58>. 
* Documentation: Documentation<56>. 
* Tests: Tests<54>. 
* Build: Build<56>. 
* Windows: Windows<53>. 
* macOS: macOS<43>. 
* IDLE: IDLE<43>. 
* Tools/Demos: Tools/Demos<32>. 
* C API: C API<52>. 

Python 3.6.4 release candidate 1

* Core and Builtins: Core and Builtins<58>. 
* Library: Library<59>. 
* Documentation: Documentation<57>. 
* Tests: Tests<55>. 
* Build: Build<57>. 
* Windows: Windows<54>. 
* macOS: macOS<44>. 
* IDLE: IDLE<44>. 
* Tools/Demos: Tools/Demos<33>. 
* C API: C API<53>. 

Python 3.6.3 final

* Library: Library<60>. 
* Build: Build<58>. 

Python 3.6.3 release candidate 1

* Security: Security<37>. 
* Core and Builtins: Core and Builtins<59>. 
* Library: Library<61>. 
* Documentation: Documentation<58>. 
* Tests: Tests<56>. 
* Build: Build<59>. 
* Windows: Windows<55>. 
* IDLE: IDLE<45>. 
* Tools/Demos: Tools/Demos<34>. 

Python 3.6.2 release candidate 2

* Security: Security<38>. 

Python 3.6.2 release candidate 1

* Security: Security<39>. 
* Core and Builtins: Core and Builtins<60>. 
* Library: Library<62>. 
* IDLE: IDLE<46>. 
* C API: C API<54>. 
* Build: Build<60>. 
* Documentation: Documentation<59>. 
* Tools/Demos: Tools/Demos<35>. 
* Tests: Tests<57>. 
* Windows: Windows<56>. 

Python 3.6.1 final

* Core and Builtins: Core and Builtins<61>. 
* Build: Build<61>. 

Python 3.6.1 release candidate 1

* Core and Builtins: Core and Builtins<62>. 
* Library: Library<63>. 
* IDLE: IDLE<47>. 
* Windows: Windows<57>. 
* C API: C API<55>. 
* Documentation: Documentation<60>. 
* Tests: Tests<58>. 
* Build: Build<62>. 

Python 3.6.0 release candidate 2

* Core and Builtins: Core and Builtins<63>. 
* Tools/Demos: Tools/Demos<36>. 
* Windows: Windows<58>. 
* Build: Build<63>. 

Python 3.6.0 release candidate 1

* Core and Builtins: Core and Builtins<64>. 
* Library: Library<64>. 
* C API: C API<56>. 
* Documentation: Documentation<61>. 
* Tools/Demos: Tools/Demos<37>. 

Python 3.6.0 beta 4

* Core and Builtins: Core and Builtins<65>. 
* Library: Library<65>. 
* Documentation: Documentation<62>. 
* Tests: Tests<59>. 
* Build: Build<64>. 

Python 3.6.0 beta 3

* Core and Builtins: Core and Builtins<66>. 
* Library: Library<66>. 
* Windows: Windows<59>. 
* Build: Build<65>. 
* Tests: Tests<60>. 

Python 3.6.0 beta 2

* Core and Builtins: Core and Builtins<67>. 
* Library: Library<67>. 
* Windows: Windows<60>. 
* C API: C API<57>. 
* Build: Build<66>. 
* Tests: Tests<61>. 

Python 3.6.0 beta 1

* Core and Builtins: Core and Builtins<68>. 
* Library: Library<68>. 
* IDLE: IDLE<48>. 
* C API: C API<58>. 
* Tests: Tests<62>. 
* Build: Build<67>. 
* Tools/Demos: Tools/Demos<38>. 
* Windows: Windows<61>. 

Python 3.6.0 alpha 4

* Core and Builtins: Core and Builtins<69>. 
* Library: Library<69>. 
* IDLE: IDLE<49>. 
* Tests: Tests<63>. 
* Windows: Windows<62>. 
* Build: Build<68>. 

Python 3.6.0 alpha 3

* Security: Security<40>. 
* Core and Builtins: Core and Builtins<70>. 
* Library: Library<70>. 
* IDLE: IDLE<50>. 
* C API: C API<59>. 
* Build: Build<69>. 
* Tools/Demos: Tools/Demos<39>. 
* Documentation: Documentation<63>. 
* Tests: Tests<64>. 

Python 3.6.0 alpha 2

* Security: Security<41>. 
* Core and Builtins: Core and Builtins<71>. 
* Library: Library<71>. 
* IDLE: IDLE<51>. 
* Documentation: Documentation<64>. 
* Tests: Tests<65>. 
* Windows: Windows<63>. 
* Build: Build<70>. 
* C API: C API<60>. 
* Tools/Demos: Tools/Demos<40>. 

Python 3.6.0 alpha 1

* Security: Security<42>. 
* Core and Builtins: Core and Builtins<72>. 
* Library: Library<72>. 
* IDLE: IDLE<52>. 
* Documentation: Documentation<65>. 
* Tests: Tests<66>. 
* Build: Build<71>. 
* Windows: Windows<64>. 
* Tools/Demos: Tools/Demos<41>. 
* C API: C API<61>. 

Python 3.5.5 release candidate 1

* Security: Security<43>. 
* Core and Builtins: Core and Builtins<73>. 
* Library: Library<73>. 

Python 3.5.4 final

* Library: Library<74>. 

Python 3.5.4 release candidate 1

* Security: Security<44>. 
* Core and Builtins: Core and Builtins<74>. 
* Library: Library<75>. 
* Documentation: Documentation<66>. 
* Tests: Tests<67>. 
* Build: Build<72>. 
* Windows: Windows<65>. 
* C API: C API<62>. 

Python 3.5.3 release candidate 1

* Security: Security<45>. 
* Core and Builtins: Core and Builtins<75>. 
* Library: Library<76>. 
* IDLE: IDLE<53>. 
* C API: C API<63>. 
* Documentation: Documentation<67>. 
* Tests: Tests<68>. 
* Tools/Demos: Tools/Demos<42>. 
* Windows: Windows<66>. 
* Build: Build<73>. 

Python 3.5.2 final

* Core and Builtins: Core and Builtins<76>. 
* Tests: Tests<69>. 
* IDLE: IDLE<54>. 

Python 3.5.2 release candidate 1

* Security: Security<46>. 
* Core and Builtins: Core and Builtins<77>. 
* Library: Library<77>. 
* IDLE: IDLE<55>. 
* Documentation: Documentation<68>. 
* Tests: Tests<70>. 
* Build: Build<74>. 
* Windows: Windows<67>. 
* Tools/Demos: Tools/Demos<43>. 

Python 3.5.1 final

* Core and Builtins: Core and Builtins<78>. 
* Windows: Windows<68>. 

Python 3.5.1 release candidate 1

* Core and Builtins: Core and Builtins<79>. 
* Library: Library<78>. 
* IDLE: IDLE<56>. 
* Documentation: Documentation<69>. 
* Tests: Tests<71>. 
* Build: Build<75>. 
* Windows: Windows<69>. 
* Tools/Demos: Tools/Demos<44>. 

Python 3.5.0 final

* Build: Build<76>. 

Python 3.5.0 release candidate 4

* Library: Library<79>. 
* Build: Build<77>. 

Python 3.5.0 release candidate 3

* Core and Builtins: Core and Builtins<80>. 
* Library: Library<80>. 

Python 3.5.0 release candidate 2

* Core and Builtins: Core and Builtins<81>. 
* Library: Library<81>. 

Python 3.5.0 release candidate 1

* Core and Builtins: Core and Builtins<82>. 
* Library: Library<82>. 
* IDLE: IDLE<57>. 
* Documentation: Documentation<70>. 
* Tests: Tests<72>. 

Python 3.5.0 beta 4

* Core and Builtins: Core and Builtins<83>. 
* Library: Library<83>. 
* Build: Build<78>. 

Python 3.5.0 beta 3

* Core and Builtins: Core and Builtins<84>. 
* Library: Library<84>. 
* Tests: Tests<73>. 
* Documentation: Documentation<71>. 
* Build: Build<79>. 

Python 3.5.0 beta 2

* Core and Builtins: Core and Builtins<85>. 
* Library: Library<85>. 

Python 3.5.0 beta 1

* Core and Builtins: Core and Builtins<86>. 
* Library: Library<86>. 
* IDLE: IDLE<58>. 
* Tests: Tests<74>. 
* Documentation: Documentation<72>. 
* Tools/Demos: Tools/Demos<45>. 

Python 3.5.0 alpha 4

* Core and Builtins: Core and Builtins<87>. 
* Library: Library<87>. 
* Build: Build<80>. 
* Tests: Tests<75>. 
* Tools/Demos: Tools/Demos<46>. 
* C API: C API<64>. 

Python 3.5.0 alpha 3

* Core and Builtins: Core and Builtins<88>. 
* Library: Library<88>. 
* Build: Build<81>. 
* Tests: Tests<76>. 
* Tools/Demos: Tools/Demos<47>. 

Python 3.5.0 alpha 2

* Core and Builtins: Core and Builtins<89>. 
* Library: Library<89>. 
* Build: Build<82>. 
* C API: C API<65>. 
* Windows: Windows<70>. 

Python 3.5.0 alpha 1

* Core and Builtins: Core and Builtins<90>. 
* Library: Library<90>. 
* IDLE: IDLE<59>. 
* Build: Build<83>. 
* C API: C API<66>. 
* Documentation: Documentation<73>. 
* Tests: Tests<77>. 
* Tools/Demos: Tools/Demos<48>. 
* Windows: Windows<71>. 

El tutorial de Python

* Abriendo el apetito:: 
* Usando el intérprete de Python:: 
* Una introducción informal a Python:: 
* Más herramientas para control de flujo:: 
* Estructuras de datos:: 
* Módulos: Módulos<2>. 
* Entrada y salida:: 
* Errores y excepciones:: 
* Clases:: 
* Breve recorrido por la Biblioteca Estándar:: 
* Pequeño paseo por la Biblioteca Estándar— Parte II:: 
* Entornos virtuales y paquetes:: 
* ¿Y ahora qué?:: 
* Edición de entrada interactiva y sustitución de historial:: 
* Floating-Point Arithmetic; Issues and Limitations: Floating-Point Arithmetic Issues and Limitations. 
* Apéndice:: 

Usando el intérprete de Python

* Invocar el intérprete:: 
* El intérprete y su entorno:: 

Invocar el intérprete

* Paso de argumentos:: 
* Modo interactivo:: 

El intérprete y su entorno

* Codificación del código fuente:: 

Una introducción informal a Python

* Usando Python como una calculadora:: 
* Primeros pasos hacia la programación:: 

Usando Python como una calculadora

* Números:: 
* Texto:: 
* Listas:: 

Más herramientas para control de flujo

* La sentencia if:: 
* La sentencia for:: 
* La función range(): La función range. 
* break and continue Statements:: 
* else Clauses on Loops:: 
* La sentencia pass:: 
* La sentencia match:: 
* Definir funciones:: 
* Más sobre definición de funciones:: 
* Intermezzo; Estilo de programación: Intermezzo Estilo de programación. 

Más sobre definición de funciones

* Argumentos con valores por omisión:: 
* Palabras claves como argumentos:: 
* Parámetros especiales:: 
* Listas de argumentos arbitrarios:: 
* Desempaquetando una lista de argumentos:: 
* Expresiones lambda:: 
* Cadenas de texto de documentación:: 
* Anotación de funciones:: 

Parámetros especiales

* Argumentos posicionales o de palabras claves:: 
* Parámetros únicamente posicionales:: 
* Argumentos únicamente de palabras clave:: 
* Ejemplos de Funciones:: 
* Resumen:: 

Estructuras de datos

* Más sobre listas:: 
* La instrucción del:: 
* Tuplas y secuencias:: 
* Conjuntos:: 
* Diccionarios:: 
* Técnicas de iteración:: 
* Más acerca de condiciones:: 
* Comparando secuencias y otros tipos:: 

Más sobre listas

* Usar listas como pilas:: 
* Usar listas como colas:: 
* Comprensión de listas: Comprensión de listas<2>. 
* Listas por comprensión anidadas:: 

Módulos

* Más sobre los módulos:: 
* Módulos estándar:: 
* La función dir(): La función dir. 
* Paquetes:: 

Más sobre los módulos

* Ejecutar módulos como scripts:: 
* El camino de búsqueda de los módulos:: 
* Archivos «compilados» de Python:: 

Paquetes

* Importar * desde un paquete:: 
* Referencias internas en paquetes:: 
* Paquetes en múltiples directorios:: 

Entrada y salida

* Formateo elegante de la salida:: 
* Leyendo y escribiendo archivos:: 

Formateo elegante de la salida

* Formatear cadenas literales:: 
* El método format() de cadenas: El método format de cadenas. 
* Formateo manual de cadenas:: 
* Viejo formateo de cadenas:: 

Leyendo y escribiendo archivos

* Métodos de los objetos Archivo:: 
* Guardar datos estructurados con json:: 

Errores y excepciones

* Errores de sintaxis:: 
* Excepciones:: 
* Gestionando excepciones:: 
* Lanzando excepciones:: 
* Encadenamiento de excepciones:: 
* Excepciones definidas por el usuario:: 
* Definiendo acciones de limpieza:: 
* Acciones predefinidas de limpieza:: 
* Lanzando y gestionando múltiples excepciones no relacionadas:: 
* Enriqueciendo excepciones con notas:: 

Clases

* Unas palabras sobre nombres y objetos:: 
* Ámbitos y espacios de nombres en Python:: 
* Un primer vistazo a las clases:: 
* Algunas observaciones:: 
* Herencia:: 
* Variables privadas:: 
* Detalles y Cuestiones Varias:: 
* Iteradores:: 
* Generadores:: 
* Expresiones generadoras:: 

Ámbitos y espacios de nombres en Python

* Ejemplo de ámbitos y espacios de nombre:: 

Un primer vistazo a las clases

* Sintaxis de definición de clases:: 
* Objetos clase:: 
* Objetos instancia:: 
* Objetos método:: 
* Variables de clase y de instancia:: 

Herencia

* Herencia múltiple:: 

Breve recorrido por la Biblioteca Estándar

* Interfaz del sistema operativo:: 
* Comodines de archivos:: 
* Argumentos de Líneas de Comandos:: 
* Redirigir la salida de error y finalización del programa:: 
* Coincidencia de patrones de cadena:: 
* Matemáticas: Matemáticas<4>. 
* Acceso a Internet:: 
* Fechas y tiempos:: 
* Compresión de datos:: 
* Medición de rendimiento:: 
* Control de calidad:: 
* Pilas incluidas:: 

Pequeño paseo por la Biblioteca Estándar— Parte II

* Formato de salida:: 
* Plantillas:: 
* Trabajar con registros estructurados conteniendo datos binarios:: 
* Multi-hilos:: 
* Registrando:: 
* Referencias débiles:: 
* Herramientas para trabajar con listas:: 
* Decimal Floating-Point Arithmetic:: 

Entornos virtuales y paquetes

* Introducción: Introducción<4>. 
* Creando entornos virtuales:: 
* Manejando paquetes con pip:: 

Edición de entrada interactiva y sustitución de historial

* Autocompletado con tab e historial de edición:: 
* Alternativas al intérprete interactivo:: 

Floating-Point Arithmetic:  Issues and Limitations

* Error de Representación:: 

Apéndice

* Modo interactivo: Modo interactivo<2>. 

Modo interactivo

* Manejo de errores:: 
* Programas ejecutables de Python:: 
* El archivo de inicio interactivo:: 
* Los módulos de customización:: 

Configuración y uso de Python

* Línea de comandos y entorno:: 
* Uso de Python en plataformas Unix:: 
* Configurar Python:: 
* Uso de Python en Windows:: 
* Using Python on macOS:: 
* Using Python on Android:: 
* Using Python on iOS:: 
* Editores e IDEs:: 

Línea de comandos y entorno

* Línea de comando:: 
* Variables de entorno:: 

Línea de comando

* Opciones de interfaz:: 
* Opciones genéricas:: 
* Opciones diversas:: 
* Controlling color:: 
* Opciones que no se deben usar:: 

Variables de entorno

* Variables de modo de depuración:: 

Uso de Python en plataformas Unix

* Obteniendo e instalando la última versión de Python:: 
* Construyendo Python:: 
* Rutas y archivos relacionados con Python:: 
* Miscelánea:: 
* OpenSSL personalizado:: 

Obteniendo e instalando la última versión de Python

* En Linux:: 
* En FreeBSD y OpenBSD:: 

Configurar Python

* Requisitos de compilación:: 
* Archivos generados:: 
* Configurar opciones:: 
* Sistema de compilación Python:: 
* Banderas de compilador y vinculación:: 

Archivos generados

* configure script:: 

Configurar opciones

* Opciones generales:: 
* C compiler options:: 
* Opciones del enlazador:: 
* Options for third-party dependencies:: 
* Opciones de WebAssembly:: 
* Opciones de instalación:: 
* Opciones de desempeño:: 
* Compilación de depuración de Python:: 
* Opciones de depuración:: 
* Opciones del enlazador: Opciones del enlazador<2>. 
* Opciones de bibliotecas:: 
* Opciones de seguridad:: 
* Opciones macOS:: 
* iOS Options:: 
* Opciones de compilación cruzada:: 

Sistema de compilación Python

* Archivos principales del sistema de compilación:: 
* Pasos principales de compilación:: 
* Objetivos principales de Makefile:: 
* Extensiones C:: 

Objetivos principales de Makefile

* make:: 
* make platform:: 
* make profile-opt:: 
* make clean:: 
* make distclean:: 
* make install:: 
* make test:: 
* make ci:: 
* make buildbottest:: 
* make regen-all:: 

Banderas de compilador y vinculación

* Banderas del preprocesador:: 
* Banderas del compilador:: 
* Banderas de vinculación:: 

Uso de Python en Windows

* El instalador completo:: 
* El paquete Microsoft Store:: 
* El paquete de nuget.org: El paquete de nuget org. 
* El paquete incrustable:: 
* Distribuciones alternativas:: 
* Configuración de Python:: 
* Modo UTF-8:: 
* Lanzador de Python para Windows:: 
* Encontrar módulos:: 
* Módulos adicionales:: 
* Compilar Python en Windows:: 
* Otras plataformas:: 

El instalador completo

* Pasos para la instalación:: 
* Quitar el límite de MAX_PATH:: 
* Instalación sin interfaz de usuario:: 
* Instalación sin descargas:: 
* Modificar una instalación:: 
* Installing Free-threaded Binaries:: 

El paquete Microsoft Store

* Problemas conocidos:: 

Problemas conocidos

* Redirección de datos locales@comma{} registro y rutas temporales: Redirección de datos locales registro y rutas temporales. 

El paquete de nuget.org

* Free-threaded packages:: 

El paquete incrustable

* Aplicación Python:: 
* Incrustar Python:: 

Configuración de Python

* Excurso; configurar variables de entorno: Excurso configurar variables de entorno. 
* Encontrar el ejecutable de Python:: 

Lanzador de Python para Windows

* Comenzar:: 
* Líneas shebang:: 
* Argumentos en líneas shebang:: 
* Personalización:: 
* Diagnóstico:: 
* Ejecución en seco:: 
* Instalación bajo demanda:: 
* Códigos de retorno:: 

Comenzar

* Desde la línea de comandos:: 
* Entornos virtuales:: 
* Desde un script:: 
* Desde asociaciones de archivos:: 

Personalización

* Personalización con archivos INI:: 
* Personalizar las versiones de Python predeterminadas:: 

Módulos adicionales

* PyWin32:: 
* cx_Freeze:: 

Using Python on macOS

* Using Python for macOS from python.org: Using Python for macOS from python org. 
* Alternative Distributions:: 
* Instalación de paquetes adicionales de Python:: 
* GUI Programming:: 
* Advanced Topics:: 
* Otros recursos:: 

Using Python for macOS from python.org

* Installation steps:: 
* Cómo ejecutar un script de Python:: 

Advanced Topics

* Installing Free-threaded Binaries: Installing Free-threaded Binaries<2>. 
* Installing using the command line:: 
* Distributing Python Applications:: 
* App Store Compliance:: 

Using Python on Android

* Adding Python to an Android app:: 

Using Python on iOS

* Python at runtime on iOS:: 
* Installing Python on iOS:: 
* App Store Compliance: App Store Compliance<2>. 

Python at runtime on iOS

* iOS version compatibility:: 
* Platform identification:: 
* Standard library availability:: 
* Binary extension modules:: 
* Compiler stub binaries:: 

Installing Python on iOS

* Tools for building iOS apps:: 
* Adding Python to an iOS project:: 

Referencia del Lenguaje Python

* Introducción: Introducción<5>. 
* Análisis léxico:: 
* Modelo de datos:: 
* Modelo de ejecución:: 
* El sistema de importación:: 
* Expresiones:: 
* Declaraciones simples:: 
* Sentencias compuestas:: 
* Componentes de nivel superior:: 
* Especificación completa de la gramática:: 

Introducción

* Implementaciones alternativas:: 
* Notación:: 

Análisis léxico

* Estructura de línea:: 
* Otros tokens:: 
* Identificadores y palabras clave:: 
* Literales:: 
* Operadores:: 
* Delimitadores:: 

Estructura de línea

* Líneas lógicas:: 
* Líneas físicas:: 
* Comentarios:: 
* Declaración de Codificación:: 
* Unión explícita de líneas:: 
* Unión implícita de líneas:: 
* Líneas en blanco:: 
* Sangría:: 
* Espacios en blanco entre tokens:: 

Identificadores y palabras clave

* Palabras clave:: 
* Palabras clave suaves:: 
* Clases reservadas de identificadores:: 

Literales

* Literales de cadenas y bytes:: 
* Concatenación de literales de cadena:: 
* f-strings:: 
* Literales numéricos:: 
* Literales enteros:: 
* Floating-point literals:: 
* Literales imaginarios:: 

Literales de cadenas y bytes

* Escape sequences:: 

Modelo de datos

* Objetos@comma{} valores y tipos: Objetos valores y tipos. 
* Jerarquía de tipos estándar:: 
* Nombres especiales de método:: 
* Corrutinas:: 

Jerarquía de tipos estándar

* None:: 
* NotImplemented:: 
* Elipsis:: 
* numbers.Number: numbers Number. 
* Secuencias:: 
* Tipos de conjuntos:: 
* Mapeos:: 
* Tipos invocables:: 
* Módulos: Módulos<3>. 
* Clases personalizadas:: 
* Instancias de clase:: 
* Objetos E/S (también conocidos como objetos de archivo): Objetos E/S también conocidos como objetos de archivo. 
* Tipos internos:: 

numbers.Number

* numbers.Integral: numbers Integral. 
* numbers.Real (float): numbers Real float. 
* numbers.Complex (complex): numbers Complex complex. 

Secuencias

* Secuencias inmutables:: 
* Secuencias mutables:: 

Mapeos

* Diccionarios: Diccionarios<2>. 

Tipos invocables

* Funciones definidas por el usuario:: 
* Métodos de instancia:: 
* Funciones generadoras:: 
* Funciones de corrutina:: 
* Funciones generadoras asincrónicas:: 
* Funciones incorporadas:: 
* Métodos incorporados:: 
* Clases: Clases<2>. 
* Instancias de clases:: 

Funciones definidas por el usuario

* Special read-only attributes:: 
* Special writable attributes:: 

Módulos

* Import-related attributes on module objects:: 
* Other writable attributes on module objects:: 
* Module dictionaries:: 

Clases personalizadas

* Special attributes:: 
* Special methods:: 

Instancias de clase

* Special attributes: Special attributes<2>. 

Tipos internos

* Objetos de código:: 
* Objetos de marco:: 
* Objetos de seguimiento de pila (traceback): Objetos de seguimiento de pila traceback. 
* Objetos de segmento (Slice objects): Objetos de segmento Slice objects. 
* Objetos de método estático:: 
* Objetos de método de clase:: 

Objetos de código

* Special read-only attributes: Special read-only attributes<2>. 
* Methods on code objects:: 

Objetos de marco

* Special read-only attributes: Special read-only attributes<3>. 
* Special writable attributes: Special writable attributes<2>. 
* Frame object methods:: 

Nombres especiales de método

* Personalización básica:: 
* Personalizando acceso a atributos:: 
* Personalización de creación de clases:: 
* Personalizando revisiones de instancia y subclase:: 
* Emulando tipos genéricos:: 
* Emulando objetos que se pueden llamar:: 
* Emulando tipos de contenedores:: 
* Emulando tipos numéricos:: 
* Gestores de Contexto en la Declaración with:: 
* Personalización de argumentos posicionales en la coincidencia de patrones de clase:: 
* Emulando tipos de búfer:: 
* Annotations:: 
* Búsqueda de método especial:: 

Personalizando acceso a atributos

* Personalizando acceso a atributos de módulo:: 
* Implementando descriptores:: 
* Invocando descriptores:: 
* __slots__: __slots__<2>. 

Personalización de creación de clases

* Metaclases:: 
* Resolviendo entradas de la Orden de Resolución de Métodos (MRU): Resolviendo entradas de la Orden de Resolución de Métodos MRU. 
* Determinando la metaclase adecuada:: 
* Preparando el espacio de nombres de la clase:: 
* Ejecutando el cuerpo de la clase:: 
* Creando el objeto de clase:: 
* Usos para metaclases:: 

Emulando tipos genéricos

* El propósito de __class_getitem__:: 
* __class_getitem__ frente a __getitem__:: 

Corrutinas

* Objetos esperables:: 
* Objetos de corrutina:: 
* Iteradores asíncronos:: 
* Gestores de contexto asíncronos:: 

Modelo de ejecución

* Estructura de un programa:: 
* Nombres y vínculos:: 
* Excepciones: Excepciones<2>. 

Nombres y vínculos

* Vinculación de nombres:: 
* Resolución de nombres:: 
* Ámbitos de anotación:: 
* Evaluación perezosa:: 
* Integraciones y ejecución restringida:: 
* Interacción con funcionalidades dinámicas:: 

El sistema de importación

* importlib: importlib<11>. 
* Paquetes: Paquetes<2>. 
* Buscando:: 
* Cargando:: 
* El buscador basado en rutas:: 
* Reemplazando el sistema de importación estándar:: 
* Paquete Importaciones relativas:: 
* Consideraciones especiales para __main__:: 
* Referencias:: 

Paquetes

* Paquetes regulares:: 
* Paquetes de espacio de nombres:: 

Buscando

* La caché del módulo:: 
* Buscadores y cargadores:: 
* Ganchos de importación:: 
* La meta ruta (path): La meta ruta path. 

Cargando

* Cargadores:: 
* Submódulos:: 
* Module specs:: 
* __path__ attributes on modules:: 
* Representación (Reprs) de módulos: Representación Reprs de módulos. 
* Invalidación del código de bytes en caché:: 

El buscador basado en rutas

* Buscadores de entradas de ruta:: 
* Buscadores de entradas de ruta: Buscadores de entradas de ruta<2>. 

Consideraciones especiales para __main__

* __main__.__spec__: __main__ __spec__. 

Expresiones

* Conversiones aritméticas:: 
* Átomos:: 
* Primarios:: 
* Expresión await:: 
* El operador de potencia:: 
* Aritmética unaria y operaciones bit a bit:: 
* Operaciones aritméticas binarias:: 
* Operaciones de desplazamiento:: 
* Operaciones bit a bit binarias:: 
* Comparaciones:: 
* Operaciones booleanas:: 
* Expresiones de asignación: Expresiones de asignación<2>. 
* Expresiones condicionales:: 
* Lambdas:: 
* Listas de expresiones:: 
* Orden de evaluación:: 
* Prioridad de operador:: 

Átomos

* Identificadores (Nombres): Identificadores Nombres. 
* Literales: Literales<2>. 
* Formas entre paréntesis:: 
* Despliegues para listas@comma{} conjuntos y diccionarios: Despliegues para listas conjuntos y diccionarios. 
* Despliegues de lista:: 
* Despliegues de conjuntos:: 
* Despliegues de diccionario:: 
* Expresiones de generador:: 
* Expresiones yield:: 

Identificadores (Nombres)

* Private name mangling:: 

Expresiones yield

* Métodos generador-iterador:: 
* Ejemplos:: 
* Funciones generadoras asincrónicas: Funciones generadoras asincrónicas<2>. 
* Métodos asincrónicos de generador-iterador:: 

Primarios

* Referencias de atributos:: 
* Suscripciones:: 
* Segmentos:: 
* Invocaciones:: 

Comparaciones

* Comparaciones de valor:: 
* Operaciones de prueba de membresía:: 
* Comparaciones de identidad:: 

Declaraciones simples

* Declaraciones de tipo expresión:: 
* Declaraciones de asignación:: 
* La declaración assert:: 
* La declaración pass:: 
* La declaración del:: 
* La declaración return:: 
* La declaración yield:: 
* La declaración raise:: 
* La declaración break:: 
* La declaración continue:: 
* La declaración import:: 
* La declaración global:: 
* La declaración nonlocal:: 
* The type statement:: 

Declaraciones de asignación

* Declaraciones de asignación aumentada:: 
* Declaraciones de asignación anotadas:: 

La declaración import

* Declaraciones Futuras:: 

Sentencias compuestas

* La sentencia if: La sentencia if<2>. 
* La sentencia while:: 
* La sentencia for: La sentencia for<2>. 
* La sentencia try:: 
* La sentencia with:: 
* La sentencia match: La sentencia match<2>. 
* Definiciones de funciones:: 
* Definiciones de clase:: 
* Corrutinas: Corrutinas<2>. 
* Type parameter lists:: 
* Annotations: Annotations<2>. 

La sentencia try

* Cláusula except:: 
* Cláusula except*:: 
* La sentencia else:: 
* Cláusula finally:: 

La sentencia match

* Resumen: Resumen<2>. 
* Protecciones:: 
* Bloques de Casos Irrefutables:: 
* Patrones:: 

Patrones

* Patrones OR:: 
* patrones AS:: 
* Patrones literales:: 
* Patrones de captura:: 
* Patrones comodín:: 
* Patrones de valor:: 
* Patrones de grupo:: 
* Patrones de secuencia:: 
* Patrones de mapeo:: 
* Patrones de clase:: 

Corrutinas

* Definición de la función corrutina:: 
* La sentencia async for:: 
* La sentencia async with:: 

Type parameter lists

* Generic functions:: 
* Generic classes:: 
* Generic type aliases:: 

Componentes de nivel superior

* Programas completos de Python:: 
* Entrada de archivo:: 
* Entrada interactiva:: 
* Entrada de expresión:: 

La biblioteca estándar de Python

* Introducción: Introducción<6>. 
* Funciones incorporadas: Funciones incorporadas<2>. 
* Constantes incorporadas:: 
* Tipos integrados:: 
* Excepciones incorporadas:: 
* Servicios de procesamiento de texto:: 
* Servicios de datos binarios:: 
* Tipos de datos:: 
* Módulos numéricos y matemáticos:: 
* Módulos de programación funcional:: 
* Acceso a archivos y directorios:: 
* Persistencia de datos:: 
* Compresión de datos y archivado:: 
* Formatos de archivo:: 
* Servicios criptográficos:: 
* Servicios genéricos del sistema operativo:: 
* Ejecución concurrente:: 
* Comunicación en redes y entre procesos:: 
* Manejo de datos de internet:: 
* Herramientas Para Procesar Formatos de Marcado Estructurado:: 
* Protocolos y soporte de Internet:: 
* Servicios Multimedia:: 
* Internacionalización:: 
* Frameworks de programa:: 
* Interfaces gráficas de usuario con Tk:: 
* Herramientas de desarrollo:: 
* Depuración y perfilado:: 
* Empaquetado y distribución de software:: 
* Servicios en tiempo de ejecución de Python:: 
* Intérpretes de Python personalizados:: 
* Importando módulos:: 
* Servicios del lenguaje Python:: 
* Servicios Específicos para MS Windows:: 
* Servicios específicos de Unix:: 
* Modules command-line interface (CLI): Modules command-line interface CLI. 
* Módulos reemplazados:: 
* Removed Modules:: 
* Consideraciones de seguridad: Consideraciones de seguridad<4>. 

Introducción

* Notas sobre la disponibilidad:: 

Notas sobre la disponibilidad

* Plataformas WebAssembly:: 
* Mobile platforms:: 

Constantes incorporadas

* Constantes agregadas por el módulo site:: 

Tipos integrados

* Evaluar como valor verdadero/falso:: 
* Operaciones booleanas — and@comma{} or@comma{} not: Operaciones booleanas — and or not. 
* Comparaciones: Comparaciones<2>. 
* Tipos numéricos — int@comma{} float@comma{} complex: Tipos numéricos — int float complex. 
* Boolean Type - bool:: 
* Tipos de iteradores:: 
* Tipos secuencia — list@comma{} tuple@comma{} range: Tipos secuencia — list tuple range. 
* Cadenas de caracteres — str:: 
* Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview: Tipos de secuencias binarias — bytes bytearray y memoryview. 
* Conjuntos — set@comma{} frozenset: Conjuntos — set frozenset. 
* Tipos mapa — dict:: 
* Tipos gestores de contexto:: 
* Tipos de anotaciones de type — alias genérico@comma{} Union: Tipos de anotaciones de type — alias genérico Union. 
* Otros tipos predefinidos:: 
* Atributos especiales:: 
* Limitación de longitud de conversión de cadena de tipo entero:: 

Tipos numéricos — int, float, complex

* Operaciones de bits en números enteros:: 
* Métodos adicionales de los enteros:: 
* Métodos adicionales de float:: 
* Additional Methods on Complex:: 
* Calculo del hash de tipos numéricos:: 

Tipos de iteradores

* Tipos generador:: 

Tipos secuencia — list, tuple, range

* Operaciones comunes de las secuencias:: 
* Tipos de secuencia inmutables:: 
* Tipos de secuencia mutables:: 
* Listas: Listas<2>. 
* Tuplas:: 
* Rangos:: 

Cadenas de caracteres — str

* Métodos de las cadenas de caracteres:: 
* Formateo de cadenas al estilo *printf*:: 

Tipos de secuencias binarias — bytes, bytearray y memoryview

* Objetos de tipo Bytes:: 
* Objetos de tipo Bytearray:: 
* Operaciones de bytes y bytearray:: 
* Usando el formateo tipo printf con bytes:: 
* Vistas de memoria:: 

Tipos mapa — dict

* Objetos tipos vista de diccionario:: 

Tipos de anotaciones de type — alias genérico, Union

* Tipo Alias Genérico:: 
* Tipo de conversión:: 

Tipo Alias Genérico

* Clases genéricas estándar:: 
* Atributos especiales de los objetos GenericAlias:: 

Otros tipos predefinidos

* Módulos: Módulos<4>. 
* Clases e instancias de clase:: 
* Funciones:: 
* Métodos:: 
* Objetos código:: 
* Objetos Tipo:: 
* El objeto nulo (Null): El objeto nulo Null. 
* El objeto puntos suspensivos (Ellipsis): El objeto puntos suspensivos Ellipsis. 
* El objeto NotImplemented:: 
* Objetos internos:: 

Limitación de longitud de conversión de cadena de tipo entero

* APIs afectadas:: 
* Configuración del límite:: 
* Configuración recomendada:: 

Excepciones incorporadas

* Contexto de una excepción:: 
* Heredando de excepciones incorporadas:: 
* Clases base:: 
* Excepciones específicas:: 
* Advertencias:: 
* Grupos de excepciones:: 
* Jerarquía de excepción:: 

Excepciones específicas

* Excepciones del sistema operativo:: 

Servicios de procesamiento de texto

* string — Common string operations:: 
* re — Regular expression operations:: 
* difflib — Helpers for computing deltas:: 
* textwrap — Text wrapping and filling:: 
* unicodedata — Unicode Database:: 
* stringprep — Internet String Preparation:: 
* readline — GNU readline interface:: 
* rlcompleter — Completion function for GNU readline:: 

string — Common string operations

* Constantes de cadenas:: 
* Formato de cadena de caracteres personalizado:: 
* Sintaxis de formateo de cadena:: 
* Cadenas de plantillas:: 
* Funciones de ayuda:: 

Sintaxis de formateo de cadena

* Especificación de formato Mini-Lenguaje:: 
* Ejemplos de formateo:: 

re — Regular expression operations

* Sintaxis de expresiones regulares:: 
* Contenidos del módulo:: 
* Objetos expresión regular:: 
* Objetos de coincidencia:: 
* Ejemplos de expresiones regulares:: 

Contenidos del módulo

* Indicadores:: 
* Funciones: Funciones<2>. 
* Excepciones: Excepciones<3>. 

Ejemplos de expresiones regulares

* Buscando un par:: 
* Simular scanf(): Simular scanf. 
* search() vs. match(): search vs match. 
* Haciendo una guía telefónica:: 
* Mungear texto:: 
* Encontrar todos los adverbios:: 
* Encontrar todos los adverbios y sus posiciones:: 
* Notación de cadena raw:: 
* Escribir un Tokenizador:: 

difflib — Helpers for computing deltas

* Objetos SequenceMatcher:: 
* SequenceMatcher Ejemplos:: 
* Objetos Differ:: 
* Ejemplo de Differ:: 
* Una interfaz de línea de comandos para difflib:: 
* ndiff example:: 

readline — GNU readline interface

* Archivo de inicio:: 
* Búfer de línea:: 
* Archivo de historial:: 
* Lista del historial:: 
* Ganchos (hooks) de inicialización: Ganchos hooks de inicialización. 
* Terminación:: 
* Ejemplo:: 

Servicios de datos binarios

* struct — Interpret bytes as packed binary data:: 
* codecs — Codec registry and base classes:: 

struct — Interpret bytes as packed binary data

* Funciones y excepciones:: 
* Cadenas de formato:: 
* Aplicaciones:: 
* Clases: Clases<3>. 

Cadenas de formato

* Orden de bytes@comma{} tamaño y alineación: Orden de bytes tamaño y alineación. 
* Caracteres de formato:: 
* Ejemplos: Ejemplos<2>. 

Aplicaciones

* Formatos nativos:: 
* Formatos estándar:: 

codecs — Codec registry and base classes

* Clases Base de Códec:: 
* Codificaciones y Unicode:: 
* Codificaciones estándar:: 
* Codificaciones específicas de Python:: 
* encodings.idna — Nombres de dominio internacionalizados en aplicaciones: encodings idna — Nombres de dominio internacionalizados en aplicaciones. 
* encodings.mbcs — Página de códigos ANSI de Windows: encodings mbcs — Página de códigos ANSI de Windows. 
* encodings.utf_8_sig — Códec UTF-8 con firma BOM: encodings utf_8_sig — Códec UTF-8 con firma BOM. 

Clases Base de Códec

* Manejadores de errores:: 
* Codificación y decodificación sin estado:: 
* Codificación y decodificación incrementales:: 
* Codificación y decodificación de flujos:: 

Codificación y decodificación incrementales

* Objetos IncrementalEncoder:: 
* Objetos IncrementalDecoder:: 

Codificación y decodificación de flujos

* Objetos StreamWriter:: 
* Objetos StreamReader:: 
* Objetos StreamReaderWriter:: 
* Objetos StreamRecoder:: 

Codificaciones específicas de Python

* Codificaciones de texto:: 
* Transformaciones Binarias:: 
* Transformaciones de texto:: 

Tipos de datos

* datetime — Basic date and time types:: 
* zoneinfo — IANA time zone support:: 
* calendar — General calendar-related functions:: 
* collections — Container datatypes:: 
* collections.abc — Abstract Base Classes for Containers: collections abc — Abstract Base Classes for Containers. 
* heapq — Heap queue algorithm:: 
* bisect — Array bisection algorithm:: 
* array — Efficient arrays of numeric values:: 
* weakref — Referencias débiles:: 
* types — Dynamic type creation and names for built-in types:: 
* copy — Shallow and deep copy operations:: 
* pprint — Data pretty printer:: 
* reprlib — Alternate repr() implementation: reprlib — Alternate repr implementation. 
* enum — Support for enumerations:: 
* graphlib — Functionality to operate with graph-like structures:: 

datetime — Basic date and time types

* Objetos conscientes (aware) y naífs (naive): Objetos conscientes aware y naífs naive. 
* Constantes:: 
* Tipos disponibles:: 
* Objetos timedelta:: 
* Objeto date:: 
* Objetos datetime:: 
* Objetos time:: 
* Objetos tzinfo:: 
* Objetos timezone:: 
* strftime() and strptime() Behavior: strftime and strptime Behavior. 

Tipos disponibles

* Propiedades comunes:: 
* Determinando si un objeto es Consciente (Aware) o Naíf (Naive): Determinando si un objeto es Consciente Aware o Naíf Naive. 

Objetos timedelta

* Ejemplos de uso; timedelta: Ejemplos de uso timedelta. 

Objeto date

* Ejemplos de uso; date: Ejemplos de uso date. 

Objetos datetime

* Ejemplos de uso; datetime: Ejemplos de uso datetime. 

Objetos time

* Ejemplos de uso; time: Ejemplos de uso time. 

strftime() and strptime() Behavior

* strftime() and strptime() Format Codes: strftime and strptime Format Codes. 
* Detalle técnico:: 

zoneinfo — IANA time zone support

* Usando ZoneInfo:: 
* Fuentes de datos:: 
* La clase ZoneInfo:: 
* Funciones: Funciones<3>. 
* Globales:: 
* Excepciones y advertencias:: 

Fuentes de datos

* Configurando los orígenes de datos:: 

Configurando los orígenes de datos

* Configuración en tiempo de compilación:: 
* Configuración del entorno:: 
* Configuración de tiempo de ejecución:: 

La clase ZoneInfo

* Representaciones de cadenas:: 
* Serialización de Pickle:: 

calendar — General calendar-related functions

* Uso de la línea de comandos:: 

collections — Container datatypes

* Objetos ChainMap:: 
* Objetos Counter:: 
* Objetos deque:: 
* Objetos defaultdict:: 
* namedtuple() Funciones Factory para Tuplas y Campos con Nombres: namedtuple Funciones Factory para Tuplas y Campos con Nombres. 
* Objetos OrderedDict:: 
* Objetos UserDict:: 
* Objetos UserList:: 
* Objetos UserString:: 

Objetos ChainMap

* Ejemplos y recetas ChainMap:: 

Objetos deque

* Recetas deque:: 

Objetos defaultdict

* Ejemplos defaultdict:: 

Objetos OrderedDict

* Ejemplos y recetas OrderedDict:: 

collections.abc — Abstract Base Classes for Containers

* Colecciones clases base abstractas:: 
* Colecciones Clases base abstractas - Descripciones detalladas:: 
* Ejemplos y Recetas:: 

heapq — Heap queue algorithm

* Ejemplos Básicos:: 
* Notas de Aplicación de la Cola de Prioridades:: 
* Teoría:: 

bisect — Array bisection algorithm

* Notas de rendimiento:: 
* Búsqueda en listas ordenadas:: 
* Ejemplos: Ejemplos<3>. 

weakref — Referencias débiles

* Objetos de referencias débiles:: 
* Ejemplo: Ejemplo<2>. 
* Objetos finalizadores:: 
* Comparando finalizadores con los métodos __del__(): Comparando finalizadores con los métodos __del__. 

types — Dynamic type creation and names for built-in types

* Creación dinámica de tipos:: 
* Tipos de Intérpretes Estándar:: 
* Clases y funciones de utilidad adicionales:: 
* Funciones de utilidad de corutina:: 

pprint — Data pretty printer

* Functions:: 
* Objetos PrettyPrinter:: 
* Ejemplo: Ejemplo<3>. 

reprlib — Alternate repr() implementation

* Objetos Repr:: 
* Subclasificando Objetos Repr:: 

enum — Support for enumerations

* Contenido del Módulo:: 
* Tipos de datos: Tipos de datos<2>. 
* Utilidades y decoradores:: 
* Notas:: 

Tipos de datos

* Nombres soportados __dunder__:: 
* Nombres _sunder_ compatibles:: 

graphlib — Functionality to operate with graph-like structures

* Excepciones: Excepciones<4>. 

Módulos numéricos y matemáticos

* numbers — Numeric abstract base classes:: 
* math — Mathematical functions:: 
* cmath — Mathematical functions for complex numbers:: 
* decimal — Decimal fixed-point and floating-point arithmetic:: 
* fractions — Rational numbers:: 
* random — Generate pseudo-random numbers:: 
* statistics — Mathematical statistics functions:: 

numbers — Numeric abstract base classes

* La torre numérica:: 
* Notes for type implementers:: 

Notes for type implementers

* Agregar más ABCs numéricos:: 
* Implementar operaciones aritméticas:: 

math — Mathematical functions

* Teoría de números y funciones de representación:: 
* Funciones logarítmicas y exponenciales:: 
* Funciones trigonométricas:: 
* Conversión angular:: 
* Funciones hiperbólicas:: 
* Funciones especiales:: 
* Constantes: Constantes<2>. 

cmath — Mathematical functions for complex numbers

* Conversión a y desde coordenadas polares:: 
* Funciones logarítmicas y de potencias:: 
* Funciones trigonométricas: Funciones trigonométricas<2>. 
* Funciones hiperbólicas: Funciones hiperbólicas<2>. 
* Funciones de clasificación:: 
* Constantes: Constantes<3>. 

decimal — Decimal fixed-point and floating-point arithmetic

* Tutorial de inicio rápido:: 
* Objetos Decimal:: 
* Objetos context:: 
* Constantes: Constantes<4>. 
* Modos de redondeo:: 
* Señales:: 
* Floating-Point Notes:: 
* Trabajando con hilos:: 
* Casos prácticos:: 
* Preguntas frecuentes sobre decimal:: 

Objetos Decimal

* Operandos lógicos:: 

Floating-Point Notes

* Mitigación del error de redondeo usando mayor precisión:: 
* Valores especiales:: 

random — Generate pseudo-random numbers

* Funciones de contabilidad:: 
* Funciones para los bytes:: 
* Funciones para enteros:: 
* Funciones para secuencias:: 
* Discrete distributions:: 
* Distribuciones para los nombres reales:: 
* Generador alternativo:: 
* Notas sobre la Reproducibilidad:: 
* Ejemplos: Ejemplos<4>. 
* Recetas:: 
* Command-line usage:: 
* Command-line example:: 

statistics — Mathematical statistics functions

* Promedios y medidas de tendencia central:: 
* Medidas de dispersión:: 
* Estadísticas para relaciones entre dos entradas:: 
* Detalles de las funciones:: 
* Excepciones: Excepciones<5>. 
* Objetos NormalDist:: 
* Examples and Recipes:: 

Examples and Recipes

* Problemas de probabilidad clásicos:: 
* Entradas de Monte Carlo para simulaciones:: 
* Aproximación de la distribución binomial:: 
* Clasificador bayesiano ingenuo:: 

Módulos de programación funcional

* itertools — Functions creating iterators for efficient looping:: 
* functools — Higher-order functions and operations on callable objects:: 
* operator — Standard operators as functions:: 

itertools — Functions creating iterators for efficient looping

* Itertool Functions:: 
* Fórmulas con itertools:: 

functools — Higher-order functions and operations on callable objects

* partial Objetos:: 

operator — Standard operators as functions

* Asignación de operadores a funciones:: 
* Operadores In-place:: 

Acceso a archivos y directorios

* pathlib — Object-oriented filesystem paths:: 
* os.path — Common pathname manipulations: os path — Common pathname manipulations. 
* fileinput — Iterate over lines from multiple input streams:: 
* stat — Interpreting stat() results: stat — Interpreting stat results. 
* filecmp — File and Directory Comparisons:: 
* tempfile — Generate temporary files and directories:: 
* glob — Unix style pathname pattern expansion:: 
* fnmatch — Unix filename pattern matching:: 
* linecache — Random access to text lines:: 
* shutil — High-level file operations:: 

pathlib — Object-oriented filesystem paths

* Uso básico:: 
* Exceptions:: 
* Rutas puras:: 
* Rutas concretas:: 
* Pattern language:: 
* Comparison to the glob module:: 
* Comparison to the os and os.path modules: Comparison to the os and os path modules. 

Rutas puras

* Propiedades generales:: 
* Operadores: Operadores<2>. 
* Acceso a partes individuales:: 
* Métodos y propiedades:: 

Rutas concretas

* Parsing and generating URIs:: 
* Expanding and resolving paths:: 
* Querying file type and status:: 
* Reading and writing files:: 
* Reading directories:: 
* Creating files and directories:: 
* Copying@comma{} moving and deleting: Copying moving and deleting. 
* Permissions and ownership:: 

Comparison to the os and os.path modules

* Corresponding tools:: 

filecmp — File and Directory Comparisons

* La clase dircmp:: 

tempfile — Generate temporary files and directories

* Ejemplos: Ejemplos<5>. 
* Funciones y variables deprecadas:: 

glob — Unix style pathname pattern expansion

* Examples:: 

shutil — High-level file operations

* Operaciones de directorios y archivos:: 
* Operaciones de archivado:: 
* Consulta el tamaño de la terminal de salida:: 

Operaciones de directorios y archivos

* Operaciones de copia eficientes dependientes de la plataforma:: 
* ejemplo de copytree:: 
* ejemplo de rmtree:: 

Operaciones de archivado

* Ejemplo de archivado:: 
* Ejemplo de archivado con base_dir:: 

Persistencia de datos

* pickle — Python object serialization:: 
* copyreg — Register pickle support functions:: 
* shelve — Python object persistence:: 
* marshal — Internal Python object serialization:: 
* dbm — Interfaces to Unix «databases»:: 
* sqlite3 — DB-API 2.0 interface for SQLite databases: sqlite3 — DB-API 2 0 interface for SQLite databases. 

pickle — Python object serialization

* Relación con otros módulos de Python:: 
* Formato de flujo de datos:: 
* Interfaz del módulo:: 
* ¿Qué se puede serializar (pickled) y deserializar (unpickled) con pickle?: ¿Qué se puede serializar pickled y deserializar unpickled con pickle?. 
* Pickling de Instancias de clases:: 
* Reducción personalizada para tipos@comma{} funciones y otros objetos: Reducción personalizada para tipos funciones y otros objetos. 
* Búferes fuera de banda:: 
* Restricción de globals:: 
* Performance:: 
* Ejemplos: Ejemplos<6>. 

Relación con otros módulos de Python

* Comparación con marshal:: 
* Comparación con json:: 

Pickling de Instancias de clases

* Persistencia de objetos externos:: 
* Tablas de despacho:: 
* Manejo de objetos con estado:: 

Búferes fuera de banda

* API de proveedor:: 
* API de consumidor:: 
* Ejemplo: Ejemplo<4>. 

copyreg — Register pickle support functions

* Ejemplo: Ejemplo<5>. 

shelve — Python object persistence

* Restricciones:: 
* Ejemplo: Ejemplo<6>. 

dbm — Interfaces to Unix «databases»

* dbm.sqlite3 — SQLite backend for dbm: dbm sqlite3 — SQLite backend for dbm. 
* dbm.gnu — GNU database manager: dbm gnu — GNU database manager. 
* dbm.ndbm — New Database Manager: dbm ndbm — New Database Manager. 
* dbm.dumb — Implementación de DBM portátil: dbm dumb — Implementación de DBM portátil. 

sqlite3 — DB-API 2.0 interface for SQLite databases

* Tutorial:: 
* Referencia:: 
* Guías prácticas:: 
* Explicación:: 

Referencia

* Funciones del módulo:: 
* Constantes del módulo:: 
* Objetos de conexión:: 
* Objetos cursor:: 
* Objetos fila (Row): Objetos fila Row. 
* Objetos fila (Row): Objetos fila Row<2>. 
* Objetos PrepareProtocol:: 
* Excepciones: Excepciones<6>. 
* SQLite y tipos de Python:: 
* Default adapters and converters (deprecated): Default adapters and converters deprecated. 
* Command-line interface:: 

Guías prácticas

* Cómo usar marcadores de posición para vincular valores en consultas SQL:: 
* Cómo adaptar tipos de Python personalizados a valores de SQLite:: 
* Como convertir valores SQLite a tipos de Python personalizados:: 
* Ejemplos para adaptadores y convertidores:: 
* Cómo utilizar los métodos de acceso directo de conexión:: 
* Como usar la conexión con un administrador de contexto:: 
* Como trabajar con URIs SQLite:: 
* How to create and use row factories:: 
* How to handle non-UTF-8 text encodings:: 

Cómo adaptar tipos de Python personalizados a valores de SQLite

* Cómo escribir objetos adaptables:: 
* Como registrar un adaptador invocable:: 

Explicación

* Control transaccional:: 

Control transaccional

* Transaction control via the autocommit attribute:: 
* Transaction control via the isolation_level attribute:: 

Compresión de datos y archivado

* zlib — Compression compatible with gzip:: 
* gzip — Support for gzip files:: 
* bz2 — Support for bzip2 compression:: 
* lzma — Compression using the LZMA algorithm:: 
* zipfile — Work with ZIP archives:: 
* tarfile — Read and write tar archive files:: 

gzip — Support for gzip files

* Ejemplos de uso:: 
* Interfaz de Línea de Comandos:: 

Interfaz de Línea de Comandos

* Opciones de línea de comandos:: 

bz2 — Support for bzip2 compression

* (De)compresión de archivos: De compresión de archivos. 
* (De)compresión incremental: De compresión incremental. 
* (Des)comprimir en un solo paso: Des comprimir en un solo paso. 
* Ejemplos de uso: Ejemplos de uso<2>. 

lzma — Compression using the LZMA algorithm

* Leyendo y escribiendo ficheros comprimidos:: 
* Comprimiendo y descomprimiendo datos en memoria:: 
* Misceláneas:: 
* Especificando cadenas de filtro personalizadas:: 
* Ejemplos: Ejemplos<7>. 

zipfile — Work with ZIP archives

* Objetos ZipFile:: 
* Objetos de ruta:: 
* Objetos PyZipFile:: 
* Objetos ZipInfo:: 
* Interfaz de línea de comandos:: 
* Problemas de descompresión:: 

Interfaz de línea de comandos

* Opciones de línea de comando:: 

Problemas de descompresión

* Del archivo mismo:: 
* Limitaciones del sistema de archivos:: 
* Limitaciones de recursos:: 
* Interrupción:: 
* Comportamientos predeterminados de extracción:: 

tarfile — Read and write tar archive files

* Objetos TarFile:: 
* Objetos TarInfo:: 
* Extraction filters:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<2>. 
* Ejemplos: Ejemplos<8>. 
* Formatos tar con soporte:: 
* Problemas unicode:: 

Extraction filters

* Default named filters:: 
* Filter errors:: 
* Hints for further verification:: 
* Supporting older Python versions:: 
* Stateful extraction filter example:: 

Interfaz de línea de comandos

* Opciones de línea de comandos: Opciones de línea de comandos<2>. 

Formatos de archivo

* csv — CSV File Reading and Writing:: 
* configparser — Configuration file parser:: 
* tomllib — Parse TOML files:: 
* netrc — netrc file processing:: 
* plistlib — Generate and parse Apple .plist files: plistlib — Generate and parse Apple plist files. 

csv — CSV File Reading and Writing

* Contenidos del módulo: Contenidos del módulo<2>. 
* Dialectos y parámetros de formato:: 
* Objetos Reader:: 
* Objetos Writer:: 
* Ejemplos: Ejemplos<9>. 

configparser — Configuration file parser

* Inicio Rápido:: 
* Tipos de Datos Soportados:: 
* Valores de contingencia:: 
* Estructura soportada para el archivo ini:: 
* Unnamed Sections:: 
* Interpolación de valores:: 
* Acceso por protocolo de mapeo:: 
* Personalizando el comportamiento del parser:: 
* Ejemplos de la API heredada:: 
* Objetos ConfigParser:: 
* Objetos RawConfigParser:: 
* Excepciones: Excepciones<7>. 

tomllib — Parse TOML files

* Ejemplos: Ejemplos<10>. 
* Tabla de conversión:: 

netrc — netrc file processing

* Objetos netrc:: 

plistlib — Generate and parse Apple .plist files

* Ejemplos: Ejemplos<11>. 

Servicios criptográficos

* hashlib — Secure hashes and message digests:: 
* hmac — Keyed-Hashing for Message Authentication:: 
* secrets — Generate secure random numbers for managing secrets:: 

hashlib — Secure hashes and message digests

* Algoritmos de hash:: 
* Usage:: 
* Constructors:: 
* Attributes:: 
* Hash Objects:: 
* Resúmenes SHAKE de largo variable:: 
* Cifrado de archivos:: 
* Derivación de clave:: 
* BLAKE2:: 

BLAKE2

* Creando objetos hash:: 
* Constantes: Constantes<5>. 
* Ejemplos: Ejemplos<12>. 
* Créditos:: 

Ejemplos

* Cifrado simple:: 
* Usar diferentes tamaños de resumen:: 
* Cifrado de clave:: 
* Cifrado aleatorio:: 
* Personalización: Personalización<2>. 
* Modo de árbol:: 

secrets — Generate secure random numbers for managing secrets

* Números aleatorios:: 
* Generando tokens:: 
* Otras funciones:: 
* Recetas y mejores prácticas:: 

Generando tokens

* ¿Cuántos bytes deben tener los tokens?:: 

Servicios genéricos del sistema operativo

* os — Miscellaneous operating system interfaces:: 
* io — Core tools for working with streams:: 
* time — Time access and conversions:: 
* argparse — Parser for command-line options@comma{} arguments and subcommands: argparse — Parser for command-line options arguments and subcommands. 
* logging — Logging facility for Python:: 
* logging.config — Logging configuration: logging config — Logging configuration. 
* logging.handlers — Logging handlers: logging handlers — Logging handlers. 
* getpass — Portable password input:: 
* curses — Terminal handling for character-cell displays:: 
* curses.textpad— Widget de entrada de texto para programas de curses: curses textpad— Widget de entrada de texto para programas de curses. 
* curses.ascii — Utilities for ASCII characters: curses ascii — Utilities for ASCII characters. 
* curses.panel — A panel stack extension for curses: curses panel — A panel stack extension for curses. 
* platform — Access to underlying platform’s identifying data:: 
* errno — Standard errno system symbols:: 
* ctypes — A foreign function library for Python:: 

os — Miscellaneous operating system interfaces

* Nombres de archivos@comma{} argumentos de la línea de comandos y variables de entorno: Nombres de archivos argumentos de la línea de comandos y variables de entorno. 
* Modo Python UTF-8:: 
* Parámetros de proceso:: 
* Creación de objetos de tipo archivo:: 
* Operaciones de descriptores de archivos:: 
* Archivos y directorios:: 
* Gestión de proceso:: 
* Interfaz al planificador:: 
* Información miscelánea del sistema:: 
* Números al azar:: 

Operaciones de descriptores de archivos

* Consultando las dimensiones de una terminal:: 
* Herencia de los descriptores de archivos:: 

Archivos y directorios

* Timer File Descriptors:: 
* Atributos extendidos de Linux:: 

io — Core tools for working with streams

* Resumen: Resumen<3>. 
* Codificación de texto:: 
* Interfaz de módulo de alto nivel:: 
* Jerarquía de clases:: 
* Rendimiento: Rendimiento<2>. 

Resumen

* E/S Texto:: 
* E/S Binaria:: 
* E/S sin formato:: 

Codificación de texto

* EncodingWarning opcional:: 

Jerarquía de clases

* Clases base E/S:: 
* Archivo sin formato E/S:: 
* Streams almacenados (búfer): Streams almacenados búfer. 
* E/S Texto: E/S Texto<2>. 

Rendimiento

* E/S Binaria: E/S Binaria<2>. 
* E/S Texto: E/S Texto<3>. 
* Multihilo:: 
* Reentrada:: 

time — Time access and conversions

* Las Funciones:: 
* Constantes de ID de reloj:: 
* Constantes de zona horaria:: 

argparse — Parser for command-line options, arguments and subcommands

* Objetos ArgumentParser:: 
* El método add_argument(): El método add_argument. 
* El método parse_args(): El método parse_args. 
* Otras utilidades:: 
* Excepciones: Excepciones<8>. 

Objetos ArgumentParser

* prog:: 
* uso:: 
* description:: 
* epilog:: 
* parents:: 
* formatter_class:: 
* prefix_chars:: 
* fromfile_prefix_chars:: 
* argument_default:: 
* allow_abbrev:: 
* conflict_handler:: 
* add_help:: 
* exit_on_error:: 
* suggest_on_error:: 

El método add_argument()

* name or flags:: 
* action:: 
* nargs:: 
* const:: 
* default:: 
* type:: 
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Las clases Action:: 

El método parse_args()

* Sintaxis del valor de la opción:: 
* Argumentos no válidos:: 
* Argumentos conteniendo -:: 
* Abreviaturas de los argumentos (coincidencia de prefijos): Abreviaturas de los argumentos coincidencia de prefijos. 
* Más allá de sys.argv: Más allá de sys argv. 
* El objeto Namespace:: 

Otras utilidades

* Sub-comandos:: 
* Objetos FileType:: 
* Grupos de argumentos:: 
* Exclusión mutua:: 
* Valores por defecto del analizador:: 
* Mostrando la ayuda:: 
* Análisis parcial:: 
* Personalizando el análisis de archivos:: 
* Métodos de salida:: 
* Análisis entremezclado:: 

Excepciones

* Tutorial de argparse:: 
* Upgrading optparse code:: 

Tutorial de argparse

* Conceptos:: 
* Las bases:: 
* Introducción a los argumentos posicionales:: 
* Introducción a los argumentos opcionales:: 
* Combinar argumentos opcionales y posicionales:: 
* Un poco mas avanzado:: 
* Cómo traducir la salida de argparse:: 
* Custom type converters:: 
* Conclusión:: 

Introducción a los argumentos opcionales

* Opciones cortas:: 

Un poco mas avanzado

* Especificando argumentos ambiguos:: 
* Opciones conflictivas:: 

logging — Logging facility for Python

* Objetos logger:: 
* Niveles de logging:: 
* Gestor de objetos:: 
* Objetos formateadores:: 
* Filtro de Objetos:: 
* Objetos LogRecord:: 
* Atributos LogRecord:: 
* Objetos LoggerAdapter:: 
* Seguridad del hilo:: 
* Funciones a nivel de módulo:: 
* Atributos a nivel de módulo:: 
* Integración con el módulo de advertencias:: 

logging.config — Logging configuration

* Funciones de configuración:: 
* Consideraciones de seguridad:: 
* Esquema del diccionario de configuración:: 
* Formato de archivo de configuración:: 

Esquema del diccionario de configuración

* Detalles del esquema del diccionario:: 
* Configuración incremental:: 
* Conexiones de objeto:: 
* Objetos definidos por el usuario:: 
* Handler configuration order:: 
* Acceso a objetos externos:: 
* Acceso a objetos internos:: 
* Resolución de importación e importadores personalizados:: 
* Configuring QueueHandler and QueueListener:: 

logging.handlers — Logging handlers

* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* Gestor SysLog (SysLogHandler): Gestor SysLog SysLogHandler. 
* Gestor de eventos NTELog (NTEventLogHandler): Gestor de eventos NTELog NTEventLogHandler. 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

curses — Terminal handling for character-cell displays

* Funciones: Funciones<4>. 
* Objetos de ventana:: 
* Constantes: Constantes<6>. 

curses.textpad— Widget de entrada de texto para programas de curses

* Objeto de caja de texto:: 

curses.panel — A panel stack extension for curses

* Funciones: Funciones<5>. 
* Objetos de panel:: 

platform —  Access to underlying platform’s identifying data

* Plataforma cruzada:: 
* Plataforma Java:: 
* Plataforma windows:: 
* Plataforma macOS:: 
* iOS Platform:: 
* Plataformas Unix:: 
* Plataformas Linux:: 
* Android Platform:: 
* Miscellaneous:: 

ctypes — A foreign function library for Python

* tutorial de ctypes:: 
* referencia ctypes:: 

tutorial de ctypes

* Carga de bibliotecas de enlaces dinámicos:: 
* Acceder a las funciones de los dll cargados:: 
* Funciones de llamada:: 
* Tipos de datos fundamentales:: 
* Funciones de llamada@comma{} continuación: Funciones de llamada continuación. 
* Calling variadic functions:: 
* Funciones de llamada con sus propios tipos de datos personalizados:: 
* Especificar los tipos de argumentos requeridos (prototipos de funciones): Especificar los tipos de argumentos requeridos prototipos de funciones. 
* Tipos de retorno:: 
* Pasar los punteros (o; pasar los parámetros por referencia): Pasar los punteros o pasar los parámetros por referencia. 
* Estructuras y uniones:: 
* Structure/union layout@comma{} alignment and byte order: Structure/union layout alignment and byte order. 
* Campos de bits en estructuras y uniones:: 
* Arreglos:: 
* Punteros:: 
* Conversiones de tipos:: 
* Tipos incompletos:: 
* Funciones de retrollamadas (callback): Funciones de retrollamadas callback. 
* Acceder a los valores exportados de los dlls:: 
* Sorpresas:: 
* Tipos de datos de tamaño variable:: 

referencia ctypes

* Encontrar bibliotecas compartidas:: 
* Cargando bibliotecas compartidas:: 
* Funciones foráneas:: 
* Prototipos de funciones:: 
* Funciones de utilidad:: 
* Tipos de datos: Tipos de datos<3>. 
* Tipos de datos fundamentales: Tipos de datos fundamentales<2>. 
* Tipos de datos estructurados:: 
* Arreglos y punteros:: 

Ejecución concurrente

* threading — Thread-based parallelism:: 
* multiprocessing — Process-based parallelism:: 
* multiprocessing.shared_memory — Shared memory for direct access across processes: multiprocessing shared_memory — Shared memory for direct access across processes. 
* El paquete concurrent:: 
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks. 
* subprocess — Subprocess management:: 
* sched — Event scheduler:: 
* queue — A synchronized queue class:: 
* contextvars — Context Variables:: 
* _thread — Low-level threading API:: 

threading — Thread-based parallelism

* Datos locales del hilo:: 
* Objetos tipo hilo:: 
* Objetos tipo lock:: 
* Objetos Rlock:: 
* Objetos condicionales:: 
* Objetos semáforo:: 
* Objetos de eventos:: 
* Objetos temporizadores:: 
* Objetos de barrera:: 
* Uso de locks@comma{} condiciones y semáforos en la declaración with: Uso de locks condiciones y semáforos en la declaración with. 

Objetos semáforo

* Ejemplo de Semaphore:: 

multiprocessing — Process-based parallelism

* Introducción: Introducción<7>. 
* Referencia: Referencia<2>. 
* Pautas de programación:: 
* Ejemplos: Ejemplos<13>. 

Introducción

* La clase Process:: 
* Contextos y métodos de inicio:: 
* Intercambiando objetos entre procesos:: 
* Sincronización entre procesos:: 
* Compartiendo estado entre procesos:: 
* Usando una piscina de trabajadores (pool of workers): Usando una piscina de trabajadores pool of workers. 

Referencia

* Process y excepciones:: 
* Tuberías (Pipes) y Colas (Queues): Tuberías Pipes y Colas Queues. 
* Miscelánea: Miscelánea<2>. 
* Objetos de conexión Connection Objects:: 
* Primitivas de sincronización (Synchronization primitives): Primitivas de sincronización Synchronization primitives. 
* Objetos compartidos ctypes:: 
* Administradores (Managers): Administradores Managers. 
* Objetos Proxy (Proxy Objects): Objetos Proxy Proxy Objects. 
* Piscinas de procesos (Process Pools): Piscinas de procesos Process Pools. 
* Oyentes y clientes (Listeners and Clients): Oyentes y clientes Listeners and Clients. 
* Llaves de autentificación:: 
* Logging:: 
* El módulo multiprocessing.dummy: El módulo multiprocessing dummy. 

Objetos compartidos ctypes

* El módulo multiprocessing.sharedctypes: El módulo multiprocessing sharedctypes. 

Administradores (Managers)

* Administradores customizables (Customized managers): Administradores customizables Customized managers. 
* Utilizando un administrador remoto:: 

Objetos Proxy (Proxy Objects)

* Limpieza (Cleanup): Limpieza Cleanup. 

Oyentes y clientes (Listeners and Clients)

* Formatos de dirección (Address formats): Formatos de dirección Address formats. 

Pautas de programación

* Todos los métodos de inicio:: 
* Los métodos de inicio spawn y forkserver:: 

concurrent.futures — Launching parallel tasks

* Objetos ejecutores:: 
* ThreadPoolExecutor:: 
* InterpreterPoolExecutor:: 
* ProcessPoolExecutor:: 
* Objetos futuro:: 
* Funciones del módulo: Funciones del módulo<2>. 
* Clases de Excepciones:: 

ThreadPoolExecutor

* Ejemplo de ThreadPoolExecutor:: 

ProcessPoolExecutor

* Ejemplo de ProcessPoolExecutor:: 

subprocess — Subprocess management

* Uso del módulo subprocess:: 
* Consideraciones sobre seguridad:: 
* Objetos Popen:: 
* Elementos auxiliares de Popen en Windows:: 
* Antigua API de alto nivel:: 
* Cómo reemplazar anteriores funciones con el módulo subprocess:: 
* Funciones de llamada a la shell de retrocompatibilidad:: 
* Notas: Notas<2>. 

Uso del módulo subprocess

* Argumentos frecuentemente empleados:: 
* El constructor de Popen:: 
* Excepciones: Excepciones<9>. 

Elementos auxiliares de Popen en Windows

* Constantes de Windows:: 

Cómo reemplazar anteriores funciones con el módulo subprocess

* Cómo reemplazar la sustitución de órdenes de /bin/sh:: 
* Cómo remplazar los flujos de la shell:: 
* Cómo reemplazar os.system(): Cómo reemplazar os system. 
* Cómo reemplazar la familia os.spawn: Cómo reemplazar la familia os spawn. 
* Replacing os.popen(): Replacing os popen. 

Notas

* Cómo convertir una secuencia de argumentos a una cadena en Windows:: 
* Disable use of posix_spawn(): Disable use of posix_spawn. 

sched — Event scheduler

* Objetos de Scheduler:: 

queue — A synchronized queue class

* Objetos de la cola:: 
* Objetos de cola simple:: 

Objetos de la cola

* Terminating queues:: 

contextvars — Context Variables

* variables de contexto:: 
* Gestión de contexto manual:: 
* Soporte asyncio:: 

Comunicación en redes y entre procesos

* asyncio — Asynchronous I/O:: 
* socket — Low-level networking interface:: 
* ssl — TLS/SSL wrapper for socket objects:: 
* select — Waiting for I/O completion:: 
* selectors — High-level I/O multiplexing:: 
* signal — Set handlers for asynchronous events:: 
* mmap — Memory-mapped file support:: 

asyncio — Asynchronous I/O

* Runners:: 
* Corrutinas y tareas:: 
* Streams:: 
* Primitivas de sincronización:: 
* Sub-procesos:: 
* Colas:: 
* Excepciones: Excepciones<11>. 
* Bucle de eventos:: 
* Futures:: 
* Transportes y protocolos:: 
* Políticas:: 
* Soporte de plataforma:: 
* Extensión:: 
* Índice de API de alto nivel:: 
* Índice de API de bajo nivel:: 
* Desarrollando con asyncio:: 

Runners

* Ejecutando un programa asyncio:: 
* Gestor de contexto del runner:: 
* Manejando interrupciones de teclado:: 

Corrutinas y tareas

* Corrutinas: Corrutinas<3>. 
* Esperables:: 
* Creando Tareas:: 
* Cancelación de tareas:: 
* Grupos de tareas:: 
* Durmiendo:: 
* Ejecutando tareas concurrentemente:: 
* Fábrica de tareas ansiosas:: 
* Protección contra cancelación:: 
* Tiempo agotado:: 
* Esperando primitivas:: 
* Ejecutando en hilos:: 
* Planificación desde otros hilos:: 
* Introspección:: 
* Objeto Task:: 

Grupos de tareas

* Terminating a Task Group:: 

Streams

* StreamReader:: 
* StreamWriter:: 
* Ejemplos: Ejemplos<14>. 

Ejemplos

* Cliente eco TCP usando streams:: 
* Servidor eco TCP usando streams:: 
* Obtener encabezados HTTP:: 
* Registrar un socket abierto para esperar datos usando streams:: 

Primitivas de sincronización

* Lock:: 
* Event:: 
* Condition:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrera:: 

Sub-procesos

* Creando sub-procesos:: 
* Constantes: Constantes<7>. 
* Interactuando con Subprocesos:: 

Interactuando con Subprocesos

* Subprocesos y Hilos:: 
* Ejemplos: Ejemplos<15>. 

Colas

* Cola:: 
* Cola de prioridad:: 
* Cola UEPA (o LIFO en inglés): Cola UEPA o LIFO en inglés. 
* Excepciones: Excepciones<10>. 
* Ejemplos: Ejemplos<16>. 

Bucle de eventos

* Métodos del bucle de eventos:: 
* Gestores de llamadas:: 
* Objetos Servidor:: 
* Implementaciones del bucle de eventos:: 
* Examples: Examples<2>. 

Métodos del bucle de eventos

* Iniciar y para el bucle:: 
* Programación de llamadas de retorno:: 
* Planificando llamadas retardadas:: 
* Creando futuros y tareas:: 
* Abriendo conexiones de red:: 
* Creando servidores de red:: 
* Transfiriendo archivos:: 
* Actualización de TLS:: 
* Viendo descriptores de archivos:: 
* Trabajar con objetos sockets directamente:: 
* DNS:: 
* Trabajando con tuberías:: 
* Señales Unix:: 
* Ejecutando código en un hilos o grupos de procesos:: 
* API para manejo de errores:: 
* Habilitando el modo depuración:: 
* Ejecutando subprocesos:: 

Examples

* Hola Mundo con call_soon(): Hola Mundo con call_soon. 
* Muestra la fecha actual con call_later(): Muestra la fecha actual con call_later. 
* Mirar un descriptor de archivo para leer eventos:: 
* Establece los gestores de señal para SIGINT y SIGTERM:: 

Futures

* Funciones Future:: 
* Objeto Future:: 

Transportes y protocolos

* Transportes:: 
* Protocolos:: 
* Ejemplos: Ejemplos<17>. 

Transportes

* Jerarquía de transportes:: 
* Transporte base:: 
* Transportes de solo lectura:: 
* Transportes de solo escritura:: 
* Transportes de datagramas:: 
* Transportes de subprocesos:: 

Protocolos

* Protocolos base:: 
* Protocolo base:: 
* Protocolos de streaming:: 
* Protocolos de streaming mediante búfer:: 
* Protocolos de datagramas:: 
* Protocolos de subprocesos:: 

Ejemplos

* Servidor de eco TCP:: 
* Cliente de eco TCP:: 
* Servidor de eco UDP:: 
* Cliente de eco UDP:: 
* Conectando sockets existentes:: 
* loop.subprocess_exec() y SubprocessProtocol: loop subprocess_exec y SubprocessProtocol. 

Políticas

* Obteniendo y configurando la política:: 
* Objetos de política:: 
* Personalizar Políticas:: 

Soporte de plataforma

* Todas las plataformas:: 
* Windows: Windows<72>. 
* macOS: macOS<45>. 

Windows

* Soporte de sub-procesos en Windows:: 

Extensión

* Escribir un bucle de eventos personalizado:: 
* Constructores privados Future y Task:: 
* Soporte de por vida de tareas:: 

Índice de API de alto nivel

* Tareas:: 
* Colas: Colas<2>. 
* Subprocesos:: 
* Flujos:: 
* Sincronización:: 
* Excepciones: Excepciones<12>. 

Índice de API de bajo nivel

* Obtención del bucle de eventos:: 
* Métodos del bucle de eventos: Métodos del bucle de eventos<2>. 
* Transportes: Transportes<2>. 
* Protocolos: Protocolos<2>. 
* Políticas de bucle de eventos:: 

Desarrollando con asyncio

* Modo depuración:: 
* Concurrencia y multihilo:: 
* Ejecutando código bloqueante:: 
* Logueando:: 
* Detectar corrutinas no esperadas:: 
* Detectar excepciones nunca recuperadas:: 

socket — Low-level networking interface

* Familias Socket:: 
* Contenido del módulo:: 
* Objetos Socket:: 
* Notas sobre los tiempos de espera del socket:: 
* Ejemplo: Ejemplo<7>. 

Contenido del módulo

* Excepciones: Excepciones<13>. 
* Constantes: Constantes<8>. 
* Funciones: Funciones<6>. 

Funciones

* Creación de sockets:: 
* Otras funciones: Otras funciones<2>. 

Notas sobre los tiempos de espera del socket

* Tiempos de espera y el método connect:: 
* Tiempos de espera y el método accept:: 

ssl — TLS/SSL wrapper for socket objects

* Funciones@comma{} constantes y excepciones: Funciones constantes y excepciones. 
* Sockets SSL:: 
* Contextos SSL:: 
* Certificados:: 
* Ejemplos: Ejemplos<18>. 
* Notas sobre los sockets no bloqueantes:: 
* Soporte de memoria BIO: Soporte de memoria BIO<2>. 
* Sesión SSL:: 
* Consideraciones de seguridad: Consideraciones de seguridad<2>. 
* TLS 1.3: TLS 1 3. 

Funciones, constantes y excepciones

* Creación de sockets: Creación de sockets<2>. 
* Creación de contexto:: 
* Excepciones: Excepciones<14>. 
* Generación aleatoria:: 
* Gestión de certificados:: 
* Constantes: Constantes<9>. 

Certificados

* Cadenas de certificados:: 
* Certificados CA:: 
* Clave y certificado combinados:: 
* Certificados auto-firmados:: 

Ejemplos

* Pruebas de compatibilidad con SSL:: 
* Operación del lado del cliente:: 
* Operación del lado del servidor:: 

Consideraciones de seguridad

* Los mejores valores por defecto:: 
* Ajustes manuales:: 
* Multiprocesamiento:: 

Ajustes manuales

* Verificación de certificados:: 
* Versiones del protocolo:: 
* Selección de cifrado:: 

select — Waiting for I/O completion

* Objetos de sondeo /dev/poll:: 
* Objetos de sondeo de Edge y Level Trigger (epoll): Objetos de sondeo de Edge y Level Trigger epoll. 
* Sondeo de objetos:: 
* Objetos Kqueue:: 
* Objetos Kevent:: 

selectors — High-level I/O multiplexing

* Introducción: Introducción<8>. 
* Clases: Clases<4>. 
* Ejemplos: Ejemplos<19>. 

signal — Set handlers for asynchronous events

* Reglas generales:: 
* Contenidos del módulo: Contenidos del módulo<3>. 
* Ejemplos: Ejemplos<20>. 
* Nota sobre SIGPIPE:: 
* Nota sobre Manejadores de Señales y Excepciones:: 

Reglas generales

* Ejecución de los gestores de señales de Python:: 
* Señales e hilos:: 

mmap — Memory-mapped file support

* Constantes MADV_*:: 
* Constantes MAP_*:: 

Manejo de datos de internet

* email — An email and MIME handling package:: 
* json — JSON encoder and decoder:: 
* mailbox — Manipulate mailboxes in various formats:: 
* mimetypes — Map filenames to MIME types:: 
* base64 — Base16@comma{} Base32@comma{} Base64@comma{} Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings. 
* binascii — Convert between binary and ASCII:: 
* quopri — Encode and decode MIME quoted-printable data:: 

email — An email and MIME handling package

* email.message; Representing an email message: email message Representing an email message. 
* email.parser; Parsing email messages: email parser Parsing email messages. 
* email.generator; Generating MIME documents: email generator Generating MIME documents. 
* email.policy; Policy Objects: email policy Policy Objects. 
* email.errors; Exception and Defect classes: email errors Exception and Defect classes. 
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects. 
* email.contentmanager; Managing MIME Content: email contentmanager Managing MIME Content. 
* email; Ejemplos: email Ejemplos. 
* email.message.Message; Representar un mensaje de correo electrónico usando la API compat32: email message Message Representar un mensaje de correo electrónico usando la API compat32. 
* email.mime; Creating email and MIME objects from scratch: email mime Creating email and MIME objects from scratch. 
* email.header; Internationalized headers: email header Internationalized headers. 
* email.charset; Representing character sets: email charset Representing character sets. 
* email.encoders; Encoders: email encoders Encoders. 
* email.utils; Miscellaneous utilities: email utils Miscellaneous utilities. 
* email.iterators; Iterators: email iterators Iterators. 

email.parser: Parsing email messages

* API FeedParser:: 
* API Parser:: 
* Notas adicionales:: 

email.contentmanager: Managing MIME Content

* Instancias gestoras de contenido:: 

json — JSON encoder and decoder

* Uso básico: Uso básico<2>. 
* Codificadores y Decodificadores:: 
* Excepciones: Excepciones<15>. 
* Cumplimiento e interoperabilidad estándar:: 
* Command-line interface: Command-line interface<2>. 

Cumplimiento e interoperabilidad estándar

* Codificaciones de caracteres:: 
* Valores de número infinito y NaN:: 
* Nombres repetidos dentro de un objeto:: 
* Valores de nivel superior No-Objeto @comma{} No-Arreglo: Valores de nivel superior No-Objeto No-Arreglo. 
* Limitaciones de la implementación:: 

Command-line interface

* Command-line options:: 

mailbox — Manipulate mailboxes in various formats

* Mailbox objects:: 
* Message objects:: 
* Excepciones: Excepciones<16>. 
* Ejemplos: Ejemplos<21>. 

Mailbox objects

* Maildir objects:: 
* mbox objects:: 
* MH objects:: 
* Babyl objects:: 
* MMDF objects:: 

Message objects

* MaildirMessage objects:: 
* mboxMessage objects:: 
* MHMessage objects:: 
* BabylMessage objects:: 
* MMDFMessage objects:: 

mimetypes — Map filenames to MIME types

* Objetos MimeTypes:: 

base64 — Base16, Base32, Base64, Base85 Data Encodings

* Consideraciones de Seguridad:: 

Herramientas Para Procesar Formatos de Marcado Estructurado

* html — HyperText Markup Language support:: 
* html.parser — Simple HTML and XHTML parser: html parser — Simple HTML and XHTML parser. 
* html.entities — Definitions of HTML general entities: html entities — Definitions of HTML general entities. 
* Módulos de procesamiento XML:: 
* xml.etree.ElementTree — The ElementTree XML API: xml etree ElementTree — The ElementTree XML API. 
* xml.dom — The Document Object Model API: xml dom — The Document Object Model API. 
* xml.dom.minidom — Minimal DOM implementation: xml dom minidom — Minimal DOM implementation. 
* xml.dom.pulldom — Support for building partial DOM trees: xml dom pulldom — Support for building partial DOM trees. 
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers. 
* xml.sax.handler — Base classes for SAX handlers: xml sax handler — Base classes for SAX handlers. 
* xml.sax.saxutils — SAX Utilities: xml sax saxutils — SAX Utilities. 
* xml.sax.xmlreader — Interface for XML parsers: xml sax xmlreader — Interface for XML parsers. 
* xml.parsers.expat — Fast XML parsing using Expat: xml parsers expat — Fast XML parsing using Expat. 

html.parser — Simple HTML and XHTML parser

* Aplicación ejemplo de un analizador sintáctico (parser) de HTML: Aplicación ejemplo de un analizador sintáctico parser de HTML. 
* Métodos HTMLParser:: 
* Ejemplos: Ejemplos<22>. 

Módulos de procesamiento XML

* Vulnerabilidades XML:: 
* El paquete defusedxml:: 

xml.etree.ElementTree — The ElementTree XML API

* Tutorial: Tutorial<2>. 
* Soporte de XPath:: 
* Referencia: Referencia<3>. 
* Soporte de XInclude:: 
* Referencia: Referencia<4>. 

Tutorial

* Árbol y elementos XML:: 
* Procesando XML:: 
* API de consulta para un procesamiento no bloqueante:: 
* Encontrando elementos interesantes:: 
* Modificando un archivo XML:: 
* Construyendo documentos XML:: 
* Procesando XML con espacio de nombres:: 

Soporte de XPath

* Ejemplo: Ejemplo<8>. 
* Sintaxis XPath soportada:: 

Referencia

* Funciones: Funciones<7>. 

Soporte de XInclude

* Ejemplo: Ejemplo<9>. 

Referencia

* Funciones: Funciones<8>. 
* Objetos Element:: 
* Objetos ElementTree:: 
* Objetos QName:: 
* Objetos TreeBuilder:: 
* Objetos XMLParser:: 
* Objetos XMLPullParser:: 
* Excepciones: Excepciones<17>. 

xml.dom — The Document Object Model API

* Contenido del módulo: Contenido del módulo<2>. 
* Objetos en el DOM:: 
* Conformidad:: 

Objetos en el DOM

* Objetos DOMImplementation:: 
* Objetos nodo:: 
* Objetos NodeList:: 
* Objetos DocumentType:: 
* Objetos documento:: 
* Objetos elemento:: 
* Objetos atributo:: 
* Objetos NamedNodeMap:: 
* Objetos comentario:: 
* Objetos Texto y CDATASection:: 
* Objetos ProcessingInstruction:: 
* Excepciones: Excepciones<18>. 

Conformidad

* Mapeo de tipos:: 
* Métodos de acceso (accessor): Métodos de acceso accessor. 

xml.dom.minidom — Minimal DOM implementation

* Objetos del DOM:: 
* Ejemplo de DOM:: 
* minidom y el estándar DOM:: 

xml.dom.pulldom — Support for building partial DOM trees

* Objetos DOMEventStream:: 

xml.sax — Support for SAX2 parsers

* Objetos SAXException:: 

xml.sax.handler — Base classes for SAX handlers

* Objetos ContentHandler:: 
* Objetos DTDHandler:: 
* Objetos EntityResolver:: 
* Objetos ErrorHandler:: 
* Objetos DTDHandler: Objetos DTDHandler<2>. 

xml.sax.xmlreader — Interface for XML parsers

* Objetos XMLReader:: 
* Objetos IncrementalParser:: 
* Objetos localizadores:: 
* Objetos InputSource:: 
* La Interfaz Attributes:: 
* La Interfaz AttributesNS:: 

xml.parsers.expat — Fast XML parsing using Expat

* Objetos XMLParser: Objetos XMLParser<2>. 
* Excepciones de ExpatError:: 
* Ejemplo: Ejemplo<10>. 
* Descripciones del modelo de contenido:: 
* Constantes de error de expansión:: 

Protocolos y soporte de Internet

* webbrowser — Convenient web-browser controller:: 
* wsgiref — WSGI Utilities and Reference Implementation:: 
* urllib — URL handling modules:: 
* urllib.request — Extensible library for opening URLs: urllib request — Extensible library for opening URLs. 
* urllib.response — Clases de respuesta usadas por urllib: urllib response — Clases de respuesta usadas por urllib. 
* urllib.parse — Parse URLs into components: urllib parse — Parse URLs into components. 
* urllib.error — Exception classes raised by urllib.request: urllib error — Exception classes raised by urllib request. 
* urllib.robotparser — Parser for robots.txt: urllib robotparser — Parser for robots txt. 
* http — HTTP modules:: 
* http.client — HTTP protocol client: http client — HTTP protocol client. 
* ftplib — FTP protocol client:: 
* poplib — POP3 protocol client:: 
* imaplib — IMAP4 protocol client:: 
* smtplib — SMTP protocol client:: 
* uuid — UUID objects according to RFC 9562:: 
* socketserver — A framework for network servers:: 
* http.server — HTTP servers: http server — HTTP servers. 
* http.cookies — HTTP state management: http cookies — HTTP state management. 
* http.cookiejar — Cookie handling for HTTP clients: http cookiejar — Cookie handling for HTTP clients. 
* xmlrpc — Módulos XMLRPC para cliente y servidor:: 
* xmlrpc.client — XML-RPC client access: xmlrpc client — XML-RPC client access. 
* xmlrpc.server — Basic XML-RPC servers: xmlrpc server — Basic XML-RPC servers. 
* ipaddress — IPv4/IPv6 manipulation library:: 

webbrowser — Convenient web-browser controller

* Objetos controladores de navegador:: 

wsgiref — WSGI Utilities and Reference Implementation

* wsgiref.util – Utilidades de entorno WSGI: wsgiref util – Utilidades de entorno WSGI. 
* wsgiref.headers – Herramientas para cabeceras de respuesta WSGI: wsgiref headers – Herramientas para cabeceras de respuesta WSGI. 
* wsgiref.simple_server– Un servidor HTTP WSGI simple: wsgiref simple_server– Un servidor HTTP WSGI simple. 
* wsgiref.validate — Verificador de compatibilidad WSGI: wsgiref validate — Verificador de compatibilidad WSGI. 
* wsgiref.handlers – Clases base servidor/gateway: wsgiref handlers – Clases base servidor/gateway. 
* wsgiref.types — Tipos de WSGI para validadores estáticos de tipos: wsgiref types — Tipos de WSGI para validadores estáticos de tipos. 
* Ejemplos: Ejemplos<23>. 

urllib.request — Extensible library for opening URLs

* Objetos Request:: 
* Objetos OpenerDirector:: 
* Objetos BaseHandler:: 
* Objetos HTTPRedirectHandler:: 
* Objetos HTTPCookieProcessor:: 
* Objetos ProxyHandler:: 
* Objetos HTTPPasswordMgr:: 
* Objetos HTTPPasswordMgrWithPriorAuth:: 
* Objetos AbstractBasicAuthHandler:: 
* Objetos HTTPBasicAuthHandler:: 
* Objetos ProxyBasicAuthHandler:: 
* Objetos AbstractDigestAuthHandler:: 
* Objetos HTTPDigestAuthHandler:: 
* Objetos ProxyDigestAuthHandler:: 
* Objetos HTTPHandler:: 
* Objetos HTTPSHandler:: 
* Objetos FileHandler:: 
* Objetos DataHandler:: 
* Objetos FTPHandler:: 
* Objetos CacheFTPHandler:: 
* Objetos UnknownHandler:: 
* Objetos HTTPErrorProcessor:: 
* Ejemplos: Ejemplos<24>. 
* Interfaz heredada:: 
* Restricciones urllib.request: Restricciones urllib request. 

urllib.parse — Parse URLs into components

* Análisis de URL:: 
* Análisis de seguridad de URL:: 
* Análisis de bytes codificados ASCII:: 
* Resultados del análisis estructurado:: 
* Cita de URL:: 

http — HTTP modules

* Códigos de estado HTTP:: 
* Categoría de estado HTTP:: 
* Métodos HTTP:: 

http.client — HTTP protocol client

* Objetos de HTTPConnection:: 
* Objetos de HTTPResponse:: 
* Ejemplos: Ejemplos<25>. 
* Objetos de HTTPMessage:: 

ftplib — FTP protocol client

* Reference:: 

Reference

* FTP objects:: 
* FTP_TLS objects:: 
* Module variables:: 

poplib — POP3 protocol client

* Objetos POP3:: 
* Ejemplo POP3:: 

imaplib — IMAP4 protocol client

* Objetos de IMAP4:: 
* Ejemplo IMAP4:: 

smtplib — SMTP protocol client

* Objetos SMTP:: 
* Ejemplo SMTP:: 

uuid — UUID objects according to RFC 9562

* Uso de la línea de comandos: Uso de la línea de comandos<2>. 
* Ejemplo: Ejemplo<11>. 
* Ejemplo de línea de comandos:: 

socketserver — A framework for network servers

* Notas de creación del servidor:: 
* Objetos de servidor:: 
* Solicitar objetos de controlador:: 
* Ejemplos: Ejemplos<26>. 

Ejemplos

* socketserver.TCPServer Ejemplo: socketserver TCPServer Ejemplo. 
* socketserver.UDPServer Ejemplo: socketserver UDPServer Ejemplo. 
* Mixins asincrónicos:: 

http.server — HTTP servers

* Consideraciones de seguridad: Consideraciones de seguridad<3>. 

http.cookies — HTTP state management

* Objetos de cookie:: 
* Objetos Morsel:: 
* Ejemplo: Ejemplo<12>. 

http.cookiejar — Cookie handling for HTTP clients

* Objetos CookieJar y FileCookieJar:: 
* Subclases FileCookieJar y co-operación con navegadores web:: 
* Objetos CookiePolicy:: 
* Objetos DefaultCookiePolicy:: 
* Objetos Cookie:: 
* Ejemplos: Ejemplos<27>. 

xmlrpc.client — XML-RPC client access

* Objetos ServerProxy:: 
* Objetos DateTime:: 
* Objetos binarios:: 
* Objetos Faults:: 
* Objetos ProtocolError:: 
* Objetos MultiCall:: 
* Funciones de Conveniencia:: 
* Ejemplo de uso de cliente:: 
* Ejemplo de uso de cliente y servidor:: 

xmlrpc.server — Basic XML-RPC servers

* Objetos SimpleXMLRPCServer:: 
* CGIXMLRPCRequestHandler:: 
* Documentando el servidor XMLRPC:: 
* Objetos DocXMLRPCServer:: 
* DocCGIXMLRPCRequestHandler:: 

Objetos SimpleXMLRPCServer

* Ejemplo de SimpleXMLRPCServer:: 

ipaddress — IPv4/IPv6 manipulation library

* Funciones de fábrica de conveniencia:: 
* Direcciones IP:: 
* Definiciones de red IP:: 
* Objetos de interfaz:: 
* Otras funciones de nivel de módulo:: 
* Excepciones personalizadas:: 

Direcciones IP

* Objetos de dirección:: 
* Conversión a cadenas y enteros:: 
* Operadores: Operadores<3>. 

Operadores

* Operadores de comparación:: 
* Operadores aritméticos:: 

Definiciones de red IP

* Prefijo@comma{} máscara de red y máscara de host: Prefijo máscara de red y máscara de host. 
* Objetos de red:: 
* Operadores: Operadores<4>. 

Operadores

* Operadores lógicos:: 
* Iteración:: 
* Redes como contenedores de direcciones:: 

Objetos de interfaz

* Operadores: Operadores<5>. 

Operadores

* Operadores lógicos: Operadores lógicos<2>. 

Servicios Multimedia

* wave — Read and write WAV files:: 
* colorsys — Conversions between color systems:: 

wave — Read and write WAV files

* Los objetos Wave_read:: 
* Los objetos Wave_write:: 

Internacionalización

* gettext — Multilingual internationalization services:: 
* locale — Internationalization services:: 

gettext — Multilingual internationalization services

* GNU API gettext:: 
* API basada en clases:: 
* Internacionalizando sus programas y módulos:: 
* Agradecimientos: Agradecimientos<9>. 

API basada en clases

* La clase NullTranslations:: 
* La clase GNUTranslations:: 
* Soporte de catálogo de mensajes de Solaris:: 
* El constructor del catálogo:: 

Internacionalizando sus programas y módulos

* Agregar configuración regional a su módulo:: 
* Agregar configuración regional a su aplicación:: 
* Cambiar idiomas sobre la marcha:: 
* Traducciones diferidas:: 

locale — Internationalization services

* Segundo plano@comma{} detalles@comma{} indicaciones@comma{} consejos y advertencias: Segundo plano detalles indicaciones consejos y advertencias. 
* Para escritores de extensión y programas que incrustan Python:: 
* Acceso a los catálogos de mensajes:: 

Frameworks de programa

* turtle — Gráficos con Turtle:: 
* cmd — Support for line-oriented command interpreters:: 
* shlex — Simple lexical analysis:: 

turtle — Gráficos con Turtle

* Introducción: Introducción<9>. 
* Get started:: 
* Tutorial: Tutorial<3>. 
* How to…:: 
* Turtle graphics reference:: 
* Métodos de RawTurtle/Turtle Y sus correspondientes funciones:: 
* Métodos de TurtleScreen/Screen y sus correspondientes funciones:: 
* Clases públicas:: 
* Explanation:: 
* Ayuda y configuración:: 
* turtledemo — Scripts de demostración:: 
* Cambios desde Python 2.6: Cambios desde Python 2 6. 
* Cambios desde Python 3.0: Cambios desde Python 3 0. 

Tutorial

* Starting a turtle environment:: 
* Basic drawing:: 
* Making algorithmic patterns:: 

Basic drawing

* Control del lápiz:: 
* The turtle’s position:: 

How to…

* Get started as quickly as possible:: 
* Use the turtle module namespace:: 
* Use turtle graphics in a script:: 
* Use object-oriented turtle graphics:: 

Turtle graphics reference

* Métodos Turtle:: 
* Métodos de TurtleScreen/Screen:: 

Métodos de RawTurtle/Turtle Y sus correspondientes funciones

* Movimiento de Turtle:: 
* Mostrar el estado de la tortuga:: 
* Configuración de las medidas:: 
* Control del lápiz: Control del lápiz<2>. 
* Estado de la Tortuga:: 
* Usando eventos:: 
* Métodos especiales de Turtle:: 
* Formas compuestas:: 

Control del lápiz

* Estado de dibujo:: 
* Control del color:: 
* Relleno:: 
* Más controles de dibujo:: 

Estado de la Tortuga

* Visibilidad:: 
* Apariencia:: 

Métodos de TurtleScreen/Screen y sus correspondientes funciones

* Control de ventana:: 
* Control de animación:: 
* Usando eventos de pantalla:: 
* Métodos de entrada:: 
* Configuración y métodos especiales:: 
* Métodos específicos de Screen@comma{} no heredados de TurtleScreen: Métodos específicos de Screen no heredados de TurtleScreen. 

Ayuda y configuración

* Cómo usar la ayuda:: 
* Traducción de cadenas de documentos a diferentes idiomas:: 
* Cómo configurar Screen and Turtles:: 

cmd — Support for line-oriented command interpreters

* Objetos Cmd:: 
* Ejemplo Cmd:: 

shlex — Simple lexical analysis

* objetos shlex:: 
* Reglas de análisis:: 
* Compatibilidad mejorada con intérprete de comandos:: 

Interfaces gráficas de usuario con Tk

* tkinter — Python interface to Tcl/Tk:: 
* tkinter.colorchooser — Color choosing dialog: tkinter colorchooser — Color choosing dialog. 
* tkinter.font — Tkinter font wrapper: tkinter font — Tkinter font wrapper. 
* Diálogos tkinter:: 
* tkinter.messagebox — Tkinter message prompts: tkinter messagebox — Tkinter message prompts. 
* tkinter.scrolledtext — Scrolled Text Widget: tkinter scrolledtext — Scrolled Text Widget. 
* tkinter.dnd — Drag and drop support: tkinter dnd — Drag and drop support. 
* tkinter.ttk — Tk themed widgets: tkinter ttk — Tk themed widgets. 
* IDLE: IDLE<60>. 

tkinter — Python interface to Tcl/Tk

* Arquitectura:: 
* Módulos Tkinter:: 
* Guía de supervivencia de Tkinter:: 
* Modelo de subprocesamiento:: 
* Guía práctica:: 
* Gestor de archivos:: 

Guía de supervivencia de Tkinter

* Un programa simple de Hola Mundo:: 
* Conceptos importantes de Tk:: 
* Entendiendo como funcionan los empaquetadores de Tcl/Tk:: 
* ¿Cómo lo hago?@comma{} ¿Cómo funciona?: ¿Cómo lo hago? ¿Cómo funciona?. 
* Navegando en el manual de referencia de Tcl/Tk:: 

Guía práctica

* Configuración de opciones:: 
* El empaquetador:: 
* Opciones del empaquetador:: 
* Asociación de variables de widget:: 
* El gestor de ventanas:: 
* Tipos de datos de opciones Tk:: 
* Enlaces y eventos:: 
* El parámetro índice:: 
* Imágenes:: 

Diálogos tkinter

* tkinter.simpledialog —Diálogos de entrada estándar de Tkinter: tkinter simpledialog —Diálogos de entrada estándar de Tkinter. 
* Diálogos de selección de archivos:: 
* tkinter.commondialog — Plantillas de ventanas de diálogo: tkinter commondialog — Plantillas de ventanas de diálogo. 

Diálogos de selección de archivos

* Diálogos nativos de carga/guardado:: 

tkinter.ttk — Tk themed widgets

* Uso de Ttk:: 
* Ttk widgets:: 
* Widget:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk Styling:: 

Widget

* Opciones estándar:: 
* Opciones de widgets desplegables:: 
* Opciones de etiqueta:: 
* Opciones de compatibilidad:: 
* Estados del widget:: 
* ttk.Widget: ttk Widget. 

Combobox

* Opciones:: 
* Eventos virtuales:: 
* ttk.Combobox: ttk Combobox. 

Spinbox

* Opciones: Opciones<2>. 
* Eventos virtuales: Eventos virtuales<2>. 
* ttk.Spinbox: ttk Spinbox. 

Notebook

* Opciones: Opciones<3>. 
* Opciones de pestañas:: 
* Identificadores de pestañas:: 
* Eventos virtuales: Eventos virtuales<3>. 
* ttk.Notebook: ttk Notebook. 

Progressbar

* Opciones: Opciones<4>. 
* ttk.Progressbar: ttk Progressbar. 

Separator

* Opciones: Opciones<5>. 

Sizegrip

* Notas específicas por plataforma:: 
* Errores detectados:: 

Treeview

* Opciones: Opciones<6>. 
* Opciones de elementos:: 
* Opciones de etiqueta: Opciones de etiqueta<2>. 
* Identificadores de columna:: 
* Eventos virtuales: Eventos virtuales<4>. 
* ttk.Treeview: ttk Treeview. 

Ttk Styling

* Diseños:: 

IDLE

* Menús:: 
* Edición y navegación:: 
* Inicio y ejecución de código:: 
* Ayuda y preferencias:: 
* idlelib:: 

Menús

* Menú de archivo (Shell y Editor): Menú de archivo Shell y Editor. 
* Menú editar (Shell y Editor): Menú editar Shell y Editor. 
* Menú de formato (solo ventana del Editor): Menú de formato solo ventana del Editor. 
* Menú ejecutar (solo ventana Editor): Menú ejecutar solo ventana Editor. 
* Menú de shell (solo ventana de shell): Menú de shell solo ventana de shell. 
* Menú de depuración (solo ventana de shell): Menú de depuración solo ventana de shell. 
* Menú de opciones (Shell y editor): Menú de opciones Shell y editor. 
* Menú de ventana (shell y editor): Menú de ventana shell y editor. 
* Menú de ayuda (shell y editor): Menú de ayuda shell y editor. 
* Menús contextuales:: 

Edición y navegación

* Ventana del editor:: 
* Atajos de teclado:: 
* Indentación automática:: 
* Buscar y reemplazar:: 
* Terminaciones:: 
* Sugerencias de llamada:: 
* Contexto del código:: 
* Ventana de Shell:: 
* Colores del texto:: 

Inicio y ejecución de código

* Uso de línea de comando:: 
* Error de inicio:: 
* Ejecutando código del usuario:: 
* Salida del usuario en consola:: 
* Desarrollando aplicaciones tkinter:: 
* Ejecutando sin un subproceso:: 

Ayuda y preferencias

* Recursos de ayuda:: 
* Preferencias de configuración:: 
* IDLE en macOS:: 
* Extensiones:: 

Herramientas de desarrollo

* typing — Soporte para type hints:: 
* pydoc — Documentation generator and online help system:: 
* Modo de desarrollo de Python:: 
* doctest — Test interactive Python examples:: 
* unittest — Unit testing framework:: 
* unittest.mock — mock object library: unittest mock — mock object library. 
* unittest.mock — getting started: unittest mock — getting started. 
* test — Regression tests package for Python:: 
* test.support — Utilidades para el conjunto de pruebas de Python: test support — Utilidades para el conjunto de pruebas de Python. 
* test.support.socket_helper — Utilidades para pruebas de socket: test support socket_helper — Utilidades para pruebas de socket. 
* test.support.script_helper —Utilidades para las pruebas de ejecución de Python: test support script_helper —Utilidades para las pruebas de ejecución de Python. 
* test.support.bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode: test support bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode. 
* test.support.threading_helper — Utilidades para pruebas con hilos: test support threading_helper — Utilidades para pruebas con hilos. 
* test.support.os_helper — Utilidades para pruebas de sistemas operativos: test support os_helper — Utilidades para pruebas de sistemas operativos. 
* test.support.import_helper — Utilidades para pruebas de importación: test support import_helper — Utilidades para pruebas de importación. 
* test.support.warnings_helper — Utilidades para pruebas de advertencias: test support warnings_helper — Utilidades para pruebas de advertencias. 

typing — Soporte para type hints

* Specification for the Python Type System:: 
* Alias de tipo:: 
* NewType:: 
* Annotating callable objects:: 
* Genéricos:: 
* Annotating tuples:: 
* The type of class objects:: 
* Annotating generators and coroutines:: 
* Tipos genéricos definidos por el usuario:: 
* El tipo Any:: 
* Subtipado nominal vs estructural:: 
* Contenido del módulo: Contenido del módulo<3>. 
* Línea de tiempo de obsolescencia de características principales:: 

Contenido del módulo

* Primitivos especiales de tipado:: 
* Protocolos: Protocolos<3>. 
* ABCs for working with IO:: 
* Funciones y decoradores:: 
* Ayudas de introspección:: 
* Constantes: Constantes<10>. 
* Deprecated aliases:: 

Primitivos especiales de tipado

* Tipos especiales:: 
* Formas especiales:: 
* Building generic types and type aliases:: 
* Otras directivas especiales:: 

Deprecated aliases

* Aliases to built-in types:: 
* Aliases to types in collections:: 
* Aliases to other concrete types:: 
* Aliases to container ABCs in collections.abc: Aliases to container ABCs in collections abc. 
* Aliases to asynchronous ABCs in collections.abc: Aliases to asynchronous ABCs in collections abc. 
* Aliases to other ABCs in collections.abc: Aliases to other ABCs in collections abc. 
* Aliases to contextlib ABCs:: 

Modo de desarrollo de Python

* Efectos del modo de desarrollo de Python:: 
* Ejemplo de ResourceWarning:: 
* Ejemplo de error de descriptor de archivo incorrecto:: 

doctest — Test interactive Python examples

* Uso simple; verificar ejemplos en docstrings: Uso simple verificar ejemplos en docstrings. 
* Uso Simple; Verificar ejemplos en un Archivo de Texto: Uso Simple Verificar ejemplos en un Archivo de Texto. 
* Cómo funciona:: 
* API básica:: 
* API de unittest:: 
* API avanzada:: 
* Depuración:: 
* Plataforma improvisada:: 

Cómo funciona

* ¿Qué docstrings son examinados?:: 
* ¿Cómo se reconocen los ejemplos de docstring?:: 
* ¿Cuál es el contexto de ejecución?:: 
* ¿Y las excepciones?:: 
* Banderas de Opción:: 
* Directivas:: 
* Advertencias: Advertencias<2>. 

API avanzada

* Objetos DocTest:: 
* Objetos Example:: 
* Objetos DocTestFinder:: 
* Objetos DocTestParser:: 
* TestResults objects:: 
* Objetos DocTestRunner:: 
* Objetos OutputChecker:: 

unittest — Unit testing framework

* Ejemplo sencillo:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<3>. 
* Descubrimiento de pruebas:: 
* Organización del código de pruebas:: 
* Reutilización de código de prueba anterior:: 
* Omitir tests y fallos esperados:: 
* Distinguiendo iteraciones de tests empleando subtests:: 
* Clases y funciones:: 
* Instalaciones para clases y módulos:: 
* Manejo de señales:: 

Interfaz de línea de comandos

* Opciones de la línea de órdenes:: 

Clases y funciones

* Casos de test:: 
* Agrupando tests:: 
* Cargando y ejecutando tests:: 

Cargando y ejecutando tests

* load_tests protocolo:: 

Instalaciones para clases y módulos

* setUpClass y tearDownClass:: 
* setUpModule y tearDownModule:: 

unittest.mock — mock object library

* Guía rápida:: 
* La clase Mock:: 
* Parcheadores:: 
* MagicMock y el soporte de métodos mágicos:: 
* Ayudantes:: 
* Order of precedence of side_effect@comma{} return_value and wraps: Order of precedence of side_effect return_value and wraps. 

La clase Mock

* Llamar a los objetos simulados:: 
* Eliminar atributos:: 
* Los nombres de los objetos simulados y el atributo name:: 
* Adjuntar objetos simulados como atributos:: 

Parcheadores

* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* métodos start y stop de patch:: 
* parchear objetos incorporados (builtins): parchear objetos incorporados builtins. 
* TEST_PREFIX:: 
* Anidando decoradores patch:: 
* Dónde parchear:: 
* Parcheando descriptores y objetos proxy:: 

MagicMock y el soporte de métodos mágicos

* Simular métodos mágicos:: 
* Magic Mock:: 

Ayudantes

* sentinel:: 
* DEFAULT:: 
* call:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* Autoespecificación:: 
* Sellar objetos simulados:: 

unittest.mock — getting started

* Usando mock:: 
* Decoradores de Parches:: 
* Otros ejemplos:: 

Usando mock

* Métodos de parcheo mock:: 
* Mock de llamadas a métodos sobre un objeto:: 
* Clases de Mock:: 
* Nombrando tus mocks:: 
* Siguiendo todas las llamadas:: 
* Establecer valores de retorno y atributos:: 
* Generar excepciones con mocks:: 
* Funciones de efectos secundarios e iterables:: 
* Iteradores asincrónicos de Mocking:: 
* El gestor de contexto asincrónico de Mocking:: 
* Creando un mock desde un objeto existente:: 
* Uso de side_effect para devolver el contenido por archivo:: 

Otros ejemplos

* Mocking de llamadas encadenadas:: 
* Mocking parcial:: 
* Mocking de un método generador:: 
* Aplicar el mismo parche a cada método de prueba:: 
* Mocking de métodos sin enlazar:: 
* Comprobación de varias llamadas con mock:: 
* Copiando con argumentos mutables:: 
* Anidando parches:: 
* Mocking a un diccionario usando MagickMock:: 
* Mock de subclases y sus atributos:: 
* Importaciones de Mocking con patch.dict: Importaciones de Mocking con patch dict. 
* Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas:: 
* Coincidencia de argumentos más compleja:: 

test — Regression tests package for Python

* Escritura de pruebas unitarias para el paquete test:: 
* Ejecución de pruebas utilizando la interfaz de línea de comandos:: 

Depuración y perfilado

* Tabla de auditoría de eventos:: 
* bdb — Debugger framework:: 
* faulthandler — Dump the Python traceback:: 
* pdb — El Depurador de Python:: 
* Los perfiladores de Python:: 
* timeit — Measure execution time of small code snippets:: 
* trace — Trace or track Python statement execution:: 
* tracemalloc — Trace memory allocations:: 

faulthandler — Dump the Python traceback

* Volcar el rastreo:: 
* Estado del gestor de fallos:: 
* Volcar los rastreos después de un tiempo de espera:: 
* Volcar el rastreo en una señal del usuario:: 
* Problema con descriptores de archivo:: 
* Ejemplo: Ejemplo<13>. 

pdb — El Depurador de Python

* Comandos del depurador:: 

Los perfiladores de Python

* Introducción a los perfiladores:: 
* Manual instantáneo de usuario:: 
* Referencia del módulo profile y cProfile:: 
* La clase Stats:: 
* ¿Qué es el perfil determinista?:: 
* Limitaciones:: 
* Calibración:: 
* Usando un temporizador personalizado:: 

timeit — Measure execution time of small code snippets

* Ejemplos básicos:: 
* Interfaz de Python:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<4>. 
* Ejemplos: Ejemplos<28>. 

trace — Trace or track Python statement execution

* Uso de la línea de comandos: Uso de la línea de comandos<3>. 
* Interfaz programática:: 

Uso de la línea de comandos

* Opciones principales:: 
* Modificadores:: 
* Filtros:: 

tracemalloc — Trace memory allocations

* Ejemplos: Ejemplos<29>. 
* API:: 

Ejemplos

* Mostrar los 10 principales:: 
* Calcula las diferencias:: 
* Consigue el seguimiento del bloque de memoria:: 
* Los 10 más bonitos:: 

Los 10 más bonitos

* Graba los tamaños actual y máximo de todos los bloques de memoria rastreados:: 

API

* Funciones: Funciones<9>. 
* Filtro de dominio:: 
* Filtro:: 
* Cuadro:: 
* Captura instantánea:: 
* Estadística:: 
* StatisticDiff:: 
* Rastro:: 
* Seguimiento:: 

Empaquetado y distribución de software

* ensurepip — Bootstrapping the pip installer:: 
* venv — Creation of virtual environments:: 
* zipapp — Manage executable Python zip archives:: 

ensurepip — Bootstrapping the pip installer

* Interfaz de línea de comandos: Interfaz de línea de comandos<5>. 
* API del módulo:: 

venv — Creation of virtual environments

* Creación de entornos virtuales:: 
* Cómo funcionan los venvs:: 
* API: API<2>. 
* Un ejemplo de la extensión de EnvBuilder:: 

zipapp — Manage executable Python zip archives

* Ejemplo básico:: 
* Interfaz de línea de comando:: 
* API de Python:: 
* Ejemplos: Ejemplos<30>. 
* Especificar el intérprete:: 
* Creando aplicaciones independientes con zipapp:: 
* El formato de archivado Zip de aplicaciones Python:: 

Creando aplicaciones independientes con zipapp

* Advertencias: Advertencias<3>. 

Servicios en tiempo de ejecución de Python

* sys — System-specific parameters and functions:: 
* sys.monitoring — Execution event monitoring: sys monitoring — Execution event monitoring. 
* sysconfig — Provide access to Python’s configuration information:: 
* builtins — Built-in objects:: 
* __main__ — Top-level code environment:: 
* warnings — Warning control:: 
* dataclasses — Data Classes:: 
* contextlib — Utilidades para declaraciones de contexto with:: 
* abc — Abstract Base Classes:: 
* atexit — Exit handlers:: 
* traceback — Print or retrieve a stack traceback:: 
* __future__ — Future statement definitions:: 
* gc — Garbage Collector interface:: 
* inspect — Inspect live objects:: 
* annotationlib — Functionality for introspecting annotations:: 
* site — Site-specific configuration hook:: 

sys.monitoring — Execution event monitoring

* Identificadores de herramientas:: 
* Eventos:: 
* Activar y desactivar eventos:: 
* Registrando funciones de retrollamada:: 

Identificadores de herramientas

* Registro y uso de herramientas:: 

Eventos

* Eventos locales:: 
* Eventos auxiliares:: 
* Otros eventos:: 
* El evento STOP_ITERATION:: 

Activar y desactivar eventos

* Configuración de eventos globalmente:: 
* Eventos por objeto de código:: 
* Deshabilitando eventos:: 

Registrando funciones de retrollamada

* Argumentos de la función de retrollamada:: 

sysconfig — Provide access to Python’s configuration information

* Variables de configuración:: 
* Rutas de instalación:: 
* User scheme:: 
* Home scheme:: 
* Prefix scheme:: 
* Installation path functions:: 
* Otras funciones: Otras funciones<3>. 
* Usando sysconfig como un script:: 

User scheme

* posix_user:: 
* nt_user:: 
* osx_framework_user:: 

Home scheme

* posix_home:: 

Prefix scheme

* posix_prefix:: 
* nt:: 

__main__ — Top-level code environment

* __name__ == '__main__':: 
* __main__.py en paquetes de Python: __main__ py en paquetes de Python. 
* import __main__:: 

__name__ == '__main__'

* ¿Qué es el «entorno de código de máximo nivel»?:: 
* Uso idiomático:: 
* Consideraciones de empaquetado:: 

__main__.py en paquetes de Python

* Uso idiomático: Uso idiomático<2>. 

warnings — Warning control

* Categorías de advertencia:: 
* El filtro de advertencias:: 
* Eliminación temporal de las advertencias:: 
* Advertencias de prueba:: 
* Actualización del código para las nuevas versiones de las dependencias:: 
* Funciones disponibles:: 
* Gestores de contexto disponibles:: 

El filtro de advertencias

* Repeated Warning Suppression Criteria:: 
* Descripción de los filtros de advertencia:: 
* Filtro de advertencia predeterminado:: 
* Anulando el filtro por defecto:: 

dataclasses — Data Classes

* Contenidos del módulo: Contenidos del módulo<4>. 
* Procesamiento posterior a la inicialización:: 
* Variables de clase:: 
* Variable de solo inicialización:: 
* Instancias congeladas:: 
* Herencia: Herencia<2>. 
* Re-ordering of keyword-only parameters in __init__(): Re-ordering of keyword-only parameters in __init__. 
* Funciones fábrica por defecto:: 
* Valores por defecto mutables:: 
* Campos tipo descriptor:: 

contextlib — Utilidades para declaraciones de contexto with

* Utilidades:: 
* Ejemplos y recetas:: 
* Gestores de contexto de uso único@comma{} reutilizables y reentrantes: Gestores de contexto de uso único reutilizables y reentrantes. 

Ejemplos y recetas

* Apoyando un número variable de gestores de contexto:: 
* Capturando excepciones de los métodos __enter__:: 
* Limpieza en una implementación __enter__:: 
* Reemplazar cualquier uso de try-finally y marcar variables:: 
* Usar un gestor de contexto como decorador de funciones:: 

Gestores de contexto de uso único, reutilizables y reentrantes

* Gestores contextuales reentrantes:: 
* Gestores contextuales reutilizables:: 

atexit — Exit handlers

* Ejemplo con atexit:: 

traceback — Print or retrieve a stack traceback

* Module-Level Functions:: 
* TracebackException Objects:: 
* StackSummary Objects:: 
* FrameSummary Objects:: 
* Examples of Using the Module-Level Functions:: 
* Examples of Using TracebackException:: 

__future__ — Future statement definitions

* Module Contents:: 

inspect — Inspect live objects

* Tipos y miembros:: 
* Recuperar el código fuente:: 
* Introspección de los invocables con el objeto Signature:: 
* Clases y funciones: Clases y funciones<2>. 
* La pila del interprete:: 
* Obteniendo atributos estáticamente:: 
* Current State of Generators@comma{} Coroutines@comma{} and Asynchronous Generators: Current State of Generators Coroutines and Asynchronous Generators. 
* Objetos de código Bit Flags:: 
* Buffer flags:: 
* Interfaz de la línea de comando:: 

annotationlib — Functionality for introspecting annotations

* Annotation semantics:: 
* Classes:: 
* Functions: Functions<2>. 

site — Site-specific configuration hook

* sitecustomize:: 
* usercustomize:: 
* Configuración de Readline:: 
* Contenido del módulo: Contenido del módulo<4>. 
* Interfaz de línea de comando: Interfaz de línea de comando<2>. 

Intérpretes de Python personalizados

* code — Interpreter base classes:: 
* codeop — Compile Python code:: 

code — Interpreter base classes

* Objetos de intérprete interactivo:: 
* Objetos de consola interactiva:: 

Importando módulos

* zipimport — Import modules from Zip archives:: 
* pkgutil — Package extension utility:: 
* modulefinder — Find modules used by a script:: 
* runpy — Locating and executing Python modules:: 
* importlib — La implementación de import:: 
* importlib.resources – Package resource reading@comma{} opening and access: importlib resources – Package resource reading opening and access. 
* importlib.resources.abc – Abstract base classes for resources: importlib resources abc – Abstract base classes for resources. 
* importlib.metadata – Acceso a los metadatos de los paquetes: importlib metadata – Acceso a los metadatos de los paquetes. 
* La inicialización de la ruta de búsqueda de módulo de sys.path: La inicialización de la ruta de búsqueda de módulo de sys path. 

zipimport — Import modules from Zip archives

* Objetos zipimporter:: 
* Ejemplos: Ejemplos<31>. 

modulefinder — Find modules used by a script

* Ejemplo de uso de ModuleFinder:: 

importlib — La implementación de import

* Introducción: Introducción<10>. 
* Funciones: Funciones<10>. 
* importlib.abc – Clases base abstractas relacionadas con la importación: importlib abc – Clases base abstractas relacionadas con la importación. 
* importlib.machinery – Importadores y enlaces de ruta: importlib machinery – Importadores y enlaces de ruta. 
* importlib.util – Código de utilidad para importadores: importlib util – Código de utilidad para importadores. 
* Ejemplos: Ejemplos<32>. 

Ejemplos

* Importar programáticamente:: 
* Comprobando si se puede importar un módulo:: 
* Importar un archivo fuente directamente:: 
* Implementar importaciones diferidas:: 
* Configurar un importador:: 
* Aproximando importlib.import_module(): Aproximando importlib import_module. 

importlib.resources – Package resource reading, opening and access

* Functional API:: 

importlib.metadata – Acceso a los metadatos de los paquetes

* Descripción general:: 
* API funcional:: 
* Distribuciones:: 
* Distribution Discovery:: 
* Implementing Custom Providers:: 

API funcional

* Puntos de entrada:: 
* Metadatos de distribución:: 
* Versiones de distribución:: 
* Archivos de distribución:: 
* Requerimientos de la distribución:: 
* Mapeo de paquetes de importación a distribución:: 

Implementing Custom Providers

* Example:: 

La inicialización de la ruta de búsqueda de módulo de sys.path

* Entornos virtuales: Entornos virtuales<2>. 
* Archivos _pth:: 
* Python embebido:: 

Servicios del lenguaje Python

* ast — Abstract Syntax Trees:: 
* symtable — Access to the compiler’s symbol tables:: 
* token — Constants used with Python parse trees:: 
* keyword — Testing for Python keywords:: 
* tokenize — Tokenizer for Python source:: 
* tabnanny — Detection of ambiguous indentation:: 
* pyclbr — Python module browser support:: 
* py_compile — Compile Python source files:: 
* compileall — Byte-compile Python libraries:: 
* dis — Disassembler for Python bytecode:: 
* pickletools — Tools for pickle developers:: 

ast — Abstract Syntax Trees

* Gramática abstracta:: 
* Clases nodo:: 
* Ayudantes de ast:: 
* Banderas del compilador: Banderas del compilador<2>. 
* Uso en línea de comandos:: 

Clases nodo

* Nodos raíz:: 
* Literales: Literales<3>. 
* Variables:: 
* Expresiones: Expresiones<2>. 
* Declaraciones:: 
* Control de flujo:: 
* La coincidencia de patrones:: 
* Tipos de parámetro:: 
* Definiciones de función y clase:: 
* Async y await:: 

Expresiones

* Subindexado:: 
* Comprensiones:: 

Declaraciones

* Importaciones:: 

symtable — Access to the compiler’s symbol tables

* Generando tablas de símbolos:: 
* Examinando la tabla de símbolos:: 
* Command-Line Usage:: 

tokenize — Tokenizer for Python source

* Convirtiendo la entrada en tokens:: 
* Uso como línea de comandos:: 
* Ejemplos: Ejemplos<33>. 

pyclbr — Python module browser support

* Objetos Function:: 
* Objetos Class:: 

py_compile — Compile Python source files

* Interfaz de línea de comandos: Interfaz de línea de comandos<6>. 

compileall — Byte-compile Python libraries

* Uso de la línea de comandos: Uso de la línea de comandos<4>. 
* Funciones públicas:: 

dis — Disassembler for Python bytecode

* Command-line interface: Command-line interface<3>. 
* Análisis de bytecode:: 
* Funciones de análisis:: 
* Instrucciones bytecode de Python:: 
* Colecciones opcode:: 

pickletools — Tools for pickle developers

* Uso de la línea de comandos: Uso de la línea de comandos<5>. 
* Interfaz programática: Interfaz programática<2>. 

Uso de la línea de comandos

* Opciones de línea de comandos: Opciones de línea de comandos<3>. 

Servicios Específicos para MS Windows

* msvcrt — Useful routines from the MS VC++ runtime:: 
* winreg — Windows registry access:: 
* winsound — Sound-playing interface for Windows:: 

msvcrt — Useful routines from the MS VC++ runtime

* Operaciones con archivos:: 
* Consola E/S:: 
* Otras funciones: Otras funciones<4>. 

winreg — Windows registry access

* Funciones: Funciones<11>. 
* Constantes: Constantes<11>. 
* Objetos de control del registro:: 

Constantes

* HKEY_* Constantes:: 
* Access Rights:: 
* Tipos de valor:: 

Access Rights

* Específico de 64 bits:: 

Servicios específicos de Unix

* posix — The most common POSIX system calls:: 
* pwd — The password database:: 
* grp — The group database:: 
* termios — POSIX style tty control:: 
* tty — Terminal control functions:: 
* pty — Pseudo-terminal utilities:: 
* fcntl — The fcntl and ioctl system calls:: 
* resource — Resource usage information:: 
* syslog — Unix syslog library routines:: 

posix — The most common POSIX system calls

* Soporte de archivos grandes:: 
* Contenido notable del módulo:: 

termios — POSIX style tty control

* Ejemplo: Ejemplo<14>. 

pty — Pseudo-terminal utilities

* Ejemplo: Ejemplo<15>. 

resource — Resource usage information

* Límites de recursos:: 
* Utilización de recursos:: 

syslog — Unix syslog library routines

* Ejemplos: Ejemplos<34>. 

Ejemplos

* Ejemplo sencillo: Ejemplo sencillo<2>. 

Módulos reemplazados

* getopt — C-style parser for command line options:: 
* optparse — Parser for command line options:: 

optparse — Parser for command line options

* Contexto:: 
* Tutorial: Tutorial<4>. 
* Guía de referencia:: 
* Retrollamadas de opción:: 
* Extendiendo el módulo optparse:: 
* Excepciones: Excepciones<19>. 

Contexto

* Terminología:: 
* ¿Qué finalidad tienen las opciones?:: 
* ¿Qué finalidad tienen los argumentos posicionales?:: 

Tutorial

* Comprendiendo las acciones de opción:: 
* La acción store:: 
* Manejo de opciones booleanas (flags): Manejo de opciones booleanas flags. 
* Otras acciones:: 
* Valores por defecto:: 
* Generando ayuda:: 
* Imprimir una cadena de caracteres con la versión del programa:: 
* Cómo maneja los errores el módulo optparse:: 
* Reuniendo todas las piezas:: 

Generando ayuda

* Agrupando opciones:: 

Guía de referencia

* Creando el analizador sintáctico (parser): Creando el analizador sintáctico parser. 
* Completando el analizador con opciones:: 
* Definiendo las opciones:: 
* Atributos de opción:: 
* Acciones de opción estándares:: 
* Tipos de opción estándares:: 
* Analizando los argumentos:: 
* Consultar y manipular el analizador de opciones:: 
* Conflictos entre opciones:: 
* Limpieza:: 
* Otros métodos:: 

Retrollamadas de opción

* Definición de una opción con retrollamada:: 
* Cómo son invocadas las retrollamadas:: 
* Lanzando errores en una retrollamada:: 
* Ejemplo de retrollamada 1; una retrollamada trivial: Ejemplo de retrollamada 1 una retrollamada trivial. 
* Ejemplo de retrollamada 2; comprobar el orden de las opciones: Ejemplo de retrollamada 2 comprobar el orden de las opciones. 
* Ejemplo de retrollamada 3; comprobar el orden de las opciones (generalizado): Ejemplo de retrollamada 3 comprobar el orden de las opciones generalizado. 
* Ejemplo de retrollamada 4; comprobar una condición arbitraria: Ejemplo de retrollamada 4 comprobar una condición arbitraria. 
* Ejemplo de retrollamada 5; argumentos fijos: Ejemplo de retrollamada 5 argumentos fijos. 
* Ejemplo de retrollamada 6; argumentos variables: Ejemplo de retrollamada 6 argumentos variables. 

Extendiendo el módulo optparse

* Agregando nuevos tipos:: 
* Agregando nuevas acciones:: 

Removed Modules

* aifc — Read and write AIFF and AIFC files:: 
* asynchat — Asynchronous socket command/response handler:: 
* asyncore — Asynchronous socket handler:: 
* audioop — Manipulate raw audio data:: 
* cgi — Common Gateway Interface support:: 
* cgitb — Traceback manager for CGI scripts:: 
* chunk — Read IFF chunked data:: 
* crypt — Function to check Unix passwords:: 
* distutils — Building and installing Python modules:: 
* imghdr — Determine the type of an image:: 
* imp — Access the import internals:: 
* mailcap — Mailcap file handling:: 
* msilib — Read and write Microsoft Installer files:: 
* nis — Interface to Sun’s NIS (Yellow Pages): nis — Interface to Sun’s NIS Yellow Pages. 
* nntplib — NNTP protocol client:: 
* ossaudiodev — Access to OSS-compatible audio devices:: 
* pipes — Interface to shell pipelines:: 
* smtpd — SMTP Server:: 
* sndhdr — Determine type of sound file:: 
* spwd — The shadow password database:: 
* sunau — Read and write Sun AU files:: 
* telnetlib — Telnet client:: 
* uu — Encode and decode uuencode files:: 
* xdrlib — Encode and decode XDR data:: 

Ampliación e incrustación del intérprete de Python

* Herramientas de terceros recomendadas:: 
* Crear extensiones sin herramientas de terceros:: 
* Incrustar el tiempo de ejecución de CPython en una aplicación más grande:: 

Crear extensiones sin herramientas de terceros

* Extendiendo Python con C o C++:: 
* Definición de tipos de extensión; Tutorial: Definición de tipos de extensión Tutorial. 
* Definición de tipos de extensión; temas variados: Definición de tipos de extensión temas variados. 
* Construyendo extensiones C y C++:: 
* Creación de extensiones C y C++ en Windows:: 

Extendiendo Python con C o C++

* Un ejemplo simple:: 
* Intermezzo; errores y excepciones: Intermezzo errores y excepciones. 
* De vuelta al ejemplo:: 
* La tabla de métodos del módulo y la función de inicialización:: 
* Compilación y enlazamiento:: 
* Llamando funciones Python desde C:: 
* Extracción de parámetros en funciones de extensión:: 
* Parámetros de palabras clave para funciones de extensión:: 
* Construyendo valores arbitrarios:: 
* Conteo de referencias:: 
* Escribiendo extensiones en C++:: 
* Proporcionar una API C para un módulo de extensión:: 

Conteo de referencias

* Conteo de referencias en Python:: 
* Reglas de propiedad:: 
* Hielo delgado:: 
* Punteros NULL:: 

Definición de tipos de extensión: Tutorial

* Lo básico:: 
* Agregar datos y métodos al ejemplo básico:: 
* Proporcionar un control más preciso sobre los atributos de datos:: 
* Apoyo a la recolección de basura cíclica:: 
* Subclases de otros tipos:: 

Definición de tipos de extensión: temas variados

* Finalización y desasignación:: 
* Presentación de objetos:: 
* Gestión de atributos:: 
* Comparación de Objetos:: 
* Soporte de protocolo abstracto:: 
* Soporte de referencia débil:: 
* Más Sugerencias:: 

Gestión de atributos

* Gestión de atributos genéricos:: 
* Gestión de atributos específicos de tipo:: 

Construyendo extensiones C y C++

* Building C and C++ Extensions with setuptools:: 

Creación de extensiones C y C++ en Windows

* Un enfoque de libro de cocina:: 
* Diferencias entre Unix y Windows:: 
* Usar DLL en la práctica:: 

Incrustar el tiempo de ejecución de CPython en una aplicación más grande

* Incrustando Python en otra aplicación:: 

Incrustando Python en otra aplicación

* Incrustación de muy alto nivel:: 
* Más allá de la incrustación de muy alto nivel; una visión general: Más allá de la incrustación de muy alto nivel una visión general. 
* Incrustación pura:: 
* Extendiendo Python incrustado:: 
* Incrustando Python en C++:: 
* Compilar y enlazar bajo sistemas tipo Unix:: 

Manual de referencia de la API en C de Python

* Introducción: Introducción<11>. 
* Estabilidad de la API en C:: 
* La capa de muy alto nivel:: 
* Conteo de referencias: Conteo de referencias<2>. 
* Manejo de excepciones:: 
* Utilidades: Utilidades<2>. 
* Capa de objetos abstractos:: 
* Capa de objetos concretos:: 
* Inicialización@comma{} finalización e hilos: Inicialización finalización e hilos. 
* Configuración de inicialización de Python:: 
* Gestión de la memoria:: 
* Soporte de implementación de objetos:: 
* Versiones de API y ABI:: 
* Monitoring C API:: 
* Generating Execution Events:: 

Introducción

* Estándares de codificación:: 
* Archivos de cabecera (Include): Archivos de cabecera Include. 
* Macros útiles:: 
* Objetos@comma{} tipos y conteos de referencias: Objetos tipos y conteos de referencias. 
* Excepciones: Excepciones<20>. 
* Integración de Python:: 
* Depuración de compilaciones:: 

Objetos, tipos y conteos de referencias

* Conteo de Referencias:: 
* Tipos:: 

Conteo de Referencias

* Detalles del conteo de referencia:: 

Estabilidad de la API en C

* Unstable C API:: 
* Interfaz binaria de aplicación estable:: 
* Consideraciones de la plataforma:: 
* Contenido de la API limitada:: 

Interfaz binaria de aplicación estable

* Limited C API:: 
* Stable ABI:: 
* Alcance y rendimiento de la API limitada:: 
* Advertencias de la API limitada:: 

Manejo de excepciones

* Impresión y limpieza:: 
* Lanzando excepciones: Lanzando excepciones<2>. 
* Emitir advertencias:: 
* Consultando el indicador de error:: 
* Manejo de señal:: 
* Clases de excepción:: 
* Objetos excepción:: 
* Objetos unicode de excepción:: 
* Control de recursión:: 
* Excepciones estándar:: 
* Categorías de advertencia estándar:: 

Utilidades

* Utilidades del sistema operativo:: 
* Funciones del Sistema:: 
* Control de procesos:: 
* Importando módulos: Importando módulos<2>. 
* Soporte de empaquetado (marshalling) de datos: Soporte de empaquetado marshalling de datos. 
* Analizando argumentos y construyendo valores:: 
* Conversión y formato de cadenas de caracteres:: 
* PyHash API:: 
* Reflexión:: 
* Registro de códec y funciones de soporte:: 
* PyTime C API:: 
* Support for Perf Maps:: 

Analizando argumentos y construyendo valores

* Analizando argumentos:: 
* Construyendo valores:: 

Analizando argumentos

* Cadena de caracteres y búferes:: 
* Números: Números<2>. 
* Otros objetos:: 
* Funciones API:: 

Registro de códec y funciones de soporte

* API de búsqueda de códec:: 
* API de registro para controladores de errores de codificación Unicode:: 

PyTime C API

* Types:: 
* Clock Functions:: 
* Raw Clock Functions:: 
* Conversion functions:: 

Capa de objetos abstractos

* Protocolo de objeto:: 
* Protocolo de llamada:: 
* Protocolo de números:: 
* Protocolo de secuencia:: 
* Protocolo de mapeo:: 
* Protocolo iterador:: 
* Protocolo búfer:: 

Protocolo de llamada

* El protocolo tp_call:: 
* El protocolo vectorcall:: 
* API para invocar objetos:: 
* API de soporte de llamadas:: 

El protocolo vectorcall

* Control de recursión: Control de recursión<2>. 
* API de soporte para vectorcall:: 

Protocolo búfer

* Estructura de búfer:: 
* Tipos de solicitud búfer:: 
* Arreglos complejos:: 
* Funciones relacionadas a búfer:: 

Tipos de solicitud búfer

* campos independientes de solicitud:: 
* formato de sólo lectura:: 
* formas@comma{} strides@comma{} suboffsets: formas strides suboffsets. 
* solicitudes de contigüidad:: 
* solicitudes compuestas:: 

Arreglos complejos

* Estilo NumPy; forma y strides: Estilo NumPy forma y strides. 
* Estilo PIL; forma@comma{} strides y suboffsets: Estilo PIL forma strides y suboffsets. 

Capa de objetos concretos

* Objetos fundamentales:: 
* Objetos numéricos:: 
* Objetos de secuencia:: 
* Objetos contenedor:: 
* Objetos de función:: 
* Otros objetos: Otros objetos<2>. 

Objetos fundamentales

* Objetos tipo:: 
* El objeto None:: 

Objetos tipo

* Crear tipos asignados en montículo (heap): Crear tipos asignados en montículo heap. 

Objetos numéricos

* Objetos enteros:: 
* Objetos booleanos:: 
* Floating-Point Objects:: 
* Objetos de números complejos:: 

Floating-Point Objects

* Funciones de empaquetado y desempaquetado:: 

Funciones de empaquetado y desempaquetado

* Funciones de Empaquetado:: 
* Funciones de Desempaquetado:: 

Objetos de números complejos

* Números complejos como estructuras C:: 
* Números complejos como objetos de Python:: 

Objetos de secuencia

* Objetos bytes:: 
* Objetos de arreglos de bytes (bytearrays): Objetos de arreglos de bytes bytearrays. 
* Objetos y códecs unicode:: 
* Objetos tupla:: 
* Objetos de secuencia de estructura:: 
* Objetos lista:: 

Objetos de arreglos de bytes (bytearrays)

* Macros de verificación de tipos:: 
* Funciones API directas:: 
* Macros:: 

Objetos y códecs unicode

* Objetos unicode:: 
* Códecs incorporados:: 
* Métodos y funciones de ranura (Slot): Métodos y funciones de ranura Slot. 
* PyUnicodeWriter:: 

Objetos unicode

* Tipo unicode:: 
* Propiedades de caracteres Unicode:: 
* Creando y accediendo a cadenas de caracteres Unicode:: 
* Codificación regional:: 
* Codificación del sistema de archivos:: 
* soporte wchar_t:: 

Códecs incorporados

* Códecs genéricos:: 
* Códecs UTF-8:: 
* Códecs UTF-32:: 
* Códecs UTF-16:: 
* Códecs UTF-7:: 
* Códecs Unicode escapado:: 
* Códecs para Unicode escapado en bruto:: 
* Códecs Latin-1:: 
* Códecs ASCII:: 
* Códecs de mapa de caracteres:: 
* Códecs MBCS para Windows:: 
* Métodos & Ranuras (Slots): Métodos & Ranuras Slots. 

Objetos contenedor

* Objetos diccionario:: 
* Objetos conjunto:: 

Objetos de función

* Objetos función:: 
* Objetos de método de instancia:: 
* Objetos método: Objetos método<2>. 
* Objetos celda:: 
* Objetos código: Objetos código<2>. 
* Extra information:: 

Otros objetos

* Objetos archivo:: 
* Objetos módulo:: 
* Objetos iteradores:: 
* Objetos descriptores:: 
* Objetos rebanada (slice): Objetos rebanada slice. 
* Objetos de vista de memoria (MemoryView): Objetos de vista de memoria MemoryView. 
* Objetos de referencia débil:: 
* Cápsulas: Cápsulas<2>. 
* Objetos frame:: 
* Objetos generadores:: 
* Objetos corrutina:: 
* Objetos de variables de contexto:: 
* Objetos DateTime: Objetos DateTime<2>. 
* Objetos para indicaciones de tipado:: 

Objetos módulo

* Inicializando módulos en C:: 
* Búsqueda de módulos:: 

Inicializando módulos en C

* Inicialización monofásica:: 
* Inicialización multifase:: 
* Funciones de creación de módulos de bajo nivel:: 
* Funciones de soporte:: 

Objetos rebanada (slice)

* Objeto elipsis:: 

Objetos frame

* Internal Frames:: 

Inicialización, finalización e hilos

* Antes de la inicialización de Python:: 
* Variables de configuración global:: 
* Inicializando y finalizando el intérprete:: 
* Parámetros de todo el proceso:: 
* Estado del hilo y el bloqueo global del intérprete:: 
* Soporte de subinterprete:: 
* Notificaciones asincrónicas:: 
* Perfilado y Rastreo:: 
* Reference tracing:: 
* Soporte avanzado del depurador:: 
* Soporte de almacenamiento local de hilo:: 
* Synchronization Primitives:: 

Estado del hilo y el bloqueo global del intérprete

* Liberando el GIL del código de extensión:: 
* Hilos creados sin Python:: 
* Precauciones sobre fork(): Precauciones sobre fork. 
* Cautions regarding runtime finalization:: 
* API de alto nivel:: 
* API de bajo nivel:: 

Soporte de subinterprete

* A Per-Interpreter GIL:: 
* Errores y advertencias:: 

Soporte de almacenamiento local de hilo

* API de almacenamiento específico de hilo (TSS@comma{} Thread Specific Storage): API de almacenamiento específico de hilo TSS Thread Specific Storage. 
* API de almacenamiento local de hilos (TLS@comma{} Thread Local Storage): API de almacenamiento local de hilos TLS Thread Local Storage. 

API de almacenamiento específico de hilo (TSS, Thread Specific Storage)

* Asignación dinámica:: 
* Métodos: Métodos<2>. 

Synchronization Primitives

* Python Critical Section API:: 

Configuración de inicialización de Python

* PyConfig C API:: 
* PyInitConfig C API:: 
* Runtime Python configuration API:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* API Provisional Privada de Inicialización Multifásica:: 

PyConfig C API

* Ejemplo: Ejemplo<16>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* Preinicialización de Python con PyPreConfig:: 
* PyConfig:: 
* Inicialización con PyConfig:: 
* Configuración aislada:: 
* Configuración de Python: Configuración de Python<2>. 
* Configuración de la ruta de Python:: 

PyInitConfig C API

* Create Config:: 
* Error Handling:: 
* Get Options:: 
* Set Options:: 
* Module:: 
* Initialize Python:: 
* Ejemplo: Ejemplo<17>. 

Gestión de la memoria

* Visión general:: 
* Dominios del asignador:: 
* Interfaz de memoria sin procesar:: 
* Interfaz de memoria:: 
* Asignadores de objetos:: 
* Asignadores de memoria predeterminados:: 
* Personalizar asignadores de memoria:: 
* Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python:: 
* El asignador pymalloc:: 
* The mimalloc allocator:: 
* tracemalloc C API:: 
* Ejemplos: Ejemplos<35>. 

El asignador pymalloc

* Personalizar asignador de arena de pymalloc:: 

Soporte de implementación de objetos

* Asignación de objetos en el montículo:: 
* Estructuras de objetos comunes:: 
* Objetos tipo: Objetos tipo<2>. 
* Apoyo a la recolección de basura cíclica: Apoyo a la recolección de basura cíclica<2>. 

Estructuras de objetos comunes

* Tipos objeto base y macros:: 
* Implementando funciones y métodos:: 
* Acceder a atributos de tipos de extensión:: 

Acceder a atributos de tipos de extensión

* Member flags:: 
* Member types:: 
* Defining Getters and Setters:: 

Objetos tipo

* Referencia rápida:: 
* Definición de PyTypeObject:: 
* Ranuras (Slots) PyObject: Ranuras Slots PyObject. 
* Ranuras PyVarObject:: 
* Ranuras PyTypeObject:: 
* Tipos estáticos:: 
* Tipos Heap:: 
* Estructuras de objetos de números:: 
* Estructuras de objetos mapeo:: 
* Estructuras de objetos secuencia:: 
* Estructuras de objetos búfer:: 
* Estructuras de objetos asíncronos:: 
* Tipo Ranura typedefs:: 
* Ejemplos: Ejemplos<36>. 

Referencia rápida

* «ranuras tp» (tp slots): «ranuras tp» tp slots. 
* sub-ranuras (sub-slots): sub-ranuras sub-slots. 
* ranura de typedefs:: 

Apoyo a la recolección de basura cíclica

* Controlar el estado del recolector de basura:: 
* Querying Garbage Collector State:: 

Generating Execution Events

* Managing the Monitoring State:: 

Instalando módulos de Python

* Palabras clave: Palabras clave<2>. 
* Uso básico: Uso básico<3>. 
* ¿Cómo…:: 
* Problemas de instalación comunes:: 

¿Cómo…

* … instalo pip en versiones de Python anteriores a Python 3.4?: … instalo pip en versiones de Python anteriores a Python 3 4?. 
* … instalo paquetes solamente para el usuario actual?:: 
* … instalo paquetes científicos de Python?:: 
* … trabajo con múltiples versiones de Python instaladas en paralelo?:: 

Problemas de instalación comunes

* Instalando en el Python del sistema bajo Linux:: 
* Pip no está instalado:: 
* Instalando extensiones binarias:: 

Comos (HOWTOs) de Python

* Portar módulos de extensión a Python 3:: 
* Programación de curses con Python:: 
* Descriptor Guide:: 
* Debugging C API extensions and CPython Internals with GDB:: 
* HOWTO - Enum:: 
* HOWTO - Programación funcional:: 
* HOWTO hacer registros (Logging): HOWTO hacer registros Logging. 
* Libro de recetas de Logging:: 
* Expresiones regulares COMOS (HOWTO): Expresiones regulares COMOS HOWTO. 
* HOW TO - Programación con sockets:: 
* Sorting Techniques:: 
* CÓMO (HOWTO) Unicode: CÓMO HOWTO Unicode. 
* HOWTO - Cómo obtener recursos de Internet con el paquete urllib:: 
* Introducción al modulo ipaddress:: 
* Instrumentación de CPython con DTrace y SystemTap:: 
* Soporte de Python para el perfilador perf de Linux:: 
* Prácticas recomendadas para las anotaciones:: 
* Aislamiento de módulos de extensión:: 
* timer file descriptor HOWTO:: 
* The Python 2.3 Method Resolution Order: The Python 2 3 Method Resolution Order. 
* Python experimental support for free threading:: 
* C API Extension Support for Free Threading:: 

Programación de curses con Python

* ¿Qué es curses?:: 
* Iniciar y finalizar una aplicación de curses:: 
* Ventanas y pads:: 
* Mostrando el texto:: 
* Input del usuario:: 
* Para más información:: 

¿Qué es curses?

* El módulo curses de Python:: 

Mostrando el texto

* Atributos y color:: 

Descriptor Guide

* Guía introductoria:: 
* Ejemplo completo práctico:: 
* Tutorial técnico:: 
* Equivalentes en Python puro:: 

Guía introductoria

* Ejemplo simple; un descriptor que retorna una constante: Ejemplo simple un descriptor que retorna una constante. 
* Búsquedas dinámicas:: 
* Atributos gestionados:: 
* Nombres personalizados:: 
* Pensamientos finales:: 

Ejemplo completo práctico

* Clase validadora:: 
* Validadores personalizados:: 
* Aplicación práctica:: 

Tutorial técnico

* Resumen: Resumen<4>. 
* Definición e introducción:: 
* Protocolo de descriptores:: 
* Visión general de invocación de descriptores:: 
* Invocación desde una instancia:: 
* Invocación desde una clase:: 
* Invocación desde super:: 
* Resumen de la lógica de invocación:: 
* Notificación automática de nombre:: 
* Ejemplo de mapeos objeto-relacional (ORM): Ejemplo de mapeos objeto-relacional ORM. 

Equivalentes en Python puro

* Propiedades:: 
* Funciones y métodos:: 
* Tipos de métodos:: 
* Métodos estáticos:: 
* Métodos de clase:: 
* Objetos miembros y __slots__:: 

Debugging C API extensions and CPython Internals with GDB

* Prerequisites:: 
* Using the Debug build and Development mode:: 
* Using the python-gdb extension:: 
* Use with GDB commands:: 

Prerequisites

* Setup with Python built from source:: 
* Setup for Python from a Linux distro:: 

Using the python-gdb extension

* Pretty-printers:: 
* py-list:: 
* py-up and py-down:: 
* py-bt:: 
* py-print:: 
* py-locals:: 

HOWTO - Enum

* Acceso programático a los miembros de la enumeración y sus atributos:: 
* Duplicar miembros y valores de enumeración:: 
* Garantizar valores de enumeración únicos:: 
* Uso de valores automáticos:: 
* Iteración: Iteración<2>. 
* Comparaciones: Comparaciones<3>. 
* Miembros permitidos y atributos de enumeraciones:: 
* Subclases de Enum restringidas:: 
* Soporte de Dataclass:: 
* Serialización (Pickling): Serialización Pickling. 
* API funcional: API funcional<2>. 
* Enumeraciones derivadas:: 
* Cuándo usar __new__() frente a __init__(): Cuándo usar __new__ frente a __init__. 
* ¿En qué se diferencian las Enumeraciones (Enums) y las Banderas (Flags)?: ¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?. 
* Recetario de Enumeraciones:: 
* Subclase EnumType:: 

Enumeraciones derivadas

* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Bandera:: 
* Otros: Otros<2>. 

Cuándo usar __new__() frente a __init__()

* Puntos más finos:: 

Puntos más finos

* Nombres __dunder__ admitidos:: 
* Nombres _sunder_ admitidos:: 
* _Private__names:: 
* Tipo de miembro Enum:: 
* Creación de miembros que se mezclan con otros tipos de datos:: 
* Valor booleano de clases y miembros Enum:: 
* Clases Enum con métodos:: 
* Combinación de miembros de Flag:: 
* Minuciosidades Flag y IntFlag:: 

¿En qué se diferencian las Enumeraciones (Enums) y las Banderas (Flags)?

* Clases de enumeración:: 
* Clases de Banderas:: 
* Miembros de enumeración (también conocidos como instancias): Miembros de enumeración también conocidos como instancias. 
* Miembros de Banderas:: 

Recetario de Enumeraciones

* Omitir valores:: 
* Enum ordenado:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planeta:: 
* Periodo de tiempo:: 

Omitir valores

* Usando auto:: 
* Usando object:: 
* Usar una cadena descriptiva:: 
* Usando un __new__() personalizado: Usando un __new__ personalizado. 

HOWTO - Programación funcional

* Introducción: Introducción<12>. 
* Iteradores: Iteradores<2>. 
* Expresiones generadoras y listas por comprensión:: 
* Generadores: Generadores<2>. 
* Funciones incorporadas: Funciones incorporadas<3>. 
* El módulo itertools:: 
* El módulo functools:: 
* Funciones pequeñas y la expresión lambda:: 
* Historia de revisiones y reconocimientos:: 
* Referencias: Referencias<2>. 

Introducción

* Demostrabilidad formal:: 
* Modularidad:: 
* Facilidad de depurar y probar:: 
* Componibilidad:: 

Iteradores

* Tipos de datos que soportan iteradores:: 

Generadores

* Pasar valores a un generador:: 

El módulo itertools

* Crear nuevos iteradores:: 
* Aplicar funciones a los elementos:: 
* Seleccionar elementos:: 
* Funciones combinatorias:: 
* Agrupar elementos:: 

El módulo functools

* El módulo operator:: 

Referencias

* Generales:: 
* Específicas de Python:: 
* Documentación de Python:: 

HOWTO hacer registros (Logging)

* Tutorial básico de logging:: 
* Tutorial de registro avanzado:: 
* Niveles de registro:: 
* Gestores útiles:: 
* Excepciones lanzadas durante logging:: 
* Usando objetos arbitrarios como mensajes:: 
* Optimización:: 
* Otros recursos: Otros recursos<2>. 

Tutorial básico de logging

* Cuándo usar logging:: 
* Un simple ejemplo:: 
* Logging a un archivo:: 
* Registrar datos de variables:: 
* Cambiar el formato de los mensajes mostrados:: 
* Visualización de la fecha/hora en los mensajes:: 
* Próximos pasos:: 

Tutorial de registro avanzado

* Flujo de Registro:: 
* Registradores:: 
* Gestores:: 
* Formateadores:: 
* Configuración del registro:: 
* ¿Qué pasa si no se proporciona ninguna configuración:: 
* Configurando Logging para una biblioteca:: 

Niveles de registro

* Niveles personalizados:: 

Libro de recetas de Logging

* Usar logging en múltiples módulos:: 
* Logging desde múltiples hilos:: 
* Múltiples gestores y formateadores:: 
* Logging en múltiples destinos:: 
* Gestión personalizada de niveles:: 
* Ejemplo de servidor de configuración:: 
* Tratar con gestores que bloquean:: 
* Enviar y recibir eventos logging a través de una red:: 
* Agregar información contextual a su salida de logging:: 
* Uso de contextvars:: 
* Impartir información contextual en los gestores:: 
* Logging a un sólo archivo desde múltiples procesos:: 
* Usando rotación de archivos:: 
* Uso de estilos de formato alternativos:: 
* Personalización de LogRecord:: 
* Subclassing QueueHandler and QueueListener- a ZeroMQ example:: 
* Subclassing QueueHandler and QueueListener- a pynng example:: 
* Una configuración de ejemplo basada en diccionario:: 
* Usar un rotador y un nombre para personalizar el procesamiento de rotación de log:: 
* Un ejemplo de multiprocesamiento más elaborado:: 
* Insertar BOM en mensajes enviados a SysLogHandler:: 
* Implementar logging estructurado:: 
* Personalización de gestores con dictConfig(): Personalización de gestores con dictConfig. 
* Usar estilos de formato particulares en toda su aplicación:: 
* Configurar filtros con dictConfig(): Configurar filtros con dictConfig. 
* Formato de excepción personalizado:: 
* Mensajes de logging hablantes:: 
* Almacenamiento en búfer de mensajes de logging y su salida condicional:: 
* Enviando mensajes de logging al correo electrónico@comma{} con almacenamiento en búfer: Enviando mensajes de logging al correo electrónico con almacenamiento en búfer. 
* Formateo de horas usando UTC (GMT) a través de la configuración: Formateo de horas usando UTC GMT a través de la configuración. 
* Usar un administrador de contexto para logging selectivo:: 
* Una plantilla de inicio de aplicación CLI:: 
* Una GUI de Qt para logging:: 
* Logging en syslog con soporte RFC5424:: 
* Cómo tratar un logger como una salida stream:: 
* Patrones para evitar:: 
* Otros recursos: Otros recursos<3>. 

Enviar y recibir eventos logging a través de una red

* Ejecutando un logging de socket oyente en producción:: 

Agregar información contextual a su salida de logging

* Uso de LoggerAdapters para impartir información contextual:: 
* Usar filtros para impartir información contextual:: 

Uso de LoggerAdapters para impartir información contextual

* Usar objetos distintos a los diccionarios para transmitir información contextual:: 

Logging a un sólo archivo desde múltiples procesos

* Usando concurrent.futures.ProcessPoolExecutor: Usando concurrent futures ProcessPoolExecutor. 
* Despliegue de aplicaciones web con Gunicorn y uWSGI:: 

Subclassing QueueHandler and QueueListener- a ZeroMQ example

* Subclass QueueHandler:: 
* Subclass QueueListener:: 

Subclassing QueueHandler and QueueListener- a pynng example

* Subclass QueueListener: Subclass QueueListener<2>. 
* Subclass QueueHandler: Subclass QueueHandler<2>. 

Usar estilos de formato particulares en toda su aplicación

* Uso de fábricas de LogRecord:: 
* Usar objetos de mensaje personalizados:: 

Patrones para evitar

* Abrir el mismo archivo de registro varias veces:: 
* Usar registradores como atributos en una clase o pasarlos como parámetros:: 
* Adding handlers other than NullHandler to a logger in a library:: 
* Crear muchos registradores (loggers): Crear muchos registradores loggers. 

Expresiones regulares COMOS (HOWTO)

* Introducción: Introducción<13>. 
* Patrones simples:: 
* Usando expresiones regulares:: 
* Más poder de patrones:: 
* Modificando cadenas de caracteres:: 
* Problemas comunes:: 
* Feedback:: 

Patrones simples

* Coincidencia de caracteres (Matching Characters): Coincidencia de caracteres Matching Characters. 
* Repitiendo cosas:: 

Usando expresiones regulares

* Compilando expresiones regulares:: 
* La plaga de la barra invertida (The Backslash Plague): La plaga de la barra invertida The Backslash Plague. 
* Realizando coincidencias:: 
* Funciones a nivel de módulo: Funciones a nivel de módulo<2>. 
* Los flags de compilación:: 

Más poder de patrones

* Más metacaracteres:: 
* Agrupando:: 
* Grupos con nombre y sin captura:: 
* Aserciones anticipadas:: 

Modificando cadenas de caracteres

* Separando cadenas de caracteres:: 
* Búsqueda y reemplazo:: 

Problemas comunes

* Uso de métodos de cadenas de caracteres:: 
* match() versus search(): match versus search. 
* Codiciosa versus no codiciosa (Greedy versus Non-Greedy): Codiciosa versus no codiciosa Greedy versus Non-Greedy. 
* Usando re.VERBOSE: Usando re VERBOSE. 

HOW TO - Programación con sockets

* Sockets:: 
* Creando un socket:: 
* Usando un socket:: 
* Desconectando:: 
* Sockets no bloqueantes:: 

Sockets

* Historia:: 

Creando un socket

* IPC:: 

Usando un socket

* Datos binarios:: 

Desconectando

* Cuando los sockets mueren:: 

Sorting Techniques

* Conceptos básicos de ordenación:: 
* Funciones clave:: 
* Operator Module Functions and Partial Function Evaluation:: 
* Ascendente y descendente:: 
* Estabilidad de ordenamiento y ordenamientos complejos:: 
* Decorate-Sort-Undecorate:: 
* Funciones de comparación:: 
* Strategies For Unorderable Types and Values:: 
* Curiosidades:: 
* Partial Sorts:: 

CÓMO (HOWTO) Unicode

* Introducción a Unicode:: 
* Soporte Unicode de Python:: 
* Leyendo y escribiendo datos Unicode:: 
* Agradecimientos: Agradecimientos<10>. 

Introducción a Unicode

* Definiciones:: 
* Codificaciones:: 
* Referencias: Referencias<3>. 

Soporte Unicode de Python

* El tipo cadena:: 
* Convirtiendo a Bytes:: 
* Literales Unicode en código fuente Python:: 
* Propiedades Unicode:: 
* Comparando cadenas:: 
* Expresiones regulares Unicode:: 
* Referencias: Referencias<4>. 

Leyendo y escribiendo datos Unicode

* Nombres de archivos Unicode:: 
* Consejos para escribir programas compatibles con Unicode:: 
* Referencias: Referencias<5>. 

Consejos para escribir programas compatibles con Unicode

* Conversión entre codificaciones de archivo:: 
* Archivos en una codificación desconocida:: 

HOWTO - Cómo obtener recursos de Internet con el paquete urllib

* Introducción: Introducción<14>. 
* Obtención de URLs:: 
* Gestión de excepciones:: 
* info y geturl:: 
* Objetos de Apertura (Openers) y Gestores (Handlers): Objetos de Apertura Openers y Gestores Handlers. 
* Autenticación básica:: 
* Proxies:: 
* Sockets y capas:: 
* Notas a pie de página:: 

Obtención de URLs

* Datos:: 
* Encabezados (Headers): Encabezados Headers. 

Gestión de excepciones

* URLError:: 
* HTTPError:: 
* Resumiéndolo:: 

HTTPError

* Códigos de error:: 

Resumiéndolo

* Número 1:: 
* Número 2:: 

Introducción al modulo ipaddress

* Creando objetos Dirección/Red/Interfaz (Address/Network/Interface): Creando objetos Dirección/Red/Interfaz Address/Network/Interface. 
* Inspeccionando objetos Dirección/Red/Interfaz (Address/Network/Interface): Inspeccionando objetos Dirección/Red/Interfaz Address/Network/Interface. 
* Redes como listas de direcciones:: 
* Comparaciones: Comparaciones<4>. 
* Uso de direcciones IP con otros módulos:: 
* Obtener más detalles cuando se produce un error en la creación de instancias:: 

Creando objetos Dirección/Red/Interfaz (Address/Network/Interface)

* Nota sobre versiones IP:: 
* Direcciones IP del Host:: 
* Definiendo redes:: 
* Interfaces de host:: 

Instrumentación de CPython con DTrace y SystemTap

* Habilitando los marcadores estáticos:: 
* Sondas estáticas DTrace:: 
* Marcadores estáticos SystemTap:: 
* Marcadores estáticos disponibles:: 
* SystemTap Tapsets:: 
* Ejemplos: Ejemplos<37>. 

Soporte de Python para el perfilador perf de Linux

* Cómo habilitar el soporte de creación de perfiles perf:: 
* Cómo obtener los mejores resultados:: 
* How to work without frame pointers:: 

Prácticas recomendadas para las anotaciones

* Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.10 y posteriores: Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 10 y posteriores. 
* Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.9 y anteriores: Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 9 y anteriores. 
* Desencadenamiento manual de anotaciones en cadena:: 
* Prácticas recomendadas para __annotations__ en cualquier versión de Python:: 
* Peculiaridades de __annotations__:: 

Aislamiento de módulos de extensión

* ¿Quién debería leer esto?:: 
* Trasfondo:: 
* Cómo hacer que los módulos sean seguros con varios intérpretes:: 
* Tipos Heap: Tipos Heap<2>. 
* Problemas abiertos:: 

Trasfondo

* Ingrese al estado por módulo:: 
* Objetos módulos aislados:: 
* Casos extremos sorprendentes:: 

Cómo hacer que los módulos sean seguros con varios intérpretes

* Administrar el estado global:: 
* Administración del estado por módulo:: 
* Exclusión voluntaria; limitación a un objeto de módulo por proceso: Exclusión voluntaria limitación a un objeto de módulo por proceso. 
* Acceso al estado del módulo desde las funciones:: 

Tipos Heap

* Cambio de tipos estáticos a tipos heap:: 
* Definición de tipos heap:: 
* Protocolo de recolección de basura:: 
* Acceso al estado del módulo desde las clases:: 
* Acceso al estado del módulo desde métodos regulares:: 
* Acceso al estado del módulo desde métodos de Slot@comma{} Getters y Setters: Acceso al estado del módulo desde métodos de Slot Getters y Setters. 
* Vida útil del estado del módulo:: 

Protocolo de recolección de basura

* tp_traverse in Python 3.8 and lower: tp_traverse in Python 3 8 and lower. 
* Delegating tp_traverse:: 
* Defining tp_dealloc:: 
* Not overriding tp_free:: 
* Avoiding PyObject_New:: 

Problemas abiertos

* Alcance por clase:: 
* Conversión sin pérdidas a tipos heap:: 

timer file descriptor HOWTO

* Examples: Examples<3>. 

The Python 2.3 Method Resolution Order

* The beginning:: 
* The C3 Method Resolution Order:: 
* Examples: Examples<4>. 
* Bad Method Resolution Orders:: 
* The end:: 
* Resources:: 

Python experimental support for free threading

* Installation:: 
* Identifying free-threaded Python:: 
* The global interpreter lock in free-threaded Python:: 
* Thread safety:: 
* Known limitations:: 

Known limitations

* Immortalization:: 
* Frame objects:: 
* Iterators:: 
* Single-threaded performance:: 

C API Extension Support for Free Threading

* Identifying the Free-Threaded Build in C:: 
* Module Initialization:: 
* General API Guidelines:: 
* Borrowed References:: 
* Memory Allocation APIs:: 
* Thread State and GIL APIs:: 
* Protecting Internal Extension State:: 
* Building Extensions for the Free-Threaded Build:: 

Module Initialization

* Multi-Phase Initialization:: 
* Single-Phase Initialization:: 

General API Guidelines

* Container Thread Safety:: 

Container Thread Safety

* PyDict_Next:: 

Building Extensions for the Free-Threaded Build

* Limited C API and Stable ABI:: 
* Windows: Windows<73>. 

Preguntas más frecuentes de Python

* Preguntas frecuentes generales sobre Python:: 
* Preguntas frecuentes de programación:: 
* Preguntas frecuentes sobre diseño e historia:: 
* Preguntas frecuentes sobre bibliotecas y extensiones:: 
* Extendiendo/Embebiendo FAQ:: 
* Preguntas frecuentes sobre Python en Windows:: 
* Preguntas frecuentes sobre la Interfaz Gráfica de Usuario (GUI): Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI. 
* «¿Por qué está Python instalado en mi ordenador?» FAQ:: 

Preguntas frecuentes generales sobre Python

* Información general:: 
* Python en el mundo real:: 

Información general

* ¿Qué es Python?:: 
* ¿Que es la Python Software Foundation?:: 
* ¿Hay restricciones de copyright sobre el uso de Python?:: 
* ¿Por qué se creó Python en primer lugar?:: 
* ¿Para qué es bueno Python?:: 
* ¿Cómo funciona el esquema numérico de versiones de Python?:: 
* ¿Cómo obtengo una copia del código fuente de Python?:: 
* ¿Cómo consigo documentación sobre Python?:: 
* Nunca he programado antes. ¿Hay un tutorial de Python?: Nunca he programado antes ¿Hay un tutorial de Python?. 
* ¿Hay un newsgroup o una lista de correo dedicada a Python?:: 
* ¿Cómo obtengo una versión de prueba beta de Python?:: 
* ¿Cómo envío un reporte de bug y parches para Python?:: 
* ¿Hay algún artículo publicado sobre Python que pueda referir?:: 
* ¿Hay libros sobre Python?:: 
* ¿En qué parte del mundo está ubicado www.python.org?: ¿En qué parte del mundo está ubicado www python org?. 
* ¿Por qué se llama Python?:: 
* ¿Debe gustarme «Monty Python’s Flying Circus»?:: 

Python en el mundo real

* ¿Cuán estable es Python?:: 
* ¿Cuánta gente usa Python?:: 
* ¿Hay proyectos significativos hechos con Python?:: 
* ¿Qué nuevos desarrollos se esperan para Python en el futuro?:: 
* ¿Es razonable proponer cambios incompatibles a Python?:: 
* ¿Python es un buen lenguaje para principiantes?:: 

Preguntas frecuentes de programación

* Preguntas generales:: 
* Núcleo del lenguaje:: 
* Números y cadenas:: 
* Rendimiento: Rendimiento<3>. 
* Secuencias (Tuplas/Listas): Secuencias Tuplas/Listas. 
* Objetos:: 
* Módulos: Módulos<5>. 

Preguntas generales

* ¿Existe un depurador a nivel de código fuente con puntos de interrupción@comma{} depuración paso a paso@comma{} etc?: ¿Existe un depurador a nivel de código fuente con puntos de interrupción depuración paso a paso etc?. 
* ¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?:: 
* ¿Cómo puedo crear un binario independiente a partir de un programa Python?:: 
* ¿Existen estándares de código o una guía de estilo para programas Python?:: 

Núcleo del lenguaje

* ¿Por qué obtengo un UnboundLocalError cuando la variable tiene un valor?:: 
* ¿Cuáles son las reglas para las variables locales y globales en Python?:: 
* ¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?:: 
* ¿Cómo puedo compartir variables globales entre módulos?:: 
* ¿Cuáles son las «buenas prácticas» para usar import en un módulo?:: 
* ¿Por qué los valores por defecto se comparten entre objetos?:: 
* ¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?:: 
* ¿Cuál es la diferencia entre argumentos y parámetros?:: 
* ¿Por qué cambiando la lista “y” cambia@comma{} también@comma{} la lista “x”?: ¿Por qué cambiando la lista “y” cambia también la lista “x”?. 
* ¿Cómo puedo escribir una función sin parámetros (invocación mediante referencia)?: ¿Cómo puedo escribir una función sin parámetros invocación mediante referencia ?. 
* ¿Cómo se puede hacer una función de orden superior en Python?:: 
* ¿Cómo copio un objeto en Python?:: 
* ¿Cómo puedo encontrar los métodos o atributos de un objeto?:: 
* ¿Cómo puede mi código descubrir el nombre de un objeto?:: 
* ¿Qué ocurre con la precedencia del operador coma?:: 
* ¿Existe un equivalente al operador ternario de C «?;»?: ¿Existe un equivalente al operador ternario de C «? »?. 
* ¿Es posible escribir expresiones en una línea de forma ofuscada en Python?:: 
* ¿Qué hace la barra (/) en medio de la lista de parámetros de una función?: ¿Qué hace la barra / en medio de la lista de parámetros de una función?. 

Números y cadenas

* ¿Cómo puedo especificar enteros hexadecimales y octales?:: 
* ¿Por qué -22 // 10 devuelve -3?:: 
* ¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?:: 
* ¿Cómo convierto una cadena a un número?:: 
* ¿Cómo puedo convertir un número a una cadena?:: 
* ¿Cómo puedo modificar una cadena in situ?:: 
* ¿Cómo puedo usar cadenas para invocar funciones/métodos?:: 
* ¿Existe un equivalente a chomp() en Perl para eliminar nuevas líneas al final de las cadenas?: ¿Existe un equivalente a chomp en Perl para eliminar nuevas líneas al final de las cadenas?. 
* ¿Existe un equivalente a scanf() o a sscanf() ?: ¿Existe un equivalente a scanf o a sscanf ?. 
* ¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?:: 
* Can I end a raw string with an odd number of backslashes?:: 

Rendimiento

* Mi programa es muy lento. ¿Cómo puedo acelerarlo?: Mi programa es muy lento ¿Cómo puedo acelerarlo?. 
* ¿Cuál es la forma más eficiente de concatenar muchas cadenas conjuntamente?:: 

Secuencias (Tuplas/Listas)

* ¿Cómo convertir entre tuplas y listas?:: 
* ¿Qué es un índice negativo?:: 
* ¿Cómo puedo iterar sobre una secuencia en orden inverso?:: 
* ¿Cómo eliminar duplicados de una lista?:: 
* Cómo eliminar duplicados de una lista:: 
* ¿Cómo se puede hacer un array en Python?:: 
* ¿Cómo puedo crear una lista multidimensional?:: 
* How do I apply a method or function to a sequence of objects?:: 
* ¿Por qué hacer lo siguiente@comma{} a_tuple[i] += ['item']@comma{} lanza una excepción cuando la suma funciona?: ¿Por qué hacer lo siguiente a_tuple[i] += ['item'] lanza una excepción cuando la suma funciona?. 
* Quiero hacer una ordenación compleja; ¿Puedes hacer una transformada Schwartziana (Schwartzian Transform) en Python?: Quiero hacer una ordenación compleja ¿Puedes hacer una transformada Schwartziana Schwartzian Transform en Python?. 
* ¿Cómo puedo ordenar una lista a partir de valores de otra lista?:: 

Objetos

* ¿Qué es una clase?:: 
* ¿Qué es un método?:: 
* ¿Qué es self?:: 
* ¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?:: 
* ¿Qué es la delegación?:: 
* ¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?:: 
* ¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?:: 
* ¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?:: 
* ¿Como puedo sobrecargar constructores (o métodos) en Python?: ¿Como puedo sobrecargar constructores o métodos en Python?. 
* Intento usar __spam y obtengo un error sobre _SomeClassName__spam.: Intento usar __spam y obtengo un error sobre _SomeClassName__spam. 
* Mi clase define __del__ pero no se le invoca cuando borro el objeto.: Mi clase define __del__ pero no se le invoca cuando borro el objeto. 
* ¿Cómo puedo obtener una lista de todas las instancias de una clase dada?:: 
* ¿Por qué el resultado de id() no parece ser único?: ¿Por qué el resultado de id no parece ser único?. 
* ¿Cuándo puedo fiarme de pruebas de identidad con el operador is?:: 
* ¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?:: 
* ¿Cómo cacheo llamadas de método?:: 

Módulos

* ¿Cómo creo un fichero .pyc?: ¿Cómo creo un fichero pyc?. 
* ¿Cómo puedo encontrar el nombre del módulo en uso?:: 
* ¿Cómo podría tener módulos que se importan mutuamente entre ellos?:: 
* __import__(“x.y.z”) devuelve <module “x”>; ¿cómo puedo obtener z?: __import__ “x y z” devuelve <module “x”>; ¿cómo puedo obtener z?. 
* Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto. ¿Por qué sucede esto?: Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto ¿Por qué sucede esto?. 

Preguntas frecuentes sobre diseño e historia

* ¿Por qué Python usa indentación para agrupar declaraciones?:: 
* ¿Por qué obtengo resultados extraños con operaciones aritméticas simples?:: 
* ¿Por qué los cálculos de punto flotante son tan inexactos?:: 
* ¿Por qué las cadenas de caracteres de Python son inmutables?:: 
* ¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?:: 
* ¿Por qué no puedo usar una tarea en una expresión?:: 
* ¿Por qué Python usa métodos para alguna funcionalidad (por ejemplo@comma{} list.index()) pero funciones para otra (por ejemplo@comma{} len(list))?: ¿Por qué Python usa métodos para alguna funcionalidad por ejemplo list index pero funciones para otra por ejemplo len list ?. 
* ¿Por qué join() es un método de cadena de caracteres en lugar de un método de lista o tupla?: ¿Por qué join es un método de cadena de caracteres en lugar de un método de lista o tupla?. 
* ¿Qué tan rápido van las excepciones?:: 
* ¿Por qué no hay un switch o una declaración case en Python?:: 
* ¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?:: 
* ¿Por qué las expresiones lambda no pueden contener sentencias?:: 
* ¿Se puede compilar Python en código máquina@comma{} C o algún otro lenguaje?: ¿Se puede compilar Python en código máquina C o algún otro lenguaje?. 
* ¿Cómo gestiona Python la memoria?:: 
* ¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?:: 
* ¿Por qué no se libera toda la memoria cuando sale CPython?:: 
* ¿Por qué hay tipos de datos separados de tuplas y listas?:: 
* ¿Cómo se implementan las listas en Python?:: 
* ¿Cómo se implementan los diccionarios en CPython?:: 
* ¿Por qué las claves del diccionario deben ser inmutables?:: 
* ¿Por qué list.sort() no retorna la lista ordenada?: ¿Por qué list sort no retorna la lista ordenada?. 
* ¿Cómo se especifica y aplica una especificación de interfaz en Python?:: 
* ¿Por qué no hay goto?:: 
* ¿Por qué las cadenas de caracteres sin formato (r-strings) no pueden terminar con una barra diagonal inversa?: ¿Por qué las cadenas de caracteres sin formato r-strings no pueden terminar con una barra diagonal inversa?. 
* ¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?:: 
* ¿Por qué los generadores no admiten la declaración with?:: 
* ¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?:: 
* ¿Por qué Python permite comas al final de las listas y tuplas?:: 

Preguntas frecuentes sobre bibliotecas y extensiones

* Cuestiones generales sobre bibliotecas:: 
* Tareas comunes:: 
* Hilos:: 
* Entrada y salida: Entrada y salida<2>. 
* Programación de Redes/Internet:: 
* Bases de datos:: 
* Matemáticas y numérica:: 

Cuestiones generales sobre bibliotecas

* ¿Cómo encuentro un módulo o aplicación para ejecutar la tarea X?:: 
* ¿Dónde está el fichero fuente math.py (socket.py@comma{} regex.py@comma{} etc.)?: ¿Dónde está el fichero fuente math py socket py regex py etc ?. 
* ¿Cómo hago ejecutable un script Python en Unix?:: 
* ¿Hay un paquete curses/termcap para Python?:: 
* ¿Hay un equivalente en Python al onexit() de C?: ¿Hay un equivalente en Python al onexit de C?. 
* ¿Por qué no funcionan mis manejadores de señales?:: 

Tareas comunes

* ¿Cómo pruebo un programa o un componente Python?:: 
* ¿Cómo creo documentación a partir de los docstrings?:: 
* ¿Cómo consigo presionar una única tecla cada vez?:: 

Hilos

* ¿Cómo programo usando hilos?:: 
* Ninguno de mis hilos parece funcionar; ¿por qué?: Ninguno de mis hilos parece funcionar ¿por qué?. 
* ¿Cómo puedo dividir trabajo entre un grupo de hilos?:: 
* ¿Qué tipos de mutación de valores globales son thread-safe?:: 
* ¿Podemos deshacernos del Global Interpreter Lock?:: 

Entrada y salida

* ¿Cómo borro un fichero? (Y otras preguntas sobre ficheros…): ¿Cómo borro un fichero? Y otras preguntas sobre ficheros…. 
* ¿Cómo copio un fichero?:: 
* ¿Cómo leo (o escribo) datos binarios?: ¿Cómo leo o escribo datos binarios?. 
* No consigo usar os.read() en un pipe creado con os.popen(); ¿por qué?: No consigo usar os read en un pipe creado con os popen ; ¿por qué?. 
* ¿Cómo accedo al puerto serial (RS232)?: ¿Cómo accedo al puerto serial RS232 ?. 
* ¿Por qué al cerrar sys.stdout (stdin@comma{} stderr) realmente no se cierran?: ¿Por qué al cerrar sys stdout stdin stderr realmente no se cierran?. 

Programación de Redes/Internet

* ¿Qué herramientas de Python existen para WWW?:: 
* ¿Qué modulo debería usar para generación de HTML?:: 
* ¿Cómo envío correo desde un script Python?:: 
* ¿Cómo evito el bloqueo en el método connect() de un socket?: ¿Cómo evito el bloqueo en el método connect de un socket?. 

Bases de datos

* ¿Hay paquetes para interfaces a bases de datos en Python?:: 
* ¿Cómo implementar objetos persistentes en Python?:: 

Matemáticas y numérica

* ¿Cómo genero números aleatorios en Python?:: 

Extendiendo/Embebiendo FAQ

* ¿Puedo crear mis propias funciones en C?:: 
* ¿Puedo crear mis propias funciones en C++?:: 
* Escribir en C es difícil; ¿no hay otra alternativa?:: 
* ¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?:: 
* ¿Cómo puedo evaluar una expresión arbitraria de Python desde C?:: 
* ¿Cómo extraigo valores C de un objeto Python?:: 
* ¿Cómo utilizo Py_BuildValue() para crear una tupla de un tamaño arbitrario?: ¿Cómo utilizo Py_BuildValue para crear una tupla de un tamaño arbitrario?. 
* ¿Cómo puedo llamar un método de un objeto desde C?:: 
* ¿Cómo obtengo la salida de PyErr_Print() (o cualquier cosa que se imprime a stdout/stderr)?: ¿Cómo obtengo la salida de PyErr_Print o cualquier cosa que se imprime a stdout/stderr ?. 
* ¿Cómo accedo al módulo escrito en Python desde C?:: 
* ¿Cómo hago una interface a objetos C++ desde Python?:: 
* He agregado un módulo usando el archivo de configuración y el make falla. ¿Porque?: He agregado un módulo usando el archivo de configuración y el make falla ¿Porque?. 
* ¿Cómo puedo depurar una extensión?:: 
* Quiero compilar un módulo Python en mi sistema Linux@comma{} pero me faltan algunos archivos . ¿Por qué?: Quiero compilar un módulo Python en mi sistema Linux pero me faltan algunos archivos ¿Por qué?. 
* ¿Cómo digo «entrada incompleta» desde «entrada inválida»?:: 
* ¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?:: 
* ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python (por ejemplo a través de la herencia)?: ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python por ejemplo a través de la herencia ?. 

Preguntas frecuentes sobre Python en Windows

* ¿Cómo ejecutar un programa Python en Windows?:: 
* ¿Cómo hacer que los scripts de Python sean ejecutables?:: 
* ¿Por qué Python tarda en comenzar?:: 
* ¿Cómo hacer un ejecutable a partir de un script de Python?:: 
* ¿Es un archivo *.pyd lo mismo que una DLL?: ¿Es un archivo * pyd lo mismo que una DLL?. 
* ¿Cómo puedo integrar Python en una aplicación de Windows?:: 
* ¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?:: 
* ¿Cómo verifico una pulsación de tecla sin bloquearla?:: 
* ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0.dll no encontrado?: ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0 dll no encontrado?. 

Preguntas frecuentes sobre la Interfaz Gráfica de Usuario (GUI)

* Preguntas generales de la GUI:: 
* ¿Qué conjuntos de herramientas de GUI existen para Python?:: 
* Preguntas de Tkinter:: 

Preguntas de Tkinter

* ¿Cómo congelo las aplicaciones de Tkinter?:: 
* ¿Puedo tener eventos Tk manejados mientras espero por I/O?:: 
* No puedo hacer que los atajos de teclado funcionen en Tkinter; ¿por qué?: No puedo hacer que los atajos de teclado funcionen en Tkinter ¿por qué?. 

«¿Por qué está Python instalado en mi ordenador?» FAQ

* ¿Qué es Python?: ¿Qué es Python?<2>. 
* ¿Por qué Python está instalado en mi máquina?:: 
* ¿Puedo eliminar Python?:: 

Deprecations

* Pending removal in Python 3.15: Pending removal in Python 3 15<7>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<4>. 
* Pending removal in future versions: Pending removal in future versions<7>. 
* C API deprecations:: 

C API deprecations

* Pending removal in Python 3.15: Pending removal in Python 3 15<8>. 
* Pending removal in future versions: Pending removal in future versions<8>. 

Acerca de estos documentos

* Contribuidores de la documentación de Python:: 

Lidiar con errores

* Documentación de errores:: 
* Utilizar el issue tracker de Python:: 
* Para empezar a contribuir en Python:: 

Historia y Licencia

* Historia del software:: 
* Términos y condiciones para acceder o usar Python:: 
* Licencias y reconocimientos para software incorporado:: 

Términos y condiciones para acceder o usar Python

* ACUERDO DE LICENCIA DE PSF PARA PYTHON | lanzamiento |:: 
* ACUERDO DE LICENCIA DE BEOPEN.COM PARA PYTHON 2.0: ACUERDO DE LICENCIA DE BEOPEN COM PARA PYTHON 2 0. 
* ACUERDO DE LICENCIA CNRI PARA PYTHON 1.6.1: ACUERDO DE LICENCIA CNRI PARA PYTHON 1 6 1. 
* ACUERDO DE LICENCIA CWI PARA PYTHON 0.9.0 HASTA 1.2: ACUERDO DE LICENCIA CWI PARA PYTHON 0 9 0 HASTA 1 2. 
* LICENCIA BSD DE CLÁUSULA CERO PARA CÓDIGO EN EL PYTHON | lanzamiento | DOCUMENTACIÓN:: 

Licencias y reconocimientos para software incorporado

* Mersenne Twister:: 
* Sockets: Sockets<2>. 
* Servicios de socket asincrónicos:: 
* Gestión de cookies:: 
* Seguimiento de ejecución:: 
* funciones UUencode y UUdecode:: 
* Llamadas a procedimientos remotos XML:: 
* test_epoll:: 
* Seleccionar kqueue:: 
* SipHash24:: 
* strtod y dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<3>. 
* cfuhash:: 
* libmpdec:: 
* Conjunto de pruebas W3C C14N:: 
* mimalloc:: 
* asyncio: asyncio<12>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 

@end detailmenu
@end menu

@node Qué hay de nuevo en Python,El tutorial de Python,Top,Top
@anchor{whatsnew/index doc}@anchor{135}@anchor{whatsnew/index python-documentation-contents}@anchor{136}@anchor{whatsnew/index what-s-new-in-python}@anchor{137}@anchor{whatsnew/index whatsnew-index}@anchor{138}
@chapter Qué hay de nuevo en Python


La serie «Qué hay de nuevo en Python» da un vistazo a los cambios más importantes entre las versiones de Python. Son de «lectura obligatoria» para cualquier persona que quiera estar al día después de un nuevo lanzamiento.

@menu
* What’s new in Python 3.14: What’s new in Python 3 14. 
* What’s New In Python 3.13: What’s New In Python 3 13. 
* Novedades de Python 3.12: Novedades de Python 3 12. 
* Qué hay de nuevo en Python 3.11: Qué hay de nuevo en Python 3 11. 
* Qué hay de nuevo en Python 3.10: Qué hay de nuevo en Python 3 10. 
* Qué hay de nuevo en Python 3.9: Qué hay de nuevo en Python 3 9. 
* Qué hay de nuevo en Python 3.8: Qué hay de nuevo en Python 3 8. 
* Qué hay de nuevo en Python 3.7: Qué hay de nuevo en Python 3 7. 
* Qué hay de nuevo en Python 3.6: Qué hay de nuevo en Python 3 6. 
* Qué hay de nuevo en Python 3.5: Qué hay de nuevo en Python 3 5. 
* Qué hay de nuevo en Python 3.4: Qué hay de nuevo en Python 3 4. 
* Qué hay de nuevo en Python 3.3: Qué hay de nuevo en Python 3 3. 
* Qué hay de nuevo en Python 3.2: Qué hay de nuevo en Python 3 2. 
* Qué hay de nuevo en Python 3.1: Qué hay de nuevo en Python 3 1. 
* Qué hay de nuevo en Python 3.0: Qué hay de nuevo en Python 3 0. 
* Qué hay de nuevo en Python 2.7: Qué hay de nuevo en Python 2 7. 
* Qué hay de nuevo en Python 2.6: Qué hay de nuevo en Python 2 6. 
* Qué hay de nuevo en Python 2.5: Qué hay de nuevo en Python 2 5. 
* Qué hay de nuevo en Python 2.4: Qué hay de nuevo en Python 2 4. 
* Qué hay de nuevo en Python 2.3: Qué hay de nuevo en Python 2 3. 
* Qué hay de nuevo en Python 2.2: Qué hay de nuevo en Python 2 2. 
* Qué hay de nuevo en Python 2.1: Qué hay de nuevo en Python 2 1. 
* Qué hay de nuevo en Python 2.0: Qué hay de nuevo en Python 2 0. 
* Registro de cambios:: 

@end menu

@node What’s new in Python 3 14,What’s New In Python 3 13,,Qué hay de nuevo en Python
@anchor{whatsnew/3 14 doc}@anchor{139}@anchor{whatsnew/3 14 what-s-new-in-python-3-14}@anchor{13a}
@section What’s new in Python 3.14


@*Editor: 
TBD


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log
@c when researching a change.

This article explains the new features in Python 3.14, compared to 3.13.

For full details, see the @ref{13b,,changelog}.

@cartouche
@quotation Nota 
Prerelease users should be aware that this document is currently in draft
form. It will be updated substantially as Python 3.14 moves towards release,
so it’s worth checking back even after reading earlier versions.
@end quotation
@end cartouche

@menu
* Summary – release highlights:: 
* New features:: 
* Other language changes:: 
* New modules:: 
* Improved modules:: 
* Optimizations:: 
* Deprecated:: 
* Removed:: 
* Porting to Python 3.14: Porting to Python 3 14. 
* Build changes:: 
* C API changes:: 

@end menu

@node Summary – release highlights,New features,,What’s new in Python 3 14
@anchor{whatsnew/3 14 summary-release-highlights}@anchor{13c}
@subsection Summary – release highlights


@c This section singles out the most important changes in Python 3.14.
@c Brevity is key.

@c PEP-sized items next.

@node New features,Other language changes,Summary – release highlights,What’s new in Python 3 14
@anchor{whatsnew/3 14 new-features}@anchor{13d}
@subsection New features


@menu
* PEP 649; deferred evaluation of annotations: PEP 649 deferred evaluation of annotations. 
* Improved error messages:: 

@end menu

@node PEP 649 deferred evaluation of annotations,Improved error messages,,New features
@anchor{whatsnew/3 14 pep-649-deferred-evaluation-of-annotations}@anchor{13e}@anchor{whatsnew/3 14 whatsnew314-pep649}@anchor{13f}
@subsubsection PEP 649: deferred evaluation of annotations


The @ref{140,,annotations} on functions, classes, and modules are no
longer evaluated eagerly. Instead, annotations are stored in special-purpose
@ref{141,,annotate functions} and evaluated only when
necessary. This is specified in 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} and 
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}.

This change is designed to make annotations in Python more performant and more
usable in most circumstances. The runtime cost for defining annotations is
minimized, but it remains possible to introspect annotations at runtime.
It is usually no longer necessary to enclose annotations in strings if they
contain forward references.

The new @ref{6,,annotationlib} module provides tools for inspecting deferred
annotations. Annotations may be evaluated in the @ref{142,,VALUE}
format (which evaluates annotations to runtime values, similar to the behavior in
earlier Python versions), the @ref{143,,FORWARDREF} format
(which replaces undefined names with special markers), and the
@ref{144,,STRING} format (which returns annotations as strings).

This example shows how these formats behave:

@example
>>> from annotationlib import get_annotations, Format
>>> def func(arg: Undefined):
...     pass
>>> get_annotations(func, format=Format.VALUE)
Traceback (most recent call last):
  ...
NameError: name 'Undefined' is not defined
>>> get_annotations(func, format=Format.FORWARDREF)
@{'arg': ForwardRef('Undefined')@}
>>> get_annotations(func, format=Format.STRING)
@{'arg': 'Undefined'@}
@end example

@menu
* Implications for annotated code:: 
* Implications for readers of __annotations__:: 
* Related changes:: 
* from __future__ import annotations:: 

@end menu

@node Implications for annotated code,Implications for readers of __annotations__,,PEP 649 deferred evaluation of annotations
@anchor{whatsnew/3 14 implications-for-annotated-code}@anchor{145}
@subsubsection Implications for annotated code


If you define annotations in your code (for example, for use with a static type
checker), then this change probably does not affect you: you can keep
writing annotations the same way you did with previous versions of Python.

You will likely be able to remove quoted strings in annotations, which are frequently
used for forward references. Similarly, if you use @code{from __future__ import annotations}
to avoid having to write strings in annotations, you may well be able to
remove that import. However, if you rely on third-party libraries that read annotations,
those libraries may need changes to support unquoted annotations before they
work as expected.

@node Implications for readers of __annotations__,Related changes,Implications for annotated code,PEP 649 deferred evaluation of annotations
@anchor{whatsnew/3 14 implications-for-readers-of-annotations}@anchor{146}
@subsubsection Implications for readers of @code{__annotations__}


If your code reads the @code{__annotations__} attribute on objects, you may want
to make changes in order to support code that relies on deferred evaluation of
annotations. For example, you may want to use @ref{147,,annotationlib.get_annotations()}
with the @ref{143,,FORWARDREF} format, as the @ref{30,,dataclasses}
module now does.

@node Related changes,from __future__ import annotations,Implications for readers of __annotations__,PEP 649 deferred evaluation of annotations
@anchor{whatsnew/3 14 related-changes}@anchor{148}
@subsubsection Related changes


The changes in Python 3.14 are designed to rework how @code{__annotations__}
works at runtime while minimizing breakage to code that contains
annotations in source code and to code that reads @code{__annotations__}. However,
if you rely on undocumented details of the annotation behavior or on private
functions in the standard library, there are many ways in which your code may
not work in Python 3.14. To safeguard your code against future changes,
use only the documented functionality of the @ref{6,,annotationlib} module.

@node from __future__ import annotations,,Related changes,PEP 649 deferred evaluation of annotations
@anchor{whatsnew/3 14 from-future-import-annotations}@anchor{149}
@subsubsection @code{from __future__ import annotations}


In Python 3.7, 
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} introduced the @code{from __future__ import annotations}
directive, which turns all annotations into strings. This directive is now
considered deprecated and it is expected to be removed in a future version of Python.
However, this removal will not happen until after Python 3.13, the last version of
Python without deferred evaluation of annotations, reaches its end of life in 2029.
In Python 3.14, the behavior of code using @code{from __future__ import annotations}
is unchanged.

@node Improved error messages,,PEP 649 deferred evaluation of annotations,New features
@anchor{whatsnew/3 14 improved-error-messages}@anchor{14a}
@subsubsection Improved error messages



@itemize *

@item 
When unpacking assignment fails due to incorrect number of variables, the
error message prints the received number of values in more cases than before.
(Contributed by Tushar Sadhwani in gh-122239@footnote{https://github.com/python/cpython/issues/122239}.)

@example
>>> x, y, z = 1, 2, 3, 4
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    x, y, z = 1, 2, 3, 4
    ^^^^^^^
ValueError: too many values to unpack (expected 3, got 4)
@end example
@end itemize

@node Other language changes,New modules,New features,What’s new in Python 3 14
@anchor{whatsnew/3 14 other-language-changes}@anchor{14b}
@subsection Other language changes



@itemize *

@item 
The @ref{14c,,map()} built-in now has an optional keyword-only `strict' flag
like @ref{14d,,zip()} to check that all the iterables are of equal length.
(Contributed by Wannes Boeykens in gh-119793@footnote{https://github.com/python/cpython/issues/119793}.)

@item 
Incorrect usage of @ref{14e,,await} and asynchronous comprehensions
is now detected even if the code is optimized away by the @ref{14f,,-O}
command-line option. For example, @code{python -O -c 'assert await 1'}
now produces a @ref{150,,SyntaxError}. (Contributed by Jelle Zijlstra in gh-121637@footnote{https://github.com/python/cpython/issues/121637}.)

@item 
Writes to @code{__debug__} are now detected even if the code is optimized
away by the @ref{14f,,-O} command-line option. For example,
@code{python -O -c 'assert (__debug__ := 1)'} now produces a
@ref{150,,SyntaxError}. (Contributed by Irit Katriel in gh-122245@footnote{https://github.com/python/cpython/issues/122245}.)

@item 
Add class methods @ref{151,,float.from_number()} and @ref{152,,complex.from_number()}
to convert a number to @ref{153,,float} or @ref{154,,complex} type correspondingly.
They raise an error if the argument is a string.
(Contributed by Serhiy Storchaka in gh-84978@footnote{https://github.com/python/cpython/issues/84978}.)

@item 
@ref{155,,super} objects are now @ref{a6,,pickleable} and
@ref{26,,copyable}.
(Contributed by Serhiy Storchaka in gh-125767@footnote{https://github.com/python/cpython/issues/125767}.)

@item 
The @ref{156,,memoryview} type now supports subscription,
making it a @ref{157,,generic type}.
(Contributed by Brian Schubert in gh-126012@footnote{https://github.com/python/cpython/issues/126012}.)
@end itemize

@node New modules,Improved modules,Other language changes,What’s new in Python 3 14
@anchor{whatsnew/3 14 new-modules}@anchor{158}
@subsection New modules



@itemize *

@item 
@ref{6,,annotationlib}: For introspecting @ref{140,,annotations}.
See 
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} for more details.
(Contributed by Jelle Zijlstra in gh-119180@footnote{https://github.com/python/cpython/issues/119180}.)
@end itemize

@node Improved modules,Optimizations,New modules,What’s new in Python 3 14
@anchor{whatsnew/3 14 improved-modules}@anchor{159}
@subsection Improved modules


@menu
* argparse:: 
* ast:: 
* concurrent.futures: concurrent futures. 
* ctypes:: 
* decimal:: 
* datetime:: 
* dis:: 
* fractions:: 
* functools:: 
* getopt:: 
* http:: 
* inspect:: 
* json:: 
* mimetypes:: 
* multiprocessing:: 
* operator:: 
* os:: 
* pathlib:: 
* platform:: 
* pdb:: 
* pickle:: 
* pydoc:: 
* symtable:: 
* sys:: 
* unicodedata:: 
* unittest:: 
* uuid:: 

@end menu

@node argparse,ast,,Improved modules
@anchor{whatsnew/3 14 argparse}@anchor{15a}
@subsubsection argparse



@itemize *

@item 
The default value of the @ref{15b,,program name} for
@ref{15c,,argparse.ArgumentParser} now reflects the way the Python
interpreter was instructed to find the @code{__main__} module code.
(Contributed by Serhiy Storchaka and Alyssa Coghlan in gh-66436@footnote{https://github.com/python/cpython/issues/66436}.)

@item 
Introduced the optional `suggest_on_error' parameter to
@ref{15c,,argparse.ArgumentParser}, enabling suggestions for argument choices
and subparser names if mistyped by the user.
(Contributed by Savannah Ostrowski in gh-124456@footnote{https://github.com/python/cpython/issues/124456})
@end itemize

@node ast,concurrent futures,argparse,Improved modules
@anchor{whatsnew/3 14 ast}@anchor{15d}
@subsubsection ast



@itemize *

@item 
Add @ref{15e,,ast.compare()} for comparing two ASTs.
(Contributed by Batuhan Taskaya and Jeremy Hylton in gh-60191@footnote{https://github.com/python/cpython/issues/60191}.)

@item 
Add support for @ref{15f,,copy.replace()} for AST nodes.
(Contributed by Bénédikt Tran in gh-121141@footnote{https://github.com/python/cpython/issues/121141}.)

@item 
Docstrings are now removed from an optimized AST in optimization level 2.
(Contributed by Irit Katriel in gh-123958@footnote{https://github.com/python/cpython/issues/123958}.)

@item 
The @code{repr()} output for AST nodes now includes more information.
(Contributed by Tomas R in gh-116022@footnote{https://github.com/python/cpython/issues/116022}.)
@end itemize

@node concurrent futures,ctypes,ast,Improved modules
@anchor{whatsnew/3 14 concurrent-futures}@anchor{160}
@subsubsection concurrent.futures



@itemize *

@item 
Add @ref{161,,InterpreterPoolExecutor},
which exposes «subinterpreters (multiple Python interpreters in the
same process) to Python code.  This is separate from the proposed API
in 
@geindex Python Enhancement Proposals; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}.
(Contributed by Eric Snow in gh-124548@footnote{https://github.com/python/cpython/issues/124548}.)

@item 
The default @code{ProcessPoolExecutor} start method (see
@ref{162,,Contextos y métodos de inicio}) changed from `fork' to `forkserver' on
platforms other than macOS & Windows. If you require the threading
incompatible `fork' start method you must explicitly request it by
supplying a `mp_context' to @ref{163,,concurrent.futures.ProcessPoolExecutor}.
(Contributed by Gregory P.  Smith in gh-84559@footnote{https://github.com/python/cpython/issues/84559}.)
@end itemize

@node ctypes,decimal,concurrent futures,Improved modules
@anchor{whatsnew/3 14 ctypes}@anchor{164}
@subsubsection ctypes



@itemize *

@item 
The layout of @ref{165,,bit fields}
in @ref{166,,Structure} and @ref{167,,Union}
now matches platform defaults (GCC/Clang or MVSC) more closely.
In particular, fields no longer overlap.
(Contributed by Matthias Görgens in gh-97702@footnote{https://github.com/python/cpython/issues/97702}.)

@item 
The @ref{168,,Structure._layout_} class attribute can now be set
to help match a non-default ABI.
(Contributed by Petr Viktorin in gh-97702@footnote{https://github.com/python/cpython/issues/97702}.)
@end itemize

@node decimal,datetime,ctypes,Improved modules
@anchor{whatsnew/3 14 decimal}@anchor{169}
@subsubsection decimal



@itemize *

@item 
Add alternative @ref{16a,,Decimal} constructor
@ref{16b,,Decimal.from_number()}.
(Contributed by Serhiy Storchaka in gh-121798@footnote{https://github.com/python/cpython/issues/121798}.)
@end itemize

@node datetime,dis,decimal,Improved modules
@anchor{whatsnew/3 14 datetime}@anchor{16c}
@subsubsection datetime



@itemize *

@item 
Add @ref{16d,,datetime.time.strptime()} and @ref{16e,,datetime.date.strptime()}.
(Contributed by Wannes Boeykens in gh-41431@footnote{https://github.com/python/cpython/issues/41431}.)
@end itemize

@node dis,fractions,datetime,Improved modules
@anchor{whatsnew/3 14 dis}@anchor{16f}
@subsubsection dis



@itemize *

@item 
Add support for rendering full source location information of
@ref{170,,instructions}, rather than only the line number.
This feature is added to the following interfaces via the `show_positions'
keyword argument:


@itemize -

@item 
@ref{171,,dis.Bytecode}

@item 
@ref{172,,dis.dis()}

@item 
@ref{173,,dis.distb()}

@item 
@ref{174,,dis.disassemble()}
@end itemize

This feature is also exposed via @ref{175,,dis --show-positions}.
(Contributed by Bénédikt Tran in gh-123165@footnote{https://github.com/python/cpython/issues/123165}.)
@end itemize

@node fractions,functools,dis,Improved modules
@anchor{whatsnew/3 14 fractions}@anchor{176}
@subsubsection fractions



@itemize *

@item 
Add support for converting any objects that have the
@code{as_integer_ratio()} method to a @ref{177,,Fraction}.
(Contributed by Serhiy Storchaka in gh-82017@footnote{https://github.com/python/cpython/issues/82017}.)

@item 
Add alternative @ref{177,,Fraction} constructor
@ref{178,,Fraction.from_number()}.
(Contributed by Serhiy Storchaka in gh-121797@footnote{https://github.com/python/cpython/issues/121797}.)
@end itemize

@node functools,getopt,fractions,Improved modules
@anchor{whatsnew/3 14 functools}@anchor{179}
@subsubsection functools



@itemize *

@item 
Add support to @ref{17a,,functools.partial()} and
@ref{17b,,functools.partialmethod()} for @ref{17c,,functools.Placeholder} sentinels
to reserve a place for positional arguments.
(Contributed by Dominykas Grigonis in gh-119127@footnote{https://github.com/python/cpython/issues/119127}.)

@item 
Allow the `initial' parameter of @ref{17d,,functools.reduce()} to be passed
as a keyword argument.
(Contributed by Sayandip Dutta in gh-125916@footnote{https://github.com/python/cpython/issues/125916}.)
@end itemize

@node getopt,http,functools,Improved modules
@anchor{whatsnew/3 14 getopt}@anchor{17e}
@subsubsection getopt



@itemize *

@item 
Add support for options with optional arguments.
(Contributed by Serhiy Storchaka in gh-126374@footnote{https://github.com/python/cpython/issues/126374}.)

@item 
Add support for returning intermixed options and non-option arguments in order.
(Contributed by Serhiy Storchaka in gh-126390@footnote{https://github.com/python/cpython/issues/126390}.)
@end itemize

@node http,inspect,getopt,Improved modules
@anchor{whatsnew/3 14 http}@anchor{17f}
@subsubsection http



@itemize *

@item 
Directory lists and error pages generated by the @ref{72,,http.server}
module allow the browser to apply its default dark mode.
(Contributed by Yorik Hansen in gh-123430@footnote{https://github.com/python/cpython/issues/123430}.)
@end itemize

@node inspect,json,http,Improved modules
@anchor{whatsnew/3 14 inspect}@anchor{180}
@subsubsection inspect



@itemize *

@item 
@ref{181,,inspect.signature()} takes a new argument `annotation_format' to control
the @ref{182,,annotationlib.Format} used for representing annotations.
(Contributed by Jelle Zijlstra in gh-101552@footnote{https://github.com/python/cpython/issues/101552}.)

@item 
@ref{183,,inspect.Signature.format()} takes a new argument `unquote_annotations'.
If true, string @ref{140,,annotations} are displayed without surrounding quotes.
(Contributed by Jelle Zijlstra in gh-101552@footnote{https://github.com/python/cpython/issues/101552}.)

@item 
Add function @ref{184,,inspect.ispackage()} to determine whether an object is a
@ref{185,,package} or not.
(Contributed by Zhikang Yan in gh-125634@footnote{https://github.com/python/cpython/issues/125634}.)
@end itemize

@node json,mimetypes,inspect,Improved modules
@anchor{whatsnew/3 14 json}@anchor{186}
@subsubsection json



@itemize *

@item 
Add notes for JSON serialization errors that allow to identify the source
of the error.
(Contributed by Serhiy Storchaka in gh-122163@footnote{https://github.com/python/cpython/issues/122163}.)

@item 
Enable the @ref{82,,json} module to work as a script using the @ref{187,,-m}
switch: @code{python -m json}.
See the @ref{188,,JSON command-line interface} documentation.
(Contributed by Trey Hunner in gh-122873@footnote{https://github.com/python/cpython/issues/122873}.)
@end itemize

@node mimetypes,multiprocessing,json,Improved modules
@anchor{whatsnew/3 14 mimetypes}@anchor{189}
@subsubsection mimetypes



@itemize *

@item 
Add MS and 
@geindex RFC; RFC 8081
RFC 8081@footnote{https://datatracker.ietf.org/doc/html/rfc8081.html} MIME types for fonts:


@itemize *

@item 
Embedded OpenType: @code{application/vnd.ms-fontobject}

@item 
OpenType Layout (OTF) @code{font/otf}

@item 
TrueType: @code{font/ttf}

@item 
WOFF 1.0 @code{font/woff}

@item 
WOFF 2.0 @code{font/woff2}
@end itemize

(Contributed by Sahil Prajapati and Hugo van Kemenade in gh-84852@footnote{https://github.com/python/cpython/issues/84852}.)

@item 
Add 
@geindex RFC; RFC 9559
RFC 9559@footnote{https://datatracker.ietf.org/doc/html/rfc9559.html} MIME types for Matroska audiovisual data container
structures, containing:


@itemize *

@item 
audio with no video: @code{audio/matroska} (@code{.mka})

@item 
video: @code{video/matroska} (@code{.mkv})

@item 
stereoscopic video: @code{video/matroska-3d} (@code{.mk3d})
@end itemize

(Contributed by Hugo van Kemenade in gh-89416@footnote{https://github.com/python/cpython/issues/89416}.)
@end itemize

@node multiprocessing,operator,mimetypes,Improved modules
@anchor{whatsnew/3 14 multiprocessing}@anchor{18a}
@subsubsection multiprocessing



@itemize *

@item 
The default start method (see @ref{162,,Contextos y métodos de inicio}) changed
from `fork' to `forkserver' on platforms other than macOS & Windows where
it was already `spawn'. If you require the threading incompatible `fork'
start method you must explicitly request it using a context from
@ref{18b,,multiprocessing.get_context()} (preferred) or change the default via
@ref{18c,,multiprocessing.set_start_method()}.
(Contributed by Gregory P. Smith in gh-84559@footnote{https://github.com/python/cpython/issues/84559}.)

@item 
The @ref{18d,,multiprocessing proxy objects}
for `list' and `dict' types gain previously overlooked missing methods:

@quotation


@itemize *

@item 
@code{clear()} and @code{copy()} for proxies of @ref{18e,,list}.

@item 
@ref{18f,,fromkeys()}, @code{reversed(d)}, @code{d | @{@}}, @code{@{@} | d},
@code{d |= @{'b': 2@}} for proxies of @ref{190,,dict}.
@end itemize
@end quotation

(Contributed by Roy Hyunjin Han for gh-103134@footnote{https://github.com/python/cpython/issues/103134})
@end itemize

@node operator,os,multiprocessing,Improved modules
@anchor{whatsnew/3 14 operator}@anchor{191}
@subsubsection operator



@itemize *

@item 
Two new functions @ref{192,,operator.is_none()} and @ref{193,,operator.is_not_none()}
have been added, such that @code{operator.is_none(obj)} is equivalent
to @code{obj is None} and @code{operator.is_not_none(obj)} is equivalent
to @code{obj is not None}.
(Contributed by Raymond Hettinger and Nico Mexis in gh-115808@footnote{https://github.com/python/cpython/issues/115808}.)
@end itemize

@node os,pathlib,operator,Improved modules
@anchor{whatsnew/3 14 os}@anchor{194}
@subsubsection os



@itemize *

@item 
Add the @ref{195,,os.reload_environ()} function to update @ref{196,,os.environ} and
@ref{197,,os.environb} with changes to the environment made by
@ref{198,,os.putenv()}, by @ref{199,,os.unsetenv()}, or made outside Python in the
same process.
(Contributed by Victor Stinner in gh-120057@footnote{https://github.com/python/cpython/issues/120057}.)
@end itemize

@node pathlib,platform,os,Improved modules
@anchor{whatsnew/3 14 pathlib}@anchor{19a}
@subsubsection pathlib



@itemize *

@item 
Add methods to @ref{19b,,pathlib.Path} to recursively copy or move files and
directories:


@itemize *

@item 
@ref{19c,,copy()} copies a file or directory tree to a destination.

@item 
@ref{19d,,copy_into()} copies `into' a destination directory.

@item 
@ref{19e,,move()} moves a file or directory tree to a destination.

@item 
@ref{19f,,move_into()} moves `into' a destination directory.
@end itemize

(Contributed by Barney Gale in gh-73991@footnote{https://github.com/python/cpython/issues/73991}.)

@item 
Add @ref{1a0,,pathlib.Path.scandir()} to scan a directory and return an iterator
of @ref{1a1,,os.DirEntry} objects. This is exactly equivalent to calling
@ref{1a2,,os.scandir()} on a path object.

(Contributed by Barney Gale in gh-125413@footnote{https://github.com/python/cpython/issues/125413}.)
@end itemize

@node platform,pdb,pathlib,Improved modules
@anchor{whatsnew/3 14 platform}@anchor{1a3}
@subsubsection platform



@itemize *

@item 
Add @ref{1a4,,platform.invalidate_caches()} to invalidate the cached results.

(Contributed by Bénédikt Tran in gh-122549@footnote{https://github.com/python/cpython/issues/122549}.)
@end itemize

@node pdb,pickle,platform,Improved modules
@anchor{whatsnew/3 14 pdb}@anchor{1a5}
@subsubsection pdb



@itemize *

@item 
Hardcoded breakpoints (@ref{1a6,,breakpoint()} and @ref{1a7,,pdb.set_trace()}) now
reuse the most recent @ref{1a8,,Pdb} instance that calls
@ref{1a9,,set_trace()}, instead of creating a new one each time.
As a result, all the instance specific data like @ref{1aa,,display} and
@ref{1ab,,commands} are preserved across hardcoded breakpoints.
(Contributed by Tian Gao in gh-121450@footnote{https://github.com/python/cpython/issues/121450}.)

@item 
Add a new argument `mode' to @ref{1a8,,pdb.Pdb}. Disable the @code{restart}
command when @ref{a5,,pdb} is in @code{inline} mode.
(Contributed by Tian Gao in gh-123757@footnote{https://github.com/python/cpython/issues/123757}.)
@end itemize

@node pickle,pydoc,pdb,Improved modules
@anchor{whatsnew/3 14 pickle}@anchor{1ac}
@subsubsection pickle



@itemize *

@item 
Set the default protocol version on the @ref{a6,,pickle} module to 5.
For more details, see @ref{1ad,,pickle protocols}.

@item 
Add notes for pickle serialization errors that allow to identify the source
of the error.
(Contributed by Serhiy Storchaka in gh-122213@footnote{https://github.com/python/cpython/issues/122213}.)
@end itemize

@node pydoc,symtable,pickle,Improved modules
@anchor{whatsnew/3 14 pydoc}@anchor{1ae}
@subsubsection pydoc



@itemize *

@item 
@ref{140,,Annotations} in help output are now usually
displayed in a format closer to that in the original source.
(Contributed by Jelle Zijlstra in gh-101552@footnote{https://github.com/python/cpython/issues/101552}.)
@end itemize

@node symtable,sys,pydoc,Improved modules
@anchor{whatsnew/3 14 symtable}@anchor{1af}
@subsubsection symtable



@itemize *

@item 
Expose the following @ref{1b0,,symtable.Symbol} methods:


@itemize *

@item 
@ref{1b1,,is_comp_cell()}

@item 
@ref{1b2,,is_comp_iter()}

@item 
@ref{1b3,,is_free_class()}
@end itemize

(Contributed by Bénédikt Tran in gh-120029@footnote{https://github.com/python/cpython/issues/120029}.)
@end itemize

@node sys,unicodedata,symtable,Improved modules
@anchor{whatsnew/3 14 sys}@anchor{1b4}
@subsubsection sys



@itemize *

@item 
The previously undocumented special function @ref{1b5,,sys.getobjects()},
which only exists in specialized builds of Python, may now return objects
from other interpreters than the one it’s called in.
@end itemize

@node unicodedata,unittest,sys,Improved modules
@anchor{whatsnew/3 14 unicodedata}@anchor{1b6}
@subsubsection unicodedata



@itemize *

@item 
The Unicode database has been updated to Unicode 16.0.0.
@end itemize

@node unittest,uuid,unicodedata,Improved modules
@anchor{whatsnew/3 14 unittest}@anchor{1b7}
@subsubsection unittest



@itemize *

@item 
unittest discovery supports @ref{1b8,,namespace package} as start
directory again. It was removed in Python 3.11.
(Contributed by Jacob Walls in gh-80958@footnote{https://github.com/python/cpython/issues/80958}.)
@end itemize

@node uuid,,unittest,Improved modules
@anchor{whatsnew/3 14 uuid}@anchor{1b9}
@subsubsection uuid



@itemize *

@item 
Add support for UUID version 8 via @ref{1ba,,uuid.uuid8()} as specified
in 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}.
(Contributed by Bénédikt Tran in gh-89083@footnote{https://github.com/python/cpython/issues/89083}.)
@end itemize

@c Add improved modules above alphabetically, not here at the end.

@node Optimizations,Deprecated,Improved modules,What’s new in Python 3 14
@anchor{whatsnew/3 14 optimizations}@anchor{1bb}
@subsection Optimizations


@menu
* asyncio:: 
* io:: 

@end menu

@node asyncio,io,,Optimizations
@anchor{whatsnew/3 14 asyncio}@anchor{1bc}
@subsubsection asyncio



@itemize *

@item 
@ref{b,,asyncio} now uses double linked list implementation for native tasks
which speeds up execution by 10% on standard pyperformance benchmarks and
reduces memory usage.
(Contributed by Kumar Aditya in gh-107803@footnote{https://github.com/python/cpython/issues/107803}.)
@end itemize

@node io,,asyncio,Optimizations
@anchor{whatsnew/3 14 io}@anchor{1bd}
@subsubsection io



@itemize *

@item 
@ref{7f,,io} which provides the built-in @ref{1be,,open()} makes less system calls
when opening regular files as well as reading whole files. Reading a small
operating system cached file in full is up to 15% faster.
@ref{1bf,,pathlib.Path.read_bytes()} has the most optimizations for reading a
file’s bytes in full. (Contributed by Cody Maloney and Victor Stinner in
gh-120754@footnote{https://github.com/python/cpython/issues/120754} and gh-90102@footnote{https://github.com/python/cpython/issues/90102}.)
@end itemize

@node Deprecated,Removed,Optimizations,What’s new in Python 3 14
@anchor{whatsnew/3 14 deprecated}@anchor{1c0}
@subsection Deprecated



@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
Passing the undocumented keyword argument `prefix_chars' to
@ref{1c1,,add_argument_group()} is now
deprecated.
(Contributed by Savannah Ostrowski in gh-125563@footnote{https://github.com/python/cpython/issues/125563}.)

@item 
Deprecated the @ref{1c2,,argparse.FileType} type converter.
Anything with resource management should be done downstream after the
arguments are parsed.
(Contributed by Serhiy Storchaka in gh-58032@footnote{https://github.com/python/cpython/issues/58032}.)
@end itemize

@item 
@ref{b,,asyncio}:
@code{asyncio.iscoroutinefunction()} is deprecated
and will be removed in Python 3.16,
use @ref{1c3,,inspect.iscoroutinefunction()} instead.
(Contributed by Jiahao Li and Kumar Aditya in gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)

@item 
@ref{13,,builtins}:
Passing a complex number as the `real' or `imag' argument in the
@ref{154,,complex()} constructor is now deprecated; it should only be passed
as a single positional argument.
(Contributed by Serhiy Storchaka in gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)

@item 
@ref{a1,,os}:
@ref{1c4,,Soft deprecate} @ref{1c5,,os.popen()} and
@ref{1c6,,os.spawn*} functions. They should no longer be used to
write new code.  The @ref{d6,,subprocess} module is recommended instead.
(Contributed by Victor Stinner in gh-120743@footnote{https://github.com/python/cpython/issues/120743}.)

@item 
@ref{d8,,symtable}:
Deprecate @ref{1c7,,symtable.Class.get_methods()} due to the lack of interest.
(Contributed by Bénédikt Tran in gh-119698@footnote{https://github.com/python/cpython/issues/119698}.)

@item 
@ref{10a,,urllib.parse}:
Accepting objects with false values (like @code{0} and @code{[]}) except empty
strings, byte-like objects and @code{None} in @ref{10a,,urllib.parse} functions
@ref{1c8,,parse_qsl()} and @ref{1c9,,parse_qs()} is now
deprecated.
(Contributed by Serhiy Storchaka in gh-116897@footnote{https://github.com/python/cpython/issues/116897}.)
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Pending removal in Python 3.15: Pending removal in Python 3 15. 
* Pending removal in Python 3.16: Pending removal in Python 3 16. 
* Pending removal in future versions:: 

@end menu

@node Pending removal in Python 3 15,Pending removal in Python 3 16,,Deprecated
@anchor{whatsnew/3 14 pending-removal-in-python-3-15}@anchor{1ca}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1cb,,__cached__} on a module while
failing to set @ref{1cc,,__spec__.cached}
is deprecated. In Python 3.15, @code{__cached__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
Setting @ref{1cd,,__package__} on a module while
failing to set @ref{1ce,,__spec__.parent}
is deprecated. In Python 3.15, @code{__package__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2b,,ctypes}:


@itemize *

@item 
The undocumented @code{ctypes.SetPointerType()} function
has been deprecated since Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
The obsolete and rarely used @ref{1cf,,CGIHTTPRequestHandler}
has been deprecated since Python 3.13.
No direct replacement exists.
`Anything' is better than CGI to interface
a web server with a request handler.

@item 
The @code{--cgi} flag to the @code{python -m http.server}
command-line interface has been deprecated since Python 3.13.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
The @ref{1d0,,getdefaultlocale()} function
has been deprecated since Python 3.11.
Its removal was originally planned for Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}),
but has been postponed to Python 3.15.
Use @ref{1d1,,getlocale()}, @ref{1d2,,setlocale()},
and @ref{1d3,,getencoding()} instead.
(Contributed by Hugo van Kemenade in gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{1d4,,PurePath.is_reserved()}
has been deprecated since Python 3.13.
Use @ref{1d5,,os.path.isreserved()} to detect reserved paths on Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{1d6,,java_ver()} has been deprecated since Python 3.13.
This function is only useful for Jython support, has a confusing API,
and is largely untested.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{1d7,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the  Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{1d8,,types.CodeType}: Accessing @ref{1d9,,co_lnotab} was
deprecated in 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}
since 3.10 and was planned to be removed in 3.12,
but it only got a proper @ref{1da,,DeprecationWarning} in 3.12.
May be removed in 3.15.
(Contributed by Nikita Sobolev in gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
The undocumented keyword argument syntax for creating
@ref{1db,,NamedTuple} classes
(for example, @code{Point = NamedTuple("Point", x=int, y=int)})
has been deprecated since Python 3.13.
Use the class-based syntax or the functional syntax instead.

@item 
The @ref{1dc,,typing.no_type_check_decorator()} decorator function
has been deprecated since Python 3.13.
After eight years in the @ref{104,,typing} module,
it has yet to be supported by any major type checker.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
The @ref{1dd,,getmark()}, @code{setmark()},
and @ref{1de,,getmarkers()} methods of
the @ref{1df,,Wave_read} and @ref{1e0,,Wave_write} classes
have been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in Python 3 16,Pending removal in future versions,Pending removal in Python 3 15,Deprecated
@anchor{whatsnew/3 14 pending-removal-in-python-3-16}@anchor{1e1}
@subsubsection Pending removal in Python 3.16



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1e2,,__loader__} on a module while
failing to set @ref{1e3,,__spec__.loader}
is deprecated. In Python 3.16, @code{__loader__} will cease to be set or
taken into consideration by the import system or the standard library.
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
The @code{'u'} format code (@code{wchar_t})
has been deprecated in documentation since Python 3.3
and at runtime since Python 3.13.
Use the @code{'w'} format code (@ref{1e4,,Py_UCS4})
for Unicode characters instead.
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} is deprecated
and will be removed in Python 3.16,
use @ref{1c3,,inspect.iscoroutinefunction()} instead.
(Contributed by Jiahao Li and Kumar Aditya in gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
Bitwise inversion on boolean types, @code{~True} or @code{~False}
has been deprecated since Python 3.12,
as it produces surprising and unintuitive results (@code{-2} and @code{-1}).
Use @code{not x} instead for the logical negation of a Boolean.
In the rare case that you need the bitwise inversion of
the underlying integer, convert to @code{int} explicitly (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
The @code{ExecError} exception
has been deprecated since Python 3.14.
It has not been used by any function in @code{shutil} since Python 3.4,
and is now an alias of @ref{1e5,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
The @ref{1c7,,Class.get_methods} method
has been deprecated since Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
The @ref{1e6,,_enablelegacywindowsfsencoding()} function
has been deprecated since Python 3.13.
Use the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment variable instead.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
The undocumented and unused @code{TarFile.tarfile} attribute
has been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in future versions,,Pending removal in Python 3 16,Deprecated
@anchor{whatsnew/3 14 pending-removal-in-future-versions}@anchor{1e8}
@subsubsection Pending removal in future versions


The following APIs will be removed in the future,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
Nesting argument groups and nesting mutually exclusive
groups are deprecated.

@item 
Passing the undocumented keyword argument `prefix_chars' to
@ref{1c1,,add_argument_group()} is now
deprecated.

@item 
The @ref{1c2,,argparse.FileType} type converter is deprecated.
@end itemize

@item 
@ref{8,,array}’s @code{'u'} format code (gh-57281@footnote{https://github.com/python/cpython/issues/57281})

@item 
@ref{13,,builtins}:


@itemize *

@item 
@code{bool(NotImplemented)}.

@item 
Generators: @code{throw(type, exc, tb)} and @code{athrow(type, exc, tb)}
signature is deprecated: use @code{throw(exc)} and @code{athrow(exc)} instead,
the single argument signature.

@item 
Currently Python accepts numeric literals immediately followed by keywords,
for example @code{0in x}, @code{1or x}, @code{0if 1else 2}.  It allows confusing and
ambiguous expressions like @code{[0x1for x in y]} (which can be interpreted as
@code{[0x1 for x in y]} or @code{[0x1f or x in y]}).  A syntax warning is raised
if the numeric literal is immediately followed by one of keywords
@ref{1e9,,and}, @ref{1ea,,else}, @ref{1eb,,for}, @ref{1ec,,if},
@ref{1ed,,in}, @ref{1ee,,is} and @ref{1ef,,or}.  In a future release it
will be changed to a syntax error. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Support for @code{__index__()} and @code{__int__()} method returning non-int type:
these methods will be required to return an instance of a strict subclass of
@ref{1f0,,int}.

@item 
Support for @code{__float__()} method returning a strict subclass of
@ref{153,,float}: these methods will be required to return an instance of
@ref{153,,float}.

@item 
Support for @code{__complex__()} method returning a strict subclass of
@ref{154,,complex}: these methods will be required to return an instance of
@ref{154,,complex}.

@item 
Delegation of @code{int()} to @code{__trunc__()} method.

@item 
Passing a complex number as the `real' or `imag' argument in the
@ref{154,,complex()} constructor is now deprecated; it should only be passed
as a single positional argument.
(Contributed by Serhiy Storchaka in gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} and @code{calendar.February} constants are
deprecated and replaced by @ref{1f1,,calendar.JANUARY} and
@ref{1f2,,calendar.FEBRUARY}.
(Contributed by Prince Roshan in gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1d9,,codeobject.co_lnotab}: use the @ref{1f3,,codeobject.co_lines()} method
instead.

@item 
@ref{31,,datetime}:


@itemize *

@item 
@ref{1f4,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{1f5,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: Plural value must be an integer.

@item 
@ref{77,,importlib}:


@itemize *

@item 
@code{load_module()} method: use @code{exec_module()} instead.

@item 
@ref{1f6,,cache_from_source()} `debug_override' parameter is
deprecated: use the `optimization' parameter instead.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} tuple interface.

@item 
Implicit @code{None} on return values.
@end itemize

@item 
@ref{87,,logging}: the @code{warn()} method has been deprecated
since Python 3.3, use @ref{1f7,,warning()} instead.

@item 
@ref{8b,,mailbox}: Use of StringIO input and text mode is deprecated, use
BytesIO and binary mode instead.

@item 
@ref{a1,,os}: Calling @ref{1f8,,os.register_at_fork()} in multi-threaded process.

@item 
@code{pydoc.ErrorDuringImport}: A tuple value for `exc_info' parameter is
deprecated, use an exception instance.

@item 
@ref{b9,,re}: More strict rules are now applied for numerical group references
and group names in regular expressions.  Only sequence of ASCII digits is now
accepted as a numerical reference.  The group name in bytes patterns and
replacement strings can now only contain ASCII letters and digits and
underscore.
(Contributed by Serhiy Storchaka in gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
@code{sre_compile}, @code{sre_constants} and @code{sre_parse} modules.

@item 
@ref{c5,,shutil}: @ref{1f9,,rmtree()}”s `onerror' parameter is deprecated in
Python 3.12; use the `onexc' parameter instead.

@item 
@ref{d0,,ssl} options and protocols:


@itemize *

@item 
@ref{1fa,,ssl.SSLContext} without protocol argument is deprecated.

@item 
@ref{1fa,,ssl.SSLContext}: @ref{1fb,,set_npn_protocols()} and
@code{selected_npn_protocol()} are deprecated: use ALPN
instead.

@item 
@code{ssl.OP_NO_SSL*} options

@item 
@code{ssl.OP_NO_TLS*} options

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{1fc,,sysconfig.is_python_build()} `check_home' parameter is deprecated and
ignored.

@item 
@ref{ed,,threading} methods:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{1fd,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{1fe,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{1ff,,threading.Thread.setDaemon()}:
use @ref{200,,threading.Thread.daemon} attribute.

@item 
@code{threading.Thread.getName()}, @ref{201,,threading.Thread.setName()}:
use @ref{202,,threading.Thread.name} attribute.

@item 
@code{threading.currentThread()}: use @ref{203,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{204,,threading.active_count()}.
@end itemize

@item 
@ref{205,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{206,,unittest.IsolatedAsyncioTestCase}: it is deprecated to return a value
that is not @code{None} from a test case.

@item 
@ref{10a,,urllib.parse} deprecated functions: @ref{207,,urlparse()} instead


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{10b,,urllib.request}: @ref{208,,URLopener} and
@ref{209,,FancyURLopener} style of invoking requests is
deprecated. Use newer @ref{20a,,urlopen()} functions and methods.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} should not do partial
writes.

@item 
@ref{125,,xml.etree.ElementTree}: Testing the truth value of an
@ref{20b,,Element} is deprecated. In a future release it
will always return @code{True}. Prefer explicit @code{len(elem)} or
@code{elem is not None} tests instead.

@item 
@ref{20c,,zipimport.zipimporter.load_module()} is deprecated:
use @ref{20d,,exec_module()} instead.
@end itemize

@node Removed,Porting to Python 3 14,Deprecated,What’s new in Python 3 14
@anchor{whatsnew/3 14 removed}@anchor{20e}
@subsection Removed


@menu
* argparse: argparse<2>. 
* ast: ast<2>. 
* asyncio: asyncio<2>. 
* collections.abc: collections abc. 
* email:: 
* importlib:: 
* itertools:: 
* pathlib: pathlib<2>. 
* pkgutil:: 
* pty:: 
* sqlite3:: 
* typing:: 
* urllib:: 
* Others:: 

@end menu

@node argparse<2>,ast<2>,,Removed
@anchor{whatsnew/3 14 id1}@anchor{20f}
@subsubsection argparse



@itemize *

@item 
Remove the `type', `choices', and `metavar' parameters
of @code{argparse.BooleanOptionalAction}.
They were deprecated since 3.12.
@end itemize

@node ast<2>,asyncio<2>,argparse<2>,Removed
@anchor{whatsnew/3 14 id2}@anchor{210}
@subsubsection ast



@itemize *

@item 
Remove the following classes. They were all deprecated since Python 3.8,
and have emitted deprecation warnings since Python 3.12:


@itemize *

@item 
@code{ast.Bytes}

@item 
@code{ast.Ellipsis}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Num}

@item 
@code{ast.Str}
@end itemize

Use @ref{211,,ast.Constant} instead. As a consequence of these removals,
user-defined @code{visit_Num}, @code{visit_Str}, @code{visit_Bytes},
@code{visit_NameConstant} and @code{visit_Ellipsis} methods on custom
@ref{212,,ast.NodeVisitor} subclasses will no longer be called when the
@code{NodeVisitor} subclass is visiting an AST. Define a @code{visit_Constant}
method instead.

Also, remove the following deprecated properties on @ref{211,,ast.Constant},
which were present for compatibility with the now-removed AST classes:


@itemize *

@item 
@code{ast.Constant.n}

@item 
@code{ast.Constant.s}
@end itemize

Use @code{ast.Constant.value} instead.

(Contributed by Alex Waygood in gh-119562@footnote{https://github.com/python/cpython/issues/119562}.)
@end itemize

@node asyncio<2>,collections abc,ast<2>,Removed
@anchor{whatsnew/3 14 id3}@anchor{213}
@subsubsection asyncio



@itemize *

@item 
Remove the following classes and functions. They were all deprecated and
emitted deprecation warnings since Python 3.12:


@itemize *

@item 
@code{asyncio.get_child_watcher()}

@item 
@code{asyncio.set_child_watcher()}

@item 
@code{asyncio.AbstractEventLoopPolicy.get_child_watcher()}

@item 
@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()}

@item 
@code{asyncio.AbstractChildWatcher}

@item 
@code{asyncio.FastChildWatcher}

@item 
@code{asyncio.MultiLoopChildWatcher}

@item 
@code{asyncio.PidfdChildWatcher}

@item 
@code{asyncio.SafeChildWatcher}

@item 
@code{asyncio.ThreadedChildWatcher}
@end itemize

(Contributed by Kumar Aditya in gh-120804@footnote{https://github.com/python/cpython/issues/120804}.)

@item 
Removed implicit creation of event loop by @ref{214,,asyncio.get_event_loop()}.
It now raises a @ref{1e5,,RuntimeError} if there is no current event loop.
(Contributed by Kumar Aditya in gh-126353@footnote{https://github.com/python/cpython/issues/126353}.)
@end itemize

@node collections abc,email,asyncio<2>,Removed
@anchor{whatsnew/3 14 collections-abc}@anchor{215}
@subsubsection collections.abc



@itemize *

@item 
Remove @code{collections.abc.ByteString}. It had previously raised a
@ref{1da,,DeprecationWarning} since Python 3.12.
@end itemize

@node email,importlib,collections abc,Removed
@anchor{whatsnew/3 14 email}@anchor{216}
@subsubsection email



@itemize *

@item 
Remove the `isdst' parameter from @ref{217,,email.utils.localtime()}.
(Contributed by Hugo van Kemenade in gh-118798@footnote{https://github.com/python/cpython/issues/118798}.)
@end itemize

@node importlib,itertools,email,Removed
@anchor{whatsnew/3 14 importlib}@anchor{218}
@subsubsection importlib



@itemize *

@item 
Remove deprecated @ref{78,,importlib.abc} classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Use @ref{7c,,importlib.resources.abc} classes instead:


@itemize *

@item 
@ref{219,,importlib.resources.abc.Traversable}

@item 
@ref{21a,,importlib.resources.abc.TraversableResources}
@end itemize

(Contributed by Jason R. Coombs and Hugo van Kemenade in gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)
@end itemize

@node itertools,pathlib<2>,importlib,Removed
@anchor{whatsnew/3 14 itertools}@anchor{21b}
@subsubsection itertools



@itemize *

@item 
Remove @ref{81,,itertools} support for copy, deepcopy, and pickle operations.
These had previously raised a @ref{1da,,DeprecationWarning} since Python 3.12.
(Contributed by Raymond Hettinger in gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)
@end itemize

@node pathlib<2>,pkgutil,itertools,Removed
@anchor{whatsnew/3 14 id4}@anchor{21c}
@subsubsection pathlib



@itemize *

@item 
Remove support for passing additional keyword arguments to
@ref{19b,,pathlib.Path}. In previous versions, any such arguments are ignored.

@item 
Remove support for passing additional positional arguments to
@ref{21d,,pathlib.PurePath.relative_to()} and
@ref{21e,,is_relative_to()}. In previous versions, any such
arguments are joined onto `other'.
@end itemize

@node pkgutil,pty,pathlib<2>,Removed
@anchor{whatsnew/3 14 pkgutil}@anchor{21f}
@subsubsection pkgutil



@itemize *

@item 
Remove deprecated @code{pkgutil.get_loader()} and @code{pkgutil.find_loader()}.
These had previously raised a @ref{1da,,DeprecationWarning} since Python 3.12.
(Contributed by Bénédikt Tran in gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)
@end itemize

@node pty,sqlite3,pkgutil,Removed
@anchor{whatsnew/3 14 pty}@anchor{220}
@subsubsection pty



@itemize *

@item 
Remove deprecated @code{pty.master_open()} and @code{pty.slave_open()}.
They had previously raised a @ref{1da,,DeprecationWarning} since Python 3.12.
Use @ref{221,,pty.openpty()} instead.
(Contributed by Nikita Sobolev in gh-118824@footnote{https://github.com/python/cpython/issues/118824}.)
@end itemize

@node sqlite3,typing,pty,Removed
@anchor{whatsnew/3 14 sqlite3}@anchor{222}
@subsubsection sqlite3



@itemize *

@item 
Remove @code{version} and @code{version_info} from @ref{cf,,sqlite3}.
(Contributed by Hugo van Kemenade in gh-118924@footnote{https://github.com/python/cpython/issues/118924}.)

@item 
Disallow using a sequence of parameters with named placeholders.
This had previously raised a @ref{1da,,DeprecationWarning} since Python 3.12;
it will now raise a @ref{223,,sqlite3.ProgrammingError}.
(Contributed by Erlend E. Aasland in gh-118928@footnote{https://github.com/python/cpython/issues/118928} and gh-101693@footnote{https://github.com/python/cpython/issues/101693}.)
@end itemize

@node typing,urllib,sqlite3,Removed
@anchor{whatsnew/3 14 typing}@anchor{224}
@subsubsection typing



@itemize *

@item 
Remove @code{typing.ByteString}. It had previously raised a
@ref{1da,,DeprecationWarning} since Python 3.12.
@end itemize

@node urllib,Others,typing,Removed
@anchor{whatsnew/3 14 urllib}@anchor{225}
@subsubsection urllib



@itemize *

@item 
Remove deprecated @code{Quoter} class from @ref{10a,,urllib.parse}.
It had previously raised a @ref{1da,,DeprecationWarning} since Python 3.11.
(Contributed by Nikita Sobolev in gh-118827@footnote{https://github.com/python/cpython/issues/118827}.)
@end itemize

@node Others,,urllib,Removed
@anchor{whatsnew/3 14 others}@anchor{226}
@subsubsection Others



@itemize *

@item 
Using @ref{227,,NotImplemented} in a boolean context will now raise a @ref{228,,TypeError}.
It had previously raised a @ref{1da,,DeprecationWarning} since Python 3.9. (Contributed
by Jelle Zijlstra in gh-118767@footnote{https://github.com/python/cpython/issues/118767}.)

@item 
The @ref{1f0,,int()} built-in no longer delegates to
@ref{229,,__trunc__()}. Classes that want to support conversion to
integer must implement either @ref{22a,,__int__()} or
@ref{22b,,__index__()}. (Contributed by Mark Dickinson in gh-119743@footnote{https://github.com/python/cpython/issues/119743}.)
@end itemize

@node Porting to Python 3 14,Build changes,Removed,What’s new in Python 3 14
@anchor{whatsnew/3 14 porting-to-python-3-14}@anchor{22c}
@subsection Porting to Python 3.14


This section lists previously described changes and other bugfixes
that may require changes to your code.

@menu
* Changes in the Python API:: 

@end menu

@node Changes in the Python API,,,Porting to Python 3 14
@anchor{whatsnew/3 14 changes-in-the-python-api}@anchor{22d}
@subsubsection Changes in the Python API



@itemize *

@item 
@ref{17a,,functools.partial} is now a method descriptor.
Wrap it in @ref{22e,,staticmethod()} if you want to preserve the old behavior.
(Contributed by Serhiy Storchaka and Dominykas Grigonis in gh-121027@footnote{https://github.com/python/cpython/issues/121027}.)

@item 
The @ref{22f,,locale.nl_langinfo()} function now sets temporarily the @code{LC_CTYPE}
locale in some cases.
This temporary change affects other threads.
(Contributed by Serhiy Storchaka in gh-69998@footnote{https://github.com/python/cpython/issues/69998}.)
@end itemize

@node Build changes,C API changes,Porting to Python 3 14,What’s new in Python 3 14
@anchor{whatsnew/3 14 build-changes}@anchor{230}
@subsection Build changes


@menu
* PEP 761; Discontinuation of PGP signatures: PEP 761 Discontinuation of PGP signatures. 

@end menu

@node PEP 761 Discontinuation of PGP signatures,,,Build changes
@anchor{whatsnew/3 14 pep-761-discontinuation-of-pgp-signatures}@anchor{231}
@subsubsection PEP 761: Discontinuation of PGP signatures


PGP signatures will not be available for CPython 3.14 and onwards.
Users verifying artifacts must use Sigstore verification materials@footnote{https://www.python.org/downloads/metadata/sigstore/} for
verifying CPython artifacts. This change in release process is specified
in 
@geindex Python Enhancement Proposals; PEP 761
PEP 761@footnote{https://peps.python.org/pep-0761/}.

@node C API changes,,Build changes,What’s new in Python 3 14
@anchor{whatsnew/3 14 c-api-changes}@anchor{232}@anchor{whatsnew/3 14 sigstore-verification-materials}@anchor{233}
@subsection C API changes


@menu
* New features: New features<2>. 
* Porting to Python 3.14: Porting to Python 3 14<2>. 
* Deprecated: Deprecated<2>. 
* Removed: Removed<2>. 

@end menu

@node New features<2>,Porting to Python 3 14<2>,,C API changes
@anchor{whatsnew/3 14 id5}@anchor{234}
@subsubsection New features



@itemize *

@item 
Add @ref{235,,PyLong_GetSign()} function to get the sign of @ref{1f0,,int} objects.
(Contributed by Sergey B Kirpichev in gh-116560@footnote{https://github.com/python/cpython/issues/116560}.)

@item 
Add a new @ref{236,,PyUnicodeWriter} API to create a Python @ref{237,,str}
object:


@itemize *

@item 
@ref{238,,PyUnicodeWriter_Create()}

@item 
@ref{239,,PyUnicodeWriter_DecodeUTF8Stateful()}

@item 
@ref{23a,,PyUnicodeWriter_Discard()}

@item 
@ref{23b,,PyUnicodeWriter_Finish()}

@item 
@ref{23c,,PyUnicodeWriter_Format()}

@item 
@ref{23d,,PyUnicodeWriter_WriteChar()}

@item 
@ref{23e,,PyUnicodeWriter_WriteRepr()}

@item 
@ref{23f,,PyUnicodeWriter_WriteStr()}

@item 
@ref{240,,PyUnicodeWriter_WriteSubstring()}

@item 
@ref{241,,PyUnicodeWriter_WriteUCS4()}

@item 
@ref{242,,PyUnicodeWriter_WriteUTF8()}

@item 
@ref{243,,PyUnicodeWriter_WriteWideChar()}
@end itemize

(Contributed by Victor Stinner in gh-119182@footnote{https://github.com/python/cpython/issues/119182}.)

@item 
Add @ref{244,,PyIter_NextItem()} to replace @ref{245,,PyIter_Next()},
which has an ambiguous return value.
(Contributed by Irit Katriel and Erlend Aasland in gh-105201@footnote{https://github.com/python/cpython/issues/105201}.)

@item 
@ref{246,,Py_Finalize()} now deletes all interned strings. This
is backwards incompatible to any C-Extension that holds onto an interned
string after a call to @ref{246,,Py_Finalize()} and is then reused after a
call to @ref{247,,Py_Initialize()}.  Any issues arising from this behavior will
normally result in crashes during the execution of the subsequent call to
@ref{247,,Py_Initialize()} from accessing uninitialized memory. To fix, use
an address sanitizer to identify any use-after-free coming from
an interned string and deallocate it during module shutdown.
(Contributed by Eddie Elizondo in gh-113601@footnote{https://github.com/python/cpython/issues/113601}.)

@item 
Add @ref{248,,PyLong_IsPositive()}, @ref{249,,PyLong_IsNegative()}
and @ref{24a,,PyLong_IsZero()} for checking if @ref{24b,,PyLongObject}
is positive, negative, or zero, respectively.
(Contribued by James Roy and Sergey B Kirpichev in gh-126061@footnote{https://github.com/python/cpython/issues/126061}.)

@item 
Add new functions to convert C @code{<stdint.h>} numbers from/to Python
@ref{1f0,,int}:


@itemize *

@item 
@ref{24c,,PyLong_AsInt32()}

@item 
@ref{24d,,PyLong_AsInt64()}

@item 
@ref{24e,,PyLong_AsUInt32()}

@item 
@ref{24f,,PyLong_AsUInt64()}

@item 
@ref{250,,PyLong_FromInt32()}

@item 
@ref{251,,PyLong_FromInt64()}

@item 
@ref{252,,PyLong_FromUInt32()}

@item 
@ref{253,,PyLong_FromUInt64()}
@end itemize

(Contributed by Victor Stinner in gh-120389@footnote{https://github.com/python/cpython/issues/120389}.)

@item 
Add @ref{254,,PyBytes_Join(sep@comma{} iterable)} function,
similar to @code{sep.join(iterable)} in Python.
(Contributed by Victor Stinner in gh-121645@footnote{https://github.com/python/cpython/issues/121645}.)

@item 
Add @ref{255,,Py_HashBuffer()} to compute and return the hash value of a buffer.
(Contributed by Antoine Pitrou and Victor Stinner in gh-122854@footnote{https://github.com/python/cpython/issues/122854}.)

@item 
Add functions to get and set the current runtime Python configuration
(
@geindex Python Enhancement Proposals; PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}):


@itemize *

@item 
@ref{256,,PyConfig_Get()}

@item 
@ref{257,,PyConfig_GetInt()}

@item 
@ref{258,,PyConfig_Set()}

@item 
@ref{259,,PyConfig_Names()}
@end itemize

(Contributed by Victor Stinner in gh-107954@footnote{https://github.com/python/cpython/issues/107954}.)

@item 
Add functions to configure the Python initialization (
@geindex Python Enhancement Proposals; PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}):


@itemize *

@item 
@ref{25a,,Py_InitializeFromInitConfig()}

@item 
@ref{25b,,PyInitConfig_AddModule()}

@item 
@ref{25c,,PyInitConfig_Create()}

@item 
@ref{25d,,PyInitConfig_Free()}

@item 
@ref{25e,,PyInitConfig_FreeStrList()}

@item 
@ref{25f,,PyInitConfig_GetError()}

@item 
@ref{260,,PyInitConfig_GetExitCode()}

@item 
@ref{261,,PyInitConfig_GetInt()}

@item 
@ref{262,,PyInitConfig_GetStr()}

@item 
@ref{263,,PyInitConfig_GetStrList()}

@item 
@ref{264,,PyInitConfig_HasOption()}

@item 
@ref{265,,PyInitConfig_SetInt()}

@item 
@ref{266,,PyInitConfig_SetStr()}

@item 
@ref{267,,PyInitConfig_SetStrList()}
@end itemize

(Contributed by Victor Stinner in gh-107954@footnote{https://github.com/python/cpython/issues/107954}.)

@item 
Add @ref{268,,PyType_GetBaseByToken()} and @ref{269,,Py_tp_token} slot for easier
superclass identification, which attempts to resolve the type checking issue@footnote{https://peps.python.org/pep-0630/#type-checking} mentioned in 
@geindex Python Enhancement Proposals; PEP 630
PEP 630@footnote{https://peps.python.org/pep-0630/}
(gh-124153@footnote{https://github.com/python/cpython/issues/124153}).

@item 
Add @ref{26a,,PyUnicode_Equal()} function to the limited C API:
test if two strings are equal.
(Contributed by Victor Stinner in gh-124502@footnote{https://github.com/python/cpython/issues/124502}.)

@item 
Add @ref{26b,,PyType_Freeze()} function to make a type immutable.
(Contributed by Victor Stinner in gh-121654@footnote{https://github.com/python/cpython/issues/121654}.)

@item 
Add @ref{26c,,PyUnstable_Object_EnableDeferredRefcount()} for enabling
deferred reference counting, as outlined in 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.
@end itemize

@node Porting to Python 3 14<2>,Deprecated<2>,New features<2>,C API changes
@anchor{whatsnew/3 14 id6}@anchor{26d}
@subsubsection Porting to Python 3.14



@itemize *

@item 
In the limited C API 3.14 and newer, @ref{26e,,Py_TYPE()} and
@ref{26f,,Py_REFCNT()} are now implemented as an opaque function call to hide
implementation details.
(Contributed by Victor Stinner in gh-120600@footnote{https://github.com/python/cpython/issues/120600} and gh-124127@footnote{https://github.com/python/cpython/issues/124127}.)
@end itemize

@node Deprecated<2>,Removed<2>,Porting to Python 3 14<2>,C API changes
@anchor{whatsnew/3 14 id7}@anchor{270}
@subsubsection Deprecated



@itemize *

@item 
The @code{Py_HUGE_VAL} macro is @ref{1c4,,soft deprecated},
use @code{Py_INFINITY} instead.
(Contributed by Sergey B Kirpichev in gh-120026@footnote{https://github.com/python/cpython/issues/120026}.)

@item 
Macros @code{Py_IS_NAN}, @code{Py_IS_INFINITY}
and @code{Py_IS_FINITE} are @ref{1c4,,soft deprecated},
use instead @code{isnan}, @code{isinf} and
@code{isfinite} available from @code{math.h}
since C99.  (Contributed by Sergey B Kirpichev in gh-119613@footnote{https://github.com/python/cpython/issues/119613}.)
@end itemize

@c Add C API deprecations above alphabetically, not here at the end.

@menu
* Pending removal in Python 3.15: Pending removal in Python 3 15<2>. 
* Pending removal in future versions: Pending removal in future versions<2>. 

@end menu

@node Pending removal in Python 3 15<2>,Pending removal in future versions<2>,,Deprecated<2>
@anchor{whatsnew/3 14 id8}@anchor{271}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The bundled copy of @code{libmpdecimal}.

@item 
The @ref{272,,PyImport_ImportModuleNoBlock()}:
Use @ref{273,,PyImport_ImportModule()} instead.

@item 
@ref{274,,PyWeakref_GetObject()} and @ref{275,,PyWeakref_GET_OBJECT()}:
Use @ref{276,,PyWeakref_GetRef()} instead.

@item 
@ref{277,,Py_UNICODE} type and the @code{Py_UNICODE_WIDE} macro:
Use @code{wchar_t} instead.

@item 
Python initialization functions:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}:
Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@item 
@ref{27a,,Py_GetExecPrefix()}:
Get @ref{27b,,sys.base_exec_prefix} and @ref{27c,,sys.exec_prefix} instead.

@item 
@ref{27d,,Py_GetPath()}:
Get @ref{27e,,sys.path} instead.

@item 
@ref{27f,,Py_GetPrefix()}:
Get @ref{280,,sys.base_prefix} and @ref{281,,sys.prefix} instead.

@item 
@ref{282,,Py_GetProgramFullPath()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{284,,Py_GetProgramName()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{285,,Py_GetPythonHome()}:
Get @ref{286,,PyConfig.home}
or the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment variable instead.
@end itemize
@end itemize

@node Pending removal in future versions<2>,,Pending removal in Python 3 15<2>,Deprecated<2>
@anchor{whatsnew/3 14 id9}@anchor{288}
@subsubsection Pending removal in future versions


The following APIs are deprecated and will be removed,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{289,,Py_TPFLAGS_HAVE_FINALIZE}:
Unneeded since Python 3.8.

@item 
@ref{28a,,PyErr_Fetch()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28c,,PyErr_NormalizeException()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28d,,PyErr_Restore()}:
Use @ref{28e,,PyErr_SetRaisedException()} instead.

@item 
@ref{28f,,PyModule_GetFilename()}:
Use @ref{290,,PyModule_GetFilenameObject()} instead.

@item 
@ref{291,,PyOS_AfterFork()}:
Use @ref{292,,PyOS_AfterFork_Child()} instead.

@item 
@ref{293,,PySlice_GetIndicesEx()}:
Use @ref{294,,PySlice_Unpack()} and @ref{295,,PySlice_AdjustIndices()} instead.

@item 
@code{PyUnicode_AsDecodedObject()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsDecodedUnicode()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsEncodedObject()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@code{PyUnicode_AsEncodedUnicode()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@ref{298,,PyUnicode_READY()}:
Unneeded since Python 3.12

@item 
@code{PyErr_Display()}:
Use @ref{299,,PyErr_DisplayException()} instead.

@item 
@code{_PyErr_ChainExceptions()}:
Use @code{_PyErr_ChainExceptions1()} instead.

@item 
@code{PyBytesObject.ob_shash} member:
call @ref{29a,,PyObject_Hash()} instead.

@item 
@code{PyDictObject.ma_version_tag} member.

@item 
Thread Local Storage (TLS) API:


@itemize *

@item 
@ref{29b,,PyThread_create_key()}:
Use @ref{29c,,PyThread_tss_alloc()} instead.

@item 
@ref{29d,,PyThread_delete_key()}:
Use @ref{29e,,PyThread_tss_free()} instead.

@item 
@ref{29f,,PyThread_set_key_value()}:
Use @ref{2a0,,PyThread_tss_set()} instead.

@item 
@ref{2a1,,PyThread_get_key_value()}:
Use @ref{2a2,,PyThread_tss_get()} instead.

@item 
@ref{2a3,,PyThread_delete_key_value()}:
Use @ref{2a4,,PyThread_tss_delete()} instead.

@item 
@ref{2a5,,PyThread_ReInitTLS()}:
Unneeded since Python 3.7.
@end itemize
@end itemize

@node Removed<2>,,Deprecated<2>,C API changes
@anchor{whatsnew/3 14 id10}@anchor{2a6}
@subsubsection Removed



@itemize *

@item 
Creating @ref{2a7,,immutable types} with mutable
bases was deprecated since 3.12 and now raises a @ref{228,,TypeError}.
@end itemize

@node What’s New In Python 3 13,Novedades de Python 3 12,What’s new in Python 3 14,Qué hay de nuevo en Python
@anchor{whatsnew/3 13 doc}@anchor{2a8}@anchor{whatsnew/3 13 what-s-new-in-python-3-13}@anchor{2a9}
@section What’s New In Python 3.13


@*Editors: 
Adam Turner and Thomas Wouters


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log
@c when researching a change.

This article explains the new features in Python 3.13, compared to 3.12.
Python 3.13 was released on October 7, 2024.
For full details, see the @ref{13b,,changelog}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 719
PEP 719@footnote{https://peps.python.org/pep-0719/} – Python 3.13 Release Schedule


@menu
* Summary – Release Highlights:: 
* New Features:: 
* Other Language Changes:: 
* New Modules:: 
* Improved Modules:: 
* Optimizations: Optimizations<2>. 
* Removed Modules And APIs:: 
* New Deprecations:: 
* CPython Bytecode Changes:: 
* C API Changes:: 
* Build Changes:: 
* Porting to Python 3.13: Porting to Python 3 13. 
* Regression Test Changes:: 

@end menu

@node Summary – Release Highlights,New Features,,What’s New In Python 3 13
@anchor{whatsnew/3 13 summary-release-highlights}@anchor{2aa}
@subsection Summary – Release Highlights


@c This section singles out the most important changes in Python 3.13.
@c Brevity is key.

Python 3.13 is the latest stable release of the Python programming
language, with a mix of changes to the language, the implementation
and the standard library.
The biggest changes include a new @ref{2ab,,interactive interpreter}@anchor{whatsnew/3 13 whatsnew313-better-interactive-interpreter}@anchor{2ab},
experimental support for running in a @ref{2ac,,free-threaded mode}@anchor{whatsnew/3 13 whatsnew313-free-threaded-cpython}@anchor{2ac} (
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}),
and a @ref{2ad,,Just-In-Time compiler}@anchor{whatsnew/3 13 whatsnew313-jit-compiler}@anchor{2ad} (
@geindex Python Enhancement Proposals; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}).

Error messages continue to improve, with tracebacks now highlighted in color
by default. The @ref{2ae,,locals()} builtin now has @ref{2af,,defined semantics} for changing the returned mapping,
and type parameters now support default values.

The library changes contain removal of deprecated APIs and modules,
as well as the usual improvements in user-friendliness and correctness.
Several legacy standard library modules have now @ref{2b0,,been removed}@anchor{whatsnew/3 13 whatsnew313-pep594}@anchor{2b0} following their deprecation in Python 3.11 (
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}).

This article doesn’t attempt to provide a complete specification
of all new features, but instead gives a convenient overview.
For full details refer to the documentation,
such as the @ref{2b1,,Library Reference}
and @ref{2b2,,Language Reference}.
To understand the complete implementation and design rationale for a change,
refer to the PEP for a particular new feature;
but note that PEPs usually are not kept up-to-date
once a feature has been fully implemented.
See @ref{2b3,,Porting to Python 3.13} for guidance on upgrading from
earlier versions of Python.


__________________________________________________________________


@c PEP-sized items next.

Interpreter improvements:


@itemize *

@item 
A greatly improved @ref{2ab,,interactive interpreter} and
@ref{2b4,,improved error messages}.

@item 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}: The @ref{2ae,,locals()} builtin now has
@ref{2af,,defined semantics} when mutating the
returned mapping. Python debuggers and similar tools may now more reliably
update local variables in optimized scopes even during concurrent code
execution.

@item 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}: CPython 3.13 has experimental support for running with the
@ref{2b5,,global interpreter lock} disabled. See @ref{2ac,,Free-threaded CPython} for more details.

@item 
@geindex Python Enhancement Proposals; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}: A basic @ref{2ad,,JIT compiler} was added.
It is currently disabled by default (though we may turn it on later).
Performance improvements are modest – we expect to improve this
over the next few releases.

@item 
Color support in the new @ref{2ab,,interactive interpreter},
as well as in @ref{2b4,,tracebacks}
and @ref{2b6,,doctest} output.
This can be disabled through the 
@geindex PYTHON_COLORS
@geindex variables de entorno; PYTHON_COLORS
@ref{2b7,,PYTHON_COLORS} and NO_COLOR@footnote{https://no-color.org/}
environment variables.
@end itemize

Python data model improvements:


@itemize *

@item 
@ref{2b8,,__static_attributes__} stores the names of attributes accessed
through @code{self.X} in any function in a class body.

@item 
@ref{2b9,,__firstlineno__} records the first line number of a class
definition.
@end itemize

Significant improvements in the standard library:


@itemize *

@item 
Add a new @ref{2ba,,PythonFinalizationError} exception, raised when an operation
is blocked during @ref{2bb,,finalization}.

@item 
The @ref{7,,argparse} module now supports deprecating command-line options,
positional arguments, and subcommands.

@item 
The new functions @ref{2bc,,base64.z85encode()} and @ref{2bd,,base64.z85decode()}
support encoding and decoding Z85 data@footnote{https://rfc.zeromq.org/spec/32/}.

@item 
The @ref{26,,copy} module now has a @ref{15f,,copy.replace()} function,
with support for many builtin types and any class defining
the @ref{2be,,__replace__()} method.

@item 
The new @ref{36,,dbm.sqlite3} module is now the default @ref{32,,dbm} backend.

@item 
The @ref{a1,,os} module has a @ref{2bf,,suite of new functions}
for working with Linux’s timer notification file descriptors.

@item 
The @ref{b8,,random} module now has a @ref{2c0,,command-line interface}.
@end itemize

Security improvements:


@itemize *

@item 
@ref{2c1,,ssl.create_default_context()} sets @ref{2c2,,ssl.VERIFY_X509_PARTIAL_CHAIN}
and @ref{2c3,,ssl.VERIFY_X509_STRICT} as default flags.
@end itemize

C API improvements:


@itemize *

@item 
The @ref{2c4,,Py_mod_gil} slot is now used to indicate that
an extension module supports running with the @ref{2c5,,GIL} disabled.

@item 
The @ref{2c6,,PyTime C API} has been added,
providing access to system clocks.

@item 
@ref{2c7,,PyMutex} is a new lightweight mutex that occupies a single byte.

@item 
There is a new @ref{2c8,,suite of functions}
for generating 
@geindex Python Enhancement Proposals; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} monitoring events in the C API.
@end itemize

New typing features:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}: Type parameters (@ref{2c9,,typing.TypeVar}, @ref{2ca,,typing.ParamSpec},
and @ref{2cb,,typing.TypeVarTuple}) now support defaults.

@item 
@geindex Python Enhancement Proposals; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: The new @ref{2cc,,warnings.deprecated()} decorator adds support
for marking deprecations in the type system and at runtime.

@item 
@geindex Python Enhancement Proposals; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: @ref{2cd,,typing.ReadOnly} can be used to mark an item of a
@ref{2ce,,typing.TypedDict} as read-only for type checkers.

@item 
@geindex Python Enhancement Proposals; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: @ref{2cf,,typing.TypeIs} provides more intuitive
type narrowing behavior, as an alternative to @ref{2d0,,typing.TypeGuard}.
@end itemize

Platform support:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: Apple’s iOS is now an @ref{2d1,,officially supported platform}, at 
@geindex Python Enhancement Proposals; PEP 11#tier-3
tier 3@footnote{https://peps.python.org/pep-0011/#tier-3}.

@item 
@geindex Python Enhancement Proposals; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: Android is now an @ref{2d1,,officially supported platform}, at 
@geindex Python Enhancement Proposals; PEP 11#tier-3
tier 3@footnote{https://peps.python.org/pep-0011/#tier-3}.

@item 
@code{wasm32-wasi} is now supported as a 
@geindex Python Enhancement Proposals; PEP 11#tier-2
tier 2@footnote{https://peps.python.org/pep-0011/#tier-2} platform.

@item 
@code{wasm32-emscripten} is no longer an officially supported platform.
@end itemize

Important removals:


@itemize *

@item 
@ref{2b0,,PEP 594}: The remaining 19 «dead batteries»
(legacy stdlib modules) have been removed from the standard library:
@code{aifc}, @code{audioop}, @code{cgi}, @code{cgitb}, @code{chunk},
@code{crypt}, @code{imghdr}, @code{mailcap}, @code{msilib}, @code{nis},
@code{nntplib}, @code{ossaudiodev}, @code{pipes}, @code{sndhdr},
@code{spwd}, @code{sunau}, @code{telnetlib}, @code{uu} and @code{xdrlib}.

@item 
Remove the @code{2to3} tool and @code{lib2to3} module
(deprecated in Python 3.11).

@item 
Remove the @code{tkinter.tix} module (deprecated in Python 3.6).

@item 
Remove the @code{locale.resetlocale()} function.

@item 
Remove the @code{typing.io} and @code{typing.re} namespaces.

@item 
Remove chained @ref{2d2,,classmethod} descriptors.
@end itemize

Release schedule changes:

@geindex Python Enhancement Proposals; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/} («Annual Release Cycle for Python») has been updated
to extend the full support (“bugfix”) period for new releases to two years.
This updated policy means that:


@itemize *

@item 
Python 3.9–3.12 have one and a half years of full support,
followed by three and a half years of security fixes.

@item 
Python 3.13 and later have two years of full support,
followed by three years of security fixes.
@end itemize

@node New Features,Other Language Changes,Summary – Release Highlights,What’s New In Python 3 13
@anchor{whatsnew/3 13 new-features}@anchor{2d3}
@subsection New Features


@menu
* A better interactive interpreter:: 
* Improved error messages: Improved error messages<2>. 
* Free-threaded CPython:: 
* An experimental just-in-time (JIT) compiler: An experimental just-in-time JIT compiler. 
* Defined mutation semantics for locals(): Defined mutation semantics for locals. 
* Support for mobile platforms:: 

@end menu

@node A better interactive interpreter,Improved error messages<2>,,New Features
@anchor{whatsnew/3 13 a-better-interactive-interpreter}@anchor{2d4}
@subsubsection A better interactive interpreter


Python now uses a new @ref{2d5,,interactive} shell by default, based on code
from the PyPy project@footnote{https://pypy.org/}.
When the user starts the @ref{2d6,,REPL} from an interactive terminal,
the following new features are now supported:


@itemize *

@item 
Multiline editing with history preservation.

@item 
Direct support for REPL-specific commands like @code{help}, @code{exit},
and @code{quit}, without the need to call them as functions.

@item 
Prompts and tracebacks with @ref{2d7,,color enabled by default}.

@item 
Interactive help browsing using @code{F1} with a separate command
history.

@item 
History browsing using @code{F2} that skips output as well as the
@ref{2d8,,>>>} and @ref{2d9,,…} prompts.

@item 
«Paste mode» with @code{F3} that makes pasting larger blocks of code
easier (press @code{F3} again to return to the regular prompt).
@end itemize

To disable the new interactive shell,
set the 
@geindex PYTHON_BASIC_REPL
@geindex variables de entorno; PYTHON_BASIC_REPL
@ref{2da,,PYTHON_BASIC_REPL} environment variable.
For more on interactive mode, see @ref{2db,,Modo interactivo}.

(Contributed by Pablo Galindo Salgado, Łukasz Langa, and
Lysandros Nikolaou in gh-111201@footnote{https://github.com/python/cpython/issues/111201} based on code from the PyPy project.
Windows support contributed by Dino Viehland and Anthony Shaw.)

@node Improved error messages<2>,Free-threaded CPython,A better interactive interpreter,New Features
@anchor{whatsnew/3 13 improved-error-messages}@anchor{2dc}@anchor{whatsnew/3 13 whatsnew313-improved-error-messages}@anchor{2b4}
@subsubsection Improved error messages



@itemize *

@item 
The interpreter now uses color by default when displaying tracebacks in the
terminal. This feature @ref{2d7,,can be controlled}
via the new 
@geindex PYTHON_COLORS
@geindex variables de entorno; PYTHON_COLORS
@ref{2b7,,PYTHON_COLORS} environment variable as well as
the canonical NO_COLOR@footnote{https://no-color.org/} and FORCE_COLOR@footnote{https://force-color.org/} environment variables.
(Contributed by Pablo Galindo Salgado in gh-112730@footnote{https://github.com/python/cpython/issues/112730}.)
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)


@itemize *

@item 
A common mistake is to write a script with the same name as a
standard library module. When this results in errors, we now
display a more helpful error message:

@example
$ python random.py
Traceback (most recent call last):
  File "/home/me/random.py", line 1, in <module>
    import random
  File "/home/me/random.py", line 3, in <module>
    print(random.randint(5))
          ^^^^^^^^^^^^^^
AttributeError: module 'random' has no attribute 'randint' (consider renaming '/home/me/random.py' since it has the same name as the standard library module named 'random' and prevents importing that standard library module)
@end example

Similarly, if a script has the same name as a third-party
module that it attempts to import and this results in errors,
we also display a more helpful error message:

@example
$ python numpy.py
Traceback (most recent call last):
  File "/home/me/numpy.py", line 1, in <module>
    import numpy as np
  File "/home/me/numpy.py", line 3, in <module>
    np.array([1, 2, 3])
    ^^^^^^^^
AttributeError: module 'numpy' has no attribute 'array' (consider renaming '/home/me/numpy.py' if it has the same name as a library you intended to import)
@end example

(Contributed by Shantanu Jain in gh-95754@footnote{https://github.com/python/cpython/issues/95754}.)

@item 
The error message now tries to suggest the correct keyword argument
when an incorrect keyword argument is passed to a function.

@example
>>> "Better error messages!".split(max_split=1)
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    "Better error messages!".split(max_split=1)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
TypeError: split() got an unexpected keyword argument 'max_split'. Did you mean 'maxsplit'?
@end example

(Contributed by Pablo Galindo Salgado and Shantanu Jain in gh-107944@footnote{https://github.com/python/cpython/issues/107944}.)
@end itemize

@node Free-threaded CPython,An experimental just-in-time JIT compiler,Improved error messages<2>,New Features
@anchor{whatsnew/3 13 free-threaded-cpython}@anchor{2dd}
@subsubsection Free-threaded CPython


CPython now has experimental support for running in a free-threaded mode,
with the @ref{2b5,,global interpreter lock} (GIL) disabled.
This is an experimental feature and therefore is not enabled by default.
The free-threaded mode requires a different executable,
usually called @code{python3.13t} or @code{python3.13t.exe}.
Pre-built binaries marked as `free-threaded' can be installed as part of
the official @ref{2de,,Windows}
and @ref{2df,,macOS} installers,
or CPython can be built from source with the @ref{2e0,,--disable-gil} option.

Free-threaded execution allows for full utilization of the available
processing power by running threads in parallel on available CPU cores.
While not all software will benefit from this automatically, programs
designed with threading in mind will run faster on multi-core hardware.
`The free-threaded mode is experimental' and work is ongoing to improve it:
expect some bugs and a substantial single-threaded performance hit.
Free-threaded builds of CPython support optionally running with the GIL
enabled at runtime using the environment variable 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL} or
the command-line option @ref{2e2,,-X gil=1}.

To check if the current interpreter supports free-threading, @ref{2e3,,python -VV}
and @ref{2e4,,sys.version} contain «experimental free-threading build».
The new @code{sys._is_gil_enabled()} function can be used to check whether
the GIL is actually disabled in the running process.

C-API extension modules need to be built specifically for the free-threaded
build. Extensions that support running with the @ref{2c5,,GIL} disabled should
use the @ref{2c4,,Py_mod_gil} slot. Extensions using single-phase init should
use @ref{2e5,,PyUnstable_Module_SetGIL()} to indicate whether they support
running with the GIL disabled. Importing C extensions that don’t use these
mechanisms will cause the GIL to be enabled, unless the GIL was explicitly
disabled with the 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL} environment variable or the
@ref{2e2,,-X gil=0} option.
pip 24.1 or newer is required to install packages with C extensions in the
free-threaded build.

This work was made possible thanks to many individuals and
organizations, including the large community of contributors to Python
and third-party projects to test and enable free-threading support.
Notable contributors include:
Sam Gross, Ken Jin, Donghee Na, Itamar Oren, Matt Page, Brett Simmers,
Dino Viehland, Carl Meyer, Nathan Goldbaum, Ralf Gommers,
Lysandros Nikolaou, and many others.
Many of these contributors are employed by Meta, which has
provided significant engineering resources to support this project.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} «Making the Global Interpreter Lock Optional in CPython»
contains rationale and information surrounding this work.

Porting Extension Modules to Support Free-Threading@footnote{https://py-free-threading.github.io/porting/}: A community-maintained
porting guide for extension authors.


@node An experimental just-in-time JIT compiler,Defined mutation semantics for locals,Free-threaded CPython,New Features
@anchor{whatsnew/3 13 an-experimental-just-in-time-jit-compiler}@anchor{2e6}
@subsubsection An experimental just-in-time (JIT) compiler


When CPython is configured and built using
the @code{--enable-experimental-jit} option,
a just-in-time (JIT) compiler is added which may speed up some Python programs.
On Windows, use @code{PCbuild/build.bat --experimental-jit} to enable the JIT
or @code{--experimental-jit-interpreter} to enable the Tier 2 interpreter.
Build requirements and further supporting information are contained at@footnote{https://github.com/python/cpython/blob/main/Tools/jit/README.md}
@code{Tools/jit/README.md}.

The @code{--enable-experimental-jit} option takes these (optional) values,
defaulting to @code{yes} if @code{--enable-experimental-jit} is present
without the optional value.


@itemize *

@item 
@code{no}: Disable the entire Tier 2 and JIT pipeline.

@item 
@code{yes}: Enable the JIT.
To disable the JIT at runtime, pass the environment variable @code{PYTHON_JIT=0}.

@item 
@code{yes-off}: Build the JIT but disable it by default.
To enable the JIT at runtime, pass the environment variable @code{PYTHON_JIT=1}.

@item 
@code{interpreter}: Enable the Tier 2 interpreter but disable the JIT.
The interpreter can be disabled by running with @code{PYTHON_JIT=0}.
@end itemize

The internal architecture is roughly as follows:


@itemize *

@item 
We start with specialized `Tier 1 bytecode'.
See @ref{2e7,,What’s new in 3.11} for details.

@item 
When the Tier 1 bytecode gets hot enough, it gets translated
to a new purely internal intermediate representation (IR),
called the `Tier 2 IR', and sometimes referred to as micro-ops («uops»).

@item 
The Tier 2 IR uses the same stack-based virtual machine as Tier 1,
but the instruction format is better suited to translation to machine code.

@item 
We have several optimization passes for Tier 2 IR, which are applied
before it is interpreted or translated to machine code.

@item 
There is a Tier 2 interpreter, but it is mostly intended for debugging
the earlier stages of the optimization pipeline.
The Tier 2 interpreter can be enabled by configuring Python
with @code{--enable-experimental-jit=interpreter}.

@item 
When the JIT is enabled, the optimized
Tier 2 IR is translated to machine code, which is then executed.

@item 
The machine code translation process uses a technique called
`copy-and-patch'. It has no runtime dependencies, but there is a new
build-time dependency on LLVM.
@end itemize


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}


(JIT by Brandt Bucher, inspired by a paper by Haoran Xu and Fredrik Kjolstad.
Tier 2 IR by Mark Shannon and Guido van Rossum.
Tier 2 optimizer by Ken Jin.)

@node Defined mutation semantics for locals,Support for mobile platforms,An experimental just-in-time JIT compiler,New Features
@anchor{whatsnew/3 13 defined-mutation-semantics-for-locals}@anchor{2e8}@anchor{whatsnew/3 13 whatsnew313-locals-semantics}@anchor{2af}
@subsubsection Defined mutation semantics for @code{locals()}


Historically, the expected result of mutating the return value of
@ref{2ae,,locals()} has been left to individual Python implementations to define.
Starting from Python 3.13, 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} standardises
the historical behavior of CPython for most code execution scopes,
but changes @ref{2e9,,optimized scopes}
(functions, generators, coroutines, comprehensions, and generator expressions)
to explicitly return independent snapshots of the currently assigned local
variables, including locally referenced nonlocal variables captured in closures.

This change to the semantics of @ref{2ae,,locals()} in optimized scopes also
affects the default behavior of code execution functions that implicitly
target @code{locals()} if no explicit namespace is provided
(such as @ref{2ea,,exec()} and @ref{2eb,,eval()}).
In previous versions, whether or not changes could be accessed by calling
@code{locals()} after calling the code execution function was
implementation-dependent. In CPython specifically, such code would typically
appear to work as desired, but could sometimes fail in optimized scopes based
on other code (including debuggers and code execution tracing tools)
potentially resetting the shared snapshot in that scope.
Now, the code will always run against an independent snapshot of
the local variables in optimized scopes, and hence the changes will never
be visible in subsequent calls to @code{locals()}.
To access the changes made in these cases, an explicit namespace reference
must now be passed to the relevant function.
Alternatively, it may make sense to update affected code to use a higher level
code execution API that returns the resulting code execution namespace
(e.g. @ref{2ec,,runpy.run_path()} when executing Python files from disk).

To ensure debuggers and similar tools can reliably update local variables in
scopes affected by this change, @ref{2ed,,FrameType.f_locals} now
returns a write-through proxy to the frame’s local and locally referenced
nonlocal variables in these scopes, rather than returning an inconsistently
updated shared @code{dict} instance with undefined runtime semantics.

See 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} for more details, including related C API changes
and deprecations. Porting notes are also provided below for the affected
@ref{2ee,,Python APIs} and @ref{2ef,,C APIs}.

(PEP and implementation contributed by Mark Shannon and Tian Gao in
gh-74929@footnote{https://github.com/python/cpython/issues/74929}. Documentation updates provided by Guido van Rossum and
Alyssa Coghlan.)

@node Support for mobile platforms,,Defined mutation semantics for locals,New Features
@anchor{whatsnew/3 13 support-for-mobile-platforms}@anchor{2f0}@anchor{whatsnew/3 13 whatsnew313-platform-support}@anchor{2d1}
@subsubsection Support for mobile platforms


@geindex Python Enhancement Proposals; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: iOS is now a 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} supported platform, with the
@code{arm64-apple-ios} and @code{arm64-apple-ios-simulator} targets at tier 3
(iPhone and iPad devices released after 2013 and the Xcode iOS simulator
running on Apple silicon hardware, respectively).
@code{x86_64-apple-ios-simulator}
(the Xcode iOS simulator running on older @code{x86_64} hardware)
is not a tier 3 supported platform, but will have best-effort support.
(PEP written and implementation contributed by Russell Keith-Magee in
gh-114099@footnote{https://github.com/python/cpython/issues/114099}.)

@geindex Python Enhancement Proposals; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: Android is now a 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} supported platform, with the
@code{aarch64-linux-android} and @code{x86_64-linux-android} targets at tier 3.
The 32-bit targets @code{arm-linux-androideabi} and @code{i686-linux-android}
are not tier 3 supported platforms, but will have best-effort support.
(PEP written and implementation contributed by Malcolm Smith in
gh-116622@footnote{https://github.com/python/cpython/issues/116622}.)


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}, 
@geindex Python Enhancement Proposals; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}


@node Other Language Changes,New Modules,New Features,What’s New In Python 3 13
@anchor{whatsnew/3 13 other-language-changes}@anchor{2f1}
@subsection Other Language Changes



@itemize *

@item 
The compiler now strips common leading whitespace
from every line in a docstring.
This reduces the size of the @ref{2f2,,bytecode cache}
(such as @code{.pyc} files), with reductions in file size of around 5%,
for example in @code{sqlalchemy.orm.session} from SQLAlchemy 2.0.
This change affects tools that use docstrings, such as @ref{3b,,doctest}.

@example
>>> def spam():
...     """
...         This is a docstring with
...           leading whitespace.
...
...         It even has multiple paragraphs!
...     """
...
>>> spam.__doc__
'\nThis is a docstring with\n  leading whitespace.\n\nIt even has multiple paragraphs!\n'
@end example

(Contributed by Inada Naoki in gh-81283@footnote{https://github.com/python/cpython/issues/81283}.)

@item 
@ref{2f3,,Annotation scopes} within class scopes
can now contain lambdas and comprehensions.
Comprehensions that are located within class scopes
are not inlined into their parent scope.

@example
class C[T]:
    type Alias = lambda: T
@end example

(Contributed by Jelle Zijlstra in gh-109118@footnote{https://github.com/python/cpython/issues/109118} and gh-118160@footnote{https://github.com/python/cpython/issues/118160}.)

@item 
@ref{2f4,,Future statements} are no longer triggered by
relative imports of the @ref{0,,__future__} module,
meaning that statements of the form @code{from .__future__ import ...}
are now simply standard relative imports, with no special features activated.
(Contributed by Jeremiah Gabriel Pascual in gh-118216@footnote{https://github.com/python/cpython/issues/118216}.)

@item 
@ref{2f5,,global} declarations are now permitted in @ref{2f6,,except} blocks
when that global is used in the @ref{1ea,,else} block.
Previously this raised an erroneous @ref{150,,SyntaxError}.
(Contributed by Irit Katriel in gh-111123@footnote{https://github.com/python/cpython/issues/111123}.)

@item 
Add 
@geindex PYTHON_FROZEN_MODULES
@geindex variables de entorno; PYTHON_FROZEN_MODULES
@ref{2f7,,PYTHON_FROZEN_MODULES}, a new environment variable that
determines whether frozen modules are ignored by the import machinery,
equivalent to the @ref{2e2,,-X frozen_modules} command-line option.
(Contributed by Yilei Yang in gh-111374@footnote{https://github.com/python/cpython/issues/111374}.)

@item 
Add @ref{2f8,,support for the perf profiler} working
without frame pointers@footnote{https://en.wikipedia.org/wiki/Call_stack} through
the new environment variable 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variables de entorno; PYTHON_PERF_JIT_SUPPORT
@ref{2f9,,PYTHON_PERF_JIT_SUPPORT}
and command-line option @ref{2e2,,-X perf_jit}.
(Contributed by Pablo Galindo in gh-118518@footnote{https://github.com/python/cpython/issues/118518}.)

@item 
The location of a @code{.python_history} file can be changed via the
new 
@geindex PYTHON_HISTORY
@geindex variables de entorno; PYTHON_HISTORY
@ref{2fa,,PYTHON_HISTORY} environment variable.
(Contributed by Levi Sabah, Zackery Spytz and Hugo van Kemenade
in gh-73965@footnote{https://github.com/python/cpython/issues/73965}.)

@item 
Classes have a new @ref{2b8,,__static_attributes__} attribute.
This is populated by the compiler with a tuple of the class’s attribute names
which are assigned through @code{self.<name>} from any function in its body.
(Contributed by Irit Katriel in gh-115775@footnote{https://github.com/python/cpython/issues/115775}.)

@item 
The compiler now creates a @code{__firstlineno__} attribute on classes
with the line number of the first line of the class definition.
(Contributed by Serhiy Storchaka in gh-118465@footnote{https://github.com/python/cpython/issues/118465}.)

@item 
The @ref{2ea,,exec()} and @ref{2eb,,eval()} builtins now accept
the `globals' and `locals' arguments as keywords.
(Contributed by Raphael Gaschignard in gh-105879@footnote{https://github.com/python/cpython/issues/105879})

@item 
The @ref{2fb,,compile()} builtin now accepts a new flag,
@code{ast.PyCF_OPTIMIZED_AST}, which is similar to @code{ast.PyCF_ONLY_AST}
except that the returned AST is optimized according to
the value of the `optimize' argument.
(Contributed by Irit Katriel in gh-108113@footnote{https://github.com/python/cpython/issues/108113}).

@item 
Add a @ref{2fc,,__name__} attribute on @ref{2fd,,property} objects.
(Contributed by Eugene Toder in gh-101860@footnote{https://github.com/python/cpython/issues/101860}.)

@item 
Add @ref{2ba,,PythonFinalizationError}, a new exception derived from
@ref{1e5,,RuntimeError} and used to signal when operations are blocked
during @ref{2bb,,finalization}.
The following callables now raise @code{PythonFinalizationError},
instead of @ref{1e5,,RuntimeError}:


@itemize *

@item 
@ref{2fe,,_thread.start_new_thread()}

@item 
@ref{2ff,,os.fork()}

@item 
@ref{300,,os.forkpty()}

@item 
@ref{301,,subprocess.Popen}
@end itemize

(Contributed by Victor Stinner in gh-114570@footnote{https://github.com/python/cpython/issues/114570}.)

@item 
Allow the `count' argument of @ref{302,,str.replace()} to be a keyword.
(Contributed by Hugo van Kemenade in gh-106487@footnote{https://github.com/python/cpython/issues/106487}.)

@item 
Many functions now emit a warning if a boolean value is passed as
a file descriptor argument.
This can help catch some errors earlier.
(Contributed by Serhiy Storchaka in gh-82626@footnote{https://github.com/python/cpython/issues/82626}.)

@item 
Added @code{name} and @code{mode} attributes
for compressed and archived file-like objects in
the @ref{14,,bz2}, @ref{8a,,lzma}, @ref{de,,tarfile}, and @ref{130,,zipfile} modules.
(Contributed by Serhiy Storchaka in gh-115961@footnote{https://github.com/python/cpython/issues/115961}.)
@end itemize

@node New Modules,Improved Modules,Other Language Changes,What’s New In Python 3 13
@anchor{whatsnew/3 13 new-modules}@anchor{303}
@subsection New Modules



@itemize *

@item 
@ref{36,,dbm.sqlite3}: An SQLite backend for @ref{32,,dbm}.
(Contributed by Raymond Hettinger and Erlend E. Aasland in gh-100414@footnote{https://github.com/python/cpython/issues/100414}.)
@end itemize

@node Improved Modules,Optimizations<2>,New Modules,What’s New In Python 3 13
@anchor{whatsnew/3 13 improved-modules}@anchor{304}
@subsection Improved Modules


@menu
* argparse: argparse<3>. 
* array:: 
* ast: ast<3>. 
* asyncio: asyncio<3>. 
* base64:: 
* compileall:: 
* concurrent.futures: concurrent futures<2>. 
* configparser:: 
* copy:: 
* ctypes: ctypes<2>. 
* dbm:: 
* dis: dis<2>. 
* doctest:: 
* email: email<2>. 
* fractions: fractions<2>. 
* glob:: 
* importlib: importlib<2>. 
* io: io<2>. 
* ipaddress:: 
* itertools: itertools<2>. 
* marshal:: 
* math:: 
* mimetypes: mimetypes<2>. 
* mmap:: 
* multiprocessing: multiprocessing<2>. 
* os: os<2>. 
* os.path: os path. 
* pathlib: pathlib<3>. 
* pdb: pdb<2>. 
* queue:: 
* random:: 
* re:: 
* shutil:: 
* site:: 
* sqlite3: sqlite3<2>. 
* ssl:: 
* statistics:: 
* subprocess:: 
* sys: sys<2>. 
* tempfile:: 
* time:: 
* tkinter:: 
* traceback:: 
* types:: 
* typing: typing<2>. 
* unicodedata: unicodedata<2>. 
* venv:: 
* warnings:: 
* xml:: 
* zipimport:: 

@end menu

@node argparse<3>,array,,Improved Modules
@anchor{whatsnew/3 13 argparse}@anchor{305}
@subsubsection argparse



@itemize *

@item 
Add the `deprecated' parameter to the
@ref{306,,add_argument()}
and @code{add_parser()} methods, to enable deprecating
command-line options, positional arguments, and subcommands.
(Contributed by Serhiy Storchaka in gh-83648@footnote{https://github.com/python/cpython/issues/83648}.)
@end itemize

@node array,ast<3>,argparse<3>,Improved Modules
@anchor{whatsnew/3 13 array}@anchor{307}
@subsubsection array



@itemize *

@item 
Add the @code{'w'} type code (@code{Py_UCS4}) for Unicode characters.
It should be used instead of the deprecated @code{'u'} type code.
(Contributed by Inada Naoki in gh-80480@footnote{https://github.com/python/cpython/issues/80480}.)

@item 
Register @ref{308,,array.array} as a @ref{309,,MutableSequence}
by implementing the @ref{30a,,clear()} method.
(Contributed by Mike Zimin in gh-114894@footnote{https://github.com/python/cpython/issues/114894}.)
@end itemize

@node ast<3>,asyncio<3>,array,Improved Modules
@anchor{whatsnew/3 13 ast}@anchor{30b}
@subsubsection ast



@itemize *

@item 
The constructors of node types in the @ref{9,,ast} module are now
stricter in the arguments they accept,
with more intuitive behavior when arguments are omitted.

If an optional field on an AST node is not included as an argument when
constructing an instance, the field will now be set to @code{None}. Similarly,
if a list field is omitted, that field will now be set to an empty list,
and if an @code{expr_context} field is omitted, it defaults to
@ref{30c,,Load()}.
(Previously, in all cases, the attribute would be missing on the newly
constructed AST node instance.)

In all other cases, where a required argument is omitted,
the node constructor will emit a @ref{1da,,DeprecationWarning}.
This will raise an exception in Python 3.15.
Similarly, passing a keyword argument to the constructor
that does not map to a field on the AST node is now deprecated,
and will raise an exception in Python 3.15.

These changes do not apply to user-defined subclasses of @ref{30d,,ast.AST}
unless the class opts in to the new behavior
by defining the @ref{30e,,AST._field_types} mapping.

(Contributed by Jelle Zijlstra in gh-105858@footnote{https://github.com/python/cpython/issues/105858}, gh-117486@footnote{https://github.com/python/cpython/issues/117486}, and gh-118851@footnote{https://github.com/python/cpython/issues/118851}.)

@item 
@ref{30f,,ast.parse()} now accepts an optional argument `optimize'
which is passed on to @ref{2fb,,compile()}.
This makes it possible to obtain an optimized AST.
(Contributed by Irit Katriel in gh-108113@footnote{https://github.com/python/cpython/issues/108113}.)
@end itemize

@node asyncio<3>,base64,ast<3>,Improved Modules
@anchor{whatsnew/3 13 asyncio}@anchor{310}
@subsubsection asyncio



@itemize *

@item 
@ref{311,,asyncio.as_completed()} now returns an object that is both an
@ref{312,,asynchronous iterator} and a plain @ref{313,,iterator}
of @ref{314,,awaitables}.
The awaitables yielded by asynchronous iteration include original task
or future objects that were passed in,
making it easier to associate results with the tasks being completed.
(Contributed by Justin Arthur in gh-77714@footnote{https://github.com/python/cpython/issues/77714}.)

@item 
@ref{315,,asyncio.loop.create_unix_server()} will now automatically remove
the Unix socket when the server is closed.
(Contributed by Pierre Ossman in gh-111246@footnote{https://github.com/python/cpython/issues/111246}.)

@item 
@ref{316,,DatagramTransport.sendto()} will now send zero-length
datagrams if called with an empty bytes object.
The transport flow control also now accounts for the datagram header
when calculating the buffer size.
(Contributed by Jamie Phan in gh-115199@footnote{https://github.com/python/cpython/issues/115199}.)

@item 
Add @ref{317,,Queue.shutdown}
and @ref{318,,QueueShutDown} to manage queue termination.
(Contributed by Laurie Opperman and Yves Duprat in gh-104228@footnote{https://github.com/python/cpython/issues/104228}.)

@item 
Add the @ref{319,,Server.close_clients()} and @ref{31a,,Server.abort_clients()}
methods, which more forcefully close an asyncio server.
(Contributed by Pierre Ossman in gh-113538@footnote{https://github.com/python/cpython/issues/113538}.)

@item 
Accept a tuple of separators in @ref{31b,,StreamReader.readuntil()},
stopping when any one of them is encountered.
(Contributed by Bruce Merry in gh-81322@footnote{https://github.com/python/cpython/issues/81322}.)

@item 
Improve the behavior of @ref{31c,,TaskGroup} when
an external cancellation collides with an internal cancellation.
For example, when two task groups are nested
and both experience an exception in a child task simultaneously,
it was possible that the outer task group would hang,
because its internal cancellation was swallowed by the inner task group.

In the case where a task group is cancelled externally
and also must raise an @ref{31d,,ExceptionGroup},
it will now call the parent task’s @ref{31e,,cancel()} method.
This ensures that a @ref{31f,,CancelledError} will be raised
at the next @ref{14e,,await}, so the cancellation is not lost.

An added benefit of these changes is that task groups now preserve
the cancellation count (@ref{320,,cancelling()}).

In order to handle some corner cases, @ref{321,,uncancel()} may now
reset the undocumented @code{_must_cancel} flag
when the cancellation count reaches zero.

(Inspired by an issue reported by Arthur Tacca in gh-116720@footnote{https://github.com/python/cpython/issues/116720}.)

@item 
When @ref{322,,TaskGroup.create_task()} is called on an inactive
@ref{31c,,TaskGroup}, the given coroutine will be closed (which
prevents a @ref{323,,RuntimeWarning} about the given coroutine being
never awaited).
(Contributed by Arthur Tacca and Jason Zhang in gh-115957@footnote{https://github.com/python/cpython/issues/115957}.)
@end itemize

@node base64,compileall,asyncio<3>,Improved Modules
@anchor{whatsnew/3 13 base64}@anchor{324}
@subsubsection base64



@itemize *

@item 
Add @ref{2bc,,z85encode()} and @ref{2bd,,z85decode()} functions
for encoding @ref{325,,bytes} as Z85 data@footnote{https://rfc.zeromq.org/spec/32/}
and decoding Z85-encoded data to @code{bytes}.
(Contributed by Matan Perelman in gh-75299@footnote{https://github.com/python/cpython/issues/75299}.)
@end itemize

@node compileall,concurrent futures<2>,base64,Improved Modules
@anchor{whatsnew/3 13 compileall}@anchor{326}
@subsubsection compileall



@itemize *

@item 
The default number of worker threads and processes is now selected using
@ref{327,,os.process_cpu_count()} instead of @ref{328,,os.cpu_count()}.
(Contributed by Victor Stinner in gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node concurrent futures<2>,configparser,compileall,Improved Modules
@anchor{whatsnew/3 13 concurrent-futures}@anchor{329}
@subsubsection concurrent.futures



@itemize *

@item 
The default number of worker threads and processes is now selected using
@ref{327,,os.process_cpu_count()} instead of @ref{328,,os.cpu_count()}.
(Contributed by Victor Stinner in gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node configparser,copy,concurrent futures<2>,Improved Modules
@anchor{whatsnew/3 13 configparser}@anchor{32a}
@subsubsection configparser



@itemize *

@item 
@ref{32b,,ConfigParser} now has support for unnamed sections,
which allows for top-level key-value pairs.
This can be enabled with the new `allow_unnamed_section' parameter.
(Contributed by Pedro Sousa Lacerda in gh-66449@footnote{https://github.com/python/cpython/issues/66449}.)
@end itemize

@node copy,ctypes<2>,configparser,Improved Modules
@anchor{whatsnew/3 13 copy}@anchor{32c}
@subsubsection copy



@itemize *

@item 
The new @ref{15f,,replace()} function and the @ref{2be,,replace protocol} make creating modified copies of objects much simpler.
This is especially useful when working with immutable objects.
The following types support the @ref{15f,,replace()} function
and implement the replace protocol:


@itemize *

@item 
@ref{32d,,collections.namedtuple()}

@item 
@ref{32e,,dataclasses.dataclass}

@item 
@ref{32f,,datetime.datetime}, @ref{330,,datetime.date}, @ref{331,,datetime.time}

@item 
@ref{332,,inspect.Signature}, @ref{333,,inspect.Parameter}

@item 
@ref{334,,types.SimpleNamespace}

@item 
@ref{335,,code objects}
@end itemize

Any user-defined class can also support @ref{15f,,copy.replace()} by defining
the @ref{2be,,__replace__()} method.
(Contributed by Serhiy Storchaka in gh-108751@footnote{https://github.com/python/cpython/issues/108751}.)
@end itemize

@node ctypes<2>,dbm,copy,Improved Modules
@anchor{whatsnew/3 13 ctypes}@anchor{336}
@subsubsection ctypes



@itemize *

@item 
As a consequence of necessary internal refactoring, initialization of
internal metaclasses now happens in @code{__init__} rather
than in @code{__new__}. This affects projects that subclass these internal
metaclasses to provide custom initialization.
Generally:


@itemize -

@item 
Custom logic that was done in @code{__new__} after calling @code{super().__new__}
should be moved to @code{__init__}.

@item 
To create a class, call the metaclass, not only the metaclass’s
@code{__new__} method.
@end itemize

See gh-124520@footnote{https://github.com/python/cpython/issues/124520} for discussion and links to changes in some affected
projects.

@item 
@ref{166,,ctypes.Structure} objects have a new @ref{337,,_align_}
attribute which allows the alignment of the structure being packed to/from
memory to be specified explicitly.
(Contributed by Matt Sanderson in gh-112433@footnote{https://github.com/python/cpython/issues/112433})
@end itemize

@node dbm,dis<2>,ctypes<2>,Improved Modules
@anchor{whatsnew/3 13 dbm}@anchor{338}
@subsubsection dbm



@itemize *

@item 
Add @ref{36,,dbm.sqlite3}, a new module which implements an SQLite backend,
and make it the default @code{dbm} backend.
(Contributed by Raymond Hettinger and Erlend E. Aasland in gh-100414@footnote{https://github.com/python/cpython/issues/100414}.)

@item 
Allow removing all items from the database through
the new @ref{339,,gdbm.clear()} and @ref{33a,,ndbm.clear()} methods.
(Contributed by Donghee Na in gh-107122@footnote{https://github.com/python/cpython/issues/107122}.)
@end itemize

@node dis<2>,doctest,dbm,Improved Modules
@anchor{whatsnew/3 13 dis}@anchor{33b}
@subsubsection dis



@itemize *

@item 
Change the output of @ref{39,,dis} module functions to show logical
labels for jump targets and exception handlers, rather than offsets.
The offsets can be added with the new
@ref{33c,,-O} command-line option
or the `show_offsets' argument.
(Contributed by Irit Katriel in gh-112137@footnote{https://github.com/python/cpython/issues/112137}.)

@item 
@ref{33d,,get_instructions()} no longer represents cache entries
as separate instructions.
Instead, it returns them as part of the @ref{170,,Instruction},
in the new `cache_info' field.
The `show_caches' argument to @ref{33d,,get_instructions()} is deprecated
and no longer has any effect.
(Contributed by Irit Katriel in gh-112962@footnote{https://github.com/python/cpython/issues/112962}.)
@end itemize

@node doctest,email<2>,dis<2>,Improved Modules
@anchor{whatsnew/3 13 doctest}@anchor{33e}@anchor{whatsnew/3 13 whatsnew313-doctest}@anchor{2b6}
@subsubsection doctest



@itemize *

@item 
@ref{3b,,doctest} output is now colored by default.
This can be controlled via the new 
@geindex PYTHON_COLORS
@geindex variables de entorno; PYTHON_COLORS
@ref{2b7,,PYTHON_COLORS} environment
variable as well as the canonical NO_COLOR@footnote{https://no-color.org/}
and FORCE_COLOR@footnote{https://force-color.org/} environment variables.
See also @ref{2d7,,Controlling color}.
(Contributed by Hugo van Kemenade in gh-117225@footnote{https://github.com/python/cpython/issues/117225}.)

@item 
The @ref{33f,,DocTestRunner.run()} method now counts the number of skipped tests.
Add the @ref{340,,DocTestRunner.skips} and @ref{341,,TestResults.skipped} attributes.
(Contributed by Victor Stinner in gh-108794@footnote{https://github.com/python/cpython/issues/108794}.)
@end itemize

@node email<2>,fractions<2>,doctest,Improved Modules
@anchor{whatsnew/3 13 email}@anchor{342}
@subsubsection email



@itemize *

@item 
Headers with embedded newlines are now quoted on output.
The @ref{41,,generator} will now refuse to serialize (write) headers
that are improperly folded or delimited, such that they would be parsed as
multiple headers or joined with adjacent data.
If you need to turn this safety feature off,
set @ref{343,,verify_generated_headers}.
(Contributed by Bas Bloemsaat and Petr Viktorin in gh-121650@footnote{https://github.com/python/cpython/issues/121650}.)

@item 
@ref{344,,getaddresses()} and @ref{345,,parseaddr()} now
return @code{('@w{'}, '@w{'})} pairs in more situations where invalid email addresses
are encountered instead of potentially inaccurate values.
The two functions have a new optional `strict' parameter (default @code{True}).
To get the old behavior (accepting malformed input), use @code{strict=False}.
@code{getattr(email.utils, 'supports_strict_parsing', False)} can be used
to check if the `strict' parameter is available.
(Contributed by Thomas Dwyer and Victor Stinner for gh-102988@footnote{https://github.com/python/cpython/issues/102988} to improve
the 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043} fix.)
@end itemize

@node fractions<2>,glob,email<2>,Improved Modules
@anchor{whatsnew/3 13 fractions}@anchor{346}
@subsubsection fractions



@itemize *

@item 
@ref{177,,Fraction} objects now support the standard
@ref{347,,format specification mini-language} rules
for fill, alignment, sign handling, minimum width, and grouping.
(Contributed by Mark Dickinson in gh-111320@footnote{https://github.com/python/cpython/issues/111320}.)
@end itemize

@node glob,importlib<2>,fractions<2>,Improved Modules
@anchor{whatsnew/3 13 glob}@anchor{348}
@subsubsection glob



@itemize *

@item 
Add @ref{349,,translate()}, a function to convert a path specification
with shell-style wildcards to a regular expression.
(Contributed by Barney Gale in gh-72904@footnote{https://github.com/python/cpython/issues/72904}.)
@end itemize

@node importlib<2>,io<2>,glob,Improved Modules
@anchor{whatsnew/3 13 importlib}@anchor{34a}
@subsubsection importlib



@itemize *

@item 
The following functions in @ref{7b,,importlib.resources} now allow accessing
a directory (or tree) of resources, using multiple positional arguments
(the `encoding' and `errors' arguments in the text-reading functions
are now keyword-only):


@itemize *

@item 
@ref{34b,,is_resource()}

@item 
@ref{34c,,open_binary()}

@item 
@ref{34d,,open_text()}

@item 
@ref{34e,,path()}

@item 
@ref{34f,,read_binary()}

@item 
@ref{350,,read_text()}
@end itemize

These functions are no longer deprecated and are not scheduled for removal.
(Contributed by Petr Viktorin in gh-116608@footnote{https://github.com/python/cpython/issues/116608}.)

@item 
@ref{351,,contents()} remains deprecated in favor of
the fully-featured @ref{219,,Traversable} API.
However, there is now no plan to remove it.
(Contributed by Petr Viktorin in gh-116608@footnote{https://github.com/python/cpython/issues/116608}.)
@end itemize

@node io<2>,ipaddress,importlib<2>,Improved Modules
@anchor{whatsnew/3 13 io}@anchor{352}
@subsubsection io



@itemize *

@item 
The @ref{353,,IOBase} finalizer now logs any errors raised by
the @ref{354,,close()} method with @ref{355,,sys.unraisablehook}.
Previously, errors were ignored silently by default,
and only logged in @ref{356,,Python Development Mode}
or when using a @ref{357,,Python debug build}.
(Contributed by Victor Stinner in gh-62948@footnote{https://github.com/python/cpython/issues/62948}.)
@end itemize

@node ipaddress,itertools<2>,io<2>,Improved Modules
@anchor{whatsnew/3 13 ipaddress}@anchor{358}
@subsubsection ipaddress



@itemize *

@item 
Add the @ref{359,,IPv4Address.ipv6_mapped} property,
which returns the IPv4-mapped IPv6 address.
(Contributed by Charles Machalow in gh-109466@footnote{https://github.com/python/cpython/issues/109466}.)

@item 
Fix @code{is_global} and @code{is_private} behavior in
@ref{35a,,IPv4Address}, @ref{35b,,IPv6Address},
@ref{35c,,IPv4Network}, and @ref{35d,,IPv6Network}.
(Contributed by Jakub Stasiak in gh-113171@footnote{https://github.com/python/cpython/issues/113171}.)
@end itemize

@node itertools<2>,marshal,ipaddress,Improved Modules
@anchor{whatsnew/3 13 itertools}@anchor{35e}
@subsubsection itertools



@itemize *

@item 
@ref{35f,,batched()} has a new `strict' parameter,
which raises a @ref{360,,ValueError} if the final batch is shorter
than the specified batch size.
(Contributed by Raymond Hettinger in gh-113202@footnote{https://github.com/python/cpython/issues/113202}.)
@end itemize

@node marshal,math,itertools<2>,Improved Modules
@anchor{whatsnew/3 13 marshal}@anchor{361}
@subsubsection marshal



@itemize *

@item 
Add the `allow_code' parameter in module functions.
Passing @code{allow_code=False} prevents serialization and de-serialization
of code objects which are incompatible between Python versions.
(Contributed by Serhiy Storchaka in gh-113626@footnote{https://github.com/python/cpython/issues/113626}.)
@end itemize

@node math,mimetypes<2>,marshal,Improved Modules
@anchor{whatsnew/3 13 math}@anchor{362}
@subsubsection math



@itemize *

@item 
The new function @ref{363,,fma()} performs fused multiply-add operations.
This computes @code{x * y + z} with only a single round,
and so avoids any intermediate loss of precision.
It wraps the @code{fma()} function provided by C99,
and follows the specification of the IEEE 754 «fusedMultiplyAdd» operation
for special cases.
(Contributed by Mark Dickinson and Victor Stinner in gh-73468@footnote{https://github.com/python/cpython/issues/73468}.)
@end itemize

@node mimetypes<2>,mmap,math,Improved Modules
@anchor{whatsnew/3 13 mimetypes}@anchor{364}
@subsubsection mimetypes



@itemize *

@item 
Add the @ref{365,,guess_file_type()} function to guess a MIME type
from a filesystem path.
Using paths with @ref{366,,guess_type()} is now @ref{1c4,,soft deprecated}.
(Contributed by Serhiy Storchaka in gh-66543@footnote{https://github.com/python/cpython/issues/66543}.)
@end itemize

@node mmap,multiprocessing<2>,mimetypes<2>,Improved Modules
@anchor{whatsnew/3 13 mmap}@anchor{367}
@subsubsection mmap



@itemize *

@item 
@ref{368,,mmap} is now protected from crashing on Windows when the
mapped memory is inaccessible due to file system errors or access violations.
(Contributed by Jannis Weigend in gh-118209@footnote{https://github.com/python/cpython/issues/118209}.)

@item 
@ref{368,,mmap} has a new @ref{369,,seekable()} method
that can be used when a seekable file-like object is required.
The @ref{36a,,seek()} method now returns the new absolute position.
(Contributed by Donghee Na and Sylvie Liberman in gh-111835@footnote{https://github.com/python/cpython/issues/111835}.)

@item 
The new UNIX-only `trackfd' parameter for @ref{368,,mmap} controls
file descriptor duplication;
if false, the file descriptor specified by `fileno' will not be duplicated.
(Contributed by Zackery Spytz and Petr Viktorin in gh-78502@footnote{https://github.com/python/cpython/issues/78502}.)
@end itemize

@node multiprocessing<2>,os<2>,mmap,Improved Modules
@anchor{whatsnew/3 13 multiprocessing}@anchor{36b}
@subsubsection multiprocessing



@itemize *

@item 
The default number of worker threads and processes is now selected using
@ref{327,,os.process_cpu_count()} instead of @ref{328,,os.cpu_count()}.
(Contributed by Victor Stinner in gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node os<2>,os path,multiprocessing<2>,Improved Modules
@anchor{whatsnew/3 13 os}@anchor{36c}
@subsubsection os



@itemize *

@item 
Add @ref{327,,process_cpu_count()} function to get the number
of logical CPU cores usable by the calling thread of the current process.
(Contributed by Victor Stinner in gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)

@item 
@ref{328,,cpu_count()} and @ref{327,,process_cpu_count()} can be overridden
through the new environment variable 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT}
or the new command-line option @ref{2e2,,-X cpu_count}.
This option is useful for users who need to limit CPU resources
of a container system without having to modify application code
or the container itself.
(Contributed by Donghee Na in gh-109595@footnote{https://github.com/python/cpython/issues/109595}.)

@item 
Add a @ref{2bf,,low level interface} to Linux’s
@code{timer file descriptors@footnote{https://manpages.debian.org/timerfd_create(2)}}
via @ref{36e,,timerfd_create()},
@ref{36f,,timerfd_settime()}, @ref{370,,timerfd_settime_ns()},
@ref{371,,timerfd_gettime()}, @ref{372,,timerfd_gettime_ns()},
@ref{373,,TFD_NONBLOCK}, @ref{374,,TFD_CLOEXEC},
@ref{375,,TFD_TIMER_ABSTIME}, and @ref{376,,TFD_TIMER_CANCEL_ON_SET}
(Contributed by Masaru Tsuchiyama in gh-108277@footnote{https://github.com/python/cpython/issues/108277}.)

@item 
@ref{377,,lchmod()} and the `follow_symlinks' argument of @ref{378,,chmod()}
are both now available on Windows.
Note that the default value of `follow_symlinks'
in @code{lchmod()} is @code{False} on Windows.
(Contributed by Serhiy Storchaka in gh-59616@footnote{https://github.com/python/cpython/issues/59616}.)

@item 
@ref{379,,fchmod()} and support for file descriptors in @ref{378,,chmod()}
are both now available on Windows.
(Contributed by Serhiy Storchaka in gh-113191@footnote{https://github.com/python/cpython/issues/113191}.)

@item 
On Windows, @ref{37a,,mkdir()} and @ref{37b,,makedirs()} now support passing
a `mode' value of @code{0o700} to apply access control to the new directory.
This implicitly affects @ref{37c,,tempfile.mkdtemp()}
and is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}.
Other values for `mode' continue to be ignored.
(Contributed by Steve Dower in gh-118486@footnote{https://github.com/python/cpython/issues/118486}.)

@item 
@ref{37d,,posix_spawn()} now accepts @code{None} for the `env' argument,
which makes the newly spawned process use the current process environment.
(Contributed by Jakub Kulik in gh-113119@footnote{https://github.com/python/cpython/issues/113119}.)

@item 
@ref{37d,,posix_spawn()} can now use the @ref{37e,,POSIX_SPAWN_CLOSEFROM}
attribute in the `file_actions' parameter on platforms that support
@code{posix_spawn_file_actions_addclosefrom_np()}.
(Contributed by Jakub Kulik in gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node os path,pathlib<3>,os<2>,Improved Modules
@anchor{whatsnew/3 13 os-path}@anchor{37f}
@subsubsection os.path



@itemize *

@item 
Add @ref{1d5,,isreserved()} to check if a path is reserved
on the current system.
This function is only available on Windows.
(Contributed by Barney Gale in gh-88569@footnote{https://github.com/python/cpython/issues/88569}.)

@item 
On Windows, @ref{380,,isabs()} no longer considers paths
starting with exactly one slash (@code{\} or @code{/}) to be absolute.
(Contributed by Barney Gale and Jon Foster in gh-44626@footnote{https://github.com/python/cpython/issues/44626}.)

@item 
@ref{381,,realpath()} now resolves MS-DOS style file names
even if the file is not accessible.
(Contributed by Moonsik Park in gh-82367@footnote{https://github.com/python/cpython/issues/82367}.)
@end itemize

@node pathlib<3>,pdb<2>,os path,Improved Modules
@anchor{whatsnew/3 13 pathlib}@anchor{382}
@subsubsection pathlib



@itemize *

@item 
Add @ref{383,,UnsupportedOperation}, which is raised instead of
@ref{384,,NotImplementedError} when a path operation isn’t supported.
(Contributed by Barney Gale in gh-89812@footnote{https://github.com/python/cpython/issues/89812}.)

@item 
Add a new constructor for creating @ref{19b,,Path} objects
from “file” URIs (@code{file:///}), @ref{385,,Path.from_uri()}.
(Contributed by Barney Gale in gh-107465@footnote{https://github.com/python/cpython/issues/107465}.)

@item 
Add @ref{386,,PurePath.full_match()} for matching paths with
shell-style wildcards, including the recursive wildcard «@code{**}».
(Contributed by Barney Gale in gh-73435@footnote{https://github.com/python/cpython/issues/73435}.)

@item 
Add the @ref{387,,PurePath.parser} class attribute to store the
implementation of @ref{a2,,os.path} used
for low-level path parsing and joining.
This will be either @code{posixpath} or @code{ntpath}.

@item 
Add `recurse_symlinks' keyword-only argument to
@ref{388,,Path.glob()} and @ref{389,,rglob()}.
(Contributed by Barney Gale in gh-77609@footnote{https://github.com/python/cpython/issues/77609}.)

@item 
@ref{388,,Path.glob()} and @ref{389,,rglob()}
now return files and directories when given a pattern that ends with «@code{**}».
Previously, only directories were returned.
(Contributed by Barney Gale in gh-70303@footnote{https://github.com/python/cpython/issues/70303}.)

@item 
Add the `follow_symlinks' keyword-only argument to
@ref{38a,,Path.is_file},
@ref{38b,,Path.is_dir},
@ref{38c,,Path.owner()}, and @ref{38d,,Path.group()}.
(Contributed by Barney Gale in gh-105793@footnote{https://github.com/python/cpython/issues/105793} and Kamil Turek in gh-107962@footnote{https://github.com/python/cpython/issues/107962}.)
@end itemize

@node pdb<2>,queue,pathlib<3>,Improved Modules
@anchor{whatsnew/3 13 pdb}@anchor{38e}
@subsubsection pdb



@itemize *

@item 
@ref{1a6,,breakpoint()} and @ref{1a7,,set_trace()} now enter the debugger immediately
rather than on the next line of code to be executed. This change prevents the
debugger from breaking outside of the context when @code{breakpoint()} is positioned
at the end of the context.
(Contributed by Tian Gao in gh-118579@footnote{https://github.com/python/cpython/issues/118579}.)

@item 
@code{sys.path[0]} is no longer replaced by the directory of the script
being debugged when @ref{38f,,sys.flags.safe_path} is set.
(Contributed by Tian Gao and Christian Walther in gh-111762@footnote{https://github.com/python/cpython/issues/111762}.)

@item 
@ref{12f,,zipapp} is now supported as a debugging target.
(Contributed by Tian Gao in gh-118501@footnote{https://github.com/python/cpython/issues/118501}.)

@item 
Add ability to move between chained exceptions during
post-mortem debugging in @ref{390,,pm()} using
the new @ref{391,,exceptions [exc_number]} command for Pdb.
(Contributed by Matthias Bussonnier in gh-106676@footnote{https://github.com/python/cpython/issues/106676}.)

@item 
Expressions and statements whose prefix is a pdb command are now correctly
identified and executed.
(Contributed by Tian Gao in gh-108464@footnote{https://github.com/python/cpython/issues/108464}.)
@end itemize

@node queue,random,pdb<2>,Improved Modules
@anchor{whatsnew/3 13 queue}@anchor{392}
@subsubsection queue



@itemize *

@item 
Add @ref{393,,Queue.shutdown} and @ref{394,,ShutDown}
to manage queue termination.
(Contributed by Laurie Opperman and Yves Duprat in gh-104750@footnote{https://github.com/python/cpython/issues/104750}.)
@end itemize

@node random,re,queue,Improved Modules
@anchor{whatsnew/3 13 random}@anchor{395}
@subsubsection random



@itemize *

@item 
Add a @ref{2c0,,command-line interface}.
(Contributed by Hugo van Kemenade in gh-118131@footnote{https://github.com/python/cpython/issues/118131}.)
@end itemize

@node re,shutil,random,Improved Modules
@anchor{whatsnew/3 13 re}@anchor{396}
@subsubsection re



@itemize *

@item 
Rename @code{re.error} to @ref{397,,PatternError} for improved clarity.
@code{re.error} is kept for backward compatibility.
@end itemize

@node shutil,site,re,Improved Modules
@anchor{whatsnew/3 13 shutil}@anchor{398}
@subsubsection shutil



@itemize *

@item 
Support the `dir_fd' and `follow_symlinks' keyword arguments
in @ref{399,,chown()}.
(Contributed by Berker Peksag and Tahia K in gh-62308@footnote{https://github.com/python/cpython/issues/62308})
@end itemize

@node site,sqlite3<2>,shutil,Improved Modules
@anchor{whatsnew/3 13 site}@anchor{39a}
@subsubsection site



@itemize *

@item 
@code{.pth} files are now decoded using UTF-8 first,
and then with the @ref{39b,,locale encoding} if UTF-8 decoding fails.
(Contributed by Inada Naoki in gh-117802@footnote{https://github.com/python/cpython/issues/117802}.)
@end itemize

@node sqlite3<2>,ssl,site,Improved Modules
@anchor{whatsnew/3 13 sqlite3}@anchor{39c}
@subsubsection sqlite3



@itemize *

@item 
A @ref{39d,,ResourceWarning} is now emitted if a @ref{39e,,Connection}
object is not @ref{39f,,closed} explicitly.
(Contributed by Erlend E. Aasland in gh-105539@footnote{https://github.com/python/cpython/issues/105539}.)

@item 
Add the `filter' keyword-only parameter to @ref{3a0,,Connection.iterdump()}
for filtering database objects to dump.
(Contributed by Mariusz Felisiak in gh-91602@footnote{https://github.com/python/cpython/issues/91602}.)
@end itemize

@node ssl,statistics,sqlite3<2>,Improved Modules
@anchor{whatsnew/3 13 ssl}@anchor{3a1}
@subsubsection ssl



@itemize *

@item 
The @ref{2c1,,create_default_context()} API now includes
@ref{2c2,,VERIFY_X509_PARTIAL_CHAIN} and @ref{2c3,,VERIFY_X509_STRICT}
in its default flags.

@cartouche
@quotation Nota 
@ref{2c3,,VERIFY_X509_STRICT} may reject pre-
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}
or malformed certificates that the underlying OpenSSL implementation
might otherwise accept.
Whilst disabling this is not recommended, you can do so using:

@example
import ssl

ctx = ssl.create_default_context()
ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
@end example
@end quotation
@end cartouche

(Contributed by William Woodruff in gh-112389@footnote{https://github.com/python/cpython/issues/112389}.)
@end itemize

@node statistics,subprocess,ssl,Improved Modules
@anchor{whatsnew/3 13 statistics}@anchor{3a2}
@subsubsection statistics



@itemize *

@item 
Add @ref{3a3,,kde()} for kernel density estimation.
This makes it possible to estimate a continuous probability density function
from a fixed number of discrete samples.
(Contributed by Raymond Hettinger in gh-115863@footnote{https://github.com/python/cpython/issues/115863}.)

@item 
Add @ref{3a4,,kde_random()} for sampling from an
estimated probability density function created by @ref{3a3,,kde()}.
(Contributed by Raymond Hettinger in gh-115863@footnote{https://github.com/python/cpython/issues/115863}.)
@end itemize

@node subprocess,sys<2>,statistics,Improved Modules
@anchor{whatsnew/3 13 subprocess}@anchor{3a5}@anchor{whatsnew/3 13 whatsnew313-subprocess}@anchor{3a6}
@subsubsection subprocess



@itemize *

@item 
The @ref{d6,,subprocess} module now uses the @ref{37d,,posix_spawn()} function in
more situations.

Notably, when `close_fds' is @code{True} (the default),
@ref{37d,,posix_spawn()} will be used when the C library provides
@code{posix_spawn_file_actions_addclosefrom_np()},
which includes recent versions of Linux, FreeBSD, and Solaris.
On Linux, this should perform similarly to the existing
Linux @code{vfork()} based code.

A private control knob @code{subprocess._USE_POSIX_SPAWN} can
be set to @code{False} if you need to force @ref{d6,,subprocess}
to never use @ref{37d,,posix_spawn()}.
Please report your reason and platform details in
the @ref{3a7,,issue tracker} if you set this
so that we can improve our API selection logic for everyone.
(Contributed by Jakub Kulik in gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node sys<2>,tempfile,subprocess,Improved Modules
@anchor{whatsnew/3 13 sys}@anchor{3a8}
@subsubsection sys



@itemize *

@item 
Add the @ref{3a9,,_is_interned()} function to test if a string was interned.
This function is not guaranteed to exist in all implementations of Python.
(Contributed by Serhiy Storchaka in gh-78573@footnote{https://github.com/python/cpython/issues/78573}.)
@end itemize

@node tempfile,time,sys<2>,Improved Modules
@anchor{whatsnew/3 13 tempfile}@anchor{3aa}
@subsubsection tempfile



@itemize *

@item 
On Windows, the default mode @code{0o700} used by @ref{37c,,tempfile.mkdtemp()} now
limits access to the new directory due to changes to @ref{37a,,os.mkdir()}.
This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}.
(Contributed by Steve Dower in gh-118486@footnote{https://github.com/python/cpython/issues/118486}.)
@end itemize

@node time,tkinter,tempfile,Improved Modules
@anchor{whatsnew/3 13 time}@anchor{3ab}
@subsubsection time



@itemize *

@item 
On Windows, @ref{3ac,,monotonic()} now uses the
@code{QueryPerformanceCounter()} clock for a resolution of 1 microsecond,
instead of the @code{GetTickCount64()} clock which has
a resolution of 15.6 milliseconds.
(Contributed by Victor Stinner in gh-88494@footnote{https://github.com/python/cpython/issues/88494}.)

@item 
On Windows, @ref{3ad,,time()} now uses the
@code{GetSystemTimePreciseAsFileTime()} clock for a resolution of 1 microsecond,
instead of the @code{GetSystemTimeAsFileTime()} clock which has
a resolution of 15.6 milliseconds.
(Contributed by Victor Stinner in gh-63207@footnote{https://github.com/python/cpython/issues/63207}.)
@end itemize

@node tkinter,traceback,time,Improved Modules
@anchor{whatsnew/3 13 tkinter}@anchor{3ae}
@subsubsection tkinter



@itemize *

@item 
Add @ref{f0,,tkinter} widget methods:
@code{tk_busy_hold()}, @code{tk_busy_configure()},
@code{tk_busy_cget()}, @code{tk_busy_forget()},
@code{tk_busy_current()}, and @code{tk_busy_status()}.
(Contributed by Miguel, klappnase and Serhiy Storchaka in gh-72684@footnote{https://github.com/python/cpython/issues/72684}.)

@item 
The @ref{f0,,tkinter} widget method @code{wm_attributes()} now accepts
the attribute name without the minus prefix to get window attributes,
for example @code{w.wm_attributes('alpha')}
and allows specifying attributes and values to set as keyword arguments,
for example @code{w.wm_attributes(alpha=0.5)}.
(Contributed by Serhiy Storchaka in gh-43457@footnote{https://github.com/python/cpython/issues/43457}.)

@item 
@code{wm_attributes()} can now return attributes as a @ref{190,,dict},
by using the new optional keyword-only parameter `return_python_dict'.
(Contributed by Serhiy Storchaka in gh-43457@footnote{https://github.com/python/cpython/issues/43457}.)

@item 
@code{Text.count()} can now return a simple @ref{1f0,,int}
when the new optional keyword-only parameter `return_ints' is used.
Otherwise, the single count is returned as a 1-tuple or @code{None}.
(Contributed by Serhiy Storchaka in gh-97928@footnote{https://github.com/python/cpython/issues/97928}.)

@item 
Support the «vsapi» element type in
the @ref{3af,,element_create()} method of
@ref{3b0,,tkinter.ttk.Style}.
(Contributed by Serhiy Storchaka in gh-68166@footnote{https://github.com/python/cpython/issues/68166}.)

@item 
Add the @code{after_info()} method for Tkinter widgets.
(Contributed by Cheryl Sabella in gh-77020@footnote{https://github.com/python/cpython/issues/77020}.)

@item 
Add a new @code{copy_replace()} method to @code{PhotoImage}
to copy a region from one image to another,
possibly with pixel zooming, subsampling, or both.
(Contributed by Serhiy Storchaka in gh-118225@footnote{https://github.com/python/cpython/issues/118225}.)

@item 
Add `from_coords' parameter to the @code{PhotoImage} methods
@code{copy()}, @code{zoom()} and @code{subsample()}.
Add `zoom' and `subsample' parameters to the @code{PhotoImage} method
@code{copy()}.
(Contributed by Serhiy Storchaka in gh-118225@footnote{https://github.com/python/cpython/issues/118225}.)

@item 
Add the @code{PhotoImage} methods
@code{read()} to read an image from a file
and @code{data()} to get the image data.
Add `background' and `grayscale' parameters to the @code{write()} method.
(Contributed by Serhiy Storchaka in gh-118271@footnote{https://github.com/python/cpython/issues/118271}.)
@end itemize

@node traceback,types,tkinter,Improved Modules
@anchor{whatsnew/3 13 traceback}@anchor{3b1}
@subsubsection traceback



@itemize *

@item 
Add the @ref{3b2,,exc_type_str} attribute
to @ref{3b3,,TracebackException},
which holds a string display of the `exc_type'.
Deprecate the @ref{3b4,,exc_type} attribute,
which holds the type object itself.
Add parameter `save_exc_type' (default @code{True})
to indicate whether @code{exc_type} should be saved.
(Contributed by Irit Katriel in gh-112332@footnote{https://github.com/python/cpython/issues/112332}.)

@item 
Add a new `show_group' keyword-only parameter to
@ref{3b5,,TracebackException.format_exception_only()} to (recursively) format
the nested exceptions of a @ref{3b6,,BaseExceptionGroup} instance.
(Contributed by Irit Katriel in gh-105292@footnote{https://github.com/python/cpython/issues/105292}.)
@end itemize

@node types,typing<2>,traceback,Improved Modules
@anchor{whatsnew/3 13 types}@anchor{3b7}
@subsubsection types



@itemize *

@item 
@ref{334,,SimpleNamespace} can now take a single positional argument
to initialise the namespace’s arguments.
This argument must either be a mapping or an iterable of key-value pairs.
(Contributed by Serhiy Storchaka in gh-108191@footnote{https://github.com/python/cpython/issues/108191}.)
@end itemize

@node typing<2>,unicodedata<2>,types,Improved Modules
@anchor{whatsnew/3 13 typing}@anchor{3b8}
@subsubsection typing



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: Add @ref{2cd,,ReadOnly}, a special typing construct
to mark a @ref{2ce,,TypedDict} item as read-only for type checkers.

@item 
@geindex Python Enhancement Proposals; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: Add @ref{2cf,,TypeIs}, a typing construct
that can be used to instruct a type checker how to narrow a type.

@item 
Add @ref{3b9,,NoDefault}, a sentinel object used to represent
the defaults of some parameters in the @ref{104,,typing} module.
(Contributed by Jelle Zijlstra in gh-116126@footnote{https://github.com/python/cpython/issues/116126}.)

@item 
Add @ref{3ba,,get_protocol_members()} to return the set of members
defining a @ref{3bb,,typing.Protocol}.
(Contributed by Jelle Zijlstra in gh-104873@footnote{https://github.com/python/cpython/issues/104873}.)

@item 
Add @ref{3bc,,is_protocol()} to check whether a class
is a @ref{3bb,,Protocol}.
(Contributed by Jelle Zijlstra in gh-104873@footnote{https://github.com/python/cpython/issues/104873}.)

@item 
@ref{3bd,,ClassVar} can now be nested in @ref{3be,,Final},
and vice versa.
(Contributed by Mehdi Drissi in gh-89547@footnote{https://github.com/python/cpython/issues/89547}.)
@end itemize

@node unicodedata<2>,venv,typing<2>,Improved Modules
@anchor{whatsnew/3 13 unicodedata}@anchor{3bf}
@subsubsection unicodedata



@itemize *

@item 
Update the Unicode database to version 15.1.0@footnote{https://www.unicode.org/versions/Unicode15.1.0/}.
(Contributed by James Gerity in gh-109559@footnote{https://github.com/python/cpython/issues/109559}.)
@end itemize

@node venv,warnings,unicodedata<2>,Improved Modules
@anchor{whatsnew/3 13 venv}@anchor{3c0}
@subsubsection venv



@itemize *

@item 
Add support for creating source control management (SCM) ignore files
in a virtual environment’s directory.
By default, Git is supported.
This is implemented as opt-in via the API,
which can be extended to support other SCMs
(@ref{3c1,,EnvBuilder} and @ref{3c2,,create()}),
and opt-out via the CLI, using @code{--without-scm-ignore-files}.
(Contributed by Brett Cannon in gh-108125@footnote{https://github.com/python/cpython/issues/108125}.)
@end itemize

@node warnings,xml,venv,Improved Modules
@anchor{whatsnew/3 13 warnings}@anchor{3c3}
@subsubsection warnings



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: The new @ref{2cc,,warnings.deprecated()} decorator provides a way to
communicate deprecations to a @ref{3c4,,static type checker}
and to warn on usage of deprecated classes and functions.
A @ref{1da,,DeprecationWarning} may also be emitted when
a decorated function or class is used at runtime.
(Contributed by Jelle Zijlstra in gh-104003@footnote{https://github.com/python/cpython/issues/104003}.)
@end itemize

@node xml,zipimport,warnings,Improved Modules
@anchor{whatsnew/3 13 xml}@anchor{3c5}
@subsubsection xml



@itemize *

@item 
Allow controlling Expat >=2.6.0 reparse deferral (
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425})
by adding five new methods:


@itemize *

@item 
@ref{3c6,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{3c7,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{3c8,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{3c9,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()}

@item 
@code{xml.sax.expatreader.ExpatParser.flush()}
@end itemize

(Contributed by Sebastian Pipping in gh-115623@footnote{https://github.com/python/cpython/issues/115623}.)

@item 
Add the @code{close()} method for the iterator returned by
@ref{3ca,,iterparse()} for explicit cleanup.
(Contributed by Serhiy Storchaka in gh-69893@footnote{https://github.com/python/cpython/issues/69893}.)
@end itemize

@node zipimport,,xml,Improved Modules
@anchor{whatsnew/3 13 zipimport}@anchor{3cb}
@subsubsection zipimport



@itemize *

@item 
Add support for ZIP64@footnote{https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64} format files.
Everybody loves huge data, right?
(Contributed by Tim Hatch in gh-94146@footnote{https://github.com/python/cpython/issues/94146}.)
@end itemize

@node Optimizations<2>,Removed Modules And APIs,Improved Modules,What’s New In Python 3 13
@anchor{whatsnew/3 13 optimizations}@anchor{3cc}
@subsection Optimizations



@itemize *

@item 
Several standard library modules have had
their import times significantly improved.
For example, the import time of the @ref{104,,typing} module
has been reduced by around a third by removing dependencies
on @ref{b9,,re} and @ref{24,,contextlib}.
Other modules to enjoy import-time speedups include
@ref{51,,email.utils}, @ref{56,,enum}, @ref{5f,,functools},
@ref{7a,,importlib.metadata}, and @ref{ed,,threading}.
(Contributed by Alex Waygood, Shantanu Jain, Adam Turner, Daniel Hollas,
and others in gh-109653@footnote{https://github.com/python/cpython/issues/109653}.)

@item 
@ref{3cd,,textwrap.indent()} is now around 30% faster than before for large input.
(Contributed by Inada Naoki in gh-107369@footnote{https://github.com/python/cpython/issues/107369}.)

@item 
The @ref{d6,,subprocess} module now uses the @ref{37d,,posix_spawn()} function in
more situations, including when `close_fds' is @code{True} (the default)
on many modern platforms.
This should provide a notable performance increase
when launching processes on FreeBSD and Solaris.
See the @ref{3a6,,subprocess} section above for details.
(Contributed by Jakub Kulik in gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node Removed Modules And APIs,New Deprecations,Optimizations<2>,What’s New In Python 3 13
@anchor{whatsnew/3 13 removed-modules-and-apis}@anchor{3ce}
@subsection Removed Modules And APIs


@menu
* PEP 594; Remove «dead batteries» from the standard library: PEP 594 Remove «dead batteries» from the standard library. 
* 2to3:: 
* builtins:: 
* configparser: configparser<2>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* pathlib: pathlib<4>. 
* re: re<2>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<3>. 
* unittest: unittest<2>. 
* urllib: urllib<2>. 
* webbrowser:: 

@end menu

@node PEP 594 Remove «dead batteries» from the standard library,2to3,,Removed Modules And APIs
@anchor{whatsnew/3 13 pep-594-remove-dead-batteries-from-the-standard-library}@anchor{3cf}
@subsubsection PEP 594: Remove «dead batteries» from the standard library


@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} proposed removing 19 modules from the standard library,
colloquially referred to as “dead batteries” due to their
historic, obsolete, or insecure status.
All of the following modules were deprecated in Python 3.11,
and are now removed:


@itemize *

@item 
@code{aifc}

@item 
@code{audioop}

@item 
@code{chunk}

@item 
@code{cgi} and @code{cgitb}


@itemize *

@item 
@code{cgi.FieldStorage} can typically be replaced with
@ref{1c8,,urllib.parse.parse_qsl()} for @code{GET} and @code{HEAD} requests,
and the @ref{45,,email.message} module or the multipart@footnote{https://pypi.org/project/multipart/} library
for @code{POST} and @code{PUT} requests.

@item 
@code{cgi.parse()} can be replaced by calling
@ref{1c9,,urllib.parse.parse_qs()} directly on the desired query string,
unless the input is @code{multipart/form-data},
which should be replaced as described below for @code{cgi.parse_multipart()}.

@item 
@code{cgi.parse_header()} can be replaced with the functionality
in the @ref{3c,,email} package, which implements the same MIME RFCs.
For example, with @ref{3d0,,email.message.EmailMessage}:

@example
from email.message import EmailMessage

msg = EmailMessage()
msg['content-type'] = 'application/json; charset="utf8"'
main, params = msg.get_content_type(), msg['content-type'].params
@end example

@item 
@code{cgi.parse_multipart()} can be replaced with the functionality
in the @ref{3c,,email} package, which implements the same MIME RFCs,
or with the multipart@footnote{https://pypi.org/project/multipart/} library.
For example, the @ref{3d0,,email.message.EmailMessage}
and @ref{3d1,,email.message.Message} classes.
@end itemize

@item 
@code{crypt} and the private @code{_crypt} extension.
The @ref{68,,hashlib} module may be an appropriate replacement
when simply hashing a value is required.
Otherwise, various third-party libraries on PyPI are available:


@itemize *

@item 
bcrypt@footnote{https://pypi.org/project/bcrypt/}:
Modern password hashing for your software and your servers.

@item 
passlib@footnote{https://pypi.org/project/passlib/}:
Comprehensive password hashing framework supporting over 30 schemes.

@item 
argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}:
The secure Argon2 password hashing algorithm.

@item 
legacycrypt@footnote{https://pypi.org/project/legacycrypt/}:
@ref{2b,,ctypes} wrapper to the POSIX crypt library call
and associated functionality.

@item 
crypt_r@footnote{https://pypi.org/project/crypt_r/}:
Fork of the @code{crypt} module,
wrapper to the @code{crypt_r(3)@footnote{https://manpages.debian.org/crypt_r(3)}} library call
and associated functionality.
@end itemize

@item 
@code{imghdr}:
The filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/}, or python-magic@footnote{https://pypi.org/project/python-magic/} libraries
should be used as replacements.
For example, the @code{puremagic.what()} function can be used
to replace the @code{imghdr.what()} function for all file formats
that were supported by @code{imghdr}.

@item 
@code{mailcap}:
Use the @ref{8f,,mimetypes} module instead.

@item 
@code{msilib}

@item 
@code{nis}

@item 
@code{nntplib}:
Use the pynntp@footnote{https://pypi.org/project/pynntp/} library from PyPI instead.

@item 
@code{ossaudiodev}:
For audio playback, use the pygame@footnote{https://pypi.org/project/pygame/} library from PyPI instead.

@item 
@code{pipes}:
Use the @ref{d6,,subprocess} module instead.
Use @ref{3d2,,shlex.quote()} to replace the undocumented @code{pipes.quote}
function.

@item 
@code{sndhdr}:
The filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/}, or python-magic@footnote{https://pypi.org/project/python-magic/} libraries
should be used as replacements.

@item 
@code{spwd}:
Use the python-pam@footnote{https://pypi.org/project/python-pam/} library from PyPI instead.

@item 
@code{sunau}

@item 
@code{telnetlib},
Use the telnetlib3@footnote{https://pypi.org/project/telnetlib3/} or Exscript@footnote{https://pypi.org/project/Exscript/} libraries from PyPI instead.

@item 
@code{uu}:
Use the @ref{f,,base64} module instead, as a modern alternative.

@item 
@code{xdrlib}
@end itemize

(Contributed by Victor Stinner and Zachary Ware in gh-104773@footnote{https://github.com/python/cpython/issues/104773} and gh-104780@footnote{https://github.com/python/cpython/issues/104780}.)

@node 2to3,builtins,PEP 594 Remove «dead batteries» from the standard library,Removed Modules And APIs
@anchor{whatsnew/3 13 to3}@anchor{3d3}
@subsubsection 2to3



@itemize *

@item 
Remove the @code{2to3} program and the @code{lib2to3} module,
previously deprecated in Python 3.11.
(Contributed by Victor Stinner in gh-104780@footnote{https://github.com/python/cpython/issues/104780}.)
@end itemize

@node builtins,configparser<2>,2to3,Removed Modules And APIs
@anchor{whatsnew/3 13 builtins}@anchor{3d4}
@subsubsection builtins



@itemize *

@item 
Remove support for chained @ref{2d2,,classmethod} descriptors
(introduced in gh-63272@footnote{https://github.com/python/cpython/issues/63272}).
These can no longer be used to wrap other descriptors,
such as @ref{2fd,,property}.
The core design of this feature was flawed and led to several problems.
To «pass-through» a @ref{2d2,,classmethod}, consider using
the @code{__wrapped__} attribute that was added in Python 3.10.
(Contributed by Raymond Hettinger in gh-89519@footnote{https://github.com/python/cpython/issues/89519}.)

@item 
Raise a @ref{1e5,,RuntimeError} when calling @ref{3d5,,frame.clear()}
on a suspended frame (as has always been the case for an executing frame).
(Contributed by Irit Katriel in gh-79932@footnote{https://github.com/python/cpython/issues/79932}.)
@end itemize

@node configparser<2>,importlib metadata,builtins,Removed Modules And APIs
@anchor{whatsnew/3 13 id3}@anchor{3d6}
@subsubsection configparser



@itemize *

@item 
Remove the undocumented @code{LegacyInterpolation} class,
deprecated in the docstring since Python 3.2,
and at runtime since Python 3.11.
(Contributed by Hugo van Kemenade in gh-104886@footnote{https://github.com/python/cpython/issues/104886}.)
@end itemize

@node importlib metadata,locale,configparser<2>,Removed Modules And APIs
@anchor{whatsnew/3 13 importlib-metadata}@anchor{3d7}
@subsubsection importlib.metadata



@itemize *

@item 
Remove deprecated subscript (@ref{3d8,,__getitem__()}) access for
@ref{3d9,,EntryPoint} objects.
(Contributed by Jason R. Coombs in gh-113175@footnote{https://github.com/python/cpython/issues/113175}.)
@end itemize

@node locale,opcode,importlib metadata,Removed Modules And APIs
@anchor{whatsnew/3 13 locale}@anchor{3da}
@subsubsection locale



@itemize *

@item 
Remove the @code{locale.resetlocale()} function, deprecated in Python 3.11.
Use @code{locale.setlocale(locale.LC_ALL, "")} instead.
(Contributed by Victor Stinner in gh-104783@footnote{https://github.com/python/cpython/issues/104783}.)
@end itemize

@node opcode,pathlib<4>,locale,Removed Modules And APIs
@anchor{whatsnew/3 13 opcode}@anchor{3db}
@subsubsection opcode



@itemize *

@item 
Move @code{opcode.ENABLE_SPECIALIZATION} to @code{_opcode.ENABLE_SPECIALIZATION}.
This field was added in 3.12, it was never documented,
and is not intended for external use.
(Contributed by Irit Katriel in gh-105481@footnote{https://github.com/python/cpython/issues/105481}.)

@item 
Remove @code{opcode.is_pseudo()}, @code{opcode.MIN_PSEUDO_OPCODE},
and @code{opcode.MAX_PSEUDO_OPCODE}, which were added in Python 3.12,
but were neither documented nor exposed through @ref{39,,dis},
and were not intended to be used externally.
(Contributed by Irit Katriel in gh-105481@footnote{https://github.com/python/cpython/issues/105481}.)
@end itemize

@node pathlib<4>,re<2>,opcode,Removed Modules And APIs
@anchor{whatsnew/3 13 id4}@anchor{3dc}
@subsubsection pathlib



@itemize *

@item 
Remove the ability to use @ref{19b,,Path} objects as context managers.
This functionality was deprecated and has had no effect since Python 3.9.
(Contributed by Barney Gale in gh-83863@footnote{https://github.com/python/cpython/issues/83863}.)
@end itemize

@node re<2>,tkinter tix,pathlib<4>,Removed Modules And APIs
@anchor{whatsnew/3 13 id5}@anchor{3dd}
@subsubsection re



@itemize *

@item 
Remove the undocumented, deprecated, and broken
@code{re.template()} function and @code{re.TEMPLATE} / @code{re.T} flag.
(Contributed by Serhiy Storchaka and Nikita Sobolev in gh-105687@footnote{https://github.com/python/cpython/issues/105687}.)
@end itemize

@node tkinter tix,turtle,re<2>,Removed Modules And APIs
@anchor{whatsnew/3 13 tkinter-tix}@anchor{3de}
@subsubsection tkinter.tix



@itemize *

@item 
Remove the @code{tkinter.tix} module, deprecated in Python 3.6.
The third-party Tix library which the module wrapped is unmaintained.
(Contributed by Zachary Ware in gh-75552@footnote{https://github.com/python/cpython/issues/75552}.)
@end itemize

@node turtle,typing<3>,tkinter tix,Removed Modules And APIs
@anchor{whatsnew/3 13 turtle}@anchor{3df}
@subsubsection turtle



@itemize *

@item 
Remove the @code{RawTurtle.settiltangle()} method,
deprecated in the documentation since Python 3.1
and at runtime since Python 3.11.
(Contributed by Hugo van Kemenade in gh-104876@footnote{https://github.com/python/cpython/issues/104876}.)
@end itemize

@node typing<3>,unittest<2>,turtle,Removed Modules And APIs
@anchor{whatsnew/3 13 id6}@anchor{3e0}
@subsubsection typing



@itemize *

@item 
Remove the @code{typing.io} and @code{typing.re} namespaces,
deprecated since Python 3.8.
The items in those namespaces can be imported directly
from the @ref{104,,typing} module.
(Contributed by Sebastian Rittau in gh-92871@footnote{https://github.com/python/cpython/issues/92871}.)

@item 
Remove the keyword-argument method of creating
@ref{2ce,,TypedDict} types, deprecated in Python 3.11.
(Contributed by Tomas Roun in gh-104786@footnote{https://github.com/python/cpython/issues/104786}.)
@end itemize

@node unittest<2>,urllib<2>,typing<3>,Removed Modules And APIs
@anchor{whatsnew/3 13 unittest}@anchor{3e1}
@subsubsection unittest



@itemize *

@item 
Remove the following @ref{106,,unittest} functions, deprecated in Python 3.11:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Use @ref{3e2,,TestLoader} methods instead:


@itemize *

@item 
@ref{3e3,,loadTestsFromModule()}

@item 
@ref{3e4,,loadTestsFromTestCase()}

@item 
@ref{3e5,,getTestCaseNames()}
@end itemize

(Contributed by Hugo van Kemenade in gh-104835@footnote{https://github.com/python/cpython/issues/104835}.)

@item 
Remove the untested and undocumented @code{TestProgram.usageExit()}
method, deprecated in Python 3.11.
(Contributed by Hugo van Kemenade in gh-104992@footnote{https://github.com/python/cpython/issues/104992}.)
@end itemize

@node urllib<2>,webbrowser,unittest<2>,Removed Modules And APIs
@anchor{whatsnew/3 13 urllib}@anchor{3e6}
@subsubsection urllib



@itemize *

@item 
Remove the `cafile', `capath', and `cadefault' parameters of the
@ref{20a,,urllib.request.urlopen()} function, deprecated in Python 3.6.
Use the `context' parameter instead with an @ref{1fa,,SSLContext} instance.
The @ref{3e7,,ssl.SSLContext.load_cert_chain()} function
can be used to load specific certificates,
or let @ref{2c1,,ssl.create_default_context()} select
the operating system’s trusted certificate authority (CA) certificates.
(Contributed by Victor Stinner in gh-105382@footnote{https://github.com/python/cpython/issues/105382}.)
@end itemize

@node webbrowser,,urllib<2>,Removed Modules And APIs
@anchor{whatsnew/3 13 webbrowser}@anchor{3e8}
@subsubsection webbrowser



@itemize *

@item 
Remove the untested and undocumented @code{MacOSX} class,
deprecated in Python 3.11.
Use the @code{MacOSXOSAScript} class (introduced in Python 3.2) instead.
(Contributed by Hugo van Kemenade in gh-104804@footnote{https://github.com/python/cpython/issues/104804}.)

@item 
Remove the deprecated @code{MacOSXOSAScript._name} attribute.
Use the @ref{3e9,,MacOSXOSAScript.name}
attribute instead.
(Contributed by Nikita Sobolev in gh-105546@footnote{https://github.com/python/cpython/issues/105546}.)
@end itemize

@node New Deprecations,CPython Bytecode Changes,Removed Modules And APIs,What’s New In Python 3 13
@anchor{whatsnew/3 13 new-deprecations}@anchor{3ea}
@subsection New Deprecations



@itemize *

@item 
@ref{3eb,,User-defined functions}:


@itemize *

@item 
Deprecate assignment to a function’s @ref{3ec,,__code__} attribute,
where the new code object’s type does not match the function’s type.
The different types are:
plain function, generator, async generator, and coroutine.
(Contributed by Irit Katriel in gh-81137@footnote{https://github.com/python/cpython/issues/81137}.)
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
Deprecate the @code{'u'} format code (@code{wchar_t}) at runtime.
This format code has been deprecated in documentation since Python 3.3,
and will be removed in Python 3.16.
Use the @code{'w'} format code (@ref{1e4,,Py_UCS4})
for Unicode characters instead.
(Contributed by Hugo van Kemenade in gh-80480@footnote{https://github.com/python/cpython/issues/80480}.)
@end itemize

@item 
@ref{2b,,ctypes}:


@itemize *

@item 
Deprecate the undocumented @code{SetPointerType()} function,
to be removed in Python 3.15.
(Contributed by Victor Stinner in gh-105733@footnote{https://github.com/python/cpython/issues/105733}.)

@item 
@ref{1c4,,Soft-deprecate} the @ref{3ed,,ARRAY()}
function in favour of @code{type * length} multiplication.
(Contributed by Victor Stinner in gh-105733@footnote{https://github.com/python/cpython/issues/105733}.)
@end itemize

@item 
@ref{37,,decimal}:


@itemize *

@item 
Deprecate the non-standard and undocumented @ref{16a,,Decimal}
format specifier @code{'N'},
which is only supported in the @code{decimal} module’s C implementation.
(Contributed by Serhiy Storchaka in gh-89902@footnote{https://github.com/python/cpython/issues/89902}.)
@end itemize

@item 
@ref{39,,dis}:


@itemize *

@item 
Deprecate the @code{HAVE_ARGUMENT} separator.
Check membership in @ref{3ee,,hasarg} instead.
(Contributed by Irit Katriel in gh-109319@footnote{https://github.com/python/cpython/issues/109319}.)
@end itemize

@item 
@ref{61,,getopt} and @ref{a0,,optparse}:


@itemize *

@item 
Both modules are now @ref{1c4,,soft deprecated},
with @ref{7,,argparse} preferred for new projects.
This is a new soft-deprecation for the @code{getopt} module,
whereas the @code{optparse} module was already `de facto' soft deprecated.
(Contributed by Victor Stinner in gh-106535@footnote{https://github.com/python/cpython/issues/106535}.)
@end itemize

@item 
@ref{63,,gettext}:


@itemize *

@item 
Deprecate non-integer numbers as arguments to functions and methods
that consider plural forms in the @code{gettext} module,
even if no translation was found.
(Contributed by Serhiy Storchaka in gh-88434@footnote{https://github.com/python/cpython/issues/88434}.)
@end itemize

@item 
@ref{64,,glob}:


@itemize *

@item 
Deprecate the undocumented @code{glob0()} and @code{glob1()} functions.
Use @ref{3ef,,glob()} and pass a @ref{3f0,,path-like object} specifying
the root directory to the `root_dir' parameter instead.
(Contributed by Barney Gale in gh-117337@footnote{https://github.com/python/cpython/issues/117337}.)
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
Deprecate @ref{1cf,,CGIHTTPRequestHandler},
to be removed in Python 3.15.
Process-based CGI HTTP servers have been out of favor for a very long time.
This code was outdated, unmaintained, and rarely used.
It has a high potential for both security and functionality bugs.
(Contributed by Gregory P. Smith in gh-109096@footnote{https://github.com/python/cpython/issues/109096}.)

@item 
Deprecate the @code{--cgi} flag to
the @code{python -m http.server} command-line interface,
to be removed in Python 3.15.
(Contributed by Gregory P. Smith in gh-109096@footnote{https://github.com/python/cpython/issues/109096}.)
@end itemize

@item 
@ref{8f,,mimetypes}:


@itemize *

@item 
@ref{1c4,,Soft-deprecate} file path arguments
to @ref{366,,guess_type()},
use @ref{365,,guess_file_type()} instead.
(Contributed by Serhiy Storchaka in gh-66543@footnote{https://github.com/python/cpython/issues/66543}.)
@end itemize

@item 
@ref{b9,,re}:


@itemize *

@item 
Deprecate passing the optional `maxsplit', `count', or `flags' arguments
as positional arguments to the module-level
@ref{3f1,,split()}, @ref{3f2,,sub()}, and @ref{3f3,,subn()} functions.
These parameters will become @ref{3f4,,keyword-only}
in a future version of Python.
(Contributed by Serhiy Storchaka in gh-56166@footnote{https://github.com/python/cpython/issues/56166}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
Deprecate @ref{1d4,,PurePath.is_reserved()},
to be removed in Python 3.15.
Use @ref{1d5,,os.path.isreserved()} to detect reserved paths on Windows.
(Contributed by Barney Gale in gh-88569@footnote{https://github.com/python/cpython/issues/88569}.)
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
Deprecate @ref{1d6,,java_ver()},
to be removed in Python 3.15.
This function is only useful for Jython support, has a confusing API,
and is largely untested.
(Contributed by Nikita Sobolev in gh-116349@footnote{https://github.com/python/cpython/issues/116349}.)
@end itemize

@item 
@ref{b5,,pydoc}:


@itemize *

@item 
Deprecate the undocumented @code{ispackage()} function.
(Contributed by Zackery Spytz in gh-64020@footnote{https://github.com/python/cpython/issues/64020}.)
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
Deprecate passing more than one positional argument to
the @ref{3f5,,connect()} function
and the @ref{39e,,Connection} constructor.
The remaining parameters will become keyword-only in Python 3.15.
(Contributed by Erlend E. Aasland in gh-107948@footnote{https://github.com/python/cpython/issues/107948}.)

@item 
Deprecate passing name, number of arguments, and the callable as keyword
arguments for @ref{3f6,,Connection.create_function()}
and @ref{3f7,,Connection.create_aggregate()}
These parameters will become positional-only in Python 3.15.
(Contributed by Erlend E. Aasland in gh-108278@footnote{https://github.com/python/cpython/issues/108278}.)

@item 
Deprecate passing the callback callable by keyword for the
@ref{3f8,,set_authorizer()},
@ref{3f9,,set_progress_handler()}, and
@ref{3fa,,set_trace_callback()}
@ref{39e,,Connection} methods.
The callback callables will become positional-only in Python 3.15.
(Contributed by Erlend E. Aasland in gh-108278@footnote{https://github.com/python/cpython/issues/108278}.)
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
Deprecate the @ref{1e6,,_enablelegacywindowsfsencoding()} function,
to be removed in Python 3.16.
Use the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment variable instead.
(Contributed by Inada Naoki in gh-73427@footnote{https://github.com/python/cpython/issues/73427}.)
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
Deprecate the undocumented and unused @code{TarFile.tarfile} attribute,
to be removed in Python 3.16.
(Contributed in gh-115256@footnote{https://github.com/python/cpython/issues/115256}.)
@end itemize

@item 
@ref{fe,,traceback}:


@itemize *

@item 
Deprecate the @ref{3b4,,TracebackException.exc_type} attribute.
Use @ref{3b2,,TracebackException.exc_type_str} instead.
(Contributed by Irit Katriel in gh-112332@footnote{https://github.com/python/cpython/issues/112332}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
Deprecate the undocumented keyword argument syntax for creating
@ref{1db,,NamedTuple} classes
(e.g. @code{Point = NamedTuple("Point", x=int, y=int)}),
to be removed in Python 3.15.
Use the class-based syntax or the functional syntax instead.
(Contributed by Alex Waygood in gh-105566@footnote{https://github.com/python/cpython/issues/105566}.)

@item 
Deprecate omitting the `fields' parameter when creating
a @ref{1db,,NamedTuple} or @ref{2ce,,typing.TypedDict} class,
and deprecate passing @code{None} to the `fields' parameter of both types.
Python 3.15 will require a valid sequence for the `fields' parameter.
To create a NamedTuple class with zero fields,
use @code{class NT(NamedTuple): pass} or @code{NT = NamedTuple("NT", ())}.
To create a TypedDict class with zero fields,
use @code{class TD(TypedDict): pass} or @code{TD = TypedDict("TD", @{@})}.
(Contributed by Alex Waygood in gh-105566@footnote{https://github.com/python/cpython/issues/105566} and gh-105570@footnote{https://github.com/python/cpython/issues/105570}.)

@item 
Deprecate the @ref{1dc,,typing.no_type_check_decorator()} decorator function,
to be removed in in Python 3.15.
After eight years in the @ref{104,,typing} module,
it has yet to be supported by any major type checker.
(Contributed by Alex Waygood in gh-106309@footnote{https://github.com/python/cpython/issues/106309}.)

@item 
Deprecate @ref{3fb,,typing.AnyStr}.
In Python 3.16, it will be removed from @code{typing.__all__},
and a @ref{1da,,DeprecationWarning} will be emitted at runtime
when it is imported or accessed.
It will be removed entirely in Python 3.18.
Use the new @ref{3fc,,type parameter syntax} instead.
(Contributed by Michael The in gh-107116@footnote{https://github.com/python/cpython/issues/107116}.)
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
Deprecate the @ref{1dd,,getmark()}, @code{setmark()},
and @ref{1de,,getmarkers()} methods of
the @ref{1df,,Wave_read} and @ref{1e0,,Wave_write} classes,
to be removed in Python 3.15.
(Contributed by Victor Stinner in gh-105096@footnote{https://github.com/python/cpython/issues/105096}.)
@end itemize
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Pending removal in Python 3.14: Pending removal in Python 3 14. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<3>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<2>. 
* Pending removal in future versions: Pending removal in future versions<3>. 

@end menu

@node Pending removal in Python 3 14,Pending removal in Python 3 15<3>,,New Deprecations
@anchor{whatsnew/3 13 pending-removal-in-python-3-14}@anchor{3fd}
@subsubsection Pending removal in Python 3.14



@itemize *

@item 
@ref{7,,argparse}: The `type', `choices', and `metavar' parameters
of @code{argparse.BooleanOptionalAction} are deprecated
and will be removed in 3.14.
(Contributed by Nikita Sobolev in gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{9,,ast}: The following features have been deprecated in documentation
since Python 3.8, now cause a @ref{1da,,DeprecationWarning} to be emitted at
runtime when they are accessed or used, and will be removed in Python 3.14:


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

Use @ref{211,,ast.Constant} instead.
(Contributed by Serhiy Storchaka in gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{b,,asyncio}:


@itemize *

@item 
The child watcher classes @code{asyncio.MultiLoopChildWatcher},
@code{asyncio.FastChildWatcher}, @code{asyncio.AbstractChildWatcher}
and @code{asyncio.SafeChildWatcher} are deprecated and
will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@code{asyncio.set_child_watcher()}, @code{asyncio.get_child_watcher()},
@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} and
@code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} are deprecated
and will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
The @ref{214,,get_event_loop()} method of the
default event loop policy now emits a @ref{1da,,DeprecationWarning} if there
is no current event loop set and it decides to create one.
(Contributed by Serhiy Storchaka and Guido van Rossum in gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{1f,,collections.abc}: Deprecated @code{collections.abc.ByteString}.
Prefer @code{Sequence} or @ref{3fe,,Buffer}.
For use in typing, prefer a union, like @code{bytes | bytearray},
or @ref{3fe,,collections.abc.Buffer}.
(Contributed by Shantanu Jain in gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)

@item 
@ref{3c,,email}: Deprecated the `isdst' parameter in @ref{217,,email.utils.localtime()}.
(Contributed by Alan Williams in gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc} deprecated classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Use @ref{7c,,importlib.resources.abc} classes instead:


@itemize *

@item 
@ref{219,,importlib.resources.abc.Traversable}

@item 
@ref{21a,,importlib.resources.abc.TraversableResources}
@end itemize

(Contributed by Jason R. Coombs and Hugo van Kemenade in gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools} had undocumented, inefficient, historically buggy,
and inconsistent support for copy, deepcopy, and pickle operations.
This will be removed in 3.14 for a significant reduction in code
volume and maintenance burden.
(Contributed by Raymond Hettinger in gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: The default start method will change to a safer one on
Linux, BSDs, and other non-macOS POSIX platforms where @code{'fork'} is currently
the default (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adding a runtime warning about this was deemed too
disruptive as the majority of code is not expected to care. Use the
@ref{18b,,get_context()} or
@ref{18c,,set_start_method()} APIs to explicitly specify when
your code `requires' @code{'fork'}.  See @ref{162,,Contextos y métodos de inicio}.

@item 
@ref{a4,,pathlib}: @ref{21e,,is_relative_to()} and
@ref{21d,,relative_to()}: passing additional arguments is
deprecated.

@item 
@ref{a9,,pkgutil}: @code{pkgutil.find_loader()} and :func:!pkgutil.get_loader`
now raise @ref{1da,,DeprecationWarning};
use @ref{3ff,,importlib.util.find_spec()} instead.
(Contributed by Nikita Sobolev in gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}:


@itemize *

@item 
@code{master_open()}: use @ref{221,,pty.openpty()}.

@item 
@code{slave_open()}: use @ref{221,,pty.openpty()}.
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@code{version} and @code{version_info}.

@item 
@ref{400,,execute()} and @ref{401,,executemany()}
if @ref{402,,named placeholders} are used and
`parameters' is a sequence instead of a @ref{190,,dict}.
@end itemize

@item 
@ref{104,,typing}: @code{typing.ByteString}, deprecated since Python 3.9,
now causes a @ref{1da,,DeprecationWarning} to be emitted when it is used.

@item 
@ref{108,,urllib}:
@code{urllib.parse.Quoter} is deprecated: it was not intended to be a
public API.
(Contributed by Gregory P. Smith in gh-88168@footnote{https://github.com/python/cpython/issues/88168}.)
@end itemize

@node Pending removal in Python 3 15<3>,Pending removal in Python 3 16<2>,Pending removal in Python 3 14,New Deprecations
@anchor{whatsnew/3 13 pending-removal-in-python-3-15}@anchor{403}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1cb,,__cached__} on a module while
failing to set @ref{1cc,,__spec__.cached}
is deprecated. In Python 3.15, @code{__cached__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
Setting @ref{1cd,,__package__} on a module while
failing to set @ref{1ce,,__spec__.parent}
is deprecated. In Python 3.15, @code{__package__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2b,,ctypes}:


@itemize *

@item 
The undocumented @code{ctypes.SetPointerType()} function
has been deprecated since Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
The obsolete and rarely used @ref{1cf,,CGIHTTPRequestHandler}
has been deprecated since Python 3.13.
No direct replacement exists.
`Anything' is better than CGI to interface
a web server with a request handler.

@item 
The @code{--cgi} flag to the @code{python -m http.server}
command-line interface has been deprecated since Python 3.13.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
The @ref{1d0,,getdefaultlocale()} function
has been deprecated since Python 3.11.
Its removal was originally planned for Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}),
but has been postponed to Python 3.15.
Use @ref{1d1,,getlocale()}, @ref{1d2,,setlocale()},
and @ref{1d3,,getencoding()} instead.
(Contributed by Hugo van Kemenade in gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{1d4,,PurePath.is_reserved()}
has been deprecated since Python 3.13.
Use @ref{1d5,,os.path.isreserved()} to detect reserved paths on Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{1d6,,java_ver()} has been deprecated since Python 3.13.
This function is only useful for Jython support, has a confusing API,
and is largely untested.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{1d7,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the  Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{1d8,,types.CodeType}: Accessing @ref{1d9,,co_lnotab} was
deprecated in 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}
since 3.10 and was planned to be removed in 3.12,
but it only got a proper @ref{1da,,DeprecationWarning} in 3.12.
May be removed in 3.15.
(Contributed by Nikita Sobolev in gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
The undocumented keyword argument syntax for creating
@ref{1db,,NamedTuple} classes
(for example, @code{Point = NamedTuple("Point", x=int, y=int)})
has been deprecated since Python 3.13.
Use the class-based syntax or the functional syntax instead.

@item 
The @ref{1dc,,typing.no_type_check_decorator()} decorator function
has been deprecated since Python 3.13.
After eight years in the @ref{104,,typing} module,
it has yet to be supported by any major type checker.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
The @ref{1dd,,getmark()}, @code{setmark()},
and @ref{1de,,getmarkers()} methods of
the @ref{1df,,Wave_read} and @ref{1e0,,Wave_write} classes
have been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in Python 3 16<2>,Pending removal in future versions<3>,Pending removal in Python 3 15<3>,New Deprecations
@anchor{whatsnew/3 13 pending-removal-in-python-3-16}@anchor{404}
@subsubsection Pending removal in Python 3.16



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1e2,,__loader__} on a module while
failing to set @ref{1e3,,__spec__.loader}
is deprecated. In Python 3.16, @code{__loader__} will cease to be set or
taken into consideration by the import system or the standard library.
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
The @code{'u'} format code (@code{wchar_t})
has been deprecated in documentation since Python 3.3
and at runtime since Python 3.13.
Use the @code{'w'} format code (@ref{1e4,,Py_UCS4})
for Unicode characters instead.
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} is deprecated
and will be removed in Python 3.16,
use @ref{1c3,,inspect.iscoroutinefunction()} instead.
(Contributed by Jiahao Li and Kumar Aditya in gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
Bitwise inversion on boolean types, @code{~True} or @code{~False}
has been deprecated since Python 3.12,
as it produces surprising and unintuitive results (@code{-2} and @code{-1}).
Use @code{not x} instead for the logical negation of a Boolean.
In the rare case that you need the bitwise inversion of
the underlying integer, convert to @code{int} explicitly (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
The @code{ExecError} exception
has been deprecated since Python 3.14.
It has not been used by any function in @code{shutil} since Python 3.4,
and is now an alias of @ref{1e5,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
The @ref{1c7,,Class.get_methods} method
has been deprecated since Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
The @ref{1e6,,_enablelegacywindowsfsencoding()} function
has been deprecated since Python 3.13.
Use the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment variable instead.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
The undocumented and unused @code{TarFile.tarfile} attribute
has been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in future versions<3>,,Pending removal in Python 3 16<2>,New Deprecations
@anchor{whatsnew/3 13 pending-removal-in-future-versions}@anchor{405}
@subsubsection Pending removal in future versions


The following APIs will be removed in the future,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
Nesting argument groups and nesting mutually exclusive
groups are deprecated.

@item 
Passing the undocumented keyword argument `prefix_chars' to
@ref{1c1,,add_argument_group()} is now
deprecated.

@item 
The @ref{1c2,,argparse.FileType} type converter is deprecated.
@end itemize

@item 
@ref{8,,array}’s @code{'u'} format code (gh-57281@footnote{https://github.com/python/cpython/issues/57281})

@item 
@ref{13,,builtins}:


@itemize *

@item 
@code{bool(NotImplemented)}.

@item 
Generators: @code{throw(type, exc, tb)} and @code{athrow(type, exc, tb)}
signature is deprecated: use @code{throw(exc)} and @code{athrow(exc)} instead,
the single argument signature.

@item 
Currently Python accepts numeric literals immediately followed by keywords,
for example @code{0in x}, @code{1or x}, @code{0if 1else 2}.  It allows confusing and
ambiguous expressions like @code{[0x1for x in y]} (which can be interpreted as
@code{[0x1 for x in y]} or @code{[0x1f or x in y]}).  A syntax warning is raised
if the numeric literal is immediately followed by one of keywords
@ref{1e9,,and}, @ref{1ea,,else}, @ref{1eb,,for}, @ref{1ec,,if},
@ref{1ed,,in}, @ref{1ee,,is} and @ref{1ef,,or}.  In a future release it
will be changed to a syntax error. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Support for @code{__index__()} and @code{__int__()} method returning non-int type:
these methods will be required to return an instance of a strict subclass of
@ref{1f0,,int}.

@item 
Support for @code{__float__()} method returning a strict subclass of
@ref{153,,float}: these methods will be required to return an instance of
@ref{153,,float}.

@item 
Support for @code{__complex__()} method returning a strict subclass of
@ref{154,,complex}: these methods will be required to return an instance of
@ref{154,,complex}.

@item 
Delegation of @code{int()} to @code{__trunc__()} method.

@item 
Passing a complex number as the `real' or `imag' argument in the
@ref{154,,complex()} constructor is now deprecated; it should only be passed
as a single positional argument.
(Contributed by Serhiy Storchaka in gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} and @code{calendar.February} constants are
deprecated and replaced by @ref{1f1,,calendar.JANUARY} and
@ref{1f2,,calendar.FEBRUARY}.
(Contributed by Prince Roshan in gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1d9,,codeobject.co_lnotab}: use the @ref{1f3,,codeobject.co_lines()} method
instead.

@item 
@ref{31,,datetime}:


@itemize *

@item 
@ref{1f4,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{1f5,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: Plural value must be an integer.

@item 
@ref{77,,importlib}:


@itemize *

@item 
@code{load_module()} method: use @code{exec_module()} instead.

@item 
@ref{1f6,,cache_from_source()} `debug_override' parameter is
deprecated: use the `optimization' parameter instead.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} tuple interface.

@item 
Implicit @code{None} on return values.
@end itemize

@item 
@ref{87,,logging}: the @code{warn()} method has been deprecated
since Python 3.3, use @ref{1f7,,warning()} instead.

@item 
@ref{8b,,mailbox}: Use of StringIO input and text mode is deprecated, use
BytesIO and binary mode instead.

@item 
@ref{a1,,os}: Calling @ref{1f8,,os.register_at_fork()} in multi-threaded process.

@item 
@code{pydoc.ErrorDuringImport}: A tuple value for `exc_info' parameter is
deprecated, use an exception instance.

@item 
@ref{b9,,re}: More strict rules are now applied for numerical group references
and group names in regular expressions.  Only sequence of ASCII digits is now
accepted as a numerical reference.  The group name in bytes patterns and
replacement strings can now only contain ASCII letters and digits and
underscore.
(Contributed by Serhiy Storchaka in gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
@code{sre_compile}, @code{sre_constants} and @code{sre_parse} modules.

@item 
@ref{c5,,shutil}: @ref{1f9,,rmtree()}”s `onerror' parameter is deprecated in
Python 3.12; use the `onexc' parameter instead.

@item 
@ref{d0,,ssl} options and protocols:


@itemize *

@item 
@ref{1fa,,ssl.SSLContext} without protocol argument is deprecated.

@item 
@ref{1fa,,ssl.SSLContext}: @ref{1fb,,set_npn_protocols()} and
@code{selected_npn_protocol()} are deprecated: use ALPN
instead.

@item 
@code{ssl.OP_NO_SSL*} options

@item 
@code{ssl.OP_NO_TLS*} options

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{1fc,,sysconfig.is_python_build()} `check_home' parameter is deprecated and
ignored.

@item 
@ref{ed,,threading} methods:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{1fd,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{1fe,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{1ff,,threading.Thread.setDaemon()}:
use @ref{200,,threading.Thread.daemon} attribute.

@item 
@code{threading.Thread.getName()}, @ref{201,,threading.Thread.setName()}:
use @ref{202,,threading.Thread.name} attribute.

@item 
@code{threading.currentThread()}: use @ref{203,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{204,,threading.active_count()}.
@end itemize

@item 
@ref{205,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{206,,unittest.IsolatedAsyncioTestCase}: it is deprecated to return a value
that is not @code{None} from a test case.

@item 
@ref{10a,,urllib.parse} deprecated functions: @ref{207,,urlparse()} instead


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{10b,,urllib.request}: @ref{208,,URLopener} and
@ref{209,,FancyURLopener} style of invoking requests is
deprecated. Use newer @ref{20a,,urlopen()} functions and methods.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} should not do partial
writes.

@item 
@ref{125,,xml.etree.ElementTree}: Testing the truth value of an
@ref{20b,,Element} is deprecated. In a future release it
will always return @code{True}. Prefer explicit @code{len(elem)} or
@code{elem is not None} tests instead.

@item 
@ref{20c,,zipimport.zipimporter.load_module()} is deprecated:
use @ref{20d,,exec_module()} instead.
@end itemize

@node CPython Bytecode Changes,C API Changes,New Deprecations,What’s New In Python 3 13
@anchor{whatsnew/3 13 cpython-bytecode-changes}@anchor{406}
@subsection CPython Bytecode Changes



@itemize *

@item 
The oparg of @ref{407,,YIELD_VALUE} is now
@code{1} if the yield is part of a yield-from or await, and @code{0} otherwise.
The oparg of @ref{408,,RESUME} was changed to add a bit indicating
if the except-depth is 1, which is needed to optimize closing of generators.
(Contributed by Irit Katriel in gh-111354@footnote{https://github.com/python/cpython/issues/111354}.)
@end itemize

@node C API Changes,Build Changes,CPython Bytecode Changes,What’s New In Python 3 13
@anchor{whatsnew/3 13 c-api-changes}@anchor{409}
@subsection C API Changes


@menu
* New Features: New Features<2>. 
* Changed C APIs:: 
* Limited C API Changes:: 
* Removed C APIs:: 
* Deprecated C APIs:: 

@end menu

@node New Features<2>,Changed C APIs,,C API Changes
@anchor{whatsnew/3 13 id7}@anchor{40a}
@subsubsection New Features



@itemize *

@item 
Add the @ref{2c8,,PyMonitoring C API}
for generating 
@geindex Python Enhancement Proposals; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} monitoring events:


@itemize *

@item 
@ref{40b,,PyMonitoringState}

@item 
@ref{40c,,PyMonitoring_FirePyStartEvent()}

@item 
@ref{40d,,PyMonitoring_FirePyResumeEvent()}

@item 
@ref{40e,,PyMonitoring_FirePyReturnEvent()}

@item 
@ref{40f,,PyMonitoring_FirePyYieldEvent()}

@item 
@ref{410,,PyMonitoring_FireCallEvent()}

@item 
@ref{411,,PyMonitoring_FireLineEvent()}

@item 
@ref{412,,PyMonitoring_FireJumpEvent()}

@item 
@ref{413,,PyMonitoring_FireBranchEvent()}

@item 
@ref{414,,PyMonitoring_FireCReturnEvent()}

@item 
@ref{415,,PyMonitoring_FirePyThrowEvent()}

@item 
@ref{416,,PyMonitoring_FireRaiseEvent()}

@item 
@ref{417,,PyMonitoring_FireCRaiseEvent()}

@item 
@ref{418,,PyMonitoring_FireReraiseEvent()}

@item 
@ref{419,,PyMonitoring_FireExceptionHandledEvent()}

@item 
@ref{41a,,PyMonitoring_FirePyUnwindEvent()}

@item 
@ref{41b,,PyMonitoring_FireStopIterationEvent()}

@item 
@ref{41c,,PyMonitoring_EnterScope()}

@item 
@ref{41d,,PyMonitoring_ExitScope()}
@end itemize

(Contributed by Irit Katriel in gh-111997@footnote{https://github.com/python/cpython/issues/111997}).

@item 
Add @ref{2c7,,PyMutex}, a lightweight mutex that occupies a single byte,
and the new @ref{41e,,PyMutex_Lock()} and @ref{41f,,PyMutex_Unlock()} functions.
@code{PyMutex_Lock()} will release the @ref{2c5,,GIL} (if currently held)
if the operation needs to block.
(Contributed by Sam Gross in gh-108724@footnote{https://github.com/python/cpython/issues/108724}.)

@item 
Add the @ref{420,,PyTime C API} to provide access to system clocks:


@itemize *

@item 
@ref{421,,PyTime_t}.

@item 
@ref{422,,PyTime_MIN} and @ref{423,,PyTime_MAX}.

@item 
@ref{424,,PyTime_AsSecondsDouble()}.

@item 
@ref{425,,PyTime_Monotonic()}.

@item 
@ref{426,,PyTime_MonotonicRaw()}.

@item 
@ref{427,,PyTime_PerfCounter()}.

@item 
@ref{428,,PyTime_PerfCounterRaw()}.

@item 
@ref{429,,PyTime_Time()}.

@item 
@ref{42a,,PyTime_TimeRaw()}.
@end itemize

(Contributed by Victor Stinner and Petr Viktorin in gh-110850@footnote{https://github.com/python/cpython/issues/110850}.)

@item 
Add the @ref{42b,,PyDict_ContainsString()} function
with the same behavior as @ref{42c,,PyDict_Contains()},
but `key' is specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
(Contributed by Victor Stinner in gh-108314@footnote{https://github.com/python/cpython/issues/108314}.)

@item 
Add the @ref{42e,,PyDict_GetItemRef()} and @ref{42f,,PyDict_GetItemStringRef()}
functions,
which behave similarly to @ref{430,,PyDict_GetItemWithError()},
but return a  @ref{431,,strong reference} instead of a @ref{432,,borrowed reference}.
Moreover, these functions return @code{-1} on error,
removing the need to check @code{PyErr_Occurred()}.
(Contributed by Victor Stinner in gh-106004@footnote{https://github.com/python/cpython/issues/106004}.)

@item 
Add the @ref{433,,PyDict_SetDefaultRef()} function,
which behaves similarly to @ref{434,,PyDict_SetDefault()},
but returns a @ref{431,,strong reference} instead of a @ref{432,,borrowed reference}.
This function returns @code{-1} on error,
@code{0} on insertion,
and @code{1} if the key was already present in the dictionary.
(Contributed by Sam Gross in gh-112066@footnote{https://github.com/python/cpython/issues/112066}.)

@item 
Add the @ref{435,,PyDict_Pop()} and @ref{436,,PyDict_PopString()} functions
to remove a key from a dictionary and optionally return the removed value.
This is similar to @ref{437,,dict.pop()},
though there is no default value,
and @ref{438,,KeyError} is not raised for missing keys.
(Contributed by Stefan Behnel and Victor Stinner in gh-111262@footnote{https://github.com/python/cpython/issues/111262}.)

@item 
Add the @ref{439,,PyMapping_GetOptionalItem()}
and @ref{43a,,PyMapping_GetOptionalItemString()} functions
as alternatives to @ref{43b,,PyObject_GetItem()}
and @ref{43c,,PyMapping_GetItemString()} respectively.
The new functions do not raise @ref{438,,KeyError}
if the requested key is missing from the mapping.
These variants are more convenient and faster
if a missing key should not be treated as a failure.
(Contributed by Serhiy Storchaka in gh-106307@footnote{https://github.com/python/cpython/issues/106307}.)

@item 
Add the @ref{43d,,PyObject_GetOptionalAttr()}
and @ref{43e,,PyObject_GetOptionalAttrString()} functions
as alternatives to  @ref{43f,,PyObject_GetAttr()}
and @ref{440,,PyObject_GetAttrString()} respectively.
The new functions do not raise @ref{441,,AttributeError}
if the requested attribute is not found on the object.
These variants are more convenient and faster
if the missing attribute should not be treated as a failure.
(Contributed by Serhiy Storchaka in gh-106521@footnote{https://github.com/python/cpython/issues/106521}.)

@item 
Add the @ref{442,,PyErr_FormatUnraisable()} function
as an extension to @ref{443,,PyErr_WriteUnraisable()}
that allows customizing the warning message.
(Contributed by Serhiy Storchaka in gh-108082@footnote{https://github.com/python/cpython/issues/108082}.)

@item 
Add new functions that return a @ref{431,,strong reference} instead of
a @ref{432,,borrowed reference} for frame locals, globals, and builtins,
as part of @ref{2af,,PEP 667}:


@itemize *

@item 
@ref{444,,PyEval_GetFrameBuiltins()} replaces @ref{445,,PyEval_GetBuiltins()}

@item 
@ref{446,,PyEval_GetFrameGlobals()} replaces @ref{447,,PyEval_GetGlobals()}

@item 
@ref{448,,PyEval_GetFrameLocals()} replaces @ref{449,,PyEval_GetLocals()}
@end itemize

(Contributed by Mark Shannon and Tian Gao in gh-74929@footnote{https://github.com/python/cpython/issues/74929}.)

@item 
Add the @ref{44a,,Py_GetConstant()} and @ref{44b,,Py_GetConstantBorrowed()}
functions to get @ref{431,,strong}
or @ref{432,,borrowed} references to constants.
For example, @code{Py_GetConstant(Py_CONSTANT_ZERO)} returns a strong reference
to the constant zero.
(Contributed by Victor  Stinner in gh-115754@footnote{https://github.com/python/cpython/issues/115754}.)

@item 
Add the @ref{44c,,PyImport_AddModuleRef()} function
as a replacement for @ref{44d,,PyImport_AddModule()}
that returns a @ref{431,,strong reference} instead of a @ref{432,,borrowed reference}.
(Contributed by Victor Stinner in gh-105922@footnote{https://github.com/python/cpython/issues/105922}.)

@item 
Add the @ref{44e,,Py_IsFinalizing()} function to check
whether the main Python interpreter is
@ref{2bb,,shutting down}.
(Contributed by Victor Stinner in gh-108014@footnote{https://github.com/python/cpython/issues/108014}.)

@item 
Add the @ref{44f,,PyList_GetItemRef()} function
as a replacement for @ref{450,,PyList_GetItem()}
that returns a @ref{431,,strong reference} instead of a @ref{432,,borrowed reference}.
(Contributed by Sam Gross in gh-114329@footnote{https://github.com/python/cpython/issues/114329}.)

@item 
Add the @ref{451,,PyList_Extend()} and @ref{452,,PyList_Clear()} functions,
mirroring the Python @code{list.extend()} and @code{list.clear()} methods.
(Contributed by Victor Stinner in gh-111138@footnote{https://github.com/python/cpython/issues/111138}.)

@item 
Add the @ref{453,,PyLong_AsInt()} function.
It behaves similarly to @ref{454,,PyLong_AsLong()},
but stores the result in a C int instead of a C long.
(Contributed by Victor Stinner in gh-108014@footnote{https://github.com/python/cpython/issues/108014}.)

@item 
Add the @ref{455,,PyLong_AsNativeBytes()}, @ref{456,,PyLong_FromNativeBytes()},
and @ref{457,,PyLong_FromUnsignedNativeBytes()} functions
to simplify converting between native integer types
and Python @ref{1f0,,int} objects.
(Contributed by Steve Dower in gh-111140@footnote{https://github.com/python/cpython/issues/111140}.)

@item 
Add @ref{458,,PyModule_Add()} function, which is similar to
@ref{459,,PyModule_AddObjectRef()} and @ref{45a,,PyModule_AddObject()},
but always steals a reference to the value.
(Contributed by Serhiy Storchaka in gh-86493@footnote{https://github.com/python/cpython/issues/86493}.)

@item 
Add the @ref{45b,,PyObject_GenericHash()} function
that implements the default hashing function of a Python object.
(Contributed by Serhiy Storchaka in gh-113024@footnote{https://github.com/python/cpython/issues/113024}.)

@item 
Add the @ref{45c,,Py_HashPointer()} function to hash a raw pointer.
(Contributed by Victor Stinner in gh-111545@footnote{https://github.com/python/cpython/issues/111545}.)

@item 
Add the @ref{45d,,PyObject_VisitManagedDict()} and
@ref{45e,,PyObject_ClearManagedDict()} functions.
which must be called by the traverse and clear functions of a type using
the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} flag.
The pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} can be used to
use these functions with Python 3.11 and 3.12.
(Contributed by Victor Stinner in gh-107073@footnote{https://github.com/python/cpython/issues/107073}.)

@item 
Add the @ref{460,,PyRefTracer_SetTracer()}
and @ref{461,,PyRefTracer_GetTracer()} functions,
which enable tracking object creation and destruction
in the same way that the @ref{ff,,tracemalloc} module does.
(Contributed by Pablo Galindo in gh-93502@footnote{https://github.com/python/cpython/issues/93502}.)

@item 
Add the @ref{462,,PySys_AuditTuple()} function
as an alternative to @ref{463,,PySys_Audit()}
that takes event arguments as a Python @ref{464,,tuple} object.
(Contributed by Victor Stinner in gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)

@item 
Add the @ref{465,,PyThreadState_GetUnchecked()} function
as an alternative to @ref{466,,PyThreadState_Get()}
that doesn’t kill the process with a fatal error if it is @code{NULL}.
The caller is responsible for checking if the result is @code{NULL}.
(Contributed by Victor Stinner in gh-108867@footnote{https://github.com/python/cpython/issues/108867}.)

@item 
Add the @ref{467,,PyType_GetFullyQualifiedName()} function
to get the type’s fully qualified name.
The module name is prepended if @ref{468,,type.__module__} is
a string and is not equal to either @code{'builtins'} or @code{'__main__'}.
(Contributed by Victor Stinner in gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
Add the @ref{469,,PyType_GetModuleName()} function
to get the type’s module name. This is equivalent to getting the
@ref{468,,type.__module__} attribute.
(Contributed by Eric Snow and Victor Stinner in gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
Add the @ref{46a,,PyUnicode_EqualToUTF8AndSize()}
and @ref{46b,,PyUnicode_EqualToUTF8()} functions
to compare a Unicode object with a const char* UTF-8 encoded string
and @code{1} if they are equal or @code{0} otherwise.
These functions do not raise exceptions.
(Contributed by Serhiy Storchaka in gh-110289@footnote{https://github.com/python/cpython/issues/110289}.)

@item 
Add the @ref{276,,PyWeakref_GetRef()} function
as an alternative to  @ref{274,,PyWeakref_GetObject()}
that returns a @ref{431,,strong reference}
or @code{NULL} if the referent is no longer live.
(Contributed by Victor Stinner in gh-105927@footnote{https://github.com/python/cpython/issues/105927}.)

@item 
Add fixed variants of functions which silently ignore errors:


@itemize *

@item 
@ref{46c,,PyObject_HasAttrWithError()} replaces @ref{46d,,PyObject_HasAttr()}.

@item 
@ref{46e,,PyObject_HasAttrStringWithError()}
replaces @ref{46f,,PyObject_HasAttrString()}.

@item 
@ref{470,,PyMapping_HasKeyWithError()} replaces @ref{471,,PyMapping_HasKey()}.

@item 
@ref{472,,PyMapping_HasKeyStringWithError()}
replaces @ref{473,,PyMapping_HasKeyString()}.
@end itemize

The new functions return @code{-1} for errors
and the standard @code{1} for true and @code{0} for false.

(Contributed by Serhiy Storchaka in gh-108511@footnote{https://github.com/python/cpython/issues/108511}.)
@end itemize

@node Changed C APIs,Limited C API Changes,New Features<2>,C API Changes
@anchor{whatsnew/3 13 changed-c-apis}@anchor{474}
@subsubsection Changed C APIs



@itemize *

@item 
The `keywords' parameter of @ref{475,,PyArg_ParseTupleAndKeywords()}
and @ref{476,,PyArg_VaParseTupleAndKeywords()}
now has type char *const* in C
and const char *const* in C++,
instead of char**.
In C++, this makes these functions compatible with arguments
of type const char *const*, const char**,
or char *const* without an explicit type cast.
In C, the functions only support arguments of type char *const*.
This can be overridden with the @ref{477,,PY_CXX_CONST} macro.
(Contributed by Serhiy Storchaka in gh-65210@footnote{https://github.com/python/cpython/issues/65210}.)

@item 
@ref{475,,PyArg_ParseTupleAndKeywords()} now supports
non-ASCII keyword parameter names.
(Contributed by Serhiy Storchaka in gh-110815@footnote{https://github.com/python/cpython/issues/110815}.)

@item 
The @code{PyCode_GetFirstFree()} function is now unstable API
and is now named @ref{478,,PyUnstable_Code_GetFirstFree()}.
(Contributed by Bogdan Romanyuk in gh-115781@footnote{https://github.com/python/cpython/issues/115781}.)

@item 
The @ref{479,,PyDict_GetItem()}, @ref{47a,,PyDict_GetItemString()},
@ref{471,,PyMapping_HasKey()}, @ref{473,,PyMapping_HasKeyString()},
@ref{46d,,PyObject_HasAttr()}, @ref{46f,,PyObject_HasAttrString()},
and @ref{47b,,PySys_GetObject()} functions,
each of which clears all errors which occurred when calling them
now reports these errors using @ref{355,,sys.unraisablehook()}.
You may replace them with other functions as recommended in the documentation.
(Contributed by Serhiy Storchaka in gh-106672@footnote{https://github.com/python/cpython/issues/106672}.)

@item 
Add support for the @code{%T}, @code{%#T}, @code{%N} and @code{%#N} formats
to @ref{47c,,PyUnicode_FromFormat()}:


@itemize *

@item 
@code{%T}: Get the fully qualified name of an object type

@item 
@code{%#T}: As above, but use a colon as the separator

@item 
@code{%N}: Get the fully qualified name of a type

@item 
@code{%#N}: As above, but use a colon as the separator
@end itemize

See 
@geindex Python Enhancement Proposals; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} for more information.
(Contributed by Victor Stinner in gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
You no longer have to define the @code{PY_SSIZE_T_CLEAN} macro before
including @code{Python.h} when using @code{#} formats in
@ref{47d,,format codes}.
APIs accepting the format codes always use @code{Py_ssize_t} for @code{#} formats.
(Contributed by Inada Naoki in gh-104922@footnote{https://github.com/python/cpython/issues/104922}.)

@item 
If Python is built in @ref{357,,debug mode}
or @ref{47e,,with assertions},
@ref{47f,,PyTuple_SET_ITEM()} and @ref{480,,PyList_SET_ITEM()}
now check the index argument with an assertion.
(Contributed by Victor Stinner in gh-106168@footnote{https://github.com/python/cpython/issues/106168}.)
@end itemize

@node Limited C API Changes,Removed C APIs,Changed C APIs,C API Changes
@anchor{whatsnew/3 13 limited-c-api-changes}@anchor{481}
@subsubsection Limited C API Changes



@itemize *

@item 
The following functions are now included in the Limited C API:


@itemize *

@item 
@ref{482,,PyMem_RawMalloc()}

@item 
@ref{483,,PyMem_RawCalloc()}

@item 
@ref{484,,PyMem_RawRealloc()}

@item 
@ref{485,,PyMem_RawFree()}

@item 
@ref{463,,PySys_Audit()}

@item 
@ref{462,,PySys_AuditTuple()}

@item 
@ref{486,,PyType_GetModuleByDef()}
@end itemize

(Contributed by Victor Stinner in gh-85283@footnote{https://github.com/python/cpython/issues/85283}, gh-85283@footnote{https://github.com/python/cpython/issues/85283}, and gh-116936@footnote{https://github.com/python/cpython/issues/116936}.)

@item 
Python built with @ref{487,,--with-trace-refs} (tracing references)
now supports the @ref{488,,Limited API}.
(Contributed by Victor Stinner in gh-108634@footnote{https://github.com/python/cpython/issues/108634}.)
@end itemize

@node Removed C APIs,Deprecated C APIs,Limited C API Changes,C API Changes
@anchor{whatsnew/3 13 removed-c-apis}@anchor{489}
@subsubsection Removed C APIs



@itemize *

@item 
Remove several functions, macros, variables, etc
with names prefixed by @code{_Py} or @code{_PY} (which are considered private).
If your project is affected  by one of these removals
and you believe that the removed API should remain available,
please @ref{3a7,,open a new issue} to request a public C API
and add @code{cc: @@vstinner} to the issue to notify Victor Stinner.
(Contributed by Victor Stinner in gh-106320@footnote{https://github.com/python/cpython/issues/106320}.)

@item 
Remove old buffer protocols deprecated in Python 3.0.
Use @ref{48a,,Protocolo búfer} instead.


@itemize *

@item 
@code{PyObject_CheckReadBuffer()}:
Use @ref{48b,,PyObject_CheckBuffer()} to test
whether the object supports the buffer protocol.
Note that @ref{48b,,PyObject_CheckBuffer()} doesn’t guarantee
that @ref{48c,,PyObject_GetBuffer()} will succeed.
To test if the object is actually readable,
see the next example of @ref{48c,,PyObject_GetBuffer()}.

@item 
@code{PyObject_AsCharBuffer()}, @code{PyObject_AsReadBuffer()}:
Use @ref{48c,,PyObject_GetBuffer()} and @ref{48d,,PyBuffer_Release()} instead:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) < 0) @{
    return NULL;
@}
// Use `view.buf` and `view.len` to read from the buffer.
// You may need to cast buf as `(const char*)view.buf`.
PyBuffer_Release(&view);
@end example

@item 
@code{PyObject_AsWriteBuffer()}:
Use @ref{48c,,PyObject_GetBuffer()} and @ref{48d,,PyBuffer_Release()} instead:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_WRITABLE) < 0) @{
    return NULL;
@}
// Use `view.buf` and `view.len` to write to the buffer.
PyBuffer_Release(&view);
@end example
@end itemize

(Contributed by Inada Naoki in gh-85275@footnote{https://github.com/python/cpython/issues/85275}.)

@item 
Remove various functions deprecated in Python 3.9:


@itemize *

@item 
@code{PyEval_CallObject()}, @code{PyEval_CallObjectWithKeywords()}:
Use @ref{48e,,PyObject_CallNoArgs()} or @ref{48f,,PyObject_Call()} instead.

@cartouche
@quotation Advertencia 
In @ref{48f,,PyObject_Call()}, positional arguments must be a @ref{464,,tuple}
and must not be @code{NULL},
and keyword arguments must be a @ref{190,,dict} or @code{NULL},
whereas the removed functions checked argument types
and accepted @code{NULL} positional and keyword arguments.
To replace @code{PyEval_CallObjectWithKeywords(func, NULL, kwargs)} with
@ref{48f,,PyObject_Call()},
pass an empty tuple as positional arguments using
@ref{490,,PyTuple_New(0)}.
@end quotation
@end cartouche

@item 
@code{PyEval_CallFunction()}:
Use @ref{491,,PyObject_CallFunction()} instead.

@item 
@code{PyEval_CallMethod()}:
Use @ref{492,,PyObject_CallMethod()} instead.

@item 
@code{PyCFunction_Call()}:
Use @ref{48f,,PyObject_Call()} instead.
@end itemize

(Contributed by Victor Stinner in gh-105107@footnote{https://github.com/python/cpython/issues/105107}.)

@item 
Remove the following old functions to configure the Python initialization,
deprecated in Python 3.11:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}:
Use @ref{493,,PyConfig.warnoptions} instead.

@item 
@code{PySys_AddWarnOption()}:
Use @ref{493,,PyConfig.warnoptions} instead.

@item 
@code{PySys_AddXOption()}:
Use @ref{494,,PyConfig.xoptions} instead.

@item 
@code{PySys_HasWarnOptions()}:
Use @ref{494,,PyConfig.xoptions} instead.

@item 
@code{PySys_SetPath()}:
Set @ref{495,,PyConfig.module_search_paths} instead.

@item 
@code{Py_SetPath()}:
Set @ref{495,,PyConfig.module_search_paths} instead.

@item 
@code{Py_SetStandardStreamEncoding()}:
Set @ref{496,,PyConfig.stdio_encoding} instead,
and set also maybe @ref{497,,PyConfig.legacy_windows_stdio} (on Windows).

@item 
@code{_Py_SetProgramFullPath()}:
Set @ref{498,,PyConfig.executable} instead.
@end itemize

Use the new @ref{499,,PyConfig} API of the @ref{49a,,Python Initialization Configuration} instead (
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}), added to Python 3.8.
(Contributed by Victor Stinner in gh-105145@footnote{https://github.com/python/cpython/issues/105145}.)

@item 
Remove @code{PyEval_AcquireLock()} and @code{PyEval_ReleaseLock()} functions,
deprecated in Python 3.2.
They didn’t update the current thread state.
They can be replaced with:


@itemize *

@item 
@ref{49b,,PyEval_SaveThread()} and @ref{49c,,PyEval_RestoreThread()};

@item 
low-level @ref{49d,,PyEval_AcquireThread()} and @ref{49c,,PyEval_RestoreThread()};

@item 
or @ref{49e,,PyGILState_Ensure()} and @ref{49f,,PyGILState_Release()}.
@end itemize

(Contributed by Victor Stinner in gh-105182@footnote{https://github.com/python/cpython/issues/105182}.)

@item 
Remove the @code{PyEval_ThreadsInitialized()} function,
deprecated in Python 3.9.
Since Python 3.7, @code{Py_Initialize()} always creates the GIL:
calling @code{PyEval_InitThreads()} does nothing and
@code{PyEval_ThreadsInitialized()} always returns non-zero.
(Contributed by Victor Stinner in gh-105182@footnote{https://github.com/python/cpython/issues/105182}.)

@item 
Remove the @code{_PyInterpreterState_Get()} alias to
@ref{4a0,,PyInterpreterState_Get()}
which was kept for backward compatibility with Python 3.8.
The pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} can be used to get
@ref{4a0,,PyInterpreterState_Get()} on Python 3.8 and older.
(Contributed by Victor Stinner in gh-106320@footnote{https://github.com/python/cpython/issues/106320}.)

@item 
Remove the private @code{_PyObject_FastCall()} function:
use @code{PyObject_Vectorcall()} which is available since Python 3.8
(
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}).
(Contributed by Victor Stinner in gh-106023@footnote{https://github.com/python/cpython/issues/106023}.)

@item 
Remove the @code{cpython/pytime.h} header file,
which only contained private functions.
(Contributed by Victor Stinner in gh-106316@footnote{https://github.com/python/cpython/issues/106316}.)

@item 
Remove the undocumented @code{PY_TIMEOUT_MAX} constant from the limited C API.
(Contributed by Victor Stinner in gh-110014@footnote{https://github.com/python/cpython/issues/110014}.)

@item 
Remove the old trashcan macros @code{Py_TRASHCAN_SAFE_BEGIN}
and @code{Py_TRASHCAN_SAFE_END}.
Replace both with the new macros @code{Py_TRASHCAN_BEGIN}
and @code{Py_TRASHCAN_END}.
(Contributed by Irit Katriel in gh-105111@footnote{https://github.com/python/cpython/issues/105111}.)
@end itemize

@node Deprecated C APIs,,Removed C APIs,C API Changes
@anchor{whatsnew/3 13 deprecated-c-apis}@anchor{4a1}
@subsubsection Deprecated C APIs



@itemize *

@item 
Deprecate old Python initialization functions:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}:
Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@item 
@ref{27a,,Py_GetExecPrefix()}:
Get @ref{27c,,sys.exec_prefix} instead.

@item 
@ref{27d,,Py_GetPath()}:
Get @ref{27e,,sys.path} instead.

@item 
@ref{27f,,Py_GetPrefix()}:
Get @ref{281,,sys.prefix} instead.

@item 
@ref{282,,Py_GetProgramFullPath()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{284,,Py_GetProgramName()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{285,,Py_GetPythonHome()}:
Get @ref{286,,PyConfig.home}
or the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment variable instead.
@end itemize

(Contributed by Victor Stinner in gh-105145@footnote{https://github.com/python/cpython/issues/105145}.)

@item 
@ref{1c4,,Soft deprecate} the
@ref{445,,PyEval_GetBuiltins()}, @ref{447,,PyEval_GetGlobals()},
and @ref{449,,PyEval_GetLocals()} functions,
which return a @ref{432,,borrowed reference}.
(Soft deprecated as part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Deprecate the @ref{272,,PyImport_ImportModuleNoBlock()} function,
which is just an alias to @ref{273,,PyImport_ImportModule()} since Python 3.3.
(Contributed by Victor Stinner in gh-105396@footnote{https://github.com/python/cpython/issues/105396}.)

@item 
@ref{1c4,,Soft deprecate} the
@ref{45a,,PyModule_AddObject()} function.
It should be replaced with @ref{458,,PyModule_Add()}
or @ref{459,,PyModule_AddObjectRef()}.
(Contributed by Serhiy Storchaka in gh-86493@footnote{https://github.com/python/cpython/issues/86493}.)

@item 
Deprecate the old @code{Py_UNICODE} and @code{PY_UNICODE_TYPE} types
and the @code{Py_UNICODE_WIDE} define.
Use the @code{wchar_t} type directly instead.
Since Python 3.3, @code{Py_UNICODE} and @code{PY_UNICODE_TYPE}
are just aliases to @code{wchar_t}.
(Contributed by Victor Stinner in gh-105156@footnote{https://github.com/python/cpython/issues/105156}.)

@item 
Deprecate the @ref{274,,PyWeakref_GetObject()} and
@ref{275,,PyWeakref_GET_OBJECT()} functions,
which return a @ref{432,,borrowed reference}.
Replace them with the new @ref{276,,PyWeakref_GetRef()} function,
which returns a @ref{431,,strong reference}.
The pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} can be used to get
@ref{276,,PyWeakref_GetRef()} on Python 3.12 and older.
(Contributed by Victor Stinner in gh-105927@footnote{https://github.com/python/cpython/issues/105927}.)
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Pending removal in Python 3.14: Pending removal in Python 3 14<2>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<4>. 
* Pending removal in future versions: Pending removal in future versions<4>. 

@end menu

@node Pending removal in Python 3 14<2>,Pending removal in Python 3 15<4>,,Deprecated C APIs
@anchor{whatsnew/3 13 id8}@anchor{4a2}
@subsubsection Pending removal in Python 3.14



@itemize *

@item 
The @code{ma_version_tag} field in @ref{4a3,,PyDictObject} for extension modules
(
@geindex Python Enhancement Proposals; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}; gh-101193@footnote{https://github.com/python/cpython/issues/101193}).

@item 
Creating @ref{2a7,,immutable types} with mutable
bases (gh-95388@footnote{https://github.com/python/cpython/issues/95388}).

@item 
Functions to configure Python’s initialization, deprecated in Python 3.11:


@itemize *

@item 
@code{PySys_SetArgvEx()}:
Set @ref{4a4,,PyConfig.argv} instead.

@item 
@code{PySys_SetArgv()}:
Set @ref{4a4,,PyConfig.argv} instead.

@item 
@code{Py_SetProgramName()}:
Set @ref{4a5,,PyConfig.program_name} instead.

@item 
@code{Py_SetPythonHome()}:
Set @ref{286,,PyConfig.home} instead.
@end itemize

The @ref{4a6,,Py_InitializeFromConfig()} API should be used with
@ref{499,,PyConfig} instead.

@item 
Global configuration variables:


@itemize *

@item 
@ref{4a7,,Py_DebugFlag}:
Use @ref{4a8,,PyConfig.parser_debug} instead.

@item 
@ref{4a9,,Py_VerboseFlag}:
Use @ref{4aa,,PyConfig.verbose} instead.

@item 
@ref{4ab,,Py_QuietFlag}:
Use @ref{4ac,,PyConfig.quiet} instead.

@item 
@ref{4ad,,Py_InteractiveFlag}:
Use @ref{4ae,,PyConfig.interactive} instead.

@item 
@ref{4af,,Py_InspectFlag}:
Use @ref{4b0,,PyConfig.inspect} instead.

@item 
@ref{4b1,,Py_OptimizeFlag}:
Use @ref{4b2,,PyConfig.optimization_level} instead.

@item 
@ref{4b3,,Py_NoSiteFlag}:
Use @ref{4b4,,PyConfig.site_import} instead.

@item 
@ref{4b5,,Py_BytesWarningFlag}:
Use @ref{4b6,,PyConfig.bytes_warning} instead.

@item 
@ref{4b7,,Py_FrozenFlag}:
Use @ref{4b8,,PyConfig.pathconfig_warnings} instead.

@item 
@ref{4b9,,Py_IgnoreEnvironmentFlag}:
Use @ref{4ba,,PyConfig.use_environment} instead.

@item 
@ref{4bb,,Py_DontWriteBytecodeFlag}:
Use @ref{4bc,,PyConfig.write_bytecode} instead.

@item 
@ref{4bd,,Py_NoUserSiteDirectory}:
Use @ref{4be,,PyConfig.user_site_directory} instead.

@item 
@ref{4bf,,Py_UnbufferedStdioFlag}:
Use @ref{4c0,,PyConfig.buffered_stdio} instead.

@item 
@ref{4c1,,Py_HashRandomizationFlag}:
Use @ref{4c2,,PyConfig.use_hash_seed}
and @ref{4c3,,PyConfig.hash_seed} instead.

@item 
@ref{4c4,,Py_IsolatedFlag}:
Use @ref{4c5,,PyConfig.isolated} instead.

@item 
@ref{4c6,,Py_LegacyWindowsFSEncodingFlag}:
Use @ref{4c7,,PyPreConfig.legacy_windows_fs_encoding} instead.

@item 
@ref{4c8,,Py_LegacyWindowsStdioFlag}:
Use @ref{497,,PyConfig.legacy_windows_stdio} instead.

@item 
@code{Py_FileSystemDefaultEncoding}:
Use @ref{4c9,,PyConfig.filesystem_encoding} instead.

@item 
@code{Py_HasFileSystemDefaultEncoding}:
Use @ref{4c9,,PyConfig.filesystem_encoding} instead.

@item 
@code{Py_FileSystemDefaultEncodeErrors}:
Use @ref{4ca,,PyConfig.filesystem_errors} instead.

@item 
@code{Py_UTF8Mode}:
Use @ref{4cb,,PyPreConfig.utf8_mode} instead.
(see @ref{4cc,,Py_PreInitialize()})
@end itemize

The @ref{4a6,,Py_InitializeFromConfig()} API should be used with
@ref{499,,PyConfig} instead.
@end itemize

@node Pending removal in Python 3 15<4>,Pending removal in future versions<4>,Pending removal in Python 3 14<2>,Deprecated C APIs
@anchor{whatsnew/3 13 id9}@anchor{4cd}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The bundled copy of @code{libmpdecimal}.

@item 
The @ref{272,,PyImport_ImportModuleNoBlock()}:
Use @ref{273,,PyImport_ImportModule()} instead.

@item 
@ref{274,,PyWeakref_GetObject()} and @ref{275,,PyWeakref_GET_OBJECT()}:
Use @ref{276,,PyWeakref_GetRef()} instead.

@item 
@ref{277,,Py_UNICODE} type and the @code{Py_UNICODE_WIDE} macro:
Use @code{wchar_t} instead.

@item 
Python initialization functions:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}:
Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@item 
@ref{27a,,Py_GetExecPrefix()}:
Get @ref{27b,,sys.base_exec_prefix} and @ref{27c,,sys.exec_prefix} instead.

@item 
@ref{27d,,Py_GetPath()}:
Get @ref{27e,,sys.path} instead.

@item 
@ref{27f,,Py_GetPrefix()}:
Get @ref{280,,sys.base_prefix} and @ref{281,,sys.prefix} instead.

@item 
@ref{282,,Py_GetProgramFullPath()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{284,,Py_GetProgramName()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{285,,Py_GetPythonHome()}:
Get @ref{286,,PyConfig.home}
or the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment variable instead.
@end itemize
@end itemize

@node Pending removal in future versions<4>,,Pending removal in Python 3 15<4>,Deprecated C APIs
@anchor{whatsnew/3 13 id10}@anchor{4ce}
@subsubsection Pending removal in future versions


The following APIs are deprecated and will be removed,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{289,,Py_TPFLAGS_HAVE_FINALIZE}:
Unneeded since Python 3.8.

@item 
@ref{28a,,PyErr_Fetch()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28c,,PyErr_NormalizeException()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28d,,PyErr_Restore()}:
Use @ref{28e,,PyErr_SetRaisedException()} instead.

@item 
@ref{28f,,PyModule_GetFilename()}:
Use @ref{290,,PyModule_GetFilenameObject()} instead.

@item 
@ref{291,,PyOS_AfterFork()}:
Use @ref{292,,PyOS_AfterFork_Child()} instead.

@item 
@ref{293,,PySlice_GetIndicesEx()}:
Use @ref{294,,PySlice_Unpack()} and @ref{295,,PySlice_AdjustIndices()} instead.

@item 
@code{PyUnicode_AsDecodedObject()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsDecodedUnicode()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsEncodedObject()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@code{PyUnicode_AsEncodedUnicode()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@ref{298,,PyUnicode_READY()}:
Unneeded since Python 3.12

@item 
@code{PyErr_Display()}:
Use @ref{299,,PyErr_DisplayException()} instead.

@item 
@code{_PyErr_ChainExceptions()}:
Use @code{_PyErr_ChainExceptions1()} instead.

@item 
@code{PyBytesObject.ob_shash} member:
call @ref{29a,,PyObject_Hash()} instead.

@item 
@code{PyDictObject.ma_version_tag} member.

@item 
Thread Local Storage (TLS) API:


@itemize *

@item 
@ref{29b,,PyThread_create_key()}:
Use @ref{29c,,PyThread_tss_alloc()} instead.

@item 
@ref{29d,,PyThread_delete_key()}:
Use @ref{29e,,PyThread_tss_free()} instead.

@item 
@ref{29f,,PyThread_set_key_value()}:
Use @ref{2a0,,PyThread_tss_set()} instead.

@item 
@ref{2a1,,PyThread_get_key_value()}:
Use @ref{2a2,,PyThread_tss_get()} instead.

@item 
@ref{2a3,,PyThread_delete_key_value()}:
Use @ref{2a4,,PyThread_tss_delete()} instead.

@item 
@ref{2a5,,PyThread_ReInitTLS()}:
Unneeded since Python 3.7.
@end itemize
@end itemize

@node Build Changes,Porting to Python 3 13,C API Changes,What’s New In Python 3 13
@anchor{whatsnew/3 13 build-changes}@anchor{4cf}@anchor{whatsnew/3 13 pythoncapi-compat-project}@anchor{4d0}
@subsection Build Changes



@itemize *

@item 
@code{arm64-apple-ios} and @code{arm64-apple-ios-simulator} are both
now 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} tier 3 platforms.
(@ref{2d1,,PEP 730} written
and implementation contributed by Russell Keith-Magee in gh-114099@footnote{https://github.com/python/cpython/issues/114099}.)

@item 
@code{aarch64-linux-android} and @code{x86_64-linux-android} are both
now 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} tier 3 platforms.
(@ref{2d1,,PEP 738} written
and implementation contributed by Malcolm Smith in gh-116622@footnote{https://github.com/python/cpython/issues/116622}.)

@item 
@code{wasm32-wasi} is now a 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} tier 2 platform.
(Contributed by Brett Cannon in gh-115192@footnote{https://github.com/python/cpython/issues/115192}.)

@item 
@code{wasm32-emscripten} is no longer a 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} supported platform.
(Contributed by Brett Cannon in gh-115192@footnote{https://github.com/python/cpython/issues/115192}.)

@item 
Building CPython now requires a compiler with support for the C11 atomic
library, GCC built-in atomic functions, or MSVC interlocked intrinsics.

@item 
Autoconf 2.71 and aclocal 1.16.5 are now required to regenerate
the @code{configure} script.
(Contributed by Christian Heimes in gh-89886@footnote{https://github.com/python/cpython/issues/89886} and by Victor Stinner in gh-112090@footnote{https://github.com/python/cpython/issues/112090}.)

@item 
SQLite 3.15.2 or newer is required to build
the @ref{cf,,sqlite3} extension module.
(Contributed by Erlend Aasland in gh-105875@footnote{https://github.com/python/cpython/issues/105875}.)

@item 
CPython now bundles the mimalloc library@footnote{https://github.com/microsoft/mimalloc/} by default.
It is licensed under the MIT license;
see @ref{4d1,,mimalloc license}.
The bundled mimalloc has custom changes, see gh-113141@footnote{https://github.com/python/cpython/issues/113141} for details.
(Contributed by Dino Viehland in gh-109914@footnote{https://github.com/python/cpython/issues/109914}.)

@item 
The @code{configure} option @ref{4d2,,--with-system-libmpdec}
now defaults to @code{yes}.
The bundled copy of @code{libmpdecimal} will be removed in Python 3.15.

@item 
Python built with @code{configure} @ref{487,,--with-trace-refs}
(tracing references) is now ABI compatible with the Python release build
and @ref{357,,debug build}.
(Contributed by Victor Stinner in gh-108634@footnote{https://github.com/python/cpython/issues/108634}.)

@item 
On POSIX systems, the pkg-config (@code{.pc}) filenames now include the ABI
flags.  For example, the free-threaded build generates @code{python-3.13t.pc}
and the debug build generates @code{python-3.13d.pc}.

@item 
The @code{errno}, @code{fcntl}, @code{grp}, @code{md5}, @code{pwd}, @code{resource},
@code{termios}, @code{winsound},
@code{_ctypes_test}, @code{_multiprocessing.posixshmem}, @code{_scproxy}, @code{_stat},
@code{_statistics}, @code{_testconsole}, @code{_testimportmultiple} and @code{_uuid}
C extensions are now built with the @ref{488,,limited C API}.
(Contributed by Victor Stinner in gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)
@end itemize

@node Porting to Python 3 13,Regression Test Changes,Build Changes,What’s New In Python 3 13
@anchor{whatsnew/3 13 porting-to-python-3-13}@anchor{2b3}
@subsection Porting to Python 3.13


This section lists previously described changes and other bugfixes
that may require changes to your code.

@menu
* Changes in the Python API: Changes in the Python API<2>. 
* Changes in the C API:: 

@end menu

@node Changes in the Python API<2>,Changes in the C API,,Porting to Python 3 13
@anchor{whatsnew/3 13 changes-in-the-python-api}@anchor{4d3}
@subsubsection Changes in the Python API

@anchor{whatsnew/3 13 pep667-porting-notes-py}@anchor{2ee}

@itemize *

@item 
@ref{2af,,PEP 667} introduces several changes
to the semantics of @ref{2ae,,locals()} and @ref{2ed,,f_locals}:


@itemize *

@item 
Calling @ref{2ae,,locals()} in an @ref{2e9,,optimized scope} now produces an
independent snapshot on each call, and hence no longer implicitly updates
previously returned references. Obtaining the legacy CPython behavior now
requires explicit calls to update the initially returned dictionary with the
results of subsequent calls to @code{locals()}. Code execution functions that
implicitly target @code{locals()} (such as @code{exec} and @code{eval}) must be
passed an explicit namespace to access their results in an optimized scope.
(Changed as part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Calling @ref{2ae,,locals()} from a comprehension at module or class scope
(including via @code{exec} or @code{eval}) once more behaves as if the comprehension
were running as an independent nested function (i.e. the local variables from
the containing scope are not included). In Python 3.12, this had changed
to include the local variables from the containing scope when implementing
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}. (Changed as part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Accessing @ref{2ed,,FrameType.f_locals} in an
@ref{2e9,,optimized scope} now returns a write-through proxy rather than a
snapshot that gets updated at ill-specified times. If a snapshot is desired,
it must be created explicitly with @code{dict} or the proxy’s @code{.copy()} method.
(Changed as part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)
@end itemize

@item 
@ref{17a,,functools.partial} now emits a @ref{4d4,,FutureWarning}
when used as a method.
The behavior will change in future Python versions.
Wrap it in @ref{22e,,staticmethod()} if you want to preserve the old behavior.
(Contributed by Serhiy Storchaka in gh-121027@footnote{https://github.com/python/cpython/issues/121027}.)

@item 
An @ref{4d5,,OSError} is now raised by @ref{4d6,,getpass.getuser()}
for any failure to retrieve a username,
instead of @ref{4d7,,ImportError} on non-Unix platforms
or @ref{438,,KeyError} on Unix platforms where the password database is empty.

@item 
The value of the @code{mode} attribute of @ref{4d8,,gzip.GzipFile}
is now a string (@code{'rb'} or @code{'wb'}) instead of an integer (@code{1} or @code{2}).
The value of the @code{mode} attribute of the readable file-like object
returned by @ref{4d9,,zipfile.ZipFile.open()} is now @code{'rb'} instead of @code{'r'}.
(Contributed by Serhiy Storchaka in gh-115961@footnote{https://github.com/python/cpython/issues/115961}.)

@item 
@ref{4da,,mailbox.Maildir} now ignores files with a leading dot (@code{.}).
(Contributed by Zackery Spytz in gh-65559@footnote{https://github.com/python/cpython/issues/65559}.)

@item 
@ref{388,,pathlib.Path.glob()} and @ref{389,,rglob()} now return both
files and directories if a pattern that ends with «@code{**}» is given,
rather than directories only.
Add a trailing slash to keep the previous behavior and only match directories.

@item 
The @ref{ed,,threading} module now expects the @code{_thread} module
to have an @code{_is_main_interpreter()} function.
This function takes no arguments and returns @code{True}
if the current interpreter is the main interpreter.

Any library or application that provides a custom @code{_thread} module
must provide @code{_is_main_interpreter()},
just like the module’s other «private» attributes.
(gh-112826@footnote{https://github.com/python/cpython/issues/112826}.)
@end itemize

@node Changes in the C API,,Changes in the Python API<2>,Porting to Python 3 13
@anchor{whatsnew/3 13 changes-in-the-c-api}@anchor{4db}
@subsubsection Changes in the C API



@itemize *

@item 
@code{Python.h} no longer includes the @code{<ieeefp.h>} standard header. It was
included for the @code{finite()} function which is now provided by the
@code{<math.h>} header. It should now be included explicitly if needed. Remove
also the @code{HAVE_IEEEFP_H} macro.
(Contributed by Victor Stinner in gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
@code{Python.h} no longer includes these standard header files: @code{<time.h>},
@code{<sys/select.h>} and @code{<sys/time.h>}. If needed, they should now be
included explicitly. For example, @code{<time.h>} provides the @code{clock()} and
@code{gmtime()} functions, @code{<sys/select.h>} provides the @code{select()}
function, and @code{<sys/time.h>} provides the @code{futimes()}, @code{gettimeofday()}
and @code{setitimer()} functions.
(Contributed by Victor Stinner in gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
On Windows, @code{Python.h} no longer includes the @code{<stddef.h>} standard
header file. If needed, it should now be included explicitly. For example, it
provides @code{offsetof()} function, and @code{size_t} and @code{ptrdiff_t} types.
Including @code{<stddef.h>} explicitly was already needed by all other
platforms, the @code{HAVE_STDDEF_H} macro is only defined on Windows.
(Contributed by Victor Stinner in gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
If the @ref{4dc,,Py_LIMITED_API} macro is defined, @code{Py_BUILD_CORE},
@code{Py_BUILD_CORE_BUILTIN} and @code{Py_BUILD_CORE_MODULE} macros
are now undefined by @code{<Python.h>}.
(Contributed by Victor Stinner in gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)

@item 
The old trashcan macros @code{Py_TRASHCAN_SAFE_BEGIN} and @code{Py_TRASHCAN_SAFE_END}
were removed. They should be replaced by the new macros @code{Py_TRASHCAN_BEGIN}
and @code{Py_TRASHCAN_END}.

A @code{tp_dealloc} function that has the old macros, such as:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

should migrate to the new macros as follows:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, mytype_dealloc)
    ...
    Py_TRASHCAN_END
@}
@end example

Note that @code{Py_TRASHCAN_BEGIN} has a second argument which
should be the deallocation function it is in. The new macros were
added in Python 3.8 and the old macros were deprecated in Python 3.11.
(Contributed by Irit Katriel in gh-105111@footnote{https://github.com/python/cpython/issues/105111}.)
@end itemize
@anchor{whatsnew/3 13 pep667-porting-notes-c}@anchor{2ef}

@itemize *

@item 
@ref{2af,,PEP 667} introduces several changes
to frame-related functions:


@itemize *

@item 
The effects of mutating the dictionary returned from
@ref{449,,PyEval_GetLocals()} in an @ref{2e9,,optimized scope} have changed.
New dict entries added this way will now `only' be visible to
subsequent @ref{449,,PyEval_GetLocals()} calls in that frame,
as @ref{4dd,,PyFrame_GetLocals()}, @ref{2ae,,locals()},
and @ref{2ed,,FrameType.f_locals} no longer access
the same underlying cached dictionary.
Changes made to entries for actual variable names and names added via
the write-through proxy interfaces will be overwritten on subsequent calls
to @ref{449,,PyEval_GetLocals()} in that frame.
The recommended code update depends on how the function was being used,
so refer to the deprecation notice on the function for details.

@item 
Calling @ref{4dd,,PyFrame_GetLocals()} in an @ref{2e9,,optimized scope}
now returns a write-through proxy rather than a snapshot
that gets updated at ill-specified times.
If a snapshot is desired, it must be created explicitly
(e.g. with @ref{4de,,PyDict_Copy()}),
or by calling the new @ref{448,,PyEval_GetFrameLocals()} API.

@item 
@code{PyFrame_FastToLocals()} and @code{PyFrame_FastToLocalsWithError()}
no longer have any effect.
Calling these functions has been redundant since Python 3.11,
when @ref{4dd,,PyFrame_GetLocals()} was first introduced.

@item 
@code{PyFrame_LocalsToFast()} no longer has any effect.
Calling this function is redundant now that @ref{4dd,,PyFrame_GetLocals()}
returns a write-through proxy for @ref{2e9,,optimized scopes}.
@end itemize
@end itemize

@node Regression Test Changes,,Porting to Python 3 13,What’s New In Python 3 13
@anchor{whatsnew/3 13 regression-test-changes}@anchor{4df}
@subsection Regression Test Changes



@itemize *

@item 
Python built with @code{configure} @ref{4e0,,--with-pydebug} now
supports a @ref{2e2,,-X presite=package.module} command-line
option. If used, it specifies a module that should be imported early
in the lifecycle of the interpreter, before @code{site.py} is executed.
(Contributed by Łukasz Langa in gh-110769@footnote{https://github.com/python/cpython/issues/110769}.)
@end itemize

@node Novedades de Python 3 12,Qué hay de nuevo en Python 3 11,What’s New In Python 3 13,Qué hay de nuevo en Python
@anchor{whatsnew/3 12 doc}@anchor{4e1}@anchor{whatsnew/3 12 what-s-new-in-python-3-12}@anchor{4e2}
@section Novedades de Python 3.12


@*Editor: 
Adam Turner


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log when
@c researching a change.

Este artículo explica las nuevas características de Python 3.12, en comparación con 3.11. Python 3.12 se lanzó el 2 de octubre de 2023. Para obtener detalles completos, consulte @ref{13b,,changelog}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 693
PEP 693@footnote{https://peps.python.org/pep-0693/} - Calendario de lanzamiento de Python 3.12


@menu
* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión. 
* Nuevas características:: 
* Nuevas funciones relacionadas con las sugerencias de escritura:: 
* Otros cambios del lenguaje:: 
* Nuevos módulos:: 
* Módulos mejorados:: 
* Optimizaciones:: 
* Cambios en el código de bytes de CPython:: 
* Demostraciones y herramientas:: 
* Obsoleto:: 
* Eliminado:: 
* Portar a Python 3.12: Portar a Python 3 12. 
* Cambios de compilación:: 
* Cambios en la API de C:: 

@end menu

@node Resumen aspectos destacados de la versión,Nuevas características,,Novedades de Python 3 12
@anchor{whatsnew/3 12 summary-release-highlights}@anchor{4e3}
@subsection Resumen: aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.12.
@c Brevity is key.

Python 3.12 is a stable release of the Python programming language,
with a mix of changes to the language and the standard library.
The library changes focus on cleaning up deprecated APIs, usability, and correctness.
Of note, the @code{distutils} package has been removed from the standard library.
Filesystem support in @ref{a1,,os} and @ref{a4,,pathlib} has seen a number of improvements,
and several modules have better performance.

Los cambios de idioma se centran en la usabilidad, ya que a @ref{4e4,,f-strings} se le han eliminado muchas limitaciones y las sugerencias «¿Quiso decir…» continúan mejorando. La nueva declaración @ref{4e5,,type parameter syntax} y @ref{4e6,,type} mejora la ergonomía para usar @ref{157,,generic types} y @ref{4e7,,type aliases} con controladores de tipo estático.

Este artículo no intenta proporcionar una especificación completa de todas las características nuevas, sino que brinda una descripción general conveniente. Para obtener detalles completos, debe consultar la documentación, como @ref{2b1,,Library Reference} y @ref{2b2,,Language Reference}. Si desea comprender la implementación completa y la justificación del diseño de un cambio, consulte el PEP para conocer una característica nueva en particular; pero tenga en cuenta que los PEP generalmente no se mantienen actualizados una vez que una característica se ha implementado por completo.


__________________________________________________________________


@c PEP-sized items next.

Nuevas características de sintaxis:


@itemize *

@item 
@ref{4e5,,PEP 695}, sintaxis de parámetro de tipo y sentencia @ref{4e6,,type}
@end itemize

Nuevas características gramaticales:


@itemize *

@item 
@ref{4e8,,PEP 701}, @ref{4e4,,f-strings} en la gramática
@end itemize

Mejoras del intérprete:


@itemize *

@item 
@ref{4e9,,PEP 684}, un @ref{2b5,,GIL} único por intérprete

@item 
@ref{4ea,,PEP 669}, monitorización de bajo impacto

@item 
@ref{4eb,,Improved 'Did you mean ...' suggestions} para excepciones @ref{4ec,,NameError}, @ref{4d7,,ImportError} y @ref{150,,SyntaxError}
@end itemize

Mejoras en el modelo de datos de Python:


@itemize *

@item 
@ref{4ed,,PEP 688}, usando @ref{48a,,buffer protocol} de Python
@end itemize

Mejoras significativas en la biblioteca estándar:


@itemize *

@item 
La clase @ref{19b,,pathlib.Path} ahora admite subclases

@item 
El módulo @ref{a1,,os} recibió varias mejoras para el soporte de Windows

@item 
Se ha agregado un @ref{4ee,,command-line interface} al módulo @ref{cf,,sqlite3}

@item 
Los controles @ref{4ef,,isinstance()} frente a @ref{4f0,,runtime-checkable protocols} benefician de una aceleración de entre dos y 20 veces

@item 
El paquete @ref{b,,asyncio} ha tenido una serie de mejoras de rendimiento, y algunos puntos de referencia muestran una aceleración del 75 %.

@item 
Se ha agregado un @ref{4f1,,command-line interface} al módulo @ref{110,,uuid}

@item 
Due to the changes in @ref{4e8,,PEP 701},
producing tokens via the @ref{fb,,tokenize} module is up to 64% faster.
@end itemize

Mejoras de seguridad:


@itemize *

@item 
Reemplaza las implementaciones @ref{68,,hashlib} integradas de SHA1, SHA3, SHA2-384, SHA2-512 y MD5 con código verificado formalmente del proyecto HACL*@footnote{https://github.com/hacl-star/hacl-star/}. Estas implementaciones integradas permanecen como alternativas que solo se utilizan cuando OpenSSL no las proporciona.
@end itemize

Mejoras de la API C:


@itemize *

@item 
@ref{4f2,,PEP 697}, nivel de API C inestable

@item 
@ref{4f3,,PEP 683}, objetos inmortales
@end itemize

Mejoras en la implementación de CPython:


@itemize *

@item 
@ref{4f4,,PEP 709}, comprensión en línea

@item 
@ref{2f8,,CPython support} para el perfilador Linux @code{perf}

@item 
Implementar protección contra desbordamiento de pila en plataformas compatibles
@end itemize

Nuevas funciones de tipado:


@itemize *

@item 
@ref{4f5,,PEP 692}, usando @ref{2ce,,TypedDict} para anotar @ref{4f6,,**kwargs}

@item 
@ref{4f7,,PEP 698}, decorador @ref{4f8,,typing.override()}
@end itemize

Depreciaciones, eliminaciones o restricciones importantes:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}: elimina @code{wstr} de los objetos Unicode en la API C de Python, reduciendo el tamaño de cada objeto @ref{237,,str} en al menos 8 bytes.

@item 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}: Remove the @code{distutils} package.
See 
@geindex Python Enhancement Proposals; PEP 0632#migration-advice
the migration guide@footnote{https://peps.python.org/pep-0632/#migration-advice}
for advice replacing the APIs it provided.
The third-party Setuptools@footnote{https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html}
package continues to provide @code{distutils},
if you still require it in Python 3.12 and beyond.

@item 
gh-95299@footnote{https://github.com/python/cpython/issues/95299}: No preinstala @code{setuptools} en entornos virtuales creados con @ref{111,,venv}. Esto significa que @code{distutils}, @code{setuptools}, @code{pkg_resources} y @code{easy_install} ya no estarán disponibles de forma predeterminada; para acceder a ellos, ejecute @code{pip install setuptools} en el entorno virtual @ref{4f9,,activated}.

@item 
Se han eliminado los módulos @code{asynchat}, @code{asyncore} y @code{imp}, junto con varios @ref{4fa,,unittest.TestCase} @ref{4fb,,method aliases}.
@end itemize

@node Nuevas características,Nuevas funciones relacionadas con las sugerencias de escritura,Resumen aspectos destacados de la versión,Novedades de Python 3 12
@anchor{whatsnew/3 12 new-features}@anchor{4fc}
@subsection Nuevas características


@menu
* PEP 695; Sintaxis de parámetro de tipo: PEP 695 Sintaxis de parámetro de tipo. 
* PEP 701; Formalización sintáctica de cadenas f: PEP 701 Formalización sintáctica de cadenas f. 
* PEP 684; un GIL por intérprete: PEP 684 un GIL por intérprete. 
* PEP 669; Monitoreo de bajo impacto para CPython: PEP 669 Monitoreo de bajo impacto para CPython. 
* PEP 688; Hacer accesible el protocolo de búfer en Python: PEP 688 Hacer accesible el protocolo de búfer en Python. 
* PEP 709; Integración de la comprensión: PEP 709 Integración de la comprensión. 
* Mensajes de error mejorados:: 

@end menu

@node PEP 695 Sintaxis de parámetro de tipo,PEP 701 Formalización sintáctica de cadenas f,,Nuevas características
@anchor{whatsnew/3 12 pep-695-type-parameter-syntax}@anchor{4fd}@anchor{whatsnew/3 12 whatsnew312-pep695}@anchor{4e5}
@subsubsection PEP 695: Sintaxis de parámetro de tipo


Las clases y funciones genéricas en 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} se declararon utilizando una sintaxis detallada que dejaba el alcance de los parámetros de tipo poco claro y requería declaraciones explícitas de variación.

@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} presenta una forma nueva, más compacta y explícita de crear @ref{4fe,,generic classes} y @ref{4ff,,functions}:

@example
def max[T](args: Iterable[T]) -> T:
    ...

class list[T]:
    def __getitem__(self, index: int, /) -> T:
        ...

    def append(self, element: T) -> None:
        ...
@end example

Además, el PEP introduce una nueva forma de declarar @ref{500,,type aliases} utilizando la declaración @ref{4e6,,type}, que crea una instancia de @ref{501,,TypeAliasType}:

@example
type Point = tuple[float, float]
@end example

Los alias de tipo también pueden ser @ref{502,,generic}:

@example
type Point[T] = tuple[T, T]
@end example

La nueva sintaxis permite declarar los parámetros @ref{2cb,,TypeVarTuple} y @ref{2ca,,ParamSpec}, así como los parámetros @ref{2c9,,TypeVar} con límites o restricciones:

@example
type IntFunc[**P] = Callable[P, int]  # ParamSpec
type LabeledTuple[*Ts] = tuple[str, *Ts]  # TypeVarTuple
type HashableSequence[T: Hashable] = Sequence[T]  # TypeVar with bound
type IntOrStrSequence[T: (int, str)] = Sequence[T]  # TypeVar with constraints
@end example

El valor de los alias de tipo y los límites y restricciones de las variables de tipo creadas mediante esta sintaxis se evalúan solo según demanda (consulte @ref{503,,lazy evaluation}). Esto significa que los alias de tipo pueden hacer referencia a otros tipos definidos más adelante en el archivo.

Los parámetros de tipo declarados a través de una lista de parámetros de tipo son visibles dentro del alcance de la declaración y de cualquier alcance anidado, pero no en el alcance externo. Por ejemplo, se pueden utilizar en las anotaciones de tipo de los métodos de una clase genérica o en el cuerpo de la clase. Sin embargo, no se pueden utilizar en el alcance del módulo una vez definida la clase. Consulte @ref{3fc,,Type parameter lists} para obtener una descripción detallada de la semántica de tiempo de ejecución de los parámetros de tipo.

Para respaldar esta semántica de alcance, se introduce un nuevo tipo de alcance, el @ref{2f3,,annotation scope}. Los ámbitos de anotación se comportan en su mayor parte como ámbitos de función, pero interactúan de manera diferente con los ámbitos de clase adjuntos. En Python 3.13, @ref{140,,annotations} también se evaluará en ámbitos de anotación.

Consulte 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} para obtener más detalles.

(PEP escrito por Eric Traut. Implementación por Jelle Zijlstra, Eric Traut y otros en gh-103764@footnote{https://github.com/python/cpython/issues/103764}.)

@node PEP 701 Formalización sintáctica de cadenas f,PEP 684 un GIL por intérprete,PEP 695 Sintaxis de parámetro de tipo,Nuevas características
@anchor{whatsnew/3 12 pep-701-syntactic-formalization-of-f-strings}@anchor{504}@anchor{whatsnew/3 12 whatsnew312-pep701}@anchor{4e8}
@subsubsection PEP 701: Formalización sintáctica de cadenas f


@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} elimina algunas restricciones sobre el uso de @ref{4e4,,f-strings}. Los componentes de expresión dentro de cadenas f ahora pueden ser cualquier expresión Python válida, incluidas cadenas que reutilizan la misma comilla que la cadena f que las contiene, expresiones de varias líneas, comentarios, barras invertidas y secuencias de escape Unicode. Cubramos estos en detalle:


@itemize *

@item 
Reutilización de comillas: en Python 3.11, reutilizar las mismas comillas que la cadena f adjunta genera un @ref{150,,SyntaxError}, lo que obliga al usuario a usar otras comillas disponibles (como usar comillas dobles o triples si la cadena f usa comillas simples). En Python 3.12, ahora puedes hacer cosas como esta:

@example
>>> songs = ['Take me back to Eden', 'Alkaline', 'Ascensionism']
>>> f"This is the playlist: @{", ".join(songs)@}"
'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
@end example

Tenga en cuenta que antes de este cambio no había un límite explícito en cómo se pueden anidar las cadenas f, pero el hecho de que las comillas de cadena no se pueden reutilizar dentro del componente de expresión de las cadenas f hacía imposible anidar cadenas f arbitrariamente. De hecho, esta es la cadena f más anidada que podría escribirse:

@example
>>> f"""@{f'@w{'}'@{f'@{f"@{1+1@}"@}'@}'@w{'}'@}"""
'2'
@end example

Como ahora las cadenas f pueden contener cualquier expresión Python válida dentro de los componentes de expresión, ahora es posible anidar cadenas f de forma arbitraria:

@example
>>> f"@{f"@{f"@{f"@{f"@{f"@{1+1@}"@}"@}"@}"@}"@}"
'2'
@end example

@item 
Expresiones y comentarios de varias líneas: en Python 3.11, las expresiones de cadena f deben definirse en una sola línea, incluso si la expresión dentro de la cadena f normalmente podría abarcar varias líneas (como listas literales que se definen en varias líneas), lo que las hace más difícil de leer. En Python 3.12 ahora puedes definir cadenas f que abarquen varias líneas y agregar comentarios en línea:

@example
>>> f"This is the playlist: @{", ".join([
...     'Take me back to Eden',  # My, my, those eyes like fire
...     'Alkaline',              # Not acid nor alkaline
...     'Ascensionism'           # Take to the broken skies at last
... ])@}"
'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
@end example

@item 
Barras invertidas y caracteres Unicode: antes de Python 3.12, las expresiones de cadena f no podían contener ningún carácter @code{\}. Esto también afectó a Unicode @ref{505,,escape sequences} (como @code{\N@{snowman@}}), ya que contienen la parte @code{\N} que anteriormente no podía ser parte de los componentes de expresión de f-strings. Ahora puedes definir expresiones como esta:

@example
>>> print(f"This is the playlist: @{"\n".join(songs)@}")
This is the playlist: Take me back to Eden
Alkaline
Ascensionism
>>> print(f"This is the playlist: @{"\N@{BLACK HEART SUIT@}".join(songs)@}")
This is the playlist: Take me back to Eden♥Alkaline♥Ascensionism
@end example
@end itemize

Consulte 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} para obtener más detalles.

As a positive side-effect of how this feature has been implemented (by parsing f-strings
with 
@geindex Python Enhancement Proposals; PEP 617
the PEG parser@footnote{https://peps.python.org/pep-0617/}), now error messages for f-strings are more precise
and include the exact location of the error. For example, in Python 3.11, the following
f-string raises a @ref{150,,SyntaxError}:

@example
>>> my_string = f"@{x z y@}" + f"@{1 + 1@}"
  File "<stdin>", line 1
    (x z y)
     ^^^
SyntaxError: f-string: invalid syntax. Perhaps you forgot a comma?
@end example

pero el mensaje de error no incluye la ubicación exacta del error dentro de la línea y también tiene la expresión artificialmente entre paréntesis. En Python 3.12, a medida que las cadenas f se analizan con el analizador PEG, los mensajes de error pueden ser más precisos y mostrar la línea completa:

@example
>>> my_string = f"@{x z y@}" + f"@{1 + 1@}"
  File "<stdin>", line 1
    my_string = f"@{x z y@}" + f"@{1 + 1@}"
                   ^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

(Aportado por Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou, Cristián Maureira-Fredes y Marta Gómez en gh-102856@footnote{https://github.com/python/cpython/issues/102856}. PEP escrito por Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou y Marta Gómez).

@node PEP 684 un GIL por intérprete,PEP 669 Monitoreo de bajo impacto para CPython,PEP 701 Formalización sintáctica de cadenas f,Nuevas características
@anchor{whatsnew/3 12 pep-684-a-per-interpreter-gil}@anchor{506}@anchor{whatsnew/3 12 whatsnew312-pep684}@anchor{4e9}
@subsubsection PEP 684: un GIL por intérprete


@geindex Python Enhancement Proposals; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/} introduce un @ref{2b5,,GIL} por intérprete, de modo que ahora se pueden crear subintérpretes con un GIL único por intérprete. Esto permite que los programas Python aprovechen al máximo múltiples núcleos de CPU. Actualmente, esto solo está disponible a través de C-API, aunque una API de Python es 
@geindex Python Enhancement Proposals; PEP 554
anticipada para 3.13@footnote{https://peps.python.org/pep-0554/}.

Use the new @ref{507,,Py_NewInterpreterFromConfig()} function to
create an interpreter with its own GIL:

@example
PyInterpreterConfig config = @{
    .check_multi_interp_extensions = 1,
    .gil = PyInterpreterConfig_OWN_GIL,
@};
PyThreadState *tstate = NULL;
PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config);
if (PyStatus_Exception(status)) @{
    return -1;
@}
/* The new interpreter is now active in the current thread. */
@end example

For further examples how to use the C-API for sub-interpreters with a
per-interpreter GIL, see @code{Modules/_xxsubinterpretersmodule.c}.

(Aportado por Eric Snow en gh-104210@footnote{https://github.com/python/cpython/issues/104210}, etc.)

@node PEP 669 Monitoreo de bajo impacto para CPython,PEP 688 Hacer accesible el protocolo de búfer en Python,PEP 684 un GIL por intérprete,Nuevas características
@anchor{whatsnew/3 12 pep-669-low-impact-monitoring-for-cpython}@anchor{508}@anchor{whatsnew/3 12 whatsnew312-pep669}@anchor{4ea}
@subsubsection PEP 669: Monitoreo de bajo impacto para CPython


@geindex Python Enhancement Proposals; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} define un nuevo @ref{da,,API} para perfiladores, depuradores y otras herramientas para monitorear eventos en CPython. Cubre una amplia gama de eventos, incluidas llamadas, devoluciones, líneas, excepciones, saltos y más. Esto significa que solo paga por lo que usa, brindando soporte para depuradores generales y herramientas de cobertura casi nulos. Consulte @ref{da,,sys.monitoring} para obtener más detalles.

(Aportado por Mark Shannon en gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@node PEP 688 Hacer accesible el protocolo de búfer en Python,PEP 709 Integración de la comprensión,PEP 669 Monitoreo de bajo impacto para CPython,Nuevas características
@anchor{whatsnew/3 12 pep-688-making-the-buffer-protocol-accessible-in-python}@anchor{509}@anchor{whatsnew/3 12 whatsnew312-pep688}@anchor{4ed}
@subsubsection PEP 688: Hacer accesible el protocolo de búfer en Python


@geindex Python Enhancement Proposals; PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/} presenta una forma de utilizar @ref{48a,,buffer protocol} desde el código Python. Las clases que implementan el método @ref{50a,,__buffer__()} ahora se pueden utilizar como tipos de búfer.

El nuevo @ref{3fe,,collections.abc.Buffer} ABC proporciona una forma estándar de representar objetos de búfer, por ejemplo en anotaciones de tipo. La nueva enumeración @ref{50b,,inspect.BufferFlags} representa los indicadores que se pueden usar para personalizar la creación del búfer. (Aportado por Jelle Zijlstra en gh-102500@footnote{https://github.com/python/cpython/issues/102500}.)

@node PEP 709 Integración de la comprensión,Mensajes de error mejorados,PEP 688 Hacer accesible el protocolo de búfer en Python,Nuevas características
@anchor{whatsnew/3 12 pep-709-comprehension-inlining}@anchor{50c}@anchor{whatsnew/3 12 whatsnew312-pep709}@anchor{4f4}
@subsubsection PEP 709: Integración de la comprensión


Las comprensiones de diccionario, lista y conjunto ahora están integradas, en lugar de crear un nuevo objeto de función de un solo uso para cada ejecución de la comprensión. Esto acelera la ejecución de una comprensión hasta dos veces. Consulte 
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} para obtener más detalles.

Las variables de iteración de comprensión permanecen aisladas y no sobrescriben una variable del mismo nombre en el alcance externo, ni son visibles después de la comprensión. La incorporación da como resultado algunos cambios de comportamiento visibles:


@itemize *

@item 
Ya no hay un marco separado para la comprensión en los rastreos, y el rastreo/elaboración de perfiles ya no muestra la comprensión como una llamada a función.

@item 
El módulo @ref{d8,,symtable} ya no producirá tablas de símbolos secundarios para cada comprensión; en cambio, los locales de comprensión se incluirán en la tabla de símbolos de la función principal.

@item 
Llamar a @ref{2ae,,locals()} dentro de una comprensión ahora incluye variables externas a la comprensión y ya no incluye la variable sintética @code{.0} para el «argumento» de comprensión.

@item 
Una comprensión que itera directamente sobre @code{locals()} (por ejemplo, @code{[k for k in locals()]}) puede ver «RuntimeError: el diccionario cambió de tamaño durante la iteración» cuando se ejecuta bajo seguimiento (por ejemplo, medición de cobertura de código). Este es el mismo comportamiento que ya se ha visto, por ejemplo, en @code{for k in locals():}. Para evitar el error, primero cree una lista de claves para iterar: @code{keys = list(locals()); [k for k in keys]}.
@end itemize

(Aportado por Carl Meyer y Vladimir Matveev en 
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}.)

@node Mensajes de error mejorados,,PEP 709 Integración de la comprensión,Nuevas características
@anchor{whatsnew/3 12 improved-error-messages}@anchor{4eb}
@subsubsection Mensajes de error mejorados



@itemize *

@item 
Ahora se sugieren potencialmente módulos de la biblioteca estándar como parte de los mensajes de error que muestra el intérprete cuando un @ref{4ec,,NameError} se eleva al nivel superior. (Aportado por Pablo Galindo en gh-98254@footnote{https://github.com/python/cpython/issues/98254}.)

@example
>>> sys.version_info
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'sys' is not defined. Did you forget to import 'sys'?
@end example

@item 
Mejora la sugerencia de error para excepciones @ref{4ec,,NameError} para instancias. Ahora, si se genera un @ref{4ec,,NameError} en un método y la instancia tiene un atributo que es exactamente igual al nombre en la excepción, la sugerencia incluirá @code{self.<NAME>} en lugar de la coincidencia más cercana en el alcance del método. (Aportado por Pablo Galindo en gh-99139@footnote{https://github.com/python/cpython/issues/99139}.)

@example
>>> class A:
...    def __init__(self):
...        self.blech = 1
...
...    def foo(self):
...        somethin = blech
...
>>> A().foo()
Traceback (most recent call last):
  File "<stdin>", line 1
    somethin = blech
               ^^^^^
NameError: name 'blech' is not defined. Did you mean: 'self.blech'?
@end example

@item 
Mejora el mensaje de error @ref{150,,SyntaxError} cuando el usuario escribe @code{import x from y} en lugar de @code{from y import x}. (Aportado por Pablo Galindo en gh-98931@footnote{https://github.com/python/cpython/issues/98931}.)

@example
>>> import a.y.z from b.y.z
Traceback (most recent call last):
  File "<stdin>", line 1
    import a.y.z from b.y.z
    ^^^^^^^^^^^^^^^^^^^^^^^
SyntaxError: Did you mean to use 'from ... import ...' instead?
@end example

@item 
Las excepciones @ref{4d7,,ImportError} generadas por sentencias @code{from <module> import <name>} fallidas ahora incluyen sugerencias para el valor de @code{<name>} según los nombres disponibles en @code{<module>}. (Aportado por Pablo Galindo en gh-91058@footnote{https://github.com/python/cpython/issues/91058}.)

@example
>>> from collections import chainmap
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name 'chainmap' from 'collections'. Did you mean: 'ChainMap'?
@end example
@end itemize

@node Nuevas funciones relacionadas con las sugerencias de escritura,Otros cambios del lenguaje,Nuevas características,Novedades de Python 3 12
@anchor{whatsnew/3 12 new-features-related-to-type-hints}@anchor{50d}
@subsection Nuevas funciones relacionadas con las sugerencias de escritura


Esta sección cubre los cambios principales que afectan a 
@geindex Python Enhancement Proposals; PEP 484
type hints@footnote{https://peps.python.org/pep-0484/} y al módulo @ref{104,,typing}.

@menu
* PEP 692; uso de TypedDict para una escritura **kwargs más precisa: PEP 692 uso de TypedDict para una escritura **kwargs más precisa. 
* PEP 698; Decorador override para escritura estática: PEP 698 Decorador override para escritura estática. 

@end menu

@node PEP 692 uso de TypedDict para una escritura **kwargs más precisa,PEP 698 Decorador override para escritura estática,,Nuevas funciones relacionadas con las sugerencias de escritura
@anchor{whatsnew/3 12 pep-692-using-typeddict-for-more-precise-kwargs-typing}@anchor{50e}@anchor{whatsnew/3 12 whatsnew312-pep692}@anchor{4f5}
@subsubsection PEP 692: uso de @code{TypedDict} para una escritura @code{**kwargs} más precisa


Escribir @code{**kwargs} en una firma de función introducida por 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} permitía anotaciones válidas solo en los casos en que todos los @code{**kwargs} eran del mismo tipo.

@geindex Python Enhancement Proposals; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} especifica una forma más precisa de escribir @code{**kwargs} basándose en diccionarios escritos:

@example
from typing import TypedDict, Unpack

class Movie(TypedDict):
  name: str
  year: int

def foo(**kwargs: Unpack[Movie]): ...
@end example

Consulte 
@geindex Python Enhancement Proposals; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} para obtener más detalles.

(Aportado por Franek Magiera en gh-103629@footnote{https://github.com/python/cpython/issues/103629}.)

@node PEP 698 Decorador override para escritura estática,,PEP 692 uso de TypedDict para una escritura **kwargs más precisa,Nuevas funciones relacionadas con las sugerencias de escritura
@anchor{whatsnew/3 12 pep-698-override-decorator-for-static-typing}@anchor{50f}@anchor{whatsnew/3 12 whatsnew312-pep698}@anchor{4f7}
@subsubsection PEP 698: Decorador override para escritura estática


Se ha agregado un nuevo decorador @ref{4f8,,typing.override()} al módulo @ref{104,,typing}. Indica a los inspectores de tipo que el método está destinado a anular un método en una superclase. Esto permite a los verificadores de tipos detectar errores cuando un método destinado a anular algo en una clase base en realidad no lo hace.

Ejemplo:

@example
from typing import override

class Base:
  def get_color(self) -> str:
    return "blue"

class GoodChild(Base):
  @@override  # ok: overrides Base.get_color
  def get_color(self) -> str:
    return "yellow"

class BadChild(Base):
  @@override  # type checker error: does not override Base.get_color
  def get_colour(self) -> str:
    return "red"
@end example

Consulte 
@geindex Python Enhancement Proposals; PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/} para obtener más detalles.

(Aportado por Steven Troxler en gh-101561@footnote{https://github.com/python/cpython/issues/101561}.)

@node Otros cambios del lenguaje,Nuevos módulos,Nuevas funciones relacionadas con las sugerencias de escritura,Novedades de Python 3 12
@anchor{whatsnew/3 12 other-language-changes}@anchor{510}
@subsection Otros cambios del lenguaje



@itemize *

@item 
El analizador ahora genera @ref{150,,SyntaxError} al analizar el código fuente que contiene bytes nulos. (Aportado por Pablo Galindo en gh-96670@footnote{https://github.com/python/cpython/issues/96670}.)

@item 
Un par de caracteres de barra invertida que no es una secuencia de escape válida ahora genera un @ref{511,,SyntaxWarning}, en lugar de @ref{1da,,DeprecationWarning}. Por ejemplo, @code{re.compile("\d+\.\d+")} ahora emite un @ref{511,,SyntaxWarning} (@code{"\d"} es una secuencia de escape no válida; utilice cadenas sin formato para la expresión regular: @code{re.compile(r"\d+\.\d+")}). En una versión futura de Python, eventualmente se generará @ref{150,,SyntaxError}, en lugar de @ref{511,,SyntaxWarning}. (Aportado por Victor Stinner en gh-98401@footnote{https://github.com/python/cpython/issues/98401}.)

@item 
Los escapes octales con un valor mayor que @code{0o377} (por ejemplo, @code{"\477"}), obsoletos en Python 3.11, ahora producen un @ref{511,,SyntaxWarning}, en lugar de @ref{1da,,DeprecationWarning}. En una futura versión de Python, eventualmente serán un @ref{150,,SyntaxError}. (Aportado por Victor Stinner en gh-98401@footnote{https://github.com/python/cpython/issues/98401}.)

@item 
Las variables utilizadas en la parte de destino de las comprensiones que no están almacenadas ahora se pueden usar en expresiones de asignación (@code{:=}). Por ejemplo, en @code{[(b := 1) for a, b.prop in some_iter]}, ahora se permite la asignación a @code{b}. Tenga en cuenta que la asignación de variables almacenadas en la parte de destino de las comprensiones (como @code{a}) todavía no está permitida, según 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}. (Aportado por Nikita Sobolev en gh-100581@footnote{https://github.com/python/cpython/issues/100581}.)

@item 
Las excepciones generadas en el método @code{__set_name__} de una clase o tipo ya no están incluidas en un @ref{1e5,,RuntimeError}. La información de contexto se agrega a la excepción como una nota 
@geindex Python Enhancement Proposals; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}. (Aportado por Irit Katriel en gh-77757@footnote{https://github.com/python/cpython/issues/77757}.)

@item 
Cuando una construcción @code{try-except*} maneja todo el @ref{31d,,ExceptionGroup} y genera otra excepción, esa excepción ya no está incluida en un @ref{31d,,ExceptionGroup}. También cambió en la versión 3.11.4. (Aportado por Irit Katriel en gh-103590@footnote{https://github.com/python/cpython/issues/103590}.)

@item 
El recolector de basura ahora se ejecuta solo en el mecanismo de interrupción de evaluación del ciclo de evaluación del código de bytes de Python en lugar de en las asignaciones de objetos. El GC también se puede ejecutar cuando se llama a @ref{512,,PyErr_CheckSignals()}, por lo que las extensiones C que necesitan ejecutarse durante un período prolongado sin ejecutar ningún código Python también tienen la posibilidad de ejecutar el GC periódicamente. (Aportado por Pablo Galindo en gh-97922@footnote{https://github.com/python/cpython/issues/97922}.)

@item 
Todos los invocables integrados y de extensión que esperan parámetros booleanos ahora aceptan argumentos de cualquier tipo en lugar de solo @ref{513,,bool} y @ref{1f0,,int}. (Contribución de Serhiy Storchaka en gh-60203@footnote{https://github.com/python/cpython/issues/60203}.)

@item 
@ref{156,,memoryview} ahora admite el tipo medio flotante (el código de formato «e»). (Contribución de Donghee Na y Antoine Pitrou en gh-90751@footnote{https://github.com/python/cpython/issues/90751}.)

@item 
Los objetos @ref{514,,slice} ahora son hasheables, lo que permite usarlos como claves de dictado y elementos de configuración. (Contribución de Will Bradshaw, Furkan Onder y Raymond Hettinger en gh-101264@footnote{https://github.com/python/cpython/issues/101264}.)

@item 
@ref{515,,sum()} ahora utiliza la suma de Neumaier para mejorar la precisión y la conmutatividad al sumar flotantes o enteros y flotantes mixtos. (Aportado por Raymond Hettinger en gh-100425@footnote{https://github.com/python/cpython/issues/100425}.)

@item 
@ref{30f,,ast.parse()} ahora genera @ref{150,,SyntaxError} en lugar de @ref{360,,ValueError} al analizar el código fuente que contiene bytes nulos. (Aportado por Pablo Galindo en gh-96670@footnote{https://github.com/python/cpython/issues/96670}.)

@item 
Los métodos de extracción en @ref{de,,tarfile} y @ref{516,,shutil.unpack_archive()} tienen un nuevo argumento, `filter', que permite limitar funciones tar que puedan resultar sorprendentes o peligrosas, como la creación de archivos fuera del directorio de destino. Consulte @ref{517,,tarfile extraction filters} para obtener más detalles. En Python 3.14, el valor predeterminado cambiará a @code{'data'}. (Aportado por Petr Viktorin en 
@geindex Python Enhancement Proposals; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)

@item 
Las instancias @ref{518,,types.MappingProxyType} ahora son hasheables si el mapeo subyacente es hasheable. (Contribución de Serhiy Storchaka en gh-87995@footnote{https://github.com/python/cpython/issues/87995}.)

@item 
Agregado @ref{2f8,,support for the perf profiler} a través de la nueva variable de entorno 
@geindex PYTHONPERFSUPPORT
@geindex variables de entorno; PYTHONPERFSUPPORT
@ref{519,,PYTHONPERFSUPPORT} y la opción de línea de comandos @ref{2e2,,-X perf}, así como las nuevas funciones @ref{51a,,sys.activate_stack_trampoline()}, @ref{51b,,sys.deactivate_stack_trampoline()} y @ref{51c,,sys.is_stack_trampoline_active()}. (Diseño de Pablo Galindo. Contribución de Pablo Galindo y Christian Heimes con contribuciones de Gregory P. Smith [Google] y Mark Shannon en gh-96123@footnote{https://github.com/python/cpython/issues/96123}.)
@end itemize

@node Nuevos módulos,Módulos mejorados,Otros cambios del lenguaje,Novedades de Python 3 12
@anchor{whatsnew/3 12 new-modules}@anchor{51d}
@subsection Nuevos módulos



@itemize *

@item 
Ninguno.
@end itemize

@node Módulos mejorados,Optimizaciones,Nuevos módulos,Novedades de Python 3 12
@anchor{whatsnew/3 12 improved-modules}@anchor{51e}
@subsection Módulos mejorados


@menu
* array: array<2>. 
* asincio:: 
* calendar:: 
* csv:: 
* dis: dis<3>. 
* fractions: fractions<3>. 
* importlib.resources: importlib resources. 
* inspect: inspect<2>. 
* itertools: itertools<3>. 
* math: math<2>. 
* os: os<3>. 
* os.path: os path<2>. 
* pathlib: pathlib<5>. 
* pbd:: 
* random: random<2>. 
* shutil: shutil<2>. 
* sqlite3: sqlite3<3>. 
* statistics: statistics<2>. 
* sys: sys<3>. 
* tempfile: tempfile<2>. 
* threading:: 
* tkinter: tkinter<2>. 
* tokenize:: 
* types: types<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<3>. 
* uuid: uuid<2>. 

@end menu

@node array<2>,asincio,,Módulos mejorados
@anchor{whatsnew/3 12 array}@anchor{51f}
@subsubsection array



@itemize *

@item 
La clase @ref{308,,array.array} ahora admite subíndices, lo que la convierte en @ref{157,,generic type}. (Aportado por Jelle Zijlstra en gh-98658@footnote{https://github.com/python/cpython/issues/98658}.)
@end itemize

@node asincio,calendar,array<2>,Módulos mejorados
@anchor{whatsnew/3 12 asyncio}@anchor{520}
@subsubsection asincio



@itemize *

@item 
Se ha mejorado significativamente el rendimiento de escritura en sockets en @ref{b,,asyncio}. @code{asyncio} ahora evita copias innecesarias al escribir en sockets y usa @ref{521,,sendmsg()} si la plataforma lo admite. (Aportado por Kumar Aditya en gh-91166@footnote{https://github.com/python/cpython/issues/91166}.)

@item 
Agregado las funciones @ref{522,,asyncio.eager_task_factory()} y @ref{523,,asyncio.create_eager_task_factory()} para permitir la opción de un bucle de eventos para la ejecución de tareas entusiastas, lo que hace que algunos casos de uso sean de 2 a 5 veces más rápidos. (Contribución de Jacob Bower e Itamar Oren en gh-102853@footnote{https://github.com/python/cpython/issues/102853}, gh-104140@footnote{https://github.com/python/cpython/issues/104140} y gh-104138@footnote{https://github.com/python/cpython/issues/104138})

@item 
On Linux, @ref{b,,asyncio} uses @code{asyncio.PidfdChildWatcher} by default
if @ref{524,,os.pidfd_open()} is available and functional instead of
@code{asyncio.ThreadedChildWatcher}.
(Contributed by Kumar Aditya in gh-98024@footnote{https://github.com/python/cpython/issues/98024}.)

@item 
The event loop now uses the best available child watcher for each platform
(@code{asyncio.PidfdChildWatcher} if supported and
@code{asyncio.ThreadedChildWatcher} otherwise), so manually
configuring a child watcher is not recommended.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
Agregado el parámetro `loop_factory' a @ref{525,,asyncio.run()} para permitir especificar una fábrica de bucle de eventos personalizada. (Aportado por Kumar Aditya en gh-99388@footnote{https://github.com/python/cpython/issues/99388}.)

@item 
Agregado la implementación C de @ref{526,,asyncio.current_task()} para una aceleración de 4x-6x. (Aportado por Itamar Oren y Pranav Thulasiram Bhat en gh-100344@footnote{https://github.com/python/cpython/issues/100344}.)

@item 
@ref{527,,asyncio.iscoroutine()} ahora devuelve @code{False} para generadores, ya que @ref{b,,asyncio} no admite rutinas heredadas basadas en generadores. (Aportado por Kumar Aditya en gh-102748@footnote{https://github.com/python/cpython/issues/102748}.)

@item 
@ref{528,,asyncio.wait()} y @ref{311,,asyncio.as_completed()} ahora aceptan generadores que generan tareas. (Aportado por Kumar Aditya en gh-78530@footnote{https://github.com/python/cpython/issues/78530}.)
@end itemize

@node calendar,csv,asincio,Módulos mejorados
@anchor{whatsnew/3 12 calendar}@anchor{529}
@subsubsection calendar



@itemize *

@item 
Agregado las enumeraciones @ref{52a,,calendar.Month} y @ref{52b,,calendar.Day} que definen los meses del año y los días de la semana. (Aportado por el Príncipe Roshan en gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)
@end itemize

@node csv,dis<3>,calendar,Módulos mejorados
@anchor{whatsnew/3 12 csv}@anchor{52c}
@subsubsection csv



@itemize *

@item 
Add @ref{52d,,csv.QUOTE_NOTNULL} and @ref{52e,,csv.QUOTE_STRINGS} flags to
provide finer grained control of @code{None} and empty strings by
@ref{52f,,reader} and @ref{530,,writer} objects.
@end itemize

@node dis<3>,fractions<3>,csv,Módulos mejorados
@anchor{whatsnew/3 12 dis}@anchor{531}
@subsubsection dis



@itemize *

@item 
Los códigos de operación de pseudoinstrucción (que son utilizados por el compilador pero que no aparecen en el código de bytes ejecutable) ahora están expuestos en el módulo @ref{39,,dis}. @ref{532,,HAVE_ARGUMENT} sigue siendo relevante para códigos de operación reales, pero no es útil para pseudoinstrucciones. Utilice la nueva colección @ref{3ee,,dis.hasarg} en su lugar. (Aportado por Irit Katriel en gh-94216@footnote{https://github.com/python/cpython/issues/94216}.)

@item 
Agregado la colección @ref{533,,dis.hasexc} para indicar instrucciones que establecen un controlador de excepciones. (Aportado por Irit Katriel en gh-94216@footnote{https://github.com/python/cpython/issues/94216}.)
@end itemize

@node fractions<3>,importlib resources,dis<3>,Módulos mejorados
@anchor{whatsnew/3 12 fractions}@anchor{534}
@subsubsection fractions



@itemize *

@item 
Los objetos de tipo @ref{177,,fractions.Fraction} ahora admiten formato de estilo flotante. (Aportado por Mark Dickinson en gh-100161@footnote{https://github.com/python/cpython/issues/100161}.)
@end itemize

@node importlib resources,inspect<2>,fractions<3>,Módulos mejorados
@anchor{whatsnew/3 12 importlib-resources}@anchor{535}
@subsubsection importlib.resources



@itemize *

@item 
@ref{536,,importlib.resources.as_file()} ahora admite directorios de recursos. (Aportado por Jason R. Coombs en gh-97930@footnote{https://github.com/python/cpython/issues/97930}.)

@item 
Rename first parameter of @ref{537,,importlib.resources.files()} to `anchor'.
(Contributed by Jason R. Coombs in gh-100598@footnote{https://github.com/python/cpython/issues/100598}.)
@end itemize

@node inspect<2>,itertools<3>,importlib resources,Módulos mejorados
@anchor{whatsnew/3 12 inspect}@anchor{538}
@subsubsection inspect



@itemize *

@item 
Add @ref{539,,inspect.markcoroutinefunction()} to mark sync functions that return
a @ref{53a,,coroutine} for use with @ref{1c3,,inspect.iscoroutinefunction()}.
(Contributed by Carlton Gibson in gh-99247@footnote{https://github.com/python/cpython/issues/99247}.)

@item 
Agregado @ref{53b,,inspect.getasyncgenstate()} y @ref{53c,,inspect.getasyncgenlocals()} para determinar el estado actual de los generadores asíncronos. (Aportado por Thomas Krennwallner en gh-79940@footnote{https://github.com/python/cpython/issues/79940}.)

@item 
The performance of @ref{53d,,inspect.getattr_static()} has been considerably
improved. Most calls to the function should be at least 2x faster than they
were in Python 3.11. (Contributed by Alex Waygood in gh-103193@footnote{https://github.com/python/cpython/issues/103193}.)
@end itemize

@node itertools<3>,math<2>,inspect<2>,Módulos mejorados
@anchor{whatsnew/3 12 itertools}@anchor{53e}
@subsubsection itertools



@itemize *

@item 
Add @ref{35f,,itertools.batched()} for collecting into even-sized
tuples where the last batch may be shorter than the rest.
(Contributed by Raymond Hettinger in gh-98363@footnote{https://github.com/python/cpython/issues/98363}.)
@end itemize

@node math<2>,os<3>,itertools<3>,Módulos mejorados
@anchor{whatsnew/3 12 math}@anchor{53f}
@subsubsection math



@itemize *

@item 
Agregado @ref{540,,math.sumprod()} para calcular una suma de productos. (Aportado por Raymond Hettinger en gh-100485@footnote{https://github.com/python/cpython/issues/100485}.)

@item 
Extend @ref{541,,math.nextafter()} to include a `steps' argument
for moving up or down multiple steps at a time. (Contributed by
Matthias Goergens, Mark Dickinson, and Raymond Hettinger in gh-94906@footnote{https://github.com/python/cpython/issues/94906}.)
@end itemize

@node os<3>,os path<2>,math<2>,Módulos mejorados
@anchor{whatsnew/3 12 os}@anchor{542}
@subsubsection os



@itemize *

@item 
Agregado @ref{543,,os.PIDFD_NONBLOCK} para abrir un descriptor de archivo para un proceso con @ref{524,,os.pidfd_open()} en modo sin bloqueo. (Aportado por Kumar Aditya en gh-93312@footnote{https://github.com/python/cpython/issues/93312}.)

@item 
@ref{1a1,,os.DirEntry} ahora incluye un método @ref{544,,os.DirEntry.is_junction()} para verificar si la entrada es un cruce. (Aportado por Charles Machalow en gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Agregado funciones @ref{545,,os.listdrives()}, @ref{546,,os.listvolumes()} y @ref{547,,os.listmounts()} en Windows para enumerar unidades, volúmenes y puntos de montaje. (Aportado por Steve Dower en gh-102519@footnote{https://github.com/python/cpython/issues/102519}.)

@item 
@ref{548,,os.stat()} y @ref{549,,os.lstat()} ahora son más precisos en Windows. El campo @code{st_birthtime} ahora se completará con la hora de creación del archivo, y @code{st_ctime} está obsoleto pero aún contiene la hora de creación (pero en el futuro devolverá el último cambio de metadatos, para mantener la coherencia con otras plataformas). @code{st_dev} puede tener hasta 64 bits y @code{st_ino} hasta 128 bits dependiendo de su sistema de archivos, y @code{st_rdev} siempre está configurado en cero en lugar de valores incorrectos. Ambas funciones pueden ser significativamente más rápidas en las versiones más recientes de Windows. (Aportado por Steve Dower en gh-99726@footnote{https://github.com/python/cpython/issues/99726}.)
@end itemize

@node os path<2>,pathlib<5>,os<3>,Módulos mejorados
@anchor{whatsnew/3 12 os-path}@anchor{54a}
@subsubsection os.path



@itemize *

@item 
Agregado @ref{54b,,os.path.isjunction()} para verificar si una ruta determinada es un cruce. (Aportado por Charles Machalow en gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Agregado @ref{54c,,os.path.splitroot()} para dividir una ruta en una tríada @code{(drive, root, tail)}. (Aportado por Barney Gale en gh-101000@footnote{https://github.com/python/cpython/issues/101000}.)
@end itemize

@node pathlib<5>,pbd,os path<2>,Módulos mejorados
@anchor{whatsnew/3 12 pathlib}@anchor{54d}
@subsubsection pathlib



@itemize *

@item 
Agregado soporte para subclasificar @ref{54e,,pathlib.PurePath} y @ref{19b,,pathlib.Path}, además de sus variantes específicas de Posix y Windows. Las subclases pueden anular el método @ref{54f,,pathlib.PurePath.with_segments()} para pasar información entre instancias de ruta.

@item 
Agregado @ref{550,,pathlib.Path.walk()} para recorrer los árboles de directorios y generar todos los nombres de archivos o directorios dentro de ellos, similar a @ref{551,,os.walk()}. (Aportado por Stanislav Zmiev en gh-90385@footnote{https://github.com/python/cpython/issues/90385}.)

@item 
Agregado el parámetro opcional `walk_up' a @ref{21d,,pathlib.PurePath.relative_to()} para permitir la inserción de entradas @code{..} en el resultado; este comportamiento es más consistente con @ref{552,,os.path.relpath()}. (Aportado por Domenico Ragusa en gh-84538@footnote{https://github.com/python/cpython/issues/84538}.)

@item 
Agregado @ref{553,,pathlib.Path.is_junction()} como proxy a @ref{54b,,os.path.isjunction()}. (Aportado por Charles Machalow en gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Agregado el parámetro opcional `case_sensitive' a @ref{388,,pathlib.Path.glob()}, @ref{389,,pathlib.Path.rglob()} y @ref{554,,pathlib.PurePath.match()} para hacer coincidir la distinción entre mayúsculas y minúsculas de la ruta, lo que permite un control más preciso sobre el proceso de coincidencia.
@end itemize

@node pbd,random<2>,pathlib<5>,Módulos mejorados
@anchor{whatsnew/3 12 pdb}@anchor{555}
@subsubsection pbd



@itemize *

@item 
Agregado variables convenientes para mantener valores temporalmente para la sesión de depuración y proporcionar acceso rápido a valores como el marco actual o el valor de retorno. (Aportado por Tian Gao en gh-103693@footnote{https://github.com/python/cpython/issues/103693}.)
@end itemize

@node random<2>,shutil<2>,pbd,Módulos mejorados
@anchor{whatsnew/3 12 random}@anchor{556}
@subsubsection random



@itemize *

@item 
Agregado @ref{557,,random.binomialvariate()}. (Aportado por Raymond Hettinger en gh-81620@footnote{https://github.com/python/cpython/issues/81620}.)

@item 
Agregado un valor predeterminado de @code{lambd=1.0} a @ref{558,,random.expovariate()}. (Aportado por Raymond Hettinger en gh-100234@footnote{https://github.com/python/cpython/issues/100234}.)
@end itemize

@node shutil<2>,sqlite3<3>,random<2>,Módulos mejorados
@anchor{whatsnew/3 12 shutil}@anchor{559}
@subsubsection shutil



@itemize *

@item 
@ref{55a,,shutil.make_archive()} ahora pasa el argumento `root_dir' a archivadores personalizados que lo admiten. En este caso, ya no cambia temporalmente el directorio de trabajo actual del proceso a `root_dir' para realizar el archivado. (Aportado por Serhiy Storchaka en gh-74696@footnote{https://github.com/python/cpython/issues/74696}.)

@item 
@ref{1f9,,shutil.rmtree()} now accepts a new argument `onexc' which is an
error handler like `onerror' but which expects an exception instance
rather than a `(typ, val, tb)' triplet. `onerror' is deprecated.
(Contributed by Irit Katriel in gh-102828@footnote{https://github.com/python/cpython/issues/102828}.)

@item 
@ref{55b,,shutil.which()} ahora consulta la variable de entorno `PATHEXT' para encontrar coincidencias dentro de `PATH' en Windows incluso cuando el `cmd' dado incluye un componente de directorio. (Aportado por Charles Machalow en gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)

@ref{55b,,shutil.which()} llamará a @code{NeedCurrentDirectoryForExePathW} cuando solicite ejecutables en Windows para determinar si el directorio de trabajo actual debe anteponerse a la ruta de búsqueda. (Aportado por Charles Machalow en gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)

@ref{55b,,shutil.which()} devolverá una ruta que coincida con `cmd' con un componente de @code{PATHEXT} antes de una coincidencia directa en otra parte de la ruta de búsqueda en Windows. (Aportado por Charles Machalow en gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)
@end itemize

@node sqlite3<3>,statistics<2>,shutil<2>,Módulos mejorados
@anchor{whatsnew/3 12 sqlite3}@anchor{55c}
@subsubsection sqlite3



@itemize *

@item 
Agregado un @ref{4ee,,command-line interface}. (Aportado por Erlend E. Aasland en gh-77617@footnote{https://github.com/python/cpython/issues/77617}.)

@item 
Agregado el atributo @ref{55d,,sqlite3.Connection.autocommit} a @ref{39e,,sqlite3.Connection} y el parámetro `autocommit' a @ref{3f5,,sqlite3.connect()} para controlar @ref{55e,,transaction handling} compatible con 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}. (Aportado por Erlend E. Aasland en gh-83638@footnote{https://github.com/python/cpython/issues/83638}.)

@item 
Agregado el parámetro de solo palabra clave `entrypoint' a @ref{55f,,sqlite3.Connection.load_extension()}, para anular el punto de entrada de la extensión SQLite. (Aportado por Erlend E. Aasland en gh-103015@footnote{https://github.com/python/cpython/issues/103015}.)

@item 
Agregado @ref{560,,sqlite3.Connection.getconfig()} y @ref{561,,sqlite3.Connection.setconfig()} a @ref{39e,,sqlite3.Connection} para realizar cambios de configuración en una conexión de base de datos. (Aportado por Erlend E. Aasland en gh-103489@footnote{https://github.com/python/cpython/issues/103489}.)
@end itemize

@node statistics<2>,sys<3>,sqlite3<3>,Módulos mejorados
@anchor{whatsnew/3 12 statistics}@anchor{562}
@subsubsection statistics



@itemize *

@item 
Se extendió @ref{563,,statistics.correlation()} para incluirlo como método @code{ranked} para calcular la correlación de Spearman de datos clasificados. (Aportado por Raymond Hettinger en gh-95861@footnote{https://github.com/python/cpython/issues/95861}.)
@end itemize

@node sys<3>,tempfile<2>,statistics<2>,Módulos mejorados
@anchor{whatsnew/3 12 sys}@anchor{564}
@subsubsection sys



@itemize *

@item 
Agregado el espacio de nombres @ref{da,,sys.monitoring} para exponer la nueva API de supervisión @ref{4ea,,PEP 669}. (Aportado por Mark Shannon en gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@item 
Agregado @ref{51a,,sys.activate_stack_trampoline()} y @ref{51b,,sys.deactivate_stack_trampoline()} para activar y desactivar los trampolines del perfilador de pila, y @ref{51c,,sys.is_stack_trampoline_active()} para consultar si los trampolines del perfilador de pila están activos. (Contribuido por Pablo Galindo y Christian Heimes con contribuciones de Gregory P. Smith [Google] y Mark Shannon en gh-96123@footnote{https://github.com/python/cpython/issues/96123}.)

@item 
Agregado @ref{565,,sys.last_exc} que contiene la última excepción no controlada que se generó (para casos de uso de depuración post-mortem). Deje obsoletos los tres campos que tienen la misma información en su formato heredado: @ref{566,,sys.last_type}, @ref{567,,sys.last_value} y @ref{568,,sys.last_traceback}. (Aportado por Irit Katriel en gh-102778@footnote{https://github.com/python/cpython/issues/102778}.)

@item 
@ref{569,,sys._current_exceptions()} ahora devuelve una asignación de thread-id a una instancia de excepción, en lugar de a una tupla @code{(typ, exc, tb)}. (Aportado por Irit Katriel en gh-103176@footnote{https://github.com/python/cpython/issues/103176}.)

@item 
@ref{56a,,sys.setrecursionlimit()} y @ref{56b,,sys.getrecursionlimit()}. El límite de recursividad ahora se aplica sólo al código Python. Las funciones integradas no utilizan el límite de recursividad, pero están protegidas por un mecanismo diferente que evita que la recursividad provoque un fallo de la máquina virtual.
@end itemize

@node tempfile<2>,threading,sys<3>,Módulos mejorados
@anchor{whatsnew/3 12 tempfile}@anchor{56c}
@subsubsection tempfile



@itemize *

@item 
La función @ref{56d,,tempfile.NamedTemporaryFile} tiene un nuevo parámetro opcional `delete_on_close' (Aportado por Evgeny Zorin en gh-58451@footnote{https://github.com/python/cpython/issues/58451}.)

@item 
@ref{37c,,tempfile.mkdtemp()} ahora siempre devuelve una ruta absoluta, incluso si el argumento proporcionado al parámetro `dir' es una ruta relativa.
@end itemize

@node threading,tkinter<2>,tempfile<2>,Módulos mejorados
@anchor{whatsnew/3 12 threading}@anchor{56e}
@subsubsection threading



@itemize *

@item 
Agregado @ref{56f,,threading.settrace_all_threads()} y @ref{570,,threading.setprofile_all_threads()} que permiten configurar funciones de seguimiento y creación de perfiles en todos los hilos en ejecución además del que realiza la llamada. (Aportado por Pablo Galindo en gh-93503@footnote{https://github.com/python/cpython/issues/93503}.)
@end itemize

@node tkinter<2>,tokenize,threading,Módulos mejorados
@anchor{whatsnew/3 12 tkinter}@anchor{571}
@subsubsection tkinter



@itemize *

@item 
@code{tkinter.Canvas.coords()} ahora aplana sus argumentos. Ahora acepta no sólo coordenadas como argumentos separados (@code{x1, y1, x2, y2, ...}) y una secuencia de coordenadas (@code{[x1, y1, x2, y2, ...]}), sino también coordenadas agrupadas en pares (@code{(x1, y1), (x2, y2), ...} y @code{[(x1, y1), (x2, y2), ...]}), como los métodos @code{create_*()}. (Aportado por Serhiy Storchaka en gh-94473@footnote{https://github.com/python/cpython/issues/94473}.)
@end itemize

@node tokenize,types<2>,tkinter<2>,Módulos mejorados
@anchor{whatsnew/3 12 tokenize}@anchor{572}
@subsubsection tokenize



@itemize *

@item 
El módulo @ref{fb,,tokenize} incluye los cambios introducidos en 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. (Aportado por Marta Gómez Macías y Pablo Galindo en gh-102856@footnote{https://github.com/python/cpython/issues/102856}.) Consulte @ref{573,,Portar a Python 3.12} para obtener más información sobre los cambios en el módulo @ref{fb,,tokenize}.
@end itemize

@node types<2>,typing<4>,tokenize,Módulos mejorados
@anchor{whatsnew/3 12 types}@anchor{574}
@subsubsection types



@itemize *

@item 
Agregado @ref{575,,types.get_original_bases()} para permitir una mayor introspección de @ref{576,,Tipos genéricos definidos por el usuario} cuando esté subclasificado. (Contribución de James Hilton-Balfe y Alex Waygood en gh-101827@footnote{https://github.com/python/cpython/issues/101827}.)
@end itemize

@node typing<4>,unicodedata<3>,types<2>,Módulos mejorados
@anchor{whatsnew/3 12 typing}@anchor{577}@anchor{whatsnew/3 12 whatsnew-typing-py312}@anchor{578}
@subsubsection typing



@itemize *

@item 
Las comprobaciones de @ref{4ef,,isinstance()} con @ref{4f0,,runtime-checkable protocols} ahora usan @ref{53d,,inspect.getattr_static()} en lugar de @ref{579,,hasattr()} para buscar si existen atributos. Esto significa que los descriptores y los métodos @ref{57a,,__getattr__()} ya no se evalúan inesperadamente durante las comprobaciones de @code{isinstance()} con protocolos verificables en tiempo de ejecución. Sin embargo, también puede significar que algunos objetos que solían considerarse instancias de un protocolo verificable en tiempo de ejecución ya no se consideran instancias de ese protocolo en Python 3.12+, y viceversa. Es poco probable que la mayoría de los usuarios se vean afectados por este cambio. (Contribuido por Alex Waygood en gh-102433@footnote{https://github.com/python/cpython/issues/102433}.)

@item 
Los miembros de un protocolo verificable en tiempo de ejecución ahora se consideran «congelados» en tiempo de ejecución tan pronto como se crea la clase. La aplicación de parches de atributos en un protocolo verificable en tiempo de ejecución seguirá funcionando, pero no tendrá ningún impacto en las comprobaciones @ref{4ef,,isinstance()} que comparan objetos con el protocolo. Por ejemplo:

@example
>>> from typing import Protocol, runtime_checkable
>>> @@runtime_checkable
... class HasX(Protocol):
...     x = 1
...
>>> class Foo: ...
...
>>> f = Foo()
>>> isinstance(f, HasX)
False
>>> f.x = 1
>>> isinstance(f, HasX)
True
>>> HasX.y = 2
>>> isinstance(f, HasX)  # unchanged, even though HasX now also has a "y" attribute
True
@end example

Este cambio se realizó para acelerar las comprobaciones de @code{isinstance()} en protocolos verificables en tiempo de ejecución.

@item 
The performance profile of @ref{4ef,,isinstance()} checks against
@ref{4f0,,runtime-checkable protocols} has changed
significantly. Most @code{isinstance()} checks against protocols with only a few
members should be at least 2x faster than in 3.11, and some may be 20x
faster or more. However, @code{isinstance()} checks against protocols with many
members may be slower than in Python 3.11. (Contributed by Alex
Waygood in gh-74690@footnote{https://github.com/python/cpython/issues/74690} and gh-103193@footnote{https://github.com/python/cpython/issues/103193}.)

@item 
Todas las clases @ref{2ce,,typing.TypedDict} y @ref{1db,,typing.NamedTuple} ahora tienen el atributo @code{__orig_bases__}. (Aportado por Adrián García Badaracco en gh-103699@footnote{https://github.com/python/cpython/issues/103699}.)

@item 
Agregado el parámetro @code{frozen_default} a @ref{57b,,typing.dataclass_transform()}. (Aportado por Erik De Bonte en gh-99957@footnote{https://github.com/python/cpython/issues/99957}.)
@end itemize

@node unicodedata<3>,unittest<3>,typing<4>,Módulos mejorados
@anchor{whatsnew/3 12 unicodedata}@anchor{57c}
@subsubsection unicodedata



@itemize *

@item 
La base de datos Unicode se ha actualizado a la versión 15.0.0. (Aportado por Benjamin Peterson en gh-96734@footnote{https://github.com/python/cpython/issues/96734}).
@end itemize

@node unittest<3>,uuid<2>,unicodedata<3>,Módulos mejorados
@anchor{whatsnew/3 12 unittest}@anchor{57d}
@subsubsection unittest


Agregado una opción de línea de comando @code{--durations}, que muestra los N casos de prueba más lentos:

@example
python3 -m unittest --durations=3 lib.tests.test_threading
.....
Slowest test durations
----------------------------------------------------------------------
1.210s     test_timeout (Lib.test.test_threading.BarrierTests)
1.003s     test_default_timeout (Lib.test.test_threading.BarrierTests)
0.518s     test_timeout (Lib.test.test_threading.EventTests)

(0.000 durations hidden.  Use -v to show these durations.)
----------------------------------------------------------------------
Ran 158 tests in 9.869s

OK (skipped=3)
@end example

(Aportado por Giampaolo Rodola en gh-48330@footnote{https://github.com/python/cpython/issues/48330})

@node uuid<2>,,unittest<3>,Módulos mejorados
@anchor{whatsnew/3 12 uuid}@anchor{57e}
@subsubsection uuid



@itemize *

@item 
Agregado un @ref{4f1,,command-line interface}. (Aportado por Adam Chhina en gh-88597@footnote{https://github.com/python/cpython/issues/88597}.)
@end itemize

@node Optimizaciones,Cambios en el código de bytes de CPython,Módulos mejorados,Novedades de Python 3 12
@anchor{whatsnew/3 12 optimizations}@anchor{57f}
@subsection Optimizaciones



@itemize *

@item 
Elimine los miembros @code{wstr} y @code{wstr_length} de los objetos Unicode. Reduce el tamaño del objeto en 8 o 16 bytes en una plataforma de 64 bits. (
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}) (Aportado por Inada Naoki en gh-92536@footnote{https://github.com/python/cpython/issues/92536}.)

@item 
Agregado soporte experimental para usar el optimizador binario BOLT en el proceso de compilación, lo que mejora el rendimiento entre un 1% y un 5%. (Contribuido por Kevin Modzelewski en gh-90536@footnote{https://github.com/python/cpython/issues/90536} y sintonizado por Donghee Na en gh-101525@footnote{https://github.com/python/cpython/issues/101525})

@item 
Acelere la sustitución de expresiones regulares (funciones @ref{3f2,,re.sub()} y @ref{3f3,,re.subn()} y los métodos @code{re.Pattern} correspondientes) para cadenas de reemplazo que contienen referencias de grupo entre 2 y 3 veces. (Aportado por Serhiy Storchaka en gh-91524@footnote{https://github.com/python/cpython/issues/91524}.)

@item 
Acelere la creación de @ref{580,,asyncio.Task} aplazando el costoso formato de cadenas. (Aportado por Itamar Oren en gh-103793@footnote{https://github.com/python/cpython/issues/103793}.)

@item 
Las funciones @ref{581,,tokenize.tokenize()} y @ref{582,,tokenize.generate_tokens()} son hasta un 64 % más rápidas como efecto secundario de los cambios necesarios para cubrir 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} en el módulo @ref{fb,,tokenize}. (Aportado por Marta Gómez Macías y Pablo Galindo en gh-102856@footnote{https://github.com/python/cpython/issues/102856}.)

@item 
Acelere las llamadas al método @ref{155,,super()} y las cargas de atributos mediante la nueva instrucción @ref{583,,LOAD_SUPER_ATTR}. (Contribución de Carl Meyer y Vladimir Matveev en gh-103497@footnote{https://github.com/python/cpython/issues/103497}.)
@end itemize

@node Cambios en el código de bytes de CPython,Demostraciones y herramientas,Optimizaciones,Novedades de Python 3 12
@anchor{whatsnew/3 12 cpython-bytecode-changes}@anchor{584}
@subsection Cambios en el código de bytes de CPython



@itemize *

@item 
Elimine la instrucción @code{LOAD_METHOD}. Se ha fusionado con @ref{585,,LOAD_ATTR}. @ref{585,,LOAD_ATTR} ahora se comportará como la antigua instrucción @code{LOAD_METHOD} si el bit bajo de su oparg está configurado. (Contribuido por Ken Jin en gh-93429@footnote{https://github.com/python/cpython/issues/93429}.)

@item 
Elimine las instrucciones @code{JUMP_IF_FALSE_OR_POP} y @code{JUMP_IF_TRUE_OR_POP}. (Aportado por Irit Katriel en gh-102859@footnote{https://github.com/python/cpython/issues/102859}.)

@item 
Elimine la instrucción @code{PRECALL}. (Aportado por Mark Shannon en gh-92925@footnote{https://github.com/python/cpython/issues/92925}.)

@item 
Agregado las instrucciones @ref{586,,BINARY_SLICE} y @ref{587,,STORE_SLICE}. (Aportado por Mark Shannon en gh-94163@footnote{https://github.com/python/cpython/issues/94163}.)

@item 
Agregado las instrucciones @ref{588,,CALL_INTRINSIC_1}. (Aportado por Mark Shannon en gh-99005@footnote{https://github.com/python/cpython/issues/99005}.)

@item 
Agregado la instrucción @ref{589,,CALL_INTRINSIC_2}. (Aportado por Irit Katriel en gh-101799@footnote{https://github.com/python/cpython/issues/101799}.)

@item 
Agregado la instrucción @ref{58a,,CLEANUP_THROW}. (Aportado por Brandt Bucher en gh-90997@footnote{https://github.com/python/cpython/issues/90997}.)

@item 
Agregado la instrucción @code{END_SEND}. (Aportado por Mark Shannon en gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@item 
Agregada la instrucción @ref{58b,,LOAD_FAST_AND_CLEAR} como parte de la implementación de 
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}. (Aportado por Carl Meyer en gh-101441@footnote{https://github.com/python/cpython/issues/101441}.)

@item 
Agregado la instrucción @ref{58c,,LOAD_FAST_CHECK}. (Aportado por Dennis Sweeney en gh-93143@footnote{https://github.com/python/cpython/issues/93143}.)

@item 
Agregado los códigos de operación @ref{58d,,LOAD_FROM_DICT_OR_DEREF}, @ref{58e,,LOAD_FROM_DICT_OR_GLOBALS} y @ref{58f,,LOAD_LOCALS} como parte de la implementación de 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}. Elimine el código de operación @code{LOAD_CLASSDEREF}, que se puede reemplazar con @ref{58f,,LOAD_LOCALS} más @ref{58d,,LOAD_FROM_DICT_OR_DEREF}. (Aportado por Jelle Zijlstra en gh-103764@footnote{https://github.com/python/cpython/issues/103764}.)

@item 
Agregado la instrucción @ref{583,,LOAD_SUPER_ATTR}. (Contribución de Carl Meyer y Vladimir Matveev en gh-103497@footnote{https://github.com/python/cpython/issues/103497}.)

@item 
Add the @code{RETURN_CONST} instruction. (Contributed by Wenyang Wang in gh-101632@footnote{https://github.com/python/cpython/issues/101632}.)
@end itemize

@node Demostraciones y herramientas,Obsoleto,Cambios en el código de bytes de CPython,Novedades de Python 3 12
@anchor{whatsnew/3 12 demos-and-tools}@anchor{590}
@subsection Demostraciones y herramientas



@itemize *

@item 
Elimine el directorio @code{Tools/demo/} que contenía scripts de demostración antiguos. Se puede encontrar una copia en el old-demos project@footnote{https://github.com/gvanrossum/old-demos}. (Aportado por Victor Stinner en gh-97681@footnote{https://github.com/python/cpython/issues/97681}.)

@item 
Elimine los scripts de ejemplo obsoletos del directorio @code{Tools/scripts/}. Se puede encontrar una copia en el old-demos project@footnote{https://github.com/gvanrossum/old-demos}. (Aportado por Victor Stinner en gh-97669@footnote{https://github.com/python/cpython/issues/97669}.)
@end itemize

@node Obsoleto,Eliminado,Demostraciones y herramientas,Novedades de Python 3 12
@anchor{whatsnew/3 12 deprecated}@anchor{591}
@subsection Obsoleto



@itemize *

@item 
@ref{7,,argparse}: Los parámetros `type', `choices' y `metavar' de @code{argparse.BooleanOptionalAction} están obsoletos y se eliminarán en 3.14. (Contribución de Nikita Sobolev en gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{9,,ast}: las siguientes características de @ref{9,,ast} han quedado obsoletas en la documentación desde Python 3.8, ahora provocan que se emita un @ref{1da,,DeprecationWarning} en tiempo de ejecución cuando se accede a ellas o se usan, y se eliminarán en Python 3.14:


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

Utilice @ref{211,,ast.Constant} en su lugar. (Aportado por Serhiy Storchaka en gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{b,,asyncio}:


@itemize *

@item 
The child watcher classes @code{asyncio.MultiLoopChildWatcher},
@code{asyncio.FastChildWatcher}, @code{asyncio.AbstractChildWatcher}
and @code{asyncio.SafeChildWatcher} are deprecated and
will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@code{asyncio.set_child_watcher()}, @code{asyncio.get_child_watcher()},
@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} and
@code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} are deprecated
and will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
El método @ref{214,,get_event_loop()} de la política de bucle de eventos predeterminada ahora emite un @ref{1da,,DeprecationWarning} si no hay ningún bucle de eventos establecido y decide crear uno. (Contribución de Serhiy Storchaka y Guido van Rossum en gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{15,,calendar}: las constantes @code{calendar.January} y @code{calendar.February} están obsoletas y reemplazadas por @ref{1f1,,calendar.JANUARY} y @ref{1f2,,calendar.FEBRUARY}. (Aportado por el Príncipe Roshan en gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1f,,collections.abc}: Deprecated @code{collections.abc.ByteString}.
Prefer @code{Sequence} or @ref{3fe,,collections.abc.Buffer}.
For use in typing, prefer a union, like @code{bytes | bytearray}, or @ref{3fe,,collections.abc.Buffer}.
(Contributed by Shantanu Jain in gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)

@item 
@ref{31,,datetime}: @ref{1f4,,utcnow()} y @ref{1f5,,utcfromtimestamp()} de @ref{32f,,datetime.datetime} están en desuso y se eliminarán en una versión futura. En su lugar, utilice objetos que tengan en cuenta la zona horaria para representar las fechas y horas en UTC: respectivamente, llame a @ref{592,,now()} y @ref{593,,fromtimestamp()} con el parámetro `tz' establecido en @ref{594,,datetime.UTC}. (Aportado por Paul Ganssle en gh-103857@footnote{https://github.com/python/cpython/issues/103857}.)

@item 
@ref{3c,,email}: obsoleto el parámetro `isdst' en @ref{217,,email.utils.localtime()}. (Aportado por Alan Williams en gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc}: Obsoletas las siguientes clases, cuya eliminación está programada en Python 3.14:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Utilice clases @ref{7c,,importlib.resources.abc} en su lugar:


@itemize *

@item 
@ref{219,,importlib.resources.abc.Traversable}

@item 
@ref{21a,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribución de Jason R. Coombs y Hugo van Kemenade en gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools}: obsoleta la compatibilidad con operaciones de copia, copia profunda y pickle, que no está documentada, es ineficiente, históricamente tiene errores e inconsistente. Esto se eliminará en 3.14 para lograr una reducción significativa en el volumen de código y la carga de mantenimiento. (Aportado por Raymond Hettinger en gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: en Python 3.14, el método de inicio predeterminado de @ref{94,,multiprocessing} cambiará a uno más seguro en Linux, BSD y otras plataformas POSIX que no sean macOS donde @code{'fork'} es actualmente el predeterminado (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Agregar una advertencia de tiempo de ejecución sobre esto se consideró demasiado perjudicial ya que se espera que a la mayoría del código no le importe. Utilice las API @ref{18b,,get_context()} o @ref{18c,,set_start_method()} para especificar explícitamente cuándo su código `requires' @code{'fork'}. Ver @ref{162,,contexts and start methods}.

@item 
@ref{a9,,pkgutil}: @code{pkgutil.find_loader()} and @code{pkgutil.get_loader()}
are deprecated and will be removed in Python 3.14;
use @ref{3ff,,importlib.util.find_spec()} instead.
(Contributed by Nikita Sobolev in gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}: el módulo tiene dos funciones @code{master_open()} y @code{slave_open()} no documentadas que han quedado obsoletas desde Python 2 pero que solo obtuvieron un @ref{1da,,DeprecationWarning} adecuado en 3.12. Elimínelos en 3.14. (Aportado por Soumendra Ganguly y Gregory P. Smith en gh-85984@footnote{https://github.com/python/cpython/issues/85984}.)

@item 
@ref{a1,,os}:


@itemize *

@item 
Los campos @code{st_ctime} devueltos por @ref{548,,os.stat()} y @ref{549,,os.lstat()} en Windows están en desuso. En una versión futura, contendrán la hora del último cambio de metadatos, de forma coherente con otras plataformas. Por ahora, todavía contienen la hora de creación, que también está disponible en el nuevo campo @code{st_birthtime}. (Aportado por Steve Dower en gh-99726@footnote{https://github.com/python/cpython/issues/99726}.)

@item 
On POSIX platforms, @ref{2ff,,os.fork()} can now raise a
@ref{1da,,DeprecationWarning} when it can detect being called from a
multithreaded process. There has always been a fundamental incompatibility
with the POSIX platform when doing so. Even if such code `appeared' to work.
We added the warning to raise awareness as issues encountered by code doing
this are becoming more frequent. See the @ref{2ff,,os.fork()} documentation for
more details along with this discussion on fork being incompatible with threads@footnote{https://discuss.python.org/t/concerns-regarding-deprecation-of-fork-with-alive-threads/33555} for `why' we’re now surfacing this
longstanding platform compatibility problem to developers.
@end itemize

Cuando aparece esta advertencia debido al uso de @ref{94,,multiprocessing} o @ref{22,,concurrent.futures}, la solución es utilizar un método de inicio de @ref{94,,multiprocessing} diferente, como @code{"spawn"} o @code{"forkserver"}.

@item 
@ref{c5,,shutil}: The `onerror' argument of @ref{1f9,,shutil.rmtree()} is deprecated;
use `onexc' instead. (Contributed by Irit Katriel in gh-102828@footnote{https://github.com/python/cpython/issues/102828}.)

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@ref{595,,default adapters and converters} ahora están en desuso. En su lugar, utilice el @ref{596,,Ejemplos para adaptadores y convertidores} y adáptelo a sus necesidades. (Aportado por Erlend E. Aasland en gh-90016@footnote{https://github.com/python/cpython/issues/90016}.)

@item 
En @ref{400,,execute()}, @ref{1da,,DeprecationWarning} ahora se emite cuando @ref{402,,named placeholders} se utiliza junto con los parámetros proporcionados como @ref{597,,sequence} en lugar de como @ref{190,,dict}. A partir de Python 3.14, el uso de marcadores de posición con nombre con parámetros proporcionados como una secuencia generará un @ref{223,,ProgrammingError}. (Aportado por Erlend E. Aasland en gh-101698@footnote{https://github.com/python/cpython/issues/101698}.)
@end itemize

@item 
@ref{d9,,sys}: los campos @ref{566,,sys.last_type}, @ref{567,,sys.last_value} y @ref{568,,sys.last_traceback} están en desuso. Utilice @ref{565,,sys.last_exc} en su lugar. (Aportado por Irit Katriel en gh-102778@footnote{https://github.com/python/cpython/issues/102778}.)

@item 
@ref{de,,tarfile}: la extracción de archivos tar sin especificar `filter' está en desuso hasta Python 3.14, cuando el filtro @code{'data'} se convertirá en el predeterminado. Consulte @ref{517,,Extraction filters} para obtener más detalles.

@item 
@ref{104,,typing}:


@itemize *

@item 
@ref{598,,typing.Hashable} and @ref{599,,typing.Sized}, aliases for
@ref{59a,,collections.abc.Hashable} and @ref{59b,,collections.abc.Sized} respectively, are
deprecated. (gh-94309@footnote{https://github.com/python/cpython/issues/94309}.)

@item 
@code{typing.ByteString}, deprecated since Python 3.9, now causes a
@ref{1da,,DeprecationWarning} to be emitted when it is used.
(Contributed by Alex Waygood in gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize

@item 
@ref{125,,xml.etree.ElementTree}: el módulo ahora emite @ref{1da,,DeprecationWarning} al probar el valor de verdad de un @ref{20b,,xml.etree.ElementTree.Element}. Antes, la implementación de Python emitía @ref{4d4,,FutureWarning} y la implementación de C no emitía nada. (Aportado por Jacob Walls en gh-83122@footnote{https://github.com/python/cpython/issues/83122}.)

@item 
Las firmas de 3 argumentos (tipo, valor, rastreo) de @ref{59c,,coroutine throw()}, @ref{59d,,generator throw()} y @ref{59e,,async generator throw()} están en desuso y es posible que se eliminen en una versión futura de Python. Utilice en su lugar las versiones de un solo argumento de estas funciones. (Aportado por Ofey Chan en gh-89874@footnote{https://github.com/python/cpython/issues/89874}.)

@item 
@ref{1da,,DeprecationWarning} is now raised when @ref{1cd,,__package__} on a
module differs from
@ref{1ce,,__spec__.parent} (previously
it was @ref{59f,,ImportWarning}).
(Contributed by Brett Cannon in gh-65961@footnote{https://github.com/python/cpython/issues/65961}.)

@item 
Setting @ref{1cd,,__package__} or @ref{1cb,,__cached__} on a
module is deprecated, and will cease to be set or taken into consideration by
the import system in Python 3.14. (Contributed by Brett Cannon in gh-65961@footnote{https://github.com/python/cpython/issues/65961}.)

@item 
The bitwise inversion operator (@code{~}) on bool is deprecated. It will throw an
error in Python 3.16. Use @code{not} for logical negation of bools instead.
In the rare case that you really need the bitwise inversion of the underlying
@code{int}, convert to int explicitly: @code{~int(x)}. (Contributed by Tim Hoffmann
in gh-103487@footnote{https://github.com/python/cpython/issues/103487}.)

@item 
Accessing @ref{1d9,,co_lnotab} on code objects was deprecated in
Python 3.10 via 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/},
but it only got a proper @ref{1da,,DeprecationWarning} in 3.12.
May be removed in 3.15.
(Contributed by Nikita Sobolev in gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@menu
* Pending removal in Python 3.13: Pending removal in Python 3 13. 
* Pending removal in Python 3.14: Pending removal in Python 3 14<3>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<5>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<3>. 
* Pending removal in future versions: Pending removal in future versions<5>. 

@end menu

@node Pending removal in Python 3 13,Pending removal in Python 3 14<3>,,Obsoleto
@anchor{whatsnew/3 12 pending-removal-in-python-3-13}@anchor{5a0}
@subsubsection Pending removal in Python 3.13


Módulos (ver 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}):


@itemize *

@item 
@code{aifc}

@item 
@code{audioop}

@item 
@code{cgi}

@item 
@code{cgitb}

@item 
@code{chunk}

@item 
@code{crypt}

@item 
@code{imghdr}

@item 
@code{mailcap}

@item 
@code{msilib}

@item 
@code{nis}

@item 
@code{nntplib}

@item 
@code{ossaudiodev}

@item 
@code{pipes}

@item 
@code{sndhdr}

@item 
@code{spwd}

@item 
@code{sunau}

@item 
@code{telnetlib}

@item 
@code{uu}

@item 
@code{xdrlib}
@end itemize

Otros módulos:


@itemize *

@item 
@code{lib2to3} y el programa @code{2to3} (gh-84540@footnote{https://github.com/python/cpython/issues/84540})
@end itemize

APIs:


@itemize *

@item 
@code{configparser.LegacyInterpolation} (gh-90765@footnote{https://github.com/python/cpython/issues/90765})

@item 
@code{locale.resetlocale()} (gh-90817@footnote{https://github.com/python/cpython/issues/90817})

@item 
@code{turtle.RawTurtle.settiltangle()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.findTestCases()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.getTestCaseNames()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.makeSuite()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.TestProgram.usageExit()} (gh-67048@footnote{https://github.com/python/cpython/issues/67048})

@item 
@code{webbrowser.MacOSX} (gh-86421@footnote{https://github.com/python/cpython/issues/86421})

@item 
Encadenamiento de descriptores @ref{2d2,,classmethod} (gh-89519@footnote{https://github.com/python/cpython/issues/89519})

@item 
@ref{7b,,importlib.resources} deprecated methods:


@itemize *

@item 
@code{contents()}

@item 
@code{is_resource()}

@item 
@code{open_binary()}

@item 
@code{open_text()}

@item 
@code{path()}

@item 
@code{read_binary()}

@item 
@code{read_text()}
@end itemize

Use @ref{537,,importlib.resources.files()} instead.  Refer to importlib-resources: Migrating from Legacy@footnote{https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy} (gh-106531@footnote{https://github.com/python/cpython/issues/106531})
@end itemize

@node Pending removal in Python 3 14<3>,Pending removal in Python 3 15<5>,Pending removal in Python 3 13,Obsoleto
@anchor{whatsnew/3 12 pending-removal-in-python-3-14}@anchor{5a1}
@subsubsection Pending removal in Python 3.14



@itemize *

@item 
@ref{7,,argparse}: Los parámetros `type', `choices' y `metavar' de @code{argparse.BooleanOptionalAction} están obsoletos y se eliminarán en 3.14. (Contribución de Nikita Sobolev en gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{9,,ast}: The following features have been deprecated in documentation
since Python 3.8, now cause a @ref{1da,,DeprecationWarning} to be emitted at
runtime when they are accessed or used, and will be removed in Python 3.14:


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

Utilice @ref{211,,ast.Constant} en su lugar. (Aportado por Serhiy Storchaka en gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{b,,asyncio}:


@itemize *

@item 
The child watcher classes @code{asyncio.MultiLoopChildWatcher},
@code{asyncio.FastChildWatcher}, @code{asyncio.AbstractChildWatcher}
and @code{asyncio.SafeChildWatcher} are deprecated and
will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@code{asyncio.set_child_watcher()}, @code{asyncio.get_child_watcher()},
@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} and
@code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} are deprecated
and will be removed in Python 3.14.
(Contributed by Kumar Aditya in gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
El método @ref{214,,get_event_loop()} de la política de bucle de eventos predeterminada ahora emite un @ref{1da,,DeprecationWarning} si no hay ningún bucle de eventos establecido y decide crear uno. (Contribución de Serhiy Storchaka y Guido van Rossum en gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{1f,,collections.abc}: Deprecated @code{collections.abc.ByteString}.
Prefer @code{Sequence} or @ref{3fe,,Buffer}.
For use in typing, prefer a union, like @code{bytes | bytearray},
or @ref{3fe,,collections.abc.Buffer}.
(Contributed by Shantanu Jain in gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)

@item 
@ref{3c,,email}: Deprecated the `isdst' parameter in @ref{217,,email.utils.localtime()}.
(Contributed by Alan Williams in gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc} deprecated classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Utilice clases @ref{7c,,importlib.resources.abc} en su lugar:


@itemize *

@item 
@ref{219,,importlib.resources.abc.Traversable}

@item 
@ref{21a,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribución de Jason R. Coombs y Hugo van Kemenade en gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools} had undocumented, inefficient, historically buggy,
and inconsistent support for copy, deepcopy, and pickle operations.
This will be removed in 3.14 for a significant reduction in code
volume and maintenance burden.
(Contributed by Raymond Hettinger in gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: The default start method will change to a safer one on
Linux, BSDs, and other non-macOS POSIX platforms where @code{'fork'} is currently
the default (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adding a runtime warning about this was deemed too
disruptive as the majority of code is not expected to care. Use the
@ref{18b,,get_context()} or
@ref{18c,,set_start_method()} APIs to explicitly specify when
your code `requires' @code{'fork'}.  See @ref{162,,Contextos y métodos de inicio}.

@item 
@ref{a4,,pathlib}: @ref{21e,,is_relative_to()} and
@ref{21d,,relative_to()}: passing additional arguments is
deprecated.

@item 
@ref{a9,,pkgutil}: @code{pkgutil.find_loader()} and :func:!pkgutil.get_loader`
now raise @ref{1da,,DeprecationWarning};
use @ref{3ff,,importlib.util.find_spec()} instead.
(Contributed by Nikita Sobolev in gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}:


@itemize *

@item 
@code{master_open()}: use @ref{221,,pty.openpty()}.

@item 
@code{slave_open()}: use @ref{221,,pty.openpty()}.
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@code{version} and @code{version_info}.

@item 
@ref{400,,execute()} and @ref{401,,executemany()}
if @ref{402,,named placeholders} are used and
`parameters' is a sequence instead of a @ref{190,,dict}.
@end itemize

@item 
@ref{104,,typing}: @code{typing.ByteString}, deprecated since Python 3.9,
now causes a @ref{1da,,DeprecationWarning} to be emitted when it is used.

@item 
@ref{108,,urllib}:
@code{urllib.parse.Quoter} is deprecated: it was not intended to be a
public API.
(Contributed by Gregory P. Smith in gh-88168@footnote{https://github.com/python/cpython/issues/88168}.)
@end itemize

@node Pending removal in Python 3 15<5>,Pending removal in Python 3 16<3>,Pending removal in Python 3 14<3>,Obsoleto
@anchor{whatsnew/3 12 pending-removal-in-python-3-15}@anchor{5a2}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1cb,,__cached__} on a module while
failing to set @ref{1cc,,__spec__.cached}
is deprecated. In Python 3.15, @code{__cached__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
Setting @ref{1cd,,__package__} on a module while
failing to set @ref{1ce,,__spec__.parent}
is deprecated. In Python 3.15, @code{__package__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2b,,ctypes}:


@itemize *

@item 
The undocumented @code{ctypes.SetPointerType()} function
has been deprecated since Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
The obsolete and rarely used @ref{1cf,,CGIHTTPRequestHandler}
has been deprecated since Python 3.13.
No direct replacement exists.
`Anything' is better than CGI to interface
a web server with a request handler.

@item 
The @code{--cgi} flag to the @code{python -m http.server}
command-line interface has been deprecated since Python 3.13.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
The @ref{1d0,,getdefaultlocale()} function
has been deprecated since Python 3.11.
Its removal was originally planned for Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}),
but has been postponed to Python 3.15.
Use @ref{1d1,,getlocale()}, @ref{1d2,,setlocale()},
and @ref{1d3,,getencoding()} instead.
(Contributed by Hugo van Kemenade in gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{1d4,,PurePath.is_reserved()}
has been deprecated since Python 3.13.
Use @ref{1d5,,os.path.isreserved()} to detect reserved paths on Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{1d6,,java_ver()} has been deprecated since Python 3.13.
This function is only useful for Jython support, has a confusing API,
and is largely untested.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{1d7,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the  Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{1d8,,types.CodeType}: Accessing @ref{1d9,,co_lnotab} was
deprecated in 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}
since 3.10 and was planned to be removed in 3.12,
but it only got a proper @ref{1da,,DeprecationWarning} in 3.12.
May be removed in 3.15.
(Contributed by Nikita Sobolev in gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
The undocumented keyword argument syntax for creating
@ref{1db,,NamedTuple} classes
(for example, @code{Point = NamedTuple("Point", x=int, y=int)})
has been deprecated since Python 3.13.
Use the class-based syntax or the functional syntax instead.

@item 
The @ref{1dc,,typing.no_type_check_decorator()} decorator function
has been deprecated since Python 3.13.
After eight years in the @ref{104,,typing} module,
it has yet to be supported by any major type checker.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
The @ref{1dd,,getmark()}, @code{setmark()},
and @ref{1de,,getmarkers()} methods of
the @ref{1df,,Wave_read} and @ref{1e0,,Wave_write} classes
have been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in Python 3 16<3>,Pending removal in future versions<5>,Pending removal in Python 3 15<5>,Obsoleto
@anchor{whatsnew/3 12 pending-removal-in-python-3-16}@anchor{5a3}
@subsubsection Pending removal in Python 3.16



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1e2,,__loader__} on a module while
failing to set @ref{1e3,,__spec__.loader}
is deprecated. In Python 3.16, @code{__loader__} will cease to be set or
taken into consideration by the import system or the standard library.
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
The @code{'u'} format code (@code{wchar_t})
has been deprecated in documentation since Python 3.3
and at runtime since Python 3.13.
Use the @code{'w'} format code (@ref{1e4,,Py_UCS4})
for Unicode characters instead.
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} is deprecated
and will be removed in Python 3.16,
use @ref{1c3,,inspect.iscoroutinefunction()} instead.
(Contributed by Jiahao Li and Kumar Aditya in gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
Bitwise inversion on boolean types, @code{~True} or @code{~False}
has been deprecated since Python 3.12,
as it produces surprising and unintuitive results (@code{-2} and @code{-1}).
Use @code{not x} instead for the logical negation of a Boolean.
In the rare case that you need the bitwise inversion of
the underlying integer, convert to @code{int} explicitly (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
The @code{ExecError} exception
has been deprecated since Python 3.14.
It has not been used by any function in @code{shutil} since Python 3.4,
and is now an alias of @ref{1e5,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
The @ref{1c7,,Class.get_methods} method
has been deprecated since Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
The @ref{1e6,,_enablelegacywindowsfsencoding()} function
has been deprecated since Python 3.13.
Use the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment variable instead.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
The undocumented and unused @code{TarFile.tarfile} attribute
has been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in future versions<5>,,Pending removal in Python 3 16<3>,Obsoleto
@anchor{whatsnew/3 12 pending-removal-in-future-versions}@anchor{5a4}
@subsubsection Pending removal in future versions


The following APIs will be removed in the future,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
Nesting argument groups and nesting mutually exclusive
groups are deprecated.

@item 
Passing the undocumented keyword argument `prefix_chars' to
@ref{1c1,,add_argument_group()} is now
deprecated.

@item 
The @ref{1c2,,argparse.FileType} type converter is deprecated.
@end itemize

@item 
Código de formato @code{'u'} de @ref{8,,array} (gh-57281@footnote{https://github.com/python/cpython/issues/57281})

@item 
@ref{13,,builtins}:


@itemize *

@item 
@code{bool(NotImplemented)}.

@item 
Generators: @code{throw(type, exc, tb)} and @code{athrow(type, exc, tb)}
signature is deprecated: use @code{throw(exc)} and @code{athrow(exc)} instead,
the single argument signature.

@item 
Currently Python accepts numeric literals immediately followed by keywords,
for example @code{0in x}, @code{1or x}, @code{0if 1else 2}.  It allows confusing and
ambiguous expressions like @code{[0x1for x in y]} (which can be interpreted as
@code{[0x1 for x in y]} or @code{[0x1f or x in y]}).  A syntax warning is raised
if the numeric literal is immediately followed by one of keywords
@ref{1e9,,and}, @ref{1ea,,else}, @ref{1eb,,for}, @ref{1ec,,if},
@ref{1ed,,in}, @ref{1ee,,is} and @ref{1ef,,or}.  In a future release it
will be changed to a syntax error. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Support for @code{__index__()} and @code{__int__()} method returning non-int type:
these methods will be required to return an instance of a strict subclass of
@ref{1f0,,int}.

@item 
Support for @code{__float__()} method returning a strict subclass of
@ref{153,,float}: these methods will be required to return an instance of
@ref{153,,float}.

@item 
Support for @code{__complex__()} method returning a strict subclass of
@ref{154,,complex}: these methods will be required to return an instance of
@ref{154,,complex}.

@item 
Delegation of @code{int()} to @code{__trunc__()} method.

@item 
Passing a complex number as the `real' or `imag' argument in the
@ref{154,,complex()} constructor is now deprecated; it should only be passed
as a single positional argument.
(Contributed by Serhiy Storchaka in gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{15,,calendar}: las constantes @code{calendar.January} y @code{calendar.February} están obsoletas y reemplazadas por @ref{1f1,,calendar.JANUARY} y @ref{1f2,,calendar.FEBRUARY}. (Aportado por el Príncipe Roshan en gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1d9,,codeobject.co_lnotab}: use the @ref{1f3,,codeobject.co_lines()} method
instead.

@item 
@ref{31,,datetime}:


@itemize *

@item 
@ref{1f4,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{1f5,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: Plural value must be an integer.

@item 
@ref{77,,importlib}:


@itemize *

@item 
@code{load_module()} method: use @code{exec_module()} instead.

@item 
@ref{1f6,,cache_from_source()} `debug_override' parameter is
deprecated: use the `optimization' parameter instead.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} tuple interface.

@item 
Implicit @code{None} on return values.
@end itemize

@item 
@ref{87,,logging}: the @code{warn()} method has been deprecated
since Python 3.3, use @ref{1f7,,warning()} instead.

@item 
@ref{8b,,mailbox}: Use of StringIO input and text mode is deprecated, use
BytesIO and binary mode instead.

@item 
@ref{a1,,os}: Calling @ref{1f8,,os.register_at_fork()} in multi-threaded process.

@item 
@code{pydoc.ErrorDuringImport}: A tuple value for `exc_info' parameter is
deprecated, use an exception instance.

@item 
@ref{b9,,re}: More strict rules are now applied for numerical group references
and group names in regular expressions.  Only sequence of ASCII digits is now
accepted as a numerical reference.  The group name in bytes patterns and
replacement strings can now only contain ASCII letters and digits and
underscore.
(Contributed by Serhiy Storchaka in gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
@code{sre_compile}, @code{sre_constants} and @code{sre_parse} modules.

@item 
@ref{c5,,shutil}: @ref{1f9,,rmtree()}”s `onerror' parameter is deprecated in
Python 3.12; use the `onexc' parameter instead.

@item 
@ref{d0,,ssl} options and protocols:


@itemize *

@item 
@ref{1fa,,ssl.SSLContext} without protocol argument is deprecated.

@item 
@ref{1fa,,ssl.SSLContext}: @ref{1fb,,set_npn_protocols()} and
@code{selected_npn_protocol()} are deprecated: use ALPN
instead.

@item 
@code{ssl.OP_NO_SSL*} options

@item 
@code{ssl.OP_NO_TLS*} options

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{1fc,,sysconfig.is_python_build()} `check_home' parameter is deprecated and
ignored.

@item 
@ref{ed,,threading} methods:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{1fd,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{1fe,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{1ff,,threading.Thread.setDaemon()}:
use @ref{200,,threading.Thread.daemon} attribute.

@item 
@code{threading.Thread.getName()}, @ref{201,,threading.Thread.setName()}:
use @ref{202,,threading.Thread.name} attribute.

@item 
@code{threading.currentThread()}: use @ref{203,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{204,,threading.active_count()}.
@end itemize

@item 
@ref{205,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{206,,unittest.IsolatedAsyncioTestCase}: it is deprecated to return a value
that is not @code{None} from a test case.

@item 
@ref{10a,,urllib.parse} deprecated functions: @ref{207,,urlparse()} instead


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{10b,,urllib.request}: @ref{208,,URLopener} and
@ref{209,,FancyURLopener} style of invoking requests is
deprecated. Use newer @ref{20a,,urlopen()} functions and methods.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} should not do partial
writes.

@item 
@ref{125,,xml.etree.ElementTree}: Testing the truth value of an
@ref{20b,,Element} is deprecated. In a future release it
will always return @code{True}. Prefer explicit @code{len(elem)} or
@code{elem is not None} tests instead.

@item 
@ref{20c,,zipimport.zipimporter.load_module()} is deprecated:
use @ref{20d,,exec_module()} instead.
@end itemize

@node Eliminado,Portar a Python 3 12,Obsoleto,Novedades de Python 3 12
@anchor{whatsnew/3 12 removed}@anchor{5a5}@anchor{whatsnew/3 12 whatsnew312-removed}@anchor{5a6}
@subsection Eliminado


@menu
* asynchat y asyncore:: 
* configparser: configparser<3>. 
* distutils:: 
* ensurepip:: 
* enum:: 
* ftplib:: 
* gzip:: 
* hashlib:: 
* importlib: importlib<3>. 
* imp:: 
* io: io<3>. 
* locale: locale<2>. 
* smtpd:: 
* sqlite3: sqlite3<4>. 
* ssl: ssl<2>. 
* unittest: unittest<4>. 
* webbrowser: webbrowser<2>. 
* xml.etree.ElementTree: xml etree ElementTree. 
* zipimport: zipimport<2>. 
* Otros:: 

@end menu

@node asynchat y asyncore,configparser<3>,,Eliminado
@anchor{whatsnew/3 12 asynchat-and-asyncore}@anchor{5a7}
@subsubsection asynchat y asyncore



@itemize *

@item 
Estos dos módulos se eliminaron según lo programado en 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} y quedaron obsoletos en Python 3.6. Utilice @ref{b,,asyncio} en su lugar. (Aportado por Nikita Sobolev en gh-96580@footnote{https://github.com/python/cpython/issues/96580}.)
@end itemize

@node configparser<3>,distutils,asynchat y asyncore,Eliminado
@anchor{whatsnew/3 12 configparser}@anchor{5a8}
@subsubsection configparser



@itemize *

@item 
Varios nombres obsoletos en @ref{23,,configparser} en 3.2 se han eliminado según gh-89336@footnote{https://github.com/python/cpython/issues/89336}:


@itemize *

@item 
@ref{5a9,,configparser.ParsingError} ya no tiene un atributo o argumento @code{filename}. Utilice el atributo y el argumento @code{source} en su lugar.

@item 
@ref{23,,configparser} ya no tiene una clase @code{SafeConfigParser}. Utilice en su lugar el nombre @ref{32b,,ConfigParser} más corto.

@item 
@ref{32b,,configparser.ConfigParser} ya no tiene un método @code{readfp}. Utilice @ref{5aa,,read_file()} en su lugar.
@end itemize
@end itemize

@node distutils,ensurepip,configparser<3>,Eliminado
@anchor{whatsnew/3 12 distutils}@anchor{5ab}@anchor{whatsnew/3 12 whatsnew312-removed-distutils}@anchor{5ac}
@subsubsection distutils



@itemize *

@item 
Elimine el paquete @code{distutils}. Quedó obsoleto en Python 3.10 por 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} «Módulo distutils obsoleto». Para proyectos que todavía usan @code{distutils} y no se pueden actualizar a otra cosa, se puede instalar el proyecto @code{setuptools}: todavía proporciona @code{distutils}. (Aportado por Victor Stinner en gh-92584@footnote{https://github.com/python/cpython/issues/92584}.)
@end itemize

@node ensurepip,enum,distutils,Eliminado
@anchor{whatsnew/3 12 ensurepip}@anchor{5ad}
@subsubsection ensurepip



@itemize *

@item 
Retire la rueda de herramientas de configuración incluida en @ref{55,,ensurepip} y deje de instalar herramientas de configuración en entornos creados por @ref{111,,venv}.

@code{pip (>= 22.1)} no requiere la instalación de herramientas de configuración en el entorno. Los paquetes basados ​​en @code{setuptools} (y @code{distutils}) aún se pueden usar con @code{pip install}, ya que pip proporcionará @code{setuptools} en el entorno de compilación que utiliza para crear un paquete.

@code{easy_install}, @code{pkg_resources}, @code{setuptools} y @code{distutils} ya no se proporcionan de forma predeterminada en entornos creados con @code{venv} o arrancados con @code{ensurepip}, ya que forman parte del paquete @code{setuptools}. Para proyectos que dependen de estos en tiempo de ejecución, el proyecto @code{setuptools} debe declararse como una dependencia e instalarse por separado (generalmente, usando pip).

(Aportado por Pradyun Gedam en gh-95299@footnote{https://github.com/python/cpython/issues/95299}.)
@end itemize

@node enum,ftplib,ensurepip,Eliminado
@anchor{whatsnew/3 12 enum}@anchor{5ae}
@subsubsection enum



@itemize *

@item 
Elimine @code{EnumMeta.__getattr__} de @ref{56,,enum}, que ya no es necesario para acceder al atributo de enumeración. (Aportado por Ethan Furman en gh-95083@footnote{https://github.com/python/cpython/issues/95083}.)
@end itemize

@node ftplib,gzip,enum,Eliminado
@anchor{whatsnew/3 12 ftplib}@anchor{5af}
@subsubsection ftplib



@itemize *

@item 
Elimine el atributo de clase @code{FTP_TLS.ssl_version} de @ref{5e,,ftplib}: utilice el parámetro `context' en su lugar. (Aportado por Victor Stinner en gh-94172@footnote{https://github.com/python/cpython/issues/94172}.)
@end itemize

@node gzip,hashlib,ftplib,Eliminado
@anchor{whatsnew/3 12 gzip}@anchor{5b0}
@subsubsection gzip



@itemize *

@item 
Elimine el atributo @code{filename} del @ref{4d8,,gzip.GzipFile} de @ref{67,,gzip}, en desuso desde Python 2.6; utilice el atributo @ref{5b1,,name} en su lugar. En modo de escritura, el atributo @code{filename} agregaba la extensión de archivo @code{'.gz'} si no estaba presente. (Aportado por Victor Stinner en gh-94196@footnote{https://github.com/python/cpython/issues/94196}.)
@end itemize

@node hashlib,importlib<3>,gzip,Eliminado
@anchor{whatsnew/3 12 hashlib}@anchor{5b2}
@subsubsection hashlib



@itemize *

@item 
Remove the pure Python implementation of @ref{68,,hashlib}’s
@ref{5b3,,hashlib.pbkdf2_hmac()}, deprecated in Python 3.10. Python 3.10 and
newer requires OpenSSL 1.1.1 (
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}): this OpenSSL version provides
a C implementation of @ref{5b3,,pbkdf2_hmac()} which is faster.
(Contributed by Victor Stinner in gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)
@end itemize

@node importlib<3>,imp,hashlib,Eliminado
@anchor{whatsnew/3 12 importlib}@anchor{5b4}
@subsubsection importlib



@itemize *

@item 
Muchas limpiezas anteriormente obsoletas en @ref{77,,importlib} ahora se han completado:


@itemize *

@item 
References to, and support for @code{module_repr()} has been removed.
(Contributed by Barry Warsaw in gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
Se han eliminado @code{importlib.util.set_package}, @code{importlib.util.set_loader} y @code{importlib.util.module_for_loader}. (Contribución de Brett Cannon y Nikita Sobolev en gh-65961@footnote{https://github.com/python/cpython/issues/65961} y gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
Se eliminó la compatibilidad con las API @code{find_loader()} y @code{find_module()}. (Aportado por Barry Varsovia en gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)

@item 
Se han eliminado @code{importlib.abc.Finder}, @code{pkgutil.ImpImporter} y @code{pkgutil.ImpLoader}. (Aportado por Barry Varsovia en gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)
@end itemize
@end itemize

@node imp,io<3>,importlib<3>,Eliminado
@anchor{whatsnew/3 12 imp}@anchor{5b5}@anchor{whatsnew/3 12 whatsnew312-removed-imp}@anchor{5b6}
@subsubsection imp



@itemize *

@item 
Se ha eliminado el módulo @code{imp}. (Aportado por Barry Varsovia en gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)

Para migrar consulte la siguiente tabla de correspondencias:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

imp

@tab

importlib

@item

@code{imp.NullImporter}

@tab

Inserta @code{None} en @code{sys.path_importer_cache}

@item

@code{imp.cache_from_source()}

@tab

@ref{1f6,,importlib.util.cache_from_source()}

@item

@code{imp.find_module()}

@tab

@ref{3ff,,importlib.util.find_spec()}

@item

@code{imp.get_magic()}

@tab

@ref{5b7,,importlib.util.MAGIC_NUMBER}

@item

@code{imp.get_suffixes()}

@tab

@ref{5b8,,importlib.machinery.SOURCE_SUFFIXES}, @ref{5b9,,importlib.machinery.EXTENSION_SUFFIXES} y @ref{5ba,,importlib.machinery.BYTECODE_SUFFIXES}

@item

@code{imp.get_tag()}

@tab

@ref{5bb,,sys.implementation.cache_tag}

@item

@code{imp.load_module()}

@tab

@ref{5bc,,importlib.import_module()}

@item

@code{imp.new_module(name)}

@tab

@code{types.ModuleType(name)}

@item

@code{imp.reload()}

@tab

@ref{5bd,,importlib.reload()}

@item

@code{imp.source_from_cache()}

@tab

@ref{5be,,importlib.util.source_from_cache()}

@item

@code{imp.load_source()}

@tab

`Ver abajo'

@end multitable

@end quotation

Reemplace @code{imp.load_source()} con:

@example
import importlib.util
import importlib.machinery

def load_source(modname, filename):
    loader = importlib.machinery.SourceFileLoader(modname, filename)
    spec = importlib.util.spec_from_file_location(modname, filename, loader=loader)
    module = importlib.util.module_from_spec(spec)
    # The module is always executed and not cached in sys.modules.
    # Uncomment the following line to cache the module.
    # sys.modules[module.__name__] = module
    loader.exec_module(module)
    return module
@end example

@item 
Elimine las funciones y atributos de @code{imp} sin reemplazos:


@itemize *

@item 
Funciones no documentadas:


@itemize *

@item 
@code{imp.init_builtin()}

@item 
@code{imp.load_compiled()}

@item 
@code{imp.load_dynamic()}

@item 
@code{imp.load_package()}
@end itemize

@item 
@code{imp.lock_held()}, @code{imp.acquire_lock()}, @code{imp.release_lock()}: el esquema de bloqueo ha cambiado en Python 3.3 a bloqueos por módulo.

@item 
Constantes @code{imp.find_module()}: @code{SEARCH_ERROR}, @code{PY_SOURCE}, @code{PY_COMPILED}, @code{C_EXTENSION}, @code{PY_RESOURCE}, @code{PKG_DIRECTORY}, @code{C_BUILTIN}, @code{PY_FROZEN}, @code{PY_CODERESOURCE}, @code{IMP_HOOK}.
@end itemize
@end itemize

@node io<3>,locale<2>,imp,Eliminado
@anchor{whatsnew/3 12 io}@anchor{5bf}
@subsubsection io



@itemize *

@item 
Elimine @code{io.OpenWrapper} y @code{_pyio.OpenWrapper} de @ref{7f,,io}, obsoletos en Python 3.10: simplemente use @ref{1be,,open()} en su lugar. La función @ref{1be,,open()} (@ref{5c0,,io.open()}) es una función incorporada. Desde Python 3.10, @code{_pyio.open()} también es un método estático. (Aportado por Victor Stinner en gh-94169@footnote{https://github.com/python/cpython/issues/94169}.)
@end itemize

@node locale<2>,smtpd,io<3>,Eliminado
@anchor{whatsnew/3 12 locale}@anchor{5c1}
@subsubsection locale



@itemize *

@item 
Elimine la función @code{locale.format()} de @ref{86,,locale}, obsoleta en Python 3.7: use @ref{5c2,,locale.format_string()} en su lugar. (Aportado por Victor Stinner en gh-94226@footnote{https://github.com/python/cpython/issues/94226}.)
@end itemize

@node smtpd,sqlite3<4>,locale<2>,Eliminado
@anchor{whatsnew/3 12 smtpd}@anchor{5c3}
@subsubsection smtpd



@itemize *

@item 
The @code{smtpd} module has been removed according to the schedule in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/},
having been deprecated in Python 3.4.7 and 3.5.4.
Use the aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} PyPI module or any other
@ref{b,,asyncio}-based server instead.
(Contributed by Oleg Iarygin in gh-93243@footnote{https://github.com/python/cpython/issues/93243}.)
@end itemize

@node sqlite3<4>,ssl<2>,smtpd,Eliminado
@anchor{whatsnew/3 12 id2}@anchor{5c4}
@subsubsection sqlite3



@itemize *

@item 
Las siguientes características @ref{cf,,sqlite3} no documentadas, obsoletas en Python 3.10, ahora se eliminan:


@itemize *

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode}
@end itemize

Si se debe utilizar una caché compartida, abra la base de datos en modo URI utilizando el parámetro de consulta @code{cache=shared}.

La fábrica de textos @code{sqlite3.OptimizedUnicode} ha sido un alias para @ref{237,,str} desde Python 3.3. El código que previamente configuró la fábrica de texto en @code{OptimizedUnicode} puede usar @code{str} explícitamente o confiar en el valor predeterminado que también es @code{str}.

(Aportado por Erlend E. Aasland en gh-92548@footnote{https://github.com/python/cpython/issues/92548}.)
@end itemize

@node ssl<2>,unittest<4>,sqlite3<4>,Eliminado
@anchor{whatsnew/3 12 ssl}@anchor{5c5}
@subsubsection ssl



@itemize *

@item 
Elimine la función @code{ssl.RAND_pseudo_bytes()} de @ref{d0,,ssl}, obsoleta en Python 3.6: use @ref{5c6,,os.urandom()} o @ref{5c7,,ssl.RAND_bytes()} en su lugar. (Aportado por Victor Stinner en gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)

@item 
Elimine la función @code{ssl.match_hostname()}. Quedó obsoleto en Python 3.7. OpenSSL realiza coincidencias de nombres de host desde Python 3.7, Python ya no usa la función @code{ssl.match_hostname()}. (Aportado por Victor Stinner en gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)

@item 
Remove the @code{ssl.wrap_socket()} function, deprecated in Python 3.7:
instead, create a @ref{1fa,,ssl.SSLContext} object and call its
@ref{5c8,,ssl.SSLContext.wrap_socket} method. Any package that still uses
@code{ssl.wrap_socket()} is broken and insecure. The function neither sends a
SNI TLS extension nor validates the server hostname. Code is subject to 
@geindex Common Weakness Enumeration; CWE 295
CWE 295@footnote{https://cwe.mitre.org/data/definitions/295.html}
(Improper Certificate Validation).
(Contributed by Victor Stinner in gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)
@end itemize

@node unittest<4>,webbrowser<2>,ssl<2>,Eliminado
@anchor{whatsnew/3 12 id3}@anchor{5c9}
@subsubsection unittest



@itemize *

@item 
Elimine muchas características de @ref{106,,unittest} que están en desuso desde hace mucho tiempo:
@anchor{whatsnew/3 12 unittest-testcase-removed-aliases}@anchor{4fb}

@itemize *

@item 
Varios alias del método @ref{4fa,,TestCase}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Alias obsoleto

@tab

Nombre del método

@tab

En desuso en

@item

@code{failUnless}

@tab

@ref{5ca,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{5cb,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{5cc,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{5cd,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{5ce,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{5cf,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{5d0,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{5ca,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{5cc,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{5cd,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{5ce,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{5cf,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{5d1,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{5d2,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{5d3,,assertNotRegex()}

@tab

3.5

@end multitable


Puede utilizar @indicateurl{https://github.com/isidentical/teyit} para modernizar automáticamente sus pruebas unitarias.

@item 
Método @code{assertDictContainsSubset} de @ref{4fa,,TestCase} indocumentado y roto (obsoleto en Python 3.2).

@item 
Undocumented @ref{3e3,,TestLoader.loadTestsFromModule} parameter `use_load_tests'
(deprecated and ignored since Python 3.5).

@item 
Un alias de la clase @ref{5d4,,TextTestResult}: @code{_TextTestResult} (obsoleto en Python 3.2).
@end itemize

(Contribución de Serhiy Storchaka en gh-89325@footnote{https://github.com/python/cpython/issues/89325}.)
@end itemize

@node webbrowser<2>,xml etree ElementTree,unittest<4>,Eliminado
@anchor{whatsnew/3 12 webbrowser}@anchor{5d5}
@subsubsection webbrowser



@itemize *

@item 
Elimina la compatibilidad con navegadores obsoletos de @ref{115,,webbrowser}. Los navegadores eliminados incluyen: Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape, Firebird y Firefox versiones 35 e inferiores (gh-102871@footnote{https://github.com/python/cpython/issues/102871}).
@end itemize

@node xml etree ElementTree,zipimport<2>,webbrowser<2>,Eliminado
@anchor{whatsnew/3 12 xml-etree-elementtree}@anchor{5d6}
@subsubsection xml.etree.ElementTree



@itemize *

@item 
Elimine el método @code{ElementTree.Element.copy()} de la implementación pura de Python, obsoleto en Python 3.10, use la función @ref{5d7,,copy.copy()} en su lugar. La implementación C de @ref{125,,xml.etree.ElementTree} no tiene ningún método @code{copy()}, solo un método @code{__copy__()}. (Aportado por Victor Stinner en gh-94383@footnote{https://github.com/python/cpython/issues/94383}.)
@end itemize

@node zipimport<2>,Otros,xml etree ElementTree,Eliminado
@anchor{whatsnew/3 12 zipimport}@anchor{5d8}
@subsubsection zipimport



@itemize *

@item 
Elimine los métodos @code{find_loader()} y @code{find_module()} de @ref{131,,zipimport}, obsoletos en Python 3.10: use el método @code{find_spec()} en su lugar. Consulte 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} para conocer el fundamento. (Aportado por Victor Stinner en gh-94379@footnote{https://github.com/python/cpython/issues/94379}.)
@end itemize

@node Otros,,zipimport<2>,Eliminado
@anchor{whatsnew/3 12 others}@anchor{5d9}
@subsubsection Otros



@itemize *

@item 
Elimine la regla @code{suspicious} de la documentación @code{Makefile} y @code{Doc/tools/rstlint.py}, ambas a favor de sphinx-lint@footnote{https://github.com/sphinx-contrib/sphinx-lint}. (Contribución de Julien Palard en gh-98179@footnote{https://github.com/python/cpython/issues/98179}.)

@item 
Elimine los parámetros `keyfile' y `certfile' de los módulos @ref{5e,,ftplib}, @ref{74,,imaplib}, @ref{ac,,poplib} y @ref{ca,,smtplib}, y los parámetros `key_file', `cert_file' y `check_hostname' del módulo @ref{6f,,http.client}, todos obsoletos desde Python 3.6. Utilice el parámetro `context' (`ssl_context' en @ref{74,,imaplib}) en su lugar. (Aportado por Victor Stinner en gh-94172@footnote{https://github.com/python/cpython/issues/94172}.)

@item 
Elimine los trucos de compatibilidad @code{Jython} de varios módulos y pruebas stdlib. (Aportado por Nikita Sobolev en gh-99482@footnote{https://github.com/python/cpython/issues/99482}.)

@item 
Elimine el indicador @code{_use_broken_old_ctypes_structure_semantics_} del módulo @ref{2b,,ctypes}. (Aportado por Nikita Sobolev en gh-99285@footnote{https://github.com/python/cpython/issues/99285}.)
@end itemize

@node Portar a Python 3 12,Cambios de compilación,Eliminado,Novedades de Python 3 12
@anchor{whatsnew/3 12 porting-to-python-3-12}@anchor{5da}@anchor{whatsnew/3 12 whatsnew312-porting-to-python312}@anchor{573}
@subsection Portar a Python 3.12


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en la API de Python:: 

@end menu

@node Cambios en la API de Python,,,Portar a Python 3 12
@anchor{whatsnew/3 12 changes-in-the-python-api}@anchor{5db}
@subsubsection Cambios en la API de Python



@itemize *

@item 
Ahora se aplican reglas más estrictas para las referencias numéricas de grupos y los nombres de grupos en expresiones regulares. Ahora sólo se acepta como referencia numérica la secuencia de dígitos ASCII. El nombre del grupo en patrones de bytes y cadenas de reemplazo ahora solo puede contener letras y dígitos ASCII y guiones bajos. (Contribución de Serhiy Storchaka en gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
Elimine la funcionalidad @code{randrange()} en desuso desde Python 3.10. Anteriormente, @code{randrange(10.0)} se convertía sin pérdidas a @code{randrange(10)}. Ahora, genera un @ref{228,,TypeError}. Además, la excepción planteada para valores no enteros como @code{randrange(10.5)} o @code{randrange('10')} se cambió de @ref{360,,ValueError} a @ref{228,,TypeError}. Esto también evita errores en los que @code{randrange(1e25)} seleccionaría silenciosamente de un rango mayor que @code{randrange(10**25)}. (Originalmente sugerido por Serhiy Storchaka gh-86388@footnote{https://github.com/python/cpython/issues/86388}.)

@item 
@ref{15c,,argparse.ArgumentParser} cambió la codificación y el controlador de errores para leer argumentos de un archivo (por ejemplo, la opción @code{fromfile_prefix_chars}) de la codificación de texto predeterminada (por ejemplo, @ref{5dc,,locale.getpreferredencoding(False)}) a @ref{5dd,,filesystem encoding and error handler}. Los archivos de argumentos deben codificarse en UTF-8 en lugar de en la página de códigos ANSI en Windows.

@item 
Remove the @code{asyncore}-based @code{smtpd} module deprecated in Python 3.4.7
and 3.5.4.  A recommended replacement is the
@ref{b,,asyncio}-based aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} PyPI module.

@item 
@ref{5de,,shlex.split()}: Pasar @code{None} por el argumento `s' ahora genera una excepción, en lugar de leer @ref{5df,,sys.stdin}. La característica quedó obsoleta en Python 3.9. (Aportado por Victor Stinner en gh-94352@footnote{https://github.com/python/cpython/issues/94352}.)

@item 
El módulo @ref{a1,,os} ya no acepta rutas tipo bytes, como los tipos @ref{5e0,,bytearray} y @ref{156,,memoryview}: solo se acepta el tipo exacto @ref{325,,bytes} para cadenas de bytes. (Aportado por Victor Stinner en gh-98393@footnote{https://github.com/python/cpython/issues/98393}.)

@item 
@ref{5e1,,syslog.openlog()} y @ref{5e2,,syslog.closelog()} ahora fallan si se usan en subintérpretes. @ref{5e3,,syslog.syslog()} aún se puede usar en subintérpretes, pero ahora solo si @ref{5e1,,syslog.openlog()} ya ha sido llamado en el intérprete principal. Estas nuevas restricciones no se aplican al intérprete principal, por lo que sólo un conjunto muy pequeño de usuarios podría verse afectado. Este cambio ayuda con el aislamiento del intérprete. Además, @ref{dc,,syslog} es un contenedor de recursos globales de procesos, que se administran mejor desde el intérprete principal. (Aportado por Donghee Na en gh-99127@footnote{https://github.com/python/cpython/issues/99127}.)

@item 
Se elimina el comportamiento de bloqueo no documentado de @ref{5e4,,cached_property()}, porque bloqueaba todas las instancias de la clase, lo que generaba una alta contención de bloqueo. Esto significa que una función de obtención de propiedades almacenadas en caché ahora podría ejecutarse más de una vez para una sola instancia, si dos subprocesos se ejecutan. Para la mayoría de las propiedades almacenadas en caché simples (por ejemplo, aquellas que son idempotentes y simplemente calculan un valor en función de otros atributos de la instancia), esto estará bien. Si se necesita sincronización, implemente el bloqueo dentro de la función de obtención de propiedades en caché o alrededor de puntos de acceso de subprocesos múltiples.

@item 
@ref{569,,sys._current_exceptions()} ahora devuelve una asignación de thread-id a una instancia de excepción, en lugar de a una tupla @code{(typ, exc, tb)}. (Aportado por Irit Katriel en gh-103176@footnote{https://github.com/python/cpython/issues/103176}.)

@item 
Al extraer archivos tar usando @ref{de,,tarfile} o @ref{516,,shutil.unpack_archive()}, pase el argumento `filter' para limitar las funciones que pueden resultar sorprendentes o peligrosas. Consulte @ref{517,,Extraction filters} para obtener más detalles.

@item 
La salida de las funciones @ref{581,,tokenize.tokenize()} y @ref{582,,tokenize.generate_tokens()} ahora cambia debido a los cambios introducidos en 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. Esto significa que los tokens @code{STRING} ya no se emiten para cadenas f y los tokens descritos en 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} ahora se producen en su lugar: @code{FSTRING_START}, @code{FSTRING_MIDDLE} y @code{FSTRING_END} ahora se emiten para partes de «cadena» de cadena f además de los tokens apropiados para la tokenización. en los componentes de la expresión. Por ejemplo, para la cadena f @code{f"start @{1+1@} end"}, la versión anterior del tokenizador emitió:

@example
1,0-1,18:           STRING         'f"start @{1+1@} end"'
@end example

mientras que la nueva versión emite:

@example
1,0-1,2:            FSTRING_START  'f"'
1,2-1,8:            FSTRING_MIDDLE 'start '
1,8-1,9:            OP             '@{'
1,9-1,10:           NUMBER         '1'
1,10-1,11:          OP             '+'
1,11-1,12:          NUMBER         '1'
1,12-1,13:          OP             '@}'
1,13-1,17:          FSTRING_MIDDLE ' end'
1,17-1,18:          FSTRING_END    '"'
@end example

Además, puede haber algunos cambios de comportamiento menores como consecuencia de los cambios necesarios para admitir 
@geindex Python Enhancement Proposals; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. Algunos de estos cambios incluyen:


@itemize *

@item 
El atributo @code{type} de los tokens emitidos al tokenizar algunos caracteres de Python no válidos, como @code{!}, ha cambiado de @code{ERRORTOKEN} a @code{OP}.

@item 
Las cadenas incompletas de una sola línea ahora también generan @ref{5e5,,tokenize.TokenError} como lo hacen las cadenas incompletas de varias líneas.

@item 
Algún código Python incompleto o no válido ahora genera @ref{5e5,,tokenize.TokenError} en lugar de devolver tokens @code{ERRORTOKEN} arbitrarios al tokenizarlo.

@item 
Ya no se admite la combinación de tabulaciones y espacios como sangría en el mismo archivo y generará un @ref{5e6,,TabError}.
@end itemize

@item 
The @ref{ed,,threading} module now expects the @code{_thread} module to have
an @code{_is_main_interpreter} attribute.  It is a function with no
arguments that returns @code{True} if the current interpreter is the
main interpreter.

Any library or application that provides a custom @code{_thread} module
should provide @code{_is_main_interpreter()}.
(See gh-112826@footnote{https://github.com/python/cpython/issues/112826}.)
@end itemize

@node Cambios de compilación,Cambios en la API de C,Portar a Python 3 12,Novedades de Python 3 12
@anchor{whatsnew/3 12 build-changes}@anchor{5e7}
@subsection Cambios de compilación



@itemize *

@item 
Python ya no usa @code{setup.py} para crear módulos de extensión C compartidos. Los parámetros de compilación, como encabezados y bibliotecas, se detectan en el script @code{configure}. Las extensiones están construidas por @code{Makefile}. La mayoría de las extensiones usan @code{pkg-config} y recurren a la detección manual. (Aportado por Christian Heimes en gh-93939@footnote{https://github.com/python/cpython/issues/93939}.)

@item 
Ahora se requiere @code{va_start()} con dos parámetros, como @code{va_start(args, format),}, para compilar Python. @code{va_start()} ya no se llama con un solo parámetro. (Aportado por Kumar Aditya en gh-93207@footnote{https://github.com/python/cpython/issues/93207}.)

@item 
CPython ahora usa la opción ThinLTO como política predeterminada de optimización del tiempo de enlace si el compilador Clang acepta la marca. (Aportado por Donghee Na en gh-89536@footnote{https://github.com/python/cpython/issues/89536}.)

@item 
Agregado la variable @code{COMPILEALL_OPTS} en @code{Makefile} para anular las opciones de @ref{21,,compileall} (predeterminada: @code{-j0}) en @code{make install}. También fusionó los 3 comandos @code{compileall} en un solo comando para crear archivos .pyc para todos los niveles de optimización (0, 1, 2) a la vez. (Aportado por Victor Stinner en gh-99289@footnote{https://github.com/python/cpython/issues/99289}.)

@item 
Agregado tripletes de plataforma para LoongArch de 64 bits:


@itemize *

@item 
loongarch64-linux-gnusf

@item 
loongarch64-linux-gnuf32

@item 
loongarch64-linux-gnu
@end itemize

(Aportado por Zhang Na en gh-90656@footnote{https://github.com/python/cpython/issues/90656}.)

@item 
@code{PYTHON_FOR_REGEN} ahora requiere Python 3.10 o posterior.

@item 
Ahora se requieren Autoconf 2.71 y aclocal 1.16.4 para regenerar @code{!configure}. (Aportado por Christian Heimes en gh-89886@footnote{https://github.com/python/cpython/issues/89886}.)

@item 
Las compilaciones de Windows y los instaladores de macOS de python.org ahora usan OpenSSL 3.0.
@end itemize

@node Cambios en la API de C,,Cambios de compilación,Novedades de Python 3 12
@anchor{whatsnew/3 12 c-api-changes}@anchor{5e8}
@subsection Cambios en la API de C


@menu
* Nuevas características: Nuevas características<2>. 
* Portar a Python 3.12: Portar a Python 3 12<2>. 
* Obsoleto: Obsoleto<2>. 
* Eliminado: Eliminado<2>. 

@end menu

@node Nuevas características<2>,Portar a Python 3 12<2>,,Cambios en la API de C
@anchor{whatsnew/3 12 id4}@anchor{5e9}
@subsubsection Nuevas características

@anchor{whatsnew/3 12 whatsnew312-pep697}@anchor{4f2}

@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: presente @ref{5ea,,Unstable C API tier}, destinado a herramientas de bajo nivel como depuradores y compiladores JIT. Esta API puede cambiar en cada versión menor de CPython sin advertencias de obsolescencia. Su contenido está marcado con el prefijo @code{PyUnstable_} en los nombres.

Constructores de objetos de código:


@itemize -

@item 
@code{PyUnstable_Code_New()} (renombrado de @code{PyCode_New})

@item 
@code{PyUnstable_Code_NewWithPosOnlyArgs()} (renombrado de @code{PyCode_NewWithPosOnlyArgs})
@end itemize

Almacenamiento adicional para objetos de código (
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}):


@itemize -

@item 
@code{PyUnstable_Eval_RequestCodeExtraIndex()} (renombrado de @code{_PyEval_RequestCodeExtraIndex})

@item 
@code{PyUnstable_Code_GetExtra()} (renombrado de @code{_PyCode_GetExtra})

@item 
@code{PyUnstable_Code_SetExtra()} (renombrado de @code{_PyCode_SetExtra})
@end itemize

Los nombres originales seguirán estando disponibles hasta que cambie la API respectiva.

(Aportado por Petr Viktorin en gh-101101@footnote{https://github.com/python/cpython/issues/101101}.)

@item 
@geindex Python Enhancement Proposals; PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: agregue una API para extender tipos cuyo diseño de memoria de instancia es opaco:


@itemize -

@item 
@ref{5eb,,PyType_Spec.basicsize} puede ser cero o negativo para especificar heredar o ampliar el tamaño de la clase base.

@item 
Se agregaron @ref{5ec,,PyObject_GetTypeData()} y @ref{5ed,,PyType_GetTypeDataSize()} para permitir el acceso a datos de instancia específicos de subclase.

@item 
Se agregaron @ref{5ee,,Py_TPFLAGS_ITEMS_AT_END} y @ref{5ef,,PyObject_GetItemData()} para permitir extender de forma segura ciertos tipos de tamaño variable, incluido @ref{5f0,,PyType_Type}.

@item 
Se agregó @ref{5f1,,Py_RELATIVE_OFFSET} para permitir definir @ref{5f2,,members} en términos de una estructura específica de subclase.
@end itemize

(Aportado por Petr Viktorin en gh-103509@footnote{https://github.com/python/cpython/issues/103509}.)

@item 
Agregado la nueva función @ref{488,,limited C API} @ref{5f3,,PyType_FromMetaclass()}, que generaliza el @ref{5f4,,PyType_FromModuleAndSpec()} existente utilizando un argumento de metaclase adicional. (Aportado por Wenzel Jakob en gh-93012@footnote{https://github.com/python/cpython/issues/93012}.)

@item 
Se agregó API para crear objetos que se pueden llamar usando @ref{5f5,,the vectorcall protocol} a @ref{5f6,,Limited API}:


@itemize *

@item 
@ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL}

@item 
@ref{5f8,,PyVectorcall_NARGS()}

@item 
@ref{5f9,,PyVectorcall_Call()}

@item 
@ref{5fa,,vectorcallfunc}
@end itemize

El indicador @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} ahora se elimina de una clase cuando se reasigna el método @ref{5fb,,__call__()} de la clase. Esto hace que vectorcall sea seguro de usar con tipos mutables (es decir, tipos de montón sin el indicador inmutable, @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE}). Los tipos mutables que no anulan @ref{5fc,,tp_call} ahora heredan el indicador @code{Py_TPFLAGS_HAVE_VECTORCALL}. (Aportado por Petr Viktorin en gh-93274@footnote{https://github.com/python/cpython/issues/93274}.)

The @ref{45f,,Py_TPFLAGS_MANAGED_DICT} and @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF}
flags have been added. This allows extensions classes to support object
@ref{5fe,,__dict__} and weakrefs with less bookkeeping,
using less memory and with faster access.

@item 
Se agregó API para realizar llamadas usando @ref{5f5,,the vectorcall protocol} a @ref{5f6,,Limited API}:


@itemize *

@item 
@ref{5ff,,PyObject_Vectorcall()}

@item 
@ref{600,,PyObject_VectorcallMethod()}

@item 
@ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET}
@end itemize

Esto significa que tanto el extremo entrante como el saliente del protocolo de llamada vectorial ahora están disponibles en el @ref{5f6,,Limited API}. (Aportado por Wenzel Jakob en gh-98586@footnote{https://github.com/python/cpython/issues/98586}.)

@item 
Agregado dos nuevas funciones públicas, @ref{602,,PyEval_SetProfileAllThreads()} y @ref{603,,PyEval_SetTraceAllThreads()}, que permiten configurar funciones de seguimiento y creación de perfiles en todos los subprocesos en ejecución además del que realiza la llamada. (Aportado por Pablo Galindo en gh-93503@footnote{https://github.com/python/cpython/issues/93503}.)

@item 
Agregado la nueva función @ref{604,,PyFunction_SetVectorcall()} a la API de C que establece el campo de llamada vectorial de un @ref{605,,PyFunctionObject} determinado. (Aportado por Andrew Frost en gh-92257@footnote{https://github.com/python/cpython/issues/92257}.)

@item 
La API de C ahora permite registrar devoluciones de llamada a través de @ref{606,,PyDict_AddWatcher()}, @ref{607,,PyDict_Watch()} y API relacionadas para ser llamadas cada vez que se modifica un diccionario. Está pensado para optimizar intérpretes, compiladores JIT o depuradores. (Aportado por Carl Meyer en gh-91052@footnote{https://github.com/python/cpython/issues/91052}.)

@item 
Agregado las API @ref{608,,PyType_AddWatcher()} y @ref{609,,PyType_Watch()} para registrar devoluciones de llamadas y recibir notificaciones sobre cambios en un tipo. (Aportado por Carl Meyer en gh-91051@footnote{https://github.com/python/cpython/issues/91051}.)

@item 
Agregado las API @ref{60a,,PyCode_AddWatcher()} y @ref{60b,,PyCode_ClearWatcher()} para registrar devoluciones de llamadas y recibir notificaciones sobre la creación y destrucción de objetos de código. (Aportado por Itamar Oren en gh-91054@footnote{https://github.com/python/cpython/issues/91054}.)

@item 
Agregado las funciones @ref{60c,,PyFrame_GetVar()} y @ref{60d,,PyFrame_GetVarString()} para obtener una variable de marco por su nombre. (Aportado por Victor Stinner en gh-91248@footnote{https://github.com/python/cpython/issues/91248}.)

@item 
Agregado @ref{28b,,PyErr_GetRaisedException()} y @ref{28e,,PyErr_SetRaisedException()} para guardar y restaurar la excepción actual. Estas funciones devuelven y aceptan un único objeto de excepción, en lugar de los argumentos triples de los ahora obsoletos @ref{28a,,PyErr_Fetch()} y @ref{28d,,PyErr_Restore()}. Esto es menos propenso a errores y un poco más eficiente. (Aportado por Mark Shannon en gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Agregado @code{_PyErr_ChainExceptions1}, que toma una instancia de excepción, para reemplazar la API heredada @code{_PyErr_ChainExceptions}, que ahora está en desuso. (Aportado por Mark Shannon en gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Agregado @ref{60e,,PyException_GetArgs()} y @ref{60f,,PyException_SetArgs()} como funciones convenientes para recuperar y modificar el @ref{610,,args} pasado al constructor de la excepción. (Aportado por Mark Shannon en gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Agregado @ref{299,,PyErr_DisplayException()}, que toma una instancia de excepción, para reemplazar la API heredada @code{PyErr_Display()}. (Aportado por Irit Katriel en gh-102755@footnote{https://github.com/python/cpython/issues/102755}).
@end itemize
@anchor{whatsnew/3 12 whatsnew312-pep683}@anchor{4f3}

@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}: presente `Immortal Objects', que permite que los objetos omitan los recuentos de referencias y los cambios relacionados en C-API:


@itemize -

@item 

@table @asis

@item @code{_Py_IMMORTAL_REFCNT}: el recuento de referencias que define un objeto

como inmortal.
@end table

@item 
@code{_Py_IsImmortal} Comprueba si un objeto tiene el recuento de referencia inmortal.

@item 

@table @asis

@item @code{PyObject_HEAD_INIT} Esto ahora inicializará el recuento de referencias

@code{_Py_IMMORTAL_REFCNT} cuando se utiliza con @code{Py_BUILD_CORE}.
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL} Un identificador para objetos Unicode internos

que son inmortales.
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL_STATIC} Un identificador para Unicode interno

Objetos inmortales y estáticos.
@end table

@item 

@table @asis

@item @code{sys.getunicodeinternedsize} Esto devuelve el número total de Unicode

objetos que han sido internados. Esto ahora es necesario para que @code{refleak.py} rastree correctamente los recuentos de referencia y los bloques asignados.
@end table
@end itemize

(Contribuido por Eddie Elizondo en gh-84436@footnote{https://github.com/python/cpython/issues/84436}.)

@item 
@geindex Python Enhancement Proposals; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}: agregue la nueva función @ref{507,,Py_NewInterpreterFromConfig()} y @ref{611,,PyInterpreterConfig}, que pueden usarse para crear subintérpretes con sus propios GIL. (Consulte @ref{4e9,,PEP 684; un GIL por intérprete} para obtener más información). (Contribución de Eric Snow en gh-104110@footnote{https://github.com/python/cpython/issues/104110}.)

@item 
En la versión limitada de C API 3.12, las funciones @ref{612,,Py_INCREF()} y @ref{613,,Py_DECREF()} ahora se implementan como llamadas de función opacas para ocultar los detalles de implementación. (Aportado por Victor Stinner en gh-105387@footnote{https://github.com/python/cpython/issues/105387}.)
@end itemize

@node Portar a Python 3 12<2>,Obsoleto<2>,Nuevas características<2>,Cambios en la API de C
@anchor{whatsnew/3 12 id5}@anchor{614}
@subsubsection Portar a Python 3.12



@itemize *

@item 
Se han eliminado las API Unicode heredadas basadas en la representación @code{Py_UNICODE*}. Migre a API basadas en UTF-8 o @code{wchar_t*}.

@item 
Las funciones de análisis de argumentos como @ref{615,,PyArg_ParseTuple()} ya no admiten el formato basado en @code{Py_UNICODE*} (por ejemplo, @code{u}, @code{Z}). Migre a otros formatos para Unicode como @code{s}, @code{z}, @code{es} y @code{U}.

@item 
@code{tp_weaklist} para todos los tipos integrados estáticos siempre es @code{NULL}. Este es un campo solo interno en @code{PyTypeObject}, pero señalamos el cambio en caso de que alguien acceda al campo directamente de todos modos. Para evitar roturas, considere utilizar la C-API pública existente o, si es necesario, la macro @code{_PyObject_GET_WEAKREFS_LISTPTR()} (solo interna).

@item 
Es posible que este @ref{616,,PyTypeObject.tp_subclasses} solo interno ya no sea un puntero de objeto válido. Su tipo se cambió a void* para reflejar esto. Mencionamos esto en caso de que alguien acceda directamente al campo interno.

To get a list of subclasses, call the Python method
@ref{617,,__subclasses__()} (using @ref{492,,PyObject_CallMethod()},
for example).

@item 
Agregado soporte para más opciones de formato (alineación a la izquierda, octales, hexadecimales en mayúsculas, cadenas @code{intmax_t}, @code{ptrdiff_t}, @code{wchar_t} C, ancho variable y precisión) en @ref{47c,,PyUnicode_FromFormat()} y @ref{618,,PyUnicode_FromFormatV()}. (Aportado por Serhiy Storchaka en gh-98836@footnote{https://github.com/python/cpython/issues/98836}.)

@item 
Un carácter de formato no reconocido en @ref{47c,,PyUnicode_FromFormat()} y @ref{618,,PyUnicode_FromFormatV()} ahora establece un @ref{619,,SystemError}. En versiones anteriores, provocaba que el resto de la cadena de formato se copiara tal cual en la cadena de resultado y se descartaran los argumentos adicionales. (Aportado por Serhiy Storchaka en gh-95781@footnote{https://github.com/python/cpython/issues/95781}.)

@item 
Se corrigió la ubicación incorrecta de los letreros en @ref{47c,,PyUnicode_FromFormat()} y @ref{618,,PyUnicode_FromFormatV()}. (Aportado por Philip Georgi en gh-95504@footnote{https://github.com/python/cpython/issues/95504}.)

@item 
Extension classes wanting to add a @ref{5fe,,__dict__} or weak reference slot
should use @ref{45f,,Py_TPFLAGS_MANAGED_DICT} and
@ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} instead of @code{tp_dictoffset} and
@code{tp_weaklistoffset}, respectively.
The use of @code{tp_dictoffset} and @code{tp_weaklistoffset} is still
supported, but does not fully support multiple inheritance
(gh-95589@footnote{https://github.com/python/cpython/issues/95589}), and performance may be worse.
Classes declaring @ref{45f,,Py_TPFLAGS_MANAGED_DICT} must call
@code{_PyObject_VisitManagedDict()} and @code{_PyObject_ClearManagedDict()}
to traverse and clear their instance’s dictionaries.
To clear weakrefs, call @ref{61a,,PyObject_ClearWeakRefs()}, as before.

@item 
La función @ref{61b,,PyUnicode_FSDecoder()} ya no acepta rutas de tipo bytes, como los tipos @ref{5e0,,bytearray} y @ref{156,,memoryview}: solo se acepta el tipo @ref{325,,bytes} exacto para cadenas de bytes. (Aportado por Victor Stinner en gh-98393@footnote{https://github.com/python/cpython/issues/98393}.)

@item 
Las macros @ref{61c,,Py_CLEAR}, @ref{61d,,Py_SETREF} y @ref{61e,,Py_XSETREF} ahora solo evalúan sus argumentos una vez. Si un argumento tiene efectos secundarios, estos efectos secundarios ya no se duplican. (Aportado por Victor Stinner en gh-98724@footnote{https://github.com/python/cpython/issues/98724}.)

@item 
El indicador de error del intérprete ahora siempre está normalizado. Esto significa que @ref{61f,,PyErr_SetObject()}, @ref{620,,PyErr_SetString()} y las otras funciones que configuran el indicador de error ahora normalizan la excepción antes de almacenarla. (Aportado por Mark Shannon en gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
@code{_Py_RefTotal} ya no tiene autoridad y solo se conserva por compatibilidad con ABI. Tenga en cuenta que es un global interno y solo está disponible en compilaciones de depuración. Si lo está utilizando, deberá comenzar a utilizar @code{_Py_GetGlobalRefTotal()}.

@item 
Las siguientes funciones ahora seleccionan una metaclase apropiada para el tipo recién creado:


@itemize *

@item 
@ref{621,,PyType_FromSpec()}

@item 
@ref{622,,PyType_FromSpecWithBases()}

@item 
@ref{5f4,,PyType_FromModuleAndSpec()}
@end itemize

La creación de clases cuya metaclase anule @ref{623,,tp_new} está en desuso y en Python 3.14+ no estará permitida. Tenga en cuenta que estas funciones ignoran @code{tp_new} de la metaclase, lo que posiblemente permita una inicialización incompleta.

Tenga en cuenta que @ref{5f3,,PyType_FromMetaclass()} (agregado en Python 3.12) ya no permite la creación de clases cuya metaclase anule @code{tp_new} (@ref{624,,__new__()} en Python).

Dado que @code{tp_new} anula casi todo lo que hacen las funciones @code{PyType_From*}, las dos son incompatibles entre sí. El comportamiento existente (ignorar la metaclase durante varios pasos de la creación de tipos) no es seguro en general, ya que las (meta)clases suponen que se llamó a @code{tp_new}. No existe una solución general sencilla. Uno de los siguientes puede funcionar para usted:


@itemize -

@item 
Si controlas la metaclase, evita usar @code{tp_new} en ella:


@itemize -

@item 
Si se puede omitir la inicialización, se puede realizar en @ref{625,,tp_init}.

@item 
Si no es necesario crear una instancia de la metaclase desde Python, configure su @code{tp_new} en @code{NULL} usando el indicador @ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION}. Esto lo hace aceptable para funciones @code{PyType_From*}.
@end itemize

@item 
Evite las funciones @code{PyType_From*}: si no necesita funciones específicas de C (ranuras o configuración del tamaño de la instancia), cree tipos mediante la metaclase @ref{627,,calling}.

@item 
Si `know' puede omitir @code{tp_new} de forma segura, filtre la advertencia de obsolescencia usando @ref{628,,warnings.catch_warnings()} de Python.
@end itemize

@item 
@ref{629,,PyOS_InputHook} y @ref{62a,,PyOS_ReadlineFunctionPointer} ya no se llaman en @ref{62b,,subinterpreters}. Esto se debe a que los clientes generalmente dependen del estado global de todo el proceso (ya que estas devoluciones de llamada no tienen forma de recuperar el estado del módulo de extensión).

Esto también evita situaciones en las que las extensiones pueden encontrarse ejecutándose en un subintérprete que no admiten (o que aún no se han cargado). Consulte gh-104668@footnote{https://github.com/python/cpython/issues/104668} para obtener más información.

@item 
@ref{24b,,PyLongObject} ha tenido cambios internos para un mejor rendimiento. Aunque las partes internas de @ref{24b,,PyLongObject} son privadas, algunos módulos de extensión las utilizan. Ya no se debe acceder directamente a los campos internos, sino que se deben utilizar las funciones API que comienzan con @code{PyLong_...}. Se proporcionan dos nuevas funciones API `unstable' para un acceso eficiente al valor de @ref{24b,,PyLongObject}s que cabe en una sola palabra de máquina:


@itemize *

@item 
@ref{62c,,PyUnstable_Long_IsCompact()}

@item 
@ref{62d,,PyUnstable_Long_CompactValue()}
@end itemize

@item 
Ahora se requiere que los asignadores personalizados, configurados a través de @ref{62e,,PyMem_SetAllocator()}, sean seguros para subprocesos, independientemente del dominio de memoria. Los asignadores que no tienen su propio estado, incluidos los «ganchos», no se ven afectados. Si su asignador personalizado aún no es seguro para subprocesos y necesita orientación, cree una nueva incidencia en GitHub y CC @code{@@ericsnowcurrently}.
@end itemize

@node Obsoleto<2>,Eliminado<2>,Portar a Python 3 12<2>,Cambios en la API de C
@anchor{whatsnew/3 12 id6}@anchor{62f}
@subsubsection Obsoleto



@itemize *

@item 
De acuerdo con 
@geindex Python Enhancement Proposals; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}, el campo @code{ma_version_tag} en @ref{4a3,,PyDictObject} está obsoleto para los módulos de extensión. Acceder a este campo generará una advertencia del compilador en el momento de la compilación. Este campo se eliminará en Python 3.14. (Contribución de Ramvikrams y Kumar Aditya en gh-101193@footnote{https://github.com/python/cpython/issues/101193}. PEP de Ken Jin.)

@item 
Variable de configuración global obsoleta:


@itemize *

@item 
@ref{4a7,,Py_DebugFlag}: use @ref{4a8,,PyConfig.parser_debug}

@item 
@ref{4a9,,Py_VerboseFlag}: use @ref{4aa,,PyConfig.verbose}

@item 
@ref{4ab,,Py_QuietFlag}: use @ref{4ac,,PyConfig.quiet}

@item 
@ref{4ad,,Py_InteractiveFlag}: use @ref{4ae,,PyConfig.interactive}

@item 
@ref{4af,,Py_InspectFlag}: use @ref{4b0,,PyConfig.inspect}

@item 
@ref{4b1,,Py_OptimizeFlag}: use @ref{4b2,,PyConfig.optimization_level}

@item 
@ref{4b3,,Py_NoSiteFlag}: use @ref{4b4,,PyConfig.site_import}

@item 
@ref{4b5,,Py_BytesWarningFlag}: use @ref{4b6,,PyConfig.bytes_warning}

@item 
@ref{4b7,,Py_FrozenFlag}: use @ref{4b8,,PyConfig.pathconfig_warnings}

@item 
@ref{4b9,,Py_IgnoreEnvironmentFlag}: use @ref{4ba,,PyConfig.use_environment}

@item 
@ref{4bb,,Py_DontWriteBytecodeFlag}: use @ref{4bc,,PyConfig.write_bytecode}

@item 
@ref{4bd,,Py_NoUserSiteDirectory}: use @ref{4be,,PyConfig.user_site_directory}

@item 
@ref{4bf,,Py_UnbufferedStdioFlag}: use @ref{4c0,,PyConfig.buffered_stdio}

@item 
@ref{4c1,,Py_HashRandomizationFlag}: use @ref{4c2,,PyConfig.use_hash_seed} y @ref{4c3,,PyConfig.hash_seed}

@item 
@ref{4c4,,Py_IsolatedFlag}: use @ref{4c5,,PyConfig.isolated}

@item 
@ref{4c6,,Py_LegacyWindowsFSEncodingFlag}: use @ref{4c7,,PyPreConfig.legacy_windows_fs_encoding}

@item 
@ref{4c8,,Py_LegacyWindowsStdioFlag}: use @ref{497,,PyConfig.legacy_windows_stdio}

@item 
@code{Py_FileSystemDefaultEncoding}: use @ref{4c9,,PyConfig.filesystem_encoding}

@item 
@code{Py_HasFileSystemDefaultEncoding}: use @ref{4c9,,PyConfig.filesystem_encoding}

@item 
@code{Py_FileSystemDefaultEncodeErrors}: use @ref{4ca,,PyConfig.filesystem_errors}

@item 
@code{Py_UTF8Mode}: use @ref{4cb,,PyPreConfig.utf8_mode} (ver @ref{4cc,,Py_PreInitialize()})
@end itemize

La API @ref{4a6,,Py_InitializeFromConfig()} debe usarse con @ref{499,,PyConfig} en su lugar. (Aportado por Victor Stinner en gh-77782@footnote{https://github.com/python/cpython/issues/77782}.)

@item 
La creación de @ref{2a7,,immutable types} con bases mutables está obsoleta y se deshabilitará en Python 3.14. (gh-95388@footnote{https://github.com/python/cpython/issues/95388})

@item 
El encabezado @code{structmember.h} está en desuso, aunque sigue estando disponible y no hay planes para eliminarlo.

Su contenido ahora está disponible simplemente incluyendo @code{Python.h}, con un prefijo @code{Py} agregado si faltara:


@itemize -

@item 
@ref{5f2,,PyMemberDef}, @ref{630,,PyMember_GetOne()} y @ref{631,,PyMember_SetOne()}

@item 
Escriba macros como @ref{632,,Py_T_INT}, @ref{633,,Py_T_DOUBLE}, etc. (anteriormente @code{T_INT}, @code{T_DOUBLE}, etc.)

@item 
Las banderas @ref{634,,Py_READONLY} (anteriormente @code{READONLY}) y @ref{635,,Py_AUDIT_READ} (anteriormente todas en mayúsculas)
@end itemize

Varios elementos no están expuestos desde @code{Python.h}:


@itemize -

@item 
@ref{636,,T_OBJECT} (use @ref{637,,Py_T_OBJECT_EX})

@item 
@ref{638,,T_NONE} (anteriormente indocumentado y bastante peculiar)

@item 
La macro @code{WRITE_RESTRICTED} que no hace nada.

@item 
Las macros @code{RESTRICTED} y @code{READ_RESTRICTED}, equivalentes a @ref{635,,Py_AUDIT_READ}.

@item 
En algunas configuraciones, @code{<stddef.h>} no se incluye en @code{Python.h}. Debe incluirse manualmente cuando se utiliza @code{offsetof()}.
@end itemize

El encabezado obsoleto continúa proporcionando su contenido original con los nombres originales. Su código antiguo puede permanecer sin cambios, a menos que las macros de inclusión y sin espacio de nombres adicionales le molesten mucho.

(Contribuido en gh-47146@footnote{https://github.com/python/cpython/issues/47146} por Petr Viktorin, basado en trabajos anteriores de Alexander Belopolsky y Matthias Braun.)

@item 
@ref{28a,,PyErr_Fetch()} y @ref{28d,,PyErr_Restore()} están en desuso. Utilice @ref{28b,,PyErr_GetRaisedException()} y @ref{28e,,PyErr_SetRaisedException()} en su lugar. (Aportado por Mark Shannon en gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
@code{PyErr_Display()} está en desuso. Utilice @ref{299,,PyErr_DisplayException()} en su lugar. (Aportado por Irit Katriel en gh-102755@footnote{https://github.com/python/cpython/issues/102755}).

@item 
@code{_PyErr_ChainExceptions} está en desuso. Utilice @code{_PyErr_ChainExceptions1} en su lugar. (Aportado por Irit Katriel en gh-102192@footnote{https://github.com/python/cpython/issues/102192}.)

@item 
El uso de @ref{621,,PyType_FromSpec()}, @ref{622,,PyType_FromSpecWithBases()} o @ref{5f4,,PyType_FromModuleAndSpec()} para crear una clase cuya metaclase anula @ref{623,,tp_new} está en desuso. En su lugar, llame a la metaclase.
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Pending removal in Python 3.14: Pending removal in Python 3 14<4>. 
* Pending removal in Python 3.15: Pending removal in Python 3 15<6>. 
* Pending removal in future versions: Pending removal in future versions<6>. 

@end menu

@node Pending removal in Python 3 14<4>,Pending removal in Python 3 15<6>,,Obsoleto<2>
@anchor{whatsnew/3 12 id7}@anchor{639}
@subsubsection Pending removal in Python 3.14



@itemize *

@item 
El campo @code{ma_version_tag} en @ref{4a3,,PyDictObject} para módulos de extensión (
@geindex Python Enhancement Proposals; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}; gh-101193@footnote{https://github.com/python/cpython/issues/101193}).

@item 
Creando @ref{2a7,,immutable types} con bases mutables (gh-95388@footnote{https://github.com/python/cpython/issues/95388}).

@item 
Functions to configure Python’s initialization, deprecated in Python 3.11:


@itemize *

@item 
@code{PySys_SetArgvEx()}:
Set @ref{4a4,,PyConfig.argv} instead.

@item 
@code{PySys_SetArgv()}:
Set @ref{4a4,,PyConfig.argv} instead.

@item 
@code{Py_SetProgramName()}:
Set @ref{4a5,,PyConfig.program_name} instead.

@item 
@code{Py_SetPythonHome()}:
Set @ref{286,,PyConfig.home} instead.
@end itemize

La API @ref{4a6,,Py_InitializeFromConfig()} debe usarse con @ref{499,,PyConfig} en su lugar.

@item 
Variables de configuración globales:


@itemize *

@item 
@ref{4a7,,Py_DebugFlag}:
Use @ref{4a8,,PyConfig.parser_debug} instead.

@item 
@ref{4a9,,Py_VerboseFlag}:
Use @ref{4aa,,PyConfig.verbose} instead.

@item 
@ref{4ab,,Py_QuietFlag}:
Use @ref{4ac,,PyConfig.quiet} instead.

@item 
@ref{4ad,,Py_InteractiveFlag}:
Use @ref{4ae,,PyConfig.interactive} instead.

@item 
@ref{4af,,Py_InspectFlag}:
Use @ref{4b0,,PyConfig.inspect} instead.

@item 
@ref{4b1,,Py_OptimizeFlag}:
Use @ref{4b2,,PyConfig.optimization_level} instead.

@item 
@ref{4b3,,Py_NoSiteFlag}:
Use @ref{4b4,,PyConfig.site_import} instead.

@item 
@ref{4b5,,Py_BytesWarningFlag}:
Use @ref{4b6,,PyConfig.bytes_warning} instead.

@item 
@ref{4b7,,Py_FrozenFlag}:
Use @ref{4b8,,PyConfig.pathconfig_warnings} instead.

@item 
@ref{4b9,,Py_IgnoreEnvironmentFlag}:
Use @ref{4ba,,PyConfig.use_environment} instead.

@item 
@ref{4bb,,Py_DontWriteBytecodeFlag}:
Use @ref{4bc,,PyConfig.write_bytecode} instead.

@item 
@ref{4bd,,Py_NoUserSiteDirectory}:
Use @ref{4be,,PyConfig.user_site_directory} instead.

@item 
@ref{4bf,,Py_UnbufferedStdioFlag}:
Use @ref{4c0,,PyConfig.buffered_stdio} instead.

@item 
@ref{4c1,,Py_HashRandomizationFlag}:
Use @ref{4c2,,PyConfig.use_hash_seed}
and @ref{4c3,,PyConfig.hash_seed} instead.

@item 
@ref{4c4,,Py_IsolatedFlag}:
Use @ref{4c5,,PyConfig.isolated} instead.

@item 
@ref{4c6,,Py_LegacyWindowsFSEncodingFlag}:
Use @ref{4c7,,PyPreConfig.legacy_windows_fs_encoding} instead.

@item 
@ref{4c8,,Py_LegacyWindowsStdioFlag}:
Use @ref{497,,PyConfig.legacy_windows_stdio} instead.

@item 
@code{Py_FileSystemDefaultEncoding}:
Use @ref{4c9,,PyConfig.filesystem_encoding} instead.

@item 
@code{Py_HasFileSystemDefaultEncoding}:
Use @ref{4c9,,PyConfig.filesystem_encoding} instead.

@item 
@code{Py_FileSystemDefaultEncodeErrors}:
Use @ref{4ca,,PyConfig.filesystem_errors} instead.

@item 
@code{Py_UTF8Mode}:
Use @ref{4cb,,PyPreConfig.utf8_mode} instead.
(see @ref{4cc,,Py_PreInitialize()})
@end itemize

La API @ref{4a6,,Py_InitializeFromConfig()} debe usarse con @ref{499,,PyConfig} en su lugar.
@end itemize

@node Pending removal in Python 3 15<6>,Pending removal in future versions<6>,Pending removal in Python 3 14<4>,Obsoleto<2>
@anchor{whatsnew/3 12 id8}@anchor{63a}
@subsubsection Pending removal in Python 3.15



@itemize *

@item 
The bundled copy of @code{libmpdecimal}.

@item 
The @ref{272,,PyImport_ImportModuleNoBlock()}:
Use @ref{273,,PyImport_ImportModule()} instead.

@item 
@ref{274,,PyWeakref_GetObject()} and @ref{275,,PyWeakref_GET_OBJECT()}:
Use @ref{276,,PyWeakref_GetRef()} instead.

@item 
@ref{277,,Py_UNICODE} type and the @code{Py_UNICODE_WIDE} macro:
Use @code{wchar_t} instead.

@item 
Funciones de inicialización de Python:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}:
Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@item 
@ref{27a,,Py_GetExecPrefix()}:
Get @ref{27b,,sys.base_exec_prefix} and @ref{27c,,sys.exec_prefix} instead.

@item 
@ref{27d,,Py_GetPath()}:
Get @ref{27e,,sys.path} instead.

@item 
@ref{27f,,Py_GetPrefix()}:
Get @ref{280,,sys.base_prefix} and @ref{281,,sys.prefix} instead.

@item 
@ref{282,,Py_GetProgramFullPath()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{284,,Py_GetProgramName()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{285,,Py_GetPythonHome()}:
Get @ref{286,,PyConfig.home}
or the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment variable instead.
@end itemize
@end itemize

@node Pending removal in future versions<6>,,Pending removal in Python 3 15<6>,Obsoleto<2>
@anchor{whatsnew/3 12 id9}@anchor{63b}
@subsubsection Pending removal in future versions


Las siguientes API están obsoletas y se eliminarán, aunque actualmente no hay una fecha programada para su eliminación.


@itemize *

@item 
@ref{289,,Py_TPFLAGS_HAVE_FINALIZE}:
Unneeded since Python 3.8.

@item 
@ref{28a,,PyErr_Fetch()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28c,,PyErr_NormalizeException()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28d,,PyErr_Restore()}:
Use @ref{28e,,PyErr_SetRaisedException()} instead.

@item 
@ref{28f,,PyModule_GetFilename()}:
Use @ref{290,,PyModule_GetFilenameObject()} instead.

@item 
@ref{291,,PyOS_AfterFork()}:
Use @ref{292,,PyOS_AfterFork_Child()} instead.

@item 
@ref{293,,PySlice_GetIndicesEx()}:
Use @ref{294,,PySlice_Unpack()} and @ref{295,,PySlice_AdjustIndices()} instead.

@item 
@code{PyUnicode_AsDecodedObject()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsDecodedUnicode()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsEncodedObject()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@code{PyUnicode_AsEncodedUnicode()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@ref{298,,PyUnicode_READY()}:
Unneeded since Python 3.12

@item 
@code{PyErr_Display()}:
Use @ref{299,,PyErr_DisplayException()} instead.

@item 
@code{_PyErr_ChainExceptions()}:
Use @code{_PyErr_ChainExceptions1()} instead.

@item 
@code{PyBytesObject.ob_shash} member:
call @ref{29a,,PyObject_Hash()} instead.

@item 
@code{PyDictObject.ma_version_tag} member.

@item 
API de almacenamiento local de subprocesos (TLS):


@itemize *

@item 
@ref{29b,,PyThread_create_key()}:
Use @ref{29c,,PyThread_tss_alloc()} instead.

@item 
@ref{29d,,PyThread_delete_key()}:
Use @ref{29e,,PyThread_tss_free()} instead.

@item 
@ref{29f,,PyThread_set_key_value()}:
Use @ref{2a0,,PyThread_tss_set()} instead.

@item 
@ref{2a1,,PyThread_get_key_value()}:
Use @ref{2a2,,PyThread_tss_get()} instead.

@item 
@ref{2a3,,PyThread_delete_key_value()}:
Use @ref{2a4,,PyThread_tss_delete()} instead.

@item 
@ref{2a5,,PyThread_ReInitTLS()}:
Unneeded since Python 3.7.
@end itemize
@end itemize

@node Eliminado<2>,,Obsoleto<2>,Cambios en la API de C
@anchor{whatsnew/3 12 id10}@anchor{63c}
@subsubsection Eliminado



@itemize *

@item 
Elimine el archivo de encabezado @code{token.h}. Nunca hubo ninguna API C de tokenizador público. El archivo de encabezado @code{token.h} solo fue diseñado para ser utilizado por componentes internos de Python. (Aportado por Victor Stinner en gh-92651@footnote{https://github.com/python/cpython/issues/92651}.)

@item 
Se han eliminado las API Unicode heredadas. Consulte 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} para obtener más detalles.


@itemize *

@item 
@code{PyUnicode_WCHAR_KIND}

@item 
@code{PyUnicode_AS_UNICODE()}

@item 
@code{PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_AsUnicodeAndSize()}

@item 
@code{PyUnicode_AS_DATA()}

@item 
@code{PyUnicode_FromUnicode()}

@item 
@code{PyUnicode_GET_SIZE()}

@item 
@code{PyUnicode_GetSize()}

@item 
@code{PyUnicode_GET_DATA_SIZE()}
@end itemize

@item 
Elimine la macro de función @code{PyUnicode_InternImmortal()}. (Aportado por Victor Stinner en gh-85858@footnote{https://github.com/python/cpython/issues/85858}.)
@end itemize

@node Qué hay de nuevo en Python 3 11,Qué hay de nuevo en Python 3 10,Novedades de Python 3 12,Qué hay de nuevo en Python
@anchor{whatsnew/3 11 doc}@anchor{63d}@anchor{whatsnew/3 11 what-s-new-in-python-3-11}@anchor{63e}
@section Qué hay de nuevo en Python 3.11


@*Editor: 
Pablo Galindo Salgado


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

Este artículo explica las nuevas características de Python 3.11, en comparación con 3.10. Python 3.11 se lanzó el 24 de octubre de 2022. Para obtener detalles completos, consulte @ref{13b,,changelog}.

@menu
* Resumen – Aspectos destacados de la versión:: 
* Nuevas características: Nuevas características<3>. 
* Nuevas funciones relacionadas con las sugerencias de tipo:: 
* Otros cambios de idioma:: 
* Otros cambios en la implementación de CPython:: 
* Nuevos Módulos:: 
* Módulos mejorados: Módulos mejorados<2>. 
* Optimizaciones: Optimizaciones<2>. 
* CPython más rápido:: 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<2>. 
* Obsoleto: Obsoleto<3>. 
* Eliminación pendiente en Python 3.12: Eliminación pendiente en Python 3 12. 
* Remoto:: 
* Migración a Python 3.11: Migración a Python 3 11. 
* Construir cambios:: 
* Cambios en la API de C: Cambios en la API de C<2>. 
* Notable changes in 3.11.4: Notable changes in 3 11 4. 
* Notable changes in 3.11.5: Notable changes in 3 11 5. 

@end menu

@node Resumen – Aspectos destacados de la versión,Nuevas características<3>,,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 summary-release-highlights}@anchor{63f}@anchor{whatsnew/3 11 whatsnew311-summary}@anchor{640}
@subsection Resumen – Aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.11.
@c Brevity is key.


@itemize *

@item 
Python 3.11 es entre un 10 y un 60 % más rápido que Python 3.10. En promedio, medimos un aumento de velocidad de 1.25x en el conjunto de pruebas de referencia estándar. Ver @ref{641,,CPython más rápido} para más detalles.
@end itemize

@c PEP-sized items next.

Nuevas funciones de sintaxis:


@itemize *

@item 
@ref{642,,PEP 654; Grupos de excepción y except*}
@end itemize

Nuevas funciones integradas:


@itemize *

@item 
@ref{643,,PEP 678; Las excepciones se pueden enriquecer con notas}
@end itemize

Nuevos módulos de biblioteca estándar:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/}: @ref{fc,,tomllib}: soporte para analizar TOML@footnote{https://toml.io/} en la biblioteca estándar
@end itemize

Mejoras en el intérprete:


@itemize *

@item 
@ref{644,,PEP 657; Ubicaciones de errores detallados en rastreos}

@item 
Nueva opción de línea de comando @ref{645,,-P} y variable de entorno 
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH} a @ref{647,,disable automatically prepending potentially unsafe paths} a @ref{27e,,sys.path}
@end itemize

Nuevas funciones de escritura:


@itemize *

@item 
@ref{648,,PEP 646; Genéricos Variádicos}

@item 
@ref{649,,PEP 655; Marcado de elementos TypedDict individuales como requeridos o no requeridos}

@item 
@ref{64a,,PEP 673; tipo Self}

@item 
@ref{64b,,PEP 675; tipo de cadena literal arbitraria}

@item 
@ref{64c,,PEP 681; Transformaciones de clases de datos}
@end itemize

Importantes depreciaciones, eliminaciones y restricciones:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: @ref{64d,,Many legacy standard library modules have been deprecated} y se eliminará en Python 3.13

@item 
@geindex Python Enhancement Proposals; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}:
@ref{64e,,Py_UNICODE encoder APIs have been removed}

@item 
@geindex Python Enhancement Proposals; PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/}:
@ref{64f,,Macros converted to static inline functions}
@end itemize

@node Nuevas características<3>,Nuevas funciones relacionadas con las sugerencias de tipo,Resumen – Aspectos destacados de la versión,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 new-features}@anchor{650}@anchor{whatsnew/3 11 whatsnew311-features}@anchor{651}
@subsection Nuevas características


@menu
* PEP 657; Ubicaciones de errores detallados en rastreos: PEP 657 Ubicaciones de errores detallados en rastreos. 
* PEP 654; Grupos de excepción y except*: PEP 654 Grupos de excepción y except*. 
* PEP 678; Las excepciones se pueden enriquecer con notas: PEP 678 Las excepciones se pueden enriquecer con notas. 
* Mejoras en el iniciador de Windows py.exe: Mejoras en el iniciador de Windows py exe. 

@end menu

@node PEP 657 Ubicaciones de errores detallados en rastreos,PEP 654 Grupos de excepción y except*,,Nuevas características<3>
@anchor{whatsnew/3 11 pep-657-fine-grained-error-locations-in-tracebacks}@anchor{652}@anchor{whatsnew/3 11 whatsnew311-pep657}@anchor{644}
@subsubsection PEP 657: Ubicaciones de errores detallados en rastreos


Al imprimir rastreos, el intérprete ahora señalará la expresión exacta que causó el error, en lugar de solo la línea. Por ejemplo:

@example
Traceback (most recent call last):
  File "distance.py", line 11, in <module>
    print(manhattan_distance(p1, p2))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "distance.py", line 6, in manhattan_distance
    return abs(point_1.x - point_2.x) + abs(point_1.y - point_2.y)
                           ^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'x'
@end example

Las versiones anteriores del intérprete apuntaban solo a la línea, por lo que resultaba ambiguo qué objeto era @code{None}. Estos errores mejorados también pueden ser útiles cuando se trata de objetos @ref{190,,dict} profundamente anidados y múltiples llamadas a funciones:

@example
Traceback (most recent call last):
  File "query.py", line 37, in <module>
    magic_arithmetic('foo')
  File "query.py", line 18, in magic_arithmetic
    return add_counts(x) / 25
           ^^^^^^^^^^^^^
  File "query.py", line 24, in add_counts
    return 25 + query_user(user1) + query_user(user2)
                ^^^^^^^^^^^^^^^^^
  File "query.py", line 32, in query_user
    return 1 + query_count(db, response['a']['b']['c']['user'], retry=True)
                               ~~~~~~~~~~~~~~~~~~^^^^^
TypeError: 'NoneType' object is not subscriptable
@end example

Además de expresiones aritméticas complejas:

@example
Traceback (most recent call last):
  File "calculation.py", line 54, in <module>
    result = (x / y / z) * (a / b / c)
              ~~~~~~^~~
ZeroDivisionError: division by zero
@end example

Además, la información utilizada por la función de rastreo mejorada está disponible a través de una API general, que se puede usar para correlacionar @ref{2f2,,bytecode} @ref{653,,instructions} con la ubicación del código fuente. Esta información se puede recuperar usando:


@itemize -

@item 
El método @ref{654,,codeobject.co_positions()} en Python.

@item 
La función @ref{655,,PyCode_Addr2Location()} en la API de C.
@end itemize

Ver 
@geindex Python Enhancement Proposals; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} para más detalles. (Aportado por Pablo Galindo, Batuhan Taskaya y Ammar Askar en bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}.)

@cartouche
@quotation Nota 
Esta característica requiere almacenar las posiciones de las columnas en @ref{656,,Objetos código}, lo que puede resultar en un pequeño aumento en el uso de la memoria del intérprete y el uso del disco para los archivos de Python compilados. Para evitar almacenar la información adicional y desactivar la impresión de la información de seguimiento adicional, utilice la opción de línea de comando @ref{2e2,,-X no_debug_ranges} o la variable de entorno 
@geindex PYTHONNODEBUGRANGES
@geindex variables de entorno; PYTHONNODEBUGRANGES
@ref{657,,PYTHONNODEBUGRANGES}.
@end quotation
@end cartouche

@node PEP 654 Grupos de excepción y except*,PEP 678 Las excepciones se pueden enriquecer con notas,PEP 657 Ubicaciones de errores detallados en rastreos,Nuevas características<3>
@anchor{whatsnew/3 11 pep-654-exception-groups-and-except}@anchor{658}@anchor{whatsnew/3 11 whatsnew311-pep654}@anchor{642}
@subsubsection PEP 654: Grupos de excepción y @code{except*}


@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} presenta funciones de lenguaje que permiten que un programa genere y maneje múltiples excepciones no relacionadas simultáneamente. Los tipos integrados @ref{31d,,ExceptionGroup} y @ref{3b6,,BaseExceptionGroup} permiten agrupar excepciones y generarlas juntas, y la nueva sintaxis @ref{659,,except*} generaliza @ref{2f6,,except} para hacer coincidir subgrupos de grupos de excepciones.

Ver 
@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} para más detalles.

(Aportado por Irit Katriel en bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}. PEP escrito por Irit Katriel, Yury Selivanov y Guido van Rossum.)

@node PEP 678 Las excepciones se pueden enriquecer con notas,Mejoras en el iniciador de Windows py exe,PEP 654 Grupos de excepción y except*,Nuevas características<3>
@anchor{whatsnew/3 11 pep-678-exceptions-can-be-enriched-with-notes}@anchor{65a}@anchor{whatsnew/3 11 whatsnew311-pep678}@anchor{643}
@subsubsection PEP 678: Las excepciones se pueden enriquecer con notas


El método @ref{65b,,add_note()} se agrega a @ref{65c,,BaseException}. Se puede utilizar para enriquecer las excepciones con información de contexto que no está disponible en el momento en que se genera la excepción. Las notas añadidas aparecen en el rastreo predeterminado.

Ver 
@geindex Python Enhancement Proposals; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} para más detalles.

(Aportado por Irit Katriel en bpo-45607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45607}. PEP escrito por Zac Hatfield-Dodds).

@node Mejoras en el iniciador de Windows py exe,,PEP 678 Las excepciones se pueden enriquecer con notas,Nuevas características<3>
@anchor{whatsnew/3 11 whatsnew311-windows-launcher}@anchor{65d}@anchor{whatsnew/3 11 windows-py-exe-launcher-improvements}@anchor{65e}
@subsubsection Mejoras en el iniciador de Windows @code{py.exe}


La copia del @ref{65f,,Lanzador de Python para Windows} incluida con Python 3.11 se ha actualizado significativamente. Ahora admite la sintaxis de empresa/etiqueta tal como se define en 
@geindex Python Enhancement Proposals; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} usando el argumento @code{-V:@var{<company>}/@var{<tag>}} en lugar del limitado @code{-@var{<major>}.@var{< menor>}}. Esto permite iniciar distribuciones distintas a @code{PythonCore}, la alojada en python.org@footnote{https://www.python.org}.

Al usar los selectores @code{-V:}, se puede omitir la empresa o la etiqueta, pero se buscarán todas las instalaciones. Por ejemplo, @code{-V:OtherPython/} seleccionará la «mejor» etiqueta registrada para @code{OtherPython}, mientras que @code{-V:3.11} o @code{-V:/3.11} seleccionarán la «mejor» distribución con la etiqueta @code{3.11}.

Cuando se utilizan los argumentos obsoletos @code{-@var{<principal>}}, @code{-@var{<principal>}.@var{<menor>}}, @code{-@var{<principal>}-@var{<bitness>} ` o :samp:}-@{<principal>@}.@{<menor>@}-@{<bitness>@}`, se debe conservar todo el comportamiento existente de las versiones anteriores y solo se seleccionarán las versiones de @code{PythonCore}. Sin embargo, el sufijo @code{-64} ahora implica «no de 32 bits» (no necesariamente x86-64), ya que existen múltiples plataformas de 64 bits compatibles. Los tiempos de ejecución de 32 bits se detectan comprobando la etiqueta del tiempo de ejecución en busca de un sufijo @code{-32}. Todas las versiones de Python desde la 3.5 han incluido esto en sus versiones de 32 bits.
@anchor{whatsnew/3 11 new-feat-related-type-hints-311}@anchor{660}
@node Nuevas funciones relacionadas con las sugerencias de tipo,Otros cambios de idioma,Nuevas características<3>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 new-features-related-to-type-hints}@anchor{661}@anchor{whatsnew/3 11 whatsnew311-typing-features}@anchor{662}
@subsection Nuevas funciones relacionadas con las sugerencias de tipo


Esta sección cubre los cambios principales que afectan las sugerencias de tipo 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} y el módulo @ref{104,,typing}.

@menu
* PEP 646; Genéricos Variádicos: PEP 646 Genéricos Variádicos. 
* PEP 655; Marcado de elementos TypedDict individuales como requeridos o no requeridos: PEP 655 Marcado de elementos TypedDict individuales como requeridos o no requeridos. 
* PEP 673; tipo Self: PEP 673 tipo Self. 
* PEP 675; tipo de cadena literal arbitraria: PEP 675 tipo de cadena literal arbitraria. 
* PEP 681; Transformaciones de clases de datos: PEP 681 Transformaciones de clases de datos. 
* PEP 563 puede no ser el futuro:: 

@end menu

@node PEP 646 Genéricos Variádicos,PEP 655 Marcado de elementos TypedDict individuales como requeridos o no requeridos,,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-646-variadic-generics}@anchor{663}@anchor{whatsnew/3 11 whatsnew311-pep646}@anchor{648}
@subsubsection PEP 646: Genéricos Variádicos


@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introdujo anteriormente @ref{2c9,,TypeVar}, lo que permite la creación de genéricos parametrizados con un solo tipo. 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} añade @ref{2cb,,TypeVarTuple}, permitiendo la parametrización con un número de tipos `arbitrary'. En otras palabras, un @ref{2cb,,TypeVarTuple} es una variable de tipo `variadic' que permite los genéricos `variadic'.

Esto permite una amplia variedad de casos de uso. En particular, permite parametrizar con el arreglo `shape' el tipo de estructuras similares a arreglos en bibliotecas de computación numérica como NumPy y TensorFlow. Los verificadores de tipo estático ahora podrán detectar errores relacionados con la forma en el código que usa estas bibliotecas.

Ver 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} para más detalles.

(Contribuido por Matthew Rahtz en bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}, con contribuciones de Serhiy Storchaka y Jelle Zijlstra. PEP escrito por Mark Mendoza, Matthew Rahtz, Pradeep Kumar Srinivasan y Vincent Siles).

@node PEP 655 Marcado de elementos TypedDict individuales como requeridos o no requeridos,PEP 673 tipo Self,PEP 646 Genéricos Variádicos,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-655-marking-individual-typeddict-items-as-required-or-not-required}@anchor{664}@anchor{whatsnew/3 11 whatsnew311-pep655}@anchor{649}
@subsubsection PEP 655: Marcado de elementos @code{TypedDict} individuales como requeridos o no requeridos


@ref{665,,Required} y @ref{666,,NotRequired} proporcionan una forma sencilla de marcar si deben estar presentes elementos individuales en un @ref{2ce,,TypedDict}. Anteriormente, esto solo era posible mediante la herencia.

Todos los campos siguen siendo obligatorios de forma predeterminada, a menos que el parámetro `total' se establezca en @code{False}, en cuyo caso todos los campos siguen sin ser obligatorios de forma predeterminada. Por ejemplo, lo siguiente especifica un @code{TypedDict} con una clave requerida y una no requerida:

@example
class Movie(TypedDict):
   title: str
   year: NotRequired[int]

m1: Movie = @{"title": "Black Panther", "year": 2018@}  # OK
m2: Movie = @{"title": "Star Wars"@}  # OK (year is not required)
m3: Movie = @{"year": 2022@}  # ERROR (missing required field title)
@end example

La siguiente definición es equivalente:

@example
class Movie(TypedDict, total=False):
   title: Required[str]
   year: int
@end example

Ver 
@geindex Python Enhancement Proposals; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} para más detalles.

(Aportado por David Foster y Jelle Zijlstra en bpo-47087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47087}. PEP escrito por David Foster).

@node PEP 673 tipo Self,PEP 675 tipo de cadena literal arbitraria,PEP 655 Marcado de elementos TypedDict individuales como requeridos o no requeridos,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-673-self-type}@anchor{667}@anchor{whatsnew/3 11 whatsnew311-pep673}@anchor{64a}
@subsubsection PEP 673: tipo @code{Self}


La nueva anotación @ref{668,,Self} proporciona una forma sencilla e intuitiva de anotar métodos que devuelven una instancia de su clase. Se comporta igual que el enfoque 
@geindex Python Enhancement Proposals; PEP 484#annotating-instance-and-class-methods
specified in PEP 484@footnote{https://peps.python.org/pep-0484/#annotating-instance-and-class-methods} basado en @ref{2c9,,TypeVar}, pero es más conciso y más fácil de seguir.

Los casos de uso comunes incluyen constructores alternativos proporcionados como @ref{2d2,,classmethod}s y métodos @ref{669,,__enter__()} que devuelven @code{self}:

@example
class MyLock:
    def __enter__(self) -> Self:
        self.lock()
        return self

    ...

class MyInt:
    @@classmethod
    def fromhex(cls, s: str) -> Self:
        return cls(int(s, 16))

    ...
@end example

@ref{668,,Self} también se puede usar para anotar parámetros de método o atributos del mismo tipo que su clase envolvente.

Ver 
@geindex Python Enhancement Proposals; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} para más detalles.

(Aportado por James Hilton-Balfe en bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534}. PEP escrito por Pradeep Kumar Srinivasan y James Hilton-Balfe).

@node PEP 675 tipo de cadena literal arbitraria,PEP 681 Transformaciones de clases de datos,PEP 673 tipo Self,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-675-arbitrary-literal-string-type}@anchor{66a}@anchor{whatsnew/3 11 whatsnew311-pep675}@anchor{64b}
@subsubsection PEP 675: tipo de cadena literal arbitraria


La nueva anotación @ref{66b,,LiteralString} se puede usar para indicar que un parámetro de función puede ser de cualquier tipo de cadena literal. Esto permite que una función acepte tipos de cadenas literales arbitrarias, así como cadenas creadas a partir de otras cadenas literales. Los verificadores de tipos pueden hacer cumplir que las funciones confidenciales, como las que ejecutan declaraciones SQL o comandos de shell, se llamen solo con argumentos estáticos, lo que brinda protección contra ataques de inyección.

Por ejemplo, una función de consulta SQL podría anotarse de la siguiente manera:

@example
def run_query(sql: LiteralString) -> ...
    ...

def caller(
    arbitrary_string: str,
    query_string: LiteralString,
    table_name: LiteralString,
) -> None:
    run_query("SELECT * FROM students")       # ok
    run_query(query_string)                   # ok
    run_query("SELECT * FROM " + table_name)  # ok
    run_query(arbitrary_string)               # type checker error
    run_query(                                # type checker error
        f"SELECT * FROM students WHERE name = @{arbitrary_string@}"
    )
@end example

Ver 
@geindex Python Enhancement Proposals; PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} para más detalles.

(Aportado por Jelle Zijlstra en bpo-47088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47088}. PEP escrito por Pradeep Kumar Srinivasan y Graham Bleaney).

@node PEP 681 Transformaciones de clases de datos,PEP 563 puede no ser el futuro,PEP 675 tipo de cadena literal arbitraria,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-681-data-class-transforms}@anchor{66c}@anchor{whatsnew/3 11 whatsnew311-pep681}@anchor{64c}
@subsubsection PEP 681: Transformaciones de clases de datos


@ref{57b,,dataclass_transform} se puede usar para decorar una clase, una metaclase o una función que en sí misma es un decorador. La presencia de @code{@@dataclass_transform()} le dice a un verificador de tipo estático que el objeto decorado realiza una «magia» en tiempo de ejecución que transforma una clase, dándole comportamientos similares a @ref{32e,,dataclass}.

Por ejemplo:

@example
# The create_model decorator is defined by a library.
@@typing.dataclass_transform()
def create_model(cls: Type[T]) -> Type[T]:
    cls.__init__ = ...
    cls.__eq__ = ...
    cls.__ne__ = ...
    return cls

# The create_model decorator can now be used to create new model classes:
@@create_model
class CustomerModel:
    id: int
    name: str

c = CustomerModel(id=327, name="Eric Idle")
@end example

Ver 
@geindex Python Enhancement Proposals; PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/} para más detalles.

(Aportado por Jelle Zijlstra en gh-91860@footnote{https://github.com/python/cpython/issues/91860}. PEP escrito por Erik De Bonte y Eric Traut.)

@node PEP 563 puede no ser el futuro,,PEP 681 Transformaciones de clases de datos,Nuevas funciones relacionadas con las sugerencias de tipo
@anchor{whatsnew/3 11 pep-563-may-not-be-the-future}@anchor{66d}@anchor{whatsnew/3 11 whatsnew311-pep563-deferred}@anchor{66e}
@subsubsection PEP 563 puede no ser el futuro


@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} Evaluación pospuesta de anotaciones (@code{from __future__ import annotations} @ref{2f4,,future statement}) que originalmente se planeó para su lanzamiento en Python 3.10 se suspendió indefinidamente. Consulte this message from the Steering Council@footnote{https://mail.python.org/archives/list/python-dev@@python.org/message/VIZEBX5EYMSYIJNDBF6DMUMZOCWHARSO/} para obtener más información.

@node Otros cambios de idioma,Otros cambios en la implementación de CPython,Nuevas funciones relacionadas con las sugerencias de tipo,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 other-language-changes}@anchor{66f}@anchor{whatsnew/3 11 whatsnew311-other-lang-changes}@anchor{670}
@subsection Otros cambios de idioma



@itemize *

@item 
Las expresiones de desempaquetado destacadas ahora se pueden usar en declaraciones @ref{1eb,,for}. (Consulte bpo-46725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46725} para obtener más detalles).

@item 
Ahora se permiten @ref{671,,comprehensions} asincrónicos dentro de las comprensiones en @ref{672,,asynchronous functions}. Las comprensiones externas implícitamente se vuelven asincrónicas en este caso. (Aportado por Serhiy Storchaka en bpo-33346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33346}.)

@item 
Ahora se genera un @ref{228,,TypeError} en lugar de un @ref{441,,AttributeError} en declaraciones @ref{673,,with} y @ref{674,,contextlib.ExitStack.enter_context()} para objetos que no admiten el protocolo @ref{675,,context manager}, y en declaraciones @ref{676,,async with} y @ref{677,,contextlib.AsyncExitStack.enter_async_context()} para objetos que no admiten el protocolo @ref{678,,asynchronous context manager}. (Aportado por Serhiy Storchaka en bpo-12022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12022} y bpo-44471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44471}).

@item 
Se agregó @ref{679,,object.__getstate__()}, que proporciona la implementación predeterminada del método @code{__getstate__()}. @ref{26,,copy}ando y @ref{a6,,pickle}ando instancias de subclases de tipos integrados @ref{5e0,,bytearray}, @ref{67a,,set}, @ref{67b,,frozenset}, @ref{67c,,collections.OrderedDict}, @ref{67d,,collections.deque}, @ref{67e,,weakref.WeakSet} y @ref{67f,,datetime.tzinfo} ahora copian y seleccionan atributos de instancia implementados como @ref{680,,slots}. Este cambio tiene un efecto secundario no deseado: hace fallar a una pequeña minoría de proyectos Python existentes que no esperaban que existiera @ref{679,,object.__getstate__()}. Consulte los comentarios posteriores sobre gh-70766@footnote{https://github.com/python/cpython/issues/70766} para obtener información sobre las soluciones alternativas que dicho código puede necesitar. (Aportado por Serhiy Storchaka en bpo-26579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26579}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pythonsafepath}@anchor{647}

@itemize *

@item 
Se agregó una opción de línea de comando @ref{645,,-P} y una variable de entorno 
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH}, que deshabilitan la anteposición automática a @ref{27e,,sys.path} del directorio del script cuando se ejecuta un script, o el directorio actual cuando se usa @ref{681,,-c} y @ref{187,,-m}. Esto garantiza que @ref{682,,import} solo recopile la biblioteca estándar y los módulos instalados, y evita el remedo involuntario o malicioso de los módulos con los de un directorio local (y normalmente el usuario puede escribir). (Aportado por Victor Stinner en gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)

@item 
Se agregó una opción @code{"z"} a @ref{347,,Especificación de formato Mini-Lenguaje} que cambia negativo a cero positivo después de redondear a la precisión del formato. Ver 
@geindex Python Enhancement Proposals; PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/} para más detalles. (Aportado por John Belmonte en gh-90153@footnote{https://github.com/python/cpython/issues/90153}.)

@item 
Ya no se aceptan bytes en @ref{27e,,sys.path}. El soporte se interrumpió en algún momento entre Python 3.2 y 3.6, y nadie se dio cuenta hasta después del lanzamiento de Python 3.10.0. Además, recuperar la compatibilidad sería problemático debido a las interacciones entre @ref{683,,-b} y @ref{684,,sys.path_importer_cache} cuando hay una combinación de claves @ref{237,,str} y @ref{325,,bytes}. (Aportado por Thomas Grainger en gh-91181@footnote{https://github.com/python/cpython/issues/91181}.)
@end itemize

@node Otros cambios en la implementación de CPython,Nuevos Módulos,Otros cambios de idioma,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 other-cpython-implementation-changes}@anchor{685}@anchor{whatsnew/3 11 whatsnew311-other-implementation-changes}@anchor{686}
@subsection Otros cambios en la implementación de CPython



@itemize *

@item 
Los métodos especiales @ref{687,,__complex__()} para @ref{154,,complex} y @ref{688,,__bytes__()} para @ref{325,,bytes} se implementan para admitir los protocolos @ref{689,,typing.SupportsComplex} y @ref{68a,,typing.SupportsBytes}. (Contribución de Mark Dickinson y Donghee Na en bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}).

@item 
@code{siphash13} se agrega como un nuevo algoritmo hash interno. Tiene propiedades de seguridad similares a @code{siphash24}, pero es un poco más rápido para entradas largas. @ref{237,,str}, @ref{325,,bytes} y algunos otros tipos ahora lo usan como algoritmo predeterminado para @ref{68b,,hash()}. 
@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} @ref{68c,,hash-based .pyc files} ahora también usa @code{siphash13}. (Aportado por Inada Naoki en bpo-29410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29410}.)

@item 
Cuando una declaración @ref{68d,,raise} sin parámetros vuelve a generar una excepción activa, el rastreo adjunto a esta excepción ahora siempre es @code{sys.exc_info()[1].__traceback__}. Esto significa que los cambios realizados en el rastreo en la cláusula @ref{2f6,,except} actual se reflejan en la excepción que se ha vuelto a generar. (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
La representación del estado del intérprete de las excepciones manejadas (también conocido como @code{exc_info} o @code{_PyErr_StackItem}) ahora solo tiene el campo @code{exc_value}; Se han eliminado @code{exc_type} y @code{exc_traceback}, ya que se pueden derivar de @code{exc_value}. (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
Se ha agregado un nuevo @ref{68e,,command line option}, @code{AppendPath}, para el instalador de Windows. Se comporta de manera similar a @code{PrependPath}, pero agrega los directorios de instalación y scripts en lugar de anteponerlos. (Aportado por Bastian Neuburger en bpo-44934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44934}.)

@item 
El campo @ref{68f,,PyConfig.module_search_paths_set} ahora debe establecerse en @code{1} para que la inicialización use @ref{495,,PyConfig.module_search_paths} para inicializar @ref{27e,,sys.path}. De lo contrario, la inicialización volverá a calcular la ruta y reemplazará los valores agregados a @code{module_search_paths}.

@item 
La salida de la opción @ref{690,,--help} ahora cabe en 50 líneas/80 columnas. La información sobre las opciones @ref{691,,Python environment variables} y @ref{2e2,,-X} ahora está disponible utilizando los indicadores respectivos @ref{692,,--help-env} y @ref{693,,--help-xoptions}, y con el nuevo @ref{694,,--help-all}. (Contribución de Éric Araujo en bpo-46142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46142}.)

@item 
Converting between @ref{1f0,,int} and @ref{237,,str} in bases other than 2
(binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal)
now raises a @ref{360,,ValueError} if the number of digits in string form is
above a limit to avoid potential denial of service attacks due to the
algorithmic complexity. This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.
This limit can be configured or disabled by environment variable, command
line flag, or @ref{d9,,sys} APIs. See the @ref{695,,integer string conversion length limitation} documentation.  The default limit
is 4300 digits in string form.
@end itemize

@node Nuevos Módulos,Módulos mejorados<2>,Otros cambios en la implementación de CPython,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 new-modules}@anchor{696}@anchor{whatsnew/3 11 whatsnew311-new-modules}@anchor{697}
@subsection Nuevos Módulos



@itemize *

@item 
@ref{fc,,tomllib}: para analizar TOML@footnote{https://toml.io/}. Ver 
@geindex Python Enhancement Proposals; PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/} para más detalles. (Aportado por Taneli Hukkinen en bpo-40059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40059}.)

@item 
@ref{11c,,wsgiref.types}: tipos específicos de 
@geindex Python Enhancement Proposals; PEP 3333
WSGI@footnote{https://peps.python.org/pep-3333/} para la comprobación de tipos estáticos. (Aportado por Sebastian Rittau en bpo-42012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42012}.)
@end itemize

@node Módulos mejorados<2>,Optimizaciones<2>,Nuevos Módulos,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 improved-modules}@anchor{698}@anchor{whatsnew/3 11 whatsnew311-improved-modules}@anchor{699}
@subsection Módulos mejorados


@menu
* asíncio:: 
* contextlib:: 
* clases de datos:: 
* fecha y hora:: 
* enumeración:: 
* fcntl:: 
* fracciones:: 
* herramientas funcionales:: 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE y libre de inactividad:: 
* inspeccionar:: 
* lugar:: 
* Inicio sesión:: 
* Matemáticas:: 
* operador:: 
* sistema operativo:: 
* rutalib:: 
* re: re<3>. 
* cerrar:: 
* enchufe:: 
* sqlite3: sqlite3<5>. 
* cuerda:: 
* sistema:: 
* configuración del sistema:: 
* archivo temporal:: 
* enhebrar:: 
* tiempo:: 
* tkinter: tkinter<3>. 
* rastrear:: 
* mecanografía:: 
* unicodedata: unicodedata<4>. 
* prueba de unidad:: 
* venv: venv<2>. 
* advertencias:: 
* archivo zip:: 

@end menu

@node asíncio,contextlib,,Módulos mejorados<2>
@anchor{whatsnew/3 11 asyncio}@anchor{69a}@anchor{whatsnew/3 11 whatsnew311-asyncio}@anchor{69b}
@subsubsection asíncio



@itemize *

@item 
Se agregó la clase @ref{31c,,TaskGroup}, un @ref{69c,,asynchronous context manager} que contiene un grupo de tareas que las esperará a todas al salir. Para código nuevo, se recomienda usar @ref{69d,,create_task()} y @ref{69e,,gather()} directamente. (Aportado por Yury Selivanov y otros en gh-90908@footnote{https://github.com/python/cpython/issues/90908}.)

@item 
Se agregó @ref{69f,,timeout()}, un administrador de contexto asíncrono para establecer un tiempo de espera en operaciones asíncronas. Para código nuevo, se recomienda usar @ref{6a0,,wait_for()} directamente. (Aportado por Andrew Svetlov en gh-90927@footnote{https://github.com/python/cpython/issues/90927}.)

@item 
Se agregó la clase @ref{6a1,,Runner}, que expone la maquinaria utilizada por @ref{525,,run()}. (Aportado por Andrew Svetlov en gh-91218@footnote{https://github.com/python/cpython/issues/91218}.)

@item 
Se agregó la clase @ref{6a2,,Barrier} a las primitivas de sincronización en la biblioteca asyncio y la excepción @ref{6a3,,BrokenBarrierError} relacionada. (Aportado por Yves Duprat y Andrew Svetlov en gh-87518@footnote{https://github.com/python/cpython/issues/87518}.)

@item 
Se agregó el argumento de palabra clave `all_errors' a @ref{6a4,,asyncio.loop.create_connection()} para que se puedan generar varios errores de conexión como @ref{31d,,ExceptionGroup}.

@item 
Se agregó el método @ref{6a5,,asyncio.StreamWriter.start_tls()} para actualizar las conexiones basadas en secuencias existentes a TLS. (Aportado por Ian Good en bpo-34975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34975}.)

@item 
Se agregaron funciones de socket de datagrama sin formato al bucle de eventos: @ref{6a6,,sock_sendto()}, @ref{6a7,,sock_recvfrom()} y @ref{6a8,,sock_recvfrom_into()}. Estos tienen implementaciones en @ref{6a9,,SelectorEventLoop} y @ref{6aa,,ProactorEventLoop}. (Aportado por Alex Grönholm en bpo-46805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46805}.)

@item 
Se agregaron los métodos @ref{320,,cancelling()} y @ref{321,,uncancel()} a @ref{580,,Task}. Estos están destinados principalmente para uso interno, en particular por @ref{31c,,TaskGroup}.
@end itemize

@node contextlib,clases de datos,asíncio,Módulos mejorados<2>
@anchor{whatsnew/3 11 contextlib}@anchor{6ab}@anchor{whatsnew/3 11 whatsnew311-contextlib}@anchor{6ac}
@subsubsection contextlib



@itemize *

@item 
Se agregó un administrador de contexto @ref{6ad,,chdir()} no seguro en paralelo para cambiar el directorio de trabajo actual y luego restaurarlo al salir. Envoltorio simple alrededor de @ref{6ae,,chdir()}. (Aportación de Filipe Laíns en bpo-25625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25625})
@end itemize

@node clases de datos,fecha y hora,contextlib,Módulos mejorados<2>
@anchor{whatsnew/3 11 dataclasses}@anchor{6af}@anchor{whatsnew/3 11 whatsnew311-dataclasses}@anchor{6b0}
@subsubsection clases de datos



@itemize *

@item 
Cambie la verificación de mutabilidad predeterminada del campo, permitiendo solo los valores predeterminados que son @ref{6b1,,hashable} en lugar de cualquier objeto que no sea una instancia de @ref{190,,dict}, @ref{18e,,list} o @ref{67a,,set}. (Aportado por Eric V. Smith en bpo-44674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44674}.)
@end itemize

@node fecha y hora,enumeración,clases de datos,Módulos mejorados<2>
@anchor{whatsnew/3 11 datetime}@anchor{6b2}@anchor{whatsnew/3 11 whatsnew311-datetime}@anchor{6b3}
@subsubsection fecha y hora



@itemize *

@item 
Agregue @ref{594,,datetime.UTC}, un alias conveniente para @ref{6b4,,datetime.timezone.utc}. (Aportado por Kabir Kwatra en gh-91973@footnote{https://github.com/python/cpython/issues/91973}.)

@item 
@ref{6b5,,datetime.date.fromisoformat()}, @ref{6b6,,datetime.time.fromisoformat()} y @ref{6b7,,datetime.datetime.fromisoformat()} ahora se pueden usar para analizar la mayoría de los formatos ISO 8601 (excepto aquellos que admiten fracciones de horas y minutos). (Aportado por Paul Ganssle en gh-80010@footnote{https://github.com/python/cpython/issues/80010}.)
@end itemize

@node enumeración,fcntl,fecha y hora,Módulos mejorados<2>
@anchor{whatsnew/3 11 enum}@anchor{6b8}@anchor{whatsnew/3 11 whatsnew311-enum}@anchor{6b9}
@subsubsection enumeración



@itemize *

@item 
Cambió el nombre de @code{EnumMeta} a @ref{6ba,,EnumType} (@code{EnumMeta} se mantuvo como un alias).

@item 
Se agregó @ref{6bb,,StrEnum}, con miembros que se pueden usar como (y deben ser) cadenas.

@item 
Se agregó @ref{6bc,,ReprEnum}, que solo modifica el @ref{6bd,,__repr__()} de los miembros mientras devuelve sus valores literales (en lugar de nombres) para @ref{6be,,__str__()} y @ref{6bf,,__format__()} (utilizados por @ref{237,,str()}, @ref{6c0,,format()} y @ref{4e4,,f-string}s).

@item 
Changed @ref{6c1,,Enum.__format__()} (the default for
@ref{6c0,,format()}, @ref{6c2,,str.format()} and @ref{4e4,,f-string}s) to always produce
the same result as @ref{6c3,,Enum.__str__()}:  for enums inheriting from
@ref{6bc,,ReprEnum} it will be the member’s value; for all other enums
it will be the enum and member name (e.g. @code{Color.RED}).

@item 
Se agregó un nuevo parámetro de clase `boundary' a las enumeraciones @ref{6c4,,Flag} y la enumeración @ref{6c5,,FlagBoundary} con sus opciones, para controlar cómo manejar los valores de marca fuera de rango.

@item 
Se agregó el decorador de enumeración @ref{6c6,,verify()} y la enumeración @ref{6c7,,EnumCheck} con sus opciones, para verificar las clases de enumeración contra varias restricciones específicas.

@item 
Se agregaron los decoradores @ref{6c8,,member()} y @ref{6c9,,nonmember()} para garantizar que el objeto decorado no se convierta en un miembro de enumeración.

@item 
Se agregó el decorador @ref{6ca,,property()}, que funciona como @ref{2fd,,property()} excepto para las enumeraciones. Use esto en lugar de @ref{6cb,,types.DynamicClassAttribute()}.

@item 
Se agregó el decorador de enumeración @ref{6cc,,global_enum()}, que ajusta @ref{6bd,,__repr__()} y @ref{6be,,__str__()} para mostrar valores como miembros de su módulo en lugar de la clase de enumeración. Por ejemplo, @code{'re.ASCII'} para el miembro @ref{6cd,,ASCII} de @ref{6ce,,re.RegexFlag} en lugar de @code{'RegexFlag.ASCII'}.

@item 
@ref{6c4,,Flag} mejorado para admitir @ref{6cf,,len()}, iteración y @ref{1ed,,in}/@ref{6d0,,not in} en sus miembros. Por ejemplo, ahora funciona lo siguiente: @code{len(AFlag(3)) == 2 and list(AFlag(3)) == (AFlag.ONE, AFlag.TWO)}

@item 
Se cambiaron @ref{6d1,,Enum} y @ref{6c4,,Flag} para que los miembros ahora se definan antes de llamar a @ref{6d2,,__init_subclass__()}; @ref{6d3,,dir()} ahora incluye métodos, etc., de tipos de datos combinados.

@item 
Se modificó @ref{6c4,,Flag} para considerar solo los valores primarios (potencia de dos) canónicos, mientras que los valores compuestos (@code{3}, @code{6}, @code{10}, etc.) se consideran alias; las banderas invertidas son forzadas a su equivalente positivo.
@end itemize

@node fcntl,fracciones,enumeración,Módulos mejorados<2>
@anchor{whatsnew/3 11 fcntl}@anchor{6d4}@anchor{whatsnew/3 11 whatsnew311-fcntl}@anchor{6d5}
@subsubsection fcntl



@itemize *

@item 
En FreeBSD, se admiten los indicadores @code{F_DUP2FD} y @code{F_DUP2FD_CLOEXEC} respectivamente; el primero equivale al uso de @code{dup2}, mientras que el segundo establece además el indicador @code{FD_CLOEXEC}.
@end itemize

@node fracciones,herramientas funcionales,fcntl,Módulos mejorados<2>
@anchor{whatsnew/3 11 fractions}@anchor{6d6}@anchor{whatsnew/3 11 whatsnew311-fractions}@anchor{6d7}
@subsubsection fracciones



@itemize *

@item 
Compatibilidad con la inicialización al estilo 
@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} de @ref{177,,Fraction} desde una cadena. (Aportado por Sergey B Kirpichev en bpo-44258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44258}.)

@item 
@ref{177,,Fraction} ahora implementa un método @code{__int__}, de modo que pasa una verificación @code{isinstance(some_fraction, typing.SupportsInt)}. (Contribuido por Mark Dickinson en bpo-44547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44547}.)
@end itemize

@node herramientas funcionales,gzip<2>,fracciones,Módulos mejorados<2>
@anchor{whatsnew/3 11 functools}@anchor{6d8}@anchor{whatsnew/3 11 whatsnew311-functools}@anchor{6d9}
@subsubsection herramientas funcionales



@itemize *

@item 
@ref{6da,,functools.singledispatch()} ahora admite @ref{6db,,types.UnionType} y @ref{6dc,,typing.Union} como anotaciones en el argumento de envío.:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)
...
>>> @@fun.register
... def _(arg: int | float, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> from typing import Union
>>> @@fun.register
... def _(arg: Union[list, set], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
...
@end example

(Aportado por Yurii Karabas en bpo-46014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46014}.)
@end itemize

@node gzip<2>,hashlib<2>,herramientas funcionales,Módulos mejorados<2>
@anchor{whatsnew/3 11 gzip}@anchor{6dd}@anchor{whatsnew/3 11 whatsnew311-gzip}@anchor{6de}
@subsubsection gzip



@itemize *

@item 
The @ref{6df,,gzip.compress()} function is now faster when used with the
`mtime=0' argument as it delegates the compression entirely to a single
@ref{6e0,,zlib.compress()} operation. There is one side effect of this change: The
gzip file header contains an «OS» byte in its header. That was traditionally
always set to a value of 255 representing «unknown» by the @ref{67,,gzip}
module. Now, when using @ref{6df,,compress()} with `mtime=0', it may be
set to a different value by the underlying zlib C library Python was linked
against.
(See gh-112346@footnote{https://github.com/python/cpython/issues/112346} for details on the side effect.)
@end itemize

@node hashlib<2>,IDLE y libre de inactividad,gzip<2>,Módulos mejorados<2>
@anchor{whatsnew/3 11 hashlib}@anchor{6e1}@anchor{whatsnew/3 11 whatsnew311-hashlib}@anchor{6e2}
@subsubsection hashlib



@itemize *

@item 
@ref{6e3,,hashlib.blake2b()} y @ref{6e4,,hashlib.blake2s()} ahora prefieren libb2@footnote{https://www.blake2.net/} a la copia proporcionada por Python. (Aportado por Christian Heimes en bpo-47095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47095}.)

@item 
El módulo interno @code{_sha3} con algoritmos SHA3 y SHAKE ahora usa `tiny_sha3' en lugar de `Keccak Code Package' para reducir el código y el tamaño binario. El módulo @ref{68,,hashlib} prefiere implementaciones SHA3 y SHAKE optimizadas de OpenSSL. El cambio afecta solo a las instalaciones sin compatibilidad con OpenSSL. (Aportado por Christian Heimes en bpo-47098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47098}.)

@item 
Agregue @ref{6e5,,hashlib.file_digest()}, una función de ayuda para el hash eficiente de archivos u objetos similares a archivos. (Aportado por Christian Heimes en gh-89313@footnote{https://github.com/python/cpython/issues/89313}.)
@end itemize

@node IDLE y libre de inactividad,inspeccionar,hashlib<2>,Módulos mejorados<2>
@anchor{whatsnew/3 11 idle-and-idlelib}@anchor{6e6}@anchor{whatsnew/3 11 whatsnew311-idle}@anchor{6e7}
@subsubsection IDLE y libre de inactividad



@itemize *

@item 
Aplicar resaltado de sintaxis a archivos @code{.pyi}. (Aportado por Alex Waygood y Terry Jan Reedy en bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}).

@item 
Incluya avisos al guardar Shell con entradas y salidas. (Aportado por Terry Jan Reedy en gh-95191@footnote{https://github.com/python/cpython/issues/95191}.)
@end itemize

@node inspeccionar,lugar,IDLE y libre de inactividad,Módulos mejorados<2>
@anchor{whatsnew/3 11 inspect}@anchor{6e8}@anchor{whatsnew/3 11 whatsnew311-inspect}@anchor{6e9}
@subsubsection inspeccionar



@itemize *

@item 
Agregue @ref{6ea,,getmembers_static()} para devolver todos los miembros sin activar la búsqueda dinámica a través del protocolo descriptor. (Contribuido por Weipeng Hong en bpo-30533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30533}.)

@item 
Agregue @ref{6eb,,ismethodwrapper()} para verificar si el tipo de un objeto es @ref{6ec,,MethodWrapperType}. (Aportado por Hakan Çelik en bpo-29418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29418}.)

@item 
Cambie las funciones relacionadas con el marco en el módulo @ref{7e,,inspect} para devolver nuevas instancias de clase @ref{6ed,,FrameInfo} y @ref{6ee,,Traceback} (compatibles con las interfaces similares a @ref{6ef,,named tuple} anteriores) que incluyen la información de posición 
@geindex Python Enhancement Proposals; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} extendida (número de línea final, columna y columna final). Las funciones afectadas son:


@itemize *

@item 
@ref{6f0,,inspect.getframeinfo()}

@item 
@ref{6f1,,inspect.getouterframes()}

@item 
@ref{6f2,,inspect.getinnerframes()},

@item 
@ref{6f3,,inspect.stack()}

@item 
@ref{6f4,,inspect.trace()}
@end itemize

(Aportado por Pablo Galindo en gh-88116@footnote{https://github.com/python/cpython/issues/88116}.)
@end itemize

@node lugar,Inicio sesión,inspeccionar,Módulos mejorados<2>
@anchor{whatsnew/3 11 locale}@anchor{6f5}@anchor{whatsnew/3 11 whatsnew311-locale}@anchor{6f6}
@subsubsection lugar



@itemize *

@item 
Agregue @ref{1d3,,locale.getencoding()} para obtener la codificación de configuración regional actual. Es similar a @code{locale.getpreferredencoding(False)} pero ignora @ref{6f7,,Python UTF-8 Mode}.
@end itemize

@node Inicio sesión,Matemáticas,lugar,Módulos mejorados<2>
@anchor{whatsnew/3 11 logging}@anchor{6f8}@anchor{whatsnew/3 11 whatsnew311-logging}@anchor{6f9}
@subsubsection Inicio sesión



@itemize *

@item 
Se agregó @ref{6fa,,getLevelNamesMapping()} para devolver una asignación de nombres de nivel de registro (por ejemplo, @code{'CRITICAL'}) a los valores de su @ref{6fb,,Niveles de logging} correspondiente (por ejemplo, @code{50}, de forma predeterminada). (Aportado por Andrei Kulakovin en gh-88024@footnote{https://github.com/python/cpython/issues/88024}.)

@item 
Se agregó un método @ref{6fc,,createSocket()} a @ref{6fd,,SysLogHandler} para que coincida con @ref{6fe,,SocketHandler.createSocket()}. Se llama automáticamente durante la inicialización del controlador y cuando se emite un evento, si no hay un socket activo. (Aportado por Kirill Pinchuk en gh-88457@footnote{https://github.com/python/cpython/issues/88457}.)
@end itemize

@node Matemáticas,operador,Inicio sesión,Módulos mejorados<2>
@anchor{whatsnew/3 11 math}@anchor{6ff}@anchor{whatsnew/3 11 whatsnew311-math}@anchor{700}
@subsubsection Matemáticas



@itemize *

@item 
Suma @ref{701,,math.exp2()}: devuelve 2 elevado a la potencia de x. (Aportado por Gideon Mitchell en bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917}.)

@item 
Agregue @ref{702,,math.cbrt()}: devuelva la raíz cúbica de x. (Aportado por Ajith Ramachandran en bpo-44357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44357}.)

@item 
Se cambió el comportamiento de dos casos de esquina @ref{703,,math.pow()}, para mantener la coherencia con la especificación IEEE 754. Las operaciones @code{math.pow(0.0, -math.inf)} y @code{math.pow(-0.0, -math.inf)} ahora devuelven @code{inf}. Anteriormente plantearon @ref{360,,ValueError}. (Contribuido por Mark Dickinson en bpo-44339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44339}.)

@item 
El valor @ref{704,,math.nan} ahora está siempre disponible. (Aportado por Victor Stinner en bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}.)
@end itemize

@node operador,sistema operativo,Matemáticas,Módulos mejorados<2>
@anchor{whatsnew/3 11 operator}@anchor{705}@anchor{whatsnew/3 11 whatsnew311-operator}@anchor{706}
@subsubsection operador



@itemize *

@item 
Se ha añadido una nueva función @code{operator.call}, de forma que @code{operator.call(obj, *args, **kwargs) == obj(*args, **kwargs)}. (Aportado por Antony Lee en bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}.)
@end itemize

@node sistema operativo,rutalib,operador,Módulos mejorados<2>
@anchor{whatsnew/3 11 os}@anchor{707}@anchor{whatsnew/3 11 whatsnew311-os}@anchor{708}
@subsubsection sistema operativo



@itemize *

@item 
En Windows, @ref{5c6,,os.urandom()} ahora usa @code{BCryptGenRandom()}, en lugar de @code{CryptGenRandom()}, que está en desuso. (Aportado por Donghee Na en bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611}.)
@end itemize

@node rutalib,re<3>,sistema operativo,Módulos mejorados<2>
@anchor{whatsnew/3 11 pathlib}@anchor{709}@anchor{whatsnew/3 11 whatsnew311-pathlib}@anchor{70a}
@subsubsection rutalib



@itemize *

@item 
@ref{388,,glob()} y @ref{389,,rglob()} solo devuelven directorios si `pattern' termina con un separador de componentes de nombre de ruta: @ref{70b,,sep} o @ref{70c,,altsep}. (Aportado por Eisuke Kawasima en bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276} y bpo-33392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33392}).
@end itemize

@node re<3>,cerrar,rutalib,Módulos mejorados<2>
@anchor{whatsnew/3 11 re}@anchor{70d}@anchor{whatsnew/3 11 whatsnew311-re}@anchor{70e}
@subsubsection re



@itemize *

@item 
La agrupación atómica (@code{(?>...)}) y los cuantificadores posesivos (@code{*+}, @code{++}, @code{?+}, @code{@{m,n@}+}) ahora son compatibles con las expresiones regulares. (Aportado por Jeffrey C. Jacobs y Serhiy Storchaka en bpo-433030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433030}).
@end itemize

@node cerrar,enchufe,re<3>,Módulos mejorados<2>
@anchor{whatsnew/3 11 shutil}@anchor{70f}@anchor{whatsnew/3 11 whatsnew311-shutil}@anchor{710}
@subsubsection cerrar



@itemize *

@item 
Agregue el parámetro opcional `dir_fd' en @ref{1f9,,shutil.rmtree()}. (Aportado por Serhiy Storchaka en bpo-46245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46245}.)
@end itemize

@node enchufe,sqlite3<5>,cerrar,Módulos mejorados<2>
@anchor{whatsnew/3 11 socket}@anchor{711}@anchor{whatsnew/3 11 whatsnew311-socket}@anchor{712}
@subsubsection enchufe



@itemize *

@item 
Agregue compatibilidad con CAN Socket para NetBSD. (Aportado por Thomas Klausner en bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512}.)

@item 
@ref{713,,create_connection()} tiene una opción para generar, en caso de falla de conexión, un @ref{31d,,ExceptionGroup} que contiene todos los errores en lugar de generar solo el último error. (Aportado por Irit Katriel en bpo-29980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29980}.)
@end itemize

@node sqlite3<5>,cuerda,enchufe,Módulos mejorados<2>
@anchor{whatsnew/3 11 sqlite3}@anchor{714}@anchor{whatsnew/3 11 whatsnew311-sqlite3}@anchor{715}
@subsubsection sqlite3



@itemize *

@item 
Ahora puede deshabilitar el autorizador pasando @ref{716,,None} a @ref{3f8,,set_authorizer()}. (Aportado por Erlend E. Aasland en bpo-44491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44491}.)

@item 
El nombre de intercalación @ref{717,,create_collation()} ahora puede contener cualquier carácter Unicode. Los nombres de intercalación con caracteres no válidos ahora generan @ref{718,,UnicodeEncodeError} en lugar de @ref{223,,sqlite3.ProgrammingError}. (Aportado por Erlend E. Aasland en bpo-44688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44688}.)

@item 
Las excepciones @ref{cf,,sqlite3} ahora incluyen el código de error extendido de SQLite como @ref{719,,sqlite_errorcode} y el nombre de error de SQLite como @ref{71a,,sqlite_errorname}. (Aportado por Aviv Palivoda, Daniel Shahaf y Erlend E. Aasland en bpo-16379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16379} y bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139}).

@item 
Agregue @ref{71b,,setlimit()} y @ref{71c,,getlimit()} a @ref{39e,,sqlite3.Connection} para configurar y obtener límites de SQLite por conexión. (Aportado por Erlend E. Aasland en bpo-45243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45243}.)

@item 
@ref{cf,,sqlite3} ahora establece @ref{71d,,sqlite3.threadsafety} en función del modo de subprocesamiento predeterminado con el que se ha compilado la biblioteca SQLite subyacente. (Aportado por Erlend E. Aasland en bpo-45613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45613}.)

@item 
Las devoluciones de llamada de @ref{cf,,sqlite3} C ahora usan excepciones que no se pueden generar si las devoluciones de llamada están habilitadas. Los usuarios ahora pueden registrar un @ref{355,,unraisable hook handler} para mejorar su experiencia de depuración. (Aportado por Erlend E. Aasland en bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}.)

@item 
Recuperar a través de reversión ya no genera @ref{71e,,InterfaceError}. En cambio, dejamos que la biblioteca SQLite maneje estos casos. (Aportado por Erlend E. Aasland en bpo-44092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44092}.)

@item 
Agregue @ref{71f,,serialize()} y @ref{720,,deserialize()} a @ref{39e,,sqlite3.Connection} para serializar y deserializar bases de datos. (Aportado por Erlend E. Aasland en bpo-41930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41930}.)

@item 
Agregue @ref{721,,create_window_function()} a @ref{39e,,sqlite3.Connection} para crear funciones de ventana agregadas. (Aportado por Erlend E. Aasland en bpo-34916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34916}.)

@item 
Agregue @ref{722,,blobopen()} a @ref{39e,,sqlite3.Connection}. @ref{723,,sqlite3.Blob} permite operaciones de E/S incrementales en blobs. (Contribuido por Aviv Palivoda y Erlend E. Aasland en bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905}).
@end itemize

@node cuerda,sistema,sqlite3<5>,Módulos mejorados<2>
@anchor{whatsnew/3 11 string}@anchor{724}@anchor{whatsnew/3 11 whatsnew311-string}@anchor{725}
@subsubsection cuerda



@itemize *

@item 
Agregue @ref{726,,get_identifiers()} y @ref{727,,is_valid()} a @ref{728,,string.Template}, que devuelven respectivamente todos los marcadores de posición válidos y si hay algún marcador de posición no válido presente. (Aportado por Ben Kehoe en gh-90465@footnote{https://github.com/python/cpython/issues/90465}.)
@end itemize

@node sistema,configuración del sistema,cuerda,Módulos mejorados<2>
@anchor{whatsnew/3 11 sys}@anchor{729}@anchor{whatsnew/3 11 whatsnew311-sys}@anchor{72a}
@subsubsection sistema



@itemize *

@item 
@ref{72b,,sys.exc_info()} ahora deriva los campos @code{type} y @code{traceback} de @code{value} (la instancia de excepción), de modo que cuando se modifica una excepción mientras se está manipulando, los cambios se reflejan en los resultados de llamadas posteriores a @code{exc_info()}. (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
Agregue @ref{72c,,sys.exception()} que devuelve la instancia de excepción activa (equivalente a @code{sys.exc_info()[1]}). (Aportado por Irit Katriel en bpo-46328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46328}.)

@item 
Agregue el indicador @ref{72d,,sys.flags.safe_path}. (Aportado por Victor Stinner en gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)
@end itemize

@node configuración del sistema,archivo temporal,sistema,Módulos mejorados<2>
@anchor{whatsnew/3 11 sysconfig}@anchor{72e}@anchor{whatsnew/3 11 whatsnew311-sysconfig}@anchor{72f}
@subsubsection configuración del sistema



@itemize *

@item 
Se agregaron tres nuevos @ref{730,,installation schemes} (`posix_venv', `nt_venv' y `venv') y se usan cuando Python crea nuevos entornos virtuales o cuando se ejecuta desde un entorno virtual. Los primeros dos esquemas (`posix_venv' y `nt_venv') son específicos del sistema operativo para Windows y no Windows, el `venv' es esencialmente un alias para uno de ellos según el sistema operativo en el que se ejecuta Python. Esto es útil para los distribuidores posteriores que modifican @ref{731,,sysconfig.get_preferred_scheme()}. El código de terceros que crea nuevos entornos virtuales debe usar el nuevo esquema de instalación `venv' para determinar las rutas, al igual que @ref{111,,venv}. (Aportado por Miro Hrončok en bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}.)
@end itemize

@node archivo temporal,enhebrar,configuración del sistema,Módulos mejorados<2>
@anchor{whatsnew/3 11 tempfile}@anchor{732}@anchor{whatsnew/3 11 whatsnew311-tempfile}@anchor{733}
@subsubsection archivo temporal



@itemize *

@item 
Los objetos @ref{734,,SpooledTemporaryFile} ahora implementan completamente los métodos de @ref{735,,io.BufferedIOBase} o @ref{736,,io.TextIOBase} (según el modo de archivo). Esto les permite trabajar correctamente con API que esperan objetos similares a archivos, como módulos de compresión. (Aportado por Carey Metcalfe en gh-70363@footnote{https://github.com/python/cpython/issues/70363}.)
@end itemize

@node enhebrar,tiempo,archivo temporal,Módulos mejorados<2>
@anchor{whatsnew/3 11 threading}@anchor{737}@anchor{whatsnew/3 11 whatsnew311-threading}@anchor{738}
@subsubsection enhebrar



@itemize *

@item 
En Unix, si la función @code{sem_clockwait()} está disponible en la biblioteca C (glibc 2.30 y posteriores), el método @ref{739,,threading.Lock.acquire()} ahora usa el reloj monótono (@ref{73a,,time.CLOCK_MONOTONIC}) para el tiempo de espera, en lugar de usar el reloj del sistema (@ref{73b,,time.CLOCK_REALTIME}), para no verse afectado por cambios de reloj del sistema. (Contribución de Victor Stinner en bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}.)
@end itemize

@node tiempo,tkinter<3>,enhebrar,Módulos mejorados<2>
@anchor{whatsnew/3 11 time}@anchor{73c}@anchor{whatsnew/3 11 whatsnew311-time}@anchor{73d}
@subsubsection tiempo



@itemize *

@item 
En Unix, @ref{73e,,time.sleep()} ahora usa la función @code{clock_nanosleep()} o @code{nanosleep()}, si está disponible, que tiene una resolución de 1 nanosegundo (10@w{^-9} segundos), en lugar de usar @code{select()} que tiene una resolución de 1 microsegundo (10@w{^-6} segundos). (Aportado por Benjamin Szőke y Victor Stinner en bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}.)

@item 
En Windows 8.1 y versiones posteriores, @ref{73e,,time.sleep()} ahora utiliza un temporizador de espera basado en high-resolution timers@footnote{https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/high-resolution-timers} que tiene una resolución de 100 nanosegundos (10@w{^-7} segundos). Anteriormente, tenía una resolución de 1 milisegundo (10@w{^-3} segundos). (Contribución de Benjamin Szőke, Donghee Na, Eryk Sun y Victor Stinner en bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302} y bpo-45429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45429}).
@end itemize

@node tkinter<3>,rastrear,tiempo,Módulos mejorados<2>
@anchor{whatsnew/3 11 tkinter}@anchor{73f}@anchor{whatsnew/3 11 whatsnew311-tkinter}@anchor{740}
@subsubsection tkinter



@itemize *

@item 
Se agregó el método @code{info_patchlevel()} que devuelve la versión exacta de la biblioteca Tcl como una tupla con nombre similar a @ref{741,,sys.version_info}. (Aportado por Serhiy Storchaka en gh-91827@footnote{https://github.com/python/cpython/issues/91827}.)
@end itemize

@node rastrear,mecanografía,tkinter<3>,Módulos mejorados<2>
@anchor{whatsnew/3 11 traceback}@anchor{742}@anchor{whatsnew/3 11 whatsnew311-traceback}@anchor{743}
@subsubsection rastrear



@itemize *

@item 
Agregue @ref{744,,traceback.StackSummary.format_frame_summary()} para permitir que los usuarios anulen qué marcos aparecen en el rastreo y cómo están formateados. (Aportado por Ammar Askar en bpo-44569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44569}.)

@item 
Agregue @ref{745,,traceback.TracebackException.print()}, que imprime la instancia @ref{3b3,,TracebackException} formateada en un archivo. (Aportado por Irit Katriel en bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809}.)
@end itemize

@node mecanografía,unicodedata<4>,rastrear,Módulos mejorados<2>
@anchor{whatsnew/3 11 typing}@anchor{746}@anchor{whatsnew/3 11 whatsnew311-typing}@anchor{747}
@subsubsection mecanografía


Para conocer los cambios importantes, consulte @ref{660,,Nuevas funciones relacionadas con las sugerencias de tipo}.


@itemize *

@item 
Agregue @ref{748,,typing.assert_never()} y @ref{749,,typing.Never}. @ref{748,,typing.assert_never()} es útil para pedirle a un verificador de tipos que confirme que no se puede acceder a una línea de código. En tiempo de ejecución, genera un @ref{74a,,AssertionError}. (Aportado por Jelle Zijlstra en gh-90633@footnote{https://github.com/python/cpython/issues/90633}.)

@item 
Agregue @ref{74b,,typing.reveal_type()}. Esto es útil para preguntarle a un verificador de tipos qué tipo ha inferido para una expresión dada. En tiempo de ejecución imprime el tipo del valor recibido. (Aportado por Jelle Zijlstra en gh-90572@footnote{https://github.com/python/cpython/issues/90572}.)

@item 
Agregue @ref{74c,,typing.assert_type()}. Esto es útil para pedirle a un verificador de tipos que confirme que el tipo que ha inferido para una expresión dada coincide con el tipo dado. En tiempo de ejecución, simplemente devuelve el valor recibido. (Aportado por Jelle Zijlstra en gh-90638@footnote{https://github.com/python/cpython/issues/90638}.)

@item 
Los tipos @ref{2ce,,typing.TypedDict} ahora pueden ser genéricos. (Aportado por Samodya Abeysiriwardane en gh-89026@footnote{https://github.com/python/cpython/issues/89026}.)

@item 
Los tipos @ref{1db,,NamedTuple} ahora pueden ser genéricos. (Aportado por Serhiy Storchaka en bpo-43923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43923}.)

@item 
Permitir subclases de @ref{74d,,typing.Any}. Esto es útil para evitar errores de verificación de tipos relacionados con clases altamente dinámicas, como simulacros. (Aportado por Shantanu Jain en gh-91154@footnote{https://github.com/python/cpython/issues/91154}.)

@item 
El decorador @ref{74e,,typing.final()} ahora establece el atributo @code{__final__} en el objeto decorado. (Aportado por Jelle Zijlstra en gh-90500@footnote{https://github.com/python/cpython/issues/90500}.)

@item 
La función @ref{74f,,typing.get_overloads()} se puede utilizar para la introspección de las sobrecargas de una función. @ref{750,,typing.clear_overloads()} se puede utilizar para borrar todas las sobrecargas registradas de una función. (Aportado por Jelle Zijlstra en gh-89263@footnote{https://github.com/python/cpython/issues/89263}.)

@item 
Ahora se conserva el método @ref{751,,__init__()} de las subclases @ref{3bb,,Protocol}. (Aportado por Adrián García Badarasco en gh-88970@footnote{https://github.com/python/cpython/issues/88970}.)

@item 
La representación de tipos de tuplas vacías (@code{Tuple[()]}) se simplifica. Esto afecta la introspección, p. @code{get_args(Tuple[()])} ahora se evalúa como @code{()} en lugar de @code{((),)}. (Aportado por Serhiy Storchaka en gh-91137@footnote{https://github.com/python/cpython/issues/91137}.)

@item 
Afloje los requisitos de tiempo de ejecución para las anotaciones de tipo eliminando la verificación invocable en la función privada @code{typing._type_check}. (Aportado por Gregory Beauregard en gh-90802@footnote{https://github.com/python/cpython/issues/90802}.)

@item 
@ref{752,,typing.get_type_hints()} ahora admite la evaluación de cadenas como referencias directas en @ref{753,,PEP 585 generic aliases}. (Aportado por Niklas Rosenstein en gh-85542@footnote{https://github.com/python/cpython/issues/85542}.)

@item 
@ref{752,,typing.get_type_hints()} ya no agrega @ref{754,,Optional} a los parámetros con @code{None} como predeterminado. (Aportado por Nikita Sobolev en gh-90353@footnote{https://github.com/python/cpython/issues/90353}.)

@item 
@ref{752,,typing.get_type_hints()} ahora admite la evaluación de anotaciones @ref{3bd,,ClassVar} con cadenas desnudas. (Aportado por Gregory Beauregard en gh-90711@footnote{https://github.com/python/cpython/issues/90711}.)

@item 
@ref{755,,typing.no_type_check()} ya no modifica clases y funciones externas. Ahora también marca correctamente los métodos de clase para que no se verifique el tipo. (Aportado por Nikita Sobolev en gh-90729@footnote{https://github.com/python/cpython/issues/90729}.)
@end itemize

@node unicodedata<4>,prueba de unidad,mecanografía,Módulos mejorados<2>
@anchor{whatsnew/3 11 unicodedata}@anchor{756}@anchor{whatsnew/3 11 whatsnew311-unicodedata}@anchor{757}
@subsubsection unicodedata



@itemize *

@item 
La base de datos Unicode se ha actualizado a la versión 14.0.0. (Aportado por Benjamin Peterson en bpo-45190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45190}).
@end itemize

@node prueba de unidad,venv<2>,unicodedata<4>,Módulos mejorados<2>
@anchor{whatsnew/3 11 unittest}@anchor{758}@anchor{whatsnew/3 11 whatsnew311-unittest}@anchor{759}
@subsubsection prueba de unidad



@itemize *

@item 
Se agregaron los métodos @ref{75a,,enterContext()} y @ref{75b,,enterClassContext()} de la clase @ref{4fa,,TestCase}, el método @ref{75c,,enterAsyncContext()} de la clase @ref{206,,IsolatedAsyncioTestCase} y la función @ref{75d,,unittest.enterModuleContext()}. (Aportado por Serhiy Storchaka en bpo-45046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45046}.)
@end itemize

@node venv<2>,advertencias,prueba de unidad,Módulos mejorados<2>
@anchor{whatsnew/3 11 venv}@anchor{75e}@anchor{whatsnew/3 11 whatsnew311-venv}@anchor{75f}
@subsubsection venv



@itemize *

@item 
Cuando se crean nuevos entornos virtuales de Python, el `venv' @ref{730,,sysconfig installation scheme} se utiliza para determinar las rutas dentro del entorno. Cuando Python se ejecuta en un entorno virtual, el mismo esquema de instalación es el predeterminado. Eso significa que los distribuidores intermedios pueden cambiar el esquema de instalación de sysconfig predeterminado sin cambiar el comportamiento de los entornos virtuales. El código de terceros que también crea nuevos entornos virtuales debería hacer lo mismo. (Aportado por Miro Hrončok en bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}.)
@end itemize

@node advertencias,archivo zip,venv<2>,Módulos mejorados<2>
@anchor{whatsnew/3 11 warnings}@anchor{760}@anchor{whatsnew/3 11 whatsnew311-warnings}@anchor{761}
@subsubsection advertencias



@itemize *

@item 
@ref{628,,warnings.catch_warnings()} ahora acepta argumentos para @ref{762,,warnings.simplefilter()}, lo que proporciona una forma más concisa de ignorar localmente las advertencias o convertirlas en errores. (Aportado por Zac Hatfield-Dodds en bpo-47074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47074}).
@end itemize

@node archivo zip,,advertencias,Módulos mejorados<2>
@anchor{whatsnew/3 11 whatsnew311-zipfile}@anchor{763}@anchor{whatsnew/3 11 zipfile}@anchor{764}
@subsubsection archivo zip



@itemize *

@item 
Se agregó compatibilidad para especificar la codificación de nombres de miembros para leer metadatos en los encabezados de archivos y directorios de @ref{765,,ZipFile}. (Aportado por Stephen J. Turnbull y Serhiy Storchaka en bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080}).

@item 
Se agregó @ref{766,,ZipFile.mkdir()} para crear nuevos directorios dentro de archivos ZIP. (Aportado por Sam Ezeh en gh-49083@footnote{https://github.com/python/cpython/issues/49083}.)

@item 
Se agregaron @ref{767,,stem}, @ref{768,,suffix} y @ref{769,,suffixes} a @ref{76a,,zipfile.Path}. (Aportado por Miguel Brito en gh-88261@footnote{https://github.com/python/cpython/issues/88261}.)
@end itemize

@node Optimizaciones<2>,CPython más rápido,Módulos mejorados<2>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 optimizations}@anchor{76b}@anchor{whatsnew/3 11 whatsnew311-optimizations}@anchor{76c}
@subsection Optimizaciones


Esta sección cubre optimizaciones específicas independientes del proyecto @ref{641,,CPython más rápido}, que se trata en su propia sección.


@itemize *

@item 
El compilador ahora optimiza @ref{76d,,printf-style % formatting} simple en cadenas literales que contienen solo los códigos de formato @code{%s}, @code{%r} y @code{%a} y lo hace tan rápido como una expresión @ref{4e4,,f-string} correspondiente. (Aportado por Serhiy Storchaka en bpo-28307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28307}.)

@item 
La división de enteros a la baja (@code{//}) está mejor ajustada para la optimización por parte de los compiladores. Ahora es un 20 % más rápido en x86-64 cuando se divide un @ref{1f0,,int} por un valor menor que @code{2**30}. (Aportado por Gregory P. Smith y Tim Peters en gh-90564@footnote{https://github.com/python/cpython/issues/90564}.)

@item 
@ref{515,,sum()} ahora es casi un 30 % más rápido para números enteros más pequeños que @code{2**30}. (Aportado por Stefan Behnel en gh-68264@footnote{https://github.com/python/cpython/issues/68264}.)

@item 
El cambio de tamaño de las listas está simplificado para el caso común, acelerando @code{list.append()} en ≈15 % y @ref{76e,,list comprehension}s simples hasta en un 20-30 % (Contribuido por Dennis Sweeney en gh-91165@footnote{https://github.com/python/cpython/issues/91165}).

@item 
Los diccionarios no almacenan valores hash cuando todas las claves son objetos Unicode, lo que reduce el tamaño de @ref{190,,dict}. Por ejemplo, @code{sys.getsizeof(dict.fromkeys("abcdefg"))} se reduce de 352 bytes a 272 bytes (un 23 % más pequeño) en plataformas de 64 bits. (Aportado por Inada Naoki en bpo-46845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46845}.)

@item 
El uso de @ref{76f,,asyncio.DatagramProtocol} ahora es mucho más rápido cuando se transfieren archivos grandes a través de UDP, con velocidades 100 veces más altas para un archivo de ≈60 MiB. (Aportado por msoxzw en gh-91487@footnote{https://github.com/python/cpython/issues/91487}.)

@item 
Las funciones @ref{8e,,math} @ref{770,,comb()} y @ref{771,,perm()} ahora son ≈10 veces más rápidas para argumentos grandes (con una aceleración mayor para `k' más grandes). (Aportado por Serhiy Storchaka en bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}.)

@item 
Las funciones @ref{d2,,statistics} @ref{772,,mean()}, @ref{773,,variance()} y @ref{774,,stdev()} ahora consumen iteradores en una sola pasada en lugar de convertirlos primero en @ref{18e,,list}. Esto es el doble de rápido y puede ahorrar una cantidad considerable de memoria. (Aportado por Raymond Hettinger en gh-90415@footnote{https://github.com/python/cpython/issues/90415}.)

@item 
@ref{775,,unicodedata.normalize()} ahora normaliza cadenas ASCII puras en tiempo constante. (Contribución de Donghee Na en bpo-44987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44987}.)
@end itemize

@node CPython más rápido,Cambios en el código de bytes de CPython<2>,Optimizaciones<2>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 faster-cpython}@anchor{776}@anchor{whatsnew/3 11 whatsnew311-faster-cpython}@anchor{641}
@subsection CPython más rápido


CPython 3.11 es en promedio 25% faster@footnote{https://github.com/faster-cpython/ideas#published-results} que CPython 3.10 cuando se mide con el conjunto de pruebas comparativas pyperformance@footnote{https://github.com/python/pyperformance} y se compila con GCC en Ubuntu Linux. Dependiendo de su carga de trabajo, la aceleración podría ser hasta un 10-60% más rápida.

Este proyecto se centra en dos áreas principales de Python: @ref{777,,Inicio más rápido} y @ref{778,,Tiempo de ejecución más rápido}. Las optimizaciones no cubiertas por este proyecto se enumeran por separado en @ref{76c,,Optimizaciones}.

@menu
* Inicio más rápido:: 
* Tiempo de ejecución más rápido:: 
* Varios:: 
* Preguntas más frecuentes:: 
* Sobre:: 

@end menu

@node Inicio más rápido,Tiempo de ejecución más rápido,,CPython más rápido
@anchor{whatsnew/3 11 faster-startup}@anchor{779}@anchor{whatsnew/3 11 whatsnew311-faster-startup}@anchor{777}
@subsubsection Inicio más rápido


@menu
* Importaciones congeladas / Objetos de código estático:: 

@end menu

@node Importaciones congeladas / Objetos de código estático,,,Inicio más rápido
@anchor{whatsnew/3 11 frozen-imports-static-code-objects}@anchor{77a}@anchor{whatsnew/3 11 whatsnew311-faster-imports}@anchor{77b}
@subsubsection Importaciones congeladas / Objetos de código estático


Python almacena en caché el @ref{2f2,,bytecode} en el directorio @ref{77c,,__pycache__} para acelerar la carga del módulo.

Previamente en 3.10, la ejecución del módulo de Python se veía así:

@example
Read __pycache__ -> Unmarshal -> Heap allocated code object -> Evaluate
@end example

En Python 3.11, los módulos principales esenciales para el inicio de Python están «congelados». Esto significa que el intérprete asigna estáticamente sus @ref{656,,Objetos código} (y sus códigos de bytes). Esto reduce los pasos en el proceso de ejecución del módulo a:

@example
Statically allocated code object -> Evaluate
@end example

El inicio del intérprete ahora es un 10-15 % más rápido en Python 3.11. Esto tiene un gran impacto para los programas de ejecución corta que usan Python.

(Aportado por Eric Snow, Guido van Rossum y Kumar Aditya en numerosos asuntos).

@node Tiempo de ejecución más rápido,Varios,Inicio más rápido,CPython más rápido
@anchor{whatsnew/3 11 faster-runtime}@anchor{77d}@anchor{whatsnew/3 11 whatsnew311-faster-runtime}@anchor{778}
@subsubsection Tiempo de ejecución más rápido


@menu
* Marcos de Python más baratos y perezosos:: 
* Llamadas a funciones de Python en línea:: 
* PEP 659; Intérprete Adaptativo Especializado: PEP 659 Intérprete Adaptativo Especializado. 

@end menu

@node Marcos de Python más baratos y perezosos,Llamadas a funciones de Python en línea,,Tiempo de ejecución más rápido
@anchor{whatsnew/3 11 cheaper-lazy-python-frames}@anchor{77e}@anchor{whatsnew/3 11 whatsnew311-lazy-python-frames}@anchor{77f}
@subsubsection Marcos de Python más baratos y perezosos


Los marcos de Python, que contienen información de ejecución, se crean cada vez que Python llama a una función de Python. Las siguientes son nuevas optimizaciones de marcos:


@itemize -

@item 
Simplificó el proceso de creación de marcos.

@item 
Se evitó la asignación de memoria al reutilizar generosamente el espacio de marcos en la pila C.

@item 
Simplificó la estructura del marco interno para que contenga solo información esencial. Los marcos contenían previamente información adicional de gestión de memoria y depuración.
@end itemize

Los @ref{780,,frame objects} de estilo antiguo ahora se crean solo cuando lo solicitan los depuradores o las funciones de introspección de Python como @ref{781,,sys._getframe()} y @ref{782,,inspect.currentframe()}. Para la mayoría del código de usuario, no se crea ningún objeto de marco. Como resultado, casi todas las llamadas a funciones de Python se han acelerado significativamente. Medimos una aceleración del 3 al 7% en pyperformance.

(Aportado por Mark Shannon en bpo-44590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44590}.)
@anchor{whatsnew/3 11 inline-calls}@anchor{783}
@node Llamadas a funciones de Python en línea,PEP 659 Intérprete Adaptativo Especializado,Marcos de Python más baratos y perezosos,Tiempo de ejecución más rápido
@anchor{whatsnew/3 11 inlined-python-function-calls}@anchor{784}@anchor{whatsnew/3 11 whatsnew311-inline-calls}@anchor{785}
@subsubsection Llamadas a funciones de Python en línea


Durante una llamada de función de Python, Python llamará a una función C de evaluación para interpretar el código de esa función. Esto limita efectivamente la recursión pura de Python a lo que es seguro para la pila de C.

En 3.11, cuando CPython detecta código de Python que llama a otra función de Python, configura un nuevo marco y «salta» al nuevo código dentro del nuevo marco. Esto evita llamar a la función de interpretación de C por completo.

La mayoría de las llamadas a funciones de Python ahora no consumen espacio en la pila de C, lo que las acelera. En funciones recursivas simples como Fibonacci o factorial, observamos una aceleración de 1,7 veces. Esto también significa que las funciones recursivas pueden recurrir significativamente más profundamente (si el usuario aumenta el límite de recursividad con @ref{56a,,sys.setrecursionlimit()}). Medimos una mejora del 1 al 3% en pyperformance.

(Aportado por Pablo Galindo y Mark Shannon en bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256}.)

@node PEP 659 Intérprete Adaptativo Especializado,,Llamadas a funciones de Python en línea,Tiempo de ejecución más rápido
@anchor{whatsnew/3 11 pep-659-specializing-adaptive-interpreter}@anchor{786}@anchor{whatsnew/3 11 whatsnew311-pep659}@anchor{2e7}
@subsubsection PEP 659: Intérprete Adaptativo Especializado


@geindex Python Enhancement Proposals; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} es una de las partes clave del proyecto Faster CPython. La idea general es que, si bien Python es un lenguaje dinámico, la mayor parte del código tiene regiones donde los objetos y tipos rara vez cambian. Este concepto se conoce como `type stability'.

En tiempo de ejecución, Python intentará buscar patrones comunes y estabilidad de tipos en el código en ejecución. Luego, Python reemplazará la operación actual por una más especializada. Esta operación especializada utiliza rutas rápidas disponibles solo para aquellos casos/tipos de uso, que generalmente superan a sus contrapartes genéricas. Esto también trae consigo otro concepto llamado `inline caching', donde Python almacena en caché los resultados de operaciones costosas directamente en el @ref{2f2,,bytecode}.

El especialista también combinará ciertos pares de instrucciones comunes en una superinstrucción, reduciendo la sobrecarga durante la ejecución.

Python solo se especializará cuando vea código «caliente» (ejecutado varias veces). Esto evita que Python pierda tiempo en código de ejecución única. Python también puede desespecializarse cuando el código es demasiado dinámico o cuando cambia el uso. La especialización se intenta periódicamente y los intentos de especialización no son demasiado costosos, lo que permite que la especialización se adapte a nuevas circunstancias.

(PEP escrito por Mark Shannon, con ideas inspiradas por Stefan Brunthaler. Consulte 
@geindex Python Enhancement Proposals; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} para obtener más información. Implementación por Mark Shannon y Brandt Bucher, con ayuda adicional de Irit Katriel y Dennis Sweeney).

@c If I missed out anyone, please add them.


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Forma

@tab

Especialización

@tab

Aceleración de la operación (hasta)

@tab

Colaborador(es)

@item

Operaciones binarias

@tab

@code{x + x}

@code{x - x}

@code{x * x}

@tab

La suma, multiplicación y resta binaria para tipos comunes como @ref{1f0,,int}, @ref{153,,float} y @ref{237,,str} toman rutas rápidas personalizadas para sus tipos subyacentes.

@tab

10%

@tab

Mark Shannon,
Donghee Na,
Brandt Bucher,
Dennis Sweeney

@item

Subíndice

@tab

@code{a[i]}

@tab

Los tipos de contenedores de subíndices, como @ref{18e,,list}, @ref{464,,tuple} y @ref{190,,dict}, indexan directamente las estructuras de datos subyacentes.

El subíndice @ref{3d8,,__getitem__()} personalizado también está incluido de manera similar a @ref{783,,Llamadas a funciones de Python en línea}.

@tab

10-25%

@tab

Irit KatrielMark Shannon

@item

Almacenar subíndice

@tab

@code{a[i] = z}

@tab

Similar a la especialización de subíndices anterior.

@tab

10-25%

@tab

dennis sweeney

@item

Llamadas

@tab

@code{f(arg)}

@code{C(arg)}

@tab

Las llamadas a funciones y tipos integrados (C) comunes, como @ref{6cf,,len()} y @ref{237,,str}, llaman directamente a su versión C subyacente. Esto evita pasar por la convención de llamadas interna.

@tab

20%

@tab

Mark ShannonKen Jin

@item

Cargar variable global

@tab

@code{print}

@code{len}

@tab

El índice del objeto en el espacio de nombres globales/integrados se almacena en caché. La carga de globales e integrados requiere cero búsquedas de espacios de nombres.

@tab

@footnote{
Ya existía una optimización similar desde Python 3.8. 3.11 se especializa en más formas y reduce algunos gastos generales.
}

@tab

marca shannon

@item

Cargar atributo

@tab

@code{o.attr}

@tab

Similar a cargar variables globales. El índice del atributo dentro del espacio de nombres de la clase/objeto se almacena en caché. En la mayoría de los casos, la carga de atributos requerirá cero búsquedas de espacios de nombres.

@tab

@footnote{
Ya existía una optimización similar desde Python 3.10. 3.11 se especializa en más formularios. Además, @uref{https://bugs.python.org/issue?@@action=redirect&bpo=45947,bpo-45947} debería acelerar todas las cargas de atributos.
}

@tab

marca shannon

@item

Cargar métodos para llamar

@tab

@code{o.meth()}

@tab

La dirección real del método se almacena en caché. La carga de métodos ahora no tiene búsquedas de espacio de nombres, incluso para clases con largas cadenas de herencia.

@tab

10-20%

@tab

Ken JinMark Shannon

@item

Atributo de la tienda

@tab

@code{o.attr = z}

@tab

Similar a la optimización de atributos de carga.

@tab

2% en rendimiento

@tab

marca shannon

@item

Secuencia de desempaquetado

@tab

@code{*seq}

@tab

Especializado para contenedores comunes como @ref{18e,,list} y @ref{464,,tuple}. Evita la convención de llamadas internas.

@tab

8%

@tab

brandt bucher

@end multitable


@node Varios,Preguntas más frecuentes,Tiempo de ejecución más rápido,CPython más rápido
@anchor{whatsnew/3 11 misc}@anchor{787}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-misc}@anchor{788}
@subsubsection Varios



@itemize *

@item 
Los objetos ahora requieren menos memoria debido a los espacios de nombres de objetos creados con pereza. Sus diccionarios de espacio de nombres ahora también comparten claves más libremente. (Contribuido por Mark Shannon en bpo-45340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45340} y bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}).

@item 
Se implementan excepciones de «costo cero», lo que elimina el costo de las declaraciones @ref{789,,try} cuando no se plantea ninguna excepción. (Contribución de Mark Shannon en bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}.)

@item 
Una representación más concisa de las excepciones en el intérprete redujo el tiempo necesario para detectar una excepción en aproximadamente un 10 %. (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
El motor de coincidencia de expresiones regulares de @ref{b9,,re} ha sido parcialmente refactorizado y ahora utiliza gotos calculados (o «código de subprocesos») en las plataformas compatibles. Como resultado, Python 3.11 ejecuta pyperformance regular expression benchmarks@footnote{https://pyperformance.readthedocs.io/benchmarks.html#regex-dna} hasta un 10% más rápido que Python 3.10. (Contribución de Brandt Bucher en gh-91404@footnote{https://github.com/python/cpython/issues/91404}.)
@end itemize

@node Preguntas más frecuentes,Sobre,Varios,CPython más rápido
@anchor{whatsnew/3 11 faq}@anchor{78a}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-faq}@anchor{78b}
@subsubsection Preguntas más frecuentes


@menu
* ¿Cómo debo escribir mi código para utilizar estas aceleraciones?:: 
* ¿CPython 3.11 usará más memoria?: ¿CPython 3 11 usará más memoria?. 
* No veo ninguna aceleración en mi carga de trabajo. ¿Por qué?: No veo ninguna aceleración en mi carga de trabajo ¿Por qué?. 
* ¿Existe un compilador JIT?:: 

@end menu

@node ¿Cómo debo escribir mi código para utilizar estas aceleraciones?,¿CPython 3 11 usará más memoria?,,Preguntas más frecuentes
@anchor{whatsnew/3 11 faster-cpython-faq-my-code}@anchor{78c}@anchor{whatsnew/3 11 how-should-i-write-my-code-to-utilize-these-speedups}@anchor{78d}
@subsubsection ¿Cómo debo escribir mi código para utilizar estas aceleraciones?


No tienes que cambiar tu código, escribe código Pythonic que siga las mejores prácticas comunes. El proyecto Faster CPython optimiza los patrones de código comunes que observamos.

@node ¿CPython 3 11 usará más memoria?,No veo ninguna aceleración en mi carga de trabajo ¿Por qué?,¿Cómo debo escribir mi código para utilizar estas aceleraciones?,Preguntas más frecuentes
@anchor{whatsnew/3 11 faster-cpython-faq-memory}@anchor{78e}@anchor{whatsnew/3 11 will-cpython-3-11-use-more-memory}@anchor{78f}
@subsubsection ¿CPython 3.11 usará más memoria?


Tal vez no. No esperamos que el uso de memoria supere el 20% más que 3.10. Esto se compensa con las optimizaciones de memoria para objetos de marco y diccionarios de objetos, como se mencionó anteriormente.

@node No veo ninguna aceleración en mi carga de trabajo ¿Por qué?,¿Existe un compilador JIT?,¿CPython 3 11 usará más memoria?,Preguntas más frecuentes
@anchor{whatsnew/3 11 faster-cpython-ymmv}@anchor{790}@anchor{whatsnew/3 11 i-don-t-see-any-speedups-in-my-workload-why}@anchor{791}
@subsubsection No veo ninguna aceleración en mi carga de trabajo. ¿Por qué?


Cierto código no tendrá beneficios notables. Si su código pasa la mayor parte de su tiempo en operaciones de E/S, o ya realiza la mayor parte de su cálculo en una biblioteca de extensión C como numpy, no habrá una aceleración significativa. Actualmente, este proyecto es el que más beneficia a las cargas de trabajo de Python puro.

Además, las cifras de pyperformance son una media geométrica. Incluso dentro de los puntos de referencia de pyrendimiento, ciertos puntos de referencia se han ralentizado ligeramente, mientras que otros se han acelerado casi 2 veces.

@node ¿Existe un compilador JIT?,,No veo ninguna aceleración en mi carga de trabajo ¿Por qué?,Preguntas más frecuentes
@anchor{whatsnew/3 11 faster-cpython-jit}@anchor{792}@anchor{whatsnew/3 11 is-there-a-jit-compiler}@anchor{793}
@subsubsection ¿Existe un compilador JIT?


No. Todavía estamos explorando otras optimizaciones.

@node Sobre,,Preguntas más frecuentes,CPython más rápido
@anchor{whatsnew/3 11 about}@anchor{794}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-about}@anchor{795}
@subsubsection Sobre


Faster CPython explora optimizaciones para @ref{796,,CPython}. El equipo principal está financiado por Microsoft para trabajar en esto a tiempo completo. Pablo Galindo Salgado también está financiado por Bloomberg LP para trabajar en el proyecto a tiempo parcial. Finalmente, muchos contribuyentes son voluntarios de la comunidad.

@node Cambios en el código de bytes de CPython<2>,Obsoleto<3>,CPython más rápido,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 cpython-bytecode-changes}@anchor{797}@anchor{whatsnew/3 11 whatsnew311-bytecode-changes}@anchor{798}
@subsection Cambios en el código de bytes de CPython


El código de bytes ahora contiene entradas de caché en línea, que toman la forma de las instrucciones @ref{799,,CACHE} recién agregadas. Muchos códigos de operación esperan ser seguidos por una cantidad exacta de cachés e indican al intérprete que los omita en tiempo de ejecución. Los cachés poblados pueden parecer instrucciones arbitrarias, por lo que se debe tener mucho cuidado al leer o modificar el código de bytes adaptativo sin procesar que contiene datos acelerados.

@menu
* Nuevos códigos de operación:: 
* Códigos de operación reemplazados:: 
* Códigos de operación cambiados/eliminados:: 

@end menu

@node Nuevos códigos de operación,Códigos de operación reemplazados,,Cambios en el código de bytes de CPython<2>
@anchor{whatsnew/3 11 new-opcodes}@anchor{79a}@anchor{whatsnew/3 11 whatsnew311-added-opcodes}@anchor{79b}
@subsubsection Nuevos códigos de operación



@itemize *

@item 
@code{ASYNC_GEN_WRAP}, @ref{79c,,RETURN_GENERATOR} and @ref{79d,,SEND},
used in generators and co-routines.

@item 
@ref{79e,,COPY_FREE_VARS}, que evita la necesidad de un código especial del lado de la persona que llama para los cierres.

@item 
@ref{79f,,JUMP_BACKWARD_NO_INTERRUPT}, para usar en ciertos bucles donde no es deseable manejar interrupciones.

@item 
@ref{7a0,,MAKE_CELL}, para crear @ref{7a1,,Objetos celda}.

@item 
@ref{7a2,,CHECK_EG_MATCH}  and  @code{PREP_RERAISE_STAR},
to handle the @ref{642,,new exception groups and except*}
added in 
@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}.

@item 
@ref{7a3,,PUSH_EXC_INFO}, para uso en controladores de excepciones.

@item 
@ref{408,,RESUME}, no operativo, para el seguimiento interno, la depuración y las comprobaciones de optimización.
@end itemize

@node Códigos de operación reemplazados,Códigos de operación cambiados/eliminados,Nuevos códigos de operación,Cambios en el código de bytes de CPython<2>
@anchor{whatsnew/3 11 replaced-opcodes}@anchor{7a4}@anchor{whatsnew/3 11 whatsnew311-replaced-opcodes}@anchor{7a5}
@subsubsection Códigos de operación reemplazados



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Códigos de operación reemplazados

@tab

Nuevos códigos de operación

@tab

notas

@item


@display
@code{BINARY_*}@w{ }
@code{INPLACE_*}@w{ }
@end display



@tab

@ref{7a6,,BINARY_OP}

@tab

Reemplazó todos los códigos de operación numéricos binarios/en el lugar con un solo código de operación

@item


@display
@code{CALL_FUNCTION}@w{ }
@code{CALL_FUNCTION_KW}@w{ }
@code{CALL_METHOD}@w{ }
@end display



@tab


@display
@ref{7a7,,CALL}@w{ }
@code{KW_NAMES}@w{ }
@code{PRECALL}@w{ }
@ref{7a8,,PUSH_NULL}@w{ }
@end display



@tab

Separa el cambio de argumentos para métodos del manejo de argumentos de palabras clave; permite una mejor especialización de las llamadas

@item


@display
@code{DUP_TOP}@w{ }
@code{DUP_TOP_TWO}@w{ }
@code{ROT_TWO}@w{ }
@code{ROT_THREE}@w{ }
@code{ROT_FOUR}@w{ }
@code{ROT_N}@w{ }
@end display



@tab


@display
@ref{7a9,,COPY}@w{ }
@ref{7aa,,SWAP}@w{ }
@end display



@tab

Instrucciones de manipulación de pilas

@item


@display
@code{JUMP_IF_NOT_EXC_MATCH}@w{ }
@end display



@tab


@display
@ref{7ab,,CHECK_EXC_MATCH}@w{ }
@end display



@tab

Ahora realiza la comprobación pero no salta.

@item


@display
@code{JUMP_ABSOLUTE}@w{ }
@code{POP_JUMP_IF_FALSE}@w{ }
@code{POP_JUMP_IF_TRUE}@w{ }
@end display



@tab


@display
@ref{7ac,,JUMP_BACKWARD}@w{ }
@code{POP_JUMP_BACKWARD_IF_*}@w{ }
@code{POP_JUMP_FORWARD_IF_*}@w{ }
@end display



@tab

Ver @footnote{
All jump opcodes are now relative, including the
existing @code{JUMP_IF_TRUE_OR_POP} and @code{JUMP_IF_FALSE_OR_POP}.
The argument is now an offset from the current instruction
rather than an absolute location.
}; Variantes @code{TRUE}, @code{FALSE}, @code{NONE} y @code{NOT_NONE} para cada dirección

@item


@display
@code{SETUP_WITH}@w{ }
@code{SETUP_ASYNC_WITH}@w{ }
@end display



@tab

@code{BEFORE_WITH}

@tab

Configuración del bloque @ref{673,,with}

@end multitable

@anchor{whatsnew/3 11 whatsnew311-changed-opcodes}@anchor{7ad}@anchor{whatsnew/3 11 whatsnew311-removed-opcodes}@anchor{7ae}
@node Códigos de operación cambiados/eliminados,,Códigos de operación reemplazados,Cambios en el código de bytes de CPython<2>
@anchor{whatsnew/3 11 changed-removed-opcodes}@anchor{7af}@anchor{whatsnew/3 11 whatsnew311-changed-removed-opcodes}@anchor{7b0}
@subsubsection Códigos de operación cambiados/eliminados



@itemize *

@item 
Se cambiaron @ref{7b1,,MATCH_CLASS} y @ref{7b2,,MATCH_KEYS} para que ya no envíen un valor booleano adicional para indicar éxito/fracaso. En su lugar, se inserta @code{None} en caso de error en lugar de la tupla de valores extraídos.

@item 
Se cambiaron los códigos de operación que funcionan con excepciones para reflejarlas y ahora se representan como un elemento en la pila en lugar de tres (ver gh-89874@footnote{https://github.com/python/cpython/issues/89874}).

@item 
Se eliminaron @code{COPY_DICT_WITHOUT_KEYS}, @code{GEN_START}, @code{POP_BLOCK}, @code{SETUP_FINALLY} y @code{YIELD_FROM}.
@end itemize
@anchor{whatsnew/3 11 whatsnew311-deprecated}@anchor{7b3}
@node Obsoleto<3>,Eliminación pendiente en Python 3 12,Cambios en el código de bytes de CPython<2>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 deprecated}@anchor{7b4}@anchor{whatsnew/3 11 whatsnew311-python-api-deprecated}@anchor{7b5}
@subsection Obsoleto


Esta sección enumera las API de Python que han quedado obsoletas en Python 3.11.

Las API de C en desuso son @ref{7b6,,listed separately}.
@anchor{whatsnew/3 11 whatsnew311-deprecated-language}@anchor{7b7}
@menu
* Idioma/Construidos:: 
* Módulos:: 
* Biblioteca estándar:: 

@end menu

@node Idioma/Construidos,Módulos,,Obsoleto<3>
@anchor{whatsnew/3 11 language-builtins}@anchor{7b8}@anchor{whatsnew/3 11 whatsnew311-deprecated-builtins}@anchor{7b9}
@subsubsection Idioma/Construidos



@itemize *

@item 
El encadenamiento de descriptores @ref{2d2,,classmethod} (introducido en bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}) ahora está en desuso. Ya no se puede usar para envolver otros descriptores como @ref{2fd,,property}. El diseño central de esta función tenía fallas y causó una serie de problemas posteriores. Para «transmitir» un @ref{2d2,,classmethod}, considere usar el atributo @code{__wrapped__} que se agregó en Python 3.10. (Aportado por Raymond Hettinger en gh-89519@footnote{https://github.com/python/cpython/issues/89519}.)

@item 
Los escapes octales en cadenas y bytes literales con valores mayores que @code{0o377} (255 en decimal) ahora producen un @ref{1da,,DeprecationWarning}. En una futura versión de Python, generarán un @ref{511,,SyntaxWarning} y eventualmente un @ref{150,,SyntaxError}. (Aportado por Serhiy Storchaka en gh-81548@footnote{https://github.com/python/cpython/issues/81548}.)

@item 
La delegación de @ref{1f0,,int()} a @ref{229,,__trunc__()} ahora está obsoleta. Llamar a @code{int(a)} cuando @code{type(a)} implementa @code{__trunc__()} pero no @ref{22a,,__int__()} o @ref{22b,,__index__()} ahora genera un @ref{1da,,DeprecationWarning}. (Aportado por Zackery Spytz en bpo-44977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44977}).
@end itemize

@node Módulos,Biblioteca estándar,Idioma/Construidos,Obsoleto<3>
@anchor{whatsnew/3 11 modules}@anchor{7ba}@anchor{whatsnew/3 11 whatsnew311-deprecated-modules}@anchor{7bb}
@subsubsection Módulos

@anchor{whatsnew/3 11 whatsnew311-pep594}@anchor{64d}

@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} condujo a la desaprobación de los siguientes módulos programados para su eliminación en Python 3.13:


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{aifc}

@tab

@code{chunk}

@tab

@code{msilib}

@tab

@code{pipes}

@tab

@code{telnetlib}

@item

@code{audioop}

@tab

@code{crypt}

@tab

@code{nis}

@tab

@code{sndhdr}

@tab

@code{uu}

@item

@code{cgi}

@tab

@code{imghdr}

@tab

@code{nntplib}

@tab

@code{spwd}

@tab

@code{xdrlib}

@item

@code{cgitb}

@tab

@code{mailcap}

@tab

@code{ossaudiodev}

@tab

@code{sunau}

@tab

@end multitable


(Aportado por Brett Cannon en bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061} y Victor Stinner en gh-68966@footnote{https://github.com/python/cpython/issues/68966}).

@item 
The @code{asynchat}, @code{asyncore} and  @code{smtpd} modules have been
deprecated since at least Python 3.6. Their documentation and deprecation
warnings have now been updated to note they will be removed in Python 3.12.
(Contributed by Hugo van Kemenade in bpo-47022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47022}.)

@item 
The @code{lib2to3} package and @code{2to3} tool
are now deprecated and may not be able to parse Python 3.10 or newer.
See 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}, introducing the new PEG parser, for details.
(Contributed by Victor Stinner in bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}.)

@item 
Los módulos no documentados @code{sre_compile}, @code{sre_constants} y @code{sre_parse} ahora están obsoletos. (Aportado por Serhiy Storchaka en bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}.)
@end itemize

@node Biblioteca estándar,,Módulos,Obsoleto<3>
@anchor{whatsnew/3 11 standard-library}@anchor{7bc}@anchor{whatsnew/3 11 whatsnew311-deprecated-stdlib}@anchor{7bd}
@subsubsection Biblioteca estándar



@itemize *

@item 
Lo siguiente ha quedado obsoleto en @ref{23,,configparser} desde Python 3.2. Sus advertencias de obsolescencia ahora se han actualizado para tener en cuenta que se eliminarán en Python 3.12:


@itemize *

@item 
la clase @code{configparser.SafeConfigParser}

@item 
la propiedad @code{configparser.ParsingError.filename}

@item 
the @code{configparser.RawConfigParser.readfp()} method
@end itemize

(Aportado por Hugo van Kemenade en bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}.)

@item 
@code{configparser.LegacyInterpolation} ha quedado obsoleto en la cadena de documentación desde Python 3.2 y no aparece en la documentación de @ref{23,,configparser}. Ahora emite un @ref{1da,,DeprecationWarning} y se eliminará en Python 3.13. Utilice @ref{7be,,configparser.BasicInterpolation} o @ref{7bf,,configparser.ExtendedInterpolation} en su lugar. (Aportado por Hugo van Kemenade en bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607}.)

@item 
El conjunto anterior de funciones @ref{7b,,importlib.resources} quedó en desuso en favor de los reemplazos agregados en Python 3.9 y se eliminará en una versión futura de Python, debido a que no admite recursos ubicados dentro de los subdirectorios del paquete:


@itemize *

@item 
@code{importlib.resources.contents()}

@item 
@code{importlib.resources.is_resource()}

@item 
@code{importlib.resources.open_binary()}

@item 
@code{importlib.resources.open_text()}

@item 
@code{importlib.resources.read_binary()}

@item 
@code{importlib.resources.read_text()}

@item 
@code{importlib.resources.path()}
@end itemize

@item 
The @ref{1d0,,locale.getdefaultlocale()} function is deprecated and will be
removed in Python 3.15. Use @ref{1d2,,locale.setlocale()},
@ref{5dc,,locale.getpreferredencoding(False)} and
@ref{1d1,,locale.getlocale()} functions instead.
(Contributed by Victor Stinner in gh-90817@footnote{https://github.com/python/cpython/issues/90817}.)

@item 
The @code{locale.resetlocale()} function is deprecated and will be
removed in Python 3.13. Use @code{locale.setlocale(locale.LC_ALL, "")} instead.
(Contributed by Victor Stinner in gh-90817@footnote{https://github.com/python/cpython/issues/90817}.)

@item 
Ahora se aplicarán reglas más estrictas para las referencias de grupos numéricos y los nombres de grupos en @ref{7c0,,regular expressions}. Ahora solo se aceptarán secuencias de dígitos ASCII como referencia numérica, y el nombre del grupo en los patrones @ref{325,,bytes} y las cadenas de reemplazo solo pueden contener letras ASCII, dígitos y guiones bajos. Por ahora, se genera una advertencia de desaprobación para la sintaxis que viola estas reglas. (Aportado por Serhiy Storchaka en gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
En el módulo @ref{b9,,re}, la función @code{re.template()} y los indicadores @code{re.TEMPLATE} y @code{re.T} correspondientes están en desuso, ya que no estaban documentados y carecían de un propósito obvio. Se eliminarán en Python 3.13. (Contribución de Serhiy Storchaka y Miro Hrončok en gh-92728@footnote{https://github.com/python/cpython/issues/92728}.)

@item 
@code{turtle.settiltangle()} has been deprecated since Python 3.1;
it now emits a deprecation warning and will be removed in Python 3.13. Use
@ref{7c1,,turtle.tiltangle()} instead (it was earlier incorrectly marked
as deprecated, and its docstring is now corrected).
(Contributed by Hugo van Kemenade in bpo-45837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45837}.)

@item 
@ref{205,,typing.Text}, que existe únicamente para proporcionar soporte de compatibilidad entre el código de Python 2 y Python 3, ahora está obsoleto. Su eliminación no está planificada actualmente, pero se recomienda a los usuarios que usen @ref{237,,str} en su lugar siempre que sea posible. (Aportado por Alex Waygood en gh-92332@footnote{https://github.com/python/cpython/issues/92332}.)

@item 
La sintaxis de argumento de palabra clave para construir tipos @ref{2ce,,typing.TypedDict} ahora está obsoleta. Se eliminará el soporte en Python 3.13. (Aportado por Jingchen Ye en gh-90224@footnote{https://github.com/python/cpython/issues/90224}.)

@item 
@code{webbrowser.MacOSX} está en desuso y se eliminará en Python 3.13. No está probado, no está documentado y no lo utiliza el propio @ref{115,,webbrowser}. (Contribución de Donghee Na en bpo-42255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42255}.)

@item 
El comportamiento de devolver un valor de los métodos de prueba @ref{4fa,,TestCase} y @ref{206,,IsolatedAsyncioTestCase} (aparte del valor @code{None} predeterminado) ahora está obsoleto.

@item 
Se descartaron las siguientes funciones @ref{106,,unittest} no documentadas formalmente, programadas para su eliminación en Python 3.13:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Utilice métodos @ref{3e2,,TestLoader} en su lugar:


@itemize *

@item 
@ref{3e3,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{3e4,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{3e5,,unittest.TestLoader.getTestCaseNames()}
@end itemize

(Aportado por Erlend E. Aasland en bpo-5846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5846}.)

@item 
@code{unittest.TestProgram.usageExit()} is marked deprecated, to be removed
in 3.13.
(Contributed by Carlos Damázio in gh-67048@footnote{https://github.com/python/cpython/issues/67048}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pending-removal}@anchor{7c2}
@node Eliminación pendiente en Python 3 12,Remoto,Obsoleto<3>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 pending-removal-in-python-3-12}@anchor{7c3}@anchor{whatsnew/3 11 whatsnew311-python-api-pending-removal}@anchor{7c4}
@subsection Eliminación pendiente en Python 3.12


Las siguientes API de Python han quedado obsoletas en versiones anteriores de Python y se eliminarán en Python 3.12.

Las API de C pendientes de eliminación son @ref{7c5,,listed separately}.


@itemize *

@item 
The @code{asynchat} module

@item 
The @code{asyncore} module

@item 
The @ref{7c6,,entire distutils package}

@item 
El módulo @code{imp}

@item 
El espacio de nombres @ref{7c7,,typing.io}

@item 
El espacio de nombres @ref{7c8,,typing.re}

@item 
@code{cgi.log()}

@item 
@code{importlib.find_loader()}

@item 
@code{importlib.abc.Loader.module_repr()}

@item 
@code{importlib.abc.MetaPathFinder.find_module()}

@item 
@code{importlib.abc.PathEntryFinder.find_loader()}

@item 
@code{importlib.abc.PathEntryFinder.find_module()}

@item 
@code{importlib.machinery.BuiltinImporter.find_module()}

@item 
@code{importlib.machinery.BuiltinLoader.module_repr()}

@item 
@code{importlib.machinery.FileFinder.find_loader()}

@item 
@code{importlib.machinery.FileFinder.find_module()}

@item 
@code{importlib.machinery.FrozenImporter.find_module()}

@item 
@code{importlib.machinery.FrozenLoader.module_repr()}

@item 
@code{importlib.machinery.PathFinder.find_module()}

@item 
@code{importlib.machinery.WindowsRegistryFinder.find_module()}

@item 
@code{importlib.util.module_for_loader()}

@item 
@code{importlib.util.set_loader_wrapper()}

@item 
@code{importlib.util.set_package_wrapper()}

@item 
@code{pkgutil.ImpImporter}

@item 
@code{pkgutil.ImpLoader}

@item 
@code{pathlib.Path.link_to()}

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode()}

@item 
@code{PYTHONTHREADDEBUG} environment variable

@item 
Los siguientes alias obsoletos en @ref{106,,unittest}:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Alias obsoleto

@tab

Nombre del método

@tab

Obsoleto en

@item

@code{failUnless}

@tab

@ref{5ca,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{5cb,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{5cc,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{5cd,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{5ce,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{5cf,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{5d0,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{5ca,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{5cc,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{5cd,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{5ce,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{5cf,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{5d1,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{5d2,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{5d3,,assertNotRegex()}

@tab

3.5

@end multitable

@end quotation
@end itemize
@anchor{whatsnew/3 11 whatsnew311-removed}@anchor{7c9}
@node Remoto,Migración a Python 3 11,Eliminación pendiente en Python 3 12,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 removed}@anchor{7ca}@anchor{whatsnew/3 11 whatsnew311-python-api-removed}@anchor{7cb}
@subsection Remoto


Esta sección enumera las API de Python que se eliminaron en Python 3.11.

Las API C eliminadas son @ref{7cc,,listed separately}.


@itemize *

@item 
Se eliminó @code{@@asyncio.coroutine()} @ref{7cd,,decorator}, lo que permite que las corrutinas basadas en generadores heredados sean compatibles con el código @ref{7ce,,async}/@ref{14e,,await}. La función ha quedado obsoleta desde Python 3.8 y la eliminación se programó inicialmente para Python 3.10. Utilice @ref{672,,async def} en su lugar. (Aportado por Illia Volochii en bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}.)

@item 
Se eliminó @code{asyncio.coroutines.CoroWrapper} utilizado para envolver objetos de corrutina basados ​​en generadores heredados en el modo de depuración. (Aportado por Illia Volochii en bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}.)

@item 
Debido a importantes problemas de seguridad, el parámetro `reuse_address' de @ref{7cf,,asyncio.loop.create_datagram_endpoint()}, deshabilitado en Python 3.9, ahora se eliminó por completo. Esto se debe al comportamiento de la opción de socket @code{SO_REUSEADDR} en UDP. (Aportado por Hugo van Kemenade en bpo-45129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45129}.)

@item 
Se eliminó el módulo @code{binhex}, obsoleto en Python 3.9. También se eliminaron las funciones @ref{11,,binascii} relacionadas y obsoletas de manera similar:


@itemize *

@item 
@code{binascii.a2b_hqx()}

@item 
@code{binascii.b2a_hqx()}

@item 
@code{binascii.rlecode_hqx()}

@item 
@code{binascii.rldecode_hqx()}
@end itemize

La función @ref{7d0,,binascii.crc_hqx()} permanece disponible.

(Aportado por Victor Stinner en bpo-45085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45085}.)

@item 
Removed the @code{distutils} @code{bdist_msi} command deprecated in Python 3.9.
Use @code{bdist_wheel} (wheel packages) instead.
(Contributed by Hugo van Kemenade in bpo-45124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45124}.)

@item 
Se eliminaron los métodos @ref{3d8,,__getitem__()} de @ref{7d1,,xml.dom.pulldom.DOMEventStream}, @ref{7d2,,wsgiref.util.FileWrapper} y @ref{7d3,,fileinput.FileInput}, obsoletos desde Python 3.9. (Aportado por Hugo van Kemenade en bpo-45132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45132}.)

@item 
Se eliminaron las funciones @ref{63,,gettext} obsoletas @code{lgettext()}, @code{ldgettext()}, @code{lngettext()} y @code{ldngettext()}. También se eliminó la función @code{bind_textdomain_codeset()}, los métodos @code{NullTranslations.output_charset()} y @code{NullTranslations.set_output_charset()}, y el parámetro `codeset' de @code{translation()} y @code{install()}, ya que solo se usan para las funciones @code{l*gettext()}. (Contribución de Donghee Na y Serhiy Storchaka en bpo-44235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44235}).

@item 
Eliminado del módulo @ref{7e,,inspect}:


@itemize *

@item 
La función @code{getargspec()}, en desuso desde Python 3.0; utilice @ref{181,,inspect.signature()} o @ref{7d4,,inspect.getfullargspec()} en su lugar.

@item 
La función @code{formatargspec()}, obsoleta desde Python 3.5; use la función @ref{181,,inspect.signature()} o el objeto @ref{332,,inspect.Signature} directamente.

@item 
Los métodos @code{Signature.from_builtin()} y @code{Signature.from_function()} no documentados, obsoletos desde Python 3.5; utilice el método @ref{7d5,,Signature.from_callable()} en su lugar.
@end itemize

(Aportado por Hugo van Kemenade en bpo-45320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45320}.)

@item 
Se eliminó el método @ref{7d6,,__class_getitem__()} de @ref{54e,,pathlib.PurePath}, porque no se usó y se agregó por error en versiones anteriores. (Aportado por Nikita Sobolev en bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483}.)

@item 
Removed the @code{MailmanProxy} class in the @code{smtpd} module,
as it is unusable without the external @code{mailman} package.
(Contributed by Donghee Na in bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}.)

@item 
Se eliminó el método obsoleto @code{split()} de @code{_tkinter.TkappType}. (Aportado por Erlend E. Aasland en bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}.)

@item 
Se eliminó la compatibilidad con el paquete de espacio de nombres del descubrimiento @ref{106,,unittest}. Se introdujo en Python 3.4 pero se rompió desde Python 3.7. (Aportado por Inada Naoki en bpo-23882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23882}.)

@item 
Removed the undocumented private @code{float.__set_format__()} method,
previously known as @code{float.__setformat__()} in Python 3.7.
Its docstring said: «You probably don’t want to use this function.
It exists mainly to be used in Python’s test suite.»
(Contributed by Victor Stinner in bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}.)

@item 
El indicador de configuración @code{--experimental-isolated-subinterpreters} (y la macro @code{EXPERIMENTAL_ISOLATED_SUBINTERPRETERS} correspondiente) se han eliminado.

@item 
Pynche@footnote{https://pypi.org/project/Pynche/}
— The Pythonically Natural Color and Hue Editor — has been moved out
of @code{Tools/scripts} and is being developed independently@footnote{https://gitlab.com/warsaw/pynche/-/tree/main} from the Python source tree.
@end itemize
@anchor{whatsnew/3 11 whatsnew311-porting}@anchor{7d7}
@node Migración a Python 3 11,Construir cambios,Remoto,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 porting-to-python-3-11}@anchor{7d8}@anchor{whatsnew/3 11 whatsnew311-python-api-porting}@anchor{7d9}
@subsection Migración a Python 3.11


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores en la API de Python que pueden requerir cambios en su código de Python.

Las notas de portabilidad para la API de C son @ref{7da,,listed separately}.


@itemize *

@item 
@ref{1be,,open()}, @ref{5c0,,io.open()}, @ref{7db,,codecs.open()} y @ref{7d3,,fileinput.FileInput} ya no aceptan @code{'U'} («nueva línea universal») en el modo de archivo. En Python 3, el modo «nueva línea universal» se usa de forma predeterminada cada vez que se abre un archivo en modo de texto, y el indicador @code{'U'} ha quedado obsoleto desde Python 3.3. El @ref{7dc,,newline parameter} para estas funciones controla cómo funcionan las nuevas líneas universales. (Aportado por Victor Stinner en bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}.)

@item 
Las posiciones de los nodos @ref{30d,,ast.AST} ahora se validan cuando se proporcionan a @ref{2fb,,compile()} y otras funciones relacionadas. Si se detectan posiciones no válidas, se generará un @ref{360,,ValueError}. (Aportado por Pablo Galindo en gh-93351@footnote{https://github.com/python/cpython/issues/93351})

@item 
Prohibido pasar ejecutores que no sean @ref{7dd,,concurrent.futures.ThreadPoolExecutor} a @ref{7de,,asyncio.loop.set_default_executor()} luego de una obsolescencia en Python 3.8. (Aportado por Illia Volochii en bpo-43234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43234}.)

@item 
@ref{15,,calendar}: las clases @ref{7df,,calendar.LocaleTextCalendar} y @ref{7e0,,calendar.LocaleHTMLCalendar} ahora usan @ref{1d1,,locale.getlocale()}, en lugar de usar @ref{1d0,,locale.getdefaultlocale()}, si no se especifica una configuración regional. (Aportado por Victor Stinner en bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}.)

@item 
El módulo @ref{a5,,pdb} ahora lee el archivo de configuración @code{.pdbrc} con la codificación @code{'UTF-8'}. (Contribuido por Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) en bpo-41137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41137}.)

@item 
El parámetro `population' de @ref{7e1,,random.sample()} debe ser una secuencia y ya no se admite la conversión automática de @ref{67a,,set}s a @ref{18e,,list}s. Además, si el tamaño de la muestra es mayor que el tamaño de la población, se genera un @ref{360,,ValueError}. (Aportado por Raymond Hettinger en bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}.)

@item 
Se eliminó el parámetro opcional `random' de @ref{7e2,,random.shuffle()}. Anteriormente, era una función aleatoria arbitraria para usar en la reproducción aleatoria; ahora, siempre se utilizará @ref{7e3,,random.random()} (su valor predeterminado anterior).

@item 
En @ref{b9,,re} @ref{7c0,,Sintaxis de expresiones regulares}, las banderas en línea globales (por ejemplo, @code{(?i)}) ahora solo se pueden usar al comienzo de las expresiones regulares. Su uso en otros lugares ha quedado obsoleto desde Python 3.6. (Aportado por Serhiy Storchaka en bpo-47066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47066}.)

@item 
En el módulo @ref{b9,,re}, se corrigieron varios errores antiguos que, en casos excepcionales, podían hacer que los grupos de captura obtuvieran un resultado incorrecto. Por lo tanto, esto podría cambiar la salida capturada en estos casos. (Contribuido por Ma Lin en bpo-35859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35859}.)
@end itemize

@node Construir cambios,Cambios en la API de C<2>,Migración a Python 3 11,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 build-changes}@anchor{7e4}@anchor{whatsnew/3 11 whatsnew311-build-changes}@anchor{7e5}
@subsection Construir cambios



@itemize *

@item 
CPython ahora tiene 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 
@geindex Python Enhancement Proposals; PEP 11#tier-3
Tier 3 support@footnote{https://peps.python.org/pep-0011/#tier-3} para la compilación cruzada en las plataformas WebAssembly@footnote{https://webassembly.org/} Emscripten@footnote{https://emscripten.org/} (@code{wasm32-unknown-emscripten}, es decir, Python en el navegador) y WebAssembly System Interface (WASI)@footnote{https://wasi.dev/} (@code{wasm32-unknown-wasi}). El esfuerzo está inspirado en trabajos anteriores como Pyodide@footnote{https://pyodide.org/}. Estas plataformas proporcionan un subconjunto limitado de API POSIX; Las funciones y módulos de las bibliotecas estándar de Python relacionadas con redes, procesos, subprocesos, señales, mmap y usuarios/grupos no están disponibles o no funcionan. (Escritos aportados por Christian Heimes y Ethan Smith en gh-84461@footnote{https://github.com/python/cpython/issues/84461} y WASI aportados por Christian Heimes en gh-90473@footnote{https://github.com/python/cpython/issues/90473}; plataformas promocionadas en gh-95085@footnote{https://github.com/python/cpython/issues/95085})

@item 
Construir CPython ahora requiere:


@itemize *

@item 
Un compilador C11@footnote{https://en.cppreference.com/w/c/11} y una biblioteca estándar. Optional C11 features@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features} no son necesarios. (Aportado por Victor Stinner en bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}, bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440} y bpo-46640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46640}.)

@item 
Support for IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754}
floating-point numbers.
(Contributed by Victor Stinner in bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}.)
@end itemize

@item 
La macro @code{Py_NO_NAN} ha sido eliminada. Dado que CPython ahora requiere flotantes IEEE 754, los valores NaN siempre están disponibles. (Contribución de Victor Stinner en bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}.)

@item 
El paquete @ref{f0,,tkinter} ahora requiere Tcl/Tk@footnote{https://www.tcl.tk} versión 8.5.12 o posterior. (Aportado por Serhiy Storchaka en bpo-46996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46996}.)

@item 
Las dependencias de compilación, los indicadores del compilador y los indicadores del vinculador para la mayoría de los módulos de extensión stdlib ahora son detectados por @code{configure}. pkg-config@footnote{https://www.freedesktop.org/wiki/Software/pkg-config/} detecta los indicadores libffi, libnsl, libsqlite3, zlib, bzip2, liblzma, libcrypt, Tcl/Tk y uuid (si están disponibles). @ref{f0,,tkinter} ahora requiere un comando pkg-config para detectar configuraciones de desarrollo para encabezados y bibliotecas Tcl/Tk@footnote{https://www.tcl.tk}. (Aportado por Christian Heimes y Erlend Egeberg Aasland en bpo-45847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45847}, bpo-45747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45747} y bpo-45763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45763}).

@item 
libpython ya no está vinculado con libcrypt. (Aportado por Mike Gilbert en bpo-45433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45433}.)

@item 
CPython ahora se puede construir con la opción ThinLTO@footnote{https://clang.llvm.org/docs/ThinLTO.html} pasando @code{thin} a @ref{7e6,,--with-lto}, es decir, @code{--with-lto=thin}. (Contribución de Donghee Na y Brett Holman en bpo-44340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44340}).

@item 
Freelists for object structs can now be disabled. A new @code{configure}
option @code{--without-freelists} can be used to disable all freelists
except empty tuple singleton.
(Contributed by Christian Heimes in bpo-45522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45522}.)

@item 
@code{Modules/Setup} y @code{Modules/makesetup} se han mejorado y atado. Los módulos de extensión ahora se pueden construir a través de @code{makesetup}. Todos, excepto algunos módulos de prueba, se pueden vincular estáticamente a una biblioteca o binario principal. (Aportado por Brett Cannon y Christian Heimes en bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}, bpo-45570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45570}, bpo-45571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45571} y bpo-43974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43974}).

@cartouche
@quotation Nota 
Utilice las variables de entorno @code{TCLTK_CFLAGS} y @code{TCLTK_LIBS} para especificar manualmente la ubicación de los encabezados y bibliotecas Tcl/Tk. Se han eliminado las opciones @code{configure} @code{--with-tcltk-includes} y @code{--with-tcltk-libs}.

En RHEL 7 y CentOS 7, los paquetes de desarrollo no proporcionan @code{tcl.pc} y @code{tk.pc}; usa @code{TCLTK_LIBS="-ltk8.5 -ltkstub8.5 -ltcl8.5"}. El directorio @code{Misc/rhel7} contiene archivos @code{.pc} e instrucciones sobre cómo compilar Python con Tcl/Tk y OpenSSL de RHEL 7 y CentOS 7.
@end quotation
@end cartouche

@item 
CPython ahora usará dígitos de 30 bits de manera predeterminada para la implementación de Python @ref{1f0,,int}. Anteriormente, el valor predeterminado era usar dígitos de 30 bits en plataformas con @code{SIZEOF_VOID_P >= 8} y dígitos de 15 bits en caso contrario. Todavía es posible solicitar explícitamente el uso de dígitos de 15 bits a través de la opción @ref{7e7,,--enable-big-digits} en el script de configuración o (para Windows) la variable @code{PYLONG_BITS_IN_DIGIT} en @code{PC/pyconfig.h}, pero es posible que esta opción se elimine en algún momento en el futuro. (Contribuido por Mark Dickinson en bpo-45569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45569}.)
@end itemize

@node Cambios en la API de C<2>,Notable changes in 3 11 4,Construir cambios,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 c-api-changes}@anchor{7e8}@anchor{whatsnew/3 11 whatsnew311-c-api}@anchor{7e9}
@subsection Cambios en la API de C


@menu
* Nuevas características: Nuevas características<4>. 
* Migración a Python 3.11: Migración a Python 3 11<2>. 
* Obsoleto: Obsoleto<4>. 
* Eliminación pendiente en Python 3.12: Eliminación pendiente en Python 3 12<2>. 
* Remoto: Remoto<2>. 

@end menu

@node Nuevas características<4>,Migración a Python 3 11<2>,,Cambios en la API de C<2>
@anchor{whatsnew/3 11 id5}@anchor{7ea}@anchor{whatsnew/3 11 whatsnew311-c-api-new-features}@anchor{7eb}
@subsubsection Nuevas características



@itemize *

@item 
Agregue una nueva función @ref{7ec,,PyType_GetName()} para obtener el nombre corto del tipo. (Aportado por Hai Shi en bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}.)

@item 
Agregue una nueva función @ref{7ed,,PyType_GetQualName()} para obtener el nombre completo del tipo. (Aportado por Hai Shi en bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}.)

@item 
Agregue nuevas funciones @ref{7ee,,PyThreadState_EnterTracing()} y @ref{7ef,,PyThreadState_LeaveTracing()} a la API de C limitada para suspender y reanudar el seguimiento y la creación de perfiles. (Aportado por Victor Stinner en bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}.)

@item 
Se agregó la constante @ref{7f0,,Py_Version} que tiene el mismo valor que @ref{7f1,,PY_VERSION_HEX}. (Aportado por Gabriele N. Tornetta en bpo-43931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43931}.)

@item 
@ref{7f2,,Py_buffer} y las API ahora forman parte de la API limitada y la ABI estable:


@itemize *

@item 
@ref{48b,,PyObject_CheckBuffer()}

@item 
@ref{48c,,PyObject_GetBuffer()}

@item 
@ref{7f3,,PyBuffer_GetPointer()}

@item 
@ref{7f4,,PyBuffer_SizeFromFormat()}

@item 
@ref{7f5,,PyBuffer_ToContiguous()}

@item 
@ref{7f6,,PyBuffer_FromContiguous()}

@item 
@ref{7f7,,PyObject_CopyData()}

@item 
@ref{7f8,,PyBuffer_IsContiguous()}

@item 
@ref{7f9,,PyBuffer_FillContiguousStrides()}

@item 
@ref{7fa,,PyBuffer_FillInfo()}

@item 
@ref{48d,,PyBuffer_Release()}

@item 
@ref{7fb,,PyMemoryView_FromBuffer()}

@item 
Ranuras de tipo @ref{7fc,,bf_getbuffer} y @ref{7fd,,bf_releasebuffer}
@end itemize

(Aportado por Christian Heimes en bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}.)

@item 
Se agregó la función @ref{486,,PyType_GetModuleByDef()}, utilizada para obtener el módulo en el que se definió un método, en los casos en que esta información no esté disponible directamente (a través de @ref{7fe,,PyCMethod}). (Aportado por Petr Viktorin en bpo-46613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46613}.)

@item 
Agrega nuevas funciones para empaquetar y desempaquetar C doble (serializar y deserializar): @ref{7ff,,PyFloat_Pack2()}, @ref{800,,PyFloat_Pack4()}, @ref{801,,PyFloat_Pack8()}, @ref{802,,PyFloat_Unpack2()}, @ref{803,,PyFloat_Unpack4()} y @ref{804,,PyFloat_Unpack8()}. (Aportado por Victor Stinner en bpo-46906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46906}.)

@item 
Agregue nuevas funciones para obtener atributos de objetos de marco: @ref{805,,PyFrame_GetBuiltins()}, @ref{806,,PyFrame_GetGenerator()}, @ref{807,,PyFrame_GetGlobals()}, @ref{808,,PyFrame_GetLasti()}.

@item 
Se agregaron dos funciones nuevas para obtener y configurar la instancia de excepción activa: @ref{809,,PyErr_GetHandledException()} y @ref{80a,,PyErr_SetHandledException()}. Estas son alternativas a @ref{80b,,PyErr_SetExcInfo()} y @ref{80c,,PyErr_GetExcInfo()} que funcionan con la representación de excepciones heredada de 3 tuplas. (Aportado por Irit Katriel en bpo-46343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46343}.)

@item 
Se agregó el miembro @ref{80d,,PyConfig.safe_path}. (Aportado por Victor Stinner en gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)
@end itemize

@node Migración a Python 3 11<2>,Obsoleto<4>,Nuevas características<4>,Cambios en la API de C<2>
@anchor{whatsnew/3 11 id6}@anchor{80e}@anchor{whatsnew/3 11 whatsnew311-c-api-porting}@anchor{7da}
@subsubsection Migración a Python 3.11

@anchor{whatsnew/3 11 whatsnew311-pep670}@anchor{64f}

@itemize *

@item 
Algunas macros se han convertido en funciones estáticas en línea para evitar macro pitfalls@footnote{https://gcc.gnu.org/onlinedocs/cpp/Macro-Pitfalls.html}. El cambio debería ser en su mayoría transparente para los usuarios, ya que las funciones de reemplazo emitirán sus argumentos a los tipos esperados para evitar advertencias del compilador debido a comprobaciones de tipos estáticos. Sin embargo, cuando la API de C limitada se establece en >=3.11, estas conversiones no se realizan y las personas que llaman deberán convertir argumentos a sus tipos esperados. Ver 
@geindex Python Enhancement Proposals; PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/} para más detalles. (Aportado por Victor Stinner y Erlend E. Aasland en gh-89653@footnote{https://github.com/python/cpython/issues/89653}.)

@item 
@ref{80b,,PyErr_SetExcInfo()} ya no usa los argumentos @code{type} y @code{traceback}, el intérprete ahora deriva esos valores de la instancia de excepción (el argumento @code{value}). La función aún roba referencias de los tres argumentos. (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
@ref{80c,,PyErr_GetExcInfo()} ahora deriva los campos @code{type} y @code{traceback} del resultado de la instancia de excepción (el campo @code{value}). (Aportado por Irit Katriel en bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
@ref{80f,,_frozen} tiene un nuevo campo @code{is_package} para indicar si el módulo congelado es o no un paquete. Anteriormente, un valor negativo en el campo @code{size} era el indicador. Ahora solo se pueden usar valores no negativos para @code{size}. (Aportado por Kumar Aditya en bpo-46608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46608}.)

@item 
@ref{810,,_PyFrameEvalFunction()} ahora toma @code{_PyInterpreterFrame*} como su segundo parámetro, en lugar de @code{PyFrameObject*}. Consulte 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} para obtener más detalles sobre cómo usar este tipo de puntero de función.

@item 
@code{PyCode_New()} and @code{PyCode_NewWithPosOnlyArgs()} now take
an additional @code{exception_table} argument.
Using these functions should be avoided, if at all possible.
To get a custom code object: create a code object using the compiler,
then get a modified version with the @code{replace} method.

@item 
@ref{811,,PyCodeObject} ya no tiene los campos @code{co_code}, @code{co_varnames}, @code{co_cellvars} y @code{co_freevars}. En su lugar, utilice @ref{812,,PyCode_GetCode()}, @ref{813,,PyCode_GetVarnames()}, @ref{814,,PyCode_GetCellvars()} y @ref{815,,PyCode_GetFreevars()} respectivamente para acceder a ellos a través de la API de C. (Aportado por Brandt Bucher en bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841} y Ken Jin en gh-92154@footnote{https://github.com/python/cpython/issues/92154} y gh-94936@footnote{https://github.com/python/cpython/issues/94936}).

@item 
Las antiguas macros de papelera (@code{Py_TRASHCAN_SAFE_BEGIN}/@code{Py_TRASHCAN_SAFE_END}) ahora están obsoletas. Deberían ser reemplazadas por las nuevas macros @code{Py_TRASHCAN_BEGIN} y @code{Py_TRASHCAN_END}.

Una función tp_dealloc que tiene las macros antiguas, como:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

debe migrar a las nuevas macros de la siguiente manera:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, mytype_dealloc)
    ...
    Py_TRASHCAN_END
@}
@end example

Tenga en cuenta que @code{Py_TRASHCAN_BEGIN} tiene un segundo argumento que debería ser la función de desasignación en la que se encuentra.

Para admitir versiones anteriores de Python en la misma base de código, puede definir las siguientes macros y usarlas en todo el código (crédito: se copiaron de la base de código @code{mypy}):

@example
#if PY_VERSION_HEX >= 0x03080000
#  define CPy_TRASHCAN_BEGIN(op, dealloc) Py_TRASHCAN_BEGIN(op, dealloc)
#  define CPy_TRASHCAN_END(op) Py_TRASHCAN_END
#else
#  define CPy_TRASHCAN_BEGIN(op, dealloc) Py_TRASHCAN_SAFE_BEGIN(op)
#  define CPy_TRASHCAN_END(op) Py_TRASHCAN_SAFE_END(op)
#endif
@end example

@item 
La función @ref{816,,PyType_Ready()} ahora genera un error si un tipo se define con el indicador @ref{817,,Py_TPFLAGS_HAVE_GC} establecido pero no tiene función transversal (@ref{818,,PyTypeObject.tp_traverse}). (Aportado por Victor Stinner en bpo-44263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44263}.)

@item 
Los tipos de montón con el indicador @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} ahora pueden heredar el protocolo de llamada vectorial 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}. Anteriormente, esto sólo era posible para @ref{819,,static types}. (Aportado por Erlend E. Aasland en bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908})

@item 
Dado que @ref{26e,,Py_TYPE()} se cambia a una función estática en línea, @code{Py_TYPE(obj) = new_type} debe reemplazarse por @code{Py_SET_TYPE(obj, new_type)}: consulte la función @ref{81a,,Py_SET_TYPE()} (disponible desde Python 3.9). Para compatibilidad con versiones anteriores, se puede usar esta macro:

@example
#if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_TYPE)
static inline void _Py_SET_TYPE(PyObject *ob, PyTypeObject *type)
@{ ob->ob_type = type; @}
#define Py_SET_TYPE(ob, type) _Py_SET_TYPE((PyObject*)(ob), type)
#endif
@end example

(Aportado por Victor Stinner en bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
Dado que @ref{81b,,Py_SIZE()} se cambia a una función estática en línea, @code{Py_SIZE(obj) = new_size} debe reemplazarse por @code{Py_SET_SIZE(obj, new_size)}: consulte la función @ref{81c,,Py_SET_SIZE()} (disponible desde Python 3.9). Para compatibilidad con versiones anteriores, se puede usar esta macro:

@example
#if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_SIZE)
static inline void _Py_SET_SIZE(PyVarObject *ob, Py_ssize_t size)
@{ ob->ob_size = size; @}
#define Py_SET_SIZE(ob, size) _Py_SET_SIZE((PyVarObject*)(ob), size)
#endif
@end example

(Aportado por Victor Stinner en bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
@code{<Python.h>} ya no incluye los archivos de encabezado @code{<stdlib.h>}, @code{<stdio.h>}, @code{<errno.h>} y @code{<string.h>} cuando la macro @code{Py_LIMITED_API} se establece en @code{0x030b0000} (Python 3.11) o superior. Las extensiones de C deben incluir explícitamente los archivos de encabezado después de @code{#include <Python.h>}. (Aportado por Victor Stinner en bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}.)

@item 
Los archivos de API no limitados @code{cellobject.h}, @code{classobject.h}, @code{code.h}, @code{context.h}, @code{funcobject.h}, @code{genobject.h} y @code{longintrepr.h} se han movido al directorio @code{Include/cpython}. Además, se eliminó el archivo de encabezado @code{eval.h}. Estos archivos no deben incluirse directamente, ya que ya están incluidos en @code{Python.h}: @ref{81d,,Include Files}. Si se han incluido directamente, considere incluir @code{Python.h} en su lugar. (Aportado por Victor Stinner en bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
The @code{PyUnicode_CHECK_INTERNED()} macro has been excluded from the
limited C API. It was never usable there, because it used internal structures
which are not available in the limited C API.
(Contributed by Victor Stinner in bpo-46007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46007}.)

@item 
Las siguientes funciones y tipos de cuadros ahora están disponibles directamente con @code{#include <Python.h>}, ya no es necesario agregar @code{#include <frameobject.h>}:


@itemize *

@item 
@ref{81e,,PyFrame_Check()}

@item 
@ref{81f,,PyFrame_GetBack()}

@item 
@ref{805,,PyFrame_GetBuiltins()}

@item 
@ref{806,,PyFrame_GetGenerator()}

@item 
@ref{807,,PyFrame_GetGlobals()}

@item 
@ref{808,,PyFrame_GetLasti()}

@item 
@ref{4dd,,PyFrame_GetLocals()}

@item 
@ref{820,,PyFrame_Type}
@end itemize

(Aportado por Victor Stinner en gh-93937@footnote{https://github.com/python/cpython/issues/93937}.)
@end itemize
@anchor{whatsnew/3 11 pyframeobject-3-11-hiding}@anchor{821}

@itemize *

@item 
Los miembros de la estructura @ref{822,,PyFrameObject} se han eliminado de la API de C pública.

Si bien la documentación señala que los campos @ref{822,,PyFrameObject} están sujetos a cambios en cualquier momento, se han mantenido estables durante mucho tiempo y se usaron en varias extensiones populares.

En Python 3.11, la estructura del marco se reorganizó para permitir optimizaciones de rendimiento. Algunos campos se eliminaron por completo, ya que eran detalles de la implementación anterior.

Campos @ref{822,,PyFrameObject}:


@itemize *

@item 
@code{f_back}: usa @ref{81f,,PyFrame_GetBack()}.

@item 
@code{f_blockstack}: eliminado.

@item 
@code{f_builtins}: usa @ref{805,,PyFrame_GetBuiltins()}.

@item 
@code{f_code}: usa @ref{823,,PyFrame_GetCode()}.

@item 
@code{f_gen}: usa @ref{806,,PyFrame_GetGenerator()}.

@item 
@code{f_globals}: usa @ref{807,,PyFrame_GetGlobals()}.

@item 
@code{f_iblock}: eliminado.

@item 
@code{f_lasti}: usa @ref{808,,PyFrame_GetLasti()}. El código que usa @code{f_lasti} con @code{PyCode_Addr2Line()} debería usar @ref{824,,PyFrame_GetLineNumber()} en su lugar; puede ser más rápido.

@item 
@code{f_lineno}: usar @ref{824,,PyFrame_GetLineNumber()}

@item 
@code{f_locals}: usa @ref{4dd,,PyFrame_GetLocals()}.

@item 
@code{f_stackdepth}: eliminado.

@item 
@code{f_state}: sin API pública (renombrado como @code{f_frame.f_state}).

@item 
@code{f_trace}: sin API pública.

@item 
@code{f_trace_lines}: utiliza @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_lines")}.

@item 
@code{f_trace_opcodes}: utiliza @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_opcodes")}.

@item 
@code{f_localsplus}: sin API pública (renombrado como @code{f_frame.localsplus}).

@item 
@code{f_valuestack}: eliminado.
@end itemize

The Python frame object is now created lazily. A side effect is that the
@ref{825,,f_back} member must not be accessed directly,
since its value is now also
computed lazily. The @ref{81f,,PyFrame_GetBack()} function must be called
instead.

Debuggers that accessed the @ref{2ed,,f_locals} directly `must' call
@ref{4dd,,PyFrame_GetLocals()} instead. They no longer need to call
@code{PyFrame_FastToLocalsWithError()} or @code{PyFrame_LocalsToFast()},
in fact they should not call those functions. The necessary updating of the
frame is now managed by the virtual machine.

Código que define @code{PyFrame_GetCode()} en Python 3.8 y anteriores:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyCodeObject* PyFrame_GetCode(PyFrameObject *frame)
@{
    Py_INCREF(frame->f_code);
    return frame->f_code;
@}
#endif
@end example

Código que define @code{PyFrame_GetBack()} en Python 3.8 y anteriores:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyFrameObject* PyFrame_GetBack(PyFrameObject *frame)
@{
    Py_XINCREF(frame->f_back);
    return frame->f_back;
@}
#endif
@end example

O use pythoncapi_compat project@footnote{https://github.com/python/pythoncapi-compat} para obtener estas dos funciones en versiones anteriores de Python.

@item 
Cambios de los miembros de la estructura @ref{826,,PyThreadState}:


@itemize *

@item 
@code{frame}: eliminado, use @ref{827,,PyThreadState_GetFrame()} (función agregada a Python 3.9 por bpo-40429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40429}). Advertencia: la función devuelve un @ref{431,,strong reference}, necesita llamar a @ref{828,,Py_XDECREF()}.

@item 
@code{tracing}: cambiado, use @ref{7ee,,PyThreadState_EnterTracing()} y @ref{7ef,,PyThreadState_LeaveTracing()} (funciones agregadas a Python 3.11 por bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}).

@item 
@code{recursion_depth}: eliminado, use @code{(tstate->recursion_limit - tstate->recursion_remaining)} en su lugar.

@item 
@code{stackcheck_counter}: eliminado.
@end itemize

Código que define @code{PyThreadState_GetFrame()} en Python 3.8 y anteriores:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyFrameObject* PyThreadState_GetFrame(PyThreadState *tstate)
@{
    Py_XINCREF(tstate->frame);
    return tstate->frame;
@}
#endif
@end example

Código que define @code{PyThreadState_EnterTracing()} y @code{PyThreadState_LeaveTracing()} en Python 3.10 y versiones anteriores:

@example
#if PY_VERSION_HEX < 0x030B00A2
static inline void PyThreadState_EnterTracing(PyThreadState *tstate)
@{
    tstate->tracing++;
#if PY_VERSION_HEX >= 0x030A00A1
    tstate->cframe->use_tracing = 0;
#else
    tstate->use_tracing = 0;
#endif
@}

static inline void PyThreadState_LeaveTracing(PyThreadState *tstate)
@{
    int use_tracing = (tstate->c_tracefunc != NULL || tstate->c_profilefunc != NULL);
    tstate->tracing--;
#if PY_VERSION_HEX >= 0x030A00A1
    tstate->cframe->use_tracing = use_tracing;
#else
    tstate->use_tracing = use_tracing;
#endif
@}
#endif
@end example

O use the pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat} para obtener estas funciones en funciones antiguas de Python.

@item 
Se alienta a los distribuidores a compilar Python con la biblioteca Blake2 optimizada libb2@footnote{https://www.blake2.net/}.

@item 
El campo @ref{68f,,PyConfig.module_search_paths_set} ahora debe establecerse en 1 para que la inicialización use @ref{495,,PyConfig.module_search_paths} para inicializar @ref{27e,,sys.path}. De lo contrario, la inicialización volverá a calcular la ruta y reemplazará los valores agregados a @code{module_search_paths}.

@item 
@ref{829,,PyConfig_Read()} ya no calcula la ruta de búsqueda inicial y no completará ningún valor en @ref{495,,PyConfig.module_search_paths}. Para calcular rutas predeterminadas y luego modificarlas, finalice la inicialización y use @ref{47b,,PySys_GetObject()} para recuperar @ref{27e,,sys.path} como un objeto de lista de Python y modificarlo directamente.
@end itemize

@node Obsoleto<4>,Eliminación pendiente en Python 3 12<2>,Migración a Python 3 11<2>,Cambios en la API de C<2>
@anchor{whatsnew/3 11 id7}@anchor{82a}@anchor{whatsnew/3 11 whatsnew311-c-api-deprecated}@anchor{7b6}
@subsubsection Obsoleto



@itemize *

@item 
Deseche las siguientes funciones para configurar la inicialización de Python:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{PySys_SetArgvEx()}

@item 
@code{PySys_SetArgv()}

@item 
@code{PySys_SetPath()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

Utilice la nueva API @ref{499,,PyConfig} de @ref{49a,,Python Initialization Configuration} en su lugar (
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}). (Aportado por Victor Stinner en gh-88279@footnote{https://github.com/python/cpython/issues/88279}.)

@item 
Deje obsoleto el miembro @code{ob_shash} de @ref{82b,,PyBytesObject}. Utilice @ref{29a,,PyObject_Hash()} en su lugar. (Aportado por Inada Naoki en bpo-46864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46864}.)
@end itemize

@node Eliminación pendiente en Python 3 12<2>,Remoto<2>,Obsoleto<4>,Cambios en la API de C<2>
@anchor{whatsnew/3 11 id8}@anchor{82c}@anchor{whatsnew/3 11 whatsnew311-c-api-pending-removal}@anchor{7c5}
@subsubsection Eliminación pendiente en Python 3.12


Las siguientes API de C quedaron obsoletas en versiones anteriores de Python y se eliminarán en Python 3.12.


@itemize *

@item 
@code{PyUnicode_AS_DATA()}

@item 
@code{PyUnicode_AS_UNICODE()}

@item 
@code{PyUnicode_AsUnicodeAndSize()}

@item 
@code{PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_FromUnicode()}

@item 
@code{PyUnicode_GET_DATA_SIZE()}

@item 
@code{PyUnicode_GET_SIZE()}

@item 
@code{PyUnicode_GetSize()}

@item 
@code{PyUnicode_IS_COMPACT()}

@item 
@code{PyUnicode_IS_READY()}

@item 
@ref{298,,PyUnicode_READY()}

@item 
@code{Py_UNICODE_WSTR_LENGTH()}

@item 
@code{_PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_WCHAR_KIND}

@item 
@ref{82d,,PyUnicodeObject}

@item 
@code{PyUnicode_InternImmortal()}
@end itemize

@node Remoto<2>,,Eliminación pendiente en Python 3 12<2>,Cambios en la API de C<2>
@anchor{whatsnew/3 11 id9}@anchor{82e}@anchor{whatsnew/3 11 whatsnew311-c-api-removed}@anchor{7cc}
@subsubsection Remoto



@itemize *

@item 
Se han eliminado @code{PyFrame_BlockSetup()} y @code{PyFrame_BlockPop()}. (Aportado por Mark Shannon en bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}.)

@item 
Quite las siguientes macros matemáticas usando la variable @code{errno}:


@itemize *

@item 
@code{Py_ADJUST_ERANGE1()}

@item 
@code{Py_ADJUST_ERANGE2()}

@item 
@code{Py_OVERFLOWED()}

@item 
@code{Py_SET_ERANGE_IF_OVERFLOW()}

@item 
@code{Py_SET_ERRNO_ON_MATH_ERROR()}
@end itemize

(Aportado por Victor Stinner en bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}.)

@item 
Elimine las macros @code{Py_UNICODE_COPY()} y @code{Py_UNICODE_FILL()}, obsoletas desde Python 3.3. Utilice @code{PyUnicode_CopyCharacters()} o @code{memcpy()} (cadena @code{wchar_t*}) y las funciones @code{PyUnicode_Fill()} en su lugar. (Aportado por Victor Stinner en bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}.)

@item 
Elimine el archivo de encabezado @code{pystrhex.h}. Solo contiene funciones privadas. Las extensiones C solo deben incluir el archivo de encabezado principal @code{<Python.h>}. (Aportado por Victor Stinner en bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}.)

@item 
Quite la macro @code{Py_FORCE_DOUBLE()}. Fue utilizado por la macro @code{Py_IS_INFINITY()}. (Aportado por Victor Stinner en bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}.)

@item 
Los siguientes elementos ya no están disponibles cuando se define @ref{4dc,,Py_LIMITED_API}:


@itemize *

@item 
@ref{82f,,PyMarshal_WriteLongToFile()}

@item 
@ref{830,,PyMarshal_WriteObjectToFile()}

@item 
@ref{831,,PyMarshal_ReadObjectFromString()}

@item 
@ref{832,,PyMarshal_WriteObjectToString()}

@item 
la macro @code{Py_MARSHAL_VERSION}
@end itemize

Estos no forman parte del @ref{833,,limited API}.

(Aportado por Victor Stinner en bpo-45474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45474}.)

@item 
Exclude @ref{275,,PyWeakref_GET_OBJECT()} from the limited C API. It never
worked since the @code{PyWeakReference} structure is opaque in the
limited C API.
(Contributed by Victor Stinner in bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
Quite la macro @code{PyHeapType_GET_MEMBERS()}. Fue expuesto en la API pública de C por error, solo debe ser utilizado por Python internamente. Utilice el miembro @code{PyTypeObject.tp_members} en su lugar. (Aportado por Victor Stinner en bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}.)

@item 
Elimine la macro @code{HAVE_PY_SET_53BIT_PRECISION} (movida a la API de C interna). (Aportado por Victor Stinner en bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pep624}@anchor{64e}

@itemize *

@item 
Elimine las API del codificador @ref{277,,Py_UNICODE}, ya que han quedado obsoletas desde Python 3.3, se usan poco y son ineficientes en relación con las alternativas recomendadas.

Las funciones eliminadas son:


@itemize *

@item 
@code{PyUnicode_Encode()}

@item 
@code{PyUnicode_EncodeASCII()}

@item 
@code{PyUnicode_EncodeLatin1()}

@item 
@code{PyUnicode_EncodeUTF7()}

@item 
@code{PyUnicode_EncodeUTF8()}

@item 
@code{PyUnicode_EncodeUTF16()}

@item 
@code{PyUnicode_EncodeUTF32()}

@item 
@code{PyUnicode_EncodeUnicodeEscape()}

@item 
@code{PyUnicode_EncodeRawUnicodeEscape()}

@item 
@code{PyUnicode_EncodeCharmap()}

@item 
@code{PyUnicode_TranslateCharmap()}

@item 
@code{PyUnicode_EncodeDecimal()}

@item 
@code{PyUnicode_TransformDecimalToASCII()}
@end itemize

Ver 
@geindex Python Enhancement Proposals; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/} para más detalles y 
@geindex Python Enhancement Proposals; PEP 624#alternative-apis
migration guidance@footnote{https://peps.python.org/pep-0624/#alternative-apis}. (Aportado por Inada Naoki en bpo-44029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44029}.)
@end itemize

@node Notable changes in 3 11 4,Notable changes in 3 11 5,Cambios en la API de C<2>,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 notable-changes-in-3-11-4}@anchor{834}
@subsection Notable changes in 3.11.4


@menu
* tarfile:: 

@end menu

@node tarfile,,,Notable changes in 3 11 4
@anchor{whatsnew/3 11 tarfile}@anchor{835}
@subsubsection tarfile



@itemize *

@item 
The extraction methods in @ref{de,,tarfile}, and @ref{516,,shutil.unpack_archive()},
have a new a `filter' argument that allows limiting tar features than may be
surprising or dangerous, such as creating files outside the destination
directory.
See @ref{517,,Extraction filters} for details.
In Python 3.12, use without the `filter' argument will show a
@ref{1da,,DeprecationWarning}.
In Python 3.14, the default will switch to @code{'data'}.
(Contributed by Petr Viktorin in 
@geindex Python Enhancement Proposals; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node Notable changes in 3 11 5,,Notable changes in 3 11 4,Qué hay de nuevo en Python 3 11
@anchor{whatsnew/3 11 notable-changes-in-3-11-5}@anchor{836}
@subsection Notable changes in 3.11.5


@menu
* OpenSSL:: 

@end menu

@node OpenSSL,,,Notable changes in 3 11 5
@anchor{whatsnew/3 11 openssl}@anchor{837}
@subsubsection OpenSSL



@itemize *

@item 
Windows builds and macOS installers from python.org now use OpenSSL 3.0.
@end itemize

@node Qué hay de nuevo en Python 3 10,Qué hay de nuevo en Python 3 9,Qué hay de nuevo en Python 3 11,Qué hay de nuevo en Python
@anchor{whatsnew/3 10 doc}@anchor{838}@anchor{whatsnew/3 10 what-s-new-in-python-3-10}@anchor{839}
@section Qué hay de nuevo en Python 3.10


@*Editor: 
Pablo Galindo Salgado


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the git log
@c when researching a change.

Este artículo explica las nuevas características de Python 3.10, en comparación con la 3.9. Python 3.10 se publicó el 4 de octubre de 2021. Para obtener todos los detalles, consulte el @ref{13b,,changelog}.

@menu
* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<2>. 
* Nuevas características: Nuevas características<5>. 
* Nuevas funciones relacionadas con las sugerencias de tipos:: 
* Otros cambios de idioma: Otros cambios de idioma<2>. 
* Nuevos módulos: Nuevos módulos<2>. 
* Módulos mejorados: Módulos mejorados<3>. 
* Optimizaciones: Optimizaciones<3>. 
* Obsoleto: Obsoleto<5>. 
* Eliminado: Eliminado<3>. 
* Portar a Python 3.10: Portar a Python 3 10. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<3>. 
* Construir cambios: Construir cambios<2>. 
* Cambios en la API de C: Cambios en la API de C<4>. 
* Notable security feature in 3.10.7: Notable security feature in 3 10 7. 
* Notable security feature in 3.10.8: Notable security feature in 3 10 8. 
* Notable changes in 3.10.12: Notable changes in 3 10 12. 

@end menu

@node Resumen aspectos destacados de la versión<2>,Nuevas características<5>,,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 summary-release-highlights}@anchor{83a}
@subsection Resumen: aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.10.
@c Brevity is key.

@c PEP-sized items next.

Nuevas funciones de sintaxis:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}, Coincidencia de patrones estructurales: Especificación

@item 
@geindex Python Enhancement Proposals; PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}, Coincidencia de patrones estructurales: motivación y fundamento

@item 
@geindex Python Enhancement Proposals; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}, Coincidencia de patrones estructurales: Tutorial

@item 
bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782}, los administradores de contexto entre paréntesis ahora están oficialmente permitidos.
@end itemize

Nuevas funciones en la biblioteca estándar:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}, agregue verificación de longitud opcional al cierre.
@end itemize

Mejoras en el intérprete:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}, números de línea precisos para depuración y otras herramientas.
@end itemize

Nuevas funciones de escritura:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/}, Permitir escribir tipos de unión como X | Y

@item 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}, variables de especificación de parámetros

@item 
@geindex Python Enhancement Proposals; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}, alias de tipo explícito

@item 
@geindex Python Enhancement Proposals; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}, User-Defined Type Guards
@end itemize

Desactivaciones, eliminaciones o restricciones importantes:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}, requiere OpenSSL 1.1.1 o más reciente

@item 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}, módulo distutils obsoleto.

@item 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}, desaprobar y prepararse para la eliminación del miembro wstr en PyUnicodeObject.

@item 
@geindex Python Enhancement Proposals; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}, eliminar las API del codificador Py_UNICODE

@item 
@geindex Python Enhancement Proposals; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}, agregar codificación opcional
@end itemize

@node Nuevas características<5>,Nuevas funciones relacionadas con las sugerencias de tipos,Resumen aspectos destacados de la versión<2>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 new-features}@anchor{83b}
@subsection Nuevas características


@menu
* Administradores de contexto entre paréntesis:: 
* Mejores mensajes de error:: 
* PEP 626; números de línea precisos para depuración y otras herramientas: PEP 626 números de línea precisos para depuración y otras herramientas. 
* PEP 634; Coincidencia de patrones estructurales: PEP 634 Coincidencia de patrones estructurales. 
* Opción opcional EncodingWarning y encoding="locale":: 

@end menu

@node Administradores de contexto entre paréntesis,Mejores mensajes de error,,Nuevas características<5>
@anchor{whatsnew/3 10 parenthesized-context-managers}@anchor{83c}@anchor{whatsnew/3 10 whatsnew310-pep563}@anchor{83d}
@subsubsection Administradores de contexto entre paréntesis


Ahora se admite el uso de entre paréntesis para continuar en varias líneas en los administradores de contexto. Esto permite formatear una colección larga de administradores de contexto en múltiples líneas de una manera similar a como era posible anteriormente con declaraciones de importación. Por ejemplo, todos estos ejemplos ahora son válidos:

@example
with (CtxManager() as example):
    ...

with (
    CtxManager1(),
    CtxManager2()
):
    ...

with (CtxManager1() as example,
      CtxManager2()):
    ...

with (CtxManager1(),
      CtxManager2() as example):
    ...

with (
    CtxManager1() as example1,
    CtxManager2() as example2
):
    ...
@end example

también es posible usar una coma al final del grupo adjunto:

@example
with (
    CtxManager1() as example1,
    CtxManager2() as example2,
    CtxManager3() as example3,
):
    ...
@end example

Esta nueva sintaxis utiliza las capacidades no LL (1) del nuevo analizador. Consulte 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} para obtener más detalles.

(Contribuido por Guido van Rossum, Pablo Galindo y Lysandros Nikolaou en bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782} y bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}.)

@node Mejores mensajes de error,PEP 626 números de línea precisos para depuración y otras herramientas,Administradores de contexto entre paréntesis,Nuevas características<5>
@anchor{whatsnew/3 10 better-error-messages}@anchor{83e}
@subsubsection Mejores mensajes de error


@menu
* SyntaxErrors:: 
* Errores de sangría:: 
* AttributeErrors:: 
* NameErrors:: 

@end menu

@node SyntaxErrors,Errores de sangría,,Mejores mensajes de error
@anchor{whatsnew/3 10 syntaxerrors}@anchor{83f}
@subsubsection SyntaxErrors


Al analizar el código que contiene paréntesis o corchetes sin cerrar, el intérprete ahora incluye la ubicación del corchete de paréntesis sin cerrar en lugar de mostrar `SyntaxError: unexpected EOF while parsing' o señalar una ubicación incorrecta. Por ejemplo, considere el siguiente código (observe el “@{” sin cerrar):

@example
expected = @{9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
            38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6,
some_other_code = foo()
@end example

Las versiones anteriores del intérprete informaron lugares confusos como la ubicación del error de sintaxis:

@example
File "example.py", line 3
    some_other_code = foo()
                    ^
SyntaxError: invalid syntax
@end example

pero en Python 3.10 se emite un error más informativo:

@example
File "example.py", line 1
    expected = @{9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
               ^
SyntaxError: '@{' was never closed
@end example

De manera similar, los errores que involucran cadenas literales no cerradas (entre comillas simples y triples) ahora apuntan al inicio de la cadena en lugar de informar EOF / EOL.

Estas mejoras están inspiradas en trabajos anteriores en el intérprete de PyPy.

(Contribuido por Pablo Galindo en bpo-42864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42864} y Batuhan Taskaya en bpo-40176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40176}.)

Las excepciones de @ref{150,,SyntaxError} planteadas por el intérprete ahora resaltarán el rango de error completo de la expresión que constituye el error de sintaxis en sí, en lugar de solo dónde se detecta el problema. De esta manera, en lugar de mostrar (antes de Python 3.10):

@example
>>> foo(x, z for z in range(10), t, w)
  File "<stdin>", line 1
    foo(x, z for z in range(10), t, w)
           ^
SyntaxError: Generator expression must be parenthesized
@end example

ahora Python 3.10 mostrará la excepción como:

@example
>>> foo(x, z for z in range(10), t, w)
  File "<stdin>", line 1
    foo(x, z for z in range(10), t, w)
           ^^^^^^^^^^^^^^^^^^^^
SyntaxError: Generator expression must be parenthesized
@end example

Esta mejora fue aportada por Pablo Galindo en bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}.

Se ha incorporado una cantidad considerable de nuevos mensajes especializados para excepciones @ref{150,,SyntaxError}. Algunos de los más notables son los siguientes:


@itemize *

@item 
Falta @code{:} antes de los bloques:

@example
>>> if rocket.position > event_horizon
  File "<stdin>", line 1
    if rocket.position > event_horizon
                                      ^
SyntaxError: expected ':'
@end example

(Aportado por Pablo Galindo en bpo-42997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42997}.)

@item 
Tuplas sin paréntesis en objetivos de comprensión:

@example
>>> @{x,y for x,y in zip('abcd', '1234')@}
  File "<stdin>", line 1
    @{x,y for x,y in zip('abcd', '1234')@}
     ^
SyntaxError: did you forget parentheses around the comprehension target?
@end example

(Aportado por Pablo Galindo en bpo-43017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43017}.)

@item 
Faltan comas en literales de colección y entre expresiones:

@example
>>> items = @{
... x: 1,
... y: 2
... z: 3,
  File "<stdin>", line 3
    y: 2
       ^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

(Aportado por Pablo Galindo en bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}.)

@item 
Varios tipos de excepciones sin paréntesis:

@example
>>> try:
...     build_dyson_sphere()
... except NotEnoughScienceError, NotEnoughResourcesError:
  File "<stdin>", line 3
    except NotEnoughScienceError, NotEnoughResourcesError:
           ^
SyntaxError: multiple exception types must be parenthesized
@end example

(Aportado por Pablo Galindo en bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}.)

@item 
Falta @code{:} y valores en literales de diccionario:

@example
>>> values = @{
... x: 1,
... y: 2,
... z:
... @}
  File "<stdin>", line 4
    z:
     ^
SyntaxError: expression expected after dictionary key and ':'

>>> values = @{x:1, y:2, z w:3@}
  File "<stdin>", line 1
    values = @{x:1, y:2, z w:3@}
                        ^
SyntaxError: ':' expected after dictionary key
@end example

(Aportado por Pablo Galindo en bpo-43823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43823}.)

@item 
Bloques @code{try} sin bloques @code{except} o @code{finally}:

@example
>>> try:
...     x = 2
... something = 3
  File "<stdin>", line 3
    something  = 3
    ^^^^^^^^^
SyntaxError: expected 'except' or 'finally' block
@end example

(Aportado por Pablo Galindo en bpo-44305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44305}.)

@item 
Uso de @code{=} en lugar de @code{==} en comparaciones:

@example
>>> if rocket.position = event_horizon:
  File "<stdin>", line 1
    if rocket.position = event_horizon:
                       ^
SyntaxError: cannot assign to attribute here. Maybe you meant '==' instead of '='?
@end example

(Aportado por Pablo Galindo en bpo-43797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43797}.)

@item 
Uso de @code{*} en f-strings:

@example
>>> f"Black holes @{*all_black_holes@} and revelations"
  File "<stdin>", line 1
    (*all_black_holes)
     ^
SyntaxError: f-string: cannot use starred expression here
@end example

(Aportado por Pablo Galindo en bpo-41064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41064}.)
@end itemize

@node Errores de sangría,AttributeErrors,SyntaxErrors,Mejores mensajes de error
@anchor{whatsnew/3 10 indentationerrors}@anchor{840}
@subsubsection Errores de sangría


Muchas excepciones de @ref{841,,IndentationError} ahora tienen más contexto con respecto a qué tipo de bloque esperaba una sangría, incluida la ubicación de la declaración:

@example
>>> def foo():
...    if lel:
...    x = 2
  File "<stdin>", line 3
    x = 2
    ^
IndentationError: expected an indented block after 'if' statement in line 2
@end example

@node AttributeErrors,NameErrors,Errores de sangría,Mejores mensajes de error
@anchor{whatsnew/3 10 attributeerrors}@anchor{842}
@subsubsection AttributeErrors


When printing @ref{441,,AttributeError}, @code{PyErr_Display()} will offer
suggestions of similar attribute names in the object that the exception was
raised from:

@example
>>> collections.namedtoplo
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'collections' has no attribute 'namedtoplo'. Did you mean: namedtuple?
@end example

(Contribuido por Pablo Galindo en bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}.)

@cartouche
@quotation Advertencia 
Notice this won’t work if @code{PyErr_Display()} is not called to display the error
which can happen if some other custom error display function is used. This is a common
scenario in some REPLs like IPython.
@end quotation
@end cartouche

@node NameErrors,,AttributeErrors,Mejores mensajes de error
@anchor{whatsnew/3 10 nameerrors}@anchor{843}
@subsubsection NameErrors


When printing @ref{4ec,,NameError} raised by the interpreter, @code{PyErr_Display()}
will offer suggestions of similar variable names in the function that the exception
was raised from:

@example
>>> schwarzschild_black_hole = None
>>> schwarschild_black_hole
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'schwarschild_black_hole' is not defined. Did you mean: schwarzschild_black_hole?
@end example

(Contribuido por Pablo Galindo en bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}.)

@cartouche
@quotation Advertencia 
Notice this won’t work if @code{PyErr_Display()} is not called to display the error,
which can happen if some other custom error display function is used. This is a common
scenario in some REPLs like IPython.
@end quotation
@end cartouche

@node PEP 626 números de línea precisos para depuración y otras herramientas,PEP 634 Coincidencia de patrones estructurales,Mejores mensajes de error,Nuevas características<5>
@anchor{whatsnew/3 10 pep-626-precise-line-numbers-for-debugging-and-other-tools}@anchor{844}
@subsubsection PEP 626: números de línea precisos para depuración y otras herramientas


PEP 626 ofrece números de línea más precisos y confiables para herramientas de depuración, creación de perfiles y cobertura. Los eventos de rastreo, con el número de línea correcto, se generan para todas las líneas de código ejecutadas y solo para las líneas de código que se ejecutan.

The @ref{845,,f_lineno} attribute of frame objects will always contain the
expected line number.

The @ref{1d9,,co_lnotab} attribute of
@ref{335,,code objects} is deprecated and
will be removed in 3.12.
Code that needs to convert from offset to line number should use the new
@ref{1f3,,co_lines()} method instead.

@node PEP 634 Coincidencia de patrones estructurales,Opción opcional EncodingWarning y encoding="locale",PEP 626 números de línea precisos para depuración y otras herramientas,Nuevas características<5>
@anchor{whatsnew/3 10 pep-634-structural-pattern-matching}@anchor{846}
@subsubsection PEP 634: Coincidencia de patrones estructurales


Se ha agregado la coincidencia de patrones estructurales en forma de un `match statement' and `case statements' de patrones con acciones asociadas. Los patrones constan de secuencias, asignaciones, tipos de datos primitivos e instancias de clases. La coincidencia de patrones permite a los programas extraer información de tipos de datos complejos, ramificar la estructura de los datos y aplicar acciones específicas basadas en diferentes formas de datos.

@menu
* Sintaxis y operaciones:: 
* Enfoque declarativo:: 
* Patrón simple; coincidir con un literal: Patrón simple coincidir con un literal. 
* Patrones con un literal y una variable:: 
* Patrones y clases:: 
* Patrones anidados:: 
* Patrones complejos y el comodín:: 
* Guardia:: 
* Otras características clave:: 

@end menu

@node Sintaxis y operaciones,Enfoque declarativo,,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 syntax-and-operations}@anchor{847}
@subsubsection Sintaxis y operaciones


La sintaxis genérica de la coincidencia de patrones es:

@example
match subject:
    case <pattern_1>:
        <action_1>
    case <pattern_2>:
        <action_2>
    case <pattern_3>:
        <action_3>
    case _:
        <action_wildcard>
@end example

Una declaración de coincidencia toma una expresión y compara su valor con los patrones sucesivos dados como uno o más bloques de casos. Específicamente, la coincidencia de patrones funciona mediante:


@enumerate 

@item 
usando datos con tipo y forma (el @code{subject})

@item 
evaluar el @code{subject} en la declaración @code{match}

@item 
comparar el sujeto con cada patrón en una declaración @code{case} de arriba a abajo hasta que se confirme una coincidencia.

@item 
ejecutar la acción asociada con el patrón de la coincidencia confirmada

@item 
Si no se confirma una coincidencia exacta, el último caso, un comodín @code{_}, si se proporciona, se utilizará como caso coincidente. Si no se confirma una coincidencia exacta y no existe un comodín, todo el bloque de coincidencias es inactivo.
@end enumerate

@node Enfoque declarativo,Patrón simple coincidir con un literal,Sintaxis y operaciones,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 declarative-approach}@anchor{848}
@subsubsection Enfoque declarativo


Los lectores pueden ser conscientes de la coincidencia de patrones a través del simple ejemplo de hacer coincidir un sujeto (objeto de datos) con un literal (patrón) con la declaración de cambio que se encuentra en C, Java o JavaScript (y muchos otros lenguajes). A menudo, la declaración de cambio se utiliza para comparar un objeto / expresión con declaraciones de casos que contienen literales.

Se pueden encontrar ejemplos más poderosos de coincidencia de patrones en lenguajes como Scala y Elixir. Con la coincidencia de patrones estructurales, el enfoque es «declarativo» y establece explícitamente las condiciones (los patrones) para que los datos coincidan.

Si bien una serie «imperativa» de instrucciones que utilizan declaraciones «if» anidadas podría usarse para lograr algo similar a la coincidencia de patrones estructurales, es menos claro que el enfoque «declarativo». En cambio, el enfoque «declarativo» establece las condiciones que se deben cumplir para una coincidencia y es más legible a través de sus patrones explícitos. Si bien la coincidencia de patrones estructurales se puede usar en su forma más simple comparando una variable con un literal en una declaración de caso, su verdadero valor para Python radica en su manejo del tipo y la forma del sujeto.

@node Patrón simple coincidir con un literal,Patrones con un literal y una variable,Enfoque declarativo,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 simple-pattern-match-to-a-literal}@anchor{849}
@subsubsection Patrón simple: coincidir con un literal


Veamos este ejemplo como coincidencia de patrones en su forma más simple: un valor, el sujeto, se empareja con varios literales, los patrones. En el siguiente ejemplo, @code{status} es el tema de la declaración de coincidencia. Los patrones son cada una de las declaraciones de casos, donde los literales representan códigos de estado de solicitud. La acción asociada al caso se ejecuta después de una coincidencia:

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
        case _:
            return "Something's wrong with the internet"
@end example

Si a la función anterior se le pasa un @code{status} de 418, se devuelve «Soy una tetera». Si a la función anterior se le pasa un @code{status} de 500, la declaración de caso con @code{_} coincidirá como un comodín y se devuelve «Algo anda mal con Internet». Tenga en cuenta el último bloque: el nombre de la variable, @code{_}, actúa como `wildcard' y asegura que el sujeto siempre coincidirá. El uso de @code{_} es opcional.

Puede combinar varios literales en un solo patrón usando @code{|} («o»)

@example
case 401 | 403 | 404:
    return "Not allowed"
@end example

@menu
* Comportamiento sin el comodín:: 

@end menu

@node Comportamiento sin el comodín,,,Patrón simple coincidir con un literal
@anchor{whatsnew/3 10 behavior-without-the-wildcard}@anchor{84a}
@subsubsection Comportamiento sin el comodín


Si modificamos el ejemplo anterior eliminando el último bloque de caso, el ejemplo se convierte en:

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
@end example

Sin el uso de @code{_} en una declaración de caso, es posible que no exista una coincidencia. Si no existe ninguna coincidencia, el comportamiento es inactivo. Por ejemplo, si se pasa @code{status} de 500, se produce una no operación.

@node Patrones con un literal y una variable,Patrones y clases,Patrón simple coincidir con un literal,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 patterns-with-a-literal-and-variable}@anchor{84b}
@subsubsection Patrones con un literal y una variable


Los patrones pueden verse como asignaciones de desempaquetado y se puede usar un patrón para vincular variables. En este ejemplo, un punto de datos se puede descomprimir en su coordenada xy coordenada y:

@example
# point is an (x, y) tuple
match point:
    case (0, 0):
        print("Origin")
    case (0, y):
        print(f"Y=@{y@}")
    case (x, 0):
        print(f"X=@{x@}")
    case (x, y):
        print(f"X=@{x@}, Y=@{y@}")
    case _:
        raise ValueError("Not a point")
@end example

El primer patrón tiene dos literales, @code{(0, 0)}, y se puede considerar como una extensión del patrón literal que se muestra arriba. Los siguientes dos patrones combinan un literal y una variable, y la variable `binds' un valor del sujeto (@code{point}). El cuarto patrón captura dos valores, lo que lo hace conceptualmente similar a la asignación de desembalaje @code{(x, y) = point}.

@node Patrones y clases,Patrones anidados,Patrones con un literal y una variable,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 patterns-and-classes}@anchor{84c}
@subsubsection Patrones y clases


Si está usando clases para estructurar sus datos, puede usar como patrón el nombre de la clase seguido de una lista de argumentos que se asemeja a un constructor. Este patrón tiene la capacidad de capturar atributos de clase en variables:

@example
class Point:
    x: int
    y: int

def location(point):
    match point:
        case Point(x=0, y=0):
            print("Origin is the point's location.")
        case Point(x=0, y=y):
            print(f"Y=@{y@} and the point is on the y-axis.")
        case Point(x=x, y=0):
            print(f"X=@{x@} and the point is on the x-axis.")
        case Point():
            print("The point is located somewhere else on the plane.")
        case _:
            print("Not a point")
@end example

@menu
* Patrones con parámetros posicionales:: 

@end menu

@node Patrones con parámetros posicionales,,,Patrones y clases
@anchor{whatsnew/3 10 patterns-with-positional-parameters}@anchor{84d}
@subsubsection Patrones con parámetros posicionales


Puede usar parámetros posicionales con algunas clases integradas que proporcionan un orden para sus atributos (por ejemplo, clases de datos). También puede definir una posición específica para atributos en patrones configurando el atributo especial @code{__match_args__} en sus clases. Si se establece en («x», «y»), los siguientes patrones son todos equivalentes (y todos vinculan el atributo @code{y} a la variable @code{var}):

@example
Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
@end example

@node Patrones anidados,Patrones complejos y el comodín,Patrones y clases,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 nested-patterns}@anchor{84e}
@subsubsection Patrones anidados


Los patrones se pueden anidar arbitrariamente. Por ejemplo, si nuestros datos son una lista corta de puntos, podrían coincidir así:

@example
match points:
    case []:
        print("No points in the list.")
    case [Point(0, 0)]:
        print("The origin is the only point in the list.")
    case [Point(x, y)]:
        print(f"A single point @{x@}, @{y@} is in the list.")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Two points on the Y axis at @{y1@}, @{y2@} are in the list.")
    case _:
        print("Something else is found in the list.")
@end example

@node Patrones complejos y el comodín,Guardia,Patrones anidados,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 complex-patterns-and-the-wildcard}@anchor{84f}
@subsubsection Patrones complejos y el comodín


Hasta este punto, los ejemplos han utilizado @code{_} solo en la última declaración de caso. Se puede utilizar un comodín en patrones más complejos, como @code{('error', code, _)}. Por ejemplo:

@example
match test_variable:
    case ('warning', code, 40):
        print("A warning has been received.")
    case ('error', code, _):
        print(f"An error @{code@} occurred.")
@end example

En el caso anterior, @code{test_variable} coincidirá con (“error”, código, 100) y (“error”, código, 800).

@node Guardia,Otras características clave,Patrones complejos y el comodín,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 guard}@anchor{850}
@subsubsection Guardia


Podemos agregar una cláusula @code{if} a un patrón, conocido como «guardia». Si la guardia es falsa, @code{match} pasa a probar el siguiente bloque de caso. Tenga en cuenta que la captura de valor ocurre antes de que se evalúe la guardia:

@example
match point:
    case Point(x, y) if x == y:
        print(f"The point is located on the diagonal Y=X at @{x@}.")
    case Point(x, y):
        print(f"Point is not on the diagonal.")
@end example

@node Otras características clave,,Guardia,PEP 634 Coincidencia de patrones estructurales
@anchor{whatsnew/3 10 other-key-features}@anchor{851}
@subsubsection Otras características clave


Varias otras características clave:


@itemize -

@item 
Al igual que las asignaciones de desempaquetado, los patrones de tupla y lista tienen exactamente el mismo significado y en realidad coinciden con secuencias arbitrarias. Técnicamente, el tema debe ser una secuencia. Por lo tanto, una excepción importante es que los patrones no coinciden con los iteradores. Además, para evitar un error común, los patrones de secuencia no coinciden con las cadenas.

@item 
Los patrones de secuencia admiten comodines: @code{[x, y, *rest]} y @code{(x, y, *rest)} funcionan de manera similar a los comodines en las asignaciones de desempaquetado. El nombre después de @code{*} también puede ser @code{_}, por lo que @code{(x, y, *_)} coincide con una secuencia de al menos dos elementos sin vincular los elementos restantes.

@item 
Patrones de mapeo: @code{@{"bandwidth": b, "latency": l@}} captura los valores @code{"bandwidth"} y @code{"latency"} de un dict. A diferencia de los patrones de secuencia, las claves adicionales se ignoran. También se admite un comodín @code{**rest}. (Pero @code{**_} sería redundante, por lo que no está permitido).

@item 
Los subpatrones se pueden capturar utilizando la palabra clave @code{as}:

@example
case (Point(x1, y1), Point(x2, y2) as p2): ...
@end example

Esto vincula x1, y1, x2, y2 como cabría esperar sin la cláusula @code{as} y p2 a todo el segundo elemento del tema.

@item 
La mayoría de los literales se comparan por igualdad. Sin embargo, los singleton @code{True}, @code{False} y @code{None} se comparan por identidad.

@item 
Las constantes con nombre se pueden usar en patrones. Estas constantes nombradas deben ser nombres con puntos para evitar que la constante se interprete como una variable de captura:

@example
from enum import Enum
class Color(Enum):
    RED = 0
    GREEN = 1
    BLUE = 2

color = Color.GREEN
match color:
    case Color.RED:
        print("I see red!")
    case Color.GREEN:
        print("Grass is green")
    case Color.BLUE:
        print("I'm feeling the blues :(")
@end example
@end itemize

Para obtener la especificación completa, consulte 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}. La motivación y el fundamento están en 
@geindex Python Enhancement Proposals; PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}, y un tutorial más largo está en 
@geindex Python Enhancement Proposals; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}.

@node Opción opcional EncodingWarning y encoding="locale",,PEP 634 Coincidencia de patrones estructurales,Nuevas características<5>
@anchor{whatsnew/3 10 optional-encodingwarning-and-encoding-locale-option}@anchor{852}@anchor{whatsnew/3 10 whatsnew310-pep597}@anchor{853}
@subsubsection Opción opcional @code{EncodingWarning} y @code{encoding="locale"}


The default encoding of @ref{854,,TextIOWrapper} and @ref{1be,,open()} is
platform and locale dependent. Since UTF-8 is used on most Unix
platforms, omitting @code{encoding} option when opening UTF-8 files
(e.g. JSON, YAML, TOML, Markdown) is a very common bug. For example:

@example
# BUG: "rb" mode or encoding="utf-8" should be used.
with open("data.json") as f:
    data = json.load(f)
@end example

Para encontrar este tipo de error, se agrega un @code{EncodingWarning} opcional. Se emite cuando @ref{72d,,sys.flags.warn_default_encoding} es verdadero y se utiliza la codificación predeterminada específica de la configuración regional.

Se agregan la opción @code{-X warn_default_encoding} y 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variables de entorno; PYTHONWARNDEFAULTENCODING
@ref{855,,PYTHONWARNDEFAULTENCODING} para habilitar la advertencia.

Consulte @ref{856,,Codificación de texto} para obtener más información.

@node Nuevas funciones relacionadas con las sugerencias de tipos,Otros cambios de idioma<2>,Nuevas características<5>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 new-feat-related-type-hints}@anchor{857}@anchor{whatsnew/3 10 new-features-related-to-type-hints}@anchor{858}
@subsection Nuevas funciones relacionadas con las sugerencias de tipos


Esta sección cubre los cambios importantes que afectan a las sugerencias de tipo 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} y al módulo @ref{104,,typing}.

@menu
* PEP 604; Nuevo tipo de operador unión: PEP 604 Nuevo tipo de operador unión. 
* PEP 612; Variables de especificación de parámetros: PEP 612 Variables de especificación de parámetros. 
* PEP 613; TypeAlias: PEP 613 TypeAlias. 
* PEP 647; protectores de tipo definidos por el usuario: PEP 647 protectores de tipo definidos por el usuario. 

@end menu

@node PEP 604 Nuevo tipo de operador unión,PEP 612 Variables de especificación de parámetros,,Nuevas funciones relacionadas con las sugerencias de tipos
@anchor{whatsnew/3 10 pep-604-new-type-union-operator}@anchor{859}
@subsubsection PEP 604: Nuevo tipo de operador unión


Se introdujo un nuevo operador de unión de tipos que habilita la sintaxis @code{X | Y}. Esto proporciona una forma más limpia de expresar “tipo X o tipo Y” en lugar de usar @ref{6dc,,typing.Union}, especialmente en sugerencias de tipo.

En versiones anteriores de Python, para aplicar una sugerencia de tipo para funciones que aceptan argumentos de múltiples tipos, se usó @ref{6dc,,typing.Union}:

@example
def square(number: Union[int, float]) -> Union[int, float]:
    return number ** 2
@end example

Las sugerencias de tipo ahora se pueden escribir de una manera más sucinta:

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

Esta nueva sintaxis también se acepta como segundo argumento para @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}:

@example
>>> isinstance(1, int | str)
True
@end example

Consulte @ref{85b,,Tipo de conversión} y 
@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} para obtener más detalles.

(Contribuido por Maggie Moss y Philippe Prados en bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}, con adiciones de Yurii Karabas y Serhiy Storchaka en bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}.)

@node PEP 612 Variables de especificación de parámetros,PEP 613 TypeAlias,PEP 604 Nuevo tipo de operador unión,Nuevas funciones relacionadas con las sugerencias de tipos
@anchor{whatsnew/3 10 pep-612-parameter-specification-variables}@anchor{85c}
@subsubsection PEP 612: Variables de especificación de parámetros


Se han agregado al módulo @ref{104,,typing} dos nuevas opciones para mejorar la información proporcionada a los verificadores de tipo estático para 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} “s @code{Callable}.

La primera es la variable de especificación de parámetros. Se utilizan para reenviar los tipos de parámetros de un invocable a otro invocable, un patrón que se encuentra comúnmente en funciones y decoradores de orden superior. Se pueden encontrar ejemplos de uso en @ref{2ca,,typing.ParamSpec}. Anteriormente, no había una manera fácil de escribir anotar la dependencia de los tipos de parámetros de una manera tan precisa.

La segunda opción es el nuevo operador @code{Concatenate}. Se usa junto con las variables de especificación de parámetros para escribir anotar un invocable de orden superior que agrega o elimina parámetros de otro invocable. Se pueden encontrar ejemplos de uso en @ref{85d,,typing.Concatenate}.

Consulte @ref{85e,,typing.Callable}, @ref{2ca,,typing.ParamSpec}, @ref{85d,,typing.Concatenate}, @ref{85f,,typing.ParamSpecArgs}, @ref{860,,typing.ParamSpecKwargs} y 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para obtener más detalles.

(Contribuido por Ken Jin en bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}, con pequeñas mejoras de Jelle Zijlstra en bpo-43783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43783}. PEP escrito por Mark Mendoza.)

@node PEP 613 TypeAlias,PEP 647 protectores de tipo definidos por el usuario,PEP 612 Variables de especificación de parámetros,Nuevas funciones relacionadas con las sugerencias de tipos
@anchor{whatsnew/3 10 pep-613-typealias}@anchor{861}
@subsubsection PEP 613: TypeAlias


@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introdujo el concepto de alias de tipo, solo requiriendo que sean asignaciones no anotadas de nivel superior. Esta simplicidad a veces dificultaba que los verificadores de tipos distinguieran entre alias de tipos y asignaciones ordinarias, especialmente cuando se trataba de referencias directas o tipos no válidos. Comparar:

@example
StrCache = 'Cache[str]'  # a type alias
LOG_PREFIX = 'LOG[DEBUG]'  # a module constant
@end example

Now the @ref{104,,typing} module has a special value @ref{862,,TypeAlias}
which lets you declare type aliases more explicitly:

@example
StrCache: TypeAlias = 'Cache[str]'  # a type alias
LOG_PREFIX = 'LOG[DEBUG]'  # a module constant
@end example

Consulte 
@geindex Python Enhancement Proposals; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} para obtener más detalles.

(Contribuido por Mikhail Golubev en bpo-41923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41923}.)

@node PEP 647 protectores de tipo definidos por el usuario,,PEP 613 TypeAlias,Nuevas funciones relacionadas con las sugerencias de tipos
@anchor{whatsnew/3 10 pep-647-user-defined-type-guards}@anchor{863}
@subsubsection PEP 647: protectores de tipo definidos por el usuario


@ref{2d0,,TypeGuard} has been added to the @ref{104,,typing} module to annotate
type guard functions and improve information provided to static type checkers
during type narrowing.  For more information, please see
@ref{2d0,,TypeGuard}“s documentation, and 
@geindex Python Enhancement Proposals; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}.

(Contribuido por Ken Jin y Guido van Rossum en bpo-43766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43766}. PEP escrito por Eric Traut.)

@node Otros cambios de idioma<2>,Nuevos módulos<2>,Nuevas funciones relacionadas con las sugerencias de tipos,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 other-language-changes}@anchor{864}
@subsection Otros cambios de idioma



@itemize *

@item 
El tipo @ref{1f0,,int} tiene un nuevo método @ref{865,,int.bit_count()}, que devuelve el número de unos en la expansión binaria de un entero dado, también conocido como recuento de población. (Contribuido por Niklas Fiekas en bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882}.)

@item 
Las vistas devueltas por @ref{866,,dict.keys()}, @ref{867,,dict.values()} y @ref{868,,dict.items()} ahora tienen todas un atributo @code{mapping} que proporciona un objeto @ref{518,,types.MappingProxyType} que envuelve el diccionario original. (Contribuido por Dennis Sweeney en bpo-40890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40890}.)

@item 
@geindex Python Enhancement Proposals; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}: La función @ref{14d,,zip()} ahora tiene un indicador @code{strict} opcional, que se utiliza para requerir que todos los iterables tengan la misma longitud.

@item 
Las funciones integradas y de extensión que toman argumentos enteros ya no aceptan @ref{16a,,Decimal} s, @ref{177,,Fraction} sy otros objetos que se pueden convertir a números enteros solo con una pérdida (por ejemplo, que tienen el método @ref{22a,,__int__()} pero no tienen el método @ref{22b,,__index__()}). (Contribuido por Serhiy Storchaka en bpo-37999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37999}.)

@item 
If @ref{869,,object.__ipow__()} returns @ref{227,,NotImplemented}, the operator will
correctly fall back to @ref{86a,,object.__pow__()} and @ref{86b,,object.__rpow__()} as expected.
(Contributed by Alex Shkop in bpo-38302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38302}.)

@item 
Las expresiones de asignación ahora se pueden usar sin paréntesis dentro de literales de conjuntos y comprensiones de conjuntos, así como en índices de secuencia (pero no por sectores).

@item 
Las funciones tienen un nuevo atributo @code{__builtins__} que se usa para buscar símbolos incorporados cuando se ejecuta una función, en lugar de buscar en @code{__globals__['__builtins__']}. El atributo se inicializa desde @code{__globals__["__builtins__"]} si existe, de lo contrario desde las incorporaciones actuales. (Contribuido por Mark Shannon en bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}.)

@item 
Se han agregado dos nuevas funciones integradas: @ref{86c,,aiter()} y @ref{86d,,anext()} para proporcionar contrapartes asíncronas a @ref{86e,,iter()} y @ref{86f,,next()}, respectivamente. (Contribuido por Joshua Bronson, Daniel Pope y Justin Wang en bpo-31861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31861}.)

@item 
Los métodos estáticos (@ref{22e,,@@staticmethod}) y los métodos de clase (@ref{2d2,,@@classmethod}) ahora heredan los atributos del método (@code{__module__}, @code{__name__}, @code{__qualname__}, @code{__doc__}, @code{__annotations__}) y tienen un nuevo atributo @code{__wrapped__}. Además, los métodos estáticos ahora se pueden llamar como funciones regulares. (Contribuido por Victor Stinner en bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}.)

@item 
Las anotaciones para objetivos complejos (todo junto a los objetivos @code{simple name} definidos por 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}) ya no causan ningún efecto de tiempo de ejecución con @code{from __future__ import annotations}. (Contribuido por Batuhan Taskaya en bpo-42737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42737}.)

@item 
Los objetos de clase y módulo ahora crean de forma perezosa anotaciones vacías dictados a pedido. Los dictados de anotaciones se almacenan en el @code{__dict__} del objeto para compatibilidad con versiones anteriores. Esto mejora las mejores prácticas para trabajar con @code{__annotations__}; para obtener más información, consulte @ref{870,,Prácticas recomendadas para las anotaciones}. (Contribuido por Larry Hastings en bpo-43901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43901}.)

@item 
Las anotaciones consisten en @code{yield}, @code{yield from}, @code{await} o expresiones con nombre ahora están prohibidas bajo @code{from __future__ import annotations} debido a sus efectos secundarios. (Contribuido por Batuhan Taskaya en bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}.)

@item 
El uso de variables independientes, @code{super()} y otras expresiones que podrían alterar el procesamiento de la tabla de símbolos como anotaciones ahora no tienen efecto bajo @code{from __future__ import annotations}. (Contribuido por Batuhan Taskaya en bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}.)

@item 
Los valores hash de NaN tanto del tipo @ref{153,,float} como del tipo @ref{16a,,decimal.Decimal} ahora dependen de la identidad del objeto. Anteriormente, siempre tenían hash en @code{0} aunque los valores de NaN no son iguales entre sí. Esto provocó un comportamiento de tiempo de ejecución potencialmente cuadrático debido a colisiones de hash excesivas al crear diccionarios y conjuntos que contienen varios NaN. (Contribuido por Raymond Hettinger en bpo-43475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43475}.)

@item 
A @ref{150,,SyntaxError} (instead of a @ref{4ec,,NameError}) will be raised when deleting
the @ref{871,,__debug__} constant.  (Contributed by Donghee Na in bpo-45000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45000}.)

@item 
Las excepciones @ref{150,,SyntaxError} ahora tienen atributos @code{end_lineno} y @code{end_offset}. Serán @code{None} si no se determinan. (Contribuido por Pablo Galindo en bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}.)
@end itemize

@node Nuevos módulos<2>,Módulos mejorados<3>,Otros cambios de idioma<2>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 new-modules}@anchor{872}
@subsection Nuevos módulos



@itemize *

@item 
None.
@end itemize

@node Módulos mejorados<3>,Optimizaciones<3>,Nuevos módulos<2>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 improved-modules}@anchor{873}
@subsection Módulos mejorados


@menu
* asyncio: asyncio<4>. 
* argumentar:: 
* formación:: 
* asynchat@comma{} asyncore@comma{} smtpd: asynchat asyncore smtpd. 
* base64: base64<2>. 
* bdb:: 
* bisecar:: 
* códecs:: 
* colecciones.abc: colecciones abc. 
* contextlib: contextlib<2>. 
* maldiciones:: 
* clases de datos: clases de datos<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* codificaciones:: 
* enum: enum<2>. 
* entrada de archivo:: 
* manipulador de faltas:: 
* GC:: 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac:: 
* IDLE e idlelib:: 
* importlib.metadata: importlib metadata<2>. 
* inspeccionar: inspeccionar<2>. 
* itertools: itertools<4>. 
* caché de línea:: 
* os: os<4>. 
* os.path: os path<3>. 
* Pathlib:: 
* plataforma:: 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* dejar de lado:: 
* Estadísticas:: 
* sitio:: 
* enchufe: enchufe<2>. 
* ssl: ssl<3>. 
* sqlite3: sqlite3<6>. 
* sys: sys<4>. 
* _hilo:: 
* enhebrar: enhebrar<2>. 
* rastrear: rastrear<2>. 
* tipos:: 
* mecanografía: mecanografía<2>. 
* prueba de unidad: prueba de unidad<2>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

@end menu

@node asyncio<4>,argumentar,,Módulos mejorados<3>
@anchor{whatsnew/3 10 asyncio}@anchor{874}
@subsubsection asyncio


Agregue el método @code{connect_accepted_socket()} faltante. (Contribuido por Alex Grönholm en bpo-41332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41332}.)

@node argumentar,formación,asyncio<4>,Módulos mejorados<3>
@anchor{whatsnew/3 10 argparse}@anchor{875}
@subsubsection argumentar


La frase engañosa «argumentos opcionales» fue reemplazada por «opciones» en la ayuda de argparse. Algunas pruebas pueden requerir una adaptación si se basan en la coincidencia exacta de la salida. (Contribuido por Raymond Hettinger en bpo-9694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9694}.)

@node formación,asynchat asyncore smtpd,argumentar,Módulos mejorados<3>
@anchor{whatsnew/3 10 array}@anchor{876}
@subsubsection formación


El método @ref{877,,index()} de @ref{308,,array.array} ahora tiene parámetros `start' and `stop' opcionales. (Contribuido por Anders Lorentsen y Zackery Spytz en bpo-31956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31956}.)

@node asynchat asyncore smtpd,base64<2>,formación,Módulos mejorados<3>
@anchor{whatsnew/3 10 asynchat-asyncore-smtpd}@anchor{878}
@subsubsection asynchat, asyncore, smtpd


Estos módulos se han marcado como obsoletos en la documentación del módulo desde Python 3.6. Ahora se ha agregado un @ref{1da,,DeprecationWarning} en tiempo de importación a estos tres módulos.

@node base64<2>,bdb,asynchat asyncore smtpd,Módulos mejorados<3>
@anchor{whatsnew/3 10 base64}@anchor{879}
@subsubsection base64


Agregue @ref{87a,,base64.b32hexencode()} y @ref{87b,,base64.b32hexdecode()} para admitir la codificación Base32 con alfabeto hexadecimal extendido.

@node bdb,bisecar,base64<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 bdb}@anchor{87c}
@subsubsection bdb


Agregue @code{clearBreakpoints()} para restablecer todos los puntos de interrupción establecidos. (Contribuido por Irit Katriel en bpo-24160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24160}.)

@node bisecar,códecs,bdb,Módulos mejorados<3>
@anchor{whatsnew/3 10 bisect}@anchor{87d}
@subsubsection bisecar


Se agregó la posibilidad de proporcionar una función `key' a las API en el módulo @ref{12,,bisect}. (Contribuido por Raymond Hettinger en bpo-4356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4356}.)

@node códecs,colecciones abc,bisecar,Módulos mejorados<3>
@anchor{whatsnew/3 10 codecs}@anchor{87e}
@subsubsection códecs


Agregue una función @ref{87f,,codecs.unregister()} para anular el registro de una función de búsqueda de códec. (Contribuido por Hai Shi en bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}.)

@node colecciones abc,contextlib<2>,códecs,Módulos mejorados<3>
@anchor{whatsnew/3 10 collections-abc}@anchor{880}
@subsubsection colecciones.abc


El @code{__args__} del @ref{753,,parameterized generic} para @ref{881,,collections.abc.Callable} ahora es consistente con @ref{85e,,typing.Callable}. @ref{881,,collections.abc.Callable} genérico ahora aplana los parámetros de tipo, similar a lo que hace actualmente @ref{85e,,typing.Callable}. Esto significa que @code{collections.abc.Callable[[int, str], str]} tendrá @code{__args__} de @code{(int, str, str)}; anteriormente esto era @code{([int, str], str)}. Para permitir este cambio, @ref{882,,types.GenericAlias} ahora puede ser subclasificado, y se devolverá una subclase al subíndice el tipo @ref{881,,collections.abc.Callable}. Tenga en cuenta que se puede generar un @ref{228,,TypeError} para formas no válidas de parametrizar @ref{881,,collections.abc.Callable} que pueden haber pasado silenciosamente en Python 3.9. (Contribuido por Ken Jin en bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@node contextlib<2>,maldiciones,colecciones abc,Módulos mejorados<3>
@anchor{whatsnew/3 10 contextlib}@anchor{883}
@subsubsection contextlib


Agregue un administrador de contexto @ref{884,,contextlib.aclosing()} para cerrar de forma segura los generadores asíncronos y los objetos que representan recursos liberados de manera asíncrona. (Contribuido por Joongi Kim y John Belmonte en bpo-41229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41229}.)

Agregue soporte de administrador de contexto asincrónico a @ref{885,,contextlib.nullcontext()}. (Contribuido por Tom Gringauz en bpo-41543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41543}.)

Add @ref{886,,AsyncContextDecorator}, for supporting usage of async
context managers as decorators.

@node maldiciones,clases de datos<2>,contextlib<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 curses}@anchor{887}
@subsubsection maldiciones


Las funciones de color extendidas agregadas en ncurses 6.1 serán utilizadas de forma transparente por @ref{888,,curses.color_content()}, @ref{889,,curses.init_color()}, @ref{88a,,curses.init_pair()} y @ref{88b,,curses.pair_content()}. Una nueva función, @ref{88c,,curses.has_extended_color_support()}, indica si la biblioteca ncurses subyacente proporciona compatibilidad de color ampliada. (Contribuido por Jeffrey Kintscher y Hans Petter Jansson en bpo-36982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36982}.)

Las constantes @code{BUTTON5_*} ahora se exponen en el módulo @ref{2c,,curses} si las proporciona la biblioteca de curses subyacente. (Contribuido por Zackery Spytz en bpo-39273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39273}.)

@node clases de datos<2>,distutils<2>,maldiciones,Módulos mejorados<3>
@anchor{whatsnew/3 10 dataclasses}@anchor{88d}
@subsubsection clases de datos


@menu
* __slots__:: 
* Campos solo de palabras clave:: 

@end menu

@node __slots__,Campos solo de palabras clave,,clases de datos<2>
@anchor{whatsnew/3 10 slots}@anchor{88e}
@subsubsection __slots__


Se agregó el parámetro @code{slots} en el decorador @ref{32e,,dataclasses.dataclass()}. (Contribuido por Yurii Karabas en bpo-42269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42269})

@node Campos solo de palabras clave,,__slots__,clases de datos<2>
@anchor{whatsnew/3 10 keyword-only-fields}@anchor{88f}
@subsubsection Campos solo de palabras clave


dataclasses ahora admite campos que son solo palabras clave en el método __init__ generado. Hay varias formas de especificar campos de solo palabras clave.

Puede decir que todos los campos son solo palabras clave:

@example
from dataclasses import dataclass

@@dataclass(kw_only=True)
class Birthday:
    name: str
    birthday: datetime.date
@end example

Tanto @code{name} como @code{birthday} son parámetros de solo palabras clave para el método __init__ generado.

Puede especificar solo palabras clave por campo:

@example
from dataclasses import dataclass, field

@@dataclass
class Birthday:
    name: str
    birthday: datetime.date = field(kw_only=True)
@end example

Aquí solo @code{birthday} es solo palabra clave. Si configura @code{kw_only} en campos individuales, tenga en cuenta que existen reglas sobre el reordenamiento de los campos debido a que los campos de solo palabras clave deben seguir campos que no son solo de palabras clave. Consulte la documentación completa de clases de datos para obtener más detalles.

También puede especificar que todos los campos que siguen a un marcador KW_ONLY sean solo de palabras clave. Este será probablemente el uso más común:

@example
from dataclasses import dataclass, KW_ONLY

@@dataclass
class Point:
    x: float
    y: float
    _: KW_ONLY
    z: float = 0.0
    t: float = 0.0
@end example

Aquí, @code{z} y @code{t} son parámetros de solo palabras clave, mientras que @code{x} y @code{y} no lo son. (Aportado por Eric V. Smith en bpo-43532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43532}.)

@node distutils<2>,doctest<2>,clases de datos<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 distutils}@anchor{890}@anchor{whatsnew/3 10 distutils-deprecated}@anchor{7c6}
@subsubsection distutils


Todo el paquete @code{distutils} está obsoleto y se eliminará en Python 3.12. Su funcionalidad para especificar compilaciones de paquetes ya ha sido completamente reemplazada por paquetes de terceros @code{setuptools} y @code{packaging}, y la mayoría de las otras API de uso común están disponibles en otras partes de la biblioteca estándar (como @ref{aa,,platform}, @ref{c5,,shutil}, @ref{d6,,subprocess} o @ref{db,,sysconfig}). No hay planes para migrar ninguna otra funcionalidad de @code{distutils}, y las aplicaciones que utilizan otras funciones deben planificar la realización de copias privadas del código. Consulte 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} para obtener más información.

Se eliminó el comando @code{bdist_wininst} en desuso en Python 3.8. Ahora se recomienda el comando @code{bdist_wheel} para distribuir paquetes binarios en Windows. (Contribuido por Victor Stinner en bpo-42802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42802}.)

@node doctest<2>,codificaciones,distutils<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 doctest}@anchor{891}
@subsubsection doctest


Cuando un módulo no define @code{__loader__}, recurre a @code{__spec__.loader}. (Contribuido por Brett Cannon en bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node codificaciones,enum<2>,doctest<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 encodings}@anchor{892}
@subsubsection codificaciones


@code{encodings.normalize_encoding()} ahora ignora los caracteres que no son ASCII. (Contribuido por Hai Shi en bpo-39337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39337}.)

@node enum<2>,entrada de archivo,codificaciones,Módulos mejorados<3>
@anchor{whatsnew/3 10 enum}@anchor{893}
@subsubsection enum


@ref{6d1,,Enum} @ref{6bd,,__repr__()} now returns @code{enum_name.member_name} and
@ref{6be,,__str__()} now returns @code{member_name}.  Stdlib enums available as
module constants have a @ref{894,,repr()} of @code{module_name.member_name}.
(Contributed by Ethan Furman in bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}.)

Añadir @ref{6bb,,enum.StrEnum} para los enums en los que todos los miembros son cadenas. (Contribuido por Ethan Furman en bpo-41816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41816}.)

@node entrada de archivo,manipulador de faltas,enum<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 fileinput}@anchor{895}
@subsubsection entrada de archivo


Agregue los parámetros `encoding' and `errors' en @ref{896,,fileinput.input()} y @ref{7d3,,fileinput.FileInput}. (Contribuido por Inada Naoki en bpo-43712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43712}.)

@ref{897,,fileinput.hook_compressed()} now returns @ref{854,,TextIOWrapper} object
when `mode' is «r» and file is compressed, like uncompressed files.
(Contributed by Inada Naoki in bpo-5758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5758}.)

@node manipulador de faltas,GC,entrada de archivo,Módulos mejorados<3>
@anchor{whatsnew/3 10 faulthandler}@anchor{898}
@subsubsection manipulador de faltas


El módulo @ref{58,,faulthandler} ahora detecta si ocurre un error fatal durante la recolección de un recolector de basura. (Contribuido por Victor Stinner en bpo-44466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44466}.)

@node GC,glob<2>,manipulador de faltas,Módulos mejorados<3>
@anchor{whatsnew/3 10 gc}@anchor{899}
@subsubsection GC


Agregue ganchos de auditoría para @ref{89a,,gc.get_objects()}, @ref{89b,,gc.get_referrers()} y @ref{89c,,gc.get_referents()}. (Contribuido por Pablo Galindo en bpo-43439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43439}.)

@node glob<2>,hashlib<3>,GC,Módulos mejorados<3>
@anchor{whatsnew/3 10 glob}@anchor{89d}
@subsubsection glob


Agregue los parámetros `root_dir' and `dir_fd' en @ref{3ef,,glob()} y @ref{89e,,iglob()} que permiten especificar el directorio raíz para la búsqueda. (Contribuido por Serhiy Storchaka en bpo-38144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38144}.)

@node hashlib<3>,hmac,glob<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 hashlib}@anchor{89f}
@subsubsection hashlib


El módulo hashlib requiere OpenSSL 1.1.1 o más reciente. (Contribuido por Christian Heimes en 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} y bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

El módulo hashlib tiene soporte preliminar para OpenSSL 3.0.0. (Contribuido por Christian Heimes en bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820} y otros números).

El respaldo de Python puro de @ref{5b3,,pbkdf2_hmac()} está en desuso. En el futuro, PBKDF2-HMAC solo estará disponible cuando Python se haya construido con soporte OpenSSL. (Contribuido por Christian Heimes en bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}.)

@node hmac,IDLE e idlelib,hashlib<3>,Módulos mejorados<3>
@anchor{whatsnew/3 10 hmac}@anchor{8a0}
@subsubsection hmac


El módulo hmac ahora usa la implementación HMAC de OpenSSL internamente. (Contribuido por Christian Heimes en bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}.)

@node IDLE e idlelib,importlib metadata<2>,hmac,Módulos mejorados<3>
@anchor{whatsnew/3 10 idle-and-idlelib}@anchor{8a1}
@subsubsection IDLE e idlelib


Hacer que IDLE invoque @ref{8a2,,sys.excepthook()} (cuando se inicia sin “-n”). Los ganchos de usuario se ignoraban anteriormente. (Aportado por Ken Hilton en bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}.)

Reorganizar el diálogo de configuración.  Dividir la pestaña General en las pestañas Windows y Shell/Ed.  Mover las fuentes de ayuda, que amplían el menú Ayuda, a la pestaña Extensiones.  Hacer espacio para nuevas opciones y acortar el diálogo. Esto último hace que el diálogo se adapte mejor a las pantallas pequeñas.  (Contribuido por Terry Jan Reedy en bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}.) Mover la configuración del espacio de indentación de la pestaña de Fuente a la nueva pestaña Windows.  (Contribuido por Mark Roseman y Terry Jan Reedy en bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}.)

Los cambios anteriores se trasladaron a una versión de mantenimiento 3.9.

Agrega una barra lateral de Shell. Mueva el indicador principal (“>>>”) a la barra lateral. Agregue mensajes secundarios (”…”) a la barra lateral. El clic izquierdo y el arrastre opcional seleccionan una o más líneas de texto, como con la barra lateral del número de línea del editor. Al hacer clic derecho después de seleccionar líneas de texto, se muestra un menú contextual con “copiar con indicaciones”. Esto comprime los mensajes de la barra lateral con líneas del texto seleccionado. Esta opción también aparece en el menú contextual del texto. (Contribuido por Tal Einat en bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}.)

Use espacios en lugar de tabulaciones para sangrar el código interactivo. Esto hace que las entradas de código interactivo “se vean bien”. Hacer esto factible fue una de las principales motivaciones para agregar la barra lateral de shell. (Aportado por Terry Jan Reedy en bpo-37892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37892}.)

Resalte los nuevos @ref{8a3,,soft keywords} @ref{8a4,,match}, @ref{8a4,,case} y @ref{8a5,,_} en declaraciones de coincidencia de patrones. Sin embargo, este resaltado no es perfecto y será incorrecto en algunos casos excepcionales, incluidos algunos @code{_}-s en patrones @code{case}. (Aportado por Tal Einat en bpo-44010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44010}.)

Nuevo en la versión de mantenimiento 3.10.

Aplicar el resaltado de sintaxis a los archivos @code{.pyi}. (Contribución de Alex Waygood y Terry Jan Reedy en bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}.)

Incluir avisos al guardar Shell con entradas y salidas. (Contribuido por Terry Jan Reedy en gh-95191@footnote{https://github.com/python/cpython/issues/95191}.)

@node importlib metadata<2>,inspeccionar<2>,IDLE e idlelib,Módulos mejorados<3>
@anchor{whatsnew/3 10 importlib-metadata}@anchor{8a6}
@subsubsection importlib.metadata


Paridad de características con @code{importlib_metadata} 4.6 (history@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html}).

@ref{3d9,,importlib.metadata entry points}
now provide a nicer experience
for selecting entry points by group and name through a new
@ref{3d9,,importlib.metadata.EntryPoints} class. See the Compatibility
Note in the docs for more info on the deprecation and usage.

Added @ref{8a7,,importlib.metadata.packages_distributions()}
for resolving top-level Python modules and packages to their
@ref{8a8,,importlib.metadata.Distribution}.

@node inspeccionar<2>,itertools<4>,importlib metadata<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 inspect}@anchor{8a9}
@subsubsection inspeccionar


Cuando un módulo no define @code{__loader__}, recurre a @code{__spec__.loader}. (Contribuido por Brett Cannon en bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

Add @ref{8aa,,inspect.get_annotations()}, which safely computes the annotations
defined on an object. It works around the quirks of accessing the annotations
on various types of objects, and makes very few assumptions about the object
it examines. @ref{8aa,,inspect.get_annotations()} can also correctly un-stringize
stringized annotations.  @ref{8aa,,inspect.get_annotations()} is now considered
best practice for accessing the annotations dict defined on any Python object;
for more information on best practices for working with annotations, please see
@ref{870,,Prácticas recomendadas para las anotaciones}.
Relatedly, @ref{181,,inspect.signature()},
@ref{7d5,,inspect.Signature.from_callable()}, and @code{inspect.Signature.from_function()}
now call @ref{8aa,,inspect.get_annotations()} to retrieve annotations. This means
@ref{181,,inspect.signature()} and @ref{7d5,,inspect.Signature.from_callable()} can
also now un-stringize stringized annotations.
(Contributed by Larry Hastings in bpo-43817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43817}.)

@node itertools<4>,caché de línea,inspeccionar<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 itertools}@anchor{8ab}
@subsubsection itertools


Add @ref{8ac,,itertools.pairwise()}.
(Contributed by Raymond Hettinger in bpo-38200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38200}.)

@node caché de línea,os<4>,itertools<4>,Módulos mejorados<3>
@anchor{whatsnew/3 10 linecache}@anchor{8ad}
@subsubsection caché de línea


Cuando un módulo no define @code{__loader__}, recurre a @code{__spec__.loader}. (Contribuido por Brett Cannon en bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node os<4>,os path<3>,caché de línea,Módulos mejorados<3>
@anchor{whatsnew/3 10 os}@anchor{8ae}
@subsubsection os


Add @ref{328,,os.cpu_count()} support for VxWorks RTOS.
(Contributed by Peixing Xin in bpo-41440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41440}.)

Agregue una nueva función @ref{8af,,os.eventfd()} y ayudantes relacionados para envolver el syscall @code{eventfd2} en Linux. (Contribuido por Christian Heimes en bpo-41001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41001}.)

Add @ref{8b0,,os.splice()} that allows to move data between two file
descriptors without copying between kernel address space and user
address space, where one of the file descriptors must refer to a
pipe. (Contributed by Pablo Galindo in bpo-41625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41625}.)

Add @ref{8b1,,O_EVTONLY}, @ref{8b2,,O_FSYNC}, @ref{8b3,,O_SYMLINK}
and @ref{8b4,,O_NOFOLLOW_ANY} for macOS.
(Contributed by Donghee Na in bpo-43106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43106}.)

@node os path<3>,Pathlib,os<4>,Módulos mejorados<3>
@anchor{whatsnew/3 10 os-path}@anchor{8b5}
@subsubsection os.path


@ref{381,,os.path.realpath()} ahora acepta un argumento de solo palabra clave `strict'. Cuando se establece en @code{True}, @ref{4d5,,OSError} se genera si no existe una ruta o se encuentra un bucle de enlace simbólico. (Contribuido por Barney Gale en bpo-43757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43757}.)

@node Pathlib,plataforma,os path<3>,Módulos mejorados<3>
@anchor{whatsnew/3 10 pathlib}@anchor{8b6}
@subsubsection Pathlib


Agregue soporte de división a @ref{8b7,,PurePath.parents}. (Aportado por Joshua Cannon en bpo-35498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35498}.)

Agregue soporte de indexación negativa a @ref{8b7,,PurePath.parents}. (Aportado por Yaroslav Pankovych en bpo-21041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21041}.)

Add @ref{8b8,,Path.hardlink_to} method that
supersedes @code{link_to()}. The new method has the same argument
order as @ref{8b9,,symlink_to()}.
(Contributed by Barney Gale in bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}.)

@ref{8ba,,pathlib.Path.stat()} y @ref{8bb,,chmod()} ahora aceptan un argumento de solo palabra clave `follow_symlinks' para mantener la coherencia con las funciones correspondientes en el módulo @ref{a1,,os}. (Contribuido por Barney Gale en bpo-39906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39906}.)

@node plataforma,pprint,Pathlib,Módulos mejorados<3>
@anchor{whatsnew/3 10 platform}@anchor{8bc}
@subsubsection plataforma


Add @ref{8bd,,platform.freedesktop_os_release()} to retrieve operation system
identification from freedesktop.org os-release@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html} standard file.
(Contributed by Christian Heimes in bpo-28468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28468}.)

@node pprint,py_compile,plataforma,Módulos mejorados<3>
@anchor{whatsnew/3 10 pprint}@anchor{8be}
@subsubsection pprint


@ref{8bf,,pprint.pprint()} ahora acepta un nuevo argumento de palabra clave @code{underscore_numbers}. (Contribuido por sblondon en bpo-42914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42914}.)

@ref{ae,,pprint} ahora puede imprimir de forma bonita instancias de @ref{32e,,dataclasses.dataclass}. (Contribuido por Lewis Gaul en bpo-43080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43080}.)

@node py_compile,pyclbr,pprint,Módulos mejorados<3>
@anchor{whatsnew/3 10 py-compile}@anchor{8c0}
@subsubsection py_compile


Agregue la opción @code{--quiet} a la interfaz de línea de comandos de @ref{b3,,py_compile}. (Contribuido por Gregory Schevchenko en bpo-38731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38731}.)

@node pyclbr,dejar de lado,py_compile,Módulos mejorados<3>
@anchor{whatsnew/3 10 pyclbr}@anchor{8c1}
@subsubsection pyclbr


Add an @code{end_lineno} attribute to the @code{Function} and @code{Class}
objects in the tree returned by @ref{8c2,,pyclbr.readmodule()} and
@ref{8c3,,pyclbr.readmodule_ex()}.  It matches the existing (start) @code{lineno}.
(Contributed by Aviral Srivastava in bpo-38307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38307}.)

@node dejar de lado,Estadísticas,pyclbr,Módulos mejorados<3>
@anchor{whatsnew/3 10 shelve}@anchor{8c4}
@subsubsection dejar de lado


The @ref{c3,,shelve} module now uses @ref{8c5,,pickle.DEFAULT_PROTOCOL} by default
instead of @ref{a6,,pickle} protocol @code{3} when creating shelves.
(Contributed by Zackery Spytz in bpo-34204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34204}.)

@node Estadísticas,sitio,dejar de lado,Módulos mejorados<3>
@anchor{whatsnew/3 10 statistics}@anchor{8c6}
@subsubsection Estadísticas


Agregue las funciones @ref{8c7,,covariance()}, @ref{563,,correlation()} de Pearson y @ref{8c8,,linear_regression()} simple. (Contribuido por Tymoteusz Wołodźko en bpo-38490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38490}.)

@node sitio,enchufe<2>,Estadísticas,Módulos mejorados<3>
@anchor{whatsnew/3 10 site}@anchor{8c9}
@subsubsection sitio


Cuando un módulo no define @code{__loader__}, recurre a @code{__spec__.loader}. (Contribuido por Brett Cannon en bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node enchufe<2>,ssl<3>,sitio,Módulos mejorados<3>
@anchor{whatsnew/3 10 socket}@anchor{8ca}
@subsubsection enchufe


La excepción @ref{8cb,,socket.timeout} ahora es un alias de @ref{8cc,,TimeoutError}. (Contribuido por Christian Heimes en bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}.)

Agregue la opción para crear sockets MPTCP con @code{IPPROTO_MPTCP} (Contribuido por Rui Cunha en bpo-43571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43571}.)

Agregue la opción @code{IP_RECVTOS} para recibir el tipo de servicio (ToS) o los campos DSCP / ECN (Contribuido por Georg Sauthoff en bpo-44077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44077}).

@node ssl<3>,sqlite3<6>,enchufe<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 ssl}@anchor{8cd}
@subsubsection ssl


El módulo ssl requiere OpenSSL 1.1.1 o más reciente. (Contribuido por Christian Heimes en 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} y bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

The ssl module has preliminary support for OpenSSL 3.0.0 and new option
@ref{8ce,,OP_IGNORE_UNEXPECTED_EOF}.
(Contributed by Christian Heimes in bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820}, bpo-43794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43794},
bpo-43788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43788}, bpo-43791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43791}, bpo-43799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43799}, bpo-43920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43920},
bpo-43789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43789}, and bpo-43811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43811}.)

La función obsoleta y el uso de constantes obsoletas ahora dan como resultado un @ref{1da,,DeprecationWarning}. @ref{8cf,,ssl.SSLContext.options} tiene @ref{8d0,,OP_NO_SSLv2} y @ref{8d1,,OP_NO_SSLv3} configurados de forma predeterminada y, por lo tanto, no puede advertir sobre la configuración de la bandera nuevamente. El @ref{8d2,,deprecation section} tiene una lista de funciones obsoletas. (Contribuido por Christian Heimes en bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}.)

El módulo ssl ahora tiene una configuración predeterminada más segura. Los cifrados sin confidencialidad directa o SHA-1 MAC están deshabilitados de forma predeterminada. El nivel de seguridad 2 prohíbe claves RSA, DH y ECC débiles con menos de 112 bits de seguridad. @ref{1fa,,SSLContext} tiene por defecto la versión mínima del protocolo TLS 1.2. Los ajustes se basan en la investigación de Hynek Schlawack. (Contribuido por Christian Heimes en bpo-43998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43998}.)

Los protocolos obsoletos SSL 3.0, TLS 1.0 y TLS 1.1 ya no son compatibles oficialmente. Python no los bloquea activamente. Sin embargo, las opciones de compilación de OpenSSL, las configuraciones de distribución, los parches de proveedores y los conjuntos de cifrado pueden impedir un protocolo de enlace exitoso.

Agregue un parámetro `timeout' a la función @ref{8d3,,ssl.get_server_certificate()}. (Contribuido por Zackery Spytz en bpo-31870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31870}.)

El módulo ssl utiliza tipos de pila e inicialización multifase. (Contribuido por Christian Heimes en bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}.)

A new verify flag @ref{2c2,,VERIFY_X509_PARTIAL_CHAIN} has been added.
(Contributed by l0x in bpo-40849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40849}.)

@node sqlite3<6>,sys<4>,ssl<3>,Módulos mejorados<3>
@anchor{whatsnew/3 10 sqlite3}@anchor{8d4}
@subsubsection sqlite3


Agregue eventos de auditoría para @code{connect/handle()}, @ref{8d5,,enable_load_extension()} y @ref{55f,,load_extension()}. (Contribuido por Erlend E. Aasland en bpo-43762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43762}.)

@node sys<4>,_hilo,sqlite3<6>,Módulos mejorados<3>
@anchor{whatsnew/3 10 sys}@anchor{8d6}
@subsubsection sys


Agregar atributo @ref{8d7,,sys.orig_argv}: la lista de los argumentos originales de la línea de comando pasados al ejecutable de Python. (Contribuido por Victor Stinner en bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}.)

Agregue @ref{8d8,,sys.stdlib_module_names}, que contiene la lista de nombres de módulos de biblioteca estándar. (Contribuido por Victor Stinner en bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955}.)

@node _hilo,enhebrar<2>,sys<4>,Módulos mejorados<3>
@anchor{whatsnew/3 10 thread}@anchor{8d9}
@subsubsection _hilo


@ref{8da,,_thread.interrupt_main()} now takes an optional signal number to
simulate (the default is still @ref{8db,,signal.SIGINT}).
(Contributed by Antoine Pitrou in bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}.)

@node enhebrar<2>,rastrear<2>,_hilo,Módulos mejorados<3>
@anchor{whatsnew/3 10 threading}@anchor{8dc}
@subsubsection enhebrar


Agregue @ref{8dd,,threading.gettrace()} y @ref{8de,,threading.getprofile()} para recuperar las funciones establecidas por @ref{8df,,threading.settrace()} y @ref{8e0,,threading.setprofile()} respectivamente. (Contribuido por Mario Corchero en bpo-42251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42251}.)

Agregue @ref{8e1,,threading.__excepthook__} para permitir recuperar el valor original de @ref{8e2,,threading.excepthook()} en caso de que esté configurado en un valor roto o diferente. (Contribuido por Mario Corchero en bpo-42308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42308}.)

@node rastrear<2>,tipos,enhebrar<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 traceback}@anchor{8e3}
@subsubsection rastrear


Las funciones @ref{8e4,,format_exception()}, @ref{8e5,,format_exception_only()} y @ref{8e6,,print_exception()} ahora pueden tomar un objeto de excepción como un argumento solo posicional. (Contribuido por Zackery Spytz y Matthias Bussonnier en bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}.)

@node tipos,mecanografía<2>,rastrear<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 types}@anchor{8e7}
@subsubsection tipos


Reintroduzca las clases @ref{8e8,,types.EllipsisType}, @ref{8e9,,types.NoneType} y @ref{8ea,,types.NotImplementedType}, proporcionando un nuevo conjunto de tipos fácilmente interpretables por los verificadores de tipos. (Contribuido por Bas van Beek en bpo-41810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41810}.)

@node mecanografía<2>,prueba de unidad<2>,tipos,Módulos mejorados<3>
@anchor{whatsnew/3 10 typing}@anchor{8eb}
@subsubsection mecanografía


Para conocer los cambios importantes, consulte @ref{857,,Nuevas funciones relacionadas con las sugerencias de tipos}.

El comportamiento de @ref{8ec,,typing.Literal} se modificó para cumplir con 
@geindex Python Enhancement Proposals; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} y para coincidir con el comportamiento de los verificadores de tipo estático especificados en el PEP.


@enumerate 

@item 
@code{Literal} ahora elimina los parámetros duplicados.

@item 
Las comparaciones de igualdad entre objetos @code{Literal} ahora son independientes del orden.

@item 
Las comparaciones @code{Literal} ahora respetan los tipos. Por ejemplo, @code{Literal[0] == Literal[False]} se evaluó previamente como @code{True}. Ahora es @code{False}. Para admitir este cambio, la memoria caché de tipos utilizada internamente ahora admite tipos diferenciados.

@item 
Los objetos @code{Literal} ahora generarán una excepción @ref{228,,TypeError} durante las comparaciones de igualdad si alguno de sus parámetros no es @ref{6b1,,hashable}. Tenga en cuenta que declarar @code{Literal} con parámetros que no se pueden aplicar hash no arrojará un error:

@example
>>> from typing import Literal
>>> Literal[@{0@}]
>>> Literal[@{0@}] == Literal[@{False@}]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unhashable type: 'set'
@end example
@end enumerate

(Contribuido por Yurii Karabas en bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}.)

Agregue la nueva función @ref{8ed,,typing.is_typeddict()} a la introspección si una anotación es @ref{2ce,,typing.TypedDict}. (Contribuido por Patrick Reader en bpo-41792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41792}.)

Subclasses of @code{typing.Protocol} which only have data variables declared
will now raise a @code{TypeError} when checked with @code{isinstance} unless they
are decorated with @ref{4f0,,runtime_checkable()}.  Previously, these checks
passed silently.  Users should decorate their
subclasses with the @code{runtime_checkable()} decorator
if they want runtime protocols.
(Contributed by Yurii Karabas in bpo-38908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38908}.)

La importación desde los submódulos @code{typing.io} y @code{typing.re} ahora emitirá @ref{1da,,DeprecationWarning}. Estos submódulos quedaron obsoletos desde Python 3.8 y se eliminarán en una versión futura de Python. Todo lo que pertenezca a esos submódulos debe importarse directamente desde @ref{104,,typing}. (Aportado por Sebastian Rittau en bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}.)

@node prueba de unidad<2>,urllib parse,mecanografía<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 unittest}@anchor{8ee}
@subsubsection prueba de unidad


Agregue un nuevo método @ref{8ef,,assertNoLogs()} para complementar el @ref{8f0,,assertLogs()} existente. (Contribuido por Kit Yan Choi en bpo-39385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39385}.)

@node urllib parse,xml<2>,prueba de unidad<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 urllib-parse}@anchor{8f1}
@subsubsection urllib.parse


Python versions earlier than Python 3.10 allowed using both @code{;} and @code{&} as
query parameter separators in @ref{1c9,,urllib.parse.parse_qs()} and
@ref{1c8,,urllib.parse.parse_qsl()}.  Due to security concerns, and to conform with
newer W3C recommendations, this has been changed to allow only a single
separator key, with @code{&} as the default.  This change also affects
@code{cgi.parse()} and @code{cgi.parse_multipart()} as they use the affected
functions internally.  For more details, please see their respective
documentation.
(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

The presence of newline or tab characters in parts of a URL allows for some
forms of attacks. Following the WHATWG specification that updates 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html},
ASCII newline @code{\n}, @code{\r} and tab @code{\t} characters are stripped from the
URL by the parser in @ref{10a,,urllib.parse} preventing such attacks. The removal
characters are controlled by a new module level variable
@code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (See gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node xml<2>,zipimport<3>,urllib parse,Módulos mejorados<3>
@anchor{whatsnew/3 10 xml}@anchor{8f2}
@subsubsection xml


Agregue una clase @ref{8f3,,LexicalHandler} al módulo @ref{12a,,xml.sax.handler}. (Contribuido por Jonathan Gossage y Zackery Spytz en bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018}.)

@node zipimport<3>,,xml<2>,Módulos mejorados<3>
@anchor{whatsnew/3 10 zipimport}@anchor{8f4}
@subsubsection zipimport


Agregue métodos relacionados con 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}: @ref{8f5,,find_spec()}, @ref{8f6,,zipimport.zipimporter.create_module()} y @ref{20d,,zipimport.zipimporter.exec_module()}. (Contribuido por Brett Cannon en bpo-42131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42131}.)

Agregue el método @ref{8f7,,invalidate_caches()}. (Contribuido por Desmond Cheong en bpo-14678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14678}.)

@node Optimizaciones<3>,Obsoleto<5>,Módulos mejorados<3>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 optimizations}@anchor{8f8}
@subsection Optimizaciones



@itemize *

@item 
Los constructores @ref{237,,str()}, @ref{325,,bytes()} y @ref{5e0,,bytearray()} ahora son más rápidos (alrededor del 30-40% para objetos pequeños). (Contribuido por Serhiy Storchaka en bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334}.)

@item 
El módulo @ref{be,,runpy} ahora importa menos módulos. El tiempo de inicio del comando @code{python3 -m module-name} es 1,4 veces más rápido en promedio. En Linux, @code{python3 -I -m module-name} importa 69 módulos en Python 3.9, mientras que solo importa 51 módulos (-18) en Python 3.10. (Contribuido por Victor Stinner en bpo-41006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41006} y bpo-41718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41718}.)

@item 
La instrucción @code{LOAD_ATTR} ahora usa un nuevo mecanismo «por caché de código de operación». Es aproximadamente un 36% más rápido ahora para los atributos regulares y un 44% más rápido para las tragamonedas. (Contribuido por Pablo Galindo y Yury Selivanov en bpo-42093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42093} y Guido van Rossum en bpo-42927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42927}, basado en ideas implementadas originalmente en PyPy y MicroPython).

@item 
Al compilar Python con @ref{8f9,,--enable-optimizations}, ahora @code{-fno-semantic-interposition} se agrega tanto a la línea de compilación como a la de enlace. Esto acelera las compilaciones del intérprete de Python creado con @ref{8fa,,--enable-shared} con @code{gcc} hasta en un 30%. Consulte this article@footnote{https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/} para obtener más detalles. (Contribuido por Victor Stinner y Pablo Galindo en bpo-38980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38980}.)

@item 
Utilice un nuevo código de gestión del búfer de salida para los módulos @ref{14,,bz2} / @ref{8a,,lzma} / @ref{132,,zlib} y agregue la función @code{.readall()} a la clase @code{_compression.DecompressReader}. La descompresión de bz2 ahora es 1.09x ~ 1.17x más rápida, la descompresión de lzma 1.20x ~ 1.32x más rápida, @code{GzipFile.read(-1)} 1.11x ~ 1.18x más rápida. (Contribuido por Ma Lin, revisado por Gregory P. Smith, en bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486})

@item 
Cuando se utilizan anotaciones en cadena, los dictados de anotaciones para funciones ya no se crean cuando se crea la función. En su lugar, se almacenan como una tupla de cadenas, y el objeto de función convierte esto de forma perezosa en el dictado de anotaciones a pedido. Esta optimización reduce a la mitad el tiempo de CPU necesario para definir una función anotada. (Aportado por Yurii Karabas e Inada Naoki en bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}.)

@item 
Las funciones de búsqueda de subcadenas como @code{str1 in str2} y @code{str2.find(str1)} ahora utilizan a veces el algoritmo de búsqueda de cadenas «bidireccional» de Crochemore & Perrin para evitar el comportamiento cuadrático en cadenas largas. (Contribuido por Dennis Sweeney en bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972})

@item 
Agregue microoptimizaciones a @code{_PyType_Lookup()} para mejorar el rendimiento de búsqueda de caché de atributos de tipo en el caso común de coincidencias de caché. Esto hace que el intérprete sea 1,04 veces más rápido de media. (Aportado por Dino Viehland en bpo-43452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43452}.)

@item 
The following built-in functions now support the faster 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall calling convention:
@ref{14c,,map()}, @ref{8fb,,filter()}, @ref{8fc,,reversed()}, @ref{513,,bool()} and @ref{153,,float()}.
(Contributed by Donghee Na and Jeroen Demeyer in bpo-43575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43575}, bpo-43287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43287}, bpo-41922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41922}, bpo-41873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41873} and bpo-41870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41870}.)

@item 
@ref{8fd,,BZ2File} performance is improved by removing internal @code{RLock}.
This makes @code{BZ2File} thread unsafe in the face of multiple simultaneous
readers or writers, just like its equivalent classes in @ref{67,,gzip} and
@ref{8a,,lzma} have always been.  (Contributed by Inada Naoki in bpo-43785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43785}.)
@end itemize

@node Obsoleto<5>,Eliminado<3>,Optimizaciones<3>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 deprecated}@anchor{8fe}@anchor{whatsnew/3 10 whatsnew310-deprecated}@anchor{8d2}
@subsection Obsoleto



@itemize *

@item 
Actualmente, Python acepta literales numéricos seguidos inmediatamente de palabras clave, por ejemplo, @code{0in x}, @code{1or x}, @code{0if 1else 2}. Permite expresiones confusas y ambiguas como @code{[0x1for x in y]} (que puede interpretarse como @code{[0x1 for x in y]} o @code{[0x1f or x in y]}). A partir de esta versión, se genera una advertencia de desuso si el literal numérico va seguido inmediatamente por una de las palabras clave @ref{1e9,,and}, @ref{1ea,,else}, @ref{1eb,,for}, @ref{1ec,,if}, @ref{1ed,,in}, @ref{1ee,,is} y @ref{1ef,,or}. En versiones futuras, se cambiará a advertencia de sintaxis y, finalmente, a error de sintaxis. (Aportado por Serhiy Storchaka en bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}.)

@item 
Starting in this release, there will be a concerted effort to begin
cleaning up old import semantics that were kept for Python 2.7
compatibility. Specifically,
@code{find_loader()}/@code{find_module()}
(superseded by @ref{8ff,,find_spec()}),
@ref{900,,load_module()}
(superseded by @ref{901,,exec_module()}),
@code{module_repr()} (which the import system
takes care of for you), the @code{__package__} attribute
(superseded by @code{__spec__.parent}), the @code{__loader__} attribute
(superseded by @code{__spec__.loader}), and the @code{__cached__} attribute
(superseded by @code{__spec__.cached}) will slowly be removed (as well
as other classes and methods in @ref{77,,importlib}).
@ref{59f,,ImportWarning} and/or @ref{1da,,DeprecationWarning} will be raised
as appropriate to help identify code which needs updating during
this transition.

@item 
Todo el espacio de nombres @code{distutils} está obsoleto y se eliminará en Python 3.12. Consulte la sección @ref{7c6,,module changes} para obtener más información.

@item 
Los argumentos que no son enteros para @ref{902,,random.randrange()} están en desuso. El @ref{360,,ValueError} está en desuso en favor de un @ref{228,,TypeError}. (Contribuido por Serhiy Storchaka y Raymond Hettinger en bpo-37319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37319}.)

@item 
Los diversos métodos @code{load_module()} de @ref{77,,importlib} se han documentado como obsoletos desde Python 3.6, pero ahora también activarán un @ref{1da,,DeprecationWarning}. Utilice @ref{901,,exec_module()} en su lugar. (Contribuido por Brett Cannon en bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
@code{zimport.zipimporter.load_module()} has been deprecated in
preference for @ref{20d,,exec_module()}.
(Contributed by Brett Cannon in bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
El uso de @ref{900,,load_module()} por parte del sistema de importación ahora activa un @ref{59f,,ImportWarning} ya que se prefiere @ref{901,,exec_module()}. (Contribuido por Brett Cannon en bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
The use of @code{importlib.abc.MetaPathFinder.find_module()} and
@code{importlib.abc.PathEntryFinder.find_module()} by the import system now
trigger an @ref{59f,,ImportWarning} as
@ref{8ff,,importlib.abc.MetaPathFinder.find_spec()} and
@ref{903,,importlib.abc.PathEntryFinder.find_spec()}
are preferred, respectively. You can use
@ref{904,,importlib.util.spec_from_loader()} to help in porting.
(Contributed by Brett Cannon in bpo-42134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42134}.)

@item 
The use of @code{importlib.abc.PathEntryFinder.find_loader()} by the import
system now triggers an @ref{59f,,ImportWarning} as
@ref{903,,importlib.abc.PathEntryFinder.find_spec()} is preferred. You can use
@ref{904,,importlib.util.spec_from_loader()} to help in porting.
(Contributed by Brett Cannon in bpo-43672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43672}.)

@item 
The various implementations of
@code{importlib.abc.MetaPathFinder.find_module()} (
@code{importlib.machinery.BuiltinImporter.find_module()},
@code{importlib.machinery.FrozenImporter.find_module()},
@code{importlib.machinery.WindowsRegistryFinder.find_module()},
@code{importlib.machinery.PathFinder.find_module()},
@code{importlib.abc.MetaPathFinder.find_module()} ),
@code{importlib.abc.PathEntryFinder.find_module()} (
@code{importlib.machinery.FileFinder.find_module()} ), and
@code{importlib.abc.PathEntryFinder.find_loader()} (
@code{importlib.machinery.FileFinder.find_loader()} )
now raise @ref{1da,,DeprecationWarning} and are slated for removal in
Python 3.12 (previously they were documented as deprecated in Python 3.4).
(Contributed by Brett Cannon in bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}.)

@item 
@code{importlib.abc.Finder} is deprecated (including its sole method,
@code{find_module()}). Both
@ref{905,,importlib.abc.MetaPathFinder} and @ref{906,,importlib.abc.PathEntryFinder}
no longer inherit from the class. Users should inherit from one of these two
classes as appropriate instead.
(Contributed by Brett Cannon in bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}.)

@item 
The deprecations of @code{imp}, @code{importlib.find_loader()},
@code{importlib.util.set_package_wrapper()},
@code{importlib.util.set_loader_wrapper()},
@code{importlib.util.module_for_loader()},
@code{pkgutil.ImpImporter}, and
@code{pkgutil.ImpLoader} have all been updated to list Python 3.12 as the
slated version of removal (they began raising @ref{1da,,DeprecationWarning} in
previous versions of Python).
(Contributed by Brett Cannon in bpo-43720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43720}.)

@item 
The import system now uses the @code{__spec__} attribute on modules before
falling back on @code{module_repr()} for a module’s
@code{__repr__()} method. Removal of the use of @code{module_repr()} is scheduled
for Python 3.12.
(Contributed by Brett Cannon in bpo-42137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42137}.)

@item 
@code{importlib.abc.Loader.module_repr()},
@code{importlib.machinery.FrozenLoader.module_repr()}, and
@code{importlib.machinery.BuiltinLoader.module_repr()} are deprecated and
slated for removal in Python 3.12.
(Contributed by Brett Cannon in bpo-42136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42136}.)

@item 
@code{sqlite3.OptimizedUnicode} ha sido indocumentado y obsoleto desde Python 3.3, cuando se convirtió en un alias para @ref{237,,str}. Ahora está en desuso, programado para su eliminación en Python 3.12. (Contribuido por Erlend E. Aasland en bpo-42264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42264}.)

@item 
La función incorporada no documentada @code{sqlite3.enable_shared_cache} ahora está en desuso, programada para su eliminación en Python 3.12. Su uso está fuertemente desaconsejado por la documentación de SQLite3. Consulte the SQLite3 docs@footnote{https://sqlite.org/c3ref/enable_shared_cache.html} para obtener más detalles. Si se debe usar una caché compartida, abra la base de datos en modo URI usando el parámetro de consulta @code{cache=shared}. (Contribuido por Erlend E. Aasland en bpo-24464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24464}.)

@item 
Los siguientes métodos @code{threading} ahora están en desuso:


@itemize *

@item 
@code{threading.currentThread} => @ref{203,,threading.current_thread()}

@item 
@code{threading.activeCount} => @ref{204,,threading.active_count()}

@item 
@code{threading.Condition.notifyAll} =>
@ref{1fd,,threading.Condition.notify_all()}

@item 
@code{threading.Event.isSet} => @ref{1fe,,threading.Event.is_set()}

@item 
@code{threading.Thread.setName} => @ref{202,,threading.Thread.name}

@item 
@code{threading.thread.getName} => @ref{202,,threading.Thread.name}

@item 
@code{threading.Thread.isDaemon} => @ref{200,,threading.Thread.daemon}

@item 
@code{threading.Thread.setDaemon} => @ref{200,,threading.Thread.daemon}
@end itemize

(Aportado por Jelle Zijlstra en gh-87889@footnote{https://github.com/python/cpython/issues/87889}.)

@item 
@code{pathlib.Path.link_to()} is deprecated and slated for removal in
Python 3.12. Use @ref{8b8,,pathlib.Path.hardlink_to()} instead.
(Contributed by Barney Gale in bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}.)

@item 
@code{cgi.log()} está obsoleto y está programado para su eliminación en Python 3.12. (Contribuido por Inada Naoki en bpo-41139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41139}.)

@item 
Las siguientes funciones de @ref{d0,,ssl} han quedado obsoletas desde Python 3.6, Python 3.7 u OpenSSL 1.1.0 y se eliminarán en 3.11:


@itemize *

@item 
@code{OP_NO_SSLv2}, @code{OP_NO_SSLv3}, @code{OP_NO_TLSv1},
@code{OP_NO_TLSv1_1}, @code{OP_NO_TLSv1_2}, and
@code{OP_NO_TLSv1_3} are replaced by
@ref{907,,minimum_version} and
@ref{908,,maximum_version}.

@item 
@code{PROTOCOL_SSLv2}, @code{PROTOCOL_SSLv3},
@code{PROTOCOL_SSLv23}, @code{PROTOCOL_TLSv1},
@code{PROTOCOL_TLSv1_1}, @code{PROTOCOL_TLSv1_2}, and
@code{PROTOCOL_TLS} are deprecated in favor of
@ref{909,,PROTOCOL_TLS_CLIENT} and @ref{90a,,PROTOCOL_TLS_SERVER}

@item 
@code{wrap_socket()} is replaced by @ref{5c8,,ssl.SSLContext.wrap_socket()}

@item 
@code{match_hostname()}

@item 
@code{RAND_pseudo_bytes()}, @code{RAND_egd()}

@item 
Las funciones NPN como @ref{90b,,ssl.SSLSocket.selected_npn_protocol()} y @ref{1fb,,ssl.SSLContext.set_npn_protocols()} son reemplazadas por ALPN.
@end itemize

@item 
The threading debug (@code{PYTHONTHREADDEBUG} environment variable) is
deprecated in Python 3.10 and will be removed in Python 3.12. This feature
requires a @ref{357,,debug build of Python}.
(Contributed by Victor Stinner in bpo-44584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44584}.)

@item 
La importación desde los submódulos @code{typing.io} y @code{typing.re} ahora emitirá @ref{1da,,DeprecationWarning}. Estos submódulos se eliminarán en una versión futura de Python. Todo lo que pertenezca a estos submódulos debe importarse directamente desde @ref{104,,typing}. (Aportado por Sebastian Rittau en bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}.)
@end itemize

@node Eliminado<3>,Portar a Python 3 10,Obsoleto<5>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 removed}@anchor{90c}@anchor{whatsnew/3 10 whatsnew310-removed}@anchor{90d}
@subsection Eliminado



@itemize *

@item 
Se eliminaron los métodos especiales @code{__int__}, @code{__float__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__rfloordiv__}, @code{__rmod__} y @code{__rdivmod__} de la clase @ref{154,,complex}. Siempre levantaron un @ref{228,,TypeError}. (Contribuido por Serhiy Storchaka en bpo-41974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41974}.)

@item 
Se ha eliminado el método @code{ParserBase.error()} del módulo @code{_markupbase} privado e indocumentado. @ref{90e,,html.parser.HTMLParser} es la única subclase de @code{ParserBase} y su implementación @code{error()} ya se eliminó en Python 3.5. (Contribuido por Berker Peksag en bpo-31844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31844}.)

@item 
Se eliminó el atributo @code{unicodedata.ucnhash_CAPI} que era un objeto interno de PyCapsule. La estructura @code{_PyUnicode_Name_CAPI} privada relacionada se movió a la API C interna. (Contribuido por Victor Stinner en bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}.)

@item 
Se eliminó el módulo @code{parser}, que quedó obsoleto en 3.9 debido al cambio al nuevo analizador PEG, así como todos los archivos fuente y de encabezado C que solo usaba el analizador anterior, incluidos @code{node.h}, @code{parser.h}, @code{graminit.h} y @code{grammar.h}.

@item 
Se eliminaron las funciones de la API pública de C @code{PyParser_SimpleParseStringFlags}, @code{PyParser_SimpleParseStringFlagsFilename}, @code{PyParser_SimpleParseFileFlags} y @code{PyNode_Compile} que estaban en desuso en 3.9 debido al cambio al nuevo analizador PEG.

@item 
Removed the @code{formatter} module, which was deprecated in Python 3.4.
It is somewhat obsolete, little used, and not tested. It was originally
scheduled to be removed in Python 3.6, but such removals were delayed until
after Python 2.7 EOL. Existing users should copy whatever classes they use
into their code.
(Contributed by Donghee Na and Terry J. Reedy in bpo-42299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42299}.)

@item 
Removed the @code{PyModule_GetWarningsModule()} function that was useless
now due to the @code{_warnings} module was converted to a builtin module in 2.6.
(Contributed by Hai Shi in bpo-42599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42599}.)

@item 
Elimine los alias obsoletos a @ref{90f,,Colecciones clases base abstractas} del módulo @ref{1e,,collections}. (Contribuido por Victor Stinner en bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324}.)

@item 
El parámetro @code{loop} se ha eliminado de la mayoría de @ref{b,,asyncio}“s @ref{910,,API de alto nivel} después de la desaprobación en Python 3.8. La motivación detrás de este cambio es múltiple:


@enumerate 

@item 
Esto simplifica la API de alto nivel.

@item 
Las funciones en la API de alto nivel han obtenido implícitamente el bucle de eventos en ejecución del hilo actual desde Python 3.7. No es necesario pasar el bucle de eventos a la API en la mayoría de los casos de uso normales.

@item 
El paso de bucles de eventos es propenso a errores, especialmente cuando se trata de bucles que se ejecutan en diferentes subprocesos.
@end enumerate

Tenga en cuenta que la API de bajo nivel seguirá aceptando @code{loop}. Consulte @ref{911,,Cambios en la API de Python} para ver ejemplos de cómo reemplazar el código existente.

(Contribuido por Yurii Karabas, Andrew Svetlov, Yury Selivanov y Kyle Stanley en bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}.)
@end itemize

@node Portar a Python 3 10,Cambios en el código de bytes de CPython<3>,Eliminado<3>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 porting-to-python-3-10}@anchor{912}
@subsection Portar a Python 3.10


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en la sintaxis de Python:: 
* Cambios en la API de Python: Cambios en la API de Python<2>. 
* Cambios en la API de C: Cambios en la API de C<3>. 

@end menu

@node Cambios en la sintaxis de Python,Cambios en la API de Python<2>,,Portar a Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-syntax}@anchor{913}
@subsubsection Cambios en la sintaxis de Python



@itemize *

@item 
Ahora se emite una advertencia de desaprobación cuando se compila una sintaxis previamente válida si el literal numérico va seguido inmediatamente de una palabra clave (como en @code{0in x}). En versiones futuras, se cambiará a advertencia de sintaxis y, finalmente, a error de sintaxis. Para deshacerse de la advertencia y hacer que el código sea compatible con versiones futuras, simplemente agregue un espacio entre el literal numérico y la siguiente palabra clave. (Aportado por Serhiy Storchaka en bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}.)
@end itemize

@node Cambios en la API de Python<2>,Cambios en la API de C<3>,Cambios en la sintaxis de Python,Portar a Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-api}@anchor{914}@anchor{whatsnew/3 10 changes-python-api}@anchor{911}
@subsubsection Cambios en la API de Python



@itemize *

@item 
Los parámetros `etype' de las funciones @ref{8e4,,format_exception()}, @ref{8e5,,format_exception_only()}, y @ref{8e6,,print_exception()} en el módulo @ref{fe,,traceback} han sido renombradas a `exc'. (Contribuido por Zackery Spytz y Matthias Bussonnier en bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}.)

@item 
@ref{d,,atexit}: en la salida de Python, si falla una devolución de llamada registrada con @ref{915,,atexit.register()}, ahora se registra su excepción. Anteriormente, solo se registraban algunas excepciones y la última excepción siempre se ignoraba en silencio. (Contribuido por Victor Stinner en bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}.)

@item 
@ref{881,,collections.abc.Callable} genérico ahora aplana los parámetros de tipo, similar a lo que hace actualmente @ref{85e,,typing.Callable}. Esto significa que @code{collections.abc.Callable[[int, str], str]} tendrá @code{__args__} de @code{(int, str, str)}; anteriormente esto era @code{([int, str], str)}. El código que accede a los argumentos a través de @ref{916,,typing.get_args()} o @code{__args__} debe tener en cuenta este cambio. Además, @ref{228,,TypeError} se puede generar para formas no válidas de parametrizar @ref{881,,collections.abc.Callable} que pueden haber pasado silenciosamente en Python 3.9. (Contribuido por Ken Jin en bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@item 
@ref{917,,socket.htons()} y @ref{918,,socket.ntohs()} ahora generan @ref{919,,OverflowError} en lugar de @ref{1da,,DeprecationWarning} si el parámetro dado no cabe en un entero sin signo de 16 bits. (Contribuido por Erlend E. Aasland en bpo-42393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42393}.)

@item 
El parámetro @code{loop} se ha eliminado de la mayoría de @ref{b,,asyncio}“s @ref{910,,API de alto nivel} después de la desaprobación en Python 3.8.

Una corrutina que actualmente se ve así:

@example
async def foo(loop):
    await asyncio.sleep(1, loop=loop)
@end example

Debería ser reemplazado por esto:

@example
async def foo():
    await asyncio.sleep(1)
@end example

Si @code{foo()} fue diseñado específicamente `not' para ejecutarse en el bucle de eventos en ejecución del hilo actual (por ejemplo, ejecutándose en el bucle de eventos de otro hilo), considere usar @ref{91a,,asyncio.run_coroutine_threadsafe()} en su lugar.

(Contribuido por Yurii Karabas, Andrew Svetlov, Yury Selivanov y Kyle Stanley en bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}.)

@item 
El constructor @ref{91b,,types.FunctionType} ahora hereda las incorporaciones actuales si el diccionario `globals' no tiene clave @code{"__builtins__"}, en lugar de usar @code{@{"None": None@}} como incorporaciones: el mismo comportamiento que las funciones @ref{2eb,,eval()} y @ref{2ea,,exec()}. La definición de una función con @code{def function(...): ...} en Python no se ve afectada, los globales no se pueden anular con esta sintaxis: también hereda las incorporaciones actuales. (Contribuido por Victor Stinner en bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}.)
@end itemize

@node Cambios en la API de C<3>,,Cambios en la API de Python<2>,Portar a Python 3 10
@anchor{whatsnew/3 10 changes-in-the-c-api}@anchor{91c}
@subsubsection Cambios en la API de C



@itemize *

@item 
Las funciones de API C @code{PyParser_SimpleParseStringFlags}, @code{PyParser_SimpleParseStringFlagsFilename}, @code{PyParser_SimpleParseFileFlags}, @code{PyNode_Compile} y el tipo utilizado por estas funciones, @code{struct _node}, se eliminaron debido al cambio al nuevo analizador PEG.

La fuente debe compilarse ahora directamente en un objeto de código utilizando, por ejemplo, @ref{91d,,Py_CompileString()}. A continuación, el objeto de código resultante se puede evaluar utilizando, por ejemplo, @ref{91e,,PyEval_EvalCode()}.

Específicamente:


@itemize *

@item 
Una llamada a @code{PyParser_SimpleParseStringFlags} seguida de @code{PyNode_Compile} se puede reemplazar llamando a @ref{91d,,Py_CompileString()}.

@item 
No hay reemplazo directo para @code{PyParser_SimpleParseFileFlags}. Para compilar código a partir de un argumento @code{FILE *}, deberá leer el archivo en C y pasar el búfer resultante a @ref{91d,,Py_CompileString()}.

@item 
Para compilar un archivo con un nombre de archivo @code{char *}, abra explícitamente el archivo, léalo y compile el resultado. Una forma de hacerlo es utilizando el módulo @ref{7f,,io} con @ref{273,,PyImport_ImportModule()}, @ref{492,,PyObject_CallMethod()}, @ref{91f,,PyBytes_AsString()} y @ref{91d,,Py_CompileString()}, como se muestra a continuación. (Se omiten las declaraciones y el manejo de errores).

@example
io_module = Import_ImportModule("io");
fileobject = PyObject_CallMethod(io_module, "open", "ss", filename, "rb");
source_bytes_object = PyObject_CallMethod(fileobject, "read", "");
result = PyObject_CallMethod(fileobject, "close", "");
source_buf = PyBytes_AsString(source_bytes_object);
code = Py_CompileString(source_buf, filename, Py_file_input);
@end example

@item 
For @code{FrameObject} objects, the @ref{920,,f_lasti} member now represents a wordcode
offset instead of a simple offset into the bytecode string. This means that this
number needs to be multiplied by 2 to be used with APIs that expect a byte offset
instead (like @ref{921,,PyCode_Addr2Line()} for example). Notice as well that the
@code{f_lasti} member of @code{FrameObject} objects is not considered stable: please
use @ref{824,,PyFrame_GetLineNumber()} instead.
@end itemize
@end itemize

@node Cambios en el código de bytes de CPython<3>,Construir cambios<2>,Portar a Python 3 10,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 cpython-bytecode-changes}@anchor{922}
@subsection Cambios en el código de bytes de CPython



@itemize *

@item 
La instrucción @code{MAKE_FUNCTION} ahora acepta un dict o una tupla de cadenas como anotaciones de la función. (Aportado por Yurii Karabas e Inada Naoki en bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}.)
@end itemize

@node Construir cambios<2>,Cambios en la API de C<4>,Cambios en el código de bytes de CPython<3>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 build-changes}@anchor{923}
@subsection Construir cambios



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}: Python ahora requiere OpenSSL 1.1.1 o más reciente. OpenSSL 1.0.2 ya no es compatible. (Contribuido por Christian Heimes en bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

@item 
Las funciones C99 @code{snprintf()} y @code{vsnprintf()} ahora son necesarias para construir Python. (Contribuido por Victor Stinner en bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}.)

@item 
@ref{cf,,sqlite3} requiere SQLite 3.7.15 o superior. (Aportado por Sergey Fedoseev y Erlend E. Aasland en bpo-40744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40744} y bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}).

@item 
El módulo @ref{d,,atexit} ahora debe construirse siempre como un módulo integrado. (Contribuido por Victor Stinner en bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}.)

@item 
Agregue la opción @ref{924,,--disable-test-modules} al script @code{configure}: no cree ni instale módulos de prueba. (Contribuido por Xavier de Gaye, Thomas Petazzoni y Peixing Xin en bpo-27640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27640}.)

@item 
Agregue @ref{925,,--with-wheel-pkg-dir=PATH option} al script @code{./configure}. Si se especifica, el módulo @ref{55,,ensurepip} busca paquetes de ruedas @code{setuptools} y @code{pip} en este directorio: si ambos están presentes, estos paquetes de ruedas se utilizan en lugar de los paquetes de ruedas asegurados.

Algunas políticas de empaquetado de distribución de Linux recomiendan no empaquetar dependencias. Por ejemplo, Fedora instala paquetes de rueda en el directorio @code{/usr/share/python-wheels/} y no instala el paquete @code{ensurepip._bundled}.

(Contribuido por Victor Stinner en bpo-42856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42856}.)

@item 
Agregue un nuevo @ref{926,,configure --without-static-libpython option} para no construir la biblioteca estática @code{libpythonMAJOR.MINOR.a} y no instalar el archivo de objeto @code{python.o}.

(Contribuido por Victor Stinner en bpo-43103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43103}.)

@item 
El script @code{configure} ahora usa la utilidad @code{pkg-config}, si está disponible, para detectar la ubicación de los encabezados y bibliotecas Tcl/Tk. Como antes, esas ubicaciones se pueden especificar explícitamente con las opciones de configuración @code{--with-tcltk-includes} y @code{--with-tcltk-libs}. (Aportado por Manolis Stamatogiannakis en bpo-42603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42603}.)

@item 
Agregue la opción @ref{927,,--with-openssl-rpath} al script @code{configure}. La opción simplifica la construcción de Python con una instalación personalizada de OpenSSL, p. Ej. @code{./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto}. (Contribuido por Christian Heimes en bpo-43466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43466}.)
@end itemize

@node Cambios en la API de C<4>,Notable security feature in 3 10 7,Construir cambios<2>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 c-api-changes}@anchor{928}
@subsection Cambios en la API de C


@menu
* PEP 652; Mantenimiento del ABI estable: PEP 652 Mantenimiento del ABI estable. 
* Nuevas características: Nuevas características<6>. 
* Portar a Python 3.10: Portar a Python 3 10<2>. 
* Obsoleto: Obsoleto<6>. 
* Eliminado: Eliminado<4>. 

@end menu

@node PEP 652 Mantenimiento del ABI estable,Nuevas características<6>,,Cambios en la API de C<4>
@anchor{whatsnew/3 10 pep-652-maintaining-the-stable-abi}@anchor{929}
@subsubsection PEP 652: Mantenimiento del ABI estable


La ABI estable (interfaz binaria de aplicación) para módulos de extensión o incrustación de Python ahora está definida explícitamente. @ref{5f6,,Estabilidad de la API en C} describe las garantías de estabilidad C API y ABI junto con las mejores prácticas para usar la ABI estable.

(Contribuido por Petr Viktorin en 
@geindex Python Enhancement Proposals; PEP 652
PEP 652@footnote{https://peps.python.org/pep-0652/} y bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}.)

@node Nuevas características<6>,Portar a Python 3 10<2>,PEP 652 Mantenimiento del ABI estable,Cambios en la API de C<4>
@anchor{whatsnew/3 10 id1}@anchor{92a}
@subsubsection Nuevas características



@itemize *

@item 
El resultado de @ref{92b,,PyNumber_Index()} ahora siempre tiene el tipo exacto @ref{1f0,,int}. Anteriormente, el resultado podría haber sido una instancia de una subclase de @code{int}. (Contribuido por Serhiy Storchaka en bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}.)

@item 
Agregue un nuevo miembro @ref{92c,,orig_argv} a la estructura @ref{499,,PyConfig}: la lista de los argumentos originales de la línea de comandos pasados al ejecutable de Python. (Contribuido por Victor Stinner en bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}.)

@item 
Se han agregado las macros @ref{92d,,PyDateTime_DATE_GET_TZINFO()} y @ref{92e,,PyDateTime_TIME_GET_TZINFO()} para acceder a los atributos @code{tzinfo} de los objetos @ref{32f,,datetime.datetime} y @ref{331,,datetime.time}. (Contribuido por Zackery Spytz en bpo-30155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30155}.)

@item 
Agregue una función @ref{92f,,PyCodec_Unregister()} para anular el registro de una función de búsqueda de códec. (Contribuido por Hai Shi en bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}.)

@item 
Se agregó la función @ref{930,,PyIter_Send()} para permitir el envío de valor al iterador sin generar la excepción @code{StopIteration}. (Contribuido por Vladimir Matveev en bpo-41756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41756}.)

@item 
Agregue @ref{931,,PyUnicode_AsUTF8AndSize()} a la API C limitada. (Contribuido por Alex Gaynor en bpo-41784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41784}.)

@item 
Agregue la función @ref{459,,PyModule_AddObjectRef()}: similar a @ref{45a,,PyModule_AddObject()} pero no robe una referencia al valor en caso de éxito. (Contribuido por Victor Stinner en bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}.)

@item 
Agregue las funciones @ref{932,,Py_NewRef()} y @ref{933,,Py_XNewRef()} para incrementar el recuento de referencia de un objeto y devolver el objeto. (Contribuido por Victor Stinner en bpo-42262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42262}.)

@item 
Las funciones @ref{622,,PyType_FromSpecWithBases()} y @ref{5f4,,PyType_FromModuleAndSpec()} ahora aceptan una sola clase como argumento `bases'. (Contribuido por Serhiy Storchaka en bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423}.)

@item 
La función @ref{5f4,,PyType_FromModuleAndSpec()} ahora acepta la ranura NULL @code{tp_doc}. (Contribuido por Hai Shi en bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832}.)

@item 
La función @ref{934,,PyType_GetSlot()} puede aceptar @ref{819,,static types}. (Contribuido por Hai Shi y Petr Viktorin en bpo-41073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41073}.)

@item 
Agregue una nueva función @ref{935,,PySet_CheckExact()} a la C-API para verificar si un objeto es una instancia de @ref{67a,,set} pero no una instancia de un subtipo. (Contribuido por Pablo Galindo en bpo-43277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43277}.)

@item 
Agregue @ref{936,,PyErr_SetInterruptEx()} que permite pasar un número de señal para simular. (Contribuido por Antoine Pitrou en bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}.)

@item 
La API C limitada ahora es compatible si @ref{357,,Python is built in debug mode} (si se define la macro @code{Py_DEBUG}). En la API C limitada, las funciones @ref{612,,Py_INCREF()} y @ref{613,,Py_DECREF()} ahora se implementan como llamadas de función opacas, en lugar de acceder directamente al miembro @ref{937,,PyObject.ob_refcnt}, si Python está construido en modo de depuración y la macro @code{Py_LIMITED_API} apunta a Python 3.10 o más reciente. Se hizo posible admitir la API C limitada en modo de depuración porque la estructura @ref{42d,,PyObject} es la misma en el modo de liberación y depuración desde Python 3.8 (ver bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}).

La API C limitada todavía no es compatible con la compilación especial @ref{487,,--with-trace-refs} (macro @code{Py_TRACE_REFS}). (Contribuido por Victor Stinner en bpo-43688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43688}.)

@item 
Agregue la función @ref{938,,Py_Is(x@comma{} y)} para probar si el objeto `x' object is the `y', lo mismo que @code{x is y} en Python. Agregue también las funciones @ref{939,,Py_IsNone()}, @ref{93a,,Py_IsTrue()}, @ref{93b,,Py_IsFalse()} para probar si un objeto es, respectivamente, el singleton @code{None}, el singleton @code{True} o el singleton @code{False}. (Contribuido por Victor Stinner en bpo-43753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43753}.)

@item 
Agregue nuevas funciones para controlar el recolector de basura desde el código C: @ref{93c,,PyGC_Enable()}, @ref{93d,,PyGC_Disable()}, @ref{93e,,PyGC_IsEnabled()}. Estas funciones permiten activar, desactivar y consultar el estado del recolector de basura desde código C sin tener que importar el módulo @ref{60,,gc}.

@item 
Add a new @ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION} type flag to disallow
creating type instances.
(Contributed by Victor Stinner in bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916}.)

@item 
Add a new @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} type flag for creating immutable
type objects: type attributes cannot be set nor deleted.
(Contributed by Victor Stinner and Erlend E. Aasland in bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}.)
@end itemize

@node Portar a Python 3 10<2>,Obsoleto<6>,Nuevas características<6>,Cambios en la API de C<4>
@anchor{whatsnew/3 10 id2}@anchor{93f}
@subsubsection Portar a Python 3.10



@itemize *

@item 
La macro @code{PY_SSIZE_T_CLEAN} ahora debe definirse para usar los formatos @ref{615,,PyArg_ParseTuple()} y @ref{940,,Py_BuildValue()} que usan @code{#}: @code{es#}, @code{et#}, @code{s#}, @code{u#}, @code{y#}, @code{z#}, @code{U#} y @code{Z#}. Consulte @ref{941,,Analizando argumentos y construyendo valores} y 
@geindex Python Enhancement Proposals; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}. (Aportado por Victor Stinner en bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}.)

@item 
Dado que @ref{26f,,Py_REFCNT()} se cambia a la función estática en línea, @code{Py_REFCNT(obj) = new_refcnt} debe reemplazarse con @code{Py_SET_REFCNT(obj, new_refcnt)}: consulte @ref{942,,Py_SET_REFCNT()} (disponible desde Python 3.9). Para compatibilidad con versiones anteriores, esta macro se puede utilizar:

@example
#if PY_VERSION_HEX < 0x030900A4
#  define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
#endif
@end example

(Contribuido por Victor Stinner en bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
Se había permitido llamar a @ref{479,,PyDict_GetItem()} sin @ref{2c5,,GIL} retenido por motivos históricos. Ya no está permitido. (Contribuido por Victor Stinner en bpo-40839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40839}.)

@item 
@code{PyUnicode_FromUnicode(NULL, size)} y @code{PyUnicode_FromStringAndSize(NULL, size)} generan @code{DeprecationWarning} ahora. Utilice @ref{943,,PyUnicode_New()} para asignar un objeto Unicode sin datos iniciales. (Contribuido por Inada Naoki en bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
La estructura @code{_PyUnicode_Name_CAPI} privada de la API @code{unicodedata.ucnhash_CAPI} de PyCapsule se ha movido a la API C interna. (Contribuido por Victor Stinner en bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}.)

@item 
Las funciones @ref{27d,,Py_GetPath()}, @ref{27f,,Py_GetPrefix()}, @ref{27a,,Py_GetExecPrefix()}, @ref{282,,Py_GetProgramFullPath()}, @ref{285,,Py_GetPythonHome()} y @ref{284,,Py_GetProgramName()} ahora devuelven @code{NULL} si se llama antes de @ref{247,,Py_Initialize()} (antes de que se inicialice Python). Utilice la nueva API @ref{49a,,Configuración de inicialización de Python} para obtener el @ref{944,,Configuración de la ruta de Python}. (Aportado por Victor Stinner en bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}.)

@item 
Las macros @ref{480,,PyList_SET_ITEM()}, @ref{47f,,PyTuple_SET_ITEM()} y @ref{945,,PyCell_SET()} ya no se pueden utilizar como valor l o valor r. Por ejemplo, @code{x = PyList_SET_ITEM(a, b, c)} y @code{PyList_SET_ITEM(a, b, c) = x} ahora fallan con un error del compilador. Previene errores como la prueba @code{if (PyList_SET_ITEM (a, b, c) < 0) ...}. (Contribuido por Zackery Spytz y Victor Stinner en bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459}.)

@item 
Los archivos de API no limitados @code{odictobject.h}, @code{parser_interface.h}, @code{picklebufobject.h}, @code{pyarena.h}, @code{pyctype.h}, @code{pydebug.h}, @code{pyfpe.h} y @code{pytime.h} se han movido al directorio @code{Include/cpython}. Estos archivos no deben incluirse directamente, ya que ya están incluidos en @code{Python.h}; ver @ref{81d,,Archivos de cabecera (Include)}. Si se han incluido directamente, considere incluir @code{Python.h} en su lugar. (Aportado por Nicholas Sim en bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
Use the @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} type flag to create immutable type
objects. Do not rely on @ref{946,,Py_TPFLAGS_HEAPTYPE} to decide if a type
object is mutable or not; check if @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} is set
instead.
(Contributed by Victor Stinner and Erlend E. Aasland in bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}.)

@item 
La función no documentada @code{Py_FrozenMain} se eliminó de la API limitada. La función es principalmente útil para compilaciones personalizadas de Python. (Aportado por Petr Viktorin en bpo-26241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26241}.)
@end itemize

@node Obsoleto<6>,Eliminado<4>,Portar a Python 3 10<2>,Cambios en la API de C<4>
@anchor{whatsnew/3 10 id3}@anchor{947}
@subsubsection Obsoleto



@itemize *

@item 
La función @code{PyUnicode_InternImmortal()} ahora está en desuso y se eliminará en Python 3.12: use @ref{948,,PyUnicode_InternInPlace()} en su lugar. (Contribuido por Victor Stinner en bpo-41692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41692}.)
@end itemize

@node Eliminado<4>,,Obsoleto<6>,Cambios en la API de C<4>
@anchor{whatsnew/3 10 id4}@anchor{949}
@subsubsection Eliminado



@itemize *

@item 
Se eliminaron las funciones @code{Py_UNICODE_str*} que manipulaban cadenas @code{Py_UNICODE*}. (Contribuido por Inada Naoki en bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}.)


@itemize *

@item 
@code{Py_UNICODE_strlen}: utilice @ref{94a,,PyUnicode_GetLength()} o @ref{94b,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat}: utilice @ref{94c,,PyUnicode_CopyCharacters()} o @ref{47c,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy}, @code{Py_UNICODE_strncpy}: utilice @ref{94c,,PyUnicode_CopyCharacters()} o @ref{94d,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp}: utilice @ref{94e,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp}: utilice @ref{94f,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr}, @code{Py_UNICODE_strrchr}: utilice @ref{950,,PyUnicode_FindChar()}
@end itemize

@item 
Eliminado @code{PyUnicode_GetMax()}. Migra a las API nuevas (
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}). (Contribuido por Inada Naoki en bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}.)

@item 
Eliminado @code{PyLong_FromUnicode()}. Migra a @ref{951,,PyLong_FromUnicodeObject()}. (Contribuido por Inada Naoki en bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}.)

@item 
Eliminado @code{PyUnicode_AsUnicodeCopy()}. Utilice @ref{952,,PyUnicode_AsUCS4Copy()} o @ref{953,,PyUnicode_AsWideCharString()} (contribución de Inada Naoki en bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}).

@item 
Variable @code{_Py_CheckRecursionLimit} eliminada: ha sido reemplazada por @code{ceval.recursion_limit} de la estructura @ref{954,,PyInterpreterState}. (Contribuido por Victor Stinner en bpo-41834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41834}.)

@item 
Se eliminaron las macros @code{Py_ALLOW_RECURSION} y @code{Py_END_ALLOW_RECURSION} sin documentar y el campo @code{recursion_critical} de la estructura @ref{954,,PyInterpreterState}. (Contribuido por Serhiy Storchaka en bpo-41936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41936}.)

@item 
Se eliminó la función @code{PyOS_InitInterrupts()} indocumentada. La inicialización de Python ya instala implícitamente controladores de señales: consulte @ref{955,,PyConfig.install_signal_handlers}. (Contribuido por Victor Stinner en bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}.)

@item 
Elimina la función @code{PyAST_Validate()}. Ya no es posible construir un objeto AST (tipo @code{mod_ty}) con la API C pública. La función ya estaba excluida de la API C limitada (
@geindex Python Enhancement Proposals; PEP 384
PEP 384@footnote{https://peps.python.org/pep-0384/}). (Contribuido por Victor Stinner en bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Elimine el archivo de encabezado @code{symtable.h} y las funciones no documentadas:


@itemize *

@item 
@code{PyST_GetScope()}

@item 
@code{PySymtable_Build()}

@item 
@code{PySymtable_BuildObject()}

@item 
@code{PySymtable_Free()}

@item 
@code{Py_SymtableString()}

@item 
@code{Py_SymtableStringObject()}
@end itemize

La función @code{Py_SymtableString()} fue parte de la ABI estable por error, pero no se pudo usar porque el archivo de encabezado @code{symtable.h} se excluyó de la API C limitada.

En su lugar, utilice el módulo Python @ref{d8,,symtable}. (Contribuido por Victor Stinner en bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Elimine @ref{62a,,PyOS_ReadlineFunctionPointer()} de los encabezados limitados de la API C y de @code{python3.dll}, la biblioteca que proporciona la ABI estable en Windows. Dado que la función toma un argumento @code{FILE*}, no se puede garantizar su estabilidad ABI. (Contribuido por Petr Viktorin en bpo-43868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43868}.)

@item 
Elimine los archivos de encabezado @code{ast.h}, @code{asdl.h} y @code{Python-ast.h}. Estas funciones no estaban documentadas y se excluyeron de la API C limitada. La mayoría de los nombres definidos por estos archivos de encabezado no tenían el prefijo @code{Py} y, por lo tanto, podrían crear conflictos de nombres. Por ejemplo, @code{Python-ast.h} definió una macro @code{Yield} que estaba en conflicto con el nombre @code{Yield} utilizado por el encabezado @code{<winbase.h>} de Windows. En su lugar, utilice el módulo Python @ref{9,,ast}. (Contribuido por Victor Stinner en bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Elimine las funciones de compilador y analizador utilizando el tipo @code{struct _mod}, porque se eliminó la API de AST C pública:


@itemize *

@item 
@code{PyAST_Compile()}

@item 
@code{PyAST_CompileEx()}

@item 
@code{PyAST_CompileObject()}

@item 
@code{PyFuture_FromAST()}

@item 
@code{PyFuture_FromASTObject()}

@item 
@code{PyParser_ASTFromFile()}

@item 
@code{PyParser_ASTFromFileObject()}

@item 
@code{PyParser_ASTFromFilename()}

@item 
@code{PyParser_ASTFromString()}

@item 
@code{PyParser_ASTFromStringObject()}
@end itemize

Estas funciones no estaban documentadas y se excluyeron de la API C limitada. (Contribuido por Victor Stinner en bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Elimine el archivo de encabezado @code{pyarena.h} con funciones:


@itemize *

@item 
@code{PyArena_New()}

@item 
@code{PyArena_Free()}

@item 
@code{PyArena_Malloc()}

@item 
@code{PyArena_AddPyObject()}
@end itemize

Estas funciones no estaban documentadas, estaban excluidas de la API C limitada y el compilador solo las usaba internamente. (Contribuido por Victor Stinner en bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
El miembro @code{PyThreadState.use_tracing} se ha eliminado para optimizar Python. (Contribuido por Mark Shannon en bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}.)
@end itemize

@node Notable security feature in 3 10 7,Notable security feature in 3 10 8,Cambios en la API de C<4>,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-7}@anchor{956}
@subsection Notable security feature in 3.10.7


Converting between @ref{1f0,,int} and @ref{237,,str} in bases other than 2
(binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal)
now raises a @ref{360,,ValueError} if the number of digits in string form is
above a limit to avoid potential denial of service attacks due to the
algorithmic complexity. This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.
This limit can be configured or disabled by environment variable, command
line flag, or @ref{d9,,sys} APIs. See the @ref{695,,integer string conversion length limitation} documentation.  The default limit
is 4300 digits in string form.

@node Notable security feature in 3 10 8,Notable changes in 3 10 12,Notable security feature in 3 10 7,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-8}@anchor{957}
@subsection Notable security feature in 3.10.8


The deprecated @code{mailcap} module now refuses to inject unsafe text
(filenames, MIME types, parameters) into shell commands. Instead of using such
text, it will warn and act as if a match was not found (or for test commands,
as if the test failed).
(Contributed by Petr Viktorin in gh-98966@footnote{https://github.com/python/cpython/issues/98966}.)

@node Notable changes in 3 10 12,,Notable security feature in 3 10 8,Qué hay de nuevo en Python 3 10
@anchor{whatsnew/3 10 notable-changes-in-3-10-12}@anchor{958}
@subsection Notable changes in 3.10.12


@menu
* tarfile: tarfile<2>. 

@end menu

@node tarfile<2>,,,Notable changes in 3 10 12
@anchor{whatsnew/3 10 tarfile}@anchor{959}
@subsubsection tarfile



@itemize *

@item 
The extraction methods in @ref{de,,tarfile}, and @ref{516,,shutil.unpack_archive()},
have a new a `filter' argument that allows limiting tar features than may be
surprising or dangerous, such as creating files outside the destination
directory.
See @ref{517,,Extraction filters} for details.
In Python 3.12, use without the `filter' argument will show a
@ref{1da,,DeprecationWarning}.
In Python 3.14, the default will switch to @code{'data'}.
(Contributed by Petr Viktorin in 
@geindex Python Enhancement Proposals; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node Qué hay de nuevo en Python 3 9,Qué hay de nuevo en Python 3 8,Qué hay de nuevo en Python 3 10,Qué hay de nuevo en Python
@anchor{whatsnew/3 9 doc}@anchor{95a}@anchor{whatsnew/3 9 what-s-new-in-python-3-9}@anchor{95b}
@section Qué hay de nuevo en Python 3.9


@*Editor: 
Łukasz Langa


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Your text might get
@c rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes will be too small
@c or esoteric to include.  If such a change is added to the text,
@c it might get removed during final editing.
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

This article explains the new features in Python 3.9, compared to 3.8.
Python 3.9 was released on October 5, 2020.
For full details, see the @ref{13b,,changelog}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 596
PEP 596@footnote{https://peps.python.org/pep-0596/} - Programa de lanzamiento de Python 3.9


@menu
* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<3>. 
* Debe verificar DeprecationWarning en su código:: 
* Nuevas características: Nuevas características<7>. 
* Otros cambios de idioma: Otros cambios de idioma<3>. 
* Nuevos módulos: Nuevos módulos<3>. 
* Módulos mejorados: Módulos mejorados<4>. 
* Optimizaciones: Optimizaciones<4>. 
* Obsoleto: Obsoleto<7>. 
* Remoto: Remoto<3>. 
* Portar a Python 3.9: Portar a Python 3 9. 
* Construir cambios: Construir cambios<3>. 
* Cambios en la API de C: Cambios en la API de C<6>. 
* Cambios notables en Python 3.9.1: Cambios notables en Python 3 9 1. 
* Cambios notables en Python 3.9.2: Cambios notables en Python 3 9 2. 
* Notable changes in Python 3.9.3: Notable changes in Python 3 9 3. 
* Notable changes in Python 3.9.5: Notable changes in Python 3 9 5. 
* Notable security feature in 3.9.14: Notable security feature in 3 9 14. 
* Notable changes in 3.9.17: Notable changes in 3 9 17. 

@end menu

@node Resumen aspectos destacados de la versión<3>,Debe verificar DeprecationWarning en su código,,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 summary-release-highlights}@anchor{95c}
@subsection Resumen: aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.9.
@c Brevity is key.

Nuevas funciones de sintaxis:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}, operadores unión agregados a @code{dict};

@item 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}, genéricos de sugerencia de tipo en colecciones estándar;

@item 
@geindex Python Enhancement Proposals; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}, restricciones gramaticales relajadas para los decoradores.
@end itemize

Nuevas funciones integradas:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/}, métodos de cadena para eliminar prefijos y sufijos.
@end itemize

Nuevas funciones en la biblioteca estándar:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}, función flexible y anotaciones variables;

@item 
Se agregó @ref{524,,os.pidfd_open()} que permite la gestión de procesos sin razas ni señales.
@end itemize

Mejoras en el intérprete:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}, acceso rápido al estado del módulo desde métodos de tipos de extensión C;

@item 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}, CPython ahora usa un nuevo analizador basado en PEG;

@item 
varias incorporaciones de Python (rango, tupla, conjunto, conjunto frozenset, lista, dict) ahora se aceleran usando 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall;

@item 
la recolección de basura no bloquea los objetos resucitados;

@item 
a number of Python modules (@code{_abc}, @code{audioop}, @code{_bz2},
@code{_codecs}, @code{_contextvars}, @code{_crypt}, @code{_functools},
@code{_json}, @code{_locale}, @ref{8e,,math}, @ref{9f,,operator}, @ref{bc,,resource},
@ref{ee,,time}, @code{_weakref}) now use multiphase initialization as defined
by PEP 489;

@item 
a number of standard library modules (@code{audioop}, @ref{9,,ast}, @ref{66,,grp},
@code{_hashlib}, @ref{b2,,pwd}, @code{_posixsubprocess}, @ref{b8,,random},
@ref{c1,,select}, @ref{d5,,struct}, @ref{e1,,termios}, @ref{132,,zlib}) are now using
the stable ABI defined by PEP 384.
@end itemize

Nuevos módulos de biblioteca:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}, la base de datos de zona horaria de IANA ahora está presente en la biblioteca estándar en el módulo @ref{133,,zoneinfo};

@item 
ahora se proporciona una implementación de una especie de gráfico topológico en el nuevo módulo @ref{65,,graphlib}.
@end itemize

Cambios en el proceso de lanzamiento:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/}, CPython adopta un ciclo de lanzamiento anual.
@end itemize

@node Debe verificar DeprecationWarning en su código,Nuevas características<7>,Resumen aspectos destacados de la versión<3>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 you-should-check-for-deprecationwarning-in-your-code}@anchor{95d}
@subsection Debe verificar DeprecationWarning en su código


Cuando todavía se admitía Python 2.7, se conservaba una gran cantidad de funciones en Python 3 por compatibilidad con versiones anteriores de Python 2.7. Con el fin de la compatibilidad con Python 2, estas capas de compatibilidad con versiones anteriores se eliminaron o se eliminarán pronto. La mayoría de ellos emitió una advertencia @ref{1da,,DeprecationWarning} durante varios años. Por ejemplo, usar @code{collections.Mapping} en lugar de @code{collections.abc.Mapping} emite un @ref{1da,,DeprecationWarning} desde Python 3.3, lanzado en 2012.

Pruebe su aplicación con la opción de línea de comandos @ref{95e,,-W} @code{default} para ver @ref{1da,,DeprecationWarning} y @ref{95f,,PendingDeprecationWarning}, o incluso con @ref{95e,,-W} @code{error} para tratarlos como errores. @ref{960,,Warnings Filter} se puede utilizar para ignorar las advertencias del código de terceros.

Python 3.9 es la última versión que proporciona esas capas de compatibilidad con versiones anteriores de Python 2, para dar más tiempo a los mantenedores de proyectos de Python para organizar la eliminación del soporte de Python 2 y agregar soporte para Python 3.9.

Los alias de @ref{90f,,Abstract Base Classes} en el módulo @ref{1e,,collections}, como el alias de @code{collections.Mapping} de @ref{961,,collections.abc.Mapping}, se mantienen para una última versión por compatibilidad con versiones anteriores. Se eliminarán de Python 3.10.

De manera más general, intente ejecutar sus pruebas en el @ref{356,,Python Development Mode}, lo que ayuda a preparar su código para que sea compatible con la próxima versión de Python.

Nota: también se eliminaron varias obsoletas en esta versión de Python. Consulte la sección @ref{962,,Remoto}.

@node Nuevas características<7>,Otros cambios de idioma<3>,Debe verificar DeprecationWarning en su código,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 new-features}@anchor{963}
@subsection Nuevas características


@menu
* Operadores de combinación y actualización de diccionarios:: 
* Nuevos métodos de cadena para eliminar prefijos y sufijos:: 
* Tipos genéricos de sugerencia en colecciones estándar:: 
* Nuevo analizador:: 

@end menu

@node Operadores de combinación y actualización de diccionarios,Nuevos métodos de cadena para eliminar prefijos y sufijos,,Nuevas características<7>
@anchor{whatsnew/3 9 dictionary-merge-update-operators}@anchor{964}
@subsubsection Operadores de combinación y actualización de diccionarios


Los operadores de fusión (@code{|}) y actualización (@code{|=}) se han agregado a la clase @ref{190,,dict} incorporada. Estos complementan los métodos @code{dict.update} y @code{@{**d1, **d2@}} existentes para fusionar diccionarios.

Ejemplo:

@example
>>> x = @{"key1": "value1 from x", "key2": "value2 from x"@}
>>> y = @{"key2": "value2 from y", "key3": "value3 from y"@}
>>> x | y
@{'key1': 'value1 from x', 'key2': 'value2 from y', 'key3': 'value3 from y'@}
>>> y | x
@{'key2': 'value2 from x', 'key3': 'value3 from y', 'key1': 'value1 from x'@}
@end example

Consulte 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} para obtener una descripción completa. (Contribuido por Brandt Bucher en bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}.)

@node Nuevos métodos de cadena para eliminar prefijos y sufijos,Tipos genéricos de sugerencia en colecciones estándar,Operadores de combinación y actualización de diccionarios,Nuevas características<7>
@anchor{whatsnew/3 9 new-string-methods-to-remove-prefixes-and-suffixes}@anchor{965}
@subsubsection Nuevos métodos de cadena para eliminar prefijos y sufijos


Se han agregado @ref{966,,str.removeprefix(prefix)} y @ref{967,,str.removesuffix(suffix)} para eliminar fácilmente un prefijo o sufijo innecesario de una cadena. También se han agregado los métodos correspondientes @code{bytes}, @code{bytearray} y @code{collections.UserString}. Consulte 
@geindex Python Enhancement Proposals; PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/} para obtener una descripción completa. (Contribuido por Dennis Sweeney en bpo-39939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39939}.)

@node Tipos genéricos de sugerencia en colecciones estándar,Nuevo analizador,Nuevos métodos de cadena para eliminar prefijos y sufijos,Nuevas características<7>
@anchor{whatsnew/3 9 type-hinting-generics-in-standard-collections}@anchor{968}
@subsubsection Tipos genéricos de sugerencia en colecciones estándar


En las anotaciones de tipo, ahora puede usar tipos de colección integrados como @code{list} y @code{dict} como tipos genéricos en lugar de importar los tipos en mayúsculas correspondientes (por ejemplo, @code{List} o @code{Dict}) desde @code{typing}. Algunos otros tipos de la biblioteca estándar ahora también son genéricos, por ejemplo, @code{queue.Queue}.

Ejemplo:

@example
def greet_all(names: list[str]) -> None:
    for name in names:
        print("Hello", name)
@end example

Consulte 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} para obtener más detalles. (Contribuido por Guido van Rossum, Ethan Smith y Batuhan Taşkaya en bpo-39481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39481}.)

@node Nuevo analizador,,Tipos genéricos de sugerencia en colecciones estándar,Nuevas características<7>
@anchor{whatsnew/3 9 new-parser}@anchor{969}
@subsubsection Nuevo analizador


Python 3.9 usa un nuevo analizador, basado en PEG@footnote{https://en.wikipedia.org/wiki/Parsing_expression_grammar} en lugar de LL(1)@footnote{https://en.wikipedia.org/wiki/LL_parser}. El rendimiento del analizador nuevo es aproximadamente comparable al del analizador anterior, pero el formalismo PEG es más flexible que LL (1) cuando se trata de diseñar nuevas funciones de lenguaje. Comenzaremos a usar esta flexibilidad en Python 3.10 y versiones posteriores.

El módulo @ref{9,,ast} usa el nuevo analizador y produce el mismo AST que el analizador anterior.

In Python 3.10, the old parser will be deleted and so will all
functionality that depends on it (primarily the @code{parser} module,
which has long been deprecated).  In Python 3.9 `only', you can switch
back to the LL(1) parser using a command line switch (@code{-X
oldparser}) or an environment variable (@code{PYTHONOLDPARSER=1}).

Consulte 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} para obtener más detalles. (Contribuido por Guido van Rossum, Pablo Galindo y Lysandros Nikolaou en bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}.)

@node Otros cambios de idioma<3>,Nuevos módulos<3>,Nuevas características<7>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 other-language-changes}@anchor{96a}
@subsection Otros cambios de idioma



@itemize *

@item 
@ref{96b,,__import__()} ahora lanza @ref{4d7,,ImportError} en lugar de @ref{360,,ValueError}, que solía ocurrir cuando una importación relativa pasaba de su paquete de nivel superior. (Contribuido por Ngalim Siregar en bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}.)

@item 
Python ahora obtiene la ruta absoluta del nombre de archivo del script especificado en la línea de comando (por ejemplo: @code{python3 script.py}): el módulo @code{__file__} attribute of the @ref{1,,__main__} se convirtió en una ruta absoluta, en lugar de una ruta relativa. Estas rutas ahora siguen siendo válidas después de que las tramas del módulo @ref{6ae,,os.chdir()}. Como efecto alterno, la traza también muestra la ruta absoluta para los marcos del módulo @ref{1,,__main__} en este caso. (Contribuido por Victor Stinner en bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}.)

@item 
En @ref{356,,Python Development Mode} y en @ref{357,,debug build}, los argumentos de `encoding' and `errors' ahora se comprueban para las operaciones de codificación y decodificación de cadenas. Ejemplos: @ref{1be,,open()}, @ref{96c,,str.encode()} y @ref{96d,,bytes.decode()}.

De forma predeterminada, para un mejor rendimiento, el argumento `errors' argument is only checked at the first encoding/decoding error and the `encoding' a veces se ignora para cadenas vacías. (Contribuido por Victor Stinner en bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}.)

@item 
@code{"".replace("", s, n)} ahora devuelve @code{s} en lugar de una cadena vacía para todos los @code{n} distintos de cero. Ahora es compatible con @code{"".replace("", s)}. Hay cambios similares para los objetos @ref{325,,bytes} y @ref{5e0,,bytearray}. (Contribuido por Serhiy Storchaka en bpo-28029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28029}.)

@item 
Cualquier expresión válida ahora se puede utilizar como @ref{7cd,,decorator}. Anteriormente, la gramática era mucho más restrictiva. Consulte 
@geindex Python Enhancement Proposals; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para obtener más detalles. (Contribuido por Brandt Bucher en bpo-39702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39702}.)

@item 
Ayuda mejorada para el módulo @ref{104,,typing}. Las cadenas de documentos ahora se muestran para todas las formas especiales y alias genéricos especiales (como @code{Union} y @code{List}). El uso de @ref{96e,,help()} con un alias genérico como @code{List[int]} mostrará la ayuda para el tipo concreto correspondiente (@code{list} en este caso). (Contribuido por Serhiy Storchaka en bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}.)

@item 
La ejecución en paralelo de @ref{96f,,aclose()} / @ref{970,,asend()} / @ref{59e,,athrow()} ahora está prohibida, y @code{ag_running} ahora refleja el estado de ejecución real del generador asíncrono. (Contribuido por Yury Selivanov en bpo-30773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30773}.)

@item 
Los errores inesperados al llamar al método @code{__iter__} ya no están enmascarados por @code{TypeError} en el operador @ref{1ed,,in} y funciones @ref{971,,contains()}, @ref{972,,indexOf()} y @ref{973,,countOf()} del módulo @ref{9f,,operator}. (Contribuido por Serhiy Storchaka en bpo-40824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40824}.)

@item 
Las expresiones lambda sin paréntesis ya no pueden ser la parte de expresión en una cláusula @code{if} en comprensiones y expresiones generadoras. Consulte bpo-41848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41848} y bpo-43755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43755} para obtener más detalles.
@end itemize

@node Nuevos módulos<3>,Módulos mejorados<4>,Otros cambios de idioma<3>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 new-modules}@anchor{974}
@subsection Nuevos módulos


@menu
* zoneinfo:: 
* Graphlib:: 

@end menu

@node zoneinfo,Graphlib,,Nuevos módulos<3>
@anchor{whatsnew/3 9 zoneinfo}@anchor{975}
@subsubsection zoneinfo


El módulo @ref{133,,zoneinfo} brinda soporte para la base de datos de zona horaria de IANA a la biblioteca estándar. Agrega @ref{976,,zoneinfo.ZoneInfo}, una implementación de @ref{67f,,datetime.tzinfo} concreta respaldada por los datos de la zona horaria del sistema.

Ejemplo:

@example
>>> from zoneinfo import ZoneInfo
>>> from datetime import datetime, timedelta

>>> # Daylight saving time
>>> dt = datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-10-31 12:00:00-07:00
>>> dt.tzname()
'PDT'

>>> # Standard time
>>> dt += timedelta(days=7)
>>> print(dt)
2020-11-07 12:00:00-08:00
>>> print(dt.tzname())
PST
@end example

As a fall-back source of data for platforms that don’t ship the IANA database,
the tzdata@footnote{https://pypi.org/project/tzdata/} module was released as a first-party package – distributed via
PyPI and maintained by the CPython core team.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 615

@item PEP 615@footnote{https://peps.python.org/pep-0615/}: compatibilidad con la base de datos de zona horaria de IANA en la biblioteca estándar

PEP escrito e implementado por Paul Ganssle
@end table


@node Graphlib,,zoneinfo,Nuevos módulos<3>
@anchor{whatsnew/3 9 graphlib}@anchor{977}
@subsubsection Graphlib


Se agregó un nuevo módulo, @ref{65,,graphlib}, que contiene la clase @ref{978,,graphlib.TopologicalSorter} para ofrecer funcionalidad para realizar la clasificación topológica de gráficos. (Contribuido por Pablo Galindo, Tim Peters y Larry Hastings en bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}.)

@node Módulos mejorados<4>,Optimizaciones<4>,Nuevos módulos<3>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 improved-modules}@anchor{979}
@subsection Módulos mejorados


@menu
* ast: ast<4>. 
* asyncio: asyncio<5>. 
* compilar todo:: 
* Futuros concurrentes:: 
* maldiciones: maldiciones<2>. 
* fecha y hora: fecha y hora<2>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* GC: GC<2>. 
* hashlib: hashlib<4>. 
* http: http<2>. 
* IDLE e idlelib: IDLE e idlelib<2>. 
* imaplib:: 
* importlib: importlib<4>. 
* inspeccionar: inspeccionar<3>. 
* dirección IP:: 
* Matemáticas: Matemáticas<2>. 
* multiprocesamiento:: 
* nntplib:: 
* os: os<5>. 
* Pathlib: Pathlib<2>. 
* pdb: pdb<3>. 
* poplib:: 
* pprint: pprint<2>. 
* Pydoc:: 
* aleatorio:: 
* señal:: 
* smtplib:: 
* enchufe: enchufe<3>. 
* tiempo: tiempo<2>. 
* sys: sys<5>. 
* tracemalloc:: 
* mecanografía: mecanografía<3>. 
* unicodedata: unicodedata<5>. 
* venv: venv<3>. 
* xml: xml<3>. 

@end menu

@node ast<4>,asyncio<5>,,Módulos mejorados<4>
@anchor{whatsnew/3 9 ast}@anchor{97a}
@subsubsection ast


Se agregó la opción `indent' a @ref{97b,,dump()} que le permite producir una salida con sangría de varias líneas. (Contribuido por Serhiy Storchaka en bpo-37995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37995}.)

Se agregó @ref{97c,,ast.unparse()} como una función en el módulo @ref{9,,ast} que se puede usar para descomprimir un objeto @ref{30d,,ast.AST} y producir una cadena con código que produciría un objeto @ref{30d,,ast.AST} equivalente cuando se analiza. (Contribuido por Pablo Galindo y Batuhan Taskaya en bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870}.)

Se agregaron cadenas de documentación a los nodos AST que contienen la firma ASDL utilizada para construir ese nodo. (Contribuido por Batuhan Taskaya en bpo-39638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39638}.)

@node asyncio<5>,compilar todo,ast<4>,Módulos mejorados<4>
@anchor{whatsnew/3 9 asyncio}@anchor{97d}
@subsubsection asyncio


Debido a importantes problemas de seguridad, el parámetro `reuse_address' de @ref{7cf,,asyncio.loop.create_datagram_endpoint()} ya no es compatible. Esto se debe al comportamiento de la opción de socket @code{SO_REUSEADDR} en UDP. Para obtener más detalles, consulte la documentación de @code{loop.create_datagram_endpoint()}. (Contribuido por Kyle Stanley, Antoine Pitrou y Yury Selivanov en bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

Se agregó un nuevo @ref{53a,,coroutine} @ref{97e,,shutdown_default_executor()} que programa un apagado para el ejecutor predeterminado que espera en el @ref{7dd,,ThreadPoolExecutor} para finalizar el cierre. Además, @ref{525,,asyncio.run()} se ha actualizado para utilizar el nuevo @ref{53a,,coroutine}. (Contribuido por Kyle Stanley en bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}.)

Added @code{asyncio.PidfdChildWatcher}, a Linux-specific child watcher
implementation that polls process file descriptors. (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692})

Se agregó un nuevo @ref{53a,,coroutine} @ref{97f,,asyncio.to_thread()}. Se utiliza principalmente para ejecutar funciones vinculadas a IO en un hilo separado para evitar bloquear el bucle de eventos, y esencialmente funciona como una versión de alto nivel de @ref{980,,run_in_executor()} que puede tomar directamente argumentos de palabras clave. (Contribuido por Kyle Stanley y Yury Selivanov en bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309}.)

Al cancelar la tarea debido a un tiempo de espera, @ref{6a0,,asyncio.wait_for()} ahora esperará hasta que se complete la cancelación también en el caso de que `timeout' sea <= 0, como ocurre con los tiempos de espera positivos. (Contribuido por Elvis Pranskevichus en bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}.)

@ref{b,,asyncio} now raises @ref{228,,TypeError} when calling incompatible
methods with an @ref{981,,ssl.SSLSocket} socket.
(Contributed by Ido Michael in bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404}.)

@node compilar todo,Futuros concurrentes,asyncio<5>,Módulos mejorados<4>
@anchor{whatsnew/3 9 compileall}@anchor{982}
@subsubsection compilar todo


Se agregó una nueva posibilidad de usar enlaces duros para archivos @code{.pyc} duplicados: parámetro `hardlink_dupes' y opción de línea de comando –hardlink-dupes. (Contribuido por Lumír “Frenzy” Balhar en bpo-40495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40495}.)

Se agregaron nuevas opciones para la manipulación de rutas en los archivos @code{.pyc} resultantes: parámetros `stripdir', `prependdir', `limit_sl_dest' y opciones de línea de comando -s, -p, -e. Se agregó la posibilidad de especificar la opción para un nivel de optimización varias veces. (Contribuido por Lumír “Frenzy” Balhar en bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112}.)

@node Futuros concurrentes,maldiciones<2>,compilar todo,Módulos mejorados<4>
@anchor{whatsnew/3 9 concurrent-futures}@anchor{983}
@subsubsection Futuros concurrentes


Se agregó un nuevo parámetro `cancel_futures' a @ref{984,,concurrent.futures.Executor.shutdown()} que cancela todos los futuros pendientes que no han comenzado a ejecutarse, en lugar de esperar a que se completen antes de apagar el ejecutor. (Contribuido por Kyle Stanley en bpo-39349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39349}.)

Se eliminaron los subprocesos del demonio de @ref{7dd,,ThreadPoolExecutor} y @ref{163,,ProcessPoolExecutor}. Esto mejora la compatibilidad con los subinterpretadores y la previsibilidad en sus procesos de cierre. (Contribuido por Kyle Stanley en bpo-39812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39812}.)

Los trabajadores en @ref{163,,ProcessPoolExecutor} ahora se generan a pedido, solo cuando no hay trabajadores inactivos disponibles para reutilizar. Esto optimiza la sobrecarga de inicio y reduce la cantidad de tiempo de CPU perdido para los trabajadores inactivos. (Contribuido por Kyle Stanley en bpo-39207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39207}.)

@node maldiciones<2>,fecha y hora<2>,Futuros concurrentes,Módulos mejorados<4>
@anchor{whatsnew/3 9 curses}@anchor{985}
@subsubsection maldiciones


Se agregaron funciones @ref{986,,curses.get_escdelay()}, @ref{987,,curses.set_escdelay()}, @ref{988,,curses.get_tabsize()} y @ref{989,,curses.set_tabsize()}. (Contribuido por Anthony Sottile en bpo-38312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38312}.)

@node fecha y hora<2>,distutils<3>,maldiciones<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 datetime}@anchor{98a}
@subsubsection fecha y hora


The @ref{98b,,isocalendar()} of @ref{330,,datetime.date}
and @ref{98c,,isocalendar()} of @ref{32f,,datetime.datetime}
methods now returns a @ref{32d,,namedtuple()} instead of a @ref{464,,tuple}.
(Contributed by Donghee Na in bpo-24416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24416}.)

@node distutils<3>,fcntl<2>,fecha y hora<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 distutils}@anchor{98d}
@subsubsection distutils


El comando: command: @cite{upload} ahora crea resúmenes de hash SHA2-256 y Blake2b-256. Omite MD5 en plataformas que bloquean el resumen de MD5. (Contribuido por Christian Heimes en bpo-40698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40698}.)

@node fcntl<2>,ftplib<2>,distutils<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 fcntl}@anchor{98e}
@subsubsection fcntl


Added constants @code{F_OFD_GETLK}, @code{F_OFD_SETLK}
and @code{F_OFD_SETLKW}.
(Contributed by Donghee Na in bpo-38602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38602}.)

@node ftplib<2>,GC<2>,fcntl<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 ftplib}@anchor{98f}
@subsubsection ftplib


@ref{990,,FTP} and @ref{991,,FTP_TLS} now raise a @ref{360,,ValueError}
if the given timeout for their constructor is zero to prevent the creation of
a non-blocking socket. (Contributed by Donghee Na in bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node GC<2>,hashlib<4>,ftplib<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 gc}@anchor{992}
@subsubsection GC


Cuando el recolector de basura realiza una recolección en la que resucitan algunos objetos (se puede acceder a ellos desde fuera de los ciclos aislados después de que se hayan ejecutado los finalizadores), no bloquee la recolección de todos los objetos que aún no se pueden alcanzar. (Contribuido por Pablo Galindo y Tim Peters en bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}.)

Se agregó una nueva función @ref{993,,gc.is_finalized()} para verificar si el recolector de basura ha finalizado un objeto. (Contribuido por Pablo Galindo en bpo-39322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39322}.)

@node hashlib<4>,http<2>,GC<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 hashlib}@anchor{994}
@subsubsection hashlib


El módulo @ref{68,,hashlib} ahora puede usar hashes SHA3 y SHAKE XOF de OpenSSL cuando esté disponible. (Contribuido por Christian Heimes en bpo-37630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37630}.)

Los módulos hash incorporados ahora pueden desactivarse con @code{./configure --without-builtin-hashlib-hashes} o activarse selectivamente con p. Ej. @code{./configure --with-builtin-hashlib-hashes=sha3,blake2} para forzar el uso de la implementación basada en OpenSSL. (Contribuido por Christian Heimes en bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479})

@node http<2>,IDLE e idlelib<2>,hashlib<4>,Módulos mejorados<4>
@anchor{whatsnew/3 9 http}@anchor{995}
@subsubsection http


HTTP status codes @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} and @code{425 TOO_EARLY} are added to
@ref{996,,http.HTTPStatus}. (Contributed by Donghee Na in bpo-39509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39509} and Ross Rhodes in bpo-39507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39507}.)

@node IDLE e idlelib<2>,imaplib,http<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 idle-and-idlelib}@anchor{997}
@subsubsection IDLE e idlelib


Opción agregada para apagar el cursor parpadeando. (Contribuido por Zackery Spytz en bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603}.)

La tecla Escape ahora cierra las ventanas de finalización IDLE. (Contribuido por Johnny Najera en bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}.)

Se agregaron palabras clave a la lista de finalización del nombre del módulo. (Contribuido por Terry J. Reedy en bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}.)

Novedades de la versión de mantenimiento 3.9

Hacer que IDLE invoque @ref{8a2,,sys.excepthook()} (cuando se inicia sin “-n”). Anteriormente se ignoraban los hooks de usuario.  (Contribuido por Ken Hilton en bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}.)

Los cambios anteriores se han actualizado a las versiones de mantenimiento 3.8.

Reorganizar el diálogo de configuración. Dividir la pestaña General en Windows y Shell/Ed. Mover las fuentes de ayuda, que amplían el menú Ayuda, a la pestaña Extensiones. Hacer espacio para nuevas opciones y acortar el diálogo. Esto último hace que el diálogo se adapte mejor a las pantallas pequeñas. (Contribuido por Terry Jan Reedy en bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}.) Mover la configuración del espacio de sangría de la pestaña Fuente a la nueva pestaña Windows. (Contribuido por Mark Roseman y Terry Jan Reedy en bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}.)

Aplicar el resaltado de sintaxis a los archivos @code{.pyi}. (Contribución de Alex Waygood y Terry Jan Reedy en bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447})

@node imaplib,importlib<4>,IDLE e idlelib<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 imaplib}@anchor{998}
@subsubsection imaplib


@ref{999,,IMAP4} and @ref{99a,,IMAP4_SSL} now have
an optional `timeout' parameter for their constructors.
Also, the @ref{99b,,open()} method now has an optional `timeout' parameter
with this change. The overridden methods of @ref{99a,,IMAP4_SSL} and
@ref{99c,,IMAP4_stream} were applied to this change.
(Contributed by Donghee Na in bpo-38615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38615}.)

@ref{99d,,imaplib.IMAP4.unselect()} is added.
@ref{99d,,imaplib.IMAP4.unselect()} frees server’s resources associated with the
selected mailbox and returns the server to the authenticated
state. This command performs the same actions as @ref{99e,,imaplib.IMAP4.close()}, except
that no messages are permanently removed from the currently
selected mailbox. (Contributed by Donghee Na in bpo-40375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40375}.)

@node importlib<4>,inspeccionar<3>,imaplib,Módulos mejorados<4>
@anchor{whatsnew/3 9 importlib}@anchor{99f}
@subsubsection importlib


Para mejorar la coherencia con las declaraciones de importación, @ref{9a0,,importlib.util.resolve_name()} ahora lanza @ref{4d7,,ImportError} en lugar de @ref{360,,ValueError} para intentos de importación relativa no válidos. (Contribuido por Ngalim Siregar en bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}.)

Los cargadores de importación que publican objetos de módulo inmutables ahora pueden publicar paquetes inmutables además de módulos individuales. (Contribuido por Dino Viehland en bpo-39336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39336}.)

Se agregó la función @ref{537,,importlib.resources.files()} con soporte para subdirectorios en los datos del paquete, compatible con el backport en @code{importlib_resources} versión 1.5. (Contribuido por Jason R. Coombs en bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}.)

@code{importlib.metadata} actualizado de @code{importlib_metadata} versión 1.6.1.

@node inspeccionar<3>,dirección IP,importlib<4>,Módulos mejorados<4>
@anchor{whatsnew/3 9 inspect}@anchor{9a1}
@subsubsection inspeccionar


@ref{9a2,,inspect.BoundArguments.arguments} se cambia de @code{OrderedDict} a dictado regular. (Contribuido por Inada Naoki en bpo-36350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36350} y bpo-39775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39775}.)

@node dirección IP,Matemáticas<2>,inspeccionar<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 ipaddress}@anchor{9a3}
@subsubsection dirección IP


@ref{80,,ipaddress} ahora admite direcciones de ámbito IPv6 (dirección IPv6 con sufijo @code{%<scope_id>}).

Las direcciones IPv6 con alcance se pueden analizar mediante @ref{35b,,ipaddress.IPv6Address}. Si está presente, la identificación de la zona del alcance está disponible a través del atributo @ref{9a4,,scope_id}. (Contribuido por Oleksandr Pavliuk en bpo-34788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34788}.)

A partir de Python 3.9.5, el módulo @ref{80,,ipaddress} ya no acepta ceros a la izquierda en cadenas de direcciones IPv4. (Contribuido por Christian Heimes en bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}).

@node Matemáticas<2>,multiprocesamiento,dirección IP,Módulos mejorados<4>
@anchor{whatsnew/3 9 math}@anchor{9a5}
@subsubsection Matemáticas


Se amplió la función @ref{9a6,,math.gcd()} para manejar múltiples argumentos. Anteriormente, solo respaldaba dos argumentos. (Contribuido por Serhiy Storchaka en bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648}.)

@ref{9a7,,math.lcm()} agregado: devuelve el mínimo común múltiplo de argumentos especificados. (Contribuido por Mark Dickinson, Ananthakrishnan y Serhiy Storchaka en bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479} y bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648}.)

@ref{541,,math.nextafter()} agregado: devuelve el siguiente valor de punto flotante después de `x' towards `y'. (Contribuido por Victor Stinner en bpo-39288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39288}.)

@ref{9a8,,math.ulp()} agregado: devuelve el valor del bit menos significativo de un flotador. (Contribuido por Victor Stinner en bpo-39310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39310}.)

@node multiprocesamiento,nntplib,Matemáticas<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 multiprocessing}@anchor{9a9}
@subsubsection multiprocesamiento


La clase @ref{9aa,,multiprocessing.SimpleQueue} tiene un nuevo método @ref{9ab,,close()} para cerrar explícitamente la cola. (Contribuido por Victor Stinner en bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}.)

@node nntplib,os<5>,multiprocesamiento,Módulos mejorados<4>
@anchor{whatsnew/3 9 nntplib}@anchor{9ac}
@subsubsection nntplib


@code{NNTP} and @code{NNTP_SSL} now raise a @ref{360,,ValueError}
if the given timeout for their constructor is zero to prevent the creation of
a non-blocking socket. (Contributed by Donghee Na in bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node os<5>,Pathlib<2>,nntplib,Módulos mejorados<4>
@anchor{whatsnew/3 9 os}@anchor{9ad}
@subsubsection os


Added @ref{9ae,,CLD_KILLED} and @ref{9af,,CLD_STOPPED} for @code{si_code}.
(Contributed by Donghee Na in bpo-38493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38493}.)

Exposed the Linux-specific @ref{524,,os.pidfd_open()} (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}) and
@ref{9b0,,os.P_PIDFD} (bpo-38713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38713}) for process management with file
descriptors.

La función @ref{199,,os.unsetenv()} ahora también está disponible en Windows. (Contribuido por Victor Stinner en bpo-39413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39413}.)

Las funciones @ref{198,,os.putenv()} y @ref{199,,os.unsetenv()} ahora están siempre disponibles. (Contribuido por Victor Stinner en bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}.)

Función @ref{9b1,,os.waitstatus_to_exitcode()} agregada: convierte un estado de espera en un código de salida. (Contribuido por Victor Stinner en bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}.)

@node Pathlib<2>,pdb<3>,os<5>,Módulos mejorados<4>
@anchor{whatsnew/3 9 pathlib}@anchor{9b2}
@subsubsection Pathlib


Added @ref{9b3,,pathlib.Path.readlink()} which acts similarly to
@ref{9b4,,os.readlink()}.
(Contributed by Girts Folkmanis in bpo-30618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30618})

@node pdb<3>,poplib,Pathlib<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 pdb}@anchor{9b5}
@subsubsection pdb


En Windows, ahora @ref{1a8,,Pdb} es compatible con @code{~/.pdbrc}. (Contribuido por Tim Hopper y Dan Lidral-Porter en bpo-20523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20523}.)

@node poplib,pprint<2>,pdb<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 poplib}@anchor{9b6}
@subsubsection poplib


@ref{9b7,,POP3} and @ref{9b8,,POP3_SSL} now raise a @ref{360,,ValueError}
if the given timeout for their constructor is zero to prevent the creation of
a non-blocking socket. (Contributed by Donghee Na in bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node pprint<2>,Pydoc,poplib,Módulos mejorados<4>
@anchor{whatsnew/3 9 pprint}@anchor{9b9}
@subsubsection pprint


@ref{ae,,pprint} ahora puede imprimir @ref{334,,types.SimpleNamespace} de forma bonita. (Contribuido por Carl Bordum Hansen en bpo-37376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37376}.)

@node Pydoc,aleatorio,pprint<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 pydoc}@anchor{9ba}
@subsubsection Pydoc


The documentation string is now shown not only for class, function,
method etc, but for any object that has its own @ref{9bb,,__doc__}
attribute.
(Contributed by Serhiy Storchaka in bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}.)

@node aleatorio,señal,Pydoc,Módulos mejorados<4>
@anchor{whatsnew/3 9 random}@anchor{9bc}
@subsubsection aleatorio


Se agregó un nuevo método @code{random.Random.randbytes}: generar bytes aleatorios. (Contribuido por Victor Stinner en bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}.)

@node señal,smtplib,aleatorio,Módulos mejorados<4>
@anchor{whatsnew/3 9 signal}@anchor{9bd}
@subsubsection señal


Expuso el @ref{9be,,signal.pidfd_send_signal()} específico de Linux para enviar señales a un proceso utilizando un descriptor de archivo en lugar de un pid. (bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712})

@node smtplib,enchufe<3>,señal,Módulos mejorados<4>
@anchor{whatsnew/3 9 smtplib}@anchor{9bf}
@subsubsection smtplib


@ref{9c0,,SMTP} and @ref{9c1,,SMTP_SSL} now raise a @ref{360,,ValueError}
if the given timeout for their constructor is zero to prevent the creation of
a non-blocking socket. (Contributed by Donghee Na in bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@ref{9c2,,LMTP} constructor  now has an optional `timeout' parameter.
(Contributed by Donghee Na in bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329}.)

@node enchufe<3>,tiempo<2>,smtplib,Módulos mejorados<4>
@anchor{whatsnew/3 9 socket}@anchor{9c3}
@subsubsection enchufe


The @ref{cc,,socket} module now exports the @ref{9c4,,CAN_RAW_JOIN_FILTERS}
constant on Linux 4.1 and greater.
(Contributed by Stefan Tatschner and Zackery Spytz in bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780}.)

The socket module now supports the @ref{9c5,,CAN_J1939} protocol on
platforms that support it.  (Contributed by Karl Ding in bpo-40291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40291}.)

El módulo de enchufe ahora tiene las funciones @ref{9c6,,socket.send_fds()} y @ref{9c7,,socket.recv_fds()}. (Contribuido por Joannah Nanjekye, Shinya Okano y Victor Stinner en bpo-28724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28724}.)

@node tiempo<2>,sys<5>,enchufe<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 time}@anchor{9c8}
@subsubsection tiempo


En AIX, @ref{9c9,,thread_time()} ahora se implementa con @code{thread_cputime()} que tiene una resolución de nanosegundos, en lugar de @code{clock_gettime(CLOCK_THREAD_CPUTIME_ID)} que tiene una resolución de 10 ms. (Contribuido por Batuhan Taskaya en bpo-40192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40192})

@node sys<5>,tracemalloc,tiempo<2>,Módulos mejorados<4>
@anchor{whatsnew/3 9 sys}@anchor{9ca}
@subsubsection sys


Added a new @ref{9cb,,sys.platlibdir} attribute: name of the platform-specific
library directory. It is used to build the path of standard library and the
paths of installed extension modules. It is equal to @code{"lib"} on most
platforms.  On Fedora and SuSE, it is equal to @code{"lib64"} on 64-bit platforms.
(Contributed by Jan Matějek, Matěj Cepl, Charalampos Stratakis and Victor Stinner in bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}.)

Previously, @ref{9cc,,sys.stderr} was block-buffered when non-interactive. Now
@code{stderr} defaults to always being line-buffered.
(Contributed by Jendrik Seipp in bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601}.)

@node tracemalloc,mecanografía<3>,sys<5>,Módulos mejorados<4>
@anchor{whatsnew/3 9 tracemalloc}@anchor{9cd}
@subsubsection tracemalloc


Se agregó @ref{9ce,,tracemalloc.reset_peak()} para establecer el tamaño máximo de los bloques de memoria rastreados al tamaño actual, para medir el pico de piezas de código específicas. (Contribuido por Huon Wilson en bpo-40630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40630}.)

@node mecanografía<3>,unicodedata<5>,tracemalloc,Módulos mejorados<4>
@anchor{whatsnew/3 9 typing}@anchor{9cf}
@subsubsection mecanografía


@geindex Python Enhancement Proposals; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/} introdujo un tipo @ref{9d0,,typing.Annotated} para decorar tipos existentes con metadatos específicos del contexto y el nuevo parámetro @code{include_extras} en @ref{752,,typing.get_type_hints()} para acceder a los metadatos en tiempo de ejecución. (Contribuido por Till Varoquaux y Konstantin Kashin.)

@node unicodedata<5>,venv<3>,mecanografía<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 unicodedata}@anchor{9d1}
@subsubsection unicodedata


La base de datos Unicode se ha actualizado a la versión 13.0.0. (bpo-39926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39926}).

@node venv<3>,xml<3>,unicodedata<5>,Módulos mejorados<4>
@anchor{whatsnew/3 9 venv}@anchor{9d2}
@subsubsection venv


Los scripts de activación proporcionados por @ref{111,,venv} ahora especifican su personalización de solicitud de manera consistente utilizando siempre el valor especificado por @code{__VENV_PROMPT__}. Anteriormente, algunos scripts usaban @code{__VENV_PROMPT__} incondicionalmente, otros solo si estaba configurado (que era el caso predeterminado) y uno usaba @code{__VENV_NAME__} en su lugar. (Contribuido por Brett Cannon en bpo-37663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37663}.)

@node xml<3>,,venv<3>,Módulos mejorados<4>
@anchor{whatsnew/3 9 xml}@anchor{9d3}
@subsubsection xml


Los caracteres de espacio en blanco dentro de los atributos ahora se conservan al serializar @ref{125,,xml.etree.ElementTree} en un archivo XML. Los EOLN ya no se normalizan a «n». Este es el resultado de la discusión sobre cómo interpretar la sección 2.11 de la especificación XML. (Contribuido por Mefistotelis en bpo-39011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39011}.)

@node Optimizaciones<4>,Obsoleto<7>,Módulos mejorados<4>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 optimizations}@anchor{9d4}
@subsection Optimizaciones



@itemize *

@item 
Optimización del idioma para la asignación de una variable temporal en las comprensiones. Ahora @code{for y in [expr]} en comprensiones es tan rápido como una simple asignación @code{y = expr}. Por ejemplo:

@quotation

sumas = [s para s en [0] para x en datos para s en [s + x]]
@end quotation

A diferencia del operador @code{:=}, este idioma no filtra una variable al alcance externo.

(Contribuido por Serhiy Storchaka en bpo-32856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32856}.)

@item 
Manejo de señal optimizado en aplicaciones multiproceso. Si un subproceso diferente al subproceso principal recibe una señal, el bucle de evaluación del código de bytes ya no se interrumpe en cada instrucción de código de bytes para verificar si hay señales pendientes que no se pueden manejar. Solo el hilo principal del intérprete principal puede manejar señales.

Anteriormente, el ciclo de evaluación del código de bytes se interrumpía en cada instrucción hasta que el hilo principal manejaba las señales. (Contribuido por Victor Stinner en bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}.)

@item 
Optimicé el módulo @ref{d6,,subprocess} en FreeBSD usando @code{closefrom()}. (Contribuido por Ed Maste, Conrad Meyer, Kyle Evans, Kubilay Kocak y Victor Stinner en bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}.)

@item 
@ref{9d5,,PyLong_FromDouble()} ahora es hasta 1,87 veces más rápido para valores que se ajustan a long. (Contribuido por Sergey Fedoseev en bpo-37986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37986}.)

@item 
A number of Python builtins (@ref{9d6,,range}, @ref{464,,tuple}, @ref{67a,,set},
@ref{67b,,frozenset}, @ref{18e,,list}, @ref{190,,dict}) are now sped up by using
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall protocol.
(Contributed by Donghee Na, Mark Shannon, Jeroen Demeyer and Petr Viktorin in bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}.)

@item 
@code{difference_update()} optimizado para el caso en el que el otro conjunto es mucho más grande que el conjunto base. (Sugerido por Evgeny Kapun con código aportado por Michele Orrù en bpo-8425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8425}.)

@item 
El asignador de objetos pequeños de Python (@code{obmalloc.c}) ahora permite (no más de) que una arena vacía permanezca disponible para su reutilización inmediata, sin devolverla al sistema operativo. Esto evita la paliza en bucles simples donde una arena podría crearse y destruirse de nuevo en cada iteración. (Contribuido por Tim Peters en bpo-37257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37257}.)

@item 
@ref{9d7,,floor division} de operación flotante ahora tiene un mejor rendimiento. También se actualiza el mensaje de @ref{9d8,,ZeroDivisionError} para esta operación. (Contribuido por Donghee Na en bpo-39434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39434}.)

@item 
La decodificación de cadenas cortas ASCII con códecs UTF-8 y ascii ahora es aproximadamente un 15% más rápida. (Contribuido por Inada Naoki en bpo-37348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37348}.)
@end itemize

A continuación, se muestra un resumen de las mejoras de rendimiento desde Python 3.4 hasta Python 3.9:

@example
Python version                       3.4     3.5     3.6     3.7     3.8    3.9
--------------                       ---     ---     ---     ---     ---    ---

Variable and attribute read access:
    read_local                       7.1     7.1     5.4     5.1     3.9    3.9
    read_nonlocal                    7.1     8.1     5.8     5.4     4.4    4.5
    read_global                     15.5    19.0    14.3    13.6     7.6    7.8
    read_builtin                    21.1    21.6    18.5    19.0     7.5    7.8
    read_classvar_from_class        25.6    26.5    20.7    19.5    18.4   17.9
    read_classvar_from_instance     22.8    23.5    18.8    17.1    16.4   16.9
    read_instancevar                32.4    33.1    28.0    26.3    25.4   25.3
    read_instancevar_slots          27.8    31.3    20.8    20.8    20.2   20.5
    read_namedtuple                 73.8    57.5    45.0    46.8    18.4   18.7
    read_boundmethod                37.6    37.9    29.6    26.9    27.7   41.1

Variable and attribute write access:
    write_local                      8.7     9.3     5.5     5.3     4.3    4.3
    write_nonlocal                  10.5    11.1     5.6     5.5     4.7    4.8
    write_global                    19.7    21.2    18.0    18.0    15.8   16.7
    write_classvar                  92.9    96.0   104.6   102.1    39.2   39.8
    write_instancevar               44.6    45.8    40.0    38.9    35.5   37.4
    write_instancevar_slots         35.6    36.1    27.3    26.6    25.7   25.8

Data structure read access:
    read_list                       24.2    24.5    20.8    20.8    19.0   19.5
    read_deque                      24.7    25.5    20.2    20.6    19.8   20.2
    read_dict                       24.3    25.7    22.3    23.0    21.0   22.4
    read_strdict                    22.6    24.3    19.5    21.2    18.9   21.5

Data structure write access:
    write_list                      27.1    28.5    22.5    21.6    20.0   20.0
    write_deque                     28.7    30.1    22.7    21.8    23.5   21.7
    write_dict                      31.4    33.3    29.3    29.2    24.7   25.4
    write_strdict                   28.4    29.9    27.5    25.2    23.1   24.5

Stack (or queue) operations:
    list_append_pop                 93.4   112.7    75.4    74.2    50.8   50.6
    deque_append_pop                43.5    57.0    49.4    49.2    42.5   44.2
    deque_append_popleft            43.7    57.3    49.7    49.7    42.8   46.4

Timing loop:
    loop_overhead                    0.5     0.6     0.4     0.3     0.3    0.3
@end example

These results were generated from the variable access benchmark script at:
@code{Tools/scripts/var_access_benchmark.py}. The benchmark script displays timings
in nanoseconds.  The benchmarks were measured on an
Intel® Core™ i7-4960HQ processor@footnote{https://ark.intel.com/content/www/us/en/ark/products/76088/intel-core-i7-4960hq-processor-6m-cache-up-to-3-80-ghz.html}
running the macOS 64-bit builds found at
python.org@footnote{https://www.python.org/downloads/macos/}.

@node Obsoleto<7>,Remoto<3>,Optimizaciones<4>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 deprecated}@anchor{9d9}
@subsection Obsoleto



@itemize *

@item 
El comando distutils @code{bdist_msi} ahora está en desuso, use @code{bdist_wheel} (paquetes de ruedas) en su lugar. (Contribuido por Hugo van Kemenade en bpo-39586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39586}.)

@item 
Actualmente, @ref{9da,,math.factorial()} acepta instancias de @ref{153,,float} con valores enteros no negativos (como @code{5.0}). Sube un @ref{360,,ValueError} para flotadores no integrales y negativos. Ahora está en desuso. En futuras versiones de Python, lanzará un @ref{228,,TypeError} para todos los flotadores. (Contribuido por Serhiy Storchaka en bpo-37315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37315}.)

@item 
The @code{parser} and @code{symbol} modules are deprecated and will be
removed in future versions of Python. For the majority of use cases,
users can leverage the Abstract Syntax Tree (AST) generation and compilation
stage, using the @ref{9,,ast} module.

@item 
The Public C API functions @code{PyParser_SimpleParseStringFlags()},
@code{PyParser_SimpleParseStringFlagsFilename()},
@code{PyParser_SimpleParseFileFlags()} and @code{PyNode_Compile()}
are deprecated and will be removed in Python 3.10 together with the old parser.

@item 
El uso de @ref{227,,NotImplemented} en un contexto booleano ha quedado obsoleto, ya que es casi exclusivamente el resultado de implementaciones incorrectas de comparadores ricos. Se convertirá en @ref{228,,TypeError} en una versión futura de Python. (Contribuido por Josh Rosenberg en bpo-35712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35712}.)

@item 
El módulo @ref{b8,,random} actualmente acepta cualquier tipo hash como posible valor semilla. Desafortunadamente, no se garantiza que algunos de esos tipos tengan un valor hash determinista. Después de Python 3.9, el módulo restringirá sus semillas a @ref{716,,None}, @ref{1f0,,int}, @ref{153,,float}, @ref{237,,str}, @ref{325,,bytes} y @ref{5e0,,bytearray}.

@item 
Abrir el archivo @ref{4d8,,GzipFile} para escritura sin especificar el argumento `mode' argument is deprecated.  In future Python versions it will always be opened for reading by default.  Specify the `mode' para abrirlo para escribir y silenciar una advertencia. (Contribuido por Serhiy Storchaka en bpo-28286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28286}.)

@item 
Deprecated the @code{split()} method of @code{_tkinter.TkappType} in
favour of the @code{splitlist()} method which has more consistent and
predictable behavior.
(Contributed by Serhiy Storchaka in bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}.)

@item 
El paso explícito de objetos de rutina a @ref{528,,asyncio.wait()} ha quedado obsoleto y se eliminará en la versión 3.11. (Contribuido por Yury Selivanov y Kyle Stanley en bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}.)

@item 
binhex4 and hexbin4 standards are now deprecated. The @code{binhex} module
and the following @ref{11,,binascii} functions are now deprecated:


@itemize *

@item 
@code{b2a_hqx()}, @code{a2b_hqx()}

@item 
@code{rlecode_hqx()}, @code{rledecode_hqx()}
@end itemize

(Contribuido por Victor Stinner en bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}.)

@item 
Las clases @ref{9,,ast} @code{slice}, @code{Index} y @code{ExtSlice} se consideran obsoletas y se eliminarán en futuras versiones de Python. El propio @code{value} debe utilizarse en lugar de @code{Index(value)}. Se debe utilizar @code{Tuple(slices, Load())} en lugar de @code{ExtSlice(slices)}. (Contribuido por Serhiy Storchaka en bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}.)

@item 
Las clases @ref{9,,ast} @code{Suite}, @code{Param}, @code{AugLoad} y @code{AugStore} se consideran obsoletas y se eliminarán en futuras versiones de Python. No fueron generados por el analizador y no aceptados por el generador de código en Python 3. (Contribuido por Batuhan Taskaya en bpo-39639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39639} y bpo-39969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39969} y Serhiy Storchaka en bpo-39988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39988}).

@item 
The @code{PyEval_InitThreads()} and @code{PyEval_ThreadsInitialized()}
functions are now deprecated and will be removed in Python 3.11. Calling
@code{PyEval_InitThreads()} now does nothing. The @ref{2c5,,GIL} is initialized
by @ref{247,,Py_Initialize()} since Python 3.7.
(Contributed by Victor Stinner in bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}.)

@item 
Pasar @code{None} como primer argumento a la función @ref{5de,,shlex.split()} ha quedado obsoleto. (Contribuido por Zackery Spytz en bpo-33262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33262}.)

@item 
@code{smtpd.MailmanProxy()} is now deprecated as it is unusable without
an external module, @code{mailman}.  (Contributed by Samuel Colvin in bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}.)

@item 
The @code{lib2to3} module now emits a @ref{95f,,PendingDeprecationWarning}.
Python 3.9 switched to a PEG parser (see 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}), and Python 3.10 may
include new language syntax that is not parsable by lib2to3’s LL(1) parser.
The @code{lib2to3} module may be removed from the standard library in a future
Python version. Consider third-party alternatives such as LibCST@footnote{https://libcst.readthedocs.io/} or
parso@footnote{https://parso.readthedocs.io/}.
(Contributed by Carl Meyer in bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}.)

@item 
El parámetro `random' de @ref{7e2,,random.shuffle()} ha quedado obsoleto. (Contribuido por Raymond Hettinger en bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465})
@end itemize

@node Remoto<3>,Portar a Python 3 9,Obsoleto<7>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 removed}@anchor{9db}@anchor{whatsnew/3 9 removed-in-python-39}@anchor{962}
@subsection Remoto



@itemize *

@item 
The erroneous version at @code{unittest.mock.__version__} has been removed.

@item 
@code{nntplib.NNTP}: @code{xpath()} and @code{xgtitle()} methods have been removed.
These methods are deprecated since Python 3.3. Generally, these extensions
are not supported or not enabled by NNTP server administrators.
For @code{xgtitle()}, please use @code{nntplib.NNTP.descriptions()} or
@code{nntplib.NNTP.description()} instead.
(Contributed by Donghee Na in bpo-39366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39366}.)

@item 
@ref{308,,array.array}: Se han eliminado los métodos @code{tostring()} y @code{fromstring()}. Eran alias de @code{tobytes()} y @code{frombytes()}, obsoletos desde Python 3.2. (Contribuido por Victor Stinner en bpo-38916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38916}.)

@item 
Se ha eliminado la función @code{sys.callstats()} sin documentar. Desde Python 3.7, quedó obsoleto y siempre devolvió @ref{716,,None}. Requería una opción de compilación especial @code{CALL_PROFILE} que ya se eliminó en Python 3.7. (Contribuido por Victor Stinner en bpo-37414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37414}.)

@item 
Se han eliminado las funciones @code{sys.getcheckinterval()} y @code{sys.setcheckinterval()}. Fueron obsoletos desde Python 3.2. Utilice @ref{9dc,,sys.getswitchinterval()} y @ref{9dd,,sys.setswitchinterval()} en su lugar. (Contribuido por Victor Stinner en bpo-37392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37392}.)

@item 
Se ha eliminado la función C @code{PyImport_Cleanup()}. Se documentó como: «Vacíe la tabla del módulo. Solo para uso interno». (Contribuido por Victor Stinner en bpo-36710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36710}.)

@item 
Se han eliminado los módulos @code{_dummy_thread} y @code{dummy_threading}. Estos módulos quedaron obsoletos desde Python 3.7, que requiere compatibilidad con subprocesos. (Contribuido por Victor Stinner en bpo-37312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37312}.)

@item 
@code{aifc.openfp()} alias to @code{aifc.open()}, @code{sunau.openfp()} alias to
@code{sunau.open()}, and @code{wave.openfp()} alias to @ref{9de,,wave.open()} have been
removed. They were deprecated since Python 3.7.
(Contributed by Victor Stinner in bpo-37320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37320}.)

@item 
The @code{isAlive()} method of @ref{9df,,threading.Thread}
has been removed. It was deprecated since Python 3.8.
Use @ref{9e0,,is_alive()} instead.
(Contributed by Donghee Na in bpo-37804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37804}.)

@item 
Se han eliminado los métodos @code{getchildren()} y @code{getiterator()} de las clases @ref{9e1,,ElementTree} y @ref{20b,,Element} en el módulo @ref{125,,ElementTree}. Fueron obsoletos en Python 3.2. Utilice @code{iter(x)} o @code{list(x)} en lugar de @code{x.getchildren()} y @code{x.iter()} o @code{list(x.iter())} en lugar de @code{x.getiterator()}. (Contribuido por Serhiy Storchaka en bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543}.)

@item 
Se eliminó la antigua API @ref{ab,,plistlib}, quedó en desuso desde Python 3.4. Utilice las funciones @ref{9e2,,load()}, @ref{9e3,,loads()}, @ref{9e4,,dump()} y @ref{9e5,,dumps()}. Además, se eliminó el parámetro `use_builtin_types'; en su lugar, siempre se utilizan objetos @ref{325,,bytes} estándar. (Contribuido por Jon Janzen en bpo-36409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36409}.)

@item 
Se ha eliminado la función C @code{PyGen_NeedsFinalizing}. No se documentó, probó ni usó en ningún lugar dentro de CPython después de la implementación de 
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}. Parche de Joannah Nanjekye. (Contribuido por Joannah Nanjekye en bpo-15088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15088})

@item 
@code{base64.encodestring()} y @code{base64.decodestring()}, los alias obsoletos desde Python 3.1, se han eliminado: utilice @ref{9e6,,base64.encodebytes()} y @ref{9e7,,base64.decodebytes()} en su lugar. (Contribuido por Victor Stinner en bpo-39351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39351}.)

@item 
La función @code{fractions.gcd()} se ha eliminado, está obsoleta desde Python 3.5 (bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}): utilice @ref{9a6,,math.gcd()} en su lugar. (Contribuido por Victor Stinner en bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}.)

@item 
Se ha eliminado el parámetro `buffering' de @ref{8fd,,bz2.BZ2File}. Desde Python 3.0, se ignoró y su uso emitió un @ref{1da,,DeprecationWarning}. Pase un objeto de archivo abierto para controlar cómo se abre el archivo. (Contribuido por Victor Stinner en bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}.)

@item 
Se ha eliminado el parámetro `encoding' de @ref{9e8,,json.loads()}. A partir de Python 3.1, fue obsoleto e ignorado; su uso ha emitido un @ref{1da,,DeprecationWarning} desde Python 3.8. (Contribuido por Inada Naoki en bpo-39377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39377})

@item 
Las declaraciones @code{with (await asyncio.lock):} y @code{with (yield from asyncio.lock):} ya no son compatibles, utilice @code{async with lock} en su lugar. Lo mismo es correcto para @code{asyncio.Condition} y @code{asyncio.Semaphore}. (Contribuido por Andrew Svetlov en bpo-34793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34793}.)

@item 
The @code{sys.getcounts()} function, the @code{-X showalloccount} command line
option and the @code{show_alloc_count} field of the C structure
@ref{499,,PyConfig} have been removed. They required a special Python build by
defining @code{COUNT_ALLOCS} macro.
(Contributed by Victor Stinner in bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}.)

@item 
Se ha eliminado el atributo @code{_field_types} de la clase @ref{1db,,typing.NamedTuple}. Quedó en desuso desde Python 3.8. En su lugar, utilice el atributo @code{__annotations__}. (Contribuido por Serhiy Storchaka en bpo-40182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40182}.)

@item 
The @code{symtable.SymbolTable.has_exec()} method has been removed. It was
deprecated since 2006, and only returning @code{False} when it’s called.
(Contributed by Batuhan Taskaya in bpo-40208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40208})

@item 
The @code{asyncio.Task.current_task()} and @code{asyncio.Task.all_tasks()}
have been removed. They were deprecated since Python 3.7 and you can use
@ref{526,,asyncio.current_task()} and @ref{9e9,,asyncio.all_tasks()} instead.
(Contributed by Rémi Lapeyre in bpo-40967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40967})

@item 
El método @code{unescape()} en la clase @ref{90e,,html.parser.HTMLParser} se ha eliminado (quedó obsoleto desde Python 3.4). @ref{9ea,,html.unescape()} debe usarse para convertir referencias de caracteres a los caracteres Unicode correspondientes.
@end itemize

@node Portar a Python 3 9,Construir cambios<3>,Remoto<3>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 porting-to-python-3-9}@anchor{9eb}
@subsection Portar a Python 3.9


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en la API de Python: Cambios en la API de Python<3>. 
* Cambios en la API de C: Cambios en la API de C<5>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<4>. 

@end menu

@node Cambios en la API de Python<3>,Cambios en la API de C<5>,,Portar a Python 3 9
@anchor{whatsnew/3 9 changes-in-the-python-api}@anchor{9ec}
@subsubsection Cambios en la API de Python



@itemize *

@item 
@ref{96b,,__import__()} y @ref{9a0,,importlib.util.resolve_name()} ahora lanzan @ref{4d7,,ImportError} donde anteriormente lanzaban @ref{360,,ValueError}. Las personas que llaman que detectan el tipo de excepción específico y son compatibles con Python 3.9 y versiones anteriores deberán detectar ambas usando @code{except (ImportError, ValueError):}.

@item 
Los scripts de activación de @ref{111,,venv} ya no son casos especiales cuando @code{__VENV_PROMPT__} se establece en @code{""}.

@item 
The @ref{9ed,,select.epoll.unregister()} method no longer ignores the
@ref{9ee,,EBADF} error.
(Contributed by Victor Stinner in bpo-39239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39239}.)

@item 
Se ha eliminado el parámetro `compresslevel' @ref{8fd,,bz2.BZ2File} se convirtió solo en un parámetro de llave, ya que `buffering' se quitó. (Contribuido por Victor Stinner en bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}.)

@item 
AST simplificado para suscripción. Los índices simples se representarán por su valor, los segmentos extendidos se representarán como tuplas. @code{Index(value)} devolverá un @code{value} en sí mismo, @code{ExtSlice(slices)} devolverá @code{Tuple(slices, Load())}. (Contribuido por Serhiy Storchaka en bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}.)

@item 
El módulo @ref{77,,importlib} ahora ignora la variable de entorno 
@geindex PYTHONCASEOK
@geindex variables de entorno; PYTHONCASEOK
@ref{9ef,,PYTHONCASEOK} cuando se utilizan las opciones de línea de comando @ref{9f0,,-E} o @ref{9f1,,-I}.

@item 
El parámetro `encoding' se ha agregado a las clases @ref{990,,ftplib.FTP} y @ref{991,,ftplib.FTP_TLS} como un parámetro de solo palabra clave, y la codificación predeterminada se cambia de Latin-1 a UTF-8 para seguir: rfc: @cite{2640}.

@item 
@ref{97e,,asyncio.loop.shutdown_default_executor()} se ha agregado a @ref{9f2,,AbstractEventLoop}, lo que significa que los bucles de eventos alternativos que heredan de él deben tener definido este método. (Contribuido por Kyle Stanley en bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}.)

@item 
Los valores constantes de los indicadores futuros en el módulo @ref{0,,__future__} se actualizan para evitar la colisión con los indicadores del compilador. Anteriormente, @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} chocaba con @code{CO_FUTURE_DIVISION}. (Contribuido por Batuhan Taskaya en bpo-39562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39562})

@item 
@code{array('u')} now uses @code{wchar_t} as C type instead of @code{Py_UNICODE}.
This change doesn’t affect to its behavior because @code{Py_UNICODE} is alias
of @code{wchar_t} since Python 3.3.
(Contributed by Inada Naoki in bpo-34538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34538}.)

@item 
La API @ref{9f3,,logging.getLogger()} ahora devuelve el registrador raíz cuando se le pasó el nombre @code{'root'}, mientras que anteriormente devolvía un registrador no raíz llamado @code{'root'}. Esto podría afectar los casos en los que el código de usuario desea explícitamente un registrador no root llamado @code{'root'}, o crea una instancia de un registrador usando @code{logging.getLogger(__name__)} en algún módulo de nivel superior llamado @code{'root.py'}. (Contribuido por Vinay Sajip en bpo-37742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37742}.)

@item 
Division handling of @ref{54e,,PurePath} now returns @ref{227,,NotImplemented}
instead of raising a @ref{228,,TypeError} when passed something other than an
instance of @code{str} or @ref{54e,,PurePath}.  This allows creating
compatible classes that don’t inherit from those mentioned types.
(Contributed by Roger Aiudi in bpo-34775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34775}).

@item 
A partir de Python 3.9.5, el módulo @ref{80,,ipaddress} ya no acepta ceros a la izquierda en las cadenas de direcciones IPv4. Los ceros iniciales son ambiguos y algunas bibliotecas los interpretan como notación octal. Por ejemplo, la función heredada @ref{9f4,,socket.inet_aton()} trata los ceros iniciales como una notación octal. La implementación glibc del @ref{9f5,,inet_pton()} moderno no acepta ceros a la izquierda. (Contribuido por Christian Heimes en bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}).

@item 
@ref{9f6,,codecs.lookup()} ahora normaliza el nombre de codificación de la misma manera que @code{encodings.normalize_encoding()}, excepto que @ref{9f6,,codecs.lookup()} también convierte el nombre a minúsculas. Por ejemplo, el nombre de codificación @code{"latex+latin1"} ahora está normalizado a @code{"latex_latin1"}. (Contribuido por Jordon Xu en bpo-37751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37751}.)
@end itemize

@node Cambios en la API de C<5>,Cambios en el código de bytes de CPython<4>,Cambios en la API de Python<3>,Portar a Python 3 9
@anchor{whatsnew/3 9 changes-in-the-c-api}@anchor{9f7}
@subsubsection Cambios en la API de C



@itemize *

@item 
Las instancias de @ref{9f8,,heap-allocated types} (como las creadas con @ref{621,,PyType_FromSpec()} y API similares) contienen una referencia a su objeto de tipo desde Python 3.8. Como se indica en los «Cambios en la API C» de Python 3.8, para la gran mayoría de los casos, no debería haber efectos secundarios, pero para los tipos que tienen una función personalizada @ref{818,,tp_traverse}, asegúrese de que todas las funciones @code{tp_traverse} personalizadas de los tipos asignados al montón visitan el tipo del objeto.

@quotation

Ejemplo:

@example
int
foo_traverse(foo_struct *self, visitproc visit, void *arg) @{
// Rest of the traverse function
#if PY_VERSION_HEX >= 0x03090000
    // This was not needed before Python 3.9 (Python issue 35810 and 40217)
    Py_VISIT(Py_TYPE(self));
#endif
@}
@end example
@end quotation

Si su función transversal delega en @code{tp_traverse} de su clase base (u otro tipo), asegúrese de que @code{Py_TYPE(self)} se visite solo una vez. Tenga en cuenta que solo se espera que @ref{9f8,,heap type} visite el tipo en @code{tp_traverse}.

@quotation

Por ejemplo, si su función @code{tp_traverse} incluye:

@example
base->tp_traverse(self, visit, arg)
@end example

Luego añade:

@example
#if PY_VERSION_HEX >= 0x03090000
    // This was not needed before Python 3.9 (bpo-35810 and bpo-40217)
    if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
        // a heap type's tp_traverse already visited Py_TYPE(self)
    @} else @{
        Py_VISIT(Py_TYPE(self));
    @}
#else
@end example
@end quotation

(Consulte bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810} y bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217} para obtener más información).

@item 
Las funciones @code{PyEval_CallObject}, @code{PyEval_CallFunction}, @code{PyEval_CallMethod} y @code{PyEval_CallObjectWithKeywords} están en desuso. Utilice @ref{48f,,PyObject_Call()} y sus variantes en su lugar. (Ver más detalles en bpo-29548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29548}.)
@end itemize

@node Cambios en el código de bytes de CPython<4>,,Cambios en la API de C<5>,Portar a Python 3 9
@anchor{whatsnew/3 9 cpython-bytecode-changes}@anchor{9f9}
@subsubsection Cambios en el código de bytes de CPython



@itemize *

@item 
Se agregó el código de operación @code{LOAD_ASSERTION_ERROR} para manejar la declaración @ref{9fa,,assert}. Anteriormente, la declaración de aserción no funcionaría correctamente si la excepción @ref{74a,,AssertionError} estuviera siendo sombreada. (Contribuido por Zackery Spytz en bpo-34880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34880}.)

@item 
El código de operación @ref{9fb,,COMPARE_OP} se dividió en cuatro instrucciones distintas:


@itemize *

@item 
@code{COMPARE_OP} para comparaciones enriquecidas

@item 
@code{IS_OP} para pruebas “es” y “no es”

@item 
@code{CONTAINS_OP} para pruebas “in” y “not in”

@item 
@code{JUMP_IF_NOT_EXC_MATCH} para verificar las excepciones en las declaraciones “try-except”.
@end itemize

(Contribuido por Mark Shannon en bpo-39156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39156}.)
@end itemize

@node Construir cambios<3>,Cambios en la API de C<6>,Portar a Python 3 9,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 build-changes}@anchor{9fc}
@subsection Construir cambios



@itemize *

@item 
Added @code{--with-platlibdir} option to the @code{configure} script: name of the
platform-specific library directory, stored in the new @ref{9cb,,sys.platlibdir}
attribute. See @ref{9cb,,sys.platlibdir} attribute for more information.
(Contributed by Jan Matějek, Matěj Cepl, Charalampos Stratakis
and Victor Stinner in bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}.)

@item 
Se ha eliminado la macro de compilación especial @code{COUNT_ALLOCS}. (Contribuido por Victor Stinner en bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}.)

@item 
On non-Windows platforms, the @code{setenv()} and @code{unsetenv()}
functions are now required to build Python.
(Contributed by Victor Stinner in bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}.)

@item 
En plataformas que no son de Windows, la creación de instaladores @code{bdist_wininst} ahora no es compatible oficialmente. (Consulte bpo-10945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10945} para obtener más detalles).

@item 
Al compilar Python en macOS desde la fuente, @code{_tkinter} ahora se vincula con marcos Tcl y Tk que no son del sistema si están instalados en @code{/Library/Frameworks}, como había sido el caso en versiones anteriores de macOS. Si un SDK de macOS está configurado explícitamente, mediante @ref{9fd,,--enable-universalsdk} o @code{-isysroot}, solo se busca en el SDK. El comportamiento predeterminado aún se puede anular con @cite{–with-tcltk-includes} y @cite{–with-tcltk-libs}. (Contribuido por Ned Deily en bpo-34956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34956}.)

@item 
Python ahora se puede construir para Windows 10 ARM64. (Contribuido por Steve Dower en bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}.)

@item 
Algunas pruebas individuales ahora se omiten cuando se usa @code{--pgo}. Las pruebas en cuestión aumentaron significativamente el tiempo de la tarea PGO y probablemente no ayudaron a mejorar la optimización del ejecutable final. Esto acelera la tarea en un factor de aproximadamente 15 veces. La ejecución del conjunto de pruebas unitarias completo es lenta. Este cambio puede resultar en una compilación ligeramente menos optimizada ya que no se ejecutarán tantas ramas de código. Si está dispuesto a esperar la compilación mucho más lenta, el comportamiento anterior se puede restaurar usando @code{./configure [..] PROFILE_TASK="-m test --pgo-extended"}. No garantizamos qué conjunto de tareas de PGO produce una compilación más rápida. Los usuarios interesados deben ejecutar sus propios puntos de referencia relevantes, ya que los resultados pueden depender del entorno, la carga de trabajo y la cadena de herramientas del compilador. (Consulte bpo-36044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36044} y bpo-37707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37707} para obtener más detalles).
@end itemize

@node Cambios en la API de C<6>,Cambios notables en Python 3 9 1,Construir cambios<3>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 c-api-changes}@anchor{9fe}
@subsection Cambios en la API de C


@menu
* Nuevas características: Nuevas características<8>. 
* Portar a Python 3.9: Portar a Python 3 9<2>. 
* Remoto: Remoto<4>. 

@end menu

@node Nuevas características<8>,Portar a Python 3 9<2>,,Cambios en la API de C<6>
@anchor{whatsnew/3 9 id1}@anchor{9ff}
@subsubsection Nuevas características



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}: Added @ref{5f4,,PyType_FromModuleAndSpec()} to associate
a module with a class; @ref{a00,,PyType_GetModule()} and
@ref{a01,,PyType_GetModuleState()} to retrieve the module and its state; and
@ref{7fe,,PyCMethod} and @ref{a02,,METH_METHOD} to allow a method to
access the class it was defined in.
(Contributed by Marcel Plch and Petr Viktorin in bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}.)

@item 
Se agregó la función @ref{823,,PyFrame_GetCode()}: obtenga un código de marco. Se agregó la función @ref{81f,,PyFrame_GetBack()}: obtenga el siguiente marco exterior del marco. (Contribuido por Victor Stinner en bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}.)

@item 
Se agregó @ref{824,,PyFrame_GetLineNumber()} a la API C limitada. (Contribuido por Victor Stinner en bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}.)

@item 
Se agregaron funciones @ref{a03,,PyThreadState_GetInterpreter()} y @ref{4a0,,PyInterpreterState_Get()} para obtener el intérprete. Se agregó la función @ref{827,,PyThreadState_GetFrame()} para obtener el marco actual de un estado de subproceso de Python. Se agregó la función @ref{a04,,PyThreadState_GetID()}: obtenga el identificador único de un estado de subproceso de Python. (Contribuido por Victor Stinner en bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}.)

@item 
Se agregó una nueva función pública @ref{48e,,PyObject_CallNoArgs()} a la API de C, que llama a un objeto de Python invocable sin ningún argumento. Es la forma más eficiente de llamar a un objeto de Python invocable sin ningún argumento. (Contribuido por Victor Stinner en bpo-37194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37194}.)

@item 
Cambios en la API C limitada (si se define la macro @code{Py_LIMITED_API}):


@itemize *

@item 
Proporcione @ref{a05,,Py_EnterRecursiveCall()} y @ref{a06,,Py_LeaveRecursiveCall()} como funciones regulares para la API limitada. Anteriormente, se definían como macros, pero estas macros no se compilaban con la API C limitada que no puede acceder al campo @code{PyThreadState.recursion_depth} (la estructura es opaca en la API C limitada).

@item 
@code{PyObject_INIT()} y @code{PyObject_INIT_VAR()} se convierten en funciones «opacas» habituales para ocultar los detalles de la implementación.
@end itemize

(Contribuido por Victor Stinner en bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} y bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}.)

@item 
The @ref{a07,,PyModule_AddType()} function is added to help adding a type
to a module.
(Contributed by Donghee Na in bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024}.)

@item 
Se agregaron las funciones @ref{a08,,PyObject_GC_IsTracked()} y @ref{a09,,PyObject_GC_IsFinalized()} a la API pública para permitir consultar si los objetos de Python se están rastreando actualmente o si ya han sido finalizados por el recolector de basura, respectivamente. (Contribuido por Pablo Galindo Salgado en bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}.)

@item 
Added @code{_PyObject_FunctionStr()} to get a user-friendly string
representation of a function-like object.
(Patch by Jeroen Demeyer in bpo-37645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37645}.)

@item 
Se agregó @ref{a0a,,PyObject_CallOneArg()} para llamar a un objeto con un argumento posicional (parche de Jeroen Demeyer en bpo-37483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37483}).
@end itemize

@node Portar a Python 3 9<2>,Remoto<4>,Nuevas características<8>,Cambios en la API de C<6>
@anchor{whatsnew/3 9 id2}@anchor{a0b}
@subsubsection Portar a Python 3.9



@itemize *

@item 
@code{PyInterpreterState.eval_frame} (
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}) ahora requiere un nuevo parámetro `tstate' obligatorio (@code{PyThreadState*}). (Contribuido por Victor Stinner en bpo-38500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38500}.)

@item 
Módulos de extensión: @ref{a0c,,m_traverse}, @ref{a0d,,m_clear} y @ref{a0e,,m_free} Las funciones de @ref{a0f,,PyModuleDef} ya no se llaman si el estado del módulo era solicitado pero aún no asignado. Este es el caso inmediatamente después de que se crea el módulo y antes de que se ejecute (función @ref{a10,,Py_mod_exec}). Más precisamente, estas funciones no se llaman si @ref{a11,,m_size} es mayor que 0 y el estado del módulo (como lo devuelve @ref{a12,,PyModule_GetState()}) es @code{NULL}.

Los módulos de extensión sin estado de módulo (@code{m_size <= 0}) no se ven afectados.

@item 
Si se llama a @ref{a13,,Py_AddPendingCall()} en un subinterpretador, la función ahora está programada para ser llamada desde el subinterpretador, en lugar de ser llamada desde el intérprete principal. Cada subinterpretador ahora tiene su propia lista de llamadas programadas. (Contribuido por Victor Stinner en bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}.)

@item 
El registro de Windows ya no se usa para inicializar @ref{27e,,sys.path} cuando se usa la opción @code{-E} (si @ref{4ba,,PyConfig.use_environment} está configurado en @code{0}). Esto es importante al incrustar Python en Windows. (Contribuido por Zackery Spytz en bpo-8901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8901}.)

@item 
La variable global @ref{a14,,PyStructSequence_UnnamedField} ahora es una constante y se refiere a una cadena constante. (Contribuido por Serhiy Storchaka en bpo-38650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38650}.)

@item 
The @code{PyGC_Head} structure is now opaque. It is only defined in the
internal C API (@code{pycore_gc.h}).
(Contributed by Victor Stinner in bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}.)

@item 
The @code{Py_UNICODE_COPY}, @code{Py_UNICODE_FILL}, @code{PyUnicode_WSTR_LENGTH},
@code{PyUnicode_FromUnicode()}, @code{PyUnicode_AsUnicode()},
@code{_PyUnicode_AsUnicode}, and @code{PyUnicode_AsUnicodeAndSize()} are
marked as deprecated in C.  They have been deprecated by 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} since
Python 3.3.
(Contributed by Inada Naoki in bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
La función @ref{a15,,Py_FatalError()} se reemplaza con una macro que registra automáticamente el nombre de la función actual, a menos que se defina la macro @code{Py_LIMITED_API}. (Contribuido por Victor Stinner en bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882}.)

@item 
El protocolo vectorcall ahora requiere que la persona que llama solo pase cadenas como nombres de palabras clave. (Consulte bpo-37540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37540} para obtener más información).

@item 
Los detalles de implementación de una serie de macros y funciones ahora están ocultos:


@itemize *

@item 
La macro @ref{a16,,PyObject_IS_GC()} se convirtió en una función.

@item 
The @code{PyObject_NEW()} macro becomes an alias to the
@ref{a17,,PyObject_New} macro, and the @code{PyObject_NEW_VAR()} macro
becomes an alias to the @ref{a18,,PyObject_NewVar} macro. They no longer
access directly the @ref{a19,,PyTypeObject.tp_basicsize} member.

@item 
@code{PyObject_GET_WEAKREFS_LISTPTR()} macro was converted to a function:
the macro accessed directly the @ref{a1a,,PyTypeObject.tp_weaklistoffset}
member.

@item 
La macro @ref{48b,,PyObject_CheckBuffer()} se convirtió en una función: la macro accedió directamente al miembro @ref{a1b,,PyTypeObject.tp_as_buffer}.

@item 
@ref{a1c,,PyIndex_Check()} ahora siempre se declara como una función opaca para ocultar los detalles de implementación: se eliminó la macro @code{PyIndex_Check()}. La macro accedió directamente al miembro @ref{a1d,,PyTypeObject.tp_as_number}.
@end itemize

(Consulte bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170} para obtener más detalles).
@end itemize

@node Remoto<4>,,Portar a Python 3 9<2>,Cambios en la API de C<6>
@anchor{whatsnew/3 9 id3}@anchor{a1e}
@subsubsection Remoto



@itemize *

@item 
Se excluyeron las macros @code{PyFPE_START_PROTECT()} y @code{PyFPE_END_PROTECT()} de @code{pyfpe.h} de la API C limitada. (Contribuido por Victor Stinner en bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}.)

@item 
Se ha eliminado la ranura @code{tp_print} de @ref{a1f,,PyTypeObject}. Se usó para imprimir objetos en archivos en Python 2.7 y antes. Desde Python 3.0, se ha ignorado y no se ha utilizado. (Contribuido por Jeroen Demeyer en bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}.)

@item 
Cambios en la API C limitada (si se define la macro @code{Py_LIMITED_API}):


@itemize *

@item 
Se excluyeron las siguientes funciones de la API C limitada:


@itemize *

@item 
@code{PyThreadState_DeleteCurrent()} (Contribuido por Joannah Nanjekye en bpo-37878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37878}.)

@item 
@code{_Py_CheckRecursionLimit}

@item 
@code{_Py_NewReference()}

@item 
@code{_Py_ForgetReference()}

@item 
@code{_PyTraceMalloc_NewReference()}

@item 
@code{_Py_GetRefTotal()}

@item 
El mecanismo de papelera que nunca funcionó en la API C limitada.

@item 
@code{PyTrash_UNWIND_LEVEL}

@item 
@code{Py_TRASHCAN_BEGIN_CONDITION}

@item 
@code{Py_TRASHCAN_BEGIN}

@item 
@code{Py_TRASHCAN_END}

@item 
@code{Py_TRASHCAN_SAFE_BEGIN}

@item 
@code{Py_TRASHCAN_SAFE_END}
@end itemize

@item 
Se movieron las siguientes funciones y definiciones a la API de C interna:


@itemize *

@item 
@code{_PyDebug_PrintTotalRefs()}

@item 
@code{_Py_PrintReferences()}

@item 
@code{_Py_PrintReferenceAddresses()}

@item 
@code{_Py_tracemalloc_config}

@item 
@code{_Py_AddToAllObjects()} (específico para @code{Py_TRACE_REFS} acumulación)
@end itemize
@end itemize

(Contribuido por Victor Stinner en bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} y bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}.)

@item 
Se eliminó el gancho @code{_PyRuntime.getframe} y se eliminó la macro @code{_PyThreadState_GetFrame}, que era un alias de @code{_PyRuntime.getframe}. Solo fueron expuestos por la API C interna. También se eliminó el tipo @code{PyThreadFrameGetter}. (Contribuido por Victor Stinner en bpo-39946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39946}.)

@item 
Se eliminaron las siguientes funciones de la API de C. Llame a @ref{a20,,PyGC_Collect()} explícitamente para borrar todas las listas libres. (Contribuido por Inada Naoki y Victor Stinner en bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}, bpo-38896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38896} y bpo-40428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40428}.)


@itemize *

@item 
@code{PyAsyncGen_ClearFreeLists()}

@item 
@code{PyContext_ClearFreeList()}

@item 
@code{PyDict_ClearFreeList()}

@item 
@code{PyFloat_ClearFreeList()}

@item 
@code{PyFrame_ClearFreeList()}

@item 
@code{PyList_ClearFreeList()}

@item 
@code{PyMethod_ClearFreeList()} y @code{PyCFunction_ClearFreeList()}: se han eliminado las listas libres de objetos de método enlazados.

@item 
@code{PySet_ClearFreeList()}: la lista de conjuntos libres se ha eliminado en Python 3.4.

@item 
@code{PyTuple_ClearFreeList()}

@item 
@code{PyUnicode_ClearFreeList()}: la lista libre de Unicode se ha eliminado en Python 3.3.
@end itemize

@item 
Función @code{_PyUnicode_ClearStaticStrings()} eliminada. (Contribuido por Victor Stinner en bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}.)

@item 
Eliminado @code{Py_UNICODE_MATCH}. Ha sido obsoleto por 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} y roto desde Python 3.3. En su lugar, se puede utilizar la función @ref{94f,,PyUnicode_Tailmatch()}. (Contribuido por Inada Naoki en bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
Archivos de encabezado limpios de interfaces definidas pero sin implementación. Los símbolos API públicos que se eliminan son: @code{_PyBytes_InsertThousandsGroupingLocale}, @code{_PyBytes_InsertThousandsGrouping}, @code{_Py_InitializeFromArgs}, @code{_Py_InitializeFromWideArgs}, @code{_PyFloat_Repr}, @code{_PyFloat_Digits}, @code{_PyFloat_DigitsInit}, @code{PyFrame_ExtendStack}, @code{_PyAIterWrapper_Type}, @code{PyNullImporter_Type}, @code{PyCmpWrapper_Type}, @code{PySortWrapper_Type}, @code{PyNoArgsFunction}. (Contribuido por Pablo Galindo Salgado en bpo-39372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39372}.)
@end itemize

@node Cambios notables en Python 3 9 1,Cambios notables en Python 3 9 2,Cambios en la API de C<6>,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-1}@anchor{a21}
@subsection Cambios notables en Python 3.9.1


@menu
* mecanografía: mecanografía<4>. 
* Compatibilidad con macOS 11.0 (Big Sur) y Apple Silicon Mac: Compatibilidad con macOS 11 0 Big Sur y Apple Silicon Mac. 

@end menu

@node mecanografía<4>,Compatibilidad con macOS 11 0 Big Sur y Apple Silicon Mac,,Cambios notables en Python 3 9 1
@anchor{whatsnew/3 9 id4}@anchor{a22}
@subsubsection mecanografía


El comportamiento de @ref{8ec,,typing.Literal} se modificó para cumplir con 
@geindex Python Enhancement Proposals; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} y para coincidir con el comportamiento de los verificadores de tipo estático especificados en el PEP.


@enumerate 

@item 
@code{Literal} ahora elimina los parámetros duplicados.

@item 
Las comparaciones de igualdad entre objetos @code{Literal} ahora son independientes del orden.

@item 
Las comparaciones de @code{Literal} ahora respetan los tipos. Por ejemplo, @code{Literal[0] == Literal[False]} evaluado previamente como @code{True}. Ahora es @code{False}. Para respaldar este cambio, la caché de tipos utilizada internamente ahora admite tipos diferenciados.

@item 
Los objetos @code{Literal} ahora lanzarán una excepción @ref{228,,TypeError} durante las comparaciones de igualdad si alguno de sus parámetros no es @ref{6b1,,hashable}. Tenga en cuenta que declarar @code{Literal} con parámetros mutables no arrojará un error:

@example
>>> from typing import Literal
>>> Literal[@{0@}]
>>> Literal[@{0@}] == Literal[@{False@}]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unhashable type: 'set'
@end example
@end enumerate

(Contribuido por Yurii Karabas en bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}.)

@node Compatibilidad con macOS 11 0 Big Sur y Apple Silicon Mac,,mecanografía<4>,Cambios notables en Python 3 9 1
@anchor{whatsnew/3 9 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{a23}
@subsubsection Compatibilidad con macOS 11.0 (Big Sur) y Apple Silicon Mac


A partir de 3.9.1, Python ahora es totalmente compatible con la construcción y ejecución en macOS 11.0 (Big Sur) y en Apple Silicon Macs (basado en la arquitectura @code{ARM64}). Una nueva variante de compilación universal, @code{universal2}, ahora está disponible para admitir de forma nativa tanto @code{ARM64} como @code{Intel 64} en un conjunto de ejecutables. Los binarios ahora también se pueden construir en versiones actuales de macOS para ser implementados en una variedad de versiones anteriores de macOS (probadas a 10.9) mientras hacen que algunas funciones y opciones más nuevas del sistema operativo estén disponibles condicionalmente según la versión del sistema operativo en uso en tiempo de ejecución («vinculación débil» ).

(Contribuido por Ronald Oussoren y Lawrence D’Anna en bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}.)

@node Cambios notables en Python 3 9 2,Notable changes in Python 3 9 3,Cambios notables en Python 3 9 1,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-2}@anchor{a24}
@subsection Cambios notables en Python 3.9.2


@menu
* colecciones.abc: colecciones abc<2>. 
* urllib.parse: urllib parse<2>. 

@end menu

@node colecciones abc<2>,urllib parse<2>,,Cambios notables en Python 3 9 2
@anchor{whatsnew/3 9 collections-abc}@anchor{a25}
@subsubsection colecciones.abc


@ref{881,,collections.abc.Callable} genérico ahora aplana los parámetros de tipo, similar a lo que hace actualmente @ref{85e,,typing.Callable}. Esto significa que @code{collections.abc.Callable[[int, str], str]} tendrá @code{__args__} de @code{(int, str, str)}; anteriormente esto era @code{([int, str], str)}. Para permitir este cambio, @ref{882,,types.GenericAlias} ahora puede ser subclasificado, y se devolverá una subclase al subíndice el tipo @ref{881,,collections.abc.Callable}. El código que accede a los argumentos a través de @ref{916,,typing.get_args()} o @code{__args__} debe tener en cuenta este cambio. Se puede emitir un @ref{1da,,DeprecationWarning} para formas no válidas de parametrizar @ref{881,,collections.abc.Callable} que pueden haber pasado silenciosamente en Python 3.9.1. Este @ref{1da,,DeprecationWarning} se convertirá en un @ref{228,,TypeError} en Python 3.10. (Contribuido por Ken Jin en bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@node urllib parse<2>,,colecciones abc<2>,Cambios notables en Python 3 9 2
@anchor{whatsnew/3 9 urllib-parse}@anchor{a26}
@subsubsection urllib.parse


Earlier Python versions allowed using both @code{;} and @code{&} as
query parameter separators in @ref{1c9,,urllib.parse.parse_qs()} and
@ref{1c8,,urllib.parse.parse_qsl()}.  Due to security concerns, and to conform with
newer W3C recommendations, this has been changed to allow only a single
separator key, with @code{&} as the default.  This change also affects
@code{cgi.parse()} and @code{cgi.parse_multipart()} as they use the affected
functions internally. For more details, please see their respective
documentation.
(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Notable changes in Python 3 9 3,Notable changes in Python 3 9 5,Cambios notables en Python 3 9 2,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-3}@anchor{a27}
@subsection Notable changes in Python 3.9.3


A security fix alters the @ref{990,,ftplib.FTP} behavior to not trust the
IPv4 address sent from the remote server when setting up a passive data
channel.  We reuse the ftp server IP address instead.  For unusual code
requiring the old behavior, set a @code{trust_server_pasv_ipv4_address}
attribute on your FTP instance to @code{True}.  (See gh-87451@footnote{https://github.com/python/cpython/issues/87451})

@node Notable changes in Python 3 9 5,Notable security feature in 3 9 14,Notable changes in Python 3 9 3,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-5}@anchor{a28}
@subsection Notable changes in Python 3.9.5


@menu
* urllib.parse: urllib parse<3>. 

@end menu

@node urllib parse<3>,,,Notable changes in Python 3 9 5
@anchor{whatsnew/3 9 id5}@anchor{a29}
@subsubsection urllib.parse


The presence of newline or tab characters in parts of a URL allows for some
forms of attacks. Following the WHATWG specification that updates 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html},
ASCII newline @code{\n}, @code{\r} and tab @code{\t} characters are stripped from the
URL by the parser in @ref{10a,,urllib.parse} preventing such attacks. The removal
characters are controlled by a new module level variable
@code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (See gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node Notable security feature in 3 9 14,Notable changes in 3 9 17,Notable changes in Python 3 9 5,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-security-feature-in-3-9-14}@anchor{a2a}
@subsection Notable security feature in 3.9.14


Converting between @ref{1f0,,int} and @ref{237,,str} in bases other than 2
(binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal)
now raises a @ref{360,,ValueError} if the number of digits in string form is
above a limit to avoid potential denial of service attacks due to the
algorithmic complexity. This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.
This limit can be configured or disabled by environment variable, command
line flag, or @ref{d9,,sys} APIs. See the @ref{695,,integer string conversion length limitation} documentation.  The default limit
is 4300 digits in string form.

@node Notable changes in 3 9 17,,Notable security feature in 3 9 14,Qué hay de nuevo en Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-3-9-17}@anchor{a2b}
@subsection Notable changes in 3.9.17


@menu
* tarfile: tarfile<3>. 

@end menu

@node tarfile<3>,,,Notable changes in 3 9 17
@anchor{whatsnew/3 9 tarfile}@anchor{a2c}
@subsubsection tarfile



@itemize *

@item 
The extraction methods in @ref{de,,tarfile}, and @ref{516,,shutil.unpack_archive()},
have a new a `filter' argument that allows limiting tar features than may be
surprising or dangerous, such as creating files outside the destination
directory.
See @ref{517,,Extraction filters} for details.
In Python 3.12, use without the `filter' argument will show a
@ref{1da,,DeprecationWarning}.
In Python 3.14, the default will switch to @code{'data'}.
(Contributed by Petr Viktorin in 
@geindex Python Enhancement Proposals; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node Qué hay de nuevo en Python 3 8,Qué hay de nuevo en Python 3 7,Qué hay de nuevo en Python 3 9,Qué hay de nuevo en Python
@anchor{whatsnew/3 8 doc}@anchor{a2d}@anchor{whatsnew/3 8 what-s-new-in-python-3-8}@anchor{a2e}
@section Qué hay de nuevo en Python 3.8


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Git log
@c when researching a change.

@*Editor: 
Raymond Hettinger


Este artículo explica las nuevas características de Python 3.8, en comparación con 3.7. Python 3.8 se lanzó el 14 de octubre de 2019. Para obtener detalles completos, consulte @ref{13b,,changelog}.

@c from datetime import date
@c from math import cos, radians
@c from unicodedata import normalize
@c import re
@c import math

@menu
* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<2>. 
* Nuevas características: Nuevas características<9>. 
* Otros cambios en el lenguaje:: 
* Nuevos módulos: Nuevos módulos<4>. 
* Módulos mejorados: Módulos mejorados<5>. 
* Optimizaciones: Optimizaciones<5>. 
* Cambios en la compilación y la API de C:: 
* Obsoleto: Obsoleto<8>. 
* APIs y características eliminadas:: 
* Portando a Python 3.8: Portando a Python 3 8. 
* Cambios notables en Python 3.8.1: Cambios notables en Python 3 8 1. 
* Notable changes in Python 3.8.2: Notable changes in Python 3 8 2. 
* Notable changes in Python 3.8.3: Notable changes in Python 3 8 3. 
* Cambios notables en Python 3.8.8: Cambios notables en Python 3 8 8. 
* Notable changes in Python 3.8.9: Notable changes in Python 3 8 9. 
* Notable changes in Python 3.8.10: Notable changes in Python 3 8 10. 
* Notable changes in Python 3.8.10: Notable changes in Python 3 8 10<2>. 
* Cambios notables en Python 3.8.1: Cambios notables en Python 3 8 1<2>. 
* Notable security feature in 3.8.14: Notable security feature in 3 8 14. 
* Notable changes in 3.8.17: Notable changes in 3 8 17. 

@end menu

@node Resumen – Aspectos destacados de la versión<2>,Nuevas características<9>,,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 summary-release-highlights}@anchor{a2f}
@subsection Resumen – Aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.8.
@c Brevity is key.

@c PEP-sized items next.

@node Nuevas características<9>,Otros cambios en el lenguaje,Resumen – Aspectos destacados de la versión<2>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 new-features}@anchor{a30}
@subsection Nuevas características


@menu
* Expresiones de asignación:: 
* Parámetros solo posicionales:: 
* Caché del sistema de archivos paralelo para archivos de bytecode compilados:: 
* La compilación de depuración usa la misma ABI que la compilación de lanzamiento:: 
* los f-strings soportan = para expresiones autodocumentadas y depuración:: 
* PEP 578; Ganchos de auditoría en tiempo de ejecución de Python: PEP 578 Ganchos de auditoría en tiempo de ejecución de Python. 
* PEP 587; Configuración de inicialización de Python: PEP 587 Configuración de inicialización de Python. 
* PEP 590; Vectorcall; un protocolo de llamada rápida para CPython: PEP 590 Vectorcall un protocolo de llamada rápida para CPython. 
* Protocolo 5 de Pickle con búferes de datos fuera de banda:: 

@end menu

@node Expresiones de asignación,Parámetros solo posicionales,,Nuevas características<9>
@anchor{whatsnew/3 8 assignment-expressions}@anchor{a31}
@subsubsection Expresiones de asignación


La nueva sintaxis @code{:=} asigna valores a variables como parte de una expresión más grande. Se le conoce cariñosamente como «el operador morsa» debido a su parecido con los ojos y colmillos de una morsa@footnote{https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg}.

En el siguiente ejemplo, la expresión de asignación ayuda evitando que se tenga que llamar a @ref{6cf,,len()} dos veces:

@example
if (n := len(a)) > 10:
    print(f"List is too long (@{n@} elements, expected <= 10)")
@end example

Un beneficio similar surge durante la búsqueda de coincidencias mediante expresiones regulares donde los objetos de coincidencias se necesitan dos veces, una para comprobar si se produjo una coincidencia y otra para extraer un subgrupo:

@example
discount = 0.0
if (mo := re.search(r'(\d+)% discount', advertisement)):
    discount = float(mo.group(1)) / 100.0
@end example

El operador también es útil en bucles while que calculan un valor para comprobar la terminación del bucle y posteriormente necesitan nuevamente ese mismo valor en el cuerpo del bucle:

@example
# Loop over fixed length blocks
while (block := f.read(256)) != '@w{'}:
    process(block)
@end example

Otra motivación de uso surge en las listas por comprensión en las que un valor calculado en una condición de filtrado también se necesita en el cuerpo de la expresión:

@example
[clean_name.title() for name in names
 if (clean_name := normalize('NFC', name)) in allowed_names]
@end example

Intenta limitar el uso del «operador morsa» a aquellos casos en los que reduce la complejidad y mejora la legibilidad del código.

Consultar 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para obtener una descripción completa.

(Contribución de Emily Morehouse en bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)

@node Parámetros solo posicionales,Caché del sistema de archivos paralelo para archivos de bytecode compilados,Expresiones de asignación,Nuevas características<9>
@anchor{whatsnew/3 8 positional-only-parameters}@anchor{a32}
@subsubsection Parámetros solo posicionales


There is a new function parameter syntax @code{/} to indicate that some
function parameters must be specified positionally and cannot be used as
keyword arguments.  This is the same notation shown by @code{help()} for C
functions annotated with Larry Hastings”
Argument Clinic@footnote{https://devguide.python.org/development-tools/clinic/} tool.

En el siguiente ejemplo, los parámetros `a' y `b' son solo posicionales, mientras que `c' o `d' pueden ser posicionales o por palabra clave y `e' o `f' deben proporcionarse por palabra clave exclusivamente:

@example
def f(a, b, /, c, d, *, e, f):
    print(a, b, c, d, e, f)
@end example

La siguiente es una invocación válida:

@example
f(10, 20, 30, d=40, e=50, f=60)
@end example

Sin embargo, estas son invocaciones inválidas:

@example
f(10, b=20, c=30, d=40, e=50, f=60)   # b cannot be a keyword argument
f(10, 20, 30, 40, 50, f=60)           # e must be a keyword argument
@end example

Un caso de uso de esta notación es permitir que las funciones puras de Python emulen completamente los comportamientos de las funciones codificadas en C existentes. Por ejemplo, la función incorporada @ref{a33,,divmod()} no acepta argumentos por palabra clave:

@example
def divmod(a, b, /):
    "Emulate the built in divmod() function"
    return (a // b, a % b)
@end example

Otro caso de uso es excluir los argumentos por palabra clave cuando el nombre del parámetro no es útil. Por ejemplo, la función incorporada @ref{6cf,,len()} tiene la firma @code{len(obj, /)}. Esto excluye llamadas inoportunas como:

@example
len(obj='hello')  # The "obj" keyword argument impairs readability
@end example

Un beneficio adicional de marcar un parámetro como solo posicional es que permite cambiar el nombre del parámetro en el futuro sin riesgo de romper el código del cliente. Por ejemplo, en el módulo @ref{d2,,statistics}, el nombre del parámetro `dist' puede cambiarse en el futuro. Esto es posible gracias a la siguiente especificación de función:

@example
def quantiles(dist, /, *, n=4, method='exclusive')
    ...
@end example

Dado que los parámetros a la izquierda de @code{/} no se exponen como posibles palabras clave, los nombres de los parámetros permanecen disponibles para su uso en @code{**kwargs}:

@example
>>> def f(a, b, /, **kwargs):
...     print(a, b, kwargs)
...
>>> f(10, 20, a=1, b=2, c=3)         # a and b are used in two ways
10 20 @{'a': 1, 'b': 2, 'c': 3@}
@end example

Esto simplifica enormemente la implementación de funciones y métodos que necesitan aceptar argumentos por palabra clave arbitrarios. Por ejemplo, aquí hay un extracto del código del módulo @ref{1e,,collections}:

@example
class Counter(dict):

    def __init__(self, iterable=None, /, **kwds):
        # Note "iterable" is a possible keyword argument
@end example

Consultar 
@geindex Python Enhancement Proposals; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} para obtener una descripción completa.

(Contribución de Pablo Galindo en bpo-36540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36540}.)

@c TODO: Pablo will sprint on docs at PyCon US 2019.

@node Caché del sistema de archivos paralelo para archivos de bytecode compilados,La compilación de depuración usa la misma ABI que la compilación de lanzamiento,Parámetros solo posicionales,Nuevas características<9>
@anchor{whatsnew/3 8 parallel-filesystem-cache-for-compiled-bytecode-files}@anchor{a34}
@subsubsection Caché del sistema de archivos paralelo para archivos de bytecode compilados


La nueva configuración 
@geindex PYTHONPYCACHEPREFIX
@geindex variables de entorno; PYTHONPYCACHEPREFIX
@ref{a35,,PYTHONPYCACHEPREFIX} (también disponible mediante la opción @ref{2e2,,-X} @code{pycache_prefix}) configura la caché implícita de bytecode para que use un árbol del sistema de archivos paralelo separado, en lugar de los subdirectorios @code{__pycache__} predeterminados dentro cada directorio de origen.

La ubicación de la caché se define en @ref{a36,,sys.pycache_prefix} (@ref{716,,None} indica la ubicación predeterminada en los subdirectorios @code{__pycache__}).

(Contribución de Carl Meyer en bpo-33499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33499}.)

@node La compilación de depuración usa la misma ABI que la compilación de lanzamiento,los f-strings soportan = para expresiones autodocumentadas y depuración,Caché del sistema de archivos paralelo para archivos de bytecode compilados,Nuevas características<9>
@anchor{whatsnew/3 8 debug-build-uses-the-same-abi-as-release-build}@anchor{a37}
@subsubsection La compilación de depuración usa la misma ABI que la compilación de lanzamiento


Python ahora usa la misma ABI, independientemente de que esté compilado en modo de lanzamiento o de depuración. En Unix, cuando Python se compila en modo de depuración, ahora es posible cargar extensiones C compiladas en modo de lanzamiento y extensiones C compiladas usando la ABI estable.

Las versiones de versiones y @ref{357,,debug builds} ahora son compatibles con ABI: definir la macro @code{Py_DEBUG} ya no implica la macro @code{Py_TRACE_REFS}, que presenta la única incompatibilidad ABI. La macro @code{Py_TRACE_REFS}, que agrega la función @ref{1b5,,sys.getobjects()} y la variable de entorno 
@geindex PYTHONDUMPREFS
@geindex variables de entorno; PYTHONDUMPREFS
@ref{a38,,PYTHONDUMPREFS}, se puede configurar utilizando la nueva opción de compilación @ref{487,,./configure --with-trace-refs}. (Contribuido por Victor Stinner en bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}.)

En Unix, las extensiones en C ya no están enlazadas a libpython, excepto en Android y Cygwin. Ahora es posible que un intérprete Python enlazado estáticamente cargue una extensión de C creada con una biblioteca dinámica de Python. (Contribución de Victor Stinner en bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}.)

En Unix, cuando Python se compila en modo de depuración, la importación ahora también busca extensiones C compiladas en modo de lanzamiento y extensiones C compiladas con la ABI estable. (Contribución de Victor Stinner en bpo-36722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36722}.)

Para integrar Python en una aplicación, se debe pasar una nueva opción @code{--embed} a @code{python3-config --libs --embed} para obtener @code{-lpython3.8} (enlaza la aplicación a libpython ). Para ser compatible con 3.8 y versiones anteriores, prueba primero con @code{python3-config --libs --embed} y vuelve a usar @code{python3-config --libs} (sin @code{--embed}) si falla el comando anterior.

Agrega un módulo pkg-config @code{python-3.8-embed} para integrar Python en una aplicación: @code{pkg-config python-3.8-embed --libs} incluye @code{-lpython3.8}. Para que sea compatible con 3.8 y versiones anteriores, primero intenta usar @code{pkg-config python-X.Y-embed --libs} y vuelve a @code{pkg-config python-X.Y --libs} (sin @code{--embed}) si el comando anterior falla (reemplaza @code{XY} con la versión de Python).

Por otro lado, @code{pkg-config python3.8 --libs} ya no contiene @code{-lpython3.8}. Las extensiones en C no deben estar enlazadas a libpython (excepto en Android y Cygwin, cuyos casos son manejados por el script); este cambio no es retrocompatible a propósito. (Contribución de Victor Stinner en bpo-36721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36721}.)

@node los f-strings soportan = para expresiones autodocumentadas y depuración,PEP 578 Ganchos de auditoría en tiempo de ejecución de Python,La compilación de depuración usa la misma ABI que la compilación de lanzamiento,Nuevas características<9>
@anchor{whatsnew/3 8 bpo-36817-whatsnew}@anchor{a39}@anchor{whatsnew/3 8 f-strings-support-for-self-documenting-expressions-and-debugging}@anchor{a3a}
@subsubsection los f-strings soportan @code{=} para expresiones autodocumentadas y depuración


Se ha agregado un especificador @code{=} a los @ref{4e4,,f-string}s. Un f-string como @code{f'@{expr=@}'} se expandirá al texto de la expresión, seguido de un signo igual y luego la representación de la expresión evaluada. Por ejemplo:

@example
>>> user = 'eric_idle'
>>> member_since = date(1975, 7, 31)
>>> f'@{user=@} @{member_since=@}'
"user='eric_idle' member_since=datetime.date(1975, 7, 31)"
@end example

Los @ref{a3b,,especificadores de formato de los f-string} usuales permiten un mayor control sobre como se muestra el resultado de la expresión:

@example
>>> delta = date.today() - member_since
>>> f'@{user=!s@}  @{delta.days=:,d@}'
'user=eric_idle  delta.days=16,075'
@end example

El especificador @code{=} mostrará la expresión completa para que se puedan mostrar los cálculos:

@example
>>> print(f'@{theta=@}  @{cos(radians(theta))=:.3f@}')
theta=30  cos(radians(theta))=0.866
@end example

(Contribución de Eric V. Smith y Larry Hastings en bpo-36817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36817}.)

@node PEP 578 Ganchos de auditoría en tiempo de ejecución de Python,PEP 587 Configuración de inicialización de Python,los f-strings soportan = para expresiones autodocumentadas y depuración,Nuevas características<9>
@anchor{whatsnew/3 8 pep-578-python-runtime-audit-hooks}@anchor{a3c}
@subsubsection PEP 578: Ganchos de auditoría en tiempo de ejecución de Python


Este PEP agrega un gancho de auditoría y un gancho abierto verificado. Ambos están disponibles desde Python y desde el código nativo, lo que permite que las aplicaciones y los frameworks escritos en código Python puro aprovechen las notificaciones adicionales, al tiempo que permiten a los integradores o administradores de sistemas implementar compilaciones de Python donde la auditoría siempre está habilitada.

Consultar 
@geindex Python Enhancement Proposals; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para obtener más detalles.

@node PEP 587 Configuración de inicialización de Python,PEP 590 Vectorcall un protocolo de llamada rápida para CPython,PEP 578 Ganchos de auditoría en tiempo de ejecución de Python,Nuevas características<9>
@anchor{whatsnew/3 8 pep-587-python-initialization-configuration}@anchor{a3d}
@subsubsection PEP 587: Configuración de inicialización de Python


El 
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} agrega una nueva API de C para configurar la inicialización de Python, proporcionando un control más preciso de toda la configuración y mejores informes de errores.

Nuevas estructuras:


@itemize *

@item 
@ref{499,,PyConfig}

@item 
@ref{a3e,,PyPreConfig}

@item 
@ref{a3f,,PyStatus}

@item 
@ref{a40,,PyWideStringList}
@end itemize

Nuevas funciones:


@itemize *

@item 
@ref{a41,,PyConfig_Clear()}

@item 
@ref{a42,,PyConfig_InitIsolatedConfig()}

@item 
@ref{a43,,PyConfig_InitPythonConfig()}

@item 
@ref{829,,PyConfig_Read()}

@item 
@ref{a44,,PyConfig_SetArgv()}

@item 
@ref{a45,,PyConfig_SetBytesArgv()}

@item 
@ref{a46,,PyConfig_SetBytesString()}

@item 
@ref{a47,,PyConfig_SetString()}

@item 
@ref{a48,,PyPreConfig_InitIsolatedConfig()}

@item 
@ref{a49,,PyPreConfig_InitPythonConfig()}

@item 
@ref{a4a,,PyStatus_Error()}

@item 
@ref{a4b,,PyStatus_Exception()}

@item 
@ref{a4c,,PyStatus_Exit()}

@item 
@ref{a4d,,PyStatus_IsError()}

@item 
@ref{a4e,,PyStatus_IsExit()}

@item 
@ref{a4f,,PyStatus_NoMemory()}

@item 
@ref{a50,,PyStatus_Ok()}

@item 
@ref{a51,,PyWideStringList_Append()}

@item 
@ref{a52,,PyWideStringList_Insert()}

@item 
@ref{a53,,Py_BytesMain()}

@item 
@ref{a54,,Py_ExitStatusException()}

@item 
@ref{4a6,,Py_InitializeFromConfig()}

@item 
@ref{4cc,,Py_PreInitialize()}

@item 
@ref{a55,,Py_PreInitializeFromArgs()}

@item 
@ref{a56,,Py_PreInitializeFromBytesArgs()}

@item 
@ref{a57,,Py_RunMain()}
@end itemize

Este PEP también agrega los campos @code{_PyRuntimeState.preconfig} (tipo @ref{a3e,,PyPreConfig}) y @code{PyInterpreterState.config} (tipo @ref{499,,PyConfig}) a estas estructuras internas. @code{PyInterpreterState.config} se convierte en la nueva configuración de referencia, reemplazando las variables de configuración globales y otras variables privadas.

Consultar @ref{49a,,Configuración de inicialización de Python} para la documentación.

Consultar 
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} para obtener una descripción completa.

(Contribución de Victor Stinner en bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}.)

@node PEP 590 Vectorcall un protocolo de llamada rápida para CPython,Protocolo 5 de Pickle con búferes de datos fuera de banda,PEP 587 Configuración de inicialización de Python,Nuevas características<9>
@anchor{whatsnew/3 8 pep-590-vectorcall-a-fast-calling-protocol-for-cpython}@anchor{a58}
@subsubsection PEP 590: Vectorcall: un protocolo de llamada rápida para CPython


@ref{5f5,,El protocolo vectorcall} se agrega a la API de Python / C. Está destinado a formalizar las optimizaciones existentes que ya se realizaron para varias clases. Cualquier @ref{819,,static type} que implemente un invocable puede utilizar este protocolo.

Actualmente es provisional. El objetivo es hacerlo completamente público en Python 3.9.

Consultar 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} para obtener una descripción completa.

(Contribución de Jeroen Demeyer, Mark Shannon y Petr Viktorin en bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}.)

@node Protocolo 5 de Pickle con búferes de datos fuera de banda,,PEP 590 Vectorcall un protocolo de llamada rápida para CPython,Nuevas características<9>
@anchor{whatsnew/3 8 pickle-protocol-5-with-out-of-band-data-buffers}@anchor{a59}
@subsubsection Protocolo 5 de Pickle con búferes de datos fuera de banda


Cuando @ref{a6,,pickle} se usa para transferir grandes cantidades de datos entre procesos de Python, con la finalidad de aprovechar el procesamiento de múltiples núcleos o máquinas, es importante optimizar la transferencia reduciendo las copias en memoria y posiblemente aplicando técnicas personalizadas, como la compresión dependiente de datos.

El protocolo 5 de @ref{a6,,pickle} introduce soporte para búferes fuera de banda, donde los datos compatibles con 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} se pueden transmitir separados del flujo principal de pickle, a discreción de la capa de comunicación.

Consultar 
@geindex Python Enhancement Proposals; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} para obtener una descripción completa.

(Contribución de Antoine Pitrou en bpo-36785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36785}.)

@node Otros cambios en el lenguaje,Nuevos módulos<4>,Nuevas características<9>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 other-language-changes}@anchor{a5a}
@subsection Otros cambios en el lenguaje



@itemize *

@item 
La declaración @ref{a5b,,continue} era ilegal en la cláusula @ref{a5c,,finally} debido a un problema con la implementación. En Python 3.8 se ha eliminado esta restricción. (Contribución de Serhiy Storchaka en bpo-32489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32489}.)

@item 
Los tipos @ref{513,,bool}, @ref{1f0,,int} y @ref{177,,fractions.Fraction} ahora tienen un método @ref{a5d,,as_integer_ratio()} como el que se encuentra en @ref{153,,float} y @ref{16a,,decimal.Decimal}. Esta extensión menor de la API hace posible escribir @code{numerator, denominator = x.as_integer_ratio()} y hacer que funcione con múltiples tipos numéricos. (Contribución de Lisa Roach en bpo-33073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33073} y de Raymond Hettinger en bpo-37819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37819}.)

@item 
Los constructores de @ref{1f0,,int}, @ref{153,,float} y @ref{154,,complex} ahora usarán el método especial @code{__index__()}, si está disponible y el método correspondiente @ref{22a,,__int__()}, @ref{a5e,,__float__()} o @ref{687,,__complex__()} no está disponible. (Contribución de Serhiy Storchaka en bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}.)

@item 
Agregado soporte para escapes @code{\N@{@var{name}@}} en @ref{b9,,expresiones regulares}:

@example
>>> notice = 'Copyright © 2019'
>>> copyright_year_pattern = re.compile(r'\N@{copyright sign@}\s*(\d@{4@})')
>>> int(copyright_year_pattern.search(notice).group(1))
2019
@end example

(Contribución de Jonathan Eunice y Serhiy Storchaka in bpo-30688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30688}.)

@item 
Los diccionarios y sus vistas ahora se pueden iterar en orden inverso de inserción usando @ref{8fc,,reversed()}. (Contribución de Rémi Lapeyre en bpo-33462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33462}.)

@item 
La sintaxis permitida para los nombres por palabra clave en las llamadas a funciones se ha restringido aún más. En particular, @code{f((keyword)=arg)} ya no está permitido. Nunca se tuvo intención de permitir algo más que un simple nombre en el lado izquierdo de un término de asignación de argumento por palabra clave. (Contribución de Benjamin Peterson en bpo-34641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34641}.)

@item 
El desempaquetado de iterables generalizado en declaraciones @ref{a5f,,yield} y @ref{a60,,return} ya no requiere ser encerrado entre paréntesis. Esto hace que la sintaxis de `yield' y `return' se asemeje más a la sintaxis normal de asignación:

@example
>>> def parse(family):
...     lastname, *members = family.split()
...     return lastname.upper(), *members
...
>>> parse('simpsons homer marge bart lisa maggie')
('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'maggie')
@end example

(Contribución de David Cuthbert y Jordan Chapman en bpo-32117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32117}.)

@item 
Cuando falta una coma en el código, como en @code{[(10, 20) (30, 40)]}, el compilador muestra un @ref{511,,SyntaxWarning} con una sugerencia útil. Esto representa una mejora con respecto a la implementación previa en la que solo se mostraba un @ref{228,,TypeError} indicando que la primera tupla no era invocable. (Contribución de Serhiy Storchaka en bpo-15248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15248}.)

@item 
Las operaciones aritméticas entre subclases de @ref{330,,datetime.date} o @ref{32f,,datetime.datetime} y @ref{a61,,datetime.timedelta} ahora retornan una instancia de la subclase, en lugar de la clase base. Esto también afecta al tipo de retorno de las operaciones cuya implementación (directa o indirectamente) usa la aritmética de @ref{a61,,datetime.timedelta}, como @ref{a62,,astimezone()}. (Contribución de Paul Ganssle en bpo-32417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32417}.)

@item 
Cuando el intérprete de Python es interrumpido por Ctrl-C (SIGINT) y la excepción @ref{a63,,KeyboardInterrupt} resultante no se detecta, el proceso de Python ahora termina su ejecución a través de una señal SIGINT o con el código de salida correcto, de modo que el proceso que lo invocó puede detectar que murió debido a Ctrl-C. Los shells en POSIX y Windows usan esto para terminar la ejecución de los scripts en sesiones interactivas de forma correcta. (Contribución de Google a través de Gregory P. Smith en bpo-1054041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1054041}.)

@item 
Algunos estilos de programación avanzados requieren actualizar el objeto @ref{1d8,,types.CodeType} para una función ya existente. Dado que los objetos de código son inmutables, es necesario crear un nuevo objeto de código, que sea modelado a partir del objeto de código existente. Con 19 parámetros, esto era algo tedioso. Ahora, el nuevo método @code{replace()} hace posible crear un clon con algunos parámetros alterados.

Aquí hay un ejemplo que modifica la función @ref{772,,statistics.mean()} para evitar que el parámetro `data' se use como un argumento por palabra clave:

@example
>>> from statistics import mean
>>> mean(data=[10, 20, 90])
40
>>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
>>> mean(data=[10, 20, 90])
Traceback (most recent call last):
  ...
TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'
@end example

(Contribución de Victor Stinner en bpo-37032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37032}.)

@item 
Para enteros, la forma de tres argumentos de la función @ref{a64,,pow()} ahora permite que el exponente sea negativo en el caso de que la base y el módulo sean primos relativos (coprimos). Luego calcula un inverso modular a la base cuando el exponente es @code{-1} y una potencia adecuada de ese inverso en el caso de otros exponentes negativos. Por ejemplo, para calcular el inverso multiplicativo@footnote{https://es.wikipedia.org/wiki/Inverso_multiplicativo_(aritm%C3%A9tica_modular)} de 38 módulo 137, escribe:

@example
>>> pow(38, -1, 137)
119
>>> 119 * 38 % 137
1
@end example

Los inversos modulares surgen de la solución de ecuaciones diofánticas lineales@footnote{https://es.wikipedia.org/wiki/Ecuaci%C3%B3n_diof%C3%A1ntica}. Por ejemplo, para encontrar soluciones enteras para @code{4258𝑥 + 147𝑦 = 369}, primero debes reescribirla como @code{4258𝑥 ≡ 369 (mod 147)} y luego resolver:

@example
>>> x = 369 * pow(4258, -1, 147) % 147
>>> y = (4258 * x - 369) // -147
>>> 4258 * x + 147 * y
369
@end example

(Contribución de Mark Dickinson en bpo-36027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36027}.)

@item 
Las compresiones de diccionarios se han sincronizado con los literales de diccionario para que primero se calcule la clave y posteriormente el valor:

@example
>>> # Dict comprehension
>>> cast = @{input('role? '): input('actor? ') for i in range(2)@}
role? King Arthur
actor? Chapman
role? Black Knight
actor? Cleese

>>> # Dict literal
>>> cast = @{input('role? '): input('actor? ')@}
role? Sir Robin
actor? Eric Idle
@end example

Este orden de ejecución garantizado es especialmente útil en las expresiones de asignación porque las variables asignadas en la expresión de la clave estarán disponibles en la expresión del valor:

@example
>>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
>>> @{(n := normalize('NFC', name)).casefold() : n for name in names@}
@{'martin von löwis': 'Martin von Löwis',
 'łukasz langa': 'Łukasz Langa',
 'walter dörwald': 'Walter Dörwald'@}
@end example

(Contribución de Jörn Heissler en bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)

@item 
El método @ref{a65,,object.__reduce__()} ahora puede retornar una tupla con una longitud que va desde los dos a los seis elementos. Anteriormente, el límite era cinco. El nuevo sexto elemento opcional es un invocable con una firma @code{(obj, state)}. Esto permite el control directo sobre el comportamiento de actualización de estado de un objeto específico. Si no es `None', este invocable tendrá prioridad sobre el método @code{__setstate__()} del objeto. (Contribución de Pierre Glaser y Olivier Grisel en bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}.)
@end itemize

@node Nuevos módulos<4>,Módulos mejorados<5>,Otros cambios en el lenguaje,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 new-modules}@anchor{a66}
@subsection Nuevos módulos



@itemize *

@item 
El nuevo módulo @ref{7a,,importlib.metadata} proporciona soporte (provisional) para leer metadatos de paquetes de terceros. Por ejemplo, puede extraer el número de versión de un paquete instalado, la lista de puntos de entrada y más:

@example
>>> # Note following example requires that the popular "requests"
>>> # package has been installed.
>>>
>>> from importlib.metadata import version, requires, files
>>> version('requests')
'2.22.0'
>>> list(requires('requests'))
['chardet (<3.1.0,>=3.0.2)']
>>> list(files('requests'))[:5]
[PackagePath('requests-2.22.0.dist-info/INSTALLER'),
 PackagePath('requests-2.22.0.dist-info/LICENSE'),
 PackagePath('requests-2.22.0.dist-info/METADATA'),
 PackagePath('requests-2.22.0.dist-info/RECORD'),
 PackagePath('requests-2.22.0.dist-info/WHEEL')]
@end example

(Contribución de Barry Warsaw y Jason R. Coombs en bpo-34632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34632}.)
@end itemize

@node Módulos mejorados<5>,Optimizaciones<5>,Nuevos módulos<4>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 improved-modules}@anchor{a67}
@subsection Módulos mejorados


@menu
* ast: ast<5>. 
* asyncio: asyncio<6>. 
* builtins: builtins<2>. 
* collections:: 
* cProfile:: 
* csv: csv<2>. 
* curses:: 
* ctypes: ctypes<3>. 
* datetime: datetime<2>. 
* functools: functools<2>. 
* gc:: 
* gettext:: 
* gzip: gzip<3>. 
* IDLE e idlelib: IDLE e idlelib<3>. 
* inspect: inspect<3>. 
* io: io<4>. 
* itertools: itertools<5>. 
* json.tool: json tool. 
* logging:: 
* math: math<3>. 
* mmap: mmap<2>. 
* multiprocessing: multiprocessing<3>. 
* os: os<6>. 
* os.path: os path<4>. 
* pathlib: pathlib<6>. 
* pickle: pickle<2>. 
* plistlib:: 
* pprint: pprint<3>. 
* py_compile: py_compile<2>. 
* shlex:: 
* shutil: shutil<3>. 
* socket:: 
* ssl: ssl<4>. 
* statistics: statistics<3>. 
* sys: sys<6>. 
* tarfile: tarfile<4>. 
* threading: threading<2>. 
* tokenize: tokenize<2>. 
* tkinter: tkinter<4>. 
* time: time<2>. 
* typing: typing<5>. 
* unicodedata: unicodedata<6>. 
* unittest: unittest<5>. 
* venv: venv<4>. 
* weakref:: 
* xml: xml<4>. 
* xmlrpc:: 

@end menu

@node ast<5>,asyncio<6>,,Módulos mejorados<5>
@anchor{whatsnew/3 8 ast}@anchor{a68}
@subsubsection ast


Los nodos de AST ahora disponen de los atributos @code{end_lineno} y @code{end_col_offset}, que proporcionan la localización precisa del final del nodo. (Esto solo se aplica a los nodos que tienen los atributos @code{lineno} y @code{col_offset}.)

La nueva función @ref{a69,,ast.get_source_segment()} retorna el código fuente de un nodo AST específico.

(Contribución de Ivan Levkivskyi en bpo-33416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33416}.)

La función @ref{30f,,ast.parse()} tiene algunos flags nuevos:


@itemize *

@item 
@code{type_comments=True} causa que la función retorne el texto de los comentarios de tipo especificados en 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} y 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} asociados con ciertos nodos AST;

@item 
@code{mode='func_type'} puede usarse para realizar un análisis sintáctico de los «comentarios de tipo de firma» de 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} (retornados por los nodos AST de definición de funciones);

@item 
@code{feature_version=(3, N)} permite especificar una versión de Python 3 previa. Por ejemplo, @code{feature_version=(3, 4)} hará que se trate a @ref{7ce,,async} y @ref{14e,,await} como palabras no reservadas.
@end itemize

(Contribución de Guido van Rossum en bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}.)

@node asyncio<6>,builtins<2>,ast<5>,Módulos mejorados<5>
@anchor{whatsnew/3 8 asyncio}@anchor{a6a}
@subsubsection asyncio


@ref{525,,asyncio.run()} ha pasado de la API provisional a la estable. Esta función se puede utilizar para ejecutar una @ref{53a,,coroutine} y retornar el resultado mientras se gestiona automáticamente el bucle de eventos. Por ejemplo:

@example
import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

asyncio.run(main())
@end example

Esto es `aproximadamente' equivalente a:

@example
import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
    loop.run_until_complete(main())
finally:
    asyncio.set_event_loop(None)
    loop.close()
@end example

La implementación real es significativamente más compleja. Por lo tanto, @ref{525,,asyncio.run()} debería ser la forma preferida de ejecutar programas asyncio.

(Contribución de Yury Selivanov en bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}.)

La ejecución de @code{python -m asyncio} lanza un REPL asincrónico de forma nativa. Esto permite una rápida experimentación con código que tiene un nivel @ref{14e,,await} superior. Ya no es necesario llamar directamente a @code{asyncio.run()}, lo que generaría un nuevo ciclo de eventos en cada invocación:

@example
$ python -m asyncio
asyncio REPL 3.8.0
Use "await" directly instead of "asyncio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import asyncio
>>> await asyncio.sleep(10, result='hello')
hello
@end example

(Contribución de Yury Selivanov en bpo-37028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37028}.)

La excepción @ref{31f,,asyncio.CancelledError} ahora hereda de @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception} y ya no hereda de @ref{a6c,,concurrent.futures.CancelledError}. (Contribuido por Yury Selivanov en bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}.)

En Windows, el ciclo de eventos predeterminado ahora es @ref{6aa,,ProactorEventLoop}. (Contribución de Victor Stinner en bpo-34687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34687}.)

@ref{6aa,,ProactorEventLoop} ahora también es compatible con UDP. (Contribución de Adam Meily y Andrew Svetlov en bpo-29883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29883}.)

@ref{6aa,,ProactorEventLoop} ahora puede ser interrumpido por @ref{a63,,KeyboardInterrupt} («CTRL+C»). (Contribución de Vladimir Matveev en bpo-23057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23057}.)

Se ha agregado @ref{a6d,,asyncio.Task.get_coro()} para obtener la corrutina envuelta dentro de @ref{580,,asyncio.Task}. (Contribución de Alex Grönholm en bpo-36999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36999}.)

Las tareas de Asyncio ahora se pueden nombrar, ya sea pasando el argumento por palabra clave @code{name} a @ref{69d,,asyncio.create_task()} o al método @ref{a6e,,create_task()} del bucle de eventos, o invocando al método @ref{a6f,,set_name()} en el objeto de tarea. El nombre de la tarea es visible en la salida de @code{repr()} de @ref{580,,asyncio.Task} y también se puede recuperar usando el método @ref{a70,,get_name()}. (Contribución de Alex Grönholm en bpo-34270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34270}.)

Se agregó soporte para Happy Eyeballs@footnote{https://en.wikipedia.org/wiki/Happy_Eyeballs} a @ref{6a4,,asyncio.loop.create_connection()}. Para especificar el comportamiento, se han agregado dos nuevos parámetros: `happy_eyeballs_delay' e `interleave'. El algoritmo Happy Eyeballs mejora la capacidad de respuesta en aplicaciones que admiten IPv4 e IPv6 al intentar conectarse simultáneamente utilizando ambos. (Contribución de twisteroid ambassador en bpo-33530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33530}.)

@node builtins<2>,collections,asyncio<6>,Módulos mejorados<5>
@anchor{whatsnew/3 8 builtins}@anchor{a71}
@subsubsection builtins


La función incorporada @ref{2fb,,compile()} se ha mejorado para que acepte el flag @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT}. Si se pasa este nuevo flag, @ref{2fb,,compile()} permitirá construcciones de nivel superior @code{await}, @code{async for} y @code{async with}, que normalmente se consideran sintaxis inválida. El objeto de código asíncrono marcado con el flag @code{CO_COROUTINE} puede ser retornado. (Contribución de Matthias Bussonnier en bpo-34616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34616}.)

@node collections,cProfile,builtins<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 collections}@anchor{a72}
@subsubsection collections


El método @ref{a73,,_asdict()} para @ref{32d,,collections.namedtuple()} ahora retorna una instancia de @ref{190,,dict} en lugar de una de @ref{67c,,collections.OrderedDict}. Esto funciona porque se garantiza que los diccionarios regulares mantienen el orden de inserción desde Python 3.7. Si se requieren las características adicionales de @code{OrderedDict}, la solución sugerida es realizar una conversión del resultado al tipo deseado: @code{OrderedDict(nt._asdict())}. (Contribución de Raymond Hettinger en bpo-35864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35864}.)

@node cProfile,csv<2>,collections,Módulos mejorados<5>
@anchor{whatsnew/3 8 cprofile}@anchor{a74}
@subsubsection cProfile


La clase @ref{a75,,cProfile.Profile} ahora puede usarse como gestor de contexto. Ahora se puede perfilar un bloque de código ejecutando:

@example
import cProfile

with cProfile.Profile() as profiler:
      # code to be profiled
      ...
@end example

(Contribución de Scott Sanderson en bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}.)

@node csv<2>,curses,cProfile,Módulos mejorados<5>
@anchor{whatsnew/3 8 csv}@anchor{a76}
@subsubsection csv


@ref{a77,,csv.DictReader} ahora retorna instancias de @ref{190,,dict} en lugar de @ref{67c,,collections.OrderedDict}. La herramienta ahora es más rápida y usa menos memoria, mientras conserva el orden de los campos. (Contribución de Michael Selik en bpo-34003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34003}.)

@node curses,ctypes<3>,csv<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 curses}@anchor{a78}
@subsubsection curses


Se agregó una nueva variable que contiene información de versión estructurada para la biblioteca ncurses subyacente: @ref{a79,,ncurses_version}. (Contribución de Serhiy Storchaka en bpo-31680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31680}.)

@node ctypes<3>,datetime<2>,curses,Módulos mejorados<5>
@anchor{whatsnew/3 8 ctypes}@anchor{a7a}
@subsubsection ctypes


En Windows, @ref{a7b,,CDLL} y sus subclases ahora aceptan un parámetro `winmode' para especificar flags para la invocación subyacente de @code{LoadLibraryEx}. Los flags predeterminados están establecidos para cargar solo las dependencias de DLL desde ubicaciones confiables, incluida la ruta donde se almacena la DLL (si se usa una ruta completa o parcial para cargar la DLL inicial) y las rutas agregadas por @ref{a7c,,add_dll_directory()} . (Contribución de Steve Dower en bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

@node datetime<2>,functools<2>,ctypes<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 datetime}@anchor{a7d}
@subsubsection datetime


Added new alternate constructors @ref{a7e,,datetime.date.fromisocalendar()} and
@ref{a7f,,datetime.datetime.fromisocalendar()}, which construct @ref{330,,date} and
@ref{32f,,datetime} objects respectively from ISO year, week number, and weekday;
these are the inverse of each class’s @code{isocalendar} method.
(Contributed by Paul Ganssle in bpo-36004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36004}.)

@node functools<2>,gc,datetime<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 functools}@anchor{a80}
@subsubsection functools


@ref{a81,,functools.lru_cache()} ahora se puede usar como un decorador directo en lugar de como una función que retorna un decorador. De forma que ambos son compatibles ahora:

@example
@@lru_cache
def f(x):
    ...

@@lru_cache(maxsize=256)
def f(x):
    ...
@end example

(Contribución de Raymond Hettinger en bpo-36772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36772}.)

Se ha agregado un nuevo decorador @ref{5e4,,functools.cached_property()}, para propiedades calculadas almacenadas en caché durante toda la vida útil de la instancia.

@example
import functools
import statistics

class Dataset:
   def __init__(self, sequence_of_numbers):
      self.data = sequence_of_numbers

   @@functools.cached_property
   def variance(self):
      return statistics.variance(self.data)
@end example

(Contribución de Carl Meyer en bpo-21145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21145}.)

Se ha agregado un nuevo decorador @ref{a82,,functools.singledispatchmethod()} que convierte métodos en @ref{a83,,funciones genéricas} usando @ref{a84,,single dispatch}:

@example
from functools import singledispatchmethod
from contextlib import suppress

class TaskManager:

    def __init__(self, tasks):
        self.tasks = list(tasks)

    @@singledispatchmethod
    def discard(self, value):
        with suppress(ValueError):
            self.tasks.remove(value)

    @@discard.register(list)
    def _(self, tasks):
        targets = set(tasks)
        self.tasks = [x for x in self.tasks if x not in targets]
@end example

(Contribución de Ethan Smith en bpo-32380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32380})

@node gc,gettext,functools<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 gc}@anchor{a85}
@subsubsection gc


@ref{89a,,get_objects()} ahora puede recibir un parámetro opcional `generation' que indica la generación de la que recolectar objetos. (Contribución de Pablo Galindo en bpo-36016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36016}.)

@node gettext,gzip<3>,gc,Módulos mejorados<5>
@anchor{whatsnew/3 8 gettext}@anchor{a86}
@subsubsection gettext


Agregado @ref{a87,,pgettext()} y sus variantes. (Contribución de Franz Glasner, Éric Araujo y Cheryl Sabella en bpo-2504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2504}.)

@node gzip<3>,IDLE e idlelib<3>,gettext,Módulos mejorados<5>
@anchor{whatsnew/3 8 gzip}@anchor{a88}
@subsubsection gzip


Se ha agregó el parámetro `mtime' a @ref{6df,,gzip.compress()} para una salida reproducible. (Contribución de Guo Ci Teo en bpo-34898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34898}.)

Una excepción @ref{a89,,BadGzipFile} es lanzada ahora, en lugar de @ref{4d5,,OSError}, para ciertos tipos de archivos gzip no válidos o corruptos. (Contribución de Filip Gruszczyński, Michele Orrù y Zackery Spytz en bpo-6584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6584}.)

@node IDLE e idlelib<3>,inspect<3>,gzip<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 idle-and-idlelib}@anchor{a8a}
@subsubsection IDLE e idlelib


Las salidas superiores a N líneas (50 por defecto) se pliegan en un botón. N se puede cambiar en la sección PyShell de la página General del cuadro de diálogo Settings. Se pueden plegar menos líneas, pero posiblemente más largas, haciendo clic derecho en la salida. La salida plegada se puede expandir en su lugar haciendo doble clic en el botón o en el portapapeles o en una ventana separada haciendo clic derecho en el botón. (Contribución de Tal Einat en bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

Se ha agregado «Run Customized» al menú Run para ejecutar un módulo con configuraciones personalizadas. Cualquier argumento de la línea de comandos ingresado se agrega a sys.argv. Además, vuelven a aparecer en el cuadro para la próxima ejecución personalizada. También se puede suprimir el reinicio normal del módulo principal de la Shell. (Contribución de Cheryl Sabella, Terry Jan Reedy y otros en bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} y bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}.)

Se agregaron números de línea opcionales para las ventanas del editor IDLE. Las ventanas se abren sin números de línea, a menos que se establezca lo contrario en la pestaña General del cuadro de diálogo de configuración. Los números de línea de una ventana existente se muestran y ocultan en el menú Options. (Contribución de Tal Einat y Saimadhav Heblikar en bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}.)

La codificación nativa del sistema operativo ahora se usa para convertir entre cadenas de Python y objetos Tcl. Esto permite que el IDLE funcione con emoji y otros caracteres que no son BMP. Estos caracteres se pueden mostrar o copiar y pegar en ,o desde, el portapapeles. Convertir cadenas de Tcl a Python y viceversa ahora nunca falla. (Mucha gente trabajó en esto durante ocho años, pero el problema finalmente lo resolvió Serhiy Storchaka en bpo-13153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13153}.)

Nuevo en 3.8.1:

Agregue la opción para desactivar el parpadeo del cursor. (Contribuido por Zackery Spytz en bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603}.)

La tecla Escape ahora cierra las ventanas de finalización IDLE. (Contribuido por Johnny Najera en bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}.)

Los cambios anteriores se han portado a las versiones de mantenimiento de Python 3.7.

Agrega palabras clave a la lista de finalización del nombre del módulo. (Contribución de Terry J. Reedy en bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}.)

@node inspect<3>,io<4>,IDLE e idlelib<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 inspect}@anchor{a8b}
@subsubsection inspect


La función @ref{a8c,,inspect.getdoc()} puede ahora encontrar cadenas de documentación para @code{__slots__} si el este atributo es un @ref{190,,dict} cuyos valores son las cadenas de documentación. Esto proporciona opciones de documentación similares a las que ya tenemos para @ref{2fd,,property()}, @ref{2d2,,classmethod()} y @ref{22e,,staticmethod()}:

@example
class AudioClip:
    __slots__ = @{'bit_rate': 'expressed in kilohertz to one decimal place',
                 'duration': 'in seconds, rounded up to an integer'@}
    def __init__(self, bit_rate, duration):
        self.bit_rate = round(bit_rate / 1000.0, 1)
        self.duration = ceil(duration)
@end example

(Contribución de Raymond Hettinger en bpo-36326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36326}.)

@node io<4>,itertools<5>,inspect<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 io}@anchor{a8d}
@subsubsection io


En el modo de desarrollo (@ref{2e2,,-X} @code{env}) y en @ref{357,,debug build}, el finalizador @ref{353,,io.IOBase} ahora registra la excepción si falla el método @code{close()}. La excepción se ignora de forma silenciosa de forma predeterminada en la versión de la versión. (Contribuido por Victor Stinner en bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}.)

@node itertools<5>,json tool,io<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 itertools}@anchor{a8e}
@subsubsection itertools


Se ha agregado un argumento por palabra clave opcional `initial' a la función @ref{a8f,,itertools.accumulate()} para permitir especificar un valor inicial:

@example
>>> from itertools import accumulate
>>> list(accumulate([10, 5, 30, 15], initial=1000))
[1000, 1010, 1015, 1045, 1060]
@end example

(Contribución de Lisa Roach en bpo-34659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34659}.)

@node json tool,logging,itertools<5>,Módulos mejorados<5>
@anchor{whatsnew/3 8 json-tool}@anchor{a90}
@subsubsection json.tool


Agregadas las opciones @code{--json-lines} para analizar sintácticamente cada línea de entrada como un objeto JSON separado. (Contribución de Weipeng Hong en bpo-31553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31553}.)

@node logging,math<3>,json tool,Módulos mejorados<5>
@anchor{whatsnew/3 8 logging}@anchor{a91}
@subsubsection logging


Added a `force' keyword argument to @ref{a92,,logging.basicConfig()}.
When set to true, any existing handlers attached
to the root logger are removed and closed before carrying out the
configuration specified by the other arguments.

Esto resuelve un problema de larga data. Una vez que se había invocado a un registrador o a `basicConfig()', las invocaciones posteriores a `basicConfig()' se ignoraban en silencio. Esto dificultaba la actualización, la experimentación o la instrucción de las diversas opciones de configuración de registro mediante el interprete interactivo o el bloc de notas de Jupyter.

(Sugerencia de Raymond Hettinger, implementación de Dong-hee Na y revisión de Vinay Sajip en bpo-33897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33897}.)

@node math<3>,mmap<2>,logging,Módulos mejorados<5>
@anchor{whatsnew/3 8 math}@anchor{a93}
@subsubsection math


Se ha agregado la nueva función @ref{a94,,math.dist()} para calcular la distancia euclidiana entre dos puntos. (Contribución de Raymond Hettinger en bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}.)

Se ha expandido la función @ref{a95,,math.hypot()} para manejar múltiples dimensiones. Anteriormente, solo admitía dos dimensiones. (Contribución de Raymond Hettinger en bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}.)

Agregada una nueva función, @ref{a96,,math.prod()}, como función análoga a @ref{515,,sum()}, que retorna el producto de todos los elementos de un iterable de números partiendo de un valor de inicio (`start') (por defecto: 1):

@example
>>> prior = 0.8
>>> likelihoods = [0.625, 0.84, 0.30]
>>> math.prod(likelihoods, start=prior)
0.126
@end example

(Contribución de Pablo Galindo en bpo-35606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35606}.)

Agregadas dos nuevas funciones combinatorias, @ref{771,,math.perm()} y @ref{770,,math.comb()}:

@example
>>> math.perm(10, 3)    # Permutations of 10 things taken 3 at a time
720
>>> math.comb(10, 3)    # Combinations of 10 things taken 3 at a time
120
@end example

(Contribución de Yash Aggarwal, Keller Fuchs, Serhiy Storchaka y Raymond Hettinger en bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}, bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178} y bpo-35431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35431}.)

Se ha agregada una nueva función @ref{a97,,math.isqrt()} para calcular raíces cuadradas enteras precisas sin conversión a coma flotante. La nueva función admite números enteros arbitrariamente grandes. Es más rápida que @code{floor(sqrt(n))} pero más lenta que @ref{a98,,math.sqrt()}:

@example
>>> r = 650320427
>>> s = r ** 2
>>> isqrt(s - 1)         # correct
650320426
>>> floor(sqrt(s - 1))   # incorrect
650320427
@end example

(Contribución de Mark Dickinson en bpo-36887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36887}.)

La función @ref{9da,,math.factorial()} ya no acepta argumentos que no sean similares a enteros. (Contribución de Pablo Galindo en bpo-33083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33083}.)

@node mmap<2>,multiprocessing<3>,math<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 mmap}@anchor{a99}
@subsubsection mmap


La clase @ref{368,,mmap.mmap} ahora tiene un método @ref{a9a,,madvise()} para acceder a la llamada al sistema @code{madvise()}. (Contribución de Zackery Spytz en bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941}.)

@node multiprocessing<3>,os<6>,mmap<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 multiprocessing}@anchor{a9b}
@subsubsection multiprocessing


Agregado el nuevo módulo @ref{99,,multiprocessing.shared_memory}. (Contribución de Davin Potts en bpo-35813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35813}.)

En macOS, el método de inicio `spawn' se usa ahora por defecto. (Contribución de Victor Stinner en bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.)

@node os<6>,os path<4>,multiprocessing<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 os}@anchor{a9c}
@subsubsection os


Se agregó una nueva función @ref{a7c,,add_dll_directory()} en Windows para proporcionar rutas de búsqueda adicionales para las dependencias nativas al importar módulos de extensión o al cargar archivos DLL utilizando @ref{2b,,ctypes}. (Contribución de Steve Dower en bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

Se agregó una nueva función @ref{a9d,,os.memfd_create()} para envolver la llamada al sistema @code{memfd_create()}. (Contribución de Zackery Spytz y Christian Heimes en bpo-26836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26836}.)

En Windows, gran parte de la lógica manual para manejar los puntos de reinterpretación (incluidos los enlaces simbólicos y las uniones de directorios) se ha delegado al sistema operativo. Específicamente, @ref{548,,os.stat()} ahora se encargará de todo lo que sea compatible con el sistema operativo, mientras que @ref{549,,os.lstat()} solo abrirá puntos de reinterpretación que se identifican como «sustitutos de nombre» y el resto se abrirán mediante @ref{548,,os.stat()}. En todos los casos, @code{stat_result.st_mode} solo tendrá establecido @code{S_IFLNK} para enlaces simbólicos y no para otros tipos de puntos de reinterpretación. Para identificar otros tipos de puntos de reinterpretación, verifica el nuevo atributo @code{stat_result.st_reparse_tag}.

En Windows, @ref{9b4,,os.readlink()} ahora puede leer uniones de directorio. Ten en cuenta que @ref{a9e,,islink()} retornará @code{False} para las uniones de directorios, por lo que el código que comprueba en primer lugar @code{islink} continuará tratando las uniones como directorios, mientras que el código que maneja los errores de @ref{9b4,,os.readlink()} ahora puede tratar las uniones como enlaces.

(Contribución de Steve Dower en bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node os path<4>,pathlib<6>,os<6>,Módulos mejorados<5>
@anchor{whatsnew/3 8 os-path}@anchor{a9f}
@subsubsection os.path


Las funciones de @ref{a2,,os.path} que retornan un resultado booleano como @ref{aa0,,exists()}, @ref{aa1,,lexists()}, @ref{aa2,,isdir()}, @ref{aa3,,isfile()}, @ref{a9e,,islink()} e @ref{aa4,,ismount()} ahora retornan @code{False} en lugar de lanzar una excepción @ref{360,,ValueError}, o sus subclases @ref{718,,UnicodeEncodeError} y @ref{aa5,,UnicodeDecodeError}, para rutas que contienen caracteres o bytes irrepresentables a nivel del sistema operativo. (Contribución de Serhiy Storchaka en bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}.)

@ref{aa6,,expanduser()} en Windows ahora usa preferentemente la variable de entorno 
@geindex USERPROFILE
@geindex variables de entorno; USERPROFILE
@code{USERPROFILE} y no usa 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME}, que normalmente no está establecido para cuentas de usuario normales. (Contribución de Anthony Sottile en bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}.)

@ref{aa2,,isdir()} en Windows ya no retorna @code{True} para un enlace a un directorio no existente.

@ref{381,,realpath()} en Windows ahora resuelve puntos de reinterpretación (reparse points), incluidos enlaces simbólicos y uniones de directorio.

(Contribución de Steve Dower en bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node pathlib<6>,pickle<2>,os path<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 pathlib}@anchor{aa7}
@subsubsection pathlib


@ref{19b,,pathlib.Path} methods that return a boolean result like
@ref{aa8,,exists()}, @ref{38b,,is_dir()},
@ref{38a,,is_file()}, @ref{aa9,,is_mount()},
@ref{aaa,,is_symlink()}, @ref{aab,,is_block_device()},
@ref{aac,,is_char_device()}, @ref{aad,,is_fifo()},
@ref{aae,,is_socket()} now return @code{False} instead of raising
@ref{360,,ValueError} or its subclass @ref{718,,UnicodeEncodeError} for paths that
contain characters unrepresentable at the OS level.
(Contributed by Serhiy Storchaka in bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}.)

Added @code{pathlib.Path.link_to()} which creates a hard link pointing
to a path.
(Contributed by Joannah Nanjekye in bpo-26978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26978})
Note that @code{link_to} was deprecated in 3.10 and removed in 3.12 in
favor of a @code{hardlink_to} method added in 3.10 which matches the
semantics of the existing @code{symlink_to} method.

@node pickle<2>,plistlib,pathlib<6>,Módulos mejorados<5>
@anchor{whatsnew/3 8 pickle}@anchor{aaf}
@subsubsection pickle


Las extensiones de @ref{a6,,pickle} que subclasifican la clase optimizada de C @ref{ab0,,Pickler} ahora pueden anular la lógica de pickling de funciones y clases definiendo el método especial @ref{ab1,,reducer_override()}. (Contribución de Pierre Glaser y Olivier Grisel en bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}.)

@node plistlib,pprint<3>,pickle<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 plistlib}@anchor{ab2}
@subsubsection plistlib


Se ha agregado la nueva clase @ref{ab3,,plistlib.UID} y se ha habilitado el soporte para leer y escribir plists binarios codificados por NSKeyedArchiver. (Contribución de Jon Janzen en bpo-26707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26707}.)

@node pprint<3>,py_compile<2>,plistlib,Módulos mejorados<5>
@anchor{whatsnew/3 8 pprint}@anchor{ab4}
@subsubsection pprint


Se ha agregado el parámetro `sort_dicts' a varias funciones del módulo @ref{ae,,pprint}. De forma predeterminada, esas funciones continúan ordenando los diccionarios antes de procesarlos o imprimirlos. Sin embargo, si `sort_dicts' se establece en falso, los diccionarios conservan el orden en que se insertaron las claves. Esto puede resultar útil para la comparación con entradas JSON durante la depuración.

Además, hay una nueva función de conveniencia, @ref{ab5,,pprint.pp()}, que es igual que @ref{8bf,,pprint.pprint()} pero con `sort_dicts' establecido en @code{False} por defecto:

@example
>>> from pprint import pprint, pp
>>> d = dict(source='input.txt', operation='filter', destination='output.txt')
>>> pp(d, width=40)                  # Original order
@{'source': 'input.txt',
 'operation': 'filter',
 'destination': 'output.txt'@}
>>> pprint(d, width=40)              # Keys sorted alphabetically
@{'destination': 'output.txt',
 'operation': 'filter',
 'source': 'input.txt'@}
@end example

(Contribución de Rémi Lapeyre en bpo-30670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30670}.)

@node py_compile<2>,shlex,pprint<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 py-compile}@anchor{ab6}
@subsubsection py_compile


@ref{ab7,,py_compile.compile()} ahora admite el modo silencioso. (Contribución de Joannah Nanjekye en bpo-22640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22640}.)

@node shlex,shutil<3>,py_compile<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 shlex}@anchor{ab8}
@subsubsection shlex


La nueva función @ref{ab9,,shlex.join()} actúa a la inversa de @ref{5de,,shlex.split()}. (Contribución de Bo Bayles en bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}.)

@node shutil<3>,socket,shlex,Módulos mejorados<5>
@anchor{whatsnew/3 8 shutil}@anchor{aba}
@subsubsection shutil


@ref{abb,,shutil.copytree()} ahora acepta el nuevo argumento por palabra clave @code{dirs_exist_ok}. (Contribución de Josh Bronson en bpo-20849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20849}.)

@ref{55a,,shutil.make_archive()} ahora usa por defecto el formato pax moderno (POSIX.1-2001) para nuevos archivos para mejorar la portabilidad y la conformidad con los estándares, heredado el cambio correspondiente del módulo @ref{de,,tarfile}. (Contribución de C.A.M. Gerlach en bpo-30661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30661}.)

@ref{1f9,,shutil.rmtree()} en Windows ahora elimina las uniones de directorio sin eliminar recursivamente su contenido primero. (Contribución de Steve Dower en bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node socket,ssl<4>,shutil<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 socket}
@subsubsection socket


Added @ref{abd,,create_server()} and @ref{abe,,has_dualstack_ipv6()}
convenience functions to automate the necessary tasks usually involved when
creating a server socket, including accepting both IPv4 and IPv6 connections
on the same socket.  (Contributed by Giampaolo Rodolà in bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561}.)

The @ref{abf,,socket.if_nameindex()}, @ref{ac0,,socket.if_nametoindex()}, and
@ref{ac1,,socket.if_indextoname()} functions have been implemented on Windows.
(Contributed by Zackery Spytz in bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007}.)

@node ssl<4>,statistics<3>,socket,Módulos mejorados<5>
@anchor{whatsnew/3 8 ssl}@anchor{ac2}
@subsubsection ssl


Se ha agregado @ref{ac3,,post_handshake_auth} para habilitar y @ref{ac4,,verify_client_post_handshake()} para iniciar la autenticación tras el establecimiento de la comunicación en TLS 1.3. (Contribución de Christian Heimes en bpo-34670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34670}.)

@node statistics<3>,sys<6>,ssl<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 statistics}@anchor{ac5}
@subsubsection statistics


Added @ref{ac6,,statistics.fmean()} as a faster, floating-point variant of
@ref{772,,statistics.mean()}.  (Contributed by Raymond Hettinger and
Steven D’Aprano in bpo-35904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35904}.)

Added @ref{ac7,,statistics.geometric_mean()}
(Contributed by Raymond Hettinger in bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}.)

Se ha agregado @ref{ac8,,statistics.multimode()} que retorna una lista con los valores más comunes. (Contribución de Raymond Hettinger en bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892}.)

Se ha agregado @ref{ac9,,statistics.quantiles()} que divide datos o una distribución en intervalos equiprobables (por ejemplo, cuartiles, deciles o percentiles). (Contribución de Raymond Hettinger en bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}.)

Se ha agregado @ref{aca,,statistics.NormalDist}, una herramienta para crear y manipular distribuciones normales de una variable aleatoria. (Contribución de Raymond Hettinger en bpo-36018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36018}.)

@example
>>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
>>> temperature_feb.mean
6.0
>>> temperature_feb.stdev
6.356099432828281

>>> temperature_feb.cdf(3)            # Chance of being under 3 degrees
0.3184678262814532
>>> # Relative chance of being 7 degrees versus 10 degrees
>>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1.2039930378537762

>>> el_niño = NormalDist(4, 2.5)
>>> temperature_feb += el_niño        # Add in a climate effect
>>> temperature_feb
NormalDist(mu=10.0, sigma=6.830080526611674)

>>> temperature_feb * (9/5) + 32      # Convert to Fahrenheit
NormalDist(mu=50.0, sigma=12.294144947901014)
>>> temperature_feb.samples(3)        # Generate random samples
[7.672102882379219, 12.000027119750287, 4.647488369766392]
@end example

@node sys<6>,tarfile<4>,statistics<3>,Módulos mejorados<5>
@anchor{whatsnew/3 8 sys}@anchor{acb}
@subsubsection sys


Se ha agregado la nueva función @ref{355,,sys.unraisablehook()} que se puede anular para controlar cómo se manejan las «excepciones no lanzables». Se llama cuando se ha producido una excepción, pero Python no tiene forma de manejarla. Por ejemplo, cuando un destructor lanza una excepción o durante la recolección de basura (@ref{acc,,gc.collect()}). (Contribución de Victor Stinner en bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}.)

@node tarfile<4>,threading<2>,sys<6>,Módulos mejorados<5>
@anchor{whatsnew/3 8 tarfile}@anchor{acd}
@subsubsection tarfile


El módulo @ref{de,,tarfile} ahora tiene por defecto el formato pax moderno (POSIX.1-2001) para nuevos archivos, en lugar del anterior específico de GNU. Esto mejora la portabilidad multiplataforma con una codificación consistente (UTF-8) en un formato estandarizado y extensible, y ofrece otros varios beneficios. (Contribución de C.A.M. Gerlach en bpo-36268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36268}.)

@node threading<2>,tokenize<2>,tarfile<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 threading}@anchor{ace}
@subsubsection threading


Se ha agregado una nueva función @ref{8e2,,threading.excepthook()} que maneja las excepciones @ref{acf,,threading.Thread.run()} no capturadas. Se puede anular para controlar cómo se manejan las excepciones @ref{acf,,threading.Thread.run()} no capturadas. (Contribución de Victor Stinner en bpo-1230540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1230540}.)

Se han agregado una nueva función @ref{ad0,,threading.get_native_id()} y un atributo @ref{ad1,,native_id} a la clase @ref{9df,,threading.Thread}. Estos retornan el Thread ID nativo integral del hilo actual asignado por el kernel. Esta función solo está disponible en determinadas plataformas, consulta @ref{ad0,,get_native_id} para obtener más información. (Contribución de Jake Tesler en bpo-36084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36084}.)

@node tokenize<2>,tkinter<4>,threading<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 tokenize}@anchor{ad2}
@subsubsection tokenize


El módulo @ref{fb,,tokenize} ahora emite implícitamente un token @code{NEWLINE} cuando se le proporciona una entrada sin una nueva línea al final. Este comportamiento ahora coincide con lo que hace internamente el tokenizador de C. (Contribución de Ammar Askar en bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node tkinter<4>,time<2>,tokenize<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 tkinter}@anchor{ad3}
@subsubsection tkinter


Se han agregado los métodos @code{selection_from()}, @code{selection_present()}, @code{selection_range()} y @code{selection_to()} a la clase @code{tkinter.Spinbox}. (Contribución de Juliette Monsel en bpo-34829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34829}.)

Se ha agregado el método @code{moveto()} a la clase @code{tkinter.Canvas}. (Contribución de Juliette Monsel en bpo-23831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23831}.)

La clase @code{tkinter.PhotoImage} ahora dispone de los métodos @code{transparency_get()} y @code{transparency_set()}. (Contribución de Zackery Spytz en bpo-25451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25451}.)

@node time<2>,typing<5>,tkinter<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 time}@anchor{ad4}
@subsubsection time


Se ha agregado el nuevo reloj @ref{ad5,,CLOCK_UPTIME_RAW} para macOS 10.12. (Contribución de Joannah Nanjekye en bpo-35702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35702}.)

@node typing<5>,unicodedata<6>,time<2>,Módulos mejorados<5>
@anchor{whatsnew/3 8 typing}@anchor{ad6}
@subsubsection typing


Se han incorporado varias características al módulo @ref{104,,typing}:


@itemize *

@item 
Un tipo de diccionario con tipos para cada clave. Consultar 
@geindex Python Enhancement Proposals; PEP 589
PEP 589@footnote{https://peps.python.org/pep-0589/} y @ref{2ce,,typing.TypedDict}. TypedDict usa solo claves de cadenas de caracteres. De forma predeterminada, se requiere que todas las claves estén presentes. Especifica «total=False» para permitir que las claves sean opcionales:

@example
class Location(TypedDict, total=False):
    lat_long: tuple
    grid_square: str
    xy_coordinate: tuple
@end example

@item 
Tipos literales. Consultar 
@geindex Python Enhancement Proposals; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} y @ref{8ec,,typing.Literal}. Los tipos literales indican que un parámetro o valor de retorno está restringido a uno o más valores literales específicos:

@example
def get_status(port: int) -> Literal['connected', 'disconnected']:
    ...
@end example

@item 
Variables, funciones, métodos y clases «finales». Consultar 
@geindex Python Enhancement Proposals; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/}, @ref{3be,,typing.Final} y @ref{74e,,typing.final()}. El clasificador final instruye a un validador estático de tipos para restringir la subclasificación, anulación o reasignación:

@example
pi: Final[float] = 3.1415926536
@end example

@item 
Definiciones de protocolo. Consultar 
@geindex Python Enhancement Proposals; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/}, @ref{3bb,,typing.Protocol} y @ref{4f0,,typing.runtime_checkable()}. ABCs simples como @ref{ad7,,typing.SupportsInt} ahora son subclases de @code{Protocol} .

@item 
Nueva clase protocolo @ref{ad8,,typing.SupportsIndex}.

@item 
Nuevas funciones @ref{ad9,,typing.get_origin()} y @ref{916,,typing.get_args()}.
@end itemize

@node unicodedata<6>,unittest<5>,typing<5>,Módulos mejorados<5>
@anchor{whatsnew/3 8 unicodedata}@anchor{ada}
@subsubsection unicodedata


El módulo @ref{105,,unicodedata} se ha actualizado para usar la versión Unicode 12.1.0@footnote{https://blog.unicode.org/2019/05/unicode-12-1-en.html}.

La nueva función @ref{adb,,is_normalized()} puede usarse para verificar que una cadena está en una forma normal específica, lo que es a menudo mucho más rápido que normalizar la cadena. (Contribución de Max Belanger, David Euresti y Greg Price en bpo-32285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32285} y bpo-37966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37966}).

@node unittest<5>,venv<4>,unicodedata<6>,Módulos mejorados<5>
@anchor{whatsnew/3 8 unittest}@anchor{adc}
@subsubsection unittest


Se ha agregado @ref{add,,AsyncMock} para admitir una versión asincrónica de @ref{ade,,Mock}. También se han agregado nuevas funciones de aserción apropiadas para las pruebas. (Contribución de Lisa Roach en bpo-26467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26467}).

Added @ref{adf,,addModuleCleanup()} and
@ref{ae0,,addClassCleanup()} to unittest to support
cleanups for @code{setUpModule()} and
@ref{ae1,,setUpClass()}.
(Contributed by Lisa Roach in bpo-24412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24412}.)

Varias funciones de aserción simulada ahora también imprimen una lista de llamadas reales en caso de fallo. (Contribución de Petter Strandmark en bpo-35047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35047}.)

El módulo @ref{106,,unittest} ha obtenido soporte para corrutinas que se utilizarán como casos de prueba con @ref{206,,unittest.IsolatedAsyncioTestCase}. (Contribución de Andrew Svetlov en bpo-32972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32972}.)

Ejemplo:

@example
import unittest


class TestRequest(unittest.IsolatedAsyncioTestCase):

    async def asyncSetUp(self):
        self.connection = await AsyncConnection()

    async def test_get(self):
        response = await self.connection.get("https://example.com")
        self.assertEqual(response.status_code, 200)

    async def asyncTearDown(self):
        await self.connection.close()


if __name__ == "__main__":
    unittest.main()
@end example

@node venv<4>,weakref,unittest<5>,Módulos mejorados<5>
@anchor{whatsnew/3 8 venv}@anchor{ae2}
@subsubsection venv


@ref{111,,venv} ahora incluye un script @code{Activate.ps1} en todas las plataformas para activar entornos virtuales en PowerShell Core 6.1. (Contribución de Brett Cannon en bpo-32718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32718}.)

@node weakref,xml<4>,venv<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 weakref}@anchor{ae3}
@subsubsection weakref


Los objetos proxy retornados por @code{debilref.proxy()} ahora admiten los operadores de multiplicación de matrices @code{@@} y @code{@@=}, además de los otros operadores numéricos. (Contribución de Mark Dickinson en bpo-36669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36669}.)

@node xml<4>,xmlrpc,weakref,Módulos mejorados<5>
@anchor{whatsnew/3 8 xml}@anchor{ae4}
@subsubsection xml


Como mitigación contra DTD y recuperación de entidades externas, los módulos @ref{122,,xml.dom.minidom} y @ref{129,,xml.sax} ya no procesan entidades externas de forma predeterminada. (Contribución de Christian Heimes en bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}.)

Los métodos @code{.find*()} del módulo @ref{125,,xml.etree.ElementTree} admiten búsquedas con comodines, como @code{@{*@}tag}, que ignora el espacio de nombres, y @code{@{namespace@}*}, que retorna todas las etiquetas en el espacio de nombres dado. (Contribución de Stefan Behnel en bpo-28238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28238}.)

The @ref{125,,xml.etree.ElementTree} module provides a new function
@code{–xml.etree.ElementTree.canonicalize()} that implements C14N 2.0.
(Contributed by Stefan Behnel in bpo-13611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13611}.)

El objeto de destino de @ref{ae5,,xml.etree.ElementTree.XMLParser} puede recibir eventos de declaración de espacio de nombres a través de los nuevos métodos de retrollamada @code{start_ns()} y @code{end_ns()}. Además, el destino @ref{ae6,,xml.etree.ElementTree.TreeBuilder} se puede configurar para procesar eventos sobre comentarios e instrucciones de procesamiento para incluirlos en el árbol generado. (Contribución de Stefan Behnel en bpo-36676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36676} y bpo-36673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36673}.)

@node xmlrpc,,xml<4>,Módulos mejorados<5>
@anchor{whatsnew/3 8 xmlrpc}@anchor{ae7}
@subsubsection xmlrpc


@ref{ae8,,xmlrpc.client.ServerProxy} ahora admite un argumento por palabra clave `headers' opcional para una secuencia de encabezados HTTP que se enviarán con cada solicitud. Entre otras cosas, esto permite actualizar desde la autenticación básica predeterminada a una autenticación de sesión más rápida. (Contribución de Cédric Krier en bpo-35153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35153}.)

@node Optimizaciones<5>,Cambios en la compilación y la API de C,Módulos mejorados<5>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 optimizations}@anchor{ae9}
@subsection Optimizaciones



@itemize *

@item 
El módulo @ref{d6,,subprocess} ahora puede usar en ciertos casos la función @ref{37d,,os.posix_spawn()} para mejorar el rendimiento. Actualmente, solo se usa en macOS y Linux (usando glibc 2.24 o una versión más reciente) y siempre que se cumplan todas estas condiciones:


@itemize *

@item 
`close_fds' es falso;

@item 
los parámetros `preexec_fn', `pass_fds', `cwd' y `start_new_session' no están establecidos;

@item 
la ruta `executable' contiene un directorio.
@end itemize

(Contribución de Joannah Nanjekye y Victor Stinner en bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}.)

@item 
@ref{aea,,shutil.copyfile()}, @ref{aeb,,shutil.copy()}, @ref{aec,,shutil.copy2()}, @ref{abb,,shutil.copytree()} y @ref{aed,,shutil.move()} usan llamadas al sistema de «copia-rápida» específicas de la plataforma en Linux y macOS, con la finalidad de copiar ficheros más eficientemente. «copia-rápida» significa que la operación de copiado tiene lugar en el propio kernel, evitando que Python haga uso de búferes en el espacio de usuario como «@code{outfd.write(infd.read())}». En Windows, @ref{aea,,shutil.copyfile()} usa un tamaño de búfer predeterminado más grande (1 MiB en lugar de 16 KiB) y se usa una variante de @ref{aee,,shutil.copyfileobj()} basada en @ref{156,,memoryview()}. La aceleración al copiar un archivo de 512 MiB dentro de la misma partición es de aproximadamente +26% en Linux, +50% en macOS y +40% en Windows. Además, se consumen muchos menos ciclos de CPU. Consultar la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}. (Contribución de Giampaolo Rodolà en bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}.)

@item 
Ahora @ref{abb,,shutil.copytree()} usa la función @ref{1a2,,os.scandir()} y todas las funciones de copia que dependen de ella usan el valor en caché de @ref{548,,os.stat()}. Al copiar un directorio con 8000 archivos, la mejora de velocidad es de +9% en Linux, +20% en Windows y +30% en recursos compartidos de Windows SMB. Además, el número de llamadas al sistema de @ref{548,,os.stat()} se reduce en un 38%, lo que hace que @ref{abb,,shutil.copytree()} sea más rápida especialmente en sistemas de archivos de red. (Contribución de Giampaolo Rodolà en bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695}.)

@item 
El protocolo por defecto del módulo @ref{a6,,pickle} es ahora el Protocolo 4, introducido por primera vez en Python 3.4. Ofrece un mejor desempeño y un menor tamaño, en comparación con el Protocolo 3 disponible desde Python 3.0.

@item 
Se eliminó un miembro @ref{af0,,Py_ssize_t} de @code{PyGC_Head}. El tamaño de todos los objetos rastreados de GC (por ejemplo, tupla, lista, dict) se reduce en 4 u 8 bytes. (Aportado por Inada Naoki en bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}.)

@item 
La clase @ref{af1,,uuid.UUID} ahora usa @code{__slots__} para reducir su impacto en la memoria. (Contribución de Wouter Bolsterlee y Tal Einat en bpo-30977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30977}.)

@item 
Mejorado el rendimiento de @ref{af2,,operator.itemgetter()} en un 33%. Se ha optimizado el manejo de argumentos y se ha agregado una ruta rápida al caso común de índices enteros no negativos únicos en tuplas (que constituye un caso de uso común en la biblioteca estándar). (Contribución de Raymond Hettinger en bpo-35664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35664}.)

@item 
Se han acelerado las búsquedas de campos en @ref{32d,,collections.namedtuple()}. Ahora son más del doble de rápidas, lo que las convierte en la forma más rápida de búsqueda de variables de instancia en Python. (Contribución de Raymond Hettinger, Pablo Galindo, Joe Jevnik y Serhiy Storchaka en bpo-32492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32492}.)

@item 
El constructor de @ref{18e,,list} no sobre-asignará el búfer del elemento interno si se conoce la longitud de la entrada iterable (es decir, si la entrada implementa @code{__len__}). Esto hace que la lista generada sea, en promedio, un 12% más pequeña. (Contribución de Raymond Hettinger y Pablo Galindo en bpo-33234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33234}.)

@item 
De ha duplicado la velocidad de escritura de variables de clase. Antes, cuando se actualizaba un atributo non-dunder, había una llamada innecesaria para actualizar slots. (Contribución de Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger, Neil Schemenauer y Serhiy Storchaka en bpo-36012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36012}.)

@item 
Se ha reducido la sobrecarga de conversión de argumentos pasados a muchas funciones y métodos integrados. Esto acelera la llamada a algunas funciones y métodos incorporados simples hasta un 20-50%. (Contribución de Serhiy Storchaka en bpo-23867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23867}, bpo-35582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35582} y bpo-36127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36127}.)

@item 
La instrucción @code{LOAD_GLOBAL} ahora utiliza el nuevo mecanismo «per opcode cache». Ahora es aproximadamente un 40% más rápida. (Contribución de Yury Selivanov e Inada Naoki en bpo-26219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26219}.)
@end itemize

@node Cambios en la compilación y la API de C,Obsoleto<8>,Optimizaciones<5>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 build-and-c-api-changes}@anchor{af3}
@subsection Cambios en la compilación y la API de C



@itemize *

@item 
El valor predeterminado para @ref{af4,,sys.abiflags} es ahora una cadena vacía: el flag @code{m} para pymalloc se ha vuelto innecesario (las compilaciones con y sin pymalloc son ABI compatibles) y por lo tanto se ha eliminado. (Contribución de Victor Stinner en bpo-36707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36707}.)

Ejemplos del cambio:


@itemize *

@item 
Solo el programa @code{python3.8} es instalado, el programa @code{python3.8m} se ha eliminado.

@item 
Solo el script @code{python3.8-config} es instalado, el script @code{python3.8m-config} se ha eliminado.

@item 
El flag @code{m} se ha eliminado del sufijo de los nombres de archivo de las bibliotecas dinámicas: los módulos de extensión de la biblioteca estándar, así como los producidos e instalados por paquetes de terceros, como los descargados desde PyPI. En Linux, por ejemplo, el sufijo @code{.cpython-37m-x86_64-linux-gnu.so} en Python 3.7 se ha convertido en @code{.cpython-38-x86_64-linux-gnu.so} en Python 3.8.
@end itemize

@item 
Los archivos de cabeceras se han reorganizado para separar mejor los diferentes tipos de APIs:


@itemize *

@item 
@code{Include/*.h} debe ser la API de C portable, pública y estable.

@item 
@code{Include/cpython/*.h} debe ser la API de C inestable específica de CPython. Una API pública, con alguna API privada marcada con los prefijos @code{_Py} o @code{_PY}.

@item 
@code{Include/internal/*.h} es la API de C interna privada, muy específica de CPython. Esta API no tiene retro-compatibilidad garantizada con versiones anteriores y no debe ser usada fuera de CPython. Solo está expuesta para cubrir necesidades muy específicas, como es el caso de depuradores y perfiladores, que necesitan acceder a los componentes internos de CPython sin llamar directamente a las funciones. Esta API es ahora instalada por @code{make install}.
@end itemize

(Contribución de Victor Stinner en bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} y bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}, trabajo iniciado por Eric Snow en Python 3.7.)

@item 
Algunas macros se han convertido a funciones inline estáticas: los tipos de los parámetros y el tipo de retorno están bien definidos, no entrañan cuestiones que precisen el uso específico de macros y las variables tienen ámbito local. Algunos ejemplos:


@itemize *

@item 
@ref{612,,Py_INCREF()}, @ref{613,,Py_DECREF()}

@item 
@ref{af5,,Py_XINCREF()}, @ref{828,,Py_XDECREF()}

@item 
@code{PyObject_INIT()}, @code{PyObject_INIT_VAR()}

@item 
Funciones privadas: @code{_PyObject_GC_TRACK()}, @code{_PyObject_GC_UNTRACK()}, @code{_Py_Dealloc()}
@end itemize

(Contribución de Victor Stinner en bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}.)

@item 
Las funciones @code{PyByteArray_Init()} y @code{PyByteArray_Fini()} se han eliminado. No eran de utilidad desde Python 2.7.4 y Python 3.2.0, cuando fueron excluidas de la API limitada (ABI estable) y dejaron de estar documentadas. (Contribución de Victor Stinner en bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}.)

@item 
El resultado de @code{PyExceptionClass_Name()} es ahora de tipo @code{const char *} en vez de @code{char *}. (Contribución de Serhiy Storchaka en bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818}.)

@item 
La dualidad conformada por @code{Modules/Setup.dist} y @code{Modules/Setup} ha sido eliminada. Anteriormente, al actualizar el árbol de fuentes de CPython, se tenía que copiar manualmente @code{Modules/Setup.dist} (dentro del árbol de fuentes) a @code{Modules/Setup} (dentro del árbol de compilación) para reflejar cualquier cambio en sentido ascendente. Esto suponía un pequeño beneficio para los empaquetadores, a expensas de una frecuente molestia para los desarrolladores de CPython, ya que olvidarse de copiar el archivo podía ocasionar fallos de compilación.

Ahora el sistema de compilación siempre lee desde @code{Modules/Setup} dentro del árbol de fuentes. Se recomienda a las personas que deseen personalizar este archivo que mantengan sus cambios en un fork de git de CPython o como archivos de parche, como harían con cualquier otro cambio en el árbol de fuentes.

(Contribución de Antoine Pitrou en bpo-32430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32430}.)

@item 
Las funciones que convierten un número de Python a un entero de C, como @ref{454,,PyLong_AsLong()}, y las funciones de análisis de argumentos como @ref{615,,PyArg_ParseTuple()} con unidades de formato de conversión de enteros como @code{'i'}, ahora usarán el método especial @ref{22b,,__index__()} si está disponible, en lugar de @ref{22a,,__int__()}. Una advertencia de deprecación se emitirá para aquellos objetos que tengan el método @code{__int__()} pero no el método @code{__index__()} (como @ref{16a,,Decimal} y @ref{177,,Fraction}). @ref{af6,,PyNumber_Check()} ahora retornará @code{1} para los objetos que implementen @code{__index__()}. @ref{af7,,PyNumber_Long()}, @ref{af8,,PyNumber_Float()} y @ref{af9,,PyFloat_AsDouble()} ahora también usan el método @code{__index__()} si está disponible. (Contribución de Serhiy Storchaka en bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048} y bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}.)

@item 
Los objetos de tipo asignados al montículo ahora aumentarán su recuento de referencias en @ref{afa,,PyObject_Init()} (y en su macro paralela @code{PyObject_INIT}) en lugar de en @ref{afb,,PyType_GenericAlloc()}. Es posible que deban ajustarse los tipos que modifican la asignación o desasignación de instancias. (Contribución de Eddie Elizondo en bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}.)

@item 
The new function @code{PyCode_NewWithPosOnlyArgs()} allows to create
code objects like @code{PyCode_New()}, but with an extra `posonlyargcount'
parameter for indicating the number of positional-only arguments.
(Contributed by Pablo Galindo in bpo-37221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37221}.)

@item 
@code{Py_SetPath()} ahora establece @ref{283,,sys.executable} en la ruta completa del programa (@ref{282,,Py_GetProgramFullPath()}), en vez de en el nombre del programa (@ref{284,,Py_GetProgramName()}). (Contribución de Victor Stinner en bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}.)
@end itemize

@node Obsoleto<8>,APIs y características eliminadas,Cambios en la compilación y la API de C,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 deprecated}@anchor{afc}
@subsection Obsoleto



@itemize *

@item 
El comando @code{bdist_wininst} de distutils está ahora obsoleto, usar @code{bdist_wheel} (paquetes wheel) en su lugar. (Contribución de Victor Stinner en bpo-37481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37481}.)

@item 
Los métodos @code{getchildren()} y @code{getiterator()} del módulo @ref{125,,ElementTree} ahora emiten una advertencia @ref{1da,,DeprecationWarning}, en lugar de @ref{95f,,PendingDeprecationWarning}. Serán eliminados en Python 3.9. (Contribución de Serhiy Storchaka en bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Pasar un objeto a @ref{7de,,loop.set_default_executor()} que no sea una instancia de @ref{7dd,,concurrent.futures.ThreadPoolExecutor} está obsoleto y será prohibido en Python 3.9. (Contribución de Elvis Pranskevichus en bpo-34075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34075}.)

@item 
The @ref{3d8,,__getitem__()} methods of @ref{7d1,,xml.dom.pulldom.DOMEventStream},
@ref{7d2,,wsgiref.util.FileWrapper} and @ref{7d3,,fileinput.FileInput} have been
deprecated.

Las implementaciones de estos métodos han estado ignorando su parámetro `index' y retornando el siguiente item en su lugar. (Contribución de Berker Peksag en bpo-9372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9372}.)

@item 
El atributo @code{_field_types} de la clase @ref{1db,,typing.NamedTuple} está ahora obsoleto en favor del atributo @code{__annotations__}, que contiene la misma información. (Contribución de Raymond Hettinger en bpo-36320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36320}.)

@item 
Las clases @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} y @code{Ellipsis} del módulo @ref{9,,ast} están consideradas obsoletas y serán eliminadas en versiones futuras de Python. La clase @ref{211,,Constant} debe ser usada en su lugar. (Contribución de Serhiy Storchaka en bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}.)

@item 
Los métodos @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()}, @code{visit_NameConstant()} y @code{visit_Ellipsis()} de la clase @ref{212,,ast.NodeVisitor} están obsoletos ahora y serán invocados en versiones futuras de Python. Agregar el método @ref{afd,,visit_Constant()} para manejar todos los nodos constantes. (Contribución de Serhiy Storchaka en bpo-36917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36917}.)

@item 
El @ref{7cd,,decorator} @code{asyncio.coroutine()} está obsoleto y será eliminado en Python 3.10. En lugar de @code{@@asyncio.coroutine}, se debe usar @ref{672,,async def}. (Contribución de Andrew Svetlov en bpo-36921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36921}.)

@item 
En @ref{b,,asyncio}, pasar un argumento `loop' de forma explícita está ahora obsoleto y será eliminado en Python 3.10 para las siguientes funciones y constructores: @ref{afe,,asyncio.sleep()}, @ref{69e,,asyncio.gather()}, @ref{aff,,asyncio.shield()}, @ref{6a0,,asyncio.wait_for()}, @ref{528,,asyncio.wait()}, @ref{311,,asyncio.as_completed()}, @ref{580,,asyncio.Task}, @ref{b00,,asyncio.Lock}, @ref{b01,,asyncio.Event}, @ref{b02,,asyncio.Condition}, @ref{b03,,asyncio.Semaphore}, @ref{b04,,asyncio.BoundedSemaphore}, @ref{b05,,asyncio.Queue}, @ref{b06,,asyncio.create_subprocess_exec()} y @ref{b07,,asyncio.create_subprocess_shell()}.

@item 
El paso explícito de objetos corrutina a @ref{528,,asyncio.wait()} está ahora obsoleto y será eliminado en Python 3.11. (Contribución de Yury Selivanov en bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}.)

@item 
Las siguientes funciones y métodos del módulo @ref{63,,gettext} están obsoletos para: @code{lgettext()}, @code{ldgettext()}, @code{lngettext()} y @code{ldngettext()}. Retornan bytes codificados y es posible obtener excepciones inesperadas relacionadas con Unicode si hay problemas de codificación con las cadenas traducidas. En Python 3 es mucho mejor usar alternativas que retornen cadenas Unicode. Estas funciones han estado rotas durante mucho tiempo.

Función @code{bind_textdomain_codeset()}, métodos @code{output_charset()} y @code{set_output_charset()}, y el parámetro `codeset' de las funciones @code{translation()} y @ref{b08,,install()} también están en desuso, ya que solo se usan para las funciones @code{l*gettext()}. (Contribución de Serhiy Storchaka en bpo-33710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33710}.)

@item 
The @code{isAlive()} method of @ref{9df,,threading.Thread}
has been deprecated.
(Contributed by Donghee Na in bpo-35283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35283}.)

@item 
Muchas funciones incorporadas y de extensión que toman argumentos enteros ahora emitirán una advertencia de deprecación para @ref{16a,,Decimal}s, @ref{177,,Fraction}s y cualquier otro objeto que se pueda convertir a enteros solamente con pérdida (por ejemplo, aquellos que tienen el método @code{__int__()} pero no el método @code{__index__()}). En una versión futura, esto constituirá un error. (Contribución de Serhiy Storchaka en bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048}.)

@item 
El paso de los siguientes argumentos como argumentos por palabra clave está ahora obsoleto:


@itemize -

@item 
`func' en @ref{17b,,functools.partialmethod()}, @ref{b09,,weakref.finalize()}, @ref{b0a,,profile.Profile.runcall()}, @code{cProfile.Profile.runcall()}, @ref{b0b,,bdb.Bdb.runcall()}, @ref{b0c,,trace.Trace.runfunc()} y @ref{b0d,,curses.wrapper()}.

@item 
`function' en @ref{b0e,,unittest.TestCase.addCleanup()}.

@item 
`fn' en el método @ref{b0f,,submit()} de las clases @ref{7dd,,concurrent.futures.ThreadPoolExecutor} y @ref{163,,concurrent.futures.ProcessPoolExecutor}.

@item 
`callback' en @ref{b10,,contextlib.ExitStack.callback()}, @code{contextlib.AsyncExitStack.callback()} y @ref{b11,,contextlib.AsyncExitStack.push_async_callback()}.

@item 
`c' y `typeid' en el método @code{create()} de las clases @code{multiprocessing.managers.Server} y @code{multiprocessing.managers.SharedMemoryServer}.

@item 
`obj' en @ref{b09,,weakref.finalize()}.
@end itemize

En futuros lanzamientos de Python, todos ellos serán @ref{b12,,argumentos solo posicionales}. (Contribución de Serhiy Storchaka en bpo-36492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36492}.)
@end itemize

@node APIs y características eliminadas,Portando a Python 3 8,Obsoleto<8>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 api-and-feature-removals}@anchor{b13}
@subsection APIs y características eliminadas


Las siguientes características y APIs se han eliminado de Python 3.8:


@itemize *

@item 
Starting with Python 3.3, importing ABCs from @ref{1e,,collections} was
deprecated, and importing should be done from @ref{1f,,collections.abc}. Being
able to import from collections was marked for removal in 3.8, but has been
delayed to 3.9. (See gh-81134@footnote{https://github.com/python/cpython/issues/81134}.)

@item 
El módulo @code{macpath}, obsoleto desde Python 3.7, ha sido eliminado. (Contribución de Victor Stinner en bpo-35471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35471}.)

@item 
La función @code{platform.popen()} ha sido eliminada, después de haber estado obsoleta desde Python 3.3: usa @ref{1c5,,os.popen()} en su lugar. (Contribución de Victor Stinner en bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}.)

@item 
La función @code{time.clock()} ha sido eliminada, después de haber quedado obsoleta desde Python 3.3: usa @ref{b14,,time.perf_counter()} o @ref{b15,,time.process_time()} en su lugar, dependiendo de tus requisitos, para tener un comportamiento bien definido. (Contribución de Matthias Bussonnier en bpo-36895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36895}.)

@item 
El script @code{pyvenv} se ha eliminado, en favor de @code{python3.8 -m venv}, para ayudar a eliminar la confusión sobre a qué intérprete de Python está vinculado el script @code{pyvenv}. (Contribución de Brett Cannon en bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427}.)

@item 
@code{parse_qs}, @code{parse_qsl}, and @code{escape} are removed from the @code{cgi}
module.  They are deprecated in Python 3.2 or older. They should be imported
from the @code{urllib.parse} and @code{html} modules instead.

@item 
La función @code{filemode} se ha eliminado del módulo @ref{de,,tarfile}. Estaba indocumentada y obsoleta desde Python 3.3.

@item 
El constructor de @ref{ae5,,XMLParser} ya no acepta el argumento `html'. Nunca tuvo efecto y quedó obsoleto en Python 3.4. Todos los demás parámetros son ahora @ref{3f4,,parámetros solo nombrados}. (Contribución de Serhiy Storchaka en bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Se ha eliminado el método @code{doctype()} de @ref{ae5,,XMLParser}. (Contribución de Serhiy Storchaka en bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Se ha elimina el códec «unicode_internal». (Contribución de Inada Naoki en bpo-36297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36297}.)

@item 
Los objetos @code{Cache} y @code{Statement} del módulo @ref{cf,,sqlite3} no estarán expuestos al usuario a partir de ahora. (Contribución de Aviv Palivoda en bpo-30262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30262}.)

@item 
El argumento por palabra clave @code{bufsize} de @ref{896,,fileinput.input()} y @ref{7d3,,fileinput.FileInput()}, marcado como obsoleto e ignorado desde Python 3.6, ha sido eliminado. bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952} (Contribución de Matthias Bussonnier.)

@item 
Las funciones @code{sys.set_coroutine_wrapper()} y @code{sys.get_coroutine_wrapper()}, obsoletas desde Python 3.7, han sido eliminadas; bpo-36933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36933} (Contribución de Matthias Bussonnier.)
@end itemize

@node Portando a Python 3 8,Cambios notables en Python 3 8 1,APIs y características eliminadas,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 porting-to-python-3-8}@anchor{b16}
@subsection Portando a Python 3.8


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en tu código.

@menu
* Cambios en el comportamiento de Python:: 
* Cambios en la API de Python: Cambios en la API de Python<4>. 
* Cambios en la API de C: Cambios en la API de C<7>. 
* Cambios en el bytecode de CPython:: 
* Demos y herramientas:: 

@end menu

@node Cambios en el comportamiento de Python,Cambios en la API de Python<4>,,Portando a Python 3 8
@anchor{whatsnew/3 8 changes-in-python-behavior}@anchor{b17}
@subsubsection Cambios en el comportamiento de Python



@itemize *

@item 
Las expresiones yield (tanto la cláusula @code{yield} como la cláusula @code{yield from}) ahora no están permitidas en comprensiones y expresiones generadoras (excepto en la expresión iterable en la cláusula @code{for} situada más a la izquierda). (Contribución de Serhiy Storchaka en bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}.)

@item 
El compilador ahora produce una advertencia @ref{511,,SyntaxWarning} cuando se utilizan comprobaciones de identidad (@code{is} e @code{is not}) con ciertos tipos de literales (por ejemplo, cadenas, números). A menudo, estas pueden funcionar accidentalmente en CPython, pero no está garantizado por las especificaciones del lenguaje. La advertencia advierte a los usuarios que utilicen pruebas de igualdad (@code{==} y @code{!=}) en su lugar. (Contribución de Serhiy Storchaka en bpo-34850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34850}.)

@item 
El intérprete de CPython puede tolerar excepciones en algunas circunstancias. En Python 3.8 esto sucederá con menos frecuencia. En particular, las excepciones que se generan al obtener atributos del diccionario de tipos ya no son ignoradas. (Contribución de Serhiy Storchaka en bpo-35459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35459}.)

@item 
Se ha eliminado las implementaciones de @code{__str__} para los tipos incorporados @ref{513,,bool}, @ref{1f0,,int}, @ref{153,,float}, @ref{154,,complex} y algunas clases de la biblioteca estándar. Ahora heredan el método @code{__str__()} de @ref{b18,,object}. Como resultado, definir el método @code{__repr__()} en una subclase de estas clases afectará a su representación como cadena de caracteres. (Contribución de Serhiy Storchaka en bpo-36793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36793}.)

@item 
En AIX, el atributo @ref{b19,,sys.platform} ya no contiene la versión principal. Es decir, siempre es @code{'aix'}, en lugar de @code{'aix3'} .. @code{'aix7'}. Dado que las versiones anteriores de Python incluyen el número de versión, se recomienda usar siempre @code{sys.platform.startswith('aix')}. (Contribución de M. Felt en bpo-36588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36588}.)

@item 
@code{PyEval_AcquireLock()} y @code{PyEval_AcquireThread()} ahora terminan el hilo actual si se llaman mientras el intérprete está finalizando, haciéndolos consistentes con @ref{49c,,PyEval_RestoreThread()}, @ref{b1a,,Py_END_ALLOW_THREADS()} y @ref{49e,,PyGILState_Ensure()}. Si no se desea este comportamiento, se tiene que proteger la invocación comprobando @code{_Py_IsFinalizing()} o @code{sys.is_finalizing()}. (Contribución de Joannah Nanjekye en bpo-36475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36475}.)
@end itemize

@node Cambios en la API de Python<4>,Cambios en la API de C<7>,Cambios en el comportamiento de Python,Portando a Python 3 8
@anchor{whatsnew/3 8 changes-in-the-python-api}@anchor{b1b}
@subsubsection Cambios en la API de Python



@itemize *

@item 
La función @ref{b1c,,os.getcwdb()} ahora usa la codificación UTF-8 en Windows, en lugar de la página de códigos ANSI: consultar 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para el fundamento. La función ya no está obsoleta en Windows. (Contribución de Victor Stinner en bpo-37412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37412}.)

@item 
@ref{301,,subprocess.Popen} ahora puede usar @ref{37d,,os.posix_spawn()} en algunos casos para un mejor rendimiento. En el Subsistema de Windows para Linux y en la Emulación de usuario QEMU, el constructor @code{Popen} que usa @ref{37d,,os.posix_spawn()} ya no lanza una excepción como «missing program» ante errores. En cambio, el proceso hijo falla con un valor @code{returncode} distinto de cero. (Contribución de Joannah Nanjekye y Victor Stinner en bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}.)

@item 
El argumento `preexec_fn' de @ref{301,,subprocess.Popen} ya no es compatible con subintérpretes. El uso del parámetro en un subintérprete ahora lanza una excepción @ref{1e5,,RuntimeError}. (Contribución de Eric Snow en bpo-34651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34651}, modificado por Christian Heimes en bpo-37951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37951}.)

@item 
El método @code{imap.IMAP4.logout()} ya no ignora silenciosamente excepciones arbitrarias. (Contribución de Victor Stinner en bpo-36348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36348}.)

@item 
La función @code{platform.popen()} ha sido eliminada, después de haber estado obsoleta desde Python 3.3: usa @ref{1c5,,os.popen()} en su lugar. (Contribución de Victor Stinner en bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}.)

@item 
La función @ref{b1d,,statistics.mode()} ya no lanza una excepción cuando se proporcionan datos multimodales. Ahora, en cambio, retorna la primera moda encontrada en los datos de entrada. (Contribución de Raymond Hettinger en bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892}.)

@item 
El método @ref{b1e,,selection()} de la clase @ref{b1f,,tkinter.ttk.Treeview} ya no acepta argumentos. Usarlo con argumentos para cambiar la selección quedó obsoleto en Python 3.6. Utiliza métodos especializados, como @ref{b20,,selection_set()}, para cambiar la selección. (Contribución de Serhiy Storchaka en bpo-31508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31508}.)

@item 
Los métodos @code{writexml()}, @code{toxml()} y @code{toprettyxml()} de @ref{122,,xml.dom.minidom} y el método @code{write()} de @code{xml.etree}, ahora conservan el orden de los atributos especificado por el usuario. (Contribución de Diego Rojas y Raymond Hettinger en bpo-34160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34160}.)

@item 
Una base de datos @ref{33,,dbm.dumb} abierta con el flag @code{'r'} ahora es de solo lectura. @ref{b21,,dbm.dumb.open()} con los flags @code{'r'} y @code{'w'} ya no crea una base de datos si no existe. (Contribución de Serhiy Storchaka en bpo-32749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32749}.)

@item 
El método @code{doctype()} definido en una subclase de @ref{ae5,,XMLParser} ya no será invocado y emitirá una advertencia @ref{323,,RuntimeWarning} en lugar de @ref{1da,,DeprecationWarning}. Define el método @ref{b22,,doctype()} en un objetivo para manejar una declaración doctype de XML. (Contribución de Serhiy Storchaka en bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Ahora se lanza una excepción @ref{1e5,,RuntimeError} cuando la metaclase personalizada no proporciona la entrada @code{__classcell__} en el espacio de nombres pasado a @code{type.__new__}. En Python 3.6–3.7. se emitía una advertencia @ref{1da,,DeprecationWarning} (Contribución de Serhiy Storchaka en bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}.)

@item 
La clase @code{cProfile.Profile} ahora se puede usar como gestor de contexto. (Contribución de Scott Sanderson en bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}.)

@item 
@ref{aea,,shutil.copyfile()}, @ref{aeb,,shutil.copy()}, @ref{aec,,shutil.copy2()}, @ref{abb,,shutil.copytree()} y @ref{aed,,shutil.move()} usan llamadas al sistema de «copia-rápida» específicas de la plataforma. (Consultar la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}).

@item 
El tamaño predeterminado del búfer de @ref{aea,,shutil.copyfile()} en Windows se ha cambiado de 16 KiB a 1 MiB.

@item 
La estructura @code{PyGC_Head} ha cambiado por completo. Todo código que haga uso de algún miembro de la estructura debe reescribirse. (Consultar bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}.)

@item 
La estructura @ref{954,,PyInterpreterState} se ha movido a los archivos de cabeceras «internos» (específicamente a Include/internal/pycore_pystate.h). Un @code{PyInterpreterState} opaco todavía está disponible como parte de la API pública (y ABI estable). La documentación indica que ninguno de los campos de la estructura es público, por lo que esperamos que nadie los haya estado usando. Sin embargo, si utilizas uno o más de esos campos privados y no tienes otra alternativa, abre una issue BPO. Trabajaremos para ayudarte a adaptarlo (posiblemente incluyendo funciones de acceso a la API pública). (Consultar bpo-35886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35886}.)

@item 
El método @ref{b23,,mmap.flush()} ahora retorna @code{None} en caso de éxito y lanza una excepción en caso de error, en todas las plataformas. Anteriormente, su comportamiento dependía de la plataforma: en Windows retornaba un valor distinto de cero en caso de éxito y cero ante un error. En Unix se retornaba un valor de cero en caso de éxito y se lanzaba una excepción ante un error. (Contribución de Berker Peksag en bpo-2122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2122}.)

@item 
Los módulos @ref{122,,xml.dom.minidom} y @ref{129,,xml.sax} ya no procesan entidades externas de forma predeterminada. (Contribución de Christian Heimes en bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}.)

@item 
Eliminar una clave de una base de datos @ref{32,,dbm} de solo lectura (@ref{33,,dbm.dumb}, @ref{34,,dbm.gnu} o @ref{35,,dbm.ndbm}) lanza una excepción @code{error} (@ref{b24,,dbm.dumb.error}, @ref{b25,,dbm.gnu.error} o @ref{b26,,dbm.ndbm.error}) en lugar de @ref{438,,KeyError}. (Contribución de Xiang Zhang en bpo-33106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33106}.)

@item 
AST simplificado para literales. Todas las constantes se representarán como instancias de @ref{211,,ast.Constant}. La instanciación de las antiguas clases @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} y @code{Ellipsis} retornará ahora una instancia de @code{Constant}. (Contribución de Serhiy Storchaka en bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}.)

@item 
@ref{aa6,,expanduser()} en Windows ahora usa preferentemente la variable de entorno 
@geindex USERPROFILE
@geindex variables de entorno; USERPROFILE
@code{USERPROFILE} y no usa 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME}, que normalmente no está establecido para cuentas de usuario normales. (Contribución de Anthony Sottile en bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}.)

@item 
La excepción @ref{31f,,asyncio.CancelledError} ahora hereda de @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception} y ya no hereda de @ref{a6c,,concurrent.futures.CancelledError}. (Contribuido por Yury Selivanov en bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}.)

@item 
La función @ref{6a0,,asyncio.wait_for()} ahora espera correctamente la cancelación cuando se usa una instancia de @ref{580,,asyncio.Task}. Anteriormente, al alcanzar `timeout', se cancelaba y retornaba de inmediato. (Contribución de Elvis Pranskevichus en bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}.)

@item 
La función @ref{b27,,asyncio.BaseTransport.get_extra_info()} ahora retorna un objeto socket seguro cuando se pasa “socket” al parámetro `name'. (Contribución de Yury Selivanov en bpo-37027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37027}.)

@item 
@ref{b28,,asyncio.BufferedProtocol} ha pasado a formar parte de la API estable.
@end itemize
@anchor{whatsnew/3 8 bpo-36085-whatsnew}@anchor{b29}

@itemize *

@item 
Las dependencias de DLLs para módulos de extensión y DLLs cargadas con @ref{2b,,ctypes} en Windows ahora se resuelven de forma más segura. Solo las rutas del sistema, el directorio que contiene el archivo DLL o PYD y los directorios agregados mediante @ref{a7c,,add_dll_directory()} se buscan para las dependencias en tiempo de carga. Específicamente, 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} y el directorio de trabajo actual ya no se utilizan, y las modificaciones de estos ya no tendrán ningún efecto en la resolución normal de la DLL. Si tu aplicación se basa en estos mecanismos, debes buscar @ref{a7c,,add_dll_directory()} y, si existe, utilizarlo para agregar tu directorio DLL mientras carga tu biblioteca. Ten en cuenta que los usuarios de Windows 7 deberán asegurarse de que se haya instalado Windows Update KB2533623 (esto también lo verifica el instalador). (Contribución de Steve Dower en bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

@item 
Los archivos de cabeceras y las funciones relacionadas con pgen se han eliminado después de su reemplazo por una implementación pura de Python. (Contribución de Pablo Galindo en bpo-36623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36623}.)

@item 
@ref{1d8,,types.CodeType} tiene un nuevo parámetro en la segunda posición del constructor (`posonlyargcount') para admitir argumentos solo posicionales, definidos en 
@geindex Python Enhancement Proposals; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/}. El primer argumento (`argcount') ahora representa el número total de argumentos posicionales (incluidos los argumentos solo posicionales). El nuevo método @code{replace()} de @ref{1d8,,types.CodeType} se puede utilizar para hacer que el código esté preparado para el futuro.

@item 
El parámetro @code{digestmod} de @ref{b2a,,hmac.new()} ya no usa el resumen MD5 por defecto.
@end itemize

@node Cambios en la API de C<7>,Cambios en el bytecode de CPython,Cambios en la API de Python<4>,Portando a Python 3 8
@anchor{whatsnew/3 8 changes-in-the-c-api}@anchor{b2b}
@subsubsection Cambios en la API de C



@itemize *

@item 
La estructura @ref{b2c,,PyCompilerFlags} obtuvo un nuevo campo `cf_feature_version'. Debe inicializarse en @code{PY_MINOR_VERSION}. El campo se ignora de forma predeterminada y se usa solo si el indicador @code{PyCF_ONLY_AST} está establecido en `cf_flags'. (Aportado por Guido van Rossum en bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}.)

@item 
La función @code{PyEval_ReInitThreads()} se ha eliminado de la API de C. No debe llamarse explícitamente: usa @ref{292,,PyOS_AfterFork_Child()} en su lugar. (Contribución de Victor Stinner en bpo-36728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36728}.)

@item 
En Unix, las extensiones de C ya no están vinculadas a libpython, excepto en Android y Cygwin. Cuando Python está integrado, @code{libpython} no debe cargarse con @code{RTLD_LOCAL}, sino con @code{RTLD_GLOBAL} en su lugar. Anteriormente, no era posible usar @code{RTLD_LOCAL} para cargar extensiones de C que no estuvieran vinculadas a @code{libpython}, como las extensiones de C de la biblioteca estándar construida por la sección @code{*shared*} de @code{Modules/Setup}. (Contribución de Victor Stinner en bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}.)

@item 
El uso de variantes de formato @code{#} en el análisis o la construcción de valores (por ejemplo: @ref{615,,PyArg_ParseTuple()}, @ref{940,,Py_BuildValue()}, @ref{491,,PyObject_CallFunction()}, etc.) sin @code{PY_SSIZE_T_CLEAN} definido ahora lanza una advertencia @code{DeprecationWarning}. Se eliminará en Python 3.10 ó 4.0. Consultar @ref{941,,Analizando argumentos y construyendo valores} para más detalles. (Contribución de Inada Naoki en bpo-36381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36381}.)

@item 
Las instancias de tipos asignados al montón (como los creados con @ref{621,,PyType_FromSpec()}) contienen una referencia a su objeto de tipo. El aumento del recuento de referencias de estos objetos de tipo se ha movido de @ref{afb,,PyType_GenericAlloc()} a las funciones de más bajo nivel, @ref{afa,,PyObject_Init()} y @code{PyObject_INIT()}. Esto hace que los tipos creados mediante @ref{621,,PyType_FromSpec()} se comporten como otras clases en el código gestionado.

@ref{819,,Statically allocated types} no se ve afectado.

Para la gran mayoría de casos, no debería haber efectos secundarios. Sin embargo, los tipos que aumentan manualmente el recuento de referencias después de asignar una instancia (quizás para evitar el error) ahora pueden volverse inmortales. Para evitar esto, estas clases deben llamar a Py_DECREF en el objeto de tipo durante la desasignación de la instancia.

Para portar correctamente estos tipos a Python 3.8, aplica los siguientes cambios:


@itemize *

@item 
Elimina @ref{612,,Py_INCREF} en el objeto de tipo después de asignar una instancia, si la hubiera. Esto puede suceder después de invocar a @ref{a17,,PyObject_New}, @ref{a18,,PyObject_NewVar()}, @ref{b2d,,PyObject_GC_New()}, @ref{b2e,,PyObject_GC_NewVar()}, o cualquier otro asignador personalizado que use @ref{afa,,PyObject_Init()} o @code{PyObject_INIT()}.

Ejemplo:

@example
static foo_struct *
foo_new(PyObject *type) @{
    foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
    if (foo == NULL)
        return NULL;
#if PY_VERSION_HEX < 0x03080000
    // Workaround for Python issue 35810; no longer necessary in Python 3.8
    PY_INCREF(type)
#endif
    return foo;
@}
@end example

@item 
Asegúrate de que todas las funciones personalizadas @code{tp_dealloc} de los tipos asignados al montón disminuyan el recuento de referencias del tipo.

Ejemplo:

@example
static void
foo_dealloc(foo_struct *instance) @{
    PyObject *type = Py_TYPE(instance);
    PyObject_GC_Del(instance);
#if PY_VERSION_HEX >= 0x03080000
    // This was not needed before Python 3.8 (Python issue 35810)
    Py_DECREF(type);
#endif
@}
@end example
@end itemize

(Contribución de Eddie Elizondo en bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}.)

@item 
La macro @ref{b2f,,Py_DEPRECATED()} ha sido implementada para MSVC. La macro ahora debe ser colocada antes del nombre del símbolo.

Ejemplo:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example

(Contribución de Zackery Spytz en bpo-33407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33407}.)

@item 
El intérprete ya no pretende dar suporte nunca más a la compatibilidad binaria de tipos de extensión entre versiones de características. Un @ref{b30,,PyTypeObject} exportado por un módulo de extensión de terceros se supone que tiene todas las ranuras esperadas por la versión actual de Python, incluyendo @ref{b31,,tp_finalize} (@ref{289,,Py_TPFLAGS_HAVE_FINALIZE} ya no se verifica antes de leer @ref{b31,,tp_finalize}).

(Contribución de Antoine Pitrou en bpo-32388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32388}.)

@item 
Las funciones @code{PyNode_AddChild()} y @code{PyParser_AddToken()} ahora aceptan dos argumentos @code{int} adicionales, `end_lineno' y `end_col_offset'.

@item 
El archivo @code{libpython38.a} ya no se incluye en la distribución normal de Windows. Si se necesita este archivo, se puede generar con las herramientas @code{gendef} y @code{dlltool}, que son parte del paquete binutils de MinGW:

@example
gendef - python38.dll > tmp.def
dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
@end example

La ubicación de un archivo @code{pythonXY.dll} instalado dependerá de las opciones de instalación y de la versión y el idioma de Windows. Consultar @ref{b32,,Uso de Python en Windows} para obtener más información. La biblioteca resultante debe colocarse en el mismo directorio que @code{pythonXY.lib}, que generalmente es el directorio @code{libs} en tu instalación de Python.

(Contribución de Steve Dower en bpo-37351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37351}.)
@end itemize

@node Cambios en el bytecode de CPython,Demos y herramientas,Cambios en la API de C<7>,Portando a Python 3 8
@anchor{whatsnew/3 8 cpython-bytecode-changes}@anchor{b33}
@subsubsection Cambios en el bytecode de CPython



@itemize *

@item 
El bucle del intérprete se ha simplificado moviendo al compilador la lógica para el desenredo de la pila de bloques. El compilador ahora emite instrucciones explícitas para ajustar la pila de valores y llamar al código de limpieza para @ref{b34,,break}, @ref{a5b,,continue} y @ref{a60,,return}.

Eliminados los códigos de operación @code{BREAK_LOOP}, @code{CONTINUE_LOOP}, @code{SETUP_LOOP} y @code{SETUP_EXCEPT}. Agregados los nuevos códigos de operación @code{ROT_FOUR}, @code{BEGIN_FINALLY}, @code{CALL_FINALLY} y @code{POP_FINALLY}. Modificados los códigos de operación @code{END_FINALLY} y @code{WITH_CLEANUP_START}.

(Contribución de Mark Shannon, Antoine Pitrou y Serhiy Storchaka en bpo-17611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17611}.)

@item 
Agregado el código de operación @ref{b35,,END_ASYNC_FOR} para manejar excepciones lanzadas mientras se espera al siguiente elemento en un ciclo @ref{b36,,async for}. (Contribución de Serhiy Storchaka en bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}.)

@item 
El código de operación @ref{b37,,MAP_ADD} ahora espera el valor como primer elemento de la pila y la clave como segundo elemento. Este cambio se realizó para que la clave siempre se evalúe antes que el valor en los diccionarios por compresión, como se propone en 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}. (Contribución de Jörn Heissler en bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)
@end itemize

@node Demos y herramientas,,Cambios en el bytecode de CPython,Portando a Python 3 8
@anchor{whatsnew/3 8 demos-and-tools}@anchor{b38}
@subsubsection Demos y herramientas


Se ha añadido un script de evaluación de rendimiento para cronometrar varias formas de acceder a variables: @code{Tools/scripts/var_access_benchmark.py}. (Contribución de Raymond Hettinger en bpo-35884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35884}.)

A continuación, se muestra un resumen de las mejoras de rendimiento desde Python 3.3:

@example
Python version                       3.3     3.4     3.5     3.6     3.7     3.8
--------------                       ---     ---     ---     ---     ---     ---

Variable and attribute read access:
    read_local                       4.0     7.1     7.1     5.4     5.1     3.9
    read_nonlocal                    5.3     7.1     8.1     5.8     5.4     4.4
    read_global                     13.3    15.5    19.0    14.3    13.6     7.6
    read_builtin                    20.0    21.1    21.6    18.5    19.0     7.5
    read_classvar_from_class        20.5    25.6    26.5    20.7    19.5    18.4
    read_classvar_from_instance     18.5    22.8    23.5    18.8    17.1    16.4
    read_instancevar                26.8    32.4    33.1    28.0    26.3    25.4
    read_instancevar_slots          23.7    27.8    31.3    20.8    20.8    20.2
    read_namedtuple                 68.5    73.8    57.5    45.0    46.8    18.4
    read_boundmethod                29.8    37.6    37.9    29.6    26.9    27.7

Variable and attribute write access:
    write_local                      4.6     8.7     9.3     5.5     5.3     4.3
    write_nonlocal                   7.3    10.5    11.1     5.6     5.5     4.7
    write_global                    15.9    19.7    21.2    18.0    18.0    15.8
    write_classvar                  81.9    92.9    96.0   104.6   102.1    39.2
    write_instancevar               36.4    44.6    45.8    40.0    38.9    35.5
    write_instancevar_slots         28.7    35.6    36.1    27.3    26.6    25.7

Data structure read access:
    read_list                       19.2    24.2    24.5    20.8    20.8    19.0
    read_deque                      19.9    24.7    25.5    20.2    20.6    19.8
    read_dict                       19.7    24.3    25.7    22.3    23.0    21.0
    read_strdict                    17.9    22.6    24.3    19.5    21.2    18.9

Data structure write access:
    write_list                      21.2    27.1    28.5    22.5    21.6    20.0
    write_deque                     23.8    28.7    30.1    22.7    21.8    23.5
    write_dict                      25.9    31.4    33.3    29.3    29.2    24.7
    write_strdict                   22.9    28.4    29.9    27.5    25.2    23.1

Stack (or queue) operations:
    list_append_pop                144.2    93.4   112.7    75.4    74.2    50.8
    deque_append_pop                30.4    43.5    57.0    49.4    49.2    42.5
    deque_append_popleft            30.8    43.7    57.3    49.7    49.7    42.8

Timing loop:
    loop_overhead                    0.3     0.5     0.6     0.4     0.3     0.3
@end example

Las evaluaciones de rendimiento se realizaron en un procesador Intel® Core™ i7-4960HQ@footnote{https://ark.intel.com/content/www/us/en/ark/products/76088/intel-core-i7-4960hq-processor-6m-cache-up-to-3-80-ghz.html} ejecutando las compilaciones de 64-bits para macOS disponibles en python.org@footnote{https://www.python.org/downloads/macos/}. El script de evaluación de rendimiento muestra los tiempos en nanosegundos.

@node Cambios notables en Python 3 8 1,Notable changes in Python 3 8 2,Portando a Python 3 8,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-1}@anchor{b39}
@subsection Cambios notables en Python 3.8.1


Debido a importantes preocupaciones de seguridad, el parámetro `reuse_address' de @ref{7cf,,asyncio.loop.create_datagram_endpoint()} ya no está soportado. Esto se debe al comportamiento de la opción @code{SO_REUSEADDR} del socket en UDP. Para obtener más detalles, consulta la documentación de @code{loop.create_datagram_endpoint()}. (Contribución de Kyle Stanley, Antoine Pitrou y Yury Selivanov en bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Notable changes in Python 3 8 2,Notable changes in Python 3 8 3,Cambios notables en Python 3 8 1,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-2}@anchor{b3a}
@subsection Notable changes in Python 3.8.2


Fixed a regression with the @code{ignore} callback of @ref{abb,,shutil.copytree()}.
The argument types are now str and List[str] again.
(Contributed by Manuel Barkhau and Giampaolo Rodola in gh-83571@footnote{https://github.com/python/cpython/issues/83571}.)

@node Notable changes in Python 3 8 3,Cambios notables en Python 3 8 8,Notable changes in Python 3 8 2,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-3}@anchor{b3b}
@subsection Notable changes in Python 3.8.3


The constant values of future flags in the @ref{0,,__future__} module
are updated in order to prevent collision with compiler flags. Previously
@code{PyCF_ALLOW_TOP_LEVEL_AWAIT} was clashing with @code{CO_FUTURE_DIVISION}.
(Contributed by Batuhan Taskaya in gh-83743@footnote{https://github.com/python/cpython/issues/83743})

@node Cambios notables en Python 3 8 8,Notable changes in Python 3 8 9,Notable changes in Python 3 8 3,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-8}@anchor{b3c}
@subsection Cambios notables en Python 3.8.8


Earlier Python versions allowed using both @code{;} and @code{&} as
query parameter separators in @ref{1c9,,urllib.parse.parse_qs()} and
@ref{1c8,,urllib.parse.parse_qsl()}.  Due to security concerns, and to conform with
newer W3C recommendations, this has been changed to allow only a single
separator key, with @code{&} as the default.  This change also affects
@code{cgi.parse()} and @code{cgi.parse_multipart()} as they use the affected
functions internally. For more details, please see their respective
documentation.
(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Notable changes in Python 3 8 9,Notable changes in Python 3 8 10,Cambios notables en Python 3 8 8,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-9}@anchor{b3d}
@subsection Notable changes in Python 3.8.9


A security fix alters the @ref{990,,ftplib.FTP} behavior to not trust the
IPv4 address sent from the remote server when setting up a passive data
channel.  We reuse the ftp server IP address instead.  For unusual code
requiring the old behavior, set a @code{trust_server_pasv_ipv4_address}
attribute on your FTP instance to @code{True}.  (See gh-87451@footnote{https://github.com/python/cpython/issues/87451})

@node Notable changes in Python 3 8 10,Notable changes in Python 3 8 10<2>,Notable changes in Python 3 8 9,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-10}@anchor{b3e}
@subsection Notable changes in Python 3.8.10


@menu
* macOS 11.0 (Big Sur) and Apple Silicon Mac support: macOS 11 0 Big Sur and Apple Silicon Mac support. 

@end menu

@node macOS 11 0 Big Sur and Apple Silicon Mac support,,,Notable changes in Python 3 8 10
@anchor{whatsnew/3 8 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{b3f}
@subsubsection macOS 11.0 (Big Sur) and Apple Silicon Mac support


As of 3.8.10, Python now supports building and running on macOS 11
(Big Sur) and on Apple Silicon Macs (based on the @code{ARM64} architecture).
A new universal build variant, @code{universal2}, is now available to natively
support both @code{ARM64} and @code{Intel 64} in one set of executables.
Note that support for «weaklinking», building binaries targeted for newer
versions of macOS that will also run correctly on older versions by
testing at runtime for missing features, is not included in this backport
from Python 3.9; to support a range of macOS versions, continue to target
for and build on the oldest version in the range.

(Originally contributed by Ronald Oussoren and Lawrence D’Anna in gh-85272@footnote{https://github.com/python/cpython/issues/85272},
with fixes by FX Coudert and Eli Rykoff, and backported to 3.8 by Maxime Bélanger
and Ned Deily)

@node Notable changes in Python 3 8 10<2>,Cambios notables en Python 3 8 1<2>,Notable changes in Python 3 8 10,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 id1}@anchor{b40}
@subsection Notable changes in Python 3.8.10


@menu
* urllib.parse: urllib parse<4>. 

@end menu

@node urllib parse<4>,,,Notable changes in Python 3 8 10<2>
@anchor{whatsnew/3 8 urllib-parse}@anchor{b41}
@subsubsection urllib.parse


The presence of newline or tab characters in parts of a URL allows for some
forms of attacks. Following the WHATWG specification that updates 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html},
ASCII newline @code{\n}, @code{\r} and tab @code{\t} characters are stripped from the
URL by the parser in @ref{10a,,urllib.parse} preventing such attacks. The removal
characters are controlled by a new module level variable
@code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (See bpo-43882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43882})

@node Cambios notables en Python 3 8 1<2>,Notable security feature in 3 8 14,Notable changes in Python 3 8 10<2>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-12}@anchor{b42}
@subsection Cambios notables en Python 3.8.1


@menu
* Cambios en la API de Python: Cambios en la API de Python<5>. 

@end menu

@node Cambios en la API de Python<5>,,,Cambios notables en Python 3 8 1<2>
@anchor{whatsnew/3 8 id2}@anchor{b43}
@subsubsection Cambios en la API de Python


A partir de Python 3.8.12, el módulo @ref{80,,ipaddress} ya no acepta ceros a la izquierda en las cadenas de direcciones IPv4. Los ceros iniciales son ambiguos y algunas bibliotecas los interpretan como notación octal. Por ejemplo, la función heredada @ref{9f4,,socket.inet_aton()} trata los ceros iniciales como notación octal. La implementación glibc del @ref{9f5,,inet_pton()} moderno no acepta ceros a la izquierda.

(Contribuido originalmente por Christian Heimes en bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}, y actualizado a 3.8 por Achraf Merzouki).

@node Notable security feature in 3 8 14,Notable changes in 3 8 17,Cambios notables en Python 3 8 1<2>,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-security-feature-in-3-8-14}@anchor{b44}
@subsection Notable security feature in 3.8.14


Converting between @ref{1f0,,int} and @ref{237,,str} in bases other than 2
(binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal)
now raises a @ref{360,,ValueError} if the number of digits in string form is
above a limit to avoid potential denial of service attacks due to the
algorithmic complexity. This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.
This limit can be configured or disabled by environment variable, command
line flag, or @ref{d9,,sys} APIs. See the @ref{695,,integer string conversion length limitation} documentation.  The default limit
is 4300 digits in string form.

@node Notable changes in 3 8 17,,Notable security feature in 3 8 14,Qué hay de nuevo en Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-3-8-17}@anchor{b45}
@subsection Notable changes in 3.8.17


@menu
* tarfile: tarfile<5>. 

@end menu

@node tarfile<5>,,,Notable changes in 3 8 17
@anchor{whatsnew/3 8 id3}@anchor{b46}
@subsubsection tarfile



@itemize *

@item 
The extraction methods in @ref{de,,tarfile}, and @ref{516,,shutil.unpack_archive()},
have a new a `filter' argument that allows limiting tar features than may be
surprising or dangerous, such as creating files outside the destination
directory.
See @ref{517,,Extraction filters} for details.
In Python 3.12, use without the `filter' argument will show a
@ref{1da,,DeprecationWarning}.
In Python 3.14, the default will switch to @code{'data'}.
(Contributed by Petr Viktorin in 
@geindex Python Enhancement Proposals; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node Qué hay de nuevo en Python 3 7,Qué hay de nuevo en Python 3 6,Qué hay de nuevo en Python 3 8,Qué hay de nuevo en Python
@anchor{whatsnew/3 7 doc}@anchor{b47}@anchor{whatsnew/3 7 what-s-new-in-python-3-7}@anchor{b48}
@section Qué hay de nuevo en Python 3.7


@*Editor: 
`Elvis Pranskevichus' <@email{elvis@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Git log
@c when researching a change.

El artículo explica las nuevas características en Python 3.7, comparado con 3.6. Python 3.7 fue lanzado el 27, Junio, 2018. Para más detalles, consultar la @ref{13b,,changelog}.

@menu
* Resumen – Lanzamientos Destacados:: 
* Nuevas Características:: 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<2>. 
* Nuevos módulos: Nuevos módulos<5>. 
* Módulos mejorados: Módulos mejorados<6>. 
* Cambios en la API C:: 
* Construir cambios: Construir cambios<4>. 
* Optimizaciones: Optimizaciones<6>. 
* Otros cambios de implementación de CPython:: 
* Comportamiento obsoleto de Python:: 
* Módulos@comma{} funciones y métodos de Python obsoletos: Módulos funciones y métodos de Python obsoletos. 
* Funciones y tipos obsoletos de la API C:: 
* Eliminación de soporte de plataforma:: 
* Eliminaciones de API y funciones:: 
* Eliminaciones de módulos:: 
* Cambios solo en Windows:: 
* Portando a Python 3.7: Portando a Python 3 7. 
* Cambios notables en Python 3.7.1: Cambios notables en Python 3 7 1. 
* Cambios notables en Python 3.7.2: Cambios notables en Python 3 7 2. 
* Cambios notables en Python 3.7.6: Cambios notables en Python 3 7 6. 
* Cambios notables en Python 3.7.10: Cambios notables en Python 3 7 10. 
* Notable changes in Python 3.7.11: Notable changes in Python 3 7 11. 
* Notable security feature in 3.7.14: Notable security feature in 3 7 14. 

@end menu

@node Resumen – Lanzamientos Destacados,Nuevas Características,,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 summary-release-highlights}@anchor{b49}
@subsection Resumen – Lanzamientos Destacados


@c This section singles out the most important changes in Python 3.7.
@c Brevity is key.

Sintaxis de nuevas características:


@itemize *

@item 
@ref{b4a,,PEP 563}, evaluación pospuesta de anotaciones de tipo.
@end itemize

Cambios de sintaxis incompatibles hacia atrás:


@itemize *

@item 
@ref{7ce,,async} y @ref{14e,,await} ahora son palabras clave reservadas.
@end itemize

Nuevos módulos de biblioteca:


@itemize *

@item 
@ref{25,,contextvars}: @ref{b4b,,PEP 567 – Variables de Contexto}

@item 
@ref{30,,dataclasses}: @ref{b4c,,PEP 557 – Clases de Datos}

@item 
@ref{b4d,,importlib.resources}
@end itemize

Nuevas funciones integradas:


@itemize *

@item 
@ref{b4e,,PEP 553}, la nueva función @ref{1a6,,breakpoint()}.
@end itemize

Mejoras en el modelo de datos de Python:


@itemize *

@item 
@ref{b4f,,PEP 562}, personalización del acceso a los atributos del módulo.

@item 
@ref{b50,,PEP 560}, soporte básico para módulo de mecanografía y tipos genéricos.

@item 
la naturaleza de conservación del orden de inserción de objetos @ref{b51,,dict} han sido declarado@footnote{https://mail.python.org/pipermail/python-dev/2017-December/151283.html} para ser una parte oficial de la especificación del lenguaje Python.
@end itemize

Mejoras significativas in la librería estándar:


@itemize *

@item 
El modulo @ref{b,,asyncio} ha recibido nuevas funciones, significativas @ref{b52,,mejoras de usabilidad y rendimiento}.

@item 
El modulo @ref{ee,,time} adquirió soporte de @ref{b53,,funciones con resolución de nanosegundos}.
@end itemize

Mejoras en la implementación de CPython:


@itemize *

@item 
Evitando el uso de ASCII como codificación de texto predeterminada:


@itemize *

@item 
@ref{b54,,PEP 538}, coerción de configuración regional de C heredada

@item 
@ref{b55,,PEP 540}, modo de tiempo de ejecución UTF-8 forzado
@end itemize

@item 
@ref{b56,,PEP 552}, determinista `.pycs'

@item 
@ref{b57,,El nuevo modo de ejecución de desarrollo}

@item 
@ref{b58,,PEP 565}, manejo mejorado @ref{1da,,DeprecationWarning}
@end itemize

Mejoras en la API de C:


@itemize *

@item 
@ref{b59,,PEP 539}, nueva API de C para almacenamiento local de subprocesos
@end itemize

Mejoras de Documentación:


@itemize *

@item 
@ref{b5a,,PEP 545}, Traducción de documentación de Python

@item 
Nuevas traducciones de documentación: Japonés@footnote{https://docs.python.org/ja/}, Francés@footnote{https://docs.python.org/fr/}, y Coreano@footnote{https://docs.python.org/ko/}.
@end itemize

Esta versión presenta notables mejoras de rendimiento en muchas áreas. La sección @ref{b5b,,Optimizaciones} los enumera en detalle.

Para obtener una lista de cambios que pueden afectar la compatibilidad con versiones anteriores de Python por favor consultar la sección @ref{b5c,,Portando a Python 3.7}.

@node Nuevas Características,Otros cambios en el lenguaje<2>,Resumen – Lanzamientos Destacados,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 new-features}@anchor{b5d}
@subsection Nuevas Características


@menu
* PEP 563; Evaluación pospuesta de anotaciones: PEP 563 Evaluación pospuesta de anotaciones. 
* PEP 538; Coerción de configuración regional del Legado de C: PEP 538 Coerción de configuración regional del Legado de C. 
* PEP 540; Modo de tiempo de ejecución UTF-8 forzado: PEP 540 Modo de tiempo de ejecución UTF-8 forzado. 
* PEP 553; Incorporada en breakpoint(): PEP 553 Incorporada en breakpoint. 
* PEP 539; Nueva API C para almacenamiento local de subprocesos: PEP 539 Nueva API C para almacenamiento local de subprocesos. 
* PEP 562; Personalización del acceso a los atributos del módulo: PEP 562 Personalización del acceso a los atributos del módulo. 
* PEP 564; Nuevas funciones de tiempo con resolución de nanosegundos: PEP 564 Nuevas funciones de tiempo con resolución de nanosegundos. 
* PEP 565; Mostrar DeprecationWarning en __main__: PEP 565 Mostrar DeprecationWarning en __main__. 
* PEP 560; Soporte básico para el módulo de typing y tipos genéricos: PEP 560 Soporte básico para el módulo de typing y tipos genéricos. 
* PEP 552; Archivos .pyc basados en hash: PEP 552 Archivos pyc basados en hash. 
* PEP 545; Traducciones de Documentaciones de Python: PEP 545 Traducciones de Documentaciones de Python. 
* Modo de desarrollo de Python (-X dev): Modo de desarrollo de Python -X dev. 

@end menu

@node PEP 563 Evaluación pospuesta de anotaciones,PEP 538 Coerción de configuración regional del Legado de C,,Nuevas Características
@anchor{whatsnew/3 7 pep-563-postponed-evaluation-of-annotations}@anchor{b5e}@anchor{whatsnew/3 7 whatsnew37-pep563}@anchor{b4a}
@subsubsection PEP 563: Evaluación pospuesta de anotaciones


La llegada de las sugerencias de tipo en Python descubrió dos problemas de usabilidad evidentes con la funcionalidad de las anotaciones agregadas en 
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} y mas refinado en 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}:


@itemize *

@item 
las anotaciones solo podían usar nombres que ya estaban disponibles en el alcance actual, en otras palabras, no admitían referencias futuras de ningún tipo; y

@item 
anotar el código fuente tuvo efectos adversos en el tiempo de inicio de los programas Python.
@end itemize

Ambos problemas se solucionan posponiendo la evaluación de anotaciones. En lugar de compilar código que ejecuta expresiones en anotaciones en su momento de definición, el compilador almacena la anotación en forma de cadena equivalente al AST de la expresión en cuestión. Si es necesario, las anotaciones se pueden resolver en tiempo de ejecución usando @ref{752,,typing.get_type_hints()}. En el común de los casos esto no es necesario, las anotaciones son más fáciles de almacenar (dado que las cadenas cortas son internadas por el intérprete.) y hacen que el tiempo de inicio sea mas rápido.

En términos de usabilidad, las anotaciones ahora admiten referencias hacia adelante, lo que hace que la siguiente sintaxis sea válida:

@example
class C:
    @@classmethod
    def from_string(cls, source: str) -> C:
        ...

    def validate_b(self, obj: B) -> bool:
        ...

class B:
    ...
@end example

Dado que este cambio rompe la compatibilidad, el nuevo comportamiento debe habilitarse por modulo en Python 3.7 usando una importación @ref{0,,__future__}:

@example
from __future__ import annotations
@end example

Se convertirá en el predeterminado en Python 3.10.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} – Evaluación aplazada de anotaciones

PEP escrito y implementado por `Łukasz Langa'.
@end table


@node PEP 538 Coerción de configuración regional del Legado de C,PEP 540 Modo de tiempo de ejecución UTF-8 forzado,PEP 563 Evaluación pospuesta de anotaciones,Nuevas Características
@anchor{whatsnew/3 7 pep-538-legacy-c-locale-coercion}@anchor{b5f}@anchor{whatsnew/3 7 whatsnew37-pep538}@anchor{b54}
@subsubsection PEP 538: Coerción de configuración regional del Legado de  C


Un desafío continuo dentro de la serie Python 3 ha sido determinar una estrategia predeterminada sensata para manejar el supuesto de codificación de texto “ASCII de 7 bits” implícito actualmente en el uso de la configuración regional C o POSIX predeterminada en plataformas que no son Windows.

@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} actualiza la interfaz de línea de comandos del intérprete predeterminada para convertir automáticamente esa configuración regional en una configuración regional basada en UTF-8 disponible, como se describe en la documentación de la nueva variable de entorno 
@geindex PYTHONCOERCECLOCALE
@geindex variables de entorno; PYTHONCOERCECLOCALE
@ref{b60,,PYTHONCOERCECLOCALE}. Configurar automáticamente @code{LC_CTYPE} de esta manera significa que tanto el intérprete central como las extensiones C que reconocen la configuración regional (por ejemplo @ref{ba,,readline}) asumirá el uso de UTF-8 como codificación de texto predeterminada, en lugar de ASCII.

La definición de soporte de plataforma en 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} también se ha actualizado para limitar la compatibilidad con el manejo de texto completo a configuraciones regionales no basadas en ASCII configuradas adecuadamente.

Como parte de este cambio, el controlador de errores predeterminado para @ref{5df,,stdin} y @ref{b61,,stdout} es ahora @code{surrogateescape} (antes que @code{strict}) al usar cualquiera de las configuraciones regionales de destino de coerción definidas (actualmente @code{C.UTF-8}, @code{C.utf8}, y @code{UTF-8}). El controlador de errores predeterminado para @ref{9cc,,stderr} continua siendo @code{backslashreplace}, independientemente de local.

La coerción local es silenciosa de forma predeterminada, pero para ayudar a depurar problemas de integración potencialmente relacionados con la configuración regional, advertencias explícitas (emitido directamente en @ref{9cc,,stderr}) se puede solicitar configurando @code{PYTHONCOERCECLOCALE=warn}. Esta configuración también hará que el tiempo de ejecución de Python emita una advertencia si la configuración regional C heredada permanece activa cuando se inicializa el intérprete principal.

Mientras la coerción local 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} tiene la ventaja de afectar también a los módulos de extensión (como GNU @code{readline}), así como procesos secundarios (incluidos los que ejecutan aplicaciones que no son de Python y versiones anteriores de Python), tiene la desventaja de requerir que esté presente una ubicación de destino adecuada en el sistema en ejecución. Para manejar mejor el caso en el que no hay una configuración regional de destino adecuada disponible (como ocurre en RHEL / CentOS 7, por ejemplo), Python 3.7 también implementa @ref{b55,,PEP 540; Modo de tiempo de ejecución UTF-8 forzado}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 538

@item PEP 538@footnote{https://peps.python.org/pep-0538/} – Coaccionar la configuración regional C heredada a una configuración regional basada en UTF-8

PEP escrito y implementado por `Nick Coghlan'.
@end table


@node PEP 540 Modo de tiempo de ejecución UTF-8 forzado,PEP 553 Incorporada en breakpoint,PEP 538 Coerción de configuración regional del Legado de C,Nuevas Características
@anchor{whatsnew/3 7 pep-540-forced-utf-8-runtime-mode}@anchor{b62}@anchor{whatsnew/3 7 whatsnew37-pep540}@anchor{b55}
@subsubsection PEP 540: Modo de tiempo de ejecución UTF-8 forzado


La nueva opción de lineas de comando @ref{2e2,,-X} @code{utf8} y la variable de entorno 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} se puede utilizar para habilitar el @ref{6f7,,modo Python UTF-8}.

Cuando está en modo UTF-8, CPython ignora la configuración regional y usa la codificación UTF-8 de forma predeterminada. Los controladores de errores para los flujos @ref{5df,,sys.stdin} y @ref{b61,,sys.stdout} se establecen en @code{surrogateescape}.

El modo UTF-8 forzado se puede usar para cambiar el comportamiento de manejo de texto en un intérprete de Python integrado sin cambiar la configuración regional de una aplicación de inserción.

Mientras el modo UTF-8 
@geindex Python Enhancement Proposals; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} tiene la ventaja de funcionar independientemente de las configuraciones regionales disponibles en el sistema en ejecución, tiene la desventaja de no tener ningún efecto en los módulos de extensión (como GNU @code{readline}), procesos secundarios que ejecutan aplicaciones que no son de Python y procesos secundarios que ejecutan versiones anteriores de Python. Para reducir el riesgo de dañar los datos de texto al comunicarse con dichos componentes, Python 3.7 también implementa @ref{b55,,PEP 540; Modo de tiempo de ejecución UTF-8 forzado}.

El modo UTF-8 está habilitado de forma predeterminada cuando la configuración regional es @code{C} o @code{POSIX}, y la función de coerción local 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} no lo cambia a una alternativa basada en UTF-8 (si ese fallo se debe a que se ha establecido @code{PYTHONCOERCECLOCALE=0}, @code{LC_ALL} se esta configurando, o la falta de un lugar de destino adecuado).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 540

@item PEP 540@footnote{https://peps.python.org/pep-0540/} – Agrega un nuevo modo UTF-8

PEP escrito y implementado por `Victor Stinner'
@end table


@node PEP 553 Incorporada en breakpoint,PEP 539 Nueva API C para almacenamiento local de subprocesos,PEP 540 Modo de tiempo de ejecución UTF-8 forzado,Nuevas Características
@anchor{whatsnew/3 7 pep-553-built-in-breakpoint}@anchor{b64}@anchor{whatsnew/3 7 whatsnew37-pep553}@anchor{b4e}
@subsubsection PEP 553: Incorporada en @code{breakpoint()}


Python 3.7 incluye la nueva función incorporada @ref{1a6,,breakpoint()} como una forma fácil y consistente de ingresar al depurador de Python.

Llamadas @code{breakpoint()} incorporadas en @ref{b65,,sys.breakpointhook()}. Por defecto, este último importa @ref{a5,,pdb} y luego llama @code{pdb.set_trace()}, pero vinculando @code{sys.breakpointhook()} a la función de su elección, @code{breakpoint()} puede entrar en cualquier depurador. Adicionalmente, la variable de entorno 
@geindex PYTHONBREAKPOINT
@geindex variables de entorno; PYTHONBREAKPOINT
@ref{b66,,PYTHONBREAKPOINT} se puede configurar como el depurador que elija. Configure @code{PYTHONBREAKPOINT=0} para deshabilitar completamente el @code{breakpoint()}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 553

@item PEP 553@footnote{https://peps.python.org/pep-0553/} – Incorporada en `breakpoint()'

PEP escrito y implementado por `Barry Warsaw'
@end table


@node PEP 539 Nueva API C para almacenamiento local de subprocesos,PEP 562 Personalización del acceso a los atributos del módulo,PEP 553 Incorporada en breakpoint,Nuevas Características
@anchor{whatsnew/3 7 pep-539-new-c-api-for-thread-local-storage}@anchor{b67}@anchor{whatsnew/3 7 whatsnew37-pep539}@anchor{b59}
@subsubsection PEP 539: Nueva API C para almacenamiento local de subprocesos


Mientras que Python proporciona una API C para soporte de almacenamiento local de subprocesos; el @ref{b68,,Thread Local Storage (TLS) API} existente ha usado int para representar claves TLS en todas las plataformas. En general, esto no ha sido un problema para las plataformas de soporte oficial, pero no es compatible con POSIX ni portátil en ningún sentido práctico.

@geindex Python Enhancement Proposals; PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/} cambia esto al proporcionar un nuevo @ref{b69,,Thread Specific Storage (TSS) API} a CPython que reemplaza el uso de la API TLS existente dentro del intérprete de CPython, al tiempo que deja obsoleta la API existente. La API de TSS utiliza un nuevo tipo @ref{b6a,,Py_tss_t} en lugar de int para representar claves TSS, un tipo opaco cuya definición puede depender de la implementación de TLS subyacente. Por lo tanto, esto permitirá compilar CPython en plataformas donde la clave TLS nativa se define de una manera que no se puede convertir de manera segura a int.

Tenga en cuenta que en las plataformas en las que la clave TLS nativa se define de una manera que no se puede convertir de forma segura a int, todas las funciones de la API de TLS existente no funcionarán e inmediatamente devolverán un error. Esto indica claramente que la antigua API no es compatible con plataformas en las que no se puede usar de manera confiable y que no se hará ningún esfuerzo para agregar dicho soporte.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 539

@item PEP 539@footnote{https://peps.python.org/pep-0539/} – Un nueva `API-C' para almacenamiento local de subprocesos en `CPython'

PEP escrito por `Erik M. Bray'; implementación por `Masayuki Yamamoto'.
@end table


@node PEP 562 Personalización del acceso a los atributos del módulo,PEP 564 Nuevas funciones de tiempo con resolución de nanosegundos,PEP 539 Nueva API C para almacenamiento local de subprocesos,Nuevas Características
@anchor{whatsnew/3 7 pep-562-customization-of-access-to-module-attributes}@anchor{b6b}@anchor{whatsnew/3 7 whatsnew37-pep562}@anchor{b4f}
@subsubsection PEP 562: Personalización del acceso a los atributos del módulo


Python 3.7 permite definir @code{__getattr__()} en módulos y lo llamará siempre que no se encuentre un atributo de módulo. Definir @code{__dir__()} en modules ahora también esta permitido.

Un ejemplo típico de dónde esto puede ser útil es la desaprobación de los atributos del módulo y la carga diferida.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} – Módulo @code{__getattr__} y @code{__dir__}

PEP escrito y implementado por `Ivan Levkivskyi'
@end table


@node PEP 564 Nuevas funciones de tiempo con resolución de nanosegundos,PEP 565 Mostrar DeprecationWarning en __main__,PEP 562 Personalización del acceso a los atributos del módulo,Nuevas Características
@anchor{whatsnew/3 7 pep-564-new-time-functions-with-nanosecond-resolution}@anchor{b6c}@anchor{whatsnew/3 7 whatsnew37-pep564}@anchor{b53}
@subsubsection PEP 564: Nuevas funciones de tiempo con resolución de nanosegundos


The resolution of clocks in modern systems can exceed the limited precision
of a floating-point number returned by the @ref{3ad,,time.time()} function
and its variants.  To avoid loss of precision, 
@geindex Python Enhancement Proposals; PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/} adds six new
«nanosecond» variants of the existing timer functions to the @ref{ee,,time}
module:


@itemize *

@item 
@ref{b6d,,time.clock_gettime_ns()}

@item 
@ref{b6e,,time.clock_settime_ns()}

@item 
@ref{b6f,,time.monotonic_ns()}

@item 
@ref{b70,,time.perf_counter_ns()}

@item 
@ref{b71,,time.process_time_ns()}

@item 
@ref{b72,,time.time_ns()}
@end itemize

Las nuevas funciones devuelven el número de nanosegundos como un valor entero.

@geindex Python Enhancement Proposals; PEP 0564#annex-clocks-resolution-in-python
Measurements@footnote{https://peps.python.org/pep-0564/#annex-clocks-resolution-in-python}
show that on Linux and Windows the resolution of @ref{b72,,time.time_ns()} is
approximately 3 times better than that of @ref{3ad,,time.time()}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 564

@item PEP 564@footnote{https://peps.python.org/pep-0564/} – Agrega nuevas funciones de tiempo y resolución de nanosegundos

PEP escrito y implementado por `Victor Stinner'
@end table


@node PEP 565 Mostrar DeprecationWarning en __main__,PEP 560 Soporte básico para el módulo de typing y tipos genéricos,PEP 564 Nuevas funciones de tiempo con resolución de nanosegundos,Nuevas Características
@anchor{whatsnew/3 7 pep-565-show-deprecationwarning-in-main}@anchor{b73}@anchor{whatsnew/3 7 whatsnew37-pep565}@anchor{b58}
@subsubsection PEP 565: Mostrar `DeprecationWarning' en @code{__main__}


El manejo predeterminado de @ref{1da,,DeprecationWarning} Se ha cambiado de modo que estas advertencias se muestren una vez más de forma predeterminada, pero solo cuando el código que las activa se ejecuta directamente en el módulo @ref{1,,__main__}. Como resultado, los desarrolladores de scripts de un solo archivo y aquellos que usan Python de forma interactiva deberían comenzar a ver una vez más advertencias de desaprobación para las API que usan, pero las advertencias de desaprobación activadas por la aplicación importada, la biblioteca y los módulos de marco seguirán ocultos de forma predeterminada.

Como resultado de este cambio, la biblioteca estándar ahora permite a los desarrolladores elegir entre tres comportamientos de advertencia de obsolescencia diferentes:


@itemize *

@item 
@ref{4d4,,FutureWarning}: siempre se muestra por defecto, recomendado para las advertencias destinadas a los usuarios finales de la aplicación (por ejemplo, para los ajustes de configuración de la aplicación obsoletos).

@item 
@ref{1da,,DeprecationWarning}: se muestra por defecto solo en @ref{1,,__main__} y cuando se ejecutan pruebas, se recomienda para advertencias destinadas a ser vistas por otros desarrolladores de Python donde una actualización de la versión puede resultar en un cambio de comportamiento o un error.

@item 
@ref{95f,,PendingDeprecationWarning}: se muestra de forma predeterminada solo cuando se ejecutan pruebas, diseñado para casos en los que una actualización de versión futura cambiará la categoría de advertencia a @ref{1da,,DeprecationWarning} o @ref{4d4,,FutureWarning}.
@end itemize

Anteriormente ambos @ref{1da,,DeprecationWarning} y @ref{95f,,PendingDeprecationWarning} solo eran visibles cuando se ejecutaban pruebas, lo que significaba que los desarrolladores que escribían principalmente scripts de un solo archivo o usaban Python de forma interactiva podrían sorprenderse al ver cambios importantes en las API que usaban.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 565

@item PEP 565@footnote{https://peps.python.org/pep-0565/} – Muestra `DeprecationWarning' en @code{__main__}

PEP escrito y implementado por `Nick Coghlan'
@end table


@node PEP 560 Soporte básico para el módulo de typing y tipos genéricos,PEP 552 Archivos pyc basados en hash,PEP 565 Mostrar DeprecationWarning en __main__,Nuevas Características
@anchor{whatsnew/3 7 pep-560-core-support-for-typing-module-and-generic-types}@anchor{b74}@anchor{whatsnew/3 7 whatsnew37-pep560}@anchor{b50}
@subsubsection PEP 560: Soporte básico para el módulo de @code{typing} y tipos genéricos


Inicialmente 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} fue diseñado de tal manera que no introduciría * ningún * cambio en el intérprete principal de CPython. Ahora escriba sugerencias y el módulo @ref{104,,typing} son ampliamente utilizados por la comunidad, por lo que se elimina esta restricción. El PEP introduce dos métodos especiales @code{__class_getitem__()} y @code{__mro_entries__}, estos métodos ahora son utilizados por la mayoría de las clases y construcciones especiales en @ref{104,,typing}. Como resultado, la velocidad de varias operaciones con tipos aumentó hasta 7 veces, los tipos genéricos se pueden usar sin conflictos de metaclase, y varios errores de larga data en el módulo @ref{104,,typing} han sido arreglados.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/} – Soporte básico para el modulo de escritura y tipos genéricos

PEP escrito y implementado por `Ivan Levkivskyi'
@end table


@node PEP 552 Archivos pyc basados en hash,PEP 545 Traducciones de Documentaciones de Python,PEP 560 Soporte básico para el módulo de typing y tipos genéricos,Nuevas Características
@anchor{whatsnew/3 7 pep-552-hash-based-pyc-files}@anchor{b75}@anchor{whatsnew/3 7 whatsnew37-pep552}@anchor{b56}
@subsubsection PEP 552: Archivos .pyc basados en hash


Python ha verificado tradicionalmente la actualización de los archivos de caché de código de bytes (es decir, archivos @code{.pyc}) comparando los metadatos de origen (marca de tiempo y tamaño de última modificación) con la fuente de metadatos guardados en el encabezado del archivo de caché cuando se generó. Si bien es efectivo, este método de invalidación tiene sus inconvenientes. Cuando las marcas de tiempo del sistema de archivos son demasiado burdas, Python puede perder las actualizaciones de origen, lo que genera confusión en el usuario. Además, tener una marca de tiempo en el archivo de caché es problemático para construir reproducibilidad@footnote{https://reproducible-builds.org/} y sistemas de construcción basados en contenido.

@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} extendiendo el formato `ppc' para permitir que el hash del archivo de origen se utilice para invalidación en lugar de la marca de tiempo de origen. Estos archivos @code{.pyc} se denominan “hash-based”. Por defecto, Python todavía usa la invalidación basada en la marca de tiempo y no genera archivos @code{.pyc} basados en has de tiempos de ejecución. Los archivos @code{.pyc} basados en hash se pueden generar con @ref{b3,,py_compile} o @ref{21,,compileall}.

Archivos @code{.pyc} basados en hash Vienen en dos variantes: marcada y no marcada. Python valida los archivos @code{.pyc} basados en hash comprobados con los archivos de origen correspondientes en tiempo de ejecución, pero no lo hace para `pycs' basados en hash no verificados. Archivos @code{.pyc} no comprobados son una optimización de rendimiento útil para entornos donde un sistema externo a Python (por ejemplo, el sistema de compilación) es responsable de mantener actualizados los archivos @code{.pyc}.

Consultar @ref{68c,,Invalidación del código de bytes en caché} para mas información.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/} – `Pycs' deterministas

PEP escrito y implementado por `Benjamin Peterson'
@end table


@node PEP 545 Traducciones de Documentaciones de Python,Modo de desarrollo de Python -X dev,PEP 552 Archivos pyc basados en hash,Nuevas Características
@anchor{whatsnew/3 7 pep-545-python-documentation-translations}@anchor{b76}@anchor{whatsnew/3 7 whatsnew37-pep545}@anchor{b5a}
@subsubsection PEP 545: Traducciones de Documentaciones de Python


@geindex Python Enhancement Proposals; PEP 545
PEP 545@footnote{https://peps.python.org/pep-0545/} describe el proceso de creación y mantenimiento de traducciones de documentación de Python.

Tres nuevas traducciones han sido agregadas:


@itemize -

@item 
Japonés: @indicateurl{https://docs.python.org/ja/}

@item 
Francés: @indicateurl{https://docs.python.org/fr/}

@item 
Coreano: @indicateurl{https://docs.python.org/ko/}
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 545

@item PEP 545@footnote{https://peps.python.org/pep-0545/} – Traducciones de Documentación de `Python'

PEP escrito y implementado por `Julien Palard', `Inada Naoki' y `Victor Stinner'.
@end table


@node Modo de desarrollo de Python -X dev,,PEP 545 Traducciones de Documentaciones de Python,Nuevas Características
@anchor{whatsnew/3 7 python-development-mode-x-dev}@anchor{b77}@anchor{whatsnew/3 7 whatsnew37-devmode}@anchor{b57}
@subsubsection Modo de desarrollo de Python (-X dev)


La nueva opción @ref{2e2,,-X} @code{dev} opción de línea de comando o la nueva variable de entorno 
@geindex PYTHONDEVMODE
@geindex variables de entorno; PYTHONDEVMODE
@ref{b78,,PYTHONDEVMODE} se puede usar para habilitar @ref{356,,Python Development Mode}. Cuando está en modo de desarrollo, Python realiza comprobaciones de tiempo de ejecución adicionales que son demasiado caras para habilitarse de forma predeterminada. Ver @ref{356,,Python Development Mode} documentación para la descripción completa.

@node Otros cambios en el lenguaje<2>,Nuevos módulos<5>,Nuevas Características,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 other-language-changes}@anchor{b79}
@subsection Otros cambios en el lenguaje



@itemize *

@item 
Una expresión @ref{14e,,await} y compresiones que contienen una cláusula @ref{b36,,async for} eran ilegales en las expresiones en @ref{a3b,,formatted string literals} debido a un problema con la implementación. En Python 3.7 se eliminó esta restricción.

@item 
Ahora se pueden pasar más de 255 argumentos a una función y una función ahora puede tener más de 255 parámetros. (Contribuido por `Serhiy Storchaka' en bpo-12844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12844} y bpo-18896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18896}.)

@item 
@ref{b7a,,bytes.fromhex()} y @ref{b7b,,bytearray.fromhex()} ahora ignore todos los espacios en blanco ASCII, no solo los espacios. (Contribuido por `Robert Xiao' en bpo-28927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28927}.)

@item 
@ref{237,,str}, @ref{325,,bytes}, y @ref{5e0,,bytearray} adquirió soporte para el nuevo método @ref{b7c,,isascii()}, que se puede usar para probar si una cadena o bytes contienen solo los caracteres ASCII. (Contribuido por `INADA Naoki' en bpo-32677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32677}.)

@item 
@ref{4d7,,ImportError} ahora muestra el nombre del módulo y la ruta del módulo @code{__file__} cuando falla @code{from … import …}. (Contribuido por `Matthias Bussonnier' en bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}.)

@item 
Ahora se admiten las importaciones circulares que involucran importaciones absolutas con un submódulo vinculado a un nombre. (Contribuido por `Serhiy Storchaka' en bpo-30024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30024}.)

@item 
@code{object.__format__(x, ‘’)} ahora es equivalente a @code{str(x)} antes que @code{format(str(self), ‘’)}. (Contribuido por `Serhiy Storchaka' en bpo-28974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28974}.)

@item 
In order to better support dynamic creation of stack traces,
@ref{b7d,,types.TracebackType} can now be instantiated from Python code, and
the @ref{b7e,,tb_next} attribute on
@ref{b7f,,tracebacks} is now writable.
(Contributed by Nathaniel J. Smith in bpo-30579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30579}.)

@item 
Al usar la @ref{187,,-m} switch, @code{sys.path[0]} ahora se expande con entusiasmo a la ruta completa del directorio de inicio, en lugar de dejarse como el directorio vacío (que permite importaciones desde el directorio de trabajo * actual * en el momento en que ocurre una importación) (Contribuido por `Nick Coghlan' en bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}.)

@item 
La nueva opción @ref{2e2,,-X} @code{importtime} o la variable de entorno 
@geindex PYTHONPROFILEIMPORTTIME
@geindex variables de entorno; PYTHONPROFILEIMPORTTIME
@ref{b80,,PYTHONPROFILEIMPORTTIME} pueden usarse para mostrar el tiempo de cada importación de módulos. (Contribuido por Inada Naoki en bpo-31415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31415}.)
@end itemize

@node Nuevos módulos<5>,Módulos mejorados<6>,Otros cambios en el lenguaje<2>,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 new-modules}@anchor{b81}
@subsection Nuevos módulos


@menu
* contextvars:: 
* dataclasses:: 
* importlib.resources: importlib resources<2>. 

@end menu

@node contextvars,dataclasses,,Nuevos módulos<5>
@anchor{whatsnew/3 7 contextvars}@anchor{b82}@anchor{whatsnew/3 7 whatsnew37-pep567}@anchor{b4b}
@subsubsection `contextvars'


El nuevo módulo @ref{25,,contextvars} y un conjunto de @ref{b83,,nuevas APIs C} introducir soporte para `variables de contexto'. Las variables de contexto son conceptualmente similares a las variables locales del proceso. A diferencia de TLS, las variables de contexto admiten l código asincrónico correctamente.

Los módulos @ref{b,,asyncio} y @ref{37,,decimal} se han actualizado para utilizar y admitir variables de contexto listas para usar. En particular, el contexto decimal activo ahora se almacena en una variable de contexto, lo que permite que las operaciones decimales funcionen con el contexto correcto en código asincrónico.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 567

@item PEP 567@footnote{https://peps.python.org/pep-0567/} – Variables de Contexto

PEP escrito y implementado por `Yury Selivanov'
@end table


@node dataclasses,importlib resources<2>,contextvars,Nuevos módulos<5>
@anchor{whatsnew/3 7 dataclasses}@anchor{b84}@anchor{whatsnew/3 7 whatsnew37-pep557}@anchor{b4c}
@subsubsection `dataclasses'


El nuevo decorador @ref{32e,,dataclass()} proporciona una forma de declarar `data classes'. Una clase de datos describe sus atributos usando anotaciones de variables de clase. Su constructor y otros métodos mágicos, como @ref{6bd,,__repr__()}, @ref{b85,,__eq__()}, y @ref{b86,,__hash__()} se generan automáticamente.

Ejemplo:

@example
@@dataclass
class Point:
    x: float
    y: float
    z: float = 0.0

p = Point(1.5, 2.5)
print(p)   # produces "Point(x=1.5, y=2.5, z=0.0)"
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 557

@item PEP 557@footnote{https://peps.python.org/pep-0557/} – Clases de Datos

PEP escrito y implementado por `Eric V. Smith'
@end table


@node importlib resources<2>,,dataclasses,Nuevos módulos<5>
@anchor{whatsnew/3 7 importlib-resources}@anchor{b87}@anchor{whatsnew/3 7 whatsnew37-importlib-resources}@anchor{b4d}
@subsubsection `importlib.resources'


The new @ref{7b,,importlib.resources} module provides several new APIs and one
new ABC for access to, opening, and reading `resources' inside packages.
Resources are roughly similar to files inside packages, but they needn’t
be actual files on the physical file system.  Module loaders can provide a
@code{get_resource_reader()} function which returns
a @ref{b88,,importlib.abc.ResourceReader} instance to support this
new API.  Built-in file path loaders and zip file loaders both support this.

Contribuido por `Barry Warsaw' y `Brett Cannon' en bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}.


@subsubheading Ver también


importlib_resources@footnote{https://importlib-resources.readthedocs.io/en/latest/}: un backport de PyPI para versiones anteriores de Python.


@node Módulos mejorados<6>,Cambios en la API C,Nuevos módulos<5>,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 improved-modules}@anchor{b89}
@subsection Módulos mejorados


@menu
* argparse: argparse<4>. 
* asyncio: asyncio<7>. 
* binascii:: 
* calendar: calendar<2>. 
* collections: collections<2>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<3>. 
* contextlib: contextlib<3>. 
* cProfile: cProfile<2>. 
* crypt:: 
* datetime: datetime<3>. 
* dbm: dbm<2>. 
* decimal: decimal<2>. 
* dis: dis<4>. 
* distutils: distutils<4>. 
* enum: enum<3>. 
* functools: functools<3>. 
* gc: gc<2>. 
* hmac: hmac<2>. 
* http.client: http client. 
* http.server: http server. 
* idlelib and IDLE:: 
* importlib: importlib<5>. 
* io: io<5>. 
* ipaddress: ipaddress<2>. 
* itertools: itertools<6>. 
* locale: locale<3>. 
* logging: logging<2>. 
* math: math<4>. 
* mimetypes: mimetypes<3>. 
* msilib:: 
* multiprocessing: multiprocessing<4>. 
* os: os<7>. 
* pathlib: pathlib<7>. 
* pdb: pdb<4>. 
* py_compile: py_compile<3>. 
* pydoc: pydoc<2>. 
* queue: queue<2>. 
* re: re<4>. 
* signal:: 
* socket: socket<2>. 
* socketserver:: 
* sqlite3: sqlite3<7>. 
* ssl: ssl<5>. 
* string:: 
* subprocess: subprocess<2>. 
* sys: sys<7>. 
* time: time<3>. 
* tkinter: tkinter<5>. 
* tracemalloc: tracemalloc<2>. 
* types: types<3>. 
* unicodedata: unicodedata<7>. 
* unittest: unittest<6>. 
* unittest.mock: unittest mock. 
* urllib.parse: urllib parse<5>. 
* uu:: 
* uuid: uuid<3>. 
* warnings: warnings<2>. 
* xml: xml<5>. 
* xml.etree: xml etree. 
* xmlrpc.server: xmlrpc server. 
* zipapp:: 
* zipfile:: 

@end menu

@node argparse<4>,asyncio<7>,,Módulos mejorados<6>
@anchor{whatsnew/3 7 argparse}@anchor{b8a}
@subsubsection `argparse'


El nuevo método @ref{b8b,,ArgumentParser.parse_intermixed_args()} permite permite entremezclar opciones y argumentos posicionales. (Contribuido por `paul.j3' en bpo-14191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14191}.)

@node asyncio<7>,binascii,argparse<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 asyncio}@anchor{b8c}@anchor{whatsnew/3 7 whatsnew37-asyncio}@anchor{b52}
@subsubsection `asyncio'


El modulo @ref{b,,asyncio} ha recibido muchas funciones nuevas, usabilidad y @ref{b8d,,mejoras de rendimiento}. Los cambios notables incluyen:


@itemize *

@item 
La nueva función @ref{b8e,,provisional} @ref{525,,asyncio.run()} se puede utilizar para ejecutar una corrutina desde código síncrono creando y destruyendo automáticamente el bucle de eventos. (Contribuido por `Yury Selivanov' en bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}.)

@item 
asyncio adquirió soporte para @ref{25,,contextvars}. @ref{b8f,,loop.call_soon()}, @ref{b90,,loop.call_soon_threadsafe()}, @ref{b91,,loop.call_later()}, @ref{b92,,loop.call_at()}, y @ref{b93,,Future.add_done_callback()} tener un nuevo parámetro opcional * de contexto * solo de palabras clave. @ref{580,,Tasks} ahora rastrea su contexto automáticamente. Ver 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mas detalles. (Contribuido por `Yury Selivanov' en bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}.)

@item 
La nueva función @code{asyncio.create_task`se ha agregado como un atajo a `@w{`}asyncio.get_event_loop().create_task()`()}. (Contribuido por `Andrew Svetlov' en bpo-32311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32311}.)

@item 
El nuevo método @ref{b94,,loop.start_tls()} puede ser usado para actualizar una conexión existente para TLS. (Contribuido por `Yury Selivanov' en bpo-23749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23749}.)

@item 
El nuevo método @ref{b95,,loop.sock_recv_into()} permite leer datos de un socket directamente en un búfer proporcionado, lo que permite reducir las copias de datos. (Contribuido por `Antoine Pitrou' en bpo-31819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31819}.)

@item 
The new @ref{526,,asyncio.current_task()} function returns the currently running
@ref{580,,Task} instance, and the new @ref{9e9,,asyncio.all_tasks()}
function returns a set of all existing @code{Task} instances in a given loop.
The @code{Task.current_task()} and
@code{Task.all_tasks()} methods have been deprecated.
(Contributed by Andrew Svetlov in bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250}.)

@item 
La nueva clase `provisional' @ref{b28,,BufferedProtocol} permite implementar protocolos de transmisión con control manual sobre el búfer de recepción. (Contribuido por `Yury Selivanov' en bpo-32251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32251}.)

@item 
La nueva función @ref{b96,,asyncio.get_running_loop()} devuelve el bucle que se está ejecutando actualmente, y genera un @ref{1e5,,RuntimeError} si el bucle esta corriendo. Esto contrasta con @ref{214,,asyncio.get_event_loop()}, que * creará * un nuevo bucle de eventos si no se está ejecutando ninguno. (Contribuido por `Yury Selivanov' en bpo-32269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32269}.)

@item 
El nuevo método de rutina @ref{b97,,StreamWriter.wait_closed()} permite esperar hasta que se cierre el escritor de secuencias. El nuevo método @ref{b98,,StreamWriter.is_closing()} puede ser usado para determinar si el escritor esta cerrando. (Contribuido por `Andrew Svetlov' en bpo-32391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32391}.)

@item 
El nuevo método de rutina @ref{b99,,loop.sock_sendfile()} permite enviar archivos usando @ref{b9a,,os.sendfile} cuando sea posible. (Contribuido por `Andrew Svetlov' en bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}.)

@item 
El nuevo método @ref{b9b,,Future.get_loop()} y @code{Task.get_loop()} devuelve la instancia del bucle en el que se creó una tarea o un futuro. @ref{b9c,,Server.get_loop()} permite hacer lo mismo para objetos de @ref{b9d,,asyncio.Server}. (Contribuido por `Yury Selivanov' en bpo-32415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32415} y `Srinivas Reddy Thatiparthy' en bpo-32418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32418}.)

@item 
Ahora es posible controlar las instancias de @ref{b9d,,asyncio.Server} cuando comienzan. Anteriormente, el servidor comenzaba a funcionar inmediatamente cuando se creaba. El nuevo argumento de palabra clave `start_serving' para @ref{b9e,,loop.create_server()} y @ref{315,,loop.create_unix_server()}, así como @ref{b9f,,Server.start_serving()}, y @ref{ba0,,Server.serve_forever()} se puede usar para desacoplar la instanciación y el servicio de servidor. El nuevo método @ref{ba1,,Server.is_serving()} devuelve @code{True} si el servidor esta iniciando. @ref{b9d,,Server} los objetos ahora son administradores de contexto asíncronos:

@example
srv = await loop.create_server(...)

async with srv:
    # some code

# At this point, srv is closed and no longer accepts new connections.
@end example

(Contribuido por `Yury Selivanov' en bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}.)

@item 
Objetos de devolución de llamada devueltos por @ref{b91,,loop.call_later()} conseguir el nuevo método @ref{ba2,,when()} que devuelve una marca de tiempo de devolución de llamada programada absoluta. (Contribuido por `Andrew Svetlov' en bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}.)

@item 
El método @ref{7cf,,loop.create_datagram_endpoint()} adquirió soporte para `sockets' `UNIX'.(Contribuido por `Quentin Dawans' en bpo-31245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31245}.)

@item 
Los métodos @ref{ba3,,asyncio.open_connection()}, @ref{ba4,,asyncio.start_server()} functions, @ref{6a4,,loop.create_connection()}, @ref{b9e,,loop.create_server()}, @code{loop.create_accepted_socket() <asyncio.loop.connect_accepted_socket>`y sus correspondientes variantes de socket UNIX ahora aceptan el argumento de palabra clave *ssl_handshake_timeout*. (Contribuido por *Neil Aspinall* en :issue:`29970()}.)

@item 
El nuevo método @ref{ba5,,Handle.cancelled()} devuelve @code{True} si se canceló la devolución de llamada. (Contribuido por `Marat Sharafutdinov' en bpo-31943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31943}.)

@item 
La fuente asyncio se ha convertido para utilizar la sintaxis @ref{7ce,,async}/@ref{14e,,await}. (Contribuido por `Andrew Svetlov' en bpo-32193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32193}.)

@item 
El nuevo método @ref{ba6,,ReadTransport.is_reading()} puede ser usado para determinar el estado de lectura del transporte. Adicionalmente, las llamadas a @ref{ba7,,ReadTransport.resume_reading()} y @ref{ba8,,ReadTransport.pause_reading()} ahora son idempotentes. (Contribuido por `Yury Selivanov' en bpo-32356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32356}.)

@item 
Los métodos de bucle que aceptan rutas de socket ahora admiten el paso @ref{3f0,,objetos con forma de ruta}. (Contribuido por `Yury Selivanov' en bpo-32066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32066}.)

@item 
En @ref{b,,asyncio}, los sockets TCP en Linux ahora son creados con el indicador @code{TCP_NODELAY} configurado por defecto. (Contribuido por `Yury Selivanov' y `Victor Stinner' en bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}.)

@item 
Las excepciones que ocurren en tareas canceladas ya no se registran. (Contribuido por `Yury Selivanov' en bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}.)

@item 
Nuevas clases @code{WindowsSelectorEventLoopPolicy} y @code{WindowsProactorEventLoopPolicy}. (Contribuido por `Yury Selivanov' en bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}.)
@end itemize

Varias APIs @code{asyncio} se han @ref{ba9,,obsoleta}.

@node binascii,calendar<2>,asyncio<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 binascii}@anchor{baa}
@subsubsection `binascii'


La función @ref{bab,,b2a_uu()} ahora acepta un argumento de palabra clave opcional `backtick'. Cuando es cierto, los ceros están representados por @code{’`’} en lugar de espacios. (Contribuido por `Xiang Zhang' en bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103}.)

@node calendar<2>,collections<2>,binascii,Módulos mejorados<6>
@anchor{whatsnew/3 7 calendar}@anchor{bac}
@subsubsection `calendar'


La clase @code{ (Contribuido por *Oz Tiram* en :issue:`30095}.)

@node collections<2>,compileall<2>,calendar<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 collections}@anchor{bad}
@subsubsection `collections'


@code{collections.namedtuple()} ahora soporta valores por defecto. (Contribuido por `Raymond Hettinger' en bpo-32320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32320}.)

@node compileall<2>,concurrent futures<3>,collections<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 compileall}@anchor{bae}
@subsubsection `compileall'


@ref{baf,,compileall.compile_dir()} aprendió el nuevo parámetro `invalidation_mode', que se puede utilizar para habilitar @ref{b56,,invalidación de .pyc basada en hash}. El modo de invalidación también se puede especificar en la línea de comando usando el nuevo argumento @code{—invalidation-mode}. (Contribuido por `Benjamin Peterson' en bpo-31650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31650}.)

@node concurrent futures<3>,contextlib<3>,compileall<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 concurrent-futures}@anchor{bb0}
@subsubsection `concurrent.futures'


@ref{163,,ProcessPoolExecutor} y @ref{7dd,,ThreadPoolExecutor} ahora soporta los nuevos argumentos de constructor `initializer' y `initargs'. (Contribuido por `Antoine Pitrou' en bpo-21423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21423}.)

La @ref{163,,ProcessPoolExecutor} puede ahora tomar el contexto de multiprocesamiento a través del nuevo argumento `mp_context'. (Contribuido por `Thomas Moreau' en bpo-31540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31540}.)

@node contextlib<3>,cProfile<2>,concurrent futures<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 contextlib}@anchor{bb1}
@subsubsection `contextlib'


El nuevo @ref{885,,nullcontext()} es un administrador de contexto sin operaciones simple y rápido que @ref{bb2,,ExitStack}. (Contribuido por `Jesse-Bakker' en bpo-10049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10049}.)

Se han añadido los nuevos @ref{bb3,,asynccontextmanager()}, @ref{bb4,,AbstractAsyncContextManager}, y @ref{bb5,,AsyncExitStack} para complementar sus partes sincronicas. (Contribuido por `Jelle Zijlstra' en bpo-29679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29679} y bpo-30241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30241}, y por `Alexander Mohr' y `Ilya Kulakov' en bpo-29302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29302}.)

@node cProfile<2>,crypt,contextlib<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 cprofile}@anchor{bb6}
@subsubsection `cProfile'


La linea de comandos @ref{28,,cProfile} ahora acepta @code{-m module_name} como alternativa a la ruta del `script'. (Contribuido por `Sanyam Khurana' en bpo-21862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21862}.)

@node crypt,datetime<3>,cProfile<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 crypt}@anchor{bb7}
@subsubsection `crypt'


The @code{crypt} module now supports the Blowfish hashing method.
(Contributed by Serhiy Storchaka in bpo-31664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31664}.)

The @code{mksalt()} function now allows specifying the number of rounds
for hashing.  (Contributed by Serhiy Storchaka in bpo-31702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31702}.)

@node datetime<3>,dbm<2>,crypt,Módulos mejorados<6>
@anchor{whatsnew/3 7 datetime}@anchor{bb8}
@subsubsection `datetime'


Los nuevos objetos @ref{6b7,,datetime.fromisoformat()} un método constructor @ref{32f,,datetime} de una cadena en uno de los formatos de salida de @ref{bb9,,datetime.isoformat()}. (Contribuido por `Paul Ganssle' en bpo-15873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15873}.)

La clase @ref{67f,,tzinfo} ahora admite compensaciones de subminutos. (Contribuido por `Alexander Belopolsky' en bpo-5288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5288}.)

@node dbm<2>,decimal<2>,datetime<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 dbm}@anchor{bba}
@subsubsection `dbm'


@ref{33,,dbm.dumb} ahora admite la lectura de archivos de solo lectura y ya no escribe el archivo de índice cuándo no se cambia.

@node decimal<2>,dis<4>,dbm<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 decimal}@anchor{bbb}
@subsubsection `decimal'


El módulo @ref{37,,decimal} ahora usa @ref{b4b,,variables de contexto} para almacenar el contexto decimal. (Contribuido por `Yury Selivanov' en bpo-32630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32630}.)

@node dis<4>,distutils<4>,decimal<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 dis}@anchor{bbc}
@subsubsection `dis'


La función @ref{172,,dis()} ahora puede desensamblar objetos de código anidados (el código de comprensiones, expresiones generadoras y funciones anidadas, y el código utilizado para construir clases anidadas). La profundidad máxima de la recursividad de desmontaje se controla mediante el nuevo parámetro * profundidad `. (Contribuido por *Serhiy Storchaka' en bpo-11822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11822}.)

@node distutils<4>,enum<3>,dis<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 distutils}@anchor{bbd}
@subsubsection `distutils'


@code{README.rst} ahora se incluye en la lista de READMEs estándar de distutils y, por lo tanto, se incluye en las distribuciones de código fuente. (Contribuido por `Ryan Gonzalez' en bpo-11913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11913}.)

@node enum<3>,functools<3>,distutils<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 enum}@anchor{bbe}
@subsubsection `enum'


La @ref{6d1,,Enum} aprendió la nueva propiedad de clase @code{_ignore_}, que permite enumerar los nombres de propiedades que no deben convertirse en miembros de enumeración. (Contribuido por `Ethan Furman' en bpo-31801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31801}.)

En Python 3.8, intentar buscar objetos que no sean Enum en @code{Enum} lanzará un @ref{228,,TypeError} (por ejemplo, @code{1 in Color}); de manera similar, si se intenta buscar objetos que no sean Flag en un miembro @code{Flag} se lanzará @ref{228,,TypeError} (por ejemplo, @code{1 in Perm.RW}); actualmente, ambas operaciones devuelven @ref{bbf,,False} en su lugar y están obsoletas.

@node functools<3>,gc<2>,enum<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 functools}@anchor{bc0}
@subsubsection `functools'


@ref{6da,,functools.singledispatch()} ahora admite el registro de implementaciones mediante anotaciones de tipo. (Contribuido por `Łukasz Langa' en bpo-32227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32227}.)

@node gc<2>,hmac<2>,functools<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 gc}@anchor{bc1}
@subsubsection `gc'


La nueva función @ref{bc2,,gc.freeze()} permite congelar todos los objetos rastreados por el recolector de basura y excluirlos de colecciones futuras. Esto se puede utilizar antes de llamar POSIX @code{fork()} para hacer que la copia en escritura de GC sea amigable o para acelerar la recopilación. La nuevas funciones @ref{bc3,,gc.unfreeze()} revierten esta operación. Además, @ref{bc4,,gc.get_freeze_count()} se puede utilizar para obtener el número de objetos congelados. (Contribuido por `Li Zekun' en bpo-31558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31558}.)

@node hmac<2>,http client,gc<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 hmac}@anchor{bc5}
@subsubsection `hmac'


El módulo @ref{6a,,hmac} ahora tiene una función one-shot optimizada @ref{bc6,,digest()}, que es hasta tres veces más rápida que @code{HMAC()}.

@node http client,http server,hmac<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 http-client}@anchor{bc7}
@subsubsection `http.client'


@ref{bc8,,HTTPConnection} y @ref{bc9,,HTTPSConnection} ahora admite el nuevo argumento * tamaño de bloque * para mejorar el rendimiento de carga. (Contribuido por `Nir Soffer' en bpo-31945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31945}.)

@node http server,idlelib and IDLE,http client,Módulos mejorados<6>
@anchor{whatsnew/3 7 http-server}@anchor{bca}
@subsubsection `http.server'


@ref{bcb,,SimpleHTTPRequestHandler} ahora admite el encabezado HTTP @code{If-Modified-Since}. El servidor devuelve el estado de respuesta 304 si el archivo de destino no se modificó después del tiempo especificado en el encabezado. (Contribuido por `Pierre Quentel' en bpo-29654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29654}.)

@ref{bcb,,SimpleHTTPRequestHandler} acepta el nuevo argumento `directorio', además del nuevo argumento de línea de comando @code{—directory}. Con este parámetro, el servidor sirve el directorio especificado, por defecto usa el directorio de trabajo actual. (Contribuido por `Stéphane Wirtel' y `Julien Palard' en bpo-28707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28707}.)

La nueva clase @ref{bcc,,ThreadingHTTPServer} usa procesos para manejar solicitudes usando @code{ThreadingMixin}. Se usa cuando se ejecuta @code{http.server} con @code{-m}. (Contribuido por `Julien Palard' en bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}.)

@node idlelib and IDLE,importlib<5>,http server,Módulos mejorados<6>
@anchor{whatsnew/3 7 idlelib-and-idle}@anchor{bcd}
@subsubsection `idlelib and IDLE'


Varias correcciones para autocompletar. (Contribuido por `Louie Lu' en bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}.)

El Explorador de módulos (en el menú Archivo, antes llamado Explorador de clases), ahora muestra funciones y clases anidadas además de funciones y clases de nivel superior. (Contribuido por `Guilherme Polo', `Cheryl Sabella', y `Terry Jan Reedy' en bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}.)

El cuadro de diálogo Configuración (Opciones, Configurar IDLE) se ha reescrito parcialmente para mejorar tanto la apariencia como la función. (Contribuido por `Cheryl Sabella' y `Terry Jan Reedy' en múltiple issues.)

La muestra de fuente ahora incluye una selección de caracteres no latinos para que los usuarios puedan ver mejor el efecto de seleccionar una fuente en particular. (Contribuido por `Terry Jan Reedy' en bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}.). La muestra se puede editar para incluir otros caracteres. (Contribuido por `Serhiy Storchaka' en bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}.)

Las funciones IDLE implementadas anteriormente como extensiones se han vuelto a implementar como funciones normales. Su configuración se ha movido de la pestaña Extensiones a otras pestañas de diálogo. (Contribuido por `Charles Wohlganger' y `Terry Jan Reedy' en bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}.)

Se revisó la opción de contexto del código del editor. El cuadro muestra todas las líneas de contexto hasta las líneas máximas. Al hacer clic en una línea de contexto, el editor pasa a esa línea. Los colores de contexto para temas personalizados se agregan a la pestaña Destacados del cuadro de diálogo Configuración. (Contribuido por `Cheryl Sabella' y `Terry Jan Reedy' en bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}, bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}, y bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}.)

En Windows, una nueva llamada a la API le dice a Windows que tk escala para DPI. En Windows 8.1+ o 10, con las propiedades de compatibilidad de DPI del binario de Python sin cambios y una resolución de monitor superior a 96 DPI, esto debería hacer que el texto y las líneas sean más nítidos. De lo contrario, no debería tener ningún efecto. (Contribuido por `Terry Jan Reedy' en bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}.)

Nuevo en 3.7.1:

La salida sobre N líneas (50 por defecto) se reduce a un botón. N se puede cambiar en la sección PyShell de la página General del cuadro de diálogo Configuración. Se pueden comprimir menos líneas, pero posiblemente más largas, haciendo clic derecho en la salida. La salida comprimida se puede expandir en su lugar haciendo doble clic en el botón o en el portapapeles o en una ventana separada haciendo clic derecho en el botón. (Contribuido por `Tal Einat' en bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

Los cambios anteriores se han actualizado a las versiones de mantenimiento 3.6.

Nuevo en 3.7.4:

Agregado “Run Customized” al menú Correr para ejecutar un módulo con configuraciones personalizadas. Cualquier argumento de línea de comando ingresado se agrega a sys.argv. Vuelven a aparecer en el cuadro para la siguiente ejecución personalizada. También se puede suprimir el reinicio normal del módulo principal de Shell. (Contribuidor por `Cheryl Sabella', `Terry Jan Reedy', y otros en bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} y bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}.)

Nuevo en 3.7.5:

Agregue números de línea opcionales para las ventanas del editor IDLE. Las ventanas se abren sin números de línea a menos que se establezca lo contrario en la pestaña General del cuadro de diálogo de configuración. Los números de línea de una ventana existente se muestran y ocultan en el menú Opciones. (Contribuido por `Tal Einat' y `Saimadhav Heblikar' en bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}.)

@node importlib<5>,io<5>,idlelib and IDLE,Módulos mejorados<6>
@anchor{whatsnew/3 7 importlib}@anchor{bce}
@subsubsection `importlib'


El @ref{b88,,importlib.abc.ResourceReader} ABC se introdujo para admitir la carga de recursos desde paquetes. Ver también @ref{b4d,,importlib.resources}. (Contribuido por `Barry Warsaw', `Brett Cannon' en bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}.)

@ref{5bd,,importlib.reload()} ahora mejora @ref{bcf,,ModuleNotFoundError} si el módulo carece de especificación. (Contribuido por `Garvit Khatri' en bpo-29851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29851}.)

@code{importlib.find_spec()} ahora mejora @ref{bcf,,ModuleNotFoundError} en lugar de @ref{441,,AttributeError} si el modulo principal especifico no ese un paquete (es decir, carece de un atributo @code{__path__}). (Contribuido por `Milan Oberkirch' en bpo-30436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30436}.)

La nueva @code{importlib.source_hash()} se puede utilizar para calcular el hash de la fuente pasada. Un @ref{b56,,archivo .pyc basado en hash} incrusta el valor devuelto por esta función.

@node io<5>,ipaddress<2>,importlib<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 io}@anchor{bd0}
@subsubsection `io'


El nuevo método @ref{bd1,,TextIOWrapper.reconfigure()} se puede utilizar para reconfigurar el flujo de texto con la nueva configuración. (Contribuido por `Antoine Pitrou' en bpo-30526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30526} y `INADA Naoki' en bpo-15216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15216}.)

@node ipaddress<2>,itertools<6>,io<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 ipaddress}@anchor{bd2}
@subsubsection `ipaddress'


Los nuevos métodos @code{subnet_of()} y @code{supernet_of()} de @ref{35d,,ipaddress.IPv6Network} y @ref{35c,,ipaddress.IPv4Network} pueden ser usados para pruebas de contención de redes. (Contribuido por `Michel Albert' y `Cheryl Sabella' en bpo-20825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20825}.)

@node itertools<6>,locale<3>,ipaddress<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 itertools}@anchor{bd3}
@subsubsection `itertools'


@ref{bd4,,itertools.islice()} ahora acepta @ref{22b,,integer-like objects} como argumentos de inicio, parada y corte. (Contribuido por `Will Roberts' en bpo-30537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30537}.)

@node locale<3>,logging<2>,itertools<6>,Módulos mejorados<6>
@anchor{whatsnew/3 7 locale}@anchor{bd5}
@subsubsection `locale'


El nuevo argumento * monetario * para @ref{5c2,,locale.format_string()} se puede utilizar para hacer que la conversión utilice separadores de miles monetarios y cadenas de agrupación. (Contribuido por `Garvit' en bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}.)

La función @ref{5dc,,locale.getpreferredencoding()} ahora siempre devuelve @code{’UTF-8’} en Android o cuando está en el @ref{b55,,modo UTF-8 forzado}.

@node logging<2>,math<4>,locale<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 logging}@anchor{bd6}
@subsubsection `logging'


@ref{bd7,,Logger} instancias ahora pueden ser decapadas. (Contribuido por `Vinay Sajip' en bpo-30520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30520}.)

El nuevo método @ref{bd8,,StreamHandler.setStream()} se puede utilizar para reemplazar la secuencia del registrador después de la creación del controlador. (Contribuido por `Vinay Sajip' en bpo-30522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30522}.)

Ahora es posible especificar argumentos de palabras clave para los constructores de manejadores en la configuración pasada a @ref{bd9,,logging.config.fileConfig()}. (Contribuido por `Preston Landers' en bpo-31080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31080}.)

@node math<4>,mimetypes<3>,logging<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 math}@anchor{bda}
@subsubsection `math'


La nueva función @ref{bdb,,math.remainder()} implementa la operación de resto de estilo IEEE 754. (Contribuido por `Mark Dickinson' en bpo-29962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29962}.)

@node mimetypes<3>,msilib,math<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 mimetypes}@anchor{bdc}
@subsubsection `mimetypes'


El tipo MIME de .bmp se ha cambiado de @code{’image/x-ms-bmp’} a @code{’image/bmp’}. (Contribuido por `Nitish Chandra' en bpo-22589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22589}.)

@node msilib,multiprocessing<4>,mimetypes<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 msilib}@anchor{bdd}
@subsubsection `msilib'


The new @code{Database.Close()} method can be used
to close the @abbr{MSI} database.
(Contributed by Berker Peksag in bpo-20486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20486}.)

@node multiprocessing<4>,os<7>,msilib,Módulos mejorados<6>
@anchor{whatsnew/3 7 multiprocessing}@anchor{bde}
@subsubsection `multiprocessing'


El nuevo método @ref{bdf,,Process.close()} cierra explícitamente el objeto de proceso y libera todos los recursos asociados con él. @ref{360,,ValueError} se genera si el proceso subyacente aún se está ejecutando. (Contribuido por `Antoine Pitrou' en bpo-30596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30596}.)

El nuevo método @ref{be0,,Process.kill()} se puede usar para terminar el proceso usando la señal @code{SIGKILL} en Unix. (Contribuido por `Vitor Pereira' en bpo-30794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30794}.)

Subprocesos no demoníacos creados por @ref{be1,,Process} ahora se unen al salir del proceso. (Contribuido por `Antoine Pitrou' en bpo-18966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18966}.)

@node os<7>,pathlib<7>,multiprocessing<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 os}@anchor{be2}
@subsubsection `os'


@ref{be3,,os.fwalk()} ahora acepta el argumento `path' como @ref{325,,bytes}. (Contribuido por `Serhiy Storchaka' en bpo-28682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28682}.)

@ref{1a2,,os.scandir()} obtuvo soporte de @ref{be4,,descriptores de archivo}. (Contribuido por `Serhiy Storchaka' en bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}.)

La nueva función  @ref{1f8,,register_at_fork()} permite registrar devoluciones de llamada de Python para que se ejecuten en la bifurcación del proceso. (Contribuido por `Antoine Pitrou' en bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

Agrega funciones @ref{be5,,os.preadv()} (combinando la funcionalidad de @ref{be6,,os.readv()} y @ref{be7,,os.pread()}) y @ref{be8,,os.pwritev()} (combinando la funcionalidad de @ref{be9,,os.writev()} y @ref{bea,,os.pwrite()}). (Contribuido por `Pablo Galindo' en bpo-31368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31368}.)

El argumento de modo de @ref{37b,,os.makedirs()} ya no afecta los bits de permiso de archivo de los directorios de nivel intermedio recién creados. (Aportado por Serhiy Storchaka en bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}.)

@ref{beb,,os.dup2()} ahora retorna el nuevo descriptor de archivo. Previamente, @code{None} siempre fue retornado. (Contribuido por `Benjamin Peterson' en bpo-32441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32441}.)

La estructura retornada por @ref{548,,os.stat()} ahora contiene el atributo  @ref{bec,,st_fstype} en Solaris y sus derivados. (Contribuido por `Jesús Cea Avión' en bpo-32659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32659}.)

@node pathlib<7>,pdb<4>,os<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 pathlib}@anchor{bed}
@subsubsection `pathlib'


El nuevo método @ref{aa9,,Path.is_mount()} ahora está disponible en los sistemas POSIX y se puede utilizar para determinar si una ruta es un punto de montaje. (Contribuido por `Cooper Ry Lees' en bpo-30897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30897}.)

@node pdb<4>,py_compile<3>,pathlib<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 pdb}@anchor{bee}
@subsubsection `pdb'


@ref{1a7,,pdb.set_trace()} ahora toma un argumento opcional `header' solo de palabra clave. Si se proporciona, se imprime en la consola justo antes de que comience la depuración. (Contribuido por `Barry Warsaw' en bpo-31389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31389}.)

@ref{a5,,pdb} la línea de comando ahora acepta @code{-m module_name} como una alternativa al archivo de script. (Contribuido por `Mario Corchero' en bpo-32206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32206}.)

@node py_compile<3>,pydoc<2>,pdb<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 py-compile}@anchor{bef}
@subsubsection `py_compile'


@ref{ab7,,py_compile.compile()} — y por extensión, @ref{21,,compileall} — ahora respeta la variable de entorno 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} creando incondicionalmente archivos @code{.pyc} para la validación basada en hash. Esto permite garantizar compilaciones reproducibles@footnote{https://reproducible-builds.org/} de archivos @code{.pyc} cuando se crean con entusiasmo. (Contribuido por `Bernhard M. Wiedemann' en bpo-29708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29708}.)

@node pydoc<2>,queue<2>,py_compile<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 pydoc}@anchor{bf0}
@subsubsection `pydoc'


El servidor `pydoc' ahora puede vincularse a un nombre de host arbitrario especificado por el nuevo argumento de línea de comandos @code{-n}. (Contribuido por `Feanil Patel' en bpo-31128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31128}.)

@node queue<2>,re<4>,pydoc<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 queue}@anchor{bf1}
@subsubsection `queue'


La nueva clase @ref{bf2,,SimpleQueue} es una cola ilimitada @abbr{FIFO}. (Contribuido por `Antoine Pitrou' en bpo-14976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14976}.)

@node re<4>,signal,queue<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 re}@anchor{bf3}
@subsubsection `re'


Las banderas @ref{6cd,,re.ASCII}, @ref{bf4,,re.LOCALE} y @ref{bf5,,re.UNICODE} se pueden establecer dentro del alcance de un grupo. (Contribuido por `Serhiy Storchaka' en bpo-31690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31690}.)

@ref{3f1,,re.split()} ahora admite la división en un patrón como @code{r’\b’}, @code{’^$’} or @code{(?=-)} que coincide con una cadena vacía. (Contribuido por `Serhiy Storchaka' en bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054}.)

Las expresiones regulares compiladas con el indicador @ref{bf4,,re.LOCALE} ya no dependen de la configuración regional en el momento de la compilación. La configuración regional se aplica solo cuando se utiliza la expresión regular compilada. (Contribuido por `Serhiy Storchaka' en bpo-30215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30215}.)

@ref{4d4,,FutureWarning} ahora se emite si una expresión regular contiene construcciones de conjuntos de caracteres que cambiarán semánticamente en el futuro, como conjuntos anidados y operaciones de conjuntos. (Contribuido por `Serhiy Storchaka' en bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}.)

Las expresiones regulares compiladas y los objetos coincidentes ahora se pueden copiar usando @ref{5d7,,copy.copy()} y @ref{bf6,,copy.deepcopy()}. (Contribuido por `Serhiy Storchaka' en bpo-10076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10076}.)

@node signal,socket<2>,re<4>,Módulos mejorados<6>
@anchor{whatsnew/3 7 signal}@anchor{bf7}
@subsubsection `signal'


El nuevo argumento * warn_on_full_buffer * para la función @ref{bf8,,signal.set_wakeup_fd()} permite especificar si Python imprime una advertencia en `stderr' cuando el búfer de activación se desborda. (Contribuido por `Nathaniel J. Smith' en bpo-30050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30050}.)

@node socket<2>,socketserver,signal,Módulos mejorados<6>
@anchor{whatsnew/3 7 socket}@anchor{bf9}
@subsubsection `socket'


El nuevo método @ref{bfa,,socket.getblocking()} retorna @code{True} si el socket esta en modo bloqueo y @code{False} en caso contrario. (Contribuido por `Yury Selivanov' en bpo-32373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32373}.)

La nueva función @ref{bfb,,socket.close()} cierra el descriptor de archivo de socket pasado. Esta función debe usarse en lugar de @ref{bfc,,os.close()} para una mejor compatibilidad entre plataformas. (Contribuido por `Christian Heimes' en bpo-32454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32454}.)

The @ref{cc,,socket} module now exposes the @code{socket.TCP_CONGESTION}
(Linux 2.6.13), @code{socket.TCP_USER_TIMEOUT} (Linux 2.6.37), and
@code{socket.TCP_NOTSENT_LOWAT} (Linux 3.12) constants.
(Contributed by Omar Sandoval in bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273} and
Nathaniel J. Smith in bpo-29728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29728}.)

Support for @ref{bfd,,socket.AF_VSOCK} sockets has been added to allow
communication between virtual machines and their hosts.
(Contributed by Cathy Avery in bpo-27584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27584}.)

Los sockets ahora detectan automáticamente la familia, el tipo y el protocolo del descriptor de archivo de forma predeterminada. (Contribuido por `Christian Heimes' en bpo-28134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28134}.)

@node socketserver,sqlite3<7>,socket<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 socketserver}@anchor{bfe}
@subsubsection `socketserver'


@code{socketserver.ThreadingMixIn.server_close()} ahora espera hasta que se completen todos los subprocesos que no son demonios. @code{socketserver.ForkingMixIn.server_close()} ahora espera hasta que se completen todos los procesos secundarios.

Agregue un nuevo atributo de clase @code{socketserver.ForkingMixIn.block_on_close} a las clases @ref{bff,,socketserver.ForkingMixIn} y @ref{c00,,socketserver.ThreadingMixIn}. Establece el atributo de clase en @code{False} para obtener el comportamiento anterior a 3.7.

@node sqlite3<7>,ssl<5>,socketserver,Módulos mejorados<6>
@anchor{whatsnew/3 7 sqlite3}@anchor{c01}
@subsubsection `sqlite3'


@ref{39e,,sqlite3.Connection} ahora expone el método @ref{c02,,backup()} cuando la biblioteca SQLite subyacente está en la versión 3.6.11 o superior. (Contribuido por `Lele Gaifax' en bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}.)

El argumento * base de datos * de @ref{3f5,,sqlite3.connect()} ahora acepta cualquier @ref{3f0,,path-like object}, en lugar de solo una cadena. (Contribuido por `Anders Lorentsen' en bpo-31843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31843}.)

@node ssl<5>,string,sqlite3<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 ssl}@anchor{c03}
@subsubsection `ssl'


El módulo @ref{d0,,ssl} ahora usa la API integrada de OpenSSL en lugar de @code{match_hostname()} para comprobar un nombre de host o una dirección IP. Los valores se validan durante el protocolo de enlace TLS. Cualquier error de validación de certificado, incluida la falla en la verificación del nombre de host, ahora aumenta @ref{c04,,SSLCertVerificationError} y aborta el protocolo de enlace con un mensaje de alerta TLS adecuado. La nueva excepción contiene información adicional. La validación del nombre de host se puede personalizar con @ref{c05,,SSLContext.hostname_checks_common_name}. (Contribuido por `Christian Heimes' en bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}.)

@cartouche
@quotation Nota 
La verificación mejorada del nombre de host requiere una implementación `libssl' compatible con OpenSSL 1.0.2 o 1.1. En consecuencia, OpenSSL 0.9.8 y 1.0.1 ya no son compatibles (consulte @ref{c06,,Eliminación de soporte de plataforma} para más detalles). El módulo ssl es principalmente compatible con LibreSSL 2.7.2 y versiones posteriores.
@end quotation
@end cartouche

El módulo @code{ssl} ya no envía direcciones IP en la extensión SNI TLS. (Contribuido por `Christian Heimes' en bpo-32185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32185}.)

@code{match_hostname()} ya no admite comodines parciales como @code{www*.example.org}. (Contribuido por `Mandeep Singh' en bpo-23033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23033} y `Christian Heimes' en bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}.)

La selección del conjunto de cifrado predeterminado del módulo @code{ssl} ahora usa un enfoque de lista negra en lugar de una lista blanca codificada. Python ya no vuelve a habilitar los cifrados que han sido bloqueados por las actualizaciones de seguridad de OpenSSL. La selección del conjunto de cifrado predeterminado se puede configurar en tiempo de compilación. (Contribuido por `Christian Heimes' en bpo-31429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31429}.)

Ahora se admite la validación de certificados de servidor que contienen nombres de dominio internacionalizados (IDN). Como parte de este cambio, el atributo @ref{c07,,SSLSocket.server_hostname} ahora almacena el nombre de host esperado en forma de etiqueta A (@code{”xn--pythn-mua.org”}), en lugar de la forma de etiqueta U (@code{”pythön.org”}). (Contribuido por `Nathaniel J. Smith' y `Christian Heimes' en bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}.)

El módulo @code{ssl} tiene soporte preliminar y experimental para TLS 1.3 y OpenSSL 1.1.1. En el momento del lanzamiento de Python 3.7.0, OpenSSL 1.1.1 todavía está en desarrollo y TLS 1.3 aún no se ha finalizado. El protocolo y el protocolo de enlace TLS 1.3 se comportan de forma ligeramente diferente a TLS 1.2 y versiones anteriores, consulte @ref{c08,,TLS 1.3}. (Contribuido por `Christian Heimes' en bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}, bpo-20995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20995}, bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}, bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622} y bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618})

@ref{981,,SSLSocket} y @ref{c09,,SSLObject} ya no tiene un constructor público. La creación de instancias directa nunca fue una característica documentada y compatible. Las instancias deben crearse con métodos @ref{1fa,,SSLContext} @ref{5c8,,wrap_socket()} y @ref{c0a,,wrap_bio()}. (Contribuido por `Christian Heimes' en bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951})

Las API de OpenSSL 1.1 para configurar la versión mínima y máxima del protocolo TLS están disponibles como @ref{907,,SSLContext.minimum_version} y @ref{908,,SSLContext.maximum_version}. Los protocolos admitidos se indican mediante varios indicadores nuevos, como @ref{c0b,,HAS_TLSv1_1}. (Contribuido por `Christian Heimes' en bpo-32609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32609}.)

Added @ref{ac3,,ssl.SSLContext.post_handshake_auth} to enable and
@ref{ac4,,ssl.SSLSocket.verify_client_post_handshake()} to initiate TLS 1.3
post-handshake authentication.
(Contributed by Christian Heimes in gh-78851@footnote{https://github.com/python/cpython/issues/78851}.)

@node string,subprocess<2>,ssl<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 string}@anchor{c0c}
@subsubsection `string'


@ref{728,,string.Template} ahora le permite modificar opcionalmente el patrón de expresión regular para marcadores de posición reforzados y marcadores de posición no reforzados por separado. (Contribuido por `Barry Warsaw' en bpo-1198569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1198569}.)

@node subprocess<2>,sys<7>,string,Módulos mejorados<6>
@anchor{whatsnew/3 7 subprocess}@anchor{c0d}
@subsubsection `subprocess'


The @ref{c0e,,subprocess.run()} function accepts the new `capture_output'
keyword argument.  When true, stdout and stderr will be captured.
This is equivalent to passing @ref{c0f,,subprocess.PIPE} as `stdout' and
`stderr' arguments.
(Contributed by Bo Bayles in bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}.)

La función @code{subprocess.run} y el constructor @ref{301,,subprocess.Popen} ahora aceptan la palabra clave del argumento `text' como un alias para `universal_newlines'. (Contribuido por `Andrew Clegg' en bpo-31756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31756}.)

En Windows, el valor predeterminado de `close_fds' se cambió de @code{False} a @code{True} al redirigir los identificadores estándar. Ahora es posible establecer `close_fds' en verdadero al redirigir los identificadores estándar. Ver @ref{301,,subprocess.Popen}. Esto significa que `close_fds' ahora tiene el valor predeterminado de @code{True} en todas las plataformas compatibles. (Contribuido por `Segev Finer' en bpo-19764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19764}.)

El módulo de subproceso ahora es más elegante al manejar @ref{a63,,KeyboardInterrupt} durante: @ref{c10,,subprocess.call()}, @ref{c0e,,subprocess.run()}, o en un administrador de contexto @ref{301,,Popen}. Ahora espera un corto período de tiempo para que el niño salga, antes de continuar con el manejo de la excepción @code{KeyboardInterrupt}. (Contribuido por `Gregory P. Smith' en bpo-25942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25942}.)

@node sys<7>,time<3>,subprocess<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 sys}@anchor{c11}
@subsubsection `sys'


La nueva función de enganche @ref{b65,,sys.breakpointhook()} es llamada por la incorporada @ref{1a6,,breakpoint()}. (Contribuido por `Barry Warsaw' en bpo-31353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31353}.)

En Android, la nueva @ref{c12,,sys.getandroidapilevel()} devuelve la versión de la API de Android en tiempo de compilación. (Contribuido por `Victor Stinner' en bpo-28740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28740}.)

La nueva función @ref{c13,,sys.get_coroutine_origin_tracking_depth()} devuelve la profundidad de seguimiento del origen de la corrutina actual, según lo establecido por el nuevo @ref{c14,,sys.set_coroutine_origin_tracking_depth()}. @ref{b,,asyncio} se ha convertido para usar esta nueva API en lugar de la obsoleta @code{sys.set_coroutine_wrapper()}. (Contribuido por `Nathaniel J. Smith' en bpo-32591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32591}.)

@node time<3>,tkinter<5>,sys<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 time}@anchor{c15}
@subsubsection `time'


@geindex Python Enhancement Proposals; PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/} añade seis nuevas funciones con resolución de nanosegundos al modulo @ref{ee,,time}:


@itemize *

@item 
@ref{b6d,,time.clock_gettime_ns()}

@item 
@ref{b6e,,time.clock_settime_ns()}

@item 
@ref{b6f,,time.monotonic_ns()}

@item 
@ref{b70,,time.perf_counter_ns()}

@item 
@ref{b71,,time.process_time_ns()}

@item 
@ref{b72,,time.time_ns()}
@end itemize

Se han agregado nuevos identificadores de reloj:


@itemize *

@item 
@ref{c16,,time.CLOCK_BOOTTIME} (Linux): Identical to
@ref{73a,,time.CLOCK_MONOTONIC}, except it also includes any time that the
system is suspended.

@item 
@ref{c17,,time.CLOCK_PROF} (FreeBSD, NetBSD and OpenBSD): High-resolution
per-process CPU timer.

@item 
@ref{c18,,time.CLOCK_UPTIME} (FreeBSD, OpenBSD): Time whose absolute value is
the time the system has been running and not suspended, providing accurate
uptime measurement.
@end itemize

La nuevas funciones @ref{9c9,,time.thread_time()} y @ref{c19,,time.thread_time_ns()} se puede utilizar para obtener medidas de tiempo de CPU por subproceso. (Contribuido por `Antoine Pitrou' en bpo-32025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32025}.)

La nueva función @ref{c1a,,time.pthread_getcpuclockid()} devuelve el ID de reloj del reloj de tiempo de CPU específico del subproceso.

@node tkinter<5>,tracemalloc<2>,time<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 tkinter}@anchor{c1b}
@subsubsection `tkinter'


La nueva clase @ref{c1c,,tkinter.ttk.Spinbox} esta disponible ahora. (Contribuido por `Alan Moore' en bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}.)

@node tracemalloc<2>,types<3>,tkinter<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 tracemalloc}@anchor{c1d}
@subsubsection `tracemalloc'


@ref{c1e,,tracemalloc.Traceback} se comporta más como rastreos regulares, ordenando los fotogramas del más antiguo al más reciente. @ref{c1f,,Traceback.format()} ahora acepta `límite' negativo, truncando el resultado a los marcos más antiguos de @code{abs(limit)}. Para obtener el comportamiento anterior, use el nuevo argumento `most_recent_first' para @code{Traceback.format()}. (Contribuido por `Jesse Bakker' en bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}.)

@node types<3>,unicodedata<7>,tracemalloc<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 types}@anchor{c20}
@subsubsection `types'


Las nuevas clases @ref{c21,,WrapperDescriptorType}, @ref{6ec,,MethodWrapperType}, @ref{c22,,MethodDescriptorType}, y @ref{c23,,ClassMethodDescriptorType} ahora están disponibles. (Contribuido por `Manuel Krebber' y `Guido van Rossum' en bpo-29377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29377}, y `Serhiy Storchaka' en bpo-32265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32265}.)

La nueva función @ref{c24,,types.resolve_bases()} resuelve las entradas MRO dinámicamente según lo especificado por 
@geindex Python Enhancement Proposals; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}. (Contribuido por `Ivan Levkivskyi' en bpo-32717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32717}.)

@node unicodedata<7>,unittest<6>,types<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 unicodedata}@anchor{c25}
@subsubsection `unicodedata'


La base de datos interna @ref{105,,unicodedata} se actualizó para usar Unicode 11@footnote{https://www.unicode.org/versions/Unicode11.0.0/}. (Aportado por Benjamín Peterson.)

@node unittest<6>,unittest mock,unicodedata<7>,Módulos mejorados<6>
@anchor{whatsnew/3 7 unittest}@anchor{c26}
@subsubsection `unittest'


La nueva opción de la linea de comandos @code{-k} permite filtrar pruebas por una subcadena de nombre o un patrón similar a un shell de Unix. Por ejemplo, @code{python -m unittest -k foo} ejecuta @code{foo_tests.SomeTest.test_something}, @code{bar_tests.SomeTest.test_foo}, pero no @code{bar_tests.FooTest.test_something}. (Contribuido por `Jonas Haag' en bpo-32071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32071}.)

@node unittest mock,urllib parse<5>,unittest<6>,Módulos mejorados<6>
@anchor{whatsnew/3 7 unittest-mock}@anchor{c27}
@subsubsection `unittest.mock'


Los atributos @ref{c28,,sentinel} ahora preservan su identidad cuando están @ref{26,,copied} o @ref{a6,,pickled}. (Contribuido por `Serhiy Storchaka' en bpo-20804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20804}.)

La nueva función @ref{c29,,seal()} permite sellar instancias @ref{ade,,Mock}, que no permitirá la creación de simulacros de atributos. El sello se aplica de forma recursiva a todos los atributos que en sí mismos son burlas. (Contribuido por `Mario Corchero' en bpo-30541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30541}.)

@node urllib parse<5>,uu,unittest mock,Módulos mejorados<6>
@anchor{whatsnew/3 7 urllib-parse}@anchor{c2a}
@subsubsection `urllib.parse'


@ref{c2b,,urllib.parse.quote()} ha sido actualizada desde 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} a 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, agregado @code{~} para el conjunto de caracteres que nunca se cotizan por defecto. (Contribuido por `Christian Theune' y `Ratnadeep Debnath' en bpo-16285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16285}.)

@node uu,uuid<3>,urllib parse<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 uu}@anchor{c2c}
@subsubsection `uu'


The @code{uu.encode()} function now accepts an optional `backtick'
keyword argument.  When it’s true, zeros are represented by @code{'`'}
instead of spaces.  (Contributed by Xiang Zhang in bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103}.)

@node uuid<3>,warnings<2>,uu,Módulos mejorados<6>
@anchor{whatsnew/3 7 uuid}@anchor{c2d}
@subsubsection `uuid'


El nuevo atributo @ref{c2e,,UUID.is_safe} transmite información de la plataforma sobre si los UUID generados se generan con un método seguro para multiprocesamiento. (Contribuido por `Barry Warsaw' en bpo-22807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22807}.)

@ref{c2f,,uuid.getnode()} ahora prefiere las direcciones MAC administradas universalmente a las direcciones MAC administradas localmente. Esto ofrece una mejor garantía de la unicidad global de los UUID devueltos desde @ref{c30,,uuid.uuid1()}. Si solo hay disponibles direcciones MAC administradas localmente, se devuelve la primera que se encuentre. (Contribuido por `Barry Warsaw' en bpo-32107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32107}.)

@node warnings<2>,xml<5>,uuid<3>,Módulos mejorados<6>
@anchor{whatsnew/3 7 warnings}@anchor{c31}
@subsubsection `warnings'


La inicialización de los filtros de advertencias predeterminados ha cambiado de la siguiente manera:


@itemize *

@item 
advertencias habilitadas a través de opciones de línea de comando (incluidos los de @ref{683,,-b} y la nueva opción específica de CPython @ref{2e2,,-X} @code{dev}) siempre se pasan a la maquinaria de advertencias a través del atributo @ref{279,,sys.warnoptions}.

@item 
los filtros de advertencias habilitados a través de la línea de comandos o el entorno ahora tienen el siguiente orden de prioridad:


@itemize *

@item 
el filtro @code{BytesWarning} para @ref{683,,-b} (o @code{-bb})

@item 
cualquier filtro especificado con la opción @ref{95e,,-W}

@item 
cualquier filtro especificado con la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}

@item 
cualquier otro filtro específico de CPython (por ejemplo, el filtro @code{default} agregado para el nuevo modo @code{-X dev})

@item 
cualquier filtro implícito definido directamente por la maquinaria de advertencias
@end itemize

@item 
en las @ref{357,,compilaciones de depuración de CPython}, ahora todas las advertencias se muestran de forma predeterminada (la lista de filtros implícitos está vacía)
@end itemize

(Contribuido por `Nick Coghlan' y `Victor Stinner' en bpo-20361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20361}, bpo-32043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32043}, and bpo-32230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32230}.)

Las advertencias de obsolescencia se muestran una vez más de forma predeterminada en scripts de un solo archivo y en el indicador interactivo. Consultar @ref{b58,,PEP 565; Mostrar DeprecationWarning en __main__} para mas detalles. (Contribuido por `Nick Coghlan' en bpo-31975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31975}.)

@node xml<5>,xml etree,warnings<2>,Módulos mejorados<6>
@anchor{whatsnew/3 7 xml}@anchor{c33}
@subsubsection xml


As mitigation against DTD and external entity retrieval, the
@ref{122,,xml.dom.minidom} and @ref{129,,xml.sax} modules no longer process
external entities by default.
(Contributed by Christian Heimes in gh-61441@footnote{https://github.com/python/cpython/issues/61441}.)

@node xml etree,xmlrpc server,xml<5>,Módulos mejorados<6>
@anchor{whatsnew/3 7 xml-etree}@anchor{c34}
@subsubsection `xml.etree'


@ref{c35,,ElementPath} predicados en los métodos @code{find()} ahora pueden comparar el texto del nodo actual con @code{`[. = “text”]}, no solo texto en niños. Los predicados también permiten agregar espacios para una mejor legibilidad. (Contribuido por `Stefan Behnel' en bpo-31648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31648}.)

@node xmlrpc server,zipapp,xml etree,Módulos mejorados<6>
@anchor{whatsnew/3 7 xmlrpc-server}@anchor{c36}
@subsubsection `xmlrpc.server'


@code{SimpleXMLRPCDispatcher.register_function} ahora puede ser usado como un decorador. (Contribuido por `Xiang Zhang' en bpo-7769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7769}.)

@node zipapp,zipfile,xmlrpc server,Módulos mejorados<6>
@anchor{whatsnew/3 7 zipapp}@anchor{c37}
@subsubsection `zipapp'


Función @ref{c38,,create_archive()} ahora acepta un argumento opcional `filter' para permitir al usuario seleccionar que archivos deben incluirse en el

Función @ref{c38,,create_archive()} ahora acepta un argumento opcional * comprimido * para generar un archivo comprimido. También se ha agregado una opción de línea de comando @code{—compress} para admitir la compresión. (Contribuido por `Zhiming Wang' en bpo-31638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31638}.)

@node zipfile,,zipapp,Módulos mejorados<6>
@anchor{whatsnew/3 7 zipfile}@anchor{c39}
@subsubsection `zipfile'


@ref{765,,ZipFile} ahora acepta el nuevo parámetro `compresslevel' para controlar el nivel de compresión. (Contribuido por `Bo Bayles' en bpo-21417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21417}.)

Subdirectorios en archivos creados por @code{ZipFile} ahora son guardados en orden alfabético. (Contribuido por `Bernhard M. Wiedemann' en bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}.)

@node Cambios en la API C,Construir cambios<4>,Módulos mejorados<6>,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 c-api-changes}@anchor{c3a}
@subsection Cambios en la API C


Se implementó una nueva API para el almacenamiento local de subprocesos. Ver @ref{b59,,PEP 539; Nueva API C para almacenamiento local de subprocesos} para una descripción general y @ref{b69,,API de almacenamiento específico de hilo (TSS@comma{} Thread Specific Storage)} para una referencia completa. (Contribuido por `Masayuki Yamamoto' en bpo-25658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25658}.)

La nueva funcionalidad @ref{b4b,,variables de contexto} expone un numero de @ref{b83,,nuevas APIs C}.

La nueva función @ref{c3b,,PyImport_GetModule()} devuelve el módulo previamente importado con el nombre dado. (Contribuido por `Eric Snow' en bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}.)

El nuevo macro @ref{c3c,,Py_RETURN_RICHCOMPARE} facilita la escritura de funciones de comparación enriquecidas. (Contribuido por `Petr Victorin' en bpo-23699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23699}.)

El nuevo macro  @ref{c3d,,Py_UNREACHABLE} se puede utilizar para marcar rutas de código inalcanzables. (Contribuido por `Barry Warsaw' en bpo-31338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31338}.)

El @ref{ff,,tracemalloc} ahora expone una API C a través de las nuevas funciones @ref{c3e,,PyTraceMalloc_Track()} y @ref{c3f,,PyTraceMalloc_Untrack()}. (Contribuido por `Victor Stinner' en bpo-30054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30054}.)

Los nuevos marcadores estáticos @code{import__find__load__start()} y @code{import__find__load__done()} se pueden usar para rastrear las importaciones de módulos. (Contribuido por `Christian Heimes' en bpo-31574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31574}.)

The fields @code{name} and @code{doc} of structures
@ref{5f2,,PyMemberDef}, @ref{c40,,PyGetSetDef},
@ref{c41,,PyStructSequence_Field}, @ref{c42,,PyStructSequence_Desc},
and @code{wrapperbase} are now of type @code{const char *} rather of
@code{char *}.  (Contributed by Serhiy Storchaka in bpo-28761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28761}.)

El resultado de @ref{931,,PyUnicode_AsUTF8AndSize()} y @ref{c43,,PyUnicode_AsUTF8()} es ahora de tipo @code{const char *} en lugar de @code{char *}. (Contribuido por `Serhiy Storchaka' en bpo-28769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28769}.)

El resultado de @ref{c44,,PyMapping_Keys()}, @ref{c45,,PyMapping_Values()} y @ref{c46,,PyMapping_Items()} ahora es siempre una lista, en lugar de una lista o una tupla. (Contribuido por `Oren Milman' en bpo-28280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28280}.)

Funciones agregadas @ref{294,,PySlice_Unpack()} y @ref{295,,PySlice_AdjustIndices()}. (Contribuido por `Serhiy Storchaka' en bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@ref{291,,PyOS_AfterFork()} está en desuso en favor de las nuevas funciones @ref{c47,,PyOS_BeforeFork()}, @ref{c48,,PyOS_AfterFork_Parent()} y @ref{292,,PyOS_AfterFork_Child()}. (Contribuido por `Antoine Pitrou' en bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

El único @code{PyExc_RecursionErrorInst} que formaba parte de la API pública se ha eliminado ya que sus miembros nunca borrados pueden causar un error de segmentación durante la finalización del intérprete. Contribuido por `Xavier de Gaye' en bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} y bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}.

Se agregó compatibilidad con C API para zonas horarias con constructores de zonas horarias @ref{c49,,PyTimeZone_FromOffset()} and @ref{c4a,,PyTimeZone_FromOffsetAndName()}, y acceso único al UTC con @ref{c4b,,PyDateTime_TimeZone_UTC}. Contribuido por `Paul Ganssle' en bpo-10381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10381}.

El tipo de resultados de @code{PyThread_start_new_thread()} y @code{PyThread_get_thread_ident()}, y el parámetro `id' de @ref{c4c,,PyThreadState_SetAsyncExc()} cambió de long a unsigned long. (Aportado por Serhiy Storchaka en bpo-6532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6532}.)

@ref{953,,PyUnicode_AsWideCharString()} ahora genera un @ref{360,,ValueError} si el segundo argumento es @code{NULL} y la cadena wchar_t* contiene caracteres nulos. (Aportado por Serhiy Storchaka en bpo-30708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30708}.)

Los cambios en la secuencia de inicio y la gestión de los asignadores de memoria dinámica significan que el requisito documentado durante mucho tiempo de llamar @ref{247,,Py_Initialize()} antes de llamar a la mayoría de las funciones de la API de C, ahora se confía más en él, y no cumplirlo puede provocar errores de segmentación en las aplicaciones integradas. Ver la sección @ref{b5c,,Portando a Python 3.7} en este documento y en la sección @ref{c4d,,Antes de la inicialización de Python} en la documentación de la API de C para obtener más detalles.

El nuevo: c: func @ref{c4e,,PyInterpreterState_GetID()} devuelve él ID único para un intérprete dado. (Contribuido por `Eric Snow' en bpo-29102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29102}.)

@ref{c4f,,Py_DecodeLocale()}, @ref{c50,,Py_EncodeLocale()} ahora usa la codificación UTF-8 cuando el @ref{b55,,modo UTF-8} esta habilitado. (Contribuido por `Victor Stinner' en bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}.)

@ref{c51,,PyUnicode_DecodeLocaleAndSize()} y @ref{c52,,PyUnicode_EncodeLocale()} ahora usan la codificación local actual para el controlador de errores @code{surrogateescape}. (Contribuido por `Victor Stinner' en bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}.)

Los parámetros `start' y `end' de @ref{950,,PyUnicode_FindChar()} ahora se ajustan para comportarse como cortes de cuerda. (Contribuido por `Xiang Zhang' en bpo-28822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28822}.)

@node Construir cambios<4>,Optimizaciones<6>,Cambios en la API C,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 build-changes}@anchor{c53}
@subsection Construir cambios


Se ha eliminado el soporte para construir @code{—without-threads}. El módulo @ref{ed,,threading} ahora está siempre disponible. (Contribuido por `Antoine Pitrou' en bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370}.).

Ya no se incluye una copia completa de `libffi' para su uso al compilar el módulo @ref{2b,,_ctypes} en plataformas que no son OSX UNIX. Ahora se requiere una copia instalada de `libffi' al construir @code{_ctypes} en tales plataformas. (Contribuido por `Zachary Ware' en bpo-27979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27979}.)

El proceso de compilación de Windows ya no depende de una sub versión para extraer fuentes externas; en su lugar, se usa un script de Python para descargar archivos zip desde GitHub. Si no se encuentra Python 3.6 en el sistema (a través de @code{py -3.6}), `NuGet' se usa para descargar una copia de Python de 32 bits para este propósito. (Contribuido por `Zachary Ware' en bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}.)

El módulo @ref{d0,,ssl} requiere `libssl' compatible con OpenSSL 1.0.2 o 1.1. OpenSSL 1.0.1 llegó al final de su vida útil el 31 de diciembre de 2016 y ya no es compatible. LibreSSL tampoco es compatible temporalmente. Las versiones de LibreSSL hasta la versión 2.6.4 carecen de las API de OpenSSL 1.0.2 necesarias.

@node Optimizaciones<6>,Otros cambios de implementación de CPython,Construir cambios<4>,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 optimizations}@anchor{c54}@anchor{whatsnew/3 7 whatsnew37-perf}@anchor{b5b}
@subsection Optimizaciones


La sobrecarga de llamar a muchos métodos de varias clases de biblioteca estándar implementadas en C se ha reducido significativamente al portar más código para usar la convención @code{METH_FASTCALL}. (Contribuido por `Victor Stinner' en bpo-29300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29300}, bpo-29507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29507}, bpo-29452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29452}, y bpo-29286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29286}.)

Varias optimizaciones han reducido el tiempo de inicio de Python en un 10% en Linux y hasta en un 30% en macOS. (Contribuido por `Victor Stinner', `INADA Naoki' en bpo-29585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29585}, y `Ivan Levkivskyi' en bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}.)

Las llamadas a métodos ahora son hasta un 20% más rápidas debido a los cambios de código de bytes que evitan la creación de instancias de métodos enlazados. (Contribuidos por `Yury Selivanov' y `INADA Naoki' en bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}.)
@anchor{whatsnew/3 7 whatsnew37-asyncio-perf}@anchor{b8d}
El módulo @ref{b,,asyncio} recibió una serie de optimizaciones notables para funciones de uso común:


@itemize *

@item 
La función @ref{214,,asyncio.get_event_loop()} se ha vuelto a implementar en C para hacerlo hasta 15 veces más rápido. (Contribuido por `Yury Selivanov' en bpo-32296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32296}.)

@item 
Se ha optimizado la gestión de devolución de llamada @ref{c55,,asyncio.Future}. (Contribuido por `Yury Selivanov' en bpo-32348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32348}.)

@item 
@ref{69e,,asyncio.gather()} ahora es hasta un 15% más rápido. (Contribuido por `Yury Selivanov' en bpo-32355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32355}.)

@item 
@ref{afe,,asyncio.sleep()} ahora es hasta 2 veces más rápido cuando el argumento `delay' es cero o negativo. (Contribuido por `Andrew Svetlov' en bpo-32351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32351}.)

@item 
Se ha reducido la sobrecarga de rendimiento del modo de depuración asyncio. (Contribuido por `Antoine Pitrou' en bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}.)
@end itemize

Como resultado de @ref{b50,,PEP 560 trabajo}, el tiempo de importación de @ref{104,,typing} se ha reducido en un factor de 7, y muchas operaciones de mecanografía ahora son más rápidas. (Contribuido por `Ivan Levkivskyi' en bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}.)

@ref{c56,,sorted()} y @ref{c57,,list.sort()} se han optimizado para que los casos comunes sean hasta un 40-75% más rápidos. (Contribuido por `Elliot Gorokhovsky' en bpo-28685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28685}.)

@ref{c58,,dict.copy()} es ahora 5.5 veces más rápido. (Contribuido por `Yury Selivanov' en bpo-31179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31179}.)

@ref{579,,hasattr()} y @ref{c59,,getattr()} ahora son aproximadamente 4 veces más rápidos cuando `name' no se encuentra y `obj' no se anula @ref{57a,,object.__getattr__()} o @ref{c5a,,object.__getattribute__()}. (Contribuido por `INADA Naoki' en bpo-32544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32544}.)

La búsqueda de ciertos caracteres Unicode (como la mayúscula ucraniana “Є”) en una cadena fue hasta 25 veces más lenta que la búsqueda de otros caracteres. Ahora es solo 3 veces más lento en el peor de los casos. (Contribuido por `Serhiy Storchaka' en bpo-24821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24821}.)

La fábrica @ref{32d,,collections.namedtuple()} ha sido re-implementada para hacer que la creación de tuplas con nombre sea de 4 a 6 veces más rápida. (Contribuido por `Jelle Zijlstra' con nuevas mejoras de `INADA Naoki', `Serhiy Storchaka', y `Raymond Hettinger' en bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}.)

@code{date.fromordinal()} y @code{date.fromtimestamp()} ahora son hasta un 30% más rápidos en el caso común. (Contribuido por `Paul Ganssle' en bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403}.)

La función @ref{be3,,os.fwalk()} es ahora 2 veces mas rápida gracias al uso de @ref{1a2,,os.scandir()}. (Contribuido por `Serhiy Storchaka' en bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}.)

La rapidez de la función @ref{1f9,,shutil.rmtree()} se ha mejorado en un 20-40% gracias al uso de la función @ref{1a2,,os.scandir()}. (Contribuido por `Serhiy Storchaka' en bpo-28564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28564}.)

Búsqueda y coincidencia optimizadas que no distinguen entre mayúsculas y minúsculas de @ref{b9,,expresiones regulares}. La búsqueda de algunos patrones ahora puede ser hasta 20 veces más rápida. (Contribuido por `Serhiy Storchaka' en bpo-30285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30285}.)

@ref{c5b,,re.compile()} ahora convierte el parámetro @code{flags} en un objeto int si es @code{RegexFlag}. Ahora es tan rápido como Python 3.5 y más rápido que Python 3.6 en aproximadamente un 10% dependiendo del patrón. (Contribuido por `INADA Naoki' en bpo-31671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31671}.)

El método @ref{c5c,,modify()} de la clase @ref{c5d,,selectors.EpollSelector}, @ref{c5e,,selectors.PollSelector} y @ref{c5f,,selectors.DevpollSelector} puede ser alrededor de un 10% más rápido bajo cargas pesadas. (Contribuido por `Giampaolo Rodola' en bpo-30014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30014})

El plegado constante se ha movido del optimizador de mirilla al nuevo optimizador AST, que puede realizar optimizaciones de manera más consistente. (Contribuid por `Eugene Toder' y `INADA Naoki' en bpo-29469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29469} y bpo-11549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11549}.)

La mayoría de funciones y métodos en @ref{4,,abc} se han reescrito en C. Esto hace que la creación de clases base abstractas y la llamada a @ref{4ef,,isinstance()} y @ref{85a,,issubclass()} en ellas sean 1.5 veces más rápidas. Esto también reduce el tiempo de inicio de Python hasta en un 10%. (Contribuido por `Ivan Levkivskyi' y `INADA Naoki' en bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333})

Mejoras significativas de velocidad para constructores alternativos para @ref{330,,datetime.date} y @ref{32f,,datetime.datetime} mediante el uso de constructores de ruta rápida cuando no se construyen subclases. (Contribuido por `Paul Ganssle' en bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403})

La velocidad de comparación de instancias de @ref{308,,array.array} se ha mejorado considerablemente en determinados casos. Ahora es de 10 a 70 veces más rápido cuando se comparan matrices que contienen valores del mismo tipo de entero. (Contribuido por `Adrian Wielgosik' en bpo-24700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24700}.)

Las funciones @ref{c60,,math.erf()} y @ref{c61,,math.erfc()} ahora use la implementación de la biblioteca C (más rápida) en la mayoría de las plataformas. (Contribuido por `Serhiy Storchaka' en bpo-26121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26121}.)

@node Otros cambios de implementación de CPython,Comportamiento obsoleto de Python,Optimizaciones<6>,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 other-cpython-implementation-changes}@anchor{c62}
@subsection Otros cambios de implementación de CPython



@itemize *

@item 
Trace hooks may now opt out of receiving the @code{line} and opt into receiving
the @code{opcode} events from the interpreter by setting the corresponding new
@ref{c63,,f_trace_lines} and @ref{c64,,f_trace_opcodes} attributes on the
frame being traced. (Contributed by Nick Coghlan in bpo-31344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31344}.)

@item 
Se corrigieron algunos problemas de coherencia con los atributos del módulo del paquete de espacio de nombres. Los objetos del módulo de espacio de nombres ahora tienen un @code{__file__} que está configurado como @code{None} (previamente no configurado), y su @code{__spec__.origin} también está configurado como @code{None} (anteriormente la cadena @code{"namespace"}). Ver bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}. Además, el @code{__spec__.loader} del objeto del módulo de espacio de nombres se establece en el mismo valor que @code{__loader__} (anteriormente, el primero se estableció en @code{None}). Ver bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}.

@item 
El diccionario @ref{2ae,,locals()} ahora se muestra en el orden léxico en que se definieron las variables. Anteriormente, el orden no estaba definido. (Contribuido por `Raymond Hettinger' en bpo-32690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32690}.)

@item 
The @code{distutils} @code{upload} command no longer tries to change CR
end-of-line characters to CRLF.  This fixes a corruption issue with sdists
that ended with a byte equivalent to CR.
(Contributed by Bo Bayles in bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304}.)
@end itemize

@node Comportamiento obsoleto de Python,Módulos funciones y métodos de Python obsoletos,Otros cambios de implementación de CPython,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 deprecated-python-behavior}@anchor{c65}
@subsection Comportamiento obsoleto de Python


Las expresiones de rendimiento (tanto las cláusulas @code{yield} como las cláusulas @code{yield from}) ahora están en desuso en las comprensiones y las expresiones generadoras (aparte de la expresión iterable en la cláusula más a la izquierda @code{for}). Esto asegura que las comprensiones siempre devuelvan inmediatamente un contenedor del tipo apropiado (en lugar de potencialmente devolver un objeto @ref{c66,,generator iterator}), mientras que las expresiones generadoras no intentarán intercalar su salida implícita con la salida de ninguna expresión de rendimiento explícita. En Python 3.7, tales expresiones emiten @ref{1da,,DeprecationWarning} cuando se compilan, en Python 3.8 será un @ref{150,,SyntaxError}. (Contribuido por `Serhiy Storchaka' en bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}.)

Devolviendo una subclase de @ref{154,,complex} desde @ref{687,,object.__complex__()} está obsoleto y será un error en futuras versiones de Python. Esto hace que @code{__complex__()} se compatible con @ref{22a,,object.__int__()} y @ref{a5e,,object.__float__()}. (Contribuido por `Serhiy Storchaka' en bpo-28894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28894}.)

@node Módulos funciones y métodos de Python obsoletos,Funciones y tipos obsoletos de la API C,Comportamiento obsoleto de Python,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 deprecated-python-modules-functions-and-methods}@anchor{c67}
@subsection Módulos, funciones y métodos de Python obsoletos


@menu
* aifc:: 
* asyncio: asyncio<8>. 
* collections: collections<3>. 
* dbm: dbm<3>. 
* enum: enum<4>. 
* gettext: gettext<2>. 
* importlib: importlib<6>. 
* locale: locale<4>. 
* macpath:: 
* threading: threading<3>. 
* socket: socket<3>. 
* ssl: ssl<6>. 
* sunau:: 
* sys: sys<8>. 
* wave:: 

@end menu

@node aifc,asyncio<8>,,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 aifc}@anchor{c68}
@subsubsection `aifc'


@code{aifc.openfp()} has been deprecated and will be removed in Python 3.9.
Use @code{aifc.open()} instead.
(Contributed by Brian Curtin in bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}.)

@node asyncio<8>,collections<3>,aifc,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id2}@anchor{c69}@anchor{whatsnew/3 7 whatsnew37-asyncio-deprecated}@anchor{ba9}
@subsubsection `asyncio'


Se ha desaprobado el soporte para instancias en @code{await} de @ref{b00,,asyncio.Lock} y otras primitivas de sincronización asyncio directamente. Se debe utilizar un administrador de contexto asincrónico para adquirir y liberar el recurso de sincronización. (Contribuido por `Andrew Svetlov' en bpo-32253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32253}.)

The @code{asyncio.Task.current_task()} and @code{asyncio.Task.all_tasks()}
methods have been deprecated.
(Contributed by Andrew Svetlov in bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250}.)

@node collections<3>,dbm<3>,asyncio<8>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id3}@anchor{c6a}
@subsubsection `collections'


En Python 3.8, las clases base abstractas en @ref{1f,,collections.abc} ya no estará expuesto en el módulo regular @ref{1e,,collections}. Esto ayudará a crear una distinción más clara entre las clases concretas y las clases base abstractas. (Contribuido por `Serhiy Storchaka' en bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}.)

@node dbm<3>,enum<4>,collections<3>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id4}@anchor{c6b}
@subsubsection `dbm'


@ref{33,,dbm.dumb} ahora admite la lectura de archivos de solo lectura y ya no escribe el archivo de índice cuando no se cambia. Ahora se emite una advertencia de obsolescencia si falta el archivo de índice y se recrea en los modos @code{’r’} y @code{’w’} (esto será un error en futuras versiones de Python). (Contribuido por `Serhiy Storchaka' en bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}.)

@node enum<4>,gettext<2>,dbm<3>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id5}@anchor{c6c}
@subsubsection `enum'


En Python 3.8, intentar buscar objetos que no sean Enum en clases @code{Enum} lanzará un @ref{228,,TypeError} (por ejemplo, @code{1 in Color}); de manera similar, si se intenta buscar objetos que no sean miembro de la @code{Flag} se lanzará @ref{228,,TypeError} (por ejemplo, @code{1 in Perm.RW}); actualmente, ambas operaciones devuelven @ref{bbf,,False} en su lugar.

@node gettext<2>,importlib<6>,enum<4>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 gettext}@anchor{c6d}
@subsubsection `gettext'


Usando un valor no entero para seleccionar una forma plural en @ref{63,,gettext} ahora está en desuso. Nunca funcionó correctamente. (Contribuido por `Serhiy Storchaka' en bpo-28692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28692}.)

@node importlib<6>,locale<4>,gettext<2>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id6}@anchor{c6e}
@subsubsection `importlib'


Methods
@code{MetaPathFinder.find_module()}
(replaced by
@ref{8ff,,MetaPathFinder.find_spec()})
and
@code{PathEntryFinder.find_loader()}
(replaced by
@ref{903,,PathEntryFinder.find_spec()})
both deprecated in Python 3.4 now emit @ref{1da,,DeprecationWarning}.
(Contributed by Matthias Bussonnier in bpo-29576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29576}.)

El @ref{c6f,,importlib.abc.ResourceLoader} ABC ha quedado obsoleto en favor de @ref{b88,,importlib.abc.ResourceReader}.

@node locale<4>,macpath,importlib<6>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id7}@anchor{c70}
@subsubsection `locale'


@code{locale.format()} ha sido obsoleto, en su lugar use @ref{5c2,,locale.format_string()}. (Contribuido por `Garvit' en bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}.)

@node macpath,threading<3>,locale<4>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 macpath}@anchor{c71}
@subsubsection `macpath'


El @code{macpath} esta ahora en desuso y se eliminará en Python 3.8. (Contribuido por `Chi Hsuan Yen' en bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}.)

@node threading<3>,socket<3>,macpath,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 threading}@anchor{c72}
@subsubsection `threading'


@code{dummy_threading} and @code{_dummy_thread} have been deprecated.  It is
no longer possible to build Python with threading disabled.
Use @ref{ed,,threading} instead.
(Contributed by Antoine Pitrou in bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370}.)

@node socket<3>,ssl<6>,threading<3>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id8}@anchor{c73}
@subsubsection `socket'


El truncamiento del valor del argumento silencioso en @ref{917,,socket.htons()} y @ref{918,,socket.ntohs()} ha quedado en desuso. En futuras versiones de Python, si el argumento pasado es mayor de 16 bits, se lanzará una excepción. (Contribuido por `Oren Milman' en bpo-28332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28332}.)

@node ssl<6>,sunau,socket<3>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id9}@anchor{c74}
@subsubsection `ssl'


@code{ssl.wrap_socket()} esta en desuso. En su lugar use @ref{5c8,,ssl.SSLContext.wrap_socket()}. (Contribuido por `Christian Heimes' en bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}.)

@node sunau,sys<8>,ssl<6>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 sunau}@anchor{c75}
@subsubsection `sunau'


@code{sunau.openfp()} has been deprecated and will be removed in Python 3.9.
Use @code{sunau.open()} instead.
(Contributed by Brian Curtin in bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}.)

@node sys<8>,wave,sunau,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 id10}@anchor{c76}
@subsubsection `sys'


@code{sys.set_coroutine_wrapper()} y @code{sys.get_coroutine_wrapper()} en desuso.

La función indocumentada @code{sys.callstats()} ha quedado obsoleto y se eliminará en una futura versión de Python. (Contribuido por `Victor Stinner' en bpo-28799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28799}.)

@node wave,,sys<8>,Módulos funciones y métodos de Python obsoletos
@anchor{whatsnew/3 7 wave}@anchor{c77}
@subsubsection `wave'


@code{wave.openfp()} ha quedado obsoleta y sera removida en Python 3.9. En su lugar use @ref{9de,,wave.open()}. (Contribuido por `Brian Curtin' en bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}.)

@node Funciones y tipos obsoletos de la API C,Eliminación de soporte de plataforma,Módulos funciones y métodos de Python obsoletos,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 deprecated-functions-and-types-of-the-c-api}@anchor{c78}
@subsection Funciones y tipos obsoletos de la API C


Función @ref{293,,PySlice_GetIndicesEx()} está en desuso y se reemplaza con una macro si @code{Py_LIMITED_API} no está configurado o configurado en un valor en el rango entre @code{0x03050400} y @code{0x03060000} (no incluido), o es @code{0x03060100} o superior. (Contribuido por `Serhiy Storchaka' en bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@ref{291,,PyOS_AfterFork()} ha quedado obsoleto. En su lugar usar @ref{c47,,PyOS_BeforeFork()}, @ref{c48,,PyOS_AfterFork_Parent()} o @ref{292,,PyOS_AfterFork_Child()}. (Contribuido por `Antoine Pitrou' en bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

@node Eliminación de soporte de plataforma,Eliminaciones de API y funciones,Funciones y tipos obsoletos de la API C,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 id11}@anchor{c79}@anchor{whatsnew/3 7 platform-support-removals}@anchor{c06}
@subsection Eliminación de soporte de plataforma



@itemize *

@item 
`FreeBSD' 9 y las versiones anteriores ya no son compatibles oficialmente.

@item 
Para una compatibilidad total con Unicode, incluso dentro de los módulos de extensión, ahora se espera que las plataformas *nix proporcionen al menos uno de @code{C.UTF-8} (configuración regional completa), @code{C.utf8} (configuración regional completa) o @code{UTF-8} (configuración regional exclusiva de @code{LC_CTYPE}) como una alternativa a la configuración regional @code{C} heredada basada en @code{ASCII}.

@item 
OpenSSL 0.9.8 y 1.0.1 ya no son compatibles, lo que significa que la compilación de CPython 3.7 con compatibilidad con SSL / TLS en plataformas más antiguas que aún usan estas versiones requiere opciones de compilación personalizadas que se vinculan a una versión más reciente de OpenSSL.

En particular, este problema afecta a las distribuciones LTS Linux Debian 8 (también conocido como “jessie”) y `Ubuntu' 14.04 (también conocido como “Trusty”), ya que todavía usan OpenSSL 1.0.1 por defecto.

Debian 9 (“stretch”) y `Ubuntu' 16.04 (“xenial”), así como las versiones recientes de otras versiones de LTS Linux (por ejemplo, RHEL / CentOS 7.5, SLES 12-SP3), usan OpenSSL 1.0.2 o posterior y siguen siendo compatibles en la configuración de compilación predeterminada.

El propio CI configuration file@footnote{https://github.com/python/cpython/blob/v3.7.13/.travis.yml} de CPython proporciona un ejemplo del uso de SSL compatibility testing infrastructure@footnote{https://github.com/python/cpython/tree/main/Tools/ssl/multissltests.py} en el conjunto de pruebas de CPython para crear y vincular OpenSSL 1.1.0 en lugar de un sistema obsoleto proporcionado por OpenSSL.
@end itemize

@node Eliminaciones de API y funciones,Eliminaciones de módulos,Eliminación de soporte de plataforma,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 api-and-feature-removals}@anchor{c7a}
@subsection Eliminaciones de API y funciones


Las siguientes funciones y API se han eliminado de Python 3.7:


@itemize *

@item 
La función @code{os.stat_float_times()} ha sido removida. Se introdujo en Python 2.3 por compatibilidad con versiones anteriores de Python 2.2 y quedó obsoleto desde Python 3.1.

@item 
Los escapes desconocidos que consisten en @code{’\’} y una letra ASCII en las plantillas de reemplazo para @ref{3f2,,re.sub()} quedaron obsoletos en Python 3.5 y ahora causarán un error.

@item 
Se eliminó el soporte del argumento * exclude * en @ref{c7b,,tarfile.TarFile.add()}. Fue obsoleto en Python 2.7 y 3.2. Utilice el argumento * filtro * en su lugar.

@item 
The @code{ntpath.splitunc()} function was deprecated in
Python 3.1, and has now been removed.  Use @ref{c7c,,splitdrive()}
instead.

@item 
@ref{32d,,collections.namedtuple()} ya no admite el parámetro `verbose' o el atributo @code{_source} que mostraba el código fuente generado para la clase de tupla nombrada. Esto fue parte de una optimización diseñada para acelerar la creación de clases. (Contribuido por `Jelle Zijlstra' con nuevas mejoras de `INADA Naoki', `Serhiy Storchaka', y `Raymond Hettinger' en bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}.)

@item 
Funciones @ref{513,,bool()}, @ref{153,,float()}, @ref{18e,,list()} y @ref{464,,tuple()} ya no aceptan argumentos de palabras clave. El primer argumento de @ref{1f0,,int()} ahora solo se puede pasar como argumento posicional.

@item 
Eliminado anteriormente en desuso en las clases de Python 2.4 @code{Plist}, @code{Dict} y @code{_InternalDict} en el módulo @ref{ab,,plistlib}. Dictar valores en el resultado de funciones @code{readPlist()} y @code{readPlistFromBytes()} ahora son dictados normales. Ya no puede utilizar el acceso a atributos para acceder a elementos de estos diccionarios.

@item 
La función @code{asyncio.windows_utils.socketpair()} ha sido removida. En su lugar use la función @ref{c7d,,socket.socketpair()}, está disponible en todas las plataformas desde Python 3.5. @code{asyncio.windows_utils.socketpair} era un alias para @code{socket.socketpair} en Python 3.5 y mas nuevo.

@item 
@ref{b,,asyncio} no longer exports the @ref{c2,,selectors} and
@code{_overlapped} modules as @code{asyncio.selectors} and
@code{asyncio._overlapped}. Replace @code{from asyncio import selectors} with
@code{import selectors}.

@item 
Instanciación directa de objetos @ref{981,,ssl.SSLSocket} y @ref{c09,,ssl.SSLObject} ahora está prohibido. Los constructores nunca fueron documentados, probados o diseñados como constructores públicos. Se suponía que los usuarios usaban @code{ssl.wrap_socket()} o @ref{1fa,,ssl.SSLContext}. (Contribuido por `Christian Heimes' en bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951}.)

@item 
The unused @code{distutils} @code{install_misc} command has been removed.
(Contributed by Eric N. Vander Weele in bpo-29218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29218}.)
@end itemize

@node Eliminaciones de módulos,Cambios solo en Windows,Eliminaciones de API y funciones,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 module-removals}@anchor{c7e}
@subsection Eliminaciones de módulos


El modulo @code{fpectl} ha sido removido. Nunca se habilitó de forma predeterminada, nunca funcionó correctamente en x86-64 y cambió la ABI de Python de manera que causó la rotura inesperada de las extensiones C. (Contribuido por `Nathaniel J. Smith' en bpo-29137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29137}.)

@node Cambios solo en Windows,Portando a Python 3 7,Eliminaciones de módulos,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 windows-only-changes}@anchor{c7f}
@subsection Cambios solo en Windows


El lanzador de python, (py.exe), puede aceptar especificadores de 32 y 64 bits `sin' tener que especificar también una versión secundaria. Entonces, @code{py -3-32} y @code{py -3-64} se vuelven válidos, así como @code{py -3.7-32}, también los -`m'-64 and -`m.n'-64. Los formularios ahora se aceptan para forzar Python de 64 bits incluso si de otro modo se hubieran utilizado 32 bits. Si la versión especificada no está disponible, py.exe saldrá del error. (Contribuido por `Steve Barnes' en bpo-30291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30291}.)

El lanzador se puede ejecutar como @code{py -0} para producir una lista de las pitones instaladas, `con las marcas predeterminadas con un asterisco'. La ejecución de @code{py -0p} incluirá las rutas. Si py se ejecuta con un especificador de versión que no puede coincidir, también imprimirá la `forma corta' lista de especificadores disponibles. (Contribuido por `Steve Barnes' en bpo-30362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30362}.)

@node Portando a Python 3 7,Cambios notables en Python 3 7 1,Cambios solo en Windows,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 porting-to-python-3-7}@anchor{c80}@anchor{whatsnew/3 7 porting-to-python-37}@anchor{b5c}
@subsection Portando a Python 3.7


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en el comportamiento de Python: Cambios en el comportamiento de Python<2>. 
* Cambios en la API Python:: 
* Cambios en la API de C: Cambios en la API de C<8>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<5>. 
* Cambios solo en Windows: Cambios solo en Windows<2>. 
* Otra implementación de cambios en CPython:: 

@end menu

@node Cambios en el comportamiento de Python<2>,Cambios en la API Python,,Portando a Python 3 7
@anchor{whatsnew/3 7 changes-in-python-behavior}@anchor{c81}
@subsubsection Cambios en el comportamiento de Python



@itemize *

@item 
@ref{7ce,,async} y @ref{14e,,await} los nombres ahora son palabras clave reservadas. El código que usa estos nombres como identificadores lanzará ahora un @ref{150,,SyntaxError}. (Contribuido por `Jelle Zijlstra' en bpo-30406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30406}.)

@item 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} está habilitado para todo el código en Python 3.7, lo que significa que las excepciones de @ref{c82,,StopIteration} generadas directa o indirectamente en corutinas y generadores se transforman en excepciones de @ref{1e5,,RuntimeError}. (Contribuido por `Yury Selivanov' en bpo-32670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32670}.)

@item 
Los métodos @ref{c83,,object.__aiter__()} ya no se pueden declarar cómo asincrónicos. (Contribuido por `Yury Selivanov' en bpo-31709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31709}.)

@item 
Debido a un descuido, las versiones anteriores de Python aceptaron erróneamente la siguiente sintaxis:

@example
f(1 for x in [1],)

class C(1 for x in [1]):
    pass
@end example

Python 3.7 ahora lanza correctamente una @ref{150,,SyntaxError}, como una expresión generadora siempre debe estar directamente dentro de un conjunto de paréntesis y no puede tener una coma a ambos lados, y la duplicación de los paréntesis solo se puede omitir en las llamadas. (Contribuido por `Serhiy Storchaka' en bpo-32012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32012} y bpo-32023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32023}.)

@item 
Al usar el interruptor @ref{187,,-m}, el directorio de trabajo inicial ahora se agrega a: data @ref{27e,,sys.path}, en lugar de una cadena vacía (que denota dinámicamente el directorio de trabajo actual en el momento de cada importación). Cualquier programa que esté comprobando la cadena vacía, o que dependa de otro modo del comportamiento anterior, deberá actualizarse en consecuencia (por ejemplo, comprobando también si hay @code{os.getcwd()} o @code{os.path.dirname(__main__.__file__)}, dependiendo de por qué el código buscaba la cadena vacía en primer lugar).
@end itemize

@node Cambios en la API Python,Cambios en la API de C<8>,Cambios en el comportamiento de Python<2>,Portando a Python 3 7
@anchor{whatsnew/3 7 changes-in-the-python-api}@anchor{c84}
@subsubsection Cambios en la API Python



@itemize *

@item 
@code{socketserver.ThreadingMixIn.server_close()} ahora espera hasta que se completen todos los subprocesos que no son demonios. Establezca el nuevo atributo de clase @ref{c85,,socketserver.ThreadingMixIn.block_on_close} en @code{False} para obtener el comportamiento anterior a 3.7. (Contribuido por `Victor Stinner' en bpo-31233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31233} y bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}.)

@item 
@code{socketserver.ForkingMixIn.server_close()} ahora espera hasta que se completen todos los procesos secundarios. Establezca el nuevo atributo de clase @code{socketserver.ForkingMixIn.block_on_close} en @code{False} para obtener el comportamiento anterior a 3.7. (Contribuido por `Victor Stinner' en bpo-31151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31151} y bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}.)

@item 
La función @ref{c86,,locale.localeconv()} ahora establece temporalmente la configuración regional @code{LC_CTYPE} en el valor de @code{`LC_NUMERIC} en algunos casos. (Contribuido por `Victor Stinner' en bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}.)

@item 
@ref{c87,,pkgutil.walk_packages()} ahora genera un @ref{360,,ValueError} si la* ruta * es una cadena. Anteriormente se devolvió una lista vacía. (Contribuido por `Sanyam Khurana' en bpo-24744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24744}.)

@item 
Un argumento de cadena de formato para @ref{c88,,string.Formatter.format()} es ahora @ref{b12,,solo posicional}. Pasarlo como un argumento de palabra clave quedó obsoleto en Python 3.5. (Contribuido por `Serhiy Storchaka' en bpo-29193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29193}.)

@item 
Atributos @ref{c89,,key}, @ref{c8a,,value} y @ref{c8b,,coded_value} de la clase @ref{c8c,,http.cookies.Morsel} ahora son de solo lectura. La asignación a ellos quedó obsoleta en Python 3.5. Utilizar el método @ref{c8d,,set()} para configurarlos. (Contribuido por `Serhiy Storchaka' en bpo-29192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29192}.)

@item 
El argumento `mode' de @ref{37b,,os.makedirs()} ya no afecta los bits de permiso de archivo de los directorios de nivel intermedio recién creados. Para configurar sus bits de permiso de archivo, puede configurar umask antes de invocar @code{makedirs()}. (Aportado por Serhiy Storchaka en bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}.)

@item 
El tipo @ref{c8e,,struct.Struct.format} ahora es @ref{237,,str} en lugar de: class @ref{325,,bytes}. (Contribuido por `Victor Stinner' en bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071}.)

@item 
@code{cgi.parse_multipart()} now accepts the `encoding' and `errors'
arguments and returns the same results as
@code{FieldStorage}: for non-file fields, the value associated to a key
is a list of strings, not bytes.
(Contributed by Pierre Quentel in bpo-29979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29979}.)

@item 
Debido a cambios internos en @ref{cc,,socket}, llamar @ref{c8f,,socket.fromshare()} en un socket creado por @ref{c90,,socket.share} en versiones anteriores de Python no es compatible.

@item 
@code{repr} para @ref{65c,,BaseException} ha cambiado para no incluir la coma final. La mayoría de las excepciones se ven afectadas por este cambio. (Contribuido por `Serhiy Storchaka' en bpo-30399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30399}.)

@item 
@code{repr} para @ref{a61,,datetime.timedelta} ha cambiado para incluir los argumentos de palabras clave en la salida. (Contribuido por `Utkarsh Upadhyay' en bpo-30302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30302}.)

@item 
Debido a que @ref{1f9,,shutil.rmtree()} ahora se implementa usando la función @ref{1a2,,os.scandir()}, el controlador especificado por el usuario `onerror' ahora se llama con el primer argumento @code{os.scandir} en lugar de @code{os.listdir} cuando falla el listado del directorio.

@item 
Es posible que en el futuro se agregue soporte para conjuntos anidados y operaciones de conjuntos en expresiones regulares como en Unicode Technical Standard #18@footnote{https://unicode.org/reports/tr18/}. Esto cambiaría la sintaxis. Para facilitar este cambio futuro, por el momento, se planteará un @ref{4d4,,FutureWarning} en casos ambiguos. Que incluyen conjuntos que comienzan con un literal @code{’[‘} o que contienen secuencias de caracteres literales @code{’—‘}, @code{’&&’}, @code{’~~’}, and @code{’||’}. Para evitar una advertencia, escapa de ellos con una barra invertida. (Contribuido por `Serhiy Storchaka' en bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}.)

@item 
El resultado de dividir una cuerda en un @ref{b9,,expresión regular} que podría coincidir con una cadena vacía. Por ejemplo, dividir en @code{r’\s*’} ahora dividirá no solo en espacios en blanco como lo hizo anteriormente, sino también en cadenas vacías antes de todos los caracteres que no sean espacios en blanco y justo antes del final de la cadena. El comportamiento anterior se puede restaurar cambiando el patrón a @code{r’\s+’}. Una @ref{4d4,,FutureWarning} se emitió para tales patrones desde Python 3.5.

Para patrones que coinciden con cadenas vacías y no vacías, el resultado de la búsqueda de todas las coincidencias también puede cambiarse en otros casos. Por ejemplo en la cadena @code{'a\n\n'}, el patrón @code{’\n'} no solo coincidirá con cadenas vacías en las posiciones 2 y 3, sino también la cadena @code{'\n'} en las posiciones 2–3. Para hacer coincidir solo líneas en blanco, el patrón debe reescribirse como @code{r'(?m)^[^\S\n]*$'}.

@ref{3f2,,re.sub()} now replaces empty matches adjacent to a previous
non-empty match.  For example @code{re.sub('x*', '-', 'abxd')} returns now
@code{'-a-b--d-'} instead of @code{'-a-b-d-'} (the first minus between “b” and
“d” replaces “x”, and the second minus replaces an empty string between
“x” and “d”).

(Contribuido por `Serhiy Storchaka' en bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054} y bpo-32308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32308}.)

@item 
Cambie @ref{c91,,re.escape()} para escapar solo de los caracteres especiales regex en lugar de escapar de todos los caracteres que no sean letras ASCII, números y @code{’_’}. (Contribuido por `Serhiy Storchaka' en bpo-29995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29995}.)

@item 
Los marcos @ref{c1e,,tracemalloc.Traceback} ahora se ordenan del más antiguo al más reciente para ser más coherentes con @ref{fe,,traceback}. (Contribuido por `Jesse Bakker' en bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}.)

@item 
En sistemas operativos que admiten banderas de bits @ref{c92,,socket.SOCK_NONBLOCK} o @ref{c93,,socket.SOCK_CLOEXEC}, el @ref{c94,,socket.type} ya no los tiene aplicados. Por lo tanto, comprobaciones como @code{if sock.type == socket.SOCK_STREAM} funcionan como se espera en todas las plataformas. (Contribuido por `Yury Selivanov' en bpo-32331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32331}.)

@item 
En Windows, el valor predeterminado para el argumento `close_fds' de @ref{301,,subprocess.Popen} se cambió de @ref{bbf,,False} a @ref{c95,,True} al redirigir los identificadores estándar. Si anteriormente dependía de que los identificadores fueran heredados al usar @ref{301,,subprocess.Popen} con la redirección estándar de io, tendrá que pasar @code{close_fds=False} para preservar el comportamiento anterior, o usar @ref{c96,,STARTUPINFO.lpAttributeList}.

@item 
@ref{c97,,importlib.machinery.PathFinder.invalidate_caches()} – que afecta implícitamente a @ref{c98,,importlib.invalidate_caches()} – ahora borra entradas en @ref{684,,sys.path_importer_cache} que están configuradas en @code{None}. (Contribuido por `Brett Cannon' en bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}.)

@item 
En @ref{b,,asyncio}, @ref{c99,,loop.sock_recv()}, @ref{c9a,,loop.sock_sendall()}, @ref{c9b,,loop.sock_accept()}, @ref{c9c,,loop.getaddrinfo()}, @ref{c9d,,loop.getnameinfo()} se han cambiado para que sean métodos de rutina adecuados para que coincidan con su documentación. Anteriormente, estos métodos devolvían instancias @ref{c55,,asyncio.Future}. (Contribuido por `Yury Selivanov' en bpo-32327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32327}.)

@item 
@ref{c9e,,asyncio.Server.sockets} ahora devuelve una copia de la lista interna de sockets del servidor, en lugar de devolverla directamente. (Contribuido por `Yury Selivanov' en bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}.)

@item 
@ref{c8e,,Struct.format} es ahora una instancia @ref{237,,str} en lugar de una instancia @ref{325,,bytes}. (Contribuido por `Victor Stinner' en bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071}.)

@item 
@ref{7,,argparse} `subparsers' ahora pueden hacerse obligatorios pasando @code{required=True} a @ref{c9f,,ArgumentParser.add_subparsers()}. (Contribuido por `Anthony Sottile' en bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510}.)

@item 
@ref{ca0,,ast.literal_eval()} is now stricter.  Addition and subtraction of
arbitrary numbers are no longer allowed.
(Contributed by Serhiy Storchaka in bpo-31778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31778}.)

@item 
@ref{ca1,,Calendar.itermonthdates} ahora lanzará una excepción cuando una fecha cae fuera del rango de @code{0001-01-01} a @code{9999-12-31}. Para admitir aplicaciones que no pueden tolerar tales excepciones, se puede utilizar el nuevo @ref{ca2,,Calendar.itermonthdays3} y @ref{ca3,,Calendar.itermonthdays4}. Los nuevos métodos devuelven tuplas y no están restringidos por el rango admitido por @ref{330,,datetime.date}. (Contribuido por `Alexander Belopolsky' en bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}.)

@item 
@ref{ca4,,collections.ChainMap} ahora conserva el orden de las asignaciones subyacentes. (Contribuido por `Raymond Hettinger' en bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}.)

@item 
El método @code{submit()} de @ref{7dd,,concurrent.futures.ThreadPoolExecutor} y @ref{163,,concurrent.futures.ProcessPoolExecutor} ahora genera un @ref{1e5,,RuntimeError} si se llama durante el cierre del intérprete. (Contribuido por `Mark Nemec' en bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}.)

@item 
El constructor @ref{32b,,configparser.ConfigParser} ahora usa @code{read_dict()} para procesar los valores predeterminados, haciendo que su comportamiento sea coherente con el resto del analizador. Las claves y los valores que no son cadenas en el diccionario de valores predeterminados ahora se están convirtiendo implícitamente en cadenas. (Contribuido por `James Tocknell' en bpo-23835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23835}.)

@item 
Se eliminaron varias importaciones internas indocumentadas. Un ejemplo es que @code{os.errno} ya no está disponible; use @code{import errno} directamente en su lugar. Tenga en cuenta que estas importaciones internas no documentadas pueden eliminarse en cualquier momento sin previo aviso, incluso en las versiones micro.
@end itemize

@node Cambios en la API de C<8>,Cambios en el código de bytes de CPython<5>,Cambios en la API Python,Portando a Python 3 7
@anchor{whatsnew/3 7 changes-in-the-c-api}@anchor{ca5}
@subsubsection Cambios en la API de C


La función @ref{293,,PySlice_GetIndicesEx()} se considera insegura para secuencias de tamaño variable. Si los índices de corte no son instancias de @ref{1f0,,int}, sino objetos que implementan el método @code{__index__()}, la secuencia se puede cambiar de tamaño después de pasar su longitud a @code{PySlice_GetIndicesEx()}. Esto puede llevar a que se devuelvan índices fuera de la longitud de la secuencia. Esto puede llevar a devolver índices fuera de la longitud de la secuencia. Para evitar posibles problemas, use las nuevas funciones @ref{294,,PySlice_Unpack()} y @ref{295,,PySlice_AdjustIndices()}. (Contribuido por `Serhiy Storchaka' en bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@node Cambios en el código de bytes de CPython<5>,Cambios solo en Windows<2>,Cambios en la API de C<8>,Portando a Python 3 7
@anchor{whatsnew/3 7 cpython-bytecode-changes}@anchor{ca6}
@subsubsection Cambios en el código de bytes de CPython


Hay dos nuevos códigos de operación: @ref{ca7,,LOAD_METHOD} y @code{CALL_METHOD}. (Contribuido por `Yury Selivanov' y `INADA Naoki' en bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}.)

El código de operación @code{STORE_ANNOTATION} ha sido removido. (Contribuido por `Mark Shannon' en bpo-32550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32550}.)

@node Cambios solo en Windows<2>,Otra implementación de cambios en CPython,Cambios en el código de bytes de CPython<5>,Portando a Python 3 7
@anchor{whatsnew/3 7 id12}@anchor{ca8}
@subsubsection Cambios solo en Windows


El archivo utilizado para anular @ref{27e,,sys.path} ahora se llama @code{<python-executable>._pth} en lugar de @code{'sys.path'}. Consulte @ref{ca9,,Encontrar módulos} para obtener más información. (Aportado por Steve Dower en bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}.)

@node Otra implementación de cambios en CPython,,Cambios solo en Windows<2>,Portando a Python 3 7
@anchor{whatsnew/3 7 id13}@anchor{caa}
@subsubsection Otra implementación de cambios en CPython


En preparación para posibles cambios futuros en la API pública de inicialización del tiempo de ejecución de CPython (ver 
@geindex Python Enhancement Proposals; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/} para un borrador inicial, pero algo desactualizado), La lógica de gestión de configuración y puesta en marcha interna de CPython se ha re-factorizado significativamente. Si bien estas actualizaciones están destinadas a ser completamente transparentes tanto para las aplicaciones integradas como para los usuarios de la CLI de CPython normal, se mencionan aquí ya que la refactorización cambia el orden interno de varias operaciones durante el inicio del intérprete y, por lo tanto, pueden descubrir defectos previamente latentes, ya sea en aplicaciones incrustadas, o en el propio CPython. ( Inicialmente contribuido por `Nick Coghlan' y `Eric Snow' como parte de bpo-22257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22257}, y actualizado por `Nick', `Eric', y `Victor Stinner' en varios otros números). Algunos detalles conocidos afectados:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()} is not currently usable by embedding
applications due to the requirement to create a Unicode object prior to
calling @code{Py_Initialize}. Use @code{PySys_AddWarnOption()} instead.

@item 
warnings filters added by an embedding application with
@code{PySys_AddWarnOption()} should now more consistently take precedence
over the default filters set by the interpreter
@end itemize

Debido a cambios en la forma en que se configuran los filtros de advertencias predeterminados, establecer @ref{4b5,,Py_BytesWarningFlag} en un valor mayor que uno ya no es suficiente para que ambos emitan mensajes @ref{cab,,BytesWarning} y los conviertan en excepciones. En su lugar, se debe establecer la bandera (para hacer que las advertencias se emitan en primer lugar) y se debe agregar un filtro de advertencias explícito @code{error::BytesWarning} para convertirlas en excepciones.

Debido a un cambio en la forma en que el compilador maneja las cadenas de documentos, el implícito @code{return None} en el cuerpo de una función que consiste únicamente en una cadena de documentos ahora se marca como ocurriendo en la misma línea que la cadena de documentos, no en la línea de encabezado de la función.

El estado de excepción actual se ha movido del objeto de trama a la co-rutina. Esto simplificó el intérprete y corrigió un par de errores oscuros causados por tener un estado de excepción de intercambio al ingresar o salir de un generador. (Contribuido por `Mark Shannon' en bpo-25612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25612}.)

@node Cambios notables en Python 3 7 1,Cambios notables en Python 3 7 2,Portando a Python 3 7,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-1}@anchor{cac}
@subsection Cambios notables en Python 3.7.1


A partir de 3.7.1, @ref{247,,Py_Initialize()} ahora lee y respeta constantemente todos los mismos ajustes de entorno que @ref{cad,,Py_Main()} (en versiones anteriores de Python, respetaba un subconjunto mal definido de esas variables de entorno, mientras que en Python 3.7.0 no leyó ninguna de ellas debido a bpo-34247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34247}). Si este comportamiento no es deseado, establezca @ref{4b9,,Py_IgnoreEnvironmentFlag} en 1 antes de llamar a @ref{247,,Py_Initialize()}.

En 3.7.1 la API C para las variables de Contexto @ref{cae,,ha sido actualizada} para usar punteros @ref{42d,,PyObject}. Ver también bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762}.

En 3.7.1 el módulo @ref{fb,,tokenize} ahora emite un token @code{NEWLINE} cuando se le proporciona una entrada que no tiene una nueva línea al final. Este comportamiento ahora coincide con lo que hace el tokenizador C internamente. (Contribuido por `Ammar Askar' en bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node Cambios notables en Python 3 7 2,Cambios notables en Python 3 7 6,Cambios notables en Python 3 7 1,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-2}@anchor{caf}
@subsection Cambios notables en Python 3.7.2


En 3.7.2, @ref{111,,venv} en Windows ya no copia los binarios originales, sino que crea scripts de redireccionamiento llamados @code{python.exe} y @code{pythonw.exe} en su lugar. Esto resuelve un problema de larga data en el que todos los entornos virtuales tendrían que actualizarse o recrearse con cada actualización de Python. Sin embargo, tenga en cuenta que esta versión aún requerirá la recreación de entornos virtuales para obtener los nuevos scripts.

@node Cambios notables en Python 3 7 6,Cambios notables en Python 3 7 10,Cambios notables en Python 3 7 2,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-6}@anchor{cb0}
@subsection Cambios notables en Python 3.7.6


Debido a importantes problemas de seguridad, el parámetro `reuse_address' de @ref{7cf,,asyncio.loop.create_datagram_endpoint()} ya no es compatible. Esto se debe al comportamiento de la opción socket @code{SO_REUSEADDR} en UDP. Para obtener más detalles, consulte la documentación de @code{loop.create_datagram_endpoint()}. (Contribuido por `Kyle Stanley', `Antoine Pitrou', y `Yury Selivanov' en bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Cambios notables en Python 3 7 10,Notable changes in Python 3 7 11,Cambios notables en Python 3 7 6,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-10}@anchor{cb1}
@subsection Cambios notables en Python 3.7.10


Earlier Python versions allowed using both @code{;} and @code{&} as
query parameter separators in @ref{1c9,,urllib.parse.parse_qs()} and
@ref{1c8,,urllib.parse.parse_qsl()}.  Due to security concerns, and to conform with
newer W3C recommendations, this has been changed to allow only a single
separator key, with @code{&} as the default.  This change also affects
@code{cgi.parse()} and @code{cgi.parse_multipart()} as they use the affected
functions internally. For more details, please see their respective
documentation.
(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Notable changes in Python 3 7 11,Notable security feature in 3 7 14,Cambios notables en Python 3 7 10,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-11}@anchor{cb2}
@subsection Notable changes in Python 3.7.11


A security fix alters the @ref{990,,ftplib.FTP} behavior to not trust the
IPv4 address sent from the remote server when setting up a passive data
channel.  We reuse the ftp server IP address instead.  For unusual code
requiring the old behavior, set a @code{trust_server_pasv_ipv4_address}
attribute on your FTP instance to @code{True}.  (See gh-87451@footnote{https://github.com/python/cpython/issues/87451})

The presence of newline or tab characters in parts of a URL allows for some
forms of attacks. Following the WHATWG specification that updates RFC 3986,
ASCII newline @code{\n}, @code{\r} and tab @code{\t} characters are stripped from the
URL by the parser @ref{10a,,urllib.parse()} preventing such attacks. The removal
characters are controlled by a new module level variable
@code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (See gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node Notable security feature in 3 7 14,,Notable changes in Python 3 7 11,Qué hay de nuevo en Python 3 7
@anchor{whatsnew/3 7 notable-security-feature-in-3-7-14}@anchor{cb3}
@subsection Notable security feature in 3.7.14


Converting between @ref{1f0,,int} and @ref{237,,str} in bases other than 2
(binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal)
now raises a @ref{360,,ValueError} if the number of digits in string form is
above a limit to avoid potential denial of service attacks due to the
algorithmic complexity. This is a mitigation for 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.
This limit can be configured or disabled by environment variable, command
line flag, or @ref{d9,,sys} APIs. See the @ref{695,,integer string conversion length limitation} documentation.  The default limit
is 4300 digits in string form.

@node Qué hay de nuevo en Python 3 6,Qué hay de nuevo en Python 3 5,Qué hay de nuevo en Python 3 7,Qué hay de nuevo en Python
@anchor{whatsnew/3 6 doc}@anchor{cb4}@anchor{whatsnew/3 6 what-s-new-in-python-3-6}@anchor{cb5}
@section Qué hay de nuevo en Python 3.6


@*Editors: 
Elvis Pranskevichus <@email{elvis@@magic.io}>, Yury Selivanov <@email{yury@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

Este artículo explica las nuevas funciones de Python 3.6, en comparación con 3.5. Python 3.6 se lanzó el 23 de diciembre de 2016. Consulte el changelog@footnote{https://docs.python.org/3.6/whatsnew/changelog.html} para obtener una lista completa de cambios.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 494
PEP 494@footnote{https://peps.python.org/pep-0494/} - Programa de lanzamiento de Python 3.6


@menu
* Resumen; aspectos destacados de la versión: Resumen aspectos destacados de la versión<4>. 
* Nuevas características: Nuevas características<10>. 
* Otros cambios de idioma: Otros cambios de idioma<4>. 
* Nuevos módulos: Nuevos módulos<6>. 
* Módulos mejorados: Módulos mejorados<7>. 
* Optimizaciones: Optimizaciones<7>. 
* Cambios en la API de Build y C:: 
* Otras mejoras:: 
* Obsoleto: Obsoleto<9>. 
* Remoto: Remoto<5>. 
* Portar a Python 3.6: Portar a Python 3 6. 
* Cambios notables en Python 3.6.2: Cambios notables en Python 3 6 2. 
* Cambios notables en Python 3.6.4: Cambios notables en Python 3 6 4. 
* Cambios notables en Python 3.6.5: Cambios notables en Python 3 6 5. 
* Cambios notables en Python 3.6.7: Cambios notables en Python 3 6 7. 
* Cambios notables en Python 3.6.10: Cambios notables en Python 3 6 10. 
* Cambios notables en Python 3.6.13: Cambios notables en Python 3 6 13. 
* Notable changes in Python 3.6.14: Notable changes in Python 3 6 14. 

@end menu

@node Resumen aspectos destacados de la versión<4>,Nuevas características<10>,,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 summary-release-highlights}@anchor{cb6}
@subsection Resumen: aspectos destacados de la versión


Nuevas funciones de sintaxis:


@itemize *

@item 
@ref{cb7,,PEP 498}, literales de cadena formateados.

@item 
@ref{cb8,,PEP 515}, guiones bajos en literales numéricos.

@item 
@ref{cb9,,PEP 526}, sintaxis para anotaciones variables.

@item 
@ref{cba,,PEP 525}, generadores asincrónicos.

@item 
@ref{cbb,,PEP 530}: comprensiones asincrónicas.
@end itemize

Nuevos módulos de biblioteca:


@itemize *

@item 
@ref{c0,,secrets}: @ref{cbc,,PEP 506 – Adding A Secrets Module To The Standard Library}.
@end itemize

Mejoras en la implementación de CPython:


@itemize *

@item 
El tipo @ref{b51,,dict} se ha vuelto a implementar para utilizar un @ref{cbd,,more compact representation} basado en a proposal by Raymond Hettinger@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html} y similar al PyPy dict implementation@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}. Esto dio como resultado que los diccionarios usaran entre un 20% y un 25% menos de memoria en comparación con Python 3.5.

@item 
La personalización de la creación de clases se ha simplificado con el @ref{cbe,,new protocol}.

@item 
El orden de definición de atributo de clase es @ref{cbf,,now preserved}.

@item 
El orden de los elementos en @code{**kwargs} ahora @ref{cc0,,corresponds to the order} en el que se pasaron argumentos de palabras clave a la función.

@item 
Se han agregado DTrace y SystemTap @ref{cc1,,probing support}.

@item 
La nueva variable de entorno @ref{cc2,,PYTHONMALLOC} ahora se puede utilizar para depurar la asignación de memoria del intérprete y los errores de acceso.
@end itemize

Mejoras significativas en la biblioteca estándar:


@itemize *

@item 
El módulo @ref{b,,asyncio} ha recibido nuevas funciones, mejoras significativas de rendimiento y usabilidad, y una buena cantidad de correcciones de errores. A partir de Python 3.6, el módulo @code{asyncio} ya no es provisional y su API se considera estable.

@item 
Se ha implementado un nuevo @ref{cc3,,file system path protocol} para admitir @ref{3f0,,path-like objects}. Todas las funciones de biblioteca estándar que operan en rutas se han actualizado para trabajar con el nuevo protocolo.

@item 
El módulo @ref{31,,datetime} ha ganado soporte para @ref{cc4,,Local Time Disambiguation}.

@item 
El módulo @ref{104,,typing} recibió varios @ref{cc5,,improvements}.

@item 
El módulo @ref{ff,,tracemalloc} se ha rediseñado significativamente y ahora se utiliza para proporcionar una mejor salida para @ref{39d,,ResourceWarning}, así como para proporcionar un mejor diagnóstico de errores de asignación de memoria. Consulte @ref{cc2,,PYTHONMALLOC section} para obtener más información.
@end itemize

Mejoras de seguridad:


@itemize *

@item 
Se ha agregado el nuevo módulo @ref{c0,,secrets} para simplificar la generación de números pseudoaleatorios criptográficamente fuertes adecuados para administrar secretos como autenticación de cuentas, tokens y similares.

@item 
En Linux, @ref{5c6,,os.urandom()} ahora se bloquea hasta que se inicializa el grupo de entropía aleatoria del sistema para aumentar la seguridad. Consulte el 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} para conocer la justificación.

@item 
Los módulos @ref{68,,hashlib} y @ref{d0,,ssl} ahora son compatibles con OpenSSL 1.1.0.

@item 
Se han mejorado la configuración predeterminada y el conjunto de funciones del módulo @ref{d0,,ssl}.

@item 
El módulo @ref{68,,hashlib} recibió soporte para los algoritmos hash BLAKE2, SHA-3 y SHAKE y la función de derivación de claves @ref{cc6,,scrypt()}.
@end itemize

Mejoras de Windows:


@itemize *

@item 
@ref{cc7,,PEP 528} y @ref{cc8,,PEP 529}, el sistema de archivos de Windows y la codificación de la consola cambiaron a UTF-8.

@item 
El lanzador @code{py.exe}, cuando se usa de forma interactiva, ya no prefiere Python 2 sobre Python 3 cuando el usuario no especifica una versión (a través de argumentos de línea de comando o un archivo de configuración). El manejo de las líneas shebang permanece sin cambios - «python» se refiere a Python 2 en ese caso.

@item 
@code{python.exe} y @code{pythonw.exe} se han marcado como con reconocimiento de ruta larga, lo que significa que es posible que ya no se aplique el límite de ruta de 260 caracteres. Consulte @ref{cc9,,removing the MAX_PATH limitation} para obtener más detalles.

@item 
Se puede agregar un archivo @code{._pth} para forzar el modo aislado y especificar completamente todas las rutas de búsqueda para evitar búsquedas en el registro y el entorno. Consulte @ref{ca9,,la documentación} para obtener más información.

@item 
Un archivo @code{python36.zip} ahora funciona como un punto de referencia para inferir 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}. Consulte @ref{ca9,,la documentación} para obtener más información.
@end itemize

@node Nuevas características<10>,Otros cambios de idioma<4>,Resumen aspectos destacados de la versión<4>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 new-features}@anchor{cca}@anchor{whatsnew/3 6 pypy-dict-implementation}@anchor{ccb}
@subsection Nuevas características


@menu
* PEP 498; Literales de cadena formateados: PEP 498 Literales de cadena formateados. 
* PEP 526; Sintaxis para anotaciones de variables: PEP 526 Sintaxis para anotaciones de variables. 
* PEP 515; subrayados en literales numéricos: PEP 515 subrayados en literales numéricos. 
* PEP 525; Generadores asíncronos: PEP 525 Generadores asíncronos. 
* PEP 530; Comprensiones asincrónicas: PEP 530 Comprensiones asincrónicas. 
* PEP 487; personalización más sencilla de la creación de clases: PEP 487 personalización más sencilla de la creación de clases. 
* PEP 487; Mejoras en el protocolo descriptor: PEP 487 Mejoras en el protocolo descriptor. 
* PEP 519; Agregar un protocolo de ruta del sistema de archivos: PEP 519 Agregar un protocolo de ruta del sistema de archivos. 
* PEP 495; desambiguación de la hora local: PEP 495 desambiguación de la hora local. 
* PEP 529; cambie la codificación del sistema de archivos de Windows a UTF-8: PEP 529 cambie la codificación del sistema de archivos de Windows a UTF-8. 
* PEP 528; cambie la codificación de la consola de Windows a UTF-8: PEP 528 cambie la codificación de la consola de Windows a UTF-8. 
* PEP 520; Conservación del orden de definición de atributos de clase: PEP 520 Conservación del orden de definición de atributos de clase. 
* PEP 468; Conservación del orden de los argumentos de las palabras clave: PEP 468 Conservación del orden de los argumentos de las palabras clave. 
* Nueva implementación de dict:: 
* PEP 523; Agregar una API de evaluación de marcos a CPython: PEP 523 Agregar una API de evaluación de marcos a CPython. 
* Variable de entorno PYTHONMALLOC:: 
* Soporte de sondeo DTrace y SystemTap:: 

@end menu

@node PEP 498 Literales de cadena formateados,PEP 526 Sintaxis para anotaciones de variables,,Nuevas características<10>
@anchor{whatsnew/3 6 pep-498-formatted-string-literals}@anchor{ccc}@anchor{whatsnew/3 6 whatsnew36-pep498}@anchor{cb7}
@subsubsection PEP 498: Literales de cadena formateados


@geindex Python Enhancement Proposals; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} introduce un nuevo tipo de cadenas literales: `f-strings' o @ref{a3b,,formatted string literals}.

Los literales de cadena formateados tienen el prefijo @code{'f'} y son similares a las cadenas de formato aceptadas por @ref{6c2,,str.format()}. Contienen campos de reemplazo rodeados por llaves. Los campos de reemplazo son expresiones, que se evalúan en tiempo de ejecución y luego se formatean usando el protocolo @ref{6c0,,format()}:

@example
>>> name = "Fred"
>>> f"He said his name is @{name@}."
'He said his name is Fred.'
>>> width = 10
>>> precision = 4
>>> value = decimal.Decimal("12.34567")
>>> f"result: @{value:@{width@}.@{precision@}@}"  # nested fields
'result:      12.35'
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 498

@item PEP 498@footnote{https://peps.python.org/pep-0498/} - Interpolación de cadenas literal.

PEP escrito e implementado por Eric V. Smith.
@end table

@ref{a3b,,Feature documentation}.


@node PEP 526 Sintaxis para anotaciones de variables,PEP 515 subrayados en literales numéricos,PEP 498 Literales de cadena formateados,Nuevas características<10>
@anchor{whatsnew/3 6 pep-526-syntax-for-variable-annotations}@anchor{ccd}@anchor{whatsnew/3 6 whatsnew36-pep526}@anchor{cb9}
@subsubsection PEP 526: Sintaxis para anotaciones de variables


@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introdujo el estándar para anotaciones de tipo de parámetros de función, también conocido como sugerencias de tipo. Este PEP agrega sintaxis a Python para anotar los tipos de variables, incluidas las variables de clase y las variables de instancia:

@example
primes: List[int] = []

captain: str  # Note: no initial value!

class Starship:
    stats: Dict[str, int] = @{@}
@end example

Al igual que para las anotaciones de funciones, el intérprete de Python no asigna ningún significado particular a las anotaciones de variables y solo las almacena en el atributo @code{__annotations__} de una clase o módulo.

A diferencia de las declaraciones de variables en lenguajes tipados estáticamente, el objetivo de la sintaxis de anotación es proporcionar una manera fácil de especificar metadatos de tipo estructurado para herramientas y bibliotecas de terceros a través del árbol de sintaxis abstracta y el atributo @code{__annotations__}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/}: sintaxis para anotaciones de variables.

PEP escrito por Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa Roach y Guido van Rossum. Implementado por Ivan Levkivskyi.
@end table

Tools that use or will use the new syntax:
mypy@footnote{https://www.mypy-lang.org/},
pytype@footnote{https://github.com/google/pytype}, PyCharm, etc.


@node PEP 515 subrayados en literales numéricos,PEP 525 Generadores asíncronos,PEP 526 Sintaxis para anotaciones de variables,Nuevas características<10>
@anchor{whatsnew/3 6 pep-515-underscores-in-numeric-literals}@anchor{cce}@anchor{whatsnew/3 6 whatsnew36-pep515}@anchor{cb8}
@subsubsection PEP 515: subrayados en literales numéricos


@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} agrega la capacidad de usar guiones bajos en literales numéricos para mejorar la legibilidad. Por ejemplo:

@example
>>> 1_000_000_000_000_000
1000000000000000
>>> 0x_FF_FF_FF_FF
4294967295
@end example

Se permiten guiones bajos simples entre dígitos y después de cualquier especificador de base. No se permiten guiones bajos al principio, al final o múltiples en una fila.

The @ref{347,,string formatting} language also now has support
for the @code{'_'} option to signal the use of an underscore for a thousands
separator for floating-point presentation types and for integer
presentation type @code{'d'}.  For integer presentation types @code{'b'},
@code{'o'}, @code{'x'}, and @code{'X'}, underscores will be inserted every 4
digits:

@example
>>> '@{:_@}'.format(1000000)
'1_000_000'
>>> '@{:_x@}'.format(0xFFFFFFFF)
'ffff_ffff'
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 515

@item PEP 515@footnote{https://peps.python.org/pep-0515/} - Guiones bajos en literales numéricos

PEP escrito por Georg Brandl y Serhiy Storchaka.
@end table


@node PEP 525 Generadores asíncronos,PEP 530 Comprensiones asincrónicas,PEP 515 subrayados en literales numéricos,Nuevas características<10>
@anchor{whatsnew/3 6 pep-525-asynchronous-generators}@anchor{ccf}@anchor{whatsnew/3 6 whatsnew36-pep525}@anchor{cba}
@subsubsection PEP 525: Generadores asíncronos


@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} introdujo soporte para corrutinas nativas y sintaxis @code{async} / @code{await} para Python 3.5. Una limitación notable de la implementación de Python 3.5 es que no fue posible usar @code{await} y @code{yield} en el mismo cuerpo de función. En Python 3.6 se eliminó esta restricción, lo que permite definir `asynchronous generators'

@example
async def ticker(delay, to):
    """Yield numbers from 0 to *to* every *delay* seconds."""
    for i in range(to):
        yield i
        await asyncio.sleep(delay)
@end example

La nueva sintaxis permite un código más rápido y conciso.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/} - Generadores asincrónicos

PEP escrito e implementado por Yury Selivanov.
@end table


@node PEP 530 Comprensiones asincrónicas,PEP 487 personalización más sencilla de la creación de clases,PEP 525 Generadores asíncronos,Nuevas características<10>
@anchor{whatsnew/3 6 pep-530-asynchronous-comprehensions}@anchor{cd0}@anchor{whatsnew/3 6 whatsnew36-pep530}@anchor{cbb}
@subsubsection PEP 530: Comprensiones asincrónicas


@geindex Python Enhancement Proposals; PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/} agrega soporte para usar @code{async for} en listas, conjuntos, dict comprensiones y expresiones generadoras:

@example
result = [i async for i in aiter() if i % 2]
@end example

Además, las expresiones @code{await} son compatibles con todo tipo de comprensiones:

@example
result = [await fun() for fun in funcs if await condition()]
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 530

@item PEP 530@footnote{https://peps.python.org/pep-0530/} - Comprensiones asincrónicas

PEP escrito e implementado por Yury Selivanov.
@end table


@node PEP 487 personalización más sencilla de la creación de clases,PEP 487 Mejoras en el protocolo descriptor,PEP 530 Comprensiones asincrónicas,Nuevas características<10>
@anchor{whatsnew/3 6 pep-487-simpler-customization-of-class-creation}@anchor{cd1}@anchor{whatsnew/3 6 whatsnew36-pep487}@anchor{cbe}
@subsubsection PEP 487: personalización más sencilla de la creación de clases


Ahora es posible personalizar la creación de subclases sin utilizar una metaclase. El nuevo método de clase @code{__init_subclass__} se llamará en la clase base siempre que se cree una nueva subclase:

@example
class PluginBase:
    subclasses = []

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.subclasses.append(cls)

class Plugin1(PluginBase):
    pass

class Plugin2(PluginBase):
    pass
@end example

Para permitir que las llamadas @ref{155,,super()} sin argumentos funcionen correctamente desde las implementaciones @ref{6d2,,__init_subclass__()}, las metaclases personalizadas deben garantizar que la nueva entrada del espacio de nombres @code{__classcell__} se propague a @code{type.__new__} (como se describe en @ref{cd2,,Creando el objeto de clase}).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/}: personalización más sencilla de la creación de clases

PEP escrito e implementado por Martin Teichmann.
@end table

@ref{cd3,,Feature documentation}


@node PEP 487 Mejoras en el protocolo descriptor,PEP 519 Agregar un protocolo de ruta del sistema de archivos,PEP 487 personalización más sencilla de la creación de clases,Nuevas características<10>
@anchor{whatsnew/3 6 pep-487-descriptor-protocol-enhancements}@anchor{cd4}@anchor{whatsnew/3 6 whatsnew36-pep487-descriptors}@anchor{cd5}
@subsubsection PEP 487: Mejoras en el protocolo descriptor


@geindex Python Enhancement Proposals; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} amplía el protocolo descriptor para incluir el nuevo método opcional @ref{cd6,,__set_name__()}. Siempre que se defina una nueva clase, se llamará al nuevo método en todos los descriptores incluidos en la definición, proporcionándoles una referencia a la clase que se está definiendo y el nombre dado al descriptor dentro del espacio de nombres de la clase. En otras palabras, las instancias de descriptores ahora pueden conocer el nombre de atributo del descriptor en la clase propietaria:

@example
class IntField:
    def __get__(self, instance, owner):
        return instance.__dict__[self.name]

    def __set__(self, instance, value):
        if not isinstance(value, int):
            raise ValueError(f'expecting integer in @{self.name@}')
        instance.__dict__[self.name] = value

    # this is the new initializer:
    def __set_name__(self, owner, name):
        self.name = name

class Model:
    int_field = IntField()
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/}: personalización más sencilla de la creación de clases

PEP escrito e implementado por Martin Teichmann.
@end table

@ref{cd7,,Feature documentation}


@node PEP 519 Agregar un protocolo de ruta del sistema de archivos,PEP 495 desambiguación de la hora local,PEP 487 Mejoras en el protocolo descriptor,Nuevas características<10>
@anchor{whatsnew/3 6 pep-519-adding-a-file-system-path-protocol}@anchor{cd8}@anchor{whatsnew/3 6 whatsnew36-pep519}@anchor{cc3}
@subsubsection PEP 519: Agregar un protocolo de ruta del sistema de archivos


Históricamente, las rutas del sistema de archivos se han representado como objetos @ref{237,,str} o @ref{325,,bytes}. Esto ha llevado a las personas que escriben códigos que operan en las rutas del sistema de archivos a asumir que dichos objetos son solo uno de esos dos tipos (un @ref{1f0,,int} que representa un descriptor de archivo no cuenta, ya que no es una ruta de archivo). Desafortunadamente, esa suposición evita que las representaciones de objetos alternativos de las rutas del sistema de archivos como @ref{a4,,pathlib} funcionen con código preexistente, incluida la biblioteca estándar de Python.

Para solucionar esta situación, se ha definido una nueva interfaz representada por @ref{cd9,,os.PathLike}. Al implementar el método @ref{cda,,__fspath__()}, un objeto indica que representa una ruta. Entonces, un objeto puede proporcionar una representación de bajo nivel de una ruta del sistema de archivos como un objeto @ref{237,,str} o @ref{325,,bytes}. Esto significa que un objeto se considera @ref{3f0,,path-like} si implementa @ref{cd9,,os.PathLike} o es un objeto @ref{237,,str} o @ref{325,,bytes} que representa una ruta del sistema de archivos. El código puede usar @ref{cdb,,os.fspath()}, @ref{cdc,,os.fsdecode()} o @ref{cdd,,os.fsencode()} para obtener explícitamente una representación @ref{237,,str} y / o @ref{325,,bytes} de un objeto similar a una ruta.

La función @ref{1be,,open()} incorporada se ha actualizado para aceptar objetos @ref{cd9,,os.PathLike}, al igual que todas las funciones relevantes en los módulos @ref{a1,,os} y @ref{a2,,os.path}, y la mayoría de las otras funciones y clases en la biblioteca estándar. La clase @ref{1a1,,os.DirEntry} y las clases relevantes en @ref{a4,,pathlib} también se han actualizado para implementar @ref{cd9,,os.PathLike}.

La esperanza es que la actualización de las funciones fundamentales para operar en las rutas del sistema de archivos conducirá a un código de terceros para admitir implícitamente todos los @ref{3f0,,path-like objects} sin ningún cambio de código, o al menos muy mínimos (por ejemplo, llamar a @ref{cdb,,os.fspath()} al comienzo del código antes de operar en un objeto similar a una ruta).

A continuación, se muestran algunos ejemplos de cómo la nueva interfaz permite que @ref{19b,,pathlib.Path} se utilice de manera más fácil y transparente con código preexistente:

@example
>>> import pathlib
>>> with open(pathlib.Path("README")) as f:
...     contents = f.read()
...
>>> import os.path
>>> os.path.splitext(pathlib.Path("some_file.txt"))
('some_file', '.txt')
>>> os.path.join("/a/b", pathlib.Path("c"))
'/a/b/c'
>>> import os
>>> os.fspath(pathlib.Path("some_file.txt"))
'some_file.txt'
@end example

(Implementado por Brett Cannon, Ethan Furman, Dusty Phillips y Jelle Zijlstra).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 519

@item PEP 519@footnote{https://peps.python.org/pep-0519/}: adición de un protocolo de ruta del sistema de archivos

PEP escrito por Brett Cannon y Koos Zevenhoven.
@end table


@node PEP 495 desambiguación de la hora local,PEP 529 cambie la codificación del sistema de archivos de Windows a UTF-8,PEP 519 Agregar un protocolo de ruta del sistema de archivos,Nuevas características<10>
@anchor{whatsnew/3 6 pep-495-local-time-disambiguation}@anchor{cde}@anchor{whatsnew/3 6 whatsnew36-pep495}@anchor{cc4}
@subsubsection PEP 495: desambiguación de la hora local


En la mayoría de las ubicaciones del mundo, ha habido y habrá ocasiones en las que los relojes locales se retrasaron. En esos horarios, se introducen intervalos en los que los relojes locales marcan la misma hora dos veces en el mismo día. En estas situaciones, la información mostrada en un reloj local (o almacenada en una instancia de fecha y hora de Python) es insuficiente para identificar un momento particular en el tiempo.

@geindex Python Enhancement Proposals; PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} agrega el nuevo atributo `fold' a las instancias de las clases @ref{32f,,datetime.datetime} y @ref{331,,datetime.time} para diferenciar entre dos momentos en el tiempo en los que las horas locales son las mismas:

@example
>>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0
@end example

Los valores del atributo @ref{cdf,,fold} tienen el valor @code{0} para todas las instancias excepto aquellas que representan el segundo momento (cronológicamente) en el tiempo en un caso ambiguo.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 495

@item PEP 495@footnote{https://peps.python.org/pep-0495/} - Desambiguación de hora local

PEP escrito por Alexander Belopolsky y Tim Peters, implementación por Alexander Belopolsky.
@end table


@node PEP 529 cambie la codificación del sistema de archivos de Windows a UTF-8,PEP 528 cambie la codificación de la consola de Windows a UTF-8,PEP 495 desambiguación de la hora local,Nuevas características<10>
@anchor{whatsnew/3 6 pep-529-change-windows-filesystem-encoding-to-utf-8}@anchor{ce0}@anchor{whatsnew/3 6 whatsnew36-pep529}@anchor{cc8}
@subsubsection PEP 529: cambie la codificación del sistema de archivos de Windows a UTF-8


La representación de las rutas del sistema de archivos se realiza mejor con str (Unicode) en lugar de bytes. Sin embargo, hay algunas situaciones en las que el uso de bytes es suficiente y correcto.

Prior to Python 3.6, data loss could result when using bytes paths on Windows.
With this change, using bytes to represent paths is now supported on Windows,
provided those bytes are encoded with the encoding returned by
@ref{ce1,,sys.getfilesystemencoding()}, which now defaults to @code{'utf-8'}.

Applications that do not use str to represent paths should use
@ref{cdd,,os.fsencode()} and @ref{cdc,,os.fsdecode()} to ensure their bytes are
correctly encoded. To revert to the previous behaviour, set
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} or call
@ref{1e6,,sys._enablelegacywindowsfsencoding()}.

Consulte 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para obtener más información y una discusión sobre las modificaciones de código que pueden ser necesarias.

@node PEP 528 cambie la codificación de la consola de Windows a UTF-8,PEP 520 Conservación del orden de definición de atributos de clase,PEP 529 cambie la codificación del sistema de archivos de Windows a UTF-8,Nuevas características<10>
@anchor{whatsnew/3 6 pep-528-change-windows-console-encoding-to-utf-8}@anchor{ce2}@anchor{whatsnew/3 6 whatsnew36-pep528}@anchor{cc7}
@subsubsection PEP 528: cambie la codificación de la consola de Windows a UTF-8


La consola predeterminada en Windows ahora aceptará todos los caracteres Unicode y proporcionará objetos str leídos correctamente al código Python. @code{sys.stdin}, @code{sys.stdout} y @code{sys.stderr} ahora tienen la codificación utf-8 por defecto.

Este cambio solo se aplica cuando se usa una consola interactiva y no cuando se redirigen archivos o canalizaciones. Para volver al comportamiento anterior para el uso de la consola interactiva, configure 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@ref{ce3,,PYTHONLEGACYWINDOWSSTDIO}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 528

@item PEP 528@footnote{https://peps.python.org/pep-0528/}: cambie la codificación de la consola de Windows a UTF-8

PEP escrito e implementado por Steve Dower.
@end table


@node PEP 520 Conservación del orden de definición de atributos de clase,PEP 468 Conservación del orden de los argumentos de las palabras clave,PEP 528 cambie la codificación de la consola de Windows a UTF-8,Nuevas características<10>
@anchor{whatsnew/3 6 pep-520-preserving-class-attribute-definition-order}@anchor{ce4}@anchor{whatsnew/3 6 whatsnew36-pep520}@anchor{cbf}
@subsubsection PEP 520: Conservación del orden de definición de atributos de clase


Attributes in a class definition body have a natural ordering: the same
order in which the names appear in the source.  This order is now
preserved in the new class’s @ref{ce5,,__dict__} attribute.

Además, el espacio de nombres de clase `execution' predeterminado efectivo (devuelto desde @ref{ce6,,type.__prepare__()}) ahora es una asignación que conserva el orden de inserción.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 520

@item PEP 520@footnote{https://peps.python.org/pep-0520/} - Conservación del orden de definición de atributos de clase

PEP escrito e implementado por Eric Snow.
@end table


@node PEP 468 Conservación del orden de los argumentos de las palabras clave,Nueva implementación de dict,PEP 520 Conservación del orden de definición de atributos de clase,Nuevas características<10>
@anchor{whatsnew/3 6 pep-468-preserving-keyword-argument-order}@anchor{ce7}@anchor{whatsnew/3 6 whatsnew36-pep468}@anchor{cc0}
@subsubsection PEP 468: Conservación del orden de los argumentos de las palabras clave


Ahora se garantiza que @code{**kwargs} en una firma de función es un mapeo que conserva el orden de inserción.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 468

@item PEP 468@footnote{https://peps.python.org/pep-0468/} - Conservación del orden de los argumentos de las palabras clave

PEP escrito e implementado por Eric Snow.
@end table


@node Nueva implementación de dict,PEP 523 Agregar una API de evaluación de marcos a CPython,PEP 468 Conservación del orden de los argumentos de las palabras clave,Nuevas características<10>
@anchor{whatsnew/3 6 new-dict-implementation}@anchor{ce8}@anchor{whatsnew/3 6 whatsnew36-compactdict}@anchor{cbd}
@subsubsection Nueva implementación de dict


El tipo @ref{b51,,dict} ahora usa una representación «compacta» basada en a proposal by Raymond Hettinger@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html} que era first implemented by PyPy@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}. El uso de memoria del nuevo @ref{190,,dict()} es entre un 20% y un 25% menor en comparación con Python 3.5.

El aspecto de conservación del orden de esta nueva implementación se considera un detalle de implementación y no se debe confiar en él (esto puede cambiar en el futuro, pero se desea tener esta nueva implementación de dict en el idioma para algunas versiones antes de cambiar la especificación del idioma para exigir la semántica de preservación del orden para todas las implementaciones de Python actuales y futuras; esto también ayuda a preservar la compatibilidad con versiones anteriores del lenguaje donde el orden de iteración aleatorio todavía está vigente, por ejemplo, Python 3.5).

(Contribuido por INADA Naoki en bpo-27350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27350}. Idea originally suggested by Raymond Hettinger@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html}.)

@node PEP 523 Agregar una API de evaluación de marcos a CPython,Variable de entorno PYTHONMALLOC,Nueva implementación de dict,Nuevas características<10>
@anchor{whatsnew/3 6 pep-523-adding-a-frame-evaluation-api-to-cpython}@anchor{ce9}@anchor{whatsnew/3 6 whatsnew36-pep523}@anchor{cea}
@subsubsection PEP 523: Agregar una API de evaluación de marcos a CPython


Si bien Python proporciona un amplio soporte para personalizar cómo se ejecuta el código, un lugar en el que no lo ha hecho es en la evaluación de objetos de marco. Si quisiera alguna forma de interceptar la evaluación de marcos en Python, realmente no había ninguna forma sin manipular directamente los punteros de función para las funciones definidas.

@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} cambia esto al proporcionar una API para hacer que la evaluación de tramas se pueda conectar en el nivel C. Esto permitirá que herramientas como depuradores y JIT intercepten la evaluación del marco antes de que comience la ejecución del código Python. Esto permite el uso de implementaciones de evaluación alternativas para el código Python, seguimiento de la evaluación del marco, etc.

Esta API no forma parte de la API C limitada y está marcada como privada para indicar que se espera que el uso de esta API sea limitado y solo se aplique a casos de uso muy selectos y de bajo nivel. La semántica de la API cambiará con Python según sea necesario.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 523

@item PEP 523@footnote{https://peps.python.org/pep-0523/}: agregar una API de evaluación de marcos a CPython

PEP escrito por Brett Cannon y Dino Viehland.
@end table


@node Variable de entorno PYTHONMALLOC,Soporte de sondeo DTrace y SystemTap,PEP 523 Agregar una API de evaluación de marcos a CPython,Nuevas características<10>
@anchor{whatsnew/3 6 pythonmalloc-environment-variable}@anchor{ceb}@anchor{whatsnew/3 6 whatsnew36-pythonmalloc}@anchor{cc2}
@subsubsection Variable de entorno PYTHONMALLOC


La nueva variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} permite configurar los asignadores de memoria e instalar Python ganchos de depuración.

Ahora es posible instalar enlaces de depuración en asignadores de memoria de Python en Python compilado en modo de lanzamiento usando @code{PYTHONMALLOC=debug}. Efectos de los ganchos de depuración:


@itemize *

@item 
La memoria recién asignada se llena con el byte @code{0xCB}

@item 
La memoria liberada se llena con el byte @code{0xDB}

@item 
Detecta violaciones de la API de asignación de memoria de Python. Por ejemplo, @ref{ced,,PyObject_Free()} llamó a un bloque de memoria asignado por @ref{cee,,PyMem_Malloc()}.

@item 
Detectar escrituras antes del inicio de un búfer (subdesbordamientos del búfer)

@item 
Detectar escrituras después del final de un búfer (desbordes de búfer)

@item 
Check that the @ref{2b5,,GIL} is held when allocator
functions of @ref{cef,,PYMEM_DOMAIN_OBJ} (ex: @ref{cf0,,PyObject_Malloc()}) and
@ref{cf1,,PYMEM_DOMAIN_MEM} (ex: @ref{cee,,PyMem_Malloc()}) domains are called.
@end itemize

Verificar si el GIL se mantiene también es una nueva característica de Python 3.6.

Consulte la función @ref{cf2,,PyMem_SetupDebugHooks()} para ver los enlaces de depuración en los asignadores de memoria de Python.

Ahora también es posible forzar el uso del asignador @code{malloc()} de la biblioteca C para todas las asignaciones de memoria de Python usando @code{PYTHONMALLOC=malloc}. Esto es útil cuando se utilizan depuradores de memoria externa como Valgrind en un Python compilado en modo de lanzamiento.

En caso de error, los ganchos de depuración en los asignadores de memoria de Python ahora usan el módulo @ref{ff,,tracemalloc} para obtener el rastreo donde se asignó un bloque de memoria.

Ejemplo de error fatal en el desbordamiento del búfer usando @code{python3.6 -X tracemalloc=5} (almacenar 5 cuadros en trazas):

@example
Debug memory block at address p=0x7fbcd41666f8: API 'o'
    4 bytes originally requested
    The 7 pad bytes at p-7 are FORBIDDENBYTE, as expected.
    The 8 pad bytes at tail=0x7fbcd41666fc are not all FORBIDDENBYTE (0xfb):
        at tail+0: 0x02 *** OUCH
        at tail+1: 0xfb
        at tail+2: 0xfb
        at tail+3: 0xfb
        at tail+4: 0xfb
        at tail+5: 0xfb
        at tail+6: 0xfb
        at tail+7: 0xfb
    The block was made by call #1233329 to debug malloc/realloc.
    Data at p: 1a 2b 30 00

Memory block allocated at (most recent call first):
  File "test/test_bytes.py", line 323
  File "unittest/case.py", line 600
  File "unittest/case.py", line 648
  File "unittest/suite.py", line 122
  File "unittest/suite.py", line 84

Fatal Python error: bad trailing pad byte

Current thread 0x00007fbcdbd32700 (most recent call first):
  File "test/test_bytes.py", line 323 in test_hex
  File "unittest/case.py", line 600 in run
  File "unittest/case.py", line 648 in __call__
  File "unittest/suite.py", line 122 in run
  File "unittest/suite.py", line 84 in __call__
  File "unittest/suite.py", line 122 in run
  File "unittest/suite.py", line 84 in __call__
  ...
@end example

(Contribución de Victor Stinner en bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516} y :issue:` 26564`.)

@node Soporte de sondeo DTrace y SystemTap,,Variable de entorno PYTHONMALLOC,Nuevas características<10>
@anchor{whatsnew/3 6 dtrace-and-systemtap-probing-support}@anchor{cf3}@anchor{whatsnew/3 6 whatsnew36-tracing}@anchor{cc1}
@subsubsection Soporte de sondeo DTrace y SystemTap


Python ahora se puede construir @code{--with-dtrace} que habilita marcadores estáticos para los siguientes eventos en el intérprete:


@itemize *

@item 
función llamada / retorno

@item 
recogida de basura iniciada / finalizada

@item 
línea de código ejecutada.
@end itemize

Esto se puede utilizar para instrumentar intérpretes en ejecución en producción, sin la necesidad de volver a compilar @ref{357,,debug builds} específico o proporcionar código de depuración / perfilado específico de la aplicación.

Más detalles en @ref{cf4,,Instrumentación de CPython con DTrace y SystemTap}.

La implementación actual se prueba en Linux y macOS. Es posible que se agreguen marcadores adicionales en el futuro.

(Contribuido por Łukasz Langa en bpo-21590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21590}, basado en parches de Jesús Cea Avión, David Malcolm y Nikhil Benesch.)

@node Otros cambios de idioma<4>,Nuevos módulos<6>,Nuevas características<10>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 other-language-changes}@anchor{cf5}
@subsection Otros cambios de idioma


Algunos cambios más pequeños realizados en el lenguaje central de Python son:


@itemize *

@item 
Una declaración @code{global} o @code{nonlocal} ahora debe aparecer textualmente antes del primer uso del nombre afectado en el mismo ámbito. Anteriormente, este era un @ref{511,,SyntaxWarning}.

@item 
Ahora es posible establecer un @ref{cf6,,special method} en @code{None} para indicar que la operación correspondiente no está disponible. Por ejemplo, si una clase establece @code{__iter__()} en @code{None}, la clase no es iterable. (Contribuido por Andrew Barnert e Ivan Levkivskyi en bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}.)

@item 
Las secuencias largas de líneas de rastreo repetidas ahora se abrevian como @code{"[Previous line repeated @{count@} more times]"} (consulte @ref{cf7,,rastrear} para ver un ejemplo). (Contribución de Emanuel Barry en bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@item 
Importar ahora lanza la nueva excepción @ref{bcf,,ModuleNotFoundError} (subclase de @ref{4d7,,ImportError}) cuando no puede encontrar un módulo. El código que actualmente busca ImportError (en try-except) seguirá funcionando. (Contribución de Eric Snow en bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@item 
Los métodos de clase que se basan en @code{super()} de argumento cero ahora funcionarán correctamente cuando se llamen desde métodos de metaclase durante la creación de la clase. (Contribución de Martin Teichmann en bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}.)
@end itemize

@node Nuevos módulos<6>,Módulos mejorados<7>,Otros cambios de idioma<4>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 new-modules}@anchor{cf8}
@subsection Nuevos módulos


@menu
* misterios:: 

@end menu

@node misterios,,,Nuevos módulos<6>
@anchor{whatsnew/3 6 secrets}@anchor{cf9}@anchor{whatsnew/3 6 whatsnew36-pep506}@anchor{cbc}
@subsubsection misterios


El objetivo principal del nuevo módulo @ref{c0,,secrets} es proporcionar una forma obvia de generar de manera confiable valores pseudoaleatorios criptográficamente fuertes adecuados para administrar secretos, como autenticación de cuentas, tokens y similares.

@cartouche
@quotation Advertencia 
Note that the pseudo-random generators in the @ref{b8,,random} module
should `NOT' be used for security purposes.  Use @ref{c0,,secrets}
on Python 3.6+ and @ref{5c6,,os.urandom()} on Python 3.5 and earlier.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 506

@item PEP 506@footnote{https://peps.python.org/pep-0506/}: adición de un módulo de secretos a la biblioteca estándar

PEP escrito e implementado por Steven D’Aprano.
@end table


@node Módulos mejorados<7>,Optimizaciones<7>,Nuevos módulos<6>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 improved-modules}@anchor{cfa}
@subsection Módulos mejorados


@menu
* formación: formación<2>. 
* ast: ast<6>. 
* asyncio: asyncio<9>. 
* binascii: binascii<2>. 
* cmath:: 
* colecciones:: 
* Futuros concurrentes: Futuros concurrentes<2>. 
* contextlib: contextlib<4>. 
* fecha y hora: fecha y hora<3>. 
* decimal: decimal<3>. 
* distutils: distutils<5>. 
* Email:: 
* codificaciones: codificaciones<2>. 
* enumeración: enumeración<2>. 
* manipulador de faltas: manipulador de faltas<2>. 
* entrada de archivo: entrada de archivo<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib y IDLE:: 
* importlib: importlib<7>. 
* inspeccionar: inspeccionar<4>. 
* json: json<2>. 
* Inicio sesión: Inicio sesión<2>. 
* Matemáticas: Matemáticas<3>. 
* multiprocesamiento: multiprocesamiento<2>. 
* os: os<8>. 
* Pathlib: Pathlib<3>. 
* pdb: pdb<5>. 
* pepinillo:: 
* pepinillos:: 
* Pydoc: Pydoc<2>. 
* aleatorio: aleatorio<2>. 
* re: re<5>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* sitio: sitio<2>. 
* sqlite3: sqlite3<8>. 
* enchufe: enchufe<4>. 
* servidor de sockets:: 
* ssl: ssl<7>. 
* Estadísticas: Estadísticas<2>. 
* estructura:: 
* subproceso:: 
* sys: sys<9>. 
* telnetlib:: 
* tiempo: tiempo<3>. 
* cronométralo:: 
* tkinter: tkinter<6>. 
* rastrear: rastrear<3>. 
* tracemalloc: tracemalloc<3>. 
* mecanografía: mecanografía<5>. 
* unicodedata: unicodedata<8>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* advertencias: advertencias<2>. 
* winreg:: 
* winsonido:: 
* xmlrpc.client: xmlrpc client. 
* archivo zip: archivo zip<2>. 
* zlib:: 

@end menu

@node formación<2>,ast<6>,,Módulos mejorados<7>
@anchor{whatsnew/3 6 array}@anchor{cfb}
@subsubsection formación


Los iteradores agotados de @ref{308,,array.array} ahora permanecerán agotados incluso si se extiende la matriz iterada. Esto es consistente con el comportamiento de otras secuencias mutables.

Contribuido por Serhiy Storchaka en bpo-26492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26492}.

@node ast<6>,asyncio<9>,formación<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 ast}@anchor{cfc}
@subsubsection ast


Se ha agregado el nuevo nodo @ref{211,,ast.Constant} AST. Puede ser utilizado por optimizadores AST externos con el propósito de plegado constante.

Contribuido por Victor Stinner en bpo-26146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26146}.

@node asyncio<9>,binascii<2>,ast<6>,Módulos mejorados<7>
@anchor{whatsnew/3 6 asyncio}@anchor{cfd}
@subsubsection asyncio


A partir de Python 3.6, el módulo @code{asyncio} ya no es provisional y su API se considera estable.

Cambios notables en el módulo @ref{b,,asyncio} desde Python 3.5.0 (todos retroportados a 3.5.x debido al estado provisional):


@itemize *

@item 
La función @ref{214,,get_event_loop()} se ha cambiado para devolver siempre el bucle que se está ejecutando actualmente cuando se llama desde corrutinas y devoluciones de llamada. (Contribuido por Yury Selivanov en bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}.)

@item 
La función @ref{cfe,,ensure_future()} y todas las funciones que la utilizan, como @ref{cff,,loop.run_until_complete()}, ahora aceptan todo tipo de @ref{314,,awaitable objects}. (Contribuido por Yury Selivanov.)

@item 
Nueva función @ref{91a,,run_coroutine_threadsafe()} para enviar corrutinas a bucles de eventos de otros hilos. (Contribución de Vincent Michel.)

@item 
Nuevo método @ref{d00,,Transport.is_closing()} para comprobar si el transporte está cerrando o está cerrado. (Contribuido por Yury Selivanov.)

@item 
El método @ref{b9e,,loop.create_server()} ahora puede aceptar una lista de hosts. (Contribuido por Yann Sionneau.)

@item 
Nuevo método @ref{d01,,loop.create_future()} para crear objetos Future. Esto permite implementaciones alternativas de bucle de eventos, como uvloop@footnote{https://github.com/MagicStack/uvloop}, para proporcionar una implementación @ref{c55,,asyncio.Future} más rápida. (Contribuido por Yury Selivanov en bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}.)

@item 
Nuevo método @ref{d02,,loop.get_exception_handler()} para obtener el controlador de excepciones actual. (Contribuido por Yury Selivanov en bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}.)

@item 
Nuevo método @ref{31b,,StreamReader.readuntil()} para leer datos de la secuencia hasta que aparezca una secuencia de bytes de separación. (Contribuido por Mark Korenberg.)

@item 
Se ha mejorado el rendimiento de @ref{d03,,StreamReader.readexactly()}. (Contribuido por Mark Korenberg en bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}.)

@item 
El método @ref{c9c,,loop.getaddrinfo()} está optimizado para evitar llamar a la función @code{getaddrinfo} del sistema si la dirección ya está resuelta. (Contribuido por A. Jesse Jiryu Davis.)

@item 
El método @ref{d04,,loop.stop()} se ha cambiado para detener el bucle inmediatamente después de la iteración actual. Se descartarán todas las devoluciones de llamada nuevas programadas como resultado de la última iteración. (Contribuido por Guido van Rossum en bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}.)

@item 
@code{Future.set_exception} ahora lanzará @ref{228,,TypeError} cuando se pase una instancia de la excepción @ref{c82,,StopIteration}. (Contribuido por Chris Angelico en bpo-26221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26221}.)

@item 
Nuevo método @ref{d05,,loop.connect_accepted_socket()} para ser usado por servidores que aceptan conexiones fuera de asyncio, pero que usan asyncio para manejarlas. (Contribuido por Jim Fulton en bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}.)

@item 
El indicador @code{TCP_NODELAY} ahora está configurado para todos los transportes TCP de forma predeterminada. (Contribuido por Yury Selivanov en bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}.)

@item 
Nuevo @ref{d06,,loop.shutdown_asyncgens()} para cerrar correctamente los generadores asincrónicos pendientes antes de cerrar el ciclo. (Contribuido por Yury Selivanov en bpo-28003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28003}.)

@item 
Las clases @ref{c55,,Future} y @ref{580,,Task} ahora tienen una implementación C optimizada que hace que el código asyncio sea hasta un 30% más rápido. (Contribuido por Yury Selivanov e INADA Naoki en bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081} y bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}.)
@end itemize

@node binascii<2>,cmath,asyncio<9>,Módulos mejorados<7>
@anchor{whatsnew/3 6 binascii}@anchor{d07}
@subsubsection binascii


La función @ref{d08,,b2a_base64()} ahora acepta un argumento de palabra clave `newline' opcional para controlar si el carácter de nueva línea se agrega al valor de retorno. (Contribuido por Victor Stinner en bpo-25357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25357}.)

@node cmath,colecciones,binascii<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 cmath}@anchor{d09}
@subsubsection cmath


Se ha agregado la nueva constante @ref{d0a,,cmath.tau} (`τ'). (Contribuido por Lisa Roach en bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}, consulte 
@geindex Python Enhancement Proposals; PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/} para obtener más detalles).

Nuevas constantes: @ref{d0b,,cmath.inf} y @ref{d0c,,cmath.nan} para que coincidan con @ref{d0d,,math.inf} y @ref{704,,math.nan}, y también @ref{d0e,,cmath.infj} y @ref{d0f,,cmath.nanj} para que coincidan con el formato utilizado por la repetición compleja. (Contribuido por Mark Dickinson en bpo-23229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23229}.)

@node colecciones,Futuros concurrentes<2>,cmath,Módulos mejorados<7>
@anchor{whatsnew/3 6 collections}@anchor{d10}
@subsubsection colecciones


Se ha agregado la nueva clase base abstracta @ref{d11,,Collection} para representar clases de contenedores iterables de tamaño. (Contribuido por Ivan Levkivskyi, documentos de Neil Girdhar en bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}.)

La nueva clase base abstracta @ref{d12,,Reversible}. representa clases iterables que también proveen el método @code{__reversed__()}.(Contribuido por Ivan Levkivskyi en bpo-25987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25987}.)

La nueva clase base abstracta @ref{d13,,AsyncGenerator} representa generadores asincrónicos. (Contribuido por Yury Selivanov en bpo-28720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28720}.)

The @ref{32d,,namedtuple()} function now accepts an optional
keyword argument `module', which, when specified, is used for
the @ref{468,,__module__} attribute of the returned named tuple class.
(Contributed by Raymond Hettinger in bpo-17941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17941}.)

Los argumentos `verbose' and `rename' para @ref{32d,,namedtuple()} ahora son solo palabras clave. (Contribuido por Raymond Hettinger en bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}.)

Las instancias de @ref{67d,,collections.deque} recursivas ahora se pueden eliminar. (Contribuido por Serhiy Storchaka en bpo-26482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26482}.)

@node Futuros concurrentes<2>,contextlib<4>,colecciones,Módulos mejorados<7>
@anchor{whatsnew/3 6 concurrent-futures}@anchor{d14}
@subsubsection Futuros concurrentes


El constructor de la clase @ref{7dd,,ThreadPoolExecutor} ahora acepta un argumento `thread_name_prefix' opcional para que sea posible personalizar los nombres de los subprocesos creados por el grupo. (Contribuido por Gregory P. Smith en bpo-27664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27664}.)

@node contextlib<4>,fecha y hora<3>,Futuros concurrentes<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 contextlib}@anchor{d15}
@subsubsection contextlib


La clase @ref{d16,,contextlib.AbstractContextManager} fue agregada para proveer una clase abstracta para gestores de contexto. Provee una implementación por defecto sensible para @cite{__enter__()} que retorna @code{self} y deja un método abstracto @cite{__exit__()}. Se ha agregado una clase coincidente al módulo @ref{104,,typing} como @ref{d17,,typing.ContextManager}. (Contribuido por Brett Cannon en bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}.)

@node fecha y hora<3>,decimal<3>,contextlib<4>,Módulos mejorados<7>
@anchor{whatsnew/3 6 datetime}@anchor{d18}
@subsubsection fecha y hora


Las clases @ref{32f,,datetime} y @ref{331,,time} tienen el nuevo atributo @code{fold} utilizado para eliminar la ambigüedad de la hora local cuando sea necesario. Muchas funciones en el @ref{31,,datetime} se han actualizado para admitir la desambiguación de la hora local. Consulte la sección @ref{cc4,,Local Time Disambiguation} para obtener más información. (Contribuido por Alexander Belopolsky en bpo-24773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24773}.)

Los métodos @ref{d19,,datetime.strftime()} y @ref{d1a,,date.strftime()} ahora admiten las directivas de fecha ISO 8601 @code{%G}, @code{%u} y @code{%V}. (Contribuido por Ashley Anderson en bpo-12006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12006}.)

La función @ref{bb9,,datetime.isoformat()} ahora acepta un argumento `timespec' opcional que especifica el número de componentes adicionales del valor de tiempo a incluir. (Contribuido por Alessandro Cucci y Alexander Belopolsky en bpo-19475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19475}.)

El @ref{d1b,,datetime.combine()} ahora acepta un argumento `tzinfo' opcional. (Contribuido por Alexander Belopolsky en bpo-27661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27661}.)

@node decimal<3>,distutils<5>,fecha y hora<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 decimal}@anchor{d1c}
@subsubsection decimal


Nuevo método @ref{d1d,,Decimal.as_integer_ratio()} que devuelve un par @code{(n, d)} de enteros que representan la instancia @ref{16a,,Decimal} dada como una fracción, en términos más bajos y con un denominador positivo:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

(Contribuido por Stefan Krah y Mark Dickinson en bpo-25928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25928}.)

@node distutils<5>,Email,decimal<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 distutils}@anchor{d1e}
@subsubsection distutils


The @code{default_format} attribute has been removed from
@code{distutils.command.sdist.sdist} and the @code{formats}
attribute defaults to @code{['gztar']}. Although not anticipated,
any code relying on the presence of @code{default_format} may
need to be adapted. See bpo-27819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27819} for more details.

@node Email,codificaciones<2>,distutils<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 email}@anchor{d1f}
@subsubsection Email


La nueva API de correo electrónico, habilitada a través de la palabra clave `policy' para varios constructores, ya no es provisional. La documentación de @ref{3c,,email} se ha reorganizado y reescrito para centrarse en la nueva API, conservando la documentación anterior para la API heredada. (Contribuido por R. David Murray en bpo-24277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24277}.)

Las clases @ref{46,,email.mime} ahora aceptan todas una palabra clave `policy' opcional. (Contribuido por Berker Peksag en bpo-27331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27331}.)

El @ref{d20,,DecodedGenerator} ahora admite la palabra clave `policy'.

Hay un nuevo atributo @ref{50,,policy}, @ref{d21,,message_factory}, que controla qué clase se usa por defecto cuando el analizador crea nuevos objetos de mensaje. Para la política @ref{d22,,email.policy.compat32}, es @ref{3d1,,Message}, para las nuevas políticas es @ref{3d0,,EmailMessage}. (Contribuido por R. David Murray en bpo-20476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20476}.)

@node codificaciones<2>,enumeración<2>,Email,Módulos mejorados<7>
@anchor{whatsnew/3 6 encodings}@anchor{d23}
@subsubsection codificaciones


En Windows, se agregó la codificación @code{'oem'} para usar @code{CP_OEMCP} y el alias @code{'ansi'} para la codificación @code{'mbcs'} existente, que usa la página de códigos @code{CP_ACP}. (Contribuido por Steve Dower en bpo-27959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27959}.)

@node enumeración<2>,manipulador de faltas<2>,codificaciones<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 enum}@anchor{d24}
@subsubsection enumeración


Se han agregado dos nuevas clases base de enumeración al módulo @ref{56,,enum}: @ref{6c4,,Flag} y @code{IntFlags}. Ambos se utilizan para definir constantes que se pueden combinar utilizando los operadores bit a bit. (Contribuido por Ethan Furman en bpo-23591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23591}.)

Muchos módulos de biblioteca estándar se han actualizado para usar la clase @code{IntFlags} para sus constantes.

El nuevo valor de @ref{d25,,enum.auto} se puede utilizar para asignar valores a los miembros de enumeración automáticamente:

@example
>>> from enum import Enum, auto
>>> class Color(Enum):
...     red = auto()
...     blue = auto()
...     green = auto()
...
>>> list(Color)
[<Color.red: 1>, <Color.blue: 2>, <Color.green: 3>]
@end example

@node manipulador de faltas<2>,entrada de archivo<2>,enumeración<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 faulthandler}@anchor{d26}
@subsubsection manipulador de faltas


En Windows, el módulo @ref{58,,faulthandler} ahora instala un controlador para las excepciones de Windows: consulte @ref{d27,,faulthandler.enable()}. (Contribuido por Victor Stinner en bpo-23848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23848}.)

@node entrada de archivo<2>,hashlib<5>,manipulador de faltas<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 fileinput}@anchor{d28}
@subsubsection entrada de archivo


@ref{d29,,hook_encoded()} ahora admite el argumento `errors'. (Contribuido por Joseph Hackman en bpo-25788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25788}.)

@node hashlib<5>,http client<2>,entrada de archivo<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 hashlib}@anchor{d2a}
@subsubsection hashlib


@ref{68,,hashlib} es compatible con OpenSSL 1.1.0. La versión mínima recomendada es 1.0.2. (Contribuido por Christian Heimes en bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

Se agregaron funciones hash BLAKE2 al módulo. @ref{6e3,,blake2b()} y @ref{6e4,,blake2s()} siempre están disponibles y admiten el conjunto completo de funciones de BLAKE2. (Contribuido por Christian Heimes en bpo-26798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26798} basado en código de Dmitry Chestnykh y Samuel Neves. Documentación escrita por Dmitry Chestnykh.)

Se agregaron las funciones hash SHA-3 @ref{d2b,,sha3_224()}, @ref{d2c,,sha3_256()}, @ref{d2d,,sha3_384()}, @ref{d2e,,sha3_512()} y las funciones hash SHAKE @ref{d2f,,shake_128()} y @ref{d30,,shake_256()}. (Contribuido por Christian Heimes en bpo-16113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16113}. Paquete de código Keccak por Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche y Ronny Van Keer.)

La función de derivación de claves basada en contraseña @ref{cc6,,scrypt()} ahora está disponible con OpenSSL 1.1.0 y versiones posteriores. (Contribuido por Christian Heimes en bpo-27928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27928}.)

@node http client<2>,idlelib y IDLE,hashlib<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 http-client}@anchor{d31}
@subsubsection http.client


@ref{d32,,HTTPConnection.request()} y @ref{d33,,endheaders()} ahora admiten cuerpos de solicitud de codificación fragmentados. (Contribuido por Demian Brecht y Rolf Krahl en bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@node idlelib y IDLE,importlib<7>,http client<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 idlelib-and-idle}@anchor{d34}
@subsubsection idlelib y IDLE


El paquete idlelib se está modernizando y refactorizando para que IDLE se vea y funcione mejor y para que el código sea más fácil de entender, probar y mejorar. Parte de hacer que IDLE se vea mejor, especialmente en Linux y Mac, es usar widgets ttk, principalmente en los cuadros de diálogo. Como resultado, IDLE ya no se ejecuta con tcl / tk 8.4. Ahora requiere tcl / tk 8.5 o 8.6. Recomendamos ejecutar la última versión de cualquiera.

La “modernización” incluye el cambio de nombre y la consolidación de módulos idlelib. El cambio de nombre de archivos con nombres en mayúsculas parciales es similar al cambio de nombre de, por ejemplo, Tkinter y TkFont a tkinter y tkinter.font en 3.0. Como resultado, las importaciones de archivos idlelib que funcionaban en 3.5 normalmente no funcionarán en 3.6. Se necesitará al menos un cambio de nombre de módulo (ver idlelib / README.txt), a veces más. (Los cambios de nombre aportados por Al Swiegart y Terry Reedy en bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}. La mayoría de los parches idlelib desde entonces han sido y serán parte del proceso).

En compensación, el resultado final será que algunas clases de idlelib serán más fáciles de usar, con mejores API y cadenas de documentación que las expliquen. Se agregará información útil adicional a idlelib cuando esté disponible.

Nuevo en 3.6.2:

Varias correcciones para autocompletar. (Contribuido por Louie Lu en bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}.)

Nuevo en 3.6.3:

El Explorador de módulos (en el menú Archivo, antes llamado Explorador de clases), ahora muestra funciones y clases anidadas además de funciones y clases de nivel superior. (Contribuido por Guilherme Polo, Cheryl Sabella y Terry Jan Reedy en bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}.)

Las funciones IDLE implementadas anteriormente como extensiones se han vuelto a implementar como funciones normales. Su configuración se ha movido de la pestaña Extensiones a otras pestañas de diálogo. (Contribuido por Charles Wohlganger y Terry Jan Reedy en bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}.)

El cuadro de diálogo Configuración (Opciones, Configurar IDLE) se ha reescrito parcialmente para mejorar tanto la apariencia como la función. (Contribuido por Cheryl Sabella y Terry Jan Reedy en varios números).

Nuevo en 3.6.4:

La muestra de fuente ahora incluye una selección de caracteres no latinos para que los usuarios puedan ver mejor el efecto de seleccionar una fuente en particular. (Contribuido por Terry Jan Reedy en bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}.) La muestra se puede editar para incluir otros caracteres. (Contribuido por Serhiy Storchaka en bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}.)

Nuevo en 3.6.6:

Se revisó la opción de contexto del código del editor. El cuadro muestra todas las líneas de contexto hasta las líneas máximas. Al hacer clic en una línea de contexto, el editor salta a esa línea. Los colores de contexto para temas personalizados se agregan a la pestaña Destacados del cuadro de diálogo Configuración. (Contribuido por Cheryl Sabella y Terry Jan Reedy en bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}, bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768} y bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}.)

En Windows, una nueva llamada a la API le dice a Windows que tk escala para DPI. En Windows 8.1+ o 10, con las propiedades de compatibilidad de DPI del binario de Python sin cambios y una resolución de monitor superior a 96 DPI, esto debería hacer que el texto y las líneas sean más nítidos. De lo contrario, no debería tener ningún efecto. (Contribuido por Terry Jan Reedy en bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}.)

Nuevo en 3.6.7:

La salida sobre N líneas (50 por defecto) se reduce a un botón. N se puede cambiar en la sección PyShell de la página General del cuadro de diálogo Configuración. Se pueden comprimir menos líneas, pero posiblemente más largas, haciendo clic derecho en la salida. La salida comprimida se puede expandir en su lugar haciendo doble clic en el botón o en el portapapeles o en una ventana separada haciendo clic derecho en el botón. (Contribuido por Tal Einat en bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

@node importlib<7>,inspeccionar<4>,idlelib y IDLE,Módulos mejorados<7>
@anchor{whatsnew/3 6 importlib}@anchor{d35}
@subsubsection importlib


Importar ahora lanza la nueva excepción @ref{bcf,,ModuleNotFoundError} (subclase de @ref{4d7,,ImportError}) cuando no puede encontrar un módulo. Codifique que las comprobaciones actuales para @code{ImportError} (en try-except) seguirán funcionando. (Contribuido por Eric Snow en bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@ref{d36,,importlib.util.LazyLoader} ahora llama a @ref{d37,,create_module()} en el cargador envuelto, eliminando la restricción de que @ref{d38,,importlib.machinery.BuiltinImporter} y @ref{d39,,importlib.machinery.ExtensionFileLoader} no se pueden usar con @ref{d36,,importlib.util.LazyLoader}.

@ref{1f6,,importlib.util.cache_from_source()}, @ref{5be,,importlib.util.source_from_cache()} y @ref{d3a,,importlib.util.spec_from_file_location()} ahora aceptan un @ref{3f0,,path-like object}.

@node inspeccionar<4>,json<2>,importlib<7>,Módulos mejorados<7>
@anchor{whatsnew/3 6 inspect}@anchor{d3b}
@subsubsection inspeccionar


La función @ref{181,,inspect.signature()} ahora reporta los parámetros @code{.0} implícitos generados por el compilador para los alcances de comprensión y expresión del generador como si fueran parámetros solo posicionales llamados @code{implicit0}. (Contribuido por Jelle Zijlstra en bpo-19611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19611}.)

Para reducir la pérdida de código al actualizar desde Python 2.7 y la API @code{inspect.getargspec()} heredada, se ha revertido la desaprobación previamente documentada de @ref{7d4,,inspect.getfullargspec()}. Si bien esta función es conveniente para bases de código Python 2/3 de fuente única / fuente, la interfaz @ref{181,,inspect.signature()} más rica sigue siendo el enfoque recomendado para el nuevo código. (Contribuido por Nick Coghlan en bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172})

@node json<2>,Inicio sesión<2>,inspeccionar<4>,Módulos mejorados<7>
@anchor{whatsnew/3 6 json}@anchor{d3c}
@subsubsection json


@ref{d3d,,json.load()} y @ref{9e8,,json.loads()} ahora admiten entrada binaria. El JSON codificado debe representarse mediante UTF-8, UTF-16 o UTF-32. (Contribuido por Serhiy Storchaka en bpo-17909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17909}.)

@node Inicio sesión<2>,Matemáticas<3>,json<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 logging}@anchor{d3e}
@subsubsection Inicio sesión


Se agregó el nuevo método @ref{d3f,,WatchedFileHandler.reopenIfNeeded()} para agregar la capacidad de verificar si es necesario volver a abrir el archivo de registro. (Contribuido por Marian Horban en bpo-24884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24884}.)

@node Matemáticas<3>,multiprocesamiento<2>,Inicio sesión<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 math}@anchor{d40}
@subsubsection Matemáticas


La constante tau (`τ') se ha agregado a los módulos @ref{8e,,math} y @ref{19,,cmath}. (Contribuido por Lisa Roach en bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}, consulte 
@geindex Python Enhancement Proposals; PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/} para obtener más detalles).

@node multiprocesamiento<2>,os<8>,Matemáticas<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 multiprocessing}@anchor{d41}
@subsubsection multiprocesamiento


@ref{18d,,Proxy Objects} devuelto por @ref{d42,,multiprocessing.Manager()} ahora se puede anidar. (Contribuido por Davin Potts en bpo-6766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6766}.)

@node os<8>,Pathlib<3>,multiprocesamiento<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 os}@anchor{d43}
@subsubsection os


Consulte el resumen de @ref{cc3,,PEP 519} para obtener detalles sobre cómo los módulos @ref{a1,,os} y @ref{a2,,os.path} ahora admiten @ref{3f0,,path-like objects}.

@ref{1a2,,scandir()} ahora admite rutas @ref{325,,bytes} en Windows.

Un nuevo método @ref{d44,,close()} permite cerrar explícitamente un iterador @ref{1a2,,scandir()}. El iterador @ref{1a2,,scandir()} ahora admite el protocolo @ref{675,,context manager}. Si un iterador @code{scandir()} no se agota ni se cierra explícitamente, se emitirá un @ref{39d,,ResourceWarning} en su destructor. (Contribuido por Serhiy Storchaka en bpo-25994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25994}.)

En Linux, @ref{5c6,,os.urandom()} ahora se bloquea hasta que se inicializa el grupo de entropía aleatoria del sistema para aumentar la seguridad. Consulte el 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} para conocer la justificación.

El syscall de Linux @code{getrandom()} (obtener bytes aleatorios) ahora se expone como la nueva función @ref{d45,,os.getrandom()}. (Contribuido por Victor Stinner, parte del 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/})

@node Pathlib<3>,pdb<5>,os<8>,Módulos mejorados<7>
@anchor{whatsnew/3 6 pathlib}@anchor{d46}
@subsubsection Pathlib


@ref{a4,,pathlib} ahora es compatible con @ref{3f0,,path-like objects}. (Contribuido por Brett Cannon en bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}.)

Consulte el resumen de @ref{cc3,,PEP 519} para obtener más detalles.

@node pdb<5>,pepinillo,Pathlib<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 pdb}@anchor{d47}
@subsubsection pdb


El constructor de la clase @ref{1a8,,Pdb} tiene un nuevo argumento `readrc' opcional para controlar si se deben leer los archivos @code{.pdbrc}.

@node pepinillo,pepinillos,pdb<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 pickle}@anchor{d48}
@subsubsection pepinillo


Los objetos que necesitan que se llame a @code{__new__} con argumentos de palabras clave ahora se pueden seleccionar utilizando @ref{1ad,,pickle protocols} anterior a la versión del protocolo 4. La versión 4 del protocolo ya es compatible con este caso. (Contribuido por Serhiy Storchaka en bpo-24164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24164}.)

@node pepinillos,Pydoc<2>,pepinillo,Módulos mejorados<7>
@anchor{whatsnew/3 6 pickletools}@anchor{d49}
@subsubsection pepinillos


@ref{d4a,,pickletools.dis()} now outputs the implicit memo index for the
@code{MEMOIZE} opcode.
(Contributed by Serhiy Storchaka in bpo-25382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25382}.)

@node Pydoc<2>,aleatorio<2>,pepinillos,Módulos mejorados<7>
@anchor{whatsnew/3 6 pydoc}@anchor{d4b}
@subsubsection Pydoc


El módulo @ref{b5,,pydoc} ha aprendido a respetar la variable de entorno @code{MANPAGER}. (Contribuido por Matthias Klose en bpo-8637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8637}.)

@ref{96e,,help()} y @ref{b5,,pydoc} ahora pueden enumerar campos de tupla con nombre en el orden en que se definieron en lugar de alfabéticamente. (Contribuido por Raymond Hettinger en bpo-24879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24879}.)

@node aleatorio<2>,re<5>,Pydoc<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 random}@anchor{d4c}
@subsubsection aleatorio


La nueva función @ref{d4d,,choices()} devuelve una lista de elementos de tamaño especificado de la población dada con pesos opcionales. (Contribuido por Raymond Hettinger en bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}.)

@node re<5>,readline,aleatorio<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 re}@anchor{d4e}
@subsubsection re


Se agregó soporte para lapsos de modificadores en expresiones regulares. Ejemplos: @code{'(?i:p)ython'} coincide con @code{'python'} y @code{'Python'}, pero no con @code{'PYTHON'}; @code{'(?i)g(?-i:v)r'} coincide con @code{'GvR'} y @code{'gvr'}, pero no con @code{'GVR'}. (Contribuido por Serhiy Storchaka en bpo-433028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433028}.)

Se puede acceder a los grupos de objetos coincidentes mediante @code{__getitem__}, que es equivalente a @code{group()}. Entonces @code{mo['name']} ahora es equivalente a @code{mo.group('name')}. (Contribuido por Eric Smith en bpo-24454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24454}.)

Los objetos @ref{d4f,,Match} ahora admiten @ref{22b,,index-like objects} como índices de grupo. (Contribuido por Jeroen Demeyer y Xiang Zhang en bpo-27177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27177}.)

@node readline,rlcompleter,re<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 readline}@anchor{d50}
@subsubsection readline


Se agregó @ref{d51,,set_auto_history()} para habilitar o deshabilitar la adición automática de entradas a la lista del historial. (Contribuido por Tyler Crompton en bpo-26870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26870}.)

@node rlcompleter,shlex<2>,readline,Módulos mejorados<7>
@anchor{whatsnew/3 6 rlcompleter}@anchor{d52}
@subsubsection rlcompleter


Los nombres de atributos privados y especiales ahora se omiten a menos que el prefijo comience con guiones bajos. Se agrega un espacio o dos puntos después de algunas palabras clave completadas. (Contribuido por Serhiy Storchaka en bpo-25011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25011} y bpo-25209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25209}.)

@node shlex<2>,sitio<2>,rlcompleter,Módulos mejorados<7>
@anchor{whatsnew/3 6 shlex}@anchor{d53}
@subsubsection shlex


El @ref{d54,,shlex} tiene mucho @ref{d55,,improved shell compatibility} a través del nuevo argumento `punctuation_chars' para controlar qué caracteres se tratan como puntuación. (Contribuido por Vinay Sajip en bpo-1521950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1521950}.)

@node sitio<2>,sqlite3<8>,shlex<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 site}@anchor{d56}
@subsubsection sitio


When specifying paths to add to @ref{27e,,sys.path} in a @code{.pth} file,
you may now specify file paths on top of directories (e.g. zip files).
(Contributed by Wolfgang Langner in bpo-26587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26587}).

@node sqlite3<8>,enchufe<4>,sitio<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 sqlite3}@anchor{d57}
@subsubsection sqlite3


@ref{d58,,sqlite3.Cursor.lastrowid} ahora admite la declaración @code{REPLACE}. (Contribuido por Alex LordThorsen en bpo-16864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16864}.)

@node enchufe<4>,servidor de sockets,sqlite3<8>,Módulos mejorados<7>
@anchor{whatsnew/3 6 socket}@anchor{d59}
@subsubsection enchufe


The @ref{d5a,,ioctl()} function now supports the
@ref{d5b,,SIO_LOOPBACK_FAST_PATH} control code.
(Contributed by Daniel Stokes in bpo-26536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26536}.)

Las constantes @ref{d5c,,getsockopt()} @code{SO_DOMAIN}, @code{SO_PROTOCOL}, @code{SO_PEERSEC} y @code{SO_PASSSEC} ahora son compatibles. (Contribuido por Christian Heimes en bpo-26907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26907}.)

El @ref{d5d,,setsockopt()} ahora admite el formulario @code{setsockopt(level, optname, None, optlen: int)}. (Contribuido por Christian Heimes en bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744}.)

The socket module now supports the address family
@ref{d5e,,AF_ALG} to interface with Linux Kernel crypto API. @code{ALG_*},
@code{SOL_ALG} and @ref{d5f,,sendmsg_afalg()} were added.
(Contributed by Christian Heimes in bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744} with support from
Victor Stinner.)

Se agregaron las nuevas constantes de Linux @code{TCP_USER_TIMEOUT} y @code{TCP_CONGESTION}. (Contribuido por Omar Sandoval, bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}).

@node servidor de sockets,ssl<7>,enchufe<4>,Módulos mejorados<7>
@anchor{whatsnew/3 6 socketserver}@anchor{d60}
@subsubsection servidor de sockets


Los servidores basados en el módulo @ref{cd,,socketserver}, incluidos los definidos en @ref{72,,http.server}, @ref{12e,,xmlrpc.server} y @ref{11b,,wsgiref.simple_server}, ahora admiten el protocolo @ref{675,,context manager}. (Contribuido por Aviv Palivoda en bpo-26404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26404}.)

El atributo @code{wfile} de las clases @ref{d61,,StreamRequestHandler} ahora implementa la interfaz de escritura @ref{735,,io.BufferedIOBase}. En particular, ahora se garantiza que llamar a @ref{d62,,write()} enviará los datos completos. (Contribuido por Martin Panter en bpo-26721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26721}.)

@node ssl<7>,Estadísticas<2>,servidor de sockets,Módulos mejorados<7>
@anchor{whatsnew/3 6 ssl}@anchor{d63}
@subsubsection ssl


@ref{d0,,ssl} es compatible con OpenSSL 1.1.0. La versión mínima recomendada es 1.0.2. (Contribuido por Christian Heimes en bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

Se ha eliminado 3DES de los conjuntos de cifrado predeterminados y se han agregado conjuntos de cifrado ChaCha20 Poly1305. (Contribuido por Christian Heimes en bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850} y bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}.)

@ref{1fa,,SSLContext} tiene una mejor configuración predeterminada para opciones y cifrados. (Contribuido por Christian Heimes en bpo-28043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28043}.)

La sesión SSL se puede copiar de una conexión del lado del cliente a otra con la nueva clase @ref{d64,,SSLSession}. La reanudación de la sesión de TLS puede acelerar el apretón de manos inicial, reducir la latencia y mejorar el rendimiento (Contribuido por Christian Heimes en bpo-19500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19500} basado en un borrador de Alex Warhawk).

El nuevo método @ref{d65,,get_ciphers()} se puede utilizar para obtener una lista de cifrados habilitados en orden de prioridad de cifrado.

Todas las constantes y banderas se han convertido a @ref{d66,,IntEnum} y @code{IntFlags}. (Contribuido por Christian Heimes en bpo-28025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28025}.)

Se agregaron protocolos TLS específicos del lado del servidor y del cliente para @ref{1fa,,SSLContext}. (Contribuido por Christian Heimes en bpo-28085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28085}.)

Added @ref{ac3,,ssl.SSLContext.post_handshake_auth} to enable and
@ref{ac4,,ssl.SSLSocket.verify_client_post_handshake()} to initiate TLS 1.3
post-handshake authentication.
(Contributed by Christian Heimes in gh-78851@footnote{https://github.com/python/cpython/issues/78851}.)

@node Estadísticas<2>,estructura,ssl<7>,Módulos mejorados<7>
@anchor{whatsnew/3 6 statistics}@anchor{d67}
@subsubsection Estadísticas


Se ha agregado una nueva función @ref{d68,,harmonic_mean()}. (Contribuido por Steven D’Aprano en bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}.)

@node estructura,subproceso,Estadísticas<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 struct}@anchor{d69}
@subsubsection estructura


@ref{d5,,struct} ahora admite flotadores de media precisión IEEE 754 a través del especificador de formato @code{'e'}. (Contribuido por Eli Stevens, Mark Dickinson en bpo-11734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11734}.)

@node subproceso,sys<9>,estructura,Módulos mejorados<7>
@anchor{whatsnew/3 6 subprocess}@anchor{d6a}
@subsubsection subproceso


El destructor @ref{301,,subprocess.Popen} ahora emite una advertencia @ref{39d,,ResourceWarning} si el proceso hijo todavía se está ejecutando. Utilice el protocolo del administrador de contexto (@code{with proc: ...}) o llame explícitamente al método @ref{d6b,,wait()} para leer el estado de salida del proceso hijo. (Contribuido por Victor Stinner en bpo-26741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26741}.)

El constructor @ref{301,,subprocess.Popen} y todas las funciones que le pasan argumentos ahora aceptan argumentos `encoding' y `errors'. Especificando alguno de ellos activará el modo texto para `stdin', `stdout' y `stderr'. (Contribuido por Steve Dower en bpo-6135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6135}.)

@node sys<9>,telnetlib,subproceso,Módulos mejorados<7>
@anchor{whatsnew/3 6 sys}@anchor{d6c}
@subsubsection sys


La nueva función @ref{d6d,,getfilesystemencodeerrors()} devuelve el nombre del modo de error utilizado para convertir entre nombres de archivo Unicode y nombres de archivo en bytes. (Contribuido por Steve Dower en bpo-27781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27781}.)

En Windows, el valor de retorno de la función @ref{d6e,,getwindowsversion()} ahora incluye el campo `platform_version' que contiene la versión principal precisa, la versión secundaria y el número de compilación del sistema operativo actual, en lugar de la versión que se está emulando para el proceso (contribución de Steve Dower en bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932} .)

@node telnetlib,tiempo<3>,sys<9>,Módulos mejorados<7>
@anchor{whatsnew/3 6 telnetlib}@anchor{d6f}
@subsubsection telnetlib


@code{telnetlib.Telnet} is now a context manager (contributed by
Stéphane Wirtel in bpo-25485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25485}).

@node tiempo<3>,cronométralo,telnetlib,Módulos mejorados<7>
@anchor{whatsnew/3 6 time}@anchor{d70}
@subsubsection tiempo


Los atributos @ref{d71,,struct_time} @code{tm_gmtoff} y @code{tm_zone} ahora están disponibles en todas las plataformas.

@node cronométralo,tkinter<6>,tiempo<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 timeit}@anchor{d72}
@subsubsection cronométralo


Se ha agregado el nuevo método de conveniencia @ref{d73,,Timer.autorange()} para llamar a @ref{d74,,Timer.timeit()} repetidamente para que el tiempo de ejecución total sea mayor o igual a 200 milisegundos. (Contribuido por Steven D’Aprano en bpo-6422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6422}.)

@ref{ef,,timeit} ahora advierte cuando hay una variación sustancial (4x) entre el mejor y el peor momento. (Contribuido por Serhiy Storchaka en bpo-23552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23552}.)

@node tkinter<6>,rastrear<3>,cronométralo,Módulos mejorados<7>
@anchor{whatsnew/3 6 tkinter}@anchor{d75}
@subsubsection tkinter


Se agregaron los métodos @code{trace_add()}, @code{trace_remove()} y @code{trace_info()} en la clase @code{tkinter.Variable}. Reemplazan los métodos antiguos @code{trace_variable()}, @code{trace()}, @code{trace_vdelete()} y @code{trace_vinfo()} que usan comandos Tcl obsoletos y es posible que no funcionen en versiones futuras de Tcl. (Contribuido por Serhiy Storchaka en bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}).

@node rastrear<3>,tracemalloc<3>,tkinter<6>,Módulos mejorados<7>
@anchor{whatsnew/3 6 traceback}@anchor{d76}@anchor{whatsnew/3 6 whatsnew36-traceback}@anchor{cf7}
@subsubsection rastrear


Tanto el módulo de rastreo como la pantalla de excepción incorporada del intérprete ahora abrevian largas secuencias de líneas repetidas en los rastreos como se muestra en el siguiente ejemplo:

@example
>>> def f(): f()
...
>>> f()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 1, in f
  File "<stdin>", line 1, in f
  File "<stdin>", line 1, in f
  [Previous line repeated 995 more times]
RecursionError: maximum recursion depth exceeded
@end example

(Contribuido por Emanuel Barry en bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@node tracemalloc<3>,mecanografía<5>,rastrear<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 tracemalloc}@anchor{d77}
@subsubsection tracemalloc


El módulo @ref{ff,,tracemalloc} ahora admite el seguimiento de asignaciones de memoria en varios espacios de direcciones diferentes.

Se ha agregado la nueva clase de filtro @ref{d78,,DomainFilter} para filtrar los rastros de bloques por su espacio de direcciones (dominio).

(Contribuido por Victor Stinner en bpo-26588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26588}.)

@node mecanografía<5>,unicodedata<8>,tracemalloc<3>,Módulos mejorados<7>
@anchor{whatsnew/3 6 typing}@anchor{d79}@anchor{whatsnew/3 6 whatsnew36-typing}@anchor{cc5}
@subsubsection mecanografía


Dado que el módulo @ref{104,,typing} es @ref{b8e,,provisional}, todos los cambios introducidos en Python 3.6 también se han actualizado a Python 3.5.x.

El módulo @ref{104,,typing} tiene un soporte mucho mejor para los alias de tipo genérico. Por ejemplo, @code{Dict[str, Tuple[S, T]]} ahora es una anotación de tipo válida. (Contribuido por Guido van Rossum en Github #195@footnote{https://github.com/python/typing/pull/195}.)

Se ha agregado la clase @ref{d17,,typing.ContextManager} para representar @ref{d16,,contextlib.AbstractContextManager}. (Contribuido por Brett Cannon en bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}.)

Se ha agregado la clase @ref{d7a,,typing.Collection} para representar @ref{d11,,collections.abc.Collection}. (Contribuido por Ivan Levkivskyi en bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}.)

Se ha agregado la construcción de tipo @ref{3bd,,typing.ClassVar} para marcar las variables de clase. Como se introdujo en 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, una anotación de variable envuelta en ClassVar indica que un atributo dado está destinado a ser utilizado como una variable de clase y no debe establecerse en instancias de esa clase. (Contribuido por Ivan Levkivskyi en Github #280@footnote{https://github.com/python/typing/pull/280}.)

Una nueva constante @ref{d7b,,TYPE_CHECKING} que se supone que es @code{True} por los verificadores de tipo estático, pero es @code{False} en tiempo de ejecución. (Contribuido por Guido van Rossum en Github #230@footnote{https://github.com/python/typing/issues/230}.)

Se ha agregado una nueva función auxiliar @ref{d7c,,NewType()} para crear tipos distintos ligeros para anotaciones:

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

El verificador de tipo estático tratará el nuevo tipo como si fuera una subclase del tipo original. (Contribuido por Ivan Levkivskyi en Github #189@footnote{https://github.com/python/typing/issues/189}.)

@node unicodedata<8>,unittest mock<2>,mecanografía<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 unicodedata}@anchor{d7d}
@subsubsection unicodedata


El módulo @ref{105,,unicodedata} ahora usa datos de Unicode 9.0.0@footnote{http://unicode.org/versions/Unicode9.0.0/}. (Contribuido por Benjamin Peterson).

@node unittest mock<2>,urllib request,unicodedata<8>,Módulos mejorados<7>
@anchor{whatsnew/3 6 unittest-mock}@anchor{d7e}
@subsubsection unittest.mock


La clase @ref{ade,,Mock} tiene las siguientes mejoras:


@itemize *

@item 
Dos nuevos métodos, @ref{d7f,,Mock.assert_called()} y @ref{d80,,Mock.assert_called_once()} para verificar si se llamó al objeto simulado. (Contribuido por Amit Saha en bpo-26323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26323}.)

@item 
El método @ref{d81,,Mock.reset_mock()} ahora tiene dos argumentos opcionales de solo palabras clave: `return_value' and `side_effect'. (Contribuido por Kushal Das en bpo-21271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21271}.)
@end itemize

@node urllib request,urllib robotparser,unittest mock<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 urllib-request}@anchor{d82}
@subsubsection urllib.request


Si una solicitud HTTP tiene un archivo o un cuerpo iterable (que no sea un objeto de bytes) pero no un encabezado @code{Content-Length}, en lugar de generar un error, @code{AbstractHTTPHandler} ahora recurre a la codificación de transferencia fragmentada. (Contribuido por Demian Brecht y Rolf Krahl en bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@node urllib robotparser,venv<5>,urllib request,Módulos mejorados<7>
@anchor{whatsnew/3 6 urllib-robotparser}@anchor{d83}
@subsubsection urllib.robotparser


@ref{d84,,RobotFileParser} ahora admite las extensiones @code{Crawl-delay} y @code{Request-rate}. (Contribuido por Nikolay Bogoychev en bpo-16099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16099}.)

@node venv<5>,advertencias<2>,urllib robotparser,Módulos mejorados<7>
@anchor{whatsnew/3 6 venv}@anchor{d85}
@subsubsection venv


@ref{111,,venv} acepta un nuevo parámetro @code{--prompt}. Este parámetro proporciona un prefijo alternativo para el entorno virtual. (Propuesto por Łukasz Balcerzak y portado a 3.6 por Stéphane Wirtel en bpo-22829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22829}.)

@node advertencias<2>,winreg,venv<5>,Módulos mejorados<7>
@anchor{whatsnew/3 6 warnings}@anchor{d86}
@subsubsection advertencias


También se ha agregado un nuevo atributo opcional `source' a la función @ref{d87,,warnings.warn_explicit()} : el objeto destruído que lanzó un @ref{39d,,ResourceWarning}. Un atributo `source' también se agregó a @code{warnings.WarningMessage} (aportado por Victor Stinner en bpo-26568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26568} y bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}).

Cuando se registra una advertencia @ref{39d,,ResourceWarning}, el módulo @ref{ff,,tracemalloc} ahora se usa para intentar recuperar el rastreo donde se asignó el objeto destruido.

Ejemplo con el script @code{example.py}:

@example
import warnings

def func():
    return open(__file__)

f = func()
f = None
@end example

Salida del comando @code{python3.6 -Wd -X tracemalloc=5 example.py}:

@example
example.py:7: ResourceWarning: unclosed file <_io.TextIOWrapper name='example.py' mode='r' encoding='UTF-8'>
  f = None
Object allocated at (most recent call first):
  File "example.py", lineno 4
    return open(__file__)
  File "example.py", lineno 6
    f = func()
@end example

El rastreo «Objeto asignado en» es nuevo y solo se muestra si @ref{ff,,tracemalloc} está rastreando asignaciones de memoria de Python y si el módulo @ref{112,,warnings} ya fue importado.

@node winreg,winsonido,advertencias<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 winreg}@anchor{d88}
@subsubsection winreg


Se agregó el tipo entero de 64 bits @ref{d89,,REG_QWORD}. (Contribuido por Clement Rouault en bpo-23026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23026}.)

@node winsonido,xmlrpc client,winreg,Módulos mejorados<7>
@anchor{whatsnew/3 6 winsound}@anchor{d8a}
@subsubsection winsonido


Se permite que los argumentos de palabras clave se pasen a @ref{d8b,,Beep}, @ref{d8c,,MessageBeep} y @ref{d8d,,PlaySound} (bpo-27982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27982}).

@node xmlrpc client,archivo zip<2>,winsonido,Módulos mejorados<7>
@anchor{whatsnew/3 6 xmlrpc-client}@anchor{d8e}
@subsubsection xmlrpc.client


El módulo @ref{12d,,xmlrpc.client} ahora admite la descomposición de tipos de datos adicionales utilizados por la implementación Apache XML-RPC para números y @code{None}. (Contribuido por Serhiy Storchaka en bpo-26885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26885}.)

@node archivo zip<2>,zlib,xmlrpc client,Módulos mejorados<7>
@anchor{whatsnew/3 6 zipfile}@anchor{d8f}
@subsubsection archivo zip


Un nuevo método de clase @ref{d90,,ZipInfo.from_file()} permite crear una instancia @ref{d91,,ZipInfo} a partir de un archivo del sistema de archivos. Se puede usar un nuevo método @ref{d92,,ZipInfo.is_dir()} para verificar si la instancia @ref{d91,,ZipInfo} representa un directorio. (Contribuido por Thomas Kluyver en bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}.)

El método @ref{4d9,,ZipFile.open()} ahora se puede utilizar para escribir datos en un archivo ZIP, así como para extraer datos. (Contribuido por Thomas Kluyver en bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}.)

@node zlib,,archivo zip<2>,Módulos mejorados<7>
@anchor{whatsnew/3 6 zlib}@anchor{d93}
@subsubsection zlib


Las funciones @ref{6e0,,compress()} y @ref{d94,,decompress()} ahora aceptan argumentos de palabras clave. (Contribuido por Aviv Palivoda en bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243} y Xiang Zhang en bpo-16764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16764} respectivamente).

@node Optimizaciones<7>,Cambios en la API de Build y C,Módulos mejorados<7>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 optimizations}@anchor{d95}
@subsection Optimizaciones



@itemize *

@item 
El intérprete de Python ahora usa un código de palabra de 16 bits en lugar de un código de bytes, lo que hizo posible una serie de optimizaciones de código de operación. (Contribuido por Demur Rumed con aportes y reseñas de Serhiy Storchaka y Victor Stinner en bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} y bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050}.)

@item 
La clase @ref{c55,,asyncio.Future} ahora tiene una implementación C optimizada. (Contribuido por Yury Selivanov e INADA Naoki en bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}.)

@item 
La clase @ref{580,,asyncio.Task} ahora tiene una implementación C optimizada. (Contribuido por Yury Selivanov en bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}.)

@item 
Varias mejoras de implementación en el módulo @ref{104,,typing} (como el almacenamiento en caché de tipos genéricos) permiten mejoras de rendimiento hasta 30 veces mayores y una huella de memoria reducida.

@item 
El decodificador ASCII ahora es hasta 60 veces más rápido para los controladores de errores @code{surrogateescape}, @code{ignore} y @code{replace} (Contribuido por Victor Stinner en bpo-24870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24870}).

@item 
Los codificadores ASCII y Latin1 ahora son hasta 3 veces más rápidos para el controlador de errores @code{surrogateescape} (Contribuido por Victor Stinner en bpo-25227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25227}).

@item 
El codificador UTF-8 ahora es hasta 75 veces más rápido para los controladores de errores @code{ignore}, @code{replace}, @code{surrogateescape}, @code{surrogatepass} (Contribuido por Victor Stinner en bpo-25267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25267}).

@item 
El decodificador UTF-8 ahora es hasta 15 veces más rápido para los controladores de errores @code{ignore}, @code{replace} y @code{surrogateescape} (Contribuido por Victor Stinner en bpo-25301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25301}).

@item 
@code{bytes % args} ahora es hasta 2 veces más rápido. (Contribuido por Victor Stinner en bpo-25349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25349}).

@item 
@code{bytearray % args} es ahora entre 2,5 y 5 veces más rápido. (Contribuido por Victor Stinner en bpo-25399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25399}).

@item 
Optimice @ref{b7a,,bytes.fromhex()} y @ref{b7b,,bytearray.fromhex()}: ahora son entre 2 y 3,5 veces más rápidos. (Contribuido por Victor Stinner en bpo-25401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25401}).

@item 
Optimice @code{bytes.replace(b'@w{'}, b'.')} y @code{bytearray.replace(b'@w{'}, b'.')}: hasta un 80% más rápido. (Contribuido por Josh Snider en bpo-26574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26574}).

@item 
Allocator functions of the @ref{cee,,PyMem_Malloc()} domain
(@ref{cf1,,PYMEM_DOMAIN_MEM}) now use the @ref{d96,,pymalloc memory allocator} instead of @code{malloc()} function of the C library. The
pymalloc allocator is optimized for objects smaller or equal to 512 bytes
with a short lifetime, and use @code{malloc()} for larger memory blocks.
(Contributed by Victor Stinner in bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}).

@item 
@ref{d97,,pickle.load()} y @ref{d98,,pickle.loads()} ahora son hasta un 10% más rápidos al deserializar muchos objetos pequeños (contribución de Victor Stinner en bpo-27056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27056}).

@item 
Pasar @ref{d99,,keyword arguments} a una función tiene una sobrecarga en comparación con pasar @ref{d9a,,positional arguments}. Ahora, en las funciones de extensión implementadas con el uso de Argument Clinic, esta sobrecarga se reduce significativamente. (Contribuido por Serhiy Storchaka en bpo-27574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27574}).

@item 
Funciones @ref{3ef,,glob()} y @ref{89e,,iglob()} optimizadas en el módulo @ref{64,,glob}; ahora son unas 3 a 6 veces más rápidas. (Contribuido por Serhiy Storchaka en bpo-25596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25596}).

@item 
Globbing optimizado en @ref{a4,,pathlib} mediante @ref{1a2,,os.scandir()}; ahora es alrededor de 1,5 a 4 veces más rápido. (Contribuido por Serhiy Storchaka en bpo-26032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26032}).

@item 
Se ha mejorado significativamente el rendimiento de análisis, iteración y copia profunda de @ref{125,,xml.etree.ElementTree}. (Contribuido por Serhiy Storchaka en bpo-25638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25638}, bpo-25873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25873} y bpo-25869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25869}.)

@item 
La creación de instancias de @ref{177,,fractions.Fraction} a partir de flotantes y decimales es ahora de 2 a 3 veces más rápida. (Contribuido por Serhiy Storchaka en bpo-25971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25971}.)
@end itemize

@node Cambios en la API de Build y C,Otras mejoras,Optimizaciones<7>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 build-and-c-api-changes}@anchor{d9b}
@subsection Cambios en la API de Build y C



@itemize *

@item 
Python ahora requiere algo de compatibilidad con C99 en la cadena de herramientas para compilarse. En particular, Python ahora usa macros y tipos de enteros estándar en lugar de macros personalizadas como @code{PY_LONG_LONG}. Para obtener más información, consulte 
@geindex Python Enhancement Proposals; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} y bpo-17884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17884}.

@item 
La compilación cruzada de CPython con el NDK de Android y el nivel de API de Android establecido en 21 (Android 5.0 Lollipop) o superior se ejecuta correctamente. Si bien Android aún no es una plataforma compatible, el conjunto de pruebas de Python se ejecuta en el emulador de Android con solo alrededor de 16 fallas en las pruebas. Consulte el meta-problema de Android bpo-26865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26865}.

@item 
Se ha agregado el indicador de configuración @code{--enable-optimizations}. Activarlo activará optimizaciones costosas como PGO. (Parche original de Alecsandru Patrascu de Intel en bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}.)

@item 
The @ref{2b5,,GIL} must now be held when allocator
functions of @ref{cef,,PYMEM_DOMAIN_OBJ} (ex: @ref{cf0,,PyObject_Malloc()}) and
@ref{cf1,,PYMEM_DOMAIN_MEM} (ex: @ref{cee,,PyMem_Malloc()}) domains are called.

@item 
Nueva API @ref{d9c,,Py_FinalizeEx()} que indica si fallaron los datos almacenados en búfer. (Contribuido por Martin Panter en bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}.)

@item 
@ref{475,,PyArg_ParseTupleAndKeywords()} ahora es compatible con @ref{b12,,positional-only parameters}. Los parámetros solo posicionales se definen mediante nombres vacíos. (Contribuido por Serhiy Storchaka en bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}).

@item 
El método @code{PyTraceback_Print} ahora abrevia secuencias largas de líneas repetidas como @code{"[Previous line repeated @{count@} more times]"}. (Contribuido por Emanuel Barry en bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@item 
La nueva función @ref{d9d,,PyErr_SetImportErrorSubclass()} permite especificar una subclase de @ref{4d7,,ImportError} para aumentar. (Contribuido por Eric Snow en bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@item 
La nueva función @ref{d9e,,PyErr_ResourceWarning()} se puede utilizar para generar un @ref{39d,,ResourceWarning} que proporcione la fuente de la asignación de recursos. (Contribuido por Victor Stinner en bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}.)

@item 
La nueva función @ref{d9f,,PyOS_FSPath()} devuelve la representación del sistema de archivos de un @ref{3f0,,path-like object}. (Contribuido por Brett Cannon en bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}.)

@item 
Las funciones @ref{da0,,PyUnicode_FSConverter()} y @ref{61b,,PyUnicode_FSDecoder()} ahora aceptarán @ref{3f0,,path-like objects}.
@end itemize

@node Otras mejoras,Obsoleto<9>,Cambios en la API de Build y C,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 other-improvements}@anchor{da1}
@subsection Otras mejoras



@itemize *

@item 
Cuando @ref{da2,,--version} (forma corta: @ref{2e3,,-V}) se suministra dos veces, Python imprime @ref{2e4,,sys.version} para obtener información detallada.

@example
$ ./python -VV
Python 3.6.0b4+ (3.6:223967b49e49+, Nov 21 2016, 20:55:04)
[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
@end example
@end itemize

@node Obsoleto<9>,Remoto<5>,Otras mejoras,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 deprecated}@anchor{da3}
@subsection Obsoleto


@menu
* Nuevas palabras clave:: 
* Comportamiento de Python obsoleto:: 
* Módulos@comma{} funciones y métodos de Python obsoletos: Módulos funciones y métodos de Python obsoletos<2>. 
* xml: xml<6>. 
* Funciones y tipos obsoletos de la API de C:: 
* Opciones de compilación obsoletas:: 

@end menu

@node Nuevas palabras clave,Comportamiento de Python obsoleto,,Obsoleto<9>
@anchor{whatsnew/3 6 new-keywords}@anchor{da4}
@subsubsection Nuevas palabras clave


No se recomienda el uso de @code{async} y @code{await} como nombres de variable, clase, función o módulo. Introducidos por 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} en Python 3.5, se convertirán en palabras clave adecuadas en Python 3.7. A partir de Python 3.6, el uso de @code{async} o @code{await} como nombres lanzará un @ref{1da,,DeprecationWarning}.

@node Comportamiento de Python obsoleto,Módulos funciones y métodos de Python obsoletos<2>,Nuevas palabras clave,Obsoleto<9>
@anchor{whatsnew/3 6 deprecated-python-behavior}@anchor{da5}
@subsubsection Comportamiento de Python obsoleto


Al generar la excepción @ref{c82,,StopIteration} dentro de un generador, ahora se lanzará un @ref{1da,,DeprecationWarning} y se activará un @ref{1e5,,RuntimeError} en Python 3.7. Consulte @ref{da6,,PEP 479; Cambiar el gestor de StopIteration dentro de generadores} para obtener más detalles.

Ahora se espera que el método @code{__aiter__()} devuelva un iterador asincrónico directamente en lugar de devolver un awaitable como antes. Hacer lo primero activará un @ref{1da,,DeprecationWarning}. La compatibilidad con versiones anteriores se eliminará en Python 3.7. (Contribuido por Yury Selivanov en bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}.)

Un par de caracteres de barra invertida que no es una secuencia de escape válida ahora genera un @ref{1da,,DeprecationWarning}. Aunque eventualmente se convertirá en un @ref{150,,SyntaxError}, no será así para varias versiones de Python. (Contribuido por Emanuel Barry en bpo-27364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27364}.)

Al realizar una importación relativa, recurrir a @code{__name__} y @code{__path__} desde el módulo de llamada cuando @code{__spec__} o @code{__package__} no están definidos ahora genera un @ref{59f,,ImportWarning}. (Contribuido por Rose Ames en bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}.)

@node Módulos funciones y métodos de Python obsoletos<2>,xml<6>,Comportamiento de Python obsoleto,Obsoleto<9>
@anchor{whatsnew/3 6 deprecated-python-modules-functions-and-methods}@anchor{da7}
@subsubsection Módulos, funciones y métodos de Python obsoletos


@menu
* asynchat:: 
* asyncore:: 
* dbm: dbm<4>. 
* distutils: distutils<6>. 
* grp:: 
* importlib: importlib<8>. 
* os: os<9>. 
* re: re<6>. 
* ssl: ssl<8>. 
* tkinter: tkinter<7>. 
* venv: venv<6>. 

@end menu

@node asynchat,asyncore,,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 asynchat}@anchor{da8}
@subsubsection asynchat


The @code{asynchat} has been deprecated in favor of @ref{b,,asyncio}.
(Contributed by Mariatta in bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002}.)

@node asyncore,dbm<4>,asynchat,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 asyncore}@anchor{da9}
@subsubsection asyncore


The @code{asyncore} has been deprecated in favor of @ref{b,,asyncio}.
(Contributed by Mariatta in bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002}.)

@node dbm<4>,distutils<6>,asyncore,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 dbm}@anchor{daa}
@subsubsection dbm


A diferencia de otras implementaciones de @ref{32,,dbm}, el módulo @ref{33,,dbm.dumb} crea bases de datos con el modo @code{'rw'} y permite modificar la base de datos abierta con el modo @code{'r'}. Este comportamiento ahora está en desuso y se eliminará en 3.8. (Contribuido por Serhiy Storchaka en bpo-21708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21708}.)

@node distutils<6>,grp,dbm<4>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id2}@anchor{dab}
@subsubsection distutils


The undocumented @code{extra_path} argument to the
@code{distutils.Distribution} constructor is now considered deprecated
and will raise a warning if set.   Support for this parameter will be
removed in a future Python release.  See bpo-27919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27919} for details.

@node grp,importlib<8>,distutils<6>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 grp}@anchor{dac}
@subsubsection grp


La compatibilidad con argumentos no enteros en @ref{dad,,getgrgid()} ha quedado obsoleta. (Contribuido por Serhiy Storchaka en bpo-26129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26129}.)

@node importlib<8>,os<9>,grp,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id3}@anchor{dae}
@subsubsection importlib


Los métodos @ref{daf,,importlib.machinery.SourceFileLoader.load_module()} y @ref{db0,,importlib.machinery.SourcelessFileLoader.load_module()} ahora están en desuso. Eran las únicas implementaciones restantes de @ref{900,,importlib.abc.Loader.load_module()} en @ref{77,,importlib} que no habían quedado obsoletas en versiones anteriores de Python a favor de @ref{901,,importlib.abc.Loader.exec_module()}.

The @ref{db1,,importlib.machinery.WindowsRegistryFinder} class is now
deprecated. As of 3.6.0, it is still added to @ref{db2,,sys.meta_path} by
default (on Windows), but this may change in future releases.

@node os<9>,re<6>,importlib<8>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id4}@anchor{db3}
@subsubsection os


El soporte no documentado de @ref{db4,,bytes-like objects} general como rutas en funciones @ref{a1,,os}, @ref{2fb,,compile()} y funciones similares ahora está en desuso. (Contribuido por Serhiy Storchaka en bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791} y bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}.)

@node re<6>,ssl<8>,os<9>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id5}@anchor{db5}
@subsubsection re


La compatibilidad con indicadores en línea @code{(?letters)} en el medio de la expresión regular ha quedado obsoleta y se eliminará en una versión futura de Python. Aún se permiten las banderas al comienzo de una expresión regular. (Contribuido por Serhiy Storchaka en bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}.)

@node ssl<8>,tkinter<7>,re<6>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id6}@anchor{db6}
@subsubsection ssl


OpenSSL 0.9.8, 1.0.0 y 1.0.1 están obsoletos y ya no son compatibles. En el futuro, el módulo @ref{d0,,ssl} requerirá al menos OpenSSL 1.0.2 o 1.1.0.

Los argumentos relacionados con SSL como @code{certfile}, @code{keyfile} y @code{check_hostname} en @ref{5e,,ftplib}, @ref{6f,,http.client}, @ref{74,,imaplib}, @ref{ac,,poplib} y @ref{ca,,smtplib} se han desaprobado en favor de @code{context}. (Contribuido por Christian Heimes en bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022}.)

Un par de protocolos y funciones del módulo @ref{d0,,ssl} ahora están en desuso. Algunas funciones ya no estarán disponibles en futuras versiones de OpenSSL. Otras funciones están obsoletas en favor de una API diferente. (Contribuido por Christian Heimes en bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022} y bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

@node tkinter<7>,venv<6>,ssl<8>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id7}@anchor{db7}
@subsubsection tkinter


The @code{tkinter.tix} module is now deprecated.  @ref{f0,,tkinter} users
should use @ref{f9,,tkinter.ttk} instead.

@node venv<6>,,tkinter<7>,Módulos funciones y métodos de Python obsoletos<2>
@anchor{whatsnew/3 6 id8}@anchor{db8}@anchor{whatsnew/3 6 whatsnew36-venv}@anchor{db9}
@subsubsection venv


La secuencia de comandos @code{pyvenv} se ha desaprobado en favor de @code{python3 -m venv}. Esto evita la confusión en cuanto a qué intérprete de Python @code{pyvenv} está conectado y, por lo tanto, qué intérprete de Python será utilizado por el entorno virtual. (Contribuido por Brett Cannon en bpo-25154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25154}.)

@node xml<6>,Funciones y tipos obsoletos de la API de C,Módulos funciones y métodos de Python obsoletos<2>,Obsoleto<9>
@anchor{whatsnew/3 6 xml}@anchor{dba}
@subsubsection xml



@itemize *

@item 
As mitigation against DTD and external entity retrieval, the
@ref{122,,xml.dom.minidom} and @ref{129,,xml.sax} modules no longer process
external entities by default.
(Contributed by Christian Heimes in gh-61441@footnote{https://github.com/python/cpython/issues/61441}.)
@end itemize

@node Funciones y tipos obsoletos de la API de C,Opciones de compilación obsoletas,xml<6>,Obsoleto<9>
@anchor{whatsnew/3 6 deprecated-functions-and-types-of-the-c-api}@anchor{dbb}
@subsubsection Funciones y tipos obsoletos de la API de C


Undocumented functions @code{PyUnicode_AsEncodedObject()},
@code{PyUnicode_AsDecodedObject()}, @code{PyUnicode_AsEncodedUnicode()}
and @code{PyUnicode_AsDecodedUnicode()} are deprecated now.
Use the @ref{dbc,,generic codec based API} instead.

@node Opciones de compilación obsoletas,,Funciones y tipos obsoletos de la API de C,Obsoleto<9>
@anchor{whatsnew/3 6 deprecated-build-options}@anchor{dbd}
@subsubsection Opciones de compilación obsoletas


El indicador de configuración @code{--with-system-ffi} ahora está activado de forma predeterminada en plataformas UNIX que no son macOS. Puede deshabilitarse mediante @code{--without-system-ffi}, pero el uso de la marca está obsoleto y no se aceptará en Python 3.7. macOS no se ve afectado por este cambio. Tenga en cuenta que muchos distribuidores de sistemas operativos ya utilizan el indicador @code{--with-system-ffi} al crear su sistema Python.

@node Remoto<5>,Portar a Python 3 6,Obsoleto<9>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 removed}@anchor{dbe}
@subsection Remoto


@menu
* Eliminaciones de API y funciones: Eliminaciones de API y funciones<2>. 

@end menu

@node Eliminaciones de API y funciones<2>,,,Remoto<5>
@anchor{whatsnew/3 6 api-and-feature-removals}@anchor{dbf}
@subsubsection Eliminaciones de API y funciones



@itemize *

@item 
Los escapes desconocidos que constan de @code{'\'} y una letra ASCII en expresiones regulares ahora provocarán un error. En las plantillas de reemplazo para @ref{3f2,,re.sub()}, todavía están permitidas, pero en desuso. La bandera @ref{bf4,,re.LOCALE} ahora solo se puede usar con patrones binarios.

@item 
Se eliminó @code{inspect.getmoduleinfo()} (quedó en desuso desde CPython 3.3). Se debe utilizar @ref{dc0,,inspect.getmodulename()} para obtener el nombre del módulo para una ruta determinada. (Contribuido por Yury Selivanov en bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}.)

@item 
La clase @code{traceback.Ignore} y los métodos @code{traceback.usage}, @code{traceback.modname}, @code{traceback.fullmodname}, @code{traceback.find_lines_from_code}, @code{traceback.find_lines}, @code{traceback.find_strings}, @code{traceback.find_executable_lines} se eliminaron del módulo @ref{fe,,traceback}. Eran métodos no documentados en desuso desde Python 3.2 y la funcionalidad equivalente está disponible en métodos privados.

@item 
Se eliminaron los métodos ficticios @code{tk_menuBar()} y @code{tk_bindForTraversal()} en las clases de widgets @ref{f0,,tkinter} (los comandos Tk correspondientes estaban obsoletos desde Tk 4.0).

@item 
El método @ref{4d9,,open()} de la clase @ref{765,,zipfile.ZipFile} ya no admite el modo @code{'U'} (quedó obsoleto desde Python 3.4). Utilice @ref{854,,io.TextIOWrapper} para leer archivos de texto comprimidos en modo @ref{dc1,,universal newlines}.

@item 
Los módulos indocumentados @code{IN}, @code{CDROM}, @code{DLFCN}, @code{TYPES}, @code{CDIO} y @code{STROPTS} se han eliminado. Habían estado disponibles en los directorios @code{Lib/plat-*/} específicos de la plataforma, pero estaban desactualizados de forma crónica, estaban disponibles de manera incoherente en todas las plataformas y no se mantenían. El script que creó estos módulos todavía está disponible en la distribución fuente en: source: Tools / scripts / h2py.py@footnote{https://github.com/python/cpython/blob/v3.6.15/Tools/scripts/h2py.py}.

@item 
Se ha eliminado la clase @code{asynchat.fifo} obsoleta.
@end itemize

@node Portar a Python 3 6,Cambios notables en Python 3 6 2,Remoto<5>,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 porting-to-python-3-6}@anchor{dc2}
@subsection Portar a Python 3.6


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en el comportamiento del comando “python”:: 
* Cambios en la API de Python: Cambios en la API de Python<6>. 
* Cambios en la API de C: Cambios en la API de C<9>. 
* Cambios en el código de bytes de CPython: Cambios en el código de bytes de CPython<6>. 

@end menu

@node Cambios en el comportamiento del comando “python”,Cambios en la API de Python<6>,,Portar a Python 3 6
@anchor{whatsnew/3 6 changes-in-python-command-behavior}@anchor{dc3}
@subsubsection Cambios en el comportamiento del comando “python”



@itemize *

@item 
La salida de una compilación especial de Python con macros @code{COUNT_ALLOCS}, @code{SHOW_ALLOC_COUNT} o @code{SHOW_TRACK_COUNT} definidas ahora está desactivada de forma predeterminada. Se puede volver a habilitar usando la opción @code{-X showalloccount}. Ahora emite a @code{stderr} en lugar de @code{stdout}. (Contribuido por Serhiy Storchaka en bpo-23034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23034}.)
@end itemize

@node Cambios en la API de Python<6>,Cambios en la API de C<9>,Cambios en el comportamiento del comando “python”,Portar a Python 3 6
@anchor{whatsnew/3 6 changes-in-the-python-api}@anchor{dc4}
@subsubsection Cambios en la API de Python



@itemize *

@item 
@ref{1be,,open()} ya no permitirá combinar el indicador de modo @code{'U'} con @code{'+'}. (Contribuido por Jeff Balogh y John O’Connor en bpo-2091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2091}.)

@item 
@ref{cf,,sqlite3} ya no confirma implícitamente una transacción abierta antes de las declaraciones DDL.

@item 
En Linux, @ref{5c6,,os.urandom()} ahora se bloquea hasta que se inicializa el grupo de entropía aleatoria del sistema para aumentar la seguridad.

@item 
Cuando se define @ref{901,,importlib.abc.Loader.exec_module()}, también se debe definir @ref{d37,,importlib.abc.Loader.create_module()}.

@item 
@ref{dc5,,PyErr_SetImportError()} ahora establece @ref{228,,TypeError} cuando su argumento `msg' no está establecido. Anteriormente, solo se devolvía @code{NULL}.

@item 
The format of the @ref{1d9,,co_lnotab} attribute of code objects
changed to support
a negative line number delta. By default, Python does not emit bytecode with
a negative line number delta. Functions using @ref{845,,frame.f_lineno},
@code{PyFrame_GetLineNumber()} or @code{PyCode_Addr2Line()} are not affected.
Functions directly decoding @code{co_lnotab} should be updated to use a signed
8-bit integer type for the line number delta, but this is only required to
support applications using a negative line number delta. See
@code{Objects/lnotab_notes.txt} for the @code{co_lnotab} format and how to decode
it, and see the 
@geindex Python Enhancement Proposals; PEP 511
PEP 511@footnote{https://peps.python.org/pep-0511/} for the rationale.

@item 
Las funciones en el módulo @ref{21,,compileall} ahora devuelven booleanos en lugar de @code{1} o @code{0} para representar éxito o fracaso, respectivamente. Gracias a que los booleanos son una subclase de números enteros, esto solo debería ser un problema si estaba haciendo verificaciones de identidad para @code{1} o @code{0}. Ver bpo-25768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25768}.

@item 
La lectura del atributo @code{port} de los resultados de @ref{dc6,,urllib.parse.urlsplit()} y @ref{207,,urlparse()} ahora lanza @ref{360,,ValueError} para valores fuera de rango, en lugar de devolver @ref{716,,None}. Ver bpo-20059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20059}.

@item 
The @code{imp} module now raises a @ref{1da,,DeprecationWarning} instead of
@ref{95f,,PendingDeprecationWarning}.

@item 
The following modules have had missing APIs added to their @code{__all__}
attributes to match the documented APIs:
@ref{15,,calendar}, @code{cgi}, @ref{2a,,csv},
@ref{125,,ElementTree}, @ref{56,,enum},
@ref{5b,,fileinput}, @ref{5e,,ftplib}, @ref{87,,logging}, @ref{8b,,mailbox},
@ref{8f,,mimetypes}, @ref{a0,,optparse}, @ref{ab,,plistlib}, @code{smtpd},
@ref{d6,,subprocess}, @ref{de,,tarfile}, @ref{ed,,threading} and
@ref{113,,wave}.  This means they will export new symbols when @code{import *}
is used.
(Contributed by Joel Taddei and Jacek Kołodziej in bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883}.)

@item 
Al realizar una importación relativa, si @code{__package__} no se compara igual que @code{__spec__.parent}, entonces @ref{59f,,ImportWarning} se lanza. (Contribuido por Brett Cannon en bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}.)

@item 
Cuando se realiza una importación relativa y no se conoce ningún paquete principal, se lanzará @ref{4d7,,ImportError}. Anteriormente, se podía subir @ref{619,,SystemError}. (Contribuido por Brett Cannon en bpo-18018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18018}.)

@item 
Los servidores basados en el módulo @ref{cd,,socketserver}, incluidos los definidos en @ref{72,,http.server}, @ref{12e,,xmlrpc.server} y @ref{11b,,wsgiref.simple_server}, ahora solo detectan excepciones derivadas de @ref{a6b,,Exception}. Por lo tanto, si un controlador de solicitudes lanza una excepción como @ref{dc7,,SystemExit} o @ref{a63,,KeyboardInterrupt}, ya no se llama a @ref{dc8,,handle_error()} y la excepción detendrá un servidor de un solo subproceso. (Contribuido por Martin Panter en bpo-23430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23430}.)

@item 
@code{spwd.getspnam()} now raises a @ref{dc9,,PermissionError} instead of
@ref{438,,KeyError} if the user doesn’t have privileges.

@item 
El método @ref{dca,,socket.socket.close()} ahora lanza una excepción si la llamada al sistema subyacente informó un error (por ejemplo, @code{EBADF}). (Contribuido por Martin Panter en bpo-26685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26685}.)

@item 
The `decode_data' argument for the @code{smtpd.SMTPChannel} and
@code{smtpd.SMTPServer} constructors is now @code{False} by default.
This means that the argument passed to
@code{process_message()} is now a bytes object by
default, and @code{process_message()} will be passed keyword arguments.
Code that has already been updated in accordance with the deprecation
warning generated by 3.5 will not be affected.

@item 
Todos los argumentos opcionales de las funciones @ref{dcb,,dump()}, @ref{dcc,,dumps()}, @ref{d3d,,load()} y @ref{9e8,,loads()} y los constructores de clase @ref{dcd,,JSONEncoder} y @ref{dce,,JSONDecoder} en el módulo @ref{82,,json} ahora son @ref{3f4,,keyword-only}. (Contribuido por Serhiy Storchaka en bpo-18726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18726}.)

@item 
Es posible que las subclases de @ref{dcf,,type} que no anulan @code{type.__new__} ya no utilicen la forma de un argumento para obtener el tipo de un objeto.

@item 
Como parte de 
@geindex Python Enhancement Proposals; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/}, el manejo de argumentos de palabras clave pasados a @ref{dcf,,type} (aparte de la sugerencia de metaclase, @code{metaclass}) ahora se delega consistentemente en @ref{6d2,,object.__init_subclass__()}. Esto significa que @code{type.__new__()} y @code{type.__init__()} ahora aceptan argumentos de palabras clave arbitrarias, pero @ref{6d2,,object.__init_subclass__()} (que se llama desde @code{type.__new__()}) los rechazará de forma predeterminada. Las metaclases personalizadas que acepten argumentos de palabras clave adicionales deberán ajustar sus llamadas a @code{type.__new__()} (ya sea directa o mediante @ref{155,,super}) en consecuencia.

@item 
In @code{distutils.command.sdist.sdist}, the @code{default_format}
attribute has been removed and is no longer honored. Instead, the
gzipped tarfile format is the default on all platforms and no
platform-specific selection is made.
In environments where distributions are
built on Windows and zip distributions are required, configure
the project with a @code{setup.cfg} file containing the following:

@example
[sdist]
formats=zip
@end example

Este comportamiento también ha sido actualizado a versiones anteriores de Python por Setuptools 26.0.0.

@item 
En el módulo @ref{10b,,urllib.request} y el método @ref{d32,,http.client.HTTPConnection.request()}, si no se ha especificado ningún campo de encabezado Content-Length y el cuerpo de la solicitud es un objeto de archivo, ahora se envía con codificación fragmentada HTTP 1.1. Si un objeto de archivo debe enviarse a un servidor HTTP 1.0, la persona que llama ahora debe especificar el valor de Longitud de contenido. (Contribuido por Demian Brecht y Rolf Krahl con ajustes de Martin Panter en bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@item 
El @ref{a77,,DictReader} ahora devuelve filas de tipo @ref{67c,,OrderedDict}. (Contribuido por Steve Holden en bpo-27842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27842}.)

@item 
The @code{crypt.METHOD_CRYPT} will no longer be added to @code{crypt.methods}
if unsupported by the platform.
(Contributed by Victor Stinner in bpo-25287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25287}.)

@item 
Los argumentos `verbose' and `rename' para @ref{32d,,namedtuple()} ahora son solo palabras clave. (Contribuido por Raymond Hettinger en bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}.)

@item 
En Linux, @ref{dd0,,ctypes.util.find_library()} ahora busca bibliotecas compartidas en @code{LD_LIBRARY_PATH}. (Contribuido por Vinay Sajip en bpo-9998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9998}.)

@item 
La clase @ref{999,,imaplib.IMAP4} ahora maneja banderas que contienen el carácter @code{']'} en mensajes enviados desde el servidor para mejorar la compatibilidad en el mundo real. (Contribuido por Lita Cho en bpo-21815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21815}.)

@item 
La función @code{mmap.write()} ahora devuelve el número de bytes escritos como otros métodos de escritura. (Contribuido por Jakub Stasiak en bpo-26335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26335}.)

@item 
Las funciones @ref{dd1,,pkgutil.iter_modules()} y @ref{c87,,pkgutil.walk_packages()} ahora devuelven tuplas con nombre @ref{dd2,,ModuleInfo}. (Contribuido por Ramchandra Apte en bpo-17211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17211}.)

@item 
@ref{3f2,,re.sub()} ahora lanza un error para referencias de grupos numéricos no válidos en plantillas de reemplazo, incluso si el patrón no se encuentra en la cadena. El mensaje de error para referencias de grupo no válidas ahora incluye el índice de grupo y la posición de la referencia. (Contribuido por SilentGhost, Serhiy Storchaka en bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}.)

@item 
@ref{765,,zipfile.ZipFile} ahora lanzará @ref{384,,NotImplementedError} para valores de compresión no reconocidos. Anteriormente se planteó un @ref{1e5,,RuntimeError} simple. Además, llamar a los métodos @ref{765,,ZipFile} en un ZipFile cerrado o llamar al método @ref{dd3,,write()} en un ZipFile creado con el modo @code{'r'} lanzará un @ref{360,,ValueError}. Anteriormente, se planteó un @ref{1e5,,RuntimeError} en esos escenarios.

@item 
cuando las metaclases personalizadas se combinan con @ref{155,,super()} de argumento cero o referencias directas de métodos a la variable de cierre @code{__class__} implícita, la entrada de espacio de nombres @code{__classcell__} implícita ahora debe pasarse a @code{type.__new__} para la inicialización. No hacerlo resultará en un @ref{1da,,DeprecationWarning} en Python 3.6 y un @ref{1e5,,RuntimeError} en Python 3.8.

@item 
With the introduction of @ref{bcf,,ModuleNotFoundError}, import system consumers
may start expecting import system replacements to raise that more specific
exception when appropriate, rather than the less-specific @ref{4d7,,ImportError}.
To provide future compatibility with such consumers, implementers of
alternative import systems that completely replace @ref{96b,,__import__()} will
need to update their implementations to raise the new subclass when a module
can’t be found at all. Implementers of compliant plugins to the default
import system shouldn’t need to make any changes, as the default import
system will raise the new subclass when appropriate.
@end itemize

@node Cambios en la API de C<9>,Cambios en el código de bytes de CPython<6>,Cambios en la API de Python<6>,Portar a Python 3 6
@anchor{whatsnew/3 6 changes-in-the-c-api}@anchor{dd4}
@subsubsection Cambios en la API de C



@itemize *

@item 
La familia de asignadores @ref{cee,,PyMem_Malloc()} ahora usa el @ref{d96,,pymalloc allocator} en lugar del sistema @code{malloc()}. Las aplicaciones que llaman a @ref{cee,,PyMem_Malloc()} sin sostener el GIL ahora pueden fallar. Establezca la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} en @code{debug} para validar el uso de asignadores de memoria en su aplicación. Ver bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}.

@item 
@ref{dd5,,Py_Exit()} (y el intérprete principal) ahora anula el estado de salida con 120 si fallaron los datos almacenados en el búfer. Ver bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}.
@end itemize

@node Cambios en el código de bytes de CPython<6>,,Cambios en la API de C<9>,Portar a Python 3 6
@anchor{whatsnew/3 6 cpython-bytecode-changes}@anchor{dd6}
@subsubsection Cambios en el código de bytes de CPython


Ha habido varios cambios importantes en el @ref{2f2,,bytecode} en Python 3.6.


@itemize *

@item 
El intérprete de Python ahora usa un código de palabra de 16 bits en lugar de un código de bytes. (Contribuido por Demur Rumed con aportes y reseñas de Serhiy Storchaka y Victor Stinner en bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} y bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050}.)

@item 
Los nuevos códigos de operación @code{FORMAT_VALUE} y @ref{dd7,,BUILD_STRING} como parte de la implementación de @ref{cb7,,formatted string literal}. (Contribuido por Eric Smith en bpo-25483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25483} y Serhiy Storchaka en bpo-27078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27078}.)

@item 
El nuevo @code{BUILD_CONST_KEY_MAP} opcode para optimizar la creación de diccionarios con claves constantes. (Contribuido por Serhiy Storchaka en bpo-27140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27140}.)

@item 
Los códigos de operación de llamada de función se han rediseñado en gran medida para un mejor rendimiento y una implementación más simple. Se han modificado los códigos de operación @ref{dd8,,MAKE_FUNCTION}, @code{CALL_FUNCTION}, @code{CALL_FUNCTION_KW} y @code{BUILD_MAP_UNPACK_WITH_CALL}, se han agregado los nuevos códigos de operación @ref{dd9,,CALL_FUNCTION_EX} y @code{BUILD_TUPLE_UNPACK_WITH_CALL} y se han eliminado los códigos de operación @code{CALL_FUNCTION_VAR}, @code{CALL_FUNCTION_VAR_KW} y @code{MAKE_CLOSURE}. (Contribuido por Demur Rumed en bpo-27095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27095} y Serhiy Storchaka en bpo-27213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27213}, bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257}.)

@item 
Se han agregado los nuevos códigos de operación @ref{dda,,SETUP_ANNOTATIONS} y @code{STORE_ANNOTATION} para admitir la nueva sintaxis @ref{ddb,,variable annotation}. (Contribuido por Ivan Levkivskyi en bpo-27985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27985}.)
@end itemize

@node Cambios notables en Python 3 6 2,Cambios notables en Python 3 6 4,Portar a Python 3 6,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-2}@anchor{ddc}
@subsection Cambios notables en Python 3.6.2


@menu
* Nuevo objetivo de compilación make regen-all:: 
* Eliminación del objetivo de compilación make touch:: 

@end menu

@node Nuevo objetivo de compilación make regen-all,Eliminación del objetivo de compilación make touch,,Cambios notables en Python 3 6 2
@anchor{whatsnew/3 6 new-make-regen-all-build-target}@anchor{ddd}
@subsubsection Nuevo objetivo de compilación @code{make regen-all}


Para simplificar la compilación cruzada y garantizar que CPython se pueda compilar de manera confiable sin requerir que una versión existente de Python ya esté disponible, el sistema de compilación basado en autotools ya no intenta volver a compilar implícitamente los archivos generados en función de los tiempos de modificación del archivo.

En su lugar, se ha agregado un nuevo comando @code{make regen-all} para forzar la regeneración de estos archivos cuando se desee (por ejemplo, después de que ya se haya creado una versión inicial de Python basada en las versiones pregeneradas).

También se definen objetivos de regeneración más selectivos; consulte: fuente: @cite{Makefile.pre.in} para obtener más detalles.

(Contribuido por Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Added in version 3.6.2.


@node Eliminación del objetivo de compilación make touch,,Nuevo objetivo de compilación make regen-all,Cambios notables en Python 3 6 2
@anchor{whatsnew/3 6 removal-of-make-touch-build-target}@anchor{dde}
@subsubsection Eliminación del objetivo de compilación @code{make touch}


Se ha eliminado el objetivo de compilación @code{make touch} que se utilizaba anteriormente para solicitar la regeneración implícita de archivos generados mediante la actualización de sus tiempos de modificación.

Ha sido reemplazado por el nuevo objetivo @code{make regen-all}.

(Contribuido por Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Distinto en la versión 3.6.2.


@node Cambios notables en Python 3 6 4,Cambios notables en Python 3 6 5,Cambios notables en Python 3 6 2,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-4}@anchor{ddf}
@subsection Cambios notables en Python 3.6.4


El singleton @code{PyExc_RecursionErrorInst} que formaba parte de la API pública se ha eliminado ya que sus miembros nunca borrados pueden causar una falla de segmentación durante la finalización del intérprete. (Contribuido por Xavier de Gaye en bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} y bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}.)

@node Cambios notables en Python 3 6 5,Cambios notables en Python 3 6 7,Cambios notables en Python 3 6 4,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-5}@anchor{de0}
@subsection Cambios notables en Python 3.6.5


La función @ref{c86,,locale.localeconv()} ahora establece temporalmente la configuración regional @code{LC_CTYPE} en la configuración regional @code{LC_NUMERIC} en algunos casos. (Contribuido por Victor Stinner en bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}.)

@node Cambios notables en Python 3 6 7,Cambios notables en Python 3 6 10,Cambios notables en Python 3 6 5,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-7}@anchor{de1}
@subsection Cambios notables en Python 3.6.7


@ref{122,,xml.dom.minidom} and @ref{129,,xml.sax} modules no longer process
external entities by default. See also gh-61441@footnote{https://github.com/python/cpython/issues/61441}.

En 3.6.7, el módulo @ref{fb,,tokenize} ahora emite implícitamente un token @code{NEWLINE} cuando se le proporciona una entrada que no tiene una nueva línea al final. Este comportamiento ahora coincide con lo que hace el tokenizador C internamente. (Contribuido por Ammar Askar en bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node Cambios notables en Python 3 6 10,Cambios notables en Python 3 6 13,Cambios notables en Python 3 6 7,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-10}@anchor{de2}
@subsection Cambios notables en Python 3.6.10


Debido a importantes problemas de seguridad, el parámetro `reuse_address' de @ref{7cf,,asyncio.loop.create_datagram_endpoint()} ya no es compatible. Esto se debe al comportamiento de la opción de socket @code{SO_REUSEADDR} en UDP. Para obtener más detalles, consulte la documentación de @code{loop.create_datagram_endpoint()}. (Contribuido por Kyle Stanley, Antoine Pitrou y Yury Selivanov en bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Cambios notables en Python 3 6 13,Notable changes in Python 3 6 14,Cambios notables en Python 3 6 10,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-13}@anchor{de3}
@subsection Cambios notables en Python 3.6.13


Earlier Python versions allowed using both @code{;} and @code{&} as
query parameter separators in @ref{1c9,,urllib.parse.parse_qs()} and
@ref{1c8,,urllib.parse.parse_qsl()}.  Due to security concerns, and to conform with
newer W3C recommendations, this has been changed to allow only a single
separator key, with @code{&} as the default.  This change also affects
@code{cgi.parse()} and @code{cgi.parse_multipart()} as they use the affected
functions internally. For more details, please see their respective
documentation.
(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Notable changes in Python 3 6 14,,Cambios notables en Python 3 6 13,Qué hay de nuevo en Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-14}@anchor{de4}
@subsection Notable changes in Python 3.6.14


A security fix alters the @ref{990,,ftplib.FTP} behavior to not trust the
IPv4 address sent from the remote server when setting up a passive data
channel.  We reuse the ftp server IP address instead.  For unusual code
requiring the old behavior, set a @code{trust_server_pasv_ipv4_address}
attribute on your FTP instance to @code{True}.  (See gh-87451@footnote{https://github.com/python/cpython/issues/87451})

The presence of newline or tab characters in parts of a URL allows for some
forms of attacks. Following the WHATWG specification that updates RFC 3986,
ASCII newline @code{\n}, @code{\r} and tab @code{\t} characters are stripped from the
URL by the parser @ref{10a,,urllib.parse()} preventing such attacks. The removal
characters are controlled by a new module level variable
@code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (See gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node Qué hay de nuevo en Python 3 5,Qué hay de nuevo en Python 3 4,Qué hay de nuevo en Python 3 6,Qué hay de nuevo en Python
@anchor{whatsnew/3 5 doc}@anchor{de5}@anchor{whatsnew/3 5 what-s-new-in-python-3-5}@anchor{de6}
@section Qué hay de nuevo en Python 3.5


@*Editores: 
Elvis Pranskevichus <@email{elvis@@magic.io}>, Yury Selivanov <@email{yury@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

Este artículo explica las nuevas características de Python 3.5, en comparación con 3.4. Python 3.5 se publicó el 13 de septiembre de 2015. Consultar el registro de cambios@footnote{https://docs.python.org/3.5/whatsnew/changelog.html} para una lista completa de cambios.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 478
PEP 478@footnote{https://peps.python.org/pep-0478/} - Python 3.5 Calendario de lanzamiento de Python 3.5


@menu
* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<3>. 
* Nuevas características: Nuevas características<11>. 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<3>. 
* Nuevos módulos: Nuevos módulos<7>. 
* Módulos mejorados: Módulos mejorados<8>. 
* Otros cambios a nivel de módulo:: 
* Optimizaciones: Optimizaciones<8>. 
* Cambios en la compilación y la API de C: Cambios en la compilación y la API de C<2>. 
* Obsoleto: Obsoleto<10>. 
* Eliminado: Eliminado<5>. 
* Portando a Python 3.5: Portando a Python 3 5. 
* Cambios notables en Python 3.5.4: Cambios notables en Python 3 5 4. 

@end menu

@node Resumen – Aspectos destacados de la versión<3>,Nuevas características<11>,,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 summary-release-highlights}@anchor{de7}
@subsection Resumen – Aspectos destacados de la versión


Nuevas características de sintaxis:


@itemize *

@item 
@ref{de8,,PEP 492}, corrutinas con sintaxis async y await.

@item 
@ref{de9,,PEP 465}, un nuevo operador de multiplicación de matrices: @code{a @@ b}.

@item 
@ref{dea,,PEP 448}, generalizaciones de desembalaje adicionales.
@end itemize

Nuevos módulos:


@itemize *

@item 
@ref{104,,typing}: @ref{deb,,PEP 484 – Indicador de tipos}.

@item 
@ref{12f,,zipapp}: @ref{dec,,PEP 441 Mejora de soporte de la aplicación Python ZIP}.
@end itemize

Nuevas características integradas:


@itemize *

@item 
@code{bytes % args}, @code{bytearray % args}: @ref{ded,,PEP 461} – Agrega formato @code{%} a bytes y bytearray.

@item 
Nuevos métodos @ref{dee,,bytes.hex()}, @ref{def,,bytearray.hex()} y @ref{df0,,memoryview.hex()}. (Contribución de Arnon Yaari en bpo-9951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9951}.)

@item 
@ref{156,,memoryview} ahora admite la indexación de tuplas (incluida la multidimensional). (Contribución de Antoine Pitrou en bpo-23632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23632}.)

@item 
Los generadores tienen un nuevo atributo @code{gi_yieldfrom}, el cual retorna el objeto que está siendo iterado por expresiones @code{yield from}. (Contribución de Benno Leslie y Yury Selivanov en bpo-24450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24450}.)

@item 
Ahora se genera una nueva excepción @ref{df1,,RecursionError} cuando se alcanza la profundidad máxima de recursividad. (Contribución de Georg Brandl en bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}.)
@end itemize

Mejoras en la implementación de CPython:


@itemize *

@item 
Cuando la configuración regional @code{LC_TYPE} es la configuración regional POSIX (configuración regional @code{C}), ahora @ref{5df,,sys.stdin} y @ref{b61,,sys.stdout} usan el controlador de errores @code{surrogateescape}, en lugar del controlador de errores @code{strict}. (Contribución de Victor Stinner en bpo-19977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19977}.)

@item 
Los archivos @code{.pyo} ya no se utilizan y han sido reemplazados por un esquema más flexible que incluye el nivel de optimización explícitamente en el nombre @code{.pyc}. (Consultar la @ref{df2,,PEP 488 descripción general}.)

@item 
Ahora los módulos integrados y de extensión son inicializados en un proceso de múltiples fases, que es similar a cómo los módulos de Python son cargados. (Consultar @ref{df3,,PEP 489 descripción general}.)
@end itemize

Mejoras significativas en la biblioteca estándar:


@itemize *

@item 
@ref{67c,,collections.OrderedDict} ahora está @ref{df4,,implementado en C}, que lo hace de 4 a 100 veces más rápido.

@item 
El módulo @ref{d0,,ssl} adquirió @ref{df5,,soporte para la memoria BIO}, que desacopla el manejo del protocolo SSL de la red de E/S.

@item 
La nueva función @ref{1a2,,os.scandir()} proporciona una @ref{df6,,forma mejor y significativamente más rápida} de recorrido de directorio.

@item 
@ref{a81,,functools.lru_cache()} ha sido principalmente @ref{df7,,reimplementado en C}, produciendo un rendimiento mucho mejor.

@item 
La nueva función @ref{c0e,,subprocess.run()} proporciona una @ref{df8,,forma simplificada de ejecutar subprocesos}.

@item 
El módulo @ref{fe,,traceback} se ha @ref{df9,,mejorado} significativamente para mejorar el rendimiento y la conveniencia del desarrollador.
@end itemize

Mejoras de seguridad:


@itemize *

@item 
Ahora SSLv3 está deshabilitado en toda la biblioteca estándar. Aún se puede habilitar creando una instancia de @ref{1fa,,ssl.SSLContext} manualmente. (Consultar bpo-22638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22638} para más detalles; este cambio fue respaldado a CPython 3.4 y 2.7.)

@item 
Ahora el análisis de cookies HTTP es más estricto, con el fin de proteger contra posibles ataques de entrada. (Contribución de Antoine Pitrou en bpo-22796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22796}.)
@end itemize

Mejoras de Windows:


@itemize *

@item 
Un nuevo instalador para Windows ha reemplazado al antiguo MSI. Consultar @ref{b32,,Uso de Python en Windows} para más información.

@item 
Ahora las compilaciones de Windows usan Microsoft Visual C++ 14.0, y los módulos de extensión deberían utilizar lo mismo.
@end itemize

Por favor sigue leyendo para obtener una lista completa de los cambios que se enfrentan los usuarios, incluidas muchas otras mejoras menores, optimizaciones de CPython, deprecaciones y posibles problemas de portabilidad.

@node Nuevas características<11>,Otros cambios en el lenguaje<3>,Resumen – Aspectos destacados de la versión<3>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 new-features}@anchor{dfa}
@subsection Nuevas características


@menu
* PEP 492 - Corrutinas con sintaxis async y await:: 
* PEP 465 - Un operador infijo dedicado para la multiplicación de matrices:: 
* PEP 448 - Generalizaciones de desembalaje adicionales:: 
* PEP 461 - soporte de formateo porcentual para bytes y bytearray:: 
* PEP 484 - Indicador de tipos:: 
* PEP 471 - Función os.scandir() – un iterador de directorio mejor y más rápido: PEP 471 - Función os scandir – un iterador de directorio mejor y más rápido. 
* PEP 475; Reintentar las llamadas al sistema que fallan con EINTR: PEP 475 Reintentar las llamadas al sistema que fallan con EINTR. 
* PEP 479; Cambiar el gestor de StopIteration dentro de generadores: PEP 479 Cambiar el gestor de StopIteration dentro de generadores. 
* PEP 485; Una función para probar la igualdad aproximada: PEP 485 Una función para probar la igualdad aproximada. 
* PEP 486; Hacer que el launcher de Python sea consciente de los entornos virtuales: PEP 486 Hacer que el launcher de Python sea consciente de los entornos virtuales. 
* PEP 488; Eliminación de archivos PYO: PEP 488 Eliminación de archivos PYO. 
* PEP 489; Inicialización del módulo de extensión multifase: PEP 489 Inicialización del módulo de extensión multifase. 

@end menu

@node PEP 492 - Corrutinas con sintaxis async y await,PEP 465 - Un operador infijo dedicado para la multiplicación de matrices,,Nuevas características<11>
@anchor{whatsnew/3 5 pep-492-coroutines-with-async-and-await-syntax}@anchor{dfb}@anchor{whatsnew/3 5 whatsnew-pep-492}@anchor{de8}
@subsubsection PEP 492 - Corrutinas con sintaxis async y await


@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} mejora enormemente el soporte para la programación asíncrona en Python al agregar @ref{314,,objetos aguardables}, @ref{dfc,,funciones corrutina}, @ref{dfd,,iteración asincrónica}, y @ref{678,,gestores asincrónicos de contexto}.

Las funciones corrutina se declaran usando la nueva sintaxis @ref{672,,async def}:

@example
>>> async def coro():
...     return 'spam'
@end example

Dentro de una función corrutina, la nueva expresión @ref{14e,,await} puede ser usada para suspender la ejecución de la corrutina hasta que el resultado esté disponible. Cualquier objeto puede ser `awaited', siempre que implemente el protocolo @ref{314,,awaitable} al definir el método @code{__await__()}.

PEP 492 también agrega la declaración @ref{b36,,async for} para una iteración conveniente sobre iterables asincrónicas.

Un ejemplo de un cliente rudimentario HTTP escrito con la nueva sintaxis:

@example
import asyncio

async def http_get(domain):
    reader, writer = await asyncio.open_connection(domain, 80)

    writer.write(b'\r\n'.join([
        b'GET / HTTP/1.1',
        b'Host: %b' % domain.encode('latin-1'),
        b'Connection: close',
        b'@w{'}, b'@w{'}
    ]))

    async for line in reader:
        print('>>>', line)

    writer.close()

loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(http_get('example.com'))
finally:
    loop.close()
@end example

De manera similar a la iteración asincrónica, hay una nueva sintaxis para los gestores asincrónicos de contexto. El siguiente script:

@example
import asyncio

async def coro(name, lock):
    print('coro @{@}: waiting for lock'.format(name))
    async with lock:
        print('coro @{@}: holding the lock'.format(name))
        await asyncio.sleep(1)
        print('coro @{@}: releasing the lock'.format(name))

loop = asyncio.get_event_loop()
lock = asyncio.Lock()
coros = asyncio.gather(coro(1, lock), coro(2, lock))
try:
    loop.run_until_complete(coros)
finally:
    loop.close()
@end example

saldrá:

@example
coro 2: waiting for lock
coro 2: holding the lock
coro 1: waiting for lock
coro 2: releasing the lock
coro 1: holding the lock
coro 1: releasing the lock
@end example

Ten en cuenta que tanto @ref{b36,,async for} como @ref{676,,async with} solamente pueden ser utilizadas dentro de una función corrutina declarada con @ref{672,,async def}.

Las funciones corrutina están destinadas para ser ejecutadas dentro de un bucle de eventos compatible, como @ref{dfe,,asyncio loop}.

@cartouche
@quotation Nota 

Distinto en la versión 3.5.2: A partir de CPython 3.5.2, @code{__aiter__} puede retornar directamente @ref{312,,iteradores asincrónicos}. Retornar un objeto @ref{314,,awaitable} resultará en @ref{95f,,PendingDeprecationWarning}.

Consultar más detalles en la sección de la documentación @ref{dff,,Iteradores asíncronos}.

@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} – Corrutinas con sintaxis async y await

PEP escrito e implementado por Yury Selivanov.
@end table


@node PEP 465 - Un operador infijo dedicado para la multiplicación de matrices,PEP 448 - Generalizaciones de desembalaje adicionales,PEP 492 - Corrutinas con sintaxis async y await,Nuevas características<11>
@anchor{whatsnew/3 5 pep-465-a-dedicated-infix-operator-for-matrix-multiplication}@anchor{e00}@anchor{whatsnew/3 5 whatsnew-pep-465}@anchor{de9}
@subsubsection PEP 465 - Un operador infijo dedicado para la multiplicación de matrices


@geindex Python Enhancement Proposals; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} agrega el operador infijo @code{@@} para la multiplicación de matrices. Actualmente, ningún tipo de Python incorporado implementa el nuevo operador, sin embargo, puede ser implementado al definir @code{__matmul__()}, @code{__rmatmul__()}, y @code{__imatmul__()} para la multiplicación de matrices regulares, reflejadas e in situ. La semántica de estos métodos es similar a la de los métodos que definen otros operadores infijos aritméticos.

La multiplicación de matrices es una operación notablemente común en muchos campos de las matemáticas, la ciencia, la ingeniería, y la adición de @code{@@} permite escribir código más limpio:

@example
S = (H @@ beta - r).T @@ inv(H @@ V @@ H.T) @@ (H @@ beta - r)
@end example

en lugar de:

@example
S = dot((dot(H, beta) - r).T,
        dot(inv(dot(dot(H, V), H.T)), dot(H, beta) - r))
@end example

NumPy 1.10 tiene soporte para el nuevo operador:

@example
>>> import numpy

>>> x = numpy.ones(3)
>>> x
array([ 1., 1., 1.])

>>> m = numpy.eye(3)
>>> m
array([[ 1., 0., 0.],
       [ 0., 1., 0.],
       [ 0., 0., 1.]])

>>> x @@ m
array([ 1., 1., 1.])
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 465

@item PEP 465@footnote{https://peps.python.org/pep-0465/} – Un operador infijo dedicado para la multiplicación de matrices

PEP escrito por Nathaniel J. Smith; implementado por Benjamin Peterson.
@end table


@node PEP 448 - Generalizaciones de desembalaje adicionales,PEP 461 - soporte de formateo porcentual para bytes y bytearray,PEP 465 - Un operador infijo dedicado para la multiplicación de matrices,Nuevas características<11>
@anchor{whatsnew/3 5 pep-448-additional-unpacking-generalizations}@anchor{e01}@anchor{whatsnew/3 5 whatsnew-pep-448}@anchor{dea}
@subsubsection PEP 448 - Generalizaciones de desembalaje adicionales


@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} extiende los usos permitidos del operador de desembalaje iterable @code{*} y del operador de desembalaje del diccionario @code{**}. Ahora es posible utilizar un número arbitrario de desembalajes en @ref{e02,,llamadas a funciones}:

@example
>>> print(*[1], *[2], 3, *[4, 5])
1 2 3 4 5

>>> def fn(a, b, c, d):
...     print(a, b, c, d)
...

>>> fn(**@{'a': 1, 'c': 3@}, **@{'b': 2, 'd': 4@})
1 2 3 4
@end example

De manera similar, las pantallas de tupla, lista, conjunto y diccionario permiten desembalajes múltiples (consultar @ref{e03,,Listas de expresiones} and @ref{e04,,Despliegues de diccionario}):

@example
>>> *range(4), 4
(0, 1, 2, 3, 4)

>>> [*range(4), 4]
[0, 1, 2, 3, 4]

>>> @{*range(4), 4, *(5, 6, 7)@}
@{0, 1, 2, 3, 4, 5, 6, 7@}

>>> @{'x': 1, **@{'y': 2@}@}
@{'x': 1, 'y': 2@}
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 448

@item PEP 448@footnote{https://peps.python.org/pep-0448/} – Generalizaciones de desembalaje adicionales

PEP escrito por Joshua Landau; implementado por Neil Girdhar, Thomas Wouters y Joshua Landau.
@end table


@node PEP 461 - soporte de formateo porcentual para bytes y bytearray,PEP 484 - Indicador de tipos,PEP 448 - Generalizaciones de desembalaje adicionales,Nuevas características<11>
@anchor{whatsnew/3 5 pep-461-percent-formatting-support-for-bytes-and-bytearray}@anchor{e05}@anchor{whatsnew/3 5 whatsnew-pep-461}@anchor{ded}
@subsubsection PEP 461 - soporte de formateo porcentual para bytes y bytearray


@geindex Python Enhancement Proposals; PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} agrega soporte para el @ref{e06,,operador de interpolación} @code{%} a @ref{325,,bytes} y @ref{5e0,,bytearray}.

Si bien la interpolación generalmente se considera una operación de cadena de caracteres, hay casos donde la interpolación en @code{bytes} o @code{bytearrays} tiene sentido y el trabajo necesario para compensar esta funcionalidad faltante resta valor a la legibilidad general del código. Este problema es particularmente importante cuando se trata con protocolos de formato de cable, que a menudo son una mezcla de texto compatible binario y ASCII.

Ejemplos:

@example
>>> b'Hello %b!' % b'World'
b'Hello World!'

>>> b'x=%i y=%f' % (1, 2.5)
b'x=1 y=2.500000'
@end example

Unicode no está permitido para @code{%b}, pero es aceptado por @code{%a} (equivalente a @code{repr(obj).encode('ascii', 'backslashreplace')}):

@example
>>> b'Hello %b!' % 'World'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: %b requires bytes, or an object that implements __bytes__, not 'str'

>>> b'price: %a' % '10€'
b"price: '10\\u20ac'"
@end example

Ten en cuenta que los tipos de conversión @code{%s} y @code{%r}, aunque son compatibles, solo deben usarse en bases de código que necesiten compatibilidad con Python 2.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 461

@item PEP 461@footnote{https://peps.python.org/pep-0461/} – Agrega formato @code{%} a bytes y bytearray

PEP escrito por Ethan Furman; implementado por Neil Schemenauer y Ethan Furman.
@end table


@node PEP 484 - Indicador de tipos,PEP 471 - Función os scandir – un iterador de directorio mejor y más rápido,PEP 461 - soporte de formateo porcentual para bytes y bytearray,Nuevas características<11>
@anchor{whatsnew/3 5 pep-484-type-hints}@anchor{e07}@anchor{whatsnew/3 5 whatsnew-pep-484}@anchor{deb}
@subsubsection PEP 484 - Indicador de tipos


La sintaxis de anotaciones de funciones ha sido una característica de Python desde la versión 3.0 (
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}), sin embargo, la semántica de anotaciones se ha dejado indefinida.

La experiencia ha mostrado que la mayoría de los usos de las anotaciones de funciones eran para proporcionar el indicador de tipos para los parámetros de función y los valores de retorno. Se hizo evidente que sería beneficioso para los usuarios de Python, si la biblioteca estándar incluyera las definiciones y las herramientas base para las anotaciones de tipo.

@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introduce un @ref{b8e,,módulo provisional} para proporcionar estas definiciones y herramientas estándar, junto con algunas convenciones para situaciones en la que las anotaciones no están disponibles.

Por ejemplo, aquí hay una función simple cuyo argumento y tipo de retorno se declaran en las anotaciones:

@example
def greeting(name: str) -> str:
    return 'Hello ' + name
@end example

While these annotations are available at runtime through the usual
@ref{e08,,__annotations__} attribute, `no automatic type checking happens
at runtime'.  Instead, it is assumed that a separate off-line type checker
(e.g. mypy@footnote{https://mypy-lang.org}) will be used for on-demand
source code analysis.

El sistema de tipos admite uniones, tipos genéricos y un tipo especial llamado @ref{74d,,Any} el cual es consistente con (esto es asignable desde y hacia) todos los tipos.


@subsubheading Ver también



@itemize *

@item 
@ref{104,,typing} documentación del módulo

@item 

@table @asis

@geindex Python Enhancement Proposals; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} – Indicador de tipos

PEP escrito por Guido van Rossum, Jukka Lehtosalo y Łukasz Langa; implementado por Guido van Rossum.
@end table

@item 

@table @asis

@geindex Python Enhancement Proposals; PEP 483

@item PEP 483@footnote{https://peps.python.org/pep-0483/} – La teoría del indicador de tipos

PEP escrito por Guido van Rossum
@end table
@end itemize


@node PEP 471 - Función os scandir – un iterador de directorio mejor y más rápido,PEP 475 Reintentar las llamadas al sistema que fallan con EINTR,PEP 484 - Indicador de tipos,Nuevas características<11>
@anchor{whatsnew/3 5 pep-471-os-scandir-function-a-better-and-faster-directory-iterator}@anchor{e09}@anchor{whatsnew/3 5 whatsnew-pep-471}@anchor{df6}
@subsubsection PEP 471 - Función os.scandir() – un iterador de directorio mejor y más rápido


@geindex Python Enhancement Proposals; PEP 471
PEP 471@footnote{https://peps.python.org/pep-0471/} agrega una nueva función de iteración de directorio, @ref{1a2,,os.scandir()}, a la biblioteca estándar. Adicionalmente, ahora @ref{551,,os.walk()} se implementa utilizando @code{scandir}, lo que lo hace de 3 a 5 veces más rápido en sistemas POSIX y de 7 a 20 veces más rápido en sistemas Windows. Esto se logra en gran medida al reducir enormemente el número de llamadas necesarias de @ref{548,,os.stat()} para recorrer un árbol de directorios.

También @code{scandir} retorna un iterador, en lugar de retornar una lista de nombres de archivos, lo que mejora la eficiencia de la memoria cuando se itera sobre directorios muy grandes.

El siguiente ejemplo presenta un uso simple de @ref{1a2,,os.scandir()} para mostrar todos los archivos (excluyendo directorios) en el `path' dado que no comienzan con @code{'.'}. La llamada a @ref{e0a,,entry.is_file()} generalmente no hará una llamada adicional al sistema:

@example
for entry in os.scandir(path):
    if not entry.name.startswith('.') and entry.is_file():
        print(entry.name)
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 471

@item PEP 471@footnote{https://peps.python.org/pep-0471/} – Función os.scandir() – un iterador de directorio mejor y más rápido

PEP escrito e implementado por Ben Hoyt con la ayuda de Victor Stinner.
@end table


@node PEP 475 Reintentar las llamadas al sistema que fallan con EINTR,PEP 479 Cambiar el gestor de StopIteration dentro de generadores,PEP 471 - Función os scandir – un iterador de directorio mejor y más rápido,Nuevas características<11>
@anchor{whatsnew/3 5 pep-475-retry-system-calls-failing-with-eintr}@anchor{e0b}@anchor{whatsnew/3 5 whatsnew-pep-475}@anchor{e0c}
@subsubsection PEP 475: Reintentar las llamadas al sistema que fallan con EINTR


An @ref{e0d,,errno.EINTR} error code is returned whenever a system call, that
is waiting for I/O, is interrupted by a signal.  Previously, Python would
raise @ref{e0e,,InterruptedError} in such cases.  This meant that, when writing a
Python application, the developer had two choices:


@enumerate 

@item 
Ignorar el @code{InterruptedError}.

@item 
Manejar el @code{InterruptedError} y probar reiniciar la llamada interrumpida al sistema en cada sitio de llamada.
@end enumerate

La primera opción hace que una aplicación falle intermitentemente. La segunda opción agrega una gran cantidad de código repetitivo que hace que el código sea casi ilegible. Compara:

@example
print("Hello World")
@end example

y:

@example
while True:
    try:
        print("Hello World")
        break
    except InterruptedError:
        continue
@end example

@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} implementa el reintento automático de las llamadas al sistema en @code{EINTR}. Esto elimina la carga de lidiar con @code{EINTR} o la excepción @ref{e0e,,InterruptedError} en el código de usuario en la mayoría de las situaciones y hace que los programas de Python, incluida la biblioteca estándar, sean más robustos. Ten en cuenta que la llamada al sistema sólo se reintenta si el gestor de señales no lanza una excepción.

A continuación se muestra una lista de funciones que ahora se reintentan cuando son interrumpidas por una señal:


@itemize *

@item 
@ref{1be,,open()} y @ref{5c0,,io.open()};

@item 
funciones del módulo @ref{58,,faulthandler};

@item 
funciones del módulo @ref{a1,,os}: @ref{e0f,,fchdir()}, @ref{379,,fchmod()}, @ref{e10,,fchown()}, @ref{e11,,fdatasync()}, @ref{e12,,fstat()}, @ref{e13,,fstatvfs()}, @ref{e14,,fsync()}, @ref{e15,,ftruncate()}, @ref{e16,,mkfifo()}, @ref{e17,,mknod()}, @ref{e18,,open()}, @ref{e19,,posix_fadvise()}, @ref{e1a,,posix_fallocate()}, @ref{be7,,pread()}, @ref{bea,,pwrite()}, @ref{e1b,,read()}, @ref{be6,,readv()}, @ref{b9a,,sendfile()}, @ref{e1c,,wait3()}, @ref{e1d,,wait4()}, @ref{e1e,,wait()}, @ref{e1f,,waitid()}, @ref{e20,,waitpid()}, @ref{e21,,write()}, @ref{be9,,writev()};

@item 
special cases: @ref{bfc,,os.close()} and @ref{beb,,os.dup2()} now ignore
@ref{e0d,,EINTR} errors; the syscall is not retried (see the PEP
for the rationale);

@item 
funciones del módulo @ref{c1,,select}: @ref{e22,,devpoll.poll()}, @ref{e23,,epoll.poll()}, @ref{e24,,kqueue.control()}, @ref{e25,,poll.poll()}, @ref{e26,,select()};

@item 
métodos de la clase @ref{e27,,socket}: @ref{e28,,accept()}, @ref{e29,,connect()} (excepto para sockets sin bloqueo), @ref{e2a,,recv()}, @ref{e2b,,recvfrom()}, @ref{e2c,,recvmsg()}, @ref{e2d,,send()}, @ref{e2e,,sendall()}, @ref{521,,sendmsg()}, @ref{e2f,,sendto()};

@item 
@ref{e30,,signal.sigtimedwait()} y @ref{e31,,signal.sigwaitinfo()};

@item 
@ref{73e,,time.sleep()}.
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 475

@item PEP 475@footnote{https://peps.python.org/pep-0475/} – Reintentar las llamadas al sistema que fallan con EINTR

PEP e implementación escrita por Charles-François Natali y Victor Stinner, con la ayuda de Antoine Pitrou (la conexión francesa).
@end table


@node PEP 479 Cambiar el gestor de StopIteration dentro de generadores,PEP 485 Una función para probar la igualdad aproximada,PEP 475 Reintentar las llamadas al sistema que fallan con EINTR,Nuevas características<11>
@anchor{whatsnew/3 5 pep-479-change-stopiteration-handling-inside-generators}@anchor{e32}@anchor{whatsnew/3 5 whatsnew-pep-479}@anchor{da6}
@subsubsection PEP 479: Cambiar el gestor de StopIteration dentro de generadores


La interacción de los generadores y @ref{c82,,StopIteration} en las versiones de Python 3.4 y anteriores a veces fue sorprendente y podría ocultar bugs oscuros. Anteriormente, el @code{StopIteration} lanzado accidentalmente dentro de una función de generadores se interpretó como el final de la iteración por la construcción de bucle que impulsa el generador.

@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} cambia el comportamiento de los generadores: cuando se lanza una excepción @code{StopIteration} dentro de un generador, se reemplaza con una excepción @ref{1e5,,RuntimeError} antes de que salga del marco del generador. El objetivo principal de este cambio es facilitar la depuración en la situación en la que una llamada desprotegida a la función @ref{86f,,next()} lanza una excepción @code{StopIteration} y hace que la iteración controlada por el generador termine silenciosamente. Esto es particularmente pernicioso en combinación con la construcción @code{yield from}.

Este es un cambio incompatible hacia atrás, así que para habilitar el nuevo comportamiento, es necesario importar @ref{e33,,__future__}:

@example
>>> from __future__ import generator_stop

>>> def gen():
...     next(iter([]))
...     yield
...
>>> next(gen())
Traceback (most recent call last):
  File "<stdin>", line 2, in gen
StopIteration

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: generator raised StopIteration
@end example

Si no se importa @code{__future__}, se lanzará la excepción @ref{95f,,PendingDeprecationWarning} siempre que se lance una excepción @ref{c82,,StopIteration} dentro de un generador.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 479

@item PEP 479@footnote{https://peps.python.org/pep-0479/} – Cambiar el gestor de StopIteration dentro de generadores

PEP escrito por Chris Angelico y Guido van Rossum. Implementado por Chris Angelico, Yury Selivanov y Nick Coghlan.
@end table


@node PEP 485 Una función para probar la igualdad aproximada,PEP 486 Hacer que el launcher de Python sea consciente de los entornos virtuales,PEP 479 Cambiar el gestor de StopIteration dentro de generadores,Nuevas características<11>
@anchor{whatsnew/3 5 pep-485-a-function-for-testing-approximate-equality}@anchor{e34}@anchor{whatsnew/3 5 whatsnew-pep-485}@anchor{e35}
@subsubsection PEP 485: Una función para probar la igualdad aproximada


@geindex Python Enhancement Proposals; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} agrega las funciones @ref{e36,,math.isclose()} y @ref{e37,,cmath.isclose()} que indican si dos valores son aproximadamente iguales o «cercanos» entre sí. Si dos valores se consideran cercanos o no, se determina conforme con las tolerancias absolutas y relativas dadas. La tolerancia relativa es la diferencia máxima permitida entre los argumentos @code{isclose}, en relación con el valor absoluto mayor:

@example
>>> import math
>>> a = 5.0
>>> b = 4.99998
>>> math.isclose(a, b, rel_tol=1e-5)
True
>>> math.isclose(a, b, rel_tol=1e-6)
False
@end example

También es posible comparar dos valores usando una tolerancia absoluta, que debe ser un valor no negativo:

@example
>>> import math
>>> a = 5.0
>>> b = 4.99998
>>> math.isclose(a, b, abs_tol=0.00003)
True
>>> math.isclose(a, b, abs_tol=0.00001)
False
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 485

@item PEP 485@footnote{https://peps.python.org/pep-0485/} – Una función para probar la igualdad aproximada

PEP escrito por Christopher Barker; implementado por Chris Barker y Tal Einat.
@end table


@node PEP 486 Hacer que el launcher de Python sea consciente de los entornos virtuales,PEP 488 Eliminación de archivos PYO,PEP 485 Una función para probar la igualdad aproximada,Nuevas características<11>
@anchor{whatsnew/3 5 pep-486-make-the-python-launcher-aware-of-virtual-environments}@anchor{e38}@anchor{whatsnew/3 5 whatsnew-pep-486}@anchor{e39}
@subsubsection PEP 486: Hacer que el launcher de Python sea consciente de los entornos virtuales


@geindex Python Enhancement Proposals; PEP 486
PEP 486@footnote{https://peps.python.org/pep-0486/} hace que el launcher de Windows (consultar 
@geindex Python Enhancement Proposals; PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/}) sea consciente de un entorno virtual activo. Cuando se usa el intérprete predeterminado y se establece la variable de entorno @code{VIRTUAL_ENV} está configurado, se utilizará el intérprete en el entorno virtual.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 486

@item PEP 486@footnote{https://peps.python.org/pep-0486/} – Hacer que el launcher de Python sea consciente de los entornos virtuales

PEP escrito e implementado por Paul Moore.
@end table


@node PEP 488 Eliminación de archivos PYO,PEP 489 Inicialización del módulo de extensión multifase,PEP 486 Hacer que el launcher de Python sea consciente de los entornos virtuales,Nuevas características<11>
@anchor{whatsnew/3 5 pep-488-elimination-of-pyo-files}@anchor{e3a}@anchor{whatsnew/3 5 whatsnew-pep-488}@anchor{df2}
@subsubsection PEP 488: Eliminación de archivos PYO


@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} elimina el concepto de archivos @code{.pyo}. Esto significa que los archivos @code{.pyc} representan tanto bytecode optimizado y sin optimizar. Para evitar la necesidad de regenerar constantemente archivos bytecode, ahora los archivos @code{.pyc} tienen una etiqueta opcional @code{opt-} en su nombre cuando se optimiza el bytecode. Esto tiene el efecto secundario de que no habrá más conflictos de nombres de archivos de bytecode cuando se ejecuta bajo @ref{14f,,-O} o @ref{e3b,,-OO}. Por consiguiente, ahora los archivos bytecode generados a partir de @ref{14f,,-O} y @ref{e3b,,-OO} pueden existir simultáneamente. @ref{1f6,,importlib.util.cache_from_source()} tiene una API actualizada para ayudar con este cambio.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/} – Eliminación de archivos PYO

PEP escrito e implementado por Brett Cannon.
@end table


@node PEP 489 Inicialización del módulo de extensión multifase,,PEP 488 Eliminación de archivos PYO,Nuevas características<11>
@anchor{whatsnew/3 5 pep-489-multi-phase-extension-module-initialization}@anchor{e3c}@anchor{whatsnew/3 5 whatsnew-pep-489}@anchor{df3}
@subsubsection PEP 489: Inicialización del módulo de extensión multifase


@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} actualiza la inicialización del módulo de extensión para aprovechar el mecanismo de carga del módulo de dos pasos introducido por 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} en Python 3.4.

Este cambio acerca la semántica de importación de los módulos de extensión que optan por usar el mecanismo nuevo a la de los módulos fuente y de bytecode de Python, incluida la capacidad de utilizar cualquier identificador válido como un nombre de módulo, en lugar de estar restringido a ASCII.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/} – Inicialización del módulo de extensión multifase

PEP escrito por Petr Viktorin, Stefan Behnel y Nick Coghlan; implementado por Petr Viktorin.
@end table


@node Otros cambios en el lenguaje<3>,Nuevos módulos<7>,Nuevas características<11>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 other-language-changes}@anchor{e3d}
@subsection Otros cambios en el lenguaje


Algunos cambios más pequeños que se hicieron en el lenguaje central de Python son:


@itemize *

@item 
Se agregaron los gestores de error @code{"namereplace"}. Ahora los gestores de error @code{"backslashreplace"} funcionan con decodificación y traducción. (Contribución de Serhiy Storchaka en bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676} y bpo-22286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22286}.)

@item 
Ahora la opción @ref{683,,-b} afecta comparaciones de @ref{325,,bytes} con @ref{1f0,,int}. (Contribución de Serhiy Storchaka en bpo-23681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23681}.)

@item 
Nuevos @ref{e3e,,códecs} Kazakh @code{kz1048} y Tajik @code{koi8_t}. (Contribución de Serhiy Storchaka en bpo-22682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22682} y bpo-22681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22681}.)

@item 
Ahora las docstrings de propiedad se pueden escribir. Esto es especialmente útil para las docstrings @ref{32d,,collections.namedtuple()}. (Contribución de Berker Peksag en bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}.)

@item 
Ahora se admiten las importaciones circulares que involucran importaciones relativas. (Contribución de Brett Cannon y Antoine Pitrou en bpo-17636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17636}.)
@end itemize

@node Nuevos módulos<7>,Módulos mejorados<8>,Otros cambios en el lenguaje<3>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 new-modules}@anchor{e3f}
@subsection Nuevos módulos


@menu
* typing: typing<6>. 
* zipapp: zipapp<2>. 

@end menu

@node typing<6>,zipapp<2>,,Nuevos módulos<7>
@anchor{whatsnew/3 5 typing}@anchor{e40}
@subsubsection typing


El módulo nuevo @ref{b8e,,provisional} @ref{104,,typing} proporciona definiciones y herramientas estándar para anotaciones de tipos de funciones. Consultar @ref{deb,,Indicador de tipos} para más información.

@node zipapp<2>,,typing<6>,Nuevos módulos<7>
@anchor{whatsnew/3 5 whatsnew-zipapp}@anchor{dec}@anchor{whatsnew/3 5 zipapp}@anchor{e41}
@subsubsection zipapp


El módulo nuevo @ref{12f,,zipapp} (especificado en 
@geindex Python Enhancement Proposals; PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/}) proporciona una API y una herramienta de línea de comandos para crear aplicaciones Python Zip ejecutables, las cuales se introdujeron en la versión de Python 2.6 en bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}, pero no se publicitaron bien, ni en ese momento ni desde entonces.

Con el módulo nuevo, empaquetar tu aplicación es tan simple como colocar todos los archivos, incluido un archivo @code{__main__.py} en un directorio @code{myapp} y ejecutar:

@example
$ python -m zipapp myapp
$ python myapp.pyz
@end example

La implementación del módulo ha sido contribución de Paul Moore en bpo-23491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23491}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/} – Mejora de soporte de la aplicación Python ZIP


@node Módulos mejorados<8>,Otros cambios a nivel de módulo,Nuevos módulos<7>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 improved-modules}@anchor{e42}
@subsection Módulos mejorados


@menu
* argparse: argparse<5>. 
* asyncio: asyncio<10>. 
* bz2:: 
* cgi:: 
* cmath: cmath<2>. 
* code:: 
* collections: collections<4>. 
* collections.abc: collections abc<2>. 
* compileall: compileall<3>. 
* concurrent.futures: concurrent futures<4>. 
* configparser: configparser<4>. 
* contextlib: contextlib<5>. 
* csv: csv<3>. 
* curses: curses<2>. 
* dbm: dbm<5>. 
* difflib:: 
* distutils: distutils<7>. 
* doctest: doctest<3>. 
* email: email<3>. 
* enum: enum<5>. 
* faulthandler:: 
* functools: functools<4>. 
* glob: glob<3>. 
* gzip: gzip<4>. 
* heapq:: 
* http: http<3>. 
* http.client: http client<3>. 
* idlelib e IDLE:: 
* imaplib: imaplib<2>. 
* imghdr:: 
* importlib: importlib<9>. 
* inspect: inspect<4>. 
* io: io<6>. 
* ipaddress: ipaddress<3>. 
* json: json<3>. 
* linecache:: 
* locale: locale<5>. 
* logging: logging<3>. 
* lzma:: 
* math: math<5>. 
* multiprocessing: multiprocessing<5>. 
* operator: operator<2>. 
* os: os<10>. 
* pathlib: pathlib<8>. 
* pickle: pickle<3>. 
* poplib: poplib<2>. 
* re: re<7>. 
* readline: readline<2>. 
* selectors:: 
* shutil: shutil<4>. 
* signal: signal<2>. 
* smtpd: smtpd<2>. 
* smtplib: smtplib<2>. 
* sndhdr:: 
* socket: socket<4>. 
* ssl: ssl<9>. 
* sqlite3: sqlite3<9>. 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* sysconfig:: 
* tarfile: tarfile<6>. 
* threading: threading<4>. 
* time: time<4>. 
* timeit:: 
* tkinter: tkinter<8>. 
* traceback: traceback<2>. 
* types: types<4>. 
* unicodedata: unicodedata<9>. 
* unittest: unittest<7>. 
* unittest.mock: unittest mock<3>. 
* urllib: urllib<3>. 
* wsgiref:: 
* xmlrpc: xmlrpc<2>. 
* xml.sax: xml sax. 
* zipfile: zipfile<2>. 

@end menu

@node argparse<5>,asyncio<10>,,Módulos mejorados<8>
@anchor{whatsnew/3 5 argparse}@anchor{e43}
@subsubsection argparse


Ahora la clase @ref{15c,,ArgumentParser} permite deshabilitar el @ref{e44,,uso abreviado} de opciones largas al establecer @ref{e45,,allow_abbrev} en @code{False}. (Contribución de Jonathan Paugh, Steven Bethard, paul j3 y Daniel Eriksson en bpo-14910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14910}.)

@node asyncio<10>,bz2,argparse<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 asyncio}@anchor{e46}
@subsubsection asyncio


Ya que el módulo @ref{b,,asyncio} es @ref{b8e,,provisional}, todos los cambios que se introdujeron en Python 3.5 también se han actualizado en Python 3.4.x.

Cambios notables en el módulo @ref{b,,asyncio} desde Python 3.4.0:


@itemize *

@item 
Nuevas API de depuración: métodos @ref{e47,,loop.set_debug()} y @ref{e48,,loop.get_debug()}. (Contribución de Victor Stinner.)

@item 
Ahora el ciclo de eventos proactor es compatible con SSL. (Contribución de Antoine Pitrou y Victor Stinner en bpo-22560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22560}.)

@item 
Un nuevo método @ref{e49,,loop.is_closed()} para comprobar si el ciclo de eventos está cerrado. (Contribución de Victor Stinner en bpo-21326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21326}.)

@item 
Un nuevo método @ref{a6e,,loop.create_task()} para crear y programar convenientemente una nueva clase @ref{580,,Task} para una corrutina. El método @code{create_task} también se usa para todas las funciones asyncio que contengan corrutinas en tareas, tales como @ref{528,,asyncio.wait()}, @ref{69e,,asyncio.gather()}, etc. (Contribución de Victor Stinner.)

@item 
Un nuevo método @ref{e4a,,transport.get_write_buffer_limits()} para consultar los límites `high-' (superior) y `low-' (inferior) del control de flujo. (Contribución de Victor Stinner.)

@item 
La función @code{async()} está obsoleta en favor de la función @ref{cfe,,ensure_future()}. (Contribución de Yury Selivanov.)

@item 
Nuevos métodos @ref{e4b,,loop.set_task_factory()} y @ref{e4c,,loop.get_task_factory()} para personalizar la fábrica de tareas que el método @ref{a6e,,loop.create_task()} usa. (Contribución de Yury Selivanov.)

@item 
Nuevos métodos de cola @ref{e4d,,Queue.join()} y @ref{e4e,,Queue.task_done()}. (Contribución de Victor Stinner.)

@item 
Se eliminó la clase @code{JoinableQueue}, en favor de la clase @ref{b05,,asyncio.Queue}. (Contribución de Victor Stinner.)
@end itemize

Actualizaciones en 3.5.1:


@itemize *

@item 
La función @ref{cfe,,ensure_future()} y todas las funciones que la utilizan, como el método @ref{cff,,loop.run_until_complete()}, ahora acepta todo tipo de @ref{314,,objetos aguardables}. (Contribución de Yury Selivanov.)

@item 
Nueva función @ref{91a,,run_coroutine_threadsafe()} para enviar corrutinas a bucles de eventos de otros hilos. (Contribución de Vincent Michel.)

@item 
Nuevo método @ref{d00,,Transport.is_closing()} para comprobar si el transporte se está cerrando o ya está cerrado. (Contribución de Yury Selivanov.)

@item 
Ahora el método @ref{b9e,,loop.create_server()} puede aceptar una lista de hosts. (Contribución de Yann Sionneau.)
@end itemize

Actualizaciones en 3.5.2:


@itemize *

@item 
Nuevo método @ref{d01,,loop.create_future()} para crear objetos Future. Esto permite implementaciones alternativas de bucles de eventos, como uvloop@footnote{https://github.com/MagicStack/uvloop}, para proporcionar una implementación más rápida de @ref{c55,,asyncio.Future}. (Contribución de Yury Selivanov.)

@item 
Nuevo método @ref{d02,,loop.get_exception_handler()} para obtener el gestor de excepciones actual. (Contribución de Yury Selivanov.)

@item 
Nuevo método @ref{31b,,StreamReader.readuntil()} para leer datos de la secuencia hasta que aparezca una secuencia de separador de bytes. (Contribución de Mark Korenberg.)

@item 
Se optimizaron los métodos @ref{6a4,,loop.create_connection()} y @ref{b9e,,loop.create_server()} para evitar llamar al sistema la función @code{getaddrinfo} si la dirección ya está resuelta. (Contribución de A. Jesse Jiryu Davis.)

@item 
El método @ref{e4f,,loop.sock_connect(sock@comma{} address)} ya no requiere `address' para que se resuelva antes de la llamada. (Contribución de A. Jesse Jiryu Davis.)
@end itemize

@node bz2,cgi,asyncio<10>,Módulos mejorados<8>
@anchor{whatsnew/3 5 bz2}@anchor{e50}
@subsubsection bz2


Ahora el método @ref{e51,,BZ2Decompressor.decompress} acepta un argumento opcional `max_length' para limitar el tamaño máximo de datos descomprimidos. (Contribución de Nikolaus Rath en bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}.)

@node cgi,cmath<2>,bz2,Módulos mejorados<8>
@anchor{whatsnew/3 5 cgi}@anchor{e52}
@subsubsection cgi


The @code{FieldStorage} class now supports the @ref{675,,context manager}
protocol.  (Contributed by Berker Peksag in bpo-20289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20289}.)

@node cmath<2>,code,cgi,Módulos mejorados<8>
@anchor{whatsnew/3 5 cmath}@anchor{e53}
@subsubsection cmath


Una nueva función @ref{e37,,isclose()} proporciona una forma de probar la igualdad aproximada. (Contribución de Chris Barker y Tal Einat en bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}.)

@node code,collections<4>,cmath<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 code}@anchor{e54}
@subsubsection code


Ahora el método @ref{e55,,InteractiveInterpreter.showtraceback()} imprime el rastreo encadenado completo, al igual que el interprete interactivo. (Contribución de Claudiu Popa en bpo-17442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17442}.)

@node collections<4>,collections abc<2>,code,Módulos mejorados<8>
@anchor{whatsnew/3 5 collections}@anchor{e56}
@subsubsection collections

@anchor{whatsnew/3 5 whatsnew-ordereddict}@anchor{df4}
Ahora la clase @ref{67c,,OrderedDict} está implementada en C, lo que la hace de 4 a 100 veces más rápida. (Contribución de Eric Snow en bpo-16991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16991}.)

@code{OrderedDict.items()}, @code{OrderedDict.keys()}, @code{OrderedDict.values()} ahora soportan la iteración @ref{8fc,,reversed()}. (Contribución de Serhiy Storchaka en bpo-19505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19505}.)

Ahora la clase @ref{67d,,deque} define @ref{e57,,index()}, @ref{e58,,insert()} y @ref{e59,,copy()}, y soporta los operadores @code{+} y @code{*}. Esto permite que las deques sean reconocidas como @ref{309,,MutableSequence} y mejora su sustituibilidad por listas. (Contribución de Raymond Hettinger en bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}.)

Ahora las docstrings producidas por @ref{32d,,namedtuple()} se pueden actualizar:

@example
Point = namedtuple('Point', ['x', 'y'])
Point.__doc__ += ': Cartesian coordinate'
Point.x.__doc__ = 'abscissa'
Point.y.__doc__ = 'ordinate'
@end example

(Contribución de Berker Peksag en bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}.)

Ahora la clase @ref{e5a,,UserString} implementa los métodos @code{__getnewargs__()}, @code{__rmod__()}, @ref{e5b,,casefold()}, @ref{e5c,,format_map()}, @ref{e5d,,isprintable()} y @ref{e5e,,maketrans()} para que coincidan con los métodos correspondientes de @ref{237,,str}. (Contribución de Joe Jevnik en bpo-22189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22189}.)

@node collections abc<2>,compileall<3>,collections<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 collections-abc}@anchor{e5f}
@subsubsection collections.abc


Ahora el método @code{Sequence.index()} acepta los argumentos `start' y `stop' para que coincidan con los métodos correspondientes de @ref{464,,tuple}, @ref{18e,,list}, etc. (Contribución de Devin Jeanpierre en bpo-23086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23086}.)

Una nueva clase de base abstracta @ref{e60,,Generator}. (Contribución de Stefan Behnel en bpo-24018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24018}.)

Nuevas clases de base abstracta @ref{e61,,Awaitable}, @ref{e62,,Coroutine}, @ref{e63,,AsyncIterator} y @ref{e64,,AsyncIterable}. (Contribución de Yury Selivanov en bpo-24184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24184}.)

For earlier Python versions, a backport of the new ABCs is available in an
external PyPI package@footnote{https://pypi.org/project/backports_abc/}.

@node compileall<3>,concurrent futures<4>,collections abc<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 compileall}@anchor{e65}
@subsubsection compileall


Una nueva opción @ref{21,,compileall}, @code{-j @var{N}}, permite ejecutar `N' workers simultáneamente para realizar la compilación de bytecode en paralelo. La función @ref{baf,,compile_dir()} tiene un parámetro @code{workers} correspondiente. (Contribución de Claudiu Popa en bpo-16104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16104}.)

Otra nueva opción, @code{-r}, permite controlar el nivel máximo de recursividad de los subdirectorios. (Contribución de Claudiu Popa en bpo-19628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19628}.)

Ahora la opción de línea de comando @code{-q} se puede especificar más de una vez, en cuyo caso todas las salidas, incluyendo errores, se suprimirán. Ahora el parámetro @code{quiet} correspondiente en @ref{baf,,compile_dir()}, @ref{e66,,compile_file()} y @ref{e67,,compile_path()} puede aceptar un valor entero que indica el nivel de supresión de salida. (Contribución de Thomas Kluyver en bpo-21338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21338}.)

@node concurrent futures<4>,configparser<4>,compileall<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 concurrent-futures}@anchor{e68}
@subsubsection concurrent.futures


Ahora el método @ref{e69,,Executor.map()} acepta un argumento `chunksize' para permitir el procesamiento por lotes de tareas para mejorar el desempeño cuando se usa @ref{163,,ProcessPoolExecutor()}. (Contribución de Dan O’Reilly en bpo-11271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11271}.)

Ahora el número de workers en el constructor @ref{7dd,,ThreadPoolExecutor} es opcional. El valor predeterminado es 5 veces el número de CPUs. (Contribución de Claudiu Popa en bpo-21527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21527}.)

@node configparser<4>,contextlib<5>,concurrent futures<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 configparser}@anchor{e6a}
@subsubsection configparser


Ahora @ref{23,,configparser} proporciona una forma de personalizar la conversión de valores al especificar un diccionario de convertidores en el constructor @ref{32b,,ConfigParser} o al definirlos como métodos en las subclases @code{ConfigParser}. Los convertidores definidos en una instancia de analizador se heredan por sus proxies de sección.

Ejemplo:

@example
>>> import configparser
>>> conv = @{@}
>>> conv['list'] = lambda v: [e.strip() for e in v.split() if e.strip()]
>>> cfg = configparser.ConfigParser(converters=conv)
>>> cfg.read_string("""
... [s]
... list = a b c d e f g
... """)
>>> cfg.get('s', 'list')
'a b c d e f g'
>>> cfg.getlist('s', 'list')
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> section = cfg['s']
>>> section.getlist('list')
['a', 'b', 'c', 'd', 'e', 'f', 'g']
@end example

(Contribución de Łukasz Langa en bpo-18159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18159}.)

@node contextlib<5>,csv<3>,configparser<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 contextlib}@anchor{e6b}
@subsubsection contextlib


El nuevo @ref{675,,context manager} @ref{e6c,,redirect_stderr()} (similar a @ref{e6d,,redirect_stdout()}) facilita que los scripts de utilidad manejen APIs inflexibles que escriben su salida a @ref{9cc,,sys.stderr} y no proporcionen ninguna opción para redirigirlo:

@example
>>> import contextlib, io, logging
>>> f = io.StringIO()
>>> with contextlib.redirect_stderr(f):
...     logging.warning('warning')
...
>>> f.getvalue()
'WARNING:root:warning\n'
@end example

(Contribución de Berker Peksag en bpo-22389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22389}.)

@node csv<3>,curses<2>,contextlib<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 csv}@anchor{e6e}
@subsubsection csv


Ahora el método @ref{e6f,,writerow()} admite iterables arbitrarios, no sólo secuencias. (Contribución de Serhiy Storchaka en bpo-23171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23171}.)

@node curses<2>,dbm<5>,csv<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 curses}@anchor{e70}
@subsubsection curses


The new @ref{e71,,update_lines_cols()} function updates the @code{LINES}
and @code{COLS} module variables.  This is useful for detecting
manual screen resizing.  (Contributed by Arnon Yaari in bpo-4254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4254}.)

@node dbm<5>,difflib,curses<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 dbm}@anchor{e72}
@subsubsection dbm


@ref{b21,,dumb.open} siempre crea una nueva base de datos cuando la bandera tiene el valor @code{"n"}. (Contribución de Claudiu Popa en bpo-18039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18039}.)

@node difflib,distutils<7>,dbm<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 difflib}@anchor{e73}
@subsubsection difflib


Ahora el juego de caracteres de los documentos HTML generado por @ref{e74,,HtmlDiff.make_file()} se puede personalizar usando un nuevo argumento de solo palabras clave `charset'. El juego de caracteres predeterminado del documento HTML cambió de @code{"ISO-8859-1"} a @code{"utf-8"}. (Contribución de Berker Peksag en bpo-2052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2052}.)

Ahora la función @ref{e75,,diff_bytes()} puede comparar listas de bytes de cadenas de caracteres. Esto arregla una regresión de Python 2. (Contribución de Terry J. Reedy y Greg Ward en bpo-17445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17445}.)

@node distutils<7>,doctest<3>,difflib,Módulos mejorados<8>
@anchor{whatsnew/3 5 distutils}@anchor{e76}
@subsubsection distutils


Ahora los comandos @code{build} y @code{build_ext} aceptan una opción @code{-j} para habilitar la construcción paralela de módulos de extensión. (Contribución de Antoine Pitrou en bpo-5309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5309}.)

The @code{distutils} module now supports @code{xz} compression, and can be
enabled by passing @code{xztar} as an argument to @code{bdist --format}.
(Contributed by Serhiy Storchaka in bpo-16314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16314}.)

@node doctest<3>,email<3>,distutils<7>,Módulos mejorados<8>
@anchor{whatsnew/3 5 doctest}@anchor{e77}
@subsubsection doctest


La función @ref{e78,,DocTestSuite()} retorna una clase @ref{e79,,unittest.TestSuite} vacía si `module' no contiene docstrings, en lugar de lanzar @ref{360,,ValueError}. (Contribución de Glenn Jones en bpo-15916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15916}.)

@node email<3>,enum<5>,doctest<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 email}@anchor{e7a}
@subsubsection email


Una nueva opción de directiva @ref{e7b,,Policy.mangle_from_} controla si las líneas que empiecen o no con @code{"From "} en los cuerpos del correo electrónico tienen el prefijo de un caracter @code{">"} por generadores. El valor predeterminado es @code{True} para @ref{d22,,compat32} y @code{False} para todas las demás directivas. (Contribución de Milan Oberkirch en bpo-20098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20098}.)

Un nuevo método @ref{e7c,,Message.get_content_disposition()} proporciona fácil acceso a un valor canónico para el encabezado @code{Content-Disposition}. (Contribución de Abhilash Raj en bpo-21083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21083}.)

Una nueva opción de directiva @ref{e7d,,EmailPolicy.utf8} se puede configurar en @code{True} para codificar los encabezados de correo electrónico usando el juego de caracteres UTF-8 en lugar de utilizar palabras codificadas. Esto permite formatear @code{Messages} de acuerdo a 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} y usarlos con un servidor SMTP que admita la extensión 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} @code{SMTPUTF8}. (Contribución de R. David Murray en bpo-24211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24211}.)

Ahora el constructor @ref{e7e,,mime.text.MIMEText} admite una instancia de @ref{e7f,,charset.Charset}. (Contribución de Claude Paroz y Berker Peksag en bpo-16324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16324}.)

@node enum<5>,faulthandler,email<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 enum}@anchor{e80}
@subsubsection enum


La clase invocable @ref{6d1,,Enum} tiene un nuevo parámetro `start' para especificar el número inicial de los valores de enumeración si solo se proporcionan `names':

@example
>>> Animal = enum.Enum('Animal', 'cat dog', start=10)
>>> Animal.cat
<Animal.cat: 10>
>>> Animal.dog
<Animal.dog: 11>
@end example

(Contribución de Ethan Furman en bpo-21706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21706}.)

@node faulthandler,functools<4>,enum<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 faulthandler}@anchor{e81}
@subsubsection faulthandler


Ahora las funciones @ref{d27,,enable()}, @ref{e82,,register()}, @ref{e83,,dump_traceback()} y @ref{e84,,dump_traceback_later()} aceptan descriptores de archivo además de objetos similares a archivos. (Contribución de Wei Wu en bpo-23566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23566}.)

@node functools<4>,glob<3>,faulthandler,Módulos mejorados<8>
@anchor{whatsnew/3 5 functools}@anchor{e85}
@subsubsection functools

@anchor{whatsnew/3 5 whatsnew-lrucache}@anchor{df7}
Ahora la mayoría de la maquinaria de @ref{a81,,lru_cache()} se implementa en C, lo que la hace significativamente más rápida. (Contribución de Matt Joiner, Alexey Kachayev y Serhiy Storchaka en bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}.)

@node glob<3>,gzip<4>,functools<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 glob}@anchor{e86}
@subsubsection glob


Ahora las funciones @ref{89e,,iglob()} y @ref{3ef,,glob()} admiten búsquedas recursivas en subdirectorios usando el patrón @code{"**"}. (Contribución de Serhiy Storchaka en bpo-13968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13968}.)

@node gzip<4>,heapq,glob<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 gzip}@anchor{e87}
@subsubsection gzip


Ahora el argumento `mode' del constructor de @ref{4d8,,GzipFile} acepta @code{"x"} para solicitar la creación exclusiva. (Contribución de Tim Heaney en bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222}.)

@node heapq,http<3>,gzip<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 heapq}@anchor{e88}
@subsubsection heapq


Ahora la comparación de elementos en @ref{e89,,merge()} se puede personalizar pasando una @ref{e8a,,key function} en un nuevo argumento de palabra clave opcional `key', y un nuevo argumento de palabra clave opcional `reverse' se puede usar para revertir la comparación de elementos:

@example
>>> import heapq
>>> a = ['9', '777', '55555']
>>> b = ['88', '6666']
>>> list(heapq.merge(a, b, key=len))
['9', '88', '777', '6666', '55555']
>>> list(heapq.merge(reversed(a), reversed(b), key=len, reverse=True))
['55555', '6666', '777', '88', '9']
@end example

(Contribución de Raymond Hettinger en bpo-13742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13742}.)

@node http<3>,http client<3>,heapq,Módulos mejorados<8>
@anchor{whatsnew/3 5 http}@anchor{e8b}
@subsubsection http


Una nueva enumeración @ref{996,,HTTPStatus} que define un conjunto de códigos de estado HTTP, frases de motivo y descripciones largas escritas en inglés. (Contribución de Demian Brecht en bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}.)

@node http client<3>,idlelib e IDLE,http<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 http-client}@anchor{e8c}
@subsubsection http.client


Ahora @ref{e8d,,HTTPConnection.getresponse()} lanza una excepción @ref{e8e,,RemoteDisconnected} cuando una conexión de servidor remoto se cierra inesperadamente. Además, si se lanza una excepción @ref{e8f,,ConnectionError} (del cual @code{RemoteDisconnected} es una subclase), ahora el socket del cliente se cierra automáticamente y se reconectará en la siguiente solicitud:

@example
import http.client
conn = http.client.HTTPConnection('www.python.org')
for retries in range(3):
    try:
        conn.request('GET', '/')
        resp = conn.getresponse()
    except http.client.RemoteDisconnected:
        pass
@end example

(Contribución de Martin Panter en bpo-3566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3566}.)

@node idlelib e IDLE,imaplib<2>,http client<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 idlelib-and-idle}@anchor{e90}
@subsubsection idlelib e IDLE


Desde que idlelib implementa el shell y el editor IDLE y no se destina para ser importado por otros programas, obtiene mejoras con cada versión. Consultar @code{Lib/idlelib/NEWS.txt} para una lista acumulativa de cambios desde la 3.4.0, así como los cambios realizados en futuras versiones 3.5.x. Este archivo también está disponible en IDLE Help ‣ About IDLE.

@node imaplib<2>,imghdr,idlelib e IDLE,Módulos mejorados<8>
@anchor{whatsnew/3 5 imaplib}@anchor{e91}
@subsubsection imaplib


Ahora la clase @ref{999,,IMAP4} admite el protocolo @ref{675,,context manager}. Cuando se utiliza en una declaración @ref{673,,with}, el comando IMAP4 @code{LOGOUT} se llamará automáticamente al final del bloque. (Contribución de Tarek Ziadé y Serhiy Storchaka en bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972}.)

Ahora el módulo @ref{74,,imaplib} admite 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html} (extensión ENABLE) y 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} (soporte UTF-8) a través del método @ref{e92,,IMAP4.enable()}. Un nuevo atributo @ref{e93,,IMAP4.utf8_enabled} rastrea si el soporte con 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} está habilitado o no. (Contribución de Milan Oberkirch, R. David Murray y Maciej Szulik en bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}.)

Ahora el módulo @ref{74,,imaplib} codifica automáticamente nombres de usuario y contraseñas de cadenas de caracteres no ASCII usando UTF-8, como recomiendan las RFCs. (Contribución de Milan Oberkirch en bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}.)

@node imghdr,importlib<9>,imaplib<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 imghdr}@anchor{e94}
@subsubsection imghdr


The @code{what()} function now recognizes the
OpenEXR@footnote{https://www.openexr.com} format
(contributed by Martin Vignali and Claudiu Popa in bpo-20295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20295}),
and the WebP@footnote{https://en.wikipedia.org/wiki/WebP} format
(contributed by Fabrice Aneche and Claudiu Popa in bpo-20197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20197}.)

@node importlib<9>,inspect<4>,imghdr,Módulos mejorados<8>
@anchor{whatsnew/3 5 importlib}@anchor{e95}
@subsubsection importlib


La clase @ref{d36,,util.LazyLoader} permite la carga lenta de módulos en aplicaciones donde el tiempo de inicio es importante. (Contribución de Brett Cannon en bpo-17621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17621}.)

Ahora el método es @ref{e96,,abc.InspectLoader.source_to_code()} es un método estático. Esto hace más fácil la inicialización de un objeto de módulo con código compilado a partir de una cadena de caracteres ejecutando @code{exec(code, module.__dict__)}. (Contribución de Brett Cannon en bpo-21156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21156}.)

Ahora la nueva función @ref{e97,,util.module_from_spec()} es la forma preferida para crear un nuevo módulo. A diferencia de crear directamente una instancia @ref{e98,,types.ModuleType}, esta nueva función configurará varios atributos controlados por importación basados en el objeto de especificación pasado. (Contribución de Brett Cannon en bpo-20383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20383}.)

@node inspect<4>,io<6>,importlib<9>,Módulos mejorados<8>
@anchor{whatsnew/3 5 inspect}@anchor{e99}
@subsubsection inspect


Ahora las clases @ref{332,,Signature} y @ref{333,,Parameter} se pueden seleccionar y manipular. (Contribución de Yury Selivanov en bpo-20726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20726} y bpo-20334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20334}.)

Un nuevo método @ref{e9a,,BoundArguments.apply_defaults()} proporciona una forma de establecer valores predeterminados para los argumentos faltantes:

@example
>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])
@end example

(Contribución de Yury Selivanov en bpo-24190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24190}.)

Un nuevo método de clase @ref{7d5,,Signature.from_callable()} facilita la subclasificación de @ref{332,,Signature}. (Contribución de Yury Selivanov y Eric Snow en bpo-17373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17373}.)

Ahora la función @ref{181,,signature()} acepta un argumento de palabra clave opcional `follow_wrapped', el cual, cuando se establece en @code{False}, deshabilita el seguimiento automático de enlaces @code{__wrapped__}. (Contribución de Yury Selivanov en bpo-20691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20691}.)

Se ha agregado un conjunto de nuevas funciones para inspeccionar @ref{dfc,,funciones corrutina} y @ref{53a,,objetos corrutina}: @ref{e9b,,iscoroutine()}, @ref{1c3,,iscoroutinefunction()}, @ref{e9c,,isawaitable()}, @ref{e9d,,getcoroutinelocals()} y @ref{e9e,,getcoroutinestate()}. (Contribución de Yury Selivanov en bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017} y bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}.)

Ahora las funciones @ref{6f3,,stack()}, @ref{6f4,,trace()}, @ref{6f1,,getouterframes()} y @ref{6f2,,getinnerframes()} retornan una lista de tuplas con nombre. (Contribución de Daniel Shahaf en bpo-16808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16808}.)

@node io<6>,ipaddress<3>,inspect<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 io}@anchor{e9f}
@subsubsection io


Un nuevo método @ref{ea0,,BufferedIOBase.readinto1()}, que usa como mucho una llamada al flujo sin procesar subyacente de los métodos @ref{ea1,,RawIOBase.read()} o @ref{ea2,,RawIOBase.readinto()}. (Contribución de Nikolaus Rath en bpo-20578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20578}.)

@node ipaddress<3>,json<3>,io<6>,Módulos mejorados<8>
@anchor{whatsnew/3 5 ipaddress}@anchor{ea3}
@subsubsection ipaddress


Ahora las clases @ref{35c,,IPv4Network} y @ref{35d,,IPv6Network} aceptan un argumento de tupla @code{(address, netmask)}, para construir fácilmente objetos de red a partir de direcciones existentes:

@example
>>> import ipaddress
>>> ipaddress.IPv4Network(('127.0.0.0', 8))
IPv4Network('127.0.0.0/8')
>>> ipaddress.IPv4Network(('127.0.0.0', '255.0.0.0'))
IPv4Network('127.0.0.0/8')
@end example

(Contribución de Peter Moody y Antoine Pitrou en bpo-16531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16531}.)

Un nuevo atributo @code{reverse_pointer} para las clases @ref{35c,,IPv4Network} y @ref{35d,,IPv6Network} retorna el nombre del registro DNS PTR inverso:

@example
>>> import ipaddress
>>> addr = ipaddress.IPv4Address('127.0.0.1')
>>> addr.reverse_pointer
'1.0.0.127.in-addr.arpa'
>>> addr6 = ipaddress.IPv6Address('::1')
>>> addr6.reverse_pointer
'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa'
@end example

(Contribución de Leon Weber en bpo-20480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20480}.)

@node json<3>,linecache,ipaddress<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 json}@anchor{ea4}
@subsubsection json


Ahora la interfaz de la línea de comandos @ref{83,,json.tool} conserva el orden de los nombres en los objetos JSON pasados en la entrada. La nueva opción @code{--sort-keys} se puede usar para ordenar los nombres alfabéticamente. (Contribución de Berker Peksag en bpo-21650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21650}.)

Ahora el decodificador JSON lanza @ref{ea5,,JSONDecodeError} en lugar de @ref{360,,ValueError} para proporcionar una mejor información de contexto sobre el error. (Contribución de Serhiy Storchaka en bpo-19361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19361}.)

@node linecache,locale<5>,json<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 linecache}@anchor{ea6}
@subsubsection linecache


Una nueva función @ref{ea7,,lazycache()} se puede usar para capturar información sobre un módulo no basado en archivos para permitir obtener sus líneas más tarde a través de @ref{ea8,,getline()}. Esto evita hacer E/S hasta que una línea sea realmente necesaria, sin tener que llevar los módulos globales indefinidamente. (Contribución de Robert Collins en bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

@node locale<5>,logging<3>,linecache,Módulos mejorados<8>
@anchor{whatsnew/3 5 locale}@anchor{ea9}
@subsubsection locale


Una nueva función @ref{eaa,,delocalize()} se puede usar para convertir una cadena de caracteres en una cadena numérica normalizada, teniendo la configuración @code{LC_NUMERIC} en cuenta:

@example
>>> import locale
>>> locale.setlocale(locale.LC_NUMERIC, 'de_DE.UTF-8')
'de_DE.UTF-8'
>>> locale.delocalize('1.234,56')
'1234.56'
>>> locale.setlocale(locale.LC_NUMERIC, 'en_US.UTF-8')
'en_US.UTF-8'
>>> locale.delocalize('1,234.56')
'1234.56'
@end example

(Contribución de Cédric Krier en bpo-13918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13918}.)

@node logging<3>,lzma,locale<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 logging}@anchor{eab}
@subsubsection logging


Ahora todos los métodos del módulo logging (@ref{bd7,,Logger} @ref{eac,,log()}, @ref{ead,,exception()}, @ref{eae,,critical()}, @ref{eaf,,debug()}, etc.), aceptan instancias de excepción como un argumento `exc_info', además de valores booleanos y tuplas de excepción:

@example
>>> import logging
>>> try:
...     1/0
... except ZeroDivisionError as ex:
...     logging.error('exception', exc_info=ex)
ERROR:root:exception
@end example

(Contribución de Yury Selivanov en bpo-20537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20537}.)

Ahora la clase @ref{eb0,,handlers.HTTPHandler} acepta una instancia opcional @ref{1fa,,ssl.SSLContext} para establecer la configuración SSL usada en una conexión HTTP. (Contribución de Alex Gaynor en bpo-22788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22788}.)

Ahora la clase @ref{eb1,,handlers.QueueListener} toma un argumento de palabra clave `respect_handler_level', el cual, si se establece en @code{True}, pasará mensajes a gestores teniendo en cuenta los gestores de niveles. (Contribución de Vinay Sajip.)

@node lzma,math<5>,logging<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 lzma}@anchor{eb2}
@subsubsection lzma


Ahora el método @ref{eb3,,LZMADecompressor.decompress()} acepta un argumento opcional `max_length' para limitar el tamaño máximo de datos descomprimidos. (Contribución de Martin Panter en bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}.)

@node math<5>,multiprocessing<5>,lzma,Módulos mejorados<8>
@anchor{whatsnew/3 5 math}@anchor{eb4}
@subsubsection math


Se agregaron dos nuevas contantes en el módulo @ref{8e,,math}: @ref{d0d,,inf} y @ref{704,,nan}. (Contribución de Mark Dickinson en bpo-23185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23185}.)

Una nueva función @ref{e36,,isclose()} proporciona una forma de comprobar la igualdad aproximada. (Contribución de Chris Barker y Tal Einat en bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}.)

Se agregó una nueva función @ref{9a6,,gcd()}. Ahora la función @code{fractions.gcd()} está obsoleta. (Contribución de Mark Dickinson y Serhiy Storchaka en bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}.)

@node multiprocessing<5>,operator<2>,math<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 multiprocessing}@anchor{eb5}
@subsubsection multiprocessing


Ahora los objetos @ref{eb6,,sharedctypes.synchronized()} admiten el protocolo @ref{675,,context manager}. (Contribución de Charles-François Natali en bpo-21565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21565}.)

@node operator<2>,os<10>,multiprocessing<5>,Módulos mejorados<8>
@anchor{whatsnew/3 5 operator}@anchor{eb7}
@subsubsection operator


Ahora los objetos @ref{eb8,,attrgetter()}, @ref{af2,,itemgetter()} y @ref{eb9,,methodcaller()} admiten pickling. (Contribución de Josh Rosenberg y Serhiy Storchaka en bpo-22955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22955}.)

Las nuevas funciones @ref{eba,,matmul()} y @ref{ebb,,imatmul()} para realizar multiplicación de matrices. (Contribución de Benjamin Peterson en bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}.)

@node os<10>,pathlib<8>,operator<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 os}@anchor{ebc}
@subsubsection os


Se agregó la nueva función @ref{1a2,,scandir()} que retorna un iterador de @ref{1a1,,DirEntry}. Si es posible, @ref{1a2,,scandir()} extrae los atributos del archivo mientras escanea un directorio, eliminando la necesidad de realizar llamadas posteriores al sistema para determinar el tipo de archivo o los atributos, lo que puede mejorar significativamente el rendimiento. (Contribución de Ben Hoyt con la ayuda de Victor Stinner en bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524}.)

En Windows, ahora un nuevo atributo @ref{ebd,,stat_result.st_file_attributes} está disponible. Corresponde al miembro @code{dwFileAttributes} de la estructura @code{BY_HANDLE_FILE_INFORMATION} retornado por @code{GetFileInformationByHandle()}. (Contribución de Ben Hoyt en bpo-21719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21719}.)

Ahora la función @ref{5c6,,urandom()} usa la llamada al sistema @code{getrandom()} en Linux 3.17 o versiones más recientes, y @code{getentropy()} en OpenBSD 5.6 y versiones más recientes, eliminando la necesidad de utilizar @code{/dev/urandom} y evitando fallas debido al posible agotamiento del descriptor de archivo. (Contribución de Victor Stinner en bpo-22181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22181}.)

New @ref{ebe,,get_blocking()} and @ref{ebf,,set_blocking()} functions allow
getting and setting a file descriptor’s blocking mode (@ref{ec0,,O_NONBLOCK}.)
(Contributed by Victor Stinner in bpo-22054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22054}.)

Ahora las funciones @ref{ec1,,truncate()} y @ref{e15,,ftruncate()} se admiten en Windows. (Contribución de Steve Dower en bpo-23668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23668}.)

Hay una nueva función @ref{ec2,,os.path.commonpath()} que retorna la sub-ruta común más larga de cada nombre de ruta pasado. A diferencia de la función @ref{ec3,,os.path.commonprefix()}, siempre retorna una ruta válida:

@example
>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'
@end example

(Contribución de Rafik Draoui y Serhiy Storchaka en bpo-10395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10395}.)

@node pathlib<8>,pickle<3>,os<10>,Módulos mejorados<8>
@anchor{whatsnew/3 5 pathlib}@anchor{ec4}
@subsubsection pathlib


El nuevo método @ref{ec5,,Path.samefile()} se puede usar para verificar si la ruta apunta al mismo archivo que otra ruta, el cual puede ser otro objeto @ref{19b,,Path} o una cadena de caracteres:

@example
>>> import pathlib
>>> p1 = pathlib.Path('/etc/hosts')
>>> p2 = pathlib.Path('/etc/../etc/hosts')
>>> p1.samefile(p2)
True
@end example

(Contribución de Vajrasky Kok y Antoine Pitrou en bpo-19775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19775}.)

Ahora el método @ref{ec6,,Path.mkdir()} acepta un nuevo argumento opcional `exist_ok' para que coincida con la funcionalidad @code{mkdir -p} y @ref{37b,,os.makedirs()}. (Contribución de Berker Peksag en bpo-21539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21539}.)

Hay un nuevo método @ref{ec7,,Path.expanduser()} para expandir los prefijos @code{~} y @code{~user}. (Contribución de Serhiy Storchaka y Claudiu Popa en bpo-19776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19776}.)

Una nueva clase de método @ref{ec8,,Path.home()} se puede usar para obtener una instancia @ref{19b,,Path} que representa el directorio de inicio del usuario. (Contribución de Victor Salgado y Mayank Tripathi en bpo-19777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19777}.)

Los nuevos métodos @ref{ec9,,Path.write_text()}, @ref{eca,,Path.read_text()}, @ref{ecb,,Path.write_bytes()}, @ref{1bf,,Path.read_bytes()} para simplificar la lectura/escritura de operaciones en los archivos.

El siguiente fragmento de código creará o reescribirá el archivo existente @code{~/spam42}:

@example
>>> import pathlib
>>> p = pathlib.Path('~/spam42')
>>> p.expanduser().write_text('ham')
3
@end example

(Contribución de Christopher Welborn en bpo-20218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20218}.)

@node pickle<3>,poplib<2>,pathlib<8>,Módulos mejorados<8>
@anchor{whatsnew/3 5 pickle}@anchor{ecc}
@subsubsection pickle


Ahora los objetos anidados, como los métodos independientes o las clases anidadas, se pueden serializar con pickle usando @ref{1ad,,protocolos pickle} anteriores al protocolo de la versión 4. El protocolo de la versión 4 ya admite estos casos. (Contribución de Serhiy Storchaka en bpo-23611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23611}.)

@node poplib<2>,re<7>,pickle<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 poplib}@anchor{ecd}
@subsubsection poplib


Un nuevo comando @ref{ece,,POP3.utf8()} habilita el soporte (correo electrónico internacionalizado) 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html}, si un servidor POP lo admite. (Contribución de Milan Oberkirch en bpo-21804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21804}.)

@node re<7>,readline<2>,poplib<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 re}@anchor{ecf}
@subsubsection re


Ahora las referencias y referencias condicionales a grupos con longitud fija se permiten en afirmaciones retrospectivas:

@example
>>> import re
>>> pat = re.compile(r'(a|b).(?<=\1)c')
>>> pat.match('aac')
<_sre.SRE_Match object; span=(0, 3), match='aac'>
>>> pat.match('bbc')
<_sre.SRE_Match object; span=(0, 3), match='bbc'>
@end example

(Contribución de Serhiy Storchaka en bpo-9179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9179}.)

El número de captura de grupos en expresiones regulares ya no se limita a 100. (Contribución de Serhiy Storchaka en bpo-22437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22437}.)

Ahora las funciones @ref{3f2,,sub()} y @ref{3f3,,subn()} reemplazan grupos que no coinciden con cadenas de caracteres vacías en lugar de lanzar una excepción. (Contribución de Serhiy Storchaka en bpo-1519638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1519638}.)

Las excepciones @code{re.error} tienen nuevos atributos, @code{msg}, @code{pattern}, @code{pos}, @code{lineno} y @code{colno}, que proporcionan una mejor información de contexto sobre el error:

@example
>>> re.compile("""
...     (?x)
...     .++
... """)
Traceback (most recent call last):
   ...
sre_constants.error: multiple repeat at position 16 (line 3, column 7)
@end example

(Contribución de Serhiy Storchaka en bpo-22578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22578}.)

@node readline<2>,selectors,re<7>,Módulos mejorados<8>
@anchor{whatsnew/3 5 readline}@anchor{ed0}
@subsubsection readline


Una nueva función @ref{ed1,,append_history_file()} se puede usar para adjuntar el número especificado de los elementos finales en el historial al archivo dado. (Contribución de Bruno Cauet en bpo-22940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22940}.)

@node selectors,shutil<4>,readline<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 selectors}@anchor{ed2}
@subsubsection selectors


La nueva clase @ref{c5f,,DevpollSelector} admite sondeos eficientes @code{/dev/poll} en Solaris. (Contribución de Giampaolo Rodola” en bpo-18931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18931}.)

@node shutil<4>,signal<2>,selectors,Módulos mejorados<8>
@anchor{whatsnew/3 5 shutil}@anchor{ed3}
@subsubsection shutil


Ahora la función @ref{aed,,move()} acepta un argumento `copy_function', permitiendo, por ejemplo, que se use la función @ref{aeb,,copy()} en lugar de la predeterminada @ref{aec,,copy2()} si es necesario ignorar metadatos de archivo al moverlo. (Contribución de Claudiu Popa en bpo-19840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19840}.)

Ahora la función @ref{55a,,make_archive()} admite el formato `xztar'. (Contribución de Serhiy Storchaka en bpo-5411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5411}.)

@node signal<2>,smtpd<2>,shutil<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 signal}@anchor{ed4}
@subsubsection signal


En Windows, ahora la función @ref{bf8,,set_wakeup_fd()} también admite identificadores de socket. (Contribución de Victor Stinner en bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}.)

Varias constantes @code{SIG*} en el módulo @ref{c6,,signal} se convirtieron en @ref{56,,Enums}. Esto permite que los nombres significativos se impriman durante la depuración en lugar de «números mágicos» enteros. (Contribución de Giampaolo Rodola” en bpo-21076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21076}.)

@node smtpd<2>,smtplib<2>,signal<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 smtpd}@anchor{ed5}
@subsubsection smtpd


Both the @code{SMTPServer} and @code{SMTPChannel} classes now
accept a `decode_data' keyword argument to determine if the @code{DATA} portion of
the SMTP transaction is decoded using the @code{"utf-8"} codec or is instead
provided to the
@code{SMTPServer.process_message()}
method as a byte string.  The default is @code{True} for backward compatibility
reasons, but will change to @code{False} in Python 3.6.  If `decode_data' is set
to @code{False}, the @code{process_message} method must be prepared to accept keyword
arguments.
(Contributed by Maciej Szulik in bpo-19662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19662}.)

The @code{SMTPServer} class now advertises the @code{8BITMIME} extension
(
@geindex RFC; RFC 6152
RFC 6152@footnote{https://datatracker.ietf.org/doc/html/rfc6152.html}) if `decode_data' has been set @code{True}.  If the client
specifies @code{BODY=8BITMIME} on the @code{MAIL} command, it is passed to
@code{SMTPServer.process_message()}
via the `mail_options' keyword.
(Contributed by Milan Oberkirch and R.  David Murray in bpo-21795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21795}.)

The @code{SMTPServer} class now also supports the @code{SMTPUTF8}
extension (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}: Internationalized Email).  If the client specified
@code{SMTPUTF8 BODY=8BITMIME} on the @code{MAIL} command, they are passed to
@code{SMTPServer.process_message()}
via the `mail_options' keyword.  It is the responsibility of the
@code{process_message} method to correctly handle the @code{SMTPUTF8} data.
(Contributed by Milan Oberkirch in bpo-21725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21725}.)

It is now possible to provide, directly or via name resolution, IPv6
addresses in the @code{SMTPServer} constructor, and have it
successfully connect.  (Contributed by Milan Oberkirch in bpo-14758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14758}.)

@node smtplib<2>,sndhdr,smtpd<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 smtplib}@anchor{ed6}
@subsubsection smtplib


Un nuevo método @ref{ed7,,SMTP.auth()} proporciona una forma conveniente de implementar mecanismos de autenticación personalizados. (Contribución de Milan Oberkirch en bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}.)

Ahora el método @ref{ed8,,SMTP.set_debuglevel()} acepta un nivel de depuración adicional (2), el cual habilita las marcas de tiempo en los mensajes de depuración. (Contribución de Gavin Chappell y Maciej Szulik en bpo-16914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16914}.)

Ahora los métodos @ref{ed9,,SMTP.sendmail()} y @ref{eda,,SMTP.send_message()} admiten 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} (SMTPUTF8). (Contribución de Milan Oberkirch y R. David Murray en bpo-22027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22027}.)

@node sndhdr,socket<4>,smtplib<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 sndhdr}@anchor{edb}
@subsubsection sndhdr


The @code{what()} and @code{whathdr()} functions  now return
a @ref{32d,,namedtuple()}.  (Contributed by Claudiu Popa in
bpo-18615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18615}.)

@node socket<4>,ssl<9>,sndhdr,Módulos mejorados<8>
@anchor{whatsnew/3 5 socket}@anchor{edc}
@subsubsection socket


Ahora las funciones con tiempo de espera usan un reloj monótono en lugar de un reloj del sistema. (Contribución de Victor Stinner en bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

Un nuevo método @ref{edd,,socket.sendfile()} permite enviar un archivo a través de un socket usando la función de alto rendimiento @ref{b9a,,os.sendfile()} en UNIX, lo que hace que las cargas sean de 2 a 3 veces más rápido que cuando se usa el método simple @ref{e2d,,socket.send()}. (Contribución de Giampaolo Rodola” en bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}.)

El método @ref{e2e,,socket.sendall()} ya no reinicia el tiempo de espera del socket cada vez que se reciben o se envían bytes. Ahora el tiempo de espera del socket es la duración total máxima para enviar todos los datos. (Contribución de Victor Stinner en bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}.)

Ahora el argumento `backlog' del método @ref{ede,,socket.listen()} es opcional. De forma predeterminada, se establece en @ref{edf,,SOMAXCONN} o en @code{128}, lo que sea menor. (Contribución de Charles-François Natali en bpo-21455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21455}.)

@node ssl<9>,sqlite3<9>,socket<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 ssl}@anchor{ee0}
@subsubsection ssl


@menu
* Soporte de memoria BIO:: 
* Soporte de negociación de protocolo de capa de aplicación:: 
* Otros cambios:: 

@end menu

@node Soporte de memoria BIO,Soporte de negociación de protocolo de capa de aplicación,,ssl<9>
@anchor{whatsnew/3 5 memory-bio-support}@anchor{ee1}@anchor{whatsnew/3 5 whatsnew-sslmemorybio}@anchor{df5}
@subsubsection Soporte de memoria BIO


(Contribución de Geert Jansen en bpo-21965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21965}.)

Se ha agregado la nueva clase @ref{c09,,SSLObject} para proporcionar soporte del protocolo SSL para los casos en que las capacidades de E/S de red de @ref{981,,SSLSocket} no son necesarias o no son óptimas. @code{SSLObject} representa una instancia del protocolo SSL pero no implementa ningún método de E/S de red y, en su lugar, proporciona una interfaz de búfer de memoria. La nueva clase @ref{ee2,,MemoryBIO} se puede usar para pasar datos entre Python y una instancia del protocolo SSL.

El soporte de la memoria BIO SSL está destinado principalmente para ser usado en frameworks que implementan E/S asíncronas para las cuales el modelo de preparación («select/poll») de @ref{981,,SSLSocket} es ineficiente.

Un nuevo método @ref{c0a,,SSLContext.wrap_bio()} se puede usar para crear una nueva instancia @code{SSLObject}.

@node Soporte de negociación de protocolo de capa de aplicación,Otros cambios,Soporte de memoria BIO,ssl<9>
@anchor{whatsnew/3 5 application-layer-protocol-negotiation-support}@anchor{ee3}
@subsubsection Soporte de negociación de protocolo de capa de aplicación


(Contribución de Benjamin Peterson en bpo-20188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20188}.)

Donde está presente el soporte de OpenSSL, ahora el módulo @ref{d0,,ssl} implementa la extensión TLS `Application-Layer Protocol Negotiation' como se describe en 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}.

El nuevo método @ref{ee4,,SSLContext.set_alpn_protocols()} se puede usar para especificar qué protocolos deben anunciar un socket durante el protocolo de enlace TLS.

The new
@ref{ee5,,SSLSocket.selected_alpn_protocol()}
returns the protocol that was selected during the TLS handshake.
The @ref{ee6,,HAS_ALPN} flag indicates whether ALPN support is present.

@node Otros cambios,,Soporte de negociación de protocolo de capa de aplicación,ssl<9>
@anchor{whatsnew/3 5 other-changes}@anchor{ee7}
@subsubsection Otros cambios


Hay un nuevo método @ref{ee8,,SSLSocket.version()} para consultar la versión actual del protocolo en uso. (Contribución de Antoine Pitrou en bpo-20421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20421}.)

Ahora la clase @ref{981,,SSLSocket} implementa un método @code{SSLSocket.sendfile()}. (Contribución de Giampaolo Rodola” en bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}.)

Ahora el método @code{SSLSocket.send()} lanza la excepción @ref{ee9,,ssl.SSLWantReadError} o @ref{eea,,ssl.SSLWantWriteError} en un socket sin bloqueo si la operación se bloquearía. Anteriormente, retornaría @code{0}. (Contribución de Nikolaus Rath en bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951}.)

Ahora la función @ref{eeb,,cert_time_to_seconds()} interpreta la hora de entrada como UTC y no como hora local, por 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}. Además, el valor de retorno siempre es un @ref{1f0,,int}. (Contribución de Akira Li en bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}.)

Los nuevos métodos @code{SSLObject.shared_ciphers()} y @ref{eec,,SSLSocket.shared_ciphers()} retornan la lista de cifrados enviados por el cliente durante el protocolo de enlace. (Contribución de Benjamin Peterson en bpo-23186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23186}.)

Los métodos @ref{eed,,SSLSocket.do_handshake()}, @ref{eee,,SSLSocket.read()}, @code{SSLSocket.shutdown()} y @ref{eef,,SSLSocket.write()} de la clase @ref{981,,SSLSocket} ya no reinician el tiempo de espera del socket cada vez que se reciben o se envían bytes. Ahora el tiempo de espera del socket es la duración total máxima del método. (Contribución de Victor Stinner en bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}.)

Ahora la función @code{match_hostname()} admite la coincidencia de direcciones IP. (Contribución de Antoine Pitrou en bpo-23239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23239}.)

@node sqlite3<9>,subprocess<3>,ssl<9>,Módulos mejorados<8>
@anchor{whatsnew/3 5 sqlite3}@anchor{ef0}
@subsubsection sqlite3


Ahora la clase @ref{ef1,,Row} admite totalmente el protocolo de secuencia, en particular la iteración @ref{8fc,,reversed()} y la indexación segmentada. (Contribución de Claudiu Popa en bpo-10203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10203}; de Lucas Sinclair, Jessica McKellar, y Serhiy Storchaka en bpo-13583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13583}.)

@node subprocess<3>,sys<10>,sqlite3<9>,Módulos mejorados<8>
@anchor{whatsnew/3 5 subprocess}@anchor{ef2}@anchor{whatsnew/3 5 whatsnew-subprocess}@anchor{df8}
@subsubsection subprocess


Se agregó la nueva función @ref{c0e,,run()}. Ejecuta el comando especificado y retorna un objeto @ref{ef3,,CompletedProcess}, el cual describe un proceso terminado. La nueva API es más consistente y es el enfoque recomendado para invocar subprocesos en código Python que no necesita mantener la compatibilidad con versiones anteriores de Python. (Contribución de Thomas Kluyver en bpo-23342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23342}.)

Ejemplos:

@example
>>> subprocess.run(["ls", "-l"])  # doesn't capture output
CompletedProcess(args=['ls', '-l'], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')
@end example

@node sys<10>,sysconfig,subprocess<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 sys}@anchor{ef4}
@subsubsection sys


Una nueva función @code{set_coroutine_wrapper()} permite configurar un enlace global que será llamado siempre que un @ref{53a,,objeto corrutina} sea creado por una función @ref{672,,async def}. Una función correspondiente @code{get_coroutine_wrapper()} se puede usar para obtener un contenedor configurado actualmente. Ambas funciones son @ref{b8e,,provisionales} y se destinan solo para propósitos de depuración. (Contribución de Yury Selivanov en bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}.)

Una nueva función @ref{ef5,,is_finalizing()} se puede usar para verificar si el intérprete de Python se está @ref{2bb,,apagando}. (Contribución de Antoine Pitrou en bpo-22696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22696}.)

@node sysconfig,tarfile<6>,sys<10>,Módulos mejorados<8>
@anchor{whatsnew/3 5 sysconfig}@anchor{ef6}
@subsubsection sysconfig


Ahora el nombre del directorio de los scripts del usuario en Windows incluye los dos primeros componentes de la versión de Python. (Contribución de Paul Moore en bpo-23437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23437}.)

@node tarfile<6>,threading<4>,sysconfig,Módulos mejorados<8>
@anchor{whatsnew/3 5 tarfile}@anchor{ef7}
@subsubsection tarfile


Ahora el argumento `mode' de la función @ref{ef8,,open()} acepta @code{"x"} para solicitar una creación exclusiva. (Contribución de Berker Peksag en bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}.)

Ahora los métodos @ref{ef9,,TarFile.extractall()} y @ref{efa,,TarFile.extract()} toman un argumento de palabra clave `numeric_owner'. Si se establece como @code{True}, los archivos y directorios extraídos serán propiedad de los números @code{uid} y @code{gid} del archivo tar. Si se establece como @code{False} (el valor predeterminado y el comportamiento en versiones anteriores a la 3.5), serán propiedad del usuario y el grupo nombrados en el archivo tar. (Contribución de Michael Vogt y Eric Smith en bpo-23193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23193}.)

Ahora @ref{efb,,TarFile.list()} acepta un argumento de palabra clave opcional `members' que se puede establecer en un subconjunto de la lista retornada por @ref{efc,,TarFile.getmembers()}. (Contribución de Serhiy Storchaka en bpo-21549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21549}.)

@node threading<4>,time<4>,tarfile<6>,Módulos mejorados<8>
@anchor{whatsnew/3 5 threading}@anchor{efd}
@subsubsection threading


Ahora los métodos @ref{739,,Lock.acquire()} y @ref{efe,,RLock.acquire()} usan un reloj monótono para la administración del tiempo de espera. (Contribución de Victor Stinner en bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

@node time<4>,timeit,threading<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 time}@anchor{eff}
@subsubsection time


Ahora la función @ref{3ac,,monotonic()} siempre está disponible. (Contribución de Victor Stinner en bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

@node timeit,tkinter<8>,time<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 timeit}@anchor{f00}
@subsubsection timeit


Una nueva opción de línea de comando @code{-u} o @code{--unit=@var{U}} se puede usar para especificar la unidad de tiempo para la salida del temporizador. Las opciones que se admiten son @code{usec}, @code{msec} o @code{sec}. (Contribución de Julian Gindi en bpo-18983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18983}.)

La función @ref{f01,,timeit()} tiene un nuevo parámetro `globals' para especificar el espacio de nombres donde el código se ejecutará. (Contribución de Ben Roberts en bpo-2527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2527}.)

@node tkinter<8>,traceback<2>,timeit,Módulos mejorados<8>
@anchor{whatsnew/3 5 tkinter}@anchor{f02}
@subsubsection tkinter


The @code{tkinter._fix} module used for setting up the Tcl/Tk environment
on Windows has been replaced by a private function in the @code{_tkinter}
module which makes no permanent changes to environment variables.
(Contributed by Zachary Ware in bpo-20035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20035}.)

@node traceback<2>,types<4>,tkinter<8>,Módulos mejorados<8>
@anchor{whatsnew/3 5 traceback}@anchor{f03}@anchor{whatsnew/3 5 whatsnew-traceback}@anchor{df9}
@subsubsection traceback


New @ref{f04,,walk_stack()} and @ref{f05,,walk_tb()}
functions to conveniently traverse frame and
@ref{b7f,,traceback objects}.
(Contributed by Robert Collins in bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

Nuevas clases ligeras: @ref{3b3,,TracebackException}, @ref{f06,,StackSummary} y @ref{f07,,FrameSummary}. (Contribución de Robert Collins en bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

Ahora las funciones @ref{f08,,print_tb()} y @ref{f09,,print_stack()} admiten valores negativos para el argumento `limit'. (Contribución de Dmitry Kazakov en bpo-22619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22619}.)

@node types<4>,unicodedata<9>,traceback<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 types}@anchor{f0a}
@subsubsection types


Una nueva función @ref{f0b,,coroutine()} para transformar un @ref{c66,,iterador generador} y objetos @ref{e60,,generator-like} en @ref{314,,aguardables}. (Contribución de Yury Selivanov en bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}.)

Un nuevo tipo llamado @ref{f0c,,CoroutineType}, el cual se usa para objetos @ref{53a,,coroutine} creados por funciones @ref{672,,async def}. (Contribución de Yury Selivanov en bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}.)

@node unicodedata<9>,unittest<7>,types<4>,Módulos mejorados<8>
@anchor{whatsnew/3 5 unicodedata}@anchor{f0d}
@subsubsection unicodedata


El módulo @ref{105,,unicodedata} ahora usa datos de Unicode 8.0.0@footnote{https://unicode.org/versions/Unicode8.0.0/}.

@node unittest<7>,unittest mock<3>,unicodedata<9>,Módulos mejorados<8>
@anchor{whatsnew/3 5 unittest}@anchor{f0e}
@subsubsection unittest


Ahora el método @ref{3e3,,TestLoader.loadTestsFromModule()} acepta un solo argumento de palabra clave `pattern' que se pasa a @code{load_tests} como el tercer argumento. Ahora los paquetes encontrados se verifican en busca de @code{load_tests} independientemente de si su ruta coincide con `pattern', porque es imposible que el nombre de un paquete coincida con el modelo predeterminado. (Contribución de Robert Collins y Barry A. Warsaw en bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}.)

Ahora los errores de descubrimiento de unittest se exponen en el atributo @ref{f0f,,TestLoader.errors} de la instancia @ref{3e2,,TestLoader}. (Contribución de Robert Collins en bpo-19746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19746}.)

Una nueva opción de línea de comando @code{--locals} muestra variables locales en rastreo. (Contribución de Robert Collins en bpo-22936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22936}.)

@node unittest mock<3>,urllib<3>,unittest<7>,Módulos mejorados<8>
@anchor{whatsnew/3 5 unittest-mock}@anchor{f10}
@subsubsection unittest.mock


La clase @ref{ade,,Mock} tiene las siguientes mejoras:


@itemize *

@item 
El constructor de la clase tiene un nuevo parámetro `unsafe', que hace que los objetos simulados lancen @ref{441,,AttributeError} en los nombres de atributo que comienzan con @code{"assert"}. (Contribución de Kushal Das en bpo-21238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21238}.)

@item 
Un nuevo método @ref{f11,,Mock.assert_not_called()} para verificar si se llamó el objeto simulado. (Contribución de Kushal Das en bpo-21262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21262}.)
@end itemize

Ahora la clase @ref{f12,,MagicMock} admite los operadores @code{__truediv__()}, @code{__divmod__()} y @code{__matmul__()}. (Contribución de Johannes Baiter en bpo-20968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20968} y de Håkan Lövdahl en bpo-23581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23581} y bpo-23568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23568}.)

Ya no es necesario pasar explícitamente @code{create=True} a la función @ref{f13,,patch()} cuando se parchean los nombres incorporados. (Contribución de Kushal Das en bpo-17660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17660}.)

@node urllib<3>,wsgiref,unittest mock<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 urllib}@anchor{f14}
@subsubsection urllib


Una nueva clase @ref{f15,,request.HTTPPasswordMgrWithPriorAuth} permite que se administren las credenciales de autenticación básica HTTP para eliminar el manejo innecesario de respuestas @code{401} o enviar credenciales incondicionalmente en la primera solicitud para comunicarse con los servidores que retornen una respuesta @code{404} en lugar de un @code{401} si el encabezado @code{Authorization} no se envía. (Contribución de Matej Cepl en bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494} y de Akshit Khurana en bpo-7159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7159}.)

Un nuevo argumento `quote_via' para la función @ref{f16,,parse.urlencode()} proporciona una forma de controlar la codificación de las partes de la consulta si es necesario. (Contribución de Samwyse y Arnon Yaari en bpo-13866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13866}.)

La función @ref{20a,,request.urlopen()} acepta un objeto @ref{1fa,,ssl.SSLContext} como un argumento `context', el cual se usará para la conexión HTTPS. (Contribución de Alex Gaynor en bpo-22366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22366}.)

Se actualizó @ref{f17,,parse.urljoin()} para usar la semántica 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} para la resolución de URL relativas, en lugar de 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} y 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html}. (Contribución de Demian Brecht y Senthil Kumaran en bpo-22118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22118}.)

@node wsgiref,xmlrpc<2>,urllib<3>,Módulos mejorados<8>
@anchor{whatsnew/3 5 wsgiref}@anchor{f18}
@subsubsection wsgiref


Ahora el argumento `headers' del constructor de la clase @ref{f19,,headers.Headers} es opcional. (Contribución de Pablo Torres Navarrete y SilentGhost en bpo-5800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5800}.)

@node xmlrpc<2>,xml sax,wsgiref,Módulos mejorados<8>
@anchor{whatsnew/3 5 xmlrpc}@anchor{f1a}
@subsubsection xmlrpc


Ahora la clase @ref{ae8,,client.ServerProxy} admite el protocolo @ref{675,,context manager}. (Contribución de Claudiu Popa en bpo-20627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20627}.)

Ahora el constructor de @ref{ae8,,client.ServerProxy} acepta una instancia opcional @ref{1fa,,ssl.SSLContext}. (Contribución de Alex Gaynor en bpo-22960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22960}.)

@node xml sax,zipfile<2>,xmlrpc<2>,Módulos mejorados<8>
@anchor{whatsnew/3 5 xml-sax}@anchor{f1b}
@subsubsection xml.sax


Ahora los analizadores SAX admiten un flujo de caracteres del objeto @ref{f1c,,xmlreader.InputSource}. (Contribución de Serhiy Storchaka en bpo-2175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2175}.)

Ahora @ref{f1d,,parseString()} acepta una instancia @ref{237,,str}. (Contribución de Serhiy Storchaka en bpo-10590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10590}.)

@node zipfile<2>,,xml sax,Módulos mejorados<8>
@anchor{whatsnew/3 5 zipfile}@anchor{f1e}
@subsubsection zipfile


Ahora la salida ZIP se puede escribir en flujos inescrutables. (Contribución de Serhiy Storchaka en bpo-23252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23252}.)

Ahora el argumento `mode' del método @ref{4d9,,ZipFile.open()} acepta @code{"x"} para solicitar una creación exclusiva. (Contribución de Serhiy Storchaka en bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}.)

@node Otros cambios a nivel de módulo,Optimizaciones<8>,Módulos mejorados<8>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 other-module-level-changes}@anchor{f1f}
@subsection Otros cambios a nivel de módulo


Many functions in the @ref{90,,mmap}, @code{ossaudiodev}, @ref{cc,,socket},
@ref{d0,,ssl}, and @ref{1c,,codecs} modules now accept writable
@ref{db4,,bytes-like objects}.
(Contributed by Serhiy Storchaka in bpo-23001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23001}.)

@node Optimizaciones<8>,Cambios en la compilación y la API de C<2>,Otros cambios a nivel de módulo,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 optimizations}@anchor{f20}
@subsection Optimizaciones


La función @ref{551,,os.walk()} se aceleró de 3 a 5 veces en los sistemas POSIX y de 7 a 20 veces en Windows. Esto se hizo usando la nueva función @ref{1a2,,os.scandir()}, el cual expone la información del archivo de las llamadas al sistema @code{readdir} o @code{FindFirstFile}/@code{FindNextFile}. (Contribución de Ben Hoyt con ayuda de Victor Stinner en bpo-23605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23605}.)

La construcción de @code{bytes(int)} (llenado con cero bytes) es más rápida y usa menos memoria para objetos grandes. Se usa @code{calloc()} en lugar de @code{malloc()} para asignar memoria para estos objetos. (Contribución de Victor Stinner en bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}.)

Algunas operaciones en @ref{80,,ipaddress} @ref{35c,,IPv4Network} y @ref{35d,,IPv6Network} se aceleraron masivamente, tal como @ref{f21,,subnets()}, @ref{f22,,supernet()}, @ref{f23,,summarize_address_range()}, @ref{f24,,collapse_addresses()}. La velocidad puede variar de 3 a 15 veces. (Contribución de Antoine Pitrou, Michel Albert y Markus en bpo-21486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21486}, bpo-21487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21487}, bpo-20826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20826}, bpo-23266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23266}.)

Se optimizó pickling de objetos @ref{80,,ipaddress} para producir una salida significativamente menor. (Contribución de Serhiy Storchaka en bpo-23133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23133}.)

Ahora muchas operaciones en @ref{f25,,io.BytesIO} son de 50% a 100% más rápidas. (Contribución de Serhiy Storchaka en bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381} y de David Wilson en bpo-22003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22003}.)

Ahora la función @ref{f26,,marshal.dumps()} es más rápida: 65–85% en las versiones 3 y 4, 20–25% en las versiones 0 a 2 con datos típicos, y hasta 5 veces en el mejor de los casos. (Contribución de Serhiy Storchaka en bpo-20416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20416} y bpo-23344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23344}.)

Ahora el codificador UTF-32 es de 3 a 7 veces más rápido. (Contribución de Serhiy Storchaka en bpo-15027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15027}.)

Ahora las expresiones regulares se analizan hasta un 10% más rápido. (Contribución de Serhiy Storchaka en bpo-19380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19380}.)

Se optimizó la función @ref{dcc,,json.dumps()} para ejecutarse con @code{ensure_ascii=False} tan rápido como con @code{ensure_ascii=True}. (Contribución de Naoki Inada en bpo-23206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23206}.)

Las funciones @ref{f27,,PyObject_IsInstance()} y @ref{f28,,PyObject_IsSubclass()} se aceleraron en el caso común de que el segundo argumento tenga @ref{dcf,,type} como su metaclase. (Contribución de Georg Brandl en bpo-22540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22540}.)

Se mejoró ligeramente el almacenamiento en caché del método, lo que arrojó una mejora del rendimiento de hasta un 5% en algunos puntos de referencia. (Contribución de Antoine Pitrou en bpo-22847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22847}.)

Ahora los objetos del módulo @ref{b8,,random} usan un 50% menos de memoria en compilaciones de 64 bits. (Contribución de Serhiy Storchaka en bpo-23488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23488}.)

Las llamadas getter de @ref{2fd,,property()} son hasta un 25% más rápidas. (Contribución de Joe Jevnik en bpo-23910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23910}.)

Ahora la instanciación de @ref{177,,fractions.Fraction} es hasta un 30% más rápida. (Contribución de Stefan Behnel en bpo-22464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22464}.)

Ahora los métodos de cadena de caracteres @ref{f29,,find()}, @ref{f2a,,rfind()}, @ref{f2b,,split()}, @ref{f2c,,partition()} y el operador @ref{1ed,,in} son significativamente más rápidos para buscar subcadenas de 1 carácter. (Contribución de Serhiy Storchaka en bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}.)

@node Cambios en la compilación y la API de C<2>,Obsoleto<10>,Optimizaciones<8>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 build-and-c-api-changes}@anchor{f2d}
@subsection Cambios en la compilación y la API de C


Se agregaron las nuevas funciones @code{calloc}:


@itemize *

@item 
@ref{483,,PyMem_RawCalloc()},

@item 
@ref{f2e,,PyMem_Calloc()},

@item 
@ref{f2f,,PyObject_Calloc()}.
@end itemize

(Contribución de Victor Stinner en bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}.)

Nuevas funciones auxiliares de codificación/decodificación:


@itemize *

@item 
@ref{c4f,,Py_DecodeLocale()} (reemplazó @code{_Py_char2wchar()}),

@item 
@ref{c50,,Py_EncodeLocale()} (reemplazó @code{_Py_wchar2char()}).
@end itemize

(Contribución de Victor Stinner en bpo-18395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18395}.)

Una nueva función @ref{f30,,PyCodec_NameReplaceErrors()} para reemplazar el error de codificación unicode con @code{\N@{...@}} escapes. (Contribución de Serhiy Storchaka en bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676}.)

A new @ref{f31,,PyErr_FormatV()} function similar to @ref{f32,,PyErr_Format()},
but accepts a @code{va_list} argument.
(Contributed by Antoine Pitrou in bpo-18711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18711}.)

Una nueva excepción @code{PyExc_RecursionError}. (Contribución de Georg Brandl en bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}.)

Se introdujeron las nuevas funciones @ref{f33,,PyModule_FromDefAndSpec()}, @ref{f34,,PyModule_FromDefAndSpec2()} y @ref{f35,,PyModule_ExecDef()} por 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} – inicialización del módulo de extensión multifase. (Contribución de Petr Viktorin en bpo-24268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24268}.)

Nuevas funciones @ref{f36,,PyNumber_MatrixMultiply()} y @ref{f37,,PyNumber_InPlaceMatrixMultiply()} para realizar la multiplicación de matrices. (Contribución de Benjamin Peterson en bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}. Consultar también 
@geindex Python Enhancement Proposals; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} para más detalles.)

Ahora el espacio @ref{b31,,PyTypeObject.tp_finalize} es parte de la ABI estable.

Windows builds now require Microsoft Visual C++ 14.0, which
is available as part of Visual Studio 2015@footnote{https://visualstudio.microsoft.com/en/vs/older-downloads/#visual-studio-2015-and-other-products}.

Ahora los módulos de extensión incluyen una etiqueta de información de la plataforma en su nombre de archivo en algunas plataformas (la etiqueta es opcional y CPython importará las extensiones sin ella, aunque si la etiqueta está presente y no coincide, no se cargará la extensión):


@itemize *

@item 
En Linux, los nombres de archivo del módulo de extensión termina con @code{.cpython-<major><minor>m-<architecture>-<os>.pyd}:


@itemize *

@item 
@code{<major>} es el número principal de la versión de Python; para Python 3.5 este es @code{3}.

@item 
@code{<minor>} es el número menor de la versión de Python; para Python 3.5 este es @code{5}.

@item 
@code{<architecture>} es la arquitectura de hardware para la que se construyó el módulo de extensión. Es más común @code{i386} para plataformas Intel de 32 bits o @code{x86_64} para plataformas Intel (y AMD) de 64 bits.

@item 
@code{<os>} siempre es @code{linux-gnu}, excepto para las extensiones que se crearon para comunicarse con la ABI de 32 bits en plataformas de 64 bits, en cuyo caso es @code{linux-gnu32} (y @code{<architecture>} será @code{x86_64}).
@end itemize

@item 
En Windows, los nombres de archivo del módulo de extensión termina con @code{<debug>.cp<major><minor>-<platform>.pyd}:


@itemize *

@item 
@code{<major>} es el número principal de la versión de Python; para Python 3.5 este es @code{3}.

@item 
@code{<minor>} es el número menor de la versión de Python; para Python 3.5 este es @code{5}.

@item 
@code{<platform>} es la plataforma para la que se construyó el módulo de extensión, ya sea @code{win32} para Win32, @code{win_amd64} para Win64, @code{win_ia64} para Windows Itanium 64 y @code{win_arm} para Windows con ARM.

@item 
Si está integrado en el modo de depuración, @code{<debug>} será @code{_d}, de lo contrario estará en blanco.
@end itemize

@item 
En plataformas OS X, ahora los nombres de archivo del módulo de extensión terminan con @code{-darwin.so}.

@item 
En todas las demás plataformas, los nombres de archivo del módulo de extensión son los mismos que en Python 3.4.
@end itemize

@node Obsoleto<10>,Eliminado<5>,Cambios en la compilación y la API de C<2>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 deprecated}@anchor{f38}
@subsection Obsoleto


@menu
* Nuevas palabras clave: Nuevas palabras clave<2>. 
* Comportamiento obsoleto de Python: Comportamiento obsoleto de Python<2>. 
* Sistemas operativos no compatibles:: 
* Módulos@comma{} funciones y métodos obsoletos de Python: Módulos funciones y métodos obsoletos de Python. 

@end menu

@node Nuevas palabras clave<2>,Comportamiento obsoleto de Python<2>,,Obsoleto<10>
@anchor{whatsnew/3 5 new-keywords}@anchor{f39}
@subsubsection Nuevas palabras clave


No se recomienda usarse @code{async} y @code{await} como nombres de variable, clase, función o módulo. Se introdujo por 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} en Python 3.5, se convertirán en palabras clave adecuadas en Python 3.7.

@node Comportamiento obsoleto de Python<2>,Sistemas operativos no compatibles,Nuevas palabras clave<2>,Obsoleto<10>
@anchor{whatsnew/3 5 deprecated-python-behavior}@anchor{f3a}
@subsubsection Comportamiento obsoleto de Python


Al lanzar la excepción @ref{c82,,StopIteration} dentro de un generador ahora se lanzará un @ref{95f,,PendingDeprecationWarning} silencioso, el cual se convertirá en una advertencia de deprecación no silenciosa en Python 3.6 y activará un @ref{1e5,,RuntimeError} en Python 3.7. Consultar @ref{da6,,PEP 479; Cambiar el gestor de StopIteration dentro de generadores} para más detalles.

@node Sistemas operativos no compatibles,Módulos funciones y métodos obsoletos de Python,Comportamiento obsoleto de Python<2>,Obsoleto<10>
@anchor{whatsnew/3 5 unsupported-operating-systems}@anchor{f3b}
@subsubsection Sistemas operativos no compatibles


Windows XP ya no es compatible con Microsoft, por lo tanto, según 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, CPython 3.5 oficialmente ya no es compatible con este sistema operativo.

@node Módulos funciones y métodos obsoletos de Python,,Sistemas operativos no compatibles,Obsoleto<10>
@anchor{whatsnew/3 5 deprecated-python-modules-functions-and-methods}@anchor{f3c}
@subsubsection Módulos, funciones y métodos obsoletos de Python


Ahora el módulo @code{formatter} se ha graduado a su deprecación completa y aún está programada para su eliminación en Python 3.6.

La función @code{asyncio.async()} es obsoleta en favor de @ref{cfe,,ensure_future()}.

The @code{smtpd} module has in the past always decoded the DATA portion of
email messages using the @code{utf-8} codec.  This can now be controlled by the
new `decode_data' keyword to @code{SMTPServer}.  The default value is
@code{True}, but this default is deprecated.  Specify the `decode_data' keyword
with an appropriate value to avoid the deprecation warning.

Está obsoleto asignar valores directamente en @ref{c89,,key}, @ref{c8a,,value} y @ref{c8b,,coded_value} en los objetos de @ref{c8c,,http.cookies.Morsel}. Usar en su lugar el método @ref{c8d,,set()}. Además, el parámetro no documentado `LegalChars' de @ref{c8d,,set()} está obsoleto y ahora se ignora.

Pasar una cadena de caracteres de formato como argumento de palabra clave `format_string' al método @ref{c88,,format()} de la clase @ref{f3d,,string.Formatter} se ha quedado obsoleto. (Contribución de Serhiy Storchaka en bpo-23671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23671}.)

Ahora las funciones @code{platform.dist()} y @code{platform.linux_distribution()} están obsoletas. Las distribuciones de Linux usan demasiadas formas diferentes de describirse a sí mismas, así que la funcionalidad se deja a un paquete. (Contribución de Vajrasky Kok y Berker Peksag en bpo-1322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1322}.)

Los métodos @code{from_function} y @code{from_builtin} previamente no documentados de @ref{332,,inspect.Signature} están obsoletos. Utilizar en su lugar el nuevo método @ref{7d5,,Signature.from_callable()}. (Contribución de Yury Selivanov en bpo-24248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24248}.)

La función @code{inspect.getargspec()} está obsoleta y programada para ser eliminada en Python 3.6. (Consultar bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438} para más detalles.)

Las funciones @ref{7e,,inspect} @ref{7d4,,getfullargspec()}, @ref{f3e,,getcallargs()} y @code{formatargspec()} están obsoletas en favor de la API @ref{181,,inspect.signature()}. (Contribución de Yury Selivanov en bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438}.)

Las funciones @ref{f3f,,getargvalues()} y @ref{f40,,formatargvalues()} se marcaron inadvertidamente como obsoletas con el lanzamiento de Python 3.5.0.

Ahora el uso de la bandera @ref{bf4,,re.LOCALE} con patrones str o @ref{6cd,,re.ASCII} está obsoleto. (Contribución de Serhiy Storchaka en bpo-22407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22407}.)

El uso de secuencias especiales no reconocidas que consisten en @code{'\'} y una letra ASCII en patrones de expresión regular y patrones de reemplazo ahora lanza una advertencia de deprecación y estará prohibido en Python 3.6. (Contribución de Serhiy Storchaka en bpo-23622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23622}.)

Ahora el argumento predeterminado no documentado y no oficial `use_load_tests' del método @ref{3e3,,unittest.TestLoader.loadTestsFromModule()} está obsoleto e ignorado. (Contribución de Robert Collins y Barry A. Warsaw en bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}.)

@node Eliminado<5>,Portando a Python 3 5,Obsoleto<10>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 removed}@anchor{f41}
@subsection Eliminado


@menu
* APIs y características eliminadas: APIs y características eliminadas<2>. 

@end menu

@node APIs y características eliminadas<2>,,,Eliminado<5>
@anchor{whatsnew/3 5 api-and-feature-removals}@anchor{f42}
@subsubsection APIs y características eliminadas


Se eliminaron las siguientes APIs y características obsoletas y anteriormente obsoletas:


@itemize *

@item 
Se eliminó el atributo @code{__version__} del paquete de correo electrónico. No se envió el código de correo electrónico por separado de stdlib durante mucho tiempo, y la cadena de caracteres @code{__version__} no se actualizó en las últimas versiones.

@item 
La clase interna @code{Netrc} en el módulo @ref{5e,,ftplib} quedó obsoleta en la versión 3.4 y ahora se eliminó. (Contribución de Matt Chaput en bpo-6623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6623}.)

@item 
Se eliminó el concepto de los archivos @code{.pyo}.

@item 
La clase JoinableQueue en el módulo provisional @ref{b,,asyncio} quedó obsoleto en la versión 3.4.4 y ahora se eliminó. (Contribución de A. Jesse Jiryu Davis en bpo-23464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23464}.)
@end itemize

@node Portando a Python 3 5,Cambios notables en Python 3 5 4,Eliminado<5>,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 porting-to-python-3-5}@anchor{f43}
@subsection Portando a Python 3.5


Esta sección enumera cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en tu código.

@menu
* Cambios en el comportamiento de Python: Cambios en el comportamiento de Python<3>. 
* Cambios en la API de Python: Cambios en la API de Python<7>. 
* Cambios en la API de C: Cambios en la API de C<10>. 

@end menu

@node Cambios en el comportamiento de Python<3>,Cambios en la API de Python<7>,,Portando a Python 3 5
@anchor{whatsnew/3 5 changes-in-python-behavior}@anchor{f44}
@subsubsection Cambios en el comportamiento de Python



@itemize *

@item 
Debido a un descuido, erróneamente en anteriores versiones de Python aceptaron la siguiente sintaxis:

@example
f(1 for x in [1], *args)
f(1 for x in [1], **kwargs)
@end example

Ahora Python 3.5 lanza correctamente un @ref{150,,SyntaxError}, ya que las expresiones generadoras deben ponerse entre paréntesis si no son el único argumento de una función.
@end itemize

@node Cambios en la API de Python<7>,Cambios en la API de C<10>,Cambios en el comportamiento de Python<3>,Portando a Python 3 5
@anchor{whatsnew/3 5 changes-in-the-python-api}@anchor{f45}
@subsubsection Cambios en la API de Python



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}: Ahora se reintentan las llamadas al sistema cuando se interrumpen por una señal en lugar de lanzar @ref{e0e,,InterruptedError} si el gestor de señales de Python no lanza una excepción.

@item 
Antes de Python 3.5, se consideraba falso un objeto @ref{331,,datetime.time} si representaba la medianoche en UTC. Este comportamiento se consideraba oscuro y propenso a errores y se eliminó en Python 3.5. Consultar bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936} para más detalles.

@item 
The @code{ssl.SSLSocket.send()} method now raises either
@ref{ee9,,ssl.SSLWantReadError} or @ref{eea,,ssl.SSLWantWriteError}
on a non-blocking socket if the operation would block.  Previously,
it would return @code{0}.  (Contributed by Nikolaus Rath in bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951}.)

@item 
Ahora el atributo @code{__name__} de los generadores se establece desde el nombre de la función en lugar de establecerse desde el nombre del código. Usar @code{gen.gi_code.co_name} para recuperar el nombre del código. También los generadores tienen un nuevo atributo @code{__qualname__}, el nombre calificado, el cual se utiliza ahora para la representación de un generador (@code{repr(gen)}). (Contribución de Victor Stinner en bpo-21205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21205}.)

@item 
The deprecated «strict» mode and argument of @ref{90e,,HTMLParser},
@code{HTMLParser.error()}, and the @code{HTMLParserError} exception have been
removed.  (Contributed by Ezio Melotti in bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}.)
The `convert_charrefs' argument of @ref{90e,,HTMLParser} is
now @code{True} by default.  (Contributed by Berker Peksag in bpo-21047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21047}.)

@item 
Aunque no es parte formalmente de la API, vale la pena señalar con fines de portabilidad (es decir: pruebas de reparación) que ahora los mensajes de error que anteriormente tenían el formato «“sometype” no es compatible con el protocolo búfer» son del formato «se requiere @ref{db4,,bytes-like object}, no “sometype”». (Contribución de Ezio Melotti en bpo-16518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16518}.)

@item 
Si el directorio actual se establece en un directorio que ya no existe entonces ya no se lanzará @ref{f46,,FileNotFoundError} y en su lugar @ref{f47,,find_spec()} retornará @code{None} `sin' almacenamiento en caché @code{None} en @ref{684,,sys.path_importer_cache}, el cual es diferente al caso típico (bpo-22834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22834}).

@item 
El código de estado HTTP y los mensajes de @ref{6f,,http.client} y @ref{72,,http.server} se refactorizaron en una enumeración @ref{996,,HTTPStatus}. Los valores en @ref{6f,,http.client} y @ref{72,,http.server} permanecen disponibles para compatibilidad con versiones anteriores. (Contribución de Demian Brecht en bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}.)

@item 
Cuando un cargador de importación define @code{importlib.machinery.Loader.exec_module()}, ahora se espera que también defina @code{create_module()} (ahora lanza un @ref{1da,,DeprecationWarning}, será un error en Python 3.6). Si el cargador hereda de @ref{f48,,importlib.abc.Loader} entonces no hay nada que hacer, de lo contrario simplemente defina @code{create_module()} para retornar @code{None}. (Contribución de Brett Cannon en bpo-23014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23014}.)

@item 
La función @ref{3f1,,re.split()} siempre ignoraba las coincidencias de patrones vacías, así que el patrón @code{"x*"} funcionaba igual que @code{"x+"} y el patrón @code{"\b"} nunca funcionó. Ahora @ref{3f1,,re.split()} lanza una advertencia si el patrón puede coincidir con una cadena de caracteres vacía. Para compatibilidad, usar patrones que nunca coincidan con una cadena vacía (p. ej. @code{"x+"} en lugar de @code{"x*"}). Ahora los patrones que solo pueden coincidir con una cadena vacía (como @code{"\b"}) lanzan un error. (Contribución de Serhiy Storchaka en bpo-22818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22818}.)

@item 
La interfaz similar a diccionarios @ref{c8c,,http.cookies.Morsel} se ha hecho autoconsistente: ahora la comparación de morsel toma en cuenta @ref{c89,,key} y @ref{c8a,,value}, ahora @ref{f49,,copy()} da como resultado en una instancia @ref{c8c,,Morsel} en lugar de un @ref{190,,dict}, y ahora @ref{f4a,,update()} lanzará una excepción si alguna de las claves del diccionario de actualización no es válida. Además, el parámetro no documentado `LegalChars' de @ref{c8d,,set()} está obsoleto y ahora se ignora. (Contribución de Demian Brecht en bpo-2211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2211}.)

@item 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} eliminó los archivos @code{.pyo} de Python e introdujo la etiqueta opcional @code{opt-} en los nombres de archivo @code{.pyc}. El @ref{1f6,,importlib.util.cache_from_source()} ha obtenido un parámetro `optimization' para ayudar a controlar la etiqueta @code{opt-}. Debido a esto, el parámetro `debug_override' de la función ahora está en desuso. Los archivos @code{.pyo} ya no se admiten como argumento de archivo para el intérprete de Python y, por lo tanto, no sirven para nada cuando se distribuyen por sí solos (es decir, distribución de código sin código fuente). Debido al hecho de que el número mágico para el código de bytes ha cambiado en Python 3.5, todos los archivos @code{.pyo} antiguos de versiones anteriores de Python no son válidos independientemente de este PEP.

@item 
The @ref{cc,,socket} module now exports the @ref{f4b,,CAN_RAW_FD_FRAMES}
constant on linux 3.6 and greater.

@item 
Ahora la función @ref{eeb,,ssl.cert_time_to_seconds()} interpreta la hora de entrada como UTC y no como hora local, por 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}. Además, el valor de retorno siempre es un @ref{1f0,,int}. (Contribución de Akira Li en bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}.)

@item 
Ahora la herramienta @code{pygettext.py} usa el formato estándar +NNNN para zonas horarias en el encabezado POT-Creation-Date.

@item 
Ahora el módulo @ref{ca,,smtplib} usa @ref{9cc,,sys.stderr} en lugar de la variable anterior de nivel de módulo @code{stderr} para la salida de depuración. Si tu programa (de prueba) depende de parchear la variable de nivel de mundo para capturar la salida de depuración, necesitarás actualizarlo para capturar sys.stderr en su lugar.

@item 
Los métodos @ref{f4c,,str.startswith()} y @ref{f4d,,str.endswith()} ya no retornan @code{True} cuando encuentran la cadena de caracteres vacía y los índices están completamente fuera de rango. (Contribución de Serhiy Storchaka en bpo-24284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24284}.)

@item 
Ahora la función @ref{a8c,,inspect.getdoc()} retorna cadenas de documentación que se heredaron de clases base. Ya no es necesario duplicar las cadenas de documentación si la documentación que se heredó es apropiada. Para suprimir una cadena que se heredó, se debe especificar una cadena vacía (o se puede completar la documentación). Este cambio afecta la salida del módulo @ref{b5,,pydoc} y la función @ref{96e,,help()}. (Contribución de Serhiy Storchaka en bpo-15582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15582}.)

@item 
Ahora las llamadas anidadas @ref{17a,,functools.partial()} se aplanan. Si se confiaba en el comportamiento anterior, ahora se puede agregar un atributo a un objeto @ref{17a,,functools.partial()} o se puede crear una subclase de @ref{17a,,functools.partial()}. (Contribución de Alexander Belopolsky en bpo-7830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7830}.)
@end itemize

@node Cambios en la API de C<10>,,Cambios en la API de Python<7>,Portando a Python 3 5
@anchor{whatsnew/3 5 changes-in-the-c-api}@anchor{f4e}
@subsubsection Cambios en la API de C



@itemize *

@item 
The undocumented @code{format} member of the
(non-public) @code{PyMemoryViewObject} structure has been removed.
All extensions relying on the relevant parts in @code{memoryobject.h}
must be rebuilt.

@item 
La estructura @code{PyMemAllocator} se renombró a @ref{f4f,,PyMemAllocatorEx} y se agregó un nuevo campo @code{calloc}.

@item 
Removed non-documented macro @code{PyObject_REPR()} which leaked references.
Use format character @code{%R} in @ref{47c,,PyUnicode_FromFormat()}-like functions
to format the @ref{894,,repr()} of the object.
(Contributed by Serhiy Storchaka in bpo-22453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22453}.)

@item 
Because the lack of the @ref{468,,__module__} attribute breaks pickling and
introspection, a deprecation warning is now raised for builtin types without
the @ref{468,,__module__} attribute.  This will be an @ref{441,,AttributeError} in
the future.
(Contributed by Serhiy Storchaka in bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204}.)

@item 
As part of the 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} implementation, the @code{tp_reserved} slot of
@ref{b30,,PyTypeObject} was replaced with a
@ref{f50,,tp_as_async} slot.  Refer to @ref{f51,,Objetos corrutina} for
new types, structures and functions.
@end itemize

@node Cambios notables en Python 3 5 4,,Portando a Python 3 5,Qué hay de nuevo en Python 3 5
@anchor{whatsnew/3 5 notable-changes-in-python-3-5-4}@anchor{f52}
@subsection Cambios notables en Python 3.5.4


@menu
* Nuevo objetivo de compilación make regen-all: Nuevo objetivo de compilación make regen-all<2>. 
* Eliminación del objetivo de compilación make touch: Eliminación del objetivo de compilación make touch<2>. 

@end menu

@node Nuevo objetivo de compilación make regen-all<2>,Eliminación del objetivo de compilación make touch<2>,,Cambios notables en Python 3 5 4
@anchor{whatsnew/3 5 new-make-regen-all-build-target}@anchor{f53}
@subsubsection Nuevo objetivo de compilación @code{make regen-all}


Para simplificar la compilación cruzada y asegurar que CPython se pueda compilar de manera confiable sin requerir que una versión existente de Python ya esté disponible, el sistema de compilación basado en herramientas automáticas ya no intenta volver a compilar implícitamente los archivos generados en función de los tiempos de modificación de los archivos.

En su lugar, se agregó un nuevo comando @code{make regen-all} para forzar la regeneración de estos archivos cuando se desee (p. ej. después de que ya se haya creado una versión inicial de Python basada en las versiones pregeneradas).

También se definen objetivos de regeneración más selectivos - consultar Makefile.pre.in@footnote{https://github.com/python/cpython/tree/main/Makefile.pre.in} para más detalles.

(Contribución de Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Added in version 3.5.4.


@node Eliminación del objetivo de compilación make touch<2>,,Nuevo objetivo de compilación make regen-all<2>,Cambios notables en Python 3 5 4
@anchor{whatsnew/3 5 removal-of-make-touch-build-target}@anchor{f54}
@subsubsection Eliminación del objetivo de compilación @code{make touch}


Se eliminó el objetivo de compilación @code{make touch} que anteriormente se usaba para solicitar la regeneración implícita de los archivos generados mediante la actualización de sus tiempos de modificación.

Se reemplazó por el nuevo objetivo @code{make regen-all}.

(Contribución de Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Distinto en la versión 3.5.4.


@node Qué hay de nuevo en Python 3 4,Qué hay de nuevo en Python 3 3,Qué hay de nuevo en Python 3 5,Qué hay de nuevo en Python
@anchor{whatsnew/3 4 doc}@anchor{f55}@anchor{whatsnew/3 4 what-s-new-in-python-3-4}@anchor{f56}
@section Qué hay de nuevo en Python 3.4


@*Autor: 
R. David Murray <@email{rdmurray@@bitdance.com}> (Editor)


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document, but the maintainer reserves the
@c right to rewrite any additions. In particular, for obscure or esoteric
@c features, the maintainer may reduce any addition to a simple reference to
@c the new documentation rather than explaining the feature inline.
@c 
@c * While the maintainer will periodically go through Misc/NEWS
@c and add changes, it's best not to rely on this. We know from experience
@c that any changes that aren't in the What's New documentation around the
@c time of the original release will remain largely unknown to the community
@c for years, even if they're added later. We also know from experience that
@c other priorities can arise, and the maintainer will run out of time to do
@c updates -- in such cases, end users will be much better served by partial
@c notifications that at least give a hint about new features to
@c investigate.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS. The What's New should focus on changes that
@c are visible to Python *users* and that *require* a feature release (i.e.
@c most bug fixes should only be recorded in Misc/NEWS)
@c 
@c * PEPs should not be marked Final until they have an entry in What's New.
@c A placeholder entry that is just a section header and a link to the PEP
@c (e.g ":pep:`397` has been implemented") is acceptable. If a PEP has been
@c implemented and noted in What's New, don't forget to mark it as Final!
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to add just a very brief note about a change.  For
@c example: "The :ref:`~socket.transmogrify()` function was added to the
@c :mod:`socket` module."  The maintainer will research the change and
@c write the necessary text (if appropriate). The advantage of doing this
@c is that even if no more descriptive text is ever added, readers will at
@c least have a notification that the new feature exists and a link to the
@c relevant documentation.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c The :ref:`~socket.transmogrify()` function was added to the
@c :mod:`socket` module.  (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.
@c 
@c * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``,
@c while :ref:`~mod.attr` will display as ``attr``.

Este artículo explica las nuevas características de Python 3.4, en comparación con la 3.3. Python 3.4 se publicó el 16 de marzo de 2014.  Para obtener todos los detalles, consulte el changelog@footnote{https://docs.python.org/3.4/whatsnew/changelog.html}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 429
PEP 429@footnote{https://peps.python.org/pep-0429/} – Calendario de lanzamiento de Python 3.4


@menu
* Resumen – Puntos destacados del lanzamiento:: 
* Nuevas Funciones:: 
* Nuevos Módulos: Nuevos Módulos<2>. 
* Módulos mejorados: Módulos mejorados<9>. 
* Cambios en la implementación de CPython:: 
* Obsoleto: Obsoleto<11>. 
* Removido:: 
* Adaptación a Python 3.4: Adaptación a Python 3 4. 
* Cambiado en 3.4.3: Cambiado en 3 4 3. 

@end menu

@node Resumen – Puntos destacados del lanzamiento,Nuevas Funciones,,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 summary-release-highlights}@anchor{f57}
@subsection Resumen – Puntos destacados del lanzamiento


@c This section singles out the most important changes in Python 3.4.
@c Brevity is key.

Nuevas características de sintaxis:


@itemize *

@item 
En Python 3.4 no se han añadido nuevas características sintácticas.
@end itemize

Otras novedades:


@itemize *

@item 
@ref{f58,,pip debe estar siempre disponible} (
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}).

@item 
@ref{f59,,Los descriptores de archivo recién creados no son heredables} (
@geindex Python Enhancement Proposals; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}).

@item 
opción de línea de comandos para @ref{f5a,,modo aislado} (bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499}).

@item 
@ref{f5b,,mejoras en el manejo de códecs} que no son codificaciones de texto (múltiples problemas).improvements>

@item 
@ref{f5c,,Un tipo de ModuleSpec} para el sistema de importación (
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}).  (Afecta a los autores de los importadores)

@item 
El formato @ref{8d,,marshal} se ha hecho @ref{f5d,,más compacto y eficiente} (bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475}).
@end itemize

Nuevos módulos de la biblioteca:


@itemize *

@item 
@ref{b,,asyncio}: @ref{f5e,,Nueva API provisional para IO asíncrona} (
@geindex Python Enhancement Proposals; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}).

@item 
@ref{55,,ensurepip}: @ref{f5f,,Bootstrapping the pip installer}
(
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}).

@item 
@ref{56,,enum}: @ref{f60,,Soporte para tipos de enumeración} (
@geindex Python Enhancement Proposals; PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/}).

@item 
@ref{a4,,pathlib}: @ref{f61,,Rutas del sistema de archivos orientadas a objetos} (
@geindex Python Enhancement Proposals; PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/}).

@item 
@ref{c2,,selectors}: @ref{f62,,Multiplexación de E/S eficiente y de alto nivel}, construida sobre las primitivas del módulo @ref{c1,,select} (parte de 
@geindex Python Enhancement Proposals; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}).

@item 
@ref{d2,,statistics}: Una básica @ref{f63,,numerically stable statistics library} (
@geindex Python Enhancement Proposals; PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/}).

@item 
@ref{ff,,tracemalloc}: @ref{f64,,Trace Python memory allocations} (
@geindex Python Enhancement Proposals; PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/}).
@end itemize

Mejora significativa de los módulos de la biblioteca:


@itemize *

@item 
@ref{f65,,Funciones genéricas de despacho único} en @ref{5f,,functools} (
@geindex Python Enhancement Proposals; PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/}).

@item 
Nuevo @ref{a6,,pickle} @ref{f66,,protocolo 4} (
@geindex Python Enhancement Proposals; PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/}).

@item 
@code{multiproceso} tiene ahora @ref{f67,,una opción para evitar el uso de os.fork en Unix} (bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}).

@item 
@ref{3c,,email} tiene un nuevo submódulo, @ref{3e,,contentmanager}, y una nueva subclase @ref{3d1,,Message} (@code{EmailMessage}) que @ref{f68,,simplifica el manejo de MIME} (bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}).

@item 
Los módulos @ref{7e,,inspect} y @ref{b5,,pydoc} son ahora capaces de introspeccionar correctamente una variedad mucho más amplia de objetos invocables, lo que mejora la salida del sistema Python @ref{96e,,help()}.

@item 
La API del módulo @ref{80,,ipaddress} ha sido declarada estable
@end itemize

Mejoras en la seguridad:


@itemize *

@item 
@ref{f69,,Algoritmo hash seguro e intercambiable} (
@geindex Python Enhancement Proposals; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/}).

@item 
@ref{f59,,Hacer no heredables los descriptores de archivo recién creados} (
@geindex Python Enhancement Proposals; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}) para evitar la filtración de descriptores de archivo a los procesos hijos.

@item 
Nueva opción de línea de comandos para @ref{f5a,,modo aislado}, (bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499}).

@item 
@ref{94,,multiprocessing} tiene ahora @ref{f67,,una opción para evitar el uso de os.fork en Unix}.  `spawn' y `forkserver' son más seguros porque evitan compartir datos con los procesos hijos.

@item 
Los procesos hijos de @ref{94,,multiprocessing} en Windows ya no heredan todos los manejadores heredables del padre, sólo los necesarios.

@item 
Una nueva función @ref{5b3,,hashlib.pbkdf2_hmac()} proporciona la función de derivación de clave basada en contraseña PKCS#5 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}.

@item 
@ref{f6a,,Soporte de TLSv1.1 y TLSv1.2} para @ref{d0,,ssl}.

@item 
@ref{f6b,,Recuperación de certificados del soporte del almacén de certificados del sistema Windows} para @ref{d0,,ssl}.

@item 
@ref{f6c,,Soporte SNI (Server Name Indication) del lado del servidor} para @ref{d0,,ssl}.

@item 
La clase @ref{1fa,,ssl.SSLContext} tiene un @ref{f6d,,mucho que mejorar}.

@item 
Todos los módulos de la biblioteca estándar que soportan SSL admiten ahora la verificación de certificados de servidor, incluida la coincidencia de nombres de host (@code{ssl.match_hostname()}) y las CRL (listas de revocación de certificados, véase @ref{f6e,,ssl.SSLContext.load_verify_locations()}).
@end itemize

Mejoras en la implementación de CPython:


@itemize *

@item 
@ref{f6f,,Finalización segura de objetos} (
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}).

@item 
Aprovechando 
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}, en la mayoría de los casos @ref{f6f,,los globales de los módulos ya no se establecen como Ninguno durante la finalización} (bpo-18214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18214}).

@item 
@ref{f70,,Asignadores de memoria configurable} (
@geindex Python Enhancement Proposals; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/}).

@item 
@ref{f71,,Consultorio de argumentos} (
@geindex Python Enhancement Proposals; PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/}).
@end itemize

Por favor, siga leyendo para ver una lista completa de los cambios orientados al usuario, incluyendo muchas otras mejoras menores, optimizaciones de CPython, elementos obsoletos y posibles problemas de portabilidad.

@node Nuevas Funciones,Nuevos Módulos<2>,Resumen – Puntos destacados del lanzamiento,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 new-features}@anchor{f72}
@subsection Nuevas Funciones


@menu
* PEP 453; Arranque explícito de PIP en instalaciones de Python: PEP 453 Arranque explícito de PIP en instalaciones de Python. 
* PEP 446; Los descriptores de archivos recién creados no son heredables: PEP 446 Los descriptores de archivos recién creados no son heredables. 
* Mejoras en el manejo de códecs:: 
* PEP 451; Un tipo ModuleSpec para el sistema de importación: PEP 451 Un tipo ModuleSpec para el sistema de importación. 
* Otros cambios de lenguaje:: 

@end menu

@node PEP 453 Arranque explícito de PIP en instalaciones de Python,PEP 446 Los descriptores de archivos recién creados no son heredables,,Nuevas Funciones
@anchor{whatsnew/3 4 pep-453-explicit-bootstrapping-of-pip-in-python-installations}@anchor{f73}@anchor{whatsnew/3 4 whatsnew-pep-453}@anchor{f58}
@subsubsection PEP 453: Arranque explícito de PIP en instalaciones de Python


@menu
* Puesta en marcha de pip por defecto:: 
* Cambios en la documentación:: 

@end menu

@node Puesta en marcha de pip por defecto,Cambios en la documentación,,PEP 453 Arranque explícito de PIP en instalaciones de Python
@anchor{whatsnew/3 4 bootstrapping-pip-by-default}@anchor{f74}
@subsubsection Puesta en marcha de pip por defecto


El nuevo módulo @ref{55,,ensurepip} (definido en 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}) proporciona un mecanismo estándar multiplataforma para arrancar el instalador pip en instalaciones de Python y entornos virtuales. La versión de @code{pip} incluida con Python 3.4.0 es @code{pip} 1.5.4, y las futuras versiones de mantenimiento de 3.4.x actualizarán la versión incluida a la última versión de @code{pip} que esté disponible en el momento de crear la versión candidata.

Por defecto, los comandos @code{pipX} y @code{pipX.Y} se instalarán en todas las plataformas (donde X.Y representa la versión de la instalación de Python), junto con el paquete de Python @code{pip} y sus dependencias. En Windows y en los entornos virtuales de todas las plataformas, también se instalará el comando @code{pip} sin versionar. En otras plataformas, el comando @code{pip} no versionado en todo el sistema suele referirse a la versión de Python 2 instalada por separado.

La utilidad de línea de comandos @code{pyvenv} y el módulo @ref{111,,venv} hacen uso del módulo @ref{55,,ensurepip} para que @code{pip} esté disponible en entornos virtuales. Cuando se utiliza la utilidad de línea de comandos, @code{pip} se instala por defecto, mientras que cuando se utiliza el módulo @ref{111,,venv} @ref{f75,,API} se debe solicitar explícitamente la instalación de @code{pip}.

Para las construcciones de CPython @ref{f76,,source en sistemas POSIX}, los comandos @code{make install} y @code{make altinstall} arrancan @code{pip} por defecto.  Este comportamiento puede ser controlado a través de las opciones de configuración, y anulado a través de las opciones del Makefile.

En Windows y Mac OS X, los instaladores de CPython ahora instalan por defecto @code{pip} junto con el propio CPython (los usuarios pueden optar por no instalarlo durante el proceso de instalación). Los usuarios de Windows tendrán que optar por las modificaciones automáticas del @code{PATH} para que @code{pip} esté disponible por defecto desde la línea de comandos, de lo contrario se puede acceder a través del lanzador de Python para Windows como @code{py -m pip}.

As 
@geindex Python Enhancement Proposals; PEP 0453#recommendations-for-downstream-distributors
discussed in the PEP@footnote{https://peps.python.org/pep-0453/#recommendations-for-downstream-distributors}
platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear and
simple directions on how to install them on that platform (usually using
the system package manager).

@cartouche
@quotation Nota 
Para evitar conflictos entre instalaciones paralelas de Python 2 y Python 3, sólo los comandos versionados @code{pip3} y @code{pip3.4} son arrancados por defecto cuando se invoca @code{ensurepip} directamente - la opción @code{--default-pip} es necesaria para solicitar también el comando no versionado @code{pip}. @code{pyvenv} y el instalador de Windows aseguran que el comando @code{pip} sin calificar esté disponible en esos entornos, y @code{pip} siempre puede ser invocado a través del interruptor @code{-m} en lugar de directamente para evitar la ambigüedad en sistemas con múltiples instalaciones de Python.
@end quotation
@end cartouche

@node Cambios en la documentación,,Puesta en marcha de pip por defecto,PEP 453 Arranque explícito de PIP en instalaciones de Python
@anchor{whatsnew/3 4 documentation-changes}@anchor{f77}
@subsubsection Cambios en la documentación


Como parte de este cambio, las secciones @ref{f78,,Instalando módulos de Python} y distributing-index de la documentación han sido completamente rediseñadas como breves documentos de inicio y preguntas frecuentes. La mayor parte de la documentación de empaquetado se ha trasladado a la «Guía del usuario de empaquetado de Python» mantenida por la Autoridad de Empaquetado de Python <@indicateurl{https://packaging.python.org}>`__ y a la documentación de los proyectos individuales.

However, as this migration is currently still incomplete, the legacy
versions of those guides remaining available as @ref{f79,,Building C and C++ Extensions with setuptools}
and @ref{f7a,,Building C and C++ Extensions with setuptools}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} – Arranque explícito de pip en instalaciones de Python

PEP escrito por Donald Stufft y Nick Coghlan, implementado por Donald Stufft, Nick Coghlan, Martin von Löwis y Ned Deily.
@end table


@node PEP 446 Los descriptores de archivos recién creados no son heredables,Mejoras en el manejo de códecs,PEP 453 Arranque explícito de PIP en instalaciones de Python,Nuevas Funciones
@anchor{whatsnew/3 4 pep-446-newly-created-file-descriptors-are-non-inheritable}@anchor{f7b}@anchor{whatsnew/3 4 whatsnew-pep-446}@anchor{f59}
@subsubsection PEP 446: Los descriptores de archivos recién creados no son heredables


@geindex Python Enhancement Proposals; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/} hace que los descriptores de archivo recién creados sean @ref{f7c,,no heredables}.  En general, este es el comportamiento que una aplicación querrá: al lanzar un nuevo proceso, tener archivos actualmente abiertos también en el nuevo proceso puede llevar a todo tipo de errores difíciles de encontrar, y potencialmente a problemas de seguridad.

Sin embargo, hay ocasiones en las que se desea la herencia.  Para dar soporte a estos casos, están disponibles las siguientes funciones y métodos nuevos:


@itemize *

@item 
@ref{f7d,,os.get_inheritable()}, @ref{f7e,,os.set_inheritable()}

@item 
@ref{f7f,,os.get_handle_inheritable()}, @ref{f80,,os.set_handle_inheritable()}

@item 
@ref{f81,,socket.socket.get_inheritable()}, @ref{f82,,socket.socket.set_inheritable()}
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 446

@item PEP 446@footnote{https://peps.python.org/pep-0446/} – Hacer que los descriptores de archivo recién creados no sean heredables

PEP escrito y aplicado por Victor Stinner.
@end table


@node Mejoras en el manejo de códecs,PEP 451 Un tipo ModuleSpec para el sistema de importación,PEP 446 Los descriptores de archivos recién creados no son heredables,Nuevas Funciones
@anchor{whatsnew/3 4 codec-handling-improvements}@anchor{f5b}@anchor{whatsnew/3 4 improvements-to-codec-handling}@anchor{f83}
@subsubsection Mejoras en el manejo de códecs


Desde que se introdujo por primera vez, el módulo @ref{1c,,codecs} siempre ha pretendido funcionar como un sistema de codificación y decodificación dinámica de tipo neutro. Sin embargo, su estrecho acoplamiento con el modelo de texto de Python, especialmente los métodos de conveniencia restringidos a los tipos @ref{237,,str}, @ref{325,,bytes} y @ref{5e0,,bytearray}, ha ocultado históricamente este hecho.

Como paso clave para aclarar la situación, las funciones de conveniencia @ref{f84,,codecs.encode()} y @ref{f85,,codecs.decode()} están ahora debidamente documentadas en Python 2.7, 3.3 y 3.4. Estas funciones han existido en el módulo @ref{1c,,codecs} (y han sido cubiertas por el conjunto de pruebas de regresión) desde Python 2.4, pero anteriormente sólo se podían descubrir a través de la introspección en tiempo de ejecución.

A diferencia de los métodos de conveniencia de @ref{237,,str}, @ref{325,,bytes} y @ref{5e0,,bytearray}, las funciones de conveniencia de @ref{1c,,codecs} soportan codificaciones arbitrarias tanto en Python 2 como en Python 3, en lugar de limitarse a codificaciones de texto Unicode (en Python 3) o a <->conversiones de @code{basestring} (en Python 2).

En Python 3.4, el intérprete es capaz de identificar las codificaciones no textuales conocidas proporcionadas en la biblioteca estándar y dirigir a los usuarios hacia estas funciones de conveniencia de propósito general cuando sea apropiado:

@example
>>> b"abcdef".decode("hex")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'hex' is not a text encoding; use codecs.decode() to handle arbitrary codecs

>>> "hello".encode("rot13")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'rot13' is not a text encoding; use codecs.encode() to handle arbitrary codecs

>>> open("foo.txt", encoding="hex")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'hex' is not a text encoding; use codecs.open() to handle arbitrary codecs
@end example

En un cambio relacionado, siempre que sea factible sin romper la compatibilidad con versiones anteriores, las excepciones planteadas durante las operaciones de codificación y decodificación se envuelven en una excepción encadenada del mismo tipo que menciona el nombre del códec responsable de producir el error:

@example
>>> import codecs

>>> codecs.decode(b"abcdefgh", "hex")
Traceback (most recent call last):
  File "/usr/lib/python3.4/encodings/hex_codec.py", line 20, in hex_decode
    return (binascii.a2b_hex(input), len(input))
binascii.Error: Non-hexadecimal digit found

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
binascii.Error: decoding with 'hex' codec failed (Error: Non-hexadecimal digit found)

>>> codecs.encode("hello", "bz2")
Traceback (most recent call last):
  File "/usr/lib/python3.4/encodings/bz2_codec.py", line 17, in bz2_encode
    return (bz2.compress(input), len(input))
  File "/usr/lib/python3.4/bz2.py", line 498, in compress
    return comp.compress(data) + comp.flush()
TypeError: 'str' does not support the buffer interface

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: encoding with 'bz2' codec failed (TypeError: 'str' does not support the buffer interface)
@end example

Por último, como muestran los ejemplos anteriores, estas mejoras han permitido restaurar los alias de conveniencia para los códecs no Unicode que fueron restaurados a su vez en Python 3.2. Esto significa que la codificación de datos binarios a y desde su representación hexadecimal (por ejemplo) puede escribirse ahora como:

@example
>>> from codecs import encode, decode
>>> encode(b"hello", "hex")
b'68656c6c6f'
>>> decode(b"68656c6c6f", "hex")
b'hello'
@end example

Las transformaciones binarias y de texto proporcionadas en la biblioteca estándar se detallan en @ref{f86,,Transformaciones Binarias} y @ref{f87,,Transformaciones de texto}.

(Contribución de Nick Coghlan en bpo-7475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7475}, bpo-17827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17827}, bpo-17828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17828} y bpo-19619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19619})

@node PEP 451 Un tipo ModuleSpec para el sistema de importación,Otros cambios de lenguaje,Mejoras en el manejo de códecs,Nuevas Funciones
@anchor{whatsnew/3 4 pep-451-a-modulespec-type-for-the-import-system}@anchor{f88}@anchor{whatsnew/3 4 whatsnew-pep-451}@anchor{f5c}
@subsubsection PEP 451: Un tipo ModuleSpec para el sistema de importación


@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} proporciona una encapsulación de la información sobre un módulo que la maquinaria de importación utilizará para cargarlo (es decir, una especificación del módulo).  Esto ayuda a simplificar tanto la implementación de la importación como varias APIs relacionadas con la importación. El cambio es también un peldaño para varias mejoras futuras relacionadas con la importación@footnote{https://mail.python.org/pipermail/python-dev/2013-November/130111.html}.

Los cambios públicos del PEP son totalmente compatibles con las versiones anteriores. Además, deberían ser transparentes para todos, excepto para los autores de los importadores.  Los métodos del buscador y del cargador de claves han quedado obsoletos, pero seguirán funcionando. Los nuevos importadores deben utilizar los nuevos métodos descritos en el PEP.  Los importadores existentes deben ser actualizados para implementar los nuevos métodos.  Consulte la sección @ref{f89,,Obsoleto} para obtener una lista de los métodos que deben ser reemplazados y sus sustituciones.

@node Otros cambios de lenguaje,,PEP 451 Un tipo ModuleSpec para el sistema de importación,Nuevas Funciones
@anchor{whatsnew/3 4 other-language-changes}@anchor{f8a}
@subsubsection Otros cambios de lenguaje


Algunos de los cambios mas pequeños hechos al núcleo del lenguaje de Python son:


@itemize *

@item 
Base de datos Unicode actualizada a la versión 6.3 de UCD.

@item 
@ref{f8b,,min()} y @ref{f8c,,max()} aceptan ahora un argumento `por defecto' que puede utilizarse para especificar el valor que devuelven si el iterable que están evaluando no tiene elementos.  (Contribuido por Julian Berman en bpo-18111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18111}.)

@item 
Los objetos del módulo ahora son @ref{f8d,,weakly referenceable}.

@item 
Los atributos del módulo @code{file__} (y los valores relacionados) deberían ahora contener siempre rutas absolutas por defecto, con la única excepción de @code{main__.__file__} cuando un script ha sido ejecutado directamente usando una ruta relativa.  (Contribuido por Brett Cannon en bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}.)

@item 
Todos los códecs UTF-* (excepto UTF-7) rechazan ahora los sustitutos tanto durante la codificación como la decodificación, a menos que se utilice el controlador de errores @code{surrogatepass}, con la excepción del decodificador UTF-16 (que acepta pares de sustitutos válidos) y el codificador UTF-16 (que los produce al codificar caracteres no BMP). (Contribución de Victor Stinner, Kang-Hao (Kenny) Lu y Serhiy Storchaka en bpo-12892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12892})

@item 
Nuevo EBCDIC alemán @ref{e3e,,codec} @code{cp273}.  (Contribución de Michael Bierenfeld y Andrew Kuchling en bpo-1097797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1097797})

@item 
Nuevo Ucraniano @ref{e3e,,codec} @code{cp1125} (Contribuido por Serhiy Storchaka en bpo-19668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19668}.)

@item 
@ref{325,,bytes}.join() y @ref{5e0,,bytearray}.join() aceptan ahora objetos buffer arbitrarios como argumentos.  (Contribuido por Antoine Pitrou en bpo-15958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15958}.)

@item 
El constructor de @ref{1f0,,int} ahora acepta cualquier objeto que tenga un método @code{index__} para su argumento `base'.  (Contribuido por Mark Dickinson en bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772}.)

@item 
Los objetos Frame tienen ahora un método @ref{3d5,,clear()} que borra todas las referencias a las variables locales del frame.  (Contribuido por Antoine Pitrou en bpo-17934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17934}.)

@item 
@ref{156,,memoryview} está ahora registrada como @ref{1f,,Sequence}, y soporta el builtin @ref{8fc,,reversed()}.  (Contribución de Nick Coghlan y Claudiu Popa en bpo-18690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18690} y bpo-19078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19078})

@item 
Las firmas reportadas por @ref{96e,,help()} han sido modificadas y mejoradas en varios casos como resultado de la introducción de Argument Clinic y otros cambios en los módulos @ref{7e,,inspect} y @ref{b5,,pydoc}.

@item 
@ref{f8e,,__length_hint__()} es ahora parte de la especificación formal del lenguaje (ver 
@geindex Python Enhancement Proposals; PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/}).  (Contribuido por Armin Ronacher en bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)
@end itemize

@node Nuevos Módulos<2>,Módulos mejorados<9>,Nuevas Funciones,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 new-modules}@anchor{f8f}
@subsection Nuevos Módulos


@menu
* asyncio: asyncio<11>. 
* ensurepip: ensurepip<2>. 
* enum: enum<6>. 
* pathlib: pathlib<9>. 
* selectores:: 
* estadísticas:: 
* tracemalloc: tracemalloc<4>. 

@end menu

@node asyncio<11>,ensurepip<2>,,Nuevos Módulos<2>
@anchor{whatsnew/3 4 asyncio}@anchor{f90}@anchor{whatsnew/3 4 whatsnew-asyncio}@anchor{f5e}
@subsubsection asyncio


El nuevo módulo @ref{b,,asyncio} (definido en 
@geindex Python Enhancement Proposals; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}) proporciona un modelo de bucle de eventos enchufable estándar para Python, proporcionando un sólido soporte de IO asíncrono en la biblioteca estándar, y facilitando que otras implementaciones de bucle de eventos interoperen con la biblioteca estándar y entre sí.

Para Python 3.4, este módulo se considera un @ref{b8e,,provisional API}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3156

@item PEP 3156@footnote{https://peps.python.org/pep-3156/} – Soporte de IO asíncrono reiniciado: el módulo «asyncio

PEP redactado y ejecutado por Guido van Rossum.
@end table


@node ensurepip<2>,enum<6>,asyncio<11>,Nuevos Módulos<2>
@anchor{whatsnew/3 4 ensurepip}@anchor{f91}@anchor{whatsnew/3 4 whatsnew-ensurepip}@anchor{f5f}
@subsubsection ensurepip


El nuevo módulo @ref{55,,ensurepip} es la infraestructura principal para la implementación de 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}.  En el curso normal de los acontecimientos, los usuarios finales no necesitarán interactuar con este módulo, pero puede utilizarse para arrancar manualmente @code{pip} si se rechaza el arranque automático en una instalación o entorno virtual.

@ref{55,,ensurepip} incluye una copia de @code{pip}, actualizada a partir de la primera versión candidata de la versión de CPython con la que se envía (esto se aplica tanto a las versiones de mantenimiento como a las versiones de características).  @code{ensurepip} no tiene acceso a Internet.  Si la instalación tiene acceso a Internet, después de ejecutar @code{ensurepip} se puede utilizar el paquete @code{pip} para actualizar @code{pip} a una versión más reciente que la incluida.  (Ten en cuenta que esa versión actualizada de @code{pip} se considera un paquete instalado por separado y no se eliminará si se desinstala Python)

El módulo se llama `ensure' pip porque si se llama cuando @code{pip} ya está instalado, no hace nada.  También tiene una opción @code{--upgrade} que hará que se instale la copia incluida de @code{pip} si la versión instalada de @code{pip} es más antigua que la copia incluida.

@node enum<6>,pathlib<9>,ensurepip<2>,Nuevos Módulos<2>
@anchor{whatsnew/3 4 enum}@anchor{f92}@anchor{whatsnew/3 4 whatsnew-enum}@anchor{f60}
@subsubsection enum


El nuevo módulo @ref{56,,enum} (definido en 
@geindex Python Enhancement Proposals; PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/}) proporciona una implementación estándar de los tipos de enumeración, lo que permite a otros módulos (como @ref{cc,,socket}) proporcionar mensajes de error más informativos y un mejor soporte de depuración al sustituir las constantes enteras opacas por valores de enumeración compatibles con versiones anteriores.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 435

@item PEP 435@footnote{https://peps.python.org/pep-0435/} – Añadir un tipo Enum a la biblioteca estándar de Python

PEP escrito por Barry Warsaw, Eli Bendersky y Ethan Furman, implementado por Ethan Furman.
@end table


@node pathlib<9>,selectores,enum<6>,Nuevos Módulos<2>
@anchor{whatsnew/3 4 pathlib}@anchor{f93}@anchor{whatsnew/3 4 whatsnew-pathlib}@anchor{f61}
@subsubsection pathlib


El nuevo módulo @ref{a4,,pathlib} ofrece clases que representan las rutas del sistema de ficheros con una semántica apropiada para diferentes sistemas operativos.  Las clases de rutas se dividen entre `rutas puras', que proporcionan operaciones puramente computacionales sin E/S, y `rutas concretas', que heredan de las rutas puras pero también proporcionan operaciones de E/S.

Para Python 3.4, este módulo se considera un @ref{b8e,,provisional API}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 428

@item PEP 428@footnote{https://peps.python.org/pep-0428/} – El módulo pathlib – rutas del sistema de archivos orientadas a objetos

PEP escrito y aplicado por Antoine Pitrou.
@end table


@node selectores,estadísticas,pathlib<9>,Nuevos Módulos<2>
@anchor{whatsnew/3 4 selectors}@anchor{f94}@anchor{whatsnew/3 4 whatsnew-selectors}@anchor{f62}
@subsubsection selectores


El nuevo módulo @ref{c2,,selectors} (creado como parte de la implementación de 
@geindex Python Enhancement Proposals; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}) permite una multiplexación de E/S eficiente y de alto nivel, construida sobre las primitivas del módulo @ref{c1,,select}.

@node estadísticas,tracemalloc<4>,selectores,Nuevos Módulos<2>
@anchor{whatsnew/3 4 statistics}@anchor{f95}@anchor{whatsnew/3 4 whatsnew-statistics}@anchor{f63}
@subsubsection estadísticas


El nuevo módulo @ref{d2,,statistics} (definido en 
@geindex Python Enhancement Proposals; PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/}) ofrece algunas funciones estadísticas básicas directamente en la biblioteca estándar. Este módulo permite calcular la media, la mediana, la moda, la varianza y la desviación estándar de una serie de datos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 450

@item PEP 450@footnote{https://peps.python.org/pep-0450/} – Añadir un módulo de estadísticas a la biblioteca estándar

PEP escrito y aplicado por Steven D’Aprano
@end table


@node tracemalloc<4>,,estadísticas,Nuevos Módulos<2>
@anchor{whatsnew/3 4 tracemalloc}@anchor{f96}@anchor{whatsnew/3 4 whatsnew-tracemalloc}@anchor{f64}
@subsubsection tracemalloc


El nuevo módulo @ref{ff,,tracemalloc} (definido en 
@geindex Python Enhancement Proposals; PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/}) es una herramienta de depuración para rastrear los bloques de memoria asignados por Python. Proporciona la siguiente información:


@itemize *

@item 
Rastrear dónde se asignó un objeto

@item 
Estadísticas sobre los bloques de memoria asignados por nombre de archivo y por número de línea: tamaño total, número y tamaño medio de los bloques de memoria asignados

@item 
Calcular las diferencias entre dos instantáneas para detectar fugas de memoria
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 454

@item PEP 454@footnote{https://peps.python.org/pep-0454/} – Añade un nuevo módulo tracemalloc para rastrear las asignaciones de memoria de Python

PEP escrito y aplicado por Victor Stinner
@end table


@node Módulos mejorados<9>,Cambios en la implementación de CPython,Nuevos Módulos<2>,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 improved-modules}@anchor{f97}
@subsection Módulos mejorados


@menu
* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<6>. 
* audioop:: 
* base64: base64<3>. 
* colecciones: colecciones<2>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<5>. 
* doctest: doctest<4>. 
* email: email<4>. 
* archivoecmp:: 
* functools: functools<5>. 
* gc: gc<3>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<3>. 
* html:: 
* http: http<4>. 
* idlelib y IDLE: idlelib y IDLE<2>. 
* importlib: importlib<10>. 
* inspeccionar: inspeccionar<5>. 
* dirección IP: dirección IP<2>. 
* Tres mejoras más pequeñas en el módulo logging@comma{} todas implementadas por Vinay Sajip@comma{} son;: Tres mejoras más pequeñas en el módulo logging todas implementadas por Vinay Sajip son. 
* mariscal:: 
* mmap: mmap<3>. 
* multiprocesamiento: multiprocesamiento<3>. 
* PEP 465@comma{} un nuevo operador de multiplicación de matrices; a @@ b.: PEP 465 un nuevo operador de multiplicación de matrices a @@ b. 
* os: os<11>. 
* pdb: pdb<6>. 
* pepinillo: pepinillo<2>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty: pty<2>. 
* pydoc: pydoc<3>. 
* re: re<8>. 
* recurso:: 
* seleccionar:: 
* estante:: 
* shutil: shutil<5>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* enchufe: enchufe<5>. 
* sqlite3: sqlite3<10>. 
* ssl: ssl<10>. 
* stat:: 
* struct:: 
* subproceso: subproceso<2>. 
* sunau: sunau<2>. 
* sys: sys<11>. 
* tarfile: tarfile<7>. 
* textwrap:: 
* roscado:: 
* traceback: traceback<3>. 
* tipos: tipos<2>. 
* urllib: urllib<4>. 
* unittest: unittest<8>. 
* venv: venv<7>. 
* onda:: 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* archivo zip: archivo zip<3>. 

@end menu

@node abc,aifc<2>,,Módulos mejorados<9>
@anchor{whatsnew/3 4 abc}@anchor{f98}
@subsubsection abc


La nueva función @ref{f99,,abc.get_cache_token()} puede utilizarse para saber cuándo invalidar las cachés que se ven afectadas por cambios en el gráfico de objetos.  (Contribuido por Łukasz Langa en bpo-16832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16832}.)

La nueva clase @ref{f9a,,ABC} tiene @ref{f9b,,ABCMeta} como metaclase. Usar @code{ABC} como clase base tiene esencialmente el mismo efecto que especificar @code{metaclass=abc.ABCMeta}, pero es más sencillo de escribir y más fácil de leer. (Contribuido por Bruno Dupuis en bpo-16049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16049}.)

@node aifc<2>,argparse<6>,abc,Módulos mejorados<9>
@anchor{whatsnew/3 4 aifc}@anchor{f9c}
@subsubsection aifc


The @code{getparams()} method now returns a namedtuple rather than a
plain tuple.  (Contributed by Claudiu Popa in bpo-17818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17818}.)

@code{aifc.open()} now supports the context management protocol: when used in a
@ref{673,,with} block, the @code{close()} method of the returned
object will be called automatically at the end of the block.  (Contributed by
Serhiy Storchacha in bpo-16486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16486}.)

The @code{writeframesraw()} and @code{writeframes()}
methods now accept any @ref{db4,,bytes-like object}.  (Contributed by Serhiy
Storchaka in bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node argparse<6>,audioop,aifc<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 argparse}@anchor{f9d}
@subsubsection argparse


La clase @ref{1c2,,FileType} acepta ahora los argumentos `encoding' y `errors', que se pasan a @ref{1be,,open()}.  (Contribuido por Lucas Maystre en bpo-11175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11175}.)

@node audioop,base64<3>,argparse<6>,Módulos mejorados<9>
@anchor{whatsnew/3 4 audioop}@anchor{f9e}
@subsubsection audioop


@code{audioop} now supports 24-bit samples.  (Contributed by Serhiy Storchaka
in bpo-12866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12866}.)

New @code{byteswap()} function converts big-endian samples to
little-endian and vice versa.  (Contributed by Serhiy Storchaka in
bpo-19641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19641}.)

All @code{audioop} functions now accept any @ref{db4,,bytes-like object}.  Strings
are not accepted: they didn’t work before, now they raise an error right away.
(Contributed by Serhiy Storchaka in bpo-16685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16685}.)

@node base64<3>,colecciones<2>,audioop,Módulos mejorados<9>
@anchor{whatsnew/3 4 base64}@anchor{f9f}
@subsubsection base64


Las funciones de codificación y decodificación de @ref{f,,base64} aceptan ahora cualquier @ref{db4,,bytes-like object} en los casos en que antes se requería una instancia de @ref{325,,bytes} o @ref{5e0,,bytearray}.  (Contribución de Nick Coghlan en bpo-17839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17839}.)

Las nuevas funciones @ref{fa0,,a85encode()}, @ref{fa1,,a85decode()}, @ref{fa2,,b85encode()}, y @ref{fa3,,b85decode()} proporcionan la capacidad de codificar y decodificar datos binarios desde y hacia los formatos @code{Ascii85} y git/mercurial @code{Base85}, respectivamente.  Las funciones @code{a85} tienen opciones que se pueden utilizar para hacerlas compatibles con las variantes de la codificación @code{Ascii85}, incluyendo la variante de Adobe.  (Contribuido por Martin Morrison, el proyecto Mercurial, Serhiy Storchaka y Antoine Pitrou en bpo-17618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17618})

@node colecciones<2>,colorsys,base64<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 collections}@anchor{fa4}
@subsubsection colecciones


El método @ref{fa5,,ChainMap.new_child()} acepta ahora un argumento `m' que especifica el mapa hijo a añadir a la cadena.  Esto permite utilizar un mapa existente y/o un tipo de mapa personalizado para el hijo.  (Contribuido por Vinay Sajip en bpo-16613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16613}.)

@node colorsys,contextlib<6>,colecciones<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 colorsys}@anchor{fa6}
@subsubsection colorsys


El número de dígitos en los coeficientes para las conversiones RGB — YIQ se ha ampliado para que coincidan con las versiones FCC NTSC.  El cambio en los resultados debería ser inferior al 1% a y puede coincidir mejor con los resultados encontrados en otros lugares. (Contribución de Brian Landers y Serhiy Storchaka en bpo-14323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14323}.)

@node contextlib<6>,dbm<6>,colorsys,Módulos mejorados<9>
@anchor{whatsnew/3 4 contextlib}@anchor{fa7}
@subsubsection contextlib


El nuevo gestor de contexto @ref{fa8,,contextlib.suppress} ayuda a clarificar la intención del código que suprime deliberadamente las excepciones de una única sentencia.  (Contribuido por Raymond Hettinger en bpo-15806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15806} y Zero Piraeus en bpo-19266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19266})

El nuevo gestor de contexto @ref{e6d,,contextlib.redirect_stdout()} facilita a los scripts de utilidades el manejo de APIs inflexibles que escriben su salida en @ref{b61,,sys.stdout} y no proporcionan ninguna opción para redirigirla.  Usando el gestor de contexto, la salida de @ref{b61,,sys.stdout} puede ser redirigida a cualquier otro flujo o, junto con @ref{fa9,,io.StringIO}, a una cadena. Esto último puede ser especialmente útil, por ejemplo, para capturar la salida de una función escrita para implementar una interfaz de línea de comandos. Se recomienda sólo para scripts de utilidad porque afecta al estado global de @ref{b61,,sys.stdout}.  (Contribuido por Raymond Hettinger en bpo-15805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15805}.)

También se ha actualizado la documentación de @ref{24,,contextlib} para incluir una @ref{faa,,discusión} de las diferencias entre gestores de contexto de un solo uso, reutilizables y reentrantes.

@node dbm<6>,dis<5>,contextlib<6>,Módulos mejorados<9>
@anchor{whatsnew/3 4 dbm}@anchor{fab}
@subsubsection dbm


Los objetos @ref{fac,,dbm.open()} soportan ahora el protocolo de gestión de contexto.  Cuando se utiliza en una sentencia @ref{673,,with}, el método @code{close} del objeto de base de datos será llamado automáticamente al final del bloque.  (Contribución de Claudiu Popa y Nick Coghlan en bpo-19282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19282})

@node dis<5>,doctest<4>,dbm<6>,Módulos mejorados<9>
@anchor{whatsnew/3 4 dis}@anchor{fad}
@subsubsection dis


Las funciones @ref{fae,,show_code()}, @ref{172,,dis()}, @ref{173,,distb()}, y @ref{174,,disassemble()} aceptan ahora un argumento de `archivo' que controla dónde escriben su salida.

El módulo @ref{39,,dis} se construye ahora en torno a una clase @ref{170,,Instruction} que proporciona acceso orientado a objetos a los detalles de cada operación individual del código de bytes.

Un nuevo método, @ref{33d,,get_instructions()}, proporciona un iterador que emite el flujo de instrucciones para un trozo de código Python dado.  Por lo tanto, ahora es posible escribir un programa que inspeccione y manipule un objeto de código de bytes de forma diferente a la proporcionada por el propio módulo @ref{39,,dis}.  Por ejemplo:

@example
>>> import dis
>>> for instr in dis.get_instructions(lambda x: x + 1):
...     print(instr.opname)
LOAD_FAST
LOAD_CONST
BINARY_ADD
RETURN_VALUE
@end example

Las distintas herramientas de visualización del módulo @ref{39,,dis} se han reescrito para utilizar estos nuevos componentes.

Además, una nueva clase de fácil aplicación @ref{171,,Bytecode} proporciona una API orientada a objetos para inspeccionar el código de bytes tanto en forma legible para el ser humano como para iterar sobre las instrucciones.  El constructor @ref{171,,Bytecode} toma los mismos argumentos que @code{get_instruction()} (más un `desplazamiento actual' opcional), y el objeto resultante puede ser iterado para producir objetos @ref{170,,Instruction}.  Pero también tiene un método @ref{faf,,dis}, equivalente a llamar a @ref{172,,dis} en el argumento del constructor, pero devuelto como una cadena de varias líneas:

@example
>>> bytecode = dis.Bytecode(lambda x: x + 1, current_offset=3)
>>> for instr in bytecode:
...     print('@{@} (@{@})'.format(instr.opname, instr.opcode))
LOAD_FAST (124)
LOAD_CONST (100)
BINARY_ADD (23)
RETURN_VALUE (83)
>>> bytecode.dis().splitlines()       
['  1           0 LOAD_FAST                0 (x)',
 '      -->     3 LOAD_CONST               1 (1)',
 '              6 BINARY_ADD',
 '              7 RETURN_VALUE']
@end example

@ref{171,,Bytecode} también tiene un método de clase, @ref{fb0,,from_traceback()}, que proporciona la capacidad de manipular un traceback (es decir, @code{print(Bytecode.from_traceback(tb).dis())} es equivalente a @code{distb(tb)}).

(Contribución de Nick Coghlan, Ryan Kelly y Thomas Kluyver en bpo-11816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11816} y Claudiu Popa en bpo-17916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17916})

La nueva función @ref{fb1,,stack_effect()} calcula el efecto en la pila de Python de un opcode y un argumento dados, información que no está disponible de otro modo. (Contribuido por Larry Hastings en bpo-19722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19722}.)

@node doctest<4>,email<4>,dis<5>,Módulos mejorados<9>
@anchor{whatsnew/3 4 doctest}@anchor{fb2}
@subsubsection doctest


A new @ref{fb3,,option flag}, @ref{fb4,,FAIL_FAST}, halts
test running as soon as the first failure is detected.  (Contributed by R.
David Murray and Daniel Urban in bpo-16522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16522}.)

La interfaz de línea de comandos de @ref{3b,,doctest} utiliza ahora @ref{7,,argparse}, y tiene dos nuevas opciones, @code{-} y @code{-f}.  @code{-o} permite <doctest-options> especificar las opciones de @ref{fb3,,opciones doctest} en la línea de órdenes, y @code{-f} es una abreviatura de @code{- FAIL_FAST} (en paralelo a la opción similar soportada por el CLI de @ref{106,,unittest}).  (Contribuido por R. David Murray en bpo-11390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11390}.)

@ref{3b,,doctest} ahora encontrará doctests en las cadenas del módulo de extensión @code{doc__}. (Contribuido por Zachary Ware en bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158}.)

@node email<4>,archivoecmp,doctest<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 email}@anchor{fb5}
@subsubsection email


@ref{fb6,,as_string()} acepta ahora un argumento `policy' para anular la política por defecto del mensaje al generar una representación de cadena del mismo.  Esto significa que @code{as_string} puede utilizarse en más circunstancias, en lugar de tener que crear y utilizar un @ref{41,,generator} para pasar parámetros de formato a su método @code{flatten}.  (Contribuido por R. David Murray en bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600}.)

Nuevo método @ref{fb7,,as_bytes()} añadido para producir una representación en bytes del mensaje de forma similar a como @code{as_string} produce una representación en cadena.  No acepta el argumento `maxheaderlen', pero sí los argumentos `unixfrom' y `policy'. El método @ref{3d1,,Message} @ref{fb8,,__bytes__()} lo llama, lo que significa que @code{bytes(mymsg)} producirá ahora el resultado intuitivo: un objeto bytes que contiene el mensaje completamente formateado.  (Contribuido por R. David Murray en bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600}.)

El mensaje @ref{fb9,,Message.set_param()} acepta ahora un argumento de palabra clave `replace'. Cuando se especifica, la cabecera asociada se actualizará sin cambiar su ubicación en la lista de cabeceras.  Por compatibilidad, el valor por defecto es @code{False}.  (Contribuido por R. David Murray en bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}.)
@anchor{whatsnew/3 4 whatsnew-email-contentmanager}@anchor{f68}
Se han añadido un par de nuevas subclases de @ref{3d1,,Message} (@ref{3d0,,EmailMessage} y @ref{fba,,MIMEPart}), junto con un nuevo submódulo, @ref{3e,,contentmanager} y un nuevo atributo @ref{50,,policy} @ref{fbb,,content_manager}.  Toda la documentación se encuentra actualmente en el nuevo módulo, que se añade como parte del nuevo @ref{b8e,,provisional API} de email.  Estas clases proporcionan una serie de nuevos métodos que facilitan la extracción e inserción de contenidos en los mensajes de correo electrónico.  Para más detalles, consulte la documentación de @ref{3e,,contentmanager} y la @ref{fbc,,email; Ejemplos}.  Estas adiciones a la API completan la mayor parte del trabajo que estaba previsto como parte del proyecto email6.  Está previsto que la API, actualmente provisional, se convierta en la definitiva en Python 3.5 (posiblemente con algunos añadidos menores en el área de gestión de errores).  (Contribuido por R. David Murray en bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}.)

@node archivoecmp,functools<5>,email<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 filecmp}@anchor{fbd}
@subsubsection archivoecmp


Una nueva función @ref{fbe,,clear_cache()} ofrece la posibilidad de borrar la caché de comparación @ref{5a,,filecmp}, que utiliza la información de @ref{548,,os.stat()} para determinar si el fichero ha cambiado desde la última comparación.  Esto puede usarse, por ejemplo, si el archivo puede haber sido modificado y vuelto a comprobar en menos tiempo que la resolución del campo de tiempo de modificación de un archivo del sistema de archivos en particular. (Contribuido por Mark Levitt en bpo-18149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18149}.)

New module attribute @ref{fbf,,DEFAULT_IGNORES} provides the list of
directories that are used as the default value for the `ignore' parameter of
the @ref{fc0,,dircmp()} function.  (Contributed by Eli Bendersky in
bpo-15442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15442}.)

@node functools<5>,gc<3>,archivoecmp,Módulos mejorados<9>
@anchor{whatsnew/3 4 functools}@anchor{fc1}
@subsubsection functools


El nuevo descriptor @ref{17b,,partialmethod()} aporta la aplicación de argumentos parciales a los descriptores, al igual que @ref{17a,,partial()} proporciona para los callables normales. El nuevo descriptor también facilita la obtención de llamadas arbitrarias (incluyendo instancias de @ref{17a,,partial()}) para que se comporten como métodos de instancia normales cuando se incluyen en la definición de una clase. (Contribución de Alon Horev y Nick Coghlan en bpo-4331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4331})
@anchor{whatsnew/3 4 whatsnew-singledispatch}@anchor{f65}
El nuevo decorador @ref{6da,,singledispatch()} aporta soporte para funciones genéricas single-dispatch a la biblioteca estándar de Python. Mientras que la programación orientada a objetos se centra en agrupar múltiples operaciones sobre un conjunto común de datos en una clase, una función genérica se centra en agrupar múltiples implementaciones de una operación que le permite trabajar con `diferentes' tipos de datos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 443

@item PEP 443@footnote{https://peps.python.org/pep-0443/} – Funciones genéricas de despacho único

PEP escrito e implementado por Łukasz Langa.
@end table


@ref{fc2,,total_ordering()} now supports a return value of
@ref{227,,NotImplemented} from the underlying comparison function.  (Contributed
by Katie Miller in bpo-10042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10042}.)

Una versión en python puro de la función @ref{17a,,partial()} está ahora en la stdlib; en CPython está anulada por la versión acelerada en C, pero está disponible para que otras implementaciones la usen.  (Contribuido por Brian Thorne en bpo-12428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12428}.)

@node gc<3>,glob<4>,functools<5>,Módulos mejorados<9>
@anchor{whatsnew/3 4 gc}@anchor{fc3}
@subsubsection gc


La nueva función @ref{fc4,,get_stats()} devuelve una lista de tres diccionarios por generación que contienen las estadísticas de las colecciones desde el inicio del intérprete. (Contribuido por Antoine Pitrou en bpo-16351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16351}.)

@node glob<4>,hashlib<6>,gc<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 glob}@anchor{fc5}
@subsubsection glob


Una nueva función @ref{fc6,,escape()} proporciona una forma de escapar los caracteres especiales de un nombre de archivo para que no formen parte de la expansión globbing sino que se comparen literalmente.  (Contribuido por Serhiy Storchaka en bpo-8402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8402}.)

@node hashlib<6>,hmac<3>,glob<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 hashlib}@anchor{fc7}
@subsubsection hashlib


Una nueva función @ref{5b3,,hashlib.pbkdf2_hmac()} proporciona la función de derivación de clave basada en contraseña PKCS#5 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}.  (Contribuido por Christian Heimes en bpo-18582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18582}.)

El atributo @ref{fc8,,name} de los objetos hash @ref{68,,hashlib} es ahora una interfaz formalmente soportada.  Siempre ha existido en el @ref{68,,hashlib} de CPython (aunque no devolvía nombres en minúsculas para todos los hashes soportados), pero no era una interfaz pública y por eso algunas otras implementaciones de Python no la han soportado previamente.  (Contribuido por Jason R. Coombs en bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532}.)

@node hmac<3>,html,hashlib<6>,Módulos mejorados<9>
@anchor{whatsnew/3 4 hmac}@anchor{fc9}
@subsubsection hmac


@ref{6a,,hmac} acepta ahora @code{bytearray} así como @code{bytes} para el argumento `clave' de la función @ref{b2a,,new()}, y el parámetro `msg' tanto de la función @ref{b2a,,new()} como del método @ref{fca,,update()} acepta ahora cualquier tipo soportado por el módulo @ref{68,,hashlib}.  (Contribuido por Jonas Borgström en bpo-18240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18240}.)

El argumento `digestmod' de la función @ref{b2a,,hmac.new()} puede ser ahora cualquier nombre de digesto hash reconocido por @ref{68,,hashlib}.  Además, el comportamiento actual en el que el valor de `digestmod' por defecto es @code{MD5} queda obsoleto: en una futura versión de Python no habrá valor por defecto.  (Contribuido por Christian Heimes en bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276}.)

Con la adición de los atributos @ref{fcb,,block_size} y @ref{fcc,,name} (y la documentación formal del atributo @ref{fcd,,digest_size}), el módulo @ref{6a,,hmac} se ajusta ahora plenamente a la API 
@geindex Python Enhancement Proposals; PEP 247
PEP 247@footnote{https://peps.python.org/pep-0247/}. (Contribuido por Christian Heimes en bpo-18775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18775}.)

@node html,http<4>,hmac<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 html}@anchor{fce}
@subsubsection html


La nueva función @ref{9ea,,unescape()} convierte las referencias de caracteres de HTML5 en los correspondientes caracteres Unicode.  (Contribuido por Ezio Melotti en bpo-2927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2927}.)

@ref{90e,,HTMLParser} acepta un nuevo argumento de palabra clave `convert_charrefs' que, cuando es @code{True}, convierte automáticamente todas las referencias de caracteres.  Por compatibilidad, su valor por defecto es @code{False}, pero cambiará a @code{True} en una futura versión de Python, así que te invitamos a establecerlo explícitamente y actualizar tu código para usar esta nueva característica.  (Contribuido por Ezio Melotti en bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633}.)

El argumento `strict' de @ref{90e,,HTMLParser} está ahora obsoleto. (Contribuido por Ezio Melotti en bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}.)

@node http<4>,idlelib y IDLE<2>,html,Módulos mejorados<9>
@anchor{whatsnew/3 4 http}@anchor{fcf}
@subsubsection http


@ref{fd0,,send_error()} acepta ahora un parámetro adicional opcional `explain' que puede usarse para proporcionar una descripción de error extendida, anulando el valor predeterminado si lo hay. Esta descripción de error extendida se formateará utilizando el atributo @code{error_message_format} y se enviará como cuerpo de la respuesta de error.  (Contribuido por Karl Cow en bpo-12921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12921}.)

El @ref{72,,http.server} @ref{fd1,,interfaz de línea de comandos} tiene ahora una opción @code{-b/--bind} que hace que el servidor escuche en una dirección específica. (Contribuido por Malte Swart en bpo-17764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17764}.)

@node idlelib y IDLE<2>,importlib<10>,http<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 idlelib-and-idle}@anchor{fd2}
@subsubsection idlelib y IDLE


Como idlelib implementa el shell y el editor de IDLE y no está pensado para ser importado por otros programas, recibe mejoras con cada versión. Vea @code{Lib/idlelib/NEWS.txt} para una lista acumulativa de cambios desde la versión 3.3.0, así como los cambios realizados en futuras versiones 3.4.x. Este fichero también está disponible en el diálogo de IDLE Ayuda ‣ Sobre IDLE.

@node importlib<10>,inspeccionar<5>,idlelib y IDLE<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 importlib}@anchor{fd3}
@subsubsection importlib


El ABC de @ref{fd4,,InspectLoader} define un nuevo método, @ref{e96,,source_to_code()} que acepta datos de origen y una ruta y devuelve un objeto de código.  La implementación por defecto es equivalente a @code{compile(data, path, 'exec', dont_inherit=True)}. (Contribuido por Eric Snow y Brett Cannon en bpo-15627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15627}.)

@ref{fd4,,InspectLoader} también tiene ahora una implementación por defecto para el método @ref{fd5,,get_code()}.  Sin embargo, normalmente será deseable anular la implementación por defecto por razones de rendimiento.  (Contribuido por Brett Cannon en bpo-18072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18072}.)

The @ref{5bd,,reload()} function has been moved from @code{imp} to
@ref{77,,importlib} as part of the @code{imp} module deprecation.  (Contributed by
Berker Peksag in bpo-18193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18193}.)

@ref{7d,,importlib.util} now has a @ref{5b7,,MAGIC_NUMBER} attribute
providing access to the bytecode version number.  This replaces the
@code{get_magic()} function in the deprecated @code{imp} module.
(Contributed by Brett Cannon in bpo-18192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18192}.)

New @ref{7d,,importlib.util} functions @ref{1f6,,cache_from_source()}
and @ref{5be,,source_from_cache()} replace the same-named functions
in the deprecated @code{imp} module.  (Contributed by Brett Cannon in
bpo-18194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18194}.)

El bootstrap @ref{77,,importlib} @ref{fd6,,NamespaceLoader} se ajusta ahora al ABC de @ref{fd4,,InspectLoader}, lo que significa que @code{runpy} y @code{python -m} pueden utilizarse ahora con paquetes de espacios de nombres.  (Contribuido por Brett Cannon en bpo-18058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18058}.)

@ref{7d,,importlib.util} tiene una nueva función @ref{fd7,,decode_source()} que decodifica la fuente a partir de bytes utilizando el procesamiento universal de nuevas líneas.  Esto es útil para implementar los métodos @ref{fd8,,InspectLoader.get_source()}.

@ref{d39,,importlib.machinery.ExtensionFileLoader} tiene ahora un método @ref{fd9,,get_filename()}.  Esto fue omitido inadvertidamente en la implementación original.  (Contribuido por Eric Snow en bpo-19152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19152}.)

@node inspeccionar<5>,dirección IP<2>,importlib<10>,Módulos mejorados<9>
@anchor{whatsnew/3 4 inspect}@anchor{fda}
@subsubsection inspeccionar


El módulo @ref{7e,,inspect} ofrece ahora una @ref{fdb,,interfaz de línea de comandos básica} para mostrar rápidamente el código fuente y otra información de módulos, clases y funciones.  (Contribución de Claudiu Popa y Nick Coghlan en bpo-18626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18626})

@ref{fdc,,unwrap()} facilita el desenvolvimiento de las cadenas de funciones envolventes creadas por @ref{fdd,,functools.wraps()} (y cualquier otra API que establezca el atributo @code{__wrapped__} en una función envolvente).  (Contribución de Daniel Urban, Aaron Iles y Nick Coghlan en bpo-13266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13266})

Como parte de la implementación del nuevo módulo @ref{56,,enum}, el módulo @ref{7e,,inspect} tiene ahora un soporte sustancialmente mejor para los métodos personalizados @code{__dir__} y los atributos de clase dinámicos proporcionados a través de metaclases.  (Contribuido por Ethan Furman en bpo-18929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18929} y bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030})

@ref{7d4,,getfullargspec()} y @code{getargspec()} utilizan ahora la API @ref{181,,signature()}. Esto les permite soportar un rango mucho más amplio de llamadas, incluyendo aquellas con atributos @code{__signature__}, aquellas con metadatos proporcionados por la clínica de argumentos, objetos @ref{17a,,functools.partial()} y más. Tenga en cuenta que, a diferencia de @ref{181,,signature()}, estas funciones siguen ignorando los atributos @code{__wrapped__}, e informan del primer argumento ya ligado para los métodos ligados, por lo que sigue siendo necesario actualizar su código para utilizar @ref{181,,signature()} directamente si se desean esas características. (Contribuido por Yury Selivanov en bpo-17481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17481}.)

@ref{181,,signature()} ahora soporta los tipos de pato de las funciones CPython, lo que añade soporte para las funciones compiladas con Cython.  (Contribuido por Stefan Behnel y Yury Selivanov en bpo-17159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17159})

@node dirección IP<2>,Tres mejoras más pequeñas en el módulo logging todas implementadas por Vinay Sajip son,inspeccionar<5>,Módulos mejorados<9>
@anchor{whatsnew/3 4 ipaddress}@anchor{fde}
@subsubsection dirección IP


@ref{80,,ipaddress} se añadió a la biblioteca estándar en Python 3.3 como una @ref{b8e,,provisional API}. Con el lanzamiento de Python 3.4, se ha eliminado esta calificación: @ref{80,,ipaddress} se considera ahora una API estable, cubierta por los requisitos normales de la biblioteca estándar para mantener la compatibilidad hacia atrás.

Una nueva propiedad @ref{fdf,,is_global} es @code{True} si una dirección es enrutable globalmente.  (Contribuido por Peter Moody en bpo-17400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17400}.)

@node Tres mejoras más pequeñas en el módulo logging todas implementadas por Vinay Sajip son,mariscal,dirección IP<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 logging}@anchor{fe0}
@subsubsection Tres mejoras más pequeñas en el módulo @code{logging}, todas implementadas por Vinay Sajip, son:


La clase @ref{fe1,,TimedRotatingFileHandler} tiene un nuevo parámetro `atTime' que puede utilizarse para especificar la hora del día en que debe producirse la renovación.  (Contribuido por Ronald Oussoren en bpo-9556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9556}.)

@ref{fe2,,SocketHandler} y @ref{fe3,,DatagramHandler} ahora soportan sockets de dominio Unix (estableciendo `puerto' a @code{None}).  (Contribuido por Vinay Sajip en el commit ce46195b56a9.)

@ref{bd9,,fileConfig()} ahora acepta una instancia de la subclase @ref{fe4,,configparser.RawConfigParser} para el parámetro `fname'.  Esto facilita el uso de un archivo de configuración cuando la configuración de registro es sólo una parte de la configuración general de la aplicación, o cuando la aplicación modifica la configuración antes de pasarla a @ref{bd9,,fileConfig()}.  (Contribuido por Vinay Sajip en bpo-16110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16110}.)

Los datos de configuración de registro recibidos desde un socket a través de la función @ref{fe5,,logging.config.listen()} pueden ahora ser validados antes de ser procesados suministrando una función de verificación como argumento de la nueva palabra clave `verify'.  (Contribuido por Vinay Sajip en bpo-15452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15452}.)

@node mariscal,mmap<3>,Tres mejoras más pequeñas en el módulo logging todas implementadas por Vinay Sajip son,Módulos mejorados<9>
@anchor{whatsnew/3 4 marshal}@anchor{fe6}@anchor{whatsnew/3 4 whatsnew-marshal-3}@anchor{f5d}
@subsubsection mariscal


La versión por defecto de @ref{8d,,marshal} ha sido aumentada a 3. El código que implementa la nueva versión restablece el comportamiento de Python2 de registrar sólo una copia de las cadenas internadas y preservar la internación en la deserialización, y extiende esta capacidad de «una copia» a cualquier tipo de objeto (incluyendo el manejo de referencias recursivas).  Esto reduce tanto el tamaño de los archivos @code{.pyc} como la cantidad de memoria que ocupa un módulo en la memoria cuando se carga desde un archivo @code{.pyc} (o @code{.pyo}).  (Contribuido por Kristján Valur Jónsson en bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475}, con mejoras adicionales de velocidad por Antoine Pitrou en bpo-19219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19219})

@node mmap<3>,multiprocesamiento<3>,mariscal,Módulos mejorados<9>
@anchor{whatsnew/3 4 mmap}@anchor{fe7}
@subsubsection mmap


Los objetos mmap ahora son @ref{f8d,,weakly referenceable}. (Aportado por Valerie Lambert en bpo-4885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4885}.)

@node multiprocesamiento<3>,PEP 465 un nuevo operador de multiplicación de matrices a @@ b,mmap<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 multiprocessing}@anchor{fe8}
@subsubsection multiprocesamiento

@anchor{whatsnew/3 4 whatsnew-multiprocessing-no-fork}@anchor{f67}
En Unix se han añadido @ref{162,,métodos de comienzo} @code{spawn} y @code{forkserver}, para iniciar procesos usando @ref{94,,multiprocessing}.  Estos hacen que la mezcla de procesos con hilos sea más robusta, y el método @code{spawn} coincide con la semántica que el multiprocesamiento siempre ha utilizado en Windows.  La nueva función @ref{fe9,,get_all_start_methods()} informa de todos los métodos de inicio disponibles en la plataforma, @ref{fea,,get_start_method()} informa del método de inicio actual, y @ref{18c,,set_start_method()} establece el método de inicio.  (Contribuido por Richard Oudkerk en bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}.)

@ref{94,,multiprocessing} también tiene ahora el concepto de @code{contexto}, que determina cómo se crean los procesos hijos.  La nueva función @ref{18b,,get_context()} devuelve un contexto que utiliza un método de inicio especificado.  Tiene la misma API que el propio módulo @ref{94,,multiprocessing}, por lo que se puede utilizar para crear @ref{98,,pool} y otros objetos que operarán dentro de ese contexto.  Esto permite que un framework y una aplicación o diferentes partes de la misma aplicación utilicen el multiprocesamiento sin interferir entre sí.  (Contribuido por Richard Oudkerk en bpo-18999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18999}.)

Excepto cuando se utiliza el antiguo método de inicio `fork', los procesos hijos ya no heredan los handles/descriptores de archivo innecesarios de sus padres (parte de bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}).

@ref{94,,multiprocessing} ahora se basa en @ref{be,,runpy} (que implementa el conmutador @code{-m}) para inicializar @code{__main__} apropiadamente en los procesos hijos cuando se utilizan los métodos de inicio @code{spawn} o @code{forkserver}. Esto resuelve algunos casos extremos en los que la combinación de multiprocesamiento, el conmutador de línea de comandos @code{-m} y las importaciones relativas explícitas podían causar fallos oscuros en los procesos hijos.  (Contribuido por Nick Coghlan en bpo-19946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19946}.)

@node PEP 465 un nuevo operador de multiplicación de matrices a @@ b,os<11>,multiprocesamiento<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 operator}@anchor{feb}
@subsubsection PEP 465, un nuevo operador de multiplicación de matrices: @code{a @@ b}.


La nueva función @ref{fec,,length_hint()} proporciona una implementación de la especificación de cómo debe utilizarse el método especial @ref{f8e,,__length_hint__()}, como parte de la especificación formal 
@geindex Python Enhancement Proposals; PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/} de esta característica del lenguaje.  (Contribuido por Armin Ronacher en bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)

Ahora hay una versión puramente python del módulo @ref{9f,,operator} disponible como referencia y para ser utilizada por implementaciones alternativas de Python.  (Contribuido por Zachary Ware en bpo-16694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16694}.)

@node os<11>,pdb<6>,PEP 465 un nuevo operador de multiplicación de matrices a @@ b,Módulos mejorados<9>
@anchor{whatsnew/3 4 os}@anchor{fed}
@subsubsection os


Hay nuevas funciones para obtener y establecer la bandera @ref{f7c,,heritable} de un descriptor de archivo (@ref{f7d,,os.get_inheritable()}, @ref{f7e,,os.set_inheritable()}) o de un handle de Windows (@ref{f7f,,os.get_handle_inheritable()}, @ref{f80,,os.set_handle_inheritable()}).

La nueva función @ref{328,,cpu_count()} informa del número de CPUs disponibles en la plataforma en la que se está ejecutando Python (o @code{None} si no se puede determinar el recuento).  La función @ref{fee,,multiprocessing.cpu_count()} está ahora implementada en términos de esta función).  (Contribución de Trent Nelson, Yogesh Chaudhari, Victor Stinner y Charles-François Natali en bpo-17914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17914})

@ref{fef,,os.path.samestat()} está ahora disponible en la plataforma Windows (y la implementación de @ref{ff0,,os.path.samefile()} es ahora compartida entre Unix y Windows).  (Contribuido por Brian Curtin en bpo-11939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11939}.)

@ref{aa4,,os.path.ismount()} ahora reconoce los volúmenes montados por debajo de la raíz de una unidad en Windows.  (Contribuido por Tim Golden en bpo-9035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9035}.)

@ref{e18,,os.open()} supports two new flags on platforms that provide them,
@ref{ff1,,O_PATH} (un-opened file descriptor), and @ref{ff2,,O_TMPFILE}
(unnamed temporary file; as of 3.4.0 release available only on Linux systems
with a kernel version of 3.11 or newer that have uapi headers).  (Contributed
by Christian Heimes in bpo-18673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18673} and Benjamin Peterson, respectively.)

@node pdb<6>,pepinillo<2>,os<11>,Módulos mejorados<9>
@anchor{whatsnew/3 4 pdb}@anchor{ff3}
@subsubsection pdb


@ref{a5,,pdb} ha sido mejorado para manejar generadores, @ref{a5f,,yield}, y @code{yield from} de una manera más útil.  Esto es especialmente útil cuando se depuran programas basados en @ref{b,,asyncio}.  (Contribución de Andrew Svetlov y Xavier de Gaye en bpo-16596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16596})

El comando @code{print} ha sido eliminado de @ref{a5,,pdb}, restaurando el acceso a la función de Python @ref{ff4,,print()} desde la línea de comandos de la pdb.  El comando @code{pdb} de Python2 no tenía un comando @code{print}; en su lugar, al introducir @code{print} se ejecutaba la sentencia @code{print}.  En Python3 @code{print} se convirtió por error en un alias del comando pdb @ref{ff5,,p}.  Sin embargo, @code{p} imprime la @code{repr} de su argumento, no la @code{str} como hacía el comando @code{print} de Python2.  Peor aún, el comando @code{pdb print} de Python3 ensombrece la función @code{print} de Python3, haciéndola inaccesible en el prompt de @code{pdb}.  (Contribuido por Connor Osborn en bpo-18764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18764}.)

@node pepinillo<2>,plistlib<2>,pdb<6>,Módulos mejorados<9>
@anchor{whatsnew/3 4 pickle}@anchor{ff6}@anchor{whatsnew/3 4 whatsnew-protocol-4}@anchor{f66}
@subsubsection pepinillo


@ref{a6,,pickle} ahora soporta (pero no utiliza por defecto) un nuevo protocolo pickle, el protocolo 4.  Este nuevo protocolo aborda una serie de problemas que estaban presentes en los protocolos anteriores, como la serialización de clases anidadas, cadenas y contenedores muy grandes, y clases cuyo método @code{__new__()} toma argumentos de sólo palabras clave.  También proporciona algunas mejoras de eficiencia.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3154

@item PEP 3154@footnote{https://peps.python.org/pep-3154/} – Protocolo Pickle 4

PEP escrito por Antoine Pitrou e implementado por Alexandre Vassalotti.
@end table


@node plistlib<2>,poplib<3>,pepinillo<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 plistlib}@anchor{ff7}
@subsubsection plistlib


@ref{ab,,plistlib} now has an API that is similar to the standard pattern for
stdlib serialization protocols, with new @ref{9e2,,load()},
@ref{9e4,,dump()}, @ref{9e3,,loads()}, and @ref{9e5,,dumps()}
functions.  (The older API is now deprecated.)  In addition to the already
supported XML plist format (@ref{ff8,,FMT_XML}), it also now supports
the binary plist format (@ref{ff9,,FMT_BINARY}).  (Contributed by Ronald
Oussoren and others in bpo-14455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14455}.)

@node poplib<3>,pprint<4>,plistlib<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 poplib}@anchor{ffa}
@subsubsection poplib


Se han añadido dos nuevos métodos a @ref{ac,,poplib}: @ref{ffb,,capa()}, que devuelve la lista de capacidades anunciadas por el servidor POP, y @ref{ffc,,stls()}, que cambia una sesión POP3 de texto claro a una sesión POP3 cifrada si el servidor POP lo soporta.  (Contribuido por Lorenzo Catucci en bpo-4473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4473}.)

@node pprint<4>,pty<2>,poplib<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 pprint}@anchor{ffd}
@subsubsection pprint


La clase @ref{ffe,,PrettyPrinter} del módulo @ref{ae,,pprint} y sus funciones @ref{fff,,pformat()}, y @ref{8bf,,pprint()} tienen una nueva opción, `compact', que controla cómo se formatea la salida.  Actualmente, establecer `compact' a @code{True} significa que las secuencias se imprimirán con tantos elementos de secuencia como quepan en el `ancho' de cada línea (indentada). (Contribuido por Serhiy Storchaka en bpo-19132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19132}.)

Las cadenas largas ahora se envuelven usando la sintaxis normal de continuación de línea de Python.  (Contribuido por Antoine Pitrou en bpo-17150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17150}.)

@node pty<2>,pydoc<3>,pprint<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 pty}@anchor{1000}
@subsubsection pty


@ref{1001,,pty.spawn()} ahora devuelve el valor de estado de @ref{e20,,os.waitpid()} en el proceso hijo, en lugar de @code{None}.  (Contribución de Gregory P. Smith)

@node pydoc<3>,re<8>,pty<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 pydoc}@anchor{1002}
@subsubsection pydoc


El módulo @ref{b5,,pydoc} se basa ahora directamente en la API de introspección @ref{181,,inspect.signature()}, lo que le permite proporcionar información de firma para una mayor variedad de objetos invocables. Este cambio también significa que los atributos @code{__wrapped__} se tienen ahora en cuenta al mostrar la información de ayuda. (Contribución de Larry Hastings en bpo-19674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19674}.)

El módulo @ref{b5,,pydoc} ya no muestra el parámetro @code{self} para los métodos ya vinculados. En su lugar, pretende mostrar siempre la firma actual exacta de la llamada suministrada.  (Contribuido por Larry Hastings en bpo-20710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20710}.)

Además de los cambios que se han realizado en @ref{b5,,pydoc} directamente, su manejo de los métodos personalizados @code{__dir__} y varios comportamientos del descriptor también se han mejorado sustancialmente por los cambios subyacentes en el módulo @ref{7e,,inspect}.

Como el builtin @ref{96e,,help()} está basado en @ref{b5,,pydoc}, los cambios anteriores también afectan al comportamiento de @ref{96e,,help()}.

@node re<8>,recurso,pydoc<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 re}@anchor{1003}
@subsubsection re


La nueva función @ref{1004,,fullmatch()} y el método @code{regex.fullmatch()} anclan el patrón en ambos extremos de la cadena a comparar.  Esto proporciona una manera de ser explícito sobre el objetivo de la coincidencia, lo que evita una clase de errores sutiles donde los caracteres @code{$} se pierden durante los cambios de código o la adición de alternativas a una expresión regular existente.  (Contribuido por Matthew Barnett en bpo-16203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16203}.)

La repr de los @ref{1005,,regex objects} ahora incluye el patrón y las banderas; la repr de los @ref{1006,,objetos regex} ahora incluye el inicio, el final y la parte de la cadena que coincide.  (Contribución de Hugo Lopes Tavares y Serhiy Storchaka en bpo-13592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13592} y bpo-17087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17087})

@node recurso,seleccionar,re<8>,Módulos mejorados<9>
@anchor{whatsnew/3 4 resource}@anchor{1007}
@subsubsection recurso


La nueva función @ref{1008,,prlimit()}, disponible en plataformas Linux con un kernel de versión 2.6.36 o posterior y glibc de 2.13 o posterior, proporciona la capacidad de consultar o establecer los límites de recursos para procesos distintos del que realiza la llamada.  (Contribuido por Christian Heimes en bpo-16595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16595}.)

On Linux kernel version 2.6.36 or later, there are also some new
Linux specific constants: @ref{1009,,RLIMIT_MSGQUEUE},
@ref{100a,,RLIMIT_NICE}, @ref{100b,,RLIMIT_RTPRIO},
@ref{100c,,RLIMIT_RTTIME}, and @ref{100d,,RLIMIT_SIGPENDING}.
(Contributed by Christian Heimes in bpo-19324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19324}.)

On FreeBSD version 9 and later, there some new FreeBSD specific constants:
@ref{100e,,RLIMIT_SBSIZE}, @ref{100f,,RLIMIT_SWAP}, and
@ref{1010,,RLIMIT_NPTS}.  (Contributed by Claudiu Popa in
bpo-19343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19343}.)

@node seleccionar,estante,recurso,Módulos mejorados<9>
@anchor{whatsnew/3 4 select}@anchor{1011}
@subsubsection seleccionar


Los objetos @ref{1012,,epoll} ahora soportan el protocolo de gestión de contexto. Cuando se utiliza en una declaración @ref{673,,with}, el método @ref{1013,,close()} será llamado automáticamente al final del bloque.  (Contribuido por Serhiy Storchaka en bpo-16488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16488}.)

Los objetos @ref{1014,,devpoll} tienen ahora métodos @ref{1015,,fileno()} y @ref{1016,,close()}, así como un nuevo atributo @ref{1017,,closed}.  (Contribuido por Victor Stinner en bpo-18794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18794}.)

@node estante,shutil<5>,seleccionar,Módulos mejorados<9>
@anchor{whatsnew/3 4 shelve}@anchor{1018}
@subsubsection estante


Las instancias de @ref{1019,,Shelf} ahora pueden utilizarse en declaraciones @ref{673,,with}, y se cerrarán automáticamente al final del bloque @code{with}. (Contribuido por Filip Gruszczyński en bpo-13896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13896}.)

@node shutil<5>,smtpd<3>,estante,Módulos mejorados<9>
@anchor{whatsnew/3 4 shutil}@anchor{101a}
@subsubsection shutil


@ref{aea,,copyfile()} ahora lanza una subclase específica de @ref{101b,,Error}, @ref{101c,,SameFileError}, cuando el origen y el destino son el mismo fichero, lo que permite a una aplicación tomar la acción apropiada en este error específico.  (Contribución de Atsuo Ishimoto y Hynek Schlawack en bpo-1492704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1492704})

@node smtpd<3>,smtplib<3>,shutil<5>,Módulos mejorados<9>
@anchor{whatsnew/3 4 smtpd}@anchor{101d}
@subsubsection smtpd


The @code{SMTPServer} and @code{SMTPChannel} classes now
accept a `map' keyword argument which, if specified, is passed in to
@code{asynchat.async_chat} as its `map' argument.  This allows an application
to avoid affecting the global socket map.  (Contributed by Vinay Sajip in
bpo-11959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11959}.)

@node smtplib<3>,enchufe<5>,smtpd<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 smtplib}@anchor{101e}
@subsubsection smtplib


@ref{101f,,SMTPException} es ahora una subclase de @ref{4d5,,OSError}, que permite que tanto los errores de nivel de socket como los de nivel de protocolo SMTP sean capturados en una sentencia try/except por un código que sólo se preocupa de si se ha producido o no un error. (Contribuido por Ned Jackson Lovely en bpo-2118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2118}.)

@node enchufe<5>,sqlite3<10>,smtplib<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 socket}@anchor{1020}
@subsubsection enchufe


The socket module now supports the @ref{1021,,CAN_BCM} protocol on
platforms that support it.  (Contributed by Brian Thorne in bpo-15359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15359}.)

Los objetos Socket tienen nuevos métodos para obtener o establecer su @ref{f7c,,bandera heredable}, @ref{f81,,get_inheritable()} y @ref{f82,,set_inheritable()}.

Las constantes @code{socket.AF_*} y @code{socket.SOCK_*} son ahora valores de enumeración utilizando el nuevo módulo @ref{56,,enum}.  Esto permite imprimir nombres significativos durante la depuración, en lugar de «números mágicos» enteros.

The @ref{1022,,AF_LINK} constant is now available on BSD and OSX.

@ref{9f5,,inet_pton()} y @ref{1023,,inet_ntop()} son ahora compatibles con Windows.  (Contribuido por Atsuo Ishimoto en bpo-7171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7171}.)

@node sqlite3<10>,ssl<10>,enchufe<5>,Módulos mejorados<9>
@anchor{whatsnew/3 4 sqlite3}@anchor{1024}
@subsubsection sqlite3


Un nuevo parámetro booleano para la función @ref{3f5,,connect()}, `uri', puede usarse para indicar que el parámetro `base de datos' es una @code{uri} (véase la documentación SQLite URI@footnote{https://www.sqlite.org/uri.html}).  (Contribuido por poq en bpo-13773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13773}.)

@node ssl<10>,stat,sqlite3<10>,Módulos mejorados<9>
@anchor{whatsnew/3 4 ssl}@anchor{1025}
@subsubsection ssl

@anchor{whatsnew/3 4 whatsnew-tls-11-12}@anchor{f6a}
Se han añadido @ref{1026,,PROTOCOL_TLSv1_1} y @ref{1027,,PROTOCOL_TLSv1_2} (soporte de TLSv1.1 y TLSv1.2); el soporte de estos protocolos sólo está disponible si Python está enlazado con OpenSSL 1.0.1 o posterior.  (Contribuido por Michele Orrù y Antoine Pitrou en bpo-16692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16692})
@anchor{whatsnew/3 4 whatsnew34-sslcontext}@anchor{f6d}
La nueva función @ref{2c1,,create_default_context()} proporciona una forma estándar de obtener un @ref{1fa,,SSLContext} cuya configuración pretende ser un equilibrio razonable entre compatibilidad y seguridad.  Estos ajustes son más estrictos que los valores por defecto proporcionados por el constructor @ref{1fa,,SSLContext}, y pueden ser ajustados en el futuro, sin necesidad de una depreciación previa, si los requisitos de seguridad de las mejores prácticas cambian.  La nueva práctica recomendada para usar las bibliotecas stdlib que soportan SSL es usar @ref{2c1,,create_default_context()} para obtener un objeto @ref{1fa,,SSLContext}, modificarlo si es necesario, y luego pasarlo como el argumento `context' de la API stdlib apropiada.  (Contribuido por Christian Heimes en bpo-19689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19689}.)

El método @ref{1fa,,SSLContext} @ref{f6e,,load_verify_locations()} acepta un nuevo argumento opcional `cadata', que puede utilizarse para proporcionar certificados codificados en PEM o DER directamente mediante cadenas o bytes, respectivamente. (Contribuido por Christian Heimes en bpo-18138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18138}.)

La nueva función @ref{1028,,get_default_verify_paths()} devuelve una tupla con nombre de las rutas y variables de entorno que el método @ref{1029,,set_default_verify_paths()} utiliza para establecer el @code{cafile} y el @code{capath} por defecto de OpenSSL.  Esto puede ser una ayuda para depurar problemas de verificación por defecto.  (Contribuido por Christian Heimes en bpo-18143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18143}.)

@ref{1fa,,SSLContext} tiene un nuevo método, @ref{102a,,cert_store_stats()}, que informa del número de certificados @code{X.509} cargados, certificados @code{X.509 CA} y listas de revocación de certificados (@code{crl}), así como un método @ref{102b,,get_ca_certs()} que devuelve una lista de los certificados @code{CA} cargados.  (Contribuido por Christian Heimes en bpo-18147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18147}.)

If OpenSSL 0.9.8 or later is available, @ref{1fa,,SSLContext} has a new
attribute @ref{102c,,verify_flags} that can be used to control the
certificate verification process by setting it to some combination of the new
constants @ref{102d,,VERIFY_DEFAULT}, @ref{102e,,VERIFY_CRL_CHECK_LEAF},
@ref{102f,,VERIFY_CRL_CHECK_CHAIN}, or @ref{2c3,,VERIFY_X509_STRICT}.
OpenSSL does not do any CRL verification by default.  (Contributed by
Christien Heimes in bpo-8813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8813}.)

Nuevo método @ref{1fa,,SSLContext} @ref{1030,,load_default_certs()} carga un conjunto de certificados de «autoridad de certificación» (CA) por defecto desde ubicaciones predeterminadas, que varían según la plataforma.  Puede utilizarse para cargar tanto certificados de autenticación de servidores web TLS (@code{purpose=}@ref{1031,,SERVER_AUTH}) para que un cliente los utilice para verificar un servidor, como certificados para que un servidor los utilice para verificar certificados de clientes (@code{purpose=}@ref{1032,,CLIENT_AUTH}).  (Contribuido por Christian Heimes en bpo-19292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19292}.)
@anchor{whatsnew/3 4 whatsnew34-win-cert-store}@anchor{f6b}
Dos nuevas funciones sólo para Windows, @ref{1033,,enum_certificates()} y @ref{1034,,enum_crls()} ofrecen la posibilidad de recuperar certificados, información de certificados y CRLs del almacén de certificados de Windows.  (Contribuido por Christian Heimes en bpo-17134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17134}.)
@anchor{whatsnew/3 4 whatsnew34-sni}@anchor{f6c}
Soporte para SNI (Server Name Indication) del lado del servidor utilizando el nuevo método @ref{1035,,ssl.SSLContext.set_servername_callback()}. (Contribuido por Daniel Black en bpo-8109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8109}.)

El diccionario devuelto por @ref{1036,,SSLSocket.getpeercert()} contiene elementos de extensión @code{X509v3} adicionales: @code{crlDistributionPoints}, @code{calIssuers}, y @code{OCSP} URIs.  (Contribución de Christian Heimes en bpo-18379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18379}.)

@node stat,struct,ssl<10>,Módulos mejorados<9>
@anchor{whatsnew/3 4 stat}@anchor{1037}
@subsubsection stat


The @ref{d1,,stat} module is now backed by a C implementation in @code{_stat}. A C
implementation is required as most of the values aren’t standardized and
are platform-dependent.  (Contributed by Christian Heimes in bpo-11016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11016}.)

The module supports new @ref{1038,,ST_MODE} flags, @ref{1039,,S_IFDOOR},
@ref{103a,,S_IFPORT}, and @ref{103b,,S_IFWHT}.  (Contributed by
Christian Hiemes in bpo-11016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11016}.)

@node struct,subproceso<2>,stat,Módulos mejorados<9>
@anchor{whatsnew/3 4 struct}@anchor{103c}
@subsubsection struct


La nueva función @ref{103d,,iter_unpack} y un nuevo método @ref{103e,,struct.Struct.iter_unpack()} en formatos compilados proporcionan un desempaquetado en flujo de un buffer que contiene instancias repetidas de un formato de datos dado. (Contribuido por Antoine Pitrou en bpo-17804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17804}.)

@node subproceso<2>,sunau<2>,struct,Módulos mejorados<9>
@anchor{whatsnew/3 4 subprocess}@anchor{103f}
@subsubsection subproceso


@ref{1040,,check_output()} acepta ahora un argumento `input' que puede utilizarse para proporcionar el contenido de @code{stdin} para el comando que se ejecuta. (Contribuido por Zack Weinberg en bpo-16624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16624}.)

@code{getstatus()} y @ref{1041,,getstatusoutput()} ahora funcionan en Windows.  Este cambio se realizó inadvertidamente en la versión 3.3.4. (Contribuido por Tim Golden en bpo-10197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10197}.)

@node sunau<2>,sys<11>,subproceso<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 sunau}@anchor{1042}
@subsubsection sunau


The @code{getparams()} method now returns a namedtuple rather than a
plain tuple.  (Contributed by Claudiu Popa in bpo-18901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18901}.)

@code{sunau.open()} now supports the context management protocol: when used in a
@ref{673,,with} block, the @code{close} method of the returned object will be
called automatically at the end of the block.  (Contributed by Serhiy Storchaka
in bpo-18878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18878}.)

@code{AU_write.setsampwidth()} ahora soporta muestras de 24 bits, añadiendo así soporte para escribir 24 muestras usando el módulo.  (Contribuido por Serhiy Storchaka en bpo-19261@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19261}.)

The @code{writeframesraw()} and
@code{writeframes()} methods now accept any @ref{db4,,bytes-like object}.  (Contributed by Serhiy Storchaka in bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node sys<11>,tarfile<7>,sunau<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 sys}@anchor{1043}
@subsubsection sys


La nueva función @ref{1044,,sys.getallocatedblocks()} devuelve el número actual de bloques asignados por el intérprete.  (En CPython con la configuración por defecto @code{--with-pymalloc}, se trata de asignaciones realizadas a través de la API @ref{cf0,,PyObject_Malloc()})  Esto puede ser útil para rastrear las fugas de memoria, especialmente si se automatiza a través de un conjunto de pruebas.  (Contribuido por Antoine Pitrou en bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390}.)

Cuando el intérprete de Python se inicia en @ref{1045,,modo interactivo}, busca un atributo @ref{1046,,__interactivehook__} en el módulo @ref{d9,,sys}.  Si el atributo existe, se llama a su valor sin argumentos justo antes de iniciar el modo interactivo.  La comprobación se realiza después de leer el fichero 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}, por lo que puede establecerse allí.  El módulo @ref{c7,,site} @ref{1048,,lo establece} a una función que permite completar el tabulador y guardar el historial (en @code{~/.python-history}) si la plataforma soporta @ref{ba,,readline}.  Si no quiere este (nuevo) comportamiento, puede anularlo en 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}, @ref{c8,,sitecustomize}, o @ref{10e,,usercustomize} borrando este atributo de @ref{d9,,sys} (o poniéndolo en alguna otra llamada).  (Contribuido por Éric Araujo y Antoine Pitrou en bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845}.)

@node tarfile<7>,textwrap,sys<11>,Módulos mejorados<9>
@anchor{whatsnew/3 4 tarfile}@anchor{1049}
@subsubsection tarfile


El módulo @ref{de,,tarfile} soporta ahora una simple @ref{104a,,Interfaz de línea de comandos} cuando se llama como un script directamente o a través de @code{-m}.  Esto puede utilizarse para crear y extraer archivos tarfile.  (Contribuido por Berker Peksag en bpo-13477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13477}.)

@node textwrap,roscado,tarfile<7>,Módulos mejorados<9>
@anchor{whatsnew/3 4 textwrap}@anchor{104b}
@subsubsection textwrap


La clase @ref{104c,,TextWrapper} tiene dos nuevos atributos/argumentos de construcción: @ref{104d,,max_lines}, que limita el número de líneas en la salida, y @ref{104e,,placeholder}, que es una cadena que aparecerá al final de la salida si se ha truncado debido a `max_lines'.  Basándose en estas capacidades, una nueva función de conveniencia @ref{104f,,shorten()} colapsa todos los espacios en blanco de la entrada a espacios simples y produce una sola línea de un `ancho' dado que termina con el `marcador de posición' (por defecto, @code{[...]}).  (Contribuido por Antoine Pitrou y Serhiy Storchaka en bpo-18585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18585} y bpo-18725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18725})

@node roscado,traceback<3>,textwrap,Módulos mejorados<9>
@anchor{whatsnew/3 4 threading}@anchor{1050}
@subsubsection roscado


El objeto @ref{9df,,Thread} que representa el hilo principal puede obtenerse de la nueva función @ref{1051,,main_thread()}.  En condiciones normales será el hilo desde el que se inició el intérprete de Python.  (Contribuido por Andrew Svetlov en bpo-18882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18882}.)

@node traceback<3>,tipos<2>,roscado,Módulos mejorados<9>
@anchor{whatsnew/3 4 traceback}@anchor{1052}
@subsubsection traceback


Una nueva función @ref{1053,,traceback.clear_frames()} toma un objeto traceback y borra las variables locales en todos los marcos a los que hace referencia, reduciendo la cantidad de memoria consumida.  (Contribuido por Andrew Kuchling en bpo-1565525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1565525}.)

@node tipos<2>,urllib<4>,traceback<3>,Módulos mejorados<9>
@anchor{whatsnew/3 4 types}@anchor{1054}
@subsubsection tipos


Un nuevo descriptor @ref{6cb,,DynamicClassAttribute()} proporciona una forma de definir un atributo que actúa normalmente cuando se busca a través de un objeto instancia, pero que se dirige a la `clase' @code{__getattr__} cuando se busca a través de la clase.  Esto permite tener propiedades activas en una clase, y tener atributos virtuales en la clase con el mismo nombre (ver @code{Enum} para un ejemplo). (Contribuido por Ethan Furman en bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030}.)

@node urllib<4>,unittest<8>,tipos<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 urllib}@anchor{1055}
@subsubsection urllib


@ref{10b,,urllib.request} ahora soporta URLs @code{data:} a través de la clase @ref{1056,,DataHandler}.  (Contribuido por Mathias Panzenböck en bpo-16423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16423}.)

El método http que será utilizado por una clase @ref{1057,,Request} puede ahora especificarse estableciendo un atributo de clase @ref{1058,,method} en la subclase.  (Contribuido por Jason R Coombs en bpo-18978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18978}.)

Los objetos @ref{1057,,Request} son ahora reutilizables: si los atributos @ref{1059,,full_url} o @ref{105a,,data} se modifican, todas las propiedades internas relevantes se actualizan.  Esto significa, por ejemplo, que ahora es posible utilizar el mismo objeto @ref{1057,,Request} en más de una llamada @ref{105b,,OpenerDirector.open()} con diferentes argumentos `data', o modificar la @code{url} de un @code{Request`} en lugar de volver a calcularla desde cero.  También hay un nuevo método @ref{105c,,remove_header()} que puede utilizarse para eliminar las cabeceras de una @ref{1057,,Request}.  (Contribuido por Alexey Kachayev en bpo-16464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16464}, Daniel Wozniak en bpo-17485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17485}, y Damien Brecht y Senthil Kumaran en bpo-17272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17272})

Los objetos @ref{105d,,HTTPError} tienen ahora un atributo @ref{105e,,headers} que proporciona acceso a las cabeceras de respuesta HTTP asociadas al error.  (Contribuido por Berker Peksag en bpo-15701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15701}.)

@node unittest<8>,venv<7>,urllib<4>,Módulos mejorados<9>
@anchor{whatsnew/3 4 unittest}@anchor{105f}
@subsubsection unittest


La clase @ref{4fa,,TestCase} tiene un nuevo método, @ref{1060,,subTest()}, que produce un gestor de contexto cuyo bloque @ref{673,,with} se convierte en una «subprueba». Este gestor de contexto permite que un método de prueba genere subpruebas dinámicamente, por ejemplo, llamando al gestor de contexto @code{subTest} dentro de un bucle. Por lo tanto, un solo método de prueba puede producir un número indefinido de pruebas identificadas y contadas por separado, todas las cuales se ejecutarán incluso si una o más de ellas fallan. Por ejemplo:

@example
class NumbersTest(unittest.TestCase):
    def test_even(self):
        for i in range(6):
            with self.subTest(i=i):
                self.assertEqual(i % 2, 0)
@end example

dará como resultado seis subpruebas, cada una identificada en la salida verbose de unittest con una etiqueta que consiste en el nombre de la variable @code{i} y un valor particular para esa variable (@code{i=0}, @code{i=1}, etc).  Consulte la versión completa de este ejemplo en @ref{1061,,Distinguiendo iteraciones de tests empleando subtests}.  (Contribuido por Antoine Pitrou en bpo-16997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16997}.)

@ref{1062,,unittest.main()} ahora acepta un iterable de nombres de pruebas para `defaultTest', donde antes sólo aceptaba un único nombre de prueba como cadena.  (Contribuido por Jyrki Pulliainen en bpo-15132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15132}.)

Si @ref{1063,,SkipTest} se lanza durante el descubrimiento de la prueba (es decir, en el nivel de módulo en el archivo de prueba), ahora se reporta como un salto en lugar de un error.  (Contribuido por Zach Ware en bpo-16935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16935}.)

@ref{1064,,discover()} ahora ordena los archivos descubiertos para proporcionar un orden de pruebas consistente.  (Contribuido por Martin Melin y Jeff Ramnani en bpo-16709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16709}.)

@ref{e79,,TestSuite} ahora elimina las referencias a las pruebas tan pronto como la prueba se ha ejecutado, si la prueba tiene éxito.  En los intérpretes de Python que hacen recolección de basura, esto permite que las pruebas sean recolectadas si no hay nada más que mantenga una referencia a la prueba.  Es posible anular este comportamiento creando una subclase @ref{e79,,TestSuite} que defina un método personalizado @code{_removeTestAtIndex}.  (Contribución de Tom Wardill, Matt McClure y Andrew Svetlov en bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798})

Un nuevo gestor de contexto de aserción de pruebas, @ref{8f0,,assertLogs()}, asegurará que un bloque de código dado emita un mensaje de registro utilizando el módulo @ref{87,,logging}.  Por defecto, el mensaje puede provenir de cualquier registrador y tener una prioridad de @code{INFO} o superior, pero se puede especificar tanto el nombre del registrador como un nivel de registro mínimo alternativo.  El objeto devuelto por el gestor de contexto puede ser consultado para los mensajes @ref{1065,,LogRecord} s y/o formateados que fueron registrados.  (Contribuido por Antoine Pitrou en bpo-18937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18937}.)

El descubrimiento de pruebas ahora funciona con paquetes de espacios de nombres (Contribuido por Claudiu Popa en bpo-17457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17457}.)

Los objetos @ref{107,,unittest.mock} ahora inspeccionan sus firmas de especificación cuando coinciden con las llamadas, lo que significa que un argumento ahora puede coincidir por posición o por nombre, en lugar de sólo por posición.  (Contribuido por Antoine Pitrou en bpo-17015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17015}.)

Los objetos @code{mock_open()} tienen ahora métodos @code{readline} y @code{readlines}.  (Contribuido por Toshio Kuratomi en bpo-17467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17467}.)

@node venv<7>,onda,unittest<8>,Módulos mejorados<9>
@anchor{whatsnew/3 4 venv}@anchor{1066}
@subsubsection venv


@ref{111,,venv} incluye ahora scripts de activación para los shells @code{csh} y @code{fish}.  (Contribuido por Andrew Svetlov en bpo-15417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15417}.)

@ref{3c1,,EnvBuilder} y la función de conveniencia @ref{3c2,,create()} toman un nuevo argumento de palabra clave `with_pip', que por defecto es @code{False}, que controla si @ref{3c1,,EnvBuilder} asegura que @code{pip} está instalado en el entorno virtual.  (Contribuido por Nick Coghlan en bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} como parte de la implementación de 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/})

@node onda,weakref<2>,venv<7>,Módulos mejorados<9>
@anchor{whatsnew/3 4 wave}@anchor{1067}
@subsubsection onda


El método @code{getparams()} ahora devuelve una tupla con nombre en lugar de una tupla simple.  (Contribuido por Claudiu Popa en bpo-17487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17487}.)

@ref{9de,,wave.open()} ahora soporta el protocolo de gestión de contexto.  (Contribuido por Claudiu Popa en bpo-17616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17616}.)

@ref{113,,wave} puede ahora @ref{1068,,escribir la salida en archivos no buscables}.  (Contribución de David Jones, Guilherme Polo y Serhiy Storchaka en bpo-5202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5202})

Los métodos @ref{1069,,writeframesraw()} y @ref{106a,,writeframes()} aceptan ahora cualquier @ref{db4,,bytes-like object}.  (Contribuido por Serhiy Storchaka en bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node weakref<2>,xml etree<2>,onda,Módulos mejorados<9>
@anchor{whatsnew/3 4 weakref}@anchor{106b}
@subsubsection weakref


La nueva clase @ref{106c,,WeakMethod} simula las referencias débiles a los métodos vinculados.  (Contribuido por Antoine Pitrou en bpo-14631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14631}.)

La nueva clase @ref{b09,,finalize} permite registrar una llamada de retorno para ser invocada cuando un objeto es recogido de la basura, sin necesidad de gestionar cuidadosamente el ciclo de vida de la propia referencia débil.  (Contribuido por Richard Oudkerk en bpo-15528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15528}.)

La llamada de retorno, si la hay, asociada a un @ref{106d,,ref} se expone ahora a través del atributo @ref{106e,,__callback__}.  (Contribuido por Mark Dickinson en bpo-17643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17643}.)

@node xml etree<2>,archivo zip<3>,weakref<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 xml-etree}@anchor{106f}
@subsubsection xml.etree


Un nuevo analizador sintáctico, @ref{1070,,XMLPullParser}, permite que una aplicación no bloqueante analice documentos XML.  Un ejemplo puede verse en @ref{1071,,API de consulta para un procesamiento no bloqueante}.  (Contribuido por Antoine Pitrou en bpo-17741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17741}.)

Las funciones @ref{125,,xml.etree.ElementTree} @ref{1072,,tostring()} y @ref{1073,,tostringlist()}, y el método @ref{9e1,,ElementTree} @code{write()}, tienen ahora un parámetro `short_empty_elements' @ref{3f4,,parámetro de solo keyword} que permite controlar si los elementos sin contenido se escriben de forma abreviada (@code{<tag />}) o expandida (@code{<tag></tag>}).  (Contribución de Ariel Poliak y Serhiy Storchaka en bpo-14377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14377})

@node archivo zip<3>,,xml etree<2>,Módulos mejorados<9>
@anchor{whatsnew/3 4 zipfile}@anchor{1074}
@subsubsection archivo zip


El método @ref{1075,,writepy()} de la clase @ref{1076,,PyZipFile} tiene una nueva opción `filterfunc' que puede utilizarse para controlar qué directorios y ficheros se añaden al archivo.  Por ejemplo, esto puede ser usado para excluir archivos de prueba del archivo. (Contribuido por Christian Tismer en bpo-19274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19274}.)

El parámetro `allowZip64' de @ref{765,,ZipFile} y @code{PyZipfile} es ahora @code{True} por defecto.  (Contribuido por William Mallard en bpo-17201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17201}.)

@node Cambios en la implementación de CPython,Obsoleto<11>,Módulos mejorados<9>,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 cpython-implementation-changes}@anchor{1077}
@subsection Cambios en la implementación de CPython


@menu
* PEP 445; Personalización de los Asignadores de Memoria de CPython: PEP 445 Personalización de los Asignadores de Memoria de CPython. 
* PEP 442; Finalización segura de objetos: PEP 442 Finalización segura de objetos. 
* PEP 456; Algoritmo Hash seguro e intercambiable: PEP 456 Algoritmo Hash seguro e intercambiable. 
* PEP 436; Clínica de Argumentación: PEP 436 Clínica de Argumentación. 
* Otros cambios en la API de construcción y C:: 
* Otras mejoras: Otras mejoras<2>. 
* Optimizaciones significativas:: 

@end menu

@node PEP 445 Personalización de los Asignadores de Memoria de CPython,PEP 442 Finalización segura de objetos,,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 pep-445-customization-of-cpython-memory-allocators}@anchor{1078}@anchor{whatsnew/3 4 whatsnew-pep-445}@anchor{f70}
@subsubsection PEP 445: Personalización de los Asignadores de Memoria de CPython


@geindex Python Enhancement Proposals; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/} añade nuevas interfaces de nivel C para personalizar la asignación de memoria en el intérprete de CPython.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 445

@item PEP 445@footnote{https://peps.python.org/pep-0445/} – Añadir nuevas APIs para personalizar los asignadores de memoria de Python

PEP escrito y aplicado por Victor Stinner.
@end table


@node PEP 442 Finalización segura de objetos,PEP 456 Algoritmo Hash seguro e intercambiable,PEP 445 Personalización de los Asignadores de Memoria de CPython,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 pep-442-safe-object-finalization}@anchor{1079}@anchor{whatsnew/3 4 whatsnew-pep-442}@anchor{f6f}
@subsubsection PEP 442: Finalización segura de objetos


@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} elimina las limitaciones y peculiaridades actuales de la finalización de objetos en CPython. Con él, los objetos con métodos @code{__del__()}, así como los generadores con cláusulas @ref{a5c,,finally}, pueden ser finalizados cuando forman parte de un ciclo de referencia.

Como parte de este cambio, los globales de los módulos ya no se establecen forzosamente a @ref{716,,None} durante el cierre del intérprete en la mayoría de los casos, sino que se confía en el funcionamiento normal del recolector de basura cíclico.  Esto evita toda una clase de errores durante el cierre del intérprete, normalmente relacionados con los métodos @code{del__}, que han afectado a Python desde que se introdujo el GC cíclico.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 442

@item PEP 442@footnote{https://peps.python.org/pep-0442/} – Finalización segura del objeto

PEP escrito y aplicado por Antoine Pitrou.
@end table


@node PEP 456 Algoritmo Hash seguro e intercambiable,PEP 436 Clínica de Argumentación,PEP 442 Finalización segura de objetos,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 pep-456-secure-and-interchangeable-hash-algorithm}@anchor{107a}@anchor{whatsnew/3 4 whatsnew-pep-456}@anchor{f69}
@subsubsection PEP 456: Algoritmo Hash seguro e intercambiable


@geindex Python Enhancement Proposals; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} es la continuación de un trabajo anterior de corrección de seguridad realizado en el algoritmo hash de Python para hacer frente a ciertos ataques DOS a los que pueden estar sujetas las APIs de cara al público respaldadas por búsquedas de diccionario.  (El PEP unifica el código hash de CPython para facilitar que un empaquetador sustituya un algoritmo hash diferente, y cambia la implementación por defecto de Python a una implementación SipHash en plataformas que tienen un tipo de datos de 64 bits.  Cualquier diferencia de rendimiento en comparación con el antiguo algoritmo FNV es trivial.

The PEP adds additional fields to the @ref{107b,,sys.hash_info} named tuple to
describe the hash algorithm in use by the currently executing binary.  Otherwise,
the PEP does not alter any existing CPython APIs.

@node PEP 436 Clínica de Argumentación,Otros cambios en la API de construcción y C,PEP 456 Algoritmo Hash seguro e intercambiable,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 pep-436-argument-clinic}@anchor{107c}@anchor{whatsnew/3 4 whatsnew-pep-436}@anchor{f71}
@subsubsection PEP 436: Clínica de Argumentación


«Argument Clinic» (
@geindex Python Enhancement Proposals; PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/}) es ahora parte del proceso de construcción de CPython y puede ser utilizado para simplificar el proceso de definición y mantenimiento de firmas precisas para builtins y módulos de extensión de la biblioteca estándar implementados en C.

Algunos módulos de extensión de la biblioteca estándar han sido convertidos para utilizar Argument Clinic en Python 3.4, y @ref{b5,,pydoc} y @ref{7e,,inspect} han sido actualizados en consecuencia.

Se espera que los metadatos de firma para la introspección programática se añadan a los callables adicionales implementados en C como parte de las versiones de mantenimiento de Python 3.4.

@cartouche
@quotation Nota 
El PEP de Argument Clinic no está completamente actualizado con el estado de la implementación. Esto ha sido considerado aceptable por el director de la versión y el equipo de desarrollo del núcleo en este caso, ya que Argument Clinic no estará disponible como una API pública para el uso de terceros en Python 3.4.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 436

@item PEP 436@footnote{https://peps.python.org/pep-0436/} – La clínica de argumentos DSL

PEP escrito y aplicado por Larry Hastings.
@end table


@node Otros cambios en la API de construcción y C,Otras mejoras<2>,PEP 436 Clínica de Argumentación,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 other-build-and-c-api-changes}@anchor{107d}
@subsubsection Otros cambios en la API de construcción y C



@itemize *

@item 
La nueva función @ref{934,,PyType_GetSlot()} ha sido añadida a la ABI estable, permitiendo la recuperación de punteros a funciones desde ranuras de tipos con nombre cuando se utiliza la API limitada.  (Contribuido por Martin von Löwis en bpo-17162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17162}.)

@item 
The new @code{Py_SetStandardStreamEncoding()} pre-initialization API
allows applications embedding the CPython interpreter to reliably force
a particular encoding and error handler for the standard streams.
(Contributed by Bastien Montagne and Nick Coghlan in bpo-16129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16129}.)

@item 
La mayoría de las APIs de C de Python que no mutan los argumentos de cadena están ahora correctamente marcadas como aceptando @code{const char *} en lugar de @code{char *}.  (Contribuido por Serhiy Storchaka en bpo-1772673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772673}.)

@item 
Una nueva versión de shell de @code{python-config} puede ser utilizada incluso cuando un intérprete de python no está disponible (por ejemplo, en escenarios de compilación cruzada).

@item 
@ref{47c,,PyUnicode_FromFormat()} ahora soporta especificaciones de anchura y precisión para @code{%s}, @code{%A}, @code{%U}, @code{%V}, @code{%S} y @code{%R}. (Contribución de Ysj Ray y Victor Stinner en bpo-7330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7330}.)

@item 
La nueva función @ref{107e,,PyStructSequence_InitType2()} complementa la función existente @ref{107f,,PyStructSequence_InitType()}.  La diferencia es que devuelve @code{0} en caso de éxito y @code{-1} en caso de fallo.

@item 
El código fuente de CPython puede ahora ser compilado usando las características de comprobación de sanidad de direcciones de las versiones recientes de GCC y clang: las falsas alarmas en el asignador de objetos pequeños han sido silenciadas.  (Contribuido por Dhiru Kholia en bpo-18596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18596}.)

@item 
La versión de Windows utiliza ahora Address Space Layout Randomization@footnote{https://en.wikipedia.org/wiki/Address_space_layout_randomization} y Data Execution Prevention@footnote{https://en.wikipedia.org/wiki/Data_Execution_Prevention}.  (Contribuido por Christian Heimes en bpo-16632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16632}.)

@item 
La nueva función @ref{1080,,PyObject_LengthHint()} es el equivalente en la API de C de @ref{fec,,operator.length_hint()}.  (Contribuido por Armin Ronacher en bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)
@end itemize

@node Otras mejoras<2>,Optimizaciones significativas,Otros cambios en la API de construcción y C,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 other-improvements}@anchor{1081}@anchor{whatsnew/3 4 other-improvements-3-4}@anchor{1082}
@subsubsection Otras mejoras

@anchor{whatsnew/3 4 whatsnew-isolated-mode}@anchor{f5a}

@itemize *

@item 
The @ref{1083,,python} command has a new @ref{1084,,option}, @code{-I}, which causes it to run in «isolated mode»,
which means that @ref{27e,,sys.path} contains neither the script’s directory nor
the user’s @code{site-packages} directory, and all @code{PYTHON*} environment
variables are ignored (it implies both @code{-s} and @code{-E}).  Other
restrictions may also be applied in the future, with the goal being to
isolate the execution of a script from the user’s environment.  This is
appropriate, for example, when Python is used to run a system script.  On
most POSIX systems it can and should be used in the @code{#!} line of system
scripts.  (Contributed by Christian Heimes in bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499}.)

@item 
El completamiento de tabulaciones está ahora habilitado por defecto en el intérprete interactivo en los sistemas que soportan @ref{ba,,readline}.  El historial también está activado por defecto, y se escribe (y se lee) en el archivo @code{~/.python-history}. (Contribuido por Antoine Pitrou y Éric Araujo en bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845}.)

@item 
La invocación del intérprete de Python con @code{--versión} ahora muestra la versión en la salida estándar en lugar de en el error estándar (bpo-18338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18338}). Se han realizado cambios similares en @ref{7,,argparse} (bpo-18920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18920}) y en otros módulos que tienen capacidades de invocación tipo script (bpo-18922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18922}).

@item 
El instalador de CPython para Windows añade ahora @code{.py} a la variable 
@geindex PATHEXT
@geindex variables de entorno; PATHEXT
@code{PATHEXT} cuando se registran las extensiones, permitiendo a los usuarios ejecutar un script de python en el símbolo del sistema de Windows con sólo escribir su nombre sin la extensión @code{.py}.  (Contribuido por Paul Moore en bpo-18569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18569}.)

@item 
A new @code{make} target coverage-report@footnote{https://devguide.python.org/coverage/#measuring-coverage-of-c-code-with-gcov-and-lcov}
will build python, run the test suite, and generate an HTML coverage report
for the C codebase using @code{gcov} and lcov@footnote{https://github.com/linux-test-project/lcov}.

@item 
The @code{-R} option to the @ref{1085,,python regression test suite} now
also checks for memory allocation leaks, using
@ref{1044,,sys.getallocatedblocks()}.  (Contributed by Antoine Pitrou in
bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390}.)

@item 
@code{python -m} ahora funciona con paquetes de espacios de nombres.

@item 
El módulo @ref{d1,,stat} está ahora implementado en C, lo que significa que obtiene los valores de sus constantes de los archivos de cabecera de C, en lugar de tener los valores codificados en el módulo de python como ocurría anteriormente.

@item 
La carga de múltiples módulos de python desde un único módulo del sistema operativo (@code{.so}, @code{.dll}) ahora funciona correctamente (antes devolvía silenciosamente el primer módulo de python del archivo).  (Contribuido por Václav Šmilauer en bpo-16421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16421}.)

@item 
Se ha añadido un nuevo opcode, @code{LOAD_CLASSDEREF}, para corregir un error en la carga de variables libres en los cuerpos de las clases que podía ser provocado por ciertos usos de @ref{ce6,,__prepare__}.  (Contribuido por Benjamin Peterson en bpo-17853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17853}.)

@item 
Victor Stinner identificó y corrigió una serie de fallos relacionados con MemoryError utilizando su herramienta @code{pyfailmalloc} basada en 
@geindex Python Enhancement Proposals; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/} (bpo-18408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18408}, bpo-18520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18520}).

@item 
El comando @code{pyvenv} acepta ahora la opción @code{--copies} para utilizar copias en lugar de enlaces simbólicos, incluso en sistemas en los que los enlaces simbólicos son los predeterminados.  (Contribuido por Vinay Sajip en bpo-18807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18807}.)

@item 
El comando @code{pyvenv} también acepta la opción @code{--without-pip} para suprimir el arranque automático de pip en el entorno virtual.  (Contribuido por Nick Coghlan en bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} como parte de la implementación de 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/})

@item 
El nombre de la codificación es ahora opcional en el valor establecido para la variable de entorno 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING}.  Esto hace posible establecer sólo el manejador de errores, sin cambiar la codificación por defecto. (Contribuido por Serhiy Storchaka en bpo-18818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18818}.)

@item 
Las funciones del módulo @ref{14,,bz2}, @ref{8a,,lzma} y @ref{67,,gzip} ahora soportan el modo @code{x} (creación exclusiva).  (Contribución de Tim Heaney y Vajrasky Kok en bpo-19201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19201}, bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222} y bpo-19223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19223})
@end itemize

@node Optimizaciones significativas,,Otras mejoras<2>,Cambios en la implementación de CPython
@anchor{whatsnew/3 4 significant-optimizations}@anchor{1087}
@subsubsection Optimizaciones significativas



@itemize *

@item 
El decodificador de UTF-32 es ahora entre 3 y 4 veces más rápido.  (Contribuido por Serhiy Storchaka en bpo-14625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14625}.)

@item 
Se ha reducido el coste de las colisiones de hash para los conjuntos.  Cada sondeo de la tabla hash comprueba ahora una serie de pares clave/hash consecutivos y adyacentes antes de continuar haciendo sondeos aleatorios a través de la tabla hash.  Esto aprovecha la localidad de la caché para que la resolución de colisiones sea menos costosa. El esquema de resolución de colisiones puede describirse como un híbrido de sondeo lineal y direccionamiento abierto.  El número de sondeos lineales adicionales es por defecto de nueve.  Esto puede cambiarse en tiempo de compilación definiendo LINEAR_PROBES con cualquier valor.  Establezca LINEAR_PROBES=0 para desactivar completamente el sondeo lineal.  (Contribuido por Raymond Hettinger en bpo-18771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18771}.)

@item 
El intérprete comienza alrededor de 30% faster. Un par de medidas conducen a la aceleración. El intérprete carga menos módulos al iniciar, por ejemplo, los módulos @ref{b9,,re}, @ref{1e,,collections} y @ref{86,,locale} y sus dependencias ya no se importan por defecto. Se ha mejorado el módulo marshal para cargar más rápidamente el código Python compilado.  (Contribución de Antoine Pitrou, Christian Heimes y Victor Stinner en bpo-19219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19219}, bpo-19218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19218}, bpo-19209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19209}, bpo-19205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19205} y bpo-9548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9548})

@item 
@ref{8fd,,bz2.BZ2File} es ahora tan rápido o más que la versión de Python2 en la mayoría de los casos. @ref{1088,,lzma.LZMAFile} también ha sido optimizado.  (Contribuido por Serhiy Storchaka y Nadeem Vawda en bpo-16034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16034})

@item 
@ref{1089,,random.getrandbits()} es un 20%-40% más rápido para enteros pequeños (el caso de uso más común).  (Contribuido por Serhiy Storchaka en bpo-16674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16674}.)

@item 
Al aprovechar el nuevo formato de almacenamiento de las cadenas, el decapado de las cadenas es ahora significativamente más rápido.  (Contribución de Victor Stinner y Antoine Pitrou en bpo-15596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15596}.)

@item 
Se ha resuelto un problema de rendimiento en @code{io.FileIO.readall()}.  Esto afecta particularmente a Windows, y acelera significativamente el caso de canalizar cantidades significativas de datos a través de @ref{d6,,subprocess}.  (Contribuido por Richard Oudkerk en bpo-15758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15758}.)

@item 
@ref{108a,,html.escape()} es ahora 10 veces más rápido.  (Contribuido por Matt Bryant en bpo-18020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18020}.)

@item 
En Windows, ahora se utiliza el @code{VirtualAlloc} nativo en lugar del @code{malloc} de CRT en @code{obmalloc}.  Los benchmarks artificiales muestran un ahorro de memoria de alrededor del 3%.

@item 
@ref{5c6,,os.urandom()} ahora usa un descriptor de archivo persistente abierto de forma diferida para evitar el uso de muchos descriptores de archivo cuando se ejecuta en paralelo desde varios subprocesos. (Aportado por Antoine Pitrou en bpo-18756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18756}.)
@end itemize

@node Obsoleto<11>,Removido,Cambios en la implementación de CPython,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 deprecated}@anchor{108b}@anchor{whatsnew/3 4 deprecated-3-4}@anchor{f89}
@subsection Obsoleto


Esta sección cubre varias APIs y otras características que han sido desaprobadas en Python 3.4, y que serán eliminadas en Python 3.5 o posterior.  En la mayoría de los casos (pero no en todos), el uso de las APIs obsoletas producirá un @ref{1da,,DeprecationWarning} cuando el intérprete se ejecute con las advertencias de obturación activadas (por ejemplo, usando @code{-Wd}).

@menu
* Desapariciones en la API de Python:: 
* Funciones obsoletas:: 

@end menu

@node Desapariciones en la API de Python,Funciones obsoletas,,Obsoleto<11>
@anchor{whatsnew/3 4 deprecations-in-the-python-api}@anchor{108c}
@subsubsection Desapariciones en la API de Python



@itemize *

@item 
As mentioned in @ref{f5c,,PEP 451; Un tipo ModuleSpec para el sistema de importación}, a number of @ref{77,,importlib}
methods and functions are deprecated: @code{importlib.find_loader()} is
replaced by @ref{3ff,,importlib.util.find_spec()};
@code{importlib.machinery.PathFinder.find_module()} is replaced by
@ref{108d,,importlib.machinery.PathFinder.find_spec()};
@code{importlib.abc.MetaPathFinder.find_module()} is replaced by
@ref{8ff,,importlib.abc.MetaPathFinder.find_spec()};
@code{importlib.abc.PathEntryFinder.find_loader()} and
@code{find_module()} are replaced by
@ref{903,,importlib.abc.PathEntryFinder.find_spec()}; all of the @code{@var{xxx}Loader} ABC
@code{load_module} methods (@code{importlib.abc.Loader.load_module()},
@code{importlib.abc.InspectLoader.load_module()},
@code{importlib.abc.FileLoader.load_module()},
@code{importlib.abc.SourceLoader.load_module()}) should no longer be
implemented, instead loaders should implement an
@code{exec_module} method
(@ref{901,,importlib.abc.Loader.exec_module()},
@ref{108e,,importlib.abc.InspectLoader.exec_module()}
@ref{108f,,importlib.abc.SourceLoader.exec_module()}) and let the import system
take care of the rest; and
@code{importlib.abc.Loader.module_repr()},
@code{importlib.util.module_for_loader()}, @code{importlib.util.set_loader()},
and @code{importlib.util.set_package()} are no longer needed because their
functions are now handled automatically by the import system.

@item 
The @code{imp} module is pending deprecation. To keep compatibility with
Python 2/3 code bases, the module’s removal is currently not scheduled.

@item 
El módulo @code{formatter} está pendiente de desaprobación y está previsto que se elimine en Python 3.6.

@item 
@code{MD5} como `digestmod' por defecto para la función @ref{b2a,,hmac.new()} está en desuso.  Python 3.6 requerirá un nombre de compendio o constructor explícito como argumento `digestmod'.

@item 
La clase interna @code{Netrc} en el módulo @ref{5e,,ftplib} ha sido documentada como obsoleta en su docstring durante bastante tiempo.  Ahora emite un @ref{1da,,DeprecationWarning} y se eliminará por completo en Python 3.5.

@item 
El argumento indocumentado `endtime' de @ref{d6b,,subprocess.Popen.wait()} no debería haber sido expuesto y es de esperar que no esté en uso; es obsoleto y muy probablemente será eliminado en Python 3.5.

@item 
El argumento `strict' de @ref{90e,,HTMLParser} está obsoleto.

@item 
Las funciones @ref{ab,,plistlib} @code{readPlist()}, @code{writePlist()}, @code{readPlistFromBytes()}, y @code{writePlistToBytes()} quedan obsoletas en favor de las correspondientes nuevas funciones @ref{9e2,,load()}, @ref{9e4,,dump()}, @ref{9e3,,loads()}, y @ref{9e5,,dumps()}. @code{Data()} queda obsoleta en favor de la utilización del constructor @ref{325,,bytes}.

@item 
La clave @ref{db,,sysconfig} @code{SO} está obsoleta, ha sido sustituida por @code{EXT_SUFFIX}.

@item 
El modo @code{U} aceptado por varias funciones @code{open} está obsoleto. En Python3 no hace nada útil, y debe ser reemplazado por usos apropiados de @ref{854,,io.TextIOWrapper} (si es necesario) y su argumento `newline'.

@item 
El argumento `parser' de @ref{3ca,,xml.etree.ElementTree.iterparse()} ha quedado obsoleto, al igual que el argumento `html' de @ref{ae5,,XMLParser()}.  Para prepararse para la eliminación de este último, todos los argumentos de @code{XMLParser} deben pasarse por palabra clave.
@end itemize

@node Funciones obsoletas,,Desapariciones en la API de Python,Obsoleto<11>
@anchor{whatsnew/3 4 deprecated-features}@anchor{1090}
@subsubsection Funciones obsoletas



@itemize *

@item 
La ejecución de @ref{1091,,IDLE} con la bandera @code{n} (sin subproceso) está obsoleta. Sin embargo, la función no se eliminará hasta que se resuelva el problema bpo-18823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18823}.

@item 
El módulo site que añade un directorio «site-python» a sys.path, si existe, está obsoleto (bpo-19375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19375}).
@end itemize

@node Removido,Adaptación a Python 3 4,Obsoleto<11>,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 removed}@anchor{1092}
@subsection Removido


@menu
* Sistemas operativos que ya no son compatibles:: 
* Eliminación de la API y de las funciones:: 
* Limpieza del código:: 

@end menu

@node Sistemas operativos que ya no son compatibles,Eliminación de la API y de las funciones,,Removido
@anchor{whatsnew/3 4 operating-systems-no-longer-supported}@anchor{1093}
@subsubsection Sistemas operativos que ya no son compatibles


Se ha eliminado la compatibilidad con los siguientes sistemas operativos en las herramientas de origen y de compilación:


@itemize *

@item 
OS/2 (bpo-16135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16135}).

@item 
Windows 2000 (changeset e52df05b496a).

@item 
Sistemas Windows donde @code{COMSPEC} apunta a @code{command.com} (bpo-14470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14470}).

@item 
VMS (bpo-16136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16136}).
@end itemize

@node Eliminación de la API y de las funciones,Limpieza del código,Sistemas operativos que ya no son compatibles,Removido
@anchor{whatsnew/3 4 api-and-feature-removals}@anchor{1094}
@subsubsection Eliminación de la API y de las funciones


Se han eliminado las siguientes APIs y características obsoletas y previamente obsoletas:


@itemize *

@item 
Los directorios @code{Misc/TextMate} y @code{Misc/vim} no mantenidos han sido eliminados (ver la devguide@footnote{https://devguide.python.org} para sugerencias sobre qué usar en su lugar).

@item 
Se ha eliminado la macro makefile @code{SO} (se ha sustituido por las macros @code{SHLIB_SUFFIX} y @code{EXT_SUFFIX}) (bpo-16754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16754}).

@item 
Se ha eliminado el campo @code{PyThreadState.tick_counter}; su valor no tiene sentido desde Python 3.2, cuando se introdujo el «nuevo GIL» (bpo-19199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19199}).

@item 
@code{PyLoader} y @code{PyPycLoader} han sido eliminados de @ref{77,,importlib}. (Contribuido por Taras Lyapun en bpo-15641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15641}.)

@item 
Se ha eliminado el argumento `estricto' de @ref{bc8,,HTTPConnection} y @ref{bc9,,HTTPSConnection}.  Ya no se admiten las «respuestas simples» del estilo de HTTP 0.9.

@item 
Los métodos getter y setter @ref{10b,,urllib.request} obsoletos @code{add_data}, @code{has_data}, @code{get_data}, @code{get_type}, @code{get_host}, @code{get_selector}, @code{set_proxy}, @code{get_origin_req_host}, y @code{is_unverifiable} han sido eliminados (utilice en su lugar el acceso directo a atributos).

@item 
Se ha eliminado el soporte para cargar el obsoleto @code{TYPE_INT64} de @ref{8d,,marshal}.  (Contribuido por Dan Riti en bpo-15480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15480}.)

@item 
@ref{332,,inspect.Signature}: ahora se requiere que los parámetros sólo posicionales tengan un nombre válido.

@item 
@ref{6bf,,object.__format__()} ya no acepta cadenas de formato no vacías, ahora lanza un @ref{228,,TypeError} en su lugar.  El uso de una cadena no vacía ha sido desaprobado desde Python 3.2.  Este cambio se ha hecho para evitar una situación en la que el código que antes funcionaba (pero era incorrecto) empezaba a fallar si un objeto ganaba un método __format__, lo que significa que su código puede ahora lanzar un @ref{228,,TypeError} si está usando un código de formato @code{s} con objetos que no tienen un método __format__ que lo maneje.  Véase bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994} para más información.

@item 
@code{difflib.SequenceMatcher.isbjunk()} y @code{difflib.SequenceMatcher.isbpopular()} estaban obsoletos en la 3.2, y han sido eliminados: utilice @code{x en sm.bjunk} y @code{x en sm.bpopular}, donde `sm' es un objeto @ref{1095,,SequenceMatcher} (bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}).
@end itemize

@node Limpieza del código,,Eliminación de la API y de las funciones,Removido
@anchor{whatsnew/3 4 code-cleanups}@anchor{1096}
@subsubsection Limpieza del código



@itemize *

@item 
Se ha eliminado la clase interna @code{Scanner} no utilizada y no documentada del módulo @ref{b5,,pydoc}.

@item 
Se ha eliminado el módulo privado y efectivamente inutilizado @code{_gestalt}, junto con las funciones privadas de @ref{aa,,platform} @code{_mac_ver_lookup}, @code{_mac_ver_gstalt}, y @code{_bcd2str}, que sólo habrían sido llamadas en sistemas OSX muy estropeados (ver bpo-18393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18393}).

@item 
Se han eliminado las copias codificadas de ciertas constantes @ref{d1,,stat} que se incluían en el espacio de nombres del módulo @ref{de,,tarfile}.
@end itemize

@node Adaptación a Python 3 4,Cambiado en 3 4 3,Removido,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 porting-to-python-3-4}@anchor{1097}
@subsection Adaptación a Python 3.4


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código.

@menu
* Cambios en el comportamiento del comando “python”: Cambios en el comportamiento del comando “python”<2>. 
* Cambios en la API de Python: Cambios en la API de Python<8>. 
* Cambios en la API de C: Cambios en la API de C<11>. 

@end menu

@node Cambios en el comportamiento del comando “python”<2>,Cambios en la API de Python<8>,,Adaptación a Python 3 4
@anchor{whatsnew/3 4 changes-in-python-command-behavior}@anchor{1098}
@subsubsection Cambios en el comportamiento del comando “python”



@itemize *

@item 
En un shell posix, establecer la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} a un valor vacío es equivalente a no establecerla en absoluto.  Sin embargo, establecer 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} a un valor vacío era `no' equivalente a no establecerla en absoluto: establecer 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} a un valor vacío era equivalente a establecerla a @code{.}, lo que lleva a confusión cuando se razona por analogía con el funcionamiento de 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.  El comportamiento ahora se ajusta a la convención posix para 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.

@item 
La salida [X refs, Y blocks] de una compilación de depuración (@code{--con-pydebug}) del intérprete de CPython está ahora desactivada por defecto.  Se puede volver a activar usando la opción @code{-X showrefcount}.  (Contribuido por Ezio Melotti en bpo-17323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17323}.)

@item 
El comando python y la mayoría de los scripts de stdlib (así como @ref{7,,argparse}) ahora envían la información de @code{--version} a @code{stdout} en lugar de a @code{stderr} (para la lista de problemas, véase @ref{1082,,Otras mejoras} más arriba).
@end itemize

@node Cambios en la API de Python<8>,Cambios en la API de C<11>,Cambios en el comportamiento del comando “python”<2>,Adaptación a Python 3 4
@anchor{whatsnew/3 4 changes-in-the-python-api}@anchor{109a}
@subsubsection Cambios en la API de Python



@itemize *

@item 
Los ABCs definidos en @ref{78,,importlib.abc} ahora lanzan la excepción apropiada o devuelven un valor por defecto en lugar de lanzar @ref{384,,NotImplementedError} a ciegas. Esto sólo afectará al código que llame a @ref{155,,super()} y que llegue hasta el ABC. Por compatibilidad, capture tanto @ref{384,,NotImplementedError} como la excepción apropiada según sea necesario.

@item 
The module type now initializes the @ref{1cd,,__package__} and
@ref{1e2,,__loader__}
attributes to @code{None} by default. To determine if these attributes were set
in a backwards-compatible fashion, use e.g.
@code{getattr(module, '__loader__', None) is not None}.  (bpo-17115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17115}.)

@item 
@code{importlib.util.module_for_loader()} now sets @code{__loader__} and
@code{__package__} unconditionally to properly support reloading. If this is not
desired then you will need to set these attributes manually. You can use
@code{importlib.util.module_to_load()} for module management.

@item 
Importar ahora restablece los atributos relevantes (por ejemplo, @code{__name__}, @code{__loader__}, @code{__package__}, @code{__file__}, @code{__cached__}) incondicionalmente cuando se recarga. Tenga en cuenta que esto restablece un comportamiento anterior a la versión 3.3 en el sentido de que un módulo se vuelve a encontrar cuando se recarga (bpo-19413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19413}).

@item 
Los paquetes congelados ya no establecen @code{ruta__} en una lista que contenga el nombre del paquete, ahora lo hacen en una lista vacía.  El comportamiento anterior podía hacer que el sistema de importación hiciera algo incorrecto en las importaciones de submódulos si también había un directorio con el mismo nombre que el paquete congelado.  La forma correcta de determinar si un módulo es un paquete o no es utilizar @code{hasattr(module, '__path__')} (bpo-18065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18065}).

@item 
Frozen modules no longer define a @code{__file__} attribute. It’s semantically
incorrect for frozen modules to set the attribute as they are not loaded from
any explicit location. If you must know that a module comes from frozen code
then you can see if the module’s @code{__spec__.location} is set to @code{'frozen'},
check if the loader is a subclass of
@ref{109b,,importlib.machinery.FrozenImporter},
or if Python 2 compatibility is necessary you can use @code{imp.is_frozen()}.

@item 
@ref{ab7,,py_compile.compile()} ahora lanza @ref{109c,,FileExistsError} si la ruta de archivo en la que escribiría es un enlace simbólico o un archivo no regular. Esto es para actuar como una advertencia de que la importación sobrescribirá esos archivos con un archivo regular sin importar el tipo de ruta de archivo que eran originalmente.

@item 
@ref{109d,,importlib.abc.SourceLoader.get_source()} ya no lanza @ref{4d7,,ImportError} cuando el código fuente que se carga provoca un @ref{150,,SyntaxError} o @ref{aa5,,UnicodeDecodeError}. Como @ref{4d7,,ImportError} está pensado para ser levantado sólo cuando el código fuente no puede ser encontrado pero debería, se sintió que se sobrepasaba/sobrecargaba ese significado cuando el código fuente es encontrado pero inadecuadamente estructurado. Si usted estaba atrapando ImportError antes y desea continuar ignorando los problemas de sintaxis o decodificación, atrape las tres excepciones ahora.

@item 
@ref{109e,,functools.update_wrapper()} y @ref{fdd,,functools.wraps()} ahora establecen correctamente el atributo @code{wrapped__} a la función que está siendo envuelta, incluso si esa función también tiene su atributo @code{wrapped__} establecido. Esto significa que los atributos @code{__wrapped__} ahora enlazan correctamente una pila de funciones decoradas en lugar de que cada atributo @code{__wrapped__} en la cadena haga referencia a la función más interna. Las bibliotecas de introspección que asumían que el comportamiento anterior era intencionado pueden utilizar @ref{fdc,,inspect.unwrap()} para acceder a la primera función de la cadena que no tenga el atributo @code{__wrapped__}.

@item 
@ref{7d4,,inspect.getfullargspec()} ha sido reimplementado sobre @ref{181,,inspect.signature()} y por lo tanto maneja una variedad mucho más amplia de objetos llamables que en el pasado. Se espera que otras llamadas de módulos incorporados y de extensión obtengan metadatos de firma en el curso de la serie Python 3.4. El código que asume que @ref{7d4,,inspect.getfullargspec()} fallará en las llamadas que no son de Python puede necesitar ser ajustado en consecuencia.

@item 
@ref{109f,,importlib.machinery.PathFinder} ahora pasa el directorio de trabajo actual a los objetos en @ref{10a0,,sys.path_hooks} para la cadena vacía. Esto hace que @ref{684,,sys.path_importer_cache} nunca contenga @code{'@w{'}}, por lo que iterar a través de @ref{684,,sys.path_importer_cache} basándose en @ref{27e,,sys.path} no encontrará todas las claves. El @code{__file__} de un módulo cuando se importa en el directorio de trabajo actual también tendrá ahora una ruta absoluta, incluso cuando se utiliza @code{-m} con el intérprete (excepto para @code{__main__.__file__} cuando un script se ha ejecutado directamente utilizando una ruta relativa) (Contribuido por Brett Cannon en bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}). se especifica en la línea de comandos) (bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}).

@item 
La eliminación del argumento `estricto' de @ref{bc8,,HTTPConnection} y @ref{bc9,,HTTPSConnection} cambia el significado de los argumentos restantes si los especifica posicionalmente en lugar de por palabra clave.  Si ha prestado atención a las advertencias de desaprobación, su código ya debería especificar los argumentos adicionales mediante palabras clave.

@item 
Las cadenas entre las sentencias @code{from __future__ import ...} ahora `siempre' lanzan un @ref{150,,SyntaxError}.  Anteriormente, si no había un docstring principal, a veces se ignoraba una cadena intersticial.  Esto hace que CPython cumpla con la especificación del lenguaje; Jython y PyPy ya lo hacían. (bpo-17434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17434}).

@item 
@ref{1036,,ssl.SSLSocket.getpeercert()} y @ref{eed,,ssl.SSLSocket.do_handshake()} ahora lanzan un @ref{4d5,,OSError} con @code{ENOTCONN} cuando el @code{SSLSocket} no está conectado, en lugar del comportamiento anterior de lanzar un @ref{441,,AttributeError}.  Además, @ref{1036,,getpeercert()} lanzará un @ref{360,,ValueError} si el handshake aún no se ha realizado.

@item 
@ref{10a1,,base64.b32decode()} ahora genera un @ref{10a2,,binascii.Error} cuando la cadena de entrada contiene caracteres que no son de tipo b32, en lugar de un @ref{228,,TypeError}.  Este @ref{228,,TypeError} en particular se perdió cuando se convirtieron los otros @ref{228,,TypeError}.  (Contribuido por Serhiy Storchaka en bpo-18011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18011}.) Nota: este cambio también se aplicó inadvertidamente en Python 3.3.3.

@item 
The @code{file} attribute is now automatically closed when
the creating @code{cgi.FieldStorage} instance is garbage collected. If you
were pulling the file object out separately from the @code{cgi.FieldStorage}
instance and not keeping the instance alive, then you should either store the
entire @code{cgi.FieldStorage} instance or read the contents of the file
before the @code{cgi.FieldStorage} instance is garbage collected.

@item 
Llamar a @code{lectura} o @code{escritura} en un socket SSL cerrado ahora genera un informativo @ref{360,,ValueError} en lugar del anterior y más misterioso @ref{441,,AttributeError} (bpo-9177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9177}).

@item 
@ref{10a3,,slice.indices()} ya no produce un @ref{919,,OverflowError} para valores enormes.  Como consecuencia de esta corrección, @ref{10a3,,slice.indices()} ahora produce un @ref{360,,ValueError} si se le da una longitud negativa; antes devolvía valores sin sentido (bpo-14794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14794}).

@item 
El constructor @ref{154,,complex}, a diferencia de las funciones @ref{19,,cmath}, aceptaba incorrectamente valores @ref{153,,float} si el método especial @code{__complex__} de un objeto devolvía uno.  Ahora se produce un error @ref{228,,TypeError}. (bpo-16290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16290}.)

@item 
El constructor @ref{1f0,,int} de las versiones 3.2 y 3.3 aceptaba erróneamente valores @ref{153,,float} para el parámetro `base'.  Es poco probable que alguien esté haciendo esto, pero si es así, ahora lanzará un @ref{228,,TypeError} (bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772}).

@item 
Los valores por defecto de los argumentos de palabras clave se evalúan ahora `después' de los valores por defecto de los argumentos de palabras clave normales, en lugar de antes.  Esperemos que nadie haya escrito ningún código que dependa del comportamiento erróneo anterior (bpo-16967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16967}).

@item 
Los estados de los hilos antiguos se borran ahora después de @ref{2ff,,fork()}.  Esto puede hacer que se liberen algunos recursos del sistema que antes se mantenían vivos de forma incorrecta (por ejemplo, las conexiones a la base de datos mantenidas en el almacenamiento local del hilo).  (bpo-17094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17094}.)

@item 
Parameter names in @code{__annotations__} dicts are now mangled properly,
similarly to @ref{10a4,,__kwdefaults__}.
(Contributed by Yury Selivanov in bpo-20625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20625}.)

@item 
@ref{fc8,,hashlib.hash.name} ahora siempre devuelve el identificador en minúsculas. Anteriormente, algunos hashes incorporados tenían nombres en mayúsculas, pero ahora que se trata de una interfaz pública formal, la denominación se ha hecho consistente (bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532}).

@item 
Because @ref{e79,,unittest.TestSuite} now drops references to tests after they
are run, test harnesses that reuse a @ref{e79,,TestSuite} to re-run
a set of tests may fail.   Test suites should not be re-used in this fashion
since it means state is retained between test runs, breaking the test
isolation that @ref{106,,unittest} is designed to provide.  However, if the lack
of isolation is considered acceptable, the old behavior can be restored by
creating a @ref{e79,,TestSuite} subclass that defines a
@code{_removeTestAtIndex} method that does nothing (see
@ref{10a5,,TestSuite.__iter__()}) (bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798}).

@item 
@ref{106,,unittest} ahora utiliza @ref{7,,argparse} para el análisis de la línea de comandos.  Hay ciertas formas de comando inválidas que solían funcionar y que ya no están permitidas; en teoría, esto no debería causar problemas de compatibilidad con versiones anteriores, ya que las formas de comando no permitidas no tenían ningún sentido y es poco probable que estén en uso.

@item 
Las funciones @ref{3f1,,re.split()}, @ref{10a6,,re.findall()} y @ref{3f2,,re.sub()}, y los métodos @code{group()} y @code{groups()} de los objetos @code{match} ahora siempre devuelven un objeto `bytes' cuando la cadena a comparar es un @ref{db4,,bytes-like object}.  Anteriormente el tipo de retorno coincidía con el tipo de entrada, por lo que si su código dependía de que el valor de retorno fuera, por ejemplo, un @code{bytearray}, tendrá que cambiar su código.

@item 
@code{audioop} functions now raise an error immediately if passed string
input, instead of failing randomly later on (bpo-16685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16685}).

@item 
El nuevo argumento `convert_charrefs' de @ref{90e,,HTMLParser} tiene por defecto el valor @code{False} por compatibilidad con versiones anteriores, pero con el tiempo se cambiará a @code{True}.  Se recomienda añadir esta palabra clave, con el valor apropiado, a cualquier llamada de @ref{90e,,HTMLParser} en su código (bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633}).

@item 
Dado que el argumento `digestmod' de la función @ref{b2a,,hmac.new()} no tendrá en el futuro ningún valor por defecto, todas las llamadas a @ref{b2a,,hmac.new()} deben cambiarse para especificar explícitamente un `digestmod' (bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276}).

@item 
Llamar a @ref{10a7,,sysconfig.get_config_var()} con la clave @code{SO}, o buscar @code{SO} en los resultados de una llamada a @ref{10a8,,sysconfig.get_config_vars()} está obsoleto.  Esta clave debería ser reemplazada por @code{EXT_SUFFIX} o @code{SHLIB_SUFFIX}, dependiendo del contexto (bpo-19555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19555}).

@item 
Cualquier llamada a las funciones @code{open} que especifique @code{U} debe ser modificada. @code{U} es ineficaz en Python3 y acabará dando un error si se utiliza. Dependiendo de la función, el equivalente a su antiguo comportamiento en Python2 puede conseguirse usando un argumento `newline', o si es necesario envolviendo el flujo en @ref{854,,TextIOWrapper} para usar su argumento `newline' (bpo-15204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15204}).

@item 
Si utilizas @code{pyvenv} en un script y deseas que pip `no' se instale, debes añadir @code{--without-pip} a tu invocación del comando.

@item 
El comportamiento por defecto de @ref{dcb,,json.dump()} y @ref{dcc,,json.dumps()} cuando se especifica una sangría ha cambiado: ya no produce espacios finales después de las comas de separación al final de las líneas.  Esto sólo importará si tiene pruebas que hacen comparaciones sensibles a los espacios en blanco de dicha salida (bpo-16333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16333}).

@item 
@ref{3b,,doctest} ahora busca doctests en las cadenas del módulo de extensión @code{__doc__}, por lo que si su descubrimiento de pruebas de doctest incluye módulos de extensión que tienen cosas que parecen doctests en ellos, puede ver fallos de prueba que nunca ha visto antes al ejecutar sus pruebas (bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158}).

@item 
El módulo @ref{1f,,collections.abc} ha sido ligeramente refactorizado como parte de las mejoras de inicio de Python.  Como consecuencia de esto, ya no se da el caso de que al importar @ref{1e,,collections} se importe automáticamente @ref{1f,,collections.abc}.  Si su programa dependía de la importación implícita (no documentada), tendrá que añadir un @code{importar colecciones.abc} explícitamente (bpo-20784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20784}).
@end itemize

@node Cambios en la API de C<11>,,Cambios en la API de Python<8>,Adaptación a Python 3 4
@anchor{whatsnew/3 4 changes-in-the-c-api}@anchor{10a9}
@subsubsection Cambios en la API de C



@itemize *

@item 
@ref{10aa,,PyEval_EvalFrameEx()}, @ref{10ab,,PyObject_Repr()}, y @ref{10ac,,PyObject_Str()}, junto con algunas otras APIs internas de C, incluyen ahora una aserción de depuración que asegura que no se utilicen en situaciones en las que puedan descartar silenciosamente una excepción actualmente activa. En los casos en los que se espera y se desea descartar la excepción activa (por ejemplo, porque ya se ha guardado localmente con @ref{28a,,PyErr_Fetch()} o se está sustituyendo deliberadamente por una excepción diferente), se necesitará una llamada explícita a @ref{10ad,,PyErr_Clear()} para evitar que se active la aserción cuando se invoquen estas operaciones (directa o indirectamente) y se ejecuten contra una versión de Python que esté compilada con las aserciones activadas.

@item 
@ref{dc5,,PyErr_SetImportError()} ahora establece @ref{228,,TypeError} cuando su argumento `msg' no está establecido. Anteriormente sólo se devolvía @code{NULL} sin establecer ninguna excepción.

@item 
El resultado de la llamada de retorno de @ref{62a,,PyOS_ReadlineFunctionPointer} debe ser ahora una cadena asignada por @ref{482,,PyMem_RawMalloc()} o @ref{484,,PyMem_RawRealloc()}, o @code{NULL} si se ha producido un error, en lugar de una cadena asignada por @ref{cee,,PyMem_Malloc()} o @ref{10ae,,PyMem_Realloc()} (bpo-16742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16742})

@item 
@ref{29f,,PyThread_set_key_value()} ahora siempre establece el valor. En Python 3.3, la función no hacía nada si la clave ya existía (si el valor actual es un puntero no @code{NULL}).

@item 
Se ha eliminado el campo @code{f_tstate} (estado del hilo) de la estructura @ref{822,,PyFrameObject} para corregir un error: véase bpo-14432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14432} para conocer los motivos.
@end itemize

@node Cambiado en 3 4 3,,Adaptación a Python 3 4,Qué hay de nuevo en Python 3 4
@anchor{whatsnew/3 4 changed-in-3-4-3}@anchor{10af}
@subsection Cambiado en 3.4.3


@menu
* PEP 476; Habilitar la verificación de certificados por defecto para los clientes http stdlib: PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib. 

@end menu

@node PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib,,,Cambiado en 3 4 3
@anchor{whatsnew/3 4 pep-476}@anchor{10b0}@anchor{whatsnew/3 4 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{10b1}
@subsubsection PEP 476: Habilitar la verificación de certificados por defecto para los clientes http stdlib


@ref{6f,,http.client} y los módulos que lo utilizan, como @ref{10b,,urllib.request} y @ref{12d,,xmlrpc.client}, ahora verificarán que el servidor presenta un certificado que está firmado por una CA en el almacén de confianza de la plataforma y cuyo nombre de host coincide con el nombre de host que se solicita por defecto, mejorando significativamente la seguridad de muchas aplicaciones.

Para las aplicaciones que requieren el antiguo comportamiento anterior, pueden pasar un contexto alternativo:

@example
import urllib.request
import ssl

# This disables all verification
context = ssl._create_unverified_context()

# This allows using a specific certificate for the host, which doesn't need
# to be in the trust store
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib.request.urlopen("https://invalid-cert", context=context)
@end example

@node Qué hay de nuevo en Python 3 3,Qué hay de nuevo en Python 3 2,Qué hay de nuevo en Python 3 4,Qué hay de nuevo en Python
@anchor{whatsnew/3 3 doc}@anchor{10b2}@anchor{whatsnew/3 3 what-s-new-in-python-3-3}@anchor{10b3}
@section Qué hay de nuevo en Python 3.3


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

Éste artículo explica las nuevas características en python 3.3, en comparación con la versión 3.2. Python 3.3 se lanzó el 29 de septiembre de 2012. Para más detalles, ver el log de cambios en la dirección <@indicateurl{https://docs.python.org/3.3/whatsnew/changelog.html}>.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 398
PEP 398@footnote{https://peps.python.org/pep-0398/} - Calendario de Publicación Python 3.3


@menu
* Resumen – Aspectos destacados de la versión: Resumen – Aspectos destacados de la versión<4>. 
* PEP 405; Entornos virtuales: PEP 405 Entornos virtuales. 
* PEP 420; Paquetes para espacios de nombres implícitos: PEP 420 Paquetes para espacios de nombres implícitos. 
* PEP 3118; Nueva implementación de vista de memoria y en la documentación del protocolo del buffer: PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer. 
* PEP 393; Representación flexible de cadenas de caracteres: PEP 393 Representación flexible de cadenas de caracteres. 
* PEP 397; Lanzador de python para windows: PEP 397 Lanzador de python para windows. 
* PEP 3151; Reelaborando de la jerarquía de excepciones de IO y OS: PEP 3151 Reelaborando de la jerarquía de excepciones de IO y OS. 
* PEP 380; Sintaxis para delegar en un subgenerador: PEP 380 Sintaxis para delegar en un subgenerador. 
* PEP 409; Suprimir el contexto de excepción: PEP 409 Suprimir el contexto de excepción. 
* PEP 414; Literales Unicode explícitos: PEP 414 Literales Unicode explícitos. 
* PEP 3155; Nombres calificados para clases y funciones: PEP 3155 Nombres calificados para clases y funciones. 
* PEP 412; Diccionario de intercambio de claves: PEP 412 Diccionario de intercambio de claves. 
* PEP 362; Objeto de firma de función: PEP 362 Objeto de firma de función. 
* PEP 421; Agregar sys.implementation: PEP 421 Agregar sys implementation. 
* Usar importlib como implementación de Import:: 
* Otros cambios de idioma: Otros cambios de idioma<5>. 
* Un bloqueo de importación más detallado:: 
* Funciones y tipos incorporados:: 
* Nuevos módulos: Nuevos módulos<8>. 
* Módulos mejorados: Módulos mejorados<10>. 
* Optimizaciones: Optimizaciones<9>. 
* Construcción y cambios en la API de C:: 
* Obsoleto: Obsoleto<12>. 
* Migración a Python 3.3: Migración a Python 3 3. 

@end menu

@node Resumen – Aspectos destacados de la versión<4>,PEP 405 Entornos virtuales,,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 summary-release-highlights}@anchor{10b4}
@subsection Resumen – Aspectos destacados de la versión


@c This section singles out the most important changes in Python 3.3.
@c Brevity is key.

Nuevas características de sintaxis:


@itemize *

@item 
Nueva expresión @code{yield from} para @ref{10b5,,delegación de generadores}.

@item 
La sintaxis @code{u'unicode'} se acepta de nuevo para los objetos @ref{237,,str}.
@end itemize

Nuevos módulos de biblioteca:


@itemize *

@item 
@ref{58,,faulthandler} (ayuda a depurar bloqueos de bajo nivel)

@item 
@ref{80,,ipaddress} (Objetos de alto nivel que representan direcciones IP y máscaras)

@item 
@ref{8a,,lzma} (comprime datos usando el algoritmo XZ / LZMA)

@item 
@ref{107,,unittest.mock} (Utiliza objetos que simulen partes de tu sistema en ambiente de pruebas)

@item 
@ref{111,,venv} (Python @ref{10b6,,entornos virtuales}, como en el paquete original Virtualenv)
@end itemize

Nuevas características incorporadas:


@itemize *

@item 
Se reformula la @ref{10b7,,Jerarquía de excepción I/O} .
@end itemize

Mejoras de implementación:


@itemize *

@item 
Se reescribe @ref{10b8,,Maquinaria de importación} con base en @ref{77,,importlib}.

@item 
@ref{10b9,,cadenas de caracteres unicode} más compactas.

@item 
@ref{10ba,,diccionarios de atributos} más compactos.
@end itemize

Módulos de biblioteca con mejoras significativas:


@itemize *

@item 
Acelerador de C para el módulo @ref{10bb,,decimal} .

@item 
Mejor gestión de `unicode' en el módulo @ref{10bc,,email} (@ref{10bd,,provisional}).
@end itemize

Mejoras de seguridad:


@itemize *

@item 
La aleatoriedad en los hash está habilitada de forma predeterminada.
@end itemize

Por favor continúa leyendo para obtener una lista completa de los cambios de cara al usuario.

@node PEP 405 Entornos virtuales,PEP 420 Paquetes para espacios de nombres implícitos,Resumen – Aspectos destacados de la versión<4>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-405}@anchor{10b6}@anchor{whatsnew/3 3 pep-405-virtual-environments}@anchor{10be}
@subsection PEP 405: Entornos virtuales


Los entornos virtuales ayudan a crear configuraciones separadas de Python mientras comparten una instalación base en todo el sistema, para facilitar el mantenimiento. Los entornos virtuales tienen su propio conjunto de paquetes de sitios privados (es decir, bibliotecas instaladas localmente) y están opcionalmente segregados de los paquetes de sitios de todo el sistema. Su concepto e implementación están inspirados en el popular paquete de terceros @code{virtualenv}, pero se benefician de una integración más estrecha con el núcleo del intérprete.

Este PEP agrega el módulo @ref{111,,venv} para acceso programático, y el `script' @code{pyvenv} para administración y acceso a través de línea de comandos. El intérprete de python busca un archivo llamado @code{pyvenv.cfg}, cuya existencia señala la base de un árbol de directorios en el entorno virtual.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 405

@item PEP 405@footnote{https://peps.python.org/pep-0405/} - Entornos virtuales en python

PEP escrito por Carl Meyer; implementación por Carl Meyer y Vinay Sajip
@end table


@node PEP 420 Paquetes para espacios de nombres implícitos,PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer,PEP 405 Entornos virtuales,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-420-implicit-namespace-packages}@anchor{10bf}
@subsection PEP 420: Paquetes para espacios de nombres implícitos


Soporte nativo para directorios de paquetes que no requieran el archivo @code{__init.py__} y puedan abarcar automáticamente múltiples segmentos de rutas de acceso (Inspirado en varios enfoques de terceros para espacios de nombres de paquetes, tal como está especificado en 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/})


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/} - Paquetes de espacio de nombres implícitos

PEP escrito por Eric V. Smith; implementación por Eric V. Smith y Barry Warsaw
@end table


@node PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer,PEP 393 Representación flexible de cadenas de caracteres,PEP 420 Paquetes para espacios de nombres implícitos,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-3118-new-memoryview-implementation-and-buffer-protocol-documentation}@anchor{10c0}@anchor{whatsnew/3 3 pep-3118-update}@anchor{10c1}
@subsection PEP 3118: Nueva implementación de vista de memoria y en la documentación del protocolo del buffer


La implementación del 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} ha tenido mejoras significativas.

La nueva implementación de la vista de memoria corrige exhaustivamente todos los problemas de propiedad y duración de los campos asignados dinámicamente en la estructura de Py_buffer que ha dado lugar a varios informes de bloqueo. Además, se han corregido varias funciones que se bloquearon o retornaron resultados incorrectos para entradas no contigua o multidimensional.

El objeto de vista de memoria dispone ahora de PEP-3118 que obedece a getbufferproc(), el cual verifica el tipo de petición del cliente. Se han agregado nuevas características, la mayoría de ellas funcionan generalmente para arrays no contiguos y arrays con subindices.

La documentación se ha actualizado y se han establecido claramente las responsabilidades tanto para los exportadores como para los consumidores. Los indicadores de solicitud de buffer se agrupan en indicadores básicos y compuestos. Se explica el diseño de memoria de matrices de estilo NumPy no contiguas y multidimensionales.

@menu
* Características:: 
* Cambios en la API:: 

@end menu

@node Características,Cambios en la API,,PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer
@anchor{whatsnew/3 3 features}@anchor{10c2}
@subsubsection Características



@itemize *

@item 
Ahora se admiten todos los especificadores nativos de formato de un solo carácter en la sintaxis del módulo de estructura (opcionalmente con el prefijo “@@”).

@item 
Con algunas reestricciones, el método cast() permite cambiar el formato y forma de los arrays contiguos.

@item 
La representación de listas multidimensionales es aceptada por cualquier tipo de array.

@item 
Se admiten comparaciones multidimensionales para cualquier tipo de array.

@item 
Los objetos de vista de memoria unidimensionales de tipo hash con formatos B, b, o c ahora son hashables (Contribución por Antoine Pitrou en el issue @cite{13411}.)

@item 
Arbitrary slicing of any 1-D arrays type is supported. For example, it
is now possible to reverse a memoryview in `O'(1) by using a negative step.
@end itemize

@node Cambios en la API,,Características,PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer
@anchor{whatsnew/3 3 api-changes}@anchor{10c3}
@subsubsection Cambios en la API



@itemize *

@item 
Oficialmente, se limita el número máximo de dimensiones a 64.

@item 
Las formas vacías, pasos, y subíndices ahora son representados por una tupla vacía, en vez de @code{None}.

@item 
El acceso al elemento de una vista de memoria con formato “B” (bytes sin signo) ahora retorna un entero (de acuerdo con la sintaxis del módulo de estructura). Para retornar un objeto `bytes', primero la vista debe ser convertida a «C».

@item 
las comparaciones de la vista de memoria ahora utilizan la estructura lógica de los operandos y comparan todos los elementos de array por valor. Se admiten todos los formatos strings en la sintaxis del módulo de estructura. Aún se admiten las vistas con strings que tengan un formato no reconocido, pero siempre se compararan como desiguales, independientemente del contenido de la vista.

@item 
Para más cambios, consulte @ref{10c4,,Compilación y cambios en la API de C} y @ref{10c5,,Portabilidad del código C}.
@end itemize

(Contribución por Stefan Krah en el issue @cite{10181} .)


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} - Revisando el protocolo de buffer


@node PEP 393 Representación flexible de cadenas de caracteres,PEP 397 Lanzador de python para windows,PEP 3118 Nueva implementación de vista de memoria y en la documentación del protocolo del buffer,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-393}@anchor{10b9}@anchor{whatsnew/3 3 pep-393-flexible-string-representation}@anchor{10c6}
@subsection PEP 393: Representación flexible de cadenas de caracteres


El tipo de cadena `Unicode' es modificado para admitir múltiples representaciones internas, dependiendo del caracter con el ordinal Unicode más grande (1, 2 o 4 `bytes') en la cadena representada. Esto permite una representación que ahorra espacio en casos comunes, pero da acceso a UCS-4 completo en todos los sistemas. Para compatibilidad con APIS existentes, pueden existir varias representaciones en paralelo; con el tiempo, esta compatibilidad debería eliminarse gradualmente.

Por parte de Python, no debería haber inconvenientes por éste cambio.

Por parte de la API de C, 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} es totalmente compatible con versiones anteriores. La API antigua debería quedar disponible al menos por cinco años. Las aplicaciones que usan la API antigua no saldrán beneficiadas por la reducción de memoria, o -peor- podrían usar un bit más de memoria, debido a que python necesitaría mantener dos versiones de cada cadena de caracteres (en el formato antiguo y en el nuevo almacenamiento)

@menu
* Funcionalidad:: 
* Rendimiento y uso de recursos:: 

@end menu

@node Funcionalidad,Rendimiento y uso de recursos,,PEP 393 Representación flexible de cadenas de caracteres
@anchor{whatsnew/3 3 functionality}@anchor{10c7}
@subsubsection Funcionalidad


Los cambios introducidos en el 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} son los siguientes:


@itemize *

@item 
Ahora python admite siempre el rango completo de códigos `Unicode', incluyendo los que no son BMP (es decir, @code{U+0000} to @code{U+10FFFF}). La distinción entre ancho y angosto ya no existe, y python se comporta ahora como una compilación amplia, incluso en sistemas windows.

@item 
Con la eliminación de las construcciones estrechas, han sido solucionados también los problemas específicos referentes a este tipo de construcciones, por ejemplo:


@itemize *

@item 
@ref{6cf,,len()} Ahora siempre retorna 1 para los caracteres que no son BMP, de modo que @code{len('\U0010FFFF') == 1};

@item 
los pares sustitutos no se recombinan en cadenas literales, de modo que @code{'\uDBFF\uDFFF' != '\U0010FFFF'};

@item 
la indexación o el corte de caracteres que no son BMP, retorna el valor esperado, de modo que @code{'\U0010FFFF'[0]} ahora retorna @code{'\U0010FFFF'} y no @code{'\uDBFF'};

@item 
todas las demás funciones en la librería estándar ahora gestionan de forma correcta los puntos de código que no son BMP.
@end itemize

@item 
El valor de @ref{10c8,,sys.maxunicode} ahora es siempre @code{1114111} (@code{0x10FFFF} en hexadecimal). La función @code{PyUnicode_GetMax()} aún devuelve @code{0xFFFF} o @code{0x10FFFF} por compatibilidad con versiones anteriores y no debe usarse con la nueva API Unicode (consulte bpo-13054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13054}).

@item 
Se ha eliminado el indicador @code{./configure} @code{--with-wide-unicode}.
@end itemize

@node Rendimiento y uso de recursos,,Funcionalidad,PEP 393 Representación flexible de cadenas de caracteres
@anchor{whatsnew/3 3 performance-and-resource-usage}@anchor{10c9}
@subsubsection Rendimiento y uso de recursos


El almacenamiento de las cadenas `Unicode' ahora depende del punto de código más alto en la cadena:


@itemize *

@item 
las cadenas de caracteres en ASCII puro y Latin1 (@code{U+0000-U+00FF}) usan 1 byte por punto de código;

@item 
Las cadenas de caracteres BMP (@code{U+0000-U+FFFF}) usan 2 `bytes' por punto de código;

@item 
las cadenas de caracteres que no son BMP (@code{U+10000-U+10FFFF}) usan 4 `bytes' por punto de código.
@end itemize

El efecto neto es que para la mayoría de las aplicaciones, el uso de memoria del almacenamiento de cadenas de caracteres debería disminuir significativamente, especialmente en comparación con las construcciones `unicode' anchas, ya que, en muchos casos, las cadenas serán ASCII puro incluso en contextos internacionales (porque muchas cadenas almacenan datos en lenguaje no humano, tal como fragmentos XML, encabezados HTTP, datos codificados en JSON, etc.). También esperamos que, por las mismas razones, aumente la eficiencia de la caché de la CPU en aplicaciones no triviales. El uso de memoria de Python 3.3 es dos o tres veces más pequeño que Python 3.2, y un poco mejor que Python 2.7, en un punto de referencia de Django (consulte el PEP para obtener más detalles).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 393

@item PEP 393@footnote{https://peps.python.org/pep-0393/} - Representación flexible de cadenas de caracteres

PEP escrito por Martin von Lowis; implementado por Torsten Becker y Martin von Lowis.
@end table


@node PEP 397 Lanzador de python para windows,PEP 3151 Reelaborando de la jerarquía de excepciones de IO y OS,PEP 393 Representación flexible de cadenas de caracteres,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-397}@anchor{10ca}@anchor{whatsnew/3 3 pep-397-python-launcher-for-windows}@anchor{10cb}
@subsection PEP 397: Lanzador de python para windows


El instalador de Python 3.3 para windows ahora incluye una aplicación lanzadora @code{py} que puede ser utilizada para ejecutar aplicaciones python de forma independiente de la versión.

Este lanzador se invoca de forma implícita cuando haces doble click en archivos @code{*.py}. Si el sistema tiene instalada una única versión de python, ésta versión será usada para ejecutar el archivo. Si hay múltiples versiones instaladas en el sistema, se utilizara por defecto la versión más reciente pero ésto puede ser anulado incluyendo una «línea shebang» estilo Unix en el `script' de Python.

El lanzador también se puede usar explícitamente desde la línea de comando como la aplicación @code{py}. La ejecución de @code{py} sigue las mismas reglas de selección de versión que la ejecución implícita de scripts, pero se puede seleccionar una versión más específica pasando los argumentos apropiados (como @code{-3} para solicitar Python 3 cuando Python 2 también está instalado, o @code{-2.6} para solicitar específicamente una versión anterior de Python cuando se instala una versión más reciente).

Además del lanzador, el instalador de Windows ahora incluye una opción para agregar el Python recién instalado al PATH del sistema. (Contribución de Brian Curtin en bpo-3561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3561}.)


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 397

@item PEP 397@footnote{https://peps.python.org/pep-0397/} - Python Launcher for Windows

PEP escrito por Mark Hammond y Martin v. Löwis; implementado por Vinay Sajip.
@end table

Documentación del lanzador: @ref{65f,,Lanzador de Python para Windows}

Modificación de la ruta del instalador: @ref{10cc,,Encontrar el ejecutable de Python}


@node PEP 3151 Reelaborando de la jerarquía de excepciones de IO y OS,PEP 380 Sintaxis para delegar en un subgenerador,PEP 397 Lanzador de python para windows,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-3151}@anchor{10b7}@anchor{whatsnew/3 3 pep-3151-reworking-the-os-and-io-exception-hierarchy}@anchor{10cd}
@subsection PEP 3151: Reelaborando de la jerarquía de excepciones de IO y OS


La jerarquía de excepciones generada por errores del sistema operativo ahora está simplificada y es más detallada.

No tienes que preocuparte más por cómo elegir el tipo de excepción adecuado entre @ref{4d5,,OSError}, @ref{10ce,,IOError}, @ref{10cf,,EnvironmentError}, @ref{10d0,,WindowsError}, @code{mmap.error}, @ref{10d1,,socket.error} or @ref{10d2,,select.error}. Todos estos tipos de excepción son ahora una sola: @ref{4d5,,OSError}. Los otros nombres se mantienen como alias por razones de compatibilidad.

Además, ahora es más fácil detectar una condición de error específica. En lugar de inspeccionar el atributo @code{errno} (o @code{args[0]}) para una constante particular del módulo @ref{57,,errno}, puede seleccionar la subclase @ref{4d5,,OSError} adecuada. Las subclases disponibles son las siguientes:


@itemize *

@item 
@ref{10d3,,BlockingIOError}

@item 
@ref{10d4,,ChildProcessError}

@item 
@ref{e8f,,ConnectionError}

@item 
@ref{109c,,FileExistsError}

@item 
@ref{f46,,FileNotFoundError}

@item 
@ref{e0e,,InterruptedError}

@item 
@ref{10d5,,IsADirectoryError}

@item 
@ref{10d6,,NotADirectoryError}

@item 
@ref{dc9,,PermissionError}

@item 
@ref{10d7,,ProcessLookupError}

@item 
@ref{8cc,,TimeoutError}
@end itemize

Y el mismo @ref{e8f,,ConnectionError} tiene subclases más detalladas:


@itemize *

@item 
@ref{10d8,,BrokenPipeError}

@item 
@ref{10d9,,ConnectionAbortedError}

@item 
@ref{10da,,ConnectionRefusedError}

@item 
@ref{10db,,ConnectionResetError}
@end itemize

Gracias a las nuevas excepciones, los usos comunes de @ref{57,,errno}  ahora se pueden evitar. Por ejemplo, el siguiente código escrito para Python 3.2:

@example
from errno import ENOENT, EACCES, EPERM

try:
    with open("document.txt") as f:
        content = f.read()
except IOError as err:
    if err.errno == ENOENT:
        print("document.txt file is missing")
    elif err.errno in (EACCES, EPERM):
        print("You are not allowed to read document.txt")
    else:
        raise
@end example

ahora se pueden escribir sin la importación de @ref{57,,errno}  y sin la inspección manual de atributos de excepción:

@example
try:
    with open("document.txt") as f:
        content = f.read()
except FileNotFoundError:
    print("document.txt file is missing")
except PermissionError:
    print("You are not allowed to read document.txt")
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3151

@item PEP 3151@footnote{https://peps.python.org/pep-3151/} - Re elaboración de la jerarquía de excepciones de IO y OS

PEP escrito e implementado por Antoine Pitrou
@end table


@geindex producir;producir desde (en Novedades)

@node PEP 380 Sintaxis para delegar en un subgenerador,PEP 409 Suprimir el contexto de excepción,PEP 3151 Reelaborando de la jerarquía de excepciones de IO y OS,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-380}@anchor{10b5}@anchor{whatsnew/3 3 pep-380-syntax-for-delegating-to-a-subgenerator}@anchor{10dc}
@subsection PEP 380: Sintaxis para delegar en un subgenerador


PEP 380 agrega la expresión @code{yield from}, permitiendo que un @ref{10dd,,generator} delegue parte de sus operaciones a otro generador. Esto permite tomar en consideración una sección de código que contenga la palabra @ref{a5f,,yield} y ubicarla en otro generador. Además, el subgenerador puede regresar con un valor y el valor se pone a disposición del generador que delega.

Aunque está diseñada principalmente para su uso en la delegación a un subgenerador, la expresión @code{yield from} en realidad permite la delegación a subiteradores arbitrarios.

Para iteradores simples, @code{yield from iterable} es esencialmente una forma abreviada de @code{for item in iterable: yield item}:

@example
>>> def g(x):
...     yield from range(x, 0, -1)
...     yield from range(x)
...
>>> list(g(5))
[5, 4, 3, 2, 1, 0, 1, 2, 3, 4]
@end example

Sin embargo, a diferencia de un ciclo ordinario, @code{yield from} permite que los subgeneradores reciban valores enviados y lanzados directamente desde el ámbito de la llamada y retornen un valor final al generador externo:

@example
>>> def accumulate():
...     tally = 0
...     while 1:
...         next = yield
...         if next is None:
...             return tally
...         tally += next
...
>>> def gather_tallies(tallies):
...     while 1:
...         tally = yield from accumulate()
...         tallies.append(tally)
...
>>> tallies = []
>>> acc = gather_tallies(tallies)
>>> next(acc)  # Ensure the accumulator is ready to accept values
>>> for i in range(4):
...     acc.send(i)
...
>>> acc.send(None)  # Finish the first tally
>>> for i in range(5):
...     acc.send(i)
...
>>> acc.send(None)  # Finish the second tally
>>> tallies
[6, 10]
@end example

Lo más importante de éste cambio es permitir que incluso los generadores que están diseñados para ser usados con los métodos @code{send} y @code{throw} sean separados en múltiples subgeneradores tan fácilmente como las funciones grandes se pueden dividir en varias subfunciones.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - Sintaxis para delegar a un subgenerador

PEP escrito por Greg Ewing; implementación por Greg Ewing, integrado en 3.3 por Renaud Blanch, Ryan Kelly y Nick Coghlan; documentación de Zbigniew Jędrzejewski-Szmek y Nick Coghlan
@end table


@node PEP 409 Suprimir el contexto de excepción,PEP 414 Literales Unicode explícitos,PEP 380 Sintaxis para delegar en un subgenerador,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-409-suppressing-exception-context}@anchor{10de}
@subsection PEP 409: Suprimir el contexto de excepción


PEP 409 introduce una nueva sintaxis que permite deshabilitar la visualización del contexto de excepción encadenado. Esto permite mensajes de error más limpios en aplicaciones que convierten entre tipos de excepción:

@example
>>> class D:
...     def __init__(self, extra):
...         self._extra_attributes = extra
...     def __getattr__(self, attr):
...         try:
...             return self._extra_attributes[attr]
...         except KeyError:
...             raise AttributeError(attr) from None
...
>>> D(@{@}).x
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 8, in __getattr__
AttributeError: x
@end example

Sin el sufijo @code{from None} para suprimir la causa, la excepción original se mostraría de forma predeterminada:

@example
>>> class C:
...     def __init__(self, extra):
...         self._extra_attributes = extra
...     def __getattr__(self, attr):
...         try:
...             return self._extra_attributes[attr]
...         except KeyError:
...             raise AttributeError(attr)
...
>>> C(@{@}).x
Traceback (most recent call last):
  File "<stdin>", line 6, in __getattr__
KeyError: 'x'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 8, in __getattr__
AttributeError: x
@end example

No se pierde ninguna capacidad de depuración, ya que el contexto de la excepción original permanece disponible en caso de ser necesario (por ejemplo, si una biblioteca suprime detalles importantes y valiosos de forma incorrecta)

@example
>>> try:
...     D(@{@}).x
... except AttributeError as exc:
...     print(repr(exc.__context__))
...
KeyError('x',)
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 409

@item PEP 409@footnote{https://peps.python.org/pep-0409/} - Supresión del contexto de excepción

PEP escrito por Ethan Furman; implementado por Ethan Furman y Nick Coghlan.
@end table


@node PEP 414 Literales Unicode explícitos,PEP 3155 Nombres calificados para clases y funciones,PEP 409 Suprimir el contexto de excepción,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-414-explicit-unicode-literals}@anchor{10df}
@subsection PEP 414: Literales `Unicode' explícitos


Para facilitar la transición de Python 2 para las aplicaciones de Python que reconocen `Unicode' y que hacen un uso intensivo de literales Unicode, Python 3.3 una vez más admite el prefijo «@code{u}» para cadenas literales. Este prefijo no tiene importancia semántica en Python 3, se proporciona únicamente para reducir el número de cambios puramente mecánicos en la migración a Python 3, lo que facilita a los desarrolladores centrarse en los cambios semánticos más significativos (como la separación predeterminada más estricta de binary y datos de texto).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 414

@item PEP 414@footnote{https://peps.python.org/pep-0414/} - Literales `Unicode' Explícitos

PEP escrito por Armin Ronacher.
@end table


@node PEP 3155 Nombres calificados para clases y funciones,PEP 412 Diccionario de intercambio de claves,PEP 414 Literales Unicode explícitos,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-3155-qualified-name-for-classes-and-functions}@anchor{10e0}
@subsection PEP 3155: Nombres calificados para clases y funciones


Functions and class objects have a new @ref{10e1,,__qualname__}
attribute representing
the «path» from the module top-level to their definition.  For global functions
and classes, this is the same as @ref{10e2,,__name__}.
For other functions and classes,
it provides better information about where they were actually defined, and
how they might be accessible from the global scope.

Ejemplo con métodos (no vinculados):

@example
>>> class C:
...     def meth(self):
...         pass
...
>>> C.meth.__name__
'meth'
>>> C.meth.__qualname__
'C.meth'
@end example

Ejemplo con clases anidadas:

@example
>>> class C:
...     class D:
...         def meth(self):
...             pass
...
>>> C.D.__name__
'D'
>>> C.D.__qualname__
'C.D'
>>> C.D.meth.__name__
'meth'
>>> C.D.meth.__qualname__
'C.D.meth'
@end example

Ejemplo con funciones anidadas:

@example
>>> def outer():
...     def inner():
...         pass
...     return inner
...
>>> outer().__name__
'inner'
>>> outer().__qualname__
'outer.<locals>.inner'
@end example

La representación en cadena de estos objetos, también se ha modificado para incluir la información nueva y más precisa:

@example
>>> str(C.D)
"<class '__main__.C.D'>"
>>> str(C.D.meth)
'<function C.D.meth at 0x7f46b9fe31e0>'
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3155

@item PEP 3155@footnote{https://peps.python.org/pep-3155/} - Nombres calificados para clases y funciones

PEP Escrito e implementado por Antoine Pitrou.
@end table


@node PEP 412 Diccionario de intercambio de claves,PEP 362 Objeto de firma de función,PEP 3155 Nombres calificados para clases y funciones,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-412}@anchor{10ba}@anchor{whatsnew/3 3 pep-412-key-sharing-dictionary}@anchor{10e3}
@subsection PEP 412: Diccionario de intercambio de claves


Los diccionarios usados para almacenar atributos de objetos, ahora pueden compartir parte de su almacenamiento interno entre sí (a saber, la parte que almacena las claves y sus respectivos hashes). Esto reduce el consumo de memoria de programas creando varias instancias de tipos no integrados.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 412

@item PEP 412@footnote{https://peps.python.org/pep-0412/} -Diccionario de intercambio de claves

PEP escrito e implementado por Mark Shannon.
@end table


@node PEP 362 Objeto de firma de función,PEP 421 Agregar sys implementation,PEP 412 Diccionario de intercambio de claves,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-362-function-signature-object}@anchor{10e4}
@subsection PEP 362: Objeto de firma de función


Una nueva función @ref{181,,inspect.signature()} hace que la introspección de las llamadas de Python sea fácil y directa. Se admite una amplia gama de invocables: funciones python, decoradas o no, clases y objetos @ref{17a,,functools.partial()}. Las Nuevas clases @ref{332,,inspect.Signature}, @ref{333,,inspect.Parameter} y @ref{10e5,,inspect.BoundArguments} contienen información sobre las firmas de llamadas, tales como anotaciones, valores por defecto, tipos de parámetros, y los argumentos vinculados, lo cual simplifica considerablemente la escritura de decoradores y de cualquier código que valide o modifique las firmas de llamadas o argumentos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/}: - Objeto de firmas de función

PEP escrito por Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon Seo; implementado por Yury Selivanov.
@end table


@node PEP 421 Agregar sys implementation,Usar importlib como implementación de Import,PEP 362 Objeto de firma de función,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 pep-421-adding-sys-implementation}@anchor{10e6}
@subsection PEP 421: Agregar sys.implementation


Un nuevo atributo en el módulo @ref{d9,,sys} expone detalles específicos de la implementación del intérprete que se ésta ejecutando en el momento actual. El conjunto inicial de atributos en @ref{5bb,,sys.implementation} son @code{name}, @code{version}, @code{hexversion}, y @code{cache_tag}.

La intención de @code{sys.implementation} es consolidar dentro de un espacio de nombres, la implementación específica de datos usado por la biblioteca estándar. Esto permite que diferentes implementaciones de python puedan compartir código de la biblioteca estándar de manera más fácil. En su estado inicial, @code{sys.implementation} contiene solo una pequeña porción de los datos específicos de la implementación. Con el tiempo esta proporción cambiará para hacer que la biblioteca estándar sea más portable..

Un ejemplo de mejor portabilidad de la biblioteca estándar es @code{cache_tag}. A partir de Python 3.3, @code{sys.implementation.cache_tag} es utilizado por @ref{77,,importlib} para admitir el cumplimiento 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}. Cualquier implementación de Python que utilice @code{importlib} para su sistema de importación integrado puede usar @code{cache_tag} para controlar el comportamiento de almacenamiento en caché de los módulos.

@menu
* SimpleNamespace:: 

@end menu

@node SimpleNamespace,,,PEP 421 Agregar sys implementation
@anchor{whatsnew/3 3 simplenamespace}@anchor{10e7}
@subsubsection SimpleNamespace


La implementación de @code{sys.implementation} también trae un nuevo tipo a Python: La clase @ref{334,,types.SimpleNamespace}. En comparación con un nombre de espacio basado en mapas, como @ref{190,,dict}, @code{SimpleNamespace} es basado en atributos, como @ref{b18,,object}. Sin embargo a diferencia de @code{object}, las instancias de @code{SimpleNamespace} son editables. Esto significa que puedes agregar, eliminar, y modificar el nombre de espacio a través del acceso normal a los atributos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 421

@item PEP 421@footnote{https://peps.python.org/pep-0421/} - Agregar sys.implementation

PEP escrito e implementado por Mark Shannon.
@end table


@node Usar importlib como implementación de Import,Otros cambios de idioma<5>,PEP 421 Agregar sys implementation,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 importlib}@anchor{10b8}@anchor{whatsnew/3 3 using-importlib-as-the-implementation-of-import}@anchor{10e8}
@subsection Usar importlib como implementación de Import


bpo-2377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2377}- Replace__import__w/ importlib.__import__ bpo-13959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13959} - Re-implementar partes de  @code{imp} en Python puro bpo-14605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14605} - Hacer que la maquinaria de importación sea explícita bpo-14646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14646} - Requerir que los cargadores establezcan __loader__ y __package__

La función @ref{96b,,__import__()} ahora es potenciada por la función @ref{10e9,,importlib.__import__()}. Este trabajo conduce a completar la «fase 2» de 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. Hay múltiples beneficios en éste cambio. En primer lugar, ha permitido que la mayoría de la maquinaria que potencia las importaciones sea expuesta, en vez de estar implícitas y ocultas en el código de C. También proporciona una única implementación para todas las máquinas virtuales de python que admitan el uso de Python 3.3 lo que ayuda a terminar con cualquier desviación específica de VM en la semántica de importación. Y finalmente facilita el mantenimiento de la importación, permitiendo que ocurra un crecimiento futuro.

Para el usuario común, no debería haber cambios visibles en la semántica. Para aquellos cuyo código realmente manipula la importación o las llamadas de importación de forma programática, los cambios de código que posiblemente sean necesarios, se tratan en la sección @ref{10ea,,Porting Python code} de éste documento.

@menu
* Nuevas APIs:: 
* Cambios visibles:: 

@end menu

@node Nuevas APIs,Cambios visibles,,Usar importlib como implementación de Import
@anchor{whatsnew/3 3 new-apis}@anchor{10eb}
@subsubsection Nuevas APIs


Uno de los grandes beneficios de éste trabajo es la exposición de lo que implica hacer que funcione la sentencia de importación. Esto significa que los varios importadores que una vez fueron implícitos, ahora son expuestos completamente como parte del paquete @ref{77,,importlib}.

Las clases base abstractas definidas en @ref{78,,importlib.abc} se han expandido para delimitar adecuadamente entre @ref{10ec,,buscadores de rutas meta} y @ref{10ed,,buscadores de entrada de rutas} al introducir la clase @ref{905,,importlib.abc.MetaPathFinder} y @ref{906,,importlib.abc.PathEntryFinder} respectivamente. El antiguo ABC de la clase @code{importlib.abc.Finder} ahora solo se proporciona para compatibilidad con versiones anteriores y no exige ningún requisito de método.

En términos de buscadores, @ref{10ee,,importlib.machinery.FileFinder} expone el mecanismo utilizado para buscar archivos fuente y de código de `bytes' de un módulo. Anteriormente, ésta clase era un miembro implícito de @ref{10a0,,sys.path_hooks}.

Para los cargadores, la nueva clase base abstracta @ref{10ef,,importlib.abc.FileLoader} ayuda a escribir un cargador que usa el sistema de archivos como mecanismo de almacenamiento para el código de un módulo. El cargador de archivos fuente (@ref{10f0,,importlib.machinery.SourceFileLoader}), archivos de código byte sin fuente (@ref{10f1,,importlib.machinery.SourcelessFileLoader}) y módulos de extensión (@ref{d39,,importlib.machinery.ExtensionFileLoader}) ahora están disponibles para su uso directo.

@ref{4d7,,ImportError} ahora tiene los atributos @code{name} y @code{path} que se establecen cuando hay datos relevantes para proporcionar. También, el mensaje de importaciones fallidas ahora proporcionará el nombre completo del módulo en lugar de solo el final del nombre del mismo.

La función @ref{c98,,importlib.invalidate_caches()} ahora llamará al método con el mismo nombre en todos los buscadores almacenados en @ref{684,,sys.path_importer_cache} para ayudar a limpiar cualquier estado almacenado según sea necesario.

@node Cambios visibles,,Nuevas APIs,Usar importlib como implementación de Import
@anchor{whatsnew/3 3 visible-changes}@anchor{10f2}
@subsubsection Cambios visibles


Para conocer los posibles cambios necesarios en el código, consulte la sección @ref{10ea,,Porting Python code} .

Más allá de la extensión de lo que ahora expone @ref{77,,importlib}, hay otros cambios visibles para importar. El más grande es que @ref{db2,,sys.meta_path} y @ref{10a0,,sys.path_hooks} ahora almacenan todos los buscadores de rutas meta y los ganchos de entrada de rutas usados por la importación. Anteriormente, los buscadores estaban implícitos y ocultos dentro del código C de importación en lugar de estar expuestos directamente. Esto significa que ahora uno puede eliminar o cambiar fácilmente el orden de los diversos buscadores para satisfacer sus necesidades.

Otro cambio es que todos los módulos tienen un atributo @code{__loader__} que almacena el cargador usado para crear el módulo. La 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} se ha actualizado para hacer que este atributo sea obligatorio para implementar los cargadores, de manera que en el futuro, una vez que los cargadores de terceros hayan sido actualizados, las personas puedan confiar en la existencia de éste atributo. Sin embargo, hasta entonces la importación está configurando la post carga del módulo.

También se espera que ahora los cargadores establezcan el atributo @code{__package__} de 
@geindex Python Enhancement Proposals; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/}. Una vez más, la importación por sí misma ya está configurando ésto en todos los cargadores del módulo @ref{77,,importlib} y la importación misma está configurando la post carga del atributo.

Ahora se incluye el atributo @code{None} dentro de @ref{684,,sys.path_importer_cache} cuando no se encuentre ningún buscador en @ref{10a0,,sys.path_hooks}. Dado que @code{imp.NullImporter} no está directamente expuesto en @ref{10a0,,sys.path_hooks}, podría no haber una certeza de que esté disponible para su uso como un valor que represente que no se ha encontrado ningún buscador.

Todos los demás cambios se relacionan con los cambios de semántica que deben tomarse en cuenta al actualizar el código a python 3.3, por lo tanto, deben leerse en la sección @ref{10ea,,Portar código Python} de este documento.

(Implementación por Brett Cannon)

@node Otros cambios de idioma<5>,Un bloqueo de importación más detallado,Usar importlib como implementación de Import,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 other-language-changes}@anchor{10f3}
@subsection Otros cambios de idioma


Algunos cambios más pequeños realizados en el lenguaje Python principal son:


@itemize *

@item 
Added support for Unicode name aliases and named sequences.
Both @ref{10f4,,unicodedata.lookup()} and @code{'\N@{...@}'} now resolve name aliases,
and @ref{10f4,,unicodedata.lookup()} resolves named sequences too.

(Contribución de Ezio Melotti en bpo-12753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12753}.)

@item 
Base de datos `Unicode' actualizada a la versión 6.1.0 de UCD

@item 
Las comparaciones de igualdad en los objetos @ref{9d6,,range()} ahora retornan un resultado que refleja la igualdad de las secuencias subyacentes generadas por esos objetos de rango. (bpo-13201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13201})

@item 
Los métodos @code{count()}, @code{find()}, @code{rfind()}, @code{index()} y @code{rindex()} de los objetos @ref{325,,bytes} y @ref{5e0,,bytearray} ahora aceptan un entero entre 0 y 255 como su primer argumento.

(Contribución por Petri Lehtinen en bpo-12170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12170}.)

@item 
Los métodos @code{rjust()}, @code{ljust()}, y @code{center()} de @ref{325,,bytes} y @ref{5e0,,bytearray} ahora aceptan un @ref{5e0,,bytearray} para el argumento @code{fill}.  (Contribución de Petri Lehtinen en bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380}.)

@item 
Se han agregado nuevos métodos a @ref{18e,,list} y @ref{5e0,,bytearray}: @code{copy()} y @code{clear()} (bpo-10516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10516}). En consecuencia, @ref{309,,MutableSequence} ahora también definen un método @code{clear()} (bpo-11388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11388}).

@item 
Los literales de `bytes' sin formato ahora se pueden escribir @code{rb"..."} así como @code{br"..."}.

(Contribución de Antoine Pitrou en bpo-13748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13748}.)

@item 
El método @ref{10f5,,dict.setdefault()} ahora solo hace una sola búsqueda de la clave dada, haciéndola atómica cuando se usa con tipos incorporados.

(Contribución de Filip Gruszczyński en bpo-13521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13521}.)

@item 
Los mensajes de error producidos cuando la llamada de una función no coincide con la firma han sido mejorados significativamente.

(Contribución de Benjamin Peterson.)
@end itemize

@node Un bloqueo de importación más detallado,Funciones y tipos incorporados,Otros cambios de idioma<5>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 a-finer-grained-import-lock}@anchor{10f6}
@subsection Un bloqueo de importación más detallado


Las versiones anteriores de CPython siempre se han basado en un bloqueo de importación global. Ésto conduce a problemas inesperados tales como bloqueos cuando la importación un módulo debería disparar la ejecución de código en un hilo diferente como un efecto secundario. A veces se empleaban soluciones torpes, como la función de API C @ref{272,,PyImport_ImportModuleNoBlock()} .

En Python 3.3, la importación de un módulo toma un bloqueo por módulo.  Esto serializa correctamente la importación de un módulo determinado a partir de múltiples subprocesos (impidiendo la exposición de módulos inicializados incompletamente), mientras elimina las molestias antes mencionadas.

(Contribución de Antoine Pitrou en bpo-9260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9260}.)

@node Funciones y tipos incorporados,Nuevos módulos<8>,Un bloqueo de importación más detallado,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 builtin-functions-and-types}@anchor{10f7}
@subsection Funciones y tipos incorporados



@itemize *

@item 
@ref{1be,,open()} obtiene un nuevo parámetro `opener': el descriptor de archivo subyacente para el objeto de archivo se obtiene llamando a `opener' con (`file', `flags'). Se puede utilizar para utilizar banderas personalizadas como @ref{10f8,,os.O_CLOEXEC}, por ejemplo. Se ha añadido el modo @code{'x'} : abierto para la creación exclusiva, fallando si el archivo ya existe.

@item 
@ref{ff4,,print()}: agregó el argumento de palabra clave `flush'. Si el argumento de palabra clave `flush' es verdadero, la secuencia se vacía por la fuerza.

@item 
@ref{68b,,hash()}: la aleatorización de hash está habilitada de forma predeterminada, consulte @ref{b86,,object.__hash__()}  y 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED}.

@item 
El tipo @ref{237,,str} obtiene un nuevo método @ref{e5b,,casefold()}: retorna una copia de la cadena con mayúsculas y minúsculas, las cadenas con mayúsculas y minúsculas se pueden utilizar para la coincidencia sin mayúsculas. Por ejemplo, @code{'ß'.casefold()} retorna  @code{'ss'}.

@item 
La documentación de secuencia se ha reescrito sustancialmente para explicar mejor la distinción de secuencia binaria/texto y para proporcionar secciones de documentación específicas para los tipos de secuencia individuales integrados(bpo-4966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4966}).
@end itemize

@node Nuevos módulos<8>,Módulos mejorados<10>,Funciones y tipos incorporados,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 new-modules}@anchor{10fa}
@subsection Nuevos módulos


@menu
* faulthandler: faulthandler<2>. 
* ipaddress: ipaddress<4>. 
* lzma: lzma<2>. 

@end menu

@node faulthandler<2>,ipaddress<4>,,Nuevos módulos<8>
@anchor{whatsnew/3 3 faulthandler}@anchor{10fb}
@subsubsection faulthandler


Este nuevo módulo de depuración @ref{58,,faulthandler} contiene funciones para volcar los rastreos de Python explícitamente, en una falla (como una falla de segmentación), después de un tiempo de espera o en una señal de usuario. Llame a @ref{d27,,faulthandler.enable()} para instalar controladores de fallas para las señales @code{SIGSEGV}, @code{SIGFPE}, @code{SIGABRT}, @code{SIGBUS}, y @code{SIGILL} . También puede habilitarlos al inicio configurando la variable de entorno 
@geindex PYTHONFAULTHANDLER
@geindex variables de entorno; PYTHONFAULTHANDLER
@ref{10fc,,PYTHONFAULTHANDLER} o usando la opción de línea de comandos @ref{2e2,,-X} @code{faulthandler} .

Ejemplo de una falla de segmentación en Linux:

@example
$ python -q -X faulthandler
>>> import ctypes
>>> ctypes.string_at(0)
Fatal Python error: Segmentation fault

Current thread 0x00007fb899f39700:
  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
  File "<stdin>", line 1 in <module>
Segmentation fault
@end example

@node ipaddress<4>,lzma<2>,faulthandler<2>,Nuevos módulos<8>
@anchor{whatsnew/3 3 ipaddress}@anchor{10fd}
@subsubsection ipaddress


El nuevo módulo @ref{80,,ipaddress} proporciona herramientas para crear y manipular objetos que representen direcciones, redes e interfaces IPv4 e IPv6 (es decir, alguna dirección IP asociada con una subred IP específica)

(Contribución de Google y Peter Moody en 
@geindex Python Enhancement Proposals; PEP 3144
PEP 3144@footnote{https://peps.python.org/pep-3144/} )

@node lzma<2>,,ipaddress<4>,Nuevos módulos<8>
@anchor{whatsnew/3 3 lzma}@anchor{10fe}
@subsubsection lzma


El módulo @ref{8a,,lzma} recién agregado proporciona compresión y descompresión de datos utilizando el algoritmo LZMA, incluida la compatibilidad con los formatos de archivo @code{.xz} y @code{.lzma}.

(Contribución de Nadeem Vawda y Per Øyvind Karlsen en bpo-6715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6715}.)

@node Módulos mejorados<10>,Optimizaciones<9>,Nuevos módulos<8>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 improved-modules}@anchor{10ff}
@subsection Módulos mejorados


@menu
* abc: abc<2>. 
* array: array<3>. 
* base64: base64<4>. 
* binascii: binascii<3>. 
* bz2: bz2<2>. 
* códecs: códecs<2>. 
* colecciones: colecciones<3>. 
* contextlib: contextlib<7>. 
* crypt: crypt<2>. 
* curses: curses<3>. 
* datetime: datetime<4>. 
* decimal: decimal<4>. 
* email: email<5>. 
* ftplib: ftplib<3>. 
* functools: functools<6>. 
* gc: gc<4>. 
* hmac: hmac<4>. 
* http: http<5>. 
* html: html<2>. 
* imaplib: imaplib<3>. 
* inspect: inspect<5>. 
* io: io<7>. 
* itertools: itertools<7>. 
* logging: logging<4>. 
* math: math<6>. 
* mmap: mmap<4>. 
* multiprocesamiento: multiprocesamiento<4>. 
* nntplib: nntplib<2>. 
* os: os<12>. 
* pdb: pdb<7>. 
* pickle: pickle<4>. 
* pydoc: pydoc<4>. 
* re: re<9>. 
* sched:: 
* select:: 
* shlex: shlex<3>. 
* shutil: shutil<6>. 
* signal: signal<3>. 
* smtpd: smtpd<4>. 
* smtplib: smtplib<4>. 
* socket: socket<5>. 
* socketserver: socketserver<2>. 
* sqlite3: sqlite3<11>. 
* ssl: ssl<11>. 
* stat: stat<2>. 
* struct: struct<2>. 
* subprocess: subprocess<4>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* tempfile: tempfile<3>. 
* textwrap: textwrap<2>. 
* threading: threading<5>. 
* time: time<5>. 
* types: types<5>. 
* unittest: unittest<9>. 
* urllib: urllib<5>. 
* webbrowser: webbrowser<3>. 
* xml.etree.ElementTree: xml etree ElementTree<2>. 
* zlib: zlib<2>. 

@end menu

@node abc<2>,array<3>,,Módulos mejorados<10>
@anchor{whatsnew/3 3 abc}@anchor{1100}
@subsubsection abc


Soporte mejorado para las clases base abstractas que contienen descriptores compuestos con métodos abstractos. El enfoque recomendado para declarar descriptores abstractos ahora es proporcionar @code{__isabstractmethod__} como una propiedad actualizada dinámicamente. Los descriptores integrados han sido actualizados en consecuencia.


@itemize *

@item 
La clase @ref{1101,,abc.abstractproperty} ha quedado obsoleta, en su lugar use la clase @ref{2fd,,property} con @ref{1102,,abc.abstractmethod()}.

@item 
La clase @ref{1103,,abc.abstractclassmethod} ha quedado obsoleta. En su lugar use el método @ref{2d2,,classmethod} with @ref{1102,,abc.abstractmethod()}.

@item 
@ref{1104,,abc.abstractstaticmethod} ha quedado obsoleta, use @ref{22e,,staticmethod} with @ref{1102,,abc.abstractmethod()}.
@end itemize

(Contribución de Darren Dale en bpo-11610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11610}. )

El método @ref{1105,,abc.ABCMeta.register()} ahora retorna las subclases registradas, lo cual significa que ahora éste puede ser usado como un decorador de clases (bpo-10868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10868}).

@node array<3>,base64<4>,abc<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 array}@anchor{1106}
@subsubsection array


El módulo @ref{8,,array} admite el tipo long long utilizando los códigos de tipo @code{q} y @code{Q}.

(Contribución de Oren Tirosh y Hirokazu Yamamoto en bpo-1172711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1172711}.)

@node base64<4>,binascii<3>,array<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 base64}@anchor{1107}
@subsubsection base64


Las cadenas `Unicode' de solo ASCII ahora son aceptadas por las funciones de decodificación de la interfaz moderna @ref{f,,base64}. Por ejemplo, @code{base64.b64decode ('YWJj')} retorna @code{b'abc'}. (Contribución por Catalin Iacob en: número: @cite{13641}.)

@node binascii<3>,bz2<2>,base64<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 binascii}@anchor{1108}
@subsubsection binascii


Además de los objetos binarios que normalmente aceptan, las funciones @code{a2b_} ahora también aceptan cadenas de sólo ASCII como dato de entrada. (Contribución por Antoine Petrou en bpo-13637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13637}.)

@node bz2<2>,códecs<2>,binascii<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 bz2}@anchor{1109}
@subsubsection bz2


El módulo @ref{14,,bz2} ha sido reescrito desde cero. Durante el proceso, han sido agregadas varias características:


@itemize *

@item 
Nueva función @ref{110a,,bz2.open()}: abre un archivo comprimido por bzip2, en modo binario o en modo de texto.

@item 
@ref{8fd,,bz2.BZ2File} ahora puede leer y escribir en objetos de tipo archivo arbitrarios, mediante el argumento `fileobj' de su constructor.

(Contribución de Nadeem Vawda en bpo-5863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5863}.)

@item 
La clase @ref{8fd,,bz2.BZ2File} y la función @ref{110b,,bz2.decompress()} ahora descomprimen entradas de flujo múltiple (como las producidas por la herramienta @code{pbzip2}). La clase @ref{8fd,,bz2.BZ2File} ahora puede ser usada también para crear este tipo de archivos, usando el modo @code{'a'} (agregar).

(Contribución de Nir Aides en bpo-1625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1625}.)

@item 
La clase @ref{8fd,,bz2.BZ2File} ahora implementa toda la API @ref{735,,io.BufferedIOBase}, excepto los métodos @code{detach()} y @code{truncate()}.
@end itemize

@node códecs<2>,colecciones<3>,bz2<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 codecs}@anchor{110c}
@subsubsection códecs


El códec @ref{53,,mbcs} ha sido reescrito para manejar correctamente los controladores de error @code{reemplazar} e @code{ignorar} en todas las versiones Windows. El códec @ref{53,,mbcs} ahora admite todos los controladores de error, en lugar de solo @code{replace} para codificar e @code{ignore} para decodificar.

Ha sido agregado un nuevo códec únicamente para windows: @code{cp65001} (bpo-13216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13216}). Es la página de códigos de Windows con el código 65001 (Windows UTF-8, @code{CP_UTF8}).  Por ejemplo, es usado por @code{sys.stdout} si la página de códigos de salida de la consola se establece en cp65001 (por ejemplo, usando el comando @code{chcp 65001}).

Los decodificadores CJK multibyte ahora se re-sincronizan más rápido. Solo ignoran el primer byte de una secuencia de `bytes' no válida. Por ejemplo, @code{b'\xff\n'.decode('gb2312', 'replace')} ahora retorna un @code{\n} después del carácter de reemplazo.

(bpo-12016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12016})

Los codificadores de códec incrementales CJK ya no se restablecen en cada llamada a sus métodos encode(). Por ejemplo:

@example
>>> import codecs
>>> encoder = codecs.getincrementalencoder('hz')('strict')
>>> b'@w{'}.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
b'~@{NpJ)l6HK!#~@} Bye.'
@end example

Este ejemplo resulta @code{b'~@{Np~@}~@{J)~@}~@{l6~@}~@{HK~@}~@{!#~@} Bye.'} con versiones anteriores de Python.

(bpo-12100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12100})

El códec @code{unicode_internal} ha quedado obsoleto.

@node colecciones<3>,contextlib<7>,códecs<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 collections}@anchor{110d}
@subsubsection colecciones


Adición de una nueva @ref{ca4,,ChainMap} para permitir el tratamiento de un número de asignaciones como una sola unidad. (Escrito por Raymond Hettinger para bpo-11089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11089}, publicado en bpo-11297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11297}.)

Las clases base abstractas se han movido en un nuevo módulo @ref{1f,,collections.abc}, para diferenciar mejor entre las clases de colecciones abstractas y concretas. Los alias para ABC siguen presentes en el módulo @ref{1e,,collections} para preservar las importaciones existentes. (bpo-11085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11085})

@c XXX addition of __slots__ to ABCs not recorded here: internal detail

La clase @ref{110e,,Counter} ahora admite los operadores “”+”” y “”-”” unarios, así como los operadores in situ @code{+=}, @code{-=}, @code{|=}, and @code{&=}. (Contribución de Raymond Hettinger en bpo-13121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13121}.)

@node contextlib<7>,crypt<2>,colecciones<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 contextlib}@anchor{110f}
@subsubsection contextlib


@code{ ExitStack} ahora proporciona una base sólida para la manipulación programática de los administradores de contexto y una funcionalidad de limpieza similar. A diferencia de la API anterior @code{contextlib.nested} (que estaba en desuso y se eliminó), la nueva API está diseñada para funcionar correctamente independientemente de si los administradores de contexto adquieren sus recursos en su método @code{__init__} (por ejemplo, objetos de archivo) o en su método @code{__enter__} (por ejemplo, objetos de sincronización del módulo @ref{ed,,threading}).

(bpo-13585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13585})

@node crypt<2>,curses<3>,contextlib<7>,Módulos mejorados<10>
@anchor{whatsnew/3 3 crypt}@anchor{1110}
@subsubsection crypt


Addition of salt and modular crypt format (hashing method) and the @code{mksalt()}
function to the @code{crypt} module.

(bpo-10924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10924})

@node curses<3>,datetime<4>,crypt<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 curses}@anchor{1111}
@subsubsection curses



@itemize *

@item 
Si el módulo @ref{2c,,curses} es vinculado a la nueva librería ncursesw, se usan las funciones `Unicode' cuando se pasen cadenas o caracteres Unicode (por ejemplo, la función @code{waddwstr()}) o en caso contrario, funciones de `bytes' (e.g. @code{waddstr()}).

@item 
Usa la codificación local en vez de @code{utf-8} para codificar cadenas `Unicode'.

@item 
La clase @code{curses.window} tiene un nuevo atributo @ref{1112,,curses.window.encoding}.

@item 
La clase @code{curses.window} tiene un nuevo método @ref{1113,,get_wch()} para obtener un caracter ancho

@item 
El módulo @ref{2c,,curses} tiene una nueva función @ref{1114,,unget_wch()} para enviar un caracter ancho de manera que el próximo @ref{1113,,get_wch()} lo retorne
@end itemize

(Contribución por Iñigo Serna en bpo-6755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6755}.)

@node datetime<4>,decimal<4>,curses<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 datetime}@anchor{1115}
@subsubsection datetime



@itemize *

@item 
Las comparaciones de igualdad entre instancias conscientes e ingenuas @ref{32f,,datetime} ahora retornan @ref{bbf,,False} en lugar de generar @ref{228,,TypeError} (bpo-15006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15006}).

@item 
Nuevo método @ref{1116,,datetime.datetime.timestamp()}: Retorna la marca de tiempo POSIX correspondiente a la instancia @ref{32f,,datetime}.

@item 
El método @ref{d19,,datetime.datetime.strftime()} admite el formato de años anteriores a 1000.

@item 
Ahora se puede llamar al método @ref{a62,,datetime.datetime.astimezone()} sin argumentos para convertir la instancia datetime en la zona horaria del sistema.
@end itemize

@node decimal<4>,email<5>,datetime<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 decimal}@anchor{1117}@anchor{whatsnew/3 3 new-decimal}@anchor{10bb}
@subsubsection decimal



@table @asis

@item bpo-7652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7652} - integrar la aritmética decimal nativa rápida.

Módulo C y libmpdec escritos por Stefan Krah.
@end table

The new C version of the decimal module integrates the high speed libmpdec
library for arbitrary precision correctly rounded decimal floating-point
arithmetic. libmpdec conforms to IBM’s General Decimal Arithmetic Specification.

Performance gains range from 10x for database applications to 100x for
numerically intensive applications. These numbers are expected gains
for standard precisions used in decimal floating-point arithmetic. Since
the precision is user configurable, the exact figures may vary. For example,
in integer bignum arithmetic the differences can be significantly higher.

La siguiente tabla está pensada como una ilustración. Los puntos de referencia están disponibles en @indicateurl{https://www.bytereef.org/mpdecimal/quickstart.html}.

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} 
@headitem

@tab

decimal.py

@tab

_decimal

@tab

speedup

@item

pi

@tab

42.02s

@tab

0.345s

@tab

120x

@item

telco

@tab

172.19s

@tab

5.68s

@tab

30x

@item

psycopg

@tab

3.57s

@tab

0.29s

@tab

12x

@end multitable

@end quotation

@menu
* Características: Características<2>. 
* Cambios en la API: Cambios en la API<2>. 

@end menu

@node Características<2>,Cambios en la API<2>,,decimal<4>
@anchor{whatsnew/3 3 id1}@anchor{1118}
@subsubsection Características



@itemize *

@item 
La señal @ref{1119,,FloatOperation} habilita opcionalmente las semánticas estrictas para mezclar decimales y flotantes.

@item 
Si python se compila sin subprocesos, la versión C deshabilita automáticamente la costosa maquinaria de contexto local de subprocesos. En éste caso, la variable @ref{111a,,HAVE_THREADS} se establece en @code{False}.
@end itemize

@node Cambios en la API<2>,,Características<2>,decimal<4>
@anchor{whatsnew/3 3 id2}@anchor{111b}
@subsubsection Cambios en la API



@itemize *

@item 
El módulo C tiene los siguientes límites de contexto, dependiendo de la arquitectura de la máquina:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32-bit

@tab

64-bit

@item

@code{MAX_PREC}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@code{MAX_EMAX}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@code{MIN_EMIN}

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@end multitable

@end quotation

@item 
En las plantillas de contexto (@ref{111c,,DefaultContext}, @ref{111d,,BasicContext} and @ref{111e,,ExtendedContext}) la magnitud de @code{Emax} y @code{Emin} se ha cambiado a @code{999999}.

@item 
El constructor @ref{16a,,Decimal} en decimal.py no observa los límites de contexto y convierte valores con exponentes arbitrarios o precisión exacta. Dado que la versión C tiene límites internos, se usa el siguiente esquema: Si es posible, los valores son convertidos a valores exactos, de lo contrario se genera @ref{111f,,InvalidOperation} y el resultado es NaN. En éste último caso siempre es posible usar @ref{1120,,create_decimal()} para obtener un valor redondeado o inexacto.

@item 
La función de potencia en decimal.py siempre se redondea correctamente. En la versión C, se define en términos de las funciones @ref{1121,,exp()} y @ref{1122,,ln()} correctamente redondeadas, pero el resultado final es solo «casi siempre correctamente redondeado».

@item 
En la versión C, el diccionario de contexto que contiene las señales, es una @ref{1123,,MutableMapping}. Por razones de velocidad, @code{flags} y @code{traps} siempre se refiere a la misma @ref{1123,,MutableMapping} que el contexto con el que se inicializó. Si se asigna un nuevo diccionario de señales, @code{flags} y @code{traps} son actualizados con los nuevos valores, pero no hacen referencia al diccionario RHS.

@item 
Decapar a @ref{1124,,Context} produce una salida diferente para tener un formato de intercambio común para las versiones de Python y C.

@item 
El orden de los argumentos en el constructor de la clase @ref{1124,,Context}, ha sido cambiado para que coincida con el orden mostrado por la función @ref{894,,repr()}.

@item 
El parámetro @code{watchexp} en el método @ref{1125,,quantize()} ha quedado obsoleto.
@end itemize

@node email<5>,ftplib<3>,decimal<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 email}@anchor{1126}@anchor{whatsnew/3 3 new-email}@anchor{10bc}
@subsubsection email


@menu
* Marco de políticas:: 
* Política provisional con nueva API de encabezado:: 
* Otros cambios en la API:: 

@end menu

@node Marco de políticas,Política provisional con nueva API de encabezado,,email<5>
@anchor{whatsnew/3 3 policy-framework}@anchor{1127}
@subsubsection Marco de políticas


El paquete de correo electrónico ahora tiene un marco @ref{50,,policy}.  Un @ref{1128,,Policy} es un objeto con varios métodos y propiedades que controlan el comportamiento del paquete de correo electrónico.  La política principal de Python 3.3 es la política @ref{1129,,Compat32}, que proporciona compatibilidad con versiones anteriores del paquete de correo electrónico en Python 3.2.  Se puede especificar una @code{policy} cuando un mensaje de correo electrónico es analizado por un @ref{4f,,parser}, o cuando se crea un objeto @ref{3d1,,Message}, o cuando se serializa un correo electrónico mediante un @ref{41,,generator}. A menos que se invalide, una política pasada a un @code{parser} es heredada por todos los objetos @code{Message} y los subobjetos creados por el @code{parser}. De forma predeterminada, un @code{generator} utilizará la política del objeto @code{Message} que está serializando. La directiva predeterminada es @ref{d22,,compat32}.

El conjunto mínimo de controles implementado por todos los objetos @code{policy} son:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

max_line_length

@tab

La longitud máxima, excluyendo el(los) caracter(es) `linesep', que las líneas individuales pueden tener cuando un @code{Message} se serializa es por defecto de 78.

@item

`linesep'

@tab

El caracter usado para separar las líneas individuales cuando se serializa un @code{Message} es por defecto @code{\n}.

@item

cte_type

@tab

@code{7bit} or @code{8bit}. @code{8bit} sólo se aplica a un @code{Bytes} @code{generator}, y significa que pueden utilizarse «no ASCII» cuando lo permita el protocolo (o cuando exista en la entrada original).

@item

raise_on_defect

@tab

Hace que un “”analizador”” genere el error cuando se encuentran defectos en lugar de agregarlos a la lista “”Mensaje”” del objeto “”defectos””.

@end multitable


Una nueva instancia de directiva, con nueva configuración, se crea mediante el método @ref{112a,,clone()} de objetos de política. @code{clone} toma cualquiera de los controles anteriores como argumentos de palabra clave. Cualquier control no especificado en la llamada conserva su valor predeterminado.  Por lo tanto, puede crear una directiva que utilice caracteres `linesep' @code{\r\n} como este:

@example
mypolicy = compat32.clone(linesep='\r\n')
@end example

Las directivas pueden ser usadas para facilitar la generación de mensajes en el formato requerido por la aplicación. En vez de tener que recordar especificar @code{linesep='\r\n'} en todos los lugares en donde llamas a @code{generator}, puedes especificarlo una sola vez cuando estableces la política usada por el @code{analizador} o el @code{Mensaje}, el que tu programa utilice para crear los objetos @code{Mensaje}. Por otra parte, si necesitas generar mensajes en múltiples formas, aún puedes especificar los parámetros en la llamada al generador apropiado. O puedes tener instancias de política personalizadas para tus distintos casos, y pasarlos al crear el @code{generator}.

@node Política provisional con nueva API de encabezado,Otros cambios en la API,Marco de políticas,email<5>
@anchor{whatsnew/3 3 provisional-policy-with-new-header-api}@anchor{112b}
@subsubsection Política provisional con nueva API de encabezado


Aunque el marco de políticas vale la pena por sí solo, la principal motivación para presentarlo es permitir la creación de nuevas políticas que implementen nuevas características para el paquete de correo electrónico, de modo que mantenga la compatibilidad con versiones anteriores para aquellos quienes no usen las nuevas directivas. Dado que las nuevas políticas introducen una nueva API, estamos lanzándolas en Python 3.3 como una @ref{10bd,,provisional policy}. Pueden producirse cambios incompatibles con versiones anteriores (hasta la eliminación del código) si los desarrolladores principales lo consideran necesario.

Las nuevas directivas son instancias de @ref{112c,,EmailPolicy}, y agregan los siguientes controles adicionales:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

refold_source

@tab

Controla si los encabezados analizados por un @ref{4f,,parser} son replegados por @ref{41,,generator}. Éste puede ser @code{none}, @code{long}, o @code{all}. El valor por defecto es @code{long}, lo que significa que los encabezados principales con una linea más larga que @code{max_line_length} se repliegan. @code{none} significa que no se repliega ninguna linea, y @code{all} significa que todas las lineas son replegadas.

@item

header_factory

@tab

Un invocable que toma un @code{nombre} y un @code{valor} y produce un objeto de encabezado personalizado.

@end multitable


El @code{header_factory} es la clave a las nuevas características proporcionadas por las nuevas directivas. Cuando se usa una de las nuevas directivas, cualquier encabezado retornado por un objeto @code{Message} es un objeto producido por el @code{header_factory}, y en cualquier momento que se establece un encabezado en un @code{Message}, éste se convierte en un objeto producido por @code{header_factory}. Todos éstos objetos de encabezado tienen un atributo @code{name} igual al nombre del encabezado. Los encabezados de direcciones y fechas tienen atributos adicionales que te dan acceso a los datos analizados del encabezado. Ésto significa que ahora puedes hacer cosas como ésta:

@example
>>> m = Message(policy=SMTP)
>>> m['To'] = 'Éric <foo@@example.com>'
>>> m['to']
'Éric <foo@@example.com>'
>>> m['to'].addresses
(Address(display_name='Éric', username='foo', domain='example.com'),)
>>> m['to'].addresses[0].username
'foo'
>>> m['to'].addresses[0].display_name
'Éric'
>>> m['Date'] = email.utils.localtime()
>>> m['Date'].datetime
datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
>>> m['Date']
'Fri, 25 May 2012 21:44:27 -0400'
>>> print(m)
To: =?utf-8?q?=C3=89ric?= <foo@@example.com>
Date: Fri, 25 May 2012 21:44:27 -0400
@end example

Notarás que el nombre de visualización `Unicode' se codifica automáticamente como @code{utf-8} cuando se serializa el mensaje, pero que cuando se accede al encabezado directamente, obtienes la versión unicode. Ésto elimina cualquier necesidad de lidiar con las funciones @ref{42,,email.header} @ref{112d,,decode_header()} or @ref{112e,,make_header()}.

También puedes crear direcciones a partir de partes:

@example
>>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
...                           Address('Sally', 'sally', 'example.com')]),
...            Address('Bonzo', addr_spec='bonz@@laugh.com')]
>>> print(m)
To: =?utf-8?q?=C3=89ric?= <foo@@example.com>
Date: Fri, 25 May 2012 21:44:27 -0400
cc: pals: Bob <bob@@example.com>, Sally <sally@@example.com>;, Bonzo <bonz@@laugh.com>
@end example

La decodificación a `Unicode' se realiza automáticamente:

@example
>>> m2 = message_from_string(str(m))
>>> m2['to']
'Éric <foo@@example.com>'
@end example

Cuando analizas un mensaje, puedes usar los atributos @code{addresses} y @code{groups} de los objetos de encabezado, para acceder a los grupos y direcciones individuales:

@example
>>> m2['cc'].addresses
(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com'))
>>> m2['cc'].groups
(Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),))
@end example

En resumen, si usas una de las nuevas directivas, la manipulación de encabezados funciona del modo que debería: Su aplicación funciona con cadenas `unicode', y el paquete de correo electrónico codifica y decodifica de forma transparente el unicode desde y hacia las codificaciones de transferencia de contenido estándar RFC.

@node Otros cambios en la API,,Política provisional con nueva API de encabezado,email<5>
@anchor{whatsnew/3 3 other-api-changes}@anchor{112f}
@subsubsection Otros cambios en la API


Nuevo @ref{1130,,BytesHeaderParser}, añadido al módulo @ref{4f,,parser} para complementar @ref{1131,,HeaderParser} y completar la API Bytes.

Nuevas funciones de utilidad:


@itemize *

@item 
@ref{1132,,format_datetime()}: dado un @ref{32f,,datetime}, produce una cadena formateada para su uso en un encabezado de correo electrónico.

@item 
@ref{1133,,email.utils.parsedate_to_datetime()}: dada una cadena de fecha de un encabezado de correo electrónico, conviértela en un @ref{32f,,datetime.datetime}, o un ingenuo @ref{32f,,datetime.datetime} si el desplazamiento es @code{-0000}.

@item 
@ref{217,,localtime()}: Sin argumento, retorna la hora local actual como un reconocimiento @ref{32f,,datetime} utilizando el local @ref{1134,,timezone}.  Teniendo en cuenta @ref{32f,,datetime}, lo convierte en un @ref{32f,,datetime} con el valor local @ref{1134,,timezone}.
@end itemize

@node ftplib<3>,functools<6>,email<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 ftplib}@anchor{1135}
@subsubsection ftplib



@itemize *

@item 
@ref{990,,ftplib.FTP} ahora acepta un argumento de palabra clave @code{source_address} para especificar el @code{(host, port)} que se usará como dirección de origen en la llamada de enlace al crear el socket saliente.  (Contribución de Giampaolo Rodolà en bpo-8594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8594}.)

@item 
La clase @ref{991,,FTP_TLS} ahora proporciona una nueva función @ref{1136,,ccc()} para revertir el canal de control a texto sin formato.  Esto puede ser útil para aprovechar los firewalls que saben cómo manejar NAT con FTP no seguro sin abrir puertos fijos. (Contribución de Giampaolo Rodolà en bpo-12139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12139}.)

@item 
Añadido el método @ref{1137,,ftplib.FTP.mlsd()} que proporciona un formato de listado de directorios analizable y pone en desuso @ref{1138,,ftplib.FTP.nlst()} y @ref{1139,,ftplib.FTP.dir()}. (Contribución de Giampaolo Rodolà en bpo-11072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11072}.)
@end itemize

@node functools<6>,gc<4>,ftplib<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 functools}@anchor{113a}
@subsubsection functools


El decorador @ref{a81,,functools.lru_cache()} ahora acepta un argumento de palabra clave @code{typed} (que por defecto tiene el valor @code{False} para asegurar que almacene en caché  valores de diferentes tipos que se comparen igual en ranuras separadas de caché. (Contribución de Raymond Hettinger en bpo-13227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13227}.)

@node gc<4>,hmac<4>,functools<6>,Módulos mejorados<10>
@anchor{whatsnew/3 3 gc}@anchor{113b}
@subsubsection gc


Ahora es posible registrar devoluciones de llamadas invocadas por el recolector de basura antes y después de la recolección, utilizando la nueva lista @ref{113c,,callbacks}.

@node hmac<4>,http<5>,gc<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 hmac}@anchor{113d}
@subsubsection hmac


Se ha agregado una nueva función @ref{113e,,compare_digest()} para prevenir los ataques de canales adyacentes en resúmenes durante el análisis de tiempos. (Contribución de Nick Coghlan y Christian Heimes en bpo-15061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15061}.)

@node http<5>,html<2>,hmac<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 http}@anchor{113f}
@subsubsection http


@ref{1140,,http.server.BaseHTTPRequestHandler} ahora almacena en buffer los encabezados y los escribe todos a la vez cuando se llama a @ref{1141,,end_headers()}. Se puede usar un nuevo método @code{flush_headers()} para administrar directamente cuándo se envían los encabezados acumulados. (Contribución por Andrew Schaaf en bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709}.)

@ref{72,,http.server} ahora produce una salida @code{HTML 4.01 strict} válida. (Contribución de Ezio Melotti in bpo-13295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13295})

La clase @ref{1142,,http.client.HTTPResponse} ahora tiene un método @ref{1143,,readinto()}, lo que significa que puede ser usado como una clase @ref{1144,,io.RawIOBase}. (Contribución de John Kuhn in bpo-13464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13464})

@node html<2>,imaplib<3>,http<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 html}@anchor{1145}
@subsubsection html


@ref{90e,,html.parser.HTMLParser} ahora puede analizar el marcado no válido sin generar errores, por lo tanto, el argumento `strict' del constructor y la excepción @code{HTMLParseError} ahora están en desuso. La habilidad de analizar marcado inválido es el resultado de un número de correcciones que también están disponibles en la última versión de solución de bugs de Python 2.7/3.2. (Contribución de Ezio Melotti en bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}, y bpo-14538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14538}, bpo-13993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13993}, bpo-13960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13960}, bpo-13358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13358}, bpo-1745761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1745761}, bpo-755670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=755670}, bpo-13357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13357}, bpo-12629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12629}, bpo-1200313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1200313}, bpo-670664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=670664}, bpo-13273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13273}, bpo-12888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12888}, bpo-7311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7311}.)

Se ha agregado un nuevo diccionario @ref{1146,,html5} que asigna referencias de caracteres con nombre HTML5 a los caracteres `Unicode' equivalentes (por ejemplo, @code{html5['gt;'] == '>'}) ha sido agregado al módulo @ref{6c,,html.entities}. El diccionario ahora también es utilizado por @ref{90e,,HTMLParser}. (Contribución por Ezio Melotti en bpo-11113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11113} y bpo-15156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15156}.)

@node imaplib<3>,inspect<5>,html<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 imaplib}@anchor{1147}
@subsubsection imaplib


El constructor de @ref{99a,,IMAP4_SSL} ahora acepta un parámetro SSLContext para controlar los parámetros del canal seguro.

(Contribución de Sijin Joseph en bpo-8808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8808}.)

@node inspect<5>,io<7>,imaplib<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 inspect}@anchor{1148}
@subsubsection inspect


Se ha añadido una nueva función @ref{1149,,getclosurevars()}. Esta función notifica el enlace actual de todos los nombres a los que se hace referencia desde el cuerpo de la función y dónde se resolvieron esos nombres, lo que facilita la comprobación del estado interno correcto al probar el código que se basa en cierres con estado.

(Contribución de Meador Inge y Nick Coghlan en bpo-13062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13062}.)

Se ha añadido una nueva función @ref{114a,,getgeneratorlocals()}. Esta función informa del enlace actual de variables locales en el marco de pila del generador, lo que facilita la comprobación del estado interno correcto al probar generadores.

(Contribución de Meador Inge en bpo-15153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15153}.)

@node io<7>,itertools<7>,inspect<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 io}@anchor{114b}
@subsubsection io


La función @ref{5c0,,open()} tiene un nuevo modo @code{'x'} que puede ser usado exclusivamente para crear un nuevo archivo, y lanzar un @ref{109c,,FileExistsError} si el archivo ya existe. Este está basado en el modo C11 “x” para fopen().

(Contribución de David Townsend en bpo-12760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12760}.)

El constructor de la clase @ref{854,,TextIOWrapper} tiene un nuevo argumento opcional `write_through'. Si `write_through' es @code{True}, se garantiza que las llamadas a @code{write()} no se almacenarán en buffer: Cualquier dato escrito en el objeto @ref{854,,TextIOWrapper} es llevado inmediatamente a su buffer subyacente.

@node itertools<7>,logging<4>,io<7>,Módulos mejorados<10>
@anchor{whatsnew/3 3 itertools}@anchor{114c}
@subsubsection itertools


@ref{a8f,,accumulate()} ahora toma un argumento opcional @code{func} para proporcionar una función binaria proporcionada por el usuario.

@node logging<4>,math<6>,itertools<7>,Módulos mejorados<10>
@anchor{whatsnew/3 3 logging}@anchor{114d}
@subsubsection logging


La función @ref{a92,,basicConfig()} ahora admite un argumento opcional @code{handlers} tomando un iterable de manejadores para agregarlo en el registrador raíz.

Un atributo de nivel de la clase @code{append_nul} ha sido agregado a la clase @ref{6fd,,SysLogHandler} para permitir el control de la adición de @code{NUL} (@code{\000}) byte a los registros de syslog, dado que para algunos demonios es requerido mientras que para otros se pasa al registro.

@node math<6>,mmap<4>,logging<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 math}@anchor{114e}
@subsubsection math


El módulo @ref{8e,,math} tiene una nueva función, @ref{114f,,log2()}, la cual retorna el logaritmo de `x' en base 2.

(Escrito por Mark Dickinson en bpo-11888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11888}.)

@node mmap<4>,multiprocesamiento<4>,math<6>,Módulos mejorados<10>
@anchor{whatsnew/3 3 mmap}@anchor{1150}
@subsubsection mmap


El método @ref{1151,,read()} ahora es más compatible con otros objetos similares a archivos: Si se omite el argumento o se especifica como @code{None}, retorna los `bytes' desde la posición actual hasta el final del mapeo. (Contribución de Petri Lehtinen en bpo-12021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12021}.)

@node multiprocesamiento<4>,nntplib<2>,mmap<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 multiprocessing}@anchor{1152}
@subsubsection multiprocesamiento


La nueva función @ref{1153,,multiprocessing.connection.wait()} permite sondear varios objetos (como conexiones, sockets y tuberías) con un tiempo de espera. (Contribución de Richard Oudkerk en bpo-12328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12328}.)

Los objetos @code{multiprocessing.Connection} ahora se pueden transferir a través de conexiones de multiprocesamiento. (Contribución de Richard Oudkerk en bpo-4892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4892}.)

@ref{be1,,multiprocessing.Process} ahora acepta un argumento de palabra clave @code{daemon} para invalidar el comportamiento predeterminado de heredar el indicador @code{daemon} del proceso primario (bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064}).

Nuevo atributo @ref{1154,,multiprocessing.Process.sentinel} permite que un programa espere múltiples objetos @ref{be1,,Process} a la vez utilizando las primitivas adecuadas del sistema operativo (por ejemplo, @ref{c1,,select} en sistemas posix).

Los nuevos métodos @ref{1155,,multiprocessing.pool.Pool.starmap()} y @ref{1156,,starmap_async()} proporcionan @ref{1157,,itertools.starmap()} equivalentes a las funciones existentes @ref{1158,,multiprocessing.pool.Pool.map()} y @ref{1159,,map_async()}. (Contribución de Hynek Schlawack en bpo-12708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12708}.)

@node nntplib<2>,os<12>,multiprocesamiento<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 nntplib}@anchor{115a}
@subsubsection nntplib


The @code{nntplib.NNTP} class now supports the context management protocol to
unconditionally consume @ref{10d1,,socket.error} exceptions and to close the NNTP
connection when done:

@example
>>> from nntplib import NNTP
>>> with NNTP('news.gmane.org') as n:
...     n.group('gmane.comp.python.committers')
...
('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
>>>
@end example

(Contribución de Giampaolo Rodolà en bpo-9795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9795}.)

@node os<12>,pdb<7>,nntplib<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 os}@anchor{115b}
@subsubsection os



@itemize *

@item 
El módulo @ref{a1,,os} tiene una nueva función @ref{115c,,pipe2()} que hace posible crear una tubería con banderas @ref{10f8,,O_CLOEXEC} o @ref{ec0,,O_NONBLOCK} establecida automáticamente. Esto es especialmente útil para evitar las condiciones de carrera en programas multi-hilos.

@item 
El módulo @ref{a1,,os}  tiene una nueva función @ref{b9a,,sendfile()} que proporciona una forma eficiente de «copia cero»  para copiar datos desde un descriptor de archivo (o socket) a otro. La frase «copia cero» se refiere al hecho de que la copia de los datos entre dos descriptores es realizada en su totalidad por el kernel, sin copiar los datos en los búferes del espacio de usuario. La función @ref{b9a,,sendfile()} puede ser usada para copiar datos de forma eficiente desde un archivo en el disco a un conector de red, por ejemplo para descargar un archivo.

(Revisión enviada por Ross Lagerwall y Giampaolo Rodolà en bpo-10882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10882}.)

@item 
Para evitar las condiciones de carrera, como los ataques symlink, y errores con archivos temporales y directorios, es preferible (y más rápido) manipular los descriptores de archivos en vez de los nombres de archivos. Python 3.3 mejora las funciones existentes e introduce nuevas funciones para trabajar con los descriptores de archivos (bpo-4761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4761}, bpo-10755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10755} and bpo-14626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14626}).


@itemize -

@item 
El módulo @ref{a1,,os} tiene una nueva función @ref{be3,,fwalk()} similar a @ref{551,,walk()} excepto que también incluye descriptores de archivos que se refieren a los directorios visitados. Esto es especialmente útil para prevenir las carreras de enlaces simbólicos.

@item 
Las siguientes funciones tienen las nuevas opciones `dir_fd' (@ref{115d,,rutas relativas a descriptores de archivos}) y/o `follow_symlinks' (@ref{115e,,not following symlinks}): @ref{115f,,access()}, @ref{1160,,chflags()}, @ref{378,,chmod()}, @ref{1161,,chown()}, @ref{1162,,link()}, @ref{549,,lstat()}, @ref{37a,,mkdir()}, @ref{e16,,mkfifo()}, @ref{e17,,mknod()}, @ref{e18,,open()}, @ref{9b4,,readlink()}, @ref{1163,,remove()}, @ref{1164,,rename()}, @ref{1165,,replace()}, @ref{1166,,rmdir()}, @ref{548,,stat()}, @ref{1167,,symlink()}, @ref{1168,,unlink()}, @ref{1169,,utime()}. El soporte de la plataforma para usar éstos parámetros puede verificarse a través de los conjuntos @ref{116a,,os.supports_dir_fd} and @code{os.supports_follows_symlinks}.

@item 
Las siguientes funciones ahora admiten un descriptor de archivos para su argumento de ruta: @ref{6ae,,chdir()}, @ref{378,,chmod()}, @ref{1161,,chown()}, @ref{116b,,execve()}, @ref{116c,,listdir()}, @ref{116d,,pathconf()}, @ref{aa0,,exists()}, @ref{548,,stat()}, @ref{116e,,statvfs()}, @ref{1169,,utime()}. El soporte de la plataforma para ésto puede ser verificado a través del conjunto @ref{116f,,os.supports_fd}.
@end itemize

@item 
@ref{115f,,access()} acepta un argumento de palabra clave @code{effective_ids} acepta el uso del uid/gid efectivo en lugar del uid/gid real en la comprobación de acceso. El soporte de la plataforma para ésto, se puede comprobar a través del conjunto @ref{1170,,supports_effective_ids}.

@item 
El módulo @ref{a1,,os} tiene dos nuevas funciones @ref{1171,,getpriority()} y @ref{1172,,setpriority()}. Estas pueden ser usadas para establecer o recuperar la prioridad en una forma similar a @ref{1173,,os.nice()} pero extendidos a todos los procesos en vez de solo al proceso actual.

(Revisión enviada por Giampaolo Rodolà en  bpo-10784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10784}.)

@item 
La nueva función @ref{1165,,os.replace()} permite cambiar el nombre de un archivo entre plataformas sobrescribiendo el destino. Con @ref{1164,,os.rename()}, un archivo de destino existente se sobrescribe bajo POSIX, pero lanza un error en Windows. (Contribución de Antoine Pitrou en bpo-8828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8828}.)

@item 
La familia de estadísticas de funciones (@ref{548,,stat()}, @ref{e12,,fstat()}, y @ref{549,,lstat()}) ahora admite la lectura de marcas de tiempo de un archivo con precisión de nanosegundos. Simétricamente, @ref{1169,,utime()} ahora puede escribir marcas de tiempo de archivos con precisión de nanosegundos. (Contribución de Larry Hastings en bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127}.)

@item 
La nueva función @ref{1174,,os.get_terminal_size()} consulta el tamaño del terminal adjunto al descriptor del archivo. Vea también @ref{1175,,shutil.get_terminal_size()}. (Contribución de Zbigniew Jędrzejewski-Szmek en bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609}. )
@end itemize

@c XXX sort out this mess after beta1


@itemize *

@item 
Nuevas funciones para admitir atributos extendidos de Linux. (bpo-12720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12720}): @ref{1176,,getxattr()}, @ref{1177,,listxattr()}, @ref{1178,,removexattr()}, @ref{1179,,setxattr()}.

@item 
Nueva interfaz para el planificador. Estas funciones controlan como el sistema operativo le asigna tiempo de CPU a un proceso. Nuevas funciones: @ref{117a,,sched_get_priority_max()}, @ref{117b,,sched_get_priority_min()}, @ref{117c,,sched_getaffinity()}, @ref{117d,,sched_getparam()}, @ref{117e,,sched_getscheduler()}, @ref{117f,,sched_rr_get_interval()}, @ref{1180,,sched_setaffinity()}, @ref{1181,,sched_setparam()}, @ref{1182,,sched_setscheduler()}, @ref{1183,,sched_yield()},

@item 
Nuevas funciones para controlar el sistema de archivos:


@itemize *

@item 
@ref{e19,,posix_fadvise()}: Anuncia una intención de acceder a los datos en un patrón específico, permitiendo al kernel hacer optimizaciones.

@item 
@ref{e1a,,posix_fallocate()}: Garantiza que se asigne el espacio suficiente a un archivo.

@item 
@ref{1184,,sync()}: Fuerza la escritura de cualquier cosa en el disco.
@end itemize

@item 
Nuevas funciones posix adicionales:


@itemize *

@item 
@ref{1185,,lockf()}: Aplicar, probar o eliminar un bloqueo POSIX en un descriptor de archivo abierto.

@item 
@ref{be7,,pread()}: Leer desde un descriptor de archivo en un desplazamiento, el desplazamiento del archivo permanece sin cambios.

@item 
@code{pwrite()}: Escribe en un descriptor de archivo desde un desplazamiento, dejando el desplazamiento del archivo sin cambios.

@item 
@ref{be6,,readv()}: Leer desde el descriptor de un archivo en varios búferes editables.

@item 
@ref{ec1,,truncate()}: Truncar el archivo correspondiente a `path', para que tenga como máximo `length' `bytes' de tamaño.

@item 
@ref{e1f,,waitid()}: Espera que se completen uno o más procesos secundarios.

@item 
@ref{be9,,writev()}: Escribir los contenidos de `buffers' a un archivo descriptor, donde `buffers' es una secuencia arbitraria de `buffers'.

@item 
@ref{1186,,getgrouplist()} (bpo-9344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9344}): Retorna una lista de ids de grupo al que pertenece el usuario especificado.
@end itemize

@item 
@ref{1187,,times()} and @ref{1188,,uname()}: El tipo de retorno cambió de tupla a un objeto tipo tupla con atributos con nombre.

@item 
Varias plataformas admiten constantes adicionales para la función @ref{1189,,lseek()}, tal como @code{os.SEEK_HOLE} y @code{os.SEEK_DATA}.

@item 
Nuevas constantes @ref{118a,,RTLD_LAZY}, @ref{118b,,RTLD_NOW}, @ref{118c,,RTLD_GLOBAL}, @ref{118d,,RTLD_LOCAL}, @ref{118e,,RTLD_NODELETE}, @ref{118f,,RTLD_NOLOAD}, and @ref{1190,,RTLD_DEEPBIND} están disponibles en plataformas que las soporten. Éstas son para uso con la función @ref{1191,,sys.setdlopenflags()}, y reemplazan las constantes similares definidas en @ref{2b,,ctypes} and @code{DLFCN}.  (Contribución de Victor Stinner en bpo-13226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13226}.)

@item 
@ref{1167,,os.symlink()} ahora acepta (e ignora) el argumento de palabra clave @code{target_is_directory} en plataformas diferentes a windows, para facilitar el soporte multiplataforma.
@end itemize

@node pdb<7>,pickle<4>,os<12>,Módulos mejorados<10>
@anchor{whatsnew/3 3 pdb}@anchor{1192}
@subsubsection pdb


La finalización de tabulaciones ahora está disponible no solo para los nombres de los comandos, sino también para sus argumentos. Por ejemplo, para el comando @code{break}, se completan las funciones y los nombres de archivo.

(Contribución de Georg Brandl en bpo-14210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14210})

@node pickle<4>,pydoc<4>,pdb<7>,Módulos mejorados<10>
@anchor{whatsnew/3 3 pickle}@anchor{1193}
@subsubsection pickle


Los objetos @ref{ab0,,pickle.Pickler} ahora tienen un atributo opcional @ref{1194,,dispatch_table} que permite establecer funciones de reducción por recolector.

(Contribución de Richard Oudkerk in bpo-14166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14166}.)

@node pydoc<4>,re<9>,pickle<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 pydoc}@anchor{1195}
@subsubsection pydoc


La Tk GUI y la función @code{serve()} han sido eliminadas del módulo @ref{b5,,pydoc}: @code{pydoc -g} y @code{serve()} han quedado obsoletos en Python 3.2.

@node re<9>,sched,pydoc<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 re}@anchor{1196}
@subsubsection re


Las expresiones regulares de la clase @ref{237,,str} ahora admiten escapes de @code{\u} and @code{\U} .

(Contribución de Serhiy Storchaka en bpo-3665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3665}.)

@node sched,select,re<9>,Módulos mejorados<10>
@anchor{whatsnew/3 3 sched}@anchor{1197}
@subsubsection sched



@itemize *

@item 
@ref{1198,,run()} ahora acepta un parámetro `blocking' que al configurarse en false, hace que el método ejecute los eventos planificados debido a la pronta expiración (si corresponde) y luego responde inmediatamente. Esto es útil en caso de que quieras usar la @ref{1199,,scheduler} en aplicaciones sin bloqueo. (Contribución de Giampaolo Rodolà in bpo-13449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13449}.)

@item 
La clase @ref{1199,,scheduler} ahora se puede utilizar de forma segura en entornos multiproceso.  (Contribución por Josiah Carlson y Giampaolo Rodolà en bpo-8684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8684}.)

@item 
Los parámetros `timefunc' y `delayfunct' del constructor de la clase @ref{1199,,scheduler} ahora son opcionales y tienen el valor predeterminado @ref{3ad,,time.time()} y @ref{73e,,time.sleep()} respectivamente. (Contribución de Chris Clark en bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)

@item 
El parámetro `argument' de @ref{119a,,enter()} and @ref{119b,,enterabs()} ahora es opcional.  (Contribución de Chris Clark en bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)

@item 
@ref{119a,,enter()} y @ref{119b,,enterabs()} ahora aceptan un parámetro `kwargs'.  (Contribución de Chris Clark en bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)
@end itemize

@node select,shlex<3>,sched,Módulos mejorados<10>
@anchor{whatsnew/3 3 select}@anchor{119c}
@subsubsection select


Solaris y plataformas derivadas tienen una nueva clase @ref{1014,,select.devpoll} para sockets asincrónicos de alto rendimiento a través de @code{/dev/poll}. (Contribución de Jesús Cea Avión en bpo-6397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6397}.)

@node shlex<3>,shutil<6>,select,Módulos mejorados<10>
@anchor{whatsnew/3 3 shlex}@anchor{119d}
@subsubsection shlex


The previously undocumented helper function @code{quote} from the
@code{pipes} modules has been moved to the @ref{c4,,shlex} module and
documented.  @ref{3d2,,quote()} properly escapes all characters in a string
that might be otherwise given special meaning by the shell.

@node shutil<6>,signal<3>,shlex<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 shutil}@anchor{119e}
@subsubsection shutil



@itemize *

@item 
Nuevas funciones:


@itemize *

@item 
@ref{119f,,disk_usage()}: Proporciona estadísticas sobre el espacio total, usado, y libre en el disco. (Contribución de Giampaolo Rodolà in bpo-12442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12442}.)

@item 
@ref{399,,chown()}: Permite cambiar el usuario y/o grupo de las rutas dadas, además de especificar los nombres de usuario/grupo, y no solos sus id’s numèricos. (Contribución de Sandro Tosi in bpo-12191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12191}.)

@item 
@ref{1175,,shutil.get_terminal_size()}: Retorna el tamaño de la ventana del terminar a la cual se adjunta el intérprete. (Contribución de Zbigniew Jędrzejewski-Szmek in bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609}. )
@end itemize

@item 
@ref{aec,,copy2()} and @ref{11a0,,copystat()} ahora conservan las marcas de tiempo de archivos con precisión de nanosegundos en plataformas que lo soporten. También conservan los «atributos extendidos» de archivo en Linux (Contribución de Larry Hastings en bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127} y bpo-15238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15238}.)

@item 
Algunas funciones ahora toman un argumento opcional de @code{symlinks}: Cuando ese parámetro es verdadero, los enlaces simbólicos no se desreferencian y la operación actúa en el enlace simbólico en sí. (o crea uno, si es relevante). (Contribución de Hynek Schlawack in bpo-12715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12715}.)

@item 
Al copiar archivos a un sistema de archivos diferente, @ref{aed,,move()} ahora gestiona los enlaces simbólicos de la forma que lo hace el comando @code{mv} de posix, recreando el enlace simbólico en vez de copiar el contenido del archivo de destino. (Contribución de Jonathan Niehof en bpo-9993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9993}.) @ref{aed,,move()} ahora también retorna el argumento @code{dst} como resultado.

@item 
@ref{1f9,,rmtree()} ahora es resistente a los ataques de enlaces simbólicos en plataformas que admiten el nuevo parámetro @code{dir_fd} en @ref{e18,,os.open()} y @ref{1168,,os.unlink()}. (Contribución de Martin von Löwis and Hynek Schlawack in bpo-4489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4489}.)
@end itemize

@node signal<3>,smtpd<4>,shutil<6>,Módulos mejorados<10>
@anchor{whatsnew/3 3 signal}@anchor{11a1}
@subsubsection signal



@itemize *

@item 
El módulo @ref{c6,,signal} tiene nuevas funciones:


@itemize *

@item 
@ref{11a2,,pthread_sigmask()}: busca y/o cambia la máscara de señal del hilo de llamada (Contribución de Jean-Paul Calderone in bpo-8407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8407});

@item 
@ref{11a3,,pthread_kill()}: Envía una señal a un hilo;

@item 
@ref{11a4,,sigpending()}: Examina funciones pendientes;

@item 
@ref{11a5,,sigwait()}: Espera una señal;

@item 
@ref{e31,,sigwaitinfo()}: Espera una señal, retornando información detallada sobre ella;

@item 
@ref{e30,,sigtimedwait()}: Es similar a @ref{e31,,sigwaitinfo()} pero con un tiempo de espera.
@end itemize

@item 
El manejador de señales escribe el número de señal, como un único byte en vez de un byte nulo en el descriptor del archivo de activación. Por lo tanto, es posible esperar más de una señal y saber cuales señales han sido lanzadas.

@item 
@ref{11a6,,signal.signal()} y @ref{11a7,,signal.siginterrupt()} lanzan un OSError, en vez de un RuntimeError: OSError no tiene atributo errno.
@end itemize

@node smtpd<4>,smtplib<4>,signal<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 smtpd}@anchor{11a8}
@subsubsection smtpd


The @code{smtpd} module now supports 
@geindex RFC; RFC 5321
RFC 5321@footnote{https://datatracker.ietf.org/doc/html/rfc5321.html} (extended SMTP) and 
@geindex RFC; RFC 1870
RFC 1870@footnote{https://datatracker.ietf.org/doc/html/rfc1870.html}
(size extension).  Per the standard, these extensions are enabled if and only
if the client initiates the session with an @code{EHLO} command.

Soporte inicial de @code{ELHO} de Alberto Treviño. Ampliación de tamaño por Juhana Jauhiainen. Trabajo adicional sustancial en la revisión aportada por Michele Orrù y Dan Boswell. bpo-8739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8739})

@node smtplib<4>,socket<5>,smtpd<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 smtplib}@anchor{11a9}
@subsubsection smtplib


Las clases @ref{9c0,,SMTP}, @ref{9c1,,SMTP_SSL}, y @ref{9c2,,LMTP} ahora aceptan un argumento de palabra clave @code{source_address}, para especificar el @code{(host, port)} a usar como dirección de origen en la llamada de enlace al crear el socket saliente. (Contribución de Paulo Scardine en bpo-11281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11281}.)

@ref{9c0,,SMTP} ahora admite el protocolo de administración de contexto, permitiendo usar a una instancia @code{SMTP} en una declaración @code{with}. (Contribución de Giampaolo Rodolà en bpo-11289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11289}.)

El constructor @ref{9c1,,SMTP_SSL} y el método @ref{11aa,,starttls()} ahora aceptan un parámetro SSLContext, para controlar los parámetros del canal seguro. (Contribución por Kasun Herath en bpo-8809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8809}.)

@node socket<5>,socketserver<2>,smtplib<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 socket}@anchor{11ab}
@subsubsection socket



@itemize *

@item 
La clase @ref{e27,,socket} ahora expone métodos adicionales para procesar datos auxiliares cuando sean compatibles con la plataforma subyacente:


@itemize *

@item 
@ref{521,,sendmsg()}

@item 
@ref{e2c,,recvmsg()}

@item 
@ref{11ac,,recvmsg_into()}
@end itemize

(Contribución de David Watson en bpo-6560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6560}, basado en una revisión anterior de Heiko Wundram)

@item 
La clase @ref{e27,,socket} ahora admite la familia del protocolo PF_CAN (@indicateurl{https://en.wikipedia.org/wiki/Socketcan}), en Linux (@indicateurl{https://lwn.net/Articles/253425}).

(Contribución de Matthias Fuchs, actualizado por Tiago Gonçalves en bpo-10141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10141}.)

@item 
La clase @ref{e27,,socket} ahora admite la familia de protocolos PF_RDS (@indicateurl{https://en.wikipedia.org/wiki/Reliable_Datagram_Sockets} y https://oss.oracle.com/projects/rds@footnote{https://web.archive.org/web/20130115155505/https://oss.oracle.com/projects/rds/}).

@item 
La clase @ref{e27,,socket} ahora admite la familia del protocolo @code{PF_SYSTEM} en OS X. (Contribución de Michael Goderbauer en bpo-13777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13777}.)

@item 
La nueva función @ref{11ad,,sethostname()} permite establecer el nombre de host en sistemas Unix si el proceso de llamada tiene suficientes privilegios. (Aportado por Ross Lagerwall en bpo-10866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10866}.)
@end itemize

@node socketserver<2>,sqlite3<11>,socket<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 socketserver}@anchor{11ae}
@subsubsection socketserver


@ref{11af,,BaseServer} ahora tiene un método reemplazable @ref{11b0,,service_actions()} que es llamado por el método @ref{11b1,,serve_forever()} en el ciclo del servicio. @ref{bff,,ForkingMixIn} ahora usa ésto para limpiar procesos secundarios zombies. (Contribución de Justin Warkentin en bpo-11109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11109}.)

@node sqlite3<11>,ssl<11>,socketserver<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 sqlite3}@anchor{11b2}
@subsubsection sqlite3


Nuevo método @ref{39e,,sqlite3.Connection}  @ref{3fa,,set_trace_callback()} puede ser usado para capturar un rastro de todos los comandos sql procesados por sqlite. (Contribución de Torsten Landschoff en bpo-11688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11688}.)

@node ssl<11>,stat<2>,sqlite3<11>,Módulos mejorados<10>
@anchor{whatsnew/3 3 ssl}@anchor{11b3}
@subsubsection ssl



@itemize *

@item 
El módulo @ref{d0,,ssl} tiene dos funciones de generación aleatoria:


@itemize *

@item 
@ref{5c7,,RAND_bytes()}: genera bytes pseudo-aleatorios criptográficamente fuertes.

@item 
@code{RAND_pseudo_bytes()}: genera bytes pseudoaleatorios.
@end itemize

(Contribución de Victor Stinner en bpo-12049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12049}.)

@item 
El módulo @ref{d0,,ssl} ahora expone una jerarquía de excepciones más detallada para facilitar la inspección de varias clases de errores. (Contribución de Antoine Pitrou en bpo-11183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11183}.)

@item 
@ref{3e7,,load_cert_chain()} ahora acepta un argumento `password' que será usado si la clave privada es encriptada. (Contribución de Adam Simpkins en bpo-12803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12803}.)

@item 
El intercambio de claves Diffie-Hellman, tanto regular como basado en curvas elípticas, ahora se admite a través de los métodos @code{load_dh_params()} y @ref{11b4,,set_ecdh_curve()}. (Contribución de Antoine Pitrou en bpo-13626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13626} y bpo-13627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13627}.)

@item 
Los sockets SSL tienen un nuevo método @ref{11b5,,get_channel_binding()} que permite la implementación de ciertos mecanismos de autenticación tales como SCRAM-SHA-1-PLUS. (Contribución por Jacek Konieczny en bpo-12551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12551}.)

@item 
Puedes consultar el algoritmo de compresión SSL usado por un socket SSL, gracias a su nuevo método @ref{11b6,,compression()}. El nuevo atributo @ref{11b7,,OP_NO_COMPRESSION} puede ser usado para deshabilitar la compresión. (Contribución de Antoine Pitrou en bpo-13634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13634}.)

@item 
Se ha agregado soporte para la extensión `Next Protocol Negotiation' usando el método @ref{1fb,,ssl.SSLContext.set_npn_protocols()}. (Contribución por Colin Marc en bpo-14204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14204}.)

@item 
Los errores de SSL ahora pueden introspectarse más fácilmente gracias a los atributos @ref{11b8,,library} y @ref{11b9,,reason}. (Contribución de Antoine Pitrou en bpo-14837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14837}.)

@item 
La función @ref{8d3,,get_server_certificate()} ahora admite IPv6. (Contribución por Charles-François Natali en bpo-11811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11811}.)

@item 
El nuevo atributo @ref{11ba,,OP_CIPHER_SERVER_PREFERENCE} permite configurar los sockets del servidor SSLv3 para usar la preferencia de ordenación de cifrado del servidor en lugar de la del cliente. (bpo-13635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13635}).
@end itemize

@node stat<2>,struct<2>,ssl<11>,Módulos mejorados<10>
@anchor{whatsnew/3 3 stat}@anchor{11bb}
@subsubsection stat


La función indocumentada tarfile.filemode ha sido movida a @ref{11bc,,stat.filemode()}. Este puede ser usado para convertir el modo de un archivo a una cadena de la forma “-rwxrwxrwx”.

(Contribución de Giampaolo Rodolà in bpo-14807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14807}.)

@node struct<2>,subprocess<4>,stat<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 struct}@anchor{11bd}
@subsubsection struct


El módulo @ref{d5,,struct} ahora admite @code{ssize_t} y @code{size_t} a través de los nuevos códigos @code{n} and @code{N}, respectivamente. (Contribución de Antoine Pitrou en bpo-3163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3163}.)

@node subprocess<4>,sys<12>,struct<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 subprocess}@anchor{11be}
@subsubsection subprocess


Las cadenas de comandos ahora pueden ser objetos de `bytes' en las plataformas posix. (Contribución de Victor Stinner in bpo-8513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8513}.)

Una nueva constante @ref{11bf,,DEVNULL} permite suprimir la salida de forma independiente de la plataforma. (Contribución de Ross Lagerwall en bpo-5870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5870}.)

@node sys<12>,tarfile<8>,subprocess<4>,Módulos mejorados<10>
@anchor{whatsnew/3 3 sys}@anchor{11c0}
@subsubsection sys


El módulo @ref{d9,,sys} tiene un nuevo @ref{11c1,,thread_info} @ref{6ef,,named tuple} que almacena información sobre la implementación del hilo (bpo-11223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11223}).

@node tarfile<8>,tempfile<3>,sys<12>,Módulos mejorados<10>
@anchor{whatsnew/3 3 tarfile}@anchor{11c2}
@subsubsection tarfile


@ref{de,,tarfile} ahora admite la codificación @code{lzma} a través del módulo @ref{8a,,lzma}. (Contribución de Lars Gustäbel en bpo-5689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5689}.)

@node tempfile<3>,textwrap<2>,tarfile<8>,Módulos mejorados<10>
@anchor{whatsnew/3 3 tempfile}@anchor{11c3}
@subsubsection tempfile


El método @ref{734,,tempfile.SpooledTemporaryFile}'s @code{truncate()} ahora acepta un parámetro @code{size}. (Contribución de Ryan Kelly en bpo-9957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9957}.)

@node textwrap<2>,threading<5>,tempfile<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 textwrap}@anchor{11c4}
@subsubsection textwrap


El módulo @ref{ec,,textwrap} tiene una nueva función @ref{3cd,,indent()} que facilita la adición de un prefijo común para las lineas seleccionadas en un bloque de texto (bpo-13857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13857}).

@node threading<5>,time<5>,textwrap<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 threading}@anchor{11c5}
@subsubsection threading


@ref{11c6,,threading.Condition}, @ref{11c7,,threading.Semaphore}, @ref{11c8,,threading.BoundedSemaphore}, @ref{11c9,,threading.Event}, y @ref{11ca,,threading.Timer}, todas las cuales son usadas para ser funciones de fábrica que retornen una instancia de clase, ahora son clases y pueden ser subclasificadas (Contribución de Éric Araujo in bpo-10968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10968}.)

El constructor de la clase @ref{9df,,threading.Thread} ahora acepta un argumento de palabra clave @code{daemon} para anular el comportamiento predeterminado de heredar el valor del indicador @code{daemon} desde el hilo principal (bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064}).

La función anteriormente privada @code{_thread.get_ident} ahora está disponible como función pública @ref{11cb,,threading.get_ident()}. Ésto elimina varios casos de acceso directo al módulo @code{_thread} en el stdlib. El código de terceros que usaba @code{_thread.get_ident} debería de igual forma ser cambiado para usar la nueva interfaz pública.

@node time<5>,types<5>,threading<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 time}@anchor{11cc}
@subsubsection time


El  
@geindex Python Enhancement Proposals; PEP 418
PEP 418@footnote{https://peps.python.org/pep-0418/} agrega nuevas funciones al módulo @ref{ee,,time}:


@itemize *

@item 
@ref{11cd,,get_clock_info()}: Obtiene información en un reloj.

@item 
@ref{3ac,,monotonic()}: Reloj monotónico (no se puede retroceder), no se ve afectado por la actualización del reloj del sistema.

@item 
@ref{b14,,perf_counter()}: Contador de rendimiento con la más alta resolución disponible para medir una corta duración.

@item 
@ref{b15,,process_time()}: Suma del tiempo de CPU del sistema y del usuario del proceso actual.
@end itemize

Otras nuevas funciones:


@itemize *

@item 
Las funciones @ref{11ce,,clock_getres()}, @ref{11cf,,clock_gettime()} y @ref{11d0,,clock_settime()} con constantes @code{CLOCK_@var{xxx}} (Contribución de Victor Stinner in bpo-10278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10278}.)
@end itemize

Para mejorar la consistencia entre plataformas, la función @ref{73e,,sleep()} ahora lanza un @ref{360,,ValueError} cuando se le pasa un valor negativo. Esto era anteriormente un error en posix, pero producía una suspensión definitiva en windows.

@node types<5>,unittest<9>,time<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 types}@anchor{11d1}
@subsubsection types


Adición de una nueva clase @ref{518,,types.MappingProxyType}: Proxy de solo lectura de una asignación. (bpo-14386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14386})

Las nuevas funciones @ref{11d2,,types.new_class()} y @ref{11d3,,types.prepare_class()} proporcionan soporte para la creación de tipos dinámicos compatibles. (bpo-14588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14588})

@node unittest<9>,urllib<5>,types<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 unittest}@anchor{11d4}
@subsubsection unittest


Los métodos @ref{5d0,,assertRaises()}, @ref{5d2,,assertRaisesRegex()}, @ref{11d5,,assertWarns()}, y @ref{11d6,,assertWarnsRegex()} ahora aceptan un argumento de palabra clave `msg' cuando son usados como administradores de contexto. (Contribución por Ezio Melotti y Winston Ewert en bpo-10775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10775}.)

@ref{11d7,,unittest.TestCase.run()} ahora retorna el objeto @ref{11d8,,TestResult}.

@node urllib<5>,webbrowser<3>,unittest<9>,Módulos mejorados<10>
@anchor{whatsnew/3 3 urllib}@anchor{11d9}
@subsubsection urllib


La clase @ref{1057,,Request} ahora acepta un argumento `method' usado por @ref{11da,,get_method()} para determinar que método HTTP debería usarse. Por ejemplo, esto enviará una solicitud @code{'HEAD'}:

@example
>>> urlopen(Request('https://www.python.org', method='HEAD'))
@end example

(bpo-1673007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1673007})

@node webbrowser<3>,xml etree ElementTree<2>,urllib<5>,Módulos mejorados<10>
@anchor{whatsnew/3 3 webbrowser}@anchor{11db}
@subsubsection webbrowser


El módulo @ref{115,,webbrowser} admite más «navegadores»: Google Chrome (llamado @code{chrome}, @code{chromium}, @code{chrome-browser} or @code{chromium-browser} dependiendo de la versión y del sistema operativo), y los lanzadores genéricos @code{xdg-open}, del proyecto FreeDesktop.org, y @code{gvfs-open}, el cual es el controlador URI predeterminado para GNOME3. (El primero agregado por Arnaud Calmettes en bpo-13620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13620}, el segundo por Matthias Klose en bpo-14493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14493}.)

@node xml etree ElementTree<2>,zlib<2>,webbrowser<3>,Módulos mejorados<10>
@anchor{whatsnew/3 3 xml-etree-elementtree}@anchor{11dc}
@subsubsection xml.etree.ElementTree


El módulo @ref{125,,xml.etree.ElementTree} ahora importa su acelerador C predeterminado, ya no es necesario importar explícitamente @code{xml.etree.cElementTree} (Éste módulo permanece para compatibilidad con versiones anteriores, pero ya está obsoleto). Además, la familia de métodos @code{iter} de @ref{20b,,Element} se ha optimizado (Reescrito en C). La documentación del módulo también se ha mejorado mucho, con ejemplos agregados y una referencia más detallada.

@node zlib<2>,,xml etree ElementTree<2>,Módulos mejorados<10>
@anchor{whatsnew/3 3 zlib}@anchor{11dd}
@subsubsection zlib


El nuevo atributo @ref{11de,,zlib.Decompress.eof} permite distinguir entre un flujo comprimido correctamente formado y uno incompleto o truncado. (Aportado por Nadeem Vawda en bpo-12646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12646}.)

Nuevo atributo @ref{11df,,zlib.ZLIB_RUNTIME_VERSION} informa la cadena de versión de la biblioteca @code{zlib} subyacente que se carga en tiempo de ejecución. (Contribución de Torsten Landschoff en bpo-12306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12306}.)

@node Optimizaciones<9>,Construcción y cambios en la API de C,Módulos mejorados<10>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 optimizations}@anchor{11e0}
@subsection Optimizaciones


Se han agregado importantes mejoras de rendimiento:


@itemize *

@item 
Gracias a 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, algunas operaciones en las cadenas `Unicode' han sido optimizadas:


@itemize *

@item 
la huella de memoria se divide de 2 a 4 según el texto

@item 
codificar una cadena ASCII a UTF-8 ya no necesita codificar caracteres, la representación UTF-8 se comparte con la representación ASCII

@item 
el codificador UTF-8 ha sido optimizado

@item 
repetir una única letra ASCII y obtener una subcadena de una cadena ASCII es 4 veces más rápido
@end itemize

@item 
UTF-8 ahora es 2x a 4x más rápido. La codificación UTF-16 ahora es 10x más rápida.

(Contribución de Serhiy Storchaka, bpo-14624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14624}, bpo-14738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14738} y bpo-15026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15026}.)
@end itemize

@node Construcción y cambios en la API de C,Obsoleto<12>,Optimizaciones<9>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 build-and-c-api-changes}@anchor{10c5}
@subsection Construcción y cambios en la API de C


Los cambios en el proceso de compilación de Python y en la API de C incluyen:


@itemize *

@item 
Nueva función relacionada con 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/}:


@itemize *

@item 
@ref{11e1,,PyMemoryView_FromMemory()}
@end itemize

@item 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} Agregó nuevos tipos `unicode', macros y funciones:


@itemize *

@item 
API de alto nivel:


@itemize *

@item 
@ref{94c,,PyUnicode_CopyCharacters()}

@item 
@ref{950,,PyUnicode_FindChar()}

@item 
@ref{94a,,PyUnicode_GetLength()}, @ref{94b,,PyUnicode_GET_LENGTH}

@item 
@ref{943,,PyUnicode_New()}

@item 
@ref{94d,,PyUnicode_Substring()}

@item 
@ref{11e2,,PyUnicode_ReadChar()}, @ref{11e3,,PyUnicode_WriteChar()}
@end itemize

@item 
API de bajo nivel:


@itemize *

@item 
Tipos @ref{11e4,,Py_UCS1}, @ref{11e5,,Py_UCS2}, @ref{1e4,,Py_UCS4}

@item 
Estructuras @ref{11e6,,PyASCIIObject} y @ref{11e7,,PyCompactUnicodeObject}

@item 
@ref{298,,PyUnicode_READY}

@item 
@ref{11e8,,PyUnicode_FromKindAndData()}

@item 
@ref{11e9,,PyUnicode_AsUCS4()}, @ref{952,,PyUnicode_AsUCS4Copy()}

@item 
@ref{11ea,,PyUnicode_DATA}, @ref{11eb,,PyUnicode_1BYTE_DATA},
@ref{11ec,,PyUnicode_2BYTE_DATA}, @ref{11ed,,PyUnicode_4BYTE_DATA}

@item 
@ref{11ee,,PyUnicode_KIND} con @code{PyUnicode_Kind} enum: @code{PyUnicode_WCHAR_KIND}, @ref{11ef,,PyUnicode_1BYTE_KIND}, @ref{11f0,,PyUnicode_2BYTE_KIND}, @ref{11f1,,PyUnicode_4BYTE_KIND}

@item 
@ref{11f2,,PyUnicode_READ}, @ref{11f3,,PyUnicode_READ_CHAR}, @ref{11f4,,PyUnicode_WRITE}

@item 
@ref{11f5,,PyUnicode_MAX_CHAR_VALUE}
@end itemize
@end itemize

@item 
@ref{615,,PyArg_ParseTuple} ahora acepta un @ref{5e0,,bytearray} para el formato @code{c} (bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380}).
@end itemize

@node Obsoleto<12>,Migración a Python 3 3,Construcción y cambios en la API de C,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 deprecated}@anchor{11f6}
@subsection Obsoleto


@menu
* Sistemas operativos no compatibles: Sistemas operativos no compatibles<2>. 
* Módulos @comma{} funciones y métodos obsoletos en Python: Módulos funciones y métodos obsoletos en Python. 
* Funciones y tipos obsoletos en la API de C:: 
* Características obsoletas:: 

@end menu

@node Sistemas operativos no compatibles<2>,Módulos funciones y métodos obsoletos en Python,,Obsoleto<12>
@anchor{whatsnew/3 3 unsupported-operating-systems}@anchor{11f7}
@subsubsection Sistemas operativos no compatibles


OS/2 y VMS no son compatibles debido a la falta de un responsable de mantenimiento.

Windows 2000 y las plataformas windows que establezcan @code{COMSPEC} a @code{command.com} ya no son compatibles debido a la carga de mantenimiento.

La compatibilidad con OSF, que quedó obsoleta en 3.2, ha sido completamente eliminada.

@node Módulos funciones y métodos obsoletos en Python,Funciones y tipos obsoletos en la API de C,Sistemas operativos no compatibles<2>,Obsoleto<12>
@anchor{whatsnew/3 3 deprecated-python-modules-functions-and-methods}@anchor{11f8}
@subsubsection Módulos , funciones y métodos obsoletos en Python



@itemize *

@item 
Pasar una cadena no vacía a @code{object.__format__()} está descontinuado, y producirá un @ref{228,,TypeError} en Python 3.4 (bpo-9856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9856}).

@item 
El códec @code{unicode_internal} quedó obsoleto a causa del 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, use UTF-8, UTF-16 (@code{utf-16-le} o @code{utf-16-be}), o UTF-32 (@code{utf-32-le} or @code{utf-32-be})

@item 
@ref{1138,,ftplib.FTP.nlst()} y @ref{1139,,ftplib.FTP.dir()}: use @ref{1137,,ftplib.FTP.mlsd()}

@item 
@code{platform.popen()}: use el módulo @ref{d6,,subprocess}. Verifique especialmente la sección @ref{11f9,,Cómo reemplazar anteriores funciones con el módulo subprocess} (bpo-11377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11377}).

@item 
bpo-13374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13374}: La API de `bytes' de Windows ha sido descontinuada en el módulo @ref{a1,,os}. Use nombres de archivo `Unicode', en vez de nombres de archivo de bytes, para no depender más de la página de códigos ANSI y admitir cualquier nombre de archivo.

@item 
bpo-13988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13988}: El módulo @code{xml.etree.cElementTree} ha quedado obsoleto. El acelerador se utiliza automáticamente siempre que esté disponible.

@item 
El comportamiento de @code{time.clock()} depende de la plataforma: utilice la nueva función @ref{b14,,time.perf_counter()} o @ref{b15,,time.process_time()} en su lugar, dependiendo de sus requerimientos, para tener un comportamiento bien definido.

@item 
La función @code{os.stat_float_times()} ha quedado obsoleta.

@item 
@ref{4,,abc} module:


@itemize *

@item 
La clase @ref{1101,,abc.abstractproperty} ha quedado obsoleta, en su lugar use la clase @ref{2fd,,property} con @ref{1102,,abc.abstractmethod()}.

@item 
La clase @ref{1103,,abc.abstractclassmethod} ha quedado obsoleta. En su lugar use el método @ref{2d2,,classmethod} with @ref{1102,,abc.abstractmethod()}.

@item 
@ref{1104,,abc.abstractstaticmethod} ha quedado obsoleta, use @ref{22e,,staticmethod} with @ref{1102,,abc.abstractmethod()}.
@end itemize

@item 
paquete @ref{77,,importlib}:


@itemize *

@item 
@ref{11fa,,importlib.abc.SourceLoader.path_mtime()} ha quedado obsoleto, a favor de @ref{11fb,,importlib.abc.SourceLoader.path_stats()} ya que los archivos de código de `bytes' ahora almacenan tanto la hora de modificación como el tamaño del archivo fuente desde el cual se compiló el archivo de código de bytes.
@end itemize
@end itemize

@node Funciones y tipos obsoletos en la API de C,Características obsoletas,Módulos funciones y métodos obsoletos en Python,Obsoleto<12>
@anchor{whatsnew/3 3 deprecated-functions-and-types-of-the-c-api}@anchor{11fc}
@subsubsection Funciones y tipos obsoletos en la API de C


El @ref{277,,Py_UNICODE} ha quedado obsoleto por 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} y será eliminado en Python 4. Todas las funciones que utilizan éste tipo quedarán en desuso:

Funciones y métodos Unicode que utilizan los tipos @ref{277,,Py_UNICODE} y @ref{277,,Py_UNICODE}*:


@itemize *

@item 
@code{PyUnicode_FromUnicode}: use @ref{11fd,,PyUnicode_FromWideChar()} o @ref{11e8,,PyUnicode_FromKindAndData()}

@item 
@code{PyUnicode_AS_UNICODE}, @code{PyUnicode_AsUnicode()},
@code{PyUnicode_AsUnicodeAndSize()}: use @ref{953,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_AS_DATA}: use @ref{11ea,,PyUnicode_DATA} con @ref{11f2,,PyUnicode_READ} y @ref{11f4,,PyUnicode_WRITE}

@item 
@code{PyUnicode_GET_SIZE}, @code{PyUnicode_GetSize()}: use @ref{94b,,PyUnicode_GET_LENGTH} o @ref{94a,,PyUnicode_GetLength()}

@item 
@code{PyUnicode_GET_DATA_SIZE}: use @code{PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)} (sólo funciona en cadenas listas)

@item 
@code{PyUnicode_AsUnicodeCopy()}: use @ref{952,,PyUnicode_AsUCS4Copy()} o @ref{953,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_GetMax()}
@end itemize

Funciones y macros que manipulen cadenas de caracteres Py_UNICODE*:


@itemize *

@item 
@code{Py_UNICODE_strlen}: use @ref{94a,,PyUnicode_GetLength()} o @ref{94b,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat}: use @ref{94c,,PyUnicode_CopyCharacters()} o @ref{47c,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy}, @code{Py_UNICODE_strncpy}, @code{Py_UNICODE_COPY}: use @ref{94c,,PyUnicode_CopyCharacters()} o @ref{94d,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp()}: use @ref{94e,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp()}: use @ref{94f,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr()}, @code{Py_UNICODE_strrchr()}: use
@ref{950,,PyUnicode_FindChar()}

@item 
@code{Py_UNICODE_FILL()}: use @ref{11fe,,PyUnicode_Fill()}

@item 
@code{Py_UNICODE_MATCH}
@end itemize

Codificadores:


@itemize *

@item 
@code{PyUnicode_Encode()}: use @code{PyUnicode_AsEncodedObject()}

@item 
@code{PyUnicode_EncodeUTF7()}

@item 
@code{PyUnicode_EncodeUTF8()}: use @ref{c43,,PyUnicode_AsUTF8()} o @ref{11ff,,PyUnicode_AsUTF8String()}

@item 
@code{PyUnicode_EncodeUTF32()}

@item 
@code{PyUnicode_EncodeUTF16()}

@item 
@code{PyUnicode_EncodeUnicodeEscape()} use
@ref{1200,,PyUnicode_AsUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeRawUnicodeEscape()} use
@ref{1201,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeLatin1()}: use @ref{1202,,PyUnicode_AsLatin1String()}

@item 
@code{PyUnicode_EncodeASCII()}: use @ref{1203,,PyUnicode_AsASCIIString()}

@item 
@code{PyUnicode_EncodeCharmap()}

@item 
@code{PyUnicode_TranslateCharmap()}

@item 
@code{PyUnicode_EncodeMBCS()}: use @ref{1204,,PyUnicode_AsMBCSString()} o @ref{1205,,PyUnicode_EncodeCodePage()} (con @code{CP_ACP} code_page)

@item 
@code{PyUnicode_EncodeDecimal()},
@code{PyUnicode_TransformDecimalToASCII()}
@end itemize

@node Características obsoletas,,Funciones y tipos obsoletos en la API de C,Obsoleto<12>
@anchor{whatsnew/3 3 deprecated-features}@anchor{1206}
@subsubsection Características obsoletas


El código del formato @code{'u'} del módulo @ref{8,,array} ha quedado obsoleto y será eliminado en Python 4, junto con el resto de la API (@ref{277,,Py_UNICODE}).

@node Migración a Python 3 3,,Obsoleto<12>,Qué hay de nuevo en Python 3 3
@anchor{whatsnew/3 3 porting-to-python-3-3}@anchor{1207}
@subsection Migración a Python 3.3


Esta sección enumera los cambios descritos previamente y otras correcciones que pueden requerir cambios en su código.

@menu
* Portando código Python:: 
* Portando código C:: 
* Construyendo extensiones C:: 
* Cambios en el conmutador de línea de comandos:: 

@end menu

@node Portando código Python,Portando código C,,Migración a Python 3 3
@anchor{whatsnew/3 3 porting-python-code}@anchor{10ea}@anchor{whatsnew/3 3 portingpythoncode}@anchor{1208}
@subsubsection Portando código Python



@itemize *

@item 
La aleatoriedad de Hash ha sido habilitada de forma predeterminada. Establezca la variable de entorno 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} a 0, para deshabilitar la aleatoriedad de Hash. Vea también el método @ref{b86,,object.__hash__()} method.

@item 
bpo-12326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12326}: En Linux, sys.platform ya no contiene la versión principal. Ahora siempre es “linux”, en vez de “linux2” o “linux3” dependiendo de la versión de Linux usada para compilar Python. Reemplace sys.platform == “linux2” con sys.platform.startswith(“linux”), o directamente sys.platform == “linux” si no necesita admitir versiones anteriores de Python.

@item 
bpo-13847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13847}, bpo-14180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14180}: @ref{ee,,time} y @ref{31,,datetime}: @ref{919,,OverflowError} ahora se lanza en lugar de @ref{360,,ValueError} si una marca de tiempo está fuera de rango. @ref{4d5,,OSError} ahora se genera si fallaron las funciones C @code{gmtime()} o @code{localtime()}.

@item 
Los buscadores predeterminados usados para las importaciones, ahora utilizan un caché de lo que está contenido en un directorio específico. Si crea un archivo fuente de Python o archivo de código de `bytes' sin fuente, asegúrese de llamar a @ref{c98,,importlib.invalidate_caches()} para limpiar la caché para que los buscadores encuentren el nuevo archivo.

@item 
@ref{4d7,,ImportError} ahora usa el nombre completo del módulo que se intentó importar. Las pruebas de documentos que verifican el mensaje de “ImportErrors” necesitaran ser actualizados para usar el nombre completo del módulo en vez de sólo la terminación del nombre.

@item 
El argumento `index' para la función @ref{96b,,__import__()} ahora tiene un valor predeterminado de 0, en vez de -1, y ya no admite valores negativos. Ha sido un descuido en la implementación de 
@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} que el valor predeterminado permaneciera en -1. Si necesita continuar realizando una importación relativa seguida por una importación absoluta, entonces realice la importación relativa usando un índice de 1, seguida por otra importación que use un índice de 0. Sin embargo, es preferible usar @ref{5bc,,importlib.import_module()} en vez de llamar a la función @ref{96b,,__import__()} directamente.

@item 
@ref{96b,,__import__()} ya no admite usar un valor de índice distinto de 0 para los módulos de alto nivel. Por ejemplo, @code{__import__('sys', level=1)} ahora es un error.

@item 
Dado que @ref{db2,,sys.meta_path} y @ref{10a0,,sys.path_hooks} ahora tienen buscadores por defecto, lo más probable es que desee usar @code{list.insert()} en vez de @code{list.append()} para agregar a esas listas.

@item 
Dado que @code{None} ahora ha sido insertado en @ref{684,,sys.path_importer_cache}, si usted está borrando entradas en el diccionario de rutas que no tienen un buscador, usted necesitará eliminar los pares con valores de @code{None} `y' @code{imp.NullImporter} para ser compatible con versiones anteriores. Esto conducirá a una sobrecarga adicional con las versiones más antiguas de Python que re-inserten @code{None} dentro de @ref{684,,sys.path_importer_cache} donde éste represente el uso de buscadores implícitos, pero semánticamente no debería cambiar nada.

@item 
@code{importlib.abc.Finder} ya no especifica un método abstracto @code{find_module()} que debe implementarse. Si confiaba en subclases para implementar ese método, asegúrese de verificar primero la existencia del método. Sin embargo, probablemente querrá verificar primero @code{find_loader()}, en el caso de trabajar con @ref{10ed,,path entry finders}.

@item 
@ref{a9,,pkgutil} ha sido convertido para usar @ref{77,,importlib} internamente. Esto elimina varios casos extremos donde el antiguo comportamiento de la emulación de importación 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} fallaba al comparar el comportamiento del sistema real de importación. La emulación de importación en sí aún está presente, pero está en desuso. Las funciones @ref{1209,,pkgutil.iter_importers()} y @ref{c87,,pkgutil.walk_packages()} en un caso especial son los ganchos de importación estándar, por lo que aún son compatibles aunque no proporcionen el método no estándar @code{iter_modules ()}.

@item 
Se ha corregido un error de larga data de cumplimiento de RFC (bpo-1079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1079}) en el análisis realizado por @ref{112d,,email.header.decode_header()}. El código que usa el lenguaje estándar para convertir encabezados codificados en `unicode' (@code{str (make_header (decode_header (h))}) no verá cambios, pero el código que mira las tuplas individuales retornadas por decode_header verá ese espacio en blanco que precede o sigue las secciones @code{ASCII} ahora está incluido en la sección @code{ASCII}. El código que crea encabezados usando @code{make_header} también debería continuar funcionando sin cambios, ya que @code{make_header} continúa agregando espacios en blanco entre @code{Secciones ASCII} y no @code{ASCII} si aún no está presente en las cadenas de caracteres entrantes.

@item 
@ref{120a,,email.utils.formataddr()} ahora realiza la codificación de transferencia de contenido correcta, al pasar nombres para mostrar que no son ASCII. Cualquier código que dependa del comportamiento defectuoso anterior que conservó el `unicode' que no es @code{ASCII} en la cadena de salida formateada deberá cambiarse (bpo-1690608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1690608}).

@item 
@ref{120b,,poplib.POP3.quit()} ahora puede generar errores de protocolos como todos los demás métodos @code{poplib}. El código que asume que @code{quit} no genera errores @ref{120c,,poplib.error_proto} puede necesitar ser cambiado si una aplicación en particular encuentran errores en @code{quit} (bpo-11291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11291}).

@item 
El argumento @code{strict} para la clase @ref{120d,,email.parser.Parser}, que quedó obsoleto desde Python 2.4, finalmente ha sido eliminado.

@item 
El método @code{unittest.TestCase.assertSameElements} que estaba obsoleto, ha sido eliminado.

@item 
La variable @code{time.accept2dyear} que estaba obsoleta, ha sido eliminada.

@item 
El atributo @code{Context._clamp} que estaba obsoleto, ha sido eliminado del módulo @ref{37,,decimal}. Este se reemplazó anteriormente por el atributo público @code{clamp}. (Ver bpo-8540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8540}.)

@item 
La clase interna auxiliar indocumentada @code{SSLFakeFile}, ha sido eliminada de @ref{ca,,smtplib}, dado que su funcionalidad ha sido proporcionada directamente por @ref{120e,,socket.socket.makefile()}.

@item 
El paso de valores negativos a la función @ref{73e,,time.sleep()} en Windows, ahora lanza un error en vez de detenerse definitivamente. Este siempre ha lanzado un error en posix.

@item 
La constante @code{ast.__version__} ha sido eliminada. Si usted necesita tomar decisiones afectadas por la versión AST, use @ref{741,,sys.version_info} para tomar la decisión.

@item 
El código que solía solucionar el hecho de que el módulo @ref{ed,,threading} utilizaba funciones de fábrica mediante la subclase de las clases privadas tendrá que cambiar a la subclase de las clases ahora públicas.

@item 
La indocumentada maquinaria de depuración en el módulo threading ha sido eliminada, simplificando el código. Esto no debería tener efecto en el código de producción, pero se menciona aquí en caso de que algún framework de depuración de aplicaciones interactúe con el (bpo-13550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13550}).
@end itemize

@node Portando código C,Construyendo extensiones C,Portando código Python,Migración a Python 3 3
@anchor{whatsnew/3 3 porting-c-code}@anchor{10c4}
@subsubsection Portando código C



@itemize *

@item 
En el curso de los cambios en la API del búfer, se eliminó el miembro @code{smalltable} no documentado de la estructura @ref{7f2,,Py_buffer} y se cambió el diseño del @code{PyMemoryViewObject}.

Todas las extensiones que quedan en las partes relevantes de @code{memoryobject.h} o @code{object.h} deben ser reconstruídas.

@item 
Debido a @ref{10b9,,PEP 393}, el tipo @ref{277,,Py_UNICODE} y todas las funciones que lo utilicen han quedado obsoletas (pero seguirán estando disponibles por al menos 5 años). Si usted estuvo usando APIS Unicode de bajo nivel para construir y acceder a objetos unicode, y desea beneficiarse de la reducción de huella de memoria proporcionada por 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, usted debe convertir su código al nuevo @ref{120f,,Unicode API}.

Sin embargo, si sólo ha estado usando funciones de alto nivel como @ref{1210,,PyUnicode_Concat()}, @ref{1211,,PyUnicode_Join()} o @ref{47c,,PyUnicode_FromFormat()}, automáticamente su código se beneficiará de las nuevas representaciones `unicode'.

@item 
@ref{1212,,PyImport_GetMagicNumber()} ahora retorna @code{-1} en caso de falla.

@item 
Como valor negativo para el argumento `level' de la función @ref{96b,,__import__()} ya no es válido, y lo mismo ahora es válido para la función @ref{1213,,PyImport_ImportModuleLevel()}. Esto también significa que el valor de `level' usado por la función @ref{1214,,PyImport_ImportModuleEx()} ahora es @code{0} en vez de @code{-1}.
@end itemize

@node Construyendo extensiones C,Cambios en el conmutador de línea de comandos,Portando código C,Migración a Python 3 3
@anchor{whatsnew/3 3 building-c-extensions}@anchor{1215}
@subsubsection Construyendo extensiones C



@itemize *

@item 
Se ha reducido el rango de nombres de archivo posibles para las extensiones C. Muy raramente se han suprimido las ortografías utilizadas: en POSIX, los archivos denominados @code{xxxmodule.so}, @code{xxxmodule.abi3.so} y @code{xxxmodule.cpython-*.so} ya no se reconocen como la implementación del módulo @code{xxx}. Si ha estado generando estos archivos, tiene que cambiar a las otras ortografías (es decir, eliminar la cadena de caracteres @code{módulo} de los nombres de archivo).

(implementado en bpo-14040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14040}.)
@end itemize

@node Cambios en el conmutador de línea de comandos,,Construyendo extensiones C,Migración a Python 3 3
@anchor{whatsnew/3 3 command-line-switch-changes}@anchor{1216}
@subsubsection Cambios en el conmutador de línea de comandos



@itemize *

@item 
Se han quitado el indicador de línea de comandos -Q y los artefactos relacionados.  La comprobación de código sys.flags.division_warning tendrá que actualizar.

(bpo-10998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10998}, contribución de Éric Araujo.)

@item 
Cuando se inicia @code{python} con @ref{1217,,-S}, @code{import site} ya no agregará las rutas específicas de sitio al módulo de búsqueda de rutas. En las versiones anteriores si lo hacía.

(bpo-11591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11591}, contribución de Carl Meyer con ediciones de Éric Araujo.)
@end itemize

@node Qué hay de nuevo en Python 3 2,Qué hay de nuevo en Python 3 1,Qué hay de nuevo en Python 3 3,Qué hay de nuevo en Python
@anchor{whatsnew/3 2 doc}@anchor{1218}@anchor{whatsnew/3 2 what-s-new-in-python-3-2}@anchor{1219}
@section Qué hay de nuevo en Python 3.2


@*Autor: 
Raymond Hettinger


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten.  (Note, during release candidate phase or just before
@c a beta release, please use the tracker instead -- this helps avoid
@c merge conflicts.   If you must add a suggested entry directly,
@c please put it in an XXX comment and the maintainer will take notice).
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.  It's helpful to
@c add the issue number:
@c 
@c   XXX Describe the transmogrify() function added to the socket
@c   module.
@c 
@c   (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.

Este artículo explica las nuevas características de Python 3.2 en comparación con 3.1. Python 3.2 se lanzó el 20 de febrero de 2011. Se centra en algunos aspectos destacados y ofrece algunos ejemplos. Para obtener detalles completos, consulte el archivo Misc/NEWS@footnote{https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 392
PEP 392@footnote{https://peps.python.org/pep-0392/} - Calendario de Publicación Python 3.2


@menu
* PEP 384; Definición de un ABI estable: PEP 384 Definición de un ABI estable. 
* PEP 389; Módulo de análisis sintáctico (Parser) de línea de comandos Argparse: PEP 389 Módulo de análisis sintáctico Parser de línea de comandos Argparse. 
* PEP 391; Configuración basada en diccionario para Logging: PEP 391 Configuración basada en diccionario para Logging. 
* PEP 3148; El módulo concurrent.futures: PEP 3148 El módulo concurrent futures. 
* PEP 3147; Directorios del repositorio de PYC: PEP 3147 Directorios del repositorio de PYC. 
* PEP 3149; Archivos .so con etiquetado de versión para ABI: PEP 3149 Archivos so con etiquetado de versión para ABI. 
* PEP 3333; Interfaz de puerta de enlace del servidor web Python v1.0.1: PEP 3333 Interfaz de puerta de enlace del servidor web Python v1 0 1. 
* Otros cambios de lenguaje: Otros cambios de lenguaje<2>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos. 
* Multi-threading:: 
* Optimizations: Optimizations<3>. 
* Unicode:: 
* Codecs:: 
* Documentación:: 
* IDLE:: 
* Repositorio de código:: 
* Cambios en la API de construcción y C:: 
* Portar a Python 3.2: Portar a Python 3 2. 

@end menu

@node PEP 384 Definición de un ABI estable,PEP 389 Módulo de análisis sintáctico Parser de línea de comandos Argparse,,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-384-defining-a-stable-abi}@anchor{121a}
@subsection PEP 384: Definición de un ABI estable


En el pasado, los módulos de extensión creados para una versión de Python a menudo no se podían usar con otras versiones de Python. Particularmente en Windows, cada lanzamiento de funciones de Python requería reconstruir todos los módulos de extensión que uno quería usar. Este requisito fue el resultado del acceso gratuito a los componentes internos del intérprete de Python que los módulos de extensión podían usar.

Con Python 3.2, está disponible un enfoque alternativo: los módulos de extensión que se restringen a una API limitada (al definir Py_LIMITED_API) no pueden usar muchas de las funciones internas, pero están restringidos a un conjunto de funciones API que se promete serán estables para varias versiones. Como consecuencia, los módulos de extensión creados para 3.2 en ese modo también funcionarán con 3.3, 3.4, etc. Los módulos de extensión que hacen uso de los detalles de las estructuras de memoria aún se pueden construir, pero deberán recompilarse para cada lanzamiento de funciones.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 384

@item PEP 384@footnote{https://peps.python.org/pep-0384/} - Definición de un ABI estable

PEP escrito por Martin von Löwis.
@end table


@node PEP 389 Módulo de análisis sintáctico Parser de línea de comandos Argparse,PEP 391 Configuración basada en diccionario para Logging,PEP 384 Definición de un ABI estable,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-389-argparse-command-line-parsing-module}@anchor{121b}
@subsection PEP 389: Módulo de análisis sintáctico (`Parser') de línea de comandos Argparse


Se introdujo un nuevo módulo para el análisis de la línea de comandos, @ref{7,,argparse}, para superar las limitaciones de @ref{a0,,optparse} que no brindaba soporte para argumentos posicionales (no solo opciones), subcomandos, opciones requeridas y otros patrones comunes para especificar y validar opciones.

Este módulo ya ha tenido un éxito generalizado en la comunidad como módulo de terceros. Con más funciones que su predecesor, el módulo @ref{7,,argparse} es ahora el módulo preferido para el procesamiento de la línea de comandos. El módulo más antiguo todavía se mantiene disponible debido a la gran cantidad de código heredado que depende de él.

Aquí hay un analizador de ejemplo comentado que muestra características de cómo limitar los resultados a un conjunto de opciones, especificar un `metavar' en la pantalla de ayuda, validar que uno o más argumentos posicionales están presentes y hacer una opción requerida:­:

@example
import argparse
parser = argparse.ArgumentParser(
            description = 'Manage servers',         # main description for help
            epilog = 'Tested on Solaris and Linux') # displayed after help
parser.add_argument('action',                       # argument name
            choices = ['deploy', 'start', 'stop'],  # three allowed values
            help = 'action on each target')         # help msg
parser.add_argument('targets',
            metavar = 'HOSTNAME',                   # var name used in help msg
            nargs = '+',                            # require one or more targets
            help = 'url for target machines')       # help msg explanation
parser.add_argument('-u', '--user',                 # -u or --user option
            required = True,                        # make it a required argument
            help = 'login as user')
@end example

Ejemplo de llamada al analizador en una cadena de caracteres de comandos:

@example
>>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
>>> result = parser.parse_args(cmd.split())
>>> result.action
'deploy'
>>> result.targets
['sneezy.example.com', 'sleepy.example.com']
>>> result.user
'skycaptain'
@end example

Ejemplo de ayuda generada automáticamente por el analizador:

@example
>>> parser.parse_args('-h'.split())

usage: manage_cloud.py [-h] -u USER
                       @{deploy,start,stop@} HOSTNAME [HOSTNAME ...]

Manage servers

positional arguments:
  @{deploy,start,stop@}   action on each target
  HOSTNAME              url for target machines

optional arguments:
  -h, --help            show this help message and exit
  -u USER, --user USER  login as user

Tested on Solaris and Linux
@end example

Una característica especialmente agradable de @ref{7,,argparse} es la capacidad de definir sub-analizadores (`subparsers'), cada uno con sus propios patrones de argumentos y pantallas de ayuda:

@example
import argparse
parser = argparse.ArgumentParser(prog='HELM')
subparsers = parser.add_subparsers()

parser_l = subparsers.add_parser('launch', help='Launch Control')   # first subgroup
parser_l.add_argument('-m', '--missiles', action='store_true')
parser_l.add_argument('-t', '--torpedos', action='store_true')

parser_m = subparsers.add_parser('move', help='Move Vessel',        # second subgroup
                                 aliases=('steer', 'turn'))         # equivalent names
parser_m.add_argument('-c', '--course', type=int, required=True)
parser_m.add_argument('-s', '--speed', type=int, default=0)
@end example

@example
$ ./helm.py --help                         # top level help (launch and move)
$ ./helm.py launch --help                  # help for launch options
$ ./helm.py launch --missiles              # set missiles=True and torpedos=False
$ ./helm.py steer --course 180 --speed 5   # set movement parameters
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - Nuevo módulo de análisis de línea de comandos

PEP escrito por Steven Bethard.
@end table

@ref{121c,,Upgrading optparse code} para obtener detalles sobre las diferencias con @ref{a0,,optparse}.


@node PEP 391 Configuración basada en diccionario para Logging,PEP 3148 El módulo concurrent futures,PEP 389 Módulo de análisis sintáctico Parser de línea de comandos Argparse,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-391-dictionary-based-configuration-for-logging}@anchor{121d}
@subsection PEP 391: Configuración basada en diccionario para Logging


The @ref{87,,logging} module provided two kinds of configuration, one style with
function calls for each option or another style driven by an external file saved
in a @ref{23,,configparser} format.  Those options did not provide the flexibility
to create configurations from JSON or YAML files, nor did they support
incremental configuration, which is needed for specifying logger options from a
command line.

Para permitir un estilo más flexible, el módulo ahora ofrece @ref{121e,,logging.config.dictConfig()} para especificar la configuración de logging con diccionarios simples de Python. Las opciones de configuración incluyen formateadores, gestores, filtros y loggers. Aquí hay un ejemplo funcional de un diccionario de configuración:

@example
@{"version": 1,
 "formatters": @{"brief": @{"format": "%(levelname)-8s: %(name)-15s: %(message)s"@},
                "full": @{"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"@}
                @},
 "handlers": @{"console": @{
                   "class": "logging.StreamHandler",
                   "formatter": "brief",
                   "level": "INFO",
                   "stream": "ext://sys.stdout"@},
              "console_priority": @{
                   "class": "logging.StreamHandler",
                   "formatter": "full",
                   "level": "ERROR",
                   "stream": "ext://sys.stderr"@}
              @},
 "root": @{"level": "DEBUG", "handlers": ["console", "console_priority"]@}@}
@end example

Si ese diccionario está almacenado en un archivo llamado @code{conf.json}, se puede cargar y llamar con un código como este:

@example
>>> import json, logging.config
>>> with open('conf.json') as f:
...     conf = json.load(f)
...
>>> logging.config.dictConfig(conf)
>>> logging.info("Transaction completed normally")
INFO    : root           : Transaction completed normally
>>> logging.critical("Abnormal termination")
2011-02-17 11:14:36,694 root            CRITICAL Abnormal termination
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - Configuración basada en diccionario para Logging

PEP escrito por Vinay Sajip.
@end table


@node PEP 3148 El módulo concurrent futures,PEP 3147 Directorios del repositorio de PYC,PEP 391 Configuración basada en diccionario para Logging,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-3148-the-concurrent-futures-module}@anchor{121f}
@subsection PEP 3148: El módulo @code{concurrent.futures}


El código para crear y administrar la concurrencia se está recopilando en un nuevo espacio de nombres de nivel superior, `concurrent'. Su primer miembro es un paquete `futures' que proporciona una interfaz uniforme de alto nivel para administrar hilos y procesos.

El diseño de @ref{22,,concurrent.futures} se inspiró en el paquete `java.util.concurrent'. En ese modelo, una llamada en ejecución y su resultado están representados por un objeto @ref{1220,,Future} que abstrae características comunes a hilos, procesos y llamadas a procedimientos remotos. Ese objeto admite verificaciones de estado (en ejecución o terminadas), tiempos de espera, cancelaciones, agregar devoluciones de llamada y acceso a resultados o excepciones.

El agregado principal del nuevo módulo es un par de clases ejecutoras para lanzar y administrar llamadas. El objetivo de los ejecutores es facilitar el uso de las herramientas existentes para realizar llamadas en paralelo. Ahorran el esfuerzo necesario para configurar un grupo de recursos, lanzar las llamadas, crear una cola de resultados, agregar gestión de tiempo de espera y limitar la cantidad total de hilos, procesos o llamadas a procedimientos remotos.

Idealmente, cada aplicación debería compartir un solo ejecutor en varios componentes para que los límites de procesos e hilos se puedan administrar de forma centralizada. Esto resuelve el desafío de diseño que surge cuando cada componente tiene su propia estrategia competitiva para la gestión de recursos.

Ambas clases comparten una interfaz común con tres métodos: @ref{b0f,,submit()} para programar un invocable y retornar un objeto @ref{1220,,Future} @ref{e69,,map()} para programar muchas llamadas asincrónicas a la vez, y @ref{984,,shutdown()} para liberar recursos. La clase es un @ref{675,,context manager} y se puede usar en una declaración @ref{673,,with} para asegurar que los recursos se liberen automáticamente cuando los futuros actualmente pendientes terminan de ejecutarse.

Un ejemplo simple de @ref{7dd,,ThreadPoolExecutor} es un lanzamiento de cuatro hilos paralelos para copiar archivos:

@example
import concurrent.futures, shutil
with concurrent.futures.ThreadPoolExecutor(max_workers=4) as e:
    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} - Futuros – Ejecutar Cómputos Asincrónicos

PEP escrito por Brian Quinlan.
@end table

@ref{1221,,Código para lecturas de URL en paralelo con grupos de hilos}, un ejemplo que usa hilos para buscar varias páginas web en paralelo.

@ref{1222,,Código para calcular números primos en paralelo}, un ejemplo demostrando @ref{163,,ProcessPoolExecutor}.


@node PEP 3147 Directorios del repositorio de PYC,PEP 3149 Archivos so con etiquetado de versión para ABI,PEP 3148 El módulo concurrent futures,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-3147-pyc-repository-directories}@anchor{1223}
@subsection PEP 3147: Directorios del repositorio de PYC


El esquema de Python para almacenar en caché bytecode en archivos `.pyc' no funcionó bien en entornos con múltiples intérpretes de Python. Si un intérprete encontrara un archivo en caché creado por otro intérprete, volvería a compilar la fuente y sobrescribiría el archivo en caché, perdiendo así los beneficios del almacenamiento en caché.

El problema de las «peleas de pyc» se ha vuelto más pronunciado a medida que se ha convertido en un lugar común para las distribuciones de Linux enviadas con múltiples versiones de Python. Estos conflictos también surgen con alternativas de CPython como `Unladen Swallow'.

Para resolver este problema, el mecanismo de importación de Python se ha ampliado para utilizar nombres de archivo distintos para cada intérprete. En lugar de que Python 3.2 y Python 3.3 y `Unladen Swallow' compitan por un archivo llamado «mymodule.pyc», ahora buscarán «mymodule.cpython-32.pyc», «mymodule.cpython-33.pyc» y «mymodule .unladen10.pyc». Y para evitar que todos estos nuevos archivos abarroten los directorios de origen, los archivos `pyc' ahora se recopilan en un directorio «__pycache__» almacenado en el directorio del paquete.

Aparte de los nombres de archivo y directorios de destino, el nuevo esquema tiene algunos aspectos que son visibles para el programador:


@itemize *

@item 
Imported modules now have a @ref{1cb,,__cached__} attribute which stores
the name of the actual file that was imported:

@example
>>> import collections
>>> collections.__cached__ 
'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
@end example

@item 
The tag that is unique to each interpreter is accessible from the @code{imp}
module:

@example
>>> import imp 
>>> imp.get_tag() 
'cpython-32'
@end example

@item 
Scripts that try to deduce source filename from the imported file now need to
be smarter.  It is no longer sufficient to simply strip the «c» from a «.pyc»
filename.  Instead, use the new functions in the @code{imp} module:

@example
>>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc') 
'c:/py32/lib/collections.py'
>>> imp.cache_from_source('c:/py32/lib/collections.py') 
'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
@end example

@item 
Los módulos @ref{b3,,py_compile} y @ref{21,,compileall} se han actualizado para reflejar la nueva convención de nomenclatura y el directorio de destino. La invocación por línea de comandos de `compileall' tiene nuevas opciones: @code{-i} para especificar una lista de archivos y directorios para compilar y @code{-b} que hace que los archivos bytecode se escriban en su ubicación heredada en lugar de `__pycache__'.

@item 
The @ref{78,,importlib.abc} module has been updated with new @ref{1224,,abstract base classes} for loading bytecode files.  The obsolete
ABCs, @code{PyLoader} and
@code{PyPycLoader}, have been deprecated (instructions on how
to stay Python 3.1 compatible are included with the documentation).
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/} - Directorio del repositorio PYC

PEP escrito por Barry Warsaw.
@end table


@node PEP 3149 Archivos so con etiquetado de versión para ABI,PEP 3333 Interfaz de puerta de enlace del servidor web Python v1 0 1,PEP 3147 Directorios del repositorio de PYC,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-3149-abi-version-tagged-so-files}@anchor{1225}
@subsection PEP 3149: Archivos .so con etiquetado de versión para ABI


El directorio del repositorio PYC permite la ubicación conjunta de varios archivos de cache bytecode. Este PEP implementa un mecanismo similar para los archivos de objetos compartidos dándoles un directorio común y nombres distintos para cada versión.

El directorio común es «pyshared» y los nombres de los archivos se diferencian identificando la implementación de Python (como CPython, PyPy, Jython, etc.), los números de versión principal y secundaria, y las banderas de compilación opcionales (como «d» para debug, «m» para pymalloc, «u» para ancho-unicode). Para un paquete arbitrario «foo», se verán estos archivos cuando se instala el paquete de distribución:

@example
/usr/share/pyshared/foo.cpython-32m.so
/usr/share/pyshared/foo.cpython-33md.so
@end example

En Python mismo, las etiquetas son accesibles desde funciones en el módulo @ref{db,,sysconfig}:

@example
>>> import sysconfig
>>> sysconfig.get_config_var('SOABI')       # find the version tag
'cpython-32mu'
>>> sysconfig.get_config_var('EXT_SUFFIX')  # find the full filename extension
'.cpython-32mu.so'
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3149

@item PEP 3149@footnote{https://peps.python.org/pep-3149/} - PEP 3149: Archivos .so con etiquetado de versión para ABI

PEP escrito por Barry Warsaw.
@end table


@node PEP 3333 Interfaz de puerta de enlace del servidor web Python v1 0 1,Otros cambios de lenguaje<2>,PEP 3149 Archivos so con etiquetado de versión para ABI,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 pep-3333-python-web-server-gateway-interface-v1-0-1}@anchor{1226}
@subsection PEP 3333: Interfaz de puerta de enlace del servidor web Python v1.0.1


Este PEP informativo aclara cómo el protocolo WSGI debe gestionar los problemas de bytes/texto. El desafío es que el manejo de cadenas de caracteres en Python 3 se maneja de manera más conveniente con el tipo @ref{237,,str} aunque el protocolo HTTP está orientado a bytes.

El PEP diferencia las llamadas `cadenas nativas' que se utilizan para los encabezados y metadatos de solicitud/respuesta (`request/response') frente a las `cadenas de bytes' que se utilizan para los cuerpos de las solicitudes y respuestas.

The `native strings' are always of type @ref{237,,str} but are restricted to code
points between `U+0000' through `U+00FF' which are translatable to bytes using
`Latin-1' encoding.  These strings are used for the keys and values in the
environment dictionary and for response headers and statuses in the
@code{start_response()} function.  They must follow 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} with respect to
encoding. That is, they must either be `ISO-8859-1' characters or use
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} MIME encoding.

Para los desarrolladores que portan aplicaciones WSGI desde Python 2, estos son los puntos destacados:


@itemize *

@item 
Si la aplicación ya usó cadenas para encabezados en Python 2, no es necesario ningún cambio.

@item 
Si, en cambio, la aplicación codificó encabezados de salida o decodificó encabezados de entrada, entonces los encabezados deberán volver a codificarse en Latin-1. Por ejemplo, un encabezado de salida codificado en utf-8 usaba @code{h.encode('utf-8')}, ahora se necesita convertir de bytes a cadenas nativas usando @code{h.encode('utf-8').decode('latin-1')}.

@item 
Values yielded by an application or sent using the @code{write()} method
must be byte strings.  The @code{start_response()} function and environ
must use native strings.  The two cannot be mixed.
@end itemize

For server implementers writing CGI-to-WSGI pathways or other CGI-style
protocols, the users must to be able access the environment using native strings
even though the underlying platform may have a different convention.  To bridge
this gap, the @ref{118,,wsgiref} module has a new function,
@ref{1227,,wsgiref.handlers.read_environ()} for transcoding CGI variables from
@ref{196,,os.environ} into native strings and returning a new dictionary.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3333

@item PEP 3333@footnote{https://peps.python.org/pep-3333/} - Interfaz de puerta de enlace del servidor web Python v1.0.1

PEP escrito por Phillip Eby.
@end table


@node Otros cambios de lenguaje<2>,Módulos nuevos mejorados y obsoletos,PEP 3333 Interfaz de puerta de enlace del servidor web Python v1 0 1,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 other-language-changes}@anchor{1228}
@subsection Otros cambios de lenguaje


Algunos cambios más pequeños realizados en el lenguaje central de Python son:


@itemize *

@item 
El formato de cadena de caracteres para @ref{6c0,,format()} y @ref{6c2,,str.format()} obtuvo nuevas capacidades para el carácter de formato `#'. Anteriormente, para enteros en binario, octal o hexadecimal, hacía que la salida tuviera el prefijo “0b”, “0o” o “0x” respectivamente. Ahora también puede manejar flotantes, complejos y decimales, lo que hace que la salida siempre tenga un punto decimal, incluso cuando no le siguen dígitos.

@example
>>> format(20, '#o')
'0o24'
>>> format(12.34, '#5.0f')
'  12.'
@end example

(Sugerido por Mark Dickinson e implementado por Eric Smith en bpo-7094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7094}.)

@item 
También hay un nuevo método @ref{e5c,,str.format_map()} que amplía las capacidades del método existente @ref{6c2,,str.format()} al aceptar objetos arbitrarios @ref{1229,,mapping}. Este nuevo método hace posible usar formato de cadena de caracteres con cualquiera de los muchos objetos similares a diccionarios de Python, como @ref{122a,,defaultdict}, @ref{1019,,Shelf}, @ref{32b,,ConfigParser}, o @ref{32,,dbm}. También es útil con subclases personalizadas @ref{190,,dict} que normalizan claves antes de la búsqueda o que proporcionan un método @code{__missing__()} para claves desconocidas:

@example
>>> import shelve
>>> d = shelve.open('tmp.shl')
>>> 'The @{project_name@} status is @{status@} as of @{date@}'.format_map(d)
'The testing project status is green as of February 15, 2011'

>>> class LowerCasedDict(dict):
...     def __getitem__(self, key):
...         return dict.__getitem__(self, key.lower())
...
>>> lcd = LowerCasedDict(part='widgets', quantity=10)
>>> 'There are @{QUANTITY@} @{Part@} in stock'.format_map(lcd)
'There are 10 widgets in stock'

>>> class PlaceholderDict(dict):
...     def __missing__(self, key):
...         return '<@{@}>'.format(key)
...
>>> 'Hello @{name@}, welcome to @{location@}'.format_map(PlaceholderDict())
'Hello <name>, welcome to <location>'
@end example
@end itemize

@quotation

(Sugerido por Raymond Hettinger e implementado por Eric Smith en bpo-6081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6081}.)
@end quotation


@itemize *

@item 
The interpreter can now be started with a quiet option, @code{-q}, to prevent
the copyright and version information from being displayed in the interactive
mode.  The option can be introspected using the @ref{72d,,sys.flags} attribute:

@example
$ python -q
>>> sys.flags
sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
@end example

(Contribución de Marcin Wojdyr en bpo-1772833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772833}).

@item 
The @ref{579,,hasattr()} function works by calling @ref{c59,,getattr()} and detecting
whether an exception is raised.  This technique allows it to detect methods
created dynamically by @ref{57a,,__getattr__()} or @ref{c5a,,__getattribute__()} which
would otherwise be absent from the class dictionary.  Formerly, `hasattr'
would catch any exception, possibly masking genuine errors.  Now, `hasattr'
has been tightened to only catch @ref{441,,AttributeError} and let other
exceptions pass through:

@example
>>> class A:
...     @@property
...     def f(self):
...         return 1 // 0
...
>>> a = A()
>>> hasattr(a, 'f')
Traceback (most recent call last):
  ...
ZeroDivisionError: integer division or modulo by zero
@end example

(Descubierto por Yury Selivanov y arreglado por Benjamin Peterson; bpo-9666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9666}.)

@item 
La @ref{237,,str()} de un número flotante o complejo ahora es el mismo que su @ref{894,,repr()}. Anteriormente, el formulario @ref{237,,str()} era más corto, pero eso solo causaba confusión y ya no es necesario ahora que el más corto posible @ref{894,,repr()} se muestra por defecto:

@example
>>> import math
>>> repr(math.pi)
'3.141592653589793'
>>> str(math.pi)
'3.141592653589793'
@end example

(Propuesto e implementado por Mark Dickinson; bpo-9337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9337}.)

@item 
@ref{156,,memoryview} objects now have a @ref{122b,,release()} method
and they also now support the context management protocol.  This allows timely
release of any resources that were acquired when requesting a buffer from the
original object.

@example
>>> with memoryview(b'abcdefgh') as v:
...     print(v.tolist())
[97, 98, 99, 100, 101, 102, 103, 104]
@end example

(Añadido por Antoine Pitrou; bpo-9757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9757}.)

@item 
Anteriormente, era ilegal eliminar un nombre del espacio de nombres local si aparece como una variable libre en un bloque anidado:

@example
def outer(x):
    def inner():
        return x
    inner()
    del x
@end example

Esto ahora está permitido. Recuerde que el objetivo de una cláusula @ref{2f6,,except} se borra, por lo que este código que solía funcionar con Python 2.6, lanza un @ref{150,,SyntaxError} con Python 3.1 y ahora funciona nuevamente:

@example
def f():
    def print_error():
        print(e)
    try:
        something
    except Exception as e:
        print_error()
        # implicit "del e" here
@end example

(Ver bpo-4617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4617}.)

@item 
@ref{122c,,Struct sequence types} are now subclasses of tuple.
This means that C structures like those returned by @ref{548,,os.stat()},
@ref{122d,,time.gmtime()}, and @ref{741,,sys.version_info} now work like a
@ref{6ef,,named tuple} and now work with functions and methods that
expect a tuple as an argument.  This is a big step forward in making the C
structures as flexible as their pure Python counterparts:

@example
>>> import sys
>>> isinstance(sys.version_info, tuple)
True
>>> 'Version %d.%d.%d %s(%d)' % sys.version_info 
'Version 3.2.0 final(0)'
@end example

(Sugerido por Arfrever Frehtes Taifersar Arahesis e implementado por Benjamin Peterson en bpo-8413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8413}.)

@item 
Las `Warnings' ahora son más fáciles de controlar usando la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} como alternativa al uso de @code{-W} en la línea de comando:

@example
$ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'
@end example

(Sugerido por Barry Warsaw e implementado por Philip Jenvey en bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301}.)

@item 
Se ha agregado una nueva categoría de advertencia, @ref{39d,,ResourceWarning}. Se emite cuando se detectan problemas potenciales con el consumo de recursos o la limpieza. Está silenciado de forma predeterminada en las versiones de lanzamiento normales, pero se puede habilitar a través de los medios proporcionados por el módulo @ref{112,,warnings} o en la línea de comandos.

A @ref{39d,,ResourceWarning} is issued at interpreter shutdown if the
@ref{122e,,gc.garbage} list isn’t empty, and if @ref{122f,,gc.DEBUG_UNCOLLECTABLE} is
set, all uncollectable objects are printed.  This is meant to make the
programmer aware that their code contains object finalization issues.

Un @ref{39d,,ResourceWarning} también se emite cuando un @ref{1230,,file object} se destruye sin haber sido cerrado explícitamente. Si bien el desasignador de dicho objeto asegura que cierra el recurso del sistema operativo subyacente (generalmente, un descriptor de archivo), la demora en desasignar el objeto podría producir varios problemas, especialmente en Windows. A continuación, se muestra un ejemplo de cómo habilitar la advertencia desde la línea de comando:

@example
$ python -q -Wdefault
>>> f = open("foo", "wb")
>>> del f
__main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
@end example

(Agregado por Antoine Pitrou y Georg Brandl en bpo-10093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10093} y bpo-477863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=477863}.)

@item 
@ref{9d6,,range} objects now support `index' and `count' methods. This is part
of an effort to make more objects fully implement the
@ref{1231,,collections.Sequence} @ref{1224,,abstract base class}.  As a result, the
language will have a more uniform API.  In addition, @ref{9d6,,range} objects
now support slicing and negative indices, even with values larger than
@ref{1232,,sys.maxsize}.  This makes `range' more interoperable with lists:

@example
>>> range(0, 100, 2).count(10)
1
>>> range(0, 100, 2).index(10)
5
>>> range(0, 100, 2)[5]
10
>>> range(0, 100, 2)[0:5]
range(0, 10, 2)
@end example

(Contribuido por Daniel Stutzbach en bpo-9213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9213}, por Alexander Belopolsky en bpo-2690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2690}, y por Nick Coghlan en bpo-10889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10889}.)

@item 
Se resucitó la función incorporada @ref{1233,,callable()} de Py2.x. Proporciona una alternativa concisa y legible al uso de una @ref{1224,,abstract base class} en una expresión como @code{isinstance(x, collections.Callable)}:

@example
>>> callable(max)
True
>>> callable(20)
False
@end example

(Ver bpo-10518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10518}.)

@item 
El mecanismo de importación de Python ahora puede cargar módulos instalados en directorios con caracteres no ASCII en el nombre de la ruta. Esto resolvió un problema agravante con los directorios de inicio para los usuarios con caracteres no ASCII en sus nombres de usuario.
@end itemize

@quotation

(Trabajo extenso requerido por Victor Stinner en bpo-9425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9425}.)
@end quotation

@node Módulos nuevos mejorados y obsoletos,Multi-threading,Otros cambios de lenguaje<2>,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 new-improved-and-deprecated-modules}@anchor{1234}
@subsection Módulos nuevos, mejorados y obsoletos


La biblioteca estándar de Python ha sido objeto de importantes esfuerzos de mantenimiento y mejoras de calidad.

The biggest news for Python 3.2 is that the @ref{3c,,email} package, @ref{8b,,mailbox}
module, and @code{nntplib} modules now work correctly with the bytes/text model
in Python 3.  For the first time, there is correct handling of messages with
mixed encodings.

En toda la biblioteca estándar, se ha prestado más atención a las codificaciones y los problemas de texto frente a bytes. En particular, las interacciones con el sistema operativo ahora son más capaces de intercambiar datos que no son ASCII mediante la codificación MBCS de Windows, codificaciones con reconocimiento de configuración regional o UTF-8.

Otro logro importante es la adición de un soporte sustancialmente mejor para conexiones `SSL' y certificados de seguridad.

Además, más clases ahora implementan @ref{675,,context manager} para soportar una conveniente y confiable limpieza de recursos usando una declaración @ref{673,,with}.

@menu
* email: email<6>. 
* elementtree:: 
* functools: functools<7>. 
* itertools: itertools<8>. 
* collections: collections<5>. 
* threading: threading<6>. 
* datetime and time:: 
* math: math<7>. 
* abc: abc<3>. 
* io: io<8>. 
* reprlib:: 
* logging: logging<5>. 
* csv: csv<4>. 
* contextlib: contextlib<8>. 
* decimal and fractions:: 
* ftp:: 
* popen:: 
* select: select<2>. 
* gzip y zipfile:: 
* tarfile: tarfile<9>. 
* hashlib: hashlib<7>. 
* ast: ast<7>. 
* os: os<13>. 
* shutil: shutil<7>. 
* sqlite3: sqlite3<12>. 
* html: html<3>. 
* socket: socket<6>. 
* ssl: ssl<12>. 
* nntp:: 
* certificados:: 
* imaplib: imaplib<4>. 
* http.client: http client<4>. 
* unittest: unittest<10>. 
* random: random<3>. 
* poplib: poplib<4>. 
* asyncore: asyncore<2>. 
* tempfile: tempfile<4>. 
* inspect: inspect<6>. 
* pydoc: pydoc<5>. 
* dis: dis<6>. 
* dbm: dbm<7>. 
* ctypes: ctypes<4>. 
* site: site<2>. 
* sysconfig: sysconfig<2>. 
* pdb: pdb<8>. 
* configparser: configparser<5>. 
* urllib.parse: urllib parse<6>. 
* mailbox:: 
* turtledemo:: 

@end menu

@node email<6>,elementtree,,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 email}@anchor{1235}
@subsubsection email


La usabilidad del paquete @ref{3c,,email} en Python 3 se ha solucionado principalmente gracias a los amplios esfuerzos de R. David Murray. El problema era que los correos electrónicos generalmente se leen y almacenan en forma de @ref{325,,bytes} en lugar de texto @ref{237,,str}, y pueden contener múltiples codificaciones dentro de un solo correo electrónico. Por lo tanto, el paquete email tuvo que ampliarse para analizar y generar mensajes de correo electrónico en formato de bytes.


@itemize *

@item 
Nuevas funciones @ref{1236,,message_from_bytes()} y @ref{1237,,message_from_binary_file()}, y nuevas clases @ref{1238,,BytesFeedParser} y @ref{1239,,BytesParser} permiten mensajes de datos en binario para ser analizados (`parsed') en objetos modelados.

@item 
Dada la entrada de bytes al modelo, @ref{123a,,get_payload()} decodificará por defecto un cuerpo de mensaje que tiene un @code{Content-Transfer-Encoding} de `8bit' usando el juego de caracteres especificado en el encabezados MIME y retorna la cadena de caracteres resultante.

@item 
Dada la entrada de bytes al modelo, @ref{123b,,Generator} convertirá los cuerpos de los mensajes que tengan un @code{Content-Transfer-Encoding} de `8bit' para tener en su lugar un `7bit'@code{Content-Transfer-Encoding}.

Los encabezados con bytes no codificados que no sean ASCII se consideran 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}-codificados utilizando el juego de caracteres `unknown-8bit'.

@item 
Una nueva clase @ref{123c,,BytesGenerator} produce bytes como salida, conservando cualquier dato no ASCII sin cambios que estuviera presente en la entrada utilizada para construir el modelo, incluidos los cuerpos de los mensajes con un @code{Content-Transfer-Encoding} de `8bit'.

@item 
La clase @ref{ca,,smtplib}@ref{9c0,,SMTP} ahora acepta una cadena de bytes para el argumento `msg' para el método @ref{ed9,,sendmail()}, y un nuevo método, @ref{eda,,send_message()} acepta un objeto @ref{3d1,,Message} y opcionalmente puede obtener las direcciones `from_addr' y `to_addrs' directamente del objeto.
@end itemize

(Propuesto e implementado por R. David Murray, bpo-4661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4661} y bpo-10321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10321}.)

@node elementtree,functools<7>,email<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 elementtree}@anchor{123d}
@subsubsection elementtree


The @ref{125,,xml.etree.ElementTree} package and its @code{xml.etree.cElementTree}
counterpart have been updated to version 1.3.

Se han agregado varias nuevas y útiles funciones y métodos:


@itemize *

@item 
@ref{123e,,xml.etree.ElementTree.fromstringlist()} que crea un documento XML a partir de una secuencia de fragmentos

@item 
@ref{123f,,xml.etree.ElementTree.register_namespace()} para registrar un prefijo de espacio de nombres global

@item 
@ref{1073,,xml.etree.ElementTree.tostringlist()} para la representación de cadenas de caracteres, incluidas todas las sublistas

@item 
@ref{1240,,xml.etree.ElementTree.Element.extend()} para agregar una secuencia de cero o más elementos

@item 
@ref{1241,,xml.etree.ElementTree.Element.iterfind()} busca un elemento y subelementos

@item 
@ref{1242,,xml.etree.ElementTree.Element.itertext()} crea un iterador de texto sobre un elemento y sus subelementos

@item 
@ref{1243,,xml.etree.ElementTree.TreeBuilder.end()} cierra el elemento actual

@item 
@ref{b22,,xml.etree.ElementTree.TreeBuilder.doctype()} gestiona la declaración `doctype'
@end itemize

Dos métodos que han sido deprecados:


@itemize *

@item 
@code{xml.etree.ElementTree.getchildren()} use @code{list(elem)} instead.

@item 
@code{xml.etree.ElementTree.getiterator()} use @code{Element.iter} instead.
@end itemize

Para obtener más información sobre la actualización, consulte Introducing ElementTree@footnote{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm} en el sitio web de Fredrik Lundh.

(Contribución de Florent Xicluna y Fredrik Lundh, bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472}.)

@node functools<7>,itertools<8>,elementtree,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 functools}@anchor{1244}
@subsubsection functools



@itemize *

@item 
El módulo @ref{5f,,functools} incluye un nuevo decorador para almacenar en caché las llamadas a funciones. @ref{a81,,functools.lru_cache()} puede guardar consultas repetidas en un recurso externo siempre que se espere que los resultados sean los mismos.

Por ejemplo, agregar un decorador de almacenamiento en caché a una función de consulta de base de datos puede ahorrar accesos a la base de datos para búsquedas populares:

@example
>>> import functools
>>> @@functools.lru_cache(maxsize=300)
... def get_phone_number(name):
...     c = conn.cursor()
...     c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
...     return c.fetchone()[0]
@end example

@example
>>> for name in user_requests:        
...     get_phone_number(name)        # cached lookup
@end example

Para ayudar a elegir un tamaño de caché efectivo, la función encapsulada está instrumentada para rastrear estadísticas de caché:

@example
>>> get_phone_number.cache_info()     
CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
@end example

Si la tabla `phonelist' se actualiza, el contenido desactualizado de la caché se puede borrar con:

@example
>>> get_phone_number.cache_clear()
@end example

(Contributed by Raymond Hettinger and incorporating design ideas from Jim
Baker, Miki Tebeka, and Nick Coghlan; see recipe 498245@footnote{https://code.activestate.com/recipes/498245-lru-and-lfu-cache-decorators/}, recipe 577479@footnote{https://code.activestate.com/recipes/577479-simple-caching-decorator/}, bpo-10586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10586}, and
bpo-10593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10593}.)

@item 
The @ref{fdd,,functools.wraps()} decorator now adds a @code{__wrapped__} attribute
pointing to the original callable function.  This allows wrapped functions to
be introspected.  It also copies @ref{1245,,__annotations__} if
defined.  And now it also gracefully skips over missing attributes such as
@ref{1246,,__doc__} which
might not be defined for the wrapped callable.

En el ejemplo anterior, la caché se puede eliminar recuperando la función original:

@example
>>> get_phone_number = get_phone_number.__wrapped__    # uncached function
@end example

(Por Nick Coghlan y Terrence Cole; bpo-9567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9567}, bpo-3445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3445}, y bpo-8814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8814}.)

@item 
Para ayudar a escribir clases con métodos de comparación enriquecidos, un nuevo decorador @ref{fc2,,functools.total_ordering()} usará métodos de igualdad y desigualdad existentes para completar los métodos restantes.

Por ejemplo, suministrar `__eq__' y `__lt__' permitirá que @ref{fc2,,total_ordering()} complete `__le__', `__gt__' and `__ge__':

@example
@@total_ordering
class Student:
    def __eq__(self, other):
        return ((self.lastname.lower(), self.firstname.lower()) ==
                (other.lastname.lower(), other.firstname.lower()))

    def __lt__(self, other):
        return ((self.lastname.lower(), self.firstname.lower()) <
                (other.lastname.lower(), other.firstname.lower()))
@end example

Con el decorador `total_ordering', los métodos de comparación restantes se completan automáticamente.

(Contribución por Raymond Hettinger.)

@item 
Para ayudar en la migración de programas desde Python 2, la función @ref{1247,,functools.cmp_to_key()} convierte una función de comparación de estilo antiguo en la nueva @ref{e8a,,key function}:

@example
>>> # locale-aware sort order
>>> sorted(iterable, key=cmp_to_key(locale.strcoll)) 
@end example

Para obtener ejemplos de ordenación y un breve tutorial, consulte el tutorial Sorting HowTo@footnote{https://wiki.python.org/moin/HowTo/Sorting/}.

(Contribución por Raymond Hettinger.)
@end itemize

@node itertools<8>,collections<5>,functools<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 itertools}@anchor{1248}
@subsubsection itertools



@itemize *

@item 
El módulo @ref{81,,itertools} tiene una nueva función @ref{a8f,,accumulate()} modelada en el operador `scan' de APL y la función `accumulate' de Numpy:

@example
>>> from itertools import accumulate
>>> list(accumulate([8, 2, 50]))
[8, 10, 60]
@end example

@example
>>> prob_dist = [0.1, 0.4, 0.2, 0.3]
>>> list(accumulate(prob_dist))      # cumulative probability distribution
[0.1, 0.5, 0.7, 1.0]
@end example

Para un ejemplo usando @ref{a8f,,accumulate()}, vea los @ref{1249,,ejemplos para el módulo aleatorio}.

(Contribución de Raymond Hettinger e incorporando sugerencias de diseño de Mark Dickinson.)
@end itemize

@node collections<5>,threading<6>,itertools<8>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 collections}@anchor{124a}
@subsubsection collections



@itemize *

@item 
La clase @ref{110e,,collections.Counter} ahora tiene dos formas de resta in situ, el operador existente `-=' para saturación de resta@footnote{https://es.wikipedia.org/wiki/Aritm%C3%A9tica_de_saturaci%C3%B3n} y el nuevo método @ref{124b,,subtract()} para la resta regular. El primero es adecuado para muticonjunto@footnote{https://es.wikipedia.org/wiki/Multiconjunto} que solo tienen recuentos positivos, y el último es más adecuado para casos de uso que permiten recuentos negativos:

@example
>>> from collections import Counter
>>> tally = Counter(dogs=5, cats=3)
>>> tally -= Counter(dogs=2, cats=8)    # saturating subtraction
>>> tally
Counter(@{'dogs': 3@})
@end example

@example
>>> tally = Counter(dogs=5, cats=3)
>>> tally.subtract(dogs=2, cats=8)      # regular subtraction
>>> tally
Counter(@{'dogs': 3, 'cats': -5@})
@end example

(Contribución por Raymond Hettinger.)

@item 
La clase @ref{67c,,collections.OrderedDict} tiene un nuevo método @ref{124c,,move_to_end()} que toma una clave existente y mueve a la primera o última posición de la secuencia ordenada.

El valor predeterminado es mover un elemento a la última posición. Esto es equivalente a renovar una entrada con @code{od[k] = od.pop(k)}.

Una operación de mover al final rápida es útil para volver a secuenciar entradas. Por ejemplo, se puede usar un diccionario ordenado para rastrear el orden de acceso a las entradas por antigüedad desde la más antigua hasta la más reciente.

@example
>>> from collections import OrderedDict
>>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
>>> list(d)
['a', 'b', 'X', 'd', 'e']
>>> d.move_to_end('X')
>>> list(d)
['a', 'b', 'd', 'e', 'X']
@end example

(Contribución por Raymond Hettinger.)

@item 
La clase @ref{67d,,collections.deque} desarrolló dos métodos nuevos @ref{124d,,count()} y @ref{124e,,reverse()} que los hacen más intercambiables con los objetos @ref{18e,,list} :

@example
>>> from collections import deque
>>> d = deque('simsalabim')
>>> d.count('s')
2
>>> d.reverse()
>>> d
deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
@end example

(Contribución por Raymond Hettinger.)
@end itemize

@node threading<6>,datetime and time,collections<5>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 threading}@anchor{124f}
@subsubsection threading


El módulo @ref{ed,,threading} tiene una nueva clase @ref{1250,,Barrier} de sincronización para hacer que varios hilos esperen hasta que todos hayan alcanzado un punto de barrera común. Las barreras son útiles para asegurarse de que una tarea con múltiples condiciones previas no se ejecute hasta que se completen todas las tareas predecesoras.

Las barreras pueden trabajar con un número arbitrario de hilos. Esto es una generalización de barrera informática@footnote{https://es.wikipedia.org/wiki/Barrera_(inform%C3%A1tica)} que se define solo para dos hilos.

Implementado como una barrera cíclica de dos fases, los objetos @ref{1250,,Barrier} son adecuados para su uso en bucles. Las fases separadas de `llenado' y `drenaje' aseguran que todos los hilos se liberen (drenan) antes de que cualquiera de ellos pueda retornar y volver a entrar en la barrera. La barrera se restablece completamente después de cada ciclo.

Ejemplo de uso de barreras:

@example
from threading import Barrier, Thread

def get_votes(site):
    ballots = conduct_election(site)
    all_polls_closed.wait()        # do not count until all polls are closed
    totals = summarize(ballots)
    publish(site, totals)

all_polls_closed = Barrier(len(sites))
for site in sites:
    Thread(target=get_votes, args=(site,)).start()
@end example

En este ejemplo, la barrera impone una regla de que los votos no se pueden contar en ningún lugar de votación hasta que se cierren todas las urnas. Observe cómo una solución con una barrera es similar a una con @ref{1251,,threading.Thread.join()}, pero los hilos se mantienen vivos y continúan trabajando (resumiendo las papeletas) después de que se cruza el punto de la barrera.

Si alguna de las tareas predecesoras puede bloquearse o retrasarse, se puede crear una barrera con un parámetro opcional `timeout'. Luego, si el período de tiempo de espera transcurre antes de que todas las tareas predecesoras alcancen el punto de barrera, se liberan todos los hilos en espera y se lanza una excepción @ref{1252,,BrokenBarrierError}:

@example
def get_votes(site):
    ballots = conduct_election(site)
    try:
        all_polls_closed.wait(timeout=midnight - time.now())
    except BrokenBarrierError:
        lockbox = seal_ballots(ballots)
        queue.put(lockbox)
    else:
        totals = summarize(ballots)
        publish(site, totals)
@end example

En este ejemplo, la barrera impone una regla más sólida. Si algunos sitios electorales no terminan antes de la medianoche, la barrera expira y las boletas se sellan y se depositan en una cola para su posterior manejo.

Consulte Barrier Synchronization Patterns@footnote{https://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf} para obtener más ejemplos de cómo se pueden usar las barreras en la computación paralela. Además, hay una explicación simple pero completa de las barreras en The Little Book of Semaphores@footnote{https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf}, `section 3.6'.

(Contribución de Kristján Valur Jónsson con una revisión de API de Jeffrey Yasskin en bpo-8777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8777}.)

@node datetime and time,math<7>,threading<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 datetime-and-time}@anchor{1253}
@subsubsection datetime and time



@itemize *

@item 
El módulo @ref{31,,datetime} tiene un nuevo tipo @ref{1134,,timezone} que implementa la interfaz @ref{67f,,tzinfo} retornando un desplazamiento fijo desde UTC y un nombre de zona horaria. Esto hace que sea más fácil crear objetos de fecha y hora que tengan en cuenta la zona horaria:

@example
>>> from datetime import datetime, timezone

>>> datetime.now(timezone.utc)
datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)

>>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
@end example

@item 
Además, los objetos @ref{a61,,timedelta} ahora pueden ser multiplicados por objetos @ref{153,,float} y divididos por objetos @ref{153,,float} e @ref{1f0,,int}. Y los objetos @ref{a61,,timedelta} ahora se pueden dividir entre sí.

@item 
El método @ref{d1a,,datetime.date.strftime()} ya no está restringido a años posteriores a 1900. El nuevo rango de años admitido es de 1000 a 9999 inclusive.

@item 
Whenever a two-digit year is used in a time tuple, the interpretation has been
governed by @code{time.accept2dyear}.  The default is @code{True} which means that
for a two-digit year, the century is guessed according to the POSIX rules
governing the @code{%y} strptime format.

Starting with Py3.2, use of the century guessing heuristic will emit a
@ref{1da,,DeprecationWarning}.  Instead, it is recommended that
@code{time.accept2dyear} be set to @code{False} so that large date ranges
can be used without guesswork:

@example
>>> import time, warnings
>>> warnings.resetwarnings()      # remove the default warning filters

>>> time.accept2dyear = True      # guess whether 11 means 11 or 2011
>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
Warning (from warnings module):
  ...
DeprecationWarning: Century info guessed for a 2-digit year.
'Fri Jan  1 12:34:56 2011'

>>> time.accept2dyear = False     # use the full range of allowable dates
>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
'Fri Jan  1 12:34:56 11'
@end example

Several functions now have significantly expanded date ranges.  When
@code{time.accept2dyear} is false, the @ref{1254,,time.asctime()} function will
accept any year that fits in a C int, while the @ref{1255,,time.mktime()} and
@ref{1256,,time.strftime()} functions will accept the full range supported by the
corresponding operating system functions.
@end itemize

(Contribución de Alexander Belopolsky y Victor Stinner en bpo-1289118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1289118}, bpo-5094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5094}, bpo-6641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6641}, bpo-2706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2706}, bpo-1777412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1777412}, bpo-8013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8013}, y bpo-10827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10827}.)

@c XXX https://bugs.python.org/issue?%40search_text=datetime&%40sort=-activity

@node math<7>,abc<3>,datetime and time,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 math}@anchor{1257}
@subsubsection math


El módulo @ref{8e,,math} se ha actualizado con seis nuevas funciones inspiradas en el estándar C99.

La función @ref{1258,,isfinite()} proporciona una forma rápida y fiable de detectar valores especiales. Retorna @code{True} para números regulares y @code{False} para `Nan' o `Infinity':

@example
>>> from math import isfinite
>>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
[True, True, False, False]
@end example

La función @ref{1259,,expm1()} calcula @code{e**x-1} para valores pequeños de `x' sin incurrir en la pérdida de precisión que generalmente acompaña a la resta de cantidades casi iguales:

@example
>>> from math import expm1
>>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
0.013765762467652909
@end example

La función @ref{c60,,erf()} calcula una integral de probabilidad o función de error gaussiano@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_error}. La función de error complementaria, @ref{c61,,erfc()}, es @code{1 - erf(x)}:

@example
>>> from math import erf, erfc, sqrt
>>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
0.682689492137086
>>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
0.31731050786291404
>>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
1.0
@end example

La función @ref{125a,,gamma()} es una extensión continua de la función factorial. Consulte @indicateurl{https://es.wikipedia.org/wiki/Funci%C3%B3n_gamma} para obtener más detalles. Debido a que la función está relacionada con factoriales, crece incluso para valores pequeños de `x', por lo que también hay una función @ref{125b,,lgamma()} para calcular el logaritmo natural de la función gamma:

@example
>>> from math import gamma, lgamma
>>> gamma(7.0)           # six factorial
720.0
>>> lgamma(801.0)        # log(800 factorial)
4551.950730698041
@end example

(Contribución de Mark Dickinson.)

@node abc<3>,io<8>,math<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 abc}@anchor{125c}
@subsubsection abc


El módulo @ref{4,,abc} ahora admite @ref{1103,,abstractclassmethod()} y @ref{1104,,abstractstaticmethod()}.

Estas herramientas permiten definir una @ref{1224,,abstract base class} que requiere un @ref{2d2,,classmethod()} o @ref{22e,,staticmethod()} particular para ser implementado:

@example
class Temperature(metaclass=abc.ABCMeta):
    @@abc.abstractclassmethod
    def from_fahrenheit(cls, t):
        ...
    @@abc.abstractclassmethod
    def from_celsius(cls, t):
        ...
@end example

(Parche enviado por Daniel Urban; bpo-5867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5867}.)

@node io<8>,reprlib,abc<3>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 io}@anchor{125d}
@subsubsection io


La clase @ref{f25,,io.BytesIO} tiene un nuevo método, @ref{125e,,getbuffer()}, que proporciona una funcionalidad similar a @ref{156,,memoryview()}. Crea una vista editable de los datos sin hacer una copia. El acceso aleatorio del búfer y la compatibilidad con la notación de sectores son adecuados para la edición in situ:

@example
>>> REC_LEN, LOC_START, LOC_LEN = 34, 7, 11

>>> def change_location(buffer, record_number, location):
...     start = record_number * REC_LEN + LOC_START
...     buffer[start: start+LOC_LEN] = location

>>> import io

>>> byte_stream = io.BytesIO(
...     b'G3805  storeroom  Main chassis    '
...     b'X7899  shipping   Reserve cog     '
...     b'L6988  receiving  Primary sprocket'
... )
>>> buffer = byte_stream.getbuffer()
>>> change_location(buffer, 1, b'warehouse  ')
>>> change_location(buffer, 0, b'showroom   ')
>>> print(byte_stream.getvalue())
b'G3805  showroom   Main chassis    '
b'X7899  warehouse  Reserve cog     '
b'L6988  receiving  Primary sprocket'
@end example

(Contribución de Antoine Pitrou en bpo-5506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5506}.)

@node reprlib,logging<5>,io<8>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 reprlib}@anchor{125f}
@subsubsection reprlib


When writing a @ref{6bd,,__repr__()} method for a custom container, it is easy to
forget to handle the case where a member refers back to the container itself.
Python’s builtin objects such as @ref{18e,,list} and @ref{67a,,set} handle
self-reference by displaying «…» in the recursive part of the representation
string.

To help write such @ref{6bd,,__repr__()} methods, the @ref{bb,,reprlib} module has a new
decorator, @ref{1260,,recursive_repr()}, for detecting recursive calls to
@code{__repr__()} and substituting a placeholder string instead:

@example
>>> class MyList(list):
...     @@recursive_repr()
...     def __repr__(self):
...         return '<' + '|'.join(map(repr, self)) + '>'
...
>>> m = MyList('abc')
>>> m.append(m)
>>> m.append('x')
>>> print(m)
<'a'|'b'|'c'|...|'x'>
@end example

(Contribución de Raymond Hettinger en bpo-9826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9826} y bpo-9840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9840}.)

@node logging<5>,csv<4>,reprlib,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 logging}@anchor{1261}
@subsubsection logging


Además de la configuración basada en diccionario descrita anteriormente, el paquete @ref{87,,logging} tiene muchas otras mejoras.

La documentación de logging se ha aumentado con un @ref{1262,,tutorial básico}, un @ref{1263,,tutorial avanzado}, y un @ref{1264,,libro de recetas}. Estos documentos son la forma más rápida de aprender sobre logging.

La función de configuración @ref{a92,,logging.basicConfig()} adquirió un argumento `style' para admitir tres tipos diferentes de formato de cadena de caracteres. Su valor predeterminado es «%» para el formato % tradicional, se puede establecer en «@{» para el nuevo estilo @ref{6c2,,str.format()}, o se puede establecer en «$» para el formato de estilo shell proporcionado por @ref{728,,string.Template}. Las siguientes tres configuraciones son equivalentes:

@example
>>> from logging import basicConfig
>>> basicConfig(style='%', format="%(name)s -> %(levelname)s: %(message)s")
>>> basicConfig(style='@{', format="@{name@} -> @{levelname@} @{message@}")
>>> basicConfig(style='$', format="$name -> $levelname: $message")
@end example

If no configuration is set-up before a logging event occurs, there is now a
default configuration using a @ref{1265,,StreamHandler} directed to
@ref{9cc,,sys.stderr} for events of @code{WARNING} level or higher.  Formerly, an
event occurring before a configuration was set-up would either raise an
exception or silently drop the event depending on the value of
@ref{1266,,logging.raiseExceptions}.  The new default handler is stored in
@ref{1267,,logging.lastResort}.

El uso de filtros ha sido simplificado. En lugar de crear un objeto @ref{1268,,Filter}, la declaración puede ser cualquier invocable Python que retorna @code{True} o @code{False}.

Hubo una serie de otras mejoras que agregan flexibilidad y simplifican la configuración. Consulte la documentación del módulo para obtener una lista completa de los cambios en Python 3.2.

@node csv<4>,contextlib<8>,logging<5>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 csv}@anchor{1269}
@subsubsection csv


El módulo @ref{2a,,csv} ahora admite un nuevo dialecto, @ref{126a,,unix_dialect}, que aplica comillas para todos los campos y un estilo Unix tradicional con @code{'\n'} como terminador de línea. El nombre del dialecto registrado es @code{unix}.

La clase @ref{126b,,csv.DictWriter} tiene un nuevo método, @ref{126c,,writeheader()} para escribir una fila inicial para documentar los nombres de los campos:

@example
>>> import csv, sys
>>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix')
>>> w.writeheader()
"name","dept"
>>> w.writerows([
...     @{'name': 'tom', 'dept': 'accounting'@},
...     @{'name': 'susan', 'dept': 'Salesl'@}])
"tom","accounting"
"susan","sales"
@end example

(Nuevo dialecto sugerido por Jay Talbot en bpo-5975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5975}, y el nuevo método sugerido por Ed Abraham en bpo-1537721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537721}.)

@node contextlib<8>,decimal and fractions,csv<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 contextlib}@anchor{126d}
@subsubsection contextlib


Hay una nueva y ligeramente alucinante herramienta @ref{126e,,ContextDecorator} que es útil para crear un @ref{675,,context manager} que cumple una doble función como decorador de funciones.

Para su comodidad, esta nueva funcionalidad es utilizada por @ref{126f,,contextmanager()} de modo que no se necesita ningún esfuerzo adicional para admitir ambos roles.

La idea básica es que tanto los gestores de contexto como los decoradores de funciones se pueden usar para envoltorios (`wrappers') previos y posteriores a la acción. Los gestores de contexto envuelven un grupo de declaraciones usando la declaración @ref{673,,with} y los decoradores de funciones envuelven un grupo de declaraciones encerradas en una función. Por lo tanto, ocasionalmente es necesario escribir un envoltorio de acción previa o posterior que se pueda usar en cualquiera de los roles.

Por ejemplo, a veces es útil envolver funciones o grupos de declaraciones con un logger que pueda rastrear el tiempo de entrada y el tiempo de salida. En lugar de escribir tanto un decorador de funciones como un gestor de contexto para la tarea, @ref{126f,,contextmanager()} proporciona ambas capacidades en una sola definición:

@example
from contextlib import contextmanager
import logging

logging.basicConfig(level=logging.INFO)

@@contextmanager
def track_entry_and_exit(name):
    logging.info('Entering: %s', name)
    yield
    logging.info('Exiting: %s', name)
@end example

Anteriormente, esto solo se podía usar como gestor de contexto:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

Ahora, también se puede usar como decorador:

@example
@@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()
@end example

Tratar de cumplir dos roles a la vez impone algunas limitaciones a la técnica. Los gestores de contexto normalmente tienen la flexibilidad de retornar un argumento utilizable por una instrucción @ref{673,,with}, pero no hay paralelo para los decoradores de funciones.

En el ejemplo anterior, no hay una forma limpia para que el gestor de contexto `track_entry_and_exit' retorne una instancia de logging para usar en el cuerpo de las declaraciones adjuntas.

(Contribución de Michael Foord en bpo-9110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9110}.)

@node decimal and fractions,ftp,contextlib<8>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 decimal-and-fractions}@anchor{1270}
@subsubsection decimal and fractions


Mark Dickinson diseñó un esquema elegante y eficiente para asegurar que diferentes tipos de datos numéricos tendrán el mismo valor hash siempre que sus valores reales sean iguales (bpo-8188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8188}):

@example
assert hash(Fraction(3, 2)) == hash(1.5) == \
       hash(Decimal("1.5")) == hash(complex(1.5, 0))
@end example

Some of the hashing details are exposed through a new attribute,
@ref{107b,,sys.hash_info}, which describes the bit width of the hash value, the
prime modulus, the hash values for `infinity' and `nan', and the multiplier
used for the imaginary part of a number:

@example
>>> sys.hash_info 
sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)
@end example

An early decision to limit the interoperability of various numeric types has
been relaxed.  It is still unsupported (and ill-advised) to have implicit
mixing in arithmetic expressions such as @code{Decimal('1.1') + float('1.1')}
because the latter loses information in the process of constructing the binary
float.  However, since existing floating-point value can be converted losslessly
to either a decimal or rational representation, it makes sense to add them to
the constructor and to support mixed-type comparisons.


@itemize *

@item 
El constructor @ref{16a,,decimal.Decimal} ahora acepta objetos @ref{153,,float} directamente, por lo que ya no es necesario utilizar el método @ref{1271,,from_float()} (bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}).

@item 
Las comparaciones de tipos mixto ahora son totalmente compatibles, de modo que los objetos @ref{16a,,Decimal} se pueden comparar directamente con @ref{153,,float} y @ref{177,,fractions.Fraction} (bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531} y bpo-8188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8188}).
@end itemize

Similar changes were made to @ref{177,,fractions.Fraction} so that the
@ref{1272,,from_float()} and @ref{1273,,from_decimal()}
methods are no longer needed (bpo-8294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8294}):

@example
>>> from decimal import Decimal
>>> from fractions import Fraction
>>> Decimal(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
>>> Fraction(1.1)
Fraction(2476979795053773, 2251799813685248)
@end example

Another useful change for the @ref{37,,decimal} module is that the
@code{Context.clamp} attribute is now public.  This is useful in creating
contexts that correspond to the decimal interchange formats specified in IEEE
754 (see bpo-8540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8540}).

(Contribución de Mark Dickinson y Raymond Hettinger.)

@node ftp,popen,decimal and fractions,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 ftp}@anchor{1274}
@subsubsection ftp


La clase @ref{990,,ftplib.FTP} ahora admite el protocolo de gestor de contexto para consumir incondicionalmente las excepciones @ref{10d1,,socket.error} y cerrar la conexión FTP cuando haya terminado:

@example
>>> from ftplib import FTP
>>> with FTP("ftp1.at.proftpd.org") as ftp:
        ftp.login()
        ftp.dir()

'230 Anonymous login ok, restrictions apply.'
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
@end example

Otros objetos similares a archivos como @ref{368,,mmap.mmap} y @ref{896,,fileinput.input()} también adquirieron gestores de contexto de cierre automático:

@example
with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
    for line in f:
        process(line)
@end example

(Contribución de Tarek Ziadé y Giampaolo Rodolà en bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972}, y por Georg Brandl en bpo-8046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8046} y bpo-1286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1286}.)

La clase @ref{991,,FTP_TLS} ahora acepta un parámetro `context', que es un objeto @ref{1fa,,ssl.SSLContext} que permite agrupar opciones de configuración SSL, certificados y claves privadas en una sola (y potencialmente de larga duración) estructura.

(Contribución de Giampaolo Rodolà; bpo-8806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8806}.)

@node popen,select<2>,ftp,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 popen}@anchor{1275}
@subsubsection popen


Las funciones @ref{1c5,,os.popen()} y @ref{301,,subprocess.Popen()} ahora admiten declaraciones @ref{673,,with} para el cierre automático de los descriptores de archivo.

(Contribución de Antoine Pitrou y Brian Curtin en bpo-7461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7461} y bpo-10554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10554}.)

@node select<2>,gzip y zipfile,popen,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 select}@anchor{1276}
@subsubsection select


The @ref{c1,,select} module now exposes a new, constant attribute,
@ref{1277,,PIPE_BUF}, which gives the minimum number of bytes which are
guaranteed not to block when @ref{e26,,select.select()} says a pipe is ready
for writing.

@example
>>> import select
>>> select.PIPE_BUF  
512
@end example

(Disponible en sistemas Unix. Parche de Sébastien Sablé en bpo-9862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9862})

@node gzip y zipfile,tarfile<9>,select<2>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 gzip-and-zipfile}@anchor{1278}
@subsubsection gzip y zipfile


@ref{4d8,,gzip.GzipFile} ahora implementa @ref{735,,io.BufferedIOBase} @ref{1224,,clase base abstracta} (excepto para @code{truncate()}). También tiene un método @ref{1279,,peek()} y admite objetos de archivo con rellenos de ceros y que no se pueden buscar.

El módulo @ref{67,,gzip} también obtiene las funciones @ref{6df,,compress()} y @ref{127a,,decompress()} para facilitar la compresión y descompresión en memoria. Tenga en cuenta que el texto debe codificarse como @ref{325,,bytes} antes de comprimir y descomprimir:

@example
>>> import gzip
>>> s = 'Three shall be the number thou shalt count, '
>>> s += 'and the number of the counting shall be three'
>>> b = s.encode()                        # convert to utf-8
>>> len(b)
89
>>> c = gzip.compress(b)
>>> len(c)
77
>>> gzip.decompress(c).decode()[:42]      # decompress and convert to text
'Three shall be the number thou shalt count'
@end example

(Contribución de Anand B. Pillai en bpo-3488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3488}; y de Antoine Pitrou, Nir Aides y Brian Curtin en bpo-9962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9962}, bpo-1675951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1675951}, bpo-7471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7471} y bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846}.)

Also, the @ref{4d9,,zipfile.ZipExtFile} class was reworked internally to represent
files stored inside an archive.  The new implementation is significantly faster
and can be wrapped in an @ref{127b,,io.BufferedReader} object for more speedups.  It
also solves an issue where interleaved calls to `read' and `readline' gave the
wrong results.

(Parche enviado por Nir Aides en bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610}.)

@node tarfile<9>,hashlib<7>,gzip y zipfile,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 tarfile}@anchor{127c}
@subsubsection tarfile


La clase @ref{127d,,TarFile} ahora se puede usar como gestor de contexto. Además, su método @ref{c7b,,add()} tiene una nueva opción, `filter', que controla qué archivos se agregan y permite editar los metadatos del archivo.

La nueva opción `filter' reemplaza el parámetro anterior y menos flexible `exclude' que ahora está deprecado. Si se especifica, el parámetro opcional `filter' debe ser un @ref{d99,,keyword argument}. La función `filter' proporcionada por el usuario acepta un objeto @ref{127e,,TarInfo} y retorna un objeto @ref{127e,,TarInfo} actualizado, o si desea que el archivo sea excluido, la función puede retornar @code{None}:

@example
>>> import tarfile, glob

>>> def myfilter(tarinfo):
...     if tarinfo.isfile():             # only save real files
...         tarinfo.uname = 'monty'      # redact the user name
...         return tarinfo

>>> with tarfile.open(name='myarchive.tar.gz', mode='w:gz') as tf:
...     for filename in glob.glob('*.txt'):
...         tf.add(filename, filter=myfilter)
...     tf.list()
-rw-r--r-- monty/501        902 2011-01-26 17:59:11 annotations.txt
-rw-r--r-- monty/501        123 2011-01-26 17:59:11 general_questions.txt
-rw-r--r-- monty/501       3514 2011-01-26 17:59:11 prion.txt
-rw-r--r-- monty/501        124 2011-01-26 17:59:11 py_todo.txt
-rw-r--r-- monty/501       1399 2011-01-26 17:59:11 semaphore_notes.txt
@end example

(Propuesto por Tarek Ziadé e implementado por Lars Gustäbel en bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856}.)

@node hashlib<7>,ast<7>,tarfile<9>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 hashlib}@anchor{127f}
@subsubsection hashlib


El módulo @ref{68,,hashlib} tiene dos nuevos atributos constantes que enumeran los algoritmos hash garantizados para estar presentes en todas las implementaciones y los disponibles en la implementación actual:

@example
>>> import hashlib

>>> hashlib.algorithms_guaranteed
@{'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'@}

>>> hashlib.algorithms_available
@{'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256',
'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2',
'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224',
'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'@}
@end example

(Sugerido por Carl Chenet en bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418}.)

@node ast<7>,os<13>,hashlib<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 ast}@anchor{1280}
@subsubsection ast


El módulo @ref{9,,ast} tiene una maravillosa herramienta de propósito general para evaluar cadenas de expresión de forma segura utilizando la sintaxis literal de Python. La función @ref{ca0,,ast.literal_eval()} sirve como una alternativa segura a la función incorporada @ref{2eb,,eval()} la cual se abusa fácilmente. Python 3.2 agrega @ref{325,,bytes} y @ref{67a,,set} literales a la lista de tipos admitidos: cadenas de caracteres, bytes, números, tuplas, listas, diccionarios, sets, valores booleanos y @code{None}.

@example
>>> from ast import literal_eval

>>> request = "@{'req': 3, 'func': 'pow', 'args': (2, 0.5)@}"
>>> literal_eval(request)
@{'args': (2, 0.5), 'req': 3, 'func': 'pow'@}

>>> request = "os.system('do something harmful')"
>>> literal_eval(request)
Traceback (most recent call last):
  ...
ValueError: malformed node or string: <_ast.Call object at 0x101739a10>
@end example

(Implementado por Benjamin Peterson y Georg Brandl.)

@node os<13>,shutil<7>,ast<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 os}@anchor{1281}
@subsubsection os


Los diferentes sistemas operativos utilizan varias codificaciones para los nombres de archivo y las variables de entorno. El módulo @ref{a1,,os} proporciona dos funciones nuevas, @ref{cdd,,fsencode()} y @ref{cdc,,fsdecode()}, para codificar y decodificar nombres de archivo:

@example
>>> import os
>>> filename = 'Sehenswürdigkeiten'
>>> os.fsencode(filename)
b'Sehensw\xc3\xbcrdigkeiten'
@end example

Some operating systems allow direct access to encoded bytes in the
environment.  If so, the @ref{1282,,os.supports_bytes_environ} constant will be
true.

Para acceder directamente a las variables de entorno codificadas (si está disponible), utilice la nueva función @ref{1283,,os.getenvb()} o utilice @ref{197,,os.environb}, que es una versión en bytes de @ref{196,,os.environ}.

(Contribución de Victor Stinner.)

@node shutil<7>,sqlite3<12>,os<13>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 shutil}@anchor{1284}
@subsubsection shutil


La función @ref{abb,,shutil.copytree()} tiene dos nuevas opciones:


@itemize *

@item 
`ignore_dangling_symlinks': cuando @code{symlinks=False} para que la función copie un archivo apuntado por un enlace simbólico, no el enlace simbólico en sí. Esta opción silenciará el error lanzado si el archivo no existe.

@item 
`copy_function': es un invocable que se utilizará para copiar archivos. @ref{aec,,shutil.copy2()} se usa por defecto.
@end itemize

(Contribución de Tarek Ziadé.)

Además, el módulo @ref{c5,,shutil} ahora admite @ref{1285,,operaciones de archivado} para archivos zip, archivos tar sin comprimir, archivos tar comprimidos con gzip y archivos tar bzip. Y hay funciones para registrar formatos de archivado de archivo adicionales (como archivos tar comprimidos xz o formatos personalizados).

Las funciones principales son @ref{55a,,make_archive()} y @ref{516,,unpack_archive()}. Por defecto, ambas operan en el directorio actual (que puede ser configurado por @ref{6ae,,os.chdir()}) y en cualquier subdirectorio. El nombre del archivo de almacenamiento debe especificarse con una ruta completa. El paso de archivado no es destructivo (los archivos originales no se modifican).

@example
>>> import shutil, pprint

>>> os.chdir('mydata')  # change to the source directory
>>> f = shutil.make_archive('/var/backup/mydata',
...                         'zip')      # archive the current directory
>>> f                                   # show the name of archive
'/var/backup/mydata.zip'
>>> os.chdir('tmp')                     # change to an unpacking
>>> shutil.unpack_archive('/var/backup/mydata.zip')  # recover the data

>>> pprint.pprint(shutil.get_archive_formats())  # display known formats
[('bztar', "bzip2'ed tar-file"),
 ('gztar', "gzip'ed tar-file"),
 ('tar', 'uncompressed tar file'),
 ('zip', 'ZIP file')]

>>> shutil.register_archive_format(     # register a new archive format
...     name='xz',
...     function=xz.compress,           # callable archiving function
...     extra_args=[('level', 8)],      # arguments to the function
...     description='xz compression'
... )
@end example

(Contribución de Tarek Ziadé.)

@node sqlite3<12>,html<3>,shutil<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 sqlite3}@anchor{1286}
@subsubsection sqlite3


El módulo @ref{cf,,sqlite3} se actualizó a la versión 2.6.0 de pysqlite. Tiene dos nuevas capacidades.


@itemize *

@item 
The @code{sqlite3.Connection.in_transit} attribute is true if there is an
active transaction for uncommitted changes.

@item 
Los métodos @ref{8d5,,sqlite3.Connection.enable_load_extension()} y @ref{55f,,sqlite3.Connection.load_extension()} le permiten cargar extensiones SQLite desde archivos «.so». Una extensión conocida es la extensión de búsqueda de texto completo distribuida con SQLite.
@end itemize

(Contribución de R. David Murray y Shashwat Anand; bpo-8845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8845}.)

@node html<3>,socket<6>,sqlite3<12>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 html}@anchor{1287}
@subsubsection html


Se introdujo un nuevo módulo @ref{6b,,html} con una sola función, @ref{108a,,escape()}, que se usa para escapar caracteres reservados del marcado HTML:

@example
>>> import html
>>> html.escape('x > 2 && x < 7')
'x &gt; 2 &amp;&amp; x &lt; 7'
@end example

@node socket<6>,ssl<12>,html<3>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 socket}@anchor{1288}
@subsubsection socket


El módulo @ref{cc,,socket} tiene dos nuevas mejoras.


@itemize *

@item 
Socket objects now have a @ref{1289,,detach()} method which puts
the socket into closed state without actually closing the underlying file
descriptor.  The latter can then be reused for other purposes.
(Added by Antoine Pitrou; bpo-8524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8524}.)

@item 
@ref{713,,socket.create_connection()} ahora admite el protocolo de administración de contexto para consumir incondicionalmente las excepciones @ref{10d1,,socket.error} y cerrar el socket cuando haya terminado. (Contribución de Giampaolo Rodolà; bpo-9794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9794}.)
@end itemize

@node ssl<12>,nntp,socket<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 ssl}@anchor{128a}
@subsubsection ssl


El módulo @ref{d0,,ssl} agregó una serie de características para satisfacer los requisitos comunes para conexiones a Internet seguras (encriptadas, autenticadas):


@itemize *

@item 
Una nueva clase, @ref{1fa,,SSLContext}, sirve como contenedor para datos SSL persistentes, como configuraciones de protocolo, certificados, claves privadas y varias opciones más. Incluye un @ref{5c8,,wrap_socket()} para crear un socket SSL a partir de un contexto SSL.

@item 
A new function, @code{ssl.match_hostname()}, supports server identity
verification for higher-level protocols by implementing the rules of HTTPS
(from 
@geindex RFC; RFC 2818
RFC 2818@footnote{https://datatracker.ietf.org/doc/html/rfc2818.html}) which are also suitable for other protocols.

@item 
The @ref{5c8,,ssl.wrap_socket()} constructor function now takes a `ciphers'
argument.  The `ciphers' string lists the allowed encryption algorithms using
the format described in the OpenSSL documentation@footnote{https://docs.openssl.org/1.0.2/man1/ciphers/#cipher-list-format}.

@item 
Cuando se vincula con versiones recientes de OpenSSL, el módulo @ref{d0,,ssl} ahora admite la extensión de Server Name Indication (SNI, en español: Indicador del nombre del servidor) para el protocolo TLS, lo que permite que varios» hosts virtuales «utilicen diferentes certificados en un solo puerto IP. Esta extensión solo es compatible en modo cliente y se activa pasando el argumento `server_hostname' a @ref{5c8,,ssl.SSLContext.wrap_socket()}.

@item 
Se han agregado varias opciones al módulo @ref{d0,,ssl}, como @ref{8d0,,OP_NO_SSLv2} que deshabilita el protocolo SSLv2 inseguro y obsoleto.

@item 
La extensión ahora carga todos los algoritmos de resumen y cifrados OpenSSL. Si algunos certificados SSL no se pueden verificar, se notifican como un error de «algoritmo desconocido».

@item 
The version of OpenSSL being used is now accessible using the module
attributes @ref{128b,,ssl.OPENSSL_VERSION} (a string),
@ref{128c,,ssl.OPENSSL_VERSION_INFO} (a 5-tuple), and
@ref{128d,,ssl.OPENSSL_VERSION_NUMBER} (an integer).
@end itemize

(Contribución de Antoine Pitrou en bpo-8850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8850}, bpo-1589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1589}, bpo-8322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8322}, bpo-5639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5639}, bpo-4870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4870}, bpo-8484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8484}, y bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321}.)

@node nntp,certificados,ssl<12>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 nntp}@anchor{128e}
@subsubsection nntp


The @code{nntplib} module has a revamped implementation with better bytes and
text semantics as well as more practical APIs.  These improvements break
compatibility with the nntplib version in Python 3.1, which was partly
dysfunctional in itself.

Support for secure connections through both implicit (using
@code{nntplib.NNTP_SSL}) and explicit (using @code{nntplib.NNTP.starttls()})
TLS has also been added.

(Contribución de Antoine Pitrou en bpo-9360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9360} y Andrew Vant en bpo-1926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1926}.)

@node certificados,imaplib<4>,nntp,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 certificates}@anchor{128f}
@subsubsection certificados


@ref{bc9,,http.client.HTTPSConnection}, @ref{1290,,urllib.request.HTTPSHandler} y @ref{20a,,urllib.request.urlopen()} ahora toman argumentos opcionales para permitir la comprobación del certificado del servidor con un conjunto de Autoridades de Certificación recomendado en usos públicos de HTTPS.

(Agregado por Antoine Pitrou, bpo-9003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9003}.)

@node imaplib<4>,http client<4>,certificados,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 imaplib}@anchor{1291}
@subsubsection imaplib


Se ha agregado soporte para TLS explícito en conexiones IMAP4 estándar a través del nuevo método @ref{1292,,imaplib.IMAP4.starttls}.

(Contribución de Lorenzo M. Catucci y Antoine Pitrou, bpo-4471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4471}.)

@node http client<4>,unittest<10>,imaplib<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 http-client}@anchor{1293}
@subsubsection http.client


Hubo una serie de pequeñas mejoras de API en el módulo @ref{6f,,http.client}. Las respuestas simples HTTP 0.9 de estilo antiguo ya no son compatibles y el parámetro `strict' está obsoleto en todas las clases.

Las clases @ref{bc8,,HTTPConnection} y @ref{bc9,,HTTPSConnection} ahora tienen un parámetro `source_address' para una tupla (host, port) que indica desde dónde se realiza la conexión HTTP.

Se agregó soporte para verificación de certificados y hosts virtuales HTTPS a @ref{bc9,,HTTPSConnection}.

El método @ref{d32,,request()} en los objetos de conexión permitía un argumento `body' opcional para que un @ref{1230,,file object} pudiera usarse para proporcionar el contenido de la solicitud. Convenientemente, el argumento `body' ahora también acepta un objeto @ref{1294,,iterable} siempre que incluya un encabezado explícito @code{Content-Length}. Esta interfaz ampliada es mucho más flexible que antes.

Para establecer una conexión HTTPS a través de un servidor proxy, existe un nuevo método @ref{1295,,set_tunnel()} que establece el host y el puerto para el túnel HTTP Connect.

Para que coincida con el comportamiento de @ref{72,,http.server}, la biblioteca de cliente HTTP ahora también codifica encabezados con codificación ISO-8859-1 (Latin-1). Ya lo estaba haciendo para los encabezados entrantes, por lo que ahora el comportamiento es coherente para el tráfico entrante y saliente. (Véase el trabajo de Armin Ronacher en bpo-10980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10980})

@node unittest<10>,random<3>,http client<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 unittest}@anchor{1296}
@subsubsection unittest


El módulo unittest tiene una serie de mejoras con soporte para descubrimiento de pruebas para paquetes, una experimentación más sencilla en el indicador interactivo, nuevos métodos de casos de prueba, mensajes de diagnóstico mejorados para fallas en las pruebas y mejores nombres de métodos.


@itemize *

@item 
La llamada de línea de comandos @code{python -m unittest} ahora puede aceptar rutas de archivo en lugar de nombres de módulos para ejecutar pruebas específicas (bpo-10620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10620}). El nuevo descubrimiento de pruebas puede encontrar pruebas dentro de los paquetes, localizando cualquier prueba que se pueda importar desde el directorio de nivel superior. El directorio de nivel superior se puede especificar con la opción @code{-t}, un patrón para hacer coincidir archivos con @code{-p} y un directorio para iniciar el descubrimiento con @code{-s}:

@example
$ python -m unittest discover -s my_proj_dir -p _test.py
@end example

(Contribución de Michael Foord.)

@item 
Experimentation at the interactive prompt is now easier because the
@ref{4fa,,unittest.TestCase} class can now be instantiated without
arguments:

@example
>>> from unittest import TestCase
>>> TestCase().assertEqual(pow(2, 3), 8)
@end example

(Contribución de Michael Foord.)

@item 
El módulo @ref{106,,unittest} tiene dos métodos nuevos, @ref{11d5,,assertWarns()} y @ref{11d6,,assertWarnsRegex()} para verificar que un tipo de advertencia dado es activado por el código bajo prueba:

@example
with self.assertWarns(DeprecationWarning):
    legacy_function('XYZ')
@end example

(Contribución de Antoine Pitrou, bpo-9754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9754}.)

Otro método nuevo, @ref{1297,,assertCountEqual()} se usa para comparar dos iterables para determinar si sus conteos de elementos son iguales (si los mismos elementos están presentes con el mismo número de ocurrencias independientemente del orden):

@example
def test_anagram(self):
    self.assertCountEqual('algorithm', 'logarithm')
@end example

(Contribución por Raymond Hettinger.)

@item 
Una característica principal del módulo unittest es un esfuerzo por producir diagnósticos significativos cuando falla una prueba. Cuando es posible, la falla se registra junto con una diferencia de la salida. Esto es especialmente útil para analizar archivos de registro de ejecuciones de prueba fallidas. Sin embargo, dado que las diferencias en ocasiones pueden ser voluminosas, hay un nuevo atributo @ref{1298,,maxDiff} que establece la longitud máxima de las diferencias mostradas.

@item 
Además, los nombres de los métodos en el módulo se han sometido a una serie de limpiezas.

For example, @ref{5d1,,assertRegex()} is the new name for
@code{assertRegexpMatches()} which was misnamed because the
test uses @ref{1299,,re.search()}, not @ref{129a,,re.match()}.  Other methods using
regular expressions are now named using short form «Regex» in preference to
«Regexp» – this matches the names used in other unittest implementations,
matches Python’s old name for the @ref{b9,,re} module, and it has unambiguous
camel-casing.

(Contribución de Raymond Hettinger e implementado por Ezio Melotti.)

@item 
Para mejorar la coherencia, algunos alias de métodos antiguos se están deprecando en favor de los nombres preferidos:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Old Name

@tab

Preferred Name

@item

@code{assert_()}

@tab

@ref{5ca,,assertTrue()}

@item

@code{assertEquals()}

@tab

@ref{5cc,,assertEqual()}

@item

@code{assertNotEquals()}

@tab

@ref{5cd,,assertNotEqual()}

@item

@code{assertAlmostEquals()}

@tab

@ref{5ce,,assertAlmostEqual()}

@item

@code{assertNotAlmostEquals()}

@tab

@ref{5cf,,assertNotAlmostEqual()}

@end multitable

@end quotation

Likewise, the @code{TestCase.fail*} methods deprecated in Python 3.1 are expected
to be removed in Python 3.3.

(Contribución de Ezio Melotti; bpo-9424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9424}.)

@item 
The @code{assertDictContainsSubset()} method was deprecated
because it was misimplemented with the arguments in the wrong order.  This
created hard-to-debug optical illusions where tests like
@code{TestCase().assertDictContainsSubset(@{'a':1, 'b':2@}, @{'a':1@})} would fail.

(Contribución por Raymond Hettinger.)
@end itemize

@node random<3>,poplib<4>,unittest<10>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 random}@anchor{129b}
@subsubsection random


Los métodos enteros en el módulo @ref{b8,,random} ahora hacen un mejor trabajo al producir distribuciones uniformes. Anteriormente, calculaban las selecciones con @code{int(n*random())} que tenía un ligero sesgo siempre que `n' no era una potencia de dos. Ahora, se realizan selecciones múltiples desde un rango hasta la siguiente potencia de dos y una selección se mantiene solo cuando cae dentro del rango @code{0 <= x < n}. Las funciones y métodos afectados son @ref{902,,randrange()}, @ref{129c,,randint()}, @ref{129d,,choice()}, @ref{7e2,,shuffle()} y @ref{7e1,,sample()}.

(Contribución de Raymond Hettinger; bpo-9025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9025}.)

@node poplib<4>,asyncore<2>,random<3>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 poplib}@anchor{129e}
@subsubsection poplib


@ref{9b8,,POP3_SSL} la clase ahora acepta un parámetro `context', que es un objeto @ref{1fa,,ssl.SSLContext} que permite agrupar opciones de configuración SSL, certificados y claves privadas en una única estructura (potencialmente de larga duración) .

(Contribución de Giampaolo Rodolà; bpo-8807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8807}.)

@node asyncore<2>,tempfile<4>,poplib<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 asyncore}@anchor{129f}
@subsubsection asyncore


@code{asyncore.dispatcher} now provides a
@code{handle_accepted()} method
returning a @code{(sock, addr)} pair which is called when a connection has actually
been established with a new remote endpoint. This is supposed to be used as a
replacement for old @code{handle_accept()} and avoids
the user  to call @code{accept()} directly.

(Contribución de Giampaolo Rodolà; bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706}.)

@node tempfile<4>,inspect<6>,asyncore<2>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 tempfile}@anchor{12a0}
@subsubsection tempfile


El módulo @ref{e0,,tempfile} tiene un nuevo gestor de contexto, @ref{12a1,,TemporaryDirectory} que proporciona una limpieza determinista fácil de directorios temporales

@example
with tempfile.TemporaryDirectory() as tmpdirname:
    print('created temporary dir:', tmpdirname)
@end example

(Contribución de Neil Schemenauer y Nick Coghlan; bpo-5178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5178}.)

@node inspect<6>,pydoc<5>,tempfile<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 inspect}@anchor{12a2}
@subsubsection inspect



@itemize *

@item 
El módulo @ref{7e,,inspect} tiene una nueva función @ref{12a3,,getgeneratorstate()} para identificar fácilmente el estado actual de un generador iterador:

@example
>>> from inspect import getgeneratorstate
>>> def gen():
...     yield 'demo'
...
>>> g = gen()
>>> getgeneratorstate(g)
'GEN_CREATED'
>>> next(g)
'demo'
>>> getgeneratorstate(g)
'GEN_SUSPENDED'
>>> next(g, None)
>>> getgeneratorstate(g)
'GEN_CLOSED'
@end example

(Contribución de Rodolpho Eckhardt y Nick Coghlan, bpo-10220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10220}.)

@item 
Para admitir búsquedas sin la posibilidad de activar un atributo dinámico, el módulo @ref{7e,,inspect} tiene una nueva función, @ref{53d,,getattr_static()}. A diferencia de @ref{579,,hasattr()}, esta es una verdadera búsqueda de solo lectura, garantizada que no cambiará de estado mientras está buscando:

@example
>>> class A:
...     @@property
...     def f(self):
...         print('Running')
...         return 10
...
>>> a = A()
>>> getattr(a, 'f')
Running
10
>>> inspect.getattr_static(a, 'f')
<property object at 0x1022bd788>
@end example
@end itemize

@quotation

(Contribución de Michael Foord.)
@end quotation

@node pydoc<5>,dis<6>,inspect<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 pydoc}@anchor{12a4}
@subsubsection pydoc


El módulo @ref{b5,,pydoc} ahora proporciona una interfaz de servidor web muy mejorada, así como una nueva opción de línea de comandos @code{-b} para abrir automáticamente una ventana del navegador para mostrar ese servidor:

@example
$ pydoc3.2 -b
@end example

(Contribución de Ron Adam; bpo-2001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2001}.)

@node dis<6>,dbm<7>,pydoc<5>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 dis}@anchor{12a5}
@subsubsection dis


El módulo @ref{39,,dis} obtuvo dos nuevas funciones para inspeccionar código, @ref{12a6,,code_info()} y @ref{fae,,show_code()}. Ambas proporcionan información detallada del objeto de código para la función, método, cadena de código fuente o objeto de código suministrados. El primero retorna una cadena de caracteres y el segundo la imprime:

@example
>>> import dis, random
>>> dis.show_code(random.choice)
Name:              choice
Filename:          /Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/random.py
Argument count:    2
Kw-only arguments: 0
Number of locals:  3
Stack size:        11
Flags:             OPTIMIZED, NEWLOCALS, NOFREE
Constants:
   0: 'Choose a random element from a non-empty sequence.'
   1: 'Cannot choose from an empty sequence'
Names:
   0: _randbelow
   1: len
   2: ValueError
   3: IndexError
Variable names:
   0: self
   1: seq
   2: i
@end example

Además, la función @ref{172,,dis()} ahora acepta argumentos de cadena para que el modismo común @code{dis(compile(s, '@w{'}, 'eval'))} se pueda abreviar a @code{dis(s)}:

@example
>>> dis('3*x+1 if x%2==1 else x//2')
  1           0 LOAD_NAME                0 (x)
              3 LOAD_CONST               0 (2)
              6 BINARY_MODULO
              7 LOAD_CONST               1 (1)
             10 COMPARE_OP               2 (==)
             13 POP_JUMP_IF_FALSE       28
             16 LOAD_CONST               2 (3)
             19 LOAD_NAME                0 (x)
             22 BINARY_MULTIPLY
             23 LOAD_CONST               1 (1)
             26 BINARY_ADD
             27 RETURN_VALUE
        >>   28 LOAD_NAME                0 (x)
             31 LOAD_CONST               0 (2)
             34 BINARY_FLOOR_DIVIDE
             35 RETURN_VALUE
@end example

En conjunto, estas mejoras facilitan explorar cómo se implementa CPython y ver por sí mismo qué hace la sintaxis del lenguaje bajo el capó.

(Contribución de Nick Coghlan en bpo-9147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9147}.)

@node dbm<7>,ctypes<4>,dis<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 dbm}@anchor{12a7}
@subsubsection dbm


All database modules now support the @code{get()} and @code{setdefault()} methods.

(Sugerido por Ray Allen en bpo-9523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9523}.)

@node ctypes<4>,site<2>,dbm<7>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 ctypes}@anchor{12a8}
@subsubsection ctypes


Un nuevo tipo, @ref{12a9,,ctypes.c_ssize_t} representa el tipo de datos C @code{ssize_t}.

@node site<2>,sysconfig<2>,ctypes<4>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 site}@anchor{12aa}
@subsubsection site


El módulo @ref{c7,,site} tiene tres nuevas funciones útiles para informar sobre los detalles de una determinada instalación de Python.


@itemize *

@item 
@ref{12ab,,getsitepackages()} enumera todos los directorios de paquetes de sitios globales.

@item 
@ref{12ac,,getuserbase()} informa sobre el directorio base del usuario donde se pueden almacenar los datos.

@item 
@ref{12ad,,getusersitepackages()} revela la ruta del directorio de paquetes de sitio específico del usuario.
@end itemize

@example
>>> import site
>>> site.getsitepackages()
['/Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/site-packages',
 '/Library/Frameworks/Python.framework/Versions/3.2/lib/site-python',
 '/Library/Python/3.2/site-packages']
>>> site.getuserbase()
'/Users/raymondhettinger/Library/Python/3.2'
>>> site.getusersitepackages()
'/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages'
@end example

Convenientemente, se puede acceder a algunas de las funciones del sitio directamente desde la línea de comandos:

@example
$ python -m site --user-base
/Users/raymondhettinger/.local
$ python -m site --user-site
/Users/raymondhettinger/.local/lib/python3.2/site-packages
@end example

(Contribución de Tarek Ziadé en bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693}.)

@node sysconfig<2>,pdb<8>,site<2>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 sysconfig}@anchor{12ae}
@subsubsection sysconfig


El nuevo módulo @ref{db,,sysconfig} hace que sea sencillo descubrir rutas de instalación y variables de configuración que varían entre plataformas e instalaciones.

El módulo ofrece acceso a funciones de acceso simple para información de plataforma y versión:


@itemize *

@item 
@ref{12af,,get_platform()} retornando valores como `linux-i586' o `macosx-10.6-ppc'.

@item 
@ref{12b0,,get_python_version()} retorna una cadena de versión de Python como» 3.2 «.
@end itemize

It also provides access to the paths and variables corresponding to one of
seven named schemes used by @code{distutils}.  Those include `posix_prefix',
`posix_home', `posix_user', `nt', `nt_user', `os2', `os2_home':


@itemize *

@item 
@ref{12b1,,get_paths()} crea un diccionario que contiene las rutas de instalación para el esquema de instalación actual.

@item 
@ref{10a8,,get_config_vars()} retorna un diccionario de variables específicas de la plataforma.
@end itemize

También hay una conveniente interfaz de línea de comandos:

@example
C:\Python32>python -m sysconfig
Platform: "win32"
Python version: "3.2"
Current installation scheme: "nt"

Paths:
        data = "C:\Python32"
        include = "C:\Python32\Include"
        platinclude = "C:\Python32\Include"
        platlib = "C:\Python32\Lib\site-packages"
        platstdlib = "C:\Python32\Lib"
        purelib = "C:\Python32\Lib\site-packages"
        scripts = "C:\Python32\Scripts"
        stdlib = "C:\Python32\Lib"

Variables:
        BINDIR = "C:\Python32"
        BINLIBDEST = "C:\Python32\Lib"
        EXE = ".exe"
        INCLUDEPY = "C:\Python32\Include"
        LIBDEST = "C:\Python32\Lib"
        SO = ".pyd"
        VERSION = "32"
        abiflags = ""
        base = "C:\Python32"
        exec_prefix = "C:\Python32"
        platbase = "C:\Python32"
        prefix = "C:\Python32"
        projectbase = "C:\Python32"
        py_version = "3.2"
        py_version_nodot = "32"
        py_version_short = "3.2"
        srcdir = "C:\Python32"
        userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
@end example

(Sacado de Distutils por Tarek Ziadé.)

@node pdb<8>,configparser<5>,sysconfig<2>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 pdb}@anchor{12b2}
@subsubsection pdb


El módulo depurador @ref{a5,,pdb} obtuvo una serie de mejoras de usabilidad:


@itemize *

@item 
@code{pdb.py} ahora tiene una opción @code{-c} que ejecuta comandos como se indica en un archivo de script @code{.pdbrc}.

@item 
Un archivo de secuencia de comandos @code{.pdbrc} puede contener comandos @code{continue} y @code{next} que continúan depurando.

@item 
The @ref{1a8,,Pdb} class constructor now accepts a `nosigint' argument.

@item 
Nuevos comandos: @code{l(list)}, @code{ll(long list)} y @code{source} para enumerar el código fuente.

@item 
Nuevos comandos: @code{display} y @code{undisplay} para mostrar u ocultar el valor de una expresión si ha cambiado.

@item 
Nuevo comando: @code{interact} para iniciar un intérprete interactivo que contiene los nombres globales y locales que se encuentran en el alcance actual.

@item 
Los puntos de interrupción se pueden borrar por número de punto de interrupción.
@end itemize

(Contribución de Georg Brandl, Antonio Cuni e Ilya Sandler.)

@node configparser<5>,urllib parse<6>,pdb<8>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 configparser}@anchor{12b3}
@subsubsection configparser


The @ref{23,,configparser} module was modified to improve usability and
predictability of the default parser and its supported INI syntax.  The old
@code{ConfigParser} class was removed in favor of @code{SafeConfigParser}
which has in turn been renamed to @ref{32b,,ConfigParser}. Support
for inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.

Los analizadores de configuración obtuvieron una nueva API basada en el protocolo de mapeo:

@example
>>> parser = ConfigParser()
>>> parser.read_string("""
... [DEFAULT]
... location = upper left
... visible = yes
... editable = no
... color = blue
...
... [main]
... title = Main Menu
... color = green
...
... [options]
... title = Options
... """)
>>> parser['main']['color']
'green'
>>> parser['main']['editable']
'no'
>>> section = parser['options']
>>> section['title']
'Options'
>>> section['title'] = 'Options (editable: %(editable)s)'
>>> section['title']
'Options (editable: no)'
@end example

La nueva API se implementa sobre la API clásica, por lo que las subclases de analizadores personalizados deberían poder usarla sin modificaciones.

La estructura de archivos INI aceptada por los analizadores de configuración ahora se puede personalizar. Los usuarios pueden especificar opciones alternativas/delimitadores de valores y prefijos de comentarios, cambiar el nombre de la sección `DEFAULT' o cambiar la sintaxis de interpolación.

Hay soporte para la interpolación conectable que incluye un controlador de interpolación adicional @ref{7bf,,ExtendedInterpolation}:

@example
>>> parser = ConfigParser(interpolation=ExtendedInterpolation())
>>> parser.read_dict(@{'buildout': @{'directory': '/home/ambv/zope9'@},
...                   'custom': @{'prefix': '/usr/local'@}@})
>>> parser.read_string("""
... [buildout]
... parts =
...   zope9
...   instance
... find-links =
...   $@{buildout:directory@}/downloads/dist
...
... [zope9]
... recipe = plone.recipe.zope9install
... location = /opt/zope
...
... [instance]
... recipe = plone.recipe.zope9instance
... zope9-location = $@{zope9:location@}
... zope-conf = $@{custom:prefix@}/etc/zope.conf
... """)
>>> parser['buildout']['find-links']
'\n/home/ambv/zope9/downloads/dist'
>>> parser['instance']['zope-conf']
'/usr/local/etc/zope.conf'
>>> instance = parser['instance']
>>> instance['zope-conf']
'/usr/local/etc/zope.conf'
>>> instance['zope9-location']
'/opt/zope'
@end example

También se introdujeron una serie de características más pequeñas, como soporte para especificar codificación en operaciones de lectura, especificar valores de respaldo para funciones de obtención o leer directamente desde diccionarios y cadenas.

(Todos los cambios aportados por Łukasz Langa.)

@c XXX consider showing a difflib example

@node urllib parse<6>,mailbox,configparser<5>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 urllib-parse}@anchor{12b4}
@subsubsection urllib.parse


Se realizaron varias mejoras de usabilidad para el módulo @ref{10a,,urllib.parse}.

La función @ref{207,,urlparse()} ahora admite direcciones IPv6@footnote{https://en.wikipedia.org/wiki/IPv6} como se describe en 
@geindex RFC; RFC 2732
RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html}:

@example
>>> import urllib.parse
>>> urllib.parse.urlparse('http://[dead:beef:cafe:5417:affe:8FA3:deaf:feed]/foo/') 
ParseResult(scheme='http',
            netloc='[dead:beef:cafe:5417:affe:8FA3:deaf:feed]',
            path='/foo/',
            params='@w{'},
            query='@w{'},
            fragment='@w{'})
@end example

La función @ref{12b5,,urldefrag()} ahora devuelve un @ref{6ef,,named tuple}:

@example
>>> r = urllib.parse.urldefrag('http://python.org/about/#target')
>>> r
DefragResult(url='http://python.org/about/', fragment='target')
>>> r[0]
'http://python.org/about/'
>>> r.fragment
'target'
@end example

Y, la función @ref{f16,,urlencode()} ahora es mucho más flexible, aceptando un tipo de cadena o bytes para el argumento `query'. Si es una cadena, entonces los parámetros `safe', `encoding' y `error' se envían a @ref{12b6,,quote_plus()} para codificar:

@example
>>> urllib.parse.urlencode([
...      ('type', 'telenovela'),
...      ('name', '¿Dónde Está Elisa?')],
...      encoding='latin-1')
'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F'
@end example

Como se detalla en @ref{12b7,,Análisis de bytes codificados ASCII}, todas las funciones @ref{10a,,urllib.parse} ahora aceptan cadenas de bytes codificadas en ASCII como entrada, siempre que no estén mezcladas con cadenas normales. Si se proporcionan cadenas de bytes codificadas en ASCII como parámetros, los tipos de retorno también serán cadenas de bytes codificadas en ASCII:

@example
>>> urllib.parse.urlparse(b'http://www.python.org:80/about/') 
ParseResultBytes(scheme=b'http', netloc=b'www.python.org:80',
                 path=b'/about/', params=b'@w{'}, query=b'@w{'}, fragment=b'@w{'})
@end example

(Trabajo de Nick Coghlan, Dan Mahn y Senthil Kumaran en bpo-2987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2987}, bpo-5468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5468}, y bpo-9873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9873}.)

@node mailbox,turtledemo,urllib parse<6>,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 mailbox}@anchor{12b8}
@subsubsection mailbox


Gracias a un esfuerzo concertado de R. David Murray, el módulo @ref{8b,,mailbox} se ha corregido para Python 3.2. El desafío era que el buzón había sido diseñado originalmente con una interfaz de texto, pero los mensajes de correo electrónico se representan mejor con @ref{325,,bytes} porque varias partes de un mensaje pueden tener diferentes codificaciones.

La solución aprovechó el soporte binario de los paquete @ref{3c,,email} para analizar mensajes de correo electrónico arbitrarios. Además, la solución requirió una serie de cambios en la API.

Como era de esperar, el método @ref{12b9,,add()} para los objetos @ref{12ba,,mailbox.Mailbox} ahora acepta entrada binaria.

@ref{fa9,,StringIO} y la entrada del archivo de texto están en desuso. Además, la entrada de cadenas fallará antes si se utilizan caracteres que no sean ASCII. Anteriormente, fallaba cuando el correo electrónico se procesaba en un paso posterior.

También hay soporte para salida binaria. El método @ref{12bb,,get_file()} ahora devuelve un archivo en modo binario (donde solía configurar incorrectamente el archivo en modo texto). También hay un nuevo método @ref{12bc,,get_bytes()} que devuelve una representación @ref{325,,bytes} de un mensaje correspondiente a una `key' dada.

Todavía es posible obtener una salida no binaria usando el método de la API anterior @ref{12bd,,get_string()}, pero ese enfoque no es muy útil. En su lugar, es mejor extraer mensajes de un objeto @ref{12be,,Message} o cargarlos desde una entrada binaria.

(Contribuido por R. David Murray, con esfuerzos de Steffen Daode Nurpmeso y un parche inicial de Victor Stinner en bpo-9124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9124}.)

@node turtledemo,,mailbox,Módulos nuevos mejorados y obsoletos
@anchor{whatsnew/3 2 turtledemo}@anchor{12bf}
@subsubsection turtledemo


The demonstration code for the @ref{101,,turtle} module was moved from the `Demo'
directory to main library.  It includes over a dozen sample scripts with
lively displays.  Being on @ref{27e,,sys.path}, it can now be run directly
from the command-line:

@example
$ python -m turtledemo
@end example

(Movido del directorio Demo por Alexander Belopolsky en bpo-10199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10199}.)

@node Multi-threading,Optimizations<3>,Módulos nuevos mejorados y obsoletos,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 multi-threading}@anchor{12c0}
@subsection Multi-threading



@itemize *

@item 
The mechanism for serializing execution of concurrently running Python threads
(generally known as the @ref{2c5,,GIL} or Global Interpreter Lock) has
been rewritten.  Among the objectives were more predictable switching
intervals and reduced overhead due to lock contention and the number of
ensuing system calls.  The notion of a «check interval» to allow thread
switches has been abandoned and replaced by an absolute duration expressed in
seconds.  This parameter is tunable through @ref{9dd,,sys.setswitchinterval()}.
It currently defaults to 5 milliseconds.

Se pueden leer detalles adicionales sobre la implementación en un mensaje de lista de correo python-dev mailing-list message@footnote{https://mail.python.org/pipermail/python-dev/2009-October/093321.html} (sin embargo, «prioridad las solicitudes» como se expone en este mensaje no se han mantenido para su inclusión).

(Contribución de Antoine Pitrou.)

@item 
Los bloqueos regulares y recursivos ahora aceptan un argumento opcional `timeout' para su método @ref{739,,acquire()} . (Contribución de Antoine Pitrou; bpo-7316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7316}.)

@item 
De manera similar, @ref{12c1,,threading.Semaphore.acquire()} también ganó un argumento `timeout'. (Contribución de Torsten Landschoff; bpo-850728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=850728}.)

@item 
Las adquisiciones de bloqueos regulares y recursivas ahora pueden ser interrumpidas por señales en plataformas que usan Pthreads. Esto significa que los programas de Python que se bloquean mientras adquieren bloqueos pueden eliminarse con éxito enviando repetidamente SIGINT al proceso (presionando @code{Ctrl+C} en la mayoría de los shells). (Contribuido por Reid Kleckner; bpo-8844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8844}.)
@end itemize

@node Optimizations<3>,Unicode,Multi-threading,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 optimizations}@anchor{12c2}
@subsection Optimizations


Se han agregado una serie de pequeñas mejoras de rendimiento:


@itemize *

@item 
El optimizador de mirilla de Python ahora reconoce patrones como @code{x in @{1, 2, 3@}} como una prueba de pertenencia a un conjunto de constantes. El optimizador reformula @ref{67a,,set} como @ref{67b,,frozenset} y almacena la constante preconstruida.

Ahora que la penalización de velocidad se ha ido, es práctico comenzar a escribir pruebas de membresía usando notación de conjuntos. Este estilo es semánticamente claro y operativamente rápido:

@example
extension = name.rpartition('.')[2]
if extension in @{'xml', 'html', 'xhtml', 'css'@}:
    handle(name)
@end example

(Parche y pruebas adicionales aportadas por Dave Malcolm; bpo-6690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6690}).

@item 
Serializar y deserializar datos usando el módulo @ref{a6,,pickle} ahora es varias veces más rápido.

(Contribución de Alexandre Vassalotti, Antoine Pitrou y el equipo de Unladen Swallow en bpo-9410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9410} y bpo-3873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3873}.)

@item 
El algoritmo Timsort algorithm@footnote{https://en.wikipedia.org/wiki/Timsort} usado en @ref{c57,,list.sort()} y @ref{c56,,sorted()} ahora se ejecuta más rápido y usa menos memoria cuando se llama con @ref{e8a,,key function}. Anteriormente, cada elemento de una lista se envolvía con un objeto temporal que recordaba el valor clave asociado con cada elemento. Ahora, dos matrices de claves y valores se ordenan en paralelo. Esto ahorra la memoria consumida por los contenedores de clasificación y ahorra el tiempo perdido al delegar comparaciones.

(Parche de Daniel Stutzbach en bpo-9915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9915}.)

@item 
El rendimiento de la decodificación JSON mejora y el consumo de memoria se reduce siempre que se repite la misma cadena para varias claves. Además, la codificación JSON ahora usa las aceleraciones de C cuando el argumento @code{sort_keys} es verdadero.

(Contribución de Antoine Pitrou en bpo-7451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7451} y Raymond Hettinger y Antoine Pitrou en bpo-10314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10314}.)

@item 
Los bloqueos recursivos (creados con la API @ref{1d7,,threading.RLock()}) ahora se benefician de una implementación de C que los hace tan rápidos como los bloqueos normales, y entre 10 y 15 veces más rápidos que su anterior implementación pura de Python.

(Contribución de Antoine Pitrou; bpo-3001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3001}.)

@item 
The fast-search algorithm in stringlib is now used by the @ref{f2b,,split()},
@ref{12c3,,rsplit()}, @ref{12c4,,splitlines()} and @ref{302,,replace()} methods on
@ref{325,,bytes}, @ref{5e0,,bytearray} and @ref{237,,str} objects. Likewise, the
algorithm is also used by @ref{f2a,,rfind()}, @ref{12c5,,rindex()}, @ref{12c3,,rsplit()} and
@ref{12c6,,rpartition()}.

(Parche de Florent Xicluna en bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622} y bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462}.)

@item 
Las conversiones de enteros a cadenas de caracteres ahora funcionan con dos «dígitos» a la vez, lo que reduce el número de operaciones de división y módulo.

(bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713} de Gawain Bolton, Mark Dickinson y Victor Stinner.)
@end itemize

There were several other minor optimizations. Set differencing now runs faster
when one operand is much larger than the other (patch by Andress Bennetts in
bpo-8685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8685}).  The @code{array.repeat()} method has a faster implementation
(bpo-1569291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1569291} by Alexander Belopolsky). The @ref{1140,,BaseHTTPRequestHandler}
has more efficient buffering (bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709} by Andrew Schaaf).  The
@ref{eb8,,operator.attrgetter()} function has been sped-up (bpo-10160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10160} by
Christos Georgiou).  And @ref{32b,,ConfigParser} loads multi-line arguments a bit
faster (bpo-7113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7113} by Łukasz Langa).

@node Unicode,Codecs,Optimizations<3>,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 unicode}@anchor{12c7}
@subsection Unicode


Python se ha actualizado a Unicode 6.0.0@footnote{https://unicode.org/versions/Unicode6.0.0/}. La actualización del estándar agrega más de 2000 caracteres nuevos, incluidos los símbolos emoji@footnote{https://en.wikipedia.org/wiki/Emoji} que son importantes para los teléfonos móviles.

Además, el estándar actualizado modificó las propiedades de dos caracteres de Kannada (U+0CF1, U+0CF2) y un carácter numérico New Tai Lue (U+19DA), lo que hace que el primero sea elegible para su uso en identificadores y descalifica al segundo. Para obtener más información, consulte Unicode Character Database Changes@footnote{https://www.unicode.org/versions/Unicode6.0.0/#Database_Changes}.

@node Codecs,Documentación,Unicode,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 codecs}@anchor{12c8}
@subsection Codecs


Se agregó soporte para `cp720' codificación DOS árabe (bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979}).

La codificación MBCS ya no ignora el argumento del controlador de errores. En el modo estricto predeterminado, genera un @ref{aa5,,UnicodeDecodeError} cuando encuentra una secuencia de bytes no codificable y un @ref{718,,UnicodeEncodeError} para un carácter no codificable.

El códec MBCS admite los controladores de errores @code{'strict'} e @code{'ignore'} para la decodificación y @code{'strict'} y @code{'replace'} para la codificación.

Para emular la codificación Python3.1 MBCS, seleccione el controlador @code{'ignore'} para decodificar y el controlador @code{'replace'} para codificar.

En Mac OS X, Python decodifica los argumentos de la línea de comandos con @code{'utf-8'} en lugar de la codificación local.

De forma predeterminada, @ref{de,,tarfile} usa la codificación @code{'utf-8'} en Windows (en lugar de @code{'mbcs'}) y el controlador de errores @code{'surrogateescape'} en todos los sistemas operativos.

@node Documentación,IDLE,Codecs,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 documentation}@anchor{12c9}
@subsection Documentación


La documentación sigue mejorando.


@itemize *

@item 
Se ha agregado una tabla de enlaces rápidos en la parte superior de secciones largas como @ref{12ca,,Funciones incorporadas}. En el caso de @ref{81,,itertools}, los enlaces están acompañados de tablas de resúmenes al estilo de una hoja de trucos para proporcionar una descripción general y un cambio de memoria sin tener que leer todos los documentos.

@item 
En algunos casos, el código fuente puro de Python puede ser un complemento útil de la documentación, por lo que ahora muchos módulos incluyen enlaces rápidos a la última versión del código fuente. Por ejemplo, la documentación del módulo @ref{5f,,functools} tiene un enlace rápido en la parte superior etiquetado:

@quotation

`Código fuente' Lib/functools.py@footnote{https://github.com/python/cpython/tree/main/Lib/functools.py}.
@end quotation

(Contribuido por Raymond Hettinger; ver rationale@footnote{https://rhettinger.wordpress.com/2011/01/28/open-your-source-more/}.)

@item 
Los documentos ahora contienen más ejemplos y recetas. En particular, el módulo @ref{b9,,re} tiene una sección extensa, @ref{12cb,,Ejemplos de expresiones regulares}. Asimismo, el módulo @ref{81,,itertools} continúa siendo actualizado con nuevo @ref{12cc,,Fórmulas con itertools}.

@item 
El módulo @ref{31,,datetime} ahora tiene una implementación auxiliar en Python puro. No se modificó ninguna funcionalidad. Esto solo proporciona una implementación alternativa más fácil de leer.

(Contribuido por Alexander Belopolsky en bpo-9528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9528}.)

@item 
Se ha eliminado el directorio no mantenido @code{Demo}. Algunas demostraciones se integraron en la documentación, otras se movieron al directorio @code{Tools/demo} y otras se eliminaron por completo.

(Contribución de Georg Brandl en bpo-7962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7962}.)
@end itemize

@node IDLE,Repositorio de código,Documentación,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 idle}@anchor{12cd}
@subsection IDLE



@itemize *

@item 
El menú de formato ahora tiene una opción para limpiar archivos de origen eliminando los espacios en blanco finales.

(Contribución de Raymond Hettinger; bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150}.)

@item 
IDLE en Mac OS X ahora funciona con Carbon AquaTk y Cocoa AquaTk.

(Contribución de Kevin Walzer, Ned Deily y Ronald Oussoren; bpo-6075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6075}.)
@end itemize

@node Repositorio de código,Cambios en la API de construcción y C,IDLE,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 code-repository}@anchor{12ce}
@subsection Repositorio de código


Además del repositorio de código Subversion existente en @indicateurl{https://svn.python.org}, ahora hay un repositorio Mercurial@footnote{https://www.mercurial-scm.org/} en @indicateurl{https://hg.python.org/}.

Después de la versión 3.2, hay planes para cambiar a Mercurial como repositorio principal. Este sistema de control de versiones distribuido debería facilitar a los miembros de la comunidad la creación y el intercambio de conjuntos de cambios externos. Consulte 
@geindex Python Enhancement Proposals; PEP 385
PEP 385@footnote{https://peps.python.org/pep-0385/} para obtener más detalles.

Para aprender a utilizar el nuevo sistema de control de versiones, consulte el Quick Start@footnote{https://www.mercurial-scm.org/wiki/QuickStart} o la Guide to Mercurial Workflows@footnote{https://www.mercurial-scm.org/guide}.

@node Cambios en la API de construcción y C,Portar a Python 3 2,Repositorio de código,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 build-and-c-api-changes}@anchor{12cf}
@subsection Cambios en la API de construcción y C


Los cambios en el proceso de compilación de Python y en la API de C incluyen:


@itemize *

@item 
Los scripts `idle', `pydoc' y `2to3' ahora están instalados con un sufijo específico de la versión en @code{make altinstall} (bpo-10679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10679}).

@item 
Las funciones C que acceden a la base de datos Unicode ahora aceptan y retornan caracteres del rango Unicode completo, incluso en compilaciones Unicode estrechas (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, y otras). Una diferencia visible en Python es que @ref{12d0,,unicodedata.numeric()} ahora devuelve el valor correcto para puntos de código grandes y @ref{894,,repr()} puede considerar más caracteres como imprimibles.

(Informado por Bupjoe Lee y corregido por Amaury Forgeot D’Arc; bpo-5127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5127}.)

@item 
Los gotos calculados ahora están habilitados de forma predeterminada en los compiladores compatibles (que son detectados por el script de configuración). Todavía se pueden desactivar de forma selectiva especificando @code{--without-computed-gotos}.

(Contribución de Antoine Pitrou; bpo-9203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9203}.)

@item 
Se eliminó la opción @code{--with-wctype-functions}. La base de datos unicode incorporada ahora se usa para todas las funciones.

(Contribución de Amaury Forgeot D’Arc; bpo-9210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9210}.)

@item 
Los valores hash ahora son valores de un nuevo tipo, @ref{12d1,,Py_hash_t}, que se define como del mismo tamaño que un puntero. Anteriormente eran del tipo long, que en algunos sistemas operativos de 64 bits todavía tiene una longitud de solo 32 bits. Como resultado de esta corrección, @ref{67a,,set} y @ref{190,,dict} ahora pueden contener más de @code{2**32} entradas en compilaciones con punteros de 64 bits (anteriormente, podían crecer hasta ese tamaño pero su desempeño se degradaba catastróficamente).

(Sugerido por Raymond Hettinger e implementado por Benjamin Peterson; bpo-9778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9778}.)

@item 
A new macro @code{Py_VA_COPY} copies the state of the variable argument
list.  It is equivalent to C99 `va_copy' but available on all Python platforms
(bpo-2443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2443}).

@item 
A new C API function @code{PySys_SetArgvEx()} allows an embedded interpreter
to set @ref{12d2,,sys.argv} without also modifying @ref{27e,,sys.path}
(bpo-5753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5753}).

@item 
@code{PyEval_CallObject()} is now only available in macro form.  The
function declaration, which was kept for backwards compatibility reasons, is
now removed – the macro was introduced in 1997 (bpo-8276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8276}).

@item 
Hay una nueva función @ref{12d3,,PyLong_AsLongLongAndOverflow()} que es análoga a @ref{12d4,,PyLong_AsLongAndOverflow()}. Ambos sirven para convertir Python @ref{1f0,,int} en un tipo nativo de ancho fijo al tiempo que brindan detección de casos en los que la conversión no encaja (bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767}).

@item 
La función @ref{12d5,,PyUnicode_CompareWithASCIIString()} ahora devuelve `not equal' si la cadena de Python es `NUL' terminada.

@item 
Hay una nueva función @ref{12d6,,PyErr_NewExceptionWithDoc()} que es como @ref{12d7,,PyErr_NewException()} pero permite especificar una cadena de documentos. Esto permite que las excepciones de C tengan las mismas capacidades de auto-documentación que sus contrapartes de Python puro (bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033}).

@item 
Cuando se compila con la opción @code{--with-valgrind}, el asignador de pymalloc se desactivará automáticamente cuando se ejecute en Valgrind. Esto brinda una detección mejorada de fugas de memoria cuando se ejecuta en Valgrind, mientras se aprovecha pymalloc en otros momentos (bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422}).

@item 
Se eliminó el formato @code{O?} De las funciones `PyArg_Parse'. El formato ya no se usa y nunca se había documentado (bpo-8837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8837}).
@end itemize

Hubo una serie de otros pequeños cambios en la C-API. Consulte el archivo Misc/NEWS@footnote{https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS} para obtener una lista completa.

Also, there were a number of updates to the Mac OS X build, see
Mac/BuildScript/README.txt@footnote{https://github.com/python/cpython/blob/v3.2.6/Mac/BuildScript/README.txt}
for details.  For users running a 32/64-bit
build, there is a known problem with the default Tcl/Tk on Mac OS X 10.6.
Accordingly, we recommend installing an updated alternative such as
ActiveState Tcl/Tk 8.5.9@footnote{https://web.archive.org/web/20101208191259/https://www.activestate.com/activetcl/downloads}.
See @indicateurl{https://www.python.org/download/mac/tcltk/} for additional details.

@node Portar a Python 3 2,,Cambios en la API de construcción y C,Qué hay de nuevo en Python 3 2
@anchor{whatsnew/3 2 porting-to-python-3-2}@anchor{12d8}
@subsection Portar a Python 3.2


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código:


@itemize *

@item 
The @ref{23,,configparser} module has a number of clean-ups.  The major change is
to replace the old @code{ConfigParser} class with long-standing preferred
alternative @code{SafeConfigParser}.  In addition there are a number of
smaller incompatibilities:


@itemize *

@item 
La sintaxis de interpolación ahora está validada en las operaciones @ref{12d9,,get()} y @ref{12da,,set()}. En el esquema de interpolación predeterminado, solo dos tokens con signos de porcentaje son válidos: @code{%(name)s} y @code{%%}, siendo este último un signo de porcentaje de escape.

@item 
Los métodos @ref{12da,,set()} y @ref{12db,,add_section()}  ahora verifican que los valores sean cadenas reales. Anteriormente, los tipos no admitidos podían introducirse involuntariamente.

@item 
Las secciones u opciones duplicadas de una sola fuente ahora generan @ref{12dc,,DuplicateSectionError} o @ref{12dd,,DuplicateOptionError}. Anteriormente, los duplicados sobrescribían silenciosamente una entrada anterior.

@item 
Los comentarios en línea ahora están deshabilitados de forma predeterminada, por lo que ahora el carácter `;' se puede usar de forma segura en los valores.

@item 
Los comentarios ahora se pueden sangrar. En consecuencia, para que `;' o `#' aparezcan al principio de una línea en valores multilínea, debe interpolarse. Esto evita que los caracteres de prefijo de comentario en valores se confundan con comentarios.

@item 
@code{""} ahora es un valor válido y ya no se convierte automáticamente en una cadena vacía. Para cadenas vacías, use @code{"option ="} en una línea.
@end itemize

@item 
The @code{nntplib} module was reworked extensively, meaning that its APIs
are often incompatible with the 3.1 APIs.

@item 
@ref{5e0,,bytearray} ya no se pueden usar como nombres de archivo; en su lugar, deben convertirse a @ref{325,,bytes}.

@item 
The @code{array.tostring()} and @code{array.fromstring()} have been renamed to
@ref{12de,,array.tobytes()} and
@ref{12df,,array.frombytes()} for clarity.  The old names
have been deprecated. (See bpo-8990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8990}.)

@item 
Funciones @code{PyArg_Parse*()}:


@itemize *

@item 
Se ha eliminado el formato «t#»: utilice «s#» o «s*» en su lugar

@item 
Se han eliminado los formatos «w» y «w #»: utilice «w*» en su lugar
@end itemize

@item 
The @code{PyCObject} type, deprecated in 3.1, has been removed.  To wrap
opaque C pointers in Python objects, the @ref{12e0,,PyCapsule} API should be used
instead; the new type has a well-defined interface for passing typing safety
information and a less complicated signature for calling a destructor.

@item 
The @code{sys.setfilesystemencoding()} function was removed because
it had a flawed design.

@item 
La función y el método @ref{12e1,,random.seed()} ahora saltan semillas de cadenas con una función hash sha512. Para acceder a la versión anterior de `seed' para reproducir secuencias de Python 3.1, establezca el argumento `version' en `1', @code{random.seed(s, version=1)}.

@item 
The previously deprecated @code{string.maketrans()} function has been removed
in favor of the static methods @ref{12e2,,bytes.maketrans()} and
@ref{12e3,,bytearray.maketrans()}.  This change solves the confusion around which
types were supported by the @ref{d3,,string} module.  Now, @ref{237,,str},
@ref{325,,bytes}, and @ref{5e0,,bytearray} each have their own `maketrans' and
`translate' methods with intermediate translation tables of the appropriate
type.

(Contribución de Georg Brandl; bpo-5675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5675}.)

@item 
The previously deprecated @code{contextlib.nested()} function has been removed
in favor of a plain @ref{673,,with} statement which can accept multiple
context managers.  The latter technique is faster (because it is built-in),
and it does a better job finalizing multiple context managers when one of them
raises an exception:

@example
with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
    for line in infile:
        if '<critical>' in line:
            outfile.write(line)
@end example

(Contribución de Georg Brandl y Mattias Brändström; appspot issue 53094@footnote{https://codereview.appspot.com/53094}.)

@item 
@ref{12e4,,struct.pack()} ahora permite bytes para el código del paquete de cadenas @code{s}. Anteriormente, aceptaba argumentos de texto y los codificaba implícitamente en bytes usando UTF-8. Esto era problemático porque hacía suposiciones sobre la codificación correcta y porque una codificación de longitud variable puede fallar al escribir en un segmento de longitud fija de una estructura.

El código como @code{struct.pack('<6sHHBBB', 'GIF87a', x, y)} debe reescribirse para usar bytes en lugar de texto, @code{struct.pack('<6sHHBBB', b'GIF87a', x, y)}.

(Descubierto por David Beazley y corregido por Victor Stinner; bpo-10783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10783}.)

@item 
La clase @ref{125,,xml.etree.ElementTree} ahora genera un @ref{12e5,,xml.etree.ElementTree.ParseError} cuando falla un análisis. Anteriormente generaba un @ref{12e6,,xml.parsers.expat.ExpatError}.

@item 
El nuevo valor más largo de @ref{237,,str()} en flotantes puede romper las pruebas de documentación que se basan en el formato de salida anterior.

@item 
En @ref{301,,subprocess.Popen}, el valor predeterminado para `close_fds' es ahora @code{True} en Unix; en Windows, es @code{True} si los tres flujos estándar están configurados como @code{None}, o @code{False} en caso contrario. Anteriormente, `close_fds' siempre era @code{False} de forma predeterminada, lo que producía errores difíciles de resolver o condiciones de carrera cuando los descriptores de archivos abiertos se filtraban en el proceso hijo.

@item 
Se ha eliminado la compatibilidad con HTTP 0.9 heredado de @ref{10b,,urllib.request} y @ref{6f,,http.client}. Dicho soporte todavía está presente en el lado del servidor (en @ref{72,,http.server}).

(Contribución de Antoine Pitrou, bpo-10711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10711}.)

@item 
Los sockets SSL en modo de tiempo de espera ahora generan @ref{8cb,,socket.timeout} cuando ocurre un tiempo de espera, en lugar de un genérico @ref{12e7,,SSLError}.

(Contribución de Antoine Pitrou, bpo-10272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10272}.)

@item 
The misleading functions @code{PyEval_AcquireLock()} and
@code{PyEval_ReleaseLock()} have been officially deprecated.  The
thread-state aware APIs (such as @ref{49b,,PyEval_SaveThread()}
and @ref{49c,,PyEval_RestoreThread()}) should be used instead.

@item 
Due to security risks, @code{asyncore.handle_accept()} has been deprecated, and
a new function, @code{asyncore.handle_accepted()}, was added to replace it.

(Contribución de Giampaolo Rodola en bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706}.)

@item 
Due to the new @ref{2c5,,GIL} implementation, @code{PyEval_InitThreads()}
cannot be called before @ref{247,,Py_Initialize()} anymore.
@end itemize

@node Qué hay de nuevo en Python 3 1,Qué hay de nuevo en Python 3 0,Qué hay de nuevo en Python 3 2,Qué hay de nuevo en Python
@anchor{whatsnew/3 1 doc}@anchor{12e8}@anchor{whatsnew/3 1 what-s-new-in-python-3-1}@anchor{12e9}
@section Qué hay de nuevo en Python 3.1


@*Autor: 
Raymond Hettinger


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c % Patch 12345
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.

Este artículo explica las nuevas características de Python 3.1, en comparación con 3.0. Python 3.1 se lanzó el 27 de junio de 2009.

@menu
* PEP 372; Diccionarios ordenados: PEP 372 Diccionarios ordenados. 
* PEP 378; Especificador de formato para el separador de miles: PEP 378 Especificador de formato para el separador de miles. 
* Otros cambios del lenguaje: Otros cambios del lenguaje<2>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<2>. 
* Optimizaciones: Optimizaciones<10>. 
* IDLE: IDLE<2>. 
* Cambios en la compilación y la API de C: Cambios en la compilación y la API de C<3>. 
* Portando a Python 3.1: Portando a Python 3 1. 

@end menu

@node PEP 372 Diccionarios ordenados,PEP 378 Especificador de formato para el separador de miles,,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 pep-372-ordered-dictionaries}@anchor{12ea}
@subsection PEP 372: Diccionarios ordenados


Los diccionarios de Python normales iteran sobre los pares clave/valor en orden arbitrario. A través de los años, varios autores han escrito implementaciones alternativas que recuerdan el orden en el que se insertaron originalmente las claves. Basándose en las experiencias de esas implementaciones, una nueva clase @ref{67c,,collections.OrderedDict} ha sido introducida.

La API de OrderedDict es sustancialmente la misma que la de los diccionarios normales, pero iterará sobre las claves y los valores en un orden garantizado, dependiendo de cuándo se insertó una clave por primera vez.  Si una nueva entrada sobrescribe una entrada existente, la posición de inserción original se deja sin cambios.  Eliminar una entrada y volver a insertarla la moverá hasta el final.

La biblioteca estándar ahora admite el uso de diccionarios ordenados en varios módulos. El módulo @ref{23,,configparser} los usa por defecto. Esto permite leer, modificar y volver a escribir los archivos de configuración en su orden original. El método `_asdict()' para @ref{32d,,collections.namedtuple()} ahora devuelve un diccionario ordenado con los valores que aparecen en el mismo orden que los índices de tupla subyacentes. El módulo @ref{82,,json} se está construyendo con un `object_pairs_hook' para permitir que el decodificador construya OrderedDicts. También se agregó soporte para herramientas de terceros como PyYAML@footnote{https://pyyaml.org/}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - Diccionarios ordenados

PEP escrito por Armin Ronacher y Raymond Hettinger.  Implementación escrita por Raymond Hettinger.
@end table


Since an ordered dictionary remembers its insertion order, it can be used
in conjunction with sorting to make a sorted dictionary:

@example
>>> # regular unsorted dictionary
>>> d = @{'banana': 3, 'apple':4, 'pear': 1, 'orange': 2@}

>>> # dictionary sorted by key
>>> OrderedDict(sorted(d.items(), key=lambda t: t[0]))
OrderedDict([('apple', 4), ('banana', 3), ('orange', 2), ('pear', 1)])

>>> # dictionary sorted by value
>>> OrderedDict(sorted(d.items(), key=lambda t: t[1]))
OrderedDict([('pear', 1), ('orange', 2), ('banana', 3), ('apple', 4)])

>>> # dictionary sorted by length of the key string
>>> OrderedDict(sorted(d.items(), key=lambda t: len(t[0])))
OrderedDict([('pear', 1), ('apple', 4), ('orange', 2), ('banana', 3)])
@end example

The new sorted dictionaries maintain their sort order when entries
are deleted.  But when new keys are added, the keys are appended
to the end and the sort is not maintained.

@node PEP 378 Especificador de formato para el separador de miles,Otros cambios del lenguaje<2>,PEP 372 Diccionarios ordenados,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 pep-378-format-specifier-for-thousands-separator}@anchor{12eb}
@subsection PEP 378: Especificador de formato para el separador de miles


La función incorporada @ref{6c0,,format()} y el método @ref{6c2,,str.format()} usan un mini-lenguaje que ahora incluye una forma simple, que no tiene en cuenta la configuración regional, de formatear un número con un separador de miles. Eso proporciona una manera de humanizar la salida de un programa, mejorando su apariencia profesional y legibilidad:

@example
>>> format(1234567, ',d')
'1,234,567'
>>> format(1234567.89, ',.2f')
'1,234,567.89'
>>> format(12345.6 + 8901234.12j, ',f')
'12,345.600000+8,901,234.120000j'
>>> format(Decimal('1234567.89'), ',f')
'1,234,567.89'
@end example

Los tipos soportados son @ref{1f0,,int}, @ref{153,,float}, @ref{154,,complex} y @ref{16a,,decimal.Decimal}.

Se está discutiendo cómo especificar separadores alternativos como puntos, espacios, apóstrofos o guiones bajos. Las aplicaciones que reconocen la configuración regional deben usar el especificador de formato `n' existente, que ya es compatible con el separadores de miles.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - Especificador de formato para el separador de miles

PEP escrito por Raymond Hettinger e implementado por Eric Smith y Mark Dickinson.
@end table


@node Otros cambios del lenguaje<2>,Módulos nuevos mejorados y obsoletos<2>,PEP 378 Especificador de formato para el separador de miles,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 other-language-changes}@anchor{12ec}
@subsection Otros cambios del lenguaje


Algunos cambios pequeños en el núcleo del lenguaje Python son:


@itemize *

@item 
Los directorios y archivos zip que contienen un archivo @code{__main__.py} pueden ahora ser ejecutados directamente pasando su nombre al intérprete. El directorio/archivo zip es automáticamente insertado como la primera entrada en sys.path.  (Sugerencia y parche inicial por Andy Chu; parche revisado por Phillip J. Eby y Nick Coghlan; bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}.)

@item 
El tipo @ref{1f0,,int()} ganó un método @code{bit_length} que retorna el número de bits necesarios para representar sus argumentos en binario:

@example
>>> n = 37
>>> bin(37)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124
@end example

(Contribución de Fredrik Johansson, Victor Stinner, Raymond Hettinger y Mark Dickinson; bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439}.)

@item 
Los campos en las cadenas de formato de @ref{6c0,,format()} ahora pueden ser automáticamente numerados:

@example
>>> 'Sir @{@} of @{@}'.format('Gallahad', 'Camelot')
'Sir Gallahad of Camelot'
@end example

Anteriormente, la cadena requería campos numerados como: @code{'Sir @{0@} of @{1@}'}.

(Contribución de Eric Smith; bpo-5237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5237}.)

@item 
The @code{string.maketrans()} function is deprecated and is replaced by new
static methods, @ref{12e2,,bytes.maketrans()} and @ref{12e3,,bytearray.maketrans()}.
This change solves the confusion around which types were supported by the
@ref{d3,,string} module. Now, @ref{237,,str}, @ref{325,,bytes}, and
@ref{5e0,,bytearray} each have their own `maketrans' and `translate'
methods with intermediate translation tables of the appropriate type.

(Contribución de Georg Brandl; bpo-5675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5675}.)

@item 
La sintaxis de la sentencia @ref{673,,with} ahora permite múltiples gestores de contexto en una sola declaración:

@example
>>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
...     for line in infile:
...         if '<critical>' in line:
...             outfile.write(line)
@end example

With the new syntax, the @code{contextlib.nested()} function is no longer
needed and is now deprecated.

(Contribución de Georg Brandl y Mattias Brändström; appspot issue 53094@footnote{https://codereview.appspot.com/53094}.)

@item 
@code{round(x, n)} ahora retorna un número entero si `x' es un entero. Anteriormente retornaba un número flotante:

@example
>>> round(1123, -2)
1100
@end example

(Contribución de Mark Dickinson; bpo-4707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4707}.)

@item 
Python now uses David Gay’s algorithm for finding the shortest floating-point
representation that doesn’t change its value.  This should help
mitigate some of the confusion surrounding binary floating-point
numbers.

The significance is easily seen with a number like @code{1.1} which does not
have an exact equivalent in binary floating point.  Since there is no exact
equivalent, an expression like @code{float('1.1')} evaluates to the nearest
representable value which is @code{0x1.199999999999ap+0} in hex or
@code{1.100000000000000088817841970012523233890533447265625} in decimal. That
nearest value was and still is used in subsequent floating-point
calculations.

What is new is how the number gets displayed.  Formerly, Python used a
simple approach.  The value of @code{repr(1.1)} was computed as @code{format(1.1,
'.17g')} which evaluated to @code{'1.1000000000000001'}. The advantage of
using 17 digits was that it relied on IEEE-754 guarantees to assure that
@code{eval(repr(1.1))} would round-trip exactly to its original value.  The
disadvantage is that many people found the output to be confusing (mistaking
intrinsic limitations of binary floating-point representation as being a
problem with Python itself).

El nuevo algoritmo para @code{repr(1.1)} es más inteligente y retorna @code{'1.1'}. Efectivamente, busca todas las representaciones de cadenas equivalentes (las que se almacenan con el mismo valor flotante subyacente) y retorna la representación más corta.

El nuevo algoritmo tiende a emitir representaciones más limpias cuando es posible, pero esto no cambia los valores subyacentes.  Por lo tanto, todavía se da el caso @code{1.1 + 2.2 != 3.3}, aún cuando las representaciones puedan sugerir lo contrario.

The new algorithm depends on certain features in the underlying floating-point
implementation.  If the required features are not found, the old
algorithm will continue to be used.  Also, the text pickle protocols
assure cross-platform portability by using the old algorithm.

(Contribución de Eric Smith y Mark Dickinson; bpo-1580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1580})
@end itemize

@node Módulos nuevos mejorados y obsoletos<2>,Optimizaciones<10>,Otros cambios del lenguaje<2>,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 new-improved-and-deprecated-modules}@anchor{12ed}
@subsection Módulos nuevos, mejorados y obsoletos



@itemize *

@item 
Se ha añadido una clase @ref{110e,,collections.Counter} para admitir el recuento conveniente de elementos únicos en una secuencia o una iteración:

@example
>>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
Counter(@{'blue': 3, 'red': 2, 'green': 1@})
@end example

(Contribución de Raymond Hettinger; bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199}.)

@item 
Se ha añadido un nuevo módulo @ref{f9,,tkinter.ttk} para acceder al conjunto de widgets temáticos de Tk. La idea básica de ttk es separar, dentro de lo posible, el código que implementa el comportamiento de un widget del código que implementa su apariencia.

(Contribución de Guilherme Polo; bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983}.)

@item 
Las clases @ref{4d8,,gzip.GzipFile} y @ref{8fd,,bz2.BZ2File} ahora admiten el protocolo de gestión de contexto:

@example
>>> # Automatically close file after writing
>>> with gzip.GzipFile(filename, "wb") as f:
...     f.write(b"xxx")
@end example

(Contribución de Antoine Pitrou.)

@item 
El módulo @ref{37,,decimal} ahora admite métodos para crear un objeto decimal de un @ref{153,,float} binario.  La conversión es exacta pero puede ser a veces una sorpresa:

@example
>>> Decimal.from_float(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
@end example

El resultado decimal largo muestra la fracción binaria real que se almacena para `1.1'. La fracción tiene muchos dígitos porque `1.1' no se puede representar exactamente en binario.

(Contribución de Raymond Hettinger y Mark Dickinson.)

@item 
El módulo @ref{81,,itertools} desarrolló dos nuevas funciones.  La función @ref{12ee,,itertools.combinations_with_replacement()} es una de las cuatro para generar combinatorias que incluyen permutaciones y productos cartesianos.  La función @ref{12ef,,itertools.compress()} imita su homónimo de APL.  Además, la función existente @ref{12f0,,itertools.count()} tiene ahora un argumento `step' opcional y puede aceptar cualquier tipo de secuencia de conteo, incluyendo @ref{177,,fractions.Fraction} y @ref{16a,,decimal.Decimal}:

@example
>>> [p+q for p,q in combinations_with_replacement('LOVE', 2)]
['LL', 'LO', 'LV', 'LE', 'OO', 'OV', 'OE', 'VV', 'VE', 'EE']

>>> list(compress(data=range(10), selectors=[0,0,1,1,0,1,0,1,0,0]))
[2, 3, 5, 7]

>>> c = count(start=Fraction(1,2), step=Fraction(1,6))
>>> [next(c), next(c), next(c), next(c)]
[Fraction(1, 2), Fraction(2, 3), Fraction(5, 6), Fraction(1, 1)]
@end example

(Contribución de Raymond Hettinger.)

@item 
@ref{32d,,collections.namedtuple()} ahora admite un argumento de palabra clave `rename' que permite que los campos de nombre inválidos se conviertan automáticamente en nombres posicionados de la forma _0, _1, etc.  Esto es de utilidad cuando los nombres del campo están siendo creados por una fuente externa como un encabezado CSV, una lista de campos SQL, o la entrada del usuario:

@example
>>> query = input()
SELECT region, dept, count(*) FROM main GROUPBY region, dept

>>> cursor.execute(query)
>>> query_fields = [desc[0] for desc in cursor.description]
>>> UserQuery = namedtuple('UserQuery', query_fields, rename=True)
>>> pprint.pprint([UserQuery(*row) for row in cursor])
[UserQuery(region='South', dept='Shipping', _2=185),
 UserQuery(region='North', dept='Accounting', _2=37),
 UserQuery(region='West', dept='Sales', _2=419)]
@end example

(Contribución de Raymond Hettinger; bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818}.)

@item 
Las funciones @ref{3f2,,re.sub()}, @ref{3f3,,re.subn()} y @ref{3f1,,re.split()} ahora admiten un parámetro `flags'.

(Contribución de Gregory Smith.)

@item 
El módulo @ref{87,,logging} ahora implementa una clase simple @ref{12f1,,logging.NullHandler} para aplicaciones que no utilizan el registro pero llaman al código de una biblioteca que si lo hace.  La configuración de un controlador nulo suprimirá las advertencias falsas como «No handlers could be found for logger foo»:

@example
>>> h = logging.NullHandler()
>>> logging.getLogger("foo").addHandler(h)
@end example

(Contribución de Vinay Sajip; bpo-4384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4384}).

@item 
El módulo @ref{be,,runpy} que admite el modificador de línea de comando @code{-m} ahora admite la ejecución de paquetes al buscar y ejecutar un submódulo @code{__main__} cuando se proporciona un nombre de paquete.

(Contribución de Andi Vajda; bpo-4195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4195}.)

@item 
El módulo @ref{a5,,pdb} puede ahora acceder y mostrar el código fuente cargado a través de @ref{131,,zipimport} (o cualquier otro cargador conforme 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}).

(Contribución de Alexander Belopolsky; bpo-4201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4201}.)

@item 
Los objetos @ref{17a,,functools.partial} pueden ser ahora serializados (`pickled').
@end itemize

@quotation

(Sugerido por Antoine Pitrou y Jesse Noller.  Implementado por Jack Diederich; bpo-5228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5228}.)
@end quotation


@itemize *

@item 
Se agrega temas de ayuda @ref{b5,,pydoc} para símbolos de modo que @code{help('@@')} funcione como se espera en un entorno interactivo.

(Contribución de David Laban; bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739}.)

@item 
El módulo @ref{106,,unittest} ahora admite saltear pruebas individuales o clases de pruebas. Y admite marcar una prueba como una falla esperada, una prueba que se sabe que está rota, pero que no debe contarse como una falla en un TestResult:

@example
class TestGizmo(unittest.TestCase):

    @@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    def test_gizmo_on_windows(self):
        ...

    @@unittest.expectedFailure
    def test_gimzo_without_required_library(self):
        ...
@end example

Además, se han creado pruebas de excepciones para trabajar con gestores de contexto usando la declaración @ref{673,,with}:

@example
def test_division_by_zero(self):
    with self.assertRaises(ZeroDivisionError):
        x / 0
@end example

In addition, several new assertion methods were added including
@ref{12f2,,assertSetEqual()},
@ref{12f3,,assertDictEqual()},
@code{assertDictContainsSubset()},
@ref{12f4,,assertListEqual()},
@ref{12f5,,assertTupleEqual()},
@ref{12f6,,assertSequenceEqual()},
@ref{5d2,,assertRaisesRegexp()},
@ref{12f7,,assertIsNone()},
and @ref{12f8,,assertIsNotNone()}.

(Contribución de Benjamin Peterson y Antoine Pitrou.)

@item 
The @ref{7f,,io} module has three new constants for the @ref{12f9,,seek()}
method: @ref{12fa,,SEEK_SET}, @ref{12fb,,SEEK_CUR}, and @ref{12fc,,SEEK_END}.

@item 
The @ref{741,,sys.version_info} tuple is now a named tuple:

@example
>>> sys.version_info
sys.version_info(major=3, minor=1, micro=0, releaselevel='alpha', serial=2)
@end example

(Contribución de Ross Light; bpo-4285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4285}.)

@item 
The @code{nntplib} and @ref{74,,imaplib} modules now support IPv6.

(Contribución de Derek Morr; bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655} y bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664}.)

@item 
El módulo @ref{a6,,pickle} ha sido adaptado para una mejor interoperabilidad con 2.x cuando es usado con un protocolo 2 o menor.  La reorganización de la biblioteca estándar cambió la referencia formal para varios objetos.  Por ejemplo, @code{__builtin__.set} en Python 2 es llamado @code{builtins.set} en Python 3. Este cambio confundió los esfuerzos de compartir datos entre diferentes versiones de Python.  Pero ahora cuando el protocolo 2 o menor es seleccionado, el pickler va a usar automáticamente los nombres antiguos de Python 2 tanto para carga como para volcado. Esta reasignación es activada de manera predeterminada pero puede ser desactivada con la opción `fix_imports':

@example
>>> s = @{1, 2, 3@}
>>> pickle.dumps(s, protocol=0)
b'c__builtin__\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
>>> pickle.dumps(s, protocol=0, fix_imports=False)
b'cbuiltins\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
@end example

Un efecto secundario, desafortunado pero inevitable, de este cambio es que los pickles del protocolo 2 producidos con Python 3.1 no serán legibles con Python 3.0. El protocolo de pickle más reciente, protocolo 3, debe utilizarse al migrar datos entre implementaciones de Python 3.x, ya que no intenta seguir siendo compatible con Python 2.x.

(Contribución de Alexandre Vassalotti y Antoine Pitrou, bpo-6137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6137}.)

@item 
Se agregó un nuevo módulo, @ref{77,,importlib}. Proporciona una implementación de referencia de Python completa, portátil y pura de la instrucción @ref{682,,import} y su contraparte, la función  @ref{96b,,__import__()} . Representa un avance sustancial en la documentación y definición de las acciones que tienen lugar durante las importaciones.

(Contribución de Brett Cannon.)
@end itemize

@node Optimizaciones<10>,IDLE<2>,Módulos nuevos mejorados y obsoletos<2>,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 optimizations}@anchor{12fd}
@subsection Optimizaciones


Se han agregado importantes mejoras de rendimiento:


@itemize *

@item 
La nueva biblioteca I/O (definida en 
@geindex Python Enhancement Proposals; PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/}) estaba escrita mayormente en Python y rápidamente demostró ser un cuello de botella problemático en Python 3.0. En Python 3.1, la biblioteca I/O ha sido reescrita enteramente en C y es de 2 a 20 veces más rápida dependiendo en la tarea a manejar. La versión puramente en Python está aún disponible para fines experimentales a través del módulo @code{_pyio}.

(Contribución de Amaury Forgeot d’Arc y Antoine Pitrou.)

@item 
Se ha añadido una heurística para que el recolector de basura no realice el seguimiento de tuplas y diccionarios que contengan solo objetos no rastreables. Esto puede reducir el tamaño de las colecciones y, por lo tanto, la sobrecarga de recolección de elementos no utilizados en programas de larga ejecución, en función de su uso particular de los tipos de datos.

(Contribución de Antoine Pitrou, bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}.)

@item 
Habilitando una opción de configuración llamada @code{--with-computed-gotos} en compiladores que la admiten (en particular: gcc, SunPro, icc), el ciclo de evaluación del bytecode se compila con un nuevo mecanismo de despacho que proporciona aceleraciones de hasta un 20% , dependiendo del sistema, del compilador y del punto de referencia.

(Contribución de Antoine Pitrou junto con varios otros participantes, bpo-4753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4753}).

@item 
La decodificación de UTF-8, UTF-16 y LATIN-1 es ahora de dos a cuatro veces más rápida.

(Contribución de Antoine Pitrou y Amaury Forgeot d’Arc, bpo-4868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4868}.)

@item 
El módulo @ref{82,,json} ahora tiene una extensión C para mejorar sustancialmente su rendimiento. Además, se modificó la API para que json funcione solo con @ref{237,,str}, no con @ref{325,,bytes}. Ese cambio hace que el módulo coincida estrechamente con el JSON specification@footnote{https://json.org/} que se define en términos de Unicode.

(Contribución de Bob Ippolito y convertido a Py3.1 por Antoine Pitrou y Benjamin Peterson; bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136}.)

@item 
La deserialización (`unpickling') ahora interna los nombres de los atributos de los objetos serializados (`pickled'). Esto ahorra memoria y permite que los pickles sean más pequeños.

(Contribución de Jake McGuire y Antoine Pitrou; bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084}.)
@end itemize

@node IDLE<2>,Cambios en la compilación y la API de C<3>,Optimizaciones<10>,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 idle}@anchor{12fe}
@subsection IDLE



@itemize *

@item 
El menú de formato del IDLE ahora proporciona una opción para eliminar los espacios en blanco finales de un archivo de código fuente.

(Contribución de Roger D. Serwy; bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150}.)
@end itemize

@node Cambios en la compilación y la API de C<3>,Portando a Python 3 1,IDLE<2>,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 build-and-c-api-changes}@anchor{12ff}
@subsection Cambios en la compilación y la API de C


Los cambios en el proceso de compilación de Python y en la API C incluyen:


@itemize *

@item 
Los enteros ahora se almacenan internamente en base 2**15 o en base 2**30, la base se determina en el momento de la construcción. Anteriormente, siempre se almacenaban en base 2**15. El uso de base 2**30 ofrece mejoras significativas en el rendimiento en máquinas de 64 bits, pero los resultados de las pruebas comparativas en máquinas de 32 bits han sido diversos. Por lo tanto, el valor predeterminado es usar base 2**30 en máquinas de 64 bits y base 2**15 en máquinas de 32 bits; en Unix, hay una nueva opción de configuración @code{--enable-big-digits} que puede ser usada para sobre escribir este valor predeterminado.

Apart from the performance improvements this change should be invisible to
end users, with one exception: for testing and debugging purposes there’s a
new @ref{1300,,sys.int_info} that provides information about the
internal format, giving the number of bits per digit and the size in bytes
of the C type used to store each digit:

@example
>>> import sys
>>> sys.int_info
sys.int_info(bits_per_digit=30, sizeof_digit=4)
@end example

(Contribución de Mark Dickinson; bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258}.)

@item 
La función @ref{1301,,PyLong_AsUnsignedLongLong()} es ahora capaz de manejar un `pylong' negativo lanzando una excepción @ref{919,,OverflowError} en lugar de @ref{228,,TypeError}.

(Contribución de Mark Dickinson y Lisandro Dalcrin; bpo-5175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5175}.)

@item 
Deprecated @code{PyNumber_Int()}.  Use @ref{af7,,PyNumber_Long()} instead.

(Contribución de Mark Dickinson; bpo-4910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4910}.)

@item 
Added a new @ref{1302,,PyOS_string_to_double()} function to replace the
deprecated functions @code{PyOS_ascii_strtod()} and @code{PyOS_ascii_atof()}.

(Contribución de Mark Dickinson; bpo-5914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5914}.)

@item 
Added @ref{12e0,,PyCapsule} as a replacement for the @code{PyCObject} API.
The principal difference is that the new type has a well defined interface
for passing typing safety information and a less complicated signature
for calling a destructor.  The old type had a problematic API and is now
deprecated.

(Contribución de Larry Hastings; bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630}.)
@end itemize

@node Portando a Python 3 1,,Cambios en la compilación y la API de C<3>,Qué hay de nuevo en Python 3 1
@anchor{whatsnew/3 1 porting-to-python-3-1}@anchor{1303}
@subsection Portando a Python 3.1


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código:


@itemize *

@item 
The new floating-point string representations can break existing doctests.
For example:

@example
def e():
    '@w{'}'Compute the base of natural logarithms.

    >>> e()
    2.7182818284590451

    '@w{'}'
    return sum(1/math.factorial(x) for x in reversed(range(30)))

doctest.testmod()

**********************************************************************
Failed example:
    e()
Expected:
    2.7182818284590451
Got:
    2.718281828459045
**********************************************************************
@end example

@item 
La reasignación automática de nombres en el módulo pickle para el protocolo 2 o inferior puede hacer que los pickles de Python 3.1 sean ilegibles en Python 3.0.  Una solución es usar el protocolo 3.  Otra solución es establecer la opción `fix_imports' en @code{False}. Consulte la discusión anterior para obtener más detalles.
@end itemize

@node Qué hay de nuevo en Python 3 0,Qué hay de nuevo en Python 2 7,Qué hay de nuevo en Python 3 1,Qué hay de nuevo en Python
@anchor{whatsnew/3 0 doc}@anchor{1304}@anchor{whatsnew/3 0 what-s-new-in-python-3-0}@anchor{1305}
@section Qué hay de nuevo en Python 3.0


@c XXX Add trademark info for Apple, Microsoft.

@*Autor: 
Guido van Rossum


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.  (Note: I didn't get to this for 3.0.
@c GvR.)
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.  (Due to time
@c constraints I haven't managed to do this for 3.0.  GvR.)
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c % Patch 12345
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.  (Again, I didn't get to this for 3.0.
@c GvR.)

Este artículo explica las nuevas características de Python 3.0, en comparación con 2.6. Python 3.0, también conocido como «Python 3000» o «Py3K», es la primera versión `intentionally backwards incompatible' de Python. Python 3.0 se lanzó el 3 de diciembre de 2008. Hay más cambios que en una versión típica y más que son importantes para todos los usuarios de Python. Sin embargo, después de digerir los cambios, descubrirá que Python realmente no ha cambiado tanto; en general, estamos solucionando principalmente molestias y defectos conocidos, y eliminando una gran cantidad de viejas cosas.

Este artículo no intenta proporcionar una especificación completa de todas las características nuevas, sino que intenta proporcionar una visión general conveniente. Para obtener más información, se debe consultar la documentación de Python 3.0 y/o los muchos PEP a los que se hace referencia en el texto. Si se desea comprender la lógica completa de implementación y diseño para una característica determinada, los PEP suelen tener más detalles que la documentación regular, pero téngase en cuenta que los PEP generalmente no se mantienen actualizados una vez que una característica se ha implementado completamente.

Debido a restricciones de tiempo, este documento no es tan completo como debería haber sido. Como siempre para una nueva versión, el archivo @code{Misc/NEWS} en la distribución de origen contiene una gran cantidad de información detallada sobre cada pequeña cosa que se cambió.

@c Compare with previous release in 2 - 3 sentences here.

@c add hyperlink when the documentation becomes available online.

@c ======================================================================

@c Large, PEP-level features and changes should be described here.

@c Should there be a new section here for 3k migration?

@c Or perhaps a more general section describing module changes/deprecation?

@c sets module deprecated

@c ======================================================================

@menu
* Escollos comunes:: 
* Descripción general de los cambios de sintaxis:: 
* Cambios ya presentes en Python 2.6: Cambios ya presentes en Python 2 6. 
* Cambios de biblioteca:: 
* PEP 3101; Un nuevo enfoque al formateo de cadena de caracteres: PEP 3101 Un nuevo enfoque al formateo de cadena de caracteres. 
* Cambios a excepciones:: 
* Otros cambios diversos:: 
* Construcción y cambios a la API de C:: 
* Rendimiento:: 
* Migración a Python 3.0: Migración a Python 3 0. 

@end menu

@node Escollos comunes,Descripción general de los cambios de sintaxis,,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 common-stumbling-blocks}@anchor{1306}
@subsection Escollos comunes


Esta sección contiene esos pequeños cambios que probablemente generarán tropiezos si se está acostumbrado a Python 2.5.

@menu
* Print es una función:: 
* Vistas e iteradores en lugar de listas:: 
* Comparaciones de ordenamiento:: 
* Enteros:: 
* Texto vs. datos en lugar de unicode vs. 8 bits: Texto vs datos en lugar de unicode vs 8 bits. 

@end menu

@node Print es una función,Vistas e iteradores en lugar de listas,,Escollos comunes
@anchor{whatsnew/3 0 print-is-a-function}@anchor{1307}
@subsubsection `Print' es una función


La declaración @code{print} se ha sustituido por una función @ref{ff4,,print()}, con argumentos de palabra clave para reemplazar la mayor parte de la sintaxis especial de la antigua declaración @code{print} (
@geindex Python Enhancement Proposals; PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}). Ejemplos:

@example
Old: print "The answer is", 2*2
New: print("The answer is", 2*2)

Old: print x,           # Trailing comma suppresses newline
New: print(x, end=" ")  # Appends a space instead of a newline

Old: print              # Prints a newline
New: print()            # You must call the function!

Old: print >>sys.stderr, "fatal error"
New: print("fatal error", file=sys.stderr)

Old: print (x, y)       # prints repr((x, y))
New: print((x, y))      # Not the same as print(x, y)!
@end example

También se puede personalizar el separador entre ítems, por ejemplo:

@example
print("There are <", 2**32, "> possibilities!", sep="")
@end example

que genera:

@example
There are <4294967296> possibilities!
@end example

Nota:


@itemize *

@item 
La función @ref{ff4,,print()} no soporta la característica «softspace» de la declaración @code{print} vieja. Por ejemplo, en Python 2.x @code{print "A\n", "B"} escribiría @code{"A\nB\n"}; pero en Python 3.0, @code{print("A\n", "B")} escribe @code{"A\n B\n"}.

@item 
Inicialmente, te encontrarás escribiendo mucho la antigua @code{print x} en modo interactivo. ¡Es hora de volver a entrenar los dedos para escribir @code{print(x)} en su lugar!

@item 
En el uso de la herramienta de conversión fuente-a-fuente @code{2to3}, todos las declaraciones @code{print} son automáticamente convertidas a una llamada de la función @ref{ff4,,print()}, por lo que en general esto no es un problema para proyectos más grandes.
@end itemize

@node Vistas e iteradores en lugar de listas,Comparaciones de ordenamiento,Print es una función,Escollos comunes
@anchor{whatsnew/3 0 views-and-iterators-instead-of-lists}@anchor{1308}
@subsubsection Vistas e iteradores en lugar de listas


Algunas APIs bien conocidas no retornan más listas:


@itemize *

@item 
Los métodos @ref{190,,dict} @ref{866,,dict.keys()}, @ref{868,,dict.items()} y @ref{867,,dict.values()} retornan «vistas» en lugar de listas. Por ejemplo, esto no funciona más: @code{k = d.keys(); k.sort()}. Se usa @code{k = sorted(d)} en su lugar (esto funciona también en Python 2.5 y es igual de eficiente).

@item 
Además, los métodos @code{dict.iterkeys()}, @code{dict.iteritems()} y @code{dict.itervalues()} ya no son compatibles.

@item 
@ref{14c,,map()} y @ref{8fb,,filter()} retornan iteradores. Si realmente se necesita una lista y las secuencias de entrada son todas de igual longitud, una solución rápida es envolver @ref{14c,,map()} en @ref{18e,,list()}, por ejemplo @code{list(map(...))}, pero una mejor solución es a menudo utilizar una lista por comprensión (especialmente cuando el código original utiliza @ref{1309,,lambda}), o reescribir el código para que no necesite una lista en absoluto. Particularmente complicado es @ref{14c,,map()} invocado para los efectos secundarios de la función; la transformación correcta es usar un bucle @ref{1eb,,for} normal (ya que crear una lista sería simplemente un desperdicio).

Si las secuencias de entrada no tienen la misma longitud, @ref{14c,,map()} se detendrá en la terminación de la más corta de las secuencias. Para una compatibilidad completa con @ref{14c,,map()} de Python 2.x, también se envuelve las secuencias en @ref{130a,,itertools.zip_longest()}, por ejemplo @code{map(func, *sequences)} se convierte en @code{list(map(func, itertools.zip_longest(*sequences)))}.

@item 
@ref{9d6,,range()} ahora se comporta como @code{xrange()} solía comportarse, excepto que funciona con valores de tamaño arbitrario. Este último ya no existe.

@item 
@ref{14d,,zip()} ahora retorna un iterador.
@end itemize

@node Comparaciones de ordenamiento,Enteros,Vistas e iteradores en lugar de listas,Escollos comunes
@anchor{whatsnew/3 0 ordering-comparisons}@anchor{130b}
@subsubsection Comparaciones de ordenamiento


Python 3.0 ha simplificado las reglas para las comparaciones de ordenamiento:


@itemize *

@item 
Los operadores de comparaciones de ordenamiento (@code{<}, @code{<},`@w{`}”>`@w{`}, @code{>}) lanzan una excepción `TypeError' cuando los operandos no tienen un orden natural significativo. Por lo tanto, expresiones como @code{1 < '@w{'}}, @code{0 > None} o @code{len <= len} ya no son válidas, y por ejemplo @code{Ninguno < Ninguno} lanza @ref{228,,TypeError} en lugar de retornar @code{False}. Un corolario es que ordenar una lista heterogénea ya no tiene sentido – todos los elementos deben ser comparables entre sí. Tener en cuenta que esto no se aplica a los operadores @code{==} y @code{!=}: los objetos de diferentes tipos incomparables siempre se comparan desiguales entre sí.

@item 
@code{builtin.sorted()} y @ref{c57,,list.sort()} ya no aceptan el argumento `cmp' que proporciona una función de comparación. Utilice el argumento `key' en su lugar. N.B. los argumentos `key' y `reverse' ahora son «argumentos por palabra clave».

@item 
La función @code{cmp()} debe tratarse como quitada, y el método especial @code{__cmp__()} ya no es compatible. Utilizar @code{__lt__()} para el ordenamiento, @code{__eq__()} con @code{__hash__()}, y otras comparaciones costosas según sea necesario. (Si realmente se necesita la funcionalidad @code{cmp()}, se puede utilizar la expresión @code{(a > b) - (a < b)} como el equivalente para @code{cmp(a, b)}.)
@end itemize

@node Enteros,Texto vs datos en lugar de unicode vs 8 bits,Comparaciones de ordenamiento,Escollos comunes
@anchor{whatsnew/3 0 integers}@anchor{130c}
@subsubsection Enteros



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}: Esencialmente, @code{long} renombrado a @ref{1f0,,int}. Es decir, solo hay un tipo integral incorporado, denominado @ref{1f0,,int}; pero se comporta sobre todo como el viejo tipo @code{long}.

@item 
@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: Una expresión como @code{1/2} retorna un float. Utilizar @code{1//2} para obtener el comportamiento de truncamiento. (Esta última sintaxis ha existido durante años, al menos desde Python 2.2.)

@item 
Se eliminó la constante @code{sys.maxint}, ya que ya no hay un límite para el valor de los enteros. Sin embargo, @ref{1232,,sys.maxsize} se puede utilizar como un entero mayor que cualquier lista práctica o índice de cadena de caracteres. Se ajusta al tamaño entero «natural» de la implementación y suele ser el mismo que @code{sys.maxint} en versiones anteriores de la misma plataforma (suponiendo las mismas opciones de compilación).

@item 
El @ref{894,,repr()} de un entero largo ya no incluye la @code{L} final, por lo que el código que elimina incondicionalmente ese carácter cortará el último dígito en su lugar. (Utilizar @ref{237,,str()} en su lugar.)

@item 
Los literales octales ya no usan la forma @code{0720}; úsese @code{0o720} en su lugar.
@end itemize

@node Texto vs datos en lugar de unicode vs 8 bits,,Enteros,Escollos comunes
@anchor{whatsnew/3 0 text-vs-data-instead-of-unicode-vs-8-bit}@anchor{130d}
@subsubsection Texto vs. datos en lugar de unicode vs. 8 bits


Todo lo que pensabas saber sobre datos binarios y Unicode ha cambiado.


@itemize *

@item 
Python 3.0 utiliza los conceptos de `text' y `datos' (binarios) en lugar de cadenas de caracteres Unicode y cadenas de caracteres de 8 bits. Todo el texto es Unicode; sin embargo el Unicode `codificado' se representa como datos binarios. El tipo utilizado para contener texto es @ref{237,,str}, el tipo utilizado para contener datos es @ref{325,,bytes}. La mayor diferencia con la situación 2.x es que cualquier intento de mezclar texto y datos en Python 3.0 lanza un @ref{228,,TypeError}, mientras que si se mezclan cadenas Unicode y de 8 bits en Python 2.x, funcionaría si la cadena de 8 bits contuviera sólo bytes de 7 bits (ASCII), pero se obtendría un @ref{aa5,,UnicodeDecodeError} si contenía valores no ASCII. Este comportamiento específico del valor ha causado numerosas caras tristes a lo largo de los años.

@item 
Como consecuencia de este cambio en la filosofía, prácticamente todo el código que utiliza Unicode, codificaciones o datos binarios muy probablemente tiene que cambiar. El cambio es para mejor, ya que en el mundo 2.x había numerosos errores que tenían que ver con la mezcla de texto codificado y sin codificar. Para estar preparado en Python 2.x, comienza a usar @code{unicode} para todo el texto sin codificar, y @ref{237,,str} solo para datos binarios o codificados. Luego , la herramienta @code{2to3} hará la mayor parte del trabajo por ti.

@item 
Ya no se puede utilizar literales @code{u"..."} para texto Unicode. Sin embargo, se debe usar literales @code{b"..."} para los datos binarios.

@item 
Como los tipos @ref{237,,str} y @ref{325,,bytes} no se pueden mezclar, siempre se deben convertir explícitamente entre ellos. Utilizar @ref{96c,,str.encode()} para pasar de @ref{237,,str} a @ref{325,,bytes}, y @ref{96d,,bytes.decode()} para pasar de @ref{325,,bytes} a @ref{237,,str}. También se puede utilizar @code{bytes(s, encoding=...)} y @code{str(b, encoding=...)}, respectivamente.

@item 
Al igual que @ref{237,,str}, el tipo @ref{325,,bytes} es inmutable. Hay un tipo `mutable' independiente para contener datos binarios almacenados en búfer, @ref{5e0,,bytearray}. Casi todas las API que aceptan @ref{325,,bytes} también aceptan @ref{5e0,,bytearray}. La API mutable se basa en @code{collections. MutableSequence}.

@item 
Todas las barras invertidas en literales de cadena de caracteres sin formato se interpretan literalmente. Esto significa que los escapes @code{'\U'} y @code{'\u'} en cadenas de caracteres sin formato no se tratan especialmente. Por ejemplo, @code{r'\u20ac'} es una cadena de 6 caracteres en Python 3.0, mientras que en 2.6, @code{ur'\u20ac'} era el único carácter «euro». (Por supuesto, este cambio sólo afecta a los literales de cadena de caracteres sin formato; el carácter del euro es @code{'\u20ac'} en Python 3.0.)

@item 
Se eliminó el tipo abstracto @code{basestring} incorporado. Se utiliza @ref{237,,str} en su lugar. Los tipos @ref{237,,str} y @ref{325,,bytes} no tienen suficiente funcionalidad en común para garantizar una clase base compartida. La herramienta @code{2to3} (ver más abajo) reemplaza cada aparición de @code{basestring} por @ref{237,,str}.

@item 
Los archivos abiertos como archivos de texto (todavía el modo predeterminado para @ref{1be,,open()}) siempre utilizan una codificación para asignar entre cadenas de caracteres(en memoria) y bytes (en disco). Los archivos binarios (abiertos con una @code{b} en el argumento modo) siempre utilizan bytes en la memoria. Esto significa que si un archivo se abre utilizando un modo o codificación incorrectos, es probable que la E/S falle ruidosamente, en lugar de producir datos incorrectos de forma silenciosa. También significa que incluso los usuarios de Unix tendrán que especificar el modo correcto (texto o binario) al abrir un archivo. Hay una codificación predeterminada dependiente de la plataforma, que en las plataformas Unix se puede establecer con la variable de entorno @code{LANG} (y a veces también con algunas otras variables de entorno relacionadas con la configuración regional específicas de la plataforma). En muchos casos, pero no en todos, el valor predeterminado del sistema es UTF-8; nunca se debe contar con este valor predeterminado. Cualquier aplicación que lea o escriba más que texto ASCII puro probablemente debería tener una manera de invalidar la codificación. Ya no es necesario utilizar las secuencias compatibles con la codificación en el módulo @ref{1c,,codecs}.

@item 
Los valores iniciales de @ref{5df,,sys.stdin}, @ref{b61,,sys.stdout} y @ref{9cc,,sys.stderr} ahora son archivos de texto solo unicode (es decir, son instancias de @ref{736,,io.TextIOBase}). Para leer y escribir datos de bytes con estas secuencias, se debe usar su atributo @ref{130e,,io.TextIOBase.buffer}.

@item 
Los nombres de archivos son pasados y retornados de cadenas desde APIs como cadenas de caracteres (Unicode). Esto puede presentar problemas específicos de plataformas porque en algunas plataformas los nombres de archivos son cadenas de caracteres de bytes arbitrarios. (Por otro lado, en Windows los nombres de archivos son almacenados de forma nativa como Unicode.) Como solución alternativa, la mayoría de las APIs (por ejemplo @ref{1be,,open()} y muchas otras funciones en el módulo @ref{a1,,os}) que toman nombres de archivos aceptan tanto objetos @ref{325,,bytes} como cadenas de caracteres, y algunas APIs tienen una forma de demandar por un valor de retorno @ref{325,,bytes}. Por lo tanto, @ref{116c,,os.listdir()} retorna una lista de instancias @ref{325,,bytes} si el argumento es una instancia @ref{325,,bytes}, y @ref{b1c,,os.getcwdb()} retorna el directorio de trabajo actual como una instancia @ref{325,,bytes}. Tener en cuenta que cuando @ref{116c,,os.listdir()} retorna una lista de cadenas de caracteres, los nombres de archivo que no se pueden decodificar correctamente se omiten en lugar de lanzar @ref{130f,,UnicodeError}.

@item 
Algunas APIs del sistema como @ref{196,,os.environ} y @ref{12d2,,sys.argv} también pueden presentar problemas cuando los bytes puestos a disposición por el sistema no son interpretables usando la codificación predeterminada. Probablemente el mejor abordaje sea asignando la variable @code{LANG} y volviendo a ejecutar el programa.

@item 
@geindex Python Enhancement Proposals; PEP 3138
PEP 3138@footnote{https://peps.python.org/pep-3138/}: El @ref{894,,repr()} de una cadena de caracteres ya no escapa caracteres no ASCII. Sin embargo, todavía escapa caracteres de control caracteres y puntos de código con estado no imprimible en el estándar the Unicode.

@item 
@geindex Python Enhancement Proposals; PEP 3120
PEP 3120@footnote{https://peps.python.org/pep-3120/}: La codificación de fuente predeterminada ahora es UTF-8.

@item 
@geindex Python Enhancement Proposals; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}: Letras no ASCII ahora están permitidas en identificadores. (De todas maneras, la librería estándar permanece como sólo ASCII con la excepción de nombres de colaboradores en comentarios.)

@item 
The @code{StringIO} and @code{cStringIO} modules are gone.  Instead,
import the @ref{7f,,io} module and use @ref{fa9,,io.StringIO} or
@ref{f25,,io.BytesIO} for text and data respectively.

@item 
Ver también @ref{1310,,CÓMO (HOWTO) Unicode}, que fue actualizado para Python 3.0.
@end itemize

@node Descripción general de los cambios de sintaxis,Cambios ya presentes en Python 2 6,Escollos comunes,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 overview-of-syntax-changes}@anchor{1311}
@subsection Descripción general de los cambios de sintaxis


Esta sección brinda una descripción general breve de cada cambio `sintáctico' en Python 3.0.

@menu
* Nueva sintaxis:: 
* Sintaxis modificada:: 
* Sintaxis eliminada:: 

@end menu

@node Nueva sintaxis,Sintaxis modificada,,Descripción general de los cambios de sintaxis
@anchor{whatsnew/3 0 new-syntax}@anchor{1312}
@subsubsection Nueva sintaxis



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}: Function argument and return value annotations.  This
provides a standardized way of annotating a function’s parameters
and return value.  There are no semantics attached to such
annotations except that they can be introspected at runtime using
the @ref{e08,,__annotations__} attribute.  The intent is to
encourage experimentation through metaclasses, decorators or frameworks.

@item 
@geindex Python Enhancement Proposals; PEP 3102
PEP 3102@footnote{https://peps.python.org/pep-3102/}: Argumentos de sólo palabra clave. Los parámetros con nombre que se producen después de @code{*args} en la lista de parámetros `deben' especificarse mediante la sintaxis de palabra clave en la llamada. También puede usarse apenas un @code{*} sólo en la lista de parámetros para indicar que no se acepta una lista de argumentos de longitud variable, pero se tiene argumentos de sólo palabra clave.

@item 
Los argumentos de palabra clave se permiten después de la lista de clases base en una definición de clase. Esto lo usa la nueva convención para especificar una metaclase (consultar la sección siguiente), pero también se puede usar para otros fines, siempre y cuando la metaclase la admita.

@item 
@geindex Python Enhancement Proposals; PEP 3104
PEP 3104@footnote{https://peps.python.org/pep-3104/}: Declaración @ref{1313,,nonlocal}. Utilizando @code{nonlocal x} ahora se puede asignar directamente a una variable en un entorno externo (pero no global). @code{nonlocal} es una nueva palabra reservada.

@item 
@geindex Python Enhancement Proposals; PEP 3132
PEP 3132@footnote{https://peps.python.org/pep-3132/}: Desempaque iterable extendido. Ahora se puede escribir cosas como @code{a, b, *rest = some_sequence}. E incluso @code{*rest, a = cosas}. El objeto @code{rest} es siempre una lista (posiblemente vacía); el lado derecho puede ser cualquier iterable. Ejemplo:

@example
(a, *rest, b) = range(5)
@end example

Esto asigna `a' a @code{0}, `b' a @code{4}, y `rest' a @code{[1, 2, 3]}.

@item 
Comprensiones por diccionario: @code{@{k: v for k, v in cosas@}} significa lo mismo que @code{dict(cosas)}, pero es más flexible. (Esto es 
@geindex Python Enhancement Proposals; PEP 274
PEP 274@footnote{https://peps.python.org/pep-0274/} reivindicado. :-)

@item 
Asignar los literales, por ejemplo, @code{@{1, 2@}}. Tener en cuenta que @code{@{@}} es un diccionario vacío; utilizar @code{set()} para un conjunto vacío. También se admiten las comprensiones de conjunto; por ejemplo, @code{x for x in cosas} significa lo mismo que @code{set(cosas)}, pero es más flexible.

@item 
Nuevos octales literales, por ejemplo, @code{0o720} (ya en 2.6). Los octales literales viejos (@code{0720}) se eliminaron.

@item 
Nuevos literales binarios, por ejemplo, @code{0b1010} (ya en 2.6), y hay una nueva función incorporada correspondiente, @ref{1314,,bin()}.

@item 
Los literales de bytes se introducen con un @code{b} o @code{B} delantero, y hay una nueva función incorporada correspondiente, @ref{325,,bytes()}.
@end itemize

@node Sintaxis modificada,Sintaxis eliminada,Nueva sintaxis,Descripción general de los cambios de sintaxis
@anchor{whatsnew/3 0 changed-syntax}@anchor{1315}
@subsubsection Sintaxis modificada



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/} y 
@geindex Python Enhancement Proposals; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: Nueva sintaxis de la instrucción @ref{68d,,raise}: @code{raise [@var{expr} [from @var{expr}]]}. Ver a continuación.

@item 
@code{as} y @ref{673,,with} ahora son palabras reservadas. (Desde 2.6, de hecho.)

@item 
@code{True}, @code{False} y @code{None} son palabras reservadas. (2.6 parcialmente estableció restricciones ya en @code{None}.)

@item 
Cambio de @ref{2f6,,except} `exc', `var' a @code{except} `exc' @code{as} `var'.Ver 
@geindex Python Enhancement Proposals; PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}.

@item 
@geindex Python Enhancement Proposals; PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}: Nueva sintaxis de metaclase. En lugar de:

@example
class C:
    __metaclass__ = M
    ...
@end example

ahora se debe usar:

@example
class C(metaclass=M):
    ...
@end example

Ya no se admite la variable de módulo global @code{__metaclass__}. (Era una muleta para facilitar al valor predeterminado a las clases de estilo nuevo sin derivar todas las clases de @ref{b18,,object}.)

@item 
Las listas por comprensión ya no admiten la forma sintáctica @code{[... for @var{var} in @var{item1}, @var{item2}, ...]}. Utilizar @code{[... for@var{var} in (@var{item1}, @var{item2}, ...)]} en su lugar. También tener en cuenta que las listas por comprensión tienen semántica diferente: están más cerca del azúcar sintáctico para una expresión de generador dentro de un constructor @ref{18e,,list()} y, en particular, las variables de control de bucle ya no se filtran en el ámbito circundante.

@item 
La `elipsis' (@code{...}) puede ser utilizada como una expresión atómica en cualquier lugar. (Previamente sólo estaba permitida en segmentos.) Asimismo, esto ahora `debe' ser escrito como @code{...}. (Anteriormente, también podía ser escrito como @code{. . .}, por un mero accidente de la gramática.)
@end itemize

@node Sintaxis eliminada,,Sintaxis modificada,Descripción general de los cambios de sintaxis
@anchor{whatsnew/3 0 removed-syntax}@anchor{1316}
@subsubsection Sintaxis eliminada



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 3113
PEP 3113@footnote{https://peps.python.org/pep-3113/}: Desempaque de parámetros de tupla eliminados. Ya no se puede escribir @code{def foo(a, (b, c)): ...}. Utilizar @code{def foo(a, b_c): b, c = b_c} en su lugar.

@item 
Comillas invertidas eliminadas (usar @ref{894,,repr()} en su lugar).

@item 
Eliminados @code{<>} (usar @code{!=} en su lugar).

@item 
Palabra clave eliminada: @ref{2ea,,exec()} ya no es una palabra clave; continúa siendo una función. (Afortunadamente la sintaxis de la función también era aceptada en 2.x.) Asimismo, nótese que la @ref{2ea,,exec()} ya no toma un argumento de flujo; en lugar de @code{exec(f)} se puede utilizar @code{exec(f.read())}.

@item 
Literales enteros no admiten más @code{l} o @code{L} finales.

@item 
Literales de cadena de caracteres no admiten más @code{u} or @code{U} iniciales.

@item 
La sintaxis @ref{1317,,from} `module' @ref{682,,import} @code{*} solo se permite en el nivel de módulo, ya no dentro de las funciones.

@item 
La única sintaxis aceptable para `imports' relativos es @code{from .[@var{module}] import @var{name}}. Todos los formularios @ref{682,,import} que no comienzan con @code{.} son interpretados como `imports' absolutos

@item 
Se eliminaron las clases clásicas.
@end itemize

@node Cambios ya presentes en Python 2 6,Cambios de biblioteca,Descripción general de los cambios de sintaxis,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 changes-already-present-in-python-2-6}@anchor{1318}
@subsection Cambios ya presentes en Python 2.6


Dado que es de suponer que muchos usuarios saltan directamente de Python 2.5 a Python 3.0, esta sección recuerda al lector nuevas características que se diseñaron originalmente para Python 3.0 pero que fueron llevadas hacia atrás a Python 2.6. Las secciones correspondientes en @ref{1319,,Qué hay de nuevo en Python 2.6} deberían ser consultadas para descripciones más largas.


@itemize *

@item 
@ref{131a,,PEP 343; La sentencia “with”}.La declaración @ref{673,,with} ahora es una característica estándar y ya no necesita ser importada del @ref{0,,__future__}. También puede revisarse @ref{131b,,Escribiendo gestores de contexto} y @ref{131c,,El módulo contextlib}.

@item 
@ref{131d,,PEP 366; Importaciones relativas explícitas desde un módulo principal}. Esto mejora la utilidad de opción @ref{187,,-m} cuando el módulo al que se hace referencia vive en un paquete.

@item 
@ref{131e,,PEP 370; Directorio de site-packages por usuario}.

@item 
@ref{131f,,PEP 371; El paquete multiprocessing}.

@item 
@ref{1320,,PEP 3101; Formateo avanzado de cadena de caracteres}. Nota: la descripción 2.6 menciona el método @ref{6c0,,format()} tanto para cadenas de caracteres 8 bits como de Unicode. En 3.0, solo el tipo @ref{237,,str} (cadenas de texto con compatibilidad con Unicode) admite este método; el tipo @ref{325,,bytes} no. El plan es a la larga convertir esta en la única API para el formato de cadena de caracteres y comenzar a dejar de utilizar el operador @code{%} en Python 3.1.

@item 
@ref{1321,,PEP 3105; print como función}. Esta ahora es una característica estándar y ya no necesita ser importada de @ref{0,,__future__}. Más detalles fueron dados anteriormente.

@item 
@ref{1322,,PEP 3110; Cambios en el manejo de excepciones}. La sintaxis @ref{2f6,,except} `exc' @code{as} `var' ahora es estándar y @code{except} `exc', `var' ya no es compatible. (Por supuesto, la parte @code{as} `var' sigue siendo opcional.)

@item 
@ref{1323,,PEP 3112; Literales de bytes}. La notación literal de cadena de caracteres @code{b"..."} (y sus variantes como @code{b'...'}, @code{b"""..."""}, y @code{br"..."}) ahora genera un literal de tipo @ref{325,,bytes}.

@item 
@ref{1324,,PEP 3116; Nueva biblioteca de E/S}. El módulo @ref{7f,,io} ahora es la forma estándar de hacer E/S de archivos. La función incorporada @ref{1be,,open()} ahora es un alias para @ref{5c0,,io.open()} y tiene argumentos de palabra clave adicionales `encoding', `errors', `newline' y `closefd'. Tener en cuenta también que un argumento `mode' inválido ahora lanza @ref{360,,ValueError}, no @ref{10ce,,IOError}. Se puede acceder al objeto de archivo binario subyacente a un objeto de archivo de texto como @code{f.buffer} (pero tener en cuenta que el objeto de texto mantiene un búfer de sí mismo para acelerar las operaciones de codificación y descodificación).

@item 
@ref{1325,,PEP 3118; Protocolo revisado de la memoria intermedia}. El antiguo @code{buffer()} incorporado ahora realmente se ha eliminado; el @ref{156,,memoryview()} incorporado nuevo proporciona (mayormente) una funcionalidad similar.

@item 
@ref{1326,,PEP 3119; Clases base abstractas}. El módulo @ref{4,,abc} y los ABC definidos en el módulo @ref{1e,,collections} desempeñan un papel algo más destacado en el lenguaje ahora, y los tipos de colección incorporados como @ref{190,,dict} y @ref{18e,,list} se ajustan a los ABCs de @code{collections.MutableMapping} y @code{collections.MutableSequence}, respectivamente.

@item 
@ref{1327,,PEP 3127; Soporte y sintaxis de literales enteros}. Como se mencionó anteriormente, la nueva notación literal octal es la única admitida y se han agregado literales binarios.

@item 
@ref{1328,,PEP 3129; Decoradores de clase}.

@item 
@ref{1329,,PEP 3141; Una jerarquía de tipos para los números}. El módulo @ref{9e,,numbers} es otro uso nuevo de ABCs, definiendo la «torre numérica» de Python. También tener en cuenta el nuevo módulo @ref{5d,,fractions} que implementa @ref{132a,,numbers.Rational}.
@end itemize

@node Cambios de biblioteca,PEP 3101 Un nuevo enfoque al formateo de cadena de caracteres,Cambios ya presentes en Python 2 6,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 library-changes}@anchor{132b}
@subsection Cambios de biblioteca


Debido a las limitaciones de tiempo, este documento no cubre exhaustivamente los muy extensos cambios en la biblioteca estándar. 
@geindex Python Enhancement Proposals; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} es la referencia para los principales cambios en la biblioteca. Aquí hay una revisión de cápsula:


@itemize *

@item 
Many old modules were removed.  Some, like @code{gopherlib} (no
longer used) and @code{md5} (replaced by @ref{68,,hashlib}), were
already deprecated by 
@geindex Python Enhancement Proposals; PEP 4
PEP 4@footnote{https://peps.python.org/pep-0004/}.  Others were removed as a result
of the removal of support for various platforms such as Irix, BeOS
and Mac OS 9 (see 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}).  Some modules were also selected for
removal in Python 3.0 due to lack of use or because a better
replacement exists.  See 
@geindex Python Enhancement Proposals; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} for an exhaustive list.

@item 
The @code{bsddb3} package was removed because its presence in the
core standard library has proved over time to be a particular burden
for the core developers due to testing instability and Berkeley DB’s
release schedule.  However, the package is alive and well,
externally maintained at @indicateurl{https://www.jcea.es/programacion/pybsddb.htm}.

@item 
Algunos módulos fueron renombrados porque su antiguo nombre desobedeció 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, o por varias otras razones. Aquí está la lista:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre anterior

@tab

Nombre nuevo

@item

_winreg

@tab

winreg

@item

ConfigParser

@tab

configparser

@item

copy_reg

@tab

copyreg

@item

Queue

@tab

queue

@item

SocketServer

@tab

socketserver

@item

markupbase

@tab

_markupbase

@item

repr

@tab

reprlib

@item

test.test_support

@tab

test.support

@end multitable


@item 
A common pattern in Python 2.x is to have one version of a module
implemented in pure Python, with an optional accelerated version
implemented as a C extension; for example, @ref{a6,,pickle} and
@code{cPickle}.  This places the burden of importing the accelerated
version and falling back on the pure Python version on each user of
these modules.  In Python 3.0, the accelerated versions are
considered implementation details of the pure Python versions.
Users should always import the standard version, which attempts to
import the accelerated version and falls back to the pure Python
version.  The @ref{a6,,pickle} / @code{cPickle} pair received this
treatment.  The @ref{af,,profile} module is on the list for 3.1.  The
@code{StringIO} module has been turned into a class in the @ref{7f,,io}
module.

@item 
Algunos módulos relacionados se han agrupado en paquetes y, por lo general, los nombres de submódulo se han simplificado. Los nuevos paquetes resultantes son:


@itemize *

@item 
@ref{32,,dbm} (@code{anydbm}, @code{dbhash}, @code{dbm},
@code{dumbdbm}, @code{gdbm}, @code{whichdb}).

@item 
@ref{6b,,html} (@code{HTMLParser}, @code{htmlentitydefs}).

@item 
@ref{6e,,http} (@code{httplib}, @code{BaseHTTPServer},
@code{CGIHTTPServer}, @code{SimpleHTTPServer}, @code{Cookie},
@code{cookielib}).

@item 
@ref{f0,,tkinter} (todos los módulos relacionados con @code{Tkinter} excepto @ref{101,,turtle}). Al público objetivo de @ref{101,,turtle} no le interesa realmente @ref{f0,,tkinter}. También tener en cuenta que a partir de Python 2.6, la funcionalidad de @ref{101,,turtle} se ha mejorado considerablemente.

@item 
@ref{108,,urllib} (@code{urllib}, @code{urllib2}, @code{urlparse},
@code{robotparse}).

@item 
@code{xmlrpc} (@code{xmlrpclib}, @code{DocXMLRPCServer},
@code{SimpleXMLRPCServer}).
@end itemize
@end itemize

Algunos otros cambios a los módulos de la biblioteca estándar, no cubiertos por 
@geindex Python Enhancement Proposals; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/}:


@itemize *

@item 
Killed @code{sets}.  Use the built-in @ref{67a,,set()} class.

@item 
Limpiado el módulo @ref{d9,,sys}: quitado @code{sys.exitfunc()}, @code{sys.exc_clear()}, @code{sys.exc_type}, @code{sys.exc_value}, @code{sys.exc_traceback}. (Notar que @ref{566,,sys.last_type} etc. permanece.)

@item 
Limpiado del tipo @ref{308,,array.array}: los métodos @code{read()} y @code{write()} ya no están; usar @code{fromfile()} y @code{tofile()} en su lugar. Asimismo, the el código de tipo @code{'c'} para arreglo ya no está– utilizar o bien @code{'b'} para bytes o @code{'u'} para caracteres Unicode.

@item 
Limpieza del módulo @ref{9f,,operator}: quitados @code{sequenceIncludes()} y @code{isCallable()}.

@item 
Cleanup of the @code{thread} module: @code{acquire_lock()} and
@code{release_lock()} are gone; use @ref{739,,acquire()} and
@ref{132c,,release()} instead.

@item 
Limpieza del módulo @ref{b8,,random}: quitada la API @code{jumpahead()}.

@item 
The @code{new} module is gone.

@item 
Las funciones @code{os.tmpnam()}, @code{os.tempnam()} y @code{os.tmpfile()} se han eliminado en favor del módulo @ref{e0,,tempfile}.

@item 
El módulo @ref{fb,,tokenize} se ha cambiado para trabajar con bytes. El punto de entrada principal es ahora @ref{581,,tokenize.tokenize()}, en lugar de generate_tokens.

@item 
@code{string.letters} y sus amigos (@code{string.lowercase} y @code{string.uppercase}) se han ido. Utilice @ref{132d,,string.ascii_letters}, etc. en su lugar. (El motivo de la eliminación es que @code{string.letters} y sus amigos tenían un comportamiento específico de la configuración regional, lo cual es una mala idea para «constantes» globales con nombres tan atractivos).

@item 
Renombrado el módulo @code{__builtin__} a @ref{13,,builtins} (quitando los guiones bajos, agregando una “s”). La variable @code{__builtins__} encontrada en la mayoría de los espacios de nombres globales no tiene cambios. Para modificar un `builtin', Se debería usar @ref{13,,builtins}, no @code{__builtins__}!
@end itemize

@node PEP 3101 Un nuevo enfoque al formateo de cadena de caracteres,Cambios a excepciones,Cambios de biblioteca,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 pep-3101-a-new-approach-to-string-formatting}@anchor{132e}
@subsection 
@geindex Python Enhancement Proposals; PEP 3101
`PEP 3101': Un nuevo enfoque al formateo de cadena de caracteres



@itemize *

@item 
Un nuevo sistema para operaciones de formateo de cadenas de caracteres incorporadas reemplaza el operador de formato de cadena de caracteres @code{%}. (De todas maneras, el operador @code{%} sigue siento soportado; será obsoleto en Python 3.1 y quitado del lenguaje en algún momento más adelante.) Leer 
@geindex Python Enhancement Proposals; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/} para la primicia completa.
@end itemize

@node Cambios a excepciones,Otros cambios diversos,PEP 3101 Un nuevo enfoque al formateo de cadena de caracteres,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 changes-to-exceptions}@anchor{132f}
@subsection Cambios a excepciones


Las APIs para lanzar y capturar excepciones se limpiaron y se agregaron nuevas características poderosas:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 352
PEP 352@footnote{https://peps.python.org/pep-0352/}: Todas las excepciones deben derivarse (directa o indirectamente) de @ref{65c,,BaseException}. Esta es la raíz de la jerarquía de excepciones. Esto no es nuevo como recomendación, pero el `requisito' de heredar de @ref{65c,,BaseException} es nuevo. (Python 2.6 aún permitía que las clases clásicas se lanzaran, y no ponía ninguna restricción en lo que se podía capturar.) Como consecuencia, las excepciones de cadena de caracteres finalmente están verdaderamente y completamente muertas.

@item 
Casi todas las excepciones deberían de hecho derivarse de @ref{a6b,,Exception}; @ref{65c,,BaseException} sólo debe utilizarse como clase base para las excepciones que solo deben controlarse en el nivel superior, como @ref{dc7,,SystemExit} o @ref{a63,,KeyboardInterrupt}. El modismo recomendado para controlar todas las excepciones excepto esta última categoría es usar @ref{2f6,,except} @ref{a6b,,Exception}.

@item 
@code{StandardError} fue eliminado.

@item 
Las excepciones ya no se comportan como secuencias. Utilizar el atributo @code{args} en su lugar.

@item 
@geindex Python Enhancement Proposals; PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/}: Raising exceptions.  You must now use @code{raise
@var{Exception}(@var{args})} instead of @code{raise @var{Exception}, @var{args}}.
Additionally, you can no longer explicitly specify a traceback;
instead, if you `have' to do this, you can assign directly to the
@ref{1330,,__traceback__} attribute (see below).

@item 
@geindex Python Enhancement Proposals; PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}: Atrapando excepciones. Ahora se debe usar @code{except @var{AlgunaExcepcion} como @var{variable}} en lugar de @code{except @var{AlgunaExcepcion}, @var{variable}}. Además, la `variable' es específicamente eliminada cuando el bloque @ref{2f6,,except} se deja.

@item 
@geindex Python Enhancement Proposals; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: Exception chaining.  There are two cases: implicit
chaining and explicit chaining.  Implicit chaining happens when an
exception is raised in an @ref{2f6,,except} or @ref{a5c,,finally}
handler block.  This usually happens due to a bug in the handler
block; we call this a `secondary' exception.  In this case, the
original exception (that was being handled) is saved as the
@ref{1331,,__context__} attribute of the secondary exception.
Explicit chaining is invoked with this syntax:

@example
raise SecondaryException() from primary_exception
@end example

(where `primary_exception' is any expression that produces an
exception object, probably an exception that was previously caught).
In this case, the primary exception is stored on the
@ref{1332,,__cause__} attribute of the secondary exception.  The
traceback printed when an unhandled exception occurs walks the chain
of @code{__cause__} and @ref{1331,,__context__} attributes and
prints a
separate traceback for each component of the chain, with the primary
exception at the top.  (Java users may recognize this behavior.)

@item 
@geindex Python Enhancement Proposals; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: Exception objects now store their traceback as the
@ref{1330,,__traceback__} attribute.  This means that an exception
object now contains all the information pertaining to an exception,
and there are fewer reasons to use @ref{72b,,sys.exc_info()} (though the
latter is not removed).

@item 
Algunos mensajes de excepción se mejoraron cuando Windows falla al cargar un módulo de extensión. Por ejemplo, @code{error code 193} ahora es @code{%1 is not a valid Win32 application}. Las cadenas de caracteres ahora tratan con configuraciones regionales no inglesas.
@end itemize

@node Otros cambios diversos,Construcción y cambios a la API de C,Cambios a excepciones,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 miscellaneous-other-changes}@anchor{1333}
@subsection Otros cambios diversos


@menu
* Operadores y métodos especiales:: 
* Incorporados:: 

@end menu

@node Operadores y métodos especiales,Incorporados,,Otros cambios diversos
@anchor{whatsnew/3 0 operators-and-special-methods}@anchor{1334}
@subsubsection Operadores y métodos especiales



@itemize *

@item 
@code{!=} ahora retorna lo opuesto de @code{==}, salvo que @code{==} retorne @ref{227,,NotImplemented}.

@item 
El concepto de «métodos independientes» fue quitado del lenguaje. Cuando se refiere a un método como atributo de clase, ahora se obtiene un objeto de función simple.

@item 
@code{__getslice__()}, @code{__setslice__()} y  @code{__delslice__()} se quitaron. La sintaxis @code{a[i:j]} ahora se traduce a @code{a.__getitem__(slice(i, j))} (o @code{__setitem__()} o @code{__delitem__()}, cuando se utiliza como destino de asignación o eliminación, respectivamente).

@item 
@geindex Python Enhancement Proposals; PEP 3114
PEP 3114@footnote{https://peps.python.org/pep-3114/}: El método estándar @ref{86f,,next()} se ha renombrado como @ref{1335,,__next__()}.

@item 
Los métodos especiales @code{__oct__()} y @code{__hex__()} se quitaron – @ref{1336,,oct()} y @ref{1337,,hex()} utilizan @code{__index__()} ahora para convertir el argumento a un entero.

@item 
Soporte eliminado para @code{__members__} y @code{__methods__}.

@item 
The function attributes named @code{func_X} have been renamed to
use the @code{__X__} form, freeing up these names in the function
attribute namespace for user-defined attributes.  To wit,
@code{func_closure}, @code{func_code}, @code{func_defaults},
@code{func_dict}, @code{func_doc}, @code{func_globals},
@code{func_name} were renamed to @ref{1338,,__closure__},
@ref{3ec,,__code__}, @ref{1339,,__defaults__},
@ref{133a,,__dict__}, @ref{1246,,__doc__},
@ref{133b,,__globals__}, @ref{133c,,__name__},
respectively.

@item 
@code{__nonzero__()} is now @ref{133d,,__bool__()}.
@end itemize

@node Incorporados,,Operadores y métodos especiales,Otros cambios diversos
@anchor{whatsnew/3 0 builtins}@anchor{133e}
@subsubsection Incorporados



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 3135
PEP 3135@footnote{https://peps.python.org/pep-3135/}: Nuevo @ref{155,,super()}. Ahora se puede invocar @ref{155,,super()} sin argumentos y (suponiendo que se encuentra en un método de instancia normal definido dentro de una declaración @ref{133f,,class}) se elegirá automáticamente la clase y la instancia correctas. Con argumentos, el comportamiento de @ref{155,,super()} no cambia.

@item 
@geindex Python Enhancement Proposals; PEP 3111
PEP 3111@footnote{https://peps.python.org/pep-3111/}: @code{raw_input()} se renombró a @ref{1340,,input()}.  Es decir, la nueva función @ref{1340,,input()} lee una línea de @ref{5df,,sys.stdin} y la retorna con la línea final despojada. Lanza @ref{1341,,EOFError} si la entrada se termina prematuramente. Para obtener el comportamiento anterior de @ref{1340,,input()}, utilice @code{eval(input())}.

@item 
Se añadió una nueva función incorporada @ref{86f,,next()} para llamar al método @ref{1335,,__next__()} sobre un objeto.

@item 
La estrategia de redondeo de la función @ref{1342,,round()} y el tipo de retorno han cambiado.  Los casos exactamente a mitad de camino ahora se redondean al resultado par más cercano en lugar de alejarse de cero. (Por ejemplo, @code{round(2.5)} ahora retorna “”2”” en lugar de @code{3}.) @code{round(x[, n])} ahora delega en @code{x.__round__([n])} en lugar de retornar siempre un float. Por lo general, retorna un entero cuando se llama con un único argumento y un valor del mismo tipo que @code{x} cuando se llama con dos argumentos.

@item 
Se movió @code{intern()} a @ref{1343,,sys.intern()}.

@item 
Se eliminó: @code{apply()}. En lugar de @code{apply(f, args)} se utiliza @code{f(*args)}.

@item 
Se eliminó @ref{1233,,callable()}. En lugar de @code{callable(f)} se puede utilizar @code{isinstance(f, collections.Callable)}. La función @code{operator.isCallable()} también se quitó.

@item 
Se eliminó @code{coerce()}. Esta función ya no sirve para nada ahora que las clases clásicas se han quitado.

@item 
Se eliminó @code{execfile()}. En lugar de @code{execfile(fn)} utilizar @code{exec(open(fn).read())}.

@item 
Se eliminó el tipo @code{file}. Se utiliza @ref{1be,,open()}. Ahora hay varios tipos diferentes de secuencias que se abren y pueden retornar en el módulo @ref{7f,,io}.

@item 
Se eliminó @code{reduce()}. Se puede utilizar @ref{17d,,functools.reduce()} si es realmente necesario; de todas maneras, 99 por ciento del tiempo un bucle @ref{1eb,,for} explícito es más legible.

@item 
Removed @code{reload()}.  Use @code{imp.reload()}.

@item 
Se eliminó @code{dict.has_key()} – se utiliza el operador @ref{1ed,,in} en su lugar.
@end itemize

@c ======================================================================

@node Construcción y cambios a la API de C,Rendimiento,Otros cambios diversos,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 build-and-c-api-changes}@anchor{1344}
@subsection Construcción y cambios a la API de C


Debido a restricciones de tiempo, aquí hay una `muy' incompleta lista de cambios a la API de C.


@itemize *

@item 
Se ha eliminado el soporte para varias plataformas, incluyendo pero no limitado a Mac OS 9, BeOS, RISCOS, Irix y Tru64.

@item 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/}: Nueva API de búfer.

@item 
@geindex Python Enhancement Proposals; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}: Inicialización y finalización de módulos de extensión.

@item 
@geindex Python Enhancement Proposals; PEP 3123
PEP 3123@footnote{https://peps.python.org/pep-3123/}: Haciendo @ref{1345,,PyObject_HEAD} conforme al estándar C.

@item 
No más compatibilidad con API C para ejecución restringida.

@item 
@code{PyNumber_Coerce()}, @code{PyNumber_CoerceEx()},
@code{PyMember_Get()}, and @code{PyMember_Set()} C APIs are removed.

@item 
La nueva API C @ref{272,,PyImport_ImportModuleNoBlock()}, trabaja como @ref{273,,PyImport_ImportModule()} pero no bloqueará en el bloqueo de importación (en su lugar, retornará un error).

@item 
Se renombró la conversión booleana de ranura de nivel C y el método: @code{nb_nonzero} ahora es @code{nb_bool}.

@item 
Removed @code{METH_OLDARGS} and @code{WITH_CYCLE_GC} from the C API.
@end itemize

@c ======================================================================

@node Rendimiento,Migración a Python 3 0,Construcción y cambios a la API de C,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 performance}@anchor{1346}
@subsection Rendimiento


El resultado neto de las generalizaciones 3.0 es que Python 3.0 ejecuta el punto de referencia `pystone' alrededor de 10% más lenta que Python 2.5. Lo más probable es que la mayor causa sea la eliminación de mayúsculas y minúsculas especiales para enteros pequeños. Hay margen de mejora, ¡pero sucederá después de que se publique 3.0!

@c ======================================================================

@node Migración a Python 3 0,,Rendimiento,Qué hay de nuevo en Python 3 0
@anchor{whatsnew/3 0 porting-to-python-3-0}@anchor{1347}
@subsection Migración a Python 3.0


Para migrar código Python 2.5 o 2.6 existente a Python 3.0, la mejor estrategia es la siguiente:


@enumerate 0

@item 
(Prerrequisito:) Comenzar con excelente cobertura de test.

@item 
Migrar a Python 2.6. Esto no debería representar más trabajo que la migración promedio de Python 2.x a Python 2.(x+1). Asegurarse que todos los test pasen.

@item 
(Todavía utilizando 2.6:) Activar el modificador de línea de comandos @code{-3}. Esto habilita las advertencias sobre las características que se eliminarán (o cambiarán) en 3.0. Ejecutar el conjunto de pruebas de nuevo y corregir el código sobre el que se recibe advertencias hasta que no queden advertencias y todas las pruebas sigan pasando.

@item 
Run the @code{2to3} source-to-source translator over your source code
tree.  Run the
result of the translation under Python 3.0.  Manually fix up any
remaining issues, fixing problems until all tests pass again.
@end enumerate

No se recomienda intentar escribir código fuente que se ejecute sin cambios en Python 2.6 y 3.0; se tendría que usar un estilo de codificación muy contorsionado, por ejemplo, evitando las sentencias @code{print}, metaclases y mucho más. Si se mantiene una biblioteca que necesita soportar Python 2.6 y Python 3.0, el mejor enfoque es modificar el paso 3 anterior editando la versión 2.6 del código fuente y ejecutando el traductor @code{2to3} de nuevo, en lugar de editar la versión 3.0 del código fuente.

Para migrar las extensiones C a Python 3.0, por favor ver @ref{1348,,Portar módulos de extensión a Python 3}.

@c ======================================================================

@node Qué hay de nuevo en Python 2 7,Qué hay de nuevo en Python 2 6,Qué hay de nuevo en Python 3 0,Qué hay de nuevo en Python
@anchor{whatsnew/2 7 doc}@anchor{1349}@anchor{whatsnew/2 7 what-s-new-in-python-2-7}@anchor{134a}
@section Qué hay de nuevo en Python 2.7


@*Autor: 
A.M. Kuchling (amk en amk.ca)


@c hyperlink all the methods & functions.

@c T_STRING_INPLACE not described in main docs

@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.  Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number in a parenthetical comment.
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer some effort going through the SVN logs
@c when researching a change.

Este articulo explica las nuevas características en Python 2.7.  Python 2.7 fue publicado el 3 de Julio de 2010.

El manejo numérico ha sido mejorado en muchas formas, tanto para los números de punto flotante como para la clase @ref{16a,,Decimal}. Hay algunas adiciones útiles a la biblioteca estándar, como una gran mejora al modulo @ref{106,,unittest}, el modulo @ref{7,,argparse} para analizar las opciones de la línea de comandos, adecuando las clases @ref{67c,,OrderedDict} y @ref{110e,,Counter} en el modulo @ref{1e,,collections}, y muchas otras mejoras.

Python 2.7 esta previsto que sea el ultimo lanzamiento de la serie 2.x, así que hemos trabajado para que sea una versión a largo plazo. Para ayudar con la migración a Python 3, se han incluido varias características nuevas de la serie Python 3.x en 2.7.

Este articulo no intenta proporcionar una especificación completa de las nuevas características, sino que proporciona una visión general conveniente.  Para obtener mas información, debería consultar la documentación de Python 2.7 en @indicateurl{https://docs.python.org}. Si desea comprender la justificación para el diseño y la implementación, consultar el PEP para una nueva característica particular o el error en el que se discutió un cambio en @indicateurl{https://bugs.python.org}.  Siempre que sea posible, «Que hay de nuevo en Python» enlaza el elemento error/parche para cada cambio.

@menu
* El futuro de Python 2.x: El futuro de Python 2 x. 
* Cambios en el manejo de las advertencias de desuso:: 
* Características de Python 3.1: Características de Python 3 1. 
* PEP 372; Adición de un diccionario ordenado a las colecciones: PEP 372 Adición de un diccionario ordenado a las colecciones. 
* PEP 378; Especificador de formato para separador de miles: PEP 378 Especificador de formato para separador de miles. 
* PEP 389; El módulo argparse para el análisis de líneas de comando: PEP 389 El módulo argparse para el análisis de líneas de comando. 
* PEP 391; Configuración basada en diccionarios para el registro: PEP 391 Configuración basada en diccionarios para el registro. 
* PEP 3106; Vistas de diccionario: PEP 3106 Vistas de diccionario. 
* PEP 3137; El objeto memoryview: PEP 3137 El objeto memoryview. 
* Otros cambios de lenguaje: Otros cambios de lenguaje<3>. 
* Módulos nuevos y mejorados:: 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<2>. 
* Otros cambios y correcciones:: 
* Adaptación a Python 2.7: Adaptación a Python 2 7. 
* Nuevas funciones añadidas a las versiones de mantenimiento de Python 2.7: Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7. 
* Agradecimientos:: 

@end menu

@node El futuro de Python 2 x,Cambios en el manejo de las advertencias de desuso,,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 the-future-for-python-2-x}@anchor{134b}@anchor{whatsnew/2 7 whatsnew27-python31}@anchor{134c}
@subsection El futuro de Python 2.x


Python 2.7 es el último lanzamiento importante de la serie 2.x, ya que los mantenedores de Python han cambiado el enfoque de sus esfuerzos en el desarrollo de nuevas características para la serie de Python 3.x. Esto significa que mientras Python 2 continúe recibiendo corrección de errores, y sea actualizado para construir correctamente sobre nuevo hardware y versiones de sistemas operativos compatibles, no habrá nuevas versiones completas de funciones para el idioma o la biblioteca estándar.

Sin embargo, si bien existe un gran subconjunto común entre Python 2.7 y Python 3, y muchos de los cambios involucrados en la migración a ese subconjunto común, o directamente a Python 3, se pueden automatizar de manera segura, algunos otros cambios (en particular los asociados con el manejo de Unicode) puede requerir una consideración cuidadosa, y preferiblemente conjuntos de pruebas de regresión automatizada robustos, para migrar de manera efectiva.

Esto significa que Python 2.7 permanecerá en su lugar durante un largo tiempo, proporcionando una plataforma base estable y compatible para sistemas de producción que aún no se han adaptado a Python 3. La expectativa completa del ciclo de vida de la versión de Python 2.7 esta detallada en 
@geindex Python Enhancement Proposals; PEP 373
PEP 373@footnote{https://peps.python.org/pep-0373/}.

Algunas consecuencias clave de la importancia a largo plazo de 2.7 son:


@itemize *

@item 
Como se señalo anteriormente, la versión 2.7 tiene un período de mantenimiento mucho más largo en comparación con las versiones anteriores 2.x. Actualmente se espera que Python 2.7 siga siendo compatible con el equipo de desarrollo central (recibiendo actualizaciones de seguridad y otras correcciones de errores) al menos hasta 2020 (10 años después de su lanzamiento inicial, comparado con el típico periodo de mantenimiento de 18–24 meses).

@item 
A medida que la biblioteca estándar de Python envejece, hacer un uso eficaz del índice de paquetes de Python (ya sea directamente o a través de un distribuidor) se vuelve mas importante para los usuarios de Python 2. Además de una amplia variedad de paquetes de terceros para diversas tareas, los paquetes disponibles incluyen `backports' de nuevos módulos y características de la biblioteca estándar de Python 3 que son compatibles con Python 2, así como varias herramientas y librerías que pueden hacer mas fácil la migración a Python 3. La Guía de usuario de paquetes de Python@footnote{https://packaging.python.org} proporciona un información sobre como descargar e instalar software desde el índice de paquetes de Python.

@item 
Aunque el enfoque preferido para mejorar Python 2 es ahora la publicación de nuevos paquetes en el índice de paquetes de Python, este enfoque no necesariamente funciona en todos los casos, especialmente aquellos relacionados a la seguridad de la red. En casos excepcionales que no puedan ser manejados adecuadamente mediante la publicación de nuevos paquetes o actualizaciones en PyPI, el proceso de propuestas de mejoras de Python podría ser usado para crear el caso para añadir nuevas funciones a la librería estándar de Python 2. Dichas adiciones, y las versiones de mantenimiento donde fueron agregadas, se observaran en la sección @ref{134d,,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2.7} mas abajo.
@end itemize

Para los proyectos que deseen migrar de Python 2 a Python 3, o para los desarrolladores de `frameworks' y libreras que deseen dar soporte a usuarios en Python 2 y Python 3, hay una variedad de herramientas y guías disponibles para ayudarles a decidir sobre un enfoque adecuado y manejar algunos de los detalles técnicos involucrados. El punto de partida recomendado es la guía HOWTO pyporting-howto.

@node Cambios en el manejo de las advertencias de desuso,Características de Python 3 1,El futuro de Python 2 x,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 changes-to-the-handling-of-deprecation-warnings}@anchor{134e}
@subsection Cambios en el manejo de las advertencias de desuso


Para Python 2.7, se tomo la decisión de silenciar las advertencias solo de interés para los desarrolladores de manera predeterminada. @code{DeprecationWarning`y sus descendientes son ahora ignoradas a menos que se solicite lo contrario, impidiendo a los usuarios estar viendo las advertencias disparadas por una aplicación. Este cambio se realizo en la rama que se convirtió en Python 3.2. (Discutido en stdlib-sig y llevado a cabo en :issue:`7319}).

En versiones previas, los mensajes @ref{1da,,DeprecationWarning} estaban habilitados de manera predeterminada, proporcionando a los desarrolladores de Python una indicación clara de donde podría romperse su código en una futura versión principal de Python.

Sin embargo, cada vez hay más usuarios de aplicaciones basadas en Python que no están directamente involucrados en el desarrollo de esas aplicaciones.  Los mensajes @ref{1da,,DeprecationWarning} son irrelevantes para estos usuarios, hacen que se preocupen por una aplicación que realmente está funcionando correctamente y sobrecargando a los desarrolladores de aplicaciones con responder a estas preocupaciones.

Puede volver a habilitar la visualización de los mensajes @ref{1da,,DeprecationWarning} ejecutando Python con el modificador @ref{95e,,-Wdefault} (forma corta: @ref{95e,,-Wd}), o estableciendo la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} en @code{"default"} (o @code{"d"}) antes de ejecutar Python.  El código Python también puede volver a habilitarlos llamando a @code{warnings.simplefilter('default')}.

El módulo @code{unittest} también vuelve a instalar automáticamente las advertencias de desuso al ejecutar pruebas.

@node Características de Python 3 1,PEP 372 Adición de un diccionario ordenado a las colecciones,Cambios en el manejo de las advertencias de desuso,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 python-3-1-features}@anchor{134f}
@subsection Características de Python 3.1


Al igual que Python 2.6 incorporó características de Python 3.0, la versión 2.7 incorpora algunas de las nuevas características de Python 3.1.  La serie 2.x continúa proporcionando herramientas para migrar a la serie 3.x.

Una lista parcial de características 3.1 que se retro importaron a 2.7:


@itemize *

@item 
La sintaxis para establecer literales (@code{@{1,2,3@}} es un conjunto mutable).

@item 
Diccionario y establecimiento de compresiones (@code{@{i: i*2 for i in range(3)@}}).

@item 
Múltiples administradores de contexto en una sola declaración @ref{673,,with}.

@item 
Una nueva versión para la librería @ref{7f,,io}, rescrito en C para un mejor desempeño.

@item 
El tipo de ordenador de diccionario descrito en @ref{1350,,PEP 372; Adición de un diccionario ordenado a las colecciones}.

@item 
El nuevo especificador de formato @code{","} descrito en @ref{1351,,PEP 378; Especificador de formato para separador de miles}.

@item 
El objeto @ref{156,,memoryview}.

@item 
Un pequeño subconjunto del modulo @ref{77,,importlib}, @ref{1352,,descrito abajo}.

@item 
La @ref{894,,repr()} de un flotante @code{x} es más corto en muchos casos: ahora se basa en la cadena decimal más corta que se garantiza que redondea a @code{x}. Como en versiones anteriores de Python, se garantiza que @code{float(repr(x))} retorne @code{x}.

@item 
Las conversiones flotante a cadena y cadena a flotante se redondean correctamente. La función @ref{1342,,round()} también ahora se redondea correctamente.

@item 
El tipo @ref{12e0,,PyCapsule}, utilizado para proporcionar una API de C para módulos de extensión.

@item 
La función de API de C @ref{12d4,,PyLong_AsLongAndOverflow()}.
@end itemize

Otras nuevas advertencias en modo Python3 incluyen:


@itemize *

@item 
@code{operator.isCallable()} and @code{operator.sequenceIncludes()},
which are not supported in 3.x, now trigger warnings.

@item 
El modificador @code{-3} ahora habilita automáticamente el modificador @code{-Qwarn} que provoca advertencias sobre el uso de la división clásica con enteros y enteros largos.
@end itemize

@c ========================================================================

@c Large, PEP-level features and changes should be described here.

@c ========================================================================

@node PEP 372 Adición de un diccionario ordenado a las colecciones,PEP 378 Especificador de formato para separador de miles,Características de Python 3 1,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-0372}@anchor{1350}@anchor{whatsnew/2 7 pep-372-adding-an-ordered-dictionary-to-collections}@anchor{1353}
@subsection PEP 372: Adición de un diccionario ordenado a las colecciones


Los diccionarios de python normales recorren en iteración los pares clave/valor en un orden arbitrario. A lo largo de los años, varios autores han escrito implementaciones alternativas que recuerdan el orden en que se insertaron originalmente las claves.  Basado en las experiencias de esas implementaciones, 2.7 presenta una nueva clase @ref{67c,,OrderedDict} en el módulo @ref{1e,,collections}.

La API @ref{67c,,OrderedDict} proporciona la misma interfaz que los diccionarios normales, pero recorre en iteración las claves y los valores en un orden garantizado en función de cuándo se insertó una clave por primera vez:

@example
>>> from collections import OrderedDict
>>> d = OrderedDict([('first', 1),
...                  ('second', 2),
...                  ('third', 3)])
>>> d.items()
[('first', 1), ('second', 2), ('third', 3)]
@end example

Si una nueva entrada sobrescribe una entrada existente, la posición de inserción original no se modifica:

@example
>>> d['second'] = 4
>>> d.items()
[('first', 1), ('second', 4), ('third', 3)]
@end example

Borrando una entrada y luego reinsertándola, moverá la misma al final:

@example
>>> del d['second']
>>> d['second'] = 5
>>> d.items()
[('first', 1), ('third', 3), ('second', 5)]
@end example

El método @ref{1354,,popitem()} tiene un argumento `last' opcional que por defecto esta en @code{True} (verdadero). Si `last' es verdadero, la ultima llave ingresada es regresada y eliminada; si es falso, se selecciona la llave más antigua:

@example
>>> od = OrderedDict([(x,0) for x in range(20)])
>>> od.popitem()
(19, 0)
>>> od.popitem()
(18, 0)
>>> od.popitem(last=False)
(0, 0)
>>> od.popitem(last=False)
(1, 0)
@end example

La comparación de dos diccionarios ordenados comprueba tanto las claves como los valores, y requiere que el orden de inserción sea el mismo:

@example
>>> od1 = OrderedDict([('first', 1),
...                    ('second', 2),
...                    ('third', 3)])
>>> od2 = OrderedDict([('third', 3),
...                    ('first', 1),
...                    ('second', 2)])
>>> od1 == od2
False
>>> # Move 'third' key to the end
>>> del od2['third']; od2['third'] = 3
>>> od1 == od2
True
@end example

Comparando a un @ref{67c,,OrderedDict} con un diccionario normal ignora el orden de inserción y simplemente compara las llaves y los valores.

How does the @ref{67c,,OrderedDict} work?  It maintains a
doubly linked list of keys, appending new keys to the list as they’re inserted.
A secondary dictionary maps keys to their corresponding list node, so
deletion doesn’t have to traverse the entire linked list and therefore
remains `O'(1).

La biblioteca estándar ahora admite el uso de diccionarios ordenados en varios módulos.


@itemize *

@item 
The @ref{23,,ConfigParser} module uses them by default, meaning that
configuration files can now be read, modified, and then written back
in their original order.

@item 
The @ref{a73,,_asdict()} method for
@ref{32d,,collections.namedtuple()} now returns an ordered dictionary with the
values appearing in the same order as the underlying tuple indices.

@item 
El constructor de clase @ref{dce,,JSONDecoder} del módulo @ref{82,,json} se amplió con un parámetro `object_pairs_hook' para permitir que el decodificador construya instancias @code{OrderedDict}. También se agregó soporte para herramientas de terceros como PyYAML@footnote{https://pyyaml.org/}.
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - Adición de un diccionario ordenado a las `collections'

PEP escrito por Armin Ronacher y Raymond Hettinger; implementado por Raymond Hettinger.
@end table


@node PEP 378 Especificador de formato para separador de miles,PEP 389 El módulo argparse para el análisis de líneas de comando,PEP 372 Adición de un diccionario ordenado a las colecciones,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-0378}@anchor{1351}@anchor{whatsnew/2 7 pep-378-format-specifier-for-thousands-separator}@anchor{1355}
@subsection PEP 378: Especificador de formato para separador de miles


Para que la salida del programa sea más legible, puede ser útil agregar separadores a números grandes, representándolos como 18,446,744,073,709,551,616 en lugar de 18446744073709551616.

La solución totalmente general para hacer esto es el módulo @ref{86,,locale}, que puede utilizar diferentes separadores («,» en América del Norte, «.» en Europa) y diferentes tamaños de agrupación, pero @ref{86,,locale} es complicado de usar y no es adecuado para aplicaciones multiproceso donde diferentes hilos están produciendo resultados para diferentes configuraciones regionales.

Por lo tanto, se ha añadido un mecanismo simple de agrupación de comas al mini-lenguaje utilizado por el método @ref{6c2,,str.format()}.  Al dar formato a un número de punto flotante, simplemente incluya una coma entre el ancho y la precisión:

@example
>>> '@{:20,.2f@}'.format(18446744073709551616.0)
'18,446,744,073,709,551,616.00'
@end example

Al dar formato a un entero, incluya la coma después del ancho:

@example
>>> '@{:20,d@}'.format(18446744073709551616)
'18,446,744,073,709,551,616'
@end example

Este mecanismo no es adaptable en absoluto; Las comas siempre se utilizan como separador y la agrupación siempre está en grupos de tres dígitos.  El mecanismo de formato de coma no es tan general como el módulo @ref{86,,locale}, pero es más fácil de usar.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - Especificador de formato para separador de miles

PEP escrito por Raymond Hettinger; implementado por Eric Smith.
@end table


@node PEP 389 El módulo argparse para el análisis de líneas de comando,PEP 391 Configuración basada en diccionarios para el registro,PEP 378 Especificador de formato para separador de miles,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-389-the-argparse-module-for-parsing-command-lines}@anchor{1356}
@subsection PEP 389: El módulo argparse para el análisis de líneas de comando


El módulo @ref{7,,argparse} para analizar argumentos de línea de comandos se agregó como un reemplazo más potente para el módulo @ref{a0,,optparse}.

This means Python now supports three different modules for parsing
command-line arguments: @ref{61,,getopt}, @ref{a0,,optparse}, and
@ref{7,,argparse}.  The @ref{61,,getopt} module closely resembles the C
library’s @code{getopt()} function, so it remains useful if you’re writing a
Python prototype that will eventually be rewritten in C.
@ref{a0,,optparse} becomes redundant, but there are no plans to remove it
because there are many scripts still using it, and there’s no
automated way to update these scripts.  (Making the @ref{7,,argparse}
API consistent with @ref{a0,,optparse}’s interface was discussed but
rejected as too messy and difficult.)

En resumen, si estás escribiendo un nuevo script y no necesitas preocuparte por la compatibilidad con versiones anteriores de Python, usa @ref{7,,argparse} en lugar de @ref{a0,,optparse}.

Este es un ejemplo:

@example
import argparse

parser = argparse.ArgumentParser(description='Command-line example.')

# Add optional switches
parser.add_argument('-v', action='store_true', dest='is_verbose',
                    help='produce verbose output')
parser.add_argument('-o', action='store', dest='output',
                    metavar='FILE',
                    help='direct output to FILE instead of stdout')
parser.add_argument('-C', action='store', type=int, dest='context',
                    metavar='NUM', default=0,
                    help='display NUM lines of added context')

# Allow any number of additional arguments.
parser.add_argument(nargs='*', action='store', dest='inputs',
                    help='input filenames (default is stdin)')

args = parser.parse_args()
print args.__dict__
@end example

A menos que lo reemplace, los modificadores @code{-h} y @code{--help} se agregan automáticamente, y producen una salida con formato ordenado:

@example
-> ./python.exe argparse-example.py --help
usage: argparse-example.py [-h] [-v] [-o FILE] [-C NUM] [inputs [inputs ...]]

Command-line example.

positional arguments:
  inputs      input filenames (default is stdin)

optional arguments:
  -h, --help  show this help message and exit
  -v          produce verbose output
  -o FILE     direct output to FILE instead of stdout
  -C NUM      display NUM lines of added context
@end example

Al igual que con @ref{a0,,optparse}, los modificadores y argumentos de línea de comandos se retornan como un objeto con atributos denominados por los parámetros `dest':

@example
-> ./python.exe argparse-example.py -v
@{'output': None,
 'is_verbose': True,
 'context': 0,
 'inputs': []@}

-> ./python.exe argparse-example.py -v -o /tmp/output -C 4 file1 file2
@{'output': '/tmp/output',
 'is_verbose': True,
 'context': 4,
 'inputs': ['file1', 'file2']@}
@end example

@ref{7,,argparse} tiene una validación mucho más fantasiosa que @ref{a0,,optparse}; puede especificar un número exacto de argumentos como un entero, 0 o más argumentos pasando @code{'*'}, 1 o más pasando @code{'+'}, o un argumento opcional con @code{'?'}.  Un analizador de nivel superior puede contener sub analizadores para definir subcomandos que tienen diferentes conjuntos de modificadores, como en @code{svn commit}, @code{svn checkout}, etc.  Puede especificar el tipo de un argumento como @ref{1c2,,FileType}, que abrirá automáticamente los archivos y entiende que @code{'-'} significa entrada o salida estándar.


@subsubheading Ver también



@table @asis

@item @ref{7,,argparse} documentación

La página de documentación del módulo argparse.

@item @ref{121c,,Upgrading optparse code}

Parte de la documentación de Python, que describe cómo convertir código que usa @ref{a0,,optparse}.

@geindex Python Enhancement Proposals; PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - argparse - Nuevo módulo de análisis de línea de comandos

PEP escrito e implementado por Steven Bethard.
@end table


@node PEP 391 Configuración basada en diccionarios para el registro,PEP 3106 Vistas de diccionario,PEP 389 El módulo argparse para el análisis de líneas de comando,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-391-dictionary-based-configuration-for-logging}@anchor{1357}
@subsection PEP 391: Configuración basada en diccionarios para el registro


El módulo @ref{87,,logging} es muy flexible; las aplicaciones pueden definir un árbol de subsistemas de registro, y cada registrador de este árbol puede filtrar ciertos mensajes, formatearlos de forma diferente y dirigir mensajes a un número variable de controladores.

All this flexibility can require a lot of configuration.  You can
write Python statements to create objects and set their properties,
but a complex set-up requires verbose but boring code.
@ref{87,,logging} also supports a @ref{bd9,,fileConfig()}
function that parses a file, but the file format doesn’t support
configuring filters, and it’s messier to generate programmatically.

Python 2.7 adds a @ref{121e,,dictConfig()} function that
uses a dictionary to configure logging.  There are many ways to
produce a dictionary from different sources: construct one with code;
parse a file containing JSON; or use a YAML parsing library if one is
installed.  For more information see @ref{1358,,Funciones de configuración}.

En el ejemplo siguiente se configuran dos registradores, el registrador raíz y un registrador denominado «network».  Los mensajes enviados al registrador raíz se enviarán al registro del sistema mediante el protocolo syslog, y los mensajes al registrador de la «network» se escribirán en un archivo @code{network.log} que se rotará una vez que el registro alcance 1MB.

@example
import logging
import logging.config

configdict = @{
 'version': 1,    # Configuration schema in use; must be 1 for now
 'formatters': @{
     'standard': @{
         'format': ('%(asctime)s %(name)-15s '
                    '%(levelname)-8s %(message)s')@}@},

 'handlers': @{'netlog': @{'backupCount': 10,
                     'class': 'logging.handlers.RotatingFileHandler',
                     'filename': '/logs/network.log',
                     'formatter': 'standard',
                     'level': 'INFO',
                     'maxBytes': 1000000@},
              'syslog': @{'class': 'logging.handlers.SysLogHandler',
                         'formatter': 'standard',
                         'level': 'ERROR'@}@},

 # Specify all the subordinate loggers
 'loggers': @{
             'network': @{
                         'handlers': ['netlog']
             @}
 @},
 # Specify properties of the root logger
 'root': @{
          'handlers': ['syslog']
 @},
@}

# Set up configuration
logging.config.dictConfig(configdict)

# As an example, log two error messages
logger = logging.getLogger('/')
logger.error('Database not found')

netlogger = logging.getLogger('network')
netlogger.error('Connection failed')
@end example

Tres mejoras más pequeñas en el módulo @ref{87,,logging}, todas implementadas por Vinay Sajip, son:

@c rev79293


@itemize *

@item 
La clase @ref{6fd,,SysLogHandler} ahora admite syslogging a través de TCP.  El constructor tiene un parámetro `socktype' que proporciona el tipo de socket que se va a usar, ya sea @ref{1359,,socket.SOCK_DGRAM} para UDP o @ref{135a,,socket.SOCK_STREAM} para TCP.  El protocolo predeterminado sigue siendo UDP.

@item 
Las instancias @ref{bd7,,Logger} ganaron un método @ref{135b,,getChild()} que recupera un registrador descendiente mediante una ruta de acceso relativa. Por ejemplo, una vez que se recupera un registrador haciendo @code{log = getLogger('app')}, llamando @code{log.getChild('network.listen')} es equivalente a @code{getLogger('app.network.listen')}.

@item 
The @ref{135c,,LoggerAdapter} class gained an
@ref{135d,,isEnabledFor()} method that takes a
`level' and returns whether the underlying logger would
process a message of that level of importance.
@end itemize

@c XXX: Logger objects don't have a class declaration so the link don't work


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - Configuración basada en diccionarios para el registro

PEP escrito e implementado por Vinay Sajip.
@end table


@node PEP 3106 Vistas de diccionario,PEP 3137 El objeto memoryview,PEP 391 Configuración basada en diccionarios para el registro,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-3106-dictionary-views}@anchor{135e}
@subsection PEP 3106: Vistas de diccionario


Los métodos de diccionarios @ref{866,,keys()}, @ref{867,,values()} y @ref{868,,items()} son diferentes en Python 3.x. Ellos regresan un objeto llamado `view' en lugar de una lista completamente materializada.

It’s not possible to change the return values of @ref{866,,keys()},
@ref{867,,values()}, and @ref{868,,items()} in Python 2.7 because
too much code would break.  Instead the 3.x versions were added
under the new names @code{viewkeys()}, @code{viewvalues()},
and @code{viewitems()}.

@example
>>> d = dict((i*10, chr(65+i)) for i in range(26))
>>> d
@{0: 'A', 130: 'N', 10: 'B', 140: 'O', 20: ..., 250: 'Z'@}
>>> d.viewkeys()
dict_keys([0, 130, 10, 140, 20, 150, 30, ..., 250])
@end example

Las vistas se pueden iterar, pero las vistas de elementos y claves también se comportan como conjuntos. El operador @code{&} realiza la intersección y @code{|} realiza una unión:

@example
>>> d1 = dict((i*10, chr(65+i)) for i in range(26))
>>> d2 = dict((i**.5, i) for i in range(1000))
>>> d1.viewkeys() & d2.viewkeys()
set([0.0, 10.0, 20.0, 30.0])
>>> d1.viewkeys() | range(0, 30)
set([0, 1, 130, 3, 4, 5, 6, ..., 120, 250])
@end example

La vista realiza un seguimiento del diccionario y su contenido cambia a medida que se modifica el diccionario:

@example
>>> vk = d.viewkeys()
>>> vk
dict_keys([0, 130, 10, ..., 250])
>>> d[260] = '&'
>>> vk
dict_keys([0, 130, 260, 10, ..., 250])
@end example

Sin embargo, tenga en cuenta que no puede agregar o eliminar claves mientras está iterando sobre la vista:

@example
>>> for k in vk:
...     d[k*2] = k
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: dictionary changed size during iteration
@end example

Puede usar los métodos de vista en el código en Python 2.x, y el convertidor 2to3 los cambiará a los métodos estándar @ref{866,,keys()}, @ref{867,,values()} y @ref{868,,items()}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3106

@item PEP 3106@footnote{https://peps.python.org/pep-3106/} - Renovación dict.keys(), .values() y .items()

PEP escrito por Guido van Rossum. Portado a 2.7 por Alexandre Vassalotti; bpo-1967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1967}.
@end table


@node PEP 3137 El objeto memoryview,Otros cambios de lenguaje<3>,PEP 3106 Vistas de diccionario,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 pep-3137-the-memoryview-object}@anchor{135f}
@subsection PEP 3137: El objeto memoryview


El objeto @ref{156,,memoryview} proporciona una vista del contenido de la memoria de otro objeto que coincide con la interfaz de tipo  @ref{325,,bytes}.

@example
>>> import string
>>> m = memoryview(string.letters)
>>> m
<memory at 0x37f850>
>>> len(m)           # Returns length of underlying object
52
>>> m[0], m[25], m[26]   # Indexing returns one byte
('a', 'z', 'A')
>>> m2 = m[0:26]         # Slicing returns another memoryview
>>> m2
<memory at 0x37f080>
@end example

El contenido de la vista se puede convertir en una cadena de bytes o una lista de números enteros:

@example
>>> m2.tobytes()
'abcdefghijklmnopqrstuvwxyz'
>>> m2.tolist()
[97, 98, 99, 100, 101, 102, 103, ... 121, 122]
>>>
@end example

Los objetos @ref{156,,memoryview} permiten modificar el objeto subyacente si es un objeto mutable.

@example
>>> m2[0] = 75
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot modify read-only memory
>>> b = bytearray(string.letters)  # Creating a mutable object
>>> b
bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
>>> mb = memoryview(b)
>>> mb[0] = '*'         # Assign to view, changing the bytearray.
>>> b[0:5]              # The bytearray has been changed.
bytearray(b'*bcde')
>>>
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3137

@item PEP 3137@footnote{https://peps.python.org/pep-3137/} - Bytes inmutables y búfer mutable

PEP escrito por Guido van Rossum. Implementado por Travis Oliphant, Antoine Pitrou y otros. Portado a 2.7 por Antoine Pitrou; bpo-2396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2396}.
@end table


@node Otros cambios de lenguaje<3>,Módulos nuevos y mejorados,PEP 3137 El objeto memoryview,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 other-language-changes}@anchor{1360}
@subsection Otros cambios de lenguaje


Algunos de los cambios mas pequeños hechos al núcleo del lenguaje de Python son:


@itemize *

@item 
La sintaxis para literales de conjuntos se ha actualizado desde Python 3.x. Los corchetes se utilizan para rodear el contenido del conjunto mutable resultante; los literales de conjunto se distinguen de los diccionarios por no contener dos puntos ni valores. @code{@{@}} sigue representando un diccionario vacío; use @code{set()} para un conjunto vacío.

@example
>>> @{1, 2, 3, 4, 5@}
set([1, 2, 3, 4, 5])
>>> set() # empty set
set([])
>>> @{@}    # empty dict
@{@}
@end example

Portado por Alexandre Vassalotti; bpo-2335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2335}.

@item 
El diccionario y las comprensiones de conjuntos son otra característica portada desde 3.x, que generaliza las comprensiones de listas / generadores para usar la sintaxis literal para conjuntos y diccionarios.

@example
>>> @{x: x*x for x in range(6)@}
@{0: 0, 1: 1, 2: 4, 3: 9, 4: 16, 5: 25@}
>>> @{('a'*x) for x in range(6)@}
set(['@w{'}, 'a', 'aa', 'aaa', 'aaaa', 'aaaaa'])
@end example

Portado por Alexandre Vassalotti; bpo-2333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2333}.

@item 
La declaración @ref{673,,with} ahora puede usar múltiples administradores de contexto en una declaración. Los administradores de contexto se procesan de izquierda a derecha y cada uno se trata como si comenzara una nueva declaración @code{with}. Esto significa que:

@example
with A() as a, B() as b:
    ... suite of statements ...
@end example

es equivalente a:

@example
with A() as a:
    with B() as b:
        ... suite of statements ...
@end example

The @code{contextlib.nested()} function provides a very similar
function, so it’s no longer necessary and has been deprecated.

(Propuesta en @indicateurl{https://codereview.appspot.com/53094}; implementado por Georg Brandl.)

@item 
Las conversiones entre números de punto flotante y cadenas ahora se redondean correctamente en la mayoría de las plataformas. Estas conversiones ocurren en muchos lugares diferentes: @ref{237,,str()} en flotantes y números complejos; los constructores @ref{153,,float} y @ref{154,,complex}; formato numérico; serializar y deserializar flotantes y números complejos usando los módulos @ref{8d,,marshal}, @ref{a6,,pickle} y @ref{82,,json}; análisis de literales flotantes e imaginarios en código Python; y conversión @ref{16a,,Decimal} a flotante.

Relacionado con esto, el @ref{894,,repr()} de un número de punto flotante `x' ahora retorna un resultado basado en la cadena decimal más corta que se garantiza que se redondeará a `x' con el redondeo correcto (con el modo de redondeo `round-half-to-even'). Anteriormente, daba una cadena basada en redondear x a 17 dígitos decimales.

@c maybe add an example?

La biblioteca de redondeo responsable de esta mejora funciona en Windows y en plataformas Unix utilizando los compiladores gcc, icc o suncc.  Puede haber un pequeño número de plataformas donde no se puede garantizar el correcto funcionamiento de este código, por lo que el código no se utiliza en dichos sistemas.  Puede averiguar qué código se está utilizando marcando @ref{1361,,sys.float_repr_style}, que será @code{short} si el nuevo código está en uso y @code{legacy} si no lo está.

Implementado por Eric Smith y Mark Dickinson, utilizando la biblioteca de David Gay’s @code{dtoa.c}; bpo-7117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7117}.

@item 
Las conversiones de enteros largos y enteros regulares a punto flotante ahora redondean de forma diferente, retornando el número de punto flotante más cercano al número.  Esto no importa para los enteros pequeños que se pueden convertir exactamente, pero para los números grandes que inevitablemente perderán precisión, Python 2.7 ahora se aproxima más.  Por ejemplo, Python 2.6 calculaba lo siguiente:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935283e+20
>>> n - long(float(n))
65535L
@end example

El resultado de punto flotante de Python 2.7 es mayor, pero mucho más cerca del valor verdadero:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935289e+20
>>> n - long(float(n))
-1L
@end example

(Implementado por Mark Dickinson; bpo-3166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3166}.)

La división de enteros también es más precisa en su comportamiento de redondeo.  (También implementado por Mark Dickinson; bpo-1811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1811}.)

@item 
Implicit coercion for complex numbers has been removed; the interpreter
will no longer ever attempt to call a @code{__coerce__()} method on complex
objects.  (Removed by Meador Inge and Mark Dickinson; bpo-5211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5211}.)

@item 
El método @ref{6c2,,str.format()} soporta ahora la numeración automática de los campos de sustitución.  Esto hace que el uso de @ref{6c2,,str.format()} se asemeje más al uso del formateo @code{%s}:

@example
>>> '@{@}:@{@}:@{@}'.format(2009, 04, 'Sunday')
'2009:4:Sunday'
>>> '@{@}:@{@}:@{day@}'.format(2009, 4, day='Sunday')
'2009:4:Sunday'
@end example

La numeración automática toma los campos de izquierda a derecha, por lo que el primer especificador @code{@{...@}} utilizará el primer argumento de @ref{6c2,,str.format()}, el siguiente especificador utilizará el siguiente argumento, y así sucesivamente.  No se puede mezclar la numeración automática con la explícita - o se numeran todos los campos del especificador o ninguno - pero se puede mezclar la numeración automática con los campos con nombre, como en el segundo ejemplo anterior.  (Contribución de Eric Smith; bpo-5237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5237}.)

Los números complejos ahora soportan correctamente el uso con @ref{6c0,,format()}, y por defecto están alineados a la derecha. La especificación de una precisión o separación por comas se aplica tanto a la parte real como a la imaginaria del número, pero la anchura de campo y la alineación especificadas se aplican a la totalidad de la salida resultante @code{1,5+3j}.  (Contribución de Eric Smith; bpo-1588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1588} y bpo-7988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7988})

El código de formato “F” ahora siempre formatea su salida utilizando caracteres en mayúsculas, por lo que ahora producirá “INF” y “NAN”. (Contribución de Eric Smith; bpo-3382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3382}.)

A low-level change: the @ref{6bf,,object.__format__()} method now triggers
a @ref{95f,,PendingDeprecationWarning} if it’s passed a format string,
because the @code{__format__()} method for @ref{b18,,object} converts
the object to a string representation and formats that.  Previously
the method silently applied the format string to the string
representation, but that could hide mistakes in Python code.  If
you’re supplying formatting information such as an alignment or
precision, presumably you’re expecting the formatting to be applied
in some object-specific way.  (Fixed by Eric Smith; bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994}.)

@item 
The @ref{1f0,,int()} and @code{long()} types gained a @code{bit_length}
method that returns the number of bits necessary to represent
its argument in binary:

@example
>>> n = 37
>>> bin(n)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124
@end example

(Contribución de Fredrik Johansson y Victor Stinner; bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439}.)

@item 
La instrucción @ref{682,,import} ya no intentará una importación absoluta si se produce un error en una importación relativa (por ejemplo, @code{from .os import sep}).  Esto corrige un error, pero posiblemente podría romper ciertas instrucciones @code{import} que solo funcionaban por accidente.  (Arreglado por Meador Inge; bpo-7902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7902}.)

@item 
It’s now possible for a subclass of the built-in @code{unicode} type
to override the @code{__unicode__()} method.  (Implemented by
Victor Stinner; bpo-1583863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583863}.)

@item 
El método @ref{1362,,translate()} del tipo @ref{5e0,,bytearray} ahora acepta @code{None} como primer argumento.  (Corregido por Georg Brandl; bpo-4759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4759}.)

@c XXX bytearray doesn't seem to be documented

@item 
When using @ref{2d2,,@@classmethod} and
@ref{22e,,@@staticmethod} to wrap
methods as class or static methods, the wrapper object now
exposes the wrapped function as their @ref{1363,,__func__}
attribute.
(Contributed by Amaury Forgeot d’Arc, after a suggestion by
George Sakkis; bpo-5982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5982}.)

@item 
Cuando se establecía un conjunto restringido de atributos utilizando @code{__slots__}, la eliminación de un atributo no establecido no lanzaba @ref{441,,AttributeError} como cabría esperar.  Corregido por Benjamin Peterson; bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604})

@item 
Ahora se admiten dos nuevas codificaciones: «cp720», utilizada principalmente para el texto árabe; y «cp858», una variante de CP 850 que añade el símbolo del euro.  (CP720 contribuido por Alexander Belchenko y Amaury Forgeot d’Arc en bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979}; CP858 contribuido por Tim Hatch en bpo-8016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8016})

@item 
The @code{file} object will now set the @code{filename} attribute
on the @ref{10ce,,IOError} exception when trying to open a directory
on POSIX platforms (noted by Jan Kaliszewski; bpo-4764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4764}), and
now explicitly checks for and forbids writing to read-only file objects
instead of trusting the C library to catch and report the error
(fixed by Stefan Krah; bpo-5677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5677}).

@item 
El tokenizador de Python ahora traduce los finales de línea por sí mismo, por lo que la función incorporada @ref{2fb,,compile()} ahora acepta código que utilice cualquier convención de final de línea.  Además, ya no requiere que el código termine en una nueva línea.

@item 
Los paréntesis adicionales en las definiciones de función son ilegales en Python 3.x, lo que significa que se obtiene un error de sintaxis de @code{def f((x)): pass}.  En el modo de advertencia Python3, Python 2.7 ahora advertirá sobre este uso no común. (Anotado por James Lingard; bpo-7362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7362}.)

@item 
Ahora es posible crear referencias débiles a objetos de clase de estilo antiguo.  Las clases de estilo nuevo siempre eran de referencia débil.  (Corregido por Antoine Pitrou; bpo-8268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8268}.)

@item 
Cuando se recicla un objeto de módulo, el diccionario del módulo ahora solo se borra si nadie más tiene una referencia al diccionario (bpo-7140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7140}).
@end itemize

@c ======================================================================

@menu
* Cambios en el intérprete:: 
* Optimizaciones: Optimizaciones<11>. 

@end menu

@node Cambios en el intérprete,Optimizaciones<11>,,Otros cambios de lenguaje<3>
@anchor{whatsnew/2 7 interpreter-changes}@anchor{1364}@anchor{whatsnew/2 7 new-27-interpreter}@anchor{1365}
@subsubsection Cambios en el intérprete


Una nueva variable de entorno, 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}, permite controlar las advertencias.  Debe establecerse en una cadena que contenga la configuración de advertencia, equivalente a las utilizadas con el modificador @ref{95e,,-W}, separado por comas. (Contribuido por Brian Curtin; bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301}.)

For example, the following setting will print warnings every time
they occur, but turn warnings from the @ref{71,,Cookie} module into an
error.  (The exact syntax for setting an environment variable varies
across operating systems and shells.)

@example
export PYTHONWARNINGS=all,error:::Cookie:0
@end example

@c ======================================================================

@node Optimizaciones<11>,,Cambios en el intérprete,Otros cambios de lenguaje<3>
@anchor{whatsnew/2 7 optimizations}@anchor{1366}
@subsubsection Optimizaciones


Se han añadido varias mejoras de rendimiento:


@itemize *

@item 
A new opcode was added to perform the initial setup for
@ref{673,,with} statements, looking up the @ref{669,,__enter__()} and
@ref{1367,,__exit__()} methods.  (Contributed by Benjamin Peterson.)

@item 
El recolector de basura ahora funciona mejor para un patrón de uso común: cuando se asignan muchos objetos sin desasignar ninguno de ellos.  Antes, la recogida de basura tardaba un tiempo cuadrático, pero ahora el número de recogidas de basura completas se reduce a medida que crece el número de objetos en el montón. La nueva lógica sólo realiza una pasada completa de recogida de basura cuando la generación intermedia ha sido recogida 10 veces y cuando el número de objetos supervivientes de la generación intermedia supera el 10% del número de objetos de la generación más antigua.  (Sugerido por Martin von Löwis e implementado por Antoine Pitrou; bpo-4074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4074}.)

@item 
El recolector de basura intenta evitar el seguimiento de contenedores simples que no pueden formar parte de un ciclo. En Python 2.7, esto es ahora cierto para tuplas y diccionarios que contienen tipos atómicos (como enteros, cadenas, etc.). Transitoriamente, un dict que contenga tuplas de tipos atómicos tampoco será rastreado. Esto ayuda a reducir el coste de cada recogida de basura al disminuir el número de objetos que debe considerar y recorrer el recolector. (Contribución de Antoine Pitrou; bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}.)

@item 
Los enteros largos se almacenan ahora internamente en base 2**15 o en base 2**30, determinándose la base en el momento de la construcción.  Anteriormente, siempre se almacenaban en base 2**15.  El uso de la base 2**30 proporciona mejoras significativas en el rendimiento de las máquinas de 64 bits, pero los resultados de las pruebas comparativas en las máquinas de 32 bits han sido contradictorios.  Por lo tanto, el valor por defecto es utilizar la base 2**30 en máquinas de 64 bits y la base 2**15 en máquinas de 32 bits; en Unix, hay una nueva opción de configuración @code{--enable-big-digits} que puede utilizarse para anular este valor por defecto.

Apart from the performance improvements this change should be
invisible to end users, with one exception: for testing and
debugging purposes there’s a new structseq @code{sys.long_info} that
provides information about the internal format, giving the number of
bits per digit and the size in bytes of the C type used to store
each digit:

@example
>>> import sys
>>> sys.long_info
sys.long_info(bits_per_digit=30, sizeof_digit=4)
@end example

(Contribución de Mark Dickinson; bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258}.)

Otro conjunto de cambios hizo que los objetos largos fueran unos pocos bytes más pequeños: 2 bytes menos en sistemas de 32 bits y 6 bytes en los de 64 bits. (Contribución de Mark Dickinson; bpo-5260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5260}.)

@item 
El algoritmo de división de enteros largos se ha hecho más rápido ajustando el bucle interno, haciendo desplazamientos en lugar de multiplicaciones, y arreglando una iteración extra innecesaria. Varias pruebas de referencia muestran un aumento de velocidad de entre el 50% a y el 150% en las divisiones de enteros largos y en las operaciones de módulo. (Contribución de Mark Dickinson; bpo-5512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5512}). Las operaciones a nivel de bit también son significativamente más rápidas (parche inicial de Gregory Smith; bpo-1087418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1087418}).

@item 
La implementación de @code{%} comprueba si el operando de la izquierda es una cadena de Python y lo convierte en un caso especial; esto resulta en un aumento de rendimiento del 1–3% p para aplicaciones que utilizan frecuentemente @code{%} con cadenas, como las bibliotecas de plantillas. (Implementado por Collin Winter; bpo-5176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5176}.)

@item 
Las comprensiones de listas con una condición @code{if} se compilan en código de bytes más rápido.  (Parche de Antoine Pitrou, portado a la 2.7 por Jeffrey Yasskin; bpo-4715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4715})

@item 
La conversión de un entero o un entero largo a una cadena decimal se ha hecho más rápida mediante la conversión en base 10 en lugar de utilizar una función de conversión generalizada que soporta bases arbitrarias. (Parche de Gawain Bolton; bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713}.)

@item 
The @code{split()}, @code{replace()}, @code{rindex()},
@code{rpartition()}, and @code{rsplit()} methods of string-like types
(strings, Unicode strings, and @ref{5e0,,bytearray} objects) now use a
fast reverse-search algorithm instead of a character-by-character
scan.  This is sometimes faster by a factor of 10.  (Added by
Florent Xicluna; bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462} and bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622}.)

@item 
The @ref{a6,,pickle} and @code{cPickle} modules now automatically
intern the strings used for attribute names, reducing memory usage
of the objects resulting from unpickling.  (Contributed by Jake
McGuire; bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084}.)

@item 
The @code{cPickle} module now special-cases dictionaries,
nearly halving the time required to pickle them.
(Contributed by Collin Winter; bpo-5670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5670}.)
@end itemize

@c ======================================================================

@node Módulos nuevos y mejorados,Cambios en la API de construcción y C<2>,Otros cambios de lenguaje<3>,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 new-and-improved-modules}@anchor{1368}
@subsection Módulos nuevos y mejorados


Como en cada versión, la biblioteca estándar de Python ha recibido una serie de mejoras y correcciones de errores.  Aquí hay una lista parcial de los cambios más notables, ordenados alfabéticamente por nombre de módulo. Consulta el archivo @code{Misc/NEWS} en el árbol de código fuente para una lista más completa de cambios, o mira los registros de Subversion para todos los detalles.


@itemize *

@item 
La clase base de depuración del módulo @ref{10,,bdb} @ref{1369,,Bdb} obtuvo una función para omitir módulos.  El constructor ahora toma un iterable que contiene patrones de estilo glob como @code{django.*}; el depurador no entrará en los marcos de pila de un módulo que coincida con uno de estos patrones. (Aportado por Maru Newby tras una sugerencia de Senthil Kumaran; bpo-5142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5142}.)

@item 
El módulo @ref{11,,binascii} soporta ahora la API del buffer, por lo que puede utilizarse con instancias de @ref{156,,memoryview} y otros objetos de buffer similares. (Tomado de la 3.x por Florent Xicluna; bpo-7703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7703}.)

@item 
Updated module: the @code{bsddb} module has been updated from 4.7.2devel9
to version 4.8.4 of
the pybsddb package@footnote{https://www.jcea.es/programacion/pybsddb.htm}.
The new version features better Python 3.x compatibility, various bug fixes,
and adds several new BerkeleyDB flags and methods.
(Updated by Jesús Cea Avión; bpo-8156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8156}.  The pybsddb
changelog can be read at @indicateurl{https://hg.jcea.es/pybsddb/file/tip/ChangeLog}.)

@item 
El módulo @ref{14,,bz2} de @ref{8fd,,BZ2File} ahora soporta el protocolo de gestión de contexto, por lo que se puede escribir @code{con bz2.BZ2File(...) como f:}. (Contribución de Hagen Fürstenau; bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}.)

@item 
Nueva clase: la clase @ref{110e,,Counter} del módulo @ref{1e,,collections} es útil para el recuento de datos. Las instancias de @ref{110e,,Counter} se comportan mayoritariamente como los diccionarios, pero retornan cero si faltan claves en lugar de lanzar un @ref{438,,KeyError}:

@example
>>> from collections import Counter
>>> c = Counter()
>>> for letter in 'here is a sample of english text':
...   c[letter] += 1
...
>>> c 
Counter(@{' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
'p': 1, 'r': 1, 'x': 1@})
>>> c['e']
5
>>> c['z']
0
@end example

Hay tres métodos adicionales de @ref{110e,,Counter}. @ref{136a,,most_common()} retorna los N elementos más comunes y sus recuentos. @ref{136b,,elements()} retorna un iterador sobre los elementos contenidos, repitiendo cada elemento tantas veces como su recuento. @ref{124b,,subtract()} toma un iterable y resta uno por cada elemento en lugar de sumarlo; si el argumento es un diccionario u otra @code{Counter}, los recuentos se restan.

@example
>>> c.most_common(5)
[(' ', 6), ('e', 5), ('s', 3), ('a', 2), ('i', 2)]
>>> c.elements() ->
   'a', 'a', ' ', ' ', ' ', ' ', ' ', ' ',
   'e', 'e', 'e', 'e', 'e', 'g', 'f', 'i', 'i',
   'h', 'h', 'm', 'l', 'l', 'o', 'n', 'p', 's',
   's', 's', 'r', 't', 't', 'x'
>>> c['e']
5
>>> c.subtract('very heavy on the letter e')
>>> c['e']    # Count is now lower
-1
@end example

Contribución de Raymond Hettinger; bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199}.

@c revision 79660

Nueva clase: @ref{67c,,OrderedDict} se describe en la sección anterior @ref{1350,,PEP 372; Adición de un diccionario ordenado a las colecciones}.

Nuevo método: El tipo de datos @ref{67d,,deque} tiene ahora un método @ref{124d,,count()} que retorna el número de elementos contenidos igual al argumento suministrado `x', y un método @ref{124e,,reverse()} que invierte los elementos del deque en su lugar. @ref{67d,,deque} también expone su longitud máxima como el atributo de sólo lectura @ref{136c,,maxlen}. (Ambas características han sido añadidas por Raymond Hettinger)

La clase @ref{32d,,namedtuple} tiene ahora un parámetro opcional `rename'. Si `rename' es verdadero, los nombres de campo que no son válidos porque se han repetido o no son identificadores legales de Python serán renombrados a nombres legales que se derivan de la posición del campo dentro de la lista de campos:

@example
>>> from collections import namedtuple
>>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
>>> T._fields
('field1', '_1', '_2', 'field2')
@end example

(Añadido por Raymond Hettinger; bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818}.)

Finally, the @ref{961,,Mapping} abstract base class now
returns @ref{227,,NotImplemented} if a mapping is compared to
another type that isn’t a @code{Mapping}.
(Fixed by Daniel Stutzbach; bpo-8729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8729}.)

@item 
Constructors for the parsing classes in the @ref{23,,ConfigParser} module now
take an `allow_no_value' parameter, defaulting to false; if true,
options without values will be allowed.  For example:

@example
>>> import ConfigParser, StringIO
>>> sample_config = """
... [mysqld]
... user = mysql
... pid-file = /var/run/mysqld/mysqld.pid
... skip-bdb
... """
>>> config = ConfigParser.RawConfigParser(allow_no_value=True)
>>> config.readfp(StringIO.StringIO(sample_config))
>>> config.get('mysqld', 'user')
'mysql'
>>> print config.get('mysqld', 'skip-bdb')
None
>>> print config.get('mysqld', 'unknown')
Traceback (most recent call last):
  ...
NoOptionError: No option 'unknown' in section: 'mysqld'
@end example

(Contribución de Mats Kindahl; bpo-7005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7005}.)

@item 
Deprecated function: @code{contextlib.nested()}, which allows
handling more than one context manager with a single @ref{673,,with}
statement, has been deprecated, because the @code{with} statement
now supports multiple context managers.

@item 
The @ref{70,,cookielib} module now ignores cookies that have an invalid
version field, one that doesn’t contain an integer value.  (Fixed by
John J. Lee; bpo-3924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3924}.)

@item 
La función @ref{bf6,,deepcopy()} del módulo @ref{26,,copy} ahora copiará correctamente los métodos de instancia vinculados.  (Implementado por Robert Collins; bpo-1515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1515}.)

@item 
El módulo @ref{2b,,ctypes} ahora convierte siempre @code{None} a un puntero C @code{NULL} para los argumentos declarados como punteros.  (Cambiado por Thomas Heller; bpo-4606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4606}.) La biblioteca subyacente libffi@footnote{https://sourceware.org/libffi/} ha sido actualizada a la versión 3.0.9, que contiene varias correcciones para diferentes plataformas.  (Actualizado por Matthias Klose; bpo-8142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8142}.)

@item 
Nuevo método: la clase @ref{a61,,timedelta} del módulo @ref{31,,datetime} ha ganado un método @ref{136d,,total_seconds()} que retorna el número de segundos de la duración.  (Contribución de Brian Quinlan; bpo-5788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5788}.)

@item 
New method: the @ref{16a,,Decimal} class gained a
@ref{1271,,from_float()} class method that performs an exact
conversion of a floating-point number to a @code{Decimal}.
This exact conversion strives for the
closest decimal approximation to the floating-point representation’s value;
the resulting decimal value will therefore still include the inaccuracy,
if any.
For example, @code{Decimal.from_float(0.1)} returns
@code{Decimal('0.1000000000000000055511151231257827021181583404541015625')}.
(Implemented by Raymond Hettinger; bpo-4796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4796}.)

Comparing instances of @ref{16a,,Decimal} with floating-point
numbers now produces sensible results based on the numeric values
of the operands.  Previously such comparisons would fall back to
Python’s default rules for comparing objects, which produced arbitrary
results based on their type.  Note that you still cannot combine
@code{Decimal} and floating point in other operations such as addition,
since you should be explicitly choosing how to convert between float and
@code{Decimal}.  (Fixed by Mark Dickinson; bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531}.)

El constructor de @ref{16a,,Decimal} acepta ahora números en coma flotante (añadido por Raymond Hettinger; bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}) y caracteres Unicode no europeos, como los dígitos arábigos-índicos (contribución de Mark Dickinson; bpo-6595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6595}).

La mayoría de los métodos de la clase @ref{1124,,Context} ahora aceptan enteros así como instancias de @ref{16a,,Decimal}; las únicas excepciones son los métodos @ref{136e,,canonical()} y @ref{136f,,is_canonical()}.  (Parche de Juan José Conti; bpo-7633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7633}.)

Cuando se utilizan instancias @ref{16a,,Decimal} con el método @ref{6c2,,format()} de una cadena, la alineación por defecto era antes la izquierda.  Esto se ha cambiado a la alineación derecha, que es más sensible para los tipos numéricos.  (Cambiado por Mark Dickinson; bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857}.)

Las comparaciones que implican un valor NaN de señalización (o @code{sNAN}) señalan ahora @ref{111f,,InvalidOperation} en lugar de retornar silenciosamente un valor verdadero o falso dependiendo del operador de comparación.  Los valores NaN silenciosos (o @code{NaN}) son ahora hashable.  (Corregido por Mark Dickinson; bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279}.)

@item 
El módulo @ref{38,,difflib} produce ahora una salida más compatible con las herramientas modernas @code{diff}/@code{patch} mediante un pequeño cambio, utilizando un carácter de tabulación en lugar de espacios como separador en la cabecera que da el nombre del fichero.  (Corregido por Anatoly Techtonik; bpo-7585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7585}.)

@item 
El comando Distutils @code{sdist} ahora siempre regenera el archivo @code{MANIFEST}, ya que aunque los archivos @code{MANIFEST.in} o @code{setup.py} no hayan sido modificados, el usuario podría haber creado algunos archivos nuevos que deberían ser incluidos. (Corregido por Tarek Ziadé; bpo-8688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8688}.)

@item 
The @ref{3b,,doctest} module’s @ref{1370,,IGNORE_EXCEPTION_DETAIL} flag
will now ignore the name of the module containing the exception
being tested.  (Patch by Lennart Regebro; bpo-7490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7490}.)

@item 
The @ref{3c,,email} module’s @ref{3d1,,Message} class will
now accept a Unicode-valued payload, automatically converting the
payload to the encoding specified by @code{output_charset}.
(Added by R. David Murray; bpo-1368247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1368247}.)

@item 
La clase @ref{177,,Fraction} acepta ahora una instancia de float o @ref{16a,,Decimal}, o dos números racionales, como argumentos para su constructor.  (Implementado por Mark Dickinson; los racionales se añadieron en bpo-5812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5812}, y float/decimal en bpo-8294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8294})

Las comparaciones de ordenación (@code{<}, @code{<=}, @code{>}, @code{>=}) entre fracciones y números complejos ahora lanzan un @ref{228,,TypeError}. Esto corrige un descuido, haciendo que la @ref{177,,Fraction} coincida con los otros tipos numéricos.

@c revision 79455

@item 
Nueva clase: @ref{991,,FTP_TLS} en el módulo @ref{5e,,ftplib} proporciona conexiones FTP seguras utilizando la encapsulación TLS de la autenticación, así como las posteriores transferencias de control y datos. (Contribuido por Giampaolo Rodola; bpo-2054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2054}.)

El método @ref{1371,,storbinary()} para subidas binarias puede ahora reiniciar las subidas gracias a un parámetro `rest' añadido (parche de Pablo Mouzo; bpo-6845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6845})

@item 
New class decorator: @ref{fc2,,total_ordering()} in the @ref{5f,,functools}
module takes a class that defines an @ref{b85,,__eq__()} method and one of
@ref{1372,,__lt__()}, @ref{1373,,__le__()}, @ref{1374,,__gt__()}, or @ref{1375,,__ge__()},
and generates the missing comparison methods.  Since the
@code{__cmp__()} method is being deprecated in Python 3.x,
this decorator makes it easier to define ordered classes.
(Added by Raymond Hettinger; bpo-5479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5479}.)

Nueva función: @ref{1247,,cmp_to_key()} tomará una función de comparación de estilo antiguo que espera dos argumentos y retornará una nueva llamada que puede usarse como parámetro `clave' para funciones como @ref{c56,,sorted()}, @ref{f8b,,min()} y @ref{f8c,,max()}, etc.  El principal uso previsto es ayudar a hacer el código compatible con Python 3.x. (Añadido por Raymond Hettinger.)

@item 
Nueva función: la @ref{60,,gc()} del módulo @ref{1376,,is_tracked} retorna true si una instancia dada es rastreada por el recolector de basura, false en caso contrario. (Contribución de Antoine Pitrou; bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}.)

@item 
El módulo @ref{67,,gzip} @ref{4d8,,GzipFile} soporta ahora el protocolo de gestión de contexto, por lo que se puede escribir @code{con gzip.GzipFile(...) como f:} (contribución de Hagen Fürstenau; bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}), y ahora implementa el ABC de @ref{735,,io.BufferedIOBase}, por lo que se puede envolver con @ref{127b,,io.BufferedReader} para un procesamiento más rápido (contribución de Nir Aides; bpo-7471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7471}). Ahora también es posible anular la hora de modificación registrada en un archivo gzipped proporcionando una marca de tiempo opcional al constructor.  (Contribución de Jacques Frechet; bpo-4272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4272}.)

Los archivos en formato gzip pueden ser rellenados con bytes cero al final; el módulo @ref{67,,gzip} ahora consumirá estos bytes al final.  (Corregido por Tadek Pietraszek y Brian Curtin; bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846})

@item 
New attribute: the @ref{68,,hashlib} module now has an @code{algorithms}
attribute containing a tuple naming the supported algorithms.
In Python 2.7, @code{hashlib.algorithms} contains
@code{('md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512')}.
(Contributed by Carl Chenet; bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418}.)

@item 
The default @ref{1142,,HTTPResponse} class used by the @ref{6e,,httplib} module now
supports buffering, resulting in much faster reading of HTTP responses.
(Contributed by Kristján Valur Jónsson; bpo-4879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4879}.)

The @ref{bc8,,HTTPConnection} and @ref{bc9,,HTTPSConnection} classes
now support a `source_address' parameter, a @code{(host, port)} 2-tuple
giving the source address that will be used for the connection.
(Contributed by Eldon Ziegler; bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}.)

@item 
The @code{ihooks} module now supports relative imports.  Note that
@code{ihooks} is an older module for customizing imports,
superseded by the @code{imputil} module added in Python 2.0.
(Relative import support added by Neil Schemenauer.)

@c revision 75423

@item 
El módulo @ref{74,,imaplib} ahora soporta direcciones IPv6. (Contribución de Derek Morr; bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655}.)

@item 
Nueva función: la @ref{f3e,,getcallargs()} del módulo @ref{7e,,inspect} toma una llamada y sus argumentos posicionales y de palabra clave, y calcula qué parámetros de la llamada recibirán cada argumento, retornando un diccionario que asigna los nombres de los argumentos a sus valores.  Por ejemplo:

@example
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
...     pass
...
>>> getcallargs(f, 1, 2, 3)
@{'a': 1, 'b': 2, 'pos': (3,), 'named': @{@}@}
>>> getcallargs(f, a=2, x=4)
@{'a': 2, 'b': 1, 'pos': (), 'named': @{'x': 4@}@}
>>> getcallargs(f)
Traceback (most recent call last):
...
TypeError: f() takes at least 1 argument (0 given)
@end example

Contribución de George Sakkis; bpo-3135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3135}.

@item 
Updated module: The @ref{7f,,io} library has been upgraded to the version shipped with
Python 3.1.  For 3.1, the I/O library was entirely rewritten in C
and is 2 to 20 times faster depending on the task being performed.  The
original Python version was renamed to the @code{_pyio} module.

One minor resulting change: the @ref{736,,io.TextIOBase} class now
has an @ref{1377,,errors} attribute giving the error setting
used for encoding and decoding errors (one of @code{'strict'}, @code{'replace'},
@code{'ignore'}).

La clase @ref{1378,,io.FileIO} ahora lanza un @ref{4d5,,OSError} cuando se le pasa un descriptor de fichero no válido.  (Implementado por Benjamin Peterson; bpo-4991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4991}.) El método @ref{1379,,truncate()} ahora preserva la posición del archivo; antes cambiaba la posición del archivo al final del nuevo archivo.  (Corregido por Pascal Chambon; bpo-6939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6939}.)

@item 
Nueva función: @code{itertools.compress(data, selectors)} toma dos iteradores.  Los elementos de `datos' se retornan si el valor correspondiente en `selectores' es verdadero:

@example
itertools.compress('ABCDEF', [1,0,1,0,1,1]) =>
  A, C, E, F
@end example

@c maybe here is better to use >>> list(itertools.compress(...)) instead

Nueva función: @code{itertools.combinations_with_replacement(iter, r)} retorna todas las posibles combinaciones de elementos de longitud `r' del iterable `iter'.  A diferencia de @ref{137a,,combinations()}, los elementos individuales pueden repetirse en las combinaciones generadas:

@example
itertools.combinations_with_replacement('abc', 2) =>
  ('a', 'a'), ('a', 'b'), ('a', 'c'),
  ('b', 'b'), ('b', 'c'), ('c', 'c')
@end example

Tenga en cuenta que los elementos se tratan como únicos en función de su posición en la entrada, no de sus valores reales.

La función @ref{12f0,,itertools.count()} tiene ahora un argumento `step' que permite incrementar por valores distintos de 1. @ref{12f0,,count()} también permite ahora argumentos de palabra clave, y utilizar valores no enteros como números de punto flotante o instancias de @ref{16a,,Decimal}.  (Implementado por Raymond Hettinger; bpo-5032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5032}.)

@code{itertools.combinaciones()} y @code{itertools.producto()} anteriormente lanzaban @ref{360,,ValueError} para valores de `r' mayores que el iterable de entrada.  Esto se consideraba un error de especificación, por lo que ahora retornan un iterador vacío.  (Corregido por Raymond Hettinger; bpo-4816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4816}.)

@item 
Módulo actualizado: El módulo @ref{82,,json} ha sido actualizado a la versión 2.0.9 del paquete simplejson, que incluye una extensión en C que hace más rápida la codificación y decodificación. (Contribuido por Bob Ippolito; bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136}.)

Para soportar el nuevo tipo @ref{67c,,collections.OrderedDict}, @ref{d3d,,json.load()} tiene ahora un parámetro opcional `object_pairs_hook' que será llamado con cualquier objeto literal que decodifique a una lista de pares. (Contribución de Raymond Hettinger; bpo-5381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5381}.)

@item 
La clase @ref{8b,,mailbox} del módulo @ref{4da,,Maildir} ahora registra la marca de tiempo de los directorios que lee, y sólo los relee si la hora de modificación ha cambiado posteriormente.  Esto mejora el rendimiento al evitar escaneos innecesarios de directorios.  (Corregido por A.M. Kuchling y Antoine Pitrou; bpo-1607951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1607951}, bpo-6896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6896})

@item 
Nuevas funciones: el módulo @ref{8e,,math} ganó @ref{c60,,erf()} y @ref{c61,,erfc()} para la función de error y la función de error complementaria, @ref{1259,,expm1()} que calcula @code{e**x - 1} con más precisión que usando @ref{137b,,exp()} y restando 1, @ref{125a,,gamma()} para la función Gamma, y @ref{125b,,lgamma()} para el logaritmo natural de la función Gamma. (Contribución de Mark Dickinson y nirinA raseliarison; bpo-3366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3366}.)

@item 
The @ref{94,,multiprocessing} module’s @code{Manager*} classes
can now be passed a callable that will be called whenever
a subprocess is started, along with a set of arguments that will be
passed to the callable.
(Contributed by lekma; bpo-5585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5585}.)

The @ref{137c,,Pool} class, which controls a pool of worker processes,
now has an optional `maxtasksperchild' parameter.  Worker processes
will perform the specified number of tasks and then exit, causing the
@code{Pool} to start a new worker.  This is useful if tasks may leak
memory or other resources, or if some tasks will cause the worker to
become very large.
(Contributed by Charles Cazabon; bpo-6963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6963}.)

@item 
The @code{nntplib} module now supports IPv6 addresses.
(Contributed by Derek Morr; bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664}.)

@item 
Nuevas funciones: el módulo @ref{a1,,os} envuelve las siguientes llamadas al sistema POSIX: @ref{137d,,getresgid()} y @ref{137e,,getresuid()}, que retornan los GIDs y UIDs reales, efectivos y guardados; @ref{137f,,setresgid()} y @ref{1380,,setresuid()}, que establecen los GIDs y UIDs reales, efectivos y guardados a nuevos valores; @ref{1381,,initgroups()}, que inicializan la lista de acceso a grupos para el proceso actual.  (Funciones GID/UID contribuidas por Travis H.; bpo-6508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6508}.  Soporte para initgroups añadido por Jean-Paul Calderone; bpo-7333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7333})

La función @ref{2ff,,os.fork()} ahora reinicializa el bloqueo de importación en el proceso hijo; esto soluciona los problemas en Solaris cuando @ref{2ff,,fork()} se llama desde un hilo.  (Corregido por Zsolt Cserna; bpo-7242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7242}.)

@item 
En el módulo @ref{a2,,os.path}, las funciones @ref{1382,,normpath()} y @ref{1383,,abspath()} ahora preservan Unicode; si su ruta de entrada es una cadena Unicode, el valor de retorno es también una cadena Unicode. (@ref{1382,,normpath()} arreglado por Matt Giuca en bpo-5827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5827}; @ref{1383,,abspath()} arreglado por Ezio Melotti en bpo-3426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3426})

@item 
El módulo @ref{b5,,pydoc} tiene ahora ayuda para los distintos símbolos que utiliza Python.  Ahora puedes hacer @code{help('<<')} o @code{help('@@')}, por ejemplo. (Contribución de David Laban; bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739}.)

@item 
Las funciones @ref{b9,,re} del módulo @ref{3f1,,split()}, @ref{3f2,,sub()} y @ref{3f3,,subn()} aceptan ahora un argumento opcional `flags', por coherencia con las demás funciones del módulo.  (Añadido por Gregory P. Smith)

@item 
Nueva función: @ref{2ec,,run_path()} en el módulo @ref{be,,runpy} ejecutará el código en un argumento `ruta' proporcionado.  `path' puede ser la ruta de un fichero fuente de Python (@code{ejemplo.py}), un fichero bytecode compilado (@code{ejemplo.pyc}), un directorio (@code{./package/}), o un archivo zip (@code{ejemplo.zip}).  Si se proporciona un directorio o una ruta zip, se añadirá al frente de @code{sys.path} y se importará el módulo @ref{1,,__main__}.  Se espera que el directorio o zip contenga un @code{__main__.py}; si no es así, algún otro @code{__main__.py} podría ser importado desde una ubicación posterior en @code{sys.path}.  Esto hace que más de la maquinaria de @ref{be,,runpy} esté disponible para los scripts que quieran imitar la forma en que la línea de comandos de Python procesa un nombre de ruta explícito. (Añadido por Nick Coghlan; bpo-6816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6816}.)

@item 
Nueva función: en el módulo @ref{c5,,shutil}, @ref{55a,,make_archive()} toma un nombre de fichero, un tipo de archivo (formato zip o tar) y una ruta de directorio, y crea un archivo con el contenido del directorio. (Añadido por Tarek Ziadé.)

Las funciones @ref{c5,,shutil} @ref{aea,,copyfile()} y @ref{abb,,copytree()} ahora lanzan una excepción @code{SpecialFileError} cuando se les pide que copien una tubería con nombre.  Anteriormente, el código trataba las tuberías con nombre como un archivo normal, abriéndolas para su lectura, lo que bloqueaba indefinidamente.  (Corregido por Antoine Pitrou; bpo-3002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3002}.)

@item 
El módulo @ref{c6,,signal} ya no reinstala el manejador de señales a menos que sea realmente necesario, lo que corrige un error que podía hacer imposible atrapar la señal EINTR de forma robusta.  (Corregido por Charles-Francois Natali; bpo-8354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8354}.)

@item 
New functions: in the @ref{c7,,site} module, three new functions
return various site- and user-specific paths.
@ref{12ab,,getsitepackages()} returns a list containing all
global site-packages directories,
@ref{12ad,,getusersitepackages()} returns the path of the user’s
site-packages directory, and
@ref{12ac,,getuserbase()} returns the value of the @ref{1384,,USER_BASE}
environment variable, giving the path to a directory that can be used
to store data.
(Contributed by Tarek Ziadé; bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693}.)

El módulo @ref{c7,,site} ahora informa de las excepciones que se producen cuando se importa el módulo @ref{c8,,sitecustomize}, y ya no atrapará y tragará la excepción @ref{a63,,KeyboardInterrupt}.  (Corregido por Victor Stinner; bpo-3137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3137}.)

@item 
La función @ref{713,,create_connection()} ganó un parámetro `dirección_de_origen', una 2-tupla @code{(host, port)} que da la dirección de origen que se utilizará para la conexión. (Contribuido por Eldon Ziegler; bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}.)

Los métodos @ref{1385,,recv_into()} y @ref{1386,,recvfrom_into()} ahora escribirán en objetos que soporten la API de búfer, más útilmente los objetos @ref{5e0,,bytearray} y @ref{156,,memoryview}.  (Implementado por Antoine Pitrou; bpo-8104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8104}.)

@item 
The @ref{cd,,SocketServer} module’s @ref{1387,,TCPServer} class now
supports socket timeouts and disabling the Nagle algorithm.
The @code{disable_nagle_algorithm} class attribute
defaults to @code{False}; if overridden to be true,
new request connections will have the TCP_NODELAY option set to
prevent buffering many small sends into a single TCP packet.
The @ref{1388,,timeout} class attribute can hold
a timeout in seconds that will be applied to the request socket; if
no request is received within that time, @ref{1389,,handle_timeout()}
will be called and @ref{138a,,handle_request()} will return.
(Contributed by Kristján Valur Jónsson; bpo-6192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6192} and bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}.)

@item 
Módulo actualizado: el módulo @ref{cf,,sqlite3} ha sido actualizado a la versión 2.6.0 del paquete pysqlite@footnote{https://github.com/ghaering/pysqlite}. La versión 2.6.0 incluye una serie de correcciones de errores y añade la posibilidad de cargar extensiones de SQLite desde bibliotecas compartidas. Llame al método @code{enable_load_extension(True)} para habilitar las extensiones, y luego llame a @ref{55f,,load_extension()} para cargar una biblioteca compartida en particular. (Actualizado por Gerhard Häring.)

@item 
The @ref{d0,,ssl} module’s @ref{981,,SSLSocket} objects now support the
buffer API, which fixed a test suite failure (fix by Antoine Pitrou;
bpo-7133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7133}) and automatically set
OpenSSL’s @code{SSL_MODE_AUTO_RETRY}, which will prevent an error
code being returned from @code{recv()} operations that trigger an SSL
renegotiation (fix by Antoine Pitrou; bpo-8222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8222}).

The @ref{5c8,,wrap_socket()} constructor function now takes a
`ciphers' argument that’s a string listing the encryption algorithms
to be allowed; the format of the string is described
in the OpenSSL documentation@footnote{https://docs.openssl.org/1.0.2/man1/ciphers/}.
(Added by Antoine Pitrou; bpo-8322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8322}.)

Otro cambio hace que la extensión cargue todos los cifrados y algoritmos de compendio de OpenSSL para que estén todos disponibles.  Algunos certificados SSL no podían ser verificados, reportando un error de «algoritmo desconocido».  (Informado por Beda Kosata, y corregido por Antoine Pitrou; bpo-8484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8484})

The version of OpenSSL being used is now available as the module
attributes @ref{128b,,ssl.OPENSSL_VERSION} (a string),
@ref{128c,,ssl.OPENSSL_VERSION_INFO} (a 5-tuple), and
@ref{128d,,ssl.OPENSSL_VERSION_NUMBER} (an integer).  (Added by Antoine
Pitrou; bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321}.)

@item 
The @ref{d5,,struct} module will no longer silently ignore overflow
errors when a value is too large for a particular integer format
code (one of @code{bBhHiIlLqQ}); it now always raises a
@ref{138b,,struct.error} exception.  (Changed by Mark Dickinson;
bpo-1523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1523}.)  The @ref{12e4,,pack()} function will also
attempt to use @ref{22b,,__index__()} to convert and pack non-integers
before trying the @ref{22a,,__int__()} method or reporting an error.
(Changed by Mark Dickinson; bpo-8300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8300}.)

@item 
Nueva función: la función @ref{1040,,check_output()} del módulo @ref{d6,,subprocess} ejecuta un comando con un conjunto de argumentos especificado y retorna la salida del comando como una cadena de texto cuando el comando se ejecuta sin errores, o lanza una excepción @ref{138c,,CalledProcessError} en caso contrario.

@example
>>> subprocess.check_output(['df', '-h', '.'])
'Filesystem     Size   Used  Avail Capacity  Mounted on\n
/dev/disk0s2    52G    49G   3.0G    94%    /\n'

>>> subprocess.check_output(['df', '-h', '/bogus'])
  ...
subprocess.CalledProcessError: Command '['df', '-h', '/bogus']' returned non-zero exit status 1
@end example

(Contribución de Gregory P. Smith.)

The @ref{d6,,subprocess} module will now retry its internal system calls
on receiving an @ref{e0d,,EINTR} signal.  (Reported by several people; final
patch by Gregory P. Smith in bpo-1068268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1068268}.)

@item 
Nueva función: @ref{138d,,is_declared_global()} en el módulo @ref{d8,,symtable} retorna true para las variables declaradas explícitamente como globales, false para las que son implícitamente globales. (Contribución de Jeremy Hylton)

@item 
El módulo @ref{dc,,syslog} utilizará ahora el valor de @code{sys.argv[0]} como identificador en lugar del anterior valor por defecto de @code{'python}. (Cambiado por Sean Reifschneider; bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}.)

@item 
The @ref{741,,sys.version_info} value is now a named tuple, with attributes
named @code{major}, @code{minor}, @code{micro},
@code{releaselevel}, and @code{serial}.  (Contributed by Ross
Light; bpo-4285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4285}.)

@ref{d6e,,sys.getwindowsversion()} also returns a named tuple,
with attributes named @code{major}, @code{minor}, @code{build},
@code{platform}, @code{service_pack}, @code{service_pack_major},
@code{service_pack_minor}, @code{suite_mask}, and
@code{product_type}.  (Contributed by Brian Curtin; bpo-7766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7766}.)

@item 
El manejo de errores por defecto del módulo @ref{de,,tarfile} ha cambiado, para no suprimir los errores fatales.  El nivel de error por defecto era antes 0, lo que significaba que los errores sólo daban lugar a que se escribiera un mensaje en el registro de depuración, pero como el registro de depuración no está activado por defecto, estos errores pasan desapercibidos.  El nivel de error por defecto es ahora 1, que lanza una excepción si hay un error. (Cambiado por Lars Gustäbel; bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}.)

@ref{de,,tarfile} ahora soporta el filtrado de los objetos @ref{127e,,TarInfo} que se añaden a un fichero tar.  Cuando llame a @ref{c7b,,add()}, puede suministrar un argumento opcional `filtro' que es una llamada.  Al `filtro' se le pasará la clase @ref{127e,,TarInfo} de cada fichero que se añada, y podrá modificarlo y retornarlo. Si la llamada retorna @code{Nada}, el fichero será excluido del archivo resultante.  Esto es más potente que el argumento `exclude' existente, que por lo tanto ha sido obviado. (Añadido por Lars Gustäbel; bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856}.) La clase @ref{127d,,TarFile} también soporta ahora el protocolo de gestión de contexto. (Añadido por Lars Gustäbel; bpo-7232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7232}.)

@item 
El método @ref{138e,,wait()} de la clase @ref{11c9,,threading.Event} ahora retorna la bandera interna al salir.  Esto significa que el método normalmente retornará true porque @ref{138e,,wait()} se supone que bloquea hasta que la bandera interna se convierte en true.  El valor de retorno sólo será falso si se proporcionó un tiempo de espera y la operación expiró. (Contribuido por Tim Lesher; bpo-1674032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1674032}.)

@item 
La base de datos Unicode proporcionada por el módulo @ref{105,,unicodedata} se utiliza ahora internamente para determinar qué caracteres son numéricos, espacios en blanco o representan saltos de línea.  La base de datos también incluye información del archivo de datos @code{Unihan.txt} (parche de Anders Chrigström y Amaury Forgeot d’Arc; bpo-1571184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1571184}) y se ha actualizado a la versión 5.2.0 (actualizado por Florent Xicluna; bpo-8024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8024}).

@item 
The @ref{10a,,urlparse} module’s @ref{dc6,,urlsplit()} now handles
unknown URL schemes in a fashion compliant with 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}: if the
URL is of the form @code{"<something>://..."}, the text before the
@code{://} is treated as the scheme, even if it’s a made-up scheme that
the module doesn’t know about.  This change may break code that
worked around the old behaviour.  For example, Python 2.6.4 or 2.5
will return the following:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7 (y Python 2.6.5) retornará:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

(Python 2.7 en realidad produce una salida ligeramente diferente, ya que retorna una tupla con nombre en lugar de una tupla estándar)

The @ref{10a,,urlparse} module also supports IPv6 literal addresses as defined by
@geindex RFC; RFC 2732
RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} (contributed by Senthil Kumaran; bpo-2987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2987}).

@example
>>> urlparse.urlparse('http://[1080::8:800:200C:417A]/foo')
ParseResult(scheme='http', netloc='[1080::8:800:200C:417A]',
            path='/foo', params='@w{'}, query='@w{'}, fragment='@w{'})
@end example

@item 
Nueva clase: la clase @ref{67e,,WeakSet} del módulo @ref{114,,weakref} es un conjunto que sólo contiene referencias débiles a sus elementos; los elementos serán eliminados una vez que no haya referencias que apunten a ellos. (Implementado originalmente en Python 3.x por Raymond Hettinger, y Portado a 2.7 por Michael Foord)

@item 
The @ref{125,,xml.etree.ElementTree} library, no longer escapes
ampersands and angle brackets when outputting an XML processing
instruction (which looks like @code{<?xml-stylesheet href="#style1"?>})
or comment (which looks like @code{<!-- comment -->}).
(Patch by Neil Muller; bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}.)

@item 
The XML-RPC client and server, provided by the @ref{12d,,xmlrpclib} and
@ref{12e,,SimpleXMLRPCServer} modules, have improved performance by
supporting HTTP/1.1 keep-alive and by optionally using gzip encoding
to compress the XML being exchanged.  The gzip compression is
controlled by the @code{encode_threshold} attribute of
@ref{138f,,SimpleXMLRPCRequestHandler}, which contains a size in bytes;
responses larger than this will be compressed.
(Contributed by Kristján Valur Jónsson; bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}.)

@item 
El módulo @ref{130,,zipfile} de @ref{765,,ZipFile} soporta ahora el protocolo de gestión de contexto, por lo que se puede escribir @code{con zipfile.ZipFile(...) como f:}. (Contribución de Brian Curtin; bpo-5511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5511}.)

@ref{130,,zipfile} now also supports archiving empty directories and
extracts them correctly.  (Fixed by Kuba Wieczorek; bpo-4710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4710}.)
Reading files out of an archive is faster, and interleaving
@ref{1390,,read()} and
@ref{1391,,readline()} now works correctly.
(Contributed by Nir Aides; bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610}.)

La función @ref{1392,,is_zipfile()} acepta ahora un objeto archivo, además de los nombres de ruta aceptados en versiones anteriores.  (Contribución de Gabriel Genellina; bpo-4756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4756}.)

El método @code{writestr()} tiene ahora un parámetro opcional `compress_type' que permite anular el método de compresión por defecto especificado en el constructor @code{ZipFile}.  (Contribución de Ronald Oussoren; bpo-6003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6003}.)
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@menu
* Nuevo módulo; importlib: Nuevo módulo importlib. 
* Nuevo módulo; sysconfig: Nuevo módulo sysconfig. 
* ttk; Widgets temáticos para Tk: ttk Widgets temáticos para Tk. 
* Módulo actualizado; unittest: Módulo actualizado unittest. 
* Módulo actualizado; ElementTree 1.3: Módulo actualizado ElementTree 1 3. 

@end menu

@node Nuevo módulo importlib,Nuevo módulo sysconfig,,Módulos nuevos y mejorados
@anchor{whatsnew/2 7 importlib-section}@anchor{1352}@anchor{whatsnew/2 7 new-module-importlib}@anchor{1393}
@subsubsection Nuevo módulo: importlib


Python 3.1 includes the @ref{77,,importlib} package, a re-implementation
of the logic underlying Python’s @ref{682,,import} statement.
@ref{77,,importlib} is useful for implementers of Python interpreters and
to users who wish to write new importers that can participate in the
import process.  Python 2.7 doesn’t contain the complete
@ref{77,,importlib} package, but instead has a tiny subset that contains
a single function, @ref{5bc,,import_module()}.

@code{import_module(name, package=None)} importa un módulo.  `name' es una cadena que contiene el nombre del módulo o paquete.  Es posible realizar importaciones relativas proporcionando una cadena que comience con un carácter @code{.}, como @code{..utils.errors}.  Para las importaciones relativas, el argumento `paquete' debe ser proporcionado y es el nombre del paquete que se utilizará como ancla para la importación relativa. @ref{5bc,,import_module()} inserta el módulo importado en @code{sys.modules} y retorna el objeto módulo.

He aquí algunos ejemplos:

@example
>>> from importlib import import_module
>>> anydbm = import_module('anydbm')  # Standard absolute import
>>> anydbm
<module 'anydbm' from '/p/python/Lib/anydbm.py'>
>>> # Relative import
>>> file_util = import_module('..file_util', 'distutils.command')
>>> file_util
<module 'distutils.file_util' from '/python/Lib/distutils/file_util.pyc'>
@end example

@ref{77,,importlib} fue implementado por Brett Cannon e introducido en Python 3.1.

@node Nuevo módulo sysconfig,ttk Widgets temáticos para Tk,Nuevo módulo importlib,Módulos nuevos y mejorados
@anchor{whatsnew/2 7 new-module-sysconfig}@anchor{1394}
@subsubsection Nuevo módulo: sysconfig


El módulo @ref{db,,sysconfig} ha sido retirado del paquete Distutils, convirtiéndose en un nuevo módulo de alto nivel por derecho propio. @ref{db,,sysconfig} proporciona funciones para obtener información sobre el proceso de construcción de Python: interruptores del compilador, rutas de instalación, el nombre de la plataforma y si Python se está ejecutando desde su directorio fuente.

Algunas de las funciones del módulo son:


@itemize *

@item 
@ref{10a7,,get_config_var()} retorna variables del Makefile de Python y del fichero @code{pyconfig.h}.

@item 
@ref{10a8,,get_config_vars()} retorna un diccionario que contiene todas las variables de configuración.

@item 
@ref{1395,,get_path()} retorna la ruta configurada para un tipo de módulo concreto: la biblioteca estándar, módulos específicos del sitio, módulos específicos de la plataforma, etc.

@item 
@ref{1fc,,is_python_build()} retorna true si está ejecutando un binario desde un árbol de fuentes de Python, y false en caso contrario.
@end itemize

Consulte la documentación de @ref{db,,sysconfig} para más detalles y para una lista completa de funciones.

El paquete Distutils y @ref{db,,sysconfig} son ahora mantenidos por Tarek Ziadé, que también ha iniciado un paquete Distutils2 (repositorio de fuentes en @indicateurl{https://hg.python.org/distutils2/}) para desarrollar una versión de próxima generación de Distutils.

@node ttk Widgets temáticos para Tk,Módulo actualizado unittest,Nuevo módulo sysconfig,Módulos nuevos y mejorados
@anchor{whatsnew/2 7 ttk-themed-widgets-for-tk}@anchor{1396}
@subsubsection ttk: Widgets temáticos para Tk


Tcl/Tk 8.5 incluye un conjunto de widgets temáticos que reimplementan los widgets básicos de Tk pero tienen una apariencia más personalizable y, por tanto, pueden parecerse más a los widgets de la plataforma nativa.  Este conjunto de widgets se llamaba originalmente Tile, pero fue renombrado a Ttk (por «Tk temático») al ser añadido a la versión 8.5 de Tcl/Tck.

To learn more, read the @ref{f9,,ttk} module documentation.  You may also
wish to read the Tcl/Tk manual page describing the
Ttk theme engine, available at
@indicateurl{https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.html}. Some
screenshots of the Python/Ttk code in use are at
@indicateurl{https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki}.

The @ref{f9,,tkinter.ttk} module was written by Guilherme Polo and added in
bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983}.  An alternate version called @code{Tile.py}, written by
Martin Franklin and maintained by Kevin Walzer, was proposed for
inclusion in bpo-2618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2618}, but the authors argued that Guilherme
Polo’s work was more comprehensive.

@node Módulo actualizado unittest,Módulo actualizado ElementTree 1 3,ttk Widgets temáticos para Tk,Módulos nuevos y mejorados
@anchor{whatsnew/2 7 unittest-section}@anchor{1397}@anchor{whatsnew/2 7 updated-module-unittest}@anchor{1398}
@subsubsection Módulo actualizado: unittest


The @ref{106,,unittest} module was greatly enhanced; many
new features were added.  Most of these features were implemented
by Michael Foord, unless otherwise noted.  The enhanced version of
the module is downloadable separately for use with Python versions 2.4 to 2.6,
packaged as the @code{unittest2} package, from unittest2@footnote{https://pypi.org/project/unittest2/}.

Cuando se usa desde la línea de comandos, el módulo puede descubrir pruebas automáticamente. No es tan elegante como py.test@footnote{https://pytest.org} o nose@footnote{https://nose.readthedocs.io/}, pero proporciona una forma sencilla de ejecutar pruebas guardadas dentro de un conjunto de directorios de paquetes. Por ejemplo, el siguiente comando buscará en el subdirectorio @code{test/} cualquier archivo de prueba importable llamado @code{test*.py}:

@example
python -m unittest discover -s test
@end example

Consulte la documentación del módulo @ref{106,,unittest} para más detalles. (Desarrollado en bpo-6001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6001}.)

La función @ref{1062,,main()} soporta algunas otras opciones nuevas:


@itemize *

@item 
@ref{1399,,-b} o @code{--buffer} almacenará en búfer la salida estándar y los flujos de error estándar durante cada prueba. Si la prueba pasa, se descartará cualquier salida resultante; en caso de falla, se mostrará la salida almacenada en búfer.

@item 
@ref{139a,,-c} o @code{--catch} hará que la interrupción de control-C se maneje con más gracia.  En lugar de interrumpir el proceso de prueba inmediatamente, se completará la prueba que se esté ejecutando en ese momento y luego se informará de los resultados parciales hasta la interrupción. Si está impaciente, una segunda pulsación de control-C provocará una interrupción inmediata.</unittest>

Este manejador de control-C intenta evitar que se produzcan problemas cuando el código que se está probando o las pruebas que se están ejecutando han definido un manejador de señales propio, advirtiendo que ya se ha establecido un manejador de señales y llamándolo.  Si esto no te funciona, hay un decorador @ref{139b,,removeHandler()} que puede utilizarse para marcar las pruebas que deben tener el manejador de control-C desactivado.

@item 
@ref{139c,,-f} o @code{--failfast} hace que la ejecución de la prueba se detenga inmediatamente cuando una prueba falla en lugar de continuar ejecutando más pruebas.  (Sugerido por Cliff Dyer e implementado por Michael Foord; bpo-8074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8074})</unittest>
@end itemize

Los mensajes de progreso ahora muestran “x” para los fallos esperados y “u” para los éxitos inesperados cuando se ejecuta en modo verboso. (Contribución de Benjamin Peterson)

Los casos de prueba pueden lanzar la excepción @ref{1063,,SkipTest} para saltarse una prueba (bpo-1034053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1034053}).

Los mensajes de error para los fallos @ref{5cc,,assertEqual()}, @ref{5ca,,assertTrue()}, y @ref{5cb,,assertFalse()} ahora proporcionan más información.  Si estableces el atributo @ref{139d,,longMessage} de tus clases @ref{4fa,,TestCase} a true, tanto el mensaje de error estándar como cualquier mensaje adicional que proporciones se imprimirán para los fallos.  (Añadido por Michael Foord; bpo-5663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5663}.)

El método @ref{5d0,,assertRaises()} ahora retorna un manejador de contexto cuando se llama sin proporcionar un objeto invocable para ejecutar.  Por ejemplo, puede escribir esto:

@example
with self.assertRaises(KeyError):
    @{@}['foo']
@end example

(Implementado por Antoine Pitrou; bpo-4444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4444}.)

@c rev 78774

Ahora se soportan las funciones de configuración y desmontaje a nivel de módulo y de clase. Los módulos pueden contener funciones @code{setUpModule()} y @code{tearDownModule()}.  Las clases pueden tener métodos @ref{ae1,,setUpClass()} y @ref{139e,,tearDownClass()} que deben ser definidos como métodos de clase (usando @code{@@classmethod} o equivalente).  Estas funciones y métodos se invocan cuando el ejecutor de pruebas cambia a un caso de prueba en un módulo o clase diferente.

Se han añadido los métodos @ref{b0e,,addCleanup()} y @ref{139f,,doCleanups()}. @ref{b0e,,addCleanup()} permite añadir funciones de limpieza que serán llamadas incondicionalmente (después de @ref{13a0,,setUp()} si @ref{13a0,,setUp()} falla, en caso contrario después de @ref{13a1,,tearDown()}). Esto permite una asignación y desasignación de recursos mucho más sencilla durante las pruebas (bpo-5679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5679}).

Se añadieron varios métodos nuevos que proporcionan pruebas más especializadas.  Muchos de estos métodos fueron escritos por ingenieros de Google para utilizarlos en sus conjuntos de pruebas; Gregory P. Smith, Michael Foord y GvR trabajaron en la fusión de los mismos en la versión de Python de @ref{106,,unittest}.


@itemize *

@item 
@ref{12f7,,assertIsNone()} y @ref{12f8,,assertIsNotNone()} toman una expresión y verifican que el resultado es o no es @code{None}.

@item 
@ref{13a2,,assertIs()} y @ref{13a3,,assertIsNot()} toman dos valores y comprueban si los dos valores se evalúan al mismo objeto o no. (Añadido por Michael Foord; bpo-2578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2578}.)

@item 
@ref{13a4,,assertIsInstance()} y @ref{13a5,,assertNotIsInstance()} comprueban si el objeto resultante es una instancia de una clase concreta, o de una tupla de clases.  (Añadido por Georg Brandl; bpo-7031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7031}.)

@item 
@ref{13a6,,assertGreater()}, @ref{13a7,,assertGreaterEqual()}, @ref{13a8,,assertLess()}, y @ref{13a9,,assertLessEqual()} comparan dos cantidades.

@item 
@ref{13aa,,assertMultiLineEqual()} compara dos cadenas, y si no son iguales, muestra una comparación útil que resalta las diferencias en las dos cadenas.  Esta comparación se utiliza ahora por defecto cuando las cadenas Unicode se comparan con @ref{5cc,,assertEqual()}.

@item 
@ref{5d1,,assertRegexpMatches()} and
@ref{5d3,,assertNotRegexpMatches()} checks whether the
first argument is a string matching or not matching the regular
expression provided as the second argument (bpo-8038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8038}).

@item 
@ref{5d2,,assertRaisesRegexp()} checks
whether a particular exception
is raised, and then also checks that the string representation of
the exception matches the provided regular expression.

@item 
@ref{13ab,,assertIn()} y @ref{13ac,,assertNotIn()} comprueban si `primero' está o no está en `segundo'.

@item 
@ref{1297,,assertItemsEqual()} tests whether two provided sequences
contain the same elements.

@item 
@ref{12f2,,assertSetEqual()} compara si dos conjuntos son iguales, y sólo informa de las diferencias entre los conjuntos en caso de error.

@item 
De forma similar, @ref{12f4,,assertListEqual()} y @ref{12f5,,assertTupleEqual()} comparan los tipos especificados y explican cualquier diferencia sin imprimir necesariamente sus valores completos; estos métodos se utilizan ahora por defecto cuando se comparan listas y tuplas utilizando @ref{5cc,,assertEqual()}. De forma más general, @ref{12f6,,assertSequenceEqual()} compara dos secuencias y puede comprobar opcionalmente si ambas secuencias son de un tipo determinado.

@item 
@ref{12f3,,assertDictEqual()} compares two dictionaries and reports the
differences; it’s now used by default when you compare two dictionaries
using @ref{5cc,,assertEqual()}.  @code{assertDictContainsSubset()} checks whether
all of the key/value pairs in `first' are found in `second'.

@item 
@ref{5ce,,assertAlmostEqual()} y @ref{5cf,,assertNotAlmostEqual()} prueban si `first' y `second' son aproximadamente iguales. Este método puede redondear su diferencia a un número especificado opcionalmente de `lugares' (el valor predeterminado es 7) y compararlo con cero, o requerir que la diferencia sea menor que un valor `delta' proporcionado.

@item 
@ref{13ad,,loadTestsFromName()} respeta correctamente el atributo @ref{13ae,,suiteClass} de la @ref{3e2,,TestLoader}. (Corregido por Mark Roddy; bpo-6866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6866}.)

@item 
Un nuevo hook permite extender el método @ref{5cc,,assertEqual()} para manejar nuevos tipos de datos.  El método @ref{13af,,addTypeEqualityFunc()} toma un objeto de tipo y una función. La función se utilizará cuando los dos objetos que se comparan sean del tipo especificado.  Esta función debe comparar los dos objetos y lanzar una excepción si no coinciden; es una buena idea que la función proporcione información adicional acerca de por qué los dos objetos no coinciden, al igual que los nuevos métodos de comparación de secuencias.
@end itemize

@ref{1062,,unittest.main()} ahora toma un argumento opcional @code{exit}.  Si es falso, @ref{1062,,main()} no llama a @ref{13b0,,sys.exit()}, permitiendo que @ref{1062,,main()} sea utilizado desde el intérprete interactivo. (Contribuido por J. Pablo Fernández; bpo-3379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3379}.)

@ref{11d8,,TestResult} tiene nuevos métodos @ref{13b1,,startTestRun()} y @ref{13b2,,stopTestRun()} que se llaman inmediatamente antes y después de la ejecución de una prueba.  (Contribución de Robert Collins; bpo-5728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5728}.)

Con todos estos cambios, el archivo @code{unittest.py} se estaba volviendo incómodamente grande, por lo que el módulo se convirtió en un paquete y el código se dividió en varios archivos (por Benjamin Peterson).  Esto no afecta a la forma de importar o utilizar el módulo.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://web.archive.org/web/20210619163128/http://www.voidspace.org.uk/python/articles/unittest2.shtml}

Describe las nuevas funciones, cómo utilizarlas y la justificación de varias decisiones de diseño.  (Por Michael Foord.)
@end table


@node Módulo actualizado ElementTree 1 3,,Módulo actualizado unittest,Módulos nuevos y mejorados
@anchor{whatsnew/2 7 elementtree-section}@anchor{13b3}@anchor{whatsnew/2 7 updated-module-elementtree-1-3}@anchor{13b4}
@subsubsection Módulo actualizado: ElementTree 1.3


La versión de la biblioteca ElementTree incluida en Python se ha actualizado a la versión 1.3.  Algunas de las nuevas características son:


@itemize *

@item 
Las diversas funciones de análisis ahora toman un argumento de palabra clave `parser' que da una instancia de @ref{ae5,,XMLParser} que se utilizará.  Esto hace posible anular la codificación interna del archivo:

@example
p = ET.XMLParser(encoding='utf-8')
t = ET.XML("""<root/>""", parser=p)
@end example

Errors in parsing XML now raise a @ref{12e5,,ParseError} exception, whose
instances have a @code{position} attribute
containing a (`line', `column') tuple giving the location of the problem.

@item 
ElementTree’s code for converting trees to a string has been
significantly reworked, making it roughly twice as fast in many
cases.  The @ref{13b5,,ElementTree.write()}
and @code{Element.write()} methods now have a `method' parameter that can be
«xml» (the default), «html», or «text».  HTML mode will output empty
elements as @code{<empty></empty>} instead of @code{<empty/>}, and text
mode will skip over elements and only output the text chunks.  If
you set the @ref{13b6,,tag} attribute of an
element to @code{None} but
leave its children in place, the element will be omitted when the
tree is written out, so you don’t need to do more extensive rearrangement
to remove a single element.

También se ha mejorado la gestión de los espacios de nombres. Ahora todas las declaraciones @code{xmlns:<whatever>} se emiten en el elemento raíz, y no dispersas en el XML resultante.  Se puede establecer el espacio de nombres por defecto para un árbol mediante el atributo @code{default_namespace} y se pueden registrar nuevos prefijos con @ref{123f,,register_namespace()}.  En el modo XML, puede utilizar el parámetro true/false `xml_declaration' para suprimir la declaración XML.

@item 
Nuevo método @ref{20b,,Element}: @ref{1240,,extend()} añade los elementos de una secuencia a los hijos del elemento.  Los propios elementos se comportan como secuencias, por lo que es fácil mover los hijos de un elemento a otro:

@example
from xml.etree import ElementTree as ET

t = ET.XML("""<list>
  <item>1</item> <item>2</item>  <item>3</item>
</list>""")
new = ET.XML('<root/>')
new.extend(t)

# Outputs <root><item>1</item>...</root>
print ET.tostring(new)
@end example

@item 
New @ref{20b,,Element} method:
@ref{13b7,,iter()} yields the children of the
element as a generator.  It’s also possible to write @code{for child in
elem:} to loop over an element’s children.  The existing method
@code{getiterator()} is now deprecated, as is @code{getchildren()}
which constructs and returns a list of children.

@item 
New @ref{20b,,Element} method:
@ref{1242,,itertext()} yields all chunks of
text that are descendants of the element.  For example:

@example
t = ET.XML("""<list>
  <item>1</item> <item>2</item>  <item>3</item>
</list>""")

# Outputs ['\n  ', '1', ' ', '2', '  ', '3', '\n']
print list(t.itertext())
@end example

@item 
Deprecado: el uso de un elemento como booleano (es decir, @code{if elem:}) retornaba true si el elemento tenía algún hijo, o false si no había ningún hijo.  Este comportamiento es confuso – @code{None} es falso, pero también lo es un elemento sin hijos? – por lo que ahora provocará un @ref{4d4,,FutureWarning}.  En tu código, deberías ser explícito: escribe @code{len(elem) != 0} si te interesa el número de hijos, o @code{elem no es None}.
@end itemize

Fredrik Lundh desarrolla ElementTree y produjo la versión 1.3; puede leer su artículo que describe 1.3 en @indicateurl{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm}. Florent Xicluna actualizó la versión incluida con Python, luego de discusiones en python-dev y en bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472}.)

@c ======================================================================

@node Cambios en la API de construcción y C<2>,Otros cambios y correcciones,Módulos nuevos y mejorados,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 build-and-c-api-changes}@anchor{13b8}
@subsection Cambios en la API de construcción y C


Los cambios en el proceso de construcción de Python y en la API de C incluyen:


@itemize *

@item 
The latest release of the GNU Debugger, GDB 7, can be scripted using Python@footnote{https://web.archive.org/web/20110715084810/http://sourceware.org/gdb/current/onlinedocs/gdb/Python.html}.
When you begin debugging an executable program P, GDB will look for
a file named @code{P-gdb.py} and automatically read it.  Dave Malcolm
contributed a @code{python-gdb.py} that adds a number of
commands useful when debugging Python itself.  For example,
@code{py-up} and @code{py-down} go up or down one Python stack frame,
which usually corresponds to several C stack frames.  @code{py-print}
prints the value of a Python variable, and @code{py-bt} prints the
Python stack trace.  (Added as a result of bpo-8032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8032}.)

@item 
Si utiliza el archivo @code{.gdbinit} proporcionado con Python, la macro «pyo» en la versión 2.7 ahora funciona correctamente cuando el hilo que se está depurando no tiene el GIL; la macro ahora lo adquiere antes de imprimir. (Contribución de Victor Stinner; bpo-3632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3632}.)

@item 
@ref{a13,,Py_AddPendingCall()} ahora es seguro para los hilos, permitiendo que cualquier hilo trabajador envíe notificaciones al hilo principal de Python.  Esto es particularmente útil para las operaciones asíncronas de IO. (Contribuido por Kristján Valur Jónsson; bpo-4293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4293}.)

@item 
New function: @ref{13b9,,PyCode_NewEmpty()} creates an empty code object;
only the filename, function name, and first line number are required.
This is useful for extension modules that are attempting to
construct a more useful traceback stack.  Previously such
extensions needed to call @code{PyCode_New()}, which had many
more arguments.  (Added by Jeffrey Yasskin.)

@item 
Nueva función: @ref{12d6,,PyErr_NewExceptionWithDoc()} crea una nueva clase de excepción, igual que la existente @ref{12d7,,PyErr_NewException()}, pero toma un argumento extra @code{char *} que contiene el docstring de la nueva clase de excepción.  (Añadido por “lekma” en el bug tracker de Python; bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033})

@item 
Nueva función: @ref{824,,PyFrame_GetLineNumber()} toma un objeto frame y retorna el número de línea que el frame está ejecutando actualmente. Anteriormente, el código tenía que obtener el índice de la instrucción de código de bytes que se estaba ejecutando, y luego buscar el número de línea correspondiente a esa dirección.  (Añadido por Jeffrey Yasskin)

@item 
Nuevas funciones: @ref{12d4,,PyLong_AsLongAndOverflow()} y @ref{12d3,,PyLong_AsLongLongAndOverflow()} aproximan un entero largo de Python como C long o long long. Si el número es demasiado grande para caber en el tipo de salida, se establece un indicador `overflow' y se devuelve a la persona que llama. (Aportado por Case Van Horsen; bpo-7528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7528} y bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767}.)

@item 
New function: stemming from the rewrite of string-to-float conversion,
a new @ref{1302,,PyOS_string_to_double()} function was added.  The old
@code{PyOS_ascii_strtod()} and @code{PyOS_ascii_atof()} functions
are now deprecated.

@item 
New function: @code{PySys_SetArgvEx()} sets the value of
@code{sys.argv} and can optionally update @code{sys.path} to include the
directory containing the script named by @code{sys.argv[0]} depending
on the value of an `updatepath' parameter.

This function was added to close a security hole for applications
that embed Python.  The old function, @code{PySys_SetArgv()}, would
always update @code{sys.path}, and sometimes it would add the current
directory.  This meant that, if you ran an application embedding
Python in a directory controlled by someone else, attackers could
put a Trojan-horse module in the directory (say, a file named
@code{os.py}) that your application would then import and run.

If you maintain a C/C++ application that embeds Python, check
whether you’re calling @code{PySys_SetArgv()} and carefully consider
whether the application should be using @code{PySys_SetArgvEx()}
with `updatepath' set to false.

Security issue reported as 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983};
discussed in bpo-5753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5753}, and fixed by Antoine Pitrou.

@item 
Nuevas macros: los ficheros de cabecera de Python definen ahora las siguientes macros: @code{Py_ISALNUM}, @code{Py_ISALPHA}, @code{Py_ISDIGIT}, @code{Py_ISLOWER}, @code{Py_ISSPACE}, @code{Py_ISUPPER}, @code{Py_ISXDIGIT}, @code{Py_TOLOWER} y @code{Py_TOUPPER}. Todas estas funciones son análogas a las macros estándar de C para clasificar caracteres, pero ignoran la configuración regional actual, porque en varios lugares Python necesita analizar los caracteres de forma independiente de la configuración regional.  (Añadido por Eric Smith; bpo-5793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5793}.)

@c XXX these macros don't seem to be described in the c-api docs.

@item 
Removed function: @code{PyEval_CallObject()} is now only available
as a macro.  A function version was being kept around to preserve
ABI linking compatibility, but that was in 1997; it can certainly be
deleted by now.  (Removed by Antoine Pitrou; bpo-8276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8276}.)

@item 
New format codes: the @code{PyString_FromFormat()},
@code{PyString_FromFormatV()}, and @ref{f32,,PyErr_Format()} functions now
accept @code{%lld} and @code{%llu} format codes for displaying
C’s long long types.
(Contributed by Mark Dickinson; bpo-7228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7228}.)

@item 
Se ha cambiado la complicada interacción entre los hilos y la bifurcación de procesos.  Anteriormente, el proceso hijo creado por @ref{2ff,,os.fork()} podía fallar porque el hijo se creaba con un solo hilo en ejecución, el hilo que realizaba el @ref{2ff,,os.fork()}. Si otros hilos estuvieran manteniendo un bloqueo, como el bloqueo de importación de Python, cuando se realizara el fork, el bloqueo seguiría marcado como «mantenido» en el nuevo proceso.  Pero en el proceso hijo nada liberaría el bloqueo, ya que los otros hilos no estaban replicados, y el proceso hijo ya no podría realizar importaciones.

Python 2.7 adquiere el bloqueo de importación antes de realizar un @ref{2ff,,os.fork()}, y también limpiará cualquier bloqueo creado usando el módulo @ref{ed,,threading}.  Los módulos de extensión C que tienen bloqueos internos, o que llaman a @code{fork()} ellos mismos, no se beneficiarán de esta limpieza.

(Corregido por Thomas Wouters; bpo-1590864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1590864}.)

@item 
The @ref{246,,Py_Finalize()} function now calls the internal
@code{threading._shutdown()} function; this prevents some exceptions from
being raised when an interpreter shuts down.
(Patch by Adam Olsen; bpo-1722344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1722344}.)

@item 
When using the @ref{5f2,,PyMemberDef} structure to define attributes
of a type, Python will no longer let you try to delete or set a
@code{T_STRING_INPLACE} attribute.

@c rev 79644

@item 
Los símbolos globales definidos por el módulo @ref{2b,,ctypes} llevan ahora el prefijo @code{Py}, o bien @code{_ctypes}.  (Implementado por Thomas Heller; bpo-3102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3102}.)

@item 
New configure option: the @code{--with-system-expat} switch allows
building the @ref{126,,pyexpat} module to use the system Expat library.
(Contributed by Arfrever Frehtes Taifersar Arahesis; bpo-7609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7609}.)

@item 
Nueva opción de configuración: la opción @code{--with-valgrind} ahora desactivará el asignador pymalloc, que es difícil de analizar correctamente por el detector de errores de memoria de Valgrind. Por lo tanto, Valgrind detectará mejor las fugas de memoria y los desbordamientos. (Contribución de James Henstridge; bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422}.)

@item 
Nueva opción de configuración: ahora puede suministrar una cadena vacía a @code{--with-dbmliborder=} para desactivar todos los módulos DBM.  (Añadido por Arfrever Frehtes Taifersar Arahesis; bpo-6491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6491})

@item 
El script @code{configure} comprueba ahora los errores de redondeo en coma flotante en ciertos chips Intel de 32 bits y define una definición del preprocesador @code{X87_DOUBLE_ROUNDING}.  Ningún código utiliza actualmente esta definición, pero está disponible si alguien desea utilizarla. (Añadido por Mark Dickinson; bpo-2937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2937}.)

@code{configure} ahora también establece una variable Makefile 
@geindex LDCXXSHARED
@geindex variables de entorno; LDCXXSHARED
@code{LDCXXSHARED} para soportar el enlazado de C++.  (Contribuido por Arfrever Frehtes Taifersar Arahesis; bpo-1222585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1222585}.)

@item 
El proceso de construcción ahora crea los archivos necesarios para el soporte de pkg-config.  (Contribución de Clinton Roy; bpo-3585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3585}.)

@item 
El proceso de construcción ahora soporta Subversion 1.7.  (Contribuido por Arfrever Frehtes Taifersar Arahesis; bpo-6094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6094}.)
@end itemize

@menu
* Cápsulas:: 
* Cambios específicos en los puertos; Windows: Cambios específicos en los puertos Windows. 
* Cambios específicos en los puertos; Mac OS X: Cambios específicos en los puertos Mac OS X. 
* Cambios específicos en los puertos; FreeBSD: Cambios específicos en los puertos FreeBSD. 

@end menu

@node Cápsulas,Cambios específicos en los puertos Windows,,Cambios en la API de construcción y C<2>
@anchor{whatsnew/2 7 capsules}@anchor{13ba}@anchor{whatsnew/2 7 whatsnew27-capsules}@anchor{13bb}
@subsubsection Cápsulas


Python 3.1 añade un nuevo tipo de datos C, @ref{12e0,,PyCapsule}, para proporcionar una API C a un módulo de extensión.  Una cápsula es esencialmente el soporte de un puntero C @code{void *}, y está disponible como un atributo del módulo; por ejemplo, la API del módulo @ref{cc,,socket} se expone como @code{socket.CAPI}, y @ref{105,,unicodedata} expone @code{ucnhash_CAPI}.  Otras extensiones pueden importar el módulo, acceder a su diccionario para obtener el objeto cápsula, y luego obtener el puntero @code{void *}, que normalmente apuntará a una matriz de punteros a las diversas funciones de la API del módulo.

There is an existing data type already used for this,
@code{PyCObject}, but it doesn’t provide type safety.  Evil code
written in pure Python could cause a segmentation fault by taking a
@code{PyCObject} from module A and somehow substituting it for the
@code{PyCObject} in module B.   Capsules know their own name,
and getting the pointer requires providing the name:

@example
void *vtable;

if (!PyCapsule_IsValid(capsule, "mymodule.CAPI") @{
        PyErr_SetString(PyExc_ValueError, "argument type invalid");
        return NULL;
@}

vtable = PyCapsule_GetPointer(capsule, "mymodule.CAPI");
@end example

Se asegura que @code{vtable} apunta a lo que se espera. Si se pasara una cápsula diferente, @ref{13bc,,PyCapsule_IsValid()} detectaría el nombre erróneo y retornaría false.  Consulta @ref{13bd,,Proporcionar una API C para un módulo de extensión} para más información sobre el uso de estos objetos.

Python 2.7 now uses capsules internally to provide various
extension-module APIs, but the @code{PyCObject_AsVoidPtr()} was
modified to handle capsules, preserving compile-time compatibility
with the @code{PyCObject} interface.  Use of
@code{PyCObject_AsVoidPtr()} will signal a
@ref{95f,,PendingDeprecationWarning}, which is silent by default.

Implementado en Python 3.1 y portado a 2.7 por Larry Hastings; discutido en bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630}.

@c ======================================================================

@node Cambios específicos en los puertos Windows,Cambios específicos en los puertos Mac OS X,Cápsulas,Cambios en la API de construcción y C<2>
@anchor{whatsnew/2 7 port-specific-changes-windows}@anchor{13be}
@subsubsection Cambios específicos en los puertos: Windows



@itemize *

@item 
The @ref{93,,msvcrt} module now contains some constants from
the @code{crtassem.h} header file:
@ref{13bf,,CRT_ASSEMBLY_VERSION},
@ref{13c0,,VC_ASSEMBLY_PUBLICKEYTOKEN},
and @ref{13c1,,LIBRARIES_ASSEMBLY_NAME_PREFIX}.
(Contributed by David Cournapeau; bpo-4365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4365}.)

@item 
The @ref{116,,_winreg} module for accessing the registry now implements
the @ref{13c2,,CreateKeyEx()} and @ref{13c3,,DeleteKeyEx()}
functions, extended versions of previously supported functions that
take several extra arguments.  The @ref{13c4,,DisableReflectionKey()},
@ref{13c5,,EnableReflectionKey()}, and @ref{13c6,,QueryReflectionKey()}
were also tested and documented.
(Implemented by Brian Curtin: bpo-7347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7347}.)

@item 
The new @code{_beginthreadex()} API is used to start threads, and
the native thread-local storage functions are now used.
(Contributed by Kristján Valur Jónsson; bpo-3582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3582}.)

@item 
The @ref{13c7,,os.kill()} function now works on Windows.  The signal value
can be the constants @ref{13c8,,CTRL_C_EVENT},
@ref{13c9,,CTRL_BREAK_EVENT}, or any integer.  The first two constants
will send @code{Control-C} and @code{Control-Break} keystroke events to
subprocesses; any other value will use the @code{TerminateProcess()}
API.  (Contributed by Miki Tebeka; bpo-1220212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1220212}.)

@item 
La función @ref{116c,,os.listdir()} ahora falla correctamente si la ruta está vacía.  (Corregido por Hirokazu Yamamoto; bpo-5913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5913}.)

@item 
The @ref{8f,,mimetypes} module will now read the MIME database from
the Windows registry when initializing.
(Patch by Gabriel Genellina; bpo-4969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4969}.)
@end itemize

@c ======================================================================

@node Cambios específicos en los puertos Mac OS X,Cambios específicos en los puertos FreeBSD,Cambios específicos en los puertos Windows,Cambios en la API de construcción y C<2>
@anchor{whatsnew/2 7 port-specific-changes-mac-os-x}@anchor{13ca}
@subsubsection Cambios específicos en los puertos: Mac OS X



@itemize *

@item 
La ruta @code{/Library/Python/2.7/site-packages} se añade ahora a @code{sys.path}, para compartir los paquetes añadidos entre la instalación del sistema y una copia de la misma versión instalada por el usuario. (Cambiado por Ronald Oussoren; bpo-4865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4865}.)


Distinto en la versión 2.7.13: A partir de la versión 2.7.13, se ha eliminado este cambio. @code{/Library/Python/2.7/site-packages}, el directorio site-packages utilizado por el sistema Python 2.7 suministrado por Apple ya no se añade a @code{sys.path} para los Python instalados por el usuario, como los instaladores de python.org.  A partir de macOS 10.12, Apple ha cambiado la configuración del directorio site-packages del sistema, lo que puede hacer que falle la instalación de componentes pip, como setuptools.  Los paquetes instalados para el sistema Python ya no se compartirán con los Python instalados por el usuario. (bpo-28440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28440})

@end itemize

@node Cambios específicos en los puertos FreeBSD,,Cambios específicos en los puertos Mac OS X,Cambios en la API de construcción y C<2>
@anchor{whatsnew/2 7 port-specific-changes-freebsd}@anchor{13cb}
@subsubsection Cambios específicos en los puertos: FreeBSD



@itemize *

@item 
FreeBSD 7.1’s @code{SO_SETFIB} constant, used with the @ref{e27,,socket()} methods
@ref{d5c,,getsockopt()}/@ref{d5d,,setsockopt()} to select an
alternate routing table, is now available in the @ref{cc,,socket}
module.  (Added by Kyle VanderBeek; bpo-8235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8235}.)
@end itemize

@node Otros cambios y correcciones,Adaptación a Python 2 7,Cambios en la API de construcción y C<2>,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 other-changes-and-fixes}@anchor{13cc}
@subsection Otros cambios y correcciones



@itemize *

@item 
Dos scripts de evaluación, @code{iobench} y @code{ccbench}, han sido añadidos al directorio @code{Tools}. @code{iobench} mide la velocidad de los objetos de E/S de los archivos retornados por @ref{1be,,open()} al realizar varias operaciones, y @code{ccbench} es una evaluación de concurrencia que trata de medir el rendimiento de la computación, la latencia del cambio de hilos y el ancho de banda del procesamiento de E/S al realizar varias tareas utilizando un número variable de hilos.

@item 
El script @code{Tools/i18n/msgfmt.py} ahora entiende las formas plurales en los archivos @code{.po}.  (Corregido por Martin von Löwis; bpo-5464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5464}.)

@item 
When importing a module from a @code{.pyc} or @code{.pyo} file
with an existing @code{.py} counterpart, the @ref{13cd,,co_filename}
attributes of the resulting code objects are overwritten when the
original filename is obsolete.  This can happen if the file has been
renamed, moved, or is accessed through different paths.  (Patch by
Ziga Seilnacht and Jean-Paul Calderone; bpo-1180193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1180193}.)

@item 
El script @code{regrtest.py} ahora toma una opción @code{--randseed=} que toma un entero que será usado como semilla aleatoria para la opción @code{-r} que ejecuta las pruebas en orden aleatorio. La opción @code{-r} también informa de la semilla que se ha utilizado (Añadido por Collin Winter.)

@item 
Otra opción @code{regrtest.py} es @code{-j}, que toma un número entero que especifica cuántas pruebas se ejecutan en paralelo. Esto permite reducir el tiempo total de ejecución en máquinas multinúcleo. Esta opción es compatible con varias otras opciones, incluyendo la opción @code{-R} que es conocida por producir tiempos de ejecución largos. (Añadido por Antoine Pitrou, bpo-6152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6152}.) También puede utilizarse con una nueva opción @code{-F} que ejecuta las pruebas seleccionadas en un bucle hasta que fallen.  (Añadido por Antoine Pitrou; bpo-7312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7312}.)

@item 
Cuando se ejecuta como un script, el módulo @code{py_compile.py} ahora acepta @code{'-'} como argumento, que leerá la entrada estándar para la lista de nombres de archivos a compilar.  (Contribuido por Piotr Ożarowski; bpo-8233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8233}.)
@end itemize

@c ======================================================================

@node Adaptación a Python 2 7,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7,Otros cambios y correcciones,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 porting-to-python-2-7}@anchor{13ce}
@subsection Adaptación a Python 2.7


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código:


@itemize *

@item 
The @ref{9d6,,range()} function processes its arguments more
consistently; it will now call @ref{22a,,__int__()} on non-float,
non-integer arguments that are supplied to it.  (Fixed by Alexander
Belopolsky; bpo-1533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533}.)

@item 
El método string @ref{6c0,,format()} ha cambiado la precisión por defecto utilizada para los números de punto flotante y complejos de 6 decimales a 12, que coincide con la precisión utilizada por @ref{237,,str()}. (Cambiado por Eric Smith; bpo-5920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5920}.)

@item 
Because of an optimization for the @ref{673,,with} statement, the special
methods @ref{669,,__enter__()} and @ref{1367,,__exit__()} must belong to the object’s
type, and cannot be directly attached to the object’s instance.  This
affects new-style classes (derived from @ref{b18,,object}) and C extension
types.  (bpo-6101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6101}.)

@item 
Due to a bug in Python 2.6, the `exc_value' parameter to
@ref{1367,,__exit__()} methods was often the string representation of the
exception, not an instance.  This was fixed in 2.7, so `exc_value'
will be an instance as expected.  (Fixed by Florent Xicluna;
bpo-7853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7853}.)

@item 
Cuando se establecía un conjunto restringido de atributos utilizando @code{__slots__}, la eliminación de un atributo no establecido no lanzaba @ref{441,,AttributeError} como cabría esperar.  Corregido por Benjamin Peterson; bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604})
@end itemize

En la biblioteca estándar:


@itemize *

@item 
Las operaciones con instancias @ref{32f,,datetime} que daban como resultado un año que caía fuera del rango soportado no siempre lanzaban @ref{919,,OverflowError}.  Estos errores se comprueban ahora con más cuidado y se lanzará la excepción. (Informado por Mark Leander, parche de Anand B. Pillai y Alexander Belopolsky; bpo-7150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7150})

@item 
Cuando se utilizan instancias @ref{16a,,Decimal} con el método @ref{6c0,,format()} de una cadena, la alineación por defecto era antes la alineación a la izquierda.  Se ha cambiado a alineación derecha, lo que podría cambiar la salida de sus programas. (Cambiado por Mark Dickinson; bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857}.)

Las comparaciones que implican un valor NaN de señalización (o @code{sNAN}) señalan ahora @ref{111f,,InvalidOperation} en lugar de retornar silenciosamente un valor verdadero o falso dependiendo del operador de comparación.  Los valores NaN silenciosos (o @code{NaN}) son ahora hashable.  (Corregido por Mark Dickinson; bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279}.)

@item 
The @ref{125,,xml.etree.ElementTree} library no longer escapes
ampersands and angle brackets when outputting an XML processing
instruction (which looks like @code{<?xml-stylesheet href="#style1"?>})
or comment (which looks like @code{<!-- comment -->}).
(Patch by Neil Muller; bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}.)

@item 
The @code{readline()} method of @ref{fa9,,StringIO} objects now does
nothing when a negative length is requested, as other file-like
objects do.  (bpo-7348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7348}).

@item 
El módulo @ref{dc,,syslog} utilizará ahora el valor de @code{sys.argv[0]} como identificador en lugar del anterior valor por defecto de @code{'python}. (Cambiado por Sean Reifschneider; bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}.)

@item 
El manejo de errores por defecto del módulo @ref{de,,tarfile} ha cambiado, para no suprimir los errores fatales.  El nivel de error por defecto era antes 0, lo que significaba que los errores sólo daban lugar a que se escribiera un mensaje en el registro de depuración, pero como el registro de depuración no está activado por defecto, estos errores pasan desapercibidos.  El nivel de error por defecto es ahora 1, que lanza una excepción si hay un error. (Cambiado por Lars Gustäbel; bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}.)

@item 
The @ref{10a,,urlparse} module’s @ref{dc6,,urlsplit()} now handles
unknown URL schemes in a fashion compliant with 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}: if the
URL is of the form @code{"<something>://..."}, the text before the
@code{://} is treated as the scheme, even if it’s a made-up scheme that
the module doesn’t know about.  This change may break code that
worked around the old behaviour.  For example, Python 2.6.4 or 2.5
will return the following:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7 (y Python 2.6.5) retornará:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

(Python 2.7 en realidad produce una salida ligeramente diferente, ya que retorna una tupla con nombre en lugar de una tupla estándar)
@end itemize

Para las extensiones en C:


@itemize *

@item 
Las extensiones de C que utilizan códigos de formato entero con la familia de funciones @code{PyArg_Parse*} ahora lanzarán una excepción @ref{228,,TypeError} en lugar de provocar un @ref{1da,,DeprecationWarning} (bpo-5080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5080}).

@item 
Use the new @ref{1302,,PyOS_string_to_double()} function instead of the old
@code{PyOS_ascii_strtod()} and @code{PyOS_ascii_atof()} functions,
which are now deprecated.
@end itemize

Para aplicaciones que incrustan Python:


@itemize *

@item 
The @code{PySys_SetArgvEx()} function was added, letting
applications close a security hole when the existing
@code{PySys_SetArgv()} function was used.  Check whether you’re
calling @code{PySys_SetArgv()} and carefully consider whether the
application should be using @code{PySys_SetArgvEx()} with
`updatepath' set to false.
@end itemize

@c ======================================================================

@node Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7,Agradecimientos,Adaptación a Python 2 7,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 new-features-added-to-python-2-7-maintenance-releases}@anchor{13cf}@anchor{whatsnew/2 7 py27-maintenance-enhancements}@anchor{134d}
@subsection Nuevas funciones añadidas a las versiones de mantenimiento de Python 2.7


Se pueden añadir nuevas características a las versiones de mantenimiento de Python 2.7 cuando la situación lo requiera realmente. Cualquier adición debe pasar por el proceso de Propuesta de Mejora de Python, y hacer un caso convincente de por qué no se puede abordar adecuadamente mediante la adición de la nueva característica únicamente a Python 3, o bien mediante su publicación en el Índice de Paquetes de Python.

Además de las propuestas específicas enumeradas a continuación, existe una exención general que permite añadir nuevas advertencias @code{-3} en cualquier versión de mantenimiento de Python 2.7.

@menu
* Dos nuevas variables de entorno para el modo de depuración:: 
* PEP 434; Excepción de mejora de IDLE para todas las ramas: PEP 434 Excepción de mejora de IDLE para todas las ramas. 
* PEP 466; Mejoras en la seguridad de la red para Python 2.7: PEP 466 Mejoras en la seguridad de la red para Python 2 7. 
* PEP 477; Backport ensurepip (PEP 453) a Python 2.7: PEP 477 Backport ensurepip PEP 453 a Python 2 7. 
* PEP 476; Habilitar la verificación de certificados por defecto para los clientes http stdlib: PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib<2>. 
* PEP 493; Herramientas de migración de verificación HTTPS para Python 2.7: PEP 493 Herramientas de migración de verificación HTTPS para Python 2 7. 
* Nuevo objetivo de construcción make regen-all:: 
* Eliminación del objetivo de construcción make touch:: 

@end menu

@node Dos nuevas variables de entorno para el modo de depuración,PEP 434 Excepción de mejora de IDLE para todas las ramas,,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 two-new-environment-variables-for-debug-mode}@anchor{13d0}
@subsubsection Dos nuevas variables de entorno para el modo de depuración


In debug mode, the @code{[xxx refs]} statistic is not written by default, the
@code{PYTHONSHOWREFCOUNT} environment variable now must also be set.
(Contributed by Victor Stinner; bpo-31733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31733}.)

When Python is compiled with @code{COUNT_ALLOC} defined, allocation counts are no
longer dumped by default anymore: the @code{PYTHONSHOWALLOCCOUNT} environment
variable must now also be set. Moreover, allocation counts are now dumped into
stderr, rather than stdout. (Contributed by Victor Stinner; bpo-31692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31692}.)


Added in version 2.7.15.


@node PEP 434 Excepción de mejora de IDLE para todas las ramas,PEP 466 Mejoras en la seguridad de la red para Python 2 7,Dos nuevas variables de entorno para el modo de depuración,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 pep-434-idle-enhancement-exception-for-all-branches}@anchor{13d1}
@subsubsection PEP 434: Excepción de mejora de IDLE para todas las ramas


@geindex Python Enhancement Proposals; PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/} describe una exención general para los cambios realizados en el entorno de desarrollo de IDLE que se envía junto con Python. Esta exención hace posible que los desarrolladores de IDLE proporcionen una experiencia de usuario más consistente en todas las versiones soportadas de Python 2 y 3.

Para conocer los detalles de los cambios de IDLE, consulte el archivo NEWS de la versión en cuestión.

@node PEP 466 Mejoras en la seguridad de la red para Python 2 7,PEP 477 Backport ensurepip PEP 453 a Python 2 7,PEP 434 Excepción de mejora de IDLE para todas las ramas,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 pep-466-network-security-enhancements-for-python-2-7}@anchor{13d2}
@subsubsection PEP 466: Mejoras en la seguridad de la red para Python 2.7


@geindex Python Enhancement Proposals; PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} describe una serie de propuestas de mejora de la seguridad de la red que han sido aprobadas para su inclusión en las versiones de mantenimiento de Python 2.7, y el primero de esos cambios aparecerá en la versión 2.7.7 de Python.

Funciones relacionadas con @cite{466} añadidas en Python 2.7.7:


@itemize *

@item 
@ref{113e,,hmac.compare_digest()} fue portado desde Python 3 para hacer una operación de comparación resistente a los ataques de tiempo disponible para las aplicaciones de Python 2. (Contribuido por Alex Gaynor; bpo-21306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21306}.)

@item 
OpenSSL 1.0.1g fue actualizado en los instaladores oficiales de Windows publicados en python.org. (Contribuido por Zachary Ware; bpo-21462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21462}.)
@end itemize

Funciones relacionadas con @cite{466} añadidas en Python 2.7.8:


@itemize *

@item 
@ref{5b3,,hashlib.pbkdf2_hmac()} fue portado desde Python 3 para hacer que un algoritmo de hash adecuado para el almacenamiento seguro de contraseñas esté ampliamente disponible para las aplicaciones de Python 2. (Contribuido por Alex Gaynor; bpo-21304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21304}.)

@item 
OpenSSL 1.0.1h was upgraded for the official Windows installers published on
python.org. (Contributed by Zachary Ware in bpo-21671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21671} for 
@geindex Common Vulnerabilities and Exposures; CVE 2014-0224
CVE 2014-0224@footnote{https://www.cve.org/CVERecord?id=CVE-2014-0224}.)
@end itemize

Funciones relacionadas con @cite{466} añadidas en Python 2.7.9:


@itemize *

@item 
La mayor parte del módulo @ref{d0,,ssl} de Python 3.4 ha sido portado a esta versión. Esto significa que @ref{d0,,ssl} ahora soporta la Indicación de Nombre de Servidor, la configuración de TLS1.x, el acceso al almacén de certificados de la plataforma, la clase @ref{1fa,,SSLContext}, y otras características. (Contribución de Alex Gaynor y David Reid; bpo-21308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21308}.)

Consulte las notas «Versión añadida: 2.7.9» en la documentación del módulo para obtener detalles específicos.

@item 
@ref{5c6,,os.urandom()} ha sido modificado para almacenar en caché un descriptor de fichero en @code{/dev/urandom} en lugar de reabrir @code{/dev/urandom} en cada llamada. (Contribuido por Alex Gaynor; bpo-21305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21305}.)

@item 
@ref{13d3,,hashlib.algorithms_guaranteed} y @ref{13d4,,hashlib.algorithms_available} han sido portados desde Python 3 para facilitar a las aplicaciones de Python 2 la selección del algoritmo hash más potente disponible. (Contribuido por Alex Gaynor en bpo-21307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21307})
@end itemize

@node PEP 477 Backport ensurepip PEP 453 a Python 2 7,PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib<2>,PEP 466 Mejoras en la seguridad de la red para Python 2 7,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 pep-477-backport-ensurepip-pep-453-to-python-2-7}@anchor{13d5}
@subsubsection PEP 477: Backport ensurepip (PEP 453) a Python 2.7


@geindex Python Enhancement Proposals; PEP 477
PEP 477@footnote{https://peps.python.org/pep-0477/} aprueba la inclusión del módulo 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} ensurepip y la documentación mejorada que ha permitido en las versiones de mantenimiento de Python 2.7, apareciendo primero en la versión 2.7.9 de Python.

@menu
* Puesta en marcha de pip por defecto: Puesta en marcha de pip por defecto<2>. 
* Cambios en la documentación: Cambios en la documentación<2>. 

@end menu

@node Puesta en marcha de pip por defecto<2>,Cambios en la documentación<2>,,PEP 477 Backport ensurepip PEP 453 a Python 2 7
@anchor{whatsnew/2 7 bootstrapping-pip-by-default}@anchor{13d6}
@subsubsection Puesta en marcha de pip por defecto


El nuevo módulo @ref{55,,ensurepip} (definido en 
@geindex Python Enhancement Proposals; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}) proporciona un mecanismo estándar multiplataforma para arrancar el instalador pip en las instalaciones de Python. La versión de @code{pip} incluida con Python 2.7.9 es @code{pip} 1.5.6, y las futuras versiones de mantenimiento de 2.7.x actualizarán la versión incluida a la última versión de @code{pip} que esté disponible en el momento de crear la versión candidata.

Por defecto, los comandos @code{pip}, @code{pipX} y @code{pipX.Y} se instalarán en todas las plataformas (donde X.Y representa la versión de la instalación de Python), junto con el paquete de Python @code{pip} y sus dependencias.

Para las construcciones de CPython @ref{f76,,source en sistemas POSIX}, los comandos @code{make install} y @code{make altinstall} no arrancan @code{pip} por defecto.  Este comportamiento puede ser controlado a través de las opciones de configuración, y anulado a través de las opciones del Makefile.</building-python-on-unix>

En Windows y Mac OS X, los instaladores de CPython ahora instalan por defecto @code{pip} junto con el propio CPython (los usuarios pueden optar por no instalarlo durante el proceso de instalación). Los usuarios de Windows tendrán que optar por las modificaciones automáticas del @code{PATH} para que @code{pip} esté disponible por defecto desde la línea de comandos, de lo contrario se puede acceder a través del lanzador de Python para Windows como @code{py -m pip}.

As 
@geindex Python Enhancement Proposals; PEP 0477#disabling-ensurepip-by-downstream-distributors
discussed in the PEP@footnote{https://peps.python.org/pep-0477/#disabling-ensurepip-by-downstream-distributors},
platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear and
simple directions on how to install them on that platform (usually using
the system package manager).

@node Cambios en la documentación<2>,,Puesta en marcha de pip por defecto<2>,PEP 477 Backport ensurepip PEP 453 a Python 2 7
@anchor{whatsnew/2 7 documentation-changes}@anchor{13d7}
@subsubsection Cambios en la documentación


Como parte de este cambio, las secciones @ref{f78,,Instalando módulos de Python} y distributing-index de la documentación se han rediseñado por completo como documentos breves de introducción y preguntas frecuentes. La mayor parte de la documentación de empaquetado ahora se ha trasladado a Python Packaging Authority mantenido Python Packaging User Guide@footnote{https://packaging.python.org} y la documentación de los proyectos individuales.

However, as this migration is currently still incomplete, the legacy
versions of those guides remaining available as @ref{f79,,Building C and C++ Extensions with setuptools}
and @ref{f7a,,Building C and C++ Extensions with setuptools}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} – Arranque explícito de pip en instalaciones de Python

PEP escrito por Donald Stufft y Nick Coghlan, implementado por Donald Stufft, Nick Coghlan, Martin von Löwis y Ned Deily.
@end table


@node PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib<2>,PEP 493 Herramientas de migración de verificación HTTPS para Python 2 7,PEP 477 Backport ensurepip PEP 453 a Python 2 7,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{13d8}
@subsubsection PEP 476: Habilitar la verificación de certificados por defecto para los clientes http stdlib


@geindex Python Enhancement Proposals; PEP 476
PEP 476@footnote{https://peps.python.org/pep-0476/} updated @ref{6e,,httplib} and modules which use it, such as
@ref{10b,,urllib2} and @ref{12d,,xmlrpclib}, to now
verify that the server
presents a certificate which is signed by a Certificate Authority in the
platform trust store and whose hostname matches the hostname being requested
by default, significantly improving security for many applications. This
change was made in the Python 2.7.9 release.

Para las aplicaciones que requieren el antiguo comportamiento anterior, pueden pasar un contexto alternativo:

@example
import urllib2
import ssl

# This disables all verification
context = ssl._create_unverified_context()

# This allows using a specific certificate for the host, which doesn't need
# to be in the trust store
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib2.urlopen("https://invalid-cert", context=context)
@end example

@node PEP 493 Herramientas de migración de verificación HTTPS para Python 2 7,Nuevo objetivo de construcción make regen-all,PEP 476 Habilitar la verificación de certificados por defecto para los clientes http stdlib<2>,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 pep-493-https-verification-migration-tools-for-python-2-7}@anchor{13d9}
@subsubsection PEP 493: Herramientas de migración de verificación HTTPS para Python 2.7


@geindex Python Enhancement Proposals; PEP 493
PEP 493@footnote{https://peps.python.org/pep-0493/} proporciona herramientas de migración adicionales para soportar un proceso de actualización de la infraestructura más incremental para los entornos que contienen aplicaciones y servicios que dependen del procesamiento históricamente permisivo de los certificados de servidor cuando se establecen conexiones HTTPS de cliente.  Estas adiciones se realizaron en la versión 2.7.12 de Python.

Estas herramientas están pensadas para su uso en casos en los que las aplicaciones y servicios afectados no pueden modificarse para pasar explícitamente un contexto SSL más permisivo al establecer la conexión.

Para las aplicaciones y servicios que no pueden ser modificados en absoluto, la nueva variable de entorno @code{PYTHONHTTPSVERIFY} puede establecerse a @code{0} para revertir todo un proceso de Python al comportamiento permisivo por defecto de Python 2.7.8 y anteriores.

For cases where the connection establishment code can’t be modified, but the
overall application can be, the new @code{ssl._https_verify_certificates()}
function can be used to adjust the default behaviour at runtime.

@node Nuevo objetivo de construcción make regen-all,Eliminación del objetivo de construcción make touch,PEP 493 Herramientas de migración de verificación HTTPS para Python 2 7,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 new-make-regen-all-build-target}@anchor{13da}
@subsubsection Nuevo objetivo de construcción @code{make regen-all}


Para simplificar la compilación cruzada, y para asegurar que CPython pueda ser compilado de forma fiable sin requerir que una versión existente de Python esté ya disponible, el sistema de construcción basado en autotools ya no intenta recompilar implícitamente los archivos generados basándose en los tiempos de modificación de los archivos.

En su lugar, se ha añadido un nuevo comando @code{make regen-all} para forzar la regeneración de estos archivos cuando se desee (por ejemplo, después de que se haya construido una versión inicial de Python basada en las versiones pregeneradas).

También se definen objetivos de regeneración más selectivos - ver Makefile.pre.in@footnote{https://github.com/python/cpython/tree/main/Makefile.pre.in} para más detalles.

(Contribución de Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Added in version 2.7.14.


@node Eliminación del objetivo de construcción make touch,,Nuevo objetivo de construcción make regen-all,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7
@anchor{whatsnew/2 7 removal-of-make-touch-build-target}@anchor{13db}
@subsubsection Eliminación del objetivo de construcción @code{make touch}


Se ha eliminado el objetivo de compilación @code{make touch} que anteriormente se utilizaba para solicitar la regeneración implícita de los archivos generados mediante la actualización de sus tiempos de modificación.

Se ha sustituido por el nuevo objetivo @code{make regen-all}.

(Contribución de Victor Stinner en bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Distinto en la versión 2.7.14.


@c ======================================================================

@node Agradecimientos,,Nuevas funciones añadidas a las versiones de mantenimiento de Python 2 7,Qué hay de nuevo en Python 2 7
@anchor{whatsnew/2 7 acknowledgements}@anchor{13dc}@anchor{whatsnew/2 7 acks27}@anchor{13dd}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas sus sugerencias, correcciones y ayuda en varios borradores de este artículo: Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray y Hugh Secker-Walker.

@node Qué hay de nuevo en Python 2 6,Qué hay de nuevo en Python 2 5,Qué hay de nuevo en Python 2 7,Qué hay de nuevo en Python
@anchor{whatsnew/2 6 doc}@anchor{13de}@anchor{whatsnew/2 6 what-s-new-in-python-2-6}@anchor{13df}@anchor{whatsnew/2 6 whats-new-in-2-6}@anchor{1319}
@section Qué hay de nuevo en Python 2.6


@*Autor: 
A.M. Kuchling (amk arroba amk.ca)


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number in a parenthetical comment.
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer some effort going through the SVN logs
@c when researching a change.

Este artículo explica las nuevas funciones de Python 2.6, publicadas el 1 de octubre de 2008. El programa de publicación se describe en 
@geindex Python Enhancement Proposals; PEP 361
PEP 361@footnote{https://peps.python.org/pep-0361/}.

El tema principal de Python 2.6 es preparar el camino de migración a Python 3.0, un importante rediseño del lenguaje. Siempre que sea posible, Python 2.6 incorpora nuevas características y sintaxis de 3.0 mientras sigue siendo compatible con el código existente al no eliminar características o sintaxis más antiguas. Cuando no es posible hacer eso, Python 2.6 intenta hacer lo que puede, agregando funciones de compatibilidad en el módulo @code{future_builtins} y un interruptor @code{-3} para advertir sobre usos que dejarán de ser compatibles en 3.0 .

Se han agregado algunos paquetes nuevos importantes a la biblioteca estándar, como los módulos @ref{94,,multiprocessing} y @ref{82,,json}, pero no hay muchas características nuevas que no estén relacionadas con Python 3.0 de alguna manera.

Python 2.6 también incluye una serie de mejoras y correcciones de errores en el código fuente. Una búsqueda en los registros de cambios encuentra que se aplicaron 259 parches y se corrigieron 612 errores entre Python 2.5 y 2.6. Es probable que ambas cifras estén subestimadas.

Este artículo no intenta proporcionar una especificación completa de las nuevas características, sino que proporciona una conveniente descripción general. Para obtener detalles completos, debe consultar la documentación de Python 2.6. Si desea comprender la justificación del diseño y la implementación, consulte el PEP de una característica nueva en particular. Siempre que sea posible, «Qué hay de nuevo en Python» enlaza con el elemento de error / parche para cada cambio.

@c Compare with previous release in 2 - 3 sentences here.
@c add hyperlink when the documentation becomes available online.

@c ========================================================================

@c Large, PEP-level features and changes should be described here.

@c ========================================================================

@menu
* Python 3.0: Python 3 0. 
* Cambios en el proceso de desarrollo:: 
* PEP 343; La sentencia “with”: PEP 343 La sentencia “with”. 
* PEP 366; Importaciones relativas explícitas desde un módulo principal: PEP 366 Importaciones relativas explícitas desde un módulo principal. 
* PEP 370; Directorio de site-packages por usuario: PEP 370 Directorio de site-packages por usuario. 
* PEP 371; El paquete multiprocessing: PEP 371 El paquete multiprocessing. 
* PEP 3101; Formateo avanzado de cadena de caracteres: PEP 3101 Formateo avanzado de cadena de caracteres. 
* PEP 3105; print como función: PEP 3105 print como función. 
* PEP 3110; Cambios en el manejo de excepciones: PEP 3110 Cambios en el manejo de excepciones. 
* PEP 3112; Literales de bytes: PEP 3112 Literales de bytes. 
* PEP 3116; Nueva biblioteca de E/S: PEP 3116 Nueva biblioteca de E/S. 
* PEP 3118; Protocolo revisado de la memoria intermedia: PEP 3118 Protocolo revisado de la memoria intermedia. 
* PEP 3119; Clases base abstractas: PEP 3119 Clases base abstractas. 
* PEP 3127; Soporte y sintaxis de literales enteros: PEP 3127 Soporte y sintaxis de literales enteros. 
* PEP 3129; Decoradores de clase: PEP 3129 Decoradores de clase. 
* PEP 3141; Una jerarquía de tipos para los números: PEP 3141 Una jerarquía de tipos para los números. 
* Otros cambios lingüísticos:: 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<2>. 
* Cancelaciones y eliminaciones:: 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<3>. 
* Adaptación a Python 2.6: Adaptación a Python 2 6. 
* Agradecimientos: Agradecimientos<2>. 

@end menu

@node Python 3 0,Cambios en el proceso de desarrollo,,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 python-3-0}@anchor{13e0}
@subsection Python 3.0


El ciclo de desarrollo de las versiones 2.6 y 3.0 de Python se sincronizó, y las versiones alfa y beta de ambos lanzamientos se realizaron los mismos días. El desarrollo de 3.0 ha influido en muchas características de 2.6.

Python 3.0 es un rediseño de Python de gran alcance que rompe la compatibilidad con la serie 2.x. Esto significa que el código Python existente necesitará alguna conversión para poder ejecutarse en Python 3.0. Sin embargo, no todos los cambios en 3.0 rompen necesariamente la compatibilidad. En los casos en que las nuevas funciones no provoquen la rotura del código existente, se han actualizado a 2.6 y se describen en este documento en el lugar correspondiente. Algunas de las características derivadas de 3.0 son:


@itemize *

@item 
El método @code{__complex__()} para convertir objetos en un número complejo.

@item 
Sintaxis alternativa para detectar excepciones: @code{except TypeError as exc}.

@item 
La adición de @ref{17d,,functools.reduce()} como sinónimo de la función incorporada @code{reduce()}.
@end itemize

Python 3.0 agrega varias funciones integradas nuevas y cambia la semántica de algunas integradas existentes. Las funciones que son nuevas en 3.0 como @ref{1314,,bin()} simplemente se han agregado a Python 2.6, pero las funciones existentes no se han cambiado; en cambio, el módulo @code{future_builtins} tiene versiones con la nueva semántica 3.0. El código escrito puede ser compatible con 3.0 haciendo @code{from future_builtins import hex, map} según sea necesario.

A new command-line switch, @code{-3}, enables warnings
about features that will be removed in Python 3.0.  You can run code
with this switch to see how much work will be necessary to port
code to 3.0.  The value of this switch is available
to Python code as the boolean variable @code{sys.py3kwarning},
and to C extension code as @code{Py_Py3kWarningFlag}.


@subsubheading Ver también


The 3`xxx' series of PEPs, which contains proposals for Python 3.0.
@geindex Python Enhancement Proposals; PEP 3000
PEP 3000@footnote{https://peps.python.org/pep-3000/} describes the development process for Python 3.0.
Start with 
@geindex Python Enhancement Proposals; PEP 3100
PEP 3100@footnote{https://peps.python.org/pep-3100/} that describes the general goals for Python
3.0, and then explore the higher-numbered PEPs that propose
specific features.


@node Cambios en el proceso de desarrollo,PEP 343 La sentencia “with”,Python 3 0,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 changes-to-the-development-process}@anchor{13e1}
@subsection Cambios en el proceso de desarrollo


Mientras se desarrollaba 2.6, el proceso de desarrollo de Python experimentó dos cambios significativos: cambiamos del seguidor de incidentes (`issue tracker') de SourceForge a una instalación personalizada de Roundup, y la documentación se convirtió de LaTeX a reStructuredText.

@menu
* Nuevo seguidor de incidentes; Roundup: Nuevo seguidor de incidentes Roundup. 
* Nuevo formato de documentación; texto reestructurado con Sphinx: Nuevo formato de documentación texto reestructurado con Sphinx. 

@end menu

@node Nuevo seguidor de incidentes Roundup,Nuevo formato de documentación texto reestructurado con Sphinx,,Cambios en el proceso de desarrollo
@anchor{whatsnew/2 6 new-issue-tracker-roundup}@anchor{13e2}
@subsubsection Nuevo seguidor de incidentes: Roundup


Durante mucho tiempo, los desarrolladores de Python estaban cada vez más molestos por el seguidor de errores de SourceForge. La solución alojada en SourceForge no permite mucha personalización; por ejemplo, no fue posible personalizar el ciclo de vida de los problemas.

Por lo tanto, el comité de infraestructura de la Python Software Foundation publicó una convocatoria de rastreadores de problemas, solicitando voluntarios para configurar diferentes productos e importar algunos de los errores y parches de SourceForge. Se examinaron cuatro rastreadores diferentes: Jira@footnote{https://www.atlassian.com/software/jira/}, Launchpad@footnote{https://launchpad.net/}, Roundup@footnote{https://roundup.sourceforge.io/} y Trac@footnote{https://trac.edgewall.org/}. El comité finalmente se decidió por Jira y Roundup como los dos candidatos. Jira es un producto comercial que ofrece instancias alojadas sin costo para proyectos de software libre; Roundup es un proyecto de código abierto que requiere voluntarios para administrarlo y un servidor para alojarlo.

Después de publicar una llamada para voluntarios, se configuró una nueva instalación de Roundup en @indicateurl{https://bugs.python.org}. Una instalación de Roundup puede alojar varios seguidores, y este servidor ahora también aloja seguidores de problemas para Jython y para el sitio web de Python. Seguramente encontrará otros usos en el futuro. Siempre que sea posible, esta edición de «Qué hay de nuevo en Python» se vincula al elemento de error/parche para cada cambio.

Upfront Systems@footnote{https://upfrontsoftware.co.za} de Stellenbosch, Sudáfrica, proporciona amablemente el alojamiento del rastreador de errores de Python. Martin von Löwis se esforzó mucho en importar errores y parches existentes desde SourceForge; Sus scripts para esta operación de importación están en @code{https://svn.python.org/view/tracker/importer/} y pueden ser útiles para otros proyectos que deseen pasar de SourceForge a Roundup.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://bugs.python.org}

El seguidor de errores de Python.

@item @indicateurl{https://bugs.jython.org}:

El seguidor de errores de Jython.

@item @indicateurl{https://roundup.sourceforge.io/}

Descargas y documentación de Roundup.

@item @indicateurl{https://svn.python.org/view/tracker/importer/}

Scripts de conversión de Martin von Löwis.
@end table


@node Nuevo formato de documentación texto reestructurado con Sphinx,,Nuevo seguidor de incidentes Roundup,Cambios en el proceso de desarrollo
@anchor{whatsnew/2 6 new-documentation-format-restructuredtext-using-sphinx}@anchor{13e3}
@subsubsection Nuevo formato de documentación: texto reestructurado con Sphinx


La documentación de Python se escribió usando LaTeX desde que el proyecto comenzó alrededor de 1989. En la década de 1980 y principios de la de 1990, la mayor parte de la documentación se imprimió para su estudio posterior, no se vio en línea. LaTeX fue ampliamente utilizado porque proporcionaba una salida impresa atractiva sin dejar de ser sencillo de escribir una vez que se aprendían las reglas básicas de marcado.

Hoy en día, LaTeX todavía se usa para escribir publicaciones destinadas a la impresión, pero el panorama de las herramientas de programación ha cambiado. Ya no imprimimos montones de documentación; en su lugar, lo navegamos en línea y HTML se ha convertido en el formato más importante para dar soporte. Desafortunadamente, convertir LaTeX a HTML es bastante complicado y Fred L. Drake Jr., el editor de documentación de Python desde hace mucho tiempo, pasó mucho tiempo manteniendo el proceso de conversión. De vez en cuando, la gente sugeriría convertir la documentación a SGML y luego a XML, pero realizar una buena conversión es una tarea importante y nadie comprometió el tiempo necesario para terminar el trabajo.

Durante el ciclo de desarrollo 2.6, Georg Brandl se esforzó mucho en construir una nueva cadena de herramientas para procesar la documentación. El paquete resultante se llama Sphinx y está disponible en @indicateurl{https://www.sphinx-doc.org/}.

Sphinx se concentra en la salida HTML, produciendo HTML moderno y con un estilo atractivo; la salida impresa todavía se admite mediante la conversión a LaTeX. El formato de entrada es reStructuredText, una sintaxis de marcado que admite extensiones y directivas personalizadas que se usa comúnmente en la comunidad de Python.

Sphinx es un paquete independiente que se puede usar para escribir, y casi dos docenas de otros proyectos (enumerados en el sitio web de Sphinx@footnote{https://www.sphinx-doc.org/en/master/examples.html}) han adoptado Sphinx como su herramienta de documentación.


@subsubheading Ver también



@table @asis

@item Documentando Python@footnote{https://devguide.python.org/documenting/}

Describe cómo escribir para la documentación de Python.

@item Sphinx@footnote{https://www.sphinx-doc.org/}

Documentación y código para la cadena de herramientas Sphinx.

@item Docutils@footnote{https://docutils.sourceforge.io}

El analizador sintáctico y el conjunto de herramientas `reStructuredText' subyacentes.
@end table


@node PEP 343 La sentencia “with”,PEP 366 Importaciones relativas explícitas desde un módulo principal,Cambios en el proceso de desarrollo,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-0343}@anchor{131a}@anchor{whatsnew/2 6 pep-343-the-with-statement}@anchor{13e4}
@subsection PEP 343: La sentencia `“with”'


La versión anterior, Python 2.5, agregó la instrucción “@ref{673,,with}” como una característica opcional, para ser habilitada por una directiva @code{from __future__ import with_statement}. En 2.6, la instrucción ya no necesita estar habilitada especialmente; esto significa que ahora @code{with} es siempre una palabra clave. El resto de esta sección es una copia de la sección correspondiente del documento «Qué hay de nuevo en Python 2.5»; si está familiarizado con la declaración “@code{with}” de Python 2.5, puede omitir esta sección.

La sentencia “@ref{673,,with}” resuelve el código que anteriormente usaría bloques @code{try...finally} para garantizar que el código de limpieza se ejecute. En esta sección, discutiré como se usará comúnmente la declaración. En la siguiente sección, examinaré los detalles de la implementación y mostraré cómo escribir objetos para usar con esta declaración.

La sentencia “@ref{673,,with}” es una estructura de control de flujo cuya estructura básica es:

@example
with expression [as variable]:
    with-block
@end example

The expression is evaluated, and it should result in an object that supports the
context management protocol (that is, has @ref{669,,__enter__()} and @ref{1367,,__exit__()}
methods).

The object’s @ref{669,,__enter__()} is called before `with-block' is executed and
therefore can run set-up code. It also may return a value that is bound to the
name `variable', if given.  (Note carefully that `variable' is `not' assigned
the result of `expression'.)

After execution of the `with-block' is finished, the object’s @ref{1367,,__exit__()}
method is called, even if the block raised an exception, and can therefore run
clean-up code.

Algunos objetos estándar de Python ahora admiten el protocolo de administración de contexto y se pueden usar con la sentencia “@ref{673,,with}”. Los objetos de archivo son un ejemplo:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...
@end example

Después de que se haya ejecutado esta sentencia, el objeto de archivo en `f' se habrá cerrado automáticamente, incluso si el bucle @ref{1eb,,for} generó una excepción en la mitad del bloque.

@cartouche
@quotation Nota 
In this case, `f' is the same object created by @ref{1be,,open()}, because
@ref{669,,__enter__()} returns `self'.
@end quotation
@end cartouche

Los `locks' y las condiciones variables del módulo @ref{ed,,threading} también admiten la sentencia “@ref{673,,with}”:

@example
lock = threading.Lock()
with lock:
    # Critical section of code
    ...
@end example

El `lock' se adquiere antes de que se ejecute el bloque y siempre se libera una vez que este se completa.

La función @code{localcontext()} en el módulo @ref{37,,decimal} facilita guardar y restaurar el contexto decimal actual, que encapsula la precisión deseada y las características de redondeo para los cálculos:

@example
from decimal import Decimal, Context, localcontext

# Displays with default precision of 28 digits
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # All code in this block uses a precision of 16 digits.
    # The original context is restored on exiting the block.
    print v.sqrt()
@end example

@menu
* Escribiendo gestores de contexto:: 
* El módulo contextlib:: 

@end menu

@node Escribiendo gestores de contexto,El módulo contextlib,,PEP 343 La sentencia “with”
@anchor{whatsnew/2 6 new-26-context-managers}@anchor{131b}@anchor{whatsnew/2 6 writing-context-managers}@anchor{13e5}
@subsubsection Escribiendo gestores de contexto


Por detrás, la sentencia “@ref{673,,with}” es bastante complicada. La mayoría de las personas solo usarán “@code{with}” en compañía de objetos existentes y no necesitan conocer estos detalles, por lo que puede omitir el resto de esta sección si lo desea. Los autores de nuevos objetos deberán comprender los detalles de la implementación subyacente y deben seguir leyendo.

Una explicación de alto nivel del protocolo de gestor de contexto es:


@itemize *

@item 
The expression is evaluated and should result in an object called a «context
manager».  The context manager must have @ref{669,,__enter__()} and @ref{1367,,__exit__()}
methods.

@item 
The context manager’s @ref{669,,__enter__()} method is called.  The value returned
is assigned to `VAR'.  If no @code{as VAR} clause is present, the value is simply
discarded.

@item 
Se ejecuta el código en `BLOCK'.

@item 
If `BLOCK' raises an exception, the context manager’s @ref{1367,,__exit__()} method
is called with three arguments, the exception details (@code{type, value, traceback},
the same values returned by @ref{72b,,sys.exc_info()}, which can also be @code{None}
if no exception occurred).  The method’s return value controls whether an exception
is re-raised: any false value re-raises the exception, and @code{True} will result
in suppressing it.  You’ll only rarely want to suppress the exception, because
if you do the author of the code containing the “@ref{673,,with}” statement will
never realize anything went wrong.

@item 
If `BLOCK' didn’t raise an exception,  the @ref{1367,,__exit__()} method is still
called, but `type', `value', and `traceback' are all @code{None}.
@end itemize

Pensemos en un ejemplo. No presentaré un código detallado, solo bosquejaré los métodos necesarios para una base de datos que admita transacciones.

(Para las personas que no están familiarizadas con la terminología de la base de datos: un conjunto de cambios en la base de datos se agrupa en una transacción. Las transacciones pueden confirmarse, lo que significa que todos los cambios se escriben en la base de datos, o deshacerse, lo que significa que todos los cambios se descartan y la base de datos no ha cambiado. Consulte cualquier libro de texto de base de datos para obtener más información.)

Supongamos que hay un objeto que representa una conexión de base de datos. Nuestro objetivo será permitir que el usuario escriba un código como este:

@example
db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... more operations ...
@end example

La transacción debe confirmarse si el código del bloque se ejecuta sin problemas o revertirse si hay una excepción. Aquí está la interfaz básica para @code{DatabaseConnection} que asumiré:

@example
class DatabaseConnection:
    # Database interface
    def cursor(self):
        "Returns a cursor object and starts a new transaction"
    def commit(self):
        "Commits current transaction"
    def rollback(self):
        "Rolls back current transaction"
@end example

The @ref{669,,__enter__()} method is pretty easy, having only to start a new
transaction.  For this application the resulting cursor object would be a useful
result, so the method will return it.  The user can then add @code{as cursor} to
their “@ref{673,,with}” statement to bind the cursor to a variable name.

@example
class DatabaseConnection:
    ...
    def __enter__(self):
        # Code to start a new transaction
        cursor = self.cursor()
        return cursor
@end example

The @ref{1367,,__exit__()} method is the most complicated because it’s where most of
the work has to be done.  The method has to check if an exception occurred.  If
there was no exception, the transaction is committed.  The transaction is rolled
back if there was an exception.

En el siguiente código, la ejecución simplemente caerá al final de la función, retornando el valor predeterminado @code{None}. @code{None} es falso, por lo que la excepción se volverá a lanzar automáticamente. Si lo desea, puede ser más explícito y agregar una sentencia @ref{a60,,return} en la ubicación marcada.

@example
class DatabaseConnection:
    ...
    def __exit__(self, type, value, tb):
        if tb is None:
            # No exception, so commit
            self.commit()
        else:
            # Exception occurred, so rollback.
            self.rollback()
            # return False
@end example

@node El módulo contextlib,,Escribiendo gestores de contexto,PEP 343 La sentencia “with”
@anchor{whatsnew/2 6 new-module-contextlib}@anchor{131c}@anchor{whatsnew/2 6 the-contextlib-module}@anchor{13e6}
@subsubsection El módulo contextlib


El módulo @ref{24,,contextlib} proporciona algunas funciones y un decorador que son útiles al escribir objetos para usar con la sentencia “@ref{673,,with}”.

The decorator is called @code{contextmanager()}, and lets you write a single
generator function instead of defining a new class.  The generator should yield
exactly one value.  The code up to the @ref{a5f,,yield} will be executed as the
@ref{669,,__enter__()} method, and the value yielded will be the method’s return
value that will get bound to the variable in the “@ref{673,,with}” statement’s
@code{as} clause, if any.  The code after the @code{yield} will be
executed in the @ref{1367,,__exit__()} method.  Any exception raised in the block will
be raised by the @code{yield} statement.

Usando este decorador, nuestro ejemplo de base de datos de la sección anterior podría escribirse como:

@example
from contextlib import contextmanager

@@contextmanager
def db_transaction(connection):
    cursor = connection.cursor()
    try:
        yield cursor
    except:
        connection.rollback()
        raise
    else:
        connection.commit()

db = DatabaseConnection()
with db_transaction(db) as cursor:
    ...
@end example

El módulo @ref{24,,contextlib} también tiene una función @code{nested(mgr1, mgr2, ...)} que combina varios gestores de contexto para que no necesite escribir sentencias “@ref{673,,with}” anidadas. En este ejemplo, se utiliza una única sentencia “@code{with}” que inicia una transacción de base de datos y adquiere un bloqueo del hilo:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

Por último, la función @code{close()} retorna su argumento para que pueda vincularse a una variable, y llama al método @code{.close()} del argumento al final del bloque.

@example
import urllib, sys
from contextlib import closing

with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    for line in f:
        sys.stdout.write(line)
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - La sentencia «with»

PEP escrito por Guido van Rossum y Nick Coghlan; implementado por Mike Bland, Guido van Rossum y Neal Norwitz. El PEP muestra el código generado para una sentencia “@ref{673,,with}”, que puede ser útil para aprender cómo la sentencia funciona.
@end table

La documentación para el módulo @ref{24,,contextlib}.


@c ======================================================================

@node PEP 366 Importaciones relativas explícitas desde un módulo principal,PEP 370 Directorio de site-packages por usuario,PEP 343 La sentencia “with”,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-0366}@anchor{131d}@anchor{whatsnew/2 6 pep-366-explicit-relative-imports-from-a-main-module}@anchor{13e7}
@subsection PEP 366: Importaciones relativas explícitas desde un módulo principal


El modificador de Python @ref{187,,-m} permite ejecutar un módulo como un script. Cuando ejecutabas un módulo que estaba ubicado dentro de un paquete, las importaciones relativas no funcionaban correctamente.

The fix for Python 2.6 adds a @ref{1cd,,module.__package__} attribute.
When this attribute is present, relative imports will be
relative to the value of this attribute instead of the
@ref{13e8,,__name__} attribute.

PEP 302-style importers can then set @ref{1cd,,__package__} as necessary.
The @ref{be,,runpy} module that implements the @ref{187,,-m} switch now
does this, so relative imports will now work correctly in scripts
running from inside a package.

@c ======================================================================

@node PEP 370 Directorio de site-packages por usuario,PEP 371 El paquete multiprocessing,PEP 366 Importaciones relativas explícitas desde un módulo principal,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-0370}@anchor{131e}@anchor{whatsnew/2 6 pep-370-per-user-site-packages-directory}@anchor{13e9}
@subsection PEP 370: Directorio de @code{site-packages} por usuario


Cuando ejecuta Python, la ruta de búsqueda del módulo @code{sys.path} generalmente incluye un directorio cuya ruta termina en @code{"site-packages"}. Este directorio está destinado a contener paquetes instalados localmente disponibles para todos los usuarios que utilizan una máquina o un sitio de instalación en particular.

Python 2.6 introduce una convención para directorios de sitios específicos del usuario. El directorio varía según la plataforma:


@itemize *

@item 
Unix y Mac OS X: @code{~/.local/}

@item 
Windows: @code{%APPDATA%/Python}
@end itemize

Dentro de este directorio, habrá subdirectorios específicos de versión, como @code{lib/python2.6/site-packages} en Unix/Mac OS y @code{Python26/site-packages} en Windows.

Si no le gusta el directorio predeterminado, puede sobrescribirlo mediante una variable de entorno. 
@geindex PYTHONUSERBASE
@geindex variables de entorno; PYTHONUSERBASE
@ref{13ea,,PYTHONUSERBASE} establece el directorio raíz utilizado para todas las versiones de Python que admiten esta función. En Windows, el directorio de datos específicos de la aplicación se puede cambiar configurando la variable de entorno 
@geindex APPDATA
@geindex variables de entorno; APPDATA
@code{APPDATA}. También puede modificar el archivo @code{site.py} para su instalación de Python.

La característica se puede desactivar por completo ejecutando Python con la opción @ref{13eb,,-s} o `seteando' la variable de entorno 
@geindex PYTHONNOUSERSITE
@geindex variables de entorno; PYTHONNOUSERSITE
@ref{13ec,,PYTHONNOUSERSITE}.


@subsubheading Ver también



@table @asis

@item PEP 370: Directorio de @code{site-packages} por usuario

PEP escrito e implementado por Christian Heimes.
@end table


@c ======================================================================

@node PEP 371 El paquete multiprocessing,PEP 3101 Formateo avanzado de cadena de caracteres,PEP 370 Directorio de site-packages por usuario,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-0371}@anchor{131f}@anchor{whatsnew/2 6 pep-371-the-multiprocessing-package}@anchor{13ed}
@subsection PEP 371: El paquete @code{multiprocessing}


El nuevo paquete @ref{94,,multiprocessing} permite a los programas de Python crear nuevos procesos que realizarán un cálculo y retornaran un resultado al padre. Los procesos padre e hijo pueden comunicarse mediante colas (`queues') y tuberías (`pipes'), sincronizar sus operaciones mediante bloqueos y semáforos, y pueden compartir matrices simples de datos.

El módulo @ref{94,,multiprocessing} comenzó como una emulación exacta del módulo @ref{ed,,threading} usando procesos en lugar de hilos. Ese objetivo se descartó en el camino a Python 2.6, pero el enfoque general del módulo sigue siendo similar. La clase fundamental es @code{Process}, a la que se le pasa un objeto invocable y una colección de argumentos. El método @code{start()} establece el invocable ejecutándose en un subproceso, después de lo cual se puede llamar al método @code{is_alive()} para verificar si el subproceso aún se está ejecutando y al método @code{join()} para esperar al proceso para salir.

Aquí hay un ejemplo simple donde el subproceso calculará un factorial. La función que realiza el cálculo está escrita de forma extraña, por lo que lleva mucho más tiempo cuando el argumento de entrada es un múltiplo de 4.

@example
import time
from multiprocessing import Process, Queue


def factorial(queue, N):
    "Compute a factorial."
    # If N is a multiple of 4, this function will take much longer.
    if (N % 4) == 0:
        time.sleep(.05 * N/4)

    # Calculate the result
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # Put the result on the queue
    queue.put(fact)

if __name__ == '__main__':
    queue = Queue()

    N = 5

    p = Process(target=factorial, args=(queue, N))
    p.start()
    p.join()

    result = queue.get()
    print 'Factorial', N, '=', result
@end example

Un @ref{13ee,,Queue} se usa para comunicar el resultado del factorial. El objeto @ref{13ee,,Queue} se almacena en una variable global. El proceso hijo usará el valor de la variable cuando se creó el hijo; porque es una @code{Queue}, padre e hijo pueden usar el objeto para comunicarse. (Si el padre cambiara el valor de la variable global, el valor del hijo no se vería afectado y viceversa).

Otras dos clases, @code{Pool} y @code{Manager}, proporcionan interfaces de nivel superior. @code{Pool} creará un número fijo de procesos de trabajo, y las solicitudes se pueden distribuir a los trabajadores llamando a @code{apply()} o @code{apply_async()} para agregar una sola solicitud, y @ref{14c,,map()} o @code{map_async()} para agregar una serie de solicitudes. El siguiente código usa @code{Pool} para distribuir las solicitudes en 5 procesos de trabajo y recuperar una lista de resultados:

@example
from multiprocessing import Pool

def factorial(N, dictionary):
    "Compute a factorial."
    ...
p = Pool(5)
result = p.map(factorial, range(1, 1000, 10))
for v in result:
    print v
@end example

Esto produce la siguiente salida:

@example
1
39916800
51090942171709440000
8222838654177922817725562880000000
33452526613163807108170062053440751665152000000000
...
@end example

La otra interfaz de alto nivel, la clase @code{Manager}, crea un proceso de servidor separado que puede contener copias maestras de las estructuras de datos de Python. Luego, otros procesos pueden acceder y modificar estas estructuras de datos utilizando objetos proxy. El siguiente ejemplo crea un diccionario compartido llamando al método @ref{190,,dict()}; los procesos de trabajo luego insertan valores en el diccionario. (El bloqueo no se realiza automáticamente, lo cual no importa en este ejemplo. Los métodos de @code{Manager} también incluyen @code{Lock()}, @code{RLock()}, y @code{Semaphore()} para crear bloqueos compartidos.)

@example
import time
from multiprocessing import Pool, Manager

def factorial(N, dictionary):
    "Compute a factorial."
    # Calculate the result
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # Store result in dictionary
    dictionary[N] = fact

if __name__ == '__main__':
    p = Pool(5)
    mgr = Manager()
    d = mgr.dict()         # Create shared dictionary

    # Run tasks using the pool
    for N in range(1, 1000, 10):
        p.apply_async(factorial, (N, d))

    # Mark pool as closed -- no more tasks can be added.
    p.close()

    # Wait for tasks to exit
    p.join()

    # Output results
    for k, v in sorted(d.items()):
        print k, v
@end example

Esto producirá la salida:

@example
1 1
11 39916800
21 51090942171709440000
31 8222838654177922817725562880000000
41 33452526613163807108170062053440751665152000000000
51 15511187532873822802242430164693032110632597200169861120000...
@end example


@subsubheading Ver también


La documentación del módulo @ref{94,,multiprocessing}.


@table @asis

@geindex Python Enhancement Proposals; PEP 371

@item PEP 371@footnote{https://peps.python.org/pep-0371/} - Adición del paquete de multiprocesamiento

PEP escrito por Jesse Noller y Richard Oudkerk; implementado por Richard Oudkerk y Jesse Noller.
@end table


@c ======================================================================

@node PEP 3101 Formateo avanzado de cadena de caracteres,PEP 3105 print como función,PEP 371 El paquete multiprocessing,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3101}@anchor{1320}@anchor{whatsnew/2 6 pep-3101-advanced-string-formatting}@anchor{13ef}
@subsection PEP 3101: Formateo avanzado de cadena de caracteres


En Python 3.0, el operador @code{%} se complementa con un método de formato de cadena más potente, @ref{6c0,,format()}. La compatibilidad con el método @ref{6c2,,str.format()} se ha retroalimentado a Python 2.6.

En 2.6, tanto las cadenas de 8 bits como las Unicode tienen un método @code{.format()} que trata la cadena como una plantilla y toma los argumentos para formatear. La plantilla de formato utiliza llaves (@code{@{}, @code{@}}) como caracteres especiales:

@example
>>> # Substitute positional argument 0 into the string.
>>> "User ID: @{0@}".format("root")
'User ID: root'
>>> # Use the named keyword arguments
>>> "User ID: @{uid@}   Last seen: @{last_login@}".format(
...    uid="root",
...    last_login = "5 Mar 2008 07:20")
'User ID: root   Last seen: 5 Mar 2008 07:20'
@end example

Las llaves se pueden escapar duplicándose:

@example
>>> "Empty dict: @{@{@}@}".format()
"Empty dict: @{@}"
@end example

Los nombres de campo pueden ser números enteros que indican argumentos posicionales, como @code{@{0@}}, @code{@{1@}}, etc. o nombres de argumentos de palabras clave. También puede proporcionar nombres de campos compuestos que lean atributos o accedan a claves de diccionario:

@example
>>> import sys
>>> print 'Platform: @{0.platform@}\nPython version: @{0.version@}'.format(sys)
Platform: darwin
Python version: 2.6a1+ (trunk:61261M, Mar  5 2008, 20:29:41)
[GCC 4.0.1 (Apple Computer, Inc. build 5367)]'

>>> import mimetypes
>>> 'Content-type: @{0[.mp4]@}'.format(mimetypes.types_map)
'Content-type: video/mp4'
@end example

Tenga en cuenta que cuando utilice una notación de estilo diccionario como @code{[.mp4]}, no es necesario poner comillas alrededor de la cadena; se buscará el valor usando @code{.mp4} como clave. Las cadenas de caracteres que comienzan con un número se convertirán en entero. No puede escribir expresiones más complicadas dentro de una cadena de formato.

Hasta ahora hemos mostrado cómo especificar qué campo sustituir en la cadena resultante. El formato preciso utilizado también se puede controlar agregando dos puntos seguidos de un especificador de formato. Por ejemplo:

@example
>>> # Field 0: left justify, pad to 15 characters
>>> # Field 1: right justify, pad to 6 characters
>>> fmt = '@{0:15@} $@{1:>6@}'
>>> fmt.format('Registration', 35)
'Registration    $    35'
>>> fmt.format('Tutorial', 50)
'Tutorial        $    50'
>>> fmt.format('Banquet', 125)
'Banquet         $   125'
@end example

Los especificadores de formato pueden hacer referencia a otros campos a través del anidamiento:

@example
>>> fmt = '@{0:@{1@}@}'
>>> width = 15
>>> fmt.format('Invoice #1234', width)
'Invoice #1234  '
>>> width = 35
>>> fmt.format('Invoice #1234', width)
'Invoice #1234                      '
@end example

Se puede especificar la alineación de un campo dentro del ancho deseado:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Carácter

@tab

Efecto

@item

< (por defecto)

@tab

Alinear a la izquierda

@item

>

@tab

Alinear a la derecha

@item

^

@tab

Centrado

@item

=

@tab

(Solo para tipos numéricos) Relleno después del signo.

@end multitable


Los especificadores de formato también pueden incluir un tipo de presentación, que controla cómo se formatea el valor. Por ejemplo, los números de punto flotante pueden formatearse como un número general o en notación exponencial:

@example
>>> '@{0:g@}'.format(3.75)
'3.75'
>>> '@{0:e@}'.format(3.75)
'3.750000e+00'
@end example

Hay una variedad de tipos de presentación disponibles. Consulte la documentación 2.6 para obtener una @ref{13f0,,lista completa}; aquí hay un ejemplo:


@multitable {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{b}

@tab

Binario. Emite el número en base 2.

@item

@code{c}

@tab

Carácter. Convierte el número entero en el carácter Unicode correspondiente antes de imprimirlo.

@item

@code{d}

@tab

Entero Decimal. Muestra el número en base 10.

@item

@code{o}

@tab

Formato octal. Da salida al número en base 8.

@item

@code{x}

@tab

Formato hexadecimal. Muestra el número en base 16, utilizando letras minúsculas para los dígitos superiores a 9.

@item

@code{e}

@tab

Notación de exponente. Imprime el número en notación científica utilizando la letra “e” para indicar el exponente.

@item

@code{g}

@tab

Formato general. Esto imprime el número como un número de punto fijo, a menos que el número sea demasiado grande, en cuyo caso cambia a la notación de exponente “e”.

@item

@code{n}

@tab

Número. Es lo mismo que “g” (para flotantes) o “d” (para enteros), salvo que utiliza la configuración regional actual para insertar los caracteres separadores de números adecuados.

@item

@code{%}

@tab

Porcentaje. Multiplica el número por 100 y lo muestra en formato fijo (“f”), seguido de un signo de porcentaje.

@end multitable


Las clases y los tipos pueden definir un método @code{__format__()} para controlar cómo se formatean.  Recibe un único argumento, el especificador de formato:

@example
def __format__(self, format_spec):
    if isinstance(format_spec, unicode):
        return unicode(str(self))
    else:
        return str(self)
@end example

También hay un builtin @ref{6c0,,format()} que formateará un solo valor.  Llama al método @code{__format__()} del tipo con el especificador proporcionado:

@example
>>> format(75.6564, '.2f')
'75.66'
@end example


@subsubheading Ver también



@table @asis

@item @ref{13f0,,Sintaxis de formateo de cadena}

La documentación de referencia para los campos de formato.

@geindex Python Enhancement Proposals; PEP 3101

@item PEP 3101@footnote{https://peps.python.org/pep-3101/} - Formato avanzado de cadenas

PEP escrito por Talin. Implementado por Eric Smith.
@end table


@c ======================================================================

@node PEP 3105 print como función,PEP 3110 Cambios en el manejo de excepciones,PEP 3101 Formateo avanzado de cadena de caracteres,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3105}@anchor{1321}@anchor{whatsnew/2 6 pep-3105-print-as-a-function}@anchor{13f1}
@subsection PEP 3105: @code{print} como función


La sentencia @code{print} se convierte en la función @ref{ff4,,print()} en Python 3.0. Hacer de @ref{ff4,,print()} una función hace posible reemplazar la función haciendo @code{def print(...)} o importando una nueva función desde otro lugar.

Python 2.6 tiene una importación @code{__future__} que elimina @code{print} como sintaxis del lenguaje, permitiéndote usar la forma funcional en su lugar.  Por ejemplo:

@example
>>> from __future__ import print_function
>>> print('# of entries', len(dictionary), file=sys.stderr)
@end example

La firma de la nueva función es:

@example
def print(*args, sep=' ', end='\n', file=None)
@end example

Los parámetros son:


@itemize *

@item 
`args': argumentos posicionales cuyos valores se imprimirán.

@item 
`sep': el separador que se imprimirá entre los argumentos.

@item 
`end': el texto final, que se imprimirá después de que se hayan emitido todos los argumentos.

@item 
`archivo': el objeto archivo al que se enviará la salida.
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3105

@item PEP 3105@footnote{https://peps.python.org/pep-3105/} - Hacer de la impresión una función

PEP escrito por Georg Brandl.
@end table


@c ======================================================================

@node PEP 3110 Cambios en el manejo de excepciones,PEP 3112 Literales de bytes,PEP 3105 print como función,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3110}@anchor{1322}@anchor{whatsnew/2 6 pep-3110-exception-handling-changes}@anchor{13f2}
@subsection PEP 3110: Cambios en el manejo de excepciones


Un error que ocasionalmente cometen los programadores de Python es escribir el siguiente código:

@example
try:
    ...
except TypeError, ValueError:  # Wrong!
    ...
@end example

El autor probablemente está tratando de atrapar ambas excepciones @ref{228,,TypeError} y @ref{360,,ValueError}, pero este código en realidad hace algo diferente: atrapará @ref{228,,TypeError} y vinculará el objeto de excepción resultante al nombre local @code{"ValueError"}.  La excepción @ref{360,,ValueError} no será capturada en absoluto.  El código correcto especifica una tupla de excepciones:

@example
try:
    ...
except (TypeError, ValueError):
    ...
@end example

Este error se produce porque el uso de la coma aquí es ambiguo: ¿indica dos nodos diferentes en el árbol de análisis sintáctico, o un único nodo que es una tupla?

Python 3.0 hace que esto sea inequívoco al sustituir la coma por la palabra «as».  Para atrapar una excepción y almacenar el objeto de excepción en la variable @code{exc}, debes escribir:

@example
try:
    ...
except TypeError as exc:
    ...
@end example

Python 3.0 sólo soporta el uso de «as», y por lo tanto interpreta el primer ejemplo como la captura de dos excepciones diferentes.  Python 2.6 soporta tanto la coma como «as», por lo que el código existente seguirá funcionando.  Por lo tanto, sugerimos utilizar «as» cuando se escriba nuevo código Python que sólo se ejecutará con la versión 2.6.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3110

@item PEP 3110@footnote{https://peps.python.org/pep-3110/} - Captura de excepciones en Python 3000

PEP escrito y ejecutado por Collin Winter.
@end table


@c ======================================================================

@node PEP 3112 Literales de bytes,PEP 3116 Nueva biblioteca de E/S,PEP 3110 Cambios en el manejo de excepciones,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3112}@anchor{1323}@anchor{whatsnew/2 6 pep-3112-byte-literals}@anchor{13f3}
@subsection PEP 3112: Literales de bytes


Python 3.0 adopta Unicode como el tipo de cadena fundamental del lenguaje y denota los literales de 8 bits de forma diferente, ya sea como @code{b'string} o utilizando un constructor @ref{325,,bytes}.  Por compatibilidad futura, Python 2.6 añade @ref{325,,bytes} como sinónimo del tipo @ref{237,,str}, y también soporta la notación @code{b'@w{'}}.

El tipo @ref{237,,str} de la versión 2.6 difiere del tipo @ref{325,,bytes} de la versión 3.0 en varios aspectos; el más notable es que el constructor es completamente diferente.  En la 3.0, @code{bytes([65, 66, 67])} tiene 3 elementos, que contienen los bytes que representan @code{ABC}; en la 2.6, @code{bytes([65, 66, 67])} devuelve la cadena de 12 bytes que representa el @ref{237,,str()} de la lista.

El uso principal de @ref{325,,bytes} en 2.6 será escribir pruebas de tipo de objeto como @code{isinstance(x, bytes)}.  Esto ayudará al convertidor de 2 a 3, que no puede decir si el código de 2.x pretende que las cadenas contengan caracteres o bytes de 8 bits; ahora puede utilizar @ref{325,,bytes} o @ref{237,,str} para representar su intención exactamente, y el código resultante también será correcto en Python 3.0.

También hay una importación @code{__future__} que hace que todos los literales de cadena se conviertan en cadenas Unicode.  Esto significa que las secuencias de escape @code{u} pueden ser utilizadas para incluir caracteres Unicode:

@example
from __future__ import unicode_literals

s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
     '\u3081\u3000\u751f\u305f\u307e\u3054')

print len(s)               # 12 Unicode characters
@end example

A nivel de C, Python 3.0 renombrará el tipo de cadena de 8 bits existente, llamado @code{PyStringObject} en Python 2.x, a @ref{82b,,PyBytesObject}.  Python 2.6 utiliza @code{#define} para soportar el uso de los nombres @ref{82b,,PyBytesObject()}, @ref{13f4,,PyBytes_Check()}, @ref{13f5,,PyBytes_FromStringAndSize()}, y todas las demás funciones y macros utilizadas con cadenas.

Las instancias del tipo @ref{325,,bytes} son inmutables al igual que las cadenas.  Un nuevo tipo @ref{5e0,,bytearray} almacena una secuencia mutable de bytes:

@example
>>> bytearray([65, 66, 67])
bytearray(b'ABC')
>>> b = bytearray(u'\u21ef\u3244', 'utf-8')
>>> b
bytearray(b'\xe2\x87\xaf\xe3\x89\x84')
>>> b[0] = '\xe3'
>>> b
bytearray(b'\xe3\x87\xaf\xe3\x89\x84')
>>> unicode(str(b), 'utf-8')
u'\u31ef \u3244'
@end example

Las matrices de bytes admiten la mayoría de los métodos de los tipos de cadena, como @code{startswith()}/@code{endswith()}, @code{find()}/@code{rfind()}, y algunos de los métodos de las listas, como @code{append()}, @code{pop()} y @code{reverse()}.

@example
>>> b = bytearray('ABC')
>>> b.append('d')
>>> b.append(ord('e'))
>>> b
bytearray(b'ABCde')
@end example

También existe la correspondiente API en C, con @ref{13f6,,PyByteArray_FromObject()}, @ref{13f7,,PyByteArray_FromStringAndSize()}, y varias otras funciones.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3112

@item PEP 3112@footnote{https://peps.python.org/pep-3112/} - Literales de bytes en Python 3000

PEP escrito por Jason Orendorff; retroalimentado a 2.6 por Christian Heimes.
@end table


@c ======================================================================

@node PEP 3116 Nueva biblioteca de E/S,PEP 3118 Protocolo revisado de la memoria intermedia,PEP 3112 Literales de bytes,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3116}@anchor{1324}@anchor{whatsnew/2 6 pep-3116-new-i-o-library}@anchor{13f8}
@subsection PEP 3116: Nueva biblioteca de E/S


Los objetos de archivo incorporados en Python soportan una serie de métodos, pero los objetos que imitan a los archivos no necesariamente los soportan todos.  Los objetos que imitan a los archivos normalmente soportan @code{read()} y @code{write()}, pero pueden no soportar @ref{ba,,readline()}, por ejemplo.  Python 3.0 introduce una biblioteca de E/S por capas en el módulo @ref{7f,,io} que separa las funciones de almacenamiento en búfer y manejo de texto de las operaciones fundamentales de lectura y escritura.

Existen tres niveles de clases base abstractas proporcionadas por el módulo @ref{7f,,io}:


@itemize *

@item 
@code{RawIOBase} define las operaciones de E/S en bruto: @code{read()}, @code{readinto()}, @code{write()}, @code{seek()}, @code{tell()}, @code{truncate()}, y @code{close()}. La mayoría de los métodos de esta clase suelen corresponder a una única llamada al sistema. También hay métodos @code{readable()}, @code{writable()} y @code{seekable()} para determinar qué operaciones permite un objeto dado.

Python 3.0 tiene implementaciones concretas de esta clase para archivos y sockets, pero Python 2.6 no ha reestructurado sus objetos archivo y socket de esta manera.

@item 
@code{BufferedIOBase} es una clase base abstracta que almacena los datos en la memoria para reducir el número de llamadas al sistema, haciendo más eficiente el procesamiento de E/S. Soporta todos los métodos de @code{RawIOBase}, y añade un atributo @code{raw} que contiene el objeto crudo subyacente.

Hay cinco clases concretas que implementan este ABC. @code{BufferedWriter} y @code{BufferedReader} son para objetos que soportan el uso de sólo escritura o de sólo lectura que tienen un método @code{seek()} para el acceso aleatorio. Los objetos @code{BufferedRandom} soportan el acceso de lectura y escritura sobre el mismo flujo subyacente, y @code{BufferedRWPair} es para objetos como los TTYs que tienen operaciones de lectura y escritura actuando sobre flujos de datos desconectados. La clase @code{BytesIO} permite leer, escribir y buscar sobre un buffer en memoria.

@geindex nuevas líneas universales;Qué hay de nuevo

@item 
@code{TextIOBase}: Proporciona funciones para leer y escribir cadenas (recuerde que las cadenas serán Unicode en Python 3.0), y soporta @ref{dc1,,universal newlines}. @code{TextIOBase} define el método @ref{ba,,readline()} y soporta la iteración sobre objetos.

Hay dos implementaciones concretas. @code{TextIOWrapper} envuelve un objeto de E/S con buffer, soportando todos los métodos de E/S de texto y añadiendo un atributo @code{buffer} para acceder al objeto subyacente. @code{StringIO} simplemente almacena todo en memoria sin escribir nunca nada en el disco.

(In Python 2.6, @ref{fa9,,io.StringIO} is implemented in
pure Python, so it’s pretty slow.   You should therefore stick with the
existing @code{StringIO} module or @code{cStringIO} for now.  At some
point Python 3.0’s @ref{7f,,io} module will be rewritten into C for speed,
and perhaps the C implementation will be  backported to the 2.x releases.)
@end itemize

En Python 2.6, las implementaciones subyacentes no han sido reestructuradas para construir sobre las clases del módulo @ref{7f,,io}.  El módulo se proporciona para facilitar la escritura de código compatible con la versión 3.0, y para ahorrar a los desarrolladores el esfuerzo de escribir sus propias implementaciones de búfer y E/S de texto.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3116

@item PEP 3116@footnote{https://peps.python.org/pep-3116/} - Nueva E/S

PEP escrito por Daniel Stutzbach, Mike Verdone y Guido van Rossum. Código de Guido van Rossum, Georg Brandl, Walter Doerwald, Jeremy Hylton, Martin von Löwis, Tony Lownds y otros.
@end table


@c ======================================================================

@node PEP 3118 Protocolo revisado de la memoria intermedia,PEP 3119 Clases base abstractas,PEP 3116 Nueva biblioteca de E/S,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3118}@anchor{1325}@anchor{whatsnew/2 6 pep-3118-revised-buffer-protocol}@anchor{13f9}
@subsection PEP 3118: Protocolo revisado de la memoria intermedia


El protocolo de búferes es una API de nivel C que permite a los tipos de Python intercambiar punteros a sus representaciones internas.  Un archivo mapeado en memoria puede ser visto como un buffer de caracteres, por ejemplo, y esto permite que otro módulo como @ref{b9,,re} trate los archivos mapeados en memoria como una cadena de caracteres a buscar.

Los principales usuarios del protocolo de búferes son los paquetes de procesamiento numérico como NumPy, que exponen la representación interna de los arrays para que los invocadores puedan escribir datos directamente en un array en lugar de pasar por una API más lenta.  Este PEP actualiza el protocolo de búfer a la luz de la experiencia del desarrollo de NumPy, añadiendo una serie de nuevas características como la indicación de la forma de un array o el bloqueo de una región de memoria.

La nueva función más importante de la API en C es @code{PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)}, que toma un objeto y un conjunto de flags, y rellena la estructura @code{Py_buffer} con información sobre la representación en memoria del objeto.  Los objetos pueden utilizar esta operación para bloquear la memoria en su lugar mientras un llamador externo podría estar modificando el contenido, por lo que hay un correspondiente @code{PyBuffer_Release(Py_buffer *view)} para indicar que el llamador externo ha terminado.

El argumento `flags' de @ref{48c,,PyObject_GetBuffer()} especifica las restricciones de la memoria devuelta.  Algunos ejemplos son:


@itemize *

@item 
@ref{13fa,,PyBUF_WRITABLE} indica que la memoria debe ser grabable.

@item 
@code{PyBUF_LOCK} solicita un bloqueo de sólo lectura o exclusivo en la memoria.

@item 
@ref{13fb,,PyBUF_C_CONTIGUOUS} y @ref{13fc,,PyBUF_F_CONTIGUOUS} solicitan una disposición de matriz contigua en C (la última dimensión varía más rápidamente) o contigua en Fortran (la primera dimensión varía más rápidamente).
@end itemize

Dos nuevos códigos de argumento para @ref{615,,PyArg_ParseTuple()}, @code{s*} y @code{z*}, devuelven objetos buffer bloqueados para un parámetro.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3118

@item PEP 3118@footnote{https://peps.python.org/pep-3118/} - Revisión del protocolo del buffer

PEP escrito por Travis Oliphant y Carl Banks; implementado por Travis Oliphant.
@end table


@c ======================================================================

@node PEP 3119 Clases base abstractas,PEP 3127 Soporte y sintaxis de literales enteros,PEP 3118 Protocolo revisado de la memoria intermedia,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3119}@anchor{1326}@anchor{whatsnew/2 6 pep-3119-abstract-base-classes}@anchor{13fd}
@subsection PEP 3119: Clases base abstractas


Algunos lenguajes orientados a objetos, como Java, admiten interfaces, que declaran que una clase tiene un determinado conjunto de métodos o admite un determinado protocolo de acceso.  Las clases base abstractas (o ABC) son una característica equivalente para Python. El soporte de ABC consiste en un módulo @ref{4,,abc} que contiene una metaclase llamada @code{ABCMeta}, un manejo especial de esta metaclase por parte de los builtins @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}, y una colección de ABCs básicas que los desarrolladores de Python creen que serán ampliamente útiles.  Las futuras versiones de Python probablemente añadirán más ABCs.

Supongamos que tiene una clase concreta y desea saber si admite el acceso tipo diccionario.  Sin embargo, la frase «estilo diccionario» es vaga. Probablemente significa que el acceso a los elementos con @code{obj[1]} funciona. ¿Implica que el establecimiento de elementos con @code{obj[2] = valor} funciona? ¿O que el objeto tendrá métodos @code{keys()}, @code{values()} y @code{items()}?  ¿Qué pasa con las variantes iterativas como @code{iterkeys()}? @ref{26,,copy()} y @code{update()}?  ¿Iterar sobre el objeto con @ref{86e,,iter()}?

El módulo @ref{1e,,collections} de Python 2.6 incluye un número de ABCs diferentes que representan estas distinciones. @code{Iterable} indica que una clase define @code{__iter__()}, y @code{Container} significa que la clase define un método @code{__contains__()} y por lo tanto soporta expresiones @code{x in y}.  La interfaz básica del diccionario para obtener elementos, establecer elementos, y @code{llaves()}, @code{valores()}, y @code{elementos()}, está definida por el @code{MutableMapping} ABC.

Puedes derivar tus propias clases de un ABC particular para indicar que soportan la interfaz de ese ABC:

@example
import collections

class Storage(collections.MutableMapping):
    ...
@end example

Alternativamente, puede escribir la clase sin derivar del ABC deseado y en su lugar registrar la clase llamando al método @code{register()} del ABC:

@example
import collections

class Storage:
    ...

collections.MutableMapping.register(Storage)
@end example

Para las clases que usted escribe, derivar del ABC es probablemente más claro. El método @code{register()} es útil cuando has escrito un nuevo ABC que puede describir un tipo o clase existente, o si quieres declarar que alguna clase de terceros implementa un ABC. Por ejemplo, si has definido un @code{PrintableType} ABC, es legal hacer:

@example
# Register Python's types
PrintableType.register(int)
PrintableType.register(float)
PrintableType.register(str)
@end example

Las clases deben obedecer la semántica especificada por un ABC, pero Python no puede comprobarlo; depende del autor de la clase entender los requisitos del ABC e implementar el código en consecuencia.

Para comprobar si un objeto es compatible con una determinada interfaz, ahora se puede escribir:

@example
def func(d):
    if not isinstance(d, collections.MutableMapping):
        raise ValueError("Mapping object expected, not %r" % d)
@end example

No sientas que ahora debes empezar a escribir muchas comprobaciones como en el ejemplo anterior.  Python tiene una fuerte tradición de «duck-typing», donde la comprobación explícita de tipos nunca se hace y el código simplemente llama a los métodos de un objeto, confiando en que esos métodos estarán ahí y lanzando una excepción si no lo están.  Sea juicioso al comprobar el ABC y hágalo sólo cuando sea absolutamente necesario.

Puedes escribir tu propio ABC utilizando @code{abc.ABCMeta} como metaclase en una definición de clase:

@example
from abc import ABCMeta, abstractmethod

class Drawable():
    __metaclass__ = ABCMeta

    @@abstractmethod
    def draw(self, x, y, scale=1.0):
        pass

    def draw_doubled(self, x, y):
        self.draw(x, y, scale=2.0)


class Square(Drawable):
    def draw(self, x, y, scale):
        ...
@end example

En el ABC de @code{Drawable} anterior, el método @code{draw_doubled()} renderiza el objeto al doble de su tamaño y puede ser implementado en términos de otros métodos descritos en @code{Drawable}.  Las clases que implementan este ABC no necesitan proporcionar su propia implementación de @code{draw_doubled()}, aunque pueden hacerlo.  Sin embargo, es necesaria una implementación de @code{draw()}; el ABC no puede proporcionar una implementación genérica útil.

Puedes aplicar el decorador @code{@@abstractmethod} a métodos como @code{draw()} que deben ser implementados; Python lanzará una excepción para las clases que no definan el método. Ten en cuenta que la excepción sólo se produce cuando intentas crear una instancia de una subclase que carece del método:

@example
>>> class Circle(Drawable):
...     pass
...
>>> c = Circle()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class Circle with abstract methods draw
>>>
@end example

Los atributos de datos abstractos pueden declararse utilizando el decorador @code{@@abstractproperty}:

@example
from abc import abstractproperty
...

@@abstractproperty
def readonly(self):
   return self._x
@end example

Las subclases deben definir una propiedad @code{readonly()}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - Presentación de las clases base abstractas

PEP escrito por Guido van Rossum y Talin. Implementado por Guido van Rossum. Adaptado a la versión 2.6 por Benjamin Aranguren, con Alex Martelli.
@end table


@c ======================================================================

@node PEP 3127 Soporte y sintaxis de literales enteros,PEP 3129 Decoradores de clase,PEP 3119 Clases base abstractas,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3127}@anchor{1327}@anchor{whatsnew/2 6 pep-3127-integer-literal-support-and-syntax}@anchor{13fe}
@subsection PEP 3127: Soporte y sintaxis de literales enteros


Python 3.0 cambia la sintaxis de los literales enteros octales (base-8), prefijándolos con «0o» o «0O» en lugar de un cero inicial, y añade soporte para los literales enteros binarios (base-2), señalados con un prefijo «0b» o «0B».

Python 2.6 no elimina el soporte para el 0 inicial que señala un número octal, pero sí añade soporte para «0o» y «0b»:

@example
>>> 0o21, 2*8 + 1
(17, 17)
>>> 0b101111
47
@end example

La función @ref{1336,,oct()} sigue devolviendo números prefijados con un cero a la izquierda, y la nueva función @ref{1314,,bin()} devuelve la representación binaria de un número:

@example
>>> oct(42)
'052'
>>> future_builtins.oct(42)
'0o52'
>>> bin(173)
'0b10101101'
@end example

Las funciones built-in @ref{1f0,,int()} y @code{long()} aceptarán ahora los prefijos «0o» y «0b» cuando se solicite base-8 o base-2, o cuando el argumento `base' sea cero (indicando que la base utilizada debe determinarse a partir de la cadena):

@example
>>> int ('0o52', 0)
42
>>> int('1101', 2)
13
>>> int('0b1101', 2)
13
>>> int('0b1101', 0)
13
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3127

@item PEP 3127@footnote{https://peps.python.org/pep-3127/} - Soporte y sintaxis de literales enteros

PEP escrito por Patrick Maupin; retroalimentado a 2.6 por Eric Smith.
@end table


@c ======================================================================

@node PEP 3129 Decoradores de clase,PEP 3141 Una jerarquía de tipos para los números,PEP 3127 Soporte y sintaxis de literales enteros,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3129}@anchor{1328}@anchor{whatsnew/2 6 pep-3129-class-decorators}@anchor{13ff}
@subsection PEP 3129: Decoradores de clase


Los decoradores se han ampliado de funciones a clases.  Ahora es legal escribir:

@example
@@foo
@@bar
class A:
  pass
@end example

Esto equivale a:

@example
class A:
  pass

A = foo(bar(A))
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - Decoradores de clase

PEP escrito por Collin Winter.
@end table


@c ======================================================================

@node PEP 3141 Una jerarquía de tipos para los números,Otros cambios lingüísticos,PEP 3129 Decoradores de clase,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 pep-3141}@anchor{1329}@anchor{whatsnew/2 6 pep-3141-a-type-hierarchy-for-numbers}@anchor{1400}
@subsection PEP 3141: Una jerarquía de tipos para los números


Python 3.0 añade varias clases base abstractas para tipos numéricos inspiradas en la torre numérica de Scheme.  Estas clases fueron retrocedidas a la versión 2.6 como el módulo @ref{9e,,numbers}.

El ABC más general es @code{Number}.  No define ninguna operación, y sólo existe para permitir comprobar si un objeto es un número haciendo @code{isinstance(obj, Number)}.

@code{Complex} es una subclase de @code{Number}.  Los números complejos pueden someterse a las operaciones básicas de suma, resta, multiplicación, división y exponenciación, y se pueden recuperar las partes real e imaginaria y obtener el conjugado de un número.  El tipo complejo incorporado en Python es una implementación de @code{Complex}.

@code{Real} deriva a su vez de @code{Complex}, y añade operaciones que sólo funcionan con números reales: @code{floor()}, @code{trunc()}, redondeo, toma del resto mod N, división entera a la baja y comparaciones.

Los números @code{Rational} derivan de @code{Real}, tienen las propiedades @code{numerator} y @code{denominator}, y se pueden convertir en flotantes.  Python 2.6 añade una clase simple de números racionales, @code{Fraction}, en el módulo @ref{5d,,fractions}.  (Se llama @code{Fraction} en lugar de @code{Rational} para evitar un choque de nombres con @ref{132a,,numbers.Rational})

Los números de @code{Integral} derivan de @code{Rational}, y pueden desplazarse a la izquierda y a la derecha con @code{<} y @code{>`}, combinarse utilizando operaciones de bits como @code{&} y @code{|}, y pueden utilizarse como índices de matrices y límites de cortes.

En Python 3.0, el PEP redefine ligeramente las funciones integradas existentes @ref{1342,,round()}, @ref{1401,,math.floor()}, @ref{1402,,math.ceil()}, y añade uno nuevo, @ref{1403,,math.trunc()}, que ha sido retrocedido a Python 2.6. @ref{1403,,math.trunc()} redondea hacia cero, devolviendo el @code{Integral} más cercano que esté entre el argumento de la función y cero.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3141

@item PEP 3141@footnote{https://peps.python.org/pep-3141/} - Una jerarquía de tipos para los números

PEP escrito por Jeffrey Yasskin.
@end table

Torre numérica del esquema@footnote{https://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower}, del manual de Guile.

Scheme's number datatypes@footnote{https://conservatory.scheme.org/schemers/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2} de la especificación del esquema R5RS.


@menu
* El módulo fractions:: 

@end menu

@node El módulo fractions,,,PEP 3141 Una jerarquía de tipos para los números
@anchor{whatsnew/2 6 the-fractions-module}@anchor{1404}
@subsubsection El módulo @code{fractions}


Para completar la jerarquía de tipos numéricos, el módulo @ref{5d,,fractions} proporciona una clase de números racionales.  Los números racionales almacenan sus valores como un numerador y un denominador que forman una fracción, y pueden representar exactamente números como @code{2/3} que los números de punto flotante sólo pueden aproximar.

El constructor @code{Fraction} toma dos valores @code{Integral} que serán el numerador y el denominador de la fracción resultante.

@example
>>> from fractions import Fraction
>>> a = Fraction(2, 3)
>>> b = Fraction(2, 5)
>>> float(a), float(b)
(0.66666666666666663, 0.40000000000000002)
>>> a+b
Fraction(16, 15)
>>> a/b
Fraction(5, 3)
@end example

For converting floating-point numbers to rationals,
the float type now has an @code{as_integer_ratio()} method that returns
the numerator and denominator for a fraction that evaluates to the same
floating-point value:

@example
>>> (2.5) .as_integer_ratio()
(5, 2)
>>> (3.1415) .as_integer_ratio()
(7074029114692207L, 2251799813685248L)
>>> (1./3) .as_integer_ratio()
(6004799503160661L, 18014398509481984L)
@end example

Tenga en cuenta que los valores que sólo pueden ser aproximados por números de punto flotante, como 1,/3, no se simplifican al número que se está aproximando; la fracción intenta coincidir con el valor de punto flotante `exactamente'.

El módulo @ref{5d,,fractions} se basa en una implementación de Sjoerd Mullender que estuvo en el directorio @code{Demo/classes/} de Python durante mucho tiempo.  Esta implementación fue significativamente actualizada por Jeffrey Yasskin.

@node Otros cambios lingüísticos,Módulos nuevos y mejorados<2>,PEP 3141 Una jerarquía de tipos para los números,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 other-language-changes}@anchor{1405}
@subsection Otros cambios lingüísticos


Algunos de los cambios más pequeños realizados en el núcleo del lenguaje Python son:


@itemize *

@item 
Los directorios y archivos zip que contengan un archivo @code{__main__.py} pueden ahora ejecutarse directamente pasando su nombre al intérprete. El directorio o archivo zip se inserta automáticamente como la primera entrada en sys.path.  (Sugerencia y parche inicial de Andy Chu, revisado posteriormente por Phillip J. Eby y Nick Coghlan; bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468})

@item 
La función @ref{579,,hasattr()} estaba capturando e ignorando todos los errores, bajo la suposición de que significaban que un método @code{__getattr__()} estaba fallando de alguna manera y que el valor de retorno de @ref{579,,hasattr()} sería por tanto @code{False}.  Esta lógica no debería aplicarse a @ref{a63,,KeyboardInterrupt} y @ref{dc7,,SystemExit}, sin embargo; Python 2.6 ya no descartará tales excepciones cuando @ref{579,,hasattr()} las encuentre.  (Corregido por Benjamin Peterson; bpo-2196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2196}.)

@item 
Cuando se llama a una función utilizando la sintaxis @code{**} para proporcionar argumentos de palabras clave, ya no es necesario utilizar un diccionario de Python; ahora funcionará cualquier asignación:

@example
>>> def f(**kw):
...    print sorted(kw)
...
>>> ud=UserDict.UserDict()
>>> ud['a'] = 1
>>> ud['b'] = 'string'
>>> f(**ud)
['a', 'b']
@end example

(Contribución de Alexander Belopolsky; bpo-1686487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1686487}.)

También se ha convertido en legal proporcionar argumentos de palabras clave después de un argumento @code{*args} a una llamada de función.

@example
>>> def f(*args, **kw):
...     print args, kw
...
>>> f(1,2,3, *(4,5,6), keyword=13)
(1, 2, 3, 4, 5, 6) @{'keyword': 13@}
@end example

Anteriormente, esto habría sido un error de sintaxis. (Contribución de Amaury Forgeot d’Arc; bpo-3473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3473}.)

@item 
Un nuevo builtin, @code{next(iterator, [default])} devuelve el siguiente elemento del iterador especificado.  Si se suministra el argumento `default', se devolverá si `iterador' se ha agotado; en caso contrario, se lanzará la excepción @ref{c82,,StopIteration}.  (Se ha modificado en bpo-2719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2719}.)

@item 
Las tuplas tienen ahora métodos @code{index()} y @code{count()} que coinciden con los métodos @code{index()} y @code{count()} del tipo lista:

@example
>>> t = (0,1,2,3,4,0,1,2)
>>> t.index(3)
3
>>> t.count(0)
2
@end example

(Contribución de Raymond Hettinger)

@item 
Los tipos incorporados tienen ahora un soporte mejorado para la sintaxis de corte extendida, aceptando varias combinaciones de @code{(inicio, parada, paso)}. Anteriormente, el soporte era parcial y algunos casos de esquina no funcionaban. (Implementado por Thomas Wouters)

@c Revision 57619

@item 
Las propiedades tienen ahora tres atributos, @code{getter}, @code{setter} y @code{deleter}, que son decoradores que proporcionan atajos útiles para añadir una función getter, setter o deleter a una propiedad existente. Los usarás así:

@example
class C(object):
    @@property
    def x(self):
        return self._x

    @@x.setter
    def x(self, value):
        self._x = value

    @@x.deleter
    def x(self):
        del self._x

class D(C):
    @@C.x.getter
    def x(self):
        return self._x * 2

    @@x.setter
    def x(self, value):
        self._x = value / 2
@end example

@item 
Varios métodos de los tipos de conjuntos incorporados aceptan ahora múltiples iterables: @code{intersection()}, @code{intersection_update()}, @code{union()}, @code{update()}, @code{difference()} y @code{difference_update()}.

@example
>>> s=set('1234567890')
>>> s.intersection('abc123', 'cdf246')  # Intersection between all inputs
set(['2'])
>>> s.difference('246', '789')
set(['1', '0', '3', '5'])
@end example

(Contribución de Raymond Hettinger.)

@item 
Se han añadido muchas funciones de punto flotante.  La función @ref{153,,float()} ahora convertirá la cadena @code{nan} en un valor IEEE 754 Not A Number, y @code{+inf} y @code{-inf} en infinito positivo o negativo.  Esto funciona en cualquier plataforma con semántica IEEE 754.  (Contribución de Christian Heimes; bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}.)

Otras funciones del módulo @ref{8e,,math}, @code{isinf()} y @code{isnan()}, devuelven true si su argumento en coma flotante es infinito o No es un número.  (bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640})

Se han añadido funciones de conversión para convertir números de punto flotante en cadenas hexadecimales (bpo-3008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3008}).  Estas funciones convierten los números flotantes a y desde una representación de cadena sin introducir errores de redondeo por la conversión entre decimal y binario.  Los flotadores tienen un método @ref{1337,,hex()} que devuelve una representación de cadena, y el método @code{float.fromhex()} convierte una cadena de nuevo en un número:

@example
>>> a = 3.75
>>> a.hex()
'0x1.e000000000000p+1'
>>> float.fromhex('0x1.e000000000000p+1')
3.75
>>> b=1./3
>>> b.hex()
'0x1.5555555555555p-2'
@end example

@item 
Un detalle numérico: cuando se crea un número complejo a partir de dos flotantes en sistemas que admiten ceros con signo (-0 y +0), el constructor @ref{154,,complex()} conserva ahora el signo del cero.  (Corregido por Mark T. Dickinson; bpo-1507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1507}.)

@item 
Las clases que heredan un método @code{__hash__()} de una clase padre pueden establecer @code{__hash__ = None} para indicar que la clase no es hashable.  Esto hará que @code{hash(obj)} lance un @ref{228,,TypeError} y la clase no será indicada como implementando el ABC de @code{Hashable}.

Debes hacer esto cuando hayas definido un método @code{__cmp__()} o @code{__eq__()} que compare objetos por su valor en lugar de por su identidad.  Todos los objetos tienen un método hash por defecto que utiliza @code{id(obj)} como valor hash.  No hay una forma ordenada de eliminar el método @code{__hash__()} heredado de una clase padre, por lo que la asignación de @code{None} fue implementada como una sobreescritura.  A nivel de C, las extensiones pueden establecer @code{tp_hash} a @ref{1406,,PyObject_HashNotImplemented()}. (Corregido por Nick Coghlan y Amaury Forgeot d’Arc; bpo-2235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2235}.)

@item 
La excepción @ref{1407,,GeneratorExit} ahora subclasa @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception}.  Esto significa que un manejador de excepciones que haga @code{except Exception:} no atrapará inadvertidamente @ref{1407,,GeneratorExit}. (Contribuido por Chad Austin; bpo-1537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537}.)

@item 
Los objetos generadores tienen ahora un atributo @code{gi_code} que hace referencia al objeto de código original que respalda al generador. (Contribución de Collin Winter; bpo-1473257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1473257}.)

@item 
La función incorporada @ref{2fb,,compile()} ahora acepta argumentos de palabras clave así como parámetros posicionales.  (Contribución de Thomas Wouters; bpo-1444529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1444529}.)

@item 
El constructor @ref{154,,complex()} ahora acepta cadenas que contengan números complejos entre paréntesis, lo que significa que @code{complex(repr(cplx))} ahora redondeará los valores.  Por ejemplo, @code{complex('(3+4j)')} ahora devuelve el valor (3+4j).  (bpo-1491866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1491866})

@item 
El método string @code{translate()} acepta ahora @code{None} como parámetro de la tabla de traducción, que se trata como la transformación de identidad.   Esto facilita la realización de operaciones que sólo eliminan caracteres.  (Contribuido por Bengt Richter e implementado por Raymond Hettinger; bpo-1193128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1193128})

@item 
La función incorporada @ref{6d3,,dir()} ahora comprueba si existe un método @code{__dir__()} en los objetos que recibe.  Este método debe devolver una lista de cadenas que contengan los nombres de los atributos válidos para el objeto, y permite al objeto controlar el valor que @ref{6d3,,dir()} produce. Los objetos que tienen métodos @code{__getattr__()} o @code{__getattribute__()} pueden usar esto para anunciar los pseudo-atributos que respetarán. (bpo-1591665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1591665})

@item 
Instance method objects have new attributes for the object and function
comprising the method; the new synonym for @code{im_self} is
@ref{1408,,__self__}, and @code{im_func} is also available as
@ref{1363,,__func__}.
The old names are still supported in Python 2.6, but are gone in 3.0.

@item 
Un cambio oscuro: cuando se utiliza la función @ref{2ae,,locals()} dentro de una sentencia @ref{133f,,class}, el diccionario resultante ya no devuelve variables libres.  (Las variables libres, en este caso, son variables referenciadas en la sentencia @code{class} que no son atributos de la clase)
@end itemize

@c ======================================================================

@menu
* Optimizaciones: Optimizaciones<12>. 
* Cambios de intérprete:: 

@end menu

@node Optimizaciones<12>,Cambios de intérprete,,Otros cambios lingüísticos
@anchor{whatsnew/2 6 optimizations}@anchor{1409}
@subsubsection Optimizaciones



@itemize *

@item 
El módulo @ref{112,,warnings} ha sido reescrito en C. Esto hace posible invocar advertencias desde el analizador sintáctico, y también puede hacer que el arranque del intérprete sea más rápido. (Contribuido por Neal Norwitz y Brett Cannon; bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171}.)

@item 
Los objetos de tipo tienen ahora una caché de métodos que puede reducir el trabajo necesario para encontrar la implementación del método correcto para una clase en particular; una vez almacenada en la caché, el intérprete no necesita recorrer las clases base para averiguar el método correcto a llamar. La caché se borra si una clase base o la propia clase se modifica, por lo que la caché debería seguir siendo correcta incluso ante la naturaleza dinámica de Python. (Optimización original implementada por Armin Rigo, actualizada para Python 2.6 por Kevin Jacobs; bpo-1700288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1700288}.)

Por defecto, este cambio sólo se aplica a los tipos que se incluyen con el núcleo de Python.  Los módulos de extensión no son necesariamente compatibles con esta caché, por lo que deben añadir explícitamente @code{Py_TPFLAGS_HAVE_VERSION_TAG} al campo @code{tp_flags} del módulo para habilitar la caché de métodos. (Para ser compatible con la caché de métodos, el código del módulo de extensión no debe acceder directamente ni modificar el miembro @code{tp_dict} de ninguno de los tipos que implementa.  La mayoría de los módulos no lo hacen, pero es imposible que el intérprete de Python lo determine. Ver bpo-1878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1878} para una discusión)

@item 
Las llamadas a funciones que utilizan argumentos de palabras clave son significativamente más rápidas al hacer una comparación rápida de punteros, lo que suele ahorrar el tiempo de una comparación completa de cadenas.  (Contribución de Raymond Hettinger, tras una implementación inicial de Antoine Pitrou; bpo-1819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1819})

@item 
Todas las funciones del módulo @ref{d5,,struct} han sido reescritas en C, gracias al trabajo en el sprint de Need For Speed. (Contribución de Raymond Hettinger)

@item 
Algunos de los tipos estándar incorporados ahora establecen un bit en sus objetos de tipo.  Esto acelera la comprobación de si un objeto es una subclase de uno de estos tipos.  (Contribución de Neal Norwitz)

@item 
Las cadenas Unicode utilizan ahora un código más rápido para detectar los espacios en blanco y los saltos de línea; esto acelera el método @code{split()} en un 25% a y @code{splitlines()} en un 35%. (Contribuido por Antoine Pitrou.) El uso de la memoria se reduce utilizando pymalloc para los datos de la cadena Unicode.

@item 
The @code{with} statement now stores the @ref{1367,,__exit__()} method on the stack,
producing a small speedup.  (Implemented by Jeffrey Yasskin.)

@item 
Para reducir el uso de memoria, el recolector de basura ahora borrará las listas libres internas cuando recolecte la generación más alta de objetos. Esto puede devolver la memoria al sistema operativo antes.
@end itemize

@c ======================================================================

@node Cambios de intérprete,,Optimizaciones<12>,Otros cambios lingüísticos
@anchor{whatsnew/2 6 interpreter-changes}@anchor{140a}@anchor{whatsnew/2 6 new-26-interpreter}@anchor{140b}
@subsubsection Cambios de intérprete


Se han reservado dos opciones de la línea de comandos para su uso por otras implementaciones de Python.  La opción @ref{140c,,-J} se ha reservado para su uso por parte de Jython para las opciones específicas de Jython, como los interruptores que se pasan a la JVM subyacente. @ref{2e2,,-X} se ha reservado para las opciones específicas de una implementación particular de Python como CPython, Jython o IronPython.  Si cualquiera de estas opciones se utiliza con Python 2.6, el intérprete informará de que la opción no se utiliza actualmente.

Ahora se puede evitar que Python escriba archivos @code{.pyc} o @code{.pyo} proporcionando el modificador @ref{140d,,-B} al intérprete de Python, o estableciendo la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE} antes de ejecutar el intérprete.  Esta configuración está disponible para los programas de Python como la variable @code{sys.dont_write_bytecode}, y el código de Python puede cambiar el valor para modificar el comportamiento del intérprete.  (Contribución de Neal Norwitz y Georg Brandl)

La codificación utilizada para la entrada, la salida y el error estándar puede especificarse estableciendo la variable de entorno 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING} antes de ejecutar el intérprete.  El valor debe ser una cadena de la forma @code{<encoding>} o @code{<encoding>:<errorhandler>}. La parte `encoding' especifica el nombre de la codificación, por ejemplo @code{utf-8} o @code{latin-1}; la parte opcional `errorhandler' especifica qué hacer con los caracteres que no pueden ser manejados por la codificación, y debe ser una de las opciones «error», «ignorar» o «reemplazar».   (Contribución de Martin von Löwis)</errorhandler></encoding></encoding>

@c ======================================================================

@node Módulos nuevos y mejorados<2>,Cancelaciones y eliminaciones,Otros cambios lingüísticos,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 new-and-improved-modules}@anchor{140f}
@subsection Módulos nuevos y mejorados


Como en cada versión, la biblioteca estándar de Python ha recibido una serie de mejoras y correcciones de errores.  Aquí hay una lista parcial de los cambios más notables, ordenados alfabéticamente por nombre de módulo. Consulta el archivo @code{Misc/NEWS} en el árbol de fuentes para una lista más completa de cambios, o mira los registros de Subversion para todos los detalles.


@itemize *

@item 
The @code{asyncore} and @code{asynchat} modules are
being actively maintained again, and a number of patches and bugfixes
were applied.  (Maintained by Josiah Carlson; see bpo-1736190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1736190} for
one patch.)

@item 
El módulo @code{bsddb} también tiene un nuevo mantenedor, Jesús Cea Avión, y el paquete está ahora disponible como paquete independiente.  La página web del paquete es www.jcea.es/programacion/pybsddb.htm@footnote{https://www.jcea.es/programacion/pybsddb.htm}. El plan es eliminar el paquete de la biblioteca estándar en Python 3.0, porque su ritmo de lanzamientos es mucho más frecuente que el de Python.

El módulo @code{bsddb.dbshelve} utiliza ahora el protocolo de decapado más alto disponible, en lugar de limitarse al protocolo 1. (Contribución de W. Barnes.)

@item 
The @code{cgi} module will now read variables from the query string
of an HTTP POST request.  This makes it possible to use form actions
with URLs that include query strings such as
«/cgi-bin/add.py?category=1».  (Contributed by Alexandre Fiori and
Nubis; bpo-1817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1817}.)

The @code{parse_qs()} and @code{parse_qsl()} functions have been
relocated from the @code{cgi} module to the @ref{10a,,urlparse} module.
The versions still available in the @code{cgi} module will
trigger @ref{95f,,PendingDeprecationWarning} messages in 2.6
(bpo-600362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=600362}).

@item 
El módulo @ref{19,,cmath} ha sido objeto de una amplia revisión, a la que han contribuido Mark Dickinson y Christian Heimes. Se han añadido cinco nuevas funciones:


@itemize *

@item 
@code{polar()} convierte un número complejo en forma polar, devolviendo el módulo y el argumento del número complejo.

@item 
@code{rect()} hace lo contrario, convirtiendo un par de módulos y argumentos en el correspondiente número complejo.

@item 
@code{phase()} devuelve el argumento (también llamado ángulo) de un número complejo.

@item 
@code{isnan()} devuelve True si la parte real o imaginaria de su argumento es un NaN.

@item 
@code{isinf()} devuelve True si la parte real o imaginaria de su argumento es infinita.
@end itemize

Las revisiones también han mejorado la solidez numérica del módulo @ref{19,,cmath}.  Para todas las funciones, las partes real e imaginaria de los resultados son exactas con unas pocas unidades de precisión mínima (ulps) siempre que sea posible.  Véase bpo-1381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1381} para los detalles.  También se han corregido los cortes de rama para @code{asinh()}, @code{atanh()}: y @code{atan()}.

Las pruebas del módulo se han ampliado considerablemente; casi 2000 nuevos casos de prueba ejercitan las funciones algebraicas.

En las plataformas IEEE 754, el módulo @ref{19,,cmath} maneja ahora los valores especiales IEEE 754 y las excepciones de punto flotante de forma consistente con el Anexo “G” del estándar C99.

@item 
Un nuevo tipo de datos en el módulo @ref{1e,,collections}: @code{namedtuple(typename, fieldnames)} es una función de fábrica que crea subclases de la tupla estándar cuyos campos son accesibles tanto por nombre como por índice.  Por ejemplo:

@example
>>> var_type = collections.namedtuple('variable',
...             'id name type size')
>>> # Names are separated by spaces or commas.
>>> # 'id, name, type, size' would also work.
>>> var_type._fields
('id', 'name', 'type', 'size')

>>> var = var_type(1, 'frequency', 'int', 4)
>>> print var[0], var.id    # Equivalent
1 1
>>> print var[2], var.type  # Equivalent
int int
>>> var._asdict()
@{'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'@}
>>> v2 = var._replace(name='amplitude')
>>> v2
variable(id=1, name='amplitude', type='int', size=4)
@end example

Varios lugares de la biblioteca estándar que devolvían tuplas han sido modificados para devolver instancias de @code{namedtuple()}.  Por ejemplo, el método @code{Decimal.as_tuple()} ahora devuelve una tupla con nombre con los campos @code{sign}, @code{digits} y @code{exponent}.

(Contribución de Raymond Hettinger.)

@item 
Otro cambio en el módulo @ref{1e,,collections} es que el tipo @code{deque} admite ahora un parámetro opcional `maxlen'; si se suministra, el tamaño del deque estará restringido a no más de `maxlen' elementos.  Si se añaden más elementos a un deque lleno, se descartan los elementos antiguos.

@example
>>> from collections import deque
>>> dq=deque(maxlen=3)
>>> dq
deque([], maxlen=3)
>>> dq.append(1); dq.append(2); dq.append(3)
>>> dq
deque([1, 2, 3], maxlen=3)
>>> dq.append(4)
>>> dq
deque([2, 3, 4], maxlen=3)
@end example

(Contribución de Raymond Hettinger.)

@item 
The @ref{71,,Cookie} module’s @ref{c8c,,Morsel} objects now support an
@ref{1410,,httponly} attribute.  In some browsers. cookies with this attribute
set cannot be accessed or manipulated by JavaScript code.
(Contributed by Arvin Schnell; bpo-1638033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1638033}.)

@item 
Un nuevo método de ventana en el módulo @ref{2c,,curses}, @code{chgat()}, cambia los atributos de visualización para un determinado número de caracteres en una sola línea.  (Contribución de Fabian Kreutz)

@example
# Boldface text starting at y=0,x=21
# and affecting the rest of the line.
stdscr.chgat(0, 21, curses.A_BOLD)
@end example

La clase @code{Textbox} del módulo @ref{2f,,curses.textpad} soporta ahora la edición en modo de inserción así como en modo de sobrescritura. El modo de inserción se activa proporcionando un valor verdadero para el parámetro `insert_mode' al crear la instancia de @code{Textbox}.

@item 
Los métodos @code{strftime()} del módulo @ref{31,,datetime} soportan ahora un código de formato @code{%f} que se expande al número de microsegundos en el objeto, rellenado de cero a la izquierda hasta seis lugares.  (Contribución de Skip Montanaro; bpo-1158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1158}.)

@item 
El módulo @ref{37,,decimal} se actualizó a la versión 1.66 de the General Decimal Specification@footnote{https://speleotrove.com/decimal/decarith.html}. Las nuevas características incluyen algunos métodos para algunas funciones matemáticas básicas como @code{exp()} y @code{log10()}:

@example
>>> Decimal(1).exp()
Decimal("2.718281828459045235360287471")
>>> Decimal("2.7182818").ln()
Decimal("0.9999999895305022877376682436")
>>> Decimal(1000).log10()
Decimal("3")
@end example

El método @code{as_tuple()} de los objetos @code{Decimal} devuelve ahora una tupla con nombre con los campos @code{signo}, @code{dígitos} y @code{exponente}.

(Implementado por Facundo Batista y Mark Dickinson.  Soporte de tuplas con nombre añadido por Raymond Hettinger)

@item 
La clase @ref{38,,difflib} del módulo @code{SequenceMatcher} devuelve ahora tuplas con nombre que representan coincidencias, con atributos @code{a}, @code{b} y @code{size}. (Contribución de Raymond Hettinger)

@item 
Se ha añadido un parámetro opcional @code{timeout}, que especifica un tiempo de espera medido en segundos, al constructor de la clase @ref{990,,ftplib.FTP} así como al método @code{connect()}.  (Añadido por Facundo Batista.) Además, los métodos @code{storbinary()} y @code{storlines()} de la clase @code{FTP} ahora toman un parámetro opcional `callback' que será llamado con cada bloque de datos después de que los datos hayan sido enviados. (Contribuido por Phil Schwartz; bpo-1221598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1221598}.)

@item 
La función incorporada @code{reduce()} también está disponible en el módulo @ref{5f,,functools}.  En Python 3.0, la función incorporada se ha eliminado y @code{reduce()} sólo está disponible en @ref{5f,,functools}; actualmente no hay planes para eliminar la función incorporada en la serie 2.x. (Parcheado por Christian Heimes; bpo-1739906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739906}.)

@item 
Cuando sea posible, el módulo @ref{62,,getpass} utilizará ahora @code{/dev/tty} para imprimir un mensaje de aviso y leer la contraseña, retrocediendo al error estándar y a la entrada estándar.  Si la contraseña puede ser enviada al terminal, se imprimirá una advertencia antes de que se muestre el aviso.  (Contribución de Gregory P. Smith)

@item 
La función @ref{3ef,,glob.glob()} ahora puede devolver nombres de archivo Unicode si se ha utilizado una ruta Unicode y se han encontrado nombres de archivo Unicode dentro del directorio.  (bpo-1001604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1001604})

@item 
Una nueva función en el módulo @ref{69,,heapq}, @code{merge(iter1, iter2, ...)}, toma cualquier número de iterables que devuelven datos en orden ordenado, y devuelve un nuevo generador que devuelve el contenido de todos los iteradores, también en ordenado.  Por ejemplo:

@example
>>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
[1, 2, 3, 5, 8, 9, 16]
@end example

Otra nueva función, @code{heappushpop(heap, item)}, empuja `item' a `heap', luego lo saca y devuelve el elemento más pequeño. Esto es más eficiente que hacer una llamada a @code{heappush()} y luego a @code{heappop()}.

@ref{69,,heapq} se ha implementado para utilizar únicamente la comparación menor que, en lugar de la comparación menor o igual que utilizaba anteriormente. Esto hace que el uso de @ref{69,,heapq} de un tipo coincida con el método @ref{c57,,list.sort()}. (Contribución de Raymond Hettinger)

@item 
An optional @code{timeout} parameter, specifying a timeout measured in
seconds, was added to the @ref{bc8,,httplib.HTTPConnection} and
@ref{bc9,,HTTPSConnection} class constructors.  (Added by Facundo
Batista.)

@item 
La mayoría de las funciones del módulo @ref{7e,,inspect}, como @code{getmoduleinfo()} y @code{getargs()}, ahora devuelven tuplas con nombre. Además de comportarse como tuplas, también se puede acceder a los elementos del valor devuelto como atributos. (Contribución de Raymond Hettinger)

Algunas de las nuevas funciones del módulo son @code{isgenerator()}, @code{isgeneratorfunction()} y @code{isabstract()}.

@item 
El módulo @ref{81,,itertools} ha ganado varias funciones nuevas.

@code{izip_longest(iter1, iter2, ...[, fillvalue])} hace tuplas de cada uno de los elementos; si algunos de los iterables son más cortos que otros, los valores que faltan se ponen a `fillvalue'.  Por ejemplo:

@example
>>> tuple(itertools.izip_longest([1,2,3], [1,2,3,4,5]))
((1, 1), (2, 2), (3, 3), (None, 4), (None, 5))
@end example

@code{product(iter1, iter2, ..., [repeat=N])} devuelve el producto cartesiano de los iterables suministrados, un conjunto de tuplas que contiene todas las combinaciones posibles de los elementos devueltos de cada iterable.

@example
>>> list(itertools.product([1,2,3], [4,5,6]))
[(1, 4), (1, 5), (1, 6),
 (2, 4), (2, 5), (2, 6),
 (3, 4), (3, 5), (3, 6)]
@end example

El argumento opcional de la palabra clave `repeat' se utiliza para tomar el producto de un iterable o un conjunto de iterables con ellos mismos, repetido `N' veces.  Con un único argumento iterable, se devuelven `N'-tuplas:

@example
>>> list(itertools.product([1,2], repeat=3))
[(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
@end example

Con dos iterables, se devuelven `2N'-tuplas.

@example
>>> list(itertools.product([1,2], [3,4], repeat=2))
[(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
@end example

@code{combinaciones(iterable, r)} devuelve subsecuencias de longitud `r' de los elementos de `iterable'.

@example
>>> list(itertools.combinations('123', 2))
[('1', '2'), ('1', '3'), ('2', '3')]
>>> list(itertools.combinations('123', 3))
[('1', '2', '3')]
>>> list(itertools.combinations('1234', 3))
[('1', '2', '3'), ('1', '2', '4'),
 ('1', '3', '4'), ('2', '3', '4')]
@end example

@code{permutaciones(iter[, r])} devuelve todas las permutaciones de longitud `r' de los elementos del iterable.  Si no se especifica `r', por defecto será el número de elementos producidos por el iterable.

@example
>>> list(itertools.permutations([1,2,3,4], 2))
[(1, 2), (1, 3), (1, 4),
 (2, 1), (2, 3), (2, 4),
 (3, 1), (3, 2), (3, 4),
 (4, 1), (4, 2), (4, 3)]
@end example

@code{itertools.chain(*iterables)} es una función existente en @ref{81,,itertools} que obtuvo un nuevo constructor en Python 2.6. @code{itertools.chain.from_iterable(iterable)} toma un único iterable que debe devolver otros iterables. @code{chain()} devolverá entonces todos los elementos del primer iterable, luego todos los elementos del segundo, y así sucesivamente.

@example
>>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
[1, 2, 3, 4, 5, 6]
@end example

(Todo ello aportado por Raymond Hettinger)

@item 
La clase @ref{87,,logging} del módulo @code{FileHandler} y sus subclases @code{WatchedFileHandler}, @code{RotatingFileHandler} y @code{TimedRotatingFileHandler} tienen ahora un parámetro opcional `delay' en sus constructores.  Si `retraso' es verdadero, la apertura del fichero de registro se retrasa hasta que se realice la primera llamada @code{emit()}.  (Contribuido por Vinay Sajip.)

@code{TimedRotatingFileHandler} también tiene un parámetro constructor `utc'.  Si el argumento es verdadero, se utilizará la hora UTC para determinar cuándo ocurre la medianoche y para generar los nombres de los archivos; en caso contrario, se utilizará la hora local.

@item 
Se han añadido varias funciones nuevas al módulo @ref{8e,,math}:


@itemize *

@item 
@ref{1411,,isinf()} y @ref{1412,,isnan()} determinan si un flotador dado es un infinito (positivo o negativo) o un NaN (Not a Number), respectivamente.

@item 
@ref{1413,,copysign()} copia el bit de signo de un número IEEE 754, devolviendo el valor absoluto de `x' combinado con el bit de signo de `y'.  Por ejemplo, @code{math.copysign(1, -0.0)} devuelve -1.0. (Contribución de Christian Heimes)

@item 
@ref{9da,,factorial()} calcula el factorial de un número. (Contribuido por Raymond Hettinger; bpo-2138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2138}.)

@item 
@ref{1414,,fsum()} suma el flujo de números de un iterable, y tiene cuidado de evitar la pérdida de precisión mediante el uso de sumas parciales. (Contribución de Jean Brouwers, Raymond Hettinger y Mark Dickinson; bpo-2819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2819})

@item 
@ref{1415,,acosh()}, @ref{1416,,asinh()} y @ref{1417,,atanh()} calculan las funciones hiperbólicas inversas.

@item 
@ref{1418,,log1p()} devuelve el logaritmo natural de `1+x' (base `e').

@item 
@code{trunc()} redondea un número hacia cero, devolviendo el @code{Integral} más cercano que esté entre el argumento de la función y el cero. Añadido como parte del backport de la jerarquía de tipos de números de @ref{1329,,PEP 3141}.
@end itemize

@item 
El módulo @ref{8e,,math} se ha mejorado para ofrecer un comportamiento más coherente en todas las plataformas, especialmente en lo que respecta al manejo de las excepciones de punto flotante y los valores especiales IEEE 754.

Siempre que es posible, el módulo sigue las recomendaciones del estándar C99 sobre los valores especiales de 754.  Por ejemplo, @code{sqrt(-1.)} debería dar ahora un @ref{360,,ValueError} en casi todas las plataformas, mientras que @code{sqrt(float('NaN'))} debería devolver un NaN en todas las plataformas IEEE 754.  Cuando el Anexo “F” del estándar C99 recomiende señalar “dividir por cero” o “inválido”, Python lanzará @ref{360,,ValueError}. Cuando el Anexo “F” del estándar C99 recomiende señalar “desbordamiento”, Python lanzará @ref{919,,OverflowError}.  (Ver bpo-711019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=711019} y bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640})

(Contribución de Christian Heimes y Mark Dickinson)

@item 
Los objetos @ref{368,,mmap} tienen ahora un método @code{rfind()} que busca una subcadena empezando por el final de la cadena y buscando hacia atrás.  El método @code{find()} también ha ganado un parámetro `end' que da un índice en el que parar la búsqueda. (Contribución de John Lenton)

@item 
El módulo @ref{9f,,operator} ganó una función @code{methodcaller()} que toma un nombre y un conjunto opcional de argumentos, devolviendo un callable que llamará a la función nombrada en cualquier argumento que se le pase.  Por ejemplo:

@example
>>> # Equivalent to lambda s: s.replace('old', 'new')
>>> replacer = operator.methodcaller('replace', 'old', 'new')
>>> replacer('old wine in old bottles')
'new wine in new bottles'
@end example

(Contribución de Georg Brandl, tras una sugerencia de Gregory Petrosyan)

La función @code{attrgetter()} acepta ahora nombres con puntos y realiza las correspondientes búsquedas de atributos:

@example
>>> inst_name = operator.attrgetter(
...        '__class__.__name__')
>>> inst_name('@w{'})
'str'
>>> inst_name(help)
'_Helper'
@end example

(Contribución de Georg Brandl, tras una sugerencia de Barry Warsaw)

@item 
El módulo @ref{a1,,os} incluye ahora varias llamadas nuevas al sistema. @code{fchmod(fd, mode)} y @code{fchown(fd, uid, gid)} cambian el modo y la propiedad de un fichero abierto, y @code{lchmod(path, mode)} cambia el modo de un enlace simbólico.  (Contribución de Georg Brandl y Christian Heimes)

@code{chflags()} y @code{lchflags()} son envoltorios para las correspondientes llamadas al sistema (cuando están disponibles), que cambian las banderas establecidas en un archivo.  Las constantes para los valores de las banderas se definen en el módulo @ref{d1,,stat}; algunos valores posibles son @code{UF_IMMUTABLE} para indicar que el fichero no puede ser modificado y @code{UF_APPEND} para indicar que sólo se pueden añadir datos al fichero.  (Contribución de M. Levinson)

@code{os.closerange(low, high)} cierra eficazmente todos los descriptores de fichero desde `low' hasta `high', ignorando cualquier error y sin incluir a `high' mismo. Esta función es ahora utilizada por el módulo @ref{d6,,subprocess} para hacer más rápido el arranque de procesos.  (Contribuido por Georg Brandl; bpo-1663329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1663329}.)

@item 
El método @code{clear()} del objeto @code{os.environ} ahora desajustará las variables de entorno utilizando @ref{199,,os.unsetenv()} además de borrar las claves del objeto.  (Contribuido por Martin Horcicka; bpo-1181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1181}.)

@item 
La función @ref{551,,os.walk()} tiene ahora un parámetro @code{followlinks}. Si se establece como True, seguirá los enlaces simbólicos que apunten a directorios y visitará el contenido del directorio.  Por compatibilidad con el pasado, el valor por defecto del parámetro es false.  Tenga en cuenta que la función puede caer en una recursión infinita si hay un enlace simbólico que apunte a un directorio padre.  (bpo-1273829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1273829})

@item 
En el módulo @ref{a2,,os.path}, la función @code{splitext()} ha sido modificada para no dividir los caracteres de punto inicial. Esto produce mejores resultados cuando se opera con archivos de puntos de Unix. Por ejemplo, @code{os.path.splitext('.ipython')} ahora devuelve @code{('.ipython', '@w{'})} en lugar de @code{('@w{'}, '.ipython')}. (bpo-1115886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1115886})

Una nueva función, @code{os.path.relpath(path, start='.')}, devuelve una ruta relativa desde la ruta @code{start}, si se suministra, o desde el directorio de trabajo actual hasta el destino @code{path}.  (Contribución de Richard Barran; bpo-1339796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1339796}.)

En Windows, @ref{1419,,os.path.expandvars()} ahora expandirá las variables de entorno dadas en la forma «%var%», y «~user» se expandirá en la ruta del directorio personal del usuario.  (Contribución de Josiah Carlson; bpo-957650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957650}.)

@item 
El depurador de Python proporcionado por el módulo @ref{a5,,pdb} ganó un nuevo comando: «run» reinicia el programa Python que se está depurando y puede tomar opcionalmente nuevos argumentos de línea de comandos para el programa. (Contribución de Rocky Bernstein; bpo-1393667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1393667}.)

@item 
La función @ref{141a,,pdb.post_mortem()}, utilizada para iniciar la depuración de un traceback, utilizará ahora el traceback devuelto por @ref{72b,,sys.exc_info()} si no se suministra ningún traceback.   (Contribuido por Facundo Batista; bpo-1106316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1106316}.)

@item 
El módulo @ref{a7,,pickletools} tiene ahora una función @code{optimize()} que toma una cadena que contiene un pickle y elimina algunos opcodes no utilizados, devolviendo un pickle más corto que contiene la misma estructura de datos. (Contribución de Raymond Hettinger)

@item 
Se ha añadido una función @code{get_data()} al módulo @ref{a9,,pkgutil} que devuelve el contenido de los archivos de recursos incluidos con un paquete Python instalado.  Por ejemplo:

@example
>>> import pkgutil
>>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StandardError
 ...
@end example

(Contribución de Paul Moore; bpo-2439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2439}.)

@item 
Los objetos @code{pyexpat} del módulo @code{Parser} permiten ahora establecer su atributo @code{buffer_size} para cambiar el tamaño del buffer utilizado para mantener los datos de caracteres. (Contribución de Achim Gaedke; bpo-1137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1137}.)

@item 
El módulo @code{Queue} proporciona ahora variantes de colas que recuperan las entradas en diferentes órdenes.  La clase @code{PriorityQueue} almacena los elementos en cola en un montón y los recupera en orden de prioridad, y @code{LifoQueue} recupera primero las entradas añadidas más recientemente, lo que significa que se comporta como una pila. (Contribución de Raymond Hettinger)

@item 
Los objetos @code{Random} del módulo @ref{b8,,random} ahora pueden ser decapados en un sistema de 32 bits y desempaquetados en un sistema de 64 bits, y viceversa.  Desafortunadamente, este cambio también significa que los objetos @code{Random} de Python 2.6 no pueden ser desempaquetados correctamente en versiones anteriores de Python. (Contribuido por Shawn Ligocki; bpo-1727780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1727780}.)

La nueva función @code{triangular(low, high, mode)} devuelve números aleatorios siguiendo una distribución triangular.   Los valores devueltos están entre `bajos' y `altos', sin incluir los propios `altos', y con `modo' como valor más frecuente en la distribución.  (Contribución de Wladmir van der Laan y Raymond Hettinger; bpo-1681432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1681432}.)

@item 
Las búsquedas de expresiones regulares largas llevadas a cabo por el módulo @ref{b9,,re} comprobarán la entrega de señales, por lo que ahora se pueden interrumpir las búsquedas que consumen mucho tiempo. (Contribución de Josh Hoyt y Ralf Schmitt; bpo-846388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=846388}.)

El módulo de expresiones regulares se implementa compilando bytecodes para una pequeña máquina virtual específica de regex.  El código no fiable podría crear cadenas maliciosas de código de bytes directamente y causar caídas, por lo que Python 2.6 incluye un verificador para el código de bytes regex. (Contribuido por Guido van Rossum del trabajo para Google App Engine; bpo-3487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3487}.)

@item 
The @ref{bd,,rlcompleter} module’s @code{Completer.complete()} method
will now ignore exceptions triggered while evaluating a name.
(Fixed by Lorenz Quack; bpo-2250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2250}.)

@item 
Las instancias @ref{bf,,sched} del módulo @code{scheduler} tienen ahora un atributo @ref{b6,,queue} de sólo lectura que devuelve el contenido de la cola del planificador, representado como una lista de tuplas con nombre con los campos @code{(tiempo, prioridad, acción, argumento)}. (Contribución de Raymond Hettinger; bpo-1861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1861}.)

@item 
El módulo @ref{c1,,select} tiene ahora funciones de envoltura para las llamadas al sistema Linux @code{epoll()} y BSD @code{kqueue()}. Se ha añadido el método @code{modify()} a los objetos @code{poll} existentes; @code{pollobj.modify(fd, eventmask)} toma un descriptor de fichero o un objeto de fichero y una máscara de evento, modificando la máscara de evento registrada para ese fichero. (Contribución de Christian Heimes; bpo-1657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1657}.)

@item 
La función @ref{abb,,shutil.copytree()} tiene ahora un argumento opcional `ignore' que toma un objeto callable.  Esta llamada recibirá cada ruta de directorio y una lista del contenido del directorio, y devuelve una lista de nombres que serán ignorados, no copiados.

El módulo @ref{c5,,shutil} también proporciona una función @code{ignore_patterns()} para su uso con este nuevo parámetro. @code{ignore_patterns()} toma un número arbitrario de patrones de estilo glob y devuelve una llamada que ignorará cualquier archivo o directorio que coincida con cualquiera de estos patrones.  El siguiente ejemplo copia un árbol de directorios, pero omite los directorios @code{.svn} y los ficheros de copia de seguridad de Emacs, que tienen nombres que terminan en “~”:

@example
shutil.copytree('Doc/library', '/tmp/library',
                ignore=shutil.ignore_patterns('*~', '.svn'))
@end example

(Contribución de Tarek Ziadé; bpo-2663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2663}.)

@item 
Integrar el manejo de señales con los bucles de eventos de manejo de la interfaz gráfica de usuario (GUI), como los utilizados por Tkinter o GTk+, ha sido durante mucho tiempo un problema; la mayoría del software acaba sondeando, despertando cada fracción de segundo para comprobar si se ha producido algún evento de la GUI. El módulo @ref{c6,,signal} puede ahora hacer esto más eficiente. Llamando a @code{signal.set_wakeup_fd(fd)} se establece un descriptor de fichero a utilizar; cuando se recibe una señal, se escribe un byte en ese descriptor de fichero.  También hay una función en C, @ref{141b,,PySignal_SetWakeupFd()}, para establecer el descriptor.

Los bucles de eventos utilizarán esto abriendo una tubería para crear dos descriptores, uno de lectura y otro de escritura.  El descriptor de escritura se pasará a @code{set_wakeup_fd()}, y el descriptor de lectura se añadirá a la lista de descriptores monitorizados por el bucle de eventos mediante @code{select()} o @code{poll()}. Al recibir una señal, se escribirá un byte y se despertará el bucle de eventos principal, evitando la necesidad de hacer un sondeo.

(Contribución de Adam Olsen; bpo-1583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583}.)

La función @code{siginterrupt()} está ahora disponible desde el código Python, y permite cambiar si las señales pueden interrumpir las llamadas al sistema o no. (Contribución de Ralf Schmitt)

También se han añadido las funciones @code{setitimer()} y @code{getitimer()} (cuando están disponibles). @code{setitimer()} permite establecer temporizadores de intervalo que harán que se entregue una señal al proceso después de un tiempo especificado, medido en tiempo de reloj de pared, tiempo de proceso consumido, o tiempo combinado de proceso+sistema.  (Contribuido por Guilherme Polo; bpo-2240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2240}.)

@item 
El módulo @ref{ca,,smtplib} ahora soporta SMTP sobre SSL gracias a la adición de la clase @code{SMTP_SSL}. Esta clase soporta una interfaz idéntica a la clase @code{SMTP} existente. (Contribuido por Monty Taylor.) Ambos constructores de la clase también tienen un parámetro opcional @code{timeout} que especifica un tiempo de espera para el intento de conexión inicial, medido en segundos.  (Contribuido por Facundo Batista.)

También se ha añadido al módulo una implementación del protocolo LMTP (
@geindex RFC; RFC 2033
RFC 2033@footnote{https://datatracker.ietf.org/doc/html/rfc2033.html}).  LMTP se utiliza en lugar de SMTP cuando se transfiere correo electrónico entre agentes que no gestionan una cola de correo.  (LMTP implementado por Leif Hedstrom; bpo-957003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957003}.)

@code{SMTP.starttls()} ahora cumple con 
@geindex RFC; RFC 3207
RFC 3207@footnote{https://datatracker.ietf.org/doc/html/rfc3207.html} y olvida cualquier conocimiento obtenido del servidor que no se haya obtenido de la propia negociación TLS.  (Parche aportado por Bill Fenner; bpo-829951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=829951}.)

@item 
El módulo @ref{cc,,socket} soporta ahora TIPC (@indicateurl{http://tipc.sourceforge.net/}), un protocolo de alto rendimiento no basado en IP y diseñado para su uso en entornos agrupados.  Las direcciones TIPC son de 4 o 5 tuplas. (Contribución de Alberto Bertogli; bpo-1646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1646}.)

Una nueva función, @code{create_connection()}, toma una dirección y se conecta a ella utilizando un valor opcional de tiempo de espera, devolviendo el objeto socket conectado.  Esta función también busca el tipo de dirección y se conecta a ella usando IPv4 o IPv6 según sea el caso.  Cambiar su código para usar @code{create_connection()} en lugar de @code{socket(socket.AF_INET, ...)} puede ser todo lo que se necesita para que su código funcione con IPv6.

@item 
The base classes in the @ref{cd,,SocketServer} module now support
calling a @ref{1389,,handle_timeout()} method after a span of inactivity
specified by the server’s @ref{1388,,timeout} attribute.  (Contributed
by Michael Pomraning.)  The @ref{11b1,,serve_forever()} method
now takes an optional poll interval measured in seconds,
controlling how often the server will check for a shutdown request.
(Contributed by Pedro Werneck and Jeffrey Yasskin;
bpo-742598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=742598}, bpo-1193577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1193577}.)

@item 
El módulo @ref{cf,,sqlite3}, mantenido por Gerhard Häring, ha sido actualizado de la versión 2.3.2 en Python 2.5 a la versión 2.4.1.

@item 
El módulo @ref{d5,,struct} ahora admite el tipo C99 _Bool, utilizando el carácter de formato @code{'?'}. (Aportado por David Remahl.)

@item 
The @ref{301,,Popen} objects provided by the @ref{d6,,subprocess} module
now have @ref{141c,,terminate()}, @ref{141d,,kill()}, and @ref{141e,,send_signal()} methods.
On Windows, @code{send_signal()} only supports the @ref{141f,,SIGTERM}
signal, and all these methods are aliases for the Win32 API function
@code{TerminateProcess()}.
(Contributed by Christian Heimes.)

@item 
Una nueva variable en el módulo @ref{d9,,sys}, @code{float_info}, es un objeto que contiene información derivada del archivo @code{float.h} sobre el soporte de punto flotante de la plataforma.  Los atributos de este objeto incluyen @code{mant_dig} (número de dígitos en la mantisa), @code{epsilon} (diferencia más pequeña entre 1.0 y el siguiente valor más grande representable), y varios otros.  (Contribuido por Christian Heimes; bpo-1534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1534}.)

Otra nueva variable, @code{dont_write_bytecode}, controla si Python escribe algún archivo @code{.pyc} o @code{.pyo} al importar un módulo. Si esta variable es verdadera, los archivos compilados no se escriben.  La variable se establece inicialmente al iniciar el intérprete de Python con la opción @ref{140d,,-B}, o estableciendo la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE} antes de ejecutar el intérprete.  El código de Python puede cambiar posteriormente el valor de esta variable para controlar si los archivos de código de bytes se escriben o no. (Contribución de Neal Norwitz y Georg Brandl)

La información sobre los argumentos de la línea de comandos suministrados al intérprete de Python está disponible leyendo los atributos de una tupla con nombre disponible como @code{sys.flags}.  Por ejemplo, el atributo @code{verbose} es verdadero si Python fue ejecutado en modo verbose, @code{debug} es verdadero en modo debugging, etc. Todos estos atributos son de sólo lectura. (Contribución de Christian Heimes)

Una nueva función, @code{getsizeof()}, toma un objeto Python y devuelve la cantidad de memoria utilizada por el objeto, medida en bytes.  Los objetos incorporados devuelven resultados correctos; las extensiones de terceros pueden no hacerlo, pero pueden definir un método @code{__sizeof__()} para devolver el tamaño del objeto. (Contribución de Robert Schuppenies; bpo-2898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2898}.)

Ahora es posible determinar las funciones actuales del perfilador y del trazador llamando a @ref{1420,,sys.getprofile()} y @ref{1421,,sys.gettrace()}. (Contribuido por Georg Brandl; bpo-1648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1648}.)

@item 
El módulo @ref{de,,tarfile} soporta ahora archivos tar POSIX.1-2001 (pax) además de los formatos POSIX.1-1988 (ustar) y GNU tar que ya estaban soportados.  El formato por defecto es GNU tar; especifique el parámetro @code{format} para abrir un archivo con un formato diferente:

@example
tar = tarfile.open("output.tar", "w",
                   format=tarfile.PAX_FORMAT)
@end example

Los nuevos parámetros @code{encoding} y @code{errors} especifican una codificación y un esquema de manejo de errores para las conversiones de caracteres.  @code{'strict'}, @code{'ignore'}, y @code{'replace'} son las tres formas estándar en las que Python puede manejar los errores; @code{'utf-8'} es un valor especial que reemplaza los caracteres erróneos con su representación UTF-8.  (Las conversiones de caracteres ocurren porque el formato PAX soporta nombres de archivo Unicode, por defecto con codificación UTF-8)

El método @code{TarFile.add()} ahora acepta un argumento @code{exclude} que es una función que se puede usar para excluir ciertos nombres de archivo de un archivo. La función debe tomar un nombre de archivo y retornar verdadero si el archivo debe excluirse o falso si debe archivarse. La función se aplica tanto al nombre pasado inicialmente a @code{add()} como a los nombres de los archivos en los directorios agregados recursivamente.

(Todos los cambios han sido aportados por Lars Gustäbel).

@item 
An optional @code{timeout} parameter was added to the
@code{telnetlib.Telnet} class constructor, specifying a timeout
measured in seconds.  (Added by Facundo Batista.)

@item 
La clase @ref{56d,,tempfile.NamedTemporaryFile} suele borrar el archivo temporal que ha creado cuando se cierra el archivo.  Este comportamiento se puede cambiar pasando @code{delete=False} al constructor.  (Contribución de Damien Miller; bpo-1537850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537850}.)

Una nueva clase, @code{SpooledTemporaryFile}, se comporta como un archivo temporal pero almacena sus datos en memoria hasta que se supera un tamaño máximo.  Al llegar a ese límite, el contenido se escribirá en un archivo temporal en el disco.  (Contribución de Dustin J. Mitchell)

Las clases @code{NamedTemporaryFile} y @code{SpooledTemporaryFile} funcionan como gestores de contexto, por lo que puedes escribir @code{con tempfile.NamedTemporaryFile() como tmp: ...}. (Contribuido por Alexander Belopolsky; bpo-2021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2021}.)

@item 
The @ref{e4,,test.test_support} module gained a number
of context managers useful for writing tests.
@ref{1422,,EnvironmentVarGuard()} is a
context manager that temporarily changes environment variables and
automatically restores them to their old values.

Otro gestor de contexto, @code{TransientResource}, puede rodear las llamadas a recursos que pueden o no estar disponibles; atrapará e ignorará una lista especificada de excepciones.  Por ejemplo, una prueba de red puede ignorar ciertos fallos al conectarse a un sitio web externo:

@example
with test_support.TransientResource(IOError,
                                errno=errno.ETIMEDOUT):
    f = urllib.urlopen('https://sf.net')
    ...
@end example

Por último, @code{check_warnings()} restablece los filtros de advertencia del módulo @code{warning} y devuelve un objeto que registrará todos los mensajes de advertencia activados (bpo-3781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3781}):

@example
with test_support.check_warnings() as wrec:
    warnings.simplefilter("always")
    # ... code that triggers a warning ...
    assert str(wrec.message) == "function is outdated"
    assert len(wrec.warnings) == 1, "Multiple warnings raised"
@end example

(Contribución de Brett Cannon.)

@item 
El módulo @ref{ec,,textwrap} ahora puede conservar los espacios en blanco existentes al principio y al final de las líneas recién creadas especificando @code{drop_whitespace=False} como argumento:

@example
>>> S = """This  sentence  has a bunch   of
...   extra   whitespace."""
>>> print textwrap.fill(S, width=15)
This  sentence
has a bunch
of    extra
whitespace.
>>> print textwrap.fill(S, drop_whitespace=False, width=15)
This  sentence
  has a bunch
   of    extra
   whitespace.
>>>
@end example

(Contribución de Dwayne Bailey; bpo-1581073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1581073}.)

@item 
La API del módulo @ref{ed,,threading} se ha cambiado para utilizar propiedades como @code{daemon} en lugar de los métodos @code{setDaemon()} y @code{isDaemon()}, y algunos métodos se han renombrado para utilizar guiones bajos en lugar de mayúsculas; por ejemplo, el método @code{activeCount()} se ha renombrado a @code{active_count()}.  Tanto la versión 2.6 como la 3.0 del módulo soportan las mismas propiedades y métodos renombrados, pero no eliminan los métodos antiguos.  No se ha fijado una fecha para la eliminación de las antiguas APIs en Python 3.x; las antiguas APIs no se eliminarán en ninguna versión 2.x. (Llevado a cabo por varias personas, sobre todo por Benjamin Peterson)

Los objetos @ref{ed,,threading} del módulo @code{Thread} han ganado una propiedad @code{ident} que devuelve el identificador del hilo, un entero no nulo.  (Contribución de Gregory P. Smith; bpo-2871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2871}.)

@item 
El módulo @ref{ef,,timeit} acepta ahora callables así como cadenas para la sentencia que se está cronometrando y para el código de configuración. Se han añadido dos funciones para crear instancias de @code{Timer}: @code{repeat(stmt, setup, time, repeat, number)} y @code{timeit(stmt, setup, time, number)} crean una instancia y llaman al método correspondiente. (Contribución de Erik Demaine; bpo-1533909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533909}.)

@item 
El módulo @code{Tkinter} ahora acepta listas y tuplas para las opciones, separando los elementos por espacios antes de pasar el valor resultante a Tcl/Tk. (Contribuido por Guilherme Polo; bpo-2906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2906}.)

@item 
El módulo @ref{101,,turtle} para los gráficos de tortugas ha sido muy mejorado por Gregor Lingl.  Las nuevas características del módulo incluyen:


@itemize *

@item 
Mejor animación del movimiento y la rotación de la tortuga.

@item 
Control del movimiento de las tortugas mediante los nuevos métodos @code{retraso()}, @code{tracer()} y @code{velocidad()}.

@item 
La posibilidad de establecer nuevas formas para la tortuga y de definir un nuevo sistema de coordenadas.

@item 
Turtles now have an @code{undo()} method that can roll back actions.

@item 
Soporte sencillo para reaccionar a eventos de entrada como la actividad del ratón y del teclado, lo que permite escribir juegos sencillos.

@item 
Se puede utilizar un archivo @code{turtle.cfg} para personalizar la apariencia inicial de la pantalla de la tortuga.

@item 
Los docstrings del módulo pueden ser sustituidos por nuevos docstrings traducidos a otro idioma.
@end itemize

(bpo-1513695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1513695})

@item 
An optional @code{timeout} parameter was added to the
@ref{20a,,urllib.urlopen} function and the
@code{urllib.ftpwrapper} class constructor, as well as the
@ref{20a,,urllib2.urlopen} function.  The parameter specifies a timeout
measured in seconds.   For example:

@example
>>> u = urllib2.urlopen("http://slow.example.com",
                        timeout=3)
Traceback (most recent call last):
  ...
urllib2.URLError: <urlopen error timed out>
>>>
@end example

(Añadido por Facundo Batista.)

@item 
La base de datos Unicode proporcionada por el módulo @ref{105,,unicodedata} ha sido actualizada a la versión 5.1.0.  (Actualizado por Martin von Löwis; bpo-3811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3811}.)

@item 
Las funciones @ref{112,,warnings} del módulo @code{formatwarning()} y @code{showwarning()} han ganado un argumento opcional `line' que puede utilizarse para proporcionar la línea de código fuente.  (Añadido como parte de bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171}, que reimplementaba parte del módulo @ref{112,,warnings} en código C)

Una nueva función, @code{catch_warnings()}, es un gestor de contexto destinado a la realización de pruebas que permite modificar temporalmente los filtros de advertencia y luego restaurar sus valores originales (bpo-3781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3781}).

@item 
The XML-RPC @ref{12e,,SimpleXMLRPCServer} and @ref{12e,,DocXMLRPCServer}
classes can now be prevented from immediately opening and binding to
their socket by passing @code{False} as the `bind_and_activate'
constructor parameter.  This can be used to modify the instance’s
@code{allow_reuse_address} attribute before calling the
@code{server_bind()} and @code{server_activate()} methods to
open the socket and begin listening for connections.
(Contributed by Peter Parente; bpo-1599845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1599845}.)

@code{SimpleXMLRPCServer} también tiene un atributo @code{_send_traceback_header}; si es true, la excepción y el traceback formateado se devuelven como cabeceras HTTP «X-Exception» y «X-Traceback».  Esta característica es sólo para propósitos de depuración y no debe ser usada en servidores de producción porque los trazos pueden revelar contraseñas u otra información sensible.  (Contribuido por Alan McIntyre como parte de su proyecto para el Summer of Code 2007 de Google)

@item 
The @ref{12d,,xmlrpclib} module no longer automatically converts
@ref{330,,datetime.date} and @ref{331,,datetime.time} to the
@ref{1423,,xmlrpclib.DateTime} type; the conversion semantics were
not necessarily correct for all applications.  Code using
@code{xmlrpclib} should convert @code{date} and @ref{331,,time}
instances. (bpo-1330538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1330538})  The code can also handle
dates before 1900 (contributed by Ralf Schmitt; bpo-2014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2014})
and 64-bit integers represented by using @code{<i8>} in XML-RPC responses
(contributed by Riku Lindblad; bpo-2985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2985}).

@item 
La clase @ref{130,,zipfile} del módulo @code{ZipFile} tiene ahora los métodos @code{extract()} y @code{extractall()} que desempaquetarán un solo fichero o todos los ficheros del archivo en el directorio actual, o en un directorio especificado:

@example
z = zipfile.ZipFile('python-251.zip')

# Unpack a single file, writing it relative
# to the /tmp directory.
z.extract('Python/sysmodule.c', '/tmp')

# Unpack all the files in the archive.
z.extractall()
@end example

(Contribución de Alan McIntyre; bpo-467924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=467924}.)

Los métodos @ref{1be,,open()}, @code{read()} y @code{extract()} ahora pueden tomar un nombre de archivo o un objeto @code{ZipInfo}.  Esto es útil cuando un archivo contiene accidentalmente un nombre de archivo duplicado. (Contribución de Graham Horler; bpo-1775025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1775025}.)

Por último, @ref{130,,zipfile} soporta ahora el uso de nombres de archivo Unicode para los ficheros archivados.  (Contribución de Alexey Borzenkov; bpo-1734346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1734346}.)
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@menu
* El módulo ast:: 
* El módulo future_builtins:: 
* El módulo json; Notación de objetos de JavaScript: El módulo json Notación de objetos de JavaScript. 
* El módulo plistlib; Un analizador de listas de propiedades: El módulo plistlib Un analizador de listas de propiedades. 
* mejoras en ctypes:: 
* Mejora de la compatibilidad con SSL:: 

@end menu

@node El módulo ast,El módulo future_builtins,,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 the-ast-module}@anchor{1424}
@subsubsection El módulo @code{ast}


El módulo @ref{9,,ast} proporciona una representación de árbol de sintaxis abstracta del código Python, y Armin Ronacher ha contribuido con un conjunto de funciones de ayuda que realizan una variedad de tareas comunes.  Éstas serán útiles para paquetes de plantillas HTML, analizadores de código y herramientas similares que procesan código Python.

La función @code{parse()} toma una expresión y devuelve un AST. La función @code{dump()} devuelve una representación de un árbol, adecuada para la depuración:

@example
import ast

t = ast.parse("""
d = @{@}
for i in 'abcdefghijklm':
    d[i + i] = ord(i) - ord('a') + 1
print d
""")
print ast.dump(t)
@end example

Esto produce un árbol profundamente anidado:

@example
Module(body=[
  Assign(targets=[
    Name(id='d', ctx=Store())
   ], value=Dict(keys=[], values=[]))
  For(target=Name(id='i', ctx=Store()),
      iter=Str(s='abcdefghijklm'), body=[
    Assign(targets=[
      Subscript(value=
        Name(id='d', ctx=Load()),
          slice=
          Index(value=
            BinOp(left=Name(id='i', ctx=Load()), op=Add(),
             right=Name(id='i', ctx=Load()))), ctx=Store())
     ], value=
     BinOp(left=
      BinOp(left=
       Call(func=
        Name(id='ord', ctx=Load()), args=[
          Name(id='i', ctx=Load())
         ], keywords=[], starargs=None, kwargs=None),
       op=Sub(), right=Call(func=
        Name(id='ord', ctx=Load()), args=[
          Str(s='a')
         ], keywords=[], starargs=None, kwargs=None)),
       op=Add(), right=Num(n=1)))
    ], orelse=[])
   Print(dest=None, values=[
     Name(id='d', ctx=Load())
   ], nl=True)
 ])
@end example

El método @code{literal_eval()} toma una cadena o un AST que representa una expresión literal, la analiza y evalúa, y devuelve el valor resultante.  Una expresión literal es una expresión de Python que sólo contiene cadenas, números, diccionarios, etc. pero no declaraciones o llamadas a funciones.  Si necesita evaluar una expresión pero no puede aceptar el riesgo de seguridad que supone utilizar una llamada a @ref{2eb,,eval()}, @code{literal_eval()} lo hará de forma segura:

@example
>>> literal = '("a", "b", @{2:4, 3:8, 1:2@})'
>>> print ast.literal_eval(literal)
('a', 'b', @{1: 2, 2: 4, 3: 8@})
>>> print ast.literal_eval('"a" + "b"')
Traceback (most recent call last):
  ...
ValueError: malformed string
@end example

El módulo también incluye las clases @code{NodeVisitor} y @code{NodeTransformer} para recorrer y modificar un AST, y funciones para transformaciones comunes como el cambio de números de línea.

@c ======================================================================

@node El módulo future_builtins,El módulo json Notación de objetos de JavaScript,El módulo ast,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 the-future-builtins-module}@anchor{1425}
@subsubsection El módulo @code{future_builtins}


Python 3.0 introduce muchos cambios en el repertorio de funciones incorporadas, y la mayoría de los cambios no pueden introducirse en la serie Python 2.x porque romperían la compatibilidad. El módulo @code{future_builtins} proporciona versiones de estas funciones incorporadas que pueden importarse al escribir código compatible con la versión 3.0.

Las funciones de este módulo incluyen actualmente:


@itemize *

@item 
@code{ascii(obj)}: equivalente a @ref{894,,repr()}.  En Python 3.0, @ref{894,,repr()} devolverá una cadena Unicode, mientras que @ref{1426,,ascii()} devolverá una cadena de bytes ASCII pura.

@item 
@code{filtro(predicado, iterable)}, @code{map(func, iterable1, ...)}: las versiones 3.0 devuelven iteradores, a diferencia de las funciones integradas 2.x que devuelven listas.

@item 
@code{hex(valor)}, @code{oct(valor)}: en lugar de llamar a los métodos @code{__hex__()} o @code{__oct__()}, estas versiones llamarán al método @code{__index__()} y convertirán el resultado a hexadecimal u octal. @ref{1336,,oct()} utilizará la nueva notación @code{0o} para su resultado.
@end itemize

@c ======================================================================

@node El módulo json Notación de objetos de JavaScript,El módulo plistlib Un analizador de listas de propiedades,El módulo future_builtins,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 the-json-module-javascript-object-notation}@anchor{1427}
@subsubsection El módulo @code{json}: Notación de objetos de JavaScript


El nuevo módulo @ref{82,,json} soporta la codificación y decodificación de tipos Python en JSON (`Javascript Object Notation'). JSON es un formato de intercambio ligero que se utiliza a menudo en las aplicaciones web. Para más información sobre JSON, consulte @indicateurl{http://www.json.org}.

@ref{82,,json} viene con soporte para decodificar y codificar la mayoría de los tipos incorporados de Python. El siguiente ejemplo codifica y decodifica un diccionario:

@example
>>> import json
>>> data = @{"spam": "foo", "parrot": 42@}
>>> in_json = json.dumps(data) # Encode the data
>>> in_json
'@{"parrot": 42, "spam": "foo"@}'
>>> json.loads(in_json) # Decode into a Python object
@{"spam": "foo", "parrot": 42@}
@end example

También es posible escribir tus propios decodificadores y codificadores para soportar más tipos. También se admite la impresión bonita de las cadenas JSON.

@ref{82,,json} (originalmente llamado simplejson) fue escrito por Bob Ippolito.

@c ======================================================================

@node El módulo plistlib Un analizador de listas de propiedades,mejoras en ctypes,El módulo json Notación de objetos de JavaScript,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 the-plistlib-module-a-property-list-parser}@anchor{1428}
@subsubsection El módulo @code{plistlib}: Un analizador de listas de propiedades


El formato @code{.plist} se utiliza habitualmente en Mac OS X para almacenar tipos de datos básicos (números, cadenas, listas y diccionarios) serializándolos en un formato basado en XML. Se asemeja a la serialización XML-RPC de los tipos de datos.

A pesar de ser utilizado principalmente en Mac OS X, el formato no tiene nada de específico para Mac y la implementación de Python funciona en cualquier plataforma que soporte Python, por lo que el módulo @ref{ab,,plistlib} ha sido promovido a la biblioteca estándar.

El uso del módulo es sencillo:

@example
import sys
import plistlib
import datetime

# Create data structure
data_struct = dict(lastAccessed=datetime.datetime.now(),
                   version=1,
                   categories=('Personal','Shared','Private'))

# Create string containing XML.
plist_str = plistlib.writePlistToString(data_struct)
new_struct = plistlib.readPlistFromString(plist_str)
print data_struct
print new_struct

# Write data structure to a file and read it back.
plistlib.writePlist(data_struct, '/tmp/customizations.plist')
new_struct = plistlib.readPlist('/tmp/customizations.plist')

# read/writePlist accepts file-like objects as well as paths.
plistlib.writePlist(data_struct, sys.stdout)
@end example

@c ======================================================================

@node mejoras en ctypes,Mejora de la compatibilidad con SSL,El módulo plistlib Un analizador de listas de propiedades,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 ctypes-enhancements}@anchor{1429}
@subsubsection mejoras en ctypes


Thomas Heller siguió manteniendo y mejorando el módulo @ref{2b,,ctypes}.

@ref{2b,,ctypes} soporta ahora un tipo de datos @code{c_bool} que representa el tipo C99 @code{bool}.  (Contribución de David Remahl; bpo-1649190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1649190}.)

Los tipos de cadena, buffer y array de @ref{2b,,ctypes} han mejorado el soporte para la sintaxis de corte extendida, donde se suministran varias combinaciones de @code{(start, stop, step)}. (Implementado por Thomas Wouters)

@c Revision 57769

Todos los tipos de datos @ref{2b,,ctypes} soportan ahora los métodos @code{from_buffer()} y @code{from_buffer_copy()} que crean una instancia de ctypes basada en un objeto buffer proporcionado. @code{from_buffer_copy()} copia el contenido del objeto, mientras que @code{from_buffer()} compartirá la misma área de memoria.

Una nueva convención de llamada indica a @ref{2b,,ctypes} que borre las variables @code{errno} o Win32 LastError al inicio de cada llamada envuelta. (Implementado por Thomas Heller; bpo-1798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1798}.)

Ahora puede recuperar la variable Unix @code{errno} después de una llamada a una función.  Al crear una función envuelta, puede suministrar @code{use_errno=True} como parámetro de palabra clave a la función @code{DLL()} y luego llamar a los métodos de nivel de módulo @code{set_errno()} y @code{get_errno()} para establecer y recuperar el valor del error.

La variable Win32 LastError es soportada de forma similar por las funciones @code{DLL()}, @code{OleDLL()}, y @code{WinDLL()}. Se suministra @code{use_last_error=True} como parámetro de palabra clave y luego se llaman los métodos a nivel de módulo @code{set_last_error()} y @code{get_last_error()}.

La función @code{byref()}, utilizada para recuperar un puntero a una instancia de ctypes, tiene ahora un parámetro opcional `offset' que es un recuento de bytes que se añadirá al puntero devuelto.

@c ======================================================================

@node Mejora de la compatibilidad con SSL,,mejoras en ctypes,Módulos nuevos y mejorados<2>
@anchor{whatsnew/2 6 improved-ssl-support}@anchor{142a}
@subsubsection Mejora de la compatibilidad con SSL


Bill Janssen ha realizado amplias mejoras en el soporte de Python 2.6 para la Capa de Conexión Segura añadiendo un nuevo módulo, @ref{d0,,ssl}, que está construido sobre la biblioteca OpenSSL@footnote{https://www.openssl.org/}. Este nuevo módulo proporciona más control sobre el protocolo negociado, los certificados X.509 utilizados, y tiene un mejor soporte para escribir servidores SSL (a diferencia de los clientes) en Python.  El soporte SSL existente en el módulo @ref{cc,,socket} no ha sido eliminado y sigue funcionando, aunque será eliminado en Python 3.0.

Para utilizar el nuevo módulo, primero hay que crear una conexión TCP de la forma habitual y luego pasarla a la función @code{ssl.wrap_socket()}. Es posible especificar si se requiere un certificado, y obtener información sobre el mismo llamando al método @code{getpeercert()}.


@subsubheading Ver también


La documentación del módulo @ref{d0,,ssl}.


@c ======================================================================

@node Cancelaciones y eliminaciones,Cambios en la API de construcción y C<3>,Módulos nuevos y mejorados<2>,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 deprecations-and-removals}@anchor{142b}
@subsection Cancelaciones y eliminaciones



@itemize *

@item 
Se han eliminado las excepciones de cadena.  Al intentar utilizarlas se produce un @ref{228,,TypeError}.

@item 
Changes to the @ref{a6b,,Exception} interface
as dictated by 
@geindex Python Enhancement Proposals; PEP 352
PEP 352@footnote{https://peps.python.org/pep-0352/} continue to be made.  For 2.6,
the @code{message} attribute is being deprecated in favor of the
@ref{610,,args} attribute.

@item 
(modo 3.0-warning) Python 3.0 presentará una biblioteca estándar reorganizada que eliminará muchos módulos obsoletos y renombrará otros. Python 2.6 funcionando en modo 3.0-warning avisará de estos módulos cuando se importen.

The list of deprecated modules is:
@code{audiodev},
@code{bgenlocations},
@code{buildtools},
@code{bundlebuilder},
@code{Canvas},
@code{compiler},
@code{dircache},
@code{dl},
@code{fpformat},
@code{gensuitemodule},
@code{ihooks},
@code{imageop},
@code{imgfile},
@code{linuxaudiodev},
@code{mhlib},
@code{mimetools},
@code{multifile},
@code{new},
@code{pure},
@code{statvfs},
@code{sunaudiodev},
@code{test.testall}, and
@code{toaiff}.

@item 
The @code{gopherlib} module has been removed.

@item 
The @code{MimeWriter} module and @code{mimify} module
have been deprecated; use the @ref{3c,,email}
package instead.

@item 
The @code{md5} module has been deprecated; use the @ref{68,,hashlib} module
instead.

@item 
The @code{posixfile} module has been deprecated; @ref{142c,,fcntl.lockf()}
provides better locking.

@item 
The @code{popen2} module has been deprecated; use the @ref{d6,,subprocess}
module.

@item 
The @code{rgbimg} module has been removed.

@item 
The @code{sets} module has been deprecated; it’s better to
use the built-in @ref{67a,,set} and @ref{67b,,frozenset} types.

@item 
The @code{sha} module has been deprecated; use the @ref{68,,hashlib} module
instead.
@end itemize

@c ======================================================================

@node Cambios en la API de construcción y C<3>,Adaptación a Python 2 6,Cancelaciones y eliminaciones,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 build-and-c-api-changes}@anchor{142d}
@subsection Cambios en la API de construcción y C


Los cambios en el proceso de construcción de Python y en la API de C incluyen:


@itemize *

@item 
Python ahora debe ser compilado con compiladores C89 (¡después de 19 años!).  Esto significa que el árbol de fuentes de Python ha abandonado sus propias implementaciones de @code{memmove()} y @code{strerror()}, que están en la biblioteca estándar de C89.

@item 
Python 2.6 puede ser construido con Microsoft Visual Studio 2008 (versión 9.0), y este es el nuevo compilador por defecto.  Ver el directorio @code{PCbuild} para los archivos de construcción.  (Implementado por Christian Heimes)

@item 
En Mac OS X, Python 2.6 puede ser compilado como una construcción universal de 4 vías. El script @code{configure} puede tomar una opción :@cite{!–with-universal-archs=[32-bit|64-bit|all]}, controlando si los binarios se construyen para arquitecturas de 32 bits (x86, PowerPC), 64 bits (x86-64 y PPC-64), o ambas. (Contribución de Ronald Oussoren)

@item 
A new function added in Python 2.6.6, @code{PySys_SetArgvEx()}, sets
the value of @code{sys.argv} and can optionally update @code{sys.path} to
include the directory containing the script named by @code{sys.argv[0]}
depending on the value of an `updatepath' parameter.

This function was added to close a security hole for applications
that embed Python.  The old function, @code{PySys_SetArgv()}, would
always update @code{sys.path}, and sometimes it would add the current
directory.  This meant that, if you ran an application embedding
Python in a directory controlled by someone else, attackers could
put a Trojan-horse module in the directory (say, a file named
@code{os.py}) that your application would then import and run.

If you maintain a C/C++ application that embeds Python, check
whether you’re calling @code{PySys_SetArgv()} and carefully consider
whether the application should be using @code{PySys_SetArgvEx()}
with `updatepath' set to false.  Note that using this function will
break compatibility with Python versions 2.6.5 and earlier; if you
have to continue working with earlier versions, you can leave
the call to @code{PySys_SetArgv()} alone and call
@code{PyRun_SimpleString("sys.path.pop(0)\n")} afterwards to discard
the first @code{sys.path} component.

Security issue reported as 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983};
discussed in gh-50003@footnote{https://github.com/python/cpython/issues/50003}, and fixed by Antoine Pitrou.

@item 
El módulo BerkeleyDB tiene ahora un objeto C API, disponible como @code{bsddb.db.api}.   Este objeto puede ser utilizado por otras extensiones de C que deseen utilizar el módulo @code{bsddb} para sus propios fines. (Contribución de Duncan Grisby)

@item 
La nueva interfaz del buffer, descrita previamente en @ref{13f9,,la sección PEP 3118}, añade @ref{48c,,PyObject_GetBuffer()} y @ref{48d,,PyBuffer_Release()}, así como algunas otras funciones.

@item 
El uso que hace Python de la biblioteca stdio de C es ahora seguro para los hilos, o al menos tan seguro como la biblioteca subyacente.  Un error potencial de larga data ocurría si un hilo cerraba un objeto de archivo mientras otro hilo estaba leyendo o escribiendo en el objeto.  En la versión 2.6 los objetos archivo tienen un contador de referencias, manipulado por las funciones @code{PyFile_IncUseCount()} y @code{PyFile_DecUseCount()}.  Los objetos de archivo no pueden cerrarse a menos que el recuento de referencias sea cero. @code{PyFile_IncUseCount()} debe llamarse mientras se mantiene el GIL, antes de realizar una operación de E/S utilizando el puntero @code{FILE *}, y @code{PyFile_DecUseCount()} debe llamarse inmediatamente después de recuperar el GIL. (Contribución de Antoine Pitrou y Gregory P. Smith)

@item 
Importar módulos simultáneamente en dos hilos diferentes ya no se bloquea; ahora lanzará un @ref{4d7,,ImportError}.  Una nueva función de la API, @ref{272,,PyImport_ImportModuleNoBlock()}, buscará un módulo en @code{sys.modules} primero, y luego intentará importarlo después de adquirir un bloqueo de importación.  Si el bloqueo de importación está en manos de otro hilo, se genera un @ref{4d7,,ImportError}. (Contribuido por Christian Heimes.)

@item 
Several functions return information about the platform’s
floating-point support.  @ref{142e,,PyFloat_GetMax()} returns
the maximum representable floating-point value,
and @ref{142f,,PyFloat_GetMin()} returns the minimum
positive value.  @ref{1430,,PyFloat_GetInfo()} returns an object
containing more information from the @code{float.h} file, such as
@code{"mant_dig"} (number of digits in the mantissa), @code{"epsilon"}
(smallest difference between 1.0 and the next largest value
representable), and several others.
(Contributed by Christian Heimes; bpo-1534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1534}.)

@item 
Las funciones y métodos de C que utilizan @ref{1431,,PyComplex_AsCComplex()} ahora aceptarán argumentos que tengan un método @code{__complex__()}.  En particular, las funciones del módulo @ref{19,,cmath} ahora aceptarán objetos con este método. Este es un retroceso de un cambio en Python 3.0. (Contribuido por Mark Dickinson; bpo-1675423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1675423}.)

@item 
La API de C de Python incluye ahora dos funciones para comparar cadenas sin distinción de mayúsculas y minúsculas, @code{PyOS_stricmp(char*, char*)} y @code{PyOS_strnicmp(char*, char*, Py_ssize_t)}. (Contribución de Christian Heimes; bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}.)

@item 
Muchas extensiones de C definen su propia macro para añadir enteros y cadenas al diccionario del módulo en la función @code{init*}.  Python 2.6 finalmente define macros estándar para añadir valores a un módulo, @ref{1432,,PyModule_AddStringMacro} y @ref{1433,,PyModule_AddIntMacro()}.  (Contribución de Christian Heimes.)

@item 
Algunas macros han sido renombradas tanto en la 3.0 como en la 2.6 para dejar más claro que son macros y no funciones. @code{Py_Size()} se convierte en @ref{81b,,Py_SIZE()}, @code{Py_Type()} se convierte en @ref{26e,,Py_TYPE()}, y @code{Py_Refcnt()} se convierte en @ref{26f,,Py_REFCNT()}. Las macros de mayúsculas y minúsculas siguen estando disponibles en Python 2.6 por compatibilidad con versiones anteriores. (bpo-1629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1629})

@item 
Distutils ahora coloca las extensiones C que construye en un directorio diferente cuando se ejecuta en una versión de depuración de Python. (Contribución de Collin Winter; bpo-1530959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1530959}.)

@item 
Varios tipos de datos básicos, como los enteros y las cadenas, mantienen listas internas de objetos libres que pueden reutilizarse.  Las estructuras de datos para estas listas libres siguen ahora una convención de nomenclatura: la variable se llama siempre @code{free_list}, el contador se llama siempre @code{numfree}, y siempre se define una macro @code{Py<typename>_MAXFREELIST}

@item 
Un nuevo objetivo de Makefile, «make patchcheck», prepara el árbol de fuentes de Python para hacer un parche: corrige los espacios en blanco al final de todos los archivos @code{.py} modificados, comprueba si la documentación ha sido cambiada, e informa si los archivos @code{Misc/ACKS} y @code{Misc/NEWS} han sido actualizados. (Contribuido por Brett Cannon.)

Otro nuevo objetivo, «make profile-opt», compila un binario de Python utilizando la optimización guiada por perfiles de GCC.  Compila Python con el perfil habilitado, ejecuta el conjunto de pruebas para obtener un conjunto de resultados de perfil, y luego compila usando estos resultados para la optimización. (Contribución de Gregory P. Smith)
@end itemize

@c ======================================================================

@menu
* Cambios específicos en los puertos; Windows: Cambios específicos en los puertos Windows<2>. 
* Cambios específicos en los puertos; Mac OS X: Cambios específicos en los puertos Mac OS X<2>. 
* Cambios específicos en los puertos; IRIX: Cambios específicos en los puertos IRIX. 

@end menu

@node Cambios específicos en los puertos Windows<2>,Cambios específicos en los puertos Mac OS X<2>,,Cambios en la API de construcción y C<3>
@anchor{whatsnew/2 6 port-specific-changes-windows}@anchor{1434}
@subsubsection Cambios específicos en los puertos: Windows



@itemize *

@item 
Se ha eliminado el soporte para Windows 95, 98, ME y NT4. Python 2.6 requiere al menos Windows 2000 SP4.

@item 
El nuevo compilador por defecto en Windows es Visual Studio 2008 (versión 9.0). Los directorios de compilación para Visual Studio 2003 (versión 7.1) y 2005 (versión 8.0) se han trasladado al directorio PC/. El nuevo directorio @code{PCbuild} admite la compilación cruzada para X64, las compilaciones de depuración y la optimización guiada por perfil (PGO). Las compilaciones PGO son aproximadamente un 10% f más rápidas que las normales.  (Contribuido por Christian Heimes con la ayuda de Amaury Forgeot d’Arc y Martin von Löwis)

@item 
The @ref{93,,msvcrt} module now supports
both the normal and wide char variants of the console I/O
API.  The @ref{1435,,getwch()} function reads a keypress and returns a Unicode
value, as does the @ref{1436,,getwche()} function.  The @ref{1437,,putwch()} function
takes a Unicode character and writes it to the console.
(Contributed by Christian Heimes.)

@item 
@ref{1419,,os.path.expandvars()} ahora expandirá las variables de entorno de la forma «%var%», y «~user» se expandirá en la ruta del directorio personal del usuario.  (Contribución de Josiah Carlson; bpo-957650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957650}.)

@item 
The @ref{cc,,socket} module’s socket objects now have an
@ref{d5a,,ioctl()} method that provides a limited interface to the
@code{WSAIoctl()} system interface.

@item 
The @ref{116,,_winreg} module now has a function,
@ref{1438,,ExpandEnvironmentStrings()},
that expands environment variable references such as @code{%NAME%}
in an input string.  The handle objects provided by this
module now support the context protocol, so they can be used
in @ref{673,,with} statements. (Contributed by Christian Heimes.)

@ref{116,,_winreg} also has better support for x64 systems,
exposing the @ref{13c4,,DisableReflectionKey()}, @ref{13c5,,EnableReflectionKey()},
and @ref{13c6,,QueryReflectionKey()} functions, which enable and disable
registry reflection for 32-bit processes running on 64-bit systems.
(bpo-1753245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1753245})

@item 
The @code{msilib} module’s @code{Record} object
gained @code{GetInteger()} and @code{GetString()} methods that
return field values as an integer or a string.
(Contributed by Floris Bruynooghe; bpo-2125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2125}.)
@end itemize

@c ======================================================================

@node Cambios específicos en los puertos Mac OS X<2>,Cambios específicos en los puertos IRIX,Cambios específicos en los puertos Windows<2>,Cambios en la API de construcción y C<3>
@anchor{whatsnew/2 6 port-specific-changes-mac-os-x}@anchor{1439}
@subsubsection Cambios específicos en los puertos: Mac OS X



@itemize *

@item 
Cuando se compila una estructura de Python, ahora se puede especificar el nombre de la estructura que se utilizará proporcionando la opción @code{--with-framework-name=} al script @code{configure}.

@item 
The @code{macfs} module has been removed.  This in turn required the
@code{macostools.touched()} function to be removed because it depended on the
@code{macfs} module.  (bpo-1490190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1490190})

@item 
Many other Mac OS modules have been deprecated and will be removed in
Python 3.0:
@code{_builtinSuites},
@code{aepack},
@code{aetools},
@code{aetypes},
@code{applesingle},
@code{appletrawmain},
@code{appletrunner},
@code{argvemulator},
@code{Audio_mac},
@code{autoGIL},
@code{Carbon},
@code{cfmfile},
@code{CodeWarrior},
@code{ColorPicker},
@code{EasyDialogs},
@code{Explorer},
@code{Finder},
@code{FrameWork},
@code{findertools},
@code{ic},
@code{icglue},
@code{icopen},
@code{macerrors},
@code{MacOS},
@code{macfs},
@code{macostools},
@code{macresource},
@code{MiniAEFrame},
@code{Nav},
@code{Netscape},
@code{OSATerminology},
@code{pimp},
@code{PixMapWrapper},
@code{StdSuites},
@code{SystemEvents},
@code{Terminal}, and
@code{terminalcommand}.
@end itemize

@c ======================================================================

@node Cambios específicos en los puertos IRIX,,Cambios específicos en los puertos Mac OS X<2>,Cambios en la API de construcción y C<3>
@anchor{whatsnew/2 6 port-specific-changes-irix}@anchor{143a}
@subsubsection Cambios específicos en los puertos: IRIX


A number of old IRIX-specific modules were deprecated and will
be removed in Python 3.0:
@code{al} and @code{AL},
@code{cd},
@code{cddb},
@code{cdplayer},
@code{CL} and @code{cl},
@code{DEVICE},
@code{ERRNO},
@code{FILE},
@code{FL} and @code{fl},
@code{flp},
@code{fm},
@code{GET},
@code{GLWS},
@code{GL} and @code{gl},
@code{IN},
@code{IOCTL},
@code{jpeg},
@code{panelparser},
@code{readcd},
@code{SV} and @code{sv},
@code{torgb},
@code{videoreader}, and
@code{WAIT}.

@c ======================================================================

@node Adaptación a Python 2 6,Agradecimientos<2>,Cambios en la API de construcción y C<3>,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 porting-to-python-2-6}@anchor{143b}
@subsection Adaptación a Python 2.6


Esta sección enumera los cambios descritos anteriormente y otras correcciones de errores que pueden requerir cambios en su código:


@itemize *

@item 
Las clases que no se supone que son hashable deben establecer @code{__hash__ = None} en sus definiciones para indicar el hecho.

@item 
Se han eliminado las excepciones de cadena.  Al intentar utilizarlas se produce un @ref{228,,TypeError}.

@item 
El método @code{__init__()} de @ref{67d,,collections.deque} ahora borra cualquier contenido existente del deque antes de añadir elementos del iterable.  Este cambio hace que el comportamiento coincida con @code{list.__init__()}.

@item 
@ref{751,,object.__init__()} anteriormente aceptaba argumentos arbitrarios y argumentos de palabras clave, ignorándolos.  En Python 2.6, esto ya no está permitido y resultará en un @ref{228,,TypeError}.  Esto afectará a los métodos @code{__init__()} que acaben llamando al método correspondiente en @ref{b18,,object} (quizás mediante el uso de @ref{155,,super()}). Ver bpo-1683368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1683368} para su discusión.

@item 
El constructor @code{Decimal} ahora acepta los espacios en blanco iniciales y finales cuando se le pasa una cadena.  Antes lanzaba una excepción @code{InvalidOperation}.  Por otro lado, el método @code{create_decimal()} de los objetos @code{Context} ahora desestima explícitamente los espacios en blanco adicionales, lanzando una excepción @code{ConversionSyntax}.

@item 
Debido a un accidente de implementación, si se pasaba una ruta de archivo a la función incorporada @ref{96b,,__import__()}, ésta importaría realmente el archivo especificado.  Sin embargo, nunca se pretendió que esto funcionara, y la implementación ahora comprueba explícitamente este caso y lanza un @ref{4d7,,ImportError}.

@item 
API C: las funciones @ref{143c,,PyImport_Import()} y @ref{273,,PyImport_ImportModule()} ahora se ajustan por defecto a importaciones absolutas, no a importaciones relativas. Esto afectará a las extensiones de C que importen otros módulos.

@item 
API C: los tipos de datos de extensión que no deben ser hashable deben definir su ranura @code{tp_hash} a @ref{1406,,PyObject_HashNotImplemented()}.

@item 
La excepción del módulo @ref{cc,,socket} @ref{10d1,,socket.error} ahora hereda de @ref{10ce,,IOError}.  Anteriormente no era una subclase de @code{StandardError} pero ahora lo es, a través de @ref{10ce,,IOError}. (Implementado por Gregory P. Smith; bpo-1706815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1706815}.)

@item 
The @ref{12d,,xmlrpclib} module no longer automatically converts
@ref{330,,datetime.date} and @ref{331,,datetime.time} to the
@ref{1423,,xmlrpclib.DateTime} type; the conversion semantics were
not necessarily correct for all applications.  Code using
@code{xmlrpclib} should convert @code{date} and @ref{331,,time}
instances. (bpo-1330538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1330538})

@item 
(Modo de advertencia 3.0) La clase @ref{a6b,,Exception} ahora advierte cuando se accede utilizando el acceso a la rebanada o al índice; tener @ref{a6b,,Exception} se comporta como una tupla está siendo eliminado.

@item 
(modo de advertencia 3.0) las comparaciones de desigualdad entre dos diccionarios o dos objetos que no implementan métodos de comparación se reportan como advertencias.  @code{dict1 == dict2} sigue funcionando, pero @code{dict1 < dict2} está siendo eliminado.

Las comparaciones entre celdas, que son un detalle de implementación de las reglas de alcance de Python, también causan advertencias porque tales comparaciones están prohibidas por completo en 3.0.
@end itemize

For applications that embed Python:


@itemize *

@item 
The @code{PySys_SetArgvEx()} function was added in Python 2.6.6,
letting applications close a security hole when the existing
@code{PySys_SetArgv()} function was used.  Check whether you’re
calling @code{PySys_SetArgv()} and carefully consider whether the
application should be using @code{PySys_SetArgvEx()} with
`updatepath' set to false.
@end itemize

@c ======================================================================

@node Agradecimientos<2>,,Adaptación a Python 2 6,Qué hay de nuevo en Python 2 6
@anchor{whatsnew/2 6 acknowledgements}@anchor{143d}@anchor{whatsnew/2 6 acks}@anchor{143e}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas sus sugerencias, correcciones y ayuda en varios borradores de este artículo: Georg Brandl, Steve Brown, Nick Coghlan, Ralph Corderoy, Jim Jewett, Kent Johnson, Chris Lambacher, Martin Michlmayr, Antoine Pitrou, Brian Warner.

@node Qué hay de nuevo en Python 2 5,Qué hay de nuevo en Python 2 4,Qué hay de nuevo en Python 2 6,Qué hay de nuevo en Python
@anchor{whatsnew/2 5 doc}@anchor{143f}@anchor{whatsnew/2 5 what-s-new-in-python-2-5}@anchor{1440}
@section Qué hay de nuevo en Python 2.5


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew25.tex 56611 2007-07-29 08:26:10Z georg.brandl $

@c Fix XXX comments

Este artículo explica las nuevas características de Python 2.5.  La versión final de Python 2.5 está prevista para agosto de 2006; 
@geindex Python Enhancement Proposals; PEP 356
PEP 356@footnote{https://peps.python.org/pep-0356/} describe el cronograma de lanzamiento planificado.

Los cambios en Python 2.5 son una interesante mezcla de mejoras en el lenguaje y en las bibliotecas. Las mejoras en las bibliotecas serán más importantes para la comunidad de usuarios de Python, creo, debido a que se han añadido varios paquetes bastante útiles.  Los nuevos módulos incluyen ElementTree para el procesamiento de XML (@code{xml.etree}), el módulo de base de datos SQLite (@code{sqlite}), y el módulo @ref{2b,,ctypes} para llamar a funciones escritas en lenguaje C.

Los cambios en el lenguaje son de mediana importancia.  Se han añadido algunas características nuevas y agradables, pero la mayoría de ellas no son características que vaya a utilizar todos los días. Las expresiones condicionales fueron finalmente añadidas al lenguaje usando una nueva sintaxis; ver sección @ref{1441,,PEP 308; Expresiones condicionales}.  La nueva sentencia “@ref{673,,with}” facilitará la escritura de código de limpieza (sección @ref{1442,,PEP 343; La declaración «con}).  Ahora se pueden pasar valores a los generadores (sección @ref{1443,,PEP 342; Nuevas funciones del generador}).  Las importaciones son ahora visibles como absolutas o relativas (sección @ref{1444,,PEP 328; Importaciones absolutas y relativas}).  Se han mejorado algunos casos de manejo de excepciones (sección @ref{1445,,PEP 341; Try/except/finally unificados}).  Todas estas mejoras merecen la pena, pero son mejoras de una u otra característica específica del lenguaje; ninguna de ellas es una modificación amplia de la semántica de Python.

Además de las adiciones al lenguaje y a la biblioteca, se han realizado otras mejoras y correcciones de errores en todo el árbol de código fuente.  Una búsqueda en los registros de cambios del SVN revela que se aplicaron 353 parches y se corrigieron 458 errores entre Python 2.4 y 2.5.  (Es probable que ambas cifras estén subestimadas)

Este artículo no pretende ser una especificación completa de las nuevas características; en su lugar, los cambios se introducen brevemente utilizando ejemplos útiles.  Para obtener todos los detalles, siempre debes consultar la documentación de Python 2.5 en @indicateurl{https://docs.python.org}. Si quieres entender la implementación completa y los fundamentos del diseño, consulta el PEP de una nueva característica en particular.

Son bienvenidos los comentarios, las sugerencias y los informes de errores para este documento; por favor, envíelos por correo electrónico al autor o abra un error en el rastreador de errores de Python.

@c ======================================================================

@menu
* PEP 308; Expresiones condicionales: PEP 308 Expresiones condicionales. 
* PEP 309; Aplicación parcial de funciones: PEP 309 Aplicación parcial de funciones. 
* PEP 314; Metadatos para paquetes de software Python v1.1: PEP 314 Metadatos para paquetes de software Python v1 1. 
* PEP 328; Importaciones absolutas y relativas: PEP 328 Importaciones absolutas y relativas. 
* PEP 338; Ejecutando Módulos como Scripts: PEP 338 Ejecutando Módulos como Scripts. 
* PEP 341; Try/except/finally unificados: PEP 341 Try/except/finally unificados. 
* PEP 342; Nuevas funciones del generador: PEP 342 Nuevas funciones del generador. 
* PEP 343; La declaración «con: PEP 343 La declaración «con. 
* PEP 352; Las excepciones como clases de nuevo estilo: PEP 352 Las excepciones como clases de nuevo estilo. 
* PEP 353; Uso de ssize_t como tipo de índice: PEP 353 Uso de ssize_t como tipo de índice. 
* PEP 357; El método “__index__”: PEP 357 El método “__index__”. 
* Otros cambios lingüísticos: Otros cambios lingüísticos<2>. 
* Módulos nuevos@comma{} mejorados y eliminados: Módulos nuevos mejorados y eliminados. 
* Cambios en la API de construcción y C: Cambios en la API de construcción y C<4>. 
* Adaptación a Python 2.5: Adaptación a Python 2 5. 
* Agradecimientos: Agradecimientos<3>. 

@end menu

@node PEP 308 Expresiones condicionales,PEP 309 Aplicación parcial de funciones,,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-308}@anchor{1441}@anchor{whatsnew/2 5 pep-308-conditional-expressions}@anchor{1446}
@subsection PEP 308: Expresiones condicionales


Durante mucho tiempo, la gente ha solicitado una forma de escribir expresiones condicionales, que son expresiones que devuelven el valor A o el valor B dependiendo de si un valor booleano es verdadero o falso.  Una expresión condicional le permite escribir una única sentencia de asignación que tiene el mismo efecto que la siguiente:

@example
if condition:
    x = true_value
else:
    x = false_value
@end example

Ha habido interminables y tediosas discusiones sobre la sintaxis tanto en python-dev como en comp.lang.python.  Incluso se llevó a cabo una votación en la que se descubrió que la mayoría de los votantes querían expresiones condicionales de alguna forma, pero no había ninguna sintaxis que fuera preferida por una clara mayoría. Los candidatos incluían @code{cond ? true_v : false_v}, @code{if cond then true_v else false_v}, y otras 16 variaciones.

Guido van Rossum eligió finalmente una sintaxis sorprendente:

@example
x = true_value if condition else false_value
@end example

La evaluación sigue siendo perezosa como en las expresiones booleanas existentes, por lo que el orden de evaluación salta un poco.  La expresión `condición' del medio se evalúa primero, y la expresión `valor_verdadero' se evalúa sólo si la condición es verdadera.  Del mismo modo, la expresión `valor_falso' sólo se evalúa cuando la condición es falsa.

Esta sintaxis puede parecer extraña y retrógrada; ¿por qué la condición va en el `medio' de la expresión, y no en la parte delantera como en @code{c ? x : y} de C?  La decisión se comprobó aplicando la nueva sintaxis a los módulos de la biblioteca estándar y viendo cómo se leía el código resultante.  En muchos casos en los que se utiliza una expresión condicional, un valor parece ser el «caso común» y otro valor es un «caso excepcional», utilizado sólo en las raras ocasiones en las que no se cumple la condición.  La sintaxis condicional hace que este patrón sea un poco más obvio:

@example
contents = ((doc + '\n') if doc else '@w{'})
@end example

Leo la afirmación anterior en el sentido de que «aquí se asigna a `contents' un valor de @code{doc+'\n'}; a veces `doc' está vacío, en cuyo caso especial se devuelve una cadena vacía»   Dudo que use expresiones condicionales muy a menudo donde no hay un caso común y no común claro.

Hubo alguna discusión sobre si el lenguaje debería requerir rodear las expresiones condicionales con paréntesis.  Se tomó la decisión de `no' requerir paréntesis en la gramática del lenguaje Python, pero como una cuestión de estilo creo que siempre deberías usarlos. Considere estas dos declaraciones:

@example
# First version -- no parens
level = 1 if logging else 0

# Second version -- with parens
level = (1 if logging else 0)
@end example

En la primera versión, creo que el ojo de un lector podría agrupar la sentencia en “nivel = 1”, “si registro”, “si no 0”, y pensar que la condición decide si se realiza la asignación a `nivel'.  La segunda versión se lee mejor, en mi opinión, porque deja claro que la asignación se realiza siempre y que se está eligiendo entre dos valores.

Otra razón para incluir los paréntesis: algunas combinaciones extrañas de comprensiones de listas y lambdas podrían parecer expresiones condicionales incorrectas. Véase 
@geindex Python Enhancement Proposals; PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} para algunos ejemplos.  Si pone paréntesis alrededor de sus expresiones condicionales, no se encontrará con este caso.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 308

@item PEP 308@footnote{https://peps.python.org/pep-0308/} - Expresiones condicionales

PEP escrito por Guido van Rossum y Raymond D. Hettinger; implementado por Thomas Wouters.
@end table


@c ======================================================================

@node PEP 309 Aplicación parcial de funciones,PEP 314 Metadatos para paquetes de software Python v1 1,PEP 308 Expresiones condicionales,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-309}@anchor{1447}@anchor{whatsnew/2 5 pep-309-partial-function-application}@anchor{1448}
@subsection PEP 309: Aplicación parcial de funciones


El módulo @ref{5f,,functools} está destinado a contener herramientas para la programación de estilo funcional.

Una herramienta útil de este módulo es la función @code{partial()}. Para los programas escritos en un estilo funcional, a veces querrá construir variantes de funciones existentes que tengan algunos de los parámetros rellenados.  Considere una función Python @code{f(a, b, c)}; podría crear una nueva función @code{g(b, c)} que fuera equivalente a @code{f(1, b, c)}.  Esto se llama «aplicación parcial de funciones».

@code{parcial()} toma los argumentos @code{(function, arg1, arg2, ... kwarg1=valor1, kwarg2=valor2)}.  El objeto resultante es invocable, por lo que puedes llamarlo para invocar la `función' con los argumentos rellenados.

He aquí un pequeño pero realista ejemplo:

@example
import functools

def log (message, subsystem):
    "Write the contents of 'message' to the specified subsystem."
    print '%s: %s' % (subsystem, message)
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')
@end example

Aquí hay otro ejemplo, de un programa que utiliza PyGTK.  Aquí se está construyendo dinámicamente un menú emergente sensible al contexto.  El callback proporcionado para la opción de menú es una versión parcialmente aplicada del método @code{open_item()}, donde se ha proporcionado el primer argumento

@example
...
class Application:
    def open_item(self, path):
       ...
    def init (self):
        open_func = functools.partial(self.open_item, item_path)
        popup_menu.append( ("Open", open_func, 1) )
@end example

Otra función del módulo @ref{5f,,functools} es la función @code{update_wrapper(wrapper, wrapped)} que le ayuda a escribir decoradores con un buen comportamiento. @code{update_wrapper()} copia el nombre, el módulo y el atributo docstring a una función wrapper para que las trazas dentro de la función envuelta sean más fáciles de entender.  Por ejemplo, puedes escribir:

@example
def my_decorator(f):
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    functools.update_wrapper(wrapper, f)
    return wrapper
@end example

@code{wraps()} es un decorador que se puede utilizar dentro de sus propios decoradores para copiar la información de la función envuelta.  Una versión alternativa del ejemplo anterior sería:

@example
def my_decorator(f):
    @@functools.wraps(f)
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    return wrapper
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 309

@item PEP 309@footnote{https://peps.python.org/pep-0309/} - Aplicación parcial de funciones

PEP propuesto y escrito por Peter Harris; implementado por Hye-Shik Chang y Nick Coghlan, con adaptaciones de Raymond Hettinger.
@end table


@c ======================================================================

@node PEP 314 Metadatos para paquetes de software Python v1 1,PEP 328 Importaciones absolutas y relativas,PEP 309 Aplicación parcial de funciones,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-314}@anchor{1449}@anchor{whatsnew/2 5 pep-314-metadata-for-python-software-packages-v1-1}@anchor{144a}
@subsection PEP 314: Metadatos para paquetes de software Python v1.1


Se ha añadido a Distutils un sencillo soporte de dependencias.  La función @code{setup()} ahora tiene parámetros de palabras clave @code{requires}, @code{provides} y @code{obsoletes}.  Cuando se construye una distribución de origen utilizando el comando @code{sdist}, la información de las dependencias se registrará en el archivo @code{PKG-INFO}.

Otro nuevo parámetro de palabra clave es @code{download_url}, que debe establecerse como una URL para el código fuente del paquete.  Esto significa que ahora es posible buscar una entrada en el índice de paquetes, determinar las dependencias de un paquete y descargar los paquetes necesarios.

@example
VERSION = '1.0'
setup(name='PyPackage',
      version=VERSION,
      requires=['numarray', 'zlib (>=1.1.4)'],
      obsoletes=['OldPackage']
      download_url=('http://www.example.com/pypackage/dist/pkg-%s.tar.gz'
                    % VERSION),
     )
@end example

Otra nueva mejora en el índice de paquetes de Python en @indicateurl{https://pypi.org} es el almacenamiento de archivos fuente y binarios de un paquete.  El nuevo comando @code{upload} de Distutils subirá un paquete al repositorio.

Antes de poder subir un paquete, debes ser capaz de construir una distribución usando el comando @code{sdist} de Distutils.  Una vez que funcione, puedes ejecutar @code{python setup.py upload} para añadir tu paquete al archivo PyPI.  Opcionalmente puedes firmar el paquete con GPG suministrando las opciones @code{--sign} y @code{--identity}.

La carga de paquetes fue implementada por Martin von Löwis y Richard Jones.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 314

@item PEP 314@footnote{https://peps.python.org/pep-0314/} - Metadatos para paquetes de software Python v1.1

PEP propuesto y redactado por A.M. Kuchling, Richard Jones y Fred Drake; aplicado por Richard Jones y Fred Drake.
@end table


@c ======================================================================

@node PEP 328 Importaciones absolutas y relativas,PEP 338 Ejecutando Módulos como Scripts,PEP 314 Metadatos para paquetes de software Python v1 1,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-328}@anchor{1444}@anchor{whatsnew/2 5 pep-328-absolute-and-relative-imports}@anchor{144b}
@subsection PEP 328: Importaciones absolutas y relativas


La parte más sencilla de 
@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} se implementó en Python 2.4: los paréntesis podían utilizarse ahora para encerrar los nombres importados de un módulo utilizando la sentencia @code{from ... import ...}, facilitando la importación de muchos nombres diferentes.

La parte más complicada se ha implementado en Python 2.5: la importación de un módulo puede especificarse para utilizar importaciones absolutas o relativas al paquete.  El plan es hacer que las importaciones absolutas sean el valor por defecto en futuras versiones de Python.

Digamos que tienes un directorio de paquetes como este:

@example
pkg/
pkg/__init__.py
pkg/main.py
pkg/string.py
@end example

Esto define un paquete llamado @code{pkg} que contiene los submódulos @code{pkg.main} y @code{pkg.string}.

Considera el código del módulo @code{main.py}.  ¿Qué ocurre si ejecuta la sentencia @code{importar cadena}?  En Python 2.4 y anteriores, primero buscará en el directorio del paquete para realizar una importación relativa, encuentra @code{pkg/string.py}, importa el contenido de ese archivo como el módulo @code{pkg.string}, y ese módulo se vincula al nombre @code{string} en el espacio de nombres del módulo @code{pkg.main}.

Eso está bien si @code{pkg.string} era lo que querías.  ¿Pero qué pasa si quieres el módulo estándar de Python @ref{d3,,string}?  No hay una forma limpia de ignorar @code{pkg.string} y buscar el módulo estándar; generalmente tienes que mirar el contenido de @code{sys.modules}, lo cual es ligeramente sucio.    El paquete @code{py.std} de Holger Krekel proporciona una forma más ordenada de realizar importaciones desde la biblioteca estándar, @code{import py; py.std.string.join()}, pero ese paquete no está disponible en todas las instalaciones de Python.

La lectura de código que depende de importaciones relativas también es menos clara, porque un lector puede confundirse sobre qué módulo, @code{cadena} o @code{cadena.pkg}, se pretende utilizar.  Los usuarios de Python aprendieron pronto a no duplicar los nombres de los módulos de la biblioteca estándar en los nombres de los submódulos de sus paquetes, pero no puedes protegerte de que el nombre de tu submódulo se utilice para un nuevo módulo añadido en una futura versión de Python.

En Python 2.5, puedes cambiar el comportamiento de @ref{682,,import} a importaciones absolutas usando una directiva @code{from __future__ import absolute_import}.  Este comportamiento de importación absoluta será el predeterminado en una versión futura (probablemente Python 2.7).  Una vez que las importaciones absolutas sean el valor por defecto, @code{import string} siempre encontrará la versión de la biblioteca estándar. Se sugiere que los usuarios comiencen a usar importaciones absolutas tanto como sea posible, así que es preferible comenzar a escribir @code{de pkg import string} en su código.

Las importaciones relativas siguen siendo posibles añadiendo un punto inicial al nombre del módulo cuando se utiliza la forma @code{from ... import}:

@example
# Import names from pkg.string
from .string import name1, name2
# Import pkg.string
from . import string
@end example

Esto importa el módulo @ref{d3,,string} relativo al paquete actual, así que en @code{pkg.main} esto importará `nombre1' y `nombre2' de @code{pkg.string}. Los puntos iniciales adicionales realizan la importación relativa empezando por el padre del paquete actual.  Por ejemplo, el código en el módulo @code{A.B.C} puede hacer:

@example
from . import D                 # Imports A.B.D
from .. import E                # Imports A.E
from ..F import G               # Imports A.F.G
@end example

Los puntos suspensivos no pueden usarse con la forma @code{importar nombre de modelo} de la sentencia import, sólo con la forma @code{de ... import}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - Importaciones: Multilínea y Absoluto/Relativo

PEP escrito por Aahz; implementado por Thomas Wouters.

@item @indicateurl{https://pylib.readthedocs.io/}

La biblioteca py de Holger Krekel, que contiene el paquete @code{py.std}.
@end table


@c ======================================================================

@node PEP 338 Ejecutando Módulos como Scripts,PEP 341 Try/except/finally unificados,PEP 328 Importaciones absolutas y relativas,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-338}@anchor{144c}@anchor{whatsnew/2 5 pep-338-executing-modules-as-scripts}@anchor{144d}
@subsection PEP 338: Ejecutando Módulos como Scripts


El conmutador @ref{187,,-m} añadido en Python 2.4 para ejecutar un módulo como un script ganó algunas habilidades más.  En lugar de estar implementado en código C dentro del intérprete de Python, el interruptor ahora utiliza una implementación en un nuevo módulo, @ref{be,,runpy}.

El módulo @ref{be,,runpy} implementa un mecanismo de importación más sofisticado de forma que ahora es posible ejecutar módulos en un paquete como @code{pychecker.checker}. El módulo también soporta mecanismos de importación alternativos como el módulo @ref{131,,zipimport}.  Esto significa que puede añadir la ruta de un archivo .zip a @code{sys.path} y luego utilizar el modificador @ref{187,,-m} para ejecutar el código del archivo.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} - Ejecución de módulos como scripts

PEP escrito e implementado por Nick Coghlan.
@end table


@c ======================================================================

@node PEP 341 Try/except/finally unificados,PEP 342 Nuevas funciones del generador,PEP 338 Ejecutando Módulos como Scripts,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-341}@anchor{1445}@anchor{whatsnew/2 5 pep-341-unified-try-except-finally}@anchor{144e}
@subsection PEP 341: Try/except/finally unificados


Hasta la versión 2.5 de Python, la sentencia @ref{789,,try} tenía dos variantes. Podías usar un bloque @ref{a5c,,finally} para asegurarte de que el código se ejecutaba siempre, o uno o más bloques @ref{2f6,,except} para capturar excepciones específicas.  No podías combinar ambos bloques @code{except} y un bloque @code{finally}, porque generar el bytecode correcto para la versión combinada era complicado y no estaba claro cuál debía ser la semántica de la sentencia combinada.

Guido van Rossum pasó algún tiempo trabajando con Java, que sí soporta el equivalente de combinar bloques @ref{2f6,,except} y un bloque @ref{a5c,,finally}, y esto aclaró lo que debería significar la declaración.  En Python 2.5, ahora se puede escribir:

@example
try:
    block-1 ...
except Exception1:
    handler-1 ...
except Exception2:
    handler-2 ...
else:
    else-block
finally:
    final-block
@end example

Se ejecuta el código del `bloque-1'.  Si el código lanza una excepción, se comprueban los distintos bloques @ref{2f6,,except}: si la excepción es de clase @code{Exception1}, se ejecuta `handler-1'; en caso contrario, si es de clase @code{Exception2}, se ejecuta `handler-2', y así sucesivamente.  Si no se produce ninguna excepción, se ejecuta el bloque `else'.

No importa lo que haya sucedido previamente, el `bloque final' se ejecuta una vez que el bloque de código se ha completado y se han manejado las excepciones planteadas. Incluso si hay un error en un manejador de excepciones o en el `bloque else' y se lanza una nueva excepción, el código del `bloque final' se sigue ejecutando.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 341

@item PEP 341@footnote{https://peps.python.org/pep-0341/} - Unificar try-except y try-finally

PEP escrito por Georg Brandl; implementación por Thomas Lee.
@end table


@c ======================================================================

@node PEP 342 Nuevas funciones del generador,PEP 343 La declaración «con,PEP 341 Try/except/finally unificados,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-342}@anchor{1443}@anchor{whatsnew/2 5 pep-342-new-generator-features}@anchor{144f}
@subsection PEP 342: Nuevas funciones del generador


Python 2.5 añade una forma sencilla de pasar valores `a' un generador. Tal y como se introdujo en Python 2.3, los generadores sólo producen salida; una vez que se invoca el código de un generador para crear un iterador, no hay forma de pasar ninguna información nueva a la función cuando se reanuda su ejecución.  A veces, la capacidad de pasar alguna información sería útil.  Las soluciones más ingeniosas para esto incluyen hacer que el código del generador mire a una variable global y luego cambie el valor de la variable global, o pasar algún objeto mutable que los llamadores luego modifiquen.

Para refrescar la memoria de los generadores básicos, he aquí un ejemplo sencillo:

@example
def counter (maximum):
    i = 0
    while i < maximum:
        yield i
        i += 1
@end example

Cuando se llama a @code{contador(10)}, el resultado es un iterador que devuelve los valores de 0 a 9.  Al encontrar la sentencia @ref{a5f,,yield}, el iterador devuelve el valor proporcionado y suspende la ejecución de la función, preservando las variables locales. La ejecución se reanuda en la siguiente llamada al método @ref{86f,,next()} del iterador, retomando después de la sentencia @code{yield}.

En Python 2.3, @ref{a5f,,yield} era una declaración; no devolvía ningún valor.  En 2.5, @code{yield} es ahora una expresión, que devuelve un valor que se puede asignar a una variable o que se puede operar de otra manera:

@example
val = (yield i)
@end example

Te recomiendo que siempre pongas paréntesis alrededor de una expresión @ref{a5f,,yield} cuando estés haciendo algo con el valor devuelto, como en el ejemplo anterior. Los paréntesis no siempre son necesarios, pero es más fácil añadirlos siempre en lugar de tener que recordar cuándo son necesarios.

(
@geindex Python Enhancement Proposals; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} explica las reglas exactas, que consisten en que una expresión @ref{a5f,,yield}debe ir siempre entre paréntesis, excepto cuando ocurre en la expresión de nivel superior en el lado derecho de una asignación.  Esto significa que puedes escribir @code{val = yield i} pero tienes que usar paréntesis cuando hay una operación, como en @code{val = (yield i) + 12})

Los valores se envían a un generador llamando a su método @code{send(value)}.  El código del generador se reanuda y la expresión @ref{a5f,,yield} devuelve el `valor' especificado.  Si se llama al método regular @ref{86f,,next()}, la expresión @code{yield} devuelve @ref{716,,None}.

Aquí está el ejemplo anterior, modificado para permitir cambiar el valor del contador interno.

@example
def counter (maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # If value provided, change counter
        if val is not None:
            i = val
        else:
            i += 1
@end example

Y aquí hay un ejemplo de cambio de contador:

@example
>>> it = counter(10)
>>> print it.next()
0
>>> print it.next()
1
>>> print it.send(8)
8
>>> print it.next()
9
>>> print it.next()
Traceback (most recent call last):
  File "t.py", line 15, in ?
    print it.next()
StopIteration
@end example

@ref{a5f,,yield} normalmente devolverá @ref{716,,None}, por lo que siempre debes comprobar este caso.  No utilices su valor en las expresiones sin más, a menos que estés seguro de que el método @code{send()} será el único utilizado para reanudar tu función generadora.

Además de @code{send()}, hay otros dos nuevos métodos en los generadores:


@itemize *

@item 
@code{throw(type, value=None, traceback=None)} se utiliza para lanzar una excepción dentro del generador; la excepción es lanzada por la expresión @ref{a5f,,yield} donde la ejecución del generador se pausa.

@item 
@code{close()} lanza una nueva excepción @ref{1407,,GeneratorExit} dentro del generador para terminar la iteración.  Al recibir esta excepción, el código del generador debe lanzar @ref{1407,,GeneratorExit} o @ref{c82,,StopIteration}.  Capturar la excepción @ref{1407,,GeneratorExit} y devolver un valor es ilegal y provocará un @ref{1e5,,RuntimeError}; si la función lanza alguna otra excepción, esa excepción se propaga a quien la llama. @code{close()} también será llamado por el recolector de basura de Python cuando el generador sea recolectado.

Si necesitas ejecutar código de limpieza cuando se produce un @ref{1407,,GeneratorExit}, te sugiero que utilices un conjunto @code{try: ... finally:} en lugar de atrapar @ref{1407,,GeneratorExit}.
@end itemize

El efecto acumulativo de estos cambios es que los generadores pasan de ser productores unidireccionales de información a ser tanto productores como consumidores.

Los generadores también se convierten en `corutinas', una forma más generalizada de subrutinas. Las subrutinas se introducen en un punto y se salen en otro (la parte superior de la función, y una declaración @ref{a60,,return}), pero las coroutines pueden introducirse, salirse y reanudarse en muchos puntos diferentes (las declaraciones @ref{a5f,,yield}). Tendremos que descubrir patrones para usar coroutines de forma efectiva en Python.

La adición del método @code{close()} tiene un efecto secundario que no es obvio. @code{close()} es llamado cuando un generador es recogido por la basura, lo que significa que el código del generador tiene una última oportunidad de ejecutarse antes de que el generador sea destruido. Esta última oportunidad significa que ahora se puede garantizar que las sentencias @code{intentar...finalmente} en los generadores funcionen; la cláusula @ref{a5c,,finally} ahora siempre tendrá una oportunidad de ejecutarse.  Por lo tanto, se ha eliminado la restricción sintáctica que impedía mezclar sentencias @ref{a5f,,yield} con un conjunto @code{try...finally}.  Esto parece una trivialidad menor del lenguaje, pero el uso de generadores y @code{try...finally} es realmente necesario para implementar la sentencia @ref{673,,with} descrita por 
@geindex Python Enhancement Proposals; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.  Veré esta nueva sentencia en la siguiente sección.

Otro efecto aún más esotérico de este cambio: antes, el atributo @code{gi_frame} de un generador era siempre un objeto frame. Ahora es posible que @code{gi_frame} sea @code{None} una vez que el generador se ha agotado.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - Coroutines mediante generadores mejorados

PEP escrito por Guido van Rossum y Phillip J. Eby; implementado por Phillip J. Eby.  Incluye ejemplos de algunos usos más sofisticados de los generadores como coroutines.

Versiones anteriores de estas características fueron propuestas en 
@geindex Python Enhancement Proposals; PEP 288
PEP 288@footnote{https://peps.python.org/pep-0288/} por Raymond Hettinger y 
@geindex Python Enhancement Proposals; PEP 325
PEP 325@footnote{https://peps.python.org/pep-0325/} por Samuele Pedroni.

@item @indicateurl{https://en.wikipedia.org/wiki/Coroutine}

La entrada de Wikipedia para las coroutines.

@item @indicateurl{https://web.archive.org/web/20160321211320/http://www.sidhe.org/~dan/blog/archives/000178.html}

Una explicación de las coroutines desde el punto de vista de Perl, escrita por Dan Sugalski.
@end table


@c ======================================================================

@node PEP 343 La declaración «con,PEP 352 Las excepciones como clases de nuevo estilo,PEP 342 Nuevas funciones del generador,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-343}@anchor{1442}@anchor{whatsnew/2 5 pep-343-the-with-statement}@anchor{1450}
@subsection PEP 343: La declaración «con


La sentencia “@ref{673,,with}” aclara el código que antes utilizaba bloques @code{try...finally}” para asegurar que se ejecuta el código de limpieza.  En esta sección, hablaré de la sentencia tal y como se utiliza habitualmente.  En la siguiente sección, examinaré los detalles de la implementación y mostraré cómo escribir objetos para usar con esta sentencia.

La declaración “@ref{673,,with}” es una nueva estructura de flujo de control cuya estructura básica es:

@example
with expression [as variable]:
    with-block
@end example

The expression is evaluated, and it should result in an object that supports the
context management protocol (that is, has @ref{669,,__enter__()} and @ref{1367,,__exit__()}
methods.

The object’s @ref{669,,__enter__()} is called before `with-block' is executed and
therefore can run set-up code. It also may return a value that is bound to the
name `variable', if given.  (Note carefully that `variable' is `not' assigned
the result of `expression'.)

After execution of the `with-block' is finished, the object’s @ref{1367,,__exit__()}
method is called, even if the block raised an exception, and can therefore run
clean-up code.

Para habilitar la declaración en Python 2.5, debe añadir la siguiente directiva a su módulo:

@example
from __future__ import with_statement
@end example

La declaración siempre estará habilitada en Python 2.6.

Algunos objetos estándar de Python soportan ahora el protocolo de gestión de contextos y pueden utilizarse con la sentencia “@ref{673,,with}””. Los objetos de archivo son un ejemplo:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...
@end example

Después de que esta sentencia se haya ejecutado, el objeto archivo en `f' se habrá cerrado automáticamente, incluso si el bucle @ref{1eb,,for} lanzó una excepción a mitad del bloque.

@cartouche
@quotation Nota 
In this case, `f' is the same object created by @ref{1be,,open()}, because
@ref{669,,__enter__()} returns `self'.
@end quotation
@end cartouche

Los bloqueos y las variables de condición del módulo @ref{ed,,threading} también soportan la sentencia “@ref{673,,with}”:

@example
lock = threading.Lock()
with lock:
    # Critical section of code
    ...
@end example

El bloqueo se adquiere antes de que se ejecute el bloque y siempre se libera una vez que el bloque se ha completado.

La nueva función @code{localcontext()} del módulo @ref{37,,decimal} facilita el guardado y la restauración del contexto decimal actual, que encapsula las características de precisión y redondeo deseadas para los cálculos:

@example
from decimal import Decimal, Context, localcontext

# Displays with default precision of 28 digits
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # All code in this block uses a precision of 16 digits.
    # The original context is restored on exiting the block.
    print v.sqrt()
@end example

@menu
* Redacción de Gestores de Contexto:: 
* El módulo contextlib: El módulo contextlib<2>. 

@end menu

@node Redacción de Gestores de Contexto,El módulo contextlib<2>,,PEP 343 La declaración «con
@anchor{whatsnew/2 5 new-25-context-managers}@anchor{1451}@anchor{whatsnew/2 5 writing-context-managers}@anchor{1452}
@subsubsection Redacción de Gestores de Contexto


Bajo el capó, la sentencia “@ref{673,,with}” es bastante complicada. La mayoría de la gente sólo utilizará “@code{with}” en compañía de objetos existentes y no necesita conocer estos detalles, así que puedes saltarte el resto de esta sección si quieres.  Los autores de nuevos objetos necesitarán entender los detalles de la implementación subyacente y deberían seguir leyendo.

Una explicación de alto nivel del protocolo de gestión del contexto es:


@itemize *

@item 
The expression is evaluated and should result in an object called a «context
manager».  The context manager must have @ref{669,,__enter__()} and @ref{1367,,__exit__()}
methods.

@item 
The context manager’s @ref{669,,__enter__()} method is called.  The value returned
is assigned to `VAR'.  If no @code{'as VAR'} clause is present, the value is simply
discarded.

@item 
Se ejecuta el código en `BLOQUE'.

@item 
Si `BLOCK' lanza una excepción, se llama a @code{__exit__(type, value, traceback)} con los detalles de la excepción, los mismos valores devueltos por @ref{72b,,sys.exc_info()}.  El valor de retorno del método controla si la excepción se vuelve a lanzar: cualquier valor falso vuelve a lanzar la excepción, y @code{True} resultará en suprimirla.  Sólo en raras ocasiones querrá suprimir la excepción, porque si lo hace el autor del código que contiene la declaración “@ref{673,,with}” nunca se dará cuenta de que algo ha ido mal.

@item 
If `BLOCK' didn’t raise an exception,  the @ref{1367,,__exit__()} method is still
called, but `type', `value', and `traceback' are all @code{None}.
@end itemize

Pensemos en un ejemplo.  No presentaré un código detallado, sino que sólo esbozaré los métodos necesarios para una base de datos que soporte transacciones.

(Para quienes no estén familiarizados con la terminología de las bases de datos: un conjunto de cambios en la base de datos se agrupa en una transacción.  Las transacciones pueden ser confirmadas, lo que significa que todos los cambios se escriben en la base de datos, o revertidas, lo que significa que todos los cambios se descartan y la base de datos no se modifica.  Consulte cualquier libro de texto sobre bases de datos para obtener más información)

Supongamos que hay un objeto que representa una conexión a la base de datos. Nuestro objetivo será permitir que el usuario escriba código como este:

@example
db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... more operations ...
@end example

La transacción debe ser confirmada si el código en el bloque se ejecuta sin problemas o revertida si hay una excepción. Aquí está la interfaz básica para @code{DatabaseConnection} que voy a asumir:

@example
class DatabaseConnection:
    # Database interface
    def cursor (self):
        "Returns a cursor object and starts a new transaction"
    def commit (self):
        "Commits current transaction"
    def rollback (self):
        "Rolls back current transaction"
@end example

The @ref{669,,__enter__()} method is pretty easy, having only to start a new
transaction.  For this application the resulting cursor object would be a useful
result, so the method will return it.  The user can then add @code{as cursor} to
their “@ref{673,,with}” statement to bind the cursor to a variable name.

@example
class DatabaseConnection:
    ...
    def __enter__ (self):
        # Code to start a new transaction
        cursor = self.cursor()
        return cursor
@end example

The @ref{1367,,__exit__()} method is the most complicated because it’s where most of
the work has to be done.  The method has to check if an exception occurred.  If
there was no exception, the transaction is committed.  The transaction is rolled
back if there was an exception.

En el código de abajo, la ejecución simplemente caerá al final de la función, devolviendo el valor por defecto de @code{None}.  @code{None} es falso, por lo que la excepción se volverá a lanzar automáticamente.  Si lo desea, puede ser más explícito y añadir una declaración @ref{a60,,return} en el lugar marcado.

@example
class DatabaseConnection:
    ...
    def __exit__ (self, type, value, tb):
        if tb is None:
            # No exception, so commit
            self.commit()
        else:
            # Exception occurred, so rollback.
            self.rollback()
            # return False
@end example

@node El módulo contextlib<2>,,Redacción de Gestores de Contexto,PEP 343 La declaración «con
@anchor{whatsnew/2 5 contextlibmod}@anchor{1453}@anchor{whatsnew/2 5 the-contextlib-module}@anchor{1454}
@subsubsection El módulo contextlib


El nuevo módulo @ref{24,,contextlib} proporciona algunas funciones y un decorador que son útiles para escribir objetos para usar con la sentencia “@ref{673,,with}”.

The decorator is called @code{contextmanager()}, and lets you write a single
generator function instead of defining a new class.  The generator should yield
exactly one value.  The code up to the @ref{a5f,,yield} will be executed as the
@ref{669,,__enter__()} method, and the value yielded will be the method’s return
value that will get bound to the variable in the “@ref{673,,with}” statement’s
@code{as} clause, if any.  The code after the @ref{a5f,,yield} will be
executed in the @ref{1367,,__exit__()} method.  Any exception raised in the block will
be raised by the @code{yield} statement.

Nuestro ejemplo de base de datos de la sección anterior podría escribirse utilizando este decorador como:

@example
from contextlib import contextmanager

@@contextmanager
def db_transaction (connection):
    cursor = connection.cursor()
    try:
        yield cursor
    except:
        connection.rollback()
        raise
    else:
        connection.commit()

db = DatabaseConnection()
with db_transaction(db) as cursor:
    ...
@end example

El módulo @ref{24,,contextlib} también tiene una función @code{anidada(mgr1, mgr2, ...)} que combina varios gestores de contexto para que no sea necesario escribir sentencias “@ref{673,,with}” anidadas.  En este ejemplo, la única sentencia “@code{with`} inicia una transacción de base de datos y adquiere un bloqueo de hilo:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

Por último, la función @code{closing(object)} devuelve el `objeto' para que pueda ser vinculado a una variable, y llama a @code{object.close} al final del bloque.

@example
import urllib, sys
from contextlib import closing

with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    for line in f:
        sys.stdout.write(line)
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - La declaración «con»

PEP escrito por Guido van Rossum y Nick Coghlan; implementado por Mike Bland, Guido van Rossum y Neal Norwitz.  El PEP muestra el código generado para una sentencia “@ref{673,,with}”, que puede ser útil para aprender cómo funciona la sentencia.
@end table

La documentación del módulo @ref{24,,contextlib}.


@c ======================================================================

@node PEP 352 Las excepciones como clases de nuevo estilo,PEP 353 Uso de ssize_t como tipo de índice,PEP 343 La declaración «con,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-352}@anchor{1455}@anchor{whatsnew/2 5 pep-352-exceptions-as-new-style-classes}@anchor{1456}
@subsection PEP 352: Las excepciones como clases de nuevo estilo


Las clases de excepción ahora pueden ser clases de nuevo estilo, no sólo clases clásicas, y la clase incorporada @ref{a6b,,Exception} y todas las excepciones incorporadas estándar (@ref{4ec,,NameError}, @ref{360,,ValueError}, etc.) son ahora clases de nuevo estilo.

La jerarquía de herencia de las excepciones se ha reordenado un poco. En 2.5, las relaciones de herencia son:

@example
BaseException       # New in Python 2.5
|- KeyboardInterrupt
|- SystemExit
|- Exception
   |- (all other current built-in exceptions)
@end example

Esta reorganización se hizo porque la gente a menudo quiere atrapar todas las excepciones que indican errores del programa. @ref{a63,,KeyboardInterrupt} y @ref{dc7,,SystemExit} no son errores, sin embargo, y por lo general representan una acción explícita como el usuario pulsando @code{Control-C} o el código llamando a @ref{13b0,,sys.exit()}.  Una simple @code{except:} atrapará todas las excepciones, por lo que comúnmente se necesita listar @ref{a63,,KeyboardInterrupt} y @ref{dc7,,SystemExit} para volver a lanzarlas.  El patrón habitual es:

@example
try:
    ...
except (KeyboardInterrupt, SystemExit):
    raise
except:
    # Log error...
    # Continue running program...
@end example

En Python 2.5, ahora puedes escribir @code{except Exception} para conseguir el mismo resultado, capturando todas las excepciones que suelen indicar errores pero dejando @ref{a63,,KeyboardInterrupt} y @ref{dc7,,SystemExit} en paz.  Como en versiones anteriores, un @code{except:} desnudo sigue capturando todas las excepciones.

El objetivo de Python 3.0 es requerir que cualquier clase lanzada como excepción derive de @ref{65c,,BaseException} o de algún descendiente de @ref{65c,,BaseException}, y las futuras versiones de la serie Python 2.x pueden empezar a imponer esta restricción. Por lo tanto, sugiero que empieces a hacer que todas tus clases de excepción deriven de @ref{a6b,,Exception} ahora.  Se ha sugerido que la forma desnuda @code{except:} sea eliminada en Python 3.0, pero Guido van Rossum no ha decidido si hacerlo o no.

El lanzamiento de cadenas como excepciones, como en la declaración @code{raise "Error occurred"}, está obsoleto en Python 2.5 y provocará una advertencia.  El objetivo es poder eliminar la función de excepción de cadena en algunas versiones.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 352

@item PEP 352@footnote{https://peps.python.org/pep-0352/} - Superclase necesaria para las excepciones

PEP escrito por Brett Cannon y Guido van Rossum; implementado por Brett Cannon.
@end table


@c ======================================================================

@node PEP 353 Uso de ssize_t como tipo de índice,PEP 357 El método “__index__”,PEP 352 Las excepciones como clases de nuevo estilo,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-353}@anchor{1457}@anchor{whatsnew/2 5 pep-353-using-ssize-t-as-the-index-type}@anchor{1458}
@subsection PEP 353: Uso de ssize_t como tipo de índice


Un cambio de gran alcance en la API C de Python, que usa una nueva definición de tipo @ref{af0,,Py_ssize_t} en lugar de int, permitirá que el intérprete maneje más datos en plataformas de 64 bits. Este cambio no afecta la capacidad de Python en plataformas de 32 bits.

Varias piezas del intérprete de Python usaban el tipo int de C para almacenar tamaños o conteos; por ejemplo, la cantidad de elementos en una lista o tupla se almacenaron en un int. Los compiladores de C para la mayoría de las plataformas de 64 bits aún definen int como un tipo de 32 bits, lo que significa que las listas solo pueden contener hasta @code{2**31 - 1} = 2147483647 elementos. (En realidad, hay algunos modelos de programación diferentes que los compiladores de C de 64 bits pueden usar; consulte @indicateurl{https://unix.org/version2/whatsnew/lp64_wp.html} para ver una discusión, pero el modelo más comúnmente disponible deja int como 32 bits).

Un límite de 2147483647 elementos no importa realmente en una plataforma de 32 bits porque te quedarás sin memoria antes de alcanzar el límite de longitud. Cada elemento de la lista requiere espacio para un puntero, que es de 4 bytes, más espacio para un @ref{42d,,PyObject} que representa el elemento.  2147483647*4 ya son más bytes de los que puede contener un espacio de direcciones de 32 bits.

Sin embargo, es posible abordar esa cantidad de memoria en una plataforma de 64 bits. Los punteros para una lista de ese tamaño solo requerirían 16 GiB de espacio, por lo que no es irrazonable que los programadores de Python puedan construir listas tan grandes. Por lo tanto, el intérprete de Python tuvo que cambiarse para usar algún tipo diferente a int, y este será un tipo de 64 bits en plataformas de 64 bits. El cambio provocará incompatibilidades en las máquinas de 64 bits, por lo que se consideró que valía la pena hacer la transición ahora, mientras que la cantidad de usuarios de 64 bits aún es relativamente pequeña. (En 5 o 10 años, es posible que `todo' esté en máquinas de 64 bits y la transición sería más dolorosa entonces).

Este cambio afecta en mayor medida a los autores de módulos de extensión de C.   Las cadenas de Python y los tipos contenedores como las listas y las tuplas utilizan ahora @ref{af0,,Py_ssize_t} para almacenar su tamaño.   Funciones como @ref{1459,,PyList_Size()} ahora devuelven @ref{af0,,Py_ssize_t}.  Por lo tanto, el código de los módulos de extensión puede necesitar cambiar algunas variables a @ref{af0,,Py_ssize_t}.

Las funciones @ref{615,,PyArg_ParseTuple()} y @ref{940,,Py_BuildValue()} tienen un nuevo código de conversión, @code{n}, para @ref{af0,,Py_ssize_t}. @code{s#} y @code{t#} de @ref{615,,PyArg_ParseTuple()} aún generan int de forma predeterminada, pero puede definir la macro @code{PY_SSIZE_T_CLEAN} antes de incluir @code{Python.h} para que devuelvan @ref{af0,,Py_ssize_t}.

@geindex Python Enhancement Proposals; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} tiene una sección sobre directrices de conversión que los autores de extensiones deberían leer para aprender a soportar plataformas de 64 bits.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 353

@item PEP 353@footnote{https://peps.python.org/pep-0353/} - Uso de ssize_t como tipo de índice

PEP escrito y aplicado por Martin von Löwis.
@end table


@c ======================================================================

@node PEP 357 El método “__index__”,Otros cambios lingüísticos<2>,PEP 353 Uso de ssize_t como tipo de índice,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 pep-357}@anchor{145a}@anchor{whatsnew/2 5 pep-357-the-index-method}@anchor{145b}
@subsection PEP 357: El método “__index__”


Los desarrolladores de NumPy tenían un problema que sólo podía resolverse añadiendo un nuevo método especial, @code{__index__()}.  Cuando se utiliza la notación de trozos, como en @code{[start:stop:step]}, los valores de los índices `start', `stop' y `step' deben ser todos enteros o enteros largos.  NumPy define una variedad de tipos de enteros especializados que corresponden a enteros sin signo y con signo de 8, 16, 32 y 64 bits, pero no había forma de señalar que estos tipos pudieran usarse como índices de trozos.

El rebanado no puede utilizar el método @code{__int__()} existente porque ese método también se utiliza para implementar la coerción a enteros.  Si el rebanado utilizara @code{__int__()}, los números de punto flotante también se convertirían en índices de rebanada legales y eso es claramente un comportamiento indeseable.

En su lugar, se ha añadido un nuevo método especial llamado @code{__index__()}.  No toma argumentos y devuelve un entero que da el índice de corte a utilizar.  Por ejemplo:

@example
class C:
    def __index__ (self):
        return self.value
@end example

El valor devuelto debe ser un entero de Python o un entero largo. El intérprete comprobará que el tipo devuelto es correcto, y lanza un @ref{228,,TypeError} si no se cumple este requisito.

Se agregó una ranura @ref{145c,,nb_index} correspondiente a la estructura @ref{145d,,PyNumberMethods} de nivel C para permitir que las extensiones C implementen este protocolo. @code{PyNumber_Index(obj)} se puede utilizar en código de extensión para llamar a la función @code{__index__()} y recuperar su resultado.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 357

@item PEP 357@footnote{https://peps.python.org/pep-0357/} - Permitir el uso de cualquier objeto para rebanar

PEP escrito e implementado por Travis Oliphant.
@end table


@c ======================================================================

@node Otros cambios lingüísticos<2>,Módulos nuevos mejorados y eliminados,PEP 357 El método “__index__”,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 other-lang}@anchor{145e}@anchor{whatsnew/2 5 other-language-changes}@anchor{145f}
@subsection Otros cambios lingüísticos


Estos son todos los cambios que Python 2.5 introduce en el núcleo del lenguaje Python.


@itemize *

@item 
El tipo @ref{190,,dict} tiene un nuevo gancho para permitir que las subclases proporcionen un valor por defecto cuando una clave no está contenida en el diccionario. Cuando no se encuentre una clave, se llamará al método @code{missing__(key)} del diccionario.  Este hook se utiliza para implementar la nueva clase @code{defaultdict} en el módulo @ref{1e,,collections}.  El siguiente ejemplo define un diccionario que devuelve cero para cualquier clave que falte:

@example
class zerodict (dict):
    def __missing__ (self, key):
        return 0

d = zerodict(@{1:1, 2:2@})
print d[1], d[2]   # Prints 1, 2
print d[3], d[4]   # Prints 0, 0
@end example

@item 
Tanto las cadenas de 8 bits como las de Unicode tienen nuevos métodos @code{partition(sep)} y @code{rpartition(sep)} que simplifican un caso de uso común.

El método @code{find(S)} se utiliza a menudo para obtener un índice que luego se utiliza para cortar la cadena y obtener las piezas que están antes y después del separador. El método @code{partition(sep)} condensa este patrón en una sola llamada al método que devuelve una tripleta que contiene la subcadena antes del separador, el propio separador y la subcadena después del separador.  Si no se encuentra el separador, el primer elemento de la tupla es la cadena completa y los otros dos elementos están vacíos.  @code{rpartition(sep)} también devuelve una tupla de 3 elementos, pero empieza a buscar desde el final de la cadena; la @code{r} significa «al revés».

Algunos ejemplos:

@example
>>> ('http://www.python.org').partition('://')
('http', '://', 'www.python.org')
>>> ('file:/usr/share/doc/index.html').partition('://')
('file:/usr/share/doc/index.html', '@w{'}, '@w{'})
>>> (u'Subject: a quick question').partition(':')
(u'Subject', u':', u' a quick question')
>>> 'www.python.org'.rpartition('.')
('www.python', '.', 'org')
>>> 'www.python.org'.rpartition(':')
('@w{'}, '@w{'}, 'www.python.org')
@end example

(Implementado por Fredrik Lundh tras una sugerencia de Raymond Hettinger)

@item 
Los métodos @code{startswith()} y @code{endswith()} de los tipos de cadena aceptan ahora tuplas de cadenas para su comprobación.

@example
def is_image_file (filename):
    return filename.endswith(('.gif', '.jpg', '.tiff'))
@end example

(Implementado por Georg Brandl tras una sugerencia de Tom Lynn)

@c RFE #1491485

@item 
Las funciones incorporadas @ref{f8b,,min()} y @ref{f8c,,max()} han ganado un parámetro de palabra clave @code{key} análogo al argumento @code{key} de @code{sort()}.  Este parámetro proporciona una función que toma un único argumento y es llamada para cada valor de la lista; @ref{f8b,,min()}/@ref{f8c,,max()} devolverá el elemento con el valor de retorno más pequeño/más grande de esta función. Por ejemplo, para encontrar la cadena más larga de una lista, puede hacer:

@example
L = ['medium', 'longest', 'short']
# Prints 'longest'
print max(L, key=len)
# Prints 'short', because lexicographically 'short' has the largest value
print max(L)
@end example

(Contribución de Steven Bethard y Raymond Hettinger)

@item 
Dos nuevas funciones incorporadas, @ref{1460,,any()} y @ref{1461,,all()}, evalúan si un iterador contiene algún valor verdadero o falso. @ref{1460,,any()} devuelve @ref{c95,,True} si cualquier valor devuelto por el iterador es verdadero; en caso contrario devolverá @ref{bbf,,False}. @ref{1461,,all()} devuelve @ref{c95,,True} sólo si todos los valores devueltos por el iterador se evalúan como verdaderos. (Sugerido por Guido van Rossum, e implementado por Raymond Hettinger)

@item 
El resultado del método @code{__hash__()} de una clase puede ser ahora un entero largo o un entero normal.  Si se devuelve un entero largo, se toma el hash de ese valor.  En versiones anteriores se requería que el valor del hash fuera un entero regular, pero en 2.5 el built-in @ref{1462,,id()} se cambió para devolver siempre números no negativos, y los usuarios parecen utilizar a menudo @code{id(self)} en los métodos @code{__hash__()} (aunque esto se desaconseja).

@c Bug #1536021

@item 
ASCII es ahora la codificación por defecto para los módulos.  Ahora es un error de sintaxis si un módulo contiene literales de cadena con caracteres de 8 bits pero no tiene una declaración de codificación.  En Python 2.4 esto provocaba una advertencia, no un error de sintaxis.  Vea en 
@geindex Python Enhancement Proposals; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} cómo declarar la codificación de un módulo; por ejemplo, puede añadir una línea como ésta cerca de la parte superior del fichero fuente:

@example
# -*- coding: latin1 -*-
@end example

@item 
Una nueva advertencia, @ref{1463,,UnicodeWarning}, se activa cuando se intenta comparar una cadena Unicode y una cadena de 8 bits que no se puede convertir a Unicode utilizando la codificación ASCII por defecto.   El resultado de la comparación es falso:

@example
>>> chr(128) == unichr(128)   # Can't convert chr(128) to Unicode
__main__:1: UnicodeWarning: Unicode equal comparison failed
  to convert both arguments to Unicode - interpreting them
  as being unequal
False
>>> chr(127) == unichr(127)   # chr(127) can be converted
True
@end example

Anteriormente, esto lanzaba una excepción @ref{aa5,,UnicodeDecodeError}, pero en 2.5 esto podía dar lugar a problemas desconcertantes al acceder a un diccionario.  Si se buscaba @code{unichr(128)} y se utilizaba @code{chr(128)} como clave, se producía una excepción @ref{aa5,,UnicodeDecodeError}.  Otros cambios en la versión 2.5 hicieron que esta excepción se lanzara en lugar de ser suprimida por el código de @code{dictobject.c} que implementa los diccionarios.

Lanzar una excepción para tal comparación es estrictamente correcto, pero el cambio podría haber roto el código, así que en su lugar se introdujo @ref{1463,,UnicodeWarning}.

(Implementado por Marc-André Lemburg.)

@item 
Un error que a veces cometen los programadores de Python es olvidarse de incluir un módulo @code{__init__.py} en el directorio de un paquete. Depurar este error puede ser confuso, y normalmente requiere ejecutar Python con el modificador @ref{1464,,-v} para registrar todas las rutas buscadas. En Python 2.5, una nueva advertencia @ref{59f,,ImportWarning} se activa cuando una importación habría recogido un directorio como paquete pero no se encontró ningún @code{__init__.py}.  Esta advertencia se ignora silenciosamente por defecto; proporcione la opción @ref{95e,,-Wd} cuando ejecute el ejecutable de Python para mostrar el mensaje de advertencia. (Implementado por Thomas Wouters)</-W>

@item 
La lista de clases base en una definición de clase ahora puede estar vacía.   Como ejemplo, esto es ahora legal:

@example
class C():
    pass
@end example

(Implementado por Brett Cannon.)
@end itemize

@c ======================================================================

@menu
* Cambios en el intérprete interactivo:: 
* Optimizaciones: Optimizaciones<13>. 

@end menu

@node Cambios en el intérprete interactivo,Optimizaciones<13>,,Otros cambios lingüísticos<2>
@anchor{whatsnew/2 5 interactive}@anchor{1465}@anchor{whatsnew/2 5 interactive-interpreter-changes}@anchor{1466}
@subsubsection Cambios en el intérprete interactivo


En el intérprete interactivo, @code{quit} y @code{exit} han sido durante mucho tiempo cadenas para que los nuevos usuarios obtengan un mensaje algo útil cuando intenten salir:

@example
>>> quit
'Use Ctrl-D (i.e. EOF) to exit.'
@end example

En Python 2.5, @code{quit} y @code{exit} son ahora objetos que siguen produciendo representaciones de cadena de sí mismos, pero también son invocables. Los novatos que prueben @code{quit()} o @code{exit()} ahora saldrán del intérprete como se espera.  (Implementado por Georg Brandl.)

El ejecutable de Python ahora acepta las opciones largas estándar @ref{690,,--help} y @ref{da2,,--version}; en Windows, también acepta la opción @ref{1467,,/?} para mostrar un mensaje de ayuda. (Implementado por Georg Brandl)

@c ======================================================================

@node Optimizaciones<13>,,Cambios en el intérprete interactivo,Otros cambios lingüísticos<2>
@anchor{whatsnew/2 5 optimizations}@anchor{1468}@anchor{whatsnew/2 5 opts}@anchor{1469}
@subsubsection Optimizaciones


Varias de las optimizaciones se desarrollaron en el sprint NeedForSpeed, un evento celebrado en Reikiavik, Islandia, del 21 al 28 de mayo de 2006. El sprint se centró en las mejoras de velocidad de la implementación de CPython y fue financiado por EWT LLC con el apoyo local de CCP Games.  Las optimizaciones añadidas en este sprint están especialmente marcadas en la siguiente lista.


@itemize *

@item 
Cuando se introdujeron en Python 2.4, los tipos incorporados @ref{67a,,set} y @ref{67b,,frozenset} se construyeron sobre el tipo diccionario de Python.   En 2.5 la estructura de datos interna se ha personalizado para implementar conjuntos, y como resultado los conjuntos utilizarán un tercio menos de memoria y son algo más rápidos. (Implementado por Raymond Hettinger)

@item 
Se ha mejorado la velocidad de algunas operaciones Unicode, como la búsqueda de subcadenas, la división de cadenas y la codificación y decodificación de mapas de caracteres. (Las mejoras en la búsqueda de subcadenas y la división fueron añadidas por Fredrik Lundh y Andrew Dalke en el sprint NeedForSpeed. Los mapas de caracteres fueron mejorados por Walter Dörwald y Martin von Löwis)

@c Patch 1313939, 1359618

@item 
La función @code{long(str, base)} es ahora más rápida en cadenas de dígitos largos porque se calculan menos resultados intermedios.  El máximo es para cadenas de alrededor de 800-1000 dígitos, donde la función es 6 veces más rápida. (Aportado por Alan McIntyre y comprometido en el sprint NeedForSpeed)

@c Patch 1442927

@item 
It’s now illegal to mix iterating over a file  with @code{for line in file} and
calling  the file object’s @code{read()}/@ref{ba,,readline()}/@code{readlines()}
methods.  Iteration uses an internal buffer and the  @code{read*()} methods
don’t use that buffer.   Instead they would return the data following the
buffer, causing the data to appear out of order.  Mixing iteration and these
methods will now trigger a @ref{360,,ValueError} from the @code{read*()} method.
(Implemented by Thomas Wouters.)

@c Patch 1397960

@item 
El módulo @ref{d5,,struct} ahora compila cadenas de formato de estructura en una representación interna y almacena en caché esta representación, lo que supone una mejora del 20% s. (Contribuido por Bob Ippolito en el sprint NeedForSpeed)

@item 
El módulo @ref{b9,,re} obtuvo un 1 o 2% s de velocidad al cambiar a las funciones asignadoras de Python en lugar de las @code{malloc()} y @code{free()} del sistema. (Contribuido por Jack Diederich en el sprint NeedForSpeed)

@item 
El optimizador de la mirilla del generador de código realiza ahora un simple plegado de constantes en las expresiones.  Si escribes algo como @code{a = 2+3}, el generador de código hará la aritmética y producirá el código correspondiente a @code{a = 5}.  (Propuesto e implementado por Raymond Hettinger)

@item 
Las llamadas a funciones son ahora más rápidas porque los objetos de código guardan ahora el último fotograma terminado (un «fotograma zombi») en un campo interno del objeto de código, reutilizándolo la próxima vez que se invoque el objeto de código.  (Parche original de Michael Hudson, modificado por Armin Rigo y Richard Jones; confirmado en el sprint NeedForSpeed)  Los objetos marco son también ligeramente más pequeños, lo que puede mejorar la localidad de la caché y reducir un poco el uso de la memoria.  (Contribución de Neal Norwitz)

@c Patch 876206

@c Patch 1337051

@item 
Las excepciones incorporadas en Python son ahora clases de nuevo estilo, un cambio que acelera considerablemente la instanciación.  El manejo de excepciones en Python 2.5 es, por tanto, un 30% f más rápido que en 2.4. (Contribución de Richard Jones, Georg Brandl y Sean Reifschneider en el sprint NeedForSpeed)

@item 
La importación ahora almacena en caché las rutas intentadas, registrando si existen o no para que el intérprete haga menos llamadas a @code{open()} y @code{stat()} al iniciar. (Contribución de Martin von Löwis y Georg Brandl)

@c Patch 921466
@end itemize

@c ======================================================================

@node Módulos nuevos mejorados y eliminados,Cambios en la API de construcción y C<4>,Otros cambios lingüísticos<2>,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 modules}@anchor{146a}@anchor{whatsnew/2 5 new-improved-and-removed-modules}@anchor{146b}
@subsection Módulos nuevos, mejorados y eliminados


La biblioteca estándar ha recibido muchas mejoras y correcciones de errores en Python 2.5. Aquí hay una lista parcial de los cambios más notables, ordenados alfabéticamente por el nombre del módulo. Consulte el archivo @code{Misc/NEWS} en el árbol de fuentes para obtener una lista más completa de los cambios, o busque en los registros de SVN para obtener todos los detalles.


@itemize *

@item 
The @code{audioop} module now supports the a-LAW encoding, and the code for
u-LAW encoding has been improved.  (Contributed by Lars Immisch.)

@item 
El módulo @ref{1c,,codecs} ha ganado soporte para códecs incrementales.  La función @code{codec.lookup()} devuelve ahora una instancia de @code{CodecInfo} en lugar de una tupla. Las instancias de @code{CodecInfo} se comportan como una cuádruple tupla para preservar la compatibilidad con versiones anteriores, pero también tienen los atributos @code{encode}, @code{decode}, @code{incrementalencoder}, @code{incrementaldecoder}, @code{streamwriter} y @code{streamreader}.  Los códecs incrementales pueden recibir la entrada y producir la salida en varios trozos; la salida es la misma que si la entrada completa fuera alimentada por el códec no incremental. Consulte la documentación del módulo @ref{1c,,codecs} para más detalles. (Diseñado e implementado por Walter Dörwald)

@c Patch  1436130

@item 
El módulo @ref{1e,,collections} ha ganado un nuevo tipo, @code{defaultdict}, que subclasifica el tipo estándar @ref{190,,dict}.  El nuevo tipo se comporta principalmente como un diccionario pero construye un valor por defecto cuando una clave no está presente, añadiéndolo automáticamente al diccionario para el valor de la clave solicitada.

El primer argumento del constructor de @code{defaultdict} es una función de fábrica que se llama cada vez que se solicita una clave pero no se encuentra. Esta función de fábrica no recibe argumentos, por lo que puede utilizar constructores de tipo incorporado como @ref{18e,,list()} o @ref{1f0,,int()}.  Por ejemplo, puedes hacer un índice de palabras basado en su letra inicial así:

@example
words = """Nel mezzo del cammin di nostra vita
mi ritrovai per una selva oscura
che la diritta via era smarrita""".lower().split()

index = defaultdict(list)

for w in words:
    init_letter = w[0]
    index[init_letter].append(w)
@end example

Al imprimir @code{index} se obtiene la siguiente salida:

@example
defaultdict(<type 'list'>, @{'c': ['cammin', 'che'], 'e': ['era'],
        'd': ['del', 'di', 'diritta'], 'm': ['mezzo', 'mi'],
        'l': ['la'], 'o': ['oscura'], 'n': ['nel', 'nostra'],
        'p': ['per'], 's': ['selva', 'smarrita'],
        'r': ['ritrovai'], 'u': ['una'], 'v': ['vita', 'via']@}
@end example

(Contribución de Guido van Rossum.)

@item 
El tipo de cola doble @code{deque} suministrado por el módulo @ref{1e,,collections} tiene ahora un método @code{remove(value)} que elimina la primera aparición de `value' en la cola, lanzando @ref{360,,ValueError} si no se encuentra el valor. (Contribución de Raymond Hettinger)

@item 
Nuevo módulo: El módulo @ref{24,,contextlib} contiene funciones de ayuda para usar con la nueva sentencia “@ref{673,,with}”.  Consulte la sección @ref{1453,,El módulo contextlib} para obtener más información sobre este módulo.

@item 
Nuevo módulo: El módulo @ref{28,,cProfile} es una implementación en C del módulo existente @ref{af,,profile} que tiene una sobrecarga mucho menor. La interfaz del módulo es la misma que la de @ref{af,,profile}: se ejecuta @code{cProfile.run('main()')} para perfilar una función, se pueden guardar los datos del perfil en un archivo, etc.  Todavía no se sabe si el perfilador Hotshot, que también está escrito en C pero no coincide con la interfaz del módulo @ref{af,,profile}, seguirá manteniéndose en futuras versiones de Python.  (Contribución de Armin Rigo.)

Además, el módulo @ref{b0,,pstats} para analizar los datos medidos por el perfilador ahora soporta dirigir la salida a cualquier objeto archivo suministrando un argumento `stream' al constructor @code{Stats}. (Contribución de Skip Montanaro)

@item 
El módulo @ref{2a,,csv}, que analiza archivos en formato de valores separados por comas, recibió varias mejoras y varias correcciones de errores. Ahora puede establecer el tamaño máximo en bytes de un campo llamando a la función @code{csv.field_size_limit(new_limit)}; omitir el argumento `new_limit' devolverá el límite establecido actualmente. La clase @code{reader} ahora tiene un atributo @code{line_num} que cuenta la cantidad de líneas físicas leídas de la fuente; los registros pueden abarcar varias líneas físicas, por lo que @code{line_num} no es lo mismo que el número de registros leídos.

El analizador CSV es ahora más estricto con los campos entrecomillados de varias líneas. Anteriormente, si una línea terminaba dentro de un campo entre comillas sin un carácter de nueva línea final, se insertaba una nueva línea en el campo devuelto. Este comportamiento causaba problemas cuando se leían archivos que contenían caracteres de retorno de carro dentro de los campos, por lo que se cambió el código para devolver el campo sin insertar nuevas líneas. Como consecuencia, si las nuevas líneas incrustadas dentro de los campos son importantes, la entrada debe dividirse en líneas de manera que se conserven los caracteres de nueva línea.

(Contribución de Skip Montanaro y Andrew McNamara)

@item 
La clase @ref{32f,,datetime} del módulo @ref{31,,datetime} tiene ahora un método @code{strptime(string, format)} para analizar cadenas de fechas, aportado por Josh Spoerri. Utiliza los mismos caracteres de formato que @ref{146c,,time.strptime()} y @ref{1256,,time.strftime()}:

@example
from datetime import datetime

ts = datetime.strptime('10:13:15 2006-03-07',
                       '%H:%M:%S %Y-%m-%d')
@end example

@item 
El método @code{SequenceMatcher.get_matching_blocks()} del módulo @ref{38,,difflib} garantiza ahora la devolución de una lista mínima de bloques que describen subsecuencias coincidentes.  Anteriormente, el algoritmo rompía ocasionalmente un bloque de elementos coincidentes en dos entradas de la lista. (Mejora realizada por Tim Peters)

@item 
El módulo @ref{3b,,doctest} ha ganado una opción @code{SKIP} que impide que un ejemplo se ejecute en absoluto.  Esto está pensado para los fragmentos de código que son ejemplos de uso destinados al lector y que no son realmente casos de prueba.

Se ha añadido un parámetro `encoding' a la función @code{testfile()} y a la clase @code{DocFileSuite} para especificar la codificación del archivo.  Esto facilita el uso de caracteres no ASCII en las pruebas contenidas en un docstring. (Contribución de Bjorn Tillenius)

@c Patch 1080727

@item 
El paquete @ref{3c,,email} ha sido actualizado a la versión 4.0. (Contribución de Barry Warsaw.)

@c XXX need to provide some more detail here

@geindex nuevas líneas universales;Qué hay de nuevo

@item 
The @ref{5b,,fileinput} module was made more flexible. Unicode filenames are now
supported, and a `mode' parameter that defaults to @code{"r"} was added to the
@ref{1340,,input()} function to allow opening files in binary or @ref{dc1,,universal newlines} mode.  Another new parameter, `openhook', lets you use a function
other than @ref{1be,,open()}  to open the input files.  Once you’re iterating over
the set of files, the @code{FileInput} object’s new @ref{146d,,fileno()} returns
the file descriptor for the currently opened file. (Contributed by Georg
Brandl.)

@item 
En el módulo @ref{60,,gc}, la nueva función @code{get_count()} devuelve una 3-tupla que contiene los recuentos de recolección actuales para las tres generaciones de GC.  Se trata de información contable para el recolector de basura; cuando estos recuentos alcanzan un umbral especificado, se realiza un barrido de recolección de basura.  La función @ref{acc,,gc.collect()} existente ahora toma un argumento opcional `generación' de 0, 1 o 2 para especificar qué generación recoger. (Contribución de Barry Warsaw)

@item 
Las funciones @code{nsmallest()} y @code{nlargest()} del módulo @ref{69,,heapq} soportan ahora un parámetro de palabra clave @code{key} similar al proporcionado por las funciones @ref{f8b,,min()}/@ref{f8c,,max()} y los métodos @code{sort()}.  Por ejemplo:

@example
>>> import heapq
>>> L = ["short", 'medium', 'longest', 'longer still']
>>> heapq.nsmallest(2, L)  # Return two lowest elements, lexicographically
['longer still', 'longest']
>>> heapq.nsmallest(2, L, key=len)   # Return two shortest elements
['short', 'medium']
@end example

(Contribución de Raymond Hettinger.)

@item 
La función @ref{bd4,,itertools.islice()} ahora acepta @code{None} para los argumentos de inicio y paso.  Esto la hace más compatible con los atributos de los objetos slice, por lo que ahora se puede escribir lo siguiente:

@example
s = slice(5)     # Create slice object
itertools.islice(iterable, s.start, s.stop, s.step)
@end example

(Contribución de Raymond Hettinger.)

@item 
Se ha modificado la función @ref{6c0,,format()} del módulo @ref{86,,locale} y se han añadido dos nuevas funciones, @code{format_string()} y @code{currency()}.

El parámetro `val' de la función @ref{6c0,,format()} podía ser antes una cadena siempre que no apareciera más de un especificador %char; ahora el parámetro debe ser exactamente un especificador %char sin texto alrededor.  También se ha añadido un parámetro opcional `monetario' que, si es @code{Verdadero}, utilizará las reglas de la configuración regional para formatear la moneda al colocar un separador entre grupos de tres dígitos.

Para formatear cadenas con múltiples especificadores %char, utilice la nueva función @code{format_string()} que funciona como @ref{6c0,,format()} pero que también permite mezclar especificadores %char con texto arbitrario.

También se ha añadido una nueva función @code{currency()} que formatea un número de acuerdo con la configuración local actual.

(Contribución de Georg Brandl.)

@c Patch 1180296

@item 
El módulo @ref{8b,,mailbox} ha sido reestructurado de forma masiva para añadir la capacidad de modificar los buzones además de leerlos.  Un nuevo conjunto de clases que incluyen @code{mbox}, @code{MH}, y @code{Maildir} se utilizan para leer buzones, y tienen un método @code{add(message)} para añadir mensajes, @code{remove(key)} para eliminar mensajes, y @code{lock()}/@code{unlock()} para bloquear/desbloquear el buzón. El siguiente ejemplo convierte un buzón con formato maildir en uno con formato mbox:

@example
import mailbox

# 'factory=None' uses email.Message.Message as the class representing
# individual messages.
src = mailbox.Maildir('maildir', factory=None)
dest = mailbox.mbox('/tmp/mbox')

for msg in src:
    dest.add(msg)
@end example

(Contribución de Gregory K. Johnson.  La financiación fue proporcionada por el Summer of Code 2005 de Google)

@item 
New module: the @code{msilib} module allows creating Microsoft Installer
@code{.msi} files and CAB files.  Some support for reading the @code{.msi}
database is also included. (Contributed by Martin von Löwis.)

@item 
The @code{nis} module now supports accessing domains other than the system
default domain by supplying a `domain' argument to the @code{nis.match()} and
@code{nis.maps()} functions. (Contributed by Ben Bell.)

@item 
Las funciones @ref{9f,,operator} del módulo @code{itemgetter()} y @code{attrgetter()} ahora soportan múltiples campos.   Una llamada como @code{operator.attrgetter('a', 'b')} devolverá una función que recupera los atributos @code{a} y @code{b}.  La combinación de esta nueva función con el parámetro @code{key} del método @code{sort()} permite ordenar fácilmente las listas utilizando varios campos. (Contribución de Raymond Hettinger)

@item 
El módulo @ref{a0,,optparse} se ha actualizado a la versión 1.5.1 de la biblioteca Optik. La clase @code{OptionParser} obtuvo un atributo @code{epilog}, una cadena que se imprimirá después del mensaje de ayuda, y un método @code{destroy()} para romper los ciclos de referencia creados por el objeto. (Contribuido por Greg Ward.)

@item 
El módulo @ref{a1,,os} ha sufrido varios cambios.  La variable @code{stat_float_times} ahora está predeterminada a true, lo que significa que @ref{548,,os.stat()} ahora devolverá los valores de tiempo como flotantes.  (Esto no significa necesariamente que @ref{548,,os.stat()} devolverá tiempos con una precisión de fracciones de segundo; no todos los sistemas soportan dicha precisión)

Se han añadido las constantes @ref{12fa,,os.SEEK_SET}, @ref{12fb,,os.SEEK_CUR} y @ref{12fc,,os.SEEK_END}, que son los parámetros de la función @ref{1189,,os.lseek()}.  Dos nuevas constantes para el bloqueo son @ref{146e,,os.O_SHLOCK} y @ref{146f,,os.O_EXLOCK}.

Se han añadido dos nuevas funciones, @code{wait3()} y @code{wait4()}.  Son similares a la función @code{waitpid()} que espera la salida de un proceso hijo y devuelve una tupla con el ID del proceso y su estado de salida, pero @code{wait3()} y @code{wait4()} devuelven información adicional.  @code{wait3()} no toma un ID de proceso como entrada, por lo que espera a que cualquier proceso hijo salga y devuelve una tupla de `id de proceso', `estado de salida', `uso de recursos' tal y como se devuelve desde la función @ref{1470,,resource.getrusage()}. @code{wait4(pid)} toma un ID de proceso. (Contribuido por Chad J. Schroeder.)

En FreeBSD, la función @ref{548,,os.stat()} devuelve ahora tiempos con resolución de nanosegundos, y el objeto devuelto tiene ahora @code{st_gen} y @code{st_birthtime}. El atributo @code{st_flags} también está disponible, si la plataforma lo soporta. (Contribución de Antti Louko y Diego Pettenò)

@c (Patch 1180695, 1212117)

@item 
El depurador de Python proporcionado por el módulo @ref{a5,,pdb} puede ahora almacenar listas de comandos a ejecutar cuando se alcanza un punto de ruptura y se detiene la ejecución.  Una vez creado el punto de interrupción nº 1, introduzca @code{comandos 1} e introduzca una serie de comandos a ejecutar, terminando la lista con @code{end}.  La lista de comandos puede incluir comandos que reanuden la ejecución, como @code{continue} o @code{next}. (Contribución de Grégoire Dooms.)

@c Patch 790710

@item 
The @ref{a6,,pickle} and @code{cPickle} modules no longer accept a return value
of @code{None} from the @ref{a65,,__reduce__()} method; the method must return a tuple
of arguments instead.  The ability to return @code{None} was deprecated in Python
2.4, so this completes the removal of the feature.

@item 
El módulo @ref{a9,,pkgutil}, que contiene varias funciones de utilidad para encontrar paquetes, fue mejorado para soportar los ganchos de importación de 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} y ahora también funciona para paquetes almacenados en archivos con formato ZIP. (Contribución de Phillip J. Eby)

@item 
El conjunto de pruebas pybench de Marc-André Lemburg se incluye ahora en el directorio @code{Tools/pybench}.  El conjunto de pruebas pybench es una mejora del programa @code{pystone.py} de uso común, ya que pybench proporciona una medición más detallada de la velocidad del intérprete.  Calcula el tiempo de determinadas operaciones como las llamadas a funciones, el corte de tuplas, las búsquedas de métodos y las operaciones numéricas, en lugar de realizar muchas operaciones diferentes y reducir el resultado a un único número como hace @code{pystone.py}.

@item 
El módulo @code{pyexpat} utiliza ahora la versión 2.0 del analizador sintáctico Expat. (Contribución de Trent Mick)

@item 
La clase @ref{13ee,,Queue} proporcionada por el módulo @code{Queue} ha ganado dos nuevos métodos. @code{join()} bloquea hasta que todos los elementos de la cola han sido recuperados y todo el trabajo de procesamiento de los elementos ha sido completado.  Los hilos de trabajo llaman al otro método nuevo, @code{task_done()}, para indicar que el procesamiento de un elemento ha finalizado.  (Contribución de Raymond Hettinger)

@item 
Los antiguos módulos @code{regex} y @code{regsub}, obsoletos desde Python 2.0, han sido finalmente eliminados.   Otros módulos eliminados: @code{statcache}, @code{tzparse}, @code{whrandom}.

@item 
También se ha eliminado el directorio @code{lib-old}, que incluye módulos antiguos como @code{dircmp} y @code{ni}. @code{lib-old} no estaba en el directorio por defecto @code{sys.path}, así que a menos que tus programas añadan explícitamente el directorio a @code{sys.path}, esta eliminación no debería afectar a tu código.

@item 
El módulo @ref{bd,,rlcompleter} ya no depende de la importación del módulo @ref{ba,,readline} y, por lo tanto, ahora funciona en plataformas no Unix. (Parche de Robert Kiendl.)

@c Patch #1472854

@item 
The @ref{12e,,SimpleXMLRPCServer} and @ref{12e,,DocXMLRPCServer}  classes now have a
@code{rpc_paths} attribute that constrains XML-RPC operations to a limited set
of URL paths; the default is to allow only @code{'/'} and @code{'/RPC2'}.  Setting
@code{rpc_paths} to @code{None} or an empty tuple disables  this path checking.

@c Bug #1473048

@item 
El módulo @ref{cc,,socket} ahora soporta sockets @code{AF_NETLINK} en Linux, gracias a un parche de Philippe Biondi.   Los sockets Netlink son un mecanismo específico de Linux para las comunicaciones entre un proceso en el espacio del usuario y el código del kernel; hay un artículo introductorio sobre ellos en @indicateurl{https://www.linuxjournal.com/article/7356}. En el código Python, las direcciones de netlink se representan como una tupla de 2 enteros, @code{(pid, group_mask)}.

Dos nuevos métodos en objetos socket, @code{recv_into(buffer)} y @code{recvrom_into(buffer)}, almacenan los datos recibidos en un objeto que soporta el protocolo de buffer en lugar de devolver los datos como una cadena.  Esto significa que puedes poner los datos directamente en un array o en un archivo mapeado en memoria.

Los objetos Socket también han ganado métodos de acceso @code{getfamily()}, @code{gettype()} y @code{getproto()} para recuperar los valores de familia, tipo y protocolo del socket.

@item 
New module: the @code{spwd} module provides functions for accessing the shadow
password database on systems that support  shadow passwords.

@item 
El módulo @ref{d5,,struct} es ahora más rápido porque compila cadenas de formato en objetos @code{Struct} con métodos @code{pack()} y @code{unpack()}.  Esto es similar a cómo el módulo @ref{b9,,re} permite crear objetos de expresión regular compilados.  Puede seguir utilizando las funciones @code{pack()} y @code{unpack()} a nivel de módulo; éstas crearán objetos @code{Struct} y los almacenarán en caché.  O puede utilizar directamente las instancias de @code{Struct}:

@example
s = struct.Struct('ih3s')

data = s.pack(1972, 187, 'abc')
year, number, name = s.unpack(data)
@end example

También puedes empaquetar y desempaquetar datos hacia y desde objetos buffer directamente usando los métodos @code{pack_into(buffer, offset, v1, v2, ...)} y @code{unpack_from(buffer, offset)}.  Esto te permite almacenar datos directamente en un array o en un archivo mapeado en memoria.

(@code{Struct} objects fueron implementados por Bob Ippolito en el sprint NeedForSpeed.  El soporte para los objetos buffer fue añadido por Martin Blais, también en el sprint NeedForSpeed)

@item 
Los desarrolladores de Python cambiaron de CVS a Subversion durante el proceso de desarrollo de la versión 2.5.  La información sobre la versión exacta de construcción está disponible como la variable @code{sys.subversion}, una 3-tupla de @code{(nombre del intérprete, nombre de la rama, rango de revisión)}.  Por ejemplo, en el momento de escribir esto, mi copia de 2.5 informaba de @code{('CPython', 'trunk', '45313:45315')}.

Esta información también está disponible para las extensiones de C a través de la función @ref{1471,,Py_GetBuildInfo()} que devuelve una cadena de información de compilación como esta @code{"trunk:45355:45356M, Apr 13 2006, 07:42:19"}.   (Contribuido por Barry Warsaw.)

@item 
Otra nueva función, @ref{1472,,sys._current_frames()}, devuelve los marcos de pila actuales para todos los hilos en ejecución como un diccionario que asigna los identificadores de los hilos al marco de pila superior actualmente activo en ese hilo en el momento en que se llama a la función.  (Contribuido por Tim Peters.)

@item 
La clase @code{TarFile} del módulo @ref{de,,tarfile} tiene ahora un método @code{extractall()} que extrae todos los miembros del archivo en el directorio de trabajo actual.  También es posible establecer un directorio diferente como destino de la extracción, y desempaquetar sólo un subconjunto de los miembros del archivo.

La compresión utilizada para un archivo tar abierto en modo stream puede ahora ser autodetectada utilizando el modo @code{'r|*'}. (Contribución de Lars Gustäbel)

@c patch 918101

@item 
El módulo @ref{ed,,threading} permite ahora establecer el tamaño de la pila utilizado cuando se crean nuevos hilos. La función @code{stack_size([*size*])} devuelve el tamaño de pila actualmente configurado, y suministrando el parámetro opcional `size' establece un nuevo valor.  No todas las plataformas soportan el cambio del tamaño de la pila, pero Windows, POSIX threading y OS/2 lo hacen. (Contribución de Andrew MacIntyre)

@c Patch 1454481

@item 
El módulo @ref{105,,unicodedata} ha sido actualizado para utilizar la versión 4.1.0 de la base de datos de caracteres Unicode.  La versión 3.2.0 es requerida por algunas especificaciones, por lo que sigue estando disponible como @ref{1473,,unicodedata.ucd_3_2_0}.

@item 
Nuevo módulo: el módulo @ref{110,,uuid} genera identificadores únicos universales (UUID) de acuerdo con 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.  El RFC define varias versiones diferentes de UUID que se generan a partir de una cadena inicial, de propiedades del sistema o de forma puramente aleatoria.  Este módulo contiene una clase @code{UUID} y funciones llamadas @code{uuid1()}, @code{uuid3()}, @code{uuid4()}, y @code{uuid5()} para generar diferentes versiones de UUID.  (Los UUID de la versión 2 no se especifican en 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} y no están soportados por este módulo)

@example
>>> import uuid
>>> # make a UUID based on the host ID and current time
>>> uuid.uuid1()
UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

>>> # make a UUID using an MD5 hash of a namespace UUID and a name
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

>>> # make a random UUID
>>> uuid.uuid4()
UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
@end example

(Contribución de Ka-Ping Yee.)

@item 
Los tipos @ref{114,,weakref} del módulo @code{WeakKeyDictionary} y @code{WeakValueDictionary} han obtenido nuevos métodos para iterar sobre las referencias débiles contenidas en el diccionario. Se han añadido los métodos @code{iterkeyrefs()} y @code{keyrefs()} a @code{WeakKeyDictionary}, y @code{itervaluerefs()} y @code{valuerefs()} a @code{WeakValueDictionary}.  (Contribución de Fred L. Drake, Jr.)

@item 
El módulo @ref{115,,webbrowser} ha recibido una serie de mejoras. Ahora se puede utilizar como un script con @code{python -m webbrowser}, tomando una URL como argumento; hay una serie de interruptores para controlar el comportamiento (@code{-n} para una nueva ventana del navegador, @code{-t} para una nueva pestaña).  Se han añadido nuevas funciones a nivel de módulo, @code{open_new()} y @code{open_new_tab()}, para soportar esto.  La función @ref{1be,,open()} del módulo soporta una característica adicional, un parámetro `autoraise' que señala si se debe levantar la ventana abierta cuando sea posible. Se añadieron varios navegadores adicionales a la lista de soportados, como Firefox, Opera, Konqueror y elinks.  (Contribución de Oleg Broytmann y Georg Brandl)

@c Patch #754022

@item 
The @ref{12d,,xmlrpclib} module now supports returning  @ref{32f,,datetime} objects
for the XML-RPC date type.  Supply  @code{use_datetime=True} to the @ref{1474,,loads()}
function or the @code{Unmarshaller} class to enable this feature. (Contributed
by Skip Montanaro.)

@c Patch 1120353

@item 
El módulo @ref{130,,zipfile} ahora soporta la versión ZIP64 del formato, lo que significa que un archivo .zip ahora puede ser mayor de 4 GiB y puede contener archivos individuales mayores de 4 GiB.  (Contribución de Ronald Oussoren)

@c Patch 1446489

@item 
Los objetos @ref{132,,zlib} y @code{Decompress} del módulo @ref{132,,zlib} soportan ahora un método @ref{26,,copy()} que realiza una copia del estado interno del objeto y devuelve un nuevo objeto @code{Compress} o @code{Decompress}. (Contribución de Chris AtLee)

@c Patch 1435422
@end itemize

@c ======================================================================

@menu
* El paquete ctypes:: 
* El paquete ElementTree:: 
* El paquete hashlib:: 
* El paquete sqlite3:: 
* El paquete wsgiref:: 

@end menu

@node El paquete ctypes,El paquete ElementTree,,Módulos nuevos mejorados y eliminados
@anchor{whatsnew/2 5 module-ctypes}@anchor{1475}@anchor{whatsnew/2 5 the-ctypes-package}@anchor{1476}
@subsubsection El paquete ctypes


The @ref{2b,,ctypes} package, written by Thomas Heller, has been added  to the
standard library.  @ref{2b,,ctypes} lets you call arbitrary functions  in shared
libraries or DLLs.  Long-time users may remember the @code{dl} module, which
provides functions for loading shared libraries and calling functions in them.
The @ref{2b,,ctypes} package is much fancier.

Para cargar una biblioteca compartida o DLL, debes crear una instancia de la clase @code{CDLL} y proporcionar el nombre o la ruta de la biblioteca compartida o DLL. Una vez hecho esto, puedes llamar a funciones arbitrarias accediendo a ellas como atributos del objeto @code{CDLL}.

@example
import ctypes

libc = ctypes.CDLL('libc.so.6')
result = libc.printf("Line of output\n")
@end example

Se proporcionan constructores de tipo para los distintos tipos de C: @code{c_int()}, @code{c_float()}, @code{c_double()}, @code{c_char_p()} (equivalente a char* ), etcétera. A diferencia de los tipos de Python, las versiones C son todas mutables; puede asignar a su atributo @code{value} para cambiar el valor envuelto. Los enteros y las cadenas de Python se convertirán automáticamente a los tipos C correspondientes, pero para otros tipos debe llamar al constructor de tipo correcto. (Y me refiero a `debe'; hacerlo mal a menudo resultará en que el intérprete falle con una falla de segmentación).

No debería usar @code{c_char_p()} con una cadena de Python cuando la función C vaya a modificar el área de memoria, porque se supone que las cadenas de Python son inmutables; romper esta regla causará errores desconcertantes.  Cuando necesite un área de memoria modificable, utilice @code{create_string_buffer()}:

@example
s = "this is a string"
buf = ctypes.create_string_buffer(s)
libc.strfry(buf)
@end example

Se supone que las funciones en C devuelven números enteros, pero se puede establecer el atributo @code{restype} del objeto de la función para cambiar esto:

@example
>>> libc.atof('2.71828')
-1783957616
>>> libc.atof.restype = ctypes.c_double
>>> libc.atof('2.71828')
2.71828
@end example

@ref{2b,,ctypes} also provides a wrapper for Python’s C API  as the
@code{ctypes.pythonapi} object.  This object does `not'  release the global
interpreter lock before calling a function, because the lock must be held when
calling into the interpreter’s code.   There’s a @ref{1477,,py_object} type
constructor that will create a  @ref{42d,,PyObject}* pointer.  A simple usage:

@example
import ctypes

d = @{@}
ctypes.pythonapi.PyObject_SetItem(ctypes.py_object(d),
          ctypes.py_object("abc"),  ctypes.py_object(1))
# d is now @{'abc', 1@}.
@end example

Don’t forget to use @ref{1477,,py_object()}; if it’s omitted you end  up with a
segmentation fault.

@ref{2b,,ctypes} existe desde hace tiempo, pero la gente sigue escribiendo y distribuyendo módulos de extensión codificados a mano porque no se puede confiar en que @ref{2b,,ctypes} esté presente. Quizás los desarrolladores empiecen a escribir envoltorios de Python sobre una biblioteca a la que se accede a través de @ref{2b,,ctypes} en lugar de módulos de extensión, ahora que @ref{2b,,ctypes} está incluido en el núcleo de Python.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://web.archive.org/web/20180410025338/http://starship.python.net/crew/theller/ctypes/}

La página web pre-stdlib ctypes, con un tutorial, referencia y preguntas frecuentes.
@end table

La documentación del módulo @ref{2b,,ctypes}.


@c ======================================================================

@node El paquete ElementTree,El paquete hashlib,El paquete ctypes,Módulos nuevos mejorados y eliminados
@anchor{whatsnew/2 5 module-etree}@anchor{1478}@anchor{whatsnew/2 5 the-elementtree-package}@anchor{1479}
@subsubsection El paquete ElementTree


Un subconjunto de la biblioteca ElementTree de Fredrik Lundh para el procesamiento de XML se ha añadido a la biblioteca estándar como @code{xml.etree}.  Los módulos disponibles son @code{ElementTree}, @code{ElementPath} y @code{ElementInclude} de ElementTree 1.2.6.    También se incluye el módulo acelerador @code{cElementTree}.

El resto de esta sección proporcionará una breve descripción general del uso de ElementTree. La documentación completa de ElementTree está disponible en @indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}.

ElementTree representa un documento XML como un árbol de nodos de elementos. El contenido de texto del documento se almacena como los atributos @code{text} y @code{tail} de (Esta es una de las principales diferencias entre ElementTree y el Modelo de Objetos del Documento; en el DOM hay muchos tipos diferentes de nodo, incluyendo @code{TextNode})

La función de análisis más utilizada es @code{parse()}, que toma una cadena (se supone que contiene un nombre de archivo) o un objeto similar a un archivo y devuelve una instancia de @code{ElementTree}:

@example
from xml.etree import ElementTree as ET

tree = ET.parse('ex-1.xml')

feed = urllib.urlopen(
          'http://planet.python.org/rss10.xml')
tree = ET.parse(feed)
@end example

Una vez que tengas una instancia de @code{ElementTree}, puedes llamar a su método @code{getroot()} para obtener el nodo raíz de @code{Element}.

También hay una función @code{XML()} que toma un literal de cadena y devuelve un nodo @code{Element} (no un @code{ElementTree}).   Esta función proporciona una forma ordenada de incorporar fragmentos XML, acercándose a la comodidad de un literal XML:

@example
svg = ET.XML("""<svg width="10px" version="1.0">
             </svg>""")
svg.set('height', '320px')
svg.append(elem1)
@end example

Cada elemento XML admite algunos métodos de acceso tipo diccionario y otros tipo lista.  Las operaciones tipo diccionario se utilizan para acceder a los valores de los atributos, y las operaciones tipo lista se utilizan para acceder a los nodos hijos.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@item

@code{elem[n]}

@tab

Devuelve el elemento hijo enésimo.

@item

@code{elem[m:n]}

@tab

Devuelve la lista de m’s a n’s elementos hijos.

@item

@code{len(elem)}

@tab

Devuelve el número de elementos hijos.

@item

@code{lista(elem)}

@tab

Devuelve la lista de elementos hijos.

@item

@code{elem.append(elem2)}

@tab

Añade `elemento2' como hijo.

@item

@code{elem.insert(index, elem2)}

@tab

Inserta `elemento2' en el lugar especificado.

@item

@code{del elem[n]}

@tab

Elimina el elemento hijo enésimo.

@item

@code{elem.keys()}

@tab

Devuelve la lista de nombres de atributos.

@item

@code{elem.get(name)}

@tab

Devuelve el valor del atributo `nombre'.

@item

@code{elem.set(nombre, valor)}

@tab

Establece el nuevo valor del atributo `nombre'.

@item

@code{elem.attrib}

@tab

Recupera el diccionario que contiene los atributos.

@item

@code{del elem.attrib[name]}

@tab

Borra el atributo `nombre'.

@end multitable


Los comentarios y las instrucciones de procesamiento también se representan como nodos @code{Element}.  Para comprobar si un nodo es un comentario o unas instrucciones de procesamiento:

@example
if elem.tag is ET.Comment:
    ...
elif elem.tag is ET.ProcessingInstruction:
    ...
@end example

Para generar una salida XML, debes llamar al método @code{ElementTree.write()}. Al igual que @code{parse()}, puede tomar una cadena o un objeto tipo archivo:

@example
# Encoding is US-ASCII
tree.write('output.xml')

# Encoding is UTF-8
f = open('output.xml', 'w')
tree.write(f, encoding='utf-8')
@end example

(Atención: la codificación por defecto utilizada para la salida es ASCII.  Para el trabajo general de XML, donde el nombre de un elemento puede contener caracteres Unicode arbitrarios, ASCII no es una codificación muy útil porque lanzará una excepción si el nombre de un elemento contiene cualquier carácter con valores superiores a 127.  Por lo tanto, es mejor especificar una codificación diferente, como UTF-8, que puede manejar cualquier carácter Unicode)

Esta sección es sólo una descripción parcial de las interfaces de ElementTree. Por favor, lee la documentación oficial del paquete para más detalles.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}

Documentación oficial de ElementTree.
@end table


@c ======================================================================

@node El paquete hashlib,El paquete sqlite3,El paquete ElementTree,Módulos nuevos mejorados y eliminados
@anchor{whatsnew/2 5 module-hashlib}@anchor{147a}@anchor{whatsnew/2 5 the-hashlib-package}@anchor{147b}
@subsubsection El paquete hashlib


A new @ref{68,,hashlib} module, written by Gregory P. Smith,  has been added to
replace the @code{md5} and @code{sha} modules.  @ref{68,,hashlib} adds support for
additional secure hashes (SHA-224, SHA-256, SHA-384, and SHA-512). When
available, the module uses OpenSSL for fast platform optimized implementations
of algorithms.

The old @code{md5} and @code{sha} modules still exist as wrappers around hashlib
to preserve backwards compatibility.  The new module’s interface is very close
to that of the old modules, but not identical. The most significant difference
is that the constructor functions for creating new hashing objects are named
differently.

@example
# Old versions
h = md5.md5()
h = md5.new()

# New version
h = hashlib.md5()

# Old versions
h = sha.sha()
h = sha.new()

# New version
h = hashlib.sha1()

# Hash that weren't previously available
h = hashlib.sha224()
h = hashlib.sha256()
h = hashlib.sha384()
h = hashlib.sha512()

# Alternative form
h = hashlib.new('md5')          # Provide algorithm as a string
@end example

Una vez que se ha creado un objeto hash, sus métodos son los mismos que antes: @code{actualizar(cadena)} convierte la cadena especificada en el estado de resumen actual, @code{digest()} y @code{hexdigest()} devuelven el valor de resumen como una cadena binaria o una cadena de dígitos hexadecimales, y @code{copiar()} devuelve un nuevo objeto hash con el mismo estado de resumen.


@subsubheading Ver también


La documentación del módulo @ref{68,,hashlib}.


@c ======================================================================

@node El paquete sqlite3,El paquete wsgiref,El paquete hashlib,Módulos nuevos mejorados y eliminados
@anchor{whatsnew/2 5 module-sqlite}@anchor{147c}@anchor{whatsnew/2 5 the-sqlite3-package}@anchor{147d}
@subsubsection El paquete sqlite3


El módulo pysqlite (@indicateurl{https://www.pysqlite.org}), un envoltorio para la base de datos incrustada de SQLite, se agregó a la biblioteca estándar con el nombre de paquete @ref{cf,,sqlite3}.

SQLite es una biblioteca en C que proporciona una base de datos ligera basada en disco que no requiere un proceso de servidor independiente y permite acceder a la base de datos utilizando una variante no estándar del lenguaje de consulta SQL. Algunas aplicaciones pueden utilizar SQLite para el almacenamiento interno de datos.  También es posible crear un prototipo de una aplicación utilizando SQLite y luego portar el código a una base de datos más grande como PostgreSQL u Oracle.

pysqlite fue escrito por Gerhard Häring y proporciona una interfaz SQL que cumple con la especificación DB-API 2.0 descrita por 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}.

Si estás compilando el código fuente de Python tú mismo, ten en cuenta que el árbol de código fuente no incluye el código de SQLite, sólo el módulo envolvente. Necesitarás tener las librerías y cabeceras de SQLite instaladas antes de compilar Python, y el proceso de construcción compilará el módulo cuando las cabeceras necesarias estén disponibles.

Para utilizar el módulo, primero hay que crear un objeto @code{Connection} que represente la base de datos.  Aquí los datos se almacenarán en el archivo @code{/tmp/example}:

@example
conn = sqlite3.connect('/tmp/example')
@end example

También puede suministrar el nombre especial @code{:memory:} para crear una base de datos en la RAM.

Una vez que tengas una @code{Connection}, puedes crear un objeto @code{Cursor} y llamar a su método @code{execute()} para realizar comandos SQL:

@example
c = conn.cursor()

# Create table
c.execute('@w{'}'create table stocks
(date text, trans text, symbol text,
 qty real, price real)'@w{'}')

# Insert a row of data
c.execute("""insert into stocks
          values ('2006-01-05','BUY','RHAT',100,35.14)""")
@end example

Normalmente tus operaciones SQL necesitarán usar valores de variables de Python.  No deberías montar tu consulta usando las operaciones de cadena de Python porque hacerlo es inseguro; hace que tu programa sea vulnerable a un ataque de inyección SQL.

En su lugar, utilice la sustitución de parámetros de la DB-API.  Ponga @code{?} como marcador de posición donde quiera usar un valor, y luego proporcione una tupla de valores como segundo argumento al método @code{execute()} del cursor.  (Otros módulos de base de datos pueden utilizar un marcador de posición diferente, como @code{%s} o @code{:1}) Por ejemplo:

@example
# Never do this -- insecure!
symbol = 'IBM'
c.execute("... where symbol = '%s'" % symbol)

# Do this instead
t = (symbol,)
c.execute('select * from stocks where symbol=?', t)

# Larger example
for t in (('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
          ('2006-04-05', 'BUY', 'MSOFT', 1000, 72.00),
          ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
         ):
    c.execute('insert into stocks values (?,?,?,?,?)', t)
@end example

Para recuperar datos después de ejecutar una sentencia SELECT, puede tratar el cursor como un iterador, llamar al método @code{fetchone()} del cursor para recuperar una sola fila que coincida, o llamar a @code{fetchall()} para obtener una lista de las filas que coincidan.

Este ejemplo utiliza la forma del iterador:

@example
>>> c = conn.cursor()
>>> c.execute('select * from stocks order by price')
>>> for row in c:
...    print row
...
(u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)
(u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)
(u'2006-04-06', u'SELL', u'IBM', 500, 53.0)
(u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)
>>>
@end example

Para más información sobre el dialecto SQL soportado por SQLite, consulte @indicateurl{https://www.sqlite.org}.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://www.pysqlite.org}

La página web de pysqlite.

@item @indicateurl{https://www.sqlite.org}

La página web de SQLite; la documentación describe la sintaxis y los tipos de datos disponibles para el dialecto SQL soportado.
@end table

La documentación del módulo @ref{cf,,sqlite3}.


@table @asis

@geindex Python Enhancement Proposals; PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - Especificación de la API de la base de datos 2.0

PEP escrito por Marc-André Lemburg.
@end table


@c ======================================================================

@node El paquete wsgiref,,El paquete sqlite3,Módulos nuevos mejorados y eliminados
@anchor{whatsnew/2 5 module-wsgiref}@anchor{147e}@anchor{whatsnew/2 5 the-wsgiref-package}@anchor{147f}
@subsubsection El paquete wsgiref


La Interfaz de Pasarela del Servidor Web (WSGI) v1.0 define una interfaz estándar entre los servidores web y las aplicaciones web de Python y se describe en 
@geindex Python Enhancement Proposals; PEP 333
PEP 333@footnote{https://peps.python.org/pep-0333/}. El paquete @ref{118,,wsgiref} es una implementación de referencia de la especificación WSGI.

@c XXX should this be in a :pep:`333` section instead?

El paquete incluye un servidor HTTP básico que ejecutará una aplicación WSGI; este servidor es útil para la depuración pero no está pensado para su uso en producción.  La configuración de un servidor sólo requiere unas pocas líneas de código:

@example
from wsgiref import simple_server

wsgi_app = ...

host = '@w{'}
port = 8000
httpd = simple_server.make_server(host, port, wsgi_app)
httpd.serve_forever()
@end example

@c XXX discuss structure of WSGI applications?

@c XXX provide an example using Django or some other framework?


@subsubheading Ver también



@table @asis

@item @indicateurl{https://web.archive.org/web/20160331090247/http://wsgi.readthedocs.org/en/latest/}

Un sitio web central para los recursos relacionados con WSGI.

@geindex Python Enhancement Proposals; PEP 333

@item PEP 333@footnote{https://peps.python.org/pep-0333/} - Interfaz del servidor web Python v1.0

PEP escrito por Phillip J. Eby.
@end table


@c ======================================================================

@node Cambios en la API de construcción y C<4>,Adaptación a Python 2 5,Módulos nuevos mejorados y eliminados,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 build-and-c-api-changes}@anchor{1480}@anchor{whatsnew/2 5 build-api}@anchor{1481}
@subsection Cambios en la API de construcción y C


Los cambios en el proceso de construcción de Python y en la API de C incluyen:


@itemize *

@item 
El árbol de fuentes de Python fue convertido de CVS a Subversion, en un complejo procedimiento de migración que fue supervisado y llevado a cabo de forma impecable por Martin von Löwis.  El procedimiento se desarrolló como 
@geindex Python Enhancement Proposals; PEP 347
PEP 347@footnote{https://peps.python.org/pep-0347/}.

@item 
Coverity, una empresa que comercializa una herramienta de análisis de código fuente llamada Prevent, proporcionó los resultados de su examen del código fuente de Python.  El análisis encontró alrededor de 60 errores que fueron rápidamente corregidos.  Muchos de los errores eran problemas de recuento, que a menudo se producen en el código de gestión de errores.  Consulte las estadísticas en @indicateurl{https://scan.coverity.com}.

@item 
El mayor cambio en la API de C provino de 
@geindex Python Enhancement Proposals; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}, que modifica el intérprete para usar una definición de tipo @ref{af0,,Py_ssize_t} en lugar de int. Consulte la sección anterior @ref{1457,,PEP 353; Uso de ssize_t como tipo de índice} para obtener una explicación de este cambio.

@item 
El diseño del compilador de código de bytes ha cambiado mucho, ya no genera código de bytes recorriendo el árbol de análisis sintáctico.  En su lugar, el árbol de análisis se convierte en un árbol de sintaxis abstracta (o AST), y es el árbol de sintaxis abstracta el que se recorre para producir el código de bytes.

Es posible que el código Python obtenga objetos AST utilizando el built-in @ref{2fb,,compile()} y especificando @code{_ast.PyCF_ONLY_AST} como valor del parámetro `flags':

@example
from _ast import PyCF_ONLY_AST
ast = compile("""a=0
for i in range(10):
    a += i
""", "<string>", 'exec', PyCF_ONLY_AST)

assignment = ast.body[0]
for_loop = ast.body[1]
@end example

Todavía no se ha escrito ninguna documentación oficial para el código AST, pero 
@geindex Python Enhancement Proposals; PEP 339
PEP 339@footnote{https://peps.python.org/pep-0339/} discute el diseño.  Para empezar a conocer el código, lea la definición de los distintos nodos AST en @code{Parser/Python.asdl}.  Un script de Python lee este archivo y genera un conjunto de definiciones de estructuras C en @code{Include/Python-ast.h}.  Las funciones @code{PyParser_ASTFromString()} y @code{PyParser_ASTFromFile()}, definidas en @code{Include/pythonrun.h}, toman el código fuente de Python como entrada y devuelven la raíz de un AST que representa el contenido. Este AST puede convertirse en un objeto de código mediante @code{PyAST_Compile()}.  Para más información, lea el código fuente, y luego haga preguntas en python-dev.

El código de la AST fue desarrollado bajo la dirección de Jeremy Hylton, e implementado por (en orden alfabético) Brett Cannon, Nick Coghlan, Grant Edwards, John Ehresman, Kurt Kaiser, Neal Norwitz, Tim Peters, Armin Rigo y Neil Schemenauer, además de los participantes en varios sprints de la AST en conferencias como la PyCon.

@c List of names taken from Jeremy's python-dev post at

@c https://mail.python.org/pipermail/python-dev/2005-October/057500.html

@item 
Se aplicó el parche de Evan Jones a obmalloc, descrito por primera vez en una charla en la PyCon DC 2005.  Python 2.4 asignaba objetos pequeños en arenas de 256K, pero nunca liberaba arenas.  Con este parche, Python liberará arenas cuando estén vacías.  El efecto neto es que en algunas plataformas, cuando se asignan muchos objetos, el uso de la memoria de Python puede realmente caer cuando se borran y la memoria puede ser devuelta al sistema operativo.  (Implementado por Evan Jones, y reelaborado por Tim Peters)

Tenga en cuenta que este cambio significa que los módulos de extensión deben ser más cuidadosos al asignar memoria.  La API de Python tiene muchas funciones diferentes para asignar memoria que se agrupan en familias.  Por ejemplo, @ref{cee,,PyMem_Malloc()}, @ref{10ae,,PyMem_Realloc()}, y @ref{1482,,PyMem_Free()} son una familia que asigna memoria en bruto, mientras que @ref{cf0,,PyObject_Malloc()}, @ref{1483,,PyObject_Realloc()}, y @ref{ced,,PyObject_Free()} son otra familia que se supone que se utiliza para crear objetos de Python.

Anteriormente estas diferentes familias se reducían a las funciones @code{malloc()} y @code{free()} de la plataforma.  Esto significaba que no importaba si te equivocabas y asignabas memoria con la función @code{PyMem} pero la liberabas con la función @code{PyObject}.  Con los cambios de la versión 2.5 en obmalloc, estas familias hacen ahora cosas diferentes y los desajustes probablemente darán lugar a un fallo de seguridad.  Deberías probar cuidadosamente tus módulos de extensión C con Python 2.5.

@item 
Los tipos de conjuntos incorporados tienen ahora una API oficial en C.  Llame a @ref{1484,,PySet_New()} y @ref{1485,,PyFrozenSet_New()} para crear un nuevo conjunto, @ref{1486,,PySet_Add()} y @ref{1487,,PySet_Discard()} para añadir y eliminar elementos, y @ref{1488,,PySet_Contains()} y @ref{1489,,PySet_Size()} para examinar el estado del conjunto. (Contribución de Raymond Hettinger)

@item 
El código C puede ahora obtener información sobre la revisión exacta del intérprete de Python llamando a la función @ref{1471,,Py_GetBuildInfo()} que devuelve una cadena de información de compilación como esta @code{"trunk:45355:45356M, Apr 13 2006, 07:42:19"}.   (Contribuido por Barry Warsaw.)

@item 
Se pueden utilizar dos nuevas macros para indicar las funciones C que son locales al fichero actual, de modo que se pueda utilizar una convención de llamada más rápida. @code{Py_LOCAL(type)} declara que la función devuelve un valor del `tipo' especificado y utiliza un calificador de llamada rápida. @code{Py_LOCAL_INLINE(type)} hace lo mismo y también solicita que la función sea inline.  Si @code{PY_LOCAL_AGGRESSIVE} se define antes de que se incluya @code{python.h}, se habilita un conjunto de optimizaciones más agresivas para el módulo; debería comparar los resultados para averiguar si estas optimizaciones realmente hacen el código más rápido.  (Contribuido por Fredrik Lundh en el sprint NeedForSpeed)

@item 
@code{PyErr_NewException(name, base, dict)} ahora puede aceptar una tupla de clases base como su argumento `base'.  (Contribuido por Georg Brandl.)

@item 
La función @code{PyErr_Warn()} para emitir avisos está ahora obsoleta en favor de @code{PyErr_WarnEx(category, message, stacklevel)} que permite especificar el número de marcos de pila que separan esta función y la que la llama.  Un `stacklevel' de 1 es la función que llama a @ref{148a,,PyErr_WarnEx()}, 2 es la función que está por encima, y así sucesivamente.  (Añadido por Neal Norwitz.)

@item 
El intérprete de CPython sigue estando escrito en C, pero el código ahora puede ser compilado con un compilador de C++ sin errores.   (Implementado por Anthony Baxter, Martin von Löwis, Skip Montanaro)

@item 
Se ha eliminado la función @code{PyRange_New()}.  Nunca se documentó, nunca se utilizó en el código del núcleo, y tenía una comprobación de errores peligrosamente laxa.  En el improbable caso de que sus extensiones la utilizaran, puede sustituirla por algo como lo siguiente:

@example
range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
                              start, stop, step);
@end example
@end itemize

@c ======================================================================

@menu
* Cambios específicos en los puertos:: 

@end menu

@node Cambios específicos en los puertos,,,Cambios en la API de construcción y C<4>
@anchor{whatsnew/2 5 port-specific-changes}@anchor{148b}@anchor{whatsnew/2 5 ports}@anchor{148c}
@subsubsection Cambios específicos en los puertos



@itemize *

@item 
MacOS X (10.3 y superior): la carga dinámica de módulos utiliza ahora la función @code{dlopen()} en lugar de funciones específicas de MacOS.

@item 
MacOS X: se ha añadido una opción @code{--enable-universalsdk} al script @code{configure} que compila el intérprete como un binario universal capaz de funcionar tanto en procesadores PowerPC como Intel. (Contribución de Ronald Oussoren; bpo-2573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2573}.)

@item 
Windows: @code{.dll} ya no se admite como extensión de nombre de archivo para los módulos de extensión. @code{.pyd} es ahora la única extensión de nombre de archivo que se buscará.
@end itemize

@c ======================================================================

@node Adaptación a Python 2 5,Agradecimientos<3>,Cambios en la API de construcción y C<4>,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 porting}@anchor{148d}@anchor{whatsnew/2 5 porting-to-python-2-5}@anchor{148e}
@subsection Adaptación a Python 2.5


Esta sección enumera los cambios descritos anteriormente que pueden requerir cambios en su código:


@itemize *

@item 
ASCII es ahora la codificación por defecto para los módulos.  Ahora es un error de sintaxis si un módulo contiene literales de cadena con caracteres de 8 bits pero no tiene una declaración de codificación.  En Python 2.4 esto provocaba una advertencia, no un error de sintaxis.

@item 
Anteriormente, el atributo @code{gi_frame} de un generador era siempre un objeto frame.  Debido a los cambios de 
@geindex Python Enhancement Proposals; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} descritos en la sección @ref{1443,,PEP 342; Nuevas funciones del generador}, ahora es posible que @code{gi_frame} sea @code{None}.

@item 
Una nueva advertencia, @ref{1463,,UnicodeWarning}, se lanza cuando se intenta comparar una cadena Unicode y una cadena de 8 bits que no puede ser convertida a Unicode utilizando la codificación ASCII por defecto.  Anteriormente estas comparaciones lanzaban una excepción @ref{aa5,,UnicodeDecodeError}.

@item 
Biblioteca: el módulo @ref{2a,,csv} es ahora más estricto con los campos citados en varias líneas. Si sus archivos contienen nuevas líneas incrustadas dentro de los campos, la entrada debe dividirse en líneas de manera que se conserven los caracteres de nueva línea.

@item 
Biblioteca: la función @ref{6c0,,format()} del módulo @ref{86,,locale} aceptaba antes cualquier cadena siempre que no apareciera más de un especificador %char.  En Python 2.5, el argumento debe ser exactamente un especificador %char sin texto alrededor.

@item 
Library: The @ref{a6,,pickle} and @code{cPickle} modules no longer accept a
return value of @code{None} from the @ref{a65,,__reduce__()} method; the method must
return a tuple of arguments instead.  The modules also no longer accept the
deprecated `bin' keyword parameter.

@item 
Library: The @ref{12e,,SimpleXMLRPCServer} and @ref{12e,,DocXMLRPCServer}  classes now
have a @code{rpc_paths} attribute that constrains XML-RPC operations to a
limited set of URL paths; the default is to allow only @code{'/'} and @code{'/RPC2'}.
Setting  @code{rpc_paths} to @code{None} or an empty tuple disables  this path
checking.

@item 
API de C: muchas funciones ahora usan @ref{af0,,Py_ssize_t} en lugar de int para permitir el procesamiento de más datos en máquinas de 64 bits. Es posible que el código de extensión deba realizar el mismo cambio para evitar advertencias y admitir máquinas de 64 bits. Consulte la sección anterior @ref{1457,,PEP 353; Uso de ssize_t como tipo de índice} para obtener una explicación de este cambio.

@item 
API C:  Los cambios en obmalloc significan que debe tener cuidado de no mezclar el uso de las familias de funciones @code{PyMem_*} y @code{PyObject_*}. La memoria asignada con la función @code{*_Malloc} de una familia, debe ser liberada con la función @code{*_Free} de la familia correspondiente.
@end itemize

@c ======================================================================

@node Agradecimientos<3>,,Adaptación a Python 2 5,Qué hay de nuevo en Python 2 5
@anchor{whatsnew/2 5 acknowledgements}@anchor{148f}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas sus sugerencias, correcciones y ayuda en varios borradores de este artículo: Georg Brandl, Nick Coghlan, Phillip J. Eby, Lars Gustäbel, Raymond Hettinger, Ralf W. Grosse-Kunstleve, Kent Johnson, Iain Lowe, Martin von Löwis, Fredrik Lundh, Andrew McNamara, Skip Montanaro, Gustavo Niemeyer, Paul Prescod, James Pryor, Mike Rovner, Scott Weikart, Barry Warsaw, Thomas Wouters.

@node Qué hay de nuevo en Python 2 4,Qué hay de nuevo en Python 2 3,Qué hay de nuevo en Python 2 5,Qué hay de nuevo en Python
@anchor{whatsnew/2 4 doc}@anchor{1490}@anchor{whatsnew/2 4 what-s-new-in-python-2-4}@anchor{1491}
@section Qué hay de nuevo en Python 2.4


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew24.tex 54632 2007-03-31 11:59:54Z georg.brandl $

@c Don't write extensive text for new sections; I'll do that.

@c Feel free to add commented-out reminders of things that need

@c to be covered.  --amk

Este artículo explica las nuevas funcionalidades en Python 2.4.1 lanzadas el 30 de marzo de 2005.

Python 2.4 es un lanzamiento de término medio. Esto significa que no se han introducido grandes cambios como en la versión 2.2 de Python pero si son más significativas que la versión 2.3. Lo más relevante de estas nuevas funcionalidades son los decoradores y generadores de expresiones, la mayor parte del resto de los cambios son a la librería estándar.

De acuerdo al registro de cambios CVS , han sido aplicados 481 parches y 502 bugs han sido corregidos entre las versiones 2.3 y 2.4 de Python. Es posible que ambas cifras no concuerden con la realidad, podrían estar subestimadas.

Este artículo no pretende proveer una especificación completa y detallada de cada funcionalidad nueva, en vez de esto, se provee una breve descripción de las nuevas características. Para obtener más información se debe consultar la documentación oficial de Python 2.4, tal como la librería de referencia de Python y el manual de referencia de Python. Otra fuente de información es PEP (guía de estilo-mejoras de python) para buscar información sobre la implementación y fundamentación del diseño.

@c ======================================================================

@menu
* PEP 218; Objetos conjunto integrados: PEP 218 Objetos conjunto integrados. 
* PEP 237; Unificando enteros largos y enteros: PEP 237 Unificando enteros largos y enteros. 
* PEP 289; Expresiones generadoras: PEP 289 Expresiones generadoras. 
* PEP 292; Sustituciones simples de cadenas de caracteres: PEP 292 Sustituciones simples de cadenas de caracteres. 
* PEP 318; Decoradores para funciones y métodos: PEP 318 Decoradores para funciones y métodos. 
* PEP 322; Iteración inversa: PEP 322 Iteración inversa. 
* PEP 324; Nuevo módulo de subproceso: PEP 324 Nuevo módulo de subproceso. 
* PEP 327; Tipo de dato decimal: PEP 327 Tipo de dato decimal. 
* PEP 328; Importaciones multilínea: PEP 328 Importaciones multilínea. 
* PEP 331; Conversiones locales-independientes números flotantes/cadenas de texto: PEP 331 Conversiones locales-independientes números flotantes/cadenas de texto. 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<4>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<3>. 
* Cambios en la API de Build y C: Cambios en la API de Build y C<2>. 
* Portar a Python 2.4: Portar a Python 2 4. 
* Agradecimientos: Agradecimientos<4>. 

@end menu

@node PEP 218 Objetos conjunto integrados,PEP 237 Unificando enteros largos y enteros,,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-218-built-in-set-objects}@anchor{1492}
@subsection PEP 218: Objetos conjunto integrados


Python 2.3 introdujo el módulo @code{sets} , implementaciones del lenguaje C de tipos de datos han sido agregados al core de Python como dos nuevos tipos integrados. @code{set (iterable)} y @code{frozenset (iterable)} . Ellos proveen operaciones de alto rendimiento para pruebas de pertenencia, eliminar datos duplicados de una secuencia y operaciones matemáticas como: uniones, intersecciones, diferencias y diferencias simétricas.

@example
>>> a = set('abracadabra')              # form a set from a string
>>> 'z' in a                            # fast membership testing
False
>>> a                                   # unique letters in a
set(['a', 'r', 'b', 'c', 'd'])
>>> '@w{'}.join(a)                          # convert back into a string
'arbcd'

>>> b = set('alacazam')                 # form a second set
>>> a - b                               # letters in a but not in b
set(['r', 'd', 'b'])
>>> a | b                               # letters in either a or b
set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
>>> a & b                               # letters in both a and b
set(['a', 'c'])
>>> a ^ b                               # letters in a or b but not both
set(['r', 'd', 'b', 'm', 'z', 'l'])

>>> a.add('z')                          # add a new element
>>> a.update('wxy')                     # add multiple new elements
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
>>> a.remove('x')                       # take one element out
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])
@end example

La función de conjuntos integrados @ref{67b,,frozenset()} es una versión inmutable de @ref{67a,,set()}. Como es inmutable y hashable (su valor no cambia), se puede usar como una llave de diccionario o como parte de otro set.

El módulo set @code{sets} se encuentra en la librería estándar y puede ser útil si se desea usar una subclase de @code{Set} o @code{ImmutableSet} No existen planes de deprecación del módulo.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - Agregando tipo de objeto integrado set

Originalmente propuesto por Greg Wilson e implementado finalmente por Raymond Hettinger.
@end table


@c ======================================================================

@node PEP 237 Unificando enteros largos y enteros,PEP 289 Expresiones generadoras,PEP 218 Objetos conjunto integrados,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-237-unifying-long-integers-and-integers}@anchor{1493}
@subsection PEP 237: Unificando enteros largos y enteros


El prolongado proceso de transición para este PEP que comenzó en Python 2.2 ha dado un paso más adelante en Python 2.4. En la versión 2.3 ciertas operaciones de enteros podían comportarse diferente después de lanzar la unificación del tipo de dato int-long entregando alertas @ref{4d4,,FutureWarning} y retornando valores limitados a 32 o 64 bits dependiendo de su plataforma. En la versión 2.4 estas expresiones ya no producen alertas y en vez de eso entrega un resultado diferente que suele ser un entero largo.

Las expresiones problemáticas son principalmente desplazamientos a la izquierda y constantes largas de hexadecimales y octales. Por ejemplo, @code{2 << 32}  entrega una alerta en la versión 2.3 y evalúa 0 en plataformas 32-bit. Ahora en Python 2.4 la expresión retorna la respuesta correcta, 8589934592.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - Unificando enteros largos y enteros

PEP original escrito por Moshe Zadka y GvR.  Los cambios a la versión 2.4 fueron implementados por Kalle Svensson.
@end table


@c ======================================================================

@node PEP 289 Expresiones generadoras,PEP 292 Sustituciones simples de cadenas de caracteres,PEP 237 Unificando enteros largos y enteros,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-289-generator-expressions}@anchor{1494}
@subsection PEP 289: Expresiones generadoras


La función de iterador introducida en Python 2.2 y el módulo @ref{81,,itertools} facilitan la escritura de programas que recorren grandes conjuntos de datos sin tener todo el conjunto de datos en la memoria al mismo tiempo. Las listas de comprensión no encajan muy bien en esta imagen porque producen un objeto de lista de Python que contiene todos los elementos. Esto inevitablemente lleva todos los objetos a la memoria, lo que puede ser un problema si su conjunto de datos es muy grande. Al tratar de escribir un programa de estilo funcional, sería natural escribir algo como:

@example
links = [link for link in get_all_links() if not link.followed]
for link in links:
    ...
@end example

en vez de

@example
for link in get_all_links():
    if link.followed:
        continue
    ...
@end example

La primera forma es mas concisa y quizás mas legible pero en caso de trabajar con un gran número largo de objetos podría ser necesario el escribir una segunda línea para evitar tener los objetos enlazados en memoria al mismo tiempo.

Las expresiones generadoras trabajan de forma similar a las listas por comprensión pero no materializan la lista completa, en vez de eso se crea un generador que retornará los elementos uno a uno.
El siguiente ejemplo podría ser escrito como:

@example
links = (link for link in get_all_links() if not link.followed)
for link in links:
    ...
@end example

Los generadores de expresiones siempre tienen que ser escritos dentro de paréntesis como en el ejemplo descrito arriba. Los paréntesis señalan una llamada a la función que también se puede contar, entonces si se necesita crear un iterador que inmediatamente pasara a una función se podría escribir:

@example
print sum(obj.count for obj in list_all_objects())
@end example

Las expresiones generadoras difieren de las listas de comprensión por pequeñas diferencias. La mas notable es que la variable del loop (`obj' en el ejemplo de arriba) no es accesible fuera de la expresión generadora. Las listas de comprensión dejan la variable asignada a su último valor, en versiones futuras de Python esto será cambiado en lo que respecta a hacer que las listas de comprensión coincidan con las expresiones de los generadores.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 289

@item PEP 289@footnote{https://peps.python.org/pep-0289/} - Expresiones generadoras

Propuesto por Raymond Hettinger e implementada por Jiwon Seo con los primeros esfuerzos dirigidos por Hye-Shik Chang.
@end table


@c ======================================================================

@node PEP 292 Sustituciones simples de cadenas de caracteres,PEP 318 Decoradores para funciones y métodos,PEP 289 Expresiones generadoras,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-292-simpler-string-substitutions}@anchor{1495}
@subsection PEP 292: Sustituciones simples de cadenas de caracteres


Algunas nuevas clases en la librería estándar proveen un mecanismo alternativo para sustituir variables dentro de cadenas de caracteres, este estilo de sustituciones puede ser mejor por aplicaciones donde usuarios sin experiencia necesitan editar plantillas.

La manera usual de sustituir variables por el nombre es con el operador @code{%} :

@example
>>> '%(page)i: %(title)s' % @{'page':2, 'title': 'The Best of Times'@}
'2: The Best of Times'
@end example

Cuando se escriben plantillas con cadenas de caracteres puede ser muy fácil olvidar el uso de @code{i} or @code{s} después de cerrar paréntesis. Esto no es un problema grande si se está dentro de un módulo de Python pues al correr el código se lanza el siguiente mensaje de error «Unsupported format character» @ref{360,,ValueError} y el problema se resuelve. Sin embargo, tengamos en cuenta una aplicación como Mailman donde una plantilla de caracteres o traducciones son editadas por usuarios que no están familiarizados con Python. La sintaxis de como formatear las cadenas de caracteres es complicada de explicar para ciertos usuarios y si ellos cometen un error es una dificultad el entregar retroalimentación y ayuda.

PEP 292 agrega una clase @code{Template} al módulo @ref{d3,,string} al módulo que usa @code{$} para indicar una sustitución:

@example
>>> import string
>>> t = string.Template('$page: $title')
>>> t.substitute(@{'page':2, 'title': 'The Best of Times'@})
'2: The Best of Times'
@end example

Si una llave falta en el diccionario, el método @code{substitute()} lanzará una @ref{438,,KeyError}. También el método @code{safe_substitute()} que ignora las llaves faltantes:

@example
>>> t = string.Template('$page: $title')
>>> t.safe_substitute(@{'page':3@})
'3: $title'
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 292

@item PEP 292@footnote{https://peps.python.org/pep-0292/} - Sustituciones simples de cadenas de caracteres

Escrito e implementado por Barry Warsaw.
@end table


@c ======================================================================

@node PEP 318 Decoradores para funciones y métodos,PEP 322 Iteración inversa,PEP 292 Sustituciones simples de cadenas de caracteres,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-318-decorators-for-functions-and-methods}@anchor{1496}
@subsection PEP 318: Decoradores para funciones y métodos


Python 2.2 extendió el modelo de objeto de Python añadiendo métodos estáticos y métodos de clase pero no se extendió la sintaxis de Python para proveer alguna nueva forma de definir métodos estáticos o de clase. En vez de eso se tenía que escribir la palabra clave @ref{1497,,def} de manera usual y pasar el método resultante a la @ref{22e,,staticmethod()} o a la @ref{2d2,,classmethod()} que podía agrupar la función como método de un nuevo tipo. El código podría verse como esto:

@example
class C:
   def meth (cls):
       ...

   meth = classmethod(meth)   # Rebind name to wrapped-up class method
@end example

Si el método era muy largo, era muy probable el perder o olvidar la invocación @ref{2d2,,classmethod()} dentro del cuerpo de la función.

La intención era siempre agregar alguna sintaxis que hicieran las definiciones mas entendibles pero al tiempo del lanzamiento de la versión 2.2 una buena sintaxis no era clara. Al día de hoy una buena sintaxis aun no es clara pero los usuarios están preguntando por formas más fáciles de acceder a las características, entonces una nueva funcionalidad sintáctica ha sido añadida para satisfacer esta necesidad.

La nueva característica es llamada decoradores de funciones. El nombre proviene de la idea de que @ref{2d2,,classmethod()}, @ref{22e,,staticmethod()} son amigos y guardan información adicional en un objeto de una función. ellos están decorando funciones con mas detalles.

La notación proviene de Java y usa el @code{'@@'} símbolo arroba como un indicador. Usando la nueva sintaxis el ejemplo descrito arriba podría ser escrito de la siguiente forma:

@example
class C:

   @@classmethod
   def meth (cls):
       ...
@end example

El @code{@@classmethod}  es un atajo para @code{meth=classmethod(meth)}. De forma general si se tiene lo siguiente:

@example
@@A
@@B
@@C
def f ():
    ...
@end example

Es el equivalente para el siguiente código de pre decorador:

@example
def f(): ...
f = A(B(C(f)))
@end example

Los decoradores deben agregarse en una línea antes de la definición de la función, un decorador por línea y no puede estar en la misma línea donde se usa la palabra def para comenzar una función, por ejemplo @code{@@A def f(): ...} es incorrecto. Solo se puede decorar una definición de función tanto al nivel de módulo o dentro de una clase pero no puedes decorar definiciones de clase.

Un decorador es simplemente una función que toma la función a ser decorada como un argumento y retorna tanto la misma función o un nuevo objeto. El valor de retorno del decorador no necesita ser llamado (como típicamente se cree) si no que los decoradores podrán ser aplicados al resultado. Es fácil escribir sus propios decoradores. El siguiente ejemplo agrega un atributo a la función objetiva:

@example
>>> def deco(func):
...    func.attr = 'decorated'
...    return func
...
>>> @@deco
... def f(): pass
...
>>> f
<function f at 0x402ef0d4>
>>> f.attr
'decorated'
>>>
@end example

Como un ejemplo un poco mas realista, el siguiente decorador revisa si el argumento entregado es un entero:

@example
def require_int (func):
    def wrapper (arg):
        assert isinstance(arg, int)
        return func(arg)

    return wrapper

@@require_int
def p1 (arg):
    print arg

@@require_int
def p2(arg):
    print arg*2
@end example

Un ejemplo en 
@geindex Python Enhancement Proposals; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/}  contiene una versión mas elegante de esta idea donde deja que usted elija específicamente el tipo y revisa el tipo de retorno.

Los decoradores de funciones pueden tomar argumentos. Si los argumentos son provistos, el decorador de la función es llamado con solo esos argumentos y retorna un nuevo decorador de función, esta función debe tomar una función sola y retorna una función como previamente se ha descrito. En otras palabras @code{@@A @@B @@C(args)} comienza:

@example
def f(): ...
_deco = C(args)
f = A(B(_deco(f)))
@end example

Conseguir que esto resulte correcto puede ser un acertijo pero tampoco es muy dificultoso.

A small related change makes the @ref{133c,,func_name}
attribute of functions
writable.  This attribute is used to display function names in tracebacks, so
decorators should change the name of any new function that’s constructed and
returned.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} Decoradores para funciones, métodos y clases

Escrito por Kevin D.Smith, Jim Jewett y Skip Montanaro. Varias personas escribieron parches sobre la implementación de los decoradores de funciones, pero el único que fue chequeado fue #979728 por Mark Russell.

@item @indicateurl{https://wiki.python.org/moin/PythonDecoratorLibrary}

Esta pagina de wiki contiene múltiples ejemplos de decoradores.
@end table


@c ======================================================================

@node PEP 322 Iteración inversa,PEP 324 Nuevo módulo de subproceso,PEP 318 Decoradores para funciones y métodos,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-322-reverse-iteration}@anchor{1498}
@subsection PEP 322: Iteración inversa


Una nueva función de conjuntos integrados, @code{reversed(seq)} toma una secuencia y retorna un iterador que recorre los elementos de la secuencia en orden inverso.:

@example
>>> for i in reversed(xrange(1,4)):
...    print i
...
3
2
1
@end example

Comparado con el uso tradicional de la segmentación tal como @code{range(1,4)[::-1]} la  función @ref{8fc,,reversed()} es fácil de leer,  se ejecuta mas rápido y usa sustancialmente menos memoria.

Señalar que la función @ref{8fc,,reversed()} solo acepta secuencias, no iteradores arbitrarios. Si se quiere revertir un iterador, primero se debe convertir a una lista usando la función @ref{18e,,list()}.:

@example
>>> input = open('/etc/passwd', 'r')
>>> for line in reversed(list(input)):
...   print line
...
root:*:0:0:System Administrator:/var/root:/bin/tcsh
  ...
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 322

@item PEP 322@footnote{https://peps.python.org/pep-0322/} - Iteración inversa

Escrita e implementada por Raymond Hettinger.
@end table


@c ======================================================================

@node PEP 324 Nuevo módulo de subproceso,PEP 327 Tipo de dato decimal,PEP 322 Iteración inversa,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-324-new-subprocess-module}@anchor{1499}
@subsection PEP 324: Nuevo módulo de subproceso


The standard library provides a number of ways to execute a subprocess, offering
different features and different levels of complexity.
@code{os.system(command)} is easy to use, but slow (it runs a shell process
which executes the command) and dangerous (you have to be careful about escaping
the shell’s metacharacters).  The @code{popen2} module offers classes that can
capture standard output and standard error from the subprocess, but the naming
is confusing.  The @ref{d6,,subprocess} module cleans  this up, providing a unified
interface that offers all the features you might need.

Instead of @code{popen2}’s collection of classes, @ref{d6,,subprocess} contains a
single class called @ref{301,,subprocess.Popen}  whose constructor supports a number of
different keyword arguments.

@example
class Popen(args, bufsize=0, executable=None,
            stdin=None, stdout=None, stderr=None,
            preexec_fn=None, close_fds=False, shell=False,
            cwd=None, env=None, universal_newlines=False,
            startupinfo=None, creationflags=0):
@end example

`args' es comúnmente una secuencia de cadenas de caracteres que podrán ser los argumentos del programa ejecutado como un subproceso. (Si el argumento `shell' es verdadero, `args' puede ser una cadena de caracteres que serán pasados directamente a la shell para su interpretación, tal como @ref{149a,,os.system()} lo hace.)

`stdin', `stdout', y `stderr' especifican que flujos de entrada, salida y error serán utilizados. Se puede proceder un objeto de archivo o un archivo de descripción o se puede usar la constante @code{subprocess.PIPE} para crear un enlace entre el subproceso y el proceso principal.

@geindex nuevas líneas universales;Qué hay de nuevo

El constructor tiene un número de opciones útiles:


@itemize *

@item 
`close_fds' requiere que todos los descriptores de archivos sean cerrados antes de correr el subproceso.

@item 
`cwd'  especifica el directorio operativo donde el subproceso será ejecutado (por defecto, cualquiera que sea el directorio principal)

@item 
`env'  es un diccionario donde se especifican las variables de entorno.

@item 
`preexec_fn' es una función que es llamada antes de que el proceso hijo sea llamado.

@item 
`universal_newlines' abre el flujo de entrada y salida del hijo usando la característica de Python @ref{dc1,,universal newlines} .
@end itemize

Una vez que se ha creado la instancia de la @code{Popen}  se puede llamar al método @code{wait()} para poner en pausa hasta que el subproceso ha terminado, el método @code{poll()} comprueba si se ha salido sin pausar o el uso de @code{communicate(data)} envía la cadena de caracteres `data' a la entrada estándar del subproceso. Y el uso de @code{communicate(data)} que lee cualquier dato que el subproceso ha enviado a la salida estándar, retornando una tupla @code{(stdout_data, stderr_data)}.

@code{call()} es un atajo que pasa estos argumentos a lo largo del constructor de la clase @code{Popen}, espera por el comando para completar la secuencia y retorna el código de estatus del subproceso. Esto puede servir como un análogo mas seguro de @ref{149a,,os.system()}:

@example
sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
if sts == 0:
    # Success
    ...
else:
    # dpkg returned an error
    ...
@end example

El comando es invocado sin el uso del interprete de comandos. Si se desea usar el intérprete se puede agregar @code{shell=True} como un argumento de palabra clave y proveer una cadena de caracteres en vez de una secuencia:

@example
sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
@end example

La guía de estilo de Python toma varios ejemplos de línea de comandos y código python y muestra como estos son traducidos en el código python @ref{d6,,subprocess}. Leer esta sección de la guía de estilo es altamente recomendado.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 324

@item PEP 324@footnote{https://peps.python.org/pep-0324/} - subprocess - Nuevo módulo de procesos

Escrito e implementado por Peter Åstrand, con asistencia de Frederik Lundh y otros.
@end table


@c ======================================================================

@node PEP 327 Tipo de dato decimal,PEP 328 Importaciones multilínea,PEP 324 Nuevo módulo de subproceso,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-327-decimal-data-type}@anchor{149b}
@subsection PEP 327: Tipo de dato decimal


Python siempre ha soportado números de punto flotante (FP), basados ​​en el tipo subyacente C double, como un tipo de datos. Sin embargo, aunque la mayoría de los lenguajes de programación proporcionan un tipo de punto flotante, muchas personas (incluso los programadores) no saben que los números de punto flotante no representan ciertas fracciones decimales con precisión. El nuevo tipo @code{Decimal} puede representar estas fracciones con precisión, hasta un límite de precisión especificado por el usuario.

@menu
* ¿Por qué se necesita Decimal?:: 
* El tipo de clase Decimal:: 
* El tipo de clase Context:: 

@end menu

@node ¿Por qué se necesita Decimal?,El tipo de clase Decimal,,PEP 327 Tipo de dato decimal
@anchor{whatsnew/2 4 why-is-decimal-needed}@anchor{149c}
@subsubsection ¿Por qué se necesita Decimal?


Las limitaciones surgen de la representación usada para los números de punto flotante. Los números de punto flotante están hechos de tres componentes:


@itemize *

@item 
El signo, el cual es positivo o negativo.

@item 
El significando o mantisa el cual es el un dígito binario seguido de su parte fraccional. Por ejemplo, @code{1.01} en notación base 2 es @code{1 + 0/2 + 1/4} o 1.25 en notación decimal.

@item 
El exponente, que indica dónde se encuentra el punto decimal en el número representado.
@end itemize

Por ejemplo, el número 1.25 tiene un signo positivo, una mantisa de valor 1.01 (en binario) y un exponente de 0 (el punto decimal no necesita ser desplazado. El números 5 tiene el mismo signo y significando pero, el exponente es 2 porque el significando es multiplicado por 4 (2 elevado a la potencia del exponente 2), 1.25 * 4 es igual a 5.

Los sistemas modernos generalmente brindan soporte de coma flotante que se ajusta a un estándar llamado IEEE 754. El tipo double de C generalmente se implementa como un número IEEE 754 de 64 bits, que usa 52 bits de espacio para la mantisa. Esto significa que los números solo se pueden especificar con 52 bits de precisión. Si está tratando de representar números cuya expansión se repite sin cesar, la expansión se corta después de 52 bits. Desafortunadamente, la mayoría del software necesita producir resultados en base 10, y las fracciones comunes en base 10 a menudo son decimales repetidos en binario. Por ejemplo, 1.1 decimal es binario @code{1.0001100110011 ...}; .1 = 1/16 + 1/32 + 1/256 más un número infinito de términos adicionales. IEEE 754 tiene que cortar ese decimal repetido infinitamente después de 52 dígitos, por lo que la representación es un poco inexacta.

Algunas veces se puede ver esta inexactitud cuando el número es impreso por pantalla:

@example
>>> 1.1
1.1000000000000001
@end example

La inexactitud no siempre es visible cuando se imprime el número porque el punto flotante a decimal y conversión a cadena de texto es entregada por la librería C y la mayoría de las librerías C tratan de producir una salida sensible. Incluso si no es mostrado, la inexactitud sigue ahí y las operaciones subsecuentes pueden agrandar el error.

Para muchas aplicaciones esto no importa. Si estoy trazando puntos y mostrándolos en el monitor la diferencia entre 1.1 y 1.1000000000000001 es muy pequeña para ser visible.  Los reportes a menudo limitan la salida de un cierto número de decimales y si se redondea el número a dos o tres e incluso a 8 decimales, el error nunca aparece. Sin embargo, para las aplicaciones donde esto importa, es una cantidad de trabajo importante el personalizar los cálculos aritméticos.

Es por eso que el tipo de clase @code{Decimal} fue creada.

@node El tipo de clase Decimal,El tipo de clase Context,¿Por qué se necesita Decimal?,PEP 327 Tipo de dato decimal
@anchor{whatsnew/2 4 the-decimal-type}@anchor{149d}
@subsubsection El tipo de clase @code{Decimal}


Un nuevo módulo, @ref{37,,decimal}, fue añadido a la librería estándar de Python. Esta contiene dos clases, @code{Decimal} y @code{Context}. Las instancias de la clase decimal @code{Decimal} representan números y la instancia de la @code{Context} son usadas para condensar varios ajustes como la precisión y el modo de redondeo por defecto.

Las instancias de la clase @code{Decimal} son inmutables como los números enteros y números de punto flotante en Python, una vez han sido creadas no se puede cambiar el valor de lo que la instancia representa. Las instancias de la @code{Decimal} pueden ser creados desde números enteros o cadenas de texto:

@example
>>> import decimal
>>> decimal.Decimal(1972)
Decimal("1972")
>>> decimal.Decimal("1.1")
Decimal("1.1")
@end example

También se pueden proveer tuplas que contentan el signo, la mantisa representada como una tupla de números decimales y el exponente:

@example
>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
Decimal("-14.75")
@end example

Precaución: El signo bit es un valor booleano entonces 0 es positivo y 1 es negativo.

Convertir desde números de punto flotante posee un pequeño problema, el punto flotante representa 1.1 y se convierte en número decimal como 1.1 o por 1.1 mas cualquier inexactitud que se introduzca? La decisión fue evitar el problema y dejar tal conversión fuera de la API. En su lugar se debe convertir el número de punto flotante en una cadena con la precisión deseada y pasar la cadena al constructor @code{Decimal} :

@example
>>> f = 1.1
>>> decimal.Decimal(str(f))
Decimal("1.1")
>>> decimal.Decimal('%.12f' % f)
Decimal("1.100000000000")
@end example

Una vez que se tiene la instancia de la clase @code{Decimal} se pueden realizar las operaciones matemáticas de rigor. Una limitación, la exponenciación requiere un exponente expresado en tipo de dato entero:

@example
>>> a = decimal.Decimal('35.72')
>>> b = decimal.Decimal('1.73')
>>> a+b
Decimal("37.45")
>>> a-b
Decimal("33.99")
>>> a*b
Decimal("61.7956")
>>> a/b
Decimal("20.64739884393063583815028902")
>>> a ** 2
Decimal("1275.9184")
>>> a**b
Traceback (most recent call last):
  ...
decimal.InvalidOperation: x ** (non-integer)
@end example

Se puede combinar la instancia de la clase @code{Decimal} con enteros pero no con números de punto flotante:

@example
>>> a + 4
Decimal("39.72")
>>> a + 4.5
Traceback (most recent call last):
  ...
TypeError: You can interact Decimal only with int, long or Decimal data types.
>>>
@end example

Los números en la clase @code{Decimal} pueden ser usados con los módulos @ref{8e,,math} y @ref{19,,cmath} pero es preciso aclarar que ellos serán inmediatamente convertidos a números de punto flotante antes de realizar la operación, resultando en una posible perdida de precisión y exactitud. También obtendrá un número de punto flotante y no una clase @code{Decimal}:

@example
>>> import math, cmath
>>> d = decimal.Decimal('123456789012.345')
>>> math.sqrt(d)
351364.18288201344
>>> cmath.sqrt(-d)
351364.18288201344j
@end example

Las instancias de la clase @code{Decimal} poseen un método @code{sqrt()} que retorna una clase @code{Decimal} pero si se necesita otro tipo de cosas como funciones trigonométricas se tendrían que implementar:

@example
>>> d.sqrt()
Decimal("351364.1828820134592177245001")
@end example

@node El tipo de clase Context,,El tipo de clase Decimal,PEP 327 Tipo de dato decimal
@anchor{whatsnew/2 4 the-context-type}@anchor{149e}
@subsubsection El tipo de clase @code{Context}


Las instancias de la @code{Context} encapsulan varios ajustes para operaciones con decimales:


@itemize *

@item 
atributo @code{prec} es la precisión del número de decimales.

@item 
El atributo @code{rounding} especifica el modo de redondeo. El módulo @ref{37,,decimal} tiene constantes para varias posibilidades, @code{ROUND_DOWN}, @code{ROUND_CEILING},  @code{ROUND_HALF_EVEN} y varias otras.

@item 
El atributo @code{traps} es un diccionario que especifica lo que sucede al encontrar ciertas condiciones de error: Ya sea una excepción lanzada o un valor es retornado. algunos ejemplos de errores son las divisiones por cero, perdida de precisión o desbordamiento.
@end itemize

Hay un contexto predeterminado local de subprocesos disponible llamando a la función @code{getcontext()}, se puede cambiar las propiedades de este contexto para alterar la precisión por defecto, redondear o manejar trampas. el siguiente ejemplo muestra el efecto de cambiar la precisión del contexto por defecto:

@example
>>> decimal.getcontext().prec
28
>>> decimal.Decimal(1) / decimal.Decimal(7)
Decimal("0.1428571428571428571428571429")
>>> decimal.getcontext().prec = 9
>>> decimal.Decimal(1) / decimal.Decimal(7)
Decimal("0.142857143")
@end example

Las acciones por defecto para condiciones de error se puede seleccionar, ya sea que el módulo pueda retornar un valor especial como un infinito o un valor no numérico NaN o se pueden lanzar excepciones:

@example
>>> decimal.Decimal(1) / decimal.Decimal(0)
Traceback (most recent call last):
  ...
decimal.DivisionByZero: x / 0
>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
>>> decimal.Decimal(1) / decimal.Decimal(0)
Decimal("Infinity")
>>>
@end example

La instancia de la clase @code{Context} también tiene varios métodos para formatear números tales como @code{to_eng_string()} y @code{to_sci_string()}.

Para mas información, revisar la documentación para el módulo @ref{37,,decimal} el cual incluye un tutoría de inicio rápido y una referencia.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 327

@item PEP 327@footnote{https://peps.python.org/pep-0327/} - Tipo de dato decimal

Escrito por Facundo Batista e implementado por Facundo Batista, Eric Price, Raymond Hettinger, Aahz y Tim Peters.

@item http://www.lahey.com/float.htm@footnote{https://web.archive.org/web/20230604072523/http://www.lahey.com/float.htm}

El articulo usa código Fortran para ilustrar varios de los problemas que la inexactitud de los puntos flotantes pueden causar.

@item @indicateurl{https://speleotrove.com/decimal/}

Una descripción de una representación basada en decimales. Esta representación ha sido propuesta como un estándar y subyace al nuevo tipo de dato decimal en Python. La mayor parte de este material fue escrita por Mike Cowlishaw, diseñador del lenguaje Rexx.
@end table


@c ======================================================================

@node PEP 328 Importaciones multilínea,PEP 331 Conversiones locales-independientes números flotantes/cadenas de texto,PEP 327 Tipo de dato decimal,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-328-multi-line-imports}@anchor{149f}
@subsection PEP 328: Importaciones multilínea


Un pequeño cambio en el lenguaje ha sido una modificación a una sintaxis confusa que ha sido cambiada para hacer mas fácil el agregar varios nombres en un módulo. En una declaración @code{from module import names}, `names' es una secuencia de nombres separados por comas. Si la sentencia es muy larga, se puede ya sea escribir múltiples sentencias import desde el mismo módulo o se pueden usar barras invertidas para escapar de los términos de línea como esto:

@example
from SimpleXMLRPCServer import SimpleXMLRPCServer,\
            SimpleXMLRPCRequestHandler,\
            CGIXMLRPCRequestHandler,\
            resolve_dotted_attribute
@end example

La sintaxis cambió en Python 2.4 y es simplemente el permitir poner los nombres dentro de paréntesis. Python ignora nuevas líneas dentro de una expresión entre paréntesis por lo que las barras invertidas ya no se necesitan:

@example
from SimpleXMLRPCServer import (SimpleXMLRPCServer,
                                SimpleXMLRPCRequestHandler,
                                CGIXMLRPCRequestHandler,
                                resolve_dotted_attribute)
@end example

La convención de estilo también propone que todas las declaraciones usando  @ref{682,,import} son importaciones absolutas, con el siguiente carácter @code{.} indica una importación relativa. Esta parte de la convención de estilo no fue implementada para Python 2.4 pero fue completada para la versión 2.5.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - Importaciones multi línea y absolutas/relativas

Escrita por Aahz.  Importaciones multi línea fueron implementadas por Dima Dorfman.
@end table


@c ======================================================================

@node PEP 331 Conversiones locales-independientes números flotantes/cadenas de texto,Otros cambios en el lenguaje<4>,PEP 328 Importaciones multilínea,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 pep-331-locale-independent-float-string-conversions}@anchor{14a0}
@subsection PEP 331: Conversiones locales-independientes números flotantes/cadenas de texto


Los módulos @ref{86,,locale} deja que el software de Python seleccione varias conversiones y despliegue convenciones que están localizadas en un país particular o lenguaje. Sin embargo, el módulo es cuidadoso en no cambiar el local numérico porque la implementación de Python requería que la configuración regional numérica permaneciera establecida en la configuración regional @code{'C'} . A menudo, esto se debía a que el código utilizaba la función @code{atof()} de la biblioteca C.

No configurar la configuración regional numérica causaba problemas para las extensiones que usaban librerías externas de C, sin embargo, porque no configuraban la correcta configuración. El ejemplo mas patente fue GTK+, cuya interfaz de usuario no mostraba números en la ubicación actual.

La solución descrita en la convención de estilo es añadir tres nuevas funciones a la API de python que ejecuta solo conversiones a ASCII, ignorando las configuraciones locales:


@itemize *

@item 
@code{PyOS_ascii_strtod(str, ptr)} y @code{PyOS_ascii_atof(str, ptr)} convierten una cadena en C double.

@item 
@code{PyOS_ascii_formatd(buffer, buf_len, format, d)} convierte un double en una cadena ASCII.
@end itemize

The code for these functions came from the GLib library
(https://developer-old.gnome.org/glib/2.26/@footnote{http://web.archive.org/web/20210306104320/https://developer.gnome.org/glib/2.26/}), whose developers kindly
relicensed the relevant functions and donated them to the Python Software
Foundation.  The @ref{86,,locale} module  can now change the numeric locale,
letting extensions such as GTK+  produce the correct results.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 331

@item PEP 331@footnote{https://peps.python.org/pep-0331/} Conversiones Local-Independiente flotante/cadena de texto

Escrito por Christian R. Reis, e implementado por Gustavo Carneiro.
@end table


@c ======================================================================

@node Otros cambios en el lenguaje<4>,Módulos nuevos mejorados y obsoletos<3>,PEP 331 Conversiones locales-independientes números flotantes/cadenas de texto,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 other-language-changes}@anchor{14a1}
@subsection Otros cambios en el lenguaje


Aquí están todos los cambios que Python 2.4 ha hecho al core del lenguaje Python.


@itemize *

@item 
Fueron añadidos decoraciones para funciones (
@geindex Python Enhancement Proposals; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/}).

@item 
Funciones de conjuntos integrados @ref{67a,,set()} y @ref{67b,,frozenset()} fueron añadidas (
@geindex Python Enhancement Proposals; PEP 218
PEP 218@footnote{https://peps.python.org/pep-0218/}). Otras nuevas funciones de conjuntos integrados incluyen la función @code{reversed(seq)} (
@geindex Python Enhancement Proposals; PEP 322
PEP 322@footnote{https://peps.python.org/pep-0322/}).

@item 
Generador de expresiones fueron añadidas (
@geindex Python Enhancement Proposals; PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/}).

@item 
Algunas expresiones numéricas ya no retornan valores restringidos a 32 o 64 bits (
@geindex Python Enhancement Proposals; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}).

@item 
Se puede poner entre paréntesis una lista de nombres en la declaración @code{from module import names} (
@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/}).

@item 
El método @ref{14a2,,dict.update()} ahora acepta el mismo argumento que el constructor de la @ref{190,,dict}. Esto incluye cualquier tipo de mapeo, iterable pares de clave/valor y argumentos de palabra clave. (Contribución de Raymond Hettinger)

@item 
Los métodos de cadena de caracteres @code{ljust()}, @code{rjust()} y @code{center()} ahora toman un argumento de tipo opcional para especificar un carácter de relleno que no sea un espacio. (Contribución de Raymond Hettinger).

@item 
Cadenas de caracteres también han ganado un método @code{rsplit()} que funciona como el método @code{split()} pero divide desde el final de la cadena de caracteres. (Contribución de Sean Reifschneider)

@example
>>> 'www.python.org'.split('.', 1)
['www', 'python.org']
'www.python.org'.rsplit('.', 1)
['www.python', 'org']
@end example

@item 
Tres parámetros de argumentos de palabra clave `cmp', `key' y `reverse' fueron añadidos al método de listas @code{sort()}. Estos parámetros hacen algunos usos comunes del método @code{sort()} mas simple. Todos estos parámetros son opcionales.

Para el parámetro `cmp'  el valor debe ser una función comparativa que toma dos parámetros y retorna -1, 0 o + 1 dependiendo de como compare los parámetros. Esta función será usada para ordenar la lista. Previamente esto era el único parámetro que podía ser entregado al @code{sort()}.

`key' debe ser una función con un solo parámetro que toma un elemento de la lista y retorna una llave de comparación para el elemento. Entonces la lista es ordenado usando las claves de comparación. El siguiente ejemplo ordena una lista sin distinción de mayúsculas ni minúsculas:

@example
>>> L = ['A', 'b', 'c', 'D']
>>> L.sort()                 # Case-sensitive sort
>>> L
['A', 'D', 'b', 'c']
>>> # Using 'key' parameter to sort list
>>> L.sort(key=lambda x: x.lower())
>>> L
['A', 'b', 'c', 'D']
>>> # Old-fashioned way
>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
>>> L
['A', 'b', 'c', 'D']
@end example

El ultimo ejemplo el cual usa el parámetro `cmp'  es la antigua forma de ejecutar el orden sin distinción de mayúsculas y minúsculas. Funciona pero es mas lento en vez de usar el parámetro `key'.  El uso de `key' llama al método @code{lower()} una vez para cada elemento de la lista mientras el uso de `cmp' lo llamara dos veces para cada comparación, entonces al usar * key * se guardan las llamadas del método @code{lower()}.

Para funciones de clave sencillas y comparativas es a menudo posible el obviar la palabra clave @ref{1309,,lambda} usando un método sin ligar en reemplazo. El siguiente ejemplo de orden sin importar mayúsculas ni minúsculas es mejor escrito como se muestra:

@example
>>> L.sort(key=str.lower)
>>> L
['A', 'b', 'c', 'D']
@end example

Finalmente el parámetro `reverse' toma un valor de tipo booleano. Si el valor es verdadero la lista será ordenada de forma inversa. En vez de @code{L.sort(); L.reverse()} ahora se puede escribir @code{L.sort(reverse=True)}.

Los resultados del ordenamiento ahora están garantizados que son estables. Esto significa que dos entradas con iguales claves serán retiradas en el mismo orden en que fueron ingresadas. Por ejemplo se puede ordenar una lista de personas por el nombre y entonces ordenarla por edad, resultando en una lista ordenada donde las personas con la misma edad están en el mismo orden por nombre.

(Todos los cambios al método @code{sort()} fueron realizados por Raymond Hettinger.)

@item 
Se tiene una nueva función incorporada @code{sorted(iterable)} que trabaja como el método in situ @ref{c57,,list.sort()} que se puede usar en expresiones. Las diferencias son:

@item 
el dato de entrada puede ser algún iterable;

@item 
se ordena una copia recién formada, manteniendo el original intacto y

@item 
la expresión retorna una nueva copia ordenada

@example
>>> L = [9,7,8,3,2,4,1,6,5]
>>> [10+i for i in sorted(L)]       # usable in a list comprehension
[11, 12, 13, 14, 15, 16, 17, 18, 19]
>>> L                               # original is left unchanged
[9,7,8,3,2,4,1,6,5]
>>> sorted('Monty Python')          # any iterable may be an input
[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']

>>> # List the contents of a dict sorted by key values
>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
>>> for k, v in sorted(colormap.iteritems()):
...     print k, v
...
black 4
blue 2
green 3
red 1
yellow 5
@end example

(Contribución de Raymond Hettinger.)

@item 
Operaciones de números enteros no lanzaran una excepción @code{OverflowWarning}. La advertencia sobre @code{OverflowWarning} desaparecerá en Python 2.5.

@item 
Se añadió al interprete una nueva opción de cambio @ref{187,,-m} la cual toma un nombre, busca el módulo correspondiente en @code{sys.path} y corre el módulo como script. Ahora por ejemplo se puede correr el perfilador de Python con @code{python -m profile}. (Contribución de Nick Coghlan)

@item 
La expresión @code{eval(expr, globals, locals)} la función @code{execfile(filename, globals, locals)} y la sentencia @code{exec} ahora aceptan cualquier tipo de mapeo para parámetros locales. Previamente esto era parte de un diccionario de Python. (Contribución de Raymond Hettinger.)

@item 
La función incorporada @ref{14d,,zip()} y la función @code{itertools.izip()} ahora retornan una lista hacia si se llama sin argumentos. Previamente estos lanzaban una excepción de tipo @ref{228,,TypeError}. Esto lo hace mas apropiado de usar con listas de argumentos de longitud variable:

@example
>>> def transpose(array):
...    return zip(*array)
...
>>> transpose([(1,2,3), (4,5,6)])
[(1, 4), (2, 5), (3, 6)]
>>> transpose([])
[]
@end example

(Contribución de Raymond Hettinger.)

@item 
Encontrar un error al importar un módulo ya no deja un objeto de módulo parcialmente inicializado en @code{sys.modules}. El objeto de módulo incompleto que se deja atrás engañaría a las importaciones posteriores del mismo módulo para que tuvieran éxito, lo que generaría errores confusos. (Reparado por Tim Peters.)

@item 
@code{None`es ahora una constante, el código que une un nuevo valor con el nombre :const:`None} es ahora un error de sintaxis (Contribución de Raymond Hettinger)
@end itemize

@c ======================================================================

@menu
* Optimizaciones: Optimizaciones<14>. 

@end menu

@node Optimizaciones<14>,,,Otros cambios en el lenguaje<4>
@anchor{whatsnew/2 4 optimizations}@anchor{14a3}
@subsubsection Optimizaciones



@itemize *

@item 
Los bucles internos para separar listas y tuplas fueron optimizados y ahora corren un tercio mas rápido. Los bucles internos para diccionarios también fueron optimizados resultando en una mejora en el rendimiento para @code{keys()}, @code{values()}, @code{items()}, @code{iterkeys()}, @code{itervalues()}, y @code{iteritems()}. (Contribución de Raymond Hettinger)

@item 
El mecanismo para mejorar y contraer listas fue optimizada  para efectos de velocidad y eficiencia en la utilización de recursos. Anexar y quitar elementos de una lista es ahora mas rápido debido al código mas eficiente y al menos frecuente uso de la función subyacente  @code{realloc()}. Las listas por comprensión también son beneficiadas, el método @code{list.extend()} fue también optimizado y ya no convierte mas el argumento en una lista temporal antes de extender la lista base. (Contribución de Raymond Hettinger)

@item 
Las funciones @ref{18e,,list()}, @ref{464,,tuple()}, @ref{14c,,map()}, @ref{8fb,,filter()} y @ref{14d,,zip()} ahora corren mucho mas rápido con argumentos no secuenciales que ahora suministra el método @code{__len__()}. (Contribución Raymond Hettinger.)

@item 
Los métodos @code{list.__getitem__()}, @code{dict.__getitem__()} y @code{dict.__contains__()}  ahora son implementados como objetos de la clase @code{method_descriptor} en vez de los objetos de la clase @code{wrapper_descriptor} . Este acceso dobla el rendimiento y hace que sea mas apropiado para ser usado como argumentos de:@code{map(mydict.__getitem__, keylist)}. (Contribución de Raymond Hettinger)

@item 
Adicionalmente se ha agregado a un nuevo código de operación @code{LIST_APPEND} esto simplifica la generación de código a nivel de byte para las listas por comprensión y las agiliza en aproximadamente un tercio.

@item 
El optimizador de código a nivel de byte ha sido mejorado para producir código a nivel de byte mas corto y rápido. Esto resulta en código mas legible. (Contribución de Raymond Hettinger)

@item 
La concatenación de cadenas de texto en la declaración de @code{s = s + "abc"} and @code{s += "abc"} ahora son ejecutadas de forma mas eficiente en ciertas circunstancias. Esta optimizaciones no serán mostradas en otras implementaciones de Python tales como Python, entonces no se debe utilizar, es mejor seguir utilizando el método @code{join()} de cadenas de caracteres si se quiere mantener la eficiencia de concatenar un largo número de cadenas de caracteres. (Contribución de Armin Rigo.)
@end itemize

El resultado de las optimizaciones de la versión 2.4 es que tomando Python 2.4 como punto de referencia corre alrededor de un 5% mas rápido que Python 2.3 y un 35% mas rápido que Python 2.2 (pystone no es particularmente un buen punto de referencia pero es el mas usado para medir rendimiento en Python. Sus propias aplicaciones pueden mostrar beneficios mas grandes o mínimos desde Python 2.4)

@c pystone is almost useless for comparing different versions of Python;
@c instead, it excels at predicting relative Python performance on different
@c machines.  So, this section would be more informative if it used other tools
@c such as pybench and parrotbench.  For a more application oriented benchmark,
@c try comparing the timings of test_decimal.py under 2.3 and 2.4.

@c ======================================================================

@node Módulos nuevos mejorados y obsoletos<3>,Cambios en la API de Build y C<2>,Otros cambios en el lenguaje<4>,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 new-improved-and-deprecated-modules}@anchor{14a4}
@subsection Módulos nuevos, mejorados y obsoletos


Como es usual, la librería estándar de Python recibió un número de mejoras y corrección de errores. Aquí hay una lista parcial de los cambios mas notables, ordenados alfabéticamente por nombre de módulo. Consulte el archivo @code{Misc/NEWS} en la estructura del directorio para una completa lista de los cambios o se puede buscar a través del registro CVS para obtener todos los detalles.


@itemize *

@item 
The @code{asyncore} module’s @code{loop()} function now has a `count' parameter
that lets you perform a limited number of passes through the polling loop.  The
default is still to loop forever.

@item 
El módulo @ref{f,,base64} ahora tiene un soporte mas completo 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html} para Base64, Base32 y  Base16 para codificación y descodificación, incluyendo procesos de convertir caracteres a minúsculas y alfabetos alternativos. (Contribución de Barry Warsaw)

@item 
El módulo @ref{12,,bisect} ahora tiene una implementación C subyacente para mejorar el rendimiento. (Contribuido por Dmitry Vasiliev.)

@item 
Las colecciones CJKCodecs de códecs de Asia oriental, mantenidas por Hye-Shik Chang, se integraron en 2.4. Las nuevas codificaciones son:

@item 
Chino (PRC): gb2312, gbk, gb18030, big5hkscs, hz

@item 
Chino (República de China): big5, cp950

@item 

@table @asis

@item Japonés: cp932, euc-jis-2004, euc-jp, euc-jisx0213, iso-2022-jp,

iso-2022-jp-1, iso-2022-jp-2, iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004, shift-jis, shift-jisx0213, shift- jis-2004
@end table

@item 
Coreano: cp949, euc-kr, johab, iso-2022-kr

@item 
Se agregaron algunas otras codificaciones nuevas: HP Roman8, ISO_8859-11, ISO_8859-16, PCTP-154 y TIS-620.

@item 
Los códecs UTF-8 y UTF-16 ahora se adaptan mejor a la recepción de entradas parciales. Anteriormente, la clase @code{StreamReader} intentaba leer más datos, lo que hacía imposible reanudar la decodificación desde el flujo. El método @code{read()} ahora devolverá tantos datos como pueda y las llamadas futuras reanudarán la decodificación donde lo dejaron las anteriores. (Implementado por Walter Dörwald.)

@item 
Hay un nuevo módulo @ref{1e,,collections} para varios tipos de datos de recopilación especializados. Actualmente contiene solo un tipo, @code{deque}, una cola de dos extremos que admite la adición y eliminación de elementos de manera eficiente desde cualquier extremo:

@example
>>> from collections import deque
>>> d = deque('ghi')        # make a new deque with three items
>>> d.append('j')           # add a new entry to the right side
>>> d.appendleft('f')       # add a new entry to the left side
>>> d                       # show the representation of the deque
deque(['f', 'g', 'h', 'i', 'j'])
>>> d.pop()                 # return and remove the rightmost item
'j'
>>> d.popleft()             # return and remove the leftmost item
'f'
>>> list(d)                 # list the contents of the deque
['g', 'h', 'i']
>>> 'h' in d                # search the deque
True
@end example

Varios módulos, como los módulos @code{Queue} y @ref{ed,,threading}, ahora aprovechan @ref{67d,,collections.deque} para mejorar el rendimiento. (Contribuido por Raymond Hettinger.)

@item 
The @ref{23,,ConfigParser} classes have been enhanced slightly. The @ref{14a5,,read()}
method now returns a list of the files that were successfully parsed, and the
@ref{12da,,set()} method raises @ref{228,,TypeError} if passed a `value' argument that
isn’t a string.   (Contributed by John Belmonte and David Goodger.)

@item 
El módulo @ref{2c,,curses} ahora admite la extensión ncurses @code{use_default_colors()}. En plataformas donde el terminal admite transparencia, esto permite utilizar un fondo transparente. (Contribución de Jörg Lehmann.)

@item 
El módulo @ref{38,,difflib} ahora incluye una clase @code{HtmlDiff} que crea una tabla HTML que muestra una comparación lado a lado de dos versiones de un texto. (Contribuido por Dan Gass.)

@item 
El paquete @ref{3c,,email} se actualizó a la versión 3.0, que eliminó varias API obsoletas y elimina la compatibilidad con versiones de Python anteriores a la 2.3. La versión 3.0 del paquete usa un nuevo analizador incremental para mensajes MIME, disponible en el módulo @code{email.FeedParser}. El nuevo analizador no requiere leer todo el mensaje en la memoria y no genera excepciones si un mensaje tiene un formato incorrecto; en su lugar, registra cualquier problema en el atributo @code{defect} del mensaje. (Desarrollado por Anthony Baxter, Barry Warsaw, Thomas Wouters y otros).

@item 
El módulo @ref{69,,heapq} se ha convertido a C. La mejora de diez veces resultante en la velocidad hace que el módulo sea adecuado para manejar grandes volúmenes de datos. Además, el módulo tiene dos funciones nuevas @code{nlargest()} y @code{nsmallest()} que usan montones para encontrar los N valores más grandes o más pequeños en un conjunto de datos sin el gasto de una clasificación completa. (Contribuido por Raymond Hettinger.)

@item 
The @ref{6e,,httplib} module now contains constants for HTTP status codes defined
in various HTTP-related RFC documents.  Constants have names such as
@code{OK}, @code{CREATED}, @code{CONTINUE}, and
@code{MOVED_PERMANENTLY}; use pydoc to get a full list.  (Contributed by
Andrew Eland.)

@item 
El módulo @ref{74,,imaplib} ahora es compatible con el comando THREAD de IMAP (aportado por Yves Dionne) y los nuevos métodos @code{deleteacl()} y @code{myrights()} (aportado por Arnaud Mazin).

@item 
El módulo @ref{81,,itertools} ganó una función @code{groupby(iterable[, *func*])}. El parámetro `iterable' is something that can be iterated over to return a stream of elements, and the optional `func' es una función que toma un elemento y devuelve un valor clave; si se omite, la clave es simplemente el elemento en sí. @code{groupby()} luego agrupa los elementos en subsecuencias que tienen valores coincidentes de la clave y devuelve una serie de 2 tuplas que contienen el valor de la clave y un iterador sobre la subsecuencia.

Aquí hay un ejemplo para aclarar esto. La función `key' simplemente devuelve si un número es par o impar, por lo que el resultado de @code{groupby()} es devolver series consecutivas de números pares o impares.

@example
>>> import itertools
>>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
...    print key_val, list(it)
...
0 [2, 4, 6]
1 [7]
0 [8]
1 [9, 11]
0 [12, 14]
>>>
@end example

@code{groupby()} se utiliza normalmente con entrada ordenada. La lógica para @code{groupby()} es similar al filtro Unix @code{uniq}, lo que lo hace útil para eliminar, contar o identificar elementos duplicados:

@example
>>> word = 'abracadabra'
>>> letters = sorted(word)   # Turn string into a sorted list of letters
>>> letters
['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
>>> for k, g in itertools.groupby(letters):
...    print k, list(g)
...
a ['a', 'a', 'a', 'a', 'a']
b ['b', 'b']
c ['c']
d ['d']
r ['r', 'r']
>>> # List unique letters
>>> [k for k, g in groupby(letters)]
['a', 'b', 'c', 'd', 'r']
>>> # Count letter occurrences
>>> [(k, len(list(g))) for k, g in groupby(letters)]
[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
@end example

(Contribuido por Hye-Shik Chang.)

@item 
@ref{81,,itertools} también obtuvo una función denominada @code{tee(iterator, N)} que devuelve `N' independent iterators that replicate `iterator'.  If `N' se omite, el valor predeterminado es 2.

@example
>>> L = [1,2,3]
>>> i1, i2 = itertools.tee(L)
>>> i1,i2
(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
>>> list(i1)               # Run the first iterator to exhaustion
[1, 2, 3]
>>> list(i2)               # Run the second iterator to exhaustion
[1, 2, 3]
@end example

Tenga en cuenta que @code{tee()} debe mantener copias de los valores devueltos por el iterador; en el peor de los casos, es posible que deba conservarlos todos. Por lo tanto, esto debe usarse con cuidado si el iterador principal puede ejecutarse muy por delante del iterador final en un flujo largo de entradas. Si la separación es grande, entonces también podría usar @ref{18e,,list()} en su lugar. Cuando los iteradores se siguen de cerca entre sí, @code{tee()} es ideal. Las posibles aplicaciones incluyen marcadores, ventanas o iteradores de anticipación. (Contribuido por Raymond Hettinger.)

@item 
A number of functions were added to the @ref{86,,locale}  module, such as
@code{bind_textdomain_codeset()} to specify a particular encoding and a family of
@code{l*gettext()} functions that return messages in the chosen encoding.
(Contributed by Gustavo Niemeyer.)

@item 
Se agregaron algunos argumentos de palabras clave a la función @code{basicConfig()} del paquete @ref{87,,logging} para simplificar la configuración del registro. El comportamiento predeterminado es registrar mensajes con error estándar, pero se pueden especificar varios argumentos de palabras clave para registrar en un archivo en particular, cambiar el formato de registro o establecer el nivel de registro. Por ejemplo:

@example
import logging
logging.basicConfig(filename='/var/log/application.log',
    level=0,  # Log all messages
    format='%(levelname):%(process):%(thread):%(message)')
@end example

Otras adiciones al paquete @ref{87,,logging} incluyen un método de conveniencia @code{log(level, msg)}, así como una clase @code{TimedRotatingFileHandler} que rota sus archivos de registro en un intervalo cronometrado. El módulo ya tenía @code{RotatingFileHandler}, que rotaba los registros una vez que el archivo excedía un cierto tamaño. Ambas clases derivan de una nueva clase @code{BaseRotatingHandler} que se puede utilizar para implementar otros controladores rotativos.

(Cambios implementados por Vinay Sajip.)

@item 
El módulo @ref{8d,,marshal} ahora comparte cadenas internas al desempaquetar una estructura de datos. Esto puede reducir el tamaño de ciertas cadenas de pickle, pero el efecto principal es hacer que los archivos @code{.pyc} sean significativamente más pequeños. (Contribución de Martin von Löwis.)

@item 
The @code{nntplib} module’s @code{NNTP} class gained @code{description()} and
@code{descriptions()} methods to retrieve  newsgroup descriptions for a single
group or for a range of groups. (Contributed by Jürgen A. Erhard.)

@item 
Se agregaron dos nuevas funciones al módulo @ref{9f,,operator}, @code{attrgetter(attr)} y @code{itemgetter(index)}. Ambas funciones devuelven invocables que toman un solo argumento y devuelven el atributo o elemento correspondiente; estos llamables son excelentes extractores de datos cuando se utilizan con @ref{14c,,map()} o @ref{c56,,sorted()}. Por ejemplo:

@example
>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
>>> map(operator.itemgetter(0), L)
['c', 'd', 'a', 'b']
>>> map(operator.itemgetter(1), L)
[2, 1, 4, 3]
>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
@end example

(Contribución de Raymond Hettinger.)

@item 
El módulo @ref{a0,,optparse} se actualizó de varias formas. El módulo ahora pasa sus mensajes a través de @ref{14a6,,gettext.gettext()}, lo que permite internacionalizar los mensajes de error y ayuda de Optik. Los mensajes de ayuda para las opciones ahora pueden incluir la cadena @code{'%default'}, que será reemplazada por el valor predeterminado de la opción. (Contribuido por Greg Ward.)

@item 
The long-term plan is to deprecate the @code{rfc822} module in some future
Python release in favor of the @ref{3c,,email} package. To this end, the
@ref{14a7,,email.Utils.formatdate} function has been changed to make it usable as a
replacement for @code{rfc822.formatdate()}.  You may want to write new e-mail
processing code with this in mind.  (Change implemented by Anthony Baxter.)

@item 
Se agregó una nueva función @code{urandom(n)} al módulo @ref{a1,,os}, que devuelve una cadena que contiene `n' bytes de datos aleatorios. Esta función proporciona acceso a fuentes de aleatoriedad específicas de la plataforma, como @code{/dev/urandom} en Linux o Windows CryptoAPI. (Contribuido por Trevor Perrin.)

@item 
Otra función nueva: @code{os.path.lexists(path)} devuelve verdadero si el archivo especificado por `path' exists, whether or not it’s a symbolic link.  This differs from the existing ASDF01 function, which returns false if `path' es un enlace simbólico que apunta a un destino que no existe. (Contribuido por Beni Cherniavsky.)

@item 
Se agregó una nueva función @code{getsid()} al módulo @ref{ad,,posix} que subyace al módulo @ref{a1,,os}. (Contribuido por J. Raynor.)

@item 
El módulo @ref{ac,,poplib} ahora admite POP sobre SSL. (Contribuido por Héctor Urtubia.)

@item 
El módulo @ref{af,,profile} ahora puede perfilar funciones de extensión C. (Contribuido por Nick Bastin.)

@item 
El módulo @ref{b8,,random} tiene un nuevo método llamado @code{getrandbits(N)} que devuelve un entero largo `N' bits de longitud. El método @code{randrange()} existente ahora usa @code{getrandbits()} cuando corresponde, lo que hace que la generación de números aleatorios arbitrariamente grandes sea más eficiente. (Contribuido por Raymond Hettinger.)

@item 
El lenguaje de expresiones regulares aceptado por el módulo @ref{b9,,re} se amplió con expresiones condicionales simples, escritas como @code{(?(group)A|B)}. En su lugar, se utilizará `group' is either a numeric group ID or a group name defined with ASDF02 earlier in the expression.  If the specified group matched, the regular expression pattern `A' will be tested against the string; if the group didn’t match, the pattern `B'. (Contribución de Gustavo Niemeyer.)

@item 
El módulo @ref{b9,,re} ya no es recursivo, gracias a la enorme cantidad de trabajo de Gustavo Niemeyer. En un motor de expresión regular recursivo, ciertos patrones dan como resultado que se consuma una gran cantidad de espacio de pila de C y es posible desbordar la pila. Por ejemplo, si comparó una cadena de 30000 bytes de caracteres @code{a} con la expresión @code{(a|b)+}, se consumió un marco de pila por carácter. Python 2.3 intentó verificar el desbordamiento de la pila y generar una excepción @ref{1e5,,RuntimeError}, pero ciertos patrones podrían eludir la verificación y, si no tuvo suerte, Python podría segregar. El motor de expresiones regulares de Python 2.4 puede coincidir con este patrón sin problemas.

@item 
El módulo @ref{c6,,signal} ahora realiza una verificación de errores más estricta en los parámetros de la función @ref{11a6,,signal.signal()}. Por ejemplo, no puede establecer un controlador en la señal @code{SIGKILL}; las versiones anteriores de Python aceptarían silenciosamente esto, pero 2.4 lanzará una excepción @ref{1e5,,RuntimeError}.

@item 
Se agregaron dos nuevas funciones al módulo @ref{cc,,socket}. @code{socketpair()} devuelve un par de sockets conectados y @code{getservbyport(port)} busca el nombre del servicio para un número de puerto determinado. (Contribuido por Dave Cole y Barry Warsaw.)

@item 
La función @code{sys.exitfunc()} ha quedado obsoleta. El código debe usar el módulo @ref{d,,atexit} existente, que maneja correctamente la llamada a múltiples funciones de salida. Finalmente, @code{sys.exitfunc()} se convertirá en una interfaz puramente interna, a la que solo accederá @ref{d,,atexit}.

@item 
El módulo @ref{de,,tarfile} ahora genera archivos tar en formato GNU de forma predeterminada. (Contribución de Lars Gustäbel.)

@item 
El módulo @ref{ed,,threading} ahora tiene una forma elegante y sencilla de admitir datos locales de subprocesos. El módulo contiene una clase @code{local} cuyos valores de atributo son locales para diferentes subprocesos.

@example
import threading

data = threading.local()
data.number = 42
data.url = ('www.python.org', 80)
@end example

Otros subprocesos pueden asignar y recuperar sus propios valores para los atributos @code{number} y @code{url}. Puede crear una subclase de @code{local} para inicializar atributos o agregar métodos. (Contribuido por Jim Fulton.)

@item 
El módulo @ref{ef,,timeit} ahora deshabilita automáticamente la recolección de basura periódica durante el ciclo de temporización. Este cambio hace que los tiempos consecutivos sean más comparables. (Contribuido por Raymond Hettinger.)

@item 
El módulo @ref{114,,weakref} ahora admite una variedad más amplia de objetos, incluidas funciones de Python, instancias de clases, conjuntos, frozensets, deques, matrices, archivos, sockets y objetos de patrones de expresión regular. (Contribuido por Raymond Hettinger.)

@item 
The @ref{12d,,xmlrpclib} module now supports a multi-call extension for
transmitting multiple XML-RPC calls in a single HTTP operation. (Contributed by
Brian Quinlan.)

@item 
Se han eliminado los módulos @code{mpz}, @code{rotor} y @code{xreadlines}.
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@c =====================

@menu
* cookielib:: 
* doctest: doctest<5>. 

@end menu

@node cookielib,doctest<5>,,Módulos nuevos mejorados y obsoletos<3>
@anchor{whatsnew/2 4 cookielib}@anchor{14a8}
@subsubsection cookielib


The @ref{70,,cookielib} library supports client-side handling for HTTP cookies,
mirroring the @ref{71,,Cookie} module’s server-side cookie support. Cookies are
stored in cookie jars; the library transparently stores cookies offered by the
web server in the cookie jar, and fetches the cookie from the jar when
connecting to the server. As in web browsers, policy objects control whether
cookies are accepted or not.

Para almacenar cookies entre sesiones, se proporcionan dos implementaciones de tarros de cookies: una que almacena cookies en formato Netscape para que las aplicaciones puedan usar los archivos de cookies de Mozilla o Lynx, y otra que almacena cookies en el mismo formato que la biblioteca libwww de Perl.

@ref{10b,,urllib2} has been changed to interact with @ref{70,,cookielib}:
@code{HTTPCookieProcessor} manages a cookie jar that is used when accessing
URLs.

Este módulo fue una contribución de John J. Lee.

@c ==================

@node doctest<5>,,cookielib,Módulos nuevos mejorados y obsoletos<3>
@anchor{whatsnew/2 4 doctest}@anchor{14a9}
@subsubsection doctest


El módulo @ref{3b,,doctest} se sometió a una refactorización considerable gracias a Edward Loper y Tim Peters. Las pruebas pueden ser tan simples como ejecutar @ref{14aa,,doctest.testmod()}, pero las refactorizaciones permiten personalizar el funcionamiento del módulo de varias formas.

La nueva clase @code{DocTestFinder} extrae las pruebas de las cadenas de documentos de un objeto dado:

@example
def f (x, y):
    """>>> f(2,2)
4
>>> f(3,2)
6
    """
    return x*y

finder = doctest.DocTestFinder()

# Get list of DocTest instances
tests = finder.find(f)
@end example

La nueva clase @code{DocTestRunner} luego ejecuta pruebas individuales y puede producir un resumen de los resultados:

@example
runner = doctest.DocTestRunner()
for t in tests:
    tried, failed = runner.run(t)

runner.summarize(verbose=1)
@end example

El ejemplo anterior produce la siguiente salida:

@example
1 items passed all tests:
   2 tests in f
2 tests in 1 items.
2 passed and 0 failed.
Test passed.
@end example

@code{DocTestRunner} usa una instancia de la clase @code{OutputChecker} para comparar la salida esperada con la salida real. Esta clase toma varios indicadores diferentes que personalizan su comportamiento; Los usuarios ambiciosos también pueden escribir una subclase completamente nueva de @code{OutputChecker}.

El comprobador de salida predeterminado proporciona una serie de funciones útiles. Por ejemplo, con el indicador de opción @ref{14ab,,doctest.ELLIPSIS}, una elipsis (@code{...}) en la salida esperada coincide con cualquier subcadena, lo que facilita la adaptación de salidas que varían en formas menores:

@example
def o (n):
    """>>> o(1)
<__main__.C instance at 0x...>
>>>
"""
@end example

Otra cadena especial, @code{<BLANKLINE>}, coincide con una línea en blanco:

@example
def p (n):
    """>>> p(1)
<BLANKLINE>
>>>
"""
@end example

Otra nueva capacidad es producir una visualización de estilo diff de la salida especificando @ref{14ac,,doctest.REPORT_UDIFF} (diferencias unificadas), @ref{14ad,,doctest.REPORT_CDIFF} (diferencias de contexto), o @ref{14ae,,doctest.REPORT_NDIFF} Indicadores de opción (estilo delta). Por ejemplo:

@example
def g (n):
    """>>> g(4)
here
is
a
lengthy
>>>"""
    L = 'here is a rather lengthy list of words'.split()
    for word in L[:n]:
        print word
@end example

Al ejecutar las pruebas de la función anterior con @ref{14ac,,doctest.REPORT_UDIFF} especificado, obtiene el siguiente resultado:

@example
**********************************************************************
File "t.py", line 15, in g
Failed example:
    g(4)
Differences (unified diff with -expected +actual):
    @@@@ -2,3 +2,3 @@@@
     is
     a
    -lengthy
    +rather
**********************************************************************
@end example

@c ======================================================================

@node Cambios en la API de Build y C<2>,Portar a Python 2 4,Módulos nuevos mejorados y obsoletos<3>,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 build-and-c-api-changes}@anchor{14af}
@subsection Cambios en la API de Build y C


Algunos de los cambios en el proceso de compilación de Python y en la API de C son:


@itemize *

@item 
Se agregaron tres nuevas macros de conveniencia para valores de retorno comunes de funciones de extensión: @ref{14b0,,Py_RETURN_NONE}, @ref{14b1,,Py_RETURN_TRUE}, y @ref{14b2,,Py_RETURN_FALSE}. (Contribuido por Brett Cannon.)

@item 
Otra macro nueva, @ref{61c,,Py_CLEAR}, reduce el recuento de referencias de `obj' y establece `obj' en el puntero nulo. (Aportado por Jim Fulton.)

@item 
Una nueva función, @code{PyTuple_Pack(N, obj1, obj2, ..., objN)}, construye tuplas a partir de una lista de argumentos de longitud variable de objetos Python. (Contribuido por Raymond Hettinger.)

@item 
Una nueva función, @code{PyDict_Contains(d, k)}, implementa búsquedas rápidas de diccionarios sin enmascarar las excepciones que surgen durante el proceso de búsqueda. (Contribuido por Raymond Hettinger.)

@item 
La macro Py_IS_NAN(X) retorna 1 si su argumento flotante o doble `X' es un NaN. (Aportado por Tim Peters.)

@item 
El código C puede evitar el bloqueo innecesario mediante el uso de la nueva función @code{PyEval_ThreadsInitialized()} para saber si se ha realizado alguna operación de subproceso. Si esta función devuelve falso, no se necesitan operaciones de bloqueo. (Contribuido por Nick Coghlan.)

@item 
Una nueva función, @ref{476,,PyArg_VaParseTupleAndKeywords()}, es la misma que @ref{475,,PyArg_ParseTupleAndKeywords()} pero toma un @code{va_list} en lugar de varios argumentos. (Contribuido por Greg Chapman.)

@item 
Un nuevo indicador de método, @code{METH_COEXISTS}, permite que una función definida en ranuras coexista con un @ref{14b3,,PyCFunction} que tiene el mismo nombre. Esto puede reducir a la mitad el tiempo de acceso para un método como @code{set.__contains__()}. (Contribuido por Raymond Hettinger.)

@item 
Python ahora se puede construir con perfiles adicionales para el intérprete en sí, con la intención de ayudar a las personas que desarrollan el núcleo de Python. Proporcionar @code{ - enable-profiling} al @code{configure} script le permitirá perfilar el intérprete con @code{gprof}, y proporcionar el @code{ - with-tsc} switch permite la creación de perfiles utilizando el registro de contador de marcas de tiempo del Pentium. Tenga en cuenta que el conmutador @code{ - with-tsc} tiene un nombre ligeramente incorrecto, porque la función de creación de perfiles también funciona en la plataforma PowerPC, aunque la arquitectura del procesador no llama a ese registro» el registro TSC «. (Contribuido por Jeremy Hylton.)

@item 
El tipo @code{tracebackobject} ha sido renombrado a @code{PyTracebackObject}.
@end itemize

@c ======================================================================

@menu
* Cambios específicos del puerto:: 

@end menu

@node Cambios específicos del puerto,,,Cambios en la API de Build y C<2>
@anchor{whatsnew/2 4 port-specific-changes}@anchor{14b4}
@subsubsection Cambios específicos del puerto



@itemize *

@item 
El puerto de Windows ahora se construye bajo MSVC ++ 7.1 y también con la versión 6. (Contribuido por Martin von Löwis).
@end itemize

@c ======================================================================

@node Portar a Python 2 4,Agradecimientos<4>,Cambios en la API de Build y C<2>,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 porting-to-python-2-4}@anchor{14b5}
@subsection Portar a Python 2.4


Esta sección enumera los cambios descritos anteriormente que pueden requerir cambios en su código:


@itemize *

@item 
Los desplazamientos a la izquierda y las constantes hexadecimales / octales que son demasiado grandes ya no activan un @ref{4d4,,FutureWarning} y devuelven un valor limitado a 32 o 64 bits; en su lugar, devuelven un entero largo.

@item 
Operaciones de números enteros no lanzaran una excepción @code{OverflowWarning}. La advertencia sobre @code{OverflowWarning} desaparecerá en Python 2.5.

@item 
La función de conjunto integrado @ref{14d,,zip()} y la @code{itertools.izip()} ahora retornan una lista hacia en vez de lanzar una excepción de tipo @ref{228,,TypeError} si son llamados sin argumentos.

@item 
Ya no puede comparar las instancias @code{date} y @ref{32f,,datetime} proporcionadas por el módulo @ref{31,,datetime}. Dos instancias de clases diferentes ahora siempre serán desiguales, y las comparaciones relativas (@code{<}, @code{>}) lanzarán un @ref{228,,TypeError}.

@item 
@code{dircache.listdir()} now passes exceptions to the caller instead of
returning empty lists.

@item 
@code{LexicalHandler.startDTD()} solía recibir los identificadores públicos y del sistema en el orden incorrecto. Esto ha sido corregido; las aplicaciones que se basan en el orden incorrecto deben corregirse.

@item 
@ref{14b6,,fcntl.ioctl()} ahora advierte si el argumento `mutate' se omite y es relevante.

@item 
El módulo @ref{de,,tarfile} ahora genera archivos de GNU tar-formato por defecto.

@item 
Encontrar un error al importar un módulo ya no deja un objeto de módulo parcialmente inicializado en @code{sys.modules}.

@item 
@ref{716,,None} ahora es una constante; El código que une un nuevo valor al nombre @code{None} ahora es un error de sintaxis.

@item 
La función @code{signals.signal()} ahora genera una excepción @ref{1e5,,RuntimeError} para ciertos valores ilegales; anteriormente estos errores pasaban silenciosamente. Por ejemplo, ya no puede configurar un controlador en la señal @code{SIGKILL}.
@end itemize

@c ======================================================================

@node Agradecimientos<4>,,Portar a Python 2 4,Qué hay de nuevo en Python 2 4
@anchor{whatsnew/2 4 acknowledgements}@anchor{14b7}@anchor{whatsnew/2 4 acks}@anchor{14b8}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas por ofrecer sugerencias, correcciones y ayuda con varios borradores de este artículo: Koray Can, Hye-Shik Chang, Michael Dyck, Raymond Hettinger, Brian Hurt, Hamish Lawson, Fredrik Lundh, Sean Reifschneider, Sadruddin Rejeb.

@node Qué hay de nuevo en Python 2 3,Qué hay de nuevo en Python 2 2,Qué hay de nuevo en Python 2 4,Qué hay de nuevo en Python
@anchor{whatsnew/2 3 doc}@anchor{14b9}@anchor{whatsnew/2 3 what-s-new-in-python-2-3}@anchor{14ba}
@section Qué hay de nuevo en Python 2.3


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew23.tex 54631 2007-03-31 11:58:36Z georg.brandl $

Este artículo explica las nuevas características de Python 2.3.  Python 2.3 se publicó el 29 de julio de 2003.

Los temas principales de Python 2.3 son el pulido de algunas de las características añadidas en la 2.2, la adición de varias mejoras pequeñas pero útiles al núcleo del lenguaje y la ampliación de la biblioteca estándar.  El nuevo modelo de objetos introducido en la versión anterior se ha beneficiado de 18 meses de correcciones de errores y de esfuerzos de optimización que han mejorado el rendimiento de las clases de nuevo estilo.  Se han añadido algunas funciones incorporadas, como @ref{515,,sum()} y @ref{14bb,,enumerate()}.  El operador @ref{1ed,,in} puede utilizarse ahora para búsquedas de subcadenas (por ejemplo, @code{"ab" en "abc"} retorna @ref{c95,,True}).

Algunas de las nuevas características de la biblioteca son los tipos de datos booleanos, de conjunto, de montón y de fecha/hora, la posibilidad de importar módulos desde archivos con formato ZIP, el soporte de metadatos para el tan esperado catálogo de Python, una versión actualizada de IDLE y módulos para registrar mensajes, envolver texto, analizar archivos CSV, procesar opciones de línea de comandos, utilizar bases de datos BerkeleyDB… la lista de módulos nuevos y mejorados es larga.

Este artículo no pretende proporcionar una especificación completa de las nuevas características, sino que proporciona una visión general conveniente.  Para obtener todos los detalles, debes consultar la documentación de Python 2.3, como la Referencia de la Biblioteca de Python y el Manual de Referencia de Python.  Si quieres entender la implementación completa y los fundamentos del diseño, consulta el PEP de una nueva característica en particular.

@c ======================================================================

@menu
* PEP 218; Un tipo de datos de conjunto estándar: PEP 218 Un tipo de datos de conjunto estándar. 
* PEP 255; Generadores simples: PEP 255 Generadores simples. 
* PEP 263; Codificación del código fuente: PEP 263 Codificación del código fuente. 
* PEP 273; Importar módulos desde archivos ZIP: PEP 273 Importar módulos desde archivos ZIP. 
* PEP 277; Soporte de nombres de archivo Unicode para Windows NT: PEP 277 Soporte de nombres de archivo Unicode para Windows NT. 
* PEP 278; Soporte universal de nuevas líneas: PEP 278 Soporte universal de nuevas líneas. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; El paquete de registro: PEP 282 El paquete de registro. 
* PEP 285; Un tipo booleano: PEP 285 Un tipo booleano. 
* PEP 293; Llamadas de retorno para el manejo de errores del códec: PEP 293 Llamadas de retorno para el manejo de errores del códec. 
* PEP 301; Índice de paquetes y metadatos para Distutils: PEP 301 Índice de paquetes y metadatos para Distutils. 
* PEP 302; Nuevos ganchos de importación: PEP 302 Nuevos ganchos de importación. 
* PEP 305; Archivos separados por comas: PEP 305 Archivos separados por comas. 
* PEP 307; Mejoras en Pickle: PEP 307 Mejoras en Pickle. 
* Rebanadas ampliadas:: 
* Otros cambios en el lenguaje: Otros cambios en el lenguaje<5>. 
* Módulos nuevos@comma{} mejorados y obsoletos: Módulos nuevos mejorados y obsoletos<4>. 
* Pymalloc; un asignador de objetos especializado: Pymalloc un asignador de objetos especializado. 
* Cambios en la API de Build y C: Cambios en la API de Build y C<3>. 
* Otros cambios y correcciones: Otros cambios y correcciones<2>. 
* Portar a Python 2.3: Portar a Python 2 3. 
* Agradecimientos: Agradecimientos<5>. 

@end menu

@node PEP 218 Un tipo de datos de conjunto estándar,PEP 255 Generadores simples,,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-218-a-standard-set-datatype}@anchor{14bc}
@subsection PEP 218: Un tipo de datos de conjunto estándar


The new @code{sets} module contains an implementation of a set datatype.  The
@code{Set} class is for mutable sets, sets that can have members added and
removed.  The @code{ImmutableSet} class is for sets that can’t be modified,
and instances of @code{ImmutableSet} can therefore be used as dictionary keys.
Sets are built on top of dictionaries, so the elements within a set must be
hashable.

Aquí hay un ejemplo simple:

@example
>>> import sets
>>> S = sets.Set([1,2,3])
>>> S
Set([1, 2, 3])
>>> 1 in S
True
>>> 0 in S
False
>>> S.add(5)
>>> S.remove(3)
>>> S
Set([1, 2, 5])
>>>
@end example

The union and intersection of sets can be computed with the @ref{14bd,,union()} and
@ref{14be,,intersection()} methods; an alternative notation uses the bitwise operators
@code{&} and @code{|}. Mutable sets also have in-place versions of these methods,
@code{union_update()} and @ref{14bf,,intersection_update()}.

@example
>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([4,5,6])
>>> S1.union(S2)
Set([1, 2, 3, 4, 5, 6])
>>> S1 | S2                  # Alternative notation
Set([1, 2, 3, 4, 5, 6])
>>> S1.intersection(S2)
Set([])
>>> S1 & S2                  # Alternative notation
Set([])
>>> S1.union_update(S2)
>>> S1
Set([1, 2, 3, 4, 5, 6])
>>>
@end example

It’s also possible to take the symmetric difference of two sets.  This is the
set of all elements in the union that aren’t in the intersection.  Another way
of putting it is that the symmetric difference contains all elements that are in
exactly one set.  Again, there’s an alternative notation (@code{^}), and an
in-place version with the ungainly name @ref{14c0,,symmetric_difference_update()}.

@example
>>> S1 = sets.Set([1,2,3,4])
>>> S2 = sets.Set([3,4,5,6])
>>> S1.symmetric_difference(S2)
Set([1, 2, 5, 6])
>>> S1 ^ S2
Set([1, 2, 5, 6])
>>>
@end example

There are also @code{issubset()} and @code{issuperset()} methods for checking
whether one set is a subset or superset of another:

@example
>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([2,3])
>>> S2.issubset(S1)
True
>>> S1.issubset(S2)
False
>>> S1.issuperset(S2)
True
>>>
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - Añadiendo un tipo de objeto de conjunto incorporado

PEP escrito por Greg V. Wilson. Implementado por Greg V. Wilson, Alex Martelli y GvR.
@end table


@c ======================================================================

@node PEP 255 Generadores simples,PEP 263 Codificación del código fuente,PEP 218 Un tipo de datos de conjunto estándar,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-255-simple-generators}@anchor{14c1}@anchor{whatsnew/2 3 section-generators}@anchor{14c2}
@subsection PEP 255: Generadores simples


En Python 2.2, los generadores se añadieron como una característica opcional, que se activaba mediante una directiva @code{from __future__ import generators}.  En 2.3 los generadores ya no necesitan ser habilitados especialmente, y ahora están siempre presentes; esto significa que @ref{a5f,,yield} es ahora siempre una palabra clave.  El resto de esta sección es una copia de la descripción de los generadores del documento «What’s New in Python 2.2»; si lo leíste cuando salió Python 2.2, puedes saltarte el resto de esta sección.

Sin duda estás familiarizado con cómo funcionan las llamadas a funciones en Python o C. Cuando llamas a una función, ésta obtiene un espacio de nombres privado donde se crean sus variables locales.  Cuando la función llega a una declaración @ref{a60,,return}, las variables locales se destruyen y el valor resultante se retorna a quien la llamó.  Una llamada posterior a la misma función obtendrá un nuevo conjunto de variables locales. Pero, ¿qué pasaría si las variables locales no se tiraran al salir de una función? ¿Qué pasaría si pudieras reanudar la función donde la dejaste?  Esto es lo que proporcionan los generadores; se puede pensar en ellos como funciones reanudables.

Este es el ejemplo más sencillo de una función generadora:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

Se ha introducido una nueva palabra clave, @ref{a5f,,yield}, para los generadores.  Cualquier función que contenga una declaración @code{yield} es una función generadora; esto es detectado por el compilador de código de bits de Python que compila la función especialmente como resultado.

Cuando se llama a una función generadora, ésta no retorna un único valor, sino que retorna un objeto generador que soporta el protocolo de los iteradores.  Al ejecutar la sentencia @ref{a5f,,yield}, el generador retorna el valor de @code{i}, de forma similar a una sentencia @ref{a60,,return}.  La gran diferencia entre @code{yield} y una sentencia @code{return} es que al llegar a una sentencia @code{yield} se suspende el estado de ejecución del generador y se conservan las variables locales.  En la siguiente llamada al método @code{.next()} del generador, la función se reanudará la ejecución inmediatamente después de la sentencia @code{yield}.  (Por razones complicadas, la sentencia @code{yield} no está permitida dentro del bloque @ref{789,,try} de una sentencia @code{try}…`; lea 
@geindex Python Enhancement Proposals; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/} para una explicación completa de la interacción entre @code{yield} y las excepciones)

Here’s a sample usage of the @code{generate_ints()} generator:

@example
>>> gen = generate_ints(3)
>>> gen
<generator object at 0x8117f90>
>>> gen.next()
0
>>> gen.next()
1
>>> gen.next()
2
>>> gen.next()
Traceback (most recent call last):
  File "stdin", line 1, in ?
  File "stdin", line 2, in generate_ints
StopIteration
@end example

También podrías escribir @code{for i in generate_ints(5)}, o @code{a,b,c = generate_ints(3)}.

Dentro de una función generadora, la expresión @ref{a60,,return} sólo puede usarse sin un valor, y señala el final de la procesión de valores; después el generador no puede retornar más valores. @code{return} con un valor, como @code{return 5}, es un error de sintaxis dentro de una función generadora.  El final de los resultados del generador también puede indicarse levantando manualmente @ref{c82,,StopIteration}, o simplemente dejando que el flujo de ejecución caiga en el fondo de la función.

Puedes conseguir el efecto de los generadores manualmente escribiendo tu propia clase y almacenando todas las variables locales del generador como variables de instancia.  Por ejemplo, la devolución de una lista de enteros podría hacerse estableciendo @code{self.count} a 0, y haciendo que el método @ref{86f,,next()} incremente @code{self.count} y lo retorne. Sin embargo, para un generador medianamente complicado, escribir la clase correspondiente sería mucho más complicado. @code{Lib/test/test_generators.py} contiene varios ejemplos más interesantes.  El más sencillo implementa un recorrido en orden de un árbol utilizando generadores de forma recursiva

@example
# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x
@end example

Otros dos ejemplos en @code{Lib/test/test_generators.py} producen soluciones para el problema de las N reinas (colocar $N$ reinas en un tablero de ajedrez $NxN$ de forma que ninguna reina amenace a otra) y el recorrido del caballero (una ruta que lleva a un caballo a cada casilla de un tablero de ajedrez $NxN$ sin visitar ninguna casilla dos veces).

La idea de los generadores proviene de otros lenguajes de programación, especialmente de Icon (@indicateurl{https://www2.cs.arizona.edu/icon/}), donde la idea de los generadores es fundamental.  En Icon, cada expresión y llamada a una función se comporta como un generador.  Un ejemplo de «`An Overview of the Icon Programming Language'» en @indicateurl{https://www2.cs.arizona.edu/icon/docs/ipd266.htm} da una idea de cómo es esto:

@example
sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)
@end example

In Icon the @code{find()} function returns the indexes at which the substring
«or» is found: 3, 23, 33.  In the @ref{1ec,,if} statement, @code{i} is first
assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon
retries it with the second value of 23.  23 is greater than 5, so the comparison
now succeeds, and the code prints the value 23 to the screen.

Python no va tan lejos como Icon en la adopción de generadores como concepto central.  Los generadores se consideran parte del núcleo del lenguaje Python, pero aprenderlos o utilizarlos no es obligatorio; si no resuelven ningún problema que tengas, siéntete libre de ignorarlos. Una característica novedosa de la interfaz de Python en comparación con la de Icon es que el estado de un generador se representa como un objeto concreto (el iterador) que puede pasarse a otras funciones o almacenarse en una estructura de datos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Generadores simples

Escrito por Neil Schemenauer, Tim Peters, Magnus Lie Hetland.  Implementado principalmente por Neil Schemenauer y Tim Peters, con otras correcciones del equipo de Python Labs.
@end table


@c ======================================================================

@node PEP 263 Codificación del código fuente,PEP 273 Importar módulos desde archivos ZIP,PEP 255 Generadores simples,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-263-source-code-encodings}@anchor{14c3}@anchor{whatsnew/2 3 section-encodings}@anchor{14c4}
@subsection PEP 263: Codificación del código fuente


Los archivos fuente de Python ahora pueden declararse con diferentes codificaciones de conjuntos de caracteres.  Las codificaciones se declaran incluyendo un comentario con formato especial en la primera o segunda línea del archivo fuente.  Por ejemplo, un archivo UTF-8 puede declararse con:

@example
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
@end example

Sin esta declaración de codificación, la codificación por defecto utilizada es ASCII de 7 bits. Ejecutar o importar módulos que contengan literales de cadena con caracteres de 8 bits y que no tengan una declaración de codificación dará lugar a un @ref{1da,,DeprecationWarning} señalado por Python 2.3; en 2.4 será un error de sintaxis.

La declaración de codificación sólo afecta a los literales de cadena Unicode, que se convertirán a Unicode utilizando la codificación especificada.  Ten en cuenta que los identificadores de Python siguen restringidos a caracteres ASCII, por lo que no puedes tener nombres de variables que utilicen caracteres fuera de los alfanuméricos habituales.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/} - Definición de las codificaciones del código fuente de Python

Escrito por Marc-André Lemburg y Martin von Löwis; realizado por Suzuki Hisao y Martin von Löwis.
@end table


@c ======================================================================

@node PEP 273 Importar módulos desde archivos ZIP,PEP 277 Soporte de nombres de archivo Unicode para Windows NT,PEP 263 Codificación del código fuente,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-273-importing-modules-from-zip-archives}@anchor{14c5}
@subsection PEP 273: Importar módulos desde archivos ZIP


El nuevo módulo @ref{131,,zipimport} añade soporte para importar módulos desde un archivo en formato ZIP.  No es necesario importar el módulo explícitamente; se importará automáticamente si se añade el nombre de un archivo ZIP a @code{sys.path}. Por ejemplo:

@example
amk@@nyman:~/src/python$ unzip -l /tmp/example.zip
Archive:  /tmp/example.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  11-26-02 22:30   jwzthreading.py
 --------                   -------
     8467                   1 file
amk@@nyman:~/src/python$ ./python
Python 2.3 (#1, Aug 1 2003, 19:54:32)
>>> import sys
>>> sys.path.insert(0, '/tmp/example.zip')  # Add .zip file to front of path
>>> import jwzthreading
>>> jwzthreading.__file__
'/tmp/example.zip/jwzthreading.py'
>>>
@end example

Una entrada en @code{sys.path} puede ser ahora el nombre de un archivo ZIP. El archivo ZIP puede contener cualquier tipo de ficheros, pero sólo se pueden importar los ficheros llamados @code{*.py}, @code{*.pyc}, o @code{*.pyo}.  Si un archivo sólo contiene ficheros @code{*.py}, Python no intentará modificar el archivo añadiendo el correspondiente fichero @code{*.pyc}, lo que significa que si un archivo ZIP no contiene ficheros @code{*.pyc}, la importación puede ser bastante lenta.

También se puede especificar una ruta dentro del archivo para importar sólo de un subdirectorio; por ejemplo, la ruta @code{/tmp/example.zip/lib/} sólo importaría del subdirectorio @code{lib/} dentro del archivo.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - Importación de módulos desde archivos Zip

Escrito por James C. Ahlstrom, que también proporcionó una implementación. Python 2.3 sigue la especificación en 
@geindex Python Enhancement Proposals; PEP 273
PEP 273@footnote{https://peps.python.org/pep-0273/}, pero utiliza una implementación escrita por Just van Rossum que utiliza los ganchos de importación descritos en 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. Vea la sección @ref{14c6,,PEP 302; Nuevos ganchos de importación} para una descripción de los nuevos ganchos de importación.
@end table


@c ======================================================================

@node PEP 277 Soporte de nombres de archivo Unicode para Windows NT,PEP 278 Soporte universal de nuevas líneas,PEP 273 Importar módulos desde archivos ZIP,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-277-unicode-file-name-support-for-windows-nt}@anchor{14c7}
@subsection PEP 277: Soporte de nombres de archivo Unicode para Windows NT


En Windows NT, 2000 y XP, el sistema almacena los nombres de archivo como cadenas Unicode. Tradicionalmente, Python ha representado los nombres de archivo como cadenas de bytes, lo cual es inadecuado porque hace que algunos nombres de archivo sean inaccesibles.

Python now allows using arbitrary Unicode strings (within the limitations of the
file system) for all functions that expect file names, most notably the
@ref{1be,,open()} built-in function. If a Unicode string is passed to
@ref{116c,,os.listdir()}, Python now returns a list of Unicode strings.  A new
function, @code{os.getcwdu()}, returns the current directory as a Unicode string.

Las cadenas de bytes siguen funcionando como nombres de archivo, y en Windows Python las convertirá de forma transparente a Unicode utilizando la codificación @code{mbcs}.

Otros sistemas también permiten cadenas Unicode como nombres de archivo, pero las convierten en cadenas de bytes antes de pasarlas al sistema, lo que puede provocar un @ref{130f,,UnicodeError}. Las aplicaciones pueden comprobar si se admiten cadenas Unicode arbitrarias como nombres de archivo comprobando @ref{14c8,,os.path.supports_unicode_filenames}, un valor booleano.

En MacOS, @ref{116c,,os.listdir()} ahora puede retornar nombres de archivo Unicode.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 277

@item PEP 277@footnote{https://peps.python.org/pep-0277/} - Soporte de nombres de archivo Unicode para Windows NT

Escrito por Neil Hodgson; realizado por Neil Hodgson, Martin von Löwis y Mark Hammond.
@end table


@c ======================================================================

@geindex saltos de línea universal;Qué hay de nuevo

@node PEP 278 Soporte universal de nuevas líneas,PEP 279 enumerate,PEP 277 Soporte de nombres de archivo Unicode para Windows NT,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-278-universal-newline-support}@anchor{14c9}
@subsection PEP 278: Soporte universal de nuevas líneas


Los tres principales sistemas operativos que se utilizan hoy en día son Microsoft Windows, el sistema operativo Macintosh de Apple y los diversos derivados de Unix.  Una pequeña molestia del trabajo entre plataformas es que estas tres plataformas utilizan diferentes caracteres para marcar el final de las líneas en los archivos de texto.  Unix utiliza el salto de línea (carácter ASCII 10), MacOS utiliza el retorno de carro (carácter ASCII 13), y Windows utiliza una secuencia de dos caracteres de un retorno de carro más una nueva línea.

Python’s file objects can now support end of line conventions other than the
one followed by the platform on which Python is running. Opening a file with
the mode @code{'U'} or @code{'rU'} will open a file for reading in @ref{dc1,,universal newlines} mode.  All three line ending conventions will be translated to a
@code{'\n'} in the strings returned by the various file methods such as
@code{read()} and @code{readline()}.

Universal newline support is also used when importing modules and when executing
a file with the @code{execfile()} function.  This means that Python modules can
be shared between all three operating systems without needing to convert the
line-endings.

Esta función puede desactivarse al compilar Python especificando la opción @code{--without-universal-newlines} al ejecutar el script @code{configure} de Python.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 278

@item PEP 278@footnote{https://peps.python.org/pep-0278/} - Soporte universal de nuevas líneas

Escrito y ejecutado por Jack Jansen.
@end table


@c ======================================================================

@node PEP 279 enumerate,PEP 282 El paquete de registro,PEP 278 Soporte universal de nuevas líneas,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-279-enumerate}@anchor{14ca}@anchor{whatsnew/2 3 section-enumerate}@anchor{14cb}
@subsection PEP 279: enumerate()


Una nueva función incorporada, @ref{14bb,,enumerate()}, hará que ciertos bucles sean un poco más claros.  @code{enumerate(cosa)}, donde `cosa' es un iterador o una secuencia, retorna un iterador que retornará @code{(0, cosa[0])}, @code{(1, cosa[1])}, @code{(2, cosa[2])}, y así sucesivamente.

Un modismo común para cambiar cada elemento de una lista tiene el siguiente aspecto:

@example
for i in range(len(L)):
    item = L[i]
    # ... compute some result based on item ...
    L[i] = result
@end example

Esto se puede reescribir usando @ref{14bb,,enumerate()} como:

@example
for i, item in enumerate(L):
    # ... compute some result based on item ...
    L[i] = result
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 279

@item PEP 279@footnote{https://peps.python.org/pep-0279/} - La función incorporada enumerate()

Escrito y ejecutado por Raymond D. Hettinger.
@end table


@c ======================================================================

@node PEP 282 El paquete de registro,PEP 285 Un tipo booleano,PEP 279 enumerate,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-282-the-logging-package}@anchor{14cc}
@subsection PEP 282: El paquete de registro


Se ha añadido a Python 2.3 un paquete estándar para escribir registros, @ref{87,,logging}.  Proporciona un mecanismo potente y flexible para generar salidas de registro que pueden ser filtradas y procesadas de varias maneras.  Se puede utilizar un archivo de configuración escrito en un formato estándar para controlar el comportamiento de registro de un programa.  Python incluye manejadores que escribirán los registros en el error estándar o en un archivo o socket, los enviarán al registro del sistema, o incluso los enviarán por correo electrónico a una dirección particular; por supuesto, también es posible escribir tus propias clases de manejadores.

The @ref{bd7,,Logger} class is the primary class. Most application code will deal
with one or more @ref{bd7,,Logger} objects, each one used by a particular
subsystem of the application. Each @ref{bd7,,Logger} is identified by a name, and
names are organized into a hierarchy using @code{.}  as the component separator.
For example, you might have @ref{bd7,,Logger} instances named @code{server},
@code{server.auth} and @code{server.network}.  The latter two instances are below
@code{server} in the hierarchy.  This means that if you turn up the verbosity for
@code{server} or direct @code{server} messages to a different handler, the changes
will also apply to records logged to @code{server.auth} and @code{server.network}.
There’s also a root @ref{bd7,,Logger} that’s the parent of all other loggers.

Para usos sencillos, el paquete @ref{87,,logging} contiene algunas funciones de conveniencia que siempre utilizan la raíz log:

@example
import logging

logging.debug('Debugging information')
logging.info('Informational message')
logging.warning('Warning:config file %s not found', 'server.conf')
logging.error('Error occurred')
logging.critical('Critical error -- shutting down')
@end example

Esto produce la siguiente salida:

@example
WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down
@end example

In the default configuration, informational and debugging messages are
suppressed and the output is sent to standard error.  You can enable the display
of informational and debugging messages by calling the @ref{14cd,,setLevel()} method
on the root logger.

Notice the @ref{1f7,,warning()} call’s use of string formatting operators; all of the
functions for logging messages take the arguments @code{(msg, arg1, arg2, ...)} and
log the string resulting from @code{msg % (arg1, arg2, ...)}.

There’s also an @ref{14ce,,exception()} function that records the most recent
traceback.  Any of the other functions will also record the traceback if you
specify a true value for the keyword argument `exc_info'.

@example
def f():
    try:    1/0
    except: logging.exception('Problem recorded')

f()
@end example

Esto produce la siguiente salida:

@example
ERROR:root:Problem recorded
Traceback (most recent call last):
  File "t.py", line 6, in f
    1/0
ZeroDivisionError: integer division or modulo by zero
@end example

Los programas un poco más avanzados utilizarán un logger distinto del logger raíz. La función @code{getLogger(nombre)} se utiliza para obtener un registro en particular, creándolo si aún no existe. @code{getLogger(None)} retorna el logger raíz.

@example
log = logging.getLogger('server')
 ...
log.info('Listening on port %i', port)
 ...
log.critical('Disk full')
 ...
@end example

Log records are usually propagated up the hierarchy, so a message logged to
@code{server.auth} is also seen by @code{server} and @code{root}, but a @ref{bd7,,Logger}
can prevent this by setting its @ref{14cf,,propagate} attribute to @ref{bbf,,False}.

There are more classes provided by the @ref{87,,logging} package that can be
customized.  When a @ref{bd7,,Logger} instance is told to log a message, it
creates a @ref{1065,,LogRecord} instance that is sent to any number of different
@ref{14d0,,Handler} instances.  Loggers and handlers can also have an attached list
of filters, and each filter can cause the @ref{1065,,LogRecord} to be ignored or
can modify the record before passing it along.  When they’re finally output,
@ref{1065,,LogRecord} instances are converted to text by a @ref{14d1,,Formatter}
class.  All of these classes can be replaced by your own specially written
classes.

Con todas estas características, el paquete @ref{87,,logging} debería proporcionar suficiente flexibilidad incluso para las aplicaciones más complicadas.  Esto es sólo un resumen incompleto de sus características, así que por favor consulte la documentación de referencia del paquete para todos los detalles.  La lectura de 
@geindex Python Enhancement Proposals; PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/} también será útil.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - Un sistema de registro

Escrito por Vinay Sajip y Trent Mick; implementado por Vinay Sajip.
@end table


@c ======================================================================

@node PEP 285 Un tipo booleano,PEP 293 Llamadas de retorno para el manejo de errores del códec,PEP 282 El paquete de registro,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-285-a-boolean-type}@anchor{14d2}@anchor{whatsnew/2 3 section-bool}@anchor{14d3}
@subsection PEP 285: Un tipo booleano


A Boolean type was added to Python 2.3.  Two new constants were added to the
@code{__builtin__} module, @ref{c95,,True} and @ref{bbf,,False}.  (@ref{c95,,True} and
@ref{bbf,,False} constants were added to the built-ins in Python 2.2.1, but the
2.2.1 versions are simply set to integer values of 1 and 0 and aren’t a
different type.)

El objeto de tipo para este nuevo tipo se denomina @ref{513,,bool}; su constructor toma cualquier valor de Python y lo convierte en @ref{c95,,True} o @ref{bbf,,False}.

@example
>>> bool(1)
True
>>> bool(0)
False
>>> bool([])
False
>>> bool( (1,) )
True
@end example

La mayoría de los módulos de la biblioteca estándar y las funciones incorporadas se han modificado para retornar booleanos.

@example
>>> obj = []
>>> hasattr(obj, 'append')
True
>>> isinstance(obj, list)
True
>>> isinstance(obj, tuple)
False
@end example

Los booleanos de Python se añadieron con el objetivo principal de hacer el código más claro.  Por ejemplo, si estás leyendo una función y te encuentras con la sentencia @code{return 1}, podrías preguntarte si el @code{1} representa un valor de verdad booleano, un índice o un coeficiente que multiplica alguna otra cantidad.  Sin embargo, si la sentencia es @code{return True}, el significado del valor de retorno es bastante claro.

Los booleanos de Python `no' se añadieron en aras de una comprobación de tipos estricta.  Un lenguaje muy estricto como Pascal también le impediría realizar aritmética con booleanos, y requeriría que la expresión en una declaración @ref{1ec,,if} siempre se evaluara a un resultado booleano.  Python no es tan estricto y nunca lo será, como dice explícitamente 
@geindex Python Enhancement Proposals; PEP 285
PEP 285@footnote{https://peps.python.org/pep-0285/}.  Esto significa que puede utilizar cualquier expresión en una sentencia @code{if}, incluso las que se evalúan a una lista o tupla o algún objeto aleatorio.  El tipo Booleano es una subclase de la clase @ref{1f0,,int} por lo que la aritmética que utiliza un Booleano sigue funcionando.

@example
>>> True + 1
2
>>> False + 1
1
>>> False * 75
0
>>> True * 75
75
@end example

Para resumir @ref{c95,,True} and @ref{bbf,,False}  en una frase: son formas alternativas de deletrear los valores enteros 1 y 0, con la única diferencia de que @ref{237,,str()} y @ref{894,,repr()} retornan las cadenas @code{Verdadero} y @code{Falso} en lugar de @code{1} y @code{0}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 285

@item PEP 285@footnote{https://peps.python.org/pep-0285/} - Añadir un tipo booleano

Escrito y ejecutado por GvR.
@end table


@c ======================================================================

@node PEP 293 Llamadas de retorno para el manejo de errores del códec,PEP 301 Índice de paquetes y metadatos para Distutils,PEP 285 Un tipo booleano,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-293-codec-error-handling-callbacks}@anchor{14d4}
@subsection PEP 293: Llamadas de retorno para el manejo de errores del códec


Al codificar una cadena Unicode en una cadena de bytes, pueden encontrarse caracteres no codificables.  Hasta ahora, Python ha permitido especificar el procesamiento del error como «estricto» (lanzando @ref{130f,,UnicodeError}), «ignorar» (saltando el carácter), o «reemplazar» (usando un signo de interrogación en la cadena de salida), siendo «estricto» el comportamiento por defecto. Puede ser deseable especificar un procesamiento alternativo de tales errores, como insertar una referencia de carácter XML o una referencia de entidad HTML en la cadena convertida.

Python tiene ahora un marco flexible para añadir diferentes estrategias de procesamiento.  Se pueden añadir nuevos manejadores de errores con @ref{14d5,,codecs.register_error()}, y los códecs pueden acceder al manejador de errores con @ref{14d6,,codecs.lookup_error()}. Se ha añadido una API en C equivalente para los códecs escritos en C. El gestor de errores obtiene la información de estado necesaria, como la cadena que se está convirtiendo, la posición en la cadena donde se ha detectado el error y la codificación de destino.  El controlador puede entonces lanzar una excepción o retornar una cadena de reemplazo.

Se han implementado dos manejadores de error adicionales utilizando este marco: «backslashreplace» utiliza las comillas de barra invertida de Python para representar los caracteres no codificables y «xmlcharrefreplace» emite referencias de caracteres XML.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 293

@item PEP 293@footnote{https://peps.python.org/pep-0293/} - Retrollamadas de manejo de errores del códec

Escrito y ejecutado por Walter Dörwald.
@end table


@c ======================================================================

@node PEP 301 Índice de paquetes y metadatos para Distutils,PEP 302 Nuevos ganchos de importación,PEP 293 Llamadas de retorno para el manejo de errores del códec,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-301-package-index-and-metadata-for-distutils}@anchor{14d7}@anchor{whatsnew/2 3 section-pep301}@anchor{14d8}
@subsection PEP 301: Índice de paquetes y metadatos para Distutils


La compatibilidad con el catálogo de Python, largamente solicitada, hace su primera aparición en 2.3.

El corazón del catálogo es el nuevo comando @code{register} de Distutils. Ejecutando @code{python setup.py register} se recogen los metadatos que describen un paquete, como su nombre, versión, mantenedor, descripción, etc., y se envían a un servidor de catálogo central.  El catálogo resultante está disponible en @indicateurl{https://pypi.org}.

To make the catalog a bit more useful, a new optional `classifiers' keyword
argument has been added to the Distutils @code{setup()} function.  A list of
Trove@footnote{http://catb.org/~esr/trove/}-style strings can be supplied to help
classify the software.

Aquí hay un ejemplo @code{setup.py} con clasificadores, escrito para que sea compatible con las versiones más antiguas de Distutils:

@example
from distutils import core
kw = @{'name': "Quixote",
      'version': "0.5.1",
      'description': "A highly Pythonic Web application framework",
      # ...
      @}

if (hasattr(core, 'setup_keywords') and
    'classifiers' in core.setup_keywords):
    kw['classifiers'] = \
        ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
         'Environment :: No Input/Output (Daemon)',
         'Intended Audience :: Developers'],

core.setup(**kw)
@end example

La lista completa de clasificadores se puede obtener ejecutando @code{python setup.py register --list-classifiers}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 301

@item PEP 301@footnote{https://peps.python.org/pep-0301/} - Índice de paquetes y metadatos para Distutils

Escrito y ejecutado por Richard Jones.
@end table


@c ======================================================================

@node PEP 302 Nuevos ganchos de importación,PEP 305 Archivos separados por comas,PEP 301 Índice de paquetes y metadatos para Distutils,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-302-new-import-hooks}@anchor{14d9}@anchor{whatsnew/2 3 section-pep302}@anchor{14c6}
@subsection PEP 302: Nuevos ganchos de importación


While it’s been possible to write custom import hooks ever since the
@code{ihooks} module was introduced in Python 1.3, no one has ever been really
happy with it because writing new import hooks is difficult and messy.  There
have been various proposed alternatives such as the @code{imputil} and @code{iu}
modules, but none of them has ever gained much acceptance, and none of them were
easily usable from C code.

@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} borrows ideas from its predecessors, especially from Gordon
McMillan’s @code{iu} module.  Three new items  are added to the @ref{d9,,sys}
module:


@itemize *

@item 
@code{sys.path_hooks} es una lista de objetos invocables; la mayoría de las veces serán clases.  Cada llamada toma una cadena que contiene una ruta y retorna un objeto importador que manejará las importaciones desde esta ruta o lanza una excepción @ref{4d7,,ImportError} si no puede manejar esta ruta.

@item 
@code{sys.path_importer_cache} almacena en caché los objetos del importador para cada ruta, por lo que @code{sys.path_hooks} sólo tendrá que ser recorrido una vez para cada ruta.

@item 
@code{sys.meta_path} es una lista de objetos importadores que se recorrerán antes de comprobar @code{sys.path}.  Esta lista está inicialmente vacía, pero el código de usuario puede añadir objetos a ella.  Los módulos adicionales incorporados y congelados pueden ser importados por un objeto añadido a esta lista.
@end itemize

Los objetos importadores deben tener un único método, @code{find_module(fullname, path=None)}.  `fullname' será un nombre de módulo o paquete, por ejemplo @code{string} o @code{distutils.core}. @code{find_module()} debe retornar un objeto cargador que tenga un único método, @code{load_module(fullname)}, que cree y retorne el objeto módulo correspondiente.

Por lo tanto, el pseudocódigo de la nueva lógica de importación de Python es algo así (simplificado un poco; véase 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para los detalles completos):

@example
for mp in sys.meta_path:
    loader = mp(fullname)
    if loader is not None:
        <module> = loader.load_module(fullname)

for path in sys.path:
    for hook in sys.path_hooks:
        try:
            importer = hook(path)
        except ImportError:
            # ImportError, so try the other path hooks
            pass
        else:
            loader = importer.find_module(fullname)
            <module> = loader.load_module(fullname)

# Not found!
raise ImportError
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/} - Nuevos ganchos de importación

Escrito por Just van Rossum y Paul Moore. Implementado por Just van Rossum.
@end table


@c ======================================================================

@node PEP 305 Archivos separados por comas,PEP 307 Mejoras en Pickle,PEP 302 Nuevos ganchos de importación,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-305-comma-separated-files}@anchor{14da}@anchor{whatsnew/2 3 section-pep305}@anchor{14db}
@subsection PEP 305: Archivos separados por comas


Los archivos separados por comas son un formato frecuentemente utilizado para exportar datos de bases de datos y hojas de cálculo.  Python 2.3 añade un analizador de archivos separados por comas.

El formato separado por comas es engañosamente sencillo a primera vista:

@example
Costs,150,200,3.95
@end example

Leer una línea y llamar a @code{line.split(',')}: ¿qué puede ser más sencillo? Pero si se añaden datos de cadena que pueden contener comas, las cosas se complican:

@example
"Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
@end example

Una expresión regular grande y fea puede analizar esto, pero usar el nuevo paquete @ref{2a,,csv} es mucho más sencillo:

@example
import csv

input = open('datafile', 'rb')
reader = csv.reader(input)
for line in reader:
    print line
@end example

The @ref{52f,,reader()} function takes a number of different options. The field
separator isn’t limited to the comma and can be changed to any character, and so
can the quoting and line-ending characters.

Se pueden definir y registrar diferentes dialectos de archivos separados por comas; actualmente hay dos dialectos, ambos utilizados por Microsoft Excel. Una clase @ref{530,,csv.writer} independiente generará archivos separados por comas a partir de una sucesión de tuplas o listas, citando cadenas que contengan el delimitador.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - API de archivos CSV

Escrito y realizado por Kevin Altis, Dave Cole, Andrew McNamara, Skip Montanaro, Cliff Wells.
@end table


@c ======================================================================

@node PEP 307 Mejoras en Pickle,Rebanadas ampliadas,PEP 305 Archivos separados por comas,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pep-307-pickle-enhancements}@anchor{14dc}@anchor{whatsnew/2 3 section-pep307}@anchor{14dd}
@subsection PEP 307: Mejoras en Pickle


The @ref{a6,,pickle} and @code{cPickle} modules received some attention during the
2.3 development cycle.  In 2.2, new-style classes could be pickled without
difficulty, but they weren’t pickled very compactly; 
@geindex Python Enhancement Proposals; PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} quotes a trivial
example where a new-style class results in a pickled string three times longer
than that for a classic class.

La solución fue inventar un nuevo protocolo pickle.  La función @ref{14de,,pickle.dumps()} soporta desde hace tiempo una bandera de texto o binario.  En la versión 2.3, esta bandera se ha redefinido, pasando de ser un booleano a un entero: 0 es el antiguo formato pickle en modo texto, 1 es el antiguo formato binario, y ahora 2 es un nuevo formato específico de 2.3.  Una nueva constante, @ref{14df,,pickle.HIGHEST_PROTOCOL}, puede utilizarse para seleccionar el protocolo más elegante disponible.

Unpickling is no longer considered a safe operation.  2.2’s @ref{a6,,pickle}
provided hooks for trying to prevent unsafe classes from being unpickled
(specifically, a @code{__safe_for_unpickling__} attribute), but none of this
code was ever audited and therefore it’s all been ripped out in 2.3.  You should
not unpickle untrusted data in any version of Python.

To reduce the pickling overhead for new-style classes, a new interface for
customizing pickling was added using three special methods:
@ref{679,,__getstate__()}, @ref{14e0,,__setstate__()}, and @ref{14e1,,__getnewargs__()}.  Consult
@geindex Python Enhancement Proposals; PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} for the full semantics  of these methods.

Como forma de comprimir aún más los pickles, ahora es posible utilizar códigos enteros en lugar de cadenas largas para identificar las clases serializadas. La Python Software Foundation mantendrá una lista de códigos estandarizados; también hay una gama de códigos para uso privado.  Actualmente no se ha especificado ningún código.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 307

@item PEP 307@footnote{https://peps.python.org/pep-0307/} - Extensiones del protocolo pickle

Escrito y ejecutado por Guido van Rossum y Tim Peters.
@end table


@c ======================================================================

@node Rebanadas ampliadas,Otros cambios en el lenguaje<5>,PEP 307 Mejoras en Pickle,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 extended-slices}@anchor{14e2}@anchor{whatsnew/2 3 section-slices}@anchor{14e3}
@subsection Rebanadas ampliadas


Desde la versión 1.4 de Python, la sintaxis de corte admite un tercer argumento opcional «paso» o «zancada».  Por ejemplo, estas son todas las sintaxis legales de Python: @code{L[1:10:2]}, @code{L[:-1:1]}, @code{L[::-1]}.  Esto se añadió a Python a petición de los desarrolladores de Numerical Python, que utiliza ampliamente el tercer argumento.  Sin embargo, los tipos de secuencias de listas, tuplas y cadenas incorporados en Python nunca han soportado esta característica, y lanzan un @ref{228,,TypeError} si lo intentas. Michael Hudson ha contribuido con un parche para solucionar este problema.

Por ejemplo, ahora puede extraer fácilmente los elementos de una lista que tengan índices pares:

@example
>>> L = range(10)
>>> L[::2]
[0, 2, 4, 6, 8]
@end example

Los valores negativos también sirven para hacer una copia de la misma lista en orden inverso:

@example
>>> L[::-1]
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@end example

Esto también funciona para tuplas, arrays y cadenas:

@example
>>> s='abcd'
>>> s[::2]
'ac'
>>> s[::-1]
'dcba'
@end example

Si tienes una secuencia mutable, como una lista o un array, puedes asignar o eliminar una rebanada extendida, pero hay algunas diferencias entre la asignación a rebanadas extendidas y regulares.  La asignación a una rebanada regular se puede utilizar para cambiar la longitud de la secuencia:

@example
>>> a = range(3)
>>> a
[0, 1, 2]
>>> a[1:3] = [4, 5, 6]
>>> a
[0, 4, 5, 6]
@end example

Las rebanadas extendidas no son tan flexibles.  Cuando se asigna a una rebanada extendida, la lista a la derecha de la declaración debe contener el mismo número de elementos que la rebanada que está reemplazando:

@example
>>> a = range(4)
>>> a
[0, 1, 2, 3]
>>> a[::2]
[0, 2]
>>> a[::2] = [0, -1]
>>> a
[0, 1, -1, 3]
>>> a[::2] = [0,1,2]
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
ValueError: attempt to assign sequence of size 3 to extended slice of size 2
@end example

La eliminación es más sencilla:

@example
>>> a = range(4)
>>> a
[0, 1, 2, 3]
>>> a[::2]
[0, 2]
>>> del a[::2]
>>> a
[1, 3]
@end example

One can also now pass slice objects to the @ref{3d8,,__getitem__()} methods of the
built-in sequences:

@example
>>> range(10).__getitem__(slice(0, 5, 2))
[0, 2, 4]
@end example

O utilizar los objetos de corte directamente en los subíndices:

@example
>>> range(10)[slice(0, 5, 2)]
[0, 2, 4]
@end example

To simplify implementing sequences that support extended slicing, slice objects
now have a method @code{indices(length)} which, given the length of a sequence,
returns a @code{(start, stop, step)} tuple that can be passed directly to
@ref{9d6,,range()}. @code{indices()} handles omitted and out-of-bounds indices in a
manner consistent with regular slices (and this innocuous phrase hides a welter
of confusing details!).  The method is intended to be used like this:

@example
class FakeSeq:
    ...
    def calc_item(self, i):
        ...
    def __getitem__(self, item):
        if isinstance(item, slice):
            indices = item.indices(len(self))
            return FakeSeq([self.calc_item(i) for i in range(*indices)])
        else:
            return self.calc_item(i)
@end example

En este ejemplo también se puede ver que el objeto incorporado @ref{514,,slice} es ahora el objeto tipo para el tipo slice, y ya no es una función.  Esto es consistente con Python 2.2, donde @ref{1f0,,int}, @ref{237,,str}, etc., sufrieron el mismo cambio.

@c ======================================================================

@node Otros cambios en el lenguaje<5>,Módulos nuevos mejorados y obsoletos<4>,Rebanadas ampliadas,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 other-language-changes}@anchor{14e4}
@subsection Otros cambios en el lenguaje


Estos son todos los cambios que Python 2.3 introduce en el núcleo del lenguaje Python.


@itemize *

@item 
La expresión @ref{a5f,,yield} es ahora siempre una palabra clave, como se describe en la sección @ref{14c2,,PEP 255; Generadores simples} de este documento.

@item 
Se ha añadido una nueva función incorporada @ref{14bb,,enumerate()}, como se describe en la sección @ref{14cb,,PEP 279; enumerate()} de este documento.

@item 
Se han añadido dos nuevas constantes, @ref{c95,,True} y @ref{bbf,,False} junto con el tipo incorporado @ref{513,,bool}, como se describe en la sección @ref{14d3,,PEP 285; Un tipo booleano} de este documento.

@item 
El constructor de tipo @ref{1f0,,int()} ahora retornará un entero largo en lugar de lanzar un @ref{919,,OverflowError} cuando una cadena o un número de punto flotante es demasiado grande para caber en un entero.  Esto puede llevar al resultado paradójico de que @code{isinstance(int(expresión), int)} sea falso, pero parece poco probable que cause problemas en la práctica.

@item 
Los tipos incorporados ahora soportan la sintaxis de rebanado extendida, como se describe en la sección @ref{14e3,,Rebanadas ampliadas} de este documento.

@item 
Una nueva función incorporada, @code{suma(iterable, start=0)}, suma los elementos numéricos en el objeto iterable y retorna su suma. @code{suma()} sólo acepta números, lo que significa que no se puede utilizar para concatenar un montón de cadenas. (Contribución de Alex Martelli)

@item 
@code{list.insert(pos, valor)} solía insertar `valor' al principio de la lista cuando `pos' era negativo.  El comportamiento ha sido cambiado para ser consistente con la indexación de las rebanadas, así que cuando `pos' es -1 el valor será insertado antes del último elemento, y así sucesivamente.

@item 
@code{list.index(value)}, que busca `valor' dentro de la lista y retorna su índice, ahora toma los argumentos opcionales `start' y `stop' para limitar la búsqueda sólo a una parte de la lista.

@item 
Los diccionarios tienen un nuevo método, @code{pop(key[, *default*])}, que retorna el valor correspondiente a `key' y elimina ese par clave/valor del diccionario.  Si la clave solicitada no está presente en el diccionario, se retorna `default' si está especificada y se lanza @ref{438,,KeyError} si no lo está:

@example
>>> d = @{1:2@}
>>> d
@{1: 2@}
>>> d.pop(4)
Traceback (most recent call last):
  File "stdin", line 1, in ?
KeyError: 4
>>> d.pop(1)
2
>>> d.pop(1)
Traceback (most recent call last):
  File "stdin", line 1, in ?
KeyError: 'pop(): dictionary is empty'
>>> d
@{@}
>>>
@end example

También hay un nuevo método de clase, @code{dict.fromkeys(iterable, value)}, que crea un diccionario con claves tomadas del iterador `iterable' suministrado y todos los valores establecidos a `value', por defecto a @code{None}.

(Parches aportados por Raymond Hettinger)

Además, el constructor @ref{190,,dict()} ahora acepta argumentos de palabras clave para simplificar la creación de pequeños diccionarios:

@example
>>> dict(red=1, blue=2, green=3, black=4)
@{'blue': 2, 'black': 4, 'green': 3, 'red': 1@}
@end example

(Contribución de Just van Rossum.)

@item 
La expresión @ref{9fa,,assert} ya no comprueba la bandera @code{debug__}, por lo que ya no se pueden desactivar las aserciones asignando a @code{__debug__}. Ejecutar Python con la opción @ref{14f,,-O} seguirá generando código que no ejecute ninguna aserción.

@item 
Most type objects are now callable, so you can use them to create new objects
such as functions, classes, and modules.  (This means that the @code{new} module
can be deprecated in a future Python version, because you can now use the type
objects available in the @ref{103,,types} module.) For example, you can create a new
module object with the following code:

@example
>>> import types
>>> m = types.ModuleType('abc','docstring')
>>> m
<module 'abc' (built-in)>
>>> m.__doc__
'docstring'
@end example

@item 
Se ha añadido una nueva advertencia, @ref{95f,,PendingDeprecationWarning} para indicar las características que están en proceso de ser obsoletas.  La advertencia no se imprimirá por defecto.  Para comprobar el uso de funciones que quedarán obsoletas en el futuro, proporcione @ref{95e,,-Walways;;PendingDeprecationWarning;;} en la línea de comandos o utilice @ref{14e5,,warnings.filterwarnings()}.

@item 
Ha comenzado el proceso de desaprobación de las excepciones basadas en cadenas, como en @code{lanzamiento de "Error ocurred”}.  Al lanzar una cadena, ahora se activará @ref{95f,,PendingDeprecationWarning}.

@item 
El uso de @code{None} como nombre de una variable ahora resultará en una advertencia @ref{511,,SyntaxWarning}.  En una futura versión de Python, @code{None} podría convertirse en una palabra clave.

@item 
The @code{xreadlines()} method of file objects, introduced in Python 2.1, is no
longer necessary because files now behave as their own iterator.
@code{xreadlines()} was originally introduced as a faster way to loop over all
the lines in a file, but now you can simply write @code{for line in file_obj}.
File objects also have a new read-only @code{encoding} attribute that gives the
encoding used by the file; Unicode strings written to the file will be
automatically  converted to bytes using the given encoding.

@item 
The method resolution order used by new-style classes has changed, though
you’ll only notice the difference if you have a really complicated inheritance
hierarchy.  Classic classes are unaffected by this change.  Python 2.2
originally used a topological sort of a class’s ancestors, but 2.3 now uses the
C3 algorithm as described in the paper "A Monotonic Superclass Linearization for Dylan"@footnote{https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.3910}. To
understand the motivation for this change,  read Michele Simionato’s article
@ref{14e6,,The Python 2.3 Method Resolution Order}, or
read the thread on python-dev starting with the message at
@indicateurl{https://mail.python.org/pipermail/python-dev/2002-October/029035.html}. Samuele
Pedroni first pointed out the problem and also implemented the fix by coding the
C3 algorithm.

@item 
Python runs multithreaded programs by switching between threads after
executing N bytecodes.  The default value for N has been increased from 10 to
100 bytecodes, speeding up single-threaded applications by reducing the
switching overhead.  Some multithreaded applications may suffer slower response
time, but that’s easily fixed by setting the limit back to a lower number using
@code{sys.setcheckinterval(N)}. The limit can be retrieved with the new
@code{sys.getcheckinterval()} function.

@item 
One minor but far-reaching change is that the names of extension types defined
by the modules included with Python now contain the module and a @code{'.'} in
front of the type name.  For example, in Python 2.2, if you created a socket and
printed its @code{__class__}, you’d get this output:

@example
>>> s = socket.socket()
>>> s.__class__
<type 'socket'>
@end example

En 2.3, se obtiene esto:

@example
>>> s.__class__
<type '_socket.socket'>
@end example

@item 
One of the noted incompatibilities between old- and new-style classes has been
removed: you can now assign to the @ref{14e7,,__name__} and @ref{14e8,,__bases__}
attributes of new-style classes.  There are some restrictions on what can be
assigned to @code{__bases__} along the lines of those relating to assigning to
an instance’s @ref{14e9,,__class__} attribute.
@end itemize

@c ======================================================================

@menu
* Cambios en las cadenas de texto:: 
* Optimizaciones: Optimizaciones<15>. 

@end menu

@node Cambios en las cadenas de texto,Optimizaciones<15>,,Otros cambios en el lenguaje<5>
@anchor{whatsnew/2 3 string-changes}@anchor{14ea}
@subsubsection Cambios en las cadenas de texto



@itemize *

@item 
El operador @ref{1ed,,in} ahora funciona de forma diferente para las cadenas. Antes, cuando se evaluaba @code{X en Y} donde `X' y `Y' eran cadenas, `X' sólo podía ser un único carácter. Esto ha cambiado; `X' puede ser una cadena de cualquier longitud, y @code{X en Y} retornará @ref{c95,,True} si `X' es una subcadena de `Y'.  Si `X' es una cadena vacía, el resultado es siempre @ref{c95,,True}.

@example
>>> 'ab' in 'abcd'
True
>>> 'ad' in 'abcd'
False
>>> '@w{'} in 'abcd'
True
@end example

Note that this doesn’t tell you where the substring starts; if you need that
information, use the @ref{f29,,find()} string method.

@item 
The @ref{14eb,,strip()}, @ref{14ec,,lstrip()}, and @ref{14ed,,rstrip()} string methods now have
an optional argument for specifying the characters to strip.  The default is
still to remove all whitespace characters:

@example
>>> '   abc '.strip()
'abc'
>>> '><><abc<><><>'.strip('<>')
'abc'
>>> '><><abc<><><>\n'.strip('<>')
'abc<><><>\n'
>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
u'\u4001abc'
>>>
@end example

(Sugerido por Simon Brunning y aplicado por Walter Dörwald)

@item 
The @ref{f4c,,startswith()} and @ref{f4d,,endswith()} string methods now accept negative
numbers for the `start' and `end' parameters.

@item 
Another new string method is @ref{14ee,,zfill()}, originally a function in the
@ref{d3,,string} module.  @ref{14ee,,zfill()} pads a numeric string with zeros on the
left until it’s the specified width. Note that the @code{%} operator is still more
flexible and powerful than @ref{14ee,,zfill()}.

@example
>>> '45'.zfill(4)
'0045'
>>> '12345'.zfill(4)
'12345'
>>> 'goofy'.zfill(6)
'0goofy'
@end example

(Contribución de Walter Dörwald.)

@item 
A new type object, @code{basestring}, has been added. Both 8-bit strings and
Unicode strings inherit from this type, so @code{isinstance(obj, basestring)} will
return @ref{c95,,True} for either kind of string.  It’s a completely abstract
type, so you can’t create @code{basestring} instances.

@item 
Las cadenas internas ya no son inmortales y ahora serán recolectadas de la forma habitual cuando la única referencia a ellas sea desde el diccionario interno de cadenas internas.  (Implementado por Oren Tirosh)
@end itemize

@c ======================================================================

@node Optimizaciones<15>,,Cambios en las cadenas de texto,Otros cambios en el lenguaje<5>
@anchor{whatsnew/2 3 optimizations}@anchor{14ef}
@subsubsection Optimizaciones



@itemize *

@item 
La creación de instancias de clases de estilo nuevo se ha hecho mucho más rápida; ¡ahora son más rápidas que las clases clásicas!

@item 
The @ref{c57,,sort()} method of list objects has been extensively rewritten by Tim
Peters, and the implementation is significantly faster.

@item 
Multiplication of large long integers is now much faster thanks to an
implementation of Karatsuba multiplication, an algorithm that scales better than
the `O'(`n'@w{^2}) required for the grade-school multiplication algorithm.  (Original
patch by Christopher A. Craig, and significantly reworked by Tim Peters.)

@item 
El opcode @code{SET_LINENO} ha desaparecido.  Esto puede proporcionar un pequeño aumento de velocidad, dependiendo de la idiosincrasia de su compilador. Vea la sección @ref{14f0,,Otros cambios y correcciones} para una explicación más larga. (Eliminado por Michael Hudson)

@item 
@code{xrange()} objects now have their own iterator, making @code{for i in
xrange(n)} slightly faster than @code{for i in range(n)}.  (Patch by Raymond
Hettinger.)

@item 
Se han realizado una serie de pequeños reajustes en varios puntos conflictivos para mejorar el rendimiento, como por ejemplo alinear una función o eliminar algo de código.  (Implementado principalmente por GvR, pero mucha gente ha contribuido con cambios individuales)
@end itemize

El resultado neto de las optimizaciones de la versión 2.3 es que Python 2.3 ejecuta el benchmark pystone alrededor de un 25% f más rápido que Python 2.2.

@c ======================================================================

@node Módulos nuevos mejorados y obsoletos<4>,Pymalloc un asignador de objetos especializado,Otros cambios en el lenguaje<5>,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 new-improved-and-deprecated-modules}@anchor{14f1}
@subsection Módulos nuevos, mejorados y obsoletos


Como es habitual, la biblioteca estándar de Python ha recibido una serie de mejoras y correcciones de errores.  Aquí hay una lista parcial de los cambios más notables, ordenados alfabéticamente por nombre de módulo. Consulte el archivo @code{Misc/NEWS} en el árbol de fuentes para obtener una lista más completa de los cambios, o busque en los registros de CVS para obtener todos los detalles.


@itemize *

@item 
El módulo @ref{8,,array} soporta ahora matrices de caracteres Unicode que utilizan el carácter de formato @code{'u}.  Las matrices también soportan ahora el uso del operador de asignación @code{+=} para añadir el contenido de otra matriz, y el operador de asignación @code{*=} para repetir una matriz. (Contribución de Jason Orendorff)

@item 
The @code{bsddb} module has been replaced by version 4.1.6 of the PyBSDDB@footnote{https://pybsddb.sourceforge.net} package, providing a more complete interface
to the transactional features of the BerkeleyDB library.

The old version of the module has been renamed to  @code{bsddb185} and is no
longer built automatically; you’ll  have to edit @code{Modules/Setup} to enable
it.  Note that the new @code{bsddb} package is intended to be compatible with
the  old module, so be sure to file bugs if you discover any incompatibilities.
When upgrading to Python 2.3, if the new interpreter is compiled with a new
version of  the underlying BerkeleyDB library, you will almost certainly have to
convert your database files to the new version.  You can do this fairly easily
with the new scripts @code{db2pickle.py} and @code{pickle2db.py} which you
will find in the distribution’s @code{Tools/scripts} directory.  If you’ve
already been using the PyBSDDB package and importing it as @code{bsddb3}, you
will have to change your @code{import} statements to import it as @code{bsddb}.

@item 
El nuevo módulo @ref{14,,bz2} es una interfaz para la biblioteca de compresión de datos bz2. Los datos comprimidos con bz2 suelen ser más pequeños que los correspondientes datos comprimidos con @ref{132,,zlib}. (Contribución de Gustavo Niemeyer)

@item 
Se ha añadido un conjunto de tipos de fecha/hora estándar en el nuevo módulo @ref{31,,datetime}.  Consulte la siguiente sección para obtener más detalles.

@item 
The Distutils @code{Extension} class now supports an extra constructor
argument named `depends' for listing additional source files that an extension
depends on.  This lets Distutils recompile the module if any of the dependency
files are modified.  For example, if @code{sampmodule.c} includes the header
file @code{sample.h}, you would create the @code{Extension} object like
this:

@example
ext = Extension("samp",
                sources=["sampmodule.c"],
                depends=["sample.h"])
@end example

La modificación de @code{sample.h} haría que el módulo se recompilara. (Contribución de Jeremy Hylton)

@item 
Other minor changes to Distutils: it now checks for the 
@geindex CC
@geindex variables de entorno; CC
@ref{14f2,,CC},
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS}, @code{CPP}, 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS}, and 
@geindex CPPFLAGS
@geindex variables de entorno; CPPFLAGS
@ref{14f5,,CPPFLAGS}
environment variables, using them to override the settings in Python’s
configuration (contributed by Robert Weber).

@item 
Previously the @ref{3b,,doctest} module would only search the docstrings of
public methods and functions for test cases, but it now also examines private
ones as well.  The @ref{e78,,DocTestSuite()} function creates a
@ref{e79,,unittest.TestSuite} object from a set of @ref{3b,,doctest} tests.

@item 
La nueva función @code{gc.get_referents(object)} retorna una lista de todos los objetos referenciados por `object'.

@item 
The @ref{61,,getopt} module gained a new function, @ref{14f6,,gnu_getopt()}, that
supports the same arguments as the existing @ref{14f7,,getopt()} function but uses
GNU-style scanning mode. The existing @ref{14f7,,getopt()} stops processing options as
soon as a non-option argument is encountered, but in GNU-style mode processing
continues, meaning that options and arguments can be mixed.  For example:

@example
>>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
([('-f', 'filename')], ['output', '-v'])
>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
([('-f', 'filename'), ('-v', '@w{'})], ['output'])
@end example

(Contribución de Peter Åstrand.)

@item 
Los módulos @ref{66,,grp}, @ref{b2,,pwd} y @ref{bc,,resource} retornan ahora tuplas mejoradas:

@example
>>> import grp
>>> g = grp.getgrnam('amk')
>>> g.gr_name, g.gr_gid
('amk', 500)
@end example

@item 
El módulo @ref{67,,gzip} ahora puede manejar archivos de más de 2 GiB.

@item 
The new @ref{69,,heapq} module contains an implementation of a heap queue
algorithm.  A heap is an array-like data structure that keeps items in a
partially sorted order such that, for every index `k', @code{heap[k] <=
heap[2*k+1]} and @code{heap[k] <= heap[2*k+2]}.  This makes it quick to remove the
smallest item, and inserting a new item while maintaining the heap property is
`O'(log `n').  (See @indicateurl{https://xlinux.nist.gov/dads//HTML/priorityque.html} for more
information about the priority queue data structure.)

The @ref{69,,heapq} module provides @ref{14f8,,heappush()} and @ref{14f9,,heappop()} functions
for adding and removing items while maintaining the heap property on top of some
other mutable Python sequence type.  Here’s an example that uses a Python list:

@example
>>> import heapq
>>> heap = []
>>> for item in [3, 7, 5, 11, 1]:
...    heapq.heappush(heap, item)
...
>>> heap
[1, 3, 5, 11, 7]
>>> heapq.heappop(heap)
1
>>> heapq.heappop(heap)
3
>>> heap
[5, 7, 11]
@end example

(Contribución de Kevin O’Connor.)

@item 
El entorno de desarrollo integrado IDLE ha sido actualizado utilizando el código del proyecto IDLEfork (@indicateurl{http://idlefork.sourceforge.net}).  La característica más notable es que el código que se está desarrollando se ejecuta ahora en un subproceso, lo que significa que ya no es necesario realizar operaciones manuales de @code{reload()}. El código central de IDLE ha sido incorporado a la biblioteca estándar como el paquete @ref{73,,idlelib}.

@item 
El módulo @ref{74,,imaplib} ahora admite IMAP sobre SSL. (Contribuido por Piers Lauder y Tino Lange.)

@item 
The @ref{81,,itertools} contains a number of useful functions for use with
iterators, inspired by various functions provided by the ML and Haskell
languages.  For example, @code{itertools.ifilter(predicate, iterator)} returns all
elements in the iterator for which the function @code{predicate()} returns
@ref{c95,,True}, and @code{itertools.repeat(obj, N)} returns @code{obj} `N' times.
There are a number of other functions in the module; see the package’s reference
documentation for details.
(Contributed by Raymond Hettinger.)

@item 
Dos nuevas funciones en el módulo @ref{8e,,math}, @code{degrees(rads)} y @code{radians(degs)}, convierten entre radianes y grados. Otras funciones del módulo @ref{8e,,math}, como @ref{14fa,,math.sin()} y @ref{14fb,,math.cos()}, siempre han requerido valores de entrada medidos en radianes. Además, se agregó un argumento opcional `base' a @ref{14fc,,math.log()} para facilitar el cálculo de logaritmos para bases distintas de @code{e} y @code{10}. (Contribuido por Raymond Hettinger.)

@item 
Several new POSIX functions (@code{getpgid()}, @code{killpg()}, @code{lchown()},
@code{loadavg()}, @code{major()}, @code{makedev()}, @code{minor()}, and
@code{mknod()}) were added to the @ref{ad,,posix} module that underlies the
@ref{a1,,os} module. (Contributed by Gustavo Niemeyer, Geert Jansen, and Denis S.
Otkidach.)

@item 
In the @ref{a1,,os} module, the @code{*stat()} family of functions can now report
fractions of a second in a timestamp.  Such time stamps are represented as
floats, similar to the value returned by @ref{3ad,,time.time()}.

During testing, it was found that some applications will break if time stamps
are floats.  For compatibility, when using the tuple interface of the
@ref{14fd,,stat_result} time stamps will be represented as integers. When using
named fields (a feature first introduced in Python 2.2), time stamps are still
represented as integers, unless @code{os.stat_float_times()} is invoked to enable
float return values:

@example
>>> os.stat("/tmp").st_mtime
1034791200
>>> os.stat_float_times(True)
>>> os.stat("/tmp").st_mtime
1034791200.6335014
@end example

En Python 2.4, el valor predeterminado cambiará para devolver siempre flotantes.

Application developers should enable this feature only if all their libraries
work properly when confronted with floating-point time stamps, or if they use
the tuple API. If used, the feature should be activated on an application level
instead of trying to enable it on a per-use basis.

@item 
El módulo @ref{a0,,optparse} contiene un nuevo analizador para argumentos de línea de comandos que puede convertir valores de opción a un tipo de Python en particular y generará automáticamente un mensaje de uso. Consulte la siguiente sección para obtener más detalles.

@item 
The old and never-documented @code{linuxaudiodev} module has been deprecated,
and a new version named @code{ossaudiodev} has been added.  The module was
renamed because the OSS sound drivers can be used on platforms other than Linux,
and the interface has also been tidied and brought up to date in various ways.
(Contributed by Greg Ward and Nicholas FitzRoy-Dale.)

@item 
El nuevo módulo @ref{aa,,platform} contiene una serie de funciones que intentan determinar varias propiedades de la plataforma en la que se está ejecutando. Hay funciones para obtener la arquitectura, el tipo de CPU, la versión del sistema operativo Windows e incluso la versión de distribución de Linux. (Contribución de Marc-André Lemburg.)

@item 
The parser objects provided by the @ref{126,,pyexpat} module can now optionally
buffer character data, resulting in fewer calls to your character data handler
and therefore faster performance.  Setting the parser object’s
@ref{14fe,,buffer_text} attribute to @ref{c95,,True} will enable buffering.

@item 
The @code{sample(population, k)} function was added to the @ref{b8,,random}
module.  `population' is a sequence or @code{xrange} object containing the
elements of a population, and @ref{7e1,,sample()} chooses `k' elements from the
population without replacing chosen elements.  `k' can be any value up to
@code{len(population)}. For example:

@example
>>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
>>> random.sample(days, 3)      # Choose 3 elements
['St', 'Sn', 'Th']
>>> random.sample(days, 7)      # Choose 7 elements
['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
>>> random.sample(days, 7)      # Choose 7 again
['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
>>> random.sample(days, 8)      # Can't choose eight
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "random.py", line 414, in sample
      raise ValueError, "sample larger than population"
ValueError: sample larger than population
>>> random.sample(xrange(1,10000,2), 10)   # Choose ten odd nos. under 10000
[3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]
@end example

El módulo @ref{b8,,random} ahora usa un nuevo algoritmo, el Mersenne Twister, implementado en C. Es más rápido y más estudiado que el algoritmo anterior.

(Parches aportados por Raymond Hettinger)

@item 
The @ref{ba,,readline} module also gained a number of new functions:
@ref{14ff,,get_history_item()}, @ref{1500,,get_current_history_length()}, and
@ref{1501,,redisplay()}.

@item 
The @code{rexec} and @code{Bastion} modules have been declared dead, and
attempts to import them will fail with a @ref{1e5,,RuntimeError}.  New-style classes
provide new ways to break out of the restricted execution environment provided
by @code{rexec}, and no one has interest in fixing them or time to do so.  If
you have applications using @code{rexec}, rewrite them to use something else.

(Sticking with Python 2.2 or 2.1 will not make your applications any safer
because there are known bugs in the @code{rexec} module in those versions.  To
repeat: if you’re using @code{rexec}, stop using it immediately.)

@item 
The @code{rotor} module has been deprecated because the  algorithm it uses for
encryption is not believed to be secure.  If you need encryption, use one of the
several AES Python modules that are available separately.

@item 
El módulo @ref{c5,,shutil} obtuvo una función @code{move(src, dest)} que mueve recursivamente un archivo o directorio a una nueva ubicación.

@item 
Se agregó soporte para un manejo de señal POSIX más avanzado al @ref{c6,,signal}, pero luego se eliminó nuevamente, ya que resultó imposible hacerlo funcionar de manera confiable en todas las plataformas.

@item 
El módulo @ref{cc,,socket} ahora admite tiempos de espera. Puede llamar al método @code{settimeout(t)} en un objeto de socket para establecer un tiempo de espera de `t' seconds. Subsequent socket operations that take longer than `t' segundos para completar, abortará y lanzará una excepción @ref{8cb,,socket.timeout}.

La implementación del tiempo de espera original fue realizada por Tim O’Malley. Michael Gilfix lo integró en el módulo Python @ref{cc,,socket} y lo guió a través de una extensa revisión. Después de que se registró el código, Guido van Rossum reescribió partes del mismo. (Este es un buen ejemplo de un proceso de desarrollo colaborativo en acción).

@item 
En Windows, el módulo @ref{cc,,socket} ahora se envía con compatibilidad con Secure Sockets Layer (SSL).

@item 
The value of the C @code{PYTHON_API_VERSION} macro is now exposed at the
Python level as @code{sys.api_version}.  The current exception can be cleared by
calling the new @code{sys.exc_clear()} function.

@item 
El nuevo módulo @ref{de,,tarfile} permite leer y escribir en: programa: @cite{tar} -format archivos de almacenamiento. (Contribución de Lars Gustäbel.)

@item 
The new @ref{ec,,textwrap} module contains functions for wrapping strings
containing paragraphs of text.  The @code{wrap(text, width)} function takes a
string and returns a list containing the text split into lines of no more than
the chosen width.  The @code{fill(text, width)} function returns a single
string, reformatted to fit into lines no longer than the chosen width. (As you
can guess, @ref{1502,,fill()} is built on top of @ref{1503,,wrap()}.  For example:

@example
>>> import textwrap
>>> paragraph = "Not a whit, we defy augury: ... more text ..."
>>> textwrap.wrap(paragraph, 60)
["Not a whit, we defy augury: there's a special providence in",
 "the fall of a sparrow. If it be now, 'tis not to come; if it",
 ...]
>>> print textwrap.fill(paragraph, 35)
Not a whit, we defy augury: there's
a special providence in the fall of
a sparrow. If it be now, 'tis not
to come; if it be not to come, it
will be now; if it be not now, yet
it will come: the readiness is all.
>>>
@end example

The module also contains a @ref{104c,,TextWrapper} class that actually implements
the text wrapping strategy.   Both the @ref{104c,,TextWrapper} class and the
@ref{1503,,wrap()} and @ref{1502,,fill()} functions support a number of additional keyword
arguments for fine-tuning the formatting; consult the module’s documentation
for details. (Contributed by Greg Ward.)

@item 
The @code{thread} and @ref{ed,,threading} modules now have companion modules,
@code{dummy_thread} and @code{dummy_threading}, that provide a do-nothing
implementation of the @code{thread} module’s interface for platforms where
threads are not supported.  The intention is to simplify thread-aware modules
(ones that `don’t' rely on threads to run) by putting the following code at the
top:

@example
try:
    import threading as _threading
except ImportError:
    import dummy_threading as _threading
@end example

In this example, @code{_threading} is used as the module name to make it clear
that the module being used is not necessarily the actual @ref{ed,,threading}
module. Code can call functions and use classes in @code{_threading} whether or
not threads are supported, avoiding an @ref{1ec,,if} statement and making the
code slightly clearer.  This module will not magically make multithreaded code
run without threads; code that waits for another thread to return or to do
something will simply hang forever.

@item 
The @ref{ee,,time} module’s @ref{146c,,strptime()} function has long been an annoyance
because it uses the platform C library’s @ref{146c,,strptime()} implementation, and
different platforms sometimes have odd bugs.  Brett Cannon contributed a
portable implementation that’s written in pure Python and should behave
identically on all platforms.

@item 
The new @ref{ef,,timeit} module helps measure how long snippets of Python code
take to execute.  The @code{timeit.py} file can be run directly from the
command line, or the module’s @ref{1504,,Timer} class can be imported and used
directly.  Here’s a short example that figures out whether it’s faster to
convert an 8-bit string to Unicode by appending an empty Unicode string to it or
by using the @code{unicode()} function:

@example
import timeit

timer1 = timeit.Timer('unicode("abc")')
timer2 = timeit.Timer('"abc" + u""')

# Run three trials
print timer1.repeat(repeat=3, number=100000)
print timer2.repeat(repeat=3, number=100000)

# On my laptop this outputs:
# [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
# [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]
@end example

@item 
The @code{Tix} module has received various bug fixes and updates for the
current version of the Tix package.

@item 
The @code{Tkinter} module now works with a thread-enabled  version of Tcl.
Tcl’s threading model requires that widgets only be accessed from the thread in
which they’re created; accesses from another thread can cause Tcl to panic.  For
certain Tcl interfaces, @code{Tkinter} will now automatically avoid this  when a
widget is accessed from a different thread by marshalling a command, passing it
to the correct thread, and waiting for the results.  Other interfaces can’t be
handled automatically but @code{Tkinter} will now raise an exception on such an
access so that you can at least find out about the problem.  See
@indicateurl{https://mail.python.org/pipermail/python-dev/2002-December/031107.html} for a more
detailed explanation of this change.  (Implemented by Martin von Löwis.)

@item 
Calling Tcl methods through @code{_tkinter} no longer  returns only strings.
Instead, if Tcl returns other objects those objects are converted to their
Python equivalent, if one exists, or wrapped with a @code{_tkinter.Tcl_Obj}
object if no Python equivalent exists. This behavior can be controlled through
the @code{wantobjects()} method of @code{tkapp} objects.

When using @code{_tkinter} through the @code{Tkinter} module (as most Tkinter
applications will), this feature is always activated. It should not cause
compatibility problems, since Tkinter would always convert string results to
Python types where possible.

If any incompatibilities are found, the old behavior can be restored by setting
the @code{wantobjects} variable in the @code{Tkinter} module to false before
creating the first @code{tkapp} object.

@example
import Tkinter
Tkinter.wantobjects = 0
@end example

Cualquier rotura causada por este cambio debe notificarse como un error.

@item 
The @code{UserDict} module has a new @code{DictMixin} class which defines
all dictionary methods for classes that already have a minimum mapping
interface.  This greatly simplifies writing classes that need to be
substitutable for dictionaries, such as the classes in  the @ref{c3,,shelve}
module.

Adding the mix-in as a superclass provides the full dictionary interface
whenever the class defines @ref{3d8,,__getitem__()}, @ref{1505,,__setitem__()},
@ref{1506,,__delitem__()}, and @code{keys()}. For example:

@example
>>> import UserDict
>>> class SeqDict(UserDict.DictMixin):
...     """Dictionary lookalike implemented with lists."""
...     def __init__(self):
...         self.keylist = []
...         self.valuelist = []
...     def __getitem__(self, key):
...         try:
...             i = self.keylist.index(key)
...         except ValueError:
...             raise KeyError
...         return self.valuelist[i]
...     def __setitem__(self, key, value):
...         try:
...             i = self.keylist.index(key)
...             self.valuelist[i] = value
...         except ValueError:
...             self.keylist.append(key)
...             self.valuelist.append(value)
...     def __delitem__(self, key):
...         try:
...             i = self.keylist.index(key)
...         except ValueError:
...             raise KeyError
...         self.keylist.pop(i)
...         self.valuelist.pop(i)
...     def keys(self):
...         return list(self.keylist)
...
>>> s = SeqDict()
>>> dir(s)      # See that other dictionary methods are implemented
['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
 '__init__', '__iter__', '__len__', '__module__', '__repr__',
 '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
 'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
 'setdefault', 'update', 'valuelist', 'values']
@end example

(Parches aportados por Raymond Hettinger)

@item 
The DOM implementation in @ref{122,,xml.dom.minidom} can now generate XML output
in a particular encoding by providing an optional encoding argument to the
@ref{1507,,toxml()} and @ref{1508,,toprettyxml()} methods of DOM nodes.

@item 
The @code{xmlrpclib} module now supports an XML-RPC extension for handling nil
data values such as Python’s @code{None}.  Nil values are always supported on
unmarshalling an XML-RPC response.  To generate requests containing @code{None},
you must supply a true value for the `allow_none' parameter when creating a
@code{Marshaller} instance.

@item 
The new @code{DocXMLRPCServer} module allows writing self-documenting XML-RPC
servers. Run it in demo mode (as a program) to see it in action.   Pointing the
web browser to the RPC server produces pydoc-style documentation; pointing
xmlrpclib to the server allows invoking the actual methods. (Contributed by
Brian Quinlan.)

@item 
Se ha agregado soporte para nombres de dominio internacionalizados (RFCs 3454, 3490, 3491 y 3492). La codificación «idna» se puede utilizar para convertir entre un nombre de dominio Unicode y la codificación compatible con ASCII (ACE) de ese nombre.

@example
>@{@}>@{@}> u"www.Alliancefrançaise.nu".encode("idna")
'www.xn--alliancefranaise-npb.nu'
@end example

The @ref{cc,,socket} module has also been extended to transparently convert
Unicode hostnames to the ACE version before passing them to the C library.
Modules that deal with hostnames such as @code{httplib} and @ref{5e,,ftplib})
also support Unicode host names; @code{httplib} also sends HTTP @code{Host}
headers using the ACE version of the domain name.  @ref{108,,urllib} supports
Unicode URLs with non-ASCII host names as long as the @code{path} part of the URL
is ASCII only.

Para implementar este cambio, se han agregado el módulo @ref{d4,,stringprep}, la herramienta @code{mkstringprep} y la codificación @code{punycode}.
@end itemize

@c ======================================================================

@menu
* Tipo de fecha / hora:: 
* El módulo optparse:: 

@end menu

@node Tipo de fecha / hora,El módulo optparse,,Módulos nuevos mejorados y obsoletos<4>
@anchor{whatsnew/2 3 date-time-type}@anchor{1509}
@subsubsection Tipo de fecha / hora


Se agregaron tipos de fecha y hora adecuados para expresar marcas de tiempo como módulo @ref{31,,datetime}. Los tipos no admiten diferentes calendarios ni muchas funciones sofisticadas, y solo se ciñen a los conceptos básicos de la representación del tiempo.

The three primary types are: @ref{330,,date}, representing a day, month, and year;
@ref{331,,time}, consisting of hour, minute, and second; and @ref{32f,,datetime},
which contains all the attributes of both @ref{330,,date} and @ref{331,,time}.
There’s also a @ref{a61,,timedelta} class representing differences between two
points in time, and time zone logic is implemented by classes inheriting from
the abstract @ref{67f,,tzinfo} class.

You can create instances of @ref{330,,date} and @ref{331,,time} by either supplying
keyword arguments to the appropriate constructor, e.g.
@code{datetime.date(year=1972, month=10, day=15)}, or by using one of a number of
class methods.  For example, the @ref{150a,,today()} class method returns the
current local date.

Una vez creadas, las instancias de las clases de fecha / hora son inmutables. Hay varios métodos para producir cadenas formateadas a partir de objetos:

@example
>>> import datetime
>>> now = datetime.datetime.now()
>>> now.isoformat()
'2002-12-30T21:27:03.994956'
>>> now.ctime()  # Only available on date, datetime
'Mon Dec 30 21:27:03 2002'
>>> now.strftime('%Y %d %b')
'2002 30 Dec'
@end example

The @ref{150b,,replace()} method allows modifying one or more fields  of a
@ref{330,,date} or @ref{32f,,datetime} instance, returning a new instance:

@example
>>> d = datetime.datetime.now()
>>> d
datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
>>> d.replace(year=2001, hour = 12)
datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
>>>
@end example

Instances can be compared, hashed, and converted to strings (the result is the
same as that of @ref{bb9,,isoformat()}).  @ref{330,,date} and @ref{32f,,datetime}
instances can be subtracted from each other, and added to @ref{a61,,timedelta}
instances.  The largest missing feature is that there’s no standard library
support for parsing strings and getting back a @ref{330,,date} or
@ref{32f,,datetime}.

Para obtener más información, consulte la documentación de referencia del módulo. (Contribuido por Tim Peters.)

@c ======================================================================

@node El módulo optparse,,Tipo de fecha / hora,Módulos nuevos mejorados y obsoletos<4>
@anchor{whatsnew/2 3 the-optparse-module}@anchor{150c}
@subsubsection El módulo optparse


El módulo @ref{61,,getopt} proporciona un análisis sencillo de los argumentos de la línea de comandos. El nuevo módulo @ref{a0,,optparse} (originalmente llamado Optik) proporciona un análisis de línea de comandos más elaborado que sigue las convenciones de Unix, crea automáticamente la salida para @code{--help} y puede realizar diferentes acciones para diferentes opciones.

You start by creating an instance of @ref{150d,,OptionParser} and telling it what
your program’s options are.

@example
import sys
from optparse import OptionParser

op = OptionParser()
op.add_option('-i', '--input',
              action='store', type='string', dest='input',
              help='set input filename')
op.add_option('-l', '--length',
              action='store', type='int', dest='length',
              help='set maximum length of output')
@end example

Parsing a command line is then done by calling the @ref{150e,,parse_args()} method.

@example
options, args = op.parse_args(sys.argv[1:])
print options
print args
@end example

Esto devuelve un objeto que contiene todos los valores de las opciones y una lista de cadenas que contienen los argumentos restantes.

Invocar el script con los distintos argumentos ahora funciona como era de esperar. Tenga en cuenta que el argumento de longitud se convierte automáticamente en un número entero.

@example
$ ./python opt.py -i data arg1
<Values at 0x400cad4c: @{'input': 'data', 'length': None@}>
['arg1']
$ ./python opt.py --input=data --length=4
<Values at 0x400cad2c: @{'input': 'data', 'length': 4@}>
[]
$
@end example

El mensaje de ayuda se genera automáticamente para usted:

@example
$ ./python opt.py --help
usage: opt.py [options]

options:
  -h, --help            show this help message and exit
  -iINPUT, --input=INPUT
                        set input filename
  -lLENGTH, --length=LENGTH
                        set maximum length of output
$
@end example

Consulte la documentación del módulo para obtener más detalles.

Optik fue escrito por Greg Ward, con sugerencias de los lectores de Getopt SIG.

@c ======================================================================

@node Pymalloc un asignador de objetos especializado,Cambios en la API de Build y C<3>,Módulos nuevos mejorados y obsoletos<4>,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 pymalloc-a-specialized-object-allocator}@anchor{150f}@anchor{whatsnew/2 3 section-pymalloc}@anchor{1510}
@subsection Pymalloc: un asignador de objetos especializado


Pymalloc, un asignador de objetos especializado escrito por Vladimir Marangozov, fue una característica agregada a Python 2.1. Pymalloc está diseñado para ser más rápido que el sistema @code{malloc()} y tener menos sobrecarga de memoria para los patrones de asignación típicos de los programas Python. El asignador utiliza la función @code{malloc()} de C para obtener grandes grupos de memoria y luego satisface las solicitudes de memoria más pequeñas de estos grupos.

En 2.1 y 2.2, pymalloc era una función experimental y no estaba habilitada de forma predeterminada; tenía que habilitarlo explícitamente al compilar Python proporcionando la opción @code{--with-pymalloc} al script: program: @cite{configure}. En 2.3, pymalloc ha tenido más mejoras y ahora está habilitado de forma predeterminada; tendrá que suministrar @code{--without-pymalloc} para deshabilitarlo.

Este cambio es transparente para el código escrito en Python; sin embargo, pymalloc puede exponer errores en las extensiones C. Los autores de los módulos de extensión C deben probar su código con pymalloc habilitado, ya que algunos códigos incorrectos pueden causar volcados de núcleo en tiempo de ejecución.

Hay un error particularmente común que causa problemas. Hay una serie de funciones de asignación de memoria en la API C de Python que anteriormente solo eran alias para @code{malloc()} y @code{free()} de la biblioteca C, lo que significa que si llama accidentalmente a funciones que no coinciden, el error no se notará. Cuando el asignador de objetos está habilitado, estas funciones ya no son alias de @code{malloc()} y @code{free()}, y llamar a la función incorrecta para liberar memoria puede generar un volcado de memoria. Por ejemplo, si la memoria se asignó utilizando @ref{cf0,,PyObject_Malloc()}, debe liberarse utilizando @ref{ced,,PyObject_Free()}, no @code{free()}. Algunos módulos incluidos con Python entraron en conflicto con esto y tuvieron que ser reparados; sin duda hay más módulos de terceros que tendrán el mismo problema.

Como parte de este cambio, las confusas interfaces múltiples para asignar memoria se han consolidado en dos familias de API. La memoria asignada a una familia no debe manipularse con funciones de la otra familia. Hay una familia para asignar fragmentos de memoria y otra familia de funciones específicamente para asignar objetos Python.


@itemize *

@item 
Para asignar y liberar una porción de memoria no distinguida, use la familia de «memoria sin procesar»: @ref{cee,,PyMem_Malloc()}, @ref{10ae,,PyMem_Realloc()} y @ref{1482,,PyMem_Free()}.

@item 
La familia de «memoria de objetos» es la interfaz para la instalación de pymalloc descrita anteriormente y está sesgada hacia un gran número de asignaciones «pequeñas»: @ref{cf0,,PyObject_Malloc()}, @ref{1483,,PyObject_Realloc()} y @ref{ced,,PyObject_Free()}.

@item 
Para asignar y liberar objetos de Python, utilice la familia de «objetos» @ref{a17,,PyObject_New}, @ref{a18,,PyObject_NewVar} y @ref{1511,,PyObject_Del()}.
@end itemize

Gracias al gran trabajo de Tim Peters, pymalloc en 2.3 también proporciona funciones de depuración para detectar sobrescrituras de memoria y liberaciones duplicadas en ambos módulos de extensión y en el propio intérprete. Para habilitar este soporte, compile una versión de depuración del intérprete de Python ejecutando: programa: @cite{configure} con @code{--with-pydebug}.

Para ayudar a los escritores de extensiones, se distribuye un archivo de encabezado @code{Misc/pymemcompat.h} con la fuente a Python 2.3 que permite que las extensiones de Python usen las interfaces 2.3 para la asignación de memoria mientras se compila con cualquier versión de Python desde la 1.5.2. Debería copiar el archivo de la distribución fuente de Python y empaquetarlo con la fuente de su extensión.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://hg.python.org/cpython/file/default/Objects/obmalloc.c}

Para obtener todos los detalles de la implementación de pymalloc, consulte los comentarios en la parte superior del archivo @code{Objects/obmalloc.c} en el código fuente de Python. El enlace anterior apunta al archivo dentro del navegador SVN de python.org.
@end table


@c ======================================================================

@node Cambios en la API de Build y C<3>,Otros cambios y correcciones<2>,Pymalloc un asignador de objetos especializado,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 build-and-c-api-changes}@anchor{1512}
@subsection Cambios en la API de Build y C


Los cambios en el proceso de compilación de Python y en la API de C incluyen:


@itemize *

@item 
La implementación de detección de ciclos utilizada por la recolección de basura ha demostrado ser estable, por lo que ahora se ha hecho obligatoria. Ya no puede compilar Python sin él, y el cambio @code{--with-cycle-gc} a: program: @cite{configure} ha sido eliminado.

@item 
Python ahora se puede construir opcionalmente como una biblioteca compartida (@code{libpython2.3.so}) proporcionando @code{--enable-shared} cuando se ejecuta el script Python: program: @cite{configure}. (Contribuido por Ondrej Palkovsky.)

@item 
Las macros @code{DL_EXPORT} y @code{DL_IMPORT} ahora están en desuso. Las funciones de inicialización para los módulos de extensión de Python ahora deben declararse usando la nueva macro @ref{1513,,PyMODINIT_FUNC}, mientras que el núcleo de Python generalmente usará las macros @code{PyAPI_FUNC} y @code{PyAPI_DATA}.

@item 
El intérprete se puede compilar sin ninguna cadena de documentación para las funciones y módulos incorporados proporcionando @code{--without-doc-strings} al script: program: @cite{configure}. Esto hace que el ejecutable de Python sea un 10% más pequeño, pero también significa que no puede obtener ayuda para las funciones integradas de Python. (Contribución de Gustavo Niemeyer.)

@item 
La macro @code{PyArg_NoArgs()} ahora está en desuso y el código que la usa debe cambiarse. Para Python 2.2 y versiones posteriores, la tabla de definición de métodos puede especificar la marca @ref{1514,,METH_NOARGS}, lo que indica que no hay argumentos, y luego se puede eliminar la verificación de argumentos. Si la compatibilidad con las versiones anteriores a la 2.2 de Python es importante, el código podría usar @code{PyArg_ParseTuple(args, "")} en su lugar, pero esto será más lento que usar @ref{1514,,METH_NOARGS}.

@item 
@ref{615,,PyArg_ParseTuple()} acepta caracteres de nuevo formato para varios tamaños de enteros sin signo: @code{B} para unsigned char, @code{H} para unsigned short int, @code{I} para unsigned int, y @code{K} para unsigned long long.

@item 
Se agregó una nueva función, @code{PyObject_DelItemString(mapping, char *key)}, como abreviatura de @code{PyObject_DelItem(mapping, PyString_New(key))}.

@item 
Los objetos de archivo ahora administran su búfer de cadena interno de manera diferente, incrementándolo exponencialmente cuando es necesario. Esto da como resultado que las pruebas de referencia en @code{Lib/test/test_bufio.py} se aceleren considerablemente (de 57 segundos a 1,7 segundos, según una medición).

@item 
Ahora es posible definir métodos estáticos y de clase para un tipo de extensión C configurando los indicadores @ref{1515,,METH_CLASS} o @ref{1516,,METH_STATIC} en la estructura @ref{1517,,PyMethodDef} de un método.

@item 
Python ahora incluye una copia del código fuente del analizador XML de Expat, eliminando cualquier dependencia de una versión del sistema o instalación local de Expat.

@item 
If you dynamically allocate type objects in your extension, you should be
aware of a change in the rules relating to the @ref{468,,__module__} and
@ref{14e7,,__name__} attributes.  In summary, you will want to ensure the type’s
dictionary contains a @code{'__module__'} key; making the module name the part of
the type name leading up to the final period will no longer have the desired
effect.  For more detail, read the API reference documentation or the  source.
@end itemize

@c ======================================================================

@menu
* Cambios específicos del puerto: Cambios específicos del puerto<2>. 

@end menu

@node Cambios específicos del puerto<2>,,,Cambios en la API de Build y C<3>
@anchor{whatsnew/2 3 port-specific-changes}@anchor{1518}
@subsubsection Cambios específicos del puerto


Support for a port to IBM’s OS/2 using the EMX runtime environment was merged
into the main Python source tree.  EMX is a POSIX emulation layer over the OS/2
system APIs.  The Python port for EMX tries to support all the POSIX-like
capability exposed by the EMX runtime, and mostly succeeds; @code{fork()} and
@ref{59,,fcntl()} are restricted by the limitations of the underlying emulation
layer.  The standard OS/2 port, which uses IBM’s Visual Age compiler, also
gained support for case-sensitive import semantics as part of the integration of
the EMX port into CVS.  (Contributed by Andrew MacIntyre.)

En MacOS, la mayoría de los módulos de la caja de herramientas tienen vínculos débiles para mejorar la compatibilidad con versiones anteriores. Esto significa que los módulos ya no dejarán de cargarse si falta una rutina en la versión actual del sistema operativo. En su lugar, llamar a la rutina que falta lanzará una excepción. (Contribuido por Jack Jansen.)

Los archivos de especificaciones de RPM, que se encuentran en el directorio @code{Misc/RPM/} en la distribución fuente de Python, se actualizaron para la versión 2.3. (Contribución de Sean Reifschneider.)

Otras plataformas nuevas ahora compatibles con Python incluyen AtheOS (@indicateurl{http://www.atheos.cx/}), GNU / Hurd y OpenVMS.

@c ======================================================================

@node Otros cambios y correcciones<2>,Portar a Python 2 3,Cambios en la API de Build y C<3>,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 other-changes-and-fixes}@anchor{1519}@anchor{whatsnew/2 3 section-other}@anchor{14f0}
@subsection Otros cambios y correcciones


Como de costumbre, hubo un montón de otras mejoras y correcciones de errores esparcidas por todo el árbol de fuentes. Una búsqueda en los registros de cambios de CVS encuentra que se aplicaron 523 parches y se corrigieron 514 errores entre Python 2.2 y 2.3. Es probable que ambas cifras estén subestimadas.

Algunos de los cambios más notables son:


@itemize *

@item 
Si se establece la variable de entorno 
@geindex PYTHONINSPECT
@geindex variables de entorno; PYTHONINSPECT
@ref{151a,,PYTHONINSPECT}, el intérprete de Python ingresará al indicador interactivo después de ejecutar un programa de Python, como si Python hubiera sido invocado con la opción @ref{151b,,-i}. La variable de entorno se puede configurar antes de ejecutar el intérprete de Python, o el programa Python puede configurarla como parte de su ejecución.

@item 
El script @code{regrtest.py} ahora proporciona una forma de permitir «todos los recursos excepto `foo'». Un nombre de recurso pasado a la opción @code{-u} ahora se puede prefijar con un guión (@code{'-'}) para significar «eliminar este recurso». Por ejemplo, la opción “@code{-uall,-bsddb}” podría usarse para habilitar el uso de todos los recursos excepto @code{bsddb}.

@item 
Las herramientas utilizadas para crear la documentación ahora funcionan tanto en Cygwin como en Unix.

@item 
Se ha eliminado el código de operación @code{SET_LINENO}. En la noche de los tiempos, este código de operación era necesario para producir números de línea en rastreos y admitir funciones de rastreo (para, por ejemplo, @ref{a5,,pdb}). Desde Python 1.5, los números de línea en los rastreos se han calculado utilizando un mecanismo diferente que funciona con «python -O». Para Python 2.3, Michael Hudson implementó un esquema similar para determinar cuándo llamar a la función de seguimiento, eliminando por completo la necesidad de @code{SET_LINENO}.

Sería difícil detectar cualquier diferencia resultante del código Python, aparte de una ligera aceleración cuando Python se ejecuta sin @ref{14f,,-O}.

C extensions that access the @ref{845,,f_lineno} field of frame objects should
instead call @code{PyCode_Addr2Line(f->f_code, f->f_lasti)}. This will have the
added effect of making the code work as desired under «python -O» in earlier
versions of Python.

A nifty new feature is that trace functions can now assign to the
@ref{845,,f_lineno} attribute of frame objects, changing the line that will be
executed next.  A @code{jump} command has been added to the @ref{a5,,pdb} debugger
taking advantage of this new feature. (Implemented by Richie Hindle.)
@end itemize

@c ======================================================================

@node Portar a Python 2 3,Agradecimientos<5>,Otros cambios y correcciones<2>,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 porting-to-python-2-3}@anchor{151c}
@subsection Portar a Python 2.3


Esta sección enumera los cambios descritos anteriormente que pueden requerir cambios en su código:


@itemize *

@item 
@ref{a5f,,yield} ahora es siempre una palabra clave; si se usa como nombre de variable en su código, se debe elegir un nombre diferente.

@item 
Para cadenas, `X' and `Y', ASDF00 now works if `X' tiene más de un carácter.

@item 
El constructor de tipo @ref{1f0,,int()} ahora retornará un entero largo en lugar de lanzar un @ref{919,,OverflowError} cuando una cadena o un número de punto flotante es demasiado grande para caber en un entero.  Esto puede llevar al resultado paradójico de que @code{isinstance(int(expresión), int)} sea falso, pero parece poco probable que cause problemas en la práctica.

@item 
Si tiene cadenas Unicode que contienen caracteres de 8 bits, debe declarar la codificación del archivo (UTF-8, Latin-1 o lo que sea) agregando un comentario en la parte superior del archivo. Consulte la sección @ref{14c4,,PEP 263; Codificación del código fuente} para obtener más información.

@item 
Calling Tcl methods through @code{_tkinter} no longer  returns only strings.
Instead, if Tcl returns other objects those objects are converted to their
Python equivalent, if one exists, or wrapped with a @code{_tkinter.Tcl_Obj}
object if no Python equivalent exists.

@item 
Grandes literales octales y hexadecimales como @code{0xffffffff} ahora activan un @ref{4d4,,FutureWarning}. Actualmente se almacenan como números de 32 bits y dan como resultado un valor negativo, pero en Python 2.4 se convertirán en enteros largos positivos.

Hay varias formas de corregir esta advertencia. Si realmente necesita un número positivo, simplemente agregue un @code{L} al final del literal. Si está tratando de obtener un entero de 32 bits con bits bajos establecidos y ha usado previamente una expresión como @code{~(1 << 31)}, probablemente sea más claro comenzar con todos los bits establecidos y borrar los bits superiores deseados. Por ejemplo, para borrar solo el bit superior (bit 31), puede escribir @code{0xffffffffL &~(1L<<31)}.

@item 
Ya no puede deshabilitar las aserciones asignando a @code{__debug__}.

@item 
The Distutils @code{setup()} function has gained various new keyword arguments
such as `depends'.  Old versions of the Distutils will abort if passed unknown
keywords.  A solution is to check for the presence of the new
@code{get_distutil_options()} function in your @code{setup.py} and only uses the
new keywords with a version of the Distutils that supports them:

@example
from distutils import core

kw = @{'sources': 'foo.c', ...@}
if hasattr(core, 'get_distutil_options'):
    kw['depends'] = ['foo.h']
ext = Extension(**kw)
@end example

@item 
El uso de @code{None} como nombre de una variable ahora resultará en una advertencia @ref{511,,SyntaxWarning}.  En una futura versión de Python, @code{None} podría convertirse en una palabra clave.

@item 
Los nombres de los tipos de extensión definidos por los módulos incluidos con Python ahora contienen el módulo y un @code{'.'} delante del nombre del tipo.
@end itemize

@c ======================================================================

@node Agradecimientos<5>,,Portar a Python 2 3,Qué hay de nuevo en Python 2 3
@anchor{whatsnew/2 3 acknowledgements}@anchor{151d}@anchor{whatsnew/2 3 acks}@anchor{151e}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas por ofrecer sugerencias, correcciones y ayuda con varios borradores de este artículo: Jeff Bauer, Simon Brunning, Brett Cannon, Michael Chermside, Andrew Dalke, Scott David Daniels, Fred L. Drake, Jr., David Fraser, Kelly Gerber, Raymond Hettinger, Michael Hudson, Chris Lambert, Detlef Lannert, Martin von Löwis, Andrew MacIntyre, Lalo Martins, Chad Netzer, Gustavo Niemeyer, Neal Norwitz, Hans Nowak, Chris Reedy, Francesco Ricciardi, Vinay Sajip, Neil Schemenauer, Roman Suzi, Jason Tishler, Just van Rossum.

@node Qué hay de nuevo en Python 2 2,Qué hay de nuevo en Python 2 1,Qué hay de nuevo en Python 2 3,Qué hay de nuevo en Python
@anchor{whatsnew/2 2 doc}@anchor{151f}@anchor{whatsnew/2 2 what-s-new-in-python-2-2}@anchor{1520}
@section Qué hay de nuevo en Python 2.2


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew22.tex 37315 2004-09-10 19:33:00Z akuchling $

@menu
* Introducción:: 
* PEPs 252 y 253; Cambios de tipo y clase: PEPs 252 y 253 Cambios de tipo y clase. 
* PEP 234; Iteradores: PEP 234 Iteradores. 
* PEP 255; Generadores simples: PEP 255 Generadores simples<2>. 
* PEP 237; Unificación de enteros largos y enteros: PEP 237 Unificación de enteros largos y enteros. 
* PEP 238; Cambio del operador de división: PEP 238 Cambio del operador de división. 
* Cambios en Unicode:: 
* PEP 227; Ámbitos anidados: PEP 227 Ámbitos anidados. 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<3>. 
* Cambios y correcciones en el intérprete:: 
* Otros cambios y correcciones: Otros cambios y correcciones<3>. 
* Agradecimientos: Agradecimientos<6>. 

@end menu

@node Introducción,PEPs 252 y 253 Cambios de tipo y clase,,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 introduction}@anchor{1521}
@subsection Introducción


Este artículo explica las nuevas características en Python 2.2.2, publicado el 14 de octubre de 2002. Python 2.2.2 es una versión de corrección de errores de Python 2.2, lanzada originalmente el 21 de diciembre de 2001.

Python 2.2 se puede considerar como la «versión de limpieza». Hay algunas características como los generadores e iteradores que son completamente nuevas, pero la mayoría de los cambios, aunque sean significativos y de gran alcance, tienen como objetivo limpiar las irregularidades y los rincones oscuros del diseño del lenguaje.

Este artículo no procura proporcionar una especificación completa de las nuevas características, pero en su lugar proporciona una descripción general conveniente. Para más detalles, deberías consultar la documentación de Python 2.2, como Python Library Reference@footnote{https://docs.python.org/2.2/lib/lib.html} y Python Reference Manual@footnote{https://docs.python.org/2.2/ref/ref.html}. Si quieres comprender la justificación completa de la implementación y el diseño de un cambio, consultar la PEP para conocer una característica nueva en particular.

@c see also, now defunct
@c 
@c http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm
@c    "What's So Special About Python 2.2?" is also about the new 2.2 features, and
@c    was written by Cameron Laird and Kathryn Soraiz.

@c ======================================================================

@node PEPs 252 y 253 Cambios de tipo y clase,PEP 234 Iteradores,Introducción,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 peps-252-and-253-type-and-class-changes}@anchor{1522}
@subsection PEPs 252 y 253: Cambios de tipo y clase


Los cambios más grandes y de mayor alcance en Python 2.2 son el modelo de objetos y clases de Python. Los cambios deben ser compatibles con versiones anteriores, por lo que es probable que tu código continuará ejecutándose sin cambios, pero los cambios proporcionan algunas capacidades nuevas increíbles. Antes de comenzar esta, la sección más larga y complicada de este artículo, brindaré una descripción general de los cambios y ofreceré algunos comentarios.

A long time ago I wrote a web page listing flaws in Python’s design.  One of the
most significant flaws was that it’s impossible to subclass Python types
implemented in C.  In particular, it’s not possible to subclass built-in types,
so you can’t just subclass, say, lists in order to add a single useful method to
them. The @code{UserList} module provides a class that supports all of the
methods of lists and that can be subclassed further, but there’s lots of C code
that expects a regular Python list and won’t accept a @ref{1523,,UserList}
instance.

Python 2.2 corrige esto y, en el proceso, agrega algunas capacidades nuevas interesantes. Un breve resumen:


@itemize *

@item 
Puedes subclasificar tipos incorporados como listas e incluso enteros, y tus subclases deberían funcionar en todos los lugares que requieran el tipo original.

@item 
Ahora es posible definir métodos estáticos y de clase, además de los métodos de instancia disponibles en versiones anteriores de Python.

@item 
It’s also possible to automatically call methods on accessing or setting an
instance attribute by using a new mechanism called `properties'.  Many uses
of @ref{57a,,__getattr__()} can be rewritten to use properties instead, making the
resulting code simpler and faster.  As a small side benefit, attributes can now
have docstrings, too.

@item 
La lista de atributos legales para una instancia se puede limitar a un conjunto particular usando `slots', lo que hace posible protegerse contra errores tipográficos y quizás hacer posibles más optimizaciones en versiones futuras de Python.
@end itemize

Algunos usuarios han expresado preocupación por todos estos cambios. Claro, dicen, las nuevas características son ordenadas y se prestan a todo tipo de trucos que no eran posibles en versiones anteriores de Python, pero también hacen que el lenguaje sea más complicado. Algunas personas han dicho que siempre han recomendado Python por su simplicidad, y sienten que su simplicidad se está perdiendo.

Personalmente. pienso que no hay que preocuparse. Muchas de las nuevas características son bastante esotéricas, y puedes escribir mucho código de Python sin tener que estar al tanto de ellas. Escribir una clase simple no es más difícil de lo que nunca fue, así que no necesitas molestarte en aprender o enseñarlos a menos que realmente sean necesarios. Algunas tareas muy complicadas que antes solo eran posibles desde C ahora serán posibles en Python puro, y en mi opinión, esto es todo para mejor.

No voy a intentar cubrir todas los casos de las esquinas y los pequeños cambios que fueron necesarios para hacer que las nuevas características funcionen. En su lugar, esta sección pintará solo a grandes rasgos. Consultar la sección @ref{1524,,Enlaces relacionados}, «Enlaces relacionados», para más fuentes de información sobre el nuevo modelo de objetos de Python 2.2.

@menu
* Clases antiguas y nuevas:: 
* Descriptores:: 
* Herencia múltiple; la regla del diamante: Herencia múltiple la regla del diamante. 
* Acceso a atributos:: 
* Enlaces relacionados:: 

@end menu

@node Clases antiguas y nuevas,Descriptores,,PEPs 252 y 253 Cambios de tipo y clase
@anchor{whatsnew/2 2 old-and-new-classes}@anchor{1525}
@subsubsection Clases antiguas y nuevas


Primero, debes saber que realmente Python 2.2 tiene dos tipos de clases: clases clásicas o de estilo antiguo y clases de estilo nuevo. El modelo de clase de estilo antiguo exactamente es el mismo que el modelo de clase en versiones anteriores de Python. Todas las nuevas características descritas en esta sección se aplican solo a las clases de estilo nuevo. Esta divergencia no está destinada a durar para siempre; eventualmente las clases de estilo antiguo se eliminarán, posiblemente en Python 3.0.

Entonces, ¿cómo defines una clase de estilo nuevo? Lo haces subclasificando una clases de estilo nuevo existente. La mayoría de los tipos integrados de Python, como enteros, listas, diccionarios e incluso archivos, ahora son clases de estilo nuevo. También se agregó una clase de estilo nuevo llamada @ref{b18,,object}, la clase base para todos los tipos integrados, por lo que si ningún tipo integrado es apropiado, puedes solo subclasificar @ref{b18,,object}:

@example
class C(object):
    def __init__ (self):
        ...
    ...
@end example

This means that @ref{133f,,class} statements that don’t have any base classes are
always classic classes in Python 2.2.  (Actually you can also change this by
setting a module-level variable named @code{__metaclass__} — see 
@geindex Python Enhancement Proposals; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/}
for the details — but it’s easier to just subclass @ref{b18,,object}.)

Los objetos de tipo para los tipos integrados están disponibles como incorporados, nombrados mediante un truco inteligente. Python siempre ha tenido funciones incorporadas llamadas @ref{1f0,,int()}, @ref{153,,float()} y @ref{237,,str()}. En la versión 2.2, ya no son funciones, sino objetos de tipo que se comportan como fábricas cuando se les llaman.

@example
>>> int
<type 'int'>
>>> int('123')
123
@end example

To make the set of types complete, new type objects such as @ref{190,,dict()} and
@code{file()} have been added.  Here’s a more interesting example, adding a
@code{lock()} method to file objects:

@example
class LockableFile(file):
    def lock (self, operation, length=0, start=0, whence=0):
        import fcntl
        return fcntl.lockf(self.fileno(), operation,
                           length, start, whence)
@end example

The now-obsolete @code{posixfile} module contained a class that emulated all of
a file object’s methods and also added a @code{lock()} method, but this class
couldn’t be passed to internal functions that expected a built-in file,
something which is possible with our new @code{LockableFile}.

@node Descriptores,Herencia múltiple la regla del diamante,Clases antiguas y nuevas,PEPs 252 y 253 Cambios de tipo y clase
@anchor{whatsnew/2 2 descriptors}@anchor{1526}
@subsubsection Descriptores


In previous versions of Python, there was no consistent way to discover what
attributes and methods were supported by an object. There were some informal
conventions, such as defining @code{__members__} and @code{__methods__}
attributes that were lists of names, but often the author of an extension type
or a class wouldn’t bother to define them.  You could fall back on inspecting
the @ref{5fe,,__dict__} of an object, but when class inheritance or an arbitrary
@code{__getattr__()} hook were in use this could still be inaccurate.

La única gran idea que subyace al nuevo modelo de clases es que se ha formalizado una API para describir los atributos de un objeto usando `descriptors'. Los descriptores especifican el valor de un atributo, indicando si es un método o un campo. Con la API de un descriptor, los métodos estáticos y de clase se vuelven posibles, así como constructos más exóticos.

Los descriptores de atributos son objetos que viven dentro de los objetos de clase y tienen algunos atributos propios:


@itemize *

@item 
@ref{10e2,,__name__} es el nombre del atributo.

@item 
@ref{9bb,,__doc__} is the attribute’s docstring.

@item 
@code{__get__(object)} es un método que recupera el valor del atributo de `object'.

@item 
@code{__set__(object, value)} establece el atributo de `object' en `value'.

@item 
@code{__delete__(object, value)} elimina el atributo `value' de `object'.
@end itemize

Por ejemplo, cuando escribes @code{obj.x}, los pasos que realmente Python realiza son:

@example
descriptor = obj.__class__.x
descriptor.__get__(obj)
@end example

For methods, @ref{1527,,descriptor.__get__} returns a temporary
object that’s
callable, and wraps up the instance and the method to be called on it. This is
also why static methods and class methods are now possible; they have
descriptors that wrap up just the method, or the method and the class.  As a
brief explanation of these new kinds of methods, static methods aren’t passed
the instance, and therefore resemble regular functions.  Class methods are
passed the class of the object, but not the object itself.  Static and class
methods are defined like this:

@example
class C(object):
    def f(arg1, arg2):
        ...
    f = staticmethod(f)

    def g(cls, arg1, arg2):
        ...
    g = classmethod(g)
@end example

The @ref{22e,,staticmethod()} function takes the function @code{f()}, and returns it
wrapped up in a descriptor so it can be stored in the class object.  You might
expect there to be special syntax for creating such methods (@code{def static f},
@code{defstatic f()}, or something like that) but no such syntax has been defined
yet; that’s been left for future versions of Python.

También se implementan más características nuevas, como ranuras y propiedades, como nuevos tipos de descriptores, y no es difícil escribir una clase de descriptor que haga algo nuevo. Por ejemplo, sería posible escribir una clase de descriptor que hiciera posible escribir condiciones previas al estilo Eiffel y posteriores para un método. Una clase que usó esta característica podría definirse así:

@example
from eiffel import eiffelmethod

class C(object):
    def f(self, arg1, arg2):
        # The actual function
        ...
    def pre_f(self):
        # Check preconditions
        ...
    def post_f(self):
        # Check postconditions
        ...

    f = eiffelmethod(f, pre_f, post_f)
@end example

Note that a person using the new @code{eiffelmethod()} doesn’t have to understand
anything about descriptors.  This is why I think the new features don’t increase
the basic complexity of the language. There will be a few wizards who need to
know about it in order to write @code{eiffelmethod()} or the ZODB or whatever,
but most users will just write code on top of the resulting libraries and ignore
the implementation details.

@node Herencia múltiple la regla del diamante,Acceso a atributos,Descriptores,PEPs 252 y 253 Cambios de tipo y clase
@anchor{whatsnew/2 2 multiple-inheritance-the-diamond-rule}@anchor{1528}
@subsubsection Herencia múltiple: la regla del diamante


La herencia múltiple también se ha hecho más útil al cambiar las reglas bajo las cuales se resuelven los nombres. Considera este conjunto de clases (diagrama tomado de 
@geindex Python Enhancement Proposals; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} de Guido van Rossum):

@example
      class A:
        ^ ^  def save(self): ...
       /   \
      /     \
     /       \
    /         \
class B     class C:
    ^         ^  def save(self): ...
     \       /
      \     /
       \   /
        \ /
      class D
@end example

The lookup rule for classic classes is simple but not very smart; the base
classes are searched depth-first, going from left to right.  A reference to
@code{D.save()} will search the classes @code{D}, @code{B}, and then
@code{A}, where @code{save()} would be found and returned.  @code{C.save()}
would never be found at all.  This is bad, because if @code{C}’s @code{save()}
method is saving some internal state specific to @code{C}, not calling it will
result in that state never getting saved.

Las clases de estilo nuevo siguen un algoritmo diferente que es más complicado de explicar, pero hace lo correcto en esta situación. (Toma en cuenta que Python 2.3 cambia este algoritmo a uno que produce los mismos resultados en la mayoría de los casos, pero produce resultados más útiles para gráficos de herencia realmente complicados.)


@enumerate 

@item 
List all the base classes, following the classic lookup rule and include a
class multiple times if it’s visited repeatedly.  In the above example, the list
of visited classes is [@code{D}, @code{B}, @code{A}, @code{C},
@code{A}].

@item 
Scan the list for duplicated classes.  If any are found, remove all but one
occurrence, leaving the `last' one in the list.  In the above example, the list
becomes [@code{D}, @code{B}, @code{C}, @code{A}] after dropping
duplicates.
@end enumerate

Following this rule, referring to @code{D.save()} will return @code{C.save()},
which is the behaviour we’re after.  This lookup rule is the same as the one
followed by Common Lisp.  A new built-in function, @ref{155,,super()}, provides a way
to get at a class’s superclasses without having to reimplement Python’s
algorithm. The most commonly used form will be  @code{super(class, obj)}, which
returns  a bound superclass object (not the actual class object).  This form
will be used in methods to call a method in the superclass; for example,
@code{D}’s @code{save()} method would look like this:

@example
class D (B,C):
    def save (self):
        # Call superclass .save()
        super(D, self).save()
        # Save D's private information here
        ...
@end example

También @ref{155,,super()} puede retornar objetos de superclase no vinculados cuando se llama como @code{super(class)} o @code{super(class1, class2)}, pero probablemente esto no sea útil a menudo.

@node Acceso a atributos,Enlaces relacionados,Herencia múltiple la regla del diamante,PEPs 252 y 253 Cambios de tipo y clase
@anchor{whatsnew/2 2 attribute-access}@anchor{1529}
@subsubsection Acceso a atributos


A fair number of sophisticated Python classes define hooks for attribute access
using @ref{57a,,__getattr__()}; most commonly this is done for convenience, to make
code more readable by automatically mapping an attribute access such as
@code{obj.parent} into a method call such as @code{obj.get_parent}.  Python 2.2 adds
some new ways of controlling attribute access.

Primero, @code{__getattr__(attr_name)} aún es compatible con las clases de nuevo estilo, y nada al respecto ha cambiado. Como antes, se llamará cuando se intente acceder a @code{obj.foo} y no se encuentre ningún atributo llamado @code{foo} en el diccionario de la instancia.

New-style classes also support a new method,
@code{__getattribute__(attr_name)}.  The difference between the two methods is
that @ref{c5a,,__getattribute__()} is `always' called whenever any attribute is
accessed, while the old @ref{57a,,__getattr__()} is only called if @code{foo} isn’t
found in the instance’s dictionary.

However, Python 2.2’s support for `properties' will often be a simpler way
to trap attribute references.  Writing a @code{__getattr__()} method is
complicated because to avoid recursion you can’t use regular attribute accesses
inside them, and instead have to mess around with the contents of
@ref{5fe,,__dict__}. @ref{57a,,__getattr__()} methods also end up being called by Python
when it checks for other methods such as @ref{6bd,,__repr__()} or @code{__coerce__()},
and so have to be written with this in mind. Finally, calling a function on
every attribute access results in a sizable performance loss.

@ref{2fd,,property} is a new built-in type that packages up three functions that
get, set, or delete an attribute, and a docstring.  For example, if you want to
define a @code{size} attribute that’s computed, but also settable, you could
write:

@example
class C(object):
    def get_size (self):
        result = ... computation ...
        return result
    def set_size (self, size):
        ... compute something based on the size
        and set internal state appropriately ...

    # Define a property.  The 'delete this attribute'
    # method is defined as None, so the attribute
    # can't be deleted.
    size = property(get_size, set_size,
                    None,
                    "Storage size of this instance")
@end example

That is certainly clearer and easier to write than a pair of
@code{__getattr__()}/@code{__setattr__()} methods that check for the @code{size}
attribute and handle it specially while retrieving all other attributes from the
instance’s @ref{5fe,,__dict__}.  Accesses to @code{size} are also the only ones
which have to perform the work of calling a function, so references to other
attributes run at their usual speed.

Finalmente, es posible restringir la lista de atributos que se pueden referenciar en un objeto usando el nuevo atributo de clase @ref{152a,,__slots__}. Los objetos de Python por lo general son muy dinámicos; en cualquier momento es posible definir un nuevo atributo en una instancia haciendo simplemente @code{obj.new_attr=1}. Una clase de estilo nuevo puede definir un atributo de clase llamado @ref{152a,,__slots__} para limitar los atributos legales a un conjunto particular de nombres. Un ejemplo hará esto claro:

@example
>>> class C(object):
...     __slots__ = ('template', 'name')
...
>>> obj = C()
>>> print obj.template
None
>>> obj.template = 'Test'
>>> print obj.template
Test
>>> obj.newattr = None
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
AttributeError: 'C' object has no attribute 'newattr'
@end example

Toma en cuenta cómo obtienes un @ref{441,,AttributeError} en el intento de asignar a un atributo que no aparece en @ref{152a,,__slots__}.

@node Enlaces relacionados,,Acceso a atributos,PEPs 252 y 253 Cambios de tipo y clase
@anchor{whatsnew/2 2 related-links}@anchor{152b}@anchor{whatsnew/2 2 sect-rellinks}@anchor{1524}
@subsubsection Enlaces relacionados


Esta sección solo ha sido una descripción rápida de las nuevas características, brindando una explicación suficiente para comenzar a programar, pero muchos detalles se han simplificado o ignorado. ¿Dónde deberías ir para obtener una imagen más completa?

The @ref{152c,,Descriptor Guide} is a lengthy tutorial introduction to
the descriptor features, written by Guido van Rossum. If my description has
whetted your appetite, go read this tutorial next, because it goes into much
more detail about the new features while still remaining quite easy to read.

A continuación, hay dos PEPs relevantes, 
@geindex Python Enhancement Proposals; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} y 
@geindex Python Enhancement Proposals; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/}. 
@geindex Python Enhancement Proposals; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} se titula «Hacer que los tipos se parezcan más a las clases», y cubre la API del descriptor. 
@geindex Python Enhancement Proposals; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} se titula «Subtipado de tipos incorporados», y describe los cambios de los objetos de tipo que hacen posible el subtipo de objetos incorporados. 
@geindex Python Enhancement Proposals; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} es la PEP más complicada de las dos, y en algunos puntos las explicaciones necesarias de tipos y meta-tipos pueden causar que tu cabeza explote. Ambas PEPs se escribieron e implementaron por Guido van Rossum con la asistencia sustancial del resto del equipo de Zope Corp.

Finalmente, está la máxima autoridad: el código fuente. La mayoría de la maquinaria para el manejo de tipos está en @code{Objects/typeobject.c}, pero solo debes recurrir a él después de que se hayan agotado todas las demás vías, incluida la publicación de una pregunta en python-list o python-dev.

@c ======================================================================

@node PEP 234 Iteradores,PEP 255 Generadores simples<2>,PEPs 252 y 253 Cambios de tipo y clase,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 pep-234-iterators}@anchor{152d}
@subsection PEP 234: Iteradores


Otra adición significativa a la versión 2.2 es una interfaz de iteración tanto a nivel de C como de Python.  Los objetos pueden definir cómo pueden ser iterados por quienes los llaman.

In Python versions up to 2.1, the usual way to make @code{for item in obj} work is
to define a @ref{3d8,,__getitem__()} method that looks something like this:

@example
def __getitem__(self, index):
    return <next item>
@end example

@ref{3d8,,__getitem__()} is more properly used to define an indexing operation on an
object so that you can write @code{obj[5]} to retrieve the sixth element.  It’s a
bit misleading when you’re using this only to support @ref{1eb,,for} loops.
Consider some file-like object that wants to be looped over; the `index'
parameter is essentially meaningless, as the class probably assumes that a
series of @ref{3d8,,__getitem__()} calls will be made with `index' incrementing by
one each time.  In other words, the presence of the @ref{3d8,,__getitem__()} method
doesn’t mean that using @code{file[5]}  to randomly access the sixth element will
work, though it really should.

In Python 2.2, iteration can be implemented separately, and @ref{3d8,,__getitem__()}
methods can be limited to classes that really do support random access.  The
basic idea of iterators is  simple.  A new built-in function, @code{iter(obj)}
or @code{iter(C, sentinel)}, is used to get an iterator. @code{iter(obj)} returns
an iterator for the object `obj', while @code{iter(C, sentinel)} returns an
iterator that will invoke the callable object `C' until it returns `sentinel' to
signal that the iterator is done.

Python classes can define an @code{__iter__()} method, which should create and
return a new iterator for the object; if the object is its own iterator, this
method can just return @code{self}.  In particular, iterators will usually be their
own iterators.  Extension types implemented in C can implement a @ref{152e,,tp_iter}
function in order to return an iterator, and extension types that want to behave
as iterators can define a @ref{152f,,tp_iternext} function.

Entonces, después de todo esto, ¿qué hacen realmente los iteradores?  Tienen un método obligatorio, @ref{86f,,next()}, que no toma argumentos y retorna el siguiente valor.  Cuando no hay más valores que retornar, la llamada a @ref{86f,,next()} debería lanzar la excepción @ref{c82,,StopIteration}.

@example
>>> L = [1,2,3]
>>> i = iter(L)
>>> print i
<iterator object at 0x8116870>
>>> i.next()
1
>>> i.next()
2
>>> i.next()
3
>>> i.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
StopIteration
>>>
@end example

In 2.2, Python’s @ref{1eb,,for} statement no longer expects a sequence; it
expects something for which @ref{86e,,iter()} will return an iterator. For backward
compatibility and convenience, an iterator is automatically constructed for
sequences that don’t implement @code{__iter__()} or a @ref{152e,,tp_iter} slot, so
@code{for i in [1,2,3]} will still work.  Wherever the Python interpreter loops
over a sequence, it’s been changed to use the iterator protocol.  This means you
can do things like this:

@example
>>> L = [1,2,3]
>>> i = iter(L)
>>> a,b,c = i
>>> a,b,c
(1, 2, 3)
@end example

Se ha añadido soporte de iteradores a algunos de los tipos básicos de Python.   Llamar a @ref{86e,,iter()} sobre un diccionario retornará un iterador que hace un bucle sobre sus claves:

@example
>>> m = @{'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12@}
>>> for key in m: print key, m[key]
...
Mar 3
Feb 2
Aug 8
Sep 9
May 5
Jun 6
Jul 7
Jan 1
Apr 4
Nov 11
Dec 12
Oct 10
@end example

That’s just the default behaviour.  If you want to iterate over keys, values, or
key/value pairs, you can explicitly call the @code{iterkeys()},
@code{itervalues()}, or @code{iteritems()} methods to get an appropriate iterator.
In a minor related change, the @ref{1ed,,in} operator now works on dictionaries,
so @code{key in dict} is now equivalent to @code{dict.has_key(key)}.

Los archivos también proporcionan un iterador, que llama al método @ref{ba,,readline()} hasta que no hay más líneas en el archivo.  Esto significa que ahora puede leer cada línea de un archivo utilizando un código como este:

@example
for line in file:
    # do something for each line
    ...
@end example

Tenga en cuenta que sólo puede avanzar en un iterador; no hay forma de obtener el elemento anterior, reiniciar el iterador o hacer una copia del mismo. Un objeto iterador podría proporcionar estas capacidades adicionales, pero el protocolo iterador sólo requiere un método @ref{86f,,next()}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 234

@item PEP 234@footnote{https://peps.python.org/pep-0234/} - Iteradores

Escrito por Ka-Ping Yee y GvR; implementado por el equipo de Python Labs, principalmente por GvR y Tim Peters.
@end table


@c ======================================================================

@node PEP 255 Generadores simples<2>,PEP 237 Unificación de enteros largos y enteros,PEP 234 Iteradores,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 pep-255-simple-generators}@anchor{1530}
@subsection PEP 255: Generadores simples


Los generadores son otra novedad que interactúa con la introducción de los iteradores.

Sin duda estás familiarizado con cómo funcionan las llamadas a funciones en Python o C. Cuando llamas a una función, ésta obtiene un espacio de nombres privado donde se crean sus variables locales.  Cuando la función llega a una declaración @ref{a60,,return}, las variables locales se destruyen y el valor resultante se retorna a quien la llamó.  Una llamada posterior a la misma función obtendrá un nuevo conjunto de variables locales. Pero, ¿qué pasaría si las variables locales no se tiraran al salir de una función? ¿Qué pasaría si pudieras reanudar la función donde la dejaste?  Esto es lo que proporcionan los generadores; se puede pensar en ellos como funciones reanudables.

Este es el ejemplo más sencillo de una función generadora:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

Se ha introducido una nueva palabra clave, @ref{a5f,,yield}, para los generadores.  Cualquier función que contenga una declaración @code{yield} es una función generadora; esto es detectado por el compilador de código de bits de Python que compila la función especialmente como resultado.  Debido a la introducción de una nueva palabra clave, los generadores deben ser explícitamente habilitados en un módulo incluyendo una declaración @code{from __future__ import generators} cerca de la parte superior del código fuente del módulo.  En Python 2.3 esta declaración será innecesaria.

Cuando se llama a una función generadora, ésta no retorna un único valor, sino que retorna un objeto generador que soporta el protocolo de los iteradores.  Al ejecutar la sentencia @ref{a5f,,yield}, el generador retorna el valor de @code{i}, de forma similar a una sentencia @ref{a60,,return}.  La gran diferencia entre @code{yield} y una sentencia @code{return} es que al llegar a una sentencia @code{yield} se suspende el estado de ejecución del generador y se conservan las variables locales.  En la siguiente llamada al método @code{next()} del generador, la función se reanudará la ejecución inmediatamente después de la sentencia @code{yield}.  (Por razones complicadas, la sentencia @code{yield} no está permitida dentro del bloque @code{try} de una sentencia @ref{789,,try}…`@ref{a5c,,finally}; lea 
@geindex Python Enhancement Proposals; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/} para una explicación completa de la interacción entre @code{yield} y las excepciones)

Here’s a sample usage of the @code{generate_ints()} generator:

@example
>>> gen = generate_ints(3)
>>> gen
<generator object at 0x8117f90>
>>> gen.next()
0
>>> gen.next()
1
>>> gen.next()
2
>>> gen.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "<stdin>", line 2, in generate_ints
StopIteration
@end example

También podrías escribir @code{for i in generate_ints(5)}, o @code{a,b,c = generate_ints(3)}.

Dentro de una función generadora, la sentencia @ref{a60,,return} sólo puede usarse sin un valor, y señala el final de la procesión de valores; después el generador no puede retornar más valores. @code{return} con un valor, como @code{return 5}, es un error de sintaxis dentro de una función generadora.  El final de los resultados del generador también puede indicarse levantando manualmente @ref{c82,,StopIteration}, o simplemente dejando que el flujo de ejecución caiga en el fondo de la función.

Puedes conseguir el efecto de los generadores manualmente escribiendo tu propia clase y almacenando todas las variables locales del generador como variables de instancia.  Por ejemplo, la lución de una lista de enteros podría hacerse estableciendo @code{self.count} a 0, y haciendo que el método @ref{86f,,next()} incremente @code{self.count} y lo retorne. Sin embargo, para un generador medianamente complicado, escribir la clase correspondiente sería mucho más complicado. @code{Lib/test/test_generators.py} contiene varios ejemplos más interesantes.  El más sencillo implementa un recorrido en orden de un árbol utilizando generadores de forma recursiva

@example
# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x
@end example

Otros dos ejemplos en @code{Lib/test/test_generators.py} producen soluciones para el problema de las N reinas (colocar $N$ reinas en un tablero de ajedrez $NxN$ de forma que ninguna reina amenace a otra) y el recorrido del caballero (una ruta que lleva a un caballo a cada casilla de un tablero de ajedrez $NxN$ sin visitar ninguna casilla dos veces).

The idea of generators comes from other programming languages, especially Icon
(@indicateurl{https://www2.cs.arizona.edu/icon/}), where the idea of generators is central.  In
Icon, every expression and function call behaves like a generator.  One example
from «An Overview of the Icon Programming Language» at
@indicateurl{https://www2.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of what this looks
like:

@example
sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)
@end example

In Icon the @code{find()} function returns the indexes at which the substring
«or» is found: 3, 23, 33.  In the @ref{1ec,,if} statement, @code{i} is first
assigned a value of 3, but 3 is less than 5, so the comparison fails, and Icon
retries it with the second value of 23.  23 is greater than 5, so the comparison
now succeeds, and the code prints the value 23 to the screen.

Python no va tan lejos como Icon en la adopción de generadores como concepto central.  Los generadores se consideran una nueva parte del núcleo del lenguaje Python, pero aprenderlos o utilizarlos no es obligatorio; si no resuelven ningún problema que tengas, siéntete libre de ignorarlos. Una característica novedosa de la interfaz de Python en comparación con la de Icon es que el estado de un generador se representa como un objeto concreto (el iterador) que puede pasarse a otras funciones o almacenarse en una estructura de datos.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Generadores simples

Escrito por Neil Schemenauer, Tim Peters, Magnus Lie Hetland.  Implementado principalmente por Neil Schemenauer y Tim Peters, con otras correcciones del equipo de Python Labs.
@end table


@c ======================================================================

@node PEP 237 Unificación de enteros largos y enteros,PEP 238 Cambio del operador de división,PEP 255 Generadores simples<2>,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 pep-237-unifying-long-integers-and-integers}@anchor{1531}
@subsection PEP 237: Unificación de enteros largos y enteros


In recent versions, the distinction between regular integers, which are 32-bit
values on most machines, and long integers, which can be of arbitrary size, was
becoming an annoyance.  For example, on platforms that support files larger than
@code{2**32} bytes, the @code{tell()} method of file objects has to return a long
integer. However, there were various bits of Python that expected plain integers
and would raise an error if a long integer was provided instead.  For example,
in Python 1.5, only regular integers could be used as a slice index, and
@code{'abc'[1L:]} would raise a @ref{228,,TypeError} exception with the message “slice
index must be int”.

Python 2.2 cambiará los valores de enteros cortos a enteros largos según sea necesario. El sufijo “L” ya no es necesario para indicar un literal entero largo, ya que ahora el compilador elegirá el tipo apropiado.  (El uso del sufijo “L” se desaconsejará en futuras versiones 2.x de Python, provocando una advertencia en Python 2.4, y probablemente se eliminará en Python 3.0)  Muchas operaciones que solían lanzar un @ref{919,,OverflowError} ahora retornarán un entero largo como resultado.  Por ejemplo:

@example
>>> 1234567890123
1234567890123L
>>> 2 ** 64
18446744073709551616L
@end example

En la mayoría de los casos, los enteros y los enteros largos se tratarán ahora de forma idéntica.  Todavía se pueden distinguir con la función incorporada @ref{dcf,,type()}, pero rara vez se necesita.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - Unificación de enteros largos y enteros

Escrito por Moshe Zadka y Guido van Rossum.  Implementado principalmente por Guido van Rossum.
@end table


@c ======================================================================

@node PEP 238 Cambio del operador de división,Cambios en Unicode,PEP 237 Unificación de enteros largos y enteros,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 pep-238-changing-the-division-operator}@anchor{1532}
@subsection PEP 238: Cambio del operador de división


El cambio más controvertido de Python 2.2 anuncia el inicio de un esfuerzo por arreglar un viejo defecto de diseño que ha estado en Python desde el principio. Actualmente, el operador de división de Python, @code{/}, se comporta como el operador de división de C cuando se le presentan dos argumentos enteros: retorna un resultado entero que se trunca cuando hay una parte fraccionaria.  Por ejemplo, @code{3/2} es 1, no 1,5, y @code{(-1)/2} es -1, no -0,5.  Esto significa que los resultados de la división pueden variar inesperadamente dependiendo del tipo de los dos operandos y, como Python está tipado dinámicamente, puede ser difícil determinar los posibles tipos de los operandos.

(La controversia se centra en si esto es `realmente' un defecto de diseño, y si vale la pena romper el código existente para arreglarlo.  Ha provocado interminables discusiones en python-dev, y en julio de 2001 estalló una tormenta de publicaciones ácidamente sarcásticas en @code{comp.lang.python}. No argumentaré aquí a favor de ninguno de los dos bandos y me limitaré a describir lo que se ha implementado en la 2.2.  Lea 
@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/} para un resumen de los argumentos y contra-argumentos)

Debido a que este cambio podría romper el código, se está introduciendo de forma muy gradual. Python 2.2 comienza la transición, pero el cambio no será completo hasta Python 3.0.

En primer lugar, tomaré prestada alguna terminología de 
@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}. La «división verdadera» es la división con la que la mayoría de los no programadores están familiarizados: 3/2 es 1,5, 1/4 es 0,25, y así sucesivamente. La «división entera a la baja» es lo que hace actualmente el operador @code{/} de Python cuando se le dan operandos enteros; el resultado es el redondeo a la baja (`floor') del valor retornado por la división verdadera. La «división clásica» es el comportamiento mixto actual de @code{/}; retorna el resultado de la división entera a la baja cuando los operandos son enteros, y retorna el resultado de la división verdadera cuando uno de los operandos es un número de punto flotante.

Estos son los cambios que introduce la versión 2.2:


@itemize *

@item 
Un nuevo operador, @code{//}, es el operador de división entera a la baja. (Sí, ya sabemos que se parece al símbolo de comentario de C++.) @code{//} `siempre' realiza la división entera a la baja sin importar los tipos de sus operandos, así que @code{1 // 2} es 0 y @code{1.0 // 2.0} también es 0.0.

@code{//} está siempre disponible en Python 2.2; no es necesario habilitarlo mediante una sentencia @code{__future__}.

@item 
Al incluir una declaración @code{from __future__ import division} en un módulo, el operador @code{/} se cambiará para retornar el resultado de la división verdadera, por lo que @code{1/2} es 0,5.  Sin la declaración @code{__future__}, @code{/} sigue significando la división clásica. El significado por defecto de @code{/} no cambiará hasta Python 3.0.

@item 
Classes can define methods called @ref{1533,,__truediv__()} and @ref{1534,,__floordiv__()}
to overload the two division operators.  At the C level, there are also slots in
the @ref{145d,,PyNumberMethods} structure so extension types can define the two
operators.

@item 
Python 2.2 admite algunos argumentos de línea de comandos para comprobar si el código funcionará con la semántica de división modificada.  Ejecutar python con @code{-Q warn} hará que se emita una advertencia cada vez que se aplique la división a dos enteros.  Puedes usar esto para encontrar el código que está afectado por el cambio y arreglarlo.  Por defecto, Python 2.2 simplemente realizará la división clásica sin una advertencia; la advertencia se activará por defecto en Python 2.3.
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 238

@item PEP 238@footnote{https://peps.python.org/pep-0238/} - Cambio del operador de división

Escrito por Moshe Zadka y Guido van Rossum.  Implementado por Guido van Rossum..
@end table


@c ======================================================================

@node Cambios en Unicode,PEP 227 Ámbitos anidados,PEP 238 Cambio del operador de división,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 unicode-changes}@anchor{1535}
@subsection Cambios en Unicode


El soporte de Unicode de Python se ha mejorado un poco en la versión 2.2.  Las cadenas Unicode se almacenan normalmente como UCS-2, como enteros sin signo de 16 bits. Python 2.2 también puede ser compilado para usar UCS-4, enteros sin signo de 32 bits, como su codificación interna suministrando @code{--enable-unicode=ucs4} al script de configuración.   (También es posible especificar @code{--disable-unicode} para desactivar completamente el soporte de Unicode)

When built to use UCS-4 (a «wide Python»), the interpreter can natively handle
Unicode characters from U+000000 to U+110000, so the range of legal values for
the @code{unichr()} function is expanded accordingly.  Using an interpreter
compiled to use UCS-2 (a «narrow Python»), values greater than 65535 will still
cause @code{unichr()} to raise a @ref{360,,ValueError} exception. This is all
described in 
@geindex Python Enhancement Proposals; PEP 261
PEP 261@footnote{https://peps.python.org/pep-0261/}, «Support for “wide” Unicode characters»; consult it for
further details.

Another change is simpler to explain. Since their introduction, Unicode strings
have supported an @code{encode()} method to convert the string to a selected
encoding such as UTF-8 or Latin-1.  A symmetric @code{decode([*encoding*])}
method has been added to 8-bit strings (though not to Unicode strings) in 2.2.
@code{decode()} assumes that the string is in the specified encoding and decodes
it, returning whatever is returned by the codec.

Gracias a esta nueva función, se han añadido códecs para tareas no relacionadas directamente con Unicode.  Por ejemplo, se han añadido códecs para la codificación uu, la codificación base64 de MIME y la compresión con el módulo @ref{132,,zlib}:

@example
>>> s = """Here is a lengthy piece of redundant, overly verbose,
... and repetitive text.
... """
>>> data = s.encode('zlib')
>>> data
'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
>>> data.decode('zlib')
'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
>>> print s.encode('uu')
begin 666 <data>
M2&5R92!I<R!A(&QE;F=T:'D@@<&EE8V4@@;V8@@<F5D=6YD86YT+"!O=F5R;'D@@
>=F5R8F]S92P*86YD(')E<&5T:71I=F4@@=&5X="X*

end
>>> "sheesh".encode('rot-13')
'furrfu'
@end example

To convert a class instance to Unicode, a @code{__unicode__()} method can be
defined by a class, analogous to @code{__str__()}.

@code{encode()}, @code{decode()}, and @code{__unicode__()} were implemented by
Marc-André Lemburg.  The changes to support using UCS-4 internally were
implemented by Fredrik Lundh and Martin von Löwis.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 261

@item PEP 261@footnote{https://peps.python.org/pep-0261/} - Soporte para caracteres Unicode “anchos”

Escrito por Paul Prescod.
@end table


@c ======================================================================

@node PEP 227 Ámbitos anidados,Módulos nuevos y mejorados<3>,Cambios en Unicode,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 pep-227-nested-scopes}@anchor{1536}
@subsection PEP 227: Ámbitos anidados


En Python 2.1, los ámbitos anidados estáticamente se añadieron como una característica opcional, que se activaba mediante una directiva @code{from __future__ import nested_scopes}.  En 2.2 los ámbitos anidados ya no necesitan ser habilitados especialmente, y ahora están siempre presentes.  El resto de esta sección es una copia de la descripción de los ámbitos anidados de mi documento «What’s New in Python 2.1»; si lo leíste cuando salió la 2.1, puedes saltarte el resto de esta sección.

El mayor cambio introducido en Python 2.1, y completado en 2.2, es el de las reglas de alcance de Python.  En Python 2.0, en cualquier momento hay como máximo tres espacios de nombres utilizados para buscar nombres de variables: local, a nivel de módulo y el espacio de nombres incorporado.  Esto a menudo sorprendía a la gente porque no coincidía con sus expectativas intuitivas.  Por ejemplo, una definición de función recursiva anidada no funciona:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

The function @code{g()} will always raise a @ref{4ec,,NameError} exception, because
the binding of the name @code{g} isn’t in either its local namespace or in the
module-level namespace.  This isn’t much of a problem in practice (how often do
you recursively define interior functions like this?), but this also made using
the @ref{1309,,lambda} expression clumsier, and this was a problem in practice.
In code which uses @code{lambda} you can often find local variables being
copied by passing them as the default values of arguments.

@example
def find(self, name):
    "Return list of any entries equal to 'name'"
    L = filter(lambda x, name=name: x == name,
               self.list_attribute)
    return L
@end example

La legibilidad del código Python escrito en un estilo fuertemente funcional sufre mucho como resultado.

El cambio más significativo de Python 2.2 es que se ha añadido al lenguaje el ámbito estático para solucionar este problema.  Como primer efecto, el argumento por defecto @code{name=name} es ahora innecesario en el ejemplo anterior.  En pocas palabras, cuando a un nombre de variable dado no se le asigna un valor dentro de una función (mediante una asignación, o las sentencias @ref{1497,,def}, @ref{133f,,class}, o @ref{682,,import}), las referencias a la variable se buscarán en el espacio de nombres local del ámbito que la rodea.  Puede encontrar una explicación más detallada de las reglas y una disección de la implementación en el PEP.

Este cambio puede causar algunos problemas de compatibilidad para el código en el que el mismo nombre de variable se utiliza tanto a nivel de módulo como de variable local dentro de una función que contiene otras definiciones de función. Sin embargo, esto parece bastante improbable, ya que dicho código habría sido bastante confuso de leer en primer lugar.

Un efecto secundario del cambio es que las sentencias @code{from module import *} y @code{exec} se han hecho ilegales dentro del ámbito de una función bajo ciertas condiciones.  El manual de referencia de Python ha dicho todo el tiempo que @code{from module import *} sólo es legal en el nivel superior de un módulo, pero el intérprete de CPython nunca ha aplicado esto antes.  Como parte de la implementación de los ámbitos anidados, el compilador que convierte el código fuente de Python en bytecodes tiene que generar un código diferente para acceder a las variables de un ámbito contenedor.  Los códigos @code{from module import *} y @code{exec} hacen que el compilador no pueda averiguar esto, porque añaden nombres al espacio de nombres local que son desconocidos en tiempo de compilación. Por lo tanto, si una función contiene definiciones de funciones o expresiones @ref{1309,,lambda} con variables libres, el compilador lo señalará lanzando una excepción @ref{150,,SyntaxError}.

Para que la explicación anterior quede un poco más clara, he aquí un ejemplo:

@example
x = 1
def f():
    # The next line is a syntax error
    exec 'x=2'
    def g():
        return x
@end example

Line 4 containing the @code{exec} statement is a syntax error, since
@code{exec} would define a new local variable named @code{x} whose value should
be accessed by @code{g()}.

Esto no debería ser una gran limitación, ya que @code{exec} rara vez se utiliza en la mayoría del código de Python (y cuando se utiliza, a menudo es un signo de un mal diseño de todos modos).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - Ámbitos anidados estáticamente

Escrito e implementado por Jeremy Hylton.
@end table


@c ======================================================================

@node Módulos nuevos y mejorados<3>,Cambios y correcciones en el intérprete,PEP 227 Ámbitos anidados,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 new-and-improved-modules}@anchor{1537}
@subsection Módulos nuevos y mejorados



@itemize *

@item 
The @ref{12d,,xmlrpclib} module was contributed to the standard library by Fredrik
Lundh, providing support for writing XML-RPC clients.  XML-RPC is a simple
remote procedure call protocol built on top of HTTP and XML. For example, the
following snippet retrieves a list of RSS channels from the O’Reilly Network,
and then  lists the recent headlines for one channel:

@example
import xmlrpclib
s = xmlrpclib.Server(
      'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
channels = s.meerkat.getChannels()
# channels is a list of dictionaries, like this:
# [@{'id': 4, 'title': 'Freshmeat Daily News'@}
#  @{'id': 190, 'title': '32Bits Online'@},
#  @{'id': 4549, 'title': '3DGamers'@}, ... ]

# Get the items for one channel
items = s.meerkat.getItems( @{'channel': 4@} )

# 'items' is another list of dictionaries, like this:
# [@{'link': 'http://freshmeat.net/releases/52719/',
#   'description': 'A utility which converts HTML to XSL FO.',
#   'title': 'html2fo 0.3 (Default)'@}, ... ]
@end example

The @ref{12e,,SimpleXMLRPCServer} module makes it easy to create straightforward
XML-RPC servers.  See @indicateurl{http://xmlrpc.scripting.com/} for more information about XML-RPC.

@item 
El nuevo módulo @ref{6a,,hmac} implementa el algoritmo HMAC descrito por 
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html}. (Contribución de Gerhard Häring)

@item 
Several functions that originally returned lengthy tuples now return
pseudo-sequences that still behave like tuples but also have mnemonic attributes such
as @code{memberst_mtime} or @ref{1538,,tm_year}. The enhanced functions include
@ref{548,,stat()}, @ref{e12,,fstat()}, @ref{116e,,statvfs()}, and @ref{e13,,fstatvfs()} in the
@ref{a1,,os} module, and @ref{1539,,localtime()}, @ref{122d,,gmtime()}, and @ref{146c,,strptime()} in
the @ref{ee,,time} module.

Por ejemplo, para obtener el tamaño de un archivo utilizando las antiguas tuplas, se terminaba escribiendo algo como @code{tamaño_de_archivo = os.stat(nombre_de_archivo)[stat.ST_SIZE]}, pero ahora se puede escribir más claramente como @code{tamaño_de_archivo = os.stat(nombre_de_archivo).st_size}.

El parche original para esta función fue aportado por Nick Mathewson.

@item 
El perfilador de Python ha sido ampliamente revisado y se han corregido varios errores en su salida.  (Contribución de Fred L. Drake, Jr. y Tim Peters)

@item 
El módulo @ref{cc,,socket} puede ser compilado para soportar IPv6; especifica la opción @code{--enable-ipv6} al script configure de Python.  (Contribución de Jun-ichiro «itojun» Hagino)

@item 
Se agregaron dos nuevos caracteres de formato al módulo @ref{d5,,struct} para enteros de 64 bits en plataformas que admiten el tipo C long long. @code{q} es para un entero de 64 bits con signo y @code{Q} es para uno sin firmar. El valor se retorna en el tipo de entero largo de Python. (Aportado por Tim Peters.)

@item 
En el modo interactivo del intérprete, hay una nueva función incorporada @ref{96e,,help()} que utiliza el módulo @ref{b5,,pydoc} introducido en Python 2.1 para proporcionar ayuda interactiva. @ref{96e,,help()} sin ningún argumento te sitúa en una utilidad de ayuda online, donde puedes introducir los nombres de las funciones, clases o módulos para leer su texto de ayuda. (Contribuido por Guido van Rossum, usando el módulo @ref{b5,,pydoc} de Ka-Ping Yee)

@item 
Various bugfixes and performance improvements have been made to the SRE engine
underlying the @ref{b9,,re} module.  For example, the @ref{3f2,,re.sub()} and
@ref{3f1,,re.split()} functions have been rewritten in C.  Another contributed patch
speeds up certain Unicode character ranges by a factor of two, and a new
@ref{153a,,finditer()}  method that returns an iterator over all the non-overlapping
matches in  a given string.  (SRE is maintained by Fredrik Lundh.  The
BIGCHARSET patch was contributed by Martin von Löwis.)

@item 
El módulo @ref{ca,,smtplib} soporta ahora 
@geindex RFC; RFC 2487
RFC 2487@footnote{https://datatracker.ietf.org/doc/html/rfc2487.html}, «Secure SMTP over TLS», por lo que ahora es posible cifrar el tráfico SMTP entre un programa Python y el agente de transporte de correo que recibe un mensaje. @ref{ca,,smtplib} también soporta la autenticación SMTP.  (Contribución de Gerhard Häring)

@item 
El módulo @ref{74,,imaplib}, mantenido por Piers Lauder, tiene soporte para varias extensiones nuevas: la extensión NAMESPACE definida en 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html}, SORT, GETACL y SETACL.  (Contribución de Anthony Baxter y Michel Pelletier)

@item 
The @code{rfc822} module’s parsing of email addresses is now compliant with
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}, an update to 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html}.  (The module’s name is `not' going to be
changed to @code{rfc2822}.)  A new package, @ref{3c,,email}, has also been added for
parsing and generating e-mail messages.  (Contributed by Barry Warsaw, and
arising out of his work on Mailman.)

@item 
The @ref{38,,difflib} module now contains a new @code{Differ} class for
producing human-readable lists of changes (a «delta») between two sequences of
lines of text.  There are also two generator functions, @code{ndiff()} and
@code{restore()}, which respectively return a delta from two sequences, or one of
the original sequences from a delta. (Grunt work contributed by David Goodger,
from ndiff.py code by Tim Peters who then did the generatorization.)

@item 
New constants @code{ascii_letters}, @code{ascii_lowercase}, and
@code{ascii_uppercase} were added to the @ref{d3,,string} module.  There were
several modules in the standard library that used @code{string.letters} to
mean the ranges A-Za-z, but that assumption is incorrect when locales are in
use, because @code{string.letters} varies depending on the set of legal
characters defined by the current locale.  The buggy modules have all been fixed
to use @code{ascii_letters} instead. (Reported by an unknown person; fixed by
Fred L. Drake, Jr.)

@item 
The @ref{8f,,mimetypes} module now makes it easier to use alternative MIME-type
databases by the addition of a @ref{153b,,MimeTypes} class, which takes a list of
filenames to be parsed.  (Contributed by Fred L. Drake, Jr.)

@item 
A @ref{11ca,,Timer} class was added to the @ref{ed,,threading} module that allows
scheduling an activity to happen at some future time.  (Contributed by Itamar
Shtull-Trauring.)
@end itemize

@c ======================================================================

@node Cambios y correcciones en el intérprete,Otros cambios y correcciones<3>,Módulos nuevos y mejorados<3>,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 interpreter-changes-and-fixes}@anchor{153c}
@subsection Cambios y correcciones en el intérprete


Algunos de los cambios sólo afectan a la gente que trata con el intérprete de Python a nivel de C porque están escribiendo módulos de extensión de Python, incrustando el intérprete, o simplemente hackeando el propio intérprete. Si sólo escribes código Python, ninguno de los cambios descritos aquí te afectará mucho.


@itemize *

@item 
Las funciones de perfilado y rastreo pueden implementarse ahora en C, que puede operar a velocidades mucho mayores que las funciones basadas en Python y debería reducir la sobrecarga de perfilado y rastreo.  Esto será de interés para los autores de entornos de desarrollo para Python.  Se han añadido dos nuevas funciones en C a la API de Python, @ref{153d,,PyEval_SetProfile()} y @ref{153e,,PyEval_SetTrace()}. Las funciones @ref{153f,,sys.setprofile()} y @ref{1540,,sys.settrace()} existentes siguen existiendo, y simplemente se han cambiado para utilizar la nueva interfaz de nivel C.  (Contribución de Fred L. Drake, Jr.)

@item 
Another low-level API, primarily of interest to implementers of Python
debuggers and development tools, was added. @ref{1541,,PyInterpreterState_Head()} and
@ref{1542,,PyInterpreterState_Next()} let a caller walk through all the existing
interpreter objects; @ref{1543,,PyInterpreterState_ThreadHead()} and
@ref{1544,,PyThreadState_Next()} allow looping over all the thread states for a given
interpreter.  (Contributed by David Beazley.)

@item 
La interfaz a nivel de C para el recolector de basura ha sido cambiada para facilitar la escritura de tipos de extensión que soporten la recolección de basura y para depurar los malos usos de las funciones. Varias funciones tienen una semántica ligeramente diferente, por lo que hubo que cambiar el nombre de un montón de funciones.  Las extensiones que utilizan la antigua API seguirán compilando pero `no' participarán en la recolección de basura, por lo que actualizarlas para la 2.2 debería considerarse de alta prioridad.

Para actualizar un módulo de extensión a la nueva API, realice los siguientes pasos:

@item 
Rename @code{Py_TPFLAGS_GC} to @ref{817,,Py_TPFLAGS_HAVE_GC}.

@item 

@table @asis

@item Utilice @ref{b2d,,PyObject_GC_New()} o @ref{b2e,,PyObject_GC_NewVar()} para asignar

objetos, y @ref{1545,,PyObject_GC_Del()} para desocuparlos.
@end table

@item 
Rename @code{PyObject_GC_Init()} to @ref{1546,,PyObject_GC_Track()} and
@code{PyObject_GC_Fini()} to @ref{1547,,PyObject_GC_UnTrack()}.

@item 
Remove @code{PyGC_HEAD_SIZE} from object size calculations.

@item 
Remove calls to @code{PyObject_AS_GC()} and @code{PyObject_FROM_GC()}.

@item 
Se ha añadido una nueva secuencia de formato @code{et} a @ref{615,,PyArg_ParseTuple()}; @code{et} toma tanto un parámetro como un nombre de codificación, y convierte el parámetro a la codificación dada si el parámetro resulta ser una cadena Unicode, o lo deja solo si es una cadena de 8 bits, asumiendo que ya está en la codificación deseada.  Esto difiere del carácter de formato @code{es}, que asume que las cadenas de 8 bits están en la codificación ASCII por defecto de Python y las convierte a la nueva codificación especificada. (Contribuido por M.-A. Lemburg, y utilizado para el soporte de MBCS en Windows descrito en la siguiente sección)

@item 
Se ha agregado una función de análisis de argumentos diferente, @ref{1548,,PyArg_UnpackTuple()}, que es más simple y presumiblemente más rápida. En lugar de especificar una cadena de formato, la persona que llama simplemente proporciona el número mínimo y máximo de argumentos esperados y un conjunto de punteros a las variables @ref{42d,,PyObject}* que se completarán con los valores de los argumentos.

@item 
Two new flags @ref{1514,,METH_NOARGS} and @ref{1549,,METH_O} are available in method
definition tables to simplify implementation of methods with no arguments or a
single untyped argument. Calling such methods is more efficient than calling a
corresponding method that uses @ref{154a,,METH_VARARGS}.  Also, the old
@code{METH_OLDARGS} style of writing C methods is  now officially deprecated.

@item 
Two new wrapper functions, @ref{154b,,PyOS_snprintf()} and @ref{154c,,PyOS_vsnprintf()}
were added to provide  cross-platform implementations for the relatively new
@code{snprintf()} and @code{vsnprintf()} C lib APIs. In contrast to the standard
@code{sprintf()} and @code{vsprintf()} functions, the Python versions check the
bounds of the buffer used to protect against buffer overruns. (Contributed by
M.-A. Lemburg.)

@item 
La función @ref{154d,,_PyTuple_Resize()} ha perdido un parámetro que no se utilizaba, por lo que ahora toma 2 parámetros en lugar de 3. El tercer argumento nunca se utilizaba, y puede descartarse simplemente al portar el código de versiones anteriores a Python 2.2.
@end itemize

@c ======================================================================

@node Otros cambios y correcciones<3>,Agradecimientos<6>,Cambios y correcciones en el intérprete,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 other-changes-and-fixes}@anchor{154e}
@subsection Otros cambios y correcciones


Como es habitual, hubo un montón de otras mejoras y correcciones de errores repartidas por todo el árbol de fuentes.  Una búsqueda en los registros de cambios de CVS revela que se aplicaron 527 parches y se corrigieron 683 errores entre Python 2.1 y 2.2; en 2.2.1 se aplicaron 139 parches y se corrigieron 143 errores; en 2.2.2 se aplicaron 106 parches y se corrigieron 82 errores.  Es probable que estas cifras estén subestimadas.

Algunos de los cambios más notables son:


@itemize *

@item 
El código del puerto MacOS para Python, mantenido por Jack Jansen, se mantiene ahora en el árbol CVS principal de Python, y se han realizado muchos cambios para soportar MacOS X.

El cambio más significativo es la capacidad de construir Python como un marco de trabajo, que se activa proporcionando la opción @code{--enable-framework} al script de configuración cuando se compila Python.  Según Jack Jansen, «Esto instala una instalación autónoma de Python más el «pegamento» del framework de OS X en @code{/Library/Frameworks/Python.framework} (o en otra ubicación de su elección). Por ahora hay poco beneficio inmediato añadido a esto (en realidad, existe la desventaja de que tienes que cambiar tu PATH para poder encontrar Python), pero es la base para crear una aplicación Python completa, portar el IDE de MacPython, posiblemente usar Python como un lenguaje de scripting estándar de OSA y mucho más.»

La mayoría de los módulos de la caja de herramientas de MacPython, que interactúan con las APIs de MacOS como ventanas, QuickTime, scripts, etc. han sido portados a OS X, pero se han dejado comentados en @code{setup.py}.  Las personas que quieran experimentar con estos módulos pueden descomentarlos manualmente.

@c Jack's original comments:
@c The main change is the possibility to build Python as a
@c framework. This installs a self-contained Python installation plus the
@c OSX framework "glue" into /Library/Frameworks/Python.framework (or
@c another location of choice). For now there is little immediate added
@c benefit to this (actually, there is the disadvantage that you have to
@c change your PATH to be able to find Python), but it is the basis for
@c creating a fullblown Python application, porting the MacPython IDE,
@c possibly using Python as a standard OSA scripting language and much
@c more. You enable this with "configure --enable-framework".
@c The other change is that most MacPython toolbox modules, which
@c interface to all the MacOS APIs such as windowing, quicktime,
@c scripting, etc. have been ported. Again, most of these are not of
@c immediate use, as they need a full application to be really useful, so
@c they have been commented out in setup.py. People wanting to experiment
@c can uncomment them. Gestalt and Internet Config modules are enabled by
@c default.

@item 
Los argumentos de palabras clave pasados a funciones incorporadas que no los aceptan ahora provocan una excepción @ref{228,,TypeError}, con el mensaje «`function' no acepta argumentos de palabras clave».

@item 
Las referencias débiles, añadidas en Python 2.1 como un módulo de extensión, son ahora parte del núcleo porque se utilizan en la implementación de clases de nuevo estilo.  Por lo tanto, la excepción @ref{154f,,ReferenceError} se ha movido del módulo @ref{114,,weakref} para convertirse en una excepción incorporada.

@item 
Un nuevo script, @code{Tools/scripts/cleanfuture.py} de Tim Peters, elimina automáticamente las sentencias @code{__future__} obsoletas del código fuente de Python.

@item 
Se ha añadido un argumento adicional `flags' a la función incorporada @ref{2fb,,compile()}, por lo que el comportamiento de las sentencias @code{__future__} puede ahora observarse correctamente en shells simulados, como los presentados por IDLE y otros entornos de desarrollo.  Esto se describe en 
@geindex Python Enhancement Proposals; PEP 264
PEP 264@footnote{https://peps.python.org/pep-0264/}. (Contribución de Michael Hudson)

@item 
La nueva licencia introducida con Python 1.6 no era compatible con la GPL.  Esto se ha solucionado con algunos cambios textuales menores en la licencia 2.2, de modo que ahora es legal volver a incrustar Python dentro de un programa con licencia GPL.  Tenga en cuenta que Python en sí mismo no es GPL, sino que está bajo una licencia que es esencialmente equivalente a la licencia BSD, igual que siempre.  Los cambios en la licencia también se aplicaron a las versiones 2.0.1 y 2.1.1 de Python.

@item 
Cuando se presenta un nombre de archivo Unicode en Windows, Python ahora lo convertirá en una cadena codificada en MBCS, como la que utilizan las APIs de archivos de Microsoft.  Como las APIs de archivos utilizan explícitamente MBCS, la elección de Python de ASCII como codificación por defecto resulta ser una molestia.  En Unix, se utiliza el juego de caracteres de la localización si @code{locale.nl_langinfo(CODESET)} está disponible.  (El soporte de Windows fue contribuido por Mark Hammond con la ayuda de Marc-André Lemburg. El soporte para Unix fue añadido por Martin von Löwis)

@item 
La compatibilidad con archivos de gran tamaño ya está activada en Windows.  (Contribución de Tim Peters.)

@item 
El script @code{Tools/scripts/ftpmirror.py} ahora analiza un archivo @code{.netrc}, si tiene uno. (Contribución de Mike Romberg)

@item 
Some features of the object returned by the @code{xrange()} function are now
deprecated, and trigger warnings when they’re accessed; they’ll disappear in
Python 2.3. @code{xrange} objects tried to pretend they were full sequence
types by supporting slicing, sequence multiplication, and the @ref{1ed,,in}
operator, but these features were rarely used and therefore buggy.  The
@code{tolist()} method and the @code{start}, @code{stop}, and @code{step}
attributes are also being deprecated.  At the C level, the fourth argument to
the @code{PyRange_New()} function, @code{repeat}, has also been deprecated.

@item 
Hubo un montón de parches para la implementación del diccionario, sobre todo para arreglar posibles vertidos del núcleo si un diccionario contiene objetos que cambian furtivamente su valor hash, o mutan el diccionario que contienen. Durante un tiempo python-dev cayó en un suave ritmo de Michael Hudson encontrando un caso que volcaba el núcleo, Tim Peters corrigiendo el error, Michael encontrando otro caso, y así sucesivamente.

@item 
En Windows, Python puede ahora compilarse con Borland C gracias a una serie de parches aportados por Stephen Hansen, aunque el resultado aún no es totalmente funcional.  (Pero esto `es' un progreso…)

@item 
Otra mejora de Windows: Wise Solutions ofreció generosamente a PythonLabs el uso de su sistema InstallerMaster 8.1.  Los anteriores instaladores de PythonLabs para Windows utilizaban Wise 5.0a, que estaba empezando a mostrar su edad.  (Empaquetado por Tim Peters)

@item 
Los archivos que terminan en @code{.pyw} pueden importarse ahora en Windows. @code{.pyw} es algo exclusivo de Windows, que se utiliza para indicar que un script debe ejecutarse utilizando PYTHONW.EXE en lugar de PYTHON.EXE para evitar que aparezca una consola DOS para mostrar la salida.  Este parche hace posible la importación de tales scripts, en caso de que también se puedan utilizar como módulos.  (Implementado por David Bolen)

@item 
En las plataformas en las que Python utiliza la función C @code{dlopen()} para cargar módulos de extensión, ahora es posible establecer las banderas utilizadas por @code{dlopen()} utilizando las funciones @ref{1550,,sys.getdlopenflags()} y @ref{1191,,sys.setdlopenflags()}. (Contribución de Bram Stolk.)

@item 
The @ref{a64,,pow()} built-in function no longer supports 3 arguments when
floating-point numbers are supplied. @code{pow(x, y, z)} returns @code{(x**y) % z},
but this is never useful for floating-point numbers, and the final result varies
unpredictably depending on the platform.  A call such as @code{pow(2.0, 8.0, 7.0)}
will now raise a @ref{228,,TypeError} exception.
@end itemize

@c ======================================================================

@node Agradecimientos<6>,,Otros cambios y correcciones<3>,Qué hay de nuevo en Python 2 2
@anchor{whatsnew/2 2 acknowledgements}@anchor{1551}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas sus sugerencias, correcciones y ayuda en varios borradores de este artículo: Fred Bremmer, Keith Briggs, Andrew Dalke, Fred L. Drake, Jr, Carel Fellinger, David Goodger, Mark Hammond, Stephen Hansen, Michael Hudson, Jack Jansen, Marc-André Lemburg, Martin von Löwis, Fredrik Lundh, Michael McLay, Nick Mathewson, Paul Moore, Gustavo Niemeyer, Don O’Donnell, Joonas Paalasma, Tim Peters, Jens Quade, Tom Reinhardt, Neil Schemenauer, Guido van Rossum, Greg Ward, Edward Welbourne.

@node Qué hay de nuevo en Python 2 1,Qué hay de nuevo en Python 2 0,Qué hay de nuevo en Python 2 2,Qué hay de nuevo en Python
@anchor{whatsnew/2 1 doc}@anchor{1552}@anchor{whatsnew/2 1 what-s-new-in-python-2-1}@anchor{1553}
@section Qué hay de nuevo en Python 2.1


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew21.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* Introducción: Introducción<2>. 
* PEP 227; Ámbitos anidados: PEP 227 Ámbitos anidados<2>. 
* PEP 236; Directivas __future__: PEP 236 Directivas __future__. 
* PEP 207; Comparaciones Enriquecidas: PEP 207 Comparaciones Enriquecidas. 
* PEP 230; Marco de advertencia: PEP 230 Marco de advertencia. 
* PEP 229; Sistema de construcción nuevo: PEP 229 Sistema de construcción nuevo. 
* PEP 205; Referencias débiles: PEP 205 Referencias débiles. 
* PEP 232; Atributos de la función: PEP 232 Atributos de la función. 
* PEP 235; Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas: PEP 235 Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas. 
* PEP 217; Gancho de pantalla interactivo: PEP 217 Gancho de pantalla interactivo. 
* PEP 208; Nuevo modelo de coerción: PEP 208 Nuevo modelo de coerción. 
* PEP 241; Metadatos en paquetes de Python: PEP 241 Metadatos en paquetes de Python. 
* Módulos nuevos y mejorados: Módulos nuevos y mejorados<4>. 
* Otros cambios y correcciones: Otros cambios y correcciones<4>. 
* Agradecimientos: Agradecimientos<7>. 

@end menu

@node Introducción<2>,PEP 227 Ámbitos anidados<2>,,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 introduction}@anchor{1554}
@subsection Introducción


Este artículo explica las nuevas características de Python 2.1. Aunque no hay tantos cambios en 2.1 como en Python 2.0, todavía hay algunas sorpresas agradables. La versión 2.1 es la primera que se dirige mediante el uso de Propuestas de Mejora de Python, o PEPs, por lo que la mayoría de los cambios importantes tienen PEPs adjuntos que proporcionan una documentación más completa y una justificación de diseño para el cambio. Este artículo no intenta documentar las nuevas características por completo, sino que simplemente proporciona una visión general de las nuevas características para los programadores de Python. Consulta la documentación de Python 2.1, o el PEP específico, para obtener más detalles sobre cualquier nueva característica que te interese particularmente.

Un objetivo reciente del equipo de desarrollo de Python ha sido acelerar el ritmo de las nuevas versiones, con una nueva versión cada 6 a 9 meses. La versión 2.1 es la primera que sale a este ritmo más rápido, con la primera alfa que apareció en enero, 3 meses después de que se publicara la versión final de la 2.0.

La versión final de Python 2.1 se realizó el 17 de abril de 2001.

@c ======================================================================

@node PEP 227 Ámbitos anidados<2>,PEP 236 Directivas __future__,Introducción<2>,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-227-nested-scopes}@anchor{1555}
@subsection PEP 227: Ámbitos anidados


El mayor cambio en Python 2.1 es el de las reglas de alcance de Python. En Python 2.0, en cualquier momento hay como máximo tres espacios de nombres utilizados para buscar nombres de variables: local, a nivel de módulo y el espacio de nombres incorporado. Esto a menudo sorprendía a la gente porque no coincidía con sus expectativas intuitivas. Por ejemplo, una definición de función recursiva anidada no funciona:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

The function @code{g()} will always raise a @ref{4ec,,NameError} exception, because
the binding of the name @code{g} isn’t in either its local namespace or in the
module-level namespace.  This isn’t much of a problem in practice (how often do
you recursively define interior functions like this?), but this also made using
the @ref{1309,,lambda} expression clumsier, and this was a problem in practice.
In code which uses @ref{1309,,lambda} you can often find local variables being
copied by passing them as the default values of arguments.

@example
def find(self, name):
    "Return list of any entries equal to 'name'"
    L = filter(lambda x, name=name: x == name,
               self.list_attribute)
    return L
@end example

La legibilidad del código Python escrito en un estilo fuertemente funcional sufre mucho como resultado.

El cambio más significativo de Python 2.1 es que se ha añadido al lenguaje el ámbito estático para solucionar este problema. Como primer efecto, el argumento por defecto @code{name=name} es ahora innecesario en el ejemplo anterior. En pocas palabras, cuando a un nombre de variable dado no se le asigna un valor dentro de una función (mediante una asignación, o las sentencias @ref{1497,,def}, @ref{133f,,class}, o @ref{682,,import}), las referencias a la variable se buscarán en el espacio de nombres local del ámbito que la rodea. Puede encontrar una explicación más detallada de las reglas y una disección de la implementación en el PEP.

Este cambio puede causar algunos problemas de compatibilidad para el código en el que el mismo nombre de variable se utiliza tanto a nivel de módulo como de variable local dentro de una función que contiene otras definiciones de función. Sin embargo, esto parece bastante improbable, ya que dicho código habría sido bastante confuso de leer en primer lugar.

Un efecto secundario del cambio es que las sentencias @code{from module import *} y @code{exec} se han hecho ilegales dentro del ámbito de una función bajo ciertas condiciones. El manual de referencia de Python ha dicho todo el tiempo que @code{from module import *} sólo es legal en el nivel superior de un módulo, pero el intérprete de CPython nunca ha aplicado esto antes. Como parte de la implementación de los ámbitos anidados, el compilador que convierte el código fuente de Python en bytecodes tiene que generar un código diferente para acceder a las variables de un ámbito contenedor. Los códigos @code{from module import *} y @code{exec} hacen que el compilador no pueda averiguar esto, porque añaden nombres al espacio de nombres local que son desconocidos en tiempo de compilación. Por lo tanto, si una función contiene definiciones de funciones o expresiones @ref{1309,,lambda} con variables libres, el compilador lo señalará lanzando una excepción @ref{150,,SyntaxError}.

Para que la explicación anterior quede un poco más clara, he aquí un ejemplo:

@example
x = 1
def f():
    # The next line is a syntax error
    exec 'x=2'
    def g():
        return x
@end example

Line 4 containing the @code{exec} statement is a syntax error, since
@code{exec} would define a new local variable named @code{x} whose value should
be accessed by @code{g()}.

Esto no debería ser una gran limitación, ya que @code{exec} rara vez se utiliza en la mayoría del código de Python (y cuando se utiliza, a menudo es un signo de un mal diseño de todos modos).

Los problemas de compatibilidad han llevado a que los ámbitos anidados se introduzcan gradualmente; en Python 2.1, no están habilitados por defecto, pero pueden activarse dentro de un módulo utilizando una sentencia future como se describe en 
@geindex Python Enhancement Proposals; PEP 236
PEP 236@footnote{https://peps.python.org/pep-0236/}. (En Python 2.2, los ámbitos anidados se convertirán en el valor por defecto y no habrá forma de desactivarlos, pero los usuarios habrán tenido toda la vida de la versión 2.1 para arreglar cualquier rotura resultante de su introducción.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - Ámbitos anidados estáticamente

Escrito e implementado por Jeremy Hylton.
@end table


@c ======================================================================

@node PEP 236 Directivas __future__,PEP 207 Comparaciones Enriquecidas,PEP 227 Ámbitos anidados<2>,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-236-future-directives}@anchor{1556}
@subsection PEP 236: Directivas __future__


La reacción a los ámbitos anidados fue una preocupación generalizada sobre los peligros de romper el código con la versión 2.1, y fue lo suficientemente fuerte como para que los Pythonistas adoptaran un enfoque más conservador. Este enfoque consiste en introducir una convención para habilitar una funcionalidad opcional en la versión N que se convertirá en obligatoria en la versión N+1.

La sintaxis utiliza una sentencia @code{from...import} utilizando el nombre de módulo reservado @ref{0,,__future__}. Los ámbitos anidados pueden habilitarse mediante la siguiente sentencia:

@example
from __future__ import nested_scopes
@end example

Aunque parece una sentencia @ref{682,,import} normal, no lo es; hay reglas estrictas sobre dónde se puede poner una sentencia future. Sólo pueden estar en la parte superior de un módulo, y deben preceder a cualquier código Python o a las sentencias @code{import} normales. Esto se debe a que tales declaraciones pueden afectar a la forma en que el compilador de código de bytes de Python analiza el código y genera el código de bytes, por lo que deben preceder a cualquier declaración que dé lugar a la producción de códigos de bytes.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - De vuelta al @ref{0,,__future__}

Escrito por Tim Peters, y ejecutado principalmente por Jeremy Hylton.
@end table


@c ======================================================================

@node PEP 207 Comparaciones Enriquecidas,PEP 230 Marco de advertencia,PEP 236 Directivas __future__,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-207-rich-comparisons}@anchor{1557}
@subsection PEP 207: Comparaciones Enriquecidas


In earlier versions, Python’s support for implementing comparisons on user-defined
classes and extension types was quite simple. Classes could implement a
@code{__cmp__()} method that was given two instances of a class, and could only
return 0 if they were equal or +1 or -1 if they weren’t; the method couldn’t
raise an exception or return anything other than a Boolean value.  Users of
Numeric Python often found this model too weak and restrictive, because in the
number-crunching programs that numeric Python is used for, it would be more
useful to be able to perform elementwise comparisons of two matrices, returning
a matrix containing the results of a given comparison for each element.  If the
two matrices are of different sizes, then the compare has to be able to raise an
exception to signal the error.

En Python 2.1, se añadieron comparaciones enriquecidas para dar soporte a esta necesidad. Las clases de Python pueden ahora sobrecargar individualmente cada una de las operaciones @code{<}, @code{<=}, @code{>}, @code{>=}, @code{==} y @code{!=}. Los nuevos nombres de métodos mágicos son:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Nombre del método

@item

@code{<}

@tab

@ref{1372,,__lt__()}

@item

@code{<=}

@tab

@ref{1373,,__le__()}

@item

@code{>}

@tab

@ref{1374,,__gt__()}

@item

@code{>=}

@tab

@ref{1375,,__ge__()}

@item

@code{==}

@tab

@ref{b85,,__eq__()}

@item

@code{!=}

@tab

@ref{1558,,__ne__()}

@end multitable


(Los métodos mágicos se denominan como los correspondientes operadores de Fortran @code{.LT.}. @code{.LE.}, &c. Los programadores numéricos están casi seguramente bastante familiarizados con estos nombres y los encontrarán fáciles de recordar.)

Cada uno de estos métodos mágicos tiene la forma @code{method(self, other)}, donde @code{self} será el objeto que se encuentre en el lado izquierdo del operador, mientras que @code{other} será el objeto que se encuentre en el lado derecho. Por ejemplo, la expresión @code{A < B} hará que se llame a @code{A.__lt__(B)}.

Cada uno de estos métodos mágicos puede retornar cualquier cosa: un booleano, una matriz, una lista o cualquier otro objeto de Python. También pueden lanzar una excepción si la comparación es imposible, inconsistente o no tiene sentido.

The built-in @code{cmp(A,B)} function can use the rich comparison machinery,
and now accepts an optional argument specifying which comparison operation to
use; this is given as one of the strings @code{"<"}, @code{"<="}, @code{">"}, @code{">="},
@code{"=="}, or @code{"!="}.  If called without the optional third argument,
@code{cmp()} will only return -1, 0, or +1 as in previous versions of Python;
otherwise it will call the appropriate method and can return any Python object.

También hay cambios correspondientes de interés para los programadores de C; hay una nueva ranura @code{tp_richcmp} en los objetos de tipo y una API para realizar una comparación rica determinada. No cubrirá la API de C aquí, sino que le remitiré a 
@geindex Python Enhancement Proposals; PEP 207
PEP 207@footnote{https://peps.python.org/pep-0207/}, o a la documentación de la API de C de 2.1, para la lista completa de funciones relacionadas.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 207

@item PEP 207@footnote{https://peps.python.org/pep-0207/} - Comparaciones enriquecidas

Escrito por Guido van Rossum, basado en gran medida en un trabajo anterior de David Ascher, e implementado por Guido van Rossum.
@end table


@c ======================================================================

@node PEP 230 Marco de advertencia,PEP 229 Sistema de construcción nuevo,PEP 207 Comparaciones Enriquecidas,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-230-warning-framework}@anchor{1559}
@subsection PEP 230: Marco de advertencia


A lo largo de sus 10 años de existencia, Python ha acumulado un cierto número de módulos y características obsoletas en el camino. Es difícil saber cuándo es seguro eliminar una característica, ya que no hay manera de saber cuánto código la utiliza — tal vez ningún programa depende de la característica, o tal vez muchos lo hacen. Para permitir la eliminación de características antiguas de una manera más estructurada, se añadió un marco de advertencia. Cuando los desarrolladores de Python quieran deshacerse de una característica, primero se activará una advertencia en la siguiente versión de Python. La siguiente versión de Python puede entonces eliminar la característica, y los usuarios habrán tenido un ciclo de lanzamiento completo para eliminar los usos de la antigua característica.

Python 2.1 añade el marco de trabajo de las advertencias para ser utilizado en este esquema. Añade un módulo @ref{112,,warnings} que proporciona funciones para emitir advertencias, y para filtrar las advertencias que no se quieren mostrar. Los módulos de terceros también pueden utilizar este marco de trabajo para dejar de lado funciones antiguas que ya no desean soportar.

For example, in Python 2.1 the @code{regex} module is deprecated, so importing
it causes a warning to be printed:

@example
>>> import regex
__main__:1: DeprecationWarning: the regex module
         is deprecated; please use the re module
>>>
@end example

Las advertencias se pueden emitir llamando a la función @ref{155a,,warnings.warn()}:

@example
warnings.warn("feature X no longer supported")
@end example

El primer parámetro es el mensaje de advertencia; se pueden utilizar otros parámetros opcionales para especificar una categoría de advertencia concreta.

Filters can be added to disable certain warnings; a regular expression pattern
can be applied to the message or to the module name in order to suppress a
warning.  For example, you may have a program that uses the @code{regex} module
and not want to spare the time to convert it to use the @ref{b9,,re} module right
now.  The warning can be suppressed by calling

@example
import warnings
warnings.filterwarnings(action = 'ignore',
                        message='.*regex module is deprecated',
                        category=DeprecationWarning,
                        module = '__main__')
@end example

This adds a filter that will apply only to warnings of the class
@ref{1da,,DeprecationWarning} triggered in the @ref{1,,__main__} module, and applies
a regular expression to only match the message about the @code{regex} module
being deprecated, and will cause such warnings to be ignored.  Warnings can also
be printed only once, printed every time the offending code is executed, or
turned into exceptions that will cause the program to stop (unless the
exceptions are caught in the usual way, of course).

También se agregaron funciones a la API de C de Python para emitir advertencias; consulte el PEP 230 o la documentación de la API de Python para conocer los detalles.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 5

@item PEP 5@footnote{https://peps.python.org/pep-0005/} - Directrices para la evolución del lenguaje

Escrito por Paul Prescod, para especificar los procedimientos a seguir cuando se eliminan características antiguas de PythonLa política descrita en este PEP no ha sido adoptada oficialmente, pero la política final probablemente no será muy diferente de la propuesta de Prescod.

@geindex Python Enhancement Proposals; PEP 230

@item PEP 230@footnote{https://peps.python.org/pep-0230/} - Marco de advertencia

Escrito y ejecutado por Guido van Rossum.
@end table


@c ======================================================================

@node PEP 229 Sistema de construcción nuevo,PEP 205 Referencias débiles,PEP 230 Marco de advertencia,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-229-new-build-system}@anchor{155b}
@subsection PEP 229: Sistema de construcción nuevo


Al compilar Python, el usuario tenía que entrar y editar el archivo @code{Modules/Setup} para habilitar varios módulos adicionales; el conjunto por defecto es relativamente pequeño y se limita a los módulos que se compilan en la mayoría de las plataformas Unix. Esto significa que en plataformas Unix con muchas más características, sobre todo Linux, las instalaciones de Python no suelen contener todos los módulos útiles que podrían.

Python 2.0 añadió los Distutils, un conjunto de módulos para distribuir e instalar extensiones. En Python 2.1, los Distutils se utilizan para compilar gran parte de la biblioteca estándar de módulos de extensión, autodetectando cuáles son compatibles con la máquina actual Se espera que esto haga que las instalaciones de Python sean más fáciles y tengan más funciones.

En lugar de tener que editar el archivo @code{Modules/Setup} para habilitar los módulos, un script @code{setup.py} en el directorio superior de la distribución de fuentes de Python se ejecuta en el momento de la compilación, e intenta descubrir qué módulos pueden ser habilitados examinando los módulos y archivos de cabecera en el sistema. Si un módulo está configurado en @code{Modules/Setup}, el script @code{setup.py} no intentará compilar ese módulo y se remitirá al contenido del archivo @code{Modules/Setup}. Esto proporciona una manera de especificar cualquier flag de línea de comandos extraña o bibliotecas que se requieren para una plataforma específica.

En otro cambio de gran alcance en el mecanismo de construcción, Neil Schemenauer reestructuró las cosas para que Python ahora utilice un único makefile que no es recursivo, en lugar de makefiles en el directorio superior y en cada uno de los subdirectorios @code{Python/}, @code{Parser/}, @code{Objects/}, y @code{Modules/}. Esto hace que la construcción de Python sea más rápida y también hace que el hackeo de los Makefiles sea más claro y sencillo.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 229

@item PEP 229@footnote{https://peps.python.org/pep-0229/} - Uso de Distutils para construir Python

Escrito y ejecutado por A.M. Kuchling.
@end table


@c ======================================================================

@node PEP 205 Referencias débiles,PEP 232 Atributos de la función,PEP 229 Sistema de construcción nuevo,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-205-weak-references}@anchor{155c}
@subsection PEP 205: Referencias débiles


Las referencias débiles, disponibles a través del módulo @ref{114,,weakref}, son un nuevo tipo de datos menor pero útil en la caja de herramientas del programador de Python.

Almacenar una referencia a un objeto (por ejemplo, en un diccionario o una lista) tiene el efecto secundario de mantener ese objeto vivo para siempre. Hay algunos casos específicos en los que este comportamiento es indeseable, siendo las cachés de objetos el más común, y otro son las referencias circulares en estructuras de datos como los árboles.

Por ejemplo, considere una función de memoización que almacena en caché los resultados de otra función @code{f(x)} almacenando el argumento de la función y su resultado en un diccionario:

@example
_cache = @{@}
def memoize(x):
    if _cache.has_key(x):
        return _cache[x]

    retval = f(x)

    # Cache the returned object
    _cache[x] = retval

    return retval
@end example

This version works for simple things such as integers, but it has a side effect;
the @code{_cache} dictionary holds a reference to the return values, so they’ll
never be deallocated until the Python process exits and cleans up. This isn’t
very noticeable for integers, but if @code{f()} returns an object, or a data
structure that takes up a lot of memory, this can be a problem.

Las referencias débiles proporcionan una forma de implementar una caché que no mantendrá los objetos vivos más allá de su tiempo. Si un objeto sólo es accesible a través de referencias débiles, el objeto será desasignado y las referencias débiles indicarán ahora que el objeto al que se refería ya no existe. Una referencia débil a un objeto `obj' se crea llamando @code{wr = weakref.ref(obj)}. El objeto al que se hace referencia se retorna llamando a la referencia débil como si fuera una función: @code{wr()} retornará el objeto referenciado, o @code{None} si el objeto ya no existe.

This makes it possible to write a @code{memoize()} function whose cache doesn’t
keep objects alive, by storing weak references in the cache.

@example
_cache = @{@}
def memoize(x):
    if _cache.has_key(x):
        obj = _cache[x]()
        # If weak reference object still exists,
        # return it
        if obj is not None: return obj

    retval = f(x)

    # Cache a weak reference
    _cache[x] = weakref.ref(retval)

    return retval
@end example

The @ref{114,,weakref} module also allows creating proxy objects which behave like
weak references — an object referenced only by proxy objects is deallocated –
but instead of requiring an explicit call to retrieve the object, the proxy
transparently forwards all operations to the object as long as the object still
exists.  If the object is deallocated, attempting to use a proxy will cause a
@code{weakref.ReferenceError} exception to be raised.

@example
proxy = weakref.proxy(obj)
proxy.attr   # Equivalent to obj.attr
proxy.meth() # Equivalent to obj.meth()
del obj
proxy.attr   # raises weakref.ReferenceError
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - Referencias débiles

Escrito e implementado por Fred L. Drake, Jr.
@end table


@c ======================================================================

@node PEP 232 Atributos de la función,PEP 235 Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas,PEP 205 Referencias débiles,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-232-function-attributes}@anchor{155d}
@subsection PEP 232: Atributos de la función


In Python 2.1, functions can now have arbitrary information attached to them.
People were often using docstrings to hold information about functions and
methods, because the @ref{1246,,__doc__} attribute was the only way of
attaching any
information to a function.  For example, in the Zope web application server,
functions are marked as safe for public access by having a docstring, and in
John Aycock’s SPARK parsing framework, docstrings hold parts of the BNF grammar
to be parsed.  This overloading is unfortunate, since docstrings are really
intended to hold a function’s documentation; for example, it means you can’t
properly document functions intended for private use in Zope.

Ahora se pueden establecer y recuperar atributos arbitrarios en las funciones utilizando la sintaxis normal de Python:

@example
def f(): pass

f.publish = 1
f.secure = 1
f.grammar = "A ::= B (C D)*"
@end example

The dictionary containing attributes can be accessed as the function’s
@ref{133a,,__dict__}. Unlike the @ref{ce5,,__dict__} attribute of class instances, in
functions you can actually assign a new dictionary to @ref{133a,,__dict__}, though
the new value is restricted to a regular Python dictionary; you `can’t' be
tricky and set it to a @code{UserDict} instance, or any other random object
that behaves like a mapping.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 232

@item PEP 232@footnote{https://peps.python.org/pep-0232/} - Atributos de la función

Escrito y ejecutado por Barry Warsaw.
@end table


@c ======================================================================

@node PEP 235 Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas,PEP 217 Gancho de pantalla interactivo,PEP 232 Atributos de la función,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-235-importing-modules-on-case-insensitive-platforms}@anchor{155e}
@subsection PEP 235: Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas


Algunos sistemas operativos tienen sistemas de archivos que no distinguen entre mayúsculas y minúsculas, siendo MacOS y Windows los principales ejemplos; en estos sistemas, es imposible distinguir los nombres de archivo @code{FILE.PY} y @code{file.py}, aunque almacenan el nombre del archivo en su caso original (también preservan las mayúsculas).

En Python 2.1, la sentencia @ref{682,,import} funcionará para simular la distinción entre mayúsculas y minúsculas en plataformas que no las distinguen. Python buscará ahora la primera coincidencia entre mayúsculas y minúsculas por defecto, lanzando un @ref{4d7,,ImportError} si no se encuentra dicho fichero, por lo que @code{import file} no importará un módulo llamado @code{FILE.PY}. La coincidencia insensible a mayúsculas y minúsculas puede solicitarse estableciendo la variable de entorno 
@geindex PYTHONCASEOK
@geindex variables de entorno; PYTHONCASEOK
@ref{9ef,,PYTHONCASEOK} antes de iniciar el intérprete de Python.

@c ======================================================================

@node PEP 217 Gancho de pantalla interactivo,PEP 208 Nuevo modelo de coerción,PEP 235 Importación de módulos en plataformas que no distinguen entre mayúsculas y minúsculas,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-217-interactive-display-hook}@anchor{155f}
@subsection PEP 217: Gancho de pantalla interactivo


Cuando se utiliza el intérprete de Python de forma interactiva, la salida de los comandos se muestra utilizando la función incorporada @ref{894,,repr()}. En Python 2.1, la variable @ref{1560,,sys.displayhook()} puede establecerse a un objeto invocable que será llamado en lugar de @ref{894,,repr()}. Por ejemplo, puede establecerla a una función especial de impresión bonita:

@example
>>> # Create a recursive data structure
... L = [1,2,3]
>>> L.append(L)
>>> L # Show Python's default output
[1, 2, 3, [...]]
>>> # Use pprint.pprint() as the display function
... import sys, pprint
>>> sys.displayhook = pprint.pprint
>>> L
[1, 2, 3,  <Recursion on list with id=135143996>]
>>>
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 217

@item PEP 217@footnote{https://peps.python.org/pep-0217/} - Gancho de visualización para uso interactivo

Escrito y ejecutado por Moshe Zadka.
@end table


@c ======================================================================

@node PEP 208 Nuevo modelo de coerción,PEP 241 Metadatos en paquetes de Python,PEP 217 Gancho de pantalla interactivo,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-208-new-coercion-model}@anchor{1561}
@subsection PEP 208: Nuevo modelo de coerción


Se ha modificado significativamente la forma en que se realiza la coerción numérica a nivel de C. Esto sólo afectará a los autores de las extensiones de C a Python, permitiéndoles más flexibilidad a la hora de escribir tipos de extensión que soporten operaciones numéricas.

Los tipos de extensión pueden ahora establecer el indicador de tipo @code{Py_TPFLAGS_CHECKTYPES} en su estructura @code{PyTypeObject} para indicar que soportan el nuevo modelo de coerción. En tales tipos de extensión, las funciones numéricas de ranura ya no pueden asumir que se les pasarán dos argumentos del mismo tipo; en su lugar, se les pueden pasar dos argumentos de tipos diferentes, y entonces pueden realizar su propia coerción interna. Si a la función de ranura se le pasa un tipo que no puede manejar, puede indicar el fallo retornando una referencia al valor singleton @code{Py_NotImplemented}. Las funciones numéricas del otro tipo serán entonces probadas, y quizás puedan manejar la operación; si el otro tipo también retorna @code{Py_NotImplemented}, entonces se levantará un @code{TypeError`Los métodos numéricos escritos en Python también pueden retornar `@w{`}Py_NotImplemented`}, haciendo que el intérprete actúe como si el método no existiera (tal vez lanzando un @ref{228,,TypeError}, tal vez probando los métodos numéricos de otro objeto).


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 208

@item PEP 208@footnote{https://peps.python.org/pep-0208/} - Reformulación del modelo de coerción

Escrito e implementado por Neil Schemenauer, basado en gran medida en el trabajo anterior de Marc-André Lemburg. Léalo para entender los puntos finos de cómo las operaciones numéricas serán ahora procesadas en el nivel C.
@end table


@c ======================================================================

@node PEP 241 Metadatos en paquetes de Python,Módulos nuevos y mejorados<4>,PEP 208 Nuevo modelo de coerción,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 pep-241-metadata-in-python-packages}@anchor{1562}
@subsection PEP 241: Metadatos en paquetes de Python


Una queja común de los usuarios de Python es que no existe un solo catálogo de todos los módulos de Python existentes.  T. Middleton’s Vault of Parnassus en @code{www.vex.net/parnassus/} (borrado en febrero de 2009, disponible en Internet Archive Wayback Machine@footnote{https://web.archive.org/web/20090130140102/http://www.vex.net/parnassus/}) fue uno de los mayores catálogos de módulos de Python, pero registrar software en los archivos es opcional, y a mucha gente no le importó.

Como primer pequeño paso para solucionar el problema, el software de Python empaquetado con el comando @code{sdist} de Distutils incluirá un archivo llamado @code{PKG-INFO} que contiene información sobre el paquete, como su nombre, versión y autor (metadatos, en terminología de catalogación). 
@geindex Python Enhancement Proposals; PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/} contiene la lista completa de campos que pueden estar presentes en el archivo @code{PKG-INFO`A medida que la gente empiece a empaquetar su software usando Python 2.1, más y más paquetes incluirán metadatos, haciendo posible construir sistemas de catalogación automatizados y experimentar con ellosCon la experiencia resultante, tal vez sea posible diseñar un catálogo realmente bueno y luego construir soporte para él en Python 2.2. Por ejemplo, los comandos Distutils :command:`sdist} y @code{bdist_*} podrían soportar una opción @code{upload} que subiera automáticamente tu paquete a un servidor de catálogos.

Puedes empezar a crear paquetes que contengan @code{PKG-INFO} incluso si no estás usando Python 2.1, ya que se hará una nueva versión de las Distutils para los usuarios de versiones anteriores de PythonLa versión 1.0.2 de las Distutils incluye los cambios descritos en 
@geindex Python Enhancement Proposals; PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/}, así como varias correcciones de errores y mejoras. Estará disponible en el SIG de Distutils en @indicateurl{https://www.python.org/community/sigs/current/distutils-sig/}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 241

@item PEP 241@footnote{https://peps.python.org/pep-0241/} - Metadatos para paquetes de software de Python

Escrito y ejecutado por A.M. Kuchling.

@geindex Python Enhancement Proposals; PEP 243

@item PEP 243@footnote{https://peps.python.org/pep-0243/} - Mecanismo de carga del repositorio de módulos

Escrito por Sean Reifschneider, este borrador de PEP describe un mecanismo propuesto para subir paquetes de Python a un servidor central.
@end table


@c ======================================================================

@node Módulos nuevos y mejorados<4>,Otros cambios y correcciones<4>,PEP 241 Metadatos en paquetes de Python,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 new-and-improved-modules}@anchor{1563}
@subsection Módulos nuevos y mejorados



@itemize *

@item 
Ka-Ping Yee contributed two new modules: @code{inspect.py}, a module for
getting information about live Python code, and @code{pydoc.py}, a module for
interactively converting docstrings to HTML or text.  As a bonus,
@code{Tools/scripts/pydoc}, which is now automatically installed, uses
@code{pydoc.py} to display documentation given a Python module, package, or
class name.  For example, @code{pydoc xml.dom} displays the following:

@example
Python Library Documentation: package xml.dom in xml

NAME
    xml.dom - W3C Document Object Model implementation for Python.

FILE
    /usr/local/lib/python2.1/xml/dom/__init__.pyc

DESCRIPTION
    The Python mapping of the Document Object Model is documented in the
    Python Library Reference in the section on the xml.dom package.

    This package contains the following modules:
      ...
@end example

@code{pydoc} también incluye un navegador de ayuda interactiva basado en Tk. @code{pydoc} se vuelve rápidamente adictivo; ¡pruébalo!

@item 
Two different modules for unit testing were added to the standard library.
The @ref{3b,,doctest} module, contributed by Tim Peters, provides a testing
framework based on running embedded examples in docstrings and comparing the
results against the expected output.  PyUnit, contributed by Steve Purcell, is a
unit testing framework inspired by JUnit, which was in turn an adaptation of
Kent Beck’s Smalltalk testing framework.  See @indicateurl{https://pyunit.sourceforge.net/} for
more information about PyUnit.

@item 
The @ref{38,,difflib} module contains a class, @ref{1095,,SequenceMatcher}, which
compares two sequences and computes the changes required to transform one
sequence into the other.  For example, this module can be used to write a tool
similar to the Unix @code{diff} program, and in fact the sample program
@code{Tools/scripts/ndiff.py} demonstrates how to write such a script.

@item 
@ref{2e,,curses.panel}, una envoltura para la biblioteca de paneles, parte de ncurses y de curses SYSV, fue contribuida por Thomas Gellekum. La biblioteca de paneles proporciona ventanas con la característica adicional de la profundidad. Las ventanas pueden ser movidas más arriba o más abajo en el ordenamiento de la profundidad, y la librería de paneles calcula dónde se superponen los paneles y qué secciones son visibles.

@item 
The PyXML package has gone through a few releases since Python 2.0, and Python
2.1 includes an updated version of the @ref{120,,xml} package.  Some of the
noteworthy changes include support for Expat 1.2 and later versions, the ability
for Expat parsers to handle files in any encoding supported by Python, and
various bugfixes for SAX, DOM, and the @code{minidom} module.

@item 
Ping también contribuyó con otro gancho para manejar excepciones no detectadas. @ref{8a2,,sys.excepthook()} se puede configurar como un objeto invocable. Cuando una excepción no es detectada por ningún bloque @ref{789,,try}…@ref{2f6,,except}, la excepción se pasará a @ref{8a2,,sys.excepthook()}, que puede hacer lo que quiera. En la Novena Conferencia de Python, Ping demostró una aplicación para este gancho: imprimir un rastreo extendido que no solo enumera los marcos de la pila, sino que también enumera los argumentos de la función y las variables locales para cada marco.

@item 
Various functions in the @ref{ee,,time} module, such as @ref{1254,,asctime()} and
@ref{1539,,localtime()}, require a floating-point argument containing the time in
seconds since the epoch.  The most common use of these functions is to work with
the current time, so the floating-point argument has been made optional; when a
value isn’t provided, the current time will be used.  For example, log file
entries usually need a string containing the current time; in Python 2.1,
@code{time.asctime()} can be used, instead of the lengthier
@code{time.asctime(time.localtime(time.time()))} that was previously required.

Este cambio fue propuesto y aplicado por Thomas Wouters.

@item 
El módulo @ref{5e,,ftplib} ahora recupera por defecto los ficheros en modo pasivo, porque es más probable que el modo pasivo funcione desde detrás de un cortafuegos. Esta petición vino del sistema de seguimiento de errores de Debian, ya que otros paquetes de Debian utilizan @ref{5e,,ftplib} para recuperar archivos y entonces no funcionan desde detrás de un cortafuegos. Se considera poco probable que esto cause problemas a nadie, porque Netscape utiliza por defecto el modo pasivo y poca gente se queja, pero si el modo pasivo no es adecuado para su aplicación o configuración de red, llame a @code{set_pasv(0)} en los objetos FTP para desactivar el modo pasivo.

@item 
Se ha añadido soporte para el acceso a sockets sin procesar en el módulo @ref{cc,,socket}, aportado por Grant Edwards.

@item 
El módulo @ref{b0,,pstats} contiene ahora un sencillo navegador de estadísticas interactivo para mostrar los perfiles de tiempo de los programas de Python, invocado cuando el módulo se ejecuta como un script. Contribuido por Eric S. Raymond.

@item 
Se ha agregado una nueva función dependiente de la implementación, @code{sys._getframe([depth])}, para devolver un objeto de marco determinado de la pila de llamadas actual. @ref{781,,sys._getframe()} devuelve el marco en la parte superior de la pila de llamadas; si el argumento de entero opcional `depth' is supplied, the function returns the frame that is `depth' llama debajo de la parte superior de la pila. Por ejemplo, @code{sys._getframe(1)} devuelve el objeto de trama de la persona que llama.

Esta función sólo está presente en CPython, no en Jython ni en la implementación de .NET. Utilízala para depurar, y resiste la tentación de ponerla en el código de producción.
@end itemize

@c ======================================================================

@node Otros cambios y correcciones<4>,Agradecimientos<7>,Módulos nuevos y mejorados<4>,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 other-changes-and-fixes}@anchor{1564}
@subsection Otros cambios y correcciones


En Python 2.1 se hicieron relativamente pocos cambios pequeños debido al ciclo de publicación más corto. Una búsqueda en los registros de cambios de CVS muestra 117 parches aplicados y 136 errores corregidos; es probable que ambas cifras estén subestimadas. Algunos de los cambios más notables son:


@itemize *

@item 
A specialized object allocator is now optionally available, that should be
faster than the system @code{malloc()} and have less memory overhead.  The
allocator uses C’s @code{malloc()} function to get large pools of memory, and
then fulfills smaller memory requests from these pools.  It can be enabled by
providing the @code{--with-pymalloc} option to the @code{configure}
script; see @code{Objects/obmalloc.c} for the implementation details.

Authors of C extension modules should test their code with the object allocator
enabled, because some incorrect code may break, causing core dumps at runtime.
There are a bunch of memory allocation functions in Python’s C API that have
previously been just aliases for the C library’s @code{malloc()} and
@code{free()}, meaning that if you accidentally called mismatched functions, the
error wouldn’t be noticeable.  When the object allocator is enabled, these
functions aren’t aliases of @code{malloc()} and @code{free()} any more, and
calling the wrong function to free memory will get you a core dump.  For
example, if memory was allocated using @ref{1565,,PyMem_New}, it has to be freed
using @ref{1566,,PyMem_Del()}, not @code{free()}.  A few modules included with Python
fell afoul of this and had to be fixed; doubtless there are more third-party
modules that will have the same problem.

El asignador de objetos fue aportado por Vladimir Marangozov.

@item 
The speed of line-oriented file I/O has been improved because people often
complain about its lack of speed, and because it’s often been used as a naïve
benchmark.  The @ref{ba,,readline()} method of file objects has therefore been
rewritten to be much faster.  The exact amount of the speedup will vary from
platform to platform depending on how slow the C library’s @code{getc()} was, but
is around 66%, and potentially much faster on some particular operating systems.
Tim Peters did much of the benchmarking and coding for this change, motivated by
a discussion in comp.lang.python.

A new module and method for file objects was also added, contributed by Jeff
Epler. The new method, @code{xreadlines()}, is similar to the existing
@code{xrange()} built-in.  @code{xreadlines()} returns an opaque sequence object
that only supports being iterated over, reading a line on every iteration but
not reading the entire file into memory as the existing @code{readlines()} method
does. You’d use it like this:

@example
for line in sys.stdin.xreadlines():
    # ... do something for each line ...
    ...
@end example

Para una discusión más completa de los cambios en la línea de E/S, véase el resumen de python-dev del 1 al 15 de enero de 2001 en @indicateurl{https://mail.python.org/pipermail/python-dev/2001-January/}.

@item 
A new method, @ref{1567,,popitem()}, was added to dictionaries to enable
destructively iterating through the contents of a dictionary; this can be faster
for large dictionaries because there’s no need to construct a list containing
all the keys or values. @code{D.popitem()} removes a random @code{(key, value)} pair
from the dictionary @code{D} and returns it as a 2-tuple.  This was implemented
mostly by Tim Peters and Guido van Rossum, after a suggestion and preliminary
patch by Moshe Zadka.

@item 
Ahora los módulos pueden controlar qué nombres se importan cuando se utiliza @code{from module import *}, definiendo un atributo @code{__all__} que contiene una lista de nombres que se importarán. Una queja común es que si el módulo importa otros módulos como @ref{d9,,sys} o @ref{d3,,string}, @code{from module import *} los añadirá al espacio de nombres del módulo importador. Para arreglar esto, simplemente liste los nombres públicos en @code{__all__}:

@example
# List public names
__all__ = ['Database', 'open']
@end example

Una versión más estricta de este parche fue primero sugerida e implementada por Ben Wolfson, pero después de algunas discusiones de python-dev, una versión final más débil fue revisada.

@item 
Al aplicar @ref{894,,repr()} a las cadenas, antes se utilizaban escapes octales para los caracteres no imprimibles; por ejemplo, una nueva línea era @code{'\012'}. Esto era un vestigio de la ascendencia de Python en C, pero hoy en día el octal tiene muy poco uso práctico. Ka-Ping Yee sugirió usar escapes hexadecimales en lugar de octales, y usar los escapes @code{\n}, @code{\t}, @code{\r} para los caracteres apropiados, e implementó este nuevo formato.

@item 
Los errores de sintaxis detectados en tiempo de compilación pueden ahora lanzar excepciones que contienen el nombre del archivo y el número de línea del error, un agradable efecto secundario de la reorganización del compilador realizada por Jeremy Hylton.

@item 
C extensions which import other modules have been changed to use
@ref{273,,PyImport_ImportModule()}, which means that they will use any import hooks
that have been installed.  This is also encouraged for third-party extensions
that need to import some other module from C code.

@item 
El tamaño de la base de datos de caracteres Unicode se redujo en otros 340K gracias a Fredrik Lundh.

@item 
Se han aportado algunos puertos nuevos: MacOS X (por Steven Majewski), Cygwin (por Jason Tishler); RISCOS (por Dietmar Schwertberger); Unixware 7 (por Billy G. Allie).
@end itemize

Y hay la lista habitual de correcciones de errores menores, fugas de memoria menores, ediciones de docstrings, y otros ajustes, demasiado largos para que valga la pena detallarlos; vea los registros de CVS para los detalles completos si los quiere.

@c ======================================================================

@node Agradecimientos<7>,,Otros cambios y correcciones<4>,Qué hay de nuevo en Python 2 1
@anchor{whatsnew/2 1 acknowledgements}@anchor{1568}
@subsection Agradecimientos


El autor desea agradecer a las siguientes personas sus sugerencias sobre varios borradores de este artículo: Graeme Cross, David Goodger, Jay Graves, Michael Hudson, Marc-André Lemburg, Fredrik Lundh, Neil Schemenauer, Thomas Wouters.

@node Qué hay de nuevo en Python 2 0,Registro de cambios,Qué hay de nuevo en Python 2 1,Qué hay de nuevo en Python
@anchor{whatsnew/2 0 doc}@anchor{1569}@anchor{whatsnew/2 0 what-s-new-in-python-2-0}@anchor{156a}
@section Qué hay de nuevo en Python 2.0


@*Autor: 
A.M. Kuchling y Moshe Zadka


@c $Id: whatsnew20.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* Introducción: Introducción<3>. 
* ¿Qué pasa con Python 1.6?: ¿Qué pasa con Python 1 6?. 
* Nuevo proceso de desarrollo:: 
* Unicode: Unicode<2>. 
* Comprensión de listas:: 
* Asignación aumentada:: 
* Métodos de cadena de caracteres:: 
* Recogida de basura de los ciclos:: 
* Otros cambios en el núcleo:: 
* Adaptación a la versión 2.0: Adaptación a la versión 2 0. 
* Extensión/Incorporación de cambios:: 
* Distutils; Facilitando la instalación de módulos: Distutils Facilitando la instalación de módulos. 
* Módulos XML:: 
* Cambios en los módulos:: 
* Nuevos módulos: Nuevos módulos<9>. 
* Mejoras en IDLE:: 
* Módulos eliminados y obsoletos:: 
* Agradecimientos: Agradecimientos<8>. 

@end menu

@node Introducción<3>,¿Qué pasa con Python 1 6?,,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 introduction}@anchor{156b}
@subsection Introducción


El 16 de octubre de 2000 se publicó una nueva versión de Python, la 2.0. Este artículo cubre las emocionantes nuevas características de la 2.0, destaca algunos otros cambios útiles y señala algunos cambios incompatibles que pueden requerir reescribir el código.

El desarrollo de Python nunca se detiene por completo entre versiones, y siempre se envía un flujo constante de correcciones de errores y mejoras. Una gran cantidad de correcciones menores, algunas optimizaciones, cadenas de documentación adicionales y mejores mensajes de error entraron en 2.0; enumerarlos a todos sería imposible, pero ciertamente son significativos. Consulte los registros de CVS disponibles públicamente si desea ver la lista completa. Este progreso se debe a que a los cinco desarrolladores que trabajan para PythonLabs ahora se les paga por dedicar sus días a corregir errores, y también a la mejora de la comunicación resultante de la migración a SourceForge.

@c ======================================================================

@node ¿Qué pasa con Python 1 6?,Nuevo proceso de desarrollo,Introducción<3>,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 what-about-python-1-6}@anchor{156c}
@subsection ¿Qué pasa con Python 1.6?


Python 1.6 puede considerarse como la versión de Python de las Obligaciones Contractuales. Después de que el equipo principal de desarrollo dejara el CNRI en mayo de 2000, el CNRI pidió que se creara una versión 1.6 que contuviera todo el trabajo sobre Python que se había realizado en el CNRI. Por lo tanto, Python 1.6 representa el estado del árbol CVS en mayo de 2000, siendo la novedad más importante el soporte de Unicode. El desarrollo continuó después de mayo, por supuesto, así que el árbol 1.6 recibió algunas correcciones para asegurar que es compatible con Python 2.0. 1.Por lo tanto, la 6 es parte de la evolución de Python, y no una rama lateral.

Entonces, ¿deberías interesarte mucho por Python 1.6?  Probablemente no. Las versiones 1.6final y 2.0beta1 se publicaron el mismo día (5 de septiembre de 2000), y el plan es finalizar Python 2.0 en un mes más o menos. Si tienes aplicaciones que mantener, no parece que tenga mucho sentido romper cosas al pasar a la 1.6, arreglarlas, y luego tener otra ronda de roturas dentro de un mes al pasar a la 2.0; es mejor pasar directamente a la 2.0. La mayoría de las características realmente interesantes descritas en este documento sólo están en la 2.0, porque se hizo mucho trabajo entre mayo y septiembre.

@c ======================================================================

@node Nuevo proceso de desarrollo,Unicode<2>,¿Qué pasa con Python 1 6?,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 new-development-process}@anchor{156d}
@subsection Nuevo proceso de desarrollo


El cambio más importante en Python 2.0 puede que no sea en el código en absoluto, sino en la forma de desarrollar Python: en mayo de 2000 los desarrolladores de Python comenzaron a utilizar las herramientas puestas a disposición por SourceForge para almacenar el código fuente, rastrear los informes de errores y gestionar la cola de envíos de parches. Para informar de errores o enviar parches para Python 2.0, utilice las herramientas de seguimiento de errores y gestión de parches disponibles en la página del proyecto Python, situada en @indicateurl{https://sourceforge.net/projects/python/}.

El más importante de los servicios alojados ahora en SourceForge es el árbol CVS de Python, el repositorio de versiones controladas que contiene el código fuente de Python. Anteriormente, había unas 7 personas que tenían acceso de escritura al árbol CVS, y todos los parches tenían que ser inspeccionados y comprobados por una de las personas de esta corta lista. Obviamente, esto no era muy escalable. Al trasladar el árbol CVS a SourceForge, fue posible conceder acceso de escritura a más personas; en septiembre de 2000 había 27 personas que podían revisar los cambios, un aumento de cuatro veces. Esto hace posible cambios a gran escala que no se intentarían si tuvieran que pasar por el pequeño grupo de desarrolladores del núcleo. Por ejemplo, un día a Peter Schneider-Kamp se le ocurrió dejar de lado la compatibilidad con K&R C y convertir el código fuente de Python a ANSI C. Después de obtener la aprobación en la lista de correo de python-dev, se lanzó a una ráfaga de revisiones que duró aproximadamente una semana, otros desarrolladores se unieron para ayudar, y el trabajo estaba hecho. Si sólo hubiera habido 5 personas con acceso de escritura, probablemente esa tarea habría sido considerada como «agradable, pero no vale la pena el tiempo y el esfuerzo necesarios» y nunca se habría realizado.

El cambio al uso de los servicios de SourceForge ha dado lugar a un notable aumento de la velocidad de desarrollo. Ahora los parches se envían, se comentan, son revisados por otras personas además del remitente original, y van de un lado a otro hasta que se considera que el parche merece ser revisado. Los errores se rastrean en una ubicación central y se pueden asignar a una persona específica para que los corrija, y podemos contar el número de errores abiertos para medir el progreso. Esto no ha tenido un coste: los desarrolladores tienen ahora más correo electrónico con el que lidiar, más listas de correo que seguir, y se han tenido que escribir herramientas especiales para el nuevo entorno. Por ejemplo, SourceForge envía por defecto mensajes de correo electrónico de notificación de parches y errores que son completamente inútiles, por lo que Ka-Ping Yee escribió un raspador de pantalla HTML que envía mensajes más útiles.

La facilidad para añadir código provocó algunos problemas iniciales de crecimiento, como el hecho de que el código se registrara antes de estar listo o sin obtener un acuerdo claro del grupo de desarrolladores. El proceso de aprobación que ha surgido es algo similar al utilizado por el grupo Apache. Los desarrolladores pueden votar +1, +0, -0 o -1 sobre un parche; +1 y -1 denotan aceptación o rechazo, mientras que +0 y -0 significan que el desarrollador es mayormente indiferente al cambio, aunque con un ligero sesgo positivo o negativo. El cambio más significativo con respecto al modelo de Apache es que la votación es esencialmente consultiva, lo que permite a Guido van Rossum, que tiene el estatus de Dictador Benevolente Vitalicio, saber cuál es la opinión general. Puede seguir ignorando el resultado de una votación y aprobar o rechazar un cambio aunque la comunidad no esté de acuerdo con él.

Producir un parche real es el último paso en la adición de una nueva característica, y suele ser fácil en comparación con la tarea anterior de llegar a un buen diseño. Las discusiones sobre nuevas funcionalidades a menudo pueden explotar en largos hilos de la lista de correo, haciendo que la discusión sea difícil de seguir, y nadie puede leer todos los mensajes en python-dev. Por lo tanto, se ha establecido un proceso relativamente formal para escribir Propuestas de Mejora de Python (PEPs), siguiendo el modelo del proceso RFC de Internet. Las PEP son borradores de documentos que describen una nueva característica propuesta, y se revisan continuamente hasta que la comunidad llega a un consenso, aceptando o rechazando la propuesta. Cita de la introducción de 
@geindex Python Enhancement Proposals; PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/}, «PEP Purpose and Guidelines»:

@quotation

PEP son las siglas de Python Enhancement Proposal. Un PEP es un documento de diseño que proporciona información a la comunidad de Python, o que describe una nueva característica para Python. El PEP debe proporcionar una especificación técnica concisa de la característica y una justificación de la misma.

Pretendemos que los PEPs sean los mecanismos principales para proponer nuevas características, para recoger las opiniones de la comunidad sobre un tema y para documentar las decisiones de diseño que se han tomado en Python. El autor del PEP es responsable de crear consenso dentro de la comunidad y de documentar las opiniones discrepantes.
@end quotation

Read the rest of 
@geindex Python Enhancement Proposals; PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/} for the details of the PEP editorial process, style, and
format.  PEPs are kept in the Python CVS tree on SourceForge, though they’re not
part of the Python 2.0 distribution, and are also available in HTML form from
@indicateurl{https://peps.python.org/}.  As of September 2000, there are 25 PEPs, ranging
from 
@geindex Python Enhancement Proposals; PEP 201
PEP 201@footnote{https://peps.python.org/pep-0201/}, «Lockstep Iteration», to PEP 225, «Elementwise/Objectwise
Operators».

@c ======================================================================

@node Unicode<2>,Comprensión de listas,Nuevo proceso de desarrollo,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 unicode}@anchor{156e}
@subsection Unicode


La mayor novedad de Python 2.0 es un nuevo tipo de datos fundamental: Las cadenas Unicode. Unicode utiliza números de 16 bits para representar los caracteres en lugar de los 8 bits utilizados por ASCII, lo que significa que se pueden admitir 65.536 caracteres distintos.

La interfaz final para el soporte de Unicode se alcanzó a través de innumerables discusiones, a menudo tormentosas, en la lista de correo de python-dev, y fue implementada en su mayor parte por Marc-André Lemburg, basándose en una implementación del tipo de cadena Unicode de Fredrik Lundh. Una explicación detallada de la interfaz fue escrita como 
@geindex Python Enhancement Proposals; PEP 100
PEP 100@footnote{https://peps.python.org/pep-0100/}, «Python Unicode Integration». Este artículo se limitará a cubrir los puntos más significativos de las interfaces Unicode.

In Python source code, Unicode strings are written as @code{u"string"}.  Arbitrary
Unicode characters can be written using a new escape sequence, @code{\u@var{HHHH}}, where
`HHHH' is a 4-digit hexadecimal number from 0000 to FFFF.  The existing
@code{\x@var{HH}} escape sequence can also be used, and octal escapes can be used for
characters up to U+01FF, which is represented by @code{\777}.

Las cadenas Unicode, al igual que las cadenas normales, son un tipo de secuencia inmutable. Pueden ser indexadas y cortadas, pero no modificadas en su lugar. Las cadenas Unicode tienen un método @code{encode( [encoding] )} que retorna una cadena de 8 bits en la codificación deseada. Las codificaciones son nombradas por cadenas, como @code{'ascii'}, @code{'utf-8'}, @code{'iso-8859-1'}, o lo que sea. Se define una API de códecs para implementar y registrar nuevas codificaciones que luego están disponibles en todo el programa Python. Si no se especifica una codificación, la codificación por defecto suele ser ASCII de 7 bits, aunque puede cambiarse para tu instalación de Python llamando a la función @code{sys.setdefaultencoding(encoding)} en una versión personalizada de @code{site.py}.

La combinación de cadenas de 8 bits y Unicode siempre fuerza conversión a Unicode, utilizando la codificación ASCII por defecto; el resultado de @code{'a' + u'bc'} es @code{u'abc'}.

Se han añadido nuevas funciones incorporadas y se han modificado las existentes para que sean compatibles con Unicode:


@itemize *

@item 
@code{unichr(ch)} retorna una cadena Unicode de 1 carácter, que contiene el carácter `ch'.

@item 
@code{ord(u)}, donde `u' es una cadena regular o Unicode de 1 carácter, retorna el número del carácter como un entero.

@item 
@code{unicode(string [, encoding] [, errors] )} crea una cadena Unicode a partir de una cadena de 8 bits. @code{encoding} es una cadena que nombra la codificación a utilizar. El parámetro @code{errors} especifica el tratamiento de los caracteres que no son válidos para la codificación actual; pasar @code{'strict} como valor hace que se lance una excepción en cualquier error de codificación, mientras que @code{'ignore} hace que los errores se ignoren silenciosamente y @code{'replace} utiliza U+FFFD, el carácter oficial de reemplazo, en caso de cualquier problema.

@item 
La sentencia @code{exec}, y varias funciones integradas como @code{eval()}, @code{getattr()}, y @code{setattr()} también aceptarán cadenas Unicode así como cadenas regulares. (Es posible que en el proceso de corrección de esto se hayan pasado por alto algunas funciones incorporadas; si encuentra una función incorporada que acepte cadenas pero que no acepte cadenas Unicode en absoluto, por favor, infórmelo como un error)
@end itemize

Un nuevo módulo, @ref{105,,unicodedata}, proporciona una interfaz para las propiedades de los caracteres Unicode. Por ejemplo, @code{unicodedata.category(u'A')} retorna la cadena de 2 caracteres “Lu”, la “L” denota que es una letra, y la “u” significa que es mayúscula. @code{unicodedata.bidirectional(u'\u0660')} retorna “AN”, lo que significa que U+0660 es un número árabe.

El módulo @ref{1c,,codecs} contiene funciones para buscar codificaciones existentes y registrar otras nuevas. A menos que quiera implementar una nueva codificación, lo más habitual es que utilice la función @code{codecs.lookup(encoding)}, que retorna una tupla de 4 elementos: @code{(encode_func, decode_func, stream_reader, stream_writer)}.


@itemize *

@item 
`encode_func' es una función que toma una cadena Unicode, y retorna una 2-tupla @code{(string, length)}. `string' es una cadena de 8 bits que contiene una porción (tal vez toda) de la cadena Unicode convertida a la codificación dada, y `longitud' indica la cantidad de cadena Unicode convertida.

@item 
`decode_func' es lo opuesto a `encode_func', tomando una cadena de 8 bits y retornando una 2-tupla @code{(ustring, length)}, que consiste en la cadena Unicode resultante `ustring' y el entero `length' que dice cuánto de la cadena de 8 bits se consumió.

@item 
`stream_reader' is a class that supports decoding input from a stream.
`stream_reader(file_obj)' returns an object that supports the @code{read()},
@code{readline()}, and @code{readlines()} methods.  These methods will all
translate from the given encoding and return Unicode strings.

@item 
`stream_writer', similarly, is a class that supports encoding output to a
stream.  `stream_writer(file_obj)' returns an object that supports the
@code{write()} and @code{writelines()} methods.  These methods expect Unicode
strings, translating them to the given encoding on output.
@end itemize

Por ejemplo, el siguiente código escribe una cadena Unicode en un archivo, codificándola como UTF-8:

@example
import codecs

unistr = u'\u0660\u2000ab ...'

(UTF8_encode, UTF8_decode,
 UTF8_streamreader, UTF8_streamwriter) = codecs.lookup('UTF-8')

output = UTF8_streamwriter( open( '/tmp/output', 'wb') )
output.write( unistr )
output.close()
@end example

El siguiente código leería la entrada UTF-8 del archivo:

@example
input = UTF8_streamreader( open( '/tmp/output', 'rb') )
print repr(input.read())
input.close()
@end example

Las expresiones regulares compatibles con Unicode están disponibles a través del módulo @ref{b9,,re}, que tiene una nueva implementación subyacente llamada SRE escrita por Fredrik Lundh de Secret Labs AB.

Se ha añadido una opción de línea de comandos @code{-U} que hace que el compilador de Python interprete todos los literales de cadena como literales de cadena Unicode. Esta opción está pensada para ser utilizada en las pruebas y para asegurar el futuro de su código Python, ya que alguna versión futura de Python puede dejar de soportar cadenas de 8 bits y proporcionar sólo cadenas Unicode.

@c ======================================================================

@node Comprensión de listas,Asignación aumentada,Unicode<2>,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 list-comprehensions}@anchor{156f}
@subsection Comprensión de listas


Las listas son un tipo de datos muy útil en Python, y muchos programas manipulan una lista en algún momento. Dos operaciones comunes en las listas son hacer un bucle sobre ellas, y escoger los elementos que cumplen un cierto criterio, o aplicar alguna función a cada elemento. Por ejemplo, dada una lista de cadenas, podrías querer sacar todas las cadenas que contengan una determinada subcadena, o quitar los espacios en blanco de cada línea.

Las funciones @ref{14c,,map()} y @ref{8fb,,filter()} existentes pueden usarse para este propósito, pero requieren una función como uno de sus argumentos. Esto está bien si hay una función incorporada que se puede pasar directamente, pero si no la hay, hay que crear una pequeña función para hacer el trabajo requerido, y las reglas de ámbito de Python hacen que el resultado sea feo si la pequeña función necesita información adicional. Tomemos el primer ejemplo del párrafo anterior, encontrar todas las cadenas de la lista que contienen una subcadena dada. Podrías escribir lo siguiente para hacerlo:

@example
# Given the list L, make a list of all strings
# containing the substring S.
sublist = filter( lambda s, substring=S:
                     string.find(s, substring) != -1,
                  L)
@end example

Debido a las reglas de ámbito de Python, se utiliza un argumento por defecto para que la función anónima creada por la expresión @ref{1309,,lambda} sepa qué subcadena se está buscando. Las comprensiones de lista hacen esto más limpio:

@example
sublist = [ s for s in L if string.find(s, S) != -1 ]
@end example

Las comprensiones de listas tienen la forma:

@example
[ expression for expr in sequence1
             for expr2 in sequence2 ...
             for exprN in sequenceN
             if condition ]
@end example

Las cláusulas @code{for}…@code{in} contienen las secuencias a iterar. Las secuencias no tienen por qué tener la misma longitud, ya que no se itera sobre ellas en paralelo, sino de izquierda a derecha; esto se explica más claramente en los párrafos siguientes. Los elementos de la lista generada serán los valores sucesivos de la `expresión'. La cláusula final @code{if} es opcional; si está presente, la `expresión' sólo se evalúa y se añade al resultado si la `condición' es verdadera.

Para dejar muy clara la semántica, una comprensión de lista equivale al siguiente código de Python:

@example
for expr1 in sequence1:
    for expr2 in sequence2:
    ...
        for exprN in sequenceN:
             if (condition):
                  # Append the value of
                  # the expression to the
                  # resulting list.
@end example

Esto significa que cuando hay múltiples cláusulas @code{for}…@code{in}, la lista resultante será igual al producto de las longitudes de todas las secuencias. Si tiene dos listas de longitud 3, la lista de salida tendrá 9 elementos:

@example
seq1 = 'abc'
seq2 = (1,2,3)
>>> [ (x,y) for x in seq1 for y in seq2]
[('a', 1), ('a', 2), ('a', 3), ('b', 1), ('b', 2), ('b', 3), ('c', 1),
('c', 2), ('c', 3)]
@end example

Para evitar introducir una ambigüedad en la gramática de Python, si `expresión' está creando una tupla, debe estar rodeada de paréntesis. La primera comprensión de la lista a continuación es un error de sintaxis, mientras que la segunda es correcta:

@example
# Syntax error
[ x,y for x in seq1 for y in seq2]
# Correct
[ (x,y) for x in seq1 for y in seq2]
@end example

La idea de las comprensiones de listas procede originalmente del lenguaje de programación funcional Haskell (@indicateurl{https://www.haskell.org}). Greg Ewing fue el que más abogó por añadirlas a Python y escribió el parche inicial de comprensión de listas, que luego se discutió durante un tiempo aparentemente interminable en la lista de correo de python-dev y se mantuvo actualizada por Skip Montanaro.

@c ======================================================================

@node Asignación aumentada,Métodos de cadena de caracteres,Comprensión de listas,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 augmented-assignment}@anchor{1570}
@subsection Asignación aumentada


Los operadores de asignación aumentados, otra característica largamente solicitada, han sido añadidos a Python 2.0. Los operadores de asignación aumentados incluyen @code{+=}, @code{-=}, @code{*=}, etc. Por ejemplo, la sentencia @code{a += 2} incrementa el valor de la variable @code{a} en 2, lo que equivale a la sentencia algo más larga @code{a = a + 2}.

The full list of supported assignment operators is @code{+=}, @code{-=}, @code{*=},
@code{/=}, @code{%=}, @code{**=}, @code{&=}, @code{|=}, @code{^=}, @code{>>=}, and @code{<<=}.  Python
classes can override the augmented assignment operators by defining methods
named @code{__iadd__()}, @code{__isub__()}, etc.  For example, the following
@code{Number} class stores a number and supports using += to create a new
instance with an incremented value.

@c The empty groups below prevent conversion to guillemets.

@example
class Number:
    def __init__(self, value):
        self.value = value
    def __iadd__(self, increment):
        return Number( self.value + increment)

n = Number(5)
n += 3
print n.value
@end example

The @code{__iadd__()} special method is called with the value of the increment,
and should return a new instance with an appropriately modified value; this
return value is bound as the new value of the variable on the left-hand side.

Los operadores de asignación aumentada se introdujeron por primera vez en el lenguaje de programación C, y la mayoría de los lenguajes derivados de C, como @code{awk}, C++, Java, Perl y PHP también los soportan. El parche de asignación aumentada fue implementado por Thomas Wouters.

@c ======================================================================

@node Métodos de cadena de caracteres,Recogida de basura de los ciclos,Asignación aumentada,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 string-methods}@anchor{1571}
@subsection Métodos de cadena de caracteres


Until now string-manipulation functionality was in the @ref{d3,,string} module,
which was usually a front-end for the @code{strop} module written in C.  The
addition of Unicode posed a difficulty for the @code{strop} module, because the
functions would all need to be rewritten in order to accept either 8-bit or
Unicode strings.  For functions such as @code{string.replace()}, which takes 3
string arguments, that means eight possible permutations, and correspondingly
complicated code.

En cambio, Python 2.0 traslada el problema al tipo de cadena de caracteres, haciendo que la funcionalidad de manipulación de cadenas esté disponible a través de métodos tanto en cadenas de 8 bits como en cadenas Unicode.

@example
>>> 'andrew'.capitalize()
'Andrew'
>>> 'hostname'.replace('os', 'linux')
'hlinuxtname'
>>> 'moshe'.find('sh')
2
@end example

Una cosa que no ha cambiado, a pesar de una notable broma de April Fools, es que las cadenas de Python son inmutables. Así, los métodos de cadenas retornan cadenas nuevas, y no modifican la cadena sobre la que operan.

El antiguo módulo @ref{d3,,string} sigue existiendo por compatibilidad con el pasado, pero actúa principalmente como un front-end para los nuevos métodos de cadena de caracteres.

Two methods which have no parallel in pre-2.0 versions, although they did exist
in JPython for quite some time, are @code{startswith()} and @code{endswith()}.
@code{s.startswith(t)} is equivalent to @code{s[:len(t)] == t}, while
@code{s.endswith(t)} is equivalent to @code{s[-len(t):] == t}.

One other method which deserves special mention is @code{join()}.  The
@code{join()} method of a string receives one parameter, a sequence of strings,
and is equivalent to the @code{string.join()} function from the old @ref{d3,,string}
module, with the arguments reversed. In other words, @code{s.join(seq)} is
equivalent to the old @code{string.join(seq, s)}.

@c ======================================================================

@node Recogida de basura de los ciclos,Otros cambios en el núcleo,Métodos de cadena de caracteres,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 garbage-collection-of-cycles}@anchor{1572}
@subsection Recogida de basura de los ciclos


La implementación en C de Python utiliza el conteo de referencias para implementar la recolección de basura. Cada objeto de Python mantiene un recuento del número de referencias que apuntan a sí mismo, y ajusta el recuento a medida que se crean o destruyen referencias. Una vez que el recuento de referencias llega a cero, el objeto deja de ser accesible, ya que es necesario tener una referencia a un objeto para acceder a él, y si el recuento es cero, ya no existen referencias.

El conteo de referencias tiene algunas propiedades agradables: es fácil de entender e implementar, y la implementación resultante es portable, bastante rápida, y reacciona bien con otras bibliotecas que implementan sus propios esquemas de manejo de memoria. El mayor problema del conteo de referencias es que a veces no se da cuenta de que los objetos ya no son accesibles, lo que provoca una fuga de memoria. Esto ocurre cuando hay ciclos de referencias.

Consideremos el ciclo más simple posible, una instancia de clase que tiene una referencia a sí misma:

@example
instance = SomeClass()
instance.myself = instance
@end example

Después de ejecutar las dos líneas de código anteriores, la cuenta de referencias de @code{instance} es 2; una referencia es de la variable llamada @code{'instance}, y la otra es del atributo @code{myself} de la instancia.

Si la siguiente línea de código es @code{del instance}, ¿qué ocurre?  La cuenta de referencias de @code{instance} se reduce en 1, por lo que tiene una cuenta de referencias de 1; la referencia en el atributo @code{myself} sigue existiendo. Sin embargo, la instancia ya no es accesible a través del código de Python, y podría ser eliminada. Varios objetos pueden participar en un ciclo si tienen referencias entre sí, haciendo que todos los objetos se filtren.

Python 2.0 soluciona este problema ejecutando periódicamente un algoritmo de detección de ciclos que busca los ciclos inaccesibles y borra los objetos implicados. Un nuevo módulo @ref{60,,gc} proporciona funciones para realizar una recolección de basura, obtener estadísticas de depuración y afinar los parámetros del recolector.

Ejecutar el algoritmo de detección de ciclos lleva algo de tiempo, y por lo tanto resultará en una sobrecarga adicional. Se espera que después de que hayamos adquirido experiencia con la recogida de ciclos al utilizar la versión 2.0, Python 2.1 sea capaz de minimizar la sobrecarga con un cuidadoso ajuste. Todavía no es obvio cuánto rendimiento se pierde, porque la evaluación comparativa de esto es difícil y depende crucialmente de la frecuencia con la que el programa crea y destruye objetos. La detección de ciclos puede ser desactivada cuando Python es compilado, si no puede permitirse ni siquiera una pequeña penalización de velocidad o sospecha que la recolección de ciclos es un error, especificando la opción @code{--without-cycle-gc} cuando se ejecuta el script @code{configure}.

Varias personas abordaron este problema y contribuyeron a una solución. Una primera implementación del enfoque de detección de ciclos fue escrita por Toby Kelsey. El algoritmo actual fue sugerido por Eric Tiedemann durante una visita al CNRI, y Guido van Rossum y Neil Schemenauer escribieron dos implementaciones diferentes, que posteriormente fueron integradas por Neil. Muchas otras personas ofrecieron sugerencias a lo largo del camino; los archivos de marzo de 2000 de la lista de correo python-dev contienen la mayor parte de la discusión relevante, especialmente en los hilos titulados «Colección de ciclos de referencia para Python» y «Finalización de nuevo».

@c ======================================================================

@node Otros cambios en el núcleo,Adaptación a la versión 2 0,Recogida de basura de los ciclos,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 other-core-changes}@anchor{1573}
@subsection Otros cambios en el núcleo


Se han realizado varios cambios menores en la sintaxis y las funciones incorporadas de Python. Ninguno de los cambios es de gran alcance, pero son conveniencias prácticas.

@menu
* Cambios menores del lenguaje:: 
* Cambios en las funciones incorporadas:: 

@end menu

@node Cambios menores del lenguaje,Cambios en las funciones incorporadas,,Otros cambios en el núcleo
@anchor{whatsnew/2 0 minor-language-changes}@anchor{1574}
@subsubsection Cambios menores del lenguaje


A new syntax makes it more convenient to call a given function with a tuple of
arguments and/or a dictionary of keyword arguments. In Python 1.5 and earlier,
you’d use the @code{apply()} built-in function: @code{apply(f, args, kw)} calls the
function @code{f()} with the argument tuple `args' and the keyword arguments in
the dictionary `kw'.  @code{apply()}  is the same in 2.0, but thanks to a patch
from Greg Ewing, @code{f(*args, **kw)} is a shorter and clearer way to achieve the
same effect.  This syntax is symmetrical with the syntax for defining
functions:

@example
def f(*args, **kw):
    # args is a tuple of positional args,
    # kw is a dictionary of keyword args
    ...
@end example

The @code{print} statement can now have its output directed to a file-like
object by following the @code{print} with  @code{>> file}, similar to the
redirection operator in Unix shells. Previously you’d either have to use the
@code{write()} method of the file-like object, which lacks the convenience and
simplicity of @code{print}, or you could assign a new value to
@code{sys.stdout} and then restore the old value.  For sending output to standard
error, it’s much easier to write this:

@example
print >> sys.stderr, "Warning: action field not supplied"
@end example

Ahora se puede cambiar el nombre de los módulos al importarlos, utilizando la sintaxis @code{import module as name} o @code{from module import name as othername}. El parche fue enviado por Thomas Wouters.

Un nuevo estilo de formato está disponible cuando se utiliza el operador @code{%}; “%r” insertará el @ref{894,,repr()} de su argumento. Esto también se añadió por consideraciones de simetría, esta vez por simetría con el estilo de formato existente “%s”, que inserta el @ref{237,,str()} de su argumento. Por ejemplo, @code{'%r %s' % ('abc', 'abc')} retorna una cadena que contiene @code{'abc' abc}.

Previously there was no way to implement a class that overrode Python’s built-in
@ref{1ed,,in} operator and implemented a custom version.  @code{obj in seq} returns
true if `obj' is present in the sequence `seq'; Python computes this by simply
trying every index of the sequence until either `obj' is found or an
@ref{1575,,IndexError} is encountered.  Moshe Zadka contributed a patch which adds a
@code{__contains__()} magic method for providing a custom implementation for
@code{in}. Additionally, new built-in objects written in C can define what
@code{in} means for them via a new slot in the sequence protocol.

Las versiones anteriores de Python utilizaban un algoritmo recursivo para borrar objetos. Las estructuras de datos muy anidadas podían hacer que el intérprete llenara la pila de C y se bloqueara; Christian Tismer reescribió la lógica de borrado para solucionar este problema. En una nota relacionada, la comparación de objetos recursivos se repite infinitamente y se bloquea; Jeremy Hylton reescribió el código para que no se bloquee, produciendo un resultado útil. Por ejemplo, después de este código:

@example
a = []
b = []
a.append(a)
b.append(b)
@end example

The comparison @code{a==b} returns true, because the two recursive data structures
are isomorphic. See the thread «trashcan and PR#7» in the April 2000 archives of
the python-dev mailing list for the discussion leading up to this
implementation, and some useful relevant links.    Note that comparisons can now
also raise exceptions. In earlier versions of Python, a comparison operation
such as @code{cmp(a,b)} would always produce an answer, even if a user-defined
@code{__cmp__()} method encountered an error, since the resulting exception would
simply be silently swallowed.

@c Starting URL:

@c https://www.python.org/pipermail/python-dev/2000-April/004834.html

Se ha trabajado en la migración de Python a Windows de 64 bits en el procesador Itanium, principalmente por Trent Mick de ActiveState. (Confusamente, @code{sys.platform} sigue siendo @code{'win32'} en Win64 porque parece que, para facilitar la migración, MS Visual C++ trata el código como de 32 bits en Itanium). PythonWin también es compatible con Windows CE; consulte la página de Python CE en @indicateurl{https://pythonce.sourceforge.net/} para obtener más información.

Otra plataforma nueva es Darwin/MacOS X; el soporte inicial para ella está en Python 2.0. La carga dinámica funciona, si se especifica «configure –with-dyld –with-suffix=.x». Consulte el README de la distribución de fuentes de Python para obtener más instrucciones.

Se ha intentado aliviar uno de los defectos de Python, la a menudo confusa excepción @ref{4ec,,NameError} cuando el código hace referencia a una variable local antes de que se le haya asignado un valor. Por ejemplo, el siguiente código lanza una excepción en la sentencia @code{print} tanto en 1.5.2 como en 2.0; en 1.5.2 se lanza una excepción @ref{4ec,,NameError}, mientras que en 2.0 se lanza una nueva excepción @ref{1576,,UnboundLocalError}. @ref{1576,,UnboundLocalError} es una subclase de @ref{4ec,,NameError}, así que cualquier código existente que espere que se lance @ref{4ec,,NameError} debería seguir funcionando.

@example
def f():
    print "i=",i
    i = i + 1
f()
@end example

Se han introducido dos nuevas excepciones, @ref{5e6,,TabError} y @ref{841,,IndentationError}. Ambas son subclases de @ref{150,,SyntaxError}, y se lanzan cuando el código Python se encuentra con una sangría incorrecta.

@node Cambios en las funciones incorporadas,,Cambios menores del lenguaje,Otros cambios en el núcleo
@anchor{whatsnew/2 0 changes-to-built-in-functions}@anchor{1577}
@subsubsection Cambios en las funciones incorporadas


Se ha añadido un nuevo built-in, @code{zip(seq1, seq2, ...)}. @ref{14d,,zip()} retorna una lista de tuplas donde cada tupla contiene el i-ésimo elemento de cada una de las secuencias del argumento. La diferencia entre @ref{14d,,zip()} y @code{map(None, seq1, seq2)} es que @ref{14c,,map()} rellena las secuencias con @code{None} si las secuencias no tienen la misma longitud, mientras que @ref{14d,,zip()} trunca la lista retornada a la longitud de la secuencia argumental más corta.

The @ref{1f0,,int()} and @code{long()} functions now accept an optional «base»
parameter when the first argument is a string. @code{int('123', 10)} returns 123,
while @code{int('123', 16)} returns 291.  @code{int(123, 16)} raises a
@ref{228,,TypeError} exception with the message «can’t convert non-string with
explicit base».

Se ha añadido al módulo @ref{d9,,sys} una nueva variable que contiene información más detallada sobre la versión. @code{sys.version_info} es una tupla @code{(major, minor, micro, level, serial)} Por ejemplo, en una hipotética 2.0.1beta1, @code{sys.version_info} sería @code{(2, 0, 1, 'beta', 1)}. `level' es una cadena como @code{"alpha"}, @code{"beta"}, o @code{"final"} para una versión final.

Dictionaries have an odd new method, @code{setdefault(key, default)}, which
behaves similarly to the existing @code{get()} method.  However, if the key is
missing, @code{setdefault()} both returns the value of `default' as @code{get()}
would do, and also inserts it into the dictionary as the value for `key'.  Thus,
the following lines of code:

@example
if dict.has_key( key ): return dict[key]
else:
    dict[key] = []
    return dict[key]
@end example

puede reducirse a una única sentencia @code{return dict.setdefault(key, [])}.

El intérprete establece una profundidad de recursión máxima para atrapar la recursión desbocada antes de llenar la pila de C y causar un volcado del núcleo o GPF. Anteriormente este límite se fijaba cuando se compilaba Python, pero en la versión 2.0 la profundidad máxima de recursión puede leerse y modificarse usando @ref{56b,,sys.getrecursionlimit()} y @ref{56a,,sys.setrecursionlimit()}. El valor por defecto es 1000, y se puede encontrar un valor máximo aproximado para una plataforma determinada ejecutando un nuevo script, @code{Misc/find_recursionlimit.py}.

@c ======================================================================

@node Adaptación a la versión 2 0,Extensión/Incorporación de cambios,Otros cambios en el núcleo,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 porting-to-2-0}@anchor{1578}
@subsection Adaptación a la versión 2.0


Las nuevas versiones de Python se esfuerzan por ser compatibles con las anteriores, y el historial ha sido bastante bueno. Sin embargo, algunos cambios se consideran lo suficientemente útiles, normalmente porque corrigen decisiones de diseño iniciales que resultaron ser activamente erróneas, que no siempre se puede evitar romper la compatibilidad hacia atrás. Esta sección enumera los cambios en Python 2.0 que pueden hacer que el código Python antiguo se rompa.

The change which will probably break the most code is tightening up the
arguments accepted by some methods.  Some methods would take multiple arguments
and treat them as a tuple, particularly various list methods such as
@code{append()} and @code{insert()}. In earlier versions of Python, if @code{L} is
a list, @code{L.append( 1,2 )} appends the tuple @code{(1,2)} to the list.  In Python
2.0 this causes a @ref{228,,TypeError} exception to be raised, with the message:
“append requires exactly 1 argument; 2 given”.  The fix is to simply add an
extra set of parentheses to pass both values as a tuple:  @code{L.append( (1,2) )}.

The earlier versions of these methods were more forgiving because they used an
old function in Python’s C interface to parse their arguments; 2.0 modernizes
them to use @ref{615,,PyArg_ParseTuple()}, the current argument parsing function,
which provides more helpful error messages and treats multi-argument calls as
errors.  If you absolutely must use 2.0 but can’t fix your code, you can edit
@code{Objects/listobject.c} and define the preprocessor symbol
@code{NO_STRICT_LIST_APPEND} to preserve the old behaviour; this isn’t recommended.

Some of the functions in the @ref{cc,,socket} module are still forgiving in this
way.  For example, @code{socket.connect( ('hostname', 25) )} is the correct
form, passing a tuple representing an IP address, but @code{socket.connect('hostname', 25)}
also works. @ref{1579,,socket.connect_ex} and @ref{157a,,socket.bind}
are similarly easy-going.  2.0alpha1 tightened these functions up, but because
the documentation actually used the erroneous multiple argument form, many
people wrote code which would break with the stricter checking.  GvR backed out
the changes in the face of public reaction, so for the @ref{cc,,socket} module, the
documentation was fixed and the multiple argument form is simply marked as
deprecated; it `will' be tightened up again in a future Python version.

El escape @code{\x} en los literales de cadena ahora toma exactamente 2 dígitos hexadecimales. Antes consumía todos los dígitos hexadecimales que seguían a la “x” y tomaba los 8 bits más bajos del resultado, por lo que @code{\x123456} era equivalente a @code{\x56}.

Las excepciones @ref{441,,AttributeError} y @ref{4ec,,NameError} tienen un mensaje de error más amigable, cuyo texto será algo así como @code{'Spam' instance has no attribute 'eggs'} o @code{name 'eggs' is not defined}. Anteriormente, el mensaje de error era simplemente la falta del nombre del atributo @code{eggs}, y el código escrito para aprovechar este hecho se romperá en la versión 2.0.

Some work has been done to make integers and long integers a bit more
interchangeable.  In 1.5.2, large-file support was added for Solaris, to allow
reading files larger than 2 GiB; this made the @code{tell()} method of file
objects return a long integer instead of a regular integer.  Some code would
subtract two file offsets and attempt to use the result to multiply a sequence
or slice a string, but this raised a @ref{228,,TypeError}.  In 2.0, long integers
can be used to multiply or slice a sequence, and it’ll behave as you’d
intuitively expect it to; @code{3L * 'abc'} produces “abcabcabc”, and
@code{(0,1,2,3)[2L:4L]} produces (2,3). Long integers can also be used in various
contexts where previously only integers were accepted, such as in the
@code{seek()} method of file objects, and in the formats supported by the @code{%}
operator (@code{%d}, @code{%i}, @code{%x}, etc.).  For example, @code{"%d" % 2L**64} will
produce the string @code{18446744073709551616}.

El cambio más sutil de los enteros largos es que el @ref{237,,str()} de un entero largo ya no tiene un carácter “L” al final, aunque @ref{894,,repr()} todavía lo incluye. La “L” molestaba a muchas personas que querían imprimir enteros largos con el mismo aspecto que los enteros normales, ya que tenían que esforzarse por cortar el carácter. Esto ya no es un problema en 2.0, pero el código que hace @code{str(longval)[:-1]} y asume que la “L” está ahí, ahora perderá el dígito final.

Taking the @ref{894,,repr()} of a float now uses a different formatting precision
than @ref{237,,str()}.  @ref{894,,repr()} uses @code{%.17g} format string for C’s
@code{sprintf()}, while @ref{237,,str()} uses @code{%.12g} as before.  The effect is that
@ref{894,,repr()} may occasionally show more decimal places than  @ref{237,,str()}, for
certain numbers.  For example, the number 8.1 can’t be represented exactly in
binary, so @code{repr(8.1)} is @code{'8.0999999999999996'}, while str(8.1) is
@code{'8.1'}.

The @code{-X} command-line option, which turned all standard exceptions into
strings instead of classes, has been removed; the standard exceptions will now
always be classes.  The @code{exceptions} module containing the standard
exceptions was translated from Python to a built-in C module, written by Barry
Warsaw and Fredrik Lundh.

@c Commented out for now -- I don't think anyone will care.
@c The pattern and match objects provided by SRE are C types, not Python
@c class instances as in 1.5.  This means you can no longer inherit from
@c \class{RegexObject} or \class{MatchObject}, but that shouldn't be much
@c of a problem since no one should have been doing that in the first
@c place.

@c ======================================================================

@node Extensión/Incorporación de cambios,Distutils Facilitando la instalación de módulos,Adaptación a la versión 2 0,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 extending-embedding-changes}@anchor{157b}
@subsection Extensión/Incorporación de cambios


Algunos de los cambios están bajo la cubierta, y sólo serán evidentes para la gente que escribe módulos de extensión de C o que incrusta un intérprete de Python en una aplicación más grande. Si no estás tratando con la API de C de Python, puedes saltarte esta sección.

El número de versión de la API C de Python se incrementó, por lo que las extensiones C compiladas para 1.5.2 deben ser recompiladas para que funcionen con 2.0. En Windows, no es posible que Python 2.0 importe una extensión de terceros construida para Python 1.5.x debido a cómo funcionan las DLL de Windows, por lo que Python lanzará una excepción y la importación fallará.

Los usuarios del módulo ExtensionClass de Jim Fulton estarán encantados de saber que se han añadido ganchos para que las ExtensionClasses sean ahora compatibles con @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}. Esto significa que ya no tiene que recordar escribir código como @code{if type(obj) == myExtensionClass}, sino que puede utilizar el más natural @code{if isinstance(obj, myExtensionClass)}.

El archivo @code{Python/importdl.c}, que era una masa de #ifdefs para soportar la carga dinámica en muchas plataformas diferentes, fue limpiado y reorganizado por Greg Stein. @code{importdl.c} es ahora bastante pequeño, y el código específico de la plataforma se ha movido a un montón de archivos @code{Python/dynload_*.c}. Otra limpieza: también había una serie de archivos @code{my*.h} en el directorio Include/ que contenían varios hacks de portabilidad; se han fusionado en un único archivo, @code{Include/pyport.h}.

Vladimir Marangozov’s long-awaited malloc restructuring was completed, to make
it easy to have the Python interpreter use a custom allocator instead of C’s
standard @code{malloc()}.  For documentation, read the comments in
@code{Include/pymem.h} and @code{Include/objimpl.h}.  For the lengthy
discussions during which the interface was hammered out, see the web archives of
the “patches” and “python-dev” lists at python.org.

Las versiones recientes del entorno de desarrollo GUSI para MacOS soportan hilos POSIX. Por lo tanto, el soporte de hilos POSIX de Python ahora funciona en Macintosh. También se ha contribuido al soporte de hilos utilizando la biblioteca GNU @code{pth} del espacio de usuario.

También se ha mejorado el soporte de hilos en Windows. Windows soporta bloqueos de hilos que utilizan objetos del núcleo sólo en caso de contención; en el caso común cuando no hay contención, utilizan funciones más simples que son un orden de magnitud más rápido. Una versión con hilos de Python 1.5.2 en NT es dos veces más lenta que una versión sin hilos; con los cambios de la 2.0, la diferencia es sólo del 10%. Estas mejoras fueron aportadas por Yakov Markovitch.

El código fuente de Python 2.0 ahora sólo utiliza prototipos ANSI C, por lo que la compilación de Python ahora requiere un compilador ANSI C, y ya no puede hacerse utilizando un compilador que sólo soporte K&R C.

Anteriormente, la máquina virtual de Python utilizaba números de 16 bits en su bytecode, lo que limitaba el tamaño de los archivos fuente. En particular, esto afectaba al tamaño máximo de las listas literales y los diccionarios en el código fuente de Python; ocasionalmente, las personas que generan código Python se encontraban con este límite. Un parche de Charles G. Waldman eleva el límite de @code{2^16} a @code{2^@{32@}}.

Three new convenience functions intended for adding constants to a module’s
dictionary at module initialization time were added: @ref{45a,,PyModule_AddObject()},
@ref{157c,,PyModule_AddIntConstant()}, and @ref{157d,,PyModule_AddStringConstant()}.  Each
of these functions takes a module object, a null-terminated C string containing
the name to be added, and a third argument for the value to be assigned to the
name.  This third argument is, respectively, a Python object, a C long, or a C
string.

A wrapper API was added for Unix-style signal handlers. @ref{157e,,PyOS_getsig()} gets
a signal handler and @ref{157f,,PyOS_setsig()} will set a new handler.

@c ======================================================================

@node Distutils Facilitando la instalación de módulos,Módulos XML,Extensión/Incorporación de cambios,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 distutils-making-modules-easy-to-install}@anchor{1580}
@subsection Distutils: Facilitando la instalación de módulos


Antes de Python 2.0, la instalación de módulos era un asunto tedioso – no había forma de averiguar automáticamente dónde se instalaba Python, o qué opciones del compilador se debían usar para los módulos de extensión. Los autores de software tenían que pasar por un arduo ritual de edición de Makefiles y archivos de configuración, que sólo funcionaban realmente en Unix y dejaban sin soporte a Windows y MacOS. Los usuarios de Python se enfrentaban a instrucciones de instalación muy diferentes que variaban entre los distintos paquetes de extensión, lo que hacía que la administración de una instalación de Python fuera una tarea ardua.

The SIG for distribution utilities, shepherded by Greg Ward, has created the
Distutils, a system to make package installation much easier.  They form the
@code{distutils} package, a new part of Python’s standard library. In the best
case, installing a Python module from source will require the same steps: first
you simply mean unpack the tarball or zip archive, and the run «@code{python
setup.py install}».  The platform will be automatically detected, the compiler
will be recognized, C extension modules will be compiled, and the distribution
installed into the proper directory.  Optional command-line arguments provide
more control over the installation process, the distutils package offers many
places to override defaults – separating the build from the install, building
or installing in non-default directories, and more.

Para usar las Distutils, necesitas escribir un script @code{setup.py}. Para el caso simple, cuando el software contiene sólo archivos .py, un @code{setup.py} mínimo puede tener sólo unas pocas líneas:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       py_modules = ["module1", "module2"])
@end example

El archivo @code{setup.py} no es mucho más complicado si el software consta de unos pocos paquetes:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       packages = ["package", "package.subpackage"])
@end example

Una extensión en C puede ser el caso más complicado; he aquí un ejemplo tomado del paquete PyXML:

@example
from distutils.core import setup, Extension

expat_extension = Extension('xml.parsers.pyexpat',
     define_macros = [('XML_NS', None)],
     include_dirs = [ 'extensions/expat/xmltok',
                      'extensions/expat/xmlparse' ],
     sources = [ 'extensions/pyexpat.c',
                 'extensions/expat/xmltok/xmltok.c',
                 'extensions/expat/xmltok/xmlrole.c', ]
       )
setup (name = "PyXML", version = "0.5.4",
       ext_modules =[ expat_extension ] )
@end example

Las Distutils también pueden encargarse de crear distribuciones fuente y binarias. El comando «sdist», ejecutado por «@code{python setup.py sdist}, construye una distribución fuente como @code{foo-1.0.tar.gz}. Añadir nuevos comandos no es difícil, ya se han aportado los comandos «bdist_rpm» y «bdist_wininst» para crear una distribución RPM y un instalador de Windows para el software, respectivamente. Los comandos para crear otros formatos de distribución, como los paquetes de Debian y los archivos @code{.pkg} de Solaris, se encuentran en diversas etapas de desarrollo.

Todo esto está documentado en un nuevo manual, `Distribución de módulos de Python', que se une al conjunto básico de documentación de Python.

@c ======================================================================

@node Módulos XML,Cambios en los módulos,Distutils Facilitando la instalación de módulos,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 xml-modules}@anchor{1581}
@subsection Módulos XML


Python 1.5.2 included a simple XML parser in the form of the @code{xmllib}
module, contributed by Sjoerd Mullender.  Since 1.5.2’s release, two different
interfaces for processing XML have become common: SAX2 (version 2 of the Simple
API for XML) provides an event-driven interface with some similarities to
@code{xmllib}, and the DOM (Document Object Model) provides a tree-based
interface, transforming an XML document into a tree of nodes that can be
traversed and modified.  Python 2.0 includes a SAX2 interface and a stripped-down
DOM interface as part of the @ref{120,,xml} package. Here we will give a brief
overview of these new interfaces; consult the Python documentation or the source
code for complete details. The Python XML SIG is also working on improved
documentation.

@menu
* Soporte de SAX2:: 
* Soporte DOM:: 
* Relación con PyXML:: 

@end menu

@node Soporte de SAX2,Soporte DOM,,Módulos XML
@anchor{whatsnew/2 0 sax2-support}@anchor{1582}
@subsubsection Soporte de SAX2


SAX defines an event-driven interface for parsing XML.  To use SAX, you must
write a SAX handler class.  Handler classes inherit from various classes
provided by SAX, and override various methods that will then be called by the
XML parser.  For example, the @ref{1583,,startElement()} and @ref{1584,,endElement()}
methods are called for every starting and end tag encountered by the parser, the
@ref{1585,,characters()} method is called for every chunk of character data, and so
forth.

La ventaja del enfoque basado en eventos es que todo el documento no tiene que residir en la memoria en un momento dado, lo cual es importante si estás procesando documentos realmente enormes. Sin embargo, escribir la clase manejadora de SAX puede ser muy complicado si se intenta modificar la estructura del documento de alguna manera elaborada.

Por ejemplo, este pequeño programa de ejemplo define un manejador que imprime un mensaje para cada etiqueta inicial y final, y luego analiza el archivo @code{hamlet.xml} usándolo:

@example
from xml import sax

class SimpleHandler(sax.ContentHandler):
    def startElement(self, name, attrs):
        print 'Start of element:', name, attrs.keys()

    def endElement(self, name):
        print 'End of element:', name

# Create a parser object
parser = sax.make_parser()

# Tell it what handler to use
handler = SimpleHandler()
parser.setContentHandler( handler )

# Parse a file!
parser.parse( 'hamlet.xml' )
@end example

For more information, consult the Python documentation, or the XML HOWTO at
@indicateurl{https://pyxml.sourceforge.net/topics/howto/xml-howto.html}.

@node Soporte DOM,Relación con PyXML,Soporte de SAX2,Módulos XML
@anchor{whatsnew/2 0 dom-support}@anchor{1586}
@subsubsection Soporte DOM


The Document Object Model is a tree-based representation for an XML document.  A
top-level @code{Document} instance is the root of the tree, and has a single
child which is the top-level @code{Element} instance. This @code{Element}
has children nodes representing character data and any sub-elements, which may
have further children of their own, and so forth.  Using the DOM you can
traverse the resulting tree any way you like, access element and attribute
values, insert and delete nodes, and convert the tree back into XML.

El DOM es útil para modificar documentos XML, porque se puede crear un árbol DOM, modificarlo añadiendo nuevos nodos o reordenando subárboles, y luego producir un nuevo documento XML como salida. También se puede construir un árbol DOM manualmente y convertirlo en XML, lo que puede ser una forma más flexible de producir una salida XML que simplemente escribir @code{<tag1>}…@code{</tag1>} un archivo.

The DOM implementation included with Python lives in the @ref{122,,xml.dom.minidom}
module.  It’s a lightweight implementation of the Level 1 DOM with support for
XML namespaces.  The  @code{parse()} and @code{parseString()} convenience
functions are provided for generating a DOM tree:

@example
from xml.dom import minidom
doc = minidom.parse('hamlet.xml')
@end example

@code{doc} is a @code{Document} instance.  @code{Document}, like all the other
DOM classes such as @code{Element} and @code{Text}, is a subclass of the
@code{Node} base class.  All the nodes in a DOM tree therefore support certain
common methods, such as @code{toxml()} which returns a string containing the XML
representation of the node and its children.  Each class also has special
methods of its own; for example, @code{Element} and @code{Document}
instances have a method to find all child elements with a given tag name.
Continuing from the previous 2-line example:

@example
perslist = doc.getElementsByTagName( 'PERSONA' )
print perslist[0].toxml()
print perslist[1].toxml()
@end example

Para el archivo XML `Hamlet', las líneas anteriores dan como resultado:

@example
<PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
<PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>
@end example

El elemento raíz del documento está disponible como @code{doc.documentElement}, y sus hijos pueden modificarse fácilmente borrando, añadiendo o eliminando nodos:

@example
root = doc.documentElement

# Remove the first child
root.removeChild( root.childNodes[0] )

# Move the new first child to the end
root.appendChild( root.childNodes[0] )

# Insert the new first child (originally,
# the third child) before the 20th child.
root.insertBefore( root.childNodes[0], root.childNodes[20] )
@end example

Again, I will refer you to the Python documentation for a complete listing of
the different @code{Node} classes and their various methods.

@node Relación con PyXML,,Soporte DOM,Módulos XML
@anchor{whatsnew/2 0 relationship-to-pyxml}@anchor{1587}
@subsubsection Relación con PyXML


El Grupo de Interés Especial XML lleva un tiempo trabajando en código Python relacionado con XML. Su distribución de código, llamada PyXML, está disponible en las páginas web del SIG en @indicateurl{https://www.python.org/community/sigs/current/xml-sig}. La distribución de PyXML también utiliza el nombre de paquete @code{xml}. Si has escrito programas que utilizan PyXML, probablemente te preguntes sobre su compatibilidad con el paquete 2.0 @ref{120,,xml}.

La respuesta es que el paquete @ref{120,,xml} de Python 2.0 no es compatible con PyXML, pero puede hacerse compatible instalando una versión reciente de PyXML. Muchas aplicaciones pueden arreglárselas con el soporte XML que se incluye en Python 2.0, pero las aplicaciones más complicadas requerirán que se instale el paquete PyXML completo. Cuando se instala, las versiones 0.6.0 o superiores de PyXML sustituyen al paquete @ref{120,,xml} que se entrega con Python, y son un estricto superconjunto del paquete estándar, añadiendo un montón de características adicionales. Algunas de las características adicionales de PyXML incluyen:


@itemize *

@item 
4DOM, una implementación completa de DOM de FourThought, Inc.

@item 
El parser de validación xmlproc, escrito por Lars Marius Garshol.

@item 
The @code{sgmlop} parser accelerator module, written by Fredrik Lundh.
@end itemize

@c ======================================================================

@node Cambios en los módulos,Nuevos módulos<9>,Módulos XML,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 module-changes}@anchor{1588}
@subsection Cambios en los módulos


Lots of improvements and bugfixes were made to Python’s extensive standard
library; some of the affected modules include @ref{ba,,readline},
@ref{23,,ConfigParser}, @code{cgi}, @ref{15,,calendar}, @ref{ad,,posix}, @ref{ba,,readline},
@code{xmllib}, @code{aifc}, @code{chunk}, @ref{113,,wave}, @ref{b8,,random}, @ref{c3,,shelve},
and @code{nntplib}.  Consult the CVS logs for the exact patch-by-patch details.

Brian Gallew contributed OpenSSL support for the @ref{cc,,socket} module.  OpenSSL
is an implementation of the Secure Socket Layer, which encrypts the data being
sent over a socket.  When compiling Python, you can edit @code{Modules/Setup}
to include SSL support, which adds an additional function to the @ref{cc,,socket}
module: @code{socket.ssl(socket, keyfile, certfile)}, which takes a socket
object and returns an SSL socket.  The @ref{6e,,httplib} and @ref{108,,urllib} modules
were also changed to support @code{https://} URLs, though no one has implemented
FTP or SMTP over SSL.

The @ref{6e,,httplib} module has been rewritten by Greg Stein to support HTTP/1.1.

Backward compatibility with the 1.5 version of @code{httplib} is provided,
though using HTTP/1.1 features such as pipelining will require rewriting code to
use a different set of interfaces.

The @code{Tkinter} module now supports Tcl/Tk version 8.1, 8.2, or 8.3, and
support for the older 7.x versions has been dropped.  The Tkinter module now
supports displaying Unicode strings in Tk widgets. Also, Fredrik Lundh
contributed an optimization which makes operations like @code{create_line} and
@code{create_polygon} much faster, especially when using lots of coordinates.

El módulo @ref{2c,,curses} ha sido ampliado en gran medida, a partir de la versión mejorada de Oliver Andrich, para proporcionar muchas funciones adicionales de los curses ncurses y SYSV, como el color, el soporte de conjuntos de caracteres alternativos, los pads y el soporte de ratón. Esto significa que el módulo ya no es compatible con los sistemas operativos que sólo tienen curses BSD, pero no parece haber ningún sistema operativo actualmente mantenido que caiga en esta categoría.

Como se mencionó en la discusión anterior sobre el soporte Unicode de la 2.0, la implementación subyacente de las expresiones regulares proporcionadas por el módulo @ref{b9,,re} ha sido cambiada. SRE, un nuevo motor de expresiones regulares escrito por Fredrik Lundh y parcialmente financiado por Hewlett Packard, soporta la comparación con cadenas de 8 bits y cadenas Unicode.

@c ======================================================================

@node Nuevos módulos<9>,Mejoras en IDLE,Cambios en los módulos,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 new-modules}@anchor{1589}
@subsection Nuevos módulos


Se han añadido varios módulos nuevos. Nos limitaremos a enumerarlos con breves descripciones; consulte la documentación de la versión 2.0 para conocer los detalles de un módulo concreto.


@itemize *

@item 
@ref{d,,atexit}:  Para registrar las funciones que serán llamadas antes de que el intérprete de Python salga. El código que actualmente establece @code{sys.exitfunc} directamente debe cambiarse para usar el módulo @ref{d,,atexit} en su lugar, importando @ref{d,,atexit} y llamando a @ref{915,,atexit.register()} con la función a llamar al salir. (Contribución de Skip Montanaro)

@item 
@ref{1c,,codecs}, @code{encodings}, @ref{105,,unicodedata}:  Added as part of the new
Unicode support.

@item 
@ref{5a,,filecmp}: Supersedes the old @code{cmp}, @code{cmpcache} and
@code{dircmp} modules, which have now become deprecated. (Contributed by Gordon
MacMillan and Moshe Zadka.)

@item 
@ref{63,,gettext}: Este módulo proporciona soporte de internacionalización (I18N) y localización (L10N) para los programas de Python, proporcionando una interfaz a la biblioteca de catálogo de mensajes GNU gettext. (Integrado por Barry Warsaw, a partir de contribuciones separadas de Martin von Löwis, Peter Funk y James Henstridge)

@item 
@code{linuxaudiodev}: Support for the @code{/dev/audio} device on Linux, a
twin to the existing @code{sunaudiodev} module. (Contributed by Peter Bosch,
with fixes by Jeremy Hylton.)

@item 
@ref{90,,mmap}: Una interfaz para archivos mapeados en memoria tanto en Windows como en Unix. El contenido de un fichero puede ser mapeado directamente en memoria, en cuyo momento se comporta como una cadena mutable, por lo que su contenido puede ser leído y modificado. Incluso pueden pasarse a funciones que esperan cadenas ordinarias, como el módulo @ref{b9,,re}. (Contribución de Sam Rushing, con algunas extensiones de A.M. Kuchling)

@item 
@code{pyexpat}: An interface to the Expat XML parser. (Contributed by Paul
Prescod.)

@item 
@ref{10d,,robotparser}: Parse a @code{robots.txt} file, which is used for writing
web spiders that politely avoid certain areas of a web site.  The parser accepts
the contents of a @code{robots.txt} file, builds a set of rules from it, and
can then answer questions about the fetchability of a given URL.  (Contributed
by Skip Montanaro.)

@item 
@ref{dd,,tabnanny}: Un módulo/script para comprobar el código fuente de Python en busca de sangrías ambiguas. (Contribuido por Tim Peters.)

@item 
@code{UserString}: A base class useful for deriving objects that behave like
strings.

@item 
@ref{115,,webbrowser}: Un módulo que proporciona una forma independiente de la plataforma para lanzar un navegador web en una URL específica. Para cada plataforma, se prueban varios navegadores en un orden específico. El usuario puede modificar el navegador que se lanza estableciendo la variable de entorno `BROWSER'. (Originalmente inspirado por el parche de Eric S. Raymond a @ref{108,,urllib} que añadía una funcionalidad similar, pero el módulo final proviene de un código originalmente implementado por Fred Drake como @code{Tools/idle/BrowserControl.py}, y adaptado para la biblioteca estándar por Fred)

@item 
@ref{116,,_winreg}: An interface to the Windows registry.  @code{_winreg} is an
adaptation of functions that have been part of PythonWin since 1995, but has now
been added to the core  distribution, and enhanced to support Unicode.
@code{_winreg} was written by Bill Tutt and Mark Hammond.

@item 
@ref{130,,zipfile}: Un módulo para leer y escribir archivos con formato ZIP. Se trata de archivos producidos por @code{PKZIP} en DOS/Windows o @code{zip} en Unix, que no deben confundirse con los archivos con formato @code{gzip} (que son compatibles con el módulo @ref{67,,gzip}) (Contribución de James C. Ahlstrom.)

@item 
@code{imputil}: A module that provides a simpler way for writing customized
import hooks, in comparison to the existing @code{ihooks} module.  (Implemented
by Greg Stein, with much discussion on python-dev along the way.)
@end itemize

@c ======================================================================

@node Mejoras en IDLE,Módulos eliminados y obsoletos,Nuevos módulos<9>,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 idle-improvements}@anchor{158a}
@subsection Mejoras en IDLE


IDLE es el IDE oficial de Python multiplataforma, escrito con Tkinter. Python 2.0 incluye IDLE 0.6, que añade una serie de nuevas características y mejoras. Una lista parcial:


@itemize *

@item 
Mejoras y optimizaciones de la interfaz de usuario, especialmente en el área de resaltado de sintaxis y auto-indentación.

@item 
El navegador de clases muestra ahora más información, como las funciones de nivel superior de un módulo.

@item 
El ancho del tabulador es ahora una opción configurable por el usuario. Al abrir un archivo Python existente, IDLE detecta automáticamente las convenciones de sangría y se adapta.

@item 
Ahora hay soporte para llamar a los navegadores en varias plataformas, utilizado para abrir la documentación de Python en un navegador.

@item 
IDLE ahora tiene una línea de comandos, que es en gran medida similar al intérprete de Python vainilla.

@item 
Se añadieron consejos de llamada en muchos lugares.

@item 
Ahora IDLE puede instalarse como un paquete.

@item 
En la ventana del editor, ahora hay una barra de líneas/columnas en la parte inferior.

@item 
Tres nuevos comandos de teclado: Comprobar módulo (@code{Alt-F5}), Importar módulo (@code{F5}) y Ejecutar script (@code{Ctrl-F5}).
@end itemize

@c ======================================================================

@node Módulos eliminados y obsoletos,Agradecimientos<8>,Mejoras en IDLE,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 deleted-and-deprecated-modules}@anchor{158b}
@subsection Módulos eliminados y obsoletos


A few modules have been dropped because they’re obsolete, or because there are
now better ways to do the same thing.  The @code{stdwin} module is gone; it was
for a platform-independent windowing toolkit that’s no longer developed.

A number of modules have been moved to the @code{lib-old} subdirectory:
@code{cmp}, @code{cmpcache}, @code{dircmp}, @code{dump},  @code{find},
@code{grep}, @code{packmail},  @code{poly}, @code{util}, @code{whatsound},
@code{zmod}.  If you have code which relies on a module  that’s been moved to
@code{lib-old}, you can simply add that directory to @code{sys.path}   to get them
back, but you’re encouraged to update any code that uses these modules.

@node Agradecimientos<8>,,Módulos eliminados y obsoletos,Qué hay de nuevo en Python 2 0
@anchor{whatsnew/2 0 acknowledgements}@anchor{158c}
@subsection Agradecimientos


Los autores desean agradecer a las siguientes personas sus sugerencias sobre varios borradores de este artículo: David Bolen, Mark Hammond, Gregg Hauser, Jeremy Hylton, Fredrik Lundh, Detlef Lannert, Aahz Maruch, Skip Montanaro, Vladimir Marangozov, Tobias Polzin, Guido van Rossum, Neil Schemenauer y Russ Schmidt.

The «Changelog» is an HTML version of the file built@footnote{https://pypi.org/project/blurb/}
from the contents of the
Misc/NEWS.d@footnote{https://github.com/python/cpython/tree/main/Misc/NEWS.d} directory tree, which contains `all' nontrivial changes
to Python for the current version.

@node Registro de cambios,,Qué hay de nuevo en Python 2 0,Qué hay de nuevo en Python
@anchor{whatsnew/changelog doc}@anchor{158d}@anchor{whatsnew/changelog changelog}@anchor{13b}@anchor{whatsnew/changelog id1}@anchor{158e}
@section Registro de cambios


@menu
* Python next:: 
* Python 3.14.0 alpha 1: Python 3 14 0 alpha 1. 
* Python 3.13.0 beta 1: Python 3 13 0 beta 1. 
* Python 3.13.0 alpha 6: Python 3 13 0 alpha 6. 
* Python 3.13.0 alpha 5: Python 3 13 0 alpha 5. 
* Python 3.13.0 alpha 4: Python 3 13 0 alpha 4. 
* Python 3.13.0 alpha 3: Python 3 13 0 alpha 3. 
* Python 3.13.0 alpha 2: Python 3 13 0 alpha 2. 
* Python 3.13.0 alpha 1: Python 3 13 0 alpha 1. 
* Python 3.12.0 beta 1: Python 3 12 0 beta 1. 
* Python 3.12.0 alpha 7: Python 3 12 0 alpha 7. 
* Python 3.12.0 alpha 6: Python 3 12 0 alpha 6. 
* Python 3.12.0 alpha 5: Python 3 12 0 alpha 5. 
* Python 3.12.0 alpha 4: Python 3 12 0 alpha 4. 
* Python 3.12.0 alpha 3: Python 3 12 0 alpha 3. 
* Python 3.12.0 alpha 2: Python 3 12 0 alpha 2. 
* Python 3.12.0 alpha 1: Python 3 12 0 alpha 1. 
* Python 3.11.0 beta 1: Python 3 11 0 beta 1. 
* Python 3.11.0 alpha 7: Python 3 11 0 alpha 7. 
* Python 3.11.0 alpha 6: Python 3 11 0 alpha 6. 
* Python 3.11.0 alpha 5: Python 3 11 0 alpha 5. 
* Python 3.11.0 alpha 4: Python 3 11 0 alpha 4. 
* Python 3.11.0 alpha 3: Python 3 11 0 alpha 3. 
* Python 3.11.0 alpha 2: Python 3 11 0 alpha 2. 
* Python 3.11.0 alpha 1: Python 3 11 0 alpha 1. 
* Python 3.10.0 beta 1: Python 3 10 0 beta 1. 
* Python 3.10.0 alpha 7: Python 3 10 0 alpha 7. 
* Python 3.10.0 alpha 6: Python 3 10 0 alpha 6. 
* Python 3.10.0 alpha 5: Python 3 10 0 alpha 5. 
* Python 3.10.0 alpha 4: Python 3 10 0 alpha 4. 
* Python 3.10.0 alpha 3: Python 3 10 0 alpha 3. 
* Python 3.10.0 alpha 2: Python 3 10 0 alpha 2. 
* Python 3.10.0 alpha 1: Python 3 10 0 alpha 1. 
* Python 3.9.0 beta 1: Python 3 9 0 beta 1. 
* Python 3.9.0 alpha 6: Python 3 9 0 alpha 6. 
* Python 3.9.0 alpha 5: Python 3 9 0 alpha 5. 
* Python 3.9.0 alpha 4: Python 3 9 0 alpha 4. 
* Python 3.9.0 alpha 3: Python 3 9 0 alpha 3. 
* Python 3.9.0 alpha 2: Python 3 9 0 alpha 2. 
* Python 3.9.0 alpha 1: Python 3 9 0 alpha 1. 
* Python 3.8.0 beta 1: Python 3 8 0 beta 1. 
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4. 
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3. 
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2. 
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1. 
* Python 3.7.0 final: Python 3 7 0 final. 
* Python 3.7.0 release candidate 1: Python 3 7 0 release candidate 1. 
* Python 3.7.0 beta 5: Python 3 7 0 beta 5. 
* Python 3.7.0 beta 4: Python 3 7 0 beta 4. 
* Python 3.7.0 beta 3: Python 3 7 0 beta 3. 
* Python 3.7.0 beta 2: Python 3 7 0 beta 2. 
* Python 3.7.0 beta 1: Python 3 7 0 beta 1. 
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4. 
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3. 
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2. 
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1. 
* Python 3.6.6 final: Python 3 6 6 final. 
* Python 3.6.6 release candidate 1: Python 3 6 6 release candidate 1. 
* Python 3.6.5 final: Python 3 6 5 final. 
* Python 3.6.5 release candidate 1: Python 3 6 5 release candidate 1. 
* Python 3.6.4 final: Python 3 6 4 final. 
* Python 3.6.4 release candidate 1: Python 3 6 4 release candidate 1. 
* Python 3.6.3 final: Python 3 6 3 final. 
* Python 3.6.3 release candidate 1: Python 3 6 3 release candidate 1. 
* Python 3.6.2 final: Python 3 6 2 final. 
* Python 3.6.2 release candidate 2: Python 3 6 2 release candidate 2. 
* Python 3.6.2 release candidate 1: Python 3 6 2 release candidate 1. 
* Python 3.6.1 final: Python 3 6 1 final. 
* Python 3.6.1 release candidate 1: Python 3 6 1 release candidate 1. 
* Python 3.6.0 final: Python 3 6 0 final. 
* Python 3.6.0 release candidate 2: Python 3 6 0 release candidate 2. 
* Python 3.6.0 release candidate 1: Python 3 6 0 release candidate 1. 
* Python 3.6.0 beta 4: Python 3 6 0 beta 4. 
* Python 3.6.0 beta 3: Python 3 6 0 beta 3. 
* Python 3.6.0 beta 2: Python 3 6 0 beta 2. 
* Python 3.6.0 beta 1: Python 3 6 0 beta 1. 
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4. 
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3. 
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2. 
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1. 
* Python 3.5.5 final: Python 3 5 5 final. 
* Python 3.5.5 release candidate 1: Python 3 5 5 release candidate 1. 
* Python 3.5.4 final: Python 3 5 4 final. 
* Python 3.5.4 release candidate 1: Python 3 5 4 release candidate 1. 
* Python 3.5.3 final: Python 3 5 3 final. 
* Python 3.5.3 release candidate 1: Python 3 5 3 release candidate 1. 
* Python 3.5.2 final: Python 3 5 2 final. 
* Python 3.5.2 release candidate 1: Python 3 5 2 release candidate 1. 
* Python 3.5.1 final: Python 3 5 1 final. 
* Python 3.5.1 release candidate 1: Python 3 5 1 release candidate 1. 
* Python 3.5.0 final: Python 3 5 0 final. 
* Python 3.5.0 release candidate 4: Python 3 5 0 release candidate 4. 
* Python 3.5.0 release candidate 3: Python 3 5 0 release candidate 3. 
* Python 3.5.0 release candidate 2: Python 3 5 0 release candidate 2. 
* Python 3.5.0 release candidate 1: Python 3 5 0 release candidate 1. 
* Python 3.5.0 beta 4: Python 3 5 0 beta 4. 
* Python 3.5.0 beta 3: Python 3 5 0 beta 3. 
* Python 3.5.0 beta 2: Python 3 5 0 beta 2. 
* Python 3.5.0 beta 1: Python 3 5 0 beta 1. 
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4. 
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3. 
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2. 
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1. 

@end menu

@node Python next,Python 3 14 0 alpha 1,,Registro de cambios
@anchor{whatsnew/changelog python-next}@anchor{158f}
@subsection Python next


`Release date: XXXX-XX-XX'

@menu
* Windows:: 
* Tools/Demos:: 
* Tests:: 
* Security:: 
* Library:: 
* Documentation:: 
* Core and Builtins:: 
* C API:: 
* Build:: 

@end menu

@node Windows,Tools/Demos,,Python next
@anchor{whatsnew/changelog windows}@anchor{1590}
@subsubsection Windows



@itemize -

@item 
gh-118973@footnote{https://github.com/python/cpython/issues/118973}: Ensures the experimental free-threaded install includes the
@code{_tkinter} module. The optional Tcl/Tk component must also be installed
in order for the module to work.

@item 
gh-126497@footnote{https://github.com/python/cpython/issues/126497}: Fixes venv failure due to missing redirector executables in
experimental free-threaded installs.

@item 
gh-126074@footnote{https://github.com/python/cpython/issues/126074}: Removed unnecessary DLLs from Windows embeddable package

@item 
gh-125315@footnote{https://github.com/python/cpython/issues/125315}: Avoid crashing in @ref{aa,,platform} due to slow WMI calls on some
Windows machines.

@item 
gh-126084@footnote{https://github.com/python/cpython/issues/126084}: Fix venvwlauncher to launch pythonw instead of python so no
extra console window is created.

@item 
gh-125842@footnote{https://github.com/python/cpython/issues/125842}: Fix a @ref{619,,SystemError} when @ref{13b0,,sys.exit()} is called with
@code{0xffffffff} on Windows.

@item 
gh-125550@footnote{https://github.com/python/cpython/issues/125550}: Enable the @ref{65f,,Lanzador de Python para Windows} to detect Python 3.14 installs from
the Windows Store.
@end itemize

@node Tools/Demos,Tests,Windows,Python next
@anchor{whatsnew/changelog tools-demos}@anchor{1591}
@subsubsection Tools/Demos



@itemize -

@item 
gh-126807@footnote{https://github.com/python/cpython/issues/126807}: Fix extraction warnings in @code{pygettext.py} caused by
mistaking function definitions for function calls.
@end itemize

@node Tests,Security,Tools/Demos,Python next
@anchor{whatsnew/changelog tests}@anchor{1592}
@subsubsection Tests



@itemize -

@item 
gh-125730@footnote{https://github.com/python/cpython/issues/125730}: Change @code{make test} to not run GUI tests by default. Use
@code{make ci} to run tests with GUI tests instead.

@item 
gh-124295@footnote{https://github.com/python/cpython/issues/124295}: Add translation tests to the @ref{7,,argparse} module.
@end itemize

@node Security,Library,Tests,Python next
@anchor{whatsnew/changelog security}@anchor{1593}
@subsubsection Security



@itemize -

@item 
gh-126623@footnote{https://github.com/python/cpython/issues/126623}: Upgrade libexpat to 2.6.4
@end itemize

@node Library,Documentation,Security,Python next
@anchor{whatsnew/changelog library}@anchor{1594}
@subsubsection Library



@itemize -

@item 
gh-126920@footnote{https://github.com/python/cpython/issues/126920}: Fix the @code{prefix} and @code{exec_prefix} keys from
@ref{10a8,,sysconfig.get_config_vars()} incorrectly having the same value as
@ref{280,,sys.base_prefix} and @ref{27b,,sys.base_exec_prefix},
respectively, inside virtual environments. They now accurately reflect
@ref{281,,sys.prefix} and @ref{27c,,sys.exec_prefix}.

@item 
gh-125063@footnote{https://github.com/python/cpython/issues/125063}: @ref{8d,,marshal} now supports @ref{514,,slice} objects. The marshal
format version was increased to 5.

@item 
gh-126789@footnote{https://github.com/python/cpython/issues/126789}: Fixed the values of @ref{10a8,,sysconfig.get_config_vars()},
@ref{12b1,,sysconfig.get_paths()}, and their siblings when the @ref{c7,,site}
initialization happens after @ref{db,,sysconfig} has built a cache for
@ref{10a8,,sysconfig.get_config_vars()}.

@item 
gh-126188@footnote{https://github.com/python/cpython/issues/126188}: Update bundled pip to 24.3.1

@item 
gh-126766@footnote{https://github.com/python/cpython/issues/126766}: Fix issue where @ref{1595,,urllib.request.url2pathname()} failed to
discard two leading slashes introducing an empty authority section.

@item 
gh-126705@footnote{https://github.com/python/cpython/issues/126705}: Allow @ref{cd9,,os.PathLike} to be a base for Protocols.

@item 
gh-126699@footnote{https://github.com/python/cpython/issues/126699}: Allow @ref{e63,,collections.abc.AsyncIterator} to be a base for
Protocols.

@item 
gh-126654@footnote{https://github.com/python/cpython/issues/126654}: Fix crash when non-dict was passed to several functions in
@code{_interpreters} module.

@item 
gh-104745@footnote{https://github.com/python/cpython/issues/104745}: Limit starting a patcher (from @ref{f13,,unittest.mock.patch()} or
@ref{1596,,unittest.mock.patch.object()}) more than once without stopping it

@item 
gh-126595@footnote{https://github.com/python/cpython/issues/126595}: Fix a crash when instantiating @ref{12f0,,itertools.count} with an
initial count of @ref{1232,,sys.maxsize} on debug builds. Patch by Bénédikt
Tran.

@item 
gh-120423@footnote{https://github.com/python/cpython/issues/120423}: Fix issue where @ref{1597,,urllib.request.pathname2url()} mishandled
Windows paths with embedded forward slashes.

@item 
gh-126565@footnote{https://github.com/python/cpython/issues/126565}: Improve performances of @ref{1598,,zipfile.Path.open()} for
non-reading modes.

@item 
gh-126505@footnote{https://github.com/python/cpython/issues/126505}: Fix bugs in compiling case-insensitive @ref{b9,,regular expressions} with character classes containing non-BMP characters:
upper-case non-BMP character did was ignored and the ASCII flag was
ignored when matching a character range whose upper bound is beyond the
BMP region.

@item 
gh-117378@footnote{https://github.com/python/cpython/issues/117378}: Fixed the @ref{94,,multiprocessing} @code{"forkserver"} start method
forkserver process to correctly inherit the parent’s @ref{27e,,sys.path}
during the importing of @ref{1599,,multiprocessing.set_forkserver_preload()}
modules in the same manner as @ref{27e,,sys.path} is configured in workers
before executing work items.

This bug caused some forkserver module preloading to silently fail to
preload. This manifested as a performance degration in child processes
when the @code{sys.path} was required due to additional repeated work in
every worker.

It could also have a side effect of @code{""} remaining in @ref{27e,,sys.path}
during forkserver preload imports instead of the absolute path from
@ref{159a,,os.getcwd()} at multiprocessing import time used in the worker
@code{sys.path}.

The @code{sys.path} differences between phases in the child process could
potentially have caused preload to import incorrect things from the wrong
location.  We are unaware of that actually having happened in practice.

@item 
gh-125679@footnote{https://github.com/python/cpython/issues/125679}: The @ref{159b,,multiprocessing.Lock} and
@ref{159c,,multiprocessing.RLock} @code{repr} values no longer say «unknown» on
macOS.

@item 
gh-126476@footnote{https://github.com/python/cpython/issues/126476}: Raise @ref{159d,,calendar.IllegalMonthError} (now a subclass of
@ref{1575,,IndexError}) for @ref{159e,,calendar.month()} when the input month is
not correct.

@item 
gh-126489@footnote{https://github.com/python/cpython/issues/126489}: The Python implementation of @ref{a6,,pickle} no longer calls
@ref{159f,,pickle.Pickler.persistent_id()} for the result of
@code{persistent_id()}.

@item 
gh-126451@footnote{https://github.com/python/cpython/issues/126451}: Register the @ref{15a0,,contextvars.Context} type to
@ref{961,,collections.abc.Mapping}.

@item 
gh-126175@footnote{https://github.com/python/cpython/issues/126175}: Add @code{msg}, @code{doc}, @code{pos}, @code{lineno} and @code{colno}
attributes to @ref{15a1,,tomllib.TOMLDecodeError}. Deprecate instantiating with
free-form arguments.

@item 
gh-89416@footnote{https://github.com/python/cpython/issues/89416}: Add 
@geindex RFC; RFC 9559
RFC 9559@footnote{https://datatracker.ietf.org/doc/html/rfc9559.html} MIME types for Matroska audiovisual container
formats. Patch by Hugo van Kemenade.

@item 
gh-126417@footnote{https://github.com/python/cpython/issues/126417}: Register the @code{multiprocessing.managers.DictProxy} and
@code{multiprocessing.managers.ListProxy} types in
@ref{97,,multiprocessing.managers} to @ref{1123,,collections.abc.MutableMapping}
and @ref{309,,collections.abc.MutableSequence}, respectively.

@item 
gh-126390@footnote{https://github.com/python/cpython/issues/126390}: Add support for returning intermixed options and non-option
arguments in order in @ref{14f6,,getopt.gnu_getopt()}.

@item 
gh-126374@footnote{https://github.com/python/cpython/issues/126374}: Add support for options with optional arguments in the
@ref{61,,getopt} module.

@item 
gh-126363@footnote{https://github.com/python/cpython/issues/126363}: Speed up pattern parsing in @ref{388,,pathlib.Path.glob()} by
skipping creation of a @ref{19b,,pathlib.Path} object for the pattern.

@item 
gh-126353@footnote{https://github.com/python/cpython/issues/126353}: @ref{214,,asyncio.get_event_loop()} now does not implicitly creates
an event loop. It now raises a @ref{1e5,,RuntimeError} if there is no set
event loop. Patch by Kumar Aditya.

@item 
gh-126313@footnote{https://github.com/python/cpython/issues/126313}: Fix an issue in @ref{15a2,,curses.napms()} when
@ref{15a3,,curses.initscr()} has not yet been called. Patch by Bénédikt Tran.

@item 
gh-126303@footnote{https://github.com/python/cpython/issues/126303}: Fix pickling and copying of @ref{15a4,,os.sched_param} objects.

@item 
gh-126138@footnote{https://github.com/python/cpython/issues/126138}: Fix a use-after-free crash on @ref{580,,asyncio.Task} objects
whose underlying coroutine yields an object that implements an evil
@ref{c5a,,__getattribute__()}. Patch by Nico Posada.

@item 
gh-120057@footnote{https://github.com/python/cpython/issues/120057}: Replace the @code{os.environ.refresh()} method with a new
@ref{195,,os.reload_environ()} function. Patch by Victor Stinner.

@item 
gh-126220@footnote{https://github.com/python/cpython/issues/126220}: Fix crash in @code{cProfile.Profile} and
@code{_lsprof.Profiler} when their callbacks were directly called with
0 arguments.

@item 
gh-126212@footnote{https://github.com/python/cpython/issues/126212}: Fix issue where @ref{1597,,urllib.request.pathname2url()} and
@ref{1595,,url2pathname()} removed slashes from Windows DOS
drive paths and URLs.

@item 
gh-126223@footnote{https://github.com/python/cpython/issues/126223}: Raise a @ref{718,,UnicodeEncodeError} instead of a
@ref{619,,SystemError} upon calling @code{_interpreters.create()} with an
invalid Unicode character.

@item 
gh-126205@footnote{https://github.com/python/cpython/issues/126205}: Fix issue where @ref{1597,,urllib.request.pathname2url()} generated
URLs beginning with four slashes (rather than two) when given a Windows
UNC path.

@item 
gh-126156@footnote{https://github.com/python/cpython/issues/126156}: Improved performances of creating
@ref{c8c,,Morsel} objects by a factor of 3.8x.

@item 
gh-126105@footnote{https://github.com/python/cpython/issues/126105}: Fix a crash in @ref{9,,ast} when the @ref{15a5,,ast.AST._fields}
attribute is deleted.

@item 
gh-126106@footnote{https://github.com/python/cpython/issues/126106}: Fixes a possible @code{NULL} pointer dereference in @ref{d0,,ssl}.

@item 
gh-126080@footnote{https://github.com/python/cpython/issues/126080}: Fix a use-after-free crash on @ref{580,,asyncio.Task} objects for
which the underlying event loop implements an evil
@ref{c5a,,__getattribute__()}. Reported by Nico-Posada. Patch by
Bénédikt Tran.

@item 
gh-125322@footnote{https://github.com/python/cpython/issues/125322}: Correct detection of complex numbers support in libffi.

@item 
gh-126083@footnote{https://github.com/python/cpython/issues/126083}: Fixed a reference leak in @ref{580,,asyncio.Task} objects when
reinitializing the same object with a non-@code{None} context. Patch by Nico
Posada.

@item 
gh-126068@footnote{https://github.com/python/cpython/issues/126068}: Fix exceptions in the @ref{7,,argparse} module so that only error
messages for ArgumentError and ArgumentTypeError are now translated.
ArgumentError is now only used for command line errors, not for logical
errors in the program. TypeError is now raised instead of ValueError for
some logical errors.

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: Add @ref{1a0,,pathlib.Path.scandir()} method to efficiently fetch
directory children and their file attributes. This is a trivial wrapper of
@ref{1a2,,os.scandir()}.

@item 
gh-125984@footnote{https://github.com/python/cpython/issues/125984}: Fix use-after-free crashes on @ref{c55,,asyncio.Future} objects
for which the underlying event loop implements an evil
@ref{c5a,,__getattribute__()}. Reported by Nico-Posada. Patch by
Bénédikt Tran.

@item 
gh-125926@footnote{https://github.com/python/cpython/issues/125926}: Fix @ref{f17,,urllib.parse.urljoin()} for base URI with undefined
authority. Although 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} only specify reference resolution for
absolute base URI, @code{urljoin()} should continue to return sensible
result for relative base URI.

@item 
gh-125969@footnote{https://github.com/python/cpython/issues/125969}: Fix an out-of-bounds crash when an evil
@ref{b8f,,asyncio.loop.call_soon()} mutates the length of the internal
callbacks list. Patch by Bénédikt Tran.

@item 
gh-125966@footnote{https://github.com/python/cpython/issues/125966}: Fix a use-after-free crash in
@ref{15a6,,asyncio.Future.remove_done_callback()}. Patch by Bénédikt Tran.

@item 
gh-125789@footnote{https://github.com/python/cpython/issues/125789}: Fix possible crash when mutating list of callbacks returned by
@code{asyncio.Future._callbacks}. It now always returns a new copy in C
implementation @code{_asyncio}. Patch by Kumar Aditya.

@item 
gh-126916@footnote{https://github.com/python/cpython/issues/126916}: Allow the `initial' parameter of @ref{17d,,functools.reduce()} to be
passed as a keyword argument. Patch by Sayandip Dutta.

@item 
gh-124452@footnote{https://github.com/python/cpython/issues/124452}: Fix an issue in
@ref{15a7,,email.policy.EmailPolicy.header_source_parse()} and
@ref{15a8,,email.policy.Compat32.header_source_parse()} that introduced spurious
leading whitespaces into header values when the header includes a newline
character after the header name delimiter (@code{:}) and before the value.

@item 
gh-117941@footnote{https://github.com/python/cpython/issues/117941}: @code{argparse.BooleanOptionalAction} now rejects option
names starting with @code{--no-}.

@item 
gh-125884@footnote{https://github.com/python/cpython/issues/125884}: Fixed the bug for @ref{a5,,pdb} where it can’t set breakpoints on
functions with certain annotations.

@item 
gh-125355@footnote{https://github.com/python/cpython/issues/125355}: Fix several bugs in
@ref{b8b,,argparse.ArgumentParser.parse_intermixed_args()}.


@itemize *

@item 
The parser no longer changes temporarily during parsing.

@item 
Default values are not processed twice.

@item 
Required mutually exclusive groups containing positional arguments are now supported.

@item 
The missing arguments report now includes the names of all required optional and positional arguments.

@item 
Unknown options can be intermixed with positional arguments in parse_known_intermixed_args().
@end itemize

@item 
gh-125767@footnote{https://github.com/python/cpython/issues/125767}: @ref{155,,super} objects are now @ref{a6,,pickleable} and
@ref{26,,copyable}.

@item 
gh-124969@footnote{https://github.com/python/cpython/issues/124969}: @code{locale.nl_langinfo(locale.ALT_DIGITS)} now returns a string
again. The returned value consists of up to 100 semicolon-separated
symbols.

@item 
gh-125666@footnote{https://github.com/python/cpython/issues/125666}: Avoid the exiting the interpreter if a null byte is given as
input in the new REPL.

@item 
gh-125710@footnote{https://github.com/python/cpython/issues/125710}: [Enum] fix hashable<->nonhashable comparisons for member values

@item 
gh-125631@footnote{https://github.com/python/cpython/issues/125631}: Restore ability to set @ref{159f,,persistent_id}
and @ref{15a9,,persistent_load} attributes of instances of
the @code{Pickler} and @code{Unpickler} classes in the @ref{a6,,pickle}
module.

@item 
gh-125378@footnote{https://github.com/python/cpython/issues/125378}: Fixed the bug in @ref{a5,,pdb} where after a multi-line command,
an empty line repeats the first line of the multi-line command, instead of
the full command.

@item 
gh-125682@footnote{https://github.com/python/cpython/issues/125682}: Reject non-ASCII digits in the Python implementation of
@ref{9e8,,json.loads()} conforming to the JSON specification.

@item 
gh-125660@footnote{https://github.com/python/cpython/issues/125660}: Reject invalid unicode escapes for Python implementation of
@ref{9e8,,json.loads()}.

@item 
gh-52551@footnote{https://github.com/python/cpython/issues/52551}: Use @code{wcsftime()} to implement @ref{1256,,time.strftime()} on
Windows.

@item 
gh-125259@footnote{https://github.com/python/cpython/issues/125259}: Fix the notes removal logic for errors thrown in enum
initialization.

@item 
gh-125633@footnote{https://github.com/python/cpython/issues/125633}: Add function @ref{184,,inspect.ispackage()} to determine whether an
object is a @ref{185,,package} or not.

@item 
gh-125614@footnote{https://github.com/python/cpython/issues/125614}: In the @ref{143,,FORWARDREF} format of
@ref{6,,annotationlib}, fix bug where nested expressions were not returned
as @ref{15aa,,annotationlib.ForwardRef} format.

@item 
gh-125590@footnote{https://github.com/python/cpython/issues/125590}: Allow @code{FrameLocalsProxy} to delete and pop if the key is not
a fast variable.

@item 
gh-125600@footnote{https://github.com/python/cpython/issues/125600}: Only show stale code warning in @ref{a5,,pdb} when we display
source code.

@item 
gh-125542@footnote{https://github.com/python/cpython/issues/125542}: Deprecate passing keyword-only `prefix_chars' argument to
@ref{1c1,,argparse.ArgumentParser.add_argument_group()}.

@item 
gh-125541@footnote{https://github.com/python/cpython/issues/125541}: Pressing @code{Ctrl-C} while blocked in
@ref{739,,threading.Lock.acquire()}, @ref{efe,,threading.RLock.acquire()}, and
@ref{1251,,threading.Thread.join()} now interrupts the function call and raises
a @ref{a63,,KeyboardInterrupt} exception on Windows, similar to how those
functions behave on macOS and Linux.

@item 
gh-125519@footnote{https://github.com/python/cpython/issues/125519}: Improve traceback if @ref{5bd,,importlib.reload()} is called with an
object that is not a module. Patch by Alex Waygood.

@item 
gh-125451@footnote{https://github.com/python/cpython/issues/125451}: Fix deadlock when
@ref{163,,concurrent.futures.ProcessPoolExecutor} shuts down concurrently
with an error when feeding a job to a worker process.

@item 
gh-125115@footnote{https://github.com/python/cpython/issues/125115}: Fixed a bug in @ref{a5,,pdb} where arguments starting with @code{-}
can’t be passed to the debugged script.

@item 
gh-125398@footnote{https://github.com/python/cpython/issues/125398}: Fix the conversion of the @code{VIRTUAL_ENV} path in the
activate script in @ref{111,,venv} when running in Git Bash for Windows.

@item 
gh-125245@footnote{https://github.com/python/cpython/issues/125245}: Fix race condition when importing @ref{1f,,collections.abc}, which
could incorrectly return an empty module.

@item 
gh-52551@footnote{https://github.com/python/cpython/issues/52551}: Fix encoding issues in @ref{1256,,time.strftime()}, the
@ref{d19,,strftime()} method of the @ref{31,,datetime} classes
@ref{32f,,datetime}, @ref{330,,date} and
@ref{331,,time} and formatting of these classes. Characters not
encodable in the current locale are now acceptable in the format string.
Surrogate pairs and sequence of surrogatescape-encoded bytes are no longer
recombinated. Embedded null character no longer terminates the format
string.

@item 
gh-124984@footnote{https://github.com/python/cpython/issues/124984}: Fixed thread safety in @ref{d0,,ssl} in the free-threaded build.
OpenSSL operations are now protected by a per-object lock.

@item 
gh-124651@footnote{https://github.com/python/cpython/issues/124651}: Properly quote template strings in @ref{111,,venv} activation
scripts.

@item 
gh-124694@footnote{https://github.com/python/cpython/issues/124694}: We’ve added
@ref{161,,concurrent.futures.InterpreterPoolExecutor}, which allows you to
run code in multiple isolated interpreters.  This allows you to circumvent
the limitations of CPU-bound threads (due to the GIL). Patch by Eric Snow.

This addition is unrelated to 
@geindex Python Enhancement Proposals; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}.

@item 
gh-58032@footnote{https://github.com/python/cpython/issues/58032}: Deprecate the @ref{1c2,,argparse.FileType} type converter.

@item 
gh-99749@footnote{https://github.com/python/cpython/issues/99749}: Adds a feature to optionally enable suggestions for argument
choices and subparser names if mistyped by the user.

@item 
gh-58956@footnote{https://github.com/python/cpython/issues/58956}: Fixed a bug in @ref{a5,,pdb} where sometimes the breakpoint won’t
trigger if it was set on a function which is already in the call stack.

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: The tkinter module can now be built to use either the new
version 9.0.0 of Tcl/Tk or the latest release 8.6.15 of Tcl/Tk 8.  Tcl/Tk
9 includes many improvements, both to the Tcl language and to the
appearance and utility of the graphical user interface provided by Tk.

@item 
gh-80958@footnote{https://github.com/python/cpython/issues/80958}: unittest discovery supports PEP 420 namespace packages as start
directory again.

@item 
gh-123370@footnote{https://github.com/python/cpython/issues/123370}: Fix the canvas not clearing after running turtledemo clock.

@item 
gh-89083@footnote{https://github.com/python/cpython/issues/89083}: Add @ref{1ba,,uuid.uuid8()} for generating UUIDv8 objects as
specified in 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}. Patch by Bénédikt Tran

@item 
gh-122549@footnote{https://github.com/python/cpython/issues/122549}: Add @ref{1a4,,platform.invalidate_caches()} to invalidate cached
results.

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: Update unbounded @code{read} calls in @ref{130,,zipfile} to specify an
explicit @code{size} putting a limit on how much data they may read. This
also updates handling around ZIP max comment size to match the standard
instead of reading comments that are one byte too long.

@item 
gh-121267@footnote{https://github.com/python/cpython/issues/121267}: Improve the performance of @ref{de,,tarfile} when writing files,
by caching user names and group names.

@item 
gh-70764@footnote{https://github.com/python/cpython/issues/70764}: Fixed an issue where @ref{1149,,inspect.getclosurevars()} would
incorrectly classify an attribute name as a global variable when the name
exists both as an attribute name and a global variable.

@item 
gh-118289@footnote{https://github.com/python/cpython/issues/118289}: @code{posixpath.realpath()} now raises
@ref{10d6,,NotADirectoryError} when `strict' mode is enabled and a
non-directory path with a trailing slash is supplied.

@item 
gh-119826@footnote{https://github.com/python/cpython/issues/119826}: Always return an absolute path for @ref{1383,,os.path.abspath()} on
Windows.

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: Remove deprecated @code{pkgutil.get_loader()} and
@code{pkgutil.find_loader()}.

@item 
gh-118986@footnote{https://github.com/python/cpython/issues/118986}: Add @code{socket.IPV6_RECVERR} constant (available since
Linux 2.2).

@item 
gh-116897@footnote{https://github.com/python/cpython/issues/116897}: Accepting objects with false values (like @code{0} and @code{[]})
except empty strings, byte-like objects and @code{None} in
@ref{10a,,urllib.parse} functions @ref{1c8,,parse_qsl()} and
@ref{1c9,,parse_qs()} is now deprecated.

@item 
gh-71936@footnote{https://github.com/python/cpython/issues/71936}: Fix a race condition in @ref{137c,,multiprocessing.pool.Pool}.

@item 
bpo-46128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46128}: Strip @ref{206,,unittest.IsolatedAsyncioTestCase} stack frames
from reported stacktraces.

@item 
gh-84852@footnote{https://github.com/python/cpython/issues/84852}: Add MIME types for MS Embedded OpenType, OpenType Layout,
TrueType, WOFF 1.0 and 2.0 fonts. Patch by Sahil Prajapati and Hugo van
Kemenade.
@end itemize

@node Documentation,Core and Builtins,Library,Python next
@anchor{whatsnew/changelog documentation}@anchor{15ab}
@subsubsection Documentation



@itemize -

@item 
gh-126622@footnote{https://github.com/python/cpython/issues/126622}: Added stub pages for removed modules explaining their removal,
where to find replacements, and linking to the last Python version that
supported them. Contributed by Ned Batchelder.

@item 
gh-125277@footnote{https://github.com/python/cpython/issues/125277}: Require Sphinx 7.2.6 or later to build the Python
documentation. Patch by Adam Turner.

@item 
gh-60712@footnote{https://github.com/python/cpython/issues/60712}: Include the @ref{b18,,object} type in the lists of documented
types. Change by Furkan Onder and Martin Panter.
@end itemize

@node Core and Builtins,C API,Documentation,Python next
@anchor{whatsnew/changelog core-and-builtins}@anchor{15ac}
@subsubsection Core and Builtins



@itemize -

@item 
gh-126341@footnote{https://github.com/python/cpython/issues/126341}: Now @ref{360,,ValueError} is raised instead of @ref{619,,SystemError}
when trying to iterate over a released @ref{156,,memoryview} object.

@item 
gh-126688@footnote{https://github.com/python/cpython/issues/126688}: Fix a crash when calling @ref{2ff,,os.fork()} on some operating
systems, including SerenityOS.

@item 
gh-126066@footnote{https://github.com/python/cpython/issues/126066}: Fix @ref{77,,importlib} to not write an incomplete .pyc files when
a ulimit or some other operating system mechanism is preventing the write
to go through fully.

@item 
gh-126222@footnote{https://github.com/python/cpython/issues/126222}: Do not include count of «peek» items in @code{_PyUop_num_popped}.
This ensures that the correct number of items are popped from the stack
when a micro-op exits with an error.

@item 
gh-126366@footnote{https://github.com/python/cpython/issues/126366}: Fix crash when using @code{yield from} on an object that raises an
exception in its @code{__iter__}.

@item 
gh-126209@footnote{https://github.com/python/cpython/issues/126209}: Fix an issue with @code{skip_file_prefixes} parameter which
resulted in an inconsistent behaviour between the C and Python
implementations of @ref{155a,,warnings.warn()}. Patch by Daehee Kim.

@item 
gh-126312@footnote{https://github.com/python/cpython/issues/126312}: Fix crash during garbage collection on an object frozen by
@ref{bc2,,gc.freeze()} on the free-threaded build.

@item 
gh-103951@footnote{https://github.com/python/cpython/issues/103951}: Relax optimization requirements to allow fast attribute access
to module subclasses.

@item 
gh-126072@footnote{https://github.com/python/cpython/issues/126072}: Following gh-126101@footnote{https://github.com/python/cpython/issues/126101}, for @ref{656,,Objetos código} like lambda,
annotation and type alias, we no longer  add @code{None} to its
@ref{15ad,,co_consts}.

@item 
gh-126195@footnote{https://github.com/python/cpython/issues/126195}: Improve JIT performance by 1.4% on macOS Apple Silicon by using
platform-specific memory protection APIs. Patch by Diego Russo.

@item 
gh-126139@footnote{https://github.com/python/cpython/issues/126139}: Provide better error location when attempting to use a
@ref{e33,,future statement} with an unknown future feature.

@item 
gh-126072@footnote{https://github.com/python/cpython/issues/126072}: Add a new attribute in @ref{15ae,,co_flags} to indicate
whether the first item in @ref{15ad,,co_consts} is the docstring.
If a code object has no docstring, @code{None} will `NOT' be inserted.

@item 
gh-90370@footnote{https://github.com/python/cpython/issues/90370}: Avoid temporary tuple creation for vararg in argument passing
with Argument Clinic generated code (if arguments either vararg or
positional-only).

@item 
gh-126018@footnote{https://github.com/python/cpython/issues/126018}: Fix a crash in @ref{15af,,sys.audit()} when passing a non-string as
first argument and Python was compiled in debug mode.

@item 
gh-126012@footnote{https://github.com/python/cpython/issues/126012}: The @ref{156,,memoryview} type now supports subscription, making
it a @ref{157,,generic type}.

@item 
gh-125837@footnote{https://github.com/python/cpython/issues/125837}: Adds @ref{15b0,,LOAD_SMALL_INT} and @ref{15b1,,LOAD_CONST_IMMORTAL}
instructions. @code{LOAD_SMALL_INT} pushes a small integer equal to the
@code{oparg} to the stack. @code{LOAD_CONST_IMMORTAL} does the same as
@code{LOAD_CONST} but is more efficient for immortal objects. Removes
@code{RETURN_CONST}  instruction.

@item 
gh-125942@footnote{https://github.com/python/cpython/issues/125942}: On Android, the @code{errors} setting of @ref{b61,,sys.stdout} was
changed from @code{surrogateescape} to @code{backslashreplace}.

@item 
gh-125859@footnote{https://github.com/python/cpython/issues/125859}: Fix a crash in the free threading build when
@ref{89a,,gc.get_objects()} or @ref{89b,,gc.get_referrers()} is called during an
in-progress garbage collection.

@item 
gh-125868@footnote{https://github.com/python/cpython/issues/125868}: It was possible in 3.14.0a1 only for attribute lookup to give
the wrong value. This was due to an incorrect specialization in very
specific circumstances. This is fixed in 3.14.0a2.

@item 
gh-125498@footnote{https://github.com/python/cpython/issues/125498}: The JIT has been updated to leverage Clang 19’s new
@code{preserve_none} attribute, which supports more platforms and is more
useful than LLVM’s existing @code{ghccc} calling convention. This also
removes the need to manually patch the calling convention in LLVM IR,
simplifying the JIT compilation process.

@item 
gh-125703@footnote{https://github.com/python/cpython/issues/125703}: Correctly honour @ref{ff,,tracemalloc} hooks in specialized
@code{Py_DECREF} paths. Patch by Pablo Galindo

@item 
gh-125593@footnote{https://github.com/python/cpython/issues/125593}: Use color to highlight error locations in traceback from
exception group

@item 
gh-125017@footnote{https://github.com/python/cpython/issues/125017}: Fix crash on certain accesses to the @code{__annotations__} of
@ref{22e,,staticmethod} and @ref{2d2,,classmethod} objects.

@item 
gh-125588@footnote{https://github.com/python/cpython/issues/125588}: The Python PEG generator can now use f-strings in the grammar
actions. Patch by Pablo Galindo

@item 
gh-125444@footnote{https://github.com/python/cpython/issues/125444}: Fix illegal instruction for older Arm architectures. Patch by
Diego Russo, testing by Ross Burton.

@item 
gh-118423@footnote{https://github.com/python/cpython/issues/118423}: Add a new @code{INSTRUCTION_SIZE} macro to the cases generator
which returns the current instruction size.

@item 
gh-125038@footnote{https://github.com/python/cpython/issues/125038}: Fix crash when iterating over a generator expression after
direct changes on @code{gi_frame.f_locals}. Patch by Mikhail Efimov.

@item 
gh-124855@footnote{https://github.com/python/cpython/issues/124855}: Don’t allow the JIT and perf support to be active at the same
time. Patch by Pablo Galindo

@item 
gh-123714@footnote{https://github.com/python/cpython/issues/123714}: Update JIT compilation to use LLVM 19

@item 
gh-123930@footnote{https://github.com/python/cpython/issues/123930}: Improve the error message when a script shadowing a module from
the standard library causes @ref{4d7,,ImportError} to be raised during a
«from» import. Similarly, improve the error message when a script
shadowing a third party module attempts to «from» import an attribute from
that third party module while still initialising.

@item 
gh-119793@footnote{https://github.com/python/cpython/issues/119793}: The @ref{14c,,map()} built-in now has an optional keyword-only
`strict' flag like @ref{14d,,zip()} to check that all the iterables are of
equal length. Patch by Wannes Boeykens.

@item 
gh-118950@footnote{https://github.com/python/cpython/issues/118950}: Fix bug where SSLProtocol.connection_lost wasn’t getting called
when OSError was thrown on writing to socket.

@item 
gh-113570@footnote{https://github.com/python/cpython/issues/113570}: Fixed a bug in @code{reprlib.repr} where it incorrectly called the
repr method on shadowed Python built-in types.
@end itemize

@node C API,Build,Core and Builtins,Python next
@anchor{whatsnew/changelog c-api}@anchor{15b2}
@subsubsection C API



@itemize -

@item 
gh-126554@footnote{https://github.com/python/cpython/issues/126554}: Fix error handling in @ref{a7b,,ctypes.CDLL} objects which could
result in a crash in rare situations.

@item 
gh-126061@footnote{https://github.com/python/cpython/issues/126061}: Add @ref{248,,PyLong_IsPositive()}, @ref{249,,PyLong_IsNegative()}
and @ref{24a,,PyLong_IsZero()} for checking if a @ref{24b,,PyLongObject} is
positive, negative, or zero, respectively.

@item 
gh-125608@footnote{https://github.com/python/cpython/issues/125608}: Fix a bug where dictionary watchers (e.g.,
@ref{607,,PyDict_Watch()}) on an object’s attribute dictionary
(@ref{5fe,,__dict__}) were not triggered when the object’s attributes
were modified.

@item 
gh-123619@footnote{https://github.com/python/cpython/issues/123619}: Added the @ref{26c,,PyUnstable_Object_EnableDeferredRefcount()}
function for enabling 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} deferred reference counting.

@item 
gh-121654@footnote{https://github.com/python/cpython/issues/121654}: Add @ref{26b,,PyType_Freeze()} function to make a type immutable.
Patch by Victor Stinner.

@item 
gh-120026@footnote{https://github.com/python/cpython/issues/120026}: The @code{Py_HUGE_VAL} macro is @ref{1c4,,soft deprecated}.
@end itemize

@node Build,,C API,Python next
@anchor{whatsnew/changelog build}@anchor{15b3}
@subsubsection Build



@itemize -

@item 
gh-126691@footnote{https://github.com/python/cpython/issues/126691}: Removed the @code{--with-emscripten-target} configure flag. We
unified the @code{node} and @code{browser} options and the same build can now be
used, independent of target runtime.

@item 
gh-123877@footnote{https://github.com/python/cpython/issues/123877}: Use @code{wasm32-wasip1} as the target triple for WASI instead of
@code{wasm32-wasi}. The latter will eventually be reclaimed for WASI 1.0
while CPython currently only supports WASI preview1.

@item 
gh-126458@footnote{https://github.com/python/cpython/issues/126458}: Disable SIMD support for HACL under WASI.

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: Hard-code float word ordering as little endian on WASM.

@item 
gh-126206@footnote{https://github.com/python/cpython/issues/126206}: @code{make clinic} now runs Argument Clinic using the @code{--force}
option, thus forcefully regenerating generated code.

@item 
gh-126187@footnote{https://github.com/python/cpython/issues/126187}: Introduced @code{Tools/wasm/emscripten.py} to simplify doing
Emscripten builds.

@item 
gh-124932@footnote{https://github.com/python/cpython/issues/124932}: For cross builds, there is now support for having a different
install @code{prefix} than the @code{host_prefix} used by @code{getpath.py}. This
is set to @code{/} by default for Emscripten, on other platforms the default
behavior is the same as before.

@item 
gh-125946@footnote{https://github.com/python/cpython/issues/125946}: The minimum supported Android version is now 7.0 (API level
24).

@item 
gh-125940@footnote{https://github.com/python/cpython/issues/125940}: The Android build now supports 16 KB page sizes@footnote{https://developer.android.com/guide/practices/page-sizes}.

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: Improve detection of float word ordering on Linux when link-time
optimizations are enabled.

@item 
gh-124928@footnote{https://github.com/python/cpython/issues/124928}: Emscripten builds now require node >= 18.

@item 
gh-115382@footnote{https://github.com/python/cpython/issues/115382}: Fix cross compile failures when the host and target SOABIs
match.
@end itemize

@node Python 3 14 0 alpha 1,Python 3 13 0 beta 1,Python next,Registro de cambios
@anchor{whatsnew/changelog python-3-14-0-alpha-1}@anchor{15b4}
@subsection Python 3.14.0 alpha 1


`Release date: 2024-10-15'

@menu
* macOS:: 
* Windows: Windows<2>. 
* Tools/Demos: Tools/Demos<2>. 
* Tests: Tests<2>. 
* Security: Security<2>. 
* Library: Library<2>. 
* IDLE: IDLE<3>. 
* Documentation: Documentation<2>. 
* Core and Builtins: Core and Builtins<2>. 
* C API: C API<2>. 
* Build: Build<2>. 

@end menu

@node macOS,Windows<2>,,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog macos}@anchor{15b5}
@subsubsection macOS



@itemize -

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: Update bundled Tcl/Tk in macOS installer to 8.6.15.

@item 
gh-123797@footnote{https://github.com/python/cpython/issues/123797}: Check for runtime availability of @code{ptsname_r} function on
macos.

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Updated macOS installer build to use OpenSSL 3.0.15.
@end itemize

@node Windows<2>,Tools/Demos<2>,macOS,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id2}@anchor{15b6}
@subsubsection Windows



@itemize -

@item 
gh-124487@footnote{https://github.com/python/cpython/issues/124487}: Increases Windows required OS and API level to Windows 10.

@item 
gh-124609@footnote{https://github.com/python/cpython/issues/124609}: Fix @code{_Py_ThreadId} for Windows builds using MinGW. Patch by
Tony Roberts.

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: Updated bundled Tcl/Tk to 8.6.15.

@item 
gh-124254@footnote{https://github.com/python/cpython/issues/124254}: Ensures experimental free-threaded binaries remain installed
when updating.

@item 
gh-123915@footnote{https://github.com/python/cpython/issues/123915}: Ensure that @code{Tools\msi\buildrelease.bat} uses different
directories for AMD64 and ARM64 builds.

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Updated Windows build to use OpenSSL 3.0.15.

@item 
gh-123476@footnote{https://github.com/python/cpython/issues/123476}: Add support for @code{socket.TCP_QUICKACK} on Windows platforms.

@item 
gh-122573@footnote{https://github.com/python/cpython/issues/122573}: The Windows build of CPython now requires 3.10 or newer.

@item 
gh-100256@footnote{https://github.com/python/cpython/issues/100256}: @ref{8f,,mimetypes} no longer fails when it encounters an
inaccessible registry key.

@item 
gh-119679@footnote{https://github.com/python/cpython/issues/119679}: Ensures correct import libraries are included in Windows
installs.

@item 
gh-119690@footnote{https://github.com/python/cpython/issues/119690}: Adds Unicode support and fixes audit events for
@code{_winapi.CreateNamedPipe}.

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: Add support for new pyrepl on Windows

@item 
gh-119070@footnote{https://github.com/python/cpython/issues/119070}: Fixes @code{py.exe} handling of shebangs like @code{/usr/bin/env
python3.12}, which were previously interpreted as @code{python3.exe} instead
of @code{python3.12.exe}.

@item 
gh-117505@footnote{https://github.com/python/cpython/issues/117505}: Fixes an issue with the Windows installer not running ensurepip
in a fully isolated environment. This could cause unexpected interactions
with the user site-packages.

@item 
gh-118209@footnote{https://github.com/python/cpython/issues/118209}: Avoid crashing in @ref{90,,mmap} on Windows when the mapped memory
is inaccessible due to file system errors or access violations.

@item 
gh-79846@footnote{https://github.com/python/cpython/issues/79846}: Makes @code{ssl.create_default_context()} ignore invalid
certificates in the Windows certificate store
@end itemize

@node Tools/Demos<2>,Tests<2>,Windows<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id3}@anchor{15b7}
@subsubsection Tools/Demos



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Update GitHub CI workflows to use OpenSSL 3.0.15 and
multissltests to use 3.0.15, 3.1.7, and 3.2.3.
@end itemize

@node Tests<2>,Security<2>,Tools/Demos<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id4}@anchor{15b8}
@subsubsection Tests



@itemize -

@item 
gh-125041@footnote{https://github.com/python/cpython/issues/125041}: Re-enable skipped tests for @ref{132,,zlib} on the s390x
architecture: only skip checks of the compressed bytes, which can be
different between zlib’s software implementation and the
hardware-accelerated implementation.

@item 
gh-124378@footnote{https://github.com/python/cpython/issues/124378}: Updated @code{test_ttk} to pass with Tcl/Tk 8.6.15.

@item 
gh-124213@footnote{https://github.com/python/cpython/issues/124213}: Detect whether the test suite is running inside a
systemd-nspawn container with @code{--suppress-sync=true} option, and skip
the @code{test_os} and @code{test_mmap} tests that are failing in this scenario.

@item 
gh-124190@footnote{https://github.com/python/cpython/issues/124190}: Add capability to ignore entire files or directories in check
warning CI tool

@item 
gh-121921@footnote{https://github.com/python/cpython/issues/121921}: Update @code{Lib/test/crashers/bogus_code_obj.py} so that it
crashes properly again.

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Add tooling to check for changes in compiler warnings. Patch by
Nate Ohlson.

@item 
gh-59022@footnote{https://github.com/python/cpython/issues/59022}: Add tests for @ref{15b9,,pkgutil.extend_path()}. Patch by Andreas
Stocker.

@item 
gh-99242@footnote{https://github.com/python/cpython/issues/99242}: @ref{15ba,,os.getloadavg()} may throw @ref{4d5,,OSError} when running
regression tests under certain conditions (e.g. chroot). This error is now
caught and ignored, since reporting load average is optional.

@item 
gh-121084@footnote{https://github.com/python/cpython/issues/121084}: Fix test_typing random leaks. Clear typing ABC caches when
running tests for refleaks (@code{-R} option): call @code{_abc_caches_clear()}
on typing abstract classes and their subclasses. Patch by Victor Stinner.

@item 
gh-121160@footnote{https://github.com/python/cpython/issues/121160}: Add a test for @ref{15bb,,readline.set_history_length()}. Note that
this test may fail on readline libraries.

@item 
gh-121200@footnote{https://github.com/python/cpython/issues/121200}: Fix @code{test_expanduser_pwd2()} of @code{test_posixpath}.  Call
@code{getpwnam()} to get @code{pw_dir}, since it can be different than
@code{getpwall()} @code{pw_dir}. Patch by Victor Stinner.

@item 
gh-121188@footnote{https://github.com/python/cpython/issues/121188}: When creating the JUnit XML file, regrtest now escapes
characters which are invalid in XML, such as the chr(27) control character
used in ANSI escape sequences. Patch by Victor Stinner.

@item 
gh-120801@footnote{https://github.com/python/cpython/issues/120801}: Cleaned up fixtures for importlib.metadata tests and
consolidated behavior with “test.support.os_helper”.

@item 
gh-119727@footnote{https://github.com/python/cpython/issues/119727}: Add @code{--single-process} command line option to Python test
runner (regrtest). Patch by Victor Stinner.

@item 
gh-119273@footnote{https://github.com/python/cpython/issues/119273}: Python test runner no longer runs tests using TTY (ex:
test_ioctl) in a process group (using @code{setsid()}). Previously, tests
using TTY were skipped. Patch by Victor Stinner.

@item 
gh-119050@footnote{https://github.com/python/cpython/issues/119050}: regrtest test runner: Add XML support to the refleak checker
(-R option). Patch by Victor Stinner.

@item 
gh-101525@footnote{https://github.com/python/cpython/issues/101525}: Skip @code{test_gdb} if the binary is relocated by BOLT. Patch by
Donghee Na.

@item 
gh-107562@footnote{https://github.com/python/cpython/issues/107562}: Test certificates have been updated to expire far in the
future. This allows testing Y2038 with system time set to after that, so
that actual Y2038 issues can be exposed, and not masked by expired
certificate errors.
@end itemize

@node Security<2>,Library<2>,Tests<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id5}@anchor{15bc}
@subsubsection Security



@itemize -

@item 
gh-125140@footnote{https://github.com/python/cpython/issues/125140}: Remove the current directory from @code{sys.path} when using
PyREPL.

@item 
gh-123678@footnote{https://github.com/python/cpython/issues/123678}: Upgrade libexpat to 2.6.3

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Enable compiler options that warn of potential security
vulnerabilities.

@item 
gh-122792@footnote{https://github.com/python/cpython/issues/122792}: Changed IPv4-mapped @code{ipaddress.IPv6Address} to consistently
use the mapped IPv4 address value for deciding properties. Properties
which have their behavior fixed are @code{is_multicast}, @code{is_reserved},
@code{is_link_local}, @code{is_global}, and @code{is_unspecified}.

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Add ability to ignore warnings per file with warning count in
warning checking tooling. Patch by Nate Ohlson.

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Add macOS warning tracking to warning check tooling. Patch by
Nate Ohlson.

@item 
gh-122133@footnote{https://github.com/python/cpython/issues/122133}: Authenticate the socket connection for the
@code{socket.socketpair()} fallback on platforms where @code{AF_UNIX} is not
available like Windows.

Patch by Gregory P. Smith <@email{greg@@krypto.org}> and Seth Larson
<@email{seth@@python.org}>. Reported by Ellie <@email{el@@horse64.org}>

@item 
gh-121957@footnote{https://github.com/python/cpython/issues/121957}: Fixed missing audit events around interactive use of Python,
now also properly firing for @code{python -i}, as well as for @code{python -m
asyncio}. The events in question are @code{cpython.run_stdin} and
@code{cpython.run_startup}.

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Enable runtime protections for glibc to abort execution when
unsafe behavior is encountered, for all platforms except Windows.

@item 
gh-121285@footnote{https://github.com/python/cpython/issues/121285}: Remove backtracking from tarfile header parsing for
@code{hdrcharset}, PAX, and GNU sparse headers.

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: Add default compiler options to improve security. Enable
-Wimplicit-fallthrough, -fstack-protector-strong, -Wtrampolines.

@item 
gh-118773@footnote{https://github.com/python/cpython/issues/118773}: Fixes creation of ACLs in @ref{37a,,os.mkdir()} on Windows to work
correctly on non-English machines.

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: @ref{37a,,os.mkdir()} on Windows now accepts `mode' of @code{0o700} to
restrict the new directory to the current user. This fixes
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030} affecting @ref{37c,,tempfile.mkdtemp()} in scenarios where the
base temporary directory is more permissive than the default.
@end itemize

@node Library<2>,IDLE<3>,Security<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id6}@anchor{15bd}
@subsubsection Library



@itemize -

@item 
gh-125422@footnote{https://github.com/python/cpython/issues/125422}: Fixed the bug where @ref{a5,,pdb} and @ref{10,,bdb} can step into the
bottom caller frame.

@item 
gh-100141@footnote{https://github.com/python/cpython/issues/100141}: Fixed the bug where @ref{a5,,pdb} will be stuck in an infinite
loop when debugging an empty file.

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: Fix @ref{146c,,time.strptime()} for @code{%c}, @code{%x} and @code{%X} formats
in many locales that use non-ASCII digits, like Persian, Burmese, Odia and
Shan.

@item 
gh-125206@footnote{https://github.com/python/cpython/issues/125206}: Workaround for old libffi versions is added. Module ctypes
supports double complex only with libffi >= 3.3.0. Patch by
Mikhail Efimov.

@item 
gh-89967@footnote{https://github.com/python/cpython/issues/89967}: Make @ref{15be,,WeakKeyDictionary} and
@ref{15bf,,WeakValueDictionary} safe against concurrent mutations
from other threads. Patch by Kumar Aditya.

@item 
gh-125260@footnote{https://github.com/python/cpython/issues/125260}: The @ref{6df,,gzip.compress()} `mtime' parameter now defaults to 0
for reproducible output. Patch by Bernhard M. Wiedemann and Adam Turner.

@item 
gh-125243@footnote{https://github.com/python/cpython/issues/125243}: Fix data race when creating @ref{976,,zoneinfo.ZoneInfo} objects
in the free threading build.

@item 
gh-125254@footnote{https://github.com/python/cpython/issues/125254}: Fix a bug where ArgumentError includes the incorrect ambiguous
option in @ref{7,,argparse}.

@item 
gh-125235@footnote{https://github.com/python/cpython/issues/125235}: Keep @ref{f0,,tkinter} TCL paths in venv pointing to base
installation on Windows.

@item 
gh-61011@footnote{https://github.com/python/cpython/issues/61011}: Fix inheritance of nested mutually exclusive groups from parent
parser in @ref{15c,,argparse.ArgumentParser}. Previously, all nested
mutually exclusive groups lost their connection to the group containing
them and were displayed as belonging directly to the parser.

@item 
gh-125118@footnote{https://github.com/python/cpython/issues/125118}: Don’t copy arbitrary values to _Bool in the
@ref{d5,,struct} module.

@item 
gh-125069@footnote{https://github.com/python/cpython/issues/125069}: Fix an issue where providing a @ref{54e,,pathlib.PurePath} object
as an initializer argument to a second @ref{54e,,PurePath} object
with a different @ref{387,,parser} resulted in arguments to
the former object’s initializer being joined by the latter object’s
parser.

@item 
gh-125096@footnote{https://github.com/python/cpython/issues/125096}: If the 
@geindex PYTHON_BASIC_REPL
@geindex variables de entorno; PYTHON_BASIC_REPL
@ref{2da,,PYTHON_BASIC_REPL} environment variable is set,
the @ref{c7,,site} module no longer imports the @code{_pyrepl} module.
Moreover, the @ref{c7,,site} module now respects @ref{9f0,,-E} and
@ref{9f1,,-I} command line options: ignore 
@geindex PYTHON_BASIC_REPL
@geindex variables de entorno; PYTHON_BASIC_REPL
@ref{2da,,PYTHON_BASIC_REPL} in
this case. Patch by Victor Stinner.

@item 
gh-124969@footnote{https://github.com/python/cpython/issues/124969}: Fix @code{locale.nl_langinfo(locale.ALT_DIGITS)}. Now it returns a
tuple of up to 100 strings (an empty tuple on most locales). Previously it
returned the first item of that tuple or an empty string.

@item 
gh-124960@footnote{https://github.com/python/cpython/issues/124960}: Fix support for the @code{barry_as_FLUFL} future flag in the new
REPL.

@item 
gh-69998@footnote{https://github.com/python/cpython/issues/69998}: Fix @ref{22f,,locale.nl_langinfo()} in case when different categories
have different locales. The function now sets temporarily the @code{LC_CTYPE}
locale in some cases. This temporary change affects other threads.

@item 
gh-124958@footnote{https://github.com/python/cpython/issues/124958}: Fix refcycles in exceptions raised from
@ref{31c,,asyncio.TaskGroup} and the python implementation of
@ref{c55,,asyncio.Future}

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: Fix @ref{146c,,time.strptime()} for @code{%c} and @code{%x} formats in many
locales: Arabic, Bislama, Breton, Bodo, Kashubian, Chuvash, Estonian,
French, Irish, Ge’ez, Gurajati, Manx Gaelic, Hebrew, Hindi, Chhattisgarhi,
Haitian Kreyol, Japanese, Kannada, Korean, Marathi, Malay, Norwegian,
Nynorsk, Punjabi, Rajasthani, Tok Pisin, Yoruba, Yue Chinese, Yau/Nungon
and Chinese.

@item 
gh-123961@footnote{https://github.com/python/cpython/issues/123961}: Convert @ref{2c,,curses} to multi-phase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}), thereby fixing reference leaks at interpreter shutdown.
Patch by Bénédikt Tran.

@item 
gh-124944@footnote{https://github.com/python/cpython/issues/124944}: Add @code{SO_ORIGINAL_DST} to the @ref{cc,,socket} module.

@item 
gh-117151@footnote{https://github.com/python/cpython/issues/117151}: The default buffer size used by @ref{aee,,shutil.copyfileobj()} has
been increased from 64k to 256k on non-Windows platforms. It was already
larger on Windows.

@item 
gh-90102@footnote{https://github.com/python/cpython/issues/90102}: Skip the @code{isatty} system call during open() when the file is
known to not be a character device. This provides a slight performance
improvement when reading whole files.

@item 
gh-124917@footnote{https://github.com/python/cpython/issues/124917}: Allow calling @ref{aa0,,os.path.exists()} and
@ref{aa1,,os.path.lexists()} with keyword arguments on Windows. Fixes a
regression in 3.13.0.

@item 
gh-65865@footnote{https://github.com/python/cpython/issues/65865}: @ref{7,,argparse} now raises early error for invalid @code{help}
arguments to @ref{306,,add_argument()},
@ref{c9f,,add_subparsers()} and @code{add_parser()}.

@item 
gh-124653@footnote{https://github.com/python/cpython/issues/124653}: Fix detection of the minimal Queue API needed by the
@ref{87,,logging} module. Patch by Bénédikt Tran.

@item 
gh-91818@footnote{https://github.com/python/cpython/issues/91818}: The CLI of many modules (@ref{9,,ast}, @ref{55,,ensurepip},
@ref{82,,json}, @ref{a5,,pdb}, @ref{cf,,sqlite3}, @ref{fb,,tokenize}, @ref{111,,venv}) now
uses the actual executable name instead of simply «python» to display in
the usage message.

@item 
gh-124858@footnote{https://github.com/python/cpython/issues/124858}: Fix reference cycles left in tracebacks in
@ref{ba3,,asyncio.open_connection()} when used with @code{happy_eyeballs_delay}

@item 
gh-124390@footnote{https://github.com/python/cpython/issues/124390}: Fixed @ref{74a,,AssertionError} when using
@code{asyncio.staggered.staggered_race()} with
@ref{522,,asyncio.eager_task_factory}.

@item 
gh-85935@footnote{https://github.com/python/cpython/issues/85935}: @ref{306,,argparse.ArgumentParser.add_argument()} now raises an
exception if an @ref{15c0,,action} that does not consume arguments (like
“store_const” or “store_true”) or explicit @code{nargs=0} are specified for
positional arguments.

@item 
gh-124835@footnote{https://github.com/python/cpython/issues/124835}: Make @ref{15c1,,tomllib.loads()} raise @ref{228,,TypeError} not
@ref{441,,AttributeError} on bad input types that do not have the @code{replace}
attribute. Improve error message when @ref{325,,bytes} is received.

@item 
gh-124693@footnote{https://github.com/python/cpython/issues/124693}: Fix a bug where @ref{7,,argparse} doesn’t recognize negative
complex numbers or negative numbers using scientific notation.

@item 
gh-124787@footnote{https://github.com/python/cpython/issues/124787}: Fix @ref{501,,typing.TypeAliasType} with incorrect
@code{type_params} argument. Now it raises a @ref{228,,TypeError} when a type
parameter without a default follows one with a default, and when an entry
in the @code{type_params} tuple is not a type parameter object.

@item 
gh-66436@footnote{https://github.com/python/cpython/issues/66436}: Improved @ref{15b,,prog} default value for
@ref{15c,,argparse.ArgumentParser}. It will now include the name of the
Python executable along with the module or package name, or the path to a
directory, ZIP file, or directory within a ZIP file if the code was run
that way.

@item 
gh-116850@footnote{https://github.com/python/cpython/issues/116850}: Fix @ref{7,,argparse} for namespaces with not directly writable
dict (e.g. classes).

@item 
gh-101552@footnote{https://github.com/python/cpython/issues/101552}: Add an `annoation_format' parameter to
@ref{181,,inspect.signature()}. Add an `quote_annotation_strings' parameter to
@ref{183,,inspect.Signature.format()}. Use the new functionality to improve the
display of annotations in signatures in @ref{b5,,pydoc}. Patch by Jelle
Zijlstra.

@item 
gh-58573@footnote{https://github.com/python/cpython/issues/58573}: Fix conflicts between abbreviated long options in the parent
parser and subparsers in @ref{7,,argparse}.

@item 
gh-124594@footnote{https://github.com/python/cpython/issues/124594}: All @ref{b,,asyncio} REPL prompts run in the same @ref{15a0,,context}. Contributed by Bartosz Sławecki.

@item 
gh-61181@footnote{https://github.com/python/cpython/issues/61181}: Fix support of @ref{15c2,,choices} with string value in
@ref{7,,argparse}. Substrings of the specified string no longer considered
valid values.

@item 
gh-116750@footnote{https://github.com/python/cpython/issues/116750}: Provide @ref{15c3,,sys.monitoring.clear_tool_id()} to unregister all
events and callbacks set by the tool.

@item 
gh-124552@footnote{https://github.com/python/cpython/issues/124552}: Improve the accuracy of @ref{10,,bdb}’s check for the possibility
of breakpoint in a frame. This makes it possible to disable unnecessary
events in functions.

@item 
gh-124538@footnote{https://github.com/python/cpython/issues/124538}: Fixed crash when using @ref{89c,,gc.get_referents()} on a capsule
object.

@item 
gh-80259@footnote{https://github.com/python/cpython/issues/80259}: Fix @ref{7,,argparse} support of positional arguments with
@code{nargs='?'}, @code{default=argparse.SUPPRESS} and specified @code{type}.

@item 
gh-120378@footnote{https://github.com/python/cpython/issues/120378}: Fix a crash related to an integer overflow in
@ref{15c4,,curses.resizeterm()} and @ref{15c5,,curses.resize_term()}.

@item 
gh-124498@footnote{https://github.com/python/cpython/issues/124498}: Fix @ref{501,,typing.TypeAliasType} not to be generic, when
@code{type_params} is an empty tuple.

@item 
gh-53834@footnote{https://github.com/python/cpython/issues/53834}: Fix support of arguments with @ref{15c2,,choices} in @ref{7,,argparse}.
Positional arguments with @ref{15c6,,nargs} equal to @code{'?'} or @code{'*'} no
longer check @ref{15c7,,default} against @code{choices}. Optional arguments with
@code{nargs} equal to @code{'?'} no longer check @ref{15c8,,const} against
@code{choices}.

@item 
gh-123884@footnote{https://github.com/python/cpython/issues/123884}: Fixed bug in itertools.tee() handling of other tee inputs (a
tee in a tee). The output now has the promised `n' independent new
iterators.  Formerly, the first iterator was identical (not independent)
to the input iterator. This would sometimes give surprising results.

@item 
gh-123017@footnote{https://github.com/python/cpython/issues/123017}: Due to unreliable results on some devices,
@ref{1256,,time.strftime()} no longer accepts negative years on Android.

@item 
gh-123014@footnote{https://github.com/python/cpython/issues/123014}: @ref{524,,os.pidfd_open()} and @ref{9be,,signal.pidfd_send_signal()} are
now unavailable when building against Android API levels older than 31,
since the underlying system calls may cause a crash.

@item 
gh-124176@footnote{https://github.com/python/cpython/issues/124176}: Add support for @ref{32e,,dataclasses.dataclass()} in
@ref{15c9,,unittest.mock.create_autospec()}. Now @code{create_autospec} will check
for potential dataclasses and use @ref{15ca,,dataclasses.fields()} function to
retrieve the spec information.

@item 
gh-124345@footnote{https://github.com/python/cpython/issues/124345}: @ref{7,,argparse} vim supports abbreviated single-dash long
options separated by @code{=} from its value.

@item 
gh-124400@footnote{https://github.com/python/cpython/issues/124400}: Fixed a @ref{a5,,pdb} bug where @code{until} has no effect when it
appears in a @code{commands} sequence. Also avoid printing the frame
information at a breakpoint that has a command list containing a command
that resumes execution.

@item 
gh-90562@footnote{https://github.com/python/cpython/issues/90562}: Modify dataclasses to support zero-argument super() when
@code{slots=True} is specified.  This works by modifying all references to
@code{__class__} to point to the newly created class.

@item 
gh-104860@footnote{https://github.com/python/cpython/issues/104860}: Fix disallowing abbreviation of single-dash long options in
@ref{7,,argparse} with @code{allow_abbrev=False}.

@item 
gh-63143@footnote{https://github.com/python/cpython/issues/63143}: Fix parsing mutually exclusive arguments in @ref{7,,argparse}.
Arguments with the value identical to the default value (e.g. booleans,
small integers, empty or 1-character strings) are no longer considered
«not present».

@item 
gh-72795@footnote{https://github.com/python/cpython/issues/72795}: Positional arguments with @ref{15c6,,nargs} equal to @code{'*'} or
@code{argparse.REMAINDER} are no longer required. This allows to use
positional argument with @code{nargs='*'} and without @code{default} in mutually
exclusive group and improves error message about required arguments.

@item 
gh-59317@footnote{https://github.com/python/cpython/issues/59317}: Fix parsing positional argument with @ref{15c6,,nargs} equal to
@code{'?'} or @code{'*'} if it is preceded by an option and another positional
argument.

@item 
gh-100980@footnote{https://github.com/python/cpython/issues/100980}: The @ref{15cb,,_fields_} attribute of
@ref{166,,ctypes.Structure} and @ref{167,,Union} is no longer set if
the setattr operation raises an error.

@item 
gh-53780@footnote{https://github.com/python/cpython/issues/53780}: @ref{7,,argparse} now ignores the first @code{"--"} (double dash)
between an option and command.

@item 
gh-124217@footnote{https://github.com/python/cpython/issues/124217}: Add RFC 9637 reserved IPv6 block @code{3fff::/20} in
@ref{80,,ipaddress} module.

@item 
gh-111513@footnote{https://github.com/python/cpython/issues/111513}: Improve the error message that may be raised by
@ref{15cc,,datetime.date.fromtimestamp()}.

@item 
gh-124248@footnote{https://github.com/python/cpython/issues/124248}: Fixed potential crash when using @ref{d5,,struct} to process
zero-width “Pascal string” fields (@code{0p}).

@item 
gh-81691@footnote{https://github.com/python/cpython/issues/81691}: Fix handling of multiple @code{"--"} (double dashes) in
@ref{7,,argparse}. Only the first one has now been removed, all subsequent
ones are now taken literally.

@item 
gh-87041@footnote{https://github.com/python/cpython/issues/87041}: Fix a bug in @ref{7,,argparse} where lengthy subparser argument
help is incorrectly indented.

@item 
gh-84559@footnote{https://github.com/python/cpython/issues/84559}: The default @ref{94,,multiprocessing} start method on Linux and
other POSIX systems has been changed away from often unsafe @code{"fork"} to
@code{"forkserver"} (when the platform supports sending file handles over
pipes as most do) or @code{"spawn"}.  Mac and Windows are unchanged as they
already default to @code{"spawn"}.

@item 
gh-124212@footnote{https://github.com/python/cpython/issues/124212}: Fix invalid variable in @ref{111,,venv} handling of failed symlink
on Windows

@item 
gh-124171@footnote{https://github.com/python/cpython/issues/124171}: Add workaround for broken @code{fmod()} implementations on
Windows, that loose zero sign (e.g. @code{fmod(-10, 1)} returns @code{0.0}).
Patch by Sergey B Kirpichev.

@item 
gh-123978@footnote{https://github.com/python/cpython/issues/123978}: Remove broken @ref{9c9,,time.thread_time()} and
@ref{c19,,time.thread_time_ns()} on NetBSD.

@item 
gh-123934@footnote{https://github.com/python/cpython/issues/123934}: Fix @ref{f12,,unittest.mock.MagicMock} resetting magic methods
return values after @code{.reset_mock(return_value=True)} was called.

@item 
gh-124016@footnote{https://github.com/python/cpython/issues/124016}: Update @ref{105,,unicodedata} database to Unicode 16.0.0.

@item 
gh-123968@footnote{https://github.com/python/cpython/issues/123968}: Fix the command-line interface for the @ref{b8,,random} module to
select floats between 0 and N, not 1 and N.

@item 
gh-123945@footnote{https://github.com/python/cpython/issues/123945}: Fix a bug where @ref{7,,argparse} doesn’t recognize negative
numbers with underscores

@item 
gh-123935@footnote{https://github.com/python/cpython/issues/123935}: Fix parent slots detection for dataclasses that inherit from
classes with @code{__dictoffset__}.

@item 
gh-123892@footnote{https://github.com/python/cpython/issues/123892}: Add @code{"_wmi"} to @ref{8d8,,sys.stdlib_module_names}. Patch by
Victor Stinner.

@item 
gh-84808@footnote{https://github.com/python/cpython/issues/84808}: Fix error handling in @ref{e27,,socket} method
@ref{1579,,connect_ex()} on platforms where @code{errno}
can be negative.

@item 
gh-123756@footnote{https://github.com/python/cpython/issues/123756}: Added a new argument @code{mode} to @ref{1a8,,pdb.Pdb}. Only allow
@ref{a5,,pdb} from command line to use @code{restart} command.

@item 
gh-122765@footnote{https://github.com/python/cpython/issues/122765}: Fix unbalanced quote errors occurring when activate.csh in
@ref{111,,venv} was sourced with a custom prompt containing unpaired quotes or
newlines.

@item 
gh-123657@footnote{https://github.com/python/cpython/issues/123657}: Fix crash and memory leak in @ref{15cd,,decimal.getcontext()}. It
crashed when using a thread-local context by
@code{--with-decimal-contextvar=no}.

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: Fix @ref{15ce,,inspect.getsource()} for classes in
@ref{1f,,collections.abc} and @ref{37,,decimal} (for pure Python implementation)
modules. @ref{15cf,,inspect.getcomments()} now raises OSError instead of
IndexError if the @code{__firstlineno__} value for a class is out of bound.

@item 
gh-123374@footnote{https://github.com/python/cpython/issues/123374}: Remove check for redefined memo entry in
@ref{d4a,,pickletools.dis()}.

@item 
gh-123504@footnote{https://github.com/python/cpython/issues/123504}: Fixed reference leak in the finalization of @ref{f0,,tkinter}.

@item 
gh-123430@footnote{https://github.com/python/cpython/issues/123430}: Pages generated by the @ref{72,,http.server} module allow the
browser to apply its default dark mode.

@item 
gh-123446@footnote{https://github.com/python/cpython/issues/123446}: Fix empty function name in @ref{228,,TypeError} when
@ref{52f,,csv.reader()}, @ref{530,,csv.writer()}, or @ref{15d0,,csv.register_dialect()}
are used without the required args.

@item 
gh-123448@footnote{https://github.com/python/cpython/issues/123448}: Fixed memory leak of @ref{3b9,,typing.NoDefault} by moving it to
the static types array.

@item 
gh-123409@footnote{https://github.com/python/cpython/issues/123409}: Fix @ref{15d1,,ipaddress.IPv6Address.reverse_pointer} output
according to 
@geindex RFC; RFC 3596 Section 2.5
RFC 3596@comma{} §2.5@footnote{https://datatracker.ietf.org/doc/html/rfc3596.html#section-2.5}.  Patch by Bénédikt
Tran.

@item 
gh-123089@footnote{https://github.com/python/cpython/issues/123089}: Make @ref{67e,,weakref.WeakSet} safe against concurrent mutations
while it is being iterated. Patch by Kumar Aditya.

@item 
gh-123363@footnote{https://github.com/python/cpython/issues/123363}: Show string value of @ref{15d2,,CONTAINS_OP} oparg in @ref{39,,dis}
output. Patch by Alexandr153.

@item 
gh-123341@footnote{https://github.com/python/cpython/issues/123341}: Add @ref{7d6,,__class_getitem__()} to
@code{tkinter.Event} for type subscript support at runtime. Patch by
Adonis Rakateli.

@item 
gh-123340@footnote{https://github.com/python/cpython/issues/123340}: Show string value of @ref{15d3,,IS_OP} oparg in @ref{39,,dis}
output.

@item 
gh-119518@footnote{https://github.com/python/cpython/issues/119518}: Speed up normalization of @ref{54e,,pathlib.PurePath} and
@ref{19b,,Path} objects by not interning string parts.

@item 
gh-123270@footnote{https://github.com/python/cpython/issues/123270}: Applied a more surgical fix for malformed payloads in
@ref{76a,,zipfile.Path} causing infinite loops (gh-122905@footnote{https://github.com/python/cpython/issues/122905}) without breaking
contents using legitimate characters.

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: Add @ref{19d,,pathlib.Path.copy_into()} and
@ref{19f,,move_into()}, which copy and move files and directories
into `existing' directories.

@item 
gh-123228@footnote{https://github.com/python/cpython/issues/123228}: Fix return type for
@code{_pyrepl.readline._ReadlineWrapper.get_line_buffer()} to be
@ref{237,,str()}.  Patch by Sergey B Kirpichev.

@item 
gh-123240@footnote{https://github.com/python/cpython/issues/123240}: Raise audit events for the @ref{1340,,input()} in the new REPL.

@item 
gh-76960@footnote{https://github.com/python/cpython/issues/76960}: Fix @ref{f17,,urllib.parse.urljoin()} and
@ref{12b5,,urllib.parse.urldefrag()} for URIs containing empty components. For
example, @code{urljoin()} with relative reference «?» now sets empty query
and removes fragment. Preserve empty components (authority, params, query,
fragment) in @code{urljoin()}. Preserve empty components (authority,
params, query) in @code{urldefrag()}.

@item 
gh-116810@footnote{https://github.com/python/cpython/issues/116810}: Resolve a memory leak introduced in CPython 3.10’s @ref{d0,,ssl}
when the @ref{15d4,,ssl.SSLSocket.session} property was accessed.  Speeds up
read and write access to said property by no longer unnecessarily cloning
session objects via serialization.

@item 
gh-123243@footnote{https://github.com/python/cpython/issues/123243}: Fix memory leak in @code{_decimal}.

@item 
gh-122546@footnote{https://github.com/python/cpython/issues/122546}: Consistently use same file name for different exceptions in the
new repl. Patch by Sergey B Kirpichev.

@item 
gh-123213@footnote{https://github.com/python/cpython/issues/123213}: @ref{1240,,xml.etree.ElementTree.Element.extend()} and
@ref{20b,,Element} assignment no longer hide the
internal exception if an erroneous generator is passed. Patch by Bar
Harel.

@item 
gh-85110@footnote{https://github.com/python/cpython/issues/85110}: Preserve relative path in URL without netloc in
@ref{15d5,,urllib.parse.urlunsplit()} and @ref{15d6,,urllib.parse.urlunparse()}.

@item 
gh-123165@footnote{https://github.com/python/cpython/issues/123165}: Add support for rendering @ref{15d7,,Positions} in
@ref{39,,dis}.

@item 
gh-122909@footnote{https://github.com/python/cpython/issues/122909}: In urllib.request when URLError is raised opening an ftp URL,
the exception argument is now consistently a string. Earlier versions
passed either a string or an ftplib exception instance as the argument to
URLError.

@item 
gh-123084@footnote{https://github.com/python/cpython/issues/123084}: Deprecate @code{shutil.ExecError}, which hasn’t been raised
by any @ref{c5,,shutil} function since Python 3.4. It’s now an alias for
@ref{1e5,,RuntimeError}.

@item 
gh-123085@footnote{https://github.com/python/cpython/issues/123085}: In a bare call to @ref{537,,importlib.resources.files()}, ensure the
caller’s frame is properly detected when @code{importlib.resources} is itself
available as a compiled module only (no source).

@item 
gh-123067@footnote{https://github.com/python/cpython/issues/123067}: Fix quadratic complexity in parsing @code{"}-quoted cookie values
with backslashes by @ref{71,,http.cookies}.

@item 
gh-123049@footnote{https://github.com/python/cpython/issues/123049}: Add support for @ref{15d8,,UNNAMED_SECTION} in
@ref{12db,,configparser.ConfigParser.add_section()}.

@item 
gh-121735@footnote{https://github.com/python/cpython/issues/121735}: When working with zip archives, importlib.resources now
properly honors module-adjacent references (e.g. @code{files(pkg.mod)} and
not just @code{files(pkg)}).

@item 
gh-122981@footnote{https://github.com/python/cpython/issues/122981}: Fix @ref{15ce,,inspect.getsource()} for generated classes with Python
base classes (e.g. enums).

@item 
gh-122903@footnote{https://github.com/python/cpython/issues/122903}: @code{zipfile.Path.glob} now correctly matches directories instead
of silently omitting them.

@item 
gh-122905@footnote{https://github.com/python/cpython/issues/122905}: @ref{76a,,zipfile.Path} objects now sanitize names from the
zipfile.

@item 
gh-122873@footnote{https://github.com/python/cpython/issues/122873}: Enable @ref{82,,json} module to work as a script using the
@ref{187,,-m} switch: @code{python -m json}. See the @ref{188,,JSON command-line interface} documentation. Patch by Trey Hunner.

@item 
gh-122858@footnote{https://github.com/python/cpython/issues/122858}: Deprecate @code{asyncio.iscoroutinefunction()} in favor of
@ref{1c3,,inspect.iscoroutinefunction()}.

@item 
gh-116263@footnote{https://github.com/python/cpython/issues/116263}: @ref{15d9,,logging.handlers.RotatingFileHandler} no longer rolls
over empty log files.

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: Restore the deprecated @ref{87,,logging} @code{warn()} method. It was
removed in Python 3.13 alpha 1. Keep the deprecated @code{warn()} method in
Python 3.13. Patch by Victor Stinner.

@item 
gh-122311@footnote{https://github.com/python/cpython/issues/122311}: Improve errors in the @ref{a6,,pickle} module.
@ref{15da,,PicklingError} is now raised more often instead of
@ref{718,,UnicodeEncodeError}, @ref{360,,ValueError} and @ref{441,,AttributeError},
and the original exception is chained to it. Improve and unify error
messages in Python and C implementations.

@item 
gh-122744@footnote{https://github.com/python/cpython/issues/122744}: Bump the version of pip bundled in ensurepip to version 24.2.

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: Improve import time of @ref{ae,,pprint} by around seven times.
Patch by Hugo van Kemenade.

@item 
gh-118974@footnote{https://github.com/python/cpython/issues/118974}: Add @code{decorator} parameter to
@ref{15db,,dataclasses.make_dataclass()} to customize the functional creation of
dataclasses.

@item 
gh-118814@footnote{https://github.com/python/cpython/issues/118814}: Fix the @ref{2c9,,typing.TypeVar} constructor when name is passed
by keyword.

@item 
gh-122637@footnote{https://github.com/python/cpython/issues/122637}: Adjust @code{cmath.tanh(nanj)} and @code{cmath.tanh(infj)} for recent
C standards.

@item 
gh-122478@footnote{https://github.com/python/cpython/issues/122478}: Remove internal frames from tracebacks shown in
@ref{15dc,,code.InteractiveInterpreter} with non-default
@ref{8a2,,sys.excepthook()}. Save correct tracebacks in
@ref{568,,sys.last_traceback} and update @code{__traceback__} attribute of
@ref{567,,sys.last_value} and @ref{565,,sys.last_exc}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: On Android, the @code{FICLONE} and @code{FICLONERANGE} constants are
no longer exposed by @ref{59,,fcntl}, as these ioctls are blocked by SELinux.

@item 
gh-82378@footnote{https://github.com/python/cpython/issues/82378}: Make sure that the new @ref{2d6,,REPL} interprets
@ref{15dd,,sys.tracebacklimit} in the same way that the classic REPL did.

@item 
gh-122334@footnote{https://github.com/python/cpython/issues/122334}: Fix crash when importing @ref{d0,,ssl} after the main interpreter
restarts.

@item 
gh-122459@footnote{https://github.com/python/cpython/issues/122459}: Optimize @ref{a6,,pickling} by name objects without the
@code{__module__} attribute.

@item 
gh-87320@footnote{https://github.com/python/cpython/issues/87320}: In @ref{15dc,,code.InteractiveInterpreter}, handle exceptions
caused by calling a non-default @ref{8a2,,sys.excepthook()}. Before, the
exception bubbled up to the caller, ending the @ref{2d6,,REPL}.

@item 
gh-122272@footnote{https://github.com/python/cpython/issues/122272}: On some platforms such as Linux, year with century was not
0-padded when formatted by @ref{d19,,strftime()} with C99-specific
specifiers @code{'%C'} or @code{'%F'}. The 0-padding behavior is now guaranteed
when the format specifiers @code{'%C'} and @code{'%F'} are supported by the C
library. Patch by Ben Hsing

@item 
gh-122400@footnote{https://github.com/python/cpython/issues/122400}: Handle @ref{360,,ValueError}s raised by @ref{548,,os.stat()} in
@ref{fc0,,filecmp.dircmp} and @ref{15de,,filecmp.cmpfiles()}. Patch by Bénédikt
Tran.

@item 
gh-122311@footnote{https://github.com/python/cpython/issues/122311}: Fix some error messages in @ref{a6,,pickle}.

@item 
gh-121650@footnote{https://github.com/python/cpython/issues/121650}: @ref{3c,,email} headers with embedded newlines are now quoted on
output. The @ref{41,,generator} will now refuse to serialize (write)
headers that are unsafely folded or delimited; see
@ref{343,,verify_generated_headers}. (Contributed by Bas
Bloemsaat and Petr Viktorin in gh-121650@footnote{https://github.com/python/cpython/issues/121650}.)

@item 
gh-122332@footnote{https://github.com/python/cpython/issues/122332}: Fixed segfault with @ref{a6d,,asyncio.Task.get_coro()} when using an
eager task factory.

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: @ref{3ed,,ctypes.ARRAY()} is now @ref{1c4,,soft deprecated}: it no
longer emits deprecation warnings and is not scheduled for removal.

@item 
gh-122213@footnote{https://github.com/python/cpython/issues/122213}: Add notes for pickle serialization errors that allow to
identify the source of the error.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: As part of 
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}, add the following attributes for
customizing evaluation of annotation scopes:


@itemize *

@item 
@code{evaluate_value} on @ref{501,,typing.TypeAliasType}

@item 
@code{evaluate_bound}, @code{evaluate_constraints}, and @code{evaluate_default} on @ref{2c9,,typing.TypeVar}

@item 
@code{evaluate_default} on @ref{2ca,,typing.ParamSpec}

@item 
@code{evaluate_default} on @ref{2cb,,typing.TypeVarTuple}
@end itemize

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: Fix handling of classes with custom metaclasses in
@code{annotationlib.get_annotations}.

@item 
gh-122170@footnote{https://github.com/python/cpython/issues/122170}: Handle @ref{360,,ValueError}s raised by @ref{548,,os.stat()} in
@ref{85,,linecache}. Patch by Bénédikt Tran.

@item 
gh-122163@footnote{https://github.com/python/cpython/issues/122163}: Add notes for JSON serialization errors that allow to identify
the source of the error.

@item 
gh-122129@footnote{https://github.com/python/cpython/issues/122129}: Improve support of method descriptors and wrappers in the help
title.

@item 
gh-122145@footnote{https://github.com/python/cpython/issues/122145}: Fix an issue when reporting tracebacks corresponding to Python
code emitting an empty AST body. Patch by Nikita Sobolev and Bénédikt
Tran.

@item 
gh-121723@footnote{https://github.com/python/cpython/issues/121723}: Make @ref{121e,,logging.config.dictConfig()} accept any object
implementing the Queue public API. See the @ref{15df,,queue configuration} section for details. Patch by Bénédikt Tran.

@item 
gh-82951@footnote{https://github.com/python/cpython/issues/82951}: Serializing objects with complex @code{__qualname__} (such as
unbound methods and nested classes) by name no longer involves serializing
parent objects by value in pickle protocols < 4.

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: @code{Pathlib.read_bytes} no longer opens the file in Python’s
buffered I/O mode. This reduces overheads as the code reads a file in
whole leading to a modest speedup.

@item 
gh-113785@footnote{https://github.com/python/cpython/issues/113785}: @ref{2a,,csv} now correctly parses numeric fields (when used with
@ref{15e0,,csv.QUOTE_NONNUMERIC} or @ref{52e,,csv.QUOTE_STRINGS}) which start
with an escape character.

@item 
gh-122088@footnote{https://github.com/python/cpython/issues/122088}: @ref{2cc,,@@warnings.deprecated} now copies
the coroutine status of functions and methods so that
@ref{1c3,,inspect.iscoroutinefunction()} returns the correct result.

@item 
gh-122081@footnote{https://github.com/python/cpython/issues/122081}: Fix a crash in the @code{decimal.IEEEContext()} optional
function available via the @code{EXTRA_FUNCTIONALITY} configuration flag.

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: Add @ref{19e,,pathlib.Path.move()}, which moves a file or directory
tree.

@item 
gh-121268@footnote{https://github.com/python/cpython/issues/121268}: Remove workarounds for non-IEEE 754 systems in @ref{19,,cmath}.

@item 
gh-119698@footnote{https://github.com/python/cpython/issues/119698}: Due to the lack of interest for
@ref{1c7,,symtable.Class.get_methods()}, the method is marked as deprecated and
will be removed in Python 3.16. Patch by Bénédikt Tran.

@item 
gh-121889@footnote{https://github.com/python/cpython/issues/121889}: Adjusts @code{cmath.acosh(complex('0+nanj'))} for recent C
standards.

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: Correctly show error locations, when @ref{150,,SyntaxError} raised
in new repl. Patch by Sergey B Kirpichev.

@item 
gh-121797@footnote{https://github.com/python/cpython/issues/121797}: Add alternative @ref{177,,Fraction} constructor
@ref{178,,Fraction.from_number()}.

@item 
gh-121798@footnote{https://github.com/python/cpython/issues/121798}: Add alternative @ref{16a,,Decimal} constructor
@ref{16b,,Decimal.from_number()}.

@item 
gh-120930@footnote{https://github.com/python/cpython/issues/120930}: Fixed a bug introduced by gh-92081@footnote{https://github.com/python/cpython/issues/92081} that added an incorrect
extra blank to encoded words occurring in wrapped headers.

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: The `shallow' argument to @ref{fc0,,filecmp.dircmp} (new in Python
3.13) is now keyword-only.

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: Simplify handling of the history file in
@code{site.register_readline()} helper. The @code{CAN_USE_PYREPL} variable now
will be initialized, when imported.  Patch by Sergey B Kirpichev.

@item 
gh-121249@footnote{https://github.com/python/cpython/issues/121249}: Support the float complex and double complex C types in the @ref{d5,,struct} module if the compiler has C11
complex arithmetic.  Patch by Sergey B Kirpichev.

@item 
gh-121486@footnote{https://github.com/python/cpython/issues/121486}: @ref{8e,,math} functions @ref{a97,,isqrt()}, @ref{14fc,,log()},
@ref{114f,,log2()} and @ref{15e1,,log10()} now support integers larger
than @code{2**2**32} on 32-bit platforms.

@item 
gh-121474@footnote{https://github.com/python/cpython/issues/121474}: Fix missing sanity check for @code{parties} arg in
@ref{1250,,threading.Barrier} constructor. Patch by Clinton Christian
(pygeek).

@item 
gh-121450@footnote{https://github.com/python/cpython/issues/121450}: Hard-coded breakpoints (@ref{1a6,,breakpoint()} and
@ref{1a7,,pdb.set_trace()}) now reuse the most recent @code{Pdb} instance that
calls @code{Pdb.set_trace()}, instead of creating a new one each time. As a
result, all the instance specific data like @code{display} and @code{commands}
are preserved across Hard-coded breakpoints.

@item 
gh-119169@footnote{https://github.com/python/cpython/issues/119169}: Slightly speed up @ref{551,,os.walk()} by simplifying exception
handling.

@item 
gh-121423@footnote{https://github.com/python/cpython/issues/121423}: Improve import time of @ref{cc,,socket} by lazy importing modules
and writing @code{socket.errorTab} as a constant.

@item 
gh-59110@footnote{https://github.com/python/cpython/issues/59110}: @ref{131,,zipimport} supports now namespace packages when no
directory entry exists.

@item 
gh-119004@footnote{https://github.com/python/cpython/issues/119004}: Fix a crash in @ref{15e2,,OrderedDict.__eq__} when operands are mutated during the
check. Patch by Bénédikt Tran.

@item 
gh-121313@footnote{https://github.com/python/cpython/issues/121313}: Limit the reading size in the
@ref{15e3,,multiprocessing.connection.Connection} class to 64 KiB to prevent
memory overallocation and unnecessary memory management system calls.

@item 
gh-121332@footnote{https://github.com/python/cpython/issues/121332}: Fix constructor of @ref{9,,ast} nodes with custom
@code{_attributes}. Previously, passing custom attributes would raise a
@ref{1da,,DeprecationWarning}. Passing arguments to the constructor that
are not in @code{_fields} or @code{_attributes} remains deprecated. Patch by
Jelle Zijlstra.

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: Fix a bug in the handling of the command history of the new
@ref{2d6,,REPL} that caused the history file to be wiped at REPL exit.

@item 
gh-121210@footnote{https://github.com/python/cpython/issues/121210}: Handle AST nodes with missing runtime fields or attributes in
@ref{15e,,ast.compare()}. Patch by Bénédikt Tran.

@item 
gh-121163@footnote{https://github.com/python/cpython/issues/121163}: Add support for @code{all} as an valid @code{action} for
@ref{762,,warnings.simplefilter()} and @ref{14e5,,warnings.filterwarnings()}.

@item 
gh-121151@footnote{https://github.com/python/cpython/issues/121151}: Fix wrapping of long usage text of arguments inside a mutually
exclusive group in @ref{7,,argparse}.

@item 
gh-121141@footnote{https://github.com/python/cpython/issues/121141}: Add support for @ref{15f,,copy.replace()} to AST nodes. Patch by
Bénédikt Tran.

@item 
gh-87744@footnote{https://github.com/python/cpython/issues/87744}: Fix waitpid race while calling
@ref{15e4,,send_signal()} in asyncio. Patch by Kumar
Aditya.

@item 
gh-121027@footnote{https://github.com/python/cpython/issues/121027}: Add a future warning in @code{functools.partial.__get__()}. In
future Python versions @ref{17a,,functools.partial} will be a method
descriptor.

@item 
gh-121027@footnote{https://github.com/python/cpython/issues/121027}: Make the @ref{17a,,functools.partial} object a method descriptor.

@item 
gh-117784@footnote{https://github.com/python/cpython/issues/117784}: CPython now detects whether its linked TLS library supports
TLSv1.3 post-handshake authentication and disables that feature if support
is lacking.

@item 
gh-121025@footnote{https://github.com/python/cpython/issues/121025}: Improve the @ref{6bd,,__repr__()} of
@ref{17b,,functools.partialmethod}. Patch by Bénédikt Tran.

@item 
gh-121018@footnote{https://github.com/python/cpython/issues/121018}: Fixed issues where @code{argparse.ArgumentParser.parse_args()}
did not honor @code{exit_on_error=False}. Based on patch by Ben Hsing.

@item 
gh-119614@footnote{https://github.com/python/cpython/issues/119614}: Fix truncation of strings with embedded null characters in some
internal operations in @ref{f0,,tkinter}.

@item 
gh-120910@footnote{https://github.com/python/cpython/issues/120910}: When reading installed files from an egg, use
@code{relative_to(walk_up=True)} to honor files installed outside of the
installation root.

@item 
gh-61103@footnote{https://github.com/python/cpython/issues/61103}: Support float complex, double complex and
long double complex C types in @ref{2b,,ctypes} as
@ref{15e5,,c_float_complex}, @ref{15e6,,c_double_complex} and
@ref{15e7,,c_longdouble_complex} if the compiler has C11 complex
arithmetic. Patch by Sergey B Kirpichev.

@item 
gh-120888@footnote{https://github.com/python/cpython/issues/120888}: Upgrade pip wheel bundled with ensurepip (pip 24.1.1)

@item 
gh-101830@footnote{https://github.com/python/cpython/issues/101830}: Accessing the @ref{f0,,tkinter} object’s string representation no
longer converts the underlying Tcl object to a string on Windows.

@item 
gh-120678@footnote{https://github.com/python/cpython/issues/120678}: Fix regression in the new REPL that meant that globals from
files passed using the @code{-i} argument would not be included in the REPL’s
global namespace. Patch by Alex Waygood.

@item 
gh-120811@footnote{https://github.com/python/cpython/issues/120811}: Fix possible memory leak in @ref{15e8,,contextvars.Context.run()}.

@item 
gh-120782@footnote{https://github.com/python/cpython/issues/120782}: Fix wrong references of the @ref{31,,datetime} types after
reloading the module.

@item 
gh-120713@footnote{https://github.com/python/cpython/issues/120713}: @ref{d19,,datetime.datetime.strftime()} now 0-pads years with less
than four digits for the format specifiers @code{%Y} and @code{%G} on Linux.
Patch by Ben Hsing

@item 
gh-120769@footnote{https://github.com/python/cpython/issues/120769}: Make empty line in @ref{a5,,pdb} repeats the last command even
when the command is from @code{cmdqueue}.

@item 
gh-120780@footnote{https://github.com/python/cpython/issues/120780}: Show string value of LOAD_SPECIAL oparg in @ref{39,,dis} output.

@item 
gh-41431@footnote{https://github.com/python/cpython/issues/41431}: Add @ref{16d,,datetime.time.strptime()} and
@ref{16e,,datetime.date.strptime()}. Contributed by Wannes Boeykens.

@item 
gh-120743@footnote{https://github.com/python/cpython/issues/120743}: @ref{1c4,,Soft deprecate} @ref{1c5,,os.popen()} and
@ref{1c6,,os.spawn*} functions. They should no longer be used to
write new code. The @ref{d6,,subprocess} module is recommended instead. Patch
by Victor Stinner.

@item 
gh-120732@footnote{https://github.com/python/cpython/issues/120732}: Fix @code{name} passing to @ref{ade,,unittest.mock.Mock} object when
using @ref{15c9,,unittest.mock.create_autospec()}.

@item 
gh-111259@footnote{https://github.com/python/cpython/issues/111259}: @ref{b9,,re} now handles patterns like @code{"[\s\S]"} or @code{"\s|\S"}
which match any character as effectively as a dot with the @code{DOTALL}
modifier (@code{"(?s:.)"}).

@item 
gh-120683@footnote{https://github.com/python/cpython/issues/120683}: Fix an error in @ref{1065,,logging.LogRecord}, when the integer
part of the timestamp is rounded up, while the millisecond calculation
truncates, causing the log timestamp to be wrong by up to 999 ms (affected
roughly 1 in 8 million timestamps).

@item 
gh-118710@footnote{https://github.com/python/cpython/issues/118710}: @ref{35a,,ipaddress.IPv4Address} and
@ref{35b,,ipaddress.IPv6Address} attributes @code{version} and
@code{max_prefixlen} are now available on the class.

@item 
gh-120633@footnote{https://github.com/python/cpython/issues/120633}: Move scrollbar and remove tear-off menus in turtledemo.

@item 
gh-120606@footnote{https://github.com/python/cpython/issues/120606}: Allow users to use EOF to exit @code{commands} definition in
@ref{a5,,pdb}

@item 
gh-120284@footnote{https://github.com/python/cpython/issues/120284}: Allow @ref{15e9,,asyncio.Runner.run()} to accept @ref{314,,awaitable}
objects instead of simply @ref{53a,,coroutine}s.

@item 
gh-120541@footnote{https://github.com/python/cpython/issues/120541}: Improve the prompt in the «less» pager when @ref{96e,,help()} is
called with non-string argument.

@item 
gh-120495@footnote{https://github.com/python/cpython/issues/120495}: Fix incorrect exception handling in Tab Nanny. Patch by
Wulian233.

@item 
gh-120388@footnote{https://github.com/python/cpython/issues/120388}: Improve a warning message when a test method in @ref{106,,unittest}
returns something other than @code{None}. Now we show the returned object
type and optional asyncio-related tip.

@item 
gh-120381@footnote{https://github.com/python/cpython/issues/120381}: Correct @ref{15ea,,inspect.ismethoddescriptor()} to check also for
the lack of @ref{15eb,,__delete__()}.  Patch by Jan Kaliszewski.

@item 
gh-90425@footnote{https://github.com/python/cpython/issues/90425}: The OS byte in gzip headers is now always set to 255 when using
@ref{6df,,gzip.compress()}.

@item 
gh-120343@footnote{https://github.com/python/cpython/issues/120343}: Fix column offset reporting for tokens that come after
multiline f-strings in the @ref{fb,,tokenize} module.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: As part of implementing 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} and 
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}, add a new
module @code{annotationlib}. Add support for unresolved forward references in
annotations to @ref{30,,dataclasses}, @ref{2ce,,typing.TypedDict}, and
@ref{1db,,typing.NamedTuple}.

@item 
gh-119600@footnote{https://github.com/python/cpython/issues/119600}: Fix @ref{f13,,unittest.mock.patch()} to not read attributes of the
target when @code{new_callable} is set. Patch by Robert Collins.

@item 
gh-120289@footnote{https://github.com/python/cpython/issues/120289}: Fixed the use-after-free issue in @ref{28,,cProfile} by
disallowing @code{disable()} and @code{clear()} in external timers.

@item 
gh-82017@footnote{https://github.com/python/cpython/issues/82017}: Added support for converting any objects that have the
@code{as_integer_ratio()} method to a @ref{177,,Fraction}.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Fix edge-case bug where @ref{752,,typing.get_type_hints()} would
produce incorrect results if type parameters in a class scope were
overridden by assignments in a class scope and @code{from __future__ import
annotations} semantics were enabled. Patch by Alex Waygood.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Fix erroneous @ref{4ec,,NameError} when calling
@ref{8aa,,inspect.get_annotations()} with @code{eval_str=True`} on a class that
made use of 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} type parameters in a module that had @code{from
__future__ import annotations} at the top of the file. Patch by Alex
Waygood.

@item 
gh-120268@footnote{https://github.com/python/cpython/issues/120268}: Prohibit passing @code{None} to pure-Python
@ref{15cc,,datetime.date.fromtimestamp()} to achieve consistency with
C-extension implementation.

@item 
gh-120244@footnote{https://github.com/python/cpython/issues/120244}: Fix memory leak in @ref{3f2,,re.sub()} when the replacement string
contains backreferences.

@item 
gh-120254@footnote{https://github.com/python/cpython/issues/120254}: Added @code{commands} argument to @ref{1a7,,pdb.set_trace()} which
allows users to send debugger commands from the source file.

@item 
gh-120211@footnote{https://github.com/python/cpython/issues/120211}: Fix @ref{f9,,tkinter.ttk} with Tcl/Tk 9.0.

@item 
gh-71587@footnote{https://github.com/python/cpython/issues/71587}: Fix crash in C version of @ref{15ec,,datetime.datetime.strptime()}
when called again on the restarted interpreter.

@item 
gh-117983@footnote{https://github.com/python/cpython/issues/117983}: Defer the @code{threading} import in @code{importlib.util} until lazy
loading is used.

@item 
gh-120157@footnote{https://github.com/python/cpython/issues/120157}: Remove unused constant
@code{concurrent.futures._base._FUTURE_STATES} in @ref{22,,concurrent.futures}.
Patch by Clinton Christian (pygeek).

@item 
gh-120161@footnote{https://github.com/python/cpython/issues/120161}: @ref{31,,datetime} no longer crashes in certain complex reference
cycle situations.

@item 
gh-119698@footnote{https://github.com/python/cpython/issues/119698}: Fix @ref{1c7,,symtable.Class.get_methods()} and document its
behaviour. Patch by Bénédikt Tran.

@item 
gh-120121@footnote{https://github.com/python/cpython/issues/120121}: Add @ref{15ed,,concurrent.futures.InvalidStateError} to module’s
@code{__all__}.

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: Add the @ref{15ee,,symtable.SymbolTableType} enumeration to
represent the possible outputs of the
@ref{15ef,,symtable.SymbolTable.get_type} method. Patch by Bénédikt Tran.

@item 
gh-120029@footnote{https://github.com/python/cpython/issues/120029}: Expose @ref{1b0,,symtable.Symbol} methods
@ref{1b3,,is_free_class()},
@ref{1b2,,is_comp_iter()} and
@ref{1b1,,is_comp_cell()}. Patch by Bénédikt Tran.

@item 
gh-120108@footnote{https://github.com/python/cpython/issues/120108}: Fix calling @ref{bf6,,copy.deepcopy()} on @ref{9,,ast} trees that have
been modified to have references to parent nodes. Patch by Jelle Zijlstra.

@item 
gh-120056@footnote{https://github.com/python/cpython/issues/120056}: Add @code{socket.IP_RECVERR} and @code{socket.IP_RECVTTL}
constants (both available since Linux 2.2). And
@code{socket.IP_RECVORIGDSTADDR} constant (available since Linux
2.6.29).

@item 
gh-112672@footnote{https://github.com/python/cpython/issues/112672}: Support building @ref{f0,,tkinter} with Tcl 9.0.

@item 
gh-120057@footnote{https://github.com/python/cpython/issues/120057}: Added the @ref{196,,os.environ.refresh()} method to
update @ref{196,,os.environ} with changes to the environment made by
@ref{198,,os.putenv()}, by @ref{199,,os.unsetenv()}, or made outside Python in the
same process. Patch by Victor Stinner.

@item 
gh-120029@footnote{https://github.com/python/cpython/issues/120029}: Expose @ref{15f0,,symtable.Symbol.is_type_parameter()} in the
@ref{d8,,symtable} module. Patch by Bénédikt Tran.

@item 
gh-119819@footnote{https://github.com/python/cpython/issues/119819}: Fix regression to allow logging configuration with
multiprocessing queue types.

@item 
gh-65454@footnote{https://github.com/python/cpython/issues/65454}: @ref{15f1,,unittest.mock.Mock.attach_mock()} no longer triggers a call
to a @code{PropertyMock} being attached.

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: The @ref{2b,,ctypes} module may now be imported in all
subinterpreters, including those that have their own GIL.

@item 
gh-118835@footnote{https://github.com/python/cpython/issues/118835}: Fix _pyrepl crash when using custom prompt with ANSI escape
codes.

@item 
gh-81936@footnote{https://github.com/python/cpython/issues/81936}: @code{help()} and @code{showtopic()} methods now respect a
configured `output' argument to @code{pydoc.Helper} and not use the
pager in such cases. Patch by Enrico Tröger.

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: The @code{_datetime} module (C implementation for @ref{31,,datetime})
now supports being imported in multiple interpreters.

@item 
gh-119824@footnote{https://github.com/python/cpython/issues/119824}: Print stack entry in @ref{a5,,pdb} when and only when user input
is needed.

@item 
gh-119838@footnote{https://github.com/python/cpython/issues/119838}: In mixed arithmetic operations with
@ref{177,,Fraction} and complex, the fraction is now converted to
@ref{153,,float} instead of @ref{154,,complex}.

@item 
gh-119770@footnote{https://github.com/python/cpython/issues/119770}: Make @ref{e1,,termios} @code{ioctl()} constants positive. Patch by
Victor Stinner.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Fix issue with @ref{1f9,,shutil.rmtree()} where a
@ref{df1,,RecursionError} is raised on deep directory trees.

@item 
gh-119577@footnote{https://github.com/python/cpython/issues/119577}: The @ref{1da,,DeprecationWarning} emitted when testing the truth
value of an @ref{20b,,xml.etree.ElementTree.Element} now describes
unconditionally returning @code{True} in a future version rather than raising
an exception in Python 3.14.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Partially fix issue with @ref{1f9,,shutil.rmtree()} where a
@ref{df1,,RecursionError} is raised on deep directory trees. A recursion error
is no longer raised when @code{rmtree.avoids_symlink_attacks} is false.

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: Remove deprecated names from @code{importlib.abc} as found in
@code{importlib.resources.abc}.

@item 
gh-119118@footnote{https://github.com/python/cpython/issues/119118}: Fix performance regression in the @ref{fb,,tokenize} module by
caching the @code{line} token attribute and calculating the column offset
more efficiently.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Fix issue with @ref{be3,,os.fwalk()} where a @ref{df1,,RecursionError}
was raised on deep directory trees by adjusting the implementation to be
iterative instead of recursive.

@item 
gh-119594@footnote{https://github.com/python/cpython/issues/119594}: If one calls pow(fractions.Fraction, x, module) with modulo not
None, the error message now says that the types are incompatible rather
than saying pow only takes 2 arguments. Patch by Wim Jeantine-Glenn and
Mark Dickinson.

@item 
gh-119588@footnote{https://github.com/python/cpython/issues/119588}: @code{zipfile.Path.is_symlink} now assesses if the given path is a
symlink.

@item 
gh-119562@footnote{https://github.com/python/cpython/issues/119562}: Remove @code{ast.Num}, @code{ast.Str},
@code{ast.Bytes}, @code{ast.NameConstant} and
@code{ast.Ellipsis}. They had all emitted deprecation warnings since
Python 3.12. Patch by Alex Waygood.

@item 
gh-119555@footnote{https://github.com/python/cpython/issues/119555}: Catch @ref{150,,SyntaxError} from @ref{2fb,,compile()} in the
runsource() method of the InteractiveColoredConsole.  Patch by Sergey B
Kirpichev.

@item 
gh-118908@footnote{https://github.com/python/cpython/issues/118908}: Limit exposed globals from internal imports and definitions on
new REPL startup. Patch by Eugene Triguba and Pablo Galindo.

@item 
gh-117865@footnote{https://github.com/python/cpython/issues/117865}: Improve the import time of the @ref{9,,ast} module by deferring
the import of @ref{b9,,re}. Patch by Jelle Zijlstra.

@item 
gh-119127@footnote{https://github.com/python/cpython/issues/119127}: Positional arguments of @ref{17a,,functools.partial()} objects now
support placeholders via @ref{17c,,functools.Placeholder}.

@item 
gh-113892@footnote{https://github.com/python/cpython/issues/113892}: Now, the method @code{sock_connect} of
@ref{6aa,,asyncio.ProactorEventLoop} raises a @ref{360,,ValueError} if given
socket is not in non-blocking mode, as well as in other loop
implementations.

@item 
gh-119506@footnote{https://github.com/python/cpython/issues/119506}: Fix @code{io.TextIOWrapper.write()} method breaks internal
buffer when the method is called again during flushing internal buffer.

@item 
gh-69214@footnote{https://github.com/python/cpython/issues/69214}: Fix @code{fcntl.ioctl()} `request' parameter: use an @code{unsigned
long} instead of an @code{unsigned int} for the `request' parameter of
@ref{14b6,,fcntl.ioctl()} to support requests larger than @code{UINT_MAX}. Patch by
Victor Stinner.

@item 
gh-119105@footnote{https://github.com/python/cpython/issues/119105}: @code{difflib}’s @code{DIffer.compare()} (and so also @code{ndiff}) can
no longer be provoked into cubic-time behavior, or into unbounded
recursion, and should generally be faster in ordinary cases too. Results
may change in some cases, although that should be rare. Correctness of
diffs is not affected. Some similar lines far apart may be reported as
deleting one and adding the other, where before they were displayed on
adjacent output lines with markup showing the intraline differences.

@item 
gh-119443@footnote{https://github.com/python/cpython/issues/119443}: The interactive REPL no longer runs with @code{from __future__
import annotations} enabled. Patch by Jelle Zijlstra.

@item 
gh-119461@footnote{https://github.com/python/cpython/issues/119461}: Add @code{socket.VMADDR_CID_LOCAL} constant. Patch by Victor
Stinner.

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: Objects in the datetime C-API are now all statically allocated,
which means better memory safety, especially when the module is reloaded.
This should be transparent to users.

@item 
gh-118894@footnote{https://github.com/python/cpython/issues/118894}: @ref{b,,asyncio} REPL now has the same capabilities as PyREPL.

@item 
gh-118830@footnote{https://github.com/python/cpython/issues/118830}: Bump @ref{a6,,pickle} default protocol to @code{5}.

@item 
gh-118911@footnote{https://github.com/python/cpython/issues/118911}: In PyREPL, updated @code{maybe-accept}’s logic so that if the user
hits @code{Enter} twice, they are able to terminate the block even if
there’s trailing whitespace. Also, now when the user hits arrow up, the
cursor is on the last functional line. This matches IPython’s behavior.
Patch by Aya Elsayed.

@item 
gh-115225@footnote{https://github.com/python/cpython/issues/115225}: Raise error on certain technically valid but pathological ISO
8601 strings passed to @ref{6b6,,datetime.time.fromisoformat()} that were
previously parsed incorrectly.

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: Remove dependency to @ref{ba,,readline} from the new Python REPL.

@item 
gh-119189@footnote{https://github.com/python/cpython/issues/119189}: When using the @code{**} operator or @ref{a64,,pow()} with
@ref{177,,Fraction} as the base and an exponent that is not
rational, a float, or a complex, the fraction is no longer converted to a
float.

@item 
gh-119174@footnote{https://github.com/python/cpython/issues/119174}: Fix high DPI causes turtledemo(turtle-graphics examples)
windows blurry Patch by Wulian233 and Terry Jan Reedy

@item 
gh-119121@footnote{https://github.com/python/cpython/issues/119121}: Fix a NameError happening in
@code{asyncio.staggered.staggered_race}. This function is now tested.

@item 
gh-119105@footnote{https://github.com/python/cpython/issues/119105}: @code{difflib.Differ} is much faster for some cases of diffs where
many pairs of lines are equally similar.

@item 
gh-119113@footnote{https://github.com/python/cpython/issues/119113}: Fix issue where @ref{15f2,,pathlib.PurePath.with_suffix()} didn’t
raise @ref{228,,TypeError} when given @code{None} as a suffix.

@item 
gh-118643@footnote{https://github.com/python/cpython/issues/118643}: Fix an AttributeError in the @ref{3c,,email} module when re-fold a
long address list. Also fix more cases of incorrect encoding of the
address separator in the address list.

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: Add @ref{19c,,pathlib.Path.copy()}, which copies a file or directory
to another.

@item 
gh-58933@footnote{https://github.com/python/cpython/issues/58933}: Make @ref{a5,,pdb} return to caller frame correctly when
@code{f_trace} of the caller frame is not set

@item 
gh-82805@footnote{https://github.com/python/cpython/issues/82805}: Support single-dot file extensions in
@ref{15f3,,pathlib.PurePath.suffix} and related attributes and methods. For
example, the @ref{15f4,,suffixes} of
@code{PurePath('foo.bar.')} are now @code{['.bar', '.']} rather than @code{[]}.
This brings file extension splitting in line with
@ref{15f5,,os.path.splitext()}.

@item 
gh-118924@footnote{https://github.com/python/cpython/issues/118924}: Remove @code{version} and @code{version_info} from
@ref{cf,,sqlite3}. Patch by Hugo van Kemenade.

@item 
gh-118928@footnote{https://github.com/python/cpython/issues/118928}: Disallow using a sequence of parameters with named placeholders
in @ref{cf,,sqlite3} queries. Patch by Erlend E. Aasland.

@item 
gh-118895@footnote{https://github.com/python/cpython/issues/118895}: Setting attributes on @ref{3b9,,typing.NoDefault} now raises
@ref{441,,AttributeError} instead of @ref{228,,TypeError}.

@item 
gh-118868@footnote{https://github.com/python/cpython/issues/118868}: Fixed issue where kwargs were no longer passed to the logging
handler QueueHandler

@item 
gh-118827@footnote{https://github.com/python/cpython/issues/118827}: Remove deprecated @code{Quoter} class from
@ref{10a,,urllib.parse}. It had previously raised a @ref{1da,,DeprecationWarning}
since Python 3.11. Patch by Nikita Sobolev.

@item 
gh-118824@footnote{https://github.com/python/cpython/issues/118824}: Remove deprecated @code{pty.master_open()} and
@code{pty.slave_open()}. Use @ref{221,,pty.openpty()} instead. Patch by Nikita
Sobolev.

@item 
gh-118851@footnote{https://github.com/python/cpython/issues/118851}: @code{ctx} arguments to the constructors of @ref{9,,ast} node
classes now default to @ref{30c,,ast.Load()}. Patch by Jelle
Zijlstra.

@item 
gh-101588@footnote{https://github.com/python/cpython/issues/101588}: Remove copy, deepcopy, and pickle from itertools. These had
previously raised a DeprecationWarning since Python 3.12.

@item 
gh-118805@footnote{https://github.com/python/cpython/issues/118805}: Remove `type', `choices', and `metavar' parameters of
@code{argparse.BooleanOptionalAction}. They were deprecated since
Python 3.12.

@item 
gh-118803@footnote{https://github.com/python/cpython/issues/118803}: @code{typing.ByteString} and
@code{collections.abc.ByteString} are removed. They had previously
raised a @ref{1da,,DeprecationWarning} since Python 3.12.

@item 
gh-118798@footnote{https://github.com/python/cpython/issues/118798}: The `isdst' parameter has been removed from
@ref{217,,email.utils.localtime()}. Patch by Hugo van Kemenade.

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: Restore the default value of @code{tkiter.wantobjects} to @code{1}.

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: Fix errors in calling Tkinter bindings on Windows.

@item 
gh-74033@footnote{https://github.com/python/cpython/issues/74033}: Drop support for passing keyword arguments to
@ref{19b,,pathlib.Path}.

@item 
gh-101357@footnote{https://github.com/python/cpython/issues/101357}: Suppress all @ref{4d5,,OSError} exceptions from
@ref{aa8,,pathlib.Path.exists()} and @code{is_*()} methods, rather than a
selection of more common errors. The new behaviour is consistent with
@ref{aa0,,os.path.exists()}, @ref{aa2,,os.path.isdir()}, etc. Use
@ref{8ba,,pathlib.Path.stat()} to retrieve the file status without suppressing
exceptions.

@item 
gh-78707@footnote{https://github.com/python/cpython/issues/78707}: Drop support for passing additional positional arguments to
@ref{21d,,pathlib.PurePath.relative_to()} and
@ref{21e,,is_relative_to()}.

@item 
gh-118507@footnote{https://github.com/python/cpython/issues/118507}: Fix @ref{aa3,,os.path.isfile()} on Windows for pipes. Speedup
@ref{54b,,os.path.isjunction()} and @ref{aa1,,os.path.lexists()} on Windows with a
native implementation.

@item 
gh-118772@footnote{https://github.com/python/cpython/issues/118772}: Allow @ref{2c9,,typing.TypeVar} instances without a default to
follow instances without a default in some cases. Patch by Jelle Zijlstra.

@item 
gh-118714@footnote{https://github.com/python/cpython/issues/118714}: Allow @code{restart} in post-mortem debugging of @ref{a5,,pdb}.
Removed restart message when the user quits pdb from post-mortem mode.

@item 
gh-118673@footnote{https://github.com/python/cpython/issues/118673}: Removed executable bits and shebang from stdlib modules.

@item 
gh-110863@footnote{https://github.com/python/cpython/issues/110863}: @ref{381,,os.path.realpath()} now suppresses any @ref{4d5,,OSError} from
@ref{9b4,,os.readlink()} when `strict' mode is disabled (the default).

@item 
gh-118263@footnote{https://github.com/python/cpython/issues/118263}: Speed up @ref{54c,,os.path.splitroot()} & @ref{1382,,os.path.normpath()}
with a direct C call.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Fix ctypes structs with array on SPARC by setting
@code{MAX_STRUCT_SIZE} to 32 in stgdict. Patch by Jakub Kulik

@item 
gh-118033@footnote{https://github.com/python/cpython/issues/118033}: Fix @ref{32e,,dataclasses.dataclass()} not creating a
@code{__weakref__} slot when subclassing @ref{15f6,,typing.Generic}.

@item 
gh-117766@footnote{https://github.com/python/cpython/issues/117766}: Always use @ref{237,,str()} to print @code{choices} in @ref{7,,argparse}.

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: In @ref{7b,,importlib.resources}, sync with importlib_resources 6.3.2@footnote{https://importlib-resources.readthedocs.io/en/latest/history.html#v6-3-2},
including: @code{MultiplexedPath} now expects @code{Traversable} paths,
deprecating string arguments to @code{MultiplexedPath}; Enabled support for
resources in namespace packages in zip files; Fixed @code{NotADirectoryError}
when calling files on a subdirectory of a namespace package.

@item 
gh-115937@footnote{https://github.com/python/cpython/issues/115937}: Removed extra preprocessing for the @code{__signature__}
attribute: the code just check if it’s a @ref{332,,inspect.Signature}
instance.  Patch by Sergey B Kirpichev.

@item 
gh-115808@footnote{https://github.com/python/cpython/issues/115808}: Add @ref{192,,operator.is_none()} and @ref{193,,operator.is_not_none()}
functions.

@item 
gh-114264@footnote{https://github.com/python/cpython/issues/114264}: Improve performance of @ref{bf6,,copy.deepcopy()} by adding a fast
path for atomic types.

@item 
gh-113878@footnote{https://github.com/python/cpython/issues/113878}: Add `doc' parameter to @ref{15f7,,dataclasses.field()}, so it can be
stored and shown as a documentation / metadata. If
@code{@@dataclass(slots=True)} is used, then the supplied string is availabl
in the @ref{152a,,__slots__} dict. Otherwise, the supplied string is
only available in the corresponding @ref{15f8,,dataclasses.Field} object.

In order to support this feature we are changing the @code{__slots__} format
in dataclasses from @ref{464,,tuple} to @ref{190,,dict} when documentation /
metadata is present.

@item 
gh-113978@footnote{https://github.com/python/cpython/issues/113978}: Ignore warnings on text completion inside REPL.

@item 
gh-113008@footnote{https://github.com/python/cpython/issues/113008}: Correct argparse usage output for required, mutually exclusive
groups containing a positional argument

@item 
gh-108172@footnote{https://github.com/python/cpython/issues/108172}: @code{webbrowser} honors OS preferred browser on Linux when its
desktop entry name contains the text of a known browser name.

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: You can now get the raw TLS certificate chains from TLS
connections via @ref{15f9,,ssl.SSLSocket.get_verified_chain()} and
@ref{15fa,,ssl.SSLSocket.get_unverified_chain()} methods.

Contributed by Mateusz Nowak.

@item 
gh-105623@footnote{https://github.com/python/cpython/issues/105623}: Fix performance degradation in
@ref{15d9,,logging.handlers.RotatingFileHandler}. Patch by Craig Robson.

@item 
gh-102450@footnote{https://github.com/python/cpython/issues/102450}: Add missing ISO-8601 24:00 alternative to midnight of next day
to @ref{6b7,,datetime.datetime.fromisoformat()} and
@ref{6b6,,datetime.time.fromisoformat()}. Patch by Izan «TizzySaurus» Robinson
(@email{tizzysaurus@@gmail.com})

@item 
gh-103956@footnote{https://github.com/python/cpython/issues/103956}: Fix lack of newline characters in @ref{fd,,trace} module output
when line tracing is enabled but source code line for current frame is not
available.

@item 
gh-92081@footnote{https://github.com/python/cpython/issues/92081}: Fix missing spaces in email headers when the spaces are mixed
with encoded 8-bit characters.

@item 
gh-103194@footnote{https://github.com/python/cpython/issues/103194}: Prepare Tkinter for C API changes in Tcl 8.7/9.0 to avoid
@code{_tkinter.Tcl_Obj} being unexpectedly returned instead of
@ref{513,,bool}, @ref{237,,str}, @ref{5e0,,bytearray}, or @ref{1f0,,int}.

@item 
gh-87106@footnote{https://github.com/python/cpython/issues/87106}: Fixed handling in @ref{15fb,,inspect.Signature.bind()} of keyword
arguments having the same name as positional-only arguments when a
variadic keyword argument (e.g. @code{**kwargs}) is present.

@item 
gh-103134@footnote{https://github.com/python/cpython/issues/103134}: Add additional methods to @ref{18d,,proxy objects} in the @code{multiprocessing} module:


@itemize *

@item 
@code{clear()} and @code{copy()} for proxies of @ref{18e,,list}

@item 
@ref{18f,,fromkeys()}, @code{reversed(d)}, @code{d | @{@}}, @code{@{@} | d},
@code{d |= @{'b': 2@}} for proxies of @ref{190,,dict}
@end itemize

@item 
bpo-45767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45767}: Fix integer conversion in @ref{15fc,,os.major()}, @ref{15fd,,os.minor()},
and @ref{15fe,,os.makedev()}. Support device numbers larger than @code{2**63-1}.
Support non-existent device number (@code{NODEV}).

@item 
bpo-44864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44864}: Do not translate user-provided strings in
@ref{15c,,argparse.ArgumentParser}.

@item 
bpo-41843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41843}: Solaris now uses @ref{b9a,,os.sendfile()} fast-copy syscall for more
efficient @ref{c5,,shutil} file copy related functions.

@item 
bpo-15987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15987}: Implemented @ref{15e,,ast.compare()} for comparing two ASTs. Patch
by Batuhan Taskaya with some help from Jeremy Hylton.

@item 
gh-67693@footnote{https://github.com/python/cpython/issues/67693}: Fix @ref{15d6,,urllib.parse.urlunparse()} and
@ref{15d5,,urllib.parse.urlunsplit()} for URIs with path starting with multiple
slashes and no authority. Based on patch by Ashwin Ramaswami.

@item 
bpo-14074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14074}: Fix @ref{7,,argparse} metavar processing to allow positional
arguments to have a tuple metavar.
@end itemize

@node IDLE<3>,Documentation<2>,Library<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog idle}@anchor{15ff}
@subsubsection IDLE



@itemize -

@item 
gh-122392@footnote{https://github.com/python/cpython/issues/122392}: Increase currently inadequate vertical spacing for the IDLE
browsers (path, module, and stack) on high-resolution monitors.

@item 
gh-112938@footnote{https://github.com/python/cpython/issues/112938}: Fix uninteruptable hang when Shell gets rapid continuous
output.

@item 
gh-122482@footnote{https://github.com/python/cpython/issues/122482}: Change About IDLE to direct users to discuss.python.org instead
of the now unused idle-dev email and mailing list.

@item 
gh-78889@footnote{https://github.com/python/cpython/issues/78889}: Stop Shell freezes by blocking user access to non-method
sys.stdout.shell attributes, which are all private.

@item 
gh-120083@footnote{https://github.com/python/cpython/issues/120083}: Add explicit black IDLE Hovertip foreground color needed for
recent macOS. Fixes Sonoma showing unreadable white on pale yellow.  Patch
by John Riggles.

@item 
gh-120104@footnote{https://github.com/python/cpython/issues/120104}: Fix padding in config and search dialog windows in IDLE.
@end itemize

@node Documentation<2>,Core and Builtins<2>,IDLE<3>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id7}@anchor{1600}
@subsubsection Documentation



@itemize -

@item 
gh-124872@footnote{https://github.com/python/cpython/issues/124872}: Added definitions for @ref{1601,,context}, @ref{1602,,current context},
and @ref{1603,,context management protocol}, updated related definitions to be
consistent, and expanded the documentation for
@ref{15a0,,contextvars.Context}.

@item 
gh-125018@footnote{https://github.com/python/cpython/issues/125018}: The @ref{7a,,importlib.metadata} documentation now includes
semantic cross-reference targets for the significant documented APIs. This
means intersphinx references like @ref{1604,,importlib.metadata.version()} will
now work as expected.

@item 
gh-124720@footnote{https://github.com/python/cpython/issues/124720}: Update «Using Python on a Mac» section of the «Python Setup and
Usage» document and include information on installing free-threading
support.

@item 
gh-124457@footnote{https://github.com/python/cpython/issues/124457}: Remove coverity scan from the CPython repo. It has not been
used since 2020 and is currently unmaintained.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Add an Android platform guide, and flag modules not available
on Android.

@item 
gh-123976@footnote{https://github.com/python/cpython/issues/123976}: Refresh docs around custom providers.

@item 
gh-70870@footnote{https://github.com/python/cpython/issues/70870}: Clarified the dual usage of the term «free variable» (both the
formal meaning of any reference to names defined outside the local scope,
and the narrower pragmatic meaning of nonlocal variables named in
@code{co_freevars}).

@item 
gh-121277@footnote{https://github.com/python/cpython/issues/121277}: Writers of CPython’s documentation can now use @code{next} as the
version for the @code{versionchanged}, @code{versionadded}, @code{deprecated}
directives.

@item 
gh-117765@footnote{https://github.com/python/cpython/issues/117765}: Improved documentation for @ref{1605,,unittest.mock.patch.dict()}

@item 
gh-121749@footnote{https://github.com/python/cpython/issues/121749}: Fix documentation for @ref{459,,PyModule_AddObjectRef()}.

@item 
gh-120012@footnote{https://github.com/python/cpython/issues/120012}: Clarify the behaviours of @ref{1606,,multiprocessing.Queue.empty()}
and @ref{1607,,multiprocessing.SimpleQueue.empty()} on closed queues. Patch by
Bénédikt Tran.

@item 
gh-119574@footnote{https://github.com/python/cpython/issues/119574}: Added some missing environment variables to the output of
@ref{692,,--help-env}.

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: The @ref{cad,,Py_Main()} documentation moved from the «Very High
Level API» section to the «Initialization and Finalization» section.

Also make it explicit that we expect @code{Py_Main} to typically be called
instead of @code{Py_Initialize} rather than after it (since @code{Py_Main} makes
its own call to @code{Py_Initialize}). Document that calling both is
supported but is version dependent on which settings will be applied
correctly.
@end itemize

@node Core and Builtins<2>,C API<2>,Documentation<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id8}@anchor{1608}
@subsubsection Core and Builtins



@itemize -

@item 
gh-124375@footnote{https://github.com/python/cpython/issues/124375}: Fix a crash in the free threading build when the GC runs
concurrently with a new thread starting.

@item 
gh-125221@footnote{https://github.com/python/cpython/issues/125221}: Fix possible race condition when calling
@ref{1609,,__reduce_ex__()} for the first time in the free threading
build.

@item 
gh-125174@footnote{https://github.com/python/cpython/issues/125174}: Make the handling of reference counts of immortal objects more
robust. Immortal objects with reference counts that deviate from their
original reference count by up to a billion (half a billion on 32 bit
builds) are still counted as immortal.

@item 
gh-125039@footnote{https://github.com/python/cpython/issues/125039}: Make @code{this_instr} and @code{prev_instr} const in cases
generator.

@item 
gh-125008@footnote{https://github.com/python/cpython/issues/125008}: Fix @ref{160a,,tokenize.untokenize()} producing invalid syntax for
double braces preceded by certain escape characters.

@item 
gh-124871@footnote{https://github.com/python/cpython/issues/124871}: Fix compiler bug (in some versions of 3.13) where an assertion
fails during reachability analysis.

@item 
gh-123378@footnote{https://github.com/python/cpython/issues/123378}: Fix a crash in the @ref{6be,,__str__()} method of
@ref{130f,,UnicodeError} objects when the @ref{160b,,UnicodeError.start} and
@ref{160c,,UnicodeError.end} values are invalid or out-of-range. Patch by
Bénédikt Tran.

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: Improve the experimental JIT compiler’s ability to stay «on
trace» when encountering highly-biased branches.

@item 
gh-124642@footnote{https://github.com/python/cpython/issues/124642}: Fixed scalability issue in free-threaded builds for lock-free
reads from dictionaries in multi-threaded scenarios

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: Fix a crash caused by immortal interned strings being shared
between sub-interpreters that use basic single-phase init.  In that case,
the string can be used by an interpreter that outlives the interpreter
that created and interned it.  For interpreters that share obmalloc state,
also share the interned dict with the main interpreter.

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: Fix a bug that can cause a crash when sub-interpreters use
«basic» single-phase extension modules.  Shared objects could refer to
PyGC_Head nodes that had been freed as part of interpreter cleanup.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: The @code{__main__} module no longer always contains an
@code{__annotations__} dictionary in its global namespace.

@item 
gh-124547@footnote{https://github.com/python/cpython/issues/124547}: When deallocating an object with inline values whose
@code{__dict__} is still live: if memory allocation for the inline values
fails, clear the dictionary. Prevents an interpreter crash.

@item 
gh-124513@footnote{https://github.com/python/cpython/issues/124513}: Fix a crash in FrameLocalsProxy constructor: check the number
of arguments. Patch by Victor Stinner.

@item 
gh-124442@footnote{https://github.com/python/cpython/issues/124442}: Fix nondeterminism in compilation by sorting the value of
@ref{2b8,,__static_attributes__}. Patch by kp2pml30.

@item 
gh-124285@footnote{https://github.com/python/cpython/issues/124285}: Fix bug where @code{bool(a)} can be invoked more than once during
the evaluation of a compound boolean expression.

@item 
gh-123856@footnote{https://github.com/python/cpython/issues/123856}: Fix PyREPL failure when a keyboard interrupt is triggered after
using a history search

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: Deprecate the setting and using @code{__package__} and
@code{__cached__}.

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: The JIT now generates more efficient code for calls to C
functions resulting in up to 0.8% memory savings and 1.5% speed
improvement on AArch64. Patch by Diego Russo.

@item 
gh-122878@footnote{https://github.com/python/cpython/issues/122878}: Use the @code{pager} binary, if available (e.g. on Debian and
derivatives), to display REPL @code{help()}.

@item 
gh-124188@footnote{https://github.com/python/cpython/issues/124188}: Fix reading and decoding a line from the source file witn
non-UTF-8 encoding for syntax errors raised in the compiler.

@item 
gh-124027@footnote{https://github.com/python/cpython/issues/124027}: Support @code{<page up>}, @code{<page down>}, and @code{<delete>} keys
in the Python REPL when @code{$TERM} is set to @code{vt100}.

@item 
gh-124022@footnote{https://github.com/python/cpython/issues/124022}: Fix bug where docstring is removed from classes in interactive
mode.

@item 
gh-123958@footnote{https://github.com/python/cpython/issues/123958}: docstrings are now removed from the optimized AST in
optimization level 2.

@item 
gh-123923@footnote{https://github.com/python/cpython/issues/123923}: The @code{f_executable} field in the internal
@ref{160d,,_PyInterpreterFrame} struct now uses a tagged pointer.
Profilers and debuggers that uses this field should clear the least
significant bit to recover the @ref{42d,,PyObject}* pointer.

@item 
gh-77894@footnote{https://github.com/python/cpython/issues/77894}: Fix possible crash in the garbage collector when it tries to
break a reference loop containing a @ref{156,,memoryview} object. Now a
@code{memoryview} object can only be cleared if there are no buffers
that refer it.

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: asyncio REPL is now again properly recognizing
KeyboardInterrupts. Display of exceptions raised in secondary threads is
fixed.

@item 
gh-119310@footnote{https://github.com/python/cpython/issues/119310}: Allow the new interactive shell to read history files written
with the editline library that use unicode-escaped entries.  Patch by
aorcajo and Łukasz Langa.

@item 
gh-123572@footnote{https://github.com/python/cpython/issues/123572}: Fix key mappings for various F-keys in Windows for the new
REPL. Patch by devdanzin

@item 
gh-123614@footnote{https://github.com/python/cpython/issues/123614}: Add @ref{160e,,turtle.save()} to easily save Turtle drawings as
PostScript files. Patch by Marie Roald and Yngve Mardal Moe.

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: Setting the @code{__module__} attribute for a class now
removes the @code{__firstlineno__} item from the type’s dict, so they will no
longer be inconsistent.

@item 
gh-119034@footnote{https://github.com/python/cpython/issues/119034}: Change @code{<page up>} and @code{<page down>} keys of the Python
REPL to history search forward/backward. Patch by Victor Stinner.

@item 
gh-123562@footnote{https://github.com/python/cpython/issues/123562}: Improve @ref{150,,SyntaxError} message for using @code{case ... as
...} with not a name.

@item 
gh-123545@footnote{https://github.com/python/cpython/issues/123545}: Fix a double decref in rare cases on experimental JIT builds.

@item 
gh-123484@footnote{https://github.com/python/cpython/issues/123484}: Fix @code{_Py_DebugOffsets} for long objects to be relative to the
start of the object rather than the start of a subobject.

@item 
gh-123446@footnote{https://github.com/python/cpython/issues/123446}: Fix empty function name in @ref{228,,TypeError} when builtin magic
methods are used without the required args.

@item 
gh-123440@footnote{https://github.com/python/cpython/issues/123440}: Improve @ref{150,,SyntaxError} message for using @code{except as} with
not a name.

@item 
gh-116017@footnote{https://github.com/python/cpython/issues/116017}: Improved JIT memory consumption by periodically freeing memory
used by infrequently-executed code. This change is especially likely to
improve the memory footprint of long-running programs.

@item 
gh-123344@footnote{https://github.com/python/cpython/issues/123344}: Add AST optimizations for type parameter defaults.

@item 
gh-123321@footnote{https://github.com/python/cpython/issues/123321}: Prevent Parser/myreadline race condition from segfaulting on
multi-threaded use. Patch by Bar Harel and Amit Wienner.

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: Fix a bug causing stray prompts to appear in the middle of
wrapped lines in the new REPL.

@item 
gh-122982@footnote{https://github.com/python/cpython/issues/122982}: Extend the deprecation period for bool inversion (@code{~}) by two
years.

@item 
gh-123271@footnote{https://github.com/python/cpython/issues/123271}: Make concurrent iterations over the same @ref{14d,,zip()} iterator
safe under free-threading.

@item 
gh-123275@footnote{https://github.com/python/cpython/issues/123275}: Support @ref{2e2,,-X gil=1} and 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL=1} on non-free-threaded builds.

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: Deactivate line wrap in the Apple Terminal via a ANSI escape
code. Patch by Pablo Galindo

@item 
gh-123229@footnote{https://github.com/python/cpython/issues/123229}: Fix valgrind warning by initializing the f-string buffers to 0
in the tokenizer. Patch by Pablo Galindo

@item 
gh-122298@footnote{https://github.com/python/cpython/issues/122298}: Restore printout of GC stats when
@code{gc.set_debug(gc.DEBUG_STATS)} is called. This feature was accidentally
removed when implementing incremental GC.

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: Correctly show error locations when a @ref{150,,SyntaxError} is
raised in the basic REPL. Patch by Sergey B Kirpichev.

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: Enables inline values (Python’s equivalent of hidden classes)
on any class who’s instances are of a fixed size.

@item 
gh-123142@footnote{https://github.com/python/cpython/issues/123142}: Fix too-wide source location in exception tracebacks coming
from broken iterables in comprehensions.

@item 
gh-123048@footnote{https://github.com/python/cpython/issues/123048}: Fix a bug where pattern matching code could emit a
@ref{160f,,JUMP_FORWARD} with no source location.

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: Break up @code{CALL_ALLOC_AND_ENTER_INIT} into micro-ops and relax
requirement for exact args, in order to increase the amount of code
supported by tier 2.

@item 
gh-123123@footnote{https://github.com/python/cpython/issues/123123}: Fix displaying @ref{150,,SyntaxError} exceptions covering multiple
lines. Patch by Pablo Galindo

@item 
gh-123083@footnote{https://github.com/python/cpython/issues/123083}: Fix a potential use-after-free in @code{STORE_ATTR_WITH_HINT}.

@item 
gh-123022@footnote{https://github.com/python/cpython/issues/123022}: Fix crash in free-threaded build when calling
@ref{247,,Py_Initialize()} from a non-main thread.

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: Add three specializations for @ref{1610,,CALL_KW}:


@itemize *

@item 
@code{CALL_KW_PY} for calls to Python functions

@item 
@code{CALL_KW_BOUND_METHOD} for calls to bound methods

@item 
@code{CALL_KW_NON_PY} for all other calls
@end itemize

@item 
gh-122821@footnote{https://github.com/python/cpython/issues/122821}: Make sure that branches in @ref{1611,,while} statements have
consistent offsets for @ref{da,,sys.monitoring}. @code{while} statements
are now compiled with a simple jump at the end of the body, instead of
duplicating the test.

@item 
gh-122907@footnote{https://github.com/python/cpython/issues/122907}: Building with @code{HAVE_DYNAMIC_LOADING} now works as well as it
did in 3.12. Existing deficiences will be addressed separately. (See
@indicateurl{https://github.com/python/cpython/issues/122950}.)

@item 
gh-122888@footnote{https://github.com/python/cpython/issues/122888}: Fix crash on certain calls to @code{str()} with positional
arguments of the wrong type. Patch by Jelle Zijlstra.

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: Improve the experimental JIT’s handling of polymorphic code.

@item 
gh-122697@footnote{https://github.com/python/cpython/issues/122697}: Fixed memory leaks at interpreter shutdown in the free-threaded
build, and also reporting of leaked memory blocks via @ref{2e2,,-X showrefcount}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Fix Android stdout and stderr messages being truncated or lost.

@item 
gh-122527@footnote{https://github.com/python/cpython/issues/122527}: Fix a crash that occurred when a @code{PyStructSequence} was
deallocated after its type’s dictionary was cleared by the GC.  The type’s
@ref{a19,,tp_basicsize} now accounts for non-sequence
fields that aren’t included in the @ref{81b,,Py_SIZE} of the sequence.

@item 
gh-122445@footnote{https://github.com/python/cpython/issues/122445}: Add only fields which are modified via self.* to
@ref{2b8,,__static_attributes__}.

@item 
gh-122417@footnote{https://github.com/python/cpython/issues/122417}: In the free-threaded build, the reference counts for heap type
objects are now partially stored in a distributed manner in per-thread
arrays.  This reduces contention on the heap type’s reference count fields
when creating or destroying instances of the same type from multiple
threads concurrently.

@item 
gh-116090@footnote{https://github.com/python/cpython/issues/116090}: Fix an issue in JIT builds that prevented some @ref{1eb,,for}
loops from correctly firing @ref{1612,,RAISE} monitoring events.

@item 
gh-122300@footnote{https://github.com/python/cpython/issues/122300}: Preserve AST nodes for f-string with single-element format
specifiers. Patch by Pablo Galindo

@item 
gh-120906@footnote{https://github.com/python/cpython/issues/120906}: @ref{2ed,,frame.f_locals} now supports arbitrary hashable objects
as keys.

@item 
gh-122239@footnote{https://github.com/python/cpython/issues/122239}: When a @ref{18e,,list}, @ref{464,,tuple} or @ref{190,,dict} with too
many elements is unpacked, show the actual length in the error message.

@item 
gh-122245@footnote{https://github.com/python/cpython/issues/122245}: Detection of writes to @code{__debug__} is moved from the
compiler’s codegen stage to the symtable. This means that these errors are
now detected even in code that is optimized away before codegen (such as
assertions with the @ref{14f,,-O} command line option).

@item 
gh-122234@footnote{https://github.com/python/cpython/issues/122234}: Specializations for sums with float and complex inputs in
@ref{515,,sum()} now always use compensated summation.  Also, for integer items
in above specializations: @ref{1613,,PyLong_AsDouble()} is used, instead of
@ref{12d4,,PyLong_AsLongAndOverflow()}.  Patch by Sergey B Kirpichev.

@item 
gh-122208@footnote{https://github.com/python/cpython/issues/122208}: Dictionary watchers now only deliver the PyDict_EVENT_ADDED
event when the insertion is in a known good state to succeed.

@item 
gh-122160@footnote{https://github.com/python/cpython/issues/122160}: Remove the @code{BUILD_CONST_KEY_MAP} opcode. Use
@ref{1614,,BUILD_MAP} instead.

@item 
gh-122029@footnote{https://github.com/python/cpython/issues/122029}: Emit @code{c_call} events in @ref{153f,,sys.setprofile()} when a
@code{PyMethodObject} pointing to a @code{PyCFunction} is called.

@item 
gh-122026@footnote{https://github.com/python/cpython/issues/122026}: Fix a bug that caused the tokenizer to not correctly identify
mismatched parentheses inside f-strings in some situations. Patch by Pablo
Galindo

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Python’s hashlib now unconditionally uses the vendored HACL*
library for Blake2. Python no longer accepts libb2 as an optional
dependency for Blake2.

We refreshed HACL* to the latest version, and now vendor HACL*”s 128-bit
and 256-bit wide vector implementations for Blake2, which are used on
x86/x64 toolchains when the required CPU features are available at
runtime.

HACL*”s 128-bit wide vector implementation of Blake2 can also run on ARM
NEON and Power8, but lacking evidence of a performance gain, these are not
enabled (yet).

@item 
gh-121999@footnote{https://github.com/python/cpython/issues/121999}: The default extraction filter for the @ref{de,,tarfile} module is
now set to @ref{1615,,'data'}.

@item 
gh-121860@footnote{https://github.com/python/cpython/issues/121860}: Fix crash when rematerializing a managed dictionary after it
was deleted.

@item 
gh-121795@footnote{https://github.com/python/cpython/issues/121795}: Improve performance of set membership testing, @code{set.remove()}
and @code{set.discard()} when the argument is a set.

@item 
gh-121814@footnote{https://github.com/python/cpython/issues/121814}: Fixed the SegFault when @ref{153e,,PyEval_SetTrace()} is used with
no Python frame on stack.

@item 
gh-121295@footnote{https://github.com/python/cpython/issues/121295}: Fix PyREPL console getting into a blocked state after
interrupting a long paste

@item 
gh-121794@footnote{https://github.com/python/cpython/issues/121794}: Fix bug in free-threaded Python where a resurrected object
could lead to a negative ref count assertion failure.

@item 
gh-121657@footnote{https://github.com/python/cpython/issues/121657}: Improve the @ref{150,,SyntaxError} message if the user tries to use
@ref{a5f,,yield from} outside a function.

@item 
gh-121609@footnote{https://github.com/python/cpython/issues/121609}: Fix pasting of characters containing unicode character joiners
in the new REPL. Patch by Marta Gomez Macias

@item 
gh-121297@footnote{https://github.com/python/cpython/issues/121297}: Previously, incorrect usage of @ref{14e,,await} or asynchronous
comprehensions in code removed by the @ref{14f,,-O} option was not flagged
by the Python compiler. Now, such code raises @ref{150,,SyntaxError}. Patch by
Jelle Zijlstra.

@item 
gh-117482@footnote{https://github.com/python/cpython/issues/117482}: Unexpected slot wrappers are no longer created for builtin
static types in subinterpreters.

@item 
gh-121562@footnote{https://github.com/python/cpython/issues/121562}: Optimized performance of hex_from_char by replacing switch-case
with a lookup table

@item 
gh-121499@footnote{https://github.com/python/cpython/issues/121499}: Fix a bug affecting how multi-line history was being rendered
in the new REPL after interacting with the new screen cache. Patch by
Pablo Galindo

@item 
gh-121497@footnote{https://github.com/python/cpython/issues/121497}: Fix a bug that was preventing the REPL to correctly respect the
history when an input hook was set. Patch by Pablo Galindo

@item 
gh-121012@footnote{https://github.com/python/cpython/issues/121012}: Tier 2 execution now ensures that list iterators remain
exhausted, once they become exhausted.

@item 
gh-121439@footnote{https://github.com/python/cpython/issues/121439}: Allow tuples of length 20 in the freelist to be reused.

@item 
gh-121288@footnote{https://github.com/python/cpython/issues/121288}: @ref{360,,ValueError} messages for @code{list.index()},
@code{range.index()}, @code{deque.index()}, @code{deque.remove()} and
@code{ShareableList.index()} no longer contain the repr of the searched
value (which can be arbitrary large) and are consistent with error
messages for other @code{index()} and @code{remove()} methods.

@item 
gh-121368@footnote{https://github.com/python/cpython/issues/121368}: Fix race condition in @code{_PyType_Lookup} in the free-threaded
build due to a missing memory fence.  This could lead to
@code{_PyType_Lookup} returning incorrect results on arm64.

@item 
gh-121149@footnote{https://github.com/python/cpython/issues/121149}: Added specialization for summation of complexes, this also
improves accuracy of builtin @ref{515,,sum()} for such inputs.  Patch by Sergey
B Kirpichev.

@item 
gh-121130@footnote{https://github.com/python/cpython/issues/121130}: Fix f-strings with debug expressions in format specifiers.
Patch by Pablo Galindo

@item 
gh-121381@footnote{https://github.com/python/cpython/issues/121381}: Remove @code{subprocess._USE_VFORK} escape hatch code and
documentation. It was added just in case, and doesn’t have any known cases
that require it.

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: Optimize code layout for calls to C functions from the JIT on
AArch64. Patch by Diego Russo.

@item 
gh-121115@footnote{https://github.com/python/cpython/issues/121115}: @ref{455,,PyLong_AsNativeBytes()} no longer uses
@ref{22b,,__index__()} methods by default. The
@code{Py_ASNATIVEBYTES_ALLOW_INDEX} flag has been added to allow it.

@item 
gh-120838@footnote{https://github.com/python/cpython/issues/120838}: @ref{246,,Py_Finalize()} and @ref{d9c,,Py_FinalizeEx()} now
always run with the main interpreter active.

@item 
gh-113433@footnote{https://github.com/python/cpython/issues/113433}: Subinterpreters now get cleaned up automatically during runtime
finalization.

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: Improve the speed and memory use of C function calls from JIT
code on AArch64. Patch by Diego Russo

@item 
gh-116017@footnote{https://github.com/python/cpython/issues/116017}: Simplify the warmup mechanism used for «side exits» in JIT
code, resulting in slightly better performance and slightly lower memory
usage for most platforms.

@item 
gh-98442@footnote{https://github.com/python/cpython/issues/98442}: Fix too wide source locations of the cleanup instructions of a
with statement.

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: Reduce the number of system calls invoked when reading a whole
file (ex. @code{open('a.txt').read()}). For a sample program that reads the
contents of the 400+ @code{.rst} files in the cpython repository @code{Doc}
folder, there is an over 10% reduction in system call count.

@item 
gh-119462@footnote{https://github.com/python/cpython/issues/119462}: Make sure that invariants of type versioning are maintained: *
Superclasses always have their version number assigned before subclasses *
The version tag is always zero if the tag is not valid. * The version tag
is always non-if the tag is valid.

@item 
gh-120437@footnote{https://github.com/python/cpython/issues/120437}: Fix @code{_CHECK_STACK_SPACE} optimization problems introduced in
gh-118322@footnote{https://github.com/python/cpython/issues/118322}.

@item 
gh-120722@footnote{https://github.com/python/cpython/issues/120722}: Correctly set the bytecode position on return instructions
within lambdas. Patch by Jelle Zijlstra.

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: Fix bug where compiler creates a redundant jump during
pseudo-op replacement. Can only happen with a synthetic AST that has a try
on the same line as the instruction following the exception handler.

@item 
gh-120507@footnote{https://github.com/python/cpython/issues/120507}: Remove the @code{BEFORE_WITH} and @code{BEFORE_ASYNC_WITH}
instructions. Add the new @ref{1616,,LOAD_SPECIAL} instruction. Generate
code for @code{with} and @code{async with} statements using the new instruction.

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: Strings interned with @ref{1343,,sys.intern()} are again
garbage-collected when no longer used, as per the documentation. Strings
interned with the C function @ref{948,,PyUnicode_InternInPlace()} are still
immortal. Internals of the string interning mechanism have been changed.
This may affect performance and identities of @ref{237,,str} objects.

@item 
gh-120485@footnote{https://github.com/python/cpython/issues/120485}: Add an override of @code{allow_reuse_port} on classes subclassing
@code{socketserver.TCPServer} where @code{allow_reuse_address} is also
overridden.

@item 
gh-120384@footnote{https://github.com/python/cpython/issues/120384}: Fix an array out of bounds crash in @code{list_ass_subscript},
which could be invoked via some specifically tailored input: including
concurrent modification of a list object, where one thread assigns a slice
and another clears it.

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: Fix crash in compiler on code with redundant NOPs and JUMPs
which show up after exception handlers are moved to the end of the code.

@item 
gh-120380@footnote{https://github.com/python/cpython/issues/120380}: Fix Python implementation of @ref{ab0,,pickle.Pickler} for
@ref{325,,bytes} and @ref{5e0,,bytearray} objects when using protocol version
5. Patch by Bénédikt Tran.

@item 
gh-120397@footnote{https://github.com/python/cpython/issues/120397}: Improve the throughput by up to two times for the
@ref{1617,,str.count()}, @ref{1618,,bytes.count()} and @ref{1619,,bytearray.count()} methods
for counting single characters.

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: Deliver real signals on Ctrl-C and Ctrl-Z in the new REPL.
Patch by Pablo Galindo

@item 
gh-120346@footnote{https://github.com/python/cpython/issues/120346}: Respect 
@geindex PYTHON_BASIC_REPL
@geindex variables de entorno; PYTHON_BASIC_REPL
@ref{2da,,PYTHON_BASIC_REPL} when running in interactive
inspect mode (@code{python -i}). Patch by Pablo Galindo

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: Fix source locations of instructions generated for the iterator
of a for statement.

@item 
gh-120198@footnote{https://github.com/python/cpython/issues/120198}: Fix a crash when multiple threads read and write to the same
@code{__class__} of an object concurrently.

@item 
gh-120298@footnote{https://github.com/python/cpython/issues/120298}: Fix use-after free in @code{list_richcompare_impl} which can be
invoked via some specifically tailored evil input.

@item 
gh-119666@footnote{https://github.com/python/cpython/issues/119666}: Fix a compiler crash in the case where two comprehensions in
class scope both reference @code{__class__}.

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: JIT: Re-use trampolines on AArch64 when creating stencils.
Patch by Diego Russo

@item 
gh-120225@footnote{https://github.com/python/cpython/issues/120225}: Fix crash in compiler on empty block at end of exception
handler.

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: Fix source locations of instructions generated for with
statements.

@item 
gh-120097@footnote{https://github.com/python/cpython/issues/120097}: @code{FrameLocalsProxy} now subclasses @code{collections.abc.Mapping}
and can be matched as a mapping in @code{match} statements

@item 
gh-120080@footnote{https://github.com/python/cpython/issues/120080}: Direct call to the @code{int.__round__()} now accepts @code{None}
as a valid argument.

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: Improve @ref{150,,SyntaxError} messages for invalid expressions in
a type parameters bound, a type parameter constraint tuple or a default
type parameter. Patch by Bénédikt Tran.

@item 
gh-119724@footnote{https://github.com/python/cpython/issues/119724}: Reverted improvements to error messages for @code{elif}/@code{else}
statements not matching any valid statements, which made in hard to locate
the syntax errors inside those @code{elif}/@code{else} blocks.

@item 
gh-119879@footnote{https://github.com/python/cpython/issues/119879}: String search is now slightly faster for certain cases. It now
utilizes last character gap (good suffix rule) for two-way periodic
needles.

@item 
gh-119842@footnote{https://github.com/python/cpython/issues/119842}: Honor @ref{629,,PyOS_InputHook()} in the new REPL. Patch by Pablo
Galindo

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: @ref{2d2,,classmethod()} and @ref{22e,,staticmethod()} now wrap the
@ref{e08,,__annotations__} and @ref{161a,,__annotate__}
attributes of their underlying callable lazily. See 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}. Patch by
Jelle Zijlstra.

@item 
gh-119821@footnote{https://github.com/python/cpython/issues/119821}: Fix execution of @ref{2f3,,annotation scopes}
within classes when @code{globals} is set to a non-dict. Patch by Jelle
Zijlstra.

@item 
gh-118934@footnote{https://github.com/python/cpython/issues/118934}: Make @code{PyEval_GetLocals} return borrowed reference

@item 
gh-119740@footnote{https://github.com/python/cpython/issues/119740}: Remove the previously-deprecated delegation of @ref{1f0,,int()} to
@ref{229,,__trunc__()}.

@item 
gh-119689@footnote{https://github.com/python/cpython/issues/119689}: Generate stack effect metadata for pseudo instructions from
bytecodes.c.

@item 
gh-109218@footnote{https://github.com/python/cpython/issues/109218}: @ref{154,,complex()} accepts now a string only as a positional
argument. Passing a complex number as the «real» or «imag» argument is
deprecated; it should only be passed as a single positional argument.

@item 
gh-119548@footnote{https://github.com/python/cpython/issues/119548}: Add a @code{clear} command to the REPL. Patch by Pablo Galindo

@item 
gh-111999@footnote{https://github.com/python/cpython/issues/111999}: Fix the signature of @ref{e5c,,str.format_map()}.

@item 
gh-119560@footnote{https://github.com/python/cpython/issues/119560}: An invalid assert in beta 1 has been removed.  The assert would
fail if @code{PyState_FindModule()} was used in an extension module’s init
function before the module def had been initialized.

@item 
gh-119369@footnote{https://github.com/python/cpython/issues/119369}: Fix deadlock during thread deletion in free-threaded build,
which could occur when the GIL was enabled at runtime.

@item 
gh-119525@footnote{https://github.com/python/cpython/issues/119525}: Fix deadlock involving @code{_PyType_Lookup()} cache in the
free-threaded build when the GIL is dynamically enabled at runtime.

@item 
gh-119258@footnote{https://github.com/python/cpython/issues/119258}: Eliminate type version guards in the tier two interpreter.

Note that setting the @code{tp_version_tag} manually (which has never been
supported) may result in crashes.

@item 
gh-119311@footnote{https://github.com/python/cpython/issues/119311}: Fix bug where names are unexpectedly mangled in the bases of
generic classes.

@item 
gh-119395@footnote{https://github.com/python/cpython/issues/119395}: Fix bug where names appearing after a generic class are mangled
as if they are in the generic class.

@item 
gh-119372@footnote{https://github.com/python/cpython/issues/119372}: Correct invalid corner cases in complex division (resulted in
@code{(nan+nanj)} output), e.g.  @code{1/complex('(inf+infj)')}.  Patch by
Sergey B Kirpichev.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: Evaluation of annotations is now deferred. See 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} for
details.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: Replace @code{LOAD_ASSERTION_ERROR} opcode with
@ref{161b,,LOAD_COMMON_CONSTANT} and add support for
@ref{384,,NotImplementedError}.

@item 
gh-119213@footnote{https://github.com/python/cpython/issues/119213}: Non-builtin modules built with argument clinic were crashing if
used in a subinterpreter before the main interpreter.  The objects that
were causing the problem by leaking between interpreters carelessly have
been fixed.

@item 
gh-119011@footnote{https://github.com/python/cpython/issues/119011}: Fixes @code{type.__type_params__} to return an empty tuple instead
of a descriptor.

@item 
gh-118692@footnote{https://github.com/python/cpython/issues/118692}: Avoid creating unnecessary @ref{c82,,StopIteration} instances for
monitoring.

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: Add an @code{__annotate__} attribute to functions, classes, and
modules as part of 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}. Patch by Jelle Zijlstra.

@item 
gh-119049@footnote{https://github.com/python/cpython/issues/119049}: Fix displaying the source line for warnings created by the C
API if the @ref{112,,warnings} module had not yet been imported.

@item 
gh-119057@footnote{https://github.com/python/cpython/issues/119057}: Improve @ref{9d8,,ZeroDivisionError} error message. Now, all error
messages are harmonized: all @code{/}, @code{//}, and @code{%} operations just use
«division by zero» message. And @code{0 ** -1} operation uses «zero to a
negative power».

@item 
gh-118844@footnote{https://github.com/python/cpython/issues/118844}: Fix build failures when configuring with both @code{--disable-gil}
and @code{--enable-experimental-jit}.

@item 
gh-118921@footnote{https://github.com/python/cpython/issues/118921}: Add @code{copy()} method for @code{FrameLocalsProxy} which returns a
snapshot @code{dict} for local variables.

@item 
gh-117657@footnote{https://github.com/python/cpython/issues/117657}: Fix data races on the field that stores a pointer to the
interpreter’s main thread that occur in free-threaded builds.

@item 
gh-118750@footnote{https://github.com/python/cpython/issues/118750}: If the C version of the @code{decimal} module is available,
@code{int(str)} now uses it to supply an asymptotically much faster
conversion. However, this only applies if the string contains over about 2
million digits.

@item 
gh-118767@footnote{https://github.com/python/cpython/issues/118767}: Using @ref{227,,NotImplemented} in a boolean context now raises
@ref{228,,TypeError}. Contributed by Jelle Zijlstra.

@item 
gh-118561@footnote{https://github.com/python/cpython/issues/118561}: Fix race condition in free-threaded build where
@code{list.extend()} could expose uninitialised memory to concurrent
readers.

@item 
gh-117139@footnote{https://github.com/python/cpython/issues/117139}: Convert the Python evaluation stack to use internal stack
references. The purpose is to support tagged pointers. In 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}, this
will allow for its form of deferred reference counting. For both the
default and free-threaded builds, this sets up the infrastructure for
unboxed integers in the future.

@item 
gh-115801@footnote{https://github.com/python/cpython/issues/115801}: Raise @code{TypeError} when passing a string to
@ref{161c,,difflib.unified_diff()} and @ref{161d,,difflib.context_diff()}.

@item 
gh-117558@footnote{https://github.com/python/cpython/issues/117558}: Improve error messages when a string, bytes or bytearray object
of length 1 is expected.

@item 
gh-117195@footnote{https://github.com/python/cpython/issues/117195}: Avoid assertion failure for debug builds when calling
@code{object.__sizeof__(1)}

@item 
gh-116022@footnote{https://github.com/python/cpython/issues/116022}: Improve the @ref{6bd,,__repr__()} output of
@ref{30d,,AST} nodes.

@item 
gh-114091@footnote{https://github.com/python/cpython/issues/114091}: Changed the error message for awaiting something that can’t be
awaited from «object <type> can’t be used in an await expression» to
«”<type>” object can’t be awaited».

@item 
gh-113190@footnote{https://github.com/python/cpython/issues/113190}: @ref{246,,Py_Finalize()} now deletes all interned strings.

@item 
gh-84978@footnote{https://github.com/python/cpython/issues/84978}: Add class methods @ref{151,,float.from_number()} and
@ref{152,,complex.from_number()}.

@item 
gh-95144@footnote{https://github.com/python/cpython/issues/95144}: Improve the error message from @code{a in b} when @code{b} is not a
container to mention the term «container».

@item 
bpo-24766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24766}: Fix handling of @code{doc} argument to subclasses of @code{property}.
@end itemize

@node C API<2>,Build<2>,Core and Builtins<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id9}@anchor{161e}
@subsubsection C API



@itemize -

@item 
gh-123961@footnote{https://github.com/python/cpython/issues/123961}: Convert the @ref{161f,,curses.window} static
type exposed by the @code{PyCursesWindow_Type} macro in
@code{Include/py_curses.h} to a @ref{9f8,,heap type}. Patch by
Bénédikt Tran.

@item 
gh-124502@footnote{https://github.com/python/cpython/issues/124502}: Add @ref{26a,,PyUnicode_Equal()} function to the limited C API:
test if two strings are equal. Patch by Victor Stinner.

@item 
gh-124296@footnote{https://github.com/python/cpython/issues/124296}: @ref{4a3,,PyDictObject} no longer maintains a private version
tag field @code{ma_version_tag} per 
@geindex Python Enhancement Proposals; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}.  This field was originally
added in Python 3.6 (
@geindex Python Enhancement Proposals; PEP 509
PEP 509@footnote{https://peps.python.org/pep-0509/}) and deprecated in Python 3.12.

@item 
gh-124160@footnote{https://github.com/python/cpython/issues/124160}: Fix crash when importing modules containing state and
single-phase initialization in a subinterpreter.

@item 
gh-124153@footnote{https://github.com/python/cpython/issues/124153}: Add @ref{268,,PyType_GetBaseByToken()} and @ref{269,,Py_tp_token}
slot for easier type checking, related to 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} and 
@geindex Python Enhancement Proposals; PEP 630
PEP 630@footnote{https://peps.python.org/pep-0630/}.

@item 
gh-124127@footnote{https://github.com/python/cpython/issues/124127}: In the limited C API 3.14 and newer, @ref{26f,,Py_REFCNT()} is now
implemented as an opaque function call to hide implementation details.
Patch by Victor Stinner.

@item 
gh-123880@footnote{https://github.com/python/cpython/issues/123880}: Fixed a bug that prevented circular imports of extension
modules that use single-phase initialization.

@item 
gh-123909@footnote{https://github.com/python/cpython/issues/123909}: @ref{621,,PyType_FromSpec()}, @ref{622,,PyType_FromSpecWithBases()}
and @ref{5f4,,PyType_FromModuleAndSpec()} will now fail if the metaclass of
the new type has custom @ref{623,,tp_new}.

@item 
gh-107954@footnote{https://github.com/python/cpython/issues/107954}: Add functions to configure the Python initialization
(
@geindex Python Enhancement Proposals; PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}):


@itemize *

@item 
@ref{25c,,PyInitConfig_Create()}

@item 
@ref{25d,,PyInitConfig_Free()}

@item 
@ref{25f,,PyInitConfig_GetError()}

@item 
@ref{260,,PyInitConfig_GetExitCode()}

@item 
@ref{264,,PyInitConfig_HasOption()}

@item 
@ref{261,,PyInitConfig_GetInt()}

@item 
@ref{262,,PyInitConfig_GetStr()}

@item 
@ref{263,,PyInitConfig_GetStrList()}

@item 
@ref{25e,,PyInitConfig_FreeStrList()}

@item 
@ref{265,,PyInitConfig_SetInt()}

@item 
@ref{266,,PyInitConfig_SetStr()}

@item 
@ref{267,,PyInitConfig_SetStrList()}

@item 
@ref{25b,,PyInitConfig_AddModule()}

@item 
@ref{25a,,Py_InitializeFromInitConfig()}
@end itemize

Patch by Victor Stinner.

@item 
gh-107954@footnote{https://github.com/python/cpython/issues/107954}: Add functions to get and set the current runtime Python
configuration:


@itemize *

@item 
@ref{256,,PyConfig_Get()}

@item 
@ref{257,,PyConfig_GetInt()}

@item 
@ref{258,,PyConfig_Set()}

@item 
@ref{259,,PyConfig_Names()}
@end itemize

Patch by Victor Stinner.

@item 
gh-123465@footnote{https://github.com/python/cpython/issues/123465}: @ref{5f1,,Py_RELATIVE_OFFSET} is now allowed in
@ref{5f2,,PyMemberDef} for the special offset member
@code{"__vectorcalloffset__"}, as well as the discouraged special offset
members @code{"__dictoffset__"} and @code{"__weaklistoffset__"}

@item 
gh-100554@footnote{https://github.com/python/cpython/issues/100554}: Added a slot @code{Py_tp_vectorcall} to set
@ref{1620,,tp_vectorcall} via the @ref{621,,PyType_FromSpec()}
function family. Limited API extensions can use this feature to provide
more efficient vector call-based implementation of @code{__new__} and
@code{__init__}.

@item 
gh-122854@footnote{https://github.com/python/cpython/issues/122854}: Add @ref{255,,Py_HashBuffer()} to compute and return the hash
value of a buffer. Patch by Antoine Pitrou and Victor Stinner.

@item 
gh-122728@footnote{https://github.com/python/cpython/issues/122728}: Fix @ref{449,,PyEval_GetLocals()} to avoid @ref{619,,SystemError}
(«bad argument to internal function»). Patch by Victor Stinner.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Make @ref{1621,,PyObject_Print} work around a bug in Android and
OpenBSD which prevented it from throwing an exception when trying to write
to a read-only stream.

@item 
gh-105201@footnote{https://github.com/python/cpython/issues/105201}: Add @ref{244,,PyIter_NextItem()} to replace @ref{245,,PyIter_Next()},
which has an ambiguous return value. Patch by Irit Katriel and Erlend
Aasland.

@item 
gh-121489@footnote{https://github.com/python/cpython/issues/121489}: Export private @code{_PyBytes_Join()} again.

@item 
gh-121645@footnote{https://github.com/python/cpython/issues/121645}: Add @ref{254,,PyBytes_Join(sep@comma{} iterable)}
function, similar to @code{sep.join(iterable)} in Python. Patch by Victor
Stinner.

@item 
gh-89364@footnote{https://github.com/python/cpython/issues/89364}: Export the @ref{141b,,PySignal_SetWakeupFd()} function. Previously,
the function was documented but it couldn’t be used in 3rd party code.
Patch by Victor Stinner.

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: @ref{948,,PyUnicode_InternInPlace()} no longer prevents its
argument from being garbage collected.

Several functions that take @code{char *} are now documented as possibly
preventing string objects from being garbage collected; refer to their
documentation for details: @ref{1622,,PyUnicode_InternFromString()},
@ref{1623,,PyDict_SetItemString()}, @ref{1624,,PyObject_SetAttrString()},
@ref{1625,,PyObject_DelAttrString()}, @ref{1622,,PyUnicode_InternFromString()},
and @code{PyModule_Add*} convenience functions.

@item 
gh-113601@footnote{https://github.com/python/cpython/issues/113601}: Removed debug build assertions related to interning strings,
which were falsely triggered by stable ABI extensions.

@item 
gh-112136@footnote{https://github.com/python/cpython/issues/112136}: Restore the private @code{_PyArg_Parser} structure and the private
@code{_PyArg_ParseTupleAndKeywordsFast()} function, previously removed in
Python 3.13 alpha 1. Patch by Victor Stinner.

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: Remove the private @code{_Py_CODEUNIT} type from the public C API.
The internal @code{pycore_code.h} header should now be used to get this
internal type. Patch by Victor Stinner.

@item 
gh-120858@footnote{https://github.com/python/cpython/issues/120858}: @ref{1626,,PyDict_Next()} no longer locks the dictionary in the
free-threaded build.  The locking needs to be done by the caller around
the entire iteration loop.

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: Remove the following unstable functions:


@itemize *

@item 
@code{PyUnstable_Replace_Executor()}

@item 
@code{PyUnstable_SetOptimizer()}

@item 
@code{PyUnstable_GetOptimizer()}

@item 
@code{PyUnstable_GetExecutor()}

@item 
@code{PyUnstable_Optimizer_NewCounter()}

@item 
@code{PyUnstable_Optimizer_NewUOpOptimizer()}
@end itemize

Patch by Victor Stinner.

@item 
gh-120389@footnote{https://github.com/python/cpython/issues/120389}: Add new functions to convert C @code{<stdint.h>} numbers from/to
Python @ref{1f0,,int}:


@itemize *

@item 
@ref{250,,PyLong_FromInt32()}

@item 
@ref{252,,PyLong_FromUInt32()}

@item 
@ref{251,,PyLong_FromInt64()}

@item 
@ref{253,,PyLong_FromUInt64()}

@item 
@ref{24c,,PyLong_AsInt32()}

@item 
@ref{24e,,PyLong_AsUInt32()}

@item 
@ref{24d,,PyLong_AsInt64()}

@item 
@ref{24f,,PyLong_AsUInt64()}
@end itemize

Patch by Victor Stinner.

@item 
gh-120600@footnote{https://github.com/python/cpython/issues/120600}: In the limited C API 3.14 and newer, @ref{26e,,Py_TYPE()} is now
implemented as an opaque function call to hide implementation details.
Patch by Victor Stinner.

@item 
gh-70278@footnote{https://github.com/python/cpython/issues/70278}: @ref{47c,,PyUnicode_FromFormat()} no longer produces the ending
@code{\ufffd} character for truncated C string when use precision with @code{%s}
and @code{%V}. It now truncates the string before the start of truncated
multibyte sequences.

@item 
gh-119771@footnote{https://github.com/python/cpython/issues/119771}: Set @ref{57,,errno} in @ref{1627,,_Py_c_pow()} on overflows.  Patch
by Sergey B Kirpichev.

@item 
gh-119182@footnote{https://github.com/python/cpython/issues/119182}: Add a new @ref{236,,PyUnicodeWriter} API to create a Python
@ref{237,,str} object:


@itemize *

@item 
@ref{238,,PyUnicodeWriter_Create()}.

@item 
@ref{23a,,PyUnicodeWriter_Discard()}.

@item 
@ref{23b,,PyUnicodeWriter_Finish()}.

@item 
@ref{23d,,PyUnicodeWriter_WriteChar()}.

@item 
@ref{242,,PyUnicodeWriter_WriteUTF8()}.

@item 
@ref{241,,PyUnicodeWriter_WriteUCS4()}.

@item 
@ref{243,,PyUnicodeWriter_WriteWideChar()}.

@item 
@ref{23f,,PyUnicodeWriter_WriteStr()}.

@item 
@ref{23e,,PyUnicodeWriter_WriteRepr()}.

@item 
@ref{240,,PyUnicodeWriter_WriteSubstring()}.

@item 
@ref{23c,,PyUnicodeWriter_Format()}.

@item 
@ref{239,,PyUnicodeWriter_DecodeUTF8Stateful()}.
@end itemize

Patch by Victor Stinner.

@item 
gh-119613@footnote{https://github.com/python/cpython/issues/119613}: Soft deprecate the @code{Py_MEMCPY} macro: use directly
@code{memcpy()} instead.  Patch by Victor Stinner.

@item 
gh-119775@footnote{https://github.com/python/cpython/issues/119775}: Creating @ref{2a7,,immutable types}
with mutable bases was deprecated since 3.12 and now raises a
@ref{228,,TypeError}.

@item 
gh-119585@footnote{https://github.com/python/cpython/issues/119585}: Fix crash when a thread state that was created by
@ref{49e,,PyGILState_Ensure()} calls a destructor that during
@ref{1628,,PyThreadState_Clear()} that calls back into
@ref{49e,,PyGILState_Ensure()} and @ref{49f,,PyGILState_Release()}. This might
occur when in the free-threaded build or when using thread-local variables
whose destructors call @ref{49e,,PyGILState_Ensure()}.

@item 
gh-119613@footnote{https://github.com/python/cpython/issues/119613}: Macros @code{Py_IS_NAN}, @code{Py_IS_INFINITY} and @code{Py_IS_FINITE}
are @ref{1c4,,soft deprecated}.

@item 
gh-119336@footnote{https://github.com/python/cpython/issues/119336}: Restore the removed @code{_PyLong_NumBits()} function. It is used
by the pywin32 project. Patch by Ethan Smith

@item 
gh-119344@footnote{https://github.com/python/cpython/issues/119344}: The critical section API is now public as part of the
non-limited C API.

@item 
gh-119333@footnote{https://github.com/python/cpython/issues/119333}: Add @ref{1629,,PyContext_AddWatcher()} and
@ref{162a,,PyContext_ClearWatcher()} APIs to register callbacks to receive
notification on enter and exit of context objects.

@item 
gh-119247@footnote{https://github.com/python/cpython/issues/119247}: Added @code{Py_BEGIN_CRITICAL_SECTION_SEQUENCE_FAST} and
@code{Py_END_CRITICAL_SECTION_SEQUENCE_FAST} macros to make it possible to
use PySequence_Fast APIs safely when free-threaded, and update str.join to
work without the GIL using them.

@item 
gh-111389@footnote{https://github.com/python/cpython/issues/111389}: Add @ref{162b,,PyHASH_MULTIPLIER} constant: prime multiplier
used in string and various other hashes. Patch by Victor Stinner.

@item 
gh-118771@footnote{https://github.com/python/cpython/issues/118771}: Several C declarations with names that didn’t start with the
@code{Py} or @code{_Py} prefixes, which were added by mistake in 3.13 alpha and
beta releases, were moved to internal headers.

@item 
gh-116984@footnote{https://github.com/python/cpython/issues/116984}: Make mimalloc includes relative to the current file to avoid
embedders or extensions needing to include @code{Internal/mimalloc} if they
are already including internal CPython headers.

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: Add @ref{162c,,PyUnstable_Object_ClearWeakRefsNoCallbacks()}, which
clears weakrefs without calling their callbacks.

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: Restore @code{_PyWeakref_ClearRef} that was previously removed in
Python 3.13 alpha 1.

@item 
gh-117511@footnote{https://github.com/python/cpython/issues/117511}: Make the @ref{2c7,,PyMutex} public in the non-limited C API.

@item 
gh-116560@footnote{https://github.com/python/cpython/issues/116560}: Add @ref{235,,PyLong_GetSign()} function.  Patch by Sergey B
Kirpichev.

@item 
gh-97588@footnote{https://github.com/python/cpython/issues/97588}: Fix creating bitfields in @ref{2b,,ctypes} structures and unions.
Fields no longer overlap.

@item 
gh-87135@footnote{https://github.com/python/cpython/issues/87135}: Attempting to acquire the GIL after runtime finalization has
begun in a different thread now causes the thread to hang rather than
terminate, which avoids potential crashes or memory corruption caused by
attempting to terminate a thread that is running code not specifically
designed to support termination. In most cases this hanging is harmless
since the process will soon exit anyway.

The @code{PyThread_exit_thread} function is now deprecated.  Its behavior is
inconsistent across platforms, and it can only be used safely in the
unlikely case that every function in the entire call stack has been
designed to support the platform-dependent termination mechanism.  It is
recommended that users of this function change their design to not require
thread termination.  In the unlikely case that thread termination is
needed and can be done safely, users may migrate to calling
platform-specific APIs such as @code{pthread_exit} (POSIX) or
@code{_endthreadex} (Windows) directly.

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: Added @code{Py_IsInitialized} to the list of APIs that are safe to
call before the interpreter is initialized, and updated the embedding
tests to cover it.
@end itemize

@node Build<2>,,C API<2>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id10}@anchor{162d}
@subsubsection Build



@itemize -

@item 
gh-125269@footnote{https://github.com/python/cpython/issues/125269}: Fix detection of whether @code{-latomic} is needed when
cross-compiling CPython using the configure script.

@item 
gh-123990@footnote{https://github.com/python/cpython/issues/123990}: Remove @code{WITH_FREELISTS} macro and @code{--without-freelists}
build configuration

@item 
gh-124102@footnote{https://github.com/python/cpython/issues/124102}: Update internal documentation under PCbuild, so it now
correctly states that Windows requires VS2017 or later and Python 3.10 or
later

@item 
gh-124043@footnote{https://github.com/python/cpython/issues/124043}: Building using @ref{487,,--with-trace-refs} is (temporarily)
disallowed when the GIL is disabled.

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Updated Android build to use OpenSSL 3.0.15.

@item 
gh-123297@footnote{https://github.com/python/cpython/issues/123297}: Propagate the value of @code{LDFLAGS} to @code{LDCXXSHARED} in
@ref{db,,sysconfig}. Patch by Pablo Galindo

@item 
gh-121634@footnote{https://github.com/python/cpython/issues/121634}: Allow for specifying the target compile triple for WASI.

@item 
gh-122578@footnote{https://github.com/python/cpython/issues/122578}: Use WASI SDK 24 for testing.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Rename build variable @code{MODULE_LDFLAGS} back to @code{LIBPYTHON},
as it’s used by package build systems (e.g. Meson).

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Fix an issue where the experimental JIT could be built several
times by the @code{make regen-all} target, leading to possible race
conditions on heavily parallelized builds.

@item 
gh-121996@footnote{https://github.com/python/cpython/issues/121996}: Introduce ./configure –disable-safety and
–enable-slower-safety options. Patch by Donghee Na.

@item 
gh-120522@footnote{https://github.com/python/cpython/issues/120522}: Added a @ref{162e,,--with-app-store-compliance} option to patch
out known issues with macOS/iOS App Store review processes.

@item 
gh-120371@footnote{https://github.com/python/cpython/issues/120371}: Support WASI SDK 22 by explicitly skipping functions that are
just stubs in wasi-libc.

@item 
gh-121731@footnote{https://github.com/python/cpython/issues/121731}: Fix mimalloc compile error on GNU/Hurd

@item 
gh-121487@footnote{https://github.com/python/cpython/issues/121487}: Fix deprecation warning for ATOMIC_VAR_INIT in mimalloc.

@item 
gh-121467@footnote{https://github.com/python/cpython/issues/121467}: Fix a Makefile bug that prevented mimalloc header files from
being installed.

@item 
gh-121103@footnote{https://github.com/python/cpython/issues/121103}: On POSIX systems, excluding macOS framework installs, the lib
directory for the free-threaded build now includes a «t» suffix to avoid
conflicts with a co-located default build installation.

@item 
gh-120831@footnote{https://github.com/python/cpython/issues/120831}: The default minimum iOS version was increased to 13.0.

@item 
gh-121082@footnote{https://github.com/python/cpython/issues/121082}: Fix build failure when the developer use @code{--enable-pystats}
arguments in configuration command after #118450.

@item 
gh-120671@footnote{https://github.com/python/cpython/issues/120671}: Fix failing configure tests due to a missing space when
appending to CFLAGS.

@item 
gh-120602@footnote{https://github.com/python/cpython/issues/120602}: Correctly handle LLVM installs with @code{LLVM_VERSION_SUFFIX}
when building with @code{--enable-experimental-jit}.

@item 
gh-120688@footnote{https://github.com/python/cpython/issues/120688}: On WASI in debug mode, Python is now built with compiler flag
@code{-O3} instead of @code{-Og}, to support more recursive calls. Patch by
Victor Stinner.

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Fix a possible race condition affecting parallel builds
configured with @code{--enable-experimental-jit}, in which
@ref{f46,,FileNotFoundError} could be caused by another process already moving
@code{jit_stencils.h.new} to @code{jit_stencils.h}.

@item 
gh-120326@footnote{https://github.com/python/cpython/issues/120326}: On Windows, fix build error when @code{--disable-gil} and
@code{--experimental-jit} options are combined.

@item 
gh-120291@footnote{https://github.com/python/cpython/issues/120291}: Make the @code{python-config} shell script compatible with
non-bash shells.

@item 
gh-113565@footnote{https://github.com/python/cpython/issues/113565}: Improve @ref{2c,,curses} and @ref{2e,,curses.panel} dependency checks
in @code{configure}.

@item 
gh-119729@footnote{https://github.com/python/cpython/issues/119729}: On POSIX systems, the pkg-config (@code{.pc}) filenames now
include the ABI flags, which may include debug («d») and free-threaded
(«t»).  For example: * @code{python-3.14.pc} (default, non-debug build) *
@code{python-3.14d.pc} (default, debug build) * @code{python-3.14t.pc}
(free-threaded build)

@item 
gh-119400@footnote{https://github.com/python/cpython/issues/119400}: @code{make_ssl_certs}, the script that prepares certificate data
for the test suite, now allows specifying expiration dates.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Fall back to the bundled libmpdec if a system version cannot be
found.

@item 
gh-119132@footnote{https://github.com/python/cpython/issues/119132}: Update @ref{2e4,,sys.version} to identify whether the build is
default build or free-threading build. Patch By Donghee Na.

@item 
gh-118836@footnote{https://github.com/python/cpython/issues/118836}: Fix an @code{AssertionError} when building with
@code{--enable-experimental-jit} and the compiler emits a @code{SHT_NOTE}
section.

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Fix a possible race condition affecting parallel builds
configured with @code{--enable-experimental-jit}, in which compilation errors
could be caused by an incompletely-generated header file.
@end itemize

@node Python 3 13 0 beta 1,Python 3 13 0 alpha 6,Python 3 14 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-beta-1}@anchor{162f}
@subsection Python 3.13.0 beta 1


`Release date: 2024-05-08'

@menu
* Security: Security<3>. 
* Core and Builtins: Core and Builtins<3>. 
* Library: Library<3>. 
* Documentation: Documentation<3>. 
* Build: Build<3>. 
* Windows: Windows<3>. 
* macOS: macOS<2>. 
* IDLE: IDLE<4>. 
* C API: C API<3>. 

@end menu

@node Security<3>,Core and Builtins<3>,,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id11}@anchor{1630}
@subsubsection Security



@itemize -

@item 
gh-116741@footnote{https://github.com/python/cpython/issues/116741}: Update bundled libexpat to 2.6.2

@item 
gh-117233@footnote{https://github.com/python/cpython/issues/117233}: Detect BLAKE2, SHA3, Shake, & truncated SHA512 support in the
OpenSSL-ish libcrypto library at build time.  This allows @ref{68,,hashlib}
to be used with libraries that do not to support every algorithm that
upstream OpenSSL does.
@end itemize

@node Core and Builtins<3>,Library<3>,Security<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id12}@anchor{1631}
@subsubsection Core and Builtins



@itemize -

@item 
gh-118414@footnote{https://github.com/python/cpython/issues/118414}: Add instrumented opcodes to YIELD_VALUE assertion for tracing
cases.

@item 
gh-117953@footnote{https://github.com/python/cpython/issues/117953}: When a builtin or extension module is imported for the first
time, while a subinterpreter is active, the module’s init function is now
run by the main interpreter first before import continues in the
subinterpreter. Consequently, single-phase init modules now fail in an
isolated subinterpreter without the init function running under that
interpreter, whereas before it would run under the subinterpreter `before'
failing, potentially leaving behind global state and callbacks and
otherwise leaving the module in an inconsistent state.

@item 
gh-117549@footnote{https://github.com/python/cpython/issues/117549}: Don’t use designated initializer syntax in inline functions in
internal headers. They cause problems for C++ or MSVC users who aren’t yet
using the latest C++ standard (C++20). While internal, pycore_backoff.h,
is included (indirectly, via pycore_code.h) by some key 3rd party software
that does so for speed.

@item 
gh-95382@footnote{https://github.com/python/cpython/issues/95382}: Improve performance of @ref{dcc,,json.dumps()} and @ref{dcb,,json.dump()}
when using the argument `indent'. Depending on the data the encoding using
@ref{dcc,,json.dumps()} with `indent' can be up to 2 to 3 times faster.

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: In @code{--disable-gil} builds, the GIL will be enabled while
loading C extension modules. If the module indicates that it supports
running without the GIL, the GIL will be disabled once loading is
complete. Otherwise, the GIL will remain enabled for the remainder of the
interpreter’s lifetime. This behavior does not apply if the GIL has been
explicitly enabled or disabled with @code{PYTHON_GIL} or @code{-Xgil}.

@item 
gh-118513@footnote{https://github.com/python/cpython/issues/118513}: Fix incorrect @ref{1576,,UnboundLocalError} when two comprehensions
in the same function both reference the same name, and in one
comprehension the name is bound while in the other it’s an implicit
global.

@item 
gh-118518@footnote{https://github.com/python/cpython/issues/118518}: Allow the Linux perf support to work without frame pointers
using perf’s advanced JIT support. The feature is activated when using the
@code{PYTHON_PERF_JIT_SUPPORT} environment variable or when running Python
with @code{-Xperf_jit}. Patch by Pablo Galindo.

@item 
gh-117514@footnote{https://github.com/python/cpython/issues/117514}: Add @code{sys._is_gil_enabled()} function that returns whether the
GIL is currently enabled.  In the default build it always returns @code{True}
because the GIL is always enabled.  In the free-threaded build, it may
return @code{True} or @code{False}.

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: Break a loop between the Python implementation of the
@ref{37,,decimal} module and the Python code for integer to string
conversion. Also optimize integer to string conversion for values in the
range from 9_000 to 135_000 decimal digits.

@item 
gh-118473@footnote{https://github.com/python/cpython/issues/118473}: Fix @ref{1632,,sys.set_asyncgen_hooks()} not to be partially set when
raising @ref{228,,TypeError}.

@item 
gh-118465@footnote{https://github.com/python/cpython/issues/118465}: Compiler populates the new @code{__firstlineno__} field on a class
with the line number of the first line of the class definition.

@item 
gh-118492@footnote{https://github.com/python/cpython/issues/118492}: Fix an issue where the type cache can expose a previously
accessed attribute when a finalizer is run.

@item 
gh-117714@footnote{https://github.com/python/cpython/issues/117714}: update @code{async_generator.athrow().close()} and
@code{async_generator.asend().close()} to close their section of the
underlying async generator

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: The @ref{2d5,,interactive} interpreter is now implemented in
Python, which allows for a number of new features like colors, multiline
input, history viewing, and paste mode. Contributed by Pablo Galindo,
Łukasz Langa and Lysandros Nikolaou based on code from the PyPy project.

@item 
gh-74929@footnote{https://github.com/python/cpython/issues/74929}: Implement PEP 667: converted @ref{2ed,,FrameType.f_locals} and @ref{4dd,,PyFrame_GetLocals()} to return a
write-through proxy object when the frame refers to a function or
comprehension.

@item 
gh-116767@footnote{https://github.com/python/cpython/issues/116767}: Fix crash in compiler on “async with” that has many context
managers.

@item 
gh-118335@footnote{https://github.com/python/cpython/issues/118335}: Change how to use the tier 2 interpreter. Instead of running
Python with @code{-X uops} or setting the environment variable
@code{PYTHON_UOPS=1}, this choice is now made at build time by configuring
with @code{--enable-experimental-jit=interpreter}.

`Beware!' This changes the environment variable to enable or disable
micro-ops to @code{PYTHON_JIT}. The old @code{PYTHON_UOPS} is no longer used.

@item 
gh-118306@footnote{https://github.com/python/cpython/issues/118306}: Update JIT compilation to use LLVM 18

@item 
gh-118160@footnote{https://github.com/python/cpython/issues/118160}: @ref{2f3,,Annotation scopes} within classes can
now contain comprehensions. However, such comprehensions are not inlined
into their parent scope at runtime. Patch by Jelle Zijlstra.

@item 
gh-118272@footnote{https://github.com/python/cpython/issues/118272}: Fix bug where @code{generator.close} does not free the generator
frame’s locals.

@item 
gh-118216@footnote{https://github.com/python/cpython/issues/118216}: Don’t consider @ref{0,,__future__} imports with dots before the
module name.

@item 
gh-118074@footnote{https://github.com/python/cpython/issues/118074}: Make sure that the Executor objects in the COLD_EXITS array
aren’t assumed to be GC-able (which would access bytes outside the
object).

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: Lazy load frame line number to improve performance of tracing

@item 
gh-118082@footnote{https://github.com/python/cpython/issues/118082}: Improve @ref{150,,SyntaxError} message for imports without names,
like in @code{from x import} and @code{import} cases. It now points out to users
that @ref{682,,import} expects at least one name after it.

@item 
gh-118090@footnote{https://github.com/python/cpython/issues/118090}: Improve @ref{150,,SyntaxError} message for empty type param
brackets.

@item 
gh-117958@footnote{https://github.com/python/cpython/issues/117958}: Added a @code{get_jit_code()} method to access JIT compiled
machine code from the UOp Executor when the experimental JIT is enabled.
Patch by Anthony Shaw.

@item 
gh-117901@footnote{https://github.com/python/cpython/issues/117901}: Add option for compiler’s codegen to save nested instruction
sequences for introspection.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Redirect stdout and stderr to system log when embedded in an
Android app.

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: @ref{2f3,,annotation scope} within class scopes
can now contain lambdas.

@item 
gh-117894@footnote{https://github.com/python/cpython/issues/117894}: Prevent @code{agen.aclose()} objects being re-used after
@code{.throw()}.

@item 
gh-117881@footnote{https://github.com/python/cpython/issues/117881}: prevent concurrent access to an async generator via
athrow().throw() or asend().throw()

@item 
gh-117536@footnote{https://github.com/python/cpython/issues/117536}: Fix a @ref{323,,RuntimeWarning} when calling
@code{agen.aclose().throw(Exception)}.

@item 
gh-117755@footnote{https://github.com/python/cpython/issues/117755}: Fix mimalloc allocator for huge memory allocation (around
8,589,934,592 GiB) on s390x. Patch by Victor Stinner.

@item 
gh-117750@footnote{https://github.com/python/cpython/issues/117750}: Fix issue where an object’s dict would get out of sync with the
object’s internal values when being cleared. @code{obj.__dict__.clear()} now
clears the internal values, but leaves the dict attached to the object.

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Improve the performance of the following @ref{325,,bytes} and
@ref{5e0,,bytearray} methods by adapting them to the
@ref{1633,,METH_FASTCALL} calling convention:


@itemize *

@item 
@code{count()}

@item 
@code{find()}

@item 
@code{index()}

@item 
@code{rfind()}

@item 
@code{rindex()}
@end itemize

@item 
gh-117709@footnote{https://github.com/python/cpython/issues/117709}: Speed up calls to @ref{237,,str()} with positional-only argument, by
using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} calling convention. Patch by Erlend
Aasland.

@item 
gh-117680@footnote{https://github.com/python/cpython/issues/117680}: Give @code{_PyInstructionSequence} a Python interface and use it
in tests.

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: Statically allocated objects are, by definition, immortal so
must be marked as such regardless of whether they are in extension modules
or not.

@item 
gh-117385@footnote{https://github.com/python/cpython/issues/117385}: Remove unhandled @code{PY_MONITORING_EVENT_BRANCH} and
@code{PY_MONITORING_EVENT_EXCEPTION_HANDLED} events from
@ref{1540,,sys.settrace()}.

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: Extension modules may indicate to the runtime that they can run
without the GIL. Multi-phase init modules do so by calling providing
@code{Py_MOD_GIL_NOT_USED} for the @code{Py_mod_gil} slot, while single-phase
init modules call @code{PyUnstable_Module_SetGIL(mod, Py_MOD_GIL_NOT_USED)}
from their init function.

@item 
gh-116129@footnote{https://github.com/python/cpython/issues/116129}: Implement 
@geindex Python Enhancement Proposals; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}, adding support for defaults on type
parameters. Patch by Jelle Zijlstra.

@item 
gh-93502@footnote{https://github.com/python/cpython/issues/93502}: Add two new functions to the C-API,
@ref{460,,PyRefTracer_SetTracer()} and @ref{461,,PyRefTracer_GetTracer()}, that
allows to track object creation and destruction the same way the
@ref{ff,,tracemalloc} module does. Patch by Pablo Galindo

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: Improved the performance of @ref{1540,,sys.settrace()} significantly

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: Improve the error message when a script shadowing a module from
the standard library causes @ref{441,,AttributeError} to be raised. Similarly,
improve the error message when a script shadowing a third party module
attempts to access an attribute from that third party module while still
initialising.

@item 
gh-99180@footnote{https://github.com/python/cpython/issues/99180}: Elide uninformative traceback indicators in @code{return} and
simple @code{assignment} statements. Patch by Pablo Galindo.

@item 
gh-105879@footnote{https://github.com/python/cpython/issues/105879}: Allow the `globals' and `locals' arguments to @ref{2ea,,exec()} and
@ref{2eb,,eval()} to be passed as keywords.
@end itemize

@node Library<3>,Documentation<3>,Core and Builtins<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id13}@anchor{1634}
@subsubsection Library



@itemize -

@item 
gh-118418@footnote{https://github.com/python/cpython/issues/118418}: A @ref{1da,,DeprecationWarning} is now emitted if you fail to pass
a value to the new `type_params' parameter of @code{typing._eval_type()} or
@code{typing.ForwardRef._evaluate()}. (Using either of these private and
undocumented functions is discouraged to begin with, but failing to pass a
value to the @code{type_params} parameter may lead to incorrect behaviour on
Python 3.12 or newer.)

@item 
gh-118660@footnote{https://github.com/python/cpython/issues/118660}: Add an optional second type parameter to
@ref{d17,,typing.ContextManager} and @ref{1635,,typing.AsyncContextManager},
representing the return types of @ref{1367,,__exit__()} and
@ref{1636,,__aexit__()} respectively. This parameter defaults to @code{bool
| None}.

@item 
gh-118650@footnote{https://github.com/python/cpython/issues/118650}: The @code{enum} module allows method named @code{_repr_*} to be
defined on @code{Enum} types.

@item 
gh-118648@footnote{https://github.com/python/cpython/issues/118648}: Add type parameter defaults to @ref{1637,,typing.Generator} and
@ref{1638,,typing.AsyncGenerator}.

@item 
gh-101137@footnote{https://github.com/python/cpython/issues/101137}: Mime type @code{text/x-rst} is now supported by @ref{8f,,mimetypes}.

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: The Python implementation of the @code{decimal} module could
appear to hang in relatively small power cases (like @code{2**117}) if
context precision was set to a very high value. A different method to
check for exactly representable results is used now that doesn’t rely on
computing @code{10**precision} (which could be effectively too large to
compute).

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: @code{breakpoint()} and @code{pdb.set_trace()} now enter the debugger
immediately after the call rather than before the next line is executed.

@item 
gh-118500@footnote{https://github.com/python/cpython/issues/118500}: Add @ref{a5,,pdb} support for zipapps

@item 
gh-118406@footnote{https://github.com/python/cpython/issues/118406}: Add signature for @ref{39e,,sqlite3.Connection} objects.

@item 
gh-101732@footnote{https://github.com/python/cpython/issues/101732}: Use a Y2038 compatible openssl time function when available.

@item 
gh-118404@footnote{https://github.com/python/cpython/issues/118404}: Fix @ref{181,,inspect.signature()} for non-comparable callables.

@item 
gh-118402@footnote{https://github.com/python/cpython/issues/118402}: Fix @ref{181,,inspect.signature()} for the result of the
@ref{1247,,functools.cmp_to_key()} call.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: On Android, @ref{12af,,sysconfig.get_platform} now returns the
format specified by 
@geindex Python Enhancement Proposals; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}.

@item 
gh-118285@footnote{https://github.com/python/cpython/issues/118285}: Allow to specify the signature of custom callable instances of
extension type by the @code{__text_signature__} attribute. Specify signatures
of @ref{eb8,,operator.attrgetter}, @ref{af2,,operator.itemgetter}, and
@ref{eb9,,operator.methodcaller} instances.

@item 
gh-118314@footnote{https://github.com/python/cpython/issues/118314}: Fix an edge case in @ref{1639,,binascii.a2b_base64()} strict mode,
where excessive padding is not detected when no padding is necessary.

@item 
gh-118271@footnote{https://github.com/python/cpython/issues/118271}: Add the @code{PhotoImage} methods @code{read()} to read an
image from a file and @code{data()} to get the image data. Add
`background' and `grayscale' parameters to @code{PhotoImage} method
@code{write()}.

@item 
gh-118225@footnote{https://github.com/python/cpython/issues/118225}: Add the @code{PhotoImage} method @code{copy_replace()} to
copy a region from one image to other image, possibly with pixel zooming
and/or subsampling. Add `from_coords' parameter to @code{PhotoImage}
methods @code{copy()}, @code{zoom()} and @code{subsample()}. Add `zoom'
and `subsample' parameters to @code{PhotoImage} method @code{copy()}.

@item 
gh-118221@footnote{https://github.com/python/cpython/issues/118221}: Fix a bug where @ref{3a0,,sqlite3.Connection.iterdump()} could fail
if a custom @ref{163a,,row factory} was used.
Patch by Erlend Aasland.

@item 
gh-118013@footnote{https://github.com/python/cpython/issues/118013}: Fix regression introduced in gh-103193@footnote{https://github.com/python/cpython/issues/103193} that meant that calling
@ref{53d,,inspect.getattr_static()} on an instance would cause a strong
reference to that instance’s class to persist in an internal cache in the
@ref{7e,,inspect} module. This caused unexpected memory consumption if the
class was dynamically created, the class held strong references to other
objects which took up a significant amount of memory, and the cache
contained the sole strong reference to the class. The fix for the
regression leads to a slowdown in @code{getattr_static()}, but the
function should still be significantly faster than it was in Python 3.11.
Patch by Alex Waygood.

@item 
gh-118218@footnote{https://github.com/python/cpython/issues/118218}: Speed up @ref{8ac,,itertools.pairwise()} in the common case by up to
1.8x.

@item 
gh-117486@footnote{https://github.com/python/cpython/issues/117486}: Improve the behavior of user-defined subclasses of
@ref{30d,,ast.AST}. Such classes will now require no changes in the usual
case to conform with the behavior changes of the @ref{9,,ast} module in
Python 3.13. Patch by Jelle Zijlstra.

@item 
gh-90848@footnote{https://github.com/python/cpython/issues/90848}: Fixed @ref{15c9,,unittest.mock.create_autospec()} to configure parent
mock with keyword arguments.

@item 
gh-118168@footnote{https://github.com/python/cpython/issues/118168}: Fix incorrect argument substitution when @ref{163b,,typing.Unpack}
is used with the builtin @ref{464,,tuple}. @code{typing.Unpack} now raises
@ref{228,,TypeError} when used with certain invalid types. Patch by Jelle
Zijlstra.

@item 
gh-118131@footnote{https://github.com/python/cpython/issues/118131}: Add command-line interface for the @ref{b8,,random} module. Patch
by Hugo van Kemenade.

@item 
gh-118107@footnote{https://github.com/python/cpython/issues/118107}: Fix @ref{131,,zipimport} reading of ZIP64 files with file entries
that are too big or offset too far.

@item 
gh-102511@footnote{https://github.com/python/cpython/issues/102511}: Fix @ref{1382,,os.path.normpath()} for UNC paths on Windows. Speed up
@ref{54c,,os.path.splitroot()} with a native implementation.

@item 
gh-117535@footnote{https://github.com/python/cpython/issues/117535}: Change the unknown filename of @ref{112,,warnings} from @code{sys} to
@code{<sys>} to clarify that it’s not a real filename.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Fix erroneous @ref{4ec,,NameError} when calling
@ref{752,,typing.get_type_hints()} on a class that made use of 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} type
parameters in a module that had @code{from __future__ import annotations} at
the top of the file. Patch by Alex Waygood.

@item 
gh-116931@footnote{https://github.com/python/cpython/issues/116931}: Add parameter `fileobj' check for
@ref{163c,,tarfile.TarFile.addfile()}

@item 
gh-117995@footnote{https://github.com/python/cpython/issues/117995}: Don’t raise @ref{1da,,DeprecationWarning} when a @ref{597,,sequence}
of parameters is used to bind indexed, nameless placeholders. See also
gh-100668@footnote{https://github.com/python/cpython/issues/100668}.

@item 
gh-80361@footnote{https://github.com/python/cpython/issues/80361}: Fix TypeError in @ref{123a,,email.message.Message.get_payload()} when
the charset is 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} encoded.

@item 
gh-86650@footnote{https://github.com/python/cpython/issues/86650}: Fix IndexError when parse some emails with invalid Message-ID
(including one-off addresses generated by Microsoft Outlook).

@item 
gh-117691@footnote{https://github.com/python/cpython/issues/117691}: Improve the error messages emitted by @ref{de,,tarfile}
deprecation warnings relating to PEP 706. If a @code{filter} argument is not
provided to @code{extract()} or @code{extractall}, the deprecation warning now
points to the line in the user’s code where the relevant function was
called. Patch by Alex Waygood.

@item 
gh-115874@footnote{https://github.com/python/cpython/issues/115874}: Fixed a possible segfault during garbage collection of
@code{_asyncio.FutureIter} objects. Patch by Savannah Ostrowski.

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: Speed up @ref{388,,pathlib.Path.glob()} by omitting an initial
@ref{38b,,is_dir()} call. As a result of this change,
@ref{388,,glob()} can no longer raise @ref{4d5,,OSError}.

@item 
gh-77102@footnote{https://github.com/python/cpython/issues/77102}: @ref{c7,,site} module now parses @code{.pth} file with UTF-8 first,
and @ref{39b,,locale encoding} if @code{UnicodeDecodeError} happened. It
supported only locale encoding before.

@item 
gh-76785@footnote{https://github.com/python/cpython/issues/76785}: We’ve exposed the low-level @code{_interpreters} module for the
sake of the PyPI implementation of 
@geindex Python Enhancement Proposals; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}.  It was sometimes available
as the @code{_xxsubinterpreters} module and was formerly used only for
testing. For the most part, it should be considered an internal module,
like @code{_thread} and @code{_imp}. See
@indicateurl{https://discuss.python.org/t/pep-734-multiple-interpreters-in-the-stdlib/41147/26}.

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: Speed up @ref{388,,pathlib.Path.glob()} by not scanning directories
for non-wildcard pattern segments.

@item 
gh-117727@footnote{https://github.com/python/cpython/issues/117727}: Speed up @ref{163d,,pathlib.Path.iterdir()} by using
@ref{1a2,,os.scandir()} internally.

@item 
gh-117586@footnote{https://github.com/python/cpython/issues/117586}: Speed up @ref{550,,pathlib.Path.walk()} by working with strings
internally.

@item 
gh-117722@footnote{https://github.com/python/cpython/issues/117722}: Change the new multi-separator support in
@ref{31b,,asyncio.StreamReader.readuntil()} to only accept tuples of separators
rather than arbitrary iterables.

@item 
gh-117692@footnote{https://github.com/python/cpython/issues/117692}: Fixes a bug when @ref{163e,,doctest.DocTestFinder} was failing on
wrapped @code{builtin_function_or_method}.

@item 
gh-117348@footnote{https://github.com/python/cpython/issues/117348}: Largely restored import time performance of configparser by
avoiding dataclasses.

@item 
gh-117641@footnote{https://github.com/python/cpython/issues/117641}: Speedup @ref{ec2,,os.path.commonpath()} on Unix.

@item 
gh-117663@footnote{https://github.com/python/cpython/issues/117663}: Fix @code{_simple_enum} to detect aliases when multiple arguments
are present but only one is the member value.

@item 
gh-117636@footnote{https://github.com/python/cpython/issues/117636}: Speedup @ref{163f,,os.path.join()}.

@item 
gh-117618@footnote{https://github.com/python/cpython/issues/117618}: Support @code{package.module} as @code{filename} for @code{break}
command of @ref{a5,,pdb}

@item 
gh-102247@footnote{https://github.com/python/cpython/issues/102247}: the status codes enum with constants in http.HTTPStatus are
updated to include the names from RFC9110. This RFC includes some HTTP
statuses previously only used for WEBDAV and assigns more generic names to
them.

The old constants are preserved for backwards compatibility.

@item 
gh-117607@footnote{https://github.com/python/cpython/issues/117607}: Speedup @ref{552,,os.path.relpath()}.

@item 
gh-117586@footnote{https://github.com/python/cpython/issues/117586}: Speed up @ref{388,,pathlib.Path.glob()} by working with strings
internally.

@item 
gh-117225@footnote{https://github.com/python/cpython/issues/117225}: Add colour to doctest output. Patch by Hugo van Kemenade.

@item 
gh-117566@footnote{https://github.com/python/cpython/issues/117566}: @ref{1640,,ipaddress.IPv6Address.is_loopback()} will now return
@code{True} for IPv4-mapped loopback addresses, i.e. addresses in the
@code{::ffff:127.0.0.0/104} address space.

@item 
gh-117546@footnote{https://github.com/python/cpython/issues/117546}: Fix issue where @ref{381,,os.path.realpath()} stopped resolving
symlinks after encountering a symlink loop on POSIX.

@item 
gh-116720@footnote{https://github.com/python/cpython/issues/116720}: Improved behavior of @ref{31c,,asyncio.TaskGroup} when an
external cancellation collides with an internal cancellation. For example,
when two task groups are nested and both experience an exception in a
child task simultaneously, it was possible that the outer task group would
misbehave, because its internal cancellation was swallowed by the inner
task group.

In the case where a task group is cancelled externally and also must raise
an @ref{31d,,ExceptionGroup}, it will now call the parent task’s
@ref{31e,,cancel()} method. This ensures that a
@ref{31f,,asyncio.CancelledError} will be raised at the next @ref{14e,,await},
so the cancellation is not lost.

An added benefit of these changes is that task groups now preserve the
cancellation count (@ref{320,,asyncio.Task.cancelling()}).

In order to handle some corner cases, @ref{321,,asyncio.Task.uncancel()} may
now reset the undocumented @code{_must_cancel} flag when the cancellation
count reaches zero.

@item 
gh-117516@footnote{https://github.com/python/cpython/issues/117516}: Add @ref{2cf,,typing.TypeIs}, implementing 
@geindex Python Enhancement Proposals; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}. Patch by
Jelle Zijlstra.

@item 
gh-117503@footnote{https://github.com/python/cpython/issues/117503}: Fix support of non-ASCII user names in bytes paths in
@ref{aa6,,os.path.expanduser()} on Posix.

@item 
gh-117394@footnote{https://github.com/python/cpython/issues/117394}: @ref{aa4,,os.path.ismount()} is now 2-3 times faster if the user has
permissions.

@item 
gh-117313@footnote{https://github.com/python/cpython/issues/117313}: Only treat @code{'\n'}, @code{'\r'} and @code{'\r\n'} as line separators
in re-folding the @ref{3c,,email} messages. Preserve control characters
@code{'\v'}, @code{'\f'}, @code{'\x1c'}, @code{'\x1d'} and @code{'\x1e'} and Unicode line
separators @code{'\x85'}, @code{'\u2028'} and @code{'\u2029'} as is.

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: Convert @code{_ctypes} to multi-phase initialisation
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: Add the @ref{365,,mimetypes.guess_file_type()} function which works
with file path. Passing file path instead of URL in
@ref{366,,guess_type()} is @ref{1c4,,soft deprecated}.

@item 
gh-68583@footnote{https://github.com/python/cpython/issues/68583}: webbrowser CLI: replace getopt with argparse, add long options.
Patch by Hugo van Kemenade.

@item 
gh-116871@footnote{https://github.com/python/cpython/issues/116871}: Name suggestions for @ref{441,,AttributeError} and
@ref{4d7,,ImportError} now only include underscored names if the original name
was underscored.

@item 
gh-116023@footnote{https://github.com/python/cpython/issues/116023}: Don’t show empty fields (value @code{None} or @code{[]}) in
@ref{97b,,ast.dump()} by default. Add @code{show_empty=False} parameter to
optionally show them.

@item 
gh-115961@footnote{https://github.com/python/cpython/issues/115961}: Added @code{name} and @code{mode} attributes for compressed
and archived file-like objects in modules @ref{14,,bz2}, @ref{8a,,lzma},
@ref{de,,tarfile} and @ref{130,,zipfile}. The value of the @code{mode}
attribute of @ref{4d8,,gzip.GzipFile} was changed from integer (@code{1} or
@code{2}) to string (@code{'rb'} or @code{'wb'}). The value of the @code{mode}
attribute of the readable file-like object returned by
@ref{4d9,,zipfile.ZipFile.open()} was changed from @code{'r'} to @code{'rb'}.

@item 
gh-82062@footnote{https://github.com/python/cpython/issues/82062}: Fix @ref{181,,inspect.signature()} to correctly handle parameter
defaults on methods in extension modules that use names defined in the
module namespace.

@item 
gh-83856@footnote{https://github.com/python/cpython/issues/83856}: Honor @ref{d,,atexit} for all @ref{94,,multiprocessing} start methods

@item 
gh-113081@footnote{https://github.com/python/cpython/issues/113081}: Print colorized exception just like built-in traceback in
@ref{a5,,pdb}

@item 
gh-112855@footnote{https://github.com/python/cpython/issues/112855}: Speed up pickling of @ref{54e,,pathlib.PurePath} objects. Patch
by Barney Gale.

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: Support opcode events in @ref{10,,bdb}

@item 
gh-109617@footnote{https://github.com/python/cpython/issues/109617}: @code{ncurses}: fixed a crash that could occur on macOS 13 or
earlier when Python was built with Apple Xcode 15’s SDK.

@item 
gh-83151@footnote{https://github.com/python/cpython/issues/83151}: Enabled arbitrary statements and evaluations in @ref{a5,,pdb} shell
to access the local variables of the current frame, which made it possible
for multi-scope code like generators or nested function to work.

@item 
gh-110209@footnote{https://github.com/python/cpython/issues/110209}: Add @ref{7d6,,__class_getitem__()} to
@ref{1641,,types.GeneratorType} and @ref{f0c,,types.CoroutineType} for type
hinting purposes. Patch by James Hilton-Balfe.

@item 
gh-108191@footnote{https://github.com/python/cpython/issues/108191}: The @ref{334,,types.SimpleNamespace} now accepts an optional
positional argument which specifies initial values of attributes as a dict
or an iterable of key-value pairs.

@item 
gh-62090@footnote{https://github.com/python/cpython/issues/62090}: Fix assertion errors caused by whitespace in metavars or
@code{SUPPRESS}-ed groups in @ref{7,,argparse} by simplifying usage formatting.
Patch by Ali Hamdan.

@item 
gh-102402@footnote{https://github.com/python/cpython/issues/102402}: Adjust @code{logging.LogRecord} to use @code{time.time_ns()} and fix
minor bug related to floating-point math.

@item 
gh-100242@footnote{https://github.com/python/cpython/issues/100242}: Bring pure Python implementation @code{functools.partial.__new__}
more in line with the C-implementation by not just always checking for the
presence of the attribute @code{'func'} on the first argument of @code{partial}.
Instead, both the Python version and the C version perform an
@code{isinstance(func, partial)} check on the first argument of @code{partial}.

@item 
gh-99730@footnote{https://github.com/python/cpython/issues/99730}: HEAD requests are no longer upgraded to GET request during
redirects in urllib.

@item 
gh-66410@footnote{https://github.com/python/cpython/issues/66410}: Setting the @code{tkinter} module global @code{wantobjects}
to @code{2} before creating the @ref{1642,,Tk} object or call the
@code{wantobjects()} method of the @code{Tk} object with argument @code{2}
makes now arguments to callbacks registered in the @ref{f0,,tkinter} module
to be passed as various Python objects (@code{int}, @code{float}, @code{bytes},
@code{tuple}), depending on their internal representation in Tcl, instead of
always @code{str}. @code{tkinter.wantobjects} is now set to @code{2} by
default.

@item 
bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}: Fix several IndexError when parse emails with truncated
Message-ID, address, routes, etc, e.g. @code{example@@}.

@item 
bpo-39324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39324}: Add mime type mapping for .md <-> text/markdown

@item 
bpo-18108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18108}: @ref{399,,shutil.chown()} now supports `dir_fd' and
`follow_symlinks' keyword arguments.

@item 
bpo-30988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30988}: Fix parsing of emails with invalid address headers having a
leading or trailing dot. Patch by tsufeki.

@item 
bpo-32839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32839}: Add the @code{after_info()} method for Tkinter widgets.
@end itemize

@node Documentation<3>,Build<3>,Library<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id14}@anchor{1643}
@subsubsection Documentation



@itemize -

@item 
gh-117928@footnote{https://github.com/python/cpython/issues/117928}: The minimum Sphinx version required for the documentation is
now 6.2.1.
@end itemize

@node Build<3>,Windows<3>,Documentation<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id15}@anchor{1644}
@subsubsection Build



@itemize -

@item 
gh-118734@footnote{https://github.com/python/cpython/issues/118734}: Fixes Windows build when invoked directly (not through the
@code{build.bat} script) without specifying a value for @code{UseTIER2}.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: The @code{configure} option @ref{4d2,,--with-system-libmpdec}
now defaults to @code{yes}. The bundled copy of @code{libmpdecimal} will be
removed in Python 3.15.

@item 
gh-117845@footnote{https://github.com/python/cpython/issues/117845}: Fix building against recent libedit versions by detecting
readline hook signatures in @code{configure}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: A testbed project was added to run the test suite on Android.

@item 
gh-117645@footnote{https://github.com/python/cpython/issues/117645}: Increase WASI stack size from 512 KiB to 8 MiB and the initial
memory from 10 MiB to 20 MiB. Patch by Victor Stinner.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: @code{configure} now uses @code{pkg-config} to detect
@ref{37,,decimal} dependencies if the @ref{4d2,,--with-system-libmpdec} option
is given.
@end itemize

@node Windows<3>,macOS<2>,Build<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id16}@anchor{1645}
@subsubsection Windows



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Update Windows installer to use libmpdecimal 4.0.0.

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: @ref{37a,,os.mkdir()} now accepts `mode' of @code{0o700} to restrict
the new directory to the current user.

@item 
gh-118347@footnote{https://github.com/python/cpython/issues/118347}: Fixes launcher updates not being installed.

@item 
gh-118293@footnote{https://github.com/python/cpython/issues/118293}: The @code{multiprocessing} module now passes the
@code{STARTF_FORCEOFFFEEDBACK} flag when spawning processes to tell Windows
not to change the mouse cursor.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Update Windows installer to use SQLite 3.45.3.

@item 
gh-90329@footnote{https://github.com/python/cpython/issues/90329}: Suppress the warning displayed on virtual environment creation
when the requested and created paths differ only by a short (8.3 style)
name. Warnings will continue to be shown if a junction or symlink in the
path caused the venv to be created in a different location than originally
requested.

@item 
gh-117786@footnote{https://github.com/python/cpython/issues/117786}: Fixes virtual environments not correctly launching when created
from a Store install.
@end itemize

@node macOS<2>,IDLE<4>,Windows<3>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id17}@anchor{1646}
@subsubsection macOS



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Update macOS installer to use libmpdecimal 4.0.0.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: iOS preprocessor symbol usage was made compatible with older
macOS SDKs.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Update macOS installer to use SQLite 3.45.3.

@item 
gh-91629@footnote{https://github.com/python/cpython/issues/91629}: Use @code{~/.config/fish/conf.d} configs and
@code{fish_add_path} to set 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} when installing for the
Fish shell.
@end itemize

@node IDLE<4>,C API<3>,macOS<2>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id18}@anchor{1647}
@subsubsection IDLE



@itemize -

@item 
bpo-34774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34774}: Use user-selected color theme for Help => IDLE Doc.
@end itemize

@node C API<3>,,IDLE<4>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id19}@anchor{1648}
@subsubsection C API



@itemize -

@item 
gh-118124@footnote{https://github.com/python/cpython/issues/118124}: Fix @code{Py_BUILD_ASSERT} and
@code{Py_BUILD_ASSERT_EXPR} for non-constant expressions: use
@code{static_assert()} on C11 and newer. Patch by Victor Stinner.

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: Add «Raw» variant of PyTime functions


@itemize *

@item 
@ref{426,,PyTime_MonotonicRaw()}

@item 
@ref{428,,PyTime_PerfCounterRaw()}

@item 
@ref{42a,,PyTime_TimeRaw()}
@end itemize

Patch by Victor Stinner.

@item 
gh-117987@footnote{https://github.com/python/cpython/issues/117987}: Restore functions removed in Python 3.13 alpha 1:


@itemize *

@item 
@ref{1649,,Py_SetPythonHome()}

@item 
@ref{164a,,Py_SetProgramName()}

@item 
@ref{164b,,PySys_SetArgvEx()}

@item 
@ref{164c,,PySys_SetArgv()}
@end itemize

Patch by Victor Stinner.

@item 
gh-117929@footnote{https://github.com/python/cpython/issues/117929}: Restore removed @ref{164d,,PyEval_InitThreads()} function. Patch by
Victor Stinner.

@item 
gh-117534@footnote{https://github.com/python/cpython/issues/117534}: Improve validation logic in the C implementation of
@ref{6b7,,datetime.datetime.fromisoformat()} to better handle invalid years.
Patch by Vlad Efanov.

@item 
gh-68114@footnote{https://github.com/python/cpython/issues/68114}: Fixed skipitem()”s handling of the old “w” and “w#” formatters.
These are no longer supported and now raise an exception if used.

@item 
gh-111997@footnote{https://github.com/python/cpython/issues/111997}: Add a C-API for firing monitoring events.
@end itemize

@node Python 3 13 0 alpha 6,Python 3 13 0 alpha 5,Python 3 13 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-6}@anchor{164e}
@subsection Python 3.13.0 alpha 6


`Release date: 2024-04-09'

@menu
* Core and Builtins: Core and Builtins<4>. 
* Library: Library<4>. 
* Documentation: Documentation<4>. 
* Tests: Tests<3>. 
* Build: Build<4>. 
* Windows: Windows<4>. 
* C API: C API<4>. 

@end menu

@node Core and Builtins<4>,Library<4>,,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id20}@anchor{164f}
@subsubsection Core and Builtins



@itemize -

@item 
gh-117494@footnote{https://github.com/python/cpython/issues/117494}: Refactored the instruction sequence data structure out of
compile.c into instruction_sequence.c.

@item 
gh-116968@footnote{https://github.com/python/cpython/issues/116968}: Introduce a unified 16-bit backoff counter type
(@code{_Py_BackoffCounter}), shared between the Tier 1 adaptive specializer
and the Tier 2 optimizer. The API used for adaptive specialization
counters is changed but the behavior is (supposed to be) identical.

The behavior of the Tier 2 counters is changed:


@itemize *

@item 
There are no longer dynamic thresholds (we never varied these).

@item 
All counters now use the same exponential backoff.

@item 
The counter for @code{JUMP_BACKWARD} starts counting down from 16.

@item 
The @code{temperature} in side exits starts counting down from 64.
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Improve the performance of the following @ref{325,,bytes} and
@ref{5e0,,bytearray} methods by adapting them to the
@ref{1633,,METH_FASTCALL} calling convention:


@itemize *

@item 
@code{endswith()}

@item 
@code{startswith()}
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Improve the performance of the following @ref{237,,str} methods
by adapting them to the @ref{1633,,METH_FASTCALL} calling convention:


@itemize *

@item 
@ref{1617,,count()}

@item 
@ref{f4d,,endswith()}

@item 
@ref{f29,,find()}

@item 
@ref{1650,,index()}

@item 
@ref{f2a,,rfind()}

@item 
@ref{12c5,,rindex()}

@item 
@ref{f4c,,startswith()}
@end itemize

@item 
gh-117411@footnote{https://github.com/python/cpython/issues/117411}: Move @code{PyFutureFeatures} to an internal header and make it
private.

@item 
gh-109120@footnote{https://github.com/python/cpython/issues/109120}: Added handle of incorrect star expressions, e.g @code{f(3, *)}.
Patch by Grigoryev Semyon

@item 
gh-117266@footnote{https://github.com/python/cpython/issues/117266}: Fix crashes for certain user-created subclasses of
@ref{30d,,ast.AST}. Such classes are now expected to set the
@code{_field_types} attribute.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Updated the @ref{68,,hashlib} built-in HACL* project@footnote{https://github.com/hacl-star/hacl-star} C code
from upstream that we use for many implementations when they are not
present via OpenSSL in a given build.  This also avoids the rare potential
for a C symbol name one definition rule linking issue.

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: Change the old space bit of objects in the young generation
from 0 to gcstate->visited, so that any objects created during GC will
have the old bit set correctly if they get moved into the old generation.

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: The cycle GC now chooses the size of increments based on the
total heap size, instead of the rate of object creation. This ensures that
it can keep up with growing heaps.

@item 
gh-116735@footnote{https://github.com/python/cpython/issues/116735}: For @code{INSTRUMENTED_CALL_FUNCTION_EX}, set @code{arg0} to
@code{sys.monitoring.MISSING} instead of @code{None} for
@ref{1651,,CALL} event.

@item 
gh-113964@footnote{https://github.com/python/cpython/issues/113964}: Starting new threads and process creation through
@ref{2ff,,os.fork()} are now only prevented once all non-daemon threads exit.

@item 
gh-116626@footnote{https://github.com/python/cpython/issues/116626}: Ensure @code{INSTRUMENTED_CALL_FUNCTION_EX} always emits
@ref{1651,,CALL}

@item 
gh-116554@footnote{https://github.com/python/cpython/issues/116554}: @code{list.sort()} now exploits more cases of partial ordering,
particularly those with long descending runs with sub-runs of equal
values. Those are recognized as single runs now (previously, each block of
repeated values caused a new run to be created).

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Added a Loader that can discover extension modules in an
iOS-style Frameworks folder.

@item 
gh-115775@footnote{https://github.com/python/cpython/issues/115775}: Compiler populates the new @code{__static_attributes__} field on a
class with the names of attributes of this class which are accessed
through self.X from any function in its body.

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: The array of values, the @code{PyDictValues} struct is now
embedded in the object during allocation. This provides better performance
in the common case, and does not degrade as much when the object’s
@code{__dict__} is materialized.

@item 
gh-108362@footnote{https://github.com/python/cpython/issues/108362}: Implement an incremental cyclic garbage collector. By
collecting the old generation in increments, there is no need for a full
heap scan. This can hugely reduce maximum pause time for programs with
large heaps.

Reduce the number of generations from three to two. The old generation is
split into two spaces, «visited» and «pending».

Collection happens in two steps:: * An increment is formed from the young
generation and a small part of the pending space. * This increment is
scanned and the survivors moved to the end of the visited space.

When the collecting space becomes empty, the two spaces are swapped.

@item 
gh-109870@footnote{https://github.com/python/cpython/issues/109870}: Dataclasses now calls @ref{2ea,,exec()} once per dataclass, instead
of once per method being added.  This can speed up dataclass creation by
up to 20%.

@item 
gh-97901@footnote{https://github.com/python/cpython/issues/97901}: Mime type @code{text/rtf} is now supported by @ref{8f,,mimetypes}.

@item 
bpo-24612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24612}: Improve the @ref{150,,SyntaxError} that happens when “not” appears
after an operator. Patch by Pablo Galindo
@end itemize

@node Library<4>,Documentation<4>,Core and Builtins<4>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id21}@anchor{1652}
@subsubsection Library



@itemize -

@item 
gh-117648@footnote{https://github.com/python/cpython/issues/117648}: Improve performance of @ref{163f,,os.path.join()} and
@ref{aa6,,os.path.expanduser()}.

@item 
gh-117584@footnote{https://github.com/python/cpython/issues/117584}: Raise @ref{228,,TypeError} for non-paths in
@code{posixpath.relpath()}.

@item 
gh-117467@footnote{https://github.com/python/cpython/issues/117467}: Preserve mailbox ownership when rewriting in
@code{mailbox.mbox.flush()}. Patch by Tony Mountifield.

@item 
gh-114848@footnote{https://github.com/python/cpython/issues/114848}: Raise @ref{f46,,FileNotFoundError} when @code{getcwd()} returns
“(unreachable)”, which can happen on Linux >= 2.6.36 with glibc < 2.27.

@item 
gh-117459@footnote{https://github.com/python/cpython/issues/117459}: @code{asyncio.asyncio.run_coroutine_threadsafe()} now keeps the
traceback of @code{CancelledError}, @ref{8cc,,TimeoutError} and
@code{InvalidStateError} which are raised in the coroutine.

@item 
gh-117381@footnote{https://github.com/python/cpython/issues/117381}: Fix error message for @code{ntpath.commonpath()}.

@item 
gh-117337@footnote{https://github.com/python/cpython/issues/117337}: Deprecate undocumented @code{glob.glob0()} and
@code{glob.glob1()} functions. Use @ref{3ef,,glob.glob()} and pass a directory
to its `root_dir' argument instead.

@item 
gh-117349@footnote{https://github.com/python/cpython/issues/117349}: Optimise several functions in @ref{a2,,os.path}.

@item 
gh-117348@footnote{https://github.com/python/cpython/issues/117348}: Refactored @code{configparser.RawConfigParser._read()} to reduce
cyclometric complexity and improve comprehensibility.

@item 
gh-117335@footnote{https://github.com/python/cpython/issues/117335}: Raise TypeError for non-sequences for
@code{ntpath.commonpath()}.

@item 
gh-66449@footnote{https://github.com/python/cpython/issues/66449}: @ref{32b,,configparser.ConfigParser} now accepts unnamed sections
before named ones, if configured to do so.

@item 
gh-88014@footnote{https://github.com/python/cpython/issues/88014}: In documentation of @ref{4d8,,gzip.GzipFile} in module gzip,
explain data type of optional constructor argument `mtime', and recommend
@code{mtime = 0} for generating deterministic streams.

@item 
gh-117310@footnote{https://github.com/python/cpython/issues/117310}: Fixed an unlikely early & extra @code{Py_DECREF} triggered crash
in @ref{d0,,ssl} when creating a new @code{_ssl._SSLContext} if CPython was
built implausibly such that the default cipher list is empty `or' the
SSL library it was linked against reports a failure from its C
@code{SSL_CTX_set_cipher_list()} API.

@item 
gh-117294@footnote{https://github.com/python/cpython/issues/117294}: A @code{DocTestCase} now reports as skipped if all examples in the
doctest are skipped.

@item 
gh-98966@footnote{https://github.com/python/cpython/issues/98966}: In @ref{d6,,subprocess}, raise a more informative message when
@code{stdout=STDOUT}.

@item 
gh-117225@footnote{https://github.com/python/cpython/issues/117225}: doctest: only print «and X failed» when non-zero, don’t
pluralise «1 items». Patch by Hugo van Kemenade.

@item 
gh-117205@footnote{https://github.com/python/cpython/issues/117205}: Speed up @ref{baf,,compileall.compile_dir()} by 20% when using
multiprocessing by increasing @code{chunksize}.

@item 
gh-117178@footnote{https://github.com/python/cpython/issues/117178}: Fix regression in lazy loading of self-referential modules,
introduced in gh-114781@footnote{https://github.com/python/cpython/issues/114781}.

@item 
gh-112383@footnote{https://github.com/python/cpython/issues/112383}: Fix @ref{39,,dis} module’s handling of @code{ENTER_EXECUTOR}
instructions.

@item 
gh-117182@footnote{https://github.com/python/cpython/issues/117182}: Lazy-loading of modules that modify their own @code{__class__} no
longer reverts the @code{__class__} to @ref{e98,,types.ModuleType}.

@item 
gh-117084@footnote{https://github.com/python/cpython/issues/117084}: Fix @ref{130,,zipfile} extraction for directory entries with the
name containing backslashes on Windows.

@item 
gh-117114@footnote{https://github.com/python/cpython/issues/117114}: Make @ref{1653,,os.path.isdevdrive()} available on all platforms. For
those that do not offer Dev Drives, it will always return @code{False}.

@item 
gh-117110@footnote{https://github.com/python/cpython/issues/117110}: Fix a bug that prevents subclasses of @ref{74d,,typing.Any} to be
instantiated with arguments. Patch by Chris Fu.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Deferred select imports in importlib.metadata and
importlib.resources for a 14% speedup.

@item 
gh-70647@footnote{https://github.com/python/cpython/issues/70647}: Start the deprecation period for the current behavior of
@ref{15ec,,datetime.datetime.strptime()} and @ref{146c,,time.strptime()} which always
fails to parse a date string with a @ref{360,,ValueError} involving a day of
month such as @code{strptime("02-29", "%m-%d")} when a year is `not'
specified and the date happen to be February 29th.  This should help avoid
users finding new bugs every four years due to a natural mistaken
assumption about the API when parsing partial date values.

@item 
gh-116987@footnote{https://github.com/python/cpython/issues/116987}: Fixed @code{inspect.findsource()} for class code objects.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Modify standard library to allow for iOS platform differences.

@item 
gh-90872@footnote{https://github.com/python/cpython/issues/90872}: On Windows, @ref{d6b,,subprocess.Popen.wait()} no longer calls
@code{WaitForSingleObject()} with a negative timeout: pass @code{0} ms if the
timeout is negative. Patch by Victor Stinner.

@item 
gh-116957@footnote{https://github.com/python/cpython/issues/116957}: configparser: Don’t leave ConfigParser values in an invalid
state (stored as a list instead of a str) after an earlier read raised
DuplicateSectionError or DuplicateOptionError.

@item 
gh-115538@footnote{https://github.com/python/cpython/issues/115538}: @code{_io.WindowsConsoleIO} now emit a warning if a boolean
value is passed as a filedescriptor argument.

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: Ignore empty lines and comments in @code{.pdbrc}

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: Refreshed zipfile._path from zipp 3.18@footnote{https://zipp.readthedocs.io/en/latest/history.html#v3-18-0}, providing
better compatibility for PyPy, better glob performance for deeply nested
zipfiles, and providing internal access to @code{CompleteDirs.inject} for use
in other tests (like importlib.resources).

@item 
gh-63207@footnote{https://github.com/python/cpython/issues/63207}: On Windows, @ref{3ad,,time.time()} now uses the
@code{GetSystemTimePreciseAsFileTime()} clock to have a resolution better
than 1 us, instead of the @code{GetSystemTimeAsFileTime()} clock which has a
resolution of 15.6 ms. Patch by Victor Stinner.

@item 
gh-116764@footnote{https://github.com/python/cpython/issues/116764}: Restore support of @code{None} and other false values in
@ref{10a,,urllib.parse} functions @ref{1c9,,parse_qs()} and
@ref{1c8,,parse_qsl()}. Also, they now raise a TypeError for
non-zero integers and non-empty sequences.

@item 
gh-116811@footnote{https://github.com/python/cpython/issues/116811}: In @code{PathFinder.invalidate_caches}, delegate to
@code{MetadataPathFinder.invalidate_caches}.

@item 
gh-116647@footnote{https://github.com/python/cpython/issues/116647}: Fix recursive child in dataclasses

@item 
gh-113171@footnote{https://github.com/python/cpython/issues/113171}: Fixed various false positives and false negatives in


@itemize *

@item 
@ref{1654,,ipaddress.IPv4Address.is_private} (see these docs for details)

@item 
@ref{fdf,,ipaddress.IPv4Address.is_global}

@item 
@ref{1655,,ipaddress.IPv6Address.is_private}

@item 
@ref{1656,,ipaddress.IPv6Address.is_global}
@end itemize

Also in the corresponding @ref{35c,,ipaddress.IPv4Network} and
@ref{35d,,ipaddress.IPv6Network} attributes.

@item 
gh-63283@footnote{https://github.com/python/cpython/issues/63283}: In @ref{52,,encodings.idna}, any capitalization of the the ACE
prefix (@code{xn--}) is now acceptable. Patch by Pepijn de Vos and Zackery
Spytz.

@item 
gh-71042@footnote{https://github.com/python/cpython/issues/71042}: Add @ref{1657,,platform.android_ver()}, which provides device and OS
information on Android.

@item 
gh-73468@footnote{https://github.com/python/cpython/issues/73468}: Added new @ref{363,,math.fma()} function, wrapping C99’s @code{fma()}
operation: fused multiply-add function. Patch by Mark Dickinson and Victor
Stinner.

@item 
gh-116608@footnote{https://github.com/python/cpython/issues/116608}: The @ref{7b,,importlib.resources} functions
@ref{34b,,is_resource()},
@ref{34c,,open_binary()},
@ref{34d,,open_text()}, @ref{34e,,path()},
@ref{34f,,read_binary()}, and
@ref{350,,read_text()} are un-deprecated, and support
subdirectories via multiple positional arguments. The
@ref{351,,contents()} function also allows subdirectories,
but remains deprecated.

@item 
gh-116484@footnote{https://github.com/python/cpython/issues/116484}: Change automatically generated @code{tkinter.Checkbutton}
widget names to avoid collisions with automatically generated
@code{tkinter.ttk.Checkbutton} widget names within the same parent
widget.

@item 
gh-114314@footnote{https://github.com/python/cpython/issues/114314}: In @ref{2b,,ctypes}, ctype data is now stored in type objects
directly rather than in a dict subclass. This is an internal change that
should not affect usage.

@item 
gh-116401@footnote{https://github.com/python/cpython/issues/116401}: Fix blocking @ref{be3,,os.fwalk()} and @ref{1f9,,shutil.rmtree()} on
opening named pipe.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Implement @ref{dd0,,ctypes.util.find_library()} on Android.

@item 
gh-90535@footnote{https://github.com/python/cpython/issues/90535}: Fix support of `interval' values > 1 in
@code{logging.TimedRotatingFileHandler} for @code{when='MIDNIGHT'} and
@code{when='Wx'}.

@item 
gh-113308@footnote{https://github.com/python/cpython/issues/113308}: Remove some internal protected parts from @ref{110,,uuid}:
@code{_has_uuid_generate_time_safe}, @code{_netbios_getnode},
@code{_ipconfig_getnode}, and @code{_load_system_functions}. They were unused.

@item 
gh-115627@footnote{https://github.com/python/cpython/issues/115627}: Fix the @ref{d0,,ssl} module error handling of connection
terminate by peer. It now throws an OSError with the appropriate error
code instead of an EOFError.

@item 
gh-114847@footnote{https://github.com/python/cpython/issues/114847}: Speed up @ref{381,,os.path.realpath()} on non-Windows platforms.

@item 
gh-114271@footnote{https://github.com/python/cpython/issues/114271}: Fix a race in @code{threading.Thread.join()}.

@code{threading._MainThread} now always represents the main thread of the
main interpreter.

@code{PyThreadState.on_delete} and @code{PyThreadState.on_delete_data} have been
removed.

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: Add @ref{319,,asyncio.Server.close_clients()} and
@ref{31a,,asyncio.Server.abort_clients()} methods which allow to more
forcefully close an asyncio server.

@item 
gh-85287@footnote{https://github.com/python/cpython/issues/85287}: Changes Unicode codecs to return UnicodeEncodeError or
UnicodeDecodeError, rather than just UnicodeError.

@item 
gh-113548@footnote{https://github.com/python/cpython/issues/113548}: @ref{a5,,pdb} now allows CLI arguments to @code{pdb -m}.

@item 
gh-112948@footnote{https://github.com/python/cpython/issues/112948}: Make completion of @ref{a5,,pdb} similar to Python REPL

@item 
gh-105866@footnote{https://github.com/python/cpython/issues/105866}: Fixed @code{_get_slots} bug which caused error when defining
dataclasses with slots and a weakref_slot.

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: Add @ref{b05,,asyncio.Queue} termination with
@ref{317,,shutdown()} method.

@item 
gh-89739@footnote{https://github.com/python/cpython/issues/89739}: The @ref{131,,zipimport} module can now read ZIP64 files.

@item 
bpo-33533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33533}: @ref{311,,asyncio.as_completed()} now returns an object that is both
an asynchronous iterator and plain iterator. The new asynchronous
iteration pattern allows for easier correlation between prior tasks and
their completed results. This is a closer match to
@ref{1658,,concurrent.futures.as_completed()}”s iteration pattern. Patch by
Justin Arthur.

@item 
bpo-27578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27578}: @ref{15ce,,inspect.getsource()} (and related functions) work with
empty module files, returning @code{'\n'} (or reasonable equivalent) instead
of raising @code{OSError}. Patch by Kernc.

@item 
bpo-37141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37141}: Accept an iterable of separators in
@ref{31b,,asyncio.StreamReader.readuntil()}, stopping when one of them is
encountered.

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: Make @ref{366,,mimetypes.guess_type()} properly parsing of URLs with
only a host name, URLs containing fragment or query, and filenames with
only a UNC sharepoint on Windows. Based on patch by Dong-hee Na.

@item 
bpo-15010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15010}: @ref{1064,,unittest.TestLoader.discover()} now saves the original
value of @code{unittest.TestLoader._top_level_dir} and restores it at the end
of the call.
@end itemize

@node Documentation<4>,Tests<3>,Library<4>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id22}@anchor{1659}
@subsubsection Documentation



@itemize -

@item 
gh-115977@footnote{https://github.com/python/cpython/issues/115977}: Remove compatibility references to Emscripten.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Add an iOS platform guide, and flag modules not available on
iOS.

@item 
gh-91565@footnote{https://github.com/python/cpython/issues/91565}: Changes to documentation files and config outputs to reflect the
new location for reporting bugs - i.e. GitHub rather than bugs.python.org.
@end itemize

@node Tests<3>,Build<4>,Documentation<4>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id23}@anchor{165a}
@subsubsection Tests



@itemize -

@item 
gh-83434@footnote{https://github.com/python/cpython/issues/83434}: Disable JUnit XML output (@code{--junit-xml=FILE} command line
option) in regrtest when hunting for reference leaks (@code{-R} option).
Patch by Victor Stinner.

@item 
gh-117187@footnote{https://github.com/python/cpython/issues/117187}: Fix XML tests for vanilla Expat <2.6.0.

@item 
gh-116333@footnote{https://github.com/python/cpython/issues/116333}: Tests of TLS related things (error codes, etc) were updated to
be more lenient about specific error message strings and behaviors as seen
in the BoringSSL and AWS-LC forks of OpenSSL.

@item 
gh-117089@footnote{https://github.com/python/cpython/issues/117089}: Consolidated tests for importlib.metadata in their own
@code{metadata} package.

@item 
gh-115979@footnote{https://github.com/python/cpython/issues/115979}: Update test_importlib so that it passes under WASI SDK 21.

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: Add –tsan to test.regrtest for running TSAN tests in
reasonable execution times. Patch by Donghee Na.

@item 
gh-116307@footnote{https://github.com/python/cpython/issues/116307}: Added import helper @code{isolated_modules} as @code{CleanImport}
does not remove modules imported during the context. Use it in
importlib.resources tests to avoid leaving @code{mod} around to impede
importlib.metadata tests.
@end itemize

@node Build<4>,Windows<4>,Tests<3>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id24}@anchor{165b}
@subsubsection Build



@itemize -

@item 
gh-114736@footnote{https://github.com/python/cpython/issues/114736}: Have WASI builds use WASI SDK 21.

@item 
gh-115983@footnote{https://github.com/python/cpython/issues/115983}: Skip building test modules that must be built as shared under
WASI.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Add Android build script and instructions.
@end itemize

@node Windows<4>,C API<4>,Build<4>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id25}@anchor{165c}
@subsubsection Windows



@itemize -

@item 
gh-117267@footnote{https://github.com/python/cpython/issues/117267}: Ensure @code{DirEntry.stat().st_ctime} behaves consistently with
@ref{548,,os.stat()} during the deprecation period of @code{st_ctime} by
containing the same value as @code{st_birthtime}. After the deprecation
period, @code{st_ctime} will be the metadata change time (or unavailable
through @code{DirEntry}), and only @code{st_birthtime} will contain the creation
time.

@item 
gh-116195@footnote{https://github.com/python/cpython/issues/116195}: Improves performance of @ref{165d,,os.getppid()} by using an
alternate system API when available. Contributed by vxiiduu.

@item 
gh-88494@footnote{https://github.com/python/cpython/issues/88494}: On Windows, @ref{3ac,,time.monotonic()} now uses the
@code{QueryPerformanceCounter()} clock to have a resolution better than 1 us,
instead of the @code{GetTickCount64()} clock which has a resolution of 15.6
ms. Patch by Victor Stinner.

@item 
gh-116773@footnote{https://github.com/python/cpython/issues/116773}: Fix instances of @code{<_overlapped.Overlapped object at 0xXXX>
still has pending operation at deallocation, the process may crash}.

@item 
gh-91227@footnote{https://github.com/python/cpython/issues/91227}: Fix the asyncio ProactorEventLoop implementation so that sending
a datagram to an address that is not listening does not prevent receiving
any more datagrams.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Switched from vendored @code{libmpdecimal} code to a
separately-hosted external package in the @code{cpython-source-deps}
repository when building the @code{_decimal} module.
@end itemize

@node C API<4>,,Windows<4>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id26}@anchor{165e}
@subsubsection C API



@itemize -

@item 
gh-117642@footnote{https://github.com/python/cpython/issues/117642}: Fix 
@geindex Python Enhancement Proposals; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} implementation for @code{%#T} and @code{%#N}.

@item 
gh-87193@footnote{https://github.com/python/cpython/issues/87193}: @ref{165f,,_PyBytes_Resize()} can now be called for bytes objects
with reference count > 1, including 1-byte bytes objects. It creates a new
bytes object and destroys the old one if it has reference count > 1.

@item 
gh-117021@footnote{https://github.com/python/cpython/issues/117021}: Fix integer overflow in @code{PyLong_AsPid()} on non-Windows
64-bit platforms.

@item 
gh-115756@footnote{https://github.com/python/cpython/issues/115756}: @code{PyCode_GetFirstFree()} is an ustable API now and has
been renamed to @ref{478,,PyUnstable_Code_GetFirstFree()}. (Contributed by
Bogdan Romanyuk in gh-115781@footnote{https://github.com/python/cpython/issues/115781})

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: Add @code{test_cext} test: build a C extension to check if the
Python C API emits C compiler warnings. Patch by Victor Stinner.

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: Make the C API compatible with
@code{-Werror=declaration-after-statement} compiler flag again. Patch by
Victor Stinner.

@item 
gh-116936@footnote{https://github.com/python/cpython/issues/116936}: Add @ref{486,,PyType_GetModuleByDef()} to the limited C API. Patch
by Victor Stinner.

@item 
gh-116809@footnote{https://github.com/python/cpython/issues/116809}: Restore removed private @code{_PyErr_ChainExceptions1()} function.
Patch by Victor Stinner.

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: In the limited C API version 3.13, getting @code{Py_None},
@code{Py_False}, @code{Py_True}, @code{Py_Ellipsis} and @code{Py_NotImplemented}
singletons is now implemented as function calls at the stable ABI level to
hide implementation details. Getting these constants still return borrowed
references. Patch by Victor Stinner.

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: Add @ref{44a,,Py_GetConstant()} and
@ref{44b,,Py_GetConstantBorrowed()} functions to get constants. For example,
@code{Py_GetConstant(Py_CONSTANT_ZERO)} returns a @ref{431,,strong reference} to
the constant zero. Patch by Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Add support for @code{%T}, @code{%T#}, @code{%N} and @code{%N#} formats to
@ref{47c,,PyUnicode_FromFormat()}: format the fully qualified name of an
object type and of a type: call @ref{469,,PyType_GetModuleName()}. See
@geindex Python Enhancement Proposals; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} for more information. Patch by Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Add @ref{469,,PyType_GetModuleName()} function to get the type’s
module name. Equivalent to getting the @code{type.__module__} attribute.
Patch by Eric Snow and Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Add @ref{467,,PyType_GetFullyQualifiedName()} function to get the
type’s fully qualified name. Equivalent to
@code{f"@{type.__module__@}.@{type.__qualname__@}"}, or @code{type.__qualname__} if
@code{type.__module__} is not a string or is equal to @code{"builtins"}. Patch
by Victor Stinner.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: The @code{fcntl}, @code{grp}, @code{pwd}, @code{termios}, @code{_statistics}
and @code{_testconsole} C extensions are now built with the @ref{488,,limited C API}. Patch by Victor Stinner.

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: Add additional flags to @ref{455,,PyLong_AsNativeBytes()} and
@ref{456,,PyLong_FromNativeBytes()} to allow the caller to determine how to
handle edge cases around values that fill the entire buffer.

@item 
gh-113024@footnote{https://github.com/python/cpython/issues/113024}: Add @ref{45b,,PyObject_GenericHash()} function.
@end itemize

@node Python 3 13 0 alpha 5,Python 3 13 0 alpha 4,Python 3 13 0 alpha 6,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-5}@anchor{1660}
@subsection Python 3.13.0 alpha 5


`Release date: 2024-03-12'

@menu
* Security: Security<4>. 
* Core and Builtins: Core and Builtins<5>. 
* Library: Library<5>. 
* Documentation: Documentation<5>. 
* Tests: Tests<4>. 
* Build: Build<5>. 
* Windows: Windows<5>. 
* macOS: macOS<3>. 
* IDLE: IDLE<5>. 
* Tools/Demos: Tools/Demos<3>. 
* C API: C API<5>. 

@end menu

@node Security<4>,Core and Builtins<5>,,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id27}@anchor{1661}
@subsubsection Security



@itemize -

@item 
gh-115398@footnote{https://github.com/python/cpython/issues/115398}: Allow controlling Expat >=2.6.0 reparse deferral
(
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}) by adding five new methods:


@itemize *

@item 
@ref{3c6,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{3c7,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{3c8,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{3c9,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()}

@item 
@code{xml.sax.expatreader.ExpatParser.flush()}
@end itemize

@item 
gh-114572@footnote{https://github.com/python/cpython/issues/114572}: @ref{102a,,ssl.SSLContext.cert_store_stats()} and
@ref{102b,,ssl.SSLContext.get_ca_certs()} now correctly lock access to the
certificate store, when the @ref{1fa,,ssl.SSLContext} is shared across
multiple threads.
@end itemize

@node Core and Builtins<5>,Library<5>,Security<4>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id28}@anchor{1662}
@subsubsection Core and Builtins



@itemize -

@item 
gh-116604@footnote{https://github.com/python/cpython/issues/116604}: Respect the status of the garbage collector when indirect calls
are made via @ref{512,,PyErr_CheckSignals()} and the evaluation breaker.
Patch by Pablo Galindo

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: @ref{18e,,list} is now compatible with the implementation of
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.

@item 
gh-116381@footnote{https://github.com/python/cpython/issues/116381}: Add specialization for @code{CONTAINS_OP}.

@item 
gh-116296@footnote{https://github.com/python/cpython/issues/116296}: Fix possible refleak in @code{object.__reduce__()} internal
error handling.

@item 
gh-115823@footnote{https://github.com/python/cpython/issues/115823}: Properly calculate error ranges in the parser when raising
@ref{150,,SyntaxError} exceptions caused by invalid byte sequences. Patch by
Pablo Galindo

@item 
gh-115778@footnote{https://github.com/python/cpython/issues/115778}: Add @code{tierN} annotation for instruction definition in
interpreter DSL.

@item 
gh-115733@footnote{https://github.com/python/cpython/issues/115733}: Fix crash when calling @code{next()} on exhausted list iterators.

@item 
gh-115700@footnote{https://github.com/python/cpython/issues/115700}: The regen-cases build stage now works on Windows.

@item 
gh-115347@footnote{https://github.com/python/cpython/issues/115347}: Fix bug where docstring was replaced by a redundant NOP when
Python is run with @code{-OO}.

@item 
gh-115323@footnote{https://github.com/python/cpython/issues/115323}: Make error message more meaningful for when
@code{bytearray.extend()} is called with a @ref{237,,str} object.

@item 
gh-112175@footnote{https://github.com/python/cpython/issues/112175}: Every @code{PyThreadState} now has its own @code{eval_breaker},
allowing specific threads to be interrupted.

@item 
gh-115154@footnote{https://github.com/python/cpython/issues/115154}: Fix a bug that was causing the @ref{160a,,tokenize.untokenize()}
function to handle unicode named literals incorrectly. Patch by Pablo
Galindo

@item 
gh-112433@footnote{https://github.com/python/cpython/issues/112433}: Add ability to force alignment of @ref{166,,ctypes.Structure} by
way of the new @code{_align_} attribute on the class.

@item 
gh-104090@footnote{https://github.com/python/cpython/issues/104090}: The multiprocessing resource tracker now exits with non-zero
status code if a resource leak was detected. It still exits with status
code 0 otherwise.

@item 
gh-105858@footnote{https://github.com/python/cpython/issues/105858}: Improve the constructors for @ref{9,,ast} nodes. Arguments of
list types now default to an empty list if omitted, and optional fields
default to @code{None}. AST nodes now have an @code{__annotations__} attribute
with the expected types of their attributes. Passing unrecognized extra
arguments to AST nodes is deprecated and will become an error in Python
3.15. Omitting a required argument to an AST node is deprecated and will
become an error in Python 3.15. Patch by Jelle Zijlstra.

@item 
gh-101860@footnote{https://github.com/python/cpython/issues/101860}: Expose @code{__name__} attribute on property.

@item 
gh-96497@footnote{https://github.com/python/cpython/issues/96497}: Fix incorrect resolution of mangled class variables used in
assignment expressions in comprehensions.
@end itemize

@node Library<5>,Documentation<5>,Core and Builtins<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id29}@anchor{1663}
@subsubsection Library



@itemize -

@item 
gh-116600@footnote{https://github.com/python/cpython/issues/116600}: Fix @ref{894,,repr()} for global @ref{6c4,,Flag} members.

@item 
gh-116349@footnote{https://github.com/python/cpython/issues/116349}: @ref{1d6,,platform.java_ver()} is deprecated and will be removed in
3.15. It was largely untested, had a confusing API, and was only useful
for Jython support.

@item 
gh-116143@footnote{https://github.com/python/cpython/issues/116143}: Fix a race in pydoc @code{_start_server}, eliminating a window in
which @code{_start_server} can return a thread that is «serving» but without
a @code{docserver} set.

@item 
gh-116127@footnote{https://github.com/python/cpython/issues/116127}: @ref{104,,typing}: implement 
@geindex Python Enhancement Proposals; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/} which adds
@ref{2cd,,typing.ReadOnly} support to @ref{2ce,,typing.TypedDict}.

@item 
gh-116325@footnote{https://github.com/python/cpython/issues/116325}: @ref{104,,typing}: raise @ref{150,,SyntaxError} instead of
@ref{441,,AttributeError} on forward references as empty strings.

@item 
gh-115957@footnote{https://github.com/python/cpython/issues/115957}: When @code{asyncio.TaskGroup.create_task} is called on an inactive
@code{asyncio.TaskGroup}, the given coroutine will be closed (which prevents
a @code{RuntimeWarning}).

@item 
gh-115978@footnote{https://github.com/python/cpython/issues/115978}: Disable preadv(), readv(), pwritev(), and writev() on WASI.

Under wasmtime for WASI 0.2, these functions don’t pass test_posix
(@indicateurl{https://github.com/bytecodealliance/wasmtime/issues/7830}).

@item 
gh-88352@footnote{https://github.com/python/cpython/issues/88352}: Fix the computation of the next rollover time in the
@code{logging.TimedRotatingFileHandler} handler.
@code{computeRollover()} now always returns a timestamp larger than the
specified time and works correctly during the DST change.
@code{doRollover()} no longer overwrite the already rolled over file,
saving from data loss when run at midnight or during repeated time at the
DST change.

@item 
gh-87115@footnote{https://github.com/python/cpython/issues/87115}: Set @code{__main__.__spec__} to @code{None} when running a script with
@ref{a5,,pdb}

@item 
gh-76511@footnote{https://github.com/python/cpython/issues/76511}: Fix UnicodeEncodeError in @code{email.Message.as_string()} that
results when a message that claims to be in the ascii character set
actually has non-ascii characters. Non-ascii characters are now replaced
with the U+FFFD replacement character, like in the @code{replace} error
handler.

@item 
gh-89547@footnote{https://github.com/python/cpython/issues/89547}: Add support for nested typing special forms like
Final[ClassVar[int]].

@item 
gh-65824@footnote{https://github.com/python/cpython/issues/65824}: Improve the @code{less} prompt in @ref{b5,,pydoc}.

@item 
gh-116040@footnote{https://github.com/python/cpython/issues/116040}: [Enum] fix by-value calls when second value is falsey; e.g.
Cardinal(1, 0)

@item 
gh-115821@footnote{https://github.com/python/cpython/issues/115821}: [Enum] Improve error message when calling super().__new__() in
custom __new__.

@item 
gh-85644@footnote{https://github.com/python/cpython/issues/85644}: Use the @code{XDG_CURRENT_DESKTOP} environment variable in
@ref{115,,webbrowser} to check desktop. Prefer it to the deprecated
@code{GNOME_DESKTOP_SESSION_ID} for GNOME detection.

@item 
gh-75988@footnote{https://github.com/python/cpython/issues/75988}: Fixed @ref{15c9,,unittest.mock.create_autospec()} to pass the call
through to the wrapped object to return the real result.

@item 
gh-115881@footnote{https://github.com/python/cpython/issues/115881}: Fix issue where @ref{30f,,ast.parse()} would incorrectly flag
conditional context managers (such as @code{with (x() if y else z()): ...})
as invalid syntax if @code{feature_version=(3, 8)} was passed. This reverts
changes to the grammar made as part of gh-94949@footnote{https://github.com/python/cpython/issues/94949}.

@item 
gh-115886@footnote{https://github.com/python/cpython/issues/115886}: Fix silent truncation of the name with an embedded null
character in @ref{1664,,multiprocessing.shared_memory.SharedMemory}.

@item 
gh-115532@footnote{https://github.com/python/cpython/issues/115532}: Add kernel density estimation to the statistics module.

@item 
gh-115714@footnote{https://github.com/python/cpython/issues/115714}: On WASI, the @ref{ee,,time} module no longer get process time
using @code{times()} or @code{CLOCK_PROCESS_CPUTIME_ID}, system API is that is
unreliable and is likely to be removed from WASI. The affected clock
functions fall back to calling @code{clock()}.

@item 
gh-115809@footnote{https://github.com/python/cpython/issues/115809}: Improve algorithm for computing which rolled-over log files to
delete in @code{logging.TimedRotatingFileHandler}. It is now reliable
for handlers without @code{namer} and with arbitrary deterministic @code{namer}
that leaves the datetime part in the file name unmodified.

@item 
gh-74668@footnote{https://github.com/python/cpython/issues/74668}: @ref{10a,,urllib.parse} functions @ref{1c9,,parse_qs()} and
@ref{1c8,,parse_qsl()} now support bytes arguments containing raw
and percent-encoded non-ASCII data.

@item 
gh-67044@footnote{https://github.com/python/cpython/issues/67044}: @ref{530,,csv.writer()} now always quotes or escapes @code{'\r'} and
@code{'\n'}, regardless of `lineterminator' value.

@item 
gh-115712@footnote{https://github.com/python/cpython/issues/115712}: Restore support of space delimiter with
@code{skipinitialspace=True} in @ref{2a,,csv}. @ref{530,,csv.writer()} now quotes
empty fields if delimiter is a space and skipinitialspace is true and
raises exception if quoting is not possible.

@item 
gh-112364@footnote{https://github.com/python/cpython/issues/112364}: Fixed @ref{97c,,ast.unparse()} to handle format_spec with @code{"},
@code{'} or @code{\\}. Patched by Frank Hoffmann.

@item 
gh-112997@footnote{https://github.com/python/cpython/issues/112997}: Stop logging potentially sensitive callback arguments in
@ref{b,,asyncio} unless debug mode is active.

@item 
gh-114914@footnote{https://github.com/python/cpython/issues/114914}: Fix an issue where an abandoned @code{StreamWriter} would not
be garbage collected.

@item 
gh-111358@footnote{https://github.com/python/cpython/issues/111358}: Fix a bug in
@code{asyncio.BaseEventLoop.shutdown_default_executor()} to ensure the
timeout passed to the coroutine behaves as expected.

@item 
gh-115618@footnote{https://github.com/python/cpython/issues/115618}: Fix improper decreasing the reference count for @code{None}
argument in @ref{2fd,,property} methods @ref{1665,,getter()},
@ref{1666,,setter()} and @ref{1667,,deleter()}.

@item 
gh-112720@footnote{https://github.com/python/cpython/issues/112720}: Refactor @code{dis.ArgResolver} to make it possible to
subclass and change the way jump args are interpreted.

@item 
gh-112006@footnote{https://github.com/python/cpython/issues/112006}: Fix @ref{fdc,,inspect.unwrap()} for types with the @code{__wrapper__}
data descriptor. Fix @ref{7d5,,inspect.Signature.from_callable()} for builtins
@ref{2d2,,classmethod()} and @ref{22e,,staticmethod()}.

@item 
gh-101293@footnote{https://github.com/python/cpython/issues/101293}: Support callables with the @code{__call__()} method and types with
@code{__new__()} and @code{__init__()} methods set to class methods, static
methods, bound methods, partial functions, and other types of methods and
descriptors in @ref{7d5,,inspect.Signature.from_callable()}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Isolate @code{_lsprof} (apply 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}).

@item 
gh-113942@footnote{https://github.com/python/cpython/issues/113942}: @ref{b5,,pydoc} no longer skips global functions implemented as
builtin methods, such as @code{MethodDescriptorType} and
@code{WrapperDescriptorType}.

@item 
gh-115256@footnote{https://github.com/python/cpython/issues/115256}: Added DeprecationWarning when accessing the tarfile attribute
of TarInfo objects. The attribute is never used internally and is only
attached to TarInfos when the tarfile is opened in write-mode, not
read-mode. The attribute creates an unnecessary reference cycle which may
cause corruption when not closing the handle after writing a tarfile.

@item 
gh-115197@footnote{https://github.com/python/cpython/issues/115197}: @code{urllib.request} no longer resolves the hostname before
checking it against the system’s proxy bypass list on macOS and Windows.

@item 
gh-113812@footnote{https://github.com/python/cpython/issues/113812}: @code{DatagramTransport.sendto()} will now send zero-length
datagrams if called with an empty bytes object. The transport flow control
also now accounts for the datagram header when calculating the buffer
size.

@item 
gh-114763@footnote{https://github.com/python/cpython/issues/114763}: Protect modules loaded with @ref{d36,,importlib.util.LazyLoader}
from race conditions when multiple threads try to access attributes before
the loading is complete.

@item 
gh-114709@footnote{https://github.com/python/cpython/issues/114709}: @code{posixpath.commonpath()} now raises a @ref{360,,ValueError}
exception when passed an empty iterable. Previously, @ref{1575,,IndexError} was
raised.

@code{posixpath.commonpath()} now raises a @ref{228,,TypeError} exception when
passed @code{None}. Previously, @ref{360,,ValueError} was raised.

@item 
gh-114610@footnote{https://github.com/python/cpython/issues/114610}: Fix bug where @ref{1668,,pathlib.PurePath.with_stem()} converted a
non-empty path suffix to a stem when given an empty `stem' argument. It
now raises @ref{360,,ValueError}, just like
@ref{15f2,,pathlib.PurePath.with_suffix()} does when called on a path with an
empty stem, given a non-empty `suffix' argument.

@item 
gh-107361@footnote{https://github.com/python/cpython/issues/107361}: Add @ref{2c2,,ssl.VERIFY_X509_PARTIAL_CHAIN} and
@code{VERIFY_X509_STRICT} to the default SSL context created with
@ref{2c1,,ssl.create_default_context()}.

@item 
gh-112281@footnote{https://github.com/python/cpython/issues/112281}: Allow creating @ref{85b,,union of types} for
@ref{9d0,,typing.Annotated} with unhashable metadata.

@item 
gh-111775@footnote{https://github.com/python/cpython/issues/111775}: Fix @code{importlib.resources.simple.ResourceHandle.open()} for
text mode, added missed @code{stream} argument.

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: Make .pdbrc and -c work with any valid pdb commands.

@item 
gh-107625@footnote{https://github.com/python/cpython/issues/107625}: Raise @ref{5a9,,configparser.ParsingError} from
@ref{14a5,,read()} and
@ref{5aa,,read_file()} methods of
@ref{32b,,configparser.ConfigParser} if a key without a corresponding value
is continued (that is, followed by an indented line).

@item 
gh-107155@footnote{https://github.com/python/cpython/issues/107155}: Fix incorrect output of @code{help(x)} where @code{x} is a
@ref{1309,,lambda} function, which has an @code{__annotations__} dictionary
attribute with a @code{"return"} key.

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: Add option for `non-shallow' comparisons to
@ref{fc0,,filecmp.dircmp} like @ref{1669,,filecmp.cmp()}. Original patch by Steven
Ward. Enhanced by Tobias Rautenkranz

@item 
gh-69990@footnote{https://github.com/python/cpython/issues/69990}: @code{Profile.print_stats()} has been improved to accept multiple
sort arguments. Patched by Chiu-Hsiang Hsu and Furkan Onder.

@item 
gh-104061@footnote{https://github.com/python/cpython/issues/104061}: Add @code{socket.SO_BINDTOIFINDEX} constant.

@item 
gh-60346@footnote{https://github.com/python/cpython/issues/60346}: Fix ArgumentParser inconsistent with parse_known_args.

@item 
gh-102389@footnote{https://github.com/python/cpython/issues/102389}: Add @code{windows_31j} to aliases for @code{cp932} codec

@item 
gh-72249@footnote{https://github.com/python/cpython/issues/72249}: @code{functools.partial`s of :func:`repr()} has been improved to
include the @ref{166a,,module} name. Patched by Furkan Onder and Anilyka
Barry.

@item 
gh-100985@footnote{https://github.com/python/cpython/issues/100985}: Update HTTPSConnection to consistently wrap IPv6 Addresses when
using a proxy.

@item 
gh-100884@footnote{https://github.com/python/cpython/issues/100884}: email: fix misfolding of comma in address-lists over multiple
lines in combination with unicode encoding.

@item 
gh-95782@footnote{https://github.com/python/cpython/issues/95782}: Fix @code{io.BufferedReader.tell()},
@code{io.BufferedReader.seek()}, @code{_pyio.BufferedReader.tell()},
@code{io.BufferedRandom.tell()}, @code{io.BufferedRandom.seek()} and
@code{_pyio.BufferedRandom.tell()} being able to return negative offsets.

@item 
gh-96310@footnote{https://github.com/python/cpython/issues/96310}: Fix a traceback in @ref{7,,argparse} when all options in a
mutually exclusive group are suppressed.

@item 
gh-93205@footnote{https://github.com/python/cpython/issues/93205}: Fixed a bug in
@ref{fe1,,logging.handlers.TimedRotatingFileHandler} where multiple rotating
handler instances pointing to files with the same name but different
extensions would conflict and not delete the correct files.

@item 
bpo-31116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31116}: Add Z85 encoding to @code{base64}.

@item 
bpo-44865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44865}: Add missing call to localization function in @ref{7,,argparse}.

@item 
bpo-43952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43952}: Fix @ref{166b,,multiprocessing.connection.Listener.accept()} to
accept empty bytes as authkey. Not accepting empty bytes as key causes it
to hang indefinitely.

@item 
bpo-42125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42125}: linecache: get module name from @code{__spec__} if available. This
allows getting source code for the @code{__main__} module when a custom
loader is used.

@item 
bpo-41122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41122}: Failing to pass arguments properly to
@ref{a82,,functools.singledispatchmethod()} now throws a TypeError instead of
hitting an index out of bounds internally.

@item 
bpo-40818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40818}: The asyncio REPL now runs @ref{1046,,sys.__interactivehook__} on
startup. The default implementation of @ref{1046,,sys.__interactivehook__}
provides auto-completion to the asyncio REPL. Patch contributed by Rémi
Lapeyre.

@item 
bpo-33775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33775}: Add “default” and “version” help text for localization in
argparse.
@end itemize

@node Documentation<5>,Tests<4>,Library<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id30}@anchor{166c}
@subsubsection Documentation



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: Document 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425} of Expat <2.6.0 under «XML
vulnerabilities».

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Improve import time of @ref{110,,uuid} on Linux.
@end itemize

@node Tests<4>,Build<5>,Documentation<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id31}@anchor{166d}
@subsubsection Tests



@itemize -

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Add test exclusions to support running the test suite on
Android.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Enable @code{test_concurrent_futures} on platforms that support
threading but not multiprocessing.

@item 
gh-115796@footnote{https://github.com/python/cpython/issues/115796}: Make “_testinternalcapi.assemble_code_object” construct the
exception table for the code object.

@item 
gh-115720@footnote{https://github.com/python/cpython/issues/115720}: Leak tests (@code{-R}, @code{--huntrleaks}) now show a summary of the
number of leaks found in each iteration.

@item 
gh-115122@footnote{https://github.com/python/cpython/issues/115122}: Add @code{--bisect} option to regrtest test runner: run failed
tests with @code{test.bisect_cmd} to identify failing tests. Patch by Victor
Stinner.

@item 
gh-115596@footnote{https://github.com/python/cpython/issues/115596}: Fix @code{ProgramPriorityTests} in @code{test_os} permanently
changing the process priority.

@item 
gh-115556@footnote{https://github.com/python/cpython/issues/115556}: On Windows, commas passed in arguments to
@code{Tools\buildbot\test.bat} and @code{PCbuild\\rt.bat} are now properly
handled.

@item 
gh-115420@footnote{https://github.com/python/cpython/issues/115420}: Fix translation of exception handler targets by
@code{_testinternalcapi.optimize_cfg}.

@item 
gh-115376@footnote{https://github.com/python/cpython/issues/115376}: Fix segfault in @code{_testinternalcapi.compiler_codegen} on bad
input.
@end itemize

@node Build<5>,Windows<5>,Tests<4>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id32}@anchor{166e}
@subsubsection Build



@itemize -

@item 
gh-116313@footnote{https://github.com/python/cpython/issues/116313}: Get WASI builds to work under wasmtime 18 w/ WASI 0.2/preview2
primitives.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Change Android’s @ref{b19,,sys.platform} from @code{"linux"} to
@code{"android"}.

@item 
gh-116117@footnote{https://github.com/python/cpython/issues/116117}: Backport @code{libb2}’s PR #42 to fix compiling CPython on 32-bit
Windows with @code{clang-cl}.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Fix several Android build issues

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: A testbed project was added to run the test suite on iOS.

@item 
gh-115350@footnote{https://github.com/python/cpython/issues/115350}: Fix building ctypes module with -DWIN32_LEAN_AND_MEAN defined

@item 
gh-111225@footnote{https://github.com/python/cpython/issues/111225}: Link extension modules against libpython on Android.

@item 
gh-115737@footnote{https://github.com/python/cpython/issues/115737}: The install name for libPython is now correctly set for
non-framework macOS builds.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Makefile targets were added to support compiling an
iOS-compatible framework build.
@end itemize

@node Windows<5>,macOS<3>,Build<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id33}@anchor{166f}
@subsubsection Windows



@itemize -

@item 
gh-116012@footnote{https://github.com/python/cpython/issues/116012}: Ensure the value of @code{GetLastError()} is preserved across GIL
operations.

@item 
gh-115582@footnote{https://github.com/python/cpython/issues/115582}: Building extensions intended for free-threaded builds of
CPython now require compiling with @code{/DPy_GIL_DISABLED} manually when
using a regular install. This is expected to change in future releases.

@item 
gh-115554@footnote{https://github.com/python/cpython/issues/115554}: The installer now has more strict rules about updating the
@ref{65f,,Lanzador de Python para Windows}. In general, most users only have a single launcher
installed and will see no difference. When multiple launchers have been
installed, the option to install the launcher is disabled until all but
one have been removed. Downgrading the launcher (which was never allowed)
is now more obviously blocked.

@item 
gh-115543@footnote{https://github.com/python/cpython/issues/115543}: @ref{65f,,Lanzador de Python para Windows} can now detect Python 3.13 when installed from
the Microsoft Store, and will install Python 3.12 by default when
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex variables de entorno; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} is set.
@end itemize

@node macOS<3>,IDLE<5>,Windows<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id34}@anchor{1670}
@subsubsection macOS



@itemize -

@item 
gh-116145@footnote{https://github.com/python/cpython/issues/116145}: Update macOS installer to Tcl/Tk 8.6.14.
@end itemize

@node IDLE<5>,Tools/Demos<3>,macOS<3>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id35}@anchor{1671}
@subsubsection IDLE



@itemize -

@item 
gh-88516@footnote{https://github.com/python/cpython/issues/88516}: On macOS show a proxy icon in the title bar of editor windows to
match platform behaviour.
@end itemize

@node Tools/Demos<3>,C API<5>,IDLE<5>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id36}@anchor{1672}
@subsubsection Tools/Demos



@itemize -

@item 
gh-100176@footnote{https://github.com/python/cpython/issues/100176}: Remove outdated Tools/@{io,cc,string@}bench

@item 
bpo-45101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45101}: Add consistency in usage message IO between 2 versions of
python-config.
@end itemize

@node C API<5>,,Tools/Demos<3>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id37}@anchor{1673}
@subsubsection C API



@itemize -

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: Add again @code{_PyCFunctionFastWithKeywords} name, removed in
Python 3.13 alpha 4 by mistake.  Keep the old private
@code{_PyCFunctionFastWithKeywords} name (Python 3.7) as an alias to the new
public name @code{PyCFunctionFastWithKeywords} (Python 3.13a4). Patch by
Victor Stinner.

@item 
gh-111418@footnote{https://github.com/python/cpython/issues/111418}: Add @ref{1674,,PyHASH_MODULUS}, @ref{1675,,PyHASH_BITS},
@ref{1676,,PyHASH_INF} and @ref{1677,,PyHASH_IMAG} C macros.  Patch by
Sergey B Kirpichev.
@end itemize

@node Python 3 13 0 alpha 4,Python 3 13 0 alpha 3,Python 3 13 0 alpha 5,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-4}@anchor{1678}
@subsection Python 3.13.0 alpha 4


`Release date: 2024-02-15'

@menu
* Security: Security<5>. 
* Core and Builtins: Core and Builtins<6>. 
* Library: Library<6>. 
* Documentation: Documentation<6>. 
* Tests: Tests<5>. 
* Build: Build<6>. 
* Windows: Windows<6>. 
* macOS: macOS<4>. 
* IDLE: IDLE<6>. 
* Tools/Demos: Tools/Demos<4>. 
* C API: C API<6>. 

@end menu

@node Security<5>,Core and Builtins<6>,,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id38}@anchor{1679}
@subsubsection Security



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: Update bundled libexpat to 2.6.0

@item 
gh-115243@footnote{https://github.com/python/cpython/issues/115243}: Fix possible crashes in @ref{e57,,collections.deque.index()} when
the deque is concurrently modified.
@end itemize

@node Core and Builtins<6>,Library<6>,Security<5>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id39}@anchor{167a}
@subsubsection Core and Builtins



@itemize -

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: For an empty reverse iterator for list will be reduced to
@ref{8fc,,reversed()}. Patch by Donghee Na

@item 
gh-114570@footnote{https://github.com/python/cpython/issues/114570}: Add @ref{2ba,,PythonFinalizationError} exception. This exception
derived from @ref{1e5,,RuntimeError} is raised when an operation is blocked
during the @ref{2bb,,Python finalization}. Patch by
Victor Stinner.

@item 
gh-114695@footnote{https://github.com/python/cpython/issues/114695}: Add @ref{167b,,sys._clear_internal_caches()}, which clears all
internal performance-related caches (and deprecate the less-general
@ref{167c,,sys._clear_type_cache()} function).

@item 
gh-114828@footnote{https://github.com/python/cpython/issues/114828}: Fix compilation crashes in uncommon code examples using
@ref{155,,super()} inside a comprehension in a class body.

@item 
gh-112069@footnote{https://github.com/python/cpython/issues/112069}: Adapt @ref{67a,,set} and @ref{67b,,frozenset} methods to Argument
Clinic.

@item 
gh-115011@footnote{https://github.com/python/cpython/issues/115011}: Setters for members with an unsigned integer type now support
the same range of valid values for objects that has a
@ref{22b,,__index__()} method as for @ref{1f0,,int}.

@item 
gh-114887@footnote{https://github.com/python/cpython/issues/114887}: Changed socket type validation in
@ref{7cf,,create_datagram_endpoint()} to accept all non-stream
sockets. This fixes a regression in compatibility with raw sockets.

@item 
gh-114944@footnote{https://github.com/python/cpython/issues/114944}: Fixes a race between @code{PyParkingLot_Park} and
@code{_PyParkingLot_UnparkAll}.

@item 
gh-113462@footnote{https://github.com/python/cpython/issues/113462}: Limit the number of versions that a single class can use.
Prevents a few wayward classes using up all the version numbers.

@item 
gh-76763@footnote{https://github.com/python/cpython/issues/76763}: The @ref{167d,,chr()} builtin function now always raises
@ref{360,,ValueError} for values outside the valid range. Previously it raised
@ref{919,,OverflowError} for very large or small values.

@item 
gh-114806@footnote{https://github.com/python/cpython/issues/114806}: No longer specialize calls to classes, if those classes have
metaclasses. Fixes bug where the @code{__call__} method of the metaclass was
not being called.

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: Improve error message for function calls with bad keyword
arguments via getargs

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: The free-threaded build no longer allocates space for the
@code{PyGC_Head} structure in objects that support cyclic garbage collection.
A number of other fields and data structures are used as replacements,
including @code{ob_gc_bits}, @code{ob_tid}, and mimalloc internal data
structures.

@item 
gh-114456@footnote{https://github.com/python/cpython/issues/114456}: Lower the recursion limit under a debug build of WASI.

@item 
gh-114083@footnote{https://github.com/python/cpython/issues/114083}: Compiler applies folding of LOAD_CONST with following
instruction in a separate pass before other optimisations. This enables
jump threading in certain circumstances.

@item 
gh-114388@footnote{https://github.com/python/cpython/issues/114388}: Fix a @ref{323,,RuntimeWarning} emitted when assign an integer-like
value that is not an instance of @ref{1f0,,int} to an attribute that
corresponds to a C struct member of @ref{167e,,type} T_UINT
and T_ULONG. Fix a double @ref{323,,RuntimeWarning} emitted when assign a
negative integer value to an attribute that corresponds to a C struct
member of type T_UINT.

@item 
gh-114265@footnote{https://github.com/python/cpython/issues/114265}: Compiler propagates line numbers before optimization, leading
to more optimization opportunities and removing the need for the
@code{guarantee_lineno_for_exits} hack.

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: The free-threaded build now has its own thread-safe GC
implementation that uses mimalloc to find GC tracked objects. It is
non-generational, unlike the existing GC implementation.

@item 
gh-114050@footnote{https://github.com/python/cpython/issues/114050}: Fix segmentation fault caused by an incorrect format string in
@code{TypeError} exception when more than two arguments are passed to
@code{int}.

@item 
gh-112354@footnote{https://github.com/python/cpython/issues/112354}: The @code{END_FOR} instruction now pops only one value. This is to
better support side exits in loops.

@item 
gh-113884@footnote{https://github.com/python/cpython/issues/113884}: Make @ref{bf2,,queue.SimpleQueue} thread safe when the GIL is
disabled.

@item 
gh-114058@footnote{https://github.com/python/cpython/issues/114058}: Implement the foundations of the Tier 2 redundancy eliminator.

@item 
gh-113939@footnote{https://github.com/python/cpython/issues/113939}: frame.clear(): Clear frame.f_locals as well, and not only the
fast locals. This is relevant once frame.f_locals was accessed, which
would contain also references to all the locals.

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: Convert @ref{67d,,collections.deque} to use Argument Clinic.

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: Make methods on @ref{67d,,collections.deque} thread-safe when the
GIL is disabled.

@item 
gh-113464@footnote{https://github.com/python/cpython/issues/113464}: Add an option (@code{--enable-experimental-jit} for
@code{configure}-based builds or @code{--experimental-jit} for @code{PCbuild}-based
ones) to build an `experimental' just-in-time compiler, based on
copy-and-patch@footnote{https://fredrikbk.com/publications/copy-and-patch.pdf}

@item 
gh-113055@footnote{https://github.com/python/cpython/issues/113055}: Make interp->obmalloc a pointer. For interpreters that share
state with the main interpreter, this points to the same static memory
structure. For interpreters with their own obmalloc state, it is heap
allocated. Add free_obmalloc_arenas() which will free the obmalloc arenas
and radix tree structures for interpreters with their own obmalloc state.

@item 
gh-55664@footnote{https://github.com/python/cpython/issues/55664}: Add warning when creating @ref{dcf,,type} using a namespace
dictionary with non-string keys. Patched by Daniel Urban and Furkan Onder.

@item 
gh-104530@footnote{https://github.com/python/cpython/issues/104530}: Use native Win32 condition variables.
@end itemize

@node Library<6>,Documentation<6>,Core and Builtins<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id40}@anchor{167f}
@subsubsection Library



@itemize -

@item 
gh-115392@footnote{https://github.com/python/cpython/issues/115392}: Fix a bug in @ref{3b,,doctest} where incorrect line numbers would
be reported for decorated functions.

@item 
gh-114563@footnote{https://github.com/python/cpython/issues/114563}: Fix several @ref{6c0,,format()} bugs when using the C implementation
of @ref{16a,,Decimal}: * memory leak in some rare cases when using
the @code{z} format option (coerce negative 0) * incorrect output when
applying the @code{z} format option to type @code{F} (fixed-point with capital
@code{NAN} / @code{INF}) * incorrect output when applying the @code{#} format
option (alternate form)

@item 
gh-102840@footnote{https://github.com/python/cpython/issues/102840}: Fix confused traceback when floordiv, mod, or divmod operations
happens between instances of @ref{177,,fractions.Fraction} and
@ref{154,,complex}.

@item 
gh-115165@footnote{https://github.com/python/cpython/issues/115165}: Most exceptions are now ignored when attempting to set the
@code{__orig_class__} attribute on objects returned when calling
@ref{104,,typing} generic aliases (including generic aliases created using
@ref{9d0,,typing.Annotated}). Previously only @ref{441,,AttributeError} was
ignored. Patch by Dave Shawley.

@item 
gh-112903@footnote{https://github.com/python/cpython/issues/112903}: Fix «issubclass() arg 1 must be a class» errors in certain
cases of multiple inheritance with generic aliases (regression in early
3.13 alpha releases).

@item 
gh-115133@footnote{https://github.com/python/cpython/issues/115133}: Fix tests for @ref{1070,,XMLPullParser}
with Expat 2.6.0.

@item 
gh-115059@footnote{https://github.com/python/cpython/issues/115059}: @code{io.BufferedRandom.read1()} now flushes the underlying
write buffer.

@item 
gh-79382@footnote{https://github.com/python/cpython/issues/79382}: Trailing @code{**} no longer allows to match files and non-existing
paths in recursive @ref{3ef,,glob()}.

@item 
gh-67837@footnote{https://github.com/python/cpython/issues/67837}: Avoid race conditions in the creation of directories during
concurrent extraction in @ref{de,,tarfile} and @ref{130,,zipfile}.

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: Speed up @ref{388,,pathlib.Path.glob()} by removing redundant regex
matching.

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: Partially revert the behavior of @code{tkinter.Text.count()}. By
default it preserves the behavior of older Python versions, except that
setting @code{wantobjects} to 0 no longer has effect. Add a new parameter
`return_ints': specifying @code{return_ints=True} makes @code{Text.count()}
always returning the single count as an integer instead of a 1-tuple or
@code{None}.

@item 
gh-114628@footnote{https://github.com/python/cpython/issues/114628}: When csv.Error is raised when handling TypeError, do not print
the TypeError traceback.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Added @code{_POSIX_VDISABLE} from C’s @code{<unistd.h>} to
@ref{e1,,termios}.

@item 
gh-114965@footnote{https://github.com/python/cpython/issues/114965}: Update bundled pip to 24.0

@item 
gh-114959@footnote{https://github.com/python/cpython/issues/114959}: @ref{de,,tarfile} no longer ignores errors when trying to extract
a directory on top of a file.

@item 
gh-114894@footnote{https://github.com/python/cpython/issues/114894}: Add @ref{30a,,array.array.clear()}.

@item 
gh-114071@footnote{https://github.com/python/cpython/issues/114071}: Support tuple subclasses using auto() for enum member value.

@item 
gh-109475@footnote{https://github.com/python/cpython/issues/109475}: Fix support of explicit option value «–» in @ref{7,,argparse}
(e.g. @code{--option=--}).

@item 
gh-49766@footnote{https://github.com/python/cpython/issues/49766}: Fix @ref{330,,date}-@ref{32f,,datetime}
comparison. Now the special comparison methods like @code{__eq__} and
@code{__lt__} return @ref{227,,NotImplemented} if one of comparands is
@code{date} and other is @code{datetime} instead of ignoring the
time part and the time zone or forcefully return «not equal» or raise
@ref{228,,TypeError}. It makes comparison of @code{date} and
@code{datetime} subclasses more symmetric and allows to change the
default behavior by overriding the special comparison methods in
subclasses.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Fix ctypes structs with array on Windows ARM64 platform by
setting @code{MAX_STRUCT_SIZE} to 32 in stgdict. Patch by Diego Russo

@item 
gh-114678@footnote{https://github.com/python/cpython/issues/114678}: Ensure that deprecation warning for “N” specifier in
@ref{16a,,Decimal} format is not raised for cases where “N” appears
in other places in the format specifier. Based on patch by Stefan Krah.

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: Return both files and directories from @ref{388,,pathlib.Path.glob()}
if a pattern ends with «@code{**}». Previously only directories were
returned.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Improve import time of @ref{7a,,importlib.metadata} and
@ref{51,,email.utils}.

@item 
gh-113280@footnote{https://github.com/python/cpython/issues/113280}: Fix a leak of open socket in rare cases when error occurred in
@ref{981,,ssl.SSLSocket} creation.

@item 
gh-77749@footnote{https://github.com/python/cpython/issues/77749}: @ref{1680,,email.policy.EmailPolicy.fold()} now always encodes
non-ASCII characters in headers if @ref{e7d,,utf8}
is false.

@item 
gh-83383@footnote{https://github.com/python/cpython/issues/83383}: Synchronization of the @ref{33,,dbm.dumb} database is now no-op if
there was no modification since opening or last synchronization. The
directory file for a newly created empty @ref{33,,dbm.dumb} database is now
created immediately after opening instead of deferring this until
synchronizing or closing.

@item 
gh-91602@footnote{https://github.com/python/cpython/issues/91602}: Add `filter' keyword-only parameter to
@ref{3a0,,sqlite3.Connection.iterdump()} for filtering database objects to
dump. Patch by Mariusz Felisiak.

@item 
gh-112451@footnote{https://github.com/python/cpython/issues/112451}: Prohibit subclassing pure-Python @ref{1134,,datetime.timezone}.
This is consistent with C-extension implementation. Patch by Mariusz
Felisiak.

@item 
gh-69893@footnote{https://github.com/python/cpython/issues/69893}: Add the @code{close()} method for the iterator returned by
@ref{3ca,,xml.etree.ElementTree.iterparse()}.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduce the import time of @ref{ed,,threading} module by ~50%.
Patch by Daniel Hollas.

@item 
gh-114492@footnote{https://github.com/python/cpython/issues/114492}: Make the result of @ref{1681,,termios.tcgetattr()} reproducible on
Alpine Linux. Previously it could leave a random garbage in some fields.

@item 
gh-114315@footnote{https://github.com/python/cpython/issues/114315}: Make @ref{1682,,threading.Lock} a real class, not a factory
function. Add @code{__new__} to @code{_thread.lock} type.

@item 
gh-100414@footnote{https://github.com/python/cpython/issues/100414}: Add @ref{36,,dbm.sqlite3} as a backend to @ref{32,,dbm}, and make it
the new default @code{dbm} backend. Patch by Raymond Hettinger and Erlend
E. Aasland.

@item 
gh-113267@footnote{https://github.com/python/cpython/issues/113267}: Revert changes in gh-106584@footnote{https://github.com/python/cpython/issues/106584} which made calls of
@code{TestResult} methods @code{startTest()} and @code{stopTest()} unbalanced.

@item 
gh-75128@footnote{https://github.com/python/cpython/issues/75128}: Ignore an @ref{4d5,,OSError} in
@code{asyncio.BaseEventLoop.create_server()} when IPv6 is available but the
interface cannot actually support it.

@item 
gh-114423@footnote{https://github.com/python/cpython/issues/114423}: @code{_DummyThread} entries in @code{threading._active} are now
automatically removed when the related thread dies.

@item 
gh-114257@footnote{https://github.com/python/cpython/issues/114257}: Dismiss the @code{FileNotFound} error in
@ref{dd0,,ctypes.util.find_library()} and just return @code{None} on Linux.

@item 
gh-114321@footnote{https://github.com/python/cpython/issues/114321}: Expose more platform specific constants in the @ref{59,,fcntl}
module on Linux, macOS, FreeBSD and NetBSD.

@item 
gh-114328@footnote{https://github.com/python/cpython/issues/114328}: The @ref{1683,,tty.setcbreak()} and new @ref{1684,,tty.cfmakecbreak()} no
longer clears the terminal input ICRLF flag. This fixes a regression
introduced in 3.12 that no longer matched how OSes define cbreak mode in
their @code{stty(1)} manual pages.

@item 
gh-114281@footnote{https://github.com/python/cpython/issues/114281}: Remove type hints from @code{Lib/asyncio/staggered.py}. The
annotations in the typeshed@footnote{https://github.com/python/typeshed}
project should be used instead.

@item 
gh-101438@footnote{https://github.com/python/cpython/issues/101438}: Avoid reference cycle in ElementTree.iterparse. The iterator
returned by @code{ElementTree.iterparse} may hold on to a file descriptor.
The reference cycle prevented prompt clean-up of the file descriptor if
the returned iterator was not exhausted.

@item 
gh-114198@footnote{https://github.com/python/cpython/issues/114198}: The signature for the @code{__replace__} method on
@ref{30,,dataclasses} now has the first argument named @code{self}, rather than
@code{obj}.

@item 
gh-104522@footnote{https://github.com/python/cpython/issues/104522}: @ref{4d5,,OSError} raised when run a subprocess now only has
`filename' attribute set to `cwd' if the error was caused by a failed
attempt to change the current directory.

@item 
gh-114149@footnote{https://github.com/python/cpython/issues/114149}: Enum: correctly handle tuple subclasses in custom @code{__new__}.

@item 
gh-83648@footnote{https://github.com/python/cpython/issues/83648}: Support deprecation of options, positional arguments and
subcommands in @ref{7,,argparse}.

@item 
gh-114087@footnote{https://github.com/python/cpython/issues/114087}: Speed up @code{dataclasses.asdict} up to 1.35x.

@item 
gh-109534@footnote{https://github.com/python/cpython/issues/109534}: Fix a reference leak in
@code{asyncio.selector_events.BaseSelectorEventLoop} when SSL handshakes
fail. Patch contributed by Jamie Phan.

@item 
gh-79634@footnote{https://github.com/python/cpython/issues/79634}: Accept @ref{3f0,,path-like objects} as patterns
in @ref{388,,pathlib.Path.glob()} and @ref{389,,rglob()}.

@item 
gh-112202@footnote{https://github.com/python/cpython/issues/112202}: Ensure that a @ref{1685,,asyncio.Condition.notify()} call does not
get lost if the awakened @code{Task} is simultaneously cancelled or
encounters any other error.

@item 
gh-113951@footnote{https://github.com/python/cpython/issues/113951}: Fix the behavior of @code{tag_unbind()} methods of
@code{tkinter.Text} and @code{tkinter.Canvas} classes with three
arguments. Previously, @code{widget.tag_unbind(tag, sequence, funcid)}
destroyed the current binding for `sequence', leaving `sequence' unbound,
and deleted the `funcid' command. Now it removes only `funcid' from the
binding for `sequence', keeping other commands, and deletes the `funcid'
command. It leaves `sequence' unbound only if `funcid' was the last bound
command.

@item 
gh-97959@footnote{https://github.com/python/cpython/issues/97959}: Fix rendering class methods, bound methods, method and function
aliases in @ref{b5,,pydoc}. Class methods no longer have «method of
builtins.type instance» note. Corresponding notes are now added for class
and unbound methods. Method and function aliases now have references to
the module or the class where the origin was defined if it differs from
the current. Bound methods are now listed in the static methods section.
Methods of builtin classes are now supported as well as methods of Python
classes.

@item 
gh-113796@footnote{https://github.com/python/cpython/issues/113796}: Add more validation checks in the @ref{1686,,csv.Dialect}
constructor. @ref{360,,ValueError} is now raised if the same character is used
in different roles.

@item 
gh-113732@footnote{https://github.com/python/cpython/issues/113732}: Fix support of @ref{52d,,QUOTE_NOTNULL} and
@ref{52e,,QUOTE_STRINGS} in @ref{52f,,csv.reader()}.

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: Speed up @ref{550,,pathlib.Path.walk()} by using
@ref{1687,,os.DirEntry.path} where possible.

@item 
gh-89039@footnote{https://github.com/python/cpython/issues/89039}: When replace() method is called on a subclass of datetime, date
or time, properly call derived constructor. Previously, only the base
class’s constructor was called.

Also, make sure to pass non-zero fold values when creating subclasses in
various methods. Previously, fold was silently ignored.

@item 
gh-112919@footnote{https://github.com/python/cpython/issues/112919}: Speed-up @ref{150b,,datetime.datetime.replace()},
@ref{1688,,datetime.date.replace()} and @ref{1689,,datetime.time.replace()}.

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: Set breakpoint on the first executable line of the function,
instead of the line of function definition when the user do @code{break func}
using @ref{a5,,pdb}

@item 
gh-112343@footnote{https://github.com/python/cpython/issues/112343}: Improve handling of pdb convenience variables to avoid
replacing string contents.

@item 
gh-112240@footnote{https://github.com/python/cpython/issues/112240}: Add option to calendar module CLI to specify the weekday to
start each week. Patch by Steven Ward.

@item 
gh-111741@footnote{https://github.com/python/cpython/issues/111741}: Recognise @code{image/webp} as a standard format in the
@ref{8f,,mimetypes} module.

@item 
gh-43457@footnote{https://github.com/python/cpython/issues/43457}: Fix the @ref{f0,,tkinter} widget method @code{wm_attributes()}. It
now accepts the attribute name without the minus prefix to get window
attributes and allows to specify attributes and values to set as keyword
arguments. Add new optional keyword argument `return_python_dict': calling
@code{w.wm_attributes(return_python_dict=True)} returns the attributes as a
dict instead of a tuple. Calling @code{w.wm_attributes()} now returns a tuple
instead of string if `wantobjects' was set to 0.

@item 
gh-82626@footnote{https://github.com/python/cpython/issues/82626}: Many functions now emit a warning if a boolean value is passed
as a file descriptor argument.

@item 
gh-111051@footnote{https://github.com/python/cpython/issues/111051}: Added check for file modification during debugging with
@ref{a5,,pdb}

@item 
gh-110345@footnote{https://github.com/python/cpython/issues/110345}: Show the Tcl/Tk patchlevel (rather than version) in
@code{tkinter._test()}.

@item 
gh-38807@footnote{https://github.com/python/cpython/issues/38807}: Fix race condition in @ref{fd,,trace}. Instead of checking if a
directory exists and creating it, directly call @ref{37b,,os.makedirs()} with
the kwarg @code{exist_ok=True}.

@item 
gh-75705@footnote{https://github.com/python/cpython/issues/75705}: Set unixfrom envelope in @ref{168a,,mailbox.mbox} and
@ref{168b,,mailbox.MMDF}.

@item 
gh-106233@footnote{https://github.com/python/cpython/issues/106233}: Fix stacklevel in @code{InvalidTZPathWarning} during
@ref{133,,zoneinfo} module import.

@item 
gh-105102@footnote{https://github.com/python/cpython/issues/105102}: Allow @ref{167,,ctypes.Union} to be nested in
@ref{166,,ctypes.Structure} when the system endianness is the opposite of
the classes.

@item 
gh-104282@footnote{https://github.com/python/cpython/issues/104282}: Fix null pointer dereference in
@code{lzma._decode_filter_properties()} due to improper handling of BCJ
filters with properties of zero length. Patch by Radislav Chugunov.

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: Add @ref{13ee,,queue.Queue} termination with
@ref{393,,shutdown()}.

@item 
gh-101599@footnote{https://github.com/python/cpython/issues/101599}: Changed argparse flag options formatting to remove redundancy.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Add POSIX pseudo-terminal functions @ref{168c,,os.posix_openpt()},
@ref{168d,,os.grantpt()}, @ref{168e,,os.unlockpt()}, and @ref{168f,,os.ptsname()}.

@item 
gh-102512@footnote{https://github.com/python/cpython/issues/102512}: When @ref{2ff,,os.fork()} is called from a foreign thread (aka
@code{_DummyThread}), the type of the thread in a child process is changed to
@code{_MainThread}. Also changed its name and daemonic status, it can be now
joined.

@item 
gh-88569@footnote{https://github.com/python/cpython/issues/88569}: Add @ref{1d5,,os.path.isreserved()}, which identifies reserved
pathnames such as «NUL», «AUX» and «CON». This function is only available
on Windows.

Deprecate @ref{1d4,,pathlib.PurePath.is_reserved()}.

@item 
bpo-38364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38364}: The @code{inspect} functions @code{isgeneratorfunction},
@code{iscoroutinefunction}, @code{isasyncgenfunction} now support
@code{functools.partialmethod} wrapped functions the same way they support
@code{functools.partial}.
@end itemize

@node Documentation<6>,Tests<5>,Library<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id41}@anchor{1690}
@subsubsection Documentation



@itemize -

@item 
gh-115233@footnote{https://github.com/python/cpython/issues/115233}: Fix an example for @ref{135c,,LoggerAdapter} in the
Logging Cookbook.

@item 
gh-114123@footnote{https://github.com/python/cpython/issues/114123}: Move the @ref{2a,,csv} module docstring to the @code{csv} module
instead of reexporting it from the internal @code{_csv} module, and
remove @code{__doc__} from @code{csv.__all__}.

Move @code{csv.__version__} to the @code{csv} module instead of
reexporting it from the internal @code{_csv} module, and remove
@code{__version__} from @code{csv.__all__}.
@end itemize

@node Tests<5>,Build<6>,Documentation<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id42}@anchor{1691}
@subsubsection Tests



@itemize -

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Added test exclusions required to run the test suite on iOS.

@item 
gh-105089@footnote{https://github.com/python/cpython/issues/105089}: Fix
@code{test.test_zipfile.test_core.TestWithDirectory.test_create_directory_with_write}
test in AIX by doing a bitwise AND of 0xFFFF on mode , so that it will be
in sync with @code{zinfo.external_attr}
@end itemize

@node Build<6>,Windows<6>,Tests<5>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id43}@anchor{1692}
@subsubsection Build



@itemize -

@item 
gh-115167@footnote{https://github.com/python/cpython/issues/115167}: Avoid vendoring @code{vcruntime140_threads.dll} when building with
Visual Studio 2022 version 17.8.

@item 
gh-113632@footnote{https://github.com/python/cpython/issues/113632}: Promote WASI to a tier 2 platform and drop Emscripten from tier
3 in configure.ac.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: configure and Makefile were refactored to accommodate framework
builds on Apple platforms other than macOS.

@item 
gh-114875@footnote{https://github.com/python/cpython/issues/114875}: Add @code{getgrent()} as a prerequisite for building the
@ref{66,,grp} module.
@end itemize

@node Windows<6>,macOS<4>,Build<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id44}@anchor{1693}
@subsubsection Windows



@itemize -

@item 
gh-115049@footnote{https://github.com/python/cpython/issues/115049}: Fixes @code{py.exe} launcher failing when run as users without
user profiles.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Update Windows installer to use SQLite 3.45.1.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update Windows build to use OpenSSL 3.0.13.

@item 
gh-111239@footnote{https://github.com/python/cpython/issues/111239}: Update Windows builds to use zlib v1.3.1.

@item 
gh-100107@footnote{https://github.com/python/cpython/issues/100107}: The @code{py.exe} launcher will no longer attempt to run the
Microsoft Store redirector when launching a script containing a
@code{/usr/bin/env} shebang

@item 
gh-112984@footnote{https://github.com/python/cpython/issues/112984}: Adds free-threaded binaries to Windows installer as an optional
component.

@item 
gh-89240@footnote{https://github.com/python/cpython/issues/89240}: Allows @ref{94,,multiprocessing} to create pools of greater than 62
processes.
@end itemize

@node macOS<4>,IDLE<6>,Windows<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id45}@anchor{1694}
@subsubsection macOS



@itemize -

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Update macOS installer to use SQLite 3.45.1.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update macOS installer to use OpenSSL 3.0.13.

@item 
gh-114490@footnote{https://github.com/python/cpython/issues/114490}: Add Mach-O linkage support for @ref{1695,,platform.architecture()}.

@item 
gh-87804@footnote{https://github.com/python/cpython/issues/87804}: On macOS the result of @code{os.statvfs} and @code{os.fstatvfs} now
correctly report the size of very large disks, in previous versions the
reported number of blocks was wrong for disks with at least 2**32 blocks.
@end itemize

@node IDLE<6>,Tools/Demos<4>,macOS<4>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id46}@anchor{1696}
@subsubsection IDLE



@itemize -

@item 
gh-96905@footnote{https://github.com/python/cpython/issues/96905}: In idlelib code, stop redefining built-ins “dict” and “object”.

@item 
gh-103820@footnote{https://github.com/python/cpython/issues/103820}: Revise IDLE bindings so that events from mouse button 4/5 on
non-X11 windowing systems (i.e. Win32 and Aqua) are not mistaken for
scrolling.
@end itemize

@node Tools/Demos<4>,C API<6>,IDLE<6>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id47}@anchor{1697}
@subsubsection Tools/Demos



@itemize -

@item 
gh-113516@footnote{https://github.com/python/cpython/issues/113516}: Don’t set @code{LDSHARED} when building for WASI.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update GitHub CI workflows to use OpenSSL 3.0.13 and
multissltests to use 1.1.1w, 3.0.13, 3.1.5, and 3.2.1.

@item 
gh-115015@footnote{https://github.com/python/cpython/issues/115015}: Fix a bug in Argument Clinic that generated incorrect code for
methods with no parameters that use the @ref{1698,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS} calling
convention. Only the positional parameter count was checked; any keyword
argument passed would be silently accepted.
@end itemize

@node C API<6>,,Tools/Demos<4>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id48}@anchor{1699}
@subsubsection C API



@itemize -

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: Adds @ref{455,,PyLong_AsNativeBytes()},
@ref{456,,PyLong_FromNativeBytes()} and
@ref{457,,PyLong_FromUnsignedNativeBytes()} functions.

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: @ref{7fa,,PyBuffer_FillInfo()} now raises a @ref{619,,SystemError} if
called with @ref{169a,,PyBUF_READ} or @ref{169b,,PyBUF_WRITE} as flags.
These flags should only be used with the @code{PyMemoryView_*} C API.

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: @ref{48c,,PyObject_GetBuffer()} now raises a @ref{619,,SystemError} if
called with @ref{169a,,PyBUF_READ} or @ref{169b,,PyBUF_WRITE} as flags.
These flags should only be used with the @code{PyMemoryView_*} C API.

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: Add @code{PyCFunctionFast} and @code{PyCFunctionFastWithKeywords}
typedefs (identical to the existing @code{_PyCFunctionFast} and
@code{_PyCFunctionFastWithKeywords} typedefs, just without a leading @code{_}
prefix).

@item 
gh-114329@footnote{https://github.com/python/cpython/issues/114329}: Add @ref{44f,,PyList_GetItemRef()}, which is similar to
@ref{450,,PyList_GetItem()} but returns a @ref{431,,strong reference} instead of
a @ref{432,,borrowed reference}.

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: Add PyTime C API:


@itemize *

@item 
@ref{421,,PyTime_t} type.

@item 
@ref{422,,PyTime_MIN} and @ref{423,,PyTime_MAX} constants.

@item 
@ref{424,,PyTime_AsSecondsDouble()},
@ref{425,,PyTime_Monotonic()}, @ref{427,,PyTime_PerfCounter()}, and
@ref{429,,PyTime_Time()} functions.
@end itemize

Patch by Victor Stinner.

@item 
gh-112066@footnote{https://github.com/python/cpython/issues/112066}: Add @ref{433,,PyDict_SetDefaultRef()}: insert a key and value into
a dictionary if the key is not already present. This is similar to
@ref{10f5,,dict.setdefault()}, but returns an integer value indicating if the
key was already present. It is also similar to
@ref{434,,PyDict_SetDefault()}, but returns a strong reference instead of a
borrowed reference.
@end itemize

@node Python 3 13 0 alpha 3,Python 3 13 0 alpha 2,Python 3 13 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-3}@anchor{169c}
@subsection Python 3.13.0 alpha 3


`Release date: 2024-01-17'

@menu
* Security: Security<6>. 
* Core and Builtins: Core and Builtins<7>. 
* Library: Library<7>. 
* Documentation: Documentation<7>. 
* Tests: Tests<6>. 
* Build: Build<7>. 
* Windows: Windows<7>. 
* macOS: macOS<5>. 
* IDLE: IDLE<7>. 
* C API: C API<7>. 

@end menu

@node Security<6>,Core and Builtins<7>,,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id49}@anchor{169d}
@subsubsection Security



@itemize -

@item 
gh-113659@footnote{https://github.com/python/cpython/issues/113659}: Skip @code{.pth} files with names starting with a dot or hidden
file attribute.

@item 
gh-112302@footnote{https://github.com/python/cpython/issues/112302}: Created a Software Bill-of-Materials document and tooling for
tracking dependencies.
@end itemize

@node Core and Builtins<7>,Library<7>,Security<6>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id50}@anchor{169e}
@subsubsection Core and Builtins



@itemize -

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Compiler duplicates basic blocks that have an eval breaker
check, no line number, and multiple predecessors.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: A jump leaving an exception handler back to normal code no
longer checks the eval breaker.

@item 
gh-113655@footnote{https://github.com/python/cpython/issues/113655}: Set the C recursion limit to 4000 on Windows, and 10000 on
Linux/OSX. This seems to be near the sweet spot to maintain safety, but
not compromise backwards compatibility.

@item 
gh-113710@footnote{https://github.com/python/cpython/issues/113710}: Add typed stack effects to the interpreter DSL, along with
various instruction annotations.

@item 
gh-77046@footnote{https://github.com/python/cpython/issues/77046}: On Windows, file descriptors wrapping Windows handles are now
created non inheritable by default (
@geindex Python Enhancement Proposals; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}). Patch by Zackery Spytz
and Victor Stinner.

@item 
gh-113853@footnote{https://github.com/python/cpython/issues/113853}: Guarantee that all executors make progress. This then
guarantees that tier 2 execution always makes progress.

@item 
gh-113753@footnote{https://github.com/python/cpython/issues/113753}: Fix an issue where the finalizer of @code{PyAsyncGenASend} objects
might not be called if they were allocated from a free list.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Compiler changed so that synthetic jumps which are not at loop
end no longer check the eval breaker.

@item 
gh-113703@footnote{https://github.com/python/cpython/issues/113703}: Fix a regression in the @ref{1d,,codeop} module that was causing
it to incorrectly identify incomplete f-strings. Patch by Pablo Galindo

@item 
gh-89811@footnote{https://github.com/python/cpython/issues/89811}: Check for a valid @code{tp_version_tag} before performing bytecode
specializations that rely on this value being usable.

@item 
gh-111488@footnote{https://github.com/python/cpython/issues/111488}: Changed error message in case of no “in” keyword after “for” in
list comprehensions

@item 
gh-113657@footnote{https://github.com/python/cpython/issues/113657}: Fix an issue that caused important instruction pointer updates
to be optimized out of tier two traces.

@item 
gh-113603@footnote{https://github.com/python/cpython/issues/113603}: Fixed bug where a redundant NOP is not removed, causing an
assertion to fail in the compiler in debug mode.

@item 
gh-113602@footnote{https://github.com/python/cpython/issues/113602}: Fix an error that was causing the parser to try to overwrite
existing errors and crashing in the process. Patch by Pablo Galindo

@item 
gh-113486@footnote{https://github.com/python/cpython/issues/113486}: No longer issue spurious @code{PY_UNWIND} events for optimized
calls to classes.

@item 
gh-113297@footnote{https://github.com/python/cpython/issues/113297}: Fix segfault in the compiler on with statement with 19 context
managers.

@item 
gh-113212@footnote{https://github.com/python/cpython/issues/113212}: Improve @ref{155,,super} error messages.

@item 
gh-111375@footnote{https://github.com/python/cpython/issues/111375}: Only use @code{NULL} in the exception stack to indicate an
exception was handled. Patch by Carey Metcalfe.

@item 
gh-112215@footnote{https://github.com/python/cpython/issues/112215}: Increase the C recursion limit by a factor of 3 for non-debug
builds, except for webassembly and s390 platforms which are unchanged.
This mitigates some regressions in 3.12 with deep recursion mixing builtin
(C) and Python code.

@item 
gh-113054@footnote{https://github.com/python/cpython/issues/113054}: Fixed bug where a redundant NOP is not removed, causing an
assertion to fail in the compiler in debug mode.

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: Use per AST-parser state rather than global state to track
recursion depth within the AST parser to prevent potential race condition
due to simultaneous parsing.

The issue primarily showed up in 3.11 by multithreaded users of
@ref{30f,,ast.parse()}.  In 3.12 a change to when garbage collection can be
triggered prevented the race condition from occurring.

@item 
gh-108866@footnote{https://github.com/python/cpython/issues/108866}: Change the API and contract of @code{_PyExecutorObject} to return
the next_instr pointer, instead of the frame, and to always execute at
least one instruction.

@item 
gh-90350@footnote{https://github.com/python/cpython/issues/90350}: Optimize builtin functions @ref{f8b,,min()} and @ref{f8c,,max()}.

@item 
gh-112943@footnote{https://github.com/python/cpython/issues/112943}: Correctly compute end column offsets for multiline tokens in
the @ref{fb,,tokenize} module. Patch by Pablo Galindo

@item 
gh-112125@footnote{https://github.com/python/cpython/issues/112125}: Fix @code{None.__ne__(None)} returning @code{NotImplemented} instead
of @code{False}.

@item 
gh-74616@footnote{https://github.com/python/cpython/issues/74616}: @ref{1340,,input()} now raises a ValueError when output on the
terminal if the prompt contains embedded null characters instead of
silently truncating it.

@item 
gh-112716@footnote{https://github.com/python/cpython/issues/112716}: Fix SystemError in the @code{import} statement and in
@code{__reduce__()} methods of builtin types when @code{__builtins__} is not a
dict.

@item 
gh-112730@footnote{https://github.com/python/cpython/issues/112730}: Use color to highlight error locations in tracebacks. Patch by
Pablo Galindo

@item 
gh-112625@footnote{https://github.com/python/cpython/issues/112625}: Fixes a bug where a bytearray object could be cleared while
iterating over an argument in the @code{bytearray.join()} method that could
result in reading memory after it was freed.

@item 
gh-112660@footnote{https://github.com/python/cpython/issues/112660}: Do not clear unexpected errors during formatting error messages
for ImportError and AttributeError for modules.

@item 
gh-105967@footnote{https://github.com/python/cpython/issues/105967}: Workaround a bug in Apple’s macOS platform zlib library where
@ref{169f,,zlib.crc32()} and @ref{16a0,,binascii.crc32()} could produce incorrect
results on multi-gigabyte inputs. Including when using @ref{130,,zipfile} on
zips containing large data.

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: Provide a better error message when accessing invalid attributes
on partially initialized modules. The origin of the module being accessed
is now included in the message to help with the common issue of shadowing
other modules.

@item 
gh-112217@footnote{https://github.com/python/cpython/issues/112217}: Add check for the type of @code{__cause__} returned from calling
the type @code{T} in @code{raise from T}.

@item 
gh-111058@footnote{https://github.com/python/cpython/issues/111058}: Change coro.cr_frame/gen.gi_frame to return @code{None} after the
coroutine/generator has been closed. This fixes a bug where
@ref{e9e,,getcoroutinestate()} and @ref{12a3,,getgeneratorstate()}
return the wrong state for a closed coroutine/generator.

@item 
gh-112388@footnote{https://github.com/python/cpython/issues/112388}: Fix an error that was causing the parser to try to overwrite
tokenizer errors. Patch by pablo Galindo

@item 
gh-112387@footnote{https://github.com/python/cpython/issues/112387}: Fix error positions for decoded strings with backwards tokenize
errors. Patch by Pablo Galindo

@item 
gh-99606@footnote{https://github.com/python/cpython/issues/99606}: Make code generated for an empty f-string identical to the code
of an empty normal string.

@item 
gh-112367@footnote{https://github.com/python/cpython/issues/112367}: Avoid undefined behaviour when using the perf trampolines by
not freeing the code arenas until shutdown. Patch by Pablo Galindo

@item 
gh-112320@footnote{https://github.com/python/cpython/issues/112320}: The Tier 2 translator now tracks the confidence level for
staying «on trace» (i.e. not exiting back to the Tier 1 interpreter) for
branch instructions based on the number of bits set in the branch
«counter». Trace translation ends when the confidence drops below 1/3rd.

@item 
gh-109598@footnote{https://github.com/python/cpython/issues/109598}:
@ref{16a1,,PyComplex_RealAsDouble()}/@ref{16a2,,PyComplex_ImagAsDouble()} now
tries to convert an object to a @ref{154,,complex} instance using its
@code{__complex__()} method before falling back to the @code{__float__()}
method. Patch by Sergey B Kirpichev.

@item 
gh-94606@footnote{https://github.com/python/cpython/issues/94606}: Fix UnicodeEncodeError when @code{email.message.get_payload()}
reads a message with a Unicode surrogate character and the message content
is not well-formed for surrogateescape encoding. Patch by Sidney
Markowitz.

@item 
bpo-21861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21861}: Use the object’s actual class name in
@code{_io.FileIO.__repr__()}, @code{_io._WindowsConsoleIO()} and
@code{_io.TextIOWrapper.__repr__()}, to make these methods subclass
friendly.

@item 
bpo-45369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45369}: Remove LibreSSL workarounds as per 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}.

@item 
bpo-34392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34392}: Added @ref{3a9,,sys._is_interned()}.
@end itemize

@node Library<7>,Documentation<7>,Core and Builtins<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id51}@anchor{16a3}
@subsubsection Library



@itemize -

@item 
gh-114077@footnote{https://github.com/python/cpython/issues/114077}: Fix possible @ref{919,,OverflowError} in
@ref{edd,,socket.socket.sendfile()} when pass `count' larger than 2 GiB on
32-bit platform.

@item 
gh-111803@footnote{https://github.com/python/cpython/issues/111803}: @ref{ab,,plistlib} now supports loading more deeply nested lists
in binary format.

@item 
gh-114014@footnote{https://github.com/python/cpython/issues/114014}: Fixed a bug in @ref{177,,fractions.Fraction} where an invalid
string using @code{d} in the decimals part creates a different error compared
to other invalid letters/characters. Patch by Jeremiah Gabriel Pascual.

@item 
gh-108364@footnote{https://github.com/python/cpython/issues/108364}: @ref{3a0,,sqlite3.Connection.iterdump()} now ensures that foreign
key support is disabled before dumping the database schema, if there is
any foreign key violation. Patch by Erlend E. Aasland and Mariusz
Felisiak.

@item 
gh-113971@footnote{https://github.com/python/cpython/issues/113971}: The @ref{d91,,zipfile.ZipInfo} previously protected
@code{._compresslevel} attribute has been made public as @code{.compress_level}
with the old @code{_compresslevel} name remaining available as a property to
retain compatibility.

@item 
gh-113877@footnote{https://github.com/python/cpython/issues/113877}: Fix @ref{f0,,tkinter} method @code{winfo_pathname()} on 64-bit
Windows.

@item 
gh-113868@footnote{https://github.com/python/cpython/issues/113868}: Added @ref{16a4,,mmap.MAP_NORESERVE}, @ref{16a5,,mmap.MAP_NOEXTEND},
@ref{16a6,,mmap.MAP_HASSEMAPHORE}, @ref{16a7,,mmap.MAP_NOCACHE},
@ref{16a8,,mmap.MAP_JIT}, @ref{16a9,,mmap.MAP_RESILIENT_CODESIGN},
@ref{16aa,,mmap.MAP_RESILIENT_MEDIA}, @ref{16ab,,mmap.MAP_32BIT},
@ref{16ac,,mmap.MAP_TRANSLATED_ALLOW_EXECUTE}, @ref{16ad,,mmap.MAP_UNIX03} and
@ref{16ae,,mmap.MAP_TPRO}. All of them are @code{mmap(2)} flags on macOS.

@item 
gh-113848@footnote{https://github.com/python/cpython/issues/113848}: @ref{31c,,asyncio.TaskGroup()} and @ref{69f,,asyncio.timeout()} context
managers now handle @ref{31f,,CancelledError} subclasses as well as
exact @code{CancelledError}.

@item 
gh-113661@footnote{https://github.com/python/cpython/issues/113661}: unittest runner: Don’t exit 5 if tests were skipped. The
intention of exiting 5 was to detect issues where the test suite wasn’t
discovered at all. If we skipped tests, it was correctly discovered.

@item 
gh-96037@footnote{https://github.com/python/cpython/issues/96037}: Insert @ref{8cc,,TimeoutError} in the context of the exception that
was raised during exiting an expired @ref{69f,,asyncio.timeout()} block.

@item 
gh-113781@footnote{https://github.com/python/cpython/issues/113781}: Silence unraisable AttributeError when warnings are emitted
during Python finalization.

@item 
gh-113238@footnote{https://github.com/python/cpython/issues/113238}: Add @code{Anchor} to @code{importlib.resources} (in order for the
code to comply with the documentation)

@item 
gh-111693@footnote{https://github.com/python/cpython/issues/111693}: @ref{16af,,asyncio.Condition.wait()} now re-raises the same
@code{CancelledError} instance that may have caused it to be interrupted.
Fixed race condition in @ref{16b0,,asyncio.Semaphore.acquire()} when interrupted
with a @code{CancelledError}.

@item 
gh-113791@footnote{https://github.com/python/cpython/issues/113791}: Add @code{CLOCK_MONOTONIC_RAW_APPROX} and
@code{CLOCK_UPTIME_RAW_APPROX} to @ref{ee,,time} on macOS. These are clocks
available on macOS 10.12 or later.

@item 
gh-112932@footnote{https://github.com/python/cpython/issues/112932}: Restore the ability for @ref{130,,zipfile} to @code{extractall} from
zip files with a «/» directory entry in them as is commonly added to zips
by some wiki or bug tracker data exporters.

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: Raise deprecation warnings from @ref{54e,,pathlib.PurePath} and
not its private base class @code{PurePathBase}.

@item 
gh-113594@footnote{https://github.com/python/cpython/issues/113594}: Fix @ref{718,,UnicodeEncodeError} in @ref{3c,,email} when re-fold
lines that contain unknown-8bit encoded part followed by non-unknown-8bit
encoded part.

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: In @code{asyncio.StreamReaderProtocol.connection_made()}, there
is callback that logs an error if the task wrapping the «connected
callback» fails. This callback would itself fail if the task was
cancelled. Prevent this by checking whether the task was cancelled first.
If so, close the transport but don’t log an error.

@item 
gh-113626@footnote{https://github.com/python/cpython/issues/113626}: Add support for the `allow_code' argument in the @ref{8d,,marshal}
module. Passing @code{allow_code=False} prevents serialization and
de-serialization of code objects which is incompatible between Python
versions.

@item 
gh-85567@footnote{https://github.com/python/cpython/issues/85567}: Fix resource warnings for unclosed files in @ref{a6,,pickle} and
@ref{a7,,pickletools} command line interfaces.

@item 
gh-113537@footnote{https://github.com/python/cpython/issues/113537}: Support loads @code{str} in @ref{9e3,,plistlib.loads()}.

@item 
gh-89850@footnote{https://github.com/python/cpython/issues/89850}: Add default implementations of
@ref{159f,,pickle.Pickler.persistent_id()} and
@ref{15a9,,pickle.Unpickler.persistent_load()} methods in the C implementation.
Calling @code{super().persistent_id()} and @code{super().persistent_load()} in
subclasses of the C implementation of @ref{ab0,,pickle.Pickler} and
@ref{16b1,,pickle.Unpickler} classes no longer causes infinite recursion.

@item 
gh-113569@footnote{https://github.com/python/cpython/issues/113569}: Indicate if there were no actual calls in unittest
@ref{16b2,,assert_has_calls()} failure.

@item 
gh-101225@footnote{https://github.com/python/cpython/issues/101225}: Increase the backlog for
@ref{16b3,,multiprocessing.connection.Listener} objects created by
@code{multiprocessing.manager} and @code{multiprocessing.resource_sharer}
to significantly reduce the risk of getting a connection refused error
when creating a @ref{15e3,,multiprocessing.connection.Connection} to them.

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: Raise audit events from @ref{19b,,pathlib.Path} and not its
private base class @code{PathBase}.

@item 
gh-113543@footnote{https://github.com/python/cpython/issues/113543}: Make sure that @code{webbrowser.MacOSXOSAScript} sends
@code{webbrowser.open} audit event.

@item 
gh-113028@footnote{https://github.com/python/cpython/issues/113028}: When a second reference to a string appears in the input to
@ref{a6,,pickle}, and the Python implementation is in use, we are guaranteed
that a single copy gets pickled and a single object is shared when
reloaded. Previously, in protocol 0, when a string contained certain
characters (e.g. newline) it resulted in duplicate objects.

@item 
gh-113421@footnote{https://github.com/python/cpython/issues/113421}: Fix multiprocessing logger for @code{%(filename)s}.

@item 
gh-111784@footnote{https://github.com/python/cpython/issues/111784}: Fix segfaults in the @code{_elementtree} module. Fix first
segfault during deallocation of @code{_elementtree.XMLParser} instances by
keeping strong reference to @code{pyexpat} module in module state for capsule
lifetime. Fix second segfault which happens in the same deallocation
process  by keeping strong reference to @code{_elementtree} module in
@code{XMLParser} structure for @code{_elementtree} module lifetime.

@item 
gh-113407@footnote{https://github.com/python/cpython/issues/113407}: Fix import of @ref{107,,unittest.mock} when CPython is built
without docstrings.

@item 
gh-113320@footnote{https://github.com/python/cpython/issues/113320}: Fix regression in Python 3.12 where @ref{3bb,,Protocol}
classes that were not marked as @ref{4f0,,runtime-checkable} would be unnecessarily introspected,
potentially causing exceptions to be raised if the protocol had
problematic members. Patch by Alex Waygood.

@item 
gh-53502@footnote{https://github.com/python/cpython/issues/53502}: Add a new option @code{aware_datetime} in @ref{ab,,plistlib} to loads
or dumps aware datetime.

@item 
gh-113358@footnote{https://github.com/python/cpython/issues/113358}: Fix rendering tracebacks with exceptions with a broken
__getattr__

@item 
gh-113214@footnote{https://github.com/python/cpython/issues/113214}: Fix an @code{AttributeError} during asyncio SSL protocol aborts in
SSL-over-SSL scenarios.

@item 
gh-113246@footnote{https://github.com/python/cpython/issues/113246}: Update bundled pip to 23.3.2.

@item 
gh-87264@footnote{https://github.com/python/cpython/issues/87264}: Fixed tarfile list() method to show file type.

@item 
gh-112182@footnote{https://github.com/python/cpython/issues/112182}: @code{asyncio.futures.Future.set_exception()} now transforms
@ref{c82,,StopIteration} into @ref{1e5,,RuntimeError} instead of hanging or other
misbehavior. Patch contributed by Jamie Phan.

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: Speed up @ref{388,,pathlib.Path.glob()} by using
@ref{1687,,os.DirEntry.path} where possible.

@item 
gh-113149@footnote{https://github.com/python/cpython/issues/113149}: Improve error message when a JSON array or object contains a
trailing comma. Patch by Carson Radtke.

@item 
gh-113117@footnote{https://github.com/python/cpython/issues/113117}: The @ref{d6,,subprocess} module can now use the
@ref{37d,,os.posix_spawn()} function with @code{close_fds=True} on platforms where
@code{posix_spawn_file_actions_addclosefrom_np} is available. Patch by Jakub
Kulik.

@item 
gh-113199@footnote{https://github.com/python/cpython/issues/113199}: Make @code{http.client.HTTPResponse.read1} and
@code{http.client.HTTPResponse.readline} close IO after reading all data when
content length is known. Patch by Illia Volochii.

@item 
gh-113191@footnote{https://github.com/python/cpython/issues/113191}: Add support of @ref{379,,os.fchmod()} and a file descriptor in
@ref{378,,os.chmod()} on Windows.

@item 
gh-113188@footnote{https://github.com/python/cpython/issues/113188}: Fix @ref{16b4,,shutil.copymode()} and @ref{11a0,,shutil.copystat()} on
Windows. Previously they worked differently if `dst' is a symbolic link:
they modified the permission bits of `dst' itself rather than the file it
points to if `follow_symlinks' is true or `src' is not a symbolic link,
and did not modify the permission bits if `follow_symlinks' is false and
`src' is a symbolic link.

@item 
gh-113119@footnote{https://github.com/python/cpython/issues/113119}: @ref{37d,,os.posix_spawn()} now accepts @code{env=None}, which makes
the newly spawned process use the current process environment. Patch by
Jakub Kulik.

@item 
gh-113202@footnote{https://github.com/python/cpython/issues/113202}: Add a @code{strict} option to @code{batched()} in the @code{itertools}
module.

@item 
gh-61648@footnote{https://github.com/python/cpython/issues/61648}: Detect line numbers of properties in doctests.

@item 
gh-113175@footnote{https://github.com/python/cpython/issues/113175}: Sync with importlib_metadata 7.0, including improved type
annotations, fixed issue with symlinked packages in
@code{package_distributions}, added @code{EntryPoints.__repr__}, introduced the
@code{diagnose} script, added @code{Distribution.origin} property, and removed
deprecated @code{EntryPoint} access by numeric index (tuple behavior).

@item 
gh-59616@footnote{https://github.com/python/cpython/issues/59616}: Add support of @ref{377,,os.lchmod()} and the `follow_symlinks'
argument in @ref{378,,os.chmod()} on Windows. Note that the default value of
`follow_symlinks' in @code{os.lchmod()} is @code{False} on Windows.

@item 
gh-112559@footnote{https://github.com/python/cpython/issues/112559}: @ref{11a6,,signal.signal()} and @ref{16b5,,signal.getsignal()} no longer
call @code{repr} on callable handlers. @ref{525,,asyncio.run()} and
@ref{15e9,,asyncio.Runner.run()} no longer call @code{repr} on the task results.
Patch by Yilei Yang.

@item 
gh-112962@footnote{https://github.com/python/cpython/issues/112962}: @ref{39,,dis} module functions add cache information to the
@ref{170,,Instruction} instance rather than creating fake
@ref{170,,Instruction} instances to represent the cache entries.

@item 
gh-112989@footnote{https://github.com/python/cpython/issues/112989}: Reduce overhead to connect sockets with @ref{b,,asyncio}
SelectorEventLoop.

@item 
gh-112970@footnote{https://github.com/python/cpython/issues/112970}: Use @code{closefrom()} on Linux where available (e.g.
glibc-2.34), rather than only FreeBSD.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Fix ctypes structs with array on PPC64LE platform by setting
@code{MAX_STRUCT_SIZE} to 64 in stgdict. Patch by Diego Russo.

@item 
gh-112540@footnote{https://github.com/python/cpython/issues/112540}: The statistics.geometric_mean() function now returns zero for
datasets containing a zero.  Formerly, it would raise an exception.

@item 
gh-87286@footnote{https://github.com/python/cpython/issues/87286}: Added @code{LOG_FTP}, @code{LOG_NETINFO},
@code{LOG_REMOTEAUTH}, @code{LOG_INSTALL}, @code{LOG_RAS}, and
@code{LOG_LAUNCHD} tot the @ref{dc,,syslog} module, all of them constants
on used on macOS.

@item 
gh-112800@footnote{https://github.com/python/cpython/issues/112800}: Fix @ref{b,,asyncio} @code{SubprocessTransport.close()} not to throw
@code{PermissionError} when used with setuid executables.

@item 
gh-51944@footnote{https://github.com/python/cpython/issues/51944}: Add the following constants to the @ref{e1,,termios} module. These
values are present in macOS system headers: @code{ALTWERASE}, @code{B14400},
@code{B28800}, @code{B7200}, @code{B76800}, @code{CCAR_OFLOW}, @code{CCTS_OFLOW},
@code{CDSR_OFLOW}, @code{CDTR_IFLOW}, @code{CIGNORE}, @code{CRTS_IFLOW}, @code{EXTPROC},
@code{IUTF8}, @code{MDMBUF}, @code{NL2}, @code{NL3}, @code{NOKERNINFO}, @code{ONOEOT},
@code{OXTABS}, @code{VDSUSP}, @code{VSTATUS}.

@item 
gh-79325@footnote{https://github.com/python/cpython/issues/79325}: Fix an infinite recursion error in
@ref{12a1,,tempfile.TemporaryDirectory()} cleanup on Windows.

@item 
gh-94692@footnote{https://github.com/python/cpython/issues/94692}: @ref{1f9,,shutil.rmtree()} now only catches OSError exceptions.
Previously a symlink attack resistant version of @code{shutil.rmtree()} could
ignore or pass to the error handler arbitrary exception when invalid
arguments were provided.

@item 
gh-112736@footnote{https://github.com/python/cpython/issues/112736}: The use of del-safe symbols in @code{subprocess} was refactored to
allow for use in cross-platform build environments.

@item 
gh-112727@footnote{https://github.com/python/cpython/issues/112727}: Speed up @ref{16b6,,pathlib.Path.absolute()}. Patch by Barney Gale.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: Speedup @ref{85a,,issubclass()} checks against simple
@ref{4f0,,runtime-checkable protocols} by around
6%. Patch by Alex Waygood.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: Speedup @ref{4ef,,isinstance()} checks by roughly 20% for
@ref{4f0,,runtime-checkable protocols} that only
have one callable member. Speedup @ref{85a,,issubclass()} checks for these
protocols by roughly 10%. Patch by Alex Waygood.

@item 
gh-112645@footnote{https://github.com/python/cpython/issues/112645}: Remove deprecation error on passing @code{onerror} to
@ref{1f9,,shutil.rmtree()}.

@item 
gh-112640@footnote{https://github.com/python/cpython/issues/112640}: Add @code{kwdefaults} parameter to @ref{91b,,types.FunctionType} to
set default keyword argument values.

@item 
gh-112622@footnote{https://github.com/python/cpython/issues/112622}: Ensure @code{name} parameter is passed to event loop in
@ref{69d,,asyncio.create_task()}.

@item 
gh-112618@footnote{https://github.com/python/cpython/issues/112618}: Fix a caching bug relating to @ref{9d0,,typing.Annotated}.
@code{Annotated[str, True]} is no longer identical to @code{Annotated[str, 1]}.

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: Fixed a performance regression in 3.12’s @ref{d6,,subprocess} on
Linux where it would no longer use the fast-path @code{vfork()} system call
when it could have due to a logic bug, instead falling back to the safe
but slower @code{fork()}.

Also fixed a second 3.12.0 potential security bug.  If a value of
@code{extra_groups=[]} was passed to @ref{301,,subprocess.Popen} or related APIs,
the underlying @code{setgroups(0, NULL)} system call to clear the groups list
would not be made in the child process prior to @code{exec()}.

This was identified via code inspection in the process of fixing the first
bug.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Fix ctypes structs with array on Arm platform by setting
@code{MAX_STRUCT_SIZE} to 32 in stgdict. Patch by Diego Russo.

@item 
gh-81194@footnote{https://github.com/python/cpython/issues/81194}: Fix a crash in @ref{ac1,,socket.if_indextoname()} with specific value
(UINT_MAX). Fix an integer overflow in @ref{ac1,,socket.if_indextoname()} on
64-bit non-Windows platforms.

@item 
gh-112578@footnote{https://github.com/python/cpython/issues/112578}: Fix a spurious @ref{323,,RuntimeWarning} when executing the
@ref{130,,zipfile} module.

@item 
gh-112516@footnote{https://github.com/python/cpython/issues/112516}: Update the bundled copy of pip to version 23.3.1.

@item 
gh-112510@footnote{https://github.com/python/cpython/issues/112510}: Add @ref{16b7,,readline.backend} for the backend readline uses
(@code{editline} or @code{readline})

@item 
gh-112328@footnote{https://github.com/python/cpython/issues/112328}: [Enum] Make @code{EnumDict}, @code{EnumDict.member_names},
@code{EnumType._add_alias_} and @code{EnumType._add_value_alias_} public.

@item 
gh-112509@footnote{https://github.com/python/cpython/issues/112509}: Fix edge cases that could cause a key to be present in both the
@code{__required_keys__} and @code{__optional_keys__} attributes of a
@ref{2ce,,typing.TypedDict}. Patch by Jelle Zijlstra.

@item 
gh-101336@footnote{https://github.com/python/cpython/issues/101336}: Add @code{keep_alive} keyword parameter for
@code{AbstractEventLoop.create_server()} and
@code{BaseEventLoop.create_server()}.

@item 
gh-63284@footnote{https://github.com/python/cpython/issues/63284}: Added support for TLS-PSK (pre-shared key) mode to the
@ref{d0,,ssl} module.

@item 
gh-112414@footnote{https://github.com/python/cpython/issues/112414}: Fix regression in Python 3.12 where calling @ref{894,,repr()} on a
module that had been imported using a custom @ref{16b8,,loader} could fail
with @ref{441,,AttributeError}. Patch by Alex Waygood.

@item 
gh-112358@footnote{https://github.com/python/cpython/issues/112358}: Revert change to @ref{16b9,,struct.Struct} initialization that
broke some cases of subclassing.

@item 
gh-112405@footnote{https://github.com/python/cpython/issues/112405}: Optimize @ref{21d,,pathlib.PurePath.relative_to()}. Patch by Alex
Waygood.

@item 
gh-94722@footnote{https://github.com/python/cpython/issues/94722}: Fix bug where comparison between instances of
@ref{16ba,,DocTest} fails if one of them has @code{None} as its lineno.

@item 
gh-112361@footnote{https://github.com/python/cpython/issues/112361}: Speed up a small handful of @ref{a4,,pathlib} methods by removing
some temporary objects.

@item 
gh-112345@footnote{https://github.com/python/cpython/issues/112345}: Improve error message when trying to call @ref{85a,,issubclass()}
against a @ref{3bb,,typing.Protocol} that has non-method members. Patch by
Randolf Scholz.

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: Change @ref{39,,dis} output to display no-lineno as «–» instead
of «None».

@item 
gh-112332@footnote{https://github.com/python/cpython/issues/112332}: Deprecate the @code{exc_type} field of
@ref{3b3,,traceback.TracebackException}. Add @code{exc_type_str} to replace it.

@item 
gh-81620@footnote{https://github.com/python/cpython/issues/81620}: Add extra tests for @ref{557,,random.binomialvariate()}

@item 
gh-112292@footnote{https://github.com/python/cpython/issues/112292}: Fix a crash in @ref{ba,,readline} when imported from a sub
interpreter. Patch by Anthony Shaw

@item 
gh-77621@footnote{https://github.com/python/cpython/issues/77621}: Slightly improve the import time of the @ref{a4,,pathlib} module by
deferring some imports. Patch by Barney Gale.

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: Change @ref{39,,dis} output to display logical labels for jump
targets instead of offsets.

@item 
gh-112139@footnote{https://github.com/python/cpython/issues/112139}: Add @code{Signature.format()} to format signatures to string
with extra options. And use it in @ref{b5,,pydoc} to render more readable
signatures that have new lines between parameters.

@item 
gh-112105@footnote{https://github.com/python/cpython/issues/112105}: Make @ref{16bb,,readline.set_completer_delims()} work with libedit

@item 
gh-106922@footnote{https://github.com/python/cpython/issues/106922}: Display multiple lines with @code{traceback} when errors span
multiple lines.

@item 
gh-111874@footnote{https://github.com/python/cpython/issues/111874}: When creating a @ref{1db,,typing.NamedTuple} class, ensure
@ref{cd6,,__set_name__()} is called on all objects that define
@code{__set_name__} and exist in the values of the @code{NamedTuple} class’s
class dictionary. Patch by Alex Waygood.

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: Add support of the «vsapi» element type in
@ref{3af,,tkinter.ttk.Style.element_create()}.

@item 
gh-110275@footnote{https://github.com/python/cpython/issues/110275}: Named tuple’s methods @code{_replace()} and @code{__replace__()} now
raise TypeError instead of ValueError for invalid keyword arguments.

@item 
gh-99367@footnote{https://github.com/python/cpython/issues/99367}: Do not mangle @code{sys.path[0]} in @ref{a5,,pdb} if safe_path is set

@item 
gh-111615@footnote{https://github.com/python/cpython/issues/111615}: Fix a regression caused by a fix to gh-93162@footnote{https://github.com/python/cpython/issues/93162} whereby you
couldn’t configure a @code{QueueHandler} without specifying handlers.

@item 
gh-75666@footnote{https://github.com/python/cpython/issues/75666}: Fix the behavior of @ref{f0,,tkinter} widget’s @code{unbind()} method
with two arguments. Previously, @code{widget.unbind(sequence, funcid)}
destroyed the current binding for `sequence', leaving `sequence' unbound,
and deleted the `funcid' command. Now it removes only `funcid' from the
binding for `sequence', keeping other commands, and deletes the `funcid'
command. It leaves `sequence' unbound only if `funcid' was the last bound
command.

@item 
gh-67790@footnote{https://github.com/python/cpython/issues/67790}: Implement basic formatting support (minimum width, alignment,
fill) for @ref{177,,fractions.Fraction}.

@item 
gh-111049@footnote{https://github.com/python/cpython/issues/111049}: Fix crash during garbage collection of the @ref{f25,,io.BytesIO}
buffer object.

@item 
gh-102980@footnote{https://github.com/python/cpython/issues/102980}: Redirect the output of @code{interact} command of @ref{a5,,pdb} to
the same channel as the debugger. Add tests and improve docs.

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: @ref{344,,email.utils.getaddresses()} and
@ref{345,,email.utils.parseaddr()} now return @code{('@w{'}, '@w{'})} 2-tuples in more
situations where invalid email addresses are encountered instead of
potentially inaccurate values. Add optional `strict' parameter to these
two functions: use @code{strict=False} to get the old behavior, accept
malformed inputs. @code{getattr(email.utils, 'supports_strict_parsing',
False)} can be use to check if the `strict' parameter is available. Patch
by Thomas Dwyer and Victor Stinner to improve the 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043} fix.

@item 
gh-52161@footnote{https://github.com/python/cpython/issues/52161}: @ref{16bc,,cmd.Cmd.do_help()} now cleans docstrings with
@ref{16bd,,inspect.cleandoc()} before writing them. Patch by Filip Łapkiewicz.

@item 
gh-82300@footnote{https://github.com/python/cpython/issues/82300}: Add @code{track} parameter to
@ref{1664,,multiprocessing.shared_memory.SharedMemory} that allows using
shared memory blocks without having to register with the POSIX resource
tracker that automatically releases them upon process exit.

@item 
gh-110109@footnote{https://github.com/python/cpython/issues/110109}: Add private @code{pathlib._PurePathBase} class: a base class for
@ref{54e,,pathlib.PurePath} that omits certain magic methods. It may be made
public (along with @code{_PathBase}) in future.

@item 
gh-109858@footnote{https://github.com/python/cpython/issues/109858}: Protect @ref{130,,zipfile} from «quoted-overlap» zipbomb. It now
raises BadZipFile when try to read an entry that overlaps with other entry
or central directory.

@item 
gh-109786@footnote{https://github.com/python/cpython/issues/109786}: Fix possible reference leaks and crash when re-enter the
@code{__next__()} method of @ref{8ac,,itertools.pairwise}.

@item 
gh-91539@footnote{https://github.com/python/cpython/issues/91539}: Small (10 - 20%) and trivial performance improvement of
@code{urllib.request.getproxies_environment()}, typically useful when there
are many environment variables to go over.

@item 
gh-103363@footnote{https://github.com/python/cpython/issues/103363}: Add `follow_symlinks' keyword-only argument to
@ref{38c,,pathlib.Path.owner()} and @ref{38d,,group()}, defaulting to
@code{True}.

@item 
gh-102130@footnote{https://github.com/python/cpython/issues/102130}: Support tab completion in @ref{1a,,cmd} for @code{editline}.

@item 
gh-99437@footnote{https://github.com/python/cpython/issues/99437}: @ref{2ec,,runpy.run_path()} now decodes path-like objects, making
sure __file__ and sys.argv[0] of the module being run are always strings.

@item 
gh-104003@footnote{https://github.com/python/cpython/issues/104003}: Add @ref{2cc,,warnings.deprecated()}, a decorator to mark deprecated
functions to static type checkers and to warn on usage of deprecated
classes and functions. See 
@geindex Python Enhancement Proposals; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}. Patch by Jelle Zijlstra.

@item 
gh-103708@footnote{https://github.com/python/cpython/issues/103708}: Make hardcoded python name, a configurable parameter so that
different implementations of python can override it instead of making huge
diffs in sysconfig.py

@item 
gh-66515@footnote{https://github.com/python/cpython/issues/66515}: @ref{16be,,mailbox.MH} now supports folders that do not contain a
@code{.mh_sequences} file (e.g. Claws Mail IMAP-cache folders). Patch by
Serhiy Storchaka.

@item 
gh-83162@footnote{https://github.com/python/cpython/issues/83162}: Renamed @code{re.error} to @code{PatternError} for clarity, and
kept @code{re.error} for backward compatibility. Patch by Matthias
Bussonnier and Adam Chhina.

@item 
gh-91133@footnote{https://github.com/python/cpython/issues/91133}: Fix a bug in @ref{12a1,,tempfile.TemporaryDirectory} cleanup, which
now no longer dereferences symlinks when working around file system
permission errors.

@item 
bpo-43153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43153}: On Windows, @code{tempfile.TemporaryDirectory} previously masked a
@code{PermissionError} with @code{NotADirectoryError} during directory cleanup.
It now correctly raises @code{PermissionError} if errors are not ignored.
Patch by Andrei Kulakov and Ken Jin.

@item 
bpo-32731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32731}: @ref{4d6,,getpass.getuser()} now raises @ref{4d5,,OSError} for all
failures rather than @ref{4d7,,ImportError} on systems lacking the @ref{b2,,pwd}
module or @ref{438,,KeyError} if the password database is empty.

@item 
bpo-34321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34321}: @ref{368,,mmap.mmap} now has a `trackfd' parameter on Unix; if it
is @code{False}, the file descriptor specified by `fileno' will not be
duplicated.

@item 
bpo-35332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35332}: The @ref{1f9,,shutil.rmtree()} function now ignores errors when
calling @ref{bfc,,os.close()} when `ignore_errors' is @code{True}, and
@ref{bfc,,os.close()} no longer retried after error.

@item 
bpo-35928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35928}: @ref{854,,io.TextIOWrapper} now correctly handles the decoding
buffer after @code{read()} and @code{write()}.

@item 
bpo-26791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26791}: @ref{aed,,shutil.move()} now moves a symlink into a directory when
that directory is the target of the symlink.  This provides the same
behavior as the mv shell command.  The previous behavior raised an
exception.  Patch by Jeffrey Kintscher.

@item 
bpo-41422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41422}: Fixed memory leaks of @ref{ab0,,pickle.Pickler} and
@ref{16b1,,pickle.Unpickler} involving cyclic references via the internal
memo mapping.

@item 
bpo-19821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19821}: The @code{pydoc.ispackage()} function has been deprecated.

@item 
bpo-40262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40262}: The @code{ssl.SSLSocket.recv_into()} method no longer requires
the `buffer' argument to implement @code{__len__} and supports buffers with
arbitrary item size.

@item 
bpo-39912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39912}: @ref{14e5,,warnings.filterwarnings()} and
@ref{762,,warnings.simplefilter()} now raise appropriate exceptions instead of
@code{AssertionError}. Patch contributed by Rémi Lapeyre.

@item 
bpo-37260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37260}: Fixed a race condition in @ref{1f9,,shutil.rmtree()} in which
directory entries removed by another process or thread while
@code{shutil.rmtree()} is running can cause it to raise FileNotFoundError.
Patch by Jeffrey Kintscher.

@item 
bpo-36959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36959}: Fix some error messages for invalid ISO format string
combinations in @code{strptime()} that referred to directives not contained
in the format string. Patch by Gordon P. Hemsley.

@item 
bpo-18060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18060}: Fixed a class inheritance issue that can cause segfaults when
deriving two or more levels of subclasses from a base class of Structure
or Union.

@item 
bpo-29779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29779}: Add a new 
@geindex PYTHON_HISTORY
@geindex variables de entorno; PYTHON_HISTORY
@ref{2fa,,PYTHON_HISTORY} environment variable to set
the location of a @code{.python_history} file.

@item 
bpo-21360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21360}: @ref{4da,,mailbox.Maildir} now ignores files with a leading dot.
@end itemize

@node Documentation<7>,Tests<6>,Library<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id52}@anchor{16bf}
@subsubsection Documentation



@itemize -

@item 
gh-111699@footnote{https://github.com/python/cpython/issues/111699}: Relocate @code{smtpd} deprecation notice to its own section rather
than under @code{locale} in What’s New in Python 3.12 document

@item 
gh-110746@footnote{https://github.com/python/cpython/issues/110746}: Improved markup for valid options/values for methods
ttk.treeview.column and ttk.treeview.heading, and for Layouts.

@item 
gh-95649@footnote{https://github.com/python/cpython/issues/95649}: Document that the @ref{b,,asyncio} module contains code taken from
v0.16.0 of the uvloop project@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0}, as well as the
required MIT licensing information.
@end itemize

@node Tests<6>,Build<7>,Documentation<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id53}@anchor{16c0}
@subsubsection Tests



@itemize -

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: Disable @code{test_super_deep()} from @code{test_call} under pydebug
builds on WASI; the stack depth is too small to make the test useful.

@item 
gh-111801@footnote{https://github.com/python/cpython/issues/111801}: Lower the recursion limit in @code{test_isinstance} for
@code{test_infinitely_many_bases()}. This prevents a stack overflow on a
pydebug build of WASI.

@item 
gh-111802@footnote{https://github.com/python/cpython/issues/111802}: Specify a low recursion depth for @code{test_bad_getattr()} in
@code{test.pickletester} to avoid exhausting the stack under a pydebug build
for WASI.

@item 
gh-44626@footnote{https://github.com/python/cpython/issues/44626}: Fix @ref{380,,os.path.isabs()} incorrectly returning @code{True} when
given a path that starts with exactly one (back)slash on Windows.

Fix @code{pathlib.PureWindowsPath.is_absolute()} incorrectly returning
@code{False} for some paths beginning with two (back)slashes.

@item 
gh-113633@footnote{https://github.com/python/cpython/issues/113633}: Use module state for the _testcapi extension module.

@item 
gh-109980@footnote{https://github.com/python/cpython/issues/109980}: Fix @code{test_tarfile_vs_tar} in @code{test_shutil} for macOS, where
system tar can include more information in the archive than
@ref{55a,,shutil.make_archive}.

@item 
gh-112769@footnote{https://github.com/python/cpython/issues/112769}: The tests now correctly compare zlib version when
@ref{11df,,zlib.ZLIB_RUNTIME_VERSION} contains non-integer suffixes. For
example zlib-ng defines the version as @code{1.3.0.zlib-ng}.

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: Adds a regression test to verify that @code{vfork()} is used when
expected by @ref{d6,,subprocess} on vfork enabled POSIX systems (Linux).

@item 
gh-108927@footnote{https://github.com/python/cpython/issues/108927}: Fixed order dependence in running tests in the same process
when a test that has submodules (e.g. test_importlib) follows a test that
imports its submodule (e.g. test_importlib.util) and precedes a test (e.g.
test_unittest or test_compileall) that uses that submodule.

@item 
bpo-40648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40648}: Test modes that file can get with chmod() on Windows.
@end itemize

@node Build<7>,Windows<7>,Tests<6>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id54}@anchor{16c1}
@subsubsection Build



@itemize -

@item 
gh-114013@footnote{https://github.com/python/cpython/issues/114013}: Fix @code{Tools/wasm/wasi.py} to not include the path to
@code{python.wasm} as part of @code{HOSTRUNNER}. The environment variable is
meant to specify how to run the WASI host only, having @code{python.wasm} and
relevant flags appended to the @code{HOSTRUNNER}. This fixes @code{make test}
work.

@item 
gh-113258@footnote{https://github.com/python/cpython/issues/113258}: Changed the Windows build to write out generated frozen modules
into the build tree instead of the source tree.

@item 
gh-112305@footnote{https://github.com/python/cpython/issues/112305}: Fixed the @code{check-clean-src} step performed on out of tree
builds to detect errant @code{$(srcdir)/Python/frozen_modules/*.h} files and
recommend appropriate source tree cleanup steps to get a working build
again.

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: Add support for thread sanitizer (TSAN)

@item 
gh-112867@footnote{https://github.com/python/cpython/issues/112867}: Fix the build for the case that WITH_PYMALLOC_RADIX_TREE=0 set.

@item 
gh-103065@footnote{https://github.com/python/cpython/issues/103065}: Introduce @code{Tools/wasm/wasi.py} to simplify doing a WASI
build.

@item 
bpo-11102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11102}: The @ref{15fc,,os.major()}, @ref{15fe,,os.makedev()}, and @ref{15fd,,os.minor()}
functions are now available on HP-UX v3.

@item 
bpo-36351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36351}: Do not set ipv6type when cross-compiling.
@end itemize

@node Windows<7>,macOS<5>,Build<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id55}@anchor{16c2}
@subsubsection Windows



@itemize -

@item 
gh-114096@footnote{https://github.com/python/cpython/issues/114096}: Process privileges that are activated for creating directory
junctions are now restored afterwards, avoiding behaviour changes in other
parts of the program.

@item 
gh-111877@footnote{https://github.com/python/cpython/issues/111877}: @ref{548,,os.stat()} calls were returning incorrect time values for
files that could not be accessed directly.

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: Update Windows installer to use SQLite 3.44.2.

@item 
gh-113009@footnote{https://github.com/python/cpython/issues/113009}: @ref{94,,multiprocessing}: On Windows, fix a race condition in
@code{Process.terminate()}: no longer set the @code{returncode} attribute to
always call @code{WaitForSingleObject()} in @code{Process.wait()}.  Previously,
sometimes the process was still running after @code{TerminateProcess()} even
if @code{GetExitCodeProcess()} is not @code{STILL_ACTIVE}. Patch by Victor
Stinner.

@item 
gh-86179@footnote{https://github.com/python/cpython/issues/86179}: Fixes path calculations when launching Python on Windows through
a symlink.

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: Update Tcl/Tk in Windows installer to 8.6.13 with a patch to
suppress incorrect ThemeChanged warnings.

@item 
gh-111650@footnote{https://github.com/python/cpython/issues/111650}: Ensures the @code{Py_GIL_DISABLED} preprocessor variable is
defined in @code{pyconfig.h} so that extension modules written in C are
able to use it.

@item 
gh-112278@footnote{https://github.com/python/cpython/issues/112278}: Reduce the time cost for some functions in @ref{aa,,platform} on
Windows if current user has no permission to the WMI.

@item 
gh-73427@footnote{https://github.com/python/cpython/issues/73427}: Deprecate @ref{1e6,,sys._enablelegacywindowsfsencoding()}. Use
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} instead. Patch by Inada Naoki.

@item 
gh-87868@footnote{https://github.com/python/cpython/issues/87868}: Correctly sort and remove duplicate environment variables in
@code{_winapi.CreateProcess()}.

@item 
bpo-37308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37308}: Fix mojibake in @ref{368,,mmap.mmap} when using a non-ASCII
`tagname' argument on Windows.
@end itemize

@node macOS<5>,IDLE<7>,Windows<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id56}@anchor{16c3}
@subsubsection macOS



@itemize -

@item 
gh-113666@footnote{https://github.com/python/cpython/issues/113666}: Add the following constants to module @ref{d1,,stat}:
@code{UF_SETTABLE}, @code{UF_TRACKED}, @code{UF_DATAVAULT}, @code{SF_SUPPORTED},
@code{SF_SETTABLE}, @code{SF_SYNTHETIC}, @code{SF_RESTRICTED}, @code{SF_FIRMLINK} and
@code{SF_DATALESS}. The values @code{UF_SETTABLE}, @code{SF_SUPPORTED},
@code{SF_SETTABLE} and @code{SF_SYNTHETIC} are only available on macOS.

@item 
gh-113536@footnote{https://github.com/python/cpython/issues/113536}: @ref{e1f,,os.waitid()} is now available on macOS

@item 
gh-110459@footnote{https://github.com/python/cpython/issues/110459}: Running @code{configure ... --with-openssl-rpath=X/Y/Z} no longer
fails to detect OpenSSL on macOS.

@item 
gh-74573@footnote{https://github.com/python/cpython/issues/74573}: Document that @ref{35,,dbm.ndbm} can silently corrupt DBM files on
updates when exceeding undocumented platform limits, and can crash
(segmentation fault) when reading such a corrupted file. (FB8919203)

@item 
gh-65701@footnote{https://github.com/python/cpython/issues/65701}: The @code{freeze} tool doesn’t work with framework builds of
Python. Document this and bail out early when running the tool with such a
build.

@item 
gh-87277@footnote{https://github.com/python/cpython/issues/87277}: webbrowser: Don’t look for X11 browsers on macOS. Those are
generally not used and probing for them can result in starting XQuartz
even if it isn’t used otherwise.

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: Update macOS installer to use SQLite 3.44.2.

@item 
gh-108269@footnote{https://github.com/python/cpython/issues/108269}: Set @code{CFBundleAllowMixedLocalizations} to true in the
Info.plist for the framework, embedded Python.app and IDLE.app with
framework installs on macOS.  This allows applications to pick up the
user’s preferred locale when that’s different from english.

@item 
gh-102362@footnote{https://github.com/python/cpython/issues/102362}: Make sure the result of @code{sysconfig.get_plaform()} includes
at least a major and minor versions, even if @code{MACOSX_DEPLOYMENT_TARGET}
is set to only a major version during build to match the format expected
by pip.

@item 
gh-110017@footnote{https://github.com/python/cpython/issues/110017}: Disable a signal handling stress test on macOS due to a bug in
macOS (FB13453490).

@item 
gh-110820@footnote{https://github.com/python/cpython/issues/110820}: Make sure the preprocessor definitions for
@code{ALIGNOF_MAX_ALIGN_T}, @code{SIZEOF_LONG_DOUBLE} and
@code{HAVE_GCC_ASM_FOR_X64} are correct for Universal 2 builds on macOS.

@item 
gh-109981@footnote{https://github.com/python/cpython/issues/109981}: Use @code{/dev/fd} on macOS to determine the number of open files
in @code{test.support.os_helper.fd_count} to avoid a crash with «guarded»
file descriptors when probing for open files.
@end itemize

@node IDLE<7>,C API<7>,macOS<5>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id57}@anchor{16c4}
@subsubsection IDLE



@itemize -

@item 
gh-72284@footnote{https://github.com/python/cpython/issues/72284}: Improve the lists of features, editor key bindings, and shell
key bingings in the IDLE doc.

@item 
gh-113903@footnote{https://github.com/python/cpython/issues/113903}: Fix rare failure of test.test_idle, in test_configdialog.

@item 
gh-113729@footnote{https://github.com/python/cpython/issues/113729}: Fix the «Help -> IDLE Doc» menu bug in 3.11.7 and 3.12.1.

@item 
gh-113269@footnote{https://github.com/python/cpython/issues/113269}: Fix test_editor hang on macOS Catalina.

@item 
gh-112898@footnote{https://github.com/python/cpython/issues/112898}: Fix processing unsaved files when quitting IDLE on macOS.

@item 
bpo-13586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13586}: Enter the selected text when opening the «Replace» dialog.
@end itemize

@node C API<7>,,IDLE<7>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id58}@anchor{16c5}
@subsubsection C API



@itemize -

@item 
gh-106560@footnote{https://github.com/python/cpython/issues/106560}: Fix redundant declarations in the public C API. Declare
PyBool_Type, PyLong_Type and PySys_Audit() only once. Patch by Victor
Stinner.

@item 
gh-112438@footnote{https://github.com/python/cpython/issues/112438}: Fix support of format units «es», «et», «es#», and «et#» in
nested tuples in @ref{615,,PyArg_ParseTuple()}-like functions.

@item 
gh-111545@footnote{https://github.com/python/cpython/issues/111545}: Add @ref{45c,,Py_HashPointer()} function to hash a pointer. Patch
by Victor Stinner.

@item 
gh-65210@footnote{https://github.com/python/cpython/issues/65210}: Change the declaration of the `keywords' parameter of
@ref{475,,PyArg_ParseTupleAndKeywords()} and
@ref{476,,PyArg_VaParseTupleAndKeywords()} for better compatibility with C++.
@end itemize

@node Python 3 13 0 alpha 2,Python 3 13 0 alpha 1,Python 3 13 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-2}@anchor{16c6}
@subsection Python 3.13.0 alpha 2


`Release date: 2023-11-22'

@menu
* Core and Builtins: Core and Builtins<8>. 
* Library: Library<8>. 
* Tests: Tests<7>. 
* Build: Build<8>. 
* Windows: Windows<8>. 
* macOS: macOS<6>. 
* IDLE: IDLE<8>. 
* Tools/Demos: Tools/Demos<5>. 
* C API: C API<8>. 

@end menu

@node Core and Builtins<8>,Library<8>,,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id59}@anchor{16c7}
@subsubsection Core and Builtins



@itemize -

@item 
gh-112243@footnote{https://github.com/python/cpython/issues/112243}: Don’t include comments in f-string debug expressions. Patch by
Pablo Galindo

@item 
gh-112287@footnote{https://github.com/python/cpython/issues/112287}: Slightly optimize the Tier 2 (uop) interpreter by only loading
@code{oparg} and @code{operand} when needed. Also double the trace size limit
again, to 512 this time.

@item 
gh-112266@footnote{https://github.com/python/cpython/issues/112266}: Change docstrings of @ref{5fe,,__dict__} and
@code{__weakref__}.

@item 
gh-111807@footnote{https://github.com/python/cpython/issues/111807}: Lower the max parser stack depth to 1000 under WASI debug
builds.

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: When Python is built in debug mode, set the C recursion limit
to 500 instead of 1500. A debug build is likely built with low
optimization level which implies higher stack memory usage than a release
build. Patch by Victor Stinner.

@item 
gh-106529@footnote{https://github.com/python/cpython/issues/106529}: Enable translating unspecialized @code{FOR_ITER} to Tier 2.

@item 
gh-111916@footnote{https://github.com/python/cpython/issues/111916}: Make hashlib related modules thread-safe without the GIL

@item 
gh-81137@footnote{https://github.com/python/cpython/issues/81137}: Deprecate assignment to a function’s @code{__code__} field when the
new code object is of a mismatched type (e.g., from a generator to a plain
function).

@item 
gh-79932@footnote{https://github.com/python/cpython/issues/79932}: Raise exception if @ref{3d5,,frame.clear()} is called on a suspended
frame.

@item 
gh-81925@footnote{https://github.com/python/cpython/issues/81925}: Implement native thread ids for GNU KFreeBSD.

@item 
gh-111843@footnote{https://github.com/python/cpython/issues/111843}: Use exponential backoff to reduce the number of failed tier 2
optimization attempts by over 99%.

@item 
gh-110829@footnote{https://github.com/python/cpython/issues/110829}: Joining a thread now ensures the underlying OS thread has
exited. This is required for safer fork() in multi-threaded processes.

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: Make sure that tier 2 traces are de-optimized if the code is
instrumented

@item 
gh-111772@footnote{https://github.com/python/cpython/issues/111772}: Specialize slot loads and stores for _Py_T_OBJECT as well as
Py_T_OBJECT_EX

@item 
gh-111666@footnote{https://github.com/python/cpython/issues/111666}: Speed up @ref{16c8,,BaseExceptionGroup.derive()},
@ref{16c9,,BaseExceptionGroup.subgroup()}, and @ref{16ca,,BaseExceptionGroup.split()}
by changing how they parse passed arguments.

@item 
gh-111654@footnote{https://github.com/python/cpython/issues/111654}: Fix runtime crash when some error happens in opcode
@code{LOAD_FROM_DICT_OR_DEREF}.

@item 
gh-111623@footnote{https://github.com/python/cpython/issues/111623}: Add support for sharing tuples between interpreters using the
cross-interpreter API.  Patch by Anthony Shaw.

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: The oparg of @ref{407,,YIELD_VALUE} is now @code{1} if the
instruction is part of a yield-from or await, and @code{0} otherwise.

The SUSPENDED frame state is now split into @code{SUSPENDED} and
@code{SUSPENDED_YIELD_FROM}. This simplifies the code in @code{_PyGen_yf}.

@item 
gh-111520@footnote{https://github.com/python/cpython/issues/111520}: Merge the Tier 1 (bytecode) and Tier 2 (micro-ops) interpreters
together, moving the Tier 2 interpreter loop and switch into
@code{_PyEval_EvalFrameDefault()} in @code{Python/ceval.c}. The
@code{Python/executor.c} file is gone. Also the @code{TIER_ONE} and @code{TIER_TWO}
macros are now handled by the code generator.

`Beware!' This changes the environment variables to enable micro-ops and
their debugging to @code{PYTHON_UOPS} and @code{PYTHON_LLTRACE}.

@item 
gh-109181@footnote{https://github.com/python/cpython/issues/109181}: Speed up @code{Traceback} object creation by lazily compute
the line number. Patch by Pablo Galindo

@item 
gh-111420@footnote{https://github.com/python/cpython/issues/111420}: Allow type comments in parenthesized @code{with} statements

@item 
gh-111438@footnote{https://github.com/python/cpython/issues/111438}: Add support for sharing floats between interpreters using the
cross-interpreter API.  Patch by Anthony Shaw.

@item 
gh-111435@footnote{https://github.com/python/cpython/issues/111435}: Add support for sharing of @code{True} and @code{False} between
interpreters using the cross-interpreter API.  Patch by Anthony Shaw.

@item 
gh-102388@footnote{https://github.com/python/cpython/issues/102388}: Fix a bug where @code{iso2022_jp_3} and @code{iso2022_jp_2004} codecs
read out of bounds

@item 
gh-111366@footnote{https://github.com/python/cpython/issues/111366}: Fix an issue in the @ref{1d,,codeop} that was causing
@ref{150,,SyntaxError} exceptions raised in the presence of invalid syntax to
not contain precise error messages. Patch by Pablo Galindo

@item 
gh-111380@footnote{https://github.com/python/cpython/issues/111380}: Fix a bug that was causing @ref{511,,SyntaxWarning} to appear twice
when parsing if invalid syntax is encountered later. Patch by Pablo
galindo

@item 
gh-111374@footnote{https://github.com/python/cpython/issues/111374}: Added a new environment variable
@geindex PYTHON_FROZEN_MODULES
@geindex variables de entorno; PYTHON_FROZEN_MODULES
@ref{2f7,,PYTHON_FROZEN_MODULES}. It determines whether or not frozen
modules are ignored by the import machinery, equivalent of the @ref{2e2,,-X frozen_modules} command-line option.

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: Remove @code{oparg} from @ref{407,,YIELD_VALUE}. Change @code{oparg}
of @ref{408,,RESUME} to include information about the except-depth. These
changes make it possible to simplify the code in generator close.

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: Fix a regression that prevented jumping across @code{is None} and
@code{is not None} when debugging. Patch by Savannah Ostrowski.

@item 
gh-67224@footnote{https://github.com/python/cpython/issues/67224}: Show source lines in tracebacks when using the @code{-c} option
when running Python. Patch by Pablo Galindo

@item 
gh-111123@footnote{https://github.com/python/cpython/issues/111123}: Fix a bug where a @ref{2f5,,global} declaration in an
@ref{2f6,,except} block is rejected when the global is used in the
@ref{1ea,,else} block.

@item 
gh-110938@footnote{https://github.com/python/cpython/issues/110938}: Fix error messages for indented blocks with functions and
classes with generic type parameters. Patch by Pablo Galindo

@item 
gh-109214@footnote{https://github.com/python/cpython/issues/109214}: Remove unnecessary instruction pointer updates before returning
from frames.

@item 
gh-110912@footnote{https://github.com/python/cpython/issues/110912}: Correctly display the traceback for @ref{16cb,,MemoryError}
exceptions using the @ref{fe,,traceback} module. Patch by Pablo Galindo

@item 
gh-109894@footnote{https://github.com/python/cpython/issues/109894}: Fixed crash due to improperly initialized static
@ref{16cb,,MemoryError} in subinterpreter.

@item 
gh-110892@footnote{https://github.com/python/cpython/issues/110892}: Return @code{NULL} for @code{PyTrace_RETURN} events caused by an
exception

@item 
gh-110864@footnote{https://github.com/python/cpython/issues/110864}: Fix argument parsing by @code{_PyArg_UnpackKeywordsWithVararg} for
functions defining pos-or-keyword, vararg, and kw-only parameters.

@item 
gh-109094@footnote{https://github.com/python/cpython/issues/109094}: Replace @code{prev_instr} on the interpreter frame by
@code{instr_ptr} which points to the beginning of the instruction that is
currently executing (or will execute once the frame resumes).

@item 
gh-110805@footnote{https://github.com/python/cpython/issues/110805}: Allow the repl to show source code and complete tracebacks.
Patch by Pablo Galindo

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: Add 
@geindex PYTHON_PRESITE=package.module
@geindex variables de entorno; PYTHON_PRESITE=package.module
@code{PYTHON_PRESITE=package.module} to import a module
early in the interpreter lifecycle before @code{site.py} is executed.  Python
needs to be @ref{357,,built in debug mode} for this option to
exist.

@item 
gh-110481@footnote{https://github.com/python/cpython/issues/110481}: Implement biased reference counting in @code{--disable-gil}
builds.

@item 
gh-110543@footnote{https://github.com/python/cpython/issues/110543}: Fix regression in Python 3.12 where
@code{types.CodeType.replace()} would produce a broken code object if
called on a module or class code object that contains a comprehension.
Patch by Jelle Zijlstra.

@item 
gh-89519@footnote{https://github.com/python/cpython/issues/89519}: Removed chained @ref{2d2,,classmethod} descriptors (introduced in
bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}).  This can no longer be used to wrap other descriptors
such as @ref{2fd,,property}.  The core design of this feature was flawed and
caused a number of downstream problems.  To «pass-through» a
@ref{2d2,,classmethod}, consider using the @code{__wrapped__} attribute
that was added in Python 3.10.

@item 
gh-103615@footnote{https://github.com/python/cpython/issues/103615}: Use local events for opcode tracing

@item 
bpo-46657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46657}: Add mimalloc memory allocator support.

@item 
gh-106718@footnote{https://github.com/python/cpython/issues/106718}: When PyConfig.stdlib_dir is explicitly set, it’s now respected
and won’t be overridden by PyConfig.home.

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: Fix incorrect SystemError about AST constructor recursion depth
mismatch.

@item 
gh-100445@footnote{https://github.com/python/cpython/issues/100445}: Improve error message for unterminated strings with escapes.

@item 
bpo-45759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45759}: Improved error messages for @code{elif}/@code{else} statements not
matching any valid statements. Patch by Jeremiah Vivian.
@end itemize

@node Library<8>,Tests<7>,Core and Builtins<8>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id60}@anchor{16cc}
@subsubsection Library



@itemize -

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: Fix SystemError in the TextIOWrapper constructor with
non-encodable «errors» argument in non-debug mode.

@item 
gh-111995@footnote{https://github.com/python/cpython/issues/111995}: Added the @code{NI_IDN} constant to the @ref{cc,,socket} module when
present in C at build time for use with @ref{16cd,,socket.getnameinfo()}.

@item 
gh-109538@footnote{https://github.com/python/cpython/issues/109538}: Issue warning message instead of having @ref{1e5,,RuntimeError}
be displayed when event loop has already been closed at
@code{StreamWriter.__del__()}.

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: Fix crashes in @ref{bd1,,io.TextIOWrapper.reconfigure()} when pass
invalid arguments, e.g. non-string encoding.

@item 
gh-111460@footnote{https://github.com/python/cpython/issues/111460}: @ref{2c,,curses}: restore wide character support (including
@ref{1114,,curses.unget_wch()} and @ref{1113,,get_wch()}) on macOS,
which was unavailable due to a regression in Python 3.12.

@item 
gh-103791@footnote{https://github.com/python/cpython/issues/103791}: @ref{fa8,,contextlib.suppress} now supports suppressing
exceptions raised as part of a @ref{3b6,,BaseExceptionGroup}, in addition to
the recent support for @ref{31d,,ExceptionGroup}.

@item 
gh-111835@footnote{https://github.com/python/cpython/issues/111835}: The @ref{368,,mmap.mmap} class now has an
@ref{369,,seekable()} method that can be used when a seekable
file-like object is required. The @ref{36a,,seek()} method now
returns the new absolute position. Patch by Donghee Na.

@item 
gh-111804@footnote{https://github.com/python/cpython/issues/111804}: Remove posix.fallocate() under WASI as the underlying
posix_fallocate() is not available in WASI preview2.

@item 
gh-111841@footnote{https://github.com/python/cpython/issues/111841}: Fix truncating arguments on an embedded null character in
@ref{198,,os.putenv()} and @ref{199,,os.unsetenv()} on Windows.

@item 
gh-111768@footnote{https://github.com/python/cpython/issues/111768}: @ref{16ce,,wsgiref.util.is_hop_by_hop()} is now exposed correctly in
@code{__all__}.

@item 
gh-80731@footnote{https://github.com/python/cpython/issues/80731}: Avoid executing the default function in @ref{16cf,,cmd.Cmd} in an
except block

@item 
gh-111541@footnote{https://github.com/python/cpython/issues/111541}: Fix @ref{3b,,doctest} for @ref{150,,SyntaxError} not-builtin
subclasses.

@item 
gh-111719@footnote{https://github.com/python/cpython/issues/111719}: Add extra argument validation for @code{alias} command in
@ref{a5,,pdb}

@item 
gh-111482@footnote{https://github.com/python/cpython/issues/111482}: @ref{ee,,time}: Make @ref{11cf,,time.clock_gettime()} and
@ref{b6d,,time.clock_gettime_ns()} functions up to 2x faster by faster calling
convention. Patch by Victor Stinner.

@item 
gh-110894@footnote{https://github.com/python/cpython/issues/110894}: Call loop exception handler for exceptions in
@code{client_connected_cb} of @ref{ba4,,asyncio.start_server()} so that
applications can handle it. Patch by Kumar Aditya.

@item 
gh-111531@footnote{https://github.com/python/cpython/issues/111531}: Fix reference leaks in @code{bind_class()} and @code{bind_all()}
methods of @ref{f0,,tkinter} widgets.

@item 
gh-111246@footnote{https://github.com/python/cpython/issues/111246}: @ref{315,,asyncio.loop.create_unix_server()} will now automatically
remove the Unix socket when the server is closed.

@item 
gh-111356@footnote{https://github.com/python/cpython/issues/111356}: Added @ref{16d0,,io.text_encoding()}, @ref{16d1,,io.DEFAULT_BUFFER_SIZE},
and @ref{16d2,,io.IncrementalNewlineDecoder} to @code{io.__all__}.

@item 
gh-66425@footnote{https://github.com/python/cpython/issues/66425}: Remove the code to set the REMOTE_HOST header from wsgiref
module, as it is unreachable. This header is used for performance reasons,
which is not necessary in the wsgiref module.

@item 
gh-111429@footnote{https://github.com/python/cpython/issues/111429}: Speed up @ref{21d,,pathlib.PurePath.relative_to()} and
@ref{21e,,is_relative_to()}.

@item 
gh-111342@footnote{https://github.com/python/cpython/issues/111342}: Fixed typo in @ref{540,,math.sumprod()}.

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: Remove mention of not supported «vsapi» element type in
@ref{3af,,tkinter.ttk.Style.element_create()}. Add tests for
@code{element_create()} and other @code{ttk.Style} methods. Add examples for
@code{element_create()} in the documentation.

@item 
gh-111388@footnote{https://github.com/python/cpython/issues/111388}: Add @code{show_group} parameter to
@ref{8e5,,traceback.format_exception_only()}, which allows to format
@ref{31d,,ExceptionGroup} instances.

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: Another attempt at fixing @ref{16d3,,asyncio.Server.wait_closed()}. It
now blocks until both conditions are true: the server is closed, `and'
there are no more active connections. (This means that in some cases where
in 3.12.0 this function would `incorrectly' have returned immediately, it
will now block; in particular, when there are no active connections but
the server hasn’t been closed yet.)

@item 
gh-111259@footnote{https://github.com/python/cpython/issues/111259}: Optimize recursive wildcards in @ref{a4,,pathlib}.

@item 
gh-111295@footnote{https://github.com/python/cpython/issues/111295}: Fix @ref{ee,,time} not checking for errors when initializing.

@item 
gh-111253@footnote{https://github.com/python/cpython/issues/111253}: Add error checking during @code{_socket} module init.

@item 
gh-111251@footnote{https://github.com/python/cpython/issues/111251}: Fix @code{_blake2} not checking for errors when initializing.

@item 
gh-111233@footnote{https://github.com/python/cpython/issues/111233}: Fix @ref{c1,,select} not checking for errors when initializing.

@item 
gh-111230@footnote{https://github.com/python/cpython/issues/111230}: Fix @ref{d0,,ssl} not checking for errors when initializing.

@item 
gh-111174@footnote{https://github.com/python/cpython/issues/111174}: Fix crash in @ref{125e,,io.BytesIO.getbuffer()} called repeatedly for
empty BytesIO.

@item 
gh-111187@footnote{https://github.com/python/cpython/issues/111187}: Postpone removal version for locale.getdefaultlocale() to
Python 3.15.

@item 
gh-111159@footnote{https://github.com/python/cpython/issues/111159}: Fix @ref{3b,,doctest} output comparison for exceptions with notes.

@item 
gh-110910@footnote{https://github.com/python/cpython/issues/110910}: Fix invalid state handling in @ref{31c,,asyncio.TaskGroup} and
@ref{16d4,,asyncio.Timeout}. They now raise proper RuntimeError if they are
improperly used and are left in consistent state after this.

@item 
gh-111092@footnote{https://github.com/python/cpython/issues/111092}: Make turtledemo run without default root enabled.

@item 
gh-110944@footnote{https://github.com/python/cpython/issues/110944}: Support alias and convenience vars for @ref{a5,,pdb} completion

@item 
gh-110745@footnote{https://github.com/python/cpython/issues/110745}: Added `newline' parameter to @ref{eca,,pathlib.Path.read_text()}.
Patch by Junya Okabe.

@item 
gh-84583@footnote{https://github.com/python/cpython/issues/84583}: Make @ref{a5,,pdb} enter post-mortem mode even for
@ref{150,,SyntaxError}

@item 
gh-80675@footnote{https://github.com/python/cpython/issues/80675}: Set @code{f_trace_lines = True} on all frames upon
@ref{1a7,,pdb.set_trace()}

@item 
gh-110771@footnote{https://github.com/python/cpython/issues/110771}: Expose the setup and cleanup portions of
@code{asyncio.run_forever()} as the standalone methods
@code{asyncio.run_forever_setup()} and @code{asyncio.run_forever_cleanup()}.
This allows for tighter integration with GUI event loops.

@item 
gh-110774@footnote{https://github.com/python/cpython/issues/110774}: Support setting the @ref{6a1,,asyncio.Runner} loop_factory kwarg
in @ref{206,,unittest.IsolatedAsyncioTestCase}

@item 
gh-110392@footnote{https://github.com/python/cpython/issues/110392}: Fix @ref{16d5,,tty.setraw()} and @ref{1683,,tty.setcbreak()}: previously
they returned partially modified list of the original tty attributes.
@ref{16d6,,tty.cfmakeraw()} and @ref{1684,,tty.cfmakecbreak()} now make a copy of the
list of special characters before modifying it.

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: Make line number of function breakpoint more precise in
@ref{a5,,pdb}

@item 
gh-88434@footnote{https://github.com/python/cpython/issues/88434}: Emit deprecation warning for non-integer numbers in
@ref{63,,gettext} functions and methods that consider plural forms even if
the translation was not found.

@item 
gh-110395@footnote{https://github.com/python/cpython/issues/110395}: Ensure that @ref{16d7,,select.kqueue()} objects correctly appear as
closed in forked children, to prevent operations on an invalid file
descriptor.

@item 
gh-110196@footnote{https://github.com/python/cpython/issues/110196}: Add @code{__reduce__} method to @code{IPv6Address} in order to
keep @code{scope_id}

@item 
gh-109747@footnote{https://github.com/python/cpython/issues/109747}: Improve errors for unsupported look-behind patterns. Now
re.error is raised instead of OverflowError or RuntimeError for too large
width of look-behind pattern.

@item 
gh-109466@footnote{https://github.com/python/cpython/issues/109466}: Add the @ref{359,,ipaddress.IPv4Address.ipv6_mapped} property,
which returns the IPv4-mapped IPv6 address.

@item 
gh-85098@footnote{https://github.com/python/cpython/issues/85098}: Implement the CLI of the @ref{d8,,symtable} module and improve the
repr of @ref{1b0,,Symbol}.

@item 
gh-108791@footnote{https://github.com/python/cpython/issues/108791}: Improved error handling in @ref{a5,,pdb} command line interface,
making it produce more concise error messages.

@item 
gh-105931@footnote{https://github.com/python/cpython/issues/105931}: Change @ref{21,,compileall} to only strip the stripdir prefix from
the full path recorded in the compiled @code{.pyc} file, when the prefix
matches the start of the full path in its entirety. When the prefix does
not match, no stripping is performed and a warning to this effect is
displayed.

Previously all path components of the stripdir prefix that matched the
full path were removed, while those that did not match were left alone
(including ones interspersed between matching components).

@item 
gh-107431@footnote{https://github.com/python/cpython/issues/107431}: Make the @code{DictProxy} and @code{ListProxy} types in
@ref{97,,multiprocessing.managers} @ref{753,,Generic Alias Types} for @code{[]} use in typing contexts.

@item 
gh-72904@footnote{https://github.com/python/cpython/issues/72904}: Add @ref{349,,glob.translate()}. This function converts a pathname
with shell-style wildcards to a regular expression.

@item 
gh-90026@footnote{https://github.com/python/cpython/issues/90026}: Define @code{USE_XATTRS} on Cygwin so that XATTR-related functions
in the @ref{a1,,os} module become available.

@item 
gh-90890@footnote{https://github.com/python/cpython/issues/90890}: New methods @ref{16d8,,mailbox.Maildir.get_info()},
@ref{16d9,,mailbox.Maildir.set_info()}, @ref{16da,,mailbox.Maildir.get_flags()},
@ref{16db,,mailbox.Maildir.set_flags()}, @ref{16dc,,mailbox.Maildir.add_flag()},
@ref{16dd,,mailbox.Maildir.remove_flag()}. These methods speed up accessing a
message’s info and/or flags and are useful when it is not necessary to
access the message’s contents, as when iterating over a Maildir to find
messages with specific flags.

@item 
gh-102956@footnote{https://github.com/python/cpython/issues/102956}: Fix returning of empty byte strings after seek in zipfile
module

@item 
gh-102895@footnote{https://github.com/python/cpython/issues/102895}: Added a parameter @code{local_exit} for @ref{16de,,code.interact()} to
prevent @code{exit()} and @code{quit} from closing @code{sys.stdin} and raise
@code{SystemExit}.

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: Change the behavior of @code{tkinter.Text.count()}. It now always
returns an integer if one or less counting options are specified.
Previously it could return a single count as a 1-tuple, an integer (only
if option @code{"update"} was specified) or @code{None} if no items found. The
result is now the same if @code{wantobjects} is set to @code{0}.

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: Switch the storage of the unicode codepoint names to use a
different data-structure, a directed acyclic word graph@footnote{https://en.wikipedia.org/wiki/Deterministic_acyclic_finite_state_automaton}.
This makes the unicodedata shared library about 440 KiB smaller.
Contributed by Carl Friedrich Bolz-Tereick using code from the PyPy
project.

@item 
gh-73561@footnote{https://github.com/python/cpython/issues/73561}: Omit the interface scope from an IPv6 address when used as Host
header by @ref{6f,,http.client}.

@item 
gh-86826@footnote{https://github.com/python/cpython/issues/86826}: @code{zipinfo} now supports the full range of values in the TZ
string determined by RFC 8536 and detects all invalid formats. Both Python
and C implementations now raise exceptions of the same type on invalid
data.
@end itemize

@node Tests<7>,Build<8>,Library<8>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id61}@anchor{16df}
@subsubsection Tests



@itemize -

@item 
gh-111808@footnote{https://github.com/python/cpython/issues/111808}: Make the default value of @code{test.support.infinite_recursion()}
to be conditional based on whether optimizations were used when compiling
the interpreter. This helps with platforms like WASI whose stack size is
greatly restricted in debug builds.

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: Gathering line coverage of standard libraries within the
regression test suite is now precise, as well as much faster. Patch by
Łukasz Langa.

@item 
gh-110367@footnote{https://github.com/python/cpython/issues/110367}: Make regrtest @code{--verbose3} option compatible with
@code{--huntrleaks -jN} options. The @code{./python -m test -j1 -R 3:3
--verbose3} command now works as expected. Patch by Victor Stinner.

@item 
gh-111165@footnote{https://github.com/python/cpython/issues/111165}: Remove no longer used functions @code{run_unittest()} and
@code{run_doctest()} from the @ref{e4,,test.support} module.

@item 
gh-110932@footnote{https://github.com/python/cpython/issues/110932}: Fix regrtest if the @code{SOURCE_DATE_EPOCH} environment variable
is defined: use the variable value as the random seed. Patch by Victor
Stinner.

@item 
gh-110995@footnote{https://github.com/python/cpython/issues/110995}: test_gdb: Fix detection of gdb built without Python scripting
support. Patch by Victor Stinner.

@item 
gh-110918@footnote{https://github.com/python/cpython/issues/110918}: Test case matching patterns specified by options @code{--match},
@code{--ignore}, @code{--matchfile} and @code{--ignorefile} are now tested in the
order of specification, and the last match determines whether the test
case be run or ignored.

@item 
gh-108747@footnote{https://github.com/python/cpython/issues/108747}: Add unit test for @code{usercustomize} and @code{sitecustomize} hooks
from @ref{c7,,site}.
@end itemize

@node Build<8>,Windows<8>,Tests<7>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id62}@anchor{16e0}
@subsubsection Build



@itemize -

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: Make @code{make regen-unicodedata} work for out-of-tree builds of
CPython.

@item 
gh-112088@footnote{https://github.com/python/cpython/issues/112088}: Add @code{Tools/build/regen-configure.sh} script to regenerate the
@code{configure} with an Ubuntu container image. The
@code{quay.io/tiran/cpython_autoconf:271} container image
(tiran/cpython_autoconf@footnote{https://github.com/tiran/cpython_autoconf}) is
no longer used. Patch by Victor Stinner.

@item 
gh-111046@footnote{https://github.com/python/cpython/issues/111046}: For wasi-threads, memory is now exported to fix compatibility
issues with some wasm runtimes.

@item 
gh-110828@footnote{https://github.com/python/cpython/issues/110828}: AIX 32bit needs @code{-latomic} to build the @code{_testcapi}
extension module.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: The @code{errno}, @code{md5}, @code{resource}, @code{winsound},
@code{_ctypes_test}, @code{_multiprocessing.posixshmem}, @code{_scproxy},
@code{_stat}, @code{_testimportmultiple} and @code{_uuid} C extensions are now
built with the @ref{488,,limited C API}. Patch by Victor
Stinner.
@end itemize

@node Windows<8>,macOS<6>,Build<8>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id63}@anchor{16e1}
@subsubsection Windows



@itemize -

@item 
gh-111856@footnote{https://github.com/python/cpython/issues/111856}: Fixes @ref{e12,,fstat()} on file systems that do not support
file ID requests. This includes FAT32 and exFAT.

@item 
gh-111293@footnote{https://github.com/python/cpython/issues/111293}: Fix @ref{16e2,,os.DirEntry.inode} dropping higher 64 bits of a file
id on some filesystems on Windows.

@item 
gh-110913@footnote{https://github.com/python/cpython/issues/110913}: WindowsConsoleIO now correctly chunks large buffers without
splitting up UTF-8 sequences.
@end itemize

@node macOS<6>,IDLE<8>,Windows<8>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id64}@anchor{16e3}
@subsubsection macOS



@itemize -

@item 
gh-59703@footnote{https://github.com/python/cpython/issues/59703}: For macOS framework builds, in @code{getpath.c} use the system
@code{dladdr} function to find the path to the shared library rather than
depending on deprecated macOS APIs.

@item 
gh-110950@footnote{https://github.com/python/cpython/issues/110950}: Update macOS installer to include an upstream Tcl/Tk fix for
the @code{Secure coding is not enabled for restorable state!} warning
encountered in Tkinter on macOS 14 Sonoma.

@item 
gh-111015@footnote{https://github.com/python/cpython/issues/111015}: Ensure that IDLE.app and Python Launcher.app are installed with
appropriate permissions on macOS builds.

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: Update macOS installer to include an upstream Tcl/Tk fix for the
@code{ttk::ThemeChanged} error encountered in Tkinter.

@item 
gh-92603@footnote{https://github.com/python/cpython/issues/92603}: Update macOS installer to include a fix accepted by upstream
Tcl/Tk for a crash encountered after the first @ref{1642,,tkinter.Tk()} instance
is destroyed.
@end itemize

@node IDLE<8>,Tools/Demos<5>,macOS<6>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id65}@anchor{16e4}
@subsubsection IDLE



@itemize -

@item 
bpo-35668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35668}: Add docstrings to the IDLE debugger module. Fix two bugs:
initialize @code{Idb.botframe} (should be in Bdb); in @code{Idb.in_rpc_code},
check whether @code{prev_frame} is @code{None} before trying to use it. Greatly
expand test_debugger.
@end itemize

@node Tools/Demos<5>,C API<8>,IDLE<8>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id66}@anchor{16e5}
@subsubsection Tools/Demos



@itemize -

@item 
gh-111903@footnote{https://github.com/python/cpython/issues/111903}: Argument Clinic now supports the @code{@@critical_section}
directive that instructs Argument Clinic to generate a critical section
around the function call, which locks the @code{self} object in
@code{--disable-gil} builds. Patch by Sam Gross.
@end itemize

@node C API<8>,,Tools/Demos<5>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id67}@anchor{16e6}
@subsubsection C API



@itemize -

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Add again the private @code{_PyThreadState_UncheckedGet()}
function as an alias to the new public
@ref{465,,PyThreadState_GetUnchecked()} function. Patch by Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Restore the removed @code{_PyDict_GetItemStringWithError()}
function. It is used by numpy. Patch by Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Restore removed private C API functions, macros and structures
which have no simple replacement for now:


@itemize *

@item 
_PyDict_GetItem_KnownHash()

@item 
_PyDict_NewPresized()

@item 
_PyHASH_BITS

@item 
_PyHASH_IMAG

@item 
_PyHASH_INF

@item 
_PyHASH_MODULUS

@item 
_PyHASH_MULTIPLIER

@item 
_PyLong_Copy()

@item 
_PyLong_FromDigits()

@item 
_PyLong_New()

@item 
_PyLong_Sign()

@item 
_PyObject_CallMethodId()

@item 
_PyObject_CallMethodNoArgs()

@item 
_PyObject_CallMethodOneArg()

@item 
_PyObject_CallOneArg()

@item 
_PyObject_EXTRA_INIT

@item 
_PyObject_FastCallDict()

@item 
_PyObject_GetAttrId()

@item 
_PyObject_Vectorcall()

@item 
_PyObject_VectorcallMethod()

@item 
_PyStack_AsDict()

@item 
_PyThread_CurrentFrames()

@item 
_PyUnicodeWriter structure

@item 
_PyUnicodeWriter_Dealloc()

@item 
_PyUnicodeWriter_Finish()

@item 
_PyUnicodeWriter_Init()

@item 
_PyUnicodeWriter_Prepare()

@item 
_PyUnicodeWriter_PrepareKind()

@item 
_PyUnicodeWriter_WriteASCIIString()

@item 
_PyUnicodeWriter_WriteChar()

@item 
_PyUnicodeWriter_WriteLatin1String()

@item 
_PyUnicodeWriter_WriteStr()

@item 
_PyUnicodeWriter_WriteSubstring()

@item 
_PyUnicode_AsString()

@item 
_PyUnicode_FromId()

@item 
_PyVectorcall_Function()

@item 
_Py_IDENTIFIER()

@item 
_Py_c_abs()

@item 
_Py_c_diff()

@item 
_Py_c_neg()

@item 
_Py_c_pow()

@item 
_Py_c_prod()

@item 
_Py_c_quot()

@item 
_Py_c_sum()

@item 
_Py_static_string()

@item 
_Py_static_string_init()
@end itemize

Patch by Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Add again @code{<ctype.h>} and @code{<unistd.h>} includes in
@code{Python.h}, but don’t include them in the limited C API version 3.13 and
newer. Patch by Victor Stinner.

@item 
gh-111956@footnote{https://github.com/python/cpython/issues/111956}: Add internal-only one-time initialization API: @code{_PyOnceFlag}
and @code{_PyOnceFlag_CallOnce}.

@item 
gh-111262@footnote{https://github.com/python/cpython/issues/111262}: Add @ref{435,,PyDict_Pop()} and @ref{436,,PyDict_PopString()}
functions: remove a key from a dictionary and optionally return the
removed value. This is similar to @ref{437,,dict.pop()}, but without the
default value and not raising @ref{438,,KeyError} if the key missing. Patch by
Stefan Behnel and Victor Stinner.

@item 
gh-111863@footnote{https://github.com/python/cpython/issues/111863}: Rename @code{Py_NOGIL} to @code{Py_GIL_DISABLED}. Patch by Hugo van
Kemenade.

@item 
gh-111138@footnote{https://github.com/python/cpython/issues/111138}: Add @ref{451,,PyList_Extend()} and @ref{452,,PyList_Clear()}
functions: similar to Python @code{list.extend()} and @code{list.clear()}
methods. Patch by Victor Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: On Windows, @code{Python.h} no longer includes the @code{<stddef.h>}
standard header file. If needed, it should now be included explicitly.
Patch by Victor Stinner.

@item 
gh-111569@footnote{https://github.com/python/cpython/issues/111569}: Implement «Python Critical Sections» from 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}. These are
macros to help replace the GIL with per-object locks in the
@code{--disable-gil} build of CPython. The macros are no-ops in the default
build.

@item 
gh-111506@footnote{https://github.com/python/cpython/issues/111506}: In the limited C API version 3.13, @ref{942,,Py_SET_REFCNT()}
function is now implemented as an opaque function call. Patch by Victor
Stinner.

@item 
gh-108082@footnote{https://github.com/python/cpython/issues/108082}: Add @ref{442,,PyErr_FormatUnraisable()} function.

@item 
gh-110964@footnote{https://github.com/python/cpython/issues/110964}: Move the undocumented private _PyArg functions and
_PyArg_Parser structure to internal C API (@code{pycore_modsupport.h}). Patch
by Victor Stinner.

@item 
gh-110815@footnote{https://github.com/python/cpython/issues/110815}: Support non-ASCII keyword names in
@ref{475,,PyArg_ParseTupleAndKeywords()}.

@item 
gh-109587@footnote{https://github.com/python/cpython/issues/109587}: Introduced @code{PyUnstable_PerfTrampoline_CompileCode()},
@code{PyUnstable_PerfTrampoline_SetPersistAfterFork()} and
@code{PyUnstable_CopyPerfMapFile()}. These functions allow extension
modules to initialize trampolines eagerly, after the application is
«warmed up». This makes it possible to have perf-trampolines running in an
always-enabled fashion.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Add the @ref{463,,PySys_Audit()} function to the limited C API.
Patch by Victor Stinner.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Add @ref{482,,PyMem_RawMalloc()}, @ref{483,,PyMem_RawCalloc()},
@ref{484,,PyMem_RawRealloc()} and @ref{485,,PyMem_RawFree()} to the limited C
API. Patch by Victor Stinner.

@item 
gh-106672@footnote{https://github.com/python/cpython/issues/106672}: Functions @ref{479,,PyDict_GetItem()},
@ref{47a,,PyDict_GetItemString()}, @ref{471,,PyMapping_HasKey()},
@ref{473,,PyMapping_HasKeyString()}, @ref{46d,,PyObject_HasAttr()},
@ref{46f,,PyObject_HasAttrString()}, and @ref{47b,,PySys_GetObject()}, which
clear all errors occurred during calling the function, report now them
using @ref{355,,sys.unraisablehook()}.

@item 
gh-67565@footnote{https://github.com/python/cpython/issues/67565}: Remove redundant C-contiguity check in @code{getargs.c},
@ref{11,,binascii}, @ref{d0,,ssl} and Argument Clinic. Patched by Stefan Krah
and Furkan Onder
@end itemize

@node Python 3 13 0 alpha 1,Python 3 12 0 beta 1,Python 3 13 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-13-0-alpha-1}@anchor{16e7}
@subsection Python 3.13.0 alpha 1


`Release date: 2023-10-13'

@menu
* Security: Security<7>. 
* Core and Builtins: Core and Builtins<9>. 
* Library: Library<9>. 
* Documentation: Documentation<8>. 
* Tests: Tests<8>. 
* Build: Build<9>. 
* Windows: Windows<9>. 
* macOS: macOS<7>. 
* IDLE: IDLE<9>. 
* Tools/Demos: Tools/Demos<6>. 
* C API: C API<9>. 

@end menu

@node Security<7>,Core and Builtins<9>,,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id68}@anchor{16e8}
@subsubsection Security



@itemize -

@item 
gh-108310@footnote{https://github.com/python/cpython/issues/108310}: Fixed an issue where instances of @ref{981,,ssl.SSLSocket} were
vulnerable to a bypass of the TLS handshake and included protections (like
certificate verification) and treating sent unencrypted data as if it were
post-handshake TLS encrypted data.  Security issue reported as
@geindex Common Vulnerabilities and Exposures; CVE 2023-40217
CVE 2023-40217@footnote{https://www.cve.org/CVERecord?id=CVE-2023-40217} by Aapo Oksman. Patch by Gregory P. Smith.

@item 
gh-107774@footnote{https://github.com/python/cpython/issues/107774}: PEP 669 specifies that @code{sys.monitoring.register_callback}
will generate an audit event. Pre-releases of Python 3.12 did not generate
the audit event. This is now fixed.

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: Reverted the @ref{51,,email.utils} security improvement change
released in 3.12beta4 that unintentionally caused
@ref{344,,email.utils.getaddresses} to fail to parse email addresses with a
comma in the quoted name field. See gh-106669@footnote{https://github.com/python/cpython/issues/106669}.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Refresh our new HACL* built-in @ref{68,,hashlib} code from
upstream. Built-in SHA2 should be faster and an issue with SHA3 on 32-bit
platforms is fixed.

@item 
gh-102509@footnote{https://github.com/python/cpython/issues/102509}: Start initializing @code{ob_digit} during creation of
@ref{24b,,PyLongObject} objects. Patch by Illia Volochii.
@end itemize

@node Core and Builtins<9>,Library<9>,Security<7>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id69}@anchor{16e9}
@subsubsection Core and Builtins



@itemize -

@item 
gh-110782@footnote{https://github.com/python/cpython/issues/110782}: Fix crash when @ref{2c9,,typing.TypeVar} is constructed with a
keyword argument. Patch by Jelle Zijlstra.

@item 
gh-110752@footnote{https://github.com/python/cpython/issues/110752}: Reset @code{ceval.eval_breaker} in @code{interpreter_clear()}

@item 
gh-110721@footnote{https://github.com/python/cpython/issues/110721}: Use the @ref{fe,,traceback} implementation for the default
@code{PyErr_Display()} functionality. Patch by Pablo Galindo

@item 
gh-110696@footnote{https://github.com/python/cpython/issues/110696}: Fix incorrect error message for invalid argument unpacking.
Patch by Pablo Galindo

@item 
gh-104169@footnote{https://github.com/python/cpython/issues/104169}: Split the tokenizer into two separate directories: - One part
includes the actual lexeme producing logic and lives in @code{Parser/lexer}.
- The second part wraps the lexer according to the different tokenization
modes   we have (string, utf-8, file, interactive, readline) and lives in
@code{Parser/tokenizer}.

@item 
gh-110688@footnote{https://github.com/python/cpython/issues/110688}: Remove undocumented @code{test_c_api} method from @ref{67a,,set},
which was only defined for testing purposes under @code{Py_DEBUG}. Now we
have proper CAPI tests.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Fix a reference leak when running with 
@geindex PYTHONUOPS
@geindex variables de entorno; PYTHONUOPS
@code{PYTHONUOPS} or
@ref{2e2,,-X uops} enabled.

@item 
gh-110514@footnote{https://github.com/python/cpython/issues/110514}: Add @code{PY_THROW} to @ref{153f,,sys.setprofile()} events

@item 
gh-110489@footnote{https://github.com/python/cpython/issues/110489}: Optimise @ref{1402,,math.ceil()} when the input is exactly a float,
resulting in about a 10% improvement.

@item 
gh-110455@footnote{https://github.com/python/cpython/issues/110455}: Guard @code{assert(tstate->thread_id > 0)} with @code{#ifndef
HAVE_PTHREAD_STUBS}. This allows for for pydebug builds to work under
WASI which (currently) lacks thread support.

@item 
gh-110309@footnote{https://github.com/python/cpython/issues/110309}: Remove unnecessary empty constant nodes in the ast of f-string
specs.

@item 
gh-110259@footnote{https://github.com/python/cpython/issues/110259}: Correctly identify the format spec in f-strings (with single or
triple quotes) that have multiple lines in the expression part and include
a formatting spec. Patch by Pablo Galindo

@item 
gh-110237@footnote{https://github.com/python/cpython/issues/110237}: Fix missing error checks for calls to @code{PyList_Append} in
@code{_PyEval_MatchClass}.

@item 
gh-110164@footnote{https://github.com/python/cpython/issues/110164}: regrtest: If the @code{SOURCE_DATE_EPOCH} environment variable is
defined, regrtest now disables tests randomization. Patch by Victor
Stinner.

@item 
gh-109889@footnote{https://github.com/python/cpython/issues/109889}: Fix the compiler’s redundant NOP detection algorithm to skip
over NOPs with no line number when looking for the next instruction’s
lineno.

@item 
gh-109853@footnote{https://github.com/python/cpython/issues/109853}: @code{sys.path[0]} is now set correctly for subinterpreters.

@item 
gh-109923@footnote{https://github.com/python/cpython/issues/109923}: Set line number on the @code{POP_TOP} that follows a
@code{RETURN_GENERATOR}.

@item 
gh-105716@footnote{https://github.com/python/cpython/issues/105716}: Subinterpreters now correctly handle the case where they have
threads running in the background.  Before, such threads would interfere
with cleaning up and destroying them, as well as prevent running another
script.

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: The internal eval_breaker and supporting flags, plus the
monitoring version have been merged into a single atomic integer to speed
up checks.

@item 
gh-109823@footnote{https://github.com/python/cpython/issues/109823}: Fix bug where compiler does not adjust labels when removing an
empty basic block which is a jump target.

@item 
gh-109793@footnote{https://github.com/python/cpython/issues/109793}: The main thread no longer exits prematurely when a
subinterpreter is cleaned up during runtime finalization.  The bug was a
problem particularly because, when triggered, the Python process would
always return with a 0 exitcode, even if it failed.

@item 
gh-109719@footnote{https://github.com/python/cpython/issues/109719}: Fix missing jump target labels when compiler reorders cold/warm
blocks.

@item 
gh-109595@footnote{https://github.com/python/cpython/issues/109595}: Add @ref{2e2,,-X cpu_count}  command line option to
override return results of @ref{328,,os.cpu_count()} and
@ref{327,,os.process_cpu_count()}. This option is useful for users who need to
limit CPU resources of a container system without having to modify the
container (application code). Patch by Donghee Na.

@item 
gh-109627@footnote{https://github.com/python/cpython/issues/109627}: Fix bug where the compiler does not assign a new jump target
label to a duplicated small exit block.

@item 
gh-109596@footnote{https://github.com/python/cpython/issues/109596}: Fix some tokens in the grammar that were incorrectly marked as
soft keywords. Also fix some repeated rule names and ensure that repeated
rules are not allowed. Patch by Pablo Galindo

@item 
gh-109496@footnote{https://github.com/python/cpython/issues/109496}: On a Python built in debug mode, @ref{613,,Py_DECREF()} now
calls @code{_Py_NegativeRefcount()} if the object is a dangling pointer to
deallocated memory: memory filled with @code{0xDD} «dead byte» by the debug
hook on memory allocators. The fix is to check the reference count
`before' checking for @code{_Py_IsImmortal()}. Patch by Victor Stinner.

@item 
gh-107265@footnote{https://github.com/python/cpython/issues/107265}: Deopt opcodes hidden by the executor when base opcode is needed

@item 
gh-109371@footnote{https://github.com/python/cpython/issues/109371}: Deopted instructions correctly for tool initialization and
modified the incorrect assertion in instrumentation, when a previous tool
already sets INSTRUCTION events

@item 
gh-105658@footnote{https://github.com/python/cpython/issues/105658}: Fix bug where the line trace of an except block ending with a
conditional includes an excess event with the line of the conditional
expression.

@item 
gh-109219@footnote{https://github.com/python/cpython/issues/109219}: Fix compiling type param scopes that use a name which is also
free in an inner scope.

@item 
gh-109351@footnote{https://github.com/python/cpython/issues/109351}: Fix crash when compiling an invalid AST involving a named
(walrus) expression.

@item 
gh-109341@footnote{https://github.com/python/cpython/issues/109341}: Fix crash when compiling an invalid AST involving a
@ref{16ea,,ast.TypeAlias}.

@item 
gh-109195@footnote{https://github.com/python/cpython/issues/109195}: Fix source location for the @code{LOAD_*} instruction preceding a
@code{LOAD_SUPER_ATTR} to load the @code{super} global (or shadowing variable)
so that it encompasses only the name @code{super} and not the following
parentheses.

@item 
gh-109256@footnote{https://github.com/python/cpython/issues/109256}: Opcode IDs for specialized opcodes are allocated in their own
range to improve stability of the IDs for the “real” opcodes.

@item 
gh-109216@footnote{https://github.com/python/cpython/issues/109216}: Fix possible memory leak in @ref{1614,,BUILD_MAP}.

@item 
gh-109207@footnote{https://github.com/python/cpython/issues/109207}: Fix a SystemError in @code{__repr__} of symtable entry object.

@item 
gh-109179@footnote{https://github.com/python/cpython/issues/109179}: Fix bug where the C traceback display drops notes from
@ref{150,,SyntaxError}.

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: Disallow nested scopes (lambdas, generator expressions, and
comprehensions) within PEP 695 annotation scopes that are nested within
classes.

@item 
gh-109156@footnote{https://github.com/python/cpython/issues/109156}: Add tests for de-instrumenting instructions while keeping the
instrumentation for lines

@item 
gh-109114@footnote{https://github.com/python/cpython/issues/109114}: Relax the detection of the error message for invalid lambdas
inside f-strings to not search for arbitrary replacement fields to avoid
false positives. Patch by Pablo Galindo

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: Add a new @ref{1610,,CALL_KW} opcode, used for calls containing
keyword arguments. Also, fix a possible crash when jumping over method
calls in a debugger.

@item 
gh-109052@footnote{https://github.com/python/cpython/issues/109052}: Use the base opcode when comparing code objects to avoid
interference from instrumentation

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: Fix interpreter crash when a NameError is raised inside the
type parameters of a generic class.

@item 
gh-88943@footnote{https://github.com/python/cpython/issues/88943}: Improve syntax error for non-ASCII character that follows a
numerical literal. It now points on the invalid non-ASCII character, not
on the valid numerical literal.

@item 
gh-108976@footnote{https://github.com/python/cpython/issues/108976}: Fix crash that occurs after de-instrumenting a code object in a
monitoring callback.

@item 
gh-108732@footnote{https://github.com/python/cpython/issues/108732}: Make iteration variables of module- and class-scoped
comprehensions visible to pdb and other tools that use @code{frame.f_locals}
again.

@item 
gh-108959@footnote{https://github.com/python/cpython/issues/108959}: Fix caret placement for error locations for subscript and
binary operations that involve non-semantic parentheses and spaces. Patch
by Pablo Galindo

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Fix a crash when running with 
@geindex PYTHONUOPS
@geindex variables de entorno; PYTHONUOPS
@code{PYTHONUOPS} or
@ref{2e2,,-X uops} enabled and an error occurs during optimization.

@item 
gh-108727@footnote{https://github.com/python/cpython/issues/108727}: Define @code{tp_dealloc} for @code{CounterOptimizer_Type}. This fixes
a segfault on deallocation.

@item 
gh-108520@footnote{https://github.com/python/cpython/issues/108520}: Fix @code{multiprocessing.synchronize.SemLock.__setstate__()} to
properly initialize
@code{multiprocessing.synchronize.SemLock._is_fork_ctx}. This fixes a
regression when passing a SemLock across nested processes.

Rename @code{multiprocessing.synchronize.SemLock.is_fork_ctx} to
@code{multiprocessing.synchronize.SemLock._is_fork_ctx} to avoid exposing
it as public API.

@item 
gh-108654@footnote{https://github.com/python/cpython/issues/108654}: Restore locals shadowed by an inlined comprehension if the
comprehension raises an exception.

@item 
gh-108488@footnote{https://github.com/python/cpython/issues/108488}: Change the initialization of inline cache entries so that the
cache entry for @code{JUMP_BACKWARD} is initialized to zero, instead of the
@code{adaptive_counter_warmup()} value used for all other instructions. This
counter, unique among instructions, counts up from zero.

@item 
gh-108716@footnote{https://github.com/python/cpython/issues/108716}: Turn off deep-freezing of code objects. Modules are still
frozen, so that a file system search is not needed for common modules.

@item 
gh-108614@footnote{https://github.com/python/cpython/issues/108614}: Add RESUME_CHECK instruction, to avoid having to handle
instrumentation, signals, and contexts switches in the tier 2 execution
engine.

@item 
gh-108487@footnote{https://github.com/python/cpython/issues/108487}: Move an assert that would cause a spurious crash in a devious
case that should only trigger deoptimization.

@item 
gh-106176@footnote{https://github.com/python/cpython/issues/106176}: Use a @code{WeakValueDictionary} to track the lists containing the
modules each thread is currently importing. This helps avoid a reference
leak from keeping the list around longer than necessary. Weakrefs are used
as GC can’t interrupt the cleanup.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: The regen-opcode build stage was removed and its work is now
done in regen-cases.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Fix missing line number on @ref{7ac,,JUMP_BACKWARD} at the end
of a for loop.

@item 
gh-108113@footnote{https://github.com/python/cpython/issues/108113}: The @ref{2fb,,compile()} built-in can now accept a new flag,
@code{ast.PyCF_OPTIMIZED_AST}, which is similar to @code{ast.PyCF_ONLY_AST}
except that the returned @code{AST} is optimized according to the value of
the @code{optimize} argument.

@ref{30f,,ast.parse()} now accepts an optional argument @code{optimize} which is
passed on to the @ref{2fb,,compile()} built-in. This makes it possible to
obtain an optimized @code{AST}.

@item 
gh-107971@footnote{https://github.com/python/cpython/issues/107971}: Opcode IDs are generated from bytecodes.c instead of being hard
coded in opcode.py.

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: Improve error message for function calls with bad keyword
arguments. Patch by Pablo Galindo

@item 
gh-108390@footnote{https://github.com/python/cpython/issues/108390}: Raise an exception when setting a non-local event (@code{RAISE},
@code{EXCEPTION_HANDLED}, etc.) in @code{sys.monitoring.set_local_events}.

Fixes crash when tracing in recursive calls to Python classes.

@item 
gh-108035@footnote{https://github.com/python/cpython/issues/108035}: Remove the @code{_PyCFrame} struct, moving the pointer to the
current interpreter frame back to the threadstate, as it was for 3.10 and
earlier. The @code{_PyCFrame} existed as a performance optimization for
tracing. Since PEP 669 has been implemented, this optimization no longer
applies.

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: Fix abort / segfault when using all eight type watcher slots, on
platforms where @code{char} is signed by default.

@item 
gh-106581@footnote{https://github.com/python/cpython/issues/106581}: Fix possible assertion failures and missing instrumentation
events when 
@geindex PYTHONUOPS
@geindex variables de entorno; PYTHONUOPS
@code{PYTHONUOPS} or @ref{2e2,,-X uops} is enabled.

@item 
gh-107526@footnote{https://github.com/python/cpython/issues/107526}: Revert converting @code{vars}, @code{dir}, @code{next}, @code{getattr}, and
@code{iter} to argument clinic.

@item 
gh-84805@footnote{https://github.com/python/cpython/issues/84805}: Autogenerate signature for @ref{1514,,METH_NOARGS} and
@ref{1549,,METH_O} extension functions.

@item 
gh-107758@footnote{https://github.com/python/cpython/issues/107758}: Make the @code{dump_stack()} routine used by the @code{lltrace}
feature (low-level interpreter debugging) robust against recursion by
ensuring that it never calls a @code{__repr__} method implemented in Python.
Also make the similar output for Tier-2 uops appear on @code{stdout} (instead
of @code{stderr}), to match the @code{lltrace} code in ceval.c.

@item 
gh-107659@footnote{https://github.com/python/cpython/issues/107659}: Add docstrings for @ref{16eb,,ctypes.pointer()} and
@ref{16ec,,ctypes.POINTER()}.

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: Modify the bytecode so that the actual callable for a
@ref{7a7,,CALL} is at a consistent position on the stack (regardless of
whether or not bound-method-calling optimizations are active).

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: Fixed performance regression in @code{sys.settrace}.

@item 
gh-107724@footnote{https://github.com/python/cpython/issues/107724}: In pre-release versions of 3.12, up to rc1, the sys.monitoring
callback function for the @code{PY_THROW} event was missing the third,
exception argument. That is now fixed.

@item 
gh-84436@footnote{https://github.com/python/cpython/issues/84436}: Skip reference count modifications for many known immortal
objects.

@item 
gh-107596@footnote{https://github.com/python/cpython/issues/107596}: Specialize subscripting @ref{237,,str} objects by @ref{1f0,,int}
indexes.

@item 
gh-107080@footnote{https://github.com/python/cpython/issues/107080}: Trace refs builds (@code{--with-trace-refs}) were crashing when
used with isolated subinterpreters.  The problematic global state has been
isolated to each interpreter.  Other fixing the crashes, this change does
not affect users.

@item 
gh-107557@footnote{https://github.com/python/cpython/issues/107557}: Generate the cases needed for the barebones tier 2 abstract
interpreter for optimization passes in CPython.

@item 
gh-106608@footnote{https://github.com/python/cpython/issues/106608}: Make @code{_PyUOpExecutorObject} variable length.

@item 
gh-100964@footnote{https://github.com/python/cpython/issues/100964}: Clear generators” exception state after @code{return} to break
reference cycles.

@item 
gh-107455@footnote{https://github.com/python/cpython/issues/107455}: Improve error messages when converting an incompatible type to
@ref{16ed,,ctypes.c_char_p}, @ref{16ee,,ctypes.c_wchar_p} and
@ref{16ef,,ctypes.c_void_p}.

@item 
gh-107263@footnote{https://github.com/python/cpython/issues/107263}: Increase C recursion limit for functions other than the main
interpreter from 800 to 1500. This should allow functions like
@code{list.__repr__} and @code{json.dumps} to handle all the inputs that they
could prior to 3.12

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Fix an issue which caused incorrect inline caches to be read
when running with 
@geindex PYTHONUOPS
@geindex variables de entorno; PYTHONUOPS
@code{PYTHONUOPS} or @ref{2e2,,-X uops} enabled.

@item 
gh-104432@footnote{https://github.com/python/cpython/issues/104432}: Fix potential unaligned memory access on C APIs involving
returned sequences of @code{char *} pointers within the @ref{66,,grp} and
@ref{cc,,socket} modules. These were revealed using a
@code{-fsaniziter=alignment} build on ARM macOS. Patch by Christopher Chavez.

@item 
gh-106078@footnote{https://github.com/python/cpython/issues/106078}: Isolate @code{_decimal} (apply 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}). Patch by Charlie
Zhao.

@item 
gh-106898@footnote{https://github.com/python/cpython/issues/106898}: Add the exception as the third argument to @code{PY_UNIND}
callbacks in @code{sys.monitoring}. This makes the @code{PY_UNWIND} callback
consistent with the other exception handling callbacks.

@item 
gh-106895@footnote{https://github.com/python/cpython/issues/106895}: Raise a @code{ValueError} when a monitoring callback function
returns @code{DISABLE} for events that cannot be disabled locally.

@item 
gh-106897@footnote{https://github.com/python/cpython/issues/106897}: Add a @code{RERAISE} event to @code{sys.monitoring}, which occurs
when an exception is reraise, either explicitly by a plain @code{raise}
statement, or implicitly in an @code{except} or @code{finally} block.

@item 
gh-77377@footnote{https://github.com/python/cpython/issues/77377}: Ensure that multiprocessing synchronization objects created in a
fork context are not sent to a different process created in a spawn
context. This changes a segfault into an actionable RuntimeError in the
parent process.

@item 
gh-106931@footnote{https://github.com/python/cpython/issues/106931}: Statically allocated string objects are now interned globally
instead of per-interpreter.  This fixes a situation where such a string
would only be interned in a single interpreter. Normal string objects are
unaffected.

@item 
gh-104621@footnote{https://github.com/python/cpython/issues/104621}: Unsupported modules now always fail to be imported.

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: Add @ref{33a,,dbm.ndbm.ndbm.clear()} to @ref{35,,dbm.ndbm}. Patch By
Donghee Na.

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: Add @ref{339,,dbm.gnu.gdbm.clear()} to @ref{34,,dbm.gnu}. Patch By
Donghee Na.

@item 
gh-107015@footnote{https://github.com/python/cpython/issues/107015}: The ASYNC and AWAIT tokens are removed from the Grammar, which
removes the possibility of making @code{async} and @code{await} soft keywords
when using @code{feature_version<7} in @ref{30f,,ast.parse()}.

@item 
gh-106917@footnote{https://github.com/python/cpython/issues/106917}: Fix classmethod-style @ref{155,,super()} method calls (i.e., where
the second argument to @ref{155,,super()}, or the implied second argument drawn
from @code{self/cls} in the case of zero-arg super, is a type) when the
target of the call is not a classmethod.

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: Python no longer crashes due an infrequent race when
initializing per-interpreter interned strings.  The crash would manifest
when the interpreter was finalized.

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: Python no longer crashes due to an infrequent race in setting
@code{Py_FileSystemDefaultEncoding} and @code{Py_FileSystemDefaultEncodeErrors}
(both deprecated), when simultaneously initializing two isolated
subinterpreters.  Now they are only set during runtime initialization.

@item 
gh-106908@footnote{https://github.com/python/cpython/issues/106908}: Fix various hangs, reference leaks, test failures, and
tracing/introspection bugs when running with 
@geindex PYTHONUOPS
@geindex variables de entorno; PYTHONUOPS
@code{PYTHONUOPS} or
@ref{2e2,,-X uops} enabled.

@item 
gh-106092@footnote{https://github.com/python/cpython/issues/106092}: Fix a segmentation fault caused by a use-after-free bug in
@code{frame_dealloc} when the trashcan delays the deallocation of a
@code{PyFrameObject}.

@item 
gh-106485@footnote{https://github.com/python/cpython/issues/106485}: Reduce the number of materialized instances dictionaries by
dematerializing them when possible.

@item 
gh-106719@footnote{https://github.com/python/cpython/issues/106719}: No longer suppress arbitrary errors in the @code{__annotations__}
getter and setter in the type and module types.

@item 
gh-106723@footnote{https://github.com/python/cpython/issues/106723}: Propagate @code{frozen_modules} to multiprocessing spawned process
interpreters.

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: Split @code{LOAD_ATTR_INSTANCE_VALUE} into micro-ops.

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: Split @ref{16f0,,LOAD_GLOBAL} specializations into micro-ops.

@item 
gh-106597@footnote{https://github.com/python/cpython/issues/106597}: A new debug structure of offsets has been added to the
@code{_PyRuntimeState} that will help out-of-process debuggers and profilers
to obtain the offsets to relevant interpreter structures in a way that is
agnostic of how Python was compiled and that doesn’t require copying the
headers. Patch by Pablo Galindo

@item 
gh-106487@footnote{https://github.com/python/cpython/issues/106487}: Allow the `count' argument of @ref{302,,str.replace()} to be a
keyword. Patch by Hugo van Kemenade.

@item 
gh-96844@footnote{https://github.com/python/cpython/issues/96844}: Improve error message of @code{list.remove()}. Patch by Donghee
Na.

@item 
gh-81283@footnote{https://github.com/python/cpython/issues/81283}: Compiler now strips indents from docstrings. It reduces @code{pyc}
file size 5% when the module is heavily documented. This change affects to
@code{__doc__} so tools like doctest will be affected.

@item 
gh-106396@footnote{https://github.com/python/cpython/issues/106396}: When the format specification of an f-string expression is
empty, the parser now generates an empty @ref{16f1,,ast.JoinedStr} node for
it instead of an one-element @ref{16f1,,ast.JoinedStr} with an empty string
@ref{211,,ast.Constant}.

@item 
gh-100288@footnote{https://github.com/python/cpython/issues/100288}: Specialize @ref{585,,LOAD_ATTR} for non-descriptors on the
class. Adds @code{LOAD_ATTR_NONDESCRIPTOR_WITH_VALUES} and
@code{LOAD_ATTR_NONDESCRIPTOR_NO_DICT}.

@item 
gh-106008@footnote{https://github.com/python/cpython/issues/106008}: Fix possible reference leaks when failing to optimize
comparisons with @ref{716,,None} in the bytecode compiler.

@item 
gh-106145@footnote{https://github.com/python/cpython/issues/106145}: Make @code{end_lineno} and @code{end_col_offset} required on
@code{type_param} ast nodes.

@item 
gh-106213@footnote{https://github.com/python/cpython/issues/106213}: Changed the way that Emscripten call trampolines work for
compatibility with Wasm/JS Promise integration.

@item 
gh-106182@footnote{https://github.com/python/cpython/issues/106182}: @ref{ce1,,sys.getfilesystemencoding()} and
@ref{d6d,,sys.getfilesystemencodeerrors} now return interned Unicode object.

@item 
gh-106210@footnote{https://github.com/python/cpython/issues/106210}: Removed Emscripten import trampoline as it was no longer
necessary for Pyodide.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Added a new, experimental, tracing optimizer and interpreter
(a.k.a. «tier 2»). This currently pessimizes, so don’t use yet – this is
infrastructure so we can experiment with optimizing passes. To enable it,
pass @code{-Xuops} or set @code{PYTHONUOPS=1}. To get debug output, set
@code{PYTHONUOPSDEBUG=N} where @code{N} is a debug level (0-4, where 0 is no
debug output and 4 is excessively verbose).

@item 
gh-105775@footnote{https://github.com/python/cpython/issues/105775}: @ref{16f2,,LOAD_CLOSURE} is now a pseudo-op.

@item 
gh-105730@footnote{https://github.com/python/cpython/issues/105730}: Allow any callable other than type objects as the condition
predicate in @ref{16ca,,BaseExceptionGroup.split()} and
@ref{16c9,,BaseExceptionGroup.subgroup()}.

@item 
gh-105979@footnote{https://github.com/python/cpython/issues/105979}: Fix crash in @code{_imp.get_frozen_object()} due to improper
exception handling.

@item 
gh-106003@footnote{https://github.com/python/cpython/issues/106003}: Add a new @ref{16f3,,TO_BOOL} instruction, which performs boolean
conversions for @ref{16f4,,POP_JUMP_IF_TRUE}, @ref{16f5,,POP_JUMP_IF_FALSE},
and @ref{16f6,,UNARY_NOT} (which all expect exact @ref{513,,bool} values now).
Also, modify the oparg of @ref{9fb,,COMPARE_OP} to include an optional
«boolean conversion» flag.

@item 
gh-98931@footnote{https://github.com/python/cpython/issues/98931}: Ensure custom @ref{150,,SyntaxError} error messages are raised for
invalid imports with multiple targets. Patch by Pablo Galindo

@item 
gh-105724@footnote{https://github.com/python/cpython/issues/105724}: Improve @code{assert} error messages by providing exact error
range.

@item 
gh-105908@footnote{https://github.com/python/cpython/issues/105908}: Fixed bug where gh-99111@footnote{https://github.com/python/cpython/issues/99111} breaks future import
@code{barry_as_FLUFL} in the Python REPL.

@item 
gh-105840@footnote{https://github.com/python/cpython/issues/105840}: Fix possible crashes when specializing function calls with too
many @code{__defaults__}.

@item 
gh-105831@footnote{https://github.com/python/cpython/issues/105831}: Fix an f-string bug, where using a debug expression (the @code{=}
sign) that appears in the last line of a file results to the debug buffer
that holds the expression text being one character too small.

@item 
gh-105800@footnote{https://github.com/python/cpython/issues/105800}: Correctly issue @ref{511,,SyntaxWarning} in f-strings if invalid
sequences are used. Patch by Pablo Galindo

@item 
gh-105340@footnote{https://github.com/python/cpython/issues/105340}: Include the comprehension iteration variable in @code{locals()}
inside a module- or class-scope comprehension.

@item 
gh-105331@footnote{https://github.com/python/cpython/issues/105331}: Raise @ref{360,,ValueError} if the @code{delay} argument to
@ref{afe,,asyncio.sleep()} is a NaN (matching @ref{73e,,time.sleep()}).

@item 
gh-105587@footnote{https://github.com/python/cpython/issues/105587}: The runtime can’t guarantee that immortal objects will not be
mutated by Extensions. Thus, this modifies _PyStaticObject_CheckRefcnt to
warn instead of asserting.

@item 
gh-105564@footnote{https://github.com/python/cpython/issues/105564}: Don’t include artificil newlines in the @code{line} attribute of
tokens in the APIs of the @ref{fb,,tokenize} module. Patch by Pablo Galindo

@item 
gh-105549@footnote{https://github.com/python/cpython/issues/105549}: Tokenize separately @code{NUMBER} and @code{NAME} tokens that are not
ambiguous. Patch by Pablo Galindo.

@item 
gh-105588@footnote{https://github.com/python/cpython/issues/105588}: Fix an issue that could result in crashes when compiling
malformed @ref{9,,ast} nodes.

@item 
gh-100987@footnote{https://github.com/python/cpython/issues/100987}: Allow objects other than code objects as the «executable» in
internal frames. In the long term, this can help tools like Cython and
PySpy interact more efficiently. In the shorter term, it allows us to
perform some optimizations more simply.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in the @ref{13,,builtins} module where exceptions could
end up being overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bug in the compiler where an exception could end up being
overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Improve error handling in @code{PyUnicode_BuildEncodingMap()}
where an exception could end up being overwritten.

@item 
gh-105486@footnote{https://github.com/python/cpython/issues/105486}: Change the repr of @code{ParamSpec} list of args in
@code{types.GenericAlias}.

@item 
gh-105678@footnote{https://github.com/python/cpython/issues/105678}: Break the @code{MAKE_FUNCTION} instruction into two parts,
@code{MAKE_FUNCTION} which makes the function and @code{SET_FUNCTION_ATTRIBUTE}
which sets the attributes on the function. This makes the stack effect of
@code{MAKE_FUNCTION} regular to ease optimization and code generation.

@item 
gh-105435@footnote{https://github.com/python/cpython/issues/105435}: Fix spurious newline character if file ends on a comment
without a newline. Patch by Pablo Galindo

@item 
gh-105390@footnote{https://github.com/python/cpython/issues/105390}: Correctly raise @ref{5e5,,tokenize.TokenError} exceptions instead
of @ref{150,,SyntaxError} for tokenize errors such as incomplete input. Patch
by Pablo Galindo

@item 
gh-105259@footnote{https://github.com/python/cpython/issues/105259}: Don’t include newline character for trailing @code{NEWLINE} tokens
emitted in the @ref{fb,,tokenize} module. Patch by Pablo Galindo

@item 
gh-104635@footnote{https://github.com/python/cpython/issues/104635}: Eliminate redundant @ref{16f7,,STORE_FAST} instructions in the
compiler. Patch by Donghee Na and Carl Meyer.

@item 
gh-105324@footnote{https://github.com/python/cpython/issues/105324}: Fix the main function of the @ref{fb,,tokenize} module when
reading from @code{sys.stdin}. Patch by Pablo Galindo

@item 
gh-33092@footnote{https://github.com/python/cpython/issues/33092}: Simplify and speed up interpreter for f-strings. Removes
@code{FORMAT_VALUE} opcode. Add @code{CONVERT_VALUE}, @code{FORMAT_SIMPLE} and
@code{FORMAT_WITH_SPEC} opcode. Compiler emits more efficient sequence for
each format expression.

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: Remove remaining two-codeunit superinstructions. All remaining
superinstructions only take a single codeunit, simplifying instrumentation
and quickening.

@item 
gh-105235@footnote{https://github.com/python/cpython/issues/105235}: Prevent out-of-bounds memory access during @code{mmap.find()}
calls.

@item 
gh-98963@footnote{https://github.com/python/cpython/issues/98963}: Restore the ability for a subclass of @ref{2fd,,property} to
define @code{__slots__} or otherwise be dict-less by ignoring failures to set
a docstring on such a class.  This behavior had regressed in 3.12beta1.
An @ref{441,,AttributeError} where there had not previously been one was
disruptive to existing code.

@item 
gh-104812@footnote{https://github.com/python/cpython/issues/104812}: The «pending call» machinery now works for all interpreters,
not just the main interpreter, and runs in all threads, not just the main
thread. Some calls are still only done in the main thread, ergo in the
main interpreter. This change does not affect signal handling nor the
existing public C-API (@code{Py_AddPendingCall()}), which both still only
target the main thread. The new functionality is meant strictly for
internal use for now, since consequences of its use are not well
understood yet outside some very restricted cases.  This change brings the
capability in line with the intention when the state was made
per-interpreter several years ago.

@item 
gh-105194@footnote{https://github.com/python/cpython/issues/105194}: Do not escape with backslashes f-string format specifiers.
Patch by Pablo Galindo

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: Replace some dynamic superinstructions with single instruction
equivalents.

@item 
gh-105162@footnote{https://github.com/python/cpython/issues/105162}: Fixed bug in generator.close()/throw() where an inner iterator
would be ignored when the outer iterator was instrumented.

@item 
gh-105164@footnote{https://github.com/python/cpython/issues/105164}: Ensure annotations are set up correctly if the only annotation
in a block is within a @ref{8a4,,match} block. Patch by Jelle Zijlstra.

@item 
gh-105148@footnote{https://github.com/python/cpython/issues/105148}: Make @code{_PyASTOptimizeState} internal to ast_opt.c. Make
@code{_PyAST_Optimize} take two integers instead of a pointer to this struct.
This avoids the need to include pycore_compile.h in ast_opt.c.

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: Attributes of @ref{9,,ast} nodes that are lists now default to
the empty list if omitted. This means that some code that previously
raised @ref{228,,TypeError} when the AST node was used will now proceed with
the empty list instead. Patch by Jelle Zijlstra.

@item 
gh-105111@footnote{https://github.com/python/cpython/issues/105111}: Remove the old trashcan macros @code{Py_TRASHCAN_SAFE_BEGIN} and
@code{Py_TRASHCAN_SAFE_END}. They should be replaced by the new macros
@code{Py_TRASHCAN_BEGIN} and @code{Py_TRASHCAN_END}.

@item 
gh-105035@footnote{https://github.com/python/cpython/issues/105035}: Fix @ref{155,,super()} calls on types with custom
@ref{16f8,,tp_getattro} implementation (e.g. meta-types.)

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: Show CRLF lines in the tokenize string attribute in both NL and
NEWLINE tokens. Patch by Marta Gómez.

@item 
gh-105013@footnote{https://github.com/python/cpython/issues/105013}: Fix handling of multiline parenthesized lambdas in
@ref{15ce,,inspect.getsource()}. Patch by Pablo Galindo

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: Do not include an additional final @code{NL} token when parsing
files having CRLF lines. Patch by Marta Gómez.

@item 
gh-104976@footnote{https://github.com/python/cpython/issues/104976}: Ensure that trailing @code{DEDENT} @code{tokenize.TokenInfo}
objects emitted by the @ref{fb,,tokenize} module are reported as in Python
3.11. Patch by Pablo Galindo

@item 
gh-104972@footnote{https://github.com/python/cpython/issues/104972}: Ensure that the @code{line} attribute in
@code{tokenize.TokenInfo} objects in the @ref{fb,,tokenize} module are
always correct. Patch by Pablo Galindo

@item 
gh-104955@footnote{https://github.com/python/cpython/issues/104955}: Fix signature for the new @ref{16f9,,__release_buffer__()}
slot. Patch by Jelle Zijlstra.

@item 
gh-104690@footnote{https://github.com/python/cpython/issues/104690}: Starting new threads and process creation through
@ref{2ff,,os.fork()} during interpreter shutdown (such as from @ref{d,,atexit}
handlers) is no longer supported.  It can lead to race condition between
the main Python runtime thread freeing thread states while internal
@ref{ed,,threading} routines are trying to allocate and use the state of just
created threads. Or forked children trying to use the mid-shutdown runtime
and thread state in the child process.

@item 
gh-104879@footnote{https://github.com/python/cpython/issues/104879}: Fix crash when accessing the @code{__module__} attribute of type
aliases defined outside a module. Patch by Jelle Zijlstra.

@item 
gh-104825@footnote{https://github.com/python/cpython/issues/104825}: Tokens emitted by the @ref{fb,,tokenize} module do not include an
implicit @code{\n} character in the @code{line} attribute anymore. Patch by
Pablo Galindo

@item 
gh-104770@footnote{https://github.com/python/cpython/issues/104770}: If a generator returns a value upon being closed, the value is
now returned by @ref{16fa,,generator.close()}.

@item 
gh-89091@footnote{https://github.com/python/cpython/issues/89091}: Raise @ref{323,,RuntimeWarning} for unawaited async generator
methods like @ref{970,,asend()}, @ref{59e,,athrow()} and
@ref{96f,,aclose()}. Patch by Kumar Aditya.

@item 
gh-96663@footnote{https://github.com/python/cpython/issues/96663}: Add a better, more introspect-able error message when setting
attributes on classes without a @code{__dict__} and no slot member for the
attribute.

@item 
gh-93627@footnote{https://github.com/python/cpython/issues/93627}: Update the Python pickle module implementation to match the C
implementation of the pickle module. For objects setting reduction methods
like @ref{1609,,__reduce_ex__()} or @ref{a65,,__reduce__()} to
@code{None}, pickling will result in a @ref{228,,TypeError}.

@item 
gh-101006@footnote{https://github.com/python/cpython/issues/101006}: Improve error handling when read @ref{8d,,marshal} data.

@item 
gh-91095@footnote{https://github.com/python/cpython/issues/91095}: Specializes calls to most Python classes. Specifically, any
class that inherits from @code{object}, or another Python class, and does not
override @code{__new__}.

The specialized instruction does the following:


@enumerate 

@item 
Creates the object (by calling @code{object.__new__})

@item 
Pushes a shim frame to the frame stack (to cleanup after @code{__init__})

@item 
Pushes the frame for @code{__init__} to the frame stack
@end enumerate

Speeds up the instantiation of most Python classes.
@end itemize

@node Library<9>,Documentation<8>,Core and Builtins<9>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id70}@anchor{16fb}
@subsubsection Library



@itemize -

@item 
gh-110786@footnote{https://github.com/python/cpython/issues/110786}: @ref{db,,sysconfig}’s CLI now ignores @ref{10d8,,BrokenPipeError},
making it exit normally if its output is being piped and the pipe closes.

@item 
gh-103480@footnote{https://github.com/python/cpython/issues/103480}: The @ref{db,,sysconfig} module is now a package, instead of a
single-file module.

@item 
gh-110733@footnote{https://github.com/python/cpython/issues/110733}: Micro-optimization: Avoid calling @code{min()}, @code{max()} in
@code{BaseEventLoop._run_once()}.

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: Added @ref{16fc,,asyncio.EventLoop} for use with the
@ref{525,,asyncio.run()} `loop_factory' kwarg to avoid calling the asyncio
policy system.

@item 
gh-110682@footnote{https://github.com/python/cpython/issues/110682}: @ref{4f0,,runtime-checkable protocols}
used to consider @code{__match_args__} a protocol member in
@code{__instancecheck__} if it was present on the protocol. Now, this
attribute is ignored if it is present.

@item 
gh-110488@footnote{https://github.com/python/cpython/issues/110488}: Fix a couple of issues in @ref{16fd,,pathlib.PurePath.with_name()}: a
single dot was incorrectly considered a valid name, and in
@code{PureWindowsPath}, a name with an NTFS alternate data stream, like
@code{a:b}, was incorrectly considered invalid.

@item 
gh-110590@footnote{https://github.com/python/cpython/issues/110590}: Fix a bug in @code{_sre.compile()} where @ref{228,,TypeError} would
be overwritten by @ref{919,,OverflowError} when the `code' argument was a list
of non-ints.

@item 
gh-65052@footnote{https://github.com/python/cpython/issues/65052}: Prevent @ref{a5,,pdb} from crashing when trying to display
undisplayable objects

@item 
gh-110519@footnote{https://github.com/python/cpython/issues/110519}: Deprecation warning about non-integer number in @ref{63,,gettext}
now always refers to the line in the user code where gettext function or
method is used. Previously it could refer to a line in @code{gettext} code.

@item 
gh-89902@footnote{https://github.com/python/cpython/issues/89902}: Deprecate non-standard format specifier «N» for
@ref{16a,,decimal.Decimal}. It was not documented and only supported in the
C implementation.

@item 
gh-110378@footnote{https://github.com/python/cpython/issues/110378}: @ref{126f,,contextmanager()} and
@ref{bb3,,asynccontextmanager()} context managers now close an
invalid underlying generator object that yields more then one value.

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: In @ref{a5,,pdb}, set convenience variable @code{$_exception} for
post mortem debugging.

@item 
gh-110365@footnote{https://github.com/python/cpython/issues/110365}: Fix @ref{16fe,,termios.tcsetattr()} bug that was overwriting existing
errors during parsing integers from @code{term} list.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Slightly improve the import time of several standard-library
modules by deferring imports of @ref{112,,warnings} within those modules.
Patch by Alex Waygood.

@item 
gh-110273@footnote{https://github.com/python/cpython/issues/110273}: @ref{16ff,,dataclasses.replace()} now raises TypeError instead of
ValueError if specify keyword argument for a field declared with
init=False or miss keyword argument for required InitVar field.

@item 
gh-110249@footnote{https://github.com/python/cpython/issues/110249}: Add @code{--inline-caches} flag to @code{dis} command line.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Fix a Python 3.12 regression in the import time of
@ref{b8,,random}. Patch by Alex Waygood.

@item 
gh-110222@footnote{https://github.com/python/cpython/issues/110222}: Add support of struct sequence objects in @ref{15f,,copy.replace()}.
Patched by Xuehai Pan.

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: @ref{94,,multiprocessing}, @ref{22,,concurrent.futures},
@ref{21,,compileall}: Replace @ref{328,,os.cpu_count()} with
@ref{327,,os.process_cpu_count()} to select the default number of worker
threads and processes. Get the CPU affinity if supported. Patch by Victor
Stinner.

@item 
gh-110150@footnote{https://github.com/python/cpython/issues/110150}: Fix base case handling in statistics.quantiles.  Now allows a
single data point.

@item 
gh-110036@footnote{https://github.com/python/cpython/issues/110036}: On Windows, multiprocessing @code{Popen.terminate()} now catches
@ref{dc9,,PermissionError} and get the process exit code. If the process is
still running, raise again the @ref{dc9,,PermissionError}. Otherwise, the
process terminated as expected: store its exit code. Patch by Victor
Stinner.

@item 
gh-110038@footnote{https://github.com/python/cpython/issues/110038}: Fixed an issue that caused @code{KqueueSelector.select()} to not
return all the ready events in some cases when a file descriptor is
registered for both read and write.

@item 
gh-110045@footnote{https://github.com/python/cpython/issues/110045}: Update the @ref{d8,,symtable} module to support the new scopes
introduced by 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.

@item 
gh-88402@footnote{https://github.com/python/cpython/issues/88402}: Add new variables to @ref{10a8,,sysconfig.get_config_vars()} on
Windows: @code{LIBRARY}, @code{LDLIBRARY}, @code{LIBDIR}, @code{SOABI}, and
@code{Py_NOGIL}.

@item 
gh-109631@footnote{https://github.com/python/cpython/issues/109631}: @ref{b9,,re} functions such as @ref{10a6,,re.findall()},
@ref{3f1,,re.split()}, @ref{1299,,re.search()} and @ref{3f2,,re.sub()} which perform short
repeated matches can now be interrupted by user.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduce the import time of @ref{51,,email.utils} by around 43%.
This results in the import time of @ref{45,,email.message} falling by around
18%, which in turn reduces the import time of @ref{7a,,importlib.metadata} by
around 6%. Patch by Alex Waygood.

@item 
gh-109818@footnote{https://github.com/python/cpython/issues/109818}: Fix @ref{1260,,reprlib.recursive_repr()} not copying
@code{__type_params__} from decorated function.

@item 
gh-109047@footnote{https://github.com/python/cpython/issues/109047}: @ref{22,,concurrent.futures}: The `executor manager thread' now
catches exceptions when adding an item to the `call queue'. During Python
finalization, creating a new thread can now raise @ref{1e5,,RuntimeError}.
Catch the exception and call @code{terminate_broken()} in this case. Patch by
Victor Stinner.

@item 
gh-109782@footnote{https://github.com/python/cpython/issues/109782}: Ensure the signature of @ref{aa2,,os.path.isdir()} is identical on
all platforms. Patch by Amin Alaee.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Improve import time of @ref{5f,,functools} by around 13%. Patch by
Alex Waygood.

@item 
gh-109590@footnote{https://github.com/python/cpython/issues/109590}: @ref{55b,,shutil.which()} will prefer files with an extension in
@code{PATHEXT} if the given mode includes @code{os.X_OK} on win32. If no
@code{PATHEXT} match is found, a file without an extension in @code{PATHEXT} can
be returned. This change will have @ref{55b,,shutil.which()} act more similarly
to previous behavior in Python 3.11.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduce the import time of @ref{56,,enum} by over 50%. Patch by
Alex Waygood.

@item 
gh-109593@footnote{https://github.com/python/cpython/issues/109593}: Avoid deadlocking on a reentrant call to the multiprocessing
resource tracker. Such a reentrant call, though unlikely, can happen if a
GC pass invokes the finalizer for a multiprocessing object such as
SemLock.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduce the import time of @ref{104,,typing} by around a third.
Patch by Alex Waygood.

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: Add @ref{327,,os.process_cpu_count()} function to get the number of
logical CPUs usable by the calling thread of the current process. Patch by
Victor Stinner.

@item 
gh-74481@footnote{https://github.com/python/cpython/issues/74481}: Add @code{set_error_mode} related constants in @code{msvcrt} module in
Python debug build.

@item 
gh-109613@footnote{https://github.com/python/cpython/issues/109613}: Fix @ref{548,,os.stat()} and @ref{1700,,os.DirEntry.stat()}: check for
exceptions. Previously, on Python built in debug mode, these functions
could trigger a fatal Python error (and abort the process) when a function
succeeded with an exception set. Patch by Victor Stinner.

@item 
gh-109599@footnote{https://github.com/python/cpython/issues/109599}: Expose the type of PyCapsule objects as @code{types.CapsuleType}.

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: You can now get the raw TLS certificate chains from TLS
connections via @ref{15f9,,ssl.SSLSocket.get_verified_chain()} and
@ref{15fa,,ssl.SSLSocket.get_unverified_chain()} methods.

Contributed by Mateusz Nowak.

@item 
gh-109559@footnote{https://github.com/python/cpython/issues/109559}: Update @ref{105,,unicodedata} database to Unicode 15.1.0.

@item 
gh-109543@footnote{https://github.com/python/cpython/issues/109543}: Remove unnecessary @ref{579,,hasattr()} check during
@ref{2ce,,typing.TypedDict} creation.

@item 
gh-109495@footnote{https://github.com/python/cpython/issues/109495}: Remove unnecessary extra @code{__slots__} in
@ref{32f,,datetime}'s pure python implementation to reduce memory
size, as they are defined in the superclass. Patch by James Hilton-Balfe

@item 
gh-109461@footnote{https://github.com/python/cpython/issues/109461}: @ref{87,,logging}: Use a context manager for lock acquisition.

@item 
gh-109096@footnote{https://github.com/python/cpython/issues/109096}: @ref{1cf,,http.server.CGIHTTPRequestHandler} has been deprecated
for removal in 3.15.  Its design is old and the web world has long since
moved beyond CGI.

@item 
gh-109409@footnote{https://github.com/python/cpython/issues/109409}: Fix error when it was possible to inherit a frozen dataclass
from multiple parents some of which were possibly not frozen.

@item 
gh-109375@footnote{https://github.com/python/cpython/issues/109375}: The @ref{a5,,pdb} @code{alias} command now prevents registering
aliases without arguments.

@item 
gh-109319@footnote{https://github.com/python/cpython/issues/109319}: Deprecate the @code{dis.HAVE_ARGUMENT} field in favour of
@code{dis.hasarg}.

@item 
gh-107219@footnote{https://github.com/python/cpython/issues/107219}: Fix a race condition in @code{concurrent.futures}. When a process
in the process pool was terminated abruptly (while the future was running
or pending), close the connection write end. If the call queue is blocked
on sending bytes to a worker process, closing the connection write end
interrupts the send, so the queue can be closed. Patch by Victor Stinner.

@item 
gh-66143@footnote{https://github.com/python/cpython/issues/66143}: The @ref{1701,,codecs.CodecInfo} object has been made copyable and
pickleable. Patched by Robert Lehmann and Furkan Onder.

@item 
gh-109187@footnote{https://github.com/python/cpython/issues/109187}: @ref{1702,,pathlib.Path.resolve()} now treats symlink loops like
other errors: in strict mode, @ref{4d5,,OSError} is raised, and in non-strict
mode, no exception is raised.

@item 
gh-50644@footnote{https://github.com/python/cpython/issues/50644}: Attempts to pickle or create a shallow or deep copy of
@ref{1c,,codecs} streams now raise a TypeError. Previously, copying failed
with a RecursionError, while pickling produced wrong results that
eventually caused unpickling to fail with a RecursionError.

@item 
gh-109174@footnote{https://github.com/python/cpython/issues/109174}: Add support of @ref{334,,types.SimpleNamespace} in
@ref{15f,,copy.replace()}.

@item 
gh-109164@footnote{https://github.com/python/cpython/issues/109164}: @ref{a5,,pdb}: Replace @ref{61,,getopt} with @ref{7,,argparse} for
parsing command line arguments.

@item 
gh-109151@footnote{https://github.com/python/cpython/issues/109151}: Enable @code{readline} editing features in the @ref{4ee,,sqlite3 command-line interface} (@code{python -m sqlite3}).

@item 
gh-108987@footnote{https://github.com/python/cpython/issues/108987}: Fix @ref{2fe,,_thread.start_new_thread()} race condition. If a
thread is created during Python finalization, the newly spawned thread now
exits immediately instead of trying to access freed memory and lead to a
crash. Patch by Victor Stinner.

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: Enum: require @code{names=()} or @code{type=...} to create an empty
enum using the functional syntax.

@item 
gh-109033@footnote{https://github.com/python/cpython/issues/109033}: Exceptions raised by os.utime builtin function now include the
related filename

@item 
gh-108843@footnote{https://github.com/python/cpython/issues/108843}: Fix an issue in @ref{97c,,ast.unparse()} when unparsing f-strings
containing many quote types.

@item 
gh-108469@footnote{https://github.com/python/cpython/issues/108469}: @ref{97c,,ast.unparse()} now supports new @ref{4e4,,f-string} syntax
introduced in Python 3.12. Note that the @ref{4e4,,f-string} quotes are
reselected for simplicity under the new syntax. (Patch by Steven Sun)

@item 
gh-108751@footnote{https://github.com/python/cpython/issues/108751}: Add @ref{15f,,copy.replace()} function which allows to create a
modified copy of an object. It supports named tuples, dataclasses, and
many other objects.

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: Enum: raise @ref{228,,TypeError} if @code{super().__new__()} is called
from a custom @code{__new__}.

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: Deprecate passing the callback callable by keyword for the
following @ref{39e,,sqlite3.Connection} APIs:


@itemize *

@item 
@ref{3f8,,set_authorizer()}

@item 
@ref{3f9,,set_progress_handler()}

@item 
@ref{3fa,,set_trace_callback()}
@end itemize

The affected parameters will become positional-only in Python 3.15.

Patch by Erlend E. Aasland.

@item 
gh-105829@footnote{https://github.com/python/cpython/issues/105829}: Fix concurrent.futures.ProcessPoolExecutor deadlock

@item 
gh-108295@footnote{https://github.com/python/cpython/issues/108295}: Fix crashes related to use of weakrefs on
@ref{2c9,,typing.TypeVar}.

@item 
gh-108463@footnote{https://github.com/python/cpython/issues/108463}: Make expressions/statements work as expected in pdb

@item 
gh-108277@footnote{https://github.com/python/cpython/issues/108277}: Add @ref{36e,,os.timerfd_create()}, @ref{36f,,os.timerfd_settime()},
@ref{371,,os.timerfd_gettime()}, @ref{370,,os.timerfd_settime_ns()}, and
@ref{372,,os.timerfd_gettime_ns()} to provide a low level interface for Linux’s
timer notification file descriptor.

@item 
gh-107811@footnote{https://github.com/python/cpython/issues/107811}: @ref{de,,tarfile}: extraction of members with overly large UID or
GID (e.g. on an OS with 32-bit @code{id_t}) now fails in the same way
as failing to set the ID.

@item 
gh-64662@footnote{https://github.com/python/cpython/issues/64662}: Fix support for virtual tables in
@ref{3a0,,sqlite3.Connection.iterdump()}. Patch by Aviv Palivoda.

@item 
gh-108111@footnote{https://github.com/python/cpython/issues/108111}: Fix a regression introduced in gh-101251@footnote{https://github.com/python/cpython/issues/101251} for 3.12, resulting in
an incorrect offset calculation in @code{gzip.GzipFile.seek()}.

@item 
gh-108294@footnote{https://github.com/python/cpython/issues/108294}: @ref{73e,,time.sleep()} now raises an auditing event.

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: Deprecate passing name, number of arguments, and the callable
as keyword arguments, for the following @ref{39e,,sqlite3.Connection} APIs:


@itemize *

@item 
@ref{3f6,,create_function()}

@item 
@ref{3f7,,create_aggregate()}
@end itemize

The affected parameters will become positional-only in Python 3.15.

Patch by Erlend E. Aasland.

@item 
gh-108322@footnote{https://github.com/python/cpython/issues/108322}: Speed-up NormalDist.samples() by using the inverse CDF method
instead of calling random.gauss().

@item 
gh-83417@footnote{https://github.com/python/cpython/issues/83417}: Add the ability for venv to create a @code{.gitignore} file which
causes the created environment to be ignored by Git. It is on by default
when venv is called via its CLI.

@item 
gh-105736@footnote{https://github.com/python/cpython/issues/105736}: Harmonized the pure Python version of
@ref{67c,,OrderedDict} with the C version. Now, both versions
set up their internal state in @code{__new__}.  Formerly, the pure Python
version did the set up in @code{__init__}.

@item 
gh-108083@footnote{https://github.com/python/cpython/issues/108083}: Fix bugs in the constructor of @ref{39e,,sqlite3.Connection} and
@ref{39f,,sqlite3.Connection.close()} where exceptions could be leaked. Patch
by Erlend E. Aasland.

@item 
gh-107932@footnote{https://github.com/python/cpython/issues/107932}: Fix @code{dis} module to properly report and display bytecode that
do not have source lines.

@item 
gh-105539@footnote{https://github.com/python/cpython/issues/105539}: @ref{cf,,sqlite3} now emits an @ref{39d,,ResourceWarning} if a
@ref{39e,,sqlite3.Connection} object is not @code{closed} explicitly. Patch by Erlend E. Aasland.

@item 
gh-107995@footnote{https://github.com/python/cpython/issues/107995}: The @code{__module__} attribute on instances of
@ref{5e4,,functools.cached_property} is now set to the name of the module in
which the cached_property is defined, rather than «functools». This means
that doctests in @code{cached_property} docstrings are now properly collected
by the @ref{3b,,doctest} module. Patch by Tyler Smart.

@item 
gh-107963@footnote{https://github.com/python/cpython/issues/107963}: Fix @ref{1599,,multiprocessing.set_forkserver_preload()} to check the
given list of modules names. Patch by Donghee Na.

@item 
gh-106242@footnote{https://github.com/python/cpython/issues/106242}: Fixes @ref{1382,,os.path.normpath()} to handle embedded null
characters without truncating the path.

@item 
gh-81555@footnote{https://github.com/python/cpython/issues/81555}: @ref{122,,xml.dom.minidom} now only quotes @code{"} in attributes.

@item 
gh-50002@footnote{https://github.com/python/cpython/issues/50002}: @ref{122,,xml.dom.minidom} now preserves whitespaces in attributes.

@item 
gh-93057@footnote{https://github.com/python/cpython/issues/93057}: Passing more than one positional argument to
@ref{3f5,,sqlite3.connect()} and the @ref{39e,,sqlite3.Connection} constructor is
deprecated. The remaining parameters will become keyword-only in Python
3.15. Patch by Erlend E. Aasland.

@item 
gh-76913@footnote{https://github.com/python/cpython/issues/76913}: Add `merge_extra' parameter/feature to
@ref{135c,,logging.LoggerAdapter}

@item 
gh-107913@footnote{https://github.com/python/cpython/issues/107913}: Fix possible losses of @code{errno} and @code{winerror} values in
@ref{4d5,,OSError} exceptions if they were cleared or modified by the cleanup
code before creating the exception object.

@item 
gh-107845@footnote{https://github.com/python/cpython/issues/107845}: @ref{1615,,tarfile.data_filter()} now takes the location of symlinks
into account when determining their target, so it will no longer reject
some valid tarballs with @code{LinkOutsideDestinationError}.

@item 
gh-107812@footnote{https://github.com/python/cpython/issues/107812}: Extend socket’s netlink support to the FreeBSD platform.

@item 
gh-107805@footnote{https://github.com/python/cpython/issues/107805}: Fix signatures of module-level generated functions in
@ref{101,,turtle}.

@item 
gh-107782@footnote{https://github.com/python/cpython/issues/107782}: @ref{b5,,pydoc} is now able to show signatures which are not
representable in Python, e.g. for @code{getattr} and @code{dict.pop}.

@item 
gh-56166@footnote{https://github.com/python/cpython/issues/56166}: Deprecate passing optional arguments `maxsplit', `count' and
`flags' in module-level functions @ref{3f1,,re.split()}, @ref{3f2,,re.sub()} and
@ref{3f3,,re.subn()} as positional. They should only be passed by keyword.

@item 
gh-107710@footnote{https://github.com/python/cpython/issues/107710}: Speed up @ref{1703,,logging.getHandlerNames()}.

@item 
gh-107715@footnote{https://github.com/python/cpython/issues/107715}: Fix @ref{1704,,doctest.DocTestFinder.find()} in presence of class
names with special characters. Patch by Gertjan van Zwieten.

@item 
gh-100814@footnote{https://github.com/python/cpython/issues/100814}: Passing a callable object as an option value to a Tkinter image
now raises the expected TclError instead of an AttributeError.

@item 
gh-72684@footnote{https://github.com/python/cpython/issues/72684}: Add @ref{f0,,tkinter} widget methods: @code{tk_busy_hold()},
@code{tk_busy_configure()}, @code{tk_busy_cget()},
@code{tk_busy_forget()}, @code{tk_busy_current()}, and
@code{tk_busy_status()}.

@item 
gh-106684@footnote{https://github.com/python/cpython/issues/106684}: Raise @ref{39d,,ResourceWarning} when @ref{1705,,asyncio.StreamWriter}
is not closed leading to memory leaks. Patch by Kumar Aditya.

@item 
gh-107465@footnote{https://github.com/python/cpython/issues/107465}: Add @ref{385,,pathlib.Path.from_uri()} classmethod.

@item 
gh-107077@footnote{https://github.com/python/cpython/issues/107077}: Seems that in some conditions, OpenSSL will return
@code{SSL_ERROR_SYSCALL} instead of @code{SSL_ERROR_SSL} when a certification
verification has failed, but the error parameters will still contain
@code{ERR_LIB_SSL} and @code{SSL_R_CERTIFICATE_VERIFY_FAILED}. We are now
detecting this situation and raising the appropriate
@code{ssl.SSLCertVerificationError}. Patch by Pablo Galindo

@item 
gh-107576@footnote{https://github.com/python/cpython/issues/107576}: Fix @ref{575,,types.get_original_bases()} to only return
@code{__orig_bases__} if it is present on @code{cls} directly. Patch by
James Hilton-Balfe.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: Remove @code{opcode.is_pseudo}, @code{opcode.MIN_PSEUDO_OPCODE} and
@code{opcode.MAX_PSEUDO_OPCODE}, which were added in 3.12, were never
documented and were not intended to be used externally.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @code{opcode.ENABLE_SPECIALIZATION} (which was added in 3.12
but never documented or intended for external usage) is moved to
@code{_opcode.ENABLE_SPECIALIZATION} where tests can access it.

@item 
gh-107396@footnote{https://github.com/python/cpython/issues/107396}: tarfiles; Fixed use before assignment of self.exception for
gzip decompression

@item 
gh-107409@footnote{https://github.com/python/cpython/issues/107409}: Set @code{__wrapped__} attribute in
@ref{1260,,reprlib.recursive_repr()}.

@item 
gh-107406@footnote{https://github.com/python/cpython/issues/107406}: Implement new @code{__repr__()} method for
@ref{16b9,,struct.Struct}. Now it returns @code{Struct(<format repr>)}.

@item 
gh-107369@footnote{https://github.com/python/cpython/issues/107369}: Optimize @ref{3cd,,textwrap.indent()}. It is ~30% faster for large
input. Patch by Inada Naoki.

@item 
gh-78722@footnote{https://github.com/python/cpython/issues/78722}: Fix issue where @ref{163d,,pathlib.Path.iterdir()} did not raise
@ref{4d5,,OSError} until iterated.

@item 
gh-105578@footnote{https://github.com/python/cpython/issues/105578}: Deprecate @ref{3fb,,typing.AnyStr} in favor of the new Type
Parameter syntax. See PEP 695.

@item 
gh-62519@footnote{https://github.com/python/cpython/issues/62519}: Make @ref{a87,,gettext.pgettext()} search plural definitions when
translation is not found.

@item 
gh-107089@footnote{https://github.com/python/cpython/issues/107089}: Shelves opened with @ref{1706,,shelve.open()} have a much faster
@code{clear()} method. Patch by James Cave.

@item 
gh-82500@footnote{https://github.com/python/cpython/issues/82500}: Fix overflow on 32-bit systems with @ref{b,,asyncio}
@ref{b9a,,os.sendfile()} implementation.

@item 
gh-83006@footnote{https://github.com/python/cpython/issues/83006}: Document behavior of @ref{119f,,shutil.disk_usage()} for non-mounted
filesystems on Unix.

@item 
gh-65495@footnote{https://github.com/python/cpython/issues/65495}: Use lowercase @code{mail from} and @code{rcpt to} in
@code{smptlib.SMTP}.

@item 
gh-106186@footnote{https://github.com/python/cpython/issues/106186}: Do not report @code{MultipartInvariantViolationDefect} defect when
the @ref{120d,,email.parser.Parser} class is used to parse emails with
@code{headersonly=True}.

@item 
gh-105002@footnote{https://github.com/python/cpython/issues/105002}: Fix invalid result from @code{PurePath.relative_to()} method
when attempting to walk a «@code{..}» segment in `other' with `walk_up'
enabled. A @ref{360,,ValueError} exception is now raised in this case.

@item 
gh-106739@footnote{https://github.com/python/cpython/issues/106739}: Add the @code{rtype_cache} to the warning message (as an addition
to the type of leaked objects and the number of leaked objects already
included in the message) to make debugging leaked objects easier when the
multiprocessing resource tracker process finds leaked objects at shutdown.
This helps more quickly identify what was leaked and/or why the leaked
object was not properly cleaned up.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Optimize @code{SelectSelector.select()} for many iteration case.
Patch By Donghee Na.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Optimize @code{_PollLikeSelector.select()} for many iteration
case.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Optimize @code{KqueueSelector.select()} for many iteration case.
Patch By Donghee Na.

@item 
gh-106831@footnote{https://github.com/python/cpython/issues/106831}: Fix potential missing @code{NULL} check of @code{d2i_SSL_SESSION}
result in @code{_ssl.c}.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: The various opcode lists in the @ref{39,,dis} module are now
generated from bytecodes.c instead of explicitly constructed in opcode.py.

@item 
gh-106727@footnote{https://github.com/python/cpython/issues/106727}: Make @ref{15ce,,inspect.getsource()} smarter for class for same name
definitions

@item 
gh-106789@footnote{https://github.com/python/cpython/issues/106789}: Remove import of @ref{ae,,pprint} from @ref{db,,sysconfig}.

@item 
gh-105726@footnote{https://github.com/python/cpython/issues/105726}: Added @code{__slots__} to
@ref{d16,,contextlib.AbstractContextManager} and
@ref{bb4,,contextlib.AbstractAsyncContextManager} so that child classes can
use @code{__slots__}.

@item 
gh-106774@footnote{https://github.com/python/cpython/issues/106774}: Update the bundled copy of pip to version 23.2.1.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: @ref{c2,,selectors}: Optimize @code{EpollSelector.select()} code by
moving some code outside of the loop.

@item 
gh-106752@footnote{https://github.com/python/cpython/issues/106752}: Fixed several bugs in zipfile.Path, including: in
@code{zipfile.Path.match()}, Windows separators are no longer honored (and
never were meant to be); Fixed @code{name}/@code{suffix}/@code{suffixes}/@code{stem}
operations when no filename is present and the Path is not at the root of
the zipfile; Reworked glob for performance and more correct matching
behavior.

@item 
gh-105293@footnote{https://github.com/python/cpython/issues/105293}: Remove call to @code{SSL_CTX_set_session_id_context} during client
side context creation in the @ref{d0,,ssl} module.

@item 
gh-106734@footnote{https://github.com/python/cpython/issues/106734}: Disable tab completion in multiline mode of @ref{a5,,pdb}

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: Expose opcode metadata through @code{_opcode}.

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: Add the new @code{exceptions} command to the Pdb debugger. It
makes it possible to move between chained exceptions when using post
mortem debugging.

@item 
gh-106602@footnote{https://github.com/python/cpython/issues/106602}: Add __copy__ and __deepcopy__ in @ref{56,,enum}

@item 
gh-106664@footnote{https://github.com/python/cpython/issues/106664}: @ref{c2,,selectors}: Add @code{_SelectorMapping.get()} method and
optimize @code{_SelectorMapping.__getitem__()}.

@item 
gh-106628@footnote{https://github.com/python/cpython/issues/106628}: Speed up parsing of emails by about 20% by not compiling a new
regular expression for every single email.

@item 
gh-89427@footnote{https://github.com/python/cpython/issues/89427}: Set the environment variable @code{VIRTUAL_ENV_PROMPT} at
@ref{111,,venv} activation, even when @code{VIRTUAL_ENV_DISABLE_PROMPT} is set.

@item 
gh-106530@footnote{https://github.com/python/cpython/issues/106530}: Revert a change to @ref{1707,,colorsys.rgb_to_hls()} that caused
division by zero for certain almost-white inputs.  Patch by Terry Jan
Reedy.

@item 
gh-106584@footnote{https://github.com/python/cpython/issues/106584}: Fix exit code for @code{unittest} if all tests are skipped. Patch
by Egor Eliseev.

@item 
gh-106566@footnote{https://github.com/python/cpython/issues/106566}: Optimize @code{(?!)} (pattern which always fails) in regular
expressions.

@item 
gh-106554@footnote{https://github.com/python/cpython/issues/106554}: @ref{c2,,selectors}: Reduce Selector overhead by using a
@code{dict.get()} to lookup file descriptors.

@item 
gh-106558@footnote{https://github.com/python/cpython/issues/106558}: Remove ref cycle in callers of
@code{convert_to_error()} by deleting @code{result}
from scope in a @code{finally} block.

@item 
gh-100502@footnote{https://github.com/python/cpython/issues/100502}: Add @code{pathlib.PurePath.pathmod} class attribute that
stores the implementation of @ref{a2,,os.path} used for low-level path
operations: either @code{posixpath} or @code{ntpath}.

@item 
gh-106527@footnote{https://github.com/python/cpython/issues/106527}: Reduce overhead to add and remove @ref{b,,asyncio} readers and
writers.

@item 
gh-106524@footnote{https://github.com/python/cpython/issues/106524}: Fix crash in @code{_sre.template()} with templates containing
invalid group indices.

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: Removed @code{_legacy} and the names it provided from
@code{importlib.resources}: @code{Resource}, @code{contents}, @code{is_resource},
@code{open_binary}, @code{open_text}, @code{path}, @code{read_binary}, and
@code{read_text}.

@item 
gh-106052@footnote{https://github.com/python/cpython/issues/106052}: @ref{b9,,re} module: fix the matching of possessive quantifiers in
the case of a subpattern containing backtracking.

@item 
gh-106510@footnote{https://github.com/python/cpython/issues/106510}: Improve debug output for atomic groups in regular expressions.

@item 
gh-106503@footnote{https://github.com/python/cpython/issues/106503}: Fix ref cycle in @code{asyncio._SelectorSocketTransport} by
removing @code{_write_ready} in @code{close}.

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: Fix flag mask inversion when unnamed flags exist.

@item 
gh-90876@footnote{https://github.com/python/cpython/issues/90876}: Prevent @code{multiprocessing.spawn} from failing to `import' in
environments where @code{sys.executable} is @code{None}.  This regressed in 3.11
with the addition of support for path-like objects in multiprocessing.

@item 
gh-106403@footnote{https://github.com/python/cpython/issues/106403}: Instances of @ref{2c9,,typing.TypeVar},
@ref{2ca,,typing.ParamSpec}, @ref{85f,,typing.ParamSpecArgs},
@ref{860,,typing.ParamSpecKwargs}, and @ref{2cb,,typing.TypeVarTuple} once
again support weak references, fixing a regression introduced in Python
3.12.0 beta 1. Patch by Jelle Zijlstra.

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: Add private @code{pathlib._PathBase} class, which provides
experimental support for virtual filesystems, and may be made public in a
future version of Python.

@item 
gh-106292@footnote{https://github.com/python/cpython/issues/106292}: Check for an instance-dict cached value in the @code{__get__()}
method of @ref{5e4,,functools.cached_property()}. This better matches the
pre-3.12 behavior and improves compatibility for users subclassing
@ref{5e4,,functools.cached_property()} and adding a @code{__set__()} method.

@item 
gh-106350@footnote{https://github.com/python/cpython/issues/106350}: Detect possible memory allocation failure in the libtommath
function @code{mp_init()} used by the @code{_tkinter} module.

@item 
gh-106330@footnote{https://github.com/python/cpython/issues/106330}: Fix incorrect matching of empty paths in
@ref{554,,pathlib.PurePath.match()}. This bug was introduced in Python 3.12.0
beta 1.

@item 
gh-106309@footnote{https://github.com/python/cpython/issues/106309}: Deprecate @ref{1dc,,typing.no_type_check_decorator()}. No major type
checker ever added support for this decorator. Patch by Alex Waygood.

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: Make @code{pydoc.doc()} catch bad module @ref{4d7,,ImportError} when
output stream is not @code{None}.

@item 
gh-106263@footnote{https://github.com/python/cpython/issues/106263}: Fix crash when calling @code{repr} with a manually constructed
SignalDict object. Patch by Charlie Zhao.

@item 
gh-106236@footnote{https://github.com/python/cpython/issues/106236}: Replace @code{assert} statements with @code{raise RuntimeError} in
@ref{ed,,threading}, so that @code{_DummyThread} cannot be joined even with
@code{-OO}.

@item 
gh-106238@footnote{https://github.com/python/cpython/issues/106238}: Fix rare concurrency bug in lock acquisition by the logging
package.

@item 
gh-106152@footnote{https://github.com/python/cpython/issues/106152}: Added PY_THROW event hook for @ref{28,,cProfile} for generators

@item 
gh-106075@footnote{https://github.com/python/cpython/issues/106075}: Added @code{asyncio.taskgroups.__all__} to @code{asyncio.__all__} for
export in star imports.

@item 
gh-104527@footnote{https://github.com/python/cpython/issues/104527}: Zipapp will now skip over appending an archive to itself.

@item 
gh-106046@footnote{https://github.com/python/cpython/issues/106046}: Improve the error message from @ref{cdb,,os.fspath()} if called on
an object where @code{__fspath__} is set to @code{None}. Patch by Alex Waygood.

@item 
gh-105987@footnote{https://github.com/python/cpython/issues/105987}: Fix crash due to improper reference counting in @ref{b,,asyncio}
eager task factory internal routines.

@item 
gh-105974@footnote{https://github.com/python/cpython/issues/105974}: Fix bug where a @ref{3bb,,typing.Protocol} class that had one or
more non-callable members would raise @ref{228,,TypeError} when
@ref{85a,,issubclass()} was called against it, even if it defined a custom
@code{__subclasshook__} method. The behaviour in Python 3.11 and lower –
which has now been restored – was not to raise @ref{228,,TypeError} in these
situations if a custom @code{__subclasshook__} method was defined. Patch by
Alex Waygood.

@item 
gh-96145@footnote{https://github.com/python/cpython/issues/96145}: Reverted addition of @code{json.AttrDict}.

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: Add @ref{383,,pathlib.UnsupportedOperation}, which is raised instead
of @ref{384,,NotImplementedError} when a path operation isn’t supported.

@item 
gh-105808@footnote{https://github.com/python/cpython/issues/105808}: Fix a regression introduced in gh-101251@footnote{https://github.com/python/cpython/issues/101251} for 3.12, causing
@code{gzip.GzipFile.flush()} to not flush the compressor (nor pass along
the @code{zip_mode} argument).

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @ref{fb1,,stack_effect()} no longer raises an exception if an
@code{oparg} is provided for an @code{opcode} that doesn’t use its arg, or when
it is not provided for an @code{opcode} that does use it. In the latter case,
the stack effect is returned for @code{oparg=0}.

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: Enable @ref{97c,,ast.unparse()} to unparse function and class
definitions created without the new @code{type_params} field from 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.
Patch by Jelle Zijlstra.

@item 
gh-105793@footnote{https://github.com/python/cpython/issues/105793}: Add `follow_symlinks' keyword-only argument to
@ref{38b,,pathlib.Path.is_dir()} and @ref{38a,,is_file()}, defaulting
to @code{True}.

@item 
gh-105570@footnote{https://github.com/python/cpython/issues/105570}: Deprecate two methods of creating @ref{2ce,,typing.TypedDict}
classes with 0 fields using the functional syntax: @code{TD =
TypedDict("TD")} and @code{TD = TypedDict("TD", None)}. Both will be
disallowed in Python 3.15. To create a @code{TypedDict} class with 0 fields,
either use @code{class TD(TypedDict): pass} or @code{TD = TypedDict("TD", @{@})}.

@item 
gh-105745@footnote{https://github.com/python/cpython/issues/105745}: Fix @code{webbrowser.Konqueror.open} method.

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: @ref{2b,,ctypes}: Deprecate undocumented
@code{ctypes.SetPointerType()} and @code{ctypes.ARRAY()} functions. Patch
by Victor Stinner.

@item 
gh-105687@footnote{https://github.com/python/cpython/issues/105687}: Remove deprecated @code{re.template}, @code{re.T}, @code{re.TEMPLATE},
@code{sre_constans.SRE_FLAG_TEMPLATE}.

@item 
gh-105684@footnote{https://github.com/python/cpython/issues/105684}: Supporting @ref{a6f,,asyncio.Task.set_name()} is now mandatory for
third party task implementations. The undocumented @code{_set_task_name()}
function (deprecated since 3.8) has been removed. Patch by Kumar Aditya.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix a bug in @code{_Unpickler_SetInputStream()} where an
exception could end up being overwritten in case of failure.

@item 
gh-105626@footnote{https://github.com/python/cpython/issues/105626}: Change the default return value of
@ref{1708,,http.client.HTTPConnection.get_proxy_response_headers()} to be
@code{None} and not @code{@{@}}.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @ref{d9,,sys} where exceptions could end up being
overwritten because of deferred error handling.

@item 
gh-105605@footnote{https://github.com/python/cpython/issues/105605}: Harden @code{pyexpat} error handling during module
initialisation to prevent exceptions from possibly being overwritten, and
objects from being dereferenced twice.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bug in @ref{37,,decimal} where an exception could end up being
overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @code{_datetime} where exceptions could be
overwritten in case of module initialisation failure.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @code{_ssl} initialisation which could lead to
leaked references and overwritten exceptions.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix a bug in @ref{308,,array.array} where an exception could end
up being overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @code{_ctypes} where exceptions could end up being
overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix a bug in the @ref{ad,,posix} module where an exception could
be overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @code{_elementtree} where exceptions could be
overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @ref{133,,zoneinfo} where exceptions could be
overwritten.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @ref{57,,errno} where exceptions could be overwritten.

@item 
gh-105566@footnote{https://github.com/python/cpython/issues/105566}: Deprecate creating a @ref{1db,,typing.NamedTuple} class using
keyword arguments to denote the fields (@code{NT = NamedTuple("NT", x=int,
y=str)}). This will be disallowed in Python 3.15. Use the class-based
syntax or the functional syntax instead.

Two methods of creating @code{NamedTuple} classes with 0 fields using the
functional syntax are also deprecated, and will be disallowed in Python
3.15: @code{NT = NamedTuple("NT")} and @code{NT = NamedTuple("NT", None)}. To
create a @code{NamedTuple} class with 0 fields, either use @code{class
NT(NamedTuple): pass} or @code{NT = NamedTuple("NT", [])}.

@item 
gh-105545@footnote{https://github.com/python/cpython/issues/105545}: Remove deprecated in 3.11 @code{webbrowser.MacOSXOSAScript._name}
attribute.

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: Fix flag inversion when alias/mask members exist.

@item 
gh-105509@footnote{https://github.com/python/cpython/issues/105509}: @ref{9d0,,typing.Annotated} is now implemented as an instance of
@code{typing._SpecialForm} rather than a class. This should have no
user-facing impact for users of the @ref{104,,typing} module public API.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix bugs in @ref{a6,,pickle} where exceptions could be
overwritten.

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: Emit @ref{4d4,,FutureWarning} from @ref{388,,pathlib.Path.glob()} and
@ref{389,,rglob()} if the given pattern ends with «@code{**}». In a
future Python release, patterns with this ending will match both files and
directories. Add a trailing slash to only match directories.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix a bug in @ref{cf,,sqlite3} where an exception could be
overwritten in the @ref{717,,collation}
callback.

@item 
gh-105382@footnote{https://github.com/python/cpython/issues/105382}: Remove `cafile', `capath' and `cadefault' parameters of the
@ref{20a,,urllib.request.urlopen()} function, deprecated in Python 3.6. Patch
by Victor Stinner.

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: @ref{87,,logging}: Remove undocumented and untested
@code{Logger.warn()} and @code{LoggerAdapter.warn()} methods and
@code{logging.warn()} function. Deprecated since Python 3.3, they were
aliases to the @ref{1709,,logging.Logger.warning()} method,
@code{logging.LoggerAdapter.warning()} method and @ref{1f7,,logging.warning()}
function. Patch by Victor Stinner.

@item 
gh-105332@footnote{https://github.com/python/cpython/issues/105332}: Revert pickling method from by-name back to by-value.

@item 
gh-104554@footnote{https://github.com/python/cpython/issues/104554}: Add RTSPS scheme support in urllib.parse

@item 
gh-105292@footnote{https://github.com/python/cpython/issues/105292}: Add option to @ref{8e5,,traceback.format_exception_only()} to
recurse into the nested exception of a @ref{3b6,,BaseExceptionGroup}.

@item 
gh-105280@footnote{https://github.com/python/cpython/issues/105280}: Fix bug where @code{isinstance([], collections.abc.Mapping)} could
evaluate to @code{True} if garbage collection happened at the wrong time. The
bug was caused by changes to the implementation of
@ref{3bb,,typing.Protocol} in Python 3.12.

@item 
gh-80480@footnote{https://github.com/python/cpython/issues/80480}: @ref{8,,array}: Add @code{'w'} typecode that represents @code{Py_UCS4}.

@item 
gh-105239@footnote{https://github.com/python/cpython/issues/105239}: Fix longstanding bug where @code{issubclass(object,
typing.Protocol)} would evaluate to @code{True} in some edge cases. Patch by
Alex Waygood.

@item 
gh-104310@footnote{https://github.com/python/cpython/issues/104310}: In the beta 1 release we added a utility function for extension
module authors, to use when testing their module for support in multiple
interpreters or under a per-interpreter GIL.  The name of that function
has changed from @code{allowing_all_extensions} to
@code{_incompatible_extension_module_restrictions}.  The default for the
«disable_check» argument has change from @code{True} to @code{False}, to better
match the new function name.

@item 
gh-105080@footnote{https://github.com/python/cpython/issues/105080}: Fixed inconsistent signature on derived classes for
@ref{181,,inspect.signature()}

@item 
gh-105144@footnote{https://github.com/python/cpython/issues/105144}: Fix a recent regression in the @ref{104,,typing} module. The
regression meant that doing @code{class Foo(X, typing.Protocol)}, where @code{X}
was a class that had @ref{f9b,,abc.ABCMeta} as its metaclass, would then
cause subsequent @code{isinstance(1, X)} calls to erroneously raise
@ref{228,,TypeError}. Patch by Alex Waygood.

@item 
gh-62948@footnote{https://github.com/python/cpython/issues/62948}: The @ref{353,,io.IOBase} finalizer now logs the @code{close()} method
errors with @ref{355,,sys.unraisablehook}. Previously, errors were ignored
silently by default, and only logged in @ref{356,,Python Development Mode} or on @ref{357,,Python built on debug mode}.  Patch
by Victor Stinner.

@item 
gh-105096@footnote{https://github.com/python/cpython/issues/105096}: @ref{113,,wave}: Deprecate the @code{getmark()}, @code{setmark()} and
@code{getmarkers()} methods of the @ref{1df,,wave.Wave_read} and
@ref{1e0,,wave.Wave_write} classes. They will be removed in Python 3.15.
Patch by Victor Stinner.

@item 
gh-104992@footnote{https://github.com/python/cpython/issues/104992}: Remove the untested and undocumented
@code{unittest.TestProgram.usageExit()} method, deprecated in Python 3.11.
Patch by Hugo van Kemenade.

@item 
gh-104996@footnote{https://github.com/python/cpython/issues/104996}: Improve performance of @ref{54e,,pathlib.PurePath} initialisation
by deferring joining of paths when multiple arguments are given.

@item 
gh-101588@footnote{https://github.com/python/cpython/issues/101588}: Deprecate undocumented copy/deepcopy/pickle support for
itertools.

@item 
gh-103631@footnote{https://github.com/python/cpython/issues/103631}: Fix @code{pathlib.PurePosixPath(pathlib.PureWindowsPath(...))} not
converting path separators to restore 3.11 compatible behavior.

@item 
gh-104947@footnote{https://github.com/python/cpython/issues/104947}: Make comparisons between @ref{170a,,pathlib.PureWindowsPath}
objects consistent across Windows and Posix to match 3.11 behavior.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{audioop} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{aifc} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{uu} module, deprecated in Python
3.11. Patch by Victor Stinner.

@item 
gh-104935@footnote{https://github.com/python/cpython/issues/104935}: Fix bugs with the interaction between
@ref{4f0,,typing.runtime_checkable()} and @ref{15f6,,typing.Generic} that were
introduced by the 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} implementation. Patch by Jelle Zijlstra.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{crypt} module and its private
@code{_crypt} extension, deprecated in Python 3.11. Patch by Victor
Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{nis} module, deprecated in Python
3.11. Patch by Victor Stinner.

@item 
gh-104898@footnote{https://github.com/python/cpython/issues/104898}: Add missing @ref{152a,,__slots__} to @ref{cd9,,os.PathLike}.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{xdrlib} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{nntplib} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104886@footnote{https://github.com/python/cpython/issues/104886}: Remove the undocumented
@code{configparser.LegacyInterpolation} class, deprecated in the
docstring since Python 3.2, and with a deprecation warning since Python
3.11. Patch by Hugo van Kemenade.

@item 
gh-104786@footnote{https://github.com/python/cpython/issues/104786}: Remove kwargs-based @ref{2ce,,typing.TypedDict} creation

@item 
gh-104876@footnote{https://github.com/python/cpython/issues/104876}: Remove the @code{turtle.RawTurtle.settiltangle()} method,
deprecated in docs since Python 3.1 and with a deprecation warning since
Python 3.11. Patch by Hugo van Kemenade.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Removed the @code{msilib} package, deprecated in
Python 3.11.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{spwd} module, deprecated in
Python 3.11: the python-pam@footnote{https://pypi.org/project/python-pam/} project can be used instead. Patch by
Victor Stinner.

@item 
gh-75552@footnote{https://github.com/python/cpython/issues/75552}: Removed the @code{tkinter.tix} module, deprecated since Python 3.6.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{chunk} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{mailcap} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{sunau} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104780@footnote{https://github.com/python/cpython/issues/104780}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{ossaudiodev} module, deprecated
in Python 3.11. Patch Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{pipes} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104873@footnote{https://github.com/python/cpython/issues/104873}: Add @ref{3ba,,typing.get_protocol_members()} to return the set of
members defining a @ref{3bb,,typing.Protocol}.  Add
@ref{3bc,,typing.is_protocol()} to check whether a class is a
@ref{3bb,,typing.Protocol}. Patch by Jelle Zijlstra.

@item 
gh-104874@footnote{https://github.com/python/cpython/issues/104874}: Document the @code{__name__} and @code{__supertype__} attributes of
@ref{d7c,,typing.NewType}. Patch by Jelle Zijlstra.

@item 
gh-104835@footnote{https://github.com/python/cpython/issues/104835}: Removed the following @ref{106,,unittest} functions, deprecated in
Python 3.11:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Use @ref{3e2,,TestLoader} methods instead:


@itemize *

@item 
@ref{3e3,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{3e4,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{3e5,,unittest.TestLoader.getTestCaseNames()}
@end itemize

Patch by Hugo van Kemenade.

@item 
gh-104804@footnote{https://github.com/python/cpython/issues/104804}: Remove the untested and undocumented @ref{115,,webbrowser}
@code{MacOSX} class, deprecated in Python 3.11. Patch by Hugo van
Kemenade.

@item 
gh-83863@footnote{https://github.com/python/cpython/issues/83863}: Support for using @ref{19b,,pathlib.Path} objects as context
managers has been removed. Before Python 3.9, exiting the context manager
marked a path as «closed», which caused some (but not all!) methods to
raise when called. Since Python 3.9, using a path as a context manager
does nothing.

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: Adjust the location of the (see 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}) @code{type_params}
field on @ref{170b,,ast.ClassDef}, @ref{170c,,ast.AsyncFunctionDef}, and
@ref{170d,,ast.FunctionDef} to better preserve backward compatibility. Patch
by Jelle Zijlstra

@item 
gh-104797@footnote{https://github.com/python/cpython/issues/104797}: Allow @ref{3bb,,typing.Protocol} classes to inherit from
@ref{3fe,,collections.abc.Buffer}. Patch by Jelle Zijlstra.

@item 
gh-104783@footnote{https://github.com/python/cpython/issues/104783}: Remove @code{locale.resetlocale()} function deprecated in Python
3.11. Patch by Victor Stinner.

@item 
gh-104780@footnote{https://github.com/python/cpython/issues/104780}: Remove the @code{2to3} program and the @code{lib2to3} module,
deprecated in Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{telnetlib} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{imghdr} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{cgi} and @code{cgitb} modules,
deprecated in Python 3.11. Patch by Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove the @code{sndhdr} module, deprecated in
Python 3.11. Patch by Victor Stinner.

@item 
gh-104372@footnote{https://github.com/python/cpython/issues/104372}: On Linux where @ref{d6,,subprocess} can use the @code{vfork()}
syscall for faster spawning, prevent the parent process from blocking
other threads by dropping the GIL while it waits for the vfork’ed child
process @code{exec()} outcome. This prevents spawning a binary from a slow
filesystem from blocking the rest of the application.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: We now release the GIL around built-in @ref{68,,hashlib}
computations of reasonable size for the SHA families and MD5 hash
functions, matching what our OpenSSL backed hash computations already
does.

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: Improve performance of @ref{388,,pathlib.Path.glob()} when expanding
a pattern with a non-terminal «@code{**}» component by filtering walked paths
through a regular expression, rather than calling @ref{1a2,,os.scandir()} more
than once on each directory.

@item 
gh-104399@footnote{https://github.com/python/cpython/issues/104399}: Prepare the @code{_tkinter} module for building with Tcl 9.0 and
future libtommath by replacing usage of deprecated functions
@code{mp_to_unsigned_bin_n()} and @code{mp_unsigned_bin_size()} when
necessary.

@item 
gh-102676@footnote{https://github.com/python/cpython/issues/102676}: Add fields @code{start_offset}, @code{cache_offset}, @code{end_offset},
@code{baseopname}, @code{baseopcode}, @code{jump_target} and @code{oparg} to
@ref{170,,dis.Instruction}.

@item 
gh-103558@footnote{https://github.com/python/cpython/issues/103558}: Fixed @code{parent} argument validation mechanism of
@ref{7,,argparse}. Improved test coverage.

@item 
gh-103464@footnote{https://github.com/python/cpython/issues/103464}: Provide helpful usage messages when parsing incorrect
@ref{a5,,pdb} commands.

@item 
gh-103384@footnote{https://github.com/python/cpython/issues/103384}: Generalize the regex pattern @code{BaseConfigurator.INDEX_PATTERN}
to allow spaces and non-alphanumeric characters in keys.

@item 
gh-103124@footnote{https://github.com/python/cpython/issues/103124}: Added multiline statement support for @ref{a5,,pdb}

@item 
gh-101162@footnote{https://github.com/python/cpython/issues/101162}: Forbid using @code{builtins.issubclass()} with
@ref{882,,types.GenericAlias} as the first argument.

@item 
gh-103200@footnote{https://github.com/python/cpython/issues/103200}: Fix cache repopulation semantics of
zipimport.invalidate_caches(). The cache is now repopulated upon
retrieving files with an invalid cache, not when the cache is invalidated.

@item 
gh-100061@footnote{https://github.com/python/cpython/issues/100061}: Fix a bug that causes wrong matches for regular expressions
with possessive qualifier.

@item 
gh-77609@footnote{https://github.com/python/cpython/issues/77609}: Add `follow_symlinks' argument to @ref{388,,pathlib.Path.glob()} and
@ref{389,,rglob()}, defaulting to false.

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: Hide traceback in @ref{96e,,help()} prompt, when import failed.

@item 
gh-102120@footnote{https://github.com/python/cpython/issues/102120}: Added a stream mode to @code{tarfile} that allows for reading
archives without caching info about the inner files.

@item 
gh-102029@footnote{https://github.com/python/cpython/issues/102029}: Deprecate passing any arguments to @ref{1d7,,threading.RLock()}.

@item 
gh-88233@footnote{https://github.com/python/cpython/issues/88233}: Refactored @code{zipfile._strip_extra} to use higher level
abstractions for extras instead of a heavy-state loop.

@item 
gh-102024@footnote{https://github.com/python/cpython/issues/102024}: Reduce calls of @code{_idle_semaphore.release()} in
@code{concurrent.futures.thread._worker()}.

@item 
gh-73435@footnote{https://github.com/python/cpython/issues/73435}: Add support for recursive wildcards in
@ref{554,,pathlib.PurePath.match()}.

@item 
gh-84867@footnote{https://github.com/python/cpython/issues/84867}: @ref{3e2,,unittest.TestLoader} no longer loads test cases from
exact @ref{4fa,,unittest.TestCase} and @ref{170e,,unittest.FunctionTestCase}
classes.

@item 
gh-99203@footnote{https://github.com/python/cpython/issues/99203}: Restore following CPython <= 3.10.5 behavior of
@ref{55a,,shutil.make_archive()}: do not create an empty archive if
@code{root_dir} is not a directory, and, in that case, raise
@ref{f46,,FileNotFoundError} or @ref{10d6,,NotADirectoryError} regardless of
@code{format} choice. Beyond the brought-back behavior, the function may now
also raise these exceptions in @code{dry_run} mode.

@item 
gh-80480@footnote{https://github.com/python/cpython/issues/80480}: Emit @ref{1da,,DeprecationWarning} for @ref{8,,array}’s @code{'u'} type
code, deprecated in docs since Python 3.3.

@item 
gh-94924@footnote{https://github.com/python/cpython/issues/94924}: @ref{15c9,,unittest.mock.create_autospec()} now properly returns
coroutine functions compatible with @ref{1c3,,inspect.iscoroutinefunction()}

@item 
gh-94777@footnote{https://github.com/python/cpython/issues/94777}: Fix hanging @ref{94,,multiprocessing} @code{ProcessPoolExecutor} when
a child process crashes while data is being written in the call queue.

@item 
gh-92871@footnote{https://github.com/python/cpython/issues/92871}: Remove the @code{typing.io} and @code{typing.re} namespaces,
deprecated since Python 3.8. All items are still available from the main
@ref{104,,typing} module.

@item 
bpo-43633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43633}: Improve the textual representation of IPv4-mapped IPv6
addresses (
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} Sections 2.2, 2.5.5.2) in @ref{80,,ipaddress}. Patch
by Oleksandr Pavliuk.

@item 
bpo-44850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44850}: Improve performance of @ref{eb9,,operator.methodcaller()} using the
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} convention. Patch by Anthony Lee and Pieter
Eendebak.

@item 
bpo-44185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44185}: @ref{170f,,unittest.mock.mock_open()} will call the @code{close()}
method of the file handle mock when it is exiting from the context
manager. Patch by Samet Yaslan.

@item 
bpo-40988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40988}: Improve performance of @ref{a82,,functools.singledispatchmethod}
by caching the generated dispatch wrapper. Optimization suggested by
frederico. Patch by @@mental32, Alex Waygood and Pieter Eendebak.

@item 
bpo-41768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41768}: @ref{107,,unittest.mock} speccing no longer calls class properties.
Patch by Melanie Witt.

@item 
bpo-18319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18319}: Ensure @code{gettext(msg)} retrieve translations even if a plural
form exists. In other words: @code{gettext(msg) == ngettext(msg, '@w{'}, 1)}.

@item 
bpo-17013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17013}: Add @code{ThreadingMock} to @ref{107,,unittest.mock} that can be used
to create Mock objects that can wait until they are called. Patch by
Karthikeyan Singaravelan and Mario Corchero.
@end itemize

@node Documentation<8>,Tests<8>,Library<9>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id71}@anchor{1710}
@subsubsection Documentation



@itemize -

@item 
gh-109209@footnote{https://github.com/python/cpython/issues/109209}: The minimum Sphinx version required for the documentation is
now 4.2.

@item 
gh-108826@footnote{https://github.com/python/cpython/issues/108826}: @ref{39,,dis} module command-line interface is now mentioned in
documentation.

@item 
gh-107305@footnote{https://github.com/python/cpython/issues/107305}: Add documentation for @ref{611,,PyInterpreterConfig} and
@ref{507,,Py_NewInterpreterFromConfig()}.  Also clarify some of the nearby
docs relative to per-interpreter GIL.

@item 
gh-107008@footnote{https://github.com/python/cpython/issues/107008}: Document the @ref{2c,,curses} module variables
@ref{1711,,LINES} and @ref{1712,,COLS}.

@item 
gh-106948@footnote{https://github.com/python/cpython/issues/106948}: Add a number of standard external names to @code{nitpick_ignore}.

@item 
gh-106232@footnote{https://github.com/python/cpython/issues/106232}: Make timeit doc command lines compatible with Windows by using
double quotes for arguments.  This works on linux and macOS also.

@item 
gh-105172@footnote{https://github.com/python/cpython/issues/105172}: Fixed @ref{a81,,functools.lru_cache()} docstring accounting for
@code{typed} argument’s different handling of str and int. Patch by Bar
Harel.

@item 
gh-105052@footnote{https://github.com/python/cpython/issues/105052}: Update @code{timeit} doc to specify that time in seconds is just
the default.

@item 
gh-89455@footnote{https://github.com/python/cpython/issues/89455}: Add missing documentation for the @code{max_group_depth} and
@code{max_group_width} parameters and the @code{exceptions} attribute of the
@ref{3b3,,traceback.TracebackException} class.

@item 
gh-89412@footnote{https://github.com/python/cpython/issues/89412}: Add missing documentation for the @code{end_lineno} and
@code{end_offset} attributes of the @ref{3b3,,traceback.TracebackException}
class.

@item 
gh-104943@footnote{https://github.com/python/cpython/issues/104943}: Remove mentions of old Python versions in
@ref{1db,,typing.NamedTuple}.

@item 
gh-54738@footnote{https://github.com/python/cpython/issues/54738}: Add documentation on how to localize the @ref{7,,argparse} module.

@item 
gh-102823@footnote{https://github.com/python/cpython/issues/102823}: Document the return type of @code{x // y} when @code{x} and @code{y}
have type @ref{153,,float}.

@item 
gh-102759@footnote{https://github.com/python/cpython/issues/102759}: Align function signature for @code{functools.reduce} in
documentation and docstring with the C implementation.
@end itemize

@node Tests<8>,Build<9>,Documentation<8>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id72}@anchor{1713}
@subsubsection Tests



@itemize -

@item 
gh-110647@footnote{https://github.com/python/cpython/issues/110647}: Fix test_stress_modifying_handlers() of test_signal. Patch by
Victor Stinner.

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: Fix test_tools.test_freeze on FreeBSD: run «make distclean»
instead of «make clean» in the copied source directory to remove also the
«python» program. Patch by Victor Stinner.

@item 
gh-110167@footnote{https://github.com/python/cpython/issues/110167}: Fix a deadlock in test_socket when server fails with a timeout
but the client is still running in its thread. Don’t hold a lock to call
cleanup functions in doCleanups(). One of the cleanup function waits until
the client completes, whereas the client could deadlock if it called
addCleanup() in such situation. Patch by Victor Stinner.

@item 
gh-110388@footnote{https://github.com/python/cpython/issues/110388}: Add tests for @ref{100,,tty}.

@item 
gh-81002@footnote{https://github.com/python/cpython/issues/81002}: Add tests for @ref{e1,,termios}.

@item 
gh-110367@footnote{https://github.com/python/cpython/issues/110367}: regrtest: When using worker processes (-jN) with –verbose3
option, regrtest can now display the worker output even if a worker
process does crash. Previously, sys.stdout and sys.stderr were replaced
and so the worker output was lost on a crash. Patch by Victor Stinner.

@item 
gh-110267@footnote{https://github.com/python/cpython/issues/110267}: Add tests for pickling and copying PyStructSequence objects.
Patched by Xuehai Pan.

@item 
gh-110171@footnote{https://github.com/python/cpython/issues/110171}: @code{libregrtest} now always sets and shows @code{random.seed}, so
tests are more reproducible. Use @code{--randseed} flag to pass the explicit
random seed for tests.

@item 
gh-110152@footnote{https://github.com/python/cpython/issues/110152}: Remove @code{Tools/scripts/run_tests.py} and @code{make
hostrunnertest}. Just run @code{./python -m test --slow-ci}, @code{make
buildbottest} or @code{make test} instead. Python test runner (regrtest) now
handles cross-compilation and HOSTRUNNER. It also adds options to Python
such fast @code{-u -E -W default -bb} when @code{--fast-ci} or @code{--slow-ci}
option is used. Patch by Victor Stinner.

@item 
gh-110031@footnote{https://github.com/python/cpython/issues/110031}: Skip test_threading tests using thread+fork if Python is built
with Address Sanitizer (ASAN). Patch by Victor Stinner.

@item 
gh-110088@footnote{https://github.com/python/cpython/issues/110088}: Fix test_asyncio timeouts: don’t measure the maximum duration,
a test should not measure a CI performance. Only measure the minimum
duration when a task has a timeout or delay. Add @code{CLOCK_RES} to
@code{test_asyncio.utils}. Patch by Victor Stinner.

@item 
gh-109974@footnote{https://github.com/python/cpython/issues/109974}: Fix race conditions in test_threading lock tests. Wait until a
condition is met rather than using @ref{73e,,time.sleep()} with a hardcoded
number of seconds. Patch by Victor Stinner.

@item 
gh-110033@footnote{https://github.com/python/cpython/issues/110033}: Fix @code{test_interprocess_signal()} of @code{test_signal}. Make
sure that the @code{subprocess.Popen} object is deleted before the test
raising an exception in a signal handler. Otherwise, @code{Popen.__del__()}
can get the exception which is logged as @code{Exception ignored in: ...} and
the test fails. Patch by Victor Stinner.

@item 
gh-109594@footnote{https://github.com/python/cpython/issues/109594}: Fix test_timeout() of test_concurrent_futures.test_wait. Remove
the future which may or may not complete depending if it takes longer than
the timeout or not. Keep the second future which does not complete before
wait() timeout. Patch by Victor Stinner.

@item 
gh-109972@footnote{https://github.com/python/cpython/issues/109972}: Split test_gdb.py file into a test_gdb package made of multiple
tests, so tests can now be run in parallel. Patch by Victor Stinner.

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: regrtest: When @code{--fast-ci} or @code{--slow-ci} option is used,
regrtest now replaces the current process with a new process to add @code{-u
-W default -bb -E} options to Python. Patch by Victor Stinner.

@item 
gh-109748@footnote{https://github.com/python/cpython/issues/109748}: Fix @code{test_zippath_from_non_installed_posix()} of test_venv:
don’t copy @code{__pycache__/} sub-directories, because they can be modified
by other Python tests running in parallel. Patch by Victor Stinner.

@item 
gh-109739@footnote{https://github.com/python/cpython/issues/109739}: regrtest: Fix reference leak check on Windows. Disable the load
tracker on Windows in the reference leak check mode (-R option). Patch by
Victor Stinner.

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: regrtest: When a test fails with «env changed» and the –rerun
option is used, the test is now re-run in verbose mode in a fresh process.
Patch by Victor Stinner.

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: Skip test_freeze_simple_script() of test_tools.test_freeze if
Python is built with @code{./configure --enable-optimizations}, which means
with Profile Guided Optimization (PGO): it just makes the test too slow.
The freeze tool is tested by many other CIs with other (faster) compiler
flags. Patch by Victor Stinner.

@item 
gh-109580@footnote{https://github.com/python/cpython/issues/109580}: Skip @code{test_perf_profiler} if Python is built with ASAN, MSAN
or UBSAN sanitizer. Python does crash randomly in this test on such build.
Patch by Victor Stinner.

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: regrtest: Add @code{--fast-ci} and @code{--slow-ci} options.
@code{--fast-ci} uses a default timeout of 10 minutes and @code{-u all,-cpu}
(skip slowest tests). @code{--slow-ci} uses a default timeout of 20 minutes
and @code{-u all} (run all tests). Patch by Victor Stinner.

@item 
gh-109425@footnote{https://github.com/python/cpython/issues/109425}: libregrtest now decodes stdout of test worker processes with
the «backslashreplace» error handler to log corrupted stdout, instead of
failing with an error and not logging the stdout. Patch by Victor Stinner.

@item 
gh-109396@footnote{https://github.com/python/cpython/issues/109396}: Fix @code{test_socket.test_hmac_sha1()} in FIPS mode. Use a longer
key: FIPS mode requires at least of at least 112 bits. The previous key
was only 32 bits. Patch by Victor Stinner.

@item 
gh-104736@footnote{https://github.com/python/cpython/issues/104736}: Fix test_gdb on Python built with LLVM clang 16 on Linux
ppc64le (ex: Fedora 38). Search patterns in gdb «bt» command output to
detect when gdb fails to retrieve the traceback. For example, skip a test
if @code{Backtrace stopped: frame did not save the PC} is found. Patch by
Victor Stinner.

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: libregrtest now calls @ref{12e1,,random.seed()} before running each
test file when @code{-r/--randomize} command line option is used. Moreover,
it’s also called in worker processes.  It should help to make tests more
deterministic. Previously, it was only called once in the main process
before running all test files and it was not called in worker processes.
Patch by Victor Stinner.

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: libregrtest now uses a separated file descriptor to write test
result as JSON. Previously, if a test wrote debug messages late around the
JSON, the main test process failed to parse JSON. Patch by Victor Stinner.

@item 
gh-108996@footnote{https://github.com/python/cpython/issues/108996}: Fix and enable @code{test_msvcrt}.

@item 
gh-109237@footnote{https://github.com/python/cpython/issues/109237}: Fix @code{test_site.test_underpth_basic()} when the working
directory contains at least one non-ASCII character: encode the @code{._pth}
file to UTF-8 and enable the UTF-8 Mode to use UTF-8 for the child process
stdout. Patch by Victor Stinner.

@item 
gh-109230@footnote{https://github.com/python/cpython/issues/109230}: Fix @code{test_pyexpat.test_exception()}: it can now be run from a
directory different than Python source code directory. Before, the test
failed in this case.  Skip the test if Modules/pyexpat.c source is not
available. Skip also the test on Python implementations other than
CPython. Patch by Victor Stinner.

@item 
gh-108996@footnote{https://github.com/python/cpython/issues/108996}: Add tests for @code{msvcrt}.

@item 
gh-109015@footnote{https://github.com/python/cpython/issues/109015}: Fix test_asyncio, test_imaplib and test_socket tests on FreeBSD
if the TCP blackhole is enabled (@code{sysctl net.inet.tcp.blackhole}). Skip
the few tests which failed with @code{ETIMEDOUT} which such non standard
configuration. Currently, the FreeBSD GCP image enables TCP and UDP blackhole@footnote{https://reviews.freebsd.org/D41751} (@code{sysctl
net.inet.tcp.blackhole=2} and @code{sysctl net.inet.udp.blackhole=1}).
Patch by Victor Stinner.

@item 
gh-91960@footnote{https://github.com/python/cpython/issues/91960}: Skip @code{test_gdb} if gdb is unable to retrieve Python frame
objects: if a frame is @code{<optimized out>}. When Python is built with
«clang -Og», gdb can fail to retrieve the `frame' parameter of
@code{_PyEval_EvalFrameDefault()}. In this case, tests like @code{py_bt()} are
likely to fail. Without getting access to Python frames, @code{python-gdb.py}
is mostly clueless on retrieving the Python traceback. Moreover,
@code{test_gdb} is no longer skipped on macOS if Python is built with Clang.
Patch by Victor Stinner.

@item 
gh-108962@footnote{https://github.com/python/cpython/issues/108962}: Skip @code{test_tempfile.test_flags()} if @code{chflags()} fails with
«OSError: [Errno 45] Operation not supported» (ex: on FreeBSD 13). Patch
by Victor Stinner.

@item 
gh-91960@footnote{https://github.com/python/cpython/issues/91960}: FreeBSD 13.2 CI coverage for pull requests is now provided by
Cirrus-CI (a hosted CI service that supports Linux, macOS, Windows, and
FreeBSD).

@item 
gh-89392@footnote{https://github.com/python/cpython/issues/89392}: Removed support of @code{test_main()} function in tests. They now
always use normal unittest test runner.

@item 
gh-108851@footnote{https://github.com/python/cpython/issues/108851}: Fix @code{test_tomllib} recursion tests for WASI buildbots: reduce
the recursion limit and compute the maximum nested array/dict depending on
the current available recursion limit. Patch by Victor Stinner.

@item 
gh-108851@footnote{https://github.com/python/cpython/issues/108851}: Add @code{get_recursion_available()} and @code{get_recursion_depth()}
functions to the @ref{e4,,test.support} module. Patch by Victor Stinner.

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: Add @code{--fail-rerun option} option to regrtest: if a test
failed when then passed when rerun in verbose mode, exit the process with
exit code 2 (error), instead of exit code 0 (success). Patch by Victor
Stinner.

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: Rename regrtest @code{--verbose2} option (@code{-w}) to @code{--rerun}.
Keep @code{--verbose2} as a deprecated alias. Patch by Victor Stinner.

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: When regrtest reruns failed tests in verbose mode (@code{./python
-m test --rerun}), tests are now rerun in fresh worker processes rather
than being executed in the main process. If a test does crash or is killed
by a timeout, the main process can detect and handle the killed worker
process. Tests are rerun in parallel if the @code{-jN} option is used to run
tests in parallel. Patch by Victor Stinner.

@item 
gh-108822@footnote{https://github.com/python/cpython/issues/108822}: @code{regrtest} now computes statistics on all tests: successes,
failures and skipped. @code{test_netrc}, @code{test_pep646_syntax} and
@code{test_xml_etree} now return results in their @code{test_main()} function.
Patch by Victor Stinner and Alex Waygood.

@item 
gh-108794@footnote{https://github.com/python/cpython/issues/108794}: The @ref{33f,,doctest.DocTestRunner.run()} method now counts the
number of skipped tests. Add @ref{340,,doctest.DocTestRunner.skips} and
@ref{341,,doctest.TestResults.skipped} attributes. Patch by Victor Stinner.

@item 
gh-108388@footnote{https://github.com/python/cpython/issues/108388}: Convert test_concurrent_futures to a package of 7 sub-tests.
Patch by Victor Stinner.

@item 
gh-108388@footnote{https://github.com/python/cpython/issues/108388}: Split test_multiprocessing_fork,
test_multiprocessing_forkserver and test_multiprocessing_spawn into test
packages. Each package is made of 4 sub-tests: processes, threads, manager
and misc. It allows running more tests in parallel and so reduce the total
test duration. Patch by Victor Stinner.

@item 
gh-105776@footnote{https://github.com/python/cpython/issues/105776}: Fix test_cppext when the C compiler command @code{-std=c11}
option: remove @code{-std=} options from the compiler command. Patch by
Victor Stinner.

@item 
gh-107652@footnote{https://github.com/python/cpython/issues/107652}: Set up CIFuzz to run fuzz targets in GitHub Actions. Patch by
Illia Volochii.

@item 
gh-107237@footnote{https://github.com/python/cpython/issues/107237}: @code{test_logging}: Fix @code{test_udp_reconnection()} by increasing
the timeout from 100 ms to 5 minutes (LONG_TIMEOUT). Patch by Victor
Stinner.

@item 
gh-107178@footnote{https://github.com/python/cpython/issues/107178}: Add the C API test for functions in the Mapping Protocol, the
Sequence Protocol and some functions in the Object Protocol.

@item 
gh-106714@footnote{https://github.com/python/cpython/issues/106714}: test_capi: Fix test_no_FatalError_infinite_loop() to no longer
write a coredump, by using test.support.SuppressCrashReport. Patch by
Victor Stinner.

@item 
gh-104090@footnote{https://github.com/python/cpython/issues/104090}: Avoid creating a reference to the test object in
@ref{1714,,collectedDurations()}.

@item 
gh-106752@footnote{https://github.com/python/cpython/issues/106752}: Moved tests for @code{zipfile.Path} into
@code{Lib/test/test_zipfile/_path}. Made @code{zipfile._path} a package.

@item 
gh-106690@footnote{https://github.com/python/cpython/issues/106690}: Add .coveragerc to cpython repository for use with coverage
package.

@item 
gh-101634@footnote{https://github.com/python/cpython/issues/101634}: When running the Python test suite with @code{-jN} option, if a
worker stdout cannot be decoded from the locale encoding report a failed
testn so the exitcode is non-zero. Patch by Victor Stinner.

@item 
gh-105084@footnote{https://github.com/python/cpython/issues/105084}: When the Python build is configured @code{--with-wheel-pkg-dir},
tests requiring the @code{setuptools} and @code{wheel} wheels will search for
the wheels in @code{WHEEL_PKG_DIR}.

@item 
gh-81005@footnote{https://github.com/python/cpython/issues/81005}: String tests are modified to reflect that @code{str} and
@code{unicode} are merged in Python 3. Patch by Daniel Fortunov.

@item 
gh-103186@footnote{https://github.com/python/cpython/issues/103186}: Suppress and assert expected RuntimeWarnings in
test_sys_settrace.py

@item 
gh-69714@footnote{https://github.com/python/cpython/issues/69714}: Add additional tests to @ref{15,,calendar} to achieve full test
coverage.
@end itemize

@node Build<9>,Windows<9>,Tests<8>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id73}@anchor{1715}
@subsubsection Build



@itemize -

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: «make check-clean-src» now also checks if the «python» program
is found in the source directory: fail with an error if it does exist.
Patch by Victor Stinner.

@item 
gh-109191@footnote{https://github.com/python/cpython/issues/109191}: Fix compile error when building with recent versions of
libedit.

@item 
gh-110276@footnote{https://github.com/python/cpython/issues/110276}: No longer ignore 
@geindex PROFILE_TASK
@geindex variables de entorno; PROFILE_TASK
@ref{1716,,PROFILE_TASK} failure silently:
command used by Profile Guided Optimization (PGO). Patch by Victor
Stinner.

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: Remove @code{make testall} target: use @code{make buildbottest}
instead. Patch by Victor Stinner.

@item 
gh-109740@footnote{https://github.com/python/cpython/issues/109740}: The experimental @code{--disable-gil} configure flag now includes
«t» (for «threaded») in extension ABI tags.

@item 
gh-109054@footnote{https://github.com/python/cpython/issues/109054}: Fix building the @code{_testcapi} extension on Linux AArch64 which
requires linking to libatomic when @code{<cpython/pyatomic.h>} is used: the
@code{_Py_atomic_or_uint64()} function requires libatomic
@code{__atomic_fetch_or_8()} on this platform. The configure script now
checks if linking to libatomic is needed and generates a new LIBATOMIC
variable used to build the _testcapi extension. Patch by Victor Stinner.

@item 
gh-63760@footnote{https://github.com/python/cpython/issues/63760}: Fix Solaris build: no longer redefine the @code{gethostname()}
function. Solaris defines the function since 2005. Patch by Victor
Stinner, original patch by Jakub Kulík.

@item 
gh-108740@footnote{https://github.com/python/cpython/issues/108740}: Fix a race condition in @code{make regen-all}. The
@code{deepfreeze.c} source and files generated by Argument Clinic are now
generated or updated before generating «global objects». Previously, some
identifiers may miss depending on the order in which these files were
generated. Patch by Victor Stinner.

@item 
gh-108634@footnote{https://github.com/python/cpython/issues/108634}: Python built with @code{configure} @ref{487,,--with-trace-refs}
(tracing references) is now ABI compatible with Python release build and
@ref{357,,debug build}. Patch by Victor Stinner.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: The @code{_stat} C extension is now built with the @ref{488,,limited C API}. Patch by Victor Stinner.

@item 
gh-108447@footnote{https://github.com/python/cpython/issues/108447}: Fix x86_64 GNU/Hurd build

@item 
gh-107814@footnote{https://github.com/python/cpython/issues/107814}: When calling @code{find_python.bat} with @code{-q} it did not
properly silence the output of nuget. That is now fixed.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: Remove the make target @code{regen-opcode-targets}, merge its work
into @code{regen-opcode} which repeats most of the calculation. This
simplifies the code for the build and reduces code duplication.

@item 
gh-106881@footnote{https://github.com/python/cpython/issues/106881}: Check for @code{linux/limits.h} before including it in
@code{Modules/posixmodule.c}.

@item 
gh-95855@footnote{https://github.com/python/cpython/issues/95855}: Refactor platform triplet detection code and add detection for
MIPS soft float and musl libc.

@item 
gh-106962@footnote{https://github.com/python/cpython/issues/106962}: Detect MPI compilers in @code{configure}.

@item 
gh-106118@footnote{https://github.com/python/cpython/issues/106118}: Fix compilation for platforms without @code{O_CLOEXEC}. The
issue was introduced with Python 3.12b1 in gh-103295@footnote{https://github.com/python/cpython/issues/103295}. Patch by Erlend
Aasland.

@item 
gh-105875@footnote{https://github.com/python/cpython/issues/105875}: SQLite 3.15.2 or newer is required to build the @ref{cf,,sqlite3}
extension module. Patch by Erlend Aasland.

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: Fix a regression in @code{configure} where we could end up
unintentionally linking with @code{libbsd}.

@item 
gh-102404@footnote{https://github.com/python/cpython/issues/102404}: Document how to perform a WASI build on Linux. Also add
Tools/wasm/build_wasi.sh as a reference implementation of the docs.

@item 
gh-89886@footnote{https://github.com/python/cpython/issues/89886}: Autoconf 2.71 and aclocal 1.16.4 is now required to regenerate
@code{!configure}.

@item 
gh-104692@footnote{https://github.com/python/cpython/issues/104692}: Include @code{commoninstall} as a prerequisite for @code{bininstall}

This ensures that @code{commoninstall} is completed before @code{bininstall} is
started when parallel builds are used (@code{make -j install}), and so the
@code{python3} symlink is only installed after all standard library modules
are installed.

@item 
gh-101538@footnote{https://github.com/python/cpython/issues/101538}: Add experimental wasi-threads support. Patch by Takashi
Yamamoto.
@end itemize

@node Windows<9>,macOS<7>,Build<9>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id74}@anchor{1717}
@subsubsection Windows



@itemize -

@item 
gh-110437@footnote{https://github.com/python/cpython/issues/110437}: Allows overriding the source of VC redistributables so that
releases can be guaranteed to never downgrade between updates.

@item 
gh-109286@footnote{https://github.com/python/cpython/issues/109286}: Update Windows installer to use SQLite 3.43.1.

@item 
gh-82367@footnote{https://github.com/python/cpython/issues/82367}: @ref{381,,os.path.realpath()} now resolves MS-DOS style file names
even if the file is not accessible. Patch by Moonsik Park.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update Windows build to use OpenSSL 3.0.11.

@item 
gh-106242@footnote{https://github.com/python/cpython/issues/106242}: Fixes @ref{381,,realpath()} to behave consistently when
passed a path containing an embedded null character on Windows. In strict
mode, it now raises @ref{4d5,,OSError} instead of the unexpected
@ref{360,,ValueError}, and in non-strict mode will make the path absolute.

@item 
gh-83180@footnote{https://github.com/python/cpython/issues/83180}: Changes the @ref{65f,,Lanzador de Python para Windows} to prefer an active virtual
environment when the launched script has a shebang line using a Unix-like
virtual command, even if the command requests a specific version of
Python.

@item 
gh-106844@footnote{https://github.com/python/cpython/issues/106844}: Fix integer overflow and truncating by the null character in
@code{_winapi.LCMapStringEx()} which affects @code{ntpath.normcase()}.

@item 
gh-105436@footnote{https://github.com/python/cpython/issues/105436}: Ensure that an empty environment block is terminated by two
null characters, as is required by Windows.

@item 
gh-105146@footnote{https://github.com/python/cpython/issues/105146}: Updated the links at the end of the installer to point to
Discourse rather than the mailing lists.

@item 
gh-103646@footnote{https://github.com/python/cpython/issues/103646}: When installed from the Microsoft Store, @code{pip} no longer
defaults to per-user installs. However, as the install directory is
unwritable, it should automatically decide to do a per-user install
anyway. This should resolve issues when @code{pip} is passed an option that
conflicts with @code{--user}.

@item 
gh-88745@footnote{https://github.com/python/cpython/issues/88745}: Improve performance of @ref{aec,,shutil.copy2()} by using the
operating system’s @code{CopyFile2} function. This may result in subtle
changes to metadata copied along with some files, bringing them in line
with normal OS behavior.

@item 
gh-104820@footnote{https://github.com/python/cpython/issues/104820}: Fixes @ref{548,,stat()} and related functions on file systems
that do not support file ID requests. This includes FAT32 and exFAT.

@item 
gh-104803@footnote{https://github.com/python/cpython/issues/104803}: Add @ref{1653,,os.path.isdevdrive()} to detect whether a path is on a
Windows Dev Drive. Returns @code{False} on platforms that do not support Dev
Drive, and is absent on non-Windows platforms.
@end itemize

@node macOS<7>,IDLE<9>,Windows<9>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id75}@anchor{1718}
@subsubsection macOS



@itemize -

@item 
gh-109286@footnote{https://github.com/python/cpython/issues/109286}: Update macOS installer to use SQLite 3.43.1.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update macOS installer to use OpenSSL 3.0.11.

@item 
gh-99079@footnote{https://github.com/python/cpython/issues/99079}: Update macOS installer to use OpenSSL 3.0.9.
@end itemize

@node IDLE<9>,Tools/Demos<6>,macOS<7>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id76}@anchor{1719}
@subsubsection IDLE



@itemize -

@item 
gh-104719@footnote{https://github.com/python/cpython/issues/104719}: Remove IDLE’s modification of tokenize.tabsize and test other
uses of tokenize data and methods.
@end itemize

@node Tools/Demos<6>,C API<9>,IDLE<9>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id77}@anchor{171a}
@subsubsection Tools/Demos



@itemize -

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Update GitHub CI workflows to use OpenSSL 3.0.11 and
multissltests to use 1.1.1w, 3.0.11, and 3.1.3.

@item 
gh-108494@footnote{https://github.com/python/cpython/issues/108494}: Argument Clinic@footnote{https://devguide.python.org/development-tools/clinic/} now has a
partial support of the @ref{488,,Limited API}: see
documentation in the Python Developer's Guide@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-limited-capi}
Patch by Victor Stinner.

@item 
gh-107704@footnote{https://github.com/python/cpython/issues/107704}: It is now possible to deprecate passing keyword arguments for
keyword-or-positional parameters with Argument Clinic, using the new @code{/
[from X.Y]} syntax. (To be read as `«positional-only from Python version
X.Y»'.) See documentation in the Python Developer's Guide@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-keyword}
for more information.

@item 
gh-107880@footnote{https://github.com/python/cpython/issues/107880}: Argument Clinic can now clone @code{__init__()} and
@code{__new__()} methods.

@item 
gh-104683@footnote{https://github.com/python/cpython/issues/104683}: Add @code{--exclude} option to Argument Clinic CLI.

@item 
gh-95065@footnote{https://github.com/python/cpython/issues/95065}: Argument Clinic now supports overriding automatically generated
signature by using directive @code{@@text_signature}. See documentation in the Python Developer's Guide@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-override-signature}

@item 
gh-107609@footnote{https://github.com/python/cpython/issues/107609}: Fix duplicate module check in Argument Clinic. Previously, a
duplicate definition would incorrectly be silently accepted. Patch by
Erlend E. Aasland.

@item 
gh-107467@footnote{https://github.com/python/cpython/issues/107467}: The Argument Clinic command-line tool now prints to stderr
instead of stdout on failure.

@item 
gh-106970@footnote{https://github.com/python/cpython/issues/106970}: Fix bugs in the Argument Clinic @code{destination <name> clear}
command; the destination buffers would never be cleared, and the
@code{destination} directive parser would simply continue to the fault
handler after processing the command. Patch by Erlend E. Aasland.

@item 
gh-106706@footnote{https://github.com/python/cpython/issues/106706}: Change bytecode syntax for families to remove redundant name
matching pseudo syntax.

@item 
gh-106359@footnote{https://github.com/python/cpython/issues/106359}: Argument Clinic now explicitly forbids «kwarg splats» in
function calls used as annotations.

@item 
gh-103186@footnote{https://github.com/python/cpython/issues/103186}: @code{freeze} now fetches @code{CONFIG_ARGS} from the original
CPython instance the Makefile uses to call utility scripts. Patch by
Ijtaba Hussain.

@item 
gh-95065@footnote{https://github.com/python/cpython/issues/95065}: It is now possible to deprecate passing parameters positionally
with Argument Clinic, using the new @code{* [from X.Y]} syntax. (To be read
as `«keyword-only from Python version X.Y»'.) See documentation in the Python Developer's Guide@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-positional}
for more information. Patch by Erlend E. Aasland with help from Alex
Waygood, Nikita Sobolev, and Serhiy Storchaka.
@end itemize

@node C API<9>,,Tools/Demos<6>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id78}@anchor{171b}
@subsubsection C API



@itemize -

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: If the @ref{4dc,,Py_LIMITED_API} macro is defined,
@code{Py_BUILD_CORE}, @code{Py_BUILD_CORE_BUILTIN} and
@code{Py_BUILD_CORE_MODULE} macros are now undefined by
@code{<Python.h>}. Patch by Victor Stinner.

@item 
gh-110289@footnote{https://github.com/python/cpython/issues/110289}: Add @ref{46a,,PyUnicode_EqualToUTF8AndSize()} and
@ref{46b,,PyUnicode_EqualToUTF8()} functions.

@item 
gh-110235@footnote{https://github.com/python/cpython/issues/110235}: Raise @ref{228,,TypeError} for duplicate/unknown fields in
@code{PyStructSequence} constructor. Patched by Xuehai Pan.

@item 
gh-110014@footnote{https://github.com/python/cpython/issues/110014}: Remove undocumented @code{PY_TIMEOUT_MAX} constant from the
limited C API. Patch by Victor Stinner.

@item 
gh-109521@footnote{https://github.com/python/cpython/issues/109521}: @ref{171c,,PyImport_GetImporter()} now sets RuntimeError if it
fails to get @ref{10a0,,sys.path_hooks} or @ref{684,,sys.path_importer_cache} or
they are not list and dict correspondingly. Previously it could return
NULL without setting error in obscure cases, crash or raise SystemError if
these attributes have wrong type.

@item 
gh-108724@footnote{https://github.com/python/cpython/issues/108724}: Add @ref{2c7,,PyMutex} internal-only lightweight locking API.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Add @ref{462,,PySys_AuditTuple()} function: similar to
@ref{463,,PySys_Audit()}, but pass event arguments as a Python @ref{464,,tuple}
object.  Patch by Victor Stinner.

@item 
gh-108867@footnote{https://github.com/python/cpython/issues/108867}: Add @ref{465,,PyThreadState_GetUnchecked()} function: similar to
@ref{466,,PyThreadState_Get()}, but don’t kill the process with a fatal
error if it is NULL. The caller is responsible to check if the result is
NULL. Previously, the function was private and known as
@code{_PyThreadState_UncheckedGet()}. Patch by Victor Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} no longer includes the @code{<ctype.h>} standard
header file. If needed, it should now be included explicitly. For example,
it provides @code{isalpha()} and @code{tolower()} functions which are locale
dependent. Python provides locale independent functions, like
@code{Py_ISALPHA()} and @code{Py_TOLOWER()}. Patch by Victor Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} no longer includes the @code{<unistd.h>} standard
header file. If needed, it should now be included explicitly. For example,
it provides the functions: @code{close()}, @code{getpagesize()}, @code{getpid()}
and @code{sysconf()}. Patch by Victor Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} no longer includes the @code{<ieeefp.h>} standard
header. It was included for the @code{finite()} function which is now
provided by the @code{<math.h>} header. It should now be included explicitly
if needed. Remove also the @code{HAVE_IEEEFP_H} macro. Patch by Victor
Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} no longer includes these standard header files:
@code{<time.h>}, @code{<sys/select.h>} and @code{<sys/time.h>}. If needed, they
should now be included explicitly. For example, @code{<time.h>} provides the
@code{clock()} and @code{gmtime()} functions, @code{<sys/select.h>} provides the
@code{select()} function, and @code{<sys/time.h>} provides the @code{futimes()},
@code{gettimeofday()} and @code{setitimer()} functions. Patch by Victor Stinner.

@item 
gh-108511@footnote{https://github.com/python/cpython/issues/108511}: Add functions @ref{46c,,PyObject_HasAttrWithError()},
@ref{46e,,PyObject_HasAttrStringWithError()},
@ref{470,,PyMapping_HasKeyWithError()} and
@ref{472,,PyMapping_HasKeyStringWithError()}.

@item 
gh-107073@footnote{https://github.com/python/cpython/issues/107073}: Add @ref{45d,,PyObject_VisitManagedDict()} and
@ref{45e,,PyObject_ClearManagedDict()} functions which must be called by the
traverse and clear functions of a type using
@ref{45f,,Py_TPFLAGS_MANAGED_DICT} flag. Patch by Victor Stinner.

@item 
gh-108634@footnote{https://github.com/python/cpython/issues/108634}: Python built with @code{configure} @ref{487,,--with-trace-refs}
(tracing references) now supports the @ref{488,,Limited API}.
Patch by Victor Stinner.

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: Add @ref{453,,PyLong_AsInt()} function: similar to
@ref{454,,PyLong_AsLong()}, but store the result in a C int instead
of a C long. Previously, it was known as the private function
@code{_PyLong_AsInt()} (with an underscore prefix). Patch by Victor
Stinner.

@item 
gh-108314@footnote{https://github.com/python/cpython/issues/108314}: Add @ref{42b,,PyDict_ContainsString()} function: same as
@ref{42c,,PyDict_Contains()}, but `key' is specified as a const char* UTF-8 encoded bytes string, rather than a @ref{42d,,PyObject}*.
Patch by Victor Stinner.

@item 
gh-108337@footnote{https://github.com/python/cpython/issues/108337}: Add atomic operations on additional data types in pyatomic.h.

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: Add @ref{44e,,Py_IsFinalizing()} function: check if the main
Python interpreter is @ref{2bb,,shutting down}. Patch
by Victor Stinner.

@item 
gh-107916@footnote{https://github.com/python/cpython/issues/107916}: C API functions @ref{171d,,PyErr_SetFromErrnoWithFilename()},
@ref{171e,,PyErr_SetExcFromWindowsErrWithFilename()} and
@ref{171f,,PyErr_SetFromWindowsErrWithFilename()} save now the error code
before calling @ref{1720,,PyUnicode_DecodeFSDefault()}.

@item 
gh-107915@footnote{https://github.com/python/cpython/issues/107915}: Such C API functions as @code{PyErr_SetString()},
@code{PyErr_Format()}, @code{PyErr_SetFromErrnoWithFilename()} and many others
no longer crash or ignore errors if it failed to format the error message
or decode the filename. Instead, they keep a corresponding error.

@item 
gh-107810@footnote{https://github.com/python/cpython/issues/107810}: Improve @ref{1da,,DeprecationWarning} for uses of
@ref{1721,,PyType_Spec} with metaclasses that have custom @code{tp_new}.

@item 
gh-107249@footnote{https://github.com/python/cpython/issues/107249}: Implement the @ref{1722,,Py_UNUSED} macro for Windows MSVC
compiler. Patch by Victor Stinner.

@item 
gh-107226@footnote{https://github.com/python/cpython/issues/107226}: @ref{459,,PyModule_AddObjectRef()} is now only available in the
limited API version 3.10 or later.

@item 
gh-106320@footnote{https://github.com/python/cpython/issues/106320}: Remove private @code{_PyUnicode_AsString()} alias to
@ref{c43,,PyUnicode_AsUTF8()}. It was kept for backward compatibility with
Python 3.0 - 3.2. The @ref{c43,,PyUnicode_AsUTF8()} is available since Python
3.3. The @ref{11ff,,PyUnicode_AsUTF8String()} function can be used to keep
compatibility with Python 3.2 and older. Patch by Victor Stinner.

@item 
gh-106572@footnote{https://github.com/python/cpython/issues/106572}: Convert @ref{1723,,PyObject_DelAttr()} and
@ref{1625,,PyObject_DelAttrString()} macros to functions. Patch by Victor
Stinner.

@item 
gh-106307@footnote{https://github.com/python/cpython/issues/106307}: Add @ref{439,,PyMapping_GetOptionalItem()} function.

@item 
gh-106521@footnote{https://github.com/python/cpython/issues/106521}: Add @ref{43d,,PyObject_GetOptionalAttr()} and
@ref{43e,,PyObject_GetOptionalAttrString()} functions.

@item 
gh-106320@footnote{https://github.com/python/cpython/issues/106320}: Remove @code{_PyInterpreterState_Get()} alias to
@ref{4a0,,PyInterpreterState_Get()} which was kept for backward
compatibility with Python 3.8. Patch by Victor Stinner.

@item 
gh-106316@footnote{https://github.com/python/cpython/issues/106316}: Remove @code{cpython/pytime.h} header file: it only contained
private functions. Patch by Victor Stinner.

@item 
gh-106023@footnote{https://github.com/python/cpython/issues/106023}: Remove private @code{_PyObject_FastCall()} function: use
@code{PyObject_Vectorcall()} which is available since Python 3.8
(
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}). Patch by Victor Stinner.

@item 
gh-106168@footnote{https://github.com/python/cpython/issues/106168}: If Python is built in @ref{357,,debug mode} or
@ref{47e,,with assertions}, @ref{47f,,PyTuple_SET_ITEM()}
and @ref{480,,PyList_SET_ITEM()} now check the index argument with an
assertion. If the assertion fails, make sure that the size is set before.
Patch by Victor Stinner.

@item 
gh-106084@footnote{https://github.com/python/cpython/issues/106084}: Remove the old aliases to functions calling functions which
were kept for backward compatibility with Python 3.8 provisional API:


@itemize *

@item 
@code{_PyObject_CallMethodNoArgs()}: use @code{PyObject_CallMethodNoArgs()}

@item 
@code{_PyObject_CallMethodOneArg()}: use @code{PyObject_CallMethodOneArg()}

@item 
@code{_PyObject_CallOneArg()}: use @code{PyObject_CallOneArg()}

@item 
@code{_PyObject_FastCallDict()}: use @code{PyObject_VectorcallDict()}

@item 
@code{_PyObject_Vectorcall()}: use @code{PyObject_Vectorcall()}

@item 
@code{_PyObject_VectorcallMethod()}: use @code{PyObject_VectorcallMethod()}

@item 
@code{_PyVectorcall_Function()}: use @code{PyVectorcall_Function()}
@end itemize

Just remove the underscore prefix to update your code. Patch by Victor
Stinner.

@item 
gh-106004@footnote{https://github.com/python/cpython/issues/106004}: Adds @ref{42e,,PyDict_GetItemRef()} and
@ref{42f,,PyDict_GetItemStringRef()} functions: similar to
@ref{430,,PyDict_GetItemWithError()} but returning a @ref{431,,strong reference}
instead of a @ref{432,,borrowed reference}. Patch by Victor Stinner.

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: Deprecate the @ref{274,,PyWeakref_GetObject()} and
@ref{275,,PyWeakref_GET_OBJECT()} functions: use the new
@ref{276,,PyWeakref_GetRef()} function instead. Patch by Victor Stinner.

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: Add @ref{276,,PyWeakref_GetRef()} function: similar to
@ref{274,,PyWeakref_GetObject()} but returns a @ref{431,,strong reference}, or
@code{NULL} if the referent is no longer live. Patch by Victor Stinner.

@item 
gh-105922@footnote{https://github.com/python/cpython/issues/105922}: Add @ref{44c,,PyImport_AddModuleRef()}: similar to
@ref{44d,,PyImport_AddModule()}, but return a @ref{431,,strong reference}
instead of a @ref{432,,borrowed reference}. Patch by Victor Stinner.

@item 
gh-105227@footnote{https://github.com/python/cpython/issues/105227}: The new @ref{1724,,PyType_GetDict()} provides the dictionary for
the given type object that is normally exposed by @code{cls.__dict__}.
Normally it’s sufficient to use @ref{1725,,tp_dict}, but for
the static builtin types @code{tp_dict} is now always @code{NULL}.
@code{PyType_GetDict()} provides the correct dict object instead.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Fix a bug in @ref{1726,,PyErr_WarnExplicit()} where an exception
could end up being overwritten if the API failed internally.

@item 
gh-105603@footnote{https://github.com/python/cpython/issues/105603}: We’ve renamed the new (in 3.12) @code{PyInterpreterConfig.own_gil}
to @code{PyInterpreterConfig.gil} and changed the meaning of the value from
«bool» to an integer with supported values of
@code{PyInterpreterConfig_DEFAULT_GIL}, @code{PyInterpreterConfig_SHARED_GIL},
and @code{PyInterpreterConfig_OWN_GIL}. The default is «shared».

@item 
gh-105387@footnote{https://github.com/python/cpython/issues/105387}: In the limited C API version 3.12, @ref{612,,Py_INCREF()} and
@ref{613,,Py_DECREF()} functions are now implemented as opaque function calls
to hide implementation details. Patch by Victor Stinner.

@item 
gh-105396@footnote{https://github.com/python/cpython/issues/105396}: Deprecate the @ref{272,,PyImport_ImportModuleNoBlock()} function
which is just an alias to @ref{273,,PyImport_ImportModule()} since Python
3.3. Patch by Victor Stinner.

@item 
gh-103968@footnote{https://github.com/python/cpython/issues/103968}: @ref{5f3,,PyType_FromMetaclass()} now allows metaclasses with
@code{tp_new} set to @code{NULL}.

@item 
gh-105268@footnote{https://github.com/python/cpython/issues/105268}: Remove the old private, undocumented and untested
@code{_PyGC_FINALIZED()} macro which was kept for backward compatibility with
Python 3.8 and older. Patch by Victor Stinner.

@item 
gh-105182@footnote{https://github.com/python/cpython/issues/105182}: Remove @code{PyEval_AcquireLock()} and @code{PyEval_ReleaseLock()}
functions, deprecated in Python 3.2. Patch by Victor Stinner.

@item 
gh-105182@footnote{https://github.com/python/cpython/issues/105182}: Remove @code{PyEval_InitThreads()} and
@code{PyEval_ThreadsInitialized()} functions, deprecated in Python 3.9. Patch
by Victor Stinner.

@item 
gh-105145@footnote{https://github.com/python/cpython/issues/105145}: Deprecate old Python initialization functions:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}

@item 
@ref{27a,,Py_GetExecPrefix()}

@item 
@ref{27d,,Py_GetPath()}

@item 
@ref{27f,,Py_GetPrefix()}

@item 
@ref{282,,Py_GetProgramFullPath()}

@item 
@ref{284,,Py_GetProgramName()}

@item 
@ref{285,,Py_GetPythonHome()}
@end itemize

Patch by Victor Stinner.

@item 
gh-85275@footnote{https://github.com/python/cpython/issues/85275}: @code{PyObject_AsCharBuffer()}, @code{PyObject_AsReadBuffer()},
@code{PyObject_CheckReadBuffer()}, and @code{PyObject_AsWriteBuffer()} are
removed. Please migrate to new buffer protocol;
@ref{48c,,PyObject_GetBuffer()} and @ref{48d,,PyBuffer_Release()}.

@item 
gh-105156@footnote{https://github.com/python/cpython/issues/105156}: Deprecate the old @code{Py_UNICODE} and @code{PY_UNICODE_TYPE} types:
use directly the @code{wchar_t} type instead. Since Python 3.3,
@code{Py_UNICODE} and @code{PY_UNICODE_TYPE} are just aliases to
@code{wchar_t}. Patch by Victor Stinner.

@item 
gh-105145@footnote{https://github.com/python/cpython/issues/105145}: Remove the following old functions to configure the Python
initialization, deprecated in Python 3.11:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{PySys_SetArgvEx()}

@item 
@code{PySys_SetArgv()}

@item 
@code{PySys_SetPath()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

Patch by Victor Stinner.

@item 
gh-105107@footnote{https://github.com/python/cpython/issues/105107}: Remove functions deprecated in Python 3.9.


@itemize *

@item 
@code{PyEval_CallObject()}, @code{PyEval_CallObjectWithKeywords()}: use
@ref{48e,,PyObject_CallNoArgs()} and @ref{48f,,PyObject_Call()} (positional
arguments must not be `NULL') instead.

@item 
@code{PyEval_CallFunction()}: use @ref{491,,PyObject_CallFunction()} instead.

@item 
@code{PyEval_CallMethod()}: use @ref{492,,PyObject_CallMethod()} instead.

@item 
@code{PyCFunction_Call()}: use @ref{48f,,PyObject_Call()} instead.
@end itemize

Patch by Victor Stinner.

@item 
gh-105115@footnote{https://github.com/python/cpython/issues/105115}: @code{PyTypeObject.tp_bases} (and @code{tp_mro}) for builtin static
types are now shared by all interpreters, whereas in 3.12-beta1 they were
stored on @code{PyInterpreterState}.  Also note that now the tuples are
immortal objects.

@item 
gh-105071@footnote{https://github.com/python/cpython/issues/105071}: Add @code{PyUnstable_Exc_PrepReraiseStar} to the unstable C api to
expose the implementation of @ref{659,,except*}.

@item 
gh-104922@footnote{https://github.com/python/cpython/issues/104922}: @code{PY_SSIZE_T_CLEAN} is no longer required to use @code{'#'}
formats in APIs like @ref{615,,PyArg_ParseTuple()} and
@ref{940,,Py_BuildValue()}. They uses @code{Py_ssize_t} for @code{'#'} regardless
@code{PY_SSIZE_T_CLEAN}.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Add an unstable C API for hooking in an optimizer. This is
mainly internal, but marked «unstable» to allow third-party
experimentation.

@item 
gh-104668@footnote{https://github.com/python/cpython/issues/104668}: Don’t call @ref{629,,PyOS_InputHook} or
@ref{62a,,PyOS_ReadlineFunctionPointer} in subinterpreters, since it’s
generally difficult to avoid using global state in their registered
callbacks. This also avoids situations where extensions may find
themselves running in a subinterpreter they don’t support (or haven’t yet
been loaded in).

@item 
bpo-42327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42327}: Add @ref{458,,PyModule_Add()} function: similar to
@ref{459,,PyModule_AddObjectRef()} and @ref{45a,,PyModule_AddObject()}, but
always steals a reference to the value.

@item 
bpo-40309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40309}: Properly handle trailing spaces before closing parenthesis in
@ref{940,,Py_BuildValue()} format strings.
@end itemize

@node Python 3 12 0 beta 1,Python 3 12 0 alpha 7,Python 3 13 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-beta-1}@anchor{1727}
@subsection Python 3.12.0 beta 1


`Release date: 2023-05-22'

@menu
* Security: Security<8>. 
* Core and Builtins: Core and Builtins<10>. 
* Library: Library<10>. 
* Documentation: Documentation<9>. 
* Tests: Tests<9>. 
* Build: Build<10>. 
* Windows: Windows<10>. 
* macOS: macOS<8>. 
* IDLE: IDLE<10>. 
* Tools/Demos: Tools/Demos<7>. 
* C API: C API<10>. 

@end menu

@node Security<8>,Core and Builtins<10>,,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id79}@anchor{1728}
@subsubsection Security



@itemize -

@item 
gh-99889@footnote{https://github.com/python/cpython/issues/99889}: Fixed a security in flaw in @code{uu.decode()} that could allow
for directory traversal based on the input if no @code{out_file} was
specified.

@item 
gh-104049@footnote{https://github.com/python/cpython/issues/104049}: Do not expose the local on-disk location in directory indexes
produced by @code{http.client.SimpleHTTPRequestHandler}.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Upgrade built-in @ref{68,,hashlib} SHA3 implementation to a
verified implementation from the @code{HACL*} project.  Used when OpenSSL is
not present or lacks SHA3.

@item 
gh-102153@footnote{https://github.com/python/cpython/issues/102153}: @ref{dc6,,urllib.parse.urlsplit()} now strips leading C0 control and
space characters following the specification for URLs defined by WHATWG in
response to 
@geindex Common Vulnerabilities and Exposures; CVE 2023-24329
CVE 2023-24329@footnote{https://www.cve.org/CVERecord?id=CVE-2023-24329}. Patch by Illia Volochii.
@end itemize

@node Core and Builtins<10>,Library<10>,Security<8>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id80}@anchor{1729}
@subsubsection Core and Builtins



@itemize -

@item 
gh-102856@footnote{https://github.com/python/cpython/issues/102856}: Implement PEP 701 changes in the @ref{fb,,tokenize} module. Patch
by Marta Gómez Macías and Pablo Galindo Salgado

@item 
gh-104615@footnote{https://github.com/python/cpython/issues/104615}: Fix wrong ordering of assignments in code like @code{a, a = x, y}.
Contributed by Carl Meyer.

@item 
gh-104572@footnote{https://github.com/python/cpython/issues/104572}: Improve syntax error message for invalid constructs in
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} contexts and in annotations when @code{from __future__ import
annotations} is active.

@item 
gh-104482@footnote{https://github.com/python/cpython/issues/104482}: Fix three error handling bugs in ast.c’s validation of pattern
matching statements.

@item 
gh-102818@footnote{https://github.com/python/cpython/issues/102818}: Do not add a frame to the traceback in the @code{sys.setprofile}
and @code{sys.settrace} trampoline functions. This ensures that frames are
not duplicated if an exception is raised in the callback function, and
ensures that frames are not omitted if a C callback is used and that does
not add the frame.

@item 
gh-104405@footnote{https://github.com/python/cpython/issues/104405}: Fix an issue where some @ref{2f2,,bytecode} instructions could
ignore 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} when «inlining» calls.

@item 
gh-103082@footnote{https://github.com/python/cpython/issues/103082}: Change behavior of @code{sys.monitoring.events.LINE} events in
@code{sys.monitoring}: Line events now occur when a new line is reached
dynamically, instead of using a static approximation, as before. This
makes the behavior very similar to that of «line» events in
@code{sys.settrace}. This should ease porting of tools from 3.11 to 3.12.

@item 
gh-104263@footnote{https://github.com/python/cpython/issues/104263}: Fix @code{float("nan")} to produce a quiet NaN on platforms (like
MIPS) where the meaning of the signalling / quiet bit is inverted from its
usual meaning. Also introduce a new macro @code{Py_INFINITY} matching C99’s
@code{INFINITY}, and refactor internals to rely on C99’s @code{NAN} and
@code{INFINITY} macros instead of hard-coding bit patterns for infinities and
NaNs. Thanks Sebastian Berg.

@item 
gh-99113@footnote{https://github.com/python/cpython/issues/99113}: Multi-phase init extension modules may now indicate that they
support running in subinterpreters that have their own GIL.  This is done
by using @code{Py_MOD_PER_INTERPRETER_GIL_SUPPORTED} as the value for the
@code{Py_mod_multiple_interpreters} module def slot.  Otherwise the module,
by default, cannot be imported in such subinterpreters.  (This does not
affect the main interpreter or subinterpreters that do not have their own
GIL.)  In addition to the isolation that multi-phase init already normally
requires, support for per-interpreter GIL involves one additional
constraint: thread-safety.  If the module has external (linked)
dependencies and those libraries have any state that isn’t thread-safe
then the module must do the additional work to add thread-safety.  This
should be an uncommon case.

@item 
gh-99113@footnote{https://github.com/python/cpython/issues/99113}: The GIL is now (optionally) per-interpreter.  This is the
fundamental change for PEP 684.  This is all made possible by virtue of
the isolated state of each interpreter in the process.  The behavior of
the main interpreter remains unchanged.  Likewise, interpreters created
using @code{Py_NewInterpreter()} are not affected.  To get an interpreter
with its own GIL, call @code{Py_NewInterpreterFromConfig()}.

@item 
gh-104108@footnote{https://github.com/python/cpython/issues/104108}: Multi-phase init extension modules may now indicate whether or
not they actually support multiple interpreters.  By default such modules
are expected to support use in multiple interpreters.  In the uncommon
case that one does not, it may use the new
@code{Py_mod_multiple_interpreters} module def slot.  A value of @code{0} means
the module does not support them. @code{1} means it does.  The default is
@code{1}.

@item 
gh-104142@footnote{https://github.com/python/cpython/issues/104142}: Fix an issue where @ref{18e,,list} or @ref{464,,tuple} repetition
could fail to respect 
@geindex Python Enhancement Proposals; PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}.

@item 
gh-104078@footnote{https://github.com/python/cpython/issues/104078}: Improve the performance of @ref{46f,,PyObject_HasAttrString()}

@item 
gh-104066@footnote{https://github.com/python/cpython/issues/104066}: Improve the performance of @ref{579,,hasattr()} for module objects
with a missing attribute.

@item 
gh-104028@footnote{https://github.com/python/cpython/issues/104028}: Reduce object creation while calling callback function from gc.
Patch by Donghee Na.

@item 
gh-104018@footnote{https://github.com/python/cpython/issues/104018}: Disallow the «z» format specifier in %-format of bytes objects.

@item 
gh-102213@footnote{https://github.com/python/cpython/issues/102213}: Fix performance loss when accessing an object’s attributes with
@code{__getattr__}  defined.

@item 
gh-103895@footnote{https://github.com/python/cpython/issues/103895}: Improve handling of edge cases in showing
@code{Exception.__notes__}. Ensures that the messages always end with a
newline and that string/bytes are not exploded over multiple lines. Patch
by Carey Metcalfe.

@item 
gh-103907@footnote{https://github.com/python/cpython/issues/103907}: Don’t modify the refcounts of known immortal objects
(@ref{c95,,True}, @ref{bbf,,False}, and @ref{716,,None}) in the main interpreter
loop.

@item 
gh-103899@footnote{https://github.com/python/cpython/issues/103899}: Provide a helpful hint in the @ref{228,,TypeError} message when
accidentally calling a @ref{166a,,module} object that has a callable attribute
of the same name (such as @ref{172,,dis.dis()} or @ref{32f,,datetime.datetime}).

@item 
gh-103845@footnote{https://github.com/python/cpython/issues/103845}: Remove both line and instruction instrumentation before adding
new ones for monitoring, to avoid newly added instrumentation being
removed immediately.

@item 
gh-103763@footnote{https://github.com/python/cpython/issues/103763}: Implement 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}, adding syntactic support for generic
classes, generic functions, and type aliases.

A new @code{type X = ...} syntax is added for type aliases, which resolves at
runtime to an instance of the new class @code{typing.TypeAliasType}. The
value is lazily evaluated and is accessible through the @code{.__value__}
attribute. This is implemented as a new AST node @code{ast.TypeAlias}.

New syntax (@code{class X[T]: ...}, @code{def func[T](): ...}) is added for
defining generic functions and classes. This is implemented as a new
@code{type_params} attribute on the AST nodes for classes and functions. This
node holds instances of the new AST classes @code{ast.TypeVar},
@code{ast.ParamSpec}, and @code{ast.TypeVarTuple}.

@code{typing.TypeVar}, @code{typing.ParamSpec}, @code{typing.ParamSpecArgs},
@code{typing.ParamSpecKwargs}, @code{typing.TypeVarTuple}, and
@code{typing.Generic} are now implemented in C rather than Python.

There are new bytecode instructions @code{LOAD_LOCALS},
@code{LOAD_CLASSDICT_OR_GLOBAL}, and @code{LOAD_CLASSDICT_OR_DEREF} to support
correct resolution of names in class namespaces.

Patch by Eric Traut, Larry Hastings, and Jelle Zijlstra.

@item 
gh-103801@footnote{https://github.com/python/cpython/issues/103801}: Adds three minor linting fixes to the wasm module caught that
were caught by ruff.

@item 
gh-103793@footnote{https://github.com/python/cpython/issues/103793}: Optimized asyncio Task creation by deferring expensive string
formatting (task name generation) from Task creation to the first time
@code{get_name} is called. This makes asyncio benchmarks up to 5% faster.

@item 
gh-102310@footnote{https://github.com/python/cpython/issues/102310}: Change the error range for invalid bytes literals.

@item 
gh-103590@footnote{https://github.com/python/cpython/issues/103590}: Do not wrap a single exception raised from a @code{try-except*}
construct in an @ref{31d,,ExceptionGroup}.

@item 
gh-103650@footnote{https://github.com/python/cpython/issues/103650}: Change the perf map format to remove the “0x” prefix from the
addresses

@item 
gh-102856@footnote{https://github.com/python/cpython/issues/102856}: Implement the required C tokenizer changes for PEP 701. Patch
by Pablo Galindo Salgado, Lysandros Nikolaou, Batuhan Taskaya, Marta Gómez
Macías and sunmy2019.

@item 
gh-100530@footnote{https://github.com/python/cpython/issues/100530}: Clarify the error message raised when the called part of a
class pattern isn’t actually a class.

@item 
gh-101517@footnote{https://github.com/python/cpython/issues/101517}: Fix bug in line numbers of instructions emitted for
@ref{659,,except*}.

@item 
gh-103492@footnote{https://github.com/python/cpython/issues/103492}: Clarify @ref{511,,SyntaxWarning} with literal @code{is} comparison by
specifying which literal is problematic, since comparisons using @code{is}
with e.g. @code{None} and bool literals are idiomatic.

@item 
gh-87729@footnote{https://github.com/python/cpython/issues/87729}: Add @ref{583,,LOAD_SUPER_ATTR} (and a specialization for
@code{super().method()}) to speed up @code{super().method()} and
@code{super().attr}. This makes @code{super().method()} roughly 2.3x faster and
brings it within 20% of the performance of a simple method call. Patch by
Vladimir Matveev and Carl Meyer.

@item 
gh-103488@footnote{https://github.com/python/cpython/issues/103488}: Change the internal offset distinguishing yield and return
target addresses, so that the instruction pointer is correct for exception
handling and other stack unwinding.

@item 
gh-82012@footnote{https://github.com/python/cpython/issues/82012}: The bitwise inversion operator (@code{~}) on bool is deprecated. It
returns the bitwise inversion of the underlying @code{int} representation
such that @code{bool(~True) == True}, which can be confusing. Use @code{not} for
logical negation of bools. In the rare case that you really need the
bitwise inversion of the underlying @code{int}, convert to int explicitly
@code{~int(x)}.

@item 
gh-77757@footnote{https://github.com/python/cpython/issues/77757}: Exceptions raised in a typeobject’s @code{__set_name__} method are
no longer wrapped by a @ref{1e5,,RuntimeError}. Context information is added
to the exception as a 
@geindex Python Enhancement Proposals; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} note.

@item 
gh-103333@footnote{https://github.com/python/cpython/issues/103333}: @ref{441,,AttributeError} now retains the @code{name} attribute when
pickled and unpickled.

@item 
gh-103242@footnote{https://github.com/python/cpython/issues/103242}: Migrate @ref{11b4,,set_ecdh_curve()} method not to
use deprecated OpenSSL APIs. Patch by Donghee Na.

@item 
gh-103323@footnote{https://github.com/python/cpython/issues/103323}: We’ve replaced our use of @code{_PyRuntime.tstate_current} with a
thread-local variable.  This is a fairly low-level implementation detail,
and there should be no change in behavior.

@item 
gh-84436@footnote{https://github.com/python/cpython/issues/84436}: The implementation of PEP-683 which adds Immortal Objects by
using a fixed reference count that skips reference counting to make
objects truly immutable.

@item 
gh-102700@footnote{https://github.com/python/cpython/issues/102700}: Allow built-in modules to be submodules. This allows submodules
to be statically linked into a CPython binary.

@item 
gh-103082@footnote{https://github.com/python/cpython/issues/103082}: Implement 
@geindex Python Enhancement Proposals; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} Low Impact Monitoring for CPython.

@item 
gh-88691@footnote{https://github.com/python/cpython/issues/88691}: Reduce the number of inline @ref{799,,CACHE} entries for
@ref{7a7,,CALL}.

@item 
gh-102500@footnote{https://github.com/python/cpython/issues/102500}: Make the buffer protocol accessible in Python code using the
new @code{__buffer__} and @code{__release_buffer__} magic methods. See
@geindex Python Enhancement Proposals; PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/} for details. Patch by Jelle Zijlstra.

@item 
gh-97933@footnote{https://github.com/python/cpython/issues/97933}: 
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}: inline list, dict and set comprehensions to improve
performance and reduce bytecode size.

@item 
gh-99184@footnote{https://github.com/python/cpython/issues/99184}: Bypass instance attribute access of @code{__name__} in @code{repr} of
@ref{106d,,weakref.ref}.

@item 
gh-98003@footnote{https://github.com/python/cpython/issues/98003}: Complex function calls are now faster and consume no C stack
space.

@item 
bpo-39610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39610}: @code{len()} for 0-dimensional @ref{156,,memoryview} objects (such
as @code{memoryview(ctypes.c_uint8(42))}) now raises a @ref{228,,TypeError}.
Previously this returned @code{1}, which was not consistent with
@code{mem_0d[0]} raising an @ref{1575,,IndexError}.

@item 
bpo-31821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31821}: Fix @code{pause_reading()} to work when called from
@code{connection_made()} in @ref{b,,asyncio}.
@end itemize

@node Library<10>,Documentation<9>,Core and Builtins<10>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id81}@anchor{172a}
@subsubsection Library



@itemize -

@item 
gh-104600@footnote{https://github.com/python/cpython/issues/104600}: @ref{109e,,functools.update_wrapper()} now sets the
@code{__type_params__} attribute (added by 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}).

@item 
gh-104340@footnote{https://github.com/python/cpython/issues/104340}: When an @code{asyncio} pipe protocol loses its connection due to
an error, and the caller doesn’t await @code{wait_closed()} on the
corresponding @code{StreamWriter}, don’t log a warning about an exception
that was never retrieved. After all, according to the
@code{StreamWriter.close()} docs, the @code{wait_closed()} call is optional
(«not mandatory»).

@item 
gh-104555@footnote{https://github.com/python/cpython/issues/104555}: Fix issue where an @ref{85a,,issubclass()} check comparing a class
@code{X} against a @ref{4f0,,runtime-checkable protocol} @code{Y} with non-callable members would not
cause @ref{228,,TypeError} to be raised if an @ref{4ef,,isinstance()} call had
previously been made comparing an instance of @code{X} to @code{Y}. This issue
was present in edge cases on Python 3.11, but became more prominent in
3.12 due to some unrelated changes that were made to runtime-checkable
protocols. Patch by Alex Waygood.

@item 
gh-104372@footnote{https://github.com/python/cpython/issues/104372}: Refactored the @code{_posixsubprocess} internals to avoid Python C
API usage between fork and exec when marking @code{pass_fds=} file
descriptors inheritable.

@item 
gh-104484@footnote{https://github.com/python/cpython/issues/104484}: Added `case_sensitive' argument to
@ref{554,,pathlib.PurePath.match()}

@item 
gh-75367@footnote{https://github.com/python/cpython/issues/75367}: Fix data descriptor detection in
@ref{53d,,inspect.getattr_static()}.

@item 
gh-104536@footnote{https://github.com/python/cpython/issues/104536}: Fix a race condition in the internal
@code{multiprocessing.process} cleanup logic that could manifest as an
unintended @code{AttributeError} when calling @code{process.close()}.

@item 
gh-103857@footnote{https://github.com/python/cpython/issues/103857}: Update datetime deprecations” stracktrace to point to the
calling line

@item 
gh-101520@footnote{https://github.com/python/cpython/issues/101520}: Move the core functionality of the @code{tracemalloc} module in
the @code{Python/} folder, leaving just the module wrapper in @code{Modules/}.

@item 
gh-104392@footnote{https://github.com/python/cpython/issues/104392}: Remove undocumented and unused @code{_paramspec_tvars} attribute
from some classes in @ref{104,,typing}.

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: Fix issue where @ref{388,,pathlib.Path.glob()} raised
@ref{df1,,RecursionError} when walking deep directory trees.

@item 
gh-103000@footnote{https://github.com/python/cpython/issues/103000}: Improve performance of @ref{172b,,dataclasses.asdict()} for the
common case where `dict_factory' is @code{dict}. Patch by David C Ellis.

@item 
gh-104301@footnote{https://github.com/python/cpython/issues/104301}: Allow leading whitespace in disambiguated statements in
@ref{a5,,pdb}.

@item 
gh-104139@footnote{https://github.com/python/cpython/issues/104139}: Teach @code{urllib.parse.unsplit()} to retain the @code{"//"} when
assembling @code{itms-services://?action=generate-bugs} style Apple Platform Deployment@footnote{https://support.apple.com/en-gb/guide/deployment/depce7cefc4d/web}
URLs.

@item 
gh-104307@footnote{https://github.com/python/cpython/issues/104307}: @ref{16cd,,socket.getnameinfo()} now releases the GIL while
contacting the DNS server

@item 
gh-104310@footnote{https://github.com/python/cpython/issues/104310}: Users may now use @code{importlib.util.allowing_all_extensions()}
(a context manager) to temporarily disable the strict compatibility checks
for importing extension modules in subinterpreters.

@item 
gh-87695@footnote{https://github.com/python/cpython/issues/87695}: Fix issue where @ref{388,,pathlib.Path.glob()} raised @ref{4d5,,OSError}
when it encountered a symlink to an overly long path.

@item 
gh-104265@footnote{https://github.com/python/cpython/issues/104265}: Prevent possible crash by disallowing instantiation of the
@code{_csv.Reader} and @code{_csv.Writer} types. The regression was
introduced in 3.10.0a4 with PR 23224 (bpo-14935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14935}). Patch by Radislav
Chugunov.

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: Improve performance of @ref{388,,pathlib.Path.glob()} when expanding
recursive wildcards (»@code{**}») by merging adjacent wildcards and
de-duplicating results only when necessary.

@item 
gh-65772@footnote{https://github.com/python/cpython/issues/65772}: Remove unneeded comments and code in turtle.py.

@item 
gh-90208@footnote{https://github.com/python/cpython/issues/90208}: Fixed issue where @ref{388,,pathlib.Path.glob()} returned incomplete
results when it encountered a @ref{dc9,,PermissionError}. This method now
suppresses all @ref{4d5,,OSError} exceptions, except those raised from calling
@ref{38b,,is_dir()} on the top-level path.

@item 
gh-104144@footnote{https://github.com/python/cpython/issues/104144}: Optimize @ref{31c,,asyncio.TaskGroup} when using
@ref{522,,asyncio.eager_task_factory()}. Skip scheduling a done callback if a
TaskGroup task completes eagerly.

@item 
gh-104144@footnote{https://github.com/python/cpython/issues/104144}: Optimize @ref{69e,,asyncio.gather()} when using
@ref{522,,asyncio.eager_task_factory()} to complete eagerly if all fututres
completed eagerly. Avoid scheduling done callbacks for futures that
complete eagerly.

@item 
gh-104114@footnote{https://github.com/python/cpython/issues/104114}: Fix issue where @ref{388,,pathlib.Path.glob()} returns paths using
the case of non-wildcard segments for corresponding path segments, rather
than the real filesystem case.

@item 
gh-104104@footnote{https://github.com/python/cpython/issues/104104}: Improve performance of @ref{388,,pathlib.Path.glob()} by using
@ref{172c,,re.IGNORECASE} to implement case-insensitive matching.

@item 
gh-104102@footnote{https://github.com/python/cpython/issues/104102}: Improve performance of @ref{388,,pathlib.Path.glob()} when
evaluating patterns that contain @code{'../'} segments.

@item 
gh-103822@footnote{https://github.com/python/cpython/issues/103822}: Update the return type of @code{weekday} to the newly added Day
attribute

@item 
gh-103629@footnote{https://github.com/python/cpython/issues/103629}: Update the @code{repr} of @ref{163b,,typing.Unpack} according to
@geindex Python Enhancement Proposals; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/}.

@item 
gh-103963@footnote{https://github.com/python/cpython/issues/103963}: Make @ref{39,,dis} display the names of the args for
@code{CALL_INTRINSIC_*}.

@item 
gh-104035@footnote{https://github.com/python/cpython/issues/104035}: Do not ignore user-defined @code{__getstate__} and
@code{__setstate__} methods for slotted frozen dataclasses.

@item 
gh-103987@footnote{https://github.com/python/cpython/issues/103987}: In @ref{90,,mmap}, fix several bugs that could lead to access to
memory-mapped files after they have been invalidated.

@item 
gh-103977@footnote{https://github.com/python/cpython/issues/103977}: Improve import time of @ref{aa,,platform} module.

@item 
gh-88773@footnote{https://github.com/python/cpython/issues/88773}: Added @ref{172d,,turtle.teleport()} to the @ref{101,,turtle} module to
move a turtle to a new point without tracing a line, visible or invisible.
Patch by Liam Gersten.

@item 
gh-103935@footnote{https://github.com/python/cpython/issues/103935}: Use @ref{172e,,io.open_code()} for files to be executed instead of
raw @ref{1be,,open()}

@item 
gh-68968@footnote{https://github.com/python/cpython/issues/68968}: Fixed garbled output of @ref{5cc,,assertEqual()}
when an input lacks final newline.

@item 
gh-100370@footnote{https://github.com/python/cpython/issues/100370}: Fix potential @ref{919,,OverflowError} in
@ref{722,,sqlite3.Connection.blobopen()} for 32-bit builds. Patch by Erlend E.
Aasland.

@item 
gh-102628@footnote{https://github.com/python/cpython/issues/102628}: Substitute CTRL-D with CTRL-Z in @ref{cf,,sqlite3} CLI banner when
running on Windows.

@item 
gh-103636@footnote{https://github.com/python/cpython/issues/103636}: Module-level attributes @code{January} and @code{February} are
deprecated from @ref{15,,calendar}.

@item 
gh-103583@footnote{https://github.com/python/cpython/issues/103583}: Isolate @code{_multibytecodec} and codecs extension modules.
Patches by Erlend E. Aasland.

@item 
gh-103848@footnote{https://github.com/python/cpython/issues/103848}: Add checks to ensure that @code{[} bracketed @code{]} hosts found by
@ref{dc6,,urllib.parse.urlsplit()} are of IPv6 or IPvFuture format.

@item 
gh-103872@footnote{https://github.com/python/cpython/issues/103872}: Update the bundled copy of pip to version 23.1.2.

@item 
gh-99944@footnote{https://github.com/python/cpython/issues/99944}: Make @ref{39,,dis} display the value of oparg of
@code{KW_NAMES}.

@item 
gh-74940@footnote{https://github.com/python/cpython/issues/74940}: The C.UTF-8 locale is no longer converted to en_US.UTF-8,
enabling the use of UTF-8 encoding on systems which have no locales
installed.

@item 
gh-103861@footnote{https://github.com/python/cpython/issues/103861}: Fix @code{zipfile.Zipfile} creating invalid zip files when
@code{force_zip64} was used to add files to them. Patch by Carey Metcalfe.

@item 
gh-103857@footnote{https://github.com/python/cpython/issues/103857}: Deprecated @ref{1f4,,datetime.datetime.utcnow()} and
@ref{1f5,,datetime.datetime.utcfromtimestamp()}. (Patch by Paul Ganssle)

@item 
gh-103839@footnote{https://github.com/python/cpython/issues/103839}: Avoid compilation error due to tommath.h not being found when
building Tkinter against Tcl 8.7 built with bundled libtommath.

@item 
gh-103791@footnote{https://github.com/python/cpython/issues/103791}: @ref{fa8,,contextlib.suppress} now supports suppressing
exceptions raised as part of an @ref{31d,,ExceptionGroup}. If other exceptions
exist on the group, they are re-raised in a group that does not contain
the suppressed exceptions.

@item 
gh-90750@footnote{https://github.com/python/cpython/issues/90750}: Use @ref{a7f,,datetime.datetime.fromisocalendar()} in the
implementation of @ref{15ec,,datetime.datetime.strptime()}, which should now
accept only valid ISO dates. (Patch by Paul Ganssle)

@item 
gh-103685@footnote{https://github.com/python/cpython/issues/103685}: Prepare @code{tkinter.Menu.index()} for Tk 8.7 so that it does
not raise @code{TclError: expected integer but got ""} when it should return
@code{None}.

@item 
gh-81403@footnote{https://github.com/python/cpython/issues/81403}: @ref{172f,,urllib.request.CacheFTPHandler} no longer raises
@code{URLError} if a cached FTP instance is reused. ftplib’s endtransfer
method calls voidresp to drain the connection to handle FTP instance reuse
properly.

@item 
gh-103699@footnote{https://github.com/python/cpython/issues/103699}: Add @code{__orig_bases__} to non-generic TypedDicts, call-based
TypedDicts, and call-based NamedTuples. Other TypedDicts and NamedTuples
already had the attribute.

@item 
gh-103693@footnote{https://github.com/python/cpython/issues/103693}: Add convenience variable feature to @ref{a5,,pdb}

@item 
gh-92248@footnote{https://github.com/python/cpython/issues/92248}: Deprecate @code{type}, @code{choices}, and @code{metavar} parameters of
@code{argparse.BooleanOptionalAction}.

@item 
gh-89415@footnote{https://github.com/python/cpython/issues/89415}: Add @ref{cc,,socket} constants for source-specific multicast. Patch
by Reese Hyde.

@item 
gh-103673@footnote{https://github.com/python/cpython/issues/103673}: @ref{cd,,socketserver} gains @code{ForkingUnixStreamServer} and
@code{ForkingUnixDatagramServer} classes. Patch by Jay Berry.

@item 
gh-103636@footnote{https://github.com/python/cpython/issues/103636}: Added Enum for months and days in the calendar module.

@item 
gh-84976@footnote{https://github.com/python/cpython/issues/84976}: Create a new @code{Lib/_pydatetime.py} file that defines the Python
version of the @code{datetime} module, and make @code{datetime} import the
contents of the new library only if the C implementation is missing.
Currently, the full Python implementation is defined and then deleted if
the C implementation is not available, slowing down @code{import datetime}
unnecessarily.

@item 
gh-103596@footnote{https://github.com/python/cpython/issues/103596}: Attributes/methods are no longer shadowed by same-named enum
members, although they may be shadowed by enum.property’s.

@item 
gh-103584@footnote{https://github.com/python/cpython/issues/103584}: Updated @code{importlib.metadata} with changes from
@code{importlib_metadata} 5.2 through 6.5.0, including: Support
@code{installed-files.txt} for @code{Distribution.files} when present.
@code{PackageMetadata} now stipulates an additional @code{get} method allowing
for easy querying of metadata keys that may not be present.
@code{packages_distributions} now honors packages and modules with Python
modules that not @code{.py} sources (e.g. @code{.pyc}, @code{.so}). Expand protocol
for @code{PackageMetadata.get_all} to match the upstream implementation of
@code{email.message.Message.get_all} in python/typeshed#9620. Deprecated use
of @code{Distribution} without defining abstract methods. Deprecated
expectation that @code{PackageMetadata.__getitem__} will return @code{None} for
missing keys. In the future, it will raise a @code{KeyError}.

@item 
gh-103578@footnote{https://github.com/python/cpython/issues/103578}: Fixed a bug where @ref{a5,,pdb} crashes when reading source file
with different encoding by replacing @ref{5c0,,io.open()} with
@ref{172e,,io.open_code()}. The new method would also call into the hook set by
@ref{1730,,PyFile_SetOpenCodeHook()}.

@item 
gh-103556@footnote{https://github.com/python/cpython/issues/103556}: Now creating @ref{332,,inspect.Signature} objects with
positional-only parameter with a default followed by a
positional-or-keyword parameter without one is impossible.

@item 
gh-103559@footnote{https://github.com/python/cpython/issues/103559}: Update the bundled copy of pip to version 23.1.1.

@item 
gh-103548@footnote{https://github.com/python/cpython/issues/103548}: Improve performance of @ref{16b6,,pathlib.Path.absolute()} and
@ref{1731,,cwd()} by joining paths only when necessary. Also
improve performance of @ref{1732,,pathlib.PurePath.is_absolute()} on Posix by
skipping path parsing and normalization.

@item 
gh-103538@footnote{https://github.com/python/cpython/issues/103538}: Remove @code{_tkinter} module code guarded by definition of the
@code{TK_AQUA} macro which was only needed for Tk 8.4.7 or earlier and was
never actually defined by any build system or documented for manual use.

@item 
gh-103533@footnote{https://github.com/python/cpython/issues/103533}: Update @ref{28,,cProfile} to use PEP 669 API

@item 
gh-103525@footnote{https://github.com/python/cpython/issues/103525}: Fix misleading exception message when mixed @code{str} and
@code{bytes} arguments are supplied to @ref{54e,,pathlib.PurePath} and
@ref{19b,,Path}.

@item 
gh-103489@footnote{https://github.com/python/cpython/issues/103489}: Add @ref{560,,getconfig()} and
@ref{561,,setconfig()} to @ref{39e,,Connection} to
make configuration changes to a database connection. Patch by Erlend E.
Aasland.

@item 
gh-103365@footnote{https://github.com/python/cpython/issues/103365}: Set default Flag boundary to @code{STRICT} and fix bitwise
operations.

@item 
gh-103472@footnote{https://github.com/python/cpython/issues/103472}: Avoid a potential @ref{39d,,ResourceWarning} in
@ref{bc8,,http.client.HTTPConnection} by closing the proxy / tunnel’s
CONNECT response explicitly.

@item 
gh-103462@footnote{https://github.com/python/cpython/issues/103462}: Fixed an issue with using
@ref{1733,,writelines()} in @ref{b,,asyncio} to send very
large payloads that exceed the amount of data that can be written in one
call to @ref{e2d,,socket.socket.send()} or @ref{521,,socket.socket.sendmsg()},
resulting in the remaining buffer being left unwritten.

@item 
gh-103449@footnote{https://github.com/python/cpython/issues/103449}: Fix a bug in doc string generation in
@ref{32e,,dataclasses.dataclass()}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Isolate @code{_collections} (apply 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}). Patch by
Erlend E. Aasland.

@item 
gh-103357@footnote{https://github.com/python/cpython/issues/103357}: Added support for @ref{14d1,,logging.Formatter} @code{defaults}
parameter to @ref{121e,,logging.config.dictConfig()} and
@ref{bd9,,logging.config.fileConfig()}. Patch by Bar Harel.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Adapt the @ref{116,,winreg} extension module to 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: The performance of @ref{4ef,,isinstance()} checks against
@ref{4f0,,runtime-checkable protocols} has been
considerably improved for protocols that only have a few members. To
achieve this improvement, several internal implementation details of the
@ref{104,,typing} module have been refactored, including
@code{typing._ProtocolMeta.__instancecheck__},
@code{typing._is_callable_members_only}, and @code{typing._get_protocol_attrs}.
Patches by Alex Waygood.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: The members of a runtime-checkable protocol are now considered
«frozen» at runtime as soon as the class has been created. See
@ref{578,,«What’s new in Python 3.12»} for more
details.

@item 
gh-103256@footnote{https://github.com/python/cpython/issues/103256}: Fixed a bug that caused @ref{6a,,hmac} to raise an exception when
the requested hash algorithm was not available in OpenSSL despite being
available separately as part of @code{hashlib} itself.  It now falls back
properly to the built-in. This could happen when, for example, your
OpenSSL does not include SHA3 support and you want to compute
@code{hmac.digest(b'K', b'M', 'sha3_256')}.

@item 
gh-102778@footnote{https://github.com/python/cpython/issues/102778}: Support @code{sys.last_exc} in @ref{73,,idlelib}.

@item 
gh-103285@footnote{https://github.com/python/cpython/issues/103285}: Improve performance of @ref{a69,,ast.get_source_segment()}.

@item 
gh-103225@footnote{https://github.com/python/cpython/issues/103225}: Fix a bug in @ref{a5,,pdb} when displaying line numbers of
module-level source code.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Adapt the @ref{93,,msvcrt} extension module to 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Adapt the @ref{117,,winsound} extension module to 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}.

@item 
gh-93910@footnote{https://github.com/python/cpython/issues/93910}: Remove deprecation of enum @code{member.member} access.

@item 
gh-102978@footnote{https://github.com/python/cpython/issues/102978}: Fixes @ref{f13,,unittest.mock.patch()} not enforcing function
signatures for methods decorated with @code{@@classmethod} or
@code{@@staticmethod} when patch is called with @code{autospec=True}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Isolate @code{_socket} (apply 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}). Patch by Erlend E.
Aasland.

@item 
gh-100479@footnote{https://github.com/python/cpython/issues/100479}: Add @ref{54f,,pathlib.PurePath.with_segments()}, which creates a
path object from arguments. This method is called whenever a derivative
path is created, such as from @ref{1734,,pathlib.PurePath.parent}. Subclasses
may override this method to share information between path objects.

@item 
gh-103220@footnote{https://github.com/python/cpython/issues/103220}: Fix issue where @ref{163f,,os.path.join()} added a slash when joining
onto an incomplete UNC drive with a trailing slash on Windows.

@item 
gh-103204@footnote{https://github.com/python/cpython/issues/103204}: Fixes @ref{72,,http.server} accepting HTTP requests with HTTP
version numbers preceded by “+”, or “-”, or with digit-separating “_”
characters.  The length of the version numbers is also constrained.

@item 
gh-75586@footnote{https://github.com/python/cpython/issues/75586}: Fix various Windows-specific issues with @code{shutil.which}.

@item 
gh-103193@footnote{https://github.com/python/cpython/issues/103193}: Improve performance of @ref{53d,,inspect.getattr_static()}. Patch by
Alex Waygood.

@item 
gh-103176@footnote{https://github.com/python/cpython/issues/103176}: @ref{569,,sys._current_exceptions()} now returns a mapping from
thread-id to an exception instance, rather than to a @code{(typ, exc, tb)}
tuple.

@item 
gh-103143@footnote{https://github.com/python/cpython/issues/103143}: Polish the help messages and docstrings of @ref{a5,,pdb}.

@item 
gh-103015@footnote{https://github.com/python/cpython/issues/103015}: Add `entrypoint' keyword-only parameter to
@ref{55f,,sqlite3.Connection.load_extension()}, for overriding the SQLite
extension entry point. Patch by Erlend E. Aasland.

@item 
gh-103000@footnote{https://github.com/python/cpython/issues/103000}: Improve performance of @ref{1735,,dataclasses.astuple()} and
@ref{172b,,dataclasses.asdict()} in cases where the contents are common Python
types.

@item 
gh-102953@footnote{https://github.com/python/cpython/issues/102953}: The extraction methods in @ref{de,,tarfile}, and
@ref{516,,shutil.unpack_archive()}, have a new a `filter' argument that allows
limiting tar features than may be surprising or dangerous, such as
creating files outside the destination directory. See
@ref{517,,Extraction filters} for details.

@item 
gh-97696@footnote{https://github.com/python/cpython/issues/97696}: Implemented an eager task factory in asyncio. When used as a
task factory on an event loop, it performs eager execution of coroutines.
Coroutines that are able to complete synchronously (e.g. return or raise
without blocking) are returned immediately as a finished task, and the
task is never scheduled to the event loop. If the coroutine blocks, the
(pending) task is scheduled and returned.

@item 
gh-81079@footnote{https://github.com/python/cpython/issues/81079}: Add `case_sensitive' keyword-only argument to
@ref{388,,pathlib.Path.glob()} and @ref{389,,rglob()}.

@item 
gh-101819@footnote{https://github.com/python/cpython/issues/101819}: Isolate the @ref{7f,,io} extension module by applying 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}.
Patch by Kumar Aditya, Victor Stinner, and Erlend E. Aasland.

@item 
gh-91896@footnote{https://github.com/python/cpython/issues/91896}: Deprecate @code{collections.abc.ByteString}

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{19b,,pathlib.Path} construction by omitting the
path anchor from the internal list of path parts.

@item 
gh-102114@footnote{https://github.com/python/cpython/issues/102114}: Functions in the @ref{39,,dis} module that accept a source code
string as argument now print a more concise traceback when the string
contains a syntax or indentation error.

@item 
gh-62432@footnote{https://github.com/python/cpython/issues/62432}: The @ref{106,,unittest} runner will now exit with status code 5 if
no tests were run. It is common for test runner misconfiguration to fail
to find any tests, this should be an error.

@item 
gh-78079@footnote{https://github.com/python/cpython/issues/78079}: Fix incorrect normalization of UNC device path roots, and
partial UNC share path roots, in @ref{54e,,pathlib.PurePath}. Pathlib no
longer appends a trailing slash to such paths.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Add @ref{16d6,,tty.cfmakeraw()} and @ref{1684,,tty.cfmakecbreak()} to
@ref{100,,tty} and modernize, the behavior of @ref{16d5,,tty.setraw()} and
@ref{1683,,tty.setcbreak()} to use POSIX.1-2017 Chapter 11 «General Terminal
Interface» flag masks by default.

@item 
gh-101688@footnote{https://github.com/python/cpython/issues/101688}: Implement @ref{575,,types.get_original_bases()} to provide further
introspection for types.

@item 
gh-101640@footnote{https://github.com/python/cpython/issues/101640}: @ref{15c,,argparse.ArgumentParser} now catches errors when
writing messages, such as when @ref{9cc,,sys.stderr} is @code{None}. Patch by
Oleg Iarygin.

@item 
gh-83861@footnote{https://github.com/python/cpython/issues/83861}: Fix datetime.astimezone method return value when invoked on a
naive datetime instance that represents local time falling in a timezone
transition gap. PEP 495 requires that instances with fold=1 produce
earlier times than those with fold=0 in this case.

@item 
gh-89550@footnote{https://github.com/python/cpython/issues/89550}: Decrease execution time of some @ref{67,,gzip} file writes by 15%
by adding more appropriate buffering.

@item 
gh-95299@footnote{https://github.com/python/cpython/issues/95299}: Remove the bundled setuptools wheel from @code{ensurepip}, and stop
installing setuptools in environments created by @code{venv}.

@item 
gh-99353@footnote{https://github.com/python/cpython/issues/99353}: Respect the @ref{bc8,,http.client.HTTPConnection} @code{.debuglevel}
flag in @code{urllib.request.AbstractHTTPHandler} when its constructor
parameter @code{debuglevel} is not set. And do the same for @code{*HTTPS*}.

@item 
gh-98040@footnote{https://github.com/python/cpython/issues/98040}: Remove the long-deprecated @code{imp} module.

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: Deprecate @code{pkgutil.find_loader()} and
@code{pkgutil.get_loader()} in favor of @ref{3ff,,importlib.util.find_spec()}.

@item 
gh-94473@footnote{https://github.com/python/cpython/issues/94473}: Flatten arguments in @code{tkinter.Canvas.coords()}. It now
accepts not only @code{x1, y1, x2, y2, ...} and @code{[x1, y1, x2, y2, ...]},
but also @code{(x1, y1), (x2, y2), ...} and @code{[(x1, y1), (x2, y2), ...]}.

@item 
gh-98040@footnote{https://github.com/python/cpython/issues/98040}: Remove more deprecated importlib APIs: @code{find_loader()},
@code{find_module()}, @code{importlib.abc.Finder}, @code{pkgutil.ImpImporter},
@code{pkgutil.ImpLoader}.

@item 
gh-96522@footnote{https://github.com/python/cpython/issues/96522}: Fix potential deadlock in pty.spawn()

@item 
gh-96534@footnote{https://github.com/python/cpython/issues/96534}: Support divert(4) added in FreeBSD 14.

@item 
gh-87474@footnote{https://github.com/python/cpython/issues/87474}: Fix potential file descriptor leaks in
@ref{301,,subprocess.Popen}.

@item 
gh-94906@footnote{https://github.com/python/cpython/issues/94906}: Support multiple steps in @ref{541,,math.nextafter()}. Patch by
Shantanu Jain and Matthias Gorgens.

@item 
gh-51574@footnote{https://github.com/python/cpython/issues/51574}: Make @ref{37c,,tempfile.mkdtemp()} return absolute paths when its
`dir' parameter is relative.

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: Convert private @code{_posixsubprocess.fork_exec()} to use
Argument Clinic.

@item 
gh-92184@footnote{https://github.com/python/cpython/issues/92184}: When creating zip files using @ref{130,,zipfile}, @code{os.altsep}, if
not @code{None}, will always be treated as a path separator even when it is
not @code{/}. Patch by Carey Metcalfe.

@item 
bpo-46797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46797}: Deprecation warnings are now emitted for @code{ast.Num},
@code{ast.Bytes}, @code{ast.Str}, @code{ast.NameConstant} and
@code{ast.Ellipsis}. These have been documented as deprecated since
Python 3.8, and will be removed in Python 3.14.

@item 
bpo-44844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44844}: Enables @ref{115,,webbrowser} to detect and launch Microsoft Edge
browser.

@item 
bpo-45606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45606}: Fixed the bug in @ref{388,,pathlib.Path.glob()} – previously a
dangling symlink would not be found by this method when the pattern is an
exact match, but would be found when the pattern contains a wildcard or
the recursive wildcard (@code{**}). With this change, a dangling symlink will
be found in both cases.

@item 
bpo-23041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23041}: Add @ref{52e,,QUOTE_STRINGS} and @ref{52d,,QUOTE_NOTNULL}
to the suite of @ref{2a,,csv} module quoting styles.

@item 
bpo-24964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24964}: Added
@ref{1708,,http.client.HTTPConnection.get_proxy_response_headers()} that
provides access to the HTTP headers on a proxy server response to the
@code{CONNECT} request.

@item 
bpo-17258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17258}: @ref{94,,multiprocessing} now supports stronger HMAC algorithms
for inter-process connection authentication rather than only HMAC-MD5.

@item 
bpo-39744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39744}: Make @ref{1736,,asyncio.subprocess.Process.communicate()} close the
subprocess’s stdin even when called with @code{input=None}.

@item 
bpo-22708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22708}: http.client CONNECT method tunnel improvements: Use HTTP 1.1
protocol; send a matching Host: header with CONNECT, if one is not
provided; convert IDN domain names to Punycode. Patch by Michael Handler.
@end itemize

@node Documentation<9>,Tests<9>,Library<10>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id82}@anchor{1737}
@subsubsection Documentation



@itemize -

@item 
gh-67056@footnote{https://github.com/python/cpython/issues/67056}: Document that the effect of registering or unregistering an
@ref{d,,atexit} cleanup function from within a registered cleanup function
is undefined.

@item 
gh-103629@footnote{https://github.com/python/cpython/issues/103629}: Mention the new way of typing @code{**kwargs} with @code{Unpack} and
@code{TypedDict} introduced in 
@geindex Python Enhancement Proposals; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/}.

@item 
gh-48241@footnote{https://github.com/python/cpython/issues/48241}: Clarifying documentation about the url parameter to
urllib.request.urlopen and urllib.request.Request needing to be encoded
properly.

@item 
gh-86094@footnote{https://github.com/python/cpython/issues/86094}: Add support for Unicode Path Extra Field in ZipFile. Patch by
Yeojin Kim and Andrea Giudiceandrea

@item 
gh-99202@footnote{https://github.com/python/cpython/issues/99202}: Fix extension type from documentation for compiling in C++20
mode
@end itemize

@node Tests<9>,Build<10>,Documentation<9>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id83}@anchor{1738}
@subsubsection Tests



@itemize -

@item 
gh-104494@footnote{https://github.com/python/cpython/issues/104494}: Update @code{test_pack_configure_in} and
@code{test_place_configure_in} for changes to error message formatting in Tk
8.7.

@item 
gh-104461@footnote{https://github.com/python/cpython/issues/104461}: Run test_configure_screen on X11 only, since the @code{DISPLAY}
environment variable and @code{-screen} option for toplevels are not useful
on Tk for Win32 or Aqua.

@item 
gh-86275@footnote{https://github.com/python/cpython/issues/86275}: Added property-based tests to the @ref{133,,zoneinfo} tests, along
with stubs for the @code{hypothesis} interface. (Patch by Paul Ganssle)

@item 
gh-103329@footnote{https://github.com/python/cpython/issues/103329}: Regression tests for the behaviour of
@code{unittest.mock.PropertyMock} were added.

@item 
gh-102795@footnote{https://github.com/python/cpython/issues/102795}: fix use of poll in test_epoll’s test_control_and_wait

@item 
gh-75729@footnote{https://github.com/python/cpython/issues/75729}: Fix the @ref{1c6,,os.spawn*} tests failing on Windows
when the working directory or interpreter path contains spaces.
@end itemize

@node Build<10>,Windows<10>,Tests<9>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id84}@anchor{1739}
@subsubsection Build



@itemize -

@item 
gh-101282@footnote{https://github.com/python/cpython/issues/101282}: BOLT optimization is now applied to the libpython shared
library if building a shared library. BOLT instrumentation and application
settings can now be influenced via the @code{BOLT_INSTRUMENT_FLAGS} and
@code{BOLT_APPLY_FLAGS} configure variables.

@item 
gh-99017@footnote{https://github.com/python/cpython/issues/99017}: @code{PYTHON_FOR_REGEN} now require Python 3.10 or newer.

@item 
gh-104490@footnote{https://github.com/python/cpython/issues/104490}: Define @code{.PHONY} / virtual make targets consistently and
properly.

@item 
gh-104106@footnote{https://github.com/python/cpython/issues/104106}: Add gcc fallback of mkfifoat/mknodat for macOS. Patch by
Donghee Na.

@item 
gh-103532@footnote{https://github.com/python/cpython/issues/103532}: The @code{TKINTER_PROTECT_LOADTK} macro is no longer defined or
used in the @code{_tkinter} module.  It was previously only defined when
building against Tk 8.4.13 and older, but Tk older than 8.5.12 has been
unsupported since gh-91152@footnote{https://github.com/python/cpython/issues/91152}.

@item 
gh-99069@footnote{https://github.com/python/cpython/issues/99069}: Extended workaround defining @code{static_assert} when missing from
the libc headers to all clang and gcc builds. In particular, this fixes
building on macOS <= 10.10.

@item 
gh-100220@footnote{https://github.com/python/cpython/issues/100220}: Changed the default value of the @code{SHELL} Makefile variable
from @code{/bin/sh} to @code{/bin/sh -e} to ensure that complex recipes
correctly fail after an error. Previously, @code{make install} could fail to
install some files and yet return a successful result.

@item 
gh-90656@footnote{https://github.com/python/cpython/issues/90656}: Add platform triplets for 64-bit LoongArch:


@itemize *

@item 
loongarch64-linux-gnusf

@item 
loongarch64-linux-gnuf32

@item 
loongarch64-linux-gnu
@end itemize

Patch by Zhang Na.
@end itemize

@node Windows<10>,macOS<8>,Build<10>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id85}@anchor{173a}
@subsubsection Windows



@itemize -

@item 
gh-104623@footnote{https://github.com/python/cpython/issues/104623}: Update Windows installer to use SQLite 3.42.0.

@item 
gh-82814@footnote{https://github.com/python/cpython/issues/82814}: Fix a potential @code{[Errno 13] Permission denied} when using
@ref{11a0,,shutil.copystat()} within Windows Subsystem for Linux (WSL) on a
mounted filesystem by adding @code{errno.EACCES} to the list of ignored
errors within the internal implementation.

@item 
gh-103088@footnote{https://github.com/python/cpython/issues/103088}: Fix virtual environment @code{activate} script having
incorrect line endings for Cygwin.

@item 
gh-103088@footnote{https://github.com/python/cpython/issues/103088}: Fixes venvs not working in bash on Windows across different
disks

@item 
gh-102997@footnote{https://github.com/python/cpython/issues/102997}: Update Windows installer to use SQLite 3.41.2.

@item 
gh-88013@footnote{https://github.com/python/cpython/issues/88013}: Fixed a bug where @ref{228,,TypeError} was raised when calling
@code{ntpath.realpath()} with a bytes parameter in some cases.
@end itemize

@node macOS<8>,IDLE<10>,Windows<10>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id86}@anchor{173b}
@subsubsection macOS



@itemize -

@item 
gh-99834@footnote{https://github.com/python/cpython/issues/99834}: Update macOS installer to Tcl/Tk 8.6.13.

@item 
gh-104623@footnote{https://github.com/python/cpython/issues/104623}: Update macOS installer to SQLite 3.42.0.

@item 
gh-103545@footnote{https://github.com/python/cpython/issues/103545}: Add @code{os.PRIO_DARWIN_THREAD}, @code{os.PRIO_DARWIN_PROCESS},
@code{os.PRIO_DARWIN_BG} and @code{os.PRIO_DARWIN_NONUI}. These can be used with
@code{os.setpriority} to run the process at a lower priority and make use of
the efficiency cores on Apple Silicon systems.

@item 
gh-104180@footnote{https://github.com/python/cpython/issues/104180}: Support reading SOCKS proxy configuration from macOS System
Configuration. Patch by Sam Schott.

@item 
gh-60436@footnote{https://github.com/python/cpython/issues/60436}: update curses textbox to additionally handle backspace using the
@code{curses.ascii.DEL} key press.

@item 
gh-102997@footnote{https://github.com/python/cpython/issues/102997}: Update macOS installer to SQLite 3.41.2.
@end itemize

@node IDLE<10>,Tools/Demos<7>,macOS<8>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id87}@anchor{173c}
@subsubsection IDLE



@itemize -

@item 
gh-104499@footnote{https://github.com/python/cpython/issues/104499}: Fix completions for Tk Aqua 8.7 (currently blank).

@item 
gh-104496@footnote{https://github.com/python/cpython/issues/104496}: About prints both tcl and tk versions if different (expected
someday).

@item 
gh-88496@footnote{https://github.com/python/cpython/issues/88496}: Fix IDLE test hang on macOS.
@end itemize

@node Tools/Demos<7>,C API<10>,IDLE<10>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id88}@anchor{173d}
@subsubsection Tools/Demos



@itemize -

@item 
gh-104389@footnote{https://github.com/python/cpython/issues/104389}: Argument Clinic C converters now accept the @code{unused} keyword,
for wrapping a parameter with @ref{1722,,Py_UNUSED}. Patch by Erlend E.
Aasland.
@end itemize

@node C API<10>,,Tools/Demos<7>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id89}@anchor{173e}
@subsubsection C API



@itemize -

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: Added unstable C API for extracting the value of «compact»
integers: @ref{62c,,PyUnstable_Long_IsCompact()} and
@ref{62d,,PyUnstable_Long_CompactValue()}.

@item 
gh-104109@footnote{https://github.com/python/cpython/issues/104109}: We’ve added @code{Py_NewInterpreterFromConfig()} and
@code{PyInterpreterConfig} to the public C-API (but not the stable ABI; not
yet at least).  The new function may be used to create a new interpreter
with various features configured.  The function was added to support PEP
684 (per-interpreter GIL).

@item 
gh-103968@footnote{https://github.com/python/cpython/issues/103968}: @ref{621,,PyType_FromSpec()} and its variants now allow creating
classes whose metaclass overrides @ref{623,,tp_new}. The
@code{tp_new} is ignored. This behavior is deprecated and will be disallowed
in 3.14+. The new @ref{5f3,,PyType_FromMetaclass()} already disallows it.

@item 
gh-103743@footnote{https://github.com/python/cpython/issues/103743}: Add @ref{173f,,PyUnstable_Object_GC_NewWithExtraData()} function
that can be used to allocate additional memory after an object for data
not managed by Python.

@item 
gh-103295@footnote{https://github.com/python/cpython/issues/103295}: Introduced @ref{1740,,PyUnstable_WritePerfMapEntry()},
@ref{1741,,PyUnstable_PerfMapState_Init()} and
@ref{1742,,PyUnstable_PerfMapState_Fini()}. These allow extension modules (JIT
compilers in particular) to write to perf-map files in a thread safe
manner. The @ref{1743,,Soporte de Python para el perfilador perf de Linux} also uses these APIs to write
entries in the perf-map file.

@item 
gh-103509@footnote{https://github.com/python/cpython/issues/103509}: Added C API for extending types whose instance memory layout is
opaque: @ref{5eb,,PyType_Spec.basicsize} can now be zero or negative,
@ref{5ec,,PyObject_GetTypeData()} can be used to get subclass-specific data,
and @ref{5ee,,Py_TPFLAGS_ITEMS_AT_END} can be used to safely extend
variable-size objects. See 
@geindex Python Enhancement Proposals; PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/} for details.

@item 
gh-103091@footnote{https://github.com/python/cpython/issues/103091}: Add a new C-API function to eagerly assign a version tag to a
PyTypeObject: @code{PyUnstable_Type_AssignVersionTag()}.

@item 
gh-101408@footnote{https://github.com/python/cpython/issues/101408}: @ref{1744,,PyObject_GC_Resize} should calculate preheader size
if needed. Patch by Donghee Na.

@item 
gh-98836@footnote{https://github.com/python/cpython/issues/98836}: Add support of more formatting options (left aligning, octals,
uppercase hexadecimals, @code{intmax_t}, @code{ptrdiff_t},
@code{wchar_t} C strings, variable width and precision) in
@ref{47c,,PyUnicode_FromFormat()} and @ref{618,,PyUnicode_FromFormatV()}.

@item 
gh-96803@footnote{https://github.com/python/cpython/issues/96803}: Add unstable C-API functions to get the code object, lasti and
line number from the internal @code{_PyInterpreterFrame} in the limited API.
The functions are:


@itemize *

@item 
@code{PyCodeObject * PyUnstable_InterpreterFrame_GetCode(struct _PyInterpreterFrame *frame)}

@item 
@code{int PyUnstable_InterpreterFrame_GetLasti(struct _PyInterpreterFrame *frame)}

@item 
@code{int PyUnstable_InterpreterFrame_GetLine(struct _PyInterpreterFrame *frame)}
@end itemize
@end itemize

@node Python 3 12 0 alpha 7,Python 3 12 0 alpha 6,Python 3 12 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-7}@anchor{1745}
@subsection Python 3.12.0 alpha 7


`Release date: 2023-04-04'

@menu
* Core and Builtins: Core and Builtins<11>. 
* Library: Library<11>. 
* Documentation: Documentation<10>. 
* Tests: Tests<10>. 
* Build: Build<11>. 
* Windows: Windows<11>. 
* Tools/Demos: Tools/Demos<8>. 
* C API: C API<11>. 

@end menu

@node Core and Builtins<11>,Library<11>,,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id90}@anchor{1746}
@subsubsection Core and Builtins



@itemize -

@item 
gh-102192@footnote{https://github.com/python/cpython/issues/102192}: Deprecated @code{_PyErr_ChainExceptions} in favour of
@code{_PyErr_ChainExceptions1}.

@item 
gh-89987@footnote{https://github.com/python/cpython/issues/89987}: Reduce the number of inline @ref{799,,CACHE} entries for
@ref{1747,,BINARY_SUBSCR}.

@item 
gh-102859@footnote{https://github.com/python/cpython/issues/102859}: Removed @code{JUMP_IF_FALSE_OR_POP} and
@code{JUMP_IF_TRUE_OR_POP} instructions.

@item 
gh-101975@footnote{https://github.com/python/cpython/issues/101975}: Fixed @code{stacktop} value on tracing entries to avoid corruption
on garbage collection.

@item 
gh-102778@footnote{https://github.com/python/cpython/issues/102778}: Add @ref{565,,sys.last_exc} and deprecate @ref{566,,sys.last_type},
@ref{567,,sys.last_value} and @ref{568,,sys.last_traceback}, which hold the same
information in its legacy form.

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: Replace all occurrences of @code{COMPARE_AND_BRANCH} with
@ref{9fb,,COMPARE_OP}.

@item 
gh-102701@footnote{https://github.com/python/cpython/issues/102701}: Fix overflow when creating very large dict.

@item 
gh-102755@footnote{https://github.com/python/cpython/issues/102755}: Add @ref{299,,PyErr_DisplayException()} which takes just an
exception instance, to replace the legacy @code{PyErr_Display()} which
takes the @code{(typ, exc, tb)} triplet.

@item 
gh-102594@footnote{https://github.com/python/cpython/issues/102594}: Add note to exception raised in @code{PyErr_SetObject} when
normalization fails.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Shrink the number of inline @ref{799,,CACHE} entries used by
@ref{16f0,,LOAD_GLOBAL}.

@item 
gh-102491@footnote{https://github.com/python/cpython/issues/102491}: Improve import time of @code{platform} by removing IronPython
version parsing. The IronPython version parsing was not functional (see
@indicateurl{https://github.com/IronLanguages/ironpython3/issues/1667}).

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: Rearrage bits in first field (after header) of PyLongObject. *
Bits 0 and 1: 1 - sign. I.e. 0 for positive numbers, 1 for zero and 2 for
negative numbers. * Bit 2 reserved (probably for the immortal bit) * Bits
3+ the unsigned size.

This makes a few operations slightly more efficient, and will enable a
more compact and faster 2s-complement representation of most ints in
future.

@item 
gh-102397@footnote{https://github.com/python/cpython/issues/102397}: Fix segfault from race condition in signal handling during
garbage collection. Patch by Kumar Aditya.

@item 
gh-102406@footnote{https://github.com/python/cpython/issues/102406}: @ref{1c,,codecs} encoding/decoding errors now get the context
information (which operation and which codecs) attached as 
@geindex Python Enhancement Proposals; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}
notes instead of through chaining a new instance of the exception.

@item 
gh-102281@footnote{https://github.com/python/cpython/issues/102281}: Fix potential nullptr dereference and use of uninitialized
memory in fileutils. Patch by Max Bachmann.

@item 
gh-102300@footnote{https://github.com/python/cpython/issues/102300}: Reuse operands with refcount of 1 in float specializations of
BINARY_OP.

@item 
gh-102213@footnote{https://github.com/python/cpython/issues/102213}: Fix performance loss when accessing an object’s attributes with
@code{__getattr__}  defined.

@item 
gh-102255@footnote{https://github.com/python/cpython/issues/102255}: Improve build support for the Xbox. Patch by Max Bachmann.

@item 
gh-102027@footnote{https://github.com/python/cpython/issues/102027}: Fix SSE2 and SSE3 detection in @code{_blake2} internal module.
Patch by Max Bachmann.

@item 
gh-101865@footnote{https://github.com/python/cpython/issues/101865}: Deprecate @code{co_lnotab} in code objects, schedule it for
removal in Python 3.14

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Adapt @code{_pickle} to 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}. Patch by Mohamed Koubaa
and Erlend Aasland.
@end itemize

@node Library<11>,Documentation<10>,Core and Builtins<11>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id91}@anchor{1748}
@subsubsection Library



@itemize -

@item 
gh-103085@footnote{https://github.com/python/cpython/issues/103085}: Pure python @ref{1d3,,locale.getencoding()} will not warn
deprecation.

@item 
gh-103068@footnote{https://github.com/python/cpython/issues/103068}: It’s no longer possible to register conditional breakpoints in
@ref{1a8,,Pdb} that raise @ref{150,,SyntaxError}. Patch by Tian Gao.

@item 
gh-102549@footnote{https://github.com/python/cpython/issues/102549}: Don’t ignore exceptions in member type creation.

@item 
gh-103056@footnote{https://github.com/python/cpython/issues/103056}: Ensure final @code{_generate_next_value_} is a @code{staticmethod}.

@item 
gh-103046@footnote{https://github.com/python/cpython/issues/103046}: Display current line label correctly in @ref{39,,dis} when
@code{show_caches} is False and @code{lasti} points to a CACHE entry.

@item 
gh-102433@footnote{https://github.com/python/cpython/issues/102433}: @ref{4ef,,isinstance()} checks against @ref{4f0,,runtime-checkable protocols} now use
@ref{53d,,inspect.getattr_static()} rather than @ref{579,,hasattr()} to lookup
whether attributes exist. This means that descriptors and
@ref{57a,,__getattr__()} methods are no longer unexpectedly evaluated
during @code{isinstance()} checks against runtime-checkable protocols.
However, it may also mean that some objects which used to be considered
instances of a runtime-checkable protocol may no longer be considered
instances of that protocol on Python 3.12+, and vice versa. Most users are
unlikely to be affected by this change. Patch by Alex Waygood.

@item 
gh-103023@footnote{https://github.com/python/cpython/issues/103023}: It’s no longer possible to register expressions to display in
@ref{1a8,,Pdb} that raise @ref{150,,SyntaxError}. Patch by Tian Gao.

@item 
gh-102947@footnote{https://github.com/python/cpython/issues/102947}: Improve traceback when @ref{15ca,,dataclasses.fields()} is called on
a non-dataclass. Patch by Alex Waygood

@item 
gh-102780@footnote{https://github.com/python/cpython/issues/102780}: The @ref{16d4,,asyncio.Timeout} context manager now works reliably
even when performing cleanup due to task cancellation.  Previously it
could raise a @ref{31f,,CancelledError} instead of an
@ref{1749,,TimeoutError} in such cases.

@item 
gh-102871@footnote{https://github.com/python/cpython/issues/102871}: Remove support for obsolete browsers from @ref{115,,webbrowser}.
Removed browsers include Grail, Mosaic, Netscape, Galeon, Skipstone,
Iceape, Firebird, and Firefox versions 35 and below.

@item 
gh-102839@footnote{https://github.com/python/cpython/issues/102839}: Improve performance of @ref{14fc,,math.log()} arguments handling by
removing the argument clinic.

@item 
gh-102828@footnote{https://github.com/python/cpython/issues/102828}: Add the @code{onexc} arg to @ref{1f9,,shutil.rmtree()}, which is like
@code{onerror} but expects an exception instance rather than an exc_info
tuple. Deprecate @code{onerror}.

@item 
gh-88965@footnote{https://github.com/python/cpython/issues/88965}: typing: Fix a bug relating to substitution in custom classes
generic over a @ref{2ca,,ParamSpec}. Previously, if the
@code{ParamSpec} was substituted with a parameters list that itself contained
a @ref{2c9,,TypeVar}, the @code{TypeVar} in the parameters list could
not be subsequently substituted. This is now fixed.

Patch by Nikita Sobolev.

@item 
gh-76846@footnote{https://github.com/python/cpython/issues/76846}: Fix issue where @code{__new__()} and @code{__init__()} methods of
@ref{54e,,pathlib.PurePath} and @ref{19b,,Path} subclasses were not
called in some circumstances.

@item 
gh-78530@footnote{https://github.com/python/cpython/issues/78530}: @ref{528,,asyncio.wait()} now accepts generators yielding tasks.
Patch by Kumar Aditya.

@item 
gh-102748@footnote{https://github.com/python/cpython/issues/102748}: @ref{527,,asyncio.iscoroutine()} now returns @code{False} for
generators as @ref{b,,asyncio} does not support legacy generator-based
coroutines. Patch by Kumar Aditya.

@item 
gh-102670@footnote{https://github.com/python/cpython/issues/102670}: Optimized fmean(), correlation(), covariance(), and
linear_regression() using the new math.sumprod() function.

@item 
gh-102615@footnote{https://github.com/python/cpython/issues/102615}: Typing: Improve the @code{repr} of generic aliases for classes
generic over a @ref{2ca,,ParamSpec}. (Use square brackets to
represent a parameter list.)

@item 
gh-100112@footnote{https://github.com/python/cpython/issues/100112}: @ref{a6d,,asyncio.Task.get_coro()} now always returns a coroutine
when wrapping an awaitable object. Patch by Kumar Aditya.

@item 
gh-102578@footnote{https://github.com/python/cpython/issues/102578}: Speed up setting or deleting mutable attributes on
non-dataclass subclasses of frozen dataclasses. Due to the implementation
of @code{__setattr__} and @code{__delattr__} for frozen dataclasses, this
previously had a time complexity of `O'(`n'). It now has a time
complexity of `O'(1).

@item 
gh-102519@footnote{https://github.com/python/cpython/issues/102519}: Add @ref{545,,os.listdrives()}, @ref{546,,os.listvolumes()} and
@ref{547,,os.listmounts()} functions on Windows for enumerating drives, volumes
and mount points

@item 
gh-74468@footnote{https://github.com/python/cpython/issues/74468}: Attribute name of the extracted @ref{de,,tarfile} file object now
holds filename of itself rather than of the archive it is contained in.
Patch by Oleg Iarygin.

@item 
gh-102378@footnote{https://github.com/python/cpython/issues/102378}: Private helper method
@code{inspect._signature_strip_non_python_syntax} will no longer strip @code{/}
from the input string.

@item 
gh-79940@footnote{https://github.com/python/cpython/issues/79940}: Add @ref{53b,,inspect.getasyncgenstate()} and
@ref{53c,,inspect.getasyncgenlocals()}. Patch by Thomas Krennwallner.

@item 
gh-102103@footnote{https://github.com/python/cpython/issues/102103}: Add @code{module} argument to @ref{15db,,dataclasses.make_dataclass()}
and make classes produced by it pickleable.

@item 
gh-102069@footnote{https://github.com/python/cpython/issues/102069}: Fix @code{__weakref__} descriptor generation for custom
dataclasses.

@item 
gh-102038@footnote{https://github.com/python/cpython/issues/102038}: Skip a @code{stat} in @ref{c7,,site} if we have already found a
@code{pyvenv.cfg}

@item 
gh-98886@footnote{https://github.com/python/cpython/issues/98886}: Fix issues when defining dataclasses that have fields with
specific underscore names that aren’t clearly reserved by
@ref{30,,dataclasses}.

@item 
gh-101673@footnote{https://github.com/python/cpython/issues/101673}: Fix a @ref{a5,,pdb} bug where @code{ll} clears the changes to local
variables.

@item 
gh-101313@footnote{https://github.com/python/cpython/issues/101313}: Added -h and –help arguments to the webbrowser CLI

@item 
gh-100372@footnote{https://github.com/python/cpython/issues/100372}: @ref{f6e,,ssl.SSLContext.load_verify_locations()} no longer
incorrectly accepts some cases of trailing data when parsing DER.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Fix pathlib.Path.walk RecursionError on deep directory trees by
rewriting it using iteration instead of recursion.

@item 
gh-100131@footnote{https://github.com/python/cpython/issues/100131}: Added an optional @code{delete} keyword argument to
@ref{12a1,,tempfile.TemporaryDirectory}.

@item 
gh-48330@footnote{https://github.com/python/cpython/issues/48330}: Added @code{--durations} command line option, showing the N slowest
test cases. @ref{174a,,unittest.TextTestRunner} and
@ref{5d4,,unittest.TextTestResult} constructors accept a new `durations'
keyword argument. Subclasses should take this into account or accept
@code{**kwargs}. Added @ref{174b,,unittest.TestResult.addDuration()} method and
@ref{1714,,unittest.TestResult.collectedDurations} attribute.

(Contributed by Giampaolo Rodola)

@item 
gh-98169@footnote{https://github.com/python/cpython/issues/98169}: Fix @ref{1735,,dataclasses.astuple()} crash when
@ref{122a,,collections.defaultdict} is present in the attributes.

@item 
gh-96931@footnote{https://github.com/python/cpython/issues/96931}: Fix incorrect results from @ref{eec,,ssl.SSLSocket.shared_ciphers()}

@item 
gh-95495@footnote{https://github.com/python/cpython/issues/95495}: When built against OpenSSL 3.0, the @ref{d0,,ssl} module had a bug
where it reported unauthenticated EOFs (i.e. without close_notify) as a
clean TLS-level EOF. It now raises @ref{174c,,SSLEOFError}, matching the
behavior in previous versions of OpenSSL. The
@ref{8cf,,options} attribute on @ref{1fa,,SSLContext} also
no longer includes @ref{8ce,,OP_IGNORE_UNEXPECTED_EOF} by default. This
option may be set to specify the previous OpenSSL 3.0 behavior.

@item 
gh-94684@footnote{https://github.com/python/cpython/issues/94684}: Now @ref{174d,,uuid.uuid3()} and @ref{174e,,uuid.uuid5()} functions support
@ref{325,,bytes} objects as their `name' argument.

@item 
gh-94440@footnote{https://github.com/python/cpython/issues/94440}: Fix a @code{concurrent.futures.process} bug where
@code{ProcessPoolExecutor} shutdown could hang after a future has been
quickly submitted and canceled.

@item 
gh-72346@footnote{https://github.com/python/cpython/issues/72346}: Added deprecation warning to `isdst' parameter of
@ref{217,,email.utils.localtime()}.

@item 
bpo-36305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36305}: Fix handling of Windows filenames that resemble drives, such as
@code{./a:b}, in @ref{a4,,pathlib}.
@end itemize

@node Documentation<10>,Tests<10>,Library<11>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id92}@anchor{174f}
@subsubsection Documentation



@itemize -

@item 
gh-103112@footnote{https://github.com/python/cpython/issues/103112}: Add docstring to @ref{1750,,http.client.HTTPResponse.read()} to fix
@code{pydoc} output.
@end itemize

@node Tests<10>,Build<11>,Documentation<10>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id93}@anchor{1751}
@subsubsection Tests



@itemize -

@item 
gh-102980@footnote{https://github.com/python/cpython/issues/102980}: Improve test coverage on @ref{a5,,pdb}.

@item 
gh-102537@footnote{https://github.com/python/cpython/issues/102537}: Adjust the error handling strategy in
@code{test_zoneinfo.TzPathTest.python_tzpath_context}. Patch by Paul Ganssle.

@item 
gh-101377@footnote{https://github.com/python/cpython/issues/101377}: Improved test_locale_calendar_formatweekday of calendar.
@end itemize

@node Build<11>,Windows<11>,Tests<10>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id94}@anchor{1752}
@subsubsection Build



@itemize -

@item 
gh-102973@footnote{https://github.com/python/cpython/issues/102973}: Add a dev container (along with accompanying Dockerfile) for
development purposes.

@item 
gh-102711@footnote{https://github.com/python/cpython/issues/102711}: Fix @code{-Wstrict-prototypes} compiler warnings.
@end itemize

@node Windows<11>,Tools/Demos<8>,Build<11>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id95}@anchor{1753}
@subsubsection Windows



@itemize -

@item 
gh-102690@footnote{https://github.com/python/cpython/issues/102690}: Update @ref{115,,webbrowser} to fall back to Microsoft Edge instead
of Internet Explorer.

@item 
gh-99726@footnote{https://github.com/python/cpython/issues/99726}: Improves correctness of stat results for Windows, and uses
faster API when available
@end itemize

@node Tools/Demos<8>,C API<11>,Windows<11>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id96}@anchor{1754}
@subsubsection Tools/Demos



@itemize -

@item 
gh-102809@footnote{https://github.com/python/cpython/issues/102809}: @code{Misc/gdbinit} was removed.
@end itemize

@node C API<11>,,Tools/Demos<8>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id97}@anchor{1755}
@subsubsection C API



@itemize -

@item 
gh-102013@footnote{https://github.com/python/cpython/issues/102013}: Add a new (unstable) C-API function for iterating over GC’able
objects using a callback: @code{PyUnstable_VisitObjects}.
@end itemize

@node Python 3 12 0 alpha 6,Python 3 12 0 alpha 5,Python 3 12 0 alpha 7,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-6}@anchor{1756}
@subsection Python 3.12.0 alpha 6


`Release date: 2023-03-07'

@menu
* Security: Security<9>. 
* Core and Builtins: Core and Builtins<12>. 
* Library: Library<12>. 
* Documentation: Documentation<11>. 
* Tests: Tests<11>. 
* Build: Build<12>. 
* Windows: Windows<12>. 
* macOS: macOS<9>. 
* C API: C API<12>. 

@end menu

@node Security<9>,Core and Builtins<12>,,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id98}@anchor{1757}
@subsubsection Security



@itemize -

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Replace builtin hashlib implementations of MD5 and SHA1 with
verified ones from the HACL* project.

@item 
gh-101727@footnote{https://github.com/python/cpython/issues/101727}: Updated the OpenSSL version used in Windows and macOS binary
release builds to 1.1.1t to address 
@geindex Common Vulnerabilities and Exposures; CVE 2023-0286
CVE 2023-0286@footnote{https://www.cve.org/CVERecord?id=CVE-2023-0286}, 
@geindex Common Vulnerabilities and Exposures; CVE 2022-4303
CVE 2022-4303@footnote{https://www.cve.org/CVERecord?id=CVE-2022-4303},
and 
@geindex Common Vulnerabilities and Exposures; CVE 2022-4303
CVE 2022-4303@footnote{https://www.cve.org/CVERecord?id=CVE-2022-4303} per the OpenSSL 2023-02-07 security advisory@footnote{https://openssl-library.org/news/secadv/20230207.txt}.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Replace the builtin @ref{68,,hashlib} implementations of SHA2-384
and SHA2-512 originally from LibTomCrypt with formally verified,
side-channel resistant code from the HACL*@footnote{https://github.com/hacl-star/hacl-star/} project. The builtins remain a
fallback only used when OpenSSL does not provide them.

@item 
gh-101283@footnote{https://github.com/python/cpython/issues/101283}: @ref{301,,subprocess.Popen} now uses a safer approach to find
@code{cmd.exe} when launching with @code{shell=True}. Patch by Eryk Sun, based
on a patch by Oleg Iarygin.
@end itemize

@node Core and Builtins<12>,Library<12>,Security<9>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id99}@anchor{1758}
@subsubsection Core and Builtins



@itemize -

@item 
gh-102493@footnote{https://github.com/python/cpython/issues/102493}: Fix regression in semantics of normalisation in
@code{PyErr_SetObject}.

@item 
gh-102416@footnote{https://github.com/python/cpython/issues/102416}: Do not memoize incorrectly automatically generated loop rules
in the parser. Patch by Pablo Galindo.

@item 
gh-102356@footnote{https://github.com/python/cpython/issues/102356}: Fix a bug that caused a crash when deallocating deeply nested
filter objects. Patch by Marta Gómez Macías.

@item 
gh-102336@footnote{https://github.com/python/cpython/issues/102336}: Cleanup Windows 7 specific special handling. Patch by Max
Bachmann.

@item 
gh-102250@footnote{https://github.com/python/cpython/issues/102250}: Fixed a segfault occurring when the interpreter calls a
@code{__bool__} method that raises.

@item 
gh-102126@footnote{https://github.com/python/cpython/issues/102126}: Fix deadlock at shutdown when clearing thread states if any
finalizer tries to acquire the runtime head lock. Patch by Kumar Aditya.

@item 
gh-102027@footnote{https://github.com/python/cpython/issues/102027}: Use @code{GetCurrentProcessId} on Windows when @code{getpid} is
unavailable. Patch by Max Bachmann.

@item 
gh-102056@footnote{https://github.com/python/cpython/issues/102056}: Fix error handling bugs in interpreter’s exception printing
code, which could cause a crash on infinite recursion.

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: Restrict the scope of the @code{FOR_ITER_RANGE} instruction
to the scope of the original @ref{1759,,FOR_ITER} instruction, to allow
instrumentation.

@item 
gh-101967@footnote{https://github.com/python/cpython/issues/101967}: Fix possible segfault in @code{positional_only_passed_as_keyword}
function, when new list created.

@item 
gh-101952@footnote{https://github.com/python/cpython/issues/101952}: Fix possible segfault in @code{BUILD_SET} opcode, when new set
created.

@item 
gh-74895@footnote{https://github.com/python/cpython/issues/74895}: @ref{175a,,socket.getaddrinfo} no longer raises
@ref{919,,OverflowError} for @ref{1f0,,int} `port' values outside of the C
long range. Out of range values are left up to the underlying string based
C library API to report. A @ref{175b,,socket.gaierror} @code{SAI_SERVICE} may
occur instead, or no error at all as not all platform C libraries generate
an error.

@item 
gh-101799@footnote{https://github.com/python/cpython/issues/101799}: Add @ref{589,,CALL_INTRINSIC_2} and use it instead of
@code{PREP_RERAISE_STAR}.

@item 
gh-101857@footnote{https://github.com/python/cpython/issues/101857}: Fix xattr support detection on Linux systems by widening the
check to linux, not just glibc. This fixes support for musl.

@item 
gh-84783@footnote{https://github.com/python/cpython/issues/84783}: Make the slice object hashable. Patch by Will Bradshaw and
Furkan Onder.

@item 
gh-87849@footnote{https://github.com/python/cpython/issues/87849}: Change the @code{SEND} instruction to leave the receiver on the
stack. This allows the specialized form of @code{SEND} to skip the chain of C
calls and jump directly to the @code{RESUME} in the generator or coroutine.

@item 
gh-101765@footnote{https://github.com/python/cpython/issues/101765}: Fix SystemError / segmentation fault in iter @code{__reduce__}
when internal access of @code{builtins.__dict__} keys mutates the iter
object.

@item 
gh-101430@footnote{https://github.com/python/cpython/issues/101430}: Update @ref{ff,,tracemalloc} to handle presize of object properly.
Patch by Donghee Na.

@item 
gh-101696@footnote{https://github.com/python/cpython/issues/101696}: Invalidate type version tag in @code{_PyStaticType_Dealloc} for
static types, avoiding bug where a false cache hit could crash the
interpreter. Patch by Kumar Aditya.

@item 
gh-101632@footnote{https://github.com/python/cpython/issues/101632}: Adds a new @code{RETURN_CONST} instruction.

@item 
gh-100719@footnote{https://github.com/python/cpython/issues/100719}: Remove gi_code field from generator (and coroutine and async
generator) objects as it is redundant. The frame already includes a
reference to the code object.

@item 
gh-98627@footnote{https://github.com/python/cpython/issues/98627}: When an interpreter is configured to check (and only then),
importing an extension module will now fail when the extension does not
support multiple interpreters (i.e. doesn’t implement PEP 489 multi-phase
init). This does not apply to the main interpreter, nor to subinterpreters
created with @code{Py_NewInterpreter()}.
@end itemize

@node Library<12>,Documentation<11>,Core and Builtins<12>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id100}@anchor{175c}
@subsubsection Library



@itemize -

@item 
gh-102302@footnote{https://github.com/python/cpython/issues/102302}: Micro-optimise hashing of @ref{333,,inspect.Parameter}, reducing
the time it takes to hash an instance by around 40%.

@item 
gh-101979@footnote{https://github.com/python/cpython/issues/101979}: Fix a bug where parentheses in the @code{metavar} argument to
@ref{306,,argparse.ArgumentParser.add_argument()} were dropped. Patch by Yeojin
Kim.

@item 
gh-91038@footnote{https://github.com/python/cpython/issues/91038}: @ref{175d,,platform.platform()} now has boolean default arguments.

@item 
gh-81652@footnote{https://github.com/python/cpython/issues/81652}: Add @ref{175e,,mmap.MAP_ALIGNED_SUPER} FreeBSD and
@ref{175f,,mmap.MAP_CONCEAL} OpenBSD constants to @ref{90,,mmap}. Patch by
Yeojin Kim.

@item 
gh-102179@footnote{https://github.com/python/cpython/issues/102179}: Fix @ref{beb,,os.dup2()} error message for negative fds.

@item 
gh-101961@footnote{https://github.com/python/cpython/issues/101961}: For the binary mode, @code{fileinput.hookcompressed()} doesn’t
set the @code{encoding} value even if the value is @code{None}. Patch by Gihwan
Kim.

@item 
gh-101936@footnote{https://github.com/python/cpython/issues/101936}: The default value of @code{fp} becomes @ref{f25,,io.BytesIO} if
@ref{105d,,HTTPError} is initialized without a designated @code{fp}
parameter. Patch by Long Vo.

@item 
gh-101566@footnote{https://github.com/python/cpython/issues/101566}: In zipfile, sync Path with zipp 3.14@footnote{https://zipp.readthedocs.io/en/latest/history.html#v3-14-0}, including
fix for extractall on the underlying zipfile after being wrapped in
@code{Path}.

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: Apply changes from importlib_resources 5.12@footnote{https://importlib-resources.readthedocs.io/en/latest/history.html#v5-12-0},
including fix for @code{MultiplexedPath} to support directories in multiple
namespaces (python/importlib_resources#265).

@item 
gh-101997@footnote{https://github.com/python/cpython/issues/101997}: Upgrade pip wheel bundled with ensurepip (pip 23.0.1)

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: The built-in extension modules for @ref{68,,hashlib} SHA2
algorithms, used when OpenSSL does not provide them, now live in a single
internal @code{_sha2} module instead of separate @code{_sha256} and @code{_sha512}
modules.

@item 
gh-101892@footnote{https://github.com/python/cpython/issues/101892}: Callable iterators no longer raise @ref{619,,SystemError} when
the callable object exhausts the iterator but forgets to either return a
sentinel value or raise @ref{c82,,StopIteration}.

@item 
gh-87634@footnote{https://github.com/python/cpython/issues/87634}: Remove locking behavior from @ref{5e4,,functools.cached_property()}.

@item 
gh-97786@footnote{https://github.com/python/cpython/issues/97786}: Fix potential undefined behaviour in corner cases of
floating-point-to-time conversions.

@item 
gh-101517@footnote{https://github.com/python/cpython/issues/101517}: Fixed bug where @ref{10,,bdb} looks up the source line with
@ref{85,,linecache} with a @code{lineno=None}, which causes it to fail with an
unhandled exception.

@item 
gh-101773@footnote{https://github.com/python/cpython/issues/101773}: Optimize @ref{177,,fractions.Fraction} for small components. The
private argument @code{_normalize} of the @ref{177,,fractions.Fraction}
constructor has been removed.

@item 
gh-101693@footnote{https://github.com/python/cpython/issues/101693}: In @ref{400,,sqlite3.Cursor.execute()}, @ref{1da,,DeprecationWarning} is
now emitted when @ref{402,,named placeholders} are used
together with parameters supplied as a @ref{597,,sequence} instead of as a
@ref{190,,dict}. Starting from Python 3.14, using named placeholders with
parameters supplied as a sequence will raise a
@ref{223,,ProgrammingError}. Patch by Erlend E. Aasland.

@item 
gh-101446@footnote{https://github.com/python/cpython/issues/101446}: Change repr of @ref{67c,,collections.OrderedDict} to use regular
dictionary formatting instead of pairs of keys and values.

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{54e,,pathlib.PurePath} construction by handling
arguments more uniformly. When a @ref{19b,,pathlib.Path} argument is
supplied, we use its string representation rather than joining its parts
with @ref{163f,,os.path.join()}.

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{54e,,pathlib.PurePath} construction by calling
@ref{163f,,os.path.join()} only when two or more arguments are given.

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{19b,,pathlib.Path} construction by running the path
flavour compatibility check only when pathlib is imported.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Refactored the implementation of @ref{1760,,pty.fork()} to use
@ref{1761,,os.login_tty()}.

A @ref{1da,,DeprecationWarning} is now raised by @code{pty.master_open()} and
@code{pty.slave_open()}. They were undocumented and deprecated long long ago
in the docstring in favor of @ref{221,,pty.openpty()}.

@item 
gh-101561@footnote{https://github.com/python/cpython/issues/101561}: Add a new decorator @ref{4f8,,typing.override()}. See 
@geindex Python Enhancement Proposals; PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/} for
details. Patch by Steven Troxler.

@item 
gh-63301@footnote{https://github.com/python/cpython/issues/63301}: Set exit code when @ref{dd,,tabnanny} CLI exits on error.

@item 
gh-101360@footnote{https://github.com/python/cpython/issues/101360}: Fix anchor matching in @code{pathlib.PureWindowsPath.match()}.
Path and pattern anchors are now matched with @ref{5c,,fnmatch}, just like
other path parts. This allows patterns such as @code{"*:/Users/*"} to be
matched.

@item 
gh-101277@footnote{https://github.com/python/cpython/issues/101277}: Remove global state from @ref{81,,itertools} module (
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}).
Patches by Erlend E. Aasland.

@item 
gh-100809@footnote{https://github.com/python/cpython/issues/100809}: Fix handling of drive-relative paths (like “C:” and “C:foo”) in
@ref{16b6,,pathlib.Path.absolute()}. This method now uses the OS API to retrieve
the correct current working directory for the drive.

@item 
gh-99138@footnote{https://github.com/python/cpython/issues/99138}: Apply 
@geindex Python Enhancement Proposals; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/} to @ref{133,,zoneinfo}. Patch by Erlend E. Aasland.

@item 
gh-96764@footnote{https://github.com/python/cpython/issues/96764}: @ref{6a0,,asyncio.wait_for()} now uses @ref{69f,,asyncio.timeout()} as its
underlying implementation. Patch by Kumar Aditya.

@item 
gh-88233@footnote{https://github.com/python/cpython/issues/88233}: Correctly preserve «extra» fields in @code{zipfile} regardless of
their ordering relative to a zip64 «extra.»

@item 
bpo-23224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23224}: Fix segfaults when creating @ref{1762,,lzma.LZMADecompressor} and
@ref{1763,,bz2.BZ2Decompressor} objects without calling @code{__init__()}, and
fix leakage of locks and internal buffers when calling the @code{__init__()}
methods of @ref{1762,,lzma.LZMADecompressor}, @ref{1764,,lzma.LZMACompressor},
@ref{1765,,bz2.BZ2Compressor}, and @ref{1763,,bz2.BZ2Decompressor} objects
multiple times.
@end itemize

@node Documentation<11>,Tests<11>,Library<12>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id101}@anchor{1766}
@subsubsection Documentation



@itemize -

@item 
gh-85417@footnote{https://github.com/python/cpython/issues/85417}: Update @ref{19,,cmath} documentation to clarify behaviour on branch
cuts.

@item 
gh-97725@footnote{https://github.com/python/cpython/issues/97725}: Fix @ref{1767,,asyncio.Task.print_stack()} description for
@code{file=None}. Patch by Oleg Iarygin.
@end itemize

@node Tests<11>,Build<12>,Documentation<11>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id102}@anchor{1768}
@subsubsection Tests



@itemize -

@item 
gh-102019@footnote{https://github.com/python/cpython/issues/102019}: Fix deadlock on shutdown if @code{test_current_@{exception,frames@}}
fails. Patch by Jacob Bower.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Utilize new «winsize» functions from termios in pty tests.

@item 
gh-89792@footnote{https://github.com/python/cpython/issues/89792}: @code{test_tools} now copies up to 10x less source data to a
temporary directory during the @code{freeze} test by ignoring git metadata
and other artifacts.  It also limits its python build parallelism based on
os.cpu_count instead of hard coding it as 8 cores.
@end itemize

@node Build<12>,Windows<12>,Tests<11>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id103}@anchor{1769}
@subsubsection Build



@itemize -

@item 
gh-99942@footnote{https://github.com/python/cpython/issues/99942}: On Android, in a static build, python-config in embed mode no
longer incorrectly reports a library to link to.

@item 
gh-99942@footnote{https://github.com/python/cpython/issues/99942}: On Android, python.pc now correctly reports the library to link
to, the same as python-config.sh.

@item 
gh-100221@footnote{https://github.com/python/cpython/issues/100221}: Fix creating install directories in @code{make sharedinstall} if
they exist outside @code{DESTDIR} already.

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: Explicitly mark C extension modules that need defined signed
integer overflow, and add a configure option
@ref{176a,,--with-strict-overflow}. Patch by Matthias Görgens and Shantanu
Jain.
@end itemize

@node Windows<12>,macOS<9>,Build<12>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id104}@anchor{176b}
@subsubsection Windows



@itemize -

@item 
gh-102344@footnote{https://github.com/python/cpython/issues/102344}: Implement @code{winreg.QueryValue} using @code{QueryValueEx} and
@code{winreg.SetValue} using @code{SetValueEx}. Patch by Max Bachmann.

@item 
gh-101881@footnote{https://github.com/python/cpython/issues/101881}: Handle read and write operations on non-blocking pipes properly
on Windows.

@item 
gh-101881@footnote{https://github.com/python/cpython/issues/101881}: Add support for the os.get_blocking() and os.set_blocking()
functions on Windows.

@item 
gh-101849@footnote{https://github.com/python/cpython/issues/101849}: Ensures installer will correctly upgrade existing @code{py.exe}
launcher installs.

@item 
gh-101763@footnote{https://github.com/python/cpython/issues/101763}: Updates copy of libffi bundled with Windows installs to 3.4.4.

@item 
gh-101759@footnote{https://github.com/python/cpython/issues/101759}: Update Windows installer to SQLite 3.40.1.

@item 
gh-101614@footnote{https://github.com/python/cpython/issues/101614}: Correctly handle extensions built against debug binaries that
reference @code{python3_d.dll}.

@item 
gh-101196@footnote{https://github.com/python/cpython/issues/101196}: The functions @code{os.path.isdir}, @code{os.path.isfile},
@code{os.path.islink} and @code{os.path.exists} are now 13% to 28% faster on
Windows, by making fewer Win32 API calls.
@end itemize

@node macOS<9>,C API<12>,Windows<12>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id105}@anchor{176c}
@subsubsection macOS



@itemize -

@item 
gh-101759@footnote{https://github.com/python/cpython/issues/101759}: Update macOS installer to SQLite 3.40.1.
@end itemize

@node C API<12>,,macOS<9>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id106}@anchor{176d}
@subsubsection C API



@itemize -

@item 
gh-101907@footnote{https://github.com/python/cpython/issues/101907}: Removes use of non-standard C++ extension in public header
files.

@item 
gh-99293@footnote{https://github.com/python/cpython/issues/99293}: Document that the Py_TPFLAGS_VALID_VERSION_TAG is an internal
feature, should not be used, and will be removed.

@item 
gh-101578@footnote{https://github.com/python/cpython/issues/101578}: Add @ref{28b,,PyErr_GetRaisedException()} and
@ref{28e,,PyErr_SetRaisedException()} for saving and restoring the current
exception. These functions return and accept a single exception object,
rather than the triple arguments of the now-deprecated
@ref{28a,,PyErr_Fetch()} and @ref{28d,,PyErr_Restore()}. This is less error
prone and a bit more efficient.

Add @ref{60e,,PyException_GetArgs()} and @ref{60f,,PyException_SetArgs()} as
convenience functions for retrieving and modifying the
@ref{610,,args} passed to the exception’s constructor.

@item 
gh-91744@footnote{https://github.com/python/cpython/issues/91744}: Introduced the `Unstable C API tier', marking APi that is
allowed to change in minor releases without a deprecation period. See
@geindex Python Enhancement Proposals; PEP 689
PEP 689@footnote{https://peps.python.org/pep-0689/} for details.
@end itemize

@node Python 3 12 0 alpha 5,Python 3 12 0 alpha 4,Python 3 12 0 alpha 6,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-5}@anchor{176e}
@subsection Python 3.12.0 alpha 5


`Release date: 2023-02-07'

@menu
* Security: Security<10>. 
* Core and Builtins: Core and Builtins<13>. 
* Library: Library<13>. 
* Documentation: Documentation<12>. 
* Tests: Tests<12>. 
* Build: Build<13>. 
* Windows: Windows<13>. 

@end menu

@node Security<10>,Core and Builtins<13>,,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id107}@anchor{176f}
@subsubsection Security



@itemize -

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Replace the builtin @ref{68,,hashlib} implementations of SHA2-224
and SHA2-256 originally from LibTomCrypt with formally verified,
side-channel resistant code from the HACL*@footnote{https://github.com/hacl-star/hacl-star/} project. The builtins remain a
fallback only used when OpenSSL does not provide them.
@end itemize

@node Core and Builtins<13>,Library<13>,Security<10>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id109}@anchor{1770}
@subsubsection Core and Builtins



@itemize -

@item 
gh-92173@footnote{https://github.com/python/cpython/issues/92173}: Fix the @code{defs} and @code{kwdefs} arguments to
@ref{1771,,PyEval_EvalCodeEx()} and a reference leak in that function.

@item 
gh-59956@footnote{https://github.com/python/cpython/issues/59956}: The GILState API is now partially compatible with
subinterpreters. Previously, @code{PyThreadState_GET()} and
@code{PyGILState_GetThisThreadState()} would get out of sync, causing
inconsistent behavior and crashes.

@item 
gh-101400@footnote{https://github.com/python/cpython/issues/101400}: Fix wrong lineno in exception message on @ref{a5b,,continue} or
@ref{b34,,break} which are not in a loop. Patch by Donghee Na.

@item 
gh-101372@footnote{https://github.com/python/cpython/issues/101372}: Fix @ref{adb,,is_normalized()} to properly handle the
UCD 3.2.0 cases. Patch by Donghee Na.

@item 
gh-101266@footnote{https://github.com/python/cpython/issues/101266}: Fix @ref{1772,,sys.getsizeof()} reporting for @ref{1f0,,int}
subclasses.

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: Refactor the @code{PyLongObject} struct into a normal Python
object header and a @code{PyLongValue} struct.

@item 
gh-101046@footnote{https://github.com/python/cpython/issues/101046}: Fix a possible memory leak in the parser when raising
@ref{16cb,,MemoryError}. Patch by Pablo Galindo

@item 
gh-101037@footnote{https://github.com/python/cpython/issues/101037}: Fix potential memory underallocation issue for instances of
@ref{1f0,,int} subclasses with value zero.

@item 
gh-100762@footnote{https://github.com/python/cpython/issues/100762}: Record the (virtual) exception block depth in the oparg of
@ref{407,,YIELD_VALUE}. Use this to avoid the expensive @code{throw()} when
closing generators (and coroutines) that can be closed trivially.

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: Adds a new @code{COMPARE_AND_BRANCH} instruction. This is a
bit more efficient when performing a comparison immediately followed by a
branch, and restores the design intent of PEP 659 that specializations are
local to a single instruction.

@item 
gh-100942@footnote{https://github.com/python/cpython/issues/100942}: Fixed segfault in property.getter/setter/deleter that occurred
when a property subclass overrode the @code{__new__} method to return a
non-property instance.

@item 
gh-100923@footnote{https://github.com/python/cpython/issues/100923}: Remove the @code{mask} cache entry for the @ref{9fb,,COMPARE_OP}
instruction and embed the mask into the oparg.

@item 
gh-100892@footnote{https://github.com/python/cpython/issues/100892}: Fix race while iterating over thread states in clearing
@ref{1773,,threading.local}. Patch by Kumar Aditya.

@item 
gh-91351@footnote{https://github.com/python/cpython/issues/91351}: Fix a case where re-entrant imports could corrupt the import
deadlock detection code and cause a @ref{438,,KeyError} to be raised out of
@code{importlib/_bootstrap}.  In addition to the straightforward cases,
this could also happen when garbage collection leads to a warning being
emitted – as happens when it collects an open socket or file)

@item 
gh-100726@footnote{https://github.com/python/cpython/issues/100726}: Optimize construction of @code{range} object for medium size
integers.

@item 
gh-100712@footnote{https://github.com/python/cpython/issues/100712}: Added option to build cpython with specialization disabled, by
setting @code{ENABLE_SPECIALIZATION=False} in @code{opcode}, followed by
@code{make regen-all}.

@item 
bpo-32780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32780}: Inter-field padding is now inserted into the PEP3118 format
strings obtained from @ref{166,,ctypes.Structure} objects, reflecting their
true representation in memory.
@end itemize

@node Library<13>,Documentation<12>,Core and Builtins<13>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id110}@anchor{1774}
@subsubsection Library



@itemize -

@item 
gh-101541@footnote{https://github.com/python/cpython/issues/101541}: [Enum] - fix psuedo-flag creation

@item 
gh-101570@footnote{https://github.com/python/cpython/issues/101570}: Upgrade pip wheel bundled with ensurepip (pip 23.0)

@item 
gh-101323@footnote{https://github.com/python/cpython/issues/101323}: Fix a bug where errors where not thrown by
zlib._ZlibDecompressor if encountered during decompressing.

@item 
gh-101317@footnote{https://github.com/python/cpython/issues/101317}: Add `ssl_shutdown_timeout' parameter for
@ref{6a5,,asyncio.StreamWriter.start_tls()}.

@item 
gh-101326@footnote{https://github.com/python/cpython/issues/101326}: Fix regression when passing @code{None} as second or third
argument to @code{FutureIter.throw}.

@item 
gh-92123@footnote{https://github.com/python/cpython/issues/92123}: Adapt the @code{_elementtree} extension module to multi-phase init
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}). Patches by Erlend E. Aasland.

@item 
gh-100795@footnote{https://github.com/python/cpython/issues/100795}: Avoid potential unexpected @code{freeaddrinfo} call (double free)
in @ref{cc,,socket} when when a libc @code{getaddrinfo()} implementation leaves
garbage in an output pointer when returning an error. Original patch by
Sergey G. Brester.

@item 
gh-101143@footnote{https://github.com/python/cpython/issues/101143}: Remove unused references to @ref{1775,,TimerHandle} in
@code{asyncio.base_events.BaseEventLoop._add_callback}.

@item 
gh-101144@footnote{https://github.com/python/cpython/issues/101144}: Make @ref{1598,,zipfile.Path.open()} and
@ref{1776,,zipfile.Path.read_text()} also accept @code{encoding} as a positional
argument. This was the behavior in Python 3.9 and earlier.  3.10
introduced a regression where supplying it as a positional argument would
lead to a @ref{228,,TypeError}.

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: Group-related variables of @code{_posixsubprocess} module are
renamed to stress that supplementary group affinity is added to a fork,
not replace the inherited ones. Patch by Oleg Iarygin.

@item 
gh-101015@footnote{https://github.com/python/cpython/issues/101015}: Fix @ref{752,,typing.get_type_hints()} on @code{'*tuple[...]'} and
@code{*tuple[...]}. It must not drop the @code{Unpack} part.

@item 
gh-101000@footnote{https://github.com/python/cpython/issues/101000}: Add @ref{54c,,os.path.splitroot()}, which splits a path into a
3-item tuple @code{(drive, root, tail)}. This new function is used by
@ref{a4,,pathlib} to improve the performance of path construction by up to a
third.

@item 
gh-100573@footnote{https://github.com/python/cpython/issues/100573}: Fix a Windows @ref{b,,asyncio} bug with named pipes where a
client doing @code{os.stat()} on the pipe would cause an error in the server
that disabled serving future requests.

@item 
gh-39615@footnote{https://github.com/python/cpython/issues/39615}: @ref{155a,,warnings.warn()} now has the ability to skip stack frames
based on code filename prefix rather than only a numeric @code{stacklevel}
via the new @code{skip_file_prefixes} keyword argument.

@item 
gh-100750@footnote{https://github.com/python/cpython/issues/100750}: pass encoding kwarg to subprocess in platform

@item 
gh-100160@footnote{https://github.com/python/cpython/issues/100160}: Emit a deprecation warning in
@code{asyncio.DefaultEventLoopPolicy.get_event_loop()} if there is no
current event loop set and it decides to create one.

@item 
gh-96290@footnote{https://github.com/python/cpython/issues/96290}: Fix handling of partial and invalid UNC drives in
@code{ntpath.splitdrive()}, and in @code{ntpath.normpath()} on non-Windows
systems. Paths such as “\server” and “\” are now considered by
@code{splitdrive()} to contain only a drive, and consequently are not
modified by @code{normpath()} on non-Windows systems. The behaviour of
@code{normpath()} on Windows systems is unaffected, as native OS APIs are
used. Patch by Eryk Sun, with contributions by Barney Gale.

@item 
gh-99952@footnote{https://github.com/python/cpython/issues/99952}: Fix a reference undercounting issue in @ref{166,,ctypes.Structure}
with @code{from_param()} results larger than a C pointer.

@item 
gh-67790@footnote{https://github.com/python/cpython/issues/67790}: Add float-style formatting support for
@ref{177,,fractions.Fraction} instances.

@item 
gh-99266@footnote{https://github.com/python/cpython/issues/99266}: Preserve more detailed error messages in @ref{2b,,ctypes}.

@item 
gh-86682@footnote{https://github.com/python/cpython/issues/86682}: Ensure runtime-created collections have the correct module name
using the newly added (internal) @ref{1777,,sys._getframemodulename()}.

@item 
gh-88597@footnote{https://github.com/python/cpython/issues/88597}: @ref{110,,uuid} now has a command line interface. Try @code{python -m
uuid -h}.

@item 
gh-60580@footnote{https://github.com/python/cpython/issues/60580}: @code{ctypes.wintypes.BYTE} definition changed from
@ref{1778,,c_byte} to @ref{1779,,c_ubyte} to match Windows SDK.
Patch by Anatoly Techtonik and Oleg Iarygin.

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: @code{_posixsubprocess} now initializes all UID and GID variables
using a reserved @code{-1} value instead of a separate flag. Patch by Oleg
Iarygin.

@item 
bpo-38941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38941}: The @ref{125,,xml.etree.ElementTree} module now emits
@ref{1da,,DeprecationWarning} when testing the truth value of an
@ref{20b,,xml.etree.ElementTree.Element}. Before, the Python implementation
emitted @ref{4d4,,FutureWarning}, and the C implementation emitted nothing.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @code{elementtree} types to heap types. Patch by Erlend
E. Aasland.

@item 
bpo-29847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29847}: Fix a bug where @ref{19b,,pathlib.Path} accepted and ignored
keyword arguments. Patch provided by Yurii Karabas.

@item 
gh-77772@footnote{https://github.com/python/cpython/issues/77772}: @ref{a7b,,ctypes.CDLL}, @ref{177a,,ctypes.OleDLL},
@ref{177b,,ctypes.WinDLL}, and @ref{177c,,ctypes.PyDLL} now accept
@ref{3f0,,path-like objects} as their @code{name} argument.
Patch by Robert Hoelzl.
@end itemize

@node Documentation<12>,Tests<12>,Library<13>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id111}@anchor{177d}
@subsubsection Documentation



@itemize -

@item 
gh-88324@footnote{https://github.com/python/cpython/issues/88324}: Reword @ref{d6,,subprocess} to emphasize default behavior of
`stdin', `stdout', and `stderr' arguments. Remove inaccurate statement
about child file handle inheritance.
@end itemize

@node Tests<12>,Build<13>,Documentation<12>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id112}@anchor{177e}
@subsubsection Tests



@itemize -

@item 
gh-101334@footnote{https://github.com/python/cpython/issues/101334}: @code{test_tarfile} has been updated to pass when run as a high
UID.
@end itemize

@node Build<13>,Windows<13>,Tests<12>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id113}@anchor{177f}
@subsubsection Build



@itemize -

@item 
gh-101282@footnote{https://github.com/python/cpython/issues/101282}: Update BOLT configuration not to use deprecated usage of
@code{--split functions}. Patch by Donghee Na.

@item 
gh-101522@footnote{https://github.com/python/cpython/issues/101522}: Allow overriding Windows dependencies versions and paths using
MSBuild properties.

@item 
gh-77532@footnote{https://github.com/python/cpython/issues/77532}: Minor fixes to allow building with @code{PlatformToolset=ClangCL}
on Windows.

@item 
gh-101152@footnote{https://github.com/python/cpython/issues/101152}: In accordance with 
@geindex Python Enhancement Proposals; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}, the @code{ma_version_tag} field in
@ref{4a3,,PyDictObject} is deprecated for extension modules. Accessing this
field will generate a compiler warning at compile time. This field will be
removed in Python 3.14.

@item 
gh-100340@footnote{https://github.com/python/cpython/issues/100340}: Allows -Wno-int-conversion for wasm-sdk 17 and onwards, thus
enables building WASI builds once against the latest sdk.

@item 
gh-101060@footnote{https://github.com/python/cpython/issues/101060}: Conditionally add @code{-fno-reorder-blocks-and-partition} in
configure. Effectively fixes @code{--enable-bolt} when using Clang, as this
appears to be a GCC-only flag.

@item 
gh-98705@footnote{https://github.com/python/cpython/issues/98705}: @code{__bool__} is defined in AIX system header files which breaks
the build in AIX, so undefine it.

@item 
gh-98636@footnote{https://github.com/python/cpython/issues/98636}: Fix a regression in detecting @code{gdbm_compat} library for the
@code{_gdbm} module build.

@item 
gh-96305@footnote{https://github.com/python/cpython/issues/96305}: @code{_aix_support} now uses a simple code to get platform details
rather than the now non-existent @code{_bootsubprocess} during bootstrap.
@end itemize

@node Windows<13>,,Build<13>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id114}@anchor{1780}
@subsubsection Windows



@itemize -

@item 
gh-101543@footnote{https://github.com/python/cpython/issues/101543}: Ensure the install path in the registry is only used when the
standard library hasn’t been located in any other way.

@item 
gh-101467@footnote{https://github.com/python/cpython/issues/101467}: The @code{py.exe} launcher now correctly filters when only a
single runtime is installed. It also correctly handles prefix matches on
tags so that @code{-3.1} does not match @code{3.11}, but would still match
@code{3.1-32}.

@item 
gh-99834@footnote{https://github.com/python/cpython/issues/99834}: Updates bundled copy of Tcl/Tk to 8.6.13.0

@item 
gh-101135@footnote{https://github.com/python/cpython/issues/101135}: Restore ability to launch older 32-bit versions from the
@code{py.exe} launcher when both 32-bit and 64-bit installs of the same
version are available.

@item 
gh-82052@footnote{https://github.com/python/cpython/issues/82052}: Fixed an issue where writing more than 32K of Unicode output to
the console screen in one go can result in mojibake.

@item 
gh-100320@footnote{https://github.com/python/cpython/issues/100320}: Ensures the @code{PythonPath} registry key from an install is used
when launching from a different copy of Python that relies on an existing
install to provide a copy of its modules and standard library.

@item 
gh-100247@footnote{https://github.com/python/cpython/issues/100247}: Restores support for the @code{py.exe} launcher finding
shebang commands in its configuration file using the full command name.
@end itemize

@node Python 3 12 0 alpha 4,Python 3 12 0 alpha 3,Python 3 12 0 alpha 5,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-4}@anchor{1781}
@subsection Python 3.12.0 alpha 4


`Release date: 2023-01-10'

@menu
* Core and Builtins: Core and Builtins<14>. 
* Library: Library<14>. 
* Documentation: Documentation<13>. 
* Tests: Tests<13>. 
* Build: Build<14>. 
* Windows: Windows<14>. 
* macOS: macOS<10>. 
* Tools/Demos: Tools/Demos<9>. 
* C API: C API<13>. 

@end menu

@node Core and Builtins<14>,Library<14>,,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id115}@anchor{1782}
@subsubsection Core and Builtins



@itemize -

@item 
gh-100776@footnote{https://github.com/python/cpython/issues/100776}: Fix misleading default value in @ref{1340,,input()}”s
@code{__text_signature__}.

@item 
gh-99005@footnote{https://github.com/python/cpython/issues/99005}: Remove @code{UNARY_POSITIVE}, @code{ASYNC_GEN_WRAP} and
@code{LIST_TO_TUPLE}, replacing them with intrinsics.

@item 
gh-99005@footnote{https://github.com/python/cpython/issues/99005}: Add new @ref{588,,CALL_INTRINSIC_1} instruction. Remove
@code{IMPORT_STAR}, @code{PRINT_EXPR} and
@code{STOPITERATION_ERROR}, replacing them with the
@ref{588,,CALL_INTRINSIC_1} instruction.

@item 
gh-100288@footnote{https://github.com/python/cpython/issues/100288}: Remove the LOAD_ATTR_METHOD_WITH_DICT specialized instruction.
Stats show it is not useful.

@item 
gh-100720@footnote{https://github.com/python/cpython/issues/100720}: Added @code{_PyFrame_NumSlotsForCodeObject}, which returns the
number of slots needed in a frame for a given code object.

@item 
gh-100719@footnote{https://github.com/python/cpython/issues/100719}: Removed the co_nplaincellvars field from the code object, as it
is redundant.

@item 
gh-100637@footnote{https://github.com/python/cpython/issues/100637}: Fix @code{int.__sizeof__()} calculation to include the 1-element
@code{ob_digit} array for @code{0} and @code{False}.

@item 
gh-100649@footnote{https://github.com/python/cpython/issues/100649}: Update the native_thread_id field of PyThreadState after fork.

@item 
gh-100126@footnote{https://github.com/python/cpython/issues/100126}: Fix an issue where «incomplete» frames could be briefly visible
to C code while other frames are being torn down, possibly resulting in
corruption or hard crashes of the interpreter while running finalizers.

@item 
gh-87447@footnote{https://github.com/python/cpython/issues/87447}: Fix @ref{150,,SyntaxError} on comprehension rebind checking with
names that are not actually redefined.

Now reassigning @code{b} in @code{[(b := 1) for a, b.prop in some_iter]} is
allowed. Reassigning @code{a} is still disallowed as per 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}.

@item 
gh-100268@footnote{https://github.com/python/cpython/issues/100268}: Add @ref{1783,,int.is_integer()} to improve duck type compatibility
between @ref{1f0,,int} and @ref{153,,float}.

@item 
gh-100425@footnote{https://github.com/python/cpython/issues/100425}: Improve the accuracy of @code{sum()} with compensated summation.

@item 
gh-100374@footnote{https://github.com/python/cpython/issues/100374}: Fix incorrect result and delay in @ref{1784,,socket.getfqdn()}. Patch
by Dominic Socular.

@item 
gh-100357@footnote{https://github.com/python/cpython/issues/100357}: Convert @code{vars}, @code{dir}, @code{next}, @code{getattr}, and @code{iter}
to argument clinic.

@item 
gh-100117@footnote{https://github.com/python/cpython/issues/100117}: Improve the output of @ref{1f3,,codeobject.co_lines()} by emitting
only one entry for each line range.

@item 
gh-90043@footnote{https://github.com/python/cpython/issues/90043}: Handle NaNs when specializing @ref{9fb,,COMPARE_OP} for
@ref{153,,float} values.

@item 
gh-100222@footnote{https://github.com/python/cpython/issues/100222}: Redefine the @code{_Py_CODEUNIT} typedef as a union to describe
its layout to the C compiler, avoiding type punning and improving clarity.

@item 
gh-99955@footnote{https://github.com/python/cpython/issues/99955}: Internal compiler functions (in compile.c) now consistently
return -1 on error and 0 on success.

@item 
gh-100188@footnote{https://github.com/python/cpython/issues/100188}: The @code{BINARY_SUBSCR_LIST_INT} and @code{BINARY_SUBSCR_TUPLE_INT}
instructions are no longer used for negative integers because those
instructions always miss when encountering negative integers.

@item 
gh-99110@footnote{https://github.com/python/cpython/issues/99110}: Initialize frame->previous in frameobject.c to fix a
segmentation fault when accessing frames created by @code{PyFrame_New()}.

@item 
gh-94155@footnote{https://github.com/python/cpython/issues/94155}: Improved the hashing algorithm for code objects, mitigating some
hash collisions.

@item 
gh-99540@footnote{https://github.com/python/cpython/issues/99540}: @code{None} now hashes to a constant value. This is not a
requirements change.

@item 
gh-100143@footnote{https://github.com/python/cpython/issues/100143}: When built with @code{--enable-pystats}, stats collection is now
off by default. To enable it early at startup, pass the @code{-Xpystats}
flag.  Stats are now always dumped, even if switched off.

@item 
gh-100146@footnote{https://github.com/python/cpython/issues/100146}: Improve @code{BUILD_LIST} opcode so that it works similarly to the
@code{BUILD_TUPLE} opcode, by stealing references from the stack rather than
repeatedly using stack operations to set list elements.  Implementation
details are in a new private API @code{_PyList_FromArraySteal()}.

@item 
gh-100110@footnote{https://github.com/python/cpython/issues/100110}: Specialize @code{FOR_ITER} for tuples.

@item 
gh-100050@footnote{https://github.com/python/cpython/issues/100050}: Honor existing errors obtained when searching for mismatching
parentheses in the tokenizer. Patch by Pablo Galindo

@item 
gh-92216@footnote{https://github.com/python/cpython/issues/92216}: Improve the performance of @ref{579,,hasattr()} for type objects with
a missing attribute.

@item 
gh-99582@footnote{https://github.com/python/cpython/issues/99582}: Freeze @ref{131,,zipimport} module into @code{_bootstrap_python}.

@item 
gh-99554@footnote{https://github.com/python/cpython/issues/99554}: Pack debugging location tables more efficiently during bytecode
compilation.

@item 
gh-98522@footnote{https://github.com/python/cpython/issues/98522}: Add an internal version number to code objects, to give better
versioning of inner functions and comprehensions, and thus better
specialization of those functions. This change is invisible to both Python
and C extensions.

@item 
gh-94603@footnote{https://github.com/python/cpython/issues/94603}: Improve performance of @code{list.pop} for small lists.

@item 
gh-89051@footnote{https://github.com/python/cpython/issues/89051}: Add @ref{1785,,ssl.OP_LEGACY_SERVER_CONNECT}

@item 
bpo-32782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32782}: @code{ctypes} arrays of length 0 now report a correct itemsize
when a @code{memoryview} is constructed from them, rather than always giving
a value of 0.
@end itemize

@node Library<14>,Documentation<13>,Core and Builtins<14>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id116}@anchor{1786}
@subsubsection Library



@itemize -

@item 
gh-100833@footnote{https://github.com/python/cpython/issues/100833}: Speed up @ref{1414,,math.fsum()} by removing defensive @code{volatile}
qualifiers.

@item 
gh-100805@footnote{https://github.com/python/cpython/issues/100805}: Modify @ref{129d,,random.choice()} implementation to once again work
with NumPy arrays.

@item 
gh-100813@footnote{https://github.com/python/cpython/issues/100813}: Add @code{socket.IP_PKTINFO} constant.

@item 
gh-100792@footnote{https://github.com/python/cpython/issues/100792}: Make @ref{1787,,email.message.Message.__contains__()} twice as fast.

@item 
gh-91851@footnote{https://github.com/python/cpython/issues/91851}: Microoptimizations for @ref{1788,,fractions.Fraction.__round__()},
@ref{1789,,fractions.Fraction.__ceil__()} and
@ref{178a,,fractions.Fraction.__floor__()}.

@item 
gh-90104@footnote{https://github.com/python/cpython/issues/90104}: Avoid RecursionError on @code{repr} if a dataclass field definition
has a cyclic reference.

@item 
gh-100689@footnote{https://github.com/python/cpython/issues/100689}: Fix crash in @code{pyexpat} by statically allocating
@code{PyExpat_CAPI} capsule.

@item 
gh-100740@footnote{https://github.com/python/cpython/issues/100740}: Fix @code{unittest.mock.Mock} not respecting the spec for
attribute names prefixed with @code{assert}.

@item 
gh-91219@footnote{https://github.com/python/cpython/issues/91219}: Change @code{SimpleHTTPRequestHandler} to support subclassing to
provide a different set of index file names instead of using @code{__init__}
parameters.

@item 
gh-100690@footnote{https://github.com/python/cpython/issues/100690}: @code{Mock} objects which are not unsafe will now raise an
@code{AttributeError} when accessing an attribute that matches the name of an
assertion but without the prefix @code{assert_}, e.g. accessing
@code{called_once} instead of @code{assert_called_once}. This is in addition to
this already happening for accessing attributes with prefixes @code{assert},
@code{assret}, @code{asert}, @code{aseert}, and @code{assrt}.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Simplify and optimize @ref{551,,os.walk()} by using
@ref{4ef,,isinstance()} checks to check the top of the stack.

@item 
gh-100485@footnote{https://github.com/python/cpython/issues/100485}: Add math.sumprod() to compute the sum of products.

@item 
gh-86508@footnote{https://github.com/python/cpython/issues/86508}: Fix @ref{ba3,,asyncio.open_connection()} to skip binding to local
addresses of different family. Patch by Kumar Aditya.

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: @code{importlib.resources.files} now accepts a module as an anchor
instead of only accepting packages. If a module is passed, resources are
resolved adjacent to that module (in the same package or at the package
root). The parameter was renamed from @code{package} to @code{anchor} with a
compatibility shim for those passing by keyword. Additionally, the new
@code{anchor} parameter is now optional and will default to the caller’s
module.

@item 
gh-100585@footnote{https://github.com/python/cpython/issues/100585}: Fixed a bug where importlib.resources.as_file was leaving file
pointers open

@item 
gh-100562@footnote{https://github.com/python/cpython/issues/100562}: Improve performance of @ref{16b6,,pathlib.Path.absolute()} by nearly
2x. This comes at the cost of a performance regression in
@ref{1731,,pathlib.Path.cwd()}, which is generally used less frequently in user
code.

@item 
gh-100519@footnote{https://github.com/python/cpython/issues/100519}: Small simplification of @code{http.cookiejar.eff_request_host()}
that improves readability and better matches the RFC wording.

@item 
gh-100287@footnote{https://github.com/python/cpython/issues/100287}: Fix the interaction of @ref{c29,,unittest.mock.seal()} with
@ref{add,,unittest.mock.AsyncMock}.

@item 
gh-100488@footnote{https://github.com/python/cpython/issues/100488}: Add @code{Fraction.is_integer()} to check whether a
@ref{177,,fractions.Fraction} is an integer. This improves duck type
compatibility with @ref{153,,float} and @ref{1f0,,int}.

@item 
gh-100474@footnote{https://github.com/python/cpython/issues/100474}: @ref{72,,http.server} now checks that an index page is actually a
regular file before trying to serve it.  This avoids issues with
directories named @code{index.html}.

@item 
gh-100363@footnote{https://github.com/python/cpython/issues/100363}: Speed up @ref{b96,,asyncio.get_running_loop()} by removing redundant
@code{getpid} checks. Patch by Kumar Aditya.

@item 
gh-78878@footnote{https://github.com/python/cpython/issues/78878}: Fix crash when creating an instance of @code{_ctypes.CField}.

@item 
gh-100348@footnote{https://github.com/python/cpython/issues/100348}: Fix ref cycle in @code{asyncio._SelectorSocketTransport} by
removing @code{_read_ready_cb} in @code{close}.

@item 
gh-100344@footnote{https://github.com/python/cpython/issues/100344}: Provide C implementation for @ref{526,,asyncio.current_task()} for a
4x-6x speedup.

@item 
gh-100272@footnote{https://github.com/python/cpython/issues/100272}: Fix JSON serialization of OrderedDict.  It now preserves the
order of keys.

@item 
gh-83076@footnote{https://github.com/python/cpython/issues/83076}: Instantiation of @code{Mock()} and @code{AsyncMock()} is now 3.8x
faster.

@item 
gh-100234@footnote{https://github.com/python/cpython/issues/100234}: Set a default value of 1.0 for the @code{lambd} parameter in
random.expovariate().

@item 
gh-100228@footnote{https://github.com/python/cpython/issues/100228}: A @ref{1da,,DeprecationWarning} may be raised when @ref{2ff,,os.fork()}
or @ref{300,,os.forkpty()} is called from multi-threaded processes.  Forking
with threads is unsafe and can cause deadlocks, crashes and subtle
problems. Lack of a warning does not indicate that the fork call was
actually safe, as Python may not be aware of all threads.

@item 
gh-100039@footnote{https://github.com/python/cpython/issues/100039}: Improve signatures for enums and flags.

@item 
gh-100133@footnote{https://github.com/python/cpython/issues/100133}: Fix regression in @ref{b,,asyncio} where a subprocess would
sometimes lose data received from pipe.

@item 
bpo-44592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44592}: Fixes inconsistent handling of case sensitivity of
`extrasaction' arg in @ref{126b,,csv.DictWriter}.

@item 
gh-100098@footnote{https://github.com/python/cpython/issues/100098}: Fix @code{tuple} subclasses being cast to @code{tuple} when used as
enum values.

@item 
gh-85432@footnote{https://github.com/python/cpython/issues/85432}: Rename the `fmt' parameter of the pure-Python implementation of
@ref{178b,,datetime.time.strftime()} to `format'. Rename the `t' parameter of
@ref{593,,datetime.datetime.fromtimestamp()} to `timestamp'. These changes mean
the parameter names in the pure-Python implementation now match the
parameter names in the C implementation. Patch by Alex Waygood.

@item 
gh-98778@footnote{https://github.com/python/cpython/issues/98778}: Update @ref{105d,,HTTPError} to be initialized
properly, even if the @code{fp} is @code{None}. Patch by Donghee Na.

@item 
gh-99925@footnote{https://github.com/python/cpython/issues/99925}: Unify error messages in JSON serialization between
@code{json.dumps(float('nan'), allow_nan=False)} and
@code{json.dumps(float('nan'), allow_nan=False, indent=<SOMETHING>)}. Now
both include the representation of the value that could not be serialized.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Fix issue with @ref{551,,os.walk()} where a @ref{df1,,RecursionError}
would occur on deep directory structures by adjusting the implementation
of @ref{551,,os.walk()} to be iterative instead of recursive.

@item 
gh-94943@footnote{https://github.com/python/cpython/issues/94943}: Add @ref{178c,,Soporte de Dataclass} to the @ref{6d1,,Enum}
@ref{178d,,__repr__()}. When inheriting from a
@ref{32e,,dataclass}, only show the field names in the value
section of the member @ref{894,,repr()}, and not the dataclass” class name.

@item 
gh-83035@footnote{https://github.com/python/cpython/issues/83035}: Fix @ref{15ce,,inspect.getsource()} handling of decorator calls with
nested parentheses.

@item 
gh-99576@footnote{https://github.com/python/cpython/issues/99576}: Fix @code{.save()} method for @code{LWPCookieJar} and
@code{MozillaCookieJar}: saved file was not truncated on repeated save.

@item 
gh-94912@footnote{https://github.com/python/cpython/issues/94912}: Add @ref{539,,inspect.markcoroutinefunction()} decorator which
manually marks a function as a coroutine for the benefit of
@code{iscoroutinefunction()}.

@item 
gh-99509@footnote{https://github.com/python/cpython/issues/99509}: Add 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} support for
@code{multiprocessing.queues.Queue}.

@item 
gh-99482@footnote{https://github.com/python/cpython/issues/99482}: Remove @code{Jython} partial compatibility code from several stdlib
modules.

@item 
gh-99433@footnote{https://github.com/python/cpython/issues/99433}: Fix @ref{3b,,doctest} failure on @ref{6ec,,types.MethodWrapperType}
in modules.

@item 
gh-85267@footnote{https://github.com/python/cpython/issues/85267}: Several improvements to @ref{181,,inspect.signature()}”s handling of
@code{__text_signature}. - Fixes a case where @ref{181,,inspect.signature()}
dropped parameters - Fixes a case where @ref{181,,inspect.signature()} raised
@ref{5e5,,tokenize.TokenError} - Allows @ref{181,,inspect.signature()} to
understand defaults involving binary operations of constants -
@ref{181,,inspect.signature()} is documented as only raising @ref{228,,TypeError}
or @ref{360,,ValueError}, but sometimes raised @ref{1e5,,RuntimeError}. These
cases now raise @ref{360,,ValueError} - Removed a dead code path

@item 
gh-91166@footnote{https://github.com/python/cpython/issues/91166}: @ref{b,,asyncio} is optimized to avoid excessive copying when
writing to socket and use @ref{521,,sendmsg()} if the platform
supports it. Patch by Kumar Aditya.

@item 
gh-98030@footnote{https://github.com/python/cpython/issues/98030}: Add missing TCP socket options from Linux: @code{TCP_MD5SIG},
@code{TCP_THIN_LINEAR_TIMEOUTS}, @code{TCP_THIN_DUPACK}, @code{TCP_REPAIR},
@code{TCP_REPAIR_QUEUE}, @code{TCP_QUEUE_SEQ}, @code{TCP_REPAIR_OPTIONS},
@code{TCP_TIMESTAMP}, @code{TCP_CC_INFO}, @code{TCP_SAVE_SYN}, @code{TCP_SAVED_SYN},
@code{TCP_REPAIR_WINDOW}, @code{TCP_FASTOPEN_CONNECT}, @code{TCP_ULP},
@code{TCP_MD5SIG_EXT}, @code{TCP_FASTOPEN_KEY}, @code{TCP_FASTOPEN_NO_COOKIE},
@code{TCP_ZEROCOPY_RECEIVE}, @code{TCP_INQ}, @code{TCP_TX_DELAY}.

@item 
gh-88500@footnote{https://github.com/python/cpython/issues/88500}: Reduced the memory usage of @ref{178e,,urllib.parse.unquote()} and
@ref{178f,,urllib.parse.unquote_to_bytes()} on large values.

@item 
gh-96127@footnote{https://github.com/python/cpython/issues/96127}: @code{inspect.signature} was raising @code{TypeError} on call with
mock objects. Now it correctly returns @code{(*args, **kwargs)} as inferred
signature.

@item 
gh-95882@footnote{https://github.com/python/cpython/issues/95882}: Fix a 3.11 regression in
@ref{bb3,,asynccontextmanager()}, which caused it to propagate
exceptions with incorrect tracebacks and fix a 3.11 regression in
@ref{126f,,contextmanager()}, which caused it to propagate
exceptions with incorrect tracebacks for @ref{c82,,StopIteration}.

@item 
gh-78707@footnote{https://github.com/python/cpython/issues/78707}: Deprecate passing more than one positional argument to
@ref{21d,,pathlib.PurePath.relative_to()} and
@ref{21e,,is_relative_to()}.

@item 
gh-92122@footnote{https://github.com/python/cpython/issues/92122}: Fix reStructuredText syntax errors in docstrings in the
@ref{56,,enum} module.

@item 
gh-91851@footnote{https://github.com/python/cpython/issues/91851}: Optimize the @ref{177,,Fraction} arithmetics for small
components.

@item 
bpo-24132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24132}: Make @ref{54e,,pathlib.PurePath} and @ref{19b,,Path}
subclassable (private to start). Previously, attempting to instantiate a
subclass resulted in an @ref{441,,AttributeError} being raised. Patch by
Barney Gale.

@item 
bpo-40447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40447}: Accept @ref{cd9,,os.PathLike} (such as @ref{19b,,pathlib.Path}) in
the @code{stripdir} arguments of @ref{e66,,compileall.compile_file()} and
@ref{baf,,compileall.compile_dir()}.

@item 
bpo-36880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36880}: Fix a reference counting issue when a @ref{2b,,ctypes} callback
with return type @ref{1477,,py_object} returns @code{None}, which could
cause crashes.
@end itemize

@node Documentation<13>,Tests<13>,Library<14>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id117}@anchor{1790}
@subsubsection Documentation



@itemize -

@item 
gh-100616@footnote{https://github.com/python/cpython/issues/100616}: Document existing @code{attr} parameter to
@ref{1791,,curses.window.vline()} function in @ref{2c,,curses}.

@item 
gh-100472@footnote{https://github.com/python/cpython/issues/100472}: Remove claim in documentation that the @code{stripdir},
@code{prependdir} and @code{limit_sl_dest} parameters of
@ref{baf,,compileall.compile_dir()} and @ref{e66,,compileall.compile_file()} could
be @ref{325,,bytes}.

@item 
bpo-25377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25377}: Clarify use of octal format of mode argument in help(os.chmod)
as well as help(os.fchmod)
@end itemize

@node Tests<13>,Build<14>,Documentation<13>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id118}@anchor{1792}
@subsubsection Tests



@itemize -

@item 
gh-100454@footnote{https://github.com/python/cpython/issues/100454}: Start running SSL tests with OpenSSL 3.1.0-beta1.

@item 
gh-100086@footnote{https://github.com/python/cpython/issues/100086}: The Python test runner (libregrtest) now logs Python build
information like «debug» vs «release» build, or LTO and PGO optimizations.
Patch by Victor Stinner.

@item 
gh-93018@footnote{https://github.com/python/cpython/issues/93018}: Make two tests forgiving towards host system libexpat with
backported security fixes applied.
@end itemize

@node Build<14>,Windows<14>,Tests<13>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id119}@anchor{1793}
@subsubsection Build



@itemize -

@item 
gh-100540@footnote{https://github.com/python/cpython/issues/100540}: Removed the @code{--with-system-ffi} @code{configure} option;
@code{libffi} must now always be supplied by the system on all non-Windows
platforms.  The option has had no effect on non-Darwin platforms for
several releases, and in 3.11 only had the non-obvious effect of invoking
@code{pkg-config} to find @code{libffi} and never setting
@code{-DUSING_APPLE_OS_LIBFFI}.  Now on Darwin platforms @code{configure} will
first check for the OS @code{libffi} and then fall back to the same
processing as other platforms if it is not found.

@item 
gh-88267@footnote{https://github.com/python/cpython/issues/88267}: Avoid exporting Python symbols in linked Windows applications
when the core is built as static.

@item 
bpo-41916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41916}: Allow override of ac_cv_cxx_thread so that cross compiled
python can set -pthread for CXX.
@end itemize

@node Windows<14>,macOS<10>,Build<14>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id120}@anchor{1794}
@subsubsection Windows



@itemize -

@item 
gh-100180@footnote{https://github.com/python/cpython/issues/100180}: Update Windows installer to OpenSSL 1.1.1s

@item 
gh-99191@footnote{https://github.com/python/cpython/issues/99191}: Use @code{_MSVC_LANG >= 202002L} instead of less-precise @code{_MSC_VER
>=1929} to more accurately test for C++20 support in
@code{PC/_wmimodule.cpp}.

@item 
gh-79218@footnote{https://github.com/python/cpython/issues/79218}: Define @code{MS_WIN64} for Mingw-w64 64bit, fix cython compilation
failure.

@item 
gh-99941@footnote{https://github.com/python/cpython/issues/99941}: Ensure that @ref{1795,,asyncio.Protocol.data_received()} receives an
immutable @ref{325,,bytes} object (as documented), instead of
@ref{5e0,,bytearray}.

@item 
bpo-43984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43984}: @ref{1796,,winreg.SetValueEx()} now leaves the target value untouched
in the case of conversion errors. Previously, @code{-1} would be written in
case of such errors.

@item 
bpo-34816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34816}: @code{hasattr(ctypes.windll, 'nonexistant')} now returns @code{False}
instead of raising @ref{4d5,,OSError}.
@end itemize

@node macOS<10>,Tools/Demos<9>,Windows<14>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id121}@anchor{1797}
@subsubsection macOS



@itemize -

@item 
gh-100180@footnote{https://github.com/python/cpython/issues/100180}: Update macOS installer to OpenSSL 1.1.1s

@item 
gh-100540@footnote{https://github.com/python/cpython/issues/100540}: Removed obsolete @code{dlfcn.h} shim from the @code{_ctypes}
extension module, which has not been necessary since Mac OS X 10.2.
@end itemize

@node Tools/Demos<9>,C API<13>,macOS<10>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id122}@anchor{1798}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256}: Fix a bug that caused an @ref{441,,AttributeError} to be raised in
@code{python-gdb.py} when @code{py-locals} is used without a frame.

@item 
gh-100342@footnote{https://github.com/python/cpython/issues/100342}: Add missing @code{NULL} check for possible allocation failure in
@code{*args} parsing in Argument Clinic.
@end itemize

@node C API<13>,,Tools/Demos<9>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id123}@anchor{1799}
@subsubsection C API



@itemize -

@item 
gh-99947@footnote{https://github.com/python/cpython/issues/99947}: Raising SystemError on import will now have its cause be set to
the original unexpected exception.

@item 
gh-99240@footnote{https://github.com/python/cpython/issues/99240}: In argument parsing, after deallocating newly allocated memory,
reset its pointer to NULL.

@item 
gh-98724@footnote{https://github.com/python/cpython/issues/98724}: The @ref{61c,,Py_CLEAR}, @ref{61d,,Py_SETREF} and
@ref{61e,,Py_XSETREF} macros now only evaluate their arguments once. If an
argument has side effects, these side effects are no longer duplicated.
Patch by Victor Stinner.
@end itemize

@node Python 3 12 0 alpha 3,Python 3 12 0 alpha 2,Python 3 12 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-3}@anchor{179a}
@subsection Python 3.12.0 alpha 3


`Release date: 2022-12-06'

@menu
* Security: Security<11>. 
* Core and Builtins: Core and Builtins<15>. 
* Library: Library<15>. 
* Documentation: Documentation<14>. 
* Tests: Tests<14>. 
* Build: Build<15>. 
* Windows: Windows<15>. 
* macOS: macOS<11>. 
* Tools/Demos: Tools/Demos<10>. 
* C API: C API<14>. 

@end menu

@node Security<11>,Core and Builtins<15>,,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id124}@anchor{179b}
@subsubsection Security



@itemize -

@item 
gh-100001@footnote{https://github.com/python/cpython/issues/100001}: @code{python -m http.server} no longer allows terminal control
characters sent within a garbage request to be printed to the stderr
server log.

This is done by changing the @ref{72,,http.server}
@code{BaseHTTPRequestHandler} @code{.log_message} method to replace control
characters with a @code{\x@var{HH}} hex escape before printing.

@item 
gh-87604@footnote{https://github.com/python/cpython/issues/87604}: Avoid publishing list of active per-interpreter audit hooks via
the @ref{60,,gc} module
@end itemize

@node Core and Builtins<15>,Library<15>,Security<11>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id125}@anchor{179c}
@subsubsection Core and Builtins



@itemize -

@item 
gh-99891@footnote{https://github.com/python/cpython/issues/99891}: Fix a bug in the tokenizer that could cause infinite recursion
when showing syntax warnings that happen in the first line of the source.
Patch by Pablo Galindo

@item 
gh-91054@footnote{https://github.com/python/cpython/issues/91054}: Add @ref{60a,,PyCode_AddWatcher()} and
@ref{60b,,PyCode_ClearWatcher()} APIs to register callbacks to receive
notification on creation and destruction of code objects.

@item 
gh-99729@footnote{https://github.com/python/cpython/issues/99729}: Fix an issue that could cause frames to be visible to Python
code as they are being torn down, possibly leading to memory corruption or
hard crashes of the interpreter.

@item 
gh-99708@footnote{https://github.com/python/cpython/issues/99708}: Fix bug where compiler crashes on an if expression with an empty
body block.

@item 
gh-99578@footnote{https://github.com/python/cpython/issues/99578}: Fix a reference bug in @code{_imp.create_builtin()} after the
creation of the first sub-interpreter for modules @code{builtins} and
@code{sys}. Patch by Victor Stinner.

@item 
gh-99581@footnote{https://github.com/python/cpython/issues/99581}: Fixed a bug that was causing a buffer overflow if the tokenizer
copies a line missing the newline character from a file that is as long as
the available tokenizer buffer. Patch by Pablo galindo

@item 
gh-99553@footnote{https://github.com/python/cpython/issues/99553}: Fix bug where an @ref{31d,,ExceptionGroup} subclass can wrap a
@ref{65c,,BaseException}.

@item 
gh-99547@footnote{https://github.com/python/cpython/issues/99547}: Add a function to os.path to check if a path is a junction:
isjunction. Add similar functionality to pathlib.Path as is_junction.

@item 
gh-99370@footnote{https://github.com/python/cpython/issues/99370}: Fix zip path for venv created from a non-installed python on
POSIX platforms.

@item 
gh-99377@footnote{https://github.com/python/cpython/issues/99377}: Add audit events for thread creation and clear operations.

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: Remove the @code{BINARY_OP_GENERIC} and @code{COMPARE_OP_GENERIC}
«specializations».

@item 
gh-99298@footnote{https://github.com/python/cpython/issues/99298}: Remove the remaining error paths for attribute specializations,
and refuse to specialize attribute accesses on types that haven’t had
@ref{816,,PyType_Ready()} called on them yet.

@item 
gh-99127@footnote{https://github.com/python/cpython/issues/99127}: Allow some features of @ref{dc,,syslog} to the main interpreter
only. Patch by Donghee Na.

@item 
gh-91053@footnote{https://github.com/python/cpython/issues/91053}: Optimizing interpreters and JIT compilers may need to invalidate
internal metadata when functions are modified. This change adds the
ability to provide a callback that will be invoked each time a function is
created, modified, or destroyed.

@item 
gh-90994@footnote{https://github.com/python/cpython/issues/90994}: Improve error messages when there’s a syntax error with call
arguments. The following three cases are covered: - No value is assigned
to a named argument, eg @code{foo(a=)}. - A value is assigned to a star
argument, eg @code{foo(*args=[0])}. - A value is assigned to a double-star
keyword argument, eg @code{foo(**kwarg=@{'a': 0@})}.

@item 
bpo-45026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45026}: Optimize the @ref{9d6,,range} object iterator. It is now smaller,
faster iteration of ranges containing large numbers. Smaller pickles,
faster unpickling.

@item 
bpo-31718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31718}: Raise @ref{360,,ValueError} instead of @ref{619,,SystemError} when
methods of uninitialized @ref{16d2,,io.IncrementalNewlineDecoder} objects are
called. Patch by Oren Milman.

@item 
bpo-38031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38031}: Fix a possible assertion failure in @ref{1378,,io.FileIO} when the
opener returns an invalid file descriptor.
@end itemize

@node Library<15>,Documentation<14>,Core and Builtins<15>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id126}@anchor{179d}
@subsubsection Library



@itemize -

@item 
gh-100001@footnote{https://github.com/python/cpython/issues/100001}: Also escape s in the http.server
BaseHTTPRequestHandler.log_message so that it is technically possible to
parse the line and reconstruct what the original data was.  Without this a
xHH is ambiguous as to if it is a hex replacement we put in or the
characters r»x» came through in the original request line.

@item 
gh-99957@footnote{https://github.com/python/cpython/issues/99957}: Add @code{frozen_default} parameter to
@ref{57b,,typing.dataclass_transform()}.

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: Fix @ref{16d3,,asyncio.Server.wait_closed()} to actually do what the
docs promise – wait for all existing connections to complete, after
closing the server.

@item 
gh-51524@footnote{https://github.com/python/cpython/issues/51524}: Fix bug when calling trace.CoverageResults with valid infile.

@item 
gh-99645@footnote{https://github.com/python/cpython/issues/99645}: Fix a bug in handling class cleanups in
@ref{4fa,,unittest.TestCase}.  Now @code{addClassCleanup()} uses separate lists
for different @code{TestCase} subclasses, and @code{doClassCleanups()} only
cleans up the particular class.

@item 
gh-99508@footnote{https://github.com/python/cpython/issues/99508}: Fix @code{TypeError} in @code{Lib/importlib/_bootstrap_external.py}
while calling @code{_imp.source_hash()}.

@item 
gh-66285@footnote{https://github.com/python/cpython/issues/66285}: Fix @ref{b,,asyncio} to not share event loop and signal wakeupfd
in forked processes. Patch by Kumar Aditya.

@item 
gh-97001@footnote{https://github.com/python/cpython/issues/97001}: Release the GIL when calling termios APIs to avoid blocking
threads.

@item 
gh-92647@footnote{https://github.com/python/cpython/issues/92647}: Use final status of an enum to determine lookup or creation
branch of functional API.

@item 
gh-99388@footnote{https://github.com/python/cpython/issues/99388}: Add `loop_factory' parameter to @ref{525,,asyncio.run()} to allow
specifying a custom event loop factory. Patch by Kumar Aditya.

@item 
gh-99341@footnote{https://github.com/python/cpython/issues/99341}: Fix @ref{179e,,ast.increment_lineno()} to also cover
@code{ast.TypeIgnore} when changing line numbers.

@item 
gh-99382@footnote{https://github.com/python/cpython/issues/99382}: Check the number of arguments in substitution in user generics
containing a @ref{2cb,,TypeVarTuple} and one or more
@ref{2c9,,TypeVar}.

@item 
gh-99379@footnote{https://github.com/python/cpython/issues/99379}: Fix substitution of @ref{2ca,,ParamSpec} followed by
@ref{2cb,,TypeVarTuple} in generic aliases.

@item 
gh-99344@footnote{https://github.com/python/cpython/issues/99344}: Fix substitution of @ref{2cb,,TypeVarTuple} and
@ref{2ca,,ParamSpec} together in user generics.

@item 
gh-99284@footnote{https://github.com/python/cpython/issues/99284}: Remove @code{_use_broken_old_ctypes_structure_semantics_} old
untested and undocumented hack from @ref{2b,,ctypes}.

@item 
gh-99201@footnote{https://github.com/python/cpython/issues/99201}: Fix @ref{1575,,IndexError} when initializing the config variables on
Windows if @code{HAVE_DYNAMIC_LOADING} is not set.

@item 
gh-99240@footnote{https://github.com/python/cpython/issues/99240}: Fix double-free bug in Argument Clinic @code{str_converter} by
extracting memory clean up to a new @code{post_parsing} section.

@item 
gh-64490@footnote{https://github.com/python/cpython/issues/64490}: Fix refcount error when arguments are packed to tuple in
Argument Clinic.

@item 
gh-99029@footnote{https://github.com/python/cpython/issues/99029}: @ref{21d,,pathlib.PurePath.relative_to()} now treats naked Windows
drive paths as relative. This brings its behaviour in line with other
parts of pathlib.

@item 
gh-98253@footnote{https://github.com/python/cpython/issues/98253}: The implementation of the typing module is now more resilient to
reference leaks in binary extension modules.

Previously, a reference leak in a typed C API-based extension module could
leak internals of the typing module, which could in turn introduce leaks
in essentially any other package with typed function signatures. Although
the typing package is not the original source of the problem, such
non-local dependences exacerbate debugging of large-scale projects, and
the implementation was therefore changed to reduce harm by providing
better isolation.

@item 
gh-98458@footnote{https://github.com/python/cpython/issues/98458}: Fix infinite loop in unittest when a self-referencing chained
exception is raised

@item 
gh-93453@footnote{https://github.com/python/cpython/issues/93453}: @ref{214,,asyncio.get_event_loop()} and many other @ref{b,,asyncio}
functions like @ref{cfe,,asyncio.ensure_future()}, @ref{aff,,asyncio.shield()} or
@ref{69e,,asyncio.gather()}, and also the
@code{get_event_loop()} method of
@code{asyncio.BaseDefaultEventLoopPolicy} now raise a
@ref{1e5,,RuntimeError} if called when there is no running event loop and the
current event loop was not set. Previously they implicitly created and set
a new current event loop. @ref{1da,,DeprecationWarning} is no longer emitted
if there is no running event loop but the current event loop was set.

@item 
gh-97966@footnote{https://github.com/python/cpython/issues/97966}: On @code{uname_result}, restored expectation that @code{_fields} and
@code{_asdict} would include all six properties including @code{processor}.

@item 
gh-98248@footnote{https://github.com/python/cpython/issues/98248}: Provide informative error messages in @ref{12e4,,struct.pack()} when
its integral arguments are not in range.

@item 
gh-98108@footnote{https://github.com/python/cpython/issues/98108}: @code{zipfile.Path} is now pickleable if its initialization
parameters were pickleable (e.g. for file system paths).

@item 
gh-98098@footnote{https://github.com/python/cpython/issues/98098}: Created packages from zipfile and test_zipfile modules,
separating @code{zipfile.Path} functionality.

@item 
gh-82836@footnote{https://github.com/python/cpython/issues/82836}: Fix @ref{1654,,is_private} properties in the
@ref{80,,ipaddress} module. Previously non-private networks (0.0.0.0/0) would
return @code{True} from this method; now they correctly return @code{False}.

@item 
gh-96828@footnote{https://github.com/python/cpython/issues/96828}: Add an @ref{179f,,OP_ENABLE_KTLS} option for enabling the use
of the kernel TLS (kTLS). Patch by Illia Volochii.

@item 
gh-88863@footnote{https://github.com/python/cpython/issues/88863}: To avoid apparent memory leaks when
@ref{ba3,,asyncio.open_connection()} raises, break reference cycles generated
by local exception and future instances (which has exception instance as
its member var). Patch by Dong Uk, Kang.

@item 
gh-91078@footnote{https://github.com/python/cpython/issues/91078}: @code{TarFile.next()} now returns @code{None} when called on an
empty tarfile.

@item 
bpo-47220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47220}: Document the optional `callback' parameter of
@code{WeakMethod}. Patch by Géry Ogam.

@item 
bpo-44817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44817}: Ignore WinError 53 (ERROR_BAD_NETPATH), 65
(ERROR_NETWORK_ACCESS_DENIED) and 161 (ERROR_BAD_PATHNAME) when using
ntpath.realpath().

@item 
bpo-41260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41260}: Rename the `fmt' parameter of the pure Python implementation of
@ref{d1a,,datetime.date.strftime()} to `format'.

@item 
bpo-15999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15999}: All built-in functions now accept arguments of any type instead
of just @code{bool} and @code{int} for boolean parameters.
@end itemize

@node Documentation<14>,Tests<14>,Library<15>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id127}@anchor{17a0}
@subsubsection Documentation



@itemize -

@item 
gh-99931@footnote{https://github.com/python/cpython/issues/99931}: Use sphinxext-opengraph@footnote{https://sphinxext-opengraph.readthedocs.io/} to generate OpenGraph metadata@footnote{https://ogp.me/}.

@item 
gh-89682@footnote{https://github.com/python/cpython/issues/89682}: Reworded docstring of the default @code{__contains__} to clarify
that it returns a @ref{513,,bool}.

@item 
gh-88330@footnote{https://github.com/python/cpython/issues/88330}: Improved the description of what a resource is in
importlib.resources docs.

@item 
gh-92892@footnote{https://github.com/python/cpython/issues/92892}: Document that calling variadic functions with ctypes requires
special care on macOS/arm64 (and possibly other platforms).

@item 
bpo-41825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41825}: Restructured the documentation for the @ref{e1e,,os.wait*} family of functions, and improved the docs for
@ref{e1f,,os.waitid()} with more explanation of the possible argument
constants.
@end itemize

@node Tests<14>,Build<15>,Documentation<14>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id128}@anchor{17a1}
@subsubsection Tests



@itemize -

@item 
gh-99892@footnote{https://github.com/python/cpython/issues/99892}: Skip test_normalization() of test_unicodedata if it fails to
download NormalizationTest.txt file from pythontest.net. Patch by Victor
Stinner.

@item 
gh-99934@footnote{https://github.com/python/cpython/issues/99934}: Correct test_marsh on (32 bit) x86: test_deterministic sets was
failing.

@item 
gh-99741@footnote{https://github.com/python/cpython/issues/99741}: We’ve implemented multi-phase init (PEP 489/630/687) for the
internal (for testing) _xxsubinterpreters module.

@item 
gh-99659@footnote{https://github.com/python/cpython/issues/99659}: Optional big memory tests in @code{test_sqlite3} now catch the
correct @code{sqlite.DataError} exception type in case of too large
strings and/or blobs passed.

@item 
gh-99593@footnote{https://github.com/python/cpython/issues/99593}: Cover the Unicode C API with tests.

@item 
gh-96002@footnote{https://github.com/python/cpython/issues/96002}: Add functional test for Argument Clinic.
@end itemize

@node Build<15>,Windows<15>,Tests<14>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id129}@anchor{17a2}
@subsubsection Build



@itemize -

@item 
gh-99086@footnote{https://github.com/python/cpython/issues/99086}: Fix @code{-Wimplicit-int}, @code{-Wstrict-prototypes}, and
@code{-Wimplicit-function-declaration} compiler warnings in
@code{configure} checks.

@item 
gh-99337@footnote{https://github.com/python/cpython/issues/99337}: Fix a compilation issue with GCC 12 on macOS.

@item 
gh-99289@footnote{https://github.com/python/cpython/issues/99289}: Add a @code{COMPILEALL_OPTS} variable in Makefile to override
@ref{21,,compileall} options (default: @code{-j0}) in @code{make install}. Also
merged the @code{compileall} commands into a single command building .pyc
files for the all optimization levels (0, 1, 2) at once. Patch by Victor
Stinner.

@item 
gh-98872@footnote{https://github.com/python/cpython/issues/98872}: Fix a possible fd leak in @code{Programs/_freeze_module.c}
introduced in Python 3.11.

@item 
gh-88226@footnote{https://github.com/python/cpython/issues/88226}: Always define @code{TARGET_*} labels in @code{Python/ceval.c}, even if
@code{USE_COMPUTED_GOTOS} is disabled.  This allows breakpoints to be set at
those labels in (for instance) @code{gdb}.
@end itemize

@node Windows<15>,macOS<11>,Build<15>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id130}@anchor{17a3}
@subsubsection Windows



@itemize -

@item 
gh-99345@footnote{https://github.com/python/cpython/issues/99345}: Use faster initialization functions to detect install location
for Windows Store package

@item 
gh-98629@footnote{https://github.com/python/cpython/issues/98629}: Fix initialization of @ref{2e4,,sys.version} and @code{sys._git} on
Windows

@item 
gh-99442@footnote{https://github.com/python/cpython/issues/99442}: Fix handling in @ref{65f,,Lanzador de Python para Windows} when @code{argv[0]} does not
include a file extension.

@item 
bpo-40882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40882}: Fix a memory leak in
@ref{1664,,multiprocessing.shared_memory.SharedMemory} on Windows.
@end itemize

@node macOS<11>,Tools/Demos<10>,Windows<15>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id131}@anchor{17a4}
@subsubsection macOS



@itemize -

@item 
gh-87235@footnote{https://github.com/python/cpython/issues/87235}: On macOS @code{python3 /dev/fd/9 9</path/to/script.py} failed for
any script longer than a couple of bytes.

@item 
gh-98940@footnote{https://github.com/python/cpython/issues/98940}: Fix @code{Mac/Extras.install.py} file filter bug.
@end itemize

@node Tools/Demos<10>,C API<14>,macOS<11>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id132}@anchor{17a5}
@subsubsection Tools/Demos



@itemize -

@item 
gh-64490@footnote{https://github.com/python/cpython/issues/64490}: Argument Clinic varargs bugfixes


@itemize *

@item 
Fix out-of-bounds error in @code{_PyArg_UnpackKeywordsWithVararg()}.

@item 
Fix incorrect check which allowed more than one varargs in clinic.py.

@item 
Fix miscalculation of @code{noptargs} in generated code.

@item 
Do not generate @code{noptargs} when there is a vararg argument and no optional argument.
@end itemize
@end itemize

@node C API<14>,,Tools/Demos<10>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id133}@anchor{17a6}
@subsubsection C API



@itemize -

@item 
gh-98680@footnote{https://github.com/python/cpython/issues/98680}: @code{PyBUF_*} constants were marked as part of Limited API of
Python 3.11+. These were available in 3.11.0 with
@ref{4dc,,Py_LIMITED_API} defined for 3.11, and are necessary to use the
buffer API.

@item 
gh-99612@footnote{https://github.com/python/cpython/issues/99612}: Fix @ref{17a7,,PyUnicode_DecodeUTF8Stateful()} for ASCII-only data:
@code{*consumed} was not set.

@item 
gh-47146@footnote{https://github.com/python/cpython/issues/47146}: The @code{structmember.h} header is deprecated. Its non-deprecated
contents are now available just by including @code{Python.h}, with a @code{Py_}
prefix added if it was missing. (Deprecated contents are
@ref{636,,T_OBJECT}, @ref{638,,T_NONE}, and no-op flags.) Patch by Petr
Viktorin, based on earlier work by Alexander Belopolsky and Matthias
Braun.
@end itemize

@node Python 3 12 0 alpha 2,Python 3 12 0 alpha 1,Python 3 12 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-2}@anchor{17a8}
@subsection Python 3.12.0 alpha 2


`Release date: 2022-11-14'

@menu
* Security: Security<12>. 
* Core and Builtins: Core and Builtins<16>. 
* Library: Library<16>. 
* Documentation: Documentation<15>. 
* Tests: Tests<15>. 
* Build: Build<16>. 
* Windows: Windows<16>. 
* macOS: macOS<12>. 
* C API: C API<15>. 

@end menu

@node Security<12>,Core and Builtins<16>,,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id134}@anchor{17a9}
@subsubsection Security



@itemize -

@item 
gh-98433@footnote{https://github.com/python/cpython/issues/98433}: The IDNA codec decoder used on DNS hostnames by @ref{cc,,socket} or
@ref{b,,asyncio} related name resolution functions no longer involves a
quadratic algorithm. This prevents a potential CPU denial of service if an
out-of-spec excessive length hostname involving bidirectional characters
were decoded. Some protocols such as @ref{108,,urllib} http @code{3@var{xx}}
redirects potentially allow for an attacker to supply such a name.

Individual labels within an IDNA encoded DNS name will now raise an error
early during IDNA decoding if they are longer than 1024 unicode characters
given that each decoded DNS label must be 63 or fewer characters and the
entire decoded DNS name is limited to 255. Only an application presenting
a hostname or label consisting primarily of 
@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} section 3.1
«Nothing» characters to be removed would run into of this new limit. See
also 
@geindex RFC; RFC 5894
RFC 5894@footnote{https://datatracker.ietf.org/doc/html/rfc5894.html} section 6 and 
@geindex RFC; RFC 3491
RFC 3491@footnote{https://datatracker.ietf.org/doc/html/rfc3491.html}.

@item 
gh-98739@footnote{https://github.com/python/cpython/issues/98739}: Update bundled libexpat to 2.5.0
@end itemize

@node Core and Builtins<16>,Library<16>,Security<12>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id135}@anchor{17aa}
@subsubsection Core and Builtins



@itemize -

@item 
gh-81057@footnote{https://github.com/python/cpython/issues/81057}: The docs clearly say that @code{PyImport_Inittab},
@ref{17ab,,PyImport_AppendInittab()}, and @ref{17ac,,PyImport_ExtendInittab()}
should not be used after @ref{247,,Py_Initialize()} has been called. We now
enforce this for the two functions.  Additionally, the runtime now uses an
internal copy of @code{PyImport_Inittab}, to guard against modification.

@item 
gh-99298@footnote{https://github.com/python/cpython/issues/99298}: Fix an issue that could potentially cause incorrect error
handling for some bytecode instructions.

@item 
gh-99254@footnote{https://github.com/python/cpython/issues/99254}: The compiler now removes all unused constants from code objects
(except the first one, which may be a docstring).

@item 
gh-99205@footnote{https://github.com/python/cpython/issues/99205}: Fix an issue that prevented @ref{826,,PyThreadState} and
@ref{954,,PyInterpreterState} memory from being freed properly.

@item 
gh-81057@footnote{https://github.com/python/cpython/issues/81057}: The 18 global C variables holding the state of the allocators
have been moved to @code{_PyRuntimeState}.  This is a strictly internal
change with no change in behavior.

@item 
gh-99181@footnote{https://github.com/python/cpython/issues/99181}: Fix failure in @ref{659,,except*} with unhashable
exceptions.

@item 
gh-99204@footnote{https://github.com/python/cpython/issues/99204}: Fix calculation of @code{sys._base_executable} when inside a
POSIX virtual environment using copies of the python binary when the base
installation does not provide the executable name used by the venv.
Calculation will fall back to alternative names («python<MAJOR>»,
«python<MAJOR>.<MINOR>»).

@item 
gh-96055@footnote{https://github.com/python/cpython/issues/96055}: Update @ref{58,,faulthandler} to emit an error message with the
proper unexpected signal number. Patch by Donghee Na.

@item 
gh-99153@footnote{https://github.com/python/cpython/issues/99153}: Fix location of @ref{150,,SyntaxError} for a @ref{789,,try} block
with both @ref{2f6,,except} and @ref{659,,except*}.

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: Merge the adaptive opcode logic into each instruction’s
unquickened variant, and merge the logic in @code{EXTENDED_ARG_QUICK} into
@ref{17ad,,EXTENDED_ARG}. With these changes, the quickening that happens at
code object creation is now only responsible for initializing warmup
counters and inserting superinstructions.

@item 
gh-99103@footnote{https://github.com/python/cpython/issues/99103}: Fix the error reporting positions of specialized traceback
anchors when the source line contains Unicode characters.

@item 
gh-99139@footnote{https://github.com/python/cpython/issues/99139}: Improve the error suggestion for @ref{4ec,,NameError} exceptions for
instances. Now if a @ref{4ec,,NameError} is raised in a method and the
instance has an attribute that’s exactly equal to the name in the
exception, the suggestion will include @code{self.<NAME>} instead of the
closest match in the method scope. Patch by Pablo Galindo

@item 
gh-98401@footnote{https://github.com/python/cpython/issues/98401}: Octal escapes with value larger than @code{0o377} (ex: @code{"\477"}),
deprecated in Python 3.11, now produce a @ref{511,,SyntaxWarning}, instead of
@ref{1da,,DeprecationWarning}. In a future Python version they will be
eventually a @ref{150,,SyntaxError}. Patch by Victor Stinner.

@item 
gh-98401@footnote{https://github.com/python/cpython/issues/98401}: A backslash-character pair that is not a valid escape sequence
now generates a @ref{511,,SyntaxWarning}, instead of
@ref{1da,,DeprecationWarning}.  For example, @code{re.compile("\d+\.\d+")} now
emits a @ref{511,,SyntaxWarning} (@code{"\d"} is an invalid escape sequence), use
raw strings for regular expression: @code{re.compile(r"\d+\.\d+")}. In a
future Python version, @ref{150,,SyntaxError} will eventually be raised,
instead of @ref{511,,SyntaxWarning}. Patch by Victor Stinner.

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: Handle StopIteration and StopAsyncIteration raised in generator
or coroutines in the bytecode, rather than in wrapping C code.

@item 
gh-98931@footnote{https://github.com/python/cpython/issues/98931}: Improve the @ref{150,,SyntaxError} error message when the user types
@code{import x from y} instead of @code{from y import x}. Patch by Pablo Galindo

@item 
gh-98852@footnote{https://github.com/python/cpython/issues/98852}: Fix subscription of type aliases containing bare generic types
or types like @ref{2c9,,TypeVar}: for example @code{tuple[A, T][int]}
and @code{tuple[TypeVar, T][int]}, where @code{A} is a generic type, and @code{T}
is a type variable.

@item 
gh-98925@footnote{https://github.com/python/cpython/issues/98925}: Lower the recursion depth for marshal on WASI to support
(in-development) wasmtime 2.0.

@item 
gh-98783@footnote{https://github.com/python/cpython/issues/98783}: Fix multiple crashes in debug mode when @code{str} subclasses are
used instead of @code{str} itself.

@item 
gh-98811@footnote{https://github.com/python/cpython/issues/98811}: Use complete source locations to simplify detection of
@code{__future__} imports which are not at the beginning of the file. Also
corrects the offset in the exception raised in one case, which was off by
one and impeded highlighting.

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: Add specialization of @ref{1759,,FOR_ITER} for generators. Saves
multiple layers of dispatch and checking to get from the
@ref{1759,,FOR_ITER} instruction in the caller to the @ref{408,,RESUME} in
the generator.

@item 
gh-98762@footnote{https://github.com/python/cpython/issues/98762}: Fix source locations of @ref{8a4,,match} sub-patterns.

@item 
gh-98586@footnote{https://github.com/python/cpython/issues/98586}: Added the methods @ref{5ff,,PyObject_Vectorcall()} and
@ref{600,,PyObject_VectorcallMethod()} to the @ref{5f6,,Limited API}
along with the auxiliary macro constant
@ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET}.

The availability of these functions enables more efficient 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
vector calls from binary extension modules that avoid argument
boxing/unboxing overheads.

@item 
gh-99257@footnote{https://github.com/python/cpython/issues/99257}: Fix an issue where member descriptors (such as those for
@ref{152a,,__slots__}) could behave incorrectly or crash instead of
raising a @ref{228,,TypeError} when accessed via an instance of an invalid
type.

@item 
gh-93143@footnote{https://github.com/python/cpython/issues/93143}: Rather than changing @code{co_code}, the
interpreter will now display a @ref{323,,RuntimeWarning} and assign
@ref{716,,None} to any fast locals that are left unbound after jumps or
@ref{17ae,,del} statements executed while tracing.

@item 
gh-96421@footnote{https://github.com/python/cpython/issues/96421}: When calling into Python code from C code, through
@ref{10aa,,PyEval_EvalFrameEx()} or a related C-API function, a shim frame in
inserted into the call stack. This occurs in the
@code{_PyEval_EvalFrameDefault()} function. The extra frame should be
invisible to all Python and most C extensions, but out-of-process
profilers and debuggers need to be aware of it. These shim frames can be
detected by checking @code{frame->owner == FRAME_OWNED_BY_CSTACK}.

Extensions implementing their own interpreters using PEP 523 need to be
aware of this shim frame and the changes to the semantics of
@ref{17af,,RETURN_VALUE}, @ref{407,,YIELD_VALUE}, and
@ref{79c,,RETURN_GENERATOR}, which now clear the frame.

@item 
gh-98415@footnote{https://github.com/python/cpython/issues/98415}: Fix detection of MAC addresses for @ref{110,,uuid} on certain OSs.
Patch by Chaim Sanders

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: Quicken all code objects, and specialize adaptive bytecode
instructions more aggressively.

@item 
gh-92119@footnote{https://github.com/python/cpython/issues/92119}: Print exception class name instead of its string representation
when raising errors from @ref{2b,,ctypes} calls.

@item 
gh-91058@footnote{https://github.com/python/cpython/issues/91058}: @ref{4d7,,ImportError} raised from failed @code{from <module> import
<name>} now include suggestions for the value of @code{<name>} based on the
available names in @code{<module>}. Patch by Pablo Galindo

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: The @ref{1759,,FOR_ITER} now leaves the iterator on the stack on
termination of the loop. This is to assist specialization of loops for
generators.

@item 
gh-90716@footnote{https://github.com/python/cpython/issues/90716}: Add _pylong.py module.  It includes asymptotically faster
algorithms that can be used for operations on integers with many digits.
It is used by longobject.c to speed up some operations.

@item 
gh-95389@footnote{https://github.com/python/cpython/issues/95389}: Expose @ref{17b0,,ETH_P_ALL} and some of the
@ref{17b1,,ETHERTYPE_* constants} in @ref{cc,,socket}.
Patch by Noam Cohen.

@item 
gh-93696@footnote{https://github.com/python/cpython/issues/93696}: Allow @ref{a5,,pdb} to locate source for frozen modules in the
standard library.
@end itemize

@node Library<16>,Documentation<15>,Core and Builtins<16>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id136}@anchor{17b2}
@subsubsection Library



@itemize -

@item 
gh-99418@footnote{https://github.com/python/cpython/issues/99418}: Fix bug in @ref{207,,urllib.parse.urlparse()} that causes URL schemes
that begin with a digit, a plus sign, or a minus sign to be parsed
incorrectly.

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: Deprecate @code{asyncio.AbstractChildWatcher} to be removed in
Python 3.14. Patch by Kumar Aditya.

@item 
gh-99305@footnote{https://github.com/python/cpython/issues/99305}: Improve performance of @ref{17b3,,secrets.token_hex()}.

@item 
gh-74044@footnote{https://github.com/python/cpython/issues/74044}: Fixed bug where @ref{181,,inspect.signature()} reported incorrect
arguments for decorated methods.

@item 
gh-99275@footnote{https://github.com/python/cpython/issues/99275}: Fix @code{SystemError} in @ref{2b,,ctypes} when exception was not set
during @code{__initsubclass__}.

@item 
gh-99277@footnote{https://github.com/python/cpython/issues/99277}: Remove older version of
@code{_SSLProtocolTransport.get_write_buffer_limits} in
@code{asyncio.sslproto}

@item 
gh-99248@footnote{https://github.com/python/cpython/issues/99248}: fix negative numbers failing in verify()

@item 
gh-99155@footnote{https://github.com/python/cpython/issues/99155}: Fix @ref{aca,,statistics.NormalDist} pickle with @code{0} and @code{1}
protocols.

@item 
gh-93464@footnote{https://github.com/python/cpython/issues/93464}: @code{enum.auto()} is now correctly activated when combined with
other assignment values.  E.g. @code{ONE = auto(), 'some text'} will now
evaluate as @code{(1, 'some text')}.

@item 
gh-99134@footnote{https://github.com/python/cpython/issues/99134}: Update the bundled copy of pip to version 22.3.1.

@item 
gh-92584@footnote{https://github.com/python/cpython/issues/92584}: Remove the @code{distutils} package. It was deprecated in Python
3.10 by 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} «Deprecate distutils module». For projects still using
@code{distutils} and cannot be updated to something else, the @code{setuptools}
project can be installed: it still provides @code{distutils}. Patch by Victor
Stinner.

@item 
gh-98999@footnote{https://github.com/python/cpython/issues/98999}: Now @code{_pyio} is consistent with @code{_io} in raising
@code{ValueError} when executing methods over closed buffers.

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: Clean up refleak on failed module initialisation in
@code{_zoneinfo}

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: Clean up refleaks on failed module initialisation in
@code{_pickle}

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: Clean up refleak on failed module initialisation in @code{_io}.

@item 
gh-98897@footnote{https://github.com/python/cpython/issues/98897}: Fix memory leak in @ref{a94,,math.dist()} when both points don’t have
the same dimension. Patch by Kumar Aditya.

@item 
gh-98878@footnote{https://github.com/python/cpython/issues/98878}: Use the frame bound builtins when offering a name suggestion in
@ref{fe,,traceback} to prevent crashing when @code{__builtins__} is not a dict.

@item 
gh-98139@footnote{https://github.com/python/cpython/issues/98139}: In @code{importlib._bootstrap}, enhance namespace package repr
to @code{<module 'x' (namespace) from ['path']>}.

@item 
gh-90352@footnote{https://github.com/python/cpython/issues/90352}: Fix @code{_SelectorDatagramTransport} to inherit from
@ref{17b4,,DatagramTransport} in @ref{b,,asyncio}. Patch by Kumar
Aditya.

@item 
gh-98793@footnote{https://github.com/python/cpython/issues/98793}: Fix argument typechecks in @code{_overlapped.WSAConnect()} and
@code{_overlapped.Overlapped.WSASendTo()} functions.

@item 
gh-98744@footnote{https://github.com/python/cpython/issues/98744}: Prevent crashing in @ref{fe,,traceback} when retrieving the
byte-offset for some source files that contain certain unicode characters.

@item 
gh-98740@footnote{https://github.com/python/cpython/issues/98740}: Fix internal error in the @ref{b9,,re} module which in very rare
circumstances prevented compilation of a regular expression containing a
@ref{17b5,,conditional expression} without the
«else» branch.

@item 
gh-98703@footnote{https://github.com/python/cpython/issues/98703}: Fix @ref{17b6,,asyncio.StreamWriter.drain()} to call
@code{protocol.connection_lost} callback only once on Windows.

@item 
gh-98624@footnote{https://github.com/python/cpython/issues/98624}: Add a mutex to unittest.mock.NonCallableMock to protect
concurrent access to mock attributes.

@item 
gh-98658@footnote{https://github.com/python/cpython/issues/98658}: The @ref{308,,array.array} class now supports subscripting, making
it a @ref{157,,generic type}.

@item 
gh-98284@footnote{https://github.com/python/cpython/issues/98284}: Improved @ref{228,,TypeError} message for undefined abstract
methods of a @ref{f9a,,abc.ABC} instance. The names of the missing methods
are surrounded by single-quotes to highlight them.

@item 
gh-96151@footnote{https://github.com/python/cpython/issues/96151}: Allow @code{BUILTINS} to be a valid field name for frozen
dataclasses.

@item 
gh-98086@footnote{https://github.com/python/cpython/issues/98086}: Make sure @code{patch.dict()} can be applied on async functions.

@item 
gh-72719@footnote{https://github.com/python/cpython/issues/72719}: Remove modules @code{asyncore} and @code{asynchat}, which were
deprecated by 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

@item 
gh-96192@footnote{https://github.com/python/cpython/issues/96192}: Fix handling of @code{bytes} @ref{3f0,,path-like objects} in @code{os.ismount()}.

@item 
gh-94172@footnote{https://github.com/python/cpython/issues/94172}: @ref{5e,,ftplib}: Remove the @code{FTP_TLS.ssl_version} class
attribute: use the `context' parameter instead. Patch by Victor Stinner

@item 
gh-94172@footnote{https://github.com/python/cpython/issues/94172}: Remove the `keyfile' and `certfile' parameters from the
@ref{5e,,ftplib}, @ref{74,,imaplib}, @ref{ac,,poplib} and @ref{ca,,smtplib} modules,
and the `key_file', `cert_file' and `check_hostname' parameters from the
@ref{6f,,http.client} module, all deprecated since Python 3.6. Use the
`context' parameter (`ssl_context' in @ref{74,,imaplib}) instead. Patch by
Victor Stinner.

@item 
gh-83638@footnote{https://github.com/python/cpython/issues/83638}: Add the @ref{55d,,autocommit} attribute to
@ref{39e,,sqlite3.Connection} and the `autocommit' parameter to
@ref{3f5,,sqlite3.connect()} to control 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant @ref{55e,,transaction handling}. Patch by Erlend E.
Aasland.

@item 
gh-92452@footnote{https://github.com/python/cpython/issues/92452}: Fixed a race condition that could cause
@ref{10a7,,sysconfig.get_config_var()} to incorrectly return @ref{716,,None} in
multi-threaded programs.

@item 
gh-91803@footnote{https://github.com/python/cpython/issues/91803}: Fix an error when using a method of objects mocked with
@ref{15c9,,unittest.mock.create_autospec()} after it was sealed with
@ref{c29,,unittest.mock.seal()} function.

@item 
bpo-38523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38523}: @ref{abb,,shutil.copytree()} now applies the
`ignore_dangling_symlinks' argument recursively.

@item 
bpo-40358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40358}: Add walk_up argument in @ref{21d,,pathlib.PurePath.relative_to()}.

@item 
bpo-36267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36267}: Fix IndexError in @ref{15c,,argparse.ArgumentParser} when a
@code{store_true} action is given an explicit argument.
@end itemize

@node Documentation<15>,Tests<15>,Library<16>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id137}@anchor{17b7}
@subsubsection Documentation



@itemize -

@item 
gh-98832@footnote{https://github.com/python/cpython/issues/98832}: Changes wording of docstring for @ref{163d,,pathlib.Path.iterdir()}.

@item 
gh-97966@footnote{https://github.com/python/cpython/issues/97966}: Update uname docs to clarify the special nature of the platform
attribute and to indicate when it became late-bound.
@end itemize

@node Tests<15>,Build<16>,Documentation<15>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id138}@anchor{17b8}
@subsubsection Tests



@itemize -

@item 
gh-98903@footnote{https://github.com/python/cpython/issues/98903}: The Python test suite now fails with exit code 4 if no tests
ran. It should help detecting typos in test names and test methods.

@item 
gh-98713@footnote{https://github.com/python/cpython/issues/98713}: Fix a bug in the @ref{104,,typing} tests where a test relying on
CPython-specific implementation details was not decorated with
@code{@@cpython_only} and was not skipped on other implementations.

@item 
gh-87390@footnote{https://github.com/python/cpython/issues/87390}: Add tests for star-unpacking with PEP 646, and some other
miscellaneous PEP 646 tests.

@item 
gh-96853@footnote{https://github.com/python/cpython/issues/96853}: Added explicit coverage of @code{Py_Initialize} (and hence
@code{Py_InitializeEx}) back to the embedding tests (all other embedding
tests migrated to @code{Py_InitializeFromConfig} in Python 3.11)

@item 
bpo-34272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34272}: Some C API tests were moved into the new Lib/test/test_capi/
directory.
@end itemize

@node Build<16>,Windows<16>,Tests<15>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id139}@anchor{17b9}
@subsubsection Build



@itemize -

@item 
gh-99086@footnote{https://github.com/python/cpython/issues/99086}: Fix @code{-Wimplicit-int} compiler warning in @code{configure}
check for @code{PTHREAD_SCOPE_SYSTEM}.

@item 
gh-99016@footnote{https://github.com/python/cpython/issues/99016}: Fix build with @code{PYTHON_FOR_REGEN=python3.8}.

@item 
gh-97731@footnote{https://github.com/python/cpython/issues/97731}: Specify the full path to the source location for @code{make
docclean} (needed for cross-builds).

@item 
gh-98949@footnote{https://github.com/python/cpython/issues/98949}: Drop unused build dependency on @code{readelf}.

@item 
gh-98989@footnote{https://github.com/python/cpython/issues/98989}: Use @code{python3.11}, if available, for regeneration and freezing.

@item 
gh-98831@footnote{https://github.com/python/cpython/issues/98831}: Add new tooling, in @code{Tools/cases_generator}, to generate the
interpreter switch statement from a list of opcode definitions. This only
affects adding, modifying or removing instruction definitions. The
instruction definitions now live in @code{Python/bytecodes.c}, in the form of
a custom DSL (under development)@footnote{https://github.com/faster-cpython/ideas/blob/main/3.12/interpreter_definition.md}.
The tooling reads this file and writes @code{Python/generated_cases.c.h},
which is then included by @code{Python/ceval.c} to provide most of the cases
of the main interpreter switch.

@item 
gh-98817@footnote{https://github.com/python/cpython/issues/98817}: Remove PCbuild/lib.pyproj: it’s not used for anything, is only a
minor convenience for Visual Studio users (who probably mostly don’t even
know about it), and it takes a lot of maintenance effort to keep updated.

@item 
gh-98776@footnote{https://github.com/python/cpython/issues/98776}: Fix @code{make regen-test-levenshtein} for out-of-tree builds.

@item 
gh-98707@footnote{https://github.com/python/cpython/issues/98707}: Don’t use vendored @code{libmpdec} headers if
@ref{4d2,,--with-system-libmpdec} is passed to @code{configure}. Don’t
use vendored @code{libexpat} headers if @ref{17ba,,--with-system-expat} is
passed to @code{configure}.
@end itemize

@node Windows<16>,macOS<12>,Build<16>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id140}@anchor{17bb}
@subsubsection Windows



@itemize -

@item 
gh-98689@footnote{https://github.com/python/cpython/issues/98689}: Update Windows builds to zlib v1.2.13.  v1.2.12 has
@geindex Common Vulnerabilities and Exposures; CVE 2022-37434
CVE 2022-37434@footnote{https://www.cve.org/CVERecord?id=CVE-2022-37434}, but the vulnerable @code{inflateGetHeader} API is not used
by Python.

@item 
gh-98790@footnote{https://github.com/python/cpython/issues/98790}: Assumes that a missing @code{DLLs} directory means that standard
extension modules are in the executable’s directory.

@item 
gh-98745@footnote{https://github.com/python/cpython/issues/98745}: Update @code{py.exe} launcher to install 3.11 by default and
3.12 on request.

@item 
gh-98692@footnote{https://github.com/python/cpython/issues/98692}: Fix the @ref{65f,,Lanzador de Python para Windows} ignoring unrecognized shebang lines
instead of treating them as local paths

@item 
gh-94328@footnote{https://github.com/python/cpython/issues/94328}: Update Windows installer to use SQLite 3.39.4.
@end itemize

@node macOS<12>,C API<15>,Windows<16>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id141}@anchor{17bc}
@subsubsection macOS



@itemize -

@item 
gh-94328@footnote{https://github.com/python/cpython/issues/94328}: Update macOS installer to SQLite 3.39.4.
@end itemize

@node C API<15>,,macOS<12>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id142}@anchor{17bd}
@subsubsection C API



@itemize -

@item 
gh-98724@footnote{https://github.com/python/cpython/issues/98724}: The @ref{61c,,Py_CLEAR}, @ref{61d,,Py_SETREF} and
@ref{61e,,Py_XSETREF} macros now only evaluate their argument once. If the
argument has side effects, these side effects are no longer duplicated.
Patch by Victor Stinner.

@item 
gh-98978@footnote{https://github.com/python/cpython/issues/98978}: Fix use-after-free in @code{Py_SetPythonHome(NULL)},
@code{Py_SetProgramName(NULL)} and @code{_Py_SetProgramFullPath(NULL)} function
calls. Issue reported by Benedikt Reinartz. Patch by Victor Stinner.

@item 
gh-98410@footnote{https://github.com/python/cpython/issues/98410}: Add @code{getbufferproc} and @code{releasebufferproc} to the stable
API.

@item 
gh-98610@footnote{https://github.com/python/cpython/issues/98610}: Some configurable capabilities of sub-interpreters have changed.
They always allow subprocesses (@ref{d6,,subprocess}) now, whereas before
subprocesses could be optionally disallowed for a sub-interpreter. Instead
@code{os.exec()} can now be disallowed. Disallowing daemon threads is now
supported.  Disallowing all threads is still allowed, but is never done by
default. Note that the optional restrictions are only available through
@code{_Py_NewInterpreterFromConfig()}, which isn’t a public API. They do not
affect the main interpreter, nor @ref{17be,,Py_NewInterpreter()}.

@item 
gh-98608@footnote{https://github.com/python/cpython/issues/98608}: A @code{_PyInterpreterConfig} has been added and
@code{_Py_NewInterpreter()} has been renamed to
@code{_Py_NewInterpreterFromConfig()}.  The «isolated_subinterpreters»
argument is now a granular config that captures the previous behavior.
Note that this is all «private» API.

@item 
gh-96853@footnote{https://github.com/python/cpython/issues/96853}: @code{Py_InitializeEx} now correctly calls @code{PyConfig_Clear} after
initializing the interpreter (the omission didn’t cause a memory leak only
because none of the dynamically allocated config fields are populated by
the wrapper function)

@item 
gh-91248@footnote{https://github.com/python/cpython/issues/91248}: Add @ref{60c,,PyFrame_GetVar()} and @ref{60d,,PyFrame_GetVarString()}
functions to get a frame variable by its name. Patch by Victor Stinner.
@end itemize

@node Python 3 12 0 alpha 1,Python 3 11 0 beta 1,Python 3 12 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-12-0-alpha-1}@anchor{17bf}
@subsection Python 3.12.0 alpha 1


`Release date: 2022-10-25'

@menu
* Security: Security<13>. 
* Core and Builtins: Core and Builtins<17>. 
* Library: Library<17>. 
* Documentation: Documentation<16>. 
* Tests: Tests<16>. 
* Build: Build<17>. 
* Windows: Windows<17>. 
* macOS: macOS<13>. 
* IDLE: IDLE<11>. 
* Tools/Demos: Tools/Demos<11>. 
* C API: C API<16>. 

@end menu

@node Security<13>,Core and Builtins<17>,,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id143}@anchor{17c0}
@subsubsection Security



@itemize -

@item 
gh-97616@footnote{https://github.com/python/cpython/issues/97616}: Fix multiplying a list by an integer (@code{list *= int}): detect
the integer overflow when the new allocated length is close to the maximum
size. Issue reported by Jordan Limor.  Patch by Victor Stinner.

@item 
gh-97514@footnote{https://github.com/python/cpython/issues/97514}: On Linux the @ref{94,,multiprocessing} module returns to using
filesystem backed unix domain sockets for communication with the
`forkserver' process instead of the Linux abstract socket namespace.  Only
code that chooses to use the @ref{162,,«forkserver» start method} is affected.

Abstract sockets have no permissions and could allow any user on the
system in the same network namespace@footnote{https://man7.org/linux/man-pages/man7/network_namespaces.7.html} (often
the whole system) to inject code into the multiprocessing `forkserver'
process. This was a potential privilege escalation. Filesystem based
socket permissions restrict this to the `forkserver' process user as was
the default in Python 3.8 and earlier.

This prevents Linux 
@geindex Common Vulnerabilities and Exposures; CVE 2022-42919
CVE 2022-42919@footnote{https://www.cve.org/CVERecord?id=CVE-2022-42919}.

@item 
gh-87389@footnote{https://github.com/python/cpython/issues/87389}: @ref{72,,http.server}: Fix an open redirection vulnerability in the
HTTP server when an URI path starts with @code{//}.  Vulnerability
discovered, and initial fix proposed, by Hamza Avvan.

@item 
gh-79096@footnote{https://github.com/python/cpython/issues/79096}: LWPCookieJar and MozillaCookieJar create files with file mode
600 instead of 644 (Microsoft Windows is not affected)

@item 
gh-92888@footnote{https://github.com/python/cpython/issues/92888}: Fix @code{memoryview} use after free when accessing the backing
buffer in certain cases.

@item 
gh-68966@footnote{https://github.com/python/cpython/issues/68966}: The deprecated mailcap module now refuses to inject unsafe text
(filenames, MIME types, parameters) into shell commands. Instead of using
such text, it will warn and act as if a match was not found (or for test
commands, as if the test failed).
@end itemize

@node Core and Builtins<17>,Library<17>,Security<13>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id144}@anchor{17c1}
@subsubsection Core and Builtins



@itemize -

@item 
gh-98374@footnote{https://github.com/python/cpython/issues/98374}: Suppress ImportError for invalid query for help() command. Patch
by Donghee Na.

@item 
gh-98461@footnote{https://github.com/python/cpython/issues/98461}: Fix source location in bytecode for list, set and dict
comprehensions as well as generator expressions.

@item 
gh-98354@footnote{https://github.com/python/cpython/issues/98354}: Added unicode check for @code{name} attribute of @code{spec} argument
passed in @code{_imp.create_builtin()} function.

@item 
gh-98398@footnote{https://github.com/python/cpython/issues/98398}: Fix source location of “assert” bytecodes.

@item 
gh-98390@footnote{https://github.com/python/cpython/issues/98390}: Fix location of sub-expressions of boolean expressions, by
reducing their scope to that of the sub-expression.

@item 
gh-98254@footnote{https://github.com/python/cpython/issues/98254}: Modules from the standard library are now potentially suggested
as part of the error messages displayed by the interpreter when an
@ref{4ec,,NameError} is raised to the top level. Patch by Pablo Galindo

@item 
gh-97997@footnote{https://github.com/python/cpython/issues/97997}: Add running column offset to the tokenizer state to avoid
calculating AST column information with pointer arithmetic.

@item 
gh-97973@footnote{https://github.com/python/cpython/issues/97973}: Modify the tokenizer to return all necessary information the
parser needs to set location information in the AST nodes, so that the
parser does not have to calculate those doing pointer arithmetic.

@item 
gh-96078@footnote{https://github.com/python/cpython/issues/96078}: @ref{1183,,os.sched_yield()} now release the GIL while calling
sched_yield(2). Patch by Donghee Na.

@item 
gh-97955@footnote{https://github.com/python/cpython/issues/97955}: Migrate @ref{133,,zoneinfo} to Argument Clinic.

@item 
gh-97912@footnote{https://github.com/python/cpython/issues/97912}: The compiler now avoids quadratic behavior when finding which
instructions should use the @ref{58c,,LOAD_FAST_CHECK} opcode.

@item 
gh-97002@footnote{https://github.com/python/cpython/issues/97002}: Fix an issue where several frame objects could be backed by the
same interpreter frame, possibly leading to corrupted memory and hard
crashes of the interpreter.

@item 
gh-97943@footnote{https://github.com/python/cpython/issues/97943}: Bugfix: @ref{17c2,,PyFunction_GetAnnotations()} should return a
borrowed reference. It was returning a new reference.

@item 
gh-97922@footnote{https://github.com/python/cpython/issues/97922}: The Garbage Collector now runs only on the eval breaker
mechanism of the Python bytecode evaluation loop instead on object
allocations. The GC can also run when @ref{512,,PyErr_CheckSignals()} is
called so C extensions that need to run for a long time without executing
any Python code also have a chance to execute the GC periodically.

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: When @code{__package__} is different than @code{__spec__.parent},
raise a @code{DeprecationWarning} instead of @code{ImportWarning}.

Also remove @code{importlib.util.set_package()} which was scheduled for
removal.

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: Long deprecated, @code{module_repr()} should now be completely
eradicated.

@item 
gh-86298@footnote{https://github.com/python/cpython/issues/86298}: In cases where @code{warnings.warn_explicit()} consults the
module’s loader, an @code{DeprecationWarning} is issued when @code{m.__loader__}
differs from @code{m.__spec__.loader}.

@item 
gh-97779@footnote{https://github.com/python/cpython/issues/97779}: Ensure that all Python frame objects are backed by «complete»
frames.

@item 
gh-91052@footnote{https://github.com/python/cpython/issues/91052}: Add API for subscribing to modification events on selected
dictionaries.

@item 
gh-97752@footnote{https://github.com/python/cpython/issues/97752}: Fix possible data corruption or crashes when accessing the
@code{f_back} member of newly-created generator or coroutine frames.

@item 
gh-97591@footnote{https://github.com/python/cpython/issues/97591}: Fixed a missing incref/decref pair in
@code{Exception.__setstate__()}. Patch by Ofey Chan.

@item 
gh-97670@footnote{https://github.com/python/cpython/issues/97670}: Remove the @code{sys.getdxp()} function and the
@code{Tools/scripts/analyze_dxp.py} script. DXP stands for «dynamic execution
pairs». They were related to @code{DYNAMIC_EXECUTION_PROFILE} and @code{DXPAIRS}
macros which have been removed in Python 3.11. Python can now be built
with @ref{17c3,,./configure --enable-pystats} to gather
statistics on Python opcodes.  Patch by Victor Stinner.

@item 
gh-94526@footnote{https://github.com/python/cpython/issues/94526}: Fix the Python path configuration used to initialized
@ref{27e,,sys.path} at Python startup. Paths are no longer encoded to
UTF-8/strict to avoid encoding errors if it contains surrogate characters
(bytes paths are decoded with the surrogateescape error handler). Patch by
Victor Stinner.

@item 
gh-96670@footnote{https://github.com/python/cpython/issues/96670}: The parser now raises @ref{150,,SyntaxError} when parsing source
code containing null bytes. Patch by Pablo Galindo

@item 
gh-96975@footnote{https://github.com/python/cpython/issues/96975}: Fix a crash occurring when @ref{17c4,,PyEval_GetFrame()} is called
while the topmost Python frame is in a partially-initialized state.

@item 
gh-96848@footnote{https://github.com/python/cpython/issues/96848}: Fix command line parsing: reject @ref{2e2,,-X int_max_str_digits} option with no value (invalid) when the
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS} environment variable is set to a valid
limit. Patch by Victor Stinner.

@item 
gh-95921@footnote{https://github.com/python/cpython/issues/95921}: Fix overly-broad source position information for chained
comparisons used as branching conditions.

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: Fix undefined behaviour in @code{audioop.c}.

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: Fix undefined behaviour in @code{_testcapimodule.c}.

@item 
gh-95778@footnote{https://github.com/python/cpython/issues/95778}: When @ref{360,,ValueError} is raised if an integer is larger than
the limit, mention the @ref{17c6,,sys.set_int_max_str_digits()} function in the
error message. Patch by Victor Stinner.

@item 
gh-96387@footnote{https://github.com/python/cpython/issues/96387}: At Python exit, sometimes a thread holding the GIL can wait
forever for a thread (usually a daemon thread) which requested to drop the
GIL, whereas the thread already exited. To fix the race condition, the
thread which requested the GIL drop now resets its request before exiting.
Issue discovered and analyzed by Mingliang ZHAO. Patch by Victor Stinner.

@item 
gh-96864@footnote{https://github.com/python/cpython/issues/96864}: Fix a possible assertion failure, fatal error, or
@ref{619,,SystemError} if a line tracing event raises an exception while
opcode tracing is enabled.

@item 
gh-95778@footnote{https://github.com/python/cpython/issues/95778}: The @code{PyLong_FromString} function was refactored to make it
more maintainable and extensible.

@item 
gh-96678@footnote{https://github.com/python/cpython/issues/96678}: Fix undefined behaviour in C code of null pointer arithmetic.

@item 
gh-96754@footnote{https://github.com/python/cpython/issues/96754}: Make sure that all frame objects created are created from valid
interpreter frames. Prevents the possibility of invalid frames in
backtraces and signal handlers.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Improve the performance of reading and writing inline bytecode
caches on some platforms.

@item 
gh-96751@footnote{https://github.com/python/cpython/issues/96751}: Remove dead code from @code{CALL_FUNCTION_EX} opcode.

@item 
gh-90751@footnote{https://github.com/python/cpython/issues/90751}: @ref{156,,memoryview} now supports half-floats. Patch by Donghee
Na and Antoine Pitrou.

@item 
gh-96678@footnote{https://github.com/python/cpython/issues/96678}: Fix case of undefined behavior in ceval.c

@item 
gh-64373@footnote{https://github.com/python/cpython/issues/64373}: Convert @code{_functools} to argument clinic.

@item 
gh-96641@footnote{https://github.com/python/cpython/issues/96641}: Do not expose @code{KeyWrapper} in @code{_functools}.

@item 
gh-96636@footnote{https://github.com/python/cpython/issues/96636}: Ensure that tracing, @code{sys.setrace()}, is turned on
immediately. In pre-release versions of 3.11, some tracing events might
have been lost when turning on tracing in a @code{__del__} method or
interrupt.

@item 
gh-96572@footnote{https://github.com/python/cpython/issues/96572}: Fix use after free in trace refs build mode. Patch by Kumar
Aditya.

@item 
gh-96611@footnote{https://github.com/python/cpython/issues/96611}: When loading a file with invalid UTF-8 inside a multi-line
string, a correct SyntaxError is emitted.

@item 
gh-96612@footnote{https://github.com/python/cpython/issues/96612}: Make sure that incomplete frames do not show up in tracemalloc
traces.

@item 
gh-90230@footnote{https://github.com/python/cpython/issues/90230}: Fix compiler warnings and test failures when building with
@code{--enable-pystats}.

@item 
gh-96587@footnote{https://github.com/python/cpython/issues/96587}: Correctly raise @code{SyntaxError} on exception groups (
@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/})
on python versions prior to 3.11

@item 
gh-96569@footnote{https://github.com/python/cpython/issues/96569}: Remove two cases of undefined behavior, by adding NULL checks.

@item 
gh-96582@footnote{https://github.com/python/cpython/issues/96582}: Fix possible @code{NULL} pointer dereference in
@code{_PyThread_CurrentFrames}. Patch by Kumar Aditya.

@item 
gh-91079@footnote{https://github.com/python/cpython/issues/91079}: Separate Python recursion checking from C recursion checking
which reduces the chance of C stack overflow and allows the recursion
limit to be increased safely.

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: Fix an issue that could prevent @ref{585,,LOAD_ATTR} from
specializing properly when accessing properties.

@item 
gh-96348@footnote{https://github.com/python/cpython/issues/96348}: Emit a DeprecationWarning when @ref{59d,,throw()},
@ref{59c,,throw()} or @ref{59e,,athrow()} are called with more than
one argument.

@item 
gh-95196@footnote{https://github.com/python/cpython/issues/95196}: Disable incorrect pickling of the C implemented classmethod
descriptors.

@item 
gh-96364@footnote{https://github.com/python/cpython/issues/96364}: Fix text signatures of @code{list.__getitem__} and
@code{dict.__getitem__}.

@item 
gh-96352@footnote{https://github.com/python/cpython/issues/96352}: Fix @ref{441,,AttributeError} missing @code{name} and @code{obj}
attributes in @ref{c5a,,object.__getattribute__()}. Patch by Philip Georgi.

@item 
gh-93554@footnote{https://github.com/python/cpython/issues/93554}: Change the jump opcodes so that all conditional jumps are
forward jumps. Backward jumps are converted by the assembler into a
conditional forward jump whose target is the fallthrough block (and with a
reversed condition), followed by an unconditional backward jump. For
example:

@code{POP_JUMP_IF_TRUE BACKWARD_TARGET} becomes @code{POP_JUMP_IF_FALSE
NEXT_BLOCK; JUMP BACKWARD_TARGET}.

All the directed conditional jump opcodes were removed:
@code{POP_JUMP_FORWARD_IF_TRUE}, @code{POP_JUMP_BACKWARD_IF_TRUE},
@code{POP_JUMP_FORWARD_IF_FALSE}, @code{POP_JUMP_BACKWARD_IF_FALSE},
@code{POP_JUMP_FORWARD_IF_NONE}, @code{POP_JUMP_BACKWARD_IF_NONE},
@code{POP_JUMP_FORWARD_IF_NOT_NONE}, @code{POP_JUMP_BACKWARD_IF_NOT_NONE}.

The corresponding opcodes without direction are no longer
pseudo-instructions, and they implement the forward conditional jumps.

@item 
gh-96268@footnote{https://github.com/python/cpython/issues/96268}: Loading a file with invalid UTF-8 will now report the broken
character at the correct location.

@item 
gh-96237@footnote{https://github.com/python/cpython/issues/96237}: The internal field @code{_PyInterpreterFrame.f_func} is renamed to
@code{_PyInterpreterFrame.f_funcobj} and may be any object. The @code{f_globals}
and @code{f_builtin} fields may hold junk values.

It is safest to treat the @code{_PyInterpreterFrame} struct as opaque.

@item 
gh-96187@footnote{https://github.com/python/cpython/issues/96187}: Fixed a bug that caused @code{_PyCode_GetExtra} to return garbage
for negative indexes. Patch by Pablo Galindo

@item 
gh-96143@footnote{https://github.com/python/cpython/issues/96143}: Add a new @code{-X perf} Python command line option as well as
@ref{51a,,sys.activate_stack_trampoline()} and
@ref{51b,,sys.deactivate_stack_trampoline()} function in the @ref{d9,,sys} module
that allows to set/unset the interpreter in a way that the Linux @code{perf}
profiler can detect Python calls. The new
@ref{51c,,sys.is_stack_trampoline_active()} function allows to query the state
of the perf trampoline. Design by Pablo Galindo. Patch by Pablo Galindo
and Christian Heimes with contributions from Gregory P. Smith [Google] and
Mark Shannon.

@item 
gh-96071@footnote{https://github.com/python/cpython/issues/96071}: Fix a deadlock in @ref{49e,,PyGILState_Ensure()} when allocating
new thread state. Patch by Kumar Aditya.

@item 
gh-96046@footnote{https://github.com/python/cpython/issues/96046}: @ref{816,,PyType_Ready()} now initializes @code{ht_cached_keys} and
performs additional checks to ensure that type objects are properly
configured. This avoids crashes in 3rd party packages that don’t use
regular API to create new types.

@item 
gh-96005@footnote{https://github.com/python/cpython/issues/96005}: On WASI @ref{17c7,,ENOTCAPABLE} is now mapped to
@ref{dc9,,PermissionError}. The @ref{57,,errno} modules exposes the new error
number. @code{getpath.py} now ignores @ref{dc9,,PermissionError} when it cannot
open landmark files @code{pybuilddir.txt} and @code{pyenv.cfg}.

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: Added test a harness for direct unit tests of the compiler’s
optimization stage. The @code{_testinternalcapi.optimize_cfg()} function runs
the optimiser on a sequence of instructions. The
@code{CfgOptimizationTestCase} class in @code{test.support} has utilities for
invoking the optimizer and checking the output.

@item 
gh-95245@footnote{https://github.com/python/cpython/issues/95245}: Reduces the size of a «simple» Python object from 8 to 6 words
by moving the weakreflist pointer into the pre-header directly before the
object’s dict/values pointer.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Compile virtual @ref{789,,try}/@ref{2f6,,except} blocks to
handle exceptions raised during @ref{16fa,,close()} or
@ref{59d,,throw()} calls through a suspended frame.

@item 
gh-95977@footnote{https://github.com/python/cpython/issues/95977}: Optimized calling @ref{1527,,__get__()} with vectorcall. Patch
by Kumar Aditya.

@item 
gh-91210@footnote{https://github.com/python/cpython/issues/91210}: Improve error message when a parameter without a default value
follows one with a default value, and show the same message, even when the
non-default/default sequence is preceded by positional-only parameters.

@item 
gh-95922@footnote{https://github.com/python/cpython/issues/95922}: Fixed bug where the compiler’s @code{eliminate_empty_basic_blocks}
function ignores the last block of the code unit.

@item 
gh-95818@footnote{https://github.com/python/cpython/issues/95818}: Skip over incomplete frames in @ref{827,,PyThreadState_GetFrame()}.

@item 
gh-95876@footnote{https://github.com/python/cpython/issues/95876}: Fix format string in @code{_PyPegen_raise_error_known_location}
that can lead to memory corruption on some 64bit systems. The function was
building a tuple with @code{i} (int) instead of @code{n} (Py_ssize_t) for
Py_ssize_t arguments.

@item 
gh-95605@footnote{https://github.com/python/cpython/issues/95605}: Fix misleading contents of error message when converting an
all-whitespace string to @ref{153,,float}.

@item 
gh-95150@footnote{https://github.com/python/cpython/issues/95150}: Update code object hashing and equality to consider all
debugging and exception handling tables. This fixes an issue where certain
non-identical code objects could be «deduplicated» during compilation.

@item 
gh-91146@footnote{https://github.com/python/cpython/issues/91146}: Reduce allocation size of @ref{18e,,list} from @ref{f2b,,str.split()}
and @ref{12c3,,str.rsplit()}. Patch by Donghee Na and Inada Naoki.

@item 
gh-87092@footnote{https://github.com/python/cpython/issues/87092}: Create a “jump target label” abstraction in the compiler so that
the compiler’s codegen stage does not work directly with basic blocks.
This prepares the code for changes to the underlying CFG generation
mechanism.

@item 
gh-95355@footnote{https://github.com/python/cpython/issues/95355}: @code{_PyPegen_Parser_New} now properly detects token memory
allocation errors. Patch by Honglin Zhu.

@item 
gh-90081@footnote{https://github.com/python/cpython/issues/90081}: Run Python code in tracer/profiler function at full speed. Fixes
slowdown in earlier versions of 3.11.

@item 
gh-95324@footnote{https://github.com/python/cpython/issues/95324}: Emit a warning in debug mode if an object does not call
@ref{1547,,PyObject_GC_UnTrack()} before deallocation. Patch by Pablo Galindo.

@item 
gh-95245@footnote{https://github.com/python/cpython/issues/95245}: Merge managed dict and values pointer into a single tagged
pointer to save one word in the pre-header.

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: Add cfg_builder struct and refactor the relevant code so that a
cfg can be constructed without an instance of the compiler struct.

@item 
gh-95185@footnote{https://github.com/python/cpython/issues/95185}: Prevented crashes in the AST constructor when compiling some
absurdly long expressions like @code{"+0"*1000000}. @ref{df1,,RecursionError} is
now raised instead. Patch by Pablo Galindo

@item 
gh-93351@footnote{https://github.com/python/cpython/issues/93351}: @ref{30d,,ast.AST} node positions are now validated when provided
to @ref{2fb,,compile()} and other related functions. If invalid positions are
detected, a @ref{360,,ValueError} will be raised.

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: Fix an issue that caused extended opcode arguments and some
conditional pops to be ignored when calculating valid jump targets for
assignments to the @code{f_lineno} attribute of frame objects. In some cases,
this could cause inconsistent internal state, resulting in a hard crash of
the interpreter.

@item 
gh-95060@footnote{https://github.com/python/cpython/issues/95060}: Undocumented @code{PyCode_Addr2Location} function now properly
returns when @code{addrq} argument is less than zero.

@item 
gh-95113@footnote{https://github.com/python/cpython/issues/95113}: Replace all @code{EXTENDED_ARG_QUICK} instructions with basic
@ref{17ad,,EXTENDED_ARG} instructions in unquickened code. Consumers of
non-adaptive bytecode should be able to handle extended arguments the same
way they were handled in CPython 3.10 and older.

@item 
gh-91409@footnote{https://github.com/python/cpython/issues/91409}: Fix incorrect source location info caused by certain
optimizations in the bytecode compiler.

@item 
gh-95023@footnote{https://github.com/python/cpython/issues/95023}: Implement @ref{17c8,,os.setns()} and  @ref{17c9,,os.unshare()} for Linux.
Patch by Noam Cohen.

@item 
gh-94036@footnote{https://github.com/python/cpython/issues/94036}: Fix incorrect source location info for some multi-line attribute
accesses and method calls.

@item 
gh-94938@footnote{https://github.com/python/cpython/issues/94938}: Fix error detection in some builtin functions when keyword
argument name is an instance of a str subclass with overloaded @code{__eq__}
and @code{__hash__}. Previously it could cause SystemError or other undesired
behavior.

@item 
gh-94996@footnote{https://github.com/python/cpython/issues/94996}: @ref{30f,,ast.parse()} will no longer parse function definitions with
positional-only params when passed @code{feature_version} less than @code{(3,
8)}. Patch by Shantanu Jain.

@item 
gh-94739@footnote{https://github.com/python/cpython/issues/94739}: Allow jumping within, out of, and across exception handlers in
the debugger.

@item 
gh-94949@footnote{https://github.com/python/cpython/issues/94949}: @ref{30f,,ast.parse()} will no longer parse parenthesized context
managers when passed @code{feature_version} less than @code{(3, 9)}. Patch by
Shantanu Jain.

@item 
gh-94947@footnote{https://github.com/python/cpython/issues/94947}: @ref{30f,,ast.parse()} will no longer parse assignment expressions
when passed @code{feature_version} less than @code{(3, 8)}. Patch by Shantanu
Jain.

@item 
gh-91256@footnote{https://github.com/python/cpython/issues/91256}: Ensures the program name is known for help text during
interpreter startup.

@item 
gh-94869@footnote{https://github.com/python/cpython/issues/94869}: Fix the column offsets for some expressions in multi-line
f-strings @ref{9,,ast} nodes. Patch by Pablo Galindo.

@item 
gh-94893@footnote{https://github.com/python/cpython/issues/94893}: Fix an issue where frame object manipulations could corrupt
inline bytecode caches.

@item 
gh-94822@footnote{https://github.com/python/cpython/issues/94822}: Fix an issue where lookups of metaclass descriptors may be
ignored when an identically-named attribute also exists on the class
itself.

@item 
gh-91153@footnote{https://github.com/python/cpython/issues/91153}: Fix an issue where a @ref{5e0,,bytearray} item assignment could
crash if it’s resized by the new value’s @code{__index__()} method.

@item 
gh-90699@footnote{https://github.com/python/cpython/issues/90699}: Fix reference counting bug in @code{bool.__repr__()}. Patch by
Kumar Aditya.

@item 
gh-94694@footnote{https://github.com/python/cpython/issues/94694}: Fix an issue that could cause code with multi-line method
lookups to have misleading or incorrect column offset information. In some
cases (when compiling a hand-built AST) this could have resulted in a hard
crash of the interpreter.

@item 
gh-93252@footnote{https://github.com/python/cpython/issues/93252}: Fix an issue that caused internal frames to outlive failed
Python function calls, possibly resulting in memory leaks or hard
interpreter crashes.

@item 
gh-94215@footnote{https://github.com/python/cpython/issues/94215}: Fix an issue where exceptions raised by line-tracing events
would cause frames to be left in an invalid state, possibly resulting in a
hard crash of the interpreter.

@item 
gh-92228@footnote{https://github.com/python/cpython/issues/92228}: Disable the compiler’s inline-small-exit-blocks optimization for
exit blocks that are associated with source code lines. This fixes a bug
where the debugger cannot tell where an exception handler ends and the
following code block begins.

@item 
gh-94485@footnote{https://github.com/python/cpython/issues/94485}: Line number of a module’s @code{RESUME} instruction is set to 0 as
specified in 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}.

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: Account for instructions that can push NULL to the stack when
setting line number in a frame. Prevents some (unlikely) crashes.

@item 
gh-91719@footnote{https://github.com/python/cpython/issues/91719}: Reload @code{opcode} when raising @code{unknown opcode error} in the
interpreter main loop, for C compilers to generate dispatching code
independently.

@item 
gh-94329@footnote{https://github.com/python/cpython/issues/94329}: Compile and run code with unpacking of extremely large sequences
(1000s of elements). Such code failed to compile. It now compiles and runs
correctly.

@item 
gh-94360@footnote{https://github.com/python/cpython/issues/94360}: Fixed a tokenizer crash when reading encoded files with syntax
errors from @code{stdin} with non utf-8 encoded text. Patch by Pablo Galindo

@item 
gh-88116@footnote{https://github.com/python/cpython/issues/88116}: Fix an issue when reading line numbers from code objects if the
encoded line numbers are close to @code{INT_MIN}. Patch by Pablo Galindo

@item 
gh-94262@footnote{https://github.com/python/cpython/issues/94262}: Don’t create frame objects for incomplete frames. Prevents the
creation of generators and closures from being observable to Python and C
extensions, restoring the behavior of 3.10 and earlier.

@item 
gh-94192@footnote{https://github.com/python/cpython/issues/94192}: Fix error for dictionary literals with invalid expression as
value.

@item 
gh-87995@footnote{https://github.com/python/cpython/issues/87995}: @ref{518,,types.MappingProxyType} instances are now hashable if
the underlying mapping is hashable.

@item 
gh-93883@footnote{https://github.com/python/cpython/issues/93883}: Revise the display strategy of traceback enhanced error
locations.  The indicators are only shown when the location doesn’t span
the whole line.

@item 
gh-94163@footnote{https://github.com/python/cpython/issues/94163}: Add @ref{586,,BINARY_SLICE} and @ref{587,,STORE_SLICE}
instructions for more efficient handling and better specialization of
slicing operations, where the slice is explicit in the source code.

@item 
gh-94021@footnote{https://github.com/python/cpython/issues/94021}: Fix unreachable code warning in @code{Python/specialize.c}.

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: Specialize @code{LOAD_ATTR} for objects with custom
@code{__getattribute__}.

@item 
gh-93955@footnote{https://github.com/python/cpython/issues/93955}: Improve performance of attribute lookups on objects with custom
@code{__getattribute__} and @code{__getattr__}. Patch by Ken Jin.

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: Specialize @code{LOAD_ATTR} for @code{property()} attributes.

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: Refactor compiler optimisation code so that it no longer needs
the @code{struct assembler} and @code{struct compiler} passed around. Instead,
each function takes the CFG and other data that it actually needs. This
will make it possible to test this code directly.

@item 
gh-93841@footnote{https://github.com/python/cpython/issues/93841}: When built with @code{-enable-pystats}, @code{sys._stats_on()},
@code{sys._stats_off()}, @code{sys._stats_clear()} and @code{sys._stats_dump()}
functions have been added to enable gathering stats for parts of programs.

@item 
gh-93516@footnote{https://github.com/python/cpython/issues/93516}: Store offset of first traceable instruction in code object to
avoid having to recompute it for each instruction when tracing.

@item 
gh-93516@footnote{https://github.com/python/cpython/issues/93516}: Lazily create a table mapping bytecode offsets to line numbers
to speed up calculation of line numbers when tracing.

@item 
gh-89828@footnote{https://github.com/python/cpython/issues/89828}: @ref{882,,types.GenericAlias} no longer relays the @code{__class__}
attribute. For example, @code{isinstance(list[int], type)} no longer returns
@code{True}.

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: Refactor the compiler to reduce boilerplate and repetition.

@item 
gh-93671@footnote{https://github.com/python/cpython/issues/93671}: Fix some exponential backtrace case happening with deeply nested
sequence patterns in match statements. Patch by Pablo Galindo

@item 
gh-93662@footnote{https://github.com/python/cpython/issues/93662}: Make sure that the end column offsets are correct in multi-line
method calls. Previously, the end column could precede the column offset.

@item 
gh-93461@footnote{https://github.com/python/cpython/issues/93461}: @ref{c98,,importlib.invalidate_caches()} now drops entries from
@ref{684,,sys.path_importer_cache} with a relative path as name. This solves
a caching issue when a process changes its current working directory.

@code{FileFinder} no longer inserts a dot in the path, e.g. @code{/egg/./spam}
is now @code{/egg/spam}.

@item 
gh-93621@footnote{https://github.com/python/cpython/issues/93621}: Change order of bytecode instructions emitted for
@ref{673,,with} and @ref{676,,async with} to reduce the number of entries
in the exception table.

@item 
gh-93533@footnote{https://github.com/python/cpython/issues/93533}: Reduce the size of the inline cache for @code{LOAD_METHOD} by 2
bytes.

@item 
gh-93444@footnote{https://github.com/python/cpython/issues/93444}: Removed redundant fields from the compiler’s basicblock struct:
@code{b_nofallthrough}, @code{b_exit}, @code{b_return}. They can be easily
calculated from the opcode of the last instruction of the block.

@item 
gh-93429@footnote{https://github.com/python/cpython/issues/93429}: @code{LOAD_METHOD} instruction has been removed. It was merged back
into @code{LOAD_ATTR}.

@item 
gh-93418@footnote{https://github.com/python/cpython/issues/93418}: Fixed an assert where an f-string has an equal sign “=”
following an expression, but there’s no trailing brace. For example,
f»@{i=».

@item 
gh-93382@footnote{https://github.com/python/cpython/issues/93382}: Cache the result of @ref{812,,PyCode_GetCode()} function to restore
the `O'(1) lookup of the @code{co_code} attribute.

@item 
gh-93359@footnote{https://github.com/python/cpython/issues/93359}: Ensure that custom @ref{9,,ast} nodes without explicit end
positions can be compiled. Patch by Pablo Galindo.

@item 
gh-93356@footnote{https://github.com/python/cpython/issues/93356}: Code for exception handlers is emitted at the end of the code
unit’s bytecode. This avoids one jump when no exception is raised.

@item 
gh-93354@footnote{https://github.com/python/cpython/issues/93354}: Use exponential backoff for specialization counters in the
interpreter. Can reduce the number of failed specializations significantly
and avoid slowdown for those parts of a program that are not suitable for
specialization.

@item 
gh-93283@footnote{https://github.com/python/cpython/issues/93283}: Improve error message for invalid syntax of conversion character
in f-string expressions.

@item 
gh-93345@footnote{https://github.com/python/cpython/issues/93345}: Fix a crash in substitution of a @code{TypeVar} in nested generic
alias after @code{TypeVarTuple}.

@item 
gh-93223@footnote{https://github.com/python/cpython/issues/93223}: When a bytecode instruction jumps to an unconditional jump
instruction, the first instruction can often be optimized to target the
unconditional jump’s target directly. For tracing reasons, this would
previously only occur if both instructions have the same line number. This
also now occurs if the unconditional jump is artificial, i.e., if it has
no associated line number.

@item 
gh-84694@footnote{https://github.com/python/cpython/issues/84694}: The @code{--experimental-isolated-subinterpreters} configure option
and @code{EXPERIMENTAL_ISOLATED_SUBINTERPRETERS} macro have been removed.

@item 
gh-91924@footnote{https://github.com/python/cpython/issues/91924}: Fix @code{__lltrace__} debug feature if the stdout encoding is not
UTF-8. Patch by Victor Stinner.

@item 
gh-93040@footnote{https://github.com/python/cpython/issues/93040}: Wraps unused parameters in @code{Objects/obmalloc.c} with
@code{Py_UNUSED}.

@item 
gh-93143@footnote{https://github.com/python/cpython/issues/93143}: Avoid @code{NULL} checks for uninitialized local variables by
determining at compile time which variables must be initialized.

@item 
gh-93061@footnote{https://github.com/python/cpython/issues/93061}: Backward jumps after @code{async for} loops are no longer given
dubious line numbers.

@item 
gh-93065@footnote{https://github.com/python/cpython/issues/93065}: Fix contextvars HAMT implementation to handle iteration over
deep trees.

The bug was discovered and fixed by Eli Libman. See
MagicStack/immutables#84@footnote{https://github.com/MagicStack/immutables/issues/84} for more details.

@item 
gh-93012@footnote{https://github.com/python/cpython/issues/93012}: Added the new function @ref{5f3,,PyType_FromMetaclass()}, which
generalizes the existing @ref{5f4,,PyType_FromModuleAndSpec()} using an
additional metaclass argument. This is useful for language binding tools,
where it can be used to intercept type-related operations like subclassing
or static attribute access by specifying a metaclass with custom slots.

Importantly, @ref{5f3,,PyType_FromMetaclass()} is available in the Limited
API, which provides a path towards migrating more binding tools onto the
Stable ABI.

@item 
gh-93021@footnote{https://github.com/python/cpython/issues/93021}: Fix the @code{__text_signature__} for @code{__get__()} methods
implemented in C. Patch by Jelle Zijlstra.

@item 
gh-89914@footnote{https://github.com/python/cpython/issues/89914}: The operand of the @code{YIELD_VALUE} instruction is set to the
stack depth. This is done to help frame handling on @code{yield} and may
assist debuggers.

@item 
gh-92955@footnote{https://github.com/python/cpython/issues/92955}: Fix memory leak in code object’s lines and positions iterators
as they were not finalized at exit. Patch by Kumar Aditya.

@item 
gh-92930@footnote{https://github.com/python/cpython/issues/92930}: Fixed a crash in @code{_pickle.c} from mutating collections during
@code{__reduce__} or @code{persistent_id}.

@item 
gh-90690@footnote{https://github.com/python/cpython/issues/90690}: The PRECALL instruction has been removed. It offered only a
small advantage for specialization and is not needed in the vast majority
of cases.

@item 
gh-92914@footnote{https://github.com/python/cpython/issues/92914}: Always round the allocated size for lists up to the nearest even
number.

@item 
gh-92858@footnote{https://github.com/python/cpython/issues/92858}: Improve error message for some suites with syntax error before
“:”

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Decrease default recursion limit on WASI to address limited call
stack size.

@item 
gh-92804@footnote{https://github.com/python/cpython/issues/92804}: Fix memory leak in @code{memoryview} iterator as it was not
finalized at exit. Patch by Kumar Aditya.

@item 
gh-92777@footnote{https://github.com/python/cpython/issues/92777}: Specialize @code{LOAD_METHOD} for objects with lazy dictionaries.
Patch by Ken Jin.

@item 
gh-92658@footnote{https://github.com/python/cpython/issues/92658}: Add support for connecting and binding to Hyper-V sockets on
Windows Hyper-V hosts and guests.

@item 
gh-92236@footnote{https://github.com/python/cpython/issues/92236}: Remove spurious «LINE» event when starting a generator or
coroutine, visible tracing functions implemented in C.

@item 
gh-91102@footnote{https://github.com/python/cpython/issues/91102}: @code{_warnings.warn_explicit()} is ported to Argument Clinic.

@item 
gh-92619@footnote{https://github.com/python/cpython/issues/92619}: Make the compiler duplicate an exit block only if none of its
instructions have a lineno (previously only the first instruction in the
block was checked, leading to unnecessarily duplicated blocks).

@item 
gh-88750@footnote{https://github.com/python/cpython/issues/88750}: The deprecated debug build only @code{PYTHONTHREADDEBUG}
environment variable no longer does anything.

@item 
gh-92261@footnote{https://github.com/python/cpython/issues/92261}: Fix hang when trying to iterate over a @code{typing.Union}.

@item 
gh-91432@footnote{https://github.com/python/cpython/issues/91432}: Specialized the @ref{1759,,FOR_ITER} opcode using the PEP 659
machinery

@item 
gh-91399@footnote{https://github.com/python/cpython/issues/91399}: Removed duplicate “@{0, 0, 0, 0, 0, 0@}” entry in
“Objects/unicodetype_db.h”.

@item 
gh-91578@footnote{https://github.com/python/cpython/issues/91578}: Updates the error message for abstract class.

@item 
bpo-47091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47091}: Improve performance of repetition of @ref{18e,,list} and
@ref{464,,tuple} by using @code{memcpy} to copy data and performing the
reference increments in one step.

@item 
bpo-46142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46142}: Make @code{--help} output shorter by moving some info to the new
@code{--help-env} and @code{--help-xoptions} command-line options. Also add
@code{--help-all} option to print complete usage.

@item 
bpo-42316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42316}: Document some places where an assignment expression needs
parentheses.
@end itemize

@node Library<17>,Documentation<16>,Core and Builtins<17>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id145}@anchor{17ca}
@subsubsection Library



@itemize -

@item 
gh-89237@footnote{https://github.com/python/cpython/issues/89237}: Fix hang on Windows in @code{subprocess.wait_closed()} in
@ref{b,,asyncio} with @ref{6aa,,ProactorEventLoop}. Patch by Kumar
Aditya.

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: @code{tkinter.Text.count()} raises now an exception for options
starting with «-» instead of silently ignoring them.

@item 
gh-98393@footnote{https://github.com/python/cpython/issues/98393}: The @ref{a1,,os} module no longer accepts bytes-like paths, like
@ref{5e0,,bytearray} and @ref{156,,memoryview} types: only the exact
@ref{325,,bytes} type is accepted for bytes strings. Patch by Victor
Stinner.

@item 
gh-98363@footnote{https://github.com/python/cpython/issues/98363}: Added itertools.batched() to batch data into lists of a given
length with the last list possibly being shorter than the others.

@item 
gh-98331@footnote{https://github.com/python/cpython/issues/98331}: Update the bundled copies of pip and setuptools to versions 22.3
and 65.5.0 respectively.

@item 
gh-98307@footnote{https://github.com/python/cpython/issues/98307}: A @ref{6fc,,createSocket()} method
was added to @ref{6fd,,SysLogHandler}.

@item 
gh-96035@footnote{https://github.com/python/cpython/issues/96035}: Fix bug in @ref{207,,urllib.parse.urlparse()} that causes certain
port numbers containing whitespace, underscores, plus and minus signs, or
non-ASCII digits to be incorrectly accepted.

@item 
gh-98257@footnote{https://github.com/python/cpython/issues/98257}: Make @ref{153f,,sys.setprofile()} and @ref{1540,,sys.settrace()} functions
reentrant. They can no long fail with: @code{RuntimeError("Cannot install a
trace function while another trace function is being installed")}. Patch
by Victor Stinner.

@item 
gh-98251@footnote{https://github.com/python/cpython/issues/98251}: Allow @ref{111,,venv} to pass along @code{PYTHON*} variables to
@code{ensurepip} and @code{pip} when they do not impact path resolution

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: Deprecated
@code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} and
@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} methods to be
removed in Python 3.14. Patch by Kumar Aditya.

@item 
gh-98178@footnote{https://github.com/python/cpython/issues/98178}: On macOS, fix a crash in @ref{5e3,,syslog.syslog()} in multi-threaded
applications. On macOS, the libc @code{syslog()} function is not thread-safe,
so @ref{5e3,,syslog.syslog()} no longer releases the GIL to call it. Patch by
Victor Stinner.

@item 
gh-44098@footnote{https://github.com/python/cpython/issues/44098}: Release the GIL when creating @ref{368,,mmap.mmap} objects on
Unix.

@item 
gh-87730@footnote{https://github.com/python/cpython/issues/87730}: Wrap network errors consistently in urllib FTP support, so the
test suite doesn’t fail when a network is available but the public
internet is not reachable.

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: The child watcher classes
@code{MultiLoopChildWatcher},
@code{FastChildWatcher} and @code{SafeChildWatcher}
are deprecated and will be removed in Python 3.14. Patch by Kumar Aditya.

@item 
gh-98023@footnote{https://github.com/python/cpython/issues/98023}: Change default child watcher to
@code{PidfdChildWatcher} on Linux systems which supports it.
Patch by Kumar Aditya.

@item 
gh-90985@footnote{https://github.com/python/cpython/issues/90985}: Earlier in 3.11 we deprecated
@code{asyncio.Task.cancel("message")}. We realized we were too harsh, and
have undeprecated it.

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: Do not rely solely on @code{__cached__} on modules; code will also
support @code{__spec__.cached}.

@item 
gh-97646@footnote{https://github.com/python/cpython/issues/97646}: Replace deprecated @code{application/javascript} with
@code{text/javascript} in @ref{8f,,mimetypes}. See 
@geindex RFC; RFC 9239
RFC 9239@footnote{https://datatracker.ietf.org/doc/html/rfc9239.html}. Patch by Noam
Cohen.

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: Apply changes from importlib_resources 5.8 and 5.9:
@code{Traversable.joinpath} provides a concrete implementation. @code{as_file}
now supports directories of resources.

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: Remove deprecated @code{importlib.util.set_loader()} and
@code{importlib.util.module_for_loader()} from @ref{7d,,importlib.util}.

@item 
gh-97837@footnote{https://github.com/python/cpython/issues/97837}: Change deprecate warning message in @ref{106,,unittest} from

@code{It is deprecated to return a value!=None}

to

@code{It is deprecated to return a value that is not None from a test case}

@item 
gh-97825@footnote{https://github.com/python/cpython/issues/97825}: Fixes @ref{441,,AttributeError} when @ref{1040,,subprocess.check_output()}
is used with argument @code{input=None} and either of the arguments
`encoding' or `errors' are used.

@item 
gh-97008@footnote{https://github.com/python/cpython/issues/97008}: @ref{4ec,,NameError} and @ref{441,,AttributeError} spelling suggestions
provided since gh-82711@footnote{https://github.com/python/cpython/issues/82711} are now also emitted by the pure Python
@ref{fe,,traceback} module. Tests for those suggestions now exercise both
implementations to ensure they are equivalent. Patch by Carl Friedrich
Bolz-Tereick and Łukasz Langa.

@item 
gh-97799@footnote{https://github.com/python/cpython/issues/97799}: @code{dataclass} now uses @ref{8aa,,inspect.get_annotations()} to
examine the annotations on class objects.

@item 
gh-97781@footnote{https://github.com/python/cpython/issues/97781}: Removed deprecated interfaces in @code{importlib.metadata} (entry
points accessed as dictionary, implicit dictionary construction of
sequence of @code{EntryPoint} objects, mutablility of @code{EntryPoints} result,
access of entry point by index). @code{entry_points} now has a simpler, more
straightforward API (returning @code{EntryPoints}).

@item 
gh-96827@footnote{https://github.com/python/cpython/issues/96827}: Avoid spurious tracebacks from @ref{b,,asyncio} when default
executor cleanup is delayed until after the event loop is closed (e.g. as
the result of a keyboard interrupt).

@item 
gh-95534@footnote{https://github.com/python/cpython/issues/95534}: @code{gzip.GzipFile.read()} reads 10% faster.

@item 
gh-97592@footnote{https://github.com/python/cpython/issues/97592}: Avoid a crash in the C version of
@ref{15a6,,asyncio.Future.remove_done_callback()} when an evil argument is
passed.

@item 
gh-97639@footnote{https://github.com/python/cpython/issues/97639}: Remove @code{tokenize.NL} check from @ref{dd,,tabnanny}.

@item 
gh-97545@footnote{https://github.com/python/cpython/issues/97545}: Make Semaphore run faster.

@item 
gh-73588@footnote{https://github.com/python/cpython/issues/73588}: Fix generation of the default name of
@code{tkinter.Checkbutton}. Previously, checkbuttons in different parent
widgets could have the same short name and share the same state if
arguments «name» and «variable» are not specified. Now they are globally
unique.

@item 
gh-96865@footnote{https://github.com/python/cpython/issues/96865}: fix Flag to use boundary CONFORM

This restores previous Flag behavior of allowing flags with non-sequential
values to be combined; e.g.

class Skip(Flag):         TWO = 2         EIGHT = 8

Skip.TWO | Skip.EIGHT -> <Skip.TWO|EIGHT: 10>

@item 
gh-97005@footnote{https://github.com/python/cpython/issues/97005}: Update bundled libexpat to 2.4.9

@item 
gh-85760@footnote{https://github.com/python/cpython/issues/85760}: Fix race condition in @ref{b,,asyncio} where
@ref{17cb,,process_exited()} called before the
@ref{17cc,,pipe_data_received()} leading to
inconsistent output. Patch by Kumar Aditya.

@item 
gh-96704@footnote{https://github.com/python/cpython/issues/96704}: Pass the correct @code{contextvars.Context} when a @code{asyncio}
exception handler is called on behalf of a task or callback handle. This
adds a new @code{Task} method, @code{get_context}, and also a new @code{Handle}
method with the same name. If this method is not found on a task object
(perhaps because it is a third-party library that does not yet provide
this method), the context prevailing at the time the exception handler is
called is used.

@item 
gh-96819@footnote{https://github.com/python/cpython/issues/96819}: Fixed check in @code{multiprocessing.resource_tracker} that
guarantees that the length of a write to a pipe is not greater than
@code{PIPE_BUF}.

@item 
gh-95865@footnote{https://github.com/python/cpython/issues/95865}: Reduce @ref{17cd,,urllib.parse.quote_from_bytes()} memory use on large
values.

Contributed by Dennis Sweeney.

@item 
gh-96741@footnote{https://github.com/python/cpython/issues/96741}: Corrected type annotation for dataclass attribute
@code{pstats.FunctionProfile.ncalls} to be @code{str}.

@item 
gh-96734@footnote{https://github.com/python/cpython/issues/96734}: Update @ref{105,,unicodedata} database to Unicode 15.0.0.

@item 
gh-96735@footnote{https://github.com/python/cpython/issues/96735}: Fix undefined behaviour in @ref{17ce,,struct.unpack()}.

@item 
gh-46412@footnote{https://github.com/python/cpython/issues/46412}: Improve performance of @code{bool(db)} for large ndb/gdb databases.
Previously this would call @code{len(db)} which would iterate over all keys
– the answer (empty or not) is known after the first key.

@item 
gh-96652@footnote{https://github.com/python/cpython/issues/96652}: Fix the faulthandler implementation of
@code{faulthandler.register(signal, chain=True)} if the @code{sigaction()}
function is not available: don’t call the previous signal handler if it’s
NULL. Patch by Victor Stinner.

@item 
gh-68163@footnote{https://github.com/python/cpython/issues/68163}: Correct conversion of @ref{132a,,numbers.Rational}’s to
@ref{153,,float}.

@item 
gh-96538@footnote{https://github.com/python/cpython/issues/96538}: Speed up @code{bisect.bisect()} functions by taking advantage of
type-stability.

@item 
gh-96465@footnote{https://github.com/python/cpython/issues/96465}: Fraction hashes are now cached.

@item 
gh-96079@footnote{https://github.com/python/cpython/issues/96079}: In @ref{104,,typing}, fix missing field @code{name} and incorrect
@code{__module__} in _AnnotatedAlias.

@item 
gh-96415@footnote{https://github.com/python/cpython/issues/96415}: Remove @code{types._cell_factory} from module namespace.

@item 
gh-95987@footnote{https://github.com/python/cpython/issues/95987}: Fix @code{repr} of @code{Any} subclasses.

@item 
gh-96388@footnote{https://github.com/python/cpython/issues/96388}: Work around missing socket functions in
@ref{e27,,socket}’s @code{__repr__}.

@item 
gh-96385@footnote{https://github.com/python/cpython/issues/96385}: Fix @code{TypeVarTuple.__typing_prepare_subst__}. @code{TypeError} was
not raised when using more than one @code{TypeVarTuple}, like @code{[*T, *V]} in
type alias substitutions.

@item 
gh-96142@footnote{https://github.com/python/cpython/issues/96142}: Add @code{match_args}, @code{kw_only}, @code{slots}, and @code{weakref_slot}
to @code{_DataclassParams}.

@item 
gh-96073@footnote{https://github.com/python/cpython/issues/96073}: In @ref{7e,,inspect}, fix overeager replacement of «@code{typing.}» in
formatting annotations.

@item 
gh-89258@footnote{https://github.com/python/cpython/issues/89258}: Added a @ref{17cf,,getChildren()} method to
@ref{bd7,,logging.Logger}, to get the immediate child loggers of a logger.

@item 
gh-96346@footnote{https://github.com/python/cpython/issues/96346}: Use double caching for compiled RE patterns.

@item 
gh-96349@footnote{https://github.com/python/cpython/issues/96349}: Fixed a minor performance regression in
@code{threading.Event.__init__()}

@item 
gh-90467@footnote{https://github.com/python/cpython/issues/90467}: Fix @code{asyncio.streams.StreamReaderProtocol} to keep a
strong reference to the created task, so that it’s not garbage collected

@item 
gh-96172@footnote{https://github.com/python/cpython/issues/96172}: Fix a bug in @code{unicodedata}: @code{east_asian_width} used to
return the wrong value for unassigned characters; and for yet unassigned,
but reserved characters.

@item 
gh-96159@footnote{https://github.com/python/cpython/issues/96159}: Fix a performance regression in logging
TimedRotatingFileHandler. Only check for special files when the rollover
time has passed.

@item 
gh-96175@footnote{https://github.com/python/cpython/issues/96175}: Fix unused @code{localName} parameter in the @code{Attr} class in
@ref{122,,xml.dom.minidom}.

@item 
gh-96145@footnote{https://github.com/python/cpython/issues/96145}: Add AttrDict to JSON module for use with object_hook.

@item 
gh-96052@footnote{https://github.com/python/cpython/issues/96052}: Fix handling compiler warnings (SyntaxWarning and
DeprecationWarning) in @ref{17d0,,codeop.compile_command()} when checking for
incomplete input. Previously it emitted warnings and raised a SyntaxError.
Now it always returns @code{None} for incomplete input without emitting any
warnings.

@item 
gh-96125@footnote{https://github.com/python/cpython/issues/96125}: Fix incorrect condition that causes @code{sys.thread_info.name} to
be wrong on pthread platforms.

@item 
gh-96019@footnote{https://github.com/python/cpython/issues/96019}: Fix a bug in the @code{makeunicodedata.py} script leading to about
13 KiB of space saving in the @code{unicodedata} module, specifically the
character decomposition data.

@item 
gh-95463@footnote{https://github.com/python/cpython/issues/95463}: Remove an incompatible change from bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080} that caused a
regression that ignored the utf8 in @code{ZipInfo.flag_bits}. Patch by Pablo
Galindo.

@item 
gh-69142@footnote{https://github.com/python/cpython/issues/69142}: Add @code{%:z} strftime format code (generates tzoffset with colons
as separator), see @ref{17d1,,strftime() and strptime() Behavior}.

@item 
gh-95899@footnote{https://github.com/python/cpython/issues/95899}: Fix @ref{6a1,,asyncio.Runner} to call
@ref{17d2,,asyncio.set_event_loop()} only once to avoid calling
@code{attach_loop()} multiple times on child
watchers. Patch by Kumar Aditya.

@item 
gh-95736@footnote{https://github.com/python/cpython/issues/95736}: Fix @ref{206,,unittest.IsolatedAsyncioTestCase} to set event loop
before calling setup functions. Patch by Kumar Aditya.

@item 
gh-95865@footnote{https://github.com/python/cpython/issues/95865}: Speed up @ref{17cd,,urllib.parse.quote_from_bytes()} by replacing a
list comprehension with @code{map()}.

@item 
gh-95861@footnote{https://github.com/python/cpython/issues/95861}: Add support for computing Spearman’s correlation coefficient to
the existing statistics.correlation() function.

@item 
gh-95804@footnote{https://github.com/python/cpython/issues/95804}: Fix @code{logging} shutdown handler so it respects
@code{MemoryHandler.flushOnClose}.

@item 
gh-95704@footnote{https://github.com/python/cpython/issues/95704}: When a task catches @ref{31f,,asyncio.CancelledError} and raises
some other error, the other error should generally not silently be
suppressed.

@item 
gh-95149@footnote{https://github.com/python/cpython/issues/95149}: The @ref{996,,HTTPStatus} enum offers a couple
of properties to indicate the HTTP status category e.g.
@code{HTTPStatus.OK.is_success}.

@item 
gh-95609@footnote{https://github.com/python/cpython/issues/95609}: Update bundled pip to 22.2.2.

@item 
gh-95289@footnote{https://github.com/python/cpython/issues/95289}: Fix @ref{31c,,asyncio.TaskGroup} to propagate exception when
@ref{31f,,asyncio.CancelledError} was replaced with another exception by a
context manager. Patch by Kumar Aditya and Guido van Rossum.

@item 
gh-94909@footnote{https://github.com/python/cpython/issues/94909}: Fix incorrect joining of relative Windows paths with drives in
@ref{54e,,pathlib.PurePath} initializer.

@item 
gh-95385@footnote{https://github.com/python/cpython/issues/95385}: Faster @code{json.dumps()} when sorting of keys is not requested
(default).

@item 
gh-83901@footnote{https://github.com/python/cpython/issues/83901}: Improve @ref{15fb,,Signature.bind} error
message for missing keyword-only arguments.

@item 
gh-95339@footnote{https://github.com/python/cpython/issues/95339}: Update bundled pip to 22.2.1.

@item 
gh-95045@footnote{https://github.com/python/cpython/issues/95045}: Fix GC crash when deallocating @code{_lsprof.Profiler} by
untracking it before calling any callbacks. Patch by Kumar Aditya.

@item 
gh-95231@footnote{https://github.com/python/cpython/issues/95231}: Fail gracefully if @ref{17d3,,EPERM} or
@ref{17d4,,ENOSYS} is raised when loading @code{crypt} methods. This
may happen when trying to load @code{MD5} on a Linux kernel with @abbr{FIPS,Federal Information Processing Standard} enabled.

@item 
gh-95097@footnote{https://github.com/python/cpython/issues/95097}: Fix @ref{525,,asyncio.run()} for @ref{580,,asyncio.Task}
implementations without @ref{321,,uncancel()} method. Patch by
Kumar Aditya.

@item 
gh-95087@footnote{https://github.com/python/cpython/issues/95087}: Fix IndexError in parsing invalid date in the @ref{3c,,email}
module.

@item 
gh-95199@footnote{https://github.com/python/cpython/issues/95199}: Upgrade bundled setuptools to 63.2.0.

@item 
gh-95194@footnote{https://github.com/python/cpython/issues/95194}: Upgrade bundled pip to 22.2.

@item 
gh-93899@footnote{https://github.com/python/cpython/issues/93899}: Fix check for existence of @ref{17d5,,os.EFD_CLOEXEC},
@ref{17d6,,os.EFD_NONBLOCK} and @ref{17d7,,os.EFD_SEMAPHORE} flags on older
kernel versions where these flags are not present. Patch by Kumar Aditya.

@item 
gh-95166@footnote{https://github.com/python/cpython/issues/95166}: Fix @ref{e69,,concurrent.futures.Executor.map()} to cancel the
currently waiting on future on an error - e.g. TimeoutError or
KeyboardInterrupt.

@item 
gh-95132@footnote{https://github.com/python/cpython/issues/95132}: Fix a @ref{cf,,sqlite3} regression where @code{*args} and @code{**kwds}
were incorrectly relayed from @ref{3f5,,connect()} to the
@ref{39e,,Connection} factory. The regression was introduced in
3.11a1 with PR 24421 (gh-85128@footnote{https://github.com/python/cpython/issues/85128}). Patch by Erlend E. Aasland.

@item 
gh-93157@footnote{https://github.com/python/cpython/issues/93157}: Fix @ref{5b,,fileinput} module didn’t support @code{errors} option
when @code{inplace} is true.

@item 
gh-91212@footnote{https://github.com/python/cpython/issues/91212}: Fixed flickering of the turtle window when the tracer is turned
off. Patch by Shin-myoung-serp.

@item 
gh-95077@footnote{https://github.com/python/cpython/issues/95077}: Add deprecation warning for enum @code{member.member} access (e.g.
@code{Color.RED.BLUE}). Remove @code{EnumMeta.__getattr__}.

@item 
gh-95109@footnote{https://github.com/python/cpython/issues/95109}: Ensure that timeouts scheduled with @ref{16d4,,asyncio.Timeout}
that have already expired are delivered promptly.

@item 
gh-95105@footnote{https://github.com/python/cpython/issues/95105}: @code{wsgiref.types.InputStream.__iter__()} should return
@code{Iterator[bytes]}, not @code{Iterable[bytes]}. Patch by Shantanu Jain.

@item 
gh-95066@footnote{https://github.com/python/cpython/issues/95066}: Replaced assert with exception in @ref{30f,,ast.parse()}, when
@code{feature_version} has an invalid major version. Patch by Shantanu Jain.

@item 
gh-77617@footnote{https://github.com/python/cpython/issues/77617}: Add @ref{cf,,sqlite3} @ref{4ee,,command-line interface}.
Patch by Erlend Aasland.

@item 
gh-95005@footnote{https://github.com/python/cpython/issues/95005}: Replace _PyAccu with _PyUnicodeWriter in
JSON encoder and StringIO and remove the _PyAccu implementation.

@item 
gh-90085@footnote{https://github.com/python/cpython/issues/90085}: Remove @code{-c/--clock} and @code{-t/--time} CLI options of
@ref{ef,,timeit}. The options had been deprecated since Python 3.3 and the
functionality was removed in Python 3.7. Patch by Shantanu Jain.

@item 
gh-94857@footnote{https://github.com/python/cpython/issues/94857}: Fix refleak in @code{_io.TextIOWrapper.reconfigure}. Patch by Kumar
Aditya.

@item 
gh-94821@footnote{https://github.com/python/cpython/issues/94821}: Fix binding of unix socket to empty address on Linux to use an
available address from the abstract namespace, instead of «0».

@item 
gh-94736@footnote{https://github.com/python/cpython/issues/94736}: Fix crash when deallocating an instance of a subclass of
@code{_multiprocessing.SemLock}. Patch by Kumar Aditya.

@item 
gh-81620@footnote{https://github.com/python/cpython/issues/81620}: Add random.binomialvariate().

@item 
gh-74116@footnote{https://github.com/python/cpython/issues/74116}: Allow @ref{17b6,,asyncio.StreamWriter.drain()} to be awaited
concurrently by multiple tasks. Patch by Kumar Aditya.

@item 
gh-87822@footnote{https://github.com/python/cpython/issues/87822}: When called with @code{capture_locals=True}, the @ref{fe,,traceback}
module functions swallow exceptions raised from calls to @code{repr()} on
local variables of frames. This is in order to prioritize the original
exception over rendering errors.  An indication of the failure is printed
in place of the missing value.  (Patch by Simon-Martin Schroeder).

@item 
gh-88050@footnote{https://github.com/python/cpython/issues/88050}: Fix @ref{b,,asyncio} subprocess transport to kill process cleanly
when process is blocked and avoid @code{RuntimeError} when loop is closed.
Patch by Kumar Aditya.

@item 
gh-94637@footnote{https://github.com/python/cpython/issues/94637}: @code{SSLContext.set_default_verify_paths()} now releases the GIL
around @code{SSL_CTX_set_default_verify_paths} call. The function call
performs I/O and CPU intensive work.

@item 
gh-94309@footnote{https://github.com/python/cpython/issues/94309}: Deprecate aliases @ref{598,,typing.Hashable} and
@ref{599,,typing.Sized}

@item 
gh-92546@footnote{https://github.com/python/cpython/issues/92546}: An undocumented @code{python -m pprint} benchmark is moved into
@code{pprint} suite of pyperformance. Patch by Oleg Iarygin.

@item 
gh-94607@footnote{https://github.com/python/cpython/issues/94607}: Fix subclassing complex generics with type variables in
@ref{104,,typing}. Previously an error message saying @code{Some type variables
... are not listed in Generic[...]} was shown. @ref{104,,typing} no longer
populates @code{__parameters__} with the @code{__parameters__} of a Python
class.

@item 
gh-94619@footnote{https://github.com/python/cpython/issues/94619}: Remove the long-deprecated @code{module_repr()} from
@ref{77,,importlib}.

@item 
gh-93910@footnote{https://github.com/python/cpython/issues/93910}: The ability to access the other values of an enum on an enum
(e.g. @code{Color.RED.BLUE}) has been restored in order to fix a performance
regression.

@item 
gh-93896@footnote{https://github.com/python/cpython/issues/93896}: Fix @ref{525,,asyncio.run()} and
@ref{206,,unittest.IsolatedAsyncioTestCase} to always the set event loop as
it was done in Python 3.10 and earlier. Patch by Kumar Aditya.

@item 
gh-94343@footnote{https://github.com/python/cpython/issues/94343}: Allow setting the attributes of @code{reprlib.Repr} during object
initialization

@item 
gh-94382@footnote{https://github.com/python/cpython/issues/94382}: Port static types of @code{_multiprocessing} module to heap types.
Patch by Kumar Aditya.

@item 
gh-78724@footnote{https://github.com/python/cpython/issues/78724}: Fix crash in @ref{16b9,,struct.Struct} when it was not completely
initialized by initializing it in @ref{624,,__new__()}.  Patch by Kumar
Aditya.

@item 
gh-94510@footnote{https://github.com/python/cpython/issues/94510}: Re-entrant calls to @ref{153f,,sys.setprofile()} and
@ref{1540,,sys.settrace()} now raise @ref{1e5,,RuntimeError}. Patch by Pablo
Galindo.

@item 
gh-92336@footnote{https://github.com/python/cpython/issues/92336}: Fix bug where @ref{ea8,,linecache.getline()} fails on bad files with
@ref{aa5,,UnicodeDecodeError} or @ref{150,,SyntaxError}. It now returns an empty
string as per the documentation.

@item 
gh-94398@footnote{https://github.com/python/cpython/issues/94398}: Once a @ref{31c,,asyncio.TaskGroup} has started shutting down
(i.e., at least one task has failed and the task group has started
cancelling the remaining tasks), it should not be possible to add new
tasks to the task group.

@item 
gh-94383@footnote{https://github.com/python/cpython/issues/94383}: @code{xml.etree}: Remove the @code{ElementTree.Element.copy()}
method of the pure Python implementation, deprecated in Python 3.10, use
the @ref{5d7,,copy.copy()} function instead. The C implementation of
@code{xml.etree} has no @code{copy()} method, only a @code{__copy__()} method.
Patch by Victor Stinner.

@item 
gh-94379@footnote{https://github.com/python/cpython/issues/94379}: @ref{131,,zipimport}: Remove @code{find_loader()} and @code{find_module()}
methods, deprecated in Python 3.10: use the @code{find_spec()} method
instead. See 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} for the rationale. Patch by Victor Stinner.

@item 
gh-94352@footnote{https://github.com/python/cpython/issues/94352}: @ref{5de,,shlex.split()}: Passing @code{None} for `s' argument now
raises an exception, rather than reading @ref{5df,,sys.stdin}. The feature
was deprecated in Python 3.9. Patch by Victor Stinner.

@item 
gh-94318@footnote{https://github.com/python/cpython/issues/94318}: Strip trailing spaces in @ref{b5,,pydoc} text output.

@item 
gh-89988@footnote{https://github.com/python/cpython/issues/89988}: Fix memory leak in @ref{ab0,,pickle.Pickler} when looking up
@code{dispatch_table}. Patch by Kumar Aditya.

@item 
gh-90016@footnote{https://github.com/python/cpython/issues/90016}: Deprecate @ref{cf,,sqlite3} @ref{595,,default adapters and converters}. Patch by Erlend E. Aasland.

@item 
gh-94254@footnote{https://github.com/python/cpython/issues/94254}: Fixed types of @ref{d5,,struct} module to be immutable. Patch by
Kumar Aditya.

@item 
gh-93259@footnote{https://github.com/python/cpython/issues/93259}: Now raise @code{ValueError} when @code{None} or an empty string are
passed to @code{Distribution.from_name} (and other callers).

@item 
gh-74696@footnote{https://github.com/python/cpython/issues/74696}: @ref{55a,,shutil.make_archive()} now passes the `root_dir' argument
to custom archivers which support it.

@item 
gh-94216@footnote{https://github.com/python/cpython/issues/94216}: The @ref{39,,dis} module now has the opcodes for pseudo
instructions (those which are used by the compiler during code generation
but then removed or replaced by real opcodes before the final bytecode is
emitted).

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: Removed undocumented @code{python -m codecs}. Use @code{python -m
unittest test.test_codecs.EncodedFileTest} instead.

@item 
gh-94207@footnote{https://github.com/python/cpython/issues/94207}: Made @code{_struct.Struct} GC-tracked in order to fix a
reference leak in the @code{_struct} module.

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: Removed undocumented @code{-t} argument of @code{python -m base64}.
Use @code{python -m unittest
test.test_base64.LegacyBase64TestCase.test_encodebytes} instead.

@item 
gh-94226@footnote{https://github.com/python/cpython/issues/94226}: Remove the @code{locale.format()} function, deprecated in Python
3.7: use @ref{5c2,,locale.format_string()} instead. Patch by Victor Stinner.

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: Remove the @code{ssl.match_hostname()} function. The
@code{ssl.match_hostname()} was deprecated in Python 3.7. OpenSSL performs
hostname matching since Python 3.7, Python no longer uses the
@code{ssl.match_hostname()} function. Patch by Victor Stinner.

@item 
gh-94214@footnote{https://github.com/python/cpython/issues/94214}: Document the @code{context} object used in the @code{venv.EnvBuilder}
class, and add the new environment’s library path to it.

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: Remove the @code{ssl.wrap_socket()} function, deprecated in
Python 3.7: instead, create a @ref{1fa,,ssl.SSLContext} object and call its
@ref{5c8,,ssl.SSLContext.wrap_socket} method. Any package that still uses
@code{ssl.wrap_socket()} is broken and insecure. The function neither sends
a SNI TLS extension nor validates server hostname. Code is subject to
@geindex Common Weakness Enumeration; CWE 295
CWE 295@footnote{https://cwe.mitre.org/data/definitions/295.html} Improper Certificate Validation. Patch by Victor Stinner.

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: Remove the @code{ssl.RAND_pseudo_bytes()} function, deprecated in
Python 3.6: use @ref{5c6,,os.urandom()} or @ref{5c7,,ssl.RAND_bytes()} instead.
Patch by Victor Stinner.

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: @ref{68,,hashlib}: Remove the pure Python implementation of
@ref{5b3,,hashlib.pbkdf2_hmac()}, deprecated in Python 3.10. Python 3.10 and
newer requires OpenSSL 1.1.1 (
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}): this OpenSSL version provides a
C implementation of @ref{5b3,,pbkdf2_hmac()} which is faster. Patch by
Victor Stinner.

@item 
gh-94196@footnote{https://github.com/python/cpython/issues/94196}: @ref{67,,gzip}: Remove the @code{filename} attribute of
@ref{4d8,,gzip.GzipFile}, deprecated since Python 2.6, use the
@ref{5b1,,name} attribute instead. In write mode, the
@code{filename} attribute added @code{'.gz'} file extension if it was not
present. Patch by Victor Stinner.

@item 
gh-94182@footnote{https://github.com/python/cpython/issues/94182}: run the @code{asyncio.PidfdChildWatcher} on the running loop,
this allows event loops to run subprocesses when there is no default event
loop running on the main thread

@item 
gh-94169@footnote{https://github.com/python/cpython/issues/94169}: Remove @code{io.OpenWrapper} and @code{_pyio.OpenWrapper}, deprecated
in Python 3.10: just use @ref{1be,,open()} instead. The @ref{1be,,open()}
(@ref{5c0,,io.open()}) function is a built-in function. Since Python 3.10,
@code{_pyio.open()} is also a static method. Patch by Victor Stinner.

@item 
gh-91742@footnote{https://github.com/python/cpython/issues/91742}: Fix @ref{a5,,pdb} crash after jump caused by a null pointer
dereference. Patch by Kumar Aditya.

@item 
gh-94101@footnote{https://github.com/python/cpython/issues/94101}: Manual instantiation of @ref{d64,,ssl.SSLSession} objects is no
longer allowed as it lead to misconfigured instances that crashed the
interpreter when attributes where accessed on them.

@item 
gh-84753@footnote{https://github.com/python/cpython/issues/84753}: @ref{1c3,,inspect.iscoroutinefunction()},
@ref{17d8,,inspect.isgeneratorfunction()}, and
@ref{17d9,,inspect.isasyncgenfunction()} now properly return @code{True} for
duck-typed function-like objects like instances of
@ref{add,,unittest.mock.AsyncMock}.

This makes @ref{1c3,,inspect.iscoroutinefunction()} consistent with the
behavior of @code{asyncio.iscoroutinefunction()}.  Patch by Mehdi ABAAKOUK.

@item 
gh-94028@footnote{https://github.com/python/cpython/issues/94028}: Fix a regression in the @ref{cf,,sqlite3} where statement objects
were not properly cleared and reset after use in cursor iters. The
regression was introduced by PR 27884 in Python 3.11a1. Patch by Erlend E.
Aasland.

@item 
gh-93973@footnote{https://github.com/python/cpython/issues/93973}: Add keyword argument @code{all_errors} to
@code{asyncio.create_connection} so that multiple connection errors can be
raised as an @code{ExceptionGroup}.

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: Officially deprecate from @code{importlib.abc} classes moved to
@code{importlib.resources.abc}.

@item 
gh-93858@footnote{https://github.com/python/cpython/issues/93858}: Prevent error when activating venv in nested fish instances.

@item 
gh-93820@footnote{https://github.com/python/cpython/issues/93820}: Pickle @ref{6c4,,enum.Flag} by name.

@item 
gh-93847@footnote{https://github.com/python/cpython/issues/93847}: Fix repr of enum of generic aliases.

@item 
gh-91404@footnote{https://github.com/python/cpython/issues/91404}: Revert the @ref{b9,,re} memory leak when a match is terminated by a
signal or memory allocation failure as the implemented fix caused a major
performance regression.

@item 
gh-83499@footnote{https://github.com/python/cpython/issues/83499}: Fix double closing of file description in @ref{e0,,tempfile}.

@item 
gh-93820@footnote{https://github.com/python/cpython/issues/93820}: Fixed a regression when @ref{5d7,,copy.copy()}-ing @ref{6c4,,enum.Flag}
with multiple flag members.

@item 
gh-79512@footnote{https://github.com/python/cpython/issues/79512}: Fixed names and @code{__module__} value of @ref{114,,weakref} classes
@ref{17da,,ReferenceType}, @ref{17db,,ProxyType},
@ref{17dc,,CallableProxyType}. It makes them pickleable.

@item 
gh-91389@footnote{https://github.com/python/cpython/issues/91389}: Fix an issue where @ref{39,,dis} utilities could report missing or
incorrect position information in the presence of @code{CACHE} entries.

@item 
gh-93626@footnote{https://github.com/python/cpython/issues/93626}: Set @code{__future__.annotations} to have a @code{None}
mandatoryRelease to indicate that it is currently “TBD”.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Emscripten and WASI have no home directory and cannot provide
@geindex Python Enhancement Proposals; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} user site directory.

@item 
gh-90494@footnote{https://github.com/python/cpython/issues/90494}: @ref{5d7,,copy.copy()} and @ref{bf6,,copy.deepcopy()} now always raise a
TypeError if @code{__reduce__()} returns a tuple with length 6 instead of
silently ignore the 6th item or produce incorrect result.

@item 
gh-90549@footnote{https://github.com/python/cpython/issues/90549}: Fix a multiprocessing bug where a global named resource (such as
a semaphore) could leak when a child process is spawned (as opposed to
forked).

@item 
gh-93521@footnote{https://github.com/python/cpython/issues/93521}: Fixed a case where dataclasses would try to add @code{__weakref__}
into the @code{__slots__} for a dataclass that specified
@code{weakref_slot=True} when it was already defined in one of its bases.
This resulted in a @code{TypeError} upon the new class being created.

@item 
gh-79579@footnote{https://github.com/python/cpython/issues/79579}: @ref{cf,,sqlite3} now correctly detects DML queries with leading
comments. Patch by Erlend E. Aasland.

@item 
gh-93421@footnote{https://github.com/python/cpython/issues/93421}: Update @ref{17dd,,sqlite3.Cursor.rowcount} when a DML statement has
run to completion. This fixes the row count for SQL queries like @code{UPDATE
... RETURNING}. Patch by Erlend E. Aasland.

@item 
gh-93475@footnote{https://github.com/python/cpython/issues/93475}: Expose @code{FICLONE} and @code{FICLONERANGE} constants in
@ref{59,,fcntl}. Patch by Illia Volochii.

@item 
gh-93370@footnote{https://github.com/python/cpython/issues/93370}: Deprecate @code{version} and @code{version_info}.

@item 
gh-91810@footnote{https://github.com/python/cpython/issues/91810}: Suppress writing an XML declaration in open files in
@code{ElementTree.write()} with @code{encoding='unicode'} and
@code{xml_declaration=None}.

@item 
gh-91162@footnote{https://github.com/python/cpython/issues/91162}: Support splitting of unpacked arbitrary-length tuple over
@code{TypeVar} and @code{TypeVarTuple} parameters. For example:


@itemize *

@item 
@code{A[T, *Ts][*tuple[int, ...]]} -> @code{A[int, *tuple[int, ...]]}

@item 
@code{A[*Ts, T][*tuple[int, ...]]} -> @code{A[*tuple[int, ...], int]}
@end itemize

@item 
gh-93353@footnote{https://github.com/python/cpython/issues/93353}: Fix the @ref{536,,importlib.resources.as_file()} context manager to
remove the temporary file if destroyed late during Python finalization:
keep a local reference to the @ref{1163,,os.remove()} function. Patch by Victor
Stinner.

@item 
gh-83658@footnote{https://github.com/python/cpython/issues/83658}: Make @code{multiprocessing.Pool} raise an exception if
@code{maxtasksperchild} is not @code{None} or a positive int.

@item 
gh-93312@footnote{https://github.com/python/cpython/issues/93312}: Add @ref{543,,os.PIDFD_NONBLOCK} flag to open a file descriptor
for a process with @ref{524,,os.pidfd_open()} in non-blocking mode. Patch by
Kumar Aditya.

@item 
gh-88123@footnote{https://github.com/python/cpython/issues/88123}: Implement @code{Enum.__contains__} that returns @code{True} or
@code{False} to replace the deprecated behaviour that would sometimes raise a
@ref{228,,TypeError}.

@item 
gh-93297@footnote{https://github.com/python/cpython/issues/93297}: Make asyncio task groups prevent child tasks from being GCed

@item 
gh-85308@footnote{https://github.com/python/cpython/issues/85308}: Changed @ref{15c,,argparse.ArgumentParser} to use
@ref{5dd,,filesystem encoding and error handler} instead of default text
encoding to read arguments from file (e.g. @code{fromfile_prefix_chars}
option). This change affects Windows; argument file should be encoded with
UTF-8 instead of ANSI Codepage.

@item 
gh-93156@footnote{https://github.com/python/cpython/issues/93156}: Accessing the @ref{8b7,,pathlib.PurePath.parents} sequence of an
absolute path using negative index values produced incorrect results.

@item 
gh-93162@footnote{https://github.com/python/cpython/issues/93162}: Add the ability for @ref{121e,,logging.config.dictConfig()} to
usefully configure @ref{17de,,QueueHandler} and
@ref{eb1,,QueueListener} as a pair, and add
@ref{17df,,logging.getHandlerByName()} and @ref{1703,,logging.getHandlerNames()} APIs
to allow access to handlers by name.

@item 
gh-93243@footnote{https://github.com/python/cpython/issues/93243}: The @code{smtpd} module was removed per the schedule in
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Replace @code{assert} statements with @code{raise AssertionError()} in
@code{BaseHandler} so that the tested behaviour is maintained
running with optimizations @code{(-O)}.

@item 
gh-90155@footnote{https://github.com/python/cpython/issues/90155}: Fix broken @ref{b03,,asyncio.Semaphore} when acquire is cancelled.

@item 
gh-90817@footnote{https://github.com/python/cpython/issues/90817}: The @code{locale.resetlocale()} function is deprecated and will
be removed in Python 3.13. Use @code{locale.setlocale(locale.LC_ALL, "")}
instead. Patch by Victor Stinner.

@item 
gh-91513@footnote{https://github.com/python/cpython/issues/91513}: Added @code{taskName} attribute to @ref{87,,logging} module for use
with @ref{b,,asyncio} tasks.

@item 
gh-74696@footnote{https://github.com/python/cpython/issues/74696}: @ref{55a,,shutil.make_archive()} no longer temporarily changes the
current working directory during creation of standard @code{.zip} or tar
archives.

@item 
gh-92728@footnote{https://github.com/python/cpython/issues/92728}: The @code{re.template()} function and the corresponding
@code{re.TEMPLATE} and @code{re.T} flags are restored after they were
removed in 3.11.0b1, but they are now deprecated, so they might be removed
from Python 3.13.

@item 
gh-93033@footnote{https://github.com/python/cpython/issues/93033}: Search in some strings (platform dependent i.e [U+0xFFFF,
U+0x0100] on Windows or [U+0xFFFFFFFF, U+0x00010000] on Linux 64-bit) are
now up to 10 times faster.

@item 
gh-89973@footnote{https://github.com/python/cpython/issues/89973}: Fix @code{re.error} raised in @ref{5c,,fnmatch} if the pattern
contains a character range with upper bound lower than lower bound (e.g.
@code{[c-a]}). Now such ranges are interpreted as empty ranges.

@item 
gh-93044@footnote{https://github.com/python/cpython/issues/93044}: No longer convert the database argument of
@ref{3f5,,sqlite3.connect()} to bytes before passing it to the factory.

@item 
gh-93010@footnote{https://github.com/python/cpython/issues/93010}: In a very special case, the email package tried to append the
nonexistent @code{InvalidHeaderError} to the defect list. It should have been
@code{InvalidHeaderDefect}.

@item 
gh-92986@footnote{https://github.com/python/cpython/issues/92986}: Fix @ref{97c,,ast.unparse()} when @code{ImportFrom.level} is @code{None}

@item 
gh-92932@footnote{https://github.com/python/cpython/issues/92932}: Now @ref{172,,dis()} and @ref{33d,,get_instructions()} handle
operand values for instructions prefixed by @code{EXTENDED_ARG_QUICK}. Patch
by Sam Gross and Donghee Na.

@item 
gh-92675@footnote{https://github.com/python/cpython/issues/92675}: Fix @code{venv.ensure_directories()} to accept
@ref{19b,,pathlib.Path} arguments in addition to @ref{237,,str} paths. Patch
by David Foster.

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: Removed the @code{encoding} argument from @ref{1c5,,os.popen()} that was
added in 3.11b1.

@item 
gh-91922@footnote{https://github.com/python/cpython/issues/91922}: Fix function @code{sqlite.connect()} and the
@code{sqlite.Connection} constructor on non-UTF-8 locales. Also, they
now support bytes paths non-decodable with the current FS encoding.

@item 
gh-92869@footnote{https://github.com/python/cpython/issues/92869}: Added @ref{17e0,,c_time_t} to @ref{2b,,ctypes}, which has the
same size as the @code{time_t} type in C.

@item 
gh-92839@footnote{https://github.com/python/cpython/issues/92839}: Fixed crash resulting from calling bisect.insort() or
bisect.insort_left() with the key argument not equal to @code{None}.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: @ref{d6,,subprocess} now fails early on Emscripten and WASI
platforms to work around missing @ref{17e1,,os.pipe()} on WASI.

@item 
gh-89325@footnote{https://github.com/python/cpython/issues/89325}: Removed many old deprecated @ref{106,,unittest} features:
@ref{4fa,,TestCase} method aliases, undocumented and broken
@ref{4fa,,TestCase} method @code{assertDictContainsSubset},
undocumented @ref{3e3,,TestLoader.loadTestsFromModule} parameter `use_load_tests', and
an underscored alias of the @ref{5d4,,TextTestResult} class.

@item 
gh-92734@footnote{https://github.com/python/cpython/issues/92734}: Allow multi-element reprs emitted by @ref{bb,,reprlib} to be
pretty-printed using configurable indentation.

@item 
gh-92671@footnote{https://github.com/python/cpython/issues/92671}: Fixed @ref{97c,,ast.unparse()} for empty tuples in the assignment
target context.

@item 
gh-91581@footnote{https://github.com/python/cpython/issues/91581}: @ref{1f5,,utcfromtimestamp()} no longer attempts
to resolve @code{fold} in the pure Python implementation, since the fold is
never 1 in UTC. In addition to being slightly faster in the common case,
this also prevents some errors when the timestamp is close to
@ref{17e2,,datetime.min}.  Patch by Paul Ganssle.

@item 
gh-86388@footnote{https://github.com/python/cpython/issues/86388}: Removed randrange() functionality deprecated since Python 3.10.
Formerly, randrange(10.0) losslessly converted to randrange(10). Now, it
raises a TypeError. Also, the exception raised for non-integral values
such as randrange(10.5) or randrange(“10”) has been changed from
ValueError to TypeError.

@item 
gh-90385@footnote{https://github.com/python/cpython/issues/90385}: Add @ref{550,,pathlib.Path.walk()} as an alternative to
@ref{551,,os.walk()}.

@item 
gh-92550@footnote{https://github.com/python/cpython/issues/92550}: Fix @ref{389,,pathlib.Path.rglob()} for empty pattern.

@item 
gh-92591@footnote{https://github.com/python/cpython/issues/92591}: Allow @ref{87,,logging} filters to return a
@ref{1065,,logging.LogRecord} instance so that filters attached to
@ref{14d0,,logging.Handler}s can enrich records without side effects on
other handlers.

@item 
gh-92445@footnote{https://github.com/python/cpython/issues/92445}: Fix a bug in @ref{7,,argparse} where @code{nargs="*"} would raise an
error instead of returning an empty list when 0 arguments were supplied if
choice was also defined in @code{parser.add_argument}.

@item 
gh-92547@footnote{https://github.com/python/cpython/issues/92547}: Remove undocumented @ref{cf,,sqlite3} features deprecated in Python
3.10:


@itemize *

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode}
@end itemize

Patch by Erlend E. Aasland.

@item 
gh-92530@footnote{https://github.com/python/cpython/issues/92530}: Fix an issue that occurred after interrupting
@ref{17e3,,threading.Condition.notify()}.

@item 
gh-92531@footnote{https://github.com/python/cpython/issues/92531}: The statistics.median_grouped() function now always return a
float. Formerly, it did not convert the input type when for sequences of
length one.

@item 
gh-84131@footnote{https://github.com/python/cpython/issues/84131}: The @ref{19b,,pathlib.Path} deprecated method @code{link_to} has been
removed. Use 3.10’s @ref{8b8,,hardlink_to()} method instead as
its semantics are consistent with that of
@ref{8b9,,symlink_to()}.

@item 
gh-89336@footnote{https://github.com/python/cpython/issues/89336}: Removed @ref{23,,configparser} module APIs: the
@code{SafeConfigParser} class alias, the @code{ParsingError.filename} property
and parameter, and the @code{ConfigParser.readfp} method, all of which were
deprecated since Python 3.2.

@item 
gh-92391@footnote{https://github.com/python/cpython/issues/92391}: Add @ref{7d6,,__class_getitem__()} to
@ref{a77,,csv.DictReader} and @ref{126b,,csv.DictWriter}, allowing them to be
parameterized at runtime. Patch by Marc Mueller.

@item 
gh-91968@footnote{https://github.com/python/cpython/issues/91968}: Add @code{SO_RTABLE} and @code{SO_USER_COOKIE} constants to
@ref{cc,,socket}.

@item 
gh-91810@footnote{https://github.com/python/cpython/issues/91810}: @ref{9e1,,ElementTree} method
@ref{13b5,,write()} and function
@ref{1072,,tostring()} now use the text file’s encoding
(«UTF-8» if not available) instead of locale encoding in XML declaration
when @code{encoding="unicode"} is specified.

@item 
gh-81790@footnote{https://github.com/python/cpython/issues/81790}: @ref{c7c,,os.path.splitdrive()} now understands DOS device paths with
UNC links (beginning @code{\\?\UNC\}). Contributed by Barney Gale.

@item 
gh-91760@footnote{https://github.com/python/cpython/issues/91760}: Apply more strict rules for numerical group references and group
names in regular expressions. Only sequence of ASCII digits is now
accepted as a numerical reference. The group name in bytes patterns and
replacement strings can now only contain ASCII letters and digits and
underscore.

@item 
gh-90622@footnote{https://github.com/python/cpython/issues/90622}: Worker processes for
@ref{163,,concurrent.futures.ProcessPoolExecutor} are no longer spawned on
demand (a feature added in 3.9) when the multiprocessing context start
method is @code{"fork"} as that can lead to deadlocks in the child processes
due to a fork happening while threads are running.

@item 
gh-91577@footnote{https://github.com/python/cpython/issues/91577}: Move imports in @code{SharedMemory} methods
to module level so that they can be executed late in python finalization.

@item 
gh-91581@footnote{https://github.com/python/cpython/issues/91581}: Remove an unhandled error case in the C implementation of calls
to @ref{593,,datetime.fromtimestamp} with
no time zone (i.e. getting a local time from an epoch timestamp). This
should have no user-facing effect other than giving a possibly more
accurate error message when called with timestamps that fall on
10000-01-01 in the local time. Patch by Paul Ganssle.

@item 
gh-91539@footnote{https://github.com/python/cpython/issues/91539}: Improve performance of @code{urllib.request.getproxies_environment}
when there are many environment variables

@item 
gh-91524@footnote{https://github.com/python/cpython/issues/91524}: Speed up the regular expression substitution (functions
@ref{3f2,,re.sub()} and @ref{3f3,,re.subn()} and corresponding @ref{17e4,,re.Pattern}
methods) for replacement strings containing group references by 2–3
times.

@item 
gh-91447@footnote{https://github.com/python/cpython/issues/91447}: Fix findtext in the xml module to only give an empty string when
the text attribute is set to @code{None}.

@item 
gh-91456@footnote{https://github.com/python/cpython/issues/91456}: Deprecate current default auto() behavior:  In 3.13 the default
will be for for auto() to always return the largest member value
incremented by 1, and to raise if incompatible value types are used.

@item 
bpo-47231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47231}: Fixed an issue with inconsistent trailing slashes in tarfile
longname directories.

@item 
bpo-39064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39064}: @ref{765,,zipfile.ZipFile} now raises @ref{17e5,,zipfile.BadZipFile}
instead of @code{ValueError} when reading a corrupt zip file in which the
central directory offset is negative.

@item 
bpo-41287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41287}: Fix handling of the @code{doc} argument in subclasses of
@ref{2fd,,property()}.

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @ref{2b,,ctypes} dependency @code{libffi} is now detected with
@code{pkg-config}.

@item 
bpo-32547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32547}: The constructors for @ref{126b,,DictWriter} and
@ref{a77,,DictReader} now coerce the @code{fieldnames} argument to a
@ref{18e,,list} if it is an iterator.

@item 
bpo-35540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35540}: Fix @ref{172b,,dataclasses.asdict()} crash when
@ref{122a,,collections.defaultdict} is present in the attributes.

@item 
bpo-47063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47063}: Add an index_pages parameter to support using non-default index
page names.

@item 
bpo-47025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47025}: Drop support for @ref{325,,bytes} on @ref{27e,,sys.path}.

@item 
bpo-46951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46951}: Order the contents of zipapp archives, to make builds more
reproducible.

@item 
bpo-42777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42777}: Implement @ref{aa9,,pathlib.Path.is_mount()} for Windows paths.

@item 
bpo-46755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46755}: In @code{QueueHandler}, clear @code{stack_info} from
@code{LogRecord} to prevent stack trace from being written twice.

@item 
bpo-45393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45393}: Fix the formatting for @code{await x} and @code{not x} in the
operator precedence table when using the @ref{96e,,help()} system.

@item 
bpo-46642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46642}: Improve error message when trying to subclass an instance of
@ref{2c9,,typing.TypeVar}, @ref{2ca,,typing.ParamSpec},
@ref{2cb,,typing.TypeVarTuple}, etc. Based on patch by Gregory Beauregard.

@item 
bpo-46364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46364}: Restrict use of sockets instead of pipes for stdin of
subprocesses created by @ref{b,,asyncio} to AIX platform only.

@item 
bpo-28249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28249}: Set @ref{17e6,,doctest.DocTest.lineno} to @code{None} when an object
does not have @ref{9bb,,__doc__}.

@item 
bpo-46197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46197}: Fix @ref{55,,ensurepip} environment isolation for subprocess
running @code{pip}.

@item 
bpo-45924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45924}: Fix @ref{b,,asyncio} incorrect traceback when future’s exception
is raised multiple times. Patch by Kumar Aditya.

@item 
bpo-45046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45046}: Add support of context managers in @ref{106,,unittest}: methods
@ref{75a,,enterContext()} and
@ref{75b,,enterClassContext()} of class
@ref{4fa,,TestCase}, method
@ref{75c,,enterAsyncContext()} of class
@ref{206,,IsolatedAsyncioTestCase} and function
@ref{75d,,unittest.enterModuleContext()}.

@item 
bpo-44173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44173}: Enable fast seeking of uncompressed unencrypted
@code{zipfile.ZipExtFile}

@item 
bpo-42627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42627}: Fix incorrect parsing of Windows registry proxy settings

@item 
bpo-42047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42047}: Add @ref{ad0,,threading.get_native_id()} support for DragonFly BSD.
Patch by David Carlier.

@item 
bpo-14243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14243}: The @ref{56d,,tempfile.NamedTemporaryFile} function has a new
optional parameter `delete_on_close'

@item 
bpo-41246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41246}: Give the same callback function for when the overlapped
operation is done to the functions @code{recv}, @code{recv_into}, @code{recvfrom},
@code{sendto}, @code{send} and @code{sendfile} inside @code{IocpProactor}.

@item 
bpo-39264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39264}: Fixed @code{collections.UserDict.get()} to not call
@code{__missing__()} when a value is not found. This matches the behavior
of @ref{190,,dict}. Patch by Bar Harel.

@item 
bpo-38693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38693}: @ref{77,,importlib} now uses f-strings internally instead of
@code{str.format}.

@item 
bpo-38267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38267}: Add `timeout' parameter to
@ref{97e,,asyncio.loop.shutdown_default_executor()}. The default value is
@code{None}, which means the executor will be given an unlimited amount of
time. When called from @ref{6a1,,asyncio.Runner} or @ref{525,,asyncio.run()}, the
default timeout is 5 minutes.

@item 
bpo-34828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34828}: @ref{3a0,,sqlite3.Connection.iterdump()} now handles databases that
use @code{AUTOINCREMENT} in one or more tables.

@item 
bpo-32990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32990}: Support reading wave files with the @code{WAVE_FORMAT_EXTENSIBLE}
format in the @ref{113,,wave} module.

@item 
bpo-26253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26253}: Allow adjustable compression level for tarfile streams in
@ref{ef8,,tarfile.open()}.
@end itemize

@node Documentation<16>,Tests<16>,Library<17>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id146}@anchor{17e7}
@subsubsection Documentation



@itemize -

@item 
gh-85525@footnote{https://github.com/python/cpython/issues/85525}: Remove extra row

@item 
gh-86404@footnote{https://github.com/python/cpython/issues/86404}: Deprecated tools @code{make suspicious} and @code{rstlint.py} are now
removed. They have been replaced by sphinx-lint@footnote{https://pypi.org/project/sphinx-lint/}.

@item 
gh-97741@footnote{https://github.com/python/cpython/issues/97741}: Fix @code{!} in c domain ref target syntax via a @code{conf.py} patch,
so it works as intended to disable ref target resolution.

@item 
gh-96432@footnote{https://github.com/python/cpython/issues/96432}: Fraction literals now support whitespace around the forward
slash, @code{Fraction('2 / 3')}.

@item 
gh-96098@footnote{https://github.com/python/cpython/issues/96098}: Improve discoverability of the higher level concurrent.futures
module by providing clearer links from the lower level threading and
multiprocessing modules.

@item 
gh-95957@footnote{https://github.com/python/cpython/issues/95957}: What’s New 3.11 now has instructions for how to provide compiler
and linker flags for Tcl/Tk and OpenSSL on RHEL 7 and CentOS 7.

@item 
gh-95588@footnote{https://github.com/python/cpython/issues/95588}: Clarified the conflicting advice given in the @ref{9,,ast}
documentation about @ref{ca0,,ast.literal_eval()} being «safe» for use on
untrusted input while at the same time warning that it can crash the
process. The latter statement is true and is deemed unfixable without a
large amount of work unsuitable for a bugfix. So we keep the warning and
no longer claim that @code{literal_eval} is safe.

@item 
gh-91207@footnote{https://github.com/python/cpython/issues/91207}: Fix stylesheet not working in Windows CHM htmlhelp docs and add
warning that they are deprecated. Contributed by C.A.M. Gerlach.

@item 
gh-95454@footnote{https://github.com/python/cpython/issues/95454}: Replaced incorrectly written true/false values in documentation.
Patch by Robert O’Shea

@item 
gh-95451@footnote{https://github.com/python/cpython/issues/95451}: Update library documentation with @ref{17e8,,availability information} on WebAssembly platforms @code{wasm32-emscripten} and
@code{wasm32-wasi}.

@item 
gh-95415@footnote{https://github.com/python/cpython/issues/95415}: Use consistent syntax for platform availability. The directive
now supports a content body and emits a warning when it encounters an
unknown platform.

@item 
gh-94321@footnote{https://github.com/python/cpython/issues/94321}: Document the 
@geindex Python Enhancement Proposals; PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} style protocol type
@ref{17e9,,sqlite3.PrepareProtocol}.

@item 
gh-86128@footnote{https://github.com/python/cpython/issues/86128}: Document a limitation in ThreadPoolExecutor where its exit
handler is executed before any handlers in atexit.

@item 
gh-61162@footnote{https://github.com/python/cpython/issues/61162}: Clarify @ref{cf,,sqlite3} behavior when
@ref{17ea,,Como usar la conexión con un administrador de contexto}.

@item 
gh-87260@footnote{https://github.com/python/cpython/issues/87260}: Align @ref{cf,,sqlite3} argument specs with the actual
implementation.

@item 
gh-86986@footnote{https://github.com/python/cpython/issues/86986}: The minimum Sphinx version required to build the documentation
is now 3.2.

@item 
gh-88831@footnote{https://github.com/python/cpython/issues/88831}: Augmented documentation of asyncio.create_task(). Clarified the
need to keep strong references to tasks and added a code snippet detailing
how to do this.

@item 
gh-86438@footnote{https://github.com/python/cpython/issues/86438}: Clarify that @ref{95e,,-W} and 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} are
matched literally and case-insensitively, rather than as regular
expressions, in @ref{112,,warnings}.

@item 
gh-93031@footnote{https://github.com/python/cpython/issues/93031}: Update tutorial introduction output to use 3.10+ SyntaxError
invalid range.

@item 
gh-92240@footnote{https://github.com/python/cpython/issues/92240}: Added release dates for «What’s New in Python 3.X» for 3.0, 3.1,
3.2, 3.8 and 3.10

@item 
bpo-47161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47161}: Document that @ref{54e,,pathlib.PurePath} does not collapse
initial double slashes because they denote UNC paths.

@item 
bpo-40838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40838}: Document that @ref{a8c,,inspect.getdoc()},
@ref{17eb,,inspect.getmodule()}, and @ref{17ec,,inspect.getsourcefile()} might return
@code{None}.

@item 
bpo-43689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43689}: The @code{Differ} documentation now also mentions other whitespace
characters, which make it harder to understand the diff output.

@item 
bpo-38056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38056}: Overhaul the @ref{17ed,,Manejadores de errores} documentation in
@ref{1c,,codecs}.

@item 
bpo-13553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13553}: Document tkinter.Tk args.
@end itemize

@node Tests<16>,Build<17>,Documentation<16>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id147}@anchor{17ee}
@subsubsection Tests



@itemize -

@item 
gh-95027@footnote{https://github.com/python/cpython/issues/95027}: On Windows, when the Python test suite is run with the @code{-jN}
option, the ANSI code page is now used as the encoding for the stdout
temporary file, rather than using UTF-8 which can lead to decoding errors.
Patch by Victor Stinner.

@item 
gh-96624@footnote{https://github.com/python/cpython/issues/96624}: Fixed the failure of repeated runs of @code{test.test_unittest}
caused by side effects in @code{test_dotted_but_module_not_loaded}.

@item 
gh-95243@footnote{https://github.com/python/cpython/issues/95243}: Mitigate the inherent race condition from using
find_unused_port() in testSockName() by trying to find an unused port a
few times before failing. Patch by Ross Burton.

@item 
gh-95573@footnote{https://github.com/python/cpython/issues/95573}: Lib/test/test_asyncio/test_ssl.py@footnote{https://github.com/python/cpython/tree/main/Lib/test/test_asyncio/test_ssl.py} exposed a bug in the
macOS kernel where intense concurrent load on non-blocking sockets
occasionally causes @ref{17ef,,errno.ENOBUFS} («No buffer space available»)
to be emitted. FB11063974 filed with Apple, in the mean time as a
workaround buffer size used in tests on macOS is decreased to avoid
intermittent failures.  Patch by Fantix King.

@item 
gh-95280@footnote{https://github.com/python/cpython/issues/95280}: Fix problem with @code{test_ssl} @code{test_get_ciphers} on systems
that require perfect forward secrecy (PFS) ciphers.

@item 
gh-95212@footnote{https://github.com/python/cpython/issues/95212}: Make multiprocessing test case @code{test_shared_memory_recreate}
parallel-safe.

@item 
gh-95218@footnote{https://github.com/python/cpython/issues/95218}: Move tests for importlib.resources into
test_importlib.resources.

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: Updated tests to use preferred location for
@code{importlib.resources} ABCs.

@item 
gh-94675@footnote{https://github.com/python/cpython/issues/94675}: Add a regression test for @ref{b9,,re} exponentional slowdown when
using rjsmin.

@item 
gh-91330@footnote{https://github.com/python/cpython/issues/91330}: Added more tests for @ref{30,,dataclasses} to cover behavior with
data descriptor-based fields.

@item 
gh-94208@footnote{https://github.com/python/cpython/issues/94208}: @code{test_ssl} is now checking for supported TLS version and
protocols in more tests.

@item 
gh-94315@footnote{https://github.com/python/cpython/issues/94315}: Tests now check for DAC override capability instead of relying
on @ref{17f0,,os.geteuid()}.

@item 
gh-54781@footnote{https://github.com/python/cpython/issues/54781}: Rename test_tk to test_tkinter, and rename test_ttk_guionly to
test_ttk. Patch by Victor Stinner.

@item 
gh-93839@footnote{https://github.com/python/cpython/issues/93839}: Move @code{Lib/ctypes/test/} to @code{Lib/test/test_ctypes/}. Patch by
Victor Stinner.

@item 
gh-93951@footnote{https://github.com/python/cpython/issues/93951}: In test_bdb.StateTestCase.test_skip, avoid including auxiliary
importers.

@item 
gh-93957@footnote{https://github.com/python/cpython/issues/93957}: Provide nicer error reporting from subprocesses in
test_venv.EnsurePipTest.test_with_pip.

@item 
gh-93884@footnote{https://github.com/python/cpython/issues/93884}: Add test cases for @ref{17f1,,PyNumber_ToBase()} that take a large
number or a non-int object as parameter.

@item 
gh-93852@footnote{https://github.com/python/cpython/issues/93852}: test_asyncio, test_logging, test_socket and test_socketserver
now create AF_UNIX domains in the current directory to no longer fail with
@code{OSError("AF_UNIX path too long")} if the temporary directory (the
@geindex TMPDIR
@geindex variables de entorno; TMPDIR
@code{TMPDIR} environment variable) is too long. Patch by Victor
Stinner.

@item 
gh-93353@footnote{https://github.com/python/cpython/issues/93353}: regrtest now checks if a test leaks temporary files or
directories if run with -jN option. Patch by Victor Stinner.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: @code{run_tests.py} now handles cross compiling env vars correctly
and pass @code{HOSTRUNNER} to regression tests.

@item 
gh-93616@footnote{https://github.com/python/cpython/issues/93616}: @code{test_modulefinder} now creates a temporary directory in
@code{ModuleFinderTest.setUp()} instead of module scope.

@item 
gh-93575@footnote{https://github.com/python/cpython/issues/93575}: Fix issue with test_unicode test_raiseMemError. The test case
now use @code{test.support.calcobjsize} to calculate size of PyUnicode
structs. @ref{1772,,sys.getsizeof()} may return different size when string has
UTF-8 memory.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: WASI does not have a @code{chmod(2)} syscall. @ref{378,,os.chmod()} is
now a dummy function on WASI. Skip all tests that depend on working
@ref{378,,os.chmod()}.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Skip tests on WASI that require symlinks with absolute paths.

@item 
gh-57539@footnote{https://github.com/python/cpython/issues/57539}: Increase calendar test coverage for
@code{calendar.LocaleTextCalendar.formatweekday()}.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Skip symlink tests on WASI. wasmtime uses @code{openat2(2)} with
@code{RESOLVE_BENEATH} flag, which prevents symlinks with absolute paths.

@item 
gh-89858@footnote{https://github.com/python/cpython/issues/89858}: Fix @code{test_embed} for out-of-tree builds. Patch by Kumar
Aditya.

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Fixing tests that fail when running with optimizations (@code{-O})
in @code{test_imaplib.py}.

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Fixing tests that fail when running with optimizations (@code{-O})
in @code{test_zipimport.py}

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Fixing tests that fail when running with optimizations (@code{-O})
in @code{test_py_compile.py}

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Fixing tests that fail when running with optimizations (@code{-O})
in @code{test_sys_settrace.py}.

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: Fixing tests that fail when running with optimizations (@code{-O})
in @code{_test_multiprocessing.py}

@item 
gh-92670@footnote{https://github.com/python/cpython/issues/92670}: Skip @code{test_shutil.TestCopy.test_copyfile_nonexistent_dir} test
on AIX as the test uses a trailing slash to force the OS consider the path
as a directory, but on AIX the trailing slash has no effect and is
considered as a file.

@item 
gh-92514@footnote{https://github.com/python/cpython/issues/92514}: Remove unused @code{test.support.BasicTestRunner}. Patch by Jelle
Zijlstra.

@item 
bpo-47016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47016}: Create a GitHub Actions workflow for verifying bundled pip and
setuptools. Patch by Illia Volochii and Adam Turner.
@end itemize

@node Build<17>,Windows<17>,Tests<16>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id148}@anchor{17f2}
@subsubsection Build



@itemize -

@item 
gh-96761@footnote{https://github.com/python/cpython/issues/96761}: Fix the build process of clang compiler for
@code{_bootstrap_python} if LTO optimization is applied. Patch by
Matthias Görgens and Donghee Na.

@item 
gh-96883@footnote{https://github.com/python/cpython/issues/96883}: @code{wasm32-emscripten} builds for browsers now include
@ref{22,,concurrent.futures} for @ref{b,,asyncio} and @ref{107,,unittest.mock}.

@item 
gh-85936@footnote{https://github.com/python/cpython/issues/85936}: CPython now uses the ThinLTO option as the default policy if the
Clang compiler accepts the flag. Patch by Donghee Na.

@item 
gh-96729@footnote{https://github.com/python/cpython/issues/96729}: Ensure that Windows releases built with
@code{Tools\msi\buildrelease.bat} are upgradable to and from official Python
releases.

@item 
gh-96269@footnote{https://github.com/python/cpython/issues/96269}: Shared module targets now depend on new @code{MODULE_DEPS}
variable, which includes @code{EXPORTSYMS}. This fixes a build order issue on
unsupported AIX platform.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: @code{wasm32-emscripten} platform no longer builds @ref{bc,,resource}
module, @ref{137e,,getresuid()}, @ref{137d,,getresgid()}, and their setters.
The APIs are stubs and not functional.

@item 
gh-95973@footnote{https://github.com/python/cpython/issues/95973}: Add a new @code{--with-dsymutil} configure option to link debug
information in macOS. Patch by Pablo Galindo.

@item 
gh-90536@footnote{https://github.com/python/cpython/issues/90536}: Use the BOLT post-link optimizer to improve performance,
particularly on medium-to-large applications.

@item 
gh-93744@footnote{https://github.com/python/cpython/issues/93744}: Remove the @code{configure --with-cxx-main} build option: it didn’t
work for many years. Remove the @code{MAINCC} variable from @code{configure} and
@code{Makefile}. Patch by Victor Stinner.

@item 
gh-94801@footnote{https://github.com/python/cpython/issues/94801}: Fix a regression in @code{configure} script that caused some header
checks to ignore custom @code{CPPFLAGS}. The regression was introduced in
gh-94802@footnote{https://github.com/python/cpython/issues/94802}.

@item 
gh-95145@footnote{https://github.com/python/cpython/issues/95145}: wasm32-wasi builds no longer depend on WASIX’s pthread stubs.
Python now has its own stubbed pthread API.

@item 
gh-95174@footnote{https://github.com/python/cpython/issues/95174}: Python now detects missing @code{dup} function in WASI and works
around some missing @ref{57,,errno}, @ref{c1,,select}, and @ref{cc,,socket}
constants.

@item 
gh-95174@footnote{https://github.com/python/cpython/issues/95174}: Python now skips missing @ref{cc,,socket} functions and methods on
WASI. WASI can only create sockets from existing fd / accept and has no
netdb.

@item 
gh-95085@footnote{https://github.com/python/cpython/issues/95085}: Platforms @code{wasm32-unknown-emscripten} and
@code{wasm32-unknown-wasi} have been promoted to 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} tier 3 platform
support.

@item 
gh-94847@footnote{https://github.com/python/cpython/issues/94847}: Fixed @code{_decimal} module build issue on GCC when compiling with
LTO and pydebug. Debug builds no longer force inlining of functions.

@item 
gh-94841@footnote{https://github.com/python/cpython/issues/94841}: Fix the possible performance regression of
@ref{ced,,PyObject_Free()} compiled with MSVC version 1932.

@item 
gh-94801@footnote{https://github.com/python/cpython/issues/94801}: @code{configure} now uses custom flags like @code{ZLIB_CFLAGS} and
@code{ZLIB_LIBS} when searching for headers and libraries.

@item 
gh-94773@footnote{https://github.com/python/cpython/issues/94773}: @code{deepfreeze.py} now supports code object with frozensets that
contain incompatible, unsortable types.

@item 
gh-94682@footnote{https://github.com/python/cpython/issues/94682}: Build and test with OpenSSL 1.1.1q

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: Dependencies of @ref{ba,,readline} and @ref{2c,,curses} module are now
detected in @code{configure} script with @code{pkg-config}. Only @code{ncurses} /
@code{ncursesw} are detected automatically. The old @code{curses} library is not
configured automatically. Workaround for missing @code{termcap} or @code{tinfo}
library has been removed.

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: Fix building @code{_ctypes} extension without @code{pkg-config}.

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @code{_dbm} module dependencies are now detected by configure.

@item 
gh-94404@footnote{https://github.com/python/cpython/issues/94404}: @code{makesetup} now works around an issue with sed on macOS and
uses correct CFLAGS for object files that end up in a shared extension.
Module CFLAGS are used before PY_STDMODULE_CFLAGS to avoid clashes with
system headers.

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: C extension modules are now built by @code{configure} and @code{make}
instead of @code{distutils} and @code{setup.py}.

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: The @code{2to3}, @code{idle}, and @code{pydoc} scripts are now generated
and installed by @code{Makefile} instead of @code{setup.py}.

@item 
gh-94280@footnote{https://github.com/python/cpython/issues/94280}: Updated pegen regeneration script on Windows to find and use
Python 3.9 or higher.  Prior to this, pegen regeneration already required
3.9 or higher, but the script may have used lower versions of Python.

@item 
gh-93584@footnote{https://github.com/python/cpython/issues/93584}: Address race condition in @code{Makefile} when installing a PGO
build. All @code{test} and @code{install} targets now depend on @code{all} target.

@item 
gh-93491@footnote{https://github.com/python/cpython/issues/93491}: @code{configure} now detects and reports 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} support tiers.

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: Fix @code{Modules/Setup.stdlib.in} rule for @code{_sqlite3} extension.

@item 
gh-93207@footnote{https://github.com/python/cpython/issues/93207}: @code{va_start()} with two parameters, like @code{va_start(args,
format),} is now required to build Python. @code{va_start()} is no longer
called with a single parameter. Patch by Kumar Aditya.

@item 
gh-93202@footnote{https://github.com/python/cpython/issues/93202}: Python now always use the @code{%zu} and @code{%zd} printf formats to
format a @code{size_t} or @code{Py_ssize_t} number. Building Python 3.12
requires a C11 compiler, so these printf formats are now always supported.
Patch by Victor Stinner.

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Disable pymalloc and increase stack size on @code{wasm32-wasi}.

@item 
bpo-34449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34449}: Drop invalid compiler switch @code{-fPIC} for HP aCC on HP-UX.
Patch by Michael Osipov.
@end itemize

@node Windows<17>,macOS<13>,Build<17>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id149}@anchor{17f3}
@subsubsection Windows



@itemize -

@item 
gh-98360@footnote{https://github.com/python/cpython/issues/98360}: Fixes @ref{94,,multiprocessing} spawning child processes on Windows
from a virtual environment to ensure that child processes that also use
@ref{94,,multiprocessing} to spawn more children will recognize that they are
in a virtual environment.

@item 
gh-98414@footnote{https://github.com/python/cpython/issues/98414}: Fix @code{py.exe} launcher handling of @code{-V:@var{<company>}/}
option when default preferences have been set in environment variables or
configuration files.

@item 
gh-97728@footnote{https://github.com/python/cpython/issues/97728}: Fix possible crashes caused by the use of uninitialized
variables when pass invalid arguments in @ref{149a,,os.system()} on Windows and
in Windows-specific modules (like @code{winreg}).

@item 
gh-90989@footnote{https://github.com/python/cpython/issues/90989}: Made @ref{65f,,Lanzador de Python para Windows} install per-user by default (unless an all
users install already exists), and clarify some text in the installer.

@item 
gh-97649@footnote{https://github.com/python/cpython/issues/97649}: The @code{Tools} directory is no longer installed on Windows

@item 
gh-96965@footnote{https://github.com/python/cpython/issues/96965}: Update libffi to 3.4.3

@item 
gh-96577@footnote{https://github.com/python/cpython/issues/96577}: Fixes a potential buffer overrun in @code{msilib}.

@item 
gh-96559@footnote{https://github.com/python/cpython/issues/96559}: Fixes the Windows launcher not using the compatible
interpretation of default tags found in configuration files when no tag
was passed to the command.

@item 
gh-94781@footnote{https://github.com/python/cpython/issues/94781}: Fix @code{pcbuild.proj} to clean previous instances of output
files in @code{Python\deepfreeze} and @code{Python\frozen_modules} directories
on Windows. Patch by Charlie Zhao.

@item 
gh-89545@footnote{https://github.com/python/cpython/issues/89545}: Updates @ref{aa,,platform} code getting the Windows version to use
native Windows Management Instrumentation (WMI) queries to determine OS
version, type, and architecture.

@item 
gh-95733@footnote{https://github.com/python/cpython/issues/95733}: Make certain requirements of the Windows Store package optional
to allow installing on earlier updates of Windows.

@item 
gh-95656@footnote{https://github.com/python/cpython/issues/95656}: Enable the @ref{8d5,,enable_load_extension()}
@ref{cf,,sqlite3} API.

@item 
gh-95587@footnote{https://github.com/python/cpython/issues/95587}: Fixes some issues where the Windows installer would incorrectly
detect certain features of an existing install when upgrading.

@item 
gh-94399@footnote{https://github.com/python/cpython/issues/94399}: Restores the behaviour of @ref{65f,,Lanzador de Python para Windows} for @code{/usr/bin/env}
shebang lines, which will now search 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} for an executable
matching the given command. If none is found, the usual search process is
used.

@item 
gh-95445@footnote{https://github.com/python/cpython/issues/95445}: Fixes the unsuccessful removal of the HTML document directory
when uninstalling with Windows msi.

@item 
gh-95359@footnote{https://github.com/python/cpython/issues/95359}: Fix @ref{65f,,Lanzador de Python para Windows} handling of @code{py.ini} commands (it was
incorrectly expecting a @code{py_} prefix on keys) and crashes when reading
per-user configuration file.

@item 
gh-95285@footnote{https://github.com/python/cpython/issues/95285}: Fix @ref{65f,,Lanzador de Python para Windows} handling of command lines where it is only
passed a short executable name.

@item 
gh-90844@footnote{https://github.com/python/cpython/issues/90844}: Allow virtual environments to correctly launch when they have
spaces in the path.

@item 
gh-94772@footnote{https://github.com/python/cpython/issues/94772}: Fix incorrect handling of shebang lines in py.exe launcher

@item 
gh-94018@footnote{https://github.com/python/cpython/issues/94018}: @ref{130,,zipfile} will now remove trailing spaces from path
components when extracting files on Windows.

@item 
gh-93824@footnote{https://github.com/python/cpython/issues/93824}: Drag and drop of files onto Python files in Windows Explorer has
been enabled for Windows ARM64.

@item 
gh-43414@footnote{https://github.com/python/cpython/issues/43414}: @ref{1174,,os.get_terminal_size()} now attempts to read the size from
any provided handle, rather than only supporting file descriptors 0, 1 and
2.

@item 
gh-92817@footnote{https://github.com/python/cpython/issues/92817}: Ensures that @code{py.exe} will prefer an active virtual
environment over default tags specified with environment variables or
through a @code{py.ini} file.

@item 
gh-92984@footnote{https://github.com/python/cpython/issues/92984}: Explicitly disable incremental linking for non-Debug builds

@item 
gh-92841@footnote{https://github.com/python/cpython/issues/92841}: @ref{b,,asyncio} no longer throws @code{RuntimeError: Event loop is
closed} on interpreter exit after asynchronous socket activity. Patch by
Oleg Iarygin.

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update Windows installer to use SQLite 3.38.4.

@item 
gh-91061@footnote{https://github.com/python/cpython/issues/91061}: Accept os.PathLike for the argument to winsound.PlaySound

@item 
bpo-42658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42658}: Support native Windows case-insensitive path comparisons by
using @code{LCMapStringEx} instead of @ref{17f4,,str.lower()} in
@code{ntpath.normcase()}. Add @code{LCMapStringEx} to the @code{_winapi}
module.

@item 
bpo-38704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38704}: Prevent installation on unsupported Windows versions.
@end itemize

@node macOS<13>,IDLE<11>,Windows<17>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id150}@anchor{17f5}
@subsubsection macOS



@itemize -

@item 
gh-97897@footnote{https://github.com/python/cpython/issues/97897}: The macOS 13 SDK includes support for the @code{mkfifoat} and
@code{mknodat} system calls. Using the @code{dir_fd} option with either
@ref{e16,,os.mkfifo()} or @ref{e17,,os.mknod()} could result in a segfault if
cpython is built with the macOS 13 SDK but run on an earlier version of
macOS. Prevent this by adding runtime support for detection of these
system calls («weaklinking») as is done for other newer syscalls on macOS.
@end itemize

@node IDLE<11>,Tools/Demos<11>,macOS<13>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id151}@anchor{17f6}
@subsubsection IDLE



@itemize -

@item 
gh-97527@footnote{https://github.com/python/cpython/issues/97527}: Fix a bug in the previous bugfix that caused IDLE to not start
when run with 3.10.8, 3.12.0a1, and at least Microsoft Python 3.10.2288.0
installed without the Lib/test package.  3.11.0 was never affected.

@item 
gh-65802@footnote{https://github.com/python/cpython/issues/65802}: Document handling of extensions in Save As dialogs.

@item 
gh-95191@footnote{https://github.com/python/cpython/issues/95191}: Include prompts when saving Shell (interactive input and
output).

@item 
gh-95511@footnote{https://github.com/python/cpython/issues/95511}: Fix the Shell context menu copy-with-prompts bug of copying an
extra line when one selects whole lines.

@item 
gh-95471@footnote{https://github.com/python/cpython/issues/95471}: In the Edit menu, move @code{Select All} and add a new separator.

@item 
gh-95411@footnote{https://github.com/python/cpython/issues/95411}: Enable using IDLE’s module browser with .pyw files.

@item 
gh-89610@footnote{https://github.com/python/cpython/issues/89610}: Add .pyi as a recognized extension for IDLE on macOS.    This
allows opening stub files by double clicking on them in the Finder.
@end itemize

@node Tools/Demos<11>,C API<16>,IDLE<11>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id152}@anchor{17f7}
@subsubsection Tools/Demos



@itemize -

@item 
gh-68686@footnote{https://github.com/python/cpython/issues/68686}: Remove ptags and eptags scripts.

@item 
gh-97681@footnote{https://github.com/python/cpython/issues/97681}: Remove the @code{Tools/demo/} directory which contained old demo
scripts. A copy can be found in the old-demos project@footnote{https://github.com/gvanrossum/old-demos}.  Patch by Victor Stinner.

@item 
gh-97669@footnote{https://github.com/python/cpython/issues/97669}: Remove outdated example scripts of the @code{Tools/scripts/}
directory. A copy can be found in the old-demos project@footnote{https://github.com/gvanrossum/old-demos}. Patch by Victor Stinner.

@item 
gh-95853@footnote{https://github.com/python/cpython/issues/95853}: The @code{wasm_build.py} script now pre-builds Emscripten ports,
checks for broken EMSDK versions, and warns about pkg-config env vars.

@item 
gh-95853@footnote{https://github.com/python/cpython/issues/95853}: The new tool @code{Tools/wasm/wasm_builder.py} automates configure,
compile, and test steps for building CPython on WebAssembly platforms.

@item 
gh-95731@footnote{https://github.com/python/cpython/issues/95731}: Fix handling of module docstrings in
@code{Tools/i18n/pygettext.py}.

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: Add script @code{Tools/scripts/check_modules.py} to check and
validate builtin and shared extension modules. The script also handles
@code{Modules/Setup} and will eventually replace @code{setup.py}.

@item 
gh-94538@footnote{https://github.com/python/cpython/issues/94538}: Fix Argument Clinic output to custom file destinations. Patch by
Erlend E. Aasland.

@item 
gh-94430@footnote{https://github.com/python/cpython/issues/94430}: Allow parameters named @code{module} and @code{self} with custom C
names in Argument Clinic. Patch by Erlend E. Aasland

@item 
gh-86087@footnote{https://github.com/python/cpython/issues/86087}: The @code{Tools/scripts/parseentities.py} script used to parse
HTML4 entities has been removed.
@end itemize

@node C API<16>,,Tools/Demos<11>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id154}@anchor{17f8}
@subsubsection C API



@itemize -

@item 
gh-98393@footnote{https://github.com/python/cpython/issues/98393}: The @ref{61b,,PyUnicode_FSDecoder()} function no longer accepts
bytes-like paths, like @ref{5e0,,bytearray} and @ref{156,,memoryview} types:
only the exact @ref{325,,bytes} type is accepted for bytes strings. Patch by
Victor Stinner.

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: Add @ref{609,,PyType_Watch()} and related APIs to allow callbacks
on @ref{17f9,,PyType_Modified()}.

@item 
gh-95756@footnote{https://github.com/python/cpython/issues/95756}: Lazily create and cache @code{co_} attributes for better
performance for code getters.

@item 
gh-96512@footnote{https://github.com/python/cpython/issues/96512}: Configuration for the @ref{695,,integer string conversion length limitation} now lives in the PyConfig C API struct.

@item 
gh-95589@footnote{https://github.com/python/cpython/issues/95589}: Extensions classes that set @code{tp_dictoffset} and
@code{tp_weaklistoffset} lose the support for multiple inheritance, but are
now safe. Extension classes should use @ref{45f,,Py_TPFLAGS_MANAGED_DICT}
and @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} instead.

@item 
gh-95781@footnote{https://github.com/python/cpython/issues/95781}: An unrecognized format character in
@ref{47c,,PyUnicode_FromFormat()} and @ref{618,,PyUnicode_FromFormatV()} now
sets a @ref{619,,SystemError}. In previous versions it caused all the rest of
the format string to be copied as-is to the result string, and any extra
arguments discarded.

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: Restore the 3.10 behavior for multiple inheritance of C
extension classes that store their dictionary at the end of the struct.

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: Support C extensions using managed dictionaries by setting the
@code{Py_TPFLAGS_MANAGED_DICT} flag.

@item 
gh-93274@footnote{https://github.com/python/cpython/issues/93274}: API for implementing vectorcall
(@ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL}, @ref{5f8,,PyVectorcall_NARGS()} and
@ref{5f9,,PyVectorcall_Call()}) was added to the limited API and stable ABI.

@item 
gh-95504@footnote{https://github.com/python/cpython/issues/95504}: Fix sign placement when specifying width or precision in
@ref{47c,,PyUnicode_FromFormat()} and @ref{618,,PyUnicode_FromFormatV()}. Patch
by Philip Georgi.

@item 
gh-93012@footnote{https://github.com/python/cpython/issues/93012}: The @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag is now removed
from a class when the class’s @ref{5fb,,__call__()} method is
reassigned. This makes vectorcall safe to use with mutable types (i.e.
heap types without the @code{immutable}
flag). Mutable types that do not override
@ref{5fc,,tp_call} now inherit the
@ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag.

@item 
gh-95388@footnote{https://github.com/python/cpython/issues/95388}: Creating @ref{2a7,,immutable types}
with mutable bases is deprecated and is planned to be disabled in Python
3.14.

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: Adds unstable C-API functions @code{_PyObject_VisitManagedDict} and
@code{_PyObject_ClearManagedDict} to allow C extensions to allow the VM to
manage their object’s dictionaries.

@item 
gh-94936@footnote{https://github.com/python/cpython/issues/94936}: Added @ref{813,,PyCode_GetVarnames()}, @ref{814,,PyCode_GetCellvars()}
and @ref{815,,PyCode_GetFreevars()} for accessing @code{co_varnames},
@code{co_cellvars} and @code{co_freevars} respectively via the C API.

@item 
gh-94930@footnote{https://github.com/python/cpython/issues/94930}: Fix @code{SystemError} raised when
@ref{475,,PyArg_ParseTupleAndKeywords()} is used with @code{#} in @code{(...)} but
without @code{PY_SSIZE_T_CLEAN} defined.

@item 
gh-94731@footnote{https://github.com/python/cpython/issues/94731}: Python again uses C-style casts for most casting operations when
compiled with C++. This may trigger compiler warnings, if they are enabled
with e.g. @code{-Wold-style-cast} or @code{-Wzero-as-null-pointer-constant}
options for @code{g++}.

@item 
gh-93937@footnote{https://github.com/python/cpython/issues/93937}: The following frame functions and type are now directly
available with @code{#include <Python.h>}, it’s no longer needed to add
@code{#include <frameobject.h>}:


@itemize *

@item 
@ref{81e,,PyFrame_Check()}

@item 
@ref{81f,,PyFrame_GetBack()}

@item 
@ref{805,,PyFrame_GetBuiltins()}

@item 
@ref{806,,PyFrame_GetGenerator()}

@item 
@ref{807,,PyFrame_GetGlobals()}

@item 
@ref{808,,PyFrame_GetLasti()}

@item 
@ref{4dd,,PyFrame_GetLocals()}

@item 
@ref{820,,PyFrame_Type}
@end itemize

Patch by Victor Stinner.

@item 
gh-91321@footnote{https://github.com/python/cpython/issues/91321}: Fix the compatibility of the Python C API with C++ older than
C++11. Patch by Victor Stinner.

@item 
gh-91731@footnote{https://github.com/python/cpython/issues/91731}: Avoid defining the @code{static_assert} when compiling with C++ 11,
where this is a keyword and redefining it can lead to undefined behavior.
Patch by Pablo Galindo

@item 
gh-89546@footnote{https://github.com/python/cpython/issues/89546}: @ref{5f3,,PyType_FromMetaclass()} (and other @code{PyType_From*}
functions) now check that offsets and the base class’s
@ref{a19,,tp_basicsize} fit in the new class’s
@code{tp_basicsize}.

@item 
gh-93503@footnote{https://github.com/python/cpython/issues/93503}: Add two new public functions to the public C-API,
@ref{602,,PyEval_SetProfileAllThreads()} and
@ref{603,,PyEval_SetTraceAllThreads()}, that allow to set tracing and
profiling functions in all running threads in addition to the calling one.
Also, two analogous functions to the @ref{ed,,threading} module
(@ref{570,,threading.setprofile_all_threads()} and
@ref{56f,,threading.settrace_all_threads()}) that allow to do the same from
Python. Patch by Pablo Galindo

@item 
gh-93442@footnote{https://github.com/python/cpython/issues/93442}: Add C++ overloads for _Py_CAST_impl() to handle 0/NULL.  This
will allow C++ extensions that pass 0 or NULL to macros using _Py_CAST()
to continue to compile.

@item 
gh-93466@footnote{https://github.com/python/cpython/issues/93466}: Slot IDs in PyType_Spec may not be repeated. The documentation
was updated to mention this. For some cases of repeated slots,
PyType_FromSpec and related functions will now raise an exception.

@item 
gh-92898@footnote{https://github.com/python/cpython/issues/92898}: Fix C++ compiler warnings when casting function arguments to
@code{PyObject*}. Patch by Serge Guelton.

@item 
gh-93103@footnote{https://github.com/python/cpython/issues/93103}: Deprecate global configuration variables, like
@ref{4b9,,Py_IgnoreEnvironmentFlag}, in the documentation: the
@ref{4a6,,Py_InitializeFromConfig()} API should be instead. Patch by Victor
Stinner.

@item 
gh-77782@footnote{https://github.com/python/cpython/issues/77782}: Deprecate global configuration variable like
@ref{4b9,,Py_IgnoreEnvironmentFlag}: the @ref{4a6,,Py_InitializeFromConfig()}
API should be instead. Patch by Victor Stinner.

@item 
gh-92913@footnote{https://github.com/python/cpython/issues/92913}: Ensures changes to @ref{495,,PyConfig.module_search_paths} are
ignored unless @ref{68f,,PyConfig.module_search_paths_set} is set

@item 
gh-92781@footnote{https://github.com/python/cpython/issues/92781}: Avoid mixing declarations and code in the C API to fix the
compiler warning: «ISO C90 forbids mixed declarations and code»
[-Werror=declaration-after-statement]. Patch by Victor Stinner.

@item 
gh-92651@footnote{https://github.com/python/cpython/issues/92651}: Remove the @code{token.h} header file. There was never any public
tokenizer C API. The @code{token.h} header file was only designed to be used
by Python internals. Patch by Victor Stinner.

@item 
gh-92536@footnote{https://github.com/python/cpython/issues/92536}: Remove legacy Unicode APIs based on @code{Py_UNICODE*}.

@item 
gh-85858@footnote{https://github.com/python/cpython/issues/85858}: Remove the @code{PyUnicode_InternImmortal()} function and the
@code{SSTATE_INTERNED_IMMORTAL} macro. Patch by Victor Stinner.

@item 
gh-92193@footnote{https://github.com/python/cpython/issues/92193}: Add new function @ref{604,,PyFunction_SetVectorcall()} to the C API
which sets the vectorcall field of a given @ref{605,,PyFunctionObject}.

Warning: extensions using this API must preserve the behavior of the
unaltered function!

@item 
gh-59121@footnote{https://github.com/python/cpython/issues/59121}: Fixed an assert that prevented @code{PyRun_InteractiveOne} from
providing tracebacks when parsing from the provided FD.

@item 
bpo-45383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45383}: The @ref{621,,PyType_FromSpec()} API will now find and use a
metaclass based on the provided bases. An error will be raised if there is
a metaclass conflict.
@end itemize

@node Python 3 11 0 beta 1,Python 3 11 0 alpha 7,Python 3 12 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-beta-1}@anchor{17fa}
@subsection Python 3.11.0 beta 1


`Release date: 2022-05-06'

@menu
* Security: Security<14>. 
* Core and Builtins: Core and Builtins<18>. 
* Library: Library<18>. 
* Documentation: Documentation<17>. 
* Tests: Tests<17>. 
* Build: Build<18>. 
* Windows: Windows<18>. 
* macOS: macOS<14>. 
* Tools/Demos: Tools/Demos<12>. 
* C API: C API<17>. 

@end menu

@node Security<14>,Core and Builtins<18>,,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id155}@anchor{17fb}
@subsubsection Security



@itemize -

@item 
gh-57684@footnote{https://github.com/python/cpython/issues/57684}: Add the @ref{645,,-P} command line option and the
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH} environment variable to not prepend a potentially
unsafe path to @ref{27e,,sys.path}. Patch by Victor Stinner.
@end itemize

@node Core and Builtins<18>,Library<18>,Security<14>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id156}@anchor{17fc}
@subsubsection Core and Builtins



@itemize -

@item 
gh-89519@footnote{https://github.com/python/cpython/issues/89519}: Chaining classmethod descriptors (introduced in bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}) is
deprecated. It can no longer be used to wrap other descriptors such as
property().  The core design of this feature was flawed, and it caused a
number of downstream problems.

@item 
gh-92345@footnote{https://github.com/python/cpython/issues/92345}: @code{pymain_run_python()} now imports @code{readline} and
@code{rlcompleter} before sys.path is extended to include the current working
directory of an interactive interpreter. Non-interactive interpreters are
not affected.

@item 
bpo-43857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43857}: Improve the @ref{441,,AttributeError} message when deleting a
missing attribute. Patch by Géry Ogam.

@item 
gh-92245@footnote{https://github.com/python/cpython/issues/92245}: Make sure that PEP 523 is respected in all cases. In 3.11a7,
specialization may have prevented Python-to-Python calls respecting PEP
523.

@item 
gh-92203@footnote{https://github.com/python/cpython/issues/92203}: Add a closure keyword-only parameter to @ref{2ea,,exec()}. It can
only be specified when exec-ing a code object that uses free variables.
When specified, it must be a tuple, with exactly the number of cell
variables referenced by the code object. closure has a default value of
@code{None}, and it must be @code{None} if the code object doesn’t refer to any
free variables.

@item 
gh-91173@footnote{https://github.com/python/cpython/issues/91173}: Disable frozen modules in debug builds. Patch by Kumar Aditya.

@item 
gh-92114@footnote{https://github.com/python/cpython/issues/92114}: Improve error message when subscript a type with
@code{__class_getitem__} set to @code{None}.

@item 
gh-92112@footnote{https://github.com/python/cpython/issues/92112}: Fix crash triggered by an evil custom @code{mro()} on a metaclass.

@item 
gh-92063@footnote{https://github.com/python/cpython/issues/92063}: The @code{PRECALL_METHOD_DESCRIPTOR_FAST_WITH_KEYWORDS} instruction
now ensures methods are called only on objects of the correct type.

@item 
gh-92031@footnote{https://github.com/python/cpython/issues/92031}: Deoptimize statically allocated code objects during
@code{Py_FINALIZE()} so that future @code{_PyCode_Quicken} calls always start
with unquickened code.

@item 
gh-92036@footnote{https://github.com/python/cpython/issues/92036}: Fix a crash in subinterpreters related to the garbage collector.
When a subinterpreter is deleted, untrack all objects tracked by its GC.
To prevent a crash in deallocator functions expecting objects to be
tracked by the GC, leak a strong reference to these objects on purpose, so
they are never deleted and their deallocator functions are not called.
Patch by Victor Stinner.

@item 
gh-92032@footnote{https://github.com/python/cpython/issues/92032}: The interpreter can now autocomplete soft keywords, as of now
@code{match}, @code{case}, and @code{_} (wildcard pattern) from 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}.

@item 
gh-87999@footnote{https://github.com/python/cpython/issues/87999}: The warning emitted by the Python parser for a numeric literal
immediately followed by keyword has been changed from deprecation warning
to syntax warning.

@item 
gh-91869@footnote{https://github.com/python/cpython/issues/91869}: Fix an issue where specialized opcodes with extended arguments
could produce incorrect tracing output or lead to assertion failures.

@item 
gh-91603@footnote{https://github.com/python/cpython/issues/91603}: Speed up @ref{6db,,types.UnionType} instantiation. Based on patch
provided by Yurii Karabas.

@item 
gh-89373@footnote{https://github.com/python/cpython/issues/89373}: If Python is built in debug mode, Python now ensures that
deallocator functions leave the current exception unchanged. Patch by
Victor Stinner.

@item 
gh-91632@footnote{https://github.com/python/cpython/issues/91632}: Fix a minor memory leak at exit: release the memory of the
@code{generic_alias_iterator} type. Patch by Donghee Na.

@item 
gh-81548@footnote{https://github.com/python/cpython/issues/81548}: Octal escapes with value larger than @code{0o377} now produce a
@ref{1da,,DeprecationWarning}. In a future Python version they will be a
@ref{511,,SyntaxWarning} and eventually a @ref{150,,SyntaxError}.

@item 
bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}: Use a single compact table for line starts, ends and column
offsets. Reduces memory consumption for location info by half

@item 
gh-91102@footnote{https://github.com/python/cpython/issues/91102}: Use Argument Clinic for @code{EncodingMap}.  Patch by Oleg
Iarygin.

@item 
gh-91636@footnote{https://github.com/python/cpython/issues/91636}: Fixed a crash in a garbage-collection edge-case, in which a
@code{PyFunction_Type.tp_clear} function could leave a python function object
in an inconsistent state.

@item 
gh-91603@footnote{https://github.com/python/cpython/issues/91603}: Speed up @ref{4ef,,isinstance()} and @ref{85a,,issubclass()} checks for
@ref{6db,,types.UnionType}. Patch by Yurii Karabas.

@item 
gh-91625@footnote{https://github.com/python/cpython/issues/91625}: Fixed a bug in which adaptive opcodes ignored any preceding
@code{EXTENDED_ARG}s on specialization failure.

@item 
gh-78607@footnote{https://github.com/python/cpython/issues/78607}: The LLTRACE special build now looks for the name @code{__lltrace__}
defined in module globals, rather than the name @code{__ltrace__}, which had
been introduced as a typo.

@item 
gh-91576@footnote{https://github.com/python/cpython/issues/91576}: Speed up iteration of ascii strings by 50%. Patch by Kumar
Aditya.

@item 
gh-89279@footnote{https://github.com/python/cpython/issues/89279}: Improve interpreter performance on Windows by inlining a few
specific macros.

@item 
gh-91502@footnote{https://github.com/python/cpython/issues/91502}: Add a new @code{_PyFrame_IsEntryFrame()} API function, to
check if a @ref{822,,PyFrameObject} is an entry frame. Patch by Pablo
Galindo.

@item 
gh-91266@footnote{https://github.com/python/cpython/issues/91266}: Refactor the @code{bytearray} strip methods @code{strip}, @code{lstrip}
and @code{rstrip} to use a common implementation.

@item 
gh-91479@footnote{https://github.com/python/cpython/issues/91479}: Replaced the @code{__note__} field of @ref{65c,,BaseException} (added
in an earlier version of 3.11) with the final design of 
@geindex Python Enhancement Proposals; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}.
Namely, @ref{65c,,BaseException} gets an @code{add_note()} method, and its
@code{__notes__} field is created when necessary.

@item 
gh-46055@footnote{https://github.com/python/cpython/issues/46055}: Speed up right shift of negative integers, by removing
unnecessary creation of temporaries. Original patch by Xinhang Xu,
reworked by Mark Dickinson.

@item 
gh-91462@footnote{https://github.com/python/cpython/issues/91462}: Make the interpreter’s low-level tracing (lltrace) feature
output more readable by displaying opcode names (rather than just
numbers), and by displaying stack contents before each opcode.

@item 
gh-89455@footnote{https://github.com/python/cpython/issues/89455}: Fixed an uninitialized bool value in the traceback printing code
path that was introduced by the initial bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292} exception groups work.

@item 
gh-91421@footnote{https://github.com/python/cpython/issues/91421}: Fix a potential integer overflow in _Py_DecodeUTF8Ex.

@item 
gh-91428@footnote{https://github.com/python/cpython/issues/91428}: Add @code{static const char *const _PyOpcode_OpName[256] = @{...@};}
to @code{opcode.h} for debug builds to assist in debugging the Python
interpreter. It is now more convenient to make various forms of debugging
output more human-readable by including opcode names rather than just the
corresponding decimal digits.

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: Make @ref{16f4,,POP_JUMP_IF_TRUE}, @ref{16f5,,POP_JUMP_IF_FALSE},
@ref{17fd,,POP_JUMP_IF_NONE} and @ref{17fe,,POP_JUMP_IF_NOT_NONE} virtual,
mapping to new relative jump opcodes.

@item 
bpo-45317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45317}: Add internal documentation explaining design of new (for 3.11)
frame stack.

@item 
bpo-47197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47197}: ctypes used to mishandle @code{void} return types, so that for
instance a function declared like @code{ctypes.CFUNCTYPE(None, ctypes.c_int)}
would be called with signature @code{int f(int)} instead of @code{void f(int)}.
Wasm targets require function pointers to be called with the correct
signatures so this led to crashes. The problem is now fixed.

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: Make opcodes @code{JUMP_IF_TRUE_OR_POP} and
@code{JUMP_IF_FALSE_OR_POP} relative rather than absolute.

@item 
bpo-47177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47177}: Replace the @code{f_lasti} member of the internal
@code{_PyInterpreterFrame} structure with a @code{prev_instr} pointer, which
reduces overhead in the main interpreter loop. The @code{f_lasti} attribute
of Python-layer frame objects is preserved for backward-compatibility.

@item 
bpo-46961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46961}: Integer mod/remainder operations, including the three-argument
form of @ref{a64,,pow()}, now consistently return ints from the global small
integer cache when applicable.

@item 
bpo-46962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46962}: Classes and functions that unconditionally declared their
docstrings ignoring the @code{--without-doc-strings} compilation flag no
longer do so.

The classes affected are @code{ctypes.UnionType},
@ref{17ff,,pickle.PickleBuffer}, @code{testcapi.RecursingInfinitelyError},
and @ref{882,,types.GenericAlias}.

The functions affected are 24 methods in @ref{2b,,ctypes}.

Patch by Oleg Iarygin.

@item 
bpo-46942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46942}: Use Argument Clinic for the @ref{1800,,types.MethodType}
constructor.  Patch by Oleg Iarygin.

@item 
bpo-46764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46764}: Fix wrapping bound methods with @@classmethod

@item 
bpo-43464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43464}: Optimize @code{set.intersection()} for non-set arguments.

@item 
bpo-46721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46721}: Optimize @code{set.issuperset()} for non-set argument.

@item 
bpo-46509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46509}: Add type-specialized versions of the @code{Py_DECREF()}, and use
them for @code{float}, @code{int}, @code{str}, @code{bool}, and @code{None} to avoid
pointer-chasing at runtime where types are known at C compile time.

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: Do not use POSIX semaphores on NetBSD

@item 
bpo-36819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36819}: Fix crashes in built-in encoders with error handlers that
return position less or equal than the starting position of non-encodable
characters.

@item 
bpo-34093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34093}: @code{marshal.dumps()} uses @code{FLAG_REF} for all interned strings.
This makes output more deterministic and helps reproducible build.

@item 
bpo-26579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26579}: Added @code{object.__getstate__} which provides the default
implementation of the @code{__getstate__()} method.

Copying and pickling instances of subclasses of builtin types bytearray,
set, frozenset, collections.OrderedDict, collections.deque,
weakref.WeakSet, and datetime.tzinfo now copies and pickles instance
attributes implemented as slots.
@end itemize

@node Library<18>,Documentation<17>,Core and Builtins<18>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id157}@anchor{1801}
@subsubsection Library



@itemize -

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: Add the `encoding' parameter to @ref{1c5,,os.popen()}.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Fix an issue where @ref{39,,dis} utilities may interpret populated
inline cache entries as valid instructions.

@item 
gh-92332@footnote{https://github.com/python/cpython/issues/92332}: Deprecate @ref{205,,typing.Text} (removal of the class is
currently not planned). Patch by Alex Waygood.

@item 
Deprecate nested classes in enum definitions becoming members – in 3.13
they will be normal classes; add @code{member} and @code{nonmember} functions to
allow control over results now.

@item 
gh-92356@footnote{https://github.com/python/cpython/issues/92356}: Fixed a performance regression in ctypes function calls.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Show the actual named values stored in inline caches when
@code{show_caches=True} is passed to @ref{39,,dis} utilities.

@item 
gh-92301@footnote{https://github.com/python/cpython/issues/92301}: Prefer @code{close_range()} to iterating over procfs for file
descriptor closing in @ref{d6,,subprocess} for better performance.

@item 
gh-67248@footnote{https://github.com/python/cpython/issues/67248}: Sort the miscellaneous topics in Cmd.do_help()

@item 
gh-92210@footnote{https://github.com/python/cpython/issues/92210}: Port @code{socket.__init__} to Argument Clinic. Patch by Cinder.

@item 
gh-80010@footnote{https://github.com/python/cpython/issues/80010}: Add support for generalized ISO 8601 parsing to
@ref{6b7,,datetime.datetime.fromisoformat()},
@ref{6b5,,datetime.date.fromisoformat()} and
@ref{6b6,,datetime.time.fromisoformat()}. Patch by Paul Ganssle.

@item 
gh-92118@footnote{https://github.com/python/cpython/issues/92118}: Fix a 3.11 regression in @ref{126f,,contextmanager()},
which caused it to propagate exceptions with incorrect tracebacks.

@item 
gh-90887@footnote{https://github.com/python/cpython/issues/90887}: Adding @code{COPYFILE_STAT}, @code{COPYFILE_ACL} and
@code{COPYFILE_XATTR} constants for @code{os.fcopyfile()} available in macOs.

@item 
gh-91215@footnote{https://github.com/python/cpython/issues/91215}: For @ref{32e,,@@dataclass}, add
`weakref_slot'. The new parameter defaults to @code{False}. If true, and if
@code{slots=True}, add a slot named @code{"__weakref__"}, which will allow
instances to be weakref’d. Contributed by Eric V. Smith

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: New function os.login_tty() for Unix.

@item 
gh-92128@footnote{https://github.com/python/cpython/issues/92128}: Add @ref{7d6,,__class_getitem__()} to
@ref{135c,,logging.LoggerAdapter} and @ref{1265,,logging.StreamHandler},
allowing them to be parameterized at runtime. Patch by Alex Waygood.

@item 
gh-92049@footnote{https://github.com/python/cpython/issues/92049}: Forbid pickling constants @code{re._constants.SUCCESS} etc.
Previously, pickling did not fail, but the result could not be unpickled.

@item 
gh-92062@footnote{https://github.com/python/cpython/issues/92062}: @ref{333,,inspect.Parameter} now raises @ref{360,,ValueError} if
@code{name} is a keyword, in addition to the existing check that it is an
identifier.

@item 
gh-87390@footnote{https://github.com/python/cpython/issues/87390}: Add an @code{__unpacked__} attribute to
@ref{882,,types.GenericAlias}. Patch by Jelle Zijlstra.

@item 
gh-88089@footnote{https://github.com/python/cpython/issues/88089}: Add support for generic @ref{1db,,typing.NamedTuple}.

@item 
gh-91996@footnote{https://github.com/python/cpython/issues/91996}: New http.HTTPMethod enum to represent all the available HTTP
request methods in a convenient way

@item 
gh-91984@footnote{https://github.com/python/cpython/issues/91984}: Modified test strings in test_argparse.py to not contain
trailing spaces before end of line.

@item 
gh-91952@footnote{https://github.com/python/cpython/issues/91952}: Add @code{encoding="locale"} support to
@code{TextIOWrapper.reconfigure()}.

@item 
gh-91954@footnote{https://github.com/python/cpython/issues/91954}: Add `encoding' and `errors' arguments to
@ref{1802,,subprocess.getoutput()} and @ref{1041,,subprocess.getstatusoutput()}.

@item 
bpo-47029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47029}: Always close the read end of the pipe used by
@ref{1803,,multiprocessing.Queue} `after' the last write of buffered data to
the write end of the pipe to avoid @ref{10d8,,BrokenPipeError} at garbage
collection and at @ref{1804,,multiprocessing.Queue.close()} calls. Patch by Géry
Ogam.

@item 
gh-91928@footnote{https://github.com/python/cpython/issues/91928}: Add @code{datetime.UTC} alias for @code{datetime.timezone.utc}.

Patch by Kabir Kwatra.

@item 
gh-68966@footnote{https://github.com/python/cpython/issues/68966}: The @code{mailcap} module is now deprecated and will be removed
in Python 3.13. See 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} for the rationale and the @ref{8f,,mimetypes}
module for an alternative. Patch by Victor Stinner.

@item 
gh-91401@footnote{https://github.com/python/cpython/issues/91401}: Provide a way to disable @ref{d6,,subprocess} use of @code{vfork()}
just in case it is ever needed and document the existing mechanism for
@code{posix_spawn()}.

@item 
gh-64783@footnote{https://github.com/python/cpython/issues/64783}: Fix @ref{1805,,signal.NSIG} value on FreeBSD to accept signal
numbers greater than 32, like @code{signal.SIGRTMIN} and
@code{signal.SIGRTMAX}. Patch by Victor Stinner.

@item 
gh-91910@footnote{https://github.com/python/cpython/issues/91910}: Add missing f prefix to f-strings in error messages from the
@ref{94,,multiprocessing} and @ref{b,,asyncio} modules.

@item 
gh-91860@footnote{https://github.com/python/cpython/issues/91860}: Add @ref{57b,,typing.dataclass_transform()}, implementing 
@geindex Python Enhancement Proposals; PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/}.
Patch by Jelle Zijlstra.

@item 
gh-91832@footnote{https://github.com/python/cpython/issues/91832}: Add @code{required} attribute to @ref{1806,,argparse.Action} repr
output.

@item 
gh-91827@footnote{https://github.com/python/cpython/issues/91827}: In the @ref{f0,,tkinter} module add method @code{info_patchlevel()}
which returns the exact version of the Tcl library as a named tuple
similar to @ref{741,,sys.version_info}.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: Add @ref{1807,,--enable-wasm-pthreads} to enable pthreads support
for WASM builds. @code{Emscripten/node} no longer has threading enabled by
default. Include additional file systems.

@item 
gh-91821@footnote{https://github.com/python/cpython/issues/91821}: Fix unstable @code{test_from_tuple} test in @code{test_decimal.py}.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the xdrlib module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the uu module.

@item 
gh-91760@footnote{https://github.com/python/cpython/issues/91760}: More strict rules will be applied for numerical group references
and group names in regular expressions. For now, a deprecation warning is
emitted for group references and group names which will be errors in
future Python versions.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: Add provisional @ref{1808,,sys._emscripten_info} named tuple with
build-time and run-time information about Emscripten platform.

@item 
gh-90623@footnote{https://github.com/python/cpython/issues/90623}: @ref{1809,,signal.raise_signal()} and @ref{13c7,,os.kill()} now check
immediately for pending signals. Patch by Victor Stinner.

@item 
gh-91734@footnote{https://github.com/python/cpython/issues/91734}: Fix OSS audio support on Solaris.

@item 
gh-90633@footnote{https://github.com/python/cpython/issues/90633}: Include the passed value in the exception thrown by
@ref{748,,typing.assert_never()}. Patch by Jelle Zijlstra.

@item 
gh-91700@footnote{https://github.com/python/cpython/issues/91700}: Compilation of regular expression containing a conditional
expression @code{(?(group)...)} now raises an appropriate @code{re.error} if
the group number refers to not defined group. Previously an internal
RuntimeError was raised.

@item 
gh-91231@footnote{https://github.com/python/cpython/issues/91231}: Add an optional keyword `shutdown_timeout' parameter to the
@code{multiprocessing.BaseManager} constructor. Kill the process if
terminate() takes longer than the timeout. Patch by Victor Stinner.

@item 
gh-91621@footnote{https://github.com/python/cpython/issues/91621}: Fix @ref{752,,typing.get_type_hints()} for
@ref{881,,collections.abc.Callable}. Patch by Shantanu Jain.

@item 
gh-90568@footnote{https://github.com/python/cpython/issues/90568}: Parsing @code{\N} escapes of Unicode Named Character Sequences in a
@ref{b9,,regular expression} raises now @code{re.error} instead of
@code{TypeError}.

@item 
gh-91670@footnote{https://github.com/python/cpython/issues/91670}: Remove deprecated @code{SO} config variable in @ref{db,,sysconfig}.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the telnetlib module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the sunau module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the spwd module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the sndhdr module, as well as inline needed
functionality for @code{email.mime.MIMEAudio}.

@item 
gh-91616@footnote{https://github.com/python/cpython/issues/91616}: @ref{b9,,re} module, fix @ref{180a,,fullmatch()} mismatch
when using Atomic Grouping or Possessive Quantifiers.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the “pipes” module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the ossaudiodev module.

@item 
bpo-47256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47256}: @ref{b9,,re} module, limit the maximum capturing group to
1,073,741,823 in 64-bit build, this increases the depth of backtracking.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the nis module.

@item 
gh-91595@footnote{https://github.com/python/cpython/issues/91595}: Fix the comparison of character and integer inside
@code{Tools.gdb.libpython.write_repr()}. Patch by Yu Liu.

@item 
gh-74166@footnote{https://github.com/python/cpython/issues/74166}: Add option to raise all errors from
@ref{713,,create_connection()} in an @ref{31d,,ExceptionGroup} when it
fails to create a connection. The default remains to raise only the last
error that had occurred when multiple addresses were tried.

@item 
gh-91487@footnote{https://github.com/python/cpython/issues/91487}: Optimize asyncio UDP speed, over 100 times faster when
transferring a large file.

@item 
gh-91575@footnote{https://github.com/python/cpython/issues/91575}: Update case-insensitive matching in the @ref{b9,,re} module to the
latest Unicode version.

@item 
gh-90622@footnote{https://github.com/python/cpython/issues/90622}: In @code{concurrent.futures.process.ProcessPoolExecutor} disallow
the «fork» multiprocessing start method when the new
@code{max_tasks_per_child} feature is used as the mix of threads+fork can
hang the child processes. Default to using the safe «spawn» start method
in that circumstance if no @code{mp_context} was supplied.

@item 
gh-89022@footnote{https://github.com/python/cpython/issues/89022}: In @ref{cf,,sqlite3}, @code{SQLITE_MISUSE} result codes are now mapped
to @ref{71e,,InterfaceError} instead of
@ref{223,,ProgrammingError}. Also, more accurate exceptions are
raised when binding parameters fail. Patch by Erlend E. Aasland.

@item 
gh-91526@footnote{https://github.com/python/cpython/issues/91526}: Stop calling @code{os.device_encoding(file.fileno())} in
@code{TextIOWrapper}. It was complex, never documented, and didn’t work
for most cases. (Patch by Inada Naoki.)

@item 
gh-88116@footnote{https://github.com/python/cpython/issues/88116}: Change the frame-related functions in the @ref{7e,,inspect} module
to return a regular object (that is backwards compatible with the old
tuple-like interface) that include the extended 
@geindex Python Enhancement Proposals; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} position
information (end line number, column and end column). The affected
functions are: @ref{6f0,,inspect.getframeinfo()},
@ref{6f1,,inspect.getouterframes()}, @ref{6f2,,inspect.getinnerframes()},
@ref{6f3,,inspect.stack()} and @ref{6f4,,inspect.trace()}. Patch by Pablo Galindo.

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: Add indexing and slicing support to @ref{723,,sqlite3.Blob}. Patch
by Aviv Palivoda and Erlend E. Aasland.

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: Add @ref{675,,context manager} support to @ref{723,,sqlite3.Blob}.
Patch by Aviv Palivoda and Erlend E. Aasland.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate nntplib.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate msilib.

@item 
gh-91404@footnote{https://github.com/python/cpython/issues/91404}: Improve the performance of @ref{b9,,re} matching by using computed
gotos (or «threaded code») on supported platforms and removing expensive
pointer indirections.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the imghdr module.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the crypt module.

@item 
gh-91276@footnote{https://github.com/python/cpython/issues/91276}: Make space for longer opcodes in @ref{39,,dis} output.

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: Make @code{TextIOWrapper} uses locale encoding when
@code{encoding="locale"} is specified even in UTF-8 mode.

@item 
gh-91230@footnote{https://github.com/python/cpython/issues/91230}: @ref{628,,warnings.catch_warnings()} now accepts arguments for
@ref{762,,warnings.simplefilter()}, providing a more concise way to locally
ignore warnings or convert them to errors.

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: Deprecate the chunk module.

@item 
Add the @code{TCP_CONNECTION_INFO} option (available on macOS) to
@ref{cc,,socket}.

@item 
bpo-47260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47260}: Fix @code{os.closerange()} potentially being a no-op in a Linux
seccomp sandbox.

@item 
bpo-47087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47087}: Implement @code{typing.Required} and @code{typing.NotRequired}
(
@geindex Python Enhancement Proposals; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}). Patch by David Foster and Jelle Zijlstra.

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: Deprecate cgi and cgitb.

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: Deprecate audioop.

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: Add @ref{1d3,,locale.getencoding()} to get the current locale
encoding. It is similar to @code{locale.getpreferredencoding(False)} but
ignores the @ref{6f7,,Python UTF-8 Mode}.

@item 
bpo-42012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42012}: Add @ref{11c,,wsgiref.types}, containing WSGI-specific types for
static type checking.

@item 
bpo-47227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47227}: Suppress expression chaining for more @ref{b9,,re} parsing errors.

@item 
bpo-47211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47211}: Remove undocumented and never working function
@code{re.template()} and flag @code{re.TEMPLATE}. This was later reverted in
3.11.0b2 and deprecated instead.

@item 
bpo-47135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47135}: @ref{180b,,decimal.localcontext()} now accepts context attributes via
keyword arguments

@item 
bpo-43323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43323}: Fix errors in the @ref{3c,,email} module if the charset itself
contains undecodable/unencodable characters.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Disassembly of quickened code.

@item 
bpo-46681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46681}: Forward gzip.compress() compresslevel to zlib.

@item 
bpo-45100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45100}: Add @ref{74f,,typing.get_overloads()} and
@ref{750,,typing.clear_overloads()}. Patch by Jelle Zijlstra.

@item 
bpo-44807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44807}: @ref{3bb,,typing.Protocol} no longer silently replaces
@code{__init__()} methods defined on subclasses. Patch by Adrian Garcia
Badaracco.

@item 
bpo-46787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46787}: Fix @ref{163,,concurrent.futures.ProcessPoolExecutor} exception
memory leak

@item 
bpo-46720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46720}: Add support for path-like objects to
@ref{180c,,multiprocessing.set_executable()} for Windows to be on a par with
Unix-like systems. Patch by Géry Ogam.

@item 
bpo-46696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46696}: Add @code{SO_INCOMING_CPU} constant to @ref{cc,,socket}.

@item 
bpo-46053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46053}: Fix OSS audio support on NetBSD.

@item 
bpo-45639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45639}: @code{image/avif} and @code{image/webp} were added to
@ref{8f,,mimetypes}.

@item 
bpo-46285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46285}: Add command-line option @code{-p}/@code{--protocol} to module
@ref{72,,http.server} which specifies the HTTP version to which the server is
conformant (HTTP/1.1 conformant servers can now be run from the
command-line interface of module @ref{72,,http.server}). Patch by Géry Ogam.

@item 
bpo-44791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44791}: Accept ellipsis as the last argument of
@ref{85d,,typing.Concatenate}.

@item 
bpo-46547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46547}: Remove variables leaking into @code{pydoc.Helper} class namespace.

@item 
bpo-46415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46415}: Fix ipaddress.ip_@{address,interface,network@} raising TypeError
instead of ValueError if given invalid tuple as address parameter.

@item 
bpo-46075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46075}: @code{CookieJar} with @code{DefaultCookiePolicy} now can process
cookies from localhost with domain=localhost explicitly specified in
Set-Cookie header.

@item 
bpo-45995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45995}: Add a «z» option to the string formatting specification that
coerces negative zero floating-point values to positive zero after
rounding to the format precision.  Contributed by John Belmonte.

@item 
bpo-26175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26175}: Fully implement the @ref{735,,io.BufferedIOBase} or
@ref{736,,io.TextIOBase} interface for
@ref{734,,tempfile.SpooledTemporaryFile} objects. This lets them work
correctly with higher-level layers (like compression modules). Patch by
Carey Metcalfe.

@item 
bpo-45138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45138}: Fix a regression in the @ref{cf,,sqlite3} trace callback where
bound parameters were not expanded in the passed statement string. The
regression was introduced in Python 3.10 by bpo-40318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40318}. Patch by
Erlend E. Aasland.

@item 
bpo-44863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44863}: Allow @ref{2ce,,TypedDict} subclasses to also include
@ref{15f6,,Generic} as a base class in class based syntax. Thereby
allowing the user to define a generic @code{TypedDict}, just like a
user-defined generic but with @code{TypedDict} semantics.

@item 
bpo-44587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44587}: Fix BooleanOptionalAction to not automatically add a default
string.  If a default string is desired, use a formatter to add it.

@item 
bpo-43827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43827}: All positional-or-keyword parameters to @code{ABCMeta.__new__} are
now positional-only to avoid conflicts with keyword arguments to be passed
to @code{__init_subclass__()}.

@item 
bpo-43218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43218}: Prevent creation of a venv whose path contains the PATH
separator. This could affect the usage of the activate script. Patch by
Dustin Rodrigues.

@item 
bpo-38435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38435}: Add a @code{process_group} parameter to @ref{301,,subprocess.Popen}
to help move more things off of the unsafe @code{preexec_fn} parameter.

@item 
bpo-42066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42066}: Fix cookies getting sorted in @code{CookieJar.__iter__()} which
is an extra behavior and not mentioned in RFC 2965 or Netscape cookie
protocol. Now the cookies in @code{CookieJar} follows the order of the
@code{Set-Cookie} header. Patch by Iman Kermani.

@item 
bpo-40617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40617}: Add @ref{721,,create_window_function()} to
@ref{39e,,sqlite3.Connection} for creating aggregate window functions. Patch
by Erlend E. Aasland.

@item 
bpo-40676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40676}: Convert @ref{2a,,csv} to use Argument Clinic for
@ref{180d,,csv.field_size_limit()}, @ref{180e,,csv.get_dialect()},
@ref{180f,,csv.unregister_dialect()} and @ref{1810,,csv.list_dialects()}.

@item 
bpo-39716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39716}: Raise an @code{ArgumentError} when the same subparser name is
added twice to an @code{argparse.ArgumentParser}.  This is consistent with
the (default) behavior when the same option string is added twice to an
@code{ArgumentParser}.

@item 
bpo-36073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36073}: Raise @ref{223,,ProgrammingError} instead of segfaulting
on recursive usage of cursors in @ref{cf,,sqlite3} converters. Patch by
Sergey Fedoseev.

@item 
bpo-34975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34975}: Adds a @code{start_tls()} method to
@code{StreamWriter}, which upgrades the connection with
TLS using the given @ref{1fa,,SSLContext}.

@item 
bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276}: @ref{19b,,Path} methods @ref{388,,glob()} and
@ref{389,,rglob()} return only directories if `pattern' ends with
a pathname components separator (@code{/} or @ref{70b,,sep}). Patch by
Eisuke Kawashima.

@item 
bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905}: Add @ref{722,,blobopen()} to
@ref{39e,,sqlite3.Connection}. @ref{723,,sqlite3.Blob} allows incremental I/O
operations on blobs. Patch by Aviv Palivoda and Erlend E. Aasland.
@end itemize

@node Documentation<17>,Tests<17>,Library<18>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id158}@anchor{1811}
@subsubsection Documentation



@itemize -

@item 
gh-91888@footnote{https://github.com/python/cpython/issues/91888}: Add a new @code{gh} role to the documentation to link to GitHub
issues.

@item 
gh-91783@footnote{https://github.com/python/cpython/issues/91783}: Document security issues concerning the use of the function
@ref{516,,shutil.unpack_archive()}

@item 
gh-91547@footnote{https://github.com/python/cpython/issues/91547}: Remove «Undocumented modules» page.

@item 
gh-91298@footnote{https://github.com/python/cpython/issues/91298}: In @code{importlib.resources.abc}, refined the documentation of the
Traversable Protocol, applying changes from importlib_resources 5.7.1.

@item 
bpo-44347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44347}: Clarify the meaning of `dirs_exist_ok', a kwarg of
@ref{abb,,shutil.copytree()}.

@item 
bpo-36329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36329}: Remove “make -C Doc serve” in favour of “make -C Doc htmlview”

@item 
bpo-47189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47189}: Add a What’s New in Python 3.11 entry for the Faster CPython
project. Documentation by Ken Jin and Kumar Aditya.

@item 
bpo-38668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38668}: Update the introduction to documentation for @ref{a2,,os.path} to
remove warnings that became irrelevant after the implementations of
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} and 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}.

@item 
bpo-47115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47115}: The documentation now lists which members of C structs are part
of the @ref{5f6,,Limited API/Stable ABI}.

@item 
bpo-46962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46962}: All docstrings in code snippets are now wrapped into
@ref{1812,,PyDoc_STR} to follow the guideline of 
@geindex Python Enhancement Proposals; PEP 0007#documentation-strings
PEP 7’s Documentation Strings paragraph@footnote{https://peps.python.org/pep-0007/#documentation-strings}. Patch by
Oleg Iarygin.

@item 
bpo-26792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26792}: Improve the docstrings of @ref{1813,,runpy.run_module()} and
@ref{2ec,,runpy.run_path()}. Original patch by Andrew Brezovsky.
@end itemize

@node Tests<17>,Build<18>,Documentation<17>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id159}@anchor{1814}
@subsubsection Tests



@itemize -

@item 
gh-92169@footnote{https://github.com/python/cpython/issues/92169}: Use @code{warnings_helper.import_deprecated()} to import deprecated
modules uniformly in tests. Patch by Hugo van Kemenade.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: When multiprocessing is enabled, libregrtest can now use a
Python executable other than @code{sys.executable} via the @code{--python}
flag.

@item 
gh-91904@footnote{https://github.com/python/cpython/issues/91904}: Fix initialization of 
@geindex PYTHONREGRTEST_UNICODE_GUARD
@geindex variables de entorno; PYTHONREGRTEST_UNICODE_GUARD
@code{PYTHONREGRTEST_UNICODE_GUARD}
which prevented running regression tests on non-UTF-8 locale.

@item 
gh-91752@footnote{https://github.com/python/cpython/issues/91752}: Added @@requires_zlib to test.test_tools.test_freeze.TestFreeze.

@item 
gh-91607@footnote{https://github.com/python/cpython/issues/91607}: Fix @code{test_concurrent_futures} to test the correct
multiprocessing start method context in several cases where the test logic
mixed this up.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Threading tests are now skipped on WASM targets without pthread
support.

@item 
bpo-47109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47109}: Test for @code{ctypes.macholib.dyld},
@code{ctypes.macholib.dylib}, and @code{ctypes.macholib.framework} are
brought from manual pre-@ref{106,,unittest} times to @code{ctypes.test}
location and structure. Patch by Oleg Iarygin.

@item 
bpo-29890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29890}: Add tests for @ref{1815,,ipaddress.IPv4Interface} and
@ref{1816,,ipaddress.IPv6Interface} construction with tuple arguments.
Original patch and tests by louisom.
@end itemize

@node Build<18>,Windows<18>,Tests<17>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id160}@anchor{1817}
@subsubsection Build



@itemize -

@item 
gh-89452@footnote{https://github.com/python/cpython/issues/89452}: gdbm-compat is now preferred over ndbm if both are available on
the system. This allows avoiding the problematic ndbm.h on macOS.

@item 
gh-91731@footnote{https://github.com/python/cpython/issues/91731}: Python is now built with @code{-std=c11} compiler option, rather
than @code{-std=c99}. Patch by Victor Stinner.

@item 
bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}: Add script and make target for generating @code{sre_constants.h}.

@item 
bpo-47103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47103}: Windows @code{PGInstrument} builds now copy a required DLL into
the output directory, making it easier to run the profile stage of a PGO
build.
@end itemize

@node Windows<18>,macOS<14>,Build<18>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id161}@anchor{1818}
@subsubsection Windows



@itemize -

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update Windows installer to use SQLite 3.38.3.

@item 
bpo-47239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47239}: Fixed –list and –list-paths output for @ref{65f,,Lanzador de Python para Windows} when
used in an active virtual environment.

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update Windows installer to use SQLite 3.38.2.

@item 
bpo-46785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46785}: Fix race condition between @ref{548,,os.stat()} and unlinking a file
on Windows, by using errors codes returned by @code{FindFirstFileW()} when
appropriate in @code{win32_xstat_impl}.

@item 
bpo-40859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40859}: Update Windows build to use xz-5.2.5
@end itemize

@node macOS<14>,Tools/Demos<12>,Windows<18>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id162}@anchor{1819}
@subsubsection macOS



@itemize -

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update macOS installer to SQLite 3.38.4.
@end itemize

@node Tools/Demos<12>,C API<17>,macOS<14>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id163}@anchor{181a}
@subsubsection Tools/Demos



@itemize -

@item 
gh-91583@footnote{https://github.com/python/cpython/issues/91583}: Fix regression in the code generated by Argument Clinic for
functions with the @code{defining_class} parameter.

@item 
gh-91575@footnote{https://github.com/python/cpython/issues/91575}: Add script @code{Tools/scripts/generate_re_casefix.py} and the make
target @code{regen-re} for generating additional data for case-insensitive
matching according to the current Unicode version.

@item 
gh-91551@footnote{https://github.com/python/cpython/issues/91551}: Remove the ancient Pynche color editor.  It has moved to
@indicateurl{https://gitlab.com/warsaw/pynche}
@end itemize

@node C API<17>,,Tools/Demos<12>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id164}@anchor{181b}
@subsubsection C API



@itemize -

@item 
gh-88279@footnote{https://github.com/python/cpython/issues/88279}: Deprecate the C functions: @code{PySys_SetArgv()},
@code{PySys_SetArgvEx()}, @code{PySys_SetPath()}. Patch by Victor
Stinner.

@item 
gh-92154@footnote{https://github.com/python/cpython/issues/92154}: Added the @ref{812,,PyCode_GetCode()} function. This function does
the equivalent of the Python code @code{getattr(code_object, 'co_code')}.

@item 
gh-92173@footnote{https://github.com/python/cpython/issues/92173}: Fix the @code{closure} argument to @ref{1771,,PyEval_EvalCodeEx()}.

@item 
gh-91320@footnote{https://github.com/python/cpython/issues/91320}: Fix C++ compiler warnings about «old-style cast» (@code{g++
-Wold-style-cast}) in the Python C API. Use C++ @code{reinterpret_cast<>}
and @code{static_cast<>} casts when the Python C API is used in C++. Patch by
Victor Stinner.

@item 
gh-80527@footnote{https://github.com/python/cpython/issues/80527}: Mark functions as deprecated by 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}:
@code{PyUnicode_AS_DATA()}, @code{PyUnicode_AS_UNICODE()},
@code{PyUnicode_GET_DATA_SIZE()}, @code{PyUnicode_GET_SIZE()}. Patch
by Victor Stinner.

@item 
gh-91768@footnote{https://github.com/python/cpython/issues/91768}: @ref{26f,,Py_REFCNT()}, @ref{26e,,Py_TYPE()}, @ref{81b,,Py_SIZE()} and
@ref{181c,,Py_IS_TYPE()} functions argument type is now @code{PyObject*}, rather
than @code{const PyObject*}. Patch by Victor Stinner.

@item 
gh-91020@footnote{https://github.com/python/cpython/issues/91020}: Add @code{PyBytes_Type.tp_alloc} to initialize
@code{PyBytesObject.ob_shash} for bytes subclasses.

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: Add @code{PyFrame_GetLasti} C-API function to access frame
object’s @code{f_lasti} attribute safely from C code.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: Remove the @code{Include/code.h} header file. C extensions should
only include the main @code{<Python.h>} header file. Patch by Victor Stinner.

@item 
bpo-47169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47169}: @ref{181d,,PyOS_CheckStack()} is now exported in the Stable ABI on
Windows.

@item 
bpo-47169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47169}: @code{PyThread_get_thread_native_id()} is excluded from the
stable ABI on platforms where it doesn’t exist (like Solaris).

@item 
bpo-46343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46343}: Added @ref{809,,PyErr_GetHandledException()} and
@ref{80a,,PyErr_SetHandledException()} as simpler alternatives to
@ref{80c,,PyErr_GetExcInfo()} and @ref{80b,,PyErr_SetExcInfo()}.

They are included in the stable ABI.
@end itemize

@node Python 3 11 0 alpha 7,Python 3 11 0 alpha 6,Python 3 11 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-7}@anchor{181e}
@subsection Python 3.11.0 alpha 7


`Release date: 2022-04-05'

@menu
* Core and Builtins: Core and Builtins<19>. 
* Library: Library<19>. 
* Documentation: Documentation<18>. 
* Tests: Tests<18>. 
* Build: Build<19>. 
* Windows: Windows<19>. 
* macOS: macOS<15>. 
* Tools/Demos: Tools/Demos<13>. 
* C API: C API<18>. 

@end menu

@node Core and Builtins<19>,Library<19>,,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id165}@anchor{181f}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-47212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47212}: Raise @ref{841,,IndentationError} instead of @ref{150,,SyntaxError} for
a bare @code{except} with no following indent. Improve @ref{150,,SyntaxError}
locations for an un-parenthesized generator used as arguments. Patch by
Matthieu Dartiailh.

@item 
bpo-47186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47186}: Replace @code{JUMP_IF_NOT_EG_MATCH} by
@ref{7a2,,CHECK_EG_MATCH} + jump.

@item 
bpo-47176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47176}: Emscripten builds cannot handle signals in the usual way due to
platform limitations. Python can now handle signals. To use, set
Module.Py_EmscriptenSignalBuffer to be a single byte SharedArrayBuffer and
set Py_EMSCRIPTEN_SIGNAL_HANDLING to 1. Writing a number into the
SharedArrayBuffer will cause the corresponding signal to be raised into
the Python thread.

@item 
bpo-47186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47186}: Replace @code{JUMP_IF_NOT_EXC_MATCH} by
@ref{7ab,,CHECK_EXC_MATCH} + jump.

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: Replace the absolute jump opcode @ref{1820,,JUMP_NO_INTERRUPT} by
the relative @ref{79f,,JUMP_BACKWARD_NO_INTERRUPT}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Avoid unnecessary allocations when comparing code objects.

@item 
bpo-47182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47182}: Fix a crash when using a named unicode character like
@code{"\N@{digit nine@}"} after the main interpreter has been initialized a
second time.

@item 
bpo-47162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47162}: WebAssembly cannot deal with bad function pointer casts
(different count or types of arguments). Python can now use call
trampolines to mitigate the problem. Define @code{PY_CALL_TRAMPOLINE}
to enable call trampolines.

@item 
bpo-46775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46775}: Some Windows system error codes(>= 10000) are now mapped into
the correct errno and may now raise a subclass of @ref{4d5,,OSError}. Patch by
Donghee Na.

@item 
bpo-47129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47129}: Improve error messages in f-string syntax errors concerning
empty expressions.

@item 
bpo-47117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47117}: Fix a crash if we fail to decode characters in interactive mode
if the tokenizer buffers are uninitialized. Patch by Pablo Galindo.

@item 
bpo-47127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47127}: Speed up calls to c functions with keyword arguments by 25%
with specialization. Patch by Kumar Aditya.

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: Replaced @code{JUMP_ABSOLUTE} by the relative jump
@ref{7ac,,JUMP_BACKWARD}.

@item 
bpo-42197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42197}: @code{PyFrame_FastToLocalsWithError()} and
@code{PyFrame_LocalsToFast()} are no longer called during profiling nor
tracing. C code can access the @code{f_locals} attribute of
@ref{822,,PyFrameObject} by calling @ref{4dd,,PyFrame_GetLocals()}.

@item 
bpo-47070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47070}: Improve performance of @code{array_inplace_repeat} by reducing the
number of invocations of @code{memcpy}. Refactor the @code{repeat} and inplace
@code{repeat} methods of @code{array}, @code{bytes}, @code{bytearray} and
@code{unicodeobject} to use the common @code{_PyBytes_Repeat}.

@item 
bpo-47053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47053}: Reduce de-optimization in the specialized
@code{BINARY_OP_INPLACE_ADD_UNICODE} opcode.

@item 
bpo-47045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47045}: Remove the @code{f_state} field from the _PyInterpreterFrame
struct. Add the @code{owner} field to the _PyInterpreterFrame struct to make
ownership explicit to simplify clearing and deallocing frames and
generators.

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: Check for the existence of the «sys/auxv.h» header in
@ref{58,,faulthandler} to avoid compilation problems in systems where this
header doesn’t exist. Patch by Pablo Galindo

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: Use low bit of @code{LOAD_GLOBAL} to indicate whether to push a
@code{NULL} before the global. Helps streamline the call sequence a bit.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Quicken bytecode in-place by storing it as part of the
corresponding @code{PyCodeObject}.

@item 
bpo-47012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47012}: Speed up iteration of @ref{325,,bytes} and @ref{5e0,,bytearray} by
30%. Patch by Kumar Aditya.

@item 
bpo-47009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47009}: Improved the performance of @code{list.append()} and list
comprehensions by optimizing for the common case, where no resize is
needed. Patch by Dennis Sweeney.

@item 
bpo-47005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47005}: Improve performance of @code{bytearray_repeat} and
@code{bytearray_irepeat} by reducing the number of invocations of @code{memcpy}.

@item 
bpo-46829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46829}: Deprecate passing a message into @ref{1821,,asyncio.Future.cancel()}
and @ref{31e,,asyncio.Task.cancel()}

@item 
bpo-46993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46993}: Speed up @ref{5e0,,bytearray} creation from @ref{18e,,list} and
@ref{464,,tuple} by 40%. Patch by Kumar Aditya.

@item 
bpo-39829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39829}: Removed the @code{__len__()} call when initializing a list and
moved initializing to @code{list_extend}. Patch by Jeremiah Pascual.

@item 
bpo-46944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46944}: Speed up throwing exception in generator with
@ref{1633,,METH_FASTCALL} calling convention. Patch by Kumar Aditya.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Modify @ref{1822,,STORE_SUBSCR} to use an inline cache entry
(rather than its oparg) as an adaptive counter.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline caching for @code{PRECALL} and @ref{7a7,,CALL},
and remove the internal machinery for managing the (now unused) non-inline
caches.

@item 
bpo-46881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46881}: Statically allocate and initialize the latin1 characters.

@item 
bpo-46838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46838}: Improve syntax errors for incorrect function definitions. Patch
by Pablo Galindo

@item 
bpo-43721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43721}: Fix docstrings of @ref{1665,,getter},
@ref{1666,,setter}, and @ref{1667,,deleter} to clarify that
they create a new copy of the property.

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: Make grammar changes required for PEP 646.
@end itemize

@node Library<19>,Documentation<18>,Core and Builtins<19>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id166}@anchor{1823}
@subsubsection Library



@itemize -

@item 
bpo-47208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47208}: Allow vendors to override @code{CTYPES_MAX_ARGCOUNT}.

@item 
bpo-23689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23689}: @ref{b9,,re} module: fix memory leak when a match is terminated by
a signal or memory allocation failure. Patch by Ma Lin.

@item 
bpo-47167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47167}: Allow overriding a future compliance check in
@ref{580,,asyncio.Task}.

@item 
bpo-47151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47151}: When subprocess tries to use vfork, it now falls back to fork
if vfork returns an error. This allows use in situations where vfork isn’t
allowed by the OS kernel.

@item 
bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}: Convert the @ref{b9,,re} module into a package. Deprecate modules
@code{sre_compile}, @code{sre_constants} and @code{sre_parse}.

@item 
bpo-4833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4833}: Add @code{ZipFile.mkdir()}

@item 
bpo-27929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27929}: Fix @ref{e4f,,asyncio.loop.sock_connect()} to only resolve names for
@ref{1824,,socket.AF_INET} or @ref{1825,,socket.AF_INET6} families. Resolution
may not make sense for other families, like @code{socket.AF_BLUETOOTH}
and @ref{1826,,socket.AF_UNIX}.

@item 
bpo-14265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14265}: Adds the fully qualified test name to unittest output

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: Deprecate the aifc module.

@item 
bpo-39622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39622}: Handle Ctrl+C in asyncio programs to interrupt the main task.

@item 
bpo-47101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47101}: @ref{13d4,,hashlib.algorithms_available} now lists only algorithms
that are provided by activated crypto providers on OpenSSL 3.0. Legacy
algorithms are not listed unless the legacy provider has been loaded into
the default OSSL context.

@item 
bpo-47099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47099}: All @code{URLError} exception messages raised in
@ref{208,,urllib.request.URLopener} now contain a colon between @code{ftp
error} and the rest of the message. Previously,
@code{open_ftp()} missed the colon. Patch by Oleg
Iarygin.

@item 
bpo-47099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47099}: Exception chaining is changed from
@code{Exception.with_traceback()}/@ref{72b,,sys.exc_info()} to 
@geindex Python Enhancement Proposals; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}.
Patch by Oleg Iarygin.

@item 
bpo-47095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47095}: @ref{68,,hashlib}’s internal @code{_blake2} module now prefers
@code{libb2} from @indicateurl{https://www.blake2.net/} over Python’s vendored copy of
blake2.

@item 
bpo-47098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47098}: The Keccak Code Package for @ref{68,,hashlib}’s internal @code{_sha3}
module has been replaced with tiny_sha3. The module is used as fallback
when Python is built without OpenSSL.

@item 
bpo-47088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47088}: Implement @ref{66b,,typing.LiteralString}, part of 
@geindex Python Enhancement Proposals; PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/}.
Patch by Jelle Zijlstra.

@item 
bpo-42885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42885}: Optimize @ref{1299,,re.search()}, @ref{3f1,,re.split()},
@ref{10a6,,re.findall()}, @ref{153a,,re.finditer()} and @ref{3f2,,re.sub()} for regular
expressions starting with @code{\A} or @code{^}.

@item 
bpo-23691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23691}: Protect the @ref{153a,,re.finditer()} iterator from re-entering.

@item 
bpo-47067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47067}: Optimize calling @code{GenericAlias} objects by using 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} and by replacing @code{PyObject_SetAttrString} with
@code{PyObject_SetAttr}.

@item 
bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080}: Add the `metadata_encoding' parameter in the
@ref{765,,zipfile.ZipFile} constructor and the @code{--metadata-encoding}
option in the @ref{130,,zipfile} CLI to allow reading zipfiles using
non-standard codecs to encode the filenames within the archive.

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: Make @ref{16d0,,io.text_encoding()} returns «utf-8» when UTF-8 mode
is enabled.

@item 
bpo-42369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42369}: Fix thread safety of @code{zipfile._SharedFile.tell()} to avoid
a «zipfile.BadZipFile: Bad CRC-32 for file» exception when reading a
@code{ZipFile} from multiple threads.

@item 
bpo-38256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38256}: Fix @ref{16a0,,binascii.crc32()} when it is compiled to use zlib’c
crc32 to work properly on inputs 4+GiB in length instead of returning the
wrong result. The workaround prior to this was to always feed the function
data in increments smaller than 4GiB or to just call the zlib module
function.

We also have @ref{16a0,,binascii.crc32()} release the GIL when computing on
larger inputs as @ref{169f,,zlib.crc32()} and @ref{68,,hashlib} do.

This also boosts performance on Windows as it now uses the zlib crc32
implementation for @ref{16a0,,binascii.crc32()} for a 2-3x speedup.

That the stdlib has a crc32 API in two modules is a known historical
oddity. This moves us closer to a single implementation behind them.

@item 
bpo-47066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47066}: Global inline flags (e.g. @code{(?i)}) can now only be used at the
start of the regular expressions.  Using them not at the start of
expression was deprecated since Python 3.6.

@item 
bpo-39394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39394}: A warning about inline flags not at the start of the regular
expression now contains the position of the flag.

@item 
bpo-433030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433030}: Add support of atomic grouping (@code{(?>...)}) and possessive
quantifiers (@code{*+}, @code{++}, @code{?+}, @code{@{m,n@}+}) in @ref{b9,,regular expressions}.

@item 
bpo-47062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47062}: Implement @ref{6a1,,asyncio.Runner} context manager.

@item 
bpo-46382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46382}: @ref{32e,,dataclass()} @code{slots=True} now correctly
omits slots already defined in base classes. Patch by Arie Bovenberg.

@item 
bpo-47057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47057}: Use FASTCALL convention for @code{FutureIter.throw()}

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: Deprecate the various modules listed by 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}:

aifc, asynchat, asyncore, audioop, cgi, cgitb, chunk, crypt, imghdr,
msilib, nntplib, nis, ossaudiodev, pipes, smtpd, sndhdr, spwd, sunau,
telnetlib, uu, xdrlib

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: Remove passing coroutine objects to @ref{528,,asyncio.wait()}.

@item 
bpo-47039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47039}: Normalize @code{repr()} of asyncio future and task objects.

@item 
bpo-2604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2604}: Fix bug where doctests using globals would fail when run
multiple times.

@item 
bpo-45150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45150}: Add @ref{6e5,,hashlib.file_digest()} helper for efficient hashing of
file object.

@item 
bpo-34861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34861}: Made cumtime the default sorting key for cProfile

@item 
bpo-45997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45997}: Fix @ref{b03,,asyncio.Semaphore} re-aquiring FIFO order.

@item 
bpo-47022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47022}: The @code{asynchat}, @code{asyncore} and  @code{smtpd}
modules have been deprecated since at least Python 3.6. Their
documentation and deprecation warnings and have now been updated to note
they will removed in Python 3.12 (
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}).

@item 
bpo-43253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43253}: Fix a crash when closing transports where the underlying socket
handle is already invalid on the Proactor event loop.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @ref{e26,,select.select()} now passes @code{NULL} to @code{select} for
each empty fdset.

@item 
bpo-47004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47004}: Apply bugfixes from importlib_metadata 4.11.3, including bugfix
for EntryPoint.extras, which was returning match objects and not the
extras strings.

@item 
bpo-46998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46998}: Allow subclassing of @ref{74d,,typing.Any}. Patch by Shantanu
Jain.

@item 
bpo-46995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46995}: Deprecate missing @ref{a6f,,asyncio.Task.set_name()} for third-party
task implementations, schedule making it mandatory in Python 3.13.

@item 
bpo-46994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46994}: Accept explicit contextvars.Context in
@ref{69d,,asyncio.create_task()} and @ref{a6e,,asyncio.loop.create_task()}.

@item 
bpo-46981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46981}: @code{typing.get_args(typing.Tuple[()])} now returns @code{()}
instead of @code{((),)}.

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: Add @code{os.sysconf_names['SC_MINSIGSTKSZ']}.

@item 
bpo-46985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46985}: Upgrade pip wheel bundled with ensurepip (pip 22.0.4)

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: @ref{58,,faulthandler}: On Linux 5.14 and newer, dynamically
determine size of signal handler stack size CPython allocates using
@code{getauxval(AT_MINSIGSTKSZ)}. This changes allows for Python extension’s
request to Linux kernel to use AMX_TILE instruction set on Sapphire Rapids
Xeon processor to succeed, unblocking use of the ISA in frameworks.

@item 
bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}: The @ref{704,,math.nan} value is now always available. Patch by
Victor Stinner.

@item 
bpo-46955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46955}: Expose @code{asyncio.base_events.Server} as
@ref{b9d,,asyncio.Server}. Patch by Stefan Zabka.

@item 
bpo-23325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23325}: The @ref{c6,,signal} module no longer assumes that
@ref{1827,,SIG_IGN} and @ref{1828,,SIG_DFL} are small int
singletons.

@item 
bpo-46932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46932}: Update bundled libexpat to 2.4.7

@item 
bpo-46933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46933}: The @ref{b2,,pwd} module is now optional.
@ref{aa6,,os.path.expanduser()} returns the path when the @ref{b2,,pwd} module is
not available.

@item 
bpo-40059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40059}: 
@geindex Python Enhancement Proposals; PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/}, the @ref{fc,,tomllib} module. Adds support for parsing
TOML.

@item 
bpo-464471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=464471}: @ref{69f,,asyncio.timeout()} and @ref{1829,,asyncio.timeout_at()} context
managers added. Patch by Tin Tvrtković and Andrew Svetlov.

@item 
bpo-46805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46805}: Added raw datagram socket functions for asyncio:
@code{sock_sendto()},
@code{sock_recvfrom()} and
@code{sock_recvfrom_into()}.

@item 
bpo-46644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46644}: No longer require valid typeforms to be callable. This allows
@ref{9d0,,typing.Annotated} to wrap @ref{85f,,typing.ParamSpecArgs} and
@code{dataclasses.InitVar}. Patch by Gregory Beauregard.

@item 
bpo-46581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46581}: Brings @code{ParamSpec} propagation for @code{GenericAlias}
in line with @code{Concatenate} (and others).

@item 
bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}: Define `posix_venv' and `nt_venv' @ref{730,,sysconfig installation schemes} to be used for bootstrapping new virtual
environments. Add `venv' sysconfig installation scheme to get the
appropriate one of the above. The schemes are identical to the
pre-existing `posix_prefix' and `nt' install schemes. The @ref{111,,venv}
module now uses the `venv' scheme to create new virtual environments
instead of hardcoding the paths depending only on the platform. Downstream
Python distributors customizing the `posix_prefix' or `nt' install scheme
in a way that is not compatible with the install scheme used in virtual
environments are encouraged not to customize the `venv' schemes. When
Python itself runs in a virtual environment,
@ref{182a,,sysconfig.get_default_scheme()} and
@ref{731,,sysconfig.get_preferred_scheme()} with @code{key="prefix"} returns
`venv'.

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: Implement support for PEP 646 in typing.py.

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: Allow unpacking types.GenericAlias objects, e.g. @code{*tuple[int,
str]}.

@item 
bpo-46557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46557}: Warnings captured by the logging module are now logged without
a format string to prevent systems that group logs by the msg argument
from grouping captured warnings together.

@item 
bpo-41370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41370}: @ref{752,,typing.get_type_hints()} now supports evaluating strings
as forward references in @ref{753,,PEP 585 generic aliases}.

@item 
bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607}: Add @ref{1da,,DeprecationWarning} to @code{LegacyInterpolation},
deprecated in the docstring since Python 3.2. Will be removed in Python
3.13. Use @code{BasicInterpolation} or @code{ExtendedInterpolation}
instead.

@item 
bpo-26120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26120}: @ref{b5,,pydoc} now excludes __future__ imports from the module’s
data items.

@item 
bpo-46480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46480}: Add @ref{74c,,typing.assert_type()}. Patch by Jelle Zijlstra.

@item 
bpo-46421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46421}: Fix a unittest issue where if the command was invoked as
@code{python -m unittest} and the filename(s) began with a dot (.), a
@code{ValueError} is returned.

@item 
bpo-46245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46245}: Add optional parameter `dir_fd' in @ref{1f9,,shutil.rmtree()}.

@item 
bpo-22859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22859}: @code{unittest.TestProgram.usageExit()} is marked as
deprecated, to be removed in Python 3.13.

@item 
bpo-46170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46170}: Improve the error message when you try to subclass an instance
of @ref{d7c,,typing.NewType}.

@item 
bpo-40296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40296}: Fix supporting generic aliases in @ref{b5,,pydoc}.

@item 
bpo-20392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20392}: Fix inconsistency with uppercase file extensions in
@code{MimeTypes.guess_type()}. Patch by Kumar Aditya.

@item 
bpo-46030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46030}: Add @code{LOCAL_CREDS}, @code{LOCAL_CREDS_PERSISTENT} and
@code{SCM_CREDS2} FreeBSD constants to the socket module.

@item 
bpo-44439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44439}: Fix @code{.write()} method of a member file in @code{ZipFile}, when
the input data is an object that supports the buffer protocol, the file
length may be wrong.

@item 
bpo-45171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45171}: Fix handling of the @code{stacklevel} argument to logging
functions in the @ref{87,,logging} module so that it is consistent across all
logging functions and, as advertised, similar to the @code{stacklevel}
argument used in @ref{155a,,warn()}.

@item 
bpo-24959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24959}: Fix bug where @ref{106,,unittest} sometimes drops frames from
tracebacks of exceptions raised in tests.

@item 
bpo-44859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44859}: Raise more accurate and 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} compatible exceptions in
@ref{cf,,sqlite3}.


@itemize *

@item 
Raise @ref{71e,,InterfaceError} instead of
@ref{223,,ProgrammingError} for @code{SQLITE_MISUSE} errors.

@item 
Don’t overwrite @ref{182b,,BufferError} with @ref{360,,ValueError} when conversion to
BLOB fails.

@item 
Raise @ref{223,,ProgrammingError} instead of @ref{182c,,Warning} if
user tries to @ref{400,,execute()} more than one SQL statement.

@item 
Raise @ref{223,,ProgrammingError} instead of @ref{360,,ValueError} if an SQL
query contains null characters.
@end itemize

@item 
bpo-44493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44493}: Add missing terminated NUL in sockaddr_un’s length

This was potentially observable when using non-abstract AF_UNIX datagram
sockets to processes written in another programming language.

@item 
bpo-41930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41930}: Add @ref{71f,,serialize()} and
@ref{720,,deserialize()} support to @ref{cf,,sqlite3}. Patch
by Erlend E. Aasland.

@item 
bpo-33178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33178}: Added @ref{182d,,ctypes.BigEndianUnion} and
@ref{182e,,ctypes.LittleEndianUnion} classes, as originally documented in the
library docs but not yet implemented.

@item 
bpo-43352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43352}: Add an Barrier object in synchronization primitives of
`asyncio' Lib in order to be consistent with Barrier from `threading' and
`multiprocessing' libs*

@item 
bpo-35859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35859}: @ref{b9,,re} module, fix a few bugs about capturing group. In rare
cases, capturing group gets an incorrect string. Patch by Ma Lin.
@end itemize

@node Documentation<18>,Tests<18>,Library<19>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id167}@anchor{182f}
@subsubsection Documentation



@itemize -

@item 
bpo-45099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45099}: Document internal @ref{b,,asyncio} API.

@item 
bpo-47126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47126}: Update PEP URLs to 
@geindex Python Enhancement Proposals; PEP 676
PEP 676@footnote{https://peps.python.org/pep-0676/}’s new canonical form.

@item 
bpo-47040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47040}: Clarified the old Python versions compatibility note of
@ref{16a0,,binascii.crc32()} / @ref{1830,,zlib.adler32()} / @ref{169f,,zlib.crc32()}
functions.

@item 
bpo-46033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46033}: Clarify @code{for} statement execution in its doc.

@item 
bpo-45790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45790}: Adjust inaccurate phrasing in
@ref{1831,,Definición de tipos de extensión; Tutorial} about the @code{ob_base} field and the
macros used to access its contents.

@item 
bpo-42340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42340}: Document that in some circumstances @ref{a63,,KeyboardInterrupt}
may cause the code to enter an inconsistent state. Provided a sample
workaround to avoid it if needed.

@item 
bpo-41233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41233}: Link the errnos referenced in @code{Doc/library/exceptions.rst} to
their respective section in @code{Doc/library/errno.rst}, and vice versa.
Previously this was only done for EINTR and InterruptedError. Patch by Yan
«yyyyyyyan» Orestes.
@end itemize

@node Tests<18>,Build<19>,Documentation<18>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id168}@anchor{1832}
@subsubsection Tests



@itemize -

@item 
bpo-47205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47205}: Skip test for @ref{117c,,sched_getaffinity()} and
@ref{1180,,sched_setaffinity()} error case on FreeBSD.

@item 
bpo-46126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46126}: Restore “descriptions” when running tests internally.

@item 
bpo-47104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47104}: Rewrite @ref{97f,,asyncio.to_thread()} tests to use
@ref{206,,unittest.IsolatedAsyncioTestCase}.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: The test suite is now passing on the Emscripten platform. All
fork, socket, and subprocess-based tests are skipped.

@item 
bpo-47037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47037}: Skip @code{strftime("%4Y")} feature test on Windows. It can cause
an assertion error in debug builds.

@item 
bpo-46587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46587}: Skip tests if platform’s @code{strftime} does not support
non-portable glibc extensions.

@item 
bpo-47015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47015}: A test case for @ref{b9a,,os.sendfile()} is converted from
deprecated @code{asyncore} (see 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}) to @ref{b,,asyncio}. Patch by
Oleg Iarygin.
@end itemize

@node Build<19>,Windows<19>,Tests<18>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id169}@anchor{1833}
@subsubsection Build



@itemize -

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Add configure option @ref{1834,,--enable-wasm-dynamic-linking} to
enable @code{dlopen} and MAIN_MODULE / SIDE_MODULE on @code{wasm32-emscripten}.

@item 
bpo-46023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46023}: @code{makesetup} now detects and skips all duplicated module
definitions. The first entry wins.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Add SOABI @code{wasm32-emscripten} for Emscripten and
@code{wasm32-wasi} for WASI on 32bit WASM as well as @code{wasm64} counter
parts.

@item 
bpo-47032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47032}: Ensure Windows install builds fail correctly with a non-zero
exit code when part of the build fails.

@item 
bpo-47024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47024}: Update OpenSSL to 1.1.1n for macOS installers and all Windows
builds.

@item 
bpo-46996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46996}: The @ref{f0,,tkinter} package now requires Tcl/Tk version 8.5.12
or newer.

@item 
bpo-46973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46973}: Add @code{regen-configure} make target to regenerate configure
script with Christian’s container image
@code{quay.io/tiran/cpython_autoconf:269}.

@item 
bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}: Building Python now requires support of IEEE 754 floating-point
numbers. Patch by Victor Stinner.

@item 
bpo-45774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45774}: @code{configure} now verifies that all SQLite C APIs needed for
the @ref{cf,,sqlite3} extension module are found.
@end itemize

@node Windows<19>,macOS<15>,Build<19>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id170}@anchor{1835}
@subsubsection Windows



@itemize -

@item 
bpo-47194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47194}: Update @code{zlib} to v1.2.12 to resolve 
@geindex Common Vulnerabilities and Exposures; CVE 2018-25032
CVE 2018-25032@footnote{https://www.cve.org/CVERecord?id=CVE-2018-25032}.

@item 
bpo-47171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47171}: Enables installing the @code{py.exe} launcher on Windows
ARM64.

@item 
bpo-46566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46566}: Upgraded @ref{65f,,Lanzador de Python para Windows} to support a new @code{-V:company/tag}
argument for full 
@geindex Python Enhancement Proposals; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} support and to detect ARM64 installs. The
@code{-64} suffix on arguments is deprecated, but still selects any
non-32-bit install. Setting 
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex variables de entorno; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} and
specifying a version that is not installed will attempt to install the
requested version from the Microsoft Store.

@item 
bpo-47086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47086}: The installer for Windows now includes documentation as loose
HTML files rather than a single compiled @code{.chm} file.

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update Windows installer to use SQLite 3.38.1.

@item 
bpo-44549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44549}: Update bzip2 to 1.0.8 in Windows builds to mitigate
@geindex Common Vulnerabilities and Exposures; CVE 2016-3189
CVE 2016-3189@footnote{https://www.cve.org/CVERecord?id=CVE-2016-3189} and 
@geindex Common Vulnerabilities and Exposures; CVE 2019-12900
CVE 2019-12900@footnote{https://www.cve.org/CVERecord?id=CVE-2019-12900}.

@item 
bpo-46948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46948}: Prevent 
@geindex Common Vulnerabilities and Exposures; CVE 2022-26488
CVE 2022-26488@footnote{https://www.cve.org/CVERecord?id=CVE-2022-26488} by ensuring the Add to PATH option in
the Windows installer uses the correct path when being repaired.
@end itemize

@node macOS<15>,Tools/Demos<13>,Windows<19>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id171}@anchor{1836}
@subsubsection macOS



@itemize -

@item 
bpo-46890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46890}: Fix a regression in the setting of @code{sys._base_executable} in
framework builds, and thereby fix a regression in @ref{111,,venv} virtual
environments with such builds.

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: Update macOS installer to SQLite 3.38.1.
@end itemize

@node Tools/Demos<13>,C API<18>,macOS<15>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id172}@anchor{1837}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Replace Emscripten’s limited shell with Katie Bell’s browser-ui
REPL from python-wasm project.
@end itemize

@node C API<18>,,Tools/Demos<13>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id173}@anchor{1838}
@subsubsection C API



@itemize -

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: Add @code{PyFrame_GetBuiltins}, @code{PyFrame_GetGenerator} and
@code{PyFrame_GetGlobals} C-API functions to access frame object attributes
safely from C code.

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: Move the private @code{_PyFrameEvalFunction} type, and private
@code{_PyInterpreterState_GetEvalFrameFunc()} and
@code{_PyInterpreterState_SetEvalFrameFunc()} functions to the internal C
API. The @code{_PyFrameEvalFunction} callback function type now uses the
@code{_PyInterpreterFrame} type which is part of the internal C API. Patch by
Victor Stinner.

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: Move the private undocumented @code{_PyEval_EvalFrameDefault()}
function to the internal C API. The function now uses the
@code{_PyInterpreterFrame} type which is part of the internal C API. Patch by
Victor Stinner.

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: Remove the private undocumented function
@code{_PyEval_CallTracing()} from the C API. Call the public
@ref{1839,,sys.call_tracing()} function instead. Patch by Victor Stinner.

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: Remove the private undocumented function
@code{_PyEval_GetCoroutineOriginTrackingDepth()} from the C API. Call the
public @ref{c13,,sys.get_coroutine_origin_tracking_depth()} function instead.
Patch by Victor Stinner.

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: Remove the following private undocumented functions from the C
API:


@itemize *

@item 
@code{_PyEval_GetAsyncGenFirstiter()}

@item 
@code{_PyEval_GetAsyncGenFinalizer()}

@item 
@code{_PyEval_SetAsyncGenFirstiter()}

@item 
@code{_PyEval_SetAsyncGenFinalizer()}
@end itemize

Call the public @ref{183a,,sys.get_asyncgen_hooks()} and
@ref{1632,,sys.set_asyncgen_hooks()} functions instead. Patch by Victor Stinner.

@item 
bpo-46987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46987}: Remove private functions @code{_PySys_GetObjectId()} and
@code{_PySys_SetObjectId()}. Patch by Donghee Na.

@item 
bpo-46906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46906}: Add new functions to pack and unpack C double (serialize and
deserialize): @ref{7ff,,PyFloat_Pack2()}, @ref{800,,PyFloat_Pack4()},
@ref{801,,PyFloat_Pack8()}, @ref{802,,PyFloat_Unpack2()},
@ref{803,,PyFloat_Unpack4()} and @ref{804,,PyFloat_Unpack8()}. Patch by Victor
Stinner.
@end itemize

@node Python 3 11 0 alpha 6,Python 3 11 0 alpha 5,Python 3 11 0 alpha 7,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-6}@anchor{183b}
@subsection Python 3.11.0 alpha 6


`Release date: 2022-03-07'

@menu
* Core and Builtins: Core and Builtins<20>. 
* Library: Library<20>. 
* Documentation: Documentation<19>. 
* Tests: Tests<19>. 
* Build: Build<20>. 
* Windows: Windows<20>. 
* IDLE: IDLE<12>. 
* C API: C API<19>. 

@end menu

@node Core and Builtins<20>,Library<20>,,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id174}@anchor{183c}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-46940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46940}: Avoid overriding @ref{441,,AttributeError} metadata information for
nested attribute access calls. Patch by Pablo Galindo.

@item 
bpo-46927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46927}: Include the type’s name in the error message for subscripting
non-generic types.

@item 
bpo-46921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46921}: Support vectorcall for @code{super()}. Patch by Ken Jin.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Fix incorrect handling of inline cache entries when
specializing @ref{7a6,,BINARY_OP}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use an oparg to simplify the construction of helpful error
messages in @ref{183d,,GET_AWAITABLE}.

@item 
bpo-46903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46903}: Make sure that str subclasses can be used as attribute names
for instances with virtual dictionaries. Fixes regression in 3.11alpha

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Add more detailed specialization failure stats for
@ref{9fb,,COMPARE_OP} followed by @ref{17ad,,EXTENDED_ARG}.

@item 
bpo-46891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46891}: Fix bug introduced during 3.11alpha where subclasses of
@code{types.ModuleType} with @code{__slots__} were not initialized correctly,
resulting in an interpreter crash.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline caching for @ref{585,,LOAD_ATTR},
@ref{ca7,,LOAD_METHOD}, and @ref{183e,,STORE_ATTR}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline cache for @ref{1747,,BINARY_SUBSCR}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline caching for @ref{9fb,,COMPARE_OP}.

@item 
bpo-46864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46864}: Deprecate @code{PyBytesObject.ob_shash}. It will be removed in
Python 3.13.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline caching for @ref{183f,,UNPACK_SEQUENCE}.

@item 
bpo-46845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46845}: Reduces dict size by removing hash value from hash table when
all inserted keys are Unicode. For example,
@code{sys.getsizeof(dict.fromkeys("abcdefg"))} becomes 272 bytes from 352
bytes on 64bit platform.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline cache for @ref{16f0,,LOAD_GLOBAL}.

@item 
bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}: Rename the private undocumented @code{float.__set_format__()}
method to @code{float.__setformat__()} to fix a typo introduced in Python
3.7. The method is only used by test_float. Patch by Victor Stinner.

@item 
bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}: Remove the undocumented private @code{float.__set_format__()}
method, previously known as @code{float.__setformat__()} in Python 3.7. Its
docstring said: «You probably don’t want to use this function. It exists
mainly to be used in Python’s test suite.» Patch by Victor Stinner.

@item 
bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}: Fix regression that dict.update(other) may don’t respect
iterate order of other when other is key sharing dict.

@item 
bpo-46712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46712}: Share global string identifiers in deep-frozen modules.

@item 
bpo-46430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46430}: Fix memory leak in interned strings of deep-frozen modules.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Store @ref{7a6,,BINARY_OP} caches inline using a new
@ref{799,,CACHE} instruction.

@item 
bpo-45107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45107}: Specialize @code{LOAD_METHOD} for instances with a dict.

@item 
bpo-44337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44337}: Reduce the memory usage of specialized @ref{585,,LOAD_ATTR} and
@ref{183e,,STORE_ATTR} instructions.

@item 
bpo-46729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46729}: Add number of sub-exceptions to @code{BaseException.__str__()}.

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: Don’t un-adapt @ref{9fb,,COMPARE_OP} when collecting
specialization stats.

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: Fix specialization stats gathering for @code{PRECALL}
instructions.

@item 
bpo-46794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46794}: Bump up the libexpat version into 2.4.6

@item 
bpo-46823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46823}: Implement a specialized combined opcode
@code{LOAD_FAST__LOAD_ATTR_INSTANCE_VALUE}.  Patch by Dennis Sweeney.

@item 
bpo-46820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46820}: Fix parsing a numeric literal immediately (without spaces)
followed by «not in» keywords, like in @code{1not in x}. Now the parser only
emits a warning, not a syntax error.

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: Move @code{KW_NAMES} before @code{PRECALL} instruction in call
sequence. Change @code{operand} of @code{CALL} to match @code{PRECALL} for easier
specialization.

@item 
bpo-46808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46808}: Remove the @code{NEXT_BLOCK} macro from compile.c, and make the
compiler automatically generate implicit blocks when they are needed.

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: Add @code{PUSH_NULL} instruction. This is used as a prefix when
evaluating a callable, so that the stack has the same shape for methods
and other calls. @code{PRECALL_FUNCTION} and @code{PRECALL_METHOD} are merged
into a single @code{PRECALL} instruction.

There is no change in semantics.

@item 
bpo-46762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46762}: Fix an assert failure in debug builds when a “<”, “>”, or “=”
is the last character in an f-string that’s missing a closing right brace.

@item 
bpo-46730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46730}: Message of AttributeError caused by getting, setting or
deleting a property without the corresponding function now mentions that
the attribute is in fact a property and also specifies type of the class
that it belongs to.

@item 
bpo-46724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46724}: Make sure that all backwards jumps use the @code{JUMP_ABSOLUTE}
instruction, rather than @code{JUMP_FORWARD} with an argument of
@code{(2**32)+offset}.

@item 
bpo-46732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46732}: Correct the docstring for the @ref{133d,,__bool__()} method.
Patch by Jelle Zijlstra.

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: Add more detailed specialization failure statistics for
@ref{7a6,,BINARY_OP}.

@item 
bpo-46707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46707}: Avoid potential exponential backtracking when producing some
syntax errors involving lots of brackets. Patch by Pablo Galindo.

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: @ref{2b,,ctypes} now allocates memory on the stack instead of on
the heap to pass arguments while calling a Python callback function. Patch
by Donghee Na.

@item 
bpo-45923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45923}: Add a quickened form of @ref{408,,RESUME} that skips quickening
checks.

@item 
bpo-46702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46702}: Specialize @ref{183f,,UNPACK_SEQUENCE} for @ref{464,,tuple} and
@ref{18e,,list} unpackings.

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: Opcode pair stats are now gathered with @code{--enable-pystats}.
Defining @code{DYNAMIC_EXECUTION_PROFILE} or  @code{DXPAIRS} no longer has any
effect.

@item 
bpo-46675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46675}: Allow more than 16 items in a split dict before it is combined.
The limit is now 254.

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: Add a missing call to @code{va_end()} in
@code{Modules/_hashopenssl.c}.

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: Use @ref{5ff,,PyObject_Vectorcall()} while calling ctypes callback
function. Patch by Donghee Na.

@item 
bpo-46615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46615}: When iterating over sets internally in @code{setobject.c}, acquire
strong references to the resulting items from the set.  This prevents
crashes in corner-cases of various set operations where the set gets
mutated.

@item 
bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}: The bytecode compiler now attempts to apply runtime stack
manipulations at compile-time (whenever it is feasible to do so).

@item 
bpo-30496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30496}: Fixed a minor portability issue in the implementation of
@ref{1840,,PyLong_FromLong()}, and added a fast path for single-digit integers
to @ref{1841,,PyLong_FromLongLong()}.
@end itemize

@node Library<20>,Documentation<19>,Core and Builtins<20>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id175}@anchor{1842}
@subsubsection Library



@itemize -

@item 
bpo-25707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25707}: Fixed a file leak in @ref{3ca,,xml.etree.ElementTree.iterparse()}
when the iterator is not exhausted. Patch by Jacob Walls.

@item 
bpo-46877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46877}: Export @ref{1843,,unittest.doModuleCleanups()} in @ref{106,,unittest}.
Patch by Kumar Aditya.

@item 
bpo-46848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46848}: For performance, use the optimized string-searching
implementations from @ref{1844,,find()} and @ref{1845,,rfind()} for
@code{find()} and @code{rfind()}.

@item 
bpo-46736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46736}: @ref{bcb,,SimpleHTTPRequestHandler} now uses HTML5
grammar. Patch by Donghee Na.

@item 
bpo-44886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44886}: Inherit asyncio proactor datagram transport from
@ref{17b4,,asyncio.DatagramTransport}.

@item 
bpo-46827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46827}: Support UDP sockets in  @ref{e4f,,asyncio.loop.sock_connect()} for
selector-based event loops.  Patch by Thomas Grainger.

@item 
bpo-46811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46811}: Make test suite support Expat >=2.4.5

@item 
bpo-46252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46252}: Raise @ref{228,,TypeError} if @ref{981,,ssl.SSLSocket} is passed to
transport-based APIs.

@item 
bpo-46784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46784}: Fix libexpat symbols collisions with user dynamically loaded or
statically linked libexpat in embedded Python.

@item 
bpo-46786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46786}: The HTML serialisation in xml.etree.ElementTree now writes
@code{embed}, @code{source}, @code{track} and @code{wbr} as empty tags, as defined in
HTML 5.

@item 
bpo-39327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39327}: @ref{1f9,,shutil.rmtree()} can now work with VirtualBox shared
folders when running from the guest operating-system.

@item 
bpo-45390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45390}: Propagate @ref{31f,,asyncio.CancelledError} message from inner task
to outer awaiter.

@item 
bpo-46756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46756}: Fix a bug in
@ref{1846,,urllib.request.HTTPPasswordMgr.find_user_password()} and
@ref{1847,,urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated()} which
allowed to bypass authorization. For example, access to URI
@code{example.org/foobar} was allowed if the user was authorized for URI
@code{example.org/foo}.

@item 
bpo-46737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46737}: @ref{1848,,random.gauss()} and @ref{1849,,random.normalvariate()} now have
default arguments.

@item 
bpo-46752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46752}: Add task groups to asyncio (structured concurrency, inspired by
Trio’s nurseries). This also introduces a change to task cancellation,
where a cancelled task can’t be cancelled again until it calls
.uncancel().

@item 
bpo-46724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46724}: Fix @ref{39,,dis} behavior on negative jump offsets.

@item 
bpo-46333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46333}: The @code{__repr__()} method of @ref{184a,,typing.ForwardRef} now
includes the @code{module} parameter of @ref{184a,,typing.ForwardRef} when it is
set.

@item 
bpo-46643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46643}: In @ref{752,,typing.get_type_hints()}, support evaluating
stringified @code{ParamSpecArgs} and @code{ParamSpecKwargs} annotations. Patch
by Gregory Beauregard.

@item 
bpo-45863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45863}: When the @ref{de,,tarfile} module creates a pax format archive, it
will put an integer representation of timestamps in the ustar header (if
possible) for the benefit of older unarchivers, in addition to the
existing full-precision timestamps in the pax extended header.

@item 
bpo-46066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46066}: Deprecate kwargs-based syntax for @ref{2ce,,typing.TypedDict}
definitions. It had confusing semantics when specifying totality, and was
largely unused. Patch by Jingchen Ye.

@item 
bpo-46676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46676}: Make @ref{2ca,,typing.ParamSpec} args and kwargs equal to
themselves. Patch by Gregory Beauregard.

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: @code{ctypes.CFUNCTYPE()} and @code{ctypes.WINFUNCTYPE()} now fail to
create the type if its @code{_argtypes_} member contains too many arguments.
Previously, the error was only raised when calling a function. Patch by
Victor Stinner.

@item 
bpo-46672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46672}: Fix @code{NameError} in @ref{69e,,asyncio.gather()} when initial type
check fails.

@item 
bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}: The @ref{7df,,calendar.LocaleTextCalendar} and
@ref{7e0,,calendar.LocaleHTMLCalendar} classes now use
@ref{1d1,,locale.getlocale()}, instead of using
@ref{1d0,,locale.getdefaultlocale()}, if no locale is specified. Patch by
Victor Stinner.

@item 
bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}: The @ref{1d0,,locale.getdefaultlocale()} function is deprecated and
will be removed in Python 3.13. Use @ref{1d2,,locale.setlocale()},
@ref{5dc,,locale.getpreferredencoding(False)}
and @ref{1d1,,locale.getlocale()} functions instead.  Patch by Victor Stinner.

@item 
bpo-46655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46655}: In @ref{752,,typing.get_type_hints()}, support evaluating bare
stringified @code{TypeAlias} annotations. Patch by Gregory Beauregard.

@item 
bpo-45948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45948}: Fixed a discrepancy in the C implementation of the
@ref{125,,xml.etree.ElementTree} module. Now, instantiating an
@ref{ae5,,xml.etree.ElementTree.XMLParser} with a @code{target=None} keyword
provides a default @ref{ae6,,xml.etree.ElementTree.TreeBuilder} target as
the Python implementation does.

@item 
bpo-46626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46626}: Expose Linux’s @code{IP_BIND_ADDRESS_NO_PORT} option in
@ref{cc,,socket}.

@item 
bpo-46521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46521}: Fix a bug in the @ref{1d,,codeop} module that was incorrectly
identifying invalid code involving string quotes as valid code.

@item 
bpo-46571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46571}: Improve @ref{755,,typing.no_type_check()}.

Now it does not modify external classes and functions. We also now
correctly mark classmethods as not to be type checked.

@item 
bpo-46400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46400}: expat: Update libexpat from 2.4.1 to 2.4.4

@item 
bpo-46556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46556}: Deprecate undocumented support for using a
@ref{19b,,pathlib.Path} object as a context manager.

@item 
bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534}: Implement 
@geindex Python Enhancement Proposals; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} @ref{668,,typing.Self}. Patch by James
Hilton-Balfe.

@item 
bpo-46522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46522}: Make various module @code{__getattr__} AttributeErrors more
closely match a typical AttributeError

@item 
bpo-46475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46475}: Add @ref{749,,typing.Never} and @ref{748,,typing.assert_never()}. Patch
by Jelle Zijlstra.

@item 
bpo-46333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46333}: The @code{__eq__()} and @code{__hash__()} methods of
@ref{184a,,typing.ForwardRef} now honor the @code{module} parameter of
@ref{184a,,typing.ForwardRef}. Forward references from different modules are
now differentiated.

@item 
bpo-46246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46246}: Add missing @code{__slots__} to
@code{importlib.metadata.DeprecatedList}. Patch by Arie Bovenberg.

@item 
bpo-46232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46232}: The @ref{d0,,ssl} module now handles certificates with bit strings
in DN correctly.

@item 
bpo-46195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46195}: @ref{752,,typing.get_type_hints()} no longer adds @code{Optional} to
parameters with @code{None} as a default. This aligns to changes to PEP 484
in @indicateurl{https://github.com/python/peps/pull/689}

@item 
bpo-31369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31369}: Add @ref{6ce,,RegexFlag} to @code{re.__all__} and documented it.
Add @code{NOFLAG} to indicate no flags being set.

@item 
bpo-45898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45898}: @ref{2b,,ctypes} no longer defines @code{ffi_type_*} symbols in
@code{cfield.c}. The symbols have been provided by libffi for over a decade.

@item 
bpo-44953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44953}: Calling @code{operator.itemgetter} objects and
@code{operator.attrgetter} objects is now faster due to use of the vectorcall
calling convention.

@item 
bpo-44289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44289}: Fix an issue with @ref{184b,,is_tarfile()} method when using
`fileobj' argument: position in the `fileobj' was advanced forward which
made it unreadable with @ref{184c,,tarfile.TarFile.open()}.

@item 
bpo-44011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44011}: Reimplement SSL/TLS support in asyncio, borrow the
implementation from uvloop library.

@item 
bpo-41086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41086}: Make the @ref{32b,,configparser.ConfigParser} constructor raise
@ref{228,,TypeError} if the @code{interpolation} parameter is not of type
@code{configparser.Interpolation}

@item 
bpo-29418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29418}: Implement @ref{6eb,,inspect.ismethodwrapper()} and fix
@ref{184d,,inspect.isroutine()} for cases where methodwrapper is given. Patch by
Hakan Çelik.

@item 
bpo-14156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14156}: argparse.FileType now supports an argument of “-” in binary
mode, returning the .buffer attribute of sys.stdin/sys.stdout as
appropriate. Modes including “x” and “a” are treated equivalently to “w”
when argument is “-”. Patch contributed by Josh Rosenberg
@end itemize

@node Documentation<19>,Tests<19>,Library<20>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id176}@anchor{184e}
@subsubsection Documentation



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: @code{Doc/tools/rstlint.py} has moved to its own repository and is
now packaged on PyPI as @code{sphinx-lint}.
@end itemize

@node Tests<19>,Build<20>,Documentation<19>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id177}@anchor{184f}
@subsubsection Tests



@itemize -

@item 
bpo-46913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46913}: Fix test_faulthandler.test_sigfpe() if Python is built with
undefined behavior sanitizer (UBSAN): disable UBSAN on the
faulthandler_sigfpe() function. Patch by Victor Stinner.

@item 
bpo-46760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46760}: Remove bytecode offsets from expected values in test.test_dis
module. Reduces the obstacles to modifying the VM or compiler.

@item 
bpo-46708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46708}: Prevent default asyncio event loop policy modification warning
after @code{test_asyncio} execution.

@item 
bpo-46678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46678}: The function @code{make_legacy_pyc} in
@code{Lib/test/support/import_helper.py} no longer fails when
@code{PYTHONPYCACHEPREFIX} is set to a directory on a different device from
where tempfiles are stored.

@item 
bpo-46623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46623}: Skip test_pair() and test_speech128() of test_zlib on s390x
since they fail if zlib uses the s390x hardware accelerator. Patch by
Victor Stinner.
@end itemize

@node Build<20>,Windows<20>,Tests<19>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id178}@anchor{1850}
@subsubsection Build



@itemize -

@item 
bpo-46860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46860}: Respect @code{--with-suffix} when building on case-insensitive
file systems.

@item 
bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}: Building Python now requires a C11 compiler. Optional C11
features are not required. Patch by Victor Stinner.

@item 
bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}: Building Python now requires support for floating-point
Not-a-Number (NaN): remove the @code{Py_NO_NAN} macro. Patch by Victor
Stinner.

@item 
bpo-46640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46640}: Building Python now requires a C99 @code{<math.h>} header file
providing a @code{NAN} constant, or the @code{__builtin_nan()} built-in
function. Patch by Victor Stinner.

@item 
bpo-46608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46608}: Exclude marshalled-frozen data if deep-freezing to save 300 KB
disk space. This includes adding a new @code{is_package} field to
@ref{80f,,_frozen}. Patch by Kumar Aditya.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Fix wasm32-emscripten test failures and platform issues. -
Disable syscalls that are not supported or don’t work, e.g.   wait,
getrusage, prlimit, mkfifo, mknod, setres[gu]id, setgroups. - Use fd_count
to count open fds. - Add more checks for subprocess and fork. - Add
workarounds for missing _multiprocessing and failing socket.accept(). -
Enable bzip2. - Disable large file support. - Disable signal.alarm.

@item 
bpo-46430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46430}: Intern strings in deep-frozen modules. Patch by Kumar Aditya.
@end itemize

@node Windows<20>,IDLE<12>,Build<20>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id179}@anchor{1851}
@subsubsection Windows



@itemize -

@item 
bpo-46744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46744}: The default all users install directory for ARM64 is now under
the native @code{Program Files} folder, rather than @code{Program Files (Arm)}
which is intended for ARM (32-bit) files.

@item 
bpo-46567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46567}: Adds Tcl and Tk support for Windows ARM64. This also adds IDLE
to the installation.

@item 
bpo-46638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46638}: Ensures registry virtualization is consistently disabled. For
3.10 and earlier, it remains enabled (some registry writes are protected),
while for 3.11 and later it is disabled (registry modifications affect all
applications).
@end itemize

@node IDLE<12>,C API<19>,Windows<20>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id180}@anchor{1852}
@subsubsection IDLE



@itemize -

@item 
bpo-46630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46630}: Make query dialogs on Windows start with a cursor in the entry
box.

@item 
bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}: Apply IDLE syntax highlighting to @code{.pyi} files. Patch by Alex
Waygood and Terry Jan Reedy.
@end itemize

@node C API<19>,,IDLE<12>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id181}@anchor{1853}
@subsubsection C API



@itemize -

@item 
bpo-46748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46748}: Python’s public headers no longer import @code{<stdbool.h>},
leaving code that embeds/extends Python free to define @code{bool}, @code{true}
and @code{false}.

@item 
bpo-46836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46836}: Move the @ref{822,,PyFrameObject} type definition (@code{struct
_frame}) to the internal C API @code{pycore_frame.h} header file. Patch by
Victor Stinner.

@item 
bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}: Rename @code{Include/buffer.h} header file to
@code{Include/pybuffer.h} to avoid conflicts with projects having an existing
@code{buffer.h} header file. Patch by Victor Stinner.

@item 
bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}: Remove the @code{HAVE_PY_SET_53BIT_PRECISION} macro (moved to the
internal C API). Patch by Victor Stinner.

@item 
bpo-46613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46613}: Added function @ref{486,,PyType_GetModuleByDef()}, which allows
access to module state when a method’s defining class is not available.
@end itemize

@node Python 3 11 0 alpha 5,Python 3 11 0 alpha 4,Python 3 11 0 alpha 6,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-5}@anchor{1854}
@subsection Python 3.11.0 alpha 5


`Release date: 2022-02-03'

@menu
* Core and Builtins: Core and Builtins<21>. 
* Library: Library<21>. 
* Documentation: Documentation<20>. 
* Tests: Tests<20>. 
* Build: Build<21>. 
* Windows: Windows<21>. 
* macOS: macOS<16>. 
* IDLE: IDLE<13>. 
* C API: C API<20>. 

@end menu

@node Core and Builtins<21>,Library<21>,,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id182}@anchor{1855}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-45773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45773}: Remove two invalid «peephole» optimizations from the bytecode
compiler.

@item 
bpo-46564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46564}: Do not create frame objects when creating @ref{155,,super}
object. Patch by Kumar Aditya.

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: Added more fined-grained specialization failure stats regarding
the @code{COMPARE_OP} bytecode.

@item 
bpo-44977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44977}: The delegation of @ref{1f0,,int()} to @code{__trunc__()} is now
deprecated. Calling @code{int(a)} when @code{type(a)} implements
@code{__trunc__()} but not @code{__int__()} or @code{__index__()} now raises
a @ref{1da,,DeprecationWarning}.

@item 
bpo-46458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46458}: Reorder code emitted by the compiler for a
@ref{789,,try}-@ref{2f6,,except} block so that the @ref{1ea,,else} block’s
code immediately follows the @ref{789,,try} body (without a jump). This is
more optimal for the happy path.

@item 
bpo-46527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46527}: Allow passing @code{iterable} as a keyword argument to
@ref{14bb,,enumerate()} again. Patch by Jelle Zijlstra.

@item 
bpo-46528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46528}: Replace several stack manipulation instructions (@code{DUP_TOP},
@code{DUP_TOP_TWO}, @code{ROT_TWO}, @code{ROT_THREE}, @code{ROT_FOUR}, and @code{ROT_N})
with new @ref{7a9,,COPY} and @ref{7aa,,SWAP} instructions.

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: Use two or three bytecodes to implement most calls.

Calls without named arguments are implemented as a sequence of two
instructions: @code{PRECALL; CALL}. Calls with named arguments are
implemented as a sequence of three instructions: @code{PRECALL; KW_NAMES;
CALL}. There are two different @code{PRECALL} instructions:
@code{PRECALL_FUNTION} and @code{PRECALL_METHOD}. The latter pairs with
@code{LOAD_METHOD}.

This partition into pre-call and call allows better specialization, and
thus better performance ultimately.

There is no change in semantics.

@item 
bpo-46503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46503}: Fix an assert when parsing some invalid N escape sequences in
f-strings.

@item 
bpo-46431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46431}: Improve error message on invalid calls to
@code{BaseExceptionGroup.__new__()}.

@item 
bpo-46476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46476}: Fix memory leak in code objects generated by deepfreeze. Patch
by Kumar Aditya.

@item 
bpo-46481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46481}: Speed up calls to @code{weakref.ref.__call__()} by using the
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-46417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46417}: Fix a race condition on setting a type @code{__bases__} attribute:
the internal function @code{add_subclass()} now gets the
@code{PyTypeObject.tp_subclasses} member after calling
@ref{1856,,PyWeakref_NewRef()} which can trigger a garbage collection which
can indirectly modify @code{PyTypeObject.tp_subclasses}. Patch by Victor
Stinner.

@item 
bpo-46417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46417}: @code{python -X showrefcount} now shows the total reference count
after clearing and destroyed the main Python interpreter. Previously, it
was shown before. Patch by Victor Stinner.

@item 
bpo-43683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43683}: Add ASYNC_GEN_WRAP opcode to wrap the value to be yielded in
async generators. Removes the need to special case async generators in the
@code{YIELD_VALUE} instruction.

@item 
bpo-46407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46407}: Optimize some modulo operations in @code{Objects/longobject.c}.
Patch by Jeremiah Vivian.

@item 
bpo-46409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46409}: Add new @code{RETURN_GENERATOR} bytecode to make generators.
Simplifies calling Python functions in the VM, as they no longer any need
to special case generator functions.

Also add @code{JUMP_NO_INTERRUPT} bytecode that acts like @code{JUMP_ABSOLUTE},
but does not check for interrupts.

@item 
bpo-46406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46406}: The integer division @code{//} implementation has been optimized
to better let the compiler understand its constraints. It can be 20%
faster on the amd64 platform when dividing an int by a value smaller than
@code{2**30}.

@item 
bpo-46383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46383}: Fix invalid signature of @code{_zoneinfo}’s @code{module_free}
function to resolve a crash on wasm32-emscripten platform.

@item 
bpo-46361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46361}: Ensure that «small» integers created by @ref{1857,,int.from_bytes()}
and @ref{16a,,decimal.Decimal} are properly cached.

@item 
bpo-46161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46161}: Fix the class building error when the arguments are constants
and CALL_FUNCTION_EX is used.

@item 
bpo-46028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46028}: Fixes calculation of @code{sys._base_executable} when inside a
virtual environment that uses symlinks with different binary names than
the base environment provides.

@item 
bpo-46091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46091}: Correctly calculate indentation levels for lines with
whitespace character that are ended by line continuation characters. Patch
by Pablo Galindo

@item 
bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512}: Add CAN Socket support for NetBSD.

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: Do not use POSIX semaphores on NetBSD

@item 
bpo-44024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44024}: Improve the @ref{228,,TypeError} message for non-string second
arguments passed to the built-in functions @ref{c59,,getattr()} and
@ref{579,,hasattr()}. Patch by Géry Ogam.
@end itemize

@node Library<21>,Documentation<20>,Core and Builtins<21>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id183}@anchor{1858}
@subsubsection Library



@itemize -

@item 
bpo-46624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46624}: Restore support for non-integer arguments of
@ref{902,,random.randrange()} and @ref{129c,,random.randint()}.

@item 
bpo-46591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46591}: Make the IDLE doc URL on the About IDLE dialog clickable.

@item 
bpo-46565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46565}: Remove loop variables that are leaking into modules”
namespaces.

@item 
bpo-46553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46553}: In @ref{752,,typing.get_type_hints()}, support evaluating bare
stringified @code{ClassVar} annotations. Patch by Gregory Beauregard.

@item 
bpo-46544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46544}: Don’t leak @code{x} & @code{uspace} intermediate vars in
@ref{104c,,textwrap.TextWrapper}.

@item 
bpo-46487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46487}: Add the @code{get_write_buffer_limits} method to
@code{asyncio.transports.WriteTransport} and to the SSL transport.

@item 
bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}: Note the configparser deprecations will be removed in Python
3.12.

@item 
bpo-45162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45162}: The deprecated @ref{106,,unittest} APIs removed in 3.11a1 have been
temporarily restored to be removed in 3.12 while cleanups in external
projects go in.

@item 
bpo-46539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46539}: In @ref{752,,typing.get_type_hints()}, support evaluating
stringified @code{ClassVar} and @code{Final} annotations inside @code{Annotated}.
Patch by Gregory Beauregard.

@item 
bpo-46510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46510}: Add missing test for @ref{b7d,,types.TracebackType} and
@ref{1859,,types.FrameType}. Calculate them directly from the caught
exception without calling @ref{72b,,sys.exc_info()}.

@item 
bpo-46491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46491}: Allow @ref{9d0,,typing.Annotated} to wrap @ref{3be,,typing.Final} and
@ref{3bd,,typing.ClassVar}. Patch by Gregory Beauregard.

@item 
bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483}: Remove @ref{7d6,,__class_getitem__()} from
@ref{54e,,pathlib.PurePath} as this class was not supposed to be generic.

@item 
bpo-46436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46436}: Fix command-line option @code{-d}/@code{--directory} in module
@ref{72,,http.server} which is ignored when combined with command-line option
@code{--cgi}. Patch by Géry Ogam.

@item 
bpo-41403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41403}: Make @code{mock.patch()} raise a @ref{228,,TypeError} with a
relevant error message on invalid arg. Previously it allowed a cryptic
@ref{441,,AttributeError} to escape.

@item 
bpo-46474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46474}: In @code{importlib.metadata.EntryPoint.pattern}, avoid potential
REDoS by limiting ambiguity in consecutive whitespace.

@item 
bpo-46474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46474}: Removed private method from @code{importlib.metadata.Path}. Sync
with importlib_metadata 4.10.0.

@item 
bpo-46470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46470}: Remove unused branch from @code{typing._remove_dups_flatten}

@item 
bpo-46469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46469}: @ref{b,,asyncio} generic classes now return
@ref{882,,types.GenericAlias} in @code{__class_getitem__} instead of the same
class.

@item 
bpo-41906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41906}: Support passing filter instances in the @code{filters} values of
@code{handlers} and @code{loggers} in the dictionary passed to
@ref{121e,,logging.config.dictConfig()}.

@item 
bpo-46422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46422}: Use @code{dis.Positions} in @code{dis.Instruction} instead of a
regular @code{tuple}.

@item 
bpo-46434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46434}: @ref{a5,,pdb} now gracefully handles @code{help} when
@ref{185a,,__doc__} is missing, for example when run with pregenerated
optimized @code{.pyc} files.

@item 
bpo-43869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43869}: Python uses the same time Epoch on all platforms. Add an
explicit unit test to ensure that it’s the case. Patch by Victor Stinner.

@item 
bpo-46414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46414}: Add @ref{74b,,typing.reveal_type()}. Patch by Jelle Zijlstra.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @ref{d6,,subprocess} now imports Windows-specific imports when
@code{msvcrt} module is available, and POSIX-specific imports on all other
platforms. This gives a clean exception when @code{_posixsubprocess} is not
available (e.g. Emscripten browser target).

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}: @code{IntEnum}, @code{IntFlag}, and @code{StrEnum} use the mixed-in type
for their @code{str()} and @code{format()} output.

@item 
bpo-46316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46316}: Optimize @ref{163d,,pathlib.Path.iterdir()} by removing an
unnecessary check for special entries.

@item 
bpo-29688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29688}: Document @ref{16b6,,pathlib.Path.absolute()} (which has always
existed).

@item 
bpo-43012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43012}: The pathlib module’s obsolete and internal @code{_Accessor} class
has been removed to prepare the terrain for upcoming enhancements to the
module.

@item 
bpo-46258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46258}: Speed up @ref{a97,,math.isqrt()} for small positive integers by
replacing two division steps with a lookup table.

@item 
bpo-46242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46242}: Improve error message when creating a new @ref{6d1,,enum.Enum}
type subclassing an existing @code{Enum} with @code{_member_names_} using
@code{enum.Enum.__call__()}.

@item 
bpo-43118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43118}: Fix a bug in @ref{181,,inspect.signature()} that was causing it to
fail on some subclasses of classes with a @code{__text_signature__}
referencing module globals. Patch by Weipeng Hong.

@item 
bpo-26552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26552}: Fixed case where failing @ref{cfe,,asyncio.ensure_future()} did not
close the coroutine. Patch by Kumar Aditya.

@item 
bpo-21987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21987}: Fix an issue with @ref{185b,,tarfile.TarFile.getmember()} getting a
directory name with a trailing slash.

@item 
bpo-46124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46124}: Update @ref{133,,zoneinfo} to rely on importlib.resources
traversable API.

@item 
bpo-46103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46103}: Now @ref{185c,,inspect.getmembers()} only gets @code{__bases__}
attribute from class type. Patch by Weipeng Hong.

@item 
bpo-46080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46080}: Fix exception in argparse help text generation if a
@ref{185d,,argparse.BooleanOptionalAction} argument’s default is
@code{argparse.SUPPRESS} and it has @code{help} specified.  Patch by Felix
Fontein.

@item 
bpo-44791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44791}: Fix substitution of @ref{2ca,,ParamSpec} in
@ref{85d,,Concatenate} with different parameter expressions.
Substitution with a list of types returns now a tuple of types.
Substitution with @code{Concatenate} returns now a @code{Concatenate} with
concatenated lists of arguments.
@end itemize

@node Documentation<20>,Tests<20>,Library<21>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id184}@anchor{185e}
@subsubsection Documentation



@itemize -

@item 
bpo-46463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46463}: Fixes @code{escape4chm.py} script used when building the CHM
documentation file
@end itemize

@node Tests<20>,Build<21>,Documentation<20>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id185}@anchor{185f}
@subsubsection Tests



@itemize -

@item 
bpo-43478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43478}: Mocks can no longer be provided as the specs for other Mocks.
As a result, an already-mocked object cannot be passed to @code{mock.Mock()}.
This can uncover bugs in tests since these Mock-derived Mocks will always
pass certain tests (e.g. isinstance) and builtin assert functions (e.g.
assert_called_once_with) will unconditionally pass.

@item 
bpo-46616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46616}: Ensures @code{test_importlib.test_windows} cleans up registry keys
after completion.

@item 
bpo-44359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44359}: test_ftplib now silently ignores socket errors to prevent
logging unhandled threading exceptions. Patch by Victor Stinner.

@item 
bpo-46600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46600}: Fix test_gdb.test_pycfunction() for Python built with @code{clang
-Og}. Tolerate inlined functions in the gdb traceback. Patch by Victor
Stinner.

@item 
bpo-46542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46542}: Fix a Python crash in test_lib2to3 when using Python built in
debug mode: limit the recursion limit. Patch by Victor Stinner.

@item 
bpo-46576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46576}: test_peg_generator now disables compiler optimization when
testing compilation of its own C extensions to significantly speed up the
testing on non-debug builds of CPython.

@item 
bpo-46542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46542}: Fix @code{test_json} tests checking for @ref{df1,,RecursionError}:
modify these tests to use @code{support.infinite_recursion()}. Patch by
Victor Stinner.

@item 
bpo-13886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13886}: Skip test_builtin PTY tests on non-ASCII characters if the
readline module is loaded. The readline module changes input() behavior,
but test_builtin is not intended to test the readline module. Patch by
Victor Stinner.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Add @code{test.support.requires_fork()} decorators to mark tests
that require a working @ref{2ff,,os.fork()}.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Add @code{test.support.requires_subprocess()} decorator to mark
tests which require working @ref{d6,,subprocess} module or @code{os.spawn*}. The
wasm32-emscripten platform has no support for processes.

@item 
bpo-46126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46126}: Disable “descriptions” when running tests internally.
@end itemize

@node Build<21>,Windows<21>,Tests<20>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id186}@anchor{1860}
@subsubsection Build



@itemize -

@item 
bpo-46602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46602}: Tidied up configure.ac so that conftest.c is truncated rather
than appended. This assists in the case where the “rm” of conftest.c fails
to happen between tests.  Downstream issues such as a clobbered SOABI can
result.

@item 
bpo-46600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46600}: Fix the test checking if the C compiler supports @code{-Og} option
in the @code{./configure} script to also use @code{-Og} on clang which supports
it. Patch by Victor Stinner.

@item 
bpo-38472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38472}: Fix GCC detection in setup.py when cross-compiling. The C
compiler is now run with LC_ALL=C. Previously, the detection failed with a
German locale.

@item 
bpo-46513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46513}: @code{configure} no longer uses @code{AC_C_CHAR_UNSIGNED}
macro and @code{pyconfig.h} no longer defines reserved symbol
@code{__CHAR_UNSIGNED__}.

@item 
bpo-46471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46471}: Use global singletons for single byte bytes objects in
deepfreeze.

@item 
bpo-46443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46443}: Deepfreeze now uses cached small integers as it saves some
space for common small integers.

@item 
bpo-46429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46429}: Merge all deep-frozen files into one for space savings. Patch
by Kumar Aditya.

@item 
bpo-45569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45569}: The build now defaults to using 30-bit digits for Python
integers. Previously either 15-bit or 30-bit digits would be selected,
depending on the platform. 15-bit digits may still be selected using the
@code{--enable-big-digits=15} option to the @code{configure} script, or by
defining @code{PYLONG_BITS_IN_DIGIT} in @code{pyconfig.h}.

@item 
bpo-45925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45925}: Update Windows installer to use SQLite 3.37.2.

@item 
bpo-43112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43112}: Detect musl libc as a separate SOABI (tagged as
@code{linux-musl}).
@end itemize

@node Windows<21>,macOS<16>,Build<21>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id187}@anchor{1861}
@subsubsection Windows



@itemize -

@item 
bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}: The traditional EXE/MSI based installer for Windows is now
available for ARM64

@item 
bpo-46362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46362}: os.path.abspath(«C:CON») is now fixed to return «\.CON», not
the same path. The regression was true of all legacy DOS devices such as
COM1, LPT1, or NUL.

@item 
bpo-44934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44934}: The installer now offers a command-line only option to add the
installation directory to the end of 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} instead of at the
start.
@end itemize

@node macOS<16>,IDLE<13>,Windows<21>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id188}@anchor{1862}
@subsubsection macOS



@itemize -

@item 
bpo-45925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45925}: Update macOS installer to SQLite 3.37.2.
@end itemize

@node IDLE<13>,C API<20>,macOS<16>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id189}@anchor{1863}
@subsubsection IDLE



@itemize -

@item 
bpo-45296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45296}: Clarify close, quit, and exit in IDLE.  In the File menu,
“Close” and “Exit” are now “Close Window” (the current one) and “Exit” is
now “Exit IDLE” (by closing all windows).  In Shell, “quit()” and “exit()”
mean “close Shell”. If there are no other windows, this also exits IDLE.
@end itemize

@node C API<20>,,IDLE<13>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id190}@anchor{1864}
@subsubsection C API



@itemize -

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Remove the @code{PyHeapType_GET_MEMBERS()} macro. It was exposed
in the public C API by mistake, it must only be used by Python internally.
Use the @code{PyTypeObject.tp_members} member instead. Patch by Victor
Stinner.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Move _Py_GetAllocatedBlocks() and _PyObject_DebugMallocStats()
private functions to the internal C API. Patch by Victor Stinner.

@item 
bpo-46433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46433}: The internal function _PyType_GetModuleByDef now correctly
handles inheritance patterns involving static types.

@item 
bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}: @ref{7f2,,Py_buffer} and various @code{Py_buffer} related functions
are now part of the limited API and stable ABI.

@item 
bpo-14916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14916}: Fixed bug in the tokenizer that prevented
@code{PyRun_InteractiveOne} from parsing from the provided FD.
@end itemize

@node Python 3 11 0 alpha 4,Python 3 11 0 alpha 3,Python 3 11 0 alpha 5,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-4}@anchor{1865}
@subsection Python 3.11.0 alpha 4


`Release date: 2022-01-13'

@menu
* Core and Builtins: Core and Builtins<22>. 
* Library: Library<22>. 
* Documentation: Documentation<21>. 
* Tests: Tests<21>. 
* Build: Build<22>. 
* Windows: Windows<22>. 
* macOS: macOS<17>. 
* C API: C API<21>. 

@end menu

@node Core and Builtins<22>,Library<22>,,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id191}@anchor{1866}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-46070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46070}: @ref{1867,,Py_EndInterpreter()} now explicitly untracks all objects
currently tracked by the GC. Previously, if an object was used later by
another interpreter, calling @ref{1547,,PyObject_GC_UnTrack()} on the object
crashed if the previous or the next object of the @code{PyGC_Head}
structure became a dangling pointer. Patch by Victor Stinner.

@item 
bpo-46347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46347}: Fix memory leak in PyEval_EvalCodeEx.

@item 
bpo-46339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46339}: Fix a crash in the parser when retrieving the error text for
multi-line f-strings expressions that do not start in the first line of
the string. Patch by Pablo Galindo

@item 
bpo-46331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46331}: Do not set line number of instruction storing doc-string. Fixes
regression introduced in 3.11 alpha.

@item 
bpo-46314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46314}: Remove spurious «call» event when creating a lambda function
that was accidentally introduced in 3.11a4.

@item 
bpo-46289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46289}: ASDL declaration of @code{FormattedValue} has changed to reflect
@code{conversion} field is not optional.

@item 
bpo-46297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46297}: Fixed an interpreter crash on bootup with multiple PythonPaths
set in the Windows registry. Patch by Derzsi Dániel.

@item 
bpo-46237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46237}: Fix the line number of tokenizer errors inside f-strings. Patch
by Pablo Galindo.

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: We always expect the «use_frozen_modules» config to be set, now
that getpath.c was rewritten in pure Python and the logic improved.

@item 
bpo-46006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46006}: Fix a regression when a type method like @code{__init__()} is
modified in a subinterpreter. Fix a regression in
@code{_PyUnicode_EqualToASCIIId()} and type @code{update_slot()}. Revert the
change which made the Unicode dictionary of interned strings compatible
with subinterpreters: the internal interned dictionary is shared again by
all interpreters. Patch by Victor Stinner.

@item 
bpo-45923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45923}: Add RESUME opcode. This is a logical no-op. It is emitted by
the compiler anywhere a Python function can be entered. It is used by the
interpreter to perform tracing and optimizer checks.

@item 
bpo-46208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46208}: Fix the regression of os.path.normpath(«A/../../B») not
returning expected «../B» but «B».

@item 
bpo-46240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46240}: Correct the error message for unclosed parentheses when the
tokenizer doesn’t reach the end of the source when the error is reported.
Patch by Pablo Galindo

@item 
bpo-46009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46009}: Remove the @code{GEN_START} opcode.

@item 
bpo-46235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46235}: Certain sequence multiplication operations like @code{[0] * 1_000}
are now faster due to reference-counting optimizations. Patch by Dennis
Sweeney.

@item 
bpo-46221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46221}: @code{PREP_RERAISE_STAR} no longer pushes @code{lasti} to the
stack.

@item 
bpo-46202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46202}: Remove @code{POP_EXCEPT_AND_RERAISE} and replace it by an
equivalent sequence of other opcodes.

@item 
bpo-46085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46085}: Fix iterator cache mechanism of @code{OrderedDict}.

@item 
bpo-46055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46055}: Speed up shifting operation involving integers less than
@code{PyLong_BASE}. Patch by Xinhang Xu.

@item 
bpo-46110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46110}: Add a maximum recursion check to the PEG parser to avoid stack
overflow. Patch by Pablo Galindo

@item 
bpo-46107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46107}: Fix bug where @code{ExceptionGroup.split()} and
@code{ExceptionGroup.subgroup()} did not copy the exception group’s
@code{__note__} field to the parts.

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: The interpreter state’s representation of handled exceptions
(a.k.a exc_info, or _PyErr_StackItem) now has only the @code{exc_value}
field, @code{exc_type} and @code{exc_traceback} have been removed as their
values can be derived from @code{exc_value}.

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: Replace the four call bytecode instructions which one pre-call
instruction and two call instructions.

Removes @code{CALL_FUNCTION}, @code{CALL_FUNCTION_KW}, @code{CALL_METHOD} and
@code{CALL_METHOD_KW}.

Adds @code{CALL_NO_KW} and @code{CALL_KW} call instructions, and
@code{PRECALL_METHOD} prefix for pairing with @code{LOAD_METHOD}.

@item 
bpo-46039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46039}: Remove the @code{YIELD_FROM} instruction and replace it with the
@code{SEND} instruction which performs the same operation, but without the
loop.

@item 
bpo-45635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45635}: The code called from @code{_PyErr_Display()} was refactored
to improve error handling. It now exits immediately upon an unrecoverable
error.

@item 
bpo-46054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46054}: Fix parser error when parsing non-utf8 characters in source
files. Patch by Pablo Galindo.

@item 
bpo-46042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46042}: Improve the location of the caret in @ref{150,,SyntaxError}
exceptions emitted by the symbol table. Patch by Pablo Galindo.

@item 
bpo-46049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46049}: Ensure @code{._pth} files work as intended on platforms other
than Windows.

@item 
bpo-46048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46048}: Fixes parsing of @code{._pth} files on startup so that
single-character paths are correctly read.

@item 
bpo-37971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37971}: Fix a bug where the line numbers given in a traceback when a
decorator application raised an exception were wrong.

@item 
bpo-46031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46031}: Add @ref{17fe,,POP_JUMP_IF_NOT_NONE} and
@ref{17fd,,POP_JUMP_IF_NONE} opcodes to speed up conditional jumps.

@item 
bpo-45654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45654}: Deepfreeze @ref{be,,runpy}, patch by Kumar Aditya.

@item 
bpo-46025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46025}: Fix a crash in the @ref{d,,atexit} module involving functions
that unregister themselves before raising exceptions. Patch by Pablo
Galindo.

@item 
bpo-46000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46000}: Improve compatibility of the @ref{2c,,curses} module with NetBSD
curses.

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: Specialize the CALL_FUNCTION instruction for calls to builtin
types with a single argument. Speeds up @code{range(x)}, @code{list(x)}, and
specifically @code{type(obj)}.

@item 
bpo-42918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42918}: Fix bug where the built-in @ref{2fb,,compile()} function did not
always raise a @ref{150,,SyntaxError} when passed multiple statements in
“single” mode. Patch by Weipeng Hong.

@item 
bpo-45953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45953}: The main interpreter in _PyRuntimeState.interpreters is now
statically allocated (as part of _PyRuntime).  Likewise for the initial
thread state of each interpreter.  This means less allocation during
runtime init, as well as better memory locality for these key state
objects.

@item 
bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}: Complete the 
@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} implementation: add @code{except*}.

@item 
bpo-43413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43413}: Revert changes in @code{set.__init__}. Subclass of @ref{67a,,set}
needs to define a @code{__init__()} method if it defines a @code{__new__()}
method with additional keyword parameters.

@item 
bpo-43931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43931}: Added the @ref{7f0,,Py_Version} constant which bears the same
value as @ref{7f1,,PY_VERSION_HEX}. Patch by Gabriele N. Tornetta.
@end itemize

@node Library<22>,Documentation<21>,Core and Builtins<22>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id192}@anchor{1868}
@subsubsection Library



@itemize -

@item 
bpo-46342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46342}: The @code{@@typing.final} decorator now sets the @code{__final__}
attribute on the decorated object to allow runtime introspection. Patch by
Jelle Zijlstra.

@item 
bpo-46328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46328}: Added the @ref{72c,,sys.exception()} method which returns the active
exception instance.

@item 
bpo-46307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46307}: Add @ref{727,,string.Template.is_valid()} and
@ref{726,,string.Template.get_identifiers()} methods.

@item 
bpo-46306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46306}: Assume that @ref{1d8,,types.CodeType} always has
@code{types.CodeType.co_firstlineno} in @ref{3b,,doctest}.

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: Fix @ref{68,,hashlib} `usedforsecurity' option to work correctly
with OpenSSL 3.0.0 in FIPS mode.

@item 
bpo-46070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46070}: Fix possible segfault when importing the @ref{b,,asyncio} module
from different sub-interpreters in parallel. Patch by Erlend E. Aasland.

@item 
bpo-46244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46244}: Removed @code{__slots__} from @ref{2ca,,typing.ParamSpec} and
@ref{2c9,,typing.TypeVar}. They served no purpose. Patch by Arie Bovenberg.

@item 
bpo-46278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46278}: Reflect @code{context} argument in @code{AbstractEventLoop.call_*()}
methods. Loop implementations already support it.

@item 
bpo-46269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46269}: Remove special-casing of @code{__new__} in
@ref{1869,,enum.Enum.__dir__()}.

@item 
bpo-46266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46266}: Improve day constants in @ref{15,,calendar}.

Now all constants (@code{MONDAY} … @code{SUNDAY}) are documented, tested, and
added to @code{__all__}.

@item 
bpo-46257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46257}: Optimized the mean, variance, and stdev functions in the
statistics module. If the input is an iterator, it is consumed in a single
pass rather than eating memory by conversion to a list.  The single pass
algorithm is about twice as fast as the previous two pass code.

@item 
bpo-41011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41011}: Added two new variables to `pyvenv.cfg' which is generated by
@ref{111,,venv} module: `executable' for the executable and `command' for the
command line used to create the environment.

@item 
bpo-46239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46239}: Improve error message when importing
@code{asyncio.windows_events} on non-Windows.

@item 
bpo-46238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46238}: Reuse @code{_winapi} constants in @code{asyncio.windows_events}.

@item 
bpo-46222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46222}: Adding @code{SF_NOCACHE} sendfile constant for FreeBSD for the
posixmodule.

@item 
bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}: Add fast path for @code{0 <= k <= n <= 67} for @ref{770,,math.comb()}.

@item 
bpo-46176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46176}: Adding the @code{MAP_STACK} constant for the mmap module.

@item 
bpo-43424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43424}: Deprecate @code{webbrowser.MacOSXOSAScript._name} and use
@code{name} instead.

@item 
bpo-45321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45321}: Added missing error codes to module
@code{xml.parsers.expat.errors}.

@item 
bpo-46125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46125}: Refactor tests to test traversable API directly. Includes
changes from importlib 5.4.0.

@item 
bpo-46118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46118}: Moved importlib.resources and its related functionality to a
package.

@item 
bpo-37578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37578}: Add `include_hidden' parameter to @ref{3ef,,glob()} and
@ref{89e,,iglob()} to match hidden files and directories when using
special characters like @code{*}, @code{**}, @code{?} and @code{[]}.

@item 
bpo-20369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20369}: @ref{186a,,concurrent.futures.wait()} no longer blocks forever when
given duplicate Futures. Patch by Kumar Aditya.

@item 
bpo-46105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46105}: Honor spec when generating requirement specs with urls and
extras (importlib_metadata 4.8.3).

@item 
bpo-44893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44893}: EntryPoint objects are no longer tuples. Recommended means to
access is by attribute (“.name”, “.group”) or accessor (“.load()”). Access
by index is deprecated and will raise deprecation warning.

@item 
bpo-22815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22815}: Print unexpected successes together with failures and errors in
summary in @ref{5d4,,unittest.TextTestResult}.

@item 
bpo-22047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22047}: Calling @code{add_argument_group()} on an argument group is
deprecated. Calling @code{add_argument_group()} or
@code{add_mutually_exclusive_group()} on a mutually exclusive group is
deprecated.

These features were never supported and do not always work correctly. The
functions exist on the API by accident through inheritance and will be
removed in the future.

@item 
bpo-26952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26952}: @ref{7,,argparse} raises @ref{360,,ValueError} with clear message
when trying to render usage for an empty mutually exclusive group.
Previously it raised a cryptic @ref{1575,,IndexError}.

@item 
bpo-45615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45615}: Functions in the @ref{fe,,traceback} module raise @ref{228,,TypeError}
rather than @ref{441,,AttributeError} when an exception argument is not of
type @ref{65c,,BaseException}.

@item 
bpo-16594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16594}: Add allow allow_reuse_port flag in socketserver.

@item 
bpo-27718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27718}: Fix help for the @ref{c6,,signal} module. Some functions (e.g.
@code{signal()} and @code{getsignal()}) were omitted.

@item 
bpo-46032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46032}: The @code{registry()} method of @ref{6da,,functools.singledispatch()}
functions checks now the first argument or the first parameter annotation
and raises a TypeError if it is not supported. Previously unsupported
«types» were ignored (e.g. @code{typing.List[int]}) or caused an error at
calling time (e.g. @code{list[int]}).

@item 
bpo-46014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46014}: Add ability to use @code{typing.Union} and @code{types.UnionType} as
dispatch argument to @code{functools.singledispatch}. Patch provided by Yurii
Karabas.

@item 
bpo-27062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27062}: Add @code{__all__} to @ref{7e,,inspect}, patch by Kumar Aditya.

@item 
bpo-46018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46018}: Ensure that @ref{1259,,math.expm1()} does not raise on underflow.

@item 
bpo-46016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46016}: Adding @code{F_DUP2FD} and @code{F_DUP2FD_CLOEXEC} constants
from FreeBSD into the fcntl module.

@item 
bpo-45755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45755}: @ref{104,,typing} generic aliases now reveal the class attributes
of the original generic class when passed to @code{dir()}. This was the
behavior up to Python 3.6, but was changed in 3.7-3.9.

@item 
bpo-45874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45874}: The empty query string, consisting of no query arguments, is
now handled correctly in @code{urllib.parse.parse_qsl}. This caused problems
before when strict parsing was enabled.

@item 
bpo-44674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44674}: Change how dataclasses disallows mutable default values.  It
used to use a list of known types (list, dict, set).  Now it disallows
unhashable objects to be defaults.  It’s using unhashability as a proxy
for mutability.  Patch by Eric V. Smith, idea by Raymond Hettinger.

@item 
bpo-23882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23882}: Remove namespace package (PEP 420) support from unittest
discovery. It was introduced in Python 3.4 but has been broken since
Python 3.7.

@item 
bpo-25066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25066}: Added a @code{__repr__()} method to
@ref{186b,,multiprocessing.Event} objects, patch by Kumar Aditya.

@item 
bpo-45643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45643}: Added @ref{186c,,signal.SIGSTKFLT} on platforms where this signal
is defined.

@item 
bpo-44092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44092}: Fetch across rollback no longer raises
@ref{71e,,InterfaceError}. Instead we leave it to the SQLite library
to handle these cases. Patch by Erlend E. Aasland.

@item 
bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}: Replace @code{concurrent.futures.TimeoutError} and
@code{asyncio.TimeoutError} with builtin @ref{8cc,,TimeoutError}, keep these
names as deprecated aliases.
@end itemize

@node Documentation<21>,Tests<21>,Library<22>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id193}@anchor{186d}
@subsubsection Documentation



@itemize -

@item 
bpo-46196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46196}: Document method @ref{186e,,cmd.Cmd.columnize()}.

@item 
bpo-46120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46120}: State that @code{|} is preferred for readability over @code{Union} in
the @ref{104,,typing} docs.

@item 
bpo-46109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46109}: Extracted @code{importlib.resources} and
@code{importlib.resources.abc} documentation into separate files.

@item 
bpo-19737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19737}: Update the documentation for the @ref{186f,,globals()} function.
@end itemize

@node Tests<21>,Build<22>,Documentation<21>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id194}@anchor{1870}
@subsubsection Tests



@itemize -

@item 
bpo-46296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46296}: Add a test case for @ref{56,,enum} with @code{_use_args_ == True} and
@code{_member_type_ == object}.

@item 
bpo-46205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46205}: Fix hang in runtest_mp due to race condition

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: Fix test_capi on FreeBSD 14-dev: instruct jemalloc to not fill
freed memory with junk byte.

@item 
bpo-46262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46262}: Cover @code{ValueError} path in tests for
@code{enum.Flag._missing_()}.

@item 
bpo-46150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46150}: Now @code{fakename} in
@code{test_pathlib.PosixPathTest.test_expanduser} is checked to be
non-existent.

@item 
bpo-46129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46129}: Rewrite @code{asyncio.locks} tests with
@ref{206,,unittest.IsolatedAsyncioTestCase} usage.

@item 
bpo-23819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23819}: Fixed @ref{b,,asyncio} tests in python optimized mode. Patch by
Kumar Aditya.

@item 
bpo-46114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46114}: Fix test case for OpenSSL 3.0.1 version. OpenSSL 3.0 uses
@code{0xMNN00PP0L}.
@end itemize

@node Build<22>,Windows<22>,Tests<21>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id195}@anchor{1871}
@subsubsection Build



@itemize -

@item 
bpo-44133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44133}: When Python is configured with
@ref{926,,--without-static-libpython}, the Python static library
(libpython.a) is no longer built. Patch by Victor Stinner.

@item 
bpo-44133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44133}: When Python is built without @ref{8fa,,--enable-shared}, the
@code{python} program is now linked to object files, rather than being linked
to the Python static library (libpython.a), to make sure that all symbols
are exported. Previously, the linker omitted some symbols like the
@code{Py_FrozenMain()} function. Patch by Victor Stinner.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: The @code{configure} script has a new option
@code{--with-emscripten-target} to select browser or node as Emscripten build
target.

@item 
bpo-46315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46315}: Added and fixed @code{#ifdef HAVE_FEATURE} checks for
functionality that is not available on WASI platform.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: Fixed a regression in @code{configure} check for
@ref{1012,,select.epoll()}.

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: @code{configure} no longer sets @code{MULTIARCH} on FreeBSD
platforms.

@item 
bpo-46106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46106}: Updated OpenSSL to 1.1.1m in Windows builds, macOS installer
builds, and CI. Patch by Kumar Aditya.

@item 
bpo-46088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46088}: Automatically detect or install bootstrap Python runtime when
building from Visual Studio.

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: Add a –with-pystats configure option to turn on internal
statistics gathering.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: A new directory @code{Tools/wasm} contains WebAssembly-related
helpers like @code{config.site} override for wasm32-emscripten, wasm assets
generator to bundle the stdlib, and a README.

@item 
bpo-46023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46023}: @code{makesetup} no longer builds extensions that have been
marked as `disabled'. This allows users to disable modules in
@code{Modules/Setup.local}.

@item 
bpo-45949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45949}: Use pure Python @code{freeze_module} for all but importlib
bootstrap files. @code{--with-freeze-module} @code{configure} option is
no longer needed for cross builds.
@end itemize

@node Windows<22>,macOS<17>,Build<22>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id196}@anchor{1872}
@subsubsection Windows



@itemize -

@item 
bpo-46217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46217}: Removed parameter that is unsupported on Windows 8.1 and early
Windows 10 and may have caused build or runtime failures.
@end itemize

@node macOS<17>,C API<21>,Windows<22>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id197}@anchor{1873}
@subsubsection macOS



@itemize -

@item 
bpo-40477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40477}: The Python Launcher app for macOS now properly launches scripts
and, if necessary, the Terminal app when running on recent macOS releases.
@end itemize

@node C API<21>,,macOS<17>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id198}@anchor{1874}
@subsubsection C API



@itemize -

@item 
bpo-46236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46236}: Fix a bug in @ref{17c2,,PyFunction_GetAnnotations()} that caused it
to return a @code{tuple} instead of a @code{dict}.

@item 
bpo-46140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46140}: @ref{7f3,,PyBuffer_GetPointer()},
@ref{7f6,,PyBuffer_FromContiguous()}, @ref{7f5,,PyBuffer_ToContiguous()} and
@ref{7fb,,PyMemoryView_FromBuffer()} now take buffer info by @code{const
Py_buffer *} instead of @code{Py_buffer *}, as they do not need mutability.
@ref{7f6,,PyBuffer_FromContiguous()} also now takes the source buffer as
@code{const void *}, and similarly @ref{7f3,,PyBuffer_GetPointer()} takes the
strides as @code{const Py_ssize_t *}.

@item 
bpo-45855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45855}: Document that the `no_block' argument to
@ref{1875,,PyCapsule_Import()} is a no-op now.

@item 
bpo-45855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45855}: Replaced deprecated usage of
@ref{272,,PyImport_ImportModuleNoBlock()} with
@ref{273,,PyImport_ImportModule()} in stdlib modules. Patch by Kumar Aditya.

@item 
bpo-46007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46007}: The @code{PyUnicode_CHECK_INTERNED()} macro has been excluded
from the limited C API. It was never usable there, because it used
internal structures which are not available in the limited C API. Patch by
Victor Stinner.
@end itemize

@node Python 3 11 0 alpha 3,Python 3 11 0 alpha 2,Python 3 11 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-3}@anchor{1876}
@subsection Python 3.11.0 alpha 3


`Release date: 2021-12-08'

@menu
* Core and Builtins: Core and Builtins<23>. 
* Library: Library<23>. 
* Documentation: Documentation<22>. 
* Tests: Tests<22>. 
* Build: Build<23>. 
* Windows: Windows<23>. 
* macOS: macOS<18>. 
* C API: C API<22>. 

@end menu

@node Core and Builtins<23>,Library<23>,,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id199}@anchor{1877}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-46009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46009}: Restore behavior from 3.9 and earlier when sending non-None to
newly started generator. In 3.9 this did not affect the state of the
generator. In 3.10.0 and 3.10.1 @code{gen_func().send(0)} is equivalent to
@code{gen_func().throw(TypeError(...)} which exhausts the generator. In
3.10.2 onward, the behavior has been reverted to that of 3.9.

@item 
bpo-46004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46004}: Fix the @ref{150,,SyntaxError} location for errors involving for
loops with invalid targets. Patch by Pablo Galindo

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: @code{_PyErr_ChainStackItem()} no longer normalizes
@code{exc_info} (including setting the traceback on the exception instance)
because @code{exc_info} is always normalized.

@item 
bpo-45607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45607}: The @code{__note__} field was added to @ref{65c,,BaseException}. It is
@code{None} by default but can be set to a string which is added to the
exception’s traceback.

@item 
bpo-45947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45947}: Place pointers to dict and values immediately before GC header.
This reduces number of dependent memory loads to access either dict or
values from 3 to 1.

@item 
bpo-45915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45915}: @code{is_valid_fd} now uses faster @code{fcntl(fd, F_GETFD)} on
Linux, macOS, and Windows.

@item 
bpo-44530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44530}: Reverts a change to the @code{code.__new__} @ref{1878,,audit event} from an earlier prerelease.

@item 
bpo-42268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42268}: Fail the configure step if the selected compiler doesn’t
support memory sanitizer. Patch by Pablo Galindo

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: The three values of @code{exc_info} are now always consistent with
each other. In particular, the @code{type} and @code{traceback} fields are now
derived from the exception instance. This impacts the return values of
@ref{72b,,sys.exc_info()} and @ref{80c,,PyErr_GetExcInfo()} if the exception
instance is modified while the exception is handled, as well as
@ref{80b,,PyErr_SetExcInfo()}, which now ignores the @code{type} and
@code{traceback} arguments provided to it.

@item 
bpo-45727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45727}: Refine the custom syntax error that suggests that a comma may
be missing to trigger only when the expressions are detected between
parentheses or brackets. Patch by Pablo Galindo

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: Specialized the @code{COMPARE_OP} opcode using the PEP 659
machinery.

@item 
bpo-45786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45786}: Allocate space for the interpreter frame in the frame object,
to avoid an additional allocation when the frame object outlives the frame
activation.

@item 
bpo-45614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45614}: Fix @ref{fe,,traceback} display for exceptions with invalid module
name.

@item 
bpo-45813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45813}: Fix crash when calling coro.cr_frame.clear() after coroutine
has been freed.

@item 
bpo-45811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45811}: Improve the tokenizer errors when encountering invisible
control characters in the parser. Patch by Pablo Galindo

@item 
bpo-45848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45848}: Allow the parser to obtain error lines directly from encoded
files. Patch by Pablo Galindo

@item 
bpo-45709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45709}: Restore behavior from 3.10 when tracing an exception raised
within a with statement.

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: Adds new @ref{79e,,COPY_FREE_VARS} opcode, to make copying of
free variables from function to frame explicit. Helps optimization of
calls to Python function.

@item 
bpo-45829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45829}: Specialize @ref{1747,,BINARY_SUBSCR} for classes with a
@code{__getitem__} method implemented in Python

@item 
bpo-45826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45826}: Fixed a crash when calling @code{.with_traceback(None)} on
@code{NameError}. This occurs internally in
@code{unittest.TestCase.assertRaises()}.

@item 
bpo-45822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45822}: Fixed a bug in the parser that was causing it to not respect
@geindex Python Enhancement Proposals; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} coding cookies when no flags are provided. Patch by Pablo
Galindo

@item 
bpo-45820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45820}: Fix a segfault when the parser fails without reading any input.
Patch by Pablo Galindo

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: Simplify the implementation of @ref{7a6,,BINARY_OP} by indexing
into an array of function pointers (rather than switching on the oparg).

@item 
bpo-42540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42540}: Fix crash when @ref{2ff,,os.fork()} is called with an active
non-default memory allocator.

@item 
bpo-45738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45738}: Fix computation of error location for invalid continuation
characters in the parser. Patch by Pablo Galindo.

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: Remove an existing «fast path» for old-style string formatting,
since it no longer appears to have any measurable impact.

@item 
bpo-45753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45753}: Make recursion checks a bit more efficient by tracking amount
of calls left before overflow.

@item 
bpo-45773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45773}: Fix a compiler hang when attempting to optimize certain jump
patterns.

@item 
bpo-45764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45764}: The parser now gives a better error message when leaving out
the opening parenthesis @code{(} after a @code{def}-statement:

@example
>>> def f:
  File "<stdin>", line 1
    def f:
         ^
SyntaxError: expected '('
@end example

@item 
bpo-45609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45609}: Specialized the @code{STORE_SUBSCR} opcode using the PEP 659
machinery.

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: Replace all numeric @code{BINARY_*} and @code{INPLACE_*} instructions
with a single @ref{7a6,,BINARY_OP} implementation.

@item 
bpo-45582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45582}: Path calculation (known as @code{getpath}) has been reimplemented
as a frozen Python module. This should have no visible impact, but may
affect calculation of all paths referenced in @ref{d9,,sys} and
@ref{db,,sysconfig}.

@item 
bpo-45450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45450}: Improve the syntax error message for parenthesized arguments.
Patch by Pablo Galindo.
@end itemize

@node Library<23>,Documentation<22>,Core and Builtins<23>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id200}@anchor{1879}
@subsubsection Library



@itemize -

@item 
bpo-27946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27946}: Fix possible crash when getting an attribute of
@ref{20b,,xml.etree.ElementTree.Element} simultaneously with replacing the
@code{attrib} dict.

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: Make @ref{b,,asyncio} normalize exceptions as soon as they are
captured with @ref{28a,,PyErr_Fetch()}, and before they are stored as an
exc_info triplet. This brings @ref{b,,asyncio} in line with the rest of the
codebase, where an exc_info triplet is always normalized.

@item 
bpo-23819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23819}: Replaced asserts with exceptions in asyncio, patch by Kumar
Aditya.

@item 
bpo-13236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13236}: @ref{5d4,,unittest.TextTestResult} and
@ref{174a,,unittest.TextTestRunner} flush now the output stream more often.

@item 
bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917}: Added @ref{701,,math.exp2()}:, which returns 2 raised to the power
of x.

@item 
bpo-37658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37658}: Fix issue when on certain conditions @code{asyncio.wait_for()} may
allow a coroutine to complete successfully, but fail to return the result,
potentially causing memory leaks or other issues.

@item 
bpo-45876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45876}: Improve the accuracy of stdev() and pstdev() in the statistics
module.  When the inputs are floats or fractions, the output is a
correctly rounded float

@item 
bpo-44649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44649}: Handle dataclass(slots=True) with a field that has default a
default value, but for which init=False.

@item 
bpo-45803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45803}: Added missing kw_only parameter to
dataclasses.make_dataclass().

@item 
bpo-45837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45837}: The @code{turtle.RawTurtle.settiltangle()} is deprecated since
Python 3.1, it now emits a deprecation warning and will be removed in
Python 3.13.

Use @code{turtle.RawTurtle.tiltangle()} instead.

@code{turtle.RawTurtle.tiltangle()} was earlier incorrectly marked as
deprecated, its docstring has been corrected.

Patch by Hugo van Kemenade.

@item 
bpo-45831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45831}: @ref{58,,faulthandler} can now write ASCII-only strings (like
filenames and function names) with a single write() syscall when dumping a
traceback. It reduces the risk of getting an unreadable dump when two
threads or two processes dump a traceback to the same file (like stderr)
at the same time. Patch by Victor Stinner.

@item 
bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}: @code{sqlite} C callbacks now use unraisable exceptions if
callback tracebacks are enabled. Patch by Erlend E. Aasland.

@item 
bpo-41735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41735}: Fix thread lock in @code{zlib.Decompress.flush()} method before
@code{PyObject_GetBuffer}.

@item 
bpo-45235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45235}: Reverted an argparse bugfix that caused regression in the
handling of default arguments for subparsers.  This prevented leaf level
arguments from taking precedence over root level arguments.

@item 
bpo-45754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45754}: Fix a regression in Python 3.11a1 and 3.11a2 where
@ref{cf,,sqlite3} incorrectly would use @code{SQLITE_LIMIT_LENGTH} when checking
SQL statement lengths. Now, @code{SQLITE_LIMIT_SQL_LENGTH} is used. Patch by
Erlend E. Aasland.

@item 
bpo-45766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45766}: Added `proportional' option to
@ref{8c8,,statistics.linear_regression()}.

@item 
bpo-45765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45765}: In importlib.metadata, fix distribution discovery for an empty
path.

@item 
bpo-45757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45757}: Fix bug where @ref{39,,dis} produced an incorrect oparg when
@ref{17ad,,EXTENDED_ARG} is followed by an opcode that does not use its
argument.

@item 
bpo-45644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45644}: In-place JSON file formatting using @code{python3 -m json.tool
infile infile} now works correctly, previously it left the file empty.
Patch by Chris Wesseling.

@item 
bpo-45703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45703}: When a namespace package is imported before another module from
the same namespace is created/installed in a different @ref{27e,,sys.path}
location while the program is running, calling the
@ref{c98,,importlib.invalidate_caches()} function will now also guarantee the
new module is noticed.

@item 
bpo-45535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45535}: Improve output of @code{dir()} with Enums.

@item 
bpo-45664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45664}: Fix @ref{c24,,types.resolve_bases()} and @ref{11d2,,types.new_class()} for
@ref{882,,types.GenericAlias} instance as a base.

@item 
bpo-45663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45663}: Fix @ref{187a,,dataclasses.is_dataclass()} for dataclasses which are
subclasses of @ref{882,,types.GenericAlias}.

@item 
bpo-45662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45662}: Fix the repr of @code{dataclasses.InitVar} with a type alias
to the built-in class, e.g. @code{InitVar[list[int]]}.

@item 
bpo-43137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43137}: Launch GNOME web browsers via gio tool instead of obsolete
gvfs-open

@item 
bpo-45429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45429}: On Windows, @ref{73e,,time.sleep()} now uses a waitable timer which
supports high-resolution timers. Patch by Donghee Na and Eryk Sun.

@item 
bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}: Optimize @ref{770,,math.comb()} and @ref{771,,math.perm()}.

@item 
bpo-45514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45514}: Deprecated legacy functions in @ref{7b,,importlib.resources}.

@item 
bpo-45507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45507}: Add tests for truncated/missing trailers in gzip.decompress
implementation.

@item 
bpo-45359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45359}: Implement 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} for @ref{978,,graphlib.TopologicalSorter}.

@item 
bpo-44733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44733}: Add @code{max_tasks_per_child} to
@ref{163,,concurrent.futures.ProcessPoolExecutor}. This allows users to
specify the maximum number of tasks a single process should execute before
the process needs to be restarted.

@item 
bpo-28806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28806}: Improve netrc library. netrc file no longer needs to contain
all tokens. And if the login name is anonymous, security check is no
longer need.

@item 
bpo-43498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43498}: Avoid a possible `«RuntimeError: dictionary changed size during
iteration»' when adjusting the process count of
@code{ProcessPoolExecutor}.

@item 
bpo-42158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42158}: Add MIME types for N-quads, N-triples, Notation3 and TriG to
@code{mimetypes}.

@item 
bpo-30533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30533}: Add @ref{6ea,,inspect.getmembers_static()} , it return all members
without triggering dynamic lookup via the descriptor protocol. Patch by
Weipeng Hong.
@end itemize

@node Documentation<22>,Tests<22>,Library<23>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id201}@anchor{187b}
@subsubsection Documentation



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: @code{make -C Doc suspicious} will be removed soon in favor of
@code{make -C Doc check}, mark it as deprecated.

@item 
bpo-45840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45840}: Improve cross-references in the documentation for the data
model.

@item 
bpo-45640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45640}: Properly marked-up grammar tokens in the documentation are now
clickable and take you to the definition of a given piece of grammar.
Patch by Arthur Milchior.

@item 
bpo-45788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45788}: Link doc for sys.prefix to sysconfig doc on installation paths.

@item 
bpo-45772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45772}: @code{socket.socket} documentation is corrected to a class from a
function.

@item 
bpo-45392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45392}: Update the docstring of the @ref{dcf,,type} built-in to remove a
redundant line and to mention keyword arguments for the constructor.

@item 
bpo-45250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45250}: Update the documentation to note that CPython does not
consistently require iterators to define @code{__iter__}.

@item 
bpo-25381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25381}: In the extending chapter of the extending doc, update a
paragraph about the global variables containing exception information.

@item 
bpo-43905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43905}: Expanded @ref{1735,,astuple()} and
@ref{172b,,asdict()} docs, warning about deepcopy being applied and
providing a workaround.
@end itemize

@node Tests<22>,Build<23>,Documentation<22>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id202}@anchor{187c}
@subsubsection Tests



@itemize -

@item 
bpo-45695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45695}: Out-of-tree builds with a read-only source directory are now
tested by CI.

@item 
bpo-19460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19460}: Add new Test for
@code{Lib/email/mime/nonmultipart.py::MIMENonMultipart}.

@item 
bpo-45835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45835}: Fix race condition in test_queue tests with multiple «feeder»
threads.

@item 
bpo-45783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45783}: The test for the freeze tool now handles file moves and
deletions.

@item 
bpo-45745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45745}: Remove the @code{--findleaks} command line option of regrtest: use
the @code{--fail-env-changed} option instead. Since Python 3.7, it was a
deprecated alias to the @code{--fail-env-changed} option.

@item 
bpo-45701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45701}: Add tests with @code{tuple} type with @ref{a81,,functools.lru_cache()}
to @code{test_functools}.
@end itemize

@node Build<23>,Windows<23>,Tests<22>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id203}@anchor{187d}
@subsubsection Build



@itemize -

@item 
bpo-44035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44035}: CI now verifies that autoconf files have been regenerated with
a current and unpatched autoconf package.

@item 
bpo-45950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45950}: The build system now uses a @code{_bootstrap_python}
interpreter for freezing and deepfreezing again. To speed up build process
the build tools @code{_bootstrap_python} and @code{_freeze_module}
are no longer build with LTO.

@item 
bpo-45881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45881}: The @code{configure} script now accepts
@code{--with-build-python} and @code{--with-freeze-module} options to make cross
compiling easier.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Emscripten platform now uses @code{.wasm} suffix by default.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Disable unusable core extension modules on WASM/Emscripten
targets.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} now checks for socket @code{shutdown} function. The
check makes it possible to disable @code{SYS_shutdown} with
@code{ac_cv_func_shutdown=no} in CONFIG_SITE.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} now checks for functions @code{fork1, getegid,
geteuid, getgid, getppid, getuid, opendir, pipe, system, wait, ttyname}.

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: Update @code{config.guess} to 2021-06-03 and @code{config.sub} to
2021-08-14. @code{Makefile} now has an @code{update-config} target to make
updating more convenient.

@item 
bpo-45866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45866}: @code{make regen-all} now produces the same output when run from a
directory other than the source tree: when building Python out of the
source tree. pegen now strips directory of the «generated by pygen from
<FILENAME>» header Patch by Victor Stinner.

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} now accepts machine @code{wasm32} or @code{wasm64} and
OS @code{wasi} or @code{emscripten} for cross building, e.g.
@code{wasm32-unknown-emscripten}, @code{wasm32-wasi}, or
@code{wasm32-unknown-wasi}.

@item 
bpo-41498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41498}: Python now compiles on platforms without @code{sigset_t}. Several
functions in @ref{c6,,signal} are not available when @code{sigset_t} is missing.

Based on patch by Roman Yurchak for pyodide.

@item 
bpo-45881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45881}: @code{setup.py} now uses @code{CC} from environment first to discover
multiarch and cross compile paths.

@item 
bpo-45886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45886}: The @code{_freeze_module} program path can now be overridden on
the command line, e.g. @code{make
FREEZE_MODULE=../x86_64/Program/_freeze_module}.

@item 
bpo-45873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45873}: Get rid of the @code{_bootstrap_python} build step. The
deepfreeze.py script is now run using @code{$(PYTHON_FOR_REGEN)} which can be
Python 3.7 or newer (on Windows, 3.8 or newer).

@item 
bpo-45847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45847}: Port builtin hashlib extensions to @code{PY_STDLIB_MOD} macro and
@code{addext()}.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: Add @code{autoconf} helpers for saving and restoring environment
variables:


@itemize *

@item 
@code{SAVE_ENV}: Save @code{$CFLAGS}, @code{$LDFLAGS}, @code{$LIBS}, and
@code{$CPPFLAGS}.

@item 
@code{RESTORE_ENV}: Restore @code{$CFLAGS}, @code{$LDFLAGS}, @code{$LIBS}, and
@code{$CPPFLAGS}.

@item 
@code{WITH_SAVE_ENV([SCRIPT])}: Run @code{SCRIPT} wrapped with @code{SAVE_ENV} and
@code{RESTORE_ENV}.
@end itemize

Patch by Erlend E. Aasland.

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: Mandatory core modules, that are required to bootstrap Python,
are now in @code{Modules/Setup.bootstrap}.

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: @code{configure} now creates @code{Modules/Setup.stdlib} with
conditionally enabled/disabled extension module lines. The file is not
used, yet.

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: @code{configure} now uses a unified format to set state, compiler
flags, and linker flags in Makefile. The new macro @code{PY_STDLIB_MOD} sets
three variables that are consumed by @code{Modules/Setup} and @code{setup.py}.

@item 
bpo-45816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45816}: Python now supports building with Visual Studio 2022 (MSVC
v143, VS Version 17.0). Patch by Jeremiah Vivian.

@item 
bpo-45800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45800}: Settings for @code{pyexpat} C extension are now detected by
@code{configure}. The bundled @code{expat} library is built in @code{Makefile}.

@item 
bpo-45798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45798}: Settings for @ref{37,,decimal} internal C extension are now
detected by @code{configure}. The bundled @code{libmpdec} library is built in
@code{Makefile}.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure} has a new option @code{--with-pkg-config} to
disable or require pkg-config.

@item 
bpo-45774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45774}: The build dependencies for @ref{cf,,sqlite3} are now detected by
@code{configure} and @code{pkg-config}. Patch by Erlend E. Aasland.

@item 
bpo-45763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45763}: The build dependencies for @ref{132,,zlib}, @ref{14,,bz2}, and
@ref{8a,,lzma} are now detected by @code{configure}.

@item 
bpo-45747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45747}: gdbm and dbm build dependencies are now detected by
@code{configure}.

@item 
bpo-45743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45743}: On macOS, the build system no longer passes
@code{search_paths_first} to the linker. The flag has been the default since
Xcode 4 / macOS 10.6.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure.ac} is now compatible with autoconf 2.71.
Deprecated checks @code{STDC_HEADERS} and @code{AC_HEADER_TIME} have been
removed.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure} now prints a warning when pkg-config is missing.

@item 
bpo-45731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45731}: @code{configure --enable-loadable-sqlite-extensions} is now
handled by new @code{PY_SQLITE_ENABLE_LOAD_EXTENSION} macro instead of logic
in setup.py.

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: configure.ac now uses custom helper macros and
@code{AC_CACHE_CHECK} to simplify and speed up configure runs.

@item 
bpo-45696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45696}: Skip the marshal step for frozen modules by generating C code
that produces a set of ready-to-use code objects. This speeds up startup
time by another 10% or more.

@item 
bpo-45561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45561}: Run smelly.py tool from $(srcdir).
@end itemize

@node Windows<23>,macOS<18>,Build<23>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id204}@anchor{187e}
@subsubsection Windows



@itemize -

@item 
bpo-46105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46105}: Fixed calculation of @ref{27e,,sys.path} in a venv on Windows.

@item 
bpo-45901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45901}: When installed through the Microsoft Store and set as the
default app for @code{*.py} files, command line arguments will now be
passed to Python when invoking a script without explicitly launching
Python (that is, @code{script.py args} rather than @code{python script.py
args}).

@item 
bpo-45616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45616}: Fix Python Launcher’s ability to distinguish between versions
3.1 and 3.10 when either one is explicitly requested.  Previously, 3.1
would be used if 3.10 was requested but not installed, and 3.10 would be
used if 3.1 was requested but 3.10 was installed.

@item 
bpo-45850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45850}: Implement changes to build with deep-frozen modules on Windows.
Note that we now require Python 3.10 as the «bootstrap» or «host» Python.

@item 
bpo-45732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45732}: Updates bundled Tcl/Tk to 8.6.12.

@item 
bpo-45720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45720}: Internal reference to @code{shlwapi.dll} was dropped to help
improve startup time. This DLL will no longer be loaded at the start of
every Python process.
@end itemize

@node macOS<18>,C API<22>,Windows<23>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id205}@anchor{187f}
@subsubsection macOS



@itemize -

@item 
bpo-45732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45732}: Update python.org macOS installer to use Tcl/Tk 8.6.12.
@end itemize

@node C API<22>,,macOS<18>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id206}@anchor{1880}
@subsubsection C API



@itemize -

@item 
bpo-39026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39026}: Fix Python.h to build C extensions with Xcode: remove a
relative include from @code{Include/cpython/pystate.h}.
@end itemize

@node Python 3 11 0 alpha 2,Python 3 11 0 alpha 1,Python 3 11 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-2}@anchor{1881}
@subsection Python 3.11.0 alpha 2


`Release date: 2021-11-05'

@menu
* Core and Builtins: Core and Builtins<24>. 
* Library: Library<24>. 
* Documentation: Documentation<23>. 
* Tests: Tests<23>. 
* Build: Build<24>. 
* Windows: Windows<24>. 
* macOS: macOS<19>. 
* IDLE: IDLE<14>. 
* C API: C API<23>. 

@end menu

@node Core and Builtins<24>,Library<24>,,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id207}@anchor{1882}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-45716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45716}: Improve the @ref{150,,SyntaxError} message when using @code{True},
@code{None} or @code{False} as keywords in a function call. Patch by Pablo
Galindo.

@item 
bpo-45688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45688}: @ref{8d8,,sys.stdlib_module_names} now contains the macOS-specific
module @code{_scproxy}.

@item 
bpo-45379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45379}: Clarify @ref{4d7,,ImportError} message when we try to explicitly
import a frozen module but frozen modules are disabled.

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: Specialize simple calls to Python functions (no starargs,
keyword dict, or closure)

@item 
bpo-45530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45530}: Cases of sorting using tuples as keys may now be significantly
faster in some cases. Patch by Tim Peters.

The order of the result may differ from earlier releases if the tuple
elements don’t define a total ordering (see
@ref{1883,,Comparaciones de valor} for information on total ordering).
It’s generally true that the result of sorting simply isn’t well-defined
in the absence of a total ordering on list elements.

@item 
bpo-45526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45526}: In obmalloc, set ADDRESS_BITS to not ignore any bits (ignored
16 before). That is safer in the case that the kernel gives user-space
virtual addresses that span a range greater than 48 bits.

@item 
bpo-30570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30570}: Fixed a crash in @code{issubclass()} from infinite recursion when
searching pathological @code{__bases__} tuples.

@item 
bpo-45521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45521}: Fix a bug in the obmalloc radix tree code.  On 64-bit machines,
the bug causes the tree to hold 46-bits of virtual addresses, rather than
the intended 48-bits.

@item 
bpo-45494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45494}: Fix parser crash when reporting errors involving invalid
continuation characters. Patch by Pablo Galindo.

@item 
bpo-45445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45445}: Python now fails to initialize if it finds an invalid
@ref{2e2,,-X} option in the command line. Patch by Pablo Galindo.

@item 
bpo-45340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45340}: Object attributes are held in an array instead of a dictionary.
An object’s dictionary are created lazily, only when needed. Reduces the
memory consumption of a typical Python object by about 30%. Patch by Mark
Shannon.

@item 
bpo-45408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45408}: Fix a crash in the parser when reporting tokenizer errors that
occur at the same time unclosed parentheses are detected. Patch by Pablo
Galindo.

@item 
bpo-29410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29410}: Add SipHash13 for string hash algorithm and use it by default.

@item 
bpo-45385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45385}: Fix reference leak from descr_check. Patch by Donghee Na.

@item 
bpo-45367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45367}: Specialized the @code{BINARY_MULTIPLY} opcode to
@code{BINARY_MULTIPLY_INT} and @code{BINARY_MULTIPLY_FLOAT} using the PEP 659
machinery.

@item 
bpo-21736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21736}: Frozen stdlib modules now have @code{__file__} to the .py file
they would otherwise be loaded from, if possible.  For packages,
@code{__path__} now has the correct entry instead of being an empty list,
which allows unfrozen submodules to be imported.  These are set only if
the stdlib directory is known when the runtime is initialized.  Note that
the file at @code{__file__} is not guaranteed to exist.  None of this affects
non-stdlib frozen modules nor, for now, frozen modules imported using
@code{PyImport_ImportFrozenModule()}.  Also, at the moment @code{co_filename} is
not updated for the module.

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: For frozen stdlib modules, record the original module name as
@code{module.__spec__.loader_state.origname}.  If the value is different than
@code{module.__spec__.name} then the module was defined as an alias in
Tools/scripts/freeze_modules.py.  If it is @code{None} then the module comes
from a source file outside the stdlib.

@item 
bpo-45324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45324}: In FrozenImporter.find_spec(), we now preserve the information
needed in exec_module() to load the module.  This change mostly impacts
internal details, rather than changing the importer’s behavior.

@item 
bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}: Implement 
@geindex Python Enhancement Proposals; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}. Add @ref{31d,,ExceptionGroup} and
@ref{3b6,,BaseExceptionGroup}. Update traceback display code.

@item 
bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}: Change to the implementation of split dictionaries. Classes
where the instances differ either in the exact set of attributes, or in
the order in which those attributes are set, can still share keys. This
should have no observable effect on users of Python or the C-API. Patch by
Mark Shannon.

@item 
bpo-44050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44050}: Extensions that indicate they use global state (by setting
@code{m_size} to -1) can again be used in multiple interpreters. This reverts
to behavior of Python 3.8.

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: Setup initial specialization infrastructure for the
@code{CALL_FUNCTION} opcode. Implemented initial specializations for C
function calls:


@itemize *

@item 
@code{CALL_FUNCTION_BUILTIN_O} for @code{METH_O} flag.

@item 
@code{CALL_FUNCTION_BUILTIN_FAST} for @code{METH_FASTCALL} flag without keywords.

@item 
@code{CALL_FUNCTION_LEN} for @code{len(o)}.

@item 
@code{CALL_FUNCTION_ISINSTANCE} for @code{isinstance(o, t)}.
@end itemize

@item 
bpo-44511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44511}: Improve the generated bytecode for class and mapping patterns.

@item 
bpo-43706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43706}: Speed up calls to @code{enumerate()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.
@end itemize

@node Library<24>,Documentation<23>,Core and Builtins<24>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id208}@anchor{1884}
@subsubsection Library



@itemize -

@item 
bpo-45679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45679}: Fix caching of multi-value @ref{8ec,,typing.Literal}.
@code{Literal[True, 2]} is no longer equal to @code{Literal[1, 2]}.

@item 
bpo-42064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42064}: Convert @ref{cf,,sqlite3} to multi-phase initialisation (PEP 489).
Patches by Erlend E. Aasland.

@item 
bpo-45438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45438}: Fix typing.Signature string representation for generic builtin
types.

@item 
bpo-45613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45613}: @ref{cf,,sqlite3} now sets @ref{71d,,sqlite3.threadsafety} based on
the default threading mode the underlying SQLite library has been compiled
with. Patch by Erlend E. Aasland.

@item 
bpo-45574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45574}: Fix warning about @code{print_escape} being unused.

@item 
bpo-45581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45581}: @ref{3f5,,sqlite3.connect()} now correctly raises @ref{16cb,,MemoryError}
if the underlying SQLite API signals memory error. Patch by Erlend E.
Aasland.

@item 
bpo-45557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45557}: @ref{8bf,,pprint.pprint()} now handles `underscore_numbers'
correctly. Previously it was always setting it to @code{False}.

@item 
bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}: Add @ref{1885,,operator.call()} to @code{operator.__all__}. Patch by
Kreusada.

@item 
bpo-42174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42174}: @ref{1175,,shutil.get_terminal_size()} now falls back to sane values
if the column or line count are 0.

@item 
bpo-35673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35673}: Improve the introspectability of the @code{__loader__} attribute
for namespace packages.  @ref{fd6,,importlib.machinery.NamespaceLoader} is
now public, and implements the @ref{fd4,,importlib.abc.InspectLoader}
interface. @code{_NamespaceLoader} is kept for backward compatibility.

@item 
bpo-45515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45515}: Add references to @ref{133,,zoneinfo} in the @ref{31,,datetime}
documentation, mostly replacing outdated references to @code{dateutil.tz}.
Change by Paul Ganssle.

@item 
bpo-45475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45475}: Reverted optimization of iterating @ref{4d8,,gzip.GzipFile},
@ref{8fd,,bz2.BZ2File}, and @ref{1088,,lzma.LZMAFile} (see bpo-43787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43787}) because
it caused regression when user iterate them without having reference of
them. Patch by Inada Naoki.

@item 
bpo-45489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45489}: Update @ref{184a,,ForwardRef} to support @code{|} operator.
Patch by Donghee Na.

@item 
bpo-42222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42222}: Removed deprecated support for float arguments in
`randrange()'.

@item 
bpo-45428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45428}: Fix a regression in py_compile when reading filenames from
standard input.

@item 
bpo-45467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45467}: Fix incremental decoder and stream reader in the
«raw-unicode-escape» codec. Previously they failed if the escape sequence
was split.

@item 
bpo-45461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45461}: Fix incremental decoder and stream reader in the
«unicode-escape» codec. Previously they failed if the escape sequence was
split.

@item 
bpo-45239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45239}: Fixed @ref{1886,,email.utils.parsedate_tz()} crashing with
@ref{1576,,UnboundLocalError} on certain invalid input instead of returning
@code{None}. Patch by Ben Hoyt.

@item 
bpo-45417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45417}: Fix quadratic behaviour in the enum module: Creation of enum
classes with a lot of entries was quadratic.

@item 
bpo-45249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45249}: Fix the behaviour of @ref{1887,,traceback.print_exc()} when
displaying the caret when the @code{end_offset} in the exception is set to 0.
Patch by Pablo Galindo

@item 
bpo-45416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45416}: Fix use of @ref{b02,,asyncio.Condition} with explicit
@ref{b00,,asyncio.Lock} objects, which was a regression due to removal of
explicit loop arguments. Patch by Joongi Kim.

@item 
bpo-20028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20028}: Empty escapechar/quotechar is not allowed when initializing
@ref{1686,,csv.Dialect}. Patch by Vajrasky Kok and Donghee Na.

@item 
bpo-44904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44904}: Fix bug in the @ref{3b,,doctest} module that caused it to fail if
a docstring included an example with a @code{classmethod} @code{property}. Patch
by Alex Waygood.

@item 
bpo-45406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45406}: Make @ref{17eb,,inspect.getmodule()} catch @code{FileNotFoundError}
raised by @code{inspect.getabsfile()}, and return @code{None} to indicate that
the module could not be determined.

@item 
bpo-45411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45411}: Add extensions for files containing subtitles - .srt & .vtt -
to the mimetypes.py module.

@item 
bpo-10716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10716}: Migrated pydoc to HTML5 (without changing the look of it). Side
effect is to update xmlrpc’s @code{ServerHTMLDoc} which now uses the CSS too.
cgitb now relies less on pydoc (as it can’t use the CSS file).

@item 
bpo-27580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27580}: Add support of null characters in @ref{2a,,csv}.

@item 
bpo-45262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45262}: Prevent use-after-free in asyncio. Make sure the cached running
loop holder gets cleared on dealloc to prevent use-after-free in
get_running_loop

@item 
bpo-45386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45386}: Make @ref{12d,,xmlrpc.client} more robust to C runtimes where the
underlying C @code{strftime} function results in a @code{ValueError} when
testing for year formatting options.

@item 
bpo-20028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20028}: Improve error message of @ref{1686,,csv.Dialect} when
initializing. Patch by Vajrasky Kok and Donghee Na.

@item 
bpo-45343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45343}: Update bundled pip to 21.2.4 and setuptools to 58.1.0

@item 
bpo-45328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45328}: Fixed @ref{bc8,,http.client.HTTPConnection} to work properly in
OSs that don’t support the @code{TCP_NODELAY} socket option.

@item 
bpo-45243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45243}: Add @ref{71b,,setlimit()} and
@ref{71c,,getlimit()} to @ref{39e,,sqlite3.Connection} for
setting and getting SQLite limits by connection basis. Patch by Erlend E.
Aasland.

@item 
bpo-45320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45320}: Removed from the @ref{7e,,inspect} module:


@itemize *

@item 

@table @asis

@item the @code{getargspec} function, deprecated since Python 3.0;

use @ref{181,,inspect.signature()} or @ref{7d4,,inspect.getfullargspec()} instead.
@end table

@item 
the @code{formatargspec} function, deprecated since Python 3.5;
use the @ref{181,,inspect.signature()} function and @code{Signature} object
directly.

@item 
the undocumented @code{Signature.from_builtin} and @code{Signature.from_function}
functions, deprecated since Python 3.5; use the
@ref{7d5,,Signature.from_callable()} method
instead.
@end itemize

Patch by Hugo van Kemenade.

@item 
bpo-45192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45192}: Fix the @code{tempfile._infer_return_type} function so that the
@code{dir} argument of the @ref{e0,,tempfile} functions accepts an object
implementing the @code{os.PathLike} protocol.

Patch by Kyungmin Lee.

@item 
bpo-45160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45160}: When tracing a tkinter variable used by a ttk OptionMenu,
callbacks are no longer made twice.

@item 
bpo-25625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25625}: Added non parallel-safe @ref{6ad,,chdir()} context
manager to change the current working directory and then restore it on
exit. Simple wrapper around @ref{6ae,,chdir()}.

@item 
bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139}: Add support for SQLite extended result codes in
@ref{1888,,sqlite3.Error}. Patch by Erlend E. Aasland.

@item 
bpo-24444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24444}: Fixed an error raised in @ref{7,,argparse} help display when help
for an option is set to 1+ blank spaces or when `choices' arg is an empty
container.

@item 
bpo-44547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44547}: Implement @code{Fraction.__int__}, so that a
@ref{177,,fractions.Fraction} instance @code{f} passes an @code{isinstance(f,
typing.SupportsInt)} check.

@item 
bpo-40321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40321}: Adds support for HTTP 308 redirects to @ref{108,,urllib}. See
@geindex RFC; RFC 7538
RFC 7538@footnote{https://datatracker.ietf.org/doc/html/rfc7538.html} for details. Patch by Jochem Schulenklopper.

@item 
bpo-41374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41374}: Ensure that @code{socket.TCP_*} constants are exposed on Cygwin
3.1.6 and greater.

@item 
bpo-35970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35970}: Add help flag to the base64 module’s command line interface.
Patch contributed by Robert Kuska.
@end itemize

@node Documentation<23>,Tests<23>,Library<24>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id209}@anchor{1889}
@subsubsection Documentation



@itemize -

@item 
bpo-45726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45726}: Improve documentation for @ref{6da,,functools.singledispatch()} and
@ref{a82,,functools.singledispatchmethod}.

@item 
bpo-45680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45680}: Amend the docs on @code{GenericAlias} objects to clarify that
non-container classes can also implement @code{__class_getitem__}. Patch
contributed by Alex Waygood.

@item 
bpo-45618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45618}: Update Sphinx version used to build the documentation to 4.2.0.
Patch by Maciej Olko.

@item 
bpo-45655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45655}: Add a new «relevant PEPs» section to the top of the
documentation for the @code{typing} module. Patch by Alex Waygood.

@item 
bpo-45604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45604}: Add @code{level} argument to @code{multiprocessing.log_to_stderr}
function docs.

@item 
bpo-45516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45516}: Add protocol description to the
@ref{188a,,importlib.abc.TraversableResources} documentation.

@item 
bpo-45464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45464}: Mention in the documentation of @ref{188b,,Built-in Exceptions} that inheriting from multiple exception types in a
single subclass is not recommended due to possible memory layout
incompatibility.

@item 
bpo-45449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45449}: Add note about 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} in @ref{1f,,collections.abc}.

@item 
bpo-45516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45516}: Add protocol description to the
@ref{188c,,importlib.abc.Traversable} documentation.

@item 
bpo-20692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20692}: Add Programming FAQ entry explaining that int literal attribute
access requires either a space after or parentheses around the literal.
@end itemize

@node Tests<23>,Build<24>,Documentation<23>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id210}@anchor{188d}
@subsubsection Tests



@itemize -

@item 
bpo-45678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45678}: Add tests for scenarios in which
@ref{a82,,functools.singledispatchmethod} is stacked on top of a method that
has already been wrapped by two other decorators. Patch by Alex Waygood.

@item 
bpo-45578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45578}: Add tests for @ref{173,,dis.distb()}

@item 
bpo-45678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45678}: Add tests to ensure that @code{functools.singledispatchmethod}
correctly wraps the attributes of the target function.

@item 
bpo-45668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45668}: PGO tests now pass when Python is built without test extension
modules.

@item 
bpo-45577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45577}: Add subtests for all @code{pickle} protocols in @code{test_zoneinfo}.

@item 
bpo-45566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45566}: Fix @code{test_frozen_pickle} in @code{test_dataclasses} to check all
@code{pickle} versions.

@item 
bpo-43592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43592}: @code{test.libregrtest} now raises the soft resource limit for
the maximum number of file descriptors when the default is too low for our
test suite as was often the case on macOS.

@item 
bpo-39679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39679}: Add more test cases for @code{@@functools.singledispatchmethod}
when combined with @code{@@classmethod} or @code{@@staticmethod}.

@item 
bpo-45410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45410}: When libregrtest spawns a worker process, stderr is now written
into stdout to keep messages order. Use a single pipe for stdout and
stderr, rather than two pipes. Previously, messages were out of order
which made analysis of buildbot logs harder Patch by Victor Stinner.

@item 
bpo-45402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45402}: Fix test_tools.test_sundry() when Python is built out of tree:
fix how the freeze_modules.py tool locates the _freeze_module program.
Patch by Victor Stinner.

@item 
bpo-45403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45403}: Fix test_sys.test_stdlib_dir() when Python is built outside the
source tree: compare normalized paths. Patch by Victor Stinner.

@item 
bpo-45400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45400}: Fix
test_name_error_suggestions_do_not_trigger_for_too_many_locals() of
test_exceptions if a directory name contains «a1» (like
«Python-3.11.0a1»): use a stricter regular expression. Patch by Victor
Stinner.

@item 
bpo-10572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10572}: Rename @ref{cf,,sqlite3} tests from @code{test_sqlite} to
@code{test_sqlite3}, and relocate them to @code{Lib/test/test_sqlite3}. Patch by
Erlend E. Aasland.
@end itemize

@node Build<24>,Windows<24>,Tests<23>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id211}@anchor{188e}
@subsubsection Build



@itemize -

@item 
bpo-43158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43158}: @code{setup.py} now uses values from configure script to build the
@code{_uuid} extension module. Configure now detects util-linux’s
@code{libuuid}, too.

@item 
bpo-45666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45666}: Fix warning of @code{swprintf} and @code{%s} usage in
@code{_testembed.c}

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: @code{Modules/Setup} and @code{Modules/makesetup} have been improved.
The @code{Setup} file now contains working rules for all extensions. Outdated
comments have been removed. Rules defined by @code{makesetup} track
dependencies correctly.

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: The @ref{8e,,math} and @ref{19,,cmath} implementation now require a
C99 compatible @code{libm} and no longer ship with workarounds for missing
acosh, asinh, atanh, expm1, and log1p functions.

@item 
bpo-45595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45595}: @code{setup.py} and @code{makesetup} now track build dependencies on
all Python header files and module specific header files.

@item 
bpo-45571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45571}: @code{Modules/Setup} now use @code{PY_CFLAGS_NODIST} instead of
@code{PY_CFLAGS} to compile shared modules.

@item 
bpo-45570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45570}: @code{pyexpat} and @code{_elementtree} no longer define
obsolete macros @code{HAVE_EXPAT_CONFIG_H} and @code{USE_PYEXPAT_CAPI}.
@code{XML_POOR_ENTROPY} is now defined in @code{expat_config.h}.

@item 
bpo-43974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43974}: @code{setup.py} no longer defines @code{Py_BUILD_CORE_MODULE}.
Instead every module, that uses the internal API, defines the macro.

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: Fill in missing entries in Modules/Setup.

@item 
bpo-45532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45532}: Update @ref{2e4,,sys.version} to use @code{main} as fallback
information. Patch by Jeong YunWon.

@item 
bpo-45536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45536}: The @code{configure} script now checks whether OpenSSL headers and
libraries provide required APIs. Most common APIs are verified. The check
detects outdated or missing OpenSSL. Failures do not stop configure.

@item 
bpo-45221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45221}: Fixed regression in handling of @code{LDFLAGS} and @code{CPPFLAGS}
options where @code{argparse.parse_known_args()} could interpret an option
as one of the built-in command line argument, for example @code{-h} for help.

@item 
bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}: Building Python now requires a C99 @code{<math.h>} header file
providing the following functions: @code{copysign()}, @code{hypot()},
@code{isfinite()}, @code{isinf()}, @code{isnan()}, @code{round()}. Patch by Victor
Stinner.

@item 
bpo-45405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45405}: Prevent @code{internal configure error} when running @code{configure}
with recent versions of non-Apple clang.  Patch by David Bohman.

@item 
bpo-45433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45433}: Avoid linking libpython with libcrypt.
@end itemize

@node Windows<24>,macOS<19>,Build<24>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id212}@anchor{188f}
@subsubsection Windows



@itemize -

@item 
bpo-43652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43652}: Update Tcl/Tk to 8.6.11, actually this time. The previous
update incorrectly included 8.6.10.

@item 
bpo-45337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45337}: venv now warns when the created environment may need to be
accessed at a different path, due to redirections, links or junctions. It
also now correctly installs or upgrades components when the alternate path
is required.

@item 
bpo-43851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43851}: Build SQLite @code{SQLITE_OMIT_AUTOINIT} on Windows. Patch by
Erlend E. Aasland.
@end itemize

@node macOS<19>,IDLE<14>,Windows<24>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id213}@anchor{1890}
@subsubsection macOS



@itemize -

@item 
bpo-44828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44828}: Avoid tkinter file dialog failure on macOS 12 Monterey when
using the Tk 8.6.11 provided by python.org macOS installers. Patch by Marc
Culler of the Tk project.
@end itemize

@node IDLE<14>,C API<23>,macOS<19>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id214}@anchor{1891}
@subsubsection IDLE



@itemize -

@item 
bpo-45495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45495}: Add context keywords “case” and “match” to completions list.
@end itemize

@node C API<23>,,IDLE<14>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id215}@anchor{1892}
@subsubsection C API



@itemize -

@item 
bpo-29103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29103}: @ref{5f4,,PyType_FromSpec*} now
copies the class name from the spec to a buffer owned by the class, so the
original can be safely deallocated. Patch by Petr Viktorin.

@item 
bpo-45522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45522}: The internal freelists for frame, float, list, dict, async
generators, and context objects can now be disabled.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: Exclude @ref{275,,PyWeakref_GET_OBJECT()} from the limited C API.
It never worked since the @code{PyWeakReference} structure is opaque
in the limited C API.

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: Move the @code{interpreteridobject.h} header file from
@code{Include/} to @code{Include/internal/}. It only provides private functions.
Patch by Victor Stinner.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: The non-limited API files @code{cellobject.h}, @code{classobject.h},
@code{context.h}, @code{funcobject.h}, @code{genobject.h} and @code{longintrepr.h}
have been moved to the @code{Include/cpython} directory. Moreover, the
@code{eval.h} header file was removed. These files must not be included
directly, as they are already included in @code{Python.h}: @ref{81d,,Include Files}. If they have been included directly, consider
including @code{Python.h} instead. Patch by Victor Stinner.

@item 
bpo-45474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45474}: The following items are no longer available when
@code{Py_LIMITED_API} is defined:


@itemize *

@item 
@ref{82f,,PyMarshal_WriteLongToFile()}

@item 
@ref{830,,PyMarshal_WriteObjectToFile()}

@item 
@ref{831,,PyMarshal_ReadObjectFromString()}

@item 
@ref{832,,PyMarshal_WriteObjectToString()}

@item 
the @code{Py_MARSHAL_VERSION} macro
@end itemize

These are not part of the @ref{833,,limited API}.

Patch by Victor Stinner.

@item 
bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}: Remove the @code{pystrhex.h} header file. It only contains private
functions. C extensions should only include the main @code{<Python.h>} header
file. Patch by Victor Stinner.

@item 
bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}: Remove the @code{Py_FORCE_DOUBLE()} macro. It was used by the
@code{Py_IS_INFINITY()} macro. Patch by Victor Stinner.

@item 
bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}: @code{<Python.h>} no longer includes the header files
@code{<stdlib.h>}, @code{<stdio.h>}, @code{<errno.h>} and @code{<string.h>} when the
@code{Py_LIMITED_API} macro is set to @code{0x030b0000} (Python 3.11) or higher.
C extensions should explicitly include the header files after @code{#include
<Python.h>}. Patch by Victor Stinner.

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: Remove @code{Py_UNICODE_COPY()} and @code{Py_UNICODE_FILL()} macros,
deprecated since Python 3.3. Use @code{PyUnicode_CopyCharacters()} or
@code{memcpy()} (@code{wchar_t*} string), and @code{PyUnicode_Fill()} functions
instead. Patch by Victor Stinner.

@item 
bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}: Remove the following math macros using the @code{errno} variable:


@itemize *

@item 
@code{Py_ADJUST_ERANGE1()}

@item 
@code{Py_ADJUST_ERANGE2()}

@item 
@code{Py_OVERFLOWED()}

@item 
@code{Py_SET_ERANGE_IF_OVERFLOW()}

@item 
@code{Py_SET_ERRNO_ON_MATH_ERROR()}
@end itemize

Patch by Victor Stinner.

@item 
bpo-45395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45395}: Custom frozen modules (the array set to
@code{PyImport_FrozenModules}) are now treated as additions, rather than
replacing all the default frozen modules. Frozen stdlib modules can still
be disabled by setting the «code» field of the custom array entry to NULL.

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: Add new @ref{7ee,,PyThreadState_EnterTracing()}, and
@ref{7ef,,PyThreadState_LeaveTracing()} functions to the limited C API to
suspend and resume tracing and profiling. Patch by Victor Stinner.

@item 
bpo-44220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44220}: @ref{a14,,PyStructSequence_UnnamedField} is added to the Stable
ABI.
@end itemize

@node Python 3 11 0 alpha 1,Python 3 10 0 beta 1,Python 3 11 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-11-0-alpha-1}@anchor{1893}
@subsection Python 3.11.0 alpha 1


`Release date: 2021-10-05'

@menu
* Security: Security<15>. 
* Core and Builtins: Core and Builtins<25>. 
* Library: Library<25>. 
* Documentation: Documentation<24>. 
* Tests: Tests<24>. 
* Build: Build<25>. 
* Windows: Windows<25>. 
* macOS: macOS<20>. 
* IDLE: IDLE<15>. 
* Tools/Demos: Tools/Demos<14>. 
* C API: C API<24>. 

@end menu

@node Security<15>,Core and Builtins<25>,,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id216}@anchor{1894}
@subsubsection Security



@itemize -

@item 
bpo-42278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42278}: Replaced usage of @ref{1895,,tempfile.mktemp()} with
@ref{12a1,,TemporaryDirectory} to avoid a potential race condition.

@item 
bpo-44600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44600}: Fix incorrect line numbers while tracing some failed patterns
in @ref{8a4,,match} statements. Patch by Charles Burkland.

@item 
bpo-41180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41180}: Add auditing events to the @ref{8d,,marshal} module, and stop
raising @code{code.__init__} events for every unmarshalled code object.
Directly instantiated code objects will continue to raise an event, and
audit event handlers should inspect or collect the raw marshal data. This
reduces a significant performance overhead when loading from @code{.pyc}
files.

@item 
bpo-44394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44394}: Update the vendored copy of libexpat to 2.4.1 (from 2.2.8) to
get the fix for the 
@geindex Common Vulnerabilities and Exposures; CVE 2013-0340
CVE 2013-0340@footnote{https://www.cve.org/CVERecord?id=CVE-2013-0340} «Billion Laughs» vulnerability. This
copy is most used on Windows and macOS.

@item 
bpo-43124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43124}: Made the internal @code{putcmd} function in @ref{ca,,smtplib}
sanitize input for presence of @code{\r} and @code{\n} characters to avoid
(unlikely) command injection.

@item 
bpo-44022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44022}: @ref{6f,,http.client} now avoids infinitely reading potential HTTP
headers after a @code{100 Continue} status response from the server.
@end itemize

@node Core and Builtins<25>,Library<25>,Security<15>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id217}@anchor{1896}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: The number of hardware branches per instruction dispatch is
reduced from two to one by adding a special instruction for tracing. Patch
by Mark Shannon.

@item 
bpo-45061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45061}: Add a deallocator to the bool type to detect refcount bugs in C
extensions which call Py_DECREF(Py_True) or Py_DECREF(Py_False) by
mistake. Detect also refcount bugs when the empty tuple singleton or the
Unicode empty string singleton is destroyed by mistake. Patch by Victor
Stinner.

@item 
bpo-24076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24076}: sum() was further optimised for summing up single digit
integers.

@item 
bpo-45190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45190}: Update Unicode databases to Unicode 14.0.0.

@item 
bpo-45167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45167}: Fix deepcopying of @ref{882,,types.GenericAlias} objects.

@item 
bpo-45155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45155}: @ref{1897,,int.to_bytes()} and @ref{1857,,int.from_bytes()} now take a
default value of @code{"big"} for the @code{byteorder} argument.
@ref{1897,,int.to_bytes()} also takes a default value of @code{1} for the
@code{length} argument.

@item 
bpo-44219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44219}: Release the GIL while performing @code{isatty} system calls on
arbitrary file descriptors. In particular, this affects @ref{1898,,os.isatty()},
@ref{1899,,os.device_encoding()} and @ref{854,,io.TextIOWrapper}. By extension,
@ref{5c0,,io.open()} in text mode is also affected. This change solves a
deadlock in @ref{1898,,os.isatty()}. Patch by Vincent Michel in bpo-44219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44219}.

@item 
bpo-44959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44959}: Added fallback to extension modules with “.sl” suffix on HP-UX

@item 
bpo-45121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45121}: Fix issue where @code{Protocol.__init__} raises @code{RecursionError}
when it’s called directly or via @code{super()}. Patch provided by Yurii
Karabas.

@item 
bpo-44348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44348}: The deallocator function of the @ref{65c,,BaseException} type now
uses the trashcan mechanism to prevent stack overflow. For example, when a
@ref{df1,,RecursionError} instance is raised, it can be linked to another
RecursionError through the @code{__context__} attribute or the
@code{__traceback__} attribute, and then a chain of exceptions is created.
When the chain is destroyed, nested deallocator function calls can crash
with a stack overflow if the chain is too long compared to the available
stack memory. Patch by Victor Stinner.

@item 
bpo-45123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45123}: Fix PyAiter_Check to only check for the __anext__ presence (not
for __aiter__). Rename PyAiter_Check to PyAIter_Check, PyObject_GetAiter
-> PyObject_GetAIter.

@item 
bpo-1514420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1514420}: Interpreter no longer attempts to open files with names in
angle brackets (like «<string>» or «<stdin>») when formatting an
exception.

@item 
bpo-41031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41031}: Match C and Python code formatting of unprintable exceptions
and exceptions in the @ref{1,,__main__} module.

@item 
bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: @ref{1be,,open()}, @ref{5c0,,io.open()}, @ref{7db,,codecs.open()} and
@ref{7d3,,fileinput.FileInput} no longer accept @code{'U'} («universal
newline») in the file mode. This flag was deprecated since Python 3.3.
Patch by Victor Stinner.

@item 
bpo-45083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45083}: When the interpreter renders an exception, its name now has a
complete qualname. Previously only the class name was concatenated to the
module name, which sometimes resulted in an incorrect full name being
displayed.

(This issue impacted only the C code exception rendering, the
@ref{fe,,traceback} module was using qualname already).

@item 
bpo-34561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34561}: List sorting now uses the merge-ordering strategy from Munro
and Wild’s @code{powersort()}. Unlike the former strategy, this is provably
near-optimal in the entropy of the distribution of run lengths. Most uses
of @code{list.sort()} probably won’t see a significant time difference, but
may see significant improvements in cases where the former strategy was
exceptionally poor. However, as these are all fast linear-time
approximations to a problem that’s inherently at best quadratic-time to
solve truly optimally, it’s also possible to contrive cases where the
former strategy did better.

@item 
bpo-45056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45056}: Compiler now removes trailing unused constants from co_consts.

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: Add a new command line option, «-X frozen_modules=[on|off]» to
opt out of (or into) using optional frozen modules.  This defaults to «on»
(or «off» if it’s running out of the source tree).

@item 
bpo-45012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45012}: In @ref{ad,,posix}, release GIL during @code{stat()}, @code{lstat()},
and @code{fstatat()} syscalls made by @ref{1700,,os.DirEntry.stat()}. Patch by
Stanisław Skonieczny.

@item 
bpo-45018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45018}: Fixed pickling of range iterators that iterated for over
@code{2**32} times.

@item 
bpo-45000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45000}: A @ref{150,,SyntaxError} is now raised when trying to delete
@ref{871,,__debug__}. Patch by Donghee Na.

@item 
bpo-44963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44963}: Implement @code{send()} and @code{throw()} methods for
@code{anext_awaitable} objects. Patch by Pablo Galindo.

@item 
bpo-44962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44962}: Fix a race in WeakKeyDictionary, WeakValueDictionary and
WeakSet when two threads attempt to commit the last pending removal. This
fixes asyncio.create_task and fixes a data loss in asyncio.run where
shutdown_asyncgens is not run

@item 
bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}: Implement the @code{__bytes__()} special method on the
@ref{325,,bytes} type, so a bytes object @code{b}  passes an @code{isinstance(b,
typing.SupportsBytes)} check.

@item 
bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}: Implement the @code{__complex__()} special method on the
@ref{154,,complex} type, so a complex number @code{z} passes an @code{isinstance(z,
typing.SupportsComplex)} check.

@item 
bpo-44954@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44954}: Fixed a corner case bug where the result of
@code{float.fromhex('0x.8p-1074')} was rounded the wrong way.

@item 
bpo-44947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44947}: Refine the syntax error for trailing commas in import
statements. Patch by Pablo Galindo.

@item 
bpo-44945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44945}: Specialize the BINARY_ADD instruction using the PEP 659
machinery. Adds five new instructions:


@itemize *

@item 
BINARY_ADD_ADAPTIVE

@item 
BINARY_ADD_FLOAT

@item 
BINARY_ADD_INT

@item 
BINARY_ADD_UNICODE

@item 
BINARY_ADD_UNICODE_INPLACE_FAST
@end itemize

@item 
bpo-44929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44929}: Fix some edge cases of @code{enum.Flag} string representation in
the REPL. Patch by Pablo Galindo.

@item 
bpo-44914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44914}: Class version tags are no longer recycled.

This means that a version tag serves as a unique identifier for the state
of a class. We rely on this for effective specialization of the LOAD_ATTR
and other instructions.

@item 
bpo-44698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44698}: Restore behaviour of complex exponentiation with integer-valued
exponent of type @ref{153,,float} or @ref{154,,complex}.

@item 
bpo-44895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44895}: A debug variable 
@geindex PYTHONDUMPREFSFILE
@geindex variables de entorno; PYTHONDUMPREFSFILE
@ref{189a,,PYTHONDUMPREFSFILE} is added for
creating a dump file which is generated by @ref{487,,--with-trace-refs}.
Patch by Donghee Na.

@item 
bpo-44900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44900}: Add five superinstructions for PEP 659 quickening:


@itemize *

@item 
LOAD_FAST LOAD_FAST

@item 
STORE_FAST LOAD_FAST

@item 
LOAD_FAST LOAD_CONST

@item 
LOAD_CONST LOAD_FAST

@item 
STORE_FAST STORE_FAST
@end itemize

@item 
bpo-44889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44889}: Initial implementation of adaptive specialization of
@code{LOAD_METHOD}. The following specialized forms were added:


@itemize *

@item 
@code{LOAD_METHOD_CACHED}

@item 
@code{LOAD_METHOD_MODULE}

@item 
@code{LOAD_METHOD_CLASS}
@end itemize

@item 
bpo-44890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44890}: Specialization stats are always collected in debug builds.

@item 
bpo-44885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44885}: Correct the ast locations of f-strings with format specs and
repeated expressions. Patch by Pablo Galindo

@item 
bpo-44878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44878}: Remove the loop from the bytecode interpreter. All instructions
end with a DISPATCH macro, so the loop is now redundant.

@item 
bpo-44878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44878}: Remove switch statement for interpreter loop when using
computed gotos. This makes sure that we only have one dispatch table in
the interpreter.

@item 
bpo-44874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44874}: Deprecate the old trashcan macros
(@code{Py_TRASHCAN_SAFE_BEGIN}/@code{Py_TRASHCAN_SAFE_END}). They should be
replaced by the new macros @code{Py_TRASHCAN_BEGIN} and @code{Py_TRASHCAN_END}.

@item 
bpo-44872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44872}: Use new trashcan macros (Py_TRASHCAN_BEGIN/END) in
frameobject.c instead of the old ones (Py_TRASHCAN_SAFE_BEGIN/END).

@item 
bpo-33930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33930}: Fix segmentation fault with deep recursion when cleaning method
objects. Patch by Augusto Goulart and Pablo Galindo.

@item 
bpo-25782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25782}: Fix bug where @code{PyErr_SetObject} hangs when the current
exception has a cycle in its context chain.

@item 
bpo-44856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44856}: Fix reference leaks in the error paths of @code{update_bases()}
and @code{__build_class__}. Patch by Pablo Galindo.

@item 
bpo-44826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44826}: Initial implementation of adaptive specialization of STORE_ATTR

Three specialized forms of STORE_ATTR are added:


@itemize *

@item 
STORE_ATTR_SLOT

@item 
STORE_ATTR_SPLIT_KEYS

@item 
STORE_ATTR_WITH_HINT
@end itemize

@item 
bpo-44838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44838}: Fixed a bug that was causing the parser to raise an incorrect
custom @ref{150,,SyntaxError} for invalid “if” expressions. Patch by Pablo
Galindo.

@item 
bpo-44821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44821}: Create instance dictionaries (__dict__) eagerly, to improve
regularity of object layout and assist specialization.

@item 
bpo-44792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44792}: Improve syntax errors for if expressions. Patch by Miguel Brito

@item 
bpo-34013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34013}: Generalize the invalid legacy statement custom error message
(like the one generated when «print» is called without parentheses) to
include more generic expressions. Patch by Pablo Galindo

@item 
bpo-44732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44732}: Rename @code{types.Union} to @code{types.UnionType}.

@item 
bpo-44725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44725}: Expose specialization stats in python via
@code{_opcode.get_specialization_stats()}.

@item 
bpo-44717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44717}: Improve AttributeError on circular imports of submodules.

@item 
bpo-44698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44698}: Fix undefined behaviour in complex object exponentiation.

@item 
bpo-44653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44653}: Support @ref{104,,typing} types in parameter substitution in the
union type.

@item 
bpo-44676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44676}: Add ability to serialise @code{types.Union} objects. Patch
provided by Yurii Karabas.

@item 
bpo-44633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44633}: Parameter substitution of the union type with wrong types now
raises @code{TypeError} instead of returning @ref{227,,NotImplemented}.

@item 
bpo-44661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44661}: Update @code{property_descr_set} to use vectorcall if possible.
Patch by Donghee Na.

@item 
bpo-44662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44662}: Add @code{__module__} to @code{types.Union}. This also fixes
@code{types.Union} issues with @code{typing.Annotated}. Patch provided by Yurii
Karabas.

@item 
bpo-44655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44655}: Include the name of the type in unset __slots__ attribute
errors. Patch by Pablo Galindo

@item 
bpo-44655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44655}: Don’t include a missing attribute with the same name as the
failing one when offering suggestions for missing attributes. Patch by
Pablo Galindo

@item 
bpo-44646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44646}: Fix the hash of the union type: it no longer depends on the
order of arguments.

@item 
bpo-44636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44636}: Collapse union of equal types. E.g. the result of @code{int | int}
is now @code{int}. Fix comparison of the union type with non-hashable
objects. E.g. @code{int | str == @{@}} no longer raises a TypeError.

@item 
bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611}: On Windows, @ref{5c6,,os.urandom()}: uses BCryptGenRandom API
instead of CryptGenRandom API which is deprecated from Microsoft Windows
API. Patch by Donghee Na.

@item 
bpo-44635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44635}: Convert @code{None} to @code{type(None)} in the union type
constructor.

@item 
bpo-26280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26280}: Implement adaptive specialization for BINARY_SUBSCR

Three specialized forms of BINARY_SUBSCR are added:


@itemize *

@item 
BINARY_SUBSCR_LIST_INT

@item 
BINARY_SUBSCR_TUPLE_INT

@item 
BINARY_SUBSCR_DICT
@end itemize

@item 
bpo-44589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44589}: Mapping patterns in @code{match} statements with two or more equal
literal keys will now raise a @ref{150,,SyntaxError} at compile-time.

@item 
bpo-44606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44606}: Fix @code{__instancecheck__} and @code{__subclasscheck__} for the
union type.

@item 
bpo-42073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42073}: The @code{@@classmethod} decorator can now wrap other
classmethod-like descriptors.

@item 
bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972}: Tuned the string-searching algorithm of fastsearch.h to have a
shorter inner loop for most cases.

@item 
bpo-44590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44590}: All necessary data for executing a Python function (local
variables, stack, etc) is now kept in a per-thread stack. Frame objects
are lazily allocated on demand. This increases performance by about 7% on
the standard benchmark suite. Introspection and debugging are unaffected
as frame objects are always available when needed. Patch by Mark Shannon.

@item 
bpo-44584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44584}: The threading debug (@code{PYTHONTHREADDEBUG} environment
variable) is deprecated in Python 3.10 and will be removed in Python 3.12.
This feature requires a debug build of Python. Patch by Victor Stinner.

@item 
bpo-43895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43895}: An obsolete internal cache of shared object file handles added
in 1995 that attempted, but did not guarantee, that a .so would not be
dlopen’ed twice to work around flaws in mid-1990s posix-ish operating
systems has been removed from dynload_shlib.c.

@item 
bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}: @ref{104,,typing} now searches for type parameters in
@code{types.Union} objects. @code{get_type_hints} will also properly resolve
annotations with nested @code{types.Union} objects. Patch provided by Yurii
Karabas.

@item 
bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}: Code objects can now provide the column information for
instructions when available. This is levaraged during traceback printing
to show the expressions responsible for errors.

Contributed by Pablo Galindo, Batuhan Taskaya and Ammar Askar as part of
@geindex Python Enhancement Proposals; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/}.

@item 
bpo-44562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44562}: Remove uses of @ref{1545,,PyObject_GC_Del()} in error path when
initializing @ref{882,,types.GenericAlias}.

@item 
bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486}: Fix a memory consumption and copying performance regression in
earlier 3.10 beta releases if someone used an output buffer larger than
4GiB with zlib.decompress on input data that expands that large.

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: Heap types with the @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} flag
can now inherit the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall protocol.  Previously, this was
only possible for @ref{819,,static types}.  Patch by Erlend E.
Aasland.

@item 
bpo-44553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44553}: Implement GC methods for @code{types.Union} to break reference
cycles and prevent memory leaks.

@item 
bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}: Add @code{__parameters__} attribute and @code{__getitem__} operator
to @code{types.Union}. Patch provided by Yurii Karabas.

@item 
bpo-44523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44523}: Remove the pass-through for @ref{68b,,hash()} of
@ref{189b,,weakref.proxy} objects to prevent unintended consequences when the
original referred object dies while the proxy is part of a hashable
object. Patch by Pablo Galindo.

@item 
bpo-44483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44483}: Fix a crash in @code{types.Union} objects when creating a union of
an object with bad @code{__module__} field.

@item 
bpo-44486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44486}: Modules will always have a dictionary, even when created by
@code{types.ModuleType.__new__()}

@item 
bpo-44472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44472}: Fix ltrace functionality when exceptions are raised. Patch by
Pablo Galindo

@item 
bpo-12022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12022}: A @ref{228,,TypeError} is now raised instead of an
@ref{441,,AttributeError} in @ref{673,,with} and @ref{676,,async with}
statements for objects which do not support the @ref{675,,context manager} or
@ref{678,,asynchronous context manager} protocols correspondingly.

@item 
bpo-44297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44297}: Make sure that the line number is set when entering a
comprehension scope. This ensures that backtraces including generator
expressions show the correct line number.

@item 
bpo-44456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44456}: Improve the syntax error when mixing positional and keyword
patterns. Patch by Pablo Galindo.

@item 
bpo-44409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44409}: Fix error location information for tokenizer errors raised on
initialization of the tokenizer. Patch by Pablo Galindo.

@item 
bpo-44396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44396}: Fix a possible crash in the tokenizer when raising syntax
errors for unclosed strings. Patch by Pablo Galindo.

@item 
bpo-44376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44376}: Exact integer exponentiation (like @code{i**2} or @code{pow(i, 2)})
with a small exponent is much faster, due to reducing overhead in such
cases.

@item 
bpo-44313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44313}: Directly imported objects and modules (through import and from
import statements) don’t generate @code{LOAD_METHOD}/@code{CALL_METHOD} for
directly accessed objects on their namespace. They now use the regular
@code{LOAD_ATTR}/@code{CALL_FUNCTION}.

@item 
bpo-44338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44338}: Implement adaptive specialization for LOAD_GLOBAL

Two specialized forms of LOAD_GLOBAL are added:


@itemize *

@item 
LOAD_GLOBAL_MODULE

@item 
LOAD_GLOBAL_BUILTIN
@end itemize

@item 
bpo-44368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44368}: Improve syntax errors for invalid «as» targets. Patch by Pablo
Galindo

@item 
bpo-44349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44349}: Fix an edge case when displaying text from files with encoding
in syntax errors. Patch by Pablo Galindo.

@item 
bpo-44337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44337}: Initial implementation of adaptive specialization of LOAD_ATTR

Four specialized forms of LOAD_ATTR are added:


@itemize *

@item 
LOAD_ATTR_SLOT

@item 
LOAD_ATTR_SPLIT_KEYS

@item 
LOAD_ATTR_WITH_HINT

@item 
LOAD_ATTR_MODULE
@end itemize

@item 
bpo-44335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44335}: Fix a regression when identifying incorrect characters in
syntax errors. Patch by Pablo Galindo

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: Computation of the offsets of cell variables is done in the
compiler instead of at runtime. This reduces the overhead of handling cell
and free variables, especially in the case where a variable is both an
argument and cell variable.

@item 
bpo-44317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44317}: Improve tokenizer error with improved locations. Patch by Pablo
Galindo.

@item 
bpo-44304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44304}: Fix a crash in the @ref{cf,,sqlite3} module that happened when the
garbage collector clears @code{sqlite.Statement} objects. Patch by Pablo
Galindo

@item 
bpo-44305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44305}: Improve error message for @code{try} blocks without @code{except} or
@code{finally} blocks. Patch by Pablo Galindo.

@item 
bpo-43413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43413}: Constructors of subclasses of some builtin classes (e.g.
@ref{464,,tuple}, @ref{18e,,list}, @ref{67b,,frozenset}) no longer accept
arbitrary keyword arguments. [reverted in 3.11a4] Subclass of @ref{67a,,set}
can now define a @code{__new__()} method with additional keyword parameters
without overriding also @code{__init__()}.

@item 
bpo-43667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43667}: Improve Unicode support in non-UTF locales on Oracle Solaris.
This issue does not affect other Solaris systems.

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: A new opcode MAKE_CELL has been added that effectively moves
some of the work done on function entry into the compiler and into the
eval loop.  In addition to creating the required cell objects, the new
opcode converts relevant arguments (and other locals) to cell variables on
function entry.

@item 
bpo-44232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44232}: Fix a regression in @ref{dcf,,type()} when a metaclass raises an
exception. The C function @code{type_new()} must properly report the
exception when a metaclass constructor raises an exception and the winner
class is not the metaclass. Patch by Victor Stinner.

@item 
bpo-44201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44201}: Avoid side effects of checking for specialized syntax errors in
the REPL that was causing it to ask for extra tokens after a syntax error
had been detected. Patch by Pablo Galindo

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: @code{PyCodeObject} gained @code{co_fastlocalnames} and
@code{co_fastlocalkinds} as the authoritative source of fast locals info.
Marshaled code objects have changed accordingly.

@item 
bpo-44184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44184}: Fix a crash at Python exit when a deallocator function removes
the last strong reference to a heap type. Patch by Victor Stinner.

@item 
bpo-44187@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44187}: Implement quickening in the interpreter. This offers no
advantages as yet, but is an enabler of future optimizations. See PEP 659
for full explanation.

@item 
bpo-44180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44180}: The parser doesn’t report generic syntax errors that happen in
a position further away that the one it reached in the first pass. Patch
by Pablo Galindo

@item 
bpo-44168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44168}: Fix error message in the parser involving keyword arguments
with invalid expressions. Patch by Pablo Galindo

@item 
bpo-44156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44156}: String caches in @code{compile.c} are now subinterpreter
compatible.

@item 
bpo-44143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44143}: Fixed a crash in the parser that manifest when raising
tokenizer errors when an existing exception was present. Patch by Pablo
Galindo.

@item 
bpo-44032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44032}: Move “fast” locals and other variables from the frame object to
a per-thread datastack.

@item 
bpo-44114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44114}: Fix incorrect dictkeys_reversed and dictitems_reversed function
signatures in C code, which broke webassembly builds.

@item 
bpo-44110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44110}: Improve @code{str.__getitem__()} error message

@item 
bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}: Add @code{CALL_METHOD_KW} opcode to speed up method calls with
keyword arguments.  Idea originated from PyPy.  A side effect is executing
@code{CALL_METHOD} is now branchless in the evaluation loop.

@item 
bpo-28307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28307}: Compiler now optimizes simple C-style formatting with literal
format containing only format codes %s, %r and %a by converting them to
f-string expressions.

@item 
bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}: Correct the syntax error message regarding multiple exception
types to not refer to «exception groups». Patch by Pablo Galindo

@item 
bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}: The parser will prioritize tokenizer errors over custom syntax
errors when raising exceptions. Patch by Pablo Galindo.

@item 
bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}: «Zero cost» exception handling.


@itemize *

@item 
Uses a lookup table to determine how to handle exceptions.

@item 
Removes SETUP_FINALLY and POP_TOP block instructions, eliminating the runtime overhead of try statements.

@item 
Reduces the size of the frame object by about 60%.
@end itemize

Patch by Mark Shannon

@item 
bpo-43918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43918}: Document the signature and @code{default} argument in the
docstring of the new @code{anext} builtin.

@item 
bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}: Emit a deprecation warning if the numeric literal is
immediately followed by one of keywords: and, else, for, if, in, is, or.
Raise a syntax error with more informative message if it is immediately
followed by other keyword or identifier.

@item 
bpo-43879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43879}: Add native_thread_id to PyThreadState. Patch by Gabriele N.
Tornetta.

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: Compute cell offsets relative to locals in compiler. Allows the
interpreter to treats locals and cells a single array, which is slightly
more efficient. Also make the LOAD_CLOSURE opcode an alias for LOAD_FAST.
Preserving LOAD_CLOSURE helps keep bytecode a bit more readable.

@item 
bpo-17792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17792}: More accurate error messages for access of unbound locals or
free vars.

@item 
bpo-28146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28146}: Fix a confusing error message in @ref{6c2,,str.format()}.

@item 
bpo-11105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11105}: When compiling @ref{30d,,ast.AST} objects with recursive
references through @ref{2fb,,compile()}, the interpreter doesn’t crash anymore
instead it raises a @ref{df1,,RecursionError}.

@item 
bpo-39091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39091}: Fix crash when using passing a non-exception to a generator’s
@code{throw()} method. Patch by Noah Oxer

@item 
bpo-33346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33346}: Asynchronous comprehensions are now allowed inside
comprehensions in asynchronous functions.  Outer comprehensions implicitly
become asynchronous.
@end itemize

@node Library<25>,Documentation<24>,Core and Builtins<25>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id218}@anchor{189c}
@subsubsection Library



@itemize -

@item 
bpo-45371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45371}: Fix clang rpath issue in @code{distutils}. The UnixCCompiler now
uses correct clang option to add a runtime library directory (rpath) to a
shared library.

@item 
bpo-45329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45329}: Fix freed memory access in @code{pyexpat.xmlparser} when
building it with an installed expat library <= 2.2.0.

@item 
bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}: On Unix, if the @code{sem_clockwait()} function is available in
the C library (glibc 2.30 and newer), the @ref{739,,threading.Lock.acquire()}
method now uses the monotonic clock (@ref{73a,,time.CLOCK_MONOTONIC}) for
the timeout, rather than using the system clock
(@ref{73b,,time.CLOCK_REALTIME}), to not be affected by system clock
changes. Patch by Victor Stinner.

@item 
bpo-1596321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1596321}: Fix the @code{threading._shutdown()} function when the
@ref{ed,,threading} module was imported first from a thread different than
the main thread: no longer log an error at Python exit.

@item 
bpo-45274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45274}: Fix a race condition in the @ref{1251,,Thread.join()} method of the @ref{ed,,threading} module. If the
function is interrupted by a signal and the signal handler raises an
exception, make sure that the thread remains in a consistent state to
prevent a deadlock. Patch by Victor Stinner.

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: In Unix operating systems, @ref{73e,,time.sleep()} now uses the
@code{nanosleep()} function, if @code{clock_nanosleep()} is not available but
@code{nanosleep()} is available. @code{nanosleep()} allows to sleep with
nanosecond precision.

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: On Windows, @ref{73e,,time.sleep()} now uses a waitable timer which
has a resolution of 100 nanoseconds (10@w{^-7} seconds). Previously,
it had a resolution of 1 millisecond (10@w{^-3} seconds). Patch by
Benjamin Szőke and Victor Stinner.

@item 
bpo-45238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45238}: Fix @code{unittest.IsolatedAsyncioTestCase.debug()}: it runs now
asynchronous methods and callbacks.

@item 
bpo-36674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36674}: @ref{189d,,unittest.TestCase.debug()} raises now a
@ref{1063,,unittest.SkipTest} if the class or the test method are decorated
with the skipping decorator.

@item 
bpo-45235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45235}: Fix an issue where argparse would not preserve values in a
provided namespace when using a subparser with defaults.

@item 
bpo-45183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45183}: Have zipimport.zipimporter.find_spec() not raise an exception
when the underlying zip file has been deleted and the internal cache has
been reset via invalidate_cache().

@item 
bpo-45234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45234}: Fixed a regression in @ref{aea,,copyfile()},
@ref{aeb,,copy()}, @ref{aec,,copy2()} raising
@ref{f46,,FileNotFoundError} when source is a directory, which should raise
@ref{10d5,,IsADirectoryError}

@item 
bpo-45228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45228}: Fix stack buffer overflow in parsing J1939 network address.

@item 
bpo-45225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45225}: use map function instead of genexpr in capwords.

@item 
bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}: Fix typo: @code{importlib.find_loader} is really slated for
removal in Python 3.12 not 3.10, like the others in PR 25169.

Patch by Hugo van Kemenade.

@item 
bpo-20524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20524}: Improves error messages on @code{.format()} operation for @code{str},
@code{float}, @code{int}, and @code{complex}. New format now shows the problematic
pattern and the object type.

@item 
bpo-45168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45168}: Change @ref{172,,dis.dis()} output to omit op arg values that cannot
be resolved due to @code{co_consts}, @code{co_names} etc not being provided.
Previously the oparg itself was repeated in the value field, which is not
useful and can be confusing.

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: In Unix operating systems, @ref{73e,,time.sleep()} now uses the
@code{clock_nanosleep()} function, if available, which allows to sleep for an
interval specified with nanosecond precision.

@item 
bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}: Remove from the @ref{23,,configparser} module: the
@code{SafeConfigParser} class, the @code{filename} property of the
@ref{5a9,,ParsingError} class, the @code{readfp()} method of
the @ref{32b,,ConfigParser} class, deprecated since Python
3.2.

Patch by Hugo van Kemenade.

@item 
bpo-44987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44987}: Pure ASCII strings are now normalized in constant time by
@ref{775,,unicodedata.normalize()}. Patch by Donghee Na.

@item 
bpo-35474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35474}: Calling @ref{189e,,mimetypes.guess_all_extensions()} with
@code{strict=False} no longer affects the result of the following call with
@code{strict=True}. Also, mutating the returned list no longer affects the
global state.

@item 
bpo-45166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45166}: @ref{752,,typing.get_type_hints()} now works with
@ref{3be,,Final} wrapped in @ref{184a,,ForwardRef}.

@item 
bpo-45162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45162}: Remove many old deprecated @ref{106,,unittest} features:


@itemize *

@item 
«@code{fail*}» and «@code{assert*}» aliases of @ref{4fa,,TestCase} methods.

@item 
Broken from start @ref{4fa,,TestCase} method @code{assertDictContainsSubset()}.

@item 
Ignored @code{<unittest.TestLoader.loadTestsFromModule> TestLoader.loadTestsFromModule()} parameter `use_load_tests'.

@item 
Old alias @code{_TextTestResult} of @ref{5d4,,TextTestResult}.
@end itemize

@item 
bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}: Remove the deprecated @code{split()} method of
@code{_tkinter.TkappType}. Patch by Erlend E. Aasland.

@item 
bpo-20499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20499}: Improve the speed and accuracy of statistics.pvariance().

@item 
bpo-45132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45132}: Remove @ref{3d8,,__getitem__()} methods of
@ref{7d1,,xml.dom.pulldom.DOMEventStream}, @ref{7d2,,wsgiref.util.FileWrapper}
and @ref{7d3,,fileinput.FileInput}, deprecated since Python 3.9.

Patch by Hugo van Kemenade.

@item 
bpo-45129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45129}: Due to significant security concerns, the `reuse_address'
parameter of @ref{7cf,,asyncio.loop.create_datagram_endpoint()}, disabled in
Python 3.9, is now entirely removed. This is because of the behavior of
the socket option @code{SO_REUSEADDR} in UDP.

Patch by Hugo van Kemenade.

@item 
bpo-45124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45124}: The @code{bdist_msi} command, deprecated in Python 3.9, is now
removed.

Use @code{bdist_wheel} (wheel packages) instead.

Patch by Hugo van Kemenade.

@item 
bpo-30856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30856}: @ref{11d8,,unittest.TestResult} methods
@ref{189f,,addFailure()},
@ref{18a0,,addError()},
@ref{18a1,,addSkip()} and
@ref{18a2,,addSubTest()} are now called immediately after
raising an exception in test or finishing a subtest. Previously they were
called only after finishing the test clean up.

@item 
bpo-45034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45034}: Changes how error is formatted for @code{struct.pack} with @code{'H'}
and @code{'h'} modes and too large / small numbers. Now it shows the actual
numeric limits, while previously it was showing arithmetic expressions.

@item 
bpo-25894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25894}: @ref{106,,unittest} now always reports skipped and failed subtests
separately: separate characters in default mode and separate lines in
verbose mode. Also the test description is now output for errors in test
method, class and module cleanups.

@item 
bpo-45081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45081}: Fix issue when dataclasses that inherit from
@code{typing.Protocol} subclasses have wrong @code{__init__}. Patch provided by
Yurii Karabas.

@item 
bpo-45085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45085}: The @code{binhex} module, deprecated in Python 3.9, is now
removed. The following @ref{11,,binascii} functions, deprecated in Python
3.9, are now also removed:


@itemize *

@item 
@code{a2b_hqx()}, @code{b2a_hqx()};

@item 
@code{rlecode_hqx()}, @code{rledecode_hqx()}.
@end itemize

The @ref{7d0,,binascii.crc_hqx()} function remains available.

Patch by Victor Stinner.

@item 
bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}: The @code{lib2to3} package is now deprecated and may not be
able to parse Python 3.10 or newer. See the 
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} (New PEG parser for
CPython). Patch by Victor Stinner.

@item 
bpo-45075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45075}: Rename @code{traceback.StackSummary.format_frame()} to
@ref{744,,traceback.StackSummary.format_frame_summary()}. This method was added
for 3.11 so it was not released yet.

Updated code and docs to better distinguish frame and FrameSummary.

@item 
bpo-31299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31299}: Add option to completely drop frames from a traceback by
returning @code{None} from a @code{format_frame()}
override.

@item 
bpo-41620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41620}: @ref{11d7,,run()} now always return a
@ref{11d8,,TestResult} instance. Previously it returned @code{None} if
the test class or method was decorated with a skipping decorator.

@item 
bpo-45021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45021}: Fix a potential deadlock at shutdown of forked children when
using @ref{22,,concurrent.futures} module

@item 
bpo-43913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43913}: Fix bugs in cleaning up classes and modules in @ref{106,,unittest}:


@itemize *

@item 
Functions registered with @ref{adf,,addModuleCleanup()} were not called unless the user defines @code{tearDownModule()} in their test module.

@item 
Functions registered with @ref{ae0,,addClassCleanup()} were not called if @code{tearDownClass} is set to @code{None}.

@item 
Buffering in @ref{11d8,,TestResult} did not work with functions registered with @code{addClassCleanup()} and @code{addModuleCleanup()}.

@item 
Errors in functions registered with @code{addClassCleanup()} and @code{addModuleCleanup()} were not handled correctly in buffered and debug modes.

@item 
Errors in @code{setUpModule()} and functions registered with @code{addModuleCleanup()} were reported in wrong order.

@item 
And several lesser bugs.
@end itemize

@item 
bpo-45030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45030}: Fix integer overflow in pickling and copying the range
iterator.

@item 
bpo-45001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45001}: Made email date parsing more robust against malformed input,
namely a whitespace-only @code{Date:} header. Patch by Wouter Bolsterlee.

@item 
bpo-45010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45010}: Remove support of special method @code{__div__} in
@ref{107,,unittest.mock}. It is not used in Python 3.

@item 
bpo-39218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39218}: Improve accuracy of variance calculations by using @code{x*x}
instead of @code{x**2}.

@item 
bpo-43613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43613}: Improve the speed of @ref{6df,,gzip.compress()} and
@ref{127a,,gzip.decompress()} by compressing and decompressing at once in memory
instead of in a streamed fashion.

@item 
bpo-37596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37596}: Ensure that @ref{67a,,set} and @ref{67b,,frozenset} objects are
always @ref{8d,,marshalled} reproducibly.

@item 
bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}: A new function @code{operator.call} has been added, such that
@code{operator.call(obj, *args, **kwargs) == obj(*args, **kwargs)}.

@item 
bpo-42255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42255}: @code{webbrowser.MacOSX} is deprecated and will be removed
in Python 3.13. It is untested and undocumented and also not used by
@ref{115,,webbrowser} itself. Patch by Donghee Na.

@item 
bpo-44955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44955}: Method @ref{13b2,,stopTestRun()} is now always
called in pair with method @ref{13b1,,startTestRun()} for
@ref{11d8,,TestResult} objects implicitly created in
@ref{11d7,,run()}. Previously it was not called for test
methods and classes decorated with a skipping decorator.

@item 
bpo-39039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39039}: tarfile.open raises @ref{18a3,,ReadError} when a zlib error
occurs during file extraction.

@item 
bpo-44935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44935}: @ref{d6,,subprocess} on Solaris now also uses
@ref{37d,,os.posix_spawn()} for better performance.

@item 
bpo-44911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44911}: @ref{206,,IsolatedAsyncioTestCase} will no longer throw
an exception while cancelling leaked tasks. Patch by Bar Harel.

@item 
bpo-41322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41322}: Added @code{DeprecationWarning} for tests and async tests that
return a value!=None (as this may indicate an improperly written test, for
example a test written as a generator function).

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: Make exception message more useful when subclass from typing
special form alias. Patch provided by Yurii Karabas.

@item 
bpo-38956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38956}: @ref{185d,,argparse.BooleanOptionalAction}’s default value is no
longer printed twice when used with
@ref{18a4,,argparse.ArgumentDefaultsHelpFormatter}.

@item 
bpo-44860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44860}: Fix the @code{posix_user} scheme in @ref{db,,sysconfig} to not depend
on @ref{9cb,,sys.platlibdir}.

@item 
bpo-44859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44859}: Improve error handling in @ref{cf,,sqlite3} and raise more
accurate exceptions.


@itemize *

@item 
@ref{16cb,,MemoryError} is now raised instead of @ref{182c,,sqlite3.Warning} when memory is not enough for encoding a statement to UTF-8 in @code{Connection.__call__()} and @code{Cursor.execute()}.

@item 
@code{UnicodEncodeError} is now raised instead of @ref{182c,,sqlite3.Warning} when the statement contains surrogate characters in @code{Connection.__call__()} and @code{Cursor.execute()}.

@item 
@ref{228,,TypeError} is now raised instead of @ref{360,,ValueError} for non-string script argument in @code{Cursor.executescript()}.

@item 
@ref{360,,ValueError} is now raised for script containing the null character instead of truncating it in @code{Cursor.executescript()}.

@item 
Correctly handle exceptions raised when getting boolean value of the result of the progress handler.

@item 
Add many tests covering different corner cases.
@end itemize

@item 
bpo-44581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44581}: Upgrade bundled pip to 21.2.3 and setuptools to 57.4.0

@item 
bpo-44849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44849}: Fix the @ref{f7e,,os.set_inheritable()} function on FreeBSD 14 for
file descriptor opened with the @ref{ff1,,O_PATH} flag: ignore the
@ref{9ee,,EBADF} error on @code{ioctl()}, fallback on the @code{fcntl()}
implementation. Patch by Victor Stinner.

@item 
bpo-44605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44605}: The @@functools.total_ordering() decorator now works with
metaclasses.

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: Fixed an issue wherein the @code{__name__} and @code{__qualname__}
attributes of subscribed specialforms could be @code{None}.

@item 
bpo-44839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44839}: @ref{16cb,,MemoryError} raised in user-defined functions will now
produce a @code{MemoryError} in @ref{cf,,sqlite3}. @ref{919,,OverflowError} will
now be converted to @ref{18a5,,DataError}. Previously
@ref{18a6,,OperationalError} was produced in these cases.

@item 
bpo-44822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44822}: @ref{cf,,sqlite3} user-defined functions and aggregators returning
@ref{237,,strings} with embedded NUL characters are no longer
truncated. Patch by Erlend E. Aasland.

@item 
bpo-44801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44801}: Ensure that the @ref{2ca,,ParamSpec} variable in Callable
can only be substituted with a parameters expression (a list of types, an
ellipsis, ParamSpec or Concatenate).

@item 
bpo-44806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44806}: Non-protocol subclasses of @ref{3bb,,typing.Protocol} ignore now
the @code{__init__} method inherited from protocol base classes.

@item 
bpo-27275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27275}: @ref{1354,,collections.OrderedDict.popitem()} and
@code{collections.OrderedDict.pop()} no longer call @code{__getitem__} and
@code{__delitem__} methods of the OrderedDict subclasses.

@item 
bpo-44793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44793}: Fix checking the number of arguments when subscribe a generic
type with @code{ParamSpec} parameter.

@item 
bpo-44784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44784}: In importlib.metadata tests, override warnings behavior under
expected DeprecationWarnings (importlib_metadata 4.6.3).

@item 
bpo-44667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44667}: The @ref{581,,tokenize.tokenize()} doesn’t incorrectly generate a
@code{NEWLINE} token if the source doesn’t end with a new line character but
the last line is a comment, as the function is already generating a @code{NL}
token. Patch by Pablo Galindo

@item 
bpo-44771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44771}: Added @code{importlib.simple} module implementing adapters from a
low-level resources reader interface to a @code{TraversableResources}
interface. Legacy API (@code{path}, @code{contents}, …) is now supported
entirely by the @code{.files()} API with a compatibility shim supplied for
resource loaders without that functionality. Feature parity with
@code{importlib_resources} 5.2.

@item 
bpo-44752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44752}: @code{rcompleter} does not call @ref{c59,,getattr()} on
@ref{2fd,,property} objects to avoid the side-effect of  evaluating the
corresponding method.

@item 
bpo-44747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44747}: Refactor usage of @code{sys._getframe} in @code{typing} module. Patch
provided by Yurii Karabas.

@item 
bpo-42378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42378}: Fixes the issue with log file being overwritten when
@ref{18a7,,logging.FileHandler} is used in @ref{d,,atexit} with `filemode' set
to @code{'w'}. Note this will cause the message in `atexit' not being logged
if the log stream is already closed due to shutdown of logging.

@item 
bpo-44720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44720}: @code{weakref.proxy} objects referencing non-iterators now raise
@code{TypeError} rather than dereferencing the null @code{tp_iternext} slot and
crashing.

@item 
bpo-44704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44704}: The implementation of @code{collections.abc.Set._hash()} now
matches that of @code{frozenset.__hash__()}.

@item 
bpo-44666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44666}: Fixed issue in @ref{e66,,compileall.compile_file()} when
@code{sys.stdout} is redirected. Patch by Stefan Hölzl.

@item 
bpo-44688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44688}: @ref{717,,sqlite3.Connection.create_collation()} now accepts
non-ASCII collation names. Patch by Erlend E. Aasland.

@item 
bpo-44690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44690}: Adopt `binacii.a2b_base64'’s strict mode in `base64.b64decode'.

@item 
bpo-42854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42854}: Fixed a bug in the @code{_ssl} module that was throwing
@ref{919,,OverflowError} when using @code{_ssl._SSLSocket.write()} and
@code{_ssl._SSLSocket.read()} for a big value of the @code{len} parameter.
Patch by Pablo Galindo.

@item 
bpo-44686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44686}: Replace @code{unittest.mock._importer} with
@code{pkgutil.resolve_name}.

@item 
bpo-44353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44353}: Make @code{NewType.__call__} faster by implementing it in C. Patch
provided by Yurii Karabas.

@item 
bpo-44682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44682}: Change the @ref{a5,,pdb} `commands' directive to disallow setting
commands for an invalid breakpoint and to display an appropriate error.

@item 
bpo-44353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44353}: Refactor @code{typing.NewType} from function into callable class.
Patch provided by Yurii Karabas.

@item 
bpo-44678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44678}: Added a separate error message for discontinuous padding in
`binascii.a2b_base64' strict mode.

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: Add missing @code{__name__} and @code{__qualname__} attributes to
@code{typing} module classes. Patch provided by Yurii Karabas.

@item 
bpo-40897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40897}: Give priority to using the current class constructor in
@ref{181,,inspect.signature()}. Patch by Weipeng Hong.

@item 
bpo-44638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44638}: Add a reference to the zipp project and hint as to how to use
it.

@item 
bpo-44648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44648}: Fixed wrong error being thrown by @ref{15ce,,inspect.getsource()}
when examining a class in the interactive session. Instead of
@ref{228,,TypeError}, it should be @ref{4d5,,OSError} with appropriate error
message.

@item 
bpo-44608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44608}: Fix memory leak in @code{_tkinter._flatten()} if it is called
with a sequence or set, but not list or tuple.

@item 
bpo-44594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44594}: Fix an edge case of @code{ExitStack} and
@code{AsyncExitStack} exception chaining.  They will now match @code{with}
block behavior when @code{__context__} is explicitly set to @code{None} when the
exception is in flight.

@item 
bpo-42799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42799}: In @ref{5c,,fnmatch}, the cache size for compiled regex patterns
(@ref{a81,,functools.lru_cache()}) was bumped up from 256 to 32768, affecting
functions: @ref{18a8,,fnmatch.fnmatch()}, @ref{18a9,,fnmatch.fnmatchcase()},
@ref{18aa,,fnmatch.filter()}.

@item 
bpo-41928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41928}: Update @ref{aea,,shutil.copyfile()} to raise
@ref{f46,,FileNotFoundError} instead of confusing @ref{10d5,,IsADirectoryError}
when a path ending with a @code{os.path.sep} does not exist;
@ref{aeb,,shutil.copy()} and @ref{aec,,shutil.copy2()} are also affected.

@item 
bpo-44569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44569}: Added the @code{StackSummary.format_frame()} function in
@ref{fe,,traceback}. This allows users to customize the way individual lines
are formatted in tracebacks without re-implementing logic to handle
recursive tracebacks.

@item 
bpo-44566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44566}: handle StopIteration subclass raised from
@@contextlib.contextmanager generator

@item 
bpo-44558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44558}: Make the implementation consistency of
@ref{972,,indexOf()} between C and Python versions. Patch by Donghee
Na.

@item 
bpo-41249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41249}: Fixes @code{TypedDict} to work with @code{typing.get_type_hints()}
and postponed evaluation of annotations across modules.

@item 
bpo-44554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44554}: Refactor argument processing in @code{pdb.main()} to simplify
detection of errors in input loading and clarify behavior around module or
script invocation.

@item 
bpo-34798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34798}: Break up paragraph about @ref{ffe,,pprint.PrettyPrinter}
construction parameters to make it easier to read.

@item 
bpo-44539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44539}: Added support for recognizing JPEG files without JFIF or Exif
markers.

@item 
bpo-44461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44461}: Fix bug with @ref{a5,,pdb}’s handling of import error due to a
package which does not have a @code{__main__} module

@item 
bpo-43625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43625}: Fix a bug in the detection of CSV file headers by
@ref{18ab,,csv.Sniffer.has_header()} and improve documentation of same.

@item 
bpo-44516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44516}: Update vendored pip to 21.1.3

@item 
bpo-42892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42892}: Fixed an exception thrown while parsing a malformed multipart
email by @ref{3d0,,email.message.EmailMessage}.

@item 
bpo-44468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44468}: @ref{752,,typing.get_type_hints()} now finds annotations in classes
and base classes with unexpected @code{__module__}. Previously, it skipped
those MRO elements.

@item 
bpo-44491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44491}: Allow clearing the @ref{cf,,sqlite3} authorizer callback by
passing @ref{716,,None} to @ref{3f8,,set_authorizer()}. Patch
by Erlend E. Aasland.

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: Set the proper @ref{18ac,,Py_TPFLAGS_MAPPING} and
@ref{18ad,,Py_TPFLAGS_SEQUENCE} flags for subclasses created before a
parent has been registered as a @ref{961,,collections.abc.Mapping} or
@ref{1231,,collections.abc.Sequence}.

@item 
bpo-44482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44482}: Fix very unlikely resource leak in @ref{64,,glob} in alternate
Python implementations.

@item 
bpo-44466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44466}: The @ref{58,,faulthandler} module now detects if a fatal error
occurs during a garbage collector collection. Patch by Victor Stinner.

@item 
bpo-44471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44471}: A @ref{228,,TypeError} is now raised instead of an
@ref{441,,AttributeError} in @ref{674,,contextlib.ExitStack.enter_context()} and
@ref{677,,contextlib.AsyncExitStack.enter_async_context()} for objects which do
not support the @ref{675,,context manager} or @ref{678,,asynchronous context manager} protocols correspondingly.

@item 
bpo-44404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44404}: @ref{f0,,tkinter}’s @code{after()} method now supports callables
without the @code{__name__} attribute.

@item 
bpo-41546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41546}: Make @ref{ae,,pprint} (like the builtin @code{print}) not attempt to
write to @code{stdout} when it is @code{None}.

@item 
bpo-44458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44458}: @code{BUFFER_BLOCK_SIZE} is now declared static, to avoid linking
collisions when bz2, lmza or zlib are statically linked.

@item 
bpo-44464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44464}: Remove exception for flake8 in deprecated importlib.metadata
interfaces. Sync with importlib_metadata 4.6.

@item 
bpo-44446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44446}: Take into account that @code{lineno} might be @code{None} in
@ref{f07,,traceback.FrameSummary}.

@item 
bpo-44439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44439}: Fix in @code{bz2.BZ2File.write()} / @code{lzma.LZMAFile.write()}
methods, when the input data is an object that supports the buffer
protocol, the file length may be wrong.

@item 
bpo-44434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44434}: _thread.start_new_thread() no longer calls
PyThread_exit_thread() explicitly at the thread exit, the call was
redundant. On Linux with the glibc, pthread_exit() aborts the whole
process if dlopen() fails to open libgcc_s.so file (ex: EMFILE error).
Patch by Victor Stinner.

@item 
bpo-42972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42972}: The _thread.RLock type now fully implement the GC protocol: add
a traverse function and the @ref{817,,Py_TPFLAGS_HAVE_GC} flag. Patch by
Victor Stinner.

@item 
bpo-44422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44422}: The @ref{18ae,,threading.enumerate()} function now uses a reentrant
lock to prevent a hang on reentrant call. Patch by Victor Stinner.

@item 
bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}: Importing typing.io or typing.re now prints a
@code{DeprecationWarning}.

@item 
bpo-37880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37880}: argparse actions store_const and append_const each receive a
default value of @code{None} when the @code{const} kwarg is not provided.
Previously, this raised a @ref{228,,TypeError}.

@item 
bpo-44389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44389}: Fix deprecation of @ref{18af,,ssl.OP_NO_TLSv1_3}

@item 
bpo-27827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27827}: @code{pathlib.PureWindowsPath.is_reserved()} now identifies a
greater range of reserved filenames, including those with trailing spaces
or colons.

@item 
bpo-44395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44395}: Fix @code{as_string()} to pass unixfrom
properly. Patch by Donghee Na.

@item 
bpo-34266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34266}: Handle exceptions from parsing the arg of @ref{a5,,pdb}’s
run/restart command.

@item 
bpo-44362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44362}: Improve @ref{d0,,ssl} module’s deprecation messages, error
reporting, and documentation for deprecations.

@item 
bpo-44342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44342}: [Enum] Change pickling from by-value to by-name.

@item 
bpo-44356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44356}: [Enum] Allow multiple data-type mixins if they are all the
same.

@item 
bpo-44351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44351}: Restore back @code{parse_makefile()} in @code{distutils.sysconfig}
because it behaves differently than the similar implementation in
@ref{db,,sysconfig}.

@item 
bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}: @code{smtpd.MailmanProxy} is now removed as it is unusable
without an external module, @code{mailman}. Patch by Donghee Na.

@item 
bpo-44357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44357}: Added a function that returns cube root of the given number
@ref{702,,math.cbrt()}

@item 
bpo-44339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44339}: Change @code{math.pow(±0.0, -math.inf)} to return @code{inf} instead
of raising @code{ValueError}. This brings the special-case handling of
@code{math.pow} into compliance with the IEEE 754 standard.

@item 
bpo-44242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44242}: Remove missing flag check from Enum creation and move into a
@code{verify} decorator.

@item 
bpo-44246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44246}: In @code{importlib.metadata}, restore compatibility in the result
from @code{Distribution.entry_points} (@code{EntryPoints}) to honor expectations
in older implementations and issuing deprecation warnings for these cases:
A. @code{EntryPoints} objects are once again mutable, allowing   for
@code{sort()} and other list-based mutation operations.   Avoid deprecation
warnings by casting to a   mutable sequence (e.g.
@code{list(dist.entry_points).sort()}). B. @code{EntryPoints} results once again
allow   for access by index. To avoid deprecation warnings,   cast the
result to a Sequence first   (e.g. @code{tuple(dist.entry_points)[0]}).

@item 
bpo-44246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44246}: In importlib.metadata.entry_points, de-duplication of
distributions no longer requires loading the full metadata for
PathDistribution objects, improving entry point loading performance by
~10x.

@item 
bpo-43858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43858}: Added a function that returns a copy of a dict of logging
levels: @ref{6fa,,logging.getLevelNamesMapping()}

@item 
bpo-44260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44260}: The @ref{18b0,,random.Random} constructor no longer reads system
entropy without need.

@item 
bpo-44254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44254}: On Mac, give turtledemo button text a color that works on both
light or dark background.  Programmers cannot control the latter.

@item 
bpo-44258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44258}: Support PEP 515 for Fraction’s initialization from string.

@item 
bpo-44235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44235}: Remove deprecated functions in the @ref{63,,gettext}. Patch by
Donghee Na.

@item 
bpo-38693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38693}: Prefer f-strings to @code{.format} in importlib.resources.

@item 
bpo-33693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33693}: Importlib.metadata now prefers f-strings to .format.

@item 
bpo-44241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44241}: Incorporate minor tweaks from importlib_metadata 4.1:
SimplePath protocol, support for Metadata 2.2.

@item 
bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}: Remove the @code{@@asyncio.coroutine}
@ref{7cd,,decorator} enabling legacy generator-based coroutines to be
compatible with async/await code; remove
@code{asyncio.coroutines.CoroWrapper} used for wrapping legacy coroutine
objects in the debug mode. The decorator has been deprecated since Python
3.8 and the removal was initially scheduled for Python 3.10. Patch by
Illia Volochii.

@item 
bpo-44210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44210}: Make importlib.metadata._meta.PackageMetadata public.

@item 
bpo-43643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43643}: Declare readers.MultiplexedPath.name as a property per the
spec.

@item 
bpo-27334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27334}: The @ref{cf,,sqlite3} context manager now performs a rollback
(thus releasing the database lock) if commit failed.  Patch by Luca Citi
and Erlend E. Aasland.

@item 
bpo-4928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4928}: Documented existing behavior on POSIX: NamedTemporaryFiles are
not deleted when creating process is killed with SIGKILL

@item 
bpo-44154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44154}: Optimize @ref{177,,fractions.Fraction} pickling for large
components.

@item 
bpo-33433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33433}: For IPv4 mapped IPv6 addresses (
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} Section 2.5.5.2),
the @ref{1655,,ipaddress.IPv6Address.is_private} check is deferred to the
mapped IPv4 address. This solves a bug where public mapped IPv4 addresses
were considered private by the IPv6 check.

@item 
bpo-44150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44150}: Add optional `weights' argument to statistics.fmean().

@item 
bpo-44142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44142}: @ref{97c,,ast.unparse()} will now drop the redundant parentheses
when tuples used as assignment targets (e.g in for loops).

@item 
bpo-44145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44145}: @ref{6a,,hmac} computations were not releasing the GIL while
calling the OpenSSL @code{HMAC_Update} C API (a new feature in 3.9).  This
unintentionally prevented parallel computation as other @ref{68,,hashlib}
algorithms support.

@item 
bpo-44095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44095}: @ref{76a,,zipfile.Path} now supports @ref{767,,zipfile.Path.stem},
@ref{769,,zipfile.Path.suffixes}, and @ref{768,,zipfile.Path.suffix} attributes.

@item 
bpo-44077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44077}: It’s now possible to receive the type of service (ToS), a.k.a.
differentiated services (DS), a.k.a. differentiated services code point
(DSCP) and explicit congestion notification (ECN) IP header fields with
@code{socket.IP_RECVTOS}.

@item 
bpo-37788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37788}: Fix a reference leak when a Thread object is never joined.

@item 
bpo-38908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38908}: Subclasses of @code{typing.Protocol} which only have data
variables declared will now raise a @code{TypeError} when checked with
@code{isinstance} unless they are decorated with @code{runtime_checkable()}.
Previously, these checks passed silently. Patch provided by Yurii Karabas.

@item 
bpo-44098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44098}: @code{typing.ParamSpec} will no longer be found in the
@code{__parameters__} of most @ref{104,,typing} generics except in valid use
locations specified by 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}. This prevents incorrect usage like
@code{typing.List[P][int]}. This change means incorrect usage which may have
passed silently in 3.10 beta 1 and earlier will now error.

@item 
bpo-44089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44089}: Allow subclassing @code{csv.Error} in 3.10 (it was allowed in 3.9
and earlier but was disallowed in early versions of 3.10).

@item 
bpo-44081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44081}: @ref{97c,,ast.unparse()} now doesn’t use redundant spaces to
separate @code{lambda} and the @code{:} if there are no parameters.

@item 
bpo-44061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44061}: Fix regression in previous release when calling
@ref{dd1,,pkgutil.iter_modules()} with a list of @ref{19b,,pathlib.Path} objects

@item 
bpo-44059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44059}: Register the SerenityOS Browser in the @ref{115,,webbrowser}
module.

@item 
bpo-36515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36515}: The @ref{68,,hashlib} module no longer does unaligned memory
accesses when compiled for ARM platforms.

@item 
bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}: Remove random module features deprecated in Python 3.9.

@item 
bpo-44018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44018}: random.seed() no longer mutates bytearray inputs.

@item 
bpo-38352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38352}: Add @code{IO}, @code{BinaryIO}, @code{TextIO}, @code{Match}, and
@code{Pattern} to @code{typing.__all__}. Patch by Jelle Zijlstra.

@item 
bpo-44002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44002}: @ref{10a,,urllib.parse} now uses @code{functool.lru_cache()} for its
internal URL splitting and quoting caches instead of rolling its own like
its the “90s.

The undocumented internal @ref{10a,,urllib.parse} @code{Quoted} class API is now
deprecated, for removal in 3.14.

@item 
bpo-43972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43972}: When @ref{bcb,,http.server.SimpleHTTPRequestHandler} sends a
@code{301 (Moved Permanently)} for a directory path not ending with @code{/},
add a @code{Content-Length: 0} header. This improves the behavior for certain
clients.

@item 
bpo-28528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28528}: Fix a bug in @ref{a5,,pdb} where @code{checkline()} raises
@ref{441,,AttributeError} if it is called after @code{reset()}.

@item 
bpo-43853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43853}: Improved string handling for @ref{cf,,sqlite3} user-defined
functions and aggregates:


@itemize *

@item 
It is now possible to pass strings with embedded null characters to UDFs

@item 
Conversion failures now correctly raise @ref{16cb,,MemoryError}
@end itemize

Patch by Erlend E. Aasland.

@item 
bpo-43666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43666}: AIX: @code{Lib/_aix_support.get_platform()} may fail in an AIX
WPAR. The fileset bos.rte appears to have a builddate in both LPAR and
WPAR so this fileset is queried rather than bos.mp64. To prevent a similar
situation (no builddate in ODM) a value (9988) sufficient for completing a
build is provided. Patch by M Felt.

@item 
bpo-43650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43650}: Fix @ref{16cb,,MemoryError} in @ref{516,,shutil.unpack_archive()} which
fails inside @code{shutil._unpack_zipfile()} on large files. Patch by Igor
Bolshakov.

@item 
bpo-43612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43612}: @ref{6e0,,zlib.compress()} now accepts a wbits parameter which
allows users to compress data as a raw deflate block without zlib headers
and trailers in one go. Previously this required instantiating a
@code{zlib.compressobj}. It also provides a faster alternative to
@code{gzip.compress} when wbits=31 is used.

@item 
bpo-43392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43392}: @code{importlib._bootstrap._find_and_load()} now implements a
two-step check to avoid locking when modules have been already imported
and are ready. This improves performance of repeated calls to
@ref{5bc,,importlib.import_module()} and @ref{10e9,,importlib.__import__()}.

@item 
bpo-43318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43318}: Fix a bug where @ref{a5,,pdb} does not always echo cleared
breakpoints.

@item 
bpo-43234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43234}: Prohibit passing
non-@ref{7dd,,concurrent.futures.ThreadPoolExecutor} executors to
@code{loop.set_default_executor()} following a deprecation in Python 3.8.
Patch by Illia Volochii.

@item 
bpo-43232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43232}: Prohibit previously deprecated potentially disruptive
operations on @code{asyncio.trsock.TransportSocket}. Patch by Illia
Volochii.

@item 
bpo-30077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30077}: Added support for Apple’s aifc/sowt pseudo-compression

@item 
bpo-42971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42971}: Add definition of @code{errno.EQFULL} for platforms that define
this constant (such as macOS).

@item 
bpo-43086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43086}: Added a new optional @code{strict_mode} parameter to
`binascii.a2b_base64'. When @code{scrict_mode} is set to @code{True},
the `a2b_base64' function will accept only valid base64 content. More
details about what «valid base64 content» is, can be found in the
function’s documentation.

@item 
bpo-43024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43024}: Improve the help signature of
@ref{8e6,,traceback.print_exception()}, @ref{8e4,,traceback.format_exception()} and
@ref{8e5,,traceback.format_exception_only()}.

@item 
bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809}: Add the @ref{745,,traceback.TracebackException.print()} method which
prints the formatted exception information.

@item 
bpo-42862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42862}: @ref{cf,,sqlite3} now utilizes @ref{a81,,functools.lru_cache()} to
implement the connection statement cache. As a small optimisation, the
default statement cache size has been increased from 100 to 128. Patch by
Erlend E. Aasland.

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: Soumendra Ganguly: add termios.tcgetwinsize(),
termios.tcsetwinsize().

@item 
bpo-40497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40497}: @ref{1040,,subprocess.check_output()} now raises @ref{360,,ValueError}
when the invalid keyword argument `check' is passed by user code.
Previously such use would fail later with a @ref{228,,TypeError}. Patch by
Rémi Lapeyre.

@item 
bpo-37449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37449}: @code{ensurepip} now uses @code{importlib.resources.files()}
traversable APIs

@item 
bpo-40956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40956}: Use Argument Clinic in @ref{cf,,sqlite3}.  Patches by Erlend E.
Aasland.

@item 
bpo-41730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41730}: @code{DeprecationWarning} is now raised when importing
@code{tkinter.tix}, which has been deprecated in documentation since
Python 3.6.

@item 
bpo-20684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20684}: Remove unused @code{_signature_get_bound_param} function from
@ref{7e,,inspect} - by Anthony Sottile.

@item 
bpo-41402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41402}: Fix @ref{18b1,,email.message.EmailMessage.set_content()} when called
with binary data and @code{7bit} content transfer encoding.

@item 
bpo-32695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32695}: The `compresslevel' and `preset' keyword arguments of
@ref{ef8,,tarfile.open()} are now both documented and tested.

@item 
bpo-41137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41137}: Use utf-8 encoding while reading .pdbrc files. Patch by
Srinivas Reddy Thatiparthy

@item 
bpo-24391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24391}: Improved reprs of @ref{ed,,threading} synchronization objects:
@ref{11c7,,Semaphore}, @ref{11c8,,BoundedSemaphore},
@ref{11c9,,Event} and @ref{1250,,Barrier}.

@item 
bpo-5846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5846}: Deprecated the following @ref{106,,unittest} functions, scheduled
for removal in Python 3.13:


@itemize *

@item 
@code{findTestCases()}

@item 
@code{makeSuite()}

@item 
@code{getTestCaseNames()}
@end itemize

Use @ref{3e2,,TestLoader} methods instead:


@itemize *

@item 
@ref{3e3,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{3e4,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{3e5,,unittest.TestLoader.getTestCaseNames()}
@end itemize

Patch by Erlend E. Aasland.

@item 
bpo-40563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40563}: Support pathlike objects on dbm/shelve. Patch by Hakan Çelik
and Henry-Joseph Audéoud.

@item 
bpo-34990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34990}: Fixed a Y2k38 bug in the compileall module where it would fail
to compile files with a modification time after the year 2038.

@item 
bpo-39549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39549}: Whereas the code for reprlib.Repr had previously used a
hardcoded string value of “…”, this PR updates it to use of a
“fillvalue” attribute, whose value defaults to “…” and can be reset in
either individual reprlib.Repr instances or in subclasses thereof.

@item 
bpo-37022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37022}: @ref{a5,,pdb} now displays exceptions from @code{repr()} with its
@code{p} and @code{pp} commands.

@item 
bpo-38840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38840}: Fix @code{test___all__} on platforms lacking a shared memory
implementation.

@item 
bpo-39359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39359}: Add one missing check that the password is a bytes object for
an encrypted zipfile.

@item 
bpo-38741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38741}: @ref{23,,configparser}: using “]” inside a section header will no
longer cut the section name short at the “]”

@item 
bpo-38415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38415}: Added missing behavior to
@ref{bb3,,contextlib.asynccontextmanager()} to match
@ref{126f,,contextlib.contextmanager()} so decorated functions can themselves be
decorators.

@item 
bpo-30256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30256}: Pass multiprocessing BaseProxy argument @code{manager_owned}
through AutoProxy.

@item 
bpo-27513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27513}: @ref{344,,email.utils.getaddresses()} now accepts
@ref{18b2,,email.header.Header} objects along with string values. Patch by
Zackery Spytz.

@item 
bpo-16379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16379}: Add SQLite error code and name to @ref{cf,,sqlite3} exceptions.
Patch by Aviv Palivoda, Daniel Shahaf, and Erlend E. Aasland.

@item 
bpo-26228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26228}: pty.spawn no longer hangs on FreeBSD, macOS, and Solaris.

@item 
bpo-33349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33349}: lib2to3 now recognizes async generators everywhere.

@item 
bpo-29298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29298}: Fix @code{TypeError} when required subparsers without @code{dest} do
not receive arguments. Patch by Anthony Sottile.
@end itemize

@node Documentation<24>,Tests<24>,Library<25>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id219}@anchor{18b3}
@subsubsection Documentation



@itemize -

@item 
bpo-45216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45216}: Remove extra documentation listing methods in @code{difflib}. It
was rendering twice in pydoc and was outdated in some places.

@item 
bpo-45024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45024}: @ref{1f,,collections.abc} documentation has been expanded to
explicitly cover how instance and subclass checks work, with additional
doctest examples and an exhaustive list of ABCs which test membership
purely by presence of the right @ref{18b4,,special method}s. Patch by Raymond
Hettinger.

@item 
bpo-44957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44957}: Promote PEP 604 union syntax by using it where possible. Also,
mention @code{X | Y} more prominently in section about @code{Union} and mention
@code{X | None} at all in section about @code{Optional}.

@item 
bpo-16580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16580}: Added code equivalents for the @ref{1897,,int.to_bytes()} and
@ref{1857,,int.from_bytes()} methods, as well as tests ensuring that these code
equivalents are valid.

@item 
bpo-44903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44903}: Removed the @code{othergui.rst} file, any references to it, and
the list of GUI frameworks in the FAQ. In their place I’ve added links to
the Python Wiki page on GUI frameworks@footnote{https://wiki.python.org/moin/GuiProgramming}.

@item 
bpo-33479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33479}: Tkinter documentation has been greatly expanded with new
«Architecture» and «Threading model» sections.

@item 
bpo-36700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36700}: @ref{f,,base64} RFC references were updated to point to
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}; a section was added to point users to the new «security
considerations» section of the RFC.

@item 
bpo-44740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44740}: Replaced occurrences of uppercase «Web» and «Internet» with
lowercase versions per the 2016 revised Associated Press Style Book.

@item 
bpo-44693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44693}: Update the definition of __future__ in the glossary by
replacing the confusing word «pseudo-module» with a more accurate
description.

@item 
bpo-35183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35183}: Add typical examples to os.path.splitext docs

@item 
bpo-30511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30511}: Clarify that @ref{55a,,shutil.make_archive()} is not thread-safe due
to reliance on changing the current working directory.

@item 
bpo-44561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44561}: Update of three expired hyperlinks in
Doc/distributing/index.rst: «Project structure», «Building and packaging
the project», and «Uploading the project to the Python Packaging Index».

@item 
bpo-44651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44651}: Delete entry «coercion» in Doc/glossary.rst for its outdated
definition.

@item 
bpo-42958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42958}: Updated the docstring and docs of @ref{1669,,filecmp.cmp()} to be
more accurate and less confusing especially in respect to `shallow' arg.

@item 
bpo-44631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44631}: Refactored the @code{repr()} code of the @code{_Environ} (os module).

@item 
bpo-44613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44613}: importlib.metadata is no longer provisional.

@item 
bpo-44558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44558}: Match the docstring and python implementation of
@ref{973,,countOf()} to the behavior of its c implementation.

@item 
bpo-44544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44544}: List all kwargs for @ref{1503,,textwrap.wrap()},
@ref{1502,,textwrap.fill()}, and @ref{104f,,textwrap.shorten()}. Now, there are nav
links to attributes of @code{TextWrap}, which makes navigation much
easier while minimizing duplication in the documentation.

@item 
bpo-38062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38062}: Clarify that atexit uses equality comparisons internally.

@item 
bpo-40620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40620}: Convert examples in tutorial controlflow.rst section 4.3 to be
interpreter-demo style.

@item 
bpo-43066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43066}: Added a warning to @ref{130,,zipfile} docs: filename arg with a
leading slash may cause archive to be un-openable on Windows systems.

@item 
bpo-39452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39452}: Rewrote @code{Doc/library/__main__.rst}. Broadened scope of the
document to explicitly discuss and differentiate between @code{__main__.py}
in packages versus the @code{__name__ == '__main__'} expression (and the
idioms that surround it).

@item 
bpo-13814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13814}: In the Design FAQ, answer «Why don’t generators support the
with statement?»

@item 
bpo-27752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27752}: Documentation of csv.Dialect is more descriptive.

@item 
bpo-44453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44453}: Fix documentation for the return type of
@ref{1395,,sysconfig.get_path()}.

@item 
bpo-44392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44392}: Added a new section in the C API documentation for types used
in type hinting.  Documented @code{Py_GenericAlias} and
@code{Py_GenericAliasType}.

@item 
bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}: Mark @code{typing.io} and @code{typing.re} as deprecated since Python
3.8 in the documentation. They were never properly supported by type
checkers.

@item 
bpo-44322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44322}: Document that SyntaxError args have a details tuple and that
details are adjusted for errors in f-string field replacement expressions.

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: Document the deprecation and removal of the @code{loop} parameter
for many functions and classes in @ref{b,,asyncio}.

@item 
bpo-44195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44195}: Corrected references to @code{TraversableResources} in docs. There
is no @code{TraversableReader}.

@item 
bpo-41963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41963}: Document that @code{ConfigParser} strips off comments when reading
configuration files.

@item 
bpo-44072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44072}: Correct where in the numeric ABC hierarchy @code{**} support is
added, i.e., in numbers.Complex, not numbers.Integral.

@item 
bpo-43558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43558}: Add the remark to @ref{30,,dataclasses} documentation that the
@code{__init__()} of any base class has to be called in
@code{__post_init__()}, along with a code example.

@item 
bpo-44025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44025}: Clarify when “_” in match statements is a keyword, and when
not.

@item 
bpo-41706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41706}: Fix docs about how methods like @code{__add__} are invoked when
evaluating operator expressions.

@item 
bpo-41621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41621}: Document that @ref{122a,,collections.defaultdict} parameter
@code{default_factory} defaults to @code{None} and is positional-only.

@item 
bpo-41576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41576}: document BaseException in favor of bare except

@item 
bpo-21760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21760}: The description for __file__ fixed. Patch by Furkan Onder

@item 
bpo-39498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39498}: Add a «Security Considerations» index which links to standard
library modules that have explicitly documented security considerations.

@item 
bpo-33479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33479}: Remove the unqualified claim that tkinter is threadsafe. It has
not been true for several years and likely never was. An explanation of
what is true may be added later, after more discussion, and possibly after
patching _tkinter.c,
@end itemize

@node Tests<24>,Build<25>,Documentation<24>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id220}@anchor{18b5}
@subsubsection Tests



@itemize -

@item 
bpo-40173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40173}: Fix @ref{18b6,,test.support.import_helper.import_fresh_module()}.

@item 
bpo-45280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45280}: Add a test case for empty @ref{1db,,typing.NamedTuple}.

@item 
bpo-45269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45269}: Cover case when invalid @code{markers} type is supplied to
@code{c_make_encoder}.

@item 
bpo-45128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45128}: Fix @code{test_multiprocessing_fork} failure due to
@code{test_logging} and @code{sys.modules} manipulation.

@item 
bpo-45209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45209}: Fix @code{UserWarning: resource_tracker} warning in
@code{_test_multiprocessing._TestSharedMemory.test_shared_memory_cleaned_after_process_termination}

@item 
bpo-45185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45185}: Enables @code{TestEnumerations} test cases in @code{test_ssl} suite.

@item 
bpo-45195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45195}: Fix test_readline.test_nonascii(): sometimes, the newline
character is not written at the end, so don’t expect it in the output.
Patch by Victor Stinner.

@item 
bpo-45156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45156}: Fixes infinite loop on @ref{c29,,unittest.mock.seal()} of mocks
created by @code{create_autospec()}.

@item 
bpo-45125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45125}: Improves pickling tests and docs of @code{SharedMemory} and
@code{SharableList} objects.

@item 
bpo-44860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44860}: Update @code{test_sysconfig.test_user_similar()} for the
posix_user scheme: @code{platlib} doesn’t use @ref{9cb,,sys.platlibdir}. Patch
by Victor Stinner.

@item 
bpo-45052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45052}: @code{WithProcessesTestSharedMemory.test_shared_memory_basics}
test was ignored, because @code{self.assertEqual(sms.size, sms2.size)} line
was failing. It is now removed and test is unskipped.

The main motivation for this line to be removed from the test is that the
@code{size} of @code{SharedMemory} is not ever guaranteed to be the same. It is
decided by the platform.

@item 
bpo-44895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44895}: libregrtest now clears the type cache later to reduce the risk
of false alarm when checking for reference leaks. Previously, the type
cache was cleared too early and libregrtest raised a false alarm about
reference leaks under very specific conditions. Patch by Irit Katriel and
Victor Stinner.

@item 
bpo-45042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45042}: Fixes that test classes decorated with
@code{@@hashlib_helper.requires_hashdigest} were skipped all the time.

@item 
bpo-25130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25130}: Add calls of @ref{acc,,gc.collect()} in tests to support PyPy.

@item 
bpo-45011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45011}: Made tests relying on the @code{_asyncio} C extension module
optional to allow running on alternative Python implementations. Patch by
Serhiy Storchaka.

@item 
bpo-44949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44949}: Fix auto history tests of test_readline: sometimes, the newline
character is not written at the end, so don’t expect it in the output.

@item 
bpo-44891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44891}: Tests were added to clarify @ref{1462,,id()} is preserved when @code{obj
* 1} is used on @ref{237,,str} and @ref{325,,bytes} objects. Patch by Nikita
Sobolev.

@item 
bpo-44852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44852}: Add ability to wholesale silence DeprecationWarnings while
running the regression test suite.

@item 
bpo-40928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40928}: Notify users running test_decimal regression tests on macOS of
potential harmless «malloc can’t allocate region» messages spewed by
test_decimal.

@item 
bpo-44734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44734}: Fixed floating-point precision issue in turtle tests.

@item 
bpo-44708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44708}: Regression tests, when run with -w, are now re-running only the
affected test methods instead of re-running the entire test file.

@item 
bpo-42095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42095}: Added interop tests for Apple plists: generate plist files with
Python plistlib and parse with Apple plutil; and the other way round.

@item 
bpo-44647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44647}: Added a permanent Unicode-valued environment variable to
regression tests to ensure they handle this use case in the future. If
your test environment breaks because of that, report a bug to us, and
temporarily set PYTHONREGRTEST_UNICODE_GUARD=0 in your test environment.

@item 
bpo-44515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44515}: Adjust recently added contextlib tests to avoid assuming the
use of a refcounted GC

@item 
bpo-44287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44287}: Fix asyncio test_popen() of test_windows_utils by using a
longer timeout. Use military grade battle-tested
@ref{18b7,,test.support.SHORT_TIMEOUT} timeout rather than a hardcoded timeout
of 10 seconds: it’s 30 seconds by default, but it is made longer on slow
buildbots. Patch by Victor Stinner.

@item 
bpo-44451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44451}: Reset @code{DeprecationWarning} filters in
@code{test.test_importlib.test_metadata_api.APITests.test_entry_points_by_index}
to avoid @code{StopIteration} error if @code{DeprecationWarnings} are ignored.

@item 
bpo-44363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44363}: Account for address sanitizer in test_capi. test_capi now
passes when run GCC address sanitizer.

@item 
bpo-44364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44364}: Add non integral tests for @ref{a98,,math.sqrt()} function.

@item 
bpo-43921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43921}: Fix test_ssl.test_wrong_cert_tls13(): use
@code{suppress_ragged_eofs=False}, since @code{read()} can raise
@ref{174c,,ssl.SSLEOFError} on Windows. Patch by Victor Stinner.

@item 
bpo-43921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43921}: Fix test_pha_required_nocert() of test_ssl: catch two more EOF
cases (when the @code{recv()} method returns an empty string). Patch by
Victor Stinner.

@item 
bpo-44131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44131}: Add test_frozenmain to test_embed to test the
@code{Py_FrozenMain()} C function. Patch by Victor Stinner.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Ignore error string case in test_file_not_exists().

@item 
bpo-42083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42083}: Add test to check that @code{PyStructSequence_NewType} accepts a
@code{PyStructSequence_Desc} with @code{doc} field set to @code{NULL}.

@item 
bpo-35753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35753}: Fix crash in doctest when doctest parses modules that include
unwrappable functions by skipping those functions.

@item 
bpo-30256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30256}: Add test for nested queues when using @code{multiprocessing}
shared objects @code{AutoProxy[Queue]} inside @code{ListProxy} and @code{DictProxy}
@end itemize

@node Build<25>,Windows<25>,Tests<24>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id221}@anchor{18b8}
@subsubsection Build



@itemize -

@item 
bpo-45220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45220}: Avoid building with the Windows 11 SDK previews automatically.
This may be overridden by setting the @code{DefaultWindowsSDKVersion}
environment variable before building.

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: Freeze stdlib modules that are imported during startup.  This
provides significant performance improvements to startup.  If necessary,
use the previously added «-X frozen_modules=off» commandline option to
force importing the source modules.

@item 
bpo-45188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45188}: Windows builds now regenerate frozen modules as the first part
of the build. Previously the regeneration was later in the build, which
would require it to be restarted if any modules had changed.

@item 
bpo-45163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45163}: Fixes Haiku platform build.

@item 
bpo-45067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45067}: The ncurses function extended_color_content was introduced in
2017

(@indicateurl{https://invisible-island.net/ncurses/NEWS.html#index-t20170401}).  The

ncurses-devel package in CentOS 7 had a older version ncurses resulted in
compilation error.  For compiling ncurses with extended color support, we
verify the version of the ncurses library >= 20170401.

@item 
bpo-45019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45019}: Generate lines in relevant files for frozen modules.  Up until
now each of the files had to be edited manually.  This change makes it
easier to add to and modify the frozen modules.

@item 
bpo-44340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44340}: Add support for building with clang thin lto via
–with-lto=thin/full. Patch by Donghee Na and Brett Holman.

@item 
bpo-44535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44535}: Enable building using a Visual Studio 2022 install on Windows.

@item 
bpo-43298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43298}: Improved error message when building without a Windows SDK
installed.

@item 
bpo-44381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44381}: The Windows build now accepts 
@geindex EnableControlFlowGuard
@geindex variables de entorno; EnableControlFlowGuard
@code{EnableControlFlowGuard}
set to @code{guard} to enable CFG.

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: Fix broken @code{make install} that caused standard library
extension modules to be unnecessarily and incorrectly rebuilt during the
install phase of cpython.
@end itemize

@node Windows<25>,macOS<20>,Build<25>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id222}@anchor{18b9}
@subsubsection Windows



@itemize -

@item 
bpo-45375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45375}: Fixes an assertion failure due to searching for the standard
library in unnormalised paths.

@item 
bpo-45022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45022}: Update Windows release to include libffi 3.4.2

@item 
bpo-45007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45007}: Update to OpenSSL 1.1.1l in Windows build

@item 
bpo-44848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44848}: Upgrade Windows installer to use SQLite 3.36.0.

@item 
bpo-44572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44572}: Avoid consuming standard input in the @ref{aa,,platform} module

@item 
bpo-44582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44582}: Accelerate speed of @ref{8f,,mimetypes} initialization using a
native implementation of the registry scan.

@item 
bpo-41299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41299}: Fix 16 milliseconds jitter when using timeouts in
@ref{ed,,threading}, such as with @ref{739,,threading.Lock.acquire()} or
@ref{18ba,,threading.Condition.wait()}.

@item 
bpo-42686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42686}: Build @ref{cf,,sqlite3} with math functions enabled. Patch by
Erlend E. Aasland.

@item 
bpo-40263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40263}: This is a follow-on bug from
@indicateurl{https://bugs.python.org/issue26903}. Once that is applied we run into an
off-by-one assertion problem. The assert was not correct.
@end itemize

@node macOS<20>,IDLE<15>,Windows<25>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id223}@anchor{18bb}
@subsubsection macOS



@itemize -

@item 
bpo-45007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45007}: Update macOS installer builds to use OpenSSL 1.1.1l.

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: When building CPython on macOS with @code{./configure
--with-undefined-behavior-sanitizer --with-pydebug}, the stack size is
now quadrupled to allow for the entire test suite to pass.

@item 
bpo-44848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44848}: Update macOS installer to use SQLite 3.36.0.

@item 
bpo-44689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44689}: @ref{dd0,,ctypes.util.find_library()} now works correctly on macOS
11 Big Sur even if Python is built on an older version of macOS.
Previously, when built on older macOS systems, @code{find_library} was not
able to find  macOS system libraries when running on Big Sur due to
changes in  how system libraries are stored.

@item 
bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972}: The framework build’s user header path in sysconfig is changed
to add a “pythonX.Y” component to match distutils’s behavior.

@item 
bpo-43109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43109}: Allow –with-lto configure option to work with Apple-supplied
Xcode or Command Line Tools.

@item 
bpo-34932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34932}: Add socket.TCP_KEEPALIVE support for macOS. Patch by Shane
Harvey.
@end itemize

@node IDLE<15>,Tools/Demos<14>,macOS<20>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id224}@anchor{18bc}
@subsubsection IDLE



@itemize -

@item 
bpo-45296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45296}: On Windows, change exit/quit message to suggest Ctrl-D, which
works, instead of <Ctrl-Z Return>, which does not work in IDLE.

@item 
bpo-45193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45193}: Make completion boxes appear on Ubuntu again.

@item 
bpo-40128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40128}: Mostly fix completions on macOS when not using tcl/tk 8.6.11
(as with 3.9). The added update_idletask call should be harmless and
possibly helpful otherwise.

@item 
bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}: Move the indent space setting from the Font tab to the new
Windows tab. Patch by Mark Roseman and Terry Jan Reedy.

@item 
bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}: Split the settings dialog General tab into Windows and Shell/ED
tabs. Move help sources, which extend the Help menu, to the Extensions
tab. Make space for new options and shorten the dialog. The latter makes
the dialog better fit small screens.

@item 
bpo-41611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41611}: Avoid uncaught exceptions in
@code{AutoCompleteWindow.winconfig_event()}.

@item 
bpo-41611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41611}: Fix IDLE sometimes freezing upon tab-completion on macOS.

@item 
bpo-44010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44010}: Highlight the new @ref{8a4,,match} statement’s @ref{8a3,,soft keywords}: @ref{8a4,,match}, @ref{8a4,,case}, and
@ref{8a5,,_}. However, this highlighting is not
perfect and will be incorrect in some rare cases, including some @code{_}-s
in @code{case} patterns.

@item 
bpo-44026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44026}: Include interpreter’s typo fix suggestions in message line for
NameErrors and AttributeErrors.  Patch by E. Paine.
@end itemize

@node Tools/Demos<14>,C API<24>,IDLE<15>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id225}@anchor{18bd}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-44786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44786}: Fix a warning in regular expression in the c-analyzer script.

@item 
bpo-44967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44967}: pydoc now returns a non-zero status code when a module cannot
be found.

@item 
bpo-44978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44978}: Allow the Argument Clinic tool to handle @code{__complex__}
special methods.

@item 
bpo-43425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43425}: Removed the “test2to3” demo project that demonstrated using
lib2to3 to support Python 2.x and Python 3.x from a single source in a
distutils package. Patch by Donghee Na

@item 
bpo-44074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44074}: Make patchcheck automatically detect the correct base branch
name (previously it was hardcoded to “master”)

@item 
bpo-20291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20291}: Added support for variadic positional parameters in Argument
Clinic.
@end itemize

@node C API<24>,,Tools/Demos<14>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id226}@anchor{18be}
@subsubsection C API



@itemize -

@item 
bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}: The PyThread_acquire_lock_timed() function now clamps the
timeout if it is too large, rather than aborting the process. Patch by
Victor Stinner.

@item 
bpo-44687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44687}: @code{BufferedReader.peek()} no longer raises @ref{360,,ValueError}
when the entire file has already been buffered.

@item 
bpo-45116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45116}: Add the @ref{18bf,,Py_ALWAYS_INLINE} macro to ask the compiler
to always inline a static inline function. The compiler can ignore it and
decides to not inline the function. Patch by Victor Stinner.

@item 
bpo-45094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45094}: Add the @ref{18c0,,Py_NO_INLINE} macro to disable inlining on a
function. Patch by Victor Stinner.

@item 
bpo-45061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45061}: Add a deallocator to the @ref{513,,bool} type to detect refcount
bugs in C extensions which call @code{Py_DECREF(Py_True);} or
@code{Py_DECREF(Py_False);} by mistake. Patch by Victor Stinner.

@item 
bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}: Add a new @ref{7ed,,PyType_GetQualName()} function to get type’s
qualified name.

@item 
bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}: Reverts removal of the old buffer protocol because they are
part of stable ABI.

@item 
bpo-44751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44751}: Remove @code{crypt.h} include from the public @code{Python.h} header.

@item 
bpo-42747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42747}: The @code{Py_TPFLAGS_HAVE_VERSION_TAG} type flag now does nothing.
The @code{Py_TPFLAGS_HAVE_AM_SEND} flag (which was added in 3.10) is removed.
Both were unnecessary because it is not possible to have type objects with
the relevant fields missing.

@item 
bpo-44530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44530}: Added the @code{co_qualname} to the @code{PyCodeObject} structure to
propagate the qualified name from the compiler to code objects.

Patch by Gabriele N. Tornetta

@item 
bpo-44441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44441}: @ref{a57,,Py_RunMain()} now resets @code{PyImport_Inittab} to
its initial value at exit. It must be possible to call
@ref{17ab,,PyImport_AppendInittab()} or @ref{17ac,,PyImport_ExtendInittab()} at
each Python initialization. Patch by Victor Stinner.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Remove 4 private trashcan C API functions which were only kept
for the backward compatibility of the stable ABI with Python 3.8 and
older, since the trashcan API was not usable with the limited C API on
Python 3.8 and older. The trashcan API was excluded from the limited C API
in Python 3.9.

Removed functions:


@itemize *

@item 
_PyTrash_deposit_object()

@item 
_PyTrash_destroy_chain()

@item 
_PyTrash_thread_deposit_object()

@item 
_PyTrash_thread_destroy_chain()
@end itemize

The trashcan C API was never usable with the limited C API, since old
trashcan macros accessed directly @ref{826,,PyThreadState} members like
@code{_tstate->trash_delete_nesting}, whereas the @ref{826,,PyThreadState}
structure is opaque in the limited C API.

Exclude also the @code{PyTrash_UNWIND_LEVEL} constant from the C API.

Patch by Victor Stinner.

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: Removed documentation for the removed @code{PyParser_*} C API.

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: The list in @ref{833,,Contenido de la API limitada} now shows the public name
@ref{822,,PyFrameObject} rather than @code{_frame}. The non-existing entry
@code{_node} no longer appears in the list.

@item 
bpo-44378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44378}: @ref{181c,,Py_IS_TYPE()} no longer uses @ref{26e,,Py_TYPE()} to avoid
a compiler warning: no longer cast @code{const PyObject*} to @code{PyObject*}.
Patch by Victor Stinner.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Convert the @ref{26e,,Py_TYPE()} and @ref{81b,,Py_SIZE()} macros to
static inline functions. The @ref{81a,,Py_SET_TYPE()} and
@ref{81c,,Py_SET_SIZE()} functions must now be used to set an object type and
size. Patch by Victor Stinner.

@item 
bpo-44263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44263}: The @ref{816,,PyType_Ready()} function now raises an error if a
type is defined with the @ref{817,,Py_TPFLAGS_HAVE_GC} flag set but has no
traverse function (@ref{818,,PyTypeObject.tp_traverse}). Patch by Victor
Stinner.

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: The undocumented function @code{Py_FrozenMain()} is removed
from the Limited API.

@item 
bpo-44113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44113}: Deprecate the following functions to configure the Python
initialization:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

Use the new @ref{499,,PyConfig} API of the @ref{49a,,Python Initialization Configuration} instead (
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}).

@item 
bpo-44094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44094}: Remove @code{PyErr_SetFromErrnoWithUnicodeFilename()},
@code{PyErr_SetFromWindowsErrWithUnicodeFilename()}, and
@code{PyErr_SetExcFromWindowsErrWithUnicodeFilename()}. They are not
documented and have been deprecated since Python 3.3.

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: @ref{92f,,PyCodec_Unregister()} is now properly exported as a
function in the Windows Stable ABI DLL.

@item 
bpo-44029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44029}: Remove deprecated @code{Py_UNICODE} APIs: @code{PyUnicode_Encode},
@code{PyUnicode_EncodeUTF7}, @code{PyUnicode_EncodeUTF8},
@code{PyUnicode_EncodeUTF16}, @code{PyUnicode_EncodeUTF32},
@code{PyUnicode_EncodeLatin1}, @code{PyUnicode_EncodeMBCS},
@code{PyUnicode_EncodeDecimal}, @code{PyUnicode_EncodeRawUnicodeEscape},
@code{PyUnicode_EncodeCharmap}, @code{PyUnicode_EncodeUnicodeEscape},
@code{PyUnicode_TransformDecimalToASCII}, @code{PyUnicode_TranslateCharmap},
@code{PyUnicodeEncodeError_Create}, @code{PyUnicodeTranslateError_Create}. See
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} and 
@geindex Python Enhancement Proposals; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/} for reference.

@item 
bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}: Add a new @ref{7ec,,PyType_GetName()} function to get type’s short
name.
@end itemize

@node Python 3 10 0 beta 1,Python 3 10 0 alpha 7,Python 3 11 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-beta-1}@anchor{18c1}
@subsection Python 3.10.0 beta 1


`Release date: 2021-05-03'

@menu
* Security: Security<16>. 
* Core and Builtins: Core and Builtins<26>. 
* Library: Library<26>. 
* Documentation: Documentation<25>. 
* Tests: Tests<25>. 
* Build: Build<26>. 
* Windows: Windows<26>. 
* macOS: macOS<21>. 
* IDLE: IDLE<16>. 
* C API: C API<25>. 

@end menu

@node Security<16>,Core and Builtins<26>,,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id227}@anchor{18c2}
@subsubsection Security



@itemize -

@item 
bpo-43434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43434}: Creating @ref{39e,,sqlite3.Connection} objects now also produces
@code{sqlite3.connect} and @code{sqlite3.connect/handle} @ref{18c3,,auditing events}. Previously these events were only produced by
@ref{3f5,,sqlite3.connect()} calls. Patch by Erlend E. Aasland.

@item 
bpo-43998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43998}: The @ref{d0,,ssl} module sets more secure cipher suites defaults.
Ciphers without forward secrecy and with SHA-1 MAC are disabled by
default. Security level 2 prohibits weak RSA, DH, and ECC keys with less
than 112 bits of security. @ref{1fa,,SSLContext} defaults to minimum
protocol version TLS 1.2. Settings are based on Hynek Schlawack’s
research.

@item 
bpo-43882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43882}: The presence of newline or tab characters in parts of a URL
could allow some forms of attacks.

Following the controlling specification for URLs defined by WHATWG
@ref{10a,,urllib.parse()} now removes ASCII newlines and tabs from URLs,
preventing such attacks.

@item 
bpo-43472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43472}: Ensures interpreter-level audit hooks receive the
@code{cpython.PyInterpreterState_New} event when called through the
@code{_xxsubinterpreters} module.

@item 
bpo-43362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43362}: Fix invalid free in _sha3 module. The issue was introduced in
3.10.0a1. Python 3.9 and earlier are not affected.

@item 
bpo-43762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43762}: Add audit events for @code{sqlite3.connect/handle()},
@ref{8d5,,sqlite3.Connection.enable_load_extension()}, and
@ref{55f,,sqlite3.Connection.load_extension()}. Patch by Erlend E. Aasland.

@item 
bpo-43756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43756}: Add new audit event @code{glob.glob/2} to incorporate the new
`root_dir' and `dir_fd' arguments added to @ref{3ef,,glob.glob()} and
@ref{89e,,glob.iglob()}.

@item 
bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}: @ref{80,,ipaddress} module no longer accepts any leading zeros in
IPv4 address strings. Leading zeros are ambiguous and interpreted as octal
notation by some libraries. For example the legacy function
@ref{9f4,,socket.inet_aton()} treats leading zeros as octal notation. glibc
implementation of modern @ref{9f5,,inet_pton()} does not accept any
leading zeros. For a while the @ref{80,,ipaddress} module used to accept
ambiguous leading zeros.

@item 
bpo-43075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43075}: Fix Regular Expression Denial of Service (ReDoS) vulnerability
in @ref{18c4,,urllib.request.AbstractBasicAuthHandler}.  The ReDoS-vulnerable
regex has quadratic worst-case complexity and it allows cause a denial of
service when identifying crafted invalid RFCs. This ReDoS issue is on the
client side and needs remote attackers to control the HTTP server.

@item 
bpo-42800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42800}: Audit hooks are now fired for frame.f_code, traceback.tb_frame,
and generator code/frame attribute access.

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: Add audit events to the @ref{6f,,http.client} module.
@end itemize

@node Core and Builtins<26>,Library<26>,Security<16>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id228}@anchor{18c5}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: Prevent classes being both a sequence and a mapping when
pattern matching.

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: Use @ref{18c6,,tp_flags} on the class object to
determine if the subject is a sequence or mapping when pattern matching.
Avoids the need to import @ref{1f,,collections.abc} when pattern matching.

@item 
bpo-43892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43892}: Restore proper validation of complex literal value patterns
when parsing @code{match} blocks.

@item 
bpo-43933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43933}: Set frame.f_lineno to the line number of the “with” kweyword
when executing the call to @code{__exit__}.

@item 
bpo-43933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43933}: If the current position in a frame has no line number then set
the f_lineno attribute to None, instead of -1, to conform to PEP 626. This
should not normally be possible, but might occur in some unusual
circumstances.

@item 
bpo-43963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43963}: Importing the @code{_signal} module in a subinterpreter has no
longer side effects.

@item 
bpo-42739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42739}: The internal representation of line number tables is changed to
not use sentinels, and an explicit length parameter is added to the out of
process API function @code{PyLineTable_InitAddressRange}. This makes the
handling of line number tables more robust in some circumstances.

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: Make @ref{b9,,re} types immutable. Patch by Erlend E. Aasland.

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: Make the @ref{308,,array.array} type immutable. Patch by Erlend
E. Aasland.

@item 
bpo-43901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43901}: Change class and module objects to lazy-create empty
annotations dicts on demand.  The annotations dicts are stored in the
object’s __dict__ for backwards compatibility.

@item 
bpo-43892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43892}: Match patterns now use new dedicated AST nodes (@code{MatchValue},
@code{MatchSingleton}, @code{MatchSequence}, @code{MatchStar}, @code{MatchMapping},
@code{MatchClass}) rather than reusing expression AST nodes. @code{MatchAs} and
@code{MatchOr} are now defined as pattern nodes rather than as expression
nodes. Patch by Nick Coghlan.

@item 
bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}: Usage of @code{await}/@code{yield}/@code{yield from} and named
expressions within an annotation is now forbidden when PEP 563 is
activated.

@item 
bpo-43754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43754}: When performing structural pattern matching (
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}),
captured names are now left unbound until the `entire' pattern has matched
successfully.

@item 
bpo-42737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42737}: Annotations for complex targets (everything beside simple
names) no longer cause any runtime effects with @code{from __future__ import
annotations}.

@item 
bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}: @ref{150,,SyntaxError} exceptions raised by the interpreter will
highlight the full error range of the expression that constitutes the
syntax error itself, instead of just where the problem is detected. Patch
by Pablo Galindo.

@item 
bpo-38605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38605}: Revert making @code{from __future__ import annotations} the
default. This follows the Steering Council decision to postpone PEP 563
changes to at least Python 3.11. See the original email for more
information regarding the decision:
@indicateurl{https://mail.python.org/archives/list/python-dev@@python.org/thread/CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ/}.
Patch by Pablo Galindo.

@item 
bpo-43475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43475}: Hashes of NaN values now depend on object identity.  Formerly,
they always hashed to 0 even though NaN values are not equal to one
another.  Having the same hash for unequal values caused pile-ups in hash
tables.

@item 
bpo-43859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43859}: Improve the error message for @ref{841,,IndentationError}
exceptions. Patch by Pablo Galindo

@item 
bpo-41323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41323}: Constant tuple folding in bytecode optimizer now reuses tuple
in constant table.

@item 
bpo-43846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43846}: Data stack usage is much reduced for large literal and call
expressions.

@item 
bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}: When printing @ref{4ec,,NameError} raised by the interpreter,
@code{PyErr_Display()} will offer suggestions of similar variable names
in the function that the exception was raised from. Patch by Pablo Galindo

@item 
bpo-43823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43823}: Improve syntax errors for invalid dictionary literals. Patch by
Pablo Galindo.

@item 
bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}: Improve syntax errors in the parser for missing commas between
expressions. Patch by Pablo Galindo.

@item 
bpo-43798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43798}: @ref{18c7,,ast.alias} nodes now include source location metadata
attributes e.g. lineno, col_offset.

@item 
bpo-43797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43797}: Improve @code{SyntaxError} error messages for invalid comparisons.
Patch by Pablo Galindo.

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: Move the flag for checking whether tracing is enabled to the C
stack, from the heap. Should speed up dispatch in the interpreter.

@item 
bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}: Static methods (@ref{22e,,@@staticmethod}) and class
methods (@ref{2d2,,@@classmethod}) now inherit the method
attributes (@code{__module__}, @code{__name__}, @code{__qualname__}, @code{__doc__},
@code{__annotations__}) and have a new @code{__wrapped__} attribute. Patch by
Victor Stinner.

@item 
bpo-43751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43751}: Fixed a bug where @code{anext(ait, default)} would erroneously
return None.

@item 
bpo-42128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42128}: @ref{18c8,,__match_args__} is no longer allowed to be a
list.

@item 
bpo-43683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43683}: Add GEN_START opcode. Marks start of generator, including
async, or coroutine and handles sending values to a newly created
generator or coroutine.

@item 
bpo-43105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43105}: Importlib now resolves relative paths when creating module spec
objects from file locations.

@item 
bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}: Static methods (@ref{22e,,@@staticmethod}) are now
callable as regular functions. Patch by Victor Stinner.

@item 
bpo-42609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42609}: Prevented crashes in the AST validator and optimizer when
compiling some absurdly long expressions like @code{"+0"*1000000}.
@ref{df1,,RecursionError} is now raised instead.

@item 
bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}: When printing @ref{441,,AttributeError}, @code{PyErr_Display()}
will offer suggestions of similar attribute names in the object that the
exception was raised from. Patch by Pablo Galindo
@end itemize

@node Library<26>,Documentation<25>,Core and Builtins<26>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id229}@anchor{18c9}
@subsubsection Library



@itemize -

@item 
bpo-44015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44015}: In @@dataclass(), raise a TypeError if KW_ONLY is specified more
than once.

@item 
bpo-25478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25478}: Added a `total()' method to collections.Counter() to compute
the sum of the counts.

@item 
bpo-43733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43733}: Change @ref{18ca,,netrc.netrc} to use UTF-8 encoding before using
locale encoding.

@item 
bpo-43979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43979}: Removed an unnecessary list comprehension before looping from
@ref{1c8,,urllib.parse.parse_qsl()}.  Patch by Christoph Zwerschke and Donghee
Na.

@item 
bpo-43993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43993}: Update bundled pip to 21.1.1.

@item 
bpo-43957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43957}: [Enum] Deprecate @code{TypeError} when non-member is used in a
containment check; In 3.12 @code{True} or @code{False} will be returned instead,
and containment will return @code{True} if the value is either a member of
that enum or one of its members” value.

@item 
bpo-42904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42904}: For backwards compatibility with previous minor versions of
Python, if @ref{752,,typing.get_type_hints()} receives no namespace dictionary
arguments, @ref{752,,typing.get_type_hints()} will search through the global
then local namespaces during evaluation of stringized type annotations
(string forward references) inside a class.

@item 
bpo-43945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43945}: [Enum] Deprecate non-standard mixin format() behavior: in 3.12
the enum member, not the member’s value, will be used for format() calls.

@item 
bpo-41139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41139}: Deprecate undocumented @code{cgi.log()} API.

@item 
bpo-43937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43937}: Fixed the @ref{101,,turtle} module working with non-default root
window.

@item 
bpo-43930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43930}: Update bundled pip to 21.1 and setuptools to 56.0.0

@item 
bpo-43907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43907}: Fix a bug in the pure-Python pickle implementation when using
protocol 5, where bytearray instances that occur several time in the
pickled object graph would incorrectly unpickle into repeated copies of
the bytearray object.

@item 
bpo-43926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43926}: In @code{importlib.metadata}, provide a uniform interface to
@code{Description}, allow for any field to be encoded with multiline values,
remove continuation lines from multiline values, and add a @code{.json}
property for easy access to the PEP 566 JSON-compatible form. Sync with
@code{importlib_metadata 4.0}.

@item 
bpo-43920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43920}: OpenSSL 3.0.0: @ref{f6e,,load_verify_locations()}
now returns a consistent error message when cadata contains no valid
certificate.

@item 
bpo-43607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43607}: @ref{108,,urllib} can now convert Windows paths with @code{\\?\}
prefixes into URL paths.

@item 
bpo-43817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43817}: Add @ref{8aa,,inspect.get_annotations()}, which safely computes the
annotations defined on an object.  It works around the quirks of accessing
the annotations from various types of objects, and makes very few
assumptions about the object passed in. @ref{8aa,,inspect.get_annotations()}
can also correctly un-stringize stringized annotations.

@ref{181,,inspect.signature()}, @code{inspect.from_callable()}, and
@code{inspect.from_function()} now call @ref{8aa,,inspect.get_annotations()} to
retrieve annotations.  This means @ref{181,,inspect.signature()} and
@code{inspect.from_callable()} can now un-stringize stringized annotations,
too.

@item 
bpo-43284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43284}: platform.win32_ver derives the windows version from
sys.getwindowsversion().platform_version which in turn derives the version
from kernel32.dll (which can be of a different version than Windows
itself). Therefore change the platform.win32_ver to determine the version
using the platform module’s _syscmd_ver private function to return an
accurate version.

@item 
bpo-42854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42854}: The @ref{d0,,ssl} module now uses @code{SSL_read_ex} and
@code{SSL_write_ex} internally. The functions support reading and writing of
data larger than 2 GB. Writing zero-length data no longer fails with a
protocol violation error.

@item 
bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}: Port @code{_ssl} extension module to multiphase initialization.

@item 
bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}: @ref{d0,,ssl} now raises DeprecationWarning for OP_NO_SSL/TLS*
options, old TLS versions, old protocols, and other features that have
been deprecated since Python 3.6, 3.7, or OpenSSL 1.1.0.

@item 
bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}: 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} is now implemented purely in Python; builtin
@code{types.GenericAlias} objects no longer include @code{typing.ParamSpec} in
@code{__parameters__} (with the exception of @code{collections.abc.Callable}“s
@code{GenericAlias}). This means previously invalid uses of @code{ParamSpec}
(such as @code{list[P]}) which worked in earlier versions of Python 3.10
alpha, will now raise @code{TypeError} during substitution.

@item 
bpo-43867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43867}: The @ref{94,,multiprocessing} @code{Server} class now explicitly
catches @ref{dc7,,SystemExit} and closes the client connection in this case.
It happens when the @code{Server.serve_client()} method reaches the end of
file (EOF).

@item 
bpo-40443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40443}: Remove unused imports: pyclbr no longer uses copy, and typing
no longer uses ast. Patch by Victor Stinner.

@item 
bpo-43820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43820}: Remove an unneeded copy of the namespace passed to
dataclasses.make_dataclass().

@item 
bpo-43787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43787}: Add @code{__iter__()} method to @ref{8fd,,bz2.BZ2File},
@ref{4d8,,gzip.GzipFile}, and @ref{1088,,lzma.LZMAFile}. It makes iterating
them about 2x faster. Patch by Inada Naoki.

@item 
bpo-43680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43680}: Deprecate io.OpenWrapper and _pyio.OpenWrapper: use io.open and
_pyio.open instead. Until Python 3.9, _pyio.open was not a static method
and builtins.open was set to OpenWrapper to not become a bound method when
set to a class variable. _io.open is a built-in function whereas
_pyio.open is a Python function. In Python 3.10, _pyio.open() is now a
static method, and builtins.open() is now io.open().

@item 
bpo-43680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43680}: The Python @code{_pyio.open()} function becomes a static method
to behave as @ref{5c0,,io.open()} built-in function: don’t become a bound
method when stored as a class variable. It becomes possible since static
methods are now callable in Python 3.10. Moreover,
@code{_pyio.OpenWrapper()} becomes a simple alias to @code{_pyio.open()}.
Patch by Victor Stinner.

@item 
bpo-41515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41515}: Fix @ref{438,,KeyError} raised in @ref{752,,typing.get_type_hints()} due
to synthetic modules that don’t appear in @code{sys.modules}.

@item 
bpo-43776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43776}: When @ref{301,,subprocess.Popen} args are provided as a string or
as @ref{19b,,pathlib.Path}, the Popen instance repr now shows the right
thing.

@item 
bpo-42248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42248}: [Enum] ensure exceptions raised in @code{_missing__} are released

@item 
bpo-43744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43744}: fix issue with enum member name matching the start of a private
variable name

@item 
bpo-43772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43772}: Fixed the return value of @code{TypeVar.__ror__}. Patch by Jelle
Zijlstra.

@item 
bpo-43764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43764}: Add match_args parameter to @@dataclass decorator to allow
suppression of __match_args__ generation.

@item 
bpo-43799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43799}: OpenSSL 3.0.0: define @code{OPENSSL_API_COMPAT} 1.1.1 to suppress
deprecation warnings. Python requires OpenSSL 1.1.1 APIs.

@item 
bpo-43478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43478}: Mocks can no longer be used as the specs for other Mocks. As a
result, an already-mocked object cannot have an attribute mocked using
@code{autospec=True} or be the subject of a @code{create_autospec(...)} call.
This can uncover bugs in tests since these Mock-derived Mocks will always
pass certain tests (e.g. @ref{4ef,,isinstance()}) and builtin assert functions
(e.g. assert_called_once_with) will unconditionally pass.

@item 
bpo-43794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43794}: Add @ref{8ce,,ssl.OP_IGNORE_UNEXPECTED_EOF} constants (OpenSSL
3.0.0)

@item 
bpo-43785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43785}: Improve @code{bz2.BZ2File} performance by removing the RLock from
BZ2File. This makes BZ2File thread unsafe in the face of multiple
simultaneous readers or writers, just like its equivalent classes in
@ref{67,,gzip} and @ref{8a,,lzma} have always been.  Patch by Inada Naoki.

@item 
bpo-43789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43789}: OpenSSL 3.0.0: Don’t call the password callback function a
second time when first call has signaled an error condition.

@item 
bpo-43788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43788}: The header files for @ref{d0,,ssl} error codes are now OpenSSL
version-specific. Exceptions will now show correct reason and library
codes. The @code{make_ssl_data.py} script has been rewritten to use OpenSSL’s
text file with error codes.

@item 
bpo-43766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43766}: Implement 
@geindex Python Enhancement Proposals; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/} in the @ref{104,,typing} module by adding
@code{TypeGuard}.

@item 
bpo-25264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25264}: @ref{381,,os.path.realpath()} now accepts a `strict' keyword-only
argument. When set to @code{True}, @ref{4d5,,OSError} is raised if a path doesn’t
exist or a symlink loop is encountered.

@item 
bpo-43780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43780}: In @code{importlib.metadata}, incorporate changes from
importlib_metadata 3.10: Add mtime-based caching during distribution
discovery. Flagged use of dict result from @code{entry_points()} as
deprecated.

@item 
The @code{P.args} and @code{P.kwargs} attributes of @ref{2ca,,typing.ParamSpec}
are now instances of the new classes @ref{85f,,typing.ParamSpecArgs} and
@ref{860,,typing.ParamSpecKwargs}, which enables a more useful @code{repr()}.
Patch by Jelle Zijlstra.

@item 
bpo-43731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43731}: Add an @code{encoding} parameter @code{logging.fileConfig()}.

@item 
bpo-43712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43712}: Add @code{encoding} and @code{errors} parameters to
@ref{896,,fileinput.input()} and @ref{7d3,,fileinput.FileInput}.

@item 
bpo-38659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38659}: A @code{simple_enum} decorator is added to the @code{enum} module to
convert a normal class into an Enum. @code{test_simple_enum} added to test
simple enums against a corresponding normal Enum.  Standard library
modules updated to use @code{simple_enum}.

@item 
bpo-43764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43764}: Fix an issue where @ref{18c8,,__match_args__} generation
could fail for some @ref{30,,dataclasses}.

@item 
bpo-43752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43752}: Fix @ref{cf,,sqlite3} regression for zero-sized blobs with
converters, where @code{b""} was returned instead of @code{None}. The regression
was introduced by PR 24723. Patch by Erlend E. Aasland.

@item 
bpo-43655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43655}: @ref{f0,,tkinter} dialog windows are now recognized as dialogs by
window managers on macOS and X Window.

@item 
bpo-43723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43723}: The following @code{threading} methods are now deprecated and
should be replaced:


@itemize -

@item 
@code{currentThread} => @ref{203,,threading.current_thread()}

@item 
@code{activeCount} => @ref{204,,threading.active_count()}

@item 
@code{Condition.notifyAll} => @ref{1fd,,threading.Condition.notify_all()}

@item 
@code{Event.isSet} => @ref{1fe,,threading.Event.is_set()}

@item 
@code{Thread.setName} => @ref{202,,threading.Thread.name}

@item 
@code{thread.getName} => @ref{202,,threading.Thread.name}

@item 
@code{Thread.isDaemon} => @ref{200,,threading.Thread.daemon}

@item 
@code{Thread.setDaemon} => @ref{200,,threading.Thread.daemon}
@end itemize

Patch by Jelle Zijlstra.

@item 
bpo-2135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2135}: Deprecate find_module() and find_loader() implementations in
importlib and zipimport.

@item 
bpo-43534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43534}: @ref{18cb,,turtle.textinput()} and @ref{18cc,,turtle.numinput()} create now
a transient window working on behalf of the canvas window.

@item 
bpo-43532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43532}: Add the ability to specify keyword-only fields to dataclasses.
These fields will become keyword-only arguments to the generated __init__.

@item 
bpo-43522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43522}: Fix problem with
@ref{c05,,hostname_checks_common_name}. OpenSSL does not copy
hostflags from `struct SSL_CTX' to `struct SSL'.

@item 
bpo-8978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8978}: Improve error message for @ref{ef8,,tarfile.open()} when @ref{8a,,lzma}
/ @ref{14,,bz2} are unavailable.  Patch by Anthony Sottile.

@item 
bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}: Allow @ref{325,,bytes} @code{separator} argument in
@code{urllib.parse.parse_qs} and @code{urllib.parse.parse_qsl} when parsing
@ref{237,,str} query strings. Previously, this raised a @code{TypeError}.

@item 
bpo-43296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43296}: Improve @ref{cf,,sqlite3} error handling: @code{sqlite3_value_blob()}
errors that set @code{SQLITE_NOMEM} now raise @ref{16cb,,MemoryError}. Patch by
Erlend E. Aasland.

@item 
bpo-43312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43312}: New functions @ref{731,,sysconfig.get_preferred_scheme()} and
@ref{182a,,sysconfig.get_default_scheme()} are added to query a platform for its
preferred «user», «home», and «prefix» (default) scheme names.

@item 
bpo-43265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43265}: Improve @ref{c02,,sqlite3.Connection.backup()} error handling. The
error message for non-existent target database names is now @code{unknown
database <database name>} instead of @code{SQL logic error}. Patch by Erlend
E. Aasland.

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: Install schemes in @code{distutils.command.install} are now loaded
from @ref{db,,sysconfig}.

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: @code{distutils.sysconfig} has been merged to @ref{db,,sysconfig}.

@item 
bpo-43176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43176}: Fixed processing of a dataclass that inherits from a frozen
dataclass with no fields.  It is now correctly detected as an error.

@item 
bpo-43080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43080}: @ref{ae,,pprint} now has support for
@ref{32e,,dataclasses.dataclass}. Patch by Lewis Gaul.

@item 
bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}: Add @code{pathlib.Path.hardlink_to()} method that supersedes
@code{link_to()}. The new method has the same argument order as
@code{symlink_to()}.

@item 
bpo-42904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42904}: @ref{752,,typing.get_type_hints()} now checks the local namespace of
a class when evaluating 
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} annotations inside said class.

@item 
bpo-42269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42269}: Add @code{slots} parameter to @code{dataclasses.dataclass} decorator
to automatically generate @code{__slots__} for class. Patch provided by Yurii
Karabas.

@item 
bpo-39529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39529}: Deprecated use of @ref{214,,asyncio.get_event_loop()} without
running event loop. Emit deprecation warning for @ref{b,,asyncio} functions
which implicitly create a @ref{c55,,Future} or
@ref{580,,Task} objects if there is no running event loop and no
explicit `loop' argument is passed: @ref{cfe,,ensure_future()},
@ref{18cd,,wrap_future()}, @ref{69e,,gather()},
@ref{aff,,shield()}, @ref{311,,as_completed()} and constructors of
@ref{c55,,Future}, @ref{580,,Task},
@ref{18ce,,StreamReader}, @code{StreamReaderProtocol}.

@item 
bpo-18369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18369}: Certificate and PrivateKey classes were added to the ssl
module. Certificates and keys can now be loaded from memory buffer, too.

@item 
bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486}: Use a new output buffer management code for @ref{14,,bz2} /
@ref{8a,,lzma} / @ref{132,,zlib} modules, and add @code{.readall()} function to
@code{_compression.DecompressReader} class. These bring some performance
improvements. Patch by Ma Lin.

@item 
bpo-31870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31870}: The @ref{8d3,,ssl.get_server_certificate()} function now has a
`timeout' parameter.

@item 
bpo-41735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41735}: Fix thread locks in zlib module may go wrong in rare case.
Patch by Ma Lin.

@item 
bpo-36470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36470}: Fix dataclasses with @code{InitVar}s and
@ref{16ff,,replace()}. Patch by Claudiu Popa.

@item 
bpo-40849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40849}: Expose X509_V_FLAG_PARTIAL_CHAIN ssl flag

@item 
bpo-35114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35114}: @ref{18cf,,ssl.RAND_status()} now returns a boolean value (as
documented) instead of @code{1} or @code{0}.

@item 
bpo-39906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39906}: @ref{8ba,,pathlib.Path.stat()} and @ref{8bb,,chmod()} now
accept a `follow_symlinks' keyword-only argument for consistency with
corresponding functions in the @ref{a1,,os} module.

@item 
bpo-39899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39899}: @ref{aa6,,os.path.expanduser()} now refuses to guess Windows home
directories if the basename of current user’s home directory does not
match their username.

@ref{ec7,,pathlib.Path.expanduser()} and @ref{ec8,,home()} now
consistently raise @ref{1e5,,RuntimeError} exception when a home directory
cannot be resolved. Previously a @ref{438,,KeyError} exception could be raised
on Windows when the @code{"USERNAME"}  environment variable was unset.

@item 
bpo-36076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36076}: Added SNI support to @ref{8d3,,ssl.get_server_certificate()}.

@item 
bpo-38490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38490}: Covariance, Pearson’s correlation, and simple linear regression
functionality was added to statistics module. Patch by Tymoteusz Wołodźko.

@item 
bpo-33731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33731}: Provide a locale.localize() function, which converts a
normalized number string into a locale format.

@item 
bpo-32745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32745}: Fix a regression in the handling of ctypes”
@ref{16ee,,ctypes.c_wchar_p} type: embedded null characters would cause a
@ref{360,,ValueError} to be raised. Patch by Zackery Spytz.
@end itemize

@node Documentation<25>,Tests<25>,Library<26>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id230}@anchor{18d0}
@subsubsection Documentation



@itemize -

@item 
bpo-43987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43987}: Add «Annotations Best Practices» document as a new HOWTO.

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: Document the new @ref{18ac,,Py_TPFLAGS_MAPPING} and
@ref{18ad,,Py_TPFLAGS_SEQUENCE} type flags.

@item 
bpo-43959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43959}: The documentation on the PyContextVar C-API was clarified.

@item 
bpo-43938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43938}: Update dataclasses documentation to express that
FrozenInstanceError is derived from AttributeError.

@item 
bpo-43778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43778}: Fix the Sphinx glossary_search extension: create the _static/
sub-directory if it doesn’t exist.

@item 
bpo-43755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43755}: Update documentation to reflect that unparenthesized lambda
expressions can no longer be the expression part in an @code{if} clause in
comprehensions and generator expressions since Python 3.9.

@item 
bpo-43739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43739}: Fixing the example code in Doc/extending/extending.rst to
declare and initialize the pmodule variable to be of the right type.
@end itemize

@node Tests<25>,Build<26>,Documentation<25>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id231}@anchor{18d1}
@subsubsection Tests



@itemize -

@item 
bpo-43961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43961}: Fix test_logging.test_namer_rotator_inheritance() on Windows:
use @ref{1165,,os.replace()} rather than @ref{1164,,os.rename()}. Patch by Victor
Stinner.

@item 
bpo-43842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43842}: Fix a race condition in the SMTP test of test_logging. Don’t
close a file descriptor (socket) from a different thread while
asyncore.loop() is polling the file descriptor. Patch by Victor Stinner.

@item 
bpo-43843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43843}: @code{test.libregrtest} now marks a test as ENV_CHANGED
(altered the execution environment) if a thread raises an exception but
does not catch it. It sets a hook on @ref{8e2,,threading.excepthook()}. Use
@code{--fail-env-changed} option to mark the test as failed. Patch by Victor
Stinner.

@item 
bpo-43811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43811}: Tests multiple OpenSSL versions on GitHub Actions. Use ccache
to speed up testing.

@item 
bpo-43791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43791}: OpenSSL 3.0.0: Disable testing of legacy protocols TLS 1.0 and
1.1. Tests are failing with TLSV1_ALERT_INTERNAL_ERROR.
@end itemize

@node Build<26>,Windows<26>,Tests<25>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id232}@anchor{18d2}
@subsubsection Build



@itemize -

@item 
bpo-43567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43567}: Improved generated code refresh (AST/tokens/opcodes/keywords)
on Windows.

@item 
bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}: Implement 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}. Python now requires OpenSSL 1.1.1 or
newer.
@end itemize

@node Windows<26>,macOS<21>,Build<26>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id233}@anchor{18d3}
@subsubsection Windows



@itemize -

@item 
bpo-35306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35306}: Adds additional arguments to @ref{18d4,,os.startfile()} function.

@item 
bpo-43538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43538}: Avoid raising errors from @ref{aa8,,pathlib.Path.exists()} when
passed an invalid filename.

@item 
bpo-38822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38822}: Fixed @ref{548,,os.stat()} failing on inaccessible directories with
a trailing slash, rather than falling back to the parent directory’s
metadata. This implicitly affected @ref{aa0,,os.path.exists()} and
@ref{aa2,,os.path.isdir()}.

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: Fixed decoding of host names in @ref{18d5,,socket.gethostbyaddr()}
and @ref{18d6,,socket.gethostbyname_ex()}.

@item 
bpo-40432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40432}: Updated pegen regeneration script on Windows to find and use
Python 3.8 or higher.  Prior to this, pegen regeneration already required
3.8 or higher, but the script may have used lower versions of Python.

@item 
bpo-43745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43745}: Actually updates Windows release to OpenSSL 1.1.1k. Earlier
releases were mislabelled and actually included 1.1.1i again.

@item 
bpo-43652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43652}: Update Tcl and Tk to 8.6.11 in Windows installer.

@item 
bpo-43492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43492}: Upgrade Windows installer to use SQLite 3.35.5.

@item 
bpo-30555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30555}: Fix @code{WindowsConsoleIO} errors in the presence of fd
redirection. Patch by Segev Finer.
@end itemize

@node macOS<21>,IDLE<16>,Windows<26>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id234}@anchor{18d7}
@subsubsection macOS



@itemize -

@item 
bpo-42119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42119}: Fix check for macOS SDK paths when building Python. Narrow
search to match contents of SDKs, namely only files in
@code{/System/Library}, @code{/System/IOSSupport}, and @code{/usr} other than
@code{/usr/local}. Previously, anything under @code{/System} was assumed to be
in an SDK which causes problems with the new file system layout in 10.15+
where user file systems may appear to be mounted under @code{/System}.  Paths
in @code{/Library} were also incorrectly treated as SDK locations.

@item 
bpo-43568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43568}: Drop support for MACOSX_DEPLOYMENT_TARGET < 10.3

@item 
bpo-44009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44009}: Provide «python3.x-intel64» executable to allow reliably
forcing macOS universal2 framework builds to run under Rosetta 2 Intel-64
emulation on Apple Silicon Macs.  This can be useful for testing or when
universal2 wheels are not yet available.

@item 
bpo-43851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43851}: Build SQLite with @code{SQLITE_OMIT_AUTOINIT} on macOS. Patch by
Erlend E. Aasland.

@item 
bpo-43492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43492}: Update macOS installer to use SQLite 3.35.4.

@item 
bpo-42235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42235}: @code{Mac/BuildScript/build-installer.py} will now use
«–enable-optimizations» and @code{--with-lto} when building on macOS 10.15
or later.
@end itemize

@node IDLE<16>,C API<25>,macOS<21>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id235}@anchor{18d8}
@subsubsection IDLE



@itemize -

@item 
bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}: Add mouse actions to the shell sidebar.  Left click and
optional drag selects one or more lines, as with the editor line number
sidebar.  Right click after selecting raises a context menu with “copy
with prompts”.  This zips together prompts from the sidebar with lines
from the selected text.

@item 
bpo-43981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43981}: Fix reference leak in test_sidebar and test_squeezer. Patches
by Terry Jan Reedy and Pablo Galindo

@item 
bpo-37892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37892}: Indent IDLE Shell input with spaces instead of tabs

@item 
bpo-43655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43655}: IDLE dialog windows are now recognized as dialogs by window
managers on macOS and X Window.

@item 
bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}: IDLE’s shell now shows prompts in a separate side-bar.
@end itemize

@node C API<25>,,IDLE<16>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id236}@anchor{18d9}
@subsubsection C API



@itemize -

@item 
bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916}: Add a new @ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION} type
flag to disallow creating type instances. Patch by Victor Stinner.

@item 
bpo-43774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43774}: Remove the now unused @code{PYMALLOC_DEBUG} macro. Debug hooks on
memory allocators are now installed by default if Python is built in debug
mode (if @code{Py_DEBUG} macro is defined). Moreover, they can now be used on
Python build in release mode (ex: using @code{PYTHONMALLOC=debug} environment
variable).

@item 
bpo-43962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43962}: _PyInterpreterState_IDIncref() now calls
_PyInterpreterState_IDInitref() and always increments id_refcount.
Previously, calling _xxsubinterpreters.get_current() could create an
id_refcount inconsistency when a _xxsubinterpreters.InterpreterID object
was deallocated. Patch by Victor Stinner.

@item 
bpo-28254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28254}: Add new C-API functions to control the state of the garbage
collector: @ref{93c,,PyGC_Enable()}, @ref{93d,,PyGC_Disable()},
@ref{93e,,PyGC_IsEnabled()}, corresponding to the functions in the
@ref{60,,gc} module.

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: Introduce @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} flag for
immutable type objects, and modify @ref{816,,PyType_Ready()} to set it for
static types. Patch by Erlend E. Aasland.

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: @ref{f2e,,PyMem_Calloc()} is now available in the limited C API
(@code{Py_LIMITED_API}).

@item 
bpo-43868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43868}: @ref{62a,,PyOS_ReadlineFunctionPointer()} is no longer exported by
limited C API headers and by @code{python3.dll} on Windows. Like any function
that takes @code{FILE*}, it is not part of the stable ABI.

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: Stable ABI and limited API definitions are generated from a
central manifest (
@geindex Python Enhancement Proposals; PEP 652
PEP 652@footnote{https://peps.python.org/pep-0652/}).

@item 
bpo-43753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43753}: Add the @ref{938,,Py_Is(x@comma{} y)} function to test if the
`x' object is the `y' object, the same as @code{x is y} in Python. Add also
the @ref{939,,Py_IsNone()}, @ref{93a,,Py_IsTrue()}, @ref{93b,,Py_IsFalse()}
functions to test if an object is, respectively, the @code{None} singleton,
the @code{True} singleton or the @code{False} singleton. Patch by Victor
Stinner.
@end itemize

@node Python 3 10 0 alpha 7,Python 3 10 0 alpha 6,Python 3 10 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-7}@anchor{18da}
@subsection Python 3.10.0 alpha 7


`Release date: 2021-04-05'

@menu
* Security: Security<17>. 
* Core and Builtins: Core and Builtins<27>. 
* Library: Library<27>. 
* Documentation: Documentation<26>. 
* Tests: Tests<26>. 
* Build: Build<27>. 
* Windows: Windows<27>. 
* IDLE: IDLE<17>. 
* C API: C API<26>. 

@end menu

@node Security<17>,Core and Builtins<27>,,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id237}@anchor{18db}
@subsubsection Security



@itemize -

@item 
bpo-42988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42988}: 
@geindex Common Vulnerabilities and Exposures; CVE 2021-3426
CVE 2021-3426@footnote{https://www.cve.org/CVERecord?id=CVE-2021-3426}: Remove the @code{getfile} feature of the
@ref{b5,,pydoc} module which could be abused to read arbitrary files on the
disk (directory traversal vulnerability). Moreover, even source code of
Python modules can contain sensitive data like passwords. Vulnerability
reported by David Schwörer.

@item 
bpo-43285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43285}: @ref{5e,,ftplib} no longer trusts the IP address value returned
from the server in response to the PASV command by default.  This prevents
a malicious FTP server from using the response to probe IPv4 address and
port combinations on the client network.

Code that requires the former vulnerable behavior may set a
@code{trust_server_pasv_ipv4_address} attribute on their @ref{990,,ftplib.FTP}
instances to @code{True} to re-enable it.

@item 
bpo-43439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43439}: Add audit hooks for @ref{89a,,gc.get_objects()},
@ref{89b,,gc.get_referrers()} and @ref{89c,,gc.get_referents()}. Patch by Pablo
Galindo.
@end itemize

@node Core and Builtins<27>,Library<27>,Security<17>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id238}@anchor{18dc}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-27129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27129}: Update CPython bytecode magic number.

@item 
bpo-43672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43672}: Raise ImportWarning when calling find_loader().

@item 
bpo-43660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43660}: Fix crash that happens when replacing @code{sys.stderr} with a
callable that can remove the object while an exception is being printed.
Patch by Pablo Galindo.

@item 
bpo-27129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27129}: The bytecode interpreter uses instruction, rather byte, offsets
internally. This reduces the number of EXTENDED_ARG instructions needed
and streamlines instruction dispatch a bit.

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: Fix reference leak in the @code{_hashopenssl} extension. Patch
by Pablo Galindo.

@item 
bpo-42134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42134}: Calls to find_module() by the import system now raise
ImportWarning.

@item 
bpo-41064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41064}: Improve the syntax error for invalid usage of double starred
elements (“**”) in f-strings. Patch by Pablo Galindo.

@item 
bpo-43575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43575}: Speed up calls to @code{map()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-42137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42137}: The import system now prefers using @code{__spec__} for
@code{ModuleType.__repr__} over @code{module_repr()}.

@item 
bpo-43452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43452}: Added micro-optimizations to @code{_PyType_Lookup()} to improve
cache lookup performance in the common case of cache hits.

@item 
bpo-43555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43555}: Report the column offset for @ref{150,,SyntaxError} for invalid
line continuation characters. Patch by Pablo Galindo.

@item 
bpo-43517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43517}: Fix misdetection of circular imports when using @code{from pkg.mod
import attr}, which caused false positives in non-trivial multi-threaded
code.

@item 
bpo-43497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43497}: Emit SyntaxWarnings for assertions with tuple constants, this
is a regression introduced in python3.7

@item 
bpo-39316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39316}: Tracing now has correct line numbers for attribute accesses
when the attribute is on a different line from the object. Improves
debugging and profiling for multi-line method chains.

@item 
bpo-35883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35883}: Python no longer fails at startup with a fatal error if a
command line argument contains an invalid Unicode character. The
@ref{c4f,,Py_DecodeLocale()} function now escapes byte sequences which would
be decoded as Unicode characters outside the [U+0000; U+10ffff] range.

@item 
bpo-43410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43410}: Fix a bug that was causing the parser to crash when emitting
syntax errors when reading input from stdin. Patch by Pablo Galindo

@item 
bpo-43406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43406}: Fix a possible race condition where @code{PyErr_CheckSignals}
tries to execute a non-Python signal handler.

@item 
bpo-42128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42128}: Add @code{__match_args__} to @ref{122c,,struct sequence objects}. Patch by Pablo Galindo.

@item 
bpo-43390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43390}: CPython now sets the @code{SA_ONSTACK} flag in @code{PyOS_setsig} for
the VM’s default signal handlers.  This is friendlier to other in-process
code that an extension module or embedding use could pull in (such as
Golang’s cgo) where tiny thread stacks are the norm and @code{sigaltstack()}
has been used to provide for signal handlers.  This is a no-op change for
the vast majority of processes that don’t use sigaltstack.

@item 
bpo-43287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43287}: Speed up calls to @code{filter()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-37448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37448}: Add a radix tree based memory map to track in-use obmalloc
arenas. Use to replace the old implementation of address_in_range(). The
radix tree approach makes it easy to increase pool sizes beyond the OS
page size. Boosting the pool and arena size allows obmalloc to handle a
significantly higher percentage of requests from its ultra-fast paths.

It also has the advantage of eliminating the memory unsanitary behavior of
the previous address_in_range(). The old address_in_range() was marked
with the annotations _Py_NO_SANITIZE_ADDRESS, _Py_NO_SANITIZE_THREAD, and
_Py_NO_SANITIZE_MEMORY. Those annotations are no longer needed.

To disable the radix tree map, set a preprocessor flag as follows:
@code{-DWITH_PYMALLOC_RADIX_TREE=0}.

Co-authored-by: Tim Peters <@email{tim.peters@@gmail.com}>

@item 
bpo-29988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29988}: Only handle asynchronous exceptions and requests to drop the
GIL when returning from a call or on the back edges of loops. Makes sure
that @ref{1367,,__exit__()} is always called in with statements, even
for interrupts.
@end itemize

@node Library<27>,Documentation<26>,Core and Builtins<27>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id239}@anchor{18dd}
@subsubsection Library



@itemize -

@item 
bpo-43720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43720}: Document various stdlib deprecations in imp, pkgutil, and
importlib.util for removal in Python 3.12.

@item 
bpo-43433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43433}: @ref{ae8,,xmlrpc.client.ServerProxy} no longer ignores query and
fragment in the URL of the server.

@item 
bpo-31956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31956}: The @ref{877,,index()} method of @ref{308,,array.array}
now has optional `start' and `stop' parameters.

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}: Enum: adjust @code{repr()} to show only enum and member name (not
value, nor angle brackets) and @code{str()} to show only member name.  Update
and improve documentation to match.

@item 
bpo-42136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42136}: Deprecate all module_repr() methods found in importlib as their
use is being phased out by Python 3.12.

@item 
bpo-35930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35930}: Raising an exception raised in a «future» instance will create
reference cycles.

@item 
bpo-41369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41369}: Finish updating the vendored libmpdec to version 2.5.1.  Patch
by Stefan Krah.

@item 
bpo-43422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43422}: Revert the _decimal C API which was added in bpo-41324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41324}.

@item 
bpo-43577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43577}: Fix deadlock when using @ref{1fa,,ssl.SSLContext} debug callback
with @ref{18de,,ssl.SSLContext.sni_callback()}.

@item 
bpo-43571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43571}: It’s now possible to create MPTCP sockets with IPPROTO_MPTCP

@item 
bpo-43542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43542}: @code{image/heic} and @code{image/heif} were added to
@ref{8f,,mimetypes}.

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: The @ref{6a,,hmac} module now uses OpenSSL’s HMAC implementation
when digestmod argument is a hash name or builtin hash function.

@item 
bpo-43510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43510}: Implement 
@geindex Python Enhancement Proposals; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}: Add @code{EncodingWarning} warning, @code{-X
warn_default_encoding} option, 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variables de entorno; PYTHONWARNDEFAULTENCODING
@ref{855,,PYTHONWARNDEFAULTENCODING}
environment variable and @code{encoding="locale"} argument value.

@item 
bpo-43521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43521}: @code{ast.unparse} can now render NaNs and empty sets.

@item 
bpo-42914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42914}: @ref{8bf,,pprint.pprint()} gains a new boolean
@code{underscore_numbers} optional argument to emit integers with thousands
separated by an underscore character for improved readability (for example
@code{1_000_000} instead of @code{1000000}).

@item 
bpo-41361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41361}: @ref{18df,,rotate()} calls are now slightly faster
due to faster argument parsing.

@item 
bpo-43423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43423}: @code{subprocess.communicate()} no longer raises an IndexError
when there is an empty stdout or stderr IO buffer during a timeout on
Windows.

@item 
bpo-27820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27820}: Fixed long-standing bug of smtplib.SMTP where doing AUTH LOGIN
with initial_response_ok=False will fail.

The cause is that SMTP.auth_login _always_ returns a password if provided
with a challenge string, thus non-compliant with the standard for AUTH
LOGIN.

Also fixes bug with the test for smtpd.

@item 
bpo-43445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43445}: Add frozen modules to @ref{8d8,,sys.stdlib_module_names}. For
example, add @code{"_frozen_importlib"} and @code{"_frozen_importlib_external"}
names.

@item 
bpo-43245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43245}: Add keyword arguments support to @code{ChainMap.new_child()}.

@item 
bpo-29982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29982}: Add optional parameter `ignore_cleanup_errors' to
@ref{12a1,,tempfile.TemporaryDirectory()} and allow multiple @code{cleanup()}
attempts. Contributed by C.A.M. Gerlach.

@item 
bpo-43428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43428}: Include changes from importlib_metadata 3.7@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html#v3-7-0}:

Performance enhancements to distribution discovery.

@code{entry_points} only returns unique distributions.

Introduces new @code{EntryPoints} object for containing a set of entry points
with convenience methods for selecting entry points by group or name.
@code{entry_points} now returns this object if selection parameters are
supplied but continues to return a dict object for compatibility. Users
are encouraged to rely on the selection interface. The dict object result
is likely to be deprecated in the future.

Added packages_distributions function to return a mapping of packages to
the distributions that provide them.

@item 
bpo-43332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43332}: Improves the networking efficiency of @ref{6f,,http.client} when
using a proxy via @code{set_tunnel()}.  Fewer small send
calls are made during connection setup.

@item 
bpo-43420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43420}: Improve performance of @ref{177,,fractions.Fraction} arithmetics
for large components.  Contributed by Sergey B. Kirpichev.

@item 
bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}: Allow passing a signal number to @code{_thread.interrupt_main()}.

@item 
bpo-43399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43399}: Fix @code{ElementTree.extend} not working on iterators when using
the Python implementation

@item 
bpo-43369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43369}: Improve @ref{cf,,sqlite3} error handling: If
@code{sqlite3_column_text()} and @code{sqlite3_column_blob()} set
@code{SQLITE_NOMEM}, @ref{16cb,,MemoryError} is now raised. Patch by Erlend E.
Aasland.

@item 
bpo-43368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43368}: Fix a regression introduced in PR 24562, where an empty
bytestring was fetched as @code{None} instead of @code{b'@w{'}} in @ref{cf,,sqlite3}.
Patch by Mariusz Felisiak.

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: Fixed stacklevel of @code{DeprecationWarning} emitted from
@code{import distutils}.

@item 
bpo-42129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42129}: @code{importlib.resources} now honors namespace packages, merging
resources from each location in the namespace as introduced in
@code{importlib_resources} 3.2 and including incidental changes through
5.0.3.

@item 
bpo-43295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43295}: @ref{15ec,,datetime.datetime.strptime()} now raises @code{ValueError}
instead of @code{IndexError} when matching @code{'z'} with the @code{%z} format
specifier.

@item 
bpo-43125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43125}: Return empty string if base64mime.body_encode receive empty
bytes

@item 
bpo-43084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43084}: @ref{18e0,,curses.window.enclose()} returns now @code{True} or @code{False}
(as was documented) instead of @code{1} or @code{0}.

@item 
bpo-42994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42994}: Add MIME types for opus, AAC, 3gpp and 3gpp2

@item 
bpo-14678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14678}: Add an invalidate_caches() method to the zipimport.zipimporter
class to support importlib.invalidate_caches(). Patch by Desmond Cheong.

@item 
bpo-42782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42782}: Fail fast in @ref{aed,,shutil.move()} to avoid creating destination
directories on failure.

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}: Enum’s @code{repr()} and @code{str()} have changed: @code{repr()} is now
`EnumClass.MemberName' and @code{str()} is `MemberName'.  Additionally,
stdlib Enum’s whose contents are available as module attributes, such as
@code{RegexFlag.IGNORECASE}, have their @code{repr()} as `module.name', e.g.
@code{re.IGNORECASE}.

@item 
bpo-26053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26053}: Fixed bug where the @ref{a5,,pdb} interactive run command echoed
the args from the shell command line, even if those have been overridden
at the pdb prompt.

@item 
bpo-24160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24160}: Fixed bug where breakpoints did not persist across multiple
debugger sessions in @ref{a5,,pdb}’s interactive mode.

@item 
bpo-40701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40701}: When the @ref{18e1,,tempfile.tempdir} global variable is set to a
value of type bytes, it is now handled consistently.  Previously
exceptions could be raised from some tempfile APIs when the directory did
not already exist in this situation.  Also ensures that the
@ref{18e2,,tempfile.gettempdir()} and @ref{18e3,,tempfile.gettempdirb()} functions
`always' return @code{str} and @code{bytes} respectively.

@item 
bpo-39342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39342}: Expose @code{X509_V_FLAG_ALLOW_PROXY_CERTS} as
@ref{18e4,,VERIFY_ALLOW_PROXY_CERTS} to allow proxy certificate
validation as explained in
@indicateurl{https://docs.openssl.org/1.1.1/man7/proxy-certificates/}.

@item 
bpo-31861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31861}: Add builtins.aiter and builtins.anext. Patch by Joshua Bronson
(@@jab), Daniel Pope (@@lordmauve), and Justin Wang (@@justin39).
@end itemize

@node Documentation<26>,Tests<26>,Library<27>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id240}@anchor{18e5}
@subsubsection Documentation



@itemize -

@item 
bpo-43199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43199}: Answer «Why is there no goto?» in the Design and History FAQ.

@item 
bpo-43407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43407}: Clarified that a result from @ref{3ac,,time.monotonic()},
@ref{b14,,time.perf_counter()}, @ref{b15,,time.process_time()}, or
@ref{9c9,,time.thread_time()} can be compared with the result from any
following call to the same function - not just the next immediate call.

@item 
bpo-43354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43354}: Fix type documentation for @code{Fault.faultCode}; the type has to
be @code{int} instead of @code{str}.

@item 
bpo-41933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41933}: Clarified wording of s * n in the Common Sequence Operations
@end itemize

@node Tests<26>,Build<27>,Documentation<26>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id241}@anchor{18e6}
@subsubsection Tests



@itemize -

@item 
bpo-37945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37945}: Fix test_getsetlocale_issue1813() of test_locale: skip the test
if @code{setlocale()} fails. Patch by Victor Stinner.

@item 
bpo-41561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41561}: Add workaround for Ubuntu’s custom OpenSSL security level
policy.
@end itemize

@node Build<27>,Windows<27>,Tests<26>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id242}@anchor{18e7}
@subsubsection Build



@itemize -

@item 
bpo-43179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43179}: Introduce and correctly use ALIGNOF_X in place of SIZEOF_X for
alignment-related code in optimized string routines. Patch by Jessica
Clarke.

@item 
bpo-43631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43631}: Update macOS, Windows, and CI to OpenSSL 1.1.1k.

@item 
bpo-43617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43617}: Improve configure.ac: Check for presence of autoconf-archive
package and remove our copies of M4 macros.

@item 
bpo-43466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43466}: The @code{configure} script now supports @code{--with-openssl-rpath}
option.

@item 
bpo-43372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43372}: Use @code{_freeze_importlib} to generate code for the
@code{__hello__} module. This approach ensures the code matches the
interpreter version.  Previously, PYTHON_FOR_REGEN was used to generate
the code, which might be wrong.  The marshal format for code objects has
changed with bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}, commit 877df851. Update the code and the expected
code sizes in ctypes test_frozentable.
@end itemize

@node Windows<27>,IDLE<17>,Build<27>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id243}@anchor{18e8}
@subsubsection Windows



@itemize -

@item 
bpo-43440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43440}: Build @ref{cf,,sqlite3} with the @code{R*Tree} module enabled. Patch
by Erlend E. Aasland.
@end itemize

@node IDLE<17>,C API<26>,Windows<27>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id244}@anchor{18e9}
@subsubsection IDLE



@itemize -

@item 
bpo-42225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42225}: Document that IDLE can fail on Unix either from misconfigured
IP masquerade rules or failure displaying complex colored (non-ascii)
characters.
@end itemize

@node C API<26>,,IDLE<17>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id245}@anchor{18ea}
@subsubsection C API



@itemize -

@item 
bpo-43688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43688}: The limited C API is now supported if Python is built in debug
mode (if the @code{Py_DEBUG} macro is defined). In the limited C API, the
@ref{612,,Py_INCREF()} and @ref{613,,Py_DECREF()} functions are now implemented
as opaque function calls, rather than accessing directly the
@ref{937,,PyObject.ob_refcnt} member, if Python is built in debug mode
and the @code{Py_LIMITED_API} macro targets Python 3.10 or newer. It became
possible to support the limited C API in debug mode because the
@ref{42d,,PyObject} structure is the same in release and debug mode since
Python 3.8 (see bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}).

The limited C API is still not supported in the @code{--with-trace-refs}
special build (@code{Py_TRACE_REFS} macro).

Patch by Victor Stinner.

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: Remove the @code{pyarena.h} header file with functions:


@itemize *

@item 
@code{PyArena_New()}

@item 
@code{PyArena_Free()}

@item 
@code{PyArena_Malloc()}

@item 
@code{PyArena_AddPyObject()}
@end itemize

These functions were undocumented, excluded from the limited C API, and
were only used internally by the compiler. Patch by Victor Stinner.

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: Remove the compiler and parser functions using @code{struct _mod}
type, because the public AST C API was removed:


@itemize *

@item 
@code{PyAST_Compile()}

@item 
@code{PyAST_CompileEx()}

@item 
@code{PyAST_CompileObject()}

@item 
@code{PyFuture_FromAST()}

@item 
@code{PyFuture_FromASTObject()}

@item 
@code{PyParser_ASTFromFile()}

@item 
@code{PyParser_ASTFromFileObject()}

@item 
@code{PyParser_ASTFromFilename()}

@item 
@code{PyParser_ASTFromString()}

@item 
@code{PyParser_ASTFromStringObject()}
@end itemize

These functions were undocumented and excluded from the limited C API.
Patch by Victor Stinner.

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: Remove @code{ast.h}, @code{asdl.h}, and @code{Python-ast.h} header
files. These functions were undocumented and excluded from the limited C
API. Most names defined by these header files were not prefixed by @code{Py}
and so could create names conflicts. For example, @code{Python-ast.h} defined
a @code{Yield} macro which was conflict with the @code{Yield} name used by the
Windows @code{<winbase.h>} header. Use the Python @ref{9,,ast} module instead.
Patch by Victor Stinner.

@item 
bpo-43541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43541}: Fix a @code{PyEval_EvalCodeEx()} regression: fix reference
counting on builtins. Patch by Victor Stinner.

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: Remove the @code{symtable.h} header file and the undocumented
functions:


@itemize *

@item 
@code{PyST_GetScope()}

@item 
@code{PySymtable_Build()}

@item 
@code{PySymtable_BuildObject()}

@item 
@code{PySymtable_Free()}

@item 
@code{Py_SymtableString()}

@item 
@code{Py_SymtableStringObject()}
@end itemize

The @code{Py_SymtableString()} function was part the stable ABI by mistake
but it could not be used, because the @code{symtable.h} header file was
excluded from the limited C API.

The Python @ref{d8,,symtable} module remains available and is unchanged.

Patch by Victor Stinner.

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: Remove the @code{PyAST_Validate()} function. It is no longer
possible to build a AST object (@code{mod_ty} type) with the public C API.
The function was already excluded from the limited C API (
@geindex Python Enhancement Proposals; PEP 384
PEP 384@footnote{https://peps.python.org/pep-0384/}).
Patch by Victor Stinner.
@end itemize

@node Python 3 10 0 alpha 6,Python 3 10 0 alpha 5,Python 3 10 0 alpha 7,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-6}@anchor{18eb}
@subsection Python 3.10.0 alpha 6


`Release date: 2021-03-01'

@menu
* Security: Security<18>. 
* Core and Builtins: Core and Builtins<28>. 
* Library: Library<28>. 
* Documentation: Documentation<27>. 
* Tests: Tests<27>. 
* Build: Build<28>. 
* Windows: Windows<28>. 
* macOS: macOS<22>. 
* IDLE: IDLE<18>. 
* C API: C API<27>. 

@end menu

@node Security<18>,Core and Builtins<28>,,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id246}@anchor{18ec}
@subsubsection Security



@itemize -

@item 
bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}: Fix web cache poisoning vulnerability by defaulting the query
args separator to @code{&}, and allowing the user to choose a custom
separator.
@end itemize

@node Core and Builtins<28>,Library<28>,Security<18>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id247}@anchor{18ed}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-43321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43321}: Fix @code{SystemError} raised when @code{PyArg_Parse*()} is used with
@code{#} but without @code{PY_SSIZE_T_CLEAN} defined.

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: @code{PyArg_Parse*()} functions now emits @code{DeprecationWarning}
when @code{u} or @code{Z} format is used. See 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} for detail.

@item 
bpo-43277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43277}: Add a new @ref{935,,PySet_CheckExact()} function to the C-API to
check if an object is an instance of @ref{67a,,set} but not an instance of a
subtype. Patch by Pablo Galindo.

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: The @ref{91b,,types.FunctionType} constructor now inherits the
current builtins if the `globals' dictionary has no @code{"__builtins__"}
key, rather than using @code{@{"None": None@}} as builtins: same behavior as
@ref{2eb,,eval()} and @ref{2ea,,exec()} functions. Defining a function with @code{def
function(...): ...} in Python is not affected, globals cannot be
overridden with this syntax: it also inherits the current builtins. Patch
by Victor Stinner.

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: Functions have a new @code{__builtins__} attribute which is used
to look for builtin symbols when a function is executed, instead of
looking into @code{__globals__['__builtins__']}. Patch by Mark Shannon and
Victor Stinner.

@item 
bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}: Improve the error message in the parser for exception groups
without parentheses. Patch by Pablo Galindo.

@item 
bpo-43121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43121}: Fixed an incorrect @ref{150,,SyntaxError} message for missing comma
in literals. Patch by Pablo Galindo.

@item 
bpo-42819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42819}: @ref{ba,,readline}: Explicitly disable bracketed paste in the
interactive interpreter, even if it’s set in the inputrc, is enabled by
default (eg GNU Readline 8.1), or a user calls
@code{readline.read_init_file()}. The Python REPL has not implemented
bracketed paste support. Also, bracketed mode writes the @code{"\x1b[?2004h"}
escape sequence into stdout which causes test failures in applications
that don’t support it. It can still be explicitly enabled by calling
@code{readline.parse_and_bind("set enable-bracketed-paste on")}. Patch by
Dustin Rodrigues.

@item 
bpo-42808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42808}: Simple calls to @code{type(object)} are now faster due to the
@code{vectorcall} calling convention. Patch by Dennis Sweeney.

@item 
bpo-42217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42217}: Make the compiler merges same co_code and co_linetable objects
in a module like already did for co_consts.

@item 
bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972}: Substring search functions such as @code{str1 in str2} and
@code{str2.find(str1)} now sometimes use the «Two-Way» string comparison
algorithm to avoid quadratic behavior on long strings.

@item 
bpo-42128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42128}: Implement 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} (structural pattern matching). Patch by
Brandt Bucher.

@item 
bpo-40692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40692}: In the @ref{163,,concurrent.futures.ProcessPoolExecutor},
validate that @code{multiprocess.synchronize()} is available on a given
platform and rely on that check in the @ref{22,,concurrent.futures} test
suite so we can run tests that are unrelated to
@code{ProcessPoolExecutor} on those platforms.

@item 
bpo-38302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38302}: If @ref{869,,object.__ipow__()} returns @ref{227,,NotImplemented}, the
operator will correctly fall back to @ref{86a,,object.__pow__()} and
@ref{86b,,object.__rpow__()} as expected.
@end itemize

@node Library<28>,Documentation<27>,Core and Builtins<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id248}@anchor{18ee}
@subsubsection Library



@itemize -

@item 
bpo-43316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43316}: The @code{python -m gzip} command line application now properly
fails when detecting an unsupported extension. It exits with a non-zero
exit code and prints an error message to stderr.

@item 
bpo-43317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43317}: Set the chunk size for the @code{gzip} module main function to
io.DEFAULT_BUFFER_SIZE. This is slightly faster than the 1024 bytes
constant that was used previously.

@item 
bpo-43146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43146}: Handle None in single-arg versions of
@ref{8e6,,print_exception()} and
@ref{8e4,,format_exception()}.

@item 
bpo-43260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43260}: Fix TextIOWrapper can not flush internal buffer forever after
very large text is written.

@item 
bpo-43258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43258}: Prevent needless allocation of @ref{cf,,sqlite3} aggregate
function context when no rows match an aggregate query. Patch by Erlend E.
Aasland.

@item 
bpo-43251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43251}: Improve @ref{cf,,sqlite3} error handling:
@code{sqlite3_column_name()} failures now result in @ref{16cb,,MemoryError}. Patch
by Erlend E. Aasland.

@item 
bpo-40956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40956}: Fix segfault in @ref{c02,,sqlite3.Connection.backup()} if no
argument was provided. The regression was introduced by PR 23838. Patch by
Erlend E. Aasland.

@item 
bpo-43172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43172}: The readline module now passes its tests when built directly
against libedit. Existing irreconcilable API differences remain in
@ref{18ef,,readline.get_begidx()} and @ref{18f0,,readline.get_endidx()} behavior based
on libreadline vs libedit use.

@item 
bpo-43163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43163}: Fix a bug in @ref{1d,,codeop} that was causing it to not ask for
more input when multi-line snippets have unclosed parentheses. Patch by
Pablo Galindo

@item 
bpo-43162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43162}: deprecate unsupported ability to access enum members as
attributes of other enum members

@item 
bpo-43146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43146}: Fix recent regression in None argument handling in
@ref{fe,,traceback} module functions.

@item 
bpo-43102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43102}: The namedtuple __new__ method had its __builtins__ set to None
instead of an actual dictionary.  This created problems for introspection
tools.

@item 
bpo-43106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43106}: Added @ref{8b1,,O_EVTONLY}, @ref{8b2,,O_FSYNC},
@ref{8b3,,O_SYMLINK} and @ref{8b4,,O_NOFOLLOW_ANY} for macOS. Patch by
Donghee Na.

@item 
bpo-42960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42960}: Adds @ref{18f1,,resource.RLIMIT_KQUEUES} constant from FreeBSD to
the @ref{bc,,resource} module.

@item 
bpo-42151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42151}: Make the pure Python implementation of
@ref{125,,xml.etree.ElementTree} behave the same as the C implementation
(@code{_elementree}) regarding default attribute values (by not setting
@code{specified_attributes=1}).

@item 
bpo-29753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29753}: In ctypes, now packed bitfields are calculated properly and the
first item of packed bitfields is now shrank correctly.
@end itemize

@node Documentation<27>,Tests<27>,Library<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id249}@anchor{18f2}
@subsubsection Documentation



@itemize -

@item 
bpo-27646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27646}: Clarify that “yield from <expr>” works with any iterable, not
just iterators.

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: Update some deprecated unicode APIs which are documented as
«will be removed in 4.0» to «3.12». See 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} for detail.
@end itemize

@node Tests<27>,Build<28>,Documentation<27>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id250}@anchor{18f3}
@subsubsection Tests



@itemize -

@item 
bpo-43288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43288}: Fix test_importlib to correctly skip Unicode file tests if the
filesystem does not support them.
@end itemize

@node Build<28>,Windows<28>,Tests<27>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id251}@anchor{18f4}
@subsubsection Build



@itemize -

@item 
bpo-43174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43174}: Windows build now uses @code{/utf-8} compiler option.

@item 
bpo-43103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43103}: Add a new configure @code{--without-static-libpython} option to
not build the @code{libpythonMAJOR.MINOR.a} static library and not install
the @code{python.o} object file.

@item 
bpo-13501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13501}: The configure script can now use `libedit' instead of
`readline' with the command line option @code{--with-readline=editline}.

@item 
bpo-42603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42603}: Make configure script use pkg-config to detect the location of
Tcl/Tk headers and libraries, used to build tkinter.

On macOS, a Tcl/Tk configuration provided by pkg-config will be preferred
over Tcl/Tk frameworks installed in @code{/@{System/,@}Library/Frameworks}. If
both exist and the latter is preferred, the appropriate @code{--with-tcltk-*}
configuration options need to be explicitly set.

@item 
bpo-39448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39448}: Add the «regen-frozen» makefile target that regenerates the
code for the frozen @code{__hello__} module.
@end itemize

@node Windows<28>,macOS<22>,Build<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id252}@anchor{18f5}
@subsubsection Windows



@itemize -

@item 
bpo-43155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43155}: @ref{18f6,,PyCMethod_New()} is now present in @code{python3.lib}.
@end itemize

@node macOS<22>,IDLE<18>,Windows<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id253}@anchor{18f7}
@subsubsection macOS



@itemize -

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: Update macOS installer build to use OpenSSL 1.1.1j.
@end itemize

@node IDLE<18>,C API<27>,macOS<22>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id254}@anchor{18f8}
@subsubsection IDLE



@itemize -

@item 
bpo-43283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43283}: Document why printing to IDLE’s Shell is often slower than
printing to a system terminal and that it can be made faster by
pre-formatting a single string before printing.
@end itemize

@node C API<27>,,IDLE<18>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id255}@anchor{18f9}
@subsubsection C API



@itemize -

@item 
bpo-43278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43278}: Always put compiler and system information on the first line of
the REPL welcome message.

@item 
bpo-43270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43270}: Remove the private @code{_PyErr_OCCURRED()} macro: use the public
@ref{18fa,,PyErr_Occurred()} function instead.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: Move odictobject.h, parser_interface.h, picklebufobject.h,
pydebug.h, and pyfpe.h into the cpython/ directory. They must not be
included directly, as they are already included by Python.h: @ref{81d,,Include Files}.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: Move pyarena.h, pyctype.h, and pytime.h into the cpython/
directory. They must not be included directly, as they are already
included by Python.h: @ref{81d,,Include Files}.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @code{PyExceptionClass_Name()} is now always declared as a
function, in order to hide implementation details. The macro accessed
@ref{18fb,,PyTypeObject.tp_name} directly.  Patch by Erlend E. Aasland.

@item 
bpo-43239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43239}: The @ref{18fc,,PyCFunction_New()} function is now exported in the
ABI when compiled with @code{-fvisibility=hidden}.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{18fd,,PyIter_Check()} is now always declared as a function, in
order to hide implementation details. The macro accessed
@ref{152f,,PyTypeObject.tp_iternext} directly. Patch by Erlend E. Aasland.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert @ref{18fe,,PyDescr_IsData()} macro to a function to hide
implementation details: The macro accessed
@ref{18ff,,PyTypeObject.tp_descr_set} directly. Patch by Erlend E.
Aasland.

@item 
bpo-43181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43181}: Convert @ref{1900,,PyObject_TypeCheck()} macro to a static inline
function. Patch by Erlend E. Aasland.
@end itemize

@node Python 3 10 0 alpha 5,Python 3 10 0 alpha 4,Python 3 10 0 alpha 6,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-5}@anchor{1901}
@subsection Python 3.10.0 alpha 5


`Release date: 2021-02-02'

@menu
* Security: Security<19>. 
* Core and Builtins: Core and Builtins<29>. 
* Library: Library<29>. 
* Documentation: Documentation<28>. 
* Tests: Tests<28>. 
* Build: Build<29>. 
* Windows: Windows<29>. 
* macOS: macOS<23>. 
* IDLE: IDLE<19>. 
* C API: C API<28>. 

@end menu

@node Security<19>,Core and Builtins<29>,,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id256}@anchor{1902}
@subsubsection Security



@itemize -

@item 
bpo-42938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42938}: Avoid static buffers when computing the repr of
@ref{1903,,ctypes.c_double} and @ref{1904,,ctypes.c_longdouble} values.
@end itemize

@node Core and Builtins<29>,Library<29>,Security<19>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id257}@anchor{1905}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: Refactor the @code{PyEval_} family of functions.


@itemize *

@item 
An new function @code{_PyEval_Vector} is added to simplify calls to Python from C.

@item 
@code{_PyEval_EvalCodeWithName} is removed

@item 
@code{PyEval_EvalCodeEx} is retained as part of the API, but is not used internally
@end itemize

@item 
bpo-38631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38631}: Replace @ref{a15,,Py_FatalError()} calls in the compiler with
regular @ref{619,,SystemError} exceptions. Patch by Victor Stinner.

@item 
bpo-42997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42997}: Improve error message for missing «:» before blocks. Patch by
Pablo Galindo.

@item 
bpo-43017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43017}: Improve error message in the parser when using un-parenthesised
tuples in comprehensions. Patch by Pablo Galindo.

@item 
bpo-42986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42986}: Fix parser crash when reporting syntax errors in f-string with
newlines. Patch by Pablo Galindo.

@item 
bpo-40176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40176}: Syntax errors for unterminated string literals now point to the
start of the string instead of reporting EOF/EOL.

@item 
bpo-42927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42927}: The inline cache for @code{LOAD_ATTR} now also optimizes access to
attributes defined by @code{__slots__}. This makes reading such attribute up
to 30% faster.

@item 
bpo-42864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42864}: Improve error messages in the parser when parentheses are not
closed. Patch by Pablo Galindo.

@item 
bpo-42924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42924}: Fix @code{bytearray} repetition incorrectly copying data from the
start of the buffer, even if the data is offset within the buffer (e.g.
after reassigning a slice at the start of the @code{bytearray} to a shorter
byte string).

@item 
bpo-42882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42882}: Fix the @code{_PyUnicode_FromId()} function
(_Py_IDENTIFIER(var) API) when @ref{247,,Py_Initialize()} /
@ref{246,,Py_Finalize()} is called multiple times: preserve
@code{_PyRuntime.unicode_ids.next_index} value.

@item 
bpo-42827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42827}: Fix a crash when working out the error line of a
@ref{150,,SyntaxError} in some multi-line expressions.

@item 
bpo-42823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42823}: frame.f_lineno is correct even if frame.f_trace is set to True

@item 
bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324}: Remove deprecated aliases to
@ref{90f,,Colecciones clases base abstractas} from the @ref{1e,,collections}
module.

@item 
bpo-41994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41994}: Fixed possible leak in @code{import} when @code{sys.modules} is not a
@code{dict}.

@item 
bpo-27772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27772}: In string formatting, preceding the `width' field by @code{'0'} no
longer affects the default alignment for strings.
@end itemize

@node Library<29>,Documentation<28>,Core and Builtins<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id258}@anchor{1906}
@subsubsection Library



@itemize -

@item 
bpo-43108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43108}: Fixed a reference leak in the @ref{2c,,curses} module. Patch by
Pablo Galindo

@item 
bpo-43077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43077}: Update the bundled pip to 21.0.1 and setuptools to 52.0.0.

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: Deprecate @code{distutils} in documentation and add warning on
import.

@item 
bpo-43014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43014}: Improve performance of @ref{fb,,tokenize} by 20-30%.  Patch by
Anthony Sottile.

@item 
bpo-42323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42323}: Fix @ref{541,,math.nextafter()} for NaN on AIX.

@item 
bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955}: Add @ref{8d8,,sys.stdlib_module_names}, containing the list of the
standard library module names. Patch by Victor Stinner.

@item 
bpo-42944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42944}: Fix @code{random.Random.sample} when @code{counts} argument is not
@code{None}.

@item 
bpo-42934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42934}: Use @ref{3b3,,TracebackException}’s new @code{compact}
param in @ref{11d8,,TestResult} to reduce time and memory consumed
by traceback formatting.

@item 
bpo-42931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42931}: Add @code{randbytes()} to @code{random.__all__}.

@item 
bpo-38250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38250}: [Enum] Flags consisting of a single bit are now considered
canonical, and will be the only flags returned from listing and iterating
over a Flag class or a Flag member.  Multi-bit flags are considered
aliases; they will be returned from lookups and operations that result in
their value. Iteration for both Flag and Flag members is in definition
order.

@item 
bpo-42877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42877}: Added the @code{compact} parameter to the constructor of
@ref{3b3,,traceback.TracebackException} to reduce time and memory for use
cases that only need to call @code{TracebackException.format()} and
@code{TracebackException.format_exception_only()}.

@item 
bpo-42923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42923}: The @ref{a15,,Py_FatalError()} function and the
@ref{58,,faulthandler} module now dump the list of extension modules on a
fatal error.

@item 
bpo-42848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42848}: Removed recursion from @ref{3b3,,TracebackException}
to allow it to handle long exception chains.

@item 
bpo-42901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42901}: [Enum] move member creation from @code{EnumMeta.__new__} to
@code{_proto_member.__set_name__}, allowing members to be created and visible
in @code{__init_subclass__}.

@item 
bpo-42780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42780}: Fix os.set_inheritable() for O_PATH file descriptors on Linux.

@item 
bpo-42866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42866}: Fix a reference leak in the @code{getcodec()} function of CJK
codecs. Patch by Victor Stinner.

@item 
bpo-42846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42846}: Convert the 6 CJK codec extension modules (_codecs_cn,
_codecs_hk, _codecs_iso2022, _codecs_jp, _codecs_kr and _codecs_tw) to the
multiphase initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}). Patch by Victor Stinner.

@item 
bpo-42851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42851}: remove __init_subclass__ support for Enum members

@item 
bpo-42834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42834}: Make internal caches of the @code{_json} module compatible with
subinterpreters.

@item 
bpo-41748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41748}: Fix HTMLParser parsing rules for element attributes containing
commas with spaces. Patch by Karl Dubost.

@item 
bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}: Require SQLite 3.7.15 or newer. Patch by Erlend E. Aasland.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Convert the _multibytecodec extension module (CJK codecs) to
multi-phase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).  Patch by Erlend E. Aasland.

@item 
bpo-42802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42802}: The distutils @code{bdist_wininst} command deprecated in Python
3.8 has been removed. The distutils @code{bdist_wheel} command is now
recommended to distribute binary packages on Windows.

@item 
bpo-24464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24464}: The undocumented built-in function
@code{sqlite3.enable_shared_cache} is now deprecated, scheduled for removal
in Python 3.12.  Its use is strongly discouraged by the SQLite3
documentation.  Patch by Erlend E. Aasland.

@item 
bpo-42384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42384}: Make pdb populate sys.path[0] exactly the same as regular
python execution.

@item 
bpo-42383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42383}: Fix pdb: previously pdb would fail to restart the debugging
target if it was specified using a relative path and the current directory
changed.

@item 
bpo-42005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42005}: Fix CLI of @ref{28,,cProfile} and @ref{af,,profile} to catch
@ref{10d8,,BrokenPipeError}.

@item 
bpo-41604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41604}: Don’t decrement the reference count of the previous user_ptr
when set_panel_userptr fails.

@item 
bpo-41149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41149}: Allow executing callables that have a boolean value of
@code{False} when passed to @code{Threading.thread} as the target. Patch
contributed by Barney Stratford.

@item 
bpo-38307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38307}: Add an “end_lineno” attribute to the Class and Function objects
that appear in the tree returned by pyclbr functions.  This and the
existing “lineno” attribute define the extent of class and def statements.
Patch by Aviral Srivastava.

@item 
bpo-39273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39273}: The @code{BUTTON5_*} constants are now exposed in the
@ref{2c,,curses} module if available.

@item 
bpo-33289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33289}: Correct call to @ref{f1,,tkinter.colorchooser} to return RGB
triplet of ints instead of floats.  Patch by Cheryl Sabella.
@end itemize

@node Documentation<28>,Tests<28>,Library<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id259}@anchor{1907}
@subsubsection Documentation



@itemize -

@item 
bpo-40304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40304}: Fix doc for type(name, bases, dict).  Patch by Boris
Verkhovskiy and Éric Araujo.

@item 
bpo-42811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42811}: Updated importlib.util.resolve_name() doc to use
__spec__.parent instead of __package__. (Thanks Yair Frid.)
@end itemize

@node Tests<28>,Build<29>,Documentation<28>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id260}@anchor{1908}
@subsubsection Tests



@itemize -

@item 
bpo-40823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40823}: Use @code{unittest.TestLoader().loadTestsFromTestCase()} instead
of @code{unittest.makeSuite()} in @ref{cf,,sqlite3} tests. Patch by Erlend E.
Aasland.

@item 
bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}: In @ref{cf,,sqlite3}, fix @code{CheckTraceCallbackContent} for SQLite
pre 3.7.15.
@end itemize

@node Build<29>,Windows<29>,Tests<28>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id261}@anchor{1909}
@subsubsection Build



@itemize -

@item 
bpo-43031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43031}: Pass @code{--timeout=$(TESTTIMEOUT)} option to the default profile
task @code{./python -m test --pgo} command.

@item 
bpo-36143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36143}: @code{make regen-all} now also runs @code{regen-keyword}. Patch by
Victor Stinner.

@item 
bpo-42874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42874}: Removed the grep -q and -E flags in the tzpath validation
section of the configure script to better accommodate users of some
platforms (specifically Solaris 10).

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Add library search path by wr-cc in add_cross_compiling_paths()
for VxWorks.

@item 
bpo-42856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42856}: Add @code{--with-wheel-pkg-dir=PATH} option to the @code{./configure}
script. If specified, the @ref{55,,ensurepip} module looks for @code{setuptools}
and @code{pip} wheel packages in this directory: if both are present, these
wheel packages are used instead of ensurepip bundled wheel packages.

Some Linux distribution packaging policies recommend against bundling
dependencies. For example, Fedora installs wheel packages in the
@code{/usr/share/python-wheels/} directory and don’t install the
@code{ensurepip._bundled} package.
@end itemize

@node Windows<29>,macOS<23>,Build<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id262}@anchor{190a}
@subsubsection Windows



@itemize -

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: Updated Windows installer to include OpenSSL 1.1.1i

@item 
bpo-42584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42584}: Upgrade Windows installer to use SQLite 3.34.0.
@end itemize

@node macOS<23>,IDLE<19>,Windows<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id263}@anchor{190b}
@subsubsection macOS



@itemize -

@item 
bpo-42504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42504}: Ensure that the value of
sysconfig.get_config_var(“MACOSX_DEPLOYMENT_TARGET”) is always a string,
even in when the value is parsable as an integer.
@end itemize

@node IDLE<19>,C API<28>,macOS<23>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id264}@anchor{190c}
@subsubsection IDLE



@itemize -

@item 
bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}: Make IDLE invoke @ref{8a2,,sys.excepthook()} in normal, 2-process
mode. Patch by Ken Hilton.

@item 
bpo-33065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33065}: Fix problem debugging user classes with __repr__ method.

@item 
bpo-23544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23544}: Disable Debug=>Stack Viewer when user code is running or
Debugger is active, to prevent hang or crash.  Patch by Zackery Spytz.

@item 
bpo-32631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32631}: Finish zzdummy example extension module: make menu entries
work; add docstrings and tests with 100% coverage.
@end itemize

@node C API<28>,,IDLE<19>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id265}@anchor{190d}
@subsubsection C API



@itemize -

@item 
bpo-42979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42979}: When Python is built in debug mode (with C assertions), calling
a type slot like @code{sq_length} (@code{__len__()} in Python) now fails with a
fatal error if the slot succeeded with an exception set, or failed with no
exception set. The error message contains the slot, the type name, and the
current exception (if an exception is set). Patch by Victor Stinner.

@item 
bpo-43030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43030}: Fixed a compiler warning in @ref{190e,,Py_UNICODE_ISSPACE()} on
platforms with signed @code{wchar_t}.
@end itemize

@node Python 3 10 0 alpha 4,Python 3 10 0 alpha 3,Python 3 10 0 alpha 5,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-4}@anchor{190f}
@subsection Python 3.10.0 alpha 4


`Release date: 2021-01-04'

@menu
* Core and Builtins: Core and Builtins<30>. 
* Library: Library<30>. 
* Documentation: Documentation<29>. 
* Tests: Tests<29>. 
* Build: Build<30>. 
* macOS: macOS<24>. 
* Tools/Demos: Tools/Demos<15>. 
* C API: C API<29>. 

@end menu

@node Core and Builtins<30>,Library<30>,,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id266}@anchor{1910}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-42814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42814}: Fix undefined behavior in @code{Objects/genericaliasobject.c}.

@item 
bpo-42806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42806}: Fix the column offsets for f-strings @ref{9,,ast} nodes
surrounded by parentheses and for nodes that spawn multiple lines. Patch
by Pablo Galindo.

@item 
bpo-40631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40631}: Fix regression where a single parenthesized starred expression
was a valid assignment target.

@item 
bpo-27794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27794}: Improve the error message for failed writes/deletes to property
objects. When possible, the attribute name is now shown. Patch provided by
Yurii Karabas.

@item 
bpo-42745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42745}: Make the type attribute lookup cache per-interpreter. Patch by
Victor Stinner.

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: Jumps to jumps are not eliminated when it would break PEP 626.

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: Make sure that the @code{f_lasti} and @code{f_lineno} attributes of a
frame are set correctly when an exception is raised or re-raised. Required
for PEP 626.

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: The coding cookie (ex: @code{# coding: latin1}) is now ignored in
the command passed to the @ref{681,,-c} command line option. Patch by
Victor Stinner.

@item 
bpo-30858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30858}: Improve error location in expressions that contain assignments.
Patch by Pablo Galindo and Lysandros Nikolaou.

@item 
bpo-42615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42615}: Remove jump commands made redundant by the deletion of
unreachable bytecode blocks

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: Make the @ref{d,,atexit} module state per-interpreter. It is now
safe have more than one @ref{d,,atexit} module instance. Patch by Donghee Na
and Victor Stinner.

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: Fix encoding name when running a @code{.pyc} file on Windows:
@ref{1911,,PyRun_SimpleFileExFlags()} now uses the correct encoding to
decode the filename.

@item 
bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}: The @code{__args__} of the parameterized generics for
@ref{85e,,typing.Callable} and @ref{881,,collections.abc.Callable} are now
consistent.  The @code{__args__} for @ref{881,,collections.abc.Callable} are
now flattened while @ref{85e,,typing.Callable}’s have not changed.  To allow
this change, @ref{882,,types.GenericAlias} can now be subclassed and
@code{collections.abc.Callable}’s @code{__class_getitem__} will now return a
subclass of @code{types.GenericAlias}.  Tests for typing were also updated to
not subclass things like @code{Callable[..., T]} as that is not a valid base
class.  Finally, both @code{Callable}s no longer validate their
@code{argtypes}, in @code{Callable[[argtypes], resulttype]} to prepare for
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}.  Patch by Ken Jin.

@item 
bpo-40137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40137}: Convert functools module to use
@ref{5f4,,PyType_FromModuleAndSpec()}.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{8,,array} to use heap types, and establish module
state for these.

@item 
bpo-42008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42008}: Fix _random.Random() seeding.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{pyexpat} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: Make the Unicode dictionary of interned strings compatible with
subinterpreters. Patch by Victor Stinner.

@item 
bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}: Make @code{_PyUnicode_FromId()} function compatible with
subinterpreters. Each interpreter now has an array of identifier objects
(interned strings decoded from UTF-8). Patch by Victor Stinner.
@end itemize

@node Library<30>,Documentation<29>,Core and Builtins<30>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id267}@anchor{1912}
@subsubsection Library



@itemize -

@item 
bpo-42257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42257}: Handle empty string in variable executable in
platform.libc_ver()

@item 
bpo-42772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42772}: randrange() now raises a TypeError when step is specified
without a stop argument.  Formerly, it silently ignored the step argument.

@item 
bpo-42759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42759}: Fixed equality comparison of @code{tkinter.Variable} and
@ref{1913,,tkinter.font.Font}. Objects which belong to different Tcl
interpreters are now always different, even if they have the same name.

@item 
bpo-42756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42756}: Configure LMTP Unix-domain socket to use socket global default
timeout when a timeout is not explicitly provided.

@item 
bpo-23328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23328}: Allow / character in username, password fields on _PROXY
envars.

@item 
bpo-42740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42740}: @ref{916,,typing.get_args()} and @ref{ad9,,typing.get_origin()} now
support 
@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} union types and 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} additions to @code{Callable}.

@item 
bpo-42655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42655}: @ref{d6,,subprocess} `extra_groups' is now correctly passed into
setgroups() system call.

@item 
bpo-42727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42727}: @code{EnumMeta.__prepare__} now accepts @code{**kwds} to properly
support @code{__init_subclass__}

@item 
bpo-38308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38308}: Add optional `weights' to `statistics.harmonic_mean()'.

@item 
bpo-42721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42721}: When simple query dialogs (@ref{f8,,tkinter.simpledialog}),
message boxes (@ref{f6,,tkinter.messagebox}) or color choose dialog
(@ref{f1,,tkinter.colorchooser}) are created without arguments `master' and
`parent', and the default root window is not yet created, and
@code{NoDefaultRoot()} was not called, a new temporal hidden root
window will be created automatically. It will not be set as the default
root window and will be destroyed right after closing the dialog window.
It will help to use these simple dialog windows in programs which do not
need other GUI.

@item 
bpo-25246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25246}: Optimized @ref{1914,,collections.deque.remove()}.

@item 
bpo-35728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35728}: Added a root parameter to @ref{1915,,tkinter.font.nametofont()}.

@item 
bpo-15303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15303}: @ref{f0,,tkinter} supports now widgets with boolean value False.

@item 
bpo-42681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42681}: Fixed range checks for color and pair numbers in @ref{2c,,curses}.

@item 
bpo-42685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42685}: Improved placing of simple query windows in Tkinter (such as
@ref{1916,,tkinter.simpledialog.askinteger()}). They are now centered at the
center of the parent window if it is specified and shown, otherwise at the
center of the screen.

@item 
bpo-9694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9694}: Argparse help no longer uses the confusing phrase, «optional
arguments». It uses «options» instead.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_thread} extension module to the multiphase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) and convert its static types to heap
types.

@item 
bpo-37961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37961}: Fix crash in @code{tracemalloc.Traceback.__repr__()} (regressed
in Python 3.9).

@item 
bpo-42630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42630}: @ref{f0,,tkinter} functions and constructors which need a default
root window raise now @ref{1e5,,RuntimeError} with descriptive message instead
of obscure @ref{441,,AttributeError} or @ref{4ec,,NameError} if it is not created
yet or cannot be created automatically.

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: @code{atexit._run_exitfuncs()} now logs callback exceptions
using @ref{355,,sys.unraisablehook}, rather than logging them directly into
@ref{9cc,,sys.stderr} and raise the last exception.

@item 
bpo-42644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42644}: @code{logging.disable} will now validate the types and value of
its parameter. It also now accepts strings representing the levels (as
does @code{logging.setLevel}) instead of only the numerical values.

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: At Python exit, if a callback registered with
@ref{915,,atexit.register()} fails, its exception is now logged. Previously,
only some exceptions were logged, and the last exception was always
silently ignored.

@item 
bpo-36541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36541}: Fixed lib2to3.pgen2 to be able to parse PEP-570 positional only
argument syntax.

@item 
bpo-42382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42382}: In @code{importlib.metadata}: -  @code{EntryPoint} objects now expose
a @code{.dist} object referencing the @code{Distribution} when constructed from
a @code{Distribution}. - Add support for package discovery under package
normalization rules. - The object returned by @code{metadata()} now has a
formally defined protocol called @code{PackageMetadata} with declared support
for the @code{.get_all()} method. - Synced with importlib_metadata 3.3.

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}: A check is added against misspellings of autospect, auto_spec
and set_spec being passed as arguments to patch, patch.object and
create_autospec.

@item 
bpo-39717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39717}: [tarfile] update nested exception raising to use @code{from None}
or @code{from e}

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}: AttributeError for suspected misspellings of assertions on
mocks are now pointing out that the cause are misspelled assertions and
also what to do if the misspelling is actually an intended attribute name.
The unittest.mock document is also updated to reflect the current set of
recognised misspellings.

@item 
bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}: Implemented 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}: added @code{ParamSpec} and @code{Concatenate}
to @ref{104,,typing}.  Patch by Ken Jin.

@item 
bpo-42385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42385}: StrEnum: fix _generate_next_value_ to return a str

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Define THREAD_STACK_SIZE for VxWorks.

@item 
bpo-34750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34750}: [Enum] @code{_EnumDict.update()} is now supported.

@item 
bpo-42517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42517}: Enum: private names do not become members / do not generate
errors – they remain normal attributes

@item 
bpo-42678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42678}: @code{Enum}: call @code{__init_subclass__} after members have been
added

@item 
bpo-28964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28964}: @ref{ca0,,ast.literal_eval()} adds line number information (if
available) in error message for malformed nodes.

@item 
bpo-42470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42470}: @ref{7e1,,random.sample()} no longer warns on a sequence which is
also a set.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: @code{posixpath.expanduser()} returns the input `path' unchanged
if user home directory is None on VxWorks.

@item 
bpo-42388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42388}: Fix subprocess.check_output(…, input=None) behavior when
text=True to be consistent with that of the documentation and
universal_newlines=True.

@item 
bpo-34463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34463}: Fixed discrepancy between @ref{fe,,traceback} and the interpreter
in formatting of SyntaxError with lineno not set (@ref{fe,,traceback} was
changed to match interpreter).

@item 
bpo-42393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42393}: Raise @ref{919,,OverflowError} instead of silent truncation in
@ref{918,,socket.ntohs()} and @ref{917,,socket.htons()}.  Silent truncation was
deprecated in Python 3.7. Patch by Erlend E. Aasland

@item 
bpo-42222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42222}: Harmonized @ref{902,,random.randrange()} argument handling to match
@ref{9d6,,range()}.


@itemize *

@item 
The integer test and conversion in @code{randrange()} now uses
@ref{1917,,operator.index()}.

@item 
Non-integer arguments to @code{randrange()} are deprecated.

@item 
The @code{ValueError} is deprecated in favor of a @code{TypeError}.

@item 
It now runs a little faster than before.
@end itemize

(Contributed by Raymond Hettinger and Serhiy Storchaka.)

@item 
bpo-42163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42163}: Restore compatibility for @code{uname_result} around deepcopy and
_replace.

@item 
bpo-42090@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42090}: @code{zipfile.Path.joinpath} now accepts arbitrary arguments, same
as @code{pathlib.Path.joinpath}.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the _csv module to the multi-phase initialization API
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-42059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42059}: @ref{2ce,,typing.TypedDict} types created using the alternative
call-style syntax now correctly respect the @code{total} keyword argument
when setting their @code{__required_keys__} and @code{__optional_keys__} class
attributes.

@item 
bpo-41960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41960}: Add @code{globalns} and @code{localns} parameters to the
@ref{181,,inspect.signature()} and @ref{7d5,,inspect.Signature.from_callable()}.

@item 
bpo-41907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41907}: fix @code{format()} behavior for @code{IntFlag}

@item 
bpo-41891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41891}: Ensure asyncio.wait_for waits for task completion

@item 
bpo-24792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24792}: Fixed bug where @code{zipimporter} sometimes reports an
incorrect cause of import errors.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix site and sysconfig modules for VxWorks RTOS which has no
home directories.

@item 
bpo-41462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41462}: Add @ref{ebf,,os.set_blocking()} support for VxWorks RTOS.

@item 
bpo-40219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40219}: Lowered @code{tkinter.ttk.LabeledScale} dummy widget to
prevent hiding part of the content label.

@item 
bpo-37193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37193}: Fixed memory leak in @code{socketserver.ThreadingMixIn} introduced
in Python 3.7.

@item 
bpo-39068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39068}: Fix initialization race condition in @code{a85encode()} and
@code{b85encode()} in @ref{f,,base64}. Patch by Brandon Stansbury.
@end itemize

@node Documentation<29>,Tests<29>,Library<30>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id268}@anchor{1918}
@subsubsection Documentation



@itemize -

@item 
bpo-17140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17140}: Add documentation for the
@ref{1919,,multiprocessing.pool.ThreadPool} class.

@item 
bpo-34398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34398}: Prominently feature listings from the glossary in documentation
search results. Patch by Ammar Askar.
@end itemize

@node Tests<29>,Build<30>,Documentation<29>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id269}@anchor{191a}
@subsubsection Tests



@itemize -

@item 
bpo-42794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42794}: Update test_nntplib to use official group name of news.aioe.org
for testing. Patch by Donghee Na.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Skip some asyncio tests on VxWorks.

@item 
bpo-42641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42641}: Enhance @code{test_select.test_select()}: it now takes 500
milliseconds rather than 10 seconds. Use Python rather than a shell to
make the test more portable.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Skip some tests in _test_all_chown_common() on VxWorks.

@item 
bpo-42199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42199}: Fix bytecode helper assertNotInBytecode.

@item 
bpo-41443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41443}: Add more attribute checking in test_posix.py

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Disable os.popen and impacted tests on VxWorks

@item 
bpo-41439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41439}: Port test_ssl and test_uuid to VxWorks RTOS.
@end itemize

@node Build<30>,macOS<24>,Tests<29>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id270}@anchor{191b}
@subsubsection Build



@itemize -

@item 
bpo-42692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42692}: Fix __builtin_available check on older compilers. Patch by
Joshua Root.

@item 
bpo-27640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27640}: Added @code{--disable-test-modules} option to the @code{configure}
script: don’t build nor install test modules. Patch by Xavier de Gaye,
Thomas Petazzoni and Peixing Xin.

@item 
bpo-42604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42604}: Now all platforms use a value for the «EXT_SUFFIX» build
variable derived from SOABI (for instance in freeBSD, «EXT_SUFFIX» is now
«.cpython-310d.so» instead of «.so»). Previously only Linux, Mac and
VxWorks were using a value for «EXT_SUFFIX» that included «SOABI».

@item 
bpo-42598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42598}: Fix implicit function declarations in configure which could
have resulted in incorrect configuration checks.  Patch contributed by
Joshua Root.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Enable libpython3.so for VxWorks.

@item 
bpo-29076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29076}: Add fish shell support to macOS installer.
@end itemize

@node macOS<24>,Tools/Demos<15>,Build<30>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id271}@anchor{191c}
@subsubsection macOS



@itemize -

@item 
bpo-42361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42361}: Update macOS installer build to use Tcl/Tk 8.6.11 (rc2,
expected to be final release).

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: Update macOS installer build to use OpenSSL 1.1.1i.

@item 
bpo-42584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42584}: Update macOS installer to use SQLite 3.34.0.
@end itemize

@node Tools/Demos<15>,C API<29>,macOS<24>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id272}@anchor{191d}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-42726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42726}: Fixed Python 3 compatibility issue with gdb/libpython.py
handling of attribute dictionaries.

@item 
bpo-42613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42613}: Fix @code{freeze.py} tool to use the prope config and library
directories. Patch by Victor Stinner.
@end itemize

@node C API<29>,,Tools/Demos<15>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id273}@anchor{191e}
@subsubsection C API



@itemize -

@item 
bpo-42591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42591}: Export the @code{Py_FrozenMain()} function: fix a Python 3.9.0
regression. Python 3.9 uses @code{-fvisibility=hidden} and the function was
not exported explicitly and so not exported.

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: Remove the private @code{_Py_fopen()} function which is no
longer needed. Use @code{_Py_wfopen()} or @code{_Py_fopen_obj()}
instead. Patch by Victor Stinner.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{bc,,resource} extension module to module state

@item 
bpo-42111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42111}: Update the @code{xxlimited} module to be a better example of how
to use the limited C API.

@item 
bpo-40052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40052}: Fix an alignment build warning/error in function
@code{PyVectorcall_Function()}. Patch by Andreas Schneider, Antoine Pitrou
and Petr Viktorin.
@end itemize

@node Python 3 10 0 alpha 3,Python 3 10 0 alpha 2,Python 3 10 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-3}@anchor{191f}
@subsection Python 3.10.0 alpha 3


`Release date: 2020-12-07'

@menu
* Security: Security<20>. 
* Core and Builtins: Core and Builtins<31>. 
* Library: Library<31>. 
* Documentation: Documentation<30>. 
* Tests: Tests<30>. 
* Build: Build<31>. 
* Windows: Windows<30>. 
* macOS: macOS<25>. 
* IDLE: IDLE<20>. 
* Tools/Demos: Tools/Demos<16>. 
* C API: C API<30>. 

@end menu

@node Security<20>,Core and Builtins<31>,,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id274}@anchor{1920}
@subsubsection Security



@itemize -

@item 
bpo-40791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40791}: Add @code{volatile} to the accumulator variable in
@code{hmac.compare_digest}, making constant-time-defeating optimizations less
likely.
@end itemize

@node Core and Builtins<31>,Library<31>,Security<20>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id275}@anchor{1921}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-42576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42576}: @code{types.GenericAlias} will now raise a @code{TypeError} when
attempting to initialize with a keyword argument.  Previously, this would
cause the interpreter to crash if the interpreter was compiled with debug
symbols. This does not affect interpreters compiled for release.  Patch by
Ken Jin.

@item 
bpo-42536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42536}: Several built-in and standard library types now ensure that
their internal result tuples are always tracked by the @ref{1922,,garbage collector}:


@itemize -

@item 
@ref{67c,,collections.OrderedDict.items()}

@item 
@ref{868,,dict.items()}

@item 
@ref{14bb,,enumerate()}

@item 
@ref{17d,,functools.reduce()}

@item 
@ref{137a,,itertools.combinations()}

@item 
@ref{12ee,,itertools.combinations_with_replacement()}

@item 
@ref{1923,,itertools.permutations()}

@item 
@ref{1924,,itertools.product()}

@item 
@ref{130a,,itertools.zip_longest()}

@item 
@ref{14d,,zip()}
@end itemize

Previously, they could have become untracked by a prior garbage
collection. Patch by Brandt Bucher.

@item 
bpo-42500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42500}: Improve handling of exceptions near recursion limit. Converts a
number of Fatal Errors in RecursionErrors.

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: PEP 626: After a return, the f_lineno attribute of a frame is
always the last line executed.

@item 
bpo-42435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42435}: Speed up comparison of bytes objects with non-bytes objects
when option @ref{683,,-b} is specified. Speed up comparison of bytarray
objects with non-buffer object.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_warnings} extension module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}). Patch by Victor Stinner.

@item 
bpo-41686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41686}: On Windows, the @code{SIGINT} event, @code{_PyOS_SigintEvent()}, is
now created even if Python is configured to not install signal handlers
(if @ref{955,,PyConfig.install_signal_handlers} equals to 0, or
@code{Py_InitializeEx(0)}).

@item 
bpo-42381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42381}: Allow assignment expressions in set literals and set
comprehensions as per PEP 572. Patch by Pablo Galindo.

@item 
bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}: Change function parameters annotations internal representation
to tuple of strings. Patch provided by Yurii Karabas.

@item 
bpo-42374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42374}: Fix a regression introduced by the new parser, where an
unparenthesized walrus operator was not allowed within generator
expressions.

@item 
bpo-42316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42316}: Allow an unparenthesized walrus in subscript indexes.

@item 
bpo-42349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42349}: Make sure that the compiler front-end produces a well-formed
control flow graph. Be more aggressive in the compiler back-end, as it is
now safe to do so.

@item 
bpo-42296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42296}: On Windows, fix a regression in signal handling which prevented
to interrupt a program using CTRL+C. The signal handler can be run in a
thread different than the Python thread, in which case the test deciding
if the thread can handle signals is wrong.

@item 
bpo-42332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42332}: @ref{882,,types.GenericAlias} objects can now be the targets of
weakrefs.

@item 
bpo-42282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42282}: Optimise constant subexpressions that appear as part of named
expressions (previously the AST optimiser did not descend into named
expressions). Patch by Nick Coghlan.

@item 
bpo-42266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42266}: Fixed a bug with the LOAD_ATTR opcode cache that was not
respecting monkey-patching a class-level attribute to make it a
descriptor. Patch by Pablo Galindo.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{b6,,queue} to use heap types.

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: Improved accuracy of line tracing events and f_lineno attribute
of Frame objects. See PEP 626 for details.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{90,,mmap} to use heap types.

@item 
bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}: Allow @code{GenericAlias} objects to use @ref{85b,,union type expressions}. This allows expressions like @code{list[int] |
dict[float, str]} where previously a @code{TypeError} would have been
thrown.  This also fixes union type expressions not de-duplicating
@code{GenericAlias} objects. (Contributed by Ken Jin in bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}.)

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}: The import system triggers a @code{ImportWarning} when it falls
back to using @code{load_module()}.
@end itemize

@node Library<31>,Documentation<30>,Core and Builtins<31>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id276}@anchor{1925}
@subsubsection Library



@itemize -

@item 
bpo-5054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5054}: CGIHTTPRequestHandler.run_cgi() HTTP_ACCEPT improperly parsed.
Replace the special purpose getallmatchingheaders with generic get_all
method and add relevant tests.

Original Patch by Martin Panter. Modified by Senthil Kumaran.

@item 
bpo-42562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42562}: Fix issue when dis failed to parse function that has no line
numbers. Patch provided by Yurii Karabas.

@item 
bpo-17735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17735}: @code{inspect.findsource()} now raises @ref{4d5,,OSError} instead of
@ref{1575,,IndexError} when @code{co_lineno} of a code object is greater than
the file length. This can happen, for example, when a file is edited after
it was imported.  PR by Irit Katriel.

@item 
bpo-42116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42116}: Fix handling of trailing comments by @ref{15ce,,inspect.getsource()}.

@item 
bpo-42532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42532}: Remove unexpected call of @code{__bool__} when passing a
@code{spec_arg} argument to a Mock.

@item 
bpo-38200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38200}: Added itertools.pairwise()

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: Fix test_master_read() so that it succeeds on all platforms
that either raise OSError or return b»» upon reading from master.

@item 
bpo-42487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42487}: ChainMap.__iter__ no longer calls __getitem__ on underlying
maps

@item 
bpo-42482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42482}: @ref{3b3,,TracebackException} no longer holds a
reference to the exception’s traceback object. Consequently, instances of
TracebackException for equivalent but non-equal exceptions now compare as
equal.

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: Make test_openpty() avoid unexpected success due to number of
rows and/or number of columns being == 0.

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: Remove loop parameter from @code{asyncio.subprocess} and
@code{asyncio.tasks} functions. Patch provided by Yurii Karabas.

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: Remove loop parameter from @code{asyncio.open_connection} and
@code{asyncio.start_server} functions. Patch provided by Yurii Karabas.

@item 
bpo-28468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28468}: Add @ref{8bd,,platform.freedesktop_os_release()} function to parse
freedesktop.org @code{os-release} files.

@item 
bpo-42299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42299}: Removed the @code{formatter} module, which was deprecated in
Python 3.4. It is somewhat obsolete, little used, and not tested. It was
originally scheduled to be removed in Python 3.6, but such removals were
delayed until after Python 2.7 EOL. Existing users should copy whatever
classes they use into their code. Patch by Donghee Na and and Terry J.
Reedy.

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}: Deprecate zipimport.zipimporter.load_module() in favour of
exec_module().

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: Updated tests for the pty library. test_basic() has been
changed to test_openpty(); this additionally checks if slave termios and
slave winsize are being set properly by pty.openpty(). In order to add
support for FreeBSD, NetBSD, OpenBSD, and Darwin, this also adds
test_master_read(), which demonstrates that pty.spawn() should not depend
on an OSError to exit from its copy loop.

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: Remove loop parameter from @code{__init__} in all
@code{asyncio.locks} and @code{asyncio.Queue} classes. Patch provided by Yurii
Karabas.

@item 
bpo-15450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15450}: Make @ref{fc0,,filecmp.dircmp} respect subclassing. Now the
@ref{1926,,filecmp.dircmp.subdirs} behaves as expected when subclassing
dircmp.

@item 
bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}: The exception @ref{8cb,,socket.timeout} is now an alias of
@ref{8cc,,TimeoutError}.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Support signal module on VxWorks.

@item 
bpo-42406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42406}: We fixed an issue in @code{pickle.whichmodule} in which importing
@code{multiprocessing} could change the how pickle identifies which module an
object belongs to, potentially breaking the unpickling of those objects.

@item 
bpo-42403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42403}: Simplify the @ref{77,,importlib} external bootstrap code:
@code{importlib._bootstrap_external} now uses regular imports to import
builtin modules. When it is imported, the builtin @ref{96b,,__import__()}
function is already fully working and so can be used to import builtin
modules like @ref{d9,,sys}. Patch by Victor Stinner.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Convert _sre module types to heap types (PEP 384). Patch by
Erlend E. Aasland.

@item 
bpo-42375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42375}: subprocess module update for DragonFlyBSD support.

@item 
bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}: Port the @code{_signal} extension module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}). Patch by Victor Stinner and Mohamed
Koubaa.

@item 
bpo-37205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37205}: @ref{3ad,,time.time()}, @ref{b14,,time.perf_counter()} and
@ref{3ac,,time.monotonic()} functions can no longer fail with a Python fatal
error, instead raise a regular Python exception on failure.

@item 
bpo-42328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42328}: Fixed @ref{1927,,tkinter.ttk.Style.map()}. The function accepts now
the representation of the default state as empty sequence (as returned by
@code{Style.map()}). The structure of the result is now the same on all
platform and does not depend on the value of @code{wantobjects}.

@item 
bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}: Fix various issues with @code{typing.Literal} parameter handling
(flatten, deduplicate, use type to cache key). Patch provided by Yurii
Karabas.

@item 
bpo-37205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37205}: @ref{b14,,time.perf_counter()} on Windows and @ref{3ac,,time.monotonic()}
on macOS are now system-wide. Previously, they used an offset computed at
startup to reduce the precision loss caused by the float type. Use
@ref{b70,,time.perf_counter_ns()} and @ref{b6f,,time.monotonic_ns()} added in Python
3.7 to avoid this precision loss.

@item 
bpo-42318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42318}: Fixed support of non-BMP characters in @ref{f0,,tkinter} on macOS.

@item 
bpo-42350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42350}: Fix the @ref{9df,,threading.Thread} class at fork: do nothing if
the thread is already stopped (ex: fork called at Python exit).
Previously, an error was logged in the child process.

@item 
bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}: Port _ssl extension module to heap types.

@item 
bpo-42014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42014}: The @code{onerror} callback from @code{shutil.rmtree} now receives
correct function when @code{os.open} fails.

@item 
bpo-42237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42237}: Fix @code{os.sendfile()} on illumos.

@item 
bpo-42308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42308}: Add @ref{8e1,,threading.__excepthook__} to allow retrieving the
original value of @ref{8e2,,threading.excepthook()} in case it is set to a
broken or a different value. Patch by Mario Corchero.

@item 
bpo-42131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42131}: Implement PEP 451/spec methods on zipimport.zipimporter:
find_spec(), create_module(), and exec_module().

This also allows for the documented deprecation of find_loader(),
find_module(), and load_module().

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}: Mock objects which are not unsafe will now raise an
AttributeError if an attribute with the prefix asert, aseert, or assrt is
accessed, in addition to this already happening for the prefixes assert or
assret.

@item 
bpo-42264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42264}: @code{sqlite3.OptimizedUnicode} has been undocumented and obsolete
since Python 3.3, when it was made an alias to @ref{237,,str}.  It is now
deprecated, scheduled for removal in Python 3.12.

@item 
bpo-42251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42251}: Added @ref{8dd,,threading.gettrace()} and
@ref{8de,,threading.getprofile()} to retrieve the functions set by
@ref{8df,,threading.settrace()} and @ref{8e0,,threading.setprofile()} respectively.
Patch by Mario Corchero.

@item 
bpo-42249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42249}: Fixed writing binary Plist files larger than 4 GiB.

@item 
bpo-42236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42236}: On Unix, the @ref{1899,,os.device_encoding()} function now returns
@code{'UTF-8'} rather than the device encoding if the @ref{6f7,,Python UTF-8 Mode} is enabled.

@item 
bpo-41754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41754}: webbrowser: Ignore `NotADirectoryError' when calling
@code{xdg-settings}.

@item 
bpo-42183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42183}: Fix a stack overflow error for asyncio Task or Future repr().

The overflow occurs under some circumstances when a Task or Future
recursively returns itself.

@item 
bpo-42140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42140}: Improve asyncio.wait function to create the futures set just
one time.

@item 
bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}: Update various modules in the stdlib to fall back on
@code{__spec__.loader} when @code{__loader__} isn’t defined on a module.

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}: The @code{load_module()} methods found in @code{importlib} now
trigger a @code{DeprecationWarning}.

@item 
bpo-39825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39825}: Windows: Change @code{sysconfig.get_config_var('EXT_SUFFIX')} to
the expected full @code{platform_tag.extension} format. Previously it was
hard-coded to @code{.pyd}, now it is compatible with @code{distutils.sysconfig}
and will result in something like @code{.cp38-win_amd64.pyd}. This brings
windows into conformance with the other platforms.

@item 
bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}: The @ref{8e4,,traceback.format_exception()},
@ref{8e5,,traceback.format_exception_only()}, and
@ref{8e6,,traceback.print_exception()} functions can now take an exception
object as a positional-only argument.

@item 
bpo-41889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41889}: Enum: fix regression involving inheriting a multiply inherited
enum

@item 
bpo-41861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41861}: Convert @ref{cf,,sqlite3} to use heap types (PEP 384). Patch by
Erlend E. Aasland.

@item 
bpo-40624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40624}: Added support for the XPath @code{!=} operator in xml.etree

@item 
bpo-28850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28850}: Fix @ref{1928,,pprint.PrettyPrinter.format()} overrides being ignored
for contents of small containers. The @code{pprint._safe_repr()} function
was removed.

@item 
bpo-41625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41625}: Expose the @code{splice()} as @ref{8b0,,os.splice()} in the
@ref{a1,,os} module. Patch by Pablo Galindo

@item 
bpo-34215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34215}: Clarify the error message for
@ref{1929,,asyncio.IncompleteReadError} when @code{expected} is @code{None}.

@item 
bpo-41543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41543}: Add async context manager support for contextlib.nullcontext.

@item 
bpo-21041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21041}: @ref{8b7,,pathlib.PurePath.parents} now supports negative
indexing. Patch contributed by Yaroslav Pankovych.

@item 
bpo-41332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41332}: Added missing connect_accepted_socket() method to
@code{asyncio.AbstractEventLoop}.

@item 
bpo-12800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12800}: Extracting a symlink from a tarball should succeed and
overwrite the symlink if it already exists. The fix is to remove the
existing file or symlink before extraction. Based on patch by Chris AtLee,
Jeffrey Kintscher, and Senthil Kumaran.

@item 
bpo-40968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40968}: @ref{10b,,urllib.request} and @ref{6f,,http.client} now send
@code{http/1.1} ALPN extension during TLS handshake when no custom context is
supplied.

@item 
bpo-41001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41001}: Add @ref{8af,,os.eventfd()} to provide a low level interface for
Linux’s event notification file descriptor.

@item 
bpo-40816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40816}: Add AsyncContextDecorator to contextlib to support async
context manager as a decorator.

@item 
bpo-40550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40550}: Fix time-of-check/time-of-action issue in
subprocess.Popen.send_signal.

@item 
bpo-39411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39411}: Add an @code{is_async} identifier to @ref{b4,,pyclbr}’s @code{Function}
objects. Patch by Batuhan Taskaya

@item 
bpo-35498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35498}: Add slice support to @ref{8b7,,pathlib.PurePath.parents}.
@end itemize

@node Documentation<30>,Tests<30>,Library<31>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id277}@anchor{192a}
@subsubsection Documentation



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: Tentative to deprecate @code{make suspicious} by first removing it
from the CI and documentation builds, but keeping it around for manual
uses.

@item 
bpo-42153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42153}: Fix the URL for the IMAP protocol documents.

@item 
bpo-41028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41028}: Language and version switchers, previously maintained in every
cpython branches, are now handled by docsbuild-script.
@end itemize

@node Tests<30>,Build<31>,Documentation<30>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id278}@anchor{192b}
@subsubsection Tests



@itemize -

@item 
bpo-41473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41473}: Re-enable test_gdb on gdb 9.2 and newer:
@indicateurl{https://bugzilla.redhat.com/show_bug.cgi?id=1866884} bug is fixed in gdb
10.1.

@item 
bpo-42553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42553}: Fix @code{test_asyncio.test_call_later()} race condition: don’t
measure asyncio performance in the @code{call_later()} unit test. The test
failed randomly on the CI.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix test_netrc on VxWorks: create temporary directories using
temp_cwd().

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: skip test_getaddrinfo_ipv6_scopeid_symbolic and
test_getnameinfo_ipv6_scopeid_symbolic on VxWorks

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: skip test_test of test_mailcap on VxWorks

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: add shell requirement for test_pipes

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: skip some tests related to fifo on VxWorks

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix test_doctest.py failures for VxWorks.

@item 
bpo-40754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40754}: Include @code{_testinternalcapi} module in Windows installer for
test suite

@item 
bpo-41561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41561}: test_ssl: skip test_min_max_version_mismatch when TLS 1.0 is
not available

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix os module failures for VxWorks RTOS.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix fifo test cases for VxWorks RTOS.
@end itemize

@node Build<31>,Windows<30>,Tests<30>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id279}@anchor{192c}
@subsubsection Build



@itemize -

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: remove libnet dependency from detect_socket() for VxWorks

@item 
bpo-42398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42398}: Fix a race condition in «make regen-all» when make -jN option
is used to run jobs in parallel. The clinic.py script now only use atomic
write to write files. Moveover, generated files are now left unchanged if
the content does not change, to not change the file modification time.

@item 
bpo-41617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41617}: Fix building @code{pycore_bitutils.h} internal header on old clang
version without @code{__builtin_bswap16()} (ex: Xcode 4.6.3 on Mac OS X
10.7). Patch by Joshua Root and Victor Stinner.

@item 
bpo-38823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38823}: It is no longer possible to build the @code{_ctypes} extension
module without @code{wchar_t} type: remove @code{CTYPES_UNICODE} macro.
Anyway, the @code{wchar_t} type is required to build Python. Patch by
Victor Stinner.

@item 
bpo-42087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42087}: Support was removed for AIX 5.3 and below. See bpo-40680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40680}.

@item 
bpo-40998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40998}: Addressed three compiler warnings found by undefined behavior
sanitizer (ubsan).
@end itemize

@node Windows<30>,macOS<25>,Build<31>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id280}@anchor{192d}
@subsubsection Windows



@itemize -

@item 
bpo-42120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42120}: Remove macro definition of @code{copysign} (to @code{_copysign}) in
headers.

@item 
bpo-38506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38506}: The Windows launcher now properly handles Python 3.10 when
listing installed Python versions.
@end itemize

@node macOS<25>,IDLE<20>,Windows<30>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id281}@anchor{192e}
@subsubsection macOS



@itemize -

@item 
bpo-42504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42504}: Fix build on macOS Big Sur when MACOSX_DEPLOYMENT_TARGET=11

@item 
bpo-41116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41116}: Ensure distutils.unixxcompiler.find_library_file can find
system provided libraries on macOS 11.

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: Add support for macOS 11 and Apple Silicon systems.

It is now possible to build «Universal 2» binaries using
«–enable-universalsdk –with-universal-archs=universal2».

Binaries build on later macOS versions can be deployed back to older
versions (tested up to macOS 10.9), when using the correct deployment
target. This is tested using Xcode 11 and later.

@item 
bpo-42232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42232}: Added Darwin specific madvise options to mmap module.

@item 
bpo-38443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38443}: The @code{--enable-universalsdk} and @code{--with-universal-archs}
options for the configure script now check that the specified
architectures can be used.
@end itemize

@node IDLE<20>,Tools/Demos<16>,macOS<25>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id282}@anchor{192f}
@subsubsection IDLE



@itemize -

@item 
bpo-42508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42508}: Keep IDLE running on macOS.  Remove obsolete workaround that
prevented running files with shortcuts when using new universal2
installers built on macOS 11.

@item 
bpo-42426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42426}: Fix reporting offset of the RE error in searchengine.

@item 
bpo-42415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42415}: Get docstrings for IDLE calltips more often by using
inspect.getdoc.
@end itemize

@node Tools/Demos<16>,C API<30>,IDLE<20>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id283}@anchor{1930}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-42212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42212}: The smelly.py script now also checks the Python dynamic library
and extension modules, not only the Python static library. Make also the
script more verbose: explain what it does.

@item 
bpo-36310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36310}: Allow @code{Tools/i18n/pygettext.py} to detect calls to
@code{gettext} in f-strings.
@end itemize

@node C API<30>,,Tools/Demos<16>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id284}@anchor{1931}
@subsubsection C API



@itemize -

@item 
bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423}: The @ref{622,,PyType_FromSpecWithBases()} and
@ref{5f4,,PyType_FromModuleAndSpec()} functions now accept a single class as
the `bases' argument.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{c1,,select} extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _posixsubprocess extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _posixshmem extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _struct extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{spwd} extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{60,,gc} extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _queue extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Convert @ref{26e,,Py_TYPE()} and @ref{81b,,Py_SIZE()} back to macros
to allow using them as an l-value. Many third party C extension modules
rely on the ability of using Py_TYPE() and Py_SIZE() to set an object type
and size: @code{Py_TYPE(obj) = type;} and @code{Py_SIZE(obj) = size;}.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{d8,,symtable} extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{66,,grp} and @ref{b2,,pwd} extension modules to
multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _random extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _hashlib extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}: Removed the undocumented @code{PyOS_InitInterrupts()} function.
Initializing Python already implicitly installs signal handlers: see
@ref{955,,PyConfig.install_signal_handlers}. Patch by Victor Stinner.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: The @code{Py_TRASHCAN_BEGIN} macro no longer accesses PyTypeObject
attributes, but now can get the condition by calling the new private
@code{_PyTrash_cond()} function which hides implementation details.

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: @ref{27d,,Py_GetPath()}, @ref{27f,,Py_GetPrefix()},
@ref{27a,,Py_GetExecPrefix()}, @ref{282,,Py_GetProgramFullPath()},
@ref{285,,Py_GetPythonHome()} and @ref{284,,Py_GetProgramName()} functions now
return @code{NULL} if called before @ref{247,,Py_Initialize()} (before Python is
initialized). Use the new @ref{49a,,Python Initialization Configuration API} to get the @ref{944,,Python Path Configuration.}. Patch by Victor Stinner.

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: The @ref{829,,PyConfig_Read()} function now only parses
@ref{4a4,,PyConfig.argv} arguments once: @ref{1932,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
strippped from @ref{4a4,,PyConfig.argv}, parsing arguments twice would
parse the application options as Python options.

@item 
bpo-42262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42262}: Added @ref{932,,Py_NewRef()} and @ref{933,,Py_XNewRef()} functions to
increment the reference count of an object and return the object. Patch by
Victor Stinner.

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: When @ref{247,,Py_Initialize()} is called twice, the second call
now updates more @ref{d9,,sys} attributes for the configuration, rather than
only @ref{12d2,,sys.argv}. Patch by Victor Stinner.

@item 
bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832}: The @ref{5f4,,PyType_FromModuleAndSpec()} function now accepts
NULL @code{tp_doc} slot.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Added @ref{459,,PyModule_AddObjectRef()} function: similar to
@ref{45a,,PyModule_AddObject()} but don’t steal a reference to the value on
success. Patch by Victor Stinner.

@item 
bpo-42171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42171}: The @ref{1633,,METH_FASTCALL} calling convention is added to the
limited API. The functions  @ref{a07,,PyModule_AddType()},
@ref{5f4,,PyType_FromModuleAndSpec()}, @ref{a00,,PyType_GetModule()} and
@ref{a01,,PyType_GetModuleState()} are added to the limited API on Windows.

@item 
bpo-42085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42085}: Add dedicated entry to PyAsyncMethods for sending values

@item 
bpo-41073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41073}: @ref{934,,PyType_GetSlot()} can now accept static types.

@item 
bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459}: @ref{480,,PyList_SET_ITEM()}, @ref{47f,,PyTuple_SET_ITEM()} and
@ref{945,,PyCell_SET()} macros can no longer be used as l-value or r-value.
For example, @code{x = PyList_SET_ITEM(a, b, c)} and @code{PyList_SET_ITEM(a, b,
c) = x} now fail with a compiler error. It prevents bugs like @code{if
(PyList_SET_ITEM (a, b, c) < 0) ...} test. Patch by Zackery Spytz and
Victor Stinner.
@end itemize

@node Python 3 10 0 alpha 2,Python 3 10 0 alpha 1,Python 3 10 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-2}@anchor{1933}
@subsection Python 3.10.0 alpha 2


`Release date: 2020-11-03'

@menu
* Security: Security<21>. 
* Core and Builtins: Core and Builtins<32>. 
* Library: Library<32>. 
* Documentation: Documentation<31>. 
* Tests: Tests<31>. 
* Build: Build<32>. 
* Windows: Windows<31>. 
* macOS: macOS<26>. 
* IDLE: IDLE<21>. 
* C API: C API<31>. 

@end menu

@node Security<21>,Core and Builtins<32>,,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id285}@anchor{1934}
@subsubsection Security



@itemize -

@item 
bpo-42103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42103}: Prevented potential DoS attack via CPU and RAM exhaustion when
processing malformed Apple Property List files in binary format.

@item 
bpo-42051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42051}: The @ref{ab,,plistlib} module no longer accepts entity
declarations in XML plist files to avoid XML vulnerabilities. This should
not affect users as entity declarations are not used in regular plist
files.
@end itemize

@node Core and Builtins<32>,Library<32>,Security<21>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id286}@anchor{1935}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-42236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42236}: If the @code{nl_langinfo(CODESET)} function returns an empty
string, Python now uses UTF-8 as the filesystem encoding. Patch by Victor
Stinner.

@item 
bpo-42218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42218}: Fixed a bug in the PEG parser that was causing crashes in debug
mode. Now errors are checked in left-recursive rules to avoid cases where
such errors do not get handled in time and appear as long-distance crashes
in other places.

@item 
bpo-42214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42214}: Fixed a possible crash in the PEG parser when checking for the
“!=” token in the @code{barry_as_flufl} rule. Patch by Pablo Galindo.

@item 
bpo-42206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42206}: Propagate and raise the errors caused by
@code{PyAST_Validate()} in the parser.

@item 
bpo-41796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41796}: The @ref{9,,ast} module internal state is now per interpreter.
Patch by Victor Stinner.

@item 
bpo-42143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42143}: Fix handling of errors during creation of @code{PyFunctionObject},
which resulted in operations on uninitialized memory. Patch by Yonatan
Goldschmidt.

@item 
bpo-41659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41659}: Fix a bug in the parser, where a curly brace following a
@code{primary} didn’t fail immediately. This led to invalid expressions like
@code{a @{b@}} to throw a @ref{150,,SyntaxError} with a wrong offset, or invalid
expressions ending with a curly brace like @code{a @{} to not fail immediately
in the REPL.

@item 
bpo-42150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42150}: Fix possible buffer overflow in the new parser when checking
for continuation lines. Patch by Pablo Galindo.

@item 
bpo-42123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42123}: Run the parser two times. On the first run, disable all the
rules that only generate better error messages to gain performance. If
there’s a parse failure, run the parser a second time with those enabled.

@item 
bpo-42093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42093}: The @code{LOAD_ATTR} instruction now uses new «per opcode cache»
mechanism and it is about 36% faster now. Patch by Pablo Galindo and Yury
Selivanov.

@item 
bpo-42030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42030}: Support for the legacy AIX-specific shared library loading
support has been removed. All versions of AIX since 4.3 have supported and
defaulted to using the common Unix mechanism instead.

@item 
bpo-41984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41984}: The garbage collector now tracks all user-defined classes.
Patch by Brandt Bucher.

@item 
bpo-41993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41993}: Fixed potential issues with removing not completely initialized
module from @code{sys.modules} when import fails.

@item 
bpo-41979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41979}: Star-unpacking is now allowed for with item’s targets in the
PEG parser.

@item 
bpo-41974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41974}: Removed special methods @code{__int__}, @code{__float__},
@code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__rfloordiv__},
@code{__rmod__} and @code{__rdivmod__} of the @ref{154,,complex} class.  They
always raised a @ref{228,,TypeError}.

@item 
bpo-41902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41902}: Micro optimization when compute
@ref{1936,,sq_item} and
@ref{1937,,mp_subscript} of @ref{9d6,,range}. Patch by
Donghee Na.

@item 
bpo-41894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41894}: When loading a native module and a load failure occurs, prevent
a possible UnicodeDecodeError when not running in a UTF-8 locale by
decoding the load error message using the current locale’s encoding.

@item 
bpo-41902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41902}: Micro optimization for range.index if step is 1. Patch by
Donghee Na.

@item 
bpo-41435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41435}: Add @code{sys._current_exceptions()} function to retrieve a
dictionary mapping each thread’s identifier to the topmost exception
currently active in that thread at the time the function is called.

@item 
bpo-38605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38605}: Enable @code{from __future__ import annotations} (
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}) by
default. The values found in @ref{e08,,__annotations__} dicts are now
strings, for example @code{@{"x": "int"@}} instead of @code{@{"x": int@}}.
@end itemize

@node Library<32>,Documentation<31>,Core and Builtins<32>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id287}@anchor{1938}
@subsubsection Library



@itemize -

@item 
bpo-35455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35455}: On Solaris, @ref{9c9,,thread_time()} is now implemented with
@code{gethrvtime()} because @code{clock_gettime(CLOCK_THREAD_CPUTIME_ID)} is not
always available. Patch by Jakub Kulik.

@item 
bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}: The @ref{894,,repr()} of @ref{104,,typing} types containing
@ref{753,,Generic Alias Types} previously did not show
the parameterized types in the @code{GenericAlias}.  They have now been
changed to do so.

@item 
bpo-29566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29566}: @code{binhex.binhex()} consistently writes macOS 9 line endings.

@item 
bpo-26789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26789}: The @ref{18a7,,logging.FileHandler} class now keeps a reference to
the builtin @ref{1be,,open()} function to be able to open or reopen the file
during Python finalization. Fix errors like: @code{NameError: name 'open' is
not defined}. Patch by Victor Stinner.

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: Removed the @code{unicodedata.ucnhash_CAPI} attribute which was an
internal PyCapsule object. The related private @code{_PyUnicode_Name_CAPI}
structure was moved to the internal C API. Patch by Victor Stinner.

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: Convert the @ref{105,,unicodedata} extension module to the
multiphase initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) and convert the
@code{unicodedata.UCD} static type to a heap type. Patch by Mohamed Koubaa
and Victor Stinner.

@item 
bpo-42146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42146}: Fix memory leak in @ref{301,,subprocess.Popen()} in case an uid
(gid) specified in @code{user} (@code{group}, @code{extra_groups}) overflows
@code{uid_t} (@code{gid_t}).

@item 
bpo-42103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42103}: @code{InvalidFileException} and @ref{df1,,RecursionError}
are now the only errors caused by loading malformed binary Plist file
(previously ValueError and TypeError could be raised in some specific
cases).

@item 
bpo-41490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41490}: In @code{importlib.resources}, @code{.path} method is more aggressive
about releasing handles to zipfile objects early, enabling use-cases like
certifi to leave the context open but delete the underlying zip file.

@item 
bpo-41052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41052}: Pickling heap types implemented in C with protocols 0 and 1
raises now an error instead of producing incorrect data.

@item 
bpo-42089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42089}: In @code{importlib.metadata.PackageNotFoundError}, make reference
to the package metadata being missing to improve the user experience.

@item 
bpo-41491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41491}: plistlib: fix parsing XML plists with hexadecimal integer
values

@item 
bpo-42065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42065}: Fix an incorrectly formatted error from
@code{_codecs.charmap_decode()} when called with a mapped value outside
the range of valid Unicode code points. PR by Max Bernstein.

@item 
bpo-41966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41966}: Fix pickling pure Python @ref{331,,datetime.time} subclasses.
Patch by Dean Inwood.

@item 
bpo-19270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19270}: @ref{1939,,sched.scheduler.cancel()} will now cancel the correct
event, if two events with same priority are scheduled for the same time.
Patch by Bar Harel.

@item 
bpo-28660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28660}: @ref{1503,,textwrap.wrap()} now attempts to break long words after
hyphens when @code{break_long_words=True} and @code{break_on_hyphens=True}.

@item 
bpo-35823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35823}: Use @code{vfork()} instead of @code{fork()} for
@ref{301,,subprocess.Popen()} on Linux to improve performance in cases where it
is deemed safe.

@item 
bpo-42043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42043}: Add support for @code{zipfile.Path} inheritance.
@code{zipfile.Path.is_file()} now returns False for non-existent names.
@code{zipfile.Path} objects now expose a @code{.filename} attribute and rely on
that to resolve @code{.name} and @code{.parent} when the @code{Path} object is at
the root of the zipfile.

@item 
bpo-42021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42021}: Fix possible ref leaks in @ref{cf,,sqlite3} module init.

@item 
bpo-39101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39101}: Fixed tests using IsolatedAsyncioTestCase from hanging on
BaseExceptions.

@item 
bpo-41976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41976}: Fixed a bug that was causing @ref{dd0,,ctypes.util.find_library()}
to return @code{None} when triying to locate a library in an environment when
gcc>=9 is available and @code{ldconfig} is not. Patch by Pablo Galindo

@item 
bpo-41943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41943}: Fix bug where TestCase.assertLogs doesn’t correctly filter
messages by level.

@item 
bpo-41923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41923}: Implement 
@geindex Python Enhancement Proposals; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}, introducing @ref{862,,typing.TypeAlias}
annotation.

@item 
bpo-41905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41905}: A new function in abc: `update_abstractmethods' to re-calculate
an abstract class’s abstract status. In addition, `dataclass' has been
changed to call this function.

@item 
bpo-23706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23706}: Added `newline' parameter to @code{pathlib.Path.write_text()}.

@item 
bpo-41876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41876}: Tkinter font class repr uses font name

@item 
bpo-41831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41831}: @code{str()} for the @code{type} attribute of the @code{tkinter.Event}
object always returns now the numeric code returned by Tk instead of the
name of the event type.

@item 
bpo-39337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39337}: @code{encodings.normalize_encoding()} now ignores non-ASCII
characters.

@item 
bpo-41747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41747}: Ensure all methods that generated from
@ref{32e,,dataclasses.dataclass()} objects now have the proper @code{__qualname__}
attribute referring to the class they belong to. Patch by Batuhan Taskaya.

@item 
bpo-30681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30681}: Handle exceptions caused by unparsable date headers when using
email «default» policy.  Patch by Tim Bell, Georges Toth

@item 
bpo-41586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41586}: Add F_SETPIPE_SZ and F_GETPIPE_SZ to fcntl module. Allow
setting pipesize on subprocess.Popen.

@item 
bpo-41229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41229}: Add @code{contextlib.aclosing} for deterministic cleanup of async
generators which is analogous to @code{contextlib.closing} for non-async
generators. Patch by Joongi Kim and John Belmonte.

@item 
bpo-16396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16396}: Allow @code{ctypes.wintypes} to be imported on non-Windows
systems.

@item 
bpo-4356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4356}: Add a key function to the bisect module.

@item 
bpo-40592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40592}: @ref{55b,,shutil.which()} now ignores empty entries in
@geindex PATHEXT
@geindex variables de entorno; PATHEXT
@code{PATHEXT} instead of treating them as a match.

@item 
bpo-40492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40492}: Fix @code{--outfile} for @ref{28,,cProfile} / @ref{af,,profile} not
writing the output file in the original directory when the program being
profiled changes the working directory.  PR by Anthony Sottile.

@item 
bpo-34204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34204}: The @ref{c3,,shelve} module now uses
@ref{8c5,,pickle.DEFAULT_PROTOCOL} by default instead of @ref{a6,,pickle}
protocol @code{3}.

@item 
bpo-27321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27321}: Fixed KeyError exception when flattening an email to a string
attempts to replace a non-existent Content-Transfer-Encoding header.

@item 
bpo-38976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38976}: The @ref{70,,http.cookiejar} module now supports the parsing of
cookies in CURL-style cookiejar files through MozillaCookieJar on all
platforms. Previously, such cookie entries would be silently ignored when
loading a cookiejar with such entries.

Additionally, the HTTP Only attribute is persisted in the object, and will
be correctly written to file if the MozillaCookieJar object is
subsequently dumped.
@end itemize

@node Documentation<31>,Tests<31>,Library<32>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id288}@anchor{193a}
@subsubsection Documentation



@itemize -

@item 
bpo-42061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42061}: Document __format__ functionality for IP addresses.

@item 
bpo-41910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41910}: Document the default implementation of @code{object.__eq__}.

@item 
bpo-42010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42010}: Clarify that subscription expressions are also valid for
certain @ref{193b,,classes} and @ref{193c,,types} in the standard
library, and for user-defined classes and types if the classmethod
@code{__class_getitem__()} is provided.

@item 
bpo-41805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41805}: Documented @ref{753,,generic alias type} and
@ref{882,,types.GenericAlias}. Also added an entry in glossary for
@ref{157,,generic types}.

@item 
bpo-39693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39693}: Fix tarfile’s extractfile documentation

@item 
bpo-39416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39416}: Document some restrictions on the default string
representations of numeric classes.
@end itemize

@node Tests<31>,Build<32>,Documentation<31>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id289}@anchor{193d}
@subsubsection Tests



@itemize -

@item 
bpo-41739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41739}: Fix test_logging.test_race_between_set_target_and_flush(): the
test now waits until all threads complete to avoid leaking running
threads.

@item 
bpo-41970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41970}: Avoid a test failure in @code{test_lib2to3} if the module has
already imported at the time the test executes. Patch by Pablo Galindo.

@item 
bpo-41944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41944}: Tests for CJK codecs no longer call @code{eval()} on content
received via HTTP.

@item 
bpo-41306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41306}: Fixed a failure in @code{test_tk.test_widgets.ScaleTest} happening
when executing the test with Tk 8.6.10.
@end itemize

@node Build<32>,Windows<31>,Tests<31>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id290}@anchor{193e}
@subsubsection Build



@itemize -

@item 
bpo-38980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38980}: Add @code{-fno-semantic-interposition} to both the compile and
link line when building with @code{--enable-optimizations}. Patch by Victor
Stinner and Pablo Galindo.
@end itemize

@node Windows<31>,macOS<26>,Build<32>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id291}@anchor{193f}
@subsubsection Windows



@itemize -

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: Updates the icons for IDLE in the Windows Store package.

@item 
bpo-38252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38252}: Use 8-byte step to detect ASCII sequence in 64-bit Windows
build.

@item 
bpo-39107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39107}: Update Tcl and Tk to 8.6.10 in Windows installer.

@item 
bpo-41557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41557}: Update Windows installer to use SQLite 3.33.0.

@item 
bpo-38324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38324}: Avoid Unicode errors when accessing certain locale data on
Windows.
@end itemize

@node macOS<26>,IDLE<21>,Windows<31>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id292}@anchor{1940}
@subsubsection macOS



@itemize -

@item 
bpo-41471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41471}: Ignore invalid prefix lengths in system proxy excludes.
@end itemize

@node IDLE<21>,C API<31>,macOS<26>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id293}@anchor{1941}
@subsubsection IDLE



@itemize -

@item 
bpo-33987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33987}: Mostly finish using ttk widgets, mainly for editor, settings,
and searches. Some patches by Mark Roseman.

@item 
bpo-40511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40511}: Typing opening and closing parentheses inside the parentheses
of a function call will no longer cause unnecessary «flashing» off and on
of an existing open call-tip, e.g. when typed in a string literal.

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: Add a 256×256 pixel IDLE icon to the Windows .ico file. Created
by Andrew Clover. Remove the low-color gif variations from the .ico file.
@end itemize

@node C API<31>,,IDLE<21>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id294}@anchor{1942}
@subsubsection C API



@itemize -

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: The private @code{_PyUnicode_Name_CAPI} structure of the PyCapsule
API @code{unicodedata.ucnhash_CAPI} has been moved to the internal C API.
Patch by Victor Stinner.

@item 
bpo-42015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42015}: Fix potential crash in deallocating method objects when
dynamically allocated @ref{1517,,PyMethodDef}’s lifetime is managed through
the @code{self} argument of a @ref{14b3,,PyCFunction}.

@item 
bpo-40423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40423}: The @ref{d6,,subprocess} module and @code{os.closerange} will now use
the @code{close_range(low, high, flags)} syscall when it is available for
more efficient closing of ranges of descriptors.

@item 
bpo-41845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41845}: @ref{1943,,PyObject_GenericGetDict()} is available again in the
limited API when targeting 3.10 or later.

@item 
bpo-40422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40422}: Add @code{_Py_closerange} function to provide performant closing
of a range of file descriptors.

@item 
bpo-41986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41986}: @code{Py_FileSystemDefaultEncodeErrors} and
@code{Py_UTF8Mode} are available again in limited API.

@item 
bpo-41756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41756}: Add @code{PyIter_Send} function to allow sending value into
generator/coroutine/iterator without raising StopIteration exception to
signal return.

@item 
bpo-41784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41784}: Added @code{PyUnicode_AsUTF8AndSize} to the limited C API.
@end itemize

@node Python 3 10 0 alpha 1,Python 3 9 0 beta 1,Python 3 10 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-10-0-alpha-1}@anchor{1944}
@subsection Python 3.10.0 alpha 1


`Release date: 2020-10-05'

@menu
* Security: Security<22>. 
* Core and Builtins: Core and Builtins<33>. 
* Library: Library<33>. 
* Documentation: Documentation<32>. 
* Tests: Tests<32>. 
* Build: Build<33>. 
* Windows: Windows<32>. 
* macOS: macOS<27>. 
* IDLE: IDLE<22>. 
* C API: C API<32>. 

@end menu

@node Security<22>,Core and Builtins<33>,,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id295}@anchor{1945}
@subsubsection Security



@itemize -

@item 
bpo-41304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41304}: Fixes @code{python3x._pth} being ignored on Windows, caused by the
fix for bpo-29778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29778} (
@geindex Common Vulnerabilities and Exposures; CVE 2020-15801
CVE 2020-15801@footnote{https://www.cve.org/CVERecord?id=CVE-2020-15801}).

@item 
bpo-41162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41162}: Audit hooks are now cleared later during finalization to avoid
missing events.

@item 
bpo-29778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29778}: Ensure @code{python3.dll} is loaded from correct locations
when Python is embedded (
@geindex Common Vulnerabilities and Exposures; CVE 2020-15523
CVE 2020-15523@footnote{https://www.cve.org/CVERecord?id=CVE-2020-15523}).

@item 
bpo-41004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41004}: The __hash__() methods of  ipaddress.IPv4Interface and
ipaddress.IPv6Interface incorrectly generated constant hash values of 32
and 128 respectively. This resulted in always causing hash collisions. The
fix uses hash() to generate hash values for the tuple of (address, mask
length, network address).

@item 
bpo-39603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39603}: Prevent http header injection by rejecting control characters
in http.client.putrequest(…).
@end itemize

@node Core and Builtins<33>,Library<33>,Security<22>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id296}@anchor{1946}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-41909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41909}: Fixed stack overflow in @ref{85a,,issubclass()} and
@ref{4ef,,isinstance()} when getting the @code{__bases__} attribute leads to
infinite recursion.

@item 
bpo-41922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41922}: Speed up calls to @code{reversed()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-41873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41873}: Calls to @code{float()} are now faster due to the @code{vectorcall}
calling convention. Patch by Dennis Sweeney.

@item 
bpo-41870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41870}: Speed up calls to @code{bool()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_bisect} module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39934}: Correctly count control blocks in “except” in compiler. Ensures
that a syntax error, rather a fatal error, occurs for deeply nested, named
exception handlers.

@item 
bpo-41780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41780}: Fix @code{__dir__()} of @ref{882,,types.GenericAlias}. Patch by
Batuhan Taskaya.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_lsprof} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @ref{19,,cmath} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_scproxy} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @ref{e1,,termios} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Convert the @code{_sha256} extension module types to heap
types.

@item 
bpo-41690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41690}: Fix a possible stack overflow in the parser when parsing
functions and classes with a huge amount of arguments. Patch by Pablo
Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_overlapped} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_curses_panel} extension module to
multi-phase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_opcode} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-41681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41681}: Fixes the wrong error description in the error raised by using
2 @code{,} in format string in f-string and @ref{6c2,,str.format()}.

@item 
bpo-41675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41675}: The implementation of @ref{11a7,,signal.siginterrupt()} now uses
@code{sigaction()} (if it is available in the system) instead of the
deprecated @code{siginterrupt()}. Patch by Pablo Galindo.

@item 
bpo-41670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41670}: Prevent line trace being skipped on platforms not compiled with
@code{USE_COMPUTED_GOTOS}. Fixes issue where some lines nested within a
try-except block were not being traced on Windows.

@item 
bpo-41654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41654}: Fix a crash that occurred when destroying subclasses of
@ref{16cb,,MemoryError}. Patch by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @ref{132,,zlib} extension module to multi-phase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-41631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41631}: The @code{_ast} module uses again a global state. Using a module
state per module instance is causing subtle practical problems. For
example, the Mercurial project replaces the @code{__import__()} function to
implement lazy import, whereas Python expected that @code{import _ast} always
return a fully initialized @code{_ast} module.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @code{_operator} to use @ref{621,,PyType_FromSpec()}.

@item 
bpo-1653741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1653741}: Port @code{_sha3} to multi-phase init.  Convert static types
to heap types.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_blake2} extension module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-41533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41533}: Free the stack allocated in @code{va_build_stack} if
@code{do_mkstack} fails and the stack is not a @code{small_stack}.

@item 
bpo-41531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41531}: Fix a bug that was dropping keys when compiling dict literals
with more than 0xFFFF elements. Patch by Pablo Galindo.

@item 
bpo-41525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41525}: The output of @code{python --help} contains now only ASCII
characters.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_sha1}, @code{_sha512}, and @code{_md5}
extension modules to multi-phase initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-41431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41431}: Optimize @code{dict_merge()} for copying dict (e.g. @code{dict(d)}
and @code{@{@}.update(d)}).

@item 
bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}: Implement PEP 604. This supports (int | str) etc. in place of
Union[str, int].

@item 
bpo-41340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41340}: Removed fallback implementation for @code{strdup}.

@item 
bpo-38156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38156}: Handle interrupts that come after EOF correctly in
@code{PyOS_StdioReadline}.

@item 
bpo-41342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41342}: @ref{1342,,round()} with integer argument is now faster (9–60%).

@item 
bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334}: Constructors @ref{237,,str()}, @ref{325,,bytes()} and @ref{5e0,,bytearray()}
are now faster (around 30–40% for small objects).

@item 
bpo-41295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41295}: Resolve a regression in CPython 3.8.4 where defining
«__setattr__» in a multi-inheritance setup and calling up the hierarchy
chain could fail if builtins/extension types were involved in the base
types.

@item 
bpo-41323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41323}: Bytecode optimizations are performed directly on the control
flow graph. This will result in slightly more compact code objects in some
circumstances.

@item 
bpo-41247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41247}: Always cache the running loop holder when running
@code{asyncio.set_running_loop}.

@item 
bpo-41252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41252}: Fix incorrect refcounting in _ssl.c’s
@code{_servername_callback()}.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{94,,multiprocessing} to multi-phase initialization

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{winapi} to multiphase initialization

@item 
bpo-41215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41215}: Use non-NULL default values in the PEG parser keyword list to
overcome a bug that was preventing Python from being properly compiled
when using the XLC compiler. Patch by Pablo Galindo.

@item 
bpo-41218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41218}: Python 3.8.3 had a regression where compiling with
ast.PyCF_ALLOW_TOP_LEVEL_AWAIT would aggressively mark list comprehension
with CO_COROUTINE. Now only list comprehension making use of async/await
will tagged as so.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{58,,faulthandler} to multiphase initialization.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{sha256} to multiphase initialization

@item 
bpo-41175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41175}: Guard against a NULL pointer dereference within bytearrayobject
triggered by the @code{bytearray() + bytearray()} operation.

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: add arm64 to the allowable Mac OS arches in mpdecimal.h

@item 
bpo-41094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41094}: Fix decoding errors with audit when open files with non-ASCII
names on non-UTF-8 locale.

@item 
bpo-39960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39960}: The «hackcheck» that prevents sneaking around a type’s
__setattr__() by calling the superclass method was rewritten to allow C
implemented heap types.

@item 
bpo-41084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41084}: Prefix the error message with “f-string: “, when parsing an
f-string expression which throws a @ref{150,,SyntaxError}.

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: Empty frozensets are no longer singletons.

@item 
bpo-41076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41076}: Pre-feed the parser with the location of the f-string
expression, not the f-string itself, which allows us to skip the shifting
of the AST node locations after the parsing is completed.

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: Fixes a reference to deallocated stack space during startup
when constructing sys.path involving a relative symlink when code was
supplied via -c.  (discovered via Coverity)

@item 
bpo-41061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41061}: Fix incorrect expressions and asserts in hashtable code and
tests.

@item 
bpo-41052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41052}: Opt out serialization/deserialization for _random.Random

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: Rename @code{PyPegen*} functions to @code{PyParser*}, so that we can
remove the old set of @code{PyParser*} functions that were using the old
parser, but keep everything backwards-compatible.

@item 
bpo-35975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35975}: Stefan Behnel reported that cf_feature_version is used even
when PyCF_ONLY_AST is not set. This is against the intention and against
the documented behavior, so it’s been fixed.

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: Remove the remaining files from the old parser and the
@code{symbol} module.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @code{_bz2} to use @ref{621,,PyType_FromSpec()}.

@item 
bpo-41006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41006}: The @code{encodings.latin_1} module is no longer imported at
startup. Now it is only imported when it is the filesystem encoding or the
stdio encoding.

@item 
bpo-40636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40636}: @ref{14d,,zip()} now supports 
@geindex Python Enhancement Proposals; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}’s @code{strict} parameter,
which raises a @ref{360,,ValueError} if the arguments are exhausted at
different lengths. Patch by Brandt Bucher.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{_gdbm} to multiphase initialization.

@item 
bpo-40985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40985}: Fix a bug that caused the @ref{150,,SyntaxError} text to be empty
when a file ends with a line ending in a line continuation character (i.e.
backslash). The error text should contain the text of the last line.

@item 
bpo-40958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40958}: Fix a possible buffer overflow in the PEG parser when gathering
information for emitting syntax errors. Patch by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{_dbm} to multiphase initialization.

@item 
bpo-40957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40957}: Fix refleak in _Py_fopen_obj() when PySys_Audit() fails

@item 
bpo-40950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40950}: Add a state to the @code{nis} module (
@geindex Python Enhancement Proposals; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}) and apply
the multiphase initialization. Patch by Donghee Na.

@item 
bpo-40947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40947}: The Python @ref{944,,Path Configuration} now
takes @ref{1947,,PyConfig.platlibdir} in account.

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: Remove the old parser, the @code{parser} module and all
associated support code, command-line options and environment variables.
Patch by Pablo Galindo.

@item 
bpo-40847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40847}: Fix a bug where a line with only a line continuation character
is not considered a blank line at tokenizer level. In such cases, more
than a single @code{NEWLINE} token was emitted. The old parser was working
around the issue, but the new parser threw a @ref{150,,SyntaxError} for valid
input due to this. For example, an empty line following a line
continuation character was interpreted as a @ref{150,,SyntaxError}.

@item 
bpo-40890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40890}: Each dictionary view now has a @code{mapping} attribute that
provides a @ref{518,,types.MappingProxyType} wrapping the original
dictionary.  Patch contributed by Dennis Sweeney.

@item 
bpo-40889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40889}: Improved the performance of symmetric difference operations on
dictionary item views.  Patch by Dennis Sweeney.

@item 
bpo-40904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40904}: Fix possible segfault in the new PEG parser when parsing
f-string containing yield statements with no value (@code{f"@{yield@}"}).
Patch by Pablo Galindo

@item 
bpo-40903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40903}: Fixed a possible segfault in the new PEG parser when producing
error messages for invalid assignments of the form @code{p=p=}. Patch by
Pablo Galindo

@item 
bpo-40880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40880}: Fix invalid memory read in the new parser when checking
newlines in string literals. Patch by Pablo Galindo.

@item 
bpo-40883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40883}: Fix memory leak in when parsing f-strings in the new parser.
Patch by Pablo Galindo

@item 
bpo-40870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40870}: Raise @ref{360,,ValueError} when validating custom AST’s where the
constants @code{True}, @code{False} and @code{None} are used within a
@ref{1948,,ast.Name} node.

@item 
bpo-40854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40854}: Allow overriding @ref{9cb,,sys.platlibdir} via a new
@geindex PYTHONPLATLIBDIR
@geindex variables de entorno; PYTHONPLATLIBDIR
@ref{1949,,PYTHONPLATLIBDIR} environment variable.

@item 
bpo-40826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40826}: Fix GIL usage in @code{PyOS_Readline()}: lock the GIL to set
an exception and pass the Python thread state when checking if there is a
pending signal.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{59,,fcntl} to multiphase initialization.

@item 
bpo-19468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19468}: Delete unnecessary instance check in importlib.reload(). Patch
by Furkan Önder.

@item 
bpo-40824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40824}: Unexpected errors in calling the @code{__iter__} method are no
longer masked by @code{TypeError} in the @ref{1ed,,in} operator and functions
@ref{971,,contains()}, @ref{972,,indexOf()} and
@ref{973,,countOf()} of the @ref{9f,,operator} module.

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: Attributes @code{start}, @code{stop} and @code{step} of the
@ref{9d6,,range} object now always has exact type @ref{1f0,,int}.  Previously,
they could have been an instance of a subclass of @code{int}.

@item 
bpo-40780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40780}: Fix a corner case where g-style string formatting of a float
failed to remove trailing zeros.

@item 
bpo-38964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38964}: When there’s a @ref{150,,SyntaxError} in the expression part of an
fstring, the filename attribute of the @ref{150,,SyntaxError} gets correctly
set to the name of the file the fstring resides in.

@item 
bpo-40750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40750}: Support the «-d» debug flag in the new PEG parser. Patch by
Pablo Galindo

@item 
bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217}: Instances of types created with
@ref{622,,PyType_FromSpecWithBases()} will no longer automatically visit
their class object when traversing references in the garbage collector.
The user is expected to manually visit the object’s class. Patch by Pablo
Galindo.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: @ref{26e,,Py_TYPE()} is changed to the inline static function.
Patch by Donghee Na.

@item 
bpo-40696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40696}: Fix a hang that can arise after @ref{59d,,generator.throw()} due to
a cycle in the exception context chain.

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: Each interpreter now its has own free lists, singletons and
caches:


@itemize *

@item 
Free lists: float, tuple, list, dict, frame, context,
asynchronous generator, MemoryError.

@item 
Singletons: empty tuple, empty bytes string, empty Unicode string,
single byte character, single Unicode (latin1) character.

@item 
Slice cache.
@end itemize

They are no longer shared by all interpreters.

@item 
bpo-40679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40679}: Certain @ref{228,,TypeError} messages about missing or extra
arguments now include the function’s @ref{194a,,qualified name}.  Patch by
Dennis Sweeney.

@item 
bpo-29590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29590}: Make the stack trace correct after calling
@ref{59d,,generator.throw()} on a generator that has yielded from a @code{yield
from}.

@item 
bpo-4022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4022}: Improve performance of generators by not raising internal
StopIteration.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{90,,mmap} to multiphase initialization.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{_lzma} to multiphase initialization.

@item 
bpo-37999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37999}: Builtin and extension functions that take integer arguments no
longer accept @ref{16a,,Decimal}s, @ref{177,,Fraction}s and other objects that can be converted to integers only with a loss
(e.g. that have the @ref{22a,,__int__()} method but do not have the
@ref{22b,,__index__()} method).

@item 
bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882}: Add @ref{865,,int.bit_count()}, counting the number of ones in the
binary representation of an integer. Patch by Niklas Fiekas.

@item 
bpo-36982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36982}: Use ncurses extended color functions when available to support
terminals with 256 colors, and add the new function
@ref{88c,,curses.has_extended_color_support()} to indicate whether extended
color support is provided by the underlying ncurses library.

@item 
bpo-19569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19569}: Add the private macros @code{_Py_COMP_DIAG_PUSH},
@code{_Py_COMP_DIAG_IGNORE_DEPR_DECLS}, and @code{_Py_COMP_DIAG_POP}.

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: The int type now supports the x.is_integer() method for
compatibility with float.
@end itemize

@node Library<33>,Documentation<32>,Core and Builtins<33>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id297}@anchor{194b}
@subsubsection Library



@itemize -

@item 
bpo-41900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41900}: C14N 2.0 serialisation in xml.etree.ElementTree failed for
unprefixed attributes when a default namespace was defined.

@item 
bpo-41887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41887}: Strip leading spaces and tabs on @ref{ca0,,ast.literal_eval()}. Also
document stripping of spaces and tabs for @ref{2eb,,eval()}.

@item 
bpo-41773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41773}: Note in documentation that @ref{d4d,,random.choices()} doesn’t
support non-finite weights, raise @ref{360,,ValueError} when given non-finite
weights.

@item 
bpo-41840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41840}: Fix a bug in the @ref{d8,,symtable} module that was causing
module-scope global variables to not be reported as both local and global.
Patch by Pablo Galindo.

@item 
bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}: Add @ref{87f,,codecs.unregister()} function to unregister a codec
search function.

@item 
bpo-40564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40564}: In @code{zipfile.Path}, mutate the passed ZipFile object type
instead of making a copy. Prevents issues when both the local copy and the
caller’s copy attempt to close the same file handle.

@item 
bpo-40670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40670}: More reliable validation of statements in
@ref{1504,,timeit.Timer}. It now accepts «empty» statements (only whitespaces
and comments) and rejects misindentent statements.

@item 
bpo-41833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41833}: The @ref{9df,,threading.Thread} constructor now uses the target
name if the `target' argument is specified but the `name' argument is
omitted.

@item 
bpo-41817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41817}: fix @code{tkinter.EventType} Enum so all members are strings, and
none are tuples

@item 
bpo-41810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41810}: @ref{8e8,,types.EllipsisType}, @ref{8ea,,types.NotImplementedType}
and @ref{8e9,,types.NoneType} have been reintroduced, providing a new set of
types readily interpretable by static type checkers.

@item 
bpo-41815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41815}: Fix SQLite3 segfault when backing up closed database. Patch
contributed by Peter David McCormick.

@item 
bpo-41816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41816}: StrEnum added: it ensures that all members are already strings
or string candidates

@item 
bpo-41517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41517}: fix bug allowing Enums to be extended via multiple inheritance

@item 
bpo-39587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39587}: use the correct mix-in data type when constructing Enums

@item 
bpo-41792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41792}: Add is_typeddict function to typing.py to check if a type is a
TypedDict class

Previously there was no way to check that without using private API. See
the relevant issue in python/typing@footnote{https://github.com/python/typing/issues/751}.

@item 
bpo-41789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41789}: Honor @code{object} overrides in @code{Enum} class creation
(specifically, @code{__str__}, @code{__repr__}, @code{__format__}, and
@code{__reduce_ex__}).

@item 
bpo-32218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32218}: @code{enum.Flag} and @code{enum.IntFlag} members are now iterable.

@item 
bpo-39651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39651}: Fix a race condition in the @code{call_soon_threadsafe()} method
of @code{asyncio.ProactorEventLoop}: do nothing if the self-pipe socket has
been closed.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{mashal} extension module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_string} extension module to the multi-phase
initialization API (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-41732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41732}: Added an @ref{313,,iterator} to @ref{156,,memoryview}.

@item 
bpo-41720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41720}: Fixed @code{turtle.Vec2D.__rmul__()} for arguments which are not
int or float.

@item 
bpo-41696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41696}: Fix handling of debug mode in @ref{525,,asyncio.run()}. This allows
setting @code{PYTHONASYNCIODEBUG} or @code{-X dev} to enable asyncio debug mode
when using @ref{525,,asyncio.run()}.

@item 
bpo-41687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41687}: Fix implementation of sendfile to be compatible with Solaris.

@item 
bpo-41662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41662}: No longer override exceptions raised in @code{__len__()} of a
sequence of parameters in @ref{cf,,sqlite3} with
@ref{223,,ProgrammingError}.

@item 
bpo-39010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39010}: Restarting a @code{ProactorEventLoop} on Windows no longer logs
spurious @code{ConnectionResetErrors}.

@item 
bpo-41638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41638}: @ref{223,,ProgrammingError} message for absent parameter
in @ref{cf,,sqlite3} contains now the name of the parameter instead of its
index when parameters are supplied as a dict.

@item 
bpo-41662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41662}: Fixed crash when mutate list of parameters during iteration in
@ref{cf,,sqlite3}.

@item 
bpo-41513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41513}: Improved the accuracy of math.hypot().  Internally, each step
is computed with extra precision so that the result is now almost always
correctly rounded.

@item 
bpo-41609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41609}: The pdb whatis command correctly reports instance methods as
“Method” rather than “Function”.

@item 
bpo-39994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39994}: Fixed pprint’s handling of dict subclasses that override
__repr__.

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: When cancelling the task due to a timeout,
@ref{6a0,,asyncio.wait_for()} will now wait until the cancellation is complete
also in the case when `timeout' is <= 0, like it does with positive
timeouts.

@item 
bpo-37658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37658}: @ref{6a0,,asyncio.wait_for()} now properly handles races between
cancellation of itself and the completion of the wrapped awaitable.

@item 
bpo-40782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40782}: Change the method asyncio.AbstractEventLoop.run_in_executor to
not be a coroutine.

@item 
bpo-41520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41520}: Fix @ref{1d,,codeop} regression that prevented turning compile
warnings into errors.

@item 
bpo-41528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41528}: turtle uses math module functions to convert degrees to radians
and vice versa and to calculate vector norm

@item 
bpo-41513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41513}: Minor algorithmic improvement to math.hypot() and math.dist()
giving small gains in speed and accuracy.

@item 
bpo-41503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41503}: Fixed a race between setTarget and flush in
logging.handlers.MemoryHandler.

@item 
bpo-41497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41497}: Fix potential UnicodeDecodeError in dis module.

@item 
bpo-41467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41467}: On Windows, fix asyncio @code{recv_into()} return value when the
socket/pipe is closed (@ref{10d8,,BrokenPipeError}): return @code{0} rather than
an empty byte string (@code{b'@w{'}}).

@item 
bpo-41425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41425}: Make tkinter doc example runnable.

@item 
bpo-41421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41421}: Make an algebraic simplification to random.paretovariate().  It
now is slightly less subject to round-off error and is slightly faster.
Inputs that used to cause ZeroDivisionError now cause an OverflowError
instead.

@item 
bpo-41440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41440}: Add @ref{328,,os.cpu_count()} support for VxWorks RTOS.

@item 
bpo-41316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41316}: Fix the @ref{de,,tarfile} module to write only basename of TAR
file to GZIP compression header.

@item 
bpo-41384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41384}: Raise TclError instead of TypeError when an unknown option is
passed to tkinter.OptionMenu.

@item 
bpo-41317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41317}: Use add_done_callback() in asyncio.loop.sock_accept() to
unsubscribe reader early on cancellation.

@item 
bpo-41364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41364}: Reduce import overhead of @ref{110,,uuid}.

@item 
bpo-35328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35328}: Set the environment variable @code{VIRTUAL_ENV_PROMPT} at
@ref{111,,venv} activation.

@item 
bpo-41341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41341}: Recursive evaluation of @code{typing.ForwardRef} in
@code{get_type_hints}.

@item 
bpo-41344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41344}: Prevent creating @code{shared_memory.SharedMemory} objects
with @code{size=0}.

@item 
bpo-41333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41333}: @code{collections.OrderedDict.pop()} is now 2 times faster.

@item 
bpo-41288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41288}: Unpickling invalid NEWOBJ_EX opcode with the C implementation
raises now UnpicklingError instead of crashing.

@item 
bpo-39017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39017}: Avoid infinite loop when reading specially crafted TAR files
using the tarfile module (
@geindex Common Vulnerabilities and Exposures; CVE 2019-20907
CVE 2019-20907@footnote{https://www.cve.org/CVERecord?id=CVE-2019-20907}).

@item 
bpo-41273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41273}: Speed up any transport using @code{_ProactorReadPipeTransport} by
calling @code{recv_into} instead of @code{recv}, thus not creating a new buffer
for each @code{recv} call in the transport’s read loop.

@item 
bpo-41235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41235}: Fix the error handling in
@ref{194c,,ssl.SSLContext.load_dh_params()}.

@item 
bpo-41207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41207}: In distutils.spawn, restore expectation that DistutilsExecError
is raised when the command is not found.

@item 
bpo-29727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29727}: Register @ref{308,,array.array} as a
@ref{309,,MutableSequence}. Patch by Pablo Galindo.

@item 
bpo-39168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39168}: Remove the @code{__new__} method of @ref{15f6,,typing.Generic}.

@item 
bpo-41194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41194}: Fix a crash in the @code{_ast} module: it can no longer be loaded
more than once. It now uses a global state rather than a module state.

@item 
bpo-41195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41195}: Add read-only ssl.SSLContext.security_level attribute to
retrieve the context’s security level.

@item 
bpo-41193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41193}: The @code{write_history()} atexit function of the readline
completer now ignores any @ref{4d5,,OSError} to ignore error if the filesystem
is read-only, instead of only ignoring @ref{f46,,FileNotFoundError} and
@ref{dc9,,PermissionError}.

@item 
bpo-41182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41182}: selector: use DefaultSelector based upon implementation

@item 
bpo-41161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41161}: The decimal module now requires libmpdec-2.5.0. Users of
–with-system-libmpdec should update their system library.

@item 
bpo-40874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40874}: The decimal module now requires libmpdec-2.5.0.

@item 
bpo-41138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41138}: Fixed the @ref{fd,,trace} module CLI for Python source files with
non-UTF-8 encoding.

@item 
bpo-31082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31082}: Use the term «iterable» in the docstring for
@ref{17d,,functools.reduce()}.

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: Remove freelist from collections.deque().

@item 
bpo-31938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31938}: Fix default-value signatures of several functions in the
@ref{c1,,select} module - by Anthony Sottile.

@item 
bpo-41068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41068}: Fixed reading files with non-ASCII names from ZIP archive
directly after writing them.

@item 
bpo-41058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41058}: @code{pdb.find_function()} now correctly determines the source
file encoding.

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: Invalid file descriptor values are now prevented from being
passed to os.fpathconf. (discovered by Coverity)

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: Fix a NULL pointer dereference within the ssl module during a
MemoryError in the keylog callback. (discovered by Coverity)

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: Fixed an instance where a MemoryError within the zoneinfo
module might not be reported or not reported at its source. (found by
Coverity)

@item 
bpo-41048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41048}: @ref{194d,,mimetypes.read_mime_types()} function reads the rule file
using UTF-8 encoding, not the locale encoding. Patch by Srinivas Reddy
Thatiparthy.

@item 
bpo-41043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41043}: Fixed the use of @ref{3ef,,glob()} in the stdlib: literal part
of the path is now always correctly escaped.

@item 
bpo-41025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41025}: Fixed an issue preventing the C implementation of
@ref{976,,zoneinfo.ZoneInfo} from being subclassed.

@item 
bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018}: Add the @ref{8f3,,xml.sax.handler.LexicalHandler} class that is
present in other SAX XML implementations.

@item 
bpo-41002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41002}: Improve performance of HTTPResponse.read with a given amount.
Patch by Bruce Merry.

@item 
bpo-40448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40448}: @ref{55,,ensurepip} now disables the use of @code{pip} cache when
installing the bundled versions of @code{pip} and @code{setuptools}.  Patch by
Krzysztof Konopko.

@item 
bpo-40967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40967}: Removed @code{asyncio.Task.current_task()} and
@code{asyncio.Task.all_tasks()}. Patch contributed by Rémi Lapeyre.

@item 
bpo-40924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40924}: Ensure @code{importlib.resources.path} returns an extant path for
the SourceFileLoader’s resource reader. Avoids the regression identified
in master while a long-term solution is devised.

@item 
bpo-40955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40955}: Fix a minor memory leak in @ref{d6,,subprocess} module when
extra_groups was specified.

@item 
bpo-40855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40855}: The standard deviation and variance functions in the statistics
module were ignoring their mu and xbar arguments.

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: Use the new PEG parser when generating the stdlib
@ref{84,,keyword} module.

@item 
bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}: Add @ref{8d7,,sys.orig_argv} attribute: the list of the original
command line arguments passed to the Python executable.

@item 
bpo-33689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33689}: Ignore empty or whitespace-only lines in .pth files. This
matches the documentated behavior. Before, empty lines caused the
site-packages dir to appear multiple times in sys.path. By Ido Michael,
contributors Malcolm Smith and Tal Einat.

@item 
bpo-40884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40884}: Added a @code{defaults} parameter to @ref{14d1,,logging.Formatter},
to allow specifying default values for custom fields. Patch by Asaf Alon
and Bar Harel.

@item 
bpo-40876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40876}: Clarify error message in the @ref{2a,,csv} module.

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: Refresh importlib.metadata from importlib_metadata 1.6.1.

@item 
bpo-40807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40807}: Stop codeop._maybe_compile, used by code.InteractiveInterpreter
(and IDLE). from emitting each warning three times.

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: Fix reference leak in the @ref{c1,,select} module when the module
is imported in a subinterpreter.

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: Built-in loaders (SourceFileLoader and ZipImporter) now supply
@code{TraversableResources} implementations for @code{ResourceReader}, and the
fallback function has been removed.

@item 
bpo-39314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39314}: @ref{194e,,rlcompleter.Completer} and the standard Python shell
now close the parenthesis for functions that take no arguments. Patch
contributed by Rémi Lapeyre.

@item 
bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}: The topological sort functionality that was introduced
initially in the @ref{5f,,functools} module has been moved to a new
@ref{65,,graphlib} module to better accommodate the new tools and keep the
original scope of the @ref{5f,,functools} module. Patch by Pablo Galindo

@item 
bpo-40834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40834}: Fix truncate when sending str object
with_xxsubinterpreters.channel_send.

@item 
bpo-40755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40755}: Add rich comparisons to collections.Counter().

@item 
bpo-26407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26407}: Unexpected errors in calling the @code{__iter__} method are no
longer masked by @code{TypeError} in @ref{52f,,csv.reader()},
@code{csv.writer.writerow()} and @code{csv.writer.writerows()}.

@item 
bpo-39384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39384}: Fixed email.contentmanager to allow set_content() to set a null
string.

@item 
bpo-40744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40744}: The @ref{cf,,sqlite3} module uses SQLite API functions that
require SQLite v3.7.3 or higher.  This patch removes support for older
SQLite versions, and explicitly requires SQLite 3.7.3 both at build,
compile and runtime.  Patch by Sergey Fedoseev and Erlend E. Aasland.

@item 
bpo-40777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40777}: Initialize PyDateTime_IsoCalendarDateType.tp_base at run-time
to avoid errors on some compilers.

@item 
bpo-38488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38488}: Update ensurepip to install pip 20.1.1 and setuptools 47.1.0.

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: The result of @ref{1917,,operator.index()} now always has exact type
@ref{1f0,,int}. Previously, the result could have been an instance of a
subclass of @code{int}.

@item 
bpo-40767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40767}: @ref{115,,webbrowser} now properly finds the default browser in
pure Wayland systems by checking the WAYLAND_DISPLAY environment variable.
Patch contributed by Jérémy Attali.

@item 
bpo-40791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40791}: @code{hashlib.compare_digest()} uses OpenSSL’s
@code{CRYPTO_memcmp()} function when OpenSSL is available.

@item 
bpo-40795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40795}: @ref{2b,,ctypes} module: If ctypes fails to convert the result of
a callback or if a ctypes callback function raises an exception,
sys.unraisablehook is now called with an exception set. Previously, the
error was logged into stderr by @ref{194f,,PyErr_Print()}.

@item 
bpo-16995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16995}: Add @ref{87a,,base64.b32hexencode()} and @ref{87b,,base64.b32hexdecode()}
to support the Base32 Encoding with Extended Hex Alphabet.

@item 
bpo-30008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30008}: Fix @ref{d0,,ssl} code to be compatible with OpenSSL 1.1.x builds
that use @code{no-deprecated} and @code{--api=1.1.0}.

@item 
bpo-30064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30064}: Fix asyncio @code{loop.sock_*} race condition issue

@item 
bpo-40759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40759}: Deprecate the @code{symbol} module.

@item 
bpo-40756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40756}: The second argument (extra) of @code{LoggerAdapter.__init__} now
defaults to None.

@item 
bpo-37129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37129}: Add a new @ref{1950,,os.RWF_APPEND} flag for @ref{be8,,os.pwritev()}.

@item 
bpo-40737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40737}: Fix possible reference leak for @ref{cf,,sqlite3} initialization.

@item 
bpo-40726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40726}: Handle cases where the @code{end_lineno} is @code{None} on
@ref{179e,,ast.increment_lineno()}.

@item 
bpo-40698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40698}: @code{distutils} upload creates SHA2-256 and Blake2b-256 digests.
MD5 digests is skipped if platform blocks MD5.

@item 
bpo-40695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40695}: @ref{68,,hashlib} no longer falls back to builtin hash
implementations when OpenSSL provides a hash digest and the algorithm is
blocked by security policy.

@item 
bpo-9216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9216}: @ref{1951,,hashlib.new()} passed @code{usedforsecurity} to OpenSSL EVP
constructor @code{_hashlib.new()}. test_hashlib and test_smtplib handle
strict security policy better.

@item 
bpo-40614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40614}: @ref{30f,,ast.parse()} will not parse self documenting expressions
in f-strings when passed @code{feature_version} is less than @code{(3, 8)}.

@item 
bpo-40626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40626}: Add h5 file extension as MIME Type application/x-hdf5, as per
HDF Group recommendation for HDF5 formatted data files. Patch contributed
by Mark Schwab.

@item 
bpo-25920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25920}: On macOS, when building Python for macOS 10.4 and older, which
wasn’t the case for python.org macOS installer, @ref{175a,,socket.getaddrinfo()}
no longer uses an internal lock to prevent race conditions when calling
@code{getaddrinfo()} which is thread-safe since macOS 10.5. Python 3.9
requires macOS 10.6 or newer. The internal lock caused random hang on fork
when another thread was calling @ref{175a,,socket.getaddrinfo()}. The lock was
also used on FreeBSD older than 5.3, OpenBSD older than 201311 and NetBSD
older than 4.

@item 
bpo-40671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40671}: Prepare @code{_hashlib} for 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} and use
@ref{a07,,PyModule_AddType()}.

@item 
bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309}: Added a new @ref{53a,,coroutine} @ref{97f,,asyncio.to_thread()}. It is
mainly used for running IO-bound functions in a separate thread to avoid
blocking the event loop, and essentially works as a high-level version of
@ref{980,,run_in_executor()} that can directly take keyword
arguments.

@item 
bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543}: Restored the deprecated @code{xml.etree.cElementTree} module.

@item 
bpo-40611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40611}: @ref{1952,,MAP_POPULATE} constant has now been added to the
list of exported @ref{90,,mmap} module flags.

@item 
bpo-39881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39881}: PEP 554 for use in the test suite. (Patch By Joannah Nanjekye)

@item 
bpo-13097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13097}: @code{ctypes} now raises an @code{ArgumentError} when a callback is
invoked with more than 1024 arguments.

@item 
bpo-39385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39385}: A new test assertion context-manager,
@code{unittest.assertNoLogs()} will ensure a given block of code emits no
log messages using the logging module. Contributed by Kit Yan Choi.

@item 
bpo-23082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23082}: Updated the error message and docs of PurePath.relative_to() to
better reflect the function behaviour.

@item 
bpo-40318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40318}: Use SQLite3 trace v2 API, if it is available.

@item 
bpo-40105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40105}: ZipFile truncates files to avoid corruption when a shorter
comment is provided in append («a») mode. Patch by Jan Mazur.

@item 
bpo-40084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40084}: Fix @code{Enum.__dir__}: dir(Enum.member) now includes attributes
as well as methods.

@item 
bpo-31122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31122}: ssl.wrap_socket() now raises ssl.SSLEOFError rather than
OSError when peer closes connection during TLS negotiation

@item 
bpo-39728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39728}: fix default @code{_missing_} so a duplicate @code{ValueError} is not
set as the @code{__context__} of the original @code{ValueError}.

@item 
bpo-39244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39244}: Fixed @code{multiprocessing.context.get_all_start_methods} to
properly return the default method first on macOS.

@item 
bpo-39040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39040}: Fix parsing of invalid mime headers parameters by collapsing
whitespace between encoded words in a bare-quote-string.

@item 
bpo-38731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38731}: Add @code{--quiet} option to command-line interface of
@ref{b3,,py_compile}. Patch by Gregory Schevchenko.

@item 
bpo-35714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35714}: @ref{138b,,struct.error} is now raised if there is a null character
in a @ref{d5,,struct} format string.

@item 
bpo-38144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38144}: Added the `root_dir' and `dir_fd' parameters in
@ref{3ef,,glob.glob()}.

@item 
bpo-26543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26543}: Fix @code{IMAP4.noop()} when debug mode is enabled (ex:
@code{imaplib.Debug = 3}).

@item 
bpo-12178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12178}: @ref{530,,csv.writer()} now correctly escapes `escapechar' when
input contains `escapechar'.  Patch by Catalin Iacob, Berker Peksag, and
Itay Elbirt.

@item 
bpo-36290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36290}: AST nodes are now raising @ref{228,,TypeError} on conflicting
keyword arguments. Patch contributed by Rémi Lapeyre.

@item 
bpo-33944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33944}: Added site.py site-packages tracing in verbose mode.

@item 
bpo-35078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35078}: Refactor formatweekday, formatmonthname methods in
LocaleHTMLCalendar and LocaleTextCalendar classes in calendar module to
call the base class methods.This enables customizable CSS classes for
LocaleHTMLCalendar. Patch by Srinivas Reddy Thatiparthy

@item 
bpo-29620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29620}: @ref{11d5,,assertWarns()} no longer raises a
@code{RuntimeException} when accessing a module’s @code{__warningregistry__}
causes importation of a new module, or when a new module is imported in
another thread. Patch by Kernc.

@item 
bpo-31844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31844}: Remove @code{ParserBase.error()} method from the private and
undocumented @code{_markupbase} module.  @ref{90e,,html.parser.HTMLParser} is
the only subclass of @code{ParserBase} and its @code{error()} implementation was
deprecated in Python 3.4 and removed in Python 3.5.

@item 
bpo-34226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34226}: Fix @code{cgi.parse_multipart} without content_length. Patch by
Roger Duran

@item 
bpo-33660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33660}: Fix pathlib.PosixPath to resolve a relative path located on the
root directory properly.

@item 
bpo-28557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28557}: Improve the error message for a misbehaving @code{rawio.readinto}

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: The d.is_integer() method is added to the Decimal type, for
compatibility with other number types.

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: The x.is_integer() method is incorporated into the abstract
types of the numeric tower, Real, Rational and Integral, with appropriate
default implementations.
@end itemize

@node Documentation<32>,Tests<32>,Library<33>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id298}@anchor{1953}
@subsubsection Documentation



@itemize -

@item 
bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}: Add documentation for 
@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} (Allow writing union types as
@code{X | Y}).

@item 
bpo-41774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41774}: In Programming FAQ «Sequences (Tuples/Lists)» section, add «How
do you remove multiple items from a list».

@item 
bpo-35293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35293}: Fix RemovedInSphinx40Warning when building the documentation.
Patch by Donghee Na.

@item 
bpo-37149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37149}: Change Shipman tkinter doc link from archive.org to TkDocs.
(The doc has been removed from the NMT server.)  The new link responds
much faster and includes a short explanatory note.

@item 
bpo-41726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41726}: Update the refcounts info of @code{PyType_FromModuleAndSpec}.

@item 
bpo-41624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41624}: Fix the signature of @ref{1954,,typing.Coroutine}.

@item 
bpo-40204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40204}: Enable Sphinx 3.2 @code{c_allow_pre_v3} option and disable
@code{c_warn_on_allowed_pre_v3} option to make the documentation compatible
with Sphinx 2 and Sphinx 3.

@item 
bpo-41045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41045}: Add documentation for debug feature of f-strings.

@item 
bpo-41314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41314}: Changed the release when @code{from __future__ import annotations}
becomes the default from @code{4.0} to @code{3.10} (following a change in PEP
563).

@item 
bpo-40979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40979}: Refactored typing.rst, arranging more than 70 classes,
functions, and decorators into new sub-sections.

@item 
bpo-40552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40552}: Fix in tutorial section 4.2. Code snippet is now correct.

@item 
bpo-39883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39883}: Make code, examples, and recipes in the Python documentation be
licensed under the more permissive BSD0 license in addition to the
existing Python 2.0 license.

@item 
bpo-37703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37703}: Updated Documentation to comprehensively elaborate on the
behaviour of gather.cancel()
@end itemize

@node Tests<32>,Build<33>,Documentation<32>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id299}@anchor{1955}
@subsubsection Tests



@itemize -

@item 
bpo-41939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41939}: Fix test_site.test_license_exists_at_url(): call
@code{urllib.request.urlcleanup()} to reset the global
@code{urllib.request._opener}. Patch by Victor Stinner.

@item 
bpo-41731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41731}: Make test_cmd_line_script pass with option “-vv”.

@item 
bpo-41602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41602}: Add tests for SIGINT handling in the runpy module.

@item 
bpo-41521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41521}: @ref{e4,,test.support}: Rename @code{blacklist} parameter of
@ref{1956,,check__all__()} to @code{not_exported}.

@item 
bpo-41477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41477}: Make ctypes optional in test_genericalias.

@item 
bpo-41085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41085}: Fix integer overflow in the @ref{877,,array.array.index()} method on
64-bit Windows for index larger than @code{2**31}.

@item 
bpo-41069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41069}: @code{test.support.TESTFN} and the current directory for tests
when run via @code{test.regrtest} contain now non-ascii characters if
possible.

@item 
bpo-38377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38377}: On Linux, skip tests using multiprocessing if the current user
cannot create a file in @code{/dev/shm/} directory. Add the
@ref{1957,,skip_if_broken_multiprocessing_synchronize()} function
to the @ref{e4,,test.support} module.

@item 
bpo-41009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41009}: Fix use of @code{support.require_@{linux|mac|freebsd@}_version()}
decorators as class decorator.

@item 
bpo-41003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41003}: Fix @code{test_copyreg} when @code{numpy} is installed:
@code{test.pickletester} now saves/restores warnings filters when importing
@code{numpy}, to ignore filters installed by @code{numpy}.

@item 
bpo-40964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40964}: Disable remote @ref{74,,imaplib} tests, host cyrus.andrew.cmu.edu
is blocking incoming connections.

@item 
bpo-40927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40927}: Fix test_binhex when run twice: it now uses
import_fresh_module() to ensure that it raises DeprecationWarning each
time.

@item 
bpo-17258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17258}: Skip some @ref{94,,multiprocessing} tests when MD5 hash digest is
blocked.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Increase LOOPBACK_TIMEOUT to 10 for VxWorks RTOS.

@item 
bpo-38169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38169}: Increase code coverage for SharedMemory and ShareableList

@item 
bpo-34401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34401}: Make test_gdb properly run on HP-UX. Patch by Michael Osipov.
@end itemize

@node Build<33>,Windows<32>,Tests<32>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id300}@anchor{1958}
@subsubsection Build



@itemize -

@item 
bpo-38249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38249}: Update @ref{c3d,,Py_UNREACHABLE} to use __builtin_unreachable()
if only the compiler is able to use it. Patch by Donghee Na.

@item 
bpo-41617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41617}: Fix @code{pycore_bitutils.h} header file to support old clang
versions: @code{__builtin_bswap16()} is not available in LLVM clang 3.0.

@item 
bpo-40204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40204}: Pin Sphinx version to 2.3.1 in @code{Doc/Makefile}.

@item 
bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}: The C99 functions @code{snprintf()} and @code{vsnprintf()}
are now required to build Python.

@item 
bpo-40684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40684}: @code{make install} now uses the @code{PLATLIBDIR} variable for the
destination @code{lib-dynload/} directory when @code{./configure
--with-platlibdir} is used.

@item 
bpo-40683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40683}: Fixed an issue where the @ref{133,,zoneinfo} module and its tests
were not included when Python is installed with @code{make}.
@end itemize

@node Windows<32>,macOS<27>,Build<33>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id301}@anchor{1959}
@subsubsection Windows



@itemize -

@item 
bpo-41744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41744}: Fixes automatic import of props file when using the Nuget
package.

@item 
bpo-41627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41627}: The user site directory for 32-bit now includes a @code{-32}
suffix to distinguish it from the 64-bit interpreter’s directory.

@item 
bpo-41526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41526}: Fixed layout of final page of the installer by removing the
special thanks to Mark Hammond (with his permission).

@item 
bpo-41492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41492}: Fixes the description that appears in UAC prompts.

@item 
bpo-40948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40948}: Improve post-install message to direct people to the «py»
command.

@item 
bpo-41412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41412}: The installer will now fail to install on Windows 7 and Windows
8. Further, the UCRT dependency is now always downloaded on demand.

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: Update Windows release to include SQLite 3.32.3.

@item 
bpo-41142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41142}: @code{msilib} now supports creating CAB files with non-ASCII
file path and adding files with non-ASCII file path to them.

@item 
bpo-41074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41074}: Fixed support of non-ASCII names in functions
@code{msilib.OpenDatabase()} and @code{msilib.init_database()} and
non-ASCII SQL in method @code{msilib.Database.OpenView()}.

@item 
bpo-41039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41039}: Stable ABI redirection DLL (python3.dll) now uses @code{#pragma
comment(linker)} for re-exporting.

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: Updates Windows OpenSSL to 1.1.1g

@item 
bpo-39631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39631}: Changes the registered MIME type for @code{.py} files on Windows
to @code{text/x-python} instead of @code{text/plain}.

@item 
bpo-40677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40677}: Manually define IO_REPARSE_TAG_APPEXECLINK in case some old
Windows SDK doesn’t have it.

@item 
bpo-37556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37556}: Extend py.exe help to mention overrides via venv, shebang,
environmental variables & ini files.
@end itemize

@node macOS<27>,IDLE<22>,Windows<32>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id302}@anchor{195a}
@subsubsection macOS



@itemize -

@item 
bpo-41557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41557}: Update macOS installer to use SQLite 3.33.0.

@item 
bpo-39580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39580}: Avoid opening Finder window if running installer from the
command line. Patch contributed by Rick Heil.

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: Fix configure error when building on macOS 11. Note that the
current Python release was released shortly after the first developer
preview of macOS 11 (Big Sur); there are other known issues with building
and running on the developer preview. Big Sur is expected to be fully
supported in a future bugfix release of Python 3.8.x and with 3.9.0.

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: Update macOS installer to use SQLite 3.32.3.

@item 
bpo-41005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41005}: fixed an XDG settings issue not allowing macos to open browser
in webbrowser.py

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: Update macOS installer to use SQLite 3.32.2.
@end itemize

@node IDLE<22>,C API<32>,macOS<27>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id303}@anchor{195b}
@subsubsection IDLE



@itemize -

@item 
bpo-41775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41775}: Use “IDLE Shell” as shell title

@item 
bpo-35764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35764}: Rewrite the Calltips doc section.

@item 
bpo-40181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40181}: In calltips, stop reminding that “/” marks the end of
positional-only arguments.

@item 
bpo-41468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41468}: Improve IDLE run crash error message (which users should never
see).

@item 
bpo-41373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41373}: Save files loaded with no line ending, as when blank, or
different line endings, by setting its line ending to the system default.
Fix regression in 3.8.4 and 3.9.0b4.

@item 
bpo-41300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41300}: Save files with non-ascii chars. Fix regression released in
3.9.0b4 and 3.8.4.

@item 
bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}: Add keywords to module name completion list.  Rewrite
Completions section of IDLE doc.

@item 
bpo-41152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41152}: The encoding of @code{stdin}, @code{stdout} and @code{stderr} in IDLE is
now always UTF-8.

@item 
bpo-41144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41144}: Make Open Module open a special module such as os.path.

@item 
bpo-39885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39885}: Make context menu Cut and Copy work again when right-clicking
within a selection.

@item 
bpo-40723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40723}: Make test_idle pass when run after import.
@end itemize

@node C API<32>,,IDLE<22>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id304}@anchor{195c}
@subsubsection C API



@itemize -

@item 
bpo-41936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41936}: Removed undocumented macros @code{Py_ALLOW_RECURSION} and
@code{Py_END_ALLOW_RECURSION} and the @code{recursion_critical} field of the
@ref{954,,PyInterpreterState} structure.

@item 
bpo-41692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41692}: The @code{PyUnicode_InternImmortal()} function is now deprecated
and will be removed in Python 3.12: use @ref{948,,PyUnicode_InternInPlace()}
instead. Patch by Victor Stinner.

@item 
bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}: Add @ref{92f,,PyCodec_Unregister()} function to unregister a codec
search function.

@item 
bpo-41834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41834}: Remove the @code{_Py_CheckRecursionLimit} variable: it has been
replaced by @code{ceval.recursion_limit} of the @ref{954,,PyInterpreterState}
structure. Patch by Victor Stinner.

@item 
bpo-41689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41689}: Types created with @ref{621,,PyType_FromSpec()} now make any
signature in their @code{tp_doc} slot accessible from @code{__text_signature__}.

@item 
bpo-41524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41524}: Fix bug in PyOS_mystrnicmp and PyOS_mystricmp that incremented
pointers beyond the end of a string.

@item 
bpo-41324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41324}: Add a minimal decimal capsule API.  The API supports fast
conversions between Decimals up to 38 digits and their triple
representation as a C struct.

@item 
bpo-30155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30155}: Add @ref{92d,,PyDateTime_DATE_GET_TZINFO()} and
@ref{92e,,PyDateTime_TIME_GET_TZINFO()} macros for accessing the @code{tzinfo}
attributes of @ref{32f,,datetime.datetime} and @ref{331,,datetime.time}
objects.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Revert @ref{195d,,PyType_HasFeature()} change: it reads again
directly the @ref{18c6,,PyTypeObject.tp_flags} member when the limited C
API is not used, rather than always calling @ref{195e,,PyType_GetFlags()}
which hides implementation details.

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: Remove @code{PyUnicode_AsUnicodeCopy}.

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: Removed @code{PyLong_FromUnicode()}.

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: Removed @code{PyUnicode_GetMax()}.

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: Removed @code{Py_UNICODE_str*} functions manipulating
@code{Py_UNICODE*} strings.

@item 
bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}: @code{PyObject_AsCharBuffer()}, @code{PyObject_AsReadBuffer()},
@code{PyObject_CheckReadBuffer()}, and @code{PyObject_AsWriteBuffer()} are
removed. Please migrate to new buffer protocol;
@ref{48c,,PyObject_GetBuffer()} and @ref{48d,,PyBuffer_Release()}.

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: Raises DeprecationWarning for @code{PyUnicode_FromUnicode(NULL,
size)} and @code{PyUnicode_FromStringAndSize(NULL, size)} with @code{size > 0}.

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: Mark @code{Py_UNICODE_COPY}, @code{Py_UNICODE_FILL},
@code{PyUnicode_WSTR_LENGTH}, @code{PyUnicode_FromUnicode},
@code{PyUnicode_AsUnicode}, and @code{PyUnicode_AsUnicodeAndSize} as deprecated
in C. Remove @code{Py_UNICODE_MATCH} which was deprecated and broken since
Python 3.3.

@item 
bpo-40989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40989}: The @code{PyObject_INIT()} and @code{PyObject_INIT_VAR()}
macros become aliases to, respectively, @ref{afa,,PyObject_Init()} and
@ref{195f,,PyObject_InitVar()} functions.

@item 
bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}: On Windows, @code{#include "pyerrors.h"} no longer defines
@code{snprintf} and @code{vsnprintf} macros.

@item 
bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}: The @code{PY_SSIZE_T_CLEAN} macro must now be defined to use
@ref{615,,PyArg_ParseTuple()} and @ref{940,,Py_BuildValue()} formats which use
@code{#}: @code{es#}, @code{et#}, @code{s#}, @code{u#}, @code{y#}, @code{z#}, @code{U#} and
@code{Z#}. See @ref{941,,Parsing arguments and building values} and
the 
@geindex Python Enhancement Proposals; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}.

@item 
bpo-40910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40910}: Export explicitly the @ref{1960,,Py_GetArgcArgv()} function to the
C API and document the function. Previously, it was exported implicitly
which no longer works since Python is built with @code{-fvisibility=hidden}.

@item 
bpo-40724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40724}: Allow defining buffer slots in type specs.

@item 
bpo-40679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40679}: Fix a @code{_PyEval_EvalCode()} crash if `qualname' argument is
NULL.

@item 
bpo-40839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40839}: Calling @ref{479,,PyDict_GetItem()} without @ref{2c5,,GIL} held had
been allowed for historical reason. It is no longer allowed.

@item 
bpo-40826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40826}: @code{PyOS_InterruptOccurred()} now fails with a fatal error
if it is called with the GIL released.

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: The result of @ref{92b,,PyNumber_Index()} now always has exact
type @ref{1f0,,int}. Previously, the result could have been an instance of a
subclass of @code{int}.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Convert @ref{26f,,Py_REFCNT()} and @ref{81b,,Py_SIZE()} macros to
static inline functions. They cannot be used as l-value anymore: use
@ref{942,,Py_SET_REFCNT()} and @ref{81c,,Py_SET_SIZE()} to set an object
reference count and size. This change is backward incompatible on purpose,
to prepare the C API for an opaque @ref{42d,,PyObject} structure.

@item 
bpo-40703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40703}: The PyType_FromSpec*() functions no longer overwrite the type’s
«__module__» attribute if it is set via «Py_tp_members» or «Py_tp_getset».

@item 
bpo-39583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39583}: Remove superfluous «extern C» declarations from
@code{Include/cpython/*.h}.
@end itemize

@node Python 3 9 0 beta 1,Python 3 9 0 alpha 6,Python 3 10 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-beta-1}@anchor{1961}
@subsection Python 3.9.0 beta 1


`Release date: 2020-05-19'

@menu
* Security: Security<23>. 
* Core and Builtins: Core and Builtins<34>. 
* Library: Library<34>. 
* Documentation: Documentation<33>. 
* Tests: Tests<33>. 
* Build: Build<34>. 
* Windows: Windows<33>. 
* macOS: macOS<28>. 
* Tools/Demos: Tools/Demos<17>. 
* C API: C API<33>. 

@end menu

@node Security<23>,Core and Builtins<34>,,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id305}@anchor{1962}
@subsubsection Security



@itemize -

@item 
bpo-40501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40501}: @ref{110,,uuid} no longer uses @ref{2b,,ctypes} to load
@code{libuuid} or @code{rpcrt4.dll} at runtime.
@end itemize

@node Core and Builtins<34>,Library<34>,Security<23>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id306}@anchor{1963}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-40663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40663}: Correctly generate annotations where parentheses are omitted
but required (e.g: @code{Type[(str, int, *other))]}.

@item 
bpo-40596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40596}: Fixed @ref{1964,,str.isidentifier()} for non-canonicalized strings
containing non-BMP characters on Windows.

@item 
bpo-40593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40593}: Improved syntax errors for invalid characters in source code.

@item 
bpo-40585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40585}: Fixed a bug when using @ref{17d0,,codeop.compile_command()} that was
causing exceptions to be swallowed with the new parser. Patch by Pablo
Galindo

@item 
bpo-40566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40566}: Apply 
@geindex Python Enhancement Proposals; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/} to @ref{4,,abc}.

@item 
bpo-40502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40502}: Initialize @code{n->n_col_offset}. (Patch by Joannah Nanjekye)

@item 
bpo-40527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40527}: Fix command line argument parsing: no longer write errors
multiple times into stderr.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{57,,errno} to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40523}: Add pass-throughs for @ref{68b,,hash()} and @ref{8fc,,reversed()} to
@ref{189b,,weakref.proxy} objects. Patch by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{dc,,syslog} to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246}: Reporting a specialised error message for invalid string
prefixes, which was introduced in bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246}, is being reverted due to
backwards compatibility concerns for strings that immediately follow a
reserved keyword without whitespace between them. Constructs like
@code{bg="#d00" if clear else"#fca"} were failing to parse, which is not an
acceptable breakage on such short notice.

@item 
bpo-40417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40417}: Fix imp module deprecation warning when PyImport_ReloadModule
is called. Patch by Robert Rouhani.

@item 
bpo-40408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40408}: Fixed support of nested type variables in GenericAlias (e.g.
@code{list[list[T]]}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _stat module to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-29587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29587}: Enable implicit exception chaining when calling
@ref{59d,,generator.throw()}.

@item 
bpo-40328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40328}: Add tools for generating mappings headers for CJKCodecs.

@item 
bpo-40228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40228}: Setting frame.f_lineno is now robust w.r.t. changes in the
source-to-bytecode compiler

@item 
bpo-38880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38880}: Added the ability to list interpreters associated with channel
ends in the internal subinterpreters module.

@item 
bpo-37986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37986}: Improve performance of @ref{9d5,,PyLong_FromDouble()} for values
that fit into long.
@end itemize

@node Library<34>,Documentation<33>,Core and Builtins<34>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id307}@anchor{1965}
@subsubsection Library



@itemize -

@item 
bpo-40662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40662}: Fixed @ref{a69,,ast.get_source_segment()} for ast nodes that have
incomplete location information. Patch by Irit Katriel.

@item 
bpo-40665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40665}: Convert @ref{12,,bisect} to use Argument Clinic.

@item 
bpo-40536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40536}: Added the @ref{1966,,available_timezones()} function to the
@ref{133,,zoneinfo} module. Patch by Paul Ganssle.

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: The @code{hmac.HMAC} exposes internal implementation details.
The attributes @code{digest_cons}, @code{inner}, and @code{outer} are deprecated
and will be removed in the future.

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: The internal module @code{_hashlib} wraps and exposes OpenSSL’s
HMAC API. The new code will be used in Python 3.10 after the internal
implementation details of the pure Python HMAC module are no longer part
of the public API.

@item 
bpo-40637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40637}: Builtin hash modules can now be disabled or selectively enabled
with @code{configure --with-builtin-hashlib-hashes=sha3,blake1} or
@code{--without-builtin-hashlib-hashes}.

@item 
bpo-37630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37630}: The @ref{68,,hashlib} module can now use SHA3 hashes and SHAKE XOF
from OpenSSL when available.

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: The @ref{68,,hashlib} now compiles with OpenSSL 3.0.0-alpha2.

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: Revert changes to @ref{a8c,,inspect.getdoc()}.

@item 
bpo-40607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40607}: When cancelling a task due to timeout, @ref{6a0,,asyncio.wait_for()}
will now propagate the exception if an error happens during cancellation.
Patch by Roman Skurikhin.

@item 
bpo-40612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40612}: Fix edge cases in SyntaxError formatting. If the offset is <=
0, no caret is printed. If the offset is > line length, the caret is
printed pointing just after the last character.

@item 
bpo-40597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40597}: If text content lines are longer than policy.max_line_length,
always use a content-encoding to make sure they are wrapped.

@item 
bpo-40571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40571}: Added functools.cache() as a simpler, more discoverable way to
access the unbounded cache variant of lru_cache(maxsize=None).

@item 
bpo-40503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40503}: 
@geindex Python Enhancement Proposals; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}, the @ref{133,,zoneinfo} module. Adds support for the
IANA time zone database.

@item 
bpo-40397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40397}: Removed attributes @code{__args__} and @code{__parameters__} from
special generic aliases like @code{typing.List} (not subscripted).

@item 
bpo-40549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40549}: Convert posixmodule.c («posix» or «nt» module) to the
multiphase initialization (PEP 489).

@item 
bpo-31033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31033}: Add a @code{msg} argument to @code{Future.cancel()} and
@code{Task.cancel()}.

@item 
bpo-40541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40541}: Added an optional `counts' parameter to random.sample().

@item 
bpo-40515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40515}: The @ref{d0,,ssl} and @ref{68,,hashlib} modules now actively check
that OpenSSL is build with thread support. Python 3.7.0 made thread
support mandatory and no longer works safely with a no-thread builds.

@item 
bpo-31033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31033}: When a @ref{580,,asyncio.Task} is cancelled, the exception
traceback now chains all the way back to where the task was first
interrupted.

@item 
bpo-40504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40504}: @ref{a81,,functools.lru_cache()} objects can now be the targets of
weakrefs.

@item 
bpo-40559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40559}: Fix possible memory leak in the C implementation of
@ref{580,,asyncio.Task}.

@item 
bpo-40480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40480}: @code{fnmatch.fnmatch()} could take exponential time in the
presence of multiple @code{*} pattern characters.  This was repaired by
generating more elaborate regular expressions to avoid futile
backtracking.

@item 
bpo-40495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40495}: @ref{21,,compileall} is now able to use hardlinks to prevent
duplicates in a case when @code{.pyc} files for different optimization levels
have the same content.

@item 
bpo-40457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40457}: The ssl module now support OpenSSL builds without TLS 1.0 and
1.1 methods.

@item 
bpo-40355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40355}: Improve error reporting in @ref{ca0,,ast.literal_eval()} in the
presence of malformed @ref{1967,,ast.Dict} nodes instead of silently ignoring
any non-conforming elements. Patch by Curtis Bucher.

@item 
bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}: Deprecated the optional `random' argument to
`random.shuffle()'.

@item 
bpo-40459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40459}: @ref{1968,,platform.win32_ver()} now produces correct `ptype' strings
instead of empty strings.

@item 
bpo-39435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39435}: The first argument of @ref{d98,,pickle.loads()} is now
positional-only.

@item 
bpo-39305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39305}: Update @code{nntplib} to merge @code{nntplib.NNTP} and
@code{nntplib._NNTPBase}. Patch by Donghee Na.

@item 
bpo-32494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32494}: Update @ref{34,,dbm.gnu} to use gdbm_count if possible when
calling @ref{6cf,,len()}. Patch by Donghee Na.

@item 
bpo-40453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40453}: Add @code{isolated=True} keyword-only parameter to
@code{_xxsubinterpreters.create()}. An isolated subinterpreter cannot spawn
threads, spawn a child process or call @code{os.fork()}.

@item 
bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}: Remove @code{_random.Random.randbytes()}: the C implementation of
@code{randbytes()}. Implement the method in Python to ease subclassing:
@code{randbytes()} now directly reuses @code{getrandbits()}.

@item 
bpo-40394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40394}: Added default arguments to
@ref{1969,,difflib.SequenceMatcher.find_longest_match()}.

@item 
bpo-39995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39995}: Fix a race condition in concurrent.futures._ThreadWakeup:
access to _ThreadWakeup is now protected with the shutdown lock.

@item 
bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}: @code{Process.shutdown(wait=True)} of @ref{22,,concurrent.futures}
now closes explicitly the result queue.

@item 
bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}: Add a new @ref{9ab,,close()} method to
the @ref{9aa,,SimpleQueue} class to explicitly close the
queue.

@item 
bpo-39966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39966}: Revert bpo-25597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25597}. @ref{f12,,unittest.mock.MagicMock} with wraps”
set uses default return values for magic methods.

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: Added @code{files()} function to importlib.resources with support
for subdirectories in package data, matching backport in
importlib_resources 1.5.

@item 
bpo-40375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40375}: @ref{99d,,imaplib.IMAP4.unselect()} is added. Patch by Donghee Na.

@item 
bpo-40389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40389}: @code{repr()} now returns @code{typing.Optional[T]} when called for
@code{typing.Union} of two types, one of which is @code{NoneType}.

@item 
bpo-40291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40291}: Add support for CAN_J1939 sockets (available on Linux 5.4+)

@item 
bpo-40273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40273}: @ref{518,,types.MappingProxyType} is now reversible.

@item 
bpo-39075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39075}: The repr for @ref{334,,types.SimpleNamespace} is now insertion
ordered rather than alphabetical.

@item 
bpo-40192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40192}: On AIX, @ref{9c9,,thread_time()} is now implemented with
@code{thread_cputime()} which has nanosecond resolution, rather than
@code{clock_gettime(CLOCK_THREAD_CPUTIME_ID)} which has a resolution of 10
milliseconds. Patch by Batuhan Taskaya.

@item 
bpo-40025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40025}: Raise TypeError when _generate_next_value_ is defined after
members. Patch by Ethan Onstott.

@item 
bpo-39058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39058}: In the argparse module, the repr for Namespace() and other
argument holders now displayed in the order attributes were added.
Formerly, it displayed in alphabetical order even though argument order is
preserved the user visible parts of the module.

@item 
bpo-24416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24416}: The @code{isocalendar()} methods of @ref{330,,datetime.date} and
@ref{32f,,datetime.datetime} now return a @ref{6ef,,named tuple} instead of a
@ref{464,,tuple}.
@end itemize

@node Documentation<33>,Tests<33>,Library<34>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id308}@anchor{196a}
@subsubsection Documentation



@itemize -

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: Add version of removal for explicit passing of coros to
@code{asyncio.wait()}”s documentation

@item 
bpo-40561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40561}: Provide docstrings for webbrowser open functions.

@item 
bpo-40499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40499}: Mention that @ref{528,,asyncio.wait()} requires a non-empty set of
awaitables.

@item 
bpo-39705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39705}: Tutorial example for sorted() in the Loop Techniques section is
given a better explanation. Also a new example is included to explain
sorted()”s basic behavior.

@item 
bpo-39435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39435}: Fix an incorrect signature for @ref{d98,,pickle.loads()} in the docs
@end itemize

@node Tests<33>,Build<34>,Documentation<33>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id309}@anchor{196b}
@subsubsection Tests



@itemize -

@item 
bpo-40055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40055}: distutils.tests now saves/restores warnings filters to leave
them unchanged. Importing tests imports docutils which imports
pkg_resources which adds a warnings filter.

@item 
bpo-40436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40436}: test_gdb and test.pythoninfo now check gdb command exit code.
@end itemize

@node Build<34>,Windows<33>,Tests<33>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id310}@anchor{196c}
@subsubsection Build



@itemize -

@item 
bpo-40653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40653}: Move _dirnameW out of HAVE_SYMLINK to fix a potential compiling
issue.

@item 
bpo-40514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40514}: Add @code{--with-experimental-isolated-subinterpreters} build
option to @code{configure}: better isolate subinterpreters, experimental
build mode.
@end itemize

@node Windows<33>,macOS<28>,Build<34>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id311}@anchor{196d}
@subsubsection Windows



@itemize -

@item 
bpo-40650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40650}: Include winsock2.h in pytime.c for timeval.

@item 
bpo-40458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40458}: Increase reserved stack space to prevent overflow crash on
Windows.

@item 
bpo-39148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39148}: Add IPv6 support to @ref{b,,asyncio} datagram endpoints in
ProactorEventLoop. Change the raised exception for unknown address
families to ValueError as it’s not coming from Windows API.
@end itemize

@node macOS<28>,Tools/Demos<17>,Windows<33>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id312}@anchor{196e}
@subsubsection macOS



@itemize -

@item 
bpo-34956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34956}: When building Python on macOS from source, @code{_tkinter} now
links with non-system Tcl and Tk frameworks if they are installed in
@code{/Library/Frameworks}, as had been the case on older releases of macOS.
If a macOS SDK is explicitly configured, by using
@code{--enable-universalsdk=} or @code{-isysroot}, only the SDK itself is
searched. The default behavior can still be overridden with
@code{--with-tcltk-includes} and @code{--with-tcltk-libs}.

@item 
bpo-35569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35569}: Expose RFC 3542 IPv6 socket options.
@end itemize

@node Tools/Demos<17>,C API<33>,macOS<28>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id313}@anchor{196f}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: Update multissltest helper to test with latest OpenSSL 1.0.2,
1.1.0, 1.1.1, and 3.0.0-alpha.

@item 
bpo-40431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40431}: Fix a syntax typo in @code{turtledemo} that now raises a
@code{SyntaxError}.

@item 
bpo-40163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40163}: Fix multissltest tool. OpenSSL has changed download URL for old
releases. The multissltest tool now tries to download from current and old
download URLs.
@end itemize

@node C API<33>,,Tools/Demos<17>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id314}@anchor{1970}
@subsubsection C API



@itemize -

@item 
bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}: Remove the @code{_PyUnicode_ClearStaticStrings()} function from
the C API.

@item 
bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}: Add PyCFunction_CheckExact() macro for exact type checks now
that we allow subtypes of PyCFunction, as well as PyCMethod_CheckExact()
and PyCMethod_Check() for the new PyCMethod subtype.

@item 
bpo-40545@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40545}: Declare @code{_PyErr_GetTopmostException()} with @code{PyAPI_FUNC()}
to properly export the function in the C API. The function remains private
(@code{_Py}) prefix.

@item 
bpo-40412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40412}: Nullify inittab_copy during finalization, preventing future
interpreter initializations in an embedded situation from crashing. Patch
by Gregory Szorc.

@item 
bpo-40429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40429}: The @ref{827,,PyThreadState_GetFrame()} function now returns a
strong reference to the frame.

@item 
bpo-40428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40428}: Remove the following functions from the C API. Call
@ref{a20,,PyGC_Collect()} explicitly to free all free lists.


@itemize *

@item 
@code{PyAsyncGen_ClearFreeLists()}

@item 
@code{PyContext_ClearFreeList()}

@item 
@code{PyDict_ClearFreeList()}

@item 
@code{PyFloat_ClearFreeList()}

@item 
@code{PyFrame_ClearFreeList()}

@item 
@code{PyList_ClearFreeList()}

@item 
@code{PySet_ClearFreeList()}

@item 
@code{PyTuple_ClearFreeList()}
@end itemize

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: New @ref{81f,,PyFrame_GetBack()} function: get the frame next
outer frame.

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: New @ref{823,,PyFrame_GetCode()} function: return a borrowed
reference to the frame code.

@item 
bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217}: Ensure that instances of types created with
@ref{622,,PyType_FromSpecWithBases()} will visit its class object when
traversing references in the garbage collector (implemented as an
extension of the provided @ref{818,,tp_traverse}). Patch by
Pablo Galindo.

@item 
bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}: Module C state is now accessible from C-defined heap type
methods (
@geindex Python Enhancement Proposals; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}). Patch by Marcel Plch and Petr Viktorin.
@end itemize

@node Python 3 9 0 alpha 6,Python 3 9 0 alpha 5,Python 3 9 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-6}@anchor{1971}
@subsection Python 3.9.0 alpha 6


`Release date: 2020-04-27'

@menu
* Security: Security<24>. 
* Core and Builtins: Core and Builtins<35>. 
* Library: Library<35>. 
* Documentation: Documentation<34>. 
* Tests: Tests<34>. 
* Build: Build<35>. 
* Windows: Windows<34>. 
* macOS: macOS<29>. 
* IDLE: IDLE<23>. 
* Tools/Demos: Tools/Demos<18>. 
* C API: C API<34>. 

@end menu

@node Security<24>,Core and Builtins<35>,,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id315}@anchor{1972}
@subsubsection Security



@itemize -

@item 
bpo-40121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40121}: Fixes audit events raised on creating a new socket.

@item 
bpo-39073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39073}: Disallow CR or LF in email.headerregistry.Address arguments to
guard against header injection attacks.

@item 
bpo-39503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39503}: 
@geindex Common Vulnerabilities and Exposures; CVE 2020-8492
CVE 2020-8492@footnote{https://www.cve.org/CVERecord?id=CVE-2020-8492}: The
@ref{18c4,,AbstractBasicAuthHandler} class of the
@ref{10b,,urllib.request} module uses an inefficient regular expression which
can be exploited by an attacker to cause a denial of service. Fix the
regex to prevent the catastrophic backtracking. Vulnerability reported by
Ben Caller and Matt Schwager.
@end itemize

@node Core and Builtins<35>,Library<35>,Security<24>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id316}@anchor{1973}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-40313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40313}: Improve the performance of bytes.hex().

@item 
bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}: Switch to a new parser, based on PEG.  For more details see PEP
617. To temporarily switch back to the old parser, use @code{-X oldparser} or
@code{PYTHONOLDPARSER=1}.  In Python 3.10 we will remove the old parser
completely, including the @code{parser} module (already deprecated) and
anything that depends on it.

@item 
bpo-40267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40267}: Fix the tokenizer to display the correct error message, when
there is a @code{SyntaxError} on the last input character and no newline
follows. It used to be @code{unexpected EOF while parsing}, while it should
be @code{invalid syntax}.

@item 
bpo-39522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39522}: Correctly unparse explicit @code{u} prefix for strings when
postponed evaluation for annotations activated. Patch by Batuhan Taskaya.

@item 
bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246}: Report a specialized error message, @code{invalid string prefix},
when the tokenizer encounters a string with an invalid prefix.

@item 
bpo-40082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40082}: Fix the signal handler: it now always uses the main
interpreter, rather than trying to get the current Python thread state.

@item 
bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}: str.encode() and str.decode() no longer check the encoding and
errors in development mode or in debug mode during Python finalization.
The codecs machinery can no longer work on very late calls to str.encode()
and str.decode().

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Fix possible refleaks in @code{_json}, memo of PyScannerObject
should be traversed.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{dict()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention.

@item 
bpo-40141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40141}: Add column and line information to @code{ast.keyword} nodes. Patch
by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{bc,,resource} to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @ref{8e,,math} to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _uuid module to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert json module to use @ref{621,,PyType_FromSpec()}.

@item 
bpo-40067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40067}: Improve the error message for multiple star expressions in an
assignment. Patch by Furkan Onder

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _functools module to multiphase initialization (PEP
489). Patch by Paulo Henrique Silva.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port operator module to multiphase initialization (PEP 489).
Patch by Paulo Henrique Silva.

@item 
bpo-20526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20526}: Fix @ref{1628,,PyThreadState_Clear()}. @code{PyThreadState.frame} is
a borrowed reference, not a strong reference: @code{PyThreadState_Clear()}
must not call @code{Py_CLEAR(tstate->frame)}.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port time module to multiphase initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
Patch by Paulo Henrique Silva.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _weakref extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40020}: Fix a leak and subsequent crash in parsetok.c caused by realloc
misuse on a rare codepath.

@item 
bpo-39939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39939}: Added str.removeprefix and str.removesuffix methods and
corresponding bytes, bytearray, and collections.UserString methods to
remove affixes from a string if present. See 
@geindex Python Enhancement Proposals; PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/} for a full
description. Patch by Dennis Sweeney.

@item 
bpo-39481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39481}: Implement PEP 585. This supports list[int], tuple[str, …]
etc.

@item 
bpo-32894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32894}: Support unparsing of infinity numbers in postponed annotations.
Patch by Batuhan Taşkaya.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{list()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Mark Shannon.
@end itemize

@node Library<35>,Documentation<34>,Core and Builtins<35>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id317}@anchor{1974}
@subsubsection Library



@itemize -

@item 
bpo-40398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40398}: @ref{916,,typing.get_args()} now always returns an empty tuple for
special generic aliases.

@item 
bpo-40396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40396}: Functions @ref{ad9,,typing.get_origin()}, @ref{916,,typing.get_args()}
and @ref{752,,typing.get_type_hints()} support now generic aliases like
@code{list[int]}.

@item 
bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}: Optimize the @ref{d6,,subprocess} module on FreeBSD using
@code{closefrom()}. A single @code{close(fd)} syscall is cheap, but when
@code{sysconf(_SC_OPEN_MAX)} is high, the loop calling @code{close(fd)} on each
file descriptor can take several milliseconds.

The workaround on FreeBSD to improve performance was to load and mount the
fdescfs kernel module, but this is not enabled by default.

Initial patch by Ed Maste (emaste), Conrad Meyer (cem), Kyle Evans
(kevans) and Kubilay Kocak (koobs):
@indicateurl{https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274}

@item 
bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}: On FreeBSD, @code{os.closerange(fd_low, fd_high)} now calls
@code{closefrom(fd_low)} if `fd_high' is greater than or equal to
@code{sysconf(_SC_OPEN_MAX)}.

Initial patch by Ed Maste (emaste), Conrad Meyer (cem), Kyle Evans
(kevans) and Kubilay Kocak (koobs):
@indicateurl{https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274}

@item 
bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}: The @code{lib2to3} module is pending deprecation due to
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}.

@item 
bpo-40138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40138}: Fix the Windows implementation of @ref{e20,,os.waitpid()} for exit
code larger than @code{INT_MAX >> 8}. The exit status is now interpreted as
an unsigned number.

@item 
bpo-39942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39942}: Set «__main__» as the default module name when «__name__» is
missing in @ref{2c9,,typing.TypeVar}. Patch by Weipeng Hong.

@item 
bpo-40275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40275}: The @ref{87,,logging} package is now imported lazily in
@ref{106,,unittest} only when the @ref{8f0,,assertLogs()}
assertion is used.

@item 
bpo-40275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40275}: The @ref{b,,asyncio} package is now imported lazily in
@ref{106,,unittest} only when the @ref{206,,IsolatedAsyncioTestCase}
class is used.

@item 
bpo-40330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40330}: In @code{ShareableList.__setitem__()}, check the size of a new
string item after encoding it to utf-8, not before.

@item 
bpo-40148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40148}: Added @code{pathlib.Path.with_stem()} to create a new Path with
the stem replaced.

@item 
bpo-40325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40325}: Deprecated support for set objects in random.sample().

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: Improved help for the @ref{104,,typing} module. Docstrings are now
shown for all special forms and special generic aliases (like @code{Union}
and @code{List}). Using @code{help()} with generic alias like @code{List[int]} will
show the help for the correspondent concrete type (@code{list} in this case).

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: @ref{a8c,,inspect.getdoc()} no longer returns docstring inherited
from the type of the object or from parent class if it is a class if it is
not defined in the object itself. In @ref{b5,,pydoc} the documentation string
is now shown not only for class, function, method etc, but for any object
that has its own @code{__doc__} attribute.

@item 
bpo-40287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40287}: Fixed @code{SpooledTemporaryFile.seek()} to return the position.

@item 
bpo-40290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40290}: Added zscore() to statistics.NormalDist().

@item 
bpo-40282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40282}: Allow @code{random.getrandbits(0)} to succeed and to return 0.

@item 
bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}: Add @ref{1975,,random.randbytes()} function and
@code{random.Random.randbytes()} method to generate random bytes.

@item 
bpo-40277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40277}: @ref{32d,,collections.namedtuple()} now provides a human-readable
repr for its field accessors.

@item 
bpo-40270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40270}: The included copy of sqlite3 on Windows is now compiled with
the json extension. This allows the use of functions such as
@code{json_object}.

@item 
bpo-29255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29255}: Wait in @code{KqueueSelector.select} when no fds are registered

@item 
bpo-40260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40260}: Ensure @ref{91,,modulefinder} uses @ref{172e,,io.open_code()} and
respects coding comments.

@item 
bpo-40234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40234}: Allow again to spawn daemon threads in subinterpreters (revert
change which denied them).

@item 
bpo-39207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39207}: Workers in @ref{163,,ProcessPoolExecutor} are
now spawned on demand, only when there are no available idle workers to
reuse. This optimizes startup overhead and reduces the amount of lost CPU
time to idle workers. Patch by Kyle Stanley.

@item 
bpo-40091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40091}: Fix a hang at fork in the logging module: the new private
_at_fork_reinit() method is now used to reinitialize locks at fork in the
child process.

@item 
bpo-40149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40149}: Implement traverse and clear slots in _abc._abc_data type.

@item 
bpo-40208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40208}: Remove deprecated @code{symtable.SymbolTable.has_exec()}.

@item 
bpo-40196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40196}: Fix a bug in the @ref{d8,,symtable} module that was causing
incorrectly report global variables as local. Patch by Pablo Galindo.

@item 
bpo-40190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40190}: Add support for @code{_SC_AIX_REALMEM} to @code{posix.sysconf()}.

@item 
bpo-40182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40182}: Removed the @code{_field_types} attribute of the
@ref{1db,,typing.NamedTuple} class.

@item 
bpo-36517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36517}: Multiple inheritance with @ref{1db,,typing.NamedTuple} now raises
an error instead of silently ignoring other types.

@item 
bpo-40126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40126}: Fixed reverting multiple patches in unittest.mock. Patcher’s
@code{__exit__()} is now never called if its @code{__enter__()} is failed.
Returning true from @code{__exit__()} silences now the exception.

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: CGIHTTPRequestHandler of http.server now logs the CGI script
exit code, rather than the CGI script exit status of os.waitpid(). For
example, if the script is killed by signal 11, it now logs: «CGI script
exit code -11.»

@item 
bpo-40108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40108}: Improve the error message when triying to import a module using
@ref{be,,runpy} and incorrectly using the «.py» extension at the end of the
module name. Patch by Pablo Galindo.

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: Add @ref{9b1,,os.waitstatus_to_exitcode()} function: convert a wait
status to an exit code.

@item 
bpo-40089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40089}: Fix threading._after_fork(): if fork was not called by a thread
spawned by threading.Thread, threading._after_fork() now creates a
_MainThread instance for _main_thread, instead of a _DummyThread instance.

@item 
bpo-40089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40089}: Add a private @code{_at_fork_reinit()} method to
@code{_thread.Lock}, @code{_thread.RLock}, @ref{1d7,,threading.RLock}
and @ref{11c6,,threading.Condition} classes: reinitialize the lock at fork in
the child process, reset the lock to the unlocked state. Rename also the
private @code{_reset_internal_locks()} method of @ref{11c9,,threading.Event} to
@code{_at_fork_reinit()}.

@item 
bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780}: Expose @ref{9c4,,CAN_RAW_JOIN_FILTERS} in the
@ref{cc,,socket} module.

@item 
bpo-39503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39503}: @ref{18c4,,AbstractBasicAuthHandler} of
@ref{10b,,urllib.request} now parses all WWW-Authenticate HTTP headers and
accepts multiple challenges per header: use the realm of the first Basic
challenge.

@item 
bpo-39812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39812}: Removed daemon threads from @ref{22,,concurrent.futures} by adding
an internal @code{threading._register_atexit()}, which calls registered
functions prior to joining all non-daemon threads. This allows for
compatibility with subinterpreters, which don’t support daemon threads.

@item 
bpo-40050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40050}: Fix @code{importlib._bootstrap_external}: avoid creating a new
@code{winreg} builtin module if it’s already available in
@ref{1976,,sys.modules}, and remove redundant imports.

@item 
bpo-40014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40014}: Fix @code{os.getgrouplist()}: if @code{getgrouplist()} function fails
because the group list is too small, retry with a larger group list. On
failure, the glibc implementation of @code{getgrouplist()} sets @code{ngroups}
to the total number of groups. For other implementations, double the group
list size.

@item 
bpo-40017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40017}: Add @ref{1977,,time.CLOCK_TAI} constant if the operating system
support it.

@item 
bpo-40016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40016}: In re docstring, clarify the relationship between inline and
argument compile flags.

@item 
bpo-39953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39953}: Update internal table of OpenSSL error codes in the @code{ssl}
module.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: Added 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators to
@ref{15bf,,weakref.WeakValueDictionary}.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: Added 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators to
@ref{15be,,weakref.WeakKeyDictionary}.

@item 
bpo-38891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38891}: Fix linear runtime behaviour of the @code{__getitem__} and
@code{__setitem__} methods in
@ref{1978,,multiprocessing.shared_memory.ShareableList}. This avoids
quadratic performance when iterating a @code{ShareableList}. Patch by Thomas
Krennwallner.

@item 
bpo-39682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39682}: Remove undocumented support for `closing' a @code{pathlib.Path}
object via its context manager. The context manager magic methods remain,
but they are now a no-op, making @code{Path} objects immutable.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: Added 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators (@code{|} and @code{|=}) to
@ref{ca4,,collections.ChainMap}.

@item 
bpo-39011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39011}: Normalization of line endings in ElementTree attributes was
removed, as line endings which were replaced by entity numbers should be
preserved in original form.

@item 
bpo-38410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38410}: Properly handle @ref{15af,,sys.audit()} failures in
@ref{1632,,sys.set_asyncgen_hooks()}.

@item 
bpo-36541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36541}: lib2to3 now recognizes named assignment expressions (the walrus
operator, @code{:=})

@item 
bpo-35967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35967}: In platform, delay the invocation of “uname -p” until the
processor attribute is requested.

@item 
bpo-35113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35113}: @ref{15ce,,inspect.getsource()} now returns correct source code for
inner class with same name as module level class. Decorators are also
returned as part of source of the class. Patch by Karthikeyan
Singaravelan.

@item 
bpo-33262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33262}: Deprecate passing None as an argument for @ref{5de,,shlex.split()}”s
@code{s} parameter.  Patch by Zackery Spytz.

@item 
bpo-31758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31758}: Prevent crashes when using an uninitialized
@code{_elementtree.XMLParser} object. Patch by Oren Milman.
@end itemize

@node Documentation<34>,Tests<34>,Library<35>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id318}@anchor{1979}
@subsubsection Documentation



@itemize -

@item 
bpo-27635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27635}: The pickle documentation incorrectly claimed that @code{__new__}
isn’t called by default when unpickling.

@item 
bpo-39879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39879}: Updated @ref{197a,,Modelo de datos} docs to include @ref{190,,dict()} insertion
order preservation. Patch by Furkan Onder and Samy Lahfa.

@item 
bpo-38387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38387}: Document @ref{197b,,PyDoc_STRVAR} macro in the C-API reference.

@item 
bpo-13743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13743}: Some methods within xml.dom.minidom.Element class are now
better documented.
@end itemize

@node Tests<34>,Build<35>,Documentation<34>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id319}@anchor{197c}
@subsubsection Tests



@itemize -

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Set expected default encoding in test_c_locale_coercion.py for
VxWorks RTOS.

@item 
bpo-40162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40162}: Update Travis CI configuration to OpenSSL 1.1.1f.

@item 
bpo-40146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40146}: Update OpenSSL to 1.1.1f in Azure Pipelines.

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: Add @ref{197d,,test.support.wait_process()} function.

@item 
bpo-40003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40003}: @code{test.bisect_cmd} now copies Python command line options like
@code{-O} or @code{-W}. Moreover, emit a warning if @code{test.bisect_cmd} is used
with @code{-w}/@code{--verbose2} option.

@item 
bpo-39380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39380}: Add the encoding in @ref{990,,ftplib.FTP} and
@ref{991,,ftplib.FTP_TLS} to the constructor as keyword-only and change the
default from @code{latin-1} to @code{utf-8} to follow 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.

@item 
bpo-39793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39793}: Use the same domain when testing @code{make_msgid}. Patch by
Batuhan Taskaya.

@item 
bpo-1812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1812}: Fix newline handling in doctest.testfile when loading from a
package whose loader has a get_data method. Patch by Peter Donis.
@end itemize

@node Build<35>,Windows<34>,Tests<34>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id320}@anchor{197e}
@subsubsection Build



@itemize -

@item 
bpo-38360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38360}: Support single-argument form of macOS -isysroot flag.

@item 
bpo-40158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40158}: Fix CPython MSBuild Properties in NuGet Package
(build/native/python.props)

@item 
bpo-38527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38527}: Fix configure check on Solaris for «float word ordering»:
sometimes, the correct «grep» command was not being used. Patch by Arnon
Yaari.
@end itemize

@node Windows<34>,macOS<29>,Build<35>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id321}@anchor{197f}
@subsubsection Windows



@itemize -

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: Updates Windows to OpenSSL 1.1.1f

@item 
bpo-8901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8901}: Ignore the Windows registry when the @code{-E} option is used.
@end itemize

@node macOS<29>,IDLE<23>,Windows<34>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id322}@anchor{1980}
@subsubsection macOS



@itemize -

@item 
bpo-38329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38329}: python.org macOS installers now update the Current version
symlink of /Library/Frameworks/Python.framework/Versions for 3.9 installs.
Previously, Current was only updated for Python 2.x installs. This should
make it easier to embed Python 3 into other macOS applications.

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: Update macOS installer builds to use OpenSSL 1.1.1g.
@end itemize

@node IDLE<23>,Tools/Demos<18>,macOS<29>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id323}@anchor{1981}
@subsubsection IDLE



@itemize -

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: Add a 256×256 pixel IDLE icon to support more modern
environments. Created by Andrew Clover. Delete the unused macOS idle.icns
icon file.

@item 
bpo-38689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38689}: IDLE will no longer freeze when inspect.signature fails when
fetching a calltip.
@end itemize

@node Tools/Demos<18>,C API<34>,IDLE<23>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id324}@anchor{1982}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-40385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40385}: Removed the checkpyc.py tool. Please see compileall without
force mode as a potential alternative.

@item 
bpo-40179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40179}: Fixed translation of @code{#elif} in Argument Clinic.

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: Fix @code{which.py} script exit code: it now uses
@ref{9b1,,os.waitstatus_to_exitcode()} to convert @ref{149a,,os.system()} exit status
into an exit code.
@end itemize

@node C API<34>,,Tools/Demos<18>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id325}@anchor{1983}
@subsubsection C API



@itemize -

@item 
bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}: Move the @code{PyGC_Head} structure to the internal C API.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert @ref{a16,,PyObject_IS_GC()} macro to a function to hide
implementation details.

@item 
bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}: Add the functions @ref{a08,,PyObject_GC_IsTracked()} and
@ref{a09,,PyObject_GC_IsFinalized()} to the public API to allow to query if
Python objects are being currently tracked or have been already finalized
by the garbage collector respectively. Patch by Pablo Galindo.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: The @code{PyObject_NEW()} macro becomes an alias to the
@ref{a17,,PyObject_New()} macro, and the @code{PyObject_NEW_VAR()} macro
becomes an alias to the @ref{a18,,PyObject_NewVar()} macro, to hide
implementation details. They no longer access directly the
@ref{a19,,PyTypeObject.tp_basicsize} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{195d,,PyType_HasFeature()} now always calls
@ref{195e,,PyType_GetFlags()} to hide implementation details. Previously, it
accessed directly the @ref{18c6,,PyTypeObject.tp_flags} member when the
limited C API was not used.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert the @code{PyObject_GET_WEAKREFS_LISTPTR()} macro to a
function to hide implementation details: the macro accessed directly to
the @ref{a1a,,PyTypeObject.tp_weaklistoffset} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert @ref{48b,,PyObject_CheckBuffer()} macro to a function to
hide implementation details: the macro accessed directly the
@ref{a1b,,PyTypeObject.tp_as_buffer} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Always declare @ref{a1c,,PyIndex_Check()} as an opaque function to
hide implementation details: remove @code{PyIndex_Check()} macro. The macro
accessed directly the @ref{a1d,,PyTypeObject.tp_as_number} member.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Add @ref{a04,,PyThreadState_GetID()} function: get the unique
identifier of a Python thread state.
@end itemize

@node Python 3 9 0 alpha 5,Python 3 9 0 alpha 4,Python 3 9 0 alpha 6,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-5}@anchor{1984}
@subsection Python 3.9.0 alpha 5


`Release date: 2020-03-23'

@menu
* Security: Security<25>. 
* Core and Builtins: Core and Builtins<36>. 
* Library: Library<36>. 
* Documentation: Documentation<35>. 
* Tests: Tests<35>. 
* Build: Build<36>. 
* Windows: Windows<35>. 
* macOS: macOS<30>. 
* IDLE: IDLE<24>. 
* Tools/Demos: Tools/Demos<19>. 
* C API: C API<35>. 

@end menu

@node Security<25>,Core and Builtins<36>,,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id326}@anchor{1985}
@subsubsection Security



@itemize -

@item 
bpo-38576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38576}: Disallow control characters in hostnames in http.client,
addressing 
@geindex Common Vulnerabilities and Exposures; CVE 2019-18348
CVE 2019-18348@footnote{https://www.cve.org/CVERecord?id=CVE-2019-18348}. Such potentially malicious header injection
URLs now cause a InvalidURL to be raised.
@end itemize

@node Core and Builtins<36>,Library<36>,Security<25>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id327}@anchor{1986}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}: Optimize pending calls in multithreaded applications. If a
thread different than the main thread schedules a pending call
(@ref{a13,,Py_AddPendingCall()}), the bytecode evaluation loop is no longer
interrupted at each bytecode instruction to check for pending calls which
cannot be executed. Only the main thread can execute pending calls.

Previously, the bytecode evaluation loop was interrupted at each
instruction until the main thread executes pending calls.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _weakref extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _collections module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}: Optimize signal handling in multithreaded applications. If a
thread different than the main thread gets a signal, the bytecode
evaluation loop is no longer interrupted at each bytecode instruction to
check for pending signals which cannot be handled. Only the main thread of
the main interpreter can handle signals.

Previously, the bytecode evaluation loop was interrupted at each
instruction until the main thread handles signals.

@item 
bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}: If @ref{a13,,Py_AddPendingCall()} is called in a subinterpreter,
the function is now scheduled to be called from the subinterpreter, rather
than being called from the main interpreter. Each subinterpreter now has
its own list of scheduled calls.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _heapq module to multiphase initialization.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port itertools module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{frozenset()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}: subinterpreters: Move
@code{_PyRuntimeState.ceval.tracing_possible} to
@code{PyInterpreterState.ceval.tracing_possible}: each interpreter now has
its own variable.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{set()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _statistics module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39968}: Use inline function to replace extension modules”
get_module_state macros.

@item 
bpo-39965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39965}: Correctly raise @code{SyntaxError} if `await' is used inside
non-async functions and @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} is set (like in the
asyncio REPL). Patch by Pablo Galindo.

@item 
bpo-39562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39562}: Allow executing asynchronous comprehensions on the top level
when the @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} flag is given. Patch by Batuhan
Taskaya.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{tuple()} by using the 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.

@item 
bpo-38373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38373}: Changed list overallocation strategy. It no longer
overallocates if the new size is closer to overallocated size than to the
old size and adds padding.

@item 
bpo-39926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39926}: Update Unicode database to Unicode version 13.0.0.

@item 
bpo-19466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19466}: Clear the frames of daemon threads earlier during the Python
shutdown to call objects destructors. So «unclosed file» resource warnings
are now emitted for daemon threads in a more reliable way.

@item 
bpo-38894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38894}: Fix a bug that was causing incomplete results when calling
@code{pathlib.Path.glob} in the presence of symlinks that point to files
where the user does not have read access. Patch by Pablo Galindo and Matt
Wozniski.

@item 
bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}: Fix @ref{49c,,PyEval_RestoreThread()} random crash at exit with
daemon threads. It now accesses the @code{_PyRuntime} variable directly
instead of using @code{tstate->interp->runtime}, since @code{tstate} can be a
dangling pointer after @ref{246,,Py_Finalize()} has been called. Moreover,
the daemon thread now exits before trying to take the GIL.

@item 
bpo-39871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39871}: Fix a possible @ref{619,,SystemError} in
@code{math.@{atan2,copysign,remainder@}()} when the first argument cannot be
converted to a @ref{153,,float}. Patch by Zackery Spytz.

@item 
bpo-39776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39776}: Fix race condition where threads created by PyGILState_Ensure()
could get a duplicate id.

This affects consumers of tstate->id like the contextvar caching
machinery, which could return invalid cached objects under heavy thread
load (observed in embedded scenarios).

@item 
bpo-39778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39778}: Fixed a crash due to incorrect handling of weak references in
@code{collections.OrderedDict} classes. Patch by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port audioop extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39702}: Relax @ref{7cd,,decorator} grammar restrictions to allow any valid
expression (
@geindex Python Enhancement Proposals; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}).

@item 
bpo-38091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38091}: Tweak import deadlock detection code to not deadlock itself.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _locale extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39087}: Optimize @ref{c43,,PyUnicode_AsUTF8()} and
@ref{931,,PyUnicode_AsUTF8AndSize()} slightly when they need to create
internal UTF-8 cache.

@item 
bpo-39520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39520}: Fix unparsing of ext slices with no items (@code{foo[:,]}). Patch
by Batuhan Taskaya.

@item 
bpo-39220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39220}: Do not optimize annotations if “from __future__ import
annotations” is used. Patch by Pablo Galindo.

@item 
bpo-35712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35712}: Using @ref{227,,NotImplemented} in a boolean context has been
deprecated. Patch contributed by Josh Rosenberg.

@item 
bpo-22490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22490}: Don’t leak environment variable @code{__PYVENV_LAUNCHER__} into
the interpreter session on macOS.
@end itemize

@node Library<36>,Documentation<35>,Core and Builtins<36>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id328}@anchor{1987}
@subsubsection Library



@itemize -

@item 
bpo-39830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39830}: Add @ref{76a,,zipfile.Path} to @code{__all__} in the @ref{130,,zipfile}
module.

@item 
bpo-40000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40000}: Improved error messages for validation of @code{ast.Constant}
nodes. Patch by Batuhan Taskaya.

@item 
bpo-39999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39999}: @code{__module__} of the AST node classes is now set to «ast»
instead of «_ast». Added docstrings for dummy AST node classes and
deprecated attributes.

@item 
bpo-39991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39991}: @ref{c2f,,uuid.getnode()} now skips IPv6 addresses with the same
string length than a MAC address (17 characters): only use MAC addresses.

@item 
bpo-39988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39988}: Deprecated @code{ast.AugLoad} and @code{ast.AugStore} node classes
because they are no longer used.

@item 
bpo-39656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39656}: Ensure @code{bin/python3.#} is always present in virtual
environments on POSIX platforms - by Anthony Sottile.

@item 
bpo-39969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39969}: Deprecated @code{ast.Param} node class because it’s no longer
used. Patch by Batuhan Taskaya.

@item 
bpo-39360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39360}: Ensure all workers exit when finalizing a
@code{multiprocessing.Pool} implicitly via the module finalization
handlers of multiprocessing. This fixes a deadlock situation that can be
experienced when the Pool is not properly finalized via the context
manager or a call to @code{multiprocessing.Pool.terminate}. Patch by Batuhan
Taskaya and Pablo Galindo.

@item 
bpo-35370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35370}: sys.settrace(), sys.setprofile() and _lsprof.Profiler.enable()
now properly report @ref{463,,PySys_Audit()} error if «sys.setprofile» or
«sys.settrace» audit event is denied.

@item 
bpo-39936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39936}: AIX: Fix _aix_support module when the subprocess is not
available, when building Python from scratch. It now uses new private
_bootsubprocess module, rather than having two implementations depending
if subprocess is available or not. So _aix_support.aix_platform() result
is now the same if subprocess is available or not.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{67c,,collections.OrderedDict} now implements @code{|} and
@code{|=} (
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}).

@item 
bpo-39652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39652}: The column name found in @code{sqlite3.Cursor.description} is now
truncated on the first “[” only if the PARSE_COLNAMES option is set.

@item 
bpo-39915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39915}: Ensure @ref{1988,,unittest.mock.AsyncMock.await_args_list} has call
objects in the order of awaited arguments instead of using
@ref{1989,,unittest.mock.Mock.call_args} which has the last value of the call.
Patch by Karthikeyan Singaravelan.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: Updated @ref{196,,os.environ} and @ref{197,,os.environb} to support
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}’s merge (@code{|}) and update (@code{|=}) operators.

@item 
bpo-38662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38662}: The @code{ensurepip} module now invokes @code{pip} via the @code{runpy}
module. Hence it is no longer tightly coupled with the internal API of the
bundled @code{pip} version, allowing easier updates to a newer @code{pip}
version both internally and for distributors.

@item 
bpo-38075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38075}: Fix the @ref{198a,,random.Random.seed()} method when a @ref{513,,bool}
is passed as the seed.

@item 
bpo-39916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39916}: More reliable use of @code{os.scandir()} in @code{Path.glob()}. It no
longer emits a ResourceWarning when interrupted.

@item 
bpo-39850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39850}: @ref{94,,multiprocessing} now supports abstract socket addresses
(if abstract sockets are supported in the running platform). When creating
arbitrary addresses (like when default-constructing
@ref{16b3,,multiprocessing.connection.Listener} objects) abstract sockets are
preferred to avoid the case when the temporary-file-generated address is
too large for an AF_UNIX socket address. Patch by Pablo Galindo.

@item 
bpo-36287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36287}: @ref{97b,,ast.dump()} no longer outputs optional fields and
attributes with default values. The default values for optional fields and
attributes of AST nodes are now set as class attributes (e.g.
@code{Constant.kind} is set to @code{None}).

@item 
bpo-39889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39889}: Fixed @ref{97c,,ast.unparse()} for extended slices containing a
single element (e.g. @code{a[i:j,]}). Remove redundant tuples when index with
a tuple (e.g. @code{a[i, j]}).

@item 
bpo-39828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39828}: Fix @ref{83,,json.tool} to catch @ref{10d8,,BrokenPipeError}. Patch by
Donghee Na.

@item 
bpo-13487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13487}: Avoid a possible `«RuntimeError: dictionary changed size during
iteration»' from @ref{17eb,,inspect.getmodule()} when it tried to loop through
@ref{1976,,sys.modules}.

@item 
bpo-39674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39674}: Revert «bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: open() no longer accept “U” in file mode».
The «U» mode of open() is kept in Python 3.9 to ease transition from
Python 2.7, but will be removed in Python 3.10.

@item 
bpo-28577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28577}: The hosts method on 32-bit prefix length IPv4Networks and
128-bit prefix IPv6Networks now returns a list containing the single
Address instead of an empty list.

@item 
bpo-39826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39826}: Add getConnection method to logging HTTPHandler to enable
custom connections.

@item 
bpo-39763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39763}: Reimplement @code{distutils.spawn.spawn} function with the
@ref{d6,,subprocess} module.

@item 
bpo-39794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39794}: Add –without-decimal-contextvar build option.  This enables a
thread-local rather than a coroutine local context.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{122a,,collections.defaultdict} now implements @code{|}
(
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}).

@item 
bpo-39517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39517}: Fix runpy.run_path() when using pathlike objects

@item 
bpo-39775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39775}: Change @code{inspect.Signature.parameters} back to
@code{collections.OrderedDict}. This was changed to @code{dict} in Python
3.9.0a4.

@item 
bpo-39678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39678}: Refactor queue_manager in
@ref{163,,concurrent.futures.ProcessPoolExecutor} to make it easier to
maintain.

@item 
bpo-39764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39764}: Fix AttributeError when calling get_stack on a PyAsyncGenObject
Task

@item 
bpo-39769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39769}: The @ref{baf,,compileall.compile_dir()} function’s `ddir' parameter
and the compileall command line flag @code{-d} no longer write the wrong
pathname to the generated pyc file for submodules beneath the root of the
directory tree being compiled.  This fixes a regression introduced with
Python 3.5.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{518,,types.MappingProxyType} objects now support the merge
(@code{|}) operator from 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@item 
bpo-38691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38691}: The @ref{77,,importlib} module now ignores the
@geindex PYTHONCASEOK
@geindex variables de entorno; PYTHONCASEOK
@ref{9ef,,PYTHONCASEOK} environment variable when the @ref{9f0,,-E} or
@ref{9f1,,-I} command line options are being used.

@item 
bpo-39719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39719}: Remove @code{tempfile.SpooledTemporaryFile.softspace()} as files
no longer have the @code{softspace} attribute in Python 3. Patch by Shantanu.

@item 
bpo-39667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39667}: Improve pathlib.Path compatibility on zipfile.Path and correct
performance degradation as found in zipp 3.0.

@item 
bpo-39638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39638}: Keep ASDL signatures in the docstrings for @code{AST} nodes. Patch
by Batuhan Taskaya

@item 
bpo-39639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39639}: Deprecated @code{ast.Suite} node class because it’s no longer
used. Patch by Batuhan Taskaya.

@item 
bpo-39609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39609}: Add thread_name_prefix to default asyncio executor

@item 
bpo-39548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39548}: Fix handling of header in
@ref{198b,,urllib.request.AbstractDigestAuthHandler} when the optional
@code{qop} parameter is not present.

@item 
bpo-39509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39509}: HTTP status codes @code{103 EARLY_HINTS} and @code{425 TOO_EARLY} are
added to @ref{996,,http.HTTPStatus}. Patch by Donghee Na.

@item 
bpo-39507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39507}: Adding HTTP status 418 «I’m a Teapot» to HTTPStatus in http
library. Patch by Ross Rhodes.

@item 
bpo-39495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39495}: Remove default value from `attrs' parameter of
@ref{198c,,xml.etree.ElementTree.TreeBuilder.start()} for consistency between
Python and C implementations.

@item 
bpo-38971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38971}: Open issue in the BPO indicated a desire to make the
implementation of codecs.open() at parity with io.open(), which implements
a try/except to assure file stream gets closed before an exception is
raised.

@item 
bpo-38641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38641}: Added starred expressions support to @code{return} and @code{yield}
statements for @code{lib2to3}. Patch by Vlad Emelianov.

@item 
bpo-37534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37534}: When using minidom module to generate XML documents the ability
to add Standalone Document Declaration is added. All the changes are made
to generate a document in compliance with Extensible Markup Language (XML)
1.0 (Fifth Edition) W3C Recommendation (available here:
@indicateurl{https://www.w3.org/TR/xml/#sec-prolog-dtd}).

@item 
bpo-34788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34788}: Add support for scoped IPv6 addresses to @ref{80,,ipaddress}.
Patch by Oleksandr Pavliuk.

@item 
bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}: Simplified AST for subscription. Simple indices are now
represented by their value, extended slices are represented as tuples.
@ref{9,,ast} classes @code{Index} and @code{ExtSlice} are considered deprecated
and will be removed in future Python versions. In the meantime,
@code{Index(value)} now returns a @code{value} itself, @code{ExtSlice(slices)}
returns @code{Tuple(slices, Load())}.
@end itemize

@node Documentation<35>,Tests<35>,Library<36>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id329}@anchor{198d}
@subsubsection Documentation



@itemize -

@item 
bpo-39868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39868}: Updated the Language Reference for 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}.

@item 
bpo-13790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13790}: Change “string” to “specification” in format doc.

@item 
bpo-17422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17422}: The language reference no longer restricts default class
namespaces to dicts only.

@item 
bpo-39530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39530}: Fix misleading documentation about mixed-type numeric
comparisons.

@item 
bpo-39718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39718}: Update @ref{fa,,token} documentation to reflect additions in
Python 3.8

@item 
bpo-39677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39677}: Changed operand name of `MAKE_FUNCTION' from `argc' to
`flags' for module @ref{39,,dis}
@end itemize

@node Tests<35>,Build<36>,Documentation<35>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id330}@anchor{198e}
@subsubsection Tests



@itemize -

@item 
bpo-40019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40019}: test_gdb now skips tests if it detects that gdb failed to read
debug information because the Python binary is optimized.

@item 
bpo-27807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27807}: @code{test_site.test_startup_imports()} is now skipped if a path
of @ref{27e,,sys.path} contains a @code{.pth} file.

@item 
bpo-26067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26067}: Do not fail test_shutil test_chown test when uid or gid of user
cannot be resolved to a name.

@item 
bpo-39855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39855}: test_subprocess.test_user() now skips the test on an user name
if the user name doesn’t exist. For example, skip the test if the user
«nobody» doesn’t exist on Linux.
@end itemize

@node Build<36>,Windows<35>,Tests<35>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id331}@anchor{198f}
@subsubsection Build



@itemize -

@item 
bpo-39761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39761}: Fix build with DTrace but without additional DFLAGS.

@item 
bpo-39763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39763}: setup.py now uses a basic implementation of the
@ref{d6,,subprocess} module if the @ref{d6,,subprocess} module is not available:
before required C extension modules are built.

@item 
bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}: Add @code{--with-platlibdir} option to the configure script:
name of the platform-specific library directory, stored in the new
@ref{9cb,,sys.platlibdir} attribute. It is used to build the path of
platform-specific extension modules and the path of the standard library.
It is equal to @code{"lib"} on most platforms. On Fedora and SuSE, it is
equal to @code{"lib64"} on 64-bit platforms. Patch by Jan Matějek, Matěj
Cepl, Charalampos Stratakis and Victor Stinner.
@end itemize

@node Windows<35>,macOS<30>,Build<36>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id332}@anchor{1990}
@subsubsection Windows



@itemize -

@item 
bpo-39930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39930}: Ensures the required @code{vcruntime140.dll} is included in
install packages.

@item 
bpo-39847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39847}: Avoid hang when computer is hibernated whilst waiting for a
mutex (for lock-related objects from @ref{ed,,threading}) around 49-day
uptime.

@item 
bpo-38597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38597}: @code{distutils} will no longer statically link
@code{vcruntime140.dll} when a redistributable version is unavailable.
All future releases of CPython will include a copy of this DLL to ensure
distributed extensions can continue to load.

@item 
bpo-38380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38380}: Update Windows builds to use SQLite 3.31.1

@item 
bpo-39789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39789}: Update Windows release build machines to Visual Studio 2019
(MSVC 14.2).

@item 
bpo-34803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34803}: Package for nuget.org now includes repository reference and
bundled icon image.
@end itemize

@node macOS<30>,IDLE<24>,Windows<35>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id333}@anchor{1991}
@subsubsection macOS



@itemize -

@item 
bpo-38380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38380}: Update macOS builds to use SQLite 3.31.1
@end itemize

@node IDLE<24>,Tools/Demos<19>,macOS<30>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id334}@anchor{1992}
@subsubsection IDLE



@itemize -

@item 
bpo-27115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27115}: For “Go to Line”, use a Query box subclass with IDLE standard
behavior and improved error checking.

@item 
bpo-39885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39885}: Since clicking to get an IDLE context menu moves the cursor,
any text selection should be and now is cleared.

@item 
bpo-39852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39852}: Edit «Go to line» now clears any selection, preventing
accidental deletion. It also updates Ln and Col on the status bar.

@item 
bpo-39781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39781}: Selecting code context lines no longer causes a jump.
@end itemize

@node Tools/Demos<19>,C API<35>,IDLE<24>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id335}@anchor{1993}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-36184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36184}: Port python-gdb.py to FreeBSD. python-gdb.py now checks for
«take_gil» function name to check if a frame tries to acquire the GIL,
instead of checking for «pthread_cond_timedwait» which is specific to
Linux and can be a different condition than the GIL.

@item 
bpo-38080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38080}: Added support to fix @code{getproxies} in the
@code{lib2to3.fixes.fix_urllib} module. Patch by José Roberto Meza
Cabrera.
@end itemize

@node C API<35>,,Tools/Demos<19>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id336}@anchor{1994}
@subsubsection C API



@itemize -

@item 
bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024}: Add @ref{a07,,PyModule_AddType()} helper function: add a type to a
module. Patch by Donghee Na.

@item 
bpo-39946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39946}: Remove @code{_PyRuntime.getframe} hook and remove
@code{_PyThreadState_GetFrame} macro which was an alias to
@code{_PyRuntime.getframe}. They were only exposed by the internal C API.
Remove also @code{PyThreadFrameGetter} type.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Add @ref{827,,PyThreadState_GetFrame()} function: get the current
frame of a Python thread state.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Add _PyArg_NoKwnames helper function. Patch by Donghee Na.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Add @ref{a03,,PyThreadState_GetInterpreter()}: get the interpreter
of a Python thread state.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Add @ref{4a0,,PyInterpreterState_Get()} function to the limited C
API.

@item 
bpo-35370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35370}: If @ref{463,,PySys_Audit()} fails in @ref{153d,,PyEval_SetProfile()}
or @ref{153e,,PyEval_SetTrace()}, log the error as an unraisable exception.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Move the static inline function flavor of
Py_EnterRecursiveCall() and Py_LeaveRecursiveCall() to the internal C API:
they access PyThreadState attributes. The limited C API provides regular
functions which hide implementation details.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Py_TRASHCAN_BEGIN_CONDITION and Py_TRASHCAN_END macro no longer
access PyThreadState attributes, but call new private _PyTrash_begin() and
_PyTrash_end() functions which hide implementation details.

@item 
bpo-39884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39884}: @ref{1995,,PyDescr_NewMethod()} and @ref{1996,,PyCFunction_NewEx()} now
include the method name in the SystemError «bad call flags» error message
to ease debug.

@item 
bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}: Deprecated @code{PyEval_InitThreads()} and
@code{PyEval_ThreadsInitialized()}. Calling
@code{PyEval_InitThreads()} now does nothing.

@item 
bpo-38249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38249}: @ref{c3d,,Py_UNREACHABLE} is now implemented with
@code{__builtin_unreachable()} and analogs in release mode.

@item 
bpo-38643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38643}: @ref{17f1,,PyNumber_ToBase()} now raises a @ref{619,,SystemError}
instead of crashing when called with invalid base.

@item 
bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882}: The @ref{a15,,Py_FatalError()} function is replaced with a macro
which logs automatically the name of the current function, unless the
@code{Py_LIMITED_API} macro is defined.

@item 
bpo-39824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39824}: Extension modules: @ref{a0c,,m_traverse},
@ref{a0d,,m_clear} and @ref{a0e,,m_free}
functions of @ref{a0f,,PyModuleDef} are no longer called if the module
state was requested but is not allocated yet. This is the case immediately
after the module is created and before the module is executed
(@ref{a10,,Py_mod_exec} function). More precisely, these functions are not
called if @ref{a11,,m_size} is greater than 0 and the module
state (as returned by @ref{a12,,PyModule_GetState()}) is @code{NULL}.

Extension modules without module state (@code{m_size <= 0}) are not affected.

@item 
bpo-38913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38913}: Fixed segfault in @code{Py_BuildValue()} called with a format
containing «#» and undefined PY_SSIZE_T_CLEAN whwn an exception is set.

@item 
bpo-38500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38500}: Add a private API to get and set the frame evaluation function:
add @ref{1997,,_PyInterpreterState_GetEvalFrameFunc()} and
@ref{1998,,_PyInterpreterState_SetEvalFrameFunc()} C functions. The
@ref{810,,_PyFrameEvalFunction} function type now takes a `tstate'
parameter.
@end itemize

@node Python 3 9 0 alpha 4,Python 3 9 0 alpha 3,Python 3 9 0 alpha 5,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-4}@anchor{1999}
@subsection Python 3.9.0 alpha 4


`Release date: 2020-02-25'

@menu
* Security: Security<26>. 
* Core and Builtins: Core and Builtins<37>. 
* Library: Library<37>. 
* Documentation: Documentation<36>. 
* Tests: Tests<36>. 
* Build: Build<37>. 
* Windows: Windows<36>. 
* IDLE: IDLE<25>. 
* C API: C API<36>. 

@end menu

@node Security<26>,Core and Builtins<37>,,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id337}@anchor{199a}
@subsubsection Security



@itemize -

@item 
bpo-39184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39184}: Add audit events to functions in @code{fcntl}, @code{msvcrt}, @code{os},
@code{resource}, @code{shutil}, @code{signal} and @code{syslog}.

@item 
bpo-39401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39401}: Avoid unsafe DLL load at startup on Windows 7 and earlier.

@item 
bpo-39184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39184}: Add audit events to command execution functions in os and pty
modules.
@end itemize

@node Core and Builtins<37>,Library<37>,Security<26>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id338}@anchor{199b}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-39382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39382}: Fix a use-after-free in the single inheritance path of
@code{issubclass()}, when the @code{__bases__} of an object has a single
reference, and so does its first item. Patch by Yonatan Goldschmidt.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Update clinic tool to use @ref{181c,,Py_IS_TYPE()}. Patch by
Donghee Na.

@item 
bpo-39619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39619}: Enable use of @ref{199c,,os.chroot()} on HP-UX systems.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add @ref{181c,,Py_IS_TYPE()} static inline function to check
whether the object `o' type is `type'.

@item 
bpo-39606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39606}: Fix regression caused by fix for bpo-39386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39386}, that prevented
calling @code{aclose} on an async generator that had already been closed or
exhausted.

@item 
bpo-39579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39579}: Change the ending column offset of @code{Attribute} nodes
constructed in @code{ast_for_dotted_name} to point at the end of the current
node and not at the end of the last @code{NAME} node.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _crypt extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _contextvars extension module to multiphase
initialization (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39510}: Fix segfault in @code{readinto()} method on closed BufferedReader.

@item 
bpo-39502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39502}: Fix @ref{1539,,time.localtime()} on 64-bit AIX  to support years
before 1902 and after 2038. Patch by M Felt.

@item 
bpo-39492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39492}: Fix a reference cycle in the C Pickler that was preventing the
garbage collection of deleted, pickled objects.

@item 
bpo-39453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39453}: Fixed a possible crash in @code{list.__contains__()} when a list
is changed during comparing items. Patch by Donghee Na.

@item 
bpo-39434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39434}: @ref{9d7,,floor division} of float operation now has a better
performance. Also the message of @ref{9d8,,ZeroDivisionError} for this
operation is updated. Patch by Donghee Na.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _codecs extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _bz2 extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _abc extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39320}: Replace two complex bytecodes for building dicts with two
simpler ones. The new bytecodes @code{DICT_MERGE} and @code{DICT_UPDATE} have
been added The old bytecodes @code{BUILD_MAP_UNPACK} and
@code{BUILD_MAP_UNPACK_WITH_CALL} have been removed.

@item 
bpo-39219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39219}: Syntax errors raised in the tokenizer now always set correct
«text» and «offset» attributes.

@item 
bpo-36051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36051}: Drop the GIL during large @code{bytes.join} operations. Patch by
Bruce Merry.

@item 
bpo-38960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38960}: Fix DTrace build issues on FreeBSD. Patch by David Carlier.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: Speed up calls to @code{range()} by about 30%, by using the PEP
590 @code{vectorcall} calling convention. Patch by Mark Shannon.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{190,,dict} (and @ref{199d,,collections.UserDict}) objects now
support PEP 584’s merge (@code{|}) and update (@code{|=}) operators. Patch by
Brandt Bucher.

@item 
bpo-32856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32856}: Optimized the idiom for assignment a temporary variable in
comprehensions. Now @code{for y in [expr]} in comprehensions is as fast as a
simple assignment @code{y = expr}.
@end itemize

@node Library<37>,Documentation<36>,Core and Builtins<37>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id339}@anchor{199e}
@subsubsection Library



@itemize -

@item 
bpo-30566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30566}: Fix @ref{1575,,IndexError} when trying to decode an invalid string
with punycode codec.

@item 
bpo-39649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39649}: Remove obsolete check for @code{__args__} in
@code{bdb.Bdb.format_stack_entry}.

@item 
bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648}: Expanded @ref{9a6,,math.gcd()} and @ref{9a7,,math.lcm()} to handle
multiple arguments.

@item 
bpo-39681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39681}: Fix a regression where the C pickle module wouldn’t allow
unpickling from a file-like object that doesn’t expose a readinto()
method.

@item 
bpo-35950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35950}: Raise @ref{199f,,io.UnsupportedOperation} in
@code{io.BufferedReader.truncate()} when it is called on a read-only
@ref{127b,,io.BufferedReader} instance.

@item 
bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479}: Add @ref{9a7,,math.lcm()} function: least common multiple.

@item 
bpo-39674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39674}: Revert «Do not expose abstract collection classes in the
collections module» change (bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}). Aliases to ABC like
collections.Mapping are kept in Python 3.9 to ease transition from Python
2.7, but will be removed in Python 3.10.

@item 
bpo-39104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39104}: Fix hanging ProcessPoolExcutor on @code{shutdown(wait=False)} when
a task has failed pickling.

@item 
bpo-39627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39627}: Fixed TypedDict totality check for inherited keys.

@item 
bpo-39474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39474}: Fixed starting position of AST for expressions like @code{(a)(b)},
@code{(a)[b]} and @code{(a).b}.

@item 
bpo-21016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21016}: The @ref{b5,,pydoc} and @ref{fd,,trace} modules now use the
@ref{db,,sysconfig} module to get the path to the Python standard library, to
support uncommon installation path like @code{/usr/lib64/python3.9/} on
Fedora. Patch by Jan Matějek.

@item 
bpo-39590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39590}: Collections.deque now holds strong references during
deque.__contains__ and deque.count, fixing crashes.

@item 
bpo-39586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39586}: The distutils @code{bdist_msi} command is deprecated in Python
3.9, use @code{bdist_wheel} (wheel packages) instead.

@item 
bpo-39595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39595}: Improved performance of zipfile.Path for files with a large
number of entries. Also improved performance and fixed minor issue as
published with importlib_metadata 1.5@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html#v1-5-0}.

@item 
bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}: Fix regression in @ref{177,,fractions.Fraction} if the numerator
and/or the denominator is an @ref{1f0,,int} subclass. The @ref{9a6,,math.gcd()}
function is now used to normalize the `numerator' and `denominator'.
@ref{9a6,,math.gcd()} always return a @ref{1f0,,int} type. Previously, the GCD
type depended on `numerator' and `denominator'.

@item 
bpo-39567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39567}: Added audit for @ref{551,,os.walk()}, @ref{be3,,os.fwalk()},
@ref{388,,pathlib.Path.glob()} and @ref{389,,pathlib.Path.rglob()}.

@item 
bpo-39559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39559}: Remove unused, undocumented argument @code{getters} from
@ref{c2f,,uuid.getnode()}

@item 
bpo-38149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38149}: @ref{15af,,sys.audit()} is now called only once per call of
@ref{3ef,,glob.glob()} and @ref{89e,,glob.iglob()}.

@item 
bpo-39546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39546}: Fix a regression in @ref{15c,,ArgumentParser} where
@code{allow_abbrev=False} was ignored for long options that used a prefix
character other than «-«.

@item 
bpo-39450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39450}: Striped whitespace from docstring before returning it from
@code{unittest.case.shortDescription()}.

@item 
bpo-12915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12915}: A new function @code{resolve_name} has been added to the
@code{pkgutil} module. This resolves a string of the form @code{'a.b.c.d'} or
@code{'a.b:c.d'} to an object. In the example, @code{a.b} is a package/module
and @code{c.d} is an object within that package/module reached via recursive
attribute access.

@item 
bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}: The @ref{7d0,,binascii.crc_hqx()} function is no longer deprecated.

@item 
bpo-39493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39493}: Mark @code{typing.IO.closed} as a property

@item 
bpo-39491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39491}: Add @ref{9d0,,typing.Annotated} and @code{include_extras} parameter
to @ref{752,,typing.get_type_hints()} as part of 
@geindex Python Enhancement Proposals; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}. Patch by Till
Varoquaux, documentation by Till Varoquaux and Konstantin Kashin.

@item 
bpo-39485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39485}: Fix a bug in @ref{15c9,,unittest.mock.create_autospec()} that would
complain about the wrong number of arguments for custom descriptors
defined in an extension module returning functions.

@item 
bpo-38932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38932}: Mock fully resets child objects on reset_mock(). Patch by
Vegard Stikbakke

@item 
bpo-39082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39082}: Allow AsyncMock to correctly patch static/class methods

@item 
bpo-39432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39432}: Implement PEP-489 algorithm for non-ascii «PyInit_…» symbol
names in distutils to make it export the correct init symbol also on
Windows.

@item 
bpo-18819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18819}: Omit @code{devmajor} and @code{devminor} fields for non-device files
in @ref{de,,tarfile} archives, enabling bit-for-bit compatibility with GNU
@code{tar(1)}.

@item 
bpo-39349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39349}: Added a new `cancel_futures' parameter to
@ref{984,,concurrent.futures.Executor.shutdown()} that cancels all pending
futures which have not started running, instead of waiting for them to
complete before shutting down the executor.

@item 
bpo-39274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39274}: @code{bool(fraction.Fraction)} now returns a boolean even if
(numerator != 0) does not return a boolean (ex: numpy number).

@item 
bpo-34793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34793}: Remove support for @code{with (await asyncio.lock):} and @code{with
(yield from asyncio.lock):}.  The same is correct for
@code{asyncio.Condition} and @code{asyncio.Semaphore}.

@item 
bpo-25597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25597}: Ensure, if @code{wraps} is supplied to
@ref{f12,,unittest.mock.MagicMock}, it is used to calculate return values
for the magic methods instead of using the default return values. Patch by
Karthikeyan Singaravelan.

@item 
bpo-36350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36350}: @code{inspect.Signature.parameters} and
@code{inspect.BoundArguments.arguments} are now dicts instead of
OrderedDicts. Patch contributed by Rémi Lapeyre.

@item 
bpo-35727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35727}: Fix sys.exit() and sys.exit(None) exit code propagation when
used in multiprocessing.Process.

@item 
bpo-32173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32173}: * Add @code{lazycache} function to @code{__all__}. * Use
@code{dict.clear} to clear the cache. * Refactoring @code{getline} function and
@code{checkcache} function.
@end itemize

@node Documentation<36>,Tests<36>,Library<37>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id340}@anchor{19a0}
@subsubsection Documentation



@itemize -

@item 
bpo-17422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17422}: The language reference now specifies restrictions on class
namespaces. Adapted from a patch by Ethan Furman.

@item 
bpo-39572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39572}: Updated documentation of @code{total} flag of @code{TypedDict}.

@item 
bpo-39654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39654}: In pyclbr doc, update “class” to “module” where appropriate and
add readmodule comment. Patch by Hakan Çelik.

@item 
bpo-39153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39153}: Clarify refcounting semantics for the following functions: -
PyObject_SetItem - PyMapping_SetItemString - PyDict_SetItem -
PyDict_SetItemString

@item 
bpo-39392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39392}: Explain that when filling with turtle, overlap regions may be
left unfilled.

@item 
bpo-39369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39369}: Update mmap readline method description. The fact that the
readline method does update the file position should not be ignored since
this might give the impression for the programmer that it doesn’t update
it.

@item 
bpo-9056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9056}: Include subsection in TOC for PDF version of docs.
@end itemize

@node Tests<36>,Build<37>,Documentation<36>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id341}@anchor{19a1}
@subsubsection Tests



@itemize -

@item 
bpo-38325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38325}: Skip tests on non-BMP characters of test_winconsoleio.

@item 
bpo-39502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39502}: Skip test_zipfile.test_add_file_after_2107() if
@ref{1539,,time.localtime()} fails with @ref{919,,OverflowError}. It is the case on
AIX 6.1 for example.
@end itemize

@node Build<37>,Windows<36>,Tests<36>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id342}@anchor{19a2}
@subsubsection Build



@itemize -

@item 
bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}: Remove @code{COUNT_ALLOCS} special build.
@end itemize

@node Windows<36>,IDLE<25>,Build<37>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id343}@anchor{19a3}
@subsubsection Windows



@itemize -

@item 
bpo-39553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39553}: Delete unused code related to SxS manifests.

@item 
bpo-39439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39439}: Honor the Python path when a virtualenv is active on Windows.

@item 
bpo-39393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39393}: Improve the error message when attempting to load a DLL with
unresolved dependencies.

@item 
bpo-38883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38883}: @ref{ec8,,home()} and @ref{ec7,,expanduser()}
on Windows now prefer 
@geindex USERPROFILE
@geindex variables de entorno; USERPROFILE
@code{USERPROFILE} and no longer use
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME}, which is not normally set for regular user accounts. This
makes them again behave like @ref{aa6,,os.path.expanduser()}, which was changed
to ignore 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME} in 3.8, see bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}.

@item 
bpo-39185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39185}: The build.bat script has additional options for very-quiet
output (-q) and very-verbose output (-vv)
@end itemize

@node IDLE<25>,C API<36>,Windows<36>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id344}@anchor{19a4}
@subsubsection IDLE



@itemize -

@item 
bpo-39663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39663}: Add tests for pyparse find_good_parse_start().

@item 
bpo-39600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39600}: In the font configuration window, remove duplicated font names.

@item 
bpo-30780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30780}: Add remaining configdialog tests for buttons and highlights and
keys tabs.

@item 
bpo-39388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39388}: IDLE Settings Cancel button now cancels pending changes

@item 
bpo-38792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38792}: Close an IDLE shell calltip if a @ref{a63,,KeyboardInterrupt} or
shell restart occurs.  Patch by Zackery Spytz.
@end itemize

@node C API<36>,,IDLE<25>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id345}@anchor{19a5}
@subsubsection C API



@itemize -

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: Move the @code{bytes_methods.h} header file to the internal C API
as @code{pycore_bytes_methods.h}: it only contains private symbols (prefixed
by @code{_Py}), except of the @code{PyDoc_STRVAR_shared()} macro.

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: Move the @code{dtoa.h} header file to the internal C API as
@code{pycore_dtoa.h}: it only contains private functions (prefixed by
@code{_Py}). The @ref{8e,,math} and @ref{19,,cmath} modules must now be compiled
with the @code{Py_BUILD_CORE} macro defined.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add @ref{81c,,Py_SET_SIZE()} function to set the size of an
object.

@item 
bpo-39500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39500}: @ref{19a6,,PyUnicode_IsIdentifier()} does not call
@ref{a15,,Py_FatalError()} anymore if the string is not ready.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add @ref{81a,,Py_SET_TYPE()} function to set the type of an
object.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add a @ref{942,,Py_SET_REFCNT()} function to set the reference
counter of an object.

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: Convert @ref{195d,,PyType_HasFeature()}, @ref{19a7,,PyType_Check()} and
@ref{19a8,,PyType_CheckExact()} macros to static inline functions.

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: In the limited C API, @code{PyObject_INIT()} and
@code{PyObject_INIT_VAR()} are now defined as aliases to
@ref{afa,,PyObject_Init()} and @ref{195f,,PyObject_InitVar()} to make their
implementation opaque. It avoids to leak implementation details in the
limited C API. Exclude the following functions from the limited C API:
@code{_Py_NewReference()}, @code{_Py_ForgetReference()},
@code{_PyTraceMalloc_NewReference()} and @code{_Py_GetRefTotal()}.

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: Exclude trashcan mechanism from the limited C API: it requires
access to PyTypeObject and PyThreadState structure fields, whereas these
structures are opaque in the limited C API.

@item 
bpo-39511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39511}: The @ref{1628,,PyThreadState_Clear()} function now calls the
@code{PyThreadState.on_delete} callback. Previously, that happened in
@ref{19a9,,PyThreadState_Delete()}.

@item 
bpo-38076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38076}: Fix to clear the interpreter state only after clearing module
globals to guarantee module state access from C Extensions during runtime
destruction

@item 
bpo-39245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39245}: The Vectorcall API (PEP 590) was made public, adding the
functions @code{PyObject_Vectorcall}, @code{PyObject_VectorcallMethod},
@code{PyVectorcall_Function}, @code{PyObject_CallOneArg},
@code{PyObject_CallMethodNoArgs}, @code{PyObject_CallMethodOneArg},
@code{PyObject_FastCallDict}, and the flag @code{Py_TPFLAGS_HAVE_VECTORCALL}.
@end itemize

@node Python 3 9 0 alpha 3,Python 3 9 0 alpha 2,Python 3 9 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-3}@anchor{19aa}
@subsection Python 3.9.0 alpha 3


`Release date: 2020-01-24'

@menu
* Core and Builtins: Core and Builtins<38>. 
* Library: Library<38>. 
* Documentation: Documentation<37>. 
* Build: Build<38>. 
* IDLE: IDLE<26>. 
* C API: C API<37>. 

@end menu

@node Core and Builtins<38>,Library<38>,,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id346}@anchor{19ab}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-39427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39427}: Document all possibilities for the @code{-X} options in the
command line help section. Patch by Pablo Galindo.

@item 
bpo-39421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39421}: Fix possible crashes when operating with the functions in the
@ref{69,,heapq} module and custom comparison operators.

@item 
bpo-39386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39386}: Prevent double awaiting of async iterator.

@item 
bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}: Add @code{functools.TopologicalSorter} to the
@ref{5f,,functools} module to offers functionality to perform topological
sorting of graphs. Patch by Pablo Galindo, Tim Peters and Larry Hastings.

@item 
bpo-39320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39320}: Replace four complex bytecodes for building sequences with
three simpler ones.

The following four bytecodes have been removed:


@itemize *

@item 
BUILD_LIST_UNPACK

@item 
BUILD_TUPLE_UNPACK

@item 
BUILD_SET_UNPACK

@item 
BUILD_TUPLE_UNPACK_WITH_CALL
@end itemize

The following three bytecodes have been added:


@itemize *

@item 
LIST_TO_TUPLE

@item 
LIST_EXTEND

@item 
SET_UPDATE
@end itemize

@item 
bpo-39336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39336}: Import loaders which publish immutable module objects can now
publish immutable packages in addition to individual modules.

@item 
bpo-39322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39322}: Added a new function @ref{993,,gc.is_finalized()} to check if an
object has been finalized by the garbage collector. Patch by Pablo
Galindo.

@item 
bpo-39048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39048}: Improve the displayed error message when incorrect types are
passed to @code{async with} statements by looking up the @code{__aenter__()}
special method before the @code{__aexit__()} special method when entering
an asynchronous context manager. Patch by Géry Ogam.

@item 
bpo-39235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39235}: Fix AST end location for lone generator expression in function
call, e.g. f(i for i in a).

@item 
bpo-39209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39209}: Correctly handle multi-line tokens in interactive mode. Patch
by Pablo Galindo.

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port _json extension module to multiphase initialization
(
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
bpo-39216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39216}: Fix constant folding optimization for positional only arguments
- by Anthony Sottile.

@item 
bpo-39215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39215}: Fix @code{SystemError} when nested function has annotation on
positional-only argument - by Anthony Sottile.

@item 
bpo-39200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39200}: Correct the error message when calling the @ref{f8b,,min()} or
@ref{f8c,,max()} with no arguments. Patch by Donghee Na.

@item 
bpo-39200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39200}: Correct the error message when trying to construct
@ref{9d6,,range} objects with no arguments. Patch by Pablo Galindo.

@item 
bpo-39166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39166}: Fix incorrect line execution reporting in trace functions when
tracing the last iteration of asynchronous for loops. Patch by Pablo
Galindo.

@item 
bpo-39114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39114}: Fix incorrect line execution reporting in trace functions when
tracing exception handlers with name binding. Patch by Pablo Galindo.

@item 
bpo-39156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39156}: Split the COMPARE_OP bytecode instruction into four distinct
instructions.


@itemize *

@item 
COMPARE_OP for rich comparisons

@item 
IS_OP for “is” and “is not” tests

@item 
CONTAINS_OP for “in” and “is not” tests

@item 
JUMP_IF_NOT_EXC_MATCH for checking exceptions in “try-except” statements.
@end itemize

This improves the clarity of the interpreter and should provide a modest
speedup.

@item 
bpo-38588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38588}: Fix possible crashes in dict and list when calling
@ref{19ac,,PyObject_RichCompareBool()}.

@item 
bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601}: By default, @code{sys.stderr} is line-buffered now, even if
@code{stderr} is redirected to a file. You can still make @code{sys.stderr}
unbuffered by passing the @ref{19ad,,-u} command-line option or setting the
@geindex PYTHONUNBUFFERED
@geindex variables de entorno; PYTHONUNBUFFERED
@ref{19ae,,PYTHONUNBUFFERED} environment variable.

(Contributed by Jendrik Seipp in bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601}.)

@item 
bpo-38610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38610}: Fix possible crashes in several list methods by holding strong
references to list elements when calling
@ref{19ac,,PyObject_RichCompareBool()}.

@item 
bpo-32021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32021}: Include brotli .br encoding in mimetypes encodings_map
@end itemize

@node Library<38>,Documentation<37>,Core and Builtins<38>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id347}@anchor{19af}
@subsubsection Library



@itemize -

@item 
bpo-39430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39430}: Fixed race condition in lazy imports in @ref{de,,tarfile}.

@item 
bpo-39413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39413}: The @ref{199,,os.unsetenv()} function is now also available on
Windows.

@item 
bpo-39390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39390}: Fixed a regression with the @code{ignore} callback of
@ref{abb,,shutil.copytree()}. The argument types are now @code{str} and
@code{List[str]} again.

@item 
bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}: The @ref{198,,os.putenv()} and @ref{199,,os.unsetenv()} functions are now
always available.

@item 
bpo-39406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39406}: If @code{setenv()} C function is available, @ref{198,,os.putenv()} is
now implemented with @code{setenv()} instead of @code{putenv()}, so Python
doesn’t have to handle the environment variable memory.

@item 
bpo-39396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39396}: Fix @code{math.nextafter(-0.0, +0.0)} on AIX 7.1.

@item 
bpo-29435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29435}: Allow @ref{184b,,tarfile.is_tarfile()} to be used with file and
file-like objects, like @ref{1392,,zipfile.is_zipfile()}. Patch by William
Woodruff.

@item 
bpo-39377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39377}: Removed @code{encoding} option from @ref{9e8,,json.loads()}.  It has
been deprecated since Python 3.1.

@item 
bpo-39389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39389}: Write accurate compression level metadata in @ref{67,,gzip}
archives, rather than always signaling maximum compression.

@item 
bpo-39366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39366}: The previously deprecated @code{xpath()} and @code{xgtitle()} methods
of @code{nntplib.NNTP} have been removed.

@item 
bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}: Remove the `buffering' parameter of @ref{8fd,,bz2.BZ2File}. Since
Python 3.0, it was ignored and using it was emitting
@ref{1da,,DeprecationWarning}. Pass an open file object, to control how the
file is opened. The `compresslevel' parameter becomes keyword-only.

@item 
bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}: Deprecate binhex4 and hexbin4 standards. Deprecate the
@code{binhex} module and the following @ref{11,,binascii} functions:
@code{b2a_hqx()}, @code{a2b_hqx()},
@code{rlecode_hqx()}, @code{rledecode_hqx()},
@ref{7d0,,crc_hqx()}.

@item 
bpo-39351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39351}: Remove @code{base64.encodestring()} and @code{base64.decodestring()},
aliases deprecated since Python 3.1: use @ref{9e6,,base64.encodebytes()} and
@ref{9e7,,base64.decodebytes()} instead.

@item 
bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}: Remove @code{fractions.gcd()} function, deprecated since Python
3.5 (bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}): use @ref{9a6,,math.gcd()} instead.

@item 
bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329}: @ref{9c2,,LMTP} constructor now has an optional
`timeout' parameter. Patch by Donghee Na.

@item 
bpo-39313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39313}: Add a new @code{exec_function} option (`–exec-function' in the
CLI) to @code{RefactoringTool} for making @code{exec} a function. Patch by
Batuhan Taskaya.

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @ref{991,,FTP_TLS} and @ref{991,,FTP_TLS} now raise
a @ref{360,,ValueError} if the given timeout for their constructor is zero
to prevent the creation of a non-blocking socket. Patch by Donghee Na.

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @ref{9c0,,SMTP} and @ref{9c1,,SMTP_SSL} now raise
a @ref{360,,ValueError} if the given timeout for their constructor is zero
to prevent the creation of a non-blocking socket. Patch by Donghee Na.

@item 
bpo-39310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39310}: Add @ref{9a8,,math.ulp()}: return the value of the least significant
bit of a float.

@item 
bpo-39297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39297}: Improved performance of importlib.metadata distribution
discovery and resilients to inaccessible sys.path entries
(importlib_metadata v1.4.0).

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @code{NNTP} and @code{NNTP_SSL} now raise a
@ref{360,,ValueError} if the given timeout for their constructor is zero to
prevent the creation of a non-blocking socket. Patch by Donghee Na.

@item 
bpo-38901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38901}: When you specify prompt=”.” or equivalently python -m venv
–prompt . … the basename of the current directory is used to set the
created venv’s prompt when it’s activated.

@item 
bpo-39288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39288}: Add @ref{541,,math.nextafter()}: return the next floating-point
value after `x' towards `y'.

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @ref{9b7,,POP3} and @ref{9b8,,POP3_SSL} now raise a
@ref{360,,ValueError} if the given timeout for their constructor is zero to
prevent the creation of a non-blocking socket. Patch by Donghee Na.

@item 
bpo-39242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39242}: Updated the Gmane domain from news.gmane.org to news.gmane.io
which is used for examples of @code{NNTP} news reader server and
nntplib tests.

@item 
bpo-35292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35292}: Proxy the @code{SimpleHTTPRequestHandler.guess_type} to
@code{mimetypes.guess_type} so the @code{mimetypes.init} is called lazily to
avoid unnecessary costs when @ref{72,,http.server} module is imported.

@item 
bpo-39239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39239}: The @ref{9ed,,select.epoll.unregister()} method no longer ignores
the @ref{9ee,,EBADF} error.

@item 
bpo-38907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38907}: In http.server script, restore binding to IPv4 on Windows.

@item 
bpo-39152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39152}: Fix ttk.Scale.configure([name]) to return configuration tuple
for name or all options.  Giovanni Lombardo contributed part of the patch.

@item 
bpo-39198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39198}: If an exception were to be thrown in @code{Logger.isEnabledFor}
(say, by asyncio timeouts or stopit) , the @code{logging} global lock may not
be released appropriately, resulting in deadlock.  This change wraps that
block of code with @code{try...finally} to ensure the lock is released.

@item 
bpo-39191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39191}: Perform a check for running loop before starting a new task in
@code{loop.run_until_complete()} to fail fast; it prevents the side effect of
new task spawning before exception raising.

@item 
bpo-38871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38871}: Correctly parenthesize filter-based statements that contain
lambda expressions in @code{lib2to3}. Patch by Donghee Na.

@item 
bpo-39142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39142}: A change was made to logging.config.dictConfig to avoid
converting instances of named tuples to ConvertingTuple. It’s assumed that
named tuples are too specialised to be treated like ordinary tuples; if a
user of named tuples requires ConvertingTuple functionality, they will
have to implement that themselves in their named tuple class.

@item 
bpo-39158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39158}: ast.literal_eval() now supports empty sets.

@item 
bpo-39129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39129}: Fix import path for @code{asyncio.TimeoutError}

@item 
bpo-39057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39057}: @code{urllib.request.proxy_bypass_environment()} now ignores
leading dots and no longer ignores a trailing newline.

@item 
bpo-39056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39056}: Fixed handling invalid warning category in the -W option.  No
longer import the re module if it is not needed.

@item 
bpo-39055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39055}: @ref{19b0,,base64.b64decode()} with @code{validate=True} raises now a
binascii.Error if the input ends with a single @code{\n}.

@item 
bpo-21600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21600}: Fix @code{mock.patch.stopall()} to stop active patches that were
created with @code{mock.patch.dict()}.

@item 
bpo-39019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39019}: Implement dummy @code{__class_getitem__} for
@ref{734,,tempfile.SpooledTemporaryFile}.

@item 
bpo-39019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39019}: Implement dummy @code{__class_getitem__} for @code{subprocess.Popen},
@code{subprocess.CompletedProcess}

@item 
bpo-38914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38914}: Adjusted the wording of the warning issued by distutils”
@code{check} command when the @code{author} and @code{maintainer} fields are
supplied but no corresponding e-mail field (@code{author_email} or
@code{maintainer_email}) is found. The wording now reflects the fact that
these fields are suggested, but not required. Patch by Juergen Gmach.

@item 
bpo-38878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38878}: Fixed __subclasshook__ of @ref{cd9,,os.PathLike} to return a
correct result upon inheritance. Patch by Bar Harel.

@item 
bpo-38615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38615}: @ref{999,,IMAP4} and @ref{99a,,IMAP4_SSL} now
have an optional `timeout' parameter for their constructors. Also, the
@ref{99b,,open()} method now has an optional `timeout' parameter
with this change. The overridden methods of @ref{99a,,IMAP4_SSL}
and @ref{99c,,IMAP4_stream} were applied to this change. Patch by
Donghee Na.

@item 
bpo-35182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35182}: Fixed @code{Popen.communicate()} subsequent call crash when the
child process has already closed any piped standard stream, but still
continues to be running. Patch by Andriy Maletsky.

@item 
bpo-38630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38630}: On Unix, @ref{141e,,subprocess.Popen.send_signal()} now polls the
process status. Polling reduces the risk of sending a signal to the wrong
process if the process completed, the @ref{19b1,,subprocess.Popen.returncode}
attribute is still @code{None}, and the pid has been reassigned (recycled) to
a new different process.

@item 
bpo-38536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38536}: Removes trailing space in formatted currency with
@code{international=True} and a locale with symbol following value. E.g.
@code{locale.currency(12.34, international=True)} returned @code{'12,34 EUR '}
instead of @code{'12,34 EUR'}.

@item 
bpo-38473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38473}: Use signature from inner mock for autospecced methods attached
with @code{unittest.mock.attach_mock()}. Patch by Karthikeyan Singaravelan.

@item 
bpo-38361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38361}: Fixed an issue where @code{ident} could include a leading path
separator when @ref{5e1,,syslog.openlog()} was called without arguments.

@item 
bpo-38293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38293}: Add @ref{5d7,,copy.copy()} and @ref{bf6,,copy.deepcopy()} support to
@ref{2fd,,property()} objects.

@item 
bpo-37958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37958}: Added the pstats.Stats.get_profile_dict() method to return the
profile data as a StatsProfile instance.

@item 
bpo-28367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28367}: Termios magic constants for the following baud rates:   -
B500000   - B576000   - B921600   - B1000000   - B1152000   - B1500000   -
B2000000   - B2500000   - B3000000   - B3500000   - B4000000 Patch by
Andrey Smirnov
@end itemize

@node Documentation<37>,Build<38>,Library<38>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id348}@anchor{19b2}
@subsubsection Documentation



@itemize -

@item 
bpo-39381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39381}: Mention in docs that @ref{214,,asyncio.get_event_loop()} implicitly
creates new event loop only if called from the main thread.

@item 
bpo-38918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38918}: Add an entry for @code{__module__} in the «function» & «method»
sections of the @ref{7e,,inspect} docs” @ref{19b3,,Tipos y miembros} table.

@item 
bpo-3530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3530}: In the @ref{9,,ast} module documentation, fix a misleading
@code{NodeTransformer} example and add advice on when to use the
@code{fix_missing_locations} function.
@end itemize

@node Build<38>,IDLE<26>,Documentation<37>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id349}@anchor{19b4}
@subsubsection Build



@itemize -

@item 
bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}: On non-Windows platforms, the @code{setenv()} and
@code{unsetenv()} functions are now required to build Python.

@item 
bpo-39160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39160}: Updated the documentation in @code{./configure --help} to show
default values, reference documentation where required and add additional
explanation where needed.

@item 
bpo-39144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39144}: The ctags and etags build targets both include Modules/_ctypes
and Python standard library source files.
@end itemize

@node IDLE<26>,C API<37>,Build<38>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id350}@anchor{19b5}
@subsubsection IDLE



@itemize -

@item 
bpo-39050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39050}: Make IDLE Settings dialog Help button work again.

@item 
bpo-34118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34118}: Tag memoryview, range, and tuple as classes, the same as list,
etcetera, in the library manual built-in functions list.

@item 
bpo-32989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32989}: Add tests for editor newline_and_indent_event method. Remove
dead code from pyparse find_good_parse_start method.
@end itemize

@node C API<37>,,IDLE<26>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id351}@anchor{19b6}
@subsubsection C API



@itemize -

@item 
bpo-39372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39372}: Clean header files of interfaces defined but with no
implementation. The public API symbols being removed are:
@code{_PyBytes_InsertThousandsGroupingLocale},
@code{_PyBytes_InsertThousandsGrouping}, @code{_Py_InitializeFromArgs},
@code{_Py_InitializeFromWideArgs}, @code{_PyFloat_Repr}, @code{_PyFloat_Digits},
@code{_PyFloat_DigitsInit}, @code{PyFrame_ExtendStack},
@code{_PyAIterWrapper_Type}, @code{PyNullImporter_Type}, @code{PyCmpWrapper_Type},
@code{PySortWrapper_Type}, @code{PyNoArgsFunction}.

@item 
bpo-39164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39164}: Add a private @code{_PyErr_GetExcInfo()} function to retrieve
exception information of the specified Python thread state.
@end itemize

@node Python 3 9 0 alpha 2,Python 3 9 0 alpha 1,Python 3 9 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-2}@anchor{19b7}
@subsection Python 3.9.0 alpha 2


`Release date: 2019-12-18'

@menu
* Security: Security<27>. 
* Core and Builtins: Core and Builtins<39>. 
* Library: Library<39>. 
* Documentation: Documentation<38>. 
* Tests: Tests<37>. 
* Build: Build<39>. 
* Windows: Windows<37>. 
* macOS: macOS<31>. 
* IDLE: IDLE<27>. 
* C API: C API<38>. 

@end menu

@node Security<27>,Core and Builtins<39>,,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id352}@anchor{19b8}
@subsubsection Security



@itemize -

@item 
bpo-38945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38945}: Newline characters have been escaped when performing uu
encoding to prevent them from overflowing into to content section of the
encoded file. This prevents malicious or accidental modification of data
during the decoding process.

@item 
bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}: Due to significant security concerns, the `reuse_address'
parameter of @ref{7cf,,asyncio.loop.create_datagram_endpoint()} is no longer
supported. This is because of the behavior of @code{SO_REUSEADDR} in UDP. For
more details, see the documentation for
@code{loop.create_datagram_endpoint()}. (Contributed by Kyle Stanley, Antoine
Pitrou, and Yury Selivanov in bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@item 
bpo-38804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38804}: Fixes a ReDoS vulnerability in @ref{70,,http.cookiejar}. Patch by
Ben Caller.
@end itemize

@node Core and Builtins<39>,Library<39>,Security<27>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id353}@anchor{19b9}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-39028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39028}: Slightly improve the speed of keyword argument parsing with
many kwargs by strengthening the assumption that kwargs are interned
strings.

@item 
bpo-39080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39080}: Fix the value of `end_col_offset' for Starred Expression AST
nodes when they are among the elements in the `args' attribute of Call AST
nodes.

@item 
bpo-39031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39031}: When parsing an «elif» node, lineno and col_offset of the node
now point to the «elif» keyword and not to its condition, making it
consistent with the «if» node. Patch by Lysandros Nikolaou.

@item 
bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}: In Python 3.9.0a1, sys.argv[0] was made an absolute path if a
filename was specified on the command line. Revert this change, since most
users expect sys.argv to be unmodified.

@item 
bpo-39008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39008}: @ref{463,,PySys_Audit()} now requires @code{Py_ssize_t} to be used
for size arguments in the format string, regardless of whether
@code{PY_SSIZE_T_CLEAN} was defined at include time.

@item 
bpo-38673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38673}: In REPL mode, don’t switch to PS2 if the line starts with
comment or whitespace. Based on work by Batuhan Taşkaya.

@item 
bpo-38922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38922}: Calling @code{replace} on a code object now raises the
@code{code.__new__} audit event.

@item 
bpo-38920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38920}: Add audit hooks for when @ref{8a2,,sys.excepthook()} and
@ref{355,,sys.unraisablehook()} are invoked.

@item 
bpo-38892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38892}: Improve documentation for audit events table and functions.

@item 
bpo-38852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38852}: Set the thread stack size to 8 Mb for debug builds on android
platforms.

@item 
bpo-38858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38858}: Each Python subinterpreter now has its own «small integer
singletons»: numbers in [-5; 257] range. It is no longer possible to
change the number of small integers at build time by overriding
@code{NSMALLNEGINTS} and @code{NSMALLPOSINTS} macros: macros should now be
modified manually in @code{pycore_pystate.h} header file.

@item 
bpo-36854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36854}: The garbage collector state becomes per interpreter
(@code{PyInterpreterState.gc}), rather than being global
(@code{_PyRuntimeState.gc}).

@item 
bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}: The @code{PyFPE_START_PROTECT()} and @code{PyFPE_END_PROTECT()}
macros are empty: they have been doing nothing for the last year, so stop
using them.

@item 
bpo-38328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38328}: Sped up the creation time of constant @ref{18e,,list} and
@ref{67a,,set} displays. Patch by Brandt Bucher.

@item 
bpo-38707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38707}: @code{MainThread.native_id} is now correctly reset in child
processes spawned using @ref{be1,,multiprocessing.Process}, instead of
retaining the parent’s value.

@item 
bpo-38629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38629}: Added @code{__floor__} and @code{__ceil__} methods to float object.
Patch by Batuhan Taşkaya.

@item 
bpo-27145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27145}: int + int and int - int operators can now return small integer
singletons. Patch by hongweipeng.

@item 
bpo-38021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38021}: Provide a platform tag for AIX that is sufficient for PEP425
binary distribution identification. Patch by Michael Felt.

@item 
bpo-35409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35409}: Ignore GeneratorExit exceptions when throwing an exception into
the aclose coroutine of an asynchronous generator.

@item 
bpo-33387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33387}: Removed WITH_CLEANUP_START, WITH_CLEANUP_FINISH, BEGIN_FINALLY,
END_FINALLY, CALL_FINALLY and POP_FINALLY bytecodes. Replaced with RERAISE
and WITH_EXCEPT_START bytecodes. The compiler now generates different code
for exceptional and non-exceptional branches for “with” and “try-except”
statements. For “try-finally” statements the “finally” block is replicated
for each exit from the “try” body.
@end itemize

@node Library<39>,Documentation<38>,Core and Builtins<39>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id354}@anchor{19ba}
@subsubsection Library



@itemize -

@item 
bpo-39033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39033}: Fix @ref{4ec,,NameError} in @ref{131,,zipimport}. Patch by Karthikeyan
Singaravelan.

@item 
bpo-39022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39022}: Update importlib.metadata to include improvements from
importlib_metadata 1.3 including better serialization of EntryPoints and
improved documentation for custom finders.

@item 
bpo-39006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39006}: Fix asyncio when the ssl module is missing: only check for
ssl.SSLSocket instance if the ssl module is available.

@item 
bpo-38708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38708}: Fix a potential IndexError in email parser when parsing an
empty msg-id.

@item 
bpo-38698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38698}: Add a new @code{InvalidMessageID} token to email parser to
represent invalid Message-ID headers.  Also, add defects when there is
remaining value after parsing the header.

@item 
bpo-38994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38994}: Implement @code{__class_getitem__} for @code{os.PathLike},
@code{pathlib.Path}.

@item 
bpo-38979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38979}: Return class from @code{ContextVar.__class_getitem__} to simplify
subclassing.

@item 
bpo-38978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38978}: Implement @code{__class_getitem__} on asyncio objects (Future,
Task, Queue). Patch by Batuhan Taskaya.

@item 
bpo-38916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38916}: @ref{308,,array.array}: Remove @code{tostring()} and
@code{fromstring()} methods. They were aliases to @code{tobytes()} and
@code{frombytes()}, deprecated since Python 3.2.

@item 
bpo-38986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38986}: Make repr of C accelerated TaskWakeupMethWrapper the same as of
pure Python version.

@item 
bpo-38982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38982}: Fix asyncio @code{PidfdChildWatcher}: handle @code{waitpid()} error.
If @code{waitpid()} is called elsewhere, @code{waitpid()} call fails with
@ref{10d4,,ChildProcessError}: use return code 255 in this case, and log a
warning. It ensures that the pidfd file descriptor is closed if this error
occurs.

@item 
bpo-38529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38529}: Drop too noisy asyncio warning about deletion of a stream
without explicit @code{.close()} call.

@item 
bpo-27413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27413}: Added ability to pass through @code{ensure_ascii} options to
json.dumps in the @code{json.tool} command-line interface.

@item 
bpo-38634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38634}: The @ref{ba,,readline} module now detects if Python is linked to
libedit at runtime on all platforms.  Previously, the check was only done
on macOS.

@item 
bpo-33684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33684}: Fix @code{json.tool} failed to read a JSON file with non-ASCII
characters when locale encoding is not UTF-8.

@item 
bpo-38698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38698}: Prevent UnboundLocalError to pop up in parse_message_id.

parse_message_id() was improperly using a token defined inside an
exception handler, which was raising @code{UnboundLocalError} on parsing an
invalid value. Patch by Claudiu Popa.

@item 
bpo-38927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38927}: Use @code{python -m pip} instead of @code{pip} to upgrade
dependencies in venv.

@item 
bpo-26730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26730}: Fix @code{SpooledTemporaryFile.rollover()} might corrupt the file
when it is in text mode. Patch by Serhiy Storchaka.

@item 
bpo-38881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38881}: random.choices() now raises a ValueError when all the weights
are zero.

@item 
bpo-38876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38876}: Raise pickle.UnpicklingError when loading an item from memo for
invalid input.

The previous code was raising a @code{KeyError} for both the Python and C
implementation. This was caused by the specified index of an invalid input
which did not exist in the memo structure, where the pickle stores what
objects it has seen. The malformed input would have caused either a
@code{BINGET} or @code{LONG_BINGET} load from the memo, leading to a
@code{KeyError} as the determined index was bogus. Patch by Claudiu Popa.

@item 
bpo-38688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38688}: Calling func:@code{shutil.copytree} to copy a directory tree from
one directory to another subdirectory resulted in an endless loop and a
RecursionError. A fix was added to consume an iterator and create the list
of the entries to be copied, avoiding the recursion for newly created
directories. Patch by Bruno P. Kinoshita.

@item 
bpo-38863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38863}: Improve @code{is_cgi()} function in @ref{72,,http.server}, which
enables processing the case that cgi directory is a child of another
directory other than root.

@item 
bpo-37838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37838}: @ref{752,,typing.get_type_hints()} properly handles functions
decorated with @ref{fdd,,functools.wraps()}.

@item 
bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870}: Expose @ref{97c,,ast.unparse()} as a function of the @ref{9,,ast}
module that can be used to unparse an @ref{30d,,ast.AST} object and produce
a string with code that would produce an equivalent @ref{30d,,ast.AST}
object when parsed. Patch by Pablo Galindo and Batuhan Taskaya.

@item 
bpo-38859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38859}: AsyncMock now returns StopAsyncIteration on the exhaustion of a
side_effects iterable. Since PEP-479 its Impossible to raise a
StopIteration exception from a coroutine.

@item 
bpo-38857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38857}: AsyncMock fix for return values that are awaitable types.  This
also covers side_effect iterable values that happened to be awaitable, and
wraps callables that return an awaitable type. Before these awaitables
were being awaited instead of being returned as is.

@item 
bpo-38834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38834}: @ref{2ce,,typing.TypedDict} subclasses now track which keys are
optional using the @code{__required_keys__} and @code{__optional_keys__}
attributes, to enable runtime validation by downstream projects.  Patch by
Zac Hatfield-Dodds.

@item 
bpo-38821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38821}: Fix unhandled exceptions in @ref{7,,argparse} when
internationalizing error messages for arguments with @code{nargs} set to
special (non-integer) values. Patch by Federico Bond.

@item 
bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820}: Make Python compatible with OpenSSL 3.0.0.
@ref{1036,,ssl.SSLSocket.getpeercert()} no longer returns IPv6 addresses with a
trailing new line.

@item 
bpo-38811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38811}: Fix an unhandled exception in @ref{a4,,pathlib} when
@ref{1162,,os.link()} is missing. Patch by Toke Høiland-Jørgensen.

@item 
bpo-38686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38686}: Added support for multiple @code{qop} values in
@ref{198b,,urllib.request.AbstractDigestAuthHandler}.

@item 
bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712}: Add the Linux-specific @ref{9be,,signal.pidfd_send_signal()}
function, which allows sending a signal to a process identified by a file
descriptor rather than a pid.

@item 
bpo-38348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38348}: Add @code{-i} and @code{--indent} (indentation level), and
@code{--no-type-comments} (type comments) command line options to ast parsing
tool.

@item 
bpo-37523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37523}: Change @code{zipfile.ZipExtFile} to raise @code{ValueError} when
trying to access the underlying file object after it has been closed. This
new behavior is consistent with how accessing closed files is handled in
other parts of Python.

@item 
bpo-38045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38045}: Improve the performance of @code{enum._decompose()} in
@ref{56,,enum}. Patch by hongweipeng.

@item 
bpo-36820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36820}: Break cycle generated when saving an exception in socket.py,
codeop.py and dyld.py as they keep alive not only the exception but user
objects through the @code{__traceback__} attribute. Patch by Mario Corchero.

@item 
bpo-36406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36406}: Handle namespace packages in @ref{3b,,doctest}. Patch by
Karthikeyan Singaravelan.

@item 
bpo-34776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34776}: Fix dataclasses to support forward references in type
annotations

@item 
bpo-20928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20928}: ElementTree supports recursive XInclude processing.  Patch by
Stefan Behnel.

@item 
bpo-29636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29636}: Add whitespace options for formatting JSON with the
@code{json.tool} CLI. The following mutually exclusive options are now
supported: @code{--indent} for setting the indent level in spaces; @code{--tab}
for indenting with tabs; @code{--no-indent} for suppressing newlines; and
@code{--compact} for suppressing all whitespace. The default behavior remains
the same as @code{--indent=4}.
@end itemize

@node Documentation<38>,Tests<37>,Library<39>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id355}@anchor{19bb}
@subsubsection Documentation



@itemize -

@item 
bpo-38928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38928}: Correct when venv’s @code{upgrade_dependencies()} and
@code{--upgrade-deps} are added.

@item 
bpo-38899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38899}: Update documentation to state that to activate virtual
environments under fish one should use @code{source}, not @code{.} as documented
at @indicateurl{https://fishshell.com/docs/current/cmds/source.html}.

@item 
bpo-22377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22377}: Improves documentation of the values that
@ref{15ec,,datetime.datetime.strptime()} accepts for @code{%Z}. Patch by Karl
Dubost.
@end itemize

@node Tests<37>,Build<39>,Documentation<38>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id356}@anchor{19bc}
@subsubsection Tests



@itemize -

@item 
bpo-38546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38546}: Fix test_ressources_gced_in_workers() of
test_concurrent_futures: explicitly stop the manager to prevent leaking a
child process running in the background after the test completes.

@item 
bpo-38546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38546}: Multiprocessing and concurrent.futures tests now stop the
resource tracker process when tests complete.

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: Replace hardcoded timeout constants in tests with new
@ref{e4,,test.support} constants: @ref{19bd,,LOOPBACK_TIMEOUT},
@ref{19be,,INTERNET_TIMEOUT},
@ref{18b7,,SHORT_TIMEOUT} and
@ref{19bf,,LONG_TIMEOUT}. It becomes easier to adjust these four
timeout constants for all tests at once, rather than having to adjust
every single test file.

@item 
bpo-38547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38547}: Fix test_pty: if the process is the session leader, closing the
master file descriptor raises a SIGHUP signal: simply ignore SIGHUP when
running the tests.

@item 
bpo-38992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38992}: Fix a test for @ref{1414,,math.fsum()} that was failing due to
constant folding.

@item 
bpo-38991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38991}: @ref{e4,,test.support}:
@code{run_python_until_end()},
@code{assert_python_ok()} and
@code{assert_python_failure()} functions no longer strip
whitespaces from stderr. Remove @code{test.support.strip_python_stderr()}
function.

@item 
bpo-38965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38965}: Fix test_faulthandler on GCC 10. Use the «volatile» keyword in
@code{faulthandler._stack_overflow()} to prevent tail call optimization on
any compiler, rather than relying on compiler specific pragma.

@item 
bpo-38875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38875}: test_capi: trashcan tests now require the test «cpu» resource.

@item 
bpo-38841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38841}: Skip asyncio test_create_datagram_endpoint_existing_sock_unix
on platforms lacking a functional bind() for named unix domain sockets.

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: Skip the test_posix.test_pidfd_open() test if
@code{os.pidfd_open()} fails with a @ref{dc9,,PermissionError}. This situation
can happen in a Linux sandbox using a syscall whitelist which doesn’t
allow the @code{pidfd_open()} syscall yet.

@item 
bpo-38839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38839}: Fix some unused functions in tests. Patch by Adam Johnson.

@item 
bpo-38669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38669}: Raise @ref{228,,TypeError} when passing target as a string with
@ref{1596,,unittest.mock.patch.object()}.

@item 
bpo-37957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37957}: test.regrtest now can receive a list of test patterns to ignore
(using the -i/–ignore argument) or a file with a list of patterns to
ignore (using the –ignore-file argument). Patch by Pablo Galindo.
@end itemize

@node Build<39>,Windows<37>,Tests<37>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id357}@anchor{19c0}
@subsubsection Build



@itemize -

@item 
bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404}: @ref{b,,asyncio} now raises @ref{228,,TypeError} when calling
incompatible methods with an @ref{981,,ssl.SSLSocket} socket.  Patch by Ido
Michael.

@item 
bpo-36500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36500}: Added an optional «regen» project to the Visual Studio solution
that will regenerate all grammar, tokens, and opcodes.
@end itemize

@node Windows<37>,macOS<31>,Build<39>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id358}@anchor{19c1}
@subsubsection Windows



@itemize -

@item 
bpo-39007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39007}: Add auditing events to functions in @ref{116,,winreg}.

@item 
bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}: Add support for building and releasing Windows ARM64 packages.
@end itemize

@node macOS<31>,IDLE<27>,Windows<37>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id359}@anchor{19c2}
@subsubsection macOS



@itemize -

@item 
bpo-37931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37931}: Fixed a crash on OSX dynamic builds that occurred when
re-initializing the posix module after a Py_Finalize if the environment
had changed since the previous @code{import posix}. Patch by Benoît Hudson.
@end itemize

@node IDLE<27>,C API<38>,macOS<31>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id360}@anchor{19c3}
@subsubsection IDLE



@itemize -

@item 
bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}: Escape key now closes IDLE completion windows.  Patch by Johnny
Najera.

@item 
bpo-38943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38943}: Fix IDLE autocomplete windows not always appearing on some
systems. Patch by Johnny Najera.

@item 
bpo-38862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38862}: “Strip Trailing Whitespace” on the Format menu removes extra
newlines at the end of non-shell files.

@item 
bpo-38636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38636}: Fix IDLE Format menu tab toggle and file indent width. These
functions (default shortcuts Alt-T and Alt-U) were mistakenly disabled in
3.7.5 and 3.8.0.
@end itemize

@node C API<38>,,IDLE<27>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id361}@anchor{19c4}
@subsubsection C API



@itemize -

@item 
bpo-38896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38896}: Remove @code{PyUnicode_ClearFreeList()} function: the Unicode free
list has been removed in Python 3.3.

@item 
bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}: Remove @code{PyMethod_ClearFreeList()} and
@code{PyCFunction_ClearFreeList()} functions: the free lists of bound method
objects have been removed.

@item 
bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}: Exclude @code{PyFPE_START_PROTECT()} and @code{PyFPE_END_PROTECT()}
macros of @code{pyfpe.h} from @code{Py_LIMITED_API} (stable API).
@end itemize

@node Python 3 9 0 alpha 1,Python 3 8 0 beta 1,Python 3 9 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-9-0-alpha-1}@anchor{19c5}
@subsection Python 3.9.0 alpha 1


`Release date: 2019-11-19'

@menu
* Security: Security<28>. 
* Core and Builtins: Core and Builtins<40>. 
* Library: Library<40>. 
* Documentation: Documentation<39>. 
* Tests: Tests<38>. 
* Build: Build<40>. 
* Windows: Windows<38>. 
* macOS: macOS<32>. 
* IDLE: IDLE<28>. 
* Tools/Demos: Tools/Demos<20>. 
* C API: C API<39>. 

@end menu

@node Security<28>,Core and Builtins<40>,,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id362}@anchor{19c6}
@subsubsection Security



@itemize -

@item 
bpo-38722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38722}: @ref{be,,runpy} now uses @ref{172e,,io.open_code()} to open code files.
Patch by Jason Killen.

@item 
bpo-38622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38622}: Add additional audit events for the @ref{2b,,ctypes} module.

@item 
bpo-38418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38418}: Fixes audit event for @ref{149a,,os.system()} to be named
@code{os.system}.

@item 
bpo-38243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38243}: Escape the server title of
@ref{19c7,,xmlrpc.server.DocXMLRPCServer} when rendering the document page as
HTML. (Contributed by Donghee Na in bpo-38243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38243}.)

@item 
bpo-38174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38174}: Update vendorized expat library version to 2.2.8, which
resolves 
@geindex Common Vulnerabilities and Exposures; CVE 2019-15903
CVE 2019-15903@footnote{https://www.cve.org/CVERecord?id=CVE-2019-15903}.

@item 
bpo-37764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37764}: Fixes email._header_value_parser.get_unstructured going into an
infinite loop for a specific case in which the email header does not have
trailing whitespace, and the case in which it contains an invalid encoded
word. Patch by Ashwin Ramaswami.

@item 
bpo-37461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37461}: Fix an infinite loop when parsing specially crafted email
headers. Patch by Abhilash Raj.

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: Adds audit events for the range of supported run commands (see
@ref{19c8,,Línea de comandos y entorno}).

@item 
bpo-37463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37463}: ssl.match_hostname() no longer accepts IPv4 addresses with
additional text after the address and only quad-dotted notation without
trailing whitespaces. Some inet_aton() implementations ignore whitespace
and all data after whitespace, e.g. “127.0.0.1 whatever”.

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: Adds audit events for @ref{55,,ensurepip}, @ref{5e,,ftplib},
@ref{64,,glob}, @ref{74,,imaplib}, @code{nntplib}, @ref{a5,,pdb}, @ref{ac,,poplib},
@ref{c5,,shutil}, @ref{ca,,smtplib}, @ref{cf,,sqlite3}, @ref{d6,,subprocess},
@code{telnetlib}, @ref{e0,,tempfile} and @ref{115,,webbrowser}, as well as
@ref{116c,,os.listdir()}, @ref{1a2,,os.scandir()} and @ref{1a6,,breakpoint()}.

@item 
bpo-37364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37364}: @ref{172e,,io.open_code()} is now used when reading @code{.pth}
files.

@item 
bpo-34631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34631}: Updated OpenSSL to 1.1.1c in Windows installer

@item 
bpo-34155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34155}: Fix parsing of invalid email addresses with more than one @code{@@}
(e.g. a@@b@@c.com.) to not return the part before 2nd @code{@@} as valid email
address. Patch by maxking & jpic.
@end itemize

@node Core and Builtins<40>,Library<40>,Security<28>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id363}@anchor{19c9}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-38631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38631}: Replace @code{Py_FatalError()} call with a regular
@ref{1e5,,RuntimeError} exception in @code{float.__getformat__()}.

@item 
bpo-38639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38639}: Optimized @ref{1401,,math.floor()}, @ref{1402,,math.ceil()} and
@ref{1403,,math.trunc()} for floats.

@item 
bpo-38640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38640}: Fixed a bug in the compiler that was causing to raise in the
presence of break statements and continue statements inside always false
while loops. Patch by Pablo Galindo.

@item 
bpo-38613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38613}: Optimized some set operations (e.g. @code{|}, @code{^}, and @code{-}) of
@code{dict_keys}. @code{d.keys() | other} was slower than @code{set(d) | other} but
they are almost same performance for now.

@item 
bpo-28029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28029}: @code{"".replace("", s, n)} now returns @code{s} instead of an empty
string for all non-zero @code{n}.  There are similar changes for
@ref{325,,bytes} and @ref{5e0,,bytearray} objects.

@item 
bpo-38535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38535}: Fixed line numbers and column offsets for AST nodes for calls
without arguments in decorators.

@item 
bpo-38525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38525}: Fix a segmentation fault when using reverse iterators of empty
@code{dict} objects. Patch by Donghee Na and Inada Naoki.

@item 
bpo-38465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38465}: @ref{5e0,,bytearray}, @ref{308,,array} and
@ref{368,,mmap} objects allow now to export more than @code{2**31}
buffers at a time.

@item 
bpo-38469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38469}: Fixed a bug where the scope of named expressions was not being
resolved correctly in the presence of the `global' keyword. Patch by Pablo
Galindo.

@item 
bpo-38437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38437}: Activate the @code{GC_DEBUG} macro for debug builds of the
interpreter (when @code{Py_DEBUG} is set). Patch by Pablo Galindo.

@item 
bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}: When the garbage collector makes a collection in which some
objects resurrect (they are reachable from outside the isolated cycles
after the finalizers have been executed), do not block the collection of
all objects that are still unreachable. Patch by Pablo Galindo and Tim
Peters.

@item 
bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}: When cyclic garbage collection (gc) runs finalizers that
resurrect unreachable objects, the current gc run ends, without collecting
any cyclic trash.  However, the statistics reported by @code{collect()} and
@code{get_stats()} claimed that all cyclic trash found was collected, and
that the resurrected objects were collected.   Changed the stats to report
that none were collected.

@item 
bpo-38392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38392}: In debug mode, @ref{1546,,PyObject_GC_Track()} now calls
@code{tp_traverse()} of the object type to ensure that the object is valid:
test that objects visited by @code{tp_traverse()} are valid.

@item 
bpo-38210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38210}: Remove unnecessary intersection and update set operation in
dictview with empty set. (Contributed by Donghee Na in bpo-38210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38210}.)

@item 
bpo-38402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38402}: Check the error from the system’s underlying @code{crypt} or
@code{crypt_r}.

@item 
bpo-37474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37474}: On FreeBSD, Python no longer calls @code{fedisableexcept()} at
startup to control the floating-point control mode. The call became
useless since FreeBSD 6: it became the default mode.

@item 
bpo-38006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38006}: Fix a bug due to the interaction of weakrefs and the cyclic
garbage collector. We must clear any weakrefs in garbage in order to
prevent their callbacks from executing and causing a crash.

@item 
bpo-38317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38317}: Fix warnings options priority: @code{PyConfig.warnoptions} has the
highest priority, as stated in the 
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}.

@item 
bpo-38310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38310}: Predict @code{BUILD_MAP_UNPACK_WITH_CALL} -> @code{CALL_FUNCTION_EX}
opcode pairs in the main interpreter loop. Patch by Brandt Bucher.

@item 
bpo-36871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36871}: Improve error handling for the assert_has_calls and
assert_has_awaits methods of mocks. Fixed a bug where any errors
encountered while binding the expected calls to the mock’s spec were
silently swallowed, leading to misleading error output.

@item 
bpo-11410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11410}: Better control over symbol visibility is provided through use
of the visibility attributes available in gcc >= 4.0, provided in a
uniform way across POSIX and Windows. The POSIX build files have been
updated to compile with -fvisibility=hidden, minimising exported symbols.

@item 
bpo-38219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38219}: Optimized the @ref{190,,dict} constructor and the
@ref{14a2,,update()} method for the case when the argument is a dict.

@item 
bpo-38236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38236}: Python now dumps path configuration if it fails to import the
Python codecs of the filesystem and stdio encodings.

@item 
bpo-38013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38013}: Allow to call @code{async_generator_athrow().throw(...)} even for
non-started async generator helper. It fixes annoying warning at the end
of @ref{525,,asyncio.run()} call.

@item 
bpo-38124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38124}: Fix an off-by-one error in PyState_AddModule that could cause
out-of-bounds memory access.

@item 
bpo-38116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38116}: The select module is now PEP-384 compliant and no longer has
static state

@item 
bpo-38113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38113}: ast module updated to PEP-384 and all statics removed

@item 
bpo-38076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38076}: The struct module is now PEP-384 compatible

@item 
bpo-38075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38075}: The random module is now PEP-384 compatible

@item 
bpo-38074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38074}: zlib module made PEP-384 compatible

@item 
bpo-38073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38073}: Make pwd extension module PEP-384 compatible

@item 
bpo-38072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38072}: grp module made PEP-384 compatible

@item 
bpo-38069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38069}: Make _posixsubprocess PEP-384 compatible

@item 
bpo-38071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38071}: Make termios extension module PEP-384 compatible

@item 
bpo-38005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38005}: Fixed comparing and creating of InterpreterID and ChannelID.

@item 
bpo-36946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36946}: Fix possible signed integer overflow when handling slices.
Patch by hongweipeng.

@item 
bpo-37994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37994}: Fixed silencing arbitrary errors if an attribute lookup fails
in several sites. Only AttributeError should be silenced.

@item 
bpo-8425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8425}: Optimize set difference_update for the case when the other set
is much larger than the base set.  (Suggested by Evgeny Kapun with code
contributed by Michele Orrù).

@item 
bpo-37966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37966}: The implementation of @ref{adb,,is_normalized()} has
been greatly sped up on strings that aren’t normalized, by implementing
the full normalization-quick-check algorithm from the Unicode standard.

@item 
bpo-37947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37947}: Adjust correctly the recursion level in the symtable generation
for named expressions. Patch by Pablo Galindo.

@item 
bpo-37812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37812}: The @code{CHECK_SMALL_INT} macro used inside
@code{Object/longobject.c} has been replaced with an explicit @code{return}
at each call site.

@item 
bpo-37751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37751}: Fix @ref{9f6,,codecs.lookup()} to normalize the encoding name the
same way than @code{encodings.normalize_encoding()}, except that
@ref{9f6,,codecs.lookup()} also converts the name to lower case.

@item 
bpo-37830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37830}: Fixed compilation of @ref{b34,,break} and @ref{a5b,,continue}
in the @ref{a5c,,finally} block when the corresponding @ref{789,,try}
block contains @ref{a60,,return} with a non-constant value.

@item 
bpo-20490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20490}: Improve import error message for partially initialized module
on circular @code{from} imports - by Anthony Sottile.

@item 
bpo-37840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37840}: Fix handling of negative indices in
@ref{1936,,sq_item} of @ref{5e0,,bytearray}. Patch by
Sergey Fedoseev.

@item 
bpo-37802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37802}: Slightly improve performance of
@ref{19ca,,PyLong_FromUnsignedLong()}, @ref{19cb,,PyLong_FromUnsignedLongLong()}
and @ref{19cc,,PyLong_FromSize_t()}. Patch by Sergey Fedoseev.

@item 
bpo-37409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37409}: Ensure explicit relative imports from interactive sessions and
scripts (having no parent package) always raise ImportError, rather than
treating the current module as the package. Patch by Ben Lewis.

@item 
bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}: Reverted bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}: emitting @ref{511,,SyntaxWarning} instead
of @ref{1da,,DeprecationWarning} for invalid escape sequences in string and
bytes literals.

@item 
bpo-37757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37757}: 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}: As described in the PEP, assignment expressions now
raise @ref{150,,SyntaxError} when their interaction with comprehension scoping
results in an ambiguous target scope.

The @code{TargetScopeError} subclass originally proposed by the PEP has been
removed in favour of just raising regular syntax errors for the disallowed
cases.

@item 
bpo-36279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36279}: Fix potential use of uninitialized memory in @ref{e1c,,os.wait3()}.

@item 
bpo-36311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36311}: Decoding bytes objects larger than 2GiB is faster and no longer
fails when a multibyte characters spans a chunk boundary.

@item 
bpo-34880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34880}: The @ref{9fa,,assert} statement now works properly if the
@ref{74a,,AssertionError} exception is being shadowed. Patch by Zackery Spytz.

@item 
bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}: Removed object cache (@code{free_list}) for bound method objects.
Temporary bound method objects are less used than before thanks to the
@code{LOAD_METHOD} opcode and the @code{_PyObject_VectorcallMethod} C API.

@item 
bpo-37648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37648}: Fixed minor inconsistency in @code{list.__contains__()},
@code{tuple.__contains__()} and a few other places. The collection’s item
is now always at the left and the needle is on the right of @code{==}.

@item 
bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}: Update differing exception between @code{builtins.__import__()}
and @ref{10e9,,importlib.__import__()}.

@item 
bpo-37619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37619}: When adding a wrapper descriptor from one class to a different
class (for example, setting @code{__add__ = str.__add__} on an @code{int}
subclass), an exception is correctly raised when the operator is called.

@item 
bpo-37593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37593}: Swap the positions of the `posonlyargs' and `args' parameters
in the constructor of @code{ast.parameters} nodes.

@item 
bpo-37543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37543}: Optimized pymalloc for non PGO build.

@item 
bpo-37537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37537}: Compute allocated pymalloc blocks inside
_Py_GetAllocatedBlocks().  This slows down _Py_GetAllocatedBlocks() but
gives a small speedup to _PyObject_Malloc() and _PyObject_Free().

@item 
bpo-37467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37467}: Fix @ref{8a2,,sys.excepthook()} and @code{PyErr_Display()} if a
filename is a bytes string. For example, for a SyntaxError exception where
the filename attribute is a bytes string.

@item 
bpo-37433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37433}: Fix @code{SyntaxError} indicator printing too many spaces for
multi-line strings - by Anthony Sottile.

@item 
bpo-37417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37417}: @code{bytearray.extend()} now correctly handles errors that
arise during iteration. Patch by Brandt Bucher.

@item 
bpo-37414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37414}: The undocumented @code{sys.callstats()} function has been removed.
Since Python 3.7, it was deprecated and always returned @code{None}. It
required a special build option @code{CALL_PROFILE} which was already removed
in Python 3.7.

@item 
bpo-37392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37392}: Remove @code{sys.getcheckinterval()} and
@code{sys.setcheckinterval()} functions. They were deprecated since Python
3.2. Use @ref{9dc,,sys.getswitchinterval()} and @ref{9dd,,sys.setswitchinterval()}
instead. Remove also @code{check_interval} field of the
@code{PyInterpreterState} structure.

@item 
bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}: In development mode and in debug build, `encoding' and `errors'
arguments are now checked on string encoding and decoding operations.
Examples: @ref{1be,,open()}, @ref{96c,,str.encode()} and @ref{96d,,bytes.decode()}.

By default, for best performances, the `errors' argument is only checked
at the first encoding/decoding error, and the `encoding' argument is
sometimes ignored for empty strings.

@item 
bpo-37348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37348}: Optimized decoding short ASCII string with UTF-8 and ascii
codecs. @code{b"foo".decode()} is about 15% faster.  Patch by Inada Naoki.

@item 
bpo-24214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24214}: Improved support of the surrogatepass error handler in the
UTF-8 and UTF-16 incremental decoders.

@item 
bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: @ref{1be,,open()}, @ref{5c0,,io.open()}, @ref{7db,,codecs.open()} and
@ref{7d3,,fileinput.FileInput} no longer accept @code{'U'} («universal
newline») in the file mode. This flag was deprecated since Python 3.3.

@item 
bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}: Reverse evaluation order of key: value in dict comprehensions
as proposed in PEP 572. I.e. in @code{@{k: v for ...@}}, @code{k} will be
evaluated before @code{v}.

@item 
bpo-37316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37316}: Fix the @ref{463,,PySys_Audit()} call in @ref{368,,mmap.mmap}.

@item 
bpo-37300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37300}: Remove an unnecessary Py_XINCREF in classobject.c.

@item 
bpo-37269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37269}: Fix a bug in the peephole optimizer that was not treating
correctly constant conditions with binary operators. Patch by Pablo
Galindo.

@item 
bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}: Python now gets the absolute path of the script filename
specified on the command line (ex: «python3 script.py»): the __file__
attribute of the __main__ module and sys.path[0] become an absolute path,
rather than a relative path.

@item 
bpo-37257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37257}: Python’s small object allocator (@code{obmalloc.c}) now allows (no
more than) one empty arena to remain available for immediate reuse,
without returning it to the OS.  This prevents thrashing in simple loops
where an arena could be created and destroyed anew on each iteration.

@item 
bpo-37231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37231}: The dispatching of type slots to special methods (for example
calling @code{__mul__} when doing @code{x * y}) has been made faster.

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: Implemented separate vectorcall functions for every calling
convention of builtin functions and methods. This improves performance for
calls.

@item 
bpo-37213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37213}: Handle correctly negative line offsets in the peephole
optimizer. Patch by Pablo Galindo.

@item 
bpo-37219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37219}: Remove erroneous optimization for empty set differences.

@item 
bpo-15913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15913}: Implement @ref{7f4,,PyBuffer_SizeFromFormat()} function
(previously documented but not implemented): call @ref{19cd,,struct.calcsize()}.
Patch by Joannah Nanjekye.

@item 
bpo-36922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36922}: Slot functions optimize any callable with
@code{Py_TPFLAGS_METHOD_DESCRIPTOR} instead of only instances of
@code{function}.

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: The slot @code{tp_vectorcall_offset} is inherited unconditionally
to support @code{super().__call__()} when the base class uses vectorcall.

@item 
bpo-37160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37160}: @ref{ad0,,threading.get_native_id()} now also supports NetBSD.

@item 
bpo-37077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37077}: Add @ref{ad0,,threading.get_native_id()} support for AIX. Patch by
M. Felt

@item 
bpo-36781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36781}: @ref{515,,sum()} has been optimized for boolean values.

@item 
bpo-34556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34556}: Add @code{--upgrade-deps} to venv module. Patch by Cooper Ry Lees

@item 
bpo-20523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20523}: @code{pdb.Pdb} supports ~/.pdbrc in Windows 7. Patch by Tim Hopper
and Dan Lidral-Porter.

@item 
bpo-35551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35551}: Updated encodings: - Removed the «tis260» encoding, which was
an alias for the nonexistent «tactis» codec. - Added «mac_centeuro» as an
alias for the mac_latin2 encoding.

@item 
bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}: The @ref{2d2,,classmethod} decorator can now wrap other
descriptors such as property objects.  Adapted from a patch written by
Graham Dumpleton.

@item 
bpo-27575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27575}: Improve speed of dictview intersection by directly using set
intersection logic. Patch by David Su.

@item 
bpo-30773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30773}: Prohibit parallel running of aclose() / asend() / athrow(). Fix
ag_running to reflect the actual running status of the AG.
@end itemize

@node Library<40>,Documentation<39>,Core and Builtins<40>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id364}@anchor{19ce}
@subsubsection Library



@itemize -

@item 
bpo-36589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36589}: The @ref{e71,,curses.update_lines_cols()} function now returns
@code{None} instead of @code{1} on success.

@item 
bpo-38807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38807}: Update @ref{228,,TypeError} messages for @ref{163f,,os.path.join()} to
include @ref{cd9,,os.PathLike} objects as acceptable input types.

@item 
bpo-38724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38724}: Add a repr for @code{subprocess.Popen} objects. Patch by Andrey
Doroschenko.

@item 
bpo-38786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38786}: pydoc now recognizes and parses HTTPS URLs. Patch by python273.

@item 
bpo-38785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38785}: Prevent asyncio from crashing if parent @code{__init__} is not
called from a constructor of object derived from @code{asyncio.Future}.

@item 
bpo-38723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38723}: @ref{a5,,pdb} now uses @ref{172e,,io.open_code()} to trigger auditing
events.

@item 
bpo-27805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27805}: Allow opening pipes and other non-seekable files in append mode
with @ref{1be,,open()}.

@item 
bpo-38438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38438}: Simplify the @ref{7,,argparse} usage message for @code{nargs="*"}.

@item 
bpo-38761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38761}: WeakSet is now registered as a collections.abc.MutableSet.

@item 
bpo-38716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38716}: logging: change RotatingHandler namer and rotator to
class-level attributes. This stops __init__ from setting them to None in
the case where a subclass defines them with eponymous methods.

@item 
bpo-38713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38713}: Add @ref{9b0,,os.P_PIDFD} constant, which may be passed to
@ref{e1f,,os.waitid()} to wait on a Linux process file descriptor.

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: Add @code{asyncio.PidfdChildWatcher}, a Linux-specific child
watcher implementation that polls process file descriptors.

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: Expose the Linux @code{pidfd_open} syscall as
@ref{524,,os.pidfd_open()}.

@item 
bpo-38602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38602}: Added constants @code{F_OFD_GETLK},
@code{F_OFD_SETLK} and @code{F_OFD_SETLKW} to the
@ref{59,,fcntl} module. Patch by Donghee Na.

@item 
bpo-38334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38334}: Fixed seeking backward on an encrypted
@code{zipfile.ZipExtFile}.

@item 
bpo-38312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38312}: Add @ref{986,,curses.get_escdelay()}, @ref{987,,curses.set_escdelay()},
@ref{988,,curses.get_tabsize()}, and @ref{989,,curses.set_tabsize()} functions - by
Anthony Sottile.

@item 
bpo-38586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38586}: Now @ref{bd9,,fileConfig()} correctly sets the .name
of handlers loaded.

@item 
bpo-38565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38565}: Add new cache_parameters() method for functools.lru_cache() to
better support pickling.

@item 
bpo-34679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34679}: asynci.ProactorEventLoop.close() now only calls
signal.set_wakeup_fd() in the main thread.

@item 
bpo-31202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31202}: The case the result of @code{pathlib.WindowsPath.glob()} matches
now the case of the pattern for literal parts.

@item 
bpo-36321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36321}: Remove misspelled attribute.  The 3.8 changelog noted that this
would be removed in 3.9.

@item 
bpo-38521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38521}: Fixed erroneous equality comparison in statistics.NormalDist().

@item 
bpo-38493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38493}: Added @ref{9ae,,CLD_KILLED} and @ref{9af,,CLD_STOPPED} for
@code{si_code}. Patch by Donghee Na.

@item 
bpo-38478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38478}: Fixed a bug in @code{inspect.signature.bind()} that was causing
it to fail when handling a keyword argument with same name as
positional-only parameter. Patch by Pablo Galindo.

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: Fixed @code{hmac.new} and @code{hmac.HMAC} to raise TypeError instead
of ValueError when the digestmod parameter, now required in 3.8, is
omitted. Also clarified the hmac module documentation and docstrings.

@item 
bpo-38378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38378}: Parameters `out' and `in' of @ref{b9a,,os.sendfile()} was renamed to
`out_fd' and `in_fd'.

@item 
bpo-38417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38417}: Added support for setting the umask in the child process to the
subprocess module on POSIX systems.

@item 
bpo-38449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38449}: Revert PR 15522, which introduces a regression in
@ref{366,,mimetypes.guess_type()} due to improper handling of filenames as
urls.

@item 
bpo-38431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38431}: Fix @code{__repr__} method for @code{dataclasses.InitVar} to
support typing objects, patch by Samuel Colvin.

@item 
bpo-38109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38109}: Add missing @ref{1039,,stat.S_IFDOOR}, @ref{103a,,stat.S_IFPORT},
@ref{103b,,stat.S_IFWHT}, @ref{19cf,,stat.S_ISDOOR()}, @ref{19d0,,stat.S_ISPORT()}, and
@ref{19d1,,stat.S_ISWHT()} values to the Python implementation of @ref{d1,,stat}.

@item 
bpo-38422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38422}: Clarify docstrings of pathlib suffix(es)

@item 
bpo-38405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38405}: Nested subclasses of @ref{1db,,typing.NamedTuple} are now
pickleable.

@item 
bpo-38332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38332}: Prevent @ref{438,,KeyError} thrown by
@code{_encoded_words.decode()} when given an encoded-word with invalid
content-type encoding from propagating all the way to
@code{email.message.get()}.

@item 
bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}: Deprecated the @code{split()} method in
@code{_tkinter.TkappType} in favour of the @code{splitlist()} method which
has more consistent and predictable behavior.

@item 
bpo-38341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38341}: Add @ref{19d2,,smtplib.SMTPNotSupportedError} to the @ref{ca,,smtplib}
exported names.

@item 
bpo-38319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38319}: sendfile() used in socket and shutil modules was raising
OverflowError for files >= 2GiB on 32-bit architectures.  (patch by
Giampaolo Rodola)

@item 
bpo-38242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38242}: Revert the new asyncio Streams API

@item 
bpo-13153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13153}: OS native encoding is now used for converting between Python
strings and Tcl objects.  This allows to display, copy and paste to
clipboard emoji and other non-BMP characters.  Converting strings from Tcl
to Python and back now never fails (except MemoryError).

@item 
bpo-38019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38019}: Correctly handle pause/resume reading of closed asyncio unix
pipe.

@item 
bpo-38163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38163}: Child mocks will now detect their type as either synchronous or
asynchronous, asynchronous child mocks will be AsyncMocks and synchronous
child mocks will be either MagicMock or Mock (depending on their parent
type).

@item 
bpo-38161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38161}: Removes _AwaitEvent from AsyncMock.

@item 
bpo-38216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38216}: Allow the rare code that wants to send invalid http requests
from the @code{http.client} library a way to do so.  The fixes for bpo-30458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30458}
led to breakage for some projects that were relying on this ability to
test their own behavior in the face of bad requests.

@item 
bpo-28286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28286}: Deprecate opening @ref{4d8,,GzipFile} for writing
implicitly.  Always specify the `mode' argument for writing.

@item 
bpo-38108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38108}: Any synchronous magic methods on an AsyncMock now return a
MagicMock. Any asynchronous magic methods on a MagicMock now return an
AsyncMock.

@item 
bpo-38265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38265}: Update the `length' parameter of @ref{be7,,os.pread()} to accept
@ref{af0,,Py_ssize_t} instead of int.

@item 
bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112}: @ref{21,,compileall} has a higher default recursion limit and new
command-line arguments for path manipulation, symlinks handling, and
multiple optimization levels.

@item 
bpo-38248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38248}: asyncio: Fix inconsistent immediate Task cancellation

@item 
bpo-38237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38237}: The arguments for the builtin pow function are more
descriptive. They can now also be passed in as keywords.

@item 
bpo-34002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34002}: Improve efficiency in parts of email package by changing
while-pop to a for loop, using isdisjoint instead of set intersections.

@item 
bpo-38191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38191}: Constructors of @ref{1db,,NamedTuple} and
@ref{2ce,,TypedDict} types now accept arbitrary keyword argument
names, including «cls», «self», «typename», «_typename», «fields» and
«_fields».

@item 
bpo-38155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38155}: Add @code{__all__} to  @ref{31,,datetime}. Patch by Tahia Khan.

@item 
bpo-38185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38185}: Fixed case-insensitive string comparison in
@ref{ef1,,sqlite3.Row} indexing.

@item 
bpo-38136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38136}: Changes AsyncMock call count and await count to be two
different counters. Now await count only counts when a coroutine has been
awaited, not when it has been called, and vice-versa. Update the
documentation around this.

@item 
bpo-37828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37828}: Fix default mock name in
@ref{d7f,,unittest.mock.Mock.assert_called()} exceptions. Patch by Abraham
Toriz Cruz.

@item 
bpo-38175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38175}: Fix a memory leak in comparison of @ref{ef1,,sqlite3.Row}
objects.

@item 
bpo-33936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33936}: _hashlib no longer calls obsolete OpenSSL initialization
function with OpenSSL 1.1.0+.

@item 
bpo-34706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34706}: Preserve subclassing in inspect.Signature.from_callable.

@item 
bpo-38153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38153}: Names of hashing algorithms from OpenSSL are now normalized to
follow Python’s naming conventions. For example OpenSSL uses sha3-512
instead of sha3_512 or blake2b512 instead of blake2b.

@item 
bpo-38115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38115}: Fix a bug in dis.findlinestarts() where it would return invalid
bytecode offsets. Document that a code object’s co_lnotab can contain
invalid bytecode offsets.

@item 
bpo-38148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38148}: Add slots to @ref{b,,asyncio} transport classes, which can reduce
memory usage.

@item 
bpo-38142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38142}: The _hashlib OpenSSL wrapper extension module is now PEP-384
compliant.

@item 
bpo-9216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9216}: hashlib constructors now support usedforsecurity flag to signal
that a hashing algorithm is not used in a security context.

@item 
bpo-36991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36991}: Fixes a potential incorrect AttributeError exception escaping
ZipFile.extract() in some unsupported input error situations.

@item 
bpo-38134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38134}: Remove obsolete copy of PBKDF2_HMAC_fast. All supported OpenSSL
versions contain a fast implementation.

@item 
bpo-38132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38132}: The OpenSSL hashlib wrapper uses a simpler implementation.
Several Macros and pointless caches are gone. The hash name now comes from
OpenSSL’s EVP. The algorithm name stays the same, except it is now always
lower case.

@item 
bpo-38008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38008}: Fix parent class check in protocols to correctly identify the
module that provides a builtin protocol, instead of assuming they all come
from the @ref{1f,,collections.abc} module

@item 
bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}: For @ref{b,,asyncio}, add a new coroutine
@code{loop.shutdown_default_executor()}. The new coroutine provides an API
to schedule an executor shutdown that waits on the threadpool to finish
closing. Also, @ref{525,,asyncio.run()} has been updated to utilize the new
coroutine. Patch by Kyle Stanley.

@item 
bpo-37405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37405}: Fixed regression bug for socket.getsockname() for non-CAN_ISOTP
AF_CAN address family sockets by returning a 1-tuple instead of string.

@item 
bpo-38121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38121}: Update parameter names on functions in importlib.metadata
matching the changes in the 0.22 release of importlib_metadata.

@item 
bpo-38110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38110}: The os.closewalk() implementation now uses the libc fdwalk()
API on platforms where it is available.

@item 
bpo-38093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38093}: Fixes AsyncMock so it doesn’t crash when used with
AsyncContextManagers or AsyncIterators.

@item 
bpo-37488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37488}: Add warning to @code{datetime.utctimetuple()},
@code{datetime.utcnow()} and @code{datetime.utcfromtimestamp()} .

@item 
bpo-35640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35640}: Allow passing a @ref{3f0,,path-like object} as @code{directory}
argument to the @ref{bcb,,http.server.SimpleHTTPRequestHandler} class. Patch
by Géry Ogam.

@item 
bpo-38086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38086}: Update importlib.metadata with changes from importlib_metadata 0.21@footnote{https://gitlab.com/python-devs/importlib_metadata/blob/0.21/importlib_metadata/docs/changelog.rst}.

@item 
bpo-37251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37251}: Remove @code{__code__} check in AsyncMock that incorrectly
evaluated function specs as async objects but failed to evaluate classes
with @code{__await__} but no @code{__code__} attribute defined as async objects.

@item 
bpo-38037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38037}: Fix reference counters in the @ref{c6,,signal} module.

@item 
bpo-38066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38066}: Hide internal asyncio.Stream methods: feed_eof(), feed_data(),
set_exception() and set_transport().

@item 
bpo-38059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38059}: inspect.py now uses sys.exit() instead of exit()

@item 
bpo-38049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38049}: Added command-line interface for the @ref{9,,ast} module.

@item 
bpo-37953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37953}: In @ref{104,,typing}, improved the @code{__hash__} and @code{__eq__}
methods for @code{ForwardReferences}.

@item 
bpo-38026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38026}: Fixed @ref{53d,,inspect.getattr_static()} used @code{isinstance} while
it should avoid dynamic lookup.

@item 
bpo-35923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35923}: Update @ref{d38,,importlib.machinery.BuiltinImporter} to use
@code{loader._ORIGIN} instead of a hardcoded value. Patch by Donghee Na.

@item 
bpo-38010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38010}: In @code{importlib.metadata} sync with @code{importlib_metadata}
0.20, clarifying behavior of @code{files()} and fixing issue where only one
requirement was returned for @code{requires()} on @code{dist-info} packages.

@item 
bpo-38006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38006}: weakref.WeakValueDictionary defines a local remove() function
used as callback for weak references. This function was created with a
closure. Modify the implementation to avoid the closure.

@item 
bpo-37995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37995}: Added the `indent' option to @ref{97b,,ast.dump()} which allows it
to produce a multiline indented output.

@item 
bpo-34410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34410}: Fixed a crash in the @code{tee()} iterator when re-enter it.
RuntimeError is now raised in this case.

@item 
bpo-37140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37140}: Fix a ctypes regression of Python 3.8. When a ctypes.Structure
is passed by copy to a function, ctypes internals created a temporary
object which had the side effect of calling the structure finalizer
(__del__) twice. The Python semantics requires a finalizer to be called
exactly once. Fix ctypes internals to no longer call the finalizer twice.

@item 
bpo-37587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37587}: @code{_json.scanstring} is now up to 3x faster when there are many
backslash escaped characters in the JSON string.

@item 
bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}: Prevent shutil.rmtree exception when built on non-Windows
system without fd system call support, like older versions of macOS.

@item 
bpo-10978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10978}: Semaphores and BoundedSemaphores can now release more than one
waiting thread at a time.

@item 
bpo-37972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37972}: Subscripts to the @code{unittest.mock.call} objects now receive
the same chaining mechanism as any other custom attributes, so that the
following usage no longer raises a @code{TypeError}:

@code{call().foo().__getitem__('bar')}

Patch by blhsing

@item 
bpo-37965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37965}: Fix C compiler warning caused by
distutils.ccompiler.CCompiler.has_function.

@item 
bpo-37964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37964}: Add @code{F_GETPATH} command to @ref{59,,fcntl}.

@item 
bpo-37960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37960}: @code{repr()} of buffered and text streams now silences only
expected exceptions when get the value of «name» and «mode» attributes.

@item 
bpo-37961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37961}: Add a @code{total_nframe} field to the traces collected by the
tracemalloc module. This field indicates the original number of frames
before it was truncated.

@item 
bpo-37951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37951}: Most features of the subprocess module now work again in
subinterpreters. Only `preexec_fn' is restricted in subinterpreters.

@item 
bpo-36205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36205}: Fix the rusage implementation of time.process_time() to
correctly report the sum of the system and user CPU time.

@item 
bpo-37950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37950}: Fix @ref{97b,,ast.dump()} when call with incompletely initialized
node.

@item 
bpo-34679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34679}: Restores instantiation of Windows IOCP event loops from the
non-main thread.

@item 
bpo-36917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36917}: Add default implementation of the
@ref{afd,,ast.NodeVisitor.visit_Constant()} method which emits a deprecation
warning and calls corresponding methods @code{visit_Num()}, @code{visit_Str()},
etc.

@item 
bpo-37798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37798}: Update test_statistics.py to verify that the statistics module
works well for both C and Python implementations. Patch by Donghee Na

@item 
bpo-26589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26589}: Added a new status code to the http module: 451
UNAVAILABLE_FOR_LEGAL_REASONS

@item 
bpo-37915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37915}: Fix a segmentation fault that appeared when comparing instances
of @code{datetime.timezone} and @code{datetime.tzinfo} objects. Patch by Pablo
Galindo.

@item 
bpo-32554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32554}: Deprecate having random.seed() call hash on arbitrary types.

@item 
bpo-9938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9938}: Add optional keyword argument @code{exit_on_error} for
@code{ArgumentParser}.

@item 
bpo-37851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37851}: The @ref{58,,faulthandler} module no longer allocates its
alternative stack at Python startup. Now the stack is only allocated at
the first faulthandler usage.

@item 
bpo-32793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32793}: Fix a duplicated debug message when
@ref{19d3,,smtplib.SMTP.connect()} is called.

@item 
bpo-37885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37885}: venv: Don’t generate unset variable warning on deactivate.

@item 
bpo-37868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37868}: Fix dataclasses.is_dataclass when given an instance that never
raises AttributeError in __getattr__.  That is, an object that returns
something for __dataclass_fields__ even if it’s not a dataclass.

@item 
bpo-37811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37811}: Fix @code{socket} module’s @code{socket.connect(address)} function
being unable to establish connection in case of interrupted system call.
The problem was observed on all OSes which @code{poll(2)} system call can
take only non-negative integers and -1 as a timeout value.

@item 
bpo-37863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37863}: Optimizations for Fraction.__hash__ suggested by Tim Peters.

@item 
bpo-21131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21131}: Fix @code{faulthandler.register(chain=True)} stack. faulthandler
now allocates a dedicated stack of @code{SIGSTKSZ*2} bytes, instead of just
@code{SIGSTKSZ} bytes. Calling the previous signal handler in faulthandler
signal handler uses more than @code{SIGSTKSZ} bytes of stack memory on some
platforms.

@item 
bpo-37798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37798}: Add C fastpath for statistics.NormalDist.inv_cdf() Patch by
Donghee Na

@item 
bpo-37804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37804}: Remove the deprecated method @code{threading.Thread.isAlive()}.
Patch by Donghee Na.

@item 
bpo-37819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37819}: Add Fraction.as_integer_ratio() to match the corresponding
methods in bool, int, float, and decimal.

@item 
bpo-14465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14465}: Add an xml.etree.ElementTree.indent() function for
pretty-printing XML trees. Contributed by Stefan Behnel.

@item 
bpo-37810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37810}: Fix @ref{38,,difflib} @code{?} hint in diff output when dealing with
tabs.  Patch by Anthony Sottile.

@item 
bpo-37772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37772}: In @code{zipfile.Path}, when adding implicit dirs, ensure that
ancestral directories are added and that duplicates are excluded.

@item 
bpo-18578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18578}: Renamed and documented @code{test.bytecode_helper} as
@code{test.support.bytecode_helper}. Patch by Joannah Nanjekye.

@item 
bpo-37785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37785}: Fix xgettext warnings in @ref{7,,argparse}.

@item 
bpo-34488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34488}: @code{writelines()} method of @ref{f25,,io.BytesIO} is now
slightly faster when many small lines are passed. Patch by Sergey
Fedoseev.

@item 
bpo-37449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37449}: @code{ensurepip} now uses @code{importlib.resources.read_binary()} to
read data instead of @code{pkgutil.get_data()}. Patch by Joannah Nanjekye.

@item 
bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}: Mark calendar.py helper functions as being private.  The
follows PEP 8 guidance to maintain the style conventions in the module and
it addresses a known case of user confusion.

@item 
bpo-18049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18049}: Add definition of THREAD_STACK_SIZE for AIX in
Python/thread_pthread.h The default thread stacksize caused crashes with
the default recursion limit Patch by M Felt

@item 
bpo-37742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37742}: The logging.getLogger() API now returns the root logger when
passed the name “root”, whereas previously it returned a non-root logger
named “root”. This could affect cases where user code explicitly wants a
non-root logger named “root”, or instantiates a logger using
logging.getLogger(__name__) in some top-level module called “root.py”.

@item 
bpo-37738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37738}: Fix the implementation of curses @code{addch(str, color_pair)}:
pass the color pair to @code{setcchar()}, instead of always passing 0 as the
color pair.

@item 
bpo-37723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37723}: Fix performance regression on regular expression parsing with
huge character sets. Patch by Yann Vaginay.

@item 
bpo-35943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35943}: The function @ref{c3b,,PyImport_GetModule()} now ensures any
module it returns is fully initialized. Patch by Joannah Nanjekye.

@item 
bpo-32178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32178}: Fix IndexError in @ref{3c,,email} package when trying to parse
invalid address fields starting with @code{:}.

@item 
bpo-37268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37268}: The @code{parser} module is deprecated and will be removed in
future versions of Python.

@item 
bpo-11953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11953}: Completing WSA* error codes in @ref{cc,,socket}.

@item 
bpo-37685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37685}: Fixed comparisons of @ref{a61,,datetime.timedelta} and
@ref{1134,,datetime.timezone}.

@item 
bpo-37697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37697}: Synchronize @code{importlib.metadata} with importlib_metadata 0.19@footnote{https://gitlab.com/python-devs/importlib_metadata/-/milestones/20},
improving handling of EGG-INFO files and fixing a crash when entry point
names contained colons.

@item 
bpo-37695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37695}: Correct @ref{1114,,curses.unget_wch()} error message.  Patch by
Anthony Sottile.

@item 
bpo-37689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37689}: Add @code{is_relative_to()} in @code{PurePath} to determine
whether or not one path is relative to another.

@item 
bpo-29553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29553}: Fixed @ref{19d4,,argparse.ArgumentParser.format_usage()} for mutually
exclusive groups. Patch by Andrew Nester.

@item 
bpo-37691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37691}: Let math.dist() accept coordinates as sequences (or iterables)
rather than just tuples.

@item 
bpo-37685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37685}: Fixed @code{__eq__}, @code{__lt__} etc implementations in some
classes. They now return @ref{227,,NotImplemented} for unsupported type of
the other operand. This allows the other operand to play role (for example
the equality comparison with @ref{19d5,,ANY} will return
@code{True}).

@item 
bpo-37354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37354}: Make Activate.ps1 Powershell script static to allow for signing
it.

@item 
bpo-37664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37664}: Update wheels bundled with ensurepip (pip 19.2.3 and setuptools
41.2.0)

@item 
bpo-37663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37663}: Bring consistency to venv shell activation scripts by always
using __VENV_PROMPT__.

@item 
bpo-37642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37642}: Allowed the pure Python implementation of
@ref{1134,,datetime.timezone} to represent sub-minute offsets close to
minimum and maximum boundaries, specifically in the ranges (23:59, 24:00)
and (-23:59, 24:00). Patch by Ngalim Siregar

@item 
bpo-36161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36161}: In @ref{ad,,posix}, use @code{ttyname_r} instead of @code{ttyname} for
thread safety.

@item 
bpo-36324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36324}: Make internal attributes for statistics.NormalDist() private.

@item 
bpo-37555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37555}: Fix @code{NonCallableMock._call_matcher} returning tuple instead
of @code{_Call} object when @code{self._spec_signature} exists. Patch by
Elizabeth Uselton

@item 
bpo-29446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29446}: Make @code{from tkinter import *} import only the expected
objects.

@item 
bpo-16970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16970}: Adding a value error when an invalid value in passed to nargs
Patch by Robert Leenders

@item 
bpo-34443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34443}: Exceptions from @ref{56,,enum} now use the @code{__qualname} of the
enum class in the exception message instead of the @code{__name__}.

@item 
bpo-37491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37491}: Fix @code{IndexError} when parsing email headers with unexpectedly
ending bare-quoted string value. Patch by Abhilash Raj.

@item 
bpo-37587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37587}: Make json.loads faster for long strings. (Patch by Marco
Paolini)

@item 
bpo-18378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18378}: Recognize «UTF-8» as a valid value for LC_CTYPE in
locale._parse_localename.

@item 
bpo-37579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37579}: Return @ref{227,,NotImplemented} in Python implementation of
@code{__eq__} for @ref{a61,,timedelta} and @ref{331,,time}
when the other object being compared is not of the same type to match C
implementation. Patch by Karthikeyan Singaravelan.

@item 
bpo-21478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21478}: Record calls to parent when autospecced object is attached to a
mock using @code{unittest.mock.attach_mock()}. Patch by Karthikeyan
Singaravelan.

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: «python3 -m test -jN –timeout=TIMEOUT» now kills a worker
process if it runs longer than `TIMEOUT' seconds.

@item 
bpo-37482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37482}: Fix serialization of display name in originator or destination
address fields with both encoded words and special chars.

@item 
bpo-36993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36993}: Improve error reporting for corrupt zip files with bad zip64
extra data. Patch by Daniel Hillier.

@item 
bpo-37502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37502}: pickle.loads() no longer raises TypeError when the buffers
argument is set to None

@item 
bpo-37520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37520}: Correct behavior for zipfile.Path.parent when the path object
identifies a subdirectory.

@item 
bpo-18374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18374}: Fix the @code{.col_offset} attribute of nested @ref{19d6,,ast.BinOp}
instances which had a too large value in some situations.

@item 
bpo-37424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37424}: Fixes a possible hang when using a timeout on
@code{subprocess.run()} while capturing output.  If the child process spawned
its own children or otherwise connected its stdout or stderr handles with
another process, we could hang after the timeout was reached and our child
was killed when attempting to read final output from the pipes.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: Fix @code{multiprocessing.util.get_temp_dir()} finalizer: clear
also the “tempdir” configuration of the current process, so next call to
@code{get_temp_dir()} will create a new temporary directory, rather than
reusing the removed temporary directory.

@item 
bpo-37481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37481}: The distutils @code{bdist_wininst} command is deprecated in Python
3.8, use @code{bdist_wheel} (wheel packages) instead.

@item 
bpo-37479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37479}: When @code{Enum.__str__} is overridden in a derived class, the
override will be used by @code{Enum.__format__} regardless of whether mixin
classes are present.

@item 
bpo-37440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37440}: http.client now enables TLS 1.3 post-handshake authentication
for default context or if a cert_file is passed to HTTPSConnection.

@item 
bpo-37437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37437}: Update vendorized expat version to 2.2.7.

@item 
bpo-37428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37428}: SSLContext.post_handshake_auth = True no longer sets
SSL_VERIFY_POST_HANDSHAKE verify flag for client connections. Although the
option is documented as ignored for clients, OpenSSL implicitly enables
cert chain validation when the flag is set.

@item 
bpo-37420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37420}: @ref{1180,,os.sched_setaffinity()} now correctly handles errors that
arise during iteration over its @code{mask} argument. Patch by Brandt Bucher.

@item 
bpo-37412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37412}: The @ref{b1c,,os.getcwdb()} function now uses the UTF-8 encoding on
Windows, rather than the ANSI code page: see 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} for the rationale.
The function is no longer deprecated on Windows.

@item 
bpo-37406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37406}: The sqlite3 module now raises TypeError, rather than
ValueError, if operation argument type is not str: execute(),
executemany() and calling a connection.

@item 
bpo-29412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29412}: Fix IndexError in parsing a header value ending unexpectedly.
Patch by Abhilash Raj.

@item 
bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}: The `dist' argument for statistics.quantiles() is now
positional only. The current name doesn’t reflect that the argument can be
either a dataset or a distribution.  Marking the parameter as positional
avoids confusion and makes it possible to change the name later.

@item 
bpo-37394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37394}: Fix a bug that was causing the @ref{b6,,queue} module to fail if
the accelerator module was not available. Patch by Pablo Galindo.

@item 
bpo-37376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37376}: @ref{ae,,pprint} now has support for
@ref{334,,types.SimpleNamespace}. Patch by Carl Bordum Hansen.

@item 
bpo-26967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26967}: An @ref{15c,,ArgumentParser} with
@code{allow_abbrev=False} no longer disables grouping of short flags, such as
@code{-vv}, but only disables abbreviation of long flags as documented. Patch
by Zac Hatfield-Dodds.

@item 
bpo-37212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37212}: @ref{19d7,,unittest.mock.call()} now preserves the order of keyword
arguments in repr output. Patch by Karthikeyan Singaravelan.

@item 
bpo-37372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37372}: Fix error unpickling datetime.time objects from Python 2 with
seconds>=24. Patch by Justin Blanchard.

@item 
bpo-37345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37345}: Add formal support for UDPLITE sockets. Support was present
before, but it is now easier to detect support with @code{hasattr(socket,
'IPPROTO_UDPLITE')} and there are constants defined for each of the
values needed: @code{socket.IPPROTO_UDPLITE}, @code{UDPLITE_SEND_CSCOV}, and
@code{UDPLITE_RECV_CSCOV}. Patch by Gabe Appleton.

@item 
bpo-37358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37358}: Optimized @code{functools.partial} by using vectorcall.

@item 
bpo-37347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37347}: @ref{3f7,,sqlite3.Connection.create_aggregate()},
@ref{3f6,,sqlite3.Connection.create_function()},
@ref{3f8,,sqlite3.Connection.set_authorizer()},
@ref{3f9,,sqlite3.Connection.set_progress_handler()}
@ref{3fa,,sqlite3.Connection.set_trace_callback()} methods lead to segfaults if
some of these methods are called twice with an equal object but not the
same. Now callbacks are stored more carefully. Patch by Aleksandr Balezin.

@item 
bpo-37163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37163}: The `obj' argument of @ref{16ff,,dataclasses.replace()} is
positional-only now.

@item 
bpo-37085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37085}: Add the optional Linux SocketCAN Broadcast Manager constants,
used as flags to configure the BCM behaviour, in the socket module.  Patch
by Karl Ding.

@item 
bpo-37328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37328}: @code{HTMLParser.unescape} is removed.  It was undocumented and
deprecated since Python 3.4.

@item 
bpo-37305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37305}: Add .webmanifest -> application/manifest+json to list of
recognized file types and content type headers

@item 
bpo-37320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37320}: @code{aifc.openfp()} alias to @code{aifc.open()}, @code{sunau.openfp()}
alias to @code{sunau.open()}, and @code{wave.openfp()} alias to @code{wave.open()}
have been removed. They were deprecated since Python 3.7.

@item 
bpo-37315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37315}: Deprecated accepting floats with integral value (like @code{5.0})
in @ref{9da,,math.factorial()}.

@item 
bpo-37312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37312}: @code{_dummy_thread} and @code{dummy_threading} modules have been
removed. These modules were deprecated since Python 3.7 which requires
threading support.

@item 
bpo-33972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33972}: Email with single part but content-type set to @code{multipart/*}
doesn’t raise AttributeError anymore.

@item 
bpo-37280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37280}: Use threadpool for reading from file for sendfile fallback
mode.

@item 
bpo-37279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37279}: Fix asyncio sendfile support when sendfile sends extra data in
fallback mode.

@item 
bpo-19865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19865}: @ref{19d8,,ctypes.create_unicode_buffer()} now also supports non-BMP
characters on platforms with 16-bit @code{wchar_t} (for example,
Windows and AIX).

@item 
bpo-37266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37266}: In a subinterpreter, spawning a daemon thread now raises an
exception. Daemon threads were never supported in subinterpreters.
Previously, the subinterpreter finalization crashed with a Python fatal
error if a daemon thread was still running.

@item 
bpo-37210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37210}: Allow pure Python implementation of @ref{a6,,pickle} to work even
when the C @code{_pickle} module is unavailable.

@item 
bpo-21872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21872}: Fix @ref{8a,,lzma}: module decompresses data incompletely. When
decompressing a FORMAT_ALONE format file, and it doesn’t have the end
marker, sometimes the last one to dozens bytes can’t be output. Patch by
Ma Lin.

@item 
bpo-35922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35922}: Fix @code{RobotFileParser.crawl_delay()} and
@code{RobotFileParser.request_rate()} to return @code{None} rather than raise
@ref{441,,AttributeError} when no relevant rule is defined in the robots.txt
file.  Patch by Rémi Lapeyre.

@item 
bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}: Change the format of feature_version to be a (major, minor)
tuple.

@item 
bpo-36607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36607}: Eliminate @ref{1e5,,RuntimeError} raised by
@ref{9e9,,asyncio.all_tasks()} if internal tasks weak set is changed by another
thread during iteration.

@item 
bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}: @code{_pyio.IOBase} destructor now does nothing if getting
the @code{closed} attribute fails to better mimic @code{_io.IOBase}
finalizer.

@item 
bpo-36402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36402}: Fix a race condition at Python shutdown when waiting for
threads. Wait until the Python thread state of all non-daemon threads get
deleted (join all non-daemon threads), rather than just wait until
non-daemon Python threads complete.

@item 
bpo-37206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37206}: Default values which cannot be represented as Python objects no
longer improperly represented as @code{None} in function signatures.

@item 
bpo-37111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37111}: Added @code{encoding} and @code{errors} keyword parameters to
@code{logging.basicConfig}.

@item 
bpo-12144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12144}: Ensure cookies with @code{expires} attribute are handled in
@code{CookieJar.make_cookies()}.

@item 
bpo-34886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34886}: Fix an unintended ValueError from @ref{c0e,,subprocess.run()} when
checking for conflicting `input' and `stdin' or `capture_output' and
`stdout' or `stderr' args when they were explicitly provided but with
@code{None} values within a passed in @code{**kwargs} dict rather than as passed
directly by name. Patch contributed by Rémi Lapeyre.

@item 
bpo-37173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37173}: The exception message for @code{inspect.getfile()} now correctly
reports the passed class rather than the builtins module.

@item 
bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178}: Give math.perm() a one argument form that means the same as
math.factorial().

@item 
bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178}: For math.perm(n, k), let k default to n, giving the same result
as factorial.

@item 
bpo-37165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37165}: Converted _collections._count_elements to use the Argument
Clinic.

@item 
bpo-34767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34767}: Do not always create a @ref{67d,,collections.deque} in
@ref{b00,,asyncio.Lock}.

@item 
bpo-37158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37158}: Speed-up statistics.fmean() by switching from a function to a
generator.

@item 
bpo-34282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34282}: Remove @code{Enum._convert} method, deprecated in 3.8.

@item 
bpo-37150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37150}: @code{argparse._ActionsContainer.add_argument} now throws error,
if someone accidentally pass FileType class object instead of instance of
FileType as @code{type} argument.

@item 
bpo-28724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28724}: The socket module now has the @ref{9c6,,socket.send_fds()} and
@code{socket.recv.fds()} methods. Contributed by Joannah Nanjekye, Shinya
Okano and Victor Stinner.

@item 
bpo-35621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35621}: Support running asyncio subprocesses when execution event loop
in a thread on UNIX.

@item 
bpo-36520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36520}: Lengthy email headers with UTF-8 characters are now properly
encoded when they are folded. Patch by Jeffrey Kintscher.

@item 
bpo-30835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30835}: Fixed a bug in email parsing where a message with invalid bytes
in content-transfer-encoding of a multipart message can cause an
AttributeError. Patch by Andrew Donnellan.

@item 
bpo-31163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31163}: pathlib.Path instance’s rename and replace methods now return
the new Path instance.

@item 
bpo-25068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25068}: @ref{19d9,,urllib.request.ProxyHandler} now lowercases the keys of
the passed dictionary.

@item 
bpo-26185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26185}: Fix @ref{894,,repr()} on empty @code{ZipInfo} object. Patch by
Mickaël Schoentgen.

@item 
bpo-21315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21315}: Email headers containing RFC2047 encoded words are parsed
despite the missing whitespace, and a defect registered. Also missing
trailing whitespace after encoded words is now registered as a defect.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Port test_datetime to VxWorks: skip zoneinfo tests on VxWorks

@item 
bpo-35805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35805}: Add parser for Message-ID header and add it to default
HeaderRegistry. This should prevent folding of Message-ID using RFC 2048
encoded words.

@item 
bpo-36871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36871}: Ensure method signature is used instead of constructor
signature of a class while asserting mock object against method calls.
Patch by Karthikeyan Singaravelan.

@item 
bpo-35070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35070}: posix.getgrouplist() now works correctly when the user belongs
to NGROUPS_MAX supplemental groups. Patch by Jeffrey Kintscher.

@item 
bpo-31783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31783}: Fix race condition in ThreadPoolExecutor when worker threads
are created during interpreter shutdown.

@item 
bpo-36582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36582}: Fix @code{UserString.encode()} to correctly return @code{bytes}
rather than a @code{UserString} instance.

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: Deprecate xml.etree.ElementTree.Element.copy() in favor of
copy.copy().

Patch by Gordon P. Hemsley

@item 
bpo-36564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36564}: Fix infinite loop in email header folding logic that would be
triggered when an email policy’s max_line_length is not long enough to
include the required markup and any values in the message. Patch by Paul
Ganssle

@item 
bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543}: Removed methods Element.getchildren(), Element.getiterator()
and ElementTree.getiterator() and the xml.etree.cElementTree module.

@item 
bpo-36409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36409}: Remove the old plistlib API deprecated in Python 3.4

@item 
bpo-36302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36302}: distutils sorts source file lists so that Extension .so files
build more reproducibly by default

@item 
bpo-36250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36250}: Ignore @code{ValueError} from @code{signal} with @code{interaction} in
non-main thread.

@item 
bpo-36046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36046}: Added @code{user}, @code{group} and @code{extra_groups} parameters to
the subprocess.Popen constructor. Patch by Patrick McLean.

@item 
bpo-32627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32627}: Fix compile error when @code{_uuid} headers conflicting included.

@item 
bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}: Deprecate @code{smtpd.MailmanProxy} ready for future removal.

@item 
bpo-35168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35168}: @ref{19da,,shlex.shlex.punctuation_chars} is now a read-only
property.

@item 
bpo-8538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8538}: Add support for boolean actions like @code{--foo} and @code{--no-foo}
to argparse. Patch contributed by Rémi Lapeyre.

@item 
bpo-20504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20504}: Fixes a bug in @code{cgi} module when a multipart/form-data
request has no @code{Content-Length} header.

@item 
bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}: The abstract base classes in @ref{1f,,collections.abc} no longer
are exposed in the regular @ref{1e,,collections} module.

@item 
bpo-11122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11122}: Distutils won’t check for rpmbuild in specified paths only.

@item 
bpo-34775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34775}: Division handling of PurePath now returns NotImplemented
instead of raising a TypeError when passed something other than an
instance of str or PurePath. Patch by Roger Aiudi.

@item 
bpo-34749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34749}: @ref{1639,,binascii.a2b_base64()} is now up to 2 times faster. Patch
by Sergey Fedoseev.

@item 
bpo-34519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34519}: Add additional aliases for HP Roman 8. Patch by Michael Osipov.

@item 
bpo-28009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28009}: Fix uuid.getnode() on platforms with “.” as MAC Addr delimiter
as well fix for MAC Addr format that omits a leading 0 in MAC Addr values.
Currently, AIX is the only know platform with these settings. Patch by
Michael Felt.

@item 
bpo-30618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30618}: Add @ref{9b3,,readlink()}. Patch by Girts Folkmanis.

@item 
bpo-32498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32498}: Made @ref{178e,,urllib.parse.unquote()} accept bytes in addition to
strings. Patch by Stein Karlsen.

@item 
bpo-33348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33348}: lib2to3 now recognizes expressions after @code{*} and @code{**} like
in @code{f(*[] or [])}.

@item 
bpo-32689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32689}: Update @ref{aed,,shutil.move()} function to allow for Path objects
to be used as source argument. Patch by Emily Morehouse and Maxwell
«5.13b» McKinnon.

@item 
bpo-32820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32820}: Added @code{__format__} to IPv4 and IPv6 classes.  Always outputs
a fully zero-padded string. Supports b/x/n modifiers (bin/hex/native
format). Native format for IPv4 is bin, native format for IPv6 is hex.
Also supports “#” and “_” modifiers.

@item 
bpo-27657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27657}: Fix urllib.parse.urlparse() with numeric paths. A string like
«path:80» is no longer parsed as a path but as a scheme («path») and a
path («80»).

@item 
bpo-4963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4963}: Fixed non-deterministic behavior related to mimetypes extension
mapping and module reinitialization.
@end itemize

@node Documentation<39>,Tests<38>,Library<40>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id365}@anchor{19db}
@subsubsection Documentation



@itemize -

@item 
bpo-21767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21767}: Explicitly mention abc support in functools.singledispatch

@item 
bpo-38816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38816}: Provides more details about the interaction between
@code{fork()} and CPython’s runtime, focusing just on the C-API.  This
includes cautions about where @code{fork()} should and shouldn’t be
called.

@item 
bpo-38351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38351}: Modernize @ref{3c,,email} examples from %-formatting to f-strings.

@item 
bpo-38778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38778}: Document the fact that @ref{1e5,,RuntimeError} is raised if
@ref{2ff,,os.fork()} is called in a subinterpreter.

@item 
bpo-38592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38592}: Add Brazilian Portuguese to the language switcher at Python
Documentation website.

@item 
bpo-38294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38294}: Add list of no-longer-escaped chars to re.escape documentation

@item 
bpo-38053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38053}: Modernized the plistlib documentation

@item 
bpo-26868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26868}: Fix example usage of @ref{45a,,PyModule_AddObject()} to properly
handle errors.

@item 
bpo-36797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36797}: Fix a dead link in the distutils API Reference.

@item 
bpo-37977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37977}: Warn more strongly and clearly about pickle insecurity

@item 
bpo-37979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37979}: Added a link to dateutil.parser.isoparse in the
datetime.fromisoformat documentation. Patch by Paul Ganssle

@item 
bpo-12707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12707}: Deprecate info(), geturl(), getcode() methods in favor of the
headers, url, and status properties, respectively, for HTTPResponse and
addinfourl. Also deprecate the code attribute of addinfourl in favor of
the status attribute. Patch by Ashwin Ramaswami

@item 
bpo-37937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37937}: Mention @code{frame.f_trace} in @ref{1540,,sys.settrace()} docs.

@item 
bpo-37878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37878}: Make @ref{19dc,,PyThreadState_DeleteCurrent()} Internal.

@item 
bpo-37759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37759}: Beginning edits to Whatsnew 3.8

@item 
bpo-37726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37726}: Stop recommending getopt in the tutorial for command line
argument parsing and promote argparse.

@item 
bpo-32910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32910}: Remove implementation-specific behaviour of how venv’s
Deactivate works.

@item 
bpo-37256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37256}: Fix wording of arguments for @code{Request} in
@ref{10b,,urllib.request}

@item 
bpo-37284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37284}: Add a brief note to indicate that any new
@code{sys.implementation} required attributes must go through the PEP
process.

@item 
bpo-30088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30088}: Documented that @ref{4da,,mailbox.Maildir} constructor doesn’t
attempt to verify the maildir folder layout correctness. Patch by
Sviatoslav Sydorenko.

@item 
bpo-37521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37521}: Fix @code{importlib} examples to insert any newly created modules
via importlib.util.module_from_spec() immediately into sys.modules instead
of after calling loader.exec_module().

Thanks to Benjamin Mintz for finding the bug.

@item 
bpo-37456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37456}: Slash (“/”) is now part of syntax.

@item 
bpo-37487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37487}: Fix PyList_GetItem index description to include 0.

@item 
bpo-37149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37149}: Replace the dead link to the Tkinter 8.5 reference by John
Shipman, New Mexico Tech, with a link to the archive.org copy.

@item 
bpo-37478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37478}: Added possible exceptions to the description of os.chdir().

@item 
bpo-34903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34903}: Documented that in @ref{15ec,,datetime.datetime.strptime()}, the
leading zero in some two-digit formats is optional. Patch by Mike Gleen.

@item 
bpo-36260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36260}: Add decompression pitfalls to zipfile module documentation.

@item 
bpo-37004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37004}: In the documentation for difflib, a note was added explicitly
warning that the results of SequenceMatcher’s ratio method may depend on
the order of the input strings.

@item 
bpo-36960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36960}: Restructured the @ref{31,,datetime} docs in the interest of making
them more user-friendly and improving readability. Patch by Brad Solomon.

@item 
bpo-36487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36487}: Make C-API docs clear about what the «main» interpreter is.

@item 
bpo-23460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23460}: The documentation for decimal string formatting using the
@code{:g} specifier has been updated to reflect the correct exponential
notation cutoff point. Original patch contributed by Tuomas Suutari.

@item 
bpo-35803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35803}: Document and test that @code{tempfile} functions may accept a
@ref{3f0,,path-like object} for the @code{dir} argument.  Patch by Anthony
Sottile.

@item 
bpo-33944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33944}: Added a note about the intended use of code in .pth files.

@item 
bpo-34293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34293}: Fix the Doc/Makefile regarding PAPER environment variable and
PDF builds

@item 
bpo-25237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25237}: Add documentation for tkinter modules
@end itemize

@node Tests<38>,Build<40>,Documentation<39>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id366}@anchor{19dd}
@subsubsection Tests



@itemize -

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: Fix test_communicate() of test_asyncio.test_subprocess: use
@code{support.LONG_TIMEOUT} (5 minutes), instead of just 1 minute.

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: Add timeout constants to @ref{e4,,test.support}:
@ref{19bd,,LOOPBACK_TIMEOUT},
@ref{19be,,INTERNET_TIMEOUT},
@ref{18b7,,SHORT_TIMEOUT} and
@ref{19bf,,LONG_TIMEOUT}.

@item 
bpo-38502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38502}: test.regrtest now uses process groups in the multiprocessing
mode (-jN command line option) if process groups are available: if
@ref{19de,,os.setsid()} and @ref{19df,,os.killpg()} functions are available.

@item 
bpo-35998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35998}: Fix a race condition in test_asyncio.test_start_tls_server_1().
Previously, there was a race condition between the test main() function
which replaces the protocol and the test ServerProto protocol which sends
ANSWER once it gets HELLO. Now, only the test main() function is
responsible to send data, ServerProto no longer sends data.

@item 
bpo-38470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38470}: Fix @code{test_compileall.test_compile_dir_maxlevels()} on Windows
without long path support: only create 3 subdirectories instead of between
20 and 100 subdirectories.

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: On timeout, regrtest no longer attempts to call
@code{popen.communicate()} again: it can hang until all child processes using
stdout and stderr pipes completes. Kill the worker process and ignores its
output. Change also the faulthandler timeout of the main process from 1
minute to 5 minutes, for Python slowest buildbots.

@item 
bpo-38239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38239}: Fix test_gdb for Link Time Optimization (LTO) builds.

@item 
bpo-38275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38275}: test_ssl now handles disabled TLS/SSL versions better.
OpenSSL’s crypto policy and run-time settings are recognized and tests for
disabled versions are skipped. Tests also accept more TLS minimum_versions
for platforms that override OpenSSL’s default with strict settings.

@item 
bpo-38271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38271}: The private keys for test_ssl were encrypted with 3DES in
traditional PKCS#5 format. 3DES and the digest algorithm of PKCS#5 are
blocked by some strict crypto policies. Use PKCS#8 format with AES256
encryption instead.

@item 
bpo-38270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38270}: test.support now has a helper function to check for
availability of a hash digest function. Several tests are refactored avoid
MD5 and use SHA256 instead. Other tests are marked to use MD5 and skipped
when MD5 is disabled.

@item 
bpo-37123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37123}: Multiprocessing test test_mymanager() now also expects
-SIGTERM, not only exitcode 0. BaseManager._finalize_manager() sends
SIGTERM to the manager process if it takes longer than 1 second to stop,
which happens on slow buildbots.

@item 
bpo-38212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38212}: Multiprocessing tests: increase
test_queue_feeder_donot_stop_onexc() timeout from 1 to 60 seconds.

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: Test with OpenSSL 1.1.1d

@item 
bpo-38018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38018}: Increase code coverage for multiprocessing.shared_memory.

@item 
bpo-37805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37805}: Add tests for json.dump(…, skipkeys=True). Patch by Donghee
Na.

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: Enhance regrtest multiprocess timeout: write a message when
killing a worker process, catch popen.kill() and popen.wait() exceptions,
put a timeout on the second call to popen.communicate().

@item 
bpo-37876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37876}: Add tests for ROT-13 codec.

@item 
bpo-36833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36833}: Added tests for @code{PyDateTime_@var{xxx}_GET_@var{xxx}()} macros of
the C API of the @ref{31,,datetime} module. Patch by Joannah Nanjekye.

@item 
bpo-37558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37558}: Fix test_shared_memory_cleaned_after_process_termination name
handling

@item 
bpo-37526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37526}: Add @code{test.support.catch_threading_exception()}: context
manager catching @ref{9df,,threading.Thread} exception using
@ref{8e2,,threading.excepthook()}.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_concurrent_futures now explicitly stops the ForkServer
instance if it’s running.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: multiprocessing tests now stop the ForkServer instance if it’s
running: close the «alive» file descriptor to ask the server to stop and
then remove its UNIX address.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_distutils.test_build_ext() is now able to remove the
temporary directory on Windows: don’t import the newly built C extension
(«xx») in the current process, but test it in a separated process.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_concurrent_futures now cleans up multiprocessing to remove
immediately temporary directories created by
multiprocessing.util.get_temp_dir().

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_winconsoleio doesn’t leak a temporary file anymore: use
tempfile.TemporaryFile() to remove it when the test completes.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: multiprocessing tests now explicitly call @code{_run_finalizers()}
to immediately remove temporary directories created by tests.

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: urllib.request tests now call
@ref{19e0,,urlcleanup()} to remove temporary files created by
@code{urlretrieve()} tests and to clear the @code{_opener} global variable set
by @code{urlopen()} and functions calling indirectly @code{urlopen()}.

@item 
bpo-37472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37472}: Remove @code{Lib/test/outstanding_bugs.py}.

@item 
bpo-37199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37199}: Fix test failures when IPv6 is unavailable or disabled.

@item 
bpo-19696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19696}: Replace deprecated method «random.choose» with «random.choice»
in «test_pkg_import.py».

@item 
bpo-37335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37335}: Remove no longer necessary code from c locale coercion tests

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: Fix test_shutil to no longer leak temporary files.

@item 
bpo-37411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37411}: Fix test_wsgiref.testEnviron() to no longer depend on the
environment variables (don’t fail if «X» variable is set).

@item 
bpo-37400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37400}: Fix test_os.test_chown(): use os.getgroups() rather than
grp.getgrall() to get groups. Rename also the test to test_chown_gid().

@item 
bpo-37359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37359}: Add –cleanup option to python3 -m test to remove
@code{test_python_*} directories of previous failed jobs. Add «make
cleantest» to run @code{python3 -m test --cleanup}.

@item 
bpo-37362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37362}: test_gdb no longer fails if it gets an «unexpected» message on
stderr: it now ignores stderr. The purpose of test_gdb is to test that
python-gdb.py commands work as expected, not to test gdb.

@item 
bpo-35998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35998}: Avoid TimeoutError in test_asyncio: test_start_tls_server_1()

@item 
bpo-37278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37278}: Fix test_asyncio ProactorLoopCtrlC: join the thread to prevent
leaking a running thread and leaking a reference.

@item 
bpo-37261@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37261}: Fix @ref{19e1,,test.support.catch_unraisable_exception()}: its
__exit__() method now ignores unraisable exception raised when clearing
its @code{unraisable} attribute.

@item 
bpo-37069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37069}: regrtest now uses @ref{355,,sys.unraisablehook()} to mark a test as
«environment altered» (ENV_CHANGED) if it emits an «unraisable exception».
Moreover, regrtest logs a warning in this case.

Use @code{python3 -m test --fail-env-changed} to catch unraisable exceptions
in tests.

@item 
bpo-37252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37252}: Fix assertions in @code{test_close} and
@code{test_events_mask_overflow} devpoll tests.

@item 
bpo-37169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37169}: Rewrite @code{_PyObject_IsFreed()} unit tests.

@item 
bpo-37153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37153}: @code{test_venv.test_multiprocessing()} now explicitly calls
@code{pool.terminate()} to wait until the pool completes.

@item 
bpo-34001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34001}: Make test_ssl pass with LibreSSL. LibreSSL handles minimum and
maximum TLS version differently than OpenSSL.

@item 
bpo-36919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36919}: Make @code{test_source_encoding.test_issue2301} implementation
independent. The test will work now for both CPython and IronPython.

@item 
bpo-30202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30202}: Update @code{test.test_importlib.test_abc} to test
@code{find_spec()}.

@item 
bpo-28009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28009}: Modify the test_uuid logic to test when a program is available
AND can be used to obtain a MACADDR as basis for an UUID. Patch by M. Felt

@item 
bpo-34596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34596}: Fallback to a default reason when @ref{19e2,,unittest.skip()} is
uncalled. Patch by Naitree Zhu.
@end itemize

@node Build<40>,Windows<38>,Tests<38>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id367}@anchor{19e3}
@subsubsection Build



@itemize -

@item 
bpo-38809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38809}: On Windows, build scripts will now recognize and use python.exe
from an active virtual env.

@item 
bpo-38684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38684}: Fix _hashlib build when Blake2 is disabled, but OpenSSL
supports it.

@item 
bpo-38468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38468}: Misc/python-config.in now uses @code{getvar()} for all still
existing @code{sysconfig.get_config_var()} calls. Patch by Joannah Nanjekye.

@item 
bpo-37415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37415}: Fix stdatomic.h header check for ICC compiler: the ICC
implementation lacks atomic_uintptr_t type which is needed by Python.

@item 
bpo-38301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38301}: In Solaris family, we must be sure to use @code{-D_REENTRANT}.
Patch by Jesús Cea Avión.

@item 
bpo-36002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36002}: Locate @code{llvm-profdata} and @code{llvm-ar} binaries using
@code{AC_PATH_TOOL} rather than @code{AC_PATH_TARGET_TOOL}.

@item 
bpo-37936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37936}: The @code{.gitignore} file systematically keeps «rooted», with
a non-trailing slash, all the rules that are meant to apply to files in a
specific place in the repo.  Previously, when the intended file to ignore
happened to be at the root of the repo, we’d most often accidentally also
ignore files and directories with the same name anywhere in the tree.

@item 
bpo-37760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37760}: The @code{Tools/unicode/makeunicodedata.py} script, which is
used for converting information from the Unicode Character Database into
generated code and data used by the methods of @ref{237,,str} and by the
@ref{105,,unicodedata} module, now handles each character’s data as a
@code{dataclass} with named attributes, rather than a length-18 list of
different fields.

@item 
bpo-37936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37936}: The @code{.gitignore} file no longer applies to any files that
are in fact tracked in the Git repository.  Patch by Greg Price.

@item 
bpo-37725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37725}: Change «clean» makefile target to also clean the program guided
optimization (PGO) data.  Previously you would have to use «make clean»
and «make profile-removal», or «make clobber».

@item 
bpo-37707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37707}: Mark some individual tests to skip when –pgo is used.  The
tests marked increase the PGO task time significantly and likely don’t
help improve optimization of the final executable.

@item 
bpo-36044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36044}: Reduce the number of unit tests run for the PGO generation
task.  This speeds up the task by a factor of about 15x.  Running the full
unit test suite is slow.  This change may result in a slightly less
optimized build since not as many code branches will be executed.  If you
are willing to wait for the much slower build, the old behavior can be
restored using “./configure [..] PROFILE_TASK=»-m test –pgo-extended»”.
We make no guarantees as to which PGO task set produces a faster build.
Users who care should run their own relevant benchmarks as results can
depend on the environment, workload, and compiler tool chain.

@item 
bpo-37468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37468}: @code{make install} no longer installs @code{wininst-*.exe} files
used by distutils bdist_wininst: bdist_wininst only works on Windows.

@item 
bpo-37189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37189}: Many @code{PyRun_@var{XXX}()} functions like
@ref{19e4,,PyRun_String()} were no longer exported in @code{libpython38.dll} by
mistake. Export them again to fix the ABI compatibility.

@item 
bpo-25361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25361}: Enables use of SSE2 instructions in Windows 32-bit build.

@item 
bpo-36210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36210}: Update optional extension module detection for AIX. ossaudiodev
and spwd are not applicable for AIX, and are no longer reported as
missing. 3rd-party packaging of ncurses (with ASIS support) conflicts with
officially supported AIX curses library, so configure AIX to use
libcurses.a. However, skip trying to build _curses_panel.

patch by M Felt
@end itemize

@node Windows<38>,macOS<32>,Build<40>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id368}@anchor{19e5}
@subsubsection Windows



@itemize -

@item 
bpo-38589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38589}: Fixes HTML Help shortcut when Windows is not installed to C
drive

@item 
bpo-38453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38453}: Ensure ntpath.realpath() correctly resolves relative paths.

@item 
bpo-38519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38519}: Restores the internal C headers that were missing from the
nuget.org and Microsoft Store packages.

@item 
bpo-38492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38492}: Remove @code{pythonw.exe} dependency on the Microsoft C++ runtime.

@item 
bpo-38344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38344}: Fix error message in activate.bat

@item 
bpo-38359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38359}: Ensures @code{pyw.exe} launcher reads correct registry key.

@item 
bpo-38355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38355}: Fixes @code{ntpath.realpath} failing on @code{sys.executable}.

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: Update bundled OpenSSL to 1.1.1d

@item 
bpo-38092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38092}: Reduce overhead when using multiprocessing in a Windows virtual
environment.

@item 
bpo-38133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38133}: Allow py.exe launcher to locate installations from the
Microsoft Store and improve display of active virtual environments.

@item 
bpo-38114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38114}: The @code{pip.ini} is no longer included in the Nuget package.

@item 
bpo-32592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32592}: Set Windows 8 as the minimum required version for API support

@item 
bpo-36634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36634}: @ref{328,,os.cpu_count()} now returns active processors rather than
maximum processors.

@item 
bpo-36634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36634}: venv activate.bat now works when the existing variables contain
double quote characters.

@item 
bpo-38081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38081}: Prevent error calling @ref{381,,os.path.realpath()} on @code{'NUL'}.

@item 
bpo-38087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38087}: Fix case sensitivity in test_pathlib and test_ntpath.

@item 
bpo-38088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38088}: Fixes distutils not finding vcruntime140.dll with only the v142
toolset installed.

@item 
bpo-37283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37283}: Ensure command-line and unattend.xml setting override
previously detected states in Windows installer.

@item 
bpo-38030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38030}: Fixes @ref{548,,os.stat()} failing for block devices on Windows

@item 
bpo-38020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38020}: Fixes potential crash when calling @ref{9b4,,os.readlink()} (or
indirectly through @ref{381,,realpath()}) on a file that is not a
supported link.

@item 
bpo-37705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37705}: Improve the implementation of @code{winerror_to_errno()}.

@item 
bpo-37549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37549}: @ref{19e6,,os.dup()} no longer fails for standard streams on Windows
7.

@item 
bpo-1311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1311}: The @code{nul} file on Windows now returns True from
@ref{aa0,,exists()} and a valid result from @ref{548,,os.stat()} with
@code{S_IFCHR} set.

@item 
bpo-9949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9949}: Enable support for following symlinks in @code{os.realpath()}.

@item 
bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}: Treat all name surrogate reparse points on Windows in
@ref{549,,os.lstat()} and other reparse points as regular files in
@ref{548,,os.stat()}.

@item 
bpo-36266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36266}: Add the module name in the formatted error message when DLL
load fail happens during module import in
@code{_PyImport_FindSharedFuncptrWindows()}. Patch by Srinivas Nyayapati.

@item 
bpo-25172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25172}: Trying to import the @code{crypt} module on Windows will
result in an @ref{4d7,,ImportError} with a message explaining that the module
isn’t supported on Windows. On other platforms, if the underlying
@code{_crypt} module is not available, the ImportError will include a message
explaining the problem.

@item 
bpo-37778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37778}: Fixes the icons used for file associations to the Microsoft
Store package.

@item 
bpo-37734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37734}: Fix use of registry values to launch Python from Microsoft
Store app.

@item 
bpo-37702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37702}: Fix memory leak on Windows in creating an SSLContext object or
running @code{urllib.request.urlopen('https://...')}.

@item 
bpo-37672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37672}: Switch Windows Store package’s pip to use bundled
@code{pip.ini} instead of 
@geindex PIP_USER
@geindex variables de entorno; PIP_USER
@code{PIP_USER} variable.

@item 
bpo-10945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10945}: Officially drop support for creating bdist_wininst installers
on non-Windows systems.

@item 
bpo-37445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37445}: Include the @code{FORMAT_MESSAGE_IGNORE_INSERTS} flag in
@code{FormatMessageW()} calls.

@item 
bpo-37369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37369}: Fixes path for @ref{283,,sys.executable} when running from the
Microsoft Store.

@item 
bpo-37380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37380}: Don’t collect unfinished processes with @code{subprocess._active}
on Windows to cleanup later. Patch by Ruslan Kuprieiev.

@item 
bpo-37351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37351}: Removes libpython38.a from standard Windows distribution.

@item 
bpo-35360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35360}: Update Windows builds to use SQLite 3.28.0.

@item 
bpo-37267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37267}: On Windows, @ref{19e6,,os.dup()} no longer creates an inheritable fd
when handling a character file.

@item 
bpo-36779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36779}: Ensure @code{time.tzname} is correct on Windows when the active
code page is set to CP_UTF7 or CP_UTF8.

@item 
bpo-32587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32587}: Make @ref{19e7,,winreg.REG_MULTI_SZ} support zero-length strings.

@item 
bpo-28269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28269}: Replace use of @code{strcasecmp()} for the system function
@code{_stricmp()}. Patch by Minmin Gong.

@item 
bpo-36590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36590}: Add native Bluetooth RFCOMM support to socket module.
@end itemize

@node macOS<32>,IDLE<28>,Windows<38>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id369}@anchor{19e8}
@subsubsection macOS



@itemize -

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: Updated OpenSSL to 1.1.1d in macOS installer.

@item 
bpo-38089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38089}: Move Azure Pipelines to latest VM versions and make macOS tests
optional

@item 
bpo-18049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18049}: Increase the default stack size of threads from 5MB to 16MB on
macOS, to match the stack size of the main thread. This avoids crashes on
deep recursion in threads.

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: Avoid test suite failures on macOS by no longer calling
resource.setrlimit to increase the process stack size limit at runtime.
The runtime change is no longer needed since the interpreter is being
built with a larger default stack size.

@item 
bpo-35360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35360}: Update macOS installer to use SQLite 3.28.0.

@item 
bpo-34631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34631}: Updated OpenSSL to 1.1.1c in macOS installer.
@end itemize

@node IDLE<28>,Tools/Demos<20>,macOS<32>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id370}@anchor{19e9}
@subsubsection IDLE



@itemize -

@item 
bpo-26353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26353}: Stop adding newline when saving an IDLE shell window.

@item 
bpo-4630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4630}: Add an option to toggle IDLE’s cursor blink for shell, editor,
and output windows.  See Settings, General, Window Preferences, Cursor
Blink. Patch by Zackery Spytz.

@item 
bpo-38598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38598}: Do not try to compile IDLE shell or output windows

@item 
bpo-36698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36698}: IDLE no longer fails when write non-encodable characters to
stderr.  It now escapes them with a backslash, as the regular Python
interpreter. Added the @code{errors} field to the standard streams.

@item 
bpo-35379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35379}: When exiting IDLE, catch any AttributeError.  One happens when
EditorWindow.close is called twice.  Printing a traceback, when IDLE is
run from a terminal, is useless and annoying.

@item 
bpo-38183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38183}: To avoid problems, test_idle ignores the user config directory.
It no longer tries to create or access .idlerc or any files within. Users
must run IDLE to discover problems with saving settings.

@item 
bpo-38077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38077}: IDLE no longer adds “argv” to the user namespace when
initializing it.  This bug only affected 3.7.4 and 3.8.0b2 to 3.8.0b4.

@item 
bpo-38041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38041}: Shell restart lines now fill the window width, always start
with “=”, and avoid wrapping unnecessarily. The line will still wrap if
the included file name is long relative to the width.

@item 
bpo-35771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35771}: To avoid occasional spurious test_idle failures on slower
machines, increase the @code{hover_delay} in test_tooltip.

@item 
bpo-37824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37824}: Properly handle user input warnings in IDLE shell. Cease
turning SyntaxWarnings into SyntaxErrors.

@item 
bpo-37929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37929}: IDLE Settings dialog now closes properly when there is no shell
window.

@item 
bpo-37902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37902}: Add mousewheel scrolling for IDLE module, path, and stack
browsers. Patch by George Zhang.

@item 
bpo-37849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37849}: Fixed completions list appearing too high or low when shown
above the current line.

@item 
bpo-36419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36419}: Refactor IDLE autocomplete and improve testing.

@item 
bpo-37748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37748}: Reorder the Run menu.  Put the most common choice, Run Module,
at the top.

@item 
bpo-37692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37692}: Improve highlight config sample with example shell interaction
and better labels for shell elements.

@item 
bpo-37628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37628}: Settings dialog no longer expands with font size.

@item 
bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}: Initialize the Customize Run dialog with the command line
arguments most recently entered before.  The user can optionally edit
before submitting them.

@item 
bpo-33610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33610}: Fix code context not showing the correct context when first
toggled on.

@item 
bpo-37530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37530}: Optimize code context to reduce unneeded background activity.
Font and highlight changes now occur along with text changes instead of
after a random delay.

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: Cleanup @code{config.py} by inlining @code{RemoveFile} and
simplifying the handling of @code{file} in @code{CreateConfigHandlers}.

@item 
bpo-37325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37325}: Fix tab focus traversal order for help source and custom run
dialogs.

@item 
bpo-37321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37321}: Both subprocess connection error messages now refer to the
“Startup failure” section of the IDLE doc.

@item 
bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}: Add optional line numbers for IDLE editor windows.  Windows
open without line numbers unless set otherwise in the General tab of the
configuration dialog.

@item 
bpo-26806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26806}: To compensate for stack frames added by IDLE and avoid possible
problems with low recursion limits, add 30 to limits in the user code
execution process.  Subtract 30 when reporting recursion limits to make
this addition mostly transparent.

@item 
bpo-37177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37177}: Properly “attach” search dialogs to their main window so that
they behave like other dialogs and do not get hidden behind their main
window.

@item 
bpo-37039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37039}: Adjust «Zoom Height» to individual screens by momentarily
maximizing the window on first use with a particular screen.  Changing
screen settings may invalidate the saved height.  While a window is
maximized, «Zoom Height» has no effect.

@item 
bpo-35763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35763}: Make calltip reminder about “/” meaning positional-only less
obtrusive by only adding it when there is room on the first line.

@item 
bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680}: Add “Run… Customized” to the Run menu to run a module with
customized settings.  Any “command line arguments” entered are added to
sys.argv. One can suppress the normal Shell main module restart.

@item 
bpo-36390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36390}: Gather Format menu functions into format.py.  Combine
paragraph.py, rstrip.py, and format methods from editor.py.
@end itemize

@node Tools/Demos<20>,C API<39>,IDLE<28>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id371}@anchor{19ea}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-38118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38118}: Update Valgrind suppression file to ignore a false alarm in
@ref{19eb,,PyUnicode_Decode()} when using GCC builtin strcmp().

@item 
bpo-38347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38347}: pathfix.py: Assume all files that end on “.py” are Python
scripts when working recursively.

@item 
bpo-37803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37803}: pdb’s @code{--help} and @code{--version} long options now work.

@item 
bpo-37942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37942}: Improve ArgumentClinic converter for floats.

@item 
bpo-37704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37704}: Remove @code{Tools/scripts/h2py.py}: use cffi to access a C API in
Python.

@item 
bpo-37675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37675}: 2to3 now works when run from a zipped standard library.

@item 
bpo-37034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37034}: Argument Clinic now uses the argument name on errors with
keyword-only argument instead of their position. Patch contributed by Rémi
Lapeyre.

@item 
bpo-37064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37064}: Add option -k to pathscript.py script: preserve shebang flags.
Add option -a to pathscript.py script: add flags.
@end itemize

@node C API<39>,,Tools/Demos<20>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id372}@anchor{19ec}
@subsubsection C API



@itemize -

@item 
bpo-37633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37633}: Re-export some function compatibility wrappers for macros in
@code{pythonrun.h}.

@item 
bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644}: Provide @ref{a05,,Py_EnterRecursiveCall()} and
@ref{a06,,Py_LeaveRecursiveCall()} as regular functions for the limited API.
Previously, there were defined as macros, but these macros didn’t work
with the limited API which cannot access @code{PyThreadState.recursion_depth}
field. Remove @code{_Py_CheckRecursionLimit} from the stable ABI.

@item 
bpo-38650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38650}: The global variable @ref{a14,,PyStructSequence_UnnamedField} is
now a constant and refers to a constant string.

@item 
bpo-38540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38540}: Fixed possible leak in @ref{19ed,,PyArg_Parse()} and similar
functions for format units @code{"es#"} and @code{"et#"} when the macro
@code{PY_SSIZE_T_CLEAN} is not defined.

@item 
bpo-38395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38395}: Fix a crash in @ref{189b,,weakref.proxy} objects due to incorrect
lifetime management when calling some associated methods that may delete
the last reference to object being referenced by the proxy. Patch by Pablo
Galindo.

@item 
bpo-36389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36389}: The @code{_PyObject_CheckConsistency()} function is now also
available in release mode. For example, it can be used to debug a crash in
the @code{visit_decref()} function of the GC.

@item 
bpo-38266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38266}: Revert the removal of PyThreadState_DeleteCurrent() with
documentation.

@item 
bpo-38303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38303}: Update audioop extension module to use the stable ABI
(PEP-384). Patch by Tyler Kieft.

@item 
bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}: @code{Py_SetPath()} now sets @ref{283,,sys.executable} to the
program full path (@ref{282,,Py_GetProgramFullPath()}) rather than to the
program name (@ref{284,,Py_GetProgramName()}).

@item 
bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}: Python ignored arguments passed to @code{Py_SetPath()},
@code{Py_SetPythonHome()} and @code{Py_SetProgramName()}: fix Python
initialization to use specified arguments.

@item 
bpo-38205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38205}: The @ref{c3d,,Py_UNREACHABLE()} macro now calls
@ref{a15,,Py_FatalError()}.

@item 
bpo-38140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38140}: Make dict and weakref offsets opaque for C heap types by
passing the offsets through PyMemberDef

@item 
bpo-15088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15088}: The C function @code{PyGen_NeedsFinalizing} has been removed. It
was not documented, tested or used anywhere within CPython after the
implementation of 
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}. Patch by Joannah Nanjekye. (Patch by Joannah
Nanjekye)

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: Options added by @code{PySys_AddXOption()} are now handled the
same way than @code{PyConfig.xoptions} and command line @code{-X} options.

@item 
bpo-37926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37926}: Fix a crash in @code{PySys_SetArgvEx(0, NULL, 0)}.

@item 
bpo-37879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37879}: Fix subtype_dealloc to suppress the type decref when the base
type is a C heap type

@item 
bpo-37645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37645}: Add @code{_PyObject_FunctionStr()} to get a user-friendly
string representation of a function-like object. Patch by Jeroen Demeyer.

@item 
bpo-29548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29548}: The functions @code{PyEval_CallObject}, @code{PyEval_CallFunction},
@code{PyEval_CallMethod} and @code{PyEval_CallObjectWithKeywords} are
deprecated. Use @ref{48f,,PyObject_Call()} and its variants instead.

@item 
bpo-37151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37151}: @code{PyCFunction_Call} is now a deprecated alias of
@ref{48f,,PyObject_Call()}.

@item 
bpo-37540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37540}: The vectorcall protocol now requires that the caller passes
only strings as keyword names.

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: The vectorcall protocol is now enabled for @code{type} objects:
set @code{tp_vectorcall} to a vectorcall function to be used instead of
@code{tp_new} and @code{tp_init} when calling the class itself.

@item 
bpo-21120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21120}: Exclude Python-ast.h, ast.h and asdl.h from the limited API.

@item 
bpo-37483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37483}: Add new function @code{_PyObject_CallOneArg} for calling an object
with one positional argument.

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: Add @ref{19ee,,PyConfig_SetWideStringList()} function.

@item 
bpo-37337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37337}: Add fast functions for calling methods:
@code{_PyObject_VectorcallMethod()},
@code{_PyObject_CallMethodNoArgs()} and
@code{_PyObject_CallMethodOneArg()}.

@item 
bpo-28805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28805}: The @ref{1633,,METH_FASTCALL} calling convention has been
documented.

@item 
bpo-37221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37221}: The new function @code{PyCode_NewWithPosOnlyArgs()} allows to
create code objects like @code{PyCode_New()}, but with an extra
`posonlyargcount' parameter for indicating the number of positonal-only
arguments.

@item 
bpo-37215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37215}: Fix dtrace issue introduce by bpo-36842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36842}

@item 
bpo-37194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37194}: Add a new public @ref{48e,,PyObject_CallNoArgs()} function to the
C API: call a callable Python object without any arguments. It is the most
efficient way to call a callback without any argument. On x86-64, for
example, @code{PyObject_CallFunctionObjArgs(func, NULL)} allocates 960 bytes
on the stack per call, whereas @code{PyObject_CallNoArgs(func)} only
allocates 624 bytes per call.

@item 
bpo-37170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37170}: Fix the cast on error in
@ref{19ef,,PyLong_AsUnsignedLongLongMask()}.

@item 
bpo-35381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35381}: Convert posixmodule.c statically allocated types
@code{DirEntryType} and @code{ScandirIteratorType} to heap-allocated types.

@item 
bpo-34331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34331}: Use singular/plural noun in error message when instantiating an
abstract class with non-overridden abstract method(s).
@end itemize

@node Python 3 8 0 beta 1,Python 3 8 0 alpha 4,Python 3 9 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-8-0-beta-1}@anchor{19f0}
@subsection Python 3.8.0 beta 1


`Release date: 2019-06-04'

@menu
* Security: Security<29>. 
* Core and Builtins: Core and Builtins<41>. 
* Library: Library<41>. 
* Documentation: Documentation<40>. 
* Tests: Tests<39>. 
* Build: Build<41>. 
* Windows: Windows<39>. 
* macOS: macOS<33>. 
* IDLE: IDLE<29>. 
* Tools/Demos: Tools/Demos<21>. 
* C API: C API<40>. 

@end menu

@node Security<29>,Core and Builtins<41>,,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id373}@anchor{19f1}
@subsubsection Security



@itemize -

@item 
bpo-35907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35907}: 
@geindex Common Vulnerabilities and Exposures; CVE 2019-9948
CVE 2019-9948@footnote{https://www.cve.org/CVERecord?id=CVE-2019-9948}: Avoid file reading by disallowing
@code{local-file://} and @code{local_file://} URL schemes in
@code{URLopener().open()} and @code{URLopener().retrieve()} of
@ref{10b,,urllib.request}.

@item 
bpo-33529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33529}: Prevent fold function used in email header encoding from
entering infinite loop when there are too many non-ASCII characters in a
header.

@item 
bpo-33164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33164}: Updated blake2 implementation which uses secure memset
implementation provided by platform.
@end itemize

@node Core and Builtins<41>,Library<41>,Security<29>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id374}@anchor{19f2}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-35814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35814}: Allow unpacking in the right hand side of annotated
assignments. In particular, @code{t: Tuple[int, ...] = x, y, *z} is now
allowed.

@item 
bpo-37126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37126}: All structseq objects are now tracked by the garbage collector.
Patch by Pablo Galindo.

@item 
bpo-37122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37122}: Make the `co_argcount' attribute of code objects represent the
total number of positional arguments (including positional-only
arguments). The value of `co_posonlyargcount' can be used to distinguish
which arguments are positional only, and the difference (`co_argcount' -
`co_posonlyargcount') is the number of positional-or-keyword arguments.
Patch by Pablo Galindo.

@item 
bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}: Constructors of @ref{1f0,,int}, @ref{153,,float} and
@ref{154,,complex} will now use the @ref{22b,,__index__()} special
method, if available and the corresponding method @ref{22a,,__int__()},
@ref{a5e,,__float__()} or @ref{687,,__complex__()} is not available.

@item 
bpo-37087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37087}: Add native thread ID (TID) support to OpenBSD.

@item 
bpo-26219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26219}: Implemented per opcode cache mechanism and @code{LOAD_GLOBAL}
instruction use it. @code{LOAD_GLOBAL} is now about 40% faster. Contributed
by Yury Selivanov, and Inada Naoki.

@item 
bpo-37072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37072}: Fix crash in PyAST_FromNodeObject() when flags is NULL.

@item 
bpo-37029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37029}: Freeing a great many small objects could take time quadratic in
the number of arenas, due to using linear search to keep @code{obmalloc.c}’s
list of usable arenas sorted by order of number of free memory pools.
This is accomplished without search now, leaving the worst-case time
linear in the number of arenas.  For programs where this quite visibly
matters (typically with more than 100 thousand small objects alive
simultaneously), this can greatly reduce the time needed to release their
memory.

@item 
bpo-26423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26423}: Fix possible overflow in @code{wrap_lenfunc()} when @code{sizeof(long)
< sizeof(Py_ssize_t)} (e.g., 64-bit Windows).

@item 
bpo-37050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37050}: Improve the AST for «debug» f-strings, which use “=” to print
out the source of the expression being evaluated.  Delete expr_text from
the FormattedValue node, and instead use a Constant string node (possibly
merged with adjacent constant expressions inside the f-string).

@item 
bpo-22385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22385}: The @code{bytes.hex}, @code{bytearray.hex}, and @code{memoryview.hex}
methods as well as the @code{binascii.hexlify} and @code{b2a_hex} functions now
have the ability to include an optional separator between hex bytes.  This
functionality was inspired by MicroPython’s hexlify implementation.

@item 
bpo-26836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26836}: Add @ref{a9d,,os.memfd_create()}.

@item 
bpo-37032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37032}: Added new @code{replace()} method to the code type
(@ref{1d8,,types.CodeType}).

@item 
bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007}: Implement @ref{abf,,socket.if_nameindex()},
@ref{ac0,,socket.if_nametoindex()}, and @ref{ac1,,socket.if_indextoname()} on
Windows.

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: @ref{443,,PyErr_WriteUnraisable()} now creates a traceback object
if there is no current traceback. Moreover, call
@ref{28c,,PyErr_NormalizeException()} and @ref{19f3,,PyException_SetTraceback()}
to normalize the exception value. Ignore any error.

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: Only accept text after @code{# type: ignore} if the first
character is ASCII. This is to disallow things like @code{# type: ignoreé}.

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: Store text appearing after a @code{# type: ignore} comment in the
AST. For example a type ignore like @code{# type: ignore[E1000]} will have
the string @code{"[E1000]"} stored in its AST node.

@item 
bpo-2180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2180}: Treat line continuation at EOF as a @code{SyntaxError} by Anthony
Sottile.

@item 
bpo-36907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36907}: Fix a crash when calling a C function with a keyword dict
(@code{f(**kwargs)}) and changing the dict @code{kwargs} while that function is
running.

@item 
bpo-36946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36946}: Fix possible signed integer overflow when handling slices.

@item 
bpo-36826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36826}: Add NamedExpression kind support to ast_unparse.c

@item 
bpo-1875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1875}: A @ref{150,,SyntaxError} is now raised if a code blocks that will be
optimized away (e.g. if conditions that are always false) contains syntax
errors. Patch by Pablo Galindo.

@item 
bpo-36027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36027}: Allow computation of modular inverses via three-argument
@code{pow}: the second argument is now permitted to be negative in the case
where the first and third arguments are relatively prime.

@item 
bpo-36861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36861}: Update the Unicode database to version 12.1.0.

@item 
bpo-28866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28866}: Avoid caching attributes of classes which type defines mro() to
avoid a hard cache invalidation problem.

@item 
bpo-36851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36851}: The @code{FrameType} stack is now correctly cleaned up if the
execution ends with a return and the stack is not empty.

@item 
bpo-34616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34616}: The @code{compile()} builtin functions now support the
@code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT} flag,  which allow to compile sources
that  contains top-level @code{await}, @code{async with} or @code{async for}. This
is useful to evaluate async-code from with an already async functions; for
example in a custom REPL.

@item 
bpo-36842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36842}: Implement PEP 578, adding sys.audit, io.open_code and related
APIs.

@item 
bpo-27639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27639}: Correct return type for UserList slicing operations. Patch by
Michael Blahay, Erick Cervantes, and vaultah

@item 
bpo-36737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36737}: Move PyRuntimeState.warnings into per-interpreter state (via
«module state»).

@item 
bpo-36793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36793}: Removed @code{__str__} implementations from builtin types
@ref{513,,bool}, @ref{1f0,,int}, @ref{153,,float}, @ref{154,,complex} and few
classes from the standard library. They now inherit @code{__str__()} from
@ref{b18,,object}.

@item 
bpo-36817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36817}: Add a @code{=} feature f-strings for debugging. This can precede
@code{!s}, @code{!r}, or @code{!a}. It produces the text of the expression,
followed by an equal sign, followed by the repr of the value of the
expression. So @code{f'@{3*9+15=@}'} would be equal to the string
@code{'3*9+15=42'}.  If @code{=} is specified, the default conversion is set to
@code{!r}, unless a format spec is given, in which case the formatting
behavior is unchanged, and __format__ will be used.

@item 
bpo-24048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24048}: Save the live exception during import.c’s @code{remove_module()}.

@item 
bpo-27987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27987}: pymalloc returns memory blocks aligned by 16 bytes, instead of
8 bytes, on 64-bit platforms to conform x86-64 ABI. Recent compilers
assume this alignment more often. Patch by Inada Naoki.

@item 
bpo-36601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36601}: A long-since-meaningless check for @code{getpid() == main_pid} was
removed from Python’s internal C signal handler.

@item 
bpo-36594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36594}: Fix incorrect use of @code{%p} in format strings. Patch by Zackery
Spytz.

@item 
bpo-36045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36045}: @code{builtins.help()} now prefixes @code{async} for async functions.

@item 
bpo-36084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36084}: Add native thread ID (TID) to threading.Thread objects
(supported platforms: Windows, FreeBSD, Linux, macOS)

@item 
bpo-36035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36035}: Added fix for broken symlinks in combination with pathlib

@item 
bpo-35983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35983}: Added new trashcan macros to deal with a double deallocation
that could occur when the @code{tp_dealloc} of a subclass calls the
@code{tp_dealloc} of a base class and that base class uses the trashcan
mechanism. Patch by Jeroen Demeyer.

@item 
bpo-20602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20602}: Do not clear @ref{72d,,sys.flags} and @ref{19f4,,sys.float_info}
during shutdown. Patch by Zackery Spytz.

@item 
bpo-26826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26826}: Expose @code{copy_file_range()} as a low level API in the
@ref{a1,,os} module.

@item 
bpo-32388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32388}: Remove cross-version binary compatibility requirement in
tp_flags.

@item 
bpo-31862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31862}: Port binascii to PEP 489 multiphase initialization. Patch by
Marcel Plch.
@end itemize

@node Library<41>,Documentation<40>,Core and Builtins<41>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id375}@anchor{19f5}
@subsubsection Library



@itemize -

@item 
bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}: Added @ref{771,,math.perm()}.

@item 
bpo-37120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37120}: Add SSLContext.num_tickets to control the number of TLSv1.3
session tickets.

@item 
bpo-12202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12202}: Fix the error handling in
@code{msilib.SummaryInformation.GetProperty()}. Patch by Zackery Spytz.

@item 
bpo-26835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26835}: The fcntl module now contains file sealing constants for
sealing of memfds.

@item 
bpo-29262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29262}: Add @code{get_origin()} and @code{get_args()} introspection helpers
to @code{typing} module.

@item 
bpo-12639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12639}: @code{msilib.Directory.start_component()} no longer fails if
`keyfile' is not @code{None}.

@item 
bpo-36999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36999}: Add the @code{asyncio.Task.get_coro()} method to publicly expose
the tasks’s coroutine object.

@item 
bpo-35246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35246}: Make @ref{b06,,asyncio.create_subprocess_exec()} accept path-like
arguments.

@item 
bpo-35279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35279}: Change default `max_workers' of @code{ThreadPoolExecutor} from
@code{cpu_count() * 5} to @code{min(32, cpu_count() + 4)}.  Previous value was
unreasonably large on many cores machines.

@item 
bpo-37076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37076}: @ref{2fe,,_thread.start_new_thread()} now logs uncaught exception
raised by the function using @ref{355,,sys.unraisablehook()}, rather than
@ref{8a2,,sys.excepthook()}, so the hook gets access to the function which
raised the exception.

@item 
bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}: On macOS, the @ref{94,,multiprocessing} module now uses `spawn'
start method by default.

@item 
bpo-37054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37054}: Fix destructor @code{_pyio.BytesIO} and
@code{_pyio.TextIOWrapper}: initialize their @code{_buffer} attribute as
soon as possible (in the class body), because it’s used by @code{__del__()}
which calls @code{close()}.

@item 
bpo-37058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37058}: PEP 544: Add @code{Protocol} and @code{@@runtime_checkable} to the
@code{typing} module.

@item 
bpo-36933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36933}: The functions @code{sys.set_coroutine_wrapper} and
@code{sys.get_coroutine_wrapper} that were deprecated and marked for removal
in 3.8 have been removed.

@item 
bpo-37047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37047}: Handle late binding and attribute access in
@ref{add,,unittest.mock.AsyncMock} setup for autospeccing. Document newly
implemented async methods in @ref{f12,,unittest.mock.MagicMock}.

@item 
bpo-37049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37049}: PEP 589: Add @code{TypedDict} to the @code{typing} module.

@item 
bpo-37046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37046}: PEP 586: Add @code{Literal} to the @code{typing} module.

@item 
bpo-37045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37045}: PEP 591: Add @code{Final} qualifier and @code{@@final} decorator to
the @code{typing} module.

@item 
bpo-37035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37035}: Don’t log OSError based exceptions if a fatal error has
occurred in asyncio transport. Peer can generate almost any OSError, user
cannot avoid these exceptions by fixing own code. Errors are still
propagated to user code, it’s just logging them is pointless and pollute
asyncio logs.

@item 
bpo-37001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37001}: @ref{19f6,,symtable.symtable()} now accepts the same input types for
source code as the built-in @ref{2fb,,compile()} function. Patch by Dino
Viehland.

@item 
bpo-37028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37028}: Implement asyncio REPL

@item 
bpo-37027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37027}: Return safe to use proxy socket object from
transport.get_extra_info(“socket”)

@item 
bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}: Make asyncio.CancelledError a BaseException.

This will address the common mistake many asyncio users make: an «except
Exception» clause breaking Tasks cancellation.

In addition to this change, we stop inheriting asyncio.TimeoutError and
asyncio.InvalidStateError from their concurrent.futures.* counterparts.
There’s no point for these exceptions to share the inheritance chain.

@item 
bpo-1230540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1230540}: Add a new @ref{8e2,,threading.excepthook()} function which handles
uncaught @ref{acf,,threading.Thread.run()} exception. It can be overridden to
control how uncaught @ref{acf,,threading.Thread.run()} exceptions are handled.

@item 
bpo-36996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36996}: Handle @ref{f13,,unittest.mock.patch()} used as a decorator on async
functions.

@item 
bpo-37008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37008}: Add support for calling @ref{86f,,next()} with the mock resulting
from @ref{170f,,unittest.mock.mock_open()}

@item 
bpo-27737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27737}: Allow whitespace only header encoding in @code{email.header} - by
Batuhan Taskaya

@item 
bpo-36969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36969}: PDB command @code{args} now  display positional only arguments.
Patch contributed by Rémi Lapeyre.

@item 
bpo-36969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36969}: PDB command @code{args} now  display keyword only arguments. Patch
contributed by Rémi Lapeyre.

@item 
bpo-36983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36983}: Add missing names to @code{typing.__all__}: @code{ChainMap},
@code{ForwardRef}, @code{OrderedDict} - by Anthony Sottile.

@item 
bpo-36972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36972}: Add SupportsIndex protocol to the typing module to allow type
checking to detect classes that can be passed to @code{hex()}, @code{oct()} and
@code{bin()}.

@item 
bpo-32972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32972}: Implement @code{unittest.IsolatedAsyncioTestCase} to help testing
asyncio-based code.

@item 
bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952}: @ref{896,,fileinput.input()} and @ref{7d3,,fileinput.FileInput}
`bufsize' argument has been removed (was deprecated and ignored since
Python 3.6), and as a result the `mode' and `openhook' arguments have
been made keyword-only.

@item 
bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952}: Starting with Python 3.3, importing ABCs from
@ref{1e,,collections} is deprecated, and import should be done from
@ref{1f,,collections.abc}. Still being able to import from @ref{1e,,collections}
was marked for removal in 3.8, but has been delayed to 3.9; documentation
and @code{DeprecationWarning} clarified.

@item 
bpo-36949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36949}: Implement __repr__ for WeakSet objects.

@item 
bpo-36948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36948}: Fix @ref{4ec,,NameError} in
@ref{19f7,,urllib.request.URLopener.retrieve()}. Patch by Karthikeyan
Singaravelan.

@item 
bpo-33524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33524}: Fix the folding of email header when the max_line_length is 0
or None and the header contains non-ascii characters.  Contributed by
Licht Takeuchi (@@Licht-T).

@item 
bpo-24564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24564}: @ref{11a0,,shutil.copystat()} now ignores @ref{19f8,,errno.EINVAL} on
@ref{1179,,os.setxattr()} which may occur when copying files on filesystems
without extended attributes support.

Original patch by Giampaolo Rodola, updated by Ying Wang.

@item 
bpo-36888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36888}: Python child processes can now access the status of their
parent process using multiprocessing.process.parent_process

@item 
bpo-36921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36921}: Deprecate @code{@@coroutine} for sake of @code{async def}.

@item 
bpo-25652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25652}: Fix bug in @code{__rmod__} of @code{UserString} - by Batuhan Taskaya.

@item 
bpo-36916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36916}: Remove a message about an unhandled exception in a task when
writer.write() is used without await and writer.drain() fails with an
exception.

@item 
bpo-36889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36889}: Introduce @code{asyncio.Stream} class that merges
@ref{18ce,,asyncio.StreamReader} and @ref{1705,,asyncio.StreamWriter}
functionality. @code{asyncio.Stream} can work in readonly, writeonly and
readwrite modes. Provide @code{asyncio.connect()},
@code{asyncio.connect_unix()}, @code{asyncio.connect_read_pipe()} and
@code{asyncio.connect_write_pipe()} factories to open
@code{asyncio.Stream} connections. Provide @code{asyncio.StreamServer}
and @code{UnixStreamServer} to serve servers with asyncio.Stream API.
Modify @ref{b07,,asyncio.create_subprocess_shell()} and
@ref{b06,,asyncio.create_subprocess_exec()} to use @code{asyncio.Stream}
instead of deprecated @code{StreamReader} and @code{StreamWriter}.
Deprecate @ref{18ce,,asyncio.StreamReader} and @ref{1705,,asyncio.StreamWriter}.
Deprecate usage of private classes, e.g.
@code{asyncio.FlowControlMixing} and
@code{asyncio.StreamReaderProtocol} outside of asyncio package.

@item 
bpo-36845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36845}: Added validation of integer prefixes to the construction of IP
networks and interfaces in the ipaddress module.

@item 
bpo-23378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23378}: Add an extend action to argparser.

@item 
bpo-36867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36867}: Fix a bug making a SharedMemoryManager instance and its parent
process use two separate resource_tracker processes.

@item 
bpo-23896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23896}: Adds a grammar to lib2to3.pygram that contains exec as a
function not as statement.

@item 
bpo-36895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36895}: The function @code{time.clock()} was deprecated in 3.3 in favor of
@code{time.perf_counter()} and marked for removal in 3.8, it has removed.

@item 
bpo-35545@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35545}: Fix asyncio discarding IPv6 scopes when ensuring hostname
resolutions internally

@item 
bpo-36887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36887}: Add new function @ref{a97,,math.isqrt()} to compute integer square
roots.

@item 
bpo-34632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34632}: Introduce the @code{importlib.metadata} module with (provisional)
support for reading metadata from third-party packages.

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: When using @code{type_comments=True} in @code{ast.parse}, treat @code{#
type: ignore} followed by a non-alphanumeric character and then arbitrary
text as a type ignore, instead of requiring nothing but whitespace or
another comment. This is to permit formations such as @code{# type:
ignore[E1000]}.

@item 
bpo-36778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36778}: @code{cp65001} encoding (Windows code page 65001) becomes an alias
to @code{utf_8} encoding.

@item 
bpo-36867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36867}: The multiprocessing.resource_tracker replaces the
multiprocessing.semaphore_tracker module. Other than semaphores,
resource_tracker also tracks shared_memory segments.

@item 
bpo-30262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30262}: The @code{Cache} and @code{Statement} objects of the @ref{cf,,sqlite3}
module are not exposed to the user.  Patch by Aviv Palivoda.

@item 
bpo-24538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24538}: In @code{shutil.copystat()}, first copy extended file attributes
and then file permissions, since extended attributes can only be set on
the destination while it is still writeable.

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: Add new @ref{355,,sys.unraisablehook()} function which can be
overridden to control how «unraisable exceptions» are handled. It is
called when an exception has occurred but there is no way for Python to
handle it. For example, when a destructor raises an exception or during
garbage collection (@ref{acc,,gc.collect()}).

@item 
bpo-36832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36832}: Introducing @code{zipfile.Path}, a pathlib-compatible wrapper for
traversing zip files.

@item 
bpo-36814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36814}: Fix an issue where os.posix_spawnp() would incorrectly raise a
TypeError when file_actions is None.

@item 
bpo-33110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33110}: Handle exceptions raised by functions added by
concurrent.futures add_done_callback correctly when the Future has already
completed.

@item 
bpo-26903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26903}: Limit @code{max_workers} in @code{ProcessPoolExecutor} to 61 to work
around a WaitForMultipleObjects limitation.

@item 
bpo-36813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36813}: Fix @ref{eb1,,QueueListener} to call
@code{queue.task_done()} upon stopping. Patch by Bar Harel.

@item 
bpo-36806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36806}: Forbid creation of asyncio stream objects like StreamReader,
StreamWriter, Process, and their protocols outside of asyncio package.

@item 
bpo-36802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36802}: Provide both sync and async calls for StreamWriter.write() and
StreamWriter.close()

@item 
bpo-36801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36801}: Properly handle SSL connection closing in asyncio
StreamWriter.drain() call.

@item 
bpo-36785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36785}: Implement PEP 574 (pickle protocol 5 with out-of-band buffers).

@item 
bpo-36772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36772}: functools.lru_cache() can now be used as a straight decorator
in addition to its existing usage as a function that returns a decorator.

@item 
bpo-6584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6584}: Add a @ref{a89,,BadGzipFile} exception to the @ref{67,,gzip}
module.

@item 
bpo-36748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36748}: Optimized write buffering in C implementation of
@code{TextIOWrapper}. Writing ASCII string to @code{TextIOWrapper} with ascii,
latin1, or utf-8 encoding is about 20% faster.  Patch by Inada Naoki.

@item 
bpo-8138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8138}: Don’t mark @code{wsgiref.simple_server.SimpleServer} as
multi-threaded since @code{wsgiref.simple_server.WSGIServer} is
single-threaded.

@item 
bpo-22640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22640}: @ref{ab7,,py_compile.compile()} now supports silent mode. Patch by
Joannah Nanjekye

@item 
bpo-29183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29183}: Fix double exceptions in @ref{19f9,,wsgiref.handlers.BaseHandler}
by calling its @code{close()} method only
when no exception is raised.

@item 
bpo-36548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36548}: Improved the repr of regular expression flags.

@item 
bpo-36542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36542}: The signature of Python functions can now be overridden by
specifying the @code{__text_signature__} attribute.

@item 
bpo-36533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36533}: Reinitialize logging.Handler locks in forked child processes
instead of attempting to acquire them all in the parent before forking
only to be released in the child process.  The acquire/release pattern was
leading to deadlocks in code that has implemented any form of chained
logging handlers that depend upon one another as the lock acquisition
order cannot be guaranteed.

@item 
bpo-35252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35252}: Throw a TypeError instead of an AssertionError when using an
invalid type annotation with singledispatch.

@item 
bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}: Allow reduction methods to return a 6-item tuple where the 6th
item specifies a custom state-setting method that’s called instead of the
regular @code{__setstate__} method.

@item 
bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}: enable custom reduction callback registration for functions and
classes in _pickle.c, using the new Pickler’s attribute
@code{reducer_override}

@item 
bpo-36368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36368}: Fix a bug crashing SharedMemoryManager instances in interactive
sessions after a ctrl-c (KeyboardInterrupt) was sent

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix mmap fail for VxWorks

@item 
bpo-27497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27497}: @ref{126c,,csv.DictWriter.writeheader()} now returns the return value
of the underlying @code{csv.Writer.writerow()} method. Patch contributed by
Ashish Nitin Patil.

@item 
bpo-36239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36239}: Parsing .mo files now ignores comments starting and ending with
#-#-#-#-#.

@item 
bpo-26707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26707}: Enable plistlib to read and write binary plist files that were
created as a KeyedArchive file. Specifically, this allows the plistlib to
process 0x80 tokens as UID objects.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Add posix module support for VxWorks.

@item 
bpo-35125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35125}: Asyncio: Remove inner callback on outer cancellation in shield

@item 
bpo-35721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35721}: Fix @code{asyncio.SelectorEventLoop.subprocess_exec()} leaks
file descriptors if @code{Popen} fails and called with
@code{stdin=subprocess.PIPE}. Patch by Niklas Fiekas.

@item 
bpo-31855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31855}: @ref{170f,,unittest.mock.mock_open()} results now respects the
argument of read([size]). Patch contributed by Rémi Lapeyre.

@item 
bpo-35431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35431}: Implement @ref{770,,math.comb()} that returns binomial coefficient,
that computes the number of ways to choose k items from n items without
repetition and without order. Patch by Yash Aggarwal and Keller Fuchs.

@item 
bpo-26660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26660}: Fixed permission errors in
@ref{12a1,,TemporaryDirectory} clean up. Previously
@code{TemporaryDirectory.cleanup()} failed when non-writeable or
non-searchable files or directories were created inside a temporary
directory.

@item 
bpo-34271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34271}: Add debugging helpers to ssl module. It’s now possible to dump
key material and to trace TLS protocol. The default and stdlib contexts
also support SSLKEYLOGFILE env var.

@item 
bpo-26467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26467}: Added AsyncMock to support using unittest to mock asyncio
coroutines. Patch by Lisa Roach.

@item 
bpo-33569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33569}: dataclasses.InitVar: Exposes the type used to create the init
var.

@item 
bpo-34424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34424}: Fix serialization of messages containing encoded strings when
the policy.linesep is set to a multi-character string. Patch by Jens
Troeger.

@item 
bpo-34303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34303}: Performance of @ref{17d,,functools.reduce()} is slightly improved.
Patch by Sergey Fedoseev.

@item 
bpo-33361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33361}: Fix a bug in @ref{19fa,,codecs.StreamRecoder} where seeking might
leave old data in a buffer and break subsequent read calls. Patch by Ammar
Askar.

@item 
bpo-22454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22454}: The @ref{c4,,shlex} module now exposes @ref{ab9,,shlex.join()}, the
inverse of @ref{5de,,shlex.split()}. Patch by Bo Bayles.

@item 
bpo-31922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31922}: @code{asyncio.AbstractEventLoop.create_datagram_endpoint()}: Do
not connect UDP socket when broadcast is allowed. This allows to receive
replies after a UDP broadcast.

@item 
bpo-24882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24882}: Change ThreadPoolExecutor to use existing idle threads before
spinning up new ones.

@item 
bpo-31961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31961}: Added support for bytes and path-like objects in
@ref{301,,subprocess.Popen()} on Windows.  The `args' parameter now accepts a
@ref{3f0,,path-like object} if `shell' is @code{False} and a sequence containing
bytes and path-like objects. The `executable' parameter now accepts a
bytes and @ref{3f0,,path-like object}. The `cwd' parameter now accepts a
bytes object. Based on patch by Anders Lorentsen.

@item 
bpo-33123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33123}: @ref{19fb,,pathlib.Path.unlink} now accepts a `missing_ok'
parameter to avoid a @ref{f46,,FileNotFoundError} from being raised. Patch by
Robert Buchholz.

@item 
bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941}: Allow @ref{368,,mmap.mmap} objects to access the madvise() system
call (through @ref{a9a,,mmap.mmap.madvise()}).

@item 
bpo-22102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22102}: Added support for ZIP files with disks set to 0. Such files are
commonly created by builtin tools on Windows when use ZIP64 extension.
Patch by Francisco Facioni.

@item 
bpo-32515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32515}: trace.py can now run modules via python3 -m trace -t –module
module_name

@item 
bpo-32299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32299}: Changed @ref{1605,,unittest.mock.patch.dict()} to return the patched
dictionary when used as context manager. Patch by Vadim Tsander.

@item 
bpo-27141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27141}: Added a @code{__copy__()} to @code{collections.UserList} and
@code{collections.UserDict} in order to correctly implement shallow copying
of the objects. Patch by Bar Harel.

@item 
bpo-31829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31829}: @code{\r}, @code{\0} and @code{\x1a} (end-of-file on Windows) are now
escaped in protocol 0 pickles of Unicode strings. This allows to load them
without loss from files open in text mode in Python 2.

@item 
bpo-23395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23395}: @code{_thread.interrupt_main()} now avoids setting the Python
error status if the @code{SIGINT} signal is ignored or not handled by Python.
@end itemize

@node Documentation<40>,Tests<39>,Library<41>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id376}@anchor{19fc}
@subsubsection Documentation



@itemize -

@item 
bpo-36896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36896}: Clarify that some types have unstable constructor signature
between Python versions.

@item 
bpo-36686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36686}: Improve documentation of the stdin, stdout, and stderr
arguments of the @code{asyncio.subprocess_exec} function to specify which
values are supported. Also mention that decoding as text is not supported.

Add a few tests to verify that the various values passed to the std*
arguments actually work.

@item 
bpo-36984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36984}: Improve version added references in @code{typing} module - by
Anthony Sottile.

@item 
bpo-36868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36868}: What’s new now mentions SSLContext.hostname_checks_common_name
instead of SSLContext.host_flags.

@item 
bpo-35924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35924}: Add a note to the @code{curses.addstr()} documentation to warn
that multiline strings can cause segfaults because of an ncurses bug.

@item 
bpo-36783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36783}: Added C API Documentation for Time_FromTimeAndFold and
PyDateTime_FromDateAndTimeAndFold as per PEP 495. Patch by Edison
Abahurire.

@item 
bpo-36797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36797}: More of the legacy distutils documentation has been either
pruned, or else more clearly marked as being retained solely until the
setuptools documentation covers it independently.

@item 
bpo-22865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22865}: Add detail to the documentation on the @code{pty.spawn} function.

@item 
bpo-35397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35397}: Remove deprecation and document urllib.parse.unwrap(). Patch
contributed by Rémi Lapeyre.

@item 
bpo-32995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32995}: Added the context variable in glossary.

@item 
bpo-33519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33519}: Clarify that @code{copy()} is not part of the @code{MutableSequence}
ABC.

@item 
bpo-33482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33482}: Make @code{codecs.StreamRecoder.writelines} take a list of bytes.

@item 
bpo-25735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25735}: Added documentation for func factorial to indicate that returns
integer values

@item 
bpo-20285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20285}: Expand object.__doc__ (docstring) to make it clearer. Modify
pydoc.py so that help(object) lists object methods (for other classes,
help omits methods of the object base class.)
@end itemize

@node Tests<39>,Build<41>,Documentation<40>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id377}@anchor{19fd}
@subsubsection Tests



@itemize -

@item 
bpo-37069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37069}: Modify test_coroutines, test_cprofile, test_generators,
test_raise, test_ssl and test_yield_from to use
@ref{19e1,,test.support.catch_unraisable_exception()} rather than
@ref{19fe,,test.support.captured_stderr()}.

@item 
bpo-37098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37098}: Fix test_memfd_create on older Linux Kernels.

@item 
bpo-37081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37081}: Test with OpenSSL 1.1.1c

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: Add @ref{19e1,,test.support.catch_unraisable_exception()}: context
manager catching unraisable exception using @ref{355,,sys.unraisablehook()}.

@item 
bpo-36915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36915}: The main regrtest process now always removes all temporary
directories of worker processes even if they crash or if they are killed
on KeyboardInterrupt (CTRL+c).

@item 
bpo-36719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36719}: «python3 -m test -jN …» now continues the execution of next
tests when a worker process crash (CHILD_ERROR state). Previously, the
test suite stopped immediately. Use –failfast to stop at the first error.

@item 
bpo-36816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36816}: Update Lib/test/selfsigned_pythontestdotnet.pem to match
self-signed.pythontest.net’s new TLS certificate.

@item 
bpo-35925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35925}: Skip httplib and nntplib networking tests when they would
otherwise fail due to a modern OS or distro with a default OpenSSL policy
of rejecting connections to servers with weak certificates.

@item 
bpo-36782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36782}: Add tests for several C API functions in the @ref{31,,datetime}
module. Patch by Edison Abahurire.

@item 
bpo-36342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36342}: Fix test_multiprocessing in test_venv if platform lacks
functioning sem_open.
@end itemize

@node Build<41>,Windows<39>,Tests<39>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id378}@anchor{19ff}
@subsubsection Build



@itemize -

@item 
bpo-36721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36721}: To embed Python into an application, a new @code{--embed} option
must be passed to @code{python3-config --libs --embed} to get @code{-lpython3.8}
(link the application to libpython). To support both 3.8 and older, try
@code{python3-config --libs --embed} first and fallback to @code{python3-config
--libs} (without @code{--embed}) if the previous command fails.

Add a pkg-config @code{python-3.8-embed} module to embed Python into an
application: @code{pkg-config python-3.8-embed --libs} includes
@code{-lpython3.8}. To support both 3.8 and older, try @code{pkg-config
python-X.Y-embed --libs} first and fallback to @code{pkg-config python-X.Y
--libs} (without @code{--embed}) if the previous command fails (replace
@code{X.Y} with the Python version).

On the other hand, @code{pkg-config python3.8 --libs} no longer contains
@code{-lpython3.8}. C extensions must not be linked to libpython (except on
Android, case handled by the script); this change is backward incompatible
on purpose.

@item 
bpo-36786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36786}: «make install» now runs compileall in parallel.
@end itemize

@node Windows<39>,macOS<33>,Build<41>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id379}@anchor{1a00}
@subsubsection Windows



@itemize -

@item 
bpo-36965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36965}: include of STATUS_CONTROL_C_EXIT without depending on MSC
compiler

@item 
bpo-35926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35926}: Update to OpenSSL 1.1.1b for Windows.

@item 
bpo-29883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29883}: Add Windows support for UDP transports for the Proactor Event
Loop. Patch by Adam Meily.

@item 
bpo-33407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33407}: The @ref{b2f,,Py_DEPRECATED()} macro has been implemented for
MSVC.
@end itemize

@node macOS<33>,IDLE<29>,Windows<39>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id380}@anchor{1a01}
@subsubsection macOS



@itemize -

@item 
bpo-36231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36231}: Support building Python on macOS without /usr/include
installed. As of macOS 10.14, system header files are only available
within an SDK provided by either the Command Line Tools or the Xcode app.
@end itemize

@node IDLE<29>,Tools/Demos<21>,macOS<33>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id381}@anchor{1a02}
@subsubsection IDLE



@itemize -

@item 
bpo-35610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35610}: Replace now redundant .context_use_ps1 with .prompt_last_line.
This finishes change started in bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858}.

@item 
bpo-37038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37038}: Make idlelib.run runnable; add test clause.

@item 
bpo-36958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36958}: Print any argument other than None or int passed to SystemExit
or sys.exit().

@item 
bpo-36807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36807}: When saving a file, call os.fsync() so bits are flushed to e.g.
USB drive.

@item 
bpo-32411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32411}: In browser.py, remove extraneous sorting by line number since
dictionary was created in line number order.
@end itemize

@node Tools/Demos<21>,C API<40>,IDLE<29>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id382}@anchor{1a03}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-37053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37053}: Handle strings like u»bar» correctly in
Tools/parser/unparse.py. Patch by Chih-Hsuan Yen.
@end itemize

@node C API<40>,,Tools/Demos<21>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id383}@anchor{1a04}
@subsubsection C API



@itemize -

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: Implement the 
@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} «Python Initialization Configuration».

@item 
bpo-36379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36379}: Fix crashes when attempting to use the `modulo' parameter when
@code{__ipow__} is implemented in C.

@item 
bpo-37107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37107}: Update @ref{1a05,,PyObject_CallMethodObjArgs()} and
@code{_PyObject_CallMethodIdObjArgs} to use @code{_PyObject_GetMethod} to avoid
creating a bound method object in many cases. Patch by Michael J.
Sullivan.

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: Implement 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}: Vectorcall: a fast calling protocol for
CPython. This is a new protocol to optimize calls of custom callable
objects.

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: @code{Py_Main()} now returns the exitcode rather than calling
@code{Py_Exit(exitcode)} when calling @code{PyErr_Print()} if the current
exception type is @code{SystemExit}.

@item 
bpo-36922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36922}: Add new type flag @code{Py_TPFLAGS_METHOD_DESCRIPTOR} for objects
behaving like unbound methods. These are objects supporting the
optimization given by the @code{LOAD_METHOD}/@code{CALL_METHOD} opcodes. See PEP
590.

@item 
bpo-36728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36728}: The @code{PyEval_ReInitThreads()} function has been removed
from the C API. It should not be called explicitly: use
@ref{292,,PyOS_AfterFork_Child()} instead.
@end itemize

@node Python 3 8 0 alpha 4,Python 3 8 0 alpha 3,Python 3 8 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-8-0-alpha-4}@anchor{1a06}
@subsection Python 3.8.0 alpha 4


`Release date: 2019-05-06'

@menu
* Security: Security<30>. 
* Core and Builtins: Core and Builtins<42>. 
* Library: Library<42>. 
* Documentation: Documentation<41>. 
* Tests: Tests<40>. 
* Build: Build<42>. 
* Windows: Windows<40>. 
* macOS: macOS<34>. 
* IDLE: IDLE<30>. 
* Tools/Demos: Tools/Demos<22>. 
* C API: C API<41>. 

@end menu

@node Security<30>,Core and Builtins<42>,,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id384}@anchor{1a07}
@subsubsection Security



@itemize -

@item 
bpo-36742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36742}: Fixes mishandling of pre-normalization characters in
urlsplit().

@item 
bpo-30458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30458}: Address 
@geindex Common Vulnerabilities and Exposures; CVE 2019-9740
CVE 2019-9740@footnote{https://www.cve.org/CVERecord?id=CVE-2019-9740} by disallowing URL paths with embedded
whitespace or control characters through into the underlying http client
request.  Such potentially malicious header injection URLs now cause an
http.client.InvalidURL exception to be raised.

@item 
bpo-35755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35755}: @ref{55b,,shutil.which()} now uses @code{os.confstr("CS_PATH")} if
available and if the 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} environment variable is not set.
Remove also the current directory from @code{posixpath.defpath}. On Unix,
@ref{55b,,shutil.which()} and the @ref{d6,,subprocess} module no longer search the
executable in the current directory if the 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} environment
variable is not set.
@end itemize

@node Core and Builtins<42>,Library<42>,Security<30>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id385}@anchor{1a08}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-36722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36722}: In debug build, import now also looks for C extensions compiled
in release mode and for C extensions compiled in the stable ABI.

@item 
bpo-32849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32849}: Fix Python Initialization code on FreeBSD to detect properly
when stdin file descriptor (fd 0) is invalid.

@item 
bpo-36623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36623}: Remove parser headers and related function declarations that
lack implementations after the removal of pgen.

@item 
bpo-20180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20180}: @code{dict.pop()} is now up to 33% faster thanks to Argument
Clinic. Patch by Inada Naoki.

@item 
bpo-36611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36611}: Debug memory allocators: disable serialno field by default from
debug hooks on Python memory allocators to reduce the memory footprint by
5%. Enable @ref{ff,,tracemalloc} to get the traceback where a memory block
has been allocated when a fatal memory error is logged to decide where to
put a breakpoint. Compile Python with @code{PYMEM_DEBUG_SERIALNO} defined to
get back the field.

@item 
bpo-36588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36588}: On AIX, @ref{b19,,sys.platform} doesn’t contain the major version
anymore. Always return @code{'aix'}, instead of @code{'aix3'} .. @code{'aix7'}.
Since older Python versions include the version number, it is recommended
to always use @code{sys.platform.startswith('aix')}. Contributed by M. Felt.

@item 
bpo-36549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36549}: Change str.capitalize to use titlecase for the first character
instead of uppercase.

@item 
bpo-36540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36540}: Implement 
@geindex Python Enhancement Proposals; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} (Python positional-only parameters). Patch
by Pablo Galindo.

@item 
bpo-36475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36475}: @code{PyEval_AcquireLock()} and
@code{PyEval_AcquireThread()} now terminate the current thread if called
while the interpreter is finalizing, making them consistent with
@ref{49c,,PyEval_RestoreThread()}, @ref{b1a,,Py_END_ALLOW_THREADS()}, and
@ref{49e,,PyGILState_Ensure()}.

@item 
bpo-36504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36504}: Fix signed integer overflow in _ctypes.c’s
@code{PyCArrayType_new()}.

@item 
bpo-20844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20844}: Fix running script with encoding cookie and LF line ending may
fail on Windows.

@item 
bpo-24214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24214}: Fixed support of the surrogatepass error handler in the UTF-8
incremental decoder.

@item 
bpo-36452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36452}: Changing @code{dict} keys during iteration of the dict itself,
@code{keys()}, @code{values()}, or @code{items()} will now be detected in certain
corner cases where keys are deleted/added so that the number of keys isn’t
changed. A @code{RuntimeError} will be raised after @code{len(dict)} iterations.
Contributed by Thomas Perl.

@item 
bpo-36459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36459}: Fix a possible double @code{PyMem_FREE()} due to tokenizer.c’s
@code{tok_nextc()}.

@item 
bpo-36433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36433}: Fixed TypeError message in classmethoddescr_call.

@item 
bpo-36430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36430}: Fix a possible reference leak in @ref{12f0,,itertools.count()}.

@item 
bpo-36440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36440}: Include node names in @code{ParserError} messages, instead of
numeric IDs. Patch by A. Skrobov.

@item 
bpo-36143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36143}: Regenerate @ref{84,,keyword} from the Grammar and Tokens file
using pgen. Patch by Pablo Galindo.

@item 
bpo-18372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18372}: Add missing @ref{1546,,PyObject_GC_Track()} calls in the
@ref{a6,,pickle} module. Patch by Zackery Spytz.
@end itemize

@node Library<42>,Documentation<41>,Core and Builtins<42>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id386}@anchor{1a09}
@subsubsection Library



@itemize -

@item 
bpo-35952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35952}: Fix pythoninfo when the compiler is missing.

@item 
bpo-28238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28238}: The @code{.find*()} methods of xml.etree.ElementTree can now
search for wildcards like @code{@{*@}tag} and @code{@{ns@}*} that match a tag in any
namespace or all tags in a namespace.  Patch by Stefan Behnel.

@item 
bpo-26978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26978}: @code{pathlib.path.link_to()} is now implemented. It creates a
hard link pointing to a path.

@item 
bpo-1613500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1613500}: @ref{7d3,,fileinput.FileInput} now uses the input file mode to
correctly set the output file mode (previously it was hardcoded to
@code{'w'})  when @code{inplace=True} is passed to its constructor.

@item 
bpo-36734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36734}: Fix compilation of @code{faulthandler.c} on HP-UX. Initialize
@code{stack_t current_stack} to zero using @code{memset()}.

@item 
bpo-13611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13611}: The xml.etree.ElementTree packages gained support for C14N 2.0
serialisation. Patch by Stefan Behnel.

@item 
bpo-36669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36669}: Add missing matrix multiplication operator support to
weakref.proxy.

@item 
bpo-36676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36676}: The XMLParser() in xml.etree.ElementTree provides namespace
prefix context to the parser target if it defines the callback methods
«start_ns()» and/or «end_ns()». Patch by Stefan Behnel.

@item 
bpo-36673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36673}: The TreeBuilder and XMLPullParser in xml.etree.ElementTree
gained support for parsing comments and processing instructions. Patch by
Stefan Behnel.

@item 
bpo-36650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36650}: The C version of functools.lru_cache() was treating calls with
an empty @code{**kwargs} dictionary as being distinct from calls with no
keywords at all. This did not result in an incorrect answer, but it did
trigger an unexpected cache miss.

@item 
bpo-28552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28552}: Fix @code{distutils.sysconfig} if @ref{283,,sys.executable} is
@code{None} or an empty string: use @ref{159a,,os.getcwd()} to initialize
@code{project_base}.  Fix also the distutils build command: don’t use
@ref{283,,sys.executable} if it is @code{None} or an empty string.

@item 
bpo-35755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35755}: @ref{55b,,shutil.which()} and @code{distutils.spawn.find_executable}
now use @code{os.confstr("CS_PATH")} if available instead of
@ref{1a0a,,os.defpath}, if the @code{PATH} environment variable is not set.
Moreover, don’t use @code{os.confstr("CS_PATH")} nor @ref{1a0a,,os.defpath} if
the @code{PATH} environment variable is set to an empty string.

@item 
bpo-25430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25430}: improve performance of @code{IPNetwork.__contains__()}

@item 
bpo-30485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30485}: Path expressions in xml.etree.ElementTree can now avoid
explicit namespace prefixes for tags (or the «@{namespace@}tag» notation) by
passing a default namespace with an empty string prefix.

@item 
bpo-36613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36613}: Fix @ref{b,,asyncio} wait() not removing callback if exception

@item 
bpo-36598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36598}: Fix @code{isinstance} check for Mock objects with spec when the
code is executed under tracing. Patch by Karthikeyan Singaravelan.

@item 
bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}: In development mode (@ref{2e2,,-X} @code{dev}) and in debug build,
the @ref{353,,io.IOBase} destructor now logs @code{close()} exceptions. These
exceptions are silent by default in release mode.

@item 
bpo-36575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36575}: The @code{_lsprof} module now uses internal timer same to
@code{time.perf_counter()} by default. @code{gettimeofday(2)} was used on Unix.
New timer has better resolution on most Unix platforms and timings are no
longer impacted by system clock updates since @code{perf_counter()} is
monotonic. Patch by Inada Naoki.

@item 
bpo-33461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33461}: @code{json.loads} now emits @code{DeprecationWarning} when
@code{encoding} option is specified.  Patch by Matthias Bussonnier.

@item 
bpo-36559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36559}: The random module now prefers the lean internal _sha512 module
over hashlib for seed(version=2) to optimize import time.

@item 
bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561}: Set backlog=None as the default for socket.create_server.

@item 
bpo-34373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34373}: Fix @ref{1255,,time.mktime()} error handling on AIX for year before
1970.

@item 
bpo-36232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36232}: Improve error message when trying to open existing DBM database
that actually doesn’t exist. Patch by Marco Rougeth.

@item 
bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}: Add statistics.quantiles()

@item 
bpo-36050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36050}: Optimized @code{http.client.HTTPResponse.read()} for large
response. Patch by Inada Naoki.

@item 
bpo-36522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36522}: If `debuglevel' is set to >0 in @ref{6f,,http.client}, print all
values for headers with multiple values for the same header name. Patch by
Matt Houglum.

@item 
bpo-36492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36492}: Deprecated passing required arguments like `func' as keyword
arguments in functions which should accept arbitrary keyword arguments and
pass them to other function. Arbitrary keyword arguments (even with names
«self» and «func») can now be passed to these functions if the required
arguments are passed as positional arguments.

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: Add statistics.geometric_mean().

@item 
bpo-30427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30427}: @code{os.path.normcase()} relies on @code{os.fspath()} to check the
type of its argument. Redundant checks have been removed from its
@code{posixpath.normcase()} and @code{ntpath.normcase()} implementations. Patch
by Wolfgang Maier.

@item 
bpo-36385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36385}: Stop rejecting IPv4 octets for being ambiguously octal. Leading
zeros are ignored, and no longer are assumed to specify octal octets.
Octets are always decimal numbers. Octets must still be no more than three
digits, including leading zeroes.

@item 
bpo-36434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36434}: Errors during writing to a ZIP file no longer prevent to
properly close it.

@item 
bpo-36407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36407}: Fixed wrong indentation writing for CDATA section in
xml.dom.minidom. Patch by Vladimir Surjaninov.

@item 
bpo-36326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36326}: inspect.getdoc() can now find docstrings for member objects
when __slots__ is a dictionary.

@item 
bpo-36366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36366}: Calling @code{stop()} on an unstarted or stopped
@ref{f13,,unittest.mock.patch()} object will now return @code{None} instead of
raising @ref{1e5,,RuntimeError}, making the method idempotent. Patch by
Karthikeyan Singaravelan.

@item 
bpo-36348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36348}: The @code{imap.IMAP4.logout()} method no longer ignores silently
arbitrary exceptions.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Add time module support and fix test_time failures for VxWorks.

@item 
bpo-36227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36227}: Added support for keyword arguments @code{default_namespace} and
@code{xml_declaration} in functions @code{ElementTree.tostring()} and
@code{ElementTree.tostringlist()}.

@item 
bpo-36004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36004}: Added new alternate constructors
@ref{a7e,,datetime.date.fromisocalendar()} and
@ref{a7f,,datetime.datetime.fromisocalendar()}, which construct date objects
from ISO year, week number and weekday; these are the inverse of each
class’s @code{isocalendar} method. Patch by Paul Ganssle.

@item 
bpo-35936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35936}: @ref{91,,modulefinder} no longer depends on the deprecated
@ref{76,,imp} module, and the initializer for
@ref{1a0b,,modulefinder.ModuleFinder} now has immutable default arguments.
Patch by Brandt Bucher.

@item 
bpo-35376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35376}: @ref{91,,modulefinder} correctly handles modules that have the
same name as a bad package. Patch by Brandt Bucher.

@item 
bpo-17396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17396}: @ref{91,,modulefinder} no longer crashes when encountering syntax
errors in followed imports. Patch by Brandt Bucher.

@item 
bpo-35934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35934}: Added @ref{abd,,create_server()} and
@ref{abe,,has_dualstack_ipv6()} convenience functions to automate the
necessary tasks usually involved when creating a server socket, including
accepting both IPv4 and IPv6 connections on the same socket.  (Contributed
by Giampaolo Rodola in bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561}.)

@item 
bpo-23078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23078}: Add support for @ref{2d2,,classmethod()} and @ref{22e,,staticmethod()} to
@ref{15c9,,unittest.mock.create_autospec()}.  Initial patch by Felipe Ochoa.

@item 
bpo-35416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35416}: Fix potential resource warnings in distutils. Patch by Mickaël
Schoentgen.

@item 
bpo-25451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25451}: Add transparency methods to @code{tkinter.PhotoImage}.  Patch
by Zackery Spytz.

@item 
bpo-35082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35082}: Don’t return deleted attributes when calling dir on a
@ref{ade,,unittest.mock.Mock}.

@item 
bpo-34547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34547}: @ref{19f9,,wsgiref.handlers.BaseHandler} now handles abrupt client
connection terminations gracefully. Patch by Petter Strandmark.

@item 
bpo-31658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31658}: @ref{1a0c,,xml.sax.parse()} now supports @ref{3f0,,path-like}. Patch by Mickaël Schoentgen.

@item 
bpo-34139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34139}: Remove stale unix datagram socket before binding

@item 
bpo-33530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33530}: Implemented Happy Eyeballs in @code{asyncio.create_connection()}.
Added two new arguments, `happy_eyeballs_delay' and `interleave', to
specify Happy Eyeballs behavior.

@item 
bpo-33291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33291}: Do not raise AttributeError when calling the inspect functions
isgeneratorfunction, iscoroutinefunction, isasyncgenfunction on a method
created from an arbitrary callable. Instead, return False.

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: Fix the multiprocessing.semaphore_tracker so it is reused by
child processes

@item 
bpo-31292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31292}: Fix @code{setup.py check --restructuredtext} for files containing
@code{include} directives.
@end itemize

@node Documentation<41>,Tests<40>,Library<42>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id387}@anchor{1a0d}
@subsubsection Documentation



@itemize -

@item 
bpo-36625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36625}: Remove obsolete comments from docstrings in fractions.Fraction

@item 
bpo-30840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30840}: Document relative imports

@item 
bpo-36523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36523}: Add docstring for io.IOBase.writelines().

@item 
bpo-36425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36425}: New documentation translation: Simplified Chinese@footnote{https://docs.python.org/zh-cn/}.

@item 
bpo-36345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36345}: Avoid the duplication of code from @code{Tools/scripts/serve.py}
in using the @code{literalinclude} directive for the basic
wsgiref-based web server in the documentation of @ref{118,,wsgiref}.
Contributed by Stéphane Wirtel.

@item 
bpo-36345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36345}: Using the code of the @code{Tools/scripts/serve.py} script as an
example in the @ref{118,,wsgiref} documentation.  Contributed by Stéphane
Wirtel.

@item 
bpo-36157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36157}: Added documentation for PyInterpreterState_Main().

@item 
bpo-33043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33043}: Updates the docs.python.org page with the addition of a
“Contributing to Docs” link at the end of the page (between “Reporting
Bugs” and “About Documentation”). Updates the “Found a Bug” page with
additional links and information in the Documentation Bugs section.

@item 
bpo-35581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35581}: @@typing.type_check_only now allows type stubs to mark functions
and classes not available during runtime.

@item 
bpo-33832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33832}: Add glossary entry for “magic method”.

@item 
bpo-32913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32913}: Added re.Match.groupdict example to regex HOWTO.
@end itemize

@node Tests<40>,Build<42>,Documentation<41>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id388}@anchor{1a0e}
@subsubsection Tests



@itemize -

@item 
bpo-36719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36719}: regrtest now always detects uncollectable objects. Previously,
the check was only enabled by @code{--findleaks}. The check now also works
with @code{-jN/--multiprocess N}. @code{--findleaks} becomes a deprecated alias
to @code{--fail-env-changed}.

@item 
bpo-36725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36725}: When using multiprocessing mode (-jN), regrtest now better
reports errors if a worker process fails, and it exits immediately on a
worker thread failure or when interrupted.

@item 
bpo-36454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36454}: Change test_time.test_monotonic() to test only the lower bound
of elapsed time after a sleep command rather than the upper bound. This
prevents unnecessary test failures on slow buildbots. Patch by Victor
Stinner.

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: Improve test coverage for xml.etree.ElementTree. Patch by
Gordon P. Hemsley.

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: Fix typo in test_cyclic_gc() test for xml.etree.ElementTree.
Patch by Gordon P. Hemsley.

@item 
bpo-36635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36635}: Add a new @code{_testinternalcapi} module to test the internal
C API.

@item 
bpo-36629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36629}: Fix @code{test_imap4_host_default_value()} of @code{test_imaplib}:
catch also @ref{1a0f,,errno.ENETUNREACH} error.

@item 
bpo-36611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36611}: Fix @code{test_sys.test_getallocatedblocks()} when
@ref{ff,,tracemalloc} is enabled.

@item 
bpo-36560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36560}: Fix reference leak hunting in regrtest: compute also deltas (of
reference count, allocated memory blocks, file descriptor count) during
warmup, to ensure that everything is initialized before starting to hunt
reference leaks.

@item 
bpo-36565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36565}: Fix reference hunting (@code{python3 -m test -R 3:3}) when Python
has no built-in abc module.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Port test_resource to VxWorks: skip tests cases setting
RLIMIT_FSIZE and RLIMIT_CPU.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix test_tabnanny on VxWorks: adjust ENOENT error message.

@item 
bpo-36436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36436}: Fix @code{_testcapi.pymem_buffer_overflow()}: handle memory
allocation failure.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Fix test_utf8_mode on VxWorks: Python always use UTF-8 on
VxWorks.

@item 
bpo-36341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36341}: Fix tests that may fail with PermissionError upon calling
bind() on AF_UNIX sockets.
@end itemize

@node Build<42>,Windows<40>,Tests<40>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id389}@anchor{1a10}
@subsubsection Build



@itemize -

@item 
bpo-36747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36747}: Remove the stale scriptsinstall Makefile target.

@item 
bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}: On Unix, C extensions are no longer linked to libpython except
on Android and Cygwin.

It is now possible for a statically linked Python to load a C extension
built using a shared library Python.

When Python is embedded, @code{libpython} must not be loaded with
@code{RTLD_LOCAL}, but @code{RTLD_GLOBAL} instead. Previously, using
@code{RTLD_LOCAL}, it was already not possible to load C extensions which
were not linked to @code{libpython}, such as C extensions of the standard
library built by the @code{*shared*} section of @code{Modules/Setup}.

distutils, python-config and python-config.py have been modified.

@item 
bpo-36707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36707}: @code{./configure --with-pymalloc} no longer adds the @code{m} flag
to SOABI (sys.implementation.cache_tag). Enabling or disabling pymalloc
has no impact on the ABI.

@item 
bpo-36635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36635}: Change @code{PyAPI_FUNC(type)}, @code{PyAPI_DATA(type)} and
@code{PyMODINIT_FUNC} macros of @code{pyport.h} when @code{Py_BUILD_CORE_MODULE} is
defined. The @code{Py_BUILD_CORE_MODULE} define must be now be used to build
a C extension as a dynamic library accessing Python internals: export the
@code{PyInit_@var{xxx}()} function in DLL exports on Windows.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Don’t build the @code{_crypt} extension on VxWorks.

@item 
bpo-36618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36618}: Add @code{-fmax-type-align=8} to CFLAGS when clang compiler is
detected. The pymalloc memory allocator aligns memory on 8 bytes. On
x86-64, clang expects alignment on 16 bytes by default and so uses MOVAPS
instruction which can lead to segmentation fault. Instruct clang that
Python is limited to alignment on 8 bytes to use MOVUPS instruction
instead: slower but don’t trigger a SIGSEGV if the memory is not aligned
on 16 bytes. Sadly, the flag must be added to @code{CFLAGS} and not just
@code{CFLAGS_NODIST}, since third party C extensions can have the same issue.

@item 
bpo-36605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36605}: @code{make tags} and @code{make TAGS} now also parse
@code{Modules/_io/*.c} and @code{Modules/_io/*.h}.

@item 
bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}: Release builds and debug builds are now ABI compatible:
defining the @code{Py_DEBUG} macro no longer implies the @code{Py_TRACE_REFS}
macro, which introduces the only ABI incompatibility. The
@code{Py_TRACE_REFS} macro, which adds the @ref{1b5,,sys.getobjects()} function
and the 
@geindex PYTHONDUMPREFS
@geindex variables de entorno; PYTHONDUMPREFS
@ref{a38,,PYTHONDUMPREFS} environment variable, can be set using
the new @code{./configure --with-trace-refs} build option.

@item 
bpo-36577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36577}: setup.py now correctly reports missing OpenSSL headers and
libraries again.

@item 
bpo-36544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36544}: Fix regression introduced in bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146} refactoring setup.py

@item 
bpo-36508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36508}: @code{python-config --ldflags} no longer includes flags of the
@code{LINKFORSHARED} variable. The @code{LINKFORSHARED} variable must only be
used to build executables.

@item 
bpo-36503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36503}: Remove references to «aix3» and «aix4». Patch by M. Felt.
@end itemize

@node Windows<40>,macOS<34>,Build<42>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id390}@anchor{1a11}
@subsubsection Windows



@itemize -

@item 
bpo-35920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35920}: Added platform.win32_edition() and platform.win32_is_iot().
Added support for cross-compiling packages for Windows ARM32. Skip tests
that are not expected to work on Windows IoT Core ARM32.

@item 
bpo-36649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36649}: Remove trailing spaces for registry keys when installed via the
Store.

@item 
bpo-34144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34144}: Fixed activate.bat to correctly update codepage when chcp.com
returns dots in output. Patch by Lorenz Mende.

@item 
bpo-36509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36509}: Added preset-iot layout for Windows IoT ARM containers. This
layout doesn’t contain UI components like tkinter or IDLE. It also doesn’t
contain files to support on-target builds since Windows ARM32 builds must
be cross-compiled when using MSVC.

@item 
bpo-35941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35941}: enum_certificates function of the ssl module now returns
certificates from all available certificate stores inside windows in a
query instead of returning only certificates from the system wide
certificate store. This includes certificates from these certificate
stores: local machine, local machine enterprise, local machine group
policy, current user, current user group policy, services, users.
ssl.enum_crls() function is changed in the same way to return all
certificate revocation lists inside the windows certificate revocation
list stores.

@item 
bpo-36441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36441}: Fixes creating a venv when debug binaries are installed.

@item 
bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}: Enable better DLL resolution on Windows by using safe DLL
search paths and adding @ref{a7c,,os.add_dll_directory()}.

@item 
bpo-36010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36010}: Add the venv standard library module to the nuget distribution
for Windows.

@item 
bpo-29515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29515}: Add the following socket module constants on Windows:
IPPROTO_AH IPPROTO_CBT IPPROTO_DSTOPTS IPPROTO_EGP IPPROTO_ESP
IPPROTO_FRAGMENT IPPROTO_GGP IPPROTO_HOPOPTS IPPROTO_ICLFXBM
IPPROTO_ICMPV6 IPPROTO_IDP IPPROTO_IGMP IPPROTO_IGP IPPROTO_IPV4
IPPROTO_IPV6 IPPROTO_L2TP IPPROTO_MAX IPPROTO_ND IPPROTO_NONE IPPROTO_PGM
IPPROTO_PIM IPPROTO_PUP IPPROTO_RDP IPPROTO_ROUTING IPPROTO_SCTP
IPPROTO_ST

@item 
bpo-35947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35947}: Added current version of libffi to cpython-source-deps. Change
_ctypes to use current version of libffi on Windows.

@item 
bpo-34060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34060}: Report system load when running test suite on Windows. Patch by
Ammar Askar. Based on prior work by Jeremy Kloth.

@item 
bpo-31512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31512}: With the Windows 10 Creators Update, non-elevated users can now
create symlinks as long as the computer has Developer Mode enabled.
@end itemize

@node macOS<34>,IDLE<30>,Windows<40>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id391}@anchor{1a12}
@subsubsection macOS



@itemize -

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: Avoid failures setting macOS stack resource limit with
resource.setrlimit. This reverts an earlier fix for bpo-18075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18075} which forced
a non-default stack size when building the interpreter executable on
macOS.
@end itemize

@node IDLE<30>,Tools/Demos<22>,macOS<34>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id392}@anchor{1a13}
@subsubsection IDLE



@itemize -

@item 
bpo-36429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36429}: Fix starting IDLE with pyshell. Add idlelib.pyshell alias at
top; remove pyshell alias at bottom. Remove obsolete __name__==”__main__”
command.
@end itemize

@node Tools/Demos<22>,C API<41>,IDLE<30>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id393}@anchor{1a14}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-14546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14546}: Fix the argument handling in Tools/scripts/lll.py.
@end itemize

@node C API<41>,,Tools/Demos<22>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id394}@anchor{1a15}
@subsubsection C API



@itemize -

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: Fix memory leak in @code{Py_SetStandardStreamEncoding()}:
release memory if the function is called twice.

@item 
bpo-36641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36641}: PyDoc_VAR(name) and @ref{197b,,PyDoc_STRVAR}(name, str)
now create @code{static const char name[]} instead of @code{static char name[]}.
Patch by Inada Naoki.

@item 
bpo-36389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36389}: Change the value of @code{CLEANBYTE}, @code{DEADDYTE} and
@code{FORBIDDENBYTE} internal constants used by debug hooks on Python memory
allocators (@ref{cf2,,PyMem_SetupDebugHooks()} function). Byte patterns
@code{0xCB}, @code{0xDB} and @code{0xFB} have been replaced with @code{0xCD}, @code{0xDD}
and @code{0xFD} to use the same values than Windows CRT debug @code{malloc()}
and @code{free()}.

@item 
bpo-36443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36443}: Since Python 3.7.0, calling @ref{c4f,,Py_DecodeLocale()} before
@ref{247,,Py_Initialize()} produces mojibake if the @code{LC_CTYPE} locale is
coerced and/or if the UTF-8 Mode is enabled by the user configuration. The
LC_CTYPE coercion and UTF-8 Mode are now disabled by default to fix the
mojibake issue. They must now be enabled explicitly (opt-in) using the new
@code{_Py_PreInitialize()} API with @code{_PyPreConfig}.

@item 
bpo-36025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36025}: Fixed an accidental change to the datetime C API where the
arguments to the @ref{1a16,,PyDate_FromTimestamp()} function were incorrectly
interpreted as a single timestamp rather than an arguments tuple, which
causes existing code to start raising @ref{228,,TypeError}. The
backwards-incompatible change was only present in alpha releases of Python
3.8. Patch by Paul Ganssle.

@item 
bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}: Modify @code{PyObject_Init} to correctly increase the refcount of
heap-allocated Type objects. Also fix the refcounts of the heap-allocated
types that were either doing this manually or not decreasing the type’s
refcount in tp_dealloc
@end itemize

@node Python 3 8 0 alpha 3,Python 3 8 0 alpha 2,Python 3 8 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-8-0-alpha-3}@anchor{1a17}
@subsection Python 3.8.0 alpha 3


`Release date: 2019-03-25'

@menu
* Security: Security<31>. 
* Core and Builtins: Core and Builtins<43>. 
* Library: Library<43>. 
* Documentation: Documentation<42>. 
* Tests: Tests<41>. 
* Build: Build<43>. 
* Windows: Windows<41>. 
* IDLE: IDLE<31>. 
* Tools/Demos: Tools/Demos<23>. 
* C API: C API<42>. 

@end menu

@node Security<31>,Core and Builtins<43>,,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id395}@anchor{1a18}
@subsubsection Security



@itemize -

@item 
bpo-36216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36216}: Changes urlsplit() to raise ValueError when the URL contains
characters that decompose under IDNA encoding (NFKC-normalization) into
characters that affect how the URL is parsed.

@item 
bpo-35121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35121}: Don’t send cookies of domain A without Domain attribute to
domain B when domain A is a suffix match of domain B while using a
cookiejar with @ref{1a19,,http.cookiejar.DefaultCookiePolicy} policy. Patch
by Karthikeyan Singaravelan.
@end itemize

@node Core and Builtins<43>,Library<43>,Security<31>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id396}@anchor{1a1a}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-36421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36421}: Fix a possible double decref in _ctypes.c’s
@code{PyCArrayType_new()}.

@item 
bpo-36412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36412}: Fix a possible crash when creating a new dictionary.

@item 
bpo-36398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36398}: Fix a possible crash in @code{structseq_repr()}.

@item 
bpo-36256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36256}: Fix bug in parsermodule when parsing a state in a DFA that has
two or more arcs with labels of the same type. Patch by Pablo Galindo.

@item 
bpo-36365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36365}: repr(structseq) is no longer limited to 512 bytes.

@item 
bpo-36374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36374}: Fix a possible null pointer dereference in
@code{merge_consts_recursive()}. Patch by Zackery Spytz.

@item 
bpo-36236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36236}: At Python initialization, the current directory is no longer
prepended to @ref{27e,,sys.path} if it has been removed.

@item 
bpo-36352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36352}: Python initialization now fails with an error, rather than
silently truncating paths, if a path is too long.

@item 
bpo-36301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36301}: Python initialization now fails if decoding @code{pybuilddir.txt}
configuration file fails at startup.

@item 
bpo-36333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36333}: Fix leak in _PyRuntimeState_Fini. Contributed by Stéphane
Wirtel.

@item 
bpo-36332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36332}: The builtin @ref{2fb,,compile()} can now handle AST objects that
contain assignment expressions. Patch by Pablo Galindo.

@item 
bpo-36282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36282}: Improved error message for too much positional arguments in
some builtin functions.

@item 
bpo-30040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30040}: New empty dict uses fewer memory for now.  It used more memory
than empty dict created by @code{dict.clear()}.  And empty dict creation and
deletion is about 2x faster.  Patch by Inada Naoki.

@item 
bpo-36262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36262}: Fix an unlikely memory leak on conversion from string to float
in the function @code{_Py_dg_strtod()} used by @code{float(str)},
@code{complex(str)}, @ref{d97,,pickle.load()}, @ref{1a1b,,marshal.load()}, etc.

@item 
bpo-36252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36252}: Update Unicode databases to version 12.0.0.

@item 
bpo-36218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36218}: Fix a segfault occurring when sorting a list of heterogeneous
values. Patch contributed by Rémi Lapeyre and Elliot Gorokhovsky.

@item 
bpo-36188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36188}: Cleaned up left-over vestiges of Python 2 unbound method
handling in method objects and documentation. Patch by Martijn Pieters

@item 
bpo-36124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36124}: Add a new interpreter-specific dict and expose it in the C-API
via PyInterpreterState_GetDict().  This parallels PyThreadState_GetDict().
However, extension modules should continue using PyModule_GetState() for
their own internal per-interpreter state.

@item 
bpo-35975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35975}: Add a @code{feature_version} flag to @code{ast.parse()} (documented)
and @code{compile()} (hidden) that allows tweaking the parser to support
older versions of the grammar. In particular, if @code{feature_version} is 5
or 6, the hacks for the @code{async} and @code{await} keyword from PEP 492 are
reinstated. (For 7 or higher, these are unconditionally treated as
keywords, but they are still special tokens rather than @code{NAME} tokens
that the parser driver recognizes.)

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Use UTF-8 as the system encoding on VxWorks.

@item 
bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048}: The @ref{22b,,__index__()} special method will be used
instead of @ref{22a,,__int__()} for implicit conversion of Python
numbers to C integers.  Using the @code{__int__()} method in implicit
conversions has been deprecated.

@item 
bpo-35808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35808}: Retire pgen and use a modified version of pgen2 to generate the
parser. Patch by Pablo Galindo.
@end itemize

@node Library<43>,Documentation<42>,Core and Builtins<43>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id397}@anchor{1a1c}
@subsubsection Library



@itemize -

@item 
bpo-36401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36401}: The class documentation created by pydoc now has a separate
section for readonly properties.

@item 
bpo-36320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36320}: The typing.NamedTuple() class has deprecated the _field_types
attribute in favor of the __annotations__ attribute which carried the same
information. Also, both attributes were converted from OrderedDict to a
regular dict.

@item 
bpo-34745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34745}: Fix @ref{b,,asyncio} ssl memory issues caused by circular
references

@item 
bpo-36324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36324}: Add method to statistics.NormalDist for computing the inverse
cumulative normal distribution.

@item 
bpo-36321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36321}: collections.namedtuple() misspelled the name of an attribute.
To be consistent with typing.NamedTuple, the attribute name should have
been «_field_defaults» instead of «_fields_defaults».  For backwards
compatibility, both spellings are now created.  The misspelled version may
be removed in the future.

@item 
bpo-36297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36297}: «unicode_internal» codec is removed.  It was deprecated since
Python 3.3. Patch by Inada Naoki.

@item 
bpo-36298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36298}: Raise ModuleNotFoundError in pyclbr when a module can’t be
found. Thanks to “mental” for the bug report.

@item 
bpo-36268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36268}: Switch the default format used for writing tars with
@ref{de,,tarfile} to the modern POSIX.1-2001 pax standard, from the
vendor-specific GNU. Contributed by C.A.M. Gerlach.

@item 
bpo-36285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36285}: Fix integer overflows in the array module. Patch by Stephan
Hohe.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Add _signal module support for VxWorks.

@item 
bpo-36272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36272}: @ref{87,,logging} does not silently ignore RecursionError anymore.
Patch contributed by Rémi Lapeyre.

@item 
bpo-36280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36280}: Add a kind field to ast.Constant. It is “u” if the literal has
a “u” prefix (i.e. a Python 2 style unicode literal), else None.

@item 
bpo-35931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35931}: The @ref{a5,,pdb} @code{debug} command now gracefully handles all
exceptions.

@item 
bpo-36251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36251}: Fix format strings used for stderrprinter and re.Match reprs.
Patch by Stephan Hohe.

@item 
bpo-36235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36235}: Fix @code{CFLAGS} in @code{customize_compiler()} of
@code{distutils.sysconfig}: when the @code{CFLAGS} environment variable is
defined, don’t override @code{CFLAGS} variable with the @code{OPT} variable
anymore. Initial patch written by David Malcolm.

@item 
bpo-35807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35807}: Update ensurepip to install pip 19.0.3 and setuptools 40.8.0.

@item 
bpo-36139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36139}: Release GIL when closing @ref{368,,mmap} objects.

@item 
bpo-36179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36179}: Fix two unlikely reference leaks in _hashopenssl. The leaks
only occur in out-of-memory cases.

@item 
bpo-36169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36169}: Add overlap() method to statistics.NormalDist.  Computes the
overlapping coefficient for two normal distributions.

@item 
bpo-36103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36103}: Default buffer size used by @code{shutil.copyfileobj()} is changed
from 16 KiB to 64 KiB on non-Windows platform to reduce system call
overhead. Contributed by Inada Naoki.

@item 
bpo-36130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36130}: Fix @code{pdb} with @code{skip=...} when stepping into a frame
without a @code{__name__} global.  Patch by Anthony Sottile.

@item 
bpo-35652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35652}: shutil.copytree(copy_function=…) erroneously pass DirEntry
instead of a path string.

@item 
bpo-35178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35178}: Ensure custom @ref{1a1d,,warnings.formatwarning()} function can
receive @code{line} as positional argument. Based on patch by Tashrif Billah.

@item 
bpo-36106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36106}: Resolve potential name clash with libm’s sinpi(). Patch by
Dmitrii Pasechnik.

@item 
bpo-36091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36091}: Clean up reference to async generator in Lib/types. Patch by
Henry Chen.

@item 
bpo-36043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36043}: @code{FileCookieJar} supports @ref{3f0,,path-like object}.
Contributed by Stéphane Wirtel

@item 
bpo-35899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35899}: Enum has been fixed to correctly handle empty strings and
strings with non-Latin characters (ie. “α”, “א”) without crashing.
Original patch contributed by Maxwell. Assisted by Stéphane Wirtel.

@item 
bpo-21269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21269}: Add @code{args} and @code{kwargs} properties to mock call objects.
Contributed by Kumar Akshay.

@item 
bpo-30670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30670}: @code{pprint.pp} has been added to pretty-print objects with
dictionary keys being sorted with their insertion order by default.
Parameter `sort_dicts' has been added to @code{pprint.pprint},
@code{pprint.pformat} and @code{pprint.PrettyPrinter}. Contributed by Rémi
Lapeyre.

@item 
bpo-35843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35843}: Implement @code{__getitem__} for @code{_NamespacePath}.  Patch by
Anthony Sottile.

@item 
bpo-35802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35802}: Clean up code which checked presence of @code{os.stat} /
@code{os.lstat} / @code{os.chmod} which are always present.  Patch by Anthony
Sottile.

@item 
bpo-35715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35715}: Librates the return value of a ProcessPoolExecutor
_process_worker after it’s no longer needed to free memory

@item 
bpo-35493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35493}: Use @ref{1153,,multiprocessing.connection.wait()} instead of polling
each 0.2 seconds for worker updates in @code{multiprocessing.Pool}.
Patch by Pablo Galindo.

@item 
bpo-35661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35661}: Store the venv prompt in pyvenv.cfg.

@item 
bpo-35121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35121}: Don’t set cookie for a request when the request path is a
prefix match of the cookie’s path attribute but doesn’t end with «/».
Patch by Karthikeyan Singaravelan.

@item 
bpo-21478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21478}: Calls to a child function created with
@ref{15c9,,unittest.mock.create_autospec()} should propagate to the parent.
Patch by Karthikeyan Singaravelan.

@item 
bpo-35198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35198}: Fix C++ extension compilation on AIX
@end itemize

@node Documentation<42>,Tests<41>,Library<43>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id398}@anchor{1a1e}
@subsubsection Documentation



@itemize -

@item 
bpo-36329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36329}: Declare the path of the Python binary for the usage of
@code{Tools/scripts/serve.py} when executing @code{make -C Doc/ serve}.
Contributed by Stéphane Wirtel

@item 
bpo-36138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36138}: Improve documentation about converting datetime.timedelta to
scalars.

@item 
bpo-21314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21314}: A new entry was added to the Core Language Section of the
Programming FAQ, which explaines the usage of slash(/) in the signature of
a function. Patch by Lysandros Nikolaou
@end itemize

@node Tests<41>,Build<43>,Documentation<42>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id399}@anchor{1a1f}
@subsubsection Tests



@itemize -

@item 
bpo-36234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36234}: test_posix.PosixUidGidTests: add tests for invalid uid/gid type
(str). Initial patch written by David Malcolm.

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: Fix @code{test_re.test_locale_flag()}:  use
@code{locale.getpreferredencoding()} rather than @code{locale.getlocale()} to
get the locale encoding. With some locales, @code{locale.getlocale()} returns
the wrong encoding.

@item 
bpo-36123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36123}: Fix race condition in test_socket.
@end itemize

@node Build<43>,Windows<41>,Tests<41>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id400}@anchor{1a20}
@subsubsection Build



@itemize -

@item 
bpo-36356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36356}: Fix leaks that led to build failure when configured with
address sanitizer.

@item 
bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146}: Add @code{TEST_EXTENSIONS} constant to @code{setup.py} to allow to
not build test extensions like @code{_testcapi}.

@item 
bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146}: Fix setup.py on macOS: only add @code{/usr/include/ffi} to include
directories of _ctypes, not for all extensions.

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: Enable build system to cross-build for VxWorks RTOS.
@end itemize

@node Windows<41>,IDLE<31>,Build<43>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id401}@anchor{1a21}
@subsubsection Windows



@itemize -

@item 
bpo-36312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36312}: Fixed decoders for the following code pages: 50220, 50221,
50222, 50225, 50227, 50229, 57002 through 57011, 65000 and 42.

@item 
bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}: Don’t honor POSIX @code{HOME} in @code{os.path.expanduser} on
windows.  Patch by Anthony Sottile.

@item 
bpo-24643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24643}: Fix name collisions due to @code{#define timezone _timezone} in
PC/pyconfig.h.
@end itemize

@node IDLE<31>,Tools/Demos<23>,Windows<41>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id402}@anchor{1a22}
@subsubsection IDLE



@itemize -

@item 
bpo-36405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36405}: Use dict unpacking in idlelib.

@item 
bpo-36396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36396}: Remove fgBg param of idlelib.config.GetHighlight(). This param
was only used twice and changed the return type.

@item 
bpo-36176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36176}: Fix IDLE autocomplete & calltip popup colors. Prevent conflicts
with Linux dark themes (and slightly darken calltip background).

@item 
bpo-23205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23205}: For the grep module, add tests for findfiles, refactor
findfiles to be a module-level function, and refactor findfiles to use
os.walk.

@item 
bpo-23216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23216}: Add docstrings to IDLE search modules.

@item 
bpo-36152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36152}: Remove colorizer.ColorDelegator.close_when_done and the
corresponding argument of .close().  In IDLE, both have always been None
or False since 2007.

@item 
bpo-32129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32129}: Avoid blurry IDLE application icon on macOS with Tk 8.6. Patch
by Kevin Walzer.

@item 
bpo-36096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36096}: Refactor class variables to instance variables in colorizer.

@item 
bpo-30348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30348}: Increase test coverage of idlelib.autocomplete by 30%. Patch by
Louie Lu
@end itemize

@node Tools/Demos<23>,C API<42>,IDLE<31>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id403}@anchor{1a23}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-35132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35132}: Fix py-list and py-bt commands of python-gdb.py on gdb7.

@item 
bpo-32217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32217}: Fix freeze script on Windows.
@end itemize

@node C API<42>,,Tools/Demos<23>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id404}@anchor{1a24}
@subsubsection C API



@itemize -

@item 
bpo-36381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36381}: Raise @code{DeprecationWarning} when “#” formats are used for
building or parsing values without @code{PY_SSIZE_T_CLEAN}.

@item 
bpo-36142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36142}: The whole coreconfig.h header is now excluded from
Py_LIMITED_API. Move functions definitions into a new internal
pycore_coreconfig.h header.
@end itemize

@node Python 3 8 0 alpha 2,Python 3 8 0 alpha 1,Python 3 8 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-8-0-alpha-2}@anchor{1a25}
@subsection Python 3.8.0 alpha 2


`Release date: 2019-02-25'

@menu
* Core and Builtins: Core and Builtins<44>. 
* Library: Library<44>. 
* Documentation: Documentation<43>. 
* Tests: Tests<42>. 
* Windows: Windows<42>. 
* IDLE: IDLE<32>. 

@end menu

@node Core and Builtins<44>,Library<44>,,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id405}@anchor{1a26}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-36052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36052}: Raise a @ref{150,,SyntaxError} when assigning a value to
@code{__debug__} with the Assignment Operator. Contributed by Stéphane Wirtel
and Pablo Galindo.

@item 
bpo-36012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36012}: Doubled the speed of class variable writes.  When a non-dunder
attribute was updated, there was an unnecessary call to update slots.

@item 
bpo-35942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35942}: The error message emitted when returning invalid types from
@code{__fspath__} in interfaces that allow passing @ref{cd9,,PathLike}
objects has been improved and now it does explain the origin of the error.

@item 
bpo-36016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36016}: @code{gc.get_objects} can now receive an optional parameter
indicating a generation to get objects from. Patch by Pablo Galindo.

@item 
bpo-1054041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1054041}: When the main interpreter exits due to an uncaught
KeyboardInterrupt, the process now exits in the appropriate manner for its
parent process to detect that a SIGINT or ^C terminated the process.  This
allows shells and batch scripts to understand that the user has asked them
to stop.

@item 
bpo-35992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35992}: Fix @code{__class_getitem__()} not being called on a class with a
custom non-subscriptable metaclass.

@item 
bpo-35993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35993}: Fix a crash on fork when using subinterpreters. Contributed by
Stéphane Wirtel

@item 
bpo-35991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35991}: Fix a potential double free in Modules/_randommodule.c.

@item 
bpo-35961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35961}: Fix a crash in slice_richcompare(): use strong references
rather than stolen references for the two temporary internal tuples.

@item 
bpo-35911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35911}: Enable the creation of cell objects by adding a
@code{cell.__new__} method, and expose the type @code{cell} in @code{Lib/types.py}
under the name CellType. Patch by Pierre Glaser.

@item 
bpo-12822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12822}: Use monotonic clock for @code{pthread_cond_timedwait} when
@code{pthread_condattr_setclock} and @code{CLOCK_MONOTONIC} are available.

@item 
bpo-15248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15248}: The compiler emits now syntax warnings in the case when a comma
is likely missed before tuple or list.

@item 
bpo-35886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35886}: The implementation of PyInterpreterState has been moved into
the internal header files (guarded by Py_BUILD_CORE).

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: Clarify the errors reported when @code{object.__new__} and
@code{object.__init__} receive more than one argument. Contributed by Sanyam
Khurana.

@item 
bpo-35724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35724}: Signal-handling is now guaranteed to happen relative to the
main interpreter.

@item 
bpo-33608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33608}: We added a new internal _Py_AddPendingCall() that operates
relative to the provided interpreter.  This allows us to use the existing
implementation to ask another interpreter to do work that cannot be done
in the current interpreter, like decref an object the other interpreter
owns.  The existing Py_AddPendingCall() only operates relative to the main
interpreter.

@item 
bpo-33989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33989}: Fix a possible crash in @ref{c57,,list.sort()} when sorting objects
with @code{ob_type->tp_richcompare == NULL}.  Patch by Zackery Spytz.
@end itemize

@node Library<44>,Documentation<43>,Core and Builtins<44>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id406}@anchor{1a27}
@subsubsection Library



@itemize -

@item 
bpo-35512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35512}: @ref{1605,,unittest.mock.patch.dict()} used as a decorator with
string target resolves the target during function call instead of during
decorator construction. Patch by Karthikeyan Singaravelan.

@item 
bpo-36018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36018}: Add statistics.NormalDist, a tool for creating and manipulating
normal distributions of random variable.  Features a composite class that
treats the mean and standard deviation of measurement data as single
entity.

@item 
bpo-35904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35904}: Added statistics.fmean() as a faster, floating-point variant of
the existing mean() function.

@item 
bpo-35918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35918}: Removed broken @code{has_key} method from
multiprocessing.managers.SyncManager.dict. Contributed by Rémi Lapeyre.

@item 
bpo-18283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18283}: Add support for bytes to @ref{55b,,shutil.which()}.

@item 
bpo-35960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35960}: Fix @ref{15f7,,dataclasses.field()} throwing away empty mapping
objects passed as metadata.

@item 
bpo-35500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35500}: Write expected and actual call parameters on separate lines in
@ref{1a28,,unittest.mock.Mock.assert_called_with()} assertion errors.
Contributed by Susan Su.

@item 
bpo-35931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35931}: The @ref{a5,,pdb} @code{debug} command now gracefully handles syntax
errors.

@item 
bpo-24209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24209}: In http.server script, rely on getaddrinfo to bind to preferred
address based on the bind parameter. Now default bind or binding to a name
may bind to IPv6 or dual-stack, depending on the environment.

@item 
bpo-35321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35321}: Set @code{__spec__.origin} of  @code{_frozen_importlib} to frozen so
that it matches the behavior of @code{_frozen_importlib_external}.  Patch by
Nina Zakharenko.

@item 
bpo-35378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35378}: Fix a reference issue inside @code{multiprocessing.Pool} that
caused the pool to remain alive if it was deleted without being closed or
terminated explicitly. A new strong reference is added to the pool
iterators to link the lifetime of the pool to the lifetime of its
iterators so the pool does not get destroyed if a pool iterator is still
alive.

@item 
bpo-34294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34294}: re module, fix wrong capturing groups in rare cases.
@ref{1299,,re.search()}, @ref{10a6,,re.findall()}, @ref{3f2,,re.sub()} and other functions
that scan through string looking for a match, should reset capturing
groups between two match attempts. Patch by Ma Lin.

@item 
bpo-35615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35615}: @ref{114,,weakref}: Fix a RuntimeError when copying a
WeakKeyDictionary or a WeakValueDictionary, due to some keys or values
disappearing while iterating.

@item 
bpo-35606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35606}: Implement @ref{a96,,math.prod()} as analogous function to
@ref{515,,sum()} that returns the product of a “start” value (default: 1) times
an iterable of numbers. Patch by Pablo Galindo.

@item 
bpo-32417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32417}: Performing arithmetic between @ref{32f,,datetime.datetime}
subclasses and @ref{a61,,datetime.timedelta} now returns an object of the
same type as the @ref{32f,,datetime.datetime} subclass. As a result,
@ref{a62,,datetime.datetime.astimezone()} and alternate constructors like
@ref{592,,datetime.datetime.now()} and @code{datetime.fromtimestamp()} called
with a @code{tz} argument now `also' retain their subclass.

@item 
bpo-35153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35153}: Add `headers' optional keyword-only parameter to
@ref{ae8,,xmlrpc.client.ServerProxy}, @code{xmlrpc.client.Transport} and
@code{xmlrpc.client.SafeTransport}.  Patch by Cédric Krier.

@item 
bpo-34572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34572}: Fix C implementation of pickle.loads to use importlib’s locking
mechanisms, and thereby avoid using partially loaded modules. Patch by Tim
Burgess.
@end itemize

@node Documentation<43>,Tests<42>,Library<44>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id407}@anchor{1a29}
@subsubsection Documentation



@itemize -

@item 
bpo-36083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36083}: Fix formatting of –check-hash-based-pycs options in the
manpage Synopsis.

@item 
bpo-36007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36007}: Bump minimum sphinx version to 1.8.  Patch by Anthony Sottile.

@item 
bpo-22062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22062}: Update documentation and docstrings for pathlib. Original patch
by Mike Short.
@end itemize

@node Tests<42>,Windows<42>,Documentation<43>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id408}@anchor{1a2a}
@subsubsection Tests



@itemize -

@item 
bpo-27313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27313}: Avoid test_ttk_guionly ComboboxTest failure with macOS Cocoa
Tk.

@item 
bpo-36019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36019}: Add test.support.TEST_HTTP_URL and replace references of
@indicateurl{http://www.example.com} by this new constant. Contributed by Stéphane
Wirtel.

@item 
bpo-36037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36037}: Fix test_ssl for strict OpenSSL configuration like RHEL8 strict
crypto policy. Use older TLS version for minimum TLS version of the server
SSL context if needed, to test TLS version older than default minimum TLS
version.

@item 
bpo-35798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35798}: Added @code{test.support.check_syntax_warning()}.

@item 
bpo-35505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35505}: Make test_imap4_host_default_value independent on whether the
local IMAP server is running.

@item 
bpo-35917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35917}: multiprocessing: provide unit tests for SyncManager and
SharedMemoryManager classes + all the shareable types which are supposed
to be supported by them.  (patch by Giampaolo Rodola)

@item 
bpo-35704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35704}: Skip @code{test_shutil.test_unpack_archive_xztar} to prevent a
MemoryError on 32-bit AIX when MAXDATA setting is less than 0x20000000.

Patch by Michael Felt (aixtools)

@item 
bpo-34720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34720}: Assert m_state != NULL to mimic GC traversal functions that do
not correctly handle module creation when the module state has not been
created.
@end itemize

@node Windows<42>,IDLE<32>,Tests<42>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id409}@anchor{1a2b}
@subsubsection Windows



@itemize -

@item 
bpo-35976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35976}: Added ARM build support to Windows build files in PCBuild.

@item 
bpo-35692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35692}: @code{pathlib} no longer raises when checking file and directory
existence on drives that are not ready

@item 
bpo-35872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35872}: Uses the base Python executable when invoking venv in a virtual
environment

@item 
bpo-35873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35873}: Prevents venv paths being inherited by child processes

@item 
bpo-35299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35299}: Fix sysconfig detection of the source directory and distutils
handling of pyconfig.h during PGO profiling
@end itemize

@node IDLE<32>,,Windows<42>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id410}@anchor{1a2c}
@subsubsection IDLE



@itemize -

@item 
bpo-24310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24310}: IDLE – Document settings dialog font tab sample.

@item 
bpo-35833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35833}: Revise IDLE doc for control codes sent to Shell. Add a code
example block.

@item 
bpo-35689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35689}: Add docstrings and unittests for colorizer.py.
@end itemize

@node Python 3 8 0 alpha 1,Python 3 7 0 final,Python 3 8 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-8-0-alpha-1}@anchor{1a2d}
@subsection Python 3.8.0 alpha 1


`Release date: 2019-02-03'

@menu
* Security: Security<32>. 
* Core and Builtins: Core and Builtins<45>. 
* Library: Library<45>. 
* Documentation: Documentation<44>. 
* Tests: Tests<43>. 
* Build: Build<44>. 
* Windows: Windows<43>. 
* macOS: macOS<35>. 
* IDLE: IDLE<33>. 
* Tools/Demos: Tools/Demos<24>. 
* C API: C API<43>. 

@end menu

@node Security<32>,Core and Builtins<45>,,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id411}@anchor{1a2e}
@subsubsection Security



@itemize -

@item 
bpo-35746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35746}: 
@geindex Common Vulnerabilities and Exposures; CVE 2019-5010
CVE 2019-5010@footnote{https://www.cve.org/CVERecord?id=CVE-2019-5010}: Fix a NULL pointer deref in ssl module. The
cert parser did not handle CRL distribution points with empty DP or URI
correctly. A malicious or buggy certificate can result into segfault.
Vulnerability (TALOS-2018-0758) reported by Colin Read and Nicolas Edet of
Cisco.

@item 
bpo-34812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34812}: The @ref{9f1,,-I} command line option (run Python in isolated
mode) is now also copied by the @ref{94,,multiprocessing} and @code{distutils}
modules when spawning child processes. Previously, only @ref{9f0,,-E} and
@ref{13eb,,-s} options (enabled by @ref{9f1,,-I}) were copied.

@item 
bpo-34791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34791}: The xml.sax and xml.dom.domreg no longer use environment
variables to override parser implementations when
sys.flags.ignore_environment is set by -E or -I arguments.

@item 
bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}: The xml.sax and xml.dom.minidom parsers no longer processes
external entities by default. External DTD and ENTITY declarations no
longer load files or create network connections.

@item 
bpo-34623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34623}: 
@geindex Common Vulnerabilities and Exposures; CVE 2018-14647
CVE 2018-14647@footnote{https://www.cve.org/CVERecord?id=CVE-2018-14647}: The C accelerated _elementtree module now
initializes hash randomization salt from _Py_HashSecret instead of
libexpat’s default CSPRNG.

@item 
bpo-34405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34405}: Updated to OpenSSL 1.1.0i for Windows builds.

@item 
bpo-33871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33871}: Fixed sending the part of the file in @ref{b9a,,os.sendfile()} on
macOS.  Using the `trailers' argument could cause sending more bytes from
the input file than was specified.

@item 
bpo-32533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32533}: Fixed thread-safety of error handling in _ssl.

@item 
bpo-33136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33136}: Harden ssl module against LibreSSL 
@geindex Common Vulnerabilities and Exposures; CVE 2018-8970
CVE 2018-8970@footnote{https://www.cve.org/CVERecord?id=CVE-2018-8970}.
X509_VERIFY_PARAM_set1_host() is called with an explicit namelen. A new
test ensures that NULL bytes are not allowed.

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Minimal fix to prevent buffer overrun in os.symlink on Windows

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: Regexes in difflib and poplib were vulnerable to catastrophic
backtracking. These regexes formed potential DOS vectors (REDOS). They
have been refactored. This resolves 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} and 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}.
Patch by Jamie Davis.

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: The ssl module now allows users to perform their own IDN
en/decoding when using SNI.
@end itemize

@node Core and Builtins<45>,Library<45>,Security<32>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id412}@anchor{1a2f}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-35877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35877}: Make parenthesis optional for named expressions in while
statement. Patch by Karthikeyan Singaravelan.

@item 
bpo-35814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35814}: Allow same right hand side expressions in annotated assignments
as in normal ones. In particular, @code{x: Tuple[int, int] = 1, 2} (without
parentheses on the right) is now allowed.

@item 
bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}: Add the option to parse PEP 484 type comments in the ast
module. (Off by default.) This is merging the key functionality of the
third party fork thereof,
[typed_ast](@indicateurl{https://github.com/python/typed_ast}).

@item 
bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}: Reorganize Python initialization to get working exceptions and
sys.stderr earlier.

@item 
bpo-33416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33416}: Add end line and end column position information to the Python
AST nodes. This is a C-level backwards incompatible change.

@item 
bpo-35720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35720}: Fixed a minor memory leak in pymain_parse_cmdline_impl function
in Modules/main.c

@item 
bpo-35634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35634}: @code{func(**kwargs)} will now raise an error when @code{kwargs} is a
mapping containing multiple entries with the same key. An error was
already raised when other keyword arguments are passed before @code{**kwargs}
since Python 3.6.

@item 
bpo-35623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35623}: Fix a crash when sorting very long lists. Patch by Stephan
Hohe.

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: clang Memory Sanitizer build instrumentation was added to work
around false positives from posix, socket, time, test_io, and
test_faulthandler.

@item 
bpo-35560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35560}: Fix an assertion error in @ref{6c0,,format()} in debug build for
floating-point formatting with «n» format, zero padding and small width.
Release build is not impacted. Patch by Karthikeyan Singaravelan.

@item 
bpo-35552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35552}: Format characters @code{%s} and @code{%V} in
@ref{47c,,PyUnicode_FromFormat()} and @code{%s} in @ref{1a30,,PyBytes_FromFormat()}
no longer read memory past the limit if `precision' is specified.

@item 
bpo-35504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35504}: Fix segfaults and @ref{619,,SystemError}s when deleting certain
attributes. Patch by Zackery Spytz.

@item 
bpo-35504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35504}: Fixed a SystemError when delete the characters_written
attribute of an OSError.

@item 
bpo-35494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35494}: Improved syntax error messages for unbalanced parentheses in
f-string.

@item 
bpo-35444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35444}: Fixed error handling in pickling methods when fail to look up
builtin «getattr». Sped up pickling iterators.

@item 
bpo-35436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35436}: Fix various issues with memory allocation error handling.
Patch by Zackery Spytz.

@item 
bpo-35423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35423}: Separate the signal handling trigger in the eval loop from the
«pending calls» machinery. There is no semantic change and the difference
in performance is insignificant.

@item 
bpo-35357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35357}: Internal attributes” names of unittest.mock._Call and
unittest.mock.MagicProxy (name, parent & from_kall) are now prefixed with
_mock_ in order to prevent clashes with widely used object attributes.
Fixed minor typo in test function name.

@item 
bpo-35372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35372}: Fixed the code page decoder for input longer than 2 GiB
containing undecodable bytes.

@item 
bpo-35336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35336}: Fix PYTHONCOERCECLOCALE=1 environment variable: only coerce the
C locale if the LC_CTYPE locale is «C».

@item 
bpo-31241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31241}: The `lineno' and `col_offset' attributes of AST nodes for list
comprehensions, generator expressions and tuples are now point to the
opening parenthesis or square brace. For tuples without parenthesis they
point to the position of the first item.

@item 
bpo-33954@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33954}: For @ref{6c2,,str.format()}, @code{float.__format__()} and
@code{complex.__format__()} methods for non-ASCII decimal point when using
the «n» formatter.

@item 
bpo-35269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35269}: Fix a possible segfault involving a newly created coroutine.
Patch by Zackery Spytz.

@item 
bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}: Implement 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} (assignment expressions). Patch by Emily
Morehouse.

@item 
bpo-32492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32492}: Speed up @code{namedtuple()} attribute access by 1.6x using a C
fast-path for the name descriptors. Patch by Pablo Galindo.

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: Fixed an out of bounds memory access when parsing a truncated
unicode escape sequence at the end of a string such as @code{'\N'}.  It would
read one byte beyond the end of the memory allocation.

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: The interpreter and extension modules have had annotations
added so that they work properly under clang’s Memory Sanitizer.  A new
configure flag –with-memory-sanitizer has been added to make test builds
of this nature easier to perform.

@item 
bpo-35193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35193}: Fix an off by one error in the bytecode peephole optimizer
where it could read bytes beyond the end of bounds of an array when
removing unreachable code. This bug was present in every release of Python
3.6 and 3.7 until now.

@item 
bpo-35169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35169}: Improved error messages for forbidden assignments.

@item 
bpo-34022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34022}: Fix handling of hash-based bytecode files in @ref{131,,zipimport}.
Patch by Elvis Pranskevichus.

@item 
bpo-28401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28401}: Debug builds will no longer to attempt to import extension
modules built for the ABI as they were never compatible to begin with.
Patch by Stefano Rivera.

@item 
bpo-29341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29341}: Clarify in the docstrings of @ref{a1,,os} methods that path-like
objects are also accepted as input parameters.

@item 
bpo-35050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35050}: @ref{cc,,socket}: Fix off-by-one bug in length check for
@code{AF_ALG} name and type.

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: Raise @ref{360,,ValueError} instead of @ref{919,,OverflowError} in case
of a negative @code{_length_} in a @ref{1a31,,ctypes.Array} subclass.  Also
raise @ref{228,,TypeError} instead of @ref{441,,AttributeError} for non-integer
@code{_length_}. Original patch by Oren Milman.

@item 
bpo-16806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16806}: Fix @code{lineno} and @code{col_offset} for multi-line string tokens.

@item 
bpo-35029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35029}: @ref{511,,SyntaxWarning} raised as an exception at code generation
time will be now replaced with a @ref{150,,SyntaxError} for better error
reporting.

@item 
bpo-34983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34983}: Expose @ref{1a32,,symtable.Symbol.is_nonlocal()} in the symtable
module. Patch by Pablo Galindo.

@item 
bpo-34974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34974}: @ref{325,,bytes} and @ref{5e0,,bytearray} constructors no longer
convert unexpected exceptions (e.g. @ref{16cb,,MemoryError} and
@ref{a63,,KeyboardInterrupt}) to @ref{228,,TypeError}.

@item 
bpo-34939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34939}: Allow annotated names in module namespace that are declared
global before the annotation happens. Patch by Pablo Galindo.

@item 
bpo-34973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34973}: Fixed crash in @ref{325,,bytes()} when the @ref{18e,,list} argument is
mutated while it is iterated.

@item 
bpo-34876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34876}: The `lineno' and `col_offset' attributes of the AST for
decorated function and class refer now to the position of the
corresponding @code{def}, @code{async def} and @code{class} instead of the position
of the first decorator. This leads to more correct line reporting in
tracing. This is the only case when the position of child AST nodes can
precede the position of the parent AST node.

@item 
bpo-34879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34879}: Fix a possible null pointer dereference in bytesobject.c.
Patch by Zackery Spytz.

@item 
bpo-34784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34784}: Fix the implementation of PyStructSequence_NewType in order to
create heap allocated StructSequences.

@item 
bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}: A @ref{511,,SyntaxWarning} is now emitted instead of a
@ref{1da,,DeprecationWarning} for invalid escape sequences in string and bytes
literals.

@item 
bpo-34854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34854}: Fixed a crash in compiling string annotations containing a
lambda with a keyword-only argument that doesn’t have a default value.

@item 
bpo-34850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34850}: The compiler now produces a @ref{511,,SyntaxWarning} when identity
checks (@code{is} and @code{is not}) are used with certain types of literals
(e.g. strings, ints).  These can often work by accident in CPython, but
are not guaranteed by the language spec.  The warning advises users to use
equality tests (@code{==} and @code{!=}) instead.

@item 
bpo-34824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34824}: Fix a possible null pointer dereference in Modules/_ssl.c.
Patch by Zackery Spytz.

@item 
bpo-30156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30156}: The C function @code{property_descr_get()} uses a «cached» tuple
to optimize function calls. But this tuple can be discovered in debug mode
with @ref{1b5,,sys.getobjects()}. Remove the optimization, it’s not really
worth it and it causes 3 different crashes last years.

@item 
bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762}: Fix contextvars C API to use PyObject* pointer types.

@item 
bpo-34751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34751}: The hash function for tuples is now based on xxHash which gives
better collision results on (formerly) pathological cases. Additionally,
on 64-bit systems it improves tuple hashes in general. Patch by Jeroen
Demeyer with substantial contributions by Tim Peters.

@item 
bpo-34735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34735}: Fix a memory leak in Modules/timemodule.c.  Patch by Zackery
Spytz.

@item 
bpo-34683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34683}: Fixed a bug where some SyntaxError error pointed to locations
that were off-by-one.

@item 
bpo-34651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34651}: Only allow the main interpreter to fork.  The avoids the
possibility of affecting the main interpreter, which is critical to
operation of the runtime.

@item 
bpo-34653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34653}: Remove unused function PyParser_SimpleParseStringFilename.

@item 
bpo-32236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32236}: Warn that line buffering is not supported if @ref{1be,,open()} is
called with binary mode and @code{buffering=1}.

@item 
bpo-34641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34641}: Further restrict the syntax of the left-hand side of keyword
arguments in function calls. In particular, @code{f((keyword)=arg)} is now
disallowed.

@item 
bpo-34637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34637}: Make the `start' argument to `sum()' visible as a keyword
argument.

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: Do not assume signed integer overflow behavior (C undefined
behavior) when performing set hash table resizing.

@item 
bpo-34588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34588}: Fix an off-by-one in the recursive call pruning feature of
traceback formatting.

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: On Windows, the LC_CTYPE is now set to the user preferred
locale at startup. Previously, the LC_CTYPE locale was «C» at startup, but
changed when calling setlocale(LC_CTYPE, «») or setlocale(LC_ALL, «»).

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: Standard streams like sys.stdout now use the «surrogateescape»
error handler, instead of «strict», on the POSIX locale (when the C locale
is not coerced and the UTF-8 Mode is disabled).

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: Fix the error handler of standard streams like sys.stdout:
PYTHONIOENCODING=»:» is now ignored instead of setting the error handler
to «strict».

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: Python now gets the locale encoding with C code to initialize
the encoding of standard streams like sys.stdout. Moreover, the encoding
is now initialized to the Python codec name to get a normalized encoding
name and to ensure that the codec is loaded. The change avoids importing
_bootlocale and _locale modules at startup by default.

@item 
bpo-34527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34527}: On FreeBSD, Py_DecodeLocale() and Py_EncodeLocale() now also
forces the ASCII encoding if the LC_CTYPE locale is «POSIX», not only if
the LC_CTYPE locale is «C».

@item 
bpo-34527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34527}: The UTF-8 Mode is now also enabled by the «POSIX» locale, not
only by the «C» locale.

@item 
bpo-34403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34403}: On HP-UX with C or POSIX locale, sys.getfilesystemencoding()
now returns «ascii» instead of «roman8» (when the UTF-8 Mode is disabled
and the C locale is not coerced).

@item 
bpo-34523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34523}: The Python filesystem encoding is now read earlier during the
Python initialization.

@item 
bpo-12458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12458}: Tracebacks show now correct line number for subexpressions in
multiline expressions. Tracebacks show now the line number of the first
line for multiline expressions instead of the line number of the last
subexpression.

@item 
bpo-34408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34408}: Prevent a null pointer dereference and resource leakage in
@code{PyInterpreterState_New()}.

@item 
bpo-34400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34400}: Fix undefined behavior in parsetok.c.  Patch by Zackery Spytz.

@item 
bpo-33073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33073}: Added as_integer_ratio to ints to make them more interoperable
with floats.

@item 
bpo-34377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34377}: Update valgrind suppression list to use
@code{_PyObject_Free}/@code{_PyObject_Realloc} instead of
@code{PyObject_Free}/@code{PyObject_Realloc}.

@item 
bpo-34353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34353}: Added the «socket» option in the @code{stat.filemode()} Python
implementation to match the C implementation.

@item 
bpo-34320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34320}: Fix @code{dict(od)} didn’t copy iteration order of OrderedDict.

@item 
bpo-34113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34113}: Fixed crash on debug builds when opcode stack was adjusted with
negative numbers. Patch by Constantin Petrisor.

@item 
bpo-34100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34100}: Compiler now merges constants in tuples and frozensets
recursively. Code attributes like @code{co_names} are merged too.

@item 
bpo-34151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34151}: Performance of list concatenation, repetition and slicing
operations is slightly improved. Patch by Sergey Fedoseev.

@item 
bpo-34170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34170}: -X dev: it is now possible to override the memory allocator
using PYTHONMALLOC even if the developer mode is enabled.

@item 
bpo-33237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33237}: Improved @ref{441,,AttributeError} message for partially
initialized module.

@item 
bpo-34149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34149}: Fix min and max functions to get default behavior when key is
None.

@item 
bpo-34125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34125}: Profiling of unbound built-in methods now works when
@code{**kwargs} is given.

@item 
bpo-34141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34141}: Optimized pickling atomic types (None, bool, int, float, bytes,
str).

@item 
bpo-34126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34126}: Fix crashes when profiling certain invalid calls of unbound
methods. Patch by Jeroen Demeyer.

@item 
bpo-24618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24618}: Fixed reading invalid memory when create the code object with
too small varnames tuple or too large argument counts.

@item 
bpo-34068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34068}: In @ref{354,,io.IOBase.close()}, ensure that the
@ref{1a33,,closed} attribute is not set with a live exception.
Patch by Zackery Spytz and Serhiy Storchaka.

@item 
bpo-34087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34087}: Fix buffer overflow while converting unicode to numeric values.

@item 
bpo-34080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34080}: Fixed a memory leak in the compiler when it raised some
uncommon errors during tokenizing.

@item 
bpo-34066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34066}: Disabled interruption by Ctrl-C between calling @code{open()} and
entering a `with' block in @code{with open()}.

@item 
bpo-34042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34042}: Fix dict.copy() to maintain correct total refcount (as reported
by sys.gettotalrefcount()).

@item 
bpo-33418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33418}: Fix potential memory leak in function object when it creates
reference cycle.

@item 
bpo-33985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33985}: Implement contextvars.ContextVar.name attribute.

@item 
bpo-33956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33956}: Update vendored Expat library copy to version 2.2.5.

@item 
bpo-24596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24596}: Decref the module object in @ref{1911,,PyRun_SimpleFileExFlags()}
before calling @ref{194f,,PyErr_Print()}.  Patch by Zackery Spytz.

@item 
bpo-33451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33451}: Close directly executed pyc files before calling
@code{PyEval_EvalCode()}.

@item 
bpo-1617161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1617161}: The hash of @code{BuiltinMethodType} instances (methods of
built-in classes) now depends on the hash of the identity of `__self__'
instead of its value. The hash and equality of @code{ModuleType} and
@code{MethodWrapperType} instances (methods of user-defined classes and
some methods of built-in classes like @code{str.__add__}) now depend on the
hash and equality of the identity of `__self__' instead of its value.
@code{MethodWrapperType} instances no longer support ordering.

@item 
bpo-33824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33824}: Fix «LC_ALL=C python3.7 -V»: reset properly the command line
parser when the encoding changes after reading the Python configuration.

@item 
bpo-33803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33803}: Fix a crash in hamt.c caused by enabling GC tracking for an
object that hadn’t all of its fields set to NULL.

@item 
bpo-33738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33738}: Seven macro incompatibilities with the Limited API were fixed,
and the macros @ref{18fd,,PyIter_Check()}, @ref{a1c,,PyIndex_Check()} and
@code{PyExceptionClass_Name()} were added as functions. A script for
automatic macro checks was added.

@item 
bpo-33786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33786}: Fix asynchronous generators to handle GeneratorExit in athrow()
correctly

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: @code{PyRun_SimpleFileExFlags} removes @code{__cached__} from module
in addition to @code{__file__}.

@item 
bpo-33706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33706}: Fix a crash in Python initialization when parsing the command
line options. Thanks Christoph Gohlke for the bug report and the fix!

@item 
bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}: Reduce @code{PyGC_Head} size from 3 words to 2 words.

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: Fixed reset of the SIGINT handler to SIG_DFL on interpreter
shutdown even when there was a custom handler set previously. Patch by
Philipp Kerling.

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: Fixed a leak when the garbage collector fails to add an object
with the @code{__del__} method or referenced by it into the
@ref{122e,,gc.garbage} list. @ref{a20,,PyGC_Collect()} can now be called when an
exception is set and preserves it.

@item 
bpo-33462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33462}: Make dict and dict views reversible. Patch by Rémi Lapeyre.

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: A @ref{1e5,,RuntimeError} is now raised when the custom metaclass
doesn’t provide the @code{__classcell__} entry in the namespace passed to
@code{type.__new__}.  A @ref{1da,,DeprecationWarning} was emitted in Python
3.6–3.7.

@item 
bpo-33499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33499}: Add 
@geindex PYTHONPYCACHEPREFIX
@geindex variables de entorno; PYTHONPYCACHEPREFIX
@ref{a35,,PYTHONPYCACHEPREFIX} environment variable and
@ref{2e2,,-X} @code{pycache_prefix} command-line option to set an alternate
root directory for writing module bytecode cache files.

@item 
bpo-25711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25711}: The @ref{131,,zipimport} module has been rewritten in pure Python.

@item 
bpo-33509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33509}: Fix module_globals parameter of warnings.warn_explicit(): don’t
crash if module_globals is not a dict.

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: Fix signed/unsigned comparison warning in pyhash.c.

@item 
bpo-33475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33475}: Fixed miscellaneous bugs in converting annotations to strings
and optimized parentheses in the string representation.

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: Added support for the @code{setpgroup}, @code{resetids},
@code{setsigmask}, @code{setsigdef} and @code{scheduler} parameters of
@code{posix_spawn}. Patch by Pablo Galindo.

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: Fix a leak in set_symmetric_difference().

@item 
bpo-33363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33363}: Raise a SyntaxError for @code{async with} and @code{async for}
statements outside of async functions.

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: Fix unaligned accesses in siphash24(). Patch by Rolf Eike Beer.

@item 
bpo-33128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33128}: Fix a bug that causes PathFinder to appear twice on
sys.meta_path. Patch by Pablo Galindo Salgado.

@item 
bpo-33331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33331}: Modules imported last are now cleared first at interpreter
shutdown.

@item 
bpo-33312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33312}: Fixed clang ubsan (undefined behavior sanitizer) warnings in
dictobject.c by adjusting how the internal struct _dictkeysobject shared
keys structure is declared.

@item 
bpo-33305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33305}: Improved syntax error messages for invalid numerical literals.

@item 
bpo-33306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33306}: Improved syntax error messages for unbalanced parentheses.

@item 
bpo-33234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33234}: The list constructor will pre-size and not over-allocate when
the input length is known.

@item 
bpo-33270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33270}: Intern the names for all anonymous code objects.  Patch by
Zackery Spytz.

@item 
bpo-30455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30455}: The C and Python code and the documentation related to tokens
are now generated from a single source file @code{Grammar/Tokens}.

@item 
bpo-33176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33176}: Add a @code{toreadonly()} method to memoryviews.

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: Fix potential memory leak in @code{normalizestring()}.

@item 
bpo-33205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33205}: Change dict growth function from
@code{round_up_to_power_2(used*2+hashtable_size/2)} to
@code{round_up_to_power_2(used*3)}.  Previously, dict is shrunk only when
@code{used == 0}. Now dict has more chance to be shrunk.

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: Improved error messages in “async with” when @code{__aenter__()}
or @code{__aexit__()} return non-awaitable object.

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: Fix @code{ma_version_tag} in dict implementation is uninitialized
when copying from key-sharing dict.

@item 
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}: When using the -m switch, sys.path[0] is now explicitly
expanded as the `starting' working directory, rather than being left as
the empty path (which allows imports from the current working directory at
the time of the import)

@item 
bpo-33138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33138}: Changed standard error message for non-pickleable and
non-copyable types. It now says «cannot pickle» instead of «can’t pickle»
or «cannot serialize».

@item 
bpo-33018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33018}: Improve consistency of errors raised by @code{issubclass()} when
called with a non-class and an abstract base class as the first and second
arguments, respectively. Patch by Josh Bronson.

@item 
bpo-33083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33083}: @code{math.factorial} no longer accepts arguments that are not
int-like. Patch by Pablo Galindo.

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: Added new opcode @ref{b35,,END_ASYNC_FOR} and fixes the
following issues:


@itemize *

@item 
Setting global @ref{1a34,,StopAsyncIteration} no longer breaks @code{async for}
loops.

@item 
Jumping into an @code{async for} loop is now disabled.

@item 
Jumping out of an @code{async for} loop no longer corrupts the stack.
@end itemize

@item 
bpo-25750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25750}: Fix rare Python crash due to bad refcounting in
@code{type_getattro()} if a descriptor deletes itself from the class. Patch
by Jeroen Demeyer.

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: Fixed bytecode generation for «async for» with a complex
target. A StopAsyncIteration raised on assigning or unpacking will be now
propagated instead of stopping the iteration.

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: Fixed jumping out of «with» block by setting f_lineno.

@item 
bpo-33005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33005}: Fix a crash on fork when using a custom memory allocator (ex:
using PYTHONMALLOC env var). _PyGILState_Reinit() and
_PyInterpreterState_Enable() now use the default RAW memory allocator to
allocate a new interpreters mutex on fork.

@item 
bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911}: Due to unexpected compatibility issues discovered during
downstream beta testing, reverted bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}. @code{docstring} field is
removed from Module, ClassDef, FunctionDef, and AsyncFunctionDef ast nodes
which was added in 3.7a1.  Docstring expression is restored as a first
statement in their body. Based on patch by Inada Naoki.

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: Prevent jumps from “return” and “exception” trace events.

@item 
bpo-32946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32946}: Importing names from already imported module with «from …
import …» is now 30% faster if the module is not a package.

@item 
bpo-32932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32932}: Make error message more revealing when there are non-str
objects in @code{__all__}.

@item 
bpo-32925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32925}: Optimized iterating and containing test for literal lists
consisting of non-constants: @code{x in [a, b]} and @code{for x in [a, b]}. The
case of all constant elements already was optimized.

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: Update Valgrind suppression list to account for the rename of
@code{Py_ADDRESS_IN_RANG} to @code{address_in_range}.

@item 
bpo-32836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32836}: Don’t use temporary variables in cases of list/dict/set
comprehensions

@item 
bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356}: Remove the new API added in bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356} (gc.ensure_disabled()
context manager).

@item 
bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}: For namespace packages, ensure that both @code{__file__} and
@code{__spec__.origin} are set to None.

@item 
bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}: Make sure @code{__spec__.loader} matches @code{__loader__} for
namespace packages.

@item 
bpo-32711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32711}: Fix the warning messages for Python/ast_unparse.c. Patch by
Stéphane Wirtel

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: Fix possible crashing in builtin Unicode decoders caused by
write out-of-bound errors when using customized decode error handlers.

@item 
bpo-32489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32489}: A @ref{a5b,,continue} statement is now allowed in the
@ref{a5c,,finally} clause.

@item 
bpo-17611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17611}: Simplified the interpreter loop by moving the logic of
unrolling the stack of blocks into the compiler. The compiler emits now
explicit instructions for adjusting the stack of values and calling the
cleaning up code for @ref{b34,,break}, @ref{a5b,,continue} and
@ref{a60,,return}.

Removed opcodes @code{BREAK_LOOP}, @code{CONTINUE_LOOP},
@code{SETUP_LOOP} and @code{SETUP_EXCEPT}. Added new opcodes
@code{ROT_FOUR}, @code{BEGIN_FINALLY} and @code{CALL_FINALLY} and
@code{POP_FINALLY}. Changed the behavior of @code{END_FINALLY} and
@code{WITH_CLEANUP_START}.

@item 
bpo-32285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32285}: New function unicodedata.is_normalized, which can check whether
a string is in a specific normal form.

@item 
bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}: Yield expressions are now disallowed in comprehensions and
generator expressions except the expression for the outermost iterable.

@item 
bpo-32117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32117}: Iterable unpacking is now allowed without parentheses in yield
and return statements, e.g. @code{yield 1, 2, 3, *rest}. Thanks to David
Cuthbert for the change and Jordan Chapman for added tests.

@item 
bpo-31902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31902}: Fix the @code{col_offset} attribute for ast nodes
@code{ast.AsyncFor}, @code{ast.AsyncFunctionDef}, and @code{ast.AsyncWith}.
Previously, @code{col_offset} pointed to the keyword after @code{async}.

@item 
bpo-25862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25862}: Fix assertion failures in the @code{tell()} method of
@code{io.TextIOWrapper}. Patch by Zackery Spytz.

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: Fix a crash in @code{ctypes.cast()} in case the type argument is a
ctypes structured data type. Patch by Eryk Sun and Oren Milman.

@item 
bpo-31577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31577}: Fix a crash in @code{os.utime()} in case of a bad ns argument.
Patch by Oren Milman.

@item 
bpo-29832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29832}: Remove references to “getsockaddrarg” from various socket error
messages. Patch by Oren Milman.
@end itemize

@node Library<45>,Documentation<44>,Core and Builtins<45>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id413}@anchor{1a35}
@subsubsection Library



@itemize -

@item 
bpo-35845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35845}: Add “order” parameter to memoryview.tobytes().

@item 
bpo-35864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35864}: The _asdict() method for collections.namedtuple now returns a
regular dict instead of an OrderedDict.

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: An ExitStack is now used internally within subprocess.Popen to
clean up pipe file handles. No behavior change in normal operation. But if
closing one handle were ever to cause an exception, the others will now be
closed instead of leaked.  (patch by Giampaolo Rodola)

@item 
bpo-35847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35847}: RISC-V needed the CTYPES_PASS_BY_REF_HACK.  Fixes ctypes
Structure test_pass_by_value.

@item 
bpo-35813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35813}: Shared memory submodule added to multiprocessing to avoid need
for serialization between processes

@item 
bpo-35780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35780}: Fix lru_cache() errors arising in recursive, reentrant, or
multi-threaded code. These errors could result in orphan links and in the
cache being trapped in a state with fewer than the specified maximum
number of links. Fix handling of negative maxsize which should have been
treated as zero. Fix errors in toggling the «full» status flag. Fix
misordering of links when errors are encountered.  Sync-up the C code and
pure Python code for the space saving path in functions with a single
positional argument. In this common case, the space overhead of an lru
cache entry is reduced by almost half.  Fix counting of cache misses. In
error cases, the miss count was out of sync with the actual number of
times the underlying user function was called.

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: @ref{37d,,os.posix_spawn()} and @ref{1a36,,os.posix_spawnp()} now have a
`setsid' parameter.

@item 
bpo-23846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23846}: @ref{6aa,,asyncio.ProactorEventLoop} now catches and logs send
errors when the self-pipe is full.

@item 
bpo-34323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34323}: @ref{b,,asyncio}: Enhance @code{IocpProactor.close()} log: wait 1
second before the first log, then log every second. Log also the number of
seconds since @code{close()} was called.

@item 
bpo-35674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35674}: Add a new @ref{1a36,,os.posix_spawnp()} function. Patch by Joannah
Nanjekye.

@item 
bpo-35733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35733}: @code{ast.Constant(boolean)} no longer an instance of
@code{ast.Num}.  Patch by Anthony Sottile.

@item 
bpo-35726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35726}: QueueHandler.prepare() now makes a copy of the record before
modifying and enqueueing it, to avoid affecting other handlers in the
chain.

@item 
bpo-35719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35719}: Sped up multi-argument @ref{8e,,math} functions atan2(),
copysign(), remainder() and hypot() by 1.3–2.5 times.

@item 
bpo-35717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35717}: Fix KeyError exception raised when using enums and compile.
Patch contributed by Rémi Lapeyre.

@item 
bpo-35699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35699}: Fixed detection of Visual Studio Build Tools 2017 in distutils

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: Fix memory leaks in asyncio ProactorEventLoop on overlapped
operation failure.

@item 
bpo-35702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35702}: The @ref{ad5,,time.CLOCK_UPTIME_RAW} constant is now available
for macOS 10.12.

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: Fix a memory leak in asyncio in the ProactorEventLoop when
@code{ReadFile()} or @code{WSASend()} overlapped operation fail immediately:
release the internal buffer.

@item 
bpo-35682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35682}: Fix @code{asyncio.ProactorEventLoop.sendfile()}: don’t attempt to
set the result of an internal future if it’s already done.

@item 
bpo-35283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35283}: Add a deprecated warning for the
@code{threading.Thread.isAlive()} method. Patch by Donghee Na.

@item 
bpo-35664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35664}: Improve operator.itemgetter() performance by 33% with optimized
argument handling and with adding a fast path for the common case of a
single non-negative integer index into a tuple (which is the typical use
case in the standard library).

@item 
bpo-35643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35643}: Fixed a SyntaxWarning: invalid escape sequence in
Modules/_sha3/cleanup.py. Patch by Mickaël Schoentgen.

@item 
bpo-35619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35619}: Improved support of custom data descriptors in @ref{96e,,help()} and
@ref{b5,,pydoc}.

@item 
bpo-28503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28503}: The @code{crypt} module now internally uses the @code{crypt_r()}
library function instead of @code{crypt()} when available.

@item 
bpo-35614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35614}: Fixed help() on metaclasses. Patch by Sanyam Khurana.

@item 
bpo-35568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35568}: Expose @code{raise(signum)} as @code{raise_signal}

@item 
bpo-35588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35588}: The floor division and modulo operations and the @ref{a33,,divmod()}
function on @ref{177,,fractions.Fraction} types are 2–4x faster. Patch by
Stefan Behnel.

@item 
bpo-35585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35585}: Speed-up building enums by value, e.g. http.HTTPStatus(200).

@item 
bpo-30561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30561}: random.gammavariate(1.0, beta) now computes the same result as
random.expovariate(1.0 / beta).  This synchronizes the two algorithms and
eliminates some idiosyncrasies in the old implementation.  It does however
produce a difference stream of random variables than it used to.

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: The @ref{d6,,subprocess} module can now use the
@ref{37d,,os.posix_spawn()} function in some cases for better performance.

@item 
bpo-35526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35526}: Delaying the “joke” of barry_as_FLUFL.mandatory to Python
version 4.0

@item 
bpo-35523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35523}: Remove @ref{2b,,ctypes} callback workaround: no longer create a
callback at startup. Avoid SELinux alert on @code{import ctypes} and @code{import
uuid}.

@item 
bpo-31784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31784}: @ref{c30,,uuid.uuid1()} now calls @ref{b72,,time.time_ns()} rather than
@code{int(time.time() * 1e9)}.

@item 
bpo-35513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35513}: @code{TextTestRunner} of
@code{unittest.runner} now uses @ref{b14,,time.perf_counter()} rather than
@ref{3ad,,time.time()} to measure the execution time of a test:
@ref{3ad,,time.time()} can go backwards, whereas @ref{b14,,time.perf_counter()} is
monotonic.

@item 
bpo-35502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35502}: Fixed reference leaks in
@ref{ae6,,xml.etree.ElementTree.TreeBuilder} in case of unfinished building
of the tree (in particular when an error was raised during parsing XML).

@item 
bpo-35348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35348}: Make @ref{1695,,platform.architecture()} parsing of @code{file} command
output more reliable: add the @code{-b} option to the @code{file} command to
omit the filename, force the usage of the C locale, and search also the
«shared object» pattern.

@item 
bpo-35491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35491}: @ref{94,,multiprocessing}: Add @code{Pool.__repr__()} and enhance
@code{BaseProcess.__repr__()} (add pid and parent pid) to ease debugging.
Pool state constant values are now strings instead of integers, for
example @code{RUN} value becomes @code{'RUN'} instead of @code{0}.

@item 
bpo-35477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35477}: @code{multiprocessing.Pool.__enter__()} now fails if the pool is
not running: @code{with pool:} fails if used more than once.

@item 
bpo-31446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31446}: Copy command line that was passed to CreateProcessW since this
function can change the content of the input buffer.

@item 
bpo-35471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35471}: Python 2.4 dropped MacOS 9 support. The macpath module was
deprecated in Python 3.7. The module is now removed.

@item 
bpo-23057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23057}: Unblock Proactor event loop when keyboard interrupt is received
on Windows

@item 
bpo-35052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35052}: Fix xml.dom.minidom cloneNode() on a document with an entity:
pass the correct arguments to the user data handler of an entity.

@item 
bpo-20239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20239}: Allow repeated assignment deletion of
@ref{ade,,unittest.mock.Mock} attributes. Patch by Pablo Galindo.

@item 
bpo-17185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17185}: Set @code{__signature__} on mock for @ref{7e,,inspect} to get
signature. Patch by Karthikeyan Singaravelan.

@item 
bpo-35445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35445}: Memory errors during creating posix.environ no longer ignored.

@item 
bpo-35415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35415}: Validate fileno= argument to socket.socket().

@item 
bpo-35424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35424}: @code{multiprocessing.Pool} destructor now emits
@ref{39d,,ResourceWarning} if the pool is still running.

@item 
bpo-35330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35330}: When a @code{Mock} instance was used to wrap an object, if
@code{side_effect} is used in one of the mocks of it methods, don’t call the
original implementation and return the result of using the side effect the
same way that it is done with return_value.

@item 
bpo-35346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35346}: Drop Mac OS 9 and Rhapsody support from the @ref{aa,,platform}
module. Rhapsody last release was in 2000. Mac OS 9 last release was in
2001.

@item 
bpo-10496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10496}: @code{check_environ()} of @code{distutils.utils}
now catches @ref{438,,KeyError} on calling @ref{1a37,,pwd.getpwuid()}: don’t create
the @code{HOME} environment variable in this case.

@item 
bpo-10496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10496}: @code{posixpath.expanduser()} now returns the input `path'
unchanged if the @code{HOME} environment variable is not set and the current
user has no home directory (if the current user identifier doesn’t exist
in the password database). This change fix the @ref{c7,,site} module if the
current user doesn’t exist in the password database (if the user has no
home directory).

@item 
bpo-35389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35389}: @ref{1a38,,platform.libc_ver()} now uses
@code{os.confstr('CS_GNU_LIBC_VERSION')} if available and the `executable'
parameter is not set.

@item 
bpo-35394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35394}: Add empty slots to asyncio abstract protocols.

@item 
bpo-35310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35310}: Fix a bug in @ref{e26,,select.select()} where, in some cases, the
file descriptor sequences were returned unmodified after a signal
interruption, even though the file descriptors might not be ready yet.
@ref{e26,,select.select()} will now always return empty lists if a timeout has
occurred.  Patch by Oran Avraham.

@item 
bpo-35380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35380}: Enable TCP_NODELAY on Windows for proactor asyncio event loop.

@item 
bpo-35341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35341}: Add generic version of @code{collections.OrderedDict} to the
@code{typing} module. Patch by Ismo Toijala.

@item 
bpo-35371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35371}: Fixed possible crash in @code{os.utime()} on Windows when pass
incorrect arguments.

@item 
bpo-35346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35346}: @ref{1a39,,platform.uname()} now redirects @code{stderr} to
@ref{1a3a,,os.devnull} when running external programs like @code{cmd /c ver}.

@item 
bpo-35066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35066}: Previously, calling the strftime() method on a datetime object
with a trailing “%” in the format string would result in an exception.
However, this only occurred when the datetime C module was being used; the
python implementation did not match this behavior. Datetime is now PEP-399
compliant, and will not throw an exception on a trailing “%”.

@item 
bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}: The function @code{platform.popen} has been removed, it was
deprecated since Python 3.3: use @ref{1c5,,os.popen()} instead.

@item 
bpo-35344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35344}: On macOS, @ref{175d,,platform.platform()} now uses
@ref{1a3b,,platform.mac_ver()}, if it returns a non-empty release string, to get
the macOS version rather than the darwin version.

@item 
bpo-35312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35312}: Make @code{lib2to3.pgen2.parse.ParseError} round-trip pickle-able.
Patch by Anthony Sottile.

@item 
bpo-35308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35308}: Fix regression in @code{webbrowser} where default browsers may be
preferred over browsers in the @code{BROWSER} environment variable.

@item 
bpo-24746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24746}: Avoid stripping trailing whitespace in doctest fancy diff.
Original patch by R. David Murray & Jairo Trad. Enhanced by Sanyam
Khurana.

@item 
bpo-28604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28604}: @ref{c86,,locale.localeconv()} now sets temporarily the @code{LC_CTYPE}
locale to the @code{LC_MONETARY} locale if the two locales are different and
monetary strings are non-ASCII. This temporary change affects other
threads.

@item 
bpo-35277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35277}: Update ensurepip to install pip 18.1 and setuptools 40.6.2.

@item 
bpo-24209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24209}: Adds IPv6 support when invoking http.server directly.

@item 
bpo-35226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35226}: Recursively check arguments when testing for equality of
@ref{19d7,,unittest.mock.call} objects and add note that tracking of
parameters used to create ancestors of mocks in @code{mock_calls} is not
possible.

@item 
bpo-29564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29564}: The warnings module now suggests to enable tracemalloc if the
source is specified, the tracemalloc module is available, but tracemalloc
is not tracing memory allocations.

@item 
bpo-35189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35189}: Modify the following fnctl function to retry if interrupted by
a signal (EINTR): flock, lockf, fnctl

@item 
bpo-30064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30064}: Use add_done_callback() in sock_* asyncio API to unsubscribe
reader/writer early on calcellation.

@item 
bpo-35186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35186}: Removed the «built with» comment added when @code{setup.py upload}
is used with either @code{bdist_rpm} or @code{bdist_dumb}.

@item 
bpo-35152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35152}: Allow sending more than 2 GB at once on a multiprocessing
connection on non-Windows systems.

@item 
bpo-35062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35062}: Fix incorrect parsing of
@ref{16d2,,io.IncrementalNewlineDecoder}’s `translate' argument.

@item 
bpo-35065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35065}: Remove @code{StreamReaderProtocol._untrack_reader}. The call to
@code{_untrack_reader} is currently performed too soon, causing the protocol
to forget about the reader before @code{connection_lost} can run and feed the
EOF to the reader.

@item 
bpo-34160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34160}: ElementTree and minidom now preserve the attribute order
specified by the user.

@item 
bpo-35079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35079}: Improve difflib.SequenceManager.get_matching_blocks doc by
adding “non-overlapping” and changing “!=” to “<”.

@item 
bpo-33710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33710}: Deprecated @code{l*gettext()} functions and methods in the
@ref{63,,gettext} module. They return encoded bytes instead of Unicode
strings and are artifacts from Python 2 times. Also deprecated functions
and methods related to setting the charset for @code{l*gettext()} functions
and methods.

@item 
bpo-35017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35017}: @ref{11b1,,socketserver.BaseServer.serve_forever()} now exits
immediately if it’s @ref{1a3c,,shutdown()} method is
called while it is polling for new events.

@item 
bpo-35024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35024}: @code{importlib} no longer logs @code{wrote <bytecode path>}
redundantly after @code{(created|could not create) <bytecode path>} is
already logged. Patch by Quentin Agren.

@item 
bpo-35047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35047}: @code{unittest.mock} now includes mock calls in exception messages
if @code{assert_not_called}, @code{assert_called_once}, or
@code{assert_called_once_with} fails. Patch by Petter Strandmark.

@item 
bpo-31047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31047}: Fix @code{ntpath.abspath} regression where it didn’t remove a
trailing separator on Windows. Patch by Tim Graham.

@item 
bpo-35053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35053}: tracemalloc now tries to update the traceback when an object is
reused from a «free list» (optimization for faster object creation, used
by the builtin list type for example).

@item 
bpo-31553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31553}: Add the –json-lines option to json.tool. Patch by hongweipeng.

@item 
bpo-34794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34794}: Fixed a leak in Tkinter when pass the Python wrapper around
Tcl_Obj back to Tcl/Tk.

@item 
bpo-34909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34909}: Enum: fix grandchildren subclassing when parent mixed with
concrete data types.

@item 
bpo-35022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35022}: @ref{f12,,unittest.mock.MagicMock} now supports the
@code{__fspath__} method (from @ref{cd9,,os.PathLike}).

@item 
bpo-35008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35008}: Fixed references leaks when call the @code{__setstate__()} method
of @ref{20b,,xml.etree.ElementTree.Element} in the C implementation for
already initialized element.

@item 
bpo-23420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23420}: Verify the value for the parameter “-s” of the cProfile CLI.
Patch by Robert Kuska

@item 
bpo-33947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33947}: dataclasses now handle recursive reprs without raising
RecursionError.

@item 
bpo-34890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34890}: Make @ref{1c3,,inspect.iscoroutinefunction()},
@ref{17d8,,inspect.isgeneratorfunction()} and @ref{17d9,,inspect.isasyncgenfunction()}
work with @ref{17a,,functools.partial()}. Patch by Pablo Galindo.

@item 
bpo-34521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34521}: Use @ref{1a3d,,socket.CMSG_SPACE()} to calculate ancillary data size
instead of @ref{1a3e,,socket.CMSG_LEN()} in
@code{multiprocessing.reduction.recvfds()} as 
@geindex RFC; RFC 3542
RFC 3542@footnote{https://datatracker.ietf.org/doc/html/rfc3542.html} requires the use
of the former for portable applications.

@item 
bpo-31522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31522}: The @code{mailbox.mbox.get_string} function `from_' parameter can
now successfully be set to a non-default value.

@item 
bpo-34970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34970}: Protect tasks weak set manipulation in @code{asyncio.all_tasks()}

@item 
bpo-34969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34969}: gzip: Add –fast, –best on the gzip CLI, these parameters will
be used for the fast compression method (quick) or the best method
compress (slower, but smaller file). Also, change the default compression
level to 6 (tradeoff).

@item 
bpo-16965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16965}: The 2to3 @code{execfile} fixer now opens the file with mode
@code{'rb'}.  Patch by Zackery Spytz.

@item 
bpo-34966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34966}: @ref{b5,,pydoc} now supports aliases not only to methods defined
in the end class, but also to inherited methods.  The docstring is not
duplicated for aliases.

@item 
bpo-34926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34926}: @ref{1a3f,,mimetypes.MimeTypes.guess_type()} now accepts
@ref{3f0,,path-like object} in addition to url strings. Patch by Mayank
Asthana.

@item 
bpo-23831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23831}: Add @code{moveto()} method to the @code{tkinter.Canvas} widget. Patch
by Juliette Monsel.

@item 
bpo-34941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34941}: Methods @code{find()}, @code{findtext()} and @code{findall()} of the
@code{Element} class in the @ref{125,,xml.etree.ElementTree} module are now able
to find children which are instances of @code{Element} subclasses.

@item 
bpo-32680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32680}: @ref{9c0,,smtplib.SMTP} objects now always have a @code{sock}
attribute present

@item 
bpo-34769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34769}: Fix for async generators not finalizing when event loop is in
debug mode and garbage collector runs in another thread.

@item 
bpo-34936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34936}: Fix @code{TclError} in @code{tkinter.Spinbox.selection_element()}.
Patch by Juliette Monsel.

@item 
bpo-34829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34829}: Add methods @code{selection_from}, @code{selection_range},
@code{selection_present} and @code{selection_to} to the @code{tkinter.Spinbox} for
consistency with the @code{tkinter.Entry} widget. Patch by Juliette Monsel.

@item 
bpo-34911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34911}: Added `secure_protocols' argument to
`http.cookiejar.DefaultCookiePolicy' to allow for tweaking of protocols
and also to add support by default for `wss', the secure websocket
protocol.

@item 
bpo-34922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34922}: Fixed integer overflow in the @ref{1a40,,digest()} and
@ref{1a41,,hexdigest()} methods for the SHAKE algorithm in the
@ref{68,,hashlib} module.

@item 
bpo-34925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34925}: 25% speedup in argument parsing for the functions in the bisect
module.

@item 
bpo-34900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34900}: Fixed @ref{189d,,unittest.TestCase.debug()} when used to call test
methods with subtests.  Patch by Bruno Oliveira.

@item 
bpo-34844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34844}: logging.Formatter enhancement - Ensure styles and fmt matches
in logging.Formatter - Added validate method in each format style class:
StrFormatStyle, PercentStyle, StringTemplateStyle. - This method is called
in the constructor of logging.Formatter class - Also re-raise the KeyError
in the format method of each style class, so it would a bit clear that
it’s an error with the invalid format fields.

@item 
bpo-34897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34897}: Adjust test.support.missing_compiler_executable check so that a
nominal command name of «» is ignored. Patch by Michael Felt.

@item 
bpo-34871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34871}: Fix inspect module polluted @code{sys.modules} when parsing
@code{__text_signature__} of callable.

@item 
bpo-34898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34898}: Add @code{mtime} argument to @code{gzip.compress} for reproducible
output. Patch by Guo Ci Teo.

@item 
bpo-28441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28441}: On Cygwin and MinGW, ensure that @code{sys.executable} always
includes the full filename in the path, including the @code{.exe} suffix
(unless it is a symbolic link).

@item 
bpo-34866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34866}: Adding @code{max_num_fields} to @code{cgi.FieldStorage} to make DOS
attacks harder by limiting the number of @code{MiniFieldStorage} objects
created by @code{FieldStorage}.

@item 
bpo-34711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34711}: http.server ensures it reports HTTPStatus.NOT_FOUND when the
local path ends with «/» and is not a directory, even if the underlying OS
(e.g. AIX) accepts such paths as a valid file reference. Patch by Michael
Felt.

@item 
bpo-34872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34872}: Fix self-cancellation in C implementation of asyncio.Task

@item 
bpo-34849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34849}: Don’t log waiting for @code{selector.select} in asyncio loop
iteration. The waiting is pretty normal for any asyncio program, logging
its time just adds a noise to logs without any useful information
provided.

@item 
bpo-34022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34022}: The 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} environment variable no longer
overrides the value of the `invalidation_mode' argument to
@ref{ab7,,py_compile.compile()}, and determines its default value instead.

@item 
bpo-34819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34819}: Use a monotonic clock to compute timeouts in
@code{Executor.map()} and @code{as_completed()}, in order to prevent
timeouts from deviating when the system clock is adjusted.

@item 
bpo-34758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34758}: Add .wasm -> application/wasm to list of recognized file types
and content type headers

@item 
bpo-34789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34789}: @ref{1a42,,xml.sax.make_parser()} now accepts any iterable as its
`parser_list' argument.  Patch by Andrés Delfino.

@item 
bpo-34334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34334}: In @code{QueueHandler}, clear @code{exc_text} from
@code{LogRecord} to prevent traceback from being written twice.

@item 
bpo-34687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34687}: On Windows, asyncio now uses ProactorEventLoop, instead of
SelectorEventLoop, by default.

@item 
bpo-5950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5950}: Support reading zip files with archive comments in
@ref{131,,zipimport}.

@item 
bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}: The parser now represents all constants as
@ref{211,,ast.Constant} instead of using specific constant AST types
(@code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} and @code{Ellipsis}). These
classes are considered deprecated and will be removed in future Python
versions.

@item 
bpo-34728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34728}: Add deprecation warning when @code{loop} is used in methods:
@code{asyncio.sleep}, @code{asyncio.wait} and @code{asyncio.wait_for}.

@item 
bpo-34738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34738}: ZIP files created by @code{distutils} will now include entries for
directories.

@item 
bpo-34659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34659}: Add an optional `initial' argument to itertools.accumulate().

@item 
bpo-29577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29577}: Support multiple mixin classes when creating Enums.

@item 
bpo-34670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34670}: Add SSLContext.post_handshake_auth and
SSLSocket.verify_client_post_handshake for TLS 1.3’s post handshake
authentication feature.

@item 
bpo-32718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32718}: The Activate.ps1 script from venv works with PowerShell Core
6.1 and is now available under all operating systems.

@item 
bpo-31177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31177}: Fix bug that prevented using @ref{d81,,reset_mock} on mock instances with deleted attributes

@item 
bpo-34672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34672}: Add a workaround, so the @code{'Z'} @ref{1256,,time.strftime()}
specifier on the musl C library can work in some cases.

@item 
bpo-34666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34666}: Implement @code{asyncio.StreamWriter.awrite} and
@code{asyncio.StreamWriter.aclose()} coroutines.  Methods are needed for
providing a consistent stream API with control flow switched on by
default.

@item 
bpo-6721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6721}: Acquire the logging module’s commonly used internal locks while
fork()ing to avoid deadlocks in the child process.

@item 
bpo-34658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34658}: Fix a rare interpreter unhandled exception state SystemError
only seen when using subprocess with a preexec_fn while an after_parent
handler has been registered with os.register_at_fork and the fork system
call fails.

@item 
bpo-34652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34652}: Ensure @ref{377,,os.lchmod()} is never defined on Linux.

@item 
bpo-34638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34638}: Store a weak reference to stream reader to break strong
references loop between reader and protocol.  It allows to detect and
close the socket if the stream is deleted (garbage collected) without
@code{close()} call.

@item 
bpo-34536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34536}: @code{Enum._missing_}:  raise @code{ValueError} if None returned and
@code{TypeError} if non-member is returned.

@item 
bpo-34636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34636}: Speed up re scanning of many non-matching characters for s w
and d within bytes objects. (microoptimization)

@item 
bpo-24412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24412}: Add @ref{adf,,addModuleCleanup()} and
@ref{ae0,,addClassCleanup()} to unittest to support cleanups
for @code{setUpModule()} and
@ref{ae1,,setUpClass()}. Patch by Lisa Roach.

@item 
bpo-34630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34630}: Don’t log SSL certificate errors in asyncio code (connection
error logging is skipped already).

@item 
bpo-32490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32490}: Prevent filename duplication in @ref{d6,,subprocess} exception
messages.  Patch by Zackery Spytz.

@item 
bpo-34363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34363}: dataclasses.asdict() and .astuple() now handle namedtuples
correctly.

@item 
bpo-34625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34625}: Update vendorized expat library version to 2.2.6.

@item 
bpo-32270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32270}: The subprocess module no longer mistakenly closes redirected
fds even when they were in pass_fds when outside of the default @{0, 1, 2@}
set.

@item 
bpo-34622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34622}: Create a dedicated @code{asyncio.CancelledError},
@code{asyncio.InvalidStateError} and @code{asyncio.TimeoutError} exception
classes.  Inherit them from corresponding exceptions from
@code{concurrent.futures} package. Extract @code{asyncio} exceptions into a
separate file.

@item 
bpo-34610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34610}: Fixed iterator of @code{multiprocessing.managers.DictProxy}.

@item 
bpo-34421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34421}: Fix distutils logging for non-ASCII strings.  This caused
installation issues on Windows.

@item 
bpo-34604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34604}: Fix possible mojibake in the error message of @code{pwd.getpwnam}
and @code{grp.getgrnam} using string representation because of invisible
characters or trailing whitespaces. Patch by William Grzybowski.

@item 
bpo-30977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30977}: Make uuid.UUID use @code{__slots__} to reduce its memory
footprint. Based on original patch by Wouter Bolsterlee.

@item 
bpo-34574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34574}: OrderedDict iterators are not exhausted during pickling
anymore. Patch by Sergey Fedoseev.

@item 
bpo-8110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8110}: Refactored @ref{d6,,subprocess} to check for Windows-specific
modules rather than @code{sys.platform == 'win32'}.

@item 
bpo-34530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34530}: @code{distutils.spawn.find_executable()} now falls back on
@ref{1a0a,,os.defpath} if the @code{PATH} environment variable is not set.

@item 
bpo-34563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34563}: On Windows, fix multiprocessing.Connection for very large read:
fix _winapi.PeekNamedPipe() and _winapi.ReadFile() for read larger than
INT_MAX (usually @code{2**31-1}).

@item 
bpo-34558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34558}: Correct typo in Lib/ctypes/_aix.py

@item 
bpo-34282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34282}: Move @code{Enum._convert} to @code{EnumMeta._convert_} and fix enum
members getting shadowed by parent attributes.

@item 
bpo-22872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22872}: When the queue is closed, @ref{360,,ValueError} is now raised by
@ref{1a43,,multiprocessing.Queue.put()} and @ref{1a44,,multiprocessing.Queue.get()}
instead of @ref{74a,,AssertionError} and @ref{4d5,,OSError}, respectively. Patch
by Zackery Spytz.

@item 
bpo-34515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34515}: Fix parsing non-ASCII identifiers in
@code{lib2to3.pgen2.tokenize} (
@geindex Python Enhancement Proposals; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}).

@item 
bpo-13312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13312}: Avoids a possible integer underflow (undefined behavior) in the
time module’s year handling code when passed a very low negative year
value.

@item 
bpo-34472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34472}: Improved compatibility for streamed files in @ref{130,,zipfile}.
Previously an optional signature was not being written and certain ZIP
applications were not supported. Patch by Silas Sewell.

@item 
bpo-34454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34454}: Fix the .fromisoformat() methods of datetime types crashing
when given unicode with non-UTF-8-encodable code points.  Specifically,
datetime.fromisoformat() now accepts surrogate unicode code points used as
the separator. Report and tests by Alexey Izbyshev, patch by Paul Ganssle.

@item 
bpo-6700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6700}: Fix inspect.getsourcelines for module level frames/tracebacks.
Patch by Vladimir Matveev.

@item 
bpo-34171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34171}: Running the @ref{fd,,trace} module no longer creates the
@code{trace.cover} file.

@item 
bpo-34441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34441}: Fix crash when an @code{ABC}-derived class with invalid
@code{__subclasses__} is passed as the second argument to @ref{85a,,issubclass()}.
Patch by Alexey Izbyshev.

@item 
bpo-34427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34427}: Fix infinite loop in @code{a.extend(a)} for @code{MutableSequence}
subclasses.

@item 
bpo-34412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34412}: Make @ref{1a45,,signal.strsignal()} work on HP-UX. Patch by Michael
Osipov.

@item 
bpo-20849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20849}: shutil.copytree now accepts a new @code{dirs_exist_ok} keyword
argument. Patch by Josh Bronson.

@item 
bpo-31715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31715}: Associate @code{.mjs} file extension with
@code{application/javascript} MIME Type.

@item 
bpo-34384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34384}: @ref{9b4,,os.readlink()} now accepts @ref{3f0,,path-like} and @ref{325,,bytes} objects on Windows.

@item 
bpo-22602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22602}: The UTF-7 decoder now raises @ref{aa5,,UnicodeDecodeError} for
ill-formed sequences starting with «+» (as specified in RFC 2152).  Patch
by Zackery Spytz.

@item 
bpo-2122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2122}: The @ref{b23,,mmap.flush()} method now returns
@code{None} on success, raises an exception on error under all platforms.

@item 
bpo-34341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34341}: Appending to the ZIP archive with the ZIP64 extension no longer
grows the size of extra fields of existing entries.

@item 
bpo-34333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34333}: Fix %-formatting in @ref{15f2,,pathlib.PurePath.with_suffix()} when
formatting an error message.

@item 
bpo-18540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18540}: The @ref{999,,imaplib.IMAP4} and @ref{99a,,imaplib.IMAP4_SSL}
classes now resolve to the local host IP correctly when the default value
of `host' parameter (@code{'@w{'}}) is used.

@item 
bpo-26502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26502}: Implement @code{traceback.FrameSummary.__len__()} method to
preserve compatibility with the old tuple API.

@item 
bpo-34318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34318}: @ref{5d0,,assertRaises()},
@ref{5d2,,assertRaisesRegex()},
@ref{11d5,,assertWarns()} and
@ref{11d6,,assertWarnsRegex()} no longer success if the
passed callable is None. They no longer ignore unknown keyword arguments
in the context manager mode. A DeprecationWarning was raised in these
cases since Python 3.5.

@item 
bpo-9372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9372}: Deprecate @ref{3d8,,__getitem__()} methods of
@ref{7d1,,xml.dom.pulldom.DOMEventStream}, @ref{7d2,,wsgiref.util.FileWrapper}
and @ref{7d3,,fileinput.FileInput}.

@item 
bpo-33613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33613}: Fix a race condition in @code{multiprocessing.semaphore_tracker}
when the tracker receives SIGINT before it can register signal handlers
for ignoring it.

@item 
bpo-34248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34248}: Report filename in the exception raised when the database file
cannot be opened by @ref{1a46,,dbm.gnu.open()} and @ref{1a47,,dbm.ndbm.open()} due to
OS-related error. Patch by Zsolt Cserna.

@item 
bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}: Add math.dist() to compute the Euclidean distance between two
points.

@item 
bpo-34246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34246}: @ref{eda,,smtplib.SMTP.send_message()} no longer modifies the
content of the `mail_options' argument. Patch by Pablo S. Blum de Aguiar.

@item 
bpo-31047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31047}: Fix @code{ntpath.abspath} for invalid paths on windows. Patch by
Franz Woellert.

@item 
bpo-32321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32321}: Add pure Python fallback for functools.reduce. Patch by Robert
Wright.

@item 
bpo-34270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34270}: The default asyncio task class now always has a name which can
be get or set using two new methods (@ref{a70,,get_name()} and
@ref{a6f,,set_name()}) and is visible in the @ref{894,,repr()} output.
An initial name can also be set using the new @code{name} keyword argument to
@ref{69d,,asyncio.create_task()} or the
@code{create_task()} method of the event loop.
If no initial name is set, the default Task implementation generates a
name like @code{Task-1} using a monotonic counter.

@item 
bpo-34263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34263}: asyncio’s event loop will not pass timeouts longer than one day
to epoll/select etc.

@item 
bpo-34035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34035}: Fix several AttributeError in zipfile seek() methods. Patch by
Mickaël Schoentgen.

@item 
bpo-32215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32215}: Fix performance regression in @ref{cf,,sqlite3} when a DML
statement appeared in a different line than the rest of the SQL query.

@item 
bpo-34075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34075}: Deprecate passing non-ThreadPoolExecutor instances to
@code{AbstractEventLoop.set_default_executor()}.

@item 
bpo-34251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34251}: Restore @code{msilib.Win64} to preserve backwards compatibility
since it’s already used by @code{distutils}” @code{bdist_msi} command.

@item 
bpo-19891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19891}: Ignore errors caused by missing / non-writable homedir while
writing history during exit of an interactive session.  Patch by Anthony
Sottile.

@item 
bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}: Enhanced math.hypot() to support more than two dimensions.

@item 
bpo-34228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34228}: tracemalloc: PYTHONTRACEMALLOC=0 environment variable and -X
tracemalloc=0 command line option are now allowed to disable explicitly
tracemalloc at startup.

@item 
bpo-13041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13041}: Use @ref{1175,,shutil.get_terminal_size()} to calculate the terminal
width correctly in the @code{argparse.HelpFormatter} class.  Initial patch by
Zbyszek Jędrzejewski-Szmek.

@item 
bpo-34213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34213}: Allow frozen dataclasses to have a field named «object».
Previously this conflicted with an internal use of «object».

@item 
bpo-34052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34052}: @ref{3f7,,sqlite3.Connection.create_aggregate()},
@ref{3f6,,sqlite3.Connection.create_function()},
@ref{3f8,,sqlite3.Connection.set_authorizer()},
@ref{3f9,,sqlite3.Connection.set_progress_handler()} methods raises TypeError
when unhashable objects are passed as callable. These methods now don’t
pass such objects to SQLite API. Previous behavior could lead to
segfaults. Patch by Sergey Fedoseev.

@item 
bpo-34197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34197}: Attributes `skipinitialspace', `doublequote' and `strict' of
the `dialect' attribute of the @ref{2a,,csv} reader are now @ref{513,,bool}
instances instead of integers 0 or 1.

@item 
bpo-32788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32788}: Errors other than @ref{228,,TypeError} raised in methods
@code{__adapt__()} and @code{__conform__()} in the @ref{cf,,sqlite3} module are now
propagated to the user.

@item 
bpo-21446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21446}: The @code{reload} fixer now uses @ref{5bd,,importlib.reload()} instead
of deprecated @code{imp.reload()}.

@item 
bpo-940286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=940286}: pydoc’s @code{Helper.showtopic()} method now prints the cross
references of a topic correctly.

@item 
bpo-34164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34164}: @ref{10a1,,base64.b32decode()} could raise UnboundLocalError or
OverflowError for incorrect padding.  Now it always raises
@code{base64.Error} in these cases.

@item 
bpo-33729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33729}: Fixed issues with arguments parsing in @ref{68,,hashlib}.

@item 
bpo-34097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34097}: ZipFile can zip files older than 1980-01-01 and newer than
2107-12-31 using a new @code{strict_timestamps} parameter at the cost of
setting the timestamp to the limit.

@item 
bpo-34108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34108}: Remove extraneous CR in 2to3 refactor.

@item 
bpo-34070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34070}: Make sure to only check if the handle is a tty, when opening a
file with @code{buffering=-1}.

@item 
bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}: Reverted bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}. 2to3 rejects now a trailing comma in
generator expressions.

@item 
bpo-33967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33967}: functools.singledispatch now raises TypeError instead of
IndexError when no positional arguments are passed.

@item 
bpo-34041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34041}: Add the parameter `deterministic' to the
@ref{3f6,,sqlite3.Connection.create_function()} method. Patch by Sergey
Fedoseev.

@item 
bpo-34056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34056}: Ensure the loader shim created by @code{imp.load_module} always
returns bytes from its @code{get_data()} function. This fixes using
@code{imp.load_module} with 
@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} hash-based pycs.

@item 
bpo-34054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34054}: The multiprocessing module now uses the monotonic clock
@ref{3ac,,time.monotonic()} instead of the system clock @ref{3ad,,time.time()} to
implement timeout.

@item 
bpo-34043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34043}: Optimize tarfile uncompress performance about 15% when gzip is
used.

@item 
bpo-34044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34044}: @code{subprocess.Popen} now copies the `startupinfo' argument to
leave it unchanged: it will modify the copy, so that the same
@code{STARTUPINFO} object can be used multiple times.

@item 
bpo-34010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34010}: Fixed a performance regression for reading streams with
tarfile. The buffered read should use a list, instead of appending to a
bytes object.

@item 
bpo-34019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34019}: webbrowser: Correct the arguments passed to Opera Browser when
opening a new URL using the @code{webbrowser} module. Patch by Bumsik Kim.

@item 
bpo-34003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34003}: csv.DictReader now creates dicts instead of OrderedDicts. Patch
by Michael Selik.

@item 
bpo-33978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33978}: Closed existing logging handlers before reconfiguration via
fileConfig and dictConfig. Patch by Karthikeyan Singaravelan.

@item 
bpo-14117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14117}: Make minor tweaks to turtledemo. The “wikipedia” example is now
“rosette”, describing what it draws.  The “penrose” print output is
reduced. The’1024” output of “tree” is eliminated.

@item 
bpo-33974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33974}: Fixed passing lists and tuples of strings containing special
characters @code{"}, @code{\}, @code{@{}, @code{@}} and @code{\n} as options to
@ref{f9,,ttk} widgets.

@item 
bpo-27500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27500}: Fix getaddrinfo to resolve IPv6 addresses correctly.

@item 
bpo-24567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24567}: Improve random.choices() to handle subnormal input weights that
could occasionally trigger an IndexError.

@item 
bpo-33871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33871}: Fixed integer overflow in @ref{be6,,os.readv()}, @ref{be9,,os.writev()},
@ref{be5,,os.preadv()} and @ref{be8,,os.pwritev()} and in @ref{b9a,,os.sendfile()} with
`headers' or `trailers' arguments (on BSD-based OSes and macOS).

@item 
bpo-25007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25007}: Add @ref{5d7,,copy.copy()} and @ref{bf6,,copy.deepcopy()} support to zlib
compressors and decompressors.  Patch by Zackery Spytz.

@item 
bpo-33929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33929}: multiprocessing: Fix a race condition in Popen of
multiprocessing.popen_spawn_win32. The child process now duplicates the
read end of pipe instead of «stealing» it. Previously, the read end of
pipe was «stolen» by the child process, but it leaked a handle if the
child process had been terminated before it could steal the handle from
the parent process.

@item 
bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}: Tokenize module now implicitly emits a NEWLINE when provided
with input that does not have a trailing new line.  This behavior now
matches what the C tokenizer does internally.  Contributed by Ammar Askar.

@item 
bpo-33897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33897}: Added a “force” keyword argument to logging.basicConfig().

@item 
bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695}: @ref{abb,,shutil.copytree()} uses @ref{1a2,,os.scandir()} function and
all copy functions depending from it use cached @ref{548,,os.stat()} values.
The speedup for copying a directory with 8000 files is around +9% on
Linux, +20% on Windows and + 30% on a Windows SMB share. Also the number
of @ref{548,,os.stat()} syscalls is reduced by 38% making
@ref{abb,,shutil.copytree()} especially faster on network filesystems.
(Contributed by Giampaolo Rodola” in bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695}.)

@item 
bpo-33916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33916}: bz2 and lzma: When Decompressor.__init__() is called twice,
free the old lock to not leak memory.

@item 
bpo-32568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32568}: Make select.epoll() and its documentation consistent regarding
`sizehint' and `flags'.

@item 
bpo-33833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33833}: Fixed bug in asyncio where ProactorSocketTransport logs
AssertionError if force closed during write.

@item 
bpo-33663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33663}: Convert content length to string before putting to header.

@item 
bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}: @ref{a2,,os.path} functions that return a boolean result like
@ref{aa0,,exists()}, @ref{aa1,,lexists()}, @ref{aa2,,isdir()},
@ref{aa3,,isfile()}, @ref{a9e,,islink()}, and
@ref{aa4,,ismount()}, and @ref{19b,,pathlib.Path} methods that return a
boolean result like @ref{aa8,,exists()},
@ref{38b,,is_dir()}, @ref{38a,,is_file()},
@ref{aa9,,is_mount()}, @ref{aaa,,is_symlink()},
@ref{aab,,is_block_device()},
@ref{aac,,is_char_device()}, @ref{aad,,is_fifo()},
@ref{aae,,is_socket()} now return @code{False} instead of raising
@ref{360,,ValueError} or its subclasses @ref{718,,UnicodeEncodeError} and
@ref{aa5,,UnicodeDecodeError} for paths that contain characters or bytes
unrepresentable at the OS level.

@item 
bpo-26544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26544}: Fixed implementation of @ref{1a38,,platform.libc_ver()}. It almost
always returned version “2.9” for glibc.

@item 
bpo-33843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33843}: Remove deprecated @code{cgi.escape}, @code{cgi.parse_qs} and
@code{cgi.parse_qsl}.

@item 
bpo-33842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33842}: Remove @code{tarfile.filemode} which is deprecated since Python
3.3.

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: Prevent site.main() exception if PYTHONSTARTUP is set. Patch by
Steve Weber.

@item 
bpo-33805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33805}: Improve error message of dataclasses.replace() when an InitVar
is not specified

@item 
bpo-33687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33687}: Fix the call to @code{os.chmod()} for @code{uu.decode()} if a mode is
given or decoded. Patch by Timo Furrer.

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: Datetime instance d with non-None tzinfo, but with
d.tzinfo.utcoffset(d) returning None is now treated as naive by the
astimezone() method.

@item 
bpo-32108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32108}: In configparser, don’t clear section when it is assigned to
itself.

@item 
bpo-27397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27397}: Make email module properly handle invalid-length base64
strings.

@item 
bpo-33578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33578}: Implement multibyte encoder/decoder state methods

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: Avoid race condition with debug logging

@item 
bpo-33476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33476}: Fix _header_value_parser.py when address group is missing final
“;”. Contributed by Enrique Perez-Terron

@item 
bpo-33694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33694}: asyncio: Fix a race condition causing data loss on
pause_reading()/resume_reading() when using the ProactorEventLoop.

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: Correct test for @code{uuid_enc_be} availability in
@code{configure.ac}. Patch by Michael Felt.

@item 
bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}: Add asyncio.WindowsSelectorEventLoopPolicy and
asyncio.WindowsProactorEventLoopPolicy.

@item 
bpo-33274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33274}: W3C DOM Level 1 specifies return value of
Element.removeAttributeNode() as «The Attr node that was removed.»
xml.dom.minidom now complies with this requirement.

@item 
bpo-33778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33778}: Update @code{unicodedata}’s database to Unicode version 11.0.0.

@item 
bpo-33165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33165}: Added a stacklevel parameter to logging calls to allow use of
wrapper/helper functions for logging APIs.

@item 
bpo-33770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33770}: improve base64 exception message for encoded inputs of invalid
length

@item 
bpo-33769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33769}: asyncio/start_tls: Fix error message; cancel callbacks in case
of an unhandled error; mark SSLTransport as closed if it is aborted.

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: The concatenation (@code{+}) and repetition (@code{*}) sequence
operations now raise @ref{228,,TypeError} instead of @ref{619,,SystemError} when
performed on @ref{368,,mmap.mmap} objects.  Patch by Zackery Spytz.

@item 
bpo-33734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33734}: asyncio/ssl: Fix AttributeError, increase default handshake
timeout

@item 
bpo-31014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31014}: Fixed creating a controller for @ref{115,,webbrowser} when a user
specifies a path to an entry in the BROWSER environment variable.  Based
on patch by John Still.

@item 
bpo-2504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2504}: Add gettext.pgettext() and variants.

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: Add description property for _ParameterKind

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: When cancelling the task due to a timeout,
@ref{6a0,,asyncio.wait_for()} will now wait until the cancellation is complete.

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: Fix gather to propagate cancellation of itself even with
return_exceptions.

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: Support protocol type switching in SSLTransport.set_protocol().

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: Pause the transport as early as possible to further reduce the
risk of data_received() being called before connection_made().

@item 
bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}: @ref{aea,,shutil.copyfile()}, @ref{aeb,,shutil.copy()},
@ref{aec,,shutil.copy2()}, @ref{abb,,shutil.copytree()} and @ref{aed,,shutil.move()} use
platform-specific fast-copy syscalls on Linux and macOS in order to copy
the file more efficiently. On Windows @ref{aea,,shutil.copyfile()} uses a
bigger default buffer size (1 MiB instead of 16 KiB) and a
@ref{156,,memoryview()}-based variant of @ref{aee,,shutil.copyfileobj()} is used.
The speedup for copying a 512MiB file is about +26% on Linux, +50% on
macOS and +40% on Windows. Also, much less CPU cycles are consumed.
(Contributed by Giampaolo Rodola” in bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427}.)

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: Fix a race condition in SSLProtocol.connection_made() of
asyncio.sslproto: start immediately the handshake instead of using
call_soon(). Previously, data_received() could be called before the
handshake started, causing the handshake to hang or fail.

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: Fixed bug where calling write_eof() on a
_SelectorSocketTransport after it’s already closed raises AttributeError.

@item 
bpo-32610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32610}: Make asyncio.all_tasks() return only pending tasks.

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: Avoid blocking on file IO in sendfile fallback code

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: Fix RuntimeError after closing loop that used run_in_executor

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: Fix Task.__repr__ crash with Cython’s bogus coroutines

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: Fix transport.set_protocol() to support switching between
asyncio.Protocol and asyncio.BufferedProtocol.  Fix loop.start_tls() to
work with asyncio.BufferedProtocols.

@item 
bpo-33652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33652}: Pickles of type variables and subscripted generics are now
future-proof and compatible with older Python versions.

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: Fixed @ref{c30,,uuid.uuid1()} on FreeBSD.

@item 
bpo-33238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33238}: Add @code{InvalidStateError} to @ref{22,,concurrent.futures}.
@code{Future.set_result} and @code{Future.set_exception} now raise
@code{InvalidStateError} if the futures are not pending or running. Patch by
Jason Haydaman.

@item 
bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618}: Finalize and document preliminary and experimental TLS 1.3
support with OpenSSL 1.1.1

@item 
bpo-33625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33625}: Release GIL on @code{grp.getgrnam}, @code{grp.getgrgid},
@code{pwd.getpwnam} and @code{pwd.getpwuid} if reentrant variants of these
functions are available. Patch by William Grzybowski.

@item 
bpo-33623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33623}: Fix possible SIGSGV when asyncio.Future is created in __del__

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: Use a better regex when breaking usage into wrappable parts.
Avoids bogus assertion errors from custom metavar strings.

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: Fixed a bug in the Python implementation of the JSON decoder
that prevented the cache of parsed strings from clearing after finishing
the decoding. Based on patch by c-fos.

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: Remove HMAC default to md5 marked for removal in 3.8 (removal
originally planned in 3.6, bump to 3.8 in PR 7062).

@item 
bpo-33582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33582}: Emit a deprecation warning for inspect.formatargspec

@item 
bpo-21145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21145}: Add @code{functools.cached_property} decorator, for computed
properties cached for the life of the instance.

@item 
bpo-33570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33570}: Change TLS 1.3 cipher suite settings for compatibility with
OpenSSL 1.1.1-pre6 and newer. OpenSSL 1.1.1 will have TLS 1.3 ciphers
enabled by default.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Do not simplify arguments to @code{typing.Union}. Now
@code{Union[Manager, Employee]} is not simplified to @code{Employee} at runtime.
Such simplification previously caused several bugs and limited
possibilities for introspection.

@item 
bpo-12486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12486}: @ref{582,,tokenize.generate_tokens()} is now documented as a public
API to tokenize unicode strings. It was previously present but
undocumented.

@item 
bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}: Add a new @code{block_on_close} class attribute to
@code{ForkingMixIn} and @code{ThreadingMixIn} classes of @ref{cd,,socketserver}.

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list should consider common TEMP
locations

@item 
bpo-33109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33109}: argparse subparsers are once again not required by default,
reverting the change in behavior introduced by bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510} in 3.7.0a2.

@item 
bpo-33541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33541}: Remove unused private method @code{_strptime.LocaleTime.__pad}
(a.k.a. @code{_LocaleTime__pad}).

@item 
bpo-33536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33536}: dataclasses.make_dataclass now checks for invalid field names
and duplicate fields. Also, added a check for invalid field
specifications.

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: Prevent @code{uuid.get_node} from using a DUID instead of a MAC on
Windows. Patch by Zvi Effron

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: Fix race condition with @code{ReadTransport.resume_reading} in
Windows proactor event loop.

@item 
Fix failure in @code{typing.get_type_hints()} when ClassVar was provided as a
string forward reference.

@item 
bpo-33516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33516}: @ref{f12,,unittest.mock.MagicMock} now supports the @code{__round__}
magic method.

@item 
bpo-28612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28612}: Added support for Site Maps to urllib’s @code{RobotFileParser} as
@ref{1a48,,RobotFileParser.site_maps()}. Patch by Lady Red, based
on patch by Peter Wirtz.

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: Remove platform.linux_distribution, which was deprecated since
3.5.

@item 
bpo-33504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33504}: Switch the default dictionary implementation for
@ref{23,,configparser} from @ref{67c,,collections.OrderedDict} to the standard
@ref{190,,dict} type.

@item 
bpo-33505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33505}: Optimize asyncio.ensure_future() by reordering if checks: 1.17x
faster.

@item 
bpo-33497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33497}: Add errors param to cgi.parse_multipart and make an encoding in
FieldStorage use the given errors (needed for Twisted).  Patch by Amber
Brown.

@item 
bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}: The @code{cProfile.Profile} class can now be used as a
context manager. Patch by Scott Sanderson.

@item 
bpo-33495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33495}: Change dataclasses.Fields repr to use the repr of each of its
members, instead of str.  This makes it more clear what each field
actually represents.  This is especially true for the “type” member.

@item 
bpo-26103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26103}: Correct @code{inspect.isdatadescriptor} to look for @code{__set__} or
@code{__delete__}.  Patch by Aaron Hall.

@item 
bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}: Removed the @code{doctype()} method and the `html' parameter of
the constructor of @ref{ae5,,XMLParser}.  The
@code{doctype()} method defined in a subclass will no longer be called.
Deprecated methods @code{getchildren()} and @code{getiterator()} in the
@ref{125,,ElementTree} module emit now a @ref{1da,,DeprecationWarning}
instead of @ref{95f,,PendingDeprecationWarning}.

@item 
bpo-33453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33453}: Fix dataclasses to work if using literal string type
annotations or if using PEP 563 «Postponed Evaluation of Annotations».
Only specific string prefixes are detected for both ClassVar («ClassVar»
and «typing.ClassVar») and InitVar («InitVar» and «dataclasses.InitVar»).

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Minor fixes in typing module: add annotations to
@code{NamedTuple.__new__}, pass @code{*args} and @code{**kwds} in
@code{Generic.__new__}.  Original PRs by Paulius Šarka and Chad Dombrova.

@item 
bpo-33365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33365}: Print the header values besides the header keys instead just
the header keys if `debuglevel' is set to >0 in @ref{6f,,http.client}. Patch
by Marco Strigl.

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: Updated alias mapping with glibc 2.27 supported locales.

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: Fix trailing quotation marks getting deleted when looking up
byte/string literals on pydoc. Patch by Andrés Delfino.

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: The function @code{platform.linux_distribution} and
@code{platform.dist} now trigger a @code{DeprecationWarning} and have been
marked for removal in Python 3.8

@item 
bpo-33281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33281}: Fix ctypes.util.find_library regression on macOS.

@item 
bpo-33311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33311}: Text and html output generated by cgitb does not display
parentheses if the current call is done directly in the module. Patch by
Stéphane Blondon.

@item 
bpo-27300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27300}: The file classes in `tempfile' now accept an `errors' parameter
that complements the already existing `encoding'.  Patch by Stephan Hohe.

@item 
bpo-32933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32933}: @ref{170f,,unittest.mock.mock_open()} now supports iteration over the
file contents. Patch by Tony Flury.

@item 
bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}: Raise @ref{228,,TypeError} when looking up non-Enum objects in Enum
classes and Enum members.

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: Update error message when constructing invalid
inspect.Parameters Patch by Donghee Na.

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: Fixed crash in the get() method of the @ref{35,,dbm.ndbm} database
object when it is called with a single argument.

@item 
bpo-33375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33375}: The warnings module now finds the Python file associated with a
warning from the code object, rather than the frame’s global namespace.
This is consistent with how tracebacks and pdb find filenames, and should
work better for dynamically executed code.

@item 
bpo-33336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33336}: @code{imaplib} now allows @code{MOVE} command in @code{IMAP4.uid()} (RFC
6851: IMAP MOVE Extension) and potentially as a name of supported method
of @code{IMAP4} object.

@item 
bpo-32455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32455}: Added `jump' parameter to @ref{fb1,,dis.stack_effect()}.

@item 
bpo-27485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27485}: Rename and deprecate undocumented functions in
@ref{10a,,urllib.parse()}.

@item 
bpo-33332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33332}: Add @code{signal.valid_signals()} to expose the POSIX sigfillset()
functionality.

@item 
bpo-33251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33251}: @code{ConfigParser.items()} was fixed so that key-value pairs
passed in via @ref{1a49,,vars()} are not included in the resulting output.

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: Fix multiprocessing regression on newer glibcs

@item 
bpo-33334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33334}: @ref{fb1,,dis.stack_effect()} now supports all defined opcodes
including NOP and EXTENDED_ARG.

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: Fix quoting of the @code{Comment} attribute of
@ref{1a4a,,http.cookies.SimpleCookie}.

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: Upgrade bundled version of pip to 10.0.1.

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: Fixed a crash in the @code{parser} module when converting an ST
object to a tree of tuples or lists with @code{line_info=False} and
@code{col_info=True}.

@item 
bpo-23403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23403}: lib2to3 now uses pickle protocol 4 for pre-computed grammars.

@item 
bpo-33266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33266}: lib2to3 now recognizes @code{rf'...'} strings.

@item 
bpo-11594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11594}: Ensure line-endings are respected when using lib2to3.

@item 
bpo-33254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33254}: Have @ref{351,,importlib.resources.contents()} and
@ref{1a4b,,importlib.abc.ResourceReader.contents()} return an @ref{1294,,iterable}
instead of an @ref{313,,iterator}.

@item 
bpo-33265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33265}: @code{contextlib.ExitStack} and @code{contextlib.AsyncExitStack} now
use a method instead of a wrapper function for exit callbacks.

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: Fix FD leak in @code{_SelectorSocketTransport}  Patch by Vlad
Starostin.

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: Fix display of @code{<module>} call in the html produced by
@code{cgitb.html()}. Patch by Stéphane Blondon.

@item 
bpo-33144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33144}: @code{random.Random()} and its subclassing mechanism got optimized
to check only once at class/subclass instantiation time whether its
@code{getrandbits()} method can be relied on by other methods, including
@code{randrange()}, for the generation of arbitrarily large random integers.
Patch by Wolfgang Maier.

@item 
bpo-33185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33185}: Fixed regression when running pydoc with the @ref{187,,-m}
switch. (The regression was introduced in 3.7.0b3 by the resolution of
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053})

This fix also changed pydoc to add @code{os.getcwd()} to @ref{27e,,sys.path}
when necessary, rather than adding @code{"."}.

@item 
bpo-29613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29613}: Added support for the @code{SameSite} cookie flag to the
@code{http.cookies} module.

@item 
bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}: Delete entries of @code{None} in @ref{684,,sys.path_importer_cache}
when @code{importlib.machinery.invalidate_caches()} is called.

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} now raises @code{IndexError} for empty
sequences consistently even when called from subclasses without a
@code{getrandbits()} implementation.

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: Update difflib.mdiff() for 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.  Convert an uncaught
StopIteration in a generator into a return-statement.

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: End framing at the end of C implementation of
@ref{1a4c,,pickle.Pickler.dump()}.

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: The urllib.robotparser’s @code{__str__} representation now
includes wildcard entries and the «Crawl-delay» and «Request-rate» fields.
Also removes extra newlines that were being appended to the end of the
string. Patch by Michael Lazar.

@item 
bpo-23403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23403}: @code{DEFAULT_PROTOCOL} in @ref{a6,,pickle} was bumped to 4. Protocol
4 is described in 
@geindex Python Enhancement Proposals; PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/} and available since Python 3.4. It offers
better performance and smaller size compared to protocol 3 introduced in
Python 3.0.

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: Improved error handling and fixed a reference leak in
@ref{37d,,os.posix_spawn()}.

@item 
bpo-33106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33106}: Deleting a key from a read-only dbm database raises module
specific error instead of KeyError.

@item 
bpo-33175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33175}: In dataclasses, Field.__set_name__ now looks up the
__set_name__ special method on the class, not the instance, of the default
value.

@item 
bpo-32380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32380}: Create functools.singledispatchmethod to support generic single
dispatch on descriptors and methods.

@item 
bpo-33141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33141}: Have Field objects pass through __set_name__ to their default
values, if they have their own __set_name__.

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: Allow ttk.Treeview.insert to insert iid that has a false
boolean value. Note iid=0 and iid=False would be same. Patch by Garvit
Khatri.

@item 
bpo-32873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32873}: Treat type variables and special typing forms as immutable by
copy and pickle.  This fixes several minor issues and inconsistencies, and
improves backwards compatibility with Python 3.6.

@item 
bpo-33134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33134}: When computing dataclass’s __hash__, use the lookup table to
contain the function which returns the __hash__ value.  This is an
improvement over looking up a string, and then testing that string to see
what to do.

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: The ssl module now compiles with LibreSSL 2.7.1.

@item 
bpo-32505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32505}: Raise TypeError if a member variable of a dataclass is of type
Field, but doesn’t have a type annotation.

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: Fix the failure on OSX caused by the tests relying on
sem_getvalue

@item 
bpo-33116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33116}: Add “Field” to dataclasses.__all__.

@item 
bpo-32896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32896}: Fix an error where subclassing a dataclass with a field that
uses a default_factory would generate an incorrect class.

@item 
bpo-33100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33100}: Dataclasses: If a field has a default value that’s a
MemberDescriptorType, then it’s from that field being in __slots__, not an
actual default value.

@item 
bpo-32953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32953}: If a non-dataclass inherits from a frozen dataclass, allow
attributes to be added to the derived class.  Only attributes from the
frozen dataclass cannot be assigned to.  Require all dataclasses in a
hierarchy to be either all frozen or all non-frozen.

@item 
bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}: Raise RuntimeError when @code{executor.submit} is called during
interpreter shutdown.

@item 
bpo-32968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32968}: Modulo and floor division involving Fraction and float should
return float.

@item 
bpo-33061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33061}: Add missing @code{NoReturn} to @code{__all__} in typing.py

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: Fix the size handling in multiprocessing.Queue when a pickling
error occurs.

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3 now properly supports trailing commas after @code{*args}
and @code{**kwargs} in function signatures.

@item 
bpo-33056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33056}: FIX properly close leaking fds in
concurrent.futures.ProcessPoolExecutor.

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: Release the GIL during fstat() calls, avoiding hang of all
threads when calling mmap.mmap(), os.urandom(), and random.seed().  Patch
by Nir Soffer.

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: Avoid failing in multiprocessing.Process if the standard
streams are closed or None at exit.

@item 
bpo-33034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33034}: Providing an explicit error message when casting the port
property to anything that is not an integer value using @code{urlparse()} and
@code{urlsplit()}. Patch by Matt Eaton.

@item 
bpo-30249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30249}: Improve struct.unpack_from() exception messages for problems
with the buffer size and offset.

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: Skip sending/receiving data after SSL transport closing.

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: Fix a regression in @ref{80,,ipaddress} that result of
@code{hosts()} is empty when the network is constructed by a tuple
containing an integer mask and only 1 bit left for addresses.

@item 
bpo-22674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22674}: Add the strsignal() function in the signal module that returns
the system description of the given signal, as returned by strsignal(3).

@item 
bpo-32999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32999}: Fix C implementation of @code{ABC.__subclasscheck__(cls,
subclass)} crashed when @code{subclass} is not a type object.

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: Fix inspect.signature() for single-parameter partialmethods.

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: Expose several missing constants in zlib and fix corresponding
documentation.

@item 
bpo-32056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32056}: Improved exceptions raised for invalid number of channels and
sample width when read an audio file in modules @code{aifc}, @ref{113,,wave}
and @code{sunau}.

@item 
bpo-32970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32970}: Improved disassembly of the MAKE_FUNCTION instruction.

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: Fix wrong redirection of a low descriptor (0 or 1) to stderr in
subprocess if another low descriptor is closed.

@item 
bpo-32960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32960}: For dataclasses, disallow inheriting frozen from non-frozen
classes, and also disallow inheriting non-frozen from frozen classes. This
restriction will be relaxed at a future date.

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: Fixed tarfile.itn handling of out-of-bounds float values. Patch
by Joffrey Fuhrer.

@item 
bpo-32257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32257}: The ssl module now contains OP_NO_RENEGOTIATION constant,
available with OpenSSL 1.1.0h or 1.1.1.

@item 
bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951}: Direct instantiation of SSLSocket and SSLObject objects is now
prohibited. The constructors were never documented, tested, or designed as
public constructors. Users were suppose to use ssl.wrap_socket() or
SSLContext.

@item 
bpo-32929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32929}: Remove the tri-state parameter «hash», and add the boolean
«unsafe_hash». If unsafe_hash is True, add a __hash__ function, but if a
__hash__ exists, raise TypeError.  If unsafe_hash is False, add a __hash__
based on the values of eq= and frozen=.  The unsafe_hash=False behavior is
the same as the old hash=None behavior.  unsafe_hash=False is the default,
just as hash=None used to be.

@item 
bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}: Add OP_ENABLE_MIDDLEBOX_COMPAT and test workaround for TLSv1.3
for future compatibility with OpenSSL 1.1.1.

@item 
bpo-32146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32146}: Document the interaction between frozen executables and the
spawn and forkserver start methods in multiprocessing.

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: The ssl module now detects missing NPN support in LibreSSL.

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open() now encodes filename with the filesystem encoding
rather than default encoding.

@item 
bpo-32759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32759}: Free unused arenas in multiprocessing.heap.

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: In @code{os.dup2}, don’t check every call whether the @code{dup3}
syscall exists or not.

@item 
bpo-32556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32556}: nt._getfinalpathname, nt._getvolumepathname and
nt._getdiskusage now correctly convert from bytes.

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: Rewrite confusing message from setup.py upload from «No dist
file created in earlier command» to the more helpful «Must create and
upload files in one command».

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: In @ref{f0,,tkinter}, @code{after_cancel(None)} now raises a
@ref{360,,ValueError} instead of canceling the first scheduled function.
Patch by Cheryl Sabella.

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: Make sure sys.argv remains as a list when running trace.

@item 
bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}: @code{_abc} module is added.  It is a speedup module with C
implementations for various functions and methods in @code{abc}.  Creating an
ABC subclass and calling @code{isinstance} or @code{issubclass} with an ABC
subclass are up to 1.5x faster. In addition, this makes Python start-up up
to 10% faster.

Note that the new implementation hides internal registry and caches,
previously accessible via private attributes @code{_abc_registry},
@code{_abc_cache}, and @code{_abc_negative_cache}.  There are three debugging
helper methods that can be used instead @code{_dump_registry},
@code{_abc_registry_clear}, and @code{_abc_caches_clear}.

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: Fixed @code{asyncio.Condition} issue which silently ignored
cancellation after notifying and cancelling a conditional lock. Patch by
Bar Harel.

@item 
bpo-32819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32819}: ssl.match_hostname() has been simplified and no longer depends
on re and ipaddress module for wildcard and IP addresses. Error reporting
for invalid wildcards has been improved.

@item 
bpo-19675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19675}: @code{multiprocessing.Pool} no longer leaks processes if its
initialization fails.

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: Remove
TCP_FASTOPEN,TCP_KEEPCNT,TCP_KEEPIDLE,TCP_KEEPINTVL flags on older version
Windows during run-time.

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: Fixed refleaks of @code{__init__()} methods in various modules.
(Contributed by Oren Milman)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: Fixed guessing quote and delimiter in csv.Sniffer.sniff() when
only the last field is quoted.  Patch by Jake Davis.

@item 
bpo-30688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30688}: Added support of @code{\N@{name@}} escapes in regular expressions.
Based on patch by Jonathan Eunice.

@item 
bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}: collections.ChainMap() preserves the order of the underlying
mappings.

@item 
bpo-32775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32775}: @ref{1a4d,,fnmatch.translate()} no longer produces patterns which
contain set operations. Sets starting with “[” or containing “–”, “&&”,
“~~” or “||” will be interpreted differently in regular expressions in
future versions. Currently they emit warnings. fnmatch.translate() now
avoids producing patterns containing such sets by accident.

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: Implement native fast sendfile for Windows proactor event loop.

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: Fix a rare but potential pre-exec child process deadlock in
subprocess on POSIX systems when marking file descriptors inheritable on
exec in the child process.  This bug appears to have been introduced in
3.4.

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: The ctypes module used to depend on indirect linking for
dlopen. The shared extension is now explicitly linked against libdl on
platforms with dl.

@item 
bpo-32749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32749}: A @ref{33,,dbm.dumb} database opened with flags “r” is now
read-only. @ref{b21,,dbm.dumb.open()} with flags “r” and “w” no longer creates
a database if it does not exist.

@item 
bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}: Implement @code{asyncio.TimerHandle.when()} method.

@item 
bpo-32691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32691}: Use mod_spec.parent when running modules with pdb

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: Fixed @code{asyncio.Lock()} safety issue which allowed acquiring
and locking the same lock multiple times, without it being free. Patch by
Bar Harel.

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: Do not include name field in SMTP envelope from address. Patch
by Stéphane Wirtel

@item 
bpo-31453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31453}: Add TLSVersion constants and SSLContext.maximum_version /
minimum_version attributes. The new API wraps OpenSSL 1.1
@indicateurl{https://web.archive.org/web/20180309043602/https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html}
feature.

@item 
bpo-24334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24334}: Internal implementation details of ssl module were cleaned up.
The SSLSocket has one less layer of indirection. Owner and session
information are now handled by the SSLSocket and SSLObject constructor.
Channel binding implementation has been simplified.

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: Fix the error handling in Aifc_read.initfp() when the SSND
chunk is not found. Patch by Zackery Spytz.

@item 
bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}: Add Ttk spinbox widget to @ref{f9,,tkinter.ttk}.  Patch by Alan D
Moore.

@item 
bpo-32512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32512}: @ref{af,,profile} CLI accepts @code{-m module_name} as an alternative
to script path.

@item 
bpo-8525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8525}: help() on a type now displays builtin subclasses. This is
intended primarily to help with notification of more specific exception
subclasses.

Patch by Sanyam Khurana.

@item 
bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}: http.server now exposes a ThreadingHTTPServer class and uses it
when the module is run with @code{-m} to cope with web browsers pre-opening
sockets.

@item 
bpo-29877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29877}: compileall: import ProcessPoolExecutor only when needed,
preventing hangs on low resource platforms

@item 
bpo-32221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32221}: Various functions returning tuple containing IPv6 addresses now
omit @code{%scope} part since the same information is already encoded in
`scopeid' tuple item. Especially this speeds up @code{socket.recvfrom()}
when it receives multicast packet since useless resolving of network
interface name is omitted.

@item 
bpo-32147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32147}: @ref{1a4e,,binascii.unhexlify()} is now up to 2 times faster. Patch
by Sergey Fedoseev.

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: The TarFile class now recurses directories in a reproducible
way.

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: The ZipFile class now recurses directories in a reproducible
way.

@item 
bpo-31680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31680}: Added @ref{a79,,curses.ncurses_version}.

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: Fix output of cover files for @code{trace} module command-line
tool. Previously emitted cover files only when @code{--missing} option was
used. Patch by Michael Selik.

@item 
bpo-31608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31608}: Raise a @code{TypeError} instead of crashing if a
@code{collections.deque} subclass returns a non-deque from @code{__new__}. Patch
by Oren Milman.

@item 
bpo-31425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31425}: Add support for sockets of the AF_QIPCRTR address family,
supported by the Linux kernel. This is used to communicate with services,
such as GPS or radio, running on Qualcomm devices. Patch by Bjorn
Andersson.

@item 
bpo-22005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22005}: Implemented unpickling instances of
@ref{32f,,datetime}, @ref{330,,date} and
@ref{331,,time} pickled by Python 2. @code{encoding='latin1'} should
be used for successful decoding.

@item 
bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}: @ref{39e,,sqlite3.Connection} now exposes a
@ref{c02,,backup} method, if the underlying SQLite
library is at version 3.6.11 or higher.  Patch by Lele Gaifax.

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: Support arrays >=2GiB in @ref{2b,,ctypes}.  Patch by Segev Finer.

@item 
bpo-31508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31508}: Removed support of arguments in
@code{tkinter.ttk.Treeview.selection}. It was deprecated in 3.6.  Use
specialized methods like @code{selection_set} for changing the selection.

@item 
bpo-29456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29456}: Fix bugs in hangul normalization: u1176, u11a7 and u11c3
@end itemize

@node Documentation<44>,Tests<43>,Library<45>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id414}@anchor{1a4f}
@subsubsection Documentation



@itemize -

@item 
bpo-21257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21257}: Document @ref{1a50,,http.client.parse_headers()}.

@item 
bpo-34764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34764}: Improve example of iter() with 2nd sentinel argument.

@item 
bpo-35564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35564}: Explicitly set master_doc variable in conf.py for compliance
with Sphinx 2.0

@item 
bpo-35511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35511}: Specified that profile.Profile class doesn’t not support enable
or disable methods. Also, elaborated that Profile object as a context
manager is only supported in cProfile module.

@item 
bpo-10536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10536}: Enhance the gettext docs. Patch by Éric Araujo

@item 
bpo-35089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35089}: Remove mention of @code{typing.io} and @code{typing.re}. Their types
should be imported from @code{typing} directly.

@item 
bpo-35038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35038}: Fix the documentation about an unexisting @code{f_restricted}
attribute in the frame object. Patch by Stéphane Wirtel

@item 
bpo-35042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35042}: Replace PEP XYZ by the pep role and allow to use the direct
links to the PEPs.

@item 
bpo-35044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35044}: Fix the documentation with the role @code{exc} for the
appropriated exception. Patch by Stéphane Wirtel

@item 
bpo-35035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35035}: Rename documentation for @ref{51,,email.utils} to
@code{email.utils.rst}.

@item 
bpo-34967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34967}: Use app.add_object_type() instead of the deprecated Sphinx
function app.description_unit()

@item 
bpo-34913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34913}: Add documentation about the new command line interface of the
gzip module.

@item 
bpo-32174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32174}: chm document displays non-ASCII characters properly on some
MBCS Windows systems.

@item 
bpo-11233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11233}: Create availability directive for documentation.  Original
patch by Georg Brandl.

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: Document how passing coroutines to asyncio.wait() can be
confusing.

@item 
bpo-34552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34552}: Make clear that @code{==} operator sometimes is equivalent to
@code{is}. The @code{<}, @code{<=}, @code{>} and @code{>=} operators are only defined
where they make sense.

@item 
bpo-28617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28617}: Fixed info in the stdtypes docs concerning the types that
support membership tests.

@item 
bpo-20177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20177}: Migrate datetime.date.fromtimestamp to Argument Clinic. Patch
by Tim Hoffmann.

@item 
bpo-34065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34065}: Fix wrongly written basicConfig documentation markup syntax

@item 
bpo-33460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33460}: replaced ellipsis with correct error codes in tutorial chapter
3.

@item 
bpo-33847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33847}: Add “@@” operator entry to index.

@item 
bpo-33409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33409}: Clarified the relationship between 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}’s
PYTHONCOERCECLOCALE and PEP 540’s PYTHONUTF8 mode.

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: Add versionadded tag to the documentation of
ParameterKind.description

@item 
bpo-17045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17045}: Improve the C-API doc for PyTypeObject.  This includes adding
several quick-reference tables and a lot of missing slot/typedef entries.
The existing entries were also cleaned up with a slightly more consistent
format.

@item 
bpo-33736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33736}: Improve the documentation of @ref{ba3,,asyncio.open_connection()},
@ref{ba4,,asyncio.start_server()} and their UNIX socket counterparts.

@item 
bpo-23859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23859}: Document that @code{asyncio.wait()} does not cancel its futures on
timeout.

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: Document 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} changes to asyncio.

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: Update HMAC md5 default to a DeprecationWarning, bump removal
to 3.8.

@item 
bpo-33594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33594}: Document @code{getargspec}, @code{from_function} and @code{from_builtin}
as deprecated in their respective docstring, and include version since
deprecation in DeprecationWarning message.

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: Fix broken pypi link

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: Add missing documentation for @code{typing.AsyncContextManager}.

@item 
bpo-33487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33487}: BZ2file now emit a DeprecationWarning when buffering=None is
passed, the deprecation message and documentation also now explicitly
state it is deprecated since 3.0.

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: Add Korean language switcher for @indicateurl{https://docs.python.org/3/}

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: Clarify that the @code{__path__} attribute on modules cannot be
just any value.

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: Modernize documentation for writing C extension types.

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: Deprecate @code{Py_UNICODE} usage in @code{c-api/arg} document.
@code{Py_UNICODE} related APIs are deprecated since Python 3.3, but it is
missed in the document.

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: Document PyBuffer_ToContiguous().

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: Modify documentation for the @code{islice()} recipe to consume
initial values up to the start index.

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: Update @ref{12f,,zipapp} documentation to describe how to make
standalone applications.

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: Documentation changes for ipaddress.  Patch by Jon Foster and
Berker Peksag.

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: Update documentation to clarify that @code{WindowsRegistryFinder}
implements @code{MetaPathFinder}. (Patch by Himanshu Lakhara)

@item 
bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}: The ssl module function ssl.wrap_socket() has been
de-emphasized and deprecated in favor of the more secure and efficient
SSLContext.wrap_socket() method.

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: Clarify docs for -O and -OO.  Patch by Terry Reedy.

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: Add documentation for the contextvars module (PEP 567).

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: Update link to w3c doc for xml default namespaces.

@item 
bpo-11015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11015}: Update @ref{e4,,test.support} documentation.

@item 
bpo-32613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32613}: Update the faq/windows.html to use the py command from PEP 397
instead of python.

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: Document @code{__getattr__()} behavior when property @code{get()}
method raises @ref{441,,AttributeError}.

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: Modify RE examples in documentation to use raw strings to
prevent @ref{1da,,DeprecationWarning} and add text to REGEX HOWTO to highlight
the deprecation.

@item 
bpo-20709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20709}: Remove the paragraph where we explain that os.utime() does not
support a directory as path under Windows. Patch by Jan-Philip Gehrcke

@item 
bpo-32722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32722}: Remove the bad example in the tutorial of the Generator
Expression. Patch by Stéphane Wirtel

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: Improve docstrings for @code{pathlib.PurePath} subclasses.

@item 
bpo-30607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30607}: Use the externalized @code{python-docs-theme} package when
building the documentation.

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: Add a note about curses.addch and curses.addstr exception
behavior when writing outside a window, or pad.

@item 
bpo-32337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32337}: Update documentation related with @code{dict} order.

@item 
bpo-25041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25041}: Document @code{AF_PACKET} in the @ref{cc,,socket} module.

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: Clarify meaning of CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED
flags for ssl.SSLContext.verify_mode.
@end itemize

@node Tests<43>,Build<44>,Documentation<44>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id415}@anchor{1a51}
@subsubsection Tests



@itemize -

@item 
bpo-35772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35772}: Fix sparse file tests of test_tarfile on ppc64 with the tmpfs
filesystem. Fix the function testing if the filesystem supports sparse
files: create a file which contains data and «holes», instead of creating
a file which contains no data. tmpfs effective block size is a page size
(tmpfs lives in the page cache). RHEL uses 64 KiB pages on aarch64, ppc64,
ppc64le, only s390x and x86_64 use 4 KiB pages, whereas the test punch
holes of 4 KiB.

@item 
bpo-35045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35045}: Make ssl tests less strict and also accept TLSv1 as system
default. The changes unbreaks test_min_max_version on Fedora 29.

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: @code{test_asyncio/test_sendfile.py} now resets the event loop
policy using @code{tearDownModule()} as done in other tests, to prevent a
warning when running tests on Windows.

@item 
bpo-33717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33717}: test.pythoninfo now logs information of all clocks, not only
time.time() and time.perf_counter().

@item 
bpo-35488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35488}: Add a test to pathlib’s Path.match() to verify it does not
support glob-style ** recursive pattern matching.

@item 
bpo-31731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31731}: Fix a race condition in @code{check_interrupted_write()} of
test_io: create directly the thread with SIGALRM signal blocked, rather
than blocking the signal later from the thread. Previously, it was
possible that the thread gets the signal before the signal is blocked.

@item 
bpo-35424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35424}: Fix test_multiprocessing_main_handling: use
@code{multiprocessing.Pool} with a context manager and then explicitly
join the pool.

@item 
bpo-35519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35519}: Rename @code{test.bisect} module to @code{test.bisect_cmd} to
avoid conflict with @ref{12,,bisect} module when running directly a test like
@code{./python Lib/test/test_xmlrpc.py}.

@item 
bpo-35513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35513}: Replace @ref{3ad,,time.time()} with @ref{3ac,,time.monotonic()} in tests
to measure time delta.

@item 
bpo-34279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34279}: @code{test.support.run_unittest()} no longer raise
@code{TestDidNotRun} if the test result contains skipped tests. The
exception is now only raised if no test have been run and no test have
been skipped.

@item 
bpo-35412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35412}: Add testcase to @code{test_future4}: check unicode literal.

@item 
bpo-26704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26704}: Added test demonstrating double-patching of an instance method.
Patch by Anthony Sottile.

@item 
bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}: test_multiprocessing_fork may crash on recent versions of
macOS.  Until the issue is resolved, skip the test on macOS.

@item 
bpo-35352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35352}: Modify test_asyncio to use the certificate set from the test
directory.

@item 
bpo-35317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35317}: Fix @code{mktime()} overflow error in @code{test_email}: run
@code{test_localtime_daylight_true_dst_true()} and
@code{test_localtime_daylight_false_dst_true()} with a specific timezone.

@item 
bpo-21263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21263}: After several reports that test_gdb does not work properly on
macOS and since gdb is not shipped by default anymore, test_gdb is now
skipped on macOS when LLVM Clang has been used to compile Python. Patch by
Lysandros Nikolaou

@item 
bpo-34279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34279}: regrtest issue a warning when no tests have been executed in a
particular test file. Also, a new final result state is issued if no test
have been executed across all test files. Patch by Pablo Galindo.

@item 
bpo-34962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34962}: make docstest in Doc now passes., and is enforced in CI

@item 
bpo-23596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23596}: Use argparse for the command line of the gzip module. Patch by
Antony Lee

@item 
bpo-34537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34537}: Fix @code{test_gdb.test_strings()} when @code{LC_ALL=C} and GDB was
compiled with Python 3.6 or earlier.

@item 
bpo-34587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34587}: test_socket: Remove RDSTest.testCongestion(). The test tries to
fill the receiver’s socket buffer and expects an error. But the RDS
protocol doesn’t require that. Moreover, the Linux implementation of RDS
expects that the producer of the messages reduces its rate, it’s not the
role of the receiver to trigger an error. The test fails on Fedora 28 by
design, so just remove it.

@item 
bpo-34661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34661}: Fix test_shutil if unzip doesn’t support -t.

@item 
bpo-34200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34200}: Fixed non-deterministic flakiness of test_pkg by not using the
scary test.support.module_cleanup() logic to save and restore sys.modules
contents between test cases.

@item 
bpo-34569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34569}: The experimental PEP 554 data channels now correctly pass
negative PyLong objects between subinterpreters on 32-bit systems. Patch
by Michael Felt.

@item 
bpo-34594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34594}: Fix usage of hardcoded @code{errno} values in the tests.

@item 
bpo-34579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34579}: Fix test_embed for AIX Patch by Michael Felt

@item 
bpo-34542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34542}: Use 3072 RSA keys and SHA-256 signature for test certs and
keys.

@item 
bpo-11193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11193}: Remove special condition for AIX in
@code{test_subprocess.test_undecodable_env}

@item 
bpo-34347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34347}: Fix @code{test_utf8_mode.test_cmd_line} for AIX

@item 
bpo-34490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34490}: On AIX with AF_UNIX family sockets getsockname() does not
provide “sockname”, so skip calls to transport.get_extra_info(“sockname”)

@item 
bpo-34391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34391}: Fix ftplib test for TLS 1.3 by reading from data socket.

@item 
bpo-11192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11192}: Fix @code{test_socket} on AIX 6.1 and later IPv6 zone id supports
only supported by @code{inet_pton6_zone()}. Switch to runtime-based
@code{platform.system()} to establish current platform rather than build-time
based @code{sys.platform()}

@item 
bpo-34399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34399}: Update all RSA keys and DH params to use at least 2048 bits.

@item 
bpo-34373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34373}: Fix @code{test_mktime} and @code{test_pthread_getcpuclickid} tests
for AIX Add range checking for @code{_PyTime_localtime} for AIX Patch by
Michael Felt

@item 
bpo-11191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11191}: Skip the distutils test “test_search_cpp” when using XLC as
compiler patch by aixtools (Michael Felt)

@item 
Improved an error message when mock assert_has_calls fails.

@item 
bpo-33746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33746}: Fix test_unittest when run in verbose mode.

@item 
bpo-33901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33901}: Fix test_dbm_gnu on macOS with gdbm 1.15: add a larger value to
make sure that the file size changes.

@item 
bpo-33873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33873}: Fix a bug in @code{regrtest} that caused an extra test to run if
–huntrleaks/-R was used. Exit with error in case that invalid parameters
are specified to –huntrleaks/-R (at least one warmup run and one
repetition must be used).

@item 
bpo-33562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33562}: Check that a global asyncio event loop policy is not left
behind by any tests.

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: Ignore test_posix_fallocate failures on BSD platforms that
might be due to running on ZFS.

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: Fixed test_gdb when Python is compiled with flags -mcet
-fcf-protection -O0.

@item 
bpo-33358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33358}: Fix @code{test_embed.test_pre_initialization_sys_options()} when
the interpreter is built with @code{--enable-shared}.

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: Avoid regrtest compatibility issue with namespace packages.

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: Fix failing @code{test_asyncio} on macOS 10.12.2+ due to transport
of @code{KqueueSelector} loop was not being closed.

@item 
bpo-32663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32663}: Making sure the @code{SMTPUTF8SimTests} class of tests gets run in
@code{test_smtplib.py}.

@item 
bpo-27643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27643}: Test_C test case needs «signed short» bitfields, but the IBM
XLC compiler (on AIX) does not support this Skip the code and test when
AIX and XLC are used

Applicable to Python2-2.7 and later

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: Add test_bdb.py.

@item 
bpo-31809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31809}: Add tests to verify connection with secp ECDH curves.
@end itemize

@node Build<44>,Windows<43>,Tests<43>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id416}@anchor{1a52}
@subsubsection Build



@itemize -

@item 
bpo-34691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34691}: The _contextvars module is now built into the core Python
library on Windows.

@item 
bpo-35683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35683}: Improved Azure Pipelines build steps and now verifying layouts
correctly

@item 
bpo-35642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35642}: Remove asynciomodule.c from pythoncore.vcxproj

@item 
bpo-35550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35550}: Fix incorrect Solaris #ifdef checks to look for __sun && __SVR4
instead of sun when compiling.

@item 
bpo-35499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35499}: @code{make profile-opt} no longer replaces @code{CFLAGS_NODIST} with
@code{CFLAGS}. It now adds profile-guided optimization (PGO) flags to
@code{CFLAGS_NODIST}: existing @code{CFLAGS_NODIST} flags are kept.

@item 
bpo-35257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35257}: Avoid leaking the linker flags from Link Time Optimizations
(LTO) into distutils when compiling C extensions.

@item 
bpo-35351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35351}: When building Python with clang and LTO, LTO flags are no
longer passed into CFLAGS to build third-party C extensions through
distutils.

@item 
bpo-35139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35139}: Fix a compiler error when statically linking @code{pyexpat} in
@code{Modules/Setup}.

@item 
bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}: PCbuild: Set InlineFunctionExpansion to OnlyExplicitInline
(«/Ob1» option) in pyproject.props in Debug mode to expand functions
marked as inline. This change should make Python compiled in Debug mode a
little bit faster on Windows.

@item 
bpo-35011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35011}: Restores the use of pyexpatns.h to isolate our embedded copy of
the expat C library so that its symbols do not conflict at link or dynamic
loading time with an embedding application or other extension modules with
their own version of libexpat.

@item 
bpo-28015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28015}: Have –with-lto works correctly with clang.

@item 
bpo-34765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34765}: Update the outdated install-sh file to the latest revision from
automake v1.16.1

@item 
bpo-34585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34585}: Check for floating-point byte order in configure.ac using
compilation tests instead of executing code, so that these checks work in
cross-compiled builds.

@item 
bpo-34710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34710}: Fixed SSL module build with OpenSSL & pedantic CFLAGS.

@item 
bpo-34582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34582}: Add JUnit XML output for regression tests and update Azure
DevOps builds.

@item 
bpo-34081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34081}: Make Sphinx warnings as errors in the Docs Makefile.

@item 
bpo-34555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34555}: Fix for case where it was not possible to have both
@code{HAVE_LINUX_VM_SOCKETS_H} and @code{HAVE_SOCKADDR_ALG} be undefined.

@item 
bpo-33015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33015}: Fix an undefined behaviour in the pthread implementation of
@code{PyThread_start_new_thread()}: add a function wrapper to always
return @code{NULL}.

@item 
bpo-34245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34245}: The Python shared library is now installed with write
permission (mode 0755), which is the standard way of installing such
libraries.

@item 
bpo-34121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34121}: Fix detection of C11 atomic support on clang.

@item 
bpo-32430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32430}: Rename Modules/Setup.dist to Modules/Setup, and remove the
necessity to copy the former manually to the latter when updating the
local source tree.

@item 
bpo-30345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30345}: Add -g to LDFLAGS when compiling with LTO to get debug symbols.

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: Move @code{-Wstrict-prototypes} option to @code{CFLAGS_NODIST} from
@code{OPT}. This option emitted annoying warnings when building extension
modules written in C++.

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: Ensures module definition files for the stable ABI on Windows
are correctly regenerated.

@item 
bpo-33648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33648}: The –with-c-locale-warning configuration flag has been
removed. It has had no effect for about a year.

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: Enable CI builds on Visual Studio Team Services at
@indicateurl{https://python.visualstudio.com/cpython}

@item 
bpo-33512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33512}: configure’s check for «long double» has been simplified

@item 
bpo-33483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33483}: C compiler is now correctly detected from the standard
environment variables. –without-gcc and –with-icc options have been
removed.

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: Enable the verbose build for extension modules, when GNU make
is passed macros on the command line.

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: Update config.guess and config.sub files.

@item 
bpo-33377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33377}: Add new triplets for mips r6 and riscv variants (used in
extension suffixes).

@item 
bpo-32232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32232}: By default, modules configured in @code{Modules/Setup} are no
longer built with @code{-DPy_BUILD_CORE}. Instead, modules that specifically
need that preprocessor definition include it in their individual entries.

@item 
bpo-33182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33182}: The embedding tests can once again be built with clang 6.0

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: Upgrade pip to 9.0.3 and setuptools to v39.0.1.

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: gcc 8 has added a new warning heuristic to detect invalid
function casts and a stock python build seems to hit that warning quite
often.  The most common is the cast of a METH_NOARGS function (that uses
just one argument) to a PyCFunction. Fix this by adding a dummy argument
to all functions that implement METH_NOARGS.

@item 
bpo-32898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32898}: Fix the python debug build when using COUNT_ALLOCS.

@item 
bpo-29442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29442}: Replace optparse with argparse in setup.py
@end itemize

@node Windows<43>,macOS<35>,Build<44>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id417}@anchor{1a53}
@subsubsection Windows



@itemize -

@item 
bpo-35890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35890}: Fix API calling consistency of GetVersionEx and wcstok.

@item 
bpo-32560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32560}: The @code{py} launcher now forwards its @code{STARTUPINFO} structure
to child processes.

@item 
bpo-35854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35854}: Fix EnvBuilder and –symlinks in venv on Windows

@item 
bpo-35811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35811}: Avoid propagating venv settings when launching via py.exe

@item 
bpo-35797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35797}: Fix default executable used by the multiprocessing module

@item 
bpo-35758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35758}: Allow building on ARM with MSVC.

@item 
bpo-29734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29734}: Fix handle leaks in os.stat on Windows.

@item 
bpo-35596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35596}: Use unchecked PYCs for the embeddable distro to avoid zipimport
restrictions.

@item 
bpo-35596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35596}: Fix vcruntime140.dll being added to embeddable distro multiple
times.

@item 
bpo-35402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35402}: Update Windows build to use Tcl and Tk 8.6.9

@item 
bpo-35401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35401}: Updates Windows build to OpenSSL 1.1.0j

@item 
bpo-34977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34977}: venv on Windows will now use a python.exe redirector rather
than copying the actual binaries from the base environment.

@item 
bpo-34977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34977}: Adds support for building a Windows App Store package

@item 
bpo-35067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35067}: Remove _distutils_findvs module and use vswhere.exe instead.

@item 
bpo-32557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32557}: Allow shutil.disk_usage to take a file path on Windows

@item 
bpo-34770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34770}: Fix a possible null pointer dereference in pyshellext.cpp.

@item 
bpo-34603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34603}: Fix returning structs from functions produced by MSVC

@item 
bpo-34581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34581}: Guard MSVC-specific code in socketmodule.c with @code{#ifdef
_MSC_VER}.

@item 
bpo-34532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34532}: Fixes exit code of list version arguments for py.exe.

@item 
bpo-34062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34062}: Fixed the “–list” and “–list-paths” arguments for the py.exe
launcher

@item 
bpo-34225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34225}: Ensure INCLUDE and LIB directories do not end with a backslash.

@item 
bpo-34011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34011}: A suite of code has been changed which copied across DLLs and
init.tcl from the running Python location into a venv being created. These
copies are needed only when running from a Python source build, and the
copying code is now only run when that is the case, rather than whenever a
venv is created.

@item 
bpo-34006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34006}: Revert line length limit for Windows help docs. The line-length
limit is not needed because the pages appear in a separate app rather than
on a browser tab.  It can also interact badly with the DPI setting.

@item 
bpo-31546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31546}: Restore running PyOS_InputHook while waiting for user input at
the prompt. The restores integration of interactive GUI windows (such as
Matplotlib figures) with the prompt on Windows.

@item 
bpo-30237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30237}: Output error when ReadConsole is canceled by
CancelSynchronousIo instead of crashing.

@item 
bpo-33895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33895}: GIL is released while calling functions that acquire Windows
loader lock.

@item 
bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720}: Reduces maximum marshal recursion depth on release builds.

@item 
bpo-29097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29097}: Fix bug where @code{datetime.fromtimestamp()} erroneously throws
an @ref{4d5,,OSError} on Windows for values between 0 and 86400. Patch by
Ammar Askar.

@item 
bpo-33316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33316}: PyThread_release_lock always fails

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update Windows installer to use OpenSSL 1.1.0h.

@item 
bpo-32890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32890}: Fix usage of GetLastError() instead of errno in os.execve() and
os.truncate().

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: Fix potential use of uninitialized memory in
nt._getfinalpathname

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: Fix a memory leak in os.chdir() on Windows if the current
directory is set to a UNC path.

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: Update Tcl and Tk versions to 8.6.8

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: Fixed WindowsConsoleIO.write() for writing empty data.

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: Ensures activate.bat can handle Unicode contents.

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: Improves handling of denormalized executable path when
launching Python.

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: Use the correct encoding for ipconfig output in the uuid
module. Patch by Segev Finer.

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: Fix @ref{9b4,,os.readlink()} on Windows, which was mistakenly
treating the @code{PrintNameOffset} field of the reparse data buffer as a
number of characters instead of bytes. Patch by Craig Holmquist and SSE4.

@item 
bpo-1104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1104}: Correctly handle string length in
@code{msilib.SummaryInfo.GetProperty()} to prevent it from truncating the
last character.
@end itemize

@node macOS<35>,IDLE<33>,Windows<43>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id418}@anchor{1a54}
@subsubsection macOS



@itemize -

@item 
bpo-35401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35401}: Update macOS installer to use OpenSSL 1.1.0j.

@item 
bpo-35025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35025}: Properly guard the use of the @code{CLOCK_GETTIME} et al. macros
in @code{timemodule} on macOS.

@item 
bpo-24658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24658}: On macOS, fix reading from and writing into a file with a size
larger than 2 GiB.

@item 
bpo-34405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34405}: Update to OpenSSL 1.1.0i for macOS installer builds.

@item 
bpo-33635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33635}: In macOS stat on some file descriptors (/dev/fd/3 f.e) will
result in bad file descriptor OSError. Guard against this exception was
added in is_dir, is_file and similar methods. DirEntry.is_dir can also
throw this exception so _RecursiveWildcardSelector._iterate_directories
was also extended with the same error ignoring pattern.

@item 
bpo-13631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13631}: The .editrc file in user’s home directory is now processed
correctly during the readline initialization through editline emulation on
macOS.

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update macOS installer build to use OpenSSL 1.1.0h.

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: Build and link with private copy of Tcl/Tk 8.6 for the macOS
10.6+ installer. The 10.9+ installer variant already does this.  This
means that the Python 3.7 provided by the python.org macOS installers no
longer need or use any external versions of Tcl/Tk, either system-provided
or user-installed, such as ActiveTcl.

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: Update macOS 10.9+ installer to Tcl/Tk 8.6.8.

@item 
bpo-31903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31903}: In @code{_scproxy}, drop the GIL when calling into
@code{SystemConfiguration} to avoid deadlocks.
@end itemize

@node IDLE<33>,Tools/Demos<24>,macOS<35>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id419}@anchor{1a55}
@subsubsection IDLE



@itemize -

@item 
bpo-35770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35770}: IDLE macosx deletes Options => Configure IDLE. It previously
deleted Window => Zoom Height by mistake. (Zoom Height is now on the
Options menu).  On Mac, the settings dialog is accessed via Preferences on
the IDLE menu.

@item 
bpo-35769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35769}: Change IDLE’s new file name from “Untitled” to “untitled”

@item 
bpo-35660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35660}: Fix imports in idlelib.window.

@item 
bpo-35641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35641}: Proper format @code{calltip} when the function has no docstring.

@item 
bpo-33987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33987}: Use ttk Frame for ttk widgets.

@item 
bpo-34055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34055}: Fix erroneous “smart” indents and newlines in IDLE Shell.

@item 
bpo-35591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35591}: Find Selection now works when selection not found.

@item 
bpo-35196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35196}: Speed up squeezer line counting.

@item 
bpo-35598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35598}: Update config_key: use PEP 8 names and ttk widgets, make some
objects global, and add tests.

@item 
bpo-28097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28097}: Add Previous/Next History entries to Shell menu.

@item 
bpo-35208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35208}: Squeezer now properly counts wrapped lines before newlines.

@item 
bpo-35555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35555}: Gray out Code Context menu entry when it’s not applicable.

@item 
bpo-35521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35521}: Document the IDLE editor code context feature. Add some
internal references within the IDLE doc.

@item 
bpo-22703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22703}: The Code Context menu label now toggles between Show/Hide Code
Context. The Zoom Height menu now toggles between Zoom/Restore Height.
Zoom Height has moved from the Window menu to the Options menu.

@item 
bpo-35213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35213}: Where appropriate, use “macOS” in idlelib.

@item 
bpo-34864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34864}: On macOS, warn if the system preference «Prefer tabs when
opening documents» is set to «Always».

@item 
bpo-34864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34864}: Document two IDLE on MacOS issues. The System Preferences Dock
«prefer tabs always» setting disables some IDLE features.  Menus are a bit
different than as described for Windows and Linux.

@item 
bpo-35202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35202}: Remove unused imports from lib/idlelib

@item 
bpo-33000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33000}: Document that IDLE’s shell has no line limit. A program that
runs indefinitely can overfill memory.

@item 
bpo-23220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23220}: Explain how IDLE’s Shell displays output.

@item 
bpo-35099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35099}: Improve the doc about IDLE running user code.   The section is
renamed from «IDLE – console differences» is renamed «Running user code».
It mostly covers the implications of using custom @code{sys.std@var{xxx}}
objects.

@item 
bpo-35097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35097}: Add IDLE doc subsection explaining editor windows. Topics
include opening, title and status bar, .py* extension, and running.

@item 
bpo-35093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35093}: Document the IDLE document viewer in the IDLE doc. Add a
paragraph in «Help and preferences», «Help sources» subsection.

@item 
bpo-35088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35088}: Update idlelib.help.copy_string docstring. We now use git and
backporting instead of hg and forward merging.

@item 
bpo-35087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35087}: Update idlelib help files for the current doc build. The main
change is the elimination of chapter-section numbers.

@item 
bpo-34548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34548}: Use configured color theme for read-only text views.

@item 
bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}: Enable «squeezing» of long outputs in the shell, to avoid
performance degradation and to clean up the history without losing it.
Squeezed outputs may be copied, viewed in a separate window, and
«unsqueezed».

@item 
bpo-34047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34047}: Fixed mousewheel scrolling direction on macOS.

@item 
bpo-34275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34275}: Make IDLE calltips always visible on Mac. Some MacOS-tk
combinations need .update_idletasks(). Patch by Kevin Walzer.

@item 
bpo-34120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34120}: Fix unresponsiveness after closing certain windows and dialogs.

@item 
bpo-33975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33975}: Avoid small type when running htests. Since part of the purpose
of human-viewed tests is to determine that widgets look right, it is
important that they look the same for testing as when running IDLE.

@item 
bpo-33905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33905}: Add test for idlelib.stackview.StackBrowser.

@item 
bpo-33924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33924}: Change mainmenu.menudefs key “windows” to “window”. Every other
menudef key is lowercase version of main menu entry.

@item 
bpo-33906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33906}: Rename idlelib.windows as window Match Window on the main menu
and remove last plural module name.

@item 
bpo-33917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33917}: Fix and document idlelib/idle_test/template.py. The revised
file compiles, runs, and tests OK.  idle_test/README.txt explains how to
use it to create new IDLE test files.

@item 
bpo-33904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33904}: IDLE: In rstrip, rename class RstripExtension as Rstrip

@item 
bpo-33907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33907}: For consistency and clarity, rename an IDLE module and classes.
Module calltips and its class CallTips are now calltip and Calltip. In
module calltip_w, class CallTip is now CalltipWindow.

@item 
bpo-33856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33856}: Add «help» in the welcome message of IDLE

@item 
bpo-33839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33839}: IDLE: refactor ToolTip and CallTip and add documentation and
tests

@item 
bpo-33855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33855}: Minimally test all IDLE modules. Add missing files, import
module, instantiate classes, and check coverage. Check existing files.

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: On Windows, add API call saying that tk scales for DPI. On
Windows 8.1+ or 10, with DPI compatibility properties of the Python binary
unchanged, and a monitor resolution greater than 96 DPI, this should make
text and lines sharper.  It should otherwise have no effect.

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: Clicking on a context line moves that line to the top of the
editor window.

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE: Use read-only text widget for code context instead of
label widget.

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: Scroll IDLE editor text by lines. Previously, the mouse wheel
and scrollbar slider moved text by a fixed number of pixels, resulting in
partial lines at the top of the editor box.  The change also applies to
the shell and grep output windows, but not to read-only text views.

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: Enable theme-specific color configuration for Code Context. Use
the Highlights tab to see the setting for built-in themes or add settings
to custom themes.

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: Display up to maxlines non-blank lines for Code Context. If
there is no current context, show a single blank line.

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE: Cleanup codecontext.py and its test.

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE’s code context now recognizes async as a block opener.

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: Update word/identifier definition from ascii to unicode. In
text and entry boxes, this affects selection by double-click, movement
left/right by control-left/right, and deletion left/right by
control-BACKSPACE/DEL.

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE: consistently color invalid string prefixes. A “u” string
prefix cannot be paired with either “r” or “f”. Consistently color as much
of the prefix, starting at the right, as is valid. Revise and extend
colorizer test.

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: Set @code{__file__} while running a startup file.  Like Python,
IDLE optionally runs one startup file in the Shell window before
presenting the first interactive input prompt.  For IDLE, @code{-s} runs a
file named in environmental variable  
@geindex IDLESTARTUP
@geindex variables de entorno; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}; @code{-r file} runs @code{file}.  Python sets
@code{__file__} to the startup file name before running the file and unsets
it before the first prompt.  IDLE now does the same when run normally,
without the @code{-n} option.

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: Simplify and rename StringTranslatePseudoMapping in pyparse.

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: Change @code{str} to @code{code} in pyparse.

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: Remove unused code in pyparse module.

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: Add tests for pyparse.

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: Using the system and place-dependent default encoding for
open() is a bad idea for IDLE’s system and location-independent files.

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: Add «encoding=utf-8» to open() in IDLE’s test_help_about. GUI
test test_file_buttons() only looks at initial ascii-only lines, but
failed on systems where open() defaults to “ascii” because readline()
internally reads and decodes far enough ahead to encounter a non-ascii
character in CREDITS.txt.

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: Add docstrings and tests for codecontext.

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: Update configdialog General tab docstring to add new widgets to
the widget list.
@end itemize

@node Tools/Demos<24>,C API<43>,IDLE<33>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id420}@anchor{1a56}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-35884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35884}: Add a benchmark script for timing various ways to access
variables: @code{Tools/scripts/var_access_benchmark.py}.

@item 
bpo-34989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34989}: python-gdb.py now handles errors on computing the line number
of a Python frame.

@item 
bpo-20260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20260}: Argument Clinic now has non-bitwise unsigned int converters.

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: python-gdb now catches @code{UnicodeDecodeError} exceptions when
calling @code{string()}.

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: python-gdb now catches ValueError on read_var(): when Python
has no debug symbols for example.

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} now recognizes only literal strings as
docstrings and translatable strings, and rejects bytes literals and
f-string expressions.

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: Fixed handling directories as arguments in the @code{pygettext}
script. Based on patch by Oleg Krasnikov.

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: Fix pystackv and pystack gdbinit macros.

@item 
bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427}: Remove the pyvenv script in favor of @code{python3 -m venv} in
order to lower confusion as to what Python interpreter a virtual
environment will be created for.

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: Add an @code{-n} flag for @code{Tools/scripts/pathfix.py} to disable
automatic backup creation (files with @code{~} suffix).

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: Fix pygettext not extracting docstrings for functions with type
annotated arguments. Patch by Toby Harradine.

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: Fix 2to3 for using with –add-suffix option but without
–output-dir option for relative path to files in current directory.
@end itemize

@node C API<43>,,Tools/Demos<24>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id421}@anchor{1a57}
@subsubsection C API



@itemize -

@item 
bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}: The @code{PyByteArray_Init()} and @code{PyByteArray_Fini()}
functions have been removed. They did nothing since Python 2.7.4 and
Python 3.2.0, were excluded from the limited API (stable ABI), and were
not documented.

@item 
bpo-33817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33817}: Fixed @ref{165f,,_PyBytes_Resize()} for empty bytes objects.

@item 
bpo-35322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35322}: Fix memory leak in @ref{c52,,PyUnicode_EncodeLocale()} and
@ref{1a58,,PyUnicode_EncodeFSDefault()} on error handling.

@item 
bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}: The following C macros have been converted to static inline
functions: @ref{612,,Py_INCREF()}, @ref{613,,Py_DECREF()}, @ref{af5,,Py_XINCREF()},
@ref{828,,Py_XDECREF()}, @code{PyObject_INIT()},
@code{PyObject_INIT_VAR()}.

@item 
bpo-35296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35296}: @code{make install} now also installs the internal API:
@code{Include/internal/*.h} header files.

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: Internal APIs surrounded by @code{#ifdef Py_BUILD_CORE} have been
moved from @code{Include/*.h} headers to new header files
@code{Include/internal/pycore_*.h}.

@item 
bpo-35259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35259}: Conditionally declare @ref{d9c,,Py_FinalizeEx()} (new in 3.6)
based on Py_LIMITED_API. Patch by Arthur Neufeld.

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: The @code{_PyObject_GC_TRACK()} and
@code{_PyObject_GC_UNTRACK()} macros have been removed from the public C
API.

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: Creation of a new @code{Include/cpython/} subdirectory.

@item 
bpo-34725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34725}: Adds _Py_SetProgramFullPath so embedders may override
sys.executable

@item 
bpo-34910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34910}: Ensure that @ref{1621,,PyObject_Print()} always returns @code{-1} on
error.  Patch by Zackery Spytz.

@item 
bpo-34523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34523}: Py_DecodeLocale() and Py_EncodeLocale() now use the UTF-8
encoding on Windows if Py_LegacyWindowsFSEncodingFlag is zero.

@item 
bpo-34193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34193}: Fix pluralization in TypeError messages in getargs.c and
typeobject.c: “1 argument” instead of “1 arguments” and “1 element”
instead of “1 elements”.

@item 
bpo-34127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34127}: Return grammatically correct error message based on argument
count. Patch by Karthikeyan Singaravelan.

@item 
bpo-23927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23927}: Fixed @ref{619,,SystemError} in
@ref{475,,PyArg_ParseTupleAndKeywords()} when the @code{w*} format unit is used
for optional parameter.

@item 
bpo-32455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32455}: Added @code{PyCompile_OpcodeStackEffectWithJump()}.

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: Py_Main() can again be called after Py_Initialize(), as in
Python 3.6.

@item 
bpo-32500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32500}: Fixed error messages for @ref{1a59,,PySequence_Size()},
@ref{1a5a,,PySequence_GetItem()}, @ref{1a5b,,PySequence_SetItem()} and
@ref{1a5c,,PySequence_DelItem()} called with a mapping and
@ref{1a5d,,PyMapping_Size()} called with a sequence.

@item 
bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818}: @code{PyExceptionClass_Name()} will now return @code{const char
*} instead of @code{char *}.

@item 
bpo-33042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33042}: Embedding applications may once again call
PySys_ResetWarnOptions, PySys_AddWarnOption, and PySys_AddXOption prior to
calling Py_Initialize.

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: Document that m_traverse for multi-phase initialized modules
can be called with m_state=NULL, and add a sanity check

@item 
bpo-30863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30863}: @ref{1a5e,,PyUnicode_AsWideChar()} and
@ref{953,,PyUnicode_AsWideCharString()} no longer cache the @code{wchar_t*}
representation of string objects.
@end itemize

@node Python 3 7 0 final,Python 3 7 0 release candidate 1,Python 3 8 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-final}@anchor{1a5f}
@subsection Python 3.7.0 final


`Release date: 2018-06-27'

@menu
* Library: Library<46>. 
* C API: C API<44>. 

@end menu

@node Library<46>,C API<44>,,Python 3 7 0 final
@anchor{whatsnew/changelog id422}@anchor{1a60}
@subsubsection Library



@itemize -

@item 
bpo-33851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33851}: Fix @ref{1a61,,ast.get_docstring()} for a node that lacks a
docstring.
@end itemize

@node C API<44>,,Library<46>,Python 3 7 0 final
@anchor{whatsnew/changelog id423}@anchor{1a62}
@subsubsection C API



@itemize -

@item 
bpo-33932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33932}: Calling Py_Initialize() twice does nothing, instead of failing
with a fatal error: restore the Python 3.6 behaviour.
@end itemize

@node Python 3 7 0 release candidate 1,Python 3 7 0 beta 5,Python 3 7 0 final,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-release-candidate-1}@anchor{1a63}
@subsection Python 3.7.0 release candidate 1


`Release date: 2018-06-12'

@menu
* Core and Builtins: Core and Builtins<46>. 
* Library: Library<47>. 
* Documentation: Documentation<45>. 
* Build: Build<45>. 
* Windows: Windows<44>. 
* IDLE: IDLE<34>. 

@end menu

@node Core and Builtins<46>,Library<47>,,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id424}@anchor{1a64}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33803}: Fix a crash in hamt.c caused by enabling GC tracking for an
object that hadn’t all of its fields set to NULL.

@item 
bpo-33706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33706}: Fix a crash in Python initialization when parsing the command
line options. Thanks Christoph Gohlke for the bug report and the fix!

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: Fixed reset of the SIGINT handler to SIG_DFL on interpreter
shutdown even when there was a custom handler set previously. Patch by
Philipp Kerling.

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: Fix signed/unsigned comparison warning in pyhash.c.
@end itemize

@node Library<47>,Documentation<45>,Core and Builtins<46>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id425}@anchor{1a65}
@subsubsection Library



@itemize -

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: Prevent site.main() exception if PYTHONSTARTUP is set. Patch by
Steve Weber.

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: Datetime instance d with non-None tzinfo, but with
d.tzinfo.utcoffset(d) returning None is now treated as naive by the
astimezone() method.

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: Avoid race condition with debug logging

@item 
bpo-33694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33694}: asyncio: Fix a race condition causing data loss on
pause_reading()/resume_reading() when using the ProactorEventLoop.

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: Correct test for @code{uuid_enc_be} availability in
@code{configure.ac}. Patch by Michael Felt.

@item 
bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}: Add asyncio.WindowsSelectorEventLoopPolicy and
asyncio.WindowsProactorEventLoopPolicy.

@item 
bpo-33778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33778}: Update @code{unicodedata}’s database to Unicode version 11.0.0.

@item 
bpo-33770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33770}: improve base64 exception message for encoded inputs of invalid
length

@item 
bpo-33769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33769}: asyncio/start_tls: Fix error message; cancel callbacks in case
of an unhandled error; mark SSLTransport as closed if it is aborted.

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: The concatenation (@code{+}) and repetition (@code{*}) sequence
operations now raise @ref{228,,TypeError} instead of @ref{619,,SystemError} when
performed on @ref{368,,mmap.mmap} objects.  Patch by Zackery Spytz.

@item 
bpo-33734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33734}: asyncio/ssl: Fix AttributeError, increase default handshake
timeout

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: Use a better regex when breaking usage into wrappable parts.
Avoids bogus assertion errors from custom metavar strings.

@item 
bpo-33582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33582}: Emit a deprecation warning for inspect.formatargspec
@end itemize

@node Documentation<45>,Build<45>,Library<47>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id426}@anchor{1a66}
@subsubsection Documentation



@itemize -

@item 
bpo-33409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33409}: Clarified the relationship between 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}’s
PYTHONCOERCECLOCALE and PEP 540’s PYTHONUTF8 mode.

@item 
bpo-33736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33736}: Improve the documentation of @ref{ba3,,asyncio.open_connection()},
@ref{ba4,,asyncio.start_server()} and their UNIX socket counterparts.

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: Clarify meaning of CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED
flags for ssl.SSLContext.verify_mode.
@end itemize

@node Build<45>,Windows<44>,Documentation<45>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id427}@anchor{1a67}
@subsubsection Build



@itemize -

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: Move @code{-Wstrict-prototypes} option to @code{CFLAGS_NODIST} from
@code{OPT}. This option emitted annoying warnings when building extension
modules written in C++.
@end itemize

@node Windows<44>,IDLE<34>,Build<45>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id428}@anchor{1a68}
@subsubsection Windows



@itemize -

@item 
bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720}: Reduces maximum marshal recursion depth on release builds.
@end itemize

@node IDLE<34>,,Windows<44>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id429}@anchor{1a69}
@subsubsection IDLE



@itemize -

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: On Windows, add API call saying that tk scales for DPI. On
Windows 8.1+ or 10, with DPI compatibility properties of the Python binary
unchanged, and a monitor resolution greater than 96 DPI, this should make
text and lines sharper.  It should otherwise have no effect.

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: Clicking on a context line moves that line to the top of the
editor window.

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE: Use read-only text widget for code context instead of
label widget.

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: Scroll IDLE editor text by lines. Previously, the mouse wheel
and scrollbar slider moved text by a fixed number of pixels, resulting in
partial lines at the top of the editor box.  The change also applies to
the shell and grep output windows, but not to read-only text views.

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: Enable theme-specific color configuration for Code Context. Use
the Highlights tab to see the setting for built-in themes or add settings
to custom themes.

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: Display up to maxlines non-blank lines for Code Context. If
there is no current context, show a single blank line.
@end itemize

@node Python 3 7 0 beta 5,Python 3 7 0 beta 4,Python 3 7 0 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-beta-5}@anchor{1a6a}
@subsection Python 3.7.0 beta 5


`Release date: 2018-05-30'

@menu
* Core and Builtins: Core and Builtins<47>. 
* Library: Library<48>. 
* Documentation: Documentation<46>. 
* Tests: Tests<44>. 
* Build: Build<46>. 
* macOS: macOS<36>. 
* IDLE: IDLE<35>. 

@end menu

@node Core and Builtins<47>,Library<48>,,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id430}@anchor{1a6b}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: Fixed a leak when the garbage collector fails to add an object
with the @code{__del__} method or referenced by it into the
@ref{122e,,gc.garbage} list. @ref{a20,,PyGC_Collect()} can now be called when an
exception is set and preserves it.

@item 
bpo-33509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33509}: Fix module_globals parameter of warnings.warn_explicit(): don’t
crash if module_globals is not a dict.

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: The new @code{os.posix_spawn} added in 3.7.0b1 was removed as we
are still working on what the API should look like.  Expect this in 3.8
instead.

@item 
bpo-33475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33475}: Fixed miscellaneous bugs in converting annotations to strings
and optimized parentheses in the string representation.

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: Fix a leak in set_symmetric_difference().

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: Fix unaligned accesses in siphash24(). Patch by Rolf Eike Beer.

@item 
bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911}: Due to unexpected compatibility issues discovered during
downstream beta testing, reverted bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}. @code{docstring} field is
removed from Module, ClassDef, FunctionDef, and AsyncFunctionDef ast nodes
which was added in 3.7a1.  Docstring expression is restored as a first
statement in their body. Based on patch by Inada Naoki.

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: Fix a crash in @code{ctypes.cast()} in case the type argument is a
ctypes structured data type. Patch by Eryk Sun and Oren Milman.
@end itemize

@node Library<48>,Documentation<46>,Core and Builtins<47>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id431}@anchor{1a6c}
@subsubsection Library



@itemize -

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: When cancelling the task due to a timeout,
@ref{6a0,,asyncio.wait_for()} will now wait until the cancellation is complete.

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: Fix gather to propagate cancellation of itself even with
return_exceptions.

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: Support protocol type switching in SSLTransport.set_protocol().

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: Pause the transport as early as possible to further reduce the
risk of data_received() being called before connection_made().

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: Fix a race condition in SSLProtocol.connection_made() of
asyncio.sslproto: start immediately the handshake instead of using
call_soon(). Previously, data_received() could be called before the
handshake started, causing the handshake to hang or fail.

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: Fixed bug where calling write_eof() on a
_SelectorSocketTransport after it’s already closed raises AttributeError.

@item 
bpo-32610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32610}: Make asyncio.all_tasks() return only pending tasks.

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: Avoid blocking on file IO in sendfile fallback code

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: Fix RuntimeError after closing loop that used run_in_executor

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: Fix Task.__repr__ crash with Cython’s bogus coroutines

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: Fix transport.set_protocol() to support switching between
asyncio.Protocol and asyncio.BufferedProtocol.  Fix loop.start_tls() to
work with asyncio.BufferedProtocols.

@item 
bpo-33652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33652}: Pickles of type variables and subscripted generics are now
future-proof and compatible with older Python versions.

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: Fixed @ref{c30,,uuid.uuid1()} on FreeBSD.

@item 
bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618}: Finalize and document preliminary and experimental TLS 1.3
support with OpenSSL 1.1.1

@item 
bpo-33623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33623}: Fix possible SIGSGV when asyncio.Future is created in __del__

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: Fixed a bug in the Python implementation of the JSON decoder
that prevented the cache of parsed strings from clearing after finishing
the decoding. Based on patch by c-fos.

@item 
bpo-33570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33570}: Change TLS 1.3 cipher suite settings for compatibility with
OpenSSL 1.1.1-pre6 and newer. OpenSSL 1.1.1 will have TLS 1.3 ciphers
enabled by default.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Do not simplify arguments to @code{typing.Union}. Now
@code{Union[Manager, Employee]} is not simplified to @code{Employee} at runtime.
Such simplification previously caused several bugs and limited
possibilities for introspection.

@item 
bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}: Add a new @code{block_on_close} class attribute to
@code{ForkingMixIn} and @code{ThreadingMixIn} classes of @ref{cd,,socketserver}.

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list should consider common TEMP
locations

@item 
bpo-33109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33109}: argparse subparsers are once again not required by default,
reverting the change in behavior introduced by bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510} in 3.7.0a2.

@item 
bpo-33536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33536}: dataclasses.make_dataclass now checks for invalid field names
and duplicate fields. Also, added a check for invalid field
specifications.

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: Prevent @code{uuid.get_node} from using a DUID instead of a MAC on
Windows. Patch by Zvi Effron

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: Fix race condition with @code{ReadTransport.resume_reading} in
Windows proactor event loop.

@item 
Fix failure in @code{typing.get_type_hints()} when ClassVar was provided as a
string forward reference.

@item 
bpo-33505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33505}: Optimize asyncio.ensure_future() by reordering if checks: 1.17x
faster.

@item 
bpo-33497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33497}: Add errors param to cgi.parse_multipart and make an encoding in
FieldStorage use the given errors (needed for Twisted).  Patch by Amber
Brown.

@item 
bpo-33495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33495}: Change dataclasses.Fields repr to use the repr of each of its
members, instead of str.  This makes it more clear what each field
actually represents.  This is especially true for the “type” member.

@item 
bpo-33453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33453}: Fix dataclasses to work if using literal string type
annotations or if using PEP 563 «Postponed Evaluation of Annotations».
Only specific string prefixes are detected for both ClassVar («ClassVar»
and «typing.ClassVar») and InitVar («InitVar» and «dataclasses.InitVar»).

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Minor fixes in typing module: add annotations to
@code{NamedTuple.__new__}, pass @code{*args} and @code{**kwds} in
@code{Generic.__new__}.  Original PRs by Paulius Šarka and Chad Dombrova.

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: Updated alias mapping with glibc 2.27 supported locales.

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: Fix trailing quotation marks getting deleted when looking up
byte/string literals on pydoc. Patch by Andrés Delfino.

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: The function @code{platform.linux_distribution} and
@code{platform.dist} now trigger a @code{DeprecationWarning} and have been
marked for removal in Python 3.8

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: Update error message when constructing invalid
inspect.Parameters Patch by Donghee Na.

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: Fix FD leak in @code{_SelectorSocketTransport}  Patch by Vlad
Starostin.

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: The urllib.robotparser’s @code{__str__} representation now
includes wildcard entries and the «Crawl-delay» and «Request-rate» fields.
Patch by Michael Lazar.

@item 
bpo-32257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32257}: The ssl module now contains OP_NO_RENEGOTIATION constant,
available with OpenSSL 1.1.0h or 1.1.1.

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: Support arrays >=2GiB in @ref{2b,,ctypes}.  Patch by Segev Finer.
@end itemize

@node Documentation<46>,Tests<44>,Library<48>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id432}@anchor{1a6d}
@subsubsection Documentation



@itemize -

@item 
bpo-23859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23859}: Document that @code{asyncio.wait()} does not cancel its futures on
timeout.

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: Document 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} changes to asyncio.

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: Update HMAC md5 default to a DeprecationWarning, bump removal
to 3.8.

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: Fix broken pypi link

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: Add missing documentation for @code{typing.AsyncContextManager}.
@end itemize

@node Tests<44>,Build<46>,Documentation<46>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id433}@anchor{1a6e}
@subsubsection Tests



@itemize -

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: Ignore test_posix_fallocate failures on BSD platforms that
might be due to running on ZFS.

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: Remove the _xxsubinterpreters module (meant for testing) and
associated helpers.  This module was originally added recently in 3.7b1.
@end itemize

@node Build<46>,macOS<36>,Tests<44>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id434}@anchor{1a6f}
@subsubsection Build



@itemize -

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: Ensures module definition files for the stable ABI on Windows
are correctly regenerated.

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: Enable CI builds on Visual Studio Team Services at
@indicateurl{https://python.visualstudio.com/cpython}

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: Add @code{-Wno-cast-function-type} for gcc 8 for silencing
warnings about function casts like casting to PyCFunction in method
definition lists.
@end itemize

@node macOS<36>,IDLE<35>,Build<46>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id435}@anchor{1a70}
@subsubsection macOS



@itemize -

@item 
bpo-13631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13631}: The .editrc file in user’s home directory is now processed
correctly during the readline initialization through editline emulation on
macOS.
@end itemize

@node IDLE<35>,,macOS<36>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id436}@anchor{1a71}
@subsubsection IDLE



@itemize -

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE: Cleanup codecontext.py and its test.

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE’s code context now recognizes async as a block opener.

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: Add docstrings and tests for codecontext.
@end itemize

@node Python 3 7 0 beta 4,Python 3 7 0 beta 3,Python 3 7 0 beta 5,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-beta-4}@anchor{1a72}
@subsection Python 3.7.0 beta 4


`Release date: 2018-05-02'

@menu
* Core and Builtins: Core and Builtins<48>. 
* Library: Library<49>. 
* Documentation: Documentation<47>. 
* Tests: Tests<45>. 
* Build: Build<47>. 
* Windows: Windows<45>. 
* macOS: macOS<37>. 
* IDLE: IDLE<36>. 
* Tools/Demos: Tools/Demos<25>. 

@end menu

@node Core and Builtins<48>,Library<49>,,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id437}@anchor{1a73}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33363}: Raise a SyntaxError for @code{async with} and @code{async for}
statements outside of async functions.

@item 
bpo-33128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33128}: Fix a bug that causes PathFinder to appear twice on
sys.meta_path. Patch by Pablo Galindo Salgado.

@item 
bpo-33312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33312}: Fixed clang ubsan (undefined behavior sanitizer) warnings in
dictobject.c by adjusting how the internal struct _dictkeysobject shared
keys structure is declared.

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: Fix potential memory leak in @code{normalizestring()}.

@item 
bpo-33205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33205}: Change dict growth function from
@code{round_up_to_power_2(used*2+hashtable_size/2)} to
@code{round_up_to_power_2(used*3)}.  Previously, dict is shrunk only when
@code{used == 0}. Now dict has more chance to be shrunk.

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: Improved error messages in “async with” when @code{__aenter__()}
or @code{__aexit__()} return non-awaitable object.

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: Fix @code{ma_version_tag} in dict implementation is uninitialized
when copying from key-sharing dict.
@end itemize

@node Library<49>,Documentation<47>,Core and Builtins<48>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id438}@anchor{1a74}
@subsubsection Library



@itemize -

@item 
bpo-33281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33281}: Fix ctypes.util.find_library regression on macOS.

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: Fixed crash in the get() method of the @ref{35,,dbm.ndbm} database
object when it is called with a single argument.

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: Fix multiprocessing regression on newer glibcs

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: Fix quoting of the @code{Comment} attribute of
@ref{1a4a,,http.cookies.SimpleCookie}.

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: Upgrade bundled version of pip to 10.0.1.

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: Fixed a crash in the @code{parser} module when converting an ST
object to a tree of tuples or lists with @code{line_info=False} and
@code{col_info=True}.

@item 
bpo-33266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33266}: lib2to3 now recognizes @code{rf'...'} strings.

@item 
bpo-11594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11594}: Ensure line-endings are respected when using lib2to3.

@item 
bpo-33254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33254}: Have @ref{351,,importlib.resources.contents()} and
@ref{1a4b,,importlib.abc.ResourceReader.contents()} return an @ref{1294,,iterable}
instead of an @ref{313,,iterator}.

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: Fix display of @code{<module>} call in the html produced by
@code{cgitb.html()}. Patch by Stéphane Blondon.

@item 
bpo-33185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33185}: Fixed regression when running pydoc with the @ref{187,,-m}
switch. (The regression was introduced in 3.7.0b3 by the resolution of
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}) This fix also changed pydoc to add @code{os.getcwd()} to
@ref{27e,,sys.path} when necessary, rather than adding @code{"."}.

@item 
bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}: Delete entries of @code{None} in @ref{684,,sys.path_importer_cache}
when @code{importlib.machinery.invalidate_caches()} is called.

@item 
bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}: Deprecate looking up non-Enum objects in Enum classes and Enum
members (will raise @ref{228,,TypeError} in 3.8+).

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} now raises @code{IndexError} for empty
sequences consistently even when called from subclasses without a
@code{getrandbits()} implementation.

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: Update difflib.mdiff() for 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.  Convert an uncaught
StopIteration in a generator into a return-statement.

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: End framing at the end of C implementation of
@ref{1a4c,,pickle.Pickler.dump()}.

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: Improved error handling and fixed a reference leak in
@ref{37d,,os.posix_spawn()}.

@item 
bpo-33175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33175}: In dataclasses, Field.__set_name__ now looks up the
__set_name__ special method on the class, not the instance, of the default
value.

@item 
bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}: Raise RuntimeError when @code{executor.submit} is called during
interpreter shutdown.

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: Fix output of cover files for @code{trace} module command-line
tool. Previously emitted cover files only when @code{--missing} option was
used. Patch by Michael Selik.
@end itemize

@node Documentation<47>,Tests<45>,Library<49>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id439}@anchor{1a75}
@subsubsection Documentation



@itemize -

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: Add Korean language switcher for @indicateurl{https://docs.python.org/3/}

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: Clarify that the @code{__path__} attribute on modules cannot be
just any value.

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: Modernize documentation for writing C extension types.

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: Deprecate @code{Py_UNICODE} usage in @code{c-api/arg} document.
@code{Py_UNICODE} related APIs are deprecated since Python 3.3, but it is
missed in the document.

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: Add a note about curses.addch and curses.addstr exception
behavior when writing outside a window, or pad.

@item 
bpo-32337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32337}: Update documentation related with @code{dict} order.
@end itemize

@node Tests<45>,Build<47>,Documentation<47>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id440}@anchor{1a76}
@subsubsection Tests



@itemize -

@item 
bpo-33358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33358}: Fix @code{test_embed.test_pre_initialization_sys_options()} when
the interpreter is built with @code{--enable-shared}.
@end itemize

@node Build<47>,Windows<45>,Tests<45>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id441}@anchor{1a77}
@subsubsection Build



@itemize -

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: Enable the verbose build for extension modules, when GNU make
is passed macros on the command line.

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: Update config.guess and config.sub files.

@item 
bpo-33377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33377}: Add new triplets for mips r6 and riscv variants (used in
extension suffixes).

@item 
bpo-32232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32232}: By default, modules configured in @code{Modules/Setup} are no
longer built with @code{-DPy_BUILD_CORE}. Instead, modules that specifically
need that preprocessor definition include it in their individual entries.

@item 
bpo-33182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33182}: The embedding tests can once again be built with clang 6.0
@end itemize

@node Windows<45>,macOS<37>,Build<47>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id442}@anchor{1a78}
@subsubsection Windows



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update Windows installer to use OpenSSL 1.1.0h.
@end itemize

@node macOS<37>,IDLE<36>,Windows<45>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id443}@anchor{1a79}
@subsubsection macOS



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update macOS installer build to use OpenSSL 1.1.0h.
@end itemize

@node IDLE<36>,Tools/Demos<25>,macOS<37>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id444}@anchor{1a7a}
@subsubsection IDLE



@itemize -

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: Update word/identifier definition from ascii to unicode. In
text and entry boxes, this affects selection by double-click, movement
left/right by control-left/right, and deletion left/right by
control-BACKSPACE/DEL.

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE: consistently color invalid string prefixes. A “u” string
prefix cannot be paired with either “r” or “f”. Consistently color as much
of the prefix, starting at the right, as is valid. Revise and extend
colorizer test.
@end itemize

@node Tools/Demos<25>,,IDLE<36>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id445}@anchor{1a7b}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} now recognizes only literal strings as
docstrings and translatable strings, and rejects bytes literals and
f-string expressions.

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: Fixed handling directories as arguments in the @code{pygettext}
script. Based on patch by Oleg Krasnikov.

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: Fix pystackv and pystack gdbinit macros.

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: Fix 2to3 for using with –add-suffix option but without
–output-dir option for relative path to files in current directory.
@end itemize

@node Python 3 7 0 beta 3,Python 3 7 0 beta 2,Python 3 7 0 beta 4,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-beta-3}@anchor{1a7c}
@subsection Python 3.7.0 beta 3


`Release date: 2018-03-29'

@menu
* Security: Security<33>. 
* Core and Builtins: Core and Builtins<49>. 
* Library: Library<50>. 
* Documentation: Documentation<48>. 
* Tests: Tests<46>. 
* Build: Build<48>. 
* Windows: Windows<46>. 
* macOS: macOS<38>. 
* IDLE: IDLE<37>. 
* Tools/Demos: Tools/Demos<26>. 
* C API: C API<45>. 

@end menu

@node Security<33>,Core and Builtins<49>,,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id446}@anchor{1a7d}
@subsubsection Security



@itemize -

@item 
bpo-33136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33136}: Harden ssl module against LibreSSL 
@geindex Common Vulnerabilities and Exposures; CVE 2018-8970
CVE 2018-8970@footnote{https://www.cve.org/CVERecord?id=CVE-2018-8970}.
X509_VERIFY_PARAM_set1_host() is called with an explicit namelen. A new
test ensures that NULL bytes are not allowed.

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Minimal fix to prevent buffer overrun in os.symlink on Windows

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: Regexes in difflib and poplib were vulnerable to catastrophic
backtracking. These regexes formed potential DOS vectors (REDOS). They
have been refactored. This resolves 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} and 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}.
Patch by Jamie Davis.
@end itemize

@node Core and Builtins<49>,Library<50>,Security<33>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id447}@anchor{1a7e}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}: When using the -m switch, sys.path[0] is now explicitly
expanded as the `starting' working directory, rather than being left as
the empty path (which allows imports from the current working directory at
the time of the import)

@item 
bpo-33018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33018}: Improve consistency of errors raised by @code{issubclass()} when
called with a non-class and an abstract base class as the first and second
arguments, respectively. Patch by Josh Bronson.

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: Fixed jumping when the function contains an @code{async for} loop.

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: Fixed jumping out of «with» block by setting f_lineno.

@item 
bpo-33005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33005}: Fix a crash on fork when using a custom memory allocator (ex:
using PYTHONMALLOC env var). _PyGILState_Reinit() and
_PyInterpreterState_Enable() now use the default RAW memory allocator to
allocate a new interpreters mutex on fork.

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: Prevent jumps from “return” and “exception” trace events.

@item 
bpo-32836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32836}: Don’t use temporary variables in cases of list/dict/set
comprehensions
@end itemize

@node Library<50>,Documentation<48>,Core and Builtins<49>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id448}@anchor{1a7f}
@subsubsection Library



@itemize -

@item 
bpo-33141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33141}: Have Field objects pass through __set_name__ to their default
values, if they have their own __set_name__.

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: Allow ttk.Treeview.insert to insert iid that has a false
boolean value. Note iid=0 and iid=False would be same. Patch by Garvit
Khatri.

@item 
bpo-32873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32873}: Treat type variables and special typing forms as immutable by
copy and pickle.  This fixes several minor issues and inconsistencies, and
improves backwards compatibility with Python 3.6.

@item 
bpo-33134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33134}: When computing dataclass’s __hash__, use the lookup table to
contain the function which returns the __hash__ value.  This is an
improvement over looking up a string, and then testing that string to see
what to do.

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: The ssl module now compiles with LibreSSL 2.7.1.

@item 
bpo-32505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32505}: Raise TypeError if a member variable of a dataclass is of type
Field, but doesn’t have a type annotation.

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: Fix the failure on OSX caused by the tests relying on
sem_getvalue

@item 
bpo-33116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33116}: Add “Field” to dataclasses.__all__.

@item 
bpo-32896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32896}: Fix an error where subclassing a dataclass with a field that
uses a default_factory would generate an incorrect class.

@item 
bpo-33100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33100}: Dataclasses: If a field has a default value that’s a
MemberDescriptorType, then it’s from that field being in __slots__, not an
actual default value.

@item 
bpo-32953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32953}: If a non-dataclass inherits from a frozen dataclass, allow
attributes to be added to the derived class.  Only attributes from the
frozen dataclass cannot be assigned to.  Require all dataclasses in a
hierarchy to be either all frozen or all non-frozen.

@item 
bpo-33061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33061}: Add missing @code{NoReturn} to @code{__all__} in typing.py

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: Fix the size handling in multiprocessing.Queue when a pickling
error occurs.

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3 now properly supports trailing commas after @code{*args}
and @code{**kwargs} in function signatures.

@item 
bpo-33056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33056}: FIX properly close leaking fds in
concurrent.futures.ProcessPoolExecutor.

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: Release the GIL during fstat() calls, avoiding hang of all
threads when calling mmap.mmap(), os.urandom(), and random.seed().  Patch
by Nir Soffer.

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: Avoid failing in multiprocessing.Process if the standard
streams are closed or None at exit.

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: Skip sending/receiving data after SSL transport closing.

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: Fix a regression in @ref{80,,ipaddress} that result of
@code{hosts()} is empty when the network is constructed by a tuple
containing an integer mask and only 1 bit left for addresses.

@item 
bpo-32999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32999}: Fix C implementation of @code{ABC.__subclasscheck__(cls,
subclass)} crashed when @code{subclass} is not a type object.

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: Fix inspect.signature() for single-parameter partialmethods.

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: Expose several missing constants in zlib and fix corresponding
documentation.

@item 
bpo-32056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32056}: Improved exceptions raised for invalid number of channels and
sample width when read an audio file in modules @code{aifc}, @ref{113,,wave}
and @code{sunau}.

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: Fix wrong redirection of a low descriptor (0 or 1) to stderr in
subprocess if another low descriptor is closed.

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: In @ref{f0,,tkinter}, @code{after_cancel(None)} now raises a
@ref{360,,ValueError} instead of canceling the first scheduled function.
Patch by Cheryl Sabella.

@item 
bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}: http.server now exposes a ThreadedHTTPServer class and uses it
when the module is run with @code{-m} to cope with web browsers pre-opening
sockets.

@item 
bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}: @ref{39e,,sqlite3.Connection} now exposes a
@ref{c02,,backup} method, if the underlying SQLite
library is at version 3.6.11 or higher.  Patch by Lele Gaifax.
@end itemize

@node Documentation<48>,Tests<46>,Library<50>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id449}@anchor{1a80}
@subsubsection Documentation



@itemize -

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: Document PyBuffer_ToContiguous().

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: Modify documentation for the @code{islice()} recipe to consume
initial values up to the start index.

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: Update @ref{12f,,zipapp} documentation to describe how to make
standalone applications.

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: Documentation changes for ipaddress.  Patch by Jon Foster and
Berker Peksag.

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: Update documentation to clarify that @code{WindowsRegistryFinder}
implements @code{MetaPathFinder}. (Patch by Himanshu Lakhara)
@end itemize

@node Tests<46>,Build<48>,Documentation<48>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id450}@anchor{1a81}
@subsubsection Tests



@itemize -

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: Avoid regrtest compatibility issue with namespace packages.

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: Fix failing @code{test_asyncio} on macOS 10.12.2+ due to transport
of @code{KqueueSelector} loop was not being closed.

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: Add test_bdb.py.
@end itemize

@node Build<48>,Windows<46>,Tests<46>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id451}@anchor{1a82}
@subsubsection Build



@itemize -

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: Upgrade pip to 9.0.3 and setuptools to v39.0.1.
@end itemize

@node Windows<46>,macOS<38>,Build<48>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id452}@anchor{1a83}
@subsubsection Windows



@itemize -

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: Fix potential use of uninitialized memory in
nt._getfinalpathname

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: Fix a memory leak in os.chdir() on Windows if the current
directory is set to a UNC path.
@end itemize

@node macOS<38>,IDLE<37>,Windows<46>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id453}@anchor{1a84}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: Build and link with private copy of Tcl/Tk 8.6 for the macOS
10.6+ installer. The 10.9+ installer variant already does this.  This
means that the Python 3.7 provided by the python.org macOS installers no
longer need or use any external versions of Tcl/Tk, either system-provided
or user-installed, such as ActiveTcl.
@end itemize

@node IDLE<37>,Tools/Demos<26>,macOS<38>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id454}@anchor{1a85}
@subsubsection IDLE



@itemize -

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: Set @code{__file__} while running a startup file.  Like Python,
IDLE optionally runs one startup file in the Shell window before
presenting the first interactive input prompt.  For IDLE, @code{-s} runs a
file named in environmental variable  
@geindex IDLESTARTUP
@geindex variables de entorno; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}; @code{-r file} runs @code{file}.  Python sets
@code{__file__} to the startup file name before running the file and unsets
it before the first prompt.  IDLE now does the same when run normally,
without the @code{-n} option.

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: Simplify and rename StringTranslatePseudoMapping in pyparse.
@end itemize

@node Tools/Demos<26>,C API<45>,IDLE<37>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id455}@anchor{1a86}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: Add an @code{-n} flag for @code{Tools/scripts/pathfix.py} to disable
automatic backup creation (files with @code{~} suffix).
@end itemize

@node C API<45>,,Tools/Demos<26>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id456}@anchor{1a87}
@subsubsection C API



@itemize -

@item 
bpo-33042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33042}: Embedding applications may once again call
PySys_ResetWarnOptions, PySys_AddWarnOption, and PySys_AddXOption prior to
calling Py_Initialize.

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: Document that m_traverse for multi-phase initialized modules
can be called with m_state=NULL, and add a sanity check
@end itemize

@node Python 3 7 0 beta 2,Python 3 7 0 beta 1,Python 3 7 0 beta 3,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-beta-2}@anchor{1a88}
@subsection Python 3.7.0 beta 2


`Release date: 2018-02-27'

@menu
* Security: Security<34>. 
* Core and Builtins: Core and Builtins<50>. 
* Library: Library<51>. 
* Documentation: Documentation<49>. 
* Tests: Tests<47>. 
* Build: Build<49>. 
* Windows: Windows<47>. 
* macOS: macOS<39>. 
* IDLE: IDLE<38>. 
* Tools/Demos: Tools/Demos<27>. 

@end menu

@node Security<34>,Core and Builtins<50>,,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id457}@anchor{1a89}
@subsubsection Security



@itemize -

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: The ssl module now allows users to perform their own IDN
en/decoding when using SNI.
@end itemize

@node Core and Builtins<50>,Library<51>,Security<34>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id458}@anchor{1a8a}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: Update Valgrind suppression list to account for the rename of
@code{Py_ADDRESS_IN_RANG} to @code{address_in_range}.

@item 
bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356}: Remove the new API added in bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356} (gc.ensure_disabled()
context manager).

@item 
bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}: For namespace packages, ensure that both @code{__file__} and
@code{__spec__.origin} are set to None.

@item 
bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}: Make sure @code{__spec__.loader} matches @code{__loader__} for
namespace packages.

@item 
bpo-32711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32711}: Fix the warning messages for Python/ast_unparse.c. Patch by
Stéphane Wirtel

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: Fix possible crashing in builtin Unicode decoders caused by
write out-of-bound errors when using customized decode error handlers.
@end itemize

@node Library<51>,Documentation<49>,Core and Builtins<50>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id459}@anchor{1a8b}
@subsubsection Library



@itemize -

@item 
bpo-32960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32960}: For dataclasses, disallow inheriting frozen from non-frozen
classes, and also disallow inheriting non-frozen from frozen classes. This
restriction will be relaxed at a future date.

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: Fixed tarfile.itn handling of out-of-bounds float values. Patch
by Joffrey Fuhrer.

@item 
bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951}: Direct instantiation of SSLSocket and SSLObject objects is now
prohibited. The constructors were never documented, tested, or designed as
public constructors. Users were suppose to use ssl.wrap_socket() or
SSLContext.

@item 
bpo-32929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32929}: Remove the tri-state parameter «hash», and add the boolean
«unsafe_hash». If unsafe_hash is True, add a __hash__ function, but if a
__hash__ exists, raise TypeError.  If unsafe_hash is False, add a __hash__
based on the values of eq= and frozen=.  The unsafe_hash=False behavior is
the same as the old hash=None behavior.  unsafe_hash=False is the default,
just as hash=None used to be.

@item 
bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}: Add OP_ENABLE_MIDDLEBOX_COMPAT and test workaround for TLSv1.3
for future compatibility with OpenSSL 1.1.1.

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: The ssl module now detects missing NPN support in LibreSSL.

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open() now encodes filename with the filesystem encoding
rather than default encoding.

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: In @code{os.dup2}, don’t check every call whether the @code{dup3}
syscall exists or not.

@item 
bpo-32556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32556}: nt._getfinalpathname, nt._getvolumepathname and
nt._getdiskusage now correctly convert from bytes.

@item 
bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}: Emit a @ref{1da,,DeprecationWarning} when using or importing an ABC
directly from @ref{1e,,collections} rather than from @ref{1f,,collections.abc}.

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: Rewrite confusing message from setup.py upload from «No dist
file created in earlier command» to the more helpful «Must create and
upload files in one command».

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: Make sure sys.argv remains as a list when running trace.

@item 
bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}: @code{_abc} module is added.  It is a speedup module with C
implementations for various functions and methods in @code{abc}.  Creating an
ABC subclass and calling @code{isinstance} or @code{issubclass} with an ABC
subclass are up to 1.5x faster. In addition, this makes Python start-up up
to 10% faster. Note that the new implementation hides internal registry
and caches, previously accessible via private attributes
@code{_abc_registry}, @code{_abc_cache}, and @code{_abc_negative_cache}.  There are
three debugging helper methods that can be used instead
@code{_dump_registry}, @code{_abc_registry_clear}, and @code{_abc_caches_clear}.

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: Fixed @code{asyncio.Condition} issue which silently ignored
cancellation after notifying and cancelling a conditional lock. Patch by
Bar Harel.

@item 
bpo-32819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32819}: ssl.match_hostname() has been simplified and no longer depends
on re and ipaddress module for wildcard and IP addresses. Error reporting
for invalid wildcards has been improved.

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: Remove
TCP_FASTOPEN,TCP_KEEPCNT,TCP_KEEPIDLE,TCP_KEEPINTVL flags on older version
Windows during run-time.

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: Fixed refleaks of @code{__init__()} methods in various modules.
(Contributed by Oren Milman)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: Fixed guessing quote and delimiter in csv.Sniffer.sniff() when
only the last field is quoted.  Patch by Jake Davis.

@item 
bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}: collections.ChainMap() preserves the order of the underlying
mappings.

@item 
bpo-32775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32775}: @ref{1a4d,,fnmatch.translate()} no longer produces patterns which
contain set operations. Sets starting with “[” or containing “–”, “&&”,
“~~” or “||” will be interpreted differently in regular expressions in
future versions. Currently they emit warnings. fnmatch.translate() now
avoids producing patterns containing such sets by accident.

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: Implement native fast sendfile for Windows proactor event loop.

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: Fix a rare but potential pre-exec child process deadlock in
subprocess on POSIX systems when marking file descriptors inheritable on
exec in the child process.  This bug appears to have been introduced in
3.4.

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: The ctypes module used to depend on indirect linking for
dlopen. The shared extension is now explicitly linked against libdl on
platforms with dl.

@item 
bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}: Implement @code{asyncio.TimerHandle.when()} method.

@item 
bpo-32691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32691}: Use mod_spec.parent when running modules with pdb

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: Fixed @code{asyncio.Lock()} safety issue which allowed acquiring
and locking the same lock multiple times, without it being free. Patch by
Bar Harel.

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: Do not include name field in SMTP envelope from address. Patch
by Stéphane Wirtel

@item 
bpo-31453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31453}: Add TLSVersion constants and SSLContext.maximum_version /
minimum_version attributes. The new API wraps OpenSSL 1.1
@indicateurl{https://web.archive.org/web/20180309043602/https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html}
feature.

@item 
bpo-24334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24334}: Internal implementation details of ssl module were cleaned up.
The SSLSocket has one less layer of indirection. Owner and session
information are now handled by the SSLSocket and SSLObject constructor.
Channel binding implementation has been simplified.

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: Fix the error handling in Aifc_read.initfp() when the SSND
chunk is not found. Patch by Zackery Spytz.

@item 
bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}: Add Ttk spinbox widget to @ref{f9,,tkinter.ttk}.  Patch by Alan D
Moore.

@item 
bpo-32221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32221}: Various functions returning tuple containing IPv6 addresses now
omit @code{%scope} part since the same information is already encoded in
`scopeid' tuple item. Especially this speeds up @code{socket.recvfrom()}
when it receives multicast packet since useless resolving of network
interface name is omitted.

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: The TarFile class now recurses directories in a reproducible
way.

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: The ZipFile class now recurses directories in a reproducible
way.
@end itemize

@node Documentation<49>,Tests<47>,Library<51>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id460}@anchor{1a8c}
@subsubsection Documentation



@itemize -

@item 
bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}: The ssl module function ssl.wrap_socket() has been
de-emphasized and deprecated in favor of the more secure and efficient
SSLContext.wrap_socket() method.

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: Clarify docs for -O and -OO.  Patch by Terry Reedy.

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: Add documentation for the contextvars module (PEP 567).

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: Update link to w3c doc for xml default namespaces.

@item 
bpo-11015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11015}: Update @ref{e4,,test.support} documentation.

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: Document @code{__getattr__()} behavior when property @code{get()}
method raises @ref{441,,AttributeError}.

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: Modify RE examples in documentation to use raw strings to
prevent @ref{1da,,DeprecationWarning} and add text to REGEX HOWTO to highlight
the deprecation.

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: Improve docstrings for @code{pathlib.PurePath} subclasses.
@end itemize

@node Tests<47>,Build<49>,Documentation<49>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id461}@anchor{1a8d}
@subsubsection Tests



@itemize -

@item 
bpo-31809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31809}: Add tests to verify connection with secp ECDH curves.
@end itemize

@node Build<49>,Windows<47>,Tests<47>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id462}@anchor{1a8e}
@subsubsection Build



@itemize -

@item 
bpo-32898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32898}: Fix the python debug build when using COUNT_ALLOCS.
@end itemize

@node Windows<47>,macOS<39>,Build<49>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id463}@anchor{1a8f}
@subsubsection Windows



@itemize -

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: Update Tcl and Tk versions to 8.6.8

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: Fixed WindowsConsoleIO.write() for writing empty data.

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: Ensures activate.bat can handle Unicode contents.

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: Improves handling of denormalized executable path when
launching Python.

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: Use the correct encoding for ipconfig output in the uuid
module. Patch by Segev Finer.

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: Fix @ref{9b4,,os.readlink()} on Windows, which was mistakenly
treating the @code{PrintNameOffset} field of the reparse data buffer as a
number of characters instead of bytes. Patch by Craig Holmquist and SSE4.
@end itemize

@node macOS<39>,IDLE<38>,Windows<47>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id464}@anchor{1a90}
@subsubsection macOS



@itemize -

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: Update macOS 10.9+ installer to Tcl/Tk 8.6.8.
@end itemize

@node IDLE<38>,Tools/Demos<27>,macOS<39>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id465}@anchor{1a91}
@subsubsection IDLE



@itemize -

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: Change @code{str} to @code{code} in pyparse.

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: Remove unused code in pyparse module.

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: Add tests for pyparse.

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: Using the system and place-dependent default encoding for
open() is a bad idea for IDLE’s system and location-independent files.

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: Add «encoding=utf-8» to open() in IDLE’s test_help_about. GUI
test test_file_buttons() only looks at initial ascii-only lines, but
failed on systems where open() defaults to “ascii” because readline()
internally reads and decodes far enough ahead to encounter a non-ascii
character in CREDITS.txt.

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: Update configdialog General tab docstring to add new widgets to
the widget list.
@end itemize

@node Tools/Demos<27>,,IDLE<38>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id466}@anchor{1a92}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: Fix pygettext not extracting docstrings for functions with type
annotated arguments. Patch by Toby Harradine.
@end itemize

@node Python 3 7 0 beta 1,Python 3 7 0 alpha 4,Python 3 7 0 beta 2,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-beta-1}@anchor{1a93}
@subsection Python 3.7.0 beta 1


`Release date: 2018-01-30'

@menu
* Core and Builtins: Core and Builtins<51>. 
* Library: Library<52>. 
* Documentation: Documentation<50>. 
* Tests: Tests<48>. 
* Build: Build<50>. 
* Windows: Windows<48>. 
* macOS: macOS<40>. 
* C API: C API<46>. 

@end menu

@node Core and Builtins<51>,Library<52>,,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id467}@anchor{1a94}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-32703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32703}: Fix coroutine’s ResourceWarning when there’s an active error
set when it’s being finalized.

@item 
bpo-32650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32650}: Pdb and other debuggers dependent on bdb.py will correctly step
over (next command) native coroutines. Patch by Pablo Galindo.

@item 
bpo-28685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28685}: Optimize list.sort() and sorted() by using type specialized
comparisons when possible.

@item 
bpo-32685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32685}: Improve suggestion when the Python 2 form of print statement is
either present on the same line as the header of a compound statement or
else terminated by a semi-colon instead of a newline. Patch by Nitish
Chandra.

@item 
bpo-32697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32697}: Python now explicitly preserves the definition order of
keyword-only parameters.  It’s always preserved their order, but this
behavior was never guaranteed before; this behavior is now guaranteed and
tested.

@item 
bpo-32690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32690}: The locals() dictionary now displays in the lexical order that
variables were defined.  Previously, the order was reversed.

@item 
bpo-32677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32677}: Add @code{.isascii()} method to @code{str}, @code{bytes} and
@code{bytearray}. It can be used to test that string contains only ASCII
characters.

@item 
bpo-32670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32670}: Enforce 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} for all code. This means that manually
raising a StopIteration exception from a generator is prohibited for all
code, regardless of whether “from __future__ import generator_stop” was
used or not.

@item 
bpo-32591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32591}: Added built-in support for tracking the origin of coroutine
objects; see sys.set_coroutine_origin_tracking_depth and
CoroutineType.cr_origin. This replaces the asyncio debug mode’s use of
coroutine wrapping for native coroutine objects.

@item 
bpo-31368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31368}: Expose preadv and pwritev system calls in the os module. Patch
by Pablo Galindo

@item 
bpo-32544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32544}: @code{hasattr(obj, name)} and @code{getattr(obj, name, default)} are
about 4 times faster than before when @code{name} is not found and @code{obj}
doesn’t override @code{__getattr__} or @code{__getattribute__}.

@item 
bpo-26163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26163}: Improved frozenset() hash to create more distinct hash values
when faced with datasets containing many similar values.

@item 
bpo-32550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32550}: Remove the STORE_ANNOTATION bytecode.

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: Expose posix_spawn as a low level API in the os module.
(removed before 3.7.0rc1)

@item 
bpo-24340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24340}: Fixed estimation of the code stack size.

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: Implement 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} Context Variables.

@item 
bpo-18533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18533}: @code{repr()} on a dict containing its own @code{values()} or
@code{items()} no longer raises @code{RecursionError}; OrderedDict similarly.
Instead, use @code{...}, as for other recursive structures.  Patch by Ben
North.

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: Py_Initialize() now creates the GIL. The GIL is no longer
created «on demand» to fix a race condition when PyGILState_Ensure() is
called in a non-Python thread.

@item 
bpo-32028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32028}: Leading whitespace is now correctly ignored when generating
suggestions for converting Py2 print statements to Py3 builtin print
function calls. Patch by Sanyam Khurana.

@item 
bpo-31179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31179}: Make dict.copy() up to 5.5 times faster.

@item 
bpo-31113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31113}: Get rid of recursion in the compiler for normal control flow.
@end itemize

@node Library<52>,Documentation<50>,Core and Builtins<51>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id468}@anchor{1a95}
@subsubsection Library



@itemize -

@item 
bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}: Deprecate exposing the contents of collections.abc in the
regular collections module.

@item 
bpo-31429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31429}: The default cipher suite selection of the ssl module now uses a
blacklist approach rather than a hard-coded whitelist. Python no longer
re-enables ciphers that have been blocked by OpenSSL security update.
Default cipher suite selection can be configured on compile time.

@item 
bpo-30306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30306}: contextlib.contextmanager now releases the arguments passed to
the underlying generator as soon as the context manager is entered.
Previously it would keep them alive for as long as the context manager was
alive, even when not being used as a function decorator. Patch by Martin
Teichmann.

@item 
bpo-21417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21417}: Added support for setting the compression level for
zipfile.ZipFile.

@item 
bpo-32251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32251}: Implement asyncio.BufferedProtocol (provisional API).

@item 
bpo-32513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32513}: In dataclasses, allow easier overriding of dunder methods
without specifying decorator parameters.

@item 
bpo-32660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32660}: @ref{e1,,termios} makes available @code{FIONREAD}, @code{FIONCLEX},
@code{FIOCLEX}, @code{FIOASYNC} and @code{FIONBIO} also under Solaris/derivatives.

@item 
bpo-27931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27931}: Fix email address header parsing error when the username is an
empty quoted string. Patch by Xiang Zhang.

@item 
bpo-32659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32659}: Under Solaris and derivatives, @ref{14fd,,os.stat_result} provides
a st_fstype attribute.

@item 
bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}: Implement Server.start_serving(), Server.serve_forever(), and
Server.is_serving() methods.  Add “start_serving” keyword parameter to
loop.create_server() and loop.create_unix_server().

@item 
bpo-32391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32391}: Implement @ref{b97,,asyncio.StreamWriter.wait_closed()} and
@ref{b98,,asyncio.StreamWriter.is_closing()} methods

@item 
bpo-32643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32643}: Make Task._step, Task._wakeup and Future._schedule_callbacks
methods private.

@item 
bpo-32630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32630}: Refactor decimal module to use contextvars to store decimal
context.

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: Add @code{asyncio.AbstractEventLoop.sendfile()} method.

@item 
bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304}: distutils” upload command no longer corrupts tar files ending
with a CR byte, and no longer tries to convert CR to CRLF in any of the
upload text fields.

@item 
bpo-32502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32502}: uuid.uuid1 no longer raises an exception if a 64-bit hardware
address is encountered.

@item 
bpo-32596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32596}: @code{concurrent.futures} imports @code{ThreadPoolExecutor} and
@code{ProcessPoolExecutor} lazily (using 
@geindex Python Enhancement Proposals; PEP 562
PEP 562@footnote{https://peps.python.org/pep-0562/}). It makes @code{import
asyncio} about 15% faster because asyncio uses only
@code{ThreadPoolExecutor} by default.

@item 
bpo-31801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31801}: Add @code{_ignore_} to @code{Enum} so temporary variables can be used
during class construction without being turned into members.

@item 
bpo-32576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32576}: Use queue.SimpleQueue() in places where it can be invoked from
a weakref callback.

@item 
bpo-32574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32574}: Fix memory leak in asyncio.Queue, when the queue has limited
size and it is full, the cancellation of queue.put() can cause a memory
leak. Patch by: José Melero.

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: The nis module is now compatible with new libnsl and headers
location.

@item 
bpo-32467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32467}: collections.abc.ValuesView now inherits from
collections.abc.Collection.

@item 
bpo-32473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32473}: Improve ABCMeta._dump_registry() output readability

@item 
bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}: New argument @code{capture_output} for subprocess.run

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: glibc has removed Sun RPC. Use replacement libtirpc headers and
library in nis module.

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: UUID module fixes build for FreeBSD/OpenBSD

@item 
bpo-32503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32503}: Pickling with protocol 4 no longer creates too small frames.

@item 
bpo-29237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29237}: Create enum for pstats sorting options

@item 
bpo-32454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32454}: Add close(fd) function to the socket module.

@item 
bpo-25942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25942}: The subprocess module is now more graceful when handling a
Ctrl-C KeyboardInterrupt during subprocess.call, subprocess.run, or a
Popen context manager.  It now waits a short amount of time for the child
(presumed to have also gotten the SIGINT) to exit, before continuing the
KeyboardInterrupt exception handling.  This still includes a SIGKILL in
the call() and run() APIs, but at least the child had a chance first.

@item 
bpo-32433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32433}: The hmac module now has hmac.digest(), which provides an
optimized HMAC digest.

@item 
bpo-28134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28134}: Sockets now auto-detect family, type and protocol from file
descriptor by default.

@item 
bpo-32404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32404}: Fix bug where @ref{593,,datetime.datetime.fromtimestamp()} did not
call __new__ in @ref{32f,,datetime.datetime} subclasses.

@item 
bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403}: Improved speed of @ref{330,,datetime.date} and
@ref{32f,,datetime.datetime} alternate constructors.

@item 
bpo-32228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32228}: Ensure that @code{truncate()} preserves the file position (as
reported by @code{tell()}) after writes longer than the buffer size.

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: Implement @code{loop.sock_sendfile} for asyncio event loop.

@item 
bpo-22908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22908}: Added seek and tell to the ZipExtFile class. This only works if
the file object used to open the zipfile is seekable.

@item 
bpo-32373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32373}: Add socket.getblocking() method.

@item 
bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}: Add @ref{7b,,importlib.resources} and
@ref{b88,,importlib.abc.ResourceReader} as the unified API for reading
resources contained within packages.  Loaders wishing to support resource
reading must implement the @code{get_resource_reader()} method.  File-based
and zipimport-based loaders both implement these APIs.
@ref{c6f,,importlib.abc.ResourceLoader} is deprecated in favor of these new
APIs.

@item 
bpo-32320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32320}: collections.namedtuple() now supports default values.

@item 
bpo-29302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29302}: Add contextlib.AsyncExitStack. Patch by Alexander Mohr and Ilya
Kulakov.

@item 
bpo-31961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31961}: `Removed in Python 3.7.0b2.' The `args' argument of
subprocess.Popen can now be a @ref{3f0,,path-like object}. If `args' is given
as a sequence, it’s first element can now be a @ref{3f0,,path-like object} as
well.

@item 
bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}: The @ref{c86,,locale.localeconv()} function now sets temporarily the
@code{LC_CTYPE} locale to the @code{LC_NUMERIC} locale to decode
@code{decimal_point} and @code{thousands_sep} byte strings if they are non-ASCII
or longer than 1 byte, and the @code{LC_NUMERIC} locale is different than the
@code{LC_CTYPE} locale. This temporary change affects other threads. Same
change for the @ref{6c2,,str.format()} method when formatting a number
(@ref{1f0,,int}, @ref{153,,float}, @ref{153,,float} and subclasses) with the
@code{n} type (ex: @code{'@{:n@}'.format(1234)}).

@item 
bpo-31853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31853}: Use super().method instead of socket.method in SSLSocket.  They
were there most likely for legacy reasons.

@item 
bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}: The ssl module now uses OpenSSL’s X509_VERIFY_PARAM_set1_host()
and X509_VERIFY_PARAM_set1_ip() API to verify hostname and IP addresses.
Subject common name fallback can be disabled with
SSLContext.hostname_checks_common_name.

@item 
bpo-14976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14976}: Add a queue.SimpleQueue class, an unbounded FIFO queue with a
reentrant C implementation of put().
@end itemize

@node Documentation<50>,Tests<48>,Library<52>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id469}@anchor{1a96}
@subsubsection Documentation



@itemize -

@item 
bpo-32724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32724}: Add references to some commands in the documentation of Pdb.
Patch by Stéphane Wirtel

@item 
bpo-32649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32649}: Complete the C API documentation, profiling and tracing part
with the newly added per-opcode events.

@item 
bpo-17799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17799}: Explain real behaviour of sys.settrace and sys.setprofile and
their C-API counterparts regarding which type of events are received in
each function. Patch by Pablo Galindo Salgado.
@end itemize

@node Tests<48>,Build<50>,Documentation<50>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id470}@anchor{1a97}
@subsubsection Tests



@itemize -

@item 
bpo-32721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32721}: Fix test_hashlib to not fail if the _md5 module is not built.

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: Add test cases for IDNA 2003 and 2008 host names. IDNA 2003
internationalized host names are working since bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399} has landed. IDNA
2008 are still broken.

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: Add a new «_xxsubinterpreters» extension module that exposes
the existing subinterpreter C-API and a new cross-interpreter data sharing
mechanism. The module is primarily intended for more thorough testing of
the existing subinterpreter support. Note that the _xxsubinterpreters
module has been removed in 3.7.0rc1.

@item 
bpo-32602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32602}: Add test certs and test for ECDSA cert and EC/RSA dual mode.

@item 
bpo-32549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32549}: On Travis CI, Python now Compiles and uses a local copy of
OpenSSL 1.1.0g for testing.
@end itemize

@node Build<50>,Windows<48>,Tests<48>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id471}@anchor{1a98}
@subsubsection Build



@itemize -

@item 
bpo-32635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32635}: Fix segfault of the crypt module when libxcrypt is provided
instead of libcrypt at the system.

@item 
bpo-32598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32598}: Use autoconf to detect OpenSSL libs, headers and supported
features. The ax_check_openssl M4 macro uses pkg-config to locate OpenSSL
and falls back to manual search.

@item 
bpo-32593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32593}: Drop support of FreeBSD 9 and older.

@item 
bpo-29708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29708}: If the 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} environment variable is set,
@ref{b3,,py_compile} will always create hash-based @code{.pyc} files.
@end itemize

@node Windows<48>,macOS<40>,Build<50>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id472}@anchor{1a99}
@subsubsection Windows



@itemize -

@item 
bpo-32588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32588}: Create standalone _distutils_findvs module and add missing
_queue module to installer.

@item 
bpo-29911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29911}: Ensure separate Modify and Uninstall buttons are displayed.

@item 
bpo-32507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32507}: Use app-local UCRT install rather than the proper update for
old versions of Windows.
@end itemize

@node macOS<40>,C API<46>,Windows<48>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id473}@anchor{1a9a}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: Provide an additional, more modern macOS installer variant that
supports macOS 10.9+ systems in 64-bit mode only.  Upgrade the supplied
third-party libraries to OpenSSL 1.1.0g and to SQLite 3.22.0.  The 10.9+
installer now links with and supplies its own copy of Tcl/Tk 8.6.

@item 
bpo-28440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28440}: No longer add /Library/Python/3.x/site-packages to sys.path for
macOS framework builds to avoid future conflicts.
@end itemize

@node C API<46>,,macOS<40>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id474}@anchor{1a9b}
@subsubsection C API



@itemize -

@item 
bpo-32681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32681}: Fix uninitialized variable “res” in the C implementation of
os.dup2. Patch by Stéphane Wirtel

@item 
bpo-10381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10381}: Add C API access to the @code{datetime.timezone} constructor and
@code{datetime.timezone.UTC} singleton.
@end itemize

@node Python 3 7 0 alpha 4,Python 3 7 0 alpha 3,Python 3 7 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-alpha-4}@anchor{1a9c}
@subsection Python 3.7.0 alpha 4


`Release date: 2018-01-08'

@menu
* Core and Builtins: Core and Builtins<52>. 
* Library: Library<53>. 
* Documentation: Documentation<51>. 
* Tests: Tests<49>. 
* Windows: Windows<49>. 
* Tools/Demos: Tools/Demos<28>. 
* C API: C API<47>. 

@end menu

@node Core and Builtins<52>,Library<53>,,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id475}@anchor{1a9d}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-31975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31975}: The default warning filter list now starts with a
«default::DeprecationWarning:__main__» entry, so deprecation warnings are
once again shown by default in single-file scripts and at the interactive
prompt.

@item 
bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}: @code{__class_getitem__} is now an automatic class method.

@item 
bpo-32399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32399}: Add AIX uuid library support for RFC4122 using uuid_create() in
libc.a

@item 
bpo-32390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32390}: Fix the compilation failure on AIX after the f_fsid field has
been added to the object returned by os.statvfs() (bpo-32143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32143}). Original
patch by Michael Felt.

@item 
bpo-32379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32379}: Make MRO computation faster when a class inherits from a single
base.

@item 
bpo-32259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32259}: The error message of a TypeError raised when unpack
non-iterable is now more specific.

@item 
bpo-27169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27169}: The @code{__debug__} constant is now optimized out at compile
time. This fixes also bpo-22091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22091}.

@item 
bpo-32329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32329}: The @ref{1a9e,,-R} option now turns on hash randomization when
the 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} environment variable is set to @code{0}.
Previously, the option was ignored. Moreover,
@code{sys.flags.hash_randomization} is now properly set to 0 when hash
randomization is turned off by @code{PYTHONHASHSEED=0}.

@item 
bpo-30416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30416}: The optimizer is now protected from spending much time doing
complex calculations and consuming much memory for creating large
constants in constant folding. Increased limits for constants that can be
produced in constant folding.

@item 
bpo-32282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32282}: Fix an unnecessary ifdef in the include of VersionHelpers.h in
socketmodule on Windows.

@item 
bpo-30579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30579}: Implement TracebackType.__new__ to allow Python-level creation
of traceback objects, and make TracebackType.tb_next mutable.

@item 
bpo-32260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32260}: Don’t byte swap the input keys to the SipHash algorithm on
big-endian platforms. This should ensure siphash gives consistent results
across platforms.

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: Improve the error message logic for object.__new__ and
object.__init__. Patch by Sanyam Khurana.

@item 
bpo-20361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20361}: @code{-b} and @code{-bb} now inject @code{'default::BytesWarning'} and
@code{error::BytesWarning} entries into @code{sys.warnoptions}, ensuring that
they take precedence over any other warning filters configured via the
@code{-W} option or the @code{PYTHONWARNINGS} environment variable.

@item 
bpo-32230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32230}: @code{-X dev} now injects a @code{'default'} entry into
sys.warnoptions, ensuring that it behaves identically to actually passing
@code{-Wdefault} at the command line.

@item 
bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}: Add a new UTF-8 mode: implementation of the 
@geindex Python Enhancement Proposals; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/}.

@item 
bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}: 
@geindex Python Enhancement Proposals; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}: Add support for @code{__mro_entries__} and
@code{__class_getitem__}. Implemented by Ivan Levkivskyi.

@item 
bpo-32225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32225}: 
@geindex Python Enhancement Proposals; PEP 562
PEP 562@footnote{https://peps.python.org/pep-0562/}: Add support for module @code{__getattr__} and
@code{__dir__}. Implemented by Ivan Levkivskyi.

@item 
bpo-31901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31901}: The @code{atexit} module now has its callback stored per
interpreter.

@item 
bpo-31650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31650}: Implement 
@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} (Deterministic pycs). Python now supports
invalidating bytecode cache files bashed on a source content hash rather
than source last-modified time.

@item 
bpo-29469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29469}: Move constant folding from bytecode layer to AST layer.
Original patch by Eugene Toder.
@end itemize

@node Library<53>,Documentation<51>,Core and Builtins<52>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id476}@anchor{1a9f}
@subsubsection Library



@itemize -

@item 
bpo-32506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32506}: Now that dict is defined as keeping insertion order, drop
OrderedDict and just use plain dict.

@item 
bpo-32279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32279}: Add params to dataclasses.make_dataclasses(): init, repr, eq,
order, hash, and frozen.  Pass them through to dataclass().

@item 
bpo-32278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32278}: Make type information optional on dataclasses.make_dataclass().
If omitted, the string “typing.Any” is used.

@item 
bpo-32499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32499}: Add dataclasses.is_dataclass(obj), which returns True if obj is
a dataclass or an instance of one.

@item 
bpo-32468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32468}: Improve frame repr() to mention filename, code name and current
line number.

@item 
bpo-23749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23749}: asyncio: Implement loop.start_tls()

@item 
bpo-32441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32441}: Return the new file descriptor (i.e., the second argument) from
@code{os.dup2}. Previously, @code{None} was always returned.

@item 
bpo-32422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32422}: @code{functools.lru_cache} uses less memory (3 words for each
cached key) and takes about 1/3 time for cyclic GC.

@item 
bpo-31721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31721}: Prevent Python crash from happening when Future._log_traceback
is set to True manually.  Now it can only be set to False, or a ValueError
is raised.

@item 
bpo-32415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32415}: asyncio: Add Task.get_loop() and Future.get_loop()

@item 
bpo-26133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26133}: Don’t unsubscribe signals in asyncio UNIX event loop on
interpreter shutdown.

@item 
bpo-32363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32363}: Make asyncio.Task.set_exception() and set_result() raise
NotImplementedError. Task._step() and Future.__await__() raise proper
exceptions when they are in an invalid state, instead of raising an
AssertionError.

@item 
bpo-32357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32357}: Optimize asyncio.iscoroutine() and loop.create_task() for
non-native coroutines (e.g. async/await compiled with Cython).
“loop.create_task(python_coroutine)” used to be 20% faster than
“loop.create_task(cython_coroutine)”.  Now, the latter is as fast.

@item 
bpo-32356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32356}: asyncio.transport.resume_reading() and pause_reading() are now
idempotent. New transport.is_reading() method is added.

@item 
bpo-32355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32355}: Optimize asyncio.gather(); now up to 15% faster.

@item 
bpo-32351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32351}: Use fastpath in asyncio.sleep if delay<0 (2x boost)

@item 
bpo-32348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32348}: Optimize asyncio.Future schedule/add/remove callback.  The
optimization shows 3-6% performance improvements of async/await code.

@item 
bpo-32331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32331}: Fix socket.settimeout() and socket.setblocking() to keep
socket.type as is. Fix socket.socket() constructor to reset any bit flags
applied to socket’s type.  This change only affects OSes that have
SOCK_NONBLOCK and/or SOCK_CLOEXEC.

@item 
bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}: Add @ref{b88,,importlib.abc.ResourceReader} as an ABC for loaders
to provide a unified API for reading resources contained within packages.
Also add @ref{7b,,importlib.resources} as the port of
@code{importlib_resources}.

@item 
bpo-32311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32311}: Implement asyncio.create_task(coro) shortcut

@item 
bpo-32327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32327}: Convert asyncio functions that were documented as coroutines to
coroutines. Affected functions: loop.sock_sendall, loop.sock_recv,
loop.sock_accept, loop.getaddrinfo, loop.getnameinfo.

@item 
bpo-32323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32323}: @ref{dc6,,urllib.parse.urlsplit()} does not convert zone-id (scope)
to lower case for scoped IPv6 addresses in hostnames now.

@item 
bpo-32302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32302}: Fix bdist_wininst of distutils for CRT v142: it binary
compatible with CRT v140.

@item 
bpo-29711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29711}: Fix @code{stop_serving} in asyncio proactor loop kill all
listening servers

@item 
bpo-32308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32308}: @ref{3f2,,re.sub()} now replaces empty matches adjacent to a
previous non-empty match.

@item 
bpo-29970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29970}: Abort asyncio SSLProtocol connection if handshake not complete
within 10 seconds.

@item 
bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}: Implement asyncio.run().

@item 
bpo-17852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17852}: Revert incorrect fix based on misunderstanding of
_Py_PyAtExit() semantics.

@item 
bpo-32296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32296}: Implement asyncio._get_running_loop() and get_event_loop() in
C. This makes them 4x faster.

@item 
bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250}: Implement @code{asyncio.current_task()} and
@code{asyncio.all_tasks()}. Add helpers intended to be used by alternative
task implementations: @code{asyncio._register_task}, @code{asyncio._enter_task},
@code{asyncio._leave_task} and @code{asyncio._unregister_task}. Deprecate
@code{asyncio.Task.current_task()} and @code{asyncio.Task.all_tasks()}.

@item 
bpo-32255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32255}: A single empty field is now always quoted when written into a
CSV file. This allows to distinguish an empty row from a row consisting of
a single empty field. Patch by Licht Takeuchi.

@item 
bpo-32277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32277}: Raise @code{NotImplementedError} instead of @code{SystemError} on
platforms where @code{chmod(..., follow_symlinks=False)} is not supported.
Patch by Anthony Sottile.

@item 
bpo-30050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30050}: New argument warn_on_full_buffer to signal.set_wakeup_fd lets
you control whether Python prints a warning on stderr when the wakeup fd
buffer overflows.

@item 
bpo-29137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29137}: The @code{fpectl} library has been removed. It was never enabled
by default, never worked correctly on x86-64, and it changed the Python
ABI in ways that caused unexpected breakage of C extensions.

@item 
bpo-32273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32273}: Move asyncio.test_utils to test.test_asyncio.

@item 
bpo-32272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32272}: Remove asyncio.async() function.

@item 
bpo-32269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32269}: Add asyncio.get_running_loop() function.

@item 
bpo-32265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32265}: All class and static methods of builtin types now are correctly
classified by inspect.classify_class_attrs() and grouped in pydoc output.
Added types.ClassMethodDescriptorType for unbound class methods of builtin
types.

@item 
bpo-32253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32253}: Deprecate @code{yield from lock}, @code{await lock}, @code{with (yield
from lock)} and @code{with await lock} for asyncio synchronization
primitives.

@item 
bpo-22589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22589}: Changed MIME type of .bmp from “image/x-ms-bmp” to “image/bmp”

@item 
bpo-32193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32193}: Convert asyncio to use `async/await' syntax. Old styled @code{yield
from} is still supported too.

@item 
bpo-32206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32206}: Add support to run modules with pdb

@item 
bpo-32227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32227}: @code{functools.singledispatch} now supports registering
implementations using type annotations.

@item 
bpo-15873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15873}: Added new alternate constructors
@ref{6b7,,datetime.datetime.fromisoformat()},
@ref{6b6,,datetime.time.fromisoformat()} and
@ref{6b5,,datetime.date.fromisoformat()} as the inverse operation of each
classes’s respective @code{isoformat} methods.

@item 
bpo-32199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32199}: The getnode() ip getter now uses “ip link” instead of “ip link
list”.

@item 
bpo-32143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32143}: os.statvfs() includes the f_fsid field from statvfs(2)

@item 
bpo-26439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26439}: Fix ctypes.util.find_library() for AIX by implementing
ctypes._aix.find_library() Patch by: Michael Felt

@item 
bpo-31993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31993}: The pickler now uses less memory when serializing large bytes
and str objects into a file.  Pickles created with protocol 4 will require
less memory for unpickling large bytes and str objects.

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: Ensure TCP_NODELAY is set on Linux. Tests by Victor Stinner.

@item 
bpo-31778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31778}: ast.literal_eval() is now more strict. Addition and subtraction
of arbitrary numbers no longer allowed.

@item 
bpo-31802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31802}: Importing native path module (@code{posixpath}, @code{ntpath}) now
works even if the @code{os} module still is not imported.

@item 
bpo-30241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30241}: Add contextlib.AbstractAsyncContextManager. Patch by Jelle
Zijlstra.

@item 
bpo-31699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31699}: Fix deadlocks in
@ref{163,,concurrent.futures.ProcessPoolExecutor} when task arguments or
results cause pickling or unpickling errors. This should make sure that
calls to the @code{ProcessPoolExecutor} API always eventually return.

@item 
bpo-15216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15216}: @code{TextIOWrapper.reconfigure()} supports changing `encoding',
`errors', and `newline'.
@end itemize

@node Documentation<51>,Tests<49>,Library<53>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id477}@anchor{1aa0}
@subsubsection Documentation



@itemize -

@item 
bpo-32418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32418}: Add get_loop() method to Server and AbstractServer classes.
@end itemize

@node Tests<49>,Windows<49>,Documentation<51>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id478}@anchor{1aa1}
@subsubsection Tests



@itemize -

@item 
bpo-32252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32252}: Fix faulthandler_suppress_crash_report() used to prevent core
dump files when testing crashes. getrlimit() returns zero on success.

@item 
bpo-32002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32002}: Adjust C locale coercion testing for the empty locale and POSIX
locale cases to more readily adjust to platform dependent behaviour.
@end itemize

@node Windows<49>,Tools/Demos<28>,Tests<49>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id479}@anchor{1aa2}
@subsubsection Windows



@itemize -

@item 
bpo-19764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19764}: Implement support for @code{subprocess.Popen(close_fds=True)} on
Windows. Patch by Segev Finer.
@end itemize

@node Tools/Demos<28>,C API<47>,Windows<49>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id480}@anchor{1aa3}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-24960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24960}: 2to3 and lib2to3 can now read pickled grammar files using
pkgutil.get_data() rather than probing the filesystem. This lets 2to3 and
lib2to3 work when run from a zipfile.
@end itemize

@node C API<47>,,Tools/Demos<28>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id481}@anchor{1aa4}
@subsubsection C API



@itemize -

@item 
bpo-32030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32030}: Py_Initialize() doesn’t reset the memory allocators to default
if the @code{PYTHONMALLOC} environment variable is not set.

@item 
bpo-29084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29084}: Undocumented C API for OrderedDict has been excluded from the
limited C API. It was added by mistake and actually never worked in the
limited C API.

@item 
bpo-32264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32264}: Moved the pygetopt.h header into internal/, since it has no
public APIs.

@item 
bpo-32241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32241}: @code{Py_SetProgramName()} and @code{Py_SetPythonHome()}
now take the @code{const wchar *} arguments instead of @code{wchar *}.
@end itemize

@node Python 3 7 0 alpha 3,Python 3 7 0 alpha 2,Python 3 7 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-alpha-3}@anchor{1aa5}
@subsection Python 3.7.0 alpha 3


`Release date: 2017-12-05'

@menu
* Core and Builtins: Core and Builtins<53>. 
* Library: Library<54>. 
* Documentation: Documentation<52>. 
* Tests: Tests<50>. 
* Build: Build<51>. 
* Windows: Windows<50>. 
* macOS: macOS<41>. 
* IDLE: IDLE<39>. 
* Tools/Demos: Tools/Demos<29>. 
* C API: C API<48>. 

@end menu

@node Core and Builtins<53>,Library<54>,,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id482}@anchor{1aa6}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-32176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32176}: co_flags.CO_NOFREE is now always set correctly by the code
object constructor based on freevars and cellvars, rather than needing to
be set correctly by the caller. This ensures it will be cleared
automatically when additional cell references are injected into a modified
code object and function.

@item 
bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}: Yield expressions are now deprecated in comprehensions and
generator expressions. They are still permitted in the definition of the
outermost iterable, as that is evaluated directly in the enclosing scope.

@item 
bpo-32137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32137}: The repr of deeply nested dict now raises a RecursionError
instead of crashing due to a stack overflow.

@item 
bpo-32096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32096}: Revert memory allocator changes in the C API: move structures
back from _PyRuntime to Objects/obmalloc.c. The memory allocators are once
again initialized statically, and so PyMem_RawMalloc() and
Py_DecodeLocale() can be called before _PyRuntime_Initialize().

@item 
bpo-32043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32043}: Add a new «developer mode»: new «-X dev» command line option to
enable debug checks at runtime.

@item 
bpo-32023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32023}: SyntaxError is now correctly raised when a generator expression
without parenthesis is used instead of an inheritance list in a class
definition. The duplication of the parentheses can be omitted only on
calls.

@item 
bpo-32012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32012}: SyntaxError is now correctly raised when a generator expression
without parenthesis is passed as an argument, but followed by a trailing
comma. A generator expression always needs to be directly inside a set of
parentheses and cannot have a comma on either side.

@item 
bpo-28180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28180}: A new internal @code{_Py_SetLocaleFromEnv(category)} helper
function has been added in order to improve the consistency of behaviour
across different @code{libc} implementations (e.g. Android doesn’t support
setting the locale from the environment by default).

@item 
bpo-31949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31949}: Fixed several issues in printing tracebacks
(PyTraceBack_Print()). Setting sys.tracebacklimit to 0 or less now
suppresses printing tracebacks. Setting sys.tracebacklimit to None now
causes using the default limit. Setting sys.tracebacklimit to an integer
larger than LONG_MAX now means using the limit LONG_MAX rather than the
default limit. Fixed integer overflows in the case of more than @code{2**31}
traceback items on Windows. Fixed output errors handling.

@item 
bpo-30696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30696}: Fix the interactive interpreter looping endlessly when no
memory.

@item 
bpo-20047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20047}: Bytearray methods partition() and rpartition() now accept only
bytes-like objects as separator, as documented.  In particular they now
raise TypeError rather of returning a bogus result when an integer is
passed as a separator.

@item 
bpo-21720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21720}: BytesWarning no longer emitted when the `fromlist' argument of
@code{__import__()} or the @code{__all__} attribute of the module contain bytes
instances.

@item 
bpo-31845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31845}: Environment variables are once more read correctly at
interpreter startup.

@item 
bpo-28936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28936}: Ensure that lexically first syntax error involving a parameter
and @code{global} or @code{nonlocal} is detected first at a given scope. Patch
by Ivan Levkivskyi.

@item 
bpo-31825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31825}: Fixed OverflowError in the “unicode-escape” codec and in
codecs.escape_decode() when decode an escaped non-ascii byte.

@item 
bpo-31618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31618}: The per-frame tracing logic added in 3.7a1 has been altered so
that @code{frame->f_lineno} is updated before either @code{"line"} or
@code{"opcode"} events are emitted. Previously, opcode events were emitted
first, and therefore would occasionally see stale line numbers on the
frame. The behavior of this feature has changed slightly as a result: when
both @code{f_trace_lines} and @code{f_trace_opcodes} are enabled, line events
now occur first.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: Print the full context/cause chain of exceptions on interpreter
exit, even if an exception in the chain is unhashable or compares equal to
later ones. Patch by Zane Bitter.

@item 
bpo-31786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31786}: Fix timeout rounding in the select module to round correctly
negative timeouts between -1.0 and 0.0. The functions now block waiting
for events as expected. Previously, the call was incorrectly non-blocking.
Patch by Pablo Galindo.

@item 
bpo-31781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31781}: Prevent crashes when calling methods of an uninitialized
@code{zipimport.zipimporter} object. Patch by Oren Milman.

@item 
bpo-30399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30399}: Standard repr() of BaseException with a single argument no
longer contains redundant trailing comma.

@item 
bpo-31626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31626}: Fixed a bug in debug memory allocator.  There was a write to
freed memory after shrinking a memory block.

@item 
bpo-30817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30817}: @code{PyErr_PrintEx()} clears now the ignored exception that may
be raised by @code{_PySys_SetObjectId()}, for example when no memory.
@end itemize

@node Library<54>,Documentation<52>,Core and Builtins<53>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id483}@anchor{1aa7}
@subsubsection Library



@itemize -

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Two minor fixes for @code{typing} module: allow shallow copying
instances of generic classes, improve interaction of @code{__init_subclass__}
with generics. Original PRs by Ivan Levkivskyi.

@item 
bpo-32214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32214}: PEP 557, Data Classes. Provides a decorator which adds
boilerplate methods to classes which use type annotations so specify
fields.

@item 
bpo-27240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27240}: The header folding algorithm for the new email policies has
been rewritten, which also fixes bpo-30788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30788}, bpo-31831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31831}, and bpo-32182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32182}.  In
particular, RFC2231 folding is now done correctly.

@item 
bpo-32186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32186}: io.FileIO.readall() and io.FileIO.read() now release the GIL
when getting the file size. Fixed hang of all threads with inaccessible
NFS server. Patch by Nir Soffer.

@item 
bpo-32101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32101}: Add @ref{1aa8,,sys.flags.dev_mode} flag

@item 
bpo-32154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32154}: The @code{asyncio.windows_utils.socketpair()} function has been
removed: use directly @ref{c7d,,socket.socketpair()} which is available on all
platforms since Python 3.5 (before, it wasn’t available on Windows).
@code{asyncio.windows_utils.socketpair()} was just an alias to
@code{socket.socketpair} on Python 3.5 and newer.

@item 
bpo-32089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32089}: warnings: In development (-X dev) and debug mode (pydebug
build), use the «default» action for ResourceWarning, rather than the
«always» action, in the default warnings filters.

@item 
bpo-32107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32107}: @code{uuid.getnode()} now preferentially returns universally
administered MAC addresses if available, over locally administered MAC
addresses.  This makes a better guarantee for global uniqueness of UUIDs
returned from @code{uuid.uuid1()}.  If only locally administered MAC
addresses are available, the first such one found is returned.

@item 
bpo-23033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23033}: Wildcard is now supported in hostname when it is one and only
character in the left most segment of hostname in second argument of
@code{ssl.match_hostname()}.  Patch by Mandeep Singh.

@item 
bpo-12239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12239}: Make @code{msilib.SummaryInformation.GetProperty()} return
@code{None} when the value of property is @code{VT_EMPTY}.  Initial patch by
Mark Mc Mahon.

@item 
bpo-28334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28334}: Use @ref{aa6,,os.path.expanduser()} to find the @code{~/.netrc} file in
@ref{18ca,,netrc.netrc}.  If it does not exist, @ref{f46,,FileNotFoundError} is
raised.  Patch by Dimitri Merejkowsky.

@item 
bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}: Made @code{tracemalloc.Traceback} behave more like the traceback
module, sorting the frames from oldest to most recent.
@code{Traceback.format()} now accepts negative `limit', truncating the result
to the @code{abs(limit)} oldest frames. To get the old behaviour, one can use
the new `most_recent_first' argument to @code{Traceback.format()}. (Patch by
Jesse Bakker.)

@item 
bpo-31325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31325}: Fix wrong usage of @ref{32d,,collections.namedtuple()} in the
@ref{1aa9,,RobotFileParser.parse()}
method. Initial patch by Robin Wellner.

@item 
bpo-12382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12382}: @code{msilib.OpenDatabase()} now raises a better exception
message when it couldn’t open or create an MSI file.  Initial patch by
William Tisäter.

@item 
bpo-19610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19610}: @code{setup()} now warns about invalid types for some fields. The
@code{distutils.dist.Distribution} class now warns when @code{classifiers},
@code{keywords} and @code{platforms} fields are not specified as a list or a
string.

@item 
bpo-32071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32071}: Added the @code{-k} command-line option to @code{python -m unittest}
to run only tests that match the given pattern(s).

@item 
bpo-10049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10049}: Added `nullcontext' no-op context manager to contextlib. This
provides a simpler and faster alternative to ExitStack() when handling
optional context managers.

@item 
bpo-28684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28684}: The new test.support.skip_unless_bind_unix_socket() decorator
is used here to skip asyncio tests that fail because the platform lacks a
functional bind() function for unix domain sockets (as it is the case for
non root users on the recent Android versions that run now SELinux in
enforcing mode).

@item 
bpo-32110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32110}: @code{codecs.StreamReader.read(n)} now returns not more than `n'
characters/bytes for non-negative `n'. This makes it compatible with
@code{read()} methods of other file-like objects.

@item 
bpo-27535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27535}: The warnings module doesn’t leak memory anymore in the hidden
warnings registry for the «ignore» action of warnings filters.
warn_explicit() function doesn’t add the warning key to the registry
anymore for the «ignore» action.

@item 
bpo-32088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32088}: warnings:  When Python is build is debug mode (@code{Py_DEBUG}),
@ref{1da,,DeprecationWarning}, @ref{95f,,PendingDeprecationWarning} and
@ref{59f,,ImportWarning} warnings are now displayed by default.

@item 
bpo-1647489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1647489}: Fixed searching regular expression patterns that could match
an empty string. Non-empty string can now be correctly found after
matching an empty string.

@item 
bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054}: Added support of splitting on a pattern that could match an
empty string.

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: Fixed issues with binary plists: Fixed saving bytearrays.
Identical objects will be saved only once. Equal references will be load
as identical objects. Added support for saving and loading recursive data
structures.

@item 
bpo-32069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32069}: Drop legacy SSL transport from asyncio, ssl.MemoryBIO is always
used anyway.

@item 
bpo-32066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32066}: asyncio: Support pathlib.Path in create_unix_connection; sock
arg should be optional

@item 
bpo-32046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32046}: Updates 2to3 to convert from operator.isCallable(obj) to
callable(obj). Patch by Donghee Na.

@item 
bpo-32018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32018}: inspect.signature should follow 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, if the parameter has
an annotation and a default value. Patch by Donghee Na.

@item 
bpo-32025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32025}: Add time.thread_time() and time.thread_time_ns()

@item 
bpo-32037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32037}: Integers that fit in a signed 32-bit integer will be now
pickled with protocol 0 using the INT opcode.  This will decrease the size
of a pickle, speed up pickling and unpickling, and make these integers be
unpickled as int instances in Python 2.

@item 
bpo-32034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32034}: Make asyncio.IncompleteReadError and LimitOverrunError
pickleable.

@item 
bpo-32015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32015}: Fixed the looping of asyncio in the case of reconnection the
socket during waiting async read/write from/to the socket.

@item 
bpo-32011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32011}: Restored support of loading marshal files with the TYPE_INT64
code. These files can be produced in Python 2.7.

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: Enhance add_reader/writer check that socket is not used by some
transport. Before, only cases when add_reader/writer were called with an
int FD were supported.  Now the check is implemented correctly for all
file-like objects.

@item 
bpo-31976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31976}: Fix race condition when flushing a file is slow, which can
cause a segfault if closing the file from another thread.

@item 
bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}: Formally deprecated aifc.openfp, sunau.openfp, and wave.openfp.
Since change 7bc817d5ba917528e8bd07ec461c635291e7b06a in 1993, openfp in
each of the three modules had been pointing to that module’s open function
as a matter of backwards compatibility, though it had been both untested
and undocumented.

@item 
bpo-21862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21862}: cProfile command line now accepts @code{-m module_name} as an
alternative to script path. Patch by Sanyam Khurana.

@item 
bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}: Reduce performance overhead of asyncio debug mode.

@item 
bpo-31843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31843}: `database' argument of sqlite3.connect() now accepts a
@ref{3f0,,path-like object}, instead of just a string.

@item 
bpo-31945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31945}: Add Configurable `blocksize' to @code{HTTPConnection} and
@code{HTTPSConnection} for improved upload throughput.  Patch by Nir Soffer.

@item 
bpo-31943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31943}: Add a @code{cancelled()} method to @ref{1aaa,,asyncio.Handle}.  Patch
by Marat Sharafutdinov.

@item 
bpo-9678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9678}: Fixed determining the MAC address in the uuid module: Using
ifconfig on NetBSD and OpenBSD. Using arp on Linux, FreeBSD, NetBSD and
OpenBSD. Based on patch by Takayuki Shimizukawa.

@item 
bpo-30057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30057}: Fix potential missed signal in signal.signal().

@item 
bpo-31933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31933}: Fix Blake2 params leaf_size and node_offset on big endian
platforms. Patch by Jack O’Connor.

@item 
bpo-21423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21423}: Add an initializer argument to @{Process,Thread@}PoolExecutor

@item 
bpo-31927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31927}: Fixed compilation of the socket module on NetBSD 8.  Fixed
assertion failure or reading arbitrary data when parse a AF_BLUETOOTH
address on NetBSD and DragonFly BSD.

@item 
bpo-27666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27666}: Fixed stack corruption in curses.box() and curses.ungetmouse()
when the size of types chtype or mmask_t is less than the size of C long.
curses.box() now accepts characters as arguments.  Based on patch by Steve
Fink.

@item 
bpo-31917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31917}: Add 3 new clock identifiers: @ref{c16,,time.CLOCK_BOOTTIME},
@ref{c17,,time.CLOCK_PROF} and @ref{c18,,time.CLOCK_UPTIME}.

@item 
bpo-31897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31897}: plistlib now catches more errors when read binary plists and
raises InvalidFileException instead of unexpected exceptions.

@item 
bpo-25720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25720}: Fix the method for checking pad state of curses WINDOW. Patch
by Masayuki Yamamoto.

@item 
bpo-31893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31893}: Fixed the layout of the kqueue_event structure on OpenBSD and
NetBSD. Fixed the comparison of the kqueue_event objects.

@item 
bpo-31891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31891}: Fixed building the curses module on NetBSD.

@item 
bpo-31884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31884}: added required constants to subprocess module for setting
priority on windows

@item 
bpo-28281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28281}: Remove year (1-9999) limits on the Calendar.weekday() function.
Patch by Mark Gollahon.

@item 
bpo-31702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31702}: crypt.mksalt() now allows to specify the number of rounds for
SHA-256 and SHA-512 hashing.

@item 
bpo-30639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30639}: @ref{1aab,,inspect.getfile()} no longer computes the repr of unknown
objects to display in an error message, to protect against badly behaved
custom reprs.

@item 
bpo-30768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30768}: Fix the pthread+semaphore implementation of
PyThread_acquire_lock_timed() when called with timeout > 0 and
intr_flag=0: recompute the timeout if sem_timedwait() is interrupted by a
signal (EINTR). See also the 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}.

@item 
bpo-31854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31854}: Add @code{mmap.ACCESS_DEFAULT} constant.

@item 
bpo-31834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31834}: Use optimized code for BLAKE2 only with SSSE3+. The pure SSE2
implementation is slower than the pure C reference implementation.

@item 
bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}: Calendar.itermonthdates() will now consistently raise an
exception when a date falls outside of the 0001-01-01 through 9999-12-31
range.  To support applications that cannot tolerate such exceptions, the
new methods itermonthdays3() and itermonthdays4() are added.  The new
methods return tuples and are not restricted by the range supported by
datetime.date.

@item 
bpo-28564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28564}: The shutil.rmtree() function has been sped up to 20–40%. This
was done using the os.scandir() function.

@item 
bpo-28416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28416}: Instances of pickle.Pickler subclass with the persistent_id()
method and pickle.Unpickler subclass with the persistent_load() method no
longer create reference cycles.

@item 
bpo-31653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31653}: Don’t release the GIL if we can acquire a multiprocessing
semaphore immediately.

@item 
bpo-28326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28326}: Fix multiprocessing.Process when stdout and/or stderr is closed
or None.

@item 
bpo-20825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20825}: Add @code{subnet_of} and @code{superset_of} containment tests to
@ref{35d,,ipaddress.IPv6Network} and @ref{35c,,ipaddress.IPv4Network}. Patch
by Michel Albert and Cheryl Sabella.

@item 
bpo-31827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31827}: Remove the os.stat_float_times() function. It was introduced in
Python 2.3 for backward compatibility with Python 2.2, and was deprecated
since Python 3.1.

@item 
bpo-31756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31756}: Add a @code{subprocess.Popen(text=False)} keyword argument to
@code{subprocess} functions to be more explicit about when the library should
attempt to decode outputs into text. Patch by Andrew Clegg.

@item 
bpo-31819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31819}: Add AbstractEventLoop.sock_recv_into().

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: If nested log adapters are used, the inner @code{process()}
methods are no longer omitted.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: The @code{manager} property on LoggerAdapter objects is now
properly settable.

@item 
bpo-31806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31806}: Fix timeout rounding in time.sleep(), threading.Lock.acquire()
and socket.socket.settimeout() to round correctly negative timeouts
between -1.0 and 0.0. The functions now block waiting for events as
expected. Previously, the call was incorrectly non-blocking. Patch by
Pablo Galindo.

@item 
bpo-31803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31803}: time.clock() and time.get_clock_info(“clock”) now emit a
DeprecationWarning warning.

@item 
bpo-31800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31800}: Extended support for parsing UTC offsets. strptime “%z” can now
parse the output generated by datetime.isoformat, including seconds and
microseconds.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: traceback: Fix a TypeError that occurred during printing of
exception tracebacks when either the current exception or an exception in
its context/cause chain is unhashable. Patch by Zane Bitter.

@item 
bpo-30541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30541}: Add new function to seal a mock and prevent the automatically
creation of child mocks. Patch by Mario Corchero.

@item 
bpo-31784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31784}: Implement the 
@geindex Python Enhancement Proposals; PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/}, add new 6 new functions with
nanosecond resolution to the @ref{ee,,time} module:
@ref{b6d,,clock_gettime_ns()}, @ref{b6e,,clock_settime_ns()},
@ref{b6f,,monotonic_ns()}, @ref{b70,,perf_counter_ns()},
@ref{b71,,process_time_ns()}, @ref{b72,,time_ns()}.

@item 
bpo-30143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30143}: 2to3 now generates a code that uses abstract collection classes
from collections.abc rather than collections.

@item 
bpo-31770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31770}: Prevent a crash when calling the @code{__init__()} method of a
@code{sqlite3.Cursor} object more than once. Patch by Oren Milman.

@item 
bpo-31764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31764}: Prevent a crash in @code{sqlite3.Cursor.close()} in case the
@code{Cursor} object is uninitialized. Patch by Oren Milman.

@item 
bpo-31752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31752}: Fix possible crash in timedelta constructor called with custom
integers.

@item 
bpo-31620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31620}: an empty asyncio.Queue now doesn’t leak memory when queue.get
pollers timeout

@item 
bpo-31690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31690}: Allow the flags re.ASCII, re.LOCALE, and re.UNICODE to be used
as group flags for regular expressions.

@item 
bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}: FutureWarning is now emitted if a regular expression contains
character set constructs that will change semantically in the future
(nested sets and set operations).

@item 
bpo-31664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31664}: Added support for the Blowfish hashing in the crypt module.

@item 
bpo-31632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31632}: Fix method set_protocol() of class _SSLProtocolTransport in
asyncio module. This method was previously modifying a wrong reference to
the protocol.

@item 
bpo-15037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15037}: Added a workaround for getkey() in curses for ncurses 5.7 and
earlier.

@item 
bpo-31307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31307}: Allow use of bytes objects for arguments to
@ref{14a5,,configparser.ConfigParser.read()}. Patch by Vincent Michel.

@item 
bpo-31334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31334}: Fix @code{poll.poll([timeout])} in the @code{select} module for
arbitrary negative timeouts on all OSes where it can only be a
non-negative integer or -1. Patch by Riccardo Coccioli.

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: multiprocessing’s semaphore tracker should be launched again if
crashed.

@item 
bpo-31308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31308}: Make multiprocessing’s forkserver process immune to Ctrl-C and
other user interruptions. If it crashes, restart it when necessary.

@item 
bpo-31245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31245}: Added support for AF_UNIX socket in asyncio
@code{create_datagram_endpoint}.

@item 
bpo-30553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30553}: Add HTTP/2 status code 421 (Misdirected Request) to
@ref{996,,http.HTTPStatus}. Patch by Vitor Pereira.
@end itemize

@node Documentation<52>,Tests<50>,Library<54>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id484}@anchor{1aac}
@subsubsection Documentation



@itemize -

@item 
bpo-32105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32105}: Added asyncio.BaseEventLoop.connect_accepted_socket
versionadded marker.
@end itemize

@node Tests<50>,Build<51>,Documentation<52>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id485}@anchor{1aad}
@subsubsection Tests



@itemize -

@item 
bpo-31380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31380}: Skip test_httpservers test_undecodable_file on macOS: fails on
APFS.

@item 
bpo-31705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31705}: Skip test_socket.test_sha256() on Linux kernel older than 4.5.
The test fails with ENOKEY on kernel 3.10 (on ppc64le). A fix was merged
into the kernel 4.5.

@item 
bpo-32138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32138}: Skip on Android test_faulthandler tests that raise SIGSEGV and
remove the test.support.requires_android_level decorator.

@item 
bpo-32136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32136}: The runtime embedding tests have been split out from
@code{Lib/test/test_capi.py} into a new @code{Lib/test/test_embed.py} file.

@item 
bpo-28668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28668}: test.support.requires_multiprocessing_queue is removed. Skip
tests with test.support.import_module(“multiprocessing.synchronize”)
instead when the semaphore implementation is broken or missing.

@item 
bpo-32126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32126}: Skip test_get_event_loop_new_process in
test.test_asyncio.test_events when sem_open() is not functional.

@item 
bpo-31174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31174}: Fix test_tools.test_unparse: DirectoryTestCase now stores the
names sample to always test the same files. It prevents false alarms when
hunting reference leaks.
@end itemize

@node Build<51>,Windows<50>,Tests<50>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id486}@anchor{1aae}
@subsubsection Build



@itemize -

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: Revert the previous changes, the if_nameindex structure is
defined by Unified Headers.

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: Revert the last commit, the F_LOCK macro is defined by Android
Unified Headers.

@item 
bpo-29040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29040}: Support building Android with Unified Headers. The first NDK
release to support Unified Headers is android-ndk-r14.

@item 
bpo-32059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32059}: @code{detect_modules()} in @code{setup.py} now also searches the
sysroot paths when cross-compiling.

@item 
bpo-31957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31957}: Fixes Windows SDK version detection when building for Windows.

@item 
bpo-31609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31609}: Fixes quotes in PCbuild/clean.bat

@item 
bpo-31934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31934}: Abort the build when building out of a not clean source tree.

@item 
bpo-31926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31926}: Fixed Argument Clinic sometimes causing compilation errors when
there was more than one function and/or method in a .c file with the same
name.

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: Update Windows builds to use SQLite 3.21.0.

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: Update OS X installer to use SQLite 3.21.0.

@item 
bpo-28643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28643}: Record profile-opt build progress with stamp files.

@item 
bpo-31866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31866}: Finish removing support for AtheOS.
@end itemize

@node Windows<50>,macOS<41>,Build<51>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id487}@anchor{1aaf}
@subsubsection Windows



@itemize -

@item 
bpo-1102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1102}: Return @code{None} when @code{View.Fetch()} returns
@code{ERROR_NO_MORE_ITEMS} instead of raising @code{MSIError}. Initial patch by
Anthony Tuininga.

@item 
bpo-31944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31944}: Fixes Modify button in Apps and Features dialog.

@item 
bpo-20486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20486}: Implement the @code{Database.Close()} method to help closing MSI
database objects.

@item 
bpo-31857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31857}: Make the behavior of USE_STACKCHECK deterministic in a
multi-threaded environment.
@end itemize

@node macOS<41>,IDLE<39>,Windows<50>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id488}@anchor{1ab0}
@subsubsection macOS



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: Update macOS installer to use OpenSSL 1.0.2m
@end itemize

@node IDLE<39>,Tools/Demos<29>,macOS<41>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id489}@anchor{1ab1}
@subsubsection IDLE



@itemize -

@item 
bpo-32207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32207}: Improve tk event exception tracebacks in IDLE. When tk event
handling is driven by IDLE’s run loop, a confusing and distracting
queue.EMPTY traceback context is no longer added to tk event exception
tracebacks.  The traceback is now the same as when event handling is
driven by user code.  Patch based on a suggestion by Serhiy Storchaka.

@item 
bpo-32164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32164}: Delete unused file idlelib/tabbedpages.py. Use of TabbedPageSet
in configdialog was replaced by ttk.Notebook.

@item 
bpo-32100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32100}: IDLE: Fix old and new bugs in pathbrowser; improve tests. Patch
mostly by Cheryl Sabella.

@item 
bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858}: IDLE – Restrict shell prompt manipulation to the shell. Editor
and output windows only see an empty last prompt line.  This simplifies
the code and fixes a minor bug when newline is inserted. Sys.ps1, if
present, is read on Shell start-up, but is not set or changed.

@item 
bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}: The font sample in the IDLE configuration dialog is now
editable. Changes persist while IDLE remains open

@item 
bpo-31836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31836}: Test_code_module now passes if run after test_idle, which sets
ps1. The code module uses sys.ps1 if present or sets it to “>>> “ if not.
Test_code_module now properly tests both behaviors.  Ditto for ps2.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: Fix a TypeError that caused a shell restart when printing a
traceback that includes an exception that is unhashable. Patch by Zane
Bitter.

@item 
bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}: Use non-Latin characters in the IDLE’s Font settings sample.
Even if one selects a font that defines a limited subset of the unicode
Basic Multilingual Plane, tcl/tk will use other fonts that define a
character. The expanded example give users of non-Latin characters a
better idea of what they might see in IDLE’s shell and editors. To make
room for the expanded sample, frames on the Font tab are re-arranged.  The
Font/Tabs help explains a bit about the additions.
@end itemize

@node Tools/Demos<29>,C API<48>,IDLE<39>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id490}@anchor{1ab2}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-32159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32159}: Remove CVS and Subversion tools: remove svneol.py and
treesync.py scripts. CPython migrated from CVS to Subversion, to
Mercurial, and then to Git. CVS and Subversion are no longer used to
develop CPython.

@item 
bpo-30722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30722}: Make redemo work with Python 3.6 and newer versions. Also,
remove the @code{LOCALE} option since it doesn’t work with string patterns in
Python 3. Patch by Christoph Sarnowski.
@end itemize

@node C API<48>,,Tools/Demos<29>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id491}@anchor{1ab3}
@subsubsection C API



@itemize -

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: Fix PyGILState_Ensure(). When PyGILState_Ensure() is called in
a non-Python thread before PyEval_InitThreads(), only call
PyEval_InitThreads() after calling PyThreadState_New() to fix a crash.

@item 
bpo-32125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32125}: The @code{Py_UseClassExceptionsFlag} flag has been removed. It was
deprecated and wasn’t used anymore since Python 2.0.

@item 
bpo-25612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25612}: Move the current exception state from the frame object to the
co-routine. This simplifies the interpreter and fixes a couple of obscure
bugs caused by having swap exception state when entering or exiting a
generator.

@item 
bpo-23699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23699}: Add Py_RETURN_RICHCOMPARE macro to reduce boilerplate code in
rich comparison functions.

@item 
bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}: The @code{PyExc_RecursionErrorInst} singleton is removed and
@code{PyErr_NormalizeException()} does not use it anymore. This singleton is
persistent and its members being never cleared may cause a segfault during
finalization of the interpreter. See also bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898}.
@end itemize

@node Python 3 7 0 alpha 2,Python 3 7 0 alpha 1,Python 3 7 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-alpha-2}@anchor{1ab4}
@subsection Python 3.7.0 alpha 2


`Release date: 2017-10-16'

@menu
* Core and Builtins: Core and Builtins<54>. 
* Library: Library<55>. 
* Documentation: Documentation<53>. 
* Build: Build<52>. 
* IDLE: IDLE<40>. 
* C API: C API<49>. 

@end menu

@node Core and Builtins<54>,Library<55>,,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id492}@anchor{1ab5}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-31558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31558}: @code{gc.freeze()} is a new API that allows for moving all objects
currently tracked by the garbage collector to a permanent generation,
effectively removing them from future collection events. This can be used
to protect those objects from having their PyGC_Head mutated. In effect,
this enables great copy-on-write stability at fork().

@item 
bpo-31642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31642}: Restored blocking «from package import module» by setting
sys.modules[«package.module»] to None.

@item 
bpo-31708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31708}: Allow use of asynchronous generator expressions in synchronous
functions.

@item 
bpo-31709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31709}: Drop support of asynchronous __aiter__.

@item 
bpo-30404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30404}: The -u option now makes the stdout and stderr streams
unbuffered rather than line-buffered.

@item 
bpo-31619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31619}: Fixed a ValueError when convert a string with large number of
underscores to integer with binary base.

@item 
bpo-31602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31602}: Fix an assertion failure in @code{zipimporter.get_source()} in
case of a bad @code{zlib.decompress()}. Patch by Oren Milman.

@item 
bpo-31592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31592}: Fixed an assertion failure in Python parser in case of a bad
@code{unicodedata.normalize()}. Patch by Oren Milman.

@item 
bpo-31588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31588}: Raise a @code{TypeError} with a helpful error message when class
creation fails due to a metaclass with a bad @code{__prepare__()} method.
Patch by Oren Milman.

@item 
bpo-31574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31574}: Importlib was instrumented with two dtrace probes to profile
import timing.

@item 
bpo-31566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31566}: Fix an assertion failure in @code{_warnings.warn()} in case of a
bad @code{__name__} global. Patch by Oren Milman.

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: Improved the error message logic for @code{object.__new__} and
@code{object.__init__}.

@item 
bpo-31505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31505}: Fix an assertion failure in @code{json}, in case
@code{_json.make_encoder()} received a bad @code{encoder()} argument. Patch by
Oren Milman.

@item 
bpo-31492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31492}: Fix assertion failures in case of failing to import from a
module with a bad @code{__name__} attribute, and in case of failing to access
an attribute of such a module. Patch by Oren Milman.

@item 
bpo-31478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31478}: Fix an assertion failure in @code{_random.Random.seed()} in case
the argument has a bad @code{__abs__()} method. Patch by Oren Milman.

@item 
bpo-31336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31336}: Speed up class creation by 10-20% by reducing the overhead in
the necessary special method lookups.  Patch by Stefan Behnel.

@item 
bpo-31415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31415}: Add @code{-X importtime} option to show how long each import
takes. It can be used to optimize application’s startup time.  Support the
@geindex PYTHONPROFILEIMPORTTIME
@geindex variables de entorno; PYTHONPROFILEIMPORTTIME
@ref{b80,,PYTHONPROFILEIMPORTTIME} as an equivalent way to enable this.

@item 
bpo-31410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31410}: Optimized calling wrapper and classmethod descriptors.

@item 
bpo-31353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31353}: 
@geindex Python Enhancement Proposals; PEP 553
PEP 553@footnote{https://peps.python.org/pep-0553/} - Add a new built-in called @code{breakpoint()} which
calls @code{sys.breakpointhook()}.  By default this imports @code{pdb} and calls
@code{pdb.set_trace()}, but users may override @code{sys.breakpointhook()} to
call whatever debugger they want.  The original value of the hook is saved
in @code{sys.__breakpointhook__}.

@item 
bpo-17852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17852}: Maintain a list of open buffered files, flush them before
exiting the interpreter.  Based on a patch from Armin Rigo.

@item 
bpo-31315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31315}: Fix an assertion failure in imp.create_dynamic(), when
spec.name is not a string. Patch by Oren Milman.

@item 
bpo-31311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31311}: Fix a crash in the @code{__setstate__()} method of
@code{ctypes._CData}, in case of a bad @code{__dict__}. Patch by Oren Milman.

@item 
bpo-31293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31293}: Fix crashes in true division and multiplication of a timedelta
object by a float with a bad as_integer_ratio() method. Patch by Oren
Milman.

@item 
bpo-31285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31285}: Fix an assertion failure in @code{warnings.warn_explicit}, when
the return value of the received loader’s @code{get_source()} has a bad
@code{splitlines()} method. Patch by Oren Milman.

@item 
bpo-30406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30406}: Make @code{async} and @code{await} proper keywords, as specified in
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@end itemize

@node Library<55>,Documentation<53>,Core and Builtins<54>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id493}@anchor{1ab6}
@subsubsection Library



@itemize -

@item 
bpo-30058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30058}: Fixed buffer overflow in select.kqueue.control().

@item 
bpo-31672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31672}: @code{idpattern} in @code{string.Template} matched some non-ASCII
characters. Now it uses @code{-i} regular expression local flag to avoid
non-ASCII characters.

@item 
bpo-31701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31701}: On Windows, faulthandler.enable() now ignores MSC and COM
exceptions.

@item 
bpo-31728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31728}: Prevent crashes in @code{_elementtree} due to unsafe cleanup of
@code{Element.text} and @code{Element.tail}. Patch by Oren Milman.

@item 
bpo-31671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31671}: Now @code{re.compile()} converts passed RegexFlag to normal int
object before compiling. bm_regex_compile benchmark shows 14% performance
improvements.

@item 
bpo-30397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30397}: The types of compiled regular objects and match objects are now
exposed as @code{re.Pattern} and @code{re.Match}.  This adds information in
pydoc output for the @code{re} module.

@item 
bpo-31675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31675}: Fixed memory leaks in Tkinter’s methods splitlist() and split()
when pass a string larger than 2 GiB.

@item 
bpo-31673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31673}: Fixed typo in the name of Tkinter’s method adderrorinfo().

@item 
bpo-31648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31648}: Improvements to path predicates in ElementTree: Allow
whitespace around predicate parts, i.e. «[a = “text”]» instead of
requiring the less readable «[a=”text”]». Add support for text comparison
of the current node, like «[.=”text”]». Patch by Stefan Behnel.

@item 
bpo-30806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30806}: Fix the string representation of a netrc object.

@item 
bpo-31638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31638}: Add optional argument @code{compressed} to
@code{zipapp.create_archive}, and add option @code{--compress} to the command
line interface of @code{zipapp}.

@item 
bpo-25351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25351}: Avoid venv activate failures with undefined variables

@item 
bpo-20519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20519}: Avoid ctypes use (if possible) and improve import time for
uuid.

@item 
bpo-28293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28293}: The regular expression cache is no longer completely dumped
when it is full.

@item 
bpo-31596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31596}: Added pthread_getcpuclockid() to the time module

@item 
bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}: Make 2to3 accept a trailing comma in generator expressions. For
example, @code{set(x for x in [],)} is now allowed.

@item 
bpo-30347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30347}: Stop crashes when concurrently iterate over itertools.groupby()
iterators.

@item 
bpo-30346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30346}: An iterator produced by itertools.groupby() iterator now
becomes exhausted after advancing the groupby iterator.

@item 
bpo-31556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31556}: Cancel asyncio.wait_for future faster if timeout <= 0

@item 
bpo-31540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31540}: Allow passing a context object in
@ref{163,,concurrent.futures.ProcessPoolExecutor} constructor. Also, free
job resources in @ref{163,,concurrent.futures.ProcessPoolExecutor} earlier
to improve memory usage when a worker waits for new jobs.

@item 
bpo-31516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31516}: @code{threading.current_thread()} should not return a dummy thread
at shutdown.

@item 
bpo-31525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31525}: In the sqlite module, require the sqlite3_prepare_v2 API. Thus,
the sqlite module now requires sqlite version at least 3.3.9.

@item 
bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510}: argparse subparsers are now required by default.  This matches
behaviour in Python 2. For optional subparsers, use the new parameter
@code{add_subparsers(required=False)}. Patch by Anthony Sottile. (As of
3.7.0rc1, the default was changed to not required as had been the case
since Python 3.3.)

@item 
bpo-27541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27541}: Reprs of subclasses of some collection and iterator classes
(@code{bytearray}, @code{array.array}, @code{collections.deque},
@code{collections.defaultdict}, @code{itertools.count}, @code{itertools.repeat})
now contain actual type name instead of hardcoded names of the base class.

@item 
bpo-31351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31351}: python -m ensurepip now exits with non-zero exit code if pip
bootstrapping has failed.

@item 
bpo-31389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31389}: @code{pdb.set_trace()} now takes an optional keyword-only argument
@code{header}. If given, this is printed to the console just before debugging
begins.
@end itemize

@node Documentation<53>,Build<52>,Library<55>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id494}@anchor{1ab7}
@subsubsection Documentation



@itemize -

@item 
bpo-31537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31537}: Fix incorrect usage of @code{get_history_length} in readline
documentation example code. Patch by Brad Smith.

@item 
bpo-30085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30085}: The operator functions without double underscores are preferred
for clarity. The one with underscores are only kept for
back-compatibility.
@end itemize

@node Build<52>,IDLE<40>,Documentation<53>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id495}@anchor{1ab8}
@subsubsection Build



@itemize -

@item 
bpo-31696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31696}: Improve compiler version information in @ref{2e4,,sys.version}
when Python is built with Clang.

@item 
bpo-31625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31625}: Stop using ranlib on static libraries. Instead, we assume ar
supports the “s” flag.

@item 
bpo-31624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31624}: Remove support for BSD/OS.

@item 
bpo-22140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22140}: Prevent double substitution of prefix in python-config.sh.

@item 
bpo-31569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31569}: Correct PCBuild/ case to PCbuild/ in build scripts and
documentation.

@item 
bpo-31536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31536}: Avoid wholesale rebuild after @code{make regen-all} if nothing
changed.
@end itemize

@node IDLE<40>,C API<49>,Build<52>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id496}@anchor{1ab9}
@subsubsection IDLE



@itemize -

@item 
bpo-31460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31460}: Simplify the API of IDLE’s Module Browser. Passing a widget
instead of an flist with a root widget opens the option of creating a
browser frame that is only part of a window.  Passing a full file name
instead of pieces assumed to come from a .py file opens the possibility of
browsing python files that do not end in .py.

@item 
bpo-31649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31649}: IDLE - Make _htest, _utest parameters keyword only.

@item 
bpo-31559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31559}: Remove test order dependence in idle_test.test_browser.

@item 
bpo-31459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31459}: Rename IDLE’s module browser from Class Browser to Module
Browser. The original module-level class and method browser became a
module browser, with the addition of module-level functions, years ago.
Nested classes and functions were added yesterday.  For
back-compatibility, the virtual event <<open-class-browser>>, which
appears on the Keys tab of the Settings dialog, is not changed. Patch by
Cheryl Sabella.

@item 
bpo-31500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31500}: Default fonts now are scaled on HiDPI displays.

@item 
bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}: IDLE module browser now shows nested classes and functions.
Original patches for code and tests by Guilherme Polo and Cheryl Sabella,
respectively.
@end itemize

@node C API<49>,,IDLE<40>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id497}@anchor{1aba}
@subsubsection C API



@itemize -

@item 
bpo-28280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28280}: Make @code{PyMapping_Keys()}, @code{PyMapping_Values()} and
@code{PyMapping_Items()} always return a @code{list} (rather than a @code{list} or
a @code{tuple}). Patch by Oren Milman.

@item 
bpo-31532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31532}: Fix memory corruption due to allocator mix in getpath.c between
Py_GetPath() and Py_SetPath()

@item 
bpo-25658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25658}: Implement 
@geindex Python Enhancement Proposals; PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/} for Thread Specific Storage (TSS) API: it
is a new Thread Local Storage (TLS) API to CPython which would supersede
use of the existing TLS API within the CPython interpreter, while
deprecating the existing API. PEP written by Erik M. Bray, patch by
Masayuki Yamamoto.
@end itemize

@node Python 3 7 0 alpha 1,Python 3 6 6 final,Python 3 7 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-7-0-alpha-1}@anchor{1abb}
@subsection Python 3.7.0 alpha 1


`Release date: 2017-09-19'

@menu
* Security: Security<35>. 
* Core and Builtins: Core and Builtins<55>. 
* Library: Library<56>. 
* Documentation: Documentation<54>. 
* Tests: Tests<51>. 
* Build: Build<53>. 
* Windows: Windows<51>. 
* IDLE: IDLE<41>. 
* Tools/Demos: Tools/Demos<30>. 
* C API: C API<50>. 

@end menu

@node Security<35>,Core and Builtins<55>,,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id498}@anchor{1abc}
@subsubsection Security



@itemize -

@item 
bpo-29781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29781}: SSLObject.version() now correctly returns None when handshake
over BIO has not been performed yet.

@item 
bpo-29505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29505}: Add fuzz tests for float(str), int(str), unicode(str); for
oss-fuzz.

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to
get security fixes.

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: Prevent environment variables injection in subprocess on
Windows.  Prevent passing other environment variables and command
arguments.

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple
security vulnerabilities including: 
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233
CVE 2017-9233@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233} (External entity
infinite loop DoS), 
@geindex Common Vulnerabilities and Exposures; CVE 2016-9063
CVE 2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2016-9063} (Integer overflow, re-fix),
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} (Fix regression bugs from 2.2.0’s fix to
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718}) and 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876
CVE 2012-0876@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876} (Counter hash flooding with
SipHash). Note: the 
@geindex Common Vulnerabilities and Exposures; CVE 2016-5300
CVE 2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2016-5300} (Use os-specific entropy sources like
getrandom) doesn’t impact Python, since Python already gets entropy from
the OS to set the expat secret using @code{XML_SetHashSalt()}.

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: Fix urllib.parse.splithost() to correctly parse fragments. For
example, @code{splithost('//127.0.0.1#@@evil.com/')} now correctly returns the
@code{127.0.0.1} host, instead of treating @code{@@evil.com} as the host in an
authentication (@code{login@@host}).

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: Update expat copy from 2.1.1 to 2.2.0 to get fixes of
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} and 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}. See
@indicateurl{https://sourceforge.net/p/expat/bugs/537/} for more information.
@end itemize

@node Core and Builtins<55>,Library<56>,Security<35>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id499}@anchor{1abd}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-31490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31490}: Fix an assertion failure in @code{ctypes} class definition, in
case the class has an attribute whose name is specified in @code{_anonymous_}
but not in @code{_fields_}. Patch by Oren Milman.

@item 
bpo-31471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31471}: Fix an assertion failure in @code{subprocess.Popen()} on Windows,
in case the env argument has a bad @code{keys()} method. Patch by Oren
Milman.

@item 
bpo-31418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31418}: Fix an assertion failure in @code{PyErr_WriteUnraisable()} in case
of an exception with a bad @code{__module__} attribute. Patch by Oren Milman.

@item 
bpo-31416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31416}: Fix assertion failures in case of a bad warnings.filters or
warnings.defaultaction. Patch by Oren Milman.

@item 
bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}: Change direct usage of PyInterpreterState.modules to
PyImport_GetModuleDict(). Also introduce more uniformity in other code
that deals with sys.modules. This helps reduce complications when working
on sys.modules.

@item 
bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}: Switch to the abstract API when dealing with
@code{PyInterpreterState.modules}. This allows later support for all dict
subclasses and other Mapping implementations.  Also add a
@code{PyImport_GetModule()} function to reduce a bunch of duplicated code.

@item 
bpo-31411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31411}: Raise a TypeError instead of SystemError in case
warnings.onceregistry is not a dictionary. Patch by Oren Milman.

@item 
bpo-31344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31344}: For finer control of tracing behaviour when testing the
interpreter, two new frame attributes have been added to control the
emission of particular trace events: @code{f_trace_lines} (@code{True} by
default) to turn off per-line trace events; and @code{f_trace_opcodes}
(@code{False} by default) to turn on per-opcode trace events.

@item 
bpo-31373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31373}: Fix several possible instances of undefined behavior due to
floating-point demotions.

@item 
bpo-30465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30465}: Location information (@code{lineno} and @code{col_offset}) in
f-strings is now (mostly) correct.  This fixes tools like flake8 from
showing warnings on the wrong line (typically the first line of the file).

@item 
bpo-30860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30860}: Consolidate CPython’s global runtime state under a single
struct.  This improves discoverability of the runtime state.

@item 
bpo-31347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31347}: Fix possible undefined behavior in _PyObject_FastCall_Prepend.

@item 
bpo-31343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31343}: Include sys/sysmacros.h for major(), minor(), and makedev().
GNU C library plans to remove the functions from sys/types.h.

@item 
bpo-31291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31291}: Fix an assertion failure in @code{zipimport.zipimporter.get_data}
on Windows, when the return value of @code{pathname.replace('/','\\')} isn’t
a string. Patch by Oren Milman.

@item 
bpo-31271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31271}: Fix an assertion failure in the @code{write()} method of
@code{io.TextIOWrapper}, when the encoder doesn’t return a bytes object.
Patch by Oren Milman.

@item 
bpo-31243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31243}: Fix a crash in some methods of @code{io.TextIOWrapper}, when the
decoder’s state is invalid. Patch by Oren Milman.

@item 
bpo-30721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30721}: @code{print} now shows correct usage hint for using Python 2
redirection syntax.  Patch by Sanyam Khurana.

@item 
bpo-31070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31070}: Fix a race condition in importlib _get_module_lock().

@item 
bpo-30747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30747}: Add a non-dummy implementation of _Py_atomic_store and
_Py_atomic_load on MSVC.

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: Fix potential crash during GC caused by @code{tp_dealloc} which
doesn’t call @code{PyObject_GC_UnTrack()}.

@item 
bpo-31071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31071}: Avoid masking original TypeError in call with * unpacking when
other arguments are passed.

@item 
bpo-30978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30978}: str.format_map() now passes key lookup exceptions through.
Previously any exception was replaced with a KeyError exception.

@item 
bpo-30808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30808}: Use _Py_atomic API for concurrency-sensitive signal state.

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: Relative import from unloaded package now reimports the package
instead of failing with SystemError.  Relative import from non-package now
fails with ImportError rather than SystemError.

@item 
bpo-30703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30703}: Improve signal delivery. Avoid using Py_AddPendingCall from
signal handler, to avoid calling signal-unsafe functions. The tests I’m
adding here fail without the rest of the patch, on Linux and OS X. This
means our signal delivery logic had defects (some signals could be lost).

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: Avoid blocking in pthread_mutex_lock() when
PyThread_acquire_lock() is asked not to block.

@item 
bpo-31161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31161}: Make sure the “Missing parentheses” syntax error message is
only applied to SyntaxError, not to subclasses. Patch by Martijn Pieters.

@item 
bpo-30814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30814}: Fixed a race condition when import a submodule from a package.

@item 
bpo-30736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30736}: The internal unicodedata database has been upgraded to Unicode
10.0.

@item 
bpo-30604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30604}: Move co_extra_freefuncs from per-thread to per-interpreter to
avoid crashes.

@item 
bpo-30597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30597}: @code{print} now shows expected input in custom error message when
used as a Python 2 statement. Patch by Sanyam Khurana.

@item 
bpo-30682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30682}: Removed a too-strict assertion that failed for certain
f-strings, such as eval(«f”\n”») and eval(«f”\r”»).

@item 
bpo-30501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30501}: The compiler now produces more optimal code for complex
condition expressions in the «if», «while» and «assert» statement, the
«if» expression, and generator expressions and comprehensions.

@item 
bpo-28180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28180}: Implement 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} (legacy C locale coercion). This means
that when a suitable coercion target locale is available, both the core
interpreter and locale-aware C extensions will assume the use of UTF-8 as
the default text encoding, rather than ASCII.

@item 
bpo-30486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30486}: Allows setting cell values for __closure__. Patch by Lisa
Roach.

@item 
bpo-30537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30537}: itertools.islice now accepts integer-like objects (having an
__index__ method) as start, stop, and slice arguments

@item 
bpo-25324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25324}: Tokens needed for parsing in Python moved to C. @code{COMMENT},
@code{NL} and @code{ENCODING}. This way the tokens and tok_names in the token
module don’t get changed when you import the tokenize module.

@item 
bpo-29104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29104}: Fixed parsing backslashes in f-strings.

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: Fixed various segfaults with dict when input collections are
mutated during searching, inserting or comparing.  Based on patches by
Duane Griffin and Tim Mitchell.

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: Fixed type.__setattr__() and type.__delattr__() for
non-interned attribute names.  Based on patch by Eryk Sun.

@item 
bpo-30039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30039}: If a KeyboardInterrupt happens when the interpreter is in the
middle of resuming a chain of nested “yield from” or “await” calls, it’s
now correctly delivered to the innermost frame.

@item 
bpo-28974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28974}: @code{object.__format__(x, '@w{'})} is now equivalent to @code{str(x)}
rather than @code{format(str(self), '@w{'})}.

@item 
bpo-30024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30024}: Circular imports involving absolute imports with binding a
submodule to a name are now supported.

@item 
bpo-12414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12414}: sys.getsizeof() on a code object now returns the sizes which
includes the code struct and sizes of objects which it references. Patch
by Donghee Na.

@item 
bpo-29839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29839}: len() now raises ValueError rather than OverflowError if
__len__() returned a large negative integer.

@item 
bpo-11913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11913}: README.rst is now included in the list of distutils standard
READMEs and therefore included in source distributions.

@item 
bpo-29914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29914}: Fixed default implementations of __reduce__ and
__reduce_ex__(). object.__reduce__() no longer takes arguments,
object.__reduce_ex__() now requires one argument.

@item 
bpo-29949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29949}: Fix memory usage regression of set and frozenset object.

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: Fixed error messages in the index() method of tuple, list and
deque when pass indices of wrong type.

@item 
bpo-29816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29816}: Shift operation now has less opportunity to raise
OverflowError. ValueError always is raised rather than OverflowError for
negative counts. Shifting zero with non-negative count always returns
zero.

@item 
bpo-24821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24821}: Fixed the slowing down to 25 times in the searching of some
unlucky Unicode characters.

@item 
bpo-29102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29102}: Add a unique ID to PyInterpreterState.  This makes it easier to
identify each subinterpreter.

@item 
bpo-29894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29894}: The deprecation warning is emitted if __complex__ returns an
instance of a strict subclass of complex.  In a future versions of Python
this can be an error.

@item 
bpo-29859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29859}: Show correct error messages when any of the pthread_* calls in
thread_pthread.h fails.

@item 
bpo-29849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29849}: Fix a memory leak when an ImportError is raised during from
import.

@item 
bpo-28856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28856}: Fix an oversight that %b format for bytes should support
objects follow the buffer protocol.

@item 
bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723}: The @code{sys.path[0]} initialization change for bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} caused
a regression by revealing an inconsistency in how sys.path is initialized
when executing @code{__main__} from a zipfile, directory, or other import
location. The interpreter now consistently avoids ever adding the import
location’s parent directory to @code{sys.path}, and ensures no other
@code{sys.path} entries are inadvertently modified when inserting the import
location named on the command line.

@item 
bpo-29568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29568}: Escaped percent «%%» in the format string for classic string
formatting no longer allows any characters between two percents.

@item 
bpo-29714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29714}: Fix a regression that bytes format may fail when containing
zero bytes inside.

@item 
bpo-29695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29695}: bool(), float(), list() and tuple() no longer take keyword
arguments. The first argument of int() can now be passes only as
positional argument.

@item 
bpo-28893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28893}: Set correct __cause__ for errors about invalid awaitables
returned from __aiter__ and __anext__.

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: @code{bool(range)} works even if @code{len(range)} raises
@ref{919,,OverflowError}.

@item 
bpo-29683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29683}: Fixes to memory allocation in _PyCode_SetExtra.  Patch by Brian
Coleman.

@item 
bpo-29684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29684}: Fix minor regression of PyEval_CallObjectWithKeywords. It
should raise TypeError when kwargs is not a dict.  But it might cause segv
when args=NULL and kwargs is not a dict.

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: Support __rmod__ for subclasses of str being called before
str.__mod__. Patch by Martijn Pieters.

@item 
bpo-29607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29607}: Fix stack_effect computation for CALL_FUNCTION_EX. Patch by
Matthieu Dartiailh.

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: Fix incorrect handling of signed zeros in complex constructor
for complex subclasses and for inputs having a __complex__ method. Patch
by Serhiy Storchaka.

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: Fixed possibly dereferencing undefined pointers when creating
weakref objects.

@item 
bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}: Add @code{docstring} field to Module, ClassDef, FunctionDef, and
AsyncFunctionDef ast nodes.  docstring is not first stmt in their body
anymore.  It affects @code{co_firstlineno} and @code{co_lnotab} of code object
for module and class. (Reverted in bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911}.)

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: Fixed use-after-free problem in key sharing dict.

@item 
bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}: Set the “path” and “name” attribute on ImportError for @code{from
... import ...}.

@item 
bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}: Improve from-import error message with location

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: If max_line_length=None is specified while using the Compat32
policy, it is no longer ignored.  Patch by Mircea Cosbuc.

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: Prevent RunMainFromImporter overwriting sys.path[0].

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: Fixed possible BytesWarning when compare the code objects.
Warnings could be emitted at compile time.

@item 
bpo-29327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29327}: Fixed a crash when pass the iterable keyword argument to
sorted().

@item 
bpo-29034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29034}: Fix memory leak and use-after-free in os module
(path_converter).

@item 
bpo-29159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29159}: Fix regression in bytes(x) when x.__index__() raises Exception.

@item 
bpo-29049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29049}: Call _PyObject_GC_TRACK() lazily when calling Python function.
Calling function is up to 5% faster.

@item 
bpo-28927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28927}: bytes.fromhex() and bytearray.fromhex() now ignore all ASCII
whitespace, not only spaces.  Patch by Robert Xiao.

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: Do not include <sys/random.h> if it does not exist.

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: Correct the positioning of the syntax error caret for indented
blocks. Based on patch by Michael Layzell.

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: Fixed bytes formatting of octals with zero padding in alternate
form.

@item 
bpo-18896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18896}: Python function can now have more than 255 parameters.
collections.namedtuple() now supports tuples with more than 255 elements.

@item 
bpo-28596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28596}: The preferred encoding is UTF-8 on Android. Patch written by
Chi Hsuan Yen.

@item 
bpo-22257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22257}: Clean up interpreter startup (see 
@geindex Python Enhancement Proposals; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/}).

@item 
bpo-26919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26919}: On Android, operating system data is now always encoded/decoded
to/from UTF-8, instead of the locale encoding to avoid inconsistencies
with os.fsencode() and os.fsdecode() which are already using UTF-8.

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache() was susceptible to an obscure reentrancy
bug triggerable by a monkey-patched len() function.

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: Fix a memory leak in split-table dictionaries: setattr() must
not convert combined table into split table. Patch written by INADA Naoki.

@item 
bpo-28739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28739}: f-string expressions are no longer accepted as docstrings and
by ast.literal_eval() even if they do not include expressions.

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: Fixed setting the offset attribute of SyntaxError by
PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

@item 
bpo-28918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28918}: Fix the cross compilation of xxlimited when Python has been
built with Py_DEBUG defined.

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: Rather than silently producing a class that doesn’t support
zero-argument @code{super()} in methods, failing to pass the new
@code{__classcell__} namespace entry up to @code{type.__new__} now results in a
@code{DeprecationWarning} and a class that supports zero-argument
@code{super()}.

@item 
bpo-28797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28797}: Modifying the class __dict__ inside the __set_name__ method of
a descriptor that is used inside that class no longer prevents calling the
__set_name__ method of other descriptors.

@item 
bpo-28799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28799}: Remove the @code{PyEval_GetCallStats()} function and deprecate the
untested and undocumented @code{sys.callstats()} function. Remove the
@code{CALL_PROFILE} special build: use the @ref{153f,,sys.setprofile()} function,
@ref{28,,cProfile} or @ref{af,,profile} to profile function calls.

@item 
bpo-12844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12844}: More than 255 arguments can now be passed to a function.

@item 
bpo-28782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28782}: Fix a bug in the implementation @code{yield from} when checking if
the next instruction is YIELD_FROM. Regression introduced by WORDCODE
(bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647}).

@item 
bpo-28774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28774}: Fix error position of the unicode error in ASCII and Latin1
encoders when a string returned by the error handler contains multiple
non-encodable characters (non-ASCII for the ASCII codec, characters out of
the U+0000-U+00FF range for Latin1).

@item 
bpo-28731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28731}: Optimize _PyDict_NewPresized() to create correct size dict.
Improve speed of dict literal with constant keys up to 30%.

@item 
bpo-28532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28532}: Show sys.version when -V option is supplied twice.

@item 
bpo-27100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27100}: The with-statement now checks for __enter__ before it checks
for __exit__. This gives less confusing error messages when both methods
are missing. Patch by Jonathan Ellington.

@item 
bpo-28746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28746}: Fix the set_inheritable() file descriptor method on platforms
that do not have the ioctl FIOCLEX and FIONCLEX commands.

@item 
bpo-26920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26920}: Fix not getting the locale’s charset upon initializing the
interpreter, on platforms that do not have langinfo.

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X
when decode astral characters.  Patch by Xiang Zhang.

@item 
bpo-28665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28665}: Improve speed of the STORE_DEREF opcode by 40%.

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: Extra slash no longer added to sys.path components in case of
empty compile-time PYTHONPATH components.

@item 
bpo-28621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28621}: Sped up converting int to float by reusing faster bits counting
implementation.  Patch by Adrian Wielgosik.

@item 
bpo-28580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28580}: Optimize iterating split table values. Patch by Xiang Zhang.

@item 
bpo-28583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28583}: PyDict_SetDefault didn’t combine split table when needed. Patch
by Xiang Zhang.

@item 
bpo-28128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28128}: Deprecation warning for invalid str and byte escape sequences
now prints better information about where the error occurs. Patch by
Serhiy Storchaka and Eric Smith.

@item 
bpo-28509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28509}: dict.update() no longer allocate unnecessary large memory.

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: Fixed potential crash in PyUnicode_AsDecodedObject() in debug
build.

@item 
bpo-28517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28517}: Fixed of-by-one error in the peephole optimizer that caused
keeping unreachable code.

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: Improved exception reporting for problematic __set_name__
attributes.

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: Fixed possible memory leak in _PyTraceback_Add() and exception
loss in PyTraceBack_Here().

@item 
bpo-28183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28183}: Optimize and cleanup dict iteration.

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: Added C implementation of asyncio.Future. Original patch by
Yury Selivanov.

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: Added sanity checks and tests for PyUnicode_CopyCharacters().
Patch by Xiang Zhang.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: The type of long range iterator is now registered as Iterator.
Patch by Oren Milman.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: Creating instances of range_iterator by calling range_iterator
type now is disallowed.  Calling iter() on range instance is the only way.
Patch by Oren Milman.

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: Resolving special methods of uninitialized type now causes
implicit initialization of the type instead of a fail.

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() now checks that tp_name is not NULL. Original
patch by Niklas Koep.

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: Fixed possible crash when AST is changed in process of
compiling it.

@item 
bpo-28201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28201}: Dict reduces possibility of 2nd conflict in hash table when
hashes have same lower bits.

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: String constants with null character no longer interned.

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: Fix crash when GC runs during weakref callbacks.

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: String constants now interned recursively in tuples and
frozensets.

@item 
bpo-28289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28289}: ImportError.__init__ now resets not specified attributes.

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: Fixed misleading error message when ImportError called with
invalid keyword args.

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: Fix incorrect type in complex(1.0, @{2:3@}) error message. Patch
by Soumya Sharma.

@item 
bpo-28086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28086}: Single var-positional argument of tuple subtype was passed
unscathed to the C-defined function.  Now it is converted to exact tuple.

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: Now __set_name__ is looked up on the class instead of the
instance.

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: Fallback on reading /dev/urandom device when the getrandom()
syscall fails with EPERM, for example when blocked by SECCOMP.

@item 
bpo-28192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28192}: Don’t import readline in isolated mode.

@item 
bpo-27441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27441}: Remove some redundant assignments to ob_size in longobject.c.
Thanks Oren Milman.

@item 
bpo-27222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27222}: Clean up redundant code in long_rshift function. Thanks Oren
Milman.

@item 
Upgrade internal unicode databases to Unicode version 9.0.0.

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: Fix a regression in zipimport’s compile_source().  zipimport
should use the same optimization level as the interpreter.

@item 
bpo-28126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28126}: Replace Py_MEMCPY with memcpy(). Visual Studio can properly
optimize memcpy().

@item 
bpo-28120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28120}: Fix dict.pop() for split dictionary when trying to remove a
«pending key» (Not yet inserted in split-table). Patch by Xiang Zhang.

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: Raise DeprecationWarning when async and await keywords are used
as variable/attribute/class/function name.

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: Fix a refleak in code that raises DeprecationWarning.

@item 
bpo-28721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28721}: Fix asynchronous generators aclose() and athrow() to handle
StopAsyncIteration propagation properly.

@item 
bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}: Speed-up method calls: add LOAD_METHOD and CALL_METHOD opcodes.
@end itemize

@node Library<56>,Documentation<54>,Core and Builtins<55>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id500}@anchor{1abe}
@subsubsection Library



@itemize -

@item 
bpo-31499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31499}: xml.etree: Fix a crash when a parser is part of a reference
cycle.

@item 
bpo-31482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31482}: @code{random.seed()} now works with bytes in version=1

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing.get_type_hints now finds the right globalns for classes
and modules by default (when no @code{globalns} was specified by the caller).

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Speed improvements to the @code{typing} module.  Original PRs by
Ivan Levkivskyi and Mitar.

@item 
bpo-31544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31544}: The C accelerator module of ElementTree ignored exceptions
raised when looking up TreeBuilder target methods in XMLParser().

@item 
bpo-31234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31234}: socket.create_connection() now fixes manually a reference
cycle: clear the variable storing the last exception on success.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter objects can now be nested.

@item 
bpo-31431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31431}: SSLContext.check_hostname now automatically sets
SSLContext.verify_mode to ssl.CERT_REQUIRED instead of failing with a
ValueError.

@item 
bpo-31233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31233}: socketserver.ThreadingMixIn now keeps a list of non-daemonic
threads to wait until all these threads complete in server_close().

@item 
bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}: Changed the implementation strategy for
collections.namedtuple() to substantially reduce the use of exec() in
favor of precomputed methods. As a result, the `verbose' parameter and
`_source' attribute are no longer supported.  The benefits include 1)
having a smaller memory footprint for applications using multiple named
tuples, 2) faster creation of the named tuple class (approx 4x to 6x
depending on how it is measured), and 3) minor speed-ups for instance
creation using __new__, _make, and _replace.  (The primary patch
contributor is Jelle Zijlstra with further improvements by INADA Naoki,
Serhiy Storchaka, and Raymond Hettinger.)

@item 
bpo-31400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31400}: Improves SSL error handling to avoid losing error numbers.

@item 
bpo-27629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27629}: Make return types of SSLContext.wrap_bio() and
SSLContext.wrap_socket() customizable.

@item 
bpo-28958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28958}: ssl.SSLContext() now uses OpenSSL error information when a
context cannot be instantiated.

@item 
bpo-28182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28182}: The SSL module now raises SSLCertVerificationError when OpenSSL
fails to verify the peer’s certificate. The exception contains more
information about the error.

@item 
bpo-27340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27340}: SSLSocket.sendall() now uses memoryview to create slices of
data. This fixes support for all bytes-like object. It is also more
efficient and avoids costly copies.

@item 
bpo-14191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14191}: A new function
@code{argparse.ArgumentParser.parse_intermixed_args} provides the ability to
parse command lines where there user intermixes options and positional
arguments.

@item 
bpo-31178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31178}: Fix string concatenation bug in rare error path in the
subprocess module

@item 
bpo-31350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31350}: Micro-optimize @code{asyncio._get_running_loop()} to become up
to 10% faster.

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of
partial characters for UTF-8 input (libexpat bug 115):
@indicateurl{https://github.com/libexpat/libexpat/issues/115}

@item 
bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}: Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

@item 
bpo-1198569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1198569}: @code{string.Template} subclasses can optionally define
@code{braceidpattern} if they want to specify different placeholder patterns
inside and outside the braces.  If None (the default) it falls back to
@code{idpattern}.

@item 
bpo-31326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31326}: concurrent.futures.ProcessPoolExecutor.shutdown() now
explicitly closes the call queue. Moreover, shutdown(wait=True) now also
join the call queue thread, to prevent leaking a dangling thread.

@item 
bpo-27144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27144}: The @code{map()} and @code{as_completed()} iterators in
@code{concurrent.futures} now avoid keeping a reference to yielded objects.

@item 
bpo-31281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31281}: Fix @code{fileinput.FileInput(files, inplace=True)} when @code{files}
contain @code{pathlib.Path} objects.

@item 
bpo-10746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10746}: Fix ctypes producing wrong 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} type codes for integer
types.

@item 
bpo-27584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27584}: @code{AF_VSOCK} has been added to the socket interface which
allows communication between virtual machines and their host.

@item 
bpo-22536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22536}: The subprocess module now sets the filename when
FileNotFoundError is raised on POSIX systems due to the executable or cwd
not being found.

@item 
bpo-29741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29741}: Update some methods in the _pyio module to also accept integer
types. Patch by Oren Milman.

@item 
bpo-31249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31249}: concurrent.futures: WorkItem.run() used by ThreadPoolExecutor
now breaks a reference cycle between an exception object and the WorkItem
object.

@item 
bpo-31247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31247}: xmlrpc.server now explicitly breaks reference cycles when using
sys.exc_info() in code handling exceptions.

@item 
bpo-23835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23835}: configparser: reading defaults in the @code{ConfigParser()}
constructor is now using @code{read_dict()}, making its behavior consistent
with the rest of the parser.  Non-string keys and values in the defaults
dictionary are now being implicitly converted to strings.  Patch by James
Tocknell.

@item 
bpo-31238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31238}: pydoc: the stop() method of the private ServerThread class now
waits until DocServer.serve_until_quit() completes and then explicitly
sets its docserver attribute to None to break a reference cycle.

@item 
bpo-5001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5001}: Many asserts in @code{multiprocessing} are now more informative,
and some error types have been changed to more specific ones.

@item 
bpo-31109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31109}: Convert zipimport to use Argument Clinic.

@item 
bpo-30102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30102}: The ssl and hashlib modules now call
OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0. The function
detects CPU features and enables optimizations on some CPU architectures
such as POWER8. Patch is based on research from Gustavo Serra Scalet.

@item 
bpo-18966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18966}: Non-daemonic threads created by a multiprocessing.Process are
now joined on child exit.

@item 
bpo-31183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31183}: @code{dis} now works with asynchronous generator and coroutine
objects. Patch by George Collins based on diagnosis by Luciano Ramalho.

@item 
bpo-5001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5001}: There are a number of uninformative asserts in the
@code{multiprocessing} module, as noted in issue 5001. This change fixes two
of the most potentially problematic ones, since they are in
error-reporting code, in the @code{multiprocessing.managers.convert_to_error}
function. (It also makes more informative a ValueError message.) The only
potentially problematic change is that the AssertionError is now a
TypeError; however, this should also help distinguish it from an
AssertionError being `reported' by the function/its caller (such as in
issue 31169). - Patch by Allen W. Smith (drallensmith on github).

@item 
bpo-31185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31185}: Fixed miscellaneous errors in asyncio speedup module.

@item 
bpo-31151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31151}: socketserver.ForkingMixIn.server_close() now waits until all
child processes completed to prevent leaking zombie processes.

@item 
bpo-31072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31072}: Add an @code{include_file} parameter to
@code{zipapp.create_archive()}

@item 
bpo-24700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24700}: Optimize array.array comparison. It is now from 10x up to 70x
faster when comparing arrays holding values of the same integer type.

@item 
bpo-31135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31135}: ttk: fix the destroy() method of LabeledScale and OptionMenu
classes. Call the parent destroy() method even if the used attribute
doesn’t exist. The LabeledScale.destroy() method now also explicitly
clears label and scale attributes to help the garbage collector to destroy
all widgets.

@item 
bpo-31107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31107}: Fix @code{copyreg._slotnames()} mangled attribute calculation for
classes whose name begins with an underscore. Patch by Shane Harvey.

@item 
bpo-31080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31080}: Allow @code{logging.config.fileConfig} to accept kwargs and/or
args.

@item 
bpo-30897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30897}: @code{pathlib.Path} objects now include an @code{is_mount()} method
(only implemented on POSIX).  This is similar to @code{os.path.ismount(p)}.
Patch by Cooper Ry Lees.

@item 
bpo-31061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31061}: Fixed a crash when using asyncio and threads.

@item 
bpo-30987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30987}: Added support for CAN ISO-TP protocol in the socket module.

@item 
bpo-30522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30522}: Added a @code{setStream} method to @code{logging.StreamHandler} to
allow the stream to be set after creation.

@item 
bpo-30502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30502}: Fix handling of long oids in ssl.  Based on patch by Christian
Heimes.

@item 
bpo-5288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5288}: Support tzinfo objects with sub-minute offsets.

@item 
bpo-30919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30919}: Fix shared memory performance regression in multiprocessing in
3.x. Shared memory used anonymous memory mappings in 2.x, while 3.x mmaps
actual files. Try to be careful to do as little disk I/O as possible.

@item 
bpo-26732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26732}: Fix too many fds in processes started with the «forkserver»
method. A child process would inherit as many fds as the number of
still-running children.

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: Fix @code{unittest.mock}’s autospec to not fail on method-bound
builtin functions.  Patch by Aaron Gallagher.

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: Fix decrementing a borrowed reference in tracemalloc.

@item 
bpo-19896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19896}: Fix multiprocessing.sharedctypes to recognize typecodes @code{'q'}
and @code{'Q'}.

@item 
bpo-30946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30946}: Remove obsolete code in readline module for platforms where GNU
readline is older than 2.1 or where select() is not available.

@item 
bpo-25684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25684}: Change @code{ttk.OptionMenu} radiobuttons to be unique across
instances of @code{OptionMenu}.

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: Fix multiprocessing.Queue.join_thread(): it now waits until the
thread completes, even if the thread was started by the same process which
created the queue.

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: Fix segfault in readline when using readline’s history-size
option.  Patch by Nir Soffer.

@item 
bpo-30794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30794}: Added multiprocessing.Process.kill method to terminate using
the SIGKILL signal on Unix.

@item 
bpo-30319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30319}: socket.close() now ignores ECONNRESET error.

@item 
bpo-30828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30828}: Fix out of bounds write in
@code{asyncio.CFuture.remove_done_callback()}.

@item 
bpo-30302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30302}: Use keywords in the @code{repr} of @code{datetime.timedelta}.

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: signal.setitimer() may disable the timer when passed a tiny
value. Tiny values (such as 1e-6) are valid non-zero values for
setitimer(), which is specified as taking microsecond-resolution
intervals. However, on some platform, our conversion routine could convert
1e-6 into a zero interval, therefore disabling the timer instead of
(re-)scheduling it.

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: Fix bug when modifying os.environ while iterating over it

@item 
bpo-29585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29585}: Avoid importing @code{sysconfig} from @code{site} to improve startup
speed. Python startup is about 5% faster on Linux and 30% faster on macOS.

@item 
bpo-29293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29293}: Add missing parameter «n» on
multiprocessing.Condition.notify(). The doc claims
multiprocessing.Condition behaves like threading.Condition, but its
notify() method lacked the optional «n» argument (to specify the number of
sleepers to wake up) that threading.Condition.notify() accepts.

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: Fix email header value parser dropping folding white space in
certain cases.

@item 
bpo-30596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30596}: Add a @code{close()} method to @code{multiprocessing.Process}.

@item 
bpo-9146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9146}: Fix a segmentation fault in _hashopenssl when standard hash
functions such as md5 are not available in the linked OpenSSL library.  As
in some special FIPS-140 build environments.

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: Update zlib to 1.2.11.

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() now throws ValueError on commands that
contains CR or LF. Patch by Donghee Na.

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() and os.scandir() now emit bytes names when called
with bytes-like argument.

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: Prohibited the “=” character in environment variable names in
@code{os.putenv()} and @code{os.spawn*()}.

@item 
bpo-30664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30664}: The description of a unittest subtest now preserves the order
of keyword arguments of TestCase.subTest().

@item 
bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071}: struct.Struct.format type is now @ref{237,,str} instead of
@ref{325,,bytes}.

@item 
bpo-29212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29212}: Fix concurrent.futures.thread.ThreadPoolExecutor threads to
have a non repr() based thread name by default when no thread_name_prefix
is supplied. They will now identify themselves as
«ThreadPoolExecutor-y_n».

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: Fixed the lgettext() family of functions in the gettext module.
They now always return bytes.

@item 
bpo-30616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30616}: Functional API of enum allows to create empty enums. Patched by
Donghee Na

@item 
bpo-30038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30038}: Fix race condition between signal delivery and wakeup file
descriptor. Patch by Nathaniel Smith.

@item 
bpo-23894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23894}: lib2to3 now recognizes @code{rb'...'} and @code{f'...'} strings.

@item 
bpo-24744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24744}: pkgutil.walk_packages function now raises ValueError if `path'
is a string. Patch by Sanyam Khurana.

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: Avoid race condition in multiprocessing cleanup.

@item 
bpo-30589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30589}: Fix multiprocessing.Process.exitcode to return the opposite of
the signal number when the process is killed by a signal (instead of 255)
when using the «forkserver» method.

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: The traceback no longer displayed for SystemExit raised in a
callback registered by atexit.

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: Don’t log exceptions if Task/Future «cancel()» method was
called.

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: Fix path calculation in @code{imp.load_package()}, fixing it for
cases when a package is only shipped with bytecodes. Patch by Alexandru
Ardelean.

@item 
bpo-11822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11822}: The dis.dis() function now is able to disassemble nested code
objects.

@item 
bpo-30624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30624}: selectors does not take KeyboardInterrupt and SystemExit into
account, leaving a fd in a bad state in case of error. Patch by Giampaolo
Rodola”.

@item 
bpo-30595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30595}: multiprocessing.Queue.get() with a timeout now polls its reader
in non-blocking mode if it succeeded to acquire the lock but the acquire
took longer than the timeout.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Updates to typing module: Add generic AsyncContextManager, add
support for ContextManager on all versions. Original PRs by Jelle Zijlstra
and Ivan Levkivskyi

@item 
bpo-30605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30605}: re.compile() no longer raises a BytesWarning when compiling a
bytes instance with misplaced inline modifier.  Patch by Roy Williams.

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: Fix ssl sockets leaks when connection is aborted in asyncio/ssl
implementation. Patch by Michaël Sghaïer.

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: Closing transport during handshake process leaks open socket.
Patch by Nikolay Kim

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu
Sornay.

@item 
bpo-30014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30014}: modify() method of poll(), epoll() and devpoll() based classes
of selectors module is around 10% faster.  Patch by Giampaolo Rodola”.

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: On Windows, subprocess.Popen.communicate() now also ignore
EINVAL on stdin.write() if the child process is still running but closed
the pipe.

@item 
bpo-30463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30463}: Added empty __slots__ to abc.ABC.  This allows subclassers to
deny __dict__ and __weakref__ creation.  Patch by Aaron Hall.

@item 
bpo-30520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30520}: Loggers are now pickleable.

@item 
bpo-30557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30557}: faulthandler now correctly filters and displays exception codes
on Windows

@item 
bpo-30526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30526}: Add TextIOWrapper.reconfigure() and a
TextIOWrapper.write_through attribute.

@item 
bpo-30245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30245}: Fix possible overflow when organize struct.pack_into error
message.  Patch by Yuan Liu.

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: Fix the problem that logging.handlers.SysLogHandler cannot
handle IPv6 addresses.

@item 
bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}: Allow registering at-fork handlers.

@item 
bpo-30470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30470}: Deprecate invalid ctypes call protection on Windows.  Patch by
Mariatta Wijaya.

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed background running thread do not
break from main loop on exception.

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: Fix handling escape characters in HZ codec.  Based on patch by
Ma Lin.

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() now supports callables with
variable-argument parameters wrapped with partialmethod. Patch by Donghee
Na.

@item 
bpo-30436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30436}: importlib.find_spec() raises ModuleNotFoundError instead of
AttributeError if the specified parent module is not a package (i.e. lacks
a __path__ attribute).

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: Fix AttributeError when using SimpleQueue.empty() under `spawn'
and `forkserver' start methods.

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: Warnings emitted when compile a regular expression now always
point to the line in the user code.  Previously they could point into
inners of the re module if emitted from inside of groups or conditionals.

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib and poplib now catch the Windows socket WSAEINVAL error
(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted.
This error occurs sometimes on SSL connections.

@item 
bpo-29196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29196}: Removed previously deprecated in Python 2.4 classes Plist, Dict
and _InternalDict in the plistlib module.  Dict values in the result of
functions readPlist() and readPlistFromBytes() are now normal dicts.  You
no longer can use attribute access to access items of these dictionaries.

@item 
bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}: The @code{macpath} is now deprecated and will be removed in
Python 3.8.

@item 
bpo-30299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30299}: Compiling regular expression in debug mode on CPython now
displays the compiled bytecode in human readable form.

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: Fixed @code{Task.cancel()} can be ignored when the task is running
coroutine and the coroutine returned without any more @code{await}.

@item 
bpo-30266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30266}: contextlib.AbstractContextManager now supports
anti-registration by setting __enter__ = None or __exit__ = None,
following the pattern introduced in bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}. Patch by Jelle Zijlstra.

@item 
bpo-30340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30340}: Enhanced regular expressions optimization. This increased the
performance of matching some patterns up to 25 times.

@item 
bpo-30298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30298}: Weaken the condition of deprecation warnings for inline
modifiers. Now allowed several subsequential inline modifiers at the start
of the pattern (e.g. @code{'(?i)(?s)...'}).  In verbose mode whitespaces and
comments now are allowed before and between inline modifiers (e.g. @code{'(?x)
(?i) (?s)...'}).

@item 
bpo-30285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30285}: Optimized case-insensitive matching and searching of regular
expressions.

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: Fix range checking in GB18030 decoder.  Original patch by Ma
Lin.

@item 
bpo-29979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29979}: rewrite cgi.parse_multipart, reusing the FieldStorage class and
making its results consistent with those of FieldStorage for
multipart/form-data requests. Patch by Pierre Quentel.

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: Removed the __init__ methods of _json’s scanner and encoder.
Misusing them could cause memory leaks or crashes.  Now scanner and
encoder objects are completely initialized in the __new__ methods.

@item 
bpo-30215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30215}: Compiled regular expression objects with the re.LOCALE flag no
longer depend on the locale at compile time.  Only the locale at matching
time affects the result of matching.

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: Avoid KeyboardInterrupt tracebacks in forkserver helper process
when Ctrl-C is received.

@item 
bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103}: binascii.b2a_uu() and uu.encode() now support using @code{'`'} as
zero instead of space.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: add typing.NoReturn type, use
WrapperDescriptorType, minor bug-fixes.  Original PRs by Jim
Fasarakis-Hilliard and Ivan Levkivskyi.

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: Fix getsockname() for unbound AF_UNIX sockets on Linux.

@item 
bpo-30228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30228}: The seek() and tell() methods of io.FileIO now set the internal
seekable attribute to avoid one syscall on open() (in buffered or text
mode).

@item 
bpo-30190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30190}: unittest’s assertAlmostEqual and assertNotAlmostEqual provide a
better message in case of failure which includes the difference between
left and right arguments.  (patch by Giampaolo Rodola”)

@item 
bpo-30101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30101}: Add support for curses.A_ITALIC.

@item 
bpo-29822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29822}: inspect.isabstract() now works during __init_subclass__.  Patch
by Nate Soares.

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: Preserve generator state when _random.Random.setstate() raises
an exception. Patch by Bryan Olson.

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: Fixed leaks and crashes in errors handling in the parser
module.

@item 
bpo-22352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22352}: Column widths in the output of dis.dis() are now adjusted for
large line numbers and instruction offsets.

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: Fixed crashes in IOBase methods __next__() and readlines() when
readline() or __next__() respectively return non-sizeable object. Fixed
possible other errors caused by not checking results of PyObject_Size(),
PySequence_Size(), or PyMapping_Size().

@item 
bpo-30218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30218}: Fix PathLike support for shutil.unpack_archive. Patch by Jelle
Zijlstra.

@item 
bpo-10076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10076}: Compiled regular expression and match objects in the re module
now support copy.copy() and copy.deepcopy() (they are considered atomic).

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: _io._IOBase.readlines will check if it’s closed first when hint
is present.

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: Fixed race condition in pathlib mkdir with flags parents=True.
Patch by Armin Rigo.

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: Fixed arbitrary unchaining of RuntimeError exceptions in
contextlib.contextmanager.  Patch by Siddharth Velankar.

@item 
bpo-26187@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26187}: Test that sqlite3 trace callback is not called multiple times
when schema is changing.  Indirectly fixed by switching to use
sqlite3_prepare_v2() in bpo-9303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9303}.  Patch by Aviv Palivoda.

@item 
bpo-30017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30017}: Allowed calling the close() method of the zip entry writer
object multiple times.  Writing to a closed writer now always produces a
ValueError.

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling and copying ImportError now preserves name and path
attributes.

@item 
bpo-29995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29995}: re.escape() now escapes only regex special characters.

@item 
bpo-29962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29962}: Add math.remainder operation, implementing remainder as
specified in IEEE 754.

@item 
bpo-29649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29649}: Improve struct.pack_into() exception messages for problems with
the buffer size and offset.  Patch by Andrew Nester.

@item 
bpo-29654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29654}: Support If-Modified-Since HTTP header (browser cache).  Patch
by Pierre Quentel.

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: Fixed comparison check for ipaddress.ip_interface objects.
Patch by Sanjay Sundaresan.

@item 
bpo-29953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29953}: Fixed memory leaks in the replace() method of datetime and time
objects when pass out of bound fold argument.

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: Fix a crash in itertools.chain.from_iterable when encountering
long runs of empty iterables.

@item 
bpo-10030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10030}: Sped up reading encrypted ZIP files by 2 times.

@item 
bpo-29204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29204}: Element.getiterator() and the html parameter of XMLParser()
were deprecated only in the documentation (since Python 3.2 and 3.4
correspondingly). Now using them emits a deprecation warning.

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: Fixed multiple crashes in ElementTree caused by race conditions
and wrong types.

@item 
bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}: Added support of file descriptors in os.scandir() on Unix.
os.fwalk() is sped up by 2 times by using os.scandir().

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: Fixed a bug in pools in multiprocessing.pool that raising an
exception at the very first of an iterable may swallow the exception or
make the program hang. Patch by Davin Potts and Xiang Zhang.

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() now manually breaks a
reference cycle to not keep objects alive longer than expected.

@item 
bpo-29901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29901}: The zipapp module now supports general path-like objects, not
just pathlib.Path.

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when
the OS gives priority to errors such as EACCES over EEXIST.

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: Release references to tasks, their arguments and their results
as soon as they are finished in multiprocessing.Pool.

@item 
bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}: The mode argument of os.makedirs() no longer affects the file
permission bits of newly created intermediate-level directories.

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: Restore the old sigaltstack during teardown.
Patch by Christophe Zeitouny.

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: Fixed crashes in repr of recursive buffered file-like objects.

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: Fix crashes in partial.__repr__ if the keys of partial.keywords
are not strings.  Patch by Michael Seifert.

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: Fixed possible failing or crashing input() if attributes
«encoding» or «errors» of sys.stdin or sys.stdout are not set or are not
strings.

@item 
bpo-28692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28692}: Using non-integer value for selecting a plural form in gettext
is now deprecated.

@item 
bpo-26121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26121}: Use C library implementation for math functions erf() and
erfc().

@item 
bpo-29619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29619}: os.stat() and os.DirEntry.inode() now convert inode (st_ino)
using unsigned integers.

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: Fix a bug that prevented array “Q”, “L” and “I” from accepting
big intables (objects that have __int__) as elements.

@item 
bpo-29645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29645}: Speed up importing the webbrowser module.
webbrowser.register() is now thread-safe.

@item 
bpo-28231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28231}: The zipfile module now accepts path-like objects for external
paths.

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: index() and count() methods of collections.abc.Sequence now
check identity before checking equality when do comparisons.

@item 
bpo-28682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28682}: Added support for bytes paths in os.fwalk().

@item 
bpo-29728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29728}: Add new @code{socket.TCP_NOTSENT_LOWAT} (Linux 3.12)
constant. Patch by Nathaniel J. Smith.

@item 
bpo-29623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29623}: Allow use of path-like object as a single argument in
ConfigParser.read(). Patch by David Ellis.

@item 
bpo-9303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9303}: Migrate sqlite3 module to _v2 API.  Patch by Aviv Palivoda.

@item 
bpo-28963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28963}: Fix out of bound iteration in
asyncio.Future.remove_done_callback implemented in C.

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol no longer closes
before all pipes are closed.

@item 
bpo-29271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29271}: Fix Task.current_task and Task.all_tasks implemented in C to
accept None argument as their pure Python implementation.

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: Fix asyncio to support instantiation of new event loops in
child processes.

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher no longer chains KeyError (or any other
exception) to exception(s) raised in the dispatched methods. Patch by Petr
Motejlek.

@item 
bpo-7769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7769}: Method register_function() of
xmlrpc.server.SimpleXMLRPCDispatcher and its subclasses can now be used as
a decorator.

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: Fix assertion error in threading._DummyThread.is_alive().

@item 
bpo-28624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28624}: Add a test that checks that cwd parameter of Popen() accepts
PathLike objects.  Patch by Sayan Chowdhury.

@item 
bpo-28518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28518}: Start a transaction implicitly before a DML statement. Patch by
Aviv Palivoda.

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: get_extra_info() raises exception if get called on closed ssl
transport. Patch by Nikolay Kim.

@item 
bpo-16285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16285}: urllib.parse.quote is now based on RFC 3986 and hence includes
“~” in the set of characters that is not quoted by default. Patch by
Christian Theune and Ratnadeep Debnath.

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: Altering a kwarg dictionary passed to functools.partial() no
longer affects a partial object after creation.

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: Fix file object leak in aifc.open() when file is given as a
filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

@item 
bpo-22807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22807}: Add uuid.SafeUUID and uuid.UUID.is_safe to relay information
from the platform about whether generated UUIDs are generated with a
multiprocessing safe method.

@item 
bpo-29576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29576}: Improve some deprecations in importlib. Some deprecated methods
now emit DeprecationWarnings and have better descriptive messages.

@item 
bpo-29534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29534}: Fixed different behaviour of Decimal.from_float() for _decimal
and _pydecimal. Thanks Andrew Nester.

@item 
bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}: locale.format_string now supports the “monetary” keyword
argument, and locale.format is deprecated.

@item 
bpo-29851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29851}: importlib.reload() now raises ModuleNotFoundError if the module
lacks a spec.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: typing.Counter,
typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle
Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: Fix datetime.fromtimestamp() regression introduced in Python
3.6.0: check minimum and maximum years.

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: Prevent infinite loop in pathlib.Path.mkdir

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: Fixed out-of-bounds buffer access in the group() method of the
match object. Based on patch by WGH.

@item 
bpo-29377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29377}: Add WrapperDescriptorType, MethodWrapperType, and
MethodDescriptorType built-in types to types module. Original patch by
Manuel Krebber.

@item 
bpo-29218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29218}: Unused install_misc command is now removed.  It has been
documented as unused since 2000.  Patch by Eric N. Vander Weele.

@item 
bpo-29368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29368}: The extend() method is now called instead of the append()
method when unpickle collections.deque and other list-like objects. This
can speed up unpickling to 2 times.

@item 
bpo-29338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29338}: The help of a builtin or extension class now includes the
constructor signature if __text_signature__ is provided for the class.

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: Fix subprocess.Popen.wait() when the child process has exited
to a stopped instead of terminated state (ex: when under ptrace).

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: Fix a regression in argparse that help messages would wrap at
non-breaking spaces.

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: Fixed the comparison of mock.MagickMock with mock.ANY.

@item 
bpo-29197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29197}: Removed deprecated function ntpath.splitunc().

@item 
bpo-29210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29210}: Removed support of deprecated argument «exclude» in
tarfile.TarFile.add().

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: Fixed infinite recursion in the repr of uninitialized
ctypes.CDLL instances.

@item 
bpo-29192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29192}: Removed deprecated features in the http.cookies module.

@item 
bpo-29193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29193}: A format string argument for string.Formatter.format() is now
positional-only.

@item 
bpo-29195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29195}: Removed support of deprecated undocumented keyword arguments in
methods of regular expression objects.

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: Fixed race condition in C implementation of
functools.lru_cache. KeyError could be raised when cached function with
full cache was simultaneously called from different threads with the same
uncached arguments.

@item 
bpo-20804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20804}: The unittest.mock.sentinel attributes now preserve their
identity when they are copied or pickled.

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: In urllib.request, suffixes in no_proxy environment variable
with leading dots could match related hostnames again (e.g. .b.c matches
a.b.c). Patch by Milan Oberkirch.

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: Fix unittest.mock._Call helper: don’t ignore the name parameter
anymore. Patch written by Jiajun Huang.

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo() now correctly shows the first line of a
context. Patch by Sam Breese.

@item 
bpo-28985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28985}: Update authorizer constants in sqlite3 module. Patch by
Dingyuan Wang.

@item 
bpo-29079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29079}: Prevent infinite loop in pathlib.resolve() on Windows

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: Fixed recursion errors in large or resized
curses.textpad.Textbox.  Based on patch by Tycho Andersen.

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii predicates now work correctly with negative
integers.

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: old keys should not remove new values from WeakValueDictionary
when collecting from another thread.

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: Remove editor artifacts from Tix.py.

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: Fixed a crash when deallocate deep ElementTree.

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: Fix bugs in WeakValueDictionary.setdefault() and
WeakValueDictionary.pop() when a GC collection happens in another thread.

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: Fixed a crash in resource.prlimit() when passing a sequence
that doesn’t own its elements as limits.

@item 
bpo-16255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16255}: subprocess.Popen uses /system/bin/sh on Android as the shell,
instead of /bin/sh.

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: multiprocessing.set_forkserver_preload() would crash the
forkserver process if a preloaded module instantiated some multiprocessing
objects such as locks.

@item 
bpo-26937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26937}: The chown() method of the tarfile.TarFile class does not fail
now when the grp module cannot be imported, as for example on Android
platforms.

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb now supports reading read-only files and no longer
writes the index file when it is not changed.  A deprecation warning is
now emitted if the index file is missed and recreated in the “r” and “w”
modes (will be an error in future Python releases).

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: Unknown escapes consisting of @code{'\'} and an ASCII letter in
re.sub() replacement templates regular expressions now are errors.

@item 
bpo-28835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28835}: Fix a regression introduced in warnings.catch_warnings(): call
warnings.showwarning() if it was overridden inside the context manager.

@item 
bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172}: To assist with upgrades from 2.7, the previously documented
deprecation of @code{inspect.getfullargspec()} has been reversed. This
decision may be revisited again after the Python 2.7 branch is no longer
officially supported.

@item 
bpo-28740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28740}: Add sys.getandroidapilevel(): return the build time API version
of Android as an integer. Function only available on Android.

@item 
bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}: Add new @code{socket.TCP_CONGESTION} (Linux 2.6.13) and
@code{socket.TCP_USER_TIMEOUT} (Linux 2.6.37) constants. Patch written
by Omar Sandoval.

@item 
bpo-28752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28752}: Restored the __reduce__() methods of datetime objects.

@item 
bpo-28727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28727}: Regular expression patterns, _sre.SRE_Pattern objects created
by re.compile(), become comparable (only x==y and x!=y operators). This
change should fix the bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: don’t duplicate warning filters when
the warnings module is reloaded (thing usually only done in unit tests).

@item 
bpo-20572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20572}: Remove the subprocess.Popen.wait endtime parameter.  It was
deprecated in 3.4 and undocumented prior to that.

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: In ctypes, prevent a crash calling the from_buffer() and
from_buffer_copy() methods on abstract classes like Array.

@item 
bpo-28548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28548}: In the «http.server» module, parse the protocol version if
possible, to avoid using HTTP 0.9 in some error responses.

@item 
bpo-19717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19717}: Makes Path.resolve() succeed on paths that do not exist. Patch
by Vajrasky Kok

@item 
bpo-28563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28563}: Fixed possible DoS and arbitrary code execution when handle
plural form selections in the gettext module.  The expression parser now
supports exact syntax supported by GNU gettext.

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: Fixed possible crash in _io.TextIOWrapper deallocator when the
garbage collector is invoked in other thread.  Based on patch by Sebastian
Cufre.

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA compressor and decompressor no longer raise exceptions if
given empty data twice.  Patch by Benjamin Fogle.

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: Fixed segfault in curses’s addch() with ncurses6.

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open() with mode «r» or «r:» now tries to open a tar
file with compression before trying to open it without compression.
Otherwise it had 50% chance failed with ignore_zeros=True.

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: The webbrowser module now supports Firefox 36+ and derived
browsers.  Based on patch by Oleg Broytman.

@item 
bpo-24241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24241}: The webbrowser in an X environment now prefers using the
default browser directly. Also, the webbrowser register() function now has
a documented “preferred” argument, to specify browsers to be returned by
get() with no arguments. Patch by David Steele

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused
by representing the scale as float value internally in Tk.  tkinter.IntVar
now works if float value is set to underlying Tk variable.

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar.prweek() no longer prints a space after a
weeks’s calendar.  calendar.TextCalendar.pryear() no longer prints
redundant newline after a year’s calendar.  Based on patch by Xiang Zhang.

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar.prmonth() no longer prints a space at the
start of new line after printing a month’s calendar.  Patch by Xiang
Zhang.

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: The textwrap.TextWrapper class now honors non-breaking spaces.
Based on patch by Kaarle Ritvanen.

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() no longer fails on broken links.

@item 
bpo-28430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28430}: Fix iterator of C implemented asyncio.Future doesn’t accept
non-None value is passed to it.send(val).

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: Generated names for Tkinter widgets now start by the «!» prefix
for readability.

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: Fixed HList.header_exists() in tkinter.tix module by addin a
workaround to Tix library bug.

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() no longer adds entry «./» to ZIP archive.

@item 
bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}: re.sub() now raises an error for invalid numerical group
reference in replacement template even if the pattern is not found in the
string.  Error message for invalid group reference now includes the group
index and the position of the reference. Based on patch by SilentGhost.

@item 
bpo-28469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28469}: timeit now uses the sequence 1, 2, 5, 10, 20, 50,… instead of
1, 10, 100,… for autoranging.

@item 
bpo-28115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28115}: Command-line interface of the zipfile module now uses argparse.
Added support of long options.

@item 
bpo-18219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18219}: Optimize csv.DictWriter for large number of columns. Patch by
Mariatta Wijaya.

@item 
bpo-28448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28448}: Fix C implemented asyncio.Future didn’t work on Windows.

@item 
bpo-23214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23214}: In the «io» module, the argument to BufferedReader and
BytesIO’s read1() methods is now optional and can be -1, matching the
BufferedIOBase specification.

@item 
bpo-28480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28480}: Fix error building socket module when multithreading is
disabled.

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: timeit: remove @code{-c/--clock} and @code{-t/--time} command line
options which were deprecated since Python 3.3.

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: timeit now repeats the benchmarks 5 times instead of only 3 to
make benchmarks more reliable.

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: timeit autorange now uses a single loop iteration if the
benchmark takes less than 10 seconds, instead of 10 iterations. «python3
-m timeit -s “import time” “time.sleep(1)”» now takes 4 seconds instead of
40 seconds.

@item 
Distutils.sdist now looks for README and setup.py files with case
sensitivity. This behavior matches that found in Setuptools 6.0 and later.
See setuptools 100@footnote{https://github.com/pypa/setuptools/issues/100} for
rationale.

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: Make webbrowser support Chrome on Mac OS X. Patch by Ned
Batchelder.

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: Fix references leaked by pdb in the handling of SIGINT
handlers.

@item 
bpo-27998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27998}: Fixed bytes path support in os.scandir() on Windows. Patch by
Eryk Sun.

@item 
bpo-28317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28317}: The disassembler now decodes FORMAT_VALUE argument.

@item 
bpo-28380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28380}: unittest.mock Mock autospec functions now properly support
assert_called, assert_not_called, and assert_called_once.

@item 
bpo-28229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28229}: lzma module now supports pathlib.

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: Fixed writing non-BMP characters with binary format in
plistlib.

@item 
bpo-28225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28225}: bz2 module now supports pathlib.  Initial patch by Ethan
Furman.

@item 
bpo-28227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28227}: gzip now supports pathlib.  Patch by Ethan Furman.

@item 
bpo-28332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28332}: Deprecated silent truncations in socket.htons and socket.ntohs.
Original patch by Oren Milman.

@item 
bpo-27358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27358}: Optimized merging var-keyword arguments and improved error
message when passing a non-mapping as a var-keyword argument.

@item 
bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257}: Improved error message when passing a non-iterable as a
var-positional argument.  Added opcode BUILD_TUPLE_UNPACK_WITH_CALL.

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: Fixed possible crashes when unpickle itertools objects from
incorrect pickle data.  Based on patch by John Leitch.

@item 
bpo-28228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28228}: imghdr now supports pathlib.

@item 
bpo-28226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28226}: compileall now supports pathlib.

@item 
bpo-28314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28314}: Fix function declaration (C flags) for the getiterator() method
of xml.etree.ElementTree.Element.

@item 
bpo-28148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28148}: Stop using localtime() and gmtime() in the time module.
Introduced platform independent _PyTime_localtime API that is similar to
POSIX localtime_r, but available on all platforms.  Patch by Ed Schouten.

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: Fixed calendar functions for extreme months: 0001-01 and
9999-12. Methods itermonthdays() and itermonthdays2() are reimplemented so
that they don’t call itermonthdates() which can cause datetime.date
under/overflow.

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: Fixed possible use after free in the decompress() methods of
the LZMADecompressor and BZ2Decompressor classes. Original patch by John
Leitch.

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: Fixed possible crash in sqlite3.Connection.create_collation()
if pass invalid string-like object as a name.  Patch by Xiang Zhang.

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: random.choices() now has k as a keyword-only argument to
improve the readability of common cases and come into line with the
signature used in other languages.

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py.
Patch by Madison May.

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: Fixed support of default root window in the tkinter.tix module.
Added the master parameter in the DisplayStyle constructor.

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: In the traceback module, restore the formatting of exception
messages like «Exception: None».  This fixes a regression introduced in
3.5a2.

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: Allow false values to be used for msg parameter of subTest().

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: Fix a memory leak in os.getrandom() when the getrandom() is
interrupted by a signal and a signal handler raises a Python exception.

@item 
bpo-28200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28200}: Fix memory leak on Windows in the os module (fix
path_converter() function).

@item 
bpo-25400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25400}: RobotFileParser now correctly returns default values for
crawl_delay and request_rate.  Initial patch by Peter Wirtz.

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: Prevent memory leak in win32_ver().

@item 
Fix UnboundLocalError in socket._sendfile_use_sendfile.

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: Check for ERROR_ACCESS_DENIED in Windows implementation of
os.stat().  Patch by Eryk Sun.

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: Warning message emitted by using inline flags in the middle of
regular expression now contains a (truncated) regex pattern. Patch by Tim
Graham.

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: Prevent codecs.escape_encode() from raising SystemError when an
empty bytestring is passed.

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by
Gergely Imreh and Markus Holtermann.

@item 
bpo-28114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28114}: Fix a crash in parse_envlist() when env contains byte strings.
Patch by Eryk Sun.

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: Fixed buffer overrun in binascii.b2a_qp() and
binascii.a2b_qp().

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: Fix socket accept exhaustion during high TCP traffic. Patch by
Kevin Conway.

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: Handle when SO_REUSEPORT isn’t properly supported. Patch by
Seth Michael Larson.

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: Inspect functools.partial in asyncio.Handle.__repr__. Patch by
iceboy.

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: Fix selectors incorrectly retain invalid file descriptors.
Patch by Mark Williams.

@item 
bpo-28325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28325}: Remove vestigial MacOS 9 macurl2path module and its tests.

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: Refuse monitoring processes if the child watcher has no loop
attached. Patch by Vincent Michel.

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: Raise RuntimeError when transport’s FD is used with add_reader,
add_writer, etc.

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг
Марк.

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: Deprecate passing asyncio.Handles to run_in_executor.

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: Fix asyncio to support formatting of non-python coroutines.

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: Remove UNIX socket from FS before binding. Patch by Коренберг
Марк.

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: Prohibit Tasks to await on themselves.

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: Reading a corrupt config file left configparser in an invalid
state. Original patch by Florian Höch.

@item 
bpo-29581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29581}: ABCMeta.__new__ now accepts @code{**kwargs}, allowing abstract
base classes to use keyword parameters in __init_subclass__. Patch by Nate
Soares.

@item 
bpo-25532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25532}: inspect.unwrap() will now only try to unwrap an object
sys.getrecursionlimit() times, to protect against objects which create a
new object on every attribute access.

@item 
bpo-30177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30177}: path.resolve(strict=False) no longer cuts the path after the
first element not present in the filesystem.  Patch by Antoine Pietri.
@end itemize

@node Documentation<54>,Tests<51>,Library<56>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id501}@anchor{1abf}
@subsubsection Documentation



@itemize -

@item 
bpo-31294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31294}: Fix incomplete code snippet in the ZeroMQSocketListener and
ZeroMQSocketHandler examples and adapt them to Python 3.

@item 
bpo-21649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21649}: Add RFC 7525 and Mozilla server side TLS links to SSL
documentation.

@item 
bpo-31128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31128}: Allow the pydoc server to bind to arbitrary hostnames.

@item 
bpo-30803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30803}: Clarify doc on truth value testing. Original patch by Peter
Thomassen.

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: Add missing attribute related constants in curses
documentation.

@item 
bpo-30052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30052}: the link targets for @ref{325,,bytes()} and @ref{5e0,,bytearray()} are
now their respective type definitions, rather than the corresponding
builtin function entries. Use @ref{1ac0,,bytes} and
@ref{1ac1,,bytearray} to reference the latter. In order to
ensure this and future cross-reference updates are applied automatically,
the daily documentation builds now disable the default output caching
features in Sphinx.

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: Add missing info of code object in inspect documentation.

@item 
bpo-19824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19824}: Improve the documentation for, and links to, template strings
by emphasizing their utility for internationalization, and by clarifying
some usage constraints. (See also: bpo-20314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20314}, bpo-12518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12518})

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: Link the documentation to its source file on GitHub.

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: Document smtpd.py as effectively deprecated and add a pointer
to aiosmtpd, a third-party asyncio-based replacement.

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: Add canonical header link on each page to corresponding major
version of the documentation. Patch by Matthias Bussonnier.

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: Fix Python 2 syntax in code for building the documentation.

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: The data model reference and the porting section in the 3.6
What’s New guide now cover the additional @code{__classcell__} handling
needed for custom metaclasses to fully support 
@geindex Python Enhancement Proposals; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} and
zero-argument @code{super()}.

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: Documented command-line interface of zipfile.
@end itemize

@node Tests<51>,Build<53>,Documentation<54>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id502}@anchor{1ac2}
@subsubsection Tests



@itemize -

@item 
bpo-29639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29639}: test.support.HOST is now «localhost», a new HOSTv4 constant has
been added for your @code{127.0.0.1} needs, similar to the existing HOSTv6
constant.

@item 
bpo-31320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31320}: Silence traceback in test_ssl

@item 
bpo-31346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31346}: Prefer PROTOCOL_TLS_CLIENT and PROTOCOL_TLS_SERVER protocols
for SSLContext.

@item 
bpo-25674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25674}: Remove sha256.tbs-internet.com ssl test

@item 
bpo-30715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30715}: Address ALPN callback changes for OpenSSL 1.1.0f. The latest
version behaves like OpenSSL 1.0.2 and no longer aborts handshake.

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: regrtest: Exclude tzdata from regrtest –all. When running the
test suite using –use=all / -u all, exclude tzdata since it makes
test_datetime too slow (15-20 min on some buildbots) which then times out
on some buildbots. Fix also regrtest command line parser to allow passing
-u extralargefile to run test_zipfile64.

@item 
bpo-30695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30695}: Add the @code{set_nomemory(start, stop)} and
@code{remove_mem_hooks()} functions to the @code{_testcapi} module.

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() now uses support.threading_setup() and
support.threading_cleanup() to wait until threads complete to avoid random
side effects on following tests. Initial patch written by Grzegorz
Grzywacz.

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: Enhanced functions swap_attr() and swap_item() in the
test.support module. They now work when delete replaced attribute or item
inside the with statement.  The old value of the attribute or item (or
None if it doesn’t exist) now will be assigned to the target of the «as»
clause, if there is one.

@item 
bpo-24932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24932}: Use proper command line parsing in _testembed

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: Disallow -j0 to be combined with -T/-l in regrtest command line
arguments.

@item 
bpo-28683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28683}: Fix the tests that bind() a unix socket and raise
PermissionError on Android for a non-root user.

@item 
bpo-26936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26936}: Fix the test_socket failures on Android - getservbyname(),
getservbyport() and getaddrinfo() are broken on some Android API levels.

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: Now test.support.rmtree is able to remove unwritable or
unreadable directories.

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: Various caches now are cleared before running every test file.

@item 
bpo-26944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26944}: Fix test_posix for Android where “id -G” is entirely wrong or
missing the effective gid.

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: fix the parser of command line arguments.

@item 
bpo-28217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28217}: Adds _testconsole module to test console input.

@item 
bpo-26939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26939}: Add the support.setswitchinterval() function to fix
test_functools hanging on the Android armv7 qemu emulator.
@end itemize

@node Build<53>,Windows<51>,Tests<51>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id503}@anchor{1ac3}
@subsubsection Build



@itemize -

@item 
bpo-31354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31354}: Allow @code{--with-lto} to be used on all builds, not just @code{make
profile-opt}.

@item 
bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370}: Remove support for building –without-threads. This option is
not really useful anymore in the 21st century. Removing lots of
conditional paths allows us to simplify the code base, including in
difficult to maintain low-level internal code.

@item 
bpo-31341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31341}: Per 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, support for the IRIX operating system was
removed.

@item 
bpo-30854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30854}: Fix compile error when compiling –without-threads. Patch by
Masayuki Yamamoto.

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: Locate msbuild.exe on Windows when building rather than
vcvarsall.bat

@item 
bpo-20210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20210}: Support the `disabled' marker in Setup files. Extension modules
listed after this marker are not built at all, neither by the Makefile nor
by setup.py.

@item 
bpo-29941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29941}: Add @code{--with-assertions} configure flag to explicitly enable C
@code{assert()} checks. Defaults to off. @code{--with-pydebug} implies
@code{--with-assertions}.

@item 
bpo-28787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28787}: Fix out-of-tree builds of Python when configured with
@code{--with--dtrace}.

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: Prevent unnecessary rebuilding of Python during @code{make test},
@code{make install} and some other make targets when configured with
@code{--enable-optimizations}.

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: Don’t regenerate generated files based on file modification
time anymore: the action is now explicit. Replace @code{make touch} with
@code{make regen-all}.

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: Fix @code{--enable-optimization} didn’t work.

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: sys.version and the platform module python_build(),
python_branch(), and python_revision() functions now use git information
rather than hg when building from a repo.

@item 
bpo-29572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29572}: Update Windows build and OS X installers to use OpenSSL 1.0.2k.

@item 
bpo-27659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27659}: Prohibit implicit C function declarations: use
@code{-Werror=implicit-function-declaration} when possible (GCC and Clang,
but it depends on the compiler version). Patch written by Chi Hsuan Yen.

@item 
bpo-29384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29384}: Remove old Be OS helper scripts.

@item 
bpo-26851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26851}: Set Android compilation and link flags.

@item 
bpo-28768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28768}: Fix implicit declaration of function _setmode. Patch by
Masayuki Yamamoto

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: Removes hard dependency on hg.exe from PCBuild/build.bat

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: Added missed names to PC/python3.def.

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: lockf() is available on Android API level 24, but the F_LOCK
macro is not defined in android-ndk-r13.

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: Fix the compilation error that occurs because if_nameindex() is
available on Android API level 24, but the if_nameindex structure is not
defined.

@item 
bpo-20211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20211}: Do not add the directory for installing C header files and the
directory for installing object code libraries to the cross compilation
search paths. Original patch by Thomas Petazzoni.

@item 
bpo-28849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28849}: Do not define sys.implementation._multiarch on Android.

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: Fix out-of-tree building on AIX.  Patch by Tristan Carel and
Michael Haubenwallner.

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: Rename –with-optimiations to –enable-optimizations.

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: Fix missing extensions modules when cross compiling.

@item 
bpo-28208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28208}: Update Windows build and OS X installers to use SQLite 3.14.2.

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: Update Windows build and OS X installers to use OpenSSL 1.0.2j.

@item 
bpo-21124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21124}: Fix building the _struct module on Cygwin by passing @code{NULL}
instead of @code{&PyType_Type} to PyVarObject_HEAD_INIT.  Patch by Masayuki
Yamamoto.

@item 
bpo-13756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13756}: Fix building extensions modules on Cygwin.  Patch by Roumen
Petrov, based on original patch by Jason Tishler.

@item 
bpo-21085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21085}: Add configure check for siginfo_t.si_band, which Cygwin does
not provide. Patch by Masayuki Yamamoto with review and rebase by Erik
Bray.

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: Fixed build with Estonian locale (python-config and distclean
targets in Makefile).  Patch by Arfrever Frehtes Taifersar Arahesis.

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py now detects system libffi with multiarch wrapper.

@item 
bpo-27979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27979}: A full copy of libffi is no longer bundled for use when
building _ctypes on non-OSX UNIX platforms.  An installed copy of libffi
is now required when building _ctypes on such platforms.

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: Remove redundant include search directory option for building
outside the source tree.

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: Prevent missing “getentropy” declaration warning on macOS.
Patch by Gareth Rees.
@end itemize

@node Windows<51>,IDLE<41>,Build<53>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id504}@anchor{1ac4}
@subsubsection Windows



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: Update Windows build to use OpenSSL 1.1.0f

@item 
bpo-30389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30389}: Adds detection of Visual Studio 2017 to distutils on Windows.

@item 
bpo-31358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31358}: zlib is no longer bundled in the CPython source, instead it is
downloaded on demand just like bz2, lzma, OpenSSL, Tcl/Tk, and SQLite.

@item 
bpo-31340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31340}: Change to building with MSVC v141 (included with Visual Studio
2017)

@item 
bpo-30581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30581}: os.cpu_count() now returns the correct number of processors on
Windows when the number of logical processors is greater than 64.

@item 
bpo-30916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30916}: Pre-build OpenSSL, Tcl and Tk and include the binaries in the
build.

@item 
bpo-30731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30731}: Add a missing xmlns to python.manifest so that it matches the
schema.

@item 
bpo-30291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30291}: Allow requiring 64-bit interpreters from py.exe using -64
suffix. Contributed by Steve (Gadget) Barnes.

@item 
bpo-30362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30362}: Adds list options (-0, -0p) to py.exe launcher. Contributed by
Steve Barnes.

@item 
bpo-23451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23451}: Fix socket deprecation warnings in socketmodule.c. Patch by
Segev Finer.

@item 
bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}: The build process on Windows no longer depends on Subversion,
instead pulling external code from GitHub via a Python script.  If Python
3.6 is not found on the system (via @code{py -3.6}), NuGet is used to
download a copy of 32-bit Python.

@item 
bpo-29579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29579}: Removes readme.txt from the installer.

@item 
bpo-25778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25778}: winreg does not truncate string correctly (Patch by Eryk Sun)

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: Deprecate WindowsRegistryFinder and disable it by default

@item 
bpo-28522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28522}: Fixes mishandled buffer reallocation in getpathp.c

@item 
bpo-28402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28402}: Adds signed catalog files for stdlib on Windows.

@item 
bpo-28333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28333}: Enables Unicode for ps1/ps2 and input() prompts. (Patch by Eryk
Sun)

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: Improvements to help manuals on Windows.

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi has different product codes between 32-bit and
64-bit

@item 
bpo-28161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28161}: Opening CON for write access fails

@item 
bpo-28162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28162}: WindowsConsoleIO readall() fails if first line starts with
Ctrl+Z

@item 
bpo-28163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28163}: WindowsConsoleIO fileno() passes wrong flags to _open_osfhandle

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: _PyIO_get_console_type fails for various paths

@item 
bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}: Renames Windows path file to ._pth

@item 
bpo-28138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28138}: Windows ._pth file should allow import site
@end itemize

@node IDLE<41>,Tools/Demos<30>,Windows<51>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id505}@anchor{1ac5}
@subsubsection IDLE



@itemize -

@item 
bpo-31493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31493}: IDLE code context – fix code update and font update timers.
Canceling timers prevents a warning message when test_idle completes.

@item 
bpo-31488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31488}: IDLE - Update non-key options in former extension classes. When
applying configdialog changes, call .reload for each feature class. Change
ParenMatch so updated options affect existing instances attached to
existing editor windows.

@item 
bpo-31477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31477}: IDLE - Improve rstrip entry in doc. Strip trailing whitespace
strips more than blank spaces.  Multiline string literals are not skipped.

@item 
bpo-31480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31480}: IDLE - make tests pass with zzdummy extension disabled by
default.

@item 
bpo-31421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31421}: Document how IDLE runs tkinter programs. IDLE calls tcl/tk
update in the background in order to make live interaction and
experimentation with tkinter applications much easier.

@item 
bpo-31414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31414}: IDLE – fix tk entry box tests by deleting first. Adding to an
int entry is not the same as deleting and inserting because int(“”) will
fail.

@item 
bpo-31051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31051}: Rearrange IDLE configdialog GenPage into Window, Editor, and
Help sections.

@item 
bpo-30617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30617}: IDLE - Add docstrings and tests for outwin subclass of editor.
Move some data and functions from the class to module level. Patch by
Cheryl Sabella.

@item 
bpo-31287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31287}: IDLE - Do not modify tkinter.message in test_configdialog.

@item 
bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}: Convert IDLE’s built-in “extensions” to regular features. About
10 IDLE features were implemented as supposedly optional extensions. Their
different behavior could be confusing or worse for users and not good for
maintenance. Hence the conversion. The main difference for users is that
user configurable key bindings for builtin features are now handled
uniformly. Now, editing a binding in a keyset only affects its value in
the keyset. All bindings are defined together in the system-specific
default keysets in config-extensions.def. All custom keysets are saved as
a whole in config-extension.cfg.  All take effect as soon as one clicks
Apply or Ok. The affected events are “<<force-open-completions>>”,
“<<expand-word>>”, “<<force-open-calltip>>”, “<<flash-paren>>”,
“<<format-paragraph>>”, “<<run-module>>”, “<<check-module>>”, and
“<<zoom-height>>”.  Any (global) customizations made before 3.6.3 will not
affect their keyset-specific customization after 3.6.3. and vice versa.
Initial patch by Charles Wohlganger.

@item 
bpo-31206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31206}: IDLE: Factor HighPage(Frame) class from ConfigDialog. Patch by
Cheryl Sabella.

@item 
bpo-31001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31001}: Add tests for configdialog highlight tab.  Patch by Cheryl
Sabella.

@item 
bpo-31205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31205}: IDLE: Factor KeysPage(Frame) class from ConfigDialog.  The
slightly modified tests continue to pass.  Patch by Cheryl Sabella.

@item 
bpo-31130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31130}: IDLE – stop leaks in test_configdialog. Initial patch by
Victor Stinner.

@item 
bpo-31002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31002}: Add tests for configdialog keys tab. Patch by Cheryl Sabella.

@item 
bpo-19903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19903}: IDLE: Calltips use @code{inspect.signature} instead of
@code{inspect.getfullargspec}. This improves calltips for builtins converted
to use Argument Clinic. Patch by Louie Lu.

@item 
bpo-31083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31083}: IDLE - Add an outline of a TabPage class in configdialog.
Update existing classes to match outline. Initial patch by Cheryl Sabella.

@item 
bpo-31050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31050}: Factor GenPage(Frame) class from ConfigDialog. The slightly
modified tests continue to pass. Patch by Cheryl Sabella.

@item 
bpo-31004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31004}: IDLE - Factor FontPage(Frame) class from ConfigDialog. Slightly
modified tests continue to pass. Fix General tests. Patch mostly by Cheryl
Sabella.

@item 
bpo-30781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30781}: IDLE - Use ttk widgets in ConfigDialog. Patches by Terry Jan
Reedy and Cheryl Sabella.

@item 
bpo-31060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31060}: IDLE - Finish rearranging methods of ConfigDialog Grouping
methods pertaining to each tab and the buttons will aid writing tests and
improving the tabs and will enable splitting the groups into classes.

@item 
bpo-30853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30853}: IDLE – Factor a VarTrace class out of ConfigDialog. Instance
tracers manages pairs consisting of a tk variable and a callback function.
When tracing is turned on, setting the variable calls the function.  Test
coverage for the new class is 100%.

@item 
bpo-31003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31003}: IDLE: Add more tests for General tab.

@item 
bpo-30993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30993}: IDLE - Improve configdialog font page and tests. In
configdialog: Document causal pathways in create_font_tab docstring.
Simplify some attribute names. Move set_samples calls to var_changed_font
(idea from Cheryl Sabella).  Move related functions to positions after the
create widgets function. In test_configdialog: Fix test_font_set so not
order dependent.  Fix renamed test_indent_scale so it tests the widget.
Adjust tests for movement of set_samples call.  Add tests for load
functions.  Put all font tests in one class and tab indent tests in
another.  Except for two lines, these tests completely cover the related
functions.

@item 
bpo-30981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30981}: IDLE – Add more configdialog font page tests.

@item 
bpo-28523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28523}: IDLE: replace “colour” with “color” in configdialog.

@item 
bpo-30917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30917}: Add tests for idlelib.config.IdleConf. Increase coverage from
46% to 96%. Patch by Louie Lu.

@item 
bpo-30934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30934}: Document coverage details for idlelib tests. Add section to
idlelib/idle-test/README.txt. Include check that branches are taken both
ways. Exclude IDLE-specific code that does not run during unit tests.

@item 
bpo-30913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30913}: IDLE: Document ConfigDialog tk Vars, methods, and widgets in
docstrings This will facilitate improving the dialog and splitting up the
class. Original patch by Cheryl Sabella.

@item 
bpo-30899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30899}: IDLE: Add tests for ConfigParser subclasses in config. Patch by
Louie Lu.

@item 
bpo-30881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30881}: IDLE: Add docstrings to browser.py. Patch by Cheryl Sabella.

@item 
bpo-30851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30851}: IDLE: Remove unused variables in configdialog.  One is a
duplicate, one is set but cannot be altered by users. Patch by Cheryl
Sabella.

@item 
bpo-30870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30870}: IDLE: In Settings dialog, select font with Up, Down keys as
well as mouse. Initial patch by Louie Lu.

@item 
bpo-8231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8231}: IDLE: call config.IdleConf.GetUserCfgDir only once.

@item 
bpo-30779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30779}: IDLE: Factor ConfigChanges class from configdialog, put in
config; test. * In config, put dump test code in a function; run it and
unittest in   “if __name__ == “__main__”. * Add class config.ConfigChanges
based on changes_class_v4.py on bpo issue. * Add class
test_config.ChangesTest, partly using configdialog_tests_v1.py. * Revise
configdialog to use ConfigChanges; see tracker msg297804. * Revise
test_configdialog to match configdialog changes. * Remove configdialog
functions unused or moved to ConfigChanges. Cheryl Sabella contributed
parts of the patch.

@item 
bpo-30777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30777}: IDLE: configdialog - Add docstrings and fix comments. Patch by
Cheryl Sabella.

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: IDLE: Improve textview with docstrings, PEP8 names, and more
tests. Patch by Cheryl Sabella.

@item 
bpo-30723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30723}: IDLE: Make several improvements to parenmatch. Add “parens”
style to highlight both opener and closer. Make “default” style, which is
not default, a synonym for “opener”. Make time-delay work the same with
all styles. Add help for config dialog extensions tab, including help for
parenmatch. Add new tests.  Original patch by Charles Wohlganger.

@item 
bpo-30674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30674}: IDLE: add docstrings to grep module. Patch by Cheryl Sabella

@item 
bpo-21519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21519}: IDLE’s basic custom key entry dialog now detects duplicates
properly. Original patch by Saimadhav Heblikar.

@item 
bpo-29910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29910}: IDLE no longer deletes a character after commenting out a
region by a key shortcut.  Add @code{return 'break'} for this and other
potential conflicts between IDLE and default key bindings.

@item 
bpo-30728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30728}: Review and change idlelib.configdialog names. Lowercase method
and attribute names. Replace “colour” with “color”, expand overly cryptic
names, delete unneeded underscores. Replace @code{import *} with specific
imports. Patches by Cheryl Sabella.

@item 
bpo-6739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6739}: IDLE: Verify user-entered key sequences by trying to bind them
with tk. Add tests for all 3 validation functions. Original patch by G
Polo.  Tests added by Cheryl Sabella.

@item 
bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}: Fix several problems with IDLE’s autocompletion box. The
following should now work: clicking on selection box items; using the
scrollbar; selecting an item by hitting Return. Hangs on MacOSX should no
longer happen. Patch by Louie Lu.

@item 
bpo-25514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25514}: Add doc subsubsection about IDLE failure to start. Popup
no-connection message directs users to this section.

@item 
bpo-30642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30642}: Fix reference leaks in IDLE tests. Patches by Louie Lu and
Terry Jan Reedy.

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: Add docstrings for textview.py and use PEP8 names. Patches by
Cheryl Sabella and Terry Jan Reedy.

@item 
bpo-30290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30290}: Help-about: use pep8 names and add tests. Increase coverage to
100%. Patches by Louie Lu, Cheryl Sabella, and Terry Jan Reedy.

@item 
bpo-30303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30303}: Add _utest option to textview; add new tests. Increase coverage
to 100%. Patches by Louie Lu and Terry Jan Reedy.

@item 
bpo-29071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29071}: IDLE colors f-string prefixes (but not invalid ur prefixes).

@item 
bpo-28572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28572}: Add 10% to coverage of IDLE’s test_configdialog. Update and
augment description of the configuration system.
@end itemize

@node Tools/Demos<30>,C API<50>,IDLE<41>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id506}@anchor{1ac6}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-30983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30983}: gdb integration commands (py-bt, etc.) work on optimized shared
builds now, too.  
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} introduced _PyEval_EvalFrameDefault which
inlines PyEval_EvalFrameEx on non-debug shared builds.  This broke the
ability to use py-bt, py-up, and a few other Python-specific gdb
integrations. The problem is fixed by only looking for
_PyEval_EvalFrameDefault frames in python-gdb.py.  Original patch by Bruno
«Polaco» Penteado.

@item 
bpo-29748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29748}: Added the slice index converter in Argument Clinic.

@item 
bpo-24037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24037}: Argument Clinic now uses the converter @code{bool(accept=@{int@})}
rather than @code{int} for semantical booleans.  This avoids repeating the
default value for Python and C and will help in converting to @code{bool} in
future.

@item 
bpo-29367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29367}: python-gdb.py now supports also @code{method-wrapper}
(@code{wrapperobject}) objects.

@item 
bpo-28023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28023}: Fix python-gdb.py didn’t support new dict implementation.

@item 
bpo-15369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15369}: The pybench and pystone microbenchmark have been removed from
Tools. Please use the new Python benchmark suite
@indicateurl{https://github.com/python/pyperformance} which is more reliable and
includes a portable version of pybench working on Python 2 and Python 3.

@item 
bpo-28102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28102}: The zipfile module CLI now prints usage to stderr. Patch by
Stephen J. Turnbull.
@end itemize

@node C API<50>,,Tools/Demos<30>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id507}@anchor{1ac7}
@subsubsection C API



@itemize -

@item 
bpo-31338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31338}: Added the @code{Py_UNREACHABLE()} macro for code paths which are
never expected to be reached.  This and a few other useful macros are now
documented in the C API manual.

@item 
bpo-30832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30832}: Remove own implementation for thread-local storage. CPython has
provided the own implementation for thread-local storage (TLS) on
Python/thread.c, it’s used in the case which a platform has not supplied
native TLS.  However, currently all supported platforms (Windows and
pthreads) have provided native TLS and defined the Py_HAVE_NATIVE_TLS
macro with unconditional in any case.

@item 
bpo-30708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30708}: PyUnicode_AsWideCharString() now raises a ValueError if the
second argument is NULL and the wchar_t* string contains null characters.

@item 
bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}: Deprecate PyOS_AfterFork() and add PyOS_BeforeFork(),
PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

@item 
bpo-6532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6532}: The type of results of PyThread_start_new_thread() and
PyThread_get_thread_ident(), and the id parameter of
PyThreadState_SetAsyncExc() changed from «long» to «unsigned long».

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: Function PySlice_GetIndicesEx() is deprecated and replaced with
a macro if Py_LIMITED_API is not set or set to the value between
0x03050400 and 0x03060000 (not including) or 0x03060100 or higher.  Added
functions PySlice_Unpack() and PySlice_AdjustIndices().

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: Fixed the declaration of some public API functions.
PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in
limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and
Py_BuildValue() were not available in limited API of version < 3.3 when
PY_SSIZE_T_CLEAN is defined.

@item 
bpo-28769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28769}: The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8()
is now of type @code{const char *} rather of @code{char *}.

@item 
bpo-29058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29058}: All stable API extensions added after Python 3.2 are now
available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of
the minimum Python version supporting this API.

@item 
bpo-28822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28822}: The index parameters `start' and `end' of PyUnicode_FindChar()
are now adjusted to behave like @code{str[start:end]}.

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() now never raises exceptions.

@item 
bpo-28761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28761}: The fields name and doc of structures PyMemberDef, PyGetSetDef,
PyStructSequence_Field, PyStructSequence_Desc, and wrapperbase are now of
type @code{const char *} rather of @code{char *}.

@item 
bpo-28748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28748}: Private variable _Py_PackageContext is now of type @code{const char
*} rather of @code{char *}.

@item 
bpo-19569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19569}: Compiler warnings are now emitted if use most of deprecated
functions.

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: Deprecated undocumented functions PyUnicode_AsEncodedObject(),
PyUnicode_AsDecodedObject(), PyUnicode_AsDecodedUnicode() and
PyUnicode_AsEncodedUnicode().
@end itemize

@node Python 3 6 6 final,Python 3 6 6 release candidate 1,Python 3 7 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-6-final}@anchor{1ac8}
@subsection Python 3.6.6 final


`Release date: 2018-06-27'

There were no new changes in version 3.6.6.

@node Python 3 6 6 release candidate 1,Python 3 6 5 final,Python 3 6 6 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-6-release-candidate-1}@anchor{1ac9}
@subsection Python 3.6.6 release candidate 1


`Release date: 2018-06-11'

@menu
* Core and Builtins: Core and Builtins<56>. 
* Library: Library<57>. 
* Documentation: Documentation<55>. 
* Tests: Tests<52>. 
* Build: Build<54>. 
* Windows: Windows<52>. 
* macOS: macOS<42>. 
* IDLE: IDLE<42>. 
* Tools/Demos: Tools/Demos<31>. 
* C API: C API<51>. 

@end menu

@node Core and Builtins<56>,Library<57>,,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id508}@anchor{1aca}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33786}: Fix asynchronous generators to handle GeneratorExit in athrow()
correctly

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: Fixed reset of the SIGINT handler to SIG_DFL on interpreter
shutdown even when there was a custom handler set previously. Patch by
Philipp Kerling.

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: Fixed a leak when the garbage collector fails to add an object
with the @code{__del__} method or referenced by it into the
@ref{122e,,gc.garbage} list. @ref{a20,,PyGC_Collect()} can now be called when an
exception is set and preserves it.

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: Fix signed/unsigned comparison warning in pyhash.c.

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: Fix a leak in set_symmetric_difference().

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: Fix unaligned accesses in siphash24(). Patch by Rolf Eike Beer.

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: Fix potential memory leak in @code{normalizestring()}.

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: Improved error messages in “async with” when @code{__aenter__()}
or @code{__aexit__()} return non-awaitable object.

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: Fix @code{ma_version_tag} in dict implementation is uninitialized
when copying from key-sharing dict.

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: Fixed jumping when the function contains an @code{async for} loop.

@item 
bpo-32282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32282}: Fix an unnecessary ifdef in the include of VersionHelpers.h in
socketmodule on Windows.

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: Fix a crash in @code{ctypes.cast()} in case the type argument is a
ctypes structured data type. Patch by Eryk Sun and Oren Milman.
@end itemize

@node Library<57>,Documentation<55>,Core and Builtins<56>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id509}@anchor{1acb}
@subsubsection Library



@itemize -

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: Prevent site.main() exception if PYTHONSTARTUP is set. Patch by
Steve Weber.

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: Datetime instance d with non-None tzinfo, but with
d.tzinfo.utcoffset(d) returning None is now treated as naive by the
astimezone() method.

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: Avoid race condition with debug logging

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: The concatenation (@code{+}) and repetition (@code{*}) sequence
operations now raise @ref{228,,TypeError} instead of @ref{619,,SystemError} when
performed on @ref{368,,mmap.mmap} objects.  Patch by Zackery Spytz.

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: Fix gather to propagate cancellation of itself even with
return_exceptions.

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: Fix a race condition in SSLProtocol.connection_made() of
asyncio.sslproto: start immediately the handshake instead of using
call_soon(). Previously, data_received() could be called before the
handshake started, causing the handshake to hang or fail.

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: Fixed bug where calling write_eof() on a
_SelectorSocketTransport after it’s already closed raises AttributeError.

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: Fix Task.__repr__ crash with Cython’s bogus coroutines

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: Fix RuntimeError after closing loop that used run_in_executor

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: Use a better regex when breaking usage into wrappable parts.
Avoids bogus assertion errors from custom metavar strings.

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: Fixed a bug in the Python implementation of the JSON decoder
that prevented the cache of parsed strings from clearing after finishing
the decoding. Based on patch by c-fos.

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list should consider common TEMP
locations

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: Prevent @code{uuid.get_node} from using a DUID instead of a MAC on
Windows. Patch by Zvi Effron

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: Fix race condition with @code{ReadTransport.resume_reading} in
Windows proactor event loop.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Minor fixes in typing module: add annotations to
@code{NamedTuple.__new__}, pass @code{*args} and @code{**kwds} in
@code{Generic.__new__}.  Original PRs by Paulius Šarka and Chad Dombrova.

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: Updated alias mapping with glibc 2.27 supported locales.

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: Fix trailing quotation marks getting deleted when looking up
byte/string literals on pydoc. Patch by Andrés Delfino.

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: Update error message when constructing invalid
inspect.Parameters Patch by Donghee Na.

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: Fixed crash in the get() method of the @ref{35,,dbm.ndbm} database
object when it is called with a single argument.

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: Fix multiprocessing regression on newer glibcs

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: Fix quoting of the @code{Comment} attribute of
@ref{1a4a,,http.cookies.SimpleCookie}.

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: Upgrade bundled version of pip to 10.0.1.

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: Fixed a crash in the @code{parser} module when converting an ST
object to a tree of tuples or lists with @code{line_info=False} and
@code{col_info=True}.

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: Fix FD leak in @code{_SelectorSocketTransport}  Patch by Vlad
Starostin.

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: Fix display of @code{<module>} call in the html produced by
@code{cgitb.html()}. Patch by Stéphane Blondon.

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} now raises @code{IndexError} for empty
sequences consistently even when called from subclasses without a
@code{getrandbits()} implementation.

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: Update difflib.mdiff() for 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.  Convert an uncaught
StopIteration in a generator into a return-statement.

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: End framing at the end of C implementation of
@ref{1a4c,,pickle.Pickler.dump()}.

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: The urllib.robotparser’s @code{__str__} representation now
includes wildcard entries and the «Crawl-delay» and «Request-rate» fields.
Patch by Michael Lazar.

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: Allow ttk.Treeview.insert to insert iid that has a false
boolean value. Note iid=0 and iid=False would be same. Patch by Garvit
Khatri.

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: The ssl module now compiles with LibreSSL 2.7.1.

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: Release the GIL during fstat() calls, avoiding hang of all
threads when calling mmap.mmap(), os.urandom(), and random.seed().  Patch
by Nir Soffer.

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: Fix a regression in @ref{80,,ipaddress} that result of
@code{hosts()} is empty when the network is constructed by a tuple
containing an integer mask and only 1 bit left for addresses.

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: Fix wrong redirection of a low descriptor (0 or 1) to stderr in
subprocess if another low descriptor is closed.

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: Fix output of cover files for @code{trace} module command-line
tool. Previously emitted cover files only when @code{--missing} option was
used. Patch by Michael Selik.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: If nested log adapters are used, the inner @code{process()}
methods are no longer omitted.

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: Support arrays >=2GiB in @ref{2b,,ctypes}.  Patch by Segev Finer.

@item 
bpo-31238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31238}: pydoc: the stop() method of the private ServerThread class now
waits until DocServer.serve_until_quit() completes and then explicitly
sets its docserver attribute to None to break a reference cycle.
@end itemize

@node Documentation<55>,Tests<52>,Library<57>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id510}@anchor{1acc}
@subsubsection Documentation



@itemize -

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: Fix broken pypi link

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: Add missing documentation for @code{typing.AsyncContextManager}.

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: Add Korean language switcher for @indicateurl{https://docs.python.org/3/}

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: Clarify that the @code{__path__} attribute on modules cannot be
just any value.

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: Modernize documentation for writing C extension types.

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: Deprecate @code{Py_UNICODE} usage in @code{c-api/arg} document.
@code{Py_UNICODE} related APIs are deprecated since Python 3.3, but it is
missed in the document.

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: Document PyBuffer_ToContiguous().

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: Modify documentation for the @code{islice()} recipe to consume
initial values up to the start index.

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: Update @ref{12f,,zipapp} documentation to describe how to make
standalone applications.

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: Documentation changes for ipaddress.  Patch by Jon Foster and
Berker Peksag.

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: Update documentation to clarify that @code{WindowsRegistryFinder}
implements @code{MetaPathFinder}. (Patch by Himanshu Lakhara)

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: Add a note about curses.addch and curses.addstr exception
behavior when writing outside a window, or pad.

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: Clarify meaning of CERT_NONE, CERT_OPTIONAL, and CERT_REQUIRED
flags for ssl.SSLContext.verify_mode.
@end itemize

@node Tests<52>,Build<54>,Documentation<55>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id511}@anchor{1acd}
@subsubsection Tests



@itemize -

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: Ignore test_posix_fallocate failures on BSD platforms that
might be due to running on ZFS.

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: Add test_bdb.py.
@end itemize

@node Build<54>,Windows<52>,Tests<52>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id512}@anchor{1ace}
@subsubsection Build



@itemize -

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: Move @code{-Wstrict-prototypes} option to @code{CFLAGS_NODIST} from
@code{OPT}. This option emitted annoying warnings when building extension
modules written in C++.

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: Ensures module definition files for the stable ABI on Windows
are correctly regenerated.

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: Enable CI builds on Visual Studio Team Services at
@indicateurl{https://python.visualstudio.com/cpython}

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: Add @code{-Wno-cast-function-type} for gcc 8 for silencing
warnings about function casts like casting to PyCFunction in method
definition lists.

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: Enable the verbose build for extension modules, when GNU make
is passed macros on the command line.
@end itemize

@node Windows<52>,macOS<42>,Build<54>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id513}@anchor{1acf}
@subsubsection Windows



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update Windows installer to OpenSSL 1.0.2o.
@end itemize

@node macOS<42>,IDLE<42>,Windows<52>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id514}@anchor{1ad0}
@subsubsection macOS



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: Update macOS installer build to use OpenSSL 1.0.2o.
@end itemize

@node IDLE<42>,Tools/Demos<31>,macOS<42>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id515}@anchor{1ad1}
@subsubsection IDLE



@itemize -

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: On Windows, add API call saying that tk scales for DPI. On
Windows 8.1+ or 10, with DPI compatibility properties of the Python binary
unchanged, and a monitor resolution greater than 96 DPI, this should make
text and lines sharper.  It should otherwise have no effect.

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: Clicking on a context line moves that line to the top of the
editor window.

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE: Use read-only text widget for code context instead of
label widget.

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: Scroll IDLE editor text by lines. Previously, the mouse wheel
and scrollbar slider moved text by a fixed number of pixels, resulting in
partial lines at the top of the editor box.  The change also applies to
the shell and grep output windows, but not to read-only text views.

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: Enable theme-specific color configuration for Code Context. Use
the Highlights tab to see the setting for built-in themes or add settings
to custom themes.

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: Display up to maxlines non-blank lines for Code Context. If
there is no current context, show a single blank line.

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE: Cleanup codecontext.py and its test.

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE’s code context now recognizes async as a block opener.

@item 
bpo-29706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29706}: IDLE now colors async and await as keywords in 3.6. They become
full keywords in 3.7.

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: Update word/identifier definition from ascii to unicode. In
text and entry boxes, this affects selection by double-click, movement
left/right by control-left/right, and deletion left/right by
control-BACKSPACE/DEL.

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE: consistently color invalid string prefixes. A “u” string
prefix cannot be paired with either “r” or “f”. Consistently color as much
of the prefix, starting at the right, as is valid. Revise and extend
colorizer test.

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: Add docstrings and tests for codecontext.
@end itemize

@node Tools/Demos<31>,C API<51>,IDLE<42>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id516}@anchor{1ad2}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} now recognizes only literal strings as
docstrings and translatable strings, and rejects bytes literals and
f-string expressions.

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: Fixed handling directories as arguments in the @code{pygettext}
script. Based on patch by Oleg Krasnikov.

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: Fix pystackv and pystack gdbinit macros.

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: Add an @code{-n} flag for @code{Tools/scripts/pathfix.py} to disable
automatic backup creation (files with @code{~} suffix).

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: Fix 2to3 for using with –add-suffix option but without
–output-dir option for relative path to files in current directory.
@end itemize

@node C API<51>,,Tools/Demos<31>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id517}@anchor{1ad3}
@subsubsection C API



@itemize -

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: Document that m_traverse for multi-phase initialized modules
can be called with m_state=NULL, and add a sanity check
@end itemize

@node Python 3 6 5 final,Python 3 6 5 release candidate 1,Python 3 6 6 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-5-final}@anchor{1ad4}
@subsection Python 3.6.5 final


`Release date: 2018-03-28'

@menu
* Tests: Tests<53>. 
* Build: Build<55>. 

@end menu

@node Tests<53>,Build<55>,,Python 3 6 5 final
@anchor{whatsnew/changelog id518}@anchor{1ad5}
@subsubsection Tests



@itemize -

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: Avoid regrtest compatibility issue with namespace packages.
@end itemize

@node Build<55>,,Tests<53>,Python 3 6 5 final
@anchor{whatsnew/changelog id519}@anchor{1ad6}
@subsubsection Build



@itemize -

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: Upgrade pip to 9.0.3 and setuptools to v39.0.1.
@end itemize

@node Python 3 6 5 release candidate 1,Python 3 6 4 final,Python 3 6 5 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-5-release-candidate-1}@anchor{1ad7}
@subsection Python 3.6.5 release candidate 1


`Release date: 2018-03-13'

@menu
* Security: Security<36>. 
* Core and Builtins: Core and Builtins<57>. 
* Library: Library<58>. 
* Documentation: Documentation<56>. 
* Tests: Tests<54>. 
* Build: Build<56>. 
* Windows: Windows<53>. 
* macOS: macOS<43>. 
* IDLE: IDLE<43>. 
* Tools/Demos: Tools/Demos<32>. 
* C API: C API<52>. 

@end menu

@node Security<36>,Core and Builtins<57>,,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id520}@anchor{1ad8}
@subsubsection Security



@itemize -

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Minimal fix to prevent buffer overrun in os.symlink on Windows

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: Regexes in difflib and poplib were vulnerable to catastrophic
backtracking. These regexes formed potential DOS vectors (REDOS). They
have been refactored. This resolves 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} and 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}.
Patch by Jamie Davis.
@end itemize

@node Core and Builtins<57>,Library<58>,Security<36>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id521}@anchor{1ad9}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: Fixed jumping out of «with» block by setting f_lineno.

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: Prevent jumps from “return” and “exception” trace events.

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: Update Valgrind suppression list to account for the rename of
@code{Py_ADDRESS_IN_RANG} to @code{address_in_range}.

@item 
bpo-32650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32650}: Pdb and other debuggers dependent on bdb.py will correctly step
over (next command) native coroutines. Patch by Pablo Galindo.

@item 
bpo-32685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32685}: Improve suggestion when the Python 2 form of print statement is
either present on the same line as the header of a compound statement or
else terminated by a semi-colon instead of a newline. Patch by Nitish
Chandra.

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: Fix possible crashing in builtin Unicode decoders caused by
write out-of-bound errors when using customized decode error handlers.

@item 
bpo-26163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26163}: Improved frozenset() hash to create more distinct hash values
when faced with datasets containing many similar values.

@item 
bpo-27169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27169}: The @code{__debug__} constant is now optimized out at compile
time. This fixes also bpo-22091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22091}.

@item 
bpo-32329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32329}: @code{sys.flags.hash_randomization} is now properly set to 0 when
hash randomization is turned off by @code{PYTHONHASHSEED=0}.

@item 
bpo-30416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30416}: The optimizer is now protected from spending much time doing
complex calculations and consuming much memory for creating large
constants in constant folding.

@item 
bpo-18533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18533}: @code{repr()} on a dict containing its own @code{values()} or
@code{items()} no longer raises @code{RecursionError}; OrderedDict similarly.
Instead, use @code{...}, as for other recursive structures.  Patch by Ben
North.

@item 
bpo-32028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32028}: Leading whitespace is now correctly ignored when generating
suggestions for converting Py2 print statements to Py3 builtin print
function calls. Patch by Sanyam Khurana.

@item 
bpo-32137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32137}: The repr of deeply nested dict now raises a RecursionError
instead of crashing due to a stack overflow.
@end itemize

@node Library<58>,Documentation<56>,Core and Builtins<57>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id522}@anchor{1ada}
@subsubsection Library



@itemize -

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3 now properly supports trailing commas after @code{*args}
and @code{**kwargs} in function signatures.

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: Avoid failing in multiprocessing.Process if the standard
streams are closed or None at exit.

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: Skip sending/receiving data after SSL transport closing.

@item 
bpo-30353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30353}: Fix ctypes pass-by-value for structs on 64-bit Cygwin/MinGW.

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: Fix inspect.signature() for single-parameter partialmethods.

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: Expose several missing constants in zlib and fix corresponding
documentation.

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: Fixed tarfile.itn handling of out-of-bounds float values. Patch
by Joffrey Fuhrer.

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: The ssl module now detects missing NPN support in LibreSSL.

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open() now encodes filename with the filesystem encoding
rather than default encoding.

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: In @code{os.dup2}, don’t check every call whether the @code{dup3}
syscall exists or not.

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: Rewrite confusing message from setup.py upload from «No dist
file created in earlier command» to the more helpful «Must create and
upload files in one command».

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: In @ref{f0,,tkinter}, @code{after_cancel(None)} now raises a
@ref{360,,ValueError} instead of canceling the first scheduled function.
Patch by Cheryl Sabella.

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: Make sure sys.argv remains as a list when running trace.

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: Fixed @code{asyncio.Condition} issue which silently ignored
cancellation after notifying and cancelling a conditional lock. Patch by
Bar Harel.

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: Fixed refleaks of @code{__init__()} methods in various modules.
(Contributed by Oren Milman)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: Fixed guessing quote and delimiter in csv.Sniffer.sniff() when
only the last field is quoted.  Patch by Jake Davis.

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: Remove TCP_FASTOPEN, TCP_KEEPCNT flags on older version
Windows during run-time.

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: Fix a rare but potential pre-exec child process deadlock in
subprocess on POSIX systems when marking file descriptors inheritable on
exec in the child process.  This bug appears to have been introduced in
3.4.

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: The ctypes module used to depend on indirect linking for
dlopen. The shared extension is now explicitly linked against libdl on
platforms with dl.

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: Fixed @code{asyncio.Lock()} safety issue which allowed acquiring
and locking the same lock multiple times, without it being free. Patch by
Bar Harel.

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: Do not include name field in SMTP envelope from address. Patch
by Stéphane Wirtel

@item 
bpo-27931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27931}: Fix email address header parsing error when the username is an
empty quoted string. Patch by Xiang Zhang.

@item 
bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304}: distutils” upload command no longer corrupts tar files ending
with a CR byte, and no longer tries to convert CR to CRLF in any of the
upload text fields.

@item 
bpo-32502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32502}: uuid.uuid1 no longer raises an exception if a 64-bit hardware
address is encountered.

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: Fix the error handling in Aifc_read.initfp() when the SSND
chunk is not found. Patch by Zackery Spytz.

@item 
bpo-32555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32555}: On FreeBSD and Solaris, os.strerror() now always decode the
byte string from the current locale encoding, rather than using
ASCII/surrogateescape in some cases.

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: The nis module is now compatible with new libnsl and headers
location.

@item 
bpo-32473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32473}: Improve ABCMeta._dump_registry() output readability

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: glibc has removed Sun RPC. Use replacement libtirpc headers and
library in nis module.

@item 
bpo-32228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32228}: Ensure that @code{truncate()} preserves the file position (as
reported by @code{tell()}) after writes longer than the buffer size.

@item 
bpo-26133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26133}: Don’t unsubscribe signals in asyncio UNIX event loop on
interpreter shutdown.

@item 
bpo-32185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32185}: The SSL module no longer sends IP addresses in SNI TLS
extension on platforms with OpenSSL 1.0.2+ or inet_pton.

@item 
bpo-32323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32323}: @ref{dc6,,urllib.parse.urlsplit()} does not convert zone-id (scope)
to lower case for scoped IPv6 addresses in hostnames now.

@item 
bpo-32302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32302}: Fix bdist_wininst of distutils for CRT v142: it binary
compatible with CRT v140.

@item 
bpo-32255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32255}: A single empty field is now always quoted when written into a
CSV file. This allows to distinguish an empty row from a row consisting of
a single empty field. Patch by Licht Takeuchi.

@item 
bpo-32277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32277}: Raise @code{NotImplementedError} instead of @code{SystemError} on
platforms where @code{chmod(..., follow_symlinks=False)} is not supported.
Patch by Anthony Sottile.

@item 
bpo-32199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32199}: The getnode() ip getter now uses “ip link” instead of “ip link
list”.

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: Ensure TCP_NODELAY is set on Linux. Tests by Victor Stinner.

@item 
bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}: The @ref{c86,,locale.localeconv()} function now sets temporarily the
@code{LC_CTYPE} locale to the @code{LC_NUMERIC} locale to decode
@code{decimal_point} and @code{thousands_sep} byte strings if they are non-ASCII
or longer than 1 byte, and the @code{LC_NUMERIC} locale is different than the
@code{LC_CTYPE} locale. This temporary change affects other threads. Same
change for the @ref{6c2,,str.format()} method when formatting a number
(@ref{1f0,,int}, @ref{153,,float}, @ref{153,,float} and subclasses) with the
@code{n} type (ex: @code{'@{:n@}'.format(1234)}).

@item 
bpo-31802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31802}: Importing native path module (@code{posixpath}, @code{ntpath}) now
works even if the @code{os} module still is not imported.
@end itemize

@node Documentation<56>,Tests<54>,Library<58>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id523}@anchor{1adb}
@subsubsection Documentation



@itemize -

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: Clarify docs for -O and -OO.  Patch by Terry Reedy.

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: Update link to w3c doc for xml default namespaces.

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: Document @code{__getattr__()} behavior when property @code{get()}
method raises @ref{441,,AttributeError}.

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: Modify RE examples in documentation to use raw strings to
prevent @ref{1da,,DeprecationWarning} and add text to REGEX HOWTO to highlight
the deprecation.

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: Improve docstrings for @code{pathlib.PurePath} subclasses.

@item 
bpo-17799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17799}: Explain real behaviour of sys.settrace and sys.setprofile and
their C-API counterparts regarding which type of events are received in
each function. Patch by Pablo Galindo Salgado.
@end itemize

@node Tests<54>,Build<56>,Documentation<56>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id524}@anchor{1adc}
@subsubsection Tests



@itemize -

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: Fix failing @code{test_asyncio} on macOS 10.12.2+ due to transport
of @code{KqueueSelector} loop was not being closed.

@item 
bpo-32721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32721}: Fix test_hashlib to not fail if the _md5 module is not built.

@item 
bpo-32252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32252}: Fix faulthandler_suppress_crash_report() used to prevent core
dump files when testing crashes. getrlimit() returns zero on success.

@item 
bpo-31518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31518}: Debian Unstable has disabled TLS 1.0 and 1.1 for
SSLv23_METHOD(). Change TLS/SSL protocol of some tests to PROTOCOL_TLS or
PROTOCOL_TLSv1_2 to make them pass on Debian.
@end itemize

@node Build<56>,Windows<53>,Tests<54>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id525}@anchor{1add}
@subsubsection Build



@itemize -

@item 
bpo-32635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32635}: Fix segfault of the crypt module when libxcrypt is provided
instead of libcrypt at the system.
@end itemize

@node Windows<53>,macOS<43>,Build<56>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id526}@anchor{1ade}
@subsubsection Windows



@itemize -

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: Fix potential use of uninitialized memory in
nt._getfinalpathname

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: Fix a memory leak in os.chdir() on Windows if the current
directory is set to a UNC path.

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: Fixed WindowsConsoleIO.write() for writing empty data.

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: Ensures activate.bat can handle Unicode contents.

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: Improves handling of denormalized executable path when
launching Python.

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: Use the correct encoding for ipconfig output in the uuid
module. Patch by Segev Finer.

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: Fix @ref{9b4,,os.readlink()} on Windows, which was mistakenly
treating the @code{PrintNameOffset} field of the reparse data buffer as a
number of characters instead of bytes. Patch by Craig Holmquist and SSE4.

@item 
bpo-32588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32588}: Create standalone _distutils_findvs module.
@end itemize

@node macOS<43>,IDLE<43>,Windows<53>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id527}@anchor{1adf}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: Provide an additional, more modern macOS installer variant that
supports macOS 10.9+ systems in 64-bit mode only. Upgrade the supplied
third-party libraries to OpenSSL 1.0.2n, XZ 5.2.3, and SQLite 3.22.0. The
10.9+ installer now links with and supplies its own copy of Tcl/Tk 8.6.8.
@end itemize

@node IDLE<43>,Tools/Demos<32>,macOS<43>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id528}@anchor{1ae0}
@subsubsection IDLE



@itemize -

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: Set @code{__file__} while running a startup file.  Like Python,
IDLE optionally runs one startup file in the Shell window before
presenting the first interactive input prompt.  For IDLE, @code{-s} runs a
file named in environmental variable  
@geindex IDLESTARTUP
@geindex variables de entorno; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}; @code{-r file} runs @code{file}.  Python sets
@code{__file__} to the startup file name before running the file and unsets
it before the first prompt.  IDLE now does the same when run normally,
without the @code{-n} option.

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: Simplify and rename StringTranslatePseudoMapping in pyparse.

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: Change @code{str} to @code{code} in pyparse.

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: Remove unused code in pyparse module.

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: Add tests for pyparse.

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: Using the system and place-dependent default encoding for
open() is a bad idea for IDLE’s system and location-independent files.

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: Add «encoding=utf-8» to open() in IDLE’s test_help_about. GUI
test test_file_buttons() only looks at initial ascii-only lines, but
failed on systems where open() defaults to “ascii” because readline()
internally reads and decodes far enough ahead to encounter a non-ascii
character in CREDITS.txt.

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: Update configdialog General tab docstring to add new widgets to
the widget list.
@end itemize

@node Tools/Demos<32>,C API<52>,IDLE<43>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id529}@anchor{1ae1}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-24960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24960}: 2to3 and lib2to3 can now read pickled grammar files using
pkgutil.get_data() rather than probing the filesystem. This lets 2to3 and
lib2to3 work when run from a zipfile.

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: Fix pygettext not extracting docstrings for functions with type
annotated arguments. Patch by Toby Harradine.
@end itemize

@node C API<52>,,Tools/Demos<32>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id530}@anchor{1ae2}
@subsubsection C API



@itemize -

@item 
bpo-29084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29084}: Undocumented C API for OrderedDict has been excluded from the
limited C API. It was added by mistake and actually never worked in the
limited C API.
@end itemize

@node Python 3 6 4 final,Python 3 6 4 release candidate 1,Python 3 6 5 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-4-final}@anchor{1ae3}
@subsection Python 3.6.4 final


`Release date: 2017-12-18'

There were no new code changes in version 3.6.4 since v3.6.4rc1.

@node Python 3 6 4 release candidate 1,Python 3 6 3 final,Python 3 6 4 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-4-release-candidate-1}@anchor{1ae4}
@subsection Python 3.6.4 release candidate 1


`Release date: 2017-12-05'

@menu
* Core and Builtins: Core and Builtins<58>. 
* Library: Library<59>. 
* Documentation: Documentation<57>. 
* Tests: Tests<55>. 
* Build: Build<57>. 
* Windows: Windows<54>. 
* macOS: macOS<44>. 
* IDLE: IDLE<44>. 
* Tools/Demos: Tools/Demos<33>. 
* C API: C API<53>. 

@end menu

@node Core and Builtins<58>,Library<59>,,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id531}@anchor{1ae5}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-32176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32176}: co_flags.CO_NOFREE is now always set correctly by the code
object constructor based on freevars and cellvars, rather than needing to
be set correctly by the caller. This ensures it will be cleared
automatically when additional cell references are injected into a modified
code object and function.

@item 
bpo-31949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31949}: Fixed several issues in printing tracebacks
(PyTraceBack_Print()). Setting sys.tracebacklimit to 0 or less now
suppresses printing tracebacks. Setting sys.tracebacklimit to None now
causes using the default limit. Setting sys.tracebacklimit to an integer
larger than LONG_MAX now means using the limit LONG_MAX rather than the
default limit. Fixed integer overflows in the case of more than @code{2**31}
traceback items on Windows. Fixed output errors handling.

@item 
bpo-30696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30696}: Fix the interactive interpreter looping endlessly when no
memory.

@item 
bpo-20047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20047}: Bytearray methods partition() and rpartition() now accept only
bytes-like objects as separator, as documented.  In particular they now
raise TypeError rather of returning a bogus result when an integer is
passed as a separator.

@item 
bpo-31852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31852}: Fix a segmentation fault caused by a combination of the async
soft keyword and continuation lines.

@item 
bpo-21720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21720}: BytesWarning no longer emitted when the `fromlist' argument of
@code{__import__()} or the @code{__all__} attribute of the module contain bytes
instances.

@item 
bpo-31825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31825}: Fixed OverflowError in the “unicode-escape” codec and in
codecs.escape_decode() when decode an escaped non-ascii byte.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: Print the full context/cause chain of exceptions on interpreter
exit, even if an exception in the chain is unhashable or compares equal to
later ones. Patch by Zane Bitter.

@item 
bpo-31786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31786}: Fix timeout rounding in the select module to round correctly
negative timeouts between -1.0 and 0.0. The functions now block waiting
for events as expected. Previously, the call was incorrectly non-blocking.
Patch by Pablo Galindo.

@item 
bpo-31642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31642}: Restored blocking «from package import module» by setting
sys.modules[«package.module»] to None.

@item 
bpo-31626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31626}: Fixed a bug in debug memory allocator.  There was a write to
freed memory after shrinking a memory block.

@item 
bpo-31619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31619}: Fixed a ValueError when convert a string with large number of
underscores to integer with binary base.

@item 
bpo-31592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31592}: Fixed an assertion failure in Python parser in case of a bad
@code{unicodedata.normalize()}. Patch by Oren Milman.

@item 
bpo-31588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31588}: Raise a @code{TypeError} with a helpful error message when class
creation fails due to a metaclass with a bad @code{__prepare__()} method.
Patch by Oren Milman.

@item 
bpo-31566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31566}: Fix an assertion failure in @code{_warnings.warn()} in case of a
bad @code{__name__} global. Patch by Oren Milman.

@item 
bpo-31505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31505}: Fix an assertion failure in @code{json}, in case
@code{_json.make_encoder()} received a bad @code{encoder()} argument. Patch by
Oren Milman.

@item 
bpo-31492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31492}: Fix assertion failures in case of failing to import from a
module with a bad @code{__name__} attribute, and in case of failing to access
an attribute of such a module. Patch by Oren Milman.

@item 
bpo-31490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31490}: Fix an assertion failure in @code{ctypes} class definition, in
case the class has an attribute whose name is specified in @code{_anonymous_}
but not in @code{_fields_}. Patch by Oren Milman.

@item 
bpo-31478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31478}: Fix an assertion failure in @code{_random.Random.seed()} in case
the argument has a bad @code{__abs__()} method. Patch by Oren Milman.

@item 
bpo-31315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31315}: Fix an assertion failure in imp.create_dynamic(), when
spec.name is not a string. Patch by Oren Milman.

@item 
bpo-31311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31311}: Fix a crash in the @code{__setstate__()} method of
@code{ctypes._CData}, in case of a bad @code{__dict__}. Patch by Oren Milman.

@item 
bpo-31293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31293}: Fix crashes in true division and multiplication of a timedelta
object by a float with a bad as_integer_ratio() method. Patch by Oren
Milman.

@item 
bpo-31285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31285}: Fix an assertion failure in @code{warnings.warn_explicit}, when
the return value of the received loader’s @code{get_source()} has a bad
@code{splitlines()} method. Patch by Oren Milman.

@item 
bpo-30817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30817}: @code{PyErr_PrintEx()} clears now the ignored exception that may
be raised by @code{_PySys_SetObjectId()}, for example when no memory.
@end itemize

@node Library<59>,Documentation<57>,Core and Builtins<58>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id532}@anchor{1ae6}
@subsubsection Library



@itemize -

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Two minor fixes for @code{typing} module: allow shallow copying
instances of generic classes, improve interaction of @code{__init_subclass__}
with generics. Original PRs by Ivan Levkivskyi.

@item 
bpo-27240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27240}: The header folding algorithm for the new email policies has
been rewritten, which also fixes bpo-30788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30788}, bpo-31831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31831}, and bpo-32182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32182}.  In
particular, RFC2231 folding is now done correctly.

@item 
bpo-32186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32186}: io.FileIO.readall() and io.FileIO.read() now release the GIL
when getting the file size. Fixed hang of all threads with inaccessible
NFS server. Patch by Nir Soffer.

@item 
bpo-12239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12239}: Make @code{msilib.SummaryInformation.GetProperty()} return
@code{None} when the value of property is @code{VT_EMPTY}.  Initial patch by
Mark Mc Mahon.

@item 
bpo-31325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31325}: Fix wrong usage of @ref{32d,,collections.namedtuple()} in the
@ref{1aa9,,RobotFileParser.parse()}
method. Initial patch by Robin Wellner.

@item 
bpo-12382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12382}: @code{msilib.OpenDatabase()} now raises a better exception
message when it couldn’t open or create an MSI file.  Initial patch by
William Tisäter.

@item 
bpo-32110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32110}: @code{codecs.StreamReader.read(n)} now returns not more than `n'
characters/bytes for non-negative `n'. This makes it compatible with
@code{read()} methods of other file-like objects.

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: Fixed issues with binary plists: Fixed saving bytearrays.
Identical objects will be saved only once. Equal references will be load
as identical objects. Added support for saving and loading recursive data
structures.

@item 
bpo-32034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32034}: Make asyncio.IncompleteReadError and LimitOverrunError
pickleable.

@item 
bpo-32015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32015}: Fixed the looping of asyncio in the case of reconnection the
socket during waiting async read/write from/to the socket.

@item 
bpo-32011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32011}: Restored support of loading marshal files with the TYPE_INT64
code. These files can be produced in Python 2.7.

@item 
bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}: Reduce performance overhead of asyncio debug mode.

@item 
bpo-9678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9678}: Fixed determining the MAC address in the uuid module: Using
ifconfig on NetBSD and OpenBSD. Using arp on Linux, FreeBSD, NetBSD and
OpenBSD. Based on patch by Takayuki Shimizukawa.

@item 
bpo-30057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30057}: Fix potential missed signal in signal.signal().

@item 
bpo-31933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31933}: Fix Blake2 params leaf_size and node_offset on big endian
platforms. Patch by Jack O’Connor.

@item 
bpo-31927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31927}: Fixed compilation of the socket module on NetBSD 8.  Fixed
assertion failure or reading arbitrary data when parse a AF_BLUETOOTH
address on NetBSD and DragonFly BSD.

@item 
bpo-27666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27666}: Fixed stack corruption in curses.box() and curses.ungetmouse()
when the size of types chtype or mmask_t is less than the size of C long.
curses.box() now accepts characters as arguments.  Based on patch by Steve
Fink.

@item 
bpo-31897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31897}: plistlib now catches more errors when read binary plists and
raises InvalidFileException instead of unexpected exceptions.

@item 
bpo-25720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25720}: Fix the method for checking pad state of curses WINDOW. Patch
by Masayuki Yamamoto.

@item 
bpo-31893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31893}: Fixed the layout of the kqueue_event structure on OpenBSD and
NetBSD. Fixed the comparison of the kqueue_event objects.

@item 
bpo-31891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31891}: Fixed building the curses module on NetBSD.

@item 
bpo-28416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28416}: Instances of pickle.Pickler subclass with the persistent_id()
method and pickle.Unpickler subclass with the persistent_load() method no
longer create reference cycles.

@item 
bpo-28326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28326}: Fix multiprocessing.Process when stdout and/or stderr is closed
or None.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: If nested log adapters are used, the inner @code{process()}
methods are no longer omitted.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: The @code{manager} property on LoggerAdapter objects is now
properly settable.

@item 
bpo-31806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31806}: Fix timeout rounding in time.sleep(), threading.Lock.acquire()
and socket.socket.settimeout() to round correctly negative timeouts
between -1.0 and 0.0. The functions now block waiting for events as
expected. Previously, the call was incorrectly non-blocking. Patch by
Pablo Galindo.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: traceback: Fix a TypeError that occurred during printing of
exception tracebacks when either the current exception or an exception in
its context/cause chain is unhashable. Patch by Zane Bitter.

@item 
bpo-30058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30058}: Fixed buffer overflow in select.kqueue.control().

@item 
bpo-31770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31770}: Prevent a crash when calling the @code{__init__()} method of a
@code{sqlite3.Cursor} object more than once. Patch by Oren Milman.

@item 
bpo-31672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31672}: @code{idpattern} in @code{string.Template} matched some non-ASCII
characters. Now it uses @code{-i} regular expression local flag to avoid
non-ASCII characters.

@item 
bpo-31764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31764}: Prevent a crash in @code{sqlite3.Cursor.close()} in case the
@code{Cursor} object is uninitialized. Patch by Oren Milman.

@item 
bpo-31752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31752}: Fix possible crash in timedelta constructor called with custom
integers.

@item 
bpo-31701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31701}: On Windows, faulthandler.enable() now ignores MSC and COM
exceptions.

@item 
bpo-31728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31728}: Prevent crashes in @code{_elementtree} due to unsafe cleanup of
@code{Element.text} and @code{Element.tail}. Patch by Oren Milman.

@item 
bpo-31620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31620}: an empty asyncio.Queue now doesn’t leak memory when queue.get
pollers timeout

@item 
bpo-31632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31632}: Fix method set_protocol() of class _SSLProtocolTransport in
asyncio module. This method was previously modifying a wrong reference to
the protocol.

@item 
bpo-31675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31675}: Fixed memory leaks in Tkinter’s methods splitlist() and split()
when pass a string larger than 2 GiB.

@item 
bpo-31673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31673}: Fixed typo in the name of Tkinter’s method adderrorinfo().

@item 
bpo-30806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30806}: Fix the string representation of a netrc object.

@item 
bpo-15037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15037}: Added a workaround for getkey() in curses for ncurses 5.7 and
earlier.

@item 
bpo-25351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25351}: Avoid venv activate failures with undefined variables

@item 
bpo-25532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25532}: inspect.unwrap() will now only try to unwrap an object
sys.getrecursionlimit() times, to protect against objects which create a
new object on every attribute access.

@item 
bpo-30347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30347}: Stop crashes when concurrently iterate over itertools.groupby()
iterators.

@item 
bpo-31516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31516}: @code{threading.current_thread()} should not return a dummy thread
at shutdown.

@item 
bpo-31351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31351}: python -m ensurepip now exits with non-zero exit code if pip
bootstrapping has failed.

@item 
bpo-31482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31482}: @code{random.seed()} now works with bytes in version=1

@item 
bpo-31334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31334}: Fix @code{poll.poll([timeout])} in the @code{select} module for
arbitrary negative timeouts on all OSes where it can only be a
non-negative integer or -1. Patch by Riccardo Coccioli.

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: multiprocessing’s semaphore tracker should be launched again if
crashed.

@item 
bpo-31308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31308}: Make multiprocessing’s forkserver process immune to Ctrl-C and
other user interruptions. If it crashes, restart it when necessary.
@end itemize

@node Documentation<57>,Tests<55>,Library<59>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id533}@anchor{1ae7}
@subsubsection Documentation



@itemize -

@item 
bpo-32105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32105}: Added asyncio.BaseEventLoop.connect_accepted_socket
versionadded marker.

@item 
bpo-31537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31537}: Fix incorrect usage of @code{get_history_length} in readline
documentation example code. Patch by Brad Smith.

@item 
bpo-30085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30085}: The operator functions without double underscores are preferred
for clarity. The one with underscores are only kept for
back-compatibility.
@end itemize

@node Tests<55>,Build<57>,Documentation<57>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id534}@anchor{1ae8}
@subsubsection Tests



@itemize -

@item 
bpo-31380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31380}: Skip test_httpservers test_undecodable_file on macOS: fails on
APFS.

@item 
bpo-31705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31705}: Skip test_socket.test_sha256() on Linux kernel older than 4.5.
The test fails with ENOKEY on kernel 3.10 (on ppc64le). A fix was merged
into the kernel 4.5.

@item 
bpo-31174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31174}: Fix test_tools.test_unparse: DirectoryTestCase now stores the
names sample to always test the same files. It prevents false alarms when
hunting reference leaks.

@item 
bpo-30695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30695}: Add the @code{set_nomemory(start, stop)} and
@code{remove_mem_hooks()} functions to the @code{_testcapi} module.
@end itemize

@node Build<57>,Windows<54>,Tests<55>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id535}@anchor{1ae9}
@subsubsection Build



@itemize -

@item 
bpo-32059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32059}: @code{detect_modules()} in @code{setup.py} now also searches the
sysroot paths when cross-compiling.

@item 
bpo-31957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31957}: Fixes Windows SDK version detection when building for Windows.

@item 
bpo-31609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31609}: Fixes quotes in PCbuild/clean.bat

@item 
bpo-31934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31934}: Abort the build when building out of a not clean source tree.

@item 
bpo-31926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31926}: Fixed Argument Clinic sometimes causing compilation errors when
there was more than one function and/or method in a .c file with the same
name.

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: Update Windows builds to use SQLite 3.21.0.

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: Update OS X installer to use SQLite 3.21.0.

@item 
bpo-22140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22140}: Prevent double substitution of prefix in python-config.sh.

@item 
bpo-31536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31536}: Avoid wholesale rebuild after @code{make regen-all} if nothing
changed.
@end itemize

@node Windows<54>,macOS<44>,Build<57>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id536}@anchor{1aea}
@subsubsection Windows



@itemize -

@item 
bpo-1102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1102}: Return @code{None} when @code{View.Fetch()} returns
@code{ERROR_NO_MORE_ITEMS} instead of raising @code{MSIError}. Initial patch by
Anthony Tuininga.

@item 
bpo-31944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31944}: Fixes Modify button in Apps and Features dialog.
@end itemize

@node macOS<44>,IDLE<44>,Windows<54>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id537}@anchor{1aeb}
@subsubsection macOS



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: Update macOS installer to use OpenSSL 1.0.2m
@end itemize

@node IDLE<44>,Tools/Demos<33>,macOS<44>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id538}@anchor{1aec}
@subsubsection IDLE



@itemize -

@item 
bpo-32207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32207}: Improve tk event exception tracebacks in IDLE. When tk event
handling is driven by IDLE’s run loop, a confusing and distracting
queue.EMPTY traceback context is no longer added to tk event exception
tracebacks.  The traceback is now the same as when event handling is
driven by user code.  Patch based on a suggestion by Serhiy Storchaka.

@item 
bpo-32164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32164}: Delete unused file idlelib/tabbedpages.py. Use of TabbedPageSet
in configdialog was replaced by ttk.Notebook.

@item 
bpo-32100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32100}: IDLE: Fix old and new bugs in pathbrowser; improve tests. Patch
mostly by Cheryl Sabella.

@item 
bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858}: IDLE – Restrict shell prompt manipulation to the shell. Editor
and output windows only see an empty last prompt line.  This simplifies
the code and fixes a minor bug when newline is inserted. Sys.ps1, if
present, is read on Shell start-up, but is not set or changed.

@item 
bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}: The font sample in the IDLE configuration dialog is now
editable. Changes persist while IDLE remains open

@item 
bpo-31836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31836}: Test_code_module now passes if run after test_idle, which sets
ps1. The code module uses sys.ps1 if present or sets it to “>>> “ if not.
Test_code_module now properly tests both behaviors.  Ditto for ps2.

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: Fix a TypeError that caused a shell restart when printing a
traceback that includes an exception that is unhashable. Patch by Zane
Bitter.

@item 
bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}: Use non-Latin characters in the IDLE’s Font settings sample.
Even if one selects a font that defines a limited subset of the unicode
Basic Multilingual Plane, tcl/tk will use other fonts that define a
character. The expanded example give users of non-Latin characters a
better idea of what they might see in IDLE’s shell and editors. To make
room for the expanded sample, frames on the Font tab are re-arranged. The
Font/Tabs help explains a bit about the additions.

@item 
bpo-31460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31460}: Simplify the API of IDLE’s Module Browser. Passing a widget
instead of an flist with a root widget opens the option of creating a
browser frame that is only part of a window.  Passing a full file name
instead of pieces assumed to come from a .py file opens the possibility of
browsing python files that do not end in .py.

@item 
bpo-31649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31649}: IDLE - Make _htest, _utest parameters keyword only.

@item 
bpo-31559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31559}: Remove test order dependence in idle_test.test_browser.

@item 
bpo-31459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31459}: Rename IDLE’s module browser from Class Browser to Module
Browser. The original module-level class and method browser became a
module browser, with the addition of module-level functions, years ago.
Nested classes and functions were added yesterday.  For
back-compatibility, the virtual event <<open-class-browser>>, which
appears on the Keys tab of the Settings dialog, is not changed. Patch by
Cheryl Sabella.

@item 
bpo-31500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31500}: Default fonts now are scaled on HiDPI displays.

@item 
bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}: IDLE module browser now shows nested classes and functions.
Original patches for code and tests by Guilherme Polo and Cheryl Sabella,
respectively.
@end itemize

@node Tools/Demos<33>,C API<53>,IDLE<44>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id539}@anchor{1aed}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-30722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30722}: Make redemo work with Python 3.6 and newer versions. Also,
remove the @code{LOCALE} option since it doesn’t work with string patterns in
Python 3. Patch by Christoph Sarnowski.
@end itemize

@node C API<53>,,Tools/Demos<33>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id540}@anchor{1aee}
@subsubsection C API



@itemize -

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: Fix PyGILState_Ensure(). When PyGILState_Ensure() is called in
a non-Python thread before PyEval_InitThreads(), only call
PyEval_InitThreads() after calling PyThreadState_New() to fix a crash.

@item 
bpo-31532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31532}: Fix memory corruption due to allocator mix in getpath.c between
Py_GetPath() and Py_SetPath()

@item 
bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}: The @code{PyExc_RecursionErrorInst} singleton is removed and
@code{PyErr_NormalizeException()} does not use it anymore. This singleton is
persistent and its members being never cleared may cause a segfault during
finalization of the interpreter. See also bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898}.
@end itemize

@node Python 3 6 3 final,Python 3 6 3 release candidate 1,Python 3 6 4 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-3-final}@anchor{1aef}
@subsection Python 3.6.3 final


`Release date: 2017-10-03'

@menu
* Library: Library<60>. 
* Build: Build<58>. 

@end menu

@node Library<60>,Build<58>,,Python 3 6 3 final
@anchor{whatsnew/changelog id541}@anchor{1af0}
@subsubsection Library



@itemize -

@item 
bpo-31641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31641}: Re-allow arbitrary iterables in
@code{concurrent.futures.as_completed()}. Fixes regression in 3.6.3rc1.
@end itemize

@node Build<58>,,Library<60>,Python 3 6 3 final
@anchor{whatsnew/changelog id542}@anchor{1af1}
@subsubsection Build



@itemize -

@item 
bpo-31662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31662}: Fix typos in Windows @code{uploadrelease.bat} script. Fix Windows
Doc build issues in @code{Doc/make.bat}.

@item 
bpo-31423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31423}: Fix building the PDF documentation with newer versions of
Sphinx.
@end itemize

@node Python 3 6 3 release candidate 1,Python 3 6 2 final,Python 3 6 3 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-3-release-candidate-1}@anchor{1af2}
@subsection Python 3.6.3 release candidate 1


`Release date: 2017-09-18'

@menu
* Security: Security<37>. 
* Core and Builtins: Core and Builtins<59>. 
* Library: Library<61>. 
* Documentation: Documentation<58>. 
* Tests: Tests<56>. 
* Build: Build<59>. 
* Windows: Windows<55>. 
* IDLE: IDLE<45>. 
* Tools/Demos: Tools/Demos<34>. 

@end menu

@node Security<37>,Core and Builtins<59>,,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id543}@anchor{1af3}
@subsubsection Security



@itemize -

@item 
bpo-29781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29781}: SSLObject.version() now correctly returns None when handshake
over BIO has not been performed yet.

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to
get security fixes.
@end itemize

@node Core and Builtins<59>,Library<61>,Security<37>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id544}@anchor{1af4}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-31471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31471}: Fix an assertion failure in @code{subprocess.Popen()} on Windows,
in case the env argument has a bad @code{keys()} method. Patch by Oren
Milman.

@item 
bpo-31418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31418}: Fix an assertion failure in @code{PyErr_WriteUnraisable()} in case
of an exception with a bad @code{__module__} attribute. Patch by Oren Milman.

@item 
bpo-31416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31416}: Fix assertion failures in case of a bad warnings.filters or
warnings.defaultaction. Patch by Oren Milman.

@item 
bpo-31411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31411}: Raise a TypeError instead of SystemError in case
warnings.onceregistry is not a dictionary. Patch by Oren Milman.

@item 
bpo-31373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31373}: Fix several possible instances of undefined behavior due to
floating-point demotions.

@item 
bpo-30465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30465}: Location information (@code{lineno} and @code{col_offset}) in
f-strings is now (mostly) correct.  This fixes tools like flake8 from
showing warnings on the wrong line (typically the first line of the file).

@item 
bpo-31343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31343}: Include sys/sysmacros.h for major(), minor(), and makedev().
GNU C library plans to remove the functions from sys/types.h.

@item 
bpo-31291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31291}: Fix an assertion failure in @code{zipimport.zipimporter.get_data}
on Windows, when the return value of @code{pathname.replace('/','\\')} isn’t
a string. Patch by Oren Milman.

@item 
bpo-31271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31271}: Fix an assertion failure in the @code{write()} method of
@code{io.TextIOWrapper}, when the encoder doesn’t return a bytes object.
Patch by Oren Milman.

@item 
bpo-31243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31243}: Fix a crash in some methods of @code{io.TextIOWrapper}, when the
decoder’s state is invalid. Patch by Oren Milman.

@item 
bpo-30721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30721}: @code{print} now shows correct usage hint for using Python 2
redirection syntax.  Patch by Sanyam Khurana.

@item 
bpo-31070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31070}: Fix a race condition in importlib _get_module_lock().

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: Fix potential crash during GC caused by @code{tp_dealloc} which
doesn’t call @code{PyObject_GC_UnTrack()}.

@item 
bpo-31071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31071}: Avoid masking original TypeError in call with * unpacking when
other arguments are passed.

@item 
bpo-30978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30978}: str.format_map() now passes key lookup exceptions through.
Previously any exception was replaced with a KeyError exception.

@item 
bpo-30808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30808}: Use _Py_atomic API for concurrency-sensitive signal state.

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: Relative import from unloaded package now reimports the package
instead of failing with SystemError.  Relative import from non-package now
fails with ImportError rather than SystemError.

@item 
bpo-30703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30703}: Improve signal delivery. Avoid using Py_AddPendingCall from
signal handler, to avoid calling signal-unsafe functions. The tests I’m
adding here fail without the rest of the patch, on Linux and OS X. This
means our signal delivery logic had defects (some signals could be lost).

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: Avoid blocking in pthread_mutex_lock() when
PyThread_acquire_lock() is asked not to block.

@item 
bpo-31161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31161}: Make sure the “Missing parentheses” syntax error message is
only applied to SyntaxError, not to subclasses. Patch by Martijn Pieters.

@item 
bpo-30814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30814}: Fixed a race condition when import a submodule from a package.

@item 
bpo-30597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30597}: @code{print} now shows expected input in custom error message when
used as a Python 2 statement. Patch by Sanyam Khurana.
@end itemize

@node Library<61>,Documentation<58>,Core and Builtins<59>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id545}@anchor{1af5}
@subsubsection Library



@itemize -

@item 
bpo-31499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31499}: xml.etree: Fix a crash when a parser is part of a reference
cycle.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing.get_type_hints now finds the right globalns for classes
and modules by default (when no @code{globalns} was specified by the caller).

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Speed improvements to the @code{typing} module.  Original PRs by
Ivan Levkivskyi and Mitar.

@item 
bpo-31544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31544}: The C accelerator module of ElementTree ignored exceptions
raised when looking up TreeBuilder target methods in XMLParser().

@item 
bpo-31234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31234}: socket.create_connection() now fixes manually a reference
cycle: clear the variable storing the last exception on success.

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter objects can now be nested.

@item 
bpo-31400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31400}: Improves SSL error handling to avoid losing error numbers.

@item 
bpo-28958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28958}: ssl.SSLContext() now uses OpenSSL error information when a
context cannot be instantiated.

@item 
bpo-27340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27340}: SSLSocket.sendall() now uses memoryview to create slices of
data. This fixes support for all bytes-like object. It is also more
efficient and avoids costly copies.

@item 
bpo-31178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31178}: Fix string concatenation bug in rare error path in the
subprocess module

@item 
bpo-31350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31350}: Micro-optimize @code{asyncio._get_running_loop()} to become up
to 10% faster.

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of
partial characters for UTF-8 input (libexpat bug 115):
@indicateurl{https://github.com/libexpat/libexpat/issues/115}

@item 
bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}: Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

@item 
bpo-29212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29212}: Fix concurrent.futures.thread.ThreadPoolExecutor threads to
have a non repr() based thread name by default when no thread_name_prefix
is supplied. They will now identify themselves as
«ThreadPoolExecutor-y_n».

@item 
bpo-9146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9146}: Fix a segmentation fault in _hashopenssl when standard hash
functions such as md5 are not available in the linked OpenSSL library.  As
in some special FIPS-140 build environments.

@item 
bpo-27144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27144}: The @code{map()} and @code{as_completed()} iterators in
@code{concurrent.futures} now avoid keeping a reference to yielded objects.

@item 
bpo-10746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10746}: Fix ctypes producing wrong 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} type codes for integer
types.

@item 
bpo-22536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22536}: The subprocess module now sets the filename when
FileNotFoundError is raised on POSIX systems due to the executable or cwd
not being found.

@item 
bpo-31249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31249}: concurrent.futures: WorkItem.run() used by ThreadPoolExecutor
now breaks a reference cycle between an exception object and the WorkItem
object.

@item 
bpo-31247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31247}: xmlrpc.server now explicitly breaks reference cycles when using
sys.exc_info() in code handling exceptions.

@item 
bpo-30102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30102}: The ssl and hashlib modules now call
OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0. The function
detects CPU features and enables optimizations on some CPU architectures
such as POWER8. Patch is based on research from Gustavo Serra Scalet.

@item 
bpo-31185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31185}: Fixed miscellaneous errors in asyncio speedup module.

@item 
bpo-31135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31135}: ttk: fix the destroy() method of LabeledScale and OptionMenu
classes. Call the parent destroy() method even if the used attribute
doesn’t exist. The LabeledScale.destroy() method now also explicitly
clears label and scale attributes to help the garbage collector to destroy
all widgets.

@item 
bpo-31107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31107}: Fix @code{copyreg._slotnames()} mangled attribute calculation for
classes whose name begins with an underscore. Patch by Shane Harvey.

@item 
bpo-31061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31061}: Fixed a crash when using asyncio and threads.

@item 
bpo-30502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30502}: Fix handling of long oids in ssl.  Based on patch by Christian
Heimes.

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() now throws ValueError on commands that
contains CR or LF. Patch by Donghee Na.

@item 
bpo-30595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30595}: multiprocessing.Queue.get() with a timeout now polls its reader
in non-blocking mode if it succeeded to acquire the lock but the acquire
took longer than the timeout.

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: Fix @code{unittest.mock}’s autospec to not fail on method-bound
builtin functions.  Patch by Aaron Gallagher.

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: Fix decrementing a borrowed reference in tracemalloc.

@item 
bpo-25684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25684}: Change @code{ttk.OptionMenu} radiobuttons to be unique across
instances of @code{OptionMenu}.

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: Fix multiprocessing.Queue.join_thread(): it now waits until the
thread completes, even if the thread was started by the same process which
created the queue.

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: Fix segfault in readline when using readline’s history-size
option.  Patch by Nir Soffer.

@item 
bpo-30319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30319}: socket.close() now ignores ECONNRESET error.

@item 
bpo-30828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30828}: Fix out of bounds write in
@code{asyncio.CFuture.remove_done_callback()}.

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: signal.setitimer() may disable the timer when passed a tiny
value. Tiny values (such as 1e-6) are valid non-zero values for
setitimer(), which is specified as taking microsecond-resolution
intervals. However, on some platform, our conversion routine could convert
1e-6 into a zero interval, therefore disabling the timer instead of
(re-)scheduling it.

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: Fix bug when modifying os.environ while iterating over it

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: Fix email header value parser dropping folding white space in
certain cases.

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() and os.scandir() now emit bytes names when called
with bytes-like argument.

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: Prohibited the “=” character in environment variable names in
@code{os.putenv()} and @code{os.spawn*()}.

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: Fixed the lgettext() family of functions in the gettext module.
They now always return bytes.
@end itemize

@node Documentation<58>,Tests<56>,Library<61>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id546}@anchor{1af6}
@subsubsection Documentation



@itemize -

@item 
bpo-31294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31294}: Fix incomplete code snippet in the ZeroMQSocketListener and
ZeroMQSocketHandler examples and adapt them to Python 3.

@item 
bpo-21649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21649}: Add RFC 7525 and Mozilla server side TLS links to SSL
documentation.

@item 
bpo-30803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30803}: Clarify doc on truth value testing. Original patch by Peter
Thomassen.
@end itemize

@node Tests<56>,Build<59>,Documentation<58>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id547}@anchor{1af7}
@subsubsection Tests



@itemize -

@item 
bpo-31320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31320}: Silence traceback in test_ssl

@item 
bpo-25674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25674}: Remove sha256.tbs-internet.com ssl test

@item 
bpo-30715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30715}: Address ALPN callback changes for OpenSSL 1.1.0f. The latest
version behaves like OpenSSL 1.0.2 and no longer aborts handshake.

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: regrtest: Exclude tzdata from regrtest –all. When running the
test suite using –use=all / -u all, exclude tzdata since it makes
test_datetime too slow (15-20 min on some buildbots) which then times out
on some buildbots. Fix also regrtest command line parser to allow passing
-u extralargefile to run test_zipfile64.
@end itemize

@node Build<59>,Windows<55>,Tests<56>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id548}@anchor{1af8}
@subsubsection Build



@itemize -

@item 
bpo-30854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30854}: Fix compile error when compiling –without-threads. Patch by
Masayuki Yamamoto.
@end itemize

@node Windows<55>,IDLE<45>,Build<59>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id549}@anchor{1af9}
@subsubsection Windows



@itemize -

@item 
bpo-30389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30389}: Adds detection of Visual Studio 2017 to distutils on Windows.

@item 
bpo-31340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31340}: Change to building with MSVC v141 (included with Visual Studio
2017)

@item 
bpo-30581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30581}: os.cpu_count() now returns the correct number of processors on
Windows when the number of logical processors is greater than 64.

@item 
bpo-30731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30731}: Add a missing xmlns to python.manifest so that it matches the
schema.
@end itemize

@node IDLE<45>,Tools/Demos<34>,Windows<55>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id550}@anchor{1afa}
@subsubsection IDLE



@itemize -

@item 
bpo-31493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31493}: IDLE code context – fix code update and font update timers.
Canceling timers prevents a warning message when test_idle completes.

@item 
bpo-31488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31488}: IDLE - Update non-key options in former extension classes. When
applying configdialog changes, call .reload for each feature class. Change
ParenMatch so updated options affect existing instances attached to
existing editor windows.

@item 
bpo-31477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31477}: IDLE - Improve rstrip entry in doc. Strip trailing whitespace
strips more than blank spaces.  Multiline string literals are not skipped.

@item 
bpo-31480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31480}: IDLE - make tests pass with zzdummy extension disabled by
default.

@item 
bpo-31421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31421}: Document how IDLE runs tkinter programs. IDLE calls tcl/tk
update in the background in order to make live interaction and
experimentation with tkinter applications much easier.

@item 
bpo-31414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31414}: IDLE – fix tk entry box tests by deleting first. Adding to an
int entry is not the same as deleting and inserting because int(“”) will
fail.

@item 
bpo-31051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31051}: Rearrange IDLE configdialog GenPage into Window, Editor, and
Help sections.

@item 
bpo-30617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30617}: IDLE - Add docstrings and tests for outwin subclass of editor.
Move some data and functions from the class to module level. Patch by
Cheryl Sabella.

@item 
bpo-31287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31287}: IDLE - Do not modify tkinter.message in test_configdialog.

@item 
bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}: Convert IDLE’s built-in “extensions” to regular features. About
10 IDLE features were implemented as supposedly optional extensions. Their
different behavior could be confusing or worse for users and not good for
maintenance. Hence the conversion. The main difference for users is that
user configurable key bindings for builtin features are now handled
uniformly. Now, editing a binding in a keyset only affects its value in
the keyset. All bindings are defined together in the system-specific
default keysets in config-extensions.def. All custom keysets are saved as
a whole in config-extension.cfg.  All take effect as soon as one clicks
Apply or Ok. The affected events are “<<force-open-completions>>”,
“<<expand-word>>”, “<<force-open-calltip>>”, “<<flash-paren>>”,
“<<format-paragraph>>”, “<<run-module>>”, “<<check-module>>”, and
“<<zoom-height>>”.  Any (global) customizations made before 3.6.3 will not
affect their keyset-specific customization after 3.6.3. and vice versa.
Initial patch by Charles Wohlganger.

@item 
bpo-31206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31206}: IDLE: Factor HighPage(Frame) class from ConfigDialog. Patch by
Cheryl Sabella.

@item 
bpo-31001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31001}: Add tests for configdialog highlight tab.  Patch by Cheryl
Sabella.

@item 
bpo-31205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31205}: IDLE: Factor KeysPage(Frame) class from ConfigDialog.  The
slightly modified tests continue to pass.  Patch by Cheryl Sabella.

@item 
bpo-31130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31130}: IDLE – stop leaks in test_configdialog. Initial patch by
Victor Stinner.

@item 
bpo-31002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31002}: Add tests for configdialog keys tab. Patch by Cheryl Sabella.

@item 
bpo-19903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19903}: IDLE: Calltips use @code{inspect.signature} instead of
@code{inspect.getfullargspec}. This improves calltips for builtins converted
to use Argument Clinic. Patch by Louie Lu.

@item 
bpo-31083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31083}: IDLE - Add an outline of a TabPage class in configdialog.
Update existing classes to match outline. Initial patch by Cheryl Sabella.

@item 
bpo-31050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31050}: Factor GenPage(Frame) class from ConfigDialog. The slightly
modified tests continue to pass. Patch by Cheryl Sabella.

@item 
bpo-31004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31004}: IDLE - Factor FontPage(Frame) class from ConfigDialog. Slightly
modified tests continue to pass. Fix General tests. Patch mostly by Cheryl
Sabella.

@item 
bpo-30781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30781}: IDLE - Use ttk widgets in ConfigDialog. Patches by Terry Jan
Reedy and Cheryl Sabella.

@item 
bpo-31060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31060}: IDLE - Finish rearranging methods of ConfigDialog Grouping
methods pertaining to each tab and the buttons will aid writing tests and
improving the tabs and will enable splitting the groups into classes.

@item 
bpo-30853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30853}: IDLE – Factor a VarTrace class out of ConfigDialog. Instance
tracers manages pairs consisting of a tk variable and a callback function.
When tracing is turned on, setting the variable calls the function.  Test
coverage for the new class is 100%.

@item 
bpo-31003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31003}: IDLE: Add more tests for General tab.

@item 
bpo-30993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30993}: IDLE - Improve configdialog font page and tests. In
configdialog: Document causal pathways in create_font_tab docstring.
Simplify some attribute names. Move set_samples calls to var_changed_font
(idea from Cheryl Sabella).  Move related functions to positions after the
create widgets function. In test_configdialog: Fix test_font_set so not
order dependent.  Fix renamed test_indent_scale so it tests the widget.
Adjust tests for movement of set_samples call.  Add tests for load
functions.  Put all font tests in one class and tab indent tests in
another.  Except for two lines, these tests completely cover the related
functions.

@item 
bpo-30981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30981}: IDLE – Add more configdialog font page tests.

@item 
bpo-28523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28523}: IDLE: replace “colour” with “color” in configdialog.

@item 
bpo-30917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30917}: Add tests for idlelib.config.IdleConf. Increase coverage from
46% to 96%. Patch by Louie Lu.

@item 
bpo-30934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30934}: Document coverage details for idlelib tests. Add section to
idlelib/idle-test/README.txt. Include check that branches are taken both
ways. Exclude IDLE-specific code that does not run during unit tests.

@item 
bpo-30913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30913}: IDLE: Document ConfigDialog tk Vars, methods, and widgets in
docstrings This will facilitate improving the dialog and splitting up the
class. Original patch by Cheryl Sabella.

@item 
bpo-30899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30899}: IDLE: Add tests for ConfigParser subclasses in config. Patch by
Louie Lu.

@item 
bpo-30881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30881}: IDLE: Add docstrings to browser.py. Patch by Cheryl Sabella.

@item 
bpo-30851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30851}: IDLE: Remove unused variables in configdialog.  One is a
duplicate, one is set but cannot be altered by users. Patch by Cheryl
Sabella.

@item 
bpo-30870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30870}: IDLE: In Settings dialog, select font with Up, Down keys as
well as mouse. Initial patch by Louie Lu.

@item 
bpo-8231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8231}: IDLE: call config.IdleConf.GetUserCfgDir only once.

@item 
bpo-30779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30779}: IDLE: Factor ConfigChanges class from configdialog, put in
config; test. * In config, put dump test code in a function; run it and
unittest in   “if __name__ == “__main__”. * Add class config.ConfigChanges
based on changes_class_v4.py on bpo issue. * Add class
test_config.ChangesTest, partly using configdialog_tests_v1.py. * Revise
configdialog to use ConfigChanges; see tracker msg297804. * Revise
test_configdialog to match configdialog changes. * Remove configdialog
functions unused or moved to ConfigChanges. Cheryl Sabella contributed
parts of the patch.

@item 
bpo-30777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30777}: IDLE: configdialog - Add docstrings and fix comments. Patch by
Cheryl Sabella.

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: IDLE: Improve textview with docstrings, PEP8 names, and more
tests. Patch by Cheryl Sabella.

@item 
bpo-30723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30723}: IDLE: Make several improvements to parenmatch. Add “parens”
style to highlight both opener and closer. Make “default” style, which is
not default, a synonym for “opener”. Make time-delay work the same with
all styles. Add help for config dialog extensions tab, including help for
parenmatch. Add new tests.  Original patch by Charles Wohlganger.

@item 
bpo-30674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30674}: IDLE: add docstrings to grep module. Patch by Cheryl Sabella

@item 
bpo-21519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21519}: IDLE’s basic custom key entry dialog now detects duplicates
properly. Original patch by Saimadhav Heblikar.

@item 
bpo-29910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29910}: IDLE no longer deletes a character after commenting out a
region by a key shortcut.  Add @code{return 'break'} for this and other
potential conflicts between IDLE and default key bindings.

@item 
bpo-30728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30728}: Review and change idlelib.configdialog names. Lowercase method
and attribute names. Replace “colour” with “color”, expand overly cryptic
names, delete unneeded underscores. Replace @code{import *} with specific
imports. Patches by Cheryl Sabella.

@item 
bpo-6739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6739}: IDLE: Verify user-entered key sequences by trying to bind them
with tk. Add tests for all 3 validation functions. Original patch by G
Polo.  Tests added by Cheryl Sabella.
@end itemize

@node Tools/Demos<34>,,IDLE<45>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id551}@anchor{1afb}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-30983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30983}: gdb integration commands (py-bt, etc.) work on optimized shared
builds now, too.  
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} introduced _PyEval_EvalFrameDefault which
inlines PyEval_EvalFrameEx on non-debug shared builds.  This broke the
ability to use py-bt, py-up, and a few other Python-specific gdb
integrations. The problem is fixed by only looking for
_PyEval_EvalFrameDefault frames in python-gdb.py.  Original patch by Bruno
«Polaco» Penteado.
@end itemize

@node Python 3 6 2 final,Python 3 6 2 release candidate 2,Python 3 6 3 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-2-final}@anchor{1afc}
@subsection Python 3.6.2 final


`Release date: 2017-07-17'

No changes since release candidate 2

@node Python 3 6 2 release candidate 2,Python 3 6 2 release candidate 1,Python 3 6 2 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-2-release-candidate-2}@anchor{1afd}
@subsection Python 3.6.2 release candidate 2


`Release date: 2017-07-07'

@menu
* Security: Security<38>. 

@end menu

@node Security<38>,,,Python 3 6 2 release candidate 2
@anchor{whatsnew/changelog id552}@anchor{1afe}
@subsubsection Security



@itemize -

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: Prevent environment variables injection in subprocess on
Windows.  Prevent passing other environment variables and command
arguments.

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple
security vulnerabilities including: 
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233
CVE 2017-9233@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233} (External entity
infinite loop DoS), 
@geindex Common Vulnerabilities and Exposures; CVE 2016-9063
CVE 2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2016-9063} (Integer overflow, re-fix),
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} (Fix regression bugs from 2.2.0’s fix to
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718}) and 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876
CVE 2012-0876@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876} (Counter hash flooding with
SipHash). Note: the 
@geindex Common Vulnerabilities and Exposures; CVE 2016-5300
CVE 2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2016-5300} (Use os-specific entropy sources like
getrandom) doesn’t impact Python, since Python already gets entropy from
the OS to set the expat secret using @code{XML_SetHashSalt()}.

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: Fix urllib.parse.splithost() to correctly parse fragments. For
example, @code{splithost('//127.0.0.1#@@evil.com/')} now correctly returns the
@code{127.0.0.1} host, instead of treating @code{@@evil.com} as the host in an
authentication (@code{login@@host}).
@end itemize

@node Python 3 6 2 release candidate 1,Python 3 6 1 final,Python 3 6 2 release candidate 2,Registro de cambios
@anchor{whatsnew/changelog python-3-6-2-release-candidate-1}@anchor{1aff}
@subsection Python 3.6.2 release candidate 1


`Release date: 2017-06-17'

@menu
* Security: Security<39>. 
* Core and Builtins: Core and Builtins<60>. 
* Library: Library<62>. 
* IDLE: IDLE<46>. 
* C API: C API<54>. 
* Build: Build<60>. 
* Documentation: Documentation<59>. 
* Tools/Demos: Tools/Demos<35>. 
* Tests: Tests<57>. 
* Windows: Windows<56>. 

@end menu

@node Security<39>,Core and Builtins<60>,,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id553}@anchor{1b00}
@subsubsection Security



@itemize -

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: Update expat copy from 2.1.1 to 2.2.0 to get fixes of
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} and 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}. See
@indicateurl{https://sourceforge.net/p/expat/bugs/537/} for more information.
@end itemize

@node Core and Builtins<60>,Library<62>,Security<39>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id554}@anchor{1b01}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-30682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30682}: Removed a too-strict assertion that failed for certain
f-strings, such as eval(«f”\n”») and eval(«f”\r”»).

@item 
bpo-30604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30604}: Move co_extra_freefuncs to not be per-thread to avoid crashes

@item 
bpo-29104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29104}: Fixed parsing backslashes in f-strings.

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: Fixed various segfaults with dict when input collections are
mutated during searching, inserting or comparing.  Based on patches by
Duane Griffin and Tim Mitchell.

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: Fixed type.__setattr__() and type.__delattr__() for
non-interned attribute names.  Based on patch by Eryk Sun.

@item 
bpo-30039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30039}: If a KeyboardInterrupt happens when the interpreter is in the
middle of resuming a chain of nested “yield from” or “await” calls, it’s
now correctly delivered to the innermost frame.

@item 
bpo-12414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12414}: sys.getsizeof() on a code object now returns the sizes which
includes the code struct and sizes of objects which it references. Patch
by Donghee Na.

@item 
bpo-29949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29949}: Fix memory usage regression of set and frozenset object.

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: Fixed error messages in the index() method of tuple, list and
deque when pass indices of wrong type.

@item 
bpo-29859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29859}: Show correct error messages when any of the pthread_* calls in
thread_pthread.h fails.

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: @code{bool(range)} works even if @code{len(range)} raises
@ref{919,,OverflowError}.

@item 
bpo-29600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29600}: Fix wrapping coroutine return values in StopIteration.

@item 
bpo-28856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28856}: Fix an oversight that %b format for bytes should support
objects follow the buffer protocol.

@item 
bpo-29714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29714}: Fix a regression that bytes format may fail when containing
zero bytes inside.

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: If max_line_length=None is specified while using the Compat32
policy, it is no longer ignored.  Patch by Mircea Cosbuc.
@end itemize

@node Library<62>,IDLE<46>,Core and Builtins<60>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id555}@anchor{1b02}
@subsubsection Library



@itemize -

@item 
bpo-30616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30616}: Functional API of enum allows to create empty enums. Patched by
Donghee Na

@item 
bpo-30038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30038}: Fix race condition between signal delivery and wakeup file
descriptor. Patch by Nathaniel Smith.

@item 
bpo-23894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23894}: lib2to3 now recognizes @code{rb'...'} and @code{f'...'} strings.

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() now manually breaks a
reference cycle to not keep objects alive longer than expected.

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() now supports callables with
variable-argument parameters wrapped with partialmethod. Patch by Donghee
Na.

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: Fix path calculation in imp.load_package(), fixing it for cases
when a package is only shipped with bytecodes. Patch by Alexandru
Ardelean.

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: Fixed comparison check for ipaddress.ip_interface objects.
Patch by Sanjay Sundaresan.

@item 
bpo-30605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30605}: re.compile() no longer raises a BytesWarning when compiling a
bytes instance with misplaced inline modifier.  Patch by Roy Williams.

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: Avoid race condition in multiprocessing cleanup (#2159)

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: The traceback no longer displayed for SystemExit raised in a
callback registered by atexit.

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: Don’t log exceptions if Task/Future «cancel()» method was
called.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Updates to typing module: Add generic AsyncContextManager, add
support for ContextManager on all versions. Original PRs by Jelle Zijlstra
and Ivan Levkivskyi

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: Fix ssl sockets leaks when connection is aborted in asyncio/ssl
implementation. Patch by Michaël Sghaïer.

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: Closing transport during handshake process leaks open socket.
Patch by Nikolay Kim

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu
Sornay.

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: On Windows, subprocess.Popen.communicate() now also ignore
EINVAL on stdin.write() if the child process is still running but closed
the pipe.

@item 
bpo-29822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29822}: inspect.isabstract() now works during __init_subclass__.  Patch
by Nate Soares.

@item 
bpo-29581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29581}: ABCMeta.__new__ now accepts @code{**kwargs}, allowing abstract
base classes to use keyword parameters in __init_subclass__. Patch by Nate
Soares.

@item 
bpo-30557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30557}: faulthandler now correctly filters and displays exception codes
on Windows

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: Fix the problem that logging.handlers.SysLogHandler cannot
handle IPv6 addresses.

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: Preserve generator state when _random.Random.setstate() raises
an exception. Patch by Bryan Olson.

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed background running thread do not
break from main loop on exception.

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: Fix handling escape characters in HZ codec.  Based on patch by
Ma Lin.

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: Fix AttributeError when using SimpleQueue.empty() under `spawn'
and `forkserver' start methods.

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib and poplib now catch the Windows socket WSAEINVAL error
(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted.
This error occurs sometimes on SSL connections.

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: Warnings emitted when compile a regular expression now always
point to the line in the user code.  Previously they could point into
inners of the re module if emitted from inside of groups or conditionals.

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: Fixed @code{Task.cancel()} can be ignored when the task is running
coroutine and the coroutine returned without any more @code{await}.

@item 
bpo-30266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30266}: contextlib.AbstractContextManager now supports
anti-registration by setting __enter__ = None or __exit__ = None,
following the pattern introduced in bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}. Patch by Jelle Zijlstra.

@item 
bpo-30298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30298}: Weaken the condition of deprecation warnings for inline
modifiers. Now allowed several subsequential inline modifiers at the start
of the pattern (e.g. @code{'(?i)(?s)...'}).  In verbose mode whitespaces and
comments now are allowed before and between inline modifiers (e.g. @code{'(?x)
(?i) (?s)...'}).

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: Fix range checking in GB18030 decoder.  Original patch by Ma
Lin.

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: Change resulted because of zipfile breakage. (See also:
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094})

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: Removed the __init__ methods of _json’s scanner and encoder.
Misusing them could cause memory leaks or crashes.  Now scanner and
encoder objects are completely initialized in the __new__ methods.

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: Avoid KeyboardInterrupt tracebacks in forkserver helper process
when Ctrl-C is received.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: add typing.NoReturn type, use
WrapperDescriptorType, minor bug-fixes.  Original PRs by Jim
Fasarakis-Hilliard and Ivan Levkivskyi.

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: Fix getsockname() for unbound AF_UNIX sockets on Linux.

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: Fixed leaks and crashes in errors handling in the parser
module.

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: Fixed crashes in IOBase methods __next__() and readlines() when
readline() or __next__() respectively return non-sizeable object. Fixed
possible other errors caused by not checking results of PyObject_Size(),
PySequence_Size(), or PyMapping_Size().

@item 
bpo-30017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30017}: Allowed calling the close() method of the zip entry writer
object multiple times.  Writing to a closed writer now always produces a
ValueError.

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: _io._IOBase.readlines will check if it’s closed first when hint
is present.

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: Fixed race condition in pathlib mkdir with flags parents=True.
Patch by Armin Rigo.

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: Fixed arbitrary unchaining of RuntimeError exceptions in
contextlib.contextmanager.  Patch by Siddharth Velankar.

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling and copying ImportError now preserves name and path
attributes.

@item 
bpo-29953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29953}: Fixed memory leaks in the replace() method of datetime and time
objects when pass out of bound fold argument.

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: Fix a crash in itertools.chain.from_iterable when encountering
long runs of empty iterables.

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: Fixed multiple crashes in ElementTree caused by race conditions
and wrong types.

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: Fixed a bug in pools in multiprocessing.pool that raising an
exception at the very first of an iterable may swallow the exception or
make the program hang. Patch by Davin Potts and Xiang Zhang.

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when
the OS gives priority to errors such as EACCES over EEXIST.

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: Release references to tasks, their arguments and their results
as soon as they are finished in multiprocessing.Pool.

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: Restore the old sigaltstack during teardown.
Patch by Christophe Zeitouny.

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: Fixed crashes in repr of recursive buffered file-like objects.

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: Fix crashes in partial.__repr__ if the keys of partial.keywords
are not strings.  Patch by Michael Seifert.

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: get_extra_info() raises exception if get called on closed ssl
transport. Patch by Nikolay Kim.

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: Fixed possible failing or crashing input() if attributes
«encoding» or «errors» of sys.stdin or sys.stdout are not set or are not
strings.

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: Fix a bug that prevented array “Q”, “L” and “I” from accepting
big intables (objects that have __int__) as elements.  Patch by Oren
Milman.

@item 
bpo-28231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28231}: The zipfile module now accepts path-like objects for external
paths.

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: index() and count() methods of collections.abc.Sequence now
check identity before checking equality when do comparisons.

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher no longer chains KeyError (or any other
exception) to exception(s) raised in the dispatched methods. Patch by Petr
Motejlek.

@item 
bpo-30177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30177}: path.resolve(strict=False) no longer cuts the path after the
first element not present in the filesystem.  Patch by Antoine Pietri.
@end itemize

@node IDLE<46>,C API<54>,Library<62>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id556}@anchor{1b03}
@subsubsection IDLE



@itemize -

@item 
bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}: Fix several problems with IDLE’s autocompletion box. The
following should now work: clicking on selection box items; using the
scrollbar; selecting an item by hitting Return. Hangs on MacOSX should no
longer happen. Patch by Louie Lu.

@item 
bpo-25514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25514}: Add doc subsubsection about IDLE failure to start. Popup
no-connection message directs users to this section.

@item 
bpo-30642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30642}: Fix reference leaks in IDLE tests. Patches by Louie Lu and
Terry Jan Reedy.

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: Add docstrings for textview.py and use PEP8 names. Patches by
Cheryl Sabella and Terry Jan Reedy.

@item 
bpo-30290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30290}: Help-about: use pep8 names and add tests. Increase coverage to
100%. Patches by Louie Lu, Cheryl Sabella, and Terry Jan Reedy.

@item 
bpo-30303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30303}: Add _utest option to textview; add new tests. Increase coverage
to 100%. Patches by Louie Lu and Terry Jan Reedy.
@end itemize

@node C API<54>,Build<60>,IDLE<46>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id557}@anchor{1b04}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: Function PySlice_GetIndicesEx() no longer replaced with a macro
if Py_LIMITED_API is not set.
@end itemize

@node Build<60>,Documentation<59>,C API<54>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id558}@anchor{1b05}
@subsubsection Build



@itemize -

@item 
bpo-29941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29941}: Add @code{--with-assertions} configure flag to explicitly enable C
@code{assert()} checks. Defaults to off. @code{--with-pydebug} implies
@code{--with-assertions}.

@item 
bpo-28787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28787}: Fix out-of-tree builds of Python when configured with
@code{--with--dtrace}.

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: Prevent unnecessary rebuilding of Python during @code{make test},
@code{make install} and some other make targets when configured with
@code{--enable-optimizations}.

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: Don’t regenerate generated files based on file modification
time anymore: the action is now explicit. Replace @code{make touch} with
@code{make regen-all}.

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: Fix @code{--enable-optimization} didn’t work.
@end itemize

@node Documentation<59>,Tools/Demos<35>,Build<60>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id559}@anchor{1b06}
@subsubsection Documentation



@itemize -

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: Add missing attribute related constants in curses
documentation.

@item 
bpo-30052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30052}: the link targets for @ref{325,,bytes()} and @ref{5e0,,bytearray()} are
now their respective type definitions, rather than the corresponding
builtin function entries. Use @ref{1ac0,,bytes} and
@ref{1ac1,,bytearray} to reference the latter. In order to
ensure this and future cross-reference updates are applied automatically,
the daily documentation builds now disable the default output caching
features in Sphinx.

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: Add missing info of code object in inspect documentation.
@end itemize

@node Tools/Demos<35>,Tests<57>,Documentation<59>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id560}@anchor{1b07}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-29367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29367}: python-gdb.py now supports also @code{method-wrapper}
(@code{wrapperobject}) objects.
@end itemize

@node Tests<57>,Windows<56>,Tools/Demos<35>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id561}@anchor{1b08}
@subsubsection Tests



@itemize -

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() now uses support.threading_setup() and
support.threading_cleanup() to wait until threads complete to avoid random
side effects on following tests. Initial patch written by Grzegorz
Grzywacz.

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: Enhanced functions swap_attr() and swap_item() in the
test.support module. They now work when delete replaced attribute or item
inside the with statement.  The old value of the attribute or item (or
None if it doesn’t exist) now will be assigned to the target of the «as»
clause, if there is one.
@end itemize

@node Windows<56>,,Tests<57>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id562}@anchor{1b09}
@subsubsection Windows



@itemize -

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: Locate msbuild.exe on Windows when building rather than
vcvarsall.bat

@item 
bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}: The build process on Windows no longer depends on Subversion,
instead pulling external code from GitHub via a Python script.  If Python
3.6 is not found on the system (via @code{py -3.6}), NuGet is used to
download a copy of 32-bit Python.
@end itemize

@node Python 3 6 1 final,Python 3 6 1 release candidate 1,Python 3 6 2 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-1-final}@anchor{1b0a}
@subsection Python 3.6.1 final


`Release date: 2017-03-21'

@menu
* Core and Builtins: Core and Builtins<61>. 
* Build: Build<61>. 

@end menu

@node Core and Builtins<61>,Build<61>,,Python 3 6 1 final
@anchor{whatsnew/changelog id563}@anchor{1b0b}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723}: The @code{sys.path[0]} initialization change for bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} caused
a regression by revealing an inconsistency in how sys.path is initialized
when executing @code{__main__} from a zipfile, directory, or other import
location. The interpreter now consistently avoids ever adding the import
location’s parent directory to @code{sys.path}, and ensures no other
@code{sys.path} entries are inadvertently modified when inserting the import
location named on the command line.
@end itemize

@node Build<61>,,Core and Builtins<61>,Python 3 6 1 final
@anchor{whatsnew/changelog id564}@anchor{1b0c}
@subsubsection Build



@itemize -

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: fix format of git information used in sys.version

@item 
Fix incompatible comment in python.h
@end itemize

@node Python 3 6 1 release candidate 1,Python 3 6 0 final,Python 3 6 1 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-1-release-candidate-1}@anchor{1b0d}
@subsection Python 3.6.1 release candidate 1


`Release date: 2017-03-04'

@menu
* Core and Builtins: Core and Builtins<62>. 
* Library: Library<63>. 
* IDLE: IDLE<47>. 
* Windows: Windows<57>. 
* C API: C API<55>. 
* Documentation: Documentation<60>. 
* Tests: Tests<58>. 
* Build: Build<62>. 

@end menu

@node Core and Builtins<62>,Library<63>,,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id565}@anchor{1b0e}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-28893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28893}: Set correct __cause__ for errors about invalid awaitables
returned from __aiter__ and __anext__.

@item 
bpo-29683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29683}: Fixes to memory allocation in _PyCode_SetExtra.  Patch by Brian
Coleman.

@item 
bpo-29684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29684}: Fix minor regression of PyEval_CallObjectWithKeywords. It
should raise TypeError when kwargs is not a dict.  But it might cause segv
when args=NULL and kwargs is not a dict.

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: Support __rmod__ for subclasses of str being called before
str.__mod__. Patch by Martijn Pieters.

@item 
bpo-29607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29607}: Fix stack_effect computation for CALL_FUNCTION_EX. Patch by
Matthieu Dartiailh.

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: Fix incorrect handling of signed zeros in complex constructor
for complex subclasses and for inputs having a __complex__ method. Patch
by Serhiy Storchaka.

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: Fixed possibly dereferencing undefined pointers when creating
weakref objects.

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: Fixed use-after-free problem in key sharing dict.

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: Prevent RunMainFromImporter overwriting sys.path[0].

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: Fixed possible BytesWarning when compare the code objects.
Warnings could be emitted at compile time.

@item 
bpo-29327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29327}: Fixed a crash when pass the iterable keyword argument to
sorted().

@item 
bpo-29034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29034}: Fix memory leak and use-after-free in os module
(path_converter).

@item 
bpo-29159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29159}: Fix regression in bytes(x) when x.__index__() raises Exception.

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: Do not include <sys/random.h> if it does not exist.

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: Correct the positioning of the syntax error caret for indented
blocks. Based on patch by Michael Layzell.

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: Fixed bytes formatting of octals with zero padding in alternate
form.

@item 
bpo-26919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26919}: On Android, operating system data is now always encoded/decoded
to/from UTF-8, instead of the locale encoding to avoid inconsistencies
with os.fsencode() and os.fsdecode() which are already using UTF-8.

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache() was susceptible to an obscure reentrancy
bug triggerable by a monkey-patched len() function.

@item 
bpo-28739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28739}: f-string expressions are no longer accepted as docstrings and
by ast.literal_eval() even if they do not include expressions.

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: Fixed setting the offset attribute of SyntaxError by
PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

@item 
bpo-28918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28918}: Fix the cross compilation of xxlimited when Python has been
built with Py_DEBUG defined.

@item 
bpo-28731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28731}: Optimize _PyDict_NewPresized() to create correct size dict.
Improve speed of dict literal with constant keys up to 30%.
@end itemize

@node Library<63>,IDLE<47>,Core and Builtins<62>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id566}@anchor{1b0f}
@subsubsection Library



@itemize -

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: Update zlib to 1.2.11.

@item 
bpo-29623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29623}: Allow use of path-like object as a single argument in
ConfigParser.read(). Patch by David Ellis.

@item 
bpo-28963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28963}: Fix out of bound iteration in
asyncio.Future.remove_done_callback implemented in C.

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol no longer closes
before all pipes are closed.

@item 
bpo-29271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29271}: Fix Task.current_task and Task.all_tasks implemented in C to
accept None argument as their pure Python implementation.

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: Fix asyncio to support instantiation of new event loops in
child processes.

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: Fix assertion error in threading._DummyThread.is_alive().

@item 
bpo-28624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28624}: Add a test that checks that cwd parameter of Popen() accepts
PathLike objects.  Patch by Sayan Chowdhury.

@item 
bpo-28518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28518}: Start a transaction implicitly before a DML statement. Patch by
Aviv Palivoda.

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: Altering a kwarg dictionary passed to functools.partial() no
longer affects a partial object after creation.

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: Fix file object leak in aifc.open() when file is given as a
filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: typing.Counter,
typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle
Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: Fix datetime.fromtimestamp() regression introduced in Python
3.6.0: check minimum and maximum years.

@item 
bpo-29519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29519}: Fix weakref spewing exceptions during interpreter shutdown when
used with a rare combination of multiprocessing and custom codecs.

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: Prevent infinite loop in pathlib.Path.mkdir

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: Fixed out-of-bounds buffer access in the group() method of the
match object. Based on patch by WGH.

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: Fix subprocess.Popen.wait() when the child process has exited
to a stopped instead of terminated state (ex: when under ptrace).

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: Fix a regression in argparse that help messages would wrap at
non-breaking spaces.

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: Fixed the comparison of mock.MagickMock with mock.ANY.

@item 
bpo-29316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29316}: Restore the provisional status of typing module, add
corresponding note to documentation. Patch by Ivan L.

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: Fixed infinite recursion in the repr of uninitialized
ctypes.CDLL instances.

@item 
bpo-29011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29011}: Fix an important omission by adding Deque to the typing module.

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: Fixed race condition in C implementation of
functools.lru_cache. KeyError could be raised when cached function with
full cache was simultaneously called from different threads with the same
uncached arguments.

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: In urllib.request, suffixes in no_proxy environment variable
with leading dots could match related hostnames again (e.g. .b.c matches
a.b.c). Patch by Milan Oberkirch.

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: Fix unittest.mock._Call helper: don’t ignore the name parameter
anymore. Patch written by Jiajun Huang.

@item 
bpo-29203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29203}: functools.lru_cache() now respects 
@geindex Python Enhancement Proposals; PEP 468
PEP 468@footnote{https://peps.python.org/pep-0468/} and preserves the
order of keyword arguments.  f(a=1, b=2) is now cached separately from
f(b=2, a=1) since both calls could potentially give different results.

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo() now correctly shows the first line of a
context. Patch by Sam Breese.

@item 
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}: Offsets in a ZIP file created with extern file object and modes
«w» and «x» now are relative to the start of the file.

@item 
bpo-29085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29085}: Allow random.Random.seed() to use high quality OS randomness
rather than the pid and time.

@item 
bpo-29061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29061}: Fixed bug in secrets.randbelow() which would hang when given a
negative input.  Patch by Brendan Donegan.

@item 
bpo-29079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29079}: Prevent infinite loop in pathlib.resolve() on Windows

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: Fixed recursion errors in large or resized
curses.textpad.Textbox.  Based on patch by Tycho Andersen.

@item 
bpo-29119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29119}: Fix weakrefs in the pure python version of
collections.OrderedDict move_to_end() method. Contributed by Andra
Bogildea.

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii predicates now work correctly with negative
integers.

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: old keys should not remove new values from WeakValueDictionary
when collecting from another thread.

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: Remove editor artifacts from Tix.py.

@item 
bpo-29055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29055}: Neaten-up empty population error on random.choice() by
suppressing the upstream exception.

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: Fixed a crash when deallocate deep ElementTree.

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: Fix bugs in WeakValueDictionary.setdefault() and
WeakValueDictionary.pop() when a GC collection happens in another thread.

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: Fixed a crash in resource.prlimit() when passing a sequence
that doesn’t own its elements as limits.

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: multiprocessing.set_forkserver_preload() would crash the
forkserver process if a preloaded module instantiated some multiprocessing
objects such as locks.

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb now supports reading read-only files and no longer
writes the index file when it is not changed.

@item 
bpo-26937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26937}: The chown() method of the tarfile.TarFile class does not fail
now when the grp module cannot be imported, as for example on Android
platforms.
@end itemize

@node IDLE<47>,Windows<57>,Library<63>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id567}@anchor{1b10}
@subsubsection IDLE



@itemize -

@item 
bpo-29071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29071}: IDLE colors f-string prefixes (but not invalid ur prefixes).

@item 
bpo-28572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28572}: Add 10% to coverage of IDLE’s test_configdialog. Update and
augment description of the configuration system.
@end itemize

@node Windows<57>,C API<55>,IDLE<47>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id568}@anchor{1b11}
@subsubsection Windows



@itemize -

@item 
bpo-29579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29579}: Removes readme.txt from the installer

@item 
bpo-29326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29326}: Ignores blank lines in ._pth files (Patch by Alexey Izbyshev)

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: Correctly handle special console filenames (patch by Eryk Sun)

@item 
bpo-29409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29409}: Implement 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} for io.FileIO (Patch by Eryk Sun)

@item 
bpo-29392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29392}: Prevent crash when passing invalid arguments into msvcrt
module.

@item 
bpo-25778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25778}: winreg does not truncate string correctly (Patch by Eryk Sun)

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: Deprecate WindowsRegistryFinder and disable it by default.
@end itemize

@node C API<55>,Documentation<60>,Windows<57>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id569}@anchor{1b12}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: Function PySlice_GetIndicesEx() is replaced with a macro if
Py_LIMITED_API is not set or set to the value between 0x03050400 and
0x03060000 (not including) or 0x03060100 or higher.

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: Fixed the declaration of some public API functions.
PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in
limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and
Py_BuildValue() were not available in limited API of version < 3.3 when
PY_SSIZE_T_CLEAN is defined.

@item 
bpo-29058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29058}: All stable API extensions added after Python 3.2 are now
available only when Py_LIMITED_API is set to the PY_VERSION_HEX value of
the minimum Python version supporting this API.
@end itemize

@node Documentation<60>,Tests<58>,C API<55>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id570}@anchor{1b13}
@subsubsection Documentation



@itemize -

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: Link the documentation to its source file on GitHub.

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: Document smtpd.py as effectively deprecated and add a pointer
to aiosmtpd, a third-party asyncio-based replacement.

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: Add canonical header link on each page to corresponding major
version of the documentation. Patch by Matthias Bussonnier.

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: Fix Python 2 syntax in code for building the documentation.
@end itemize

@node Tests<58>,Build<62>,Documentation<60>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id571}@anchor{1b14}
@subsubsection Tests



@itemize -

@item 
bpo-28087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28087}: Skip test_asyncore and test_eintr poll failures on macOS. Skip
some tests of select.poll when running on macOS due to unresolved issues
with the underlying system poll function on some macOS versions.

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: to match the behaviour of the @code{re.LOCALE} flag,
test_re.test_locale_flag now uses @code{locale.getpreferredencoding(False)}
to determine the candidate encoding for the test regex (allowing it to
correctly skip the test when the default locale encoding is a multi-byte
encoding)

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: Disallow -j0 to be combined with -T/-l in regrtest command line
arguments.

@item 
bpo-28683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28683}: Fix the tests that bind() a unix socket and raise
PermissionError on Android for a non-root user.

@item 
bpo-26939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26939}: Add the support.setswitchinterval() function to fix
test_functools hanging on the Android armv7 qemu emulator.
@end itemize

@node Build<62>,,Tests<58>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id572}@anchor{1b15}
@subsubsection Build



@itemize -

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: sys.version and the platform module python_build(),
python_branch(), and python_revision() functions now use git information
rather than hg when building from a repo.

@item 
bpo-29572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29572}: Update Windows build and OS X installers to use OpenSSL 1.0.2k.

@item 
bpo-26851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26851}: Set Android compilation and link flags.

@item 
bpo-28768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28768}: Fix implicit declaration of function _setmode. Patch by
Masayuki Yamamoto

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: Removes hard dependency on hg.exe from PCBuild/build.bat

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: Added missed names to PC/python3.def.

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: lockf() is available on Android API level 24, but the F_LOCK
macro is not defined in android-ndk-r13.

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: Fix the compilation error that occurs because if_nameindex() is
available on Android API level 24, but the if_nameindex structure is not
defined.

@item 
bpo-20211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20211}: Do not add the directory for installing C header files and the
directory for installing object code libraries to the cross compilation
search paths. Original patch by Thomas Petazzoni.

@item 
bpo-28849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28849}: Do not define sys.implementation._multiarch on Android.
@end itemize

@node Python 3 6 0 final,Python 3 6 0 release candidate 2,Python 3 6 1 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-final}@anchor{1b16}
@subsection Python 3.6.0 final


`Release date: 2016-12-23'

No changes since release candidate 2

@node Python 3 6 0 release candidate 2,Python 3 6 0 release candidate 1,Python 3 6 0 final,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-release-candidate-2}@anchor{1b17}
@subsection Python 3.6.0 release candidate 2


`Release date: 2016-12-16'

@menu
* Core and Builtins: Core and Builtins<63>. 
* Tools/Demos: Tools/Demos<36>. 
* Windows: Windows<58>. 
* Build: Build<63>. 

@end menu

@node Core and Builtins<63>,Tools/Demos<36>,,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id573}@anchor{1b18}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: Fix a memory leak in split-table dictionaries: setattr() must
not convert combined table into split table. Patch written by INADA Naoki.

@item 
bpo-28990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28990}: Fix asyncio SSL hanging if connection is closed before
handshake is completed. (Patch by HoHo-Ho)
@end itemize

@node Tools/Demos<36>,Windows<58>,Core and Builtins<63>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id574}@anchor{1b19}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-28770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28770}: Fix python-gdb.py for fastcalls.
@end itemize

@node Windows<58>,Build<63>,Tools/Demos<36>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id575}@anchor{1b1a}
@subsubsection Windows



@itemize -

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: Deprecate WindowsRegistryFinder.
@end itemize

@node Build<63>,,Windows<58>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id576}@anchor{1b1b}
@subsubsection Build



@itemize -

@item 
bpo-28898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28898}: Prevent gdb build errors due to HAVE_LONG_LONG redefinition.
@end itemize

@node Python 3 6 0 release candidate 1,Python 3 6 0 beta 4,Python 3 6 0 release candidate 2,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-release-candidate-1}@anchor{1b1c}
@subsection Python 3.6.0 release candidate 1


`Release date: 2016-12-06'

@menu
* Core and Builtins: Core and Builtins<64>. 
* Library: Library<64>. 
* C API: C API<56>. 
* Documentation: Documentation<61>. 
* Tools/Demos: Tools/Demos<37>. 

@end menu

@node Core and Builtins<64>,Library<64>,,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id577}@anchor{1b1d}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: Rather than silently producing a class that doesn’t support
zero-argument @code{super()} in methods, failing to pass the new
@code{__classcell__} namespace entry up to @code{type.__new__} now results in a
@code{DeprecationWarning} and a class that supports zero-argument
@code{super()}.

@item 
bpo-28797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28797}: Modifying the class __dict__ inside the __set_name__ method of
a descriptor that is used inside that class no longer prevents calling the
__set_name__ method of other descriptors.

@item 
bpo-28782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28782}: Fix a bug in the implementation @code{yield from} when checking if
the next instruction is YIELD_FROM. Regression introduced by WORDCODE
(bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647}).
@end itemize

@node Library<64>,C API<56>,Core and Builtins<64>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id578}@anchor{1b1e}
@subsubsection Library



@itemize -

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: Unknown escapes in re.sub() replacement template are allowed
again.  But they still are deprecated and will be disabled in 3.7.

@item 
bpo-28835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28835}: Fix a regression introduced in warnings.catch_warnings(): call
warnings.showwarning() if it was overridden inside the context manager.

@item 
bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172}: To assist with upgrades from 2.7, the previously documented
deprecation of @code{inspect.getfullargspec()} has been reversed. This
decision may be revisited again after the Python 2.7 branch is no longer
officially supported.

@item 
bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}: Add new @code{socket.TCP_CONGESTION} (Linux 2.6.13) and
@code{socket.TCP_USER_TIMEOUT} (Linux 2.6.37) constants. Patch written
by Omar Sandoval.

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: Reading a corrupt config file left configparser in an invalid
state. Original patch by Florian Höch.

@item 
bpo-28843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28843}: Fix asyncio C Task to handle exceptions __traceback__.
@end itemize

@node C API<56>,Documentation<61>,Library<64>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id579}@anchor{1b1f}
@subsubsection C API



@itemize -

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() now never raises exceptions.
@end itemize

@node Documentation<61>,Tools/Demos<37>,C API<56>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id580}@anchor{1b20}
@subsubsection Documentation



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: The data model reference and the porting section in the What’s
New guide now cover the additional @code{__classcell__} handling needed for
custom metaclasses to fully support 
@geindex Python Enhancement Proposals; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} and zero-argument
@code{super()}.
@end itemize

@node Tools/Demos<37>,,Documentation<61>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id581}@anchor{1b21}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-28023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28023}: Fix python-gdb.py didn’t support new dict implementation.
@end itemize

@node Python 3 6 0 beta 4,Python 3 6 0 beta 3,Python 3 6 0 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-beta-4}@anchor{1b22}
@subsection Python 3.6.0 beta 4


`Release date: 2016-11-21'

@menu
* Core and Builtins: Core and Builtins<65>. 
* Library: Library<65>. 
* Documentation: Documentation<62>. 
* Tests: Tests<59>. 
* Build: Build<64>. 

@end menu

@node Core and Builtins<65>,Library<65>,,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id582}@anchor{1b23}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-28532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28532}: Show sys.version when -V option is supplied twice.

@item 
bpo-27100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27100}: The with-statement now checks for __enter__ before it checks
for __exit__. This gives less confusing error messages when both methods
are missing. Patch by Jonathan Ellington.

@item 
bpo-28746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28746}: Fix the set_inheritable() file descriptor method on platforms
that do not have the ioctl FIOCLEX and FIONCLEX commands.

@item 
bpo-26920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26920}: Fix not getting the locale’s charset upon initializing the
interpreter, on platforms that do not have langinfo.

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X
when decode astral characters.  Patch by Xiang Zhang.

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: Extra slash no longer added to sys.path components in case of
empty compile-time PYTHONPATH components.

@item 
bpo-28665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28665}: Improve speed of the STORE_DEREF opcode by 40%.

@item 
bpo-28583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28583}: PyDict_SetDefault didn’t combine split table when needed. Patch
by Xiang Zhang.

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: Change PendingDeprecationWarning -> DeprecationWarning. As it
was agreed in the issue, __aiter__ returning an awaitable should result in
PendingDeprecationWarning in 3.5 and in DeprecationWarning in 3.6.

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: Fix a refleak in code that raises DeprecationWarning.

@item 
bpo-28721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28721}: Fix asynchronous generators aclose() and athrow() to handle
StopAsyncIteration propagation properly.
@end itemize

@node Library<65>,Documentation<62>,Core and Builtins<65>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id583}@anchor{1b24}
@subsubsection Library



@itemize -

@item 
bpo-28752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28752}: Restored the __reduce__() methods of datetime objects.

@item 
bpo-28727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28727}: Regular expression patterns, _sre.SRE_Pattern objects created
by re.compile(), become comparable (only x==y and x!=y operators). This
change should fix the bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: don’t duplicate warning filters when
the warnings module is reloaded (thing usually only done in unit tests).

@item 
bpo-20572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20572}: The subprocess.Popen.wait method’s undocumented endtime
parameter now raises a DeprecationWarning.

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: In ctypes, prevent a crash calling the from_buffer() and
from_buffer_copy() methods on abstract classes like Array.

@item 
bpo-19717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19717}: Makes Path.resolve() succeed on paths that do not exist. Patch
by Vajrasky Kok

@item 
bpo-28563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28563}: Fixed possible DoS and arbitrary code execution when handle
plural form selections in the gettext module.  The expression parser now
supports exact syntax supported by GNU gettext.

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: Fixed possible crash in _io.TextIOWrapper deallocator when the
garbage collector is invoked in other thread.  Based on patch by Sebastian
Cufre.

@item 
bpo-28600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28600}: Optimize loop.call_soon.

@item 
bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}: Fix get_event_loop() return the current loop if called from
coroutines/callbacks.

@item 
bpo-28634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28634}: Fix asyncio.isfuture() to support unittest.Mock.

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: Fix refleak in _asyncio.Future.__iter__().throw.

@item 
bpo-28639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28639}: Fix inspect.isawaitable to always return bool Patch by Justin
Mayfield.

@item 
bpo-28652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28652}: Make loop methods reject socket kinds they do not support.

@item 
bpo-28653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28653}: Fix a refleak in functools.lru_cache.

@item 
bpo-28703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28703}: Fix asyncio.iscoroutinefunction to handle Mock objects.

@item 
bpo-28704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28704}: Fix create_unix_server to support Path-like objects (PEP 519).

@item 
bpo-28720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28720}: Add collections.abc.AsyncGenerator.
@end itemize

@node Documentation<62>,Tests<59>,Library<65>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id584}@anchor{1b25}
@subsubsection Documentation



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: Documented command-line interface of zipfile.
@end itemize

@node Tests<59>,Build<64>,Documentation<62>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id585}@anchor{1b26}
@subsubsection Tests



@itemize -

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: Now test.support.rmtree is able to remove unwritable or
unreadable directories.

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: Various caches now are cleared before running every test file.
@end itemize

@node Build<64>,,Tests<59>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id586}@anchor{1b27}
@subsubsection Build



@itemize -

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: Fix out-of-tree building on AIX.  Patch by Tristan Carel and
Michael Haubenwallner.

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: Rename –with-optimiations to –enable-optimizations.

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: Prevent missing “getentropy” declaration warning on macOS.
Patch by Gareth Rees.
@end itemize

@node Python 3 6 0 beta 3,Python 3 6 0 beta 2,Python 3 6 0 beta 4,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-beta-3}@anchor{1b28}
@subsection Python 3.6.0 beta 3


`Release date: 2016-10-31'

@menu
* Core and Builtins: Core and Builtins<66>. 
* Library: Library<66>. 
* Windows: Windows<59>. 
* Build: Build<65>. 
* Tests: Tests<60>. 

@end menu

@node Core and Builtins<66>,Library<66>,,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id587}@anchor{1b29}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-28128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28128}: Deprecation warning for invalid str and byte escape sequences
now prints better information about where the error occurs. Patch by
Serhiy Storchaka and Eric Smith.

@item 
bpo-28509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28509}: dict.update() no longer allocate unnecessary large memory.

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: Fixed potential crash in PyUnicode_AsDecodedObject() in debug
build.

@item 
bpo-28517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28517}: Fixed of-by-one error in the peephole optimizer that caused
keeping unreachable code.

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: Improved exception reporting for problematic __set_name__
attributes.

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: Fixed possible memory leak in _PyTraceback_Add() and exception
loss in PyTraceBack_Here().

@item 
bpo-28471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28471}: Fix «Python memory allocator called without holding the GIL»
crash in socket.setblocking.
@end itemize

@node Library<66>,Windows<59>,Core and Builtins<66>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id588}@anchor{1b2a}
@subsubsection Library



@itemize -

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA compressor and decompressor no longer raise exceptions if
given empty data twice.  Patch by Benjamin Fogle.

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: Fixed segfault in curses’s addch() with ncurses6.

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open() with mode «r» or «r:» now tries to open a tar
file with compression before trying to open it without compression.
Otherwise it had 50% chance failed with ignore_zeros=True.

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: The webbrowser module now supports Firefox 36+ and derived
browsers.  Based on patch by Oleg Broytman.

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused
by representing the scale as float value internally in Tk.  tkinter.IntVar
now works if float value is set to underlying Tk variable.

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: The various ways of specifying weights for random.choices() now
produce the same result sequences.

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar().prmonth() no longer prints a space at
the start of new line after printing a month’s calendar.  Patch by Xiang
Zhang.

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: The textwrap.TextWrapper class now honors non-breaking spaces.
Based on patch by Kaarle Ritvanen.

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() no longer fails on broken links.

@item 
bpo-28430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28430}: Fix iterator of C implemented asyncio.Future doesn’t accept
non-None value is passed to it.send(val).

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: Generated names for Tkinter widgets now start by the «!» prefix
for readability.

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: Fixed HList.header_exists() in tkinter.tix module by addin a
workaround to Tix library bug.

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() no longer adds entry «./» to ZIP archive.

@item 
bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}: re.sub() now raises an error for invalid numerical group
reference in replacement template even if the pattern is not found in the
string.  Error message for invalid group reference now includes the group
index and the position of the reference. Based on patch by SilentGhost.

@item 
bpo-18219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18219}: Optimize csv.DictWriter for large number of columns. Patch by
Mariatta Wijaya.

@item 
bpo-28448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28448}: Fix C implemented asyncio.Future didn’t work on Windows.

@item 
bpo-28480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28480}: Fix error building socket module when multithreading is
disabled.

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: Make webbrowser support Chrome on Mac OS X.

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: Fix references leaked by pdb in the handling of SIGINT
handlers.

@item 
bpo-28492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28492}: Fix how StopIteration exception is raised in _asyncio.Future.

@item 
bpo-28500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28500}: Fix asyncio to handle async gens GC from another thread.

@item 
bpo-26923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26923}: Fix asyncio.Gather to refuse being cancelled once all children
are done. Patch by Johannes Ebke.

@item 
bpo-26796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26796}: Don’t configure the number of workers for default threadpool
executor. Initial patch by Hans Lawrenz.

@item 
bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}: Implement asyncio.Task in C.
@end itemize

@node Windows<59>,Build<65>,Library<66>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id589}@anchor{1b2b}
@subsubsection Windows



@itemize -

@item 
bpo-28522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28522}: Fixes mishandled buffer reallocation in getpathp.c
@end itemize

@node Build<65>,Tests<60>,Windows<59>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id590}@anchor{1b2c}
@subsubsection Build



@itemize -

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: Fix missing extensions modules when cross compiling.

@item 
bpo-28208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28208}: Update Windows build and OS X installers to use SQLite 3.14.2.

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: Update Windows build and OS X installers to use OpenSSL 1.0.2j.
@end itemize

@node Tests<60>,,Build<65>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id591}@anchor{1b2d}
@subsubsection Tests



@itemize -

@item 
bpo-26944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26944}: Fix test_posix for Android where “id -G” is entirely wrong or
missing the effective gid.

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: fix the parser of command line arguments.
@end itemize

@node Python 3 6 0 beta 2,Python 3 6 0 beta 1,Python 3 6 0 beta 3,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-beta-2}@anchor{1b2e}
@subsection Python 3.6.0 beta 2


`Release date: 2016-10-10'

@menu
* Core and Builtins: Core and Builtins<67>. 
* Library: Library<67>. 
* Windows: Windows<60>. 
* C API: C API<57>. 
* Build: Build<66>. 
* Tests: Tests<61>. 

@end menu

@node Core and Builtins<67>,Library<67>,,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id592}@anchor{1b2f}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-28183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28183}: Optimize and cleanup dict iteration.

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: Added C implementation of asyncio.Future. Original patch by
Yury Selivanov.

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: Added sanity checks and tests for PyUnicode_CopyCharacters().
Patch by Xiang Zhang.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: The type of long range iterator is now registered as Iterator.
Patch by Oren Milman.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: Creating instances of range_iterator by calling range_iterator
type now is deprecated.  Patch by Oren Milman.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: The constructor of range_iterator now checks that step is not
0. Patch by Oren Milman.

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: Resolving special methods of uninitialized type now causes
implicit initialization of the type instead of a fail.

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() now checks that tp_name is not NULL. Original
patch by Niklas Koep.

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: Fixed possible crash when AST is changed in process of
compiling it.

@item 
bpo-28201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28201}: Dict reduces possibility of 2nd conflict in hash table when
hashes have same lower bits.

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: String constants with null character no longer interned.

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: Fix crash when GC runs during weakref callbacks.

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: String constants now interned recursively in tuples and
frozensets.

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: Fixed misleading error message when ImportError called with
invalid keyword args.

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: Fix incorrect type in complex(1.0, @{2:3@}) error message. Patch
by Soumya Sharma.

@item 
bpo-28086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28086}: Single var-positional argument of tuple subtype was passed
unscathed to the C-defined function.  Now it is converted to exact tuple.

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: Now __set_name__ is looked up on the class instead of the
instance.

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: Fallback on reading /dev/urandom device when the getrandom()
syscall fails with EPERM, for example when blocked by SECCOMP.

@item 
bpo-28192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28192}: Don’t import readline in isolated mode.

@item 
Upgrade internal unicode databases to Unicode version 9.0.0.

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: Fix a regression in zipimport’s compile_source().  zipimport
should use the same optimization level as the interpreter.

@item 
bpo-28126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28126}: Replace Py_MEMCPY with memcpy(). Visual Studio can properly
optimize memcpy().

@item 
bpo-28120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28120}: Fix dict.pop() for split dictionary when trying to remove a
«pending key» (Not yet inserted in split-table). Patch by Xiang Zhang.

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: Raise DeprecationWarning when async and await keywords are used
as variable/attribute/class/function name.
@end itemize

@node Library<67>,Windows<60>,Core and Builtins<67>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id593}@anchor{1b30}
@subsubsection Library



@itemize -

@item 
bpo-27998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27998}: Fixed bytes path support in os.scandir() on Windows. Patch by
Eryk Sun.

@item 
bpo-28317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28317}: The disassembler now decodes FORMAT_VALUE argument.

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: Fixed writing ZIP files that starts not from the start of the
file.  Offsets in ZIP file now are relative to the start of the archive in
conforming to the specification.

@item 
bpo-28380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28380}: unittest.mock Mock autospec functions now properly support
assert_called, assert_not_called, and assert_called_once.

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: remove statistics.geometric_mean and defer until 3.7.

@item 
bpo-28229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28229}: lzma module now supports pathlib.

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: Fixed writing non-BMP characters with binary format in
plistlib.

@item 
bpo-28225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28225}: bz2 module now supports pathlib.  Initial patch by Ethan
Furman.

@item 
bpo-28227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28227}: gzip now supports pathlib.  Patch by Ethan Furman.

@item 
bpo-27358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27358}: Optimized merging var-keyword arguments and improved error
message when passing a non-mapping as a var-keyword argument.

@item 
bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257}: Improved error message when passing a non-iterable as a
var-positional argument.  Added opcode BUILD_TUPLE_UNPACK_WITH_CALL.

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: Fixed possible crashes when unpickle itertools objects from
incorrect pickle data.  Based on patch by John Leitch.

@item 
bpo-28228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28228}: imghdr now supports pathlib.

@item 
bpo-28226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28226}: compileall now supports pathlib.

@item 
bpo-28314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28314}: Fix function declaration (C flags) for the getiterator() method
of xml.etree.ElementTree.Element.

@item 
bpo-28148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28148}: Stop using localtime() and gmtime() in the time module.
Introduced platform independent _PyTime_localtime API that is similar to
POSIX localtime_r, but available on all platforms.  Patch by Ed Schouten.

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: Fixed calendar functions for extreme months: 0001-01 and
9999-12. Methods itermonthdays() and itermonthdays2() are reimplemented so
that they don’t call itermonthdates() which can cause datetime.date
under/overflow.

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: Fixed possible use after free in the decompress() methods of
the LZMADecompressor and BZ2Decompressor classes. Original patch by John
Leitch.

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: Fixed possible crash in sqlite3.Connection.create_collation()
if pass invalid string-like object as a name.  Patch by Xiang Zhang.

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: random.choices() now has k as a keyword-only argument to
improve the readability of common cases and come into line with the
signature used in other languages.

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py.
Patch by Madison May.

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: Fixed support of default root window in the tkinter.tix module.
Added the master parameter in the DisplayStyle constructor.

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: In the traceback module, restore the formatting of exception
messages like «Exception: None».  This fixes a regression introduced in
3.5a2.

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: Allow false values to be used for msg parameter of subTest().

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: Fix a memory leak in os.getrandom() when the getrandom() is
interrupted by a signal and a signal handler raises a Python exception.

@item 
bpo-28200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28200}: Fix memory leak on Windows in the os module (fix
path_converter() function).

@item 
bpo-25400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25400}: RobotFileParser now correctly returns default values for
crawl_delay and request_rate.  Initial patch by Peter Wirtz.

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: Prevent memory leak in win32_ver().

@item 
Fix UnboundLocalError in socket._sendfile_use_sendfile.

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: Check for ERROR_ACCESS_DENIED in Windows implementation of
os.stat().  Patch by Eryk Sun.

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: Warning message emitted by using inline flags in the middle of
regular expression now contains a (truncated) regex pattern. Patch by Tim
Graham.

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: Prevent codecs.escape_encode() from raising SystemError when an
empty bytestring is passed.

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by
Gergely Imreh and Markus Holtermann.

@item 
bpo-28114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28114}: Fix a crash in parse_envlist() when env contains byte strings.
Patch by Eryk Sun.

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: Fixed buffer overrun in binascii.b2a_qp() and
binascii.a2b_qp().

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: Fix socket accept exhaustion during high TCP traffic. Patch by
Kevin Conway.

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: Handle when SO_REUSEPORT isn’t properly supported. Patch by
Seth Michael Larson.

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: Inspect functools.partial in asyncio.Handle.__repr__. Patch by
iceboy.

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: Fix selectors incorrectly retain invalid file descriptors.
Patch by Mark Williams.

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: Refuse monitoring processes if the child watcher has no loop
attached. Patch by Vincent Michel.

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: Raise RuntimeError when transport’s FD is used with add_reader,
add_writer, etc.

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг
Марк.

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: Deprecate passing asyncio.Handles to run_in_executor.

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: Fix asyncio to support formatting of non-python coroutines.

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: Remove UNIX socket from FS before binding. Patch by Коренберг
Марк.

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: Prohibit Tasks to await on themselves.
@end itemize

@node Windows<60>,C API<57>,Library<67>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id594}@anchor{1b31}
@subsubsection Windows



@itemize -

@item 
bpo-28402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28402}: Adds signed catalog files for stdlib on Windows.

@item 
bpo-28333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28333}: Enables Unicode for ps1/ps2 and input() prompts. (Patch by Eryk
Sun)

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: Improvements to help manuals on Windows.

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi has different product codes between 32-bit and
64-bit

@item 
bpo-28161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28161}: Opening CON for write access fails

@item 
bpo-28162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28162}: WindowsConsoleIO readall() fails if first line starts with
Ctrl+Z

@item 
bpo-28163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28163}: WindowsConsoleIO fileno() passes wrong flags to _open_osfhandle

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: _PyIO_get_console_type fails for various paths

@item 
bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}: Renames Windows path file to ._pth

@item 
bpo-28138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28138}: Windows ._pth file should allow import site
@end itemize

@node C API<57>,Build<66>,Windows<60>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id595}@anchor{1b32}
@subsubsection C API



@itemize -

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: Deprecated undocumented functions PyUnicode_AsEncodedObject(),
PyUnicode_AsDecodedObject(), PyUnicode_AsDecodedUnicode() and
PyUnicode_AsEncodedUnicode().
@end itemize

@node Build<66>,Tests<61>,C API<57>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id596}@anchor{1b33}
@subsubsection Build



@itemize -

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: Fixed build with Estonian locale (python-config and distclean
targets in Makefile).  Patch by Arfrever Frehtes Taifersar Arahesis.

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py now detects system libffi with multiarch wrapper.

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: Remove redundant include search directory option for building
outside the source tree.
@end itemize

@node Tests<61>,,Build<66>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id597}@anchor{1b34}
@subsubsection Tests



@itemize -

@item 
bpo-28217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28217}: Adds _testconsole module to test console input.
@end itemize

@node Python 3 6 0 beta 1,Python 3 6 0 alpha 4,Python 3 6 0 beta 2,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-beta-1}@anchor{1b35}
@subsection Python 3.6.0 beta 1


`Release date: 2016-09-12'

@menu
* Core and Builtins: Core and Builtins<68>. 
* Library: Library<68>. 
* IDLE: IDLE<48>. 
* C API: C API<58>. 
* Tests: Tests<62>. 
* Build: Build<67>. 
* Tools/Demos: Tools/Demos<38>. 
* Windows: Windows<61>. 

@end menu

@node Core and Builtins<68>,Library<68>,,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id598}@anchor{1b36}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: The __class__ cell used by zero-argument super() is now
initialized from type.__new__ rather than __build_class__, so class
methods relying on that will now work correctly when called from metaclass
methods during class creation. Patch by Martin Teichmann.

@item 
bpo-25221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25221}: Fix corrupted result from PyLong_FromLong(0) when Python is
compiled with NSMALLPOSINTS = 0.

@item 
bpo-27080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27080}: Implement formatting support for 
@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}.  Initial patch by
Chris Angelico.

@item 
bpo-27199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27199}: In tarfile, expose copyfileobj bufsize to improve throughput.
Patch by Jason Fried.

@item 
bpo-27948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27948}: In f-strings, only allow backslashes inside the braces (where
the expressions are).  This is a breaking change from the 3.6 alpha
releases, where backslashes are allowed anywhere in an f-string.  Also,
require that expressions inside f-strings be enclosed within literal
braces, and not escapes like @code{f'\x7b"hi"\x7d'}.

@item 
bpo-28046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28046}: Remove platform-specific directories from sys.path.

@item 
bpo-28071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28071}: Add early-out for differencing from an empty set.

@item 
bpo-25758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25758}: Prevents zipimport from unnecessarily encoding a filename
(patch by Eryk Sun)

@item 
bpo-25856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25856}: The __module__ attribute of extension classes and functions now
is interned. This leads to more compact pickle data with protocol 4.

@item 
bpo-27213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27213}: Rework CALL_FUNCTION* opcodes to produce shorter and more
efficient bytecode. Patch by Demur Rumed, design by Serhiy Storchaka,
reviewed by Serhiy Storchaka and Victor Stinner.

@item 
bpo-26331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26331}: Implement tokenizing support for 
@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}. Patch by Georg
Brandl.

@item 
bpo-27999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27999}: Make «global after use» a SyntaxError, and ditto for nonlocal.
Patch by Ivan Levkivskyi.

@item 
bpo-28003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28003}: Implement 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} – Asynchronous Generators.

@item 
bpo-27985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27985}: Implement 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} – Syntax for Variable Annotations. Patch
by Ivan Levkivskyi.

@item 
bpo-26058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26058}: Add a new private version to the builtin dict type, incremented
at each dictionary creation and at each dictionary change. Implementation
of the PEP 509.

@item 
bpo-27364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27364}: A backslash-character pair that is not a valid escape sequence
now generates a DeprecationWarning.  Patch by Emanuel Barry.

@item 
bpo-27350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27350}: @code{dict} implementation is changed like PyPy. It is more
compact and preserves insertion order. (Concept developed by Raymond
Hettinger and patch by Inada Naoki.)

@item 
bpo-27911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27911}: Remove unnecessary error checks in
@code{exec_builtin_or_dynamic()}.

@item 
bpo-27078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27078}: Added BUILD_STRING opcode.  Optimized f-strings evaluation.

@item 
bpo-17884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17884}: Python now requires systems with inttypes.h and stdint.h

@item 
bpo-27961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27961}: Require platforms to support @code{long long}. Python hasn’t
compiled without @code{long long} for years, so this is basically a
formality.

@item 
bpo-27355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27355}: Removed support for Windows CE.  It was never finished, and
Windows CE is no longer a relevant platform for Python.

@item 
Implement 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}.

@item 
bpo-27870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27870}: A left shift of zero by a large integer no longer attempts to
allocate large amounts of memory.

@item 
bpo-25402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25402}: In int-to-decimal-string conversion, improve the estimate of
the intermediate memory required, and remove an unnecessarily strict
overflow check. Patch by Serhiy Storchaka.

@item 
bpo-27214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27214}: In long_invert, be more careful about modifying object returned
by long_add, and remove an unnecessary check for small longs. Thanks Oren
Milman for analysis and patch.

@item 
bpo-27506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27506}: Support passing the bytes/bytearray.translate() «delete»
argument by keyword.

@item 
bpo-27812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27812}: Properly clear out a generator’s frame’s backreference to the
generator to prevent crashes in frame.clear().

@item 
bpo-27811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27811}: Fix a crash when a coroutine that has not been awaited is
finalized with warnings-as-errors enabled.

@item 
bpo-27587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27587}: Fix another issue found by PVS-Studio: Null pointer check after
use of “def” in _PyState_AddModule(). Initial patch by Christian Heimes.

@item 
bpo-27792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27792}: The modulo operation applied to @code{bool} and other @code{int}
subclasses now always returns an @code{int}. Previously the return type
depended on the input values. Patch by Xiang Zhang.

@item 
bpo-26984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26984}: int() now always returns an instance of exact int.

@item 
bpo-25604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25604}: Fix a minor bug in integer true division; this bug could
potentially have caused off-by-one-ulp results on platforms with
unreliable ldexp implementations.

@item 
bpo-24254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24254}: Make class definition namespace ordered by default.

@item 
bpo-27662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27662}: Fix an overflow check in @code{List_New}: the original code was
checking against @code{Py_SIZE_MAX} instead of the correct upper bound of
@code{Py_SSIZE_T_MAX}. Patch by Xiang Zhang.

@item 
bpo-27782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27782}: Multi-phase extension module import now correctly allows the
@code{m_methods} field to be used to add module level functions to instances
of non-module types returned from @code{Py_create_mod}. Patch by Xiang Zhang.

@item 
bpo-27936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27936}: The round() function accepted a second None argument for some
types but not for others.  Fixed the inconsistency by accepting None for
all numeric types.

@item 
bpo-27487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27487}: Warn if a submodule argument to «python -m» or
runpy.run_module() is found in sys.modules after parent packages are
imported, but before the submodule is executed.

@item 
bpo-27157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27157}: Make only type() itself accept the one-argument form. Patch by
Eryk Sun and Emanuel Barry.

@item 
bpo-27558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27558}: Fix a SystemError in the implementation of «raise» statement.
In a brand new thread, raise a RuntimeError since there is no active
exception to reraise. Patch written by Xiang Zhang.

@item 
bpo-28008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28008}: Implement 
@geindex Python Enhancement Proposals; PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/} – asynchronous comprehensions.

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: Fix memory leak in codeobject.c
@end itemize

@node Library<68>,IDLE<48>,Core and Builtins<68>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id599}@anchor{1b37}
@subsubsection Library



@itemize -

@item 
bpo-28732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28732}: Fix crash in os.spawnv() with no elements in args

@item 
bpo-28485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28485}: Always raise ValueError for negative
compileall.compile_dir(workers=…) parameter, even when multithreading is
unavailable.

@item 
bpo-28037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28037}: Use sqlite3_get_autocommit() instead of setting
Connection->inTransaction manually.

@item 
bpo-25283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25283}: Attributes tm_gmtoff and tm_zone are now available on all
platforms in the return values of time.localtime() and time.gmtime().

@item 
bpo-24454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24454}: Regular expression match object groups are now accessible using
__getitem__. «mo[x]» is equivalent to «mo.group(x)».

@item 
bpo-10740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10740}: sqlite3 no longer implicitly commit an open transaction before
DDL statements.

@item 
bpo-17941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17941}: Add a `module' parameter to collections.namedtuple().

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: Inline flags now should be used only at the start of the
regular expression. Deprecation warning is emitted if uses them in the
middle of the regular expression.

@item 
bpo-26885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26885}: xmlrpc now supports unmarshalling additional data types used by
Apache XML-RPC implementation for numerics and None.

@item 
bpo-28070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28070}: Fixed parsing inline verbose flag in regular expressions.

@item 
bpo-19500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19500}: Add client-side SSL session resumption to the ssl module.

@item 
bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022}: Deprecate ssl-related arguments in favor of SSLContext. The
deprecation include manual creation of SSLSocket and certfile/keyfile (or
similar) in ftplib, httplib, imaplib, smtplib, poplib and urllib.

@item 
bpo-28043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28043}: SSLContext has improved default settings: OP_NO_SSLv2,
OP_NO_SSLv3, OP_NO_COMPRESSION, OP_CIPHER_SERVER_PREFERENCE,
OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE and HIGH ciphers without MD5.

@item 
bpo-24693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24693}: Changed some RuntimeError’s in the zipfile module to more
appropriate types. Improved some error messages and debugging output.

@item 
bpo-17909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17909}: @code{json.load} and @code{json.loads} now support binary input
encoded as UTF-8, UTF-16 or UTF-32. Patch by Serhiy Storchaka.

@item 
bpo-27137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27137}: the pure Python fallback implementation of
@code{functools.partial} now matches the behaviour of its accelerated C
counterpart for subclassing, pickling and text representation purposes.
Patch by Emanuel Barry and Serhiy Storchaka.

@item 
Fix possible integer overflows and crashes in the mmap module with unusual
usage patterns.

@item 
bpo-1703178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1703178}: Fix the ability to pass the –link-objects option to the
distutils build_ext command.

@item 
bpo-28019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28019}: itertools.count() no longer rounds non-integer step in range
between 1.0 and 2.0 to 1.

@item 
bpo-18401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18401}: Pdb now supports the “readrc” keyword argument to control
whether .pdbrc files should be read.  Patch by Martin Matusiak and Sam
Kimbrel.

@item 
bpo-25969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25969}: Update the lib2to3 grammar to handle the unpacking
generalizations added in 3.5.

@item 
bpo-14977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14977}: mailcap now respects the order of the lines in the mailcap
files («first match»), as required by RFC 1542.  Patch by Michael Lazar.

@item 
bpo-28082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28082}: Convert re flag constants to IntFlag.

@item 
bpo-28025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28025}: Convert all ssl module constants to IntEnum and IntFlags.
SSLContext properties now return flags and enums.

@item 
bpo-23591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23591}: Add Flag, IntFlag, and auto() to enum module.

@item 
bpo-433028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433028}: Added support of modifier spans in regular expressions.

@item 
bpo-24594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24594}: Validates persist parameter when opening MSI database

@item 
bpo-17582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17582}: xml.etree.ElementTree nows preserves whitespaces in attributes
(Patch by Duane Griffin.  Reviewed and approved by Stefan Behnel.)

@item 
bpo-28047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28047}: Fixed calculation of line length used for the base64 CTE in the
new email policies.

@item 
bpo-27576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27576}: Fix call order in OrderedDict.__init__().

@item 
email.generator.DecodedGenerator now supports the policy keyword.

@item 
bpo-28027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28027}: Remove undocumented modules from @code{Lib/plat-*}: IN, CDROM,
DLFCN, TYPES, CDIO, and STROPTS.

@item 
bpo-27445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27445}: Don’t pass str(_charset) to MIMEText.set_payload(). Patch by
Claude Paroz.

@item 
bpo-24277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24277}: The new email API is no longer provisional, and the docs have
been reorganized and rewritten to emphasize the new API.

@item 
bpo-22450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22450}: urllib now includes an @code{Accept: */*} header among the default
headers. This makes the results of REST API requests more consistent and
predictable especially when proxy servers are involved.

@item 
lib2to3.pgen3.driver.load_grammar() now creates a stable cache file
between runs given the same Grammar.txt input regardless of the hash
randomization setting.

@item 
bpo-28005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28005}: Allow ImportErrors in encoding implementation to propagate.

@item 
bpo-26667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26667}: Support path-like objects in importlib.util.

@item 
bpo-27570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27570}: Avoid zero-length memcpy() etc calls with null source pointers
in the «ctypes» and «array» modules.

@item 
bpo-22233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22233}: Break email header lines `only' on the RFC specified CR and LF
characters, not on arbitrary unicode line breaks.  This also fixes a bug
in HTTP header parsing.

@item 
bpo-27331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27331}: The email.mime classes now all accept an optional policy
keyword.

@item 
bpo-27988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27988}: Fix email iter_attachments incorrect mutation of payload list.

@item 
bpo-16113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16113}: Add SHA-3 and SHAKE support to hashlib module.

@item 
Eliminate a tautological-pointer-compare warning in _scproxy.c.

@item 
bpo-27776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27776}: The @ref{5c6,,os.urandom()} function does now block on Linux 3.17
and newer until the system urandom entropy pool is initialized to increase
the security. This change is part of the 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/}.

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: Expose the Linux @code{getrandom()} syscall as a new
@ref{d45,,os.getrandom()} function. This change is part of the 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/}.

@item 
bpo-27691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27691}: Fix ssl module’s parsing of GEN_RID subject alternative name
fields in X.509 certs.

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: Add random.choices().

@item 
bpo-25761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25761}: Improved error reporting about truncated pickle data in C
implementation of unpickler.  UnpicklingError is now raised instead of
AttributeError and ValueError in some cases.

@item 
bpo-26798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26798}: Add BLAKE2 (blake2b and blake2s) to hashlib.

@item 
bpo-26032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26032}: Optimized globbing in pathlib by using os.scandir(); it is now
about 1.5–4 times faster.

@item 
bpo-25596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25596}: Optimized glob() and iglob() functions in the glob module; they
are now about 3–6 times faster.

@item 
bpo-27928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27928}: Add scrypt (password-based key derivation function) to hashlib
module (requires OpenSSL 1.1.0).

@item 
bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850}: Remove 3DES from ssl module’s default cipher list to counter
measure sweet32 attack (
@geindex Common Vulnerabilities and Exposures; CVE 2016-2183
CVE 2016-2183@footnote{https://www.cve.org/CVERecord?id=CVE-2016-2183}).

@item 
bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}: Add ChaCha20 Poly1305 to ssl module’s default cipher list.
(Required OpenSSL 1.1.0 or LibreSSL).

@item 
bpo-25387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25387}: Check return value of winsound.MessageBeep.

@item 
bpo-27866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27866}: Add SSLContext.get_ciphers() method to get a list of all
enabled ciphers.

@item 
bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744}: Add AF_ALG (Linux Kernel crypto) to socket module.

@item 
bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}: Port ssl and hashlib module to OpenSSL 1.1.0.

@item 
bpo-11620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11620}: Fix support for SND_MEMORY in winsound.PlaySound.  Based on a
patch by Tim Lesher.

@item 
bpo-11734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11734}: Add support for IEEE 754 half-precision floats to the struct
module. Based on a patch by Eli Stevens.

@item 
bpo-27919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27919}: Deprecated @code{extra_path} distribution option in distutils
packaging.

@item 
bpo-23229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23229}: Add new @code{cmath} constants: @code{cmath.inf} and @code{cmath.nan} to
match @code{math.inf} and @code{math.nan}, and also @code{cmath.infj} and
@code{cmath.nanj} to match the format used by complex repr.

@item 
bpo-27842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27842}: The csv.DictReader now returns rows of type OrderedDict.
(Contributed by Steve Holden.)

@item 
Remove support for passing a file descriptor to os.access. It never worked
but previously didn’t raise.

@item 
bpo-12885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12885}: Fix error when distutils encounters symlink.

@item 
bpo-27881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27881}: Fixed possible bugs when setting
sqlite3.Connection.isolation_level. Based on patch by Xiang Zhang.

@item 
bpo-27861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27861}: Fixed a crash in sqlite3.Connection.cursor() when a factory
creates not a cursor.  Patch by Xiang Zhang.

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: Avoid spurious output on OS X with Gnu Readline.

@item 
bpo-27706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27706}: Restore deterministic behavior of random.Random().seed() for
string seeds using seeding version 1.  Allows sequences of calls to
random() to exactly match those obtained in Python 2. Patch by Nofar
Schnider.

@item 
bpo-10513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10513}: Fix a regression in Connection.commit().  Statements should not
be reset after a commit.

@item 
bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}: Chunked transfer encoding support added to
http.client.HTTPConnection requests.  The
urllib.request.AbstractHTTPHandler class does not enforce a Content-Length
header any more.  If a HTTP request has a file or iterable body, but no
Content-Length header, the library now falls back to use chunked
transfer-encoding.

@item 
A new version of typing.py from @indicateurl{https://github.com/python/typing}: -
Collection (only for 3.6) (bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}) - Add FrozenSet to __all__
(upstream #261) - fix crash in _get_type_vars() (upstream #259) - Remove
the dict constraint in ForwardRef._eval_type (upstream #252)

@item 
bpo-27832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27832}: Make @code{_normalize} parameter to @code{Fraction} constructor
keyword-only, so that @code{Fraction(2, 3, 4)} now raises @code{TypeError}.

@item 
bpo-27539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27539}: Fix unnormalised @code{Fraction.__pow__} result in the case of
negative exponent and negative base.

@item 
bpo-21718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21718}: cursor.description is now available for queries using CTEs.

@item 
bpo-27819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27819}: In distutils sdists, simply produce the «gztar» (gzipped tar
format) distributions on all platforms unless «formats» is supplied.

@item 
bpo-2466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2466}: posixpath.ismount now correctly recognizes mount points which
the user does not have permission to access.

@item 
bpo-9998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9998}: On Linux, ctypes.util.find_library now looks in LD_LIBRARY_PATH
for shared libraries.

@item 
bpo-27573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27573}: exit message for code.interact is now configurable.

@item 
bpo-27930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27930}: Improved behaviour of logging.handlers.QueueListener. Thanks to
Paulo Andrade and Petr Viktorin for the analysis and patch.

@item 
bpo-6766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6766}: Distributed reference counting added to multiprocessing to
support nesting of shared values / proxy objects.

@item 
bpo-21201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21201}: Improves readability of multiprocessing error message.  Thanks
to Wojciech Walczak for patch.

@item 
asyncio: Add set_protocol / get_protocol to Transports.

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: asyncio: Set TCP_NODELAY by default.
@end itemize

@node IDLE<48>,C API<58>,Library<68>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id600}@anchor{1b38}
@subsubsection IDLE



@itemize -

@item 
bpo-15308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15308}: Add “interrupt execution” (^C) to Shell menu. Patch by Roger
Serwy, updated by Bayard Randel.

@item 
bpo-27922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27922}: Stop IDLE tests from “flashing” gui widgets on the screen.

@item 
bpo-27891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27891}: Consistently group and sort imports within idlelib modules.

@item 
bpo-17642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17642}: add larger font sizes for classroom projection.

@item 
Add version to title of IDLE help window.

@item 
bpo-25564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25564}: In section on IDLE – console differences, mention that using
exec means that __builtins__ is defined for each statement.

@item 
bpo-27821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27821}: Fix 3.6.0a3 regression that prevented custom key sets from
being selected when no custom theme was defined.
@end itemize

@node C API<58>,Tests<62>,IDLE<48>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id601}@anchor{1b39}
@subsubsection C API



@itemize -

@item 
bpo-26900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26900}: Excluded underscored names and other private API from limited
API.

@item 
bpo-26027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26027}: Add support for path-like objects in PyUnicode_FSConverter() &
PyUnicode_FSDecoder().
@end itemize

@node Tests<62>,Build<67>,C API<58>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id602}@anchor{1b3a}
@subsubsection Tests



@itemize -

@item 
bpo-27427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27427}: Additional tests for the math module. Patch by Francisco Couzo.

@item 
bpo-27953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27953}: Skip math and cmath tests that fail on OS X 10.4 due to a poor
libm implementation of tan.

@item 
bpo-26040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26040}: Improve test_math and test_cmath coverage and rigour. Patch by
Jeff Allen.

@item 
bpo-27787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27787}: Call gc.collect() before checking each test for «dangling
threads», since the dangling threads are weak references.
@end itemize

@node Build<67>,Tools/Demos<38>,Tests<62>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id603}@anchor{1b3b}
@subsubsection Build



@itemize -

@item 
bpo-27566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27566}: Fix clean target in freeze makefile (patch by Lisa Roach)

@item 
bpo-27705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27705}: Update message in validate_ucrtbase.py

@item 
bpo-27976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27976}: Deprecate building _ctypes with the bundled copy of libffi on
non-OSX UNIX platforms.

@item 
bpo-27983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27983}: Cause lack of llvm-profdata tool when using clang as required
for PGO linking to be a configure time error rather than make time when
@code{--with-optimizations} is enabled.  Also improve our ability to find the
llvm-profdata tool on MacOS and some Linuxes.

@item 
bpo-21590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21590}: Support for DTrace and SystemTap probes.

@item 
bpo-26307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26307}: The profile-opt build now applies PGO to the built-in modules.

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: Add the –with-optimizations flag to turn on LTO and PGO build
support when available.

@item 
bpo-27917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27917}: Set platform triplets for Android builds.

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: Update references to the $(LIBPL) installation path on AIX.
This path was changed in 3.2a4.

@item 
Update OS X installer to use SQLite 3.14.1 and XZ 5.2.2.

@item 
bpo-21122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21122}: Fix LTO builds on OS X.

@item 
bpo-17128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17128}: Build OS X installer with a private copy of OpenSSL. Also
provide a sample Install Certificates command script to install a set of
root certificates from the third-party certifi module.
@end itemize

@node Tools/Demos<38>,Windows<61>,Build<67>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id604}@anchor{1b3c}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-27952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27952}: Get Tools/scripts/fixcid.py working with Python 3 and the
current «re» module, avoid invalid Python backslash escapes, and fix a bug
parsing escaped C quote signs.
@end itemize

@node Windows<61>,,Tools/Demos<38>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id605}@anchor{1b3d}
@subsubsection Windows



@itemize -

@item 
bpo-28065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28065}: Update xz dependency to 5.2.2 and build it from source.

@item 
bpo-25144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25144}: Ensures TargetDir is set before continuing with custom install.

@item 
bpo-1602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1602}: Windows console doesn’t input or print Unicode (PEP 528)

@item 
bpo-27781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27781}: Change file system encoding on Windows to UTF-8 (PEP 529)

@item 
bpo-27731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27731}: Opt-out of MAX_PATH on Windows 10

@item 
bpo-6135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6135}: Adds encoding and errors parameters to subprocess.

@item 
bpo-27959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27959}: Adds oem encoding, alias ansi to mbcs, move aliasmbcs to codec
lookup.

@item 
bpo-27982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27982}: The functions of the winsound module now accept keyword
arguments.

@item 
bpo-20366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20366}: Build full text search support into SQLite on Windows.

@item 
bpo-27756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27756}: Adds new icons for Python files and processes on Windows.
Designs by Cherry Wang.

@item 
bpo-27883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27883}: Update sqlite to 3.14.1.0 on Windows.
@end itemize

@node Python 3 6 0 alpha 4,Python 3 6 0 alpha 3,Python 3 6 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-alpha-4}@anchor{1b3e}
@subsection Python 3.6.0 alpha 4


`Release date: 2016-08-15'

@menu
* Core and Builtins: Core and Builtins<69>. 
* Library: Library<69>. 
* IDLE: IDLE<49>. 
* Tests: Tests<63>. 
* Windows: Windows<62>. 
* Build: Build<68>. 

@end menu

@node Core and Builtins<69>,Library<69>,,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id606}@anchor{1b3f}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-27704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27704}: Optimized creating bytes and bytearray from byte-like objects
and iterables. Speed up to 3 times for short objects.  Original patch by
Naoki Inada.

@item 
bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}: Large sections of repeated lines in tracebacks are now
abbreviated as «[Previous line repeated @{count@} more times]» by the
builtin traceback rendering. Patch by Emanuel Barry.

@item 
bpo-27574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27574}: Decreased an overhead of parsing keyword arguments in functions
implemented with using Argument Clinic.

@item 
bpo-22557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22557}: Now importing already imported modules is up to 2.5 times
faster.

@item 
bpo-17596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17596}: Include <wincrypt.h> to help with Min GW building.

@item 
bpo-17599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17599}: On Windows, rename the privately defined REPARSE_DATA_BUFFER
structure to avoid conflicting with the definition from Min GW.

@item 
bpo-27507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27507}: Add integer overflow check in bytearray.extend().  Patch by
Xiang Zhang.

@item 
bpo-27581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27581}: Don’t rely on wrapping for overflow check in
PySequence_Tuple().  Patch by Xiang Zhang.

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: Avoid signed integer overflow in list and tuple operations.
Patch by Xiang Zhang.

@item 
bpo-27419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27419}: Standard __import__() no longer look up «__import__» in globals
or builtins for importing submodules or «from import».  Fixed a crash if
raise a warning about unabling to resolve package from __spec__ or
__package__.

@item 
bpo-27083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27083}: Respect the PYTHONCASEOK environment variable under Windows.

@item 
bpo-27514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27514}: Make having too many statically nested blocks a SyntaxError
instead of SystemError.

@item 
bpo-27366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27366}: Implemented 
@geindex Python Enhancement Proposals; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} (Simpler customization of class
creation). Upon subclassing, the __init_subclass__ classmethod is called
on the base class. Descriptors are initialized with __set_name__ after
class creation.
@end itemize

@node Library<69>,IDLE<49>,Core and Builtins<69>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id607}@anchor{1b40}
@subsubsection Library



@itemize -

@item 
bpo-26027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26027}: Add 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}/__fspath__() support to the os and os.path
modules. Includes code from Jelle Zijlstra. (See also: bpo-27524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27524})

@item 
bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}: Add Collections to collections.abc. Patch by Ivan Levkivskyi,
docs by Neil Girdhar.

@item 
bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}: Support «anti-registration» of special methods from various
ABCs, like __hash__, __iter__ or __len__.  All these (and several more)
can be set to None in an implementation class and the behavior will be as
if the method is not defined at all. (Previously, this mechanism existed
only for __hash__, to make mutable classes unhashable.)  Code contributed
by Andrew Barnert and Ivan Levkivskyi.

@item 
bpo-16764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16764}: Support keyword arguments to zlib.decompress().  Patch by Xiang
Zhang.

@item 
bpo-27736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27736}: Prevent segfault after interpreter re-initialization due to ref
count problem introduced in code for bpo-27038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27038} in 3.6.0a3. Patch by
Xiang Zhang.

@item 
bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}: The `verbose' and `rename' parameters for
collections.namedtuple are now keyword-only.

@item 
bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}: Add mathematical constant tau to math and cmath. See also
@geindex Python Enhancement Proposals; PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/}.

@item 
bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}: traceback.StackSummary.format now abbreviates large sections of
repeated lines as «[Previous line repeated @{count@} more times]» (this
change then further affects other traceback display operations in the
module). Patch by Emanuel Barry.

@item 
bpo-27664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27664}: Add to concurrent.futures.thread.ThreadPoolExecutor() the
ability to specify a thread name prefix.

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: Add geometric_mean and harmonic_mean to statistics module.

@item 
bpo-27573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27573}: code.interact now prints an message when exiting.

@item 
bpo-6422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6422}: Add autorange method to timeit.Timer objects.

@item 
bpo-27773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27773}: Correct some memory management errors server_hostname in
_ssl.wrap_socket().

@item 
bpo-26750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26750}: unittest.mock.create_autospec() now works properly for
subclasses of property() and other data descriptors.  Removes the never
publicly used, never documented unittest.mock.DescriptorTypes tuple.

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: Undocumented support of general bytes-like objects as path in
compile() and similar functions is now deprecated.

@item 
bpo-26800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26800}: Undocumented support of general bytes-like objects as paths in
os functions is now deprecated.

@item 
bpo-26981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26981}: Add _order_ compatibility shim to enum.Enum for Python 2/3 code
bases.

@item 
bpo-27661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27661}: Added tzinfo keyword argument to datetime.combine.

@item 
In the curses module, raise an error if window.getstr() or window.instr()
is passed a negative value.

@item 
bpo-27783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27783}: Fix possible usage of uninitialized memory in
operator.methodcaller.

@item 
bpo-27774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27774}: Fix possible Py_DECREF on unowned object in _sre.

@item 
bpo-27760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27760}: Fix possible integer overflow in binascii.b2a_qp.

@item 
bpo-27758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27758}: Fix possible integer overflow in the _csv module for large
record lengths.

@item 
bpo-27568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27568}: Prevent HTTPoxy attack (
@geindex Common Vulnerabilities and Exposures; CVE 2016-1000110
CVE 2016-1000110@footnote{https://www.cve.org/CVERecord?id=CVE-2016-1000110}). Ignore the
HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

@item 
bpo-7063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7063}: Remove dead code from the «array» module’s slice handling. Patch
by Chuck.

@item 
bpo-27656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27656}: Do not assume sched.h defines any SCHED_* constants.

@item 
bpo-27130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27130}: In the «zlib» module, fix handling of large buffers (typically
4 GiB) when compressing and decompressing.  Previously, inputs were
limited to 4 GiB, and compression and decompression operations did not
properly handle results of 4 GiB.

@item 
bpo-24773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24773}: Implemented 
@geindex Python Enhancement Proposals; PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} (Local Time Disambiguation).

@item 
Expose the EPOLLEXCLUSIVE constant (when it is defined) in the select
module.

@item 
bpo-27567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27567}: Expose the EPOLLRDHUP and POLLRDHUP constants in the select
module.

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: Avoid signed int negation overflow in the «audioop» module.

@item 
bpo-27533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27533}: Release GIL in nt._isdir

@item 
bpo-17711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17711}: Fixed unpickling by the persistent ID with protocol 0. Original
patch by Alexandre Vassalotti.

@item 
bpo-27522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27522}: Avoid an unintentional reference cycle in email.feedparser.

@item 
bpo-27512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27512}: Fix a segfault when os.fspath() called an __fspath__() method
that raised an exception. Patch by Xiang Zhang.
@end itemize

@node IDLE<49>,Tests<63>,Library<69>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id608}@anchor{1b41}
@subsubsection IDLE



@itemize -

@item 
bpo-27714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27714}: text_textview and test_autocomplete now pass when re-run in the
same process.  This occurs when test_idle fails when run with the -w
option but without -jn.  Fix warning from test_config.

@item 
bpo-27621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27621}: Put query response validation error messages in the query box
itself instead of in a separate messagebox.  Redo tests to match. Add Mac
OSX refinements. Original patch by Mark Roseman.

@item 
bpo-27620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27620}: Escape key now closes Query box as cancelled.

@item 
bpo-27609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27609}: IDLE: tab after initial whitespace should tab, not
autocomplete. This fixes problem with writing docstrings at least twice
indented.

@item 
bpo-27609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27609}: Explicitly return None when there are also non-None returns. In
a few cases, reverse a condition and eliminate a return.

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: IDLE no longer runs buggy code because of its tkinter imports.
Users must include the same imports required to run directly in Python.

@item 
bpo-27173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27173}: Add “IDLE Modern Unix” to the built-in key sets. Make the
default key set depend on the platform. Add tests for the changes to the
config module.

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: add line counter and crc to IDLE configHandler test dump.
@end itemize

@node Tests<63>,Windows<62>,IDLE<49>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id609}@anchor{1b42}
@subsubsection Tests



@itemize -

@item 
bpo-25805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25805}: Skip a test in test_pkgutil as needed that doesn’t work when
@code{__name__ == __main__}. Patch by SilentGhost.

@item 
bpo-27472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27472}: Add test.support.unix_shell as the path to the default shell.

@item 
bpo-27369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27369}: In test_pyexpat, avoid testing an error message detail that
changed in Expat 2.2.0.

@item 
bpo-27594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27594}: Prevent assertion error when running test_ast with coverage
enabled: ensure code object has a valid first line number. Patch suggested
by Ivan Levkivskyi.
@end itemize

@node Windows<62>,Build<68>,Tests<63>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id610}@anchor{1b43}
@subsubsection Windows



@itemize -

@item 
bpo-27647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27647}: Update bundled Tcl/Tk to 8.6.6.

@item 
bpo-27610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27610}: Adds 
@geindex Python Enhancement Proposals; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} metadata to Windows installer

@item 
bpo-27469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27469}: Adds a shell extension to the launcher so that drag and drop
works correctly.

@item 
bpo-27309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27309}: Enables proper Windows styles in python[w].exe manifest.
@end itemize

@node Build<68>,,Windows<62>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id611}@anchor{1b44}
@subsubsection Build



@itemize -

@item 
bpo-27713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27713}: Suppress spurious build warnings when updating importlib’s
bootstrap files. Patch by Xiang Zhang

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: Correct the references to Modules/python.exp, which is required
on AIX.  The references were accidentally changed in 3.5.0a1.

@item 
bpo-27453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27453}: CPP invocation in configure must use CPPFLAGS. Patch by Chi
Hsuan Yen.

@item 
bpo-27641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27641}: The configure script now inserts comments into the makefile to
prevent the pgen and _freeze_importlib executables from being
cross-compiled.

@item 
bpo-26662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26662}: Set PYTHON_FOR_GEN in configure as the Python program to be
used for file generation during the build.

@item 
bpo-10910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10910}: Avoid C++ compilation errors on FreeBSD and OS X. Also update
FreedBSD version checks for the original ctype UTF-8 workaround.
@end itemize

@node Python 3 6 0 alpha 3,Python 3 6 0 alpha 2,Python 3 6 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-alpha-3}@anchor{1b45}
@subsection Python 3.6.0 alpha 3


`Release date: 2016-07-11'

@menu
* Security: Security<40>. 
* Core and Builtins: Core and Builtins<70>. 
* Library: Library<70>. 
* IDLE: IDLE<50>. 
* C API: C API<59>. 
* Build: Build<69>. 
* Tools/Demos: Tools/Demos<39>. 
* Documentation: Documentation<63>. 
* Tests: Tests<64>. 

@end menu

@node Security<40>,Core and Builtins<70>,,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id612}@anchor{1b46}
@subsubsection Security



@itemize -

@item 
bpo-27278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27278}: Fix os.urandom() implementation using getrandom() on Linux.
Truncate size to INT_MAX and loop until we collected enough random bytes,
instead of casting a directly Py_ssize_t to int.

@item 
bpo-22636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22636}: Avoid shell injection problems with ctypes.util.find_library().
@end itemize

@node Core and Builtins<70>,Library<70>,Security<40>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id613}@anchor{1b47}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-27473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27473}: Fixed possible integer overflow in bytes and bytearray
concatenations. Patch by Xiang Zhang.

@item 
bpo-23034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23034}: The output of a special Python build with defined COUNT_ALLOCS,
SHOW_ALLOC_COUNT or SHOW_TRACK_COUNT macros is now off by  default.  It
can be re-enabled using the «-X showalloccount» option.  It now outputs to
stderr instead of stdout.

@item 
bpo-27443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27443}: __length_hint__() of bytearray iterators no longer return a
negative integer for a resized bytearray.

@item 
bpo-27007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27007}: The fromhex() class methods of bytes and bytearray subclasses
now return an instance of corresponding subclass.
@end itemize

@node Library<70>,IDLE<50>,Core and Builtins<70>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id614}@anchor{1b48}
@subsubsection Library



@itemize -

@item 
bpo-26844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26844}: Fix error message for imp.find_module() to refer to “path”
instead of “name”. Patch by Lev Maximov.

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: Fix SSL zero-length recv() calls to not block and not raise an
error about unclean EOF.

@item 
bpo-27466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27466}: Change time format returned by http.cookie.time2netscape,
confirming the netscape cookie format and making it consistent with
documentation.

@item 
bpo-21708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21708}: Deprecated dbm.dumb behavior that differs from common dbm
behavior: creating a database in “r” and “w” modes and modifying a
database in “r” mode.

@item 
bpo-26721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26721}: Change the socketserver.StreamRequestHandler.wfile attribute to
implement BufferedIOBase. In particular, the write() method no longer does
partial writes.

@item 
bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}: Added methods trace_add, trace_remove and trace_info in the
tkinter.Variable class.  They replace old methods trace_variable, trace,
trace_vdelete and trace_vinfo that use obsolete Tcl commands and might not
work in future versions of Tcl.  Fixed old tracing methods:
trace_vdelete() with wrong mode no longer break tracing, trace_vinfo() now
always returns a list of pairs of strings, tracing in the «u» mode now
works.

@item 
bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243}: Only the level argument to zlib.compress() is keyword argument
now.  The first argument is positional-only.

@item 
bpo-27038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27038}: Expose the DirEntry type as os.DirEntry. Code patch by Jelle
Zijlstra.

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Update os.fspath()/PyOS_FSPath() to check the return value of
__fspath__() to be either str or bytes.

@item 
bpo-18726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18726}: All optional parameters of the dump(), dumps(), load() and
loads() functions and JSONEncoder and JSONDecoder class constructors in
the json module are now keyword-only.

@item 
bpo-27319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27319}: Methods selection_set(), selection_add(), selection_remove()
and selection_toggle() of ttk.TreeView now allow passing multiple items as
multiple arguments instead of passing them as a tuple.  Deprecated
undocumented ability of calling the selection() method with arguments.

@item 
bpo-27079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27079}: Fixed curses.ascii functions isblank(), iscntrl() and
ispunct().

@item 
bpo-27294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27294}: Numerical state in the repr for Tkinter event objects is now
represented as a combination of known flags.

@item 
bpo-27177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27177}: Match objects in the re module now support index-like objects
as group indices.  Based on patches by Jeroen Demeyer and Xiang Zhang.

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: Some functions (compile() etc) accepted a filename argument
encoded as an iterable of integers. Now only strings and byte-like objects
are accepted.

@item 
bpo-26536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26536}: socket.ioctl now supports SIO_LOOPBACK_FAST_PATH. Patch by
Daniel Stokes.

@item 
bpo-27048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27048}: Prevents distutils failing on Windows when environment
variables contain non-ASCII characters

@item 
bpo-27330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27330}: Fixed possible leaks in the ctypes module.

@item 
bpo-27238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27238}: Got rid of bare excepts in the turtle module.  Original patch
by Jelle Zijlstra.

@item 
bpo-27122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27122}: When an exception is raised within the context being managed by
a contextlib.ExitStack() and one of the exit stack generators catches and
raises it in a chain, do not re-raise the original exception when exiting,
let the new chained one through.  This avoids the 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} bug described
in issue25782.

@item 
bpo-16864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16864}: sqlite3.Cursor.lastrowid now supports REPLACE statement.
Initial patch by Alex LordThorsen.

@item 
bpo-26386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26386}: Fixed ttk.TreeView selection operations with item id’s
containing spaces.

@item 
bpo-8637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8637}: Honor a pager set by the env var MANPAGER (in preference to one
set by the env var PAGER).

@item 
bpo-16182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16182}: Fix various functions in the «readline» module to use the
locale encoding, and fix get_begidx() and get_endidx() to return code
point indexes.

@item 
bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}: Add loop.connect_accepted_socket(). Patch by Jim Fulton.
@end itemize

@node IDLE<50>,C API<59>,Library<70>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id615}@anchor{1b49}
@subsubsection IDLE



@itemize -

@item 
bpo-27477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27477}: IDLE search dialogs now use ttk widgets.

@item 
bpo-27173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27173}: Add “IDLE Modern Unix” to the built-in key sets. Make the
default key set depend on the platform. Add tests for the changes to the
config module.

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: make command line «idle-test> python test_help.py» work.
__file__ is relative when python is started in the file’s directory.

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: add line counter and crc to IDLE configHandler test dump.

@item 
bpo-27380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27380}: IDLE: add query.py with base Query dialog and ttk widgets.
Module had subclasses SectionName, ModuleName, and HelpSource, which are
used to get information from users by configdialog and file =>Load Module.
Each subclass has itw own validity checks.  Using ModuleName allows users
to edit bad module names instead of starting over. Add tests and delete
the two files combined into the new one.

@item 
bpo-27372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27372}: Test_idle no longer changes the locale.

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: Allow non-ascii chars in IDLE NEWS.txt, for contributor names.

@item 
bpo-27245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27245}: IDLE: Cleanly delete custom themes and key bindings.
Previously, when IDLE was started from a console or by import, a cascade
of warnings was emitted. Patch by Serhiy Storchaka.

@item 
bpo-24137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24137}: Run IDLE, test_idle, and htest with tkinter default root
disabled.  Fix code and tests that fail with this restriction.  Fix htests
to not create a second and redundant root and mainloop.

@item 
bpo-27310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27310}: Fix IDLE.app failure to launch on OS X due to vestigial import.
@end itemize

@node C API<59>,Build<69>,IDLE<50>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id616}@anchor{1b4a}
@subsubsection C API



@itemize -

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: PyUnicode_FSDecoder() accepted a filename argument encoded as
an iterable of integers. Now only strings and byte-like objects are
accepted.
@end itemize

@node Build<69>,Tools/Demos<39>,C API<59>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id617}@anchor{1b4b}
@subsubsection Build



@itemize -

@item 
bpo-28066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28066}: Fix the logic that searches build directories for generated
include files when building outside the source tree.

@item 
bpo-27442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27442}: Expose the Android API level that python was built against, in
sysconfig.get_config_vars() as “ANDROID_API_LEVEL”.

@item 
bpo-27434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27434}: The interpreter that runs the cross-build, found in PATH, must
now be of the same feature version (e.g. 3.6) as the source being built.

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: Update Windows builds to use OpenSSL 1.0.2h.

@item 
bpo-23968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23968}: Rename the platform directory from plat-$(MACHDEP) to
plat-$(PLATFORM_TRIPLET). Rename the config directory (LIBPL) from
config-$(LDVERSION) to config-$(LDVERSION)-$(PLATFORM_TRIPLET). Install
the platform specific _sysconfigdata module into the platform directory
and rename it to include the ABIFLAGS.

@item 
Don’t use largefile support for GNU/Hurd.
@end itemize

@node Tools/Demos<39>,Documentation<63>,Build<69>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id618}@anchor{1b4c}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-27332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27332}: Fixed the type of the first argument of module-level functions
generated by Argument Clinic.  Patch by Petr Viktorin.

@item 
bpo-27418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27418}: Fixed Tools/importbench/importbench.py.
@end itemize

@node Documentation<63>,Tests<64>,Tools/Demos<39>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id619}@anchor{1b4d}
@subsubsection Documentation



@itemize -

@item 
bpo-19489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19489}: Moved the search box from the sidebar to the header and footer
of each page. Patch by Ammar Askar.

@item 
bpo-27285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27285}: Update documentation to reflect the deprecation of @code{pyvenv}
and normalize on the term «virtual environment». Patch by Steve Piercy.
@end itemize

@node Tests<64>,,Documentation<63>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id620}@anchor{1b4e}
@subsubsection Tests



@itemize -

@item 
bpo-27027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27027}: Added test.support.is_android that is True when this is an
Android build.
@end itemize

@node Python 3 6 0 alpha 2,Python 3 6 0 alpha 1,Python 3 6 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-alpha-2}@anchor{1b4f}
@subsection Python 3.6.0 alpha 2


`Release date: 2016-06-13'

@menu
* Security: Security<41>. 
* Core and Builtins: Core and Builtins<71>. 
* Library: Library<71>. 
* IDLE: IDLE<51>. 
* Documentation: Documentation<64>. 
* Tests: Tests<65>. 
* Windows: Windows<63>. 
* Build: Build<70>. 
* C API: C API<60>. 
* Tools/Demos: Tools/Demos<40>. 

@end menu

@node Security<41>,Core and Builtins<71>,,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id621}@anchor{1b50}
@subsubsection Security



@itemize -

@item 
bpo-26556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26556}: Update expat to 2.1.1, fixes 
@geindex Common Vulnerabilities and Exposures; CVE 2015-1283
CVE 2015-1283@footnote{https://www.cve.org/CVERecord?id=CVE-2015-1283}.

@item 
Fix TLS stripping vulnerability in smtplib, 
@geindex Common Vulnerabilities and Exposures; CVE 2016-0772
CVE 2016-0772@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0772}. Reported by
Team Oststrom.

@item 
bpo-26839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26839}: On Linux, @ref{5c6,,os.urandom()} now calls @code{getrandom()} with
@code{GRND_NONBLOCK} to fall back on reading @code{/dev/urandom} if the urandom
entropy pool is not initialized yet. Patch written by Colm Buckley.
@end itemize

@node Core and Builtins<71>,Library<71>,Security<41>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id622}@anchor{1b51}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-27095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27095}: Simplified MAKE_FUNCTION and removed MAKE_CLOSURE opcodes.
Patch by Demur Rumed.

@item 
bpo-27190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27190}: Raise NotSupportedError if sqlite3 is older than 3.3.1. Patch
by Dave Sawyer.

@item 
bpo-27286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27286}: Fixed compiling BUILD_MAP_UNPACK_WITH_CALL opcode.  Calling
function with generalized unpacking (PEP 448) and conflicting keyword
names could cause undefined behavior.

@item 
bpo-27140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27140}: Added BUILD_CONST_KEY_MAP opcode.

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add support for os.PathLike objects to open() (part of
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}).

@item 
bpo-27066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27066}: Fixed SystemError if a custom opener (for open()) returns a
negative number without setting an exception.

@item 
bpo-26983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26983}: float() now always return an instance of exact float. The
deprecation warning is emitted if __float__ returns an instance of a
strict subclass of float.  In a future versions of Python this can be an
error.

@item 
bpo-27097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27097}: Python interpreter is now about 7% faster due to optimized
instruction decoding.  Based on patch by Demur Rumed.

@item 
bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647}: Python interpreter now uses 16-bit wordcode instead of
bytecode. Patch by Demur Rumed.

@item 
bpo-23275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23275}: Allow assigning to an empty target list in round brackets: () =
iterable.

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: Update the __aiter__ protocol: instead of returning an
awaitable that resolves to an asynchronous iterator, the asynchronous
iterator should be returned directly.  Doing the former will trigger a
PendingDeprecationWarning.
@end itemize

@node Library<71>,IDLE<51>,Core and Builtins<71>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id623}@anchor{1b52}
@subsubsection Library



@itemize -

@item 
Comment out socket (SO_REUSEPORT) and posix (O_SHLOCK, O_EXLOCK) constants
exposed on the API which are not implemented on GNU/Hurd. They would not
work at runtime anyway.

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: Generated names for Tkinter widgets are now more meaningful and
recognizable.

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: Fixed crashes in repr of recursive ElementTree.Element and
functools.partial objects.

@item 
bpo-27294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27294}: Improved repr for Tkinter event objects.

@item 
bpo-20508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20508}: Improve exception message of IPv@{4,6@}Network.__getitem__. Patch
by Gareth Rees.

@item 
bpo-21386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21386}: Implement missing IPv4Address.is_global property.  It was
documented since 07a5610bae9d.  Initial patch by Roger Luethi.

@item 
bpo-27029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27029}: Removed deprecated support of universal newlines mode from
ZipFile.open().

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: Unknown escapes consisting of @code{'\'} and an ASCII letter in
regular expressions now are errors.  The re.LOCALE flag now can be used
only with bytes patterns.

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add os.PathLike support to DirEntry (part of 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}).
Initial patch by Jelle Zijlstra.

@item 
bpo-20900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20900}: distutils register command now decodes HTTP responses
correctly.  Initial patch by ingrid.

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add os.PathLike support to pathlib, removing its provisional
status (part of PEP 519). Initial patch by Dusty Phillips.

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add support for os.PathLike objects to os.fsencode() and
os.fsdecode() (part of 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}).

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Introduce os.PathLike and os.fspath() (part of 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}).

@item 
A new version of typing.py provides several new classes and features:
@@overload outside stubs, Reversible, DefaultDict, Text, ContextManager,
Type[], NewType(), TYPE_CHECKING, and numerous bug fixes (note that some
of the new features are not yet implemented in mypy or other static
analyzers). Also classes for 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} (Awaitable, AsyncIterable,
AsyncIterator) have been added (in fact they made it into 3.5.1 but were
never mentioned).

@item 
bpo-25738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25738}: Stop http.server.BaseHTTPRequestHandler.send_error() from
sending a message body for 205 Reset Content.  Also, don’t send Content
header fields in responses that don’t have a body.  Patch by Susumu
Koshiba.

@item 
bpo-21313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21313}: Fix the «platform» module to tolerate when sys.version contains
truncated build information.

@item 
bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883}: Added missing APIs to __all__ to match the documented APIs for
the following modules: cgi, mailbox, mimetypes, plistlib and smtpd.
Patches by Jacek Kołodziej.

@item 
bpo-27164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27164}: In the zlib module, allow decompressing raw Deflate streams
with a predefined zdict.  Based on patch by Xiang Zhang.

@item 
bpo-24291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24291}: Fix wsgiref.simple_server.WSGIRequestHandler to completely
write data to the client.  Previously it could do partial writes and
truncate data.  Also, wsgiref.handler.ServerHandler can now handle stdout
doing partial writes, but this is deprecated.

@item 
bpo-21272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21272}: Use _sysconfigdata.py to initialize distutils.sysconfig.

@item 
bpo-19611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19611}: @ref{7e,,inspect} now reports the implicit @code{.0} parameters
generated by the compiler for comprehension and generator expression
scopes as if they were positional-only parameters called @code{implicit0}.
Patch by Jelle Zijlstra.

@item 
bpo-26809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26809}: Add @code{__all__} to @ref{d3,,string}.  Patch by Emanuel Barry.

@item 
bpo-26373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26373}: subprocess.Popen.communicate now correctly ignores
BrokenPipeError when the child process dies before .communicate() is
called in more/all circumstances.

@item 
signal, socket, and ssl module IntEnum constant name lookups now return a
consistent name for values having multiple names.  Ex: signal.Signals(6)
now refers to itself as signal.SIGALRM rather than flipping between that
and signal.SIGIOT based on the interpreter’s hash randomization seed.

@item 
bpo-27167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27167}: Clarify the subprocess.CalledProcessError error message text
when the child process died due to a signal.

@item 
bpo-25931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25931}: Don’t define socketserver.Forking* names on platforms such as
Windows that do not support os.fork().

@item 
bpo-21776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21776}: distutils.upload now correctly handles HTTPError. Initial patch
by Claudiu Popa.

@item 
bpo-26526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26526}: Replace custom parse tree validation in the parser module with
a simple DFA validator.

@item 
bpo-27114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27114}: Fix SSLContext._load_windows_store_certs fails with
PermissionError

@item 
bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: Avoid creating duplicate filters when using filterwarnings and
simplefilter. Based on patch by Alex Shkop.

@item 
bpo-23026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23026}: winreg.QueryValueEx() now return an integer for REG_QWORD type.

@item 
bpo-26741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26741}: subprocess.Popen destructor now emits a ResourceWarning warning
if the child process is still running.

@item 
bpo-27056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27056}: Optimize pickle.load() and pickle.loads(), up to 10% faster to
deserialize a lot of small objects.

@item 
bpo-21271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21271}: New keyword only parameters in reset_mock call.
@end itemize

@node IDLE<51>,Documentation<64>,Library<71>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id624}@anchor{1b53}
@subsubsection IDLE



@itemize -

@item 
bpo-5124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5124}: Paste with text selected now replaces the selection on X11. This
matches how paste works on Windows, Mac, most modern Linux apps, and ttk
widgets. Original patch by Serhiy Storchaka.

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: Switch all scrollbars in IDLE to ttk versions. Where needed,
minimal tests are added to cover changes.

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: IDLE requires tk 8.5 and availability ttk widgets. Delete now
unneeded tk version tests and code for older versions. Add test for IDLE
syntax colorizer.

@item 
bpo-27239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27239}: idlelib.macosx.isXyzTk functions initialize as needed.

@item 
bpo-27262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27262}: move Aqua unbinding code, which enable context menus, to
macosx.

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: Make clear in idlelib.idle_test.__init__ that the directory is
a private implementation of test.test_idle and tool for maintainers.

@item 
bpo-27196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27196}: Stop “ThemeChanged” warnings when running IDLE tests. These
persisted after other warnings were suppressed in #20567. Apply Serhiy
Storchaka’s update_idletasks solution to four test files. Record this
additional advice in idle_test/README.txt

@item 
bpo-20567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20567}: Revise idle_test/README.txt with advice about avoiding tk
warning messages from tests.  Apply advice to several IDLE tests.

@item 
bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}: Update idlelib/README.txt with new file names and event
handlers.

@item 
bpo-27156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27156}: Remove obsolete code not used by IDLE.

@item 
bpo-27117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27117}: Make colorizer htest and turtledemo work with dark themes. Move
code for configuring text widget colors to a new function.

@item 
bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}: Rename many @code{idlelib/*.py} and @code{idle_test/test_*.py} files.
Edit files to replace old names with new names when the old name referred
to the module rather than the class it contained. See the issue and IDLE
section in What’s New in 3.6 for more.

@item 
bpo-26673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26673}: When tk reports font size as 0, change to size 10. Such fonts
on Linux prevented the configuration dialog from opening.

@item 
bpo-21939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21939}: Add test for IDLE’s percolator. Original patch by Saimadhav
Heblikar.

@item 
bpo-21676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21676}: Add test for IDLE’s replace dialog. Original patch by Saimadhav
Heblikar.

@item 
bpo-18410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18410}: Add test for IDLE’s search dialog. Original patch by Westley
Martínez.

@item 
bpo-21703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21703}: Add test for undo delegator.  Patch mostly by Saimadhav
Heblikar .

@item 
bpo-27044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27044}: Add ConfigDialog.remove_var_callbacks to stop memory leaks.

@item 
bpo-23977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23977}: Add more asserts to test_delegator.
@end itemize

@node Documentation<64>,Tests<65>,IDLE<51>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id625}@anchor{1b54}
@subsubsection Documentation



@itemize -

@item 
bpo-16484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16484}: Change the default PYTHONDOCS URL to «https:», and fix the
resulting links to use lowercase.  Patch by Sean Rodman, test by Kaushik
Nadikuditi.

@item 
bpo-24136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24136}: Document the new 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} unpacking syntax of 3.5.

@item 
bpo-22558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22558}: Add remaining doc links to source code for Python-coded
modules. Patch by Yoni Lavi.
@end itemize

@node Tests<65>,Windows<63>,Documentation<64>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id626}@anchor{1b55}
@subsubsection Tests



@itemize -

@item 
bpo-25285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25285}: regrtest now uses subprocesses when the -j1 command line option
is used: each test file runs in a fresh child process. Before, the -j1
option was ignored.

@item 
bpo-25285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25285}: Tools/buildbot/test.bat script now uses -j1 by default to run
each test file in fresh child process.
@end itemize

@node Windows<63>,Build<70>,Tests<65>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id627}@anchor{1b56}
@subsubsection Windows



@itemize -

@item 
bpo-27064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27064}: The py.exe launcher now defaults to Python 3. The Windows
launcher @code{py.exe} no longer prefers an installed Python 2 version over
Python 3 by default when used interactively.

@item 
bpo-17500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17500}: Remove unused and outdated icons. (See also:
@indicateurl{https://github.com/python/pythondotorg/issues/945})
@end itemize

@node Build<70>,C API<60>,Windows<63>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id628}@anchor{1b57}
@subsubsection Build



@itemize -

@item 
bpo-27229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27229}: Fix the cross-compiling pgen rule for in-tree builds.  Patch by
Xavier de Gaye.

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: Update OS X 10.5+ 32-bit-only installer to build and link with
OpenSSL 1.0.2h.
@end itemize

@node C API<60>,Tools/Demos<40>,Build<70>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id629}@anchor{1b58}
@subsubsection C API



@itemize -

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add the PyOS_FSPath() function (part of 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}).

@item 
bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}: PyArg_ParseTupleAndKeywords() now supports positional-only
parameters.
@end itemize

@node Tools/Demos<40>,,C API<60>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id630}@anchor{1b59}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}: Argument Clinic now supports positional-only and keyword
parameters in the same function.
@end itemize

@node Python 3 6 0 alpha 1,Python 3 5 5 final,Python 3 6 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-6-0-alpha-1}@anchor{1b5a}
@subsection Python 3.6.0 alpha 1


`Release date: 2016-05-16'

@menu
* Security: Security<42>. 
* Core and Builtins: Core and Builtins<72>. 
* Library: Library<72>. 
* IDLE: IDLE<52>. 
* Documentation: Documentation<65>. 
* Tests: Tests<66>. 
* Build: Build<71>. 
* Windows: Windows<64>. 
* Tools/Demos: Tools/Demos<41>. 
* C API: C API<61>. 

@end menu

@node Security<42>,Core and Builtins<72>,,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id631}@anchor{1b5b}
@subsubsection Security



@itemize -

@item 
bpo-26657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26657}: Fix directory traversal vulnerability with http.server on
Windows.  This fixes a regression that was introduced in 3.3.4rc1 and
3.4.0rc1.  Based on patch by Philipp Hagemeister.

@item 
bpo-26313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26313}: ssl.py _load_windows_store_certs fails if windows cert store is
empty. Patch by Baji.

@item 
bpo-25939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25939}: On Windows open the cert store readonly in
ssl.enum_certificates.
@end itemize

@node Core and Builtins<72>,Library<72>,Security<42>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id632}@anchor{1b5c}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-20041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20041}: Fixed TypeError when frame.f_trace is set to None. Patch by
Xavier de Gaye.

@item 
bpo-26168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26168}: Fixed possible refleaks in failing Py_BuildValue() with the «N»
format unit.

@item 
bpo-26991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26991}: Fix possible refleak when creating a function with annotations.

@item 
bpo-27039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27039}: Fixed bytearray.remove() for values greater than 127.  Based on
patch by Joe Jevnik.

@item 
bpo-23640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23640}: int.from_bytes() no longer bypasses constructors for
subclasses.

@item 
bpo-27005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27005}: Optimized the float.fromhex() class method for exact float. It
is now 2 times faster.

@item 
bpo-18531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18531}: Single var-keyword argument of dict subtype was passed
unscathed to the C-defined function.  Now it is converted to exact dict.

@item 
bpo-26811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26811}: gc.get_objects() no longer contains a broken tuple with NULL
pointer.

@item 
bpo-20120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20120}: Use RawConfigParser for .pypirc parsing, removing support for
interpolation unintentionally added with move to Python 3. Behavior no
longer does any interpolation in .pypirc files, matching behavior in
Python 2.7 and Setuptools 19.0.

@item 
bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}: Memory functions of the @ref{cee,,PyMem_Malloc()} domain
(@ref{cf1,,PYMEM_DOMAIN_MEM}) now use the @ref{d96,,pymalloc allocator} rather than system @code{malloc()}. Applications calling
@ref{cee,,PyMem_Malloc()} without holding the GIL can now crash: use
@code{PYTHONMALLOC=debug} environment variable to validate the usage of
memory allocators in your application.

@item 
bpo-26802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26802}: Optimize function calls only using unpacking like
@code{func(*tuple)} (no other positional argument, no keyword): avoid copying
the tuple. Patch written by Joe Jevnik.

@item 
bpo-26659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26659}: Make the builtin slice type support cycle collection.

@item 
bpo-26718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26718}: super.__init__ no longer leaks memory if called multiple times.
NOTE: A direct call of super.__init__ is not endorsed!

@item 
bpo-27138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27138}: Fix the doc comment for FileFinder.find_spec().

@item 
bpo-27147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27147}: Mention 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} in the importlib docs.

@item 
bpo-25339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25339}: PYTHONIOENCODING now has priority over locale in setting the
error handler for stdin and stdout.

@item 
bpo-26494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26494}: Fixed crash on iterating exhausting iterators. Affected classes
are generic sequence iterators, iterators of str, bytes, bytearray, list,
tuple, set, frozenset, dict, OrderedDict, corresponding views and
os.scandir() iterator.

@item 
bpo-26574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26574}: Optimize @code{bytes.replace(b'@w{'}, b'.')} and
@code{bytearray.replace(b'@w{'}, b'.')}. Patch written by Josh Snider.

@item 
bpo-26581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26581}: If coding cookie is specified multiple times on a line in
Python source code file, only the first one is taken to account.

@item 
bpo-19711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19711}: Add tests for reloading namespace packages.

@item 
bpo-21099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21099}: Switch applicable importlib tests to use 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} API.

@item 
bpo-26563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26563}: Debug hooks on Python memory allocators now raise a fatal error
if functions of the @ref{cee,,PyMem_Malloc()} family are called without
holding the GIL.

@item 
bpo-26564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26564}: On error, the debug hooks on Python memory allocators now use
the @ref{ff,,tracemalloc} module to get the traceback where a memory block
was allocated.

@item 
bpo-26558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26558}: The debug hooks on Python memory allocator
@ref{cf0,,PyObject_Malloc()} now detect when functions are called without
holding the GIL.

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: Add 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} environment variable to set the
Python memory allocators and/or install debug hooks.

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: The @ref{cf2,,PyMem_SetupDebugHooks()} function can now also be
used on Python compiled in release mode.

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: The 
@geindex PYTHONMALLOCSTATS
@geindex variables de entorno; PYTHONMALLOCSTATS
@ref{1b5d,,PYTHONMALLOCSTATS} environment variable can now
also be used on Python compiled in release mode. It now has no effect if
set to an empty string.

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: In debug mode, debug hooks are now also installed on Python
memory allocators when Python is configured without pymalloc.

@item 
bpo-26464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26464}: Fix str.translate() when string is ASCII and first replacements
removes character, but next replacement uses a non-ASCII character or a
string longer than 1 character. Regression introduced in Python 3.5.0.

@item 
bpo-22836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22836}: Ensure exception reports from PyErr_Display() and
PyErr_WriteUnraisable() are sensible even when formatting them produces
secondary errors.  This affects the reports produced by
sys.__excepthook__() and when __del__() raises an exception.

@item 
bpo-26302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26302}: Correct behavior to reject comma as a legal character for
cookie names.

@item 
bpo-26136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26136}: Upgrade the warning when a generator raises StopIteration from
PendingDeprecationWarning to DeprecationWarning.  Patch by Anish Shah.

@item 
bpo-26204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26204}: The compiler now ignores all constant statements: bytes, str,
int, float, complex, name constants (None, False, True), Ellipsis and
ast.Constant; not only str and int. For example, @code{1.0} is now ignored in
@code{def f(): 1.0}.

@item 
bpo-4806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4806}: Avoid masking the original TypeError exception when using star
(@code{*}) unpacking in function calls.  Based on patch by Hagen Fürstenau
and Daniel Urban.

@item 
bpo-26146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26146}: Add a new kind of AST node: @code{ast.Constant}. It can be used by
external AST optimizers, but the compiler does not emit directly such
node.

@item 
bpo-23601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23601}: Sped-up allocation of dict key objects by using Python’s small
object allocator.  (Contributed by Julian Taylor.)

@item 
bpo-18018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18018}: Import raises ImportError instead of SystemError if a relative
import is attempted without a known parent package.

@item 
bpo-25843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25843}: When compiling code, don’t merge constants if they are equal
but have a different types. For example, @code{f1, f2 = lambda: 1, lambda:
1.0} is now correctly compiled to two different functions: @code{f1()}
returns @code{1} (@code{int}) and @code{f2()} returns @code{1.0} (@code{float}), even if
@code{1} and @code{1.0} are equal.

@item 
bpo-26107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26107}: The format of the @code{co_lnotab} attribute of code objects
changes to support negative line number delta.

@item 
bpo-26154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26154}: Add a new private _PyThreadState_UncheckedGet() function to get
the current Python thread state, but don’t issue a fatal error if it is
NULL. This new function must be used instead of accessing directly the
_PyThreadState_Current variable.  The variable is no more exposed since
Python 3.5.1 to hide the exact implementation of atomic C types, to avoid
compiler issues.

@item 
bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}: If __package__ != __spec__.parent or if neither __package__ or
__spec__ are defined then ImportWarning is raised.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: [UPDATE] Comment out the one of the pickleability tests in
_PyObject_GetState() due to regressions observed in Cython-based projects.

@item 
bpo-25961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25961}: Disallowed null characters in the type name.

@item 
bpo-25973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25973}: Fix segfault when an invalid nonlocal statement binds a name
starting with two underscores.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: Instances of extension types with a state that aren’t
subclasses of list or dict and haven’t implemented any pickle-related
methods (__reduce__, __reduce_ex__, __getnewargs__, __getnewargs_ex__, or
__getstate__), can no longer be pickled.  Including memoryview.

@item 
bpo-20440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20440}: Massive replacing unsafe attribute setting code with special
macro Py_SETREF.

@item 
bpo-25766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25766}: Special method __bytes__() now works in str subclasses.

@item 
bpo-25421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25421}: __sizeof__ methods of builtin types now use dynamic basic size.
This allows sys.getsize() to work correctly with their subclasses with
__slots__ defined.

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: Fixed problem with in-place string concatenation and utf-8
cache.

@item 
bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}: New Py_FinalizeEx() API allowing Python to set an exit status of
120 on failure to flush buffered streams.

@item 
bpo-25485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25485}: telnetlib.Telnet is now a context manager.

@item 
bpo-24097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24097}: Fixed crash in object.__reduce__() if slot name is freed inside
__getattr__.

@item 
bpo-24731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24731}: Fixed crash on converting objects with special methods
__bytes__, __trunc__, and __float__ returning instances of subclasses of
bytes, int, and float to subclasses of bytes, int, and float
correspondingly.

@item 
bpo-25630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25630}: Fix a possible segfault during argument parsing in functions
that accept filesystem paths.

@item 
bpo-23564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23564}: Fixed a partially broken sanity check in the _posixsubprocess
internals regarding how fds_to_pass were passed to the child.  The bug had
no actual impact as subprocess.py already avoided it.

@item 
bpo-25388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25388}: Fixed tokenizer crash when processing undecodable source code
with a null byte.

@item 
bpo-25462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25462}: The hash of the key now is calculated only once in most
operations in C implementation of OrderedDict.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: Default implementation of __reduce__ and __reduce_ex__ now
rejects builtin types with not defined __new__.

@item 
bpo-24802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24802}: Avoid buffer overreads when int(), float(), compile(), exec()
and eval() are passed bytes-like objects.  These objects are not
necessarily terminated by a null byte, but the functions assumed they
were.

@item 
bpo-25555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25555}: Fix parser and AST: fill lineno and col_offset of «arg» node
when compiling AST from Python objects.

@item 
bpo-24726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24726}: Fixed a crash and leaking NULL in repr() of OrderedDict that
was mutated by direct calls of dict methods.

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: Iterating OrderedDict with keys with unstable hash now raises
KeyError in C implementations as well as in Python implementation.

@item 
bpo-25395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25395}: Fixed crash when highly nested OrderedDict structures were
garbage collected.

@item 
bpo-25401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25401}: Optimize bytes.fromhex() and bytearray.fromhex(): they are now
between 2x and 3.5x faster.

@item 
bpo-25399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25399}: Optimize bytearray % args using the new private _PyBytesWriter
API. Formatting is now between 2.5 and 5 times faster.

@item 
bpo-25274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25274}: sys.setrecursionlimit() now raises a RecursionError if the new
recursion limit is too low depending at the current recursion depth.
Modify also the «lower-water mark» formula to make it monotonic. This mark
is used to decide when the overflowed flag of the thread state is reset.

@item 
bpo-24402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24402}: Fix input() to prompt to the redirected stdout when
sys.stdout.fileno() fails.

@item 
bpo-25349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25349}: Optimize bytes % args using the new private _PyBytesWriter API.
Formatting is now up to 2 times faster.

@item 
bpo-24806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24806}: Prevent builtin types that are not allowed to be subclassed
from being subclassed through multiple inheritance.

@item 
bpo-25301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25301}: The UTF-8 decoder is now up to 15 times as fast for error
handlers: @code{ignore}, @code{replace} and @code{surrogateescape}.

@item 
bpo-24848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24848}: Fixed a number of bugs in UTF-7 decoding of misformed data.

@item 
bpo-25267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25267}: The UTF-8 encoder is now up to 75 times as fast for error
handlers: @code{ignore}, @code{replace}, @code{surrogateescape}, @code{surrogatepass}.
Patch co-written with Serhiy Storchaka.

@item 
bpo-25280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25280}: Import trace messages emitted in verbose (-v) mode are no
longer formatted twice.

@item 
bpo-25227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25227}: Optimize ASCII and latin1 encoders with the @code{surrogateescape}
error handler: the encoders are now up to 3 times as fast. Initial patch
written by Serhiy Storchaka.

@item 
bpo-25003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25003}: On Solaris 11.3 or newer, os.urandom() now uses the getrandom()
function instead of the getentropy() function. The getentropy() function
is blocking to generate very good quality entropy, os.urandom() doesn’t
need such high-quality entropy.

@item 
bpo-9232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9232}: Modify Python’s grammar to allow trailing commas in the argument
list of a function declaration.  For example, «def f(*, a = 3,): pass» is
now legal. Patch from Mark Dickinson.

@item 
bpo-24965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24965}: Implement 
@geindex Python Enhancement Proposals; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} «Literal String Interpolation». This
allows you to embed expressions inside f-strings, which are converted to
normal strings at run time. Given x=3, then f’value=@{x@}” == “value=3”.
Patch by Eric V. Smith.

@item 
bpo-26478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26478}: Fix semantic bugs when using binary operators with dictionary
views and tuples.

@item 
bpo-26171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26171}: Fix possible integer overflow and heap corruption in
zipimporter.get_data().

@item 
bpo-25660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25660}: Fix TAB key behaviour in REPL with readline.

@item 
bpo-26288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26288}: Optimize PyLong_AsDouble.

@item 
bpo-26289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26289}: Optimize floor and modulo division for single-digit longs.
Microbenchmarks show 2-2.5x improvement.  Built-in “divmod” function is
now also ~10% faster. (See also: bpo-26315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26315})

@item 
bpo-25887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25887}: Raise a RuntimeError when a coroutine object is awaited more
than once.
@end itemize

@node Library<72>,IDLE<52>,Core and Builtins<72>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id633}@anchor{1b5e}
@subsubsection Library



@itemize -

@item 
bpo-27057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27057}: Fix os.set_inheritable() on Android, ioctl() is blocked by
SELinux and fails with EACCESS. The function now falls back to fcntl().
Patch written by Michał Bednarski.

@item 
bpo-27014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27014}: Fix infinite recursion using typing.py.  Thanks to Kalle Tuure!

@item 
bpo-27031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27031}: Removed dummy methods in Tkinter widget classes: tk_menuBar()
and tk_bindForTraversal().

@item 
bpo-14132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14132}: Fix urllib.request redirect handling when the target only has a
query string.  Original fix by Ján Janech.

@item 
bpo-17214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17214}: The «urllib.request» module now percent-encodes non-ASCII bytes
found in redirect target URLs.  Some servers send Location header fields
with non-ASCII bytes, but «http.client» requires the request target to be
ASCII-encodable, otherwise a UnicodeEncodeError is raised.  Based on patch
by Christian Heimes.

@item 
bpo-27033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27033}: The default value of the decode_data parameter for
smtpd.SMTPChannel and smtpd.SMTPServer constructors is changed to False.

@item 
bpo-27034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27034}: Removed deprecated class asynchat.fifo.

@item 
bpo-26870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26870}: Added readline.set_auto_history(), which can stop entries being
automatically added to the history list.  Based on patch by Tyler
Crompton.

@item 
bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}: zipfile.ZipFile.open() can now be used to write data into a ZIP
file, as well as for extracting data.  Patch by Thomas Kluyver.

@item 
bpo-26892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26892}: Honor debuglevel flag in urllib.request.HTTPHandler. Patch
contributed by Chi Hsuan Yen.

@item 
bpo-22274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22274}: In the subprocess module, allow stderr to be redirected to
stdout even when stdout is not redirected.  Patch by Akira Li.

@item 
bpo-26807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26807}: mock_open “files” no longer error on readline at end of file.
Patch from Yolanda Robla.

@item 
bpo-25745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25745}: Fixed leaking a userptr in curses panel destructor.

@item 
bpo-26977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26977}: Removed unnecessary, and ignored, call to sum of squares helper
in statistics.pvariance.

@item 
bpo-26002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26002}: Use bisect in statistics.median instead of a linear search.
Patch by Upendra Kuma.

@item 
bpo-25974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25974}: Make use of new Decimal.as_integer_ratio() method in statistics
module. Patch by Stefan Krah.

@item 
bpo-26996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26996}: Add secrets module as described in 
@geindex Python Enhancement Proposals; PEP 506
PEP 506@footnote{https://peps.python.org/pep-0506/}.

@item 
bpo-26881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26881}: The modulefinder module now supports extended opcode arguments.

@item 
bpo-23815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23815}: Fixed crashes related to directly created instances of types in
_tkinter and curses.panel modules.

@item 
bpo-17765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17765}: weakref.ref() no longer silently ignores keyword arguments.
Patch by Georg Brandl.

@item 
bpo-26873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26873}: xmlrpc now raises ResponseError on unsupported type tags
instead of silently return incorrect result.

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: The __contains__ methods in the collections ABCs now check for
identity before checking equality.  This better matches the behavior of
the concrete classes, allows sensible handling of NaNs, and makes it
easier to reason about container invariants.

@item 
bpo-26711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26711}: Fixed the comparison of plistlib.Data with other types.

@item 
bpo-24114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24114}: Fix an uninitialized variable in @code{ctypes.util}. The bug only
occurs on SunOS when the ctypes implementation searches for the @code{crle}
program. Patch by Xiang Zhang.  Tested on SunOS by Kees Bos.

@item 
bpo-26864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26864}: In urllib.request, change the proxy bypass host checking
against no_proxy to be case-insensitive, and to not match unrelated host
names that happen to have a bypassed hostname as a suffix.  Patch by Xiang
Zhang.

@item 
bpo-24902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24902}: Print server URL on http.server startup.  Initial patch by
Felix Kaiser.

@item 
bpo-25788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25788}: fileinput.hook_encoded() now supports an «errors» argument for
passing to open.  Original patch by Joseph Hackman.

@item 
bpo-26634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26634}: recursive_repr() now sets __qualname__ of wrapper.  Patch by
Xiang Zhang.

@item 
bpo-26804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26804}: urllib.request will prefer lower_case proxy environment
variables over UPPER_CASE or Mixed_Case ones. Patch contributed by
Hans-Peter Jansen.

@item 
bpo-26837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26837}: assertSequenceEqual() now correctly outputs non-stringified
differing items (like bytes in the -b mode).  This affects
assertListEqual() and assertTupleEqual().

@item 
bpo-26041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26041}: Remove «will be removed in Python 3.7» from deprecation
messages of platform.dist() and platform.linux_distribution(). Patch by
Kumaripaba Miyurusara Athukorala.

@item 
bpo-26822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26822}: itemgetter, attrgetter and methodcaller objects no longer
silently ignore keyword arguments.

@item 
bpo-26733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26733}: Disassembling a class now disassembles class and static
methods. Patch by Xiang Zhang.

@item 
bpo-26801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26801}: Fix error handling in @ref{1175,,shutil.get_terminal_size()}, catch
@ref{441,,AttributeError} instead of @ref{4ec,,NameError}. Patch written by
Emanuel Barry.

@item 
bpo-24838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24838}: tarfile’s ustar and gnu formats now correctly calculate name
and link field limits for multibyte character encodings like utf-8.

@item 
bpo-26717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26717}: Stop encoding Latin-1-ized WSGI paths with UTF-8.  Patch by
Anthony Sottile.

@item 
bpo-26782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26782}: Add STARTUPINFO to subprocess.__all__ on Windows.

@item 
bpo-26404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26404}: Add context manager to socketserver.  Patch by Aviv Palivoda.

@item 
bpo-26735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26735}: Fix @ref{5c6,,os.urandom()} on Solaris 11.3 and newer when reading
more than 1,024 bytes: call @code{getrandom()} multiple times with a limit of
1024 bytes per call.

@item 
bpo-26585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26585}: Eliminate http.server._quote_html() and use
html.escape(quote=False).  Patch by Xiang Zhang.

@item 
bpo-26685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26685}: Raise OSError if closing a socket fails.

@item 
bpo-16329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16329}: Add .webm to mimetypes.types_map.  Patch by Giampaolo Rodola”.

@item 
bpo-13952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13952}: Add .csv to mimetypes.types_map.  Patch by Geoff Wilson.

@item 
bpo-26587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26587}: the site module now allows .pth files to specify files to be
added to sys.path (e.g. zip files).

@item 
bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}: Introduce contextlib.AbstractContextManager and
typing.ContextManager.

@item 
bpo-26709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26709}: Fixed Y2038 problem in loading binary PLists.

@item 
bpo-23735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23735}: Handle terminal resizing with Readline 6.3+ by installing our
own SIGWINCH handler.  Patch by Eric Price.

@item 
bpo-25951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25951}: Change SSLSocket.sendall() to return None, as explicitly
documented for plain socket objects.  Patch by Aviv Palivoda.

@item 
bpo-26586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26586}: In http.server, respond with «413 Request header fields too
large» if there are too many header fields to parse, rather than killing
the connection and raising an unhandled exception.  Patch by Xiang Zhang.

@item 
bpo-26676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26676}: Added missing XMLPullParser to ElementTree.__all__.

@item 
bpo-22854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22854}: Change BufferedReader.writable() and BufferedWriter.readable()
to always return False.

@item 
bpo-26492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26492}: Exhausted iterator of array.array now conforms with the
behavior of iterators of other mutable sequences: it lefts exhausted even
if iterated array is extended.

@item 
bpo-26641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26641}: doctest.DocFileTest and doctest.testfile() now support packages
(module split into multiple directories) for the package parameter.

@item 
bpo-25195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25195}: Fix a regression in mock.MagicMock. _Call is a subclass of
tuple (changeset 3603bae63c13 only works for classes) so we need to
implement __ne__ ourselves.  Patch by Andrew Plummer.

@item 
bpo-26644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26644}: Raise ValueError rather than SystemError when a negative length
is passed to SSLSocket.recv() or read().

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: Fix SSL recv(0) and read(0) methods to return zero bytes
instead of up to 1024.

@item 
bpo-26616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26616}: Fixed a bug in datetime.astimezone() method.

@item 
bpo-26637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26637}: The @ref{77,,importlib} module now emits an @ref{4d7,,ImportError}
rather than a @ref{228,,TypeError} if @ref{96b,,__import__()} is tried during the
Python shutdown process but @ref{27e,,sys.path} is already cleared (set to
@code{None}).

@item 
bpo-21925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21925}: @ref{1a1d,,warnings.formatwarning()} now catches exceptions when
calling @ref{ea8,,linecache.getline()} and
@ref{1b5f,,tracemalloc.get_object_traceback()} to be able to log
@ref{39d,,ResourceWarning} emitted late during the Python shutdown process.

@item 
bpo-23848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23848}: On Windows, faulthandler.enable() now also installs an
exception handler to dump the traceback of all Python threads on any
Windows exception, not only on UNIX signals (SIGSEGV, SIGFPE, SIGABRT).

@item 
bpo-26530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26530}: Add C functions @code{_PyTraceMalloc_Track()} and
@code{_PyTraceMalloc_Untrack()} to track memory blocks using the
@ref{ff,,tracemalloc} module. Add @code{_PyTraceMalloc_GetTraceback()} to
get the traceback of an object.

@item 
bpo-26588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26588}: The _tracemalloc now supports tracing memory allocations of
multiple address spaces (domains).

@item 
bpo-24266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24266}: Ctrl+C during Readline history search now cancels the search
mode when compiled with Readline 7.

@item 
bpo-26590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26590}: Implement a safe finalizer for the _socket.socket type. It now
releases the GIL to close the socket.

@item 
bpo-18787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18787}: spwd.getspnam() now raises a PermissionError if the user
doesn’t have privileges.

@item 
bpo-26560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26560}: Avoid potential ValueError in BaseHandler.start_response.
Initial patch by Peter Inglesby.

@item 
bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}: Add a new function @ref{d9e,,PyErr_ResourceWarning()} function to
pass the destroyed object. Add a `source' attribute to
@code{warnings.WarningMessage}. Add warnings._showwarnmsg() which uses
tracemalloc to get the traceback where source object was allocated.

@item 
bpo-26569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26569}: Fix @ref{8c2,,pyclbr.readmodule()} and @ref{8c3,,pyclbr.readmodule_ex()}
to support importing packages.

@item 
bpo-26499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26499}: Account for remaining Content-Length in HTTPResponse.readline()
and read1(). Based on patch by Silent Ghost. Also document that
HTTPResponse now supports these methods.

@item 
bpo-25320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25320}: Handle sockets in directories unittest discovery is scanning.
Patch from Victor van den Elzen.

@item 
bpo-16181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16181}: cookiejar.http2time() now returns None if year is higher than
datetime.MAXYEAR.

@item 
bpo-26513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26513}: Fixes platform module detection of Windows Server

@item 
bpo-23718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23718}: Fixed parsing time in week 0 before Jan 1.  Original patch by
Tamás Bence Gedai.

@item 
bpo-26323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26323}: Add Mock.assert_called() and Mock.assert_called_once() methods
to unittest.mock. Patch written by Amit Saha.

@item 
bpo-20589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20589}: Invoking Path.owner() and Path.group() on Windows now raise
NotImplementedError instead of ImportError.

@item 
bpo-26177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26177}: Fixed the keys() method for Canvas and Scrollbar widgets.

@item 
bpo-15068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15068}: Got rid of excessive buffering in fileinput. The bufsize
parameter is now deprecated and ignored.

@item 
bpo-19475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19475}: Added an optional argument timespec to the datetime isoformat()
method to choose the precision of the time component.

@item 
bpo-2202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2202}: Fix UnboundLocalError in
AbstractDigestAuthHandler.get_algorithm_impls. Initial patch by Mathieu
Dupuy.

@item 
bpo-26167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26167}: Minimized overhead in copy.copy() and copy.deepcopy().
Optimized copying and deepcopying bytearrays, NotImplemented, slices,
short lists, tuples, dicts, sets.

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: Fixed pickling and copying the accumulate() iterator with total
is None.

@item 
bpo-26475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26475}: Fixed debugging output for regular expressions with the (?x)
flag.

@item 
bpo-26482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26482}: Allowed pickling recursive dequeues.

@item 
bpo-26335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26335}: Make mmap.write() return the number of bytes written like other
write methods.  Patch by Jakub Stasiak.

@item 
bpo-26457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26457}: Fixed the subnets() methods in IP network classes for the case
when resulting prefix length is equal to maximal prefix length. Based on
patch by Xiang Zhang.

@item 
bpo-26385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26385}: Remove the file if the internal open() call in
NamedTemporaryFile() fails. Patch by Silent Ghost.

@item 
bpo-26402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26402}: Fix XML-RPC client to retry when the server shuts down a
persistent connection.  This was a regression related to the new
http.client.RemoteDisconnected exception in 3.5.0a4.

@item 
bpo-25913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25913}: Leading @code{<~} is optional now in base64.a85decode() with
adobe=True.  Patch by Swati Jaiswal.

@item 
bpo-26186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26186}: Remove an invalid type check in importlib.util.LazyLoader.

@item 
bpo-26367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26367}: importlib.__import__() raises ImportError like
builtins.__import__() when @code{level} is specified but without an
accompanying package specified.

@item 
bpo-26309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26309}: In the «socketserver» module, shut down the request (closing
the connected socket) when verify_request() returns false.  Patch by Aviv
Palivoda.

@item 
bpo-23430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23430}: Change the socketserver module to only catch exceptions raised
from a request handler that are derived from Exception (instead of
BaseException). Therefore SystemExit and KeyboardInterrupt no longer
trigger the handle_error() method, and will now to stop a single-threaded
server.

@item 
bpo-25995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25995}: os.walk() no longer uses FDs proportional to the tree depth.

@item 
bpo-25994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25994}: Added the close() method and the support of the context manager
protocol for the os.scandir() iterator.

@item 
bpo-23992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23992}: multiprocessing: make MapResult not fail-fast upon exception.

@item 
bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243}: Support keyword arguments to zlib.compress().  Patch by Aviv
Palivoda.

@item 
bpo-26117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26117}: The os.scandir() iterator now closes file descriptor not only
when the iteration is finished, but when it was failed with error.

@item 
bpo-25949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25949}: __dict__ for an OrderedDict instance is now created only when
needed.

@item 
bpo-25911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25911}: Restored support of bytes paths in os.walk() on Windows.

@item 
bpo-26045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26045}: Add UTF-8 suggestion to error message when posting a
non-Latin-1 string with http.client.

@item 
bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}: Added zipfile.ZipInfo.from_file() and zipinfo.ZipInfo.is_dir().
Patch by Thomas Kluyver.

@item 
bpo-12923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12923}: Reset FancyURLopener’s redirect counter even if there is an
exception. Based on patches by Brian Brazil and Daniel Rocco.

@item 
bpo-25945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25945}: Fixed a crash when unpickle the functools.partial object with
wrong state. Fixed a leak in failed functools.partial constructor. «args»
and «keywords» attributes of functools.partial have now always types tuple
and dict correspondingly.

@item 
bpo-26202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26202}: copy.deepcopy() now correctly copies range() objects with
non-atomic attributes.

@item 
bpo-23076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23076}: Path.glob() now raises a ValueError if it’s called with an
invalid pattern. Patch by Thomas Nyberg.

@item 
bpo-19883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19883}: Fixed possible integer overflows in zipimport.

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: On Windows, getnameinfo(), gethostbyaddr() and
gethostbyname_ex() functions of the socket module now decode the hostname
from the ANSI code page rather than UTF-8.

@item 
bpo-26099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26099}: The site module now writes an error into stderr if
sitecustomize module can be imported but executing the module raise an
ImportError. Same change for usercustomize.

@item 
bpo-26147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26147}: xmlrpc now works with strings not encodable with used non-UTF-8
encoding.

@item 
bpo-25935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25935}: Garbage collector now breaks reference loops with OrderedDict.

@item 
bpo-16620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16620}: Fixed AttributeError in msilib.Directory.glob().

@item 
bpo-26013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26013}: Added compatibility with broken protocol 2 pickles created in
old Python 3 versions (3.4.3 and lower).

@item 
bpo-26129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26129}: Deprecated accepting non-integers in grp.getgrgid().

@item 
bpo-25850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25850}: Use cross-compilation by default for 64-bit Windows.

@item 
bpo-25822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25822}: Add docstrings to the fields of urllib.parse results. Patch
contributed by Swati Jaiswal.

@item 
bpo-22642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22642}: Convert trace module option parsing mechanism to argparse.
Patch contributed by SilentGhost.

@item 
bpo-24705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24705}: Fix sysconfig._parse_makefile not expanding $@{@} vars appearing
before $() vars.

@item 
bpo-26069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26069}: Remove the deprecated apis in the trace module.

@item 
bpo-22138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22138}: Fix mock.patch behavior when patching descriptors. Restore
original values after patching. Patch contributed by Sean McCully.

@item 
bpo-25672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25672}: In the ssl module, enable the SSL_MODE_RELEASE_BUFFERS mode
option if it is safe to do so.

@item 
bpo-26012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26012}: Don’t traverse into symlinks for @code{**} pattern in
pathlib.Path.[r]glob().

@item 
bpo-24120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24120}: Ignore PermissionError when traversing a tree with
pathlib.Path.[r]glob(). Patch by Ulrich Petri.

@item 
bpo-21815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21815}: Accept ] characters in the data portion of imap responses, in
order to handle the flags with square brackets accepted and produced by
servers such as gmail.

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: fileinput now uses sys.stdin as-is if it does not have a buffer
attribute (restores backward compatibility).

@item 
bpo-25971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25971}: Optimized creating Fractions from floats by 2 times and from
Decimals by 3 times.

@item 
bpo-25802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25802}: Document as deprecated the remaining implementations of
importlib.abc.Loader.load_module().

@item 
bpo-25928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25928}: Add Decimal.as_integer_ratio().

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: Copying the lru_cache() wrapper object now always works,
independently from the type of the wrapped object (by returning the
original object unchanged).

@item 
bpo-25768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25768}: Have the functions in compileall return booleans instead of
ints and add proper documentation and tests for the return values.

@item 
bpo-24103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24103}: Fixed possible use after free in ElementTree.XMLPullParser.

@item 
bpo-25860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25860}: os.fwalk() no longer skips remaining directories when error
occurs. Original patch by Samson Lee.

@item 
bpo-25914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25914}: Fixed and simplified OrderedDict.__sizeof__.

@item 
bpo-25869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25869}: Optimized deepcopying ElementTree; it is now 20 times faster.

@item 
bpo-25873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25873}: Optimized iterating ElementTree.  Iterating elements
Element.iter() is now 40% faster, iterating text Element.itertext() is now
up to 2.5 times faster.

@item 
bpo-25902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25902}: Fixed various refcount issues in ElementTree iteration.

@item 
bpo-22227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22227}: The TarFile iterator is reimplemented using generator. This
implementation is simpler that using class.

@item 
bpo-25638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25638}: Optimized ElementTree.iterparse(); it is now 2x faster.
Optimized ElementTree parsing; it is now 10% faster.

@item 
bpo-25761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25761}: Improved detecting errors in broken pickle data.

@item 
bpo-25717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25717}: Restore the previous behaviour of tolerating most fstat()
errors when opening files.  This was a regression in 3.5a1, and stopped
anonymous temporary files from working in special cases.

@item 
bpo-24903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24903}: Fix regression in number of arguments compileall accepts when
“-d” is specified.  The check on the number of arguments has been dropped
completely as it never worked correctly anyway.

@item 
bpo-25764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25764}: In the subprocess module, preserve any exception caused by
fork() failure when preexec_fn is used.

@item 
bpo-25771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25771}: Tweak the exception message for importlib.util.resolve_name()
when “package” isn’t specified but necessary.

@item 
bpo-6478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6478}: _strptime’s regexp cache now is reset after changing timezone
with time.tzset().

@item 
bpo-14285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14285}: When executing a package with the «python -m package» option,
and package initialization fails, a proper traceback is now reported.  The
«runpy» module now lets exceptions from package initialization pass back
to the caller, rather than raising ImportError.

@item 
bpo-19771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19771}: Also in runpy and the «-m» option, omit the irrelevant message
«… is a package and cannot be directly executed» if the package could
not even be initialized (e.g. due to a bad @code{*.pyc} file).

@item 
bpo-25177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25177}: Fixed problem with the mean of very small and very large
numbers. As a side effect, statistics.mean and statistics.variance should
be significantly faster.

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: Fixed copying object with state with boolean value is false.

@item 
bpo-10131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10131}: Fixed deep copying of minidom documents.  Based on patch by
Marian Ganisin.

@item 
bpo-7990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7990}: dir() on ElementTree.Element now lists properties: «tag»,
«text», «tail» and «attrib».  Original patch by Santoso Wijaya.

@item 
bpo-25725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25725}: Fixed a reference leak in pickle.loads() when unpickling
invalid data including tuple instructions.

@item 
bpo-25663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25663}: In the Readline completer, avoid listing duplicate global
names, and search the global namespace before searching builtins.

@item 
bpo-25688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25688}: Fixed file leak in ElementTree.iterparse() raising an error.

@item 
bpo-23914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23914}: Fixed SystemError raised by unpickler on broken pickle data.

@item 
bpo-25691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25691}: Fixed crash on deleting ElementTree.Element attributes.

@item 
bpo-25624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25624}: ZipFile now always writes a ZIP_STORED header for directory
entries.  Patch by Dingyuan Wang.

@item 
bpo-25626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25626}: Change three zlib functions to accept sizes that fit in
Py_ssize_t, but internally cap those sizes to UINT_MAX.  This resolves a
regression in 3.5 where GzipFile.read() failed to read chunks larger than
2 or 4 GiB.  The change affects the zlib.Decompress.decompress()
max_length parameter, the zlib.decompress() bufsize parameter, and the
zlib.Decompress.flush() length parameter.

@item 
bpo-25583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25583}: Avoid incorrect errors raised by os.makedirs(exist_ok=True)
when the OS gives priority to errors such as EACCES over EEXIST.

@item 
bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}: Change semantics of EventLoop.stop() in asyncio.

@item 
bpo-6973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6973}: When we know a subprocess.Popen process has died, do not allow
the send_signal(), terminate(), or kill() methods to do anything as they
could potentially signal a different process.

@item 
bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883}: Added missing APIs to __all__ to match the documented APIs for
the following modules: calendar, csv, enum, fileinput, ftplib, logging,
optparse, tarfile, threading and wave.  Also added a
test.support.check__all__() helper. Patches by Jacek Kołodziej, Mauro S.
M. Rodrigues and Joel Taddei.

@item 
bpo-25590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25590}: In the Readline completer, only call getattr() once per
attribute.  Also complete names of attributes such as properties and slots
which are listed by dir() but not yet created on an instance.

@item 
bpo-25498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25498}: Fix a crash when garbage-collecting ctypes objects created by
wrapping a memoryview.  This was a regression made in 3.5a1.  Based on
patch by Eryksun.

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: Added «escape» to the __all__ list in the glob module.

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: Fixed recursive glob() with patterns starting with @code{**}.

@item 
bpo-25446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25446}: Fix regression in smtplib’s AUTH LOGIN support.

@item 
bpo-18010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18010}: Fix the pydoc web server’s module search function to handle
exceptions from importing packages.

@item 
bpo-25554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25554}: Got rid of circular references in regular expression parsing.

@item 
bpo-18973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18973}: Command-line interface of the calendar module now uses argparse
instead of optparse.

@item 
bpo-25510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25510}: fileinput.FileInput.readline() now returns b”” instead of “” at
the end if the FileInput was opened with binary mode. Patch by Ryosuke
Ito.

@item 
bpo-25503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25503}: Fixed inspect.getdoc() for inherited docstrings of properties.
Original patch by John Mark Vandenberg.

@item 
bpo-25515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25515}: Always use os.urandom as a source of randomness in uuid.uuid4.

@item 
bpo-21827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21827}: Fixed textwrap.dedent() for the case when largest common
whitespace is a substring of smallest leading whitespace. Based on patch
by Robert Li.

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: The lru_cache() wrapper objects now can be copied and pickled
(by returning the original object unchanged).

@item 
bpo-25390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25390}: typing: Don’t crash on Union[str, Pattern].

@item 
bpo-25441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25441}: asyncio: Raise error from drain() when socket is closed.

@item 
bpo-25410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25410}: Cleaned up and fixed minor bugs in C implementation of
OrderedDict.

@item 
bpo-25411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25411}: Improved Unicode support in SMTPHandler through better use of
the email package. Thanks to user simon04 for the patch.

@item 
Move the imp module from a PendingDeprecationWarning to
DeprecationWarning.

@item 
bpo-25407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25407}: Remove mentions of the formatter module being removed in Python
3.6.

@item 
bpo-25406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25406}: Fixed a bug in C implementation of OrderedDict.move_to_end()
that caused segmentation fault or hang in iterating after moving several
items to the start of ordered dict.

@item 
bpo-25382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25382}: pickletools.dis() now outputs implicit memo index for the
MEMOIZE opcode.

@item 
bpo-25357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25357}: Add an optional newline parameter to binascii.b2a_base64().
base64.b64encode() uses it to avoid a memory copy.

@item 
bpo-24164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24164}: Objects that need calling @code{__new__} with keyword arguments,
can now be pickled using pickle protocols older than protocol version 4.

@item 
bpo-25364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25364}: zipfile now works in threads disabled builds.

@item 
bpo-25328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25328}: smtpd’s SMTPChannel now correctly raises a ValueError if both
decode_data and enable_SMTPUTF8 are set to true.

@item 
bpo-16099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16099}: RobotFileParser now supports Crawl-delay and Request-rate
extensions.  Patch by Nikolay Bogoychev.

@item 
bpo-25316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25316}: distutils raises OSError instead of DistutilsPlatformError when
MSVC is not installed.

@item 
bpo-25380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25380}: Fixed protocol for the STACK_GLOBAL opcode in
pickletools.opcodes.

@item 
bpo-23972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23972}: Updates asyncio datagram create method allowing reuseport and
reuseaddr socket options to be set prior to binding the socket. Mirroring
the existing asyncio create_server method the reuseaddr option for
datagram sockets defaults to True if the O/S is “posix” (except if the
platform is Cygwin). Patch by Chris Laws.

@item 
bpo-25304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25304}: Add asyncio.run_coroutine_threadsafe().  This lets you submit a
coroutine to a loop from another thread, returning a
concurrent.futures.Future.  By Vincent Michel.

@item 
bpo-25232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25232}: Fix CGIRequestHandler to split the query from the URL at the
first question mark (?) rather than the last. Patch from Xiang Zhang.

@item 
bpo-24657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24657}: Prevent CGIRequestHandler from collapsing slashes in the query
part of the URL as if it were a path. Patch from Xiang Zhang.

@item 
bpo-25287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25287}: Don’t add crypt.METHOD_CRYPT to crypt.methods if it’s not
supported. Check if it is supported, it may not be supported on OpenBSD
for example.

@item 
bpo-23600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23600}: Default implementation of tzinfo.fromutc() was returning wrong
results in some cases.

@item 
bpo-25203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25203}: Failed readline.set_completer_delims() no longer left the
module in inconsistent state.

@item 
bpo-25011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25011}: rlcompleter now omits private and special attribute names
unless the prefix starts with underscores.

@item 
bpo-25209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25209}: rlcompleter now can add a space or a colon after completed
keyword.

@item 
bpo-22241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22241}: timezone.utc name is now plain “UTC”, not “UTC-00:00”.

@item 
bpo-23517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23517}: fromtimestamp() and utcfromtimestamp() methods of
datetime.datetime now round microseconds to nearest with ties going to
nearest even integer (ROUND_HALF_EVEN), as round(float), instead of
rounding towards -Infinity (ROUND_FLOOR).

@item 
bpo-23552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23552}: Timeit now warns when there is substantial (4x) variance
between best and worst times. Patch from Serhiy Storchaka.

@item 
bpo-24633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24633}: site-packages/README -> README.txt.

@item 
bpo-24879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24879}: help() and pydoc can now list named tuple fields in the order
they were defined rather than alphabetically.  The ordering is determined
by the _fields attribute if present.

@item 
bpo-24874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24874}: Improve speed of itertools.cycle() and make its pickle more
compact.

@item 
Fix crash in itertools.cycle.__setstate__() when the first argument wasn’t
a list.

@item 
bpo-20059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20059}: urllib.parse raises ValueError on all invalid ports. Patch by
Martin Panter.

@item 
bpo-24360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24360}: Improve __repr__ of argparse.Namespace() for invalid
identifiers.  Patch by Matthias Bussonnier.

@item 
bpo-23426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23426}: run_setup was broken in distutils. Patch from Alexander
Belopolsky.

@item 
bpo-13938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13938}: 2to3 converts StringTypes to a tuple. Patch from Mark Hammond.

@item 
bpo-2091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2091}: open() accepted a “U” mode string containing “+”, but “U” can
only be used with “r”. Patch from Jeff Balogh and John O’Connor.

@item 
bpo-8585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8585}: improved tests for zipimporter2. Patch from Mark Lawrence.

@item 
bpo-18622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18622}: unittest.mock.mock_open().reset_mock would recurse infinitely.
Patch from Nicola Palumbo and Laurent De Buyst.

@item 
bpo-24426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24426}: Fast searching optimization in regular expressions now works
for patterns that starts with capturing groups.  Fast searching
optimization now can’t be disabled at compile time.

@item 
bpo-23661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23661}: unittest.mock side_effects can now be exceptions again. This
was a regression vs Python 3.4. Patch from Ignacio Rossi

@item 
bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}: Remove deprecated inspect.getmoduleinfo function.

@item 
bpo-25578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25578}: Fix (another) memory leak in SSLSocket.getpeercer().

@item 
bpo-25530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25530}: Disable the vulnerable SSLv3 protocol by default when creating
ssl.SSLContext.

@item 
bpo-25569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25569}: Fix memory leak in SSLSocket.getpeercert().

@item 
bpo-25471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25471}: Sockets returned from accept() shouldn’t appear to be
nonblocking.

@item 
bpo-25319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25319}: When threading.Event is reinitialized, the underlying condition
should use a regular lock rather than a recursive lock.

@item 
Skip getaddrinfo if host is already resolved. Patch by A. Jesse Jiryu
Davis.

@item 
bpo-26050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26050}: Add asyncio.StreamReader.readuntil() method. Patch by Марк
Коренберг.

@item 
bpo-25924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25924}: Avoid unnecessary serialization of getaddrinfo(3) calls on OS X
versions 10.5 or higher.  Original patch by A. Jesse Jiryu Davis.

@item 
bpo-26406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26406}: Avoid unnecessary serialization of getaddrinfo(3) calls on
current versions of OpenBSD and NetBSD.  Patch by A. Jesse Jiryu Davis.

@item 
bpo-26848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26848}: Fix asyncio/subprocess.communicate() to handle empty input.
Patch by Jack O’Connor.

@item 
bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}: Add loop.get_exception_handler method

@item 
bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}: asyncio: Add loop.create_future method
@end itemize

@node IDLE<52>,Documentation<65>,Library<72>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id634}@anchor{1b60}
@subsubsection IDLE



@itemize -

@item 
bpo-20640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20640}: Add tests for idlelib.configHelpSourceEdit. Patch by Saimadhav
Heblikar.

@item 
In the “IDLE-console differences” section of the IDLE doc, clarify how
running with IDLE affects sys.modules and the standard streams.

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: fix incorrect change in IOBinding that prevented printing.
Augment IOBinding htest to include all major IOBinding functions.

@item 
bpo-25905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25905}: Revert unwanted conversion of “ to ’ RIGHT SINGLE QUOTATION
MARK in README.txt and open this and NEWS.txt with “ascii”. Re-encode
CREDITS.txt to utf-8 and open it with “utf-8”.

@item 
bpo-15348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15348}: Stop the debugger engine (normally in a user process) before
closing the debugger window (running in the IDLE process). This prevents
the RuntimeErrors that were being caught and ignored.

@item 
bpo-24455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24455}: Prevent IDLE from hanging when a) closing the shell while the
debugger is active (15347); b) closing the debugger with the [X] button
(15348); and c) activating the debugger when already active (24455). The
patch by Mark Roseman does this by making two changes. 1. Suspend and
resume the gui.interaction method with the tcl vwait mechanism intended
for this purpose (instead of root.mainloop & .quit). 2. In gui.run, allow
any existing interaction to terminate first.

@item 
Change “The program” to “Your program” in an IDLE “kill program?” message
to make it clearer that the program referred to is the currently running
user program, not IDLE itself.

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: Improve the appearance of the IDLE editor window status bar.
Patch by Mark Roseman.

@item 
bpo-25313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25313}: Change the handling of new built-in text color themes to better
address the compatibility problem introduced by the addition of IDLE Dark.
Consistently use the revised idleConf.CurrentTheme everywhere in idlelib.

@item 
bpo-24782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24782}: Extension configuration is now a tab in the IDLE Preferences
dialog rather than a separate dialog.  The former tabs are now a sorted
list.  Patch by Mark Roseman.

@item 
bpo-22726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22726}: Re-activate the config dialog help button with some content
about the other buttons and the new IDLE Dark theme.

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: IDLE now has an “IDLE Dark” built-in text color theme. It is
more or less IDLE Classic inverted, with a cobalt blue background.
Strings, comments, keywords, … are still green, red, orange, … . To
use it with IDLEs released before November 2015, hit the “Save as New
Custom Theme” button and enter a new name, such as “Custom Dark”.  The
custom theme will work with any IDLE release, and can be modified.

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: README.txt is now an idlelib index for IDLE developers and
curious users. The previous user content is now in the IDLE doc chapter.
“IDLE” now means “Integrated Development and Learning Environment”.

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: Users can now set breakpoint colors in Settings -> Custom
Highlighting. Original patch by Mark Roseman.

@item 
bpo-24972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24972}: Inactive selection background now matches active selection
background, as configured by users, on all systems.  Found items are now
always highlighted on Windows.  Initial patch by Mark Roseman.

@item 
bpo-24570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24570}: Idle: make calltip and completion boxes appear on Macs affected
by a tk regression.  Initial patch by Mark Roseman.

@item 
bpo-24988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24988}: Idle ScrolledList context menus (used in debugger) now work on
Mac Aqua. Patch by Mark Roseman.

@item 
bpo-24801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24801}: Make right-click for context menu work on Mac Aqua. Patch by
Mark Roseman.

@item 
bpo-25173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25173}: Associate tkinter messageboxes with a specific widget. For Mac
OSX, make them a “sheet”.  Patch by Mark Roseman.

@item 
bpo-25198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25198}: Enhance the initial html viewer now used for Idle Help.
Properly indent fixed-pitch text (patch by Mark Roseman). Give code
snippet a very Sphinx-like light blueish-gray background. Re-use initial
width and height set by users for shell and editor. When the Table of
Contents (TOC) menu is used, put the section header at the top of the
screen.

@item 
bpo-25225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25225}: Condense and rewrite Idle doc section on text colors.

@item 
bpo-21995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21995}: Explain some differences between IDLE and console Python.

@item 
bpo-22820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22820}: Explain need for `print' when running file from Idle editor.

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: Doc: augment Idle feature list and no-subprocess section.

@item 
bpo-25219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25219}: Update doc for Idle command line options. Some were missing and
notes were not correct.

@item 
bpo-24861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24861}: Most of idlelib is private and subject to change. Use
idleib.idle.* to start Idle. See idlelib.__init__.__doc__.

@item 
bpo-25199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25199}: Idle: add synchronization comments for future maintainers.

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: Replace help.txt with help.html for Idle doc display. The new
idlelib/help.html is rstripped Doc/build/html/library/idle.html. It looks
better than help.txt and will better document Idle as released. The
tkinter html viewer that works for this file was written by Rose Roseman.
The now unused EditorWindow.HelpDialog class and helt.txt file are
deprecated.

@item 
bpo-24199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24199}: Deprecate unused idlelib.idlever with possible removal in 3.6.

@item 
bpo-24790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24790}: Remove extraneous code (which also create 2 & 3 conflicts).
@end itemize

@node Documentation<65>,Tests<66>,IDLE<52>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id635}@anchor{1b61}
@subsubsection Documentation



@itemize -

@item 
bpo-26736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26736}: Used HTTPS for external links in the documentation if possible.

@item 
bpo-6953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6953}: Rework the Readline module documentation to group related
functions together, and add more details such as what underlying Readline
functions and variables are accessed.

@item 
bpo-23606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23606}: Adds note to ctypes documentation regarding cdll.msvcrt.

@item 
bpo-24952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24952}: Clarify the default size argument of stack_size() in the
«threading» and «_thread» modules. Patch from Mattip.

@item 
bpo-26014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26014}: Update 3.x packaging documentation: * «See also» links to the
new docs are now provided in the legacy pages * links to setuptools
documentation have been updated
@end itemize

@node Tests<66>,Build<71>,Documentation<65>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id636}@anchor{1b62}
@subsubsection Tests



@itemize -

@item 
bpo-21916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21916}: Added tests for the turtle module.  Patch by ingrid, Gregory
Loyse and Jelle Zijlstra.

@item 
bpo-26295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26295}: When using «python3 -m test –testdir=TESTDIR», regrtest
doesn’t add «test.» prefix to test module names.

@item 
bpo-26523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26523}: The multiprocessing thread pool (multiprocessing.dummy.Pool)
was untested.

@item 
bpo-26015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26015}: Added new tests for pickling iterators of mutable sequences.

@item 
bpo-26325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26325}: Added test.support.check_no_resource_warning() to check that no
ResourceWarning is emitted.

@item 
bpo-25940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25940}: Changed test_ssl to use its internal local server more.  This
avoids relying on svn.python.org, which recently changed root certificate.

@item 
bpo-25616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25616}: Tests for OrderedDict are extracted from test_collections into
separate file test_ordered_dict.

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: Added tests for OrderedDict subclasses.

@item 
bpo-25188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25188}: Add -P/–pgo to test.regrtest to suppress error output when
running the test suite for the purposes of a PGO build. Initial patch by
Alecsandru Patrascu.

@item 
bpo-22806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22806}: Add @code{python -m test --list-tests} command to list tests.

@item 
bpo-18174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18174}: @code{python -m test --huntrleaks ...} now also checks for leak of
file descriptors. Patch written by Richard Oudkerk.

@item 
bpo-25260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25260}: Fix @code{python -m test --coverage} on Windows. Remove the list
of ignored directories.

@item 
@code{PCbuild\rt.bat} now accepts an unlimited number of arguments to pass
along to regrtest.py.  Previously there was a limit of 9.

@item 
bpo-26583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26583}: Skip test_timestamp_overflow in test_import if bytecode files
cannot be written.
@end itemize

@node Build<71>,Windows<64>,Tests<66>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id637}@anchor{1b63}
@subsubsection Build



@itemize -

@item 
bpo-21277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21277}: Don’t try to link _ctypes with a ffi_convenience library.

@item 
bpo-26884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26884}: Fix linking extension modules for cross builds. Patch by Xavier
de Gaye.

@item 
bpo-26932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26932}: Fixed support of RTLD_* constants defined as enum values, not
via macros (in particular on Android).  Patch by Chi Hsuan Yen.

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: Disable the rules for running _freeze_importlib and pgen when
cross-compiling.  The output of these programs is normally saved with the
source code anyway, and is still regenerated when doing a native build.
Patch by Xavier de Gaye.

@item 
bpo-21668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21668}: Link audioop, _datetime, _ctypes_test modules to libm, except
on Mac OS X. Patch written by Chi Hsuan Yen.

@item 
bpo-25702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25702}: A –with-lto configure option has been added that will enable
link time optimizations at build time during a make profile-opt. Some
compilers and toolchains are known to not produce stable code when using
LTO, be sure to test things thoroughly before relying on it. It can
provide a few % speed up over profile-opt alone.

@item 
bpo-26624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26624}: Adds validation of ucrtbase[d].dll version with warning for old
versions.

@item 
bpo-17603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17603}: Avoid error about nonexistent fileblocks.o file by using a
lower-level check for st_blocks in struct stat.

@item 
bpo-26079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26079}: Fixing the build output folder for tix-8.4.3.6. Patch by Bjoern
Thiel.

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: Update Windows builds to use OpenSSL 1.0.2g.

@item 
bpo-25348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25348}: Added @code{--pgo} and @code{--pgo-job} arguments to
@code{PCbuild\build.bat} for building with Profile-Guided Optimization.  The
old @code{PCbuild\build_pgo.bat} script is removed.

@item 
bpo-25827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25827}: Add support for building with ICC to @code{configure}, including a
new @code{--with-icc} flag.

@item 
bpo-25696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25696}: Fix installation of Python on UNIX with make -j9.

@item 
bpo-24986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24986}: It is now possible to build Python on Windows without errors
when external libraries are not available.

@item 
bpo-24421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24421}: Compile Modules/_math.c once, before building extensions.
Previously it could fail to compile properly if the math and cmath builds
were concurrent.

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: Update OS X 10.5+ 32-bit-only installer to build and link with
OpenSSL 1.0.2g.

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: Update Windows builds to use OpenSSL 1.0.2f.

@item 
bpo-25136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25136}: Support Apple Xcode 7’s new textual SDK stub libraries.

@item 
bpo-24324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24324}: Do not enable unreachable code warnings when using gcc as the
option does not work correctly in older versions of gcc and has been
silently removed as of gcc-4.5.
@end itemize

@node Windows<64>,Tools/Demos<41>,Build<71>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id638}@anchor{1b64}
@subsubsection Windows



@itemize -

@item 
bpo-27053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27053}: Updates make_zip.py to correctly generate library ZIP file.

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: Update the prepare_ssl.py script to handle OpenSSL releases
that don’t include the contents of the include directory (that is, 1.0.2e
and later).

@item 
bpo-26071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26071}: bdist_wininst created binaries fail to start and find 32bit
Python

@item 
bpo-26073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26073}: Update the list of magic numbers in launcher

@item 
bpo-26065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26065}: Excludes venv from library when generating embeddable distro.

@item 
bpo-25022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25022}: Removed very outdated PC/example_nt/ directory.
@end itemize

@node Tools/Demos<41>,C API<61>,Windows<64>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id639}@anchor{1b65}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-26799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26799}: Fix python-gdb.py: don’t get C types once when the Python code
is loaded, but get C types on demand. The C types can change if
python-gdb.py is loaded before the Python executable. Patch written by
Thomas Ilsche.

@item 
bpo-26271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26271}: Fix the Freeze tool to properly use flags passed through
configure. Patch by Daniel Shaulov.

@item 
bpo-26489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26489}: Add dictionary unpacking support to Tools/parser/unparse.py.
Patch by Guo Ci Teo.

@item 
bpo-26316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26316}: Fix variable name typo in Argument Clinic.

@item 
bpo-25440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25440}: Fix output of python-config –extension-suffix.

@item 
bpo-25154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25154}: The pyvenv script has been deprecated in favour of @code{python3 -m
venv}.
@end itemize

@node C API<61>,,Tools/Demos<41>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id640}@anchor{1b66}
@subsubsection C API



@itemize -

@item 
bpo-26312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26312}: SystemError is now raised in all programming bugs with using
PyArg_ParseTupleAndKeywords().  RuntimeError did raised before in some
programming bugs.

@item 
bpo-26198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26198}: ValueError is now raised instead of TypeError on buffer
overflow in parsing «es#» and «et#» format units.  SystemError is now
raised instead of TypeError on programmatical error in parsing format
string.
@end itemize

@node Python 3 5 5 final,Python 3 5 5 release candidate 1,Python 3 6 0 alpha 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-5-final}@anchor{1b67}
@subsection Python 3.5.5 final


`Release date: 2018-02-04'

There were no new changes in version 3.5.5.

@node Python 3 5 5 release candidate 1,Python 3 5 4 final,Python 3 5 5 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-5-release-candidate-1}@anchor{1b68}
@subsection Python 3.5.5 release candidate 1


`Release date: 2018-01-23'

@menu
* Security: Security<43>. 
* Core and Builtins: Core and Builtins<73>. 
* Library: Library<73>. 

@end menu

@node Security<43>,Core and Builtins<73>,,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id641}@anchor{1b69}
@subsubsection Security



@itemize -

@item 
bpo-32551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32551}: The @code{sys.path[0]} initialization change for bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} caused
a regression by revealing an inconsistency in how sys.path is initialized
when executing @code{__main__} from a zipfile, directory, or other import
location. This is considered a potential security issue, as it may lead to
privileged processes unexpectedly loading code from user controlled
directories in situations where that was not previously the case. The
interpreter now consistently avoids ever adding the import location’s
parent directory to @code{sys.path}, and ensures no other @code{sys.path}
entries are inadvertently modified when inserting the import location
named on the command line. (Originally reported as bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723} against
Python 3.6rc1, but it was missed at the time that the then upcoming Python
3.5.4 release would also be affected)

@item 
bpo-30657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30657}: Fixed possible integer overflow in PyBytes_DecodeEscape,
@geindex Common Vulnerabilities and Exposures; CVE 2017-1000158
CVE 2017-1000158@footnote{https://www.cve.org/CVERecord?id=CVE-2017-1000158}. Original patch by Jay Bosamiya; rebased to Python 3
by Miro Hrončok.

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: Upgrade libexpat embedded copy from version 2.2.1 to 2.2.3 to
get security fixes.
@end itemize

@node Core and Builtins<73>,Library<73>,Security<43>,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id642}@anchor{1b6a}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: Fix potential crash during GC caused by @code{tp_dealloc} which
doesn’t call @code{PyObject_GC_UnTrack()}.
@end itemize

@node Library<73>,,Core and Builtins<73>,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id643}@anchor{1b6b}
@subsubsection Library



@itemize -

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: Fixed issues with binary plists: Fixed saving bytearrays.
Identical objects will be saved only once. Equal references will be load
as identical objects. Added support for saving and loading recursive data
structures.

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: Update libexpat from 2.2.3 to 2.2.4. Fix copying of
partial characters for UTF-8 input (libexpat bug 115):
@indicateurl{https://github.com/libexpat/libexpat/issues/115}
@end itemize

@node Python 3 5 4 final,Python 3 5 4 release candidate 1,Python 3 5 5 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-4-final}@anchor{1b6c}
@subsection Python 3.5.4 final


`Release date: 2017-08-07'

@menu
* Library: Library<74>. 

@end menu

@node Library<74>,,,Python 3 5 4 final
@anchor{whatsnew/changelog id644}@anchor{1b6d}
@subsubsection Library



@itemize -

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() now throws ValueError on commands that
contains CR or LF. Patch by Donghee Na.
@end itemize

@node Python 3 5 4 release candidate 1,Python 3 5 3 final,Python 3 5 4 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-4-release-candidate-1}@anchor{1b6e}
@subsection Python 3.5.4 release candidate 1


`Release date: 2017-07-23'

@menu
* Security: Security<44>. 
* Core and Builtins: Core and Builtins<74>. 
* Library: Library<75>. 
* Documentation: Documentation<66>. 
* Tests: Tests<67>. 
* Build: Build<72>. 
* Windows: Windows<65>. 
* C API: C API<62>. 

@end menu

@node Security<44>,Core and Builtins<74>,,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id645}@anchor{1b6f}
@subsubsection Security



@itemize -

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: Prevent environment variables injection in subprocess on
Windows.  Prevent passing other environment variables and command
arguments.

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes of multiple
security vulnerabilities including: 
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233
CVE 2017-9233@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233} (External entity
infinite loop DoS), 
@geindex Common Vulnerabilities and Exposures; CVE 2016-9063
CVE 2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2016-9063} (Integer overflow, re-fix),
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} (Fix regression bugs from 2.2.0’s fix to
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718}) and 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876
CVE 2012-0876@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876} (Counter hash flooding with
SipHash). Note: the 
@geindex Common Vulnerabilities and Exposures; CVE 2016-5300
CVE 2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2016-5300} (Use os-specific entropy sources like
getrandom) doesn’t impact Python, since Python already gets entropy from
the OS to set the expat secret using @code{XML_SetHashSalt()}.

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: Fix urllib.parse.splithost() to correctly parse fragments. For
example, @code{splithost('//127.0.0.1#@@evil.com/')} now correctly returns the
@code{127.0.0.1} host, instead of treating @code{@@evil.com} as the host in an
authentication (@code{login@@host}).

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: Update expat copy from 2.1.1 to 2.2.0 to get fixes of
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} and 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}. See
@indicateurl{https://sourceforge.net/p/expat/bugs/537/} for more information.
@end itemize

@node Core and Builtins<74>,Library<75>,Security<44>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id646}@anchor{1b70}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: Relative import from unloaded package now reimports the package
instead of failing with SystemError.  Relative import from non-package now
fails with ImportError rather than SystemError.

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: Avoid blocking in pthread_mutex_lock() when
PyThread_acquire_lock() is asked not to block.

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: Fixed various segfaults with dict when input collections are
mutated during searching, inserting or comparing.  Based on patches by
Duane Griffin and Tim Mitchell.

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: Fixed type.__setattr__() and type.__delattr__() for
non-interned attribute names.  Based on patch by Eryk Sun.

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: Fixed error messages in the index() method of tuple, list and
deque when pass indices of wrong type.

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: @code{bool(range)} works even if @code{len(range)} raises
@ref{919,,OverflowError}.

@item 
bpo-29600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29600}: Fix wrapping coroutine return values in StopIteration.

@item 
bpo-29537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29537}: Restore runtime compatibility with bytecode files generated by
CPython 3.5.0 to 3.5.2, and adjust the eval loop to avoid the problems
that could be caused by the malformed variant of the
BUILD_MAP_UNPACK_WITH_CALL opcode that they may contain. Patch by Petr
Viktorin, Serhiy Storchaka, and Nick Coghlan.

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: Support __rmod__ for subclasses of str being called before
str.__mod__. Patch by Martijn Pieters.

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: Fix incorrect handling of signed zeros in complex constructor
for complex subclasses and for inputs having a __complex__ method. Patch
by Serhiy Storchaka.

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: Fixed possibly dereferencing undefined pointers when creating
weakref objects.

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: Fixed use-after-free problem in key sharing dict.

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: Prevent RunMainFromImporter overwriting sys.path[0].

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: Fixed possible BytesWarning when compare the code objects.
Warnings could be emitted at compile time.

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: If max_line_length=None is specified while using the Compat32
policy, it is no longer ignored.  Patch by Mircea Cosbuc.
@end itemize

@node Library<75>,Documentation<66>,Core and Builtins<74>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id647}@anchor{1b71}
@subsubsection Library



@itemize -

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: Fix @code{unittest.mock}’s autospec to not fail on method-bound
builtin functions.  Patch by Aaron Gallagher.

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: Fix decrementing a borrowed reference in tracemalloc.

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: Fix multiprocessing.Queue.join_thread(): it now waits until the
thread completes, even if the thread was started by the same process which
created the queue.

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: Fix segfault in readline when using readline’s history-size
option.  Patch by Nir Soffer.

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: signal.setitimer() may disable the timer when passed a tiny
value. Tiny values (such as 1e-6) are valid non-zero values for
setitimer(), which is specified as taking microsecond-resolution
intervals. However, on some platform, our conversion routine could convert
1e-6 into a zero interval, therefore disabling the timer instead of
(re-)scheduling it.

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: Fix bug when modifying os.environ while iterating over it

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: Fix email header value parser dropping folding white space in
certain cases.

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: Update zlib to 1.2.11.

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() and os.scandir() now emit bytes names when called
with bytes-like argument.

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: Prohibited the “=” character in environment variable names in
@code{os.putenv()} and @code{os.spawn*()}.

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: Fixed the lgettext() family of functions in the gettext module.
They now always return bytes.

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: Fix path calculation in imp.load_package(), fixing it for cases
when a package is only shipped with bytecodes. Patch by Alexandru
Ardelean.

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() now manually breaks a
reference cycle to not keep objects alive longer than expected.

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() now supports callables with
variable-argument parameters wrapped with partialmethod. Patch by Donghee
Na.

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: Fixed comparison check for ipaddress.ip_interface objects.
Patch by Sanjay Sundaresan.

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: Avoid race condition in multiprocessing cleanup.

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: The traceback no longer displayed for SystemExit raised in a
callback registered by atexit.

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: Don’t log exceptions if Task/Future «cancel()» method was
called.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Updates to typing module: Add generic AsyncContextManager, add
support for ContextManager on all versions. Original PRs by Jelle Zijlstra
and Ivan Levkivskyi

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: Fix ssl sockets leaks when connection is aborted in asyncio/ssl
implementation. Patch by Michaël Sghaïer.

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: Closing transport during handshake process leaks open socket.
Patch by Nikolay Kim

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: Fix waiter cancellation in asyncio.Lock. Patch by Mathieu
Sornay.

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: On Windows, subprocess.Popen.communicate() now also ignore
EINVAL on stdin.write() if the child process is still running but closed
the pipe.

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: Fix the problem that logging.handlers.SysLogHandler cannot
handle IPv6 addresses.

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: Preserve generator state when _random.Random.setstate() raises
an exception. Patch by Bryan Olson.

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed background running thread do not
break from main loop on exception.

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: Fix handling escape characters in HZ codec.  Based on patch by
Ma Lin.

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: Fix AttributeError when using SimpleQueue.empty() under `spawn'
and `forkserver' start methods.

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib and poplib now catch the Windows socket WSAEINVAL error
(code 10022) on shutdown(SHUT_RDWR): An invalid operation was attempted.
This error occurs sometimes on SSL connections.

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: Warnings emitted when compile a regular expression now always
point to the line in the user code.  Previously they could point into
inners of the re module if emitted from inside of groups or conditionals.

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: Fixed @code{Task.cancel()} can be ignored when the task is running
coroutine and the coroutine returned without any more @code{await}.

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: Fix range checking in GB18030 decoder.  Original patch by Ma
Lin.

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: Change resulted because of zipfile breakage. (See also:
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094})

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: Removed the __init__ methods of _json’s scanner and encoder.
Misusing them could cause memory leaks or crashes.  Now scanner and
encoder objects are completely initialized in the __new__ methods.

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: Avoid KeyboardInterrupt tracebacks in forkserver helper process
when Ctrl-C is received.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: add typing.NoReturn type, use
WrapperDescriptorType, minor bug-fixes.  Original PRs by Jim
Fasarakis-Hilliard and Ivan Levkivskyi.

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: Fix getsockname() for unbound AF_UNIX sockets on Linux.

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: Fixed leaks and crashes in errors handling in the parser
module.

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: Fixed crashes in IOBase methods __next__() and readlines() when
readline() or __next__() respectively return non-sizeable object. Fixed
possible other errors caused by not checking results of PyObject_Size(),
PySequence_Size(), or PyMapping_Size().

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: _io._IOBase.readlines will check if it’s closed first when hint
is present.

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: Fixed race condition in pathlib mkdir with flags parents=True.
Patch by Armin Rigo.

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: Fixed arbitrary unchaining of RuntimeError exceptions in
contextlib.contextmanager.  Patch by Siddharth Velankar.

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling and copying ImportError now preserves name and path
attributes.

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: Fix a crash in itertools.chain.from_iterable when encountering
long runs of empty iterables.

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: Fixed multiple crashes in ElementTree caused by race conditions
and wrong types.

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: Fixed a bug in pools in multiprocessing.pool that raising an
exception at the very first of an iterable may swallow the exception or
make the program hang. Patch by Davin Potts and Xiang Zhang.

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: Avoid incorrect errors raised by Path.mkdir(exist_ok=True) when
the OS gives priority to errors such as EACCES over EEXIST.

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: Release references to tasks, their arguments and their results
as soon as they are finished in multiprocessing.Pool.

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: Restore the old sigaltstack during teardown.
Patch by Christophe Zeitouny.

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: Fixed crashes in repr of recursive buffered file-like objects.

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: Fix crashes in partial.__repr__ if the keys of partial.keywords
are not strings.  Patch by Michael Seifert.

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: get_extra_info() raises exception if get called on closed ssl
transport. Patch by Nikolay Kim.

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: Fixed possible failing or crashing input() if attributes
«encoding» or «errors» of sys.stdin or sys.stdout are not set or are not
strings.

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: Fix a bug that prevented array “Q”, “L” and “I” from accepting
big intables (objects that have __int__) as elements.  Patch by Oren
Milman.

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher no longer chains KeyError (or any other
exception) to exception(s) raised in the dispatched methods. Patch by Petr
Motejlek.

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol no longer closes
before all pipes are closed.

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: Fix asyncio to support instantiation of new event loops in
child processes.

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: Fix assertion error in threading._DummyThread.is_alive().

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: Fix file object leak in aifc.open() when file is given as a
filesystem path and is not in valid AIFF format. Patch by Anthony Zhang.

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: Fix unittest.mock._Call helper: don’t ignore the name parameter
anymore. Patch written by Jiajun Huang.

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: Altering a kwarg dictionary passed to functools.partial() no
longer affects a partial object after creation.

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: Various updates to typing module: typing.Counter,
typing.ChainMap, improved ABC caching, etc. Original PRs by Jelle
Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: Fix datetime.fromtimestamp() regression introduced in Python
3.6.0: check minimum and maximum years.

@item 
bpo-29519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29519}: Fix weakref spewing exceptions during interpreter shutdown when
used with a rare combination of multiprocessing and custom codecs.

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: Prevent infinite loop in pathlib.Path.mkdir

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: Fixed out-of-bounds buffer access in the group() method of the
match object. Based on patch by WGH.

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: Fix subprocess.Popen.wait() when the child process has exited
to a stopped instead of terminated state (ex: when under ptrace).

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: Fix a regression in argparse that help messages would wrap at
non-breaking spaces.

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: Fixed the comparison of mock.MagickMock with mock.ANY.

@item 
bpo-29011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29011}: Fix an important omission by adding Deque to the typing module.

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: Fixed infinite recursion in the repr of uninitialized
ctypes.CDLL instances.

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: Fixed race condition in C implementation of
functools.lru_cache. KeyError could be raised when cached function with
full cache was simultaneously called from different threads with the same
uncached arguments.

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: In urllib.request, suffixes in no_proxy environment variable
with leading dots could match related hostnames again (e.g. .b.c matches
a.b.c). Patch by Milan Oberkirch.
@end itemize

@node Documentation<66>,Tests<67>,Library<75>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id648}@anchor{1b72}
@subsubsection Documentation



@itemize -

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: Add missing attribute related constants in curses
documentation.

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: Add missing info of code object in inspect documentation.

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: Link the documentation to its source file on GitHub.

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: Document smtpd.py as effectively deprecated and add a pointer
to aiosmtpd, a third-party asyncio-based replacement.

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: Add canonical header link on each page to corresponding major
version of the documentation. Patch by Matthias Bussonnier.

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: Fix Python 2 syntax in code for building the documentation.
@end itemize

@node Tests<67>,Build<72>,Documentation<66>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id649}@anchor{1b73}
@subsubsection Tests



@itemize -

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: Fix regrtest command line parser to allow passing -u
extralargefile to run test_zipfile64.

@item 
bpo-30383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30383}: regrtest: Enhance regrtest and backport features from the
master branch. Add options: –coverage, –testdir, –list-tests (list test
files, don’t run them), –list-cases (list test identifiers, don’t run
them, bpo-30523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30523}), –matchfile (load a list of test filters from a
text file, bpo-30540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30540}), –slowest (alias to –slow). Enhance output:
add timestamp, test result, currently running tests, «Tests result: xxx»
summary with total duration, etc. Fix reference leak hunting in regrtest,
–huntrleaks: regrtest now warms up caches, create explicitly all internal
singletons which are created on demand to prevent false positives when
checking for reference leaks. (bpo-30675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30675}).

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() now uses support.threading_setup() and
support.threading_cleanup() to wait until threads complete to avoid random
side effects on following tests. Initial patch written by Grzegorz
Grzywacz.

@item 
bpo-28087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28087}: Skip test_asyncore and test_eintr poll failures on macOS. Skip
some tests of select.poll when running on macOS due to unresolved issues
with the underlying system poll function on some macOS versions.

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: Enhanced functions swap_attr() and swap_item() in the
test.support module. They now work when delete replaced attribute or item
inside the with statement.  The old value of the attribute or item (or
None if it doesn’t exist) now will be assigned to the target of the «as»
clause, if there is one.

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: to match the behaviour of the @code{re.LOCALE} flag,
test_re.test_locale_flag now uses @code{locale.getpreferredencoding(False)}
to determine the candidate encoding for the test regex (allowing it to
correctly skip the test when the default locale encoding is a multi-byte
encoding)
@end itemize

@node Build<72>,Windows<65>,Tests<67>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id650}@anchor{1b74}
@subsubsection Build



@itemize -

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: Prevent unnecessary rebuilding of Python during @code{make test},
@code{make install} and some other make targets when configured with
@code{--enable-optimizations}.

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: Don’t regenerate generated files based on file modification
time anymore: the action is now explicit. Replace @code{make touch} with
@code{make regen-all}.

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: Fix @code{--enable-optimization} didn’t work.
@end itemize

@node Windows<65>,C API<62>,Build<72>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id651}@anchor{1b75}
@subsubsection Windows



@itemize -

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: Locate msbuild.exe on Windows when building rather than
vcvarsall.bat

@item 
bpo-29392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29392}: Prevent crash when passing invalid arguments into msvcrt
module.
@end itemize

@node C API<62>,,Windows<65>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id652}@anchor{1b76}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: Function PySlice_GetIndicesEx() is replaced with a macro if
Py_LIMITED_API is set to the value between 0x03050400 and 0x03060000 (not
including) or 0x03060100 or higher.

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: Fixed the declaration of some public API functions.
PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not available in
limited API. PyArg_ValidateKeywordArguments(), PyArg_UnpackTuple() and
Py_BuildValue() were not available in limited API of version < 3.3 when
PY_SSIZE_T_CLEAN is defined.
@end itemize

@node Python 3 5 3 final,Python 3 5 3 release candidate 1,Python 3 5 4 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-3-final}@anchor{1b77}
@subsection Python 3.5.3 final


`Release date: 2017-01-17'

There were no code changes between 3.5.3rc1 and 3.5.3 final.

@node Python 3 5 3 release candidate 1,Python 3 5 2 final,Python 3 5 3 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-3-release-candidate-1}@anchor{1b78}
@subsection Python 3.5.3 release candidate 1


`Release date: 2017-01-02'

@menu
* Security: Security<45>. 
* Core and Builtins: Core and Builtins<75>. 
* Library: Library<76>. 
* IDLE: IDLE<53>. 
* C API: C API<63>. 
* Documentation: Documentation<67>. 
* Tests: Tests<68>. 
* Tools/Demos: Tools/Demos<42>. 
* Windows: Windows<66>. 
* Build: Build<73>. 

@end menu

@node Security<45>,Core and Builtins<75>,,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id653}@anchor{1b79}
@subsubsection Security



@itemize -

@item 
bpo-27278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27278}: Fix os.urandom() implementation using getrandom() on Linux.
Truncate size to INT_MAX and loop until we collected enough random bytes,
instead of casting a directly Py_ssize_t to int.

@item 
bpo-22636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22636}: Avoid shell injection problems with ctypes.util.find_library().
@end itemize

@node Core and Builtins<75>,Library<76>,Security<45>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id654}@anchor{1b7a}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-29073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29073}: bytearray formatting no longer truncates on first null byte.

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: Do not include <sys/random.h> if it does not exist.

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: Fix a memory leak in split-table dictionaries: setattr() must
not convert combined table into split table.

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: Correct the positioning of the syntax error caret for indented
blocks. Based on patch by Michael Layzell.

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: Fixed bytes formatting of octals with zero padding in alternate
form.

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: Fixed setting the offset attribute of SyntaxError by
PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache() was susceptible to an obscure reentrancy
bug caused by a monkey-patched len() function.

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: Fixed crash in Py_DecodeLocale() in debug build on Mac OS X
when decode astral characters.  Patch by Xiang Zhang.

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: Extra slash no longer added to sys.path components in case of
empty compile-time PYTHONPATH components.

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: Fixed potential crash in PyUnicode_AsDecodedObject() in debug
build.

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: Fixed possible memory leak in _PyTraceback_Add() and exception
loss in PyTraceBack_Here().

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: Added sanity checks and tests for PyUnicode_CopyCharacters().
Patch by Xiang Zhang.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: The type of long range iterator is now registered as Iterator.
Patch by Oren Milman.

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: The constructor of range_iterator now checks that step is not
0. Patch by Oren Milman.

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: Resolving special methods of uninitialized type now causes
implicit initialization of the type instead of a fail.

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() now checks that tp_name is not NULL. Original
patch by Niklas Koep.

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: Fixed possible crash when AST is changed in process of
compiling it.

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: String constants with null character no longer interned.

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: Fix crash when GC runs during weakref callbacks.

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: String constants now interned recursively in tuples and
frozensets.

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: Fixed misleading error message when ImportError called with
invalid keyword args.

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: Fix incorrect type in error message from @code{complex(1.0,
@{2:3@})}. Patch by Soumya Sharma.

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: Fallback on reading /dev/urandom device when the getrandom()
syscall fails with EPERM, for example when blocked by SECCOMP.

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: Fix a regression in zipimport’s compile_source().  zipimport
should use the same optimization level as the interpreter.

@item 
bpo-25221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25221}: Fix corrupted result from PyLong_FromLong(0) when Python is
compiled with NSMALLPOSINTS = 0.

@item 
bpo-25758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25758}: Prevents zipimport from unnecessarily encoding a filename
(patch by Eryk Sun)

@item 
bpo-28189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28189}: dictitems_contains no longer swallows compare errors. (Patch by
Xiang Zhang)

@item 
bpo-27812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27812}: Properly clear out a generator’s frame’s backreference to the
generator to prevent crashes in frame.clear().

@item 
bpo-27811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27811}: Fix a crash when a coroutine that has not been awaited is
finalized with warnings-as-errors enabled.

@item 
bpo-27587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27587}: Fix another issue found by PVS-Studio: Null pointer check after
use of “def” in _PyState_AddModule(). Initial patch by Christian Heimes.

@item 
bpo-26020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26020}: set literal evaluation order did not match documented
behaviour.

@item 
bpo-27782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27782}: Multi-phase extension module import now correctly allows the
@code{m_methods} field to be used to add module level functions to instances
of non-module types returned from @code{Py_create_mod}. Patch by Xiang Zhang.

@item 
bpo-27936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27936}: The round() function accepted a second None argument for some
types but not for others.  Fixed the inconsistency by accepting None for
all numeric types.

@item 
bpo-27487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27487}: Warn if a submodule argument to «python -m» or
runpy.run_module() is found in sys.modules after parent packages are
imported, but before the submodule is executed.

@item 
bpo-27558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27558}: Fix a SystemError in the implementation of «raise» statement.
In a brand new thread, raise a RuntimeError since there is no active
exception to reraise. Patch written by Xiang Zhang.

@item 
bpo-27419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27419}: Standard __import__() no longer look up «__import__» in globals
or builtins for importing submodules or «from import».  Fixed handling an
error of non-string package name.

@item 
bpo-27083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27083}: Respect the PYTHONCASEOK environment variable under Windows.

@item 
bpo-27514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27514}: Make having too many statically nested blocks a SyntaxError
instead of SystemError.

@item 
bpo-27473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27473}: Fixed possible integer overflow in bytes and bytearray
concatenations. Patch by Xiang Zhang.

@item 
bpo-27507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27507}: Add integer overflow check in bytearray.extend().  Patch by
Xiang Zhang.

@item 
bpo-27581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27581}: Don’t rely on wrapping for overflow check in
PySequence_Tuple().  Patch by Xiang Zhang.

@item 
bpo-27443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27443}: __length_hint__() of bytearray iterators no longer return a
negative integer for a resized bytearray.

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: Fix memory leak in codeobject.c
@end itemize

@node Library<76>,IDLE<53>,Core and Builtins<75>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id655}@anchor{1b7b}
@subsubsection Library



@itemize -

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo() now correctly shows the first line of a
context. Patch by Sam Breese.

@item 
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}: Offsets in a ZIP file created with extern file object and modes
«w» and «x» now are relative to the start of the file.

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: Fixed recursion errors in large or resized
curses.textpad.Textbox.  Based on patch by Tycho Andersen.

@item 
bpo-29119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29119}: Fix weakrefs in the pure python version of
collections.OrderedDict move_to_end() method. Contributed by Andra
Bogildea.

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii predicates now work correctly with negative
integers.

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: old keys should not remove new values from WeakValueDictionary
when collecting from another thread.

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: Remove editor artifacts from Tix.py.

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: Fixed a crash when deallocate deep ElementTree.

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: Fix bugs in WeakValueDictionary.setdefault() and
WeakValueDictionary.pop() when a GC collection happens in another thread.

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: Fixed a crash in resource.prlimit() when pass a sequence that
doesn’t own its elements as limits.

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: multiprocessing.set_forkserver_preload() would crash the
forkserver process if a preloaded module instantiated some multiprocessing
objects such as locks.

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb now supports reading read-only files and no longer
writes the index file when it is not changed.

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: In ctypes, prevent a crash calling the from_buffer() and
from_buffer_copy() methods on abstract classes like Array.

@item 
bpo-28732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28732}: Fix crash in os.spawnv() with no elements in args

@item 
bpo-28485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28485}: Always raise ValueError for negative
compileall.compile_dir(workers=…) parameter, even when multithreading is
unavailable.

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: Fixed possible crash in _io.TextIOWrapper deallocator when the
garbage collector is invoked in other thread.  Based on patch by Sebastian
Cufre.

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA compressor and decompressor no longer raise exceptions if
given empty data twice.  Patch by Benjamin Fogle.

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: Fixed segfault in curses’s addch() with ncurses6.

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open() with mode «r» or «r:» now tries to open a tar
file with compression before trying to open it without compression.
Otherwise it had 50% chance failed with ignore_zeros=True.

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: The webbrowser module now supports Firefox 36+ and derived
browsers.  Based on patch by Oleg Broytman.

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: Fixed bugs in tkinter.ttk.LabeledScale and tkinter.Scale caused
by representing the scale as float value internally in Tk.  tkinter.IntVar
now works if float value is set to underlying Tk variable.

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar().prmonth() no longer prints a space at
the start of new line after printing a month’s calendar.  Patch by Xiang
Zhang.

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: The textwrap.TextWrapper class now honors non-breaking spaces.
Based on patch by Kaarle Ritvanen.

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() no longer fails on broken links.

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: Fixed HList.header_exists() in tkinter.tix module by addin a
workaround to Tix library bug.

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() no longer add entry «./» to ZIP archive.

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: Make webbrowser support Chrome on Mac OS X.

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: Fix references leaked by pdb in the handling of SIGINT
handlers.

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: Fixed writing ZIP files that starts not from the start of the
file.  Offsets in ZIP file now are relative to the start of the archive in
conforming to the specification.

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: Fixed writing non-BMP characters with binary format in
plistlib.

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: Fixed possible crashes when unpickle itertools objects from
incorrect pickle data.  Based on patch by John Leitch.

@item 
Fix possible integer overflows and crashes in the mmap module with unusual
usage patterns.

@item 
bpo-1703178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1703178}: Fix the ability to pass the –link-objects option to the
distutils build_ext command.

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: Fixed calendar functions for extreme months: 0001-01 and
9999-12. Methods itermonthdays() and itermonthdays2() are reimplemented so
that they don’t call itermonthdates() which can cause datetime.date
under/overflow.

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: Fixed possible use after free in the decompress() methods of
the LZMADecompressor and BZ2Decompressor classes. Original patch by John
Leitch.

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: Fixed possible crash in sqlite3.Connection.create_collation()
if pass invalid string-like object as a name.  Patch by Xiang Zhang.

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: Fix invalid exception handling in Lib/ctypes/macholib/dyld.py.
Patch by Madison May.

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: Fixed support of default root window in the tkinter.tix module.

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: In the traceback module, restore the formatting of exception
messages like «Exception: None».  This fixes a regression introduced in
3.5a2.

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: Allow false values to be used for msg parameter of subTest().

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: Prevent memory leak in win32_ver().

@item 
Fix UnboundLocalError in socket._sendfile_use_sendfile.

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: Check for ERROR_ACCESS_DENIED in Windows implementation of
os.stat().  Patch by Eryk Sun.

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: Prevent codecs.escape_encode() from raising SystemError when an
empty bytestring is passed.

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: Get antigravity over HTTPS. Patch by Kaartic Sivaraam.

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: Enable WebSocket URL schemes in urllib.parse.urljoin. Patch by
Gergely Imreh and Markus Holtermann.

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: Fixed buffer overrun in binascii.b2a_qp() and
binascii.a2b_qp().

@item 
bpo-19003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19003}: m email.generator now replaces only @code{\r} and/or @code{\n} line
endings, per the RFC, instead of all unicode line endings.

@item 
bpo-28019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28019}: itertools.count() no longer rounds non-integer step in range
between 1.0 and 2.0 to 1.

@item 
bpo-25969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25969}: Update the lib2to3 grammar to handle the unpacking
generalizations added in 3.5.

@item 
bpo-14977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14977}: mailcap now respects the order of the lines in the mailcap
files («first match»), as required by RFC 1542.  Patch by Michael Lazar.

@item 
bpo-24594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24594}: Validates persist parameter when opening MSI database

@item 
bpo-17582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17582}: xml.etree.ElementTree nows preserves whitespaces in attributes
(Patch by Duane Griffin.  Reviewed and approved by Stefan Behnel.)

@item 
bpo-28047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28047}: Fixed calculation of line length used for the base64 CTE in the
new email policies.

@item 
bpo-27445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27445}: Don’t pass str(_charset) to MIMEText.set_payload(). Patch by
Claude Paroz.

@item 
bpo-22450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22450}: urllib now includes an @code{Accept: */*} header among the default
headers. This makes the results of REST API requests more consistent and
predictable especially when proxy servers are involved.

@item 
lib2to3.pgen3.driver.load_grammar() now creates a stable cache file
between runs given the same Grammar.txt input regardless of the hash
randomization setting.

@item 
bpo-27570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27570}: Avoid zero-length memcpy() etc calls with null source pointers
in the «ctypes» and «array» modules.

@item 
bpo-22233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22233}: Break email header lines `only' on the RFC specified CR and LF
characters, not on arbitrary unicode line breaks.  This also fixes a bug
in HTTP header parsing.

@item 
bpo-27988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27988}: Fix email iter_attachments incorrect mutation of payload list.

@item 
bpo-27691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27691}: Fix ssl module’s parsing of GEN_RID subject alternative name
fields in X.509 certs.

@item 
bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850}: Remove 3DES from ssl module’s default cipher list to counter
measure sweet32 attack (
@geindex Common Vulnerabilities and Exposures; CVE 2016-2183
CVE 2016-2183@footnote{https://www.cve.org/CVERecord?id=CVE-2016-2183}).

@item 
bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}: Add ChaCha20 Poly1305 to ssl module’s default cipher list.
(Required OpenSSL 1.1.0 or LibreSSL).

@item 
bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}: Port ssl and hashlib module to OpenSSL 1.1.0.

@item 
Remove support for passing a file descriptor to os.access. It never worked
but previously didn’t raise.

@item 
bpo-12885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12885}: Fix error when distutils encounters symlink.

@item 
bpo-27881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27881}: Fixed possible bugs when setting
sqlite3.Connection.isolation_level. Based on patch by Xiang Zhang.

@item 
bpo-27861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27861}: Fixed a crash in sqlite3.Connection.cursor() when a factory
creates not a cursor.  Patch by Xiang Zhang.

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: Avoid spurious output on OS X with Gnu Readline.

@item 
bpo-27706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27706}: Restore deterministic behavior of random.Random().seed() for
string seeds using seeding version 1.  Allows sequences of calls to
random() to exactly match those obtained in Python 2. Patch by Nofar
Schnider.

@item 
bpo-10513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10513}: Fix a regression in Connection.commit().  Statements should not
be reset after a commit.

@item 
A new version of typing.py from @indicateurl{https://github.com/python/typing}:
Collection (only for 3.6) (bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}). Add FrozenSet to __all__
(upstream #261). Fix crash in _get_type_vars() (upstream #259). Remove the
dict constraint in ForwardRef._eval_type (upstream #252).

@item 
bpo-27539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27539}: Fix unnormalised @code{Fraction.__pow__} result in the case of
negative exponent and negative base.

@item 
bpo-21718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21718}: cursor.description is now available for queries using CTEs.

@item 
bpo-2466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2466}: posixpath.ismount now correctly recognizes mount points which
the user does not have permission to access.

@item 
bpo-27773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27773}: Correct some memory management errors server_hostname in
_ssl.wrap_socket().

@item 
bpo-26750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26750}: unittest.mock.create_autospec() now works properly for
subclasses of property() and other data descriptors.

@item 
In the curses module, raise an error if window.getstr() or window.instr()
is passed a negative value.

@item 
bpo-27783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27783}: Fix possible usage of uninitialized memory in
operator.methodcaller.

@item 
bpo-27774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27774}: Fix possible Py_DECREF on unowned object in _sre.

@item 
bpo-27760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27760}: Fix possible integer overflow in binascii.b2a_qp.

@item 
bpo-27758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27758}: Fix possible integer overflow in the _csv module for large
record lengths.

@item 
bpo-27568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27568}: Prevent HTTPoxy attack (
@geindex Common Vulnerabilities and Exposures; CVE 2016-1000110
CVE 2016-1000110@footnote{https://www.cve.org/CVERecord?id=CVE-2016-1000110}). Ignore the
HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

@item 
bpo-27656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27656}: Do not assume sched.h defines any SCHED_* constants.

@item 
bpo-27130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27130}: In the «zlib» module, fix handling of large buffers (typically
4 GiB) when compressing and decompressing.  Previously, inputs were
limited to 4 GiB, and compression and decompression operations did not
properly handle results of 4 GiB.

@item 
bpo-27533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27533}: Release GIL in nt._isdir

@item 
bpo-17711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17711}: Fixed unpickling by the persistent ID with protocol 0. Original
patch by Alexandre Vassalotti.

@item 
bpo-27522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27522}: Avoid an unintentional reference cycle in email.feedparser.

@item 
bpo-26844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26844}: Fix error message for imp.find_module() to refer to “path”
instead of “name”. Patch by Lev Maximov.

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: Fix SSL zero-length recv() calls to not block and not raise an
error about unclean EOF.

@item 
bpo-27466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27466}: Change time format returned by http.cookie.time2netscape,
confirming the netscape cookie format and making it consistent with
documentation.

@item 
bpo-26664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26664}: Fix activate.fish by removing mis-use of @code{$}.

@item 
bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}: Fixed tracing Tkinter variables: trace_vdelete() with wrong
mode no longer break tracing, trace_vinfo() now always returns a list of
pairs of strings, tracing in the «u» mode now works.

@item 
Fix a scoping issue in importlib.util.LazyLoader which triggered an
UnboundLocalError when lazy-loading a module that was already put into
sys.modules.

@item 
bpo-27079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27079}: Fixed curses.ascii functions isblank(), iscntrl() and
ispunct().

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: Some functions (compile() etc) accepted a filename argument
encoded as an iterable of integers. Now only strings and byte-like objects
are accepted.

@item 
bpo-27048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27048}: Prevents distutils failing on Windows when environment
variables contain non-ASCII characters

@item 
bpo-27330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27330}: Fixed possible leaks in the ctypes module.

@item 
bpo-27238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27238}: Got rid of bare excepts in the turtle module.  Original patch
by Jelle Zijlstra.

@item 
bpo-27122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27122}: When an exception is raised within the context being managed by
a contextlib.ExitStack() and one of the exit stack generators catches and
raises it in a chain, do not re-raise the original exception when exiting,
let the new chained one through.  This avoids the 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} bug described
in issue25782.

@item 
bpo-26386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26386}: Fixed ttk.TreeView selection operations with item id’s
containing spaces.

@item 
bpo-16182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16182}: Fix various functions in the «readline» module to use the
locale encoding, and fix get_begidx() and get_endidx() to return code
point indexes.

@item 
bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}: Add loop.connect_accepted_socket(). Patch by Jim Fulton.

@item 
bpo-27930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27930}: Improved behaviour of logging.handlers.QueueListener. Thanks to
Paulo Andrade and Petr Viktorin for the analysis and patch.

@item 
bpo-21201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21201}: Improves readability of multiprocessing error message.  Thanks
to Wojciech Walczak for patch.

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: asyncio: Set TCP_NODELAY by default.

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: Fix socket accept exhaustion during high TCP traffic. Patch by
Kevin Conway.

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: Handle when SO_REUSEPORT isn’t properly supported. Patch by
Seth Michael Larson.

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: Inspect functools.partial in asyncio.Handle.__repr__. Patch by
iceboy.

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: Fix slow pipes IO in asyncio. Patch by INADA Naoki.

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: Fix callbacks race in asyncio.SelectorLoop.sock_connect.

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: Fix selectors incorrectly retain invalid file descriptors.
Patch by Mark Williams.

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: Refuse monitoring processes if the child watcher has no loop
attached. Patch by Vincent Michel.

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: Raise RuntimeError when transport’s FD is used with add_reader,
add_writer, etc.

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: Speedup asyncio.StreamReader.readexactly. Patch by Коренберг
Марк.

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: Deprecate passing asyncio.Handles to run_in_executor.

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: Fix asyncio to support formatting of non-python coroutines.

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: Remove UNIX socket from FS before binding. Patch by Коренберг
Марк.

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: Prohibit Tasks to await on themselves.

@item 
bpo-26923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26923}: Fix asyncio.Gather to refuse being cancelled once all children
are done. Patch by Johannes Ebke.

@item 
bpo-26796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26796}: Don’t configure the number of workers for default threadpool
executor. Initial patch by Hans Lawrenz.

@item 
bpo-28600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28600}: Optimize loop.call_soon().

@item 
bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}: Fix get_event_loop() return the current loop if called from
coroutines/callbacks.

@item 
bpo-28639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28639}: Fix inspect.isawaitable to always return bool Patch by Justin
Mayfield.

@item 
bpo-28652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28652}: Make loop methods reject socket kinds they do not support.

@item 
bpo-28653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28653}: Fix a refleak in functools.lru_cache.

@item 
bpo-28703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28703}: Fix asyncio.iscoroutinefunction to handle Mock objects.

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: Reading a corrupt config file left the parser in an invalid
state.  Original patch by Florian Höch.

@item 
bpo-28990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28990}: Fix SSL hanging if connection is closed before handshake
completed. (Patch by HoHo-Ho)
@end itemize

@node IDLE<53>,C API<63>,Library<76>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id656}@anchor{1b7c}
@subsubsection IDLE



@itemize -

@item 
bpo-15308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15308}: Add “interrupt execution” (^C) to Shell menu. Patch by Roger
Serwy, updated by Bayard Randel.

@item 
bpo-27922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27922}: Stop IDLE tests from “flashing” gui widgets on the screen.

@item 
Add version to title of IDLE help window.

@item 
bpo-25564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25564}: In section on IDLE – console differences, mention that using
exec means that __builtins__ is defined for each statement.

@item 
bpo-27714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27714}: text_textview and test_autocomplete now pass when re-run in the
same process.  This occurs when test_idle fails when run with the -w
option but without -jn.  Fix warning from test_config.

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: IDLE no longer runs buggy code because of its tkinter imports.
Users must include the same imports required to run directly in Python.

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: add line counter and crc to IDLE configHandler test dump.

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: Allow non-ascii chars in IDLE NEWS.txt, for contributor names.

@item 
bpo-27245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27245}: IDLE: Cleanly delete custom themes and key bindings.
Previously, when IDLE was started from a console or by import, a cascade
of warnings was emitted. Patch by Serhiy Storchaka.
@end itemize

@node C API<63>,Documentation<67>,IDLE<53>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id657}@anchor{1b7d}
@subsubsection C API



@itemize -

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() now never raises exceptions.

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: PyUnicode_FSDecoder() accepted a filename argument encoded as
an iterable of integers. Now only strings and bytes-like objects are
accepted.
@end itemize

@node Documentation<67>,Tests<68>,C API<63>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id658}@anchor{1b7e}
@subsubsection Documentation



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: Documented command-line interface of zipfile.
@end itemize

@node Tests<68>,Tools/Demos<42>,Documentation<67>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id659}@anchor{1b7f}
@subsubsection Tests



@itemize -

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: Disallow -j0 to be combined with -T/-l/-M in regrtest command
line arguments.

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: Now test.support.rmtree is able to remove unwritable or
unreadable directories.

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: Various caches now are cleared before running every test file.

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: fix the parser of command line arguments.

@item 
bpo-27787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27787}: Call gc.collect() before checking each test for «dangling
threads», since the dangling threads are weak references.

@item 
bpo-27369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27369}: In test_pyexpat, avoid testing an error message detail that
changed in Expat 2.2.0.
@end itemize

@node Tools/Demos<42>,Windows<66>,Tests<68>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id660}@anchor{1b80}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-27952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27952}: Get Tools/scripts/fixcid.py working with Python 3 and the
current «re» module, avoid invalid Python backslash escapes, and fix a bug
parsing escaped C quote signs.

@item 
bpo-27332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27332}: Fixed the type of the first argument of module-level functions
generated by Argument Clinic.  Patch by Petr Viktorin.

@item 
bpo-27418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27418}: Fixed Tools/importbench/importbench.py.
@end itemize

@node Windows<66>,Build<73>,Tools/Demos<42>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id661}@anchor{1b81}
@subsubsection Windows



@itemize -

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: Improvements to help manuals on Windows.

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi has different product codes between 32-bit and
64-bit

@item 
bpo-25144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25144}: Ensures TargetDir is set before continuing with custom install.

@item 
bpo-27469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27469}: Adds a shell extension to the launcher so that drag and drop
works correctly.

@item 
bpo-27309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27309}: Enabled proper Windows styles in python[w].exe manifest.
@end itemize

@node Build<73>,,Windows<66>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id662}@anchor{1b82}
@subsubsection Build



@itemize -

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: Removes hard dependency on hg.exe from PCBuild/build.bat

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: Added missed names to PC/python3.def.

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: Fix out-of-tree building on AIX.  Patch by Tristan Carel and
Michael Haubenwallner.

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: Rename –with-optimiations to –enable-optimizations.

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: Fix missing extensions modules when cross compiling.

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: Update Windows build and OS X installers to use OpenSSL 1.0.2j.

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: Fixed build with Estonian locale (python-config and distclean
targets in Makefile).  Patch by Arfrever Frehtes Taifersar Arahesis.

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py now detects system libffi with multiarch wrapper.

@item 
bpo-28066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28066}: Fix the logic that searches build directories for generated
include files when building outside the source tree.

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: Remove redundant include search directory option for building
outside the source tree.

@item 
bpo-27566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27566}: Fix clean target in freeze makefile (patch by Lisa Roach)

@item 
bpo-27705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27705}: Update message in validate_ucrtbase.py

@item 
bpo-27983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27983}: Cause lack of llvm-profdata tool when using clang as required
for PGO linking to be a configure time error rather than make time when
–with-optimizations is enabled.  Also improve our ability to find the
llvm-profdata tool on MacOS and some Linuxes.

@item 
bpo-26307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26307}: The profile-opt build now applies PGO to the built-in modules.

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: Add the –with-optimizations configure flag.

@item 
bpo-27713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27713}: Suppress spurious build warnings when updating importlib’s
bootstrap files. Patch by Xiang Zhang

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: Correct the references to Modules/python.exp and ld_so_aix,
which are required on AIX.  This updates references to an installation
path that was changed in 3.2a4, and undoes changed references to the build
tree that were made in 3.5.0a1.

@item 
bpo-27453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27453}: CPP invocation in configure must use CPPFLAGS. Patch by Chi
Hsuan Yen.

@item 
bpo-27641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27641}: The configure script now inserts comments into the makefile to
prevent the pgen and _freeze_importlib executables from being
cross-compiled.

@item 
bpo-26662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26662}: Set PYTHON_FOR_GEN in configure as the Python program to be
used for file generation during the build.

@item 
bpo-10910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10910}: Avoid C++ compilation errors on FreeBSD and OS X. Also update
FreedBSD version checks for the original ctype UTF-8 workaround.

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: Prevent missing “getentropy” declaration warning on macOS.
Patch by Gareth Rees.
@end itemize

@node Python 3 5 2 final,Python 3 5 2 release candidate 1,Python 3 5 3 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-2-final}@anchor{1b83}
@subsection Python 3.5.2 final


`Release date: 2016-06-26'

@menu
* Core and Builtins: Core and Builtins<76>. 
* Tests: Tests<69>. 
* IDLE: IDLE<54>. 

@end menu

@node Core and Builtins<76>,Tests<69>,,Python 3 5 2 final
@anchor{whatsnew/changelog id663}@anchor{1b84}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: Update Windows builds to use OpenSSL 1.0.2h.
@end itemize

@node Tests<69>,IDLE<54>,Core and Builtins<76>,Python 3 5 2 final
@anchor{whatsnew/changelog id664}@anchor{1b85}
@subsubsection Tests



@itemize -

@item 
bpo-26867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26867}: Ubuntu’s openssl OP_NO_SSLv3 is forced on by default; fix test.
@end itemize

@node IDLE<54>,,Tests<69>,Python 3 5 2 final
@anchor{whatsnew/changelog id665}@anchor{1b86}
@subsubsection IDLE



@itemize -

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: Allow non-ascii in idlelib/NEWS.txt - minimal part for 3.5.2.
@end itemize

@node Python 3 5 2 release candidate 1,Python 3 5 1 final,Python 3 5 2 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-2-release-candidate-1}@anchor{1b87}
@subsection Python 3.5.2 release candidate 1


`Release date: 2016-06-12'

@menu
* Security: Security<46>. 
* Core and Builtins: Core and Builtins<77>. 
* Library: Library<77>. 
* IDLE: IDLE<55>. 
* Documentation: Documentation<68>. 
* Tests: Tests<70>. 
* Build: Build<74>. 
* Windows: Windows<67>. 
* Tools/Demos: Tools/Demos<43>. 

@end menu

@node Security<46>,Core and Builtins<77>,,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id666}@anchor{1b88}
@subsubsection Security



@itemize -

@item 
bpo-26556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26556}: Update expat to 2.1.1, fixes 
@geindex Common Vulnerabilities and Exposures; CVE 2015-1283
CVE 2015-1283@footnote{https://www.cve.org/CVERecord?id=CVE-2015-1283}.

@item 
Fix TLS stripping vulnerability in smtplib, 
@geindex Common Vulnerabilities and Exposures; CVE 2016-0772
CVE 2016-0772@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0772}. Reported by
Team Oststrom.

@item 
bpo-26839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26839}: On Linux, @ref{5c6,,os.urandom()} now calls @code{getrandom()} with
@code{GRND_NONBLOCK} to fall back on reading @code{/dev/urandom} if the urandom
entropy pool is not initialized yet. Patch written by Colm Buckley.

@item 
bpo-26657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26657}: Fix directory traversal vulnerability with http.server on
Windows.  This fixes a regression that was introduced in 3.3.4rc1 and
3.4.0rc1.  Based on patch by Philipp Hagemeister.

@item 
bpo-26313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26313}: ssl.py _load_windows_store_certs fails if windows cert store is
empty. Patch by Baji.

@item 
bpo-25939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25939}: On Windows open the cert store readonly in
ssl.enum_certificates.
@end itemize

@node Core and Builtins<77>,Library<77>,Security<46>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id667}@anchor{1b89}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-27066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27066}: Fixed SystemError if a custom opener (for open()) returns a
negative number without setting an exception.

@item 
bpo-20041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20041}: Fixed TypeError when frame.f_trace is set to None. Patch by
Xavier de Gaye.

@item 
bpo-26168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26168}: Fixed possible refleaks in failing Py_BuildValue() with the «N»
format unit.

@item 
bpo-26991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26991}: Fix possible refleak when creating a function with annotations.

@item 
bpo-27039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27039}: Fixed bytearray.remove() for values greater than 127.  Patch by
Joe Jevnik.

@item 
bpo-23640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23640}: int.from_bytes() no longer bypasses constructors for
subclasses.

@item 
bpo-26811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26811}: gc.get_objects() no longer contains a broken tuple with NULL
pointer.

@item 
bpo-20120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20120}: Use RawConfigParser for .pypirc parsing, removing support for
interpolation unintentionally added with move to Python 3. Behavior no
longer does any interpolation in .pypirc files, matching behavior in
Python 2.7 and Setuptools 19.0.

@item 
bpo-26659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26659}: Make the builtin slice type support cycle collection.

@item 
bpo-26718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26718}: super.__init__ no longer leaks memory if called multiple times.
NOTE: A direct call of super.__init__ is not endorsed!

@item 
bpo-25339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25339}: PYTHONIOENCODING now has priority over locale in setting the
error handler for stdin and stdout.

@item 
bpo-26494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26494}: Fixed crash on iterating exhausting iterators. Affected classes
are generic sequence iterators, iterators of str, bytes, bytearray, list,
tuple, set, frozenset, dict, OrderedDict, corresponding views and
os.scandir() iterator.

@item 
bpo-26581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26581}: If coding cookie is specified multiple times on a line in
Python source code file, only the first one is taken to account.

@item 
bpo-26464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26464}: Fix str.translate() when string is ASCII and first replacements
removes character, but next replacement uses a non-ASCII character or a
string longer than 1 character. Regression introduced in Python 3.5.0.

@item 
bpo-22836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22836}: Ensure exception reports from PyErr_Display() and
PyErr_WriteUnraisable() are sensible even when formatting them produces
secondary errors.  This affects the reports produced by
sys.__excepthook__() and when __del__() raises an exception.

@item 
bpo-26302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26302}: Correct behavior to reject comma as a legal character for
cookie names.

@item 
bpo-4806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4806}: Avoid masking the original TypeError exception when using star
(@code{*}) unpacking in function calls.  Based on patch by Hagen Fürstenau
and Daniel Urban.

@item 
bpo-27138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27138}: Fix the doc comment for FileFinder.find_spec().

@item 
bpo-26154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26154}: Add a new private _PyThreadState_UncheckedGet() function to get
the current Python thread state, but don’t issue a fatal error if it is
NULL. This new function must be used instead of accessing directly the
_PyThreadState_Current variable.  The variable is no more exposed since
Python 3.5.1 to hide the exact implementation of atomic C types, to avoid
compiler issues.

@item 
bpo-26194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26194}: Deque.insert() gave odd results for bounded deques that had
reached their maximum size.  Now an IndexError will be raised when
attempting to insert into a full deque.

@item 
bpo-25843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25843}: When compiling code, don’t merge constants if they are equal
but have a different types. For example, @code{f1, f2 = lambda: 1, lambda:
1.0} is now correctly compiled to two different functions: @code{f1()}
returns @code{1} (@code{int}) and @code{f2()} returns @code{1.0} (@code{int}), even if
@code{1} and @code{1.0} are equal.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: [UPDATE] Comment out the one of the pickleability tests in
_PyObject_GetState() due to regressions observed in Cython-based projects.

@item 
bpo-25961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25961}: Disallowed null characters in the type name.

@item 
bpo-25973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25973}: Fix segfault when an invalid nonlocal statement binds a name
starting with two underscores.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: Instances of extension types with a state that aren’t
subclasses of list or dict and haven’t implemented any pickle-related
methods (__reduce__, __reduce_ex__, __getnewargs__, __getnewargs_ex__, or
__getstate__), can no longer be pickled.  Including memoryview.

@item 
bpo-20440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20440}: Massive replacing unsafe attribute setting code with special
macro Py_SETREF.

@item 
bpo-25766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25766}: Special method __bytes__() now works in str subclasses.

@item 
bpo-25421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25421}: __sizeof__ methods of builtin types now use dynamic basic size.
This allows sys.getsize() to work correctly with their subclasses with
__slots__ defined.

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: Fixed problem with in-place string concatenation and utf-8
cache.

@item 
bpo-27147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27147}: Mention 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} in the importlib docs.

@item 
bpo-24097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24097}: Fixed crash in object.__reduce__() if slot name is freed inside
__getattr__.

@item 
bpo-24731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24731}: Fixed crash on converting objects with special methods
__bytes__, __trunc__, and __float__ returning instances of subclasses of
bytes, int, and float to subclasses of bytes, int, and float
correspondingly.

@item 
bpo-26478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26478}: Fix semantic bugs when using binary operators with dictionary
views and tuples.

@item 
bpo-26171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26171}: Fix possible integer overflow and heap corruption in
zipimporter.get_data().

@item 
bpo-25660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25660}: Fix TAB key behaviour in REPL with readline.

@item 
bpo-25887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25887}: Raise a RuntimeError when a coroutine object is awaited more
than once.

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: Update the __aiter__ protocol: instead of returning an
awaitable that resolves to an asynchronous iterator, the asynchronous
iterator should be returned directly.  Doing the former will trigger a
PendingDeprecationWarning.
@end itemize

@node Library<77>,IDLE<55>,Core and Builtins<77>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id668}@anchor{1b8a}
@subsubsection Library



@itemize -

@item 
bpo-21386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21386}: Implement missing IPv4Address.is_global property.  It was
documented since 07a5610bae9d.  Initial patch by Roger Luethi.

@item 
bpo-20900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20900}: distutils register command now decodes HTTP responses
correctly.  Initial patch by ingrid.

@item 
A new version of typing.py provides several new classes and features:
@@overload outside stubs, Reversible, DefaultDict, Text, ContextManager,
Type[], NewType(), TYPE_CHECKING, and numerous bug fixes (note that some
of the new features are not yet implemented in mypy or other static
analyzers). Also classes for 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} (Awaitable, AsyncIterable,
AsyncIterator) have been added (in fact they made it into 3.5.1 but were
never mentioned).

@item 
bpo-25738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25738}: Stop http.server.BaseHTTPRequestHandler.send_error() from
sending a message body for 205 Reset Content.  Also, don’t send Content
header fields in responses that don’t have a body.  Patch by Susumu
Koshiba.

@item 
bpo-21313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21313}: Fix the «platform» module to tolerate when sys.version contains
truncated build information.

@item 
bpo-27164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27164}: In the zlib module, allow decompressing raw Deflate streams
with a predefined zdict.  Based on patch by Xiang Zhang.

@item 
bpo-24291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24291}: Fix wsgiref.simple_server.WSGIRequestHandler to completely
write data to the client.  Previously it could do partial writes and
truncate data.  Also, wsgiref.handler.ServerHandler can now handle stdout
doing partial writes, but this is deprecated.

@item 
bpo-26809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26809}: Add @code{__all__} to @ref{d3,,string}.  Patch by Emanuel Barry.

@item 
bpo-26373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26373}: subprocess.Popen.communicate now correctly ignores
BrokenPipeError when the child process dies before .communicate() is
called in more/all circumstances.

@item 
bpo-21776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21776}: distutils.upload now correctly handles HTTPError. Initial patch
by Claudiu Popa.

@item 
bpo-27114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27114}: Fix SSLContext._load_windows_store_certs fails with
PermissionError

@item 
bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: Avoid creating duplicate filters when using filterwarnings and
simplefilter. Based on patch by Alex Shkop.

@item 
bpo-27057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27057}: Fix os.set_inheritable() on Android, ioctl() is blocked by
SELinux and fails with EACCESS. The function now falls back to fcntl().
Patch written by Michał Bednarski.

@item 
bpo-27014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27014}: Fix infinite recursion using typing.py.  Thanks to Kalle Tuure!

@item 
bpo-14132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14132}: Fix urllib.request redirect handling when the target only has a
query string.  Original fix by Ján Janech.

@item 
bpo-17214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17214}: The «urllib.request» module now percent-encodes non-ASCII bytes
found in redirect target URLs.  Some servers send Location header fields
with non-ASCII bytes, but «http.client» requires the request target to be
ASCII-encodable, otherwise a UnicodeEncodeError is raised.  Based on patch
by Christian Heimes.

@item 
bpo-26892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26892}: Honor debuglevel flag in urllib.request.HTTPHandler. Patch
contributed by Chi Hsuan Yen.

@item 
bpo-22274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22274}: In the subprocess module, allow stderr to be redirected to
stdout even when stdout is not redirected.  Patch by Akira Li.

@item 
bpo-26807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26807}: mock_open “files” no longer error on readline at end of file.
Patch from Yolanda Robla.

@item 
bpo-25745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25745}: Fixed leaking a userptr in curses panel destructor.

@item 
bpo-26977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26977}: Removed unnecessary, and ignored, call to sum of squares helper
in statistics.pvariance.

@item 
bpo-26881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26881}: The modulefinder module now supports extended opcode arguments.

@item 
bpo-23815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23815}: Fixed crashes related to directly created instances of types in
_tkinter and curses.panel modules.

@item 
bpo-17765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17765}: weakref.ref() no longer silently ignores keyword arguments.
Patch by Georg Brandl.

@item 
bpo-26873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26873}: xmlrpc now raises ResponseError on unsupported type tags
instead of silently return incorrect result.

@item 
bpo-26711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26711}: Fixed the comparison of plistlib.Data with other types.

@item 
bpo-24114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24114}: Fix an uninitialized variable in @code{ctypes.util}. The bug only
occurs on SunOS when the ctypes implementation searches for the @code{crle}
program. Patch by Xiang Zhang.  Tested on SunOS by Kees Bos.

@item 
bpo-26864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26864}: In urllib.request, change the proxy bypass host checking
against no_proxy to be case-insensitive, and to not match unrelated host
names that happen to have a bypassed hostname as a suffix.  Patch by Xiang
Zhang.

@item 
bpo-26634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26634}: recursive_repr() now sets __qualname__ of wrapper.  Patch by
Xiang Zhang.

@item 
bpo-26804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26804}: urllib.request will prefer lower_case proxy environment
variables over UPPER_CASE or Mixed_Case ones. Patch contributed by
Hans-Peter Jansen.

@item 
bpo-26837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26837}: assertSequenceEqual() now correctly outputs non-stringified
differing items (like bytes in the -b mode).  This affects
assertListEqual() and assertTupleEqual().

@item 
bpo-26041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26041}: Remove «will be removed in Python 3.7» from deprecation
messages of platform.dist() and platform.linux_distribution(). Patch by
Kumaripaba Miyurusara Athukorala.

@item 
bpo-26822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26822}: itemgetter, attrgetter and methodcaller objects no longer
silently ignore keyword arguments.

@item 
bpo-26733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26733}: Disassembling a class now disassembles class and static
methods. Patch by Xiang Zhang.

@item 
bpo-26801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26801}: Fix error handling in @ref{1175,,shutil.get_terminal_size()}, catch
@ref{441,,AttributeError} instead of @ref{4ec,,NameError}. Patch written by
Emanuel Barry.

@item 
bpo-24838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24838}: tarfile’s ustar and gnu formats now correctly calculate name
and link field limits for multibyte character encodings like utf-8.

@item 
bpo-26717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26717}: Stop encoding Latin-1-ized WSGI paths with UTF-8.  Patch by
Anthony Sottile.

@item 
bpo-26735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26735}: Fix @ref{5c6,,os.urandom()} on Solaris 11.3 and newer when reading
more than 1,024 bytes: call @code{getrandom()} multiple times with a limit of
1024 bytes per call.

@item 
bpo-16329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16329}: Add .webm to mimetypes.types_map.  Patch by Giampaolo Rodola”.

@item 
bpo-13952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13952}: Add .csv to mimetypes.types_map.  Patch by Geoff Wilson.

@item 
bpo-26709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26709}: Fixed Y2038 problem in loading binary PLists.

@item 
bpo-23735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23735}: Handle terminal resizing with Readline 6.3+ by installing our
own SIGWINCH handler.  Patch by Eric Price.

@item 
bpo-26586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26586}: In http.server, respond with «413 Request header fields too
large» if there are too many header fields to parse, rather than killing
the connection and raising an unhandled exception.  Patch by Xiang Zhang.

@item 
bpo-22854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22854}: Change BufferedReader.writable() and BufferedWriter.readable()
to always return False.

@item 
bpo-25195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25195}: Fix a regression in mock.MagicMock. _Call is a subclass of
tuple (changeset 3603bae63c13 only works for classes) so we need to
implement __ne__ ourselves.  Patch by Andrew Plummer.

@item 
bpo-26644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26644}: Raise ValueError rather than SystemError when a negative length
is passed to SSLSocket.recv() or read().

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: Fix SSL recv(0) and read(0) methods to return zero bytes
instead of up to 1024.

@item 
bpo-26616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26616}: Fixed a bug in datetime.astimezone() method.

@item 
bpo-21925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21925}: @ref{1a1d,,warnings.formatwarning()} now catches exceptions on
@code{linecache.getline(...)} to be able to log @ref{39d,,ResourceWarning}
emitted late during the Python shutdown process.

@item 
bpo-24266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24266}: Ctrl+C during Readline history search now cancels the search
mode when compiled with Readline 7.

@item 
bpo-26560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26560}: Avoid potential ValueError in BaseHandler.start_response.
Initial patch by Peter Inglesby.

@item 
bpo-26569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26569}: Fix @ref{8c2,,pyclbr.readmodule()} and @ref{8c3,,pyclbr.readmodule_ex()}
to support importing packages.

@item 
bpo-26499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26499}: Account for remaining Content-Length in HTTPResponse.readline()
and read1(). Based on patch by Silent Ghost. Also document that
HTTPResponse now supports these methods.

@item 
bpo-25320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25320}: Handle sockets in directories unittest discovery is scanning.
Patch from Victor van den Elzen.

@item 
bpo-16181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16181}: cookiejar.http2time() now returns None if year is higher than
datetime.MAXYEAR.

@item 
bpo-26513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26513}: Fixes platform module detection of Windows Server

@item 
bpo-23718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23718}: Fixed parsing time in week 0 before Jan 1.  Original patch by
Tamás Bence Gedai.

@item 
bpo-20589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20589}: Invoking Path.owner() and Path.group() on Windows now raise
NotImplementedError instead of ImportError.

@item 
bpo-26177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26177}: Fixed the keys() method for Canvas and Scrollbar widgets.

@item 
bpo-15068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15068}: Got rid of excessive buffering in the fileinput module. The
bufsize parameter is no longer used.

@item 
bpo-2202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2202}: Fix UnboundLocalError in
AbstractDigestAuthHandler.get_algorithm_impls. Initial patch by Mathieu
Dupuy.

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: Fixed pickling and copying the accumulate() iterator with total
is None.

@item 
bpo-26475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26475}: Fixed debugging output for regular expressions with the (?x)
flag.

@item 
bpo-26457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26457}: Fixed the subnets() methods in IP network classes for the case
when resulting prefix length is equal to maximal prefix length. Based on
patch by Xiang Zhang.

@item 
bpo-26385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26385}: Remove the file if the internal open() call in
NamedTemporaryFile() fails. Patch by Silent Ghost.

@item 
bpo-26402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26402}: Fix XML-RPC client to retry when the server shuts down a
persistent connection.  This was a regression related to the new
http.client.RemoteDisconnected exception in 3.5.0a4.

@item 
bpo-25913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25913}: Leading @code{<~} is optional now in base64.a85decode() with
adobe=True.  Patch by Swati Jaiswal.

@item 
bpo-26186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26186}: Remove an invalid type check in importlib.util.LazyLoader.

@item 
bpo-26367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26367}: importlib.__import__() raises SystemError like
builtins.__import__() when @code{level} is specified but without an
accompanying package specified.

@item 
bpo-26309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26309}: In the «socketserver» module, shut down the request (closing
the connected socket) when verify_request() returns false.  Patch by Aviv
Palivoda.

@item 
bpo-25995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25995}: os.walk() no longer uses FDs proportional to the tree depth.

@item 
bpo-26117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26117}: The os.scandir() iterator now closes file descriptor not only
when the iteration is finished, but when it was failed with error.

@item 
bpo-25911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25911}: Restored support of bytes paths in os.walk() on Windows.

@item 
bpo-26045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26045}: Add UTF-8 suggestion to error message when posting a
non-Latin-1 string with http.client.

@item 
bpo-12923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12923}: Reset FancyURLopener’s redirect counter even if there is an
exception. Based on patches by Brian Brazil and Daniel Rocco.

@item 
bpo-25945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25945}: Fixed a crash when unpickle the functools.partial object with
wrong state. Fixed a leak in failed functools.partial constructor. «args»
and «keywords» attributes of functools.partial have now always types tuple
and dict correspondingly.

@item 
bpo-26202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26202}: copy.deepcopy() now correctly copies range() objects with
non-atomic attributes.

@item 
bpo-23076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23076}: Path.glob() now raises a ValueError if it’s called with an
invalid pattern. Patch by Thomas Nyberg.

@item 
bpo-19883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19883}: Fixed possible integer overflows in zipimport.

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: On Windows, getnameinfo(), gethostbyaddr() and
gethostbyname_ex() functions of the socket module now decode the hostname
from the ANSI code page rather than UTF-8.

@item 
bpo-26147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26147}: xmlrpc now works with strings not encodable with used non-UTF-8
encoding.

@item 
bpo-25935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25935}: Garbage collector now breaks reference loops with OrderedDict.

@item 
bpo-16620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16620}: Fixed AttributeError in msilib.Directory.glob().

@item 
bpo-26013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26013}: Added compatibility with broken protocol 2 pickles created in
old Python 3 versions (3.4.3 and lower).

@item 
bpo-25850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25850}: Use cross-compilation by default for 64-bit Windows.

@item 
bpo-17633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17633}: Improve zipimport’s support for namespace packages.

@item 
bpo-24705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24705}: Fix sysconfig._parse_makefile not expanding $@{@} vars appearing
before $() vars.

@item 
bpo-22138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22138}: Fix mock.patch behavior when patching descriptors. Restore
original values after patching. Patch contributed by Sean McCully.

@item 
bpo-25672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25672}: In the ssl module, enable the SSL_MODE_RELEASE_BUFFERS mode
option if it is safe to do so.

@item 
bpo-26012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26012}: Don’t traverse into symlinks for @code{**} pattern in
pathlib.Path.[r]glob().

@item 
bpo-24120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24120}: Ignore PermissionError when traversing a tree with
pathlib.Path.[r]glob(). Patch by Ulrich Petri.

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: fileinput now uses sys.stdin as-is if it does not have a buffer
attribute (restores backward compatibility).

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: Copying the lru_cache() wrapper object now always works,
independently from the type of the wrapped object (by returning the
original object unchanged).

@item 
bpo-24103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24103}: Fixed possible use after free in ElementTree.XMLPullParser.

@item 
bpo-25860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25860}: os.fwalk() no longer skips remaining directories when error
occurs. Original patch by Samson Lee.

@item 
bpo-25914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25914}: Fixed and simplified OrderedDict.__sizeof__.

@item 
bpo-25902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25902}: Fixed various refcount issues in ElementTree iteration.

@item 
bpo-25717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25717}: Restore the previous behaviour of tolerating most fstat()
errors when opening files.  This was a regression in 3.5a1, and stopped
anonymous temporary files from working in special cases.

@item 
bpo-24903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24903}: Fix regression in number of arguments compileall accepts when
“-d” is specified.  The check on the number of arguments has been dropped
completely as it never worked correctly anyway.

@item 
bpo-25764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25764}: In the subprocess module, preserve any exception caused by
fork() failure when preexec_fn is used.

@item 
bpo-6478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6478}: _strptime’s regexp cache now is reset after changing timezone
with time.tzset().

@item 
bpo-14285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14285}: When executing a package with the «python -m package» option,
and package initialization fails, a proper traceback is now reported.  The
«runpy» module now lets exceptions from package initialization pass back
to the caller, rather than raising ImportError.

@item 
bpo-19771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19771}: Also in runpy and the «-m» option, omit the irrelevant message
«… is a package and cannot be directly executed» if the package could
not even be initialized (e.g. due to a bad @code{*.pyc} file).

@item 
bpo-25177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25177}: Fixed problem with the mean of very small and very large
numbers. As a side effect, statistics.mean and statistics.variance should
be significantly faster.

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: Fixed copying object with state with boolean value is false.

@item 
bpo-10131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10131}: Fixed deep copying of minidom documents.  Based on patch by
Marian Ganisin.

@item 
bpo-25725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25725}: Fixed a reference leak in pickle.loads() when unpickling
invalid data including tuple instructions.

@item 
bpo-25663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25663}: In the Readline completer, avoid listing duplicate global
names, and search the global namespace before searching builtins.

@item 
bpo-25688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25688}: Fixed file leak in ElementTree.iterparse() raising an error.

@item 
bpo-23914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23914}: Fixed SystemError raised by unpickler on broken pickle data.

@item 
bpo-25691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25691}: Fixed crash on deleting ElementTree.Element attributes.

@item 
bpo-25624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25624}: ZipFile now always writes a ZIP_STORED header for directory
entries.  Patch by Dingyuan Wang.

@item 
Skip getaddrinfo if host is already resolved. Patch by A. Jesse Jiryu
Davis.

@item 
bpo-26050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26050}: Add asyncio.StreamReader.readuntil() method. Patch by Марк
Коренберг.

@item 
bpo-25924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25924}: Avoid unnecessary serialization of getaddrinfo(3) calls on OS X
versions 10.5 or higher.  Original patch by A. Jesse Jiryu Davis.

@item 
bpo-26406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26406}: Avoid unnecessary serialization of getaddrinfo(3) calls on
current versions of OpenBSD and NetBSD.  Patch by A. Jesse Jiryu Davis.

@item 
bpo-26848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26848}: Fix asyncio/subprocess.communicate() to handle empty input.
Patch by Jack O’Connor.

@item 
bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}: Add loop.get_exception_handler method

@item 
bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}: asyncio: Add loop.create_future method

@item 
bpo-27223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27223}: asyncio: Fix _read_ready and _write_ready to respect
_conn_lost. Patch by Łukasz Langa.

@item 
bpo-22970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22970}: asyncio: Fix inconsistency cancelling Condition.wait. Patch by
David Coles.
@end itemize

@node IDLE<55>,Documentation<68>,Library<77>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id669}@anchor{1b8b}
@subsubsection IDLE



@itemize -

@item 
bpo-5124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5124}: Paste with text selected now replaces the selection on X11. This
matches how paste works on Windows, Mac, most modern Linux apps, and ttk
widgets. Original patch by Serhiy Storchaka.

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: Make clear in idlelib.idle_test.__init__ that the directory is
a private implementation of test.test_idle and tool for maintainers.

@item 
bpo-27196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27196}: Stop “ThemeChanged” warnings when running IDLE tests. These
persisted after other warnings were suppressed in #20567. Apply Serhiy
Storchaka’s update_idletasks solution to four test files. Record this
additional advice in idle_test/README.txt

@item 
bpo-20567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20567}: Revise idle_test/README.txt with advice about avoiding tk
warning messages from tests.  Apply advice to several IDLE tests.

@item 
bpo-27117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27117}: Make colorizer htest and turtledemo work with dark themes. Move
code for configuring text widget colors to a new function.

@item 
bpo-26673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26673}: When tk reports font size as 0, change to size 10. Such fonts
on Linux prevented the configuration dialog from opening.

@item 
bpo-21939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21939}: Add test for IDLE’s percolator. Original patch by Saimadhav
Heblikar.

@item 
bpo-21676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21676}: Add test for IDLE’s replace dialog. Original patch by Saimadhav
Heblikar.

@item 
bpo-18410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18410}: Add test for IDLE’s search dialog. Original patch by Westley
Martínez.

@item 
bpo-21703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21703}: Add test for IDLE’s undo delegator. Original patch by Saimadhav
Heblikar .

@item 
bpo-27044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27044}: Add ConfigDialog.remove_var_callbacks to stop memory leaks.

@item 
bpo-23977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23977}: Add more asserts to test_delegator.

@item 
bpo-20640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20640}: Add tests for idlelib.configHelpSourceEdit. Patch by Saimadhav
Heblikar.

@item 
In the “IDLE-console differences” section of the IDLE doc, clarify how
running with IDLE affects sys.modules and the standard streams.

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: fix incorrect change in IOBinding that prevented printing.
Augment IOBinding htest to include all major IOBinding functions.

@item 
bpo-25905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25905}: Revert unwanted conversion of “ to ’ RIGHT SINGLE QUOTATION
MARK in README.txt and open this and NEWS.txt with “ascii”. Re-encode
CREDITS.txt to utf-8 and open it with “utf-8”.
@end itemize

@node Documentation<68>,Tests<70>,IDLE<55>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id670}@anchor{1b8c}
@subsubsection Documentation



@itemize -

@item 
bpo-19489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19489}: Moved the search box from the sidebar to the header and footer
of each page. Patch by Ammar Askar.

@item 
bpo-24136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24136}: Document the new 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} unpacking syntax of 3.5.

@item 
bpo-26736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26736}: Used HTTPS for external links in the documentation if possible.

@item 
bpo-6953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6953}: Rework the Readline module documentation to group related
functions together, and add more details such as what underlying Readline
functions and variables are accessed.

@item 
bpo-23606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23606}: Adds note to ctypes documentation regarding cdll.msvcrt.

@item 
bpo-25500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25500}: Fix documentation to not claim that __import__ is searched for
in the global scope.

@item 
bpo-26014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26014}: Update 3.x packaging documentation: * «See also» links to the
new docs are now provided in the legacy pages * links to setuptools
documentation have been updated
@end itemize

@node Tests<70>,Build<74>,Documentation<68>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id671}@anchor{1b8d}
@subsubsection Tests



@itemize -

@item 
bpo-21916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21916}: Added tests for the turtle module.  Patch by ingrid, Gregory
Loyse and Jelle Zijlstra.

@item 
bpo-26523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26523}: The multiprocessing thread pool (multiprocessing.dummy.Pool)
was untested.

@item 
bpo-26015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26015}: Added new tests for pickling iterators of mutable sequences.

@item 
bpo-26325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26325}: Added test.support.check_no_resource_warning() to check that no
ResourceWarning is emitted.

@item 
bpo-25940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25940}: Changed test_ssl to use self-signed.pythontest.net.  This
avoids relying on svn.python.org, which recently changed root certificate.

@item 
bpo-25616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25616}: Tests for OrderedDict are extracted from test_collections into
separate file test_ordered_dict.

@item 
bpo-26583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26583}: Skip test_timestamp_overflow in test_import if bytecode files
cannot be written.
@end itemize

@node Build<74>,Windows<67>,Tests<70>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id672}@anchor{1b8e}
@subsubsection Build



@itemize -

@item 
bpo-26884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26884}: Fix linking extension modules for cross builds. Patch by Xavier
de Gaye.

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: Disable the rules for running _freeze_importlib and pgen when
cross-compiling.  The output of these programs is normally saved with the
source code anyway, and is still regenerated when doing a native build.
Patch by Xavier de Gaye.

@item 
bpo-27229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27229}: Fix the cross-compiling pgen rule for in-tree builds.  Patch by
Xavier de Gaye.

@item 
bpo-21668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21668}: Link audioop, _datetime, _ctypes_test modules to libm, except
on Mac OS X. Patch written by Xavier de Gaye.

@item 
bpo-25702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25702}: A –with-lto configure option has been added that will enable
link time optimizations at build time during a make profile-opt. Some
compilers and toolchains are known to not produce stable code when using
LTO, be sure to test things thoroughly before relying on it. It can
provide a few % speed up over profile-opt alone.

@item 
bpo-26624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26624}: Adds validation of ucrtbase[d].dll version with warning for old
versions.

@item 
bpo-17603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17603}: Avoid error about nonexistent fileblocks.o file by using a
lower-level check for st_blocks in struct stat.

@item 
bpo-26079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26079}: Fixing the build output folder for tix-8.4.3.6. Patch by Bjoern
Thiel.

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: Update Windows builds to use OpenSSL 1.0.2g.

@item 
bpo-24421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24421}: Compile Modules/_math.c once, before building extensions.
Previously it could fail to compile properly if the math and cmath builds
were concurrent.

@item 
bpo-25348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25348}: Added @code{--pgo} and @code{--pgo-job} arguments to
@code{PCbuild\build.bat} for building with Profile-Guided Optimization.  The
old @code{PCbuild\build_pgo.bat} script is now deprecated, and simply calls
@code{PCbuild\build.bat --pgo %*}.

@item 
bpo-25827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25827}: Add support for building with ICC to @code{configure}, including a
new @code{--with-icc} flag.

@item 
bpo-25696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25696}: Fix installation of Python on UNIX with make -j9.

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: Update OS X 10.5+ 32-bit-only installer to build and link with
OpenSSL 1.0.2h.

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: Update Windows builds to use OpenSSL 1.0.2f.

@item 
bpo-25136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25136}: Support Apple Xcode 7’s new textual SDK stub libraries.

@item 
bpo-24324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24324}: Do not enable unreachable code warnings when using gcc as the
option does not work correctly in older versions of gcc and has been
silently removed as of gcc-4.5.
@end itemize

@node Windows<67>,Tools/Demos<43>,Build<74>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id673}@anchor{1b8f}
@subsubsection Windows



@itemize -

@item 
bpo-27053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27053}: Updates make_zip.py to correctly generate library ZIP file.

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: Update the prepare_ssl.py script to handle OpenSSL releases
that don’t include the contents of the include directory (that is, 1.0.2e
and later).

@item 
bpo-26071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26071}: bdist_wininst created binaries fail to start and find 32bit
Python

@item 
bpo-26073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26073}: Update the list of magic numbers in launcher

@item 
bpo-26065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26065}: Excludes venv from library when generating embeddable distro.

@item 
bpo-17500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17500}: Remove unused and outdated icons. (See also:
@indicateurl{https://github.com/python/pythondotorg/issues/945})
@end itemize

@node Tools/Demos<43>,,Windows<67>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id674}@anchor{1b90}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-26799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26799}: Fix python-gdb.py: don’t get C types once when the Python code
is loaded, but get C types on demand. The C types can change if
python-gdb.py is loaded before the Python executable. Patch written by
Thomas Ilsche.

@item 
bpo-26271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26271}: Fix the Freeze tool to properly use flags passed through
configure. Patch by Daniel Shaulov.

@item 
bpo-26489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26489}: Add dictionary unpacking support to Tools/parser/unparse.py.
Patch by Guo Ci Teo.

@item 
bpo-26316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26316}: Fix variable name typo in Argument Clinic.
@end itemize

@node Python 3 5 1 final,Python 3 5 1 release candidate 1,Python 3 5 2 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-1-final}@anchor{1b91}
@subsection Python 3.5.1 final


`Release date: 2015-12-06'

@menu
* Core and Builtins: Core and Builtins<78>. 
* Windows: Windows<68>. 

@end menu

@node Core and Builtins<78>,Windows<68>,,Python 3 5 1 final
@anchor{whatsnew/changelog id675}@anchor{1b92}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: Fixed problem with in-place string concatenation and utf-8
cache.
@end itemize

@node Windows<68>,,Core and Builtins<78>,Python 3 5 1 final
@anchor{whatsnew/changelog id676}@anchor{1b93}
@subsubsection Windows



@itemize -

@item 
bpo-25715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25715}: Python 3.5.1 installer shows wrong upgrade path and incorrect
logic for launcher detection.
@end itemize

@node Python 3 5 1 release candidate 1,Python 3 5 0 final,Python 3 5 1 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-1-release-candidate-1}@anchor{1b94}
@subsection Python 3.5.1 release candidate 1


`Release date: 2015-11-22'

@menu
* Core and Builtins: Core and Builtins<79>. 
* Library: Library<78>. 
* IDLE: IDLE<56>. 
* Documentation: Documentation<69>. 
* Tests: Tests<71>. 
* Build: Build<75>. 
* Windows: Windows<69>. 
* Tools/Demos: Tools/Demos<44>. 

@end menu

@node Core and Builtins<79>,Library<78>,,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id677}@anchor{1b95}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-25630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25630}: Fix a possible segfault during argument parsing in functions
that accept filesystem paths.

@item 
bpo-23564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23564}: Fixed a partially broken sanity check in the _posixsubprocess
internals regarding how fds_to_pass were passed to the child.  The bug had
no actual impact as subprocess.py already avoided it.

@item 
bpo-25388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25388}: Fixed tokenizer crash when processing undecodable source code
with a null byte.

@item 
bpo-25462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25462}: The hash of the key now is calculated only once in most
operations in C implementation of OrderedDict.

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: Default implementation of __reduce__ and __reduce_ex__ now
rejects builtin types with not defined __new__.

@item 
bpo-25555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25555}: Fix parser and AST: fill lineno and col_offset of «arg» node
when compiling AST from Python objects.

@item 
bpo-24802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24802}: Avoid buffer overreads when int(), float(), compile(), exec()
and eval() are passed bytes-like objects.  These objects are not
necessarily terminated by a null byte, but the functions assumed they
were.

@item 
bpo-24726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24726}: Fixed a crash and leaking NULL in repr() of OrderedDict that
was mutated by direct calls of dict methods.

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: Iterating OrderedDict with keys with unstable hash now raises
KeyError in C implementations as well as in Python implementation.

@item 
bpo-25395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25395}: Fixed crash when highly nested OrderedDict structures were
garbage collected.

@item 
bpo-25274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25274}: sys.setrecursionlimit() now raises a RecursionError if the new
recursion limit is too low depending at the current recursion depth.
Modify also the «lower-water mark» formula to make it monotonic. This mark
is used to decide when the overflowed flag of the thread state is reset.

@item 
bpo-24402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24402}: Fix input() to prompt to the redirected stdout when
sys.stdout.fileno() fails.

@item 
bpo-24806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24806}: Prevent builtin types that are not allowed to be subclassed
from being subclassed through multiple inheritance.

@item 
bpo-24848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24848}: Fixed a number of bugs in UTF-7 decoding of misformed data.

@item 
bpo-25280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25280}: Import trace messages emitted in verbose (-v) mode are no
longer formatted twice.

@item 
bpo-25003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25003}: On Solaris 11.3 or newer, os.urandom() now uses the getrandom()
function instead of the getentropy() function. The getentropy() function
is blocking to generate very good quality entropy, os.urandom() doesn’t
need such high-quality entropy.

@item 
bpo-25182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25182}: The stdprinter (used as sys.stderr before the io module is
imported at startup) now uses the backslashreplace error handler.

@item 
bpo-25131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25131}: Make the line number and column offset of set/dict literals and
comprehensions correspond to the opening brace.

@item 
bpo-25150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25150}: Hide the private @code{_Py_atomic_@var{xxx}} symbols from the
public Python.h header to fix a compilation error with OpenMP.
PyThreadState_GET() becomes an alias to PyThreadState_Get() to avoid ABI
incompatibilities.
@end itemize

@node Library<78>,IDLE<56>,Core and Builtins<79>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id678}@anchor{1b96}
@subsubsection Library



@itemize -

@item 
bpo-25626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25626}: Change three zlib functions to accept sizes that fit in
Py_ssize_t, but internally cap those sizes to UINT_MAX.  This resolves a
regression in 3.5 where GzipFile.read() failed to read chunks larger than
2 or 4 GiB.  The change affects the zlib.Decompress.decompress()
max_length parameter, the zlib.decompress() bufsize parameter, and the
zlib.Decompress.flush() length parameter.

@item 
bpo-25583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25583}: Avoid incorrect errors raised by os.makedirs(exist_ok=True)
when the OS gives priority to errors such as EACCES over EEXIST.

@item 
bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}: Change semantics of EventLoop.stop() in asyncio.

@item 
bpo-6973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6973}: When we know a subprocess.Popen process has died, do not allow
the send_signal(), terminate(), or kill() methods to do anything as they
could potentially signal a different process.

@item 
bpo-25590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25590}: In the Readline completer, only call getattr() once per
attribute.

@item 
bpo-25498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25498}: Fix a crash when garbage-collecting ctypes objects created by
wrapping a memoryview.  This was a regression made in 3.5a1.  Based on
patch by Eryksun.

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: Added «escape» to the __all__ list in the glob module.

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: Fixed recursive glob() with patterns starting with @code{**}.

@item 
bpo-25446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25446}: Fix regression in smtplib’s AUTH LOGIN support.

@item 
bpo-18010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18010}: Fix the pydoc web server’s module search function to handle
exceptions from importing packages.

@item 
bpo-25554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25554}: Got rid of circular references in regular expression parsing.

@item 
bpo-25510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25510}: fileinput.FileInput.readline() now returns b”” instead of “” at
the end if the FileInput was opened with binary mode. Patch by Ryosuke
Ito.

@item 
bpo-25503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25503}: Fixed inspect.getdoc() for inherited docstrings of properties.
Original patch by John Mark Vandenberg.

@item 
bpo-25515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25515}: Always use os.urandom as a source of randomness in uuid.uuid4.

@item 
bpo-21827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21827}: Fixed textwrap.dedent() for the case when largest common
whitespace is a substring of smallest leading whitespace. Based on patch
by Robert Li.

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: The lru_cache() wrapper objects now can be copied and pickled
(by returning the original object unchanged).

@item 
bpo-25390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25390}: typing: Don’t crash on Union[str, Pattern].

@item 
bpo-25441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25441}: asyncio: Raise error from drain() when socket is closed.

@item 
bpo-25410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25410}: Cleaned up and fixed minor bugs in C implementation of
OrderedDict.

@item 
bpo-25411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25411}: Improved Unicode support in SMTPHandler through better use of
the email package. Thanks to user simon04 for the patch.

@item 
bpo-25407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25407}: Remove mentions of the formatter module being removed in Python
3.6.

@item 
bpo-25406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25406}: Fixed a bug in C implementation of OrderedDict.move_to_end()
that caused segmentation fault or hang in iterating after moving several
items to the start of ordered dict.

@item 
bpo-25364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25364}: zipfile now works in threads disabled builds.

@item 
bpo-25328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25328}: smtpd’s SMTPChannel now correctly raises a ValueError if both
decode_data and enable_SMTPUTF8 are set to true.

@item 
bpo-25316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25316}: distutils raises OSError instead of DistutilsPlatformError when
MSVC is not installed.

@item 
bpo-25380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25380}: Fixed protocol for the STACK_GLOBAL opcode in
pickletools.opcodes.

@item 
bpo-23972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23972}: Updates asyncio datagram create method allowing reuseport and
reuseaddr socket options to be set prior to binding the socket. Mirroring
the existing asyncio create_server method the reuseaddr option for
datagram sockets defaults to True if the O/S is “posix” (except if the
platform is Cygwin). Patch by Chris Laws.

@item 
bpo-25304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25304}: Add asyncio.run_coroutine_threadsafe().  This lets you submit a
coroutine to a loop from another thread, returning a
concurrent.futures.Future.  By Vincent Michel.

@item 
bpo-25232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25232}: Fix CGIRequestHandler to split the query from the URL at the
first question mark (?) rather than the last. Patch from Xiang Zhang.

@item 
bpo-24657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24657}: Prevent CGIRequestHandler from collapsing slashes in the query
part of the URL as if it were a path. Patch from Xiang Zhang.

@item 
bpo-24483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24483}: C implementation of functools.lru_cache() now calculates key’s
hash only once.

@item 
bpo-22958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22958}: Constructor and update method of weakref.WeakValueDictionary
now accept the self and the dict keyword arguments.

@item 
bpo-22609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22609}: Constructor of collections.UserDict now accepts the self
keyword argument.

@item 
bpo-25111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25111}: Fixed comparison of traceback.FrameSummary.

@item 
bpo-25262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25262}: Added support for BINBYTES8 opcode in Python implementation of
unpickler. Highest 32 bits of 64-bit size for BINUNICODE8 and BINBYTES8
opcodes no longer silently ignored on 32-bit platforms in C
implementation.

@item 
bpo-25034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25034}: Fix string.Formatter problem with auto-numbering and nested
format_specs. Patch by Anthon van der Neut.

@item 
bpo-25233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25233}: Rewrite the guts of asyncio.Queue and asyncio.Semaphore to be
more understandable and correct.

@item 
bpo-25203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25203}: Failed readline.set_completer_delims() no longer left the
module in inconsistent state.

@item 
bpo-23600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23600}: Default implementation of tzinfo.fromutc() was returning wrong
results in some cases.

@item 
bpo-23329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23329}: Allow the ssl module to be built with older versions of
LibreSSL.

@item 
Prevent overflow in _Unpickler_Read.

@item 
bpo-25047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25047}: The XML encoding declaration written by Element Tree now
respects the letter case given by the user. This restores the ability to
write encoding names in uppercase like «UTF-8», which worked in Python 2.

@item 
bpo-25135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25135}: Make deque_clear() safer by emptying the deque before clearing.
This helps avoid possible reentrancy issues.

@item 
bpo-19143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19143}: platform module now reads Windows version from kernel32.dll to
avoid compatibility shims.

@item 
bpo-25092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25092}: Fix datetime.strftime() failure when errno was already set to
EINVAL.

@item 
bpo-23517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23517}: Fix rounding in fromtimestamp() and utcfromtimestamp() methods
of datetime.datetime: microseconds are now rounded to nearest with ties
going to nearest even integer (ROUND_HALF_EVEN), instead of being rounding
towards minus infinity (ROUND_FLOOR). It’s important that these methods
use the same rounding mode than datetime.timedelta to keep the property:
(datetime(1970,1,1) + timedelta(seconds=t)) ==
datetime.utcfromtimestamp(t). It also the rounding mode used by
round(float) for example.

@item 
bpo-25155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25155}: Fix datetime.datetime.now() and datetime.datetime.utcnow() on
Windows to support date after year 2038. It was a regression introduced in
Python 3.5.0.

@item 
bpo-25108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25108}: Omitted internal frames in traceback functions print_stack(),
format_stack(), and extract_stack() called without arguments.

@item 
bpo-25118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25118}: Fix a regression of Python 3.5.0 in os.waitpid() on Windows.

@item 
bpo-24684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24684}: socket.socket.getaddrinfo() now calls
PyUnicode_AsEncodedString() instead of calling the encode() method of the
host, to handle correctly custom string with an encode() method which
doesn’t return a byte string. The encoder of the IDNA codec is now called
directly instead of calling the encode() method of the string.

@item 
bpo-25060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25060}: Correctly compute stack usage of the BUILD_MAP opcode.

@item 
bpo-24857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24857}: Comparing call_args to a long sequence now correctly returns a
boolean result instead of raising an exception.  Patch by A Kaptur.

@item 
bpo-23144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23144}: Make sure that HTMLParser.feed() returns all the data, even
when convert_charrefs is True.

@item 
bpo-24982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24982}: shutil.make_archive() with the «zip» format now adds entries
for directories (including empty directories) in ZIP file.

@item 
bpo-25019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25019}: Fixed a crash caused by setting non-string key of expat parser.
Based on patch by John Leitch.

@item 
bpo-16180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16180}: Exit pdb if file has syntax error, instead of trapping user in
an infinite loop.  Patch by Xavier de Gaye.

@item 
bpo-24891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24891}: Fix a race condition at Python startup if the file descriptor
of stdin (0), stdout (1) or stderr (2) is closed while Python is creating
sys.stdin, sys.stdout and sys.stderr objects. These attributes are now set
to None if the creation of the object failed, instead of raising an
OSError exception. Initial patch written by Marco Paolini.

@item 
bpo-24992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24992}: Fix error handling and a race condition (related to garbage
collection) in collections.OrderedDict constructor.

@item 
bpo-24881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24881}: Fixed setting binary mode in Python implementation of FileIO on
Windows and Cygwin.  Patch from Akira Li.

@item 
bpo-25578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25578}: Fix (another) memory leak in SSLSocket.getpeercer().

@item 
bpo-25530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25530}: Disable the vulnerable SSLv3 protocol by default when creating
ssl.SSLContext.

@item 
bpo-25569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25569}: Fix memory leak in SSLSocket.getpeercert().

@item 
bpo-25471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25471}: Sockets returned from accept() shouldn’t appear to be
nonblocking.

@item 
bpo-25319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25319}: When threading.Event is reinitialized, the underlying condition
should use a regular lock rather than a recursive lock.

@item 
bpo-21112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21112}: Fix regression in unittest.expectedFailure on subclasses. Patch
from Berker Peksag.

@item 
bpo-24764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24764}: cgi.FieldStorage.read_multi() now ignores the Content-Length
header in part headers. Patch written by Peter Landry and reviewed by
Pierre Quentel.

@item 
bpo-24913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24913}: Fix overrun error in deque.index(). Found by John Leitch and
Bryce Darling.

@item 
bpo-24774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24774}: Fix docstring in http.server.test. Patch from Chiu-Hsiang Hsu.

@item 
bpo-21159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21159}: Improve message in
configparser.InterpolationMissingOptionError. Patch from Łukasz Langa.

@item 
bpo-20362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20362}: Honour TestCase.longMessage correctly in assertRegex. Patch
from Ilia Kurenkov.

@item 
bpo-23572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23572}: Fixed functools.singledispatch on classes with false
metaclasses.  Patch by Ethan Furman.

@item 
asyncio: ensure_future() now accepts awaitable objects.
@end itemize

@node IDLE<56>,Documentation<69>,Library<78>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id679}@anchor{1b97}
@subsubsection IDLE



@itemize -

@item 
bpo-15348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15348}: Stop the debugger engine (normally in a user process) before
closing the debugger window (running in the IDLE process). This prevents
the RuntimeErrors that were being caught and ignored.

@item 
bpo-24455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24455}: Prevent IDLE from hanging when a) closing the shell while the
debugger is active (15347); b) closing the debugger with the [X] button
(15348); and c) activating the debugger when already active (24455). The
patch by Mark Roseman does this by making two changes. 1. Suspend and
resume the gui.interaction method with the tcl vwait mechanism intended
for this purpose (instead of root.mainloop & .quit). 2. In gui.run, allow
any existing interaction to terminate first.

@item 
Change “The program” to “Your program” in an IDLE “kill program?” message
to make it clearer that the program referred to is the currently running
user program, not IDLE itself.

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: Improve the appearance of the IDLE editor window status bar.
Patch by Mark Roseman.

@item 
bpo-25313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25313}: Change the handling of new built-in text color themes to better
address the compatibility problem introduced by the addition of IDLE Dark.
Consistently use the revised idleConf.CurrentTheme everywhere in idlelib.

@item 
bpo-24782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24782}: Extension configuration is now a tab in the IDLE Preferences
dialog rather than a separate dialog.  The former tabs are now a sorted
list.  Patch by Mark Roseman.

@item 
bpo-22726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22726}: Re-activate the config dialog help button with some content
about the other buttons and the new IDLE Dark theme.

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: IDLE now has an “IDLE Dark” built-in text color theme. It is
more or less IDLE Classic inverted, with a cobalt blue background.
Strings, comments, keywords, … are still green, red, orange, … . To
use it with IDLEs released before November 2015, hit the “Save as New
Custom Theme” button and enter a new name, such as “Custom Dark”.  The
custom theme will work with any IDLE release, and can be modified.

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: README.txt is now an idlelib index for IDLE developers and
curious users. The previous user content is now in the IDLE doc chapter.
“IDLE” now means “Integrated Development and Learning Environment”.

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: Users can now set breakpoint colors in Settings -> Custom
Highlighting. Original patch by Mark Roseman.

@item 
bpo-24972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24972}: Inactive selection background now matches active selection
background, as configured by users, on all systems.  Found items are now
always highlighted on Windows.  Initial patch by Mark Roseman.

@item 
bpo-24570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24570}: Idle: make calltip and completion boxes appear on Macs affected
by a tk regression.  Initial patch by Mark Roseman.

@item 
bpo-24988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24988}: Idle ScrolledList context menus (used in debugger) now work on
Mac Aqua. Patch by Mark Roseman.

@item 
bpo-24801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24801}: Make right-click for context menu work on Mac Aqua. Patch by
Mark Roseman.

@item 
bpo-25173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25173}: Associate tkinter messageboxes with a specific widget. For Mac
OSX, make them a “sheet”.  Patch by Mark Roseman.

@item 
bpo-25198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25198}: Enhance the initial html viewer now used for Idle Help.
Properly indent fixed-pitch text (patch by Mark Roseman). Give code
snippet a very Sphinx-like light blueish-gray background. Re-use initial
width and height set by users for shell and editor. When the Table of
Contents (TOC) menu is used, put the section header at the top of the
screen.

@item 
bpo-25225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25225}: Condense and rewrite Idle doc section on text colors.

@item 
bpo-21995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21995}: Explain some differences between IDLE and console Python.

@item 
bpo-22820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22820}: Explain need for `print' when running file from Idle editor.

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: Doc: augment Idle feature list and no-subprocess section.

@item 
bpo-25219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25219}: Update doc for Idle command line options. Some were missing and
notes were not correct.

@item 
bpo-24861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24861}: Most of idlelib is private and subject to change. Use
idleib.idle.* to start Idle. See idlelib.__init__.__doc__.

@item 
bpo-25199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25199}: Idle: add synchronization comments for future maintainers.

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: Replace help.txt with help.html for Idle doc display. The new
idlelib/help.html is rstripped Doc/build/html/library/idle.html. It looks
better than help.txt and will better document Idle as released. The
tkinter html viewer that works for this file was written by Mark Roseman.
The now unused EditorWindow.HelpDialog class and helt.txt file are
deprecated.

@item 
bpo-24199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24199}: Deprecate unused idlelib.idlever with possible removal in 3.6.

@item 
bpo-24790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24790}: Remove extraneous code (which also create 2 & 3 conflicts).
@end itemize

@node Documentation<69>,Tests<71>,IDLE<56>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id680}@anchor{1b98}
@subsubsection Documentation



@itemize -

@item 
bpo-22558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22558}: Add remaining doc links to source code for Python-coded
modules. Patch by Yoni Lavi.

@item 
bpo-12067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12067}: Rewrite Comparisons section in the Expressions chapter of the
language reference. Some of the details of comparing mixed types were
incorrect or ambiguous. NotImplemented is only relevant at a lower level
than the Expressions chapter. Added details of comparing range() objects,
and default behaviour and consistency suggestions for user-defined
classes. Patch from Andy Maier.

@item 
bpo-24952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24952}: Clarify the default size argument of stack_size() in the
«threading» and «_thread» modules. Patch from Mattip.

@item 
bpo-23725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23725}: Overhaul tempfile docs. Note deprecated status of mktemp. Patch
from Zbigniew Jędrzejewski-Szmek.

@item 
bpo-24808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24808}: Update the types of some PyTypeObject fields.  Patch by Joseph
Weston.

@item 
bpo-22812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22812}: Fix unittest discovery examples. Patch from Pam McA’Nulty.
@end itemize

@node Tests<71>,Build<75>,Documentation<69>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id681}@anchor{1b99}
@subsubsection Tests



@itemize -

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: Added tests for OrderedDict subclasses.

@item 
bpo-25099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25099}: Make test_compileall not fail when an entry on sys.path cannot
be written to (commonly seen in administrative installs on Windows).

@item 
bpo-23919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23919}: Prevents assert dialogs appearing in the test suite.

@item 
@code{PCbuild\rt.bat} now accepts an unlimited number of arguments to pass
along to regrtest.py.  Previously there was a limit of 9.
@end itemize

@node Build<75>,Windows<69>,Tests<71>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id682}@anchor{1b9a}
@subsubsection Build



@itemize -

@item 
bpo-24915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24915}: Add LLVM support for PGO builds and use the test suite to
generate the profile data. Initial patch by Alecsandru Patrascu of Intel.

@item 
bpo-24910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24910}: Windows MSIs now have unique display names.

@item 
bpo-24986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24986}: It is now possible to build Python on Windows without errors
when external libraries are not available.
@end itemize

@node Windows<69>,Tools/Demos<44>,Build<75>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id683}@anchor{1b9b}
@subsubsection Windows



@itemize -

@item 
bpo-25450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25450}: Updates shortcuts to start Python in installation directory.

@item 
bpo-25164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25164}: Changes default all-users install directory to match per-user
directory.

@item 
bpo-25143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25143}: Improves installer error messages for unsupported platforms.

@item 
bpo-25163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25163}: Display correct directory in installer when using non-default
settings.

@item 
bpo-25361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25361}: Disables use of SSE2 instructions in Windows 32-bit build

@item 
bpo-25089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25089}: Adds logging to installer for case where launcher is not
selected on upgrade.

@item 
bpo-25165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25165}: Windows uninstallation should not remove launcher if other
versions remain

@item 
bpo-25112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25112}: py.exe launcher is missing icons

@item 
bpo-25102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25102}: Windows installer does not precompile for -O or -OO.

@item 
bpo-25081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25081}: Makes Back button in installer go back to upgrade page when
upgrading.

@item 
bpo-25091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25091}: Increases font size of the installer.

@item 
bpo-25126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25126}: Clarifies that the non-web installer will download some
components.

@item 
bpo-25213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25213}: Restores requestedExecutionLevel to manifest to disable UAC
virtualization.

@item 
bpo-25022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25022}: Removed very outdated PC/example_nt/ directory.
@end itemize

@node Tools/Demos<44>,,Windows<69>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id684}@anchor{1b9c}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-25440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25440}: Fix output of python-config –extension-suffix.
@end itemize

@node Python 3 5 0 final,Python 3 5 0 release candidate 4,Python 3 5 1 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-final}@anchor{1b9d}
@subsection Python 3.5.0 final


`Release date: 2015-09-13'

@menu
* Build: Build<76>. 

@end menu

@node Build<76>,,,Python 3 5 0 final
@anchor{whatsnew/changelog id685}@anchor{1b9e}
@subsubsection Build



@itemize -

@item 
bpo-25071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25071}: Windows installer should not require TargetDir parameter when
installing quietly.
@end itemize

@node Python 3 5 0 release candidate 4,Python 3 5 0 release candidate 3,Python 3 5 0 final,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-release-candidate-4}@anchor{1b9f}
@subsection Python 3.5.0 release candidate 4


`Release date: 2015-09-09'

@menu
* Library: Library<79>. 
* Build: Build<77>. 

@end menu

@node Library<79>,Build<77>,,Python 3 5 0 release candidate 4
@anchor{whatsnew/changelog id686}@anchor{1ba0}
@subsubsection Library



@itemize -

@item 
bpo-25029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25029}: Fixes MemoryError in test_strptime.
@end itemize

@node Build<77>,,Library<79>,Python 3 5 0 release candidate 4
@anchor{whatsnew/changelog id687}@anchor{1ba1}
@subsubsection Build



@itemize -

@item 
bpo-25027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25027}: Reverts partial-static build options and adds vcruntime140.dll
to Windows installation.
@end itemize

@node Python 3 5 0 release candidate 3,Python 3 5 0 release candidate 2,Python 3 5 0 release candidate 4,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-release-candidate-3}@anchor{1ba2}
@subsection Python 3.5.0 release candidate 3


`Release date: 2015-09-07'

@menu
* Core and Builtins: Core and Builtins<80>. 
* Library: Library<80>. 

@end menu

@node Core and Builtins<80>,Library<80>,,Python 3 5 0 release candidate 3
@anchor{whatsnew/changelog id688}@anchor{1ba3}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24305}: Prevent import subsystem stack frames from being counted by the
warnings.warn(stacklevel=) parameter.

@item 
bpo-24912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24912}: Prevent __class__ assignment to immutable built-in objects.

@item 
bpo-24975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24975}: Fix AST compilation for 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} syntax.
@end itemize

@node Library<80>,,Core and Builtins<80>,Python 3 5 0 release candidate 3
@anchor{whatsnew/changelog id689}@anchor{1ba4}
@subsubsection Library



@itemize -

@item 
bpo-24917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24917}: time_strftime() buffer over-read.

@item 
bpo-24748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24748}: To resolve a compatibility problem found with py2exe and
pywin32, imp.load_dynamic() once again ignores previously loaded modules
to support Python modules replacing themselves with extension modules.
Patch by Petr Viktorin.

@item 
bpo-24635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24635}: Fixed a bug in typing.py where isinstance([], typing.Iterable)
would return True once, then False on subsequent calls.

@item 
bpo-24989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24989}: Fixed buffer overread in BytesIO.readline() if a position is
set beyond size.  Based on patch by John Leitch.

@item 
bpo-24913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24913}: Fix overrun error in deque.index(). Found by John Leitch and
Bryce Darling.
@end itemize

@node Python 3 5 0 release candidate 2,Python 3 5 0 release candidate 1,Python 3 5 0 release candidate 3,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-release-candidate-2}@anchor{1ba5}
@subsection Python 3.5.0 release candidate 2


`Release date: 2015-08-25'

@menu
* Core and Builtins: Core and Builtins<81>. 
* Library: Library<81>. 

@end menu

@node Core and Builtins<81>,Library<81>,,Python 3 5 0 release candidate 2
@anchor{whatsnew/changelog id690}@anchor{1ba6}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24769}: Interpreter now starts properly when dynamic loading is
disabled.  Patch by Petr Viktorin.

@item 
bpo-21167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21167}: NAN operations are now handled correctly when python is
compiled with ICC even if -fp-model strict is not specified.

@item 
bpo-24492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24492}: A «package» lacking a __name__ attribute when trying to perform
a @code{from .. import ...} statement will trigger an ImportError instead of
an AttributeError.
@end itemize

@node Library<81>,,Core and Builtins<81>,Python 3 5 0 release candidate 2
@anchor{whatsnew/changelog id691}@anchor{1ba7}
@subsubsection Library



@itemize -

@item 
bpo-24847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24847}: Removes vcruntime140.dll dependency from Tcl/Tk.

@item 
bpo-24839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24839}: platform._syscmd_ver raises DeprecationWarning

@item 
bpo-24867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24867}: Fix Task.get_stack() for “async def” coroutines
@end itemize

@node Python 3 5 0 release candidate 1,Python 3 5 0 beta 4,Python 3 5 0 release candidate 2,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-release-candidate-1}@anchor{1ba8}
@subsection Python 3.5.0 release candidate 1


`Release date: 2015-08-09'

@menu
* Core and Builtins: Core and Builtins<82>. 
* Library: Library<82>. 
* IDLE: IDLE<57>. 
* Documentation: Documentation<70>. 
* Tests: Tests<72>. 

@end menu

@node Core and Builtins<82>,Library<82>,,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id692}@anchor{1ba9}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24667}: Resize odict in all cases that the underlying dict resizes.
@end itemize

@node Library<82>,IDLE<57>,Core and Builtins<82>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id693}@anchor{1baa}
@subsubsection Library



@itemize -

@item 
bpo-24824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24824}: Signatures of codecs.encode() and codecs.decode() now are
compatible with pydoc.

@item 
bpo-24634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24634}: Importing uuid should not try to load libc on Windows

@item 
bpo-24798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24798}: _msvccompiler.py doesn’t properly support manifests

@item 
bpo-4395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4395}: Better testing and documentation of binary operators. Patch by
Martin Panter.

@item 
bpo-23973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23973}: Update typing.py from GitHub repo.

@item 
bpo-23004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23004}: mock_open() now reads binary data correctly when the type of
read_data is bytes.  Initial patch by Aaron Hill.

@item 
bpo-23888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23888}: Handle fractional time in cookie expiry. Patch by ssh.

@item 
bpo-23652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23652}: Make it possible to compile the select module against the libc
headers from the Linux Standard Base, which do not include some EPOLL
macros.  Patch by Matt Frank.

@item 
bpo-22932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22932}: Fix timezones in email.utils.formatdate. Patch from Dmitry
Shachnev.

@item 
bpo-23779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23779}: imaplib raises TypeError if authenticator tries to abort. Patch
from Craig Holmquist.

@item 
bpo-23319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23319}: Fix ctypes.BigEndianStructure, swap correctly bytes. Patch
written by Matthieu Gautier.

@item 
bpo-23254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23254}: Document how to close the TCPServer listening socket. Patch
from Martin Panter.

@item 
bpo-19450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19450}: Update Windows and OS X installer builds to use SQLite 3.8.11.

@item 
bpo-17527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17527}: Add PATCH to wsgiref.validator. Patch from Luca Sbardella.

@item 
bpo-24791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24791}: Fix grammar regression for call syntax: “g(*a or b)”.
@end itemize

@node IDLE<57>,Documentation<70>,Library<82>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id694}@anchor{1bab}
@subsubsection IDLE



@itemize -

@item 
bpo-23672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23672}: Allow Idle to edit and run files with astral chars in name.
Patch by Mohd Sanad Zaki Rizvi.

@item 
bpo-24745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24745}: Idle editor default font. Switch from Courier to
platform-sensitive TkFixedFont.  This should not affect current customized
font selections.  If there is a problem, edit
$HOME/.idlerc/config-main.cfg and remove “@code{font@var{xxx}}” entries from
[Editor Window].  Patch by Mark Roseman.

@item 
bpo-21192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21192}: Idle editor. When a file is run, put its name in the restart
bar. Do not print false prompts. Original patch by Adnan Umer.

@item 
bpo-13884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13884}: Idle menus. Remove tearoff lines. Patch by Roger Serwy.
@end itemize

@node Documentation<70>,Tests<72>,IDLE<57>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id695}@anchor{1bac}
@subsubsection Documentation



@itemize -

@item 
bpo-24129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24129}: Clarify the reference documentation for name resolution. This
includes removing the assumption that readers will be familiar with the
name resolution scheme Python used prior to the introduction of lexical
scoping for function namespaces. Patch by Ivan Levkivskyi.

@item 
bpo-20769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20769}: Improve reload() docs. Patch by Dorian Pula.

@item 
bpo-23589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23589}: Remove duplicate sentence from the FAQ.  Patch by Yongzhi Pan.

@item 
bpo-24729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24729}: Correct IO tutorial to match implementation regarding encoding
parameter to open function.
@end itemize

@node Tests<72>,,Documentation<70>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id696}@anchor{1bad}
@subsubsection Tests



@itemize -

@item 
bpo-24751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24751}: When running regrtest with the @code{-w} command line option, a
test run is no longer marked as a failure if all tests succeed when
re-run.
@end itemize

@node Python 3 5 0 beta 4,Python 3 5 0 beta 3,Python 3 5 0 release candidate 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-beta-4}@anchor{1bae}
@subsection Python 3.5.0 beta 4


`Release date: 2015-07-26'

@menu
* Core and Builtins: Core and Builtins<83>. 
* Library: Library<83>. 
* Build: Build<78>. 

@end menu

@node Core and Builtins<83>,Library<83>,,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id697}@anchor{1baf}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}: Restored optimization of bytes.rfind() and bytearray.rfind()
for single-byte argument on Linux.

@item 
bpo-24569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24569}: Make 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} dictionary evaluation more consistent.

@item 
bpo-24583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24583}: Fix crash when set is mutated while being updated.

@item 
bpo-24407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24407}: Fix crash when dict is mutated while being updated.

@item 
bpo-24619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24619}: New approach for tokenizing async/await. As a consequence, it
is now possible to have one-line “async def foo(): await ..” functions.

@item 
bpo-24687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24687}: Plug refleak on SyntaxError in function parameters annotations.

@item 
bpo-15944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15944}: memoryview: Allow arbitrary formats when casting to bytes.
Patch by Martin Panter.
@end itemize

@node Library<83>,Build<78>,Core and Builtins<83>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id698}@anchor{1bb0}
@subsubsection Library



@itemize -

@item 
bpo-23441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23441}: rcompleter now prints a tab character instead of displaying
possible completions for an empty word.  Initial patch by Martin Sekera.

@item 
bpo-24683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24683}: Fixed crashes in _json functions called with arguments of
inappropriate type.

@item 
bpo-21697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21697}: shutil.copytree() now correctly handles symbolic links that
point to directories.  Patch by Eduardo Seabra and Thomas Kluyver.

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: Fixed segmentation fault when gc.collect() is called during
constructing lru_cache (C implementation).

@item 
bpo-24695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24695}: Fix a regression in traceback.print_exception().  If
exc_traceback is None we shouldn’t print a traceback header like described
in the documentation.

@item 
bpo-24620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24620}: Random.setstate() now validates the value of state last
element.

@item 
bpo-22485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22485}: Fixed an issue that caused @code{inspect.getsource} to return
incorrect results on nested functions.

@item 
bpo-22153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22153}: Improve unittest docs. Patch from Martin Panter and evilzero.

@item 
bpo-24580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24580}: Symbolic group references to open group in re patterns now are
explicitly forbidden as well as numeric group references.

@item 
bpo-24206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24206}: Fixed __eq__ and __ne__ methods of inspect classes.

@item 
bpo-24631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24631}: Fixed regression in the timeit module with multiline setup.

@item 
bpo-18622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18622}: unittest.mock.mock_open().reset_mock would recurse infinitely.
Patch from Nicola Palumbo and Laurent De Buyst.

@item 
bpo-23661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23661}: unittest.mock side_effects can now be exceptions again. This
was a regression vs Python 3.4. Patch from Ignacio Rossi

@item 
bpo-24608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24608}: chunk.Chunk.read() now always returns bytes, not str.

@item 
bpo-18684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18684}: Fixed reading out of the buffer in the re module.

@item 
bpo-24259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24259}: tarfile now raises a ReadError if an archive is truncated
inside a data segment.

@item 
bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}: SMTP.auth() and SMTP.login() now support RFC 4954’s optional
initial-response argument to the SMTP AUTH command.

@item 
bpo-24669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24669}: Fix inspect.getsource() for “async def” functions. Patch by Kai
Groner.

@item 
bpo-24688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24688}: ast.get_docstring() for “async def” functions.
@end itemize

@node Build<78>,,Library<83>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id699}@anchor{1bb1}
@subsubsection Build



@itemize -

@item 
bpo-24603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24603}: Update Windows builds and OS X 10.5 installer to use OpenSSL
1.0.2d.
@end itemize

@node Python 3 5 0 beta 3,Python 3 5 0 beta 2,Python 3 5 0 beta 4,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-beta-3}@anchor{1bb2}
@subsection Python 3.5.0 beta 3


`Release date: 2015-07-05'

@menu
* Core and Builtins: Core and Builtins<84>. 
* Library: Library<84>. 
* Tests: Tests<73>. 
* Documentation: Documentation<71>. 
* Build: Build<79>. 

@end menu

@node Core and Builtins<84>,Library<84>,,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id700}@anchor{1bb3}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24467}: Fixed possible buffer over-read in bytearray. The bytearray
object now always allocates place for trailing null byte and it’s buffer
now is always null-terminated.

@item 
Upgrade to Unicode 8.0.0.

@item 
bpo-24345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24345}: Add Py_tp_finalize slot for the stable ABI.

@item 
bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}: Introduce a distinct type for 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} coroutines; add
types.CoroutineType, inspect.getcoroutinestate,
inspect.getcoroutinelocals; coroutines no longer use CO_GENERATOR flag;
sys.set_coroutine_wrapper works only for “async def” coroutines;
inspect.iscoroutine no longer uses collections.abc.Coroutine, it’s
intended to test for pure “async def” coroutines only; add new opcode:
GET_YIELD_FROM_ITER; fix generators wrapper used in types.coroutine to be
instance of collections.abc.Generator; collections.abc.Awaitable and
collections.abc.Coroutine can no longer be used to detect generator-based
coroutines–use inspect.isawaitable instead.

@item 
bpo-24450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24450}: Add gi_yieldfrom to generators and cr_await to coroutines.
Contributed by Benno Leslie and Yury Selivanov.

@item 
bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}: Add new RecursionError exception. Patch by Georg Brandl.
@end itemize

@node Library<84>,Tests<73>,Core and Builtins<84>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id701}@anchor{1bb4}
@subsubsection Library



@itemize -

@item 
bpo-21750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21750}: mock_open.read_data can now be read from each instance, as it
could in Python 3.3.

@item 
bpo-24552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24552}: Fix use after free in an error case of the _pickle module.

@item 
bpo-24514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24514}: tarfile now tolerates number fields consisting of only
whitespace.

@item 
bpo-19176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19176}: Fixed doctype() related bugs in C implementation of
ElementTree. A deprecation warning no longer issued by XMLParser subclass
with default doctype() method.  Direct call of doctype() now issues a
warning.  Parser’s doctype() now is not called if target’s doctype() is
called.  Based on patch by Martin Panter.

@item 
bpo-20387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20387}: Restore semantic round-trip correctness in tokenize/untokenize
for tab-indented blocks.

@item 
bpo-24456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24456}: Fixed possible buffer over-read in adpcm2lin() and lin2adpcm()
functions of the audioop module.

@item 
bpo-24336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24336}: The contextmanager decorator now works with functions with
keyword arguments called «func» and «self».  Patch by Martin Panter.

@item 
bpo-24522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24522}: Fix possible integer overflow in json accelerator module.

@item 
bpo-24489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24489}: ensure a previously set C errno doesn’t disturb cmath.polar().

@item 
bpo-24408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24408}: Fixed AttributeError in measure() and metrics() methods of
tkinter.Font.

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: C implementation of functools.lru_cache() now can be used with
methods.

@item 
bpo-24347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24347}: Set KeyError if PyDict_GetItemWithError returns NULL.

@item 
bpo-24348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24348}: Drop superfluous incref/decref.

@item 
bpo-24359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24359}: Check for changed OrderedDict size during iteration.

@item 
bpo-24368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24368}: Support keyword arguments in OrderedDict methods.

@item 
bpo-24362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24362}: Simplify the C OrderedDict fast nodes resize logic.

@item 
bpo-24377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24377}: Fix a ref leak in OrderedDict.__repr__.

@item 
bpo-24369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24369}: Defend against key-changes during iteration.
@end itemize

@node Tests<73>,Documentation<71>,Library<84>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id702}@anchor{1bb5}
@subsubsection Tests



@itemize -

@item 
bpo-24373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24373}: _testmultiphase and xxlimited now use tp_traverse and
tp_finalize to avoid reference leaks encountered when combining tp_dealloc
with PyType_FromSpec (see bpo-16690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16690} for details)
@end itemize

@node Documentation<71>,Build<79>,Tests<73>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id703}@anchor{1bb6}
@subsubsection Documentation



@itemize -

@item 
bpo-24458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24458}: Update documentation to cover multi-phase initialization for
extension modules (PEP 489). Patch by Petr Viktorin.

@item 
bpo-24351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24351}: Clarify what is meant by «identifier» in the context of
string.Template instances.
@end itemize

@node Build<79>,,Documentation<71>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id704}@anchor{1bb7}
@subsubsection Build



@itemize -

@item 
bpo-24432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24432}: Update Windows builds and OS X 10.5 installer to use OpenSSL
1.0.2c.
@end itemize

@node Python 3 5 0 beta 2,Python 3 5 0 beta 1,Python 3 5 0 beta 3,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-beta-2}@anchor{1bb8}
@subsection Python 3.5.0 beta 2


`Release date: 2015-05-31'

@menu
* Core and Builtins: Core and Builtins<85>. 
* Library: Library<85>. 

@end menu

@node Core and Builtins<85>,Library<85>,,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id705}@anchor{1bb9}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24284}: The startswith and endswith methods of the str class no longer
return True when finding the empty string and the indexes are completely
out of range.

@item 
bpo-24115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24115}: Update uses of PyObject_IsTrue(), PyObject_Not(),
PyObject_IsInstance(), PyObject_RichCompareBool() and _PyDict_Contains()
to check for and handle errors correctly.

@item 
bpo-24328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24328}: Fix importing one character extension modules.

@item 
bpo-11205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11205}: In dictionary displays, evaluate the key before the value.

@item 
bpo-24285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24285}: Fixed regression that prevented importing extension modules
from inside packages. Patch by Petr Viktorin.
@end itemize

@node Library<85>,,Core and Builtins<85>,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id706}@anchor{1bba}
@subsubsection Library



@itemize -

@item 
bpo-23247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23247}: Fix a crash in the StreamWriter.reset() of CJK codecs.

@item 
bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}: Add math.isclose() and cmath.isclose() functions as per
@geindex Python Enhancement Proposals; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/}. Contributed by Chris Barker and Tal Einat.

@item 
bpo-5633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5633}: Fixed timeit when the statement is a string and the setup is
not.

@item 
bpo-24326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24326}: Fixed audioop.ratecv() with non-default weightB argument.
Original patch by David Moore.

@item 
bpo-16991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16991}: Add a C implementation of OrderedDict.

@item 
bpo-23934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23934}: Fix inspect.signature to fail correctly for builtin types
lacking signature information.  Initial patch by James Powell.
@end itemize

@node Python 3 5 0 beta 1,Python 3 5 0 alpha 4,Python 3 5 0 beta 2,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-beta-1}@anchor{1bbb}
@subsection Python 3.5.0 beta 1


`Release date: 2015-05-24'

@menu
* Core and Builtins: Core and Builtins<86>. 
* Library: Library<86>. 
* IDLE: IDLE<58>. 
* Tests: Tests<74>. 
* Documentation: Documentation<72>. 
* Tools/Demos: Tools/Demos<45>. 

@end menu

@node Core and Builtins<86>,Library<86>,,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id707}@anchor{1bbc}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-24276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24276}: Fixed optimization of property descriptor getter.

@item 
bpo-24268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24268}: PEP 489: Multi-phase extension module initialization. Patch by
Petr Viktorin.

@item 
bpo-23955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23955}: Add pyvenv.cfg option to suppress registry/environment lookup
for generating sys.path on Windows.

@item 
bpo-24257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24257}: Fixed system error in the comparison of faked
types.SimpleNamespace.

@item 
bpo-22939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22939}: Fixed integer overflow in iterator object.  Patch by Clement
Rouault.

@item 
bpo-23985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23985}: Fix a possible buffer overrun when deleting a slice from the
front of a bytearray and then appending some other bytes data.

@item 
bpo-24102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24102}: Fixed exception type checking in standard error handlers.

@item 
bpo-15027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15027}: The UTF-32 encoder is now 3x to 7x faster.

@item 
bpo-23290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23290}: Optimize set_merge() for cases where the target is empty.
(Contributed by Serhiy Storchaka.)

@item 
bpo-2292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2292}: PEP 448: Additional Unpacking Generalizations.

@item 
bpo-24096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24096}: Make warnings.warn_explicit more robust against mutation of the
warnings.filters list.

@item 
bpo-23996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23996}: Avoid a crash when a delegated generator raises an unnormalized
StopIteration exception.  Patch by Stefan Behnel.

@item 
bpo-23910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23910}: Optimize property() getter calls.  Patch by Joe Jevnik.

@item 
bpo-23911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23911}: Move path-based importlib bootstrap code to a separate frozen
module.

@item 
bpo-24192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24192}: Fix namespace package imports.

@item 
bpo-24022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24022}: Fix tokenizer crash when processing undecodable source code.

@item 
bpo-9951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9951}: Added a hex() method to bytes, bytearray, and memoryview.

@item 
bpo-22906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22906}: PEP 479: Change StopIteration handling inside generators.

@item 
bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}: PEP 492: Coroutines with async and await syntax.
@end itemize

@node Library<86>,IDLE<58>,Core and Builtins<86>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id708}@anchor{1bbd}
@subsubsection Library



@itemize -

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: Added C implementation of functools.lru_cache().  Based on
patches by Matt Joiner and Alexey Kachayev.

@item 
bpo-24230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24230}: The tempfile module now accepts bytes for prefix, suffix and
dir parameters and returns bytes in such situations (matching the os
module APIs).

@item 
bpo-22189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22189}: collections.UserString now supports __getnewargs__(),
__rmod__(), casefold(), format_map(), isprintable(), and maketrans().
Patch by Joe Jevnik.

@item 
bpo-24244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24244}: Prevents termination when an invalid format string is
encountered on Windows in strftime.

@item 
bpo-23973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23973}: PEP 484: Add the typing module.

@item 
bpo-23086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23086}: The collections.abc.Sequence() abstract base class added
`start' and `stop' parameters to the index() mixin. Patch by Devin
Jeanpierre.

@item 
bpo-20035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20035}: Replaced the @code{tkinter._fix} module used for setting up the
Tcl/Tk environment on Windows with a private function in the @code{_tkinter}
module that makes no permanent changes to the environment.

@item 
bpo-24257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24257}: Fixed segmentation fault in sqlite3.Row constructor with faked
cursor type.

@item 
bpo-15836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15836}: assertRaises(), assertRaisesRegex(), assertWarns() and
assertWarnsRegex() assertments now check the type of the first argument to
prevent possible user error.  Based on patch by Daniel Wagner-Hall.

@item 
bpo-9858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9858}: Add missing method stubs to _io.RawIOBase.  Patch by Laura
Rupprecht.

@item 
bpo-22955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22955}: attrgetter, itemgetter and methodcaller objects in the operator
module now support pickling.  Added readable and evaluable repr for these
objects. Based on patch by Josh Rosenberg.

@item 
bpo-22107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22107}: tempfile.gettempdir() and tempfile.mkdtemp() now try again when
a directory with the chosen name already exists on Windows as well as on
Unix. tempfile.mkstemp() now fails early if parent directory is not valid
(not exists or is a file) on Windows.

@item 
bpo-23780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23780}: Improved error message in os.path.join() with single argument.

@item 
bpo-6598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6598}: Increased time precision and random number range in
email.utils.make_msgid() to strengthen the uniqueness of the message ID.

@item 
bpo-24091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24091}: Fixed various crashes in corner cases in C implementation of
ElementTree.

@item 
bpo-21931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21931}: msilib.FCICreate() now raises TypeError in the case of a bad
argument instead of a ValueError with a bogus FCI error number. Patch by
Jeffrey Armstrong.

@item 
bpo-13866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13866}: `quote_via' argument added to urllib.parse.urlencode.

@item 
bpo-20098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20098}: New mangle_from policy option for email, default True for
compat32, but False for all other policies.

@item 
bpo-24211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24211}: The email library now supports RFC 6532: it can generate
headers using utf-8 instead of encoded words.

@item 
bpo-16314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16314}: Added support for the LZMA compression in distutils.

@item 
bpo-21804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21804}: poplib now supports RFC 6856 (UTF8).

@item 
bpo-18682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18682}: Optimized pprint functions for builtin scalar types.

@item 
bpo-22027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22027}: smtplib now supports RFC 6531 (SMTPUTF8).

@item 
bpo-23488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23488}: Random generator objects now consume 2x less memory on 64-bit.

@item 
bpo-1322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1322}: platform.dist() and platform.linux_distribution() functions are
now deprecated.  Initial patch by Vajrasky Kok.

@item 
bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}: Added the math.gcd() function.  The fractions.gcd() function
now is deprecated.  Based on patch by Mark Dickinson.

@item 
bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}: Property() docstrings are now writeable. (Patch by Berker
Peksag.)

@item 
bpo-22681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22681}: Added support for the koi8_t encoding.

@item 
bpo-22682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22682}: Added support for the kz1048 encoding.

@item 
bpo-23796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23796}: peek and read1 methods of BufferedReader now raise ValueError
if they called on a closed object. Patch by John Hergenroeder.

@item 
bpo-21795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21795}: smtpd now supports the 8BITMIME extension whenever the new
`decode_data' constructor argument is set to False.

@item 
bpo-24155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24155}: optimize heapq.heapify() for better cache performance when
heapifying large lists.

@item 
bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}: imaplib now supports RFC 5161 (enable), RFC 6855
(utf8/internationalized email) and automatically encodes non-ASCII
usernames and passwords to UTF8.

@item 
bpo-20274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20274}: When calling a _sqlite.Connection, it now complains if passed
any keyword arguments.  Previously it silently ignored them.

@item 
bpo-20274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20274}: Remove ignored and erroneous «kwargs» parameters from three
METH_VARARGS methods on _sqlite.Connection.

@item 
bpo-24134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24134}: assertRaises(), assertRaisesRegex(), assertWarns() and
assertWarnsRegex() checks now emits a deprecation warning when callable is
None or keyword arguments except msg is passed in the context manager
mode.

@item 
bpo-24018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24018}: Add a collections.abc.Generator abstract base class.
Contributed by Stefan Behnel.

@item 
bpo-23880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23880}: Tkinter’s getint() and getdouble() now support Tcl_Obj.
Tkinter’s getdouble() now supports any numbers (in particular int).

@item 
bpo-22619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22619}: Added negative limit support in the traceback module. Based on
patch by Dmitry Kazakov.

@item 
bpo-24094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24094}: Fix possible crash in json.encode with poorly behaved dict
subclasses.

@item 
bpo-9246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9246}: On POSIX, os.getcwd() now supports paths longer than 1025 bytes.
Patch written by William Orr.

@item 
bpo-17445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17445}: add difflib.diff_bytes() to support comparison of byte strings
(fixes a regression from Python 2).

@item 
bpo-23917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23917}: Fall back to sequential compilation when ProcessPoolExecutor
doesn’t exist. Patch by Claudiu Popa.

@item 
bpo-23008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23008}: Fixed resolving attributes with boolean value is False in
pydoc.

@item 
Fix asyncio issue 235: LifoQueue and PriorityQueue’s put didn’t increment
unfinished tasks (this bug was introduced when JoinableQueue was merged
with Queue).

@item 
bpo-23908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23908}: os functions now reject paths with embedded null character on
Windows instead of silently truncating them.

@item 
bpo-23728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23728}: binascii.crc_hqx() could return an integer outside of the range
0-0xffff for empty data.

@item 
bpo-23887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23887}: urllib.error.HTTPError now has a proper repr() representation.
Patch by Berker Peksag.

@item 
asyncio: New event loop APIs: set_task_factory() and get_task_factory().

@item 
asyncio: async() function is deprecated in favour of ensure_future().

@item 
bpo-24178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24178}: asyncio.Lock, Condition, Semaphore, and BoundedSemaphore
support new “async with” syntax.  Contributed by Yury Selivanov.

@item 
bpo-24179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24179}: Support “async for” for asyncio.StreamReader. Contributed by
Yury Selivanov.

@item 
bpo-24184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24184}: Add AsyncIterator and AsyncIterable ABCs to collections.abc.
Contributed by Yury Selivanov.

@item 
bpo-22547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22547}: Implement informative __repr__ for inspect.BoundArguments.
Contributed by Yury Selivanov.

@item 
bpo-24190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24190}: Implement inspect.BoundArgument.apply_defaults() method.
Contributed by Yury Selivanov.

@item 
bpo-20691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20691}: Add “follow_wrapped” argument to
inspect.Signature.from_callable() and inspect.signature(). Contributed by
Yury Selivanov.

@item 
bpo-24248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24248}: Deprecate inspect.Signature.from_function() and
inspect.Signature.from_builtin().

@item 
bpo-23898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23898}: Fix inspect.classify_class_attrs() to support attributes with
overloaded __eq__ and __bool__.  Patch by Mike Bayer.

@item 
bpo-24298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24298}: Fix inspect.signature() to correctly unwrap wrappers around
bound methods.
@end itemize

@node IDLE<58>,Tests<74>,Library<86>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id709}@anchor{1bbe}
@subsubsection IDLE



@itemize -

@item 
bpo-23184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23184}: remove unused names and imports in idlelib. Initial patch by Al
Sweigart.
@end itemize

@node Tests<74>,Documentation<72>,IDLE<58>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id710}@anchor{1bbf}
@subsubsection Tests



@itemize -

@item 
bpo-21520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21520}: test_zipfile no longer fails if the word “bad” appears anywhere
in the name of the current directory.

@item 
bpo-9517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9517}: Move script_helper into the support package. Patch by Christie
Wilson.
@end itemize

@node Documentation<72>,Tools/Demos<45>,Tests<74>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id711}@anchor{1bc0}
@subsubsection Documentation



@itemize -

@item 
bpo-22155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22155}: Add File Handlers subsection with createfilehandler to tkinter
doc.  Remove obsolete example from FAQ.  Patch by Martin Panter.

@item 
bpo-24029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24029}: Document the name binding behavior for submodule imports.

@item 
bpo-24077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24077}: Fix typo in man page for -I command option: -s, not -S
@end itemize

@node Tools/Demos<45>,,Documentation<72>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id712}@anchor{1bc1}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-24000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24000}: Improved Argument Clinic’s mapping of converters to legacy
«format units». Updated the documentation to match.

@item 
bpo-24001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24001}: Argument Clinic converters now use accept=@{type@} instead of
types=@{“type”@} to specify the types the converter accepts.

@item 
bpo-23330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23330}: h2py now supports arbitrary filenames in #include.

@item 
bpo-24031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24031}: make patchcheck now supports git checkouts, too.
@end itemize

@node Python 3 5 0 alpha 4,Python 3 5 0 alpha 3,Python 3 5 0 beta 1,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-alpha-4}@anchor{1bc2}
@subsection Python 3.5.0 alpha 4


`Release date: 2015-04-19'

@menu
* Core and Builtins: Core and Builtins<87>. 
* Library: Library<87>. 
* Build: Build<80>. 
* Tests: Tests<75>. 
* Tools/Demos: Tools/Demos<46>. 
* C API: C API<64>. 

@end menu

@node Core and Builtins<87>,Library<87>,,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id713}@anchor{1bc3}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-22980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22980}: Under Linux, GNU/KFreeBSD and the Hurd, C extensions now
include the architecture triplet in the extension name, to make it easy to
test builds for different ABIs in the same working tree.  Under OS X, the
extension name now includes 
@geindex Python Enhancement Proposals; PEP 3149
PEP 3149@footnote{https://peps.python.org/pep-3149/}-style information.

@item 
bpo-22631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22631}: Added Linux-specific socket constant CAN_RAW_FD_FRAMES. Patch
courtesy of Joe Jevnik.

@item 
bpo-23731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23731}: Implement 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}: removal of .pyo files.

@item 
bpo-23726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23726}: Don’t enable GC for user subclasses of non-GC types that don’t
add any new fields.  Patch by Eugene Toder.

@item 
bpo-23309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23309}: Avoid a deadlock at shutdown if a daemon thread is aborted
while it is holding a lock to a buffered I/O object, and the main thread
tries to use the same I/O object (typically stdout or stderr).  A fatal
error is emitted instead.

@item 
bpo-22977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22977}: Fixed formatting Windows error messages on Wine. Patch by
Martin Panter.

@item 
bpo-23466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23466}: %c, %o, %x, and %X in bytes formatting now raise TypeError on
non-integer input.

@item 
bpo-24044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24044}: Fix possible null pointer dereference in list.sort in out of
memory conditions.

@item 
bpo-21354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21354}: PyCFunction_New function is exposed by python DLL again.
@end itemize

@node Library<87>,Build<80>,Core and Builtins<87>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id714}@anchor{1bc4}
@subsubsection Library



@itemize -

@item 
bpo-23840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23840}: tokenize.open() now closes the temporary binary file on error
to fix a resource warning.

@item 
bpo-16914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16914}: new debuglevel 2 in smtplib adds timestamps to debug output.

@item 
bpo-7159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7159}: urllib.request now supports sending auth credentials
automatically after the first 401.  This enhancement is a superset of the
enhancement from bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494} and supersedes that change.

@item 
bpo-23703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23703}: Fix a regression in urljoin() introduced in 901e4e52b20a. Patch
by Demian Brecht.

@item 
bpo-4254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4254}: Adds _curses.update_lines_cols().  Patch by Arnon Yaari

@item 
bpo-19933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19933}: Provide default argument for ndigits in round. Patch by
Vajrasky Kok.

@item 
bpo-23193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23193}: Add a numeric_owner parameter to tarfile.TarFile.extract and
tarfile.TarFile.extractall. Patch by Michael Vogt and Eric Smith.

@item 
bpo-23342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23342}: Add a subprocess.run() function than returns a CalledProcess
instance for a more consistent API than the existing call* functions.

@item 
bpo-21217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21217}: inspect.getsourcelines() now tries to compute the start and end
lines from the code object, fixing an issue when a lambda function is used
as decorator argument. Patch by Thomas Ballinger and Allison Kaptur.

@item 
bpo-24521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24521}: Fix possible integer overflows in the pickle module.

@item 
bpo-22931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22931}: Allow “[” and “]” in cookie values.

@item 
The keywords attribute of functools.partial is now always a dictionary.

@item 
bpo-23811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23811}: Add missing newline to the PyCompileError error message. Patch
by Alex Shkop.

@item 
bpo-21116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21116}: Avoid blowing memory when allocating a multiprocessing shared
array that’s larger than 50% of the available RAM.  Patch by Médéric
Boquien.

@item 
bpo-22982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22982}: Improve BOM handling when seeking to multiple positions of a
writable text file.

@item 
bpo-23464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23464}: Removed deprecated asyncio JoinableQueue.

@item 
bpo-23529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23529}: Limit the size of decompressed data when reading from GzipFile,
BZ2File or LZMAFile.  This defeats denial of service attacks using
compressed bombs (i.e. compressed payloads which decompress to a huge
size).  Patch by Martin Panter and Nikolaus Rath.

@item 
bpo-21859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21859}: Added Python implementation of io.FileIO.

@item 
bpo-23865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23865}: close() methods in multiple modules now are idempotent and more
robust at shutdown. If they need to release multiple resources, all are
released even if errors occur.

@item 
bpo-23400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23400}: Raise same exception on both Python 2 and 3 if sem_open is not
available. Patch by Davin Potts.

@item 
bpo-10838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10838}: The subprocess now module includes SubprocessError and
TimeoutError in its list of exported names for the users wild enough to
use @code{from subprocess import *}.

@item 
bpo-23411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23411}: Added DefragResult, ParseResult, SplitResult,
DefragResultBytes, ParseResultBytes, and SplitResultBytes to
urllib.parse.__all__. Patch by Martin Panter.

@item 
bpo-23881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23881}: urllib.request.ftpwrapper constructor now closes the socket if
the FTP connection failed to fix a ResourceWarning.

@item 
bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}: @ref{e2e,,socket.socket.sendall()} does no more reset the socket
timeout each time data is sent successfully. The socket timeout is now the
maximum total duration to send all data.

@item 
bpo-22721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22721}: An order of multiline pprint output of set or dict containing
orderable and non-orderable elements no longer depends on iteration order
of set or dict.

@item 
bpo-15133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15133}: _tkinter.tkapp.getboolean() now supports Tcl_Obj and always
returns bool. tkinter.BooleanVar now validates input values (accepted
bool, int, str, and Tcl_Obj).  tkinter.BooleanVar.get() now always returns
bool.

@item 
bpo-10590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10590}: xml.sax.parseString() now supports string argument.

@item 
bpo-23338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23338}: Fixed formatting ctypes error messages on Cygwin. Patch by
Makoto Kato.

@item 
bpo-15582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15582}: inspect.getdoc() now follows inheritance chains.

@item 
bpo-2175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2175}: SAX parsers now support a character stream of InputSource
object.

@item 
bpo-16840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16840}: Tkinter now supports 64-bit integers added in Tcl 8.4 and
arbitrary precision integers added in Tcl 8.5.

@item 
bpo-23834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23834}: Fix socket.sendto(), use the C Py_ssize_t type to store the
result of sendto() instead of the C int type.

@item 
bpo-23618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23618}: @ref{e29,,socket.socket.connect()} now waits until the connection
completes instead of raising @ref{e0e,,InterruptedError} if the connection is
interrupted by signals, signal handlers don’t raise an exception and the
socket is blocking or has a timeout. @ref{e29,,socket.socket.connect()} still
raise @ref{e0e,,InterruptedError} for non-blocking sockets.

@item 
bpo-21526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21526}: Tkinter now supports new boolean type in Tcl 8.5.

@item 
bpo-23836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23836}: Fix the faulthandler module to handle reentrant calls to its
signal handlers.

@item 
bpo-23838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23838}: linecache now clears the cache and returns an empty result on
MemoryError.

@item 
bpo-10395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10395}: Added os.path.commonpath(). Implemented in posixpath and
ntpath. Based on patch by Rafik Draoui.

@item 
bpo-23611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23611}: Serializing more «lookupable» objects (such as unbound methods
or nested classes) now are supported with pickle protocols < 4.

@item 
bpo-13583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13583}: sqlite3.Row now supports slice indexing.

@item 
bpo-18473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18473}: Fixed 2to3 and 3to2 compatible pickle mappings.  Fixed
ambiguous reverse mappings.  Added many new mappings.  Import mapping is
no longer applied to modules already mapped with full name mapping.

@item 
bpo-23485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23485}: select.select() is now retried automatically with the
recomputed timeout when interrupted by a signal, except if the signal
handler raises an exception. This change is part of the 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}.

@item 
bpo-23752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23752}: When built from an existing file descriptor, io.FileIO() now
only calls fstat() once. Before fstat() was called twice, which was not
necessary.

@item 
bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}: collections.deque() objects now support __add__, __mul__, and
__imul__().

@item 
bpo-23171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23171}: csv.Writer.writerow() now supports arbitrary iterables.

@item 
bpo-23745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23745}: The new email header parser now handles duplicate MIME
parameter names without error, similar to how get_param behaves.

@item 
bpo-22117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22117}: Fix os.utime(), it now rounds the timestamp towards minus
infinity (-inf) instead of rounding towards zero.

@item 
bpo-23310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23310}: Fix MagicMock’s initializer to work with __methods__, just like
configure_mock().  Patch by Kasia Jachim.
@end itemize

@node Build<80>,Tests<75>,Library<87>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id715}@anchor{1bc5}
@subsubsection Build



@itemize -

@item 
bpo-23817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23817}: FreeBSD now uses «1.0» in the SOVERSION as other operating
systems, instead of just «1».

@item 
bpo-23501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23501}: Argument Clinic now generates code into separate files by
default.
@end itemize

@node Tests<75>,Tools/Demos<46>,Build<80>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id716}@anchor{1bc6}
@subsubsection Tests



@itemize -

@item 
bpo-23799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23799}: Added test.support.start_threads() for running and cleaning up
multiple threads.

@item 
bpo-22390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22390}: test.regrtest now emits a warning if temporary files or
directories are left after running a test.
@end itemize

@node Tools/Demos<46>,C API<64>,Tests<75>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id717}@anchor{1bc7}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-18128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18128}: pygettext now uses standard +NNNN format in the
POT-Creation-Date header.

@item 
bpo-23935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23935}: Argument Clinic’s understanding of format units accepting
bytes, bytearrays, and buffers is now consistent with both the
documentation and the implementation.

@item 
bpo-23944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23944}: Argument Clinic now wraps long impl prototypes at column 78.

@item 
bpo-20586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20586}: Argument Clinic now ensures that functions without docstrings
have signatures.

@item 
bpo-23492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23492}: Argument Clinic now generates argument parsing code with
PyArg_Parse instead of PyArg_ParseTuple if possible.

@item 
bpo-23500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23500}: Argument Clinic is now smarter about generating the «#ifndef»
(empty) definition of the methoddef macro: it’s only generated once, even
if Argument Clinic processes the same symbol multiple times, and it’s
emitted at the end of all processing rather than immediately after the
first use.
@end itemize

@node C API<64>,,Tools/Demos<46>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id718}@anchor{1bc8}
@subsubsection C API



@itemize -

@item 
bpo-23998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23998}: PyImport_ReInitLock() now checks for lock allocation error
@end itemize

@node Python 3 5 0 alpha 3,Python 3 5 0 alpha 2,Python 3 5 0 alpha 4,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-alpha-3}@anchor{1bc9}
@subsection Python 3.5.0 alpha 3


`Release date: 2015-03-28'

@menu
* Core and Builtins: Core and Builtins<88>. 
* Library: Library<88>. 
* Build: Build<81>. 
* Tests: Tests<76>. 
* Tools/Demos: Tools/Demos<47>. 

@end menu

@node Core and Builtins<88>,Library<88>,,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id719}@anchor{1bca}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}: Increased performance of string search operations (str.find,
str.index, str.count, the in operator, str.split, str.partition) with
arguments of different kinds (UCS1, UCS2, UCS4).

@item 
bpo-23753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23753}: Python doesn’t support anymore platforms without stat() or
fstat(), these functions are always required.

@item 
bpo-23681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23681}: The -b option now affects comparisons of bytes with int.

@item 
bpo-23632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23632}: Memoryviews now allow tuple indexing (including for
multi-dimensional memoryviews).

@item 
bpo-23192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23192}: Fixed generator lambdas.  Patch by Bruno Cauet.

@item 
bpo-23629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23629}: Fix the default __sizeof__ implementation for variable-sized
objects.
@end itemize

@node Library<88>,Build<81>,Core and Builtins<88>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id720}@anchor{1bcb}
@subsubsection Library



@itemize -

@item 
bpo-14260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14260}: The groupindex attribute of regular expression pattern object
now is non-modifiable mapping.

@item 
bpo-23792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23792}: Ignore KeyboardInterrupt when the pydoc pager is active. This
mimics the behavior of the standard unix pagers, and prevents pipepager
from shutting down while the pager itself is still running.

@item 
bpo-23775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23775}: pprint() of OrderedDict now outputs the same representation as
repr().

@item 
bpo-23765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23765}: Removed IsBadStringPtr calls in ctypes

@item 
bpo-22364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22364}: Improved some re error messages using regex for hints.

@item 
bpo-23742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23742}: ntpath.expandvars() no longer loses unbalanced single quotes.

@item 
bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}: The zipfile.ZipFile.open function now supports “x” (exclusive
creation) mode.

@item 
bpo-21802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21802}: The reader in BufferedRWPair now is closed even when closing
writer failed in BufferedRWPair.close().

@item 
bpo-23622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23622}: Unknown escapes in regular expressions that consist of @code{'\'}
and ASCII letter now raise a deprecation warning and will be forbidden in
Python 3.6.

@item 
bpo-23671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23671}: string.Template now allows specifying the «self» parameter as a
keyword argument.  string.Formatter now allows specifying the «self» and
the «format_string» parameters as keyword arguments.

@item 
bpo-23502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23502}: The pprint module now supports mapping proxies.

@item 
bpo-17530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17530}: pprint now wraps long bytes objects and bytearrays.

@item 
bpo-22687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22687}: Fixed some corner cases in breaking words in tetxtwrap. Got rid
of quadratic complexity in breaking long words.

@item 
bpo-4727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4727}: The copy module now uses pickle protocol 4 (PEP 3154) and
supports copying of instances of classes whose __new__ method takes
keyword-only arguments.

@item 
bpo-23491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23491}: Added a zipapp module to support creating executable zip file
archives of Python code. Registered «.pyz» and «.pyzw» extensions on
Windows for these archives (PEP 441).

@item 
bpo-23657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23657}: Avoid explicit checks for str in zipapp, adding support for
pathlib.Path objects as arguments.

@item 
bpo-23688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23688}: Added support of arbitrary bytes-like objects and avoided
unnecessary copying of memoryview in gzip.GzipFile.write(). Original patch
by Wolfgang Maier.

@item 
bpo-23252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23252}: Added support for writing ZIP files to unseekable streams.

@item 
bpo-23647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23647}: Increase imaplib’s MAXLINE to accommodate modern mailbox sizes.

@item 
bpo-23539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23539}: If body is None, http.client.HTTPConnection.request now sets
Content-Length to 0 for PUT, POST, and PATCH headers to avoid 411 errors
from some web servers.

@item 
bpo-22351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22351}: The nntplib.NNTP constructor no longer leaves the connection
and socket open until the garbage collector cleans them up.  Patch by
Martin Panter.

@item 
bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}: collections.deque() objects now support methods for index(),
insert(), and copy().  This allows deques to be registered as a
MutableSequence and it improves their substitutability for lists.

@item 
bpo-23715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23715}: @ref{e31,,signal.sigwaitinfo()} and @ref{e30,,signal.sigtimedwait()} are
now retried when interrupted by a signal not in the `sigset' parameter, if
the signal handler does not raise an exception. signal.sigtimedwait()
recomputes the timeout with a monotonic clock when it is retried.

@item 
bpo-23001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23001}: Few functions in modules mmap, ossaudiodev, socket, ssl, and
codecs, that accepted only read-only bytes-like object now accept writable
bytes-like object too.

@item 
bpo-23646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23646}: If time.sleep() is interrupted by a signal, the sleep is now
retried with the recomputed delay, except if the signal handler raises an
exception (PEP 475).

@item 
bpo-23136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23136}: _strptime now uniformly handles all days in week 0, including
Dec 30 of previous year.  Based on patch by Jim Carroll.

@item 
bpo-23700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23700}: Iterator of NamedTemporaryFile now keeps a reference to
NamedTemporaryFile instance.  Patch by Bohuslav Kabrda.

@item 
bpo-22903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22903}: The fake test case created by unittest.loader when it fails
importing a test module is now picklable.

@item 
bpo-22181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22181}: On Linux, os.urandom() now uses the new getrandom() syscall if
available, syscall introduced in the Linux kernel 3.17. It is more
reliable and more secure, because it avoids the need of a file descriptor
and waits until the kernel has enough entropy.

@item 
bpo-2211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2211}: Updated the implementation of the http.cookies.Morsel class.
Setting attributes key, value and coded_value directly now is deprecated.
update() and setdefault() now transform and check keys.  Comparing for
equality now takes into account attributes key, value and coded_value.
copy() now returns a Morsel, not a dict.  repr() now contains all
attributes. Optimized checking keys and quoting values.  Added new tests.
Original patch by Demian Brecht.

@item 
bpo-18983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18983}: Allow selection of output units in timeit. Patch by Julian
Gindi.

@item 
bpo-23631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23631}: Fix traceback.format_list when a traceback has been mutated.

@item 
bpo-23568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23568}: Add rdivmod support to MagicMock() objects. Patch by Håkan
Lövdahl.

@item 
bpo-2052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2052}: Add charset parameter to HtmlDiff.make_file().

@item 
bpo-23668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23668}: Support os.truncate and os.ftruncate on Windows.

@item 
bpo-23138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23138}: Fixed parsing cookies with absent keys or values in cookiejar.
Patch by Demian Brecht.

@item 
bpo-23051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23051}: multiprocessing.Pool methods imap() and imap_unordered() now
handle exceptions raised by an iterator.  Patch by Alon Diamant and Davin
Potts.

@item 
bpo-23581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23581}: Add matmul support to MagicMock. Patch by Håkan Lövdahl.

@item 
bpo-23566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23566}: enable(), register(), dump_traceback() and
dump_traceback_later() functions of faulthandler now accept file
descriptors. Patch by Wei Wu.

@item 
bpo-22928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22928}: Disabled HTTP header injections in http.client. Original patch
by Demian Brecht.

@item 
bpo-23615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23615}: Modules bz2, tarfile and tokenize now can be reloaded with
imp.reload(). Patch by Thomas Kluyver.

@item 
bpo-23605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23605}: os.walk() now calls os.scandir() instead of os.listdir(). The
usage of os.scandir() reduces the number of calls to os.stat(). Initial
patch written by Ben Hoyt.
@end itemize

@node Build<81>,Tests<76>,Library<88>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id721}@anchor{1bcc}
@subsubsection Build



@itemize -

@item 
bpo-23585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23585}: make patchcheck will ensure the interpreter is built.
@end itemize

@node Tests<76>,Tools/Demos<47>,Build<81>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id722}@anchor{1bcd}
@subsubsection Tests



@itemize -

@item 
bpo-23583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23583}: Added tests for standard IO streams in IDLE.

@item 
bpo-22289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22289}: Prevent test_urllib2net failures due to ftp connection timeout.
@end itemize

@node Tools/Demos<47>,,Tests<76>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id723}@anchor{1bce}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-22826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22826}: The result of open() in Tools/freeze/bkfile.py is now better
compatible with regular files (in particular it now supports the context
management protocol).
@end itemize

@node Python 3 5 0 alpha 2,Python 3 5 0 alpha 1,Python 3 5 0 alpha 3,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-alpha-2}@anchor{1bcf}
@subsection Python 3.5.0 alpha 2


`Release date: 2015-03-09'

@menu
* Core and Builtins: Core and Builtins<89>. 
* Library: Library<89>. 
* Build: Build<82>. 
* C API: C API<65>. 
* Windows: Windows<70>. 

@end menu

@node Core and Builtins<89>,Library<89>,,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id724}@anchor{1bd0}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23571}: PyObject_Call() and PyCFunction_Call() now raise a SystemError
if a function returns a result and raises an exception. The SystemError is
chained to the previous exception.
@end itemize

@node Library<89>,Build<82>,Core and Builtins<89>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id725}@anchor{1bd1}
@subsubsection Library



@itemize -

@item 
bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524}: New os.scandir() function, part of the 
@geindex Python Enhancement Proposals; PEP 471
PEP 471@footnote{https://peps.python.org/pep-0471/}:
«os.scandir() function – a better and faster directory iterator». Patch
written by Ben Hoyt.

@item 
bpo-23103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23103}: Reduced the memory consumption of IPv4Address and IPv6Address.

@item 
bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}: BaseHTTPRequestHandler again logs response code as numeric, not
as stringified enum.  Patch by Demian Brecht.

@item 
bpo-23476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23476}: In the ssl module, enable OpenSSL’s X509_V_FLAG_TRUSTED_FIRST
flag on certificate stores when it is available.

@item 
bpo-23576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23576}: Avoid stalling in SSL reads when EOF has been reached in the
SSL layer but the underlying connection hasn’t been closed.

@item 
bpo-23504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23504}: Added an __all__ to the types module.

@item 
bpo-23563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23563}: Optimized utility functions in urllib.parse.

@item 
bpo-7830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7830}: Flatten nested functools.partial.

@item 
bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204}: Added the __module__ attribute to _tkinter classes.

@item 
bpo-19980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19980}: Improved help() for non-recognized strings.  help(“”) now shows
the help on str.  help(“help”) now shows the help on help(). Original
patch by Mark Lawrence.

@item 
bpo-23521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23521}: Corrected pure python implementation of timedelta division.
Eliminated OverflowError from @code{timedelta * float} for some floats;
Corrected rounding in timedelta true division.

@item 
bpo-21619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21619}: Popen objects no longer leave a zombie after exit in the with
statement if the pipe was broken.  Patch by Martin Panter.

@item 
bpo-22936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22936}: Make it possible to show local variables in tracebacks for both
the traceback module and unittest.

@item 
bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}: Add an option to limit the output size in bz2.decompress().
Patch by Nikolaus Rath.

@item 
bpo-6639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6639}: Module-level turtle functions no longer raise TclError after
closing the window.

@item 
bpo-814253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=814253}: Group references and conditional group references now work in
lookbehind assertions in regular expressions. (See also: bpo-9179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9179})

@item 
bpo-23215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23215}: Multibyte codecs with custom error handlers that ignores errors
consumed too much memory and raised SystemError or MemoryError. Original
patch by Aleksi Torhamo.

@item 
bpo-5700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5700}: io.FileIO() called flush() after closing the file. flush() was
not called in close() if closefd=False.

@item 
bpo-23374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23374}: Fixed pydoc failure with non-ASCII files when stdout encoding
differs from file system encoding (e.g. on Mac OS).

@item 
bpo-23481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23481}: Remove RC4 from the SSL module’s default cipher list.

@item 
bpo-21548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21548}: Fix pydoc.synopsis() and pydoc.apropos() on modules with empty
docstrings.

@item 
bpo-22885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22885}: Fixed arbitrary code execution vulnerability in the dbm.dumb
module. Original patch by Claudiu Popa.

@item 
bpo-23239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23239}: ssl.match_hostname() now supports matching of IP addresses.

@item 
bpo-23146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23146}: Fix mishandling of absolute Windows paths with forward slashes
in pathlib.

@item 
bpo-23096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23096}: Pickle representation of floats with protocol 0 now is the same
for both Python and C implementations.

@item 
bpo-19105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19105}: pprint now more efficiently uses free space at the right.

@item 
bpo-14910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14910}: Add allow_abbrev parameter to argparse.ArgumentParser. Patch by
Jonathan Paugh, Steven Bethard, paul j3 and Daniel Eriksson.

@item 
bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}: tarfile.open() now supports “x” (exclusive creation) mode.

@item 
bpo-23344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23344}: marshal.dumps() is now 20-25% faster on average.

@item 
bpo-20416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20416}: marshal.dumps() with protocols 3 and 4 is now 40-50% faster on
average.

@item 
bpo-23421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23421}: Fixed compression in tarfile CLI.  Patch by wdv4758h.

@item 
bpo-23367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23367}: Fix possible overflows in the unicodedata module.

@item 
bpo-23361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23361}: Fix possible overflow in Windows subprocess creation code.

@item 
logging.handlers.QueueListener now takes a respect_handler_level keyword
argument which, if set to True, will pass messages to handlers taking
handler levels into account.

@item 
bpo-19705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19705}: turtledemo now has a visual sorting algorithm demo.  Original
patch from Jason Yeo.

@item 
bpo-23801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23801}: Fix issue where cgi.FieldStorage did not always ignore the
entire preamble to a multipart body.
@end itemize

@node Build<82>,C API<65>,Library<89>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id726}@anchor{1bd2}
@subsubsection Build



@itemize -

@item 
bpo-23445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23445}: pydebug builds now use «gcc -Og» where possible, to make the
resulting executable faster.

@item 
bpo-23686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23686}: Update OS X 10.5 installer build to use OpenSSL 1.0.2a.
@end itemize

@node C API<65>,Windows<70>,Build<82>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id727}@anchor{1bd3}
@subsubsection C API



@itemize -

@item 
bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204}: Deprecation warning is now raised for builtin types without the
__module__ attribute.
@end itemize

@node Windows<70>,,C API<65>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id728}@anchor{1bd4}
@subsubsection Windows



@itemize -

@item 
bpo-23465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23465}: Implement 
@geindex Python Enhancement Proposals; PEP 486
PEP 486@footnote{https://peps.python.org/pep-0486/} - Make the Python Launcher aware of
virtual environments. Patch by Paul Moore.

@item 
bpo-23437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23437}: Make user scripts directory versioned on Windows. Patch by Paul
Moore.
@end itemize

@node Python 3 5 0 alpha 1,,Python 3 5 0 alpha 2,Registro de cambios
@anchor{whatsnew/changelog python-3-5-0-alpha-1}@anchor{1bd5}
@subsection Python 3.5.0 alpha 1


`Release date: 2015-02-08'

@menu
* Core and Builtins: Core and Builtins<90>. 
* Library: Library<90>. 
* IDLE: IDLE<59>. 
* Build: Build<83>. 
* C API: C API<66>. 
* Documentation: Documentation<73>. 
* Tests: Tests<77>. 
* Tools/Demos: Tools/Demos<48>. 
* Windows: Windows<71>. 

@end menu

@node Core and Builtins<90>,Library<90>,,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id729}@anchor{1bd6}
@subsubsection Core and Builtins



@itemize -

@item 
bpo-23285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23285}: PEP 475 - EINTR handling.

@item 
bpo-22735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22735}: Fix many edge cases (including crashes) involving custom mro()
implementations.

@item 
bpo-22896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22896}: Avoid using PyObject_AsCharBuffer(), PyObject_AsReadBuffer()
and PyObject_AsWriteBuffer().

@item 
bpo-21295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21295}: Revert some changes (bpo-16795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16795}) to AST line numbers and
column offsets that constituted a regression.

@item 
bpo-22986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22986}: Allow changing an object’s __class__ between a dynamic type and
static type in some cases.

@item 
bpo-15859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15859}: PyUnicode_EncodeFSDefault(), PyUnicode_EncodeMBCS() and
PyUnicode_EncodeCodePage() now raise an exception if the object is not a
Unicode object. For PyUnicode_EncodeFSDefault(), it was already the case
on platforms other than Windows. Patch written by Campbell Barton.

@item 
bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408}: The default __ne__() now returns NotImplemented if __eq__()
returned NotImplemented.  Original patch by Martin Panter.

@item 
bpo-23321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23321}: Fixed a crash in str.decode() when error handler returned
replacement string longer than malformed input data.

@item 
bpo-22286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22286}: The «backslashreplace» error handlers now works with decoding
and translating.

@item 
bpo-23253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23253}: Delay-load ShellExecute[AW] in os.startfile for reduced startup
overhead on Windows.

@item 
bpo-22038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22038}: pyatomic.h now uses stdatomic.h or GCC built-in functions for
atomic memory access if available. Patch written by Vitor de Lima and
Gustavo Temple.

@item 
bpo-20284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20284}: %-interpolation (aka printf) formatting added for bytes and
bytearray.

@item 
bpo-23048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23048}: Fix jumping out of an infinite while loop in the pdb.

@item 
bpo-20335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20335}: bytes constructor now raises TypeError when encoding or errors
is specified with non-string argument.  Based on patch by Renaud Blanch.

@item 
bpo-22834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22834}: If the current working directory ends up being set to a
non-existent directory then import will no longer raise FileNotFoundError.

@item 
bpo-22869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22869}: Move the interpreter startup & shutdown code to a new dedicated
pylifecycle.c module

@item 
bpo-22847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22847}: Improve method cache efficiency.

@item 
bpo-22335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22335}: Fix crash when trying to enlarge a bytearray to 0x7fffffff
bytes on a 32-bit platform.

@item 
bpo-22653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22653}: Fix an assertion failure in debug mode when doing a reentrant
dict insertion in debug mode.

@item 
bpo-22643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22643}: Fix integer overflow in Unicode case operations (upper, lower,
title, swapcase, casefold).

@item 
bpo-17636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17636}: Circular imports involving relative imports are now supported.

@item 
bpo-22604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22604}: Fix assertion error in debug mode when dividing a complex
number by (nan+0j).

@item 
bpo-21052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21052}: Do not raise ImportWarning when sys.path_hooks or sys.meta_path
are set to None.

@item 
bpo-16518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16518}: Use “bytes-like object required” in error messages that
previously used the far more cryptic «“x” does not support the buffer
protocol.

@item 
bpo-22470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22470}: Fixed integer overflow issues in «backslashreplace»,
«xmlcharrefreplace», and «surrogatepass» error handlers.

@item 
bpo-22540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22540}: speed up @code{PyObject_IsInstance} and @code{PyObject_IsSubclass} in
the common case that the second argument has metaclass @code{type}.

@item 
bpo-18711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18711}: Add a new @code{PyErr_FormatV} function, similar to
@code{PyErr_Format} but accepting a @code{va_list} argument.

@item 
bpo-22520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22520}: Fix overflow checking when generating the repr of a unicode
object.

@item 
bpo-22519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22519}: Fix overflow checking in PyBytes_Repr.

@item 
bpo-22518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22518}: Fix integer overflow issues in latin-1 encoding.

@item 
bpo-16324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16324}: _charset parameter of MIMEText now also accepts
email.charset.Charset instances. Initial patch by Claude Paroz.

@item 
bpo-1764286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1764286}: Fix inspect.getsource() to support decorated functions. Patch
by Claudiu Popa.

@item 
bpo-18554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18554}: os.__all__ includes posix functions.

@item 
bpo-21391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21391}: Use os.path.abspath in the shutil module.

@item 
bpo-11471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11471}: avoid generating a JUMP_FORWARD instruction at the end of an
if-block if there is no else-clause.  Original patch by Eugene Toder.

@item 
bpo-22215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22215}: Now ValueError is raised instead of TypeError when str or bytes
argument contains not permitted null character or byte.

@item 
bpo-22258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22258}: Fix the internal function set_inheritable() on Illumos. This
platform exposes the function @code{ioctl(FIOCLEX)}, but calling it fails
with errno is ENOTTY: «Inappropriate ioctl for device». set_inheritable()
now falls back to the slower @code{fcntl()} (@code{F_GETFD} and then
@code{F_SETFD}).

@item 
bpo-21389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21389}: Displaying the __qualname__ of the underlying function in the
repr of a bound method.

@item 
bpo-22206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22206}: Using pthread, PyThread_create_key() now sets errno to ENOMEM
and returns -1 (error) on integer overflow.

@item 
bpo-20184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20184}: Argument Clinic based signature introspection added for 30 of
the builtin functions.

@item 
bpo-22116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22116}: C functions and methods (of the “builtin_function_or_method”
type) can now be weakref’ed.  Patch by Wei Wu.

@item 
bpo-22077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22077}: Improve index error messages for bytearrays, bytes, lists, and
tuples by adding “or slices”. Added “, not <typename>” for bytearrays.
Original patch by Claudiu Popa.

@item 
bpo-20179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20179}: Apply Argument Clinic to bytes and bytearray. Patch by Tal
Einat.

@item 
bpo-22082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22082}: Clear interned strings in slotdefs.

@item 
Upgrade Unicode database to Unicode 7.0.0.

@item 
bpo-21897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21897}: Fix a crash with the f_locals attribute with closure variables
when frame.clear() has been called.

@item 
bpo-21205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21205}: Add a new @code{__qualname__} attribute to generator, the
qualified name, and use it in the representation of a generator
(@code{repr(gen)}). The default name of the generator (@code{__name__}
attribute) is now get from the function instead of the code. Use
@code{gen.gi_code.co_name} to get the name of the code.

@item 
bpo-21669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21669}: With the aid of heuristics in SyntaxError.__init__, the parser
now attempts to generate more meaningful (or at least more search engine
friendly) error messages when «exec» and «print» are used as statements.

@item 
bpo-21642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21642}: In the conditional if-else expression, allow an integer written
with no space between itself and the @code{else} keyword (e.g. @code{True if
42else False}) to be valid syntax.

@item 
bpo-21523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21523}: Fix over-pessimistic computation of the stack effect of some
opcodes in the compiler.  This also fixes a quadratic compilation time
issue noticeable when compiling code with a large number of «and» and «or»
operators.

@item 
bpo-21418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21418}: Fix a crash in the builtin function super() when called without
argument and without current frame (ex: embedded Python).

@item 
bpo-21425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21425}: Fix flushing of standard streams in the interactive
interpreter.

@item 
bpo-21435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21435}: In rare cases, when running finalizers on objects in cyclic
trash a bad pointer dereference could occur due to a subtle flaw in
internal iteration logic.

@item 
bpo-21377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21377}: PyBytes_Concat() now tries to concatenate in-place when the
first argument has a reference count of 1.  Patch by Nikolaus Rath.

@item 
bpo-20355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20355}: -W command line options now have higher priority than the
PYTHONWARNINGS environment variable.  Patch by Arfrever.

@item 
bpo-21274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21274}: Define PATH_MAX for GNU/Hurd in Python/pythonrun.c.

@item 
bpo-20904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20904}: Support setting FPU precision on m68k.

@item 
bpo-21209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21209}: Fix sending tuples to custom generator objects with the yield
from syntax.

@item 
bpo-21193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21193}: pow(a, b, c) now raises ValueError rather than TypeError when b
is negative. Patch by Josh Rosenberg.

@item 
bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}: PEP 465: Add the “@@” operator for matrix multiplication.

@item 
bpo-21134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21134}: Fix segfault when str is called on an uninitialized
UnicodeEncodeError, UnicodeDecodeError, or UnicodeTranslateError object.

@item 
bpo-19537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19537}: Fix PyUnicode_DATA() alignment under m68k.  Patch by Andreas
Schwab.

@item 
bpo-20929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20929}: Add a type cast to avoid shifting a negative number.

@item 
bpo-20731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20731}: Properly position in source code files even if they are opened
in text mode. Patch by Serhiy Storchaka.

@item 
bpo-20637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20637}: Key-sharing now also works for instance dictionaries of
subclasses.  Patch by Peter Ingebretson.

@item 
bpo-8297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8297}: Attributes missing from modules now include the module name in
the error text.  Original patch by ysj.ray.

@item 
bpo-19995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19995}: %c, %o, %x, and %X now raise TypeError on non-integer input.

@item 
bpo-19655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19655}: The ASDL parser - used by the build process to generate code
for managing the Python AST in C - was rewritten. The new parser is self
contained and does not require to carry long the spark.py parser-generator
library; spark.py was removed from the source base.

@item 
bpo-12546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12546}: Allow @code{\x00} to be used as a fill character when using str,
int, float, and complex __format__ methods.

@item 
bpo-20480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20480}: Add ipaddress.reverse_pointer. Patch by Leon Weber.

@item 
bpo-13598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13598}: Modify string.Formatter to support auto-numbering of
replacement fields. It now matches the behavior of str.format() in this
regard. Patches by Phil Elson and Ramchandra Apte.

@item 
bpo-8931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8931}: Make alternate formatting (“#”) for type “c” raise an exception.
In versions prior to 3.5, “#” with “c” had no effect. Now specifying it is
an error. Patch by Torsten Landschoff.

@item 
bpo-23165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23165}: Perform overflow checks before allocating memory in the
_Py_char2wchar function.
@end itemize

@node Library<90>,IDLE<59>,Core and Builtins<90>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id730}@anchor{1bd7}
@subsubsection Library



@itemize -

@item 
bpo-23399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23399}: pyvenv creates relative symlinks where possible.

@item 
bpo-20289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20289}: cgi.FieldStorage() now supports the context management
protocol.

@item 
bpo-13128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13128}: Print response headers for CONNECT requests when debuglevel >
0. Patch by Demian Brecht.

@item 
bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381}: Optimized io.BytesIO to make less allocations and copyings.

@item 
bpo-22818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22818}: Splitting on a pattern that could match an empty string now
raises a warning.  Patterns that can only match empty strings are now
rejected.

@item 
bpo-23099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23099}: Closing io.BytesIO with exported buffer is rejected now to
prevent corrupting exported buffer.

@item 
bpo-23326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23326}: Removed __ne__ implementations.  Since fixing default __ne__
implementation in bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408} they are redundant.

@item 
bpo-23363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23363}: Fix possible overflow in itertools.permutations.

@item 
bpo-23364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23364}: Fix possible overflow in itertools.product.

@item 
bpo-23366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23366}: Fixed possible integer overflow in itertools.combinations.

@item 
bpo-23369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23369}: Fixed possible integer overflow in
_json.encode_basestring_ascii.

@item 
bpo-23353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23353}: Fix the exception handling of generators in
PyEval_EvalFrameEx(). At entry, save or swap the exception state even if
PyEval_EvalFrameEx() is called with throwflag=0. At exit, the exception
state is now always restored or swapped, not only if why is WHY_YIELD or
WHY_RETURN. Patch co-written with Antoine Pitrou.

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: Restored support of writing ZIP files to tellable but
non-seekable streams.

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: Writing to ZipFile and reading multiple ZipExtFiles is
threadsafe now.

@item 
bpo-19361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19361}: JSON decoder now raises JSONDecodeError instead of ValueError.

@item 
bpo-18518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18518}: timeit now rejects statements which can’t be compiled outside a
function or a loop (e.g. «return» or «break»).

@item 
bpo-23094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23094}: Fixed readline with frames in Python implementation of pickle.

@item 
bpo-23268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23268}: Fixed bugs in the comparison of ipaddress classes.

@item 
bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408}: Removed incorrect implementations of __ne__() which didn’t
returned NotImplemented if __eq__() returned NotImplemented.  The default
__ne__() now works correctly.

@item 
bpo-19996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19996}: @code{email.feedparser.FeedParser} now handles (malformed)
headers with no key rather than assuming the body has started.

@item 
bpo-20188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20188}: Support Application-Layer Protocol Negotiation (ALPN) in the
ssl module.

@item 
bpo-23133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23133}: Pickling of ipaddress objects now produces more compact and
portable representation.

@item 
bpo-23248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23248}: Update ssl error codes from latest OpenSSL git master.

@item 
bpo-23266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23266}: Much faster implementation of ipaddress.collapse_addresses()
when there are many non-consecutive addresses.

@item 
bpo-23098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23098}: 64-bit dev_t is now supported in the os module.

@item 
bpo-21817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21817}: When an exception is raised in a task submitted to a
ProcessPoolExecutor, the remote traceback is now displayed in the parent
process.  Patch by Claudiu Popa.

@item 
bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}: Add an option to limit output size when decompressing LZMA
data.  Patch by Nikolaus Rath and Martin Panter.

@item 
bpo-23250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23250}: In the http.cookies module, capitalize «HttpOnly» and «Secure»
as they are written in the standard.

@item 
bpo-23063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23063}: In the distutils” check command, fix parsing of reST with code
or code-block directives.

@item 
bpo-23209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23209}: selectors.BaseSelector.get_key() now raises a RuntimeError if
the selector is closed. And selectors.BaseSelector.close() now clears its
internal reference to the selector mapping to break a reference cycle.
Initial patch written by Martin Richard. (See also: bpo-23225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23225})

@item 
bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}: Provide a way to seed the linecache for a PEP-302 module
without actually loading the code.

@item 
bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}: Provide a new object API for traceback, including the ability
to not lookup lines at all until the traceback is actually rendered,
without any trace of the original objects being kept alive.

@item 
bpo-19777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19777}: Provide a home() classmethod on Path objects.  Contributed by
Victor Salgado and Mayank Tripathi.

@item 
bpo-23206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23206}: Make @code{json.dumps(..., ensure_ascii=False)} as fast as the
default case of @code{ensure_ascii=True}.  Patch by Naoki Inada.

@item 
bpo-23185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23185}: Add math.inf and math.nan constants.

@item 
bpo-23186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23186}: Add ssl.SSLObject.shared_ciphers() and
ssl.SSLSocket.shared_ciphers() to fetch the client’s list ciphers sent at
handshake.

@item 
bpo-23143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23143}: Remove compatibility with OpenSSLs older than 0.9.8.

@item 
bpo-23132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23132}: Improve performance and introspection support of comparison
methods created by functool.total_ordering.

@item 
bpo-19776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19776}: Add an expanduser() method on Path objects.

@item 
bpo-23112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23112}: Fix SimpleHTTPServer to correctly carry the query string and
fragment when it redirects to add a trailing slash.

@item 
bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}: Added http.HTTPStatus enums (i.e. HTTPStatus.OK,
HTTPStatus.NOT_FOUND). Patch by Demian Brecht.

@item 
bpo-23093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23093}: In the io, module allow more operations to work on detached
streams.

@item 
bpo-23111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23111}: In the ftplib, make ssl.PROTOCOL_SSLv23 the default protocol
version.

@item 
bpo-22585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22585}: On OpenBSD 5.6 and newer, os.urandom() now calls getentropy(),
instead of reading /dev/urandom, to get pseudo-random bytes.

@item 
bpo-19104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19104}: pprint now produces evaluable output for wrapped strings.

@item 
bpo-23071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23071}: Added missing names to codecs.__all__.  Patch by Martin Panter.

@item 
bpo-22783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22783}: Pickling now uses the NEWOBJ opcode instead of the NEWOBJ_EX
opcode if possible.

@item 
bpo-15513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15513}: Added a __sizeof__ implementation for pickle classes.

@item 
bpo-19858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19858}: pickletools.optimize() now aware of the MEMOIZE opcode, can
produce more compact result and no longer produces invalid output if input
data contains MEMOIZE opcodes together with PUT or BINPUT opcodes.

@item 
bpo-22095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22095}: Fixed HTTPConnection.set_tunnel with default port.  The port
value in the host header was set to «None».  Patch by Demian Brecht.

@item 
bpo-23016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23016}: A warning no longer produces an AttributeError when the program
is run with pythonw.exe.

@item 
bpo-21775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21775}: shutil.copytree(): fix crash when copying to VFAT. An exception
handler assumed that OSError objects always have a “winerror” attribute.
That is not the case, so the exception handler itself raised
AttributeError when run on Linux (and, presumably, any other non-Windows
OS). Patch by Greg Ward.

@item 
bpo-1218234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1218234}: Fix inspect.getsource() to load updated source of reloaded
module. Initial patch by Berker Peksag.

@item 
bpo-21740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21740}: Support wrapped callables in doctest. Patch by Claudiu Popa.

@item 
bpo-23009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23009}: Make sure selectors.EpollSelector.select() works when no FD is
registered.

@item 
bpo-22959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22959}: In the constructor of http.client.HTTPSConnection, prefer the
context’s check_hostname attribute over the `check_hostname' parameter.

@item 
bpo-22696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22696}: Add function @ref{ef5,,sys.is_finalizing()} to know about
interpreter shutdown.

@item 
bpo-16043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16043}: Add a default limit for the amount of data
xmlrpclib.gzip_decode will return. This resolves 
@geindex Common Vulnerabilities and Exposures; CVE 2013-1753
CVE 2013-1753@footnote{https://www.cve.org/CVERecord?id=CVE-2013-1753}.

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: ZipFile.open() no longer reopen the underlying file.  Objects
returned by ZipFile.open() can now operate independently of the ZipFile
even if the ZipFile was created by passing in a file-like object as the
first argument to the constructor.

@item 
bpo-22966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22966}: Fix __pycache__ pyc file name clobber when pyc_compile is asked
to compile a source file containing multiple dots in the source file name.

@item 
bpo-21971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21971}: Update turtledemo doc and add module to the index.

@item 
bpo-21032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21032}: Fixed socket leak if HTTPConnection.getresponse() fails.
Original patch by Martin Panter.

@item 
bpo-22407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22407}: Deprecated the use of re.LOCALE flag with str patterns or
re.ASCII. It was newer worked.

@item 
bpo-22902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22902}: The «ip» command is now used on Linux to determine MAC address
in uuid.getnode().  Patch by Bruno Cauet.

@item 
bpo-22960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22960}: Add a context argument to xmlrpclib.ServerProxy constructor.

@item 
bpo-22389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22389}: Add contextlib.redirect_stderr().

@item 
bpo-21356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21356}: Make ssl.RAND_egd() optional to support LibreSSL. The
availability of the function is checked during the compilation. Patch
written by Bernard Spil.

@item 
bpo-22915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22915}: SAX parser now supports files opened with file descriptor or
bytes path.

@item 
bpo-22609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22609}: Constructors and update methods of mapping classes in the
collections module now accept the self keyword argument.

@item 
bpo-22940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22940}: Add readline.append_history_file.

@item 
bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676}: Added the «namereplace» error handler.

@item 
bpo-22788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22788}: Add `context' parameter to logging.handlers.HTTPHandler.

@item 
bpo-22921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22921}: Allow SSLContext to take the `hostname' parameter even if
OpenSSL doesn’t support SNI.

@item 
bpo-22894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22894}: TestCase.subTest() would cause the test suite to be stopped
when in failfast mode, even in the absence of failures.

@item 
bpo-22796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22796}: HTTP cookie parsing is now stricter, in order to protect
against potential injection attacks.

@item 
bpo-22370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22370}: Windows detection in pathlib is now more robust.

@item 
bpo-22841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22841}: Reject coroutines in asyncio add_signal_handler(). Patch by
Ludovic.Gasc.

@item 
bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494}: Added urllib.request.HTTPBasicPriorAuthHandler. Patch by Matej
Cepl.

@item 
bpo-22578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22578}: Added attributes to the re.error class.

@item 
bpo-22849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22849}: Fix possible double free in the io.TextIOWrapper constructor.

@item 
bpo-12728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12728}: Different Unicode characters having the same uppercase but
different lowercase are now matched in case-insensitive regular
expressions.

@item 
bpo-22821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22821}: Fixed fcntl() with integer argument on 64-bit big-endian
platforms.

@item 
bpo-21650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21650}: Add an @code{--sort-keys} option to @code{json.tool} CLI.

@item 
bpo-22824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22824}: Updated reprlib output format for sets to use set literals.
Patch contributed by Berker Peksag.

@item 
bpo-22824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22824}: Updated reprlib output format for arrays to display empty
arrays without an unnecessary empty list.  Suggested by Serhiy Storchaka.

@item 
bpo-22406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22406}: Fixed the uu_codec codec incorrectly ported to 3.x. Based on
patch by Martin Panter.

@item 
bpo-17293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17293}: uuid.getnode() now determines MAC address on AIX using netstat.
Based on patch by Aivars Kalvāns.

@item 
bpo-22769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22769}: Fixed ttk.Treeview.tag_has() when called without arguments.

@item 
bpo-22417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22417}: Verify certificates by default in httplib (PEP 476).

@item 
bpo-22775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22775}: Fixed unpickling of http.cookies.SimpleCookie with protocol 2
and above. Patch by Tim Graham.

@item 
bpo-22776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22776}: Brought excluded code into the scope of a try block in
SysLogHandler.emit().

@item 
bpo-22665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22665}: Add missing get_terminal_size and SameFileError to
shutil.__all__.

@item 
bpo-6623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6623}: Remove deprecated Netrc class in the ftplib module. Patch by
Matt Chaput.

@item 
bpo-17381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17381}: Fixed handling of case-insensitive ranges in regular
expressions.

@item 
bpo-22410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22410}: Module level functions in the re module now cache compiled
locale-dependent regular expressions taking into account the locale.

@item 
bpo-22759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22759}: Query methods on pathlib.Path() (exists(), is_dir(), etc.) now
return False when the underlying stat call raises NotADirectoryError.

@item 
bpo-8876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8876}: distutils now falls back to copying files when hard linking
doesn’t work. This allows use with special filesystems such as VirtualBox
shared folders.

@item 
bpo-22217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22217}: Implemented reprs of classes in the zipfile module.

@item 
bpo-22457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22457}: Honour load_tests in the start_dir of discovery.

@item 
bpo-18216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18216}: gettext now raises an error when a .mo file has an unsupported
major version number.  Patch by Aaron Hill.

@item 
bpo-13918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13918}: Provide a locale.delocalize() function which can remove
locale-specific number formatting from a string representing a number,
without then converting it to a specific type.  Patch by Cédric Krier.

@item 
bpo-22676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22676}: Make the pickling of global objects which don’t have a
__module__ attribute less slow.

@item 
bpo-18853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18853}: Fixed ResourceWarning in shlex.__nain__.

@item 
bpo-9351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9351}: Defaults set with set_defaults on an argparse subparser are no
longer ignored when also set on the parent parser.

@item 
bpo-7559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7559}: unittest test loading ImportErrors are reported as import errors
with their import exception rather than as attribute errors after the
import has already failed.

@item 
bpo-19746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19746}: Make it possible to examine the errors from unittest discovery
without executing the test suite. The new @code{errors} attribute on
@code{TestLoader} exposes these non-fatal errors encountered during
discovery.

@item 
bpo-21991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21991}: Make email.headerregistry’s header “params” attributes be
read-only (MappingProxyType).  Previously the dictionary was modifiable
but a new one was created on each access of the attribute.

@item 
bpo-22638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22638}: SSLv3 is now disabled throughout the standard library. It can
still be enabled by instantiating a SSLContext manually.

@item 
bpo-22641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22641}: In asyncio, the default SSL context for client connections is
now created using ssl.create_default_context(), for stronger security.

@item 
bpo-17401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17401}: Include closefd in io.FileIO repr.

@item 
bpo-21338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21338}: Add silent mode for compileall. quiet parameters of
compile_@{dir, file, path@} functions now have a multilevel value. Also, -q
option of the CLI now have a multilevel value. Patch by Thomas Kluyver.

@item 
bpo-20152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20152}: Convert the array and cmath modules to Argument Clinic.

@item 
bpo-18643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18643}: Add socket.socketpair() on Windows.

@item 
bpo-22435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22435}: Fix a file descriptor leak when socketserver bind fails.

@item 
bpo-13096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13096}: Fixed segfault in CTypes POINTER handling of large values.

@item 
bpo-11694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11694}: Raise ConversionError in xdrlib as documented.  Patch by Filip
Gruszczyński and Claudiu Popa.

@item 
bpo-19380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19380}: Optimized parsing of regular expressions.

@item 
bpo-1519638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1519638}: Now unmatched groups are replaced with empty strings in
re.sub() and re.subn().

@item 
bpo-18615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18615}: sndhdr.what/whathdr now return a namedtuple.

@item 
bpo-22462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22462}: Fix pyexpat’s creation of a dummy frame to make it appear in
exception tracebacks.

@item 
bpo-21965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21965}: Add support for in-memory SSL to the ssl module.  Patch by
Geert Jansen.

@item 
bpo-21173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21173}: Fix len() on a WeakKeyDictionary when .clear() was called with
an iterator alive.

@item 
bpo-11866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11866}: Eliminated race condition in the computation of names for new
threads.

@item 
bpo-21905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21905}: Avoid RuntimeError in pickle.whichmodule() when sys.modules is
mutated while iterating.  Patch by Olivier Grisel.

@item 
bpo-11271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11271}: concurrent.futures.Executor.map() now takes a `chunksize'
argument to allow batching of tasks in child processes and improve
performance of ProcessPoolExecutor.  Patch by Dan O’Reilly.

@item 
bpo-21883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21883}: os.path.join() and os.path.relpath() now raise a TypeError with
more helpful error message for unsupported or mismatched types of
arguments.

@item 
bpo-22219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22219}: The zipfile module CLI now adds entries for directories
(including empty directories) in ZIP file.

@item 
bpo-22449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22449}: In the ssl.SSLContext.load_default_certs, consult the
environmental variables SSL_CERT_DIR and SSL_CERT_FILE on Windows.

@item 
bpo-22508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22508}: The email.__version__ variable has been removed; the email code
is no longer shipped separately from the stdlib, and __version__ hasn’t
been updated in several releases.

@item 
bpo-20076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20076}: Added non derived UTF-8 aliases to locale aliases table.

@item 
bpo-20079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20079}: Added locales supported in glibc 2.18 to locale alias table.

@item 
bpo-20218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20218}: Added convenience methods read_text/write_text and read_bytes/
write_bytes to pathlib.Path objects.

@item 
bpo-22396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22396}: On 32-bit AIX platform, don’t expose os.posix_fadvise() nor
os.posix_fallocate() because their prototypes in system headers are wrong.

@item 
bpo-22517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22517}: When an io.BufferedRWPair object is deallocated, clear its
weakrefs.

@item 
bpo-22437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22437}: Number of capturing groups in regular expression is no longer
limited by 100.

@item 
bpo-17442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17442}: InteractiveInterpreter now displays the full chained traceback
in its showtraceback method, to match the built in interactive
interpreter.

@item 
bpo-23392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23392}: Added tests for marshal C API that works with FILE*.

@item 
bpo-10510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10510}: distutils register and upload methods now use HTML standards
compliant CRLF line endings.

@item 
bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}: Fixed macpath.join() for empty first component.  Patch by Oleg
Oshmyan.

@item 
bpo-5309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5309}: distutils” build and build_ext commands now accept a @code{-j}
option to enable parallel building of extension modules.

@item 
bpo-22448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22448}: Improve canceled timer handles cleanup to prevent unbound
memory usage. Patch by Joshua Moore-Oliva.

@item 
bpo-22427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22427}: TemporaryDirectory no longer attempts to clean up twice when
used in the with statement in generator.

@item 
bpo-22362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22362}: Forbidden ambiguous octal escapes out of range 0-0o377 in
regular expressions.

@item 
bpo-20912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20912}: Now directories added to ZIP file have correct Unix and MS-DOS
directory attributes.

@item 
bpo-21866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21866}: ZipFile.close() no longer writes ZIP64 central directory
records if allowZip64 is false.

@item 
bpo-22278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22278}: Fix urljoin problem with relative urls, a regression observed
after changes to issue22118 were submitted.

@item 
bpo-22415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22415}: Fixed debugging output of the GROUPREF_EXISTS opcode in the re
module. Removed trailing spaces in debugging output.

@item 
bpo-22423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22423}: Unhandled exception in thread no longer causes unhandled
AttributeError when sys.stderr is None.

@item 
bpo-21332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21332}: Ensure that @code{bufsize=1} in subprocess.Popen() selects line
buffering, rather than block buffering.  Patch by Akira Li.

@item 
bpo-21091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21091}: Fix API bug: email.message.EmailMessage.is_attachment is now a
method.

@item 
bpo-21079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21079}: Fix email.message.EmailMessage.is_attachment to return the
correct result when the header has parameters as well as a value.

@item 
bpo-22247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22247}: Add NNTPError to nntplib.__all__.

@item 
bpo-22366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22366}: urllib.request.urlopen will accept a context object
(SSLContext) as an argument which will then be used for HTTPS connection.
Patch by Alex Gaynor.

@item 
bpo-4180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4180}: The warnings registries are now reset when the filters are
modified.

@item 
bpo-22419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22419}: Limit the length of incoming HTTP request in wsgiref server to
65536 bytes and send a 414 error code for higher lengths. Patch
contributed by Devin Cook.

@item 
Lax cookie parsing in http.cookies could be a security issue when combined
with non-standard cookie handling in some web browsers.  Reported by
Sergey Bobrov.

@item 
bpo-20537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20537}: logging methods now accept an exception instance as well as a
Boolean value or exception tuple. Thanks to Yury Selivanov for the patch.

@item 
bpo-22384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22384}: An exception in Tkinter callback no longer crashes the program
when it is run with pythonw.exe.

@item 
bpo-22168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22168}: Prevent turtle AttributeError with non-default Canvas on OS X.

@item 
bpo-21147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21147}: sqlite3 now raises an exception if the request contains a null
character instead of truncating it.  Based on patch by Victor Stinner.

@item 
bpo-13968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13968}: The glob module now supports recursive search in subdirectories
using the @code{**} pattern.

@item 
bpo-21951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21951}: Fixed a crash in Tkinter on AIX when called Tcl command with
empty string or tuple argument.

@item 
bpo-21951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21951}: Tkinter now most likely raises MemoryError instead of crash if
the memory allocation fails.

@item 
bpo-22338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22338}: Fix a crash in the json module on memory allocation failure.

@item 
bpo-12410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12410}: imaplib.IMAP4 now supports the context management protocol.
Original patch by Tarek Ziadé.

@item 
bpo-21270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21270}: We now override tuple methods in mock.call objects so that they
can be used as normal call attributes.

@item 
bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}: @code{load_tests()} is now unconditionally run when it is present
in a package’s @code{__init__.py}.  @code{TestLoader.loadTestsFromModule()}
still accepts use_load_tests, but it is deprecated and ignored.  A new
keyword-only attribute @code{pattern} is added and documented.  Patch given
by Robert Collins, tweaked by Barry Warsaw.

@item 
bpo-22226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22226}: First letter no longer is stripped from the «status» key in the
result of Treeview.heading().

@item 
bpo-19524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19524}: Fixed resource leak in the HTTP connection when an invalid
response is received.  Patch by Martin Panter.

@item 
bpo-20421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20421}: Add a .version() method to SSL sockets exposing the actual
protocol version in use.

@item 
bpo-19546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19546}: configparser exceptions no longer expose implementation
details. Chained KeyErrors are removed, which leads to cleaner tracebacks.
Patch by Claudiu Popa.

@item 
bpo-22051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22051}: turtledemo no longer reloads examples to re-run them.
Initialization of variables and gui setup should be done in main(), which
is called each time a demo is run, but not on import.

@item 
bpo-21933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21933}: Turtledemo users can change the code font size with a menu
selection or control(command) “-” or “+” or control-mousewheel. Original
patch by Lita Cho.

@item 
bpo-21597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21597}: The separator between the turtledemo text pane and the drawing
canvas can now be grabbed and dragged with a mouse.  The code text pane
can be widened to easily view or copy the full width of the text.  The
canvas can be widened on small screens.  Original patches by Jan Kanis and
Lita Cho.

@item 
bpo-18132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18132}: Turtledemo buttons no longer disappear when the window is
shrunk.  Original patches by Jan Kanis and Lita Cho.

@item 
bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}: time.monotonic() is now always available.
@code{threading.Lock.acquire()}, @code{threading.RLock.acquire()} and socket
operations now use a monotonic clock, instead of the system clock, when a
timeout is used.

@item 
bpo-21527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21527}: Add a default number of workers to ThreadPoolExecutor equal to
5 times the number of CPUs.  Patch by Claudiu Popa.

@item 
bpo-22216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22216}: smtplib now resets its state more completely after a quit.  The
most obvious consequence of the previous behavior was a STARTTLS failure
during a connect/starttls/quit/connect/starttls sequence.

@item 
bpo-22098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22098}: ctypes” BigEndianStructure and LittleEndianStructure now define
an empty __slots__ so that subclasses don’t always get an instance dict.
Patch by Claudiu Popa.

@item 
bpo-22185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22185}: Fix an occasional RuntimeError in threading.Condition.wait()
caused by mutation of the waiters queue without holding the lock.  Patch
by Doug Zongker.

@item 
bpo-22287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22287}: On UNIX, _PyTime_gettimeofday() now uses
clock_gettime(CLOCK_REALTIME) if available. As a side effect, Python now
depends on the librt library on Solaris and on Linux (only with glibc
older than 2.17).

@item 
bpo-22182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22182}: Use e.args to unpack exceptions correctly in
distutils.file_util.move_file. Patch by Claudiu Popa.

@item 
The webbrowser module now uses subprocess’s start_new_session=True rather
than a potentially risky preexec_fn=os.setsid call.

@item 
bpo-22042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22042}: signal.set_wakeup_fd(fd) now raises an exception if the file
descriptor is in blocking mode.

@item 
bpo-16808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16808}: inspect.stack() now returns a named tuple instead of a tuple.
Patch by Daniel Shahaf.

@item 
bpo-22236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22236}: Fixed Tkinter images copying operations in NoDefaultRoot mode.

@item 
bpo-2527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2527}: Add a `globals' argument to timeit functions, in order to
override the globals namespace in which the timed code is executed. Patch
by Ben Roberts.

@item 
bpo-22118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22118}: Switch urllib.parse to use RFC 3986 semantics for the
resolution of relative URLs, rather than RFCs 1808 and 2396. Patch by
Demian Brecht.

@item 
bpo-21549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21549}: Added the «members» parameter to TarFile.list().

@item 
bpo-19628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19628}: Allow compileall recursion depth to be specified with a -r
option.

@item 
bpo-15696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15696}: Add a __sizeof__ implementation for mmap objects on Windows.

@item 
bpo-22068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22068}: Avoided reference loops with Variables and Fonts in Tkinter.

@item 
bpo-22165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22165}: SimpleHTTPRequestHandler now supports undecodable file names.

@item 
bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381}: Optimized line reading in io.BytesIO.

@item 
bpo-8797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8797}: Raise HTTPError on failed Basic Authentication immediately.
Initial patch by Sam Bull.

@item 
bpo-20729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20729}: Restored the use of lazy iterkeys()/itervalues()/iteritems() in
the mailbox module.

@item 
bpo-21448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21448}: Changed FeedParser feed() to avoid `O'(`n'@w{^2})
behavior when parsing long line. Original patch by Raymond Hettinger.

@item 
bpo-22184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22184}: The functools LRU Cache decorator factory now gives an earlier
and clearer error message when the user forgets the required parameters.

@item 
bpo-17923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17923}: glob() patterns ending with a slash no longer match non-dirs on
AIX.  Based on patch by Delhallt.

@item 
bpo-21725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21725}: Added support for RFC 6531 (SMTPUTF8) in smtpd.

@item 
bpo-22176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22176}: Update the ctypes module’s libffi to v3.1.  This release adds
support for the Linux AArch64 and POWERPC ELF ABIv2 little endian
architectures.

@item 
bpo-5411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5411}: Added support for the «xztar» format in the shutil module.

@item 
bpo-21121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21121}: Don’t force 3rd party C extensions to be built with
-Werror=declaration-after-statement.

@item 
bpo-21975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21975}: Fixed crash when using uninitialized sqlite3.Row (in particular
when unpickling pickled sqlite3.Row).  sqlite3.Row is now initialized in
the __new__() method.

@item 
bpo-20170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20170}: Convert posixmodule to use Argument Clinic.

@item 
bpo-21539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21539}: Add an `exists_ok' argument to @code{Pathlib.mkdir()} to mimic
@code{mkdir -p} and @code{os.makedirs()} functionality.  When true, ignore
@code{FileExistsErrors}. Patch by Berker Peksag.

@item 
bpo-22127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22127}: Bypass IDNA for pure-ASCII host names in the socket module (in
particular for numeric IPs).

@item 
bpo-21047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21047}: set the default value for the `convert_charrefs' argument of
HTMLParser to True.  Patch by Berker Peksag.

@item 
Add an __all__ to html.entities.

@item 
bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}: the strict mode and argument of HTMLParser, HTMLParser.error,
and the HTMLParserError exception have been removed.

@item 
bpo-22085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22085}: Dropped support of Tk 8.3 in Tkinter.

@item 
bpo-21580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21580}: Now Tkinter correctly handles bytes arguments passed to Tk. In
particular this allows initializing images from binary data.

@item 
bpo-22003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22003}: When initialized from a bytes object, io.BytesIO() now defers
making a copy until it is mutated, improving performance and memory use on
some use cases. Patch by David Wilson.

@item 
bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}: On Windows, signal.set_wakeup_fd() now also supports sockets. A
side effect is that Python depends to the WinSock library.

@item 
bpo-22054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22054}: Add os.get_blocking() and os.set_blocking() functions to get
and set the blocking mode of a file descriptor (False if the O_NONBLOCK
flag is set, True otherwise). These functions are not available on
Windows.

@item 
bpo-17172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17172}: Make turtledemo start as active on OS X even when run with
subprocess. Patch by Lita Cho.

@item 
bpo-21704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21704}: Fix build error for _multiprocessing when semaphores are not
available. Patch by Arfrever Frehtes Taifersar Arahesis.

@item 
bpo-20173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20173}: Convert sha1, sha256, sha512 and md5 to ArgumentClinic. Patch
by Vajrasky Kok.

@item 
Fix repr(_socket.socket) on Windows 64-bit: don’t fail with OverflowError
on closed socket. repr(socket.socket) already works fine.

@item 
bpo-22033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22033}: Reprs of most Python implemented classes now contain actual
class name instead of hardcoded one.

@item 
bpo-21947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21947}: The dis module can now disassemble generator-iterator objects
based on their gi_code attribute. Patch by Clement Rouault.

@item 
bpo-16133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16133}: The asynchat.async_chat.handle_read() method now ignores
BlockingIOError exceptions.

@item 
bpo-22044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22044}: Fixed premature DECREF in call_tzinfo_method. Patch by Tom
Flanagan.

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: readline: Disable the meta modifier key if stdout is not a
terminal to not write the ANSI sequence @code{"\033[1034h"} into stdout. This
sequence is used on some terminal (ex: TERM=xterm-256color») to enable
support of 8 bit characters.

@item 
bpo-4350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4350}: Removed a number of out-of-dated and non-working for a long time
Tkinter methods.

@item 
bpo-6167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6167}: Scrollbar.activate() now returns the name of active element if
the argument is not specified.  Scrollbar.set() now always accepts only 2
arguments.

@item 
bpo-15275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15275}: Clean up and speed up the ntpath module.

@item 
bpo-21888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21888}: plistlib’s load() and loads() now work if the fmt parameter is
specified.

@item 
bpo-22032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22032}: __qualname__ instead of __name__ is now always used to format
fully qualified class names of Python implemented classes.

@item 
bpo-22031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22031}: Reprs now always use hexadecimal format with the «0x» prefix
when contain an id in form « at 0x…».

@item 
bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}: signal.set_wakeup_fd() now raises an OSError instead of a
ValueError on @code{fstat()} failure.

@item 
bpo-21044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21044}: tarfile.open() now handles fileobj with an integer “name”
attribute.  Based on patch by Antoine Pietri.

@item 
bpo-21966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21966}: Respect -q command-line option when code module is ran.

@item 
bpo-19076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19076}: Don’t pass the redundant “file” argument to self.error().

@item 
bpo-16382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16382}: Improve exception message of warnings.warn() for bad category.
Initial patch by Phil Elson.

@item 
bpo-21932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21932}: os.read() now uses a @ref{af0,,Py_ssize_t()} type instead of
int for the size to support reading more than 2 GB at once. On
Windows, the size is truncated to INT_MAX. As any call to os.read(), the
OS may read less bytes than the number of requested bytes.

@item 
bpo-21942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21942}: Fixed source file viewing in pydoc’s server mode on Windows.

@item 
bpo-11259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11259}: asynchat.async_chat().set_terminator() now raises a ValueError
if the number of received bytes is negative.

@item 
bpo-12523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12523}: asynchat.async_chat.push() now raises a TypeError if it doesn’t
get a bytes string

@item 
bpo-21707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21707}: Add missing kwonlyargcount argument to
ModuleFinder.replace_paths_in_code().

@item 
bpo-20639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20639}: calling Path.with_suffix(“”) allows removing the suffix again.
Patch by July Tikhonov.

@item 
bpo-21714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21714}: Disallow the construction of invalid paths using
Path.with_name().  Original patch by Antony Lee.

@item 
bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}: Added “auth” method to smtplib to make implementing auth
mechanisms simpler, and used it internally in the login method.

@item 
bpo-21151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21151}: Fixed a segfault in the winreg module when @code{None} is passed
as a @code{REG_BINARY} value to SetValueEx.  Patch by John Ehresman.

@item 
bpo-21090@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21090}: io.FileIO.readall() does not ignore I/O errors anymore. Before,
it ignored I/O errors if at least the first C call read() succeed.

@item 
bpo-5800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5800}: headers parameter of wsgiref.headers.Headers is now optional.
Initial patch by Pablo Torres Navarrete and SilentGhost.

@item 
bpo-21781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21781}: ssl.RAND_add() now supports strings longer than 2 GB.

@item 
bpo-21679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21679}: Prevent extraneous fstat() calls during open().  Patch by
Bohuslav Kabrda.

@item 
bpo-21863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21863}: cProfile now displays the module name of C extension functions,
in addition to their own name.

@item 
bpo-11453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11453}: asyncore: emit a ResourceWarning when an unclosed file_wrapper
object is destroyed. The destructor now closes the file if needed. The
close() method can now be called twice: the second call does nothing.

@item 
bpo-21858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21858}: Better handling of Python exceptions in the sqlite3 module.

@item 
bpo-21476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21476}: Make sure the email.parser.BytesParser TextIOWrapper is
discarded after parsing, so the input file isn’t unexpectedly closed.

@item 
bpo-20295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20295}: imghdr now recognizes OpenEXR format images.

@item 
bpo-21729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21729}: Used the «with» statement in the dbm.dumb module to ensure
files closing. Patch by Claudiu Popa.

@item 
bpo-21491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21491}: socketserver: Fix a race condition in child processes reaping.

@item 
bpo-21719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21719}: Added the @code{st_file_attributes} field to os.stat_result on
Windows.

@item 
bpo-21832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21832}: Require named tuple inputs to be exact strings.

@item 
bpo-21722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21722}: The distutils «upload» command now exits with a non-zero return
code when uploading fails.  Patch by Martin Dengler.

@item 
bpo-21723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21723}: asyncio.Queue: support any type of number (ex: float) for the
maximum size. Patch written by Vajrasky Kok.

@item 
bpo-21711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21711}: support for «site-python» directories has now been removed from
the site module (it was deprecated in 3.4).

@item 
bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}: new socket.sendfile() method allowing a file to be sent over a
socket by using high-performance os.sendfile() on UNIX. Patch by Giampaolo
Rodola”.

@item 
bpo-18039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18039}: dbm.dump.open() now always creates a new database when the flag
has the value “n”.  Patch by Claudiu Popa.

@item 
bpo-21326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21326}: Add a new is_closed() method to asyncio.BaseEventLoop.
run_forever() and run_until_complete() methods of asyncio.BaseEventLoop
now raise an exception if the event loop was closed.

@item 
bpo-21766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21766}: Prevent a security hole in CGIHTTPServer by URL unquoting paths
before checking for a CGI script at that path.

@item 
bpo-21310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21310}: Fixed possible resource leak in failed open().

@item 
bpo-21256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21256}: Printout of keyword args should be in deterministic order in a
mock function call. This will help to write better doctests.

@item 
bpo-21677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21677}: Fixed chaining nonnormalized exceptions in io close() methods.

@item 
bpo-11709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11709}: Fix the pydoc.help function to not fail when sys.stdin is not a
valid file.

@item 
bpo-21515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21515}: tempfile.TemporaryFile now uses os.O_TMPFILE flag is available.

@item 
bpo-13223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13223}: Fix pydoc.writedoc so that the HTML documentation for methods
that use “self” in the example code is generated correctly.

@item 
bpo-21463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21463}: In urllib.request, fix pruning of the FTP cache.

@item 
bpo-21618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21618}: The subprocess module could fail to close open fds that were
inherited by the calling process and already higher than POSIX resource
limits would otherwise allow.  On systems with a functioning /proc/self/fd
or /dev/fd interface the max is now ignored and all fds are closed.

@item 
bpo-20383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20383}: Introduce importlib.util.module_from_spec() as the preferred
way to create a new module.

@item 
bpo-21552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21552}: Fixed possible integer overflow of too long string lengths in
the tkinter module on 64-bit platforms.

@item 
bpo-14315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14315}: The zipfile module now ignores extra fields in the central
directory that are too short to be parsed instead of letting a
struct.unpack error bubble up as this «bad data» appears in many real
world zip files in the wild and is ignored by other zip tools.

@item 
bpo-13742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13742}: Added «key» and «reverse» parameters to heapq.merge(). (First
draft of patch contributed by Simon Sapin.)

@item 
bpo-21402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21402}: tkinter.ttk now works when default root window is not set.

@item 
bpo-3015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3015}: @code{_tkinter.create()} now creates @code{tkapp} object with
@code{wantobjects=1} by default.

@item 
bpo-10203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10203}: sqlite3.Row now truly supports sequence protocol.  In
particular it supports reverse() and negative indices.  Original patch by
Claudiu Popa.

@item 
bpo-18807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18807}: If copying (no symlinks) specified for a venv, then the python
interpreter aliases (python, python3) are now created by copying rather
than symlinking.

@item 
bpo-20197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20197}: Added support for the WebP image type in the imghdr module.
Patch by Fabrice Aneche and Claudiu Popa.

@item 
bpo-21513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21513}: Speedup some properties of IP addresses (IPv4Address,
IPv6Address) such as .is_private or .is_multicast.

@item 
bpo-21137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21137}: Improve the repr for threading.Lock() and its variants by
showing the «locked» or «unlocked» status.  Patch by Berker Peksag.

@item 
bpo-21538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21538}: The plistlib module now supports loading of binary plist files
when reference or offset size is not a power of two.

@item 
bpo-21455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21455}: Add a default backlog to socket.listen().

@item 
bpo-21525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21525}: Most Tkinter methods which accepted tuples now accept lists
too.

@item 
bpo-22166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22166}: With the assistance of a new internal _codecs._forget_codec
helping function, test_codecs now clears the encoding caches to avoid the
appearance of a reference leak

@item 
bpo-22236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22236}: Tkinter tests now don’t reuse default root window.  New root
window is created for every test class.

@item 
bpo-10744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10744}: Fix 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} format strings on ctypes objects with a
nontrivial shape.

@item 
bpo-20826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20826}: Optimize ipaddress.collapse_addresses().

@item 
bpo-21487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21487}: Optimize ipaddress.summarize_address_range() and
ipaddress.@{IPv4Network,IPv6Network@}.subnets().

@item 
bpo-21486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21486}: Optimize parsing of netmasks in ipaddress.IPv4Network and
ipaddress.IPv6Network.

@item 
bpo-13916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13916}: Disallowed the surrogatepass error handler for non UTF-*
encodings.

@item 
bpo-20998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20998}: Fixed re.fullmatch() of repeated single character pattern with
ignore case. Original patch by Matthew Barnett.

@item 
bpo-21075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21075}: fileinput.FileInput now reads bytes from standard stream if
binary mode is specified.  Patch by Sam Kimbrel.

@item 
bpo-19775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19775}: Add a samefile() method to pathlib Path objects.  Initial patch
by Vajrasky Kok.

@item 
bpo-21226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21226}: Set up modules properly in PyImport_ExecCodeModuleObject (and
friends).

@item 
bpo-21398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21398}: Fix a unicode error in the pydoc pager when the documentation
contains characters not encodable to the stdout encoding.

@item 
bpo-16531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16531}: ipaddress.IPv4Network and ipaddress.IPv6Network now accept an
(address, netmask) tuple argument, so as to easily construct network
objects from existing addresses.

@item 
bpo-21156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21156}: importlib.abc.InspectLoader.source_to_code() is now a
staticmethod.

@item 
bpo-21424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21424}: Simplified and optimized heaqp.nlargest() and nmsmallest() to
make fewer tuple comparisons.

@item 
bpo-21396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21396}: Fix TextIOWrapper(…, write_through=True) to not force a
flush() on the underlying binary stream.  Patch by akira.

@item 
bpo-18314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18314}: Unlink now removes junctions on Windows. Patch by Kim Gräsman

@item 
bpo-21088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21088}: Bugfix for curses.window.addch() regression in 3.4.0. In
porting to Argument Clinic, the first two arguments were reversed.

@item 
bpo-21407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21407}: _decimal: The module now supports function signatures.

@item 
bpo-10650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10650}: Remove the non-standard “watchexp” parameter from the
Decimal.quantize() method in the Python version.  It had never been
present in the C version.

@item 
bpo-21469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21469}: Reduced the risk of false positives in robotparser by checking
to make sure that robots.txt has been read or does not exist prior to
returning True in can_fetch().

@item 
bpo-19414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19414}: Have the OrderedDict mark deleted links as unusable. This gives
an early failure if the link is deleted during iteration.

@item 
bpo-21421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21421}: Add __slots__ to the MappingViews ABC. Patch by Josh Rosenberg.

@item 
bpo-21101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21101}: Eliminate double hashing in the C speed-up code for
collections.Counter().

@item 
bpo-21321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21321}: itertools.islice() now releases the reference to the source
iterator when the slice is exhausted.  Patch by Anton Afanasyev.

@item 
bpo-21057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21057}: TextIOWrapper now allows the underlying binary stream’s read()
or read1() method to return an arbitrary bytes-like object (such as a
memoryview). Patch by Nikolaus Rath.

@item 
bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951}: SSLSocket.send() now raises either SSLWantReadError or
SSLWantWriteError on a non-blocking socket if the operation would block.
Previously, it would return 0.  Patch by Nikolaus Rath.

@item 
bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}: removed previously deprecated asyncore.dispatcher __getattr__
cheap inheritance hack.

@item 
bpo-9815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9815}: assertRaises now tries to clear references to local variables in
the exception’s traceback.

@item 
bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}: ssl.cert_time_to_seconds() now interprets the given time string
in the UTC timezone (as specified in RFC 5280), not the local timezone.

@item 
bpo-13204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13204}: Calling sys.flags.__new__ would crash the interpreter, now it
raises a TypeError.

@item 
bpo-19385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19385}: Make operations on a closed dbm.dumb database always raise the
same exception.

@item 
bpo-21207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21207}: Detect when the os.urandom cached fd has been closed or
replaced, and open it anew.

@item 
bpo-21291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21291}: subprocess’s Popen.wait() is now thread safe so that multiple
threads may be calling wait() or poll() on a Popen instance at the same
time without losing the Popen.returncode value.

@item 
bpo-21127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21127}: Path objects can now be instantiated from str subclass
instances (such as @code{numpy.str_}).

@item 
bpo-15002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15002}: urllib.response object to use _TemporaryFileWrapper (and
_TemporaryFileCloser) facility. Provides a better way to handle file
descriptor close. Patch contributed by Christian Theune.

@item 
bpo-12220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12220}: mindom now raises a custom ValueError indicating it doesn’t
support spaces in URIs instead of letting a “split” ValueError bubble up.

@item 
bpo-21068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21068}: The ssl.PROTOCOL* constants are now enum members.

@item 
bpo-21276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21276}: posixmodule: Don’t define USE_XATTRS on KFreeBSD and the Hurd.

@item 
bpo-21262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21262}: New method assert_not_called for Mock. It raises AssertionError
if the mock has been called.

@item 
bpo-21238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21238}: New keyword argument @code{unsafe} to Mock. It raises
@code{AttributeError} in case of an attribute startswith assert or assret.

@item 
bpo-20896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20896}: ssl.get_server_certificate() now uses PROTOCOL_SSLv23, not
PROTOCOL_SSLv3, for maximum compatibility.

@item 
bpo-21239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21239}: patch.stopall() didn’t work deterministically when the same
name was patched more than once.

@item 
bpo-21203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21203}: Updated fileConfig and dictConfig to remove inconsistencies.
Thanks to Jure Koren for the patch.

@item 
bpo-21222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21222}: Passing name keyword argument to mock.create_autospec now
works.

@item 
bpo-21197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21197}: Add lib64 -> lib symlink in venvs on 64-bit non-OS X POSIX.

@item 
bpo-17498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17498}: Some SMTP servers disconnect after certain errors, violating
strict RFC conformance.  Instead of losing the error code when we issue
the subsequent RSET, smtplib now returns the error code and defers raising
the SMTPServerDisconnected error until the next command is issued.

@item 
bpo-17826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17826}: setting an iterable side_effect on a mock function created by
create_autospec now works. Patch by Kushal Das.

@item 
bpo-7776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7776}: Fix @code{Host:} header and reconnection when using
http.client.HTTPConnection.set_tunnel(). Patch by Nikolaus Rath.

@item 
bpo-20968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20968}: unittest.mock.MagicMock now supports division. Patch by
Johannes Baiter.

@item 
bpo-21529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21529}: Fix arbitrary memory access in JSONDecoder.raw_decode with a
negative second parameter. Bug reported by Guido Vranken. (See also:
@geindex Common Vulnerabilities and Exposures; CVE 2014-4616
CVE 2014-4616@footnote{https://www.cve.org/CVERecord?id=CVE-2014-4616})

@item 
bpo-21169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21169}: getpass now handles non-ascii characters that the input stream
encoding cannot encode by re-encoding using the replace error handler.

@item 
bpo-21171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21171}: Fixed undocumented filter API of the rot13 codec. Patch by
Berker Peksag.

@item 
bpo-20539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20539}: Improved math.factorial error message for large positive inputs
and changed exception type (OverflowError -> ValueError) for large
negative inputs.

@item 
bpo-21172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21172}: isinstance check relaxed from dict to collections.Mapping.

@item 
bpo-21155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21155}: asyncio.EventLoop.create_unix_server() now raises a ValueError
if path and sock are specified at the same time.

@item 
bpo-21136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21136}: Avoid unnecessary normalization of Fractions resulting from
power and other operations.  Patch by Raymond Hettinger.

@item 
bpo-17621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17621}: Introduce importlib.util.LazyLoader.

@item 
bpo-21076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21076}: signal module constants were turned into enums. Patch by
Giampaolo Rodola”.

@item 
bpo-20636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20636}: Improved the repr of Tkinter widgets.

@item 
bpo-19505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19505}: The items, keys, and values views of OrderedDict now support
reverse iteration using reversed().

@item 
bpo-21149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21149}: Improved thread-safety in logging cleanup during interpreter
shutdown. Thanks to Devin Jeanpierre for the patch.

@item 
bpo-21058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21058}: Fix a leak of file descriptor in
@ref{56d,,tempfile.NamedTemporaryFile()}, close the file descriptor if
@ref{5c0,,io.open()} fails

@item 
bpo-21200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21200}: Return None from pkgutil.get_loader() when __spec__ is missing.

@item 
bpo-21013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21013}: Enhance ssl.create_default_context() when used for server side
sockets to provide better security by default.

@item 
bpo-20145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20145}: @code{assertRaisesRegex} and @code{assertWarnsRegex} now raise a
@code{TypeError} if the second argument is not a string or compiled regex.

@item 
bpo-20633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20633}: Replace relative import by absolute import.

@item 
bpo-20980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20980}: Stop wrapping exception when using ThreadPool.

@item 
bpo-21082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21082}: In os.makedirs, do not set the process-wide umask. Note this
changes behavior of makedirs when exist_ok=True.

@item 
bpo-20990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20990}: Fix issues found by pyflakes for multiprocessing.

@item 
bpo-21015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21015}: SSL contexts will now automatically select an elliptic curve
for ECDH key exchange on OpenSSL 1.0.2 and later, and otherwise default to
«prime256v1».

@item 
bpo-21000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21000}: Improve the command-line interface of json.tool.

@item 
bpo-20995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20995}: Enhance default ciphers used by the ssl module to enable better
security and prioritize perfect forward secrecy.

@item 
bpo-20884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20884}: Don’t assume that __file__ is defined on importlib.__init__.

@item 
bpo-21499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21499}: Ignore __builtins__ in several test_importlib.test_api tests.

@item 
bpo-20627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20627}: xmlrpc.client.ServerProxy is now a context manager.

@item 
bpo-19165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19165}: The formatter module now raises DeprecationWarning instead of
PendingDeprecationWarning.

@item 
bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936}: Remove the ability of datetime.time instances to be considered
false in boolean contexts.

@item 
bpo-18931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18931}: selectors module now supports /dev/poll on Solaris. Patch by
Giampaolo Rodola”.

@item 
bpo-19977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19977}: When the @code{LC_TYPE} locale is the POSIX locale (@code{C} locale),
@ref{5df,,sys.stdin} and @ref{b61,,sys.stdout} are now using the
@code{surrogateescape} error handler, instead of the @code{strict} error
handler.

@item 
bpo-20574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20574}: Implement incremental decoder for cp65001 code (Windows code
page 65001, Microsoft UTF-8).

@item 
bpo-20879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20879}: Delay the initialization of encoding and decoding tables for
base32, ascii85 and base85 codecs in the base64 module, and delay the
initialization of the unquote_to_bytes() table of the urllib.parse module,
to not waste memory if these modules are not used.

@item 
bpo-19157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19157}: Include the broadcast address in the usable hosts for IPv6 in
ipaddress.

@item 
bpo-11599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11599}: When an external command (e.g. compiler) fails, distutils now
prints out the whole command line (instead of just the command name) if
the environment variable DISTUTILS_DEBUG is set.

@item 
bpo-4931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4931}: distutils should not produce unhelpful «error: None» messages
anymore. distutils.util.grok_environment_error is kept but doc-deprecated.

@item 
bpo-20875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20875}: Prevent possible gzip «“read” is not defined» NameError. Patch
by Claudiu Popa.

@item 
bpo-11558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11558}: @code{email.message.Message.attach} now returns a more useful
error message if @code{attach} is called on a message for which
@code{is_multipart} is False.

@item 
bpo-20283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20283}: RE pattern methods now accept the string keyword parameters as
documented. The pattern and source keyword parameters are left as
deprecated aliases.

@item 
bpo-20778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20778}: Fix modulefinder to work with bytecode-only modules.

@item 
bpo-20791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20791}: copy.copy() now doesn’t make a copy when the input is a bytes
object. Initial patch by Peter Otten.

@item 
bpo-19748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19748}: On AIX, time.mktime() now raises an OverflowError for year
outsize range [1902; 2037].

@item 
bpo-19573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19573}: inspect.signature: Use enum for parameter kind constants.

@item 
bpo-20726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20726}: inspect.signature: Make Signature and Parameter picklable.

@item 
bpo-17373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17373}: Add inspect.Signature.from_callable method.

@item 
bpo-20378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20378}: Improve repr of inspect.Signature and inspect.Parameter.

@item 
bpo-20816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20816}: Fix inspect.getcallargs() to raise correct TypeError for
missing keyword-only arguments. Patch by Jeremiah Lowin.

@item 
bpo-20817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20817}: Fix inspect.getcallargs() to fail correctly if more than 3
arguments are missing. Patch by Jeremiah Lowin.

@item 
bpo-6676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6676}: Ensure a meaningful exception is raised when attempting to parse
more than one XML document per pyexpat xmlparser instance. (Original
patches by Hirokazu Yamamoto and Amaury Forgeot d’Arc, with suggested
wording by David Gutteridge)

@item 
bpo-21117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21117}: Fix inspect.signature to better support functools.partial. Due
to the specifics of functools.partial implementation,
positional-or-keyword arguments passed as keyword arguments become
keyword-only.

@item 
bpo-20334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20334}: inspect.Signature and inspect.Parameter are now hashable.
Thanks to Antony Lee for bug reports and suggestions.

@item 
bpo-15916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15916}: doctest.DocTestSuite returns an empty unittest.TestSuite
instead of raising ValueError if it finds no tests

@item 
bpo-21209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21209}: Fix asyncio.tasks.CoroWrapper to workaround a bug in yield-from
implementation in CPythons prior to 3.4.1.

@item 
asyncio: Add gi_@{frame,running,code@} properties to CoroWrapper (upstream
bpo-163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=163}).

@item 
bpo-21311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21311}: Avoid exception in _osx_support with non-standard compiler
configurations. Patch by John Szakmeister.

@item 
bpo-11571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11571}: Ensure that the turtle window becomes the topmost window when
launched on OS X.

@item 
bpo-21801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21801}: Validate that __signature__ is None or an instance of
Signature.

@item 
bpo-21923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21923}: Prevent AttributeError in
distutils.sysconfig.customize_compiler due to possible uninitialized
_config_vars.

@item 
bpo-21323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21323}: Fix http.server to again handle scripts in CGI subdirectories,
broken by the fix for security bpo-19435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19435}.  Patch by Zach Byrne.

@item 
bpo-22733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22733}: Fix ffi_prep_args not zero-extending argument values correctly
on 64-bit Windows.

@item 
bpo-23302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23302}: Default to TCP_NODELAY=1 upon establishing an HTTPConnection.
Removed use of hard-coded MSS as it’s an optimization that’s no longer
needed with Nagle disabled.
@end itemize

@node IDLE<59>,Build<83>,Library<90>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id731}@anchor{1bd8}
@subsubsection IDLE



@itemize -

@item 
bpo-20577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20577}: Configuration of the max line length for the FormatParagraph
extension has been moved from the General tab of the Idle preferences
dialog to the FormatParagraph tab of the Config Extensions dialog. Patch
by Tal Einat.

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: Update Idle doc chapter to match current Idle and add new
information.

@item 
bpo-3068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3068}: Add Idle extension configuration dialog to Options menu. Changes
are written to HOME/.idlerc/config-extensions.cfg. Original patch by Tal
Einat.

@item 
bpo-16233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16233}: A module browser (File : Class Browser, Alt+C) requires an
editor window with a filename.  When Class Browser is requested otherwise,
from a shell, output window, or “Untitled” editor, Idle no longer displays
an error box. It now pops up an Open Module box (Alt+M). If a valid name
is entered and a module is opened, a corresponding browser is also opened.

@item 
bpo-4832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4832}: Save As to type Python files automatically adds .py to the name
you enter (even if your system does not display it).  Some systems
automatically add .txt when type is Text files.

@item 
bpo-21986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21986}: Code objects are not normally pickled by the pickle module. To
match this, they are no longer pickled when running under Idle.

@item 
bpo-17390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17390}: Adjust Editor window title; remove “Python”, move version to
end.

@item 
bpo-14105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14105}: Idle debugger breakpoints no longer disappear when inserting or
deleting lines.

@item 
bpo-17172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17172}: Turtledemo can now be run from Idle. Currently, the entry is on
the Help menu, but it may move to Run. Patch by Ramchandra Apt and Lita
Cho.

@item 
bpo-21765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21765}: Add support for non-ascii identifiers to HyperParser.

@item 
bpo-21940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21940}: Add unittest for WidgetRedirector. Initial patch by Saimadhav
Heblikar.

@item 
bpo-18592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18592}: Add unittest for SearchDialogBase. Patch by Phil Webster.

@item 
bpo-21694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21694}: Add unittest for ParenMatch. Patch by Saimadhav Heblikar.

@item 
bpo-21686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21686}: add unittest for HyperParser. Original patch by Saimadhav
Heblikar.

@item 
bpo-12387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12387}: Add missing upper(lower)case versions of default Windows key
bindings for Idle so Caps Lock does not disable them. Patch by Roger
Serwy.

@item 
bpo-21695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21695}: Closing a Find-in-files output window while the search is still
in progress no longer closes Idle.

@item 
bpo-18910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18910}: Add unittest for textView. Patch by Phil Webster.

@item 
bpo-18292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18292}: Add unittest for AutoExpand. Patch by Saihadhav Heblikar.

@item 
bpo-18409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18409}: Add unittest for AutoComplete. Patch by Phil Webster.

@item 
bpo-21477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21477}: htest.py - Improve framework, complete set of tests. Patches by
Saimadhav Heblikar

@item 
bpo-18104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18104}: Add idlelib/idle_test/htest.py with a few sample tests to begin
consolidating and improving human-validated tests of Idle. Change other
files as needed to work with htest.  Running the module as __main__ runs
all tests.

@item 
bpo-21139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21139}: Change default paragraph width to 72, the 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}
recommendation.

@item 
bpo-21284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21284}: Paragraph reformat test passes after user changes reformat
width.

@item 
bpo-17654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17654}: Ensure IDLE menus are customized properly on OS X for
non-framework builds and for all variants of Tk.

@item 
bpo-23180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23180}: Rename IDLE «Windows» menu item to «Window». Patch by Al
Sweigart.
@end itemize

@node Build<83>,C API<66>,IDLE<59>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id732}@anchor{1bd9}
@subsubsection Build



@itemize -

@item 
bpo-15506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15506}: Use standard PKG_PROG_PKG_CONFIG autoconf macro in the
configure script.

@item 
bpo-22935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22935}: Allow the ssl module to be compiled if openssl doesn’t support
SSL 3.

@item 
bpo-22592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22592}: Drop support of the Borland C compiler to build Python. The
distutils module still supports it to build extensions.

@item 
bpo-22591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22591}: Drop support of MS-DOS, especially of the DJGPP compiler
(MS-DOS port of GCC).

@item 
bpo-16537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16537}: Check whether self.extensions is empty in setup.py. Patch by
Jonathan Hosmer.

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: Remove incorrect uses of recursive make.  Patch by Jonas
Wagner.

@item 
bpo-21958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21958}: Define HAVE_ROUND when building with Visual Studio 2013 and
above.  Patch by Zachary Turner.

@item 
bpo-18093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18093}: the programs that embed the CPython runtime are now in a
separate «Programs» directory, rather than being kept in the Modules
directory.

@item 
bpo-15759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15759}: «make suspicious», «make linkcheck» and «make doctest» in Doc/
now display special message when and only when there are failures.

@item 
bpo-21141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21141}: The Windows build process no longer attempts to find Perl,
instead relying on OpenSSL source being configured and ready to build.
The @code{PCbuild\build_ssl.py} script has been re-written and re-named to
@code{PCbuild\prepare_ssl.py}, and takes care of configuring OpenSSL source
for both 32 and 64 bit platforms.  OpenSSL sources obtained from
svn.python.org will always be pre-configured and ready to build.

@item 
bpo-21037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21037}: Add a build option to enable AddressSanitizer support.

@item 
bpo-19962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19962}: The Windows build process now creates «python.bat» in the root
of the source tree, which passes all arguments through to the most
recently built interpreter.

@item 
bpo-21285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21285}: Refactor and fix curses configure check to always search in a
ncursesw directory.

@item 
bpo-15234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15234}: For BerkeleyDB and Sqlite, only add the found library and
include directories if they aren’t already being searched. This avoids an
explicit runtime library dependency.

@item 
bpo-17861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17861}: Tools/scripts/generate_opcode_h.py automatically regenerates
Include/opcode.h from Lib/opcode.py if the latter gets any change.

@item 
bpo-20644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20644}: OS X installer build support for documentation build changes in
3.4.1: assume externally supplied sphinx-build is available in /usr/bin.

@item 
bpo-20022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20022}: Eliminate use of deprecated bundlebuilder in OS X builds.

@item 
bpo-15968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15968}: Incorporated Tcl, Tk, and Tix builds into the Windows build
solution.

@item 
bpo-17095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17095}: Fix Modules/Setup `shared' support.

@item 
bpo-21811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21811}: Anticipated fixes to support OS X versions > 10.9.

@item 
bpo-21166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21166}: Prevent possible segfaults and other random failures of python
–generate-posix-vars in pybuilddir.txt build target.

@item 
bpo-18096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18096}: Fix library order returned by python-config.

@item 
bpo-17219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17219}: Add library build dir for Python extension cross-builds.

@item 
bpo-22919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22919}: Windows build updated to support VC 14.0 (Visual Studio 2015),
which will be used for the official release.

@item 
bpo-21236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21236}: Build _msi.pyd with cabinet.lib instead of fci.lib

@item 
bpo-17128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17128}: Use private version of OpenSSL for OS X 10.5+ installer.
@end itemize

@node C API<66>,Documentation<73>,Build<83>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id733}@anchor{1bda}
@subsubsection C API



@itemize -

@item 
bpo-14203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14203}: Remove obsolete support for view==NULL in PyBuffer_FillInfo(),
bytearray_getbuffer(), bytesiobuf_getbuffer() and array_buffer_getbuf().
All functions now raise BufferError in that case.

@item 
bpo-22445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22445}: PyBuffer_IsContiguous() now implements precise contiguity
tests, compatible with NumPy’s NPY_RELAXED_STRIDES_CHECKING compilation
flag.  Previously the function reported false negatives for corner cases.

@item 
bpo-22079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22079}: PyType_Ready() now checks that statically allocated type has no
dynamically allocated bases.

@item 
bpo-22453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22453}: Removed non-documented macro PyObject_REPR().

@item 
bpo-18395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18395}: Rename @code{_Py_char2wchar()} to @ref{c4f,,Py_DecodeLocale()},
rename @code{_Py_wchar2char()} to @ref{c50,,Py_EncodeLocale()}, and document
these functions.

@item 
bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}: Add new C functions: PyMem_RawCalloc(), PyMem_Calloc(),
PyObject_Calloc(), _PyObject_GC_Calloc(). bytes(int) is now using
@code{calloc()} instead of @code{malloc()} for large objects which is faster and
use less memory.

@item 
bpo-20942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20942}: PyImport_ImportFrozenModuleObject() no longer sets __file__ to
match what importlib does; this affects _frozen_importlib as well as any
module loaded using imp.init_frozen().
@end itemize

@node Documentation<73>,Tests<77>,C API<66>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id734}@anchor{1bdb}
@subsubsection Documentation



@itemize -

@item 
bpo-19548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19548}: Update the codecs module documentation to better cover the
distinction between text encodings and other codecs, together with other
clarifications. Patch by Martin Panter.

@item 
bpo-22394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22394}: Doc/Makefile now supports @code{make venv PYTHON=../python} to
create a venv for generating the documentation, e.g., @code{make html
PYTHON=venv/bin/python3}.

@item 
bpo-21514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21514}: The documentation of the json module now refers to new JSON RFC
7159 instead of obsoleted RFC 4627.

@item 
bpo-21777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21777}: The binary sequence methods on bytes and bytearray are now
documented explicitly, rather than assuming users will be able to derive
the expected behaviour from the behaviour of the corresponding str
methods.

@item 
bpo-6916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6916}: undocument deprecated asynchat.fifo class.

@item 
bpo-17386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17386}: Expanded functionality of the @code{Doc/make.bat} script to make
it much more comparable to @code{Doc/Makefile}.

@item 
bpo-21312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21312}: Update the thread_foobar.h template file to include newer
threading APIs. Patch by Jack McCracken.

@item 
bpo-21043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21043}: Remove the recommendation for specific CA organizations and to
mention the ability to load the OS certificates.

@item 
bpo-20765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20765}: Add missing documentation for PurePath.with_name() and
PurePath.with_suffix().

@item 
bpo-19407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19407}: New package installation and distribution guides based on the
Python Packaging Authority tools. Existing guides have been retained as
legacy links from the distutils docs, as they still contain some required
reference material for tool developers that isn’t recorded anywhere else.

@item 
bpo-19697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19697}: Document cases where __main__.__spec__ is None.
@end itemize

@node Tests<77>,Tools/Demos<48>,Documentation<73>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id735}@anchor{1bdc}
@subsubsection Tests



@itemize -

@item 
bpo-18982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18982}: Add tests for CLI of the calendar module.

@item 
bpo-19548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19548}: Added some additional checks to test_codecs to ensure that
statements in the updated documentation remain accurate. Patch by Martin
Panter.

@item 
bpo-22838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22838}: All test_re tests now work with unittest test discovery.

@item 
bpo-22173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22173}: Update lib2to3 tests to use unittest test discovery.

@item 
bpo-16000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16000}: Convert test_curses to use unittest.

@item 
bpo-21456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21456}: Skip two tests in test_urllib2net.py if _ssl module not
present. Patch by Remi Pointel.

@item 
bpo-20746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20746}: Fix test_pdb to run in refleak mode (-R).  Patch by Xavier de
Gaye.

@item 
bpo-22060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22060}: test_ctypes has been somewhat cleaned up and simplified; it now
uses unittest test discovery to find its tests.

@item 
bpo-22104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22104}: regrtest.py no longer holds a reference to the suite of tests
loaded from test modules that don’t define test_main().

@item 
bpo-22111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22111}: Assorted cleanups in test_imaplib.  Patch by Milan Oberkirch.

@item 
bpo-22002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22002}: Added @code{load_package_tests} function to test.support and used
it to implement/augment test discovery in test_asyncio, test_email,
test_importlib, test_json, and test_tools.

@item 
bpo-21976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21976}: Fix test_ssl to accept LibreSSL version strings.  Thanks to
William Orr.

@item 
bpo-21918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21918}: Converted test_tools from a module to a package containing
separate test files for each tested script.

@item 
bpo-9554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9554}: Use modern unittest features in test_argparse. Initial patch by
Denver Coneybeare and Radu Voicilas.

@item 
bpo-20155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20155}: Changed HTTP method names in failing tests in test_httpservers
so that packet filtering software (specifically Windows Base Filtering
Engine) does not interfere with the transaction semantics expected by the
tests.

@item 
bpo-19493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19493}: Refactored the ctypes test package to skip tests explicitly
rather than silently.

@item 
bpo-18492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18492}: All resources are now allowed when tests are not run by
regrtest.py.

@item 
bpo-21634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21634}: Fix pystone micro-benchmark: use floor division instead of true
division to benchmark integers instead of floating-point numbers. Set
pystone version to 1.2. Patch written by Lennart Regebro.

@item 
bpo-21605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21605}: Added tests for Tkinter images.

@item 
bpo-21493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21493}: Added test for ntpath.expanduser().  Original patch by Claudiu
Popa.

@item 
bpo-19925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19925}: Added tests for the spwd module. Original patch by Vajrasky
Kok.

@item 
bpo-21522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21522}: Added Tkinter tests for Listbox.itemconfigure(),
PanedWindow.paneconfigure(), and Menu.entryconfigure().

@item 
bpo-17756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17756}: Fix test_code test when run from the installed location.

@item 
bpo-17752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17752}: Fix distutils tests when run from the installed location.

@item 
bpo-18604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18604}: Consolidated checks for GUI availability.  All platforms now at
least check whether Tk can be instantiated when the GUI resource is
requested.

@item 
bpo-21275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21275}: Fix a socket test on KFreeBSD.

@item 
bpo-21223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21223}: Pass test_site/test_startup_imports when some of the extensions
are built as builtins.

@item 
bpo-20635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20635}: Added tests for Tk geometry managers.

@item 
Add test case for freeze.

@item 
bpo-20743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20743}: Fix a reference leak in test_tcl.

@item 
bpo-21097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21097}: Move test_namespace_pkgs into test_importlib.

@item 
bpo-21503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21503}: Use test_both() consistently in test_importlib.

@item 
bpo-20939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20939}: Avoid various network test failures due to new redirect of
@indicateurl{http://www.python.org/} to @indicateurl{https://www.python.org}: use
@indicateurl{http://www.example.com} instead.

@item 
bpo-20668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20668}: asyncio tests no longer rely on tests.txt file. (Patch by
Vajrasky Kok)

@item 
bpo-21093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21093}: Prevent failures of ctypes test_macholib on OS X if a copy of
libz exists in $HOME/lib or /usr/local/lib.

@item 
bpo-22770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22770}: Prevent some Tk segfaults on OS X when running gui tests.

@item 
bpo-23211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23211}: Workaround test_logging failure on some OS X 10.6 systems.

@item 
bpo-23345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23345}: Prevent test_ssl failures with large OpenSSL patch level values
(like 0.9.8zc).
@end itemize

@node Tools/Demos<48>,Windows<71>,Tests<77>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id736}@anchor{1bdd}
@subsubsection Tools/Demos



@itemize -

@item 
bpo-22314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22314}: pydoc now works when the LINES environment variable is set.

@item 
bpo-22615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22615}: Argument Clinic now supports the «type» argument for the int
converter. This permits using the int converter with enums and typedefs.

@item 
bpo-20076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20076}: The makelocalealias.py script no longer ignores UTF-8 mapping.

@item 
bpo-20079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20079}: The makelocalealias.py script now can parse the SUPPORTED file
from glibc sources and supports command line options for source paths.

@item 
bpo-22201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22201}: Command-line interface of the zipfile module now correctly
extracts ZIP files with directory entries.  Patch by Ryan Wilson.

@item 
bpo-22120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22120}: For functions using an unsigned integer return converter,
Argument Clinic now generates a cast to that type for the comparison to -1
in the generated code.  (This suppresses a compilation warning.)

@item 
bpo-18974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18974}: Tools/scripts/diff.py now uses argparse instead of optparse.

@item 
bpo-21906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21906}: Make Tools/scripts/md5sum.py work in Python 3. Patch by Zachary
Ware.

@item 
bpo-21629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21629}: Fix Argument Clinic’s «–converters» feature.

@item 
Add support for @code{yield from} to 2to3.

@item 
Add support for the 
@geindex Python Enhancement Proposals; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} matrix multiplication operator to 2to3.

@item 
bpo-16047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16047}: Fix module exception list and __file__ handling in freeze.
Patch by Meador Inge.

@item 
bpo-11824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11824}: Consider ABI tags in freeze. Patch by Meador Inge.

@item 
bpo-20535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20535}: PYTHONWARNING no longer affects the run_tests.py script. Patch
by Arfrever Frehtes Taifersar Arahesis.
@end itemize

@node Windows<71>,,Tools/Demos<48>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id737}@anchor{1bde}
@subsubsection Windows



@itemize -

@item 
bpo-23260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23260}: Update Windows installer

@item 
The bundled version of Tcl/Tk has been updated to 8.6.3.  The most visible
result of this change is the addition of new native file dialogs when
running on Windows Vista or newer.  See Tcl/Tk’s TIP 432 for more
information.  Also, this version of Tcl/Tk includes support for Windows
10.

@item 
bpo-17896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17896}: The Windows build scripts now expect external library sources
to be in @code{PCbuild\..\externals} rather than @code{PCbuild\..\..}.

@item 
bpo-17717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17717}: The Windows build scripts now use a copy of NASM pulled from
svn.python.org to build OpenSSL.

@item 
bpo-21907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21907}: Improved the batch scripts provided for building Python.

@item 
bpo-22644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22644}: The bundled version of OpenSSL has been updated to 1.0.1j.

@item 
bpo-10747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10747}: Use versioned labels in the Windows start menu. Patch by Olive
Kilburn.

@item 
bpo-22980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22980}: .pyd files with a version and platform tag (for example,
«.cp35-win32.pyd») will now be loaded in preference to those without tags.
@end itemize

`(For information about older versions, consult the HISTORY file.)'

@node El tutorial de Python,Configuración y uso de Python,Qué hay de nuevo en Python,Top
@anchor{tutorial/index doc}@anchor{1bdf}@anchor{tutorial/index the-python-tutorial}@anchor{1be0}@anchor{tutorial/index tutorial-index}@anchor{1be1}
@chapter El tutorial de Python


Python es un lenguaje de programación potente y fácil de aprender. Tiene estructuras de datos de alto nivel eficientes y un simple pero efectivo sistema de programación orientado a objetos. La elegante sintaxis de Python y su tipado dinámico, junto a su naturaleza interpretada lo convierten en un lenguaje ideal para scripting y desarrollo rápido de aplicaciones en muchas áreas, para la mayoría de plataformas.

El intérprete de Python y la extensa librería estándar se encuentran disponibles libremente en código fuente y de forma binaria para la mayoría de las plataformas desde la Web de Python, @indicateurl{https://www.python.org/}, y se pueden distribuir libremente. El mismo sitio también contiene distribuciones y referencias a muchos módulos libres de Python de terceros, programas, herramientas y documentación adicional.

El intérprete de Python es fácilmente extensible con funciones y tipos de datos implementados en C o C++ (u otros lenguajes que permitan ser llamados desde C). Python también es apropiado como un lenguaje para extender aplicaciones modificables.

Este tutorial introduce al lector informalmente a los conceptos básicos y las funcionalidades del lenguaje de programación Python y a su sistema. Ayuda a tener un interprete de Python accesible para una experiencia práctica, todos los ejemplos son auto-contenidos, permitiendo utilizar el tutorial sin conexión.

Para una descripción de los objetos estándar y de los módulos, ver @ref{2b1,,La biblioteca estándar de Python}. @ref{2b2,,Referencia del Lenguaje Python} dónde se ofrece una definición más formal del lenguaje. Para escribir extensiones en C o C++, leer @ref{1be2,,Ampliación e incrustación del intérprete de Python} y @ref{1be3,,Manual de referencia de la API en C de Python}. Existen diversos libros que cubren Python en detalle.

Este tutorial no pretende ser exhaustivo ni cubrir cada una de las características del lenguaje, ni siquiera las más utilizadas. En vez de eso, pretende introducir muchas de las funcionalidades más notables y brindar una idea clara acerca del estilo y el tipo de lenguaje que es Python. Después de leerlo podrás leer y escribir módulos y programas en Python, y estarás listo para aprender más acerca de las diversas librerías y módulos descritos en @ref{2b1,,La biblioteca estándar de Python}.

Es interesante leer el @ref{1be4,,Glosario}.

@menu
* Abriendo el apetito:: 
* Usando el intérprete de Python:: 
* Una introducción informal a Python:: 
* Más herramientas para control de flujo:: 
* Estructuras de datos:: 
* Módulos: Módulos<2>. 
* Entrada y salida:: 
* Errores y excepciones:: 
* Clases:: 
* Breve recorrido por la Biblioteca Estándar:: 
* Pequeño paseo por la Biblioteca Estándar— Parte II:: 
* Entornos virtuales y paquetes:: 
* ¿Y ahora qué?:: 
* Edición de entrada interactiva y sustitución de historial:: 
* Floating-Point Arithmetic; Issues and Limitations: Floating-Point Arithmetic Issues and Limitations. 
* Apéndice:: 

@end menu

@node Abriendo el apetito,Usando el intérprete de Python,,El tutorial de Python
@anchor{tutorial/appetite doc}@anchor{1be5}@anchor{tutorial/appetite tut-intro}@anchor{1be6}@anchor{tutorial/appetite whetting-your-appetite}@anchor{1be7}
@section Abriendo el apetito


Si trabajas mucho con ordenadores, en algún momento encontrarás que hay alguna tarea que quieres automatizar. Por ejemplo, quizás quieres buscar y remplazar un texto en muchos ficheros o renombrar y reordenar un montón de imágenes de forma complicada. Quizás lo que quieres es escribir una pequeña base de datos personalizada, una interfaz gráfica o un juego simple.

Si eres un desarrollador profesional, quizás quieres trabajar con varias librerías de C/C++/Java pero encuentras el ciclo de escribir/compilar/probar/recompilar bastante lento. Quizás estás escribiendo una serie de pruebas para éstas librerías y te parece tedioso escribir el código de pruebas. O quizás has escrito un programa que puede utilizar un lenguaje como extensión y no quieres diseñar e implementar un lenguaje entero para tu aplicación.

Python es justo el lenguaje para ti.

Puedes escribir un script de shell de Unix o archivos por lotes de Windows para algunas de estas tareas. Los scripts de shell son mejores para mover archivos y cambiar datos de texto, pero no son adecuados para juegos o aplicaciones GUI. Podrías escribir un programa C / C ++ / Java, pero llevaría mucho tiempo de desarrollo obtener incluso un primer programa de borrador. Python es más fácil de usar, está disponible en los sistemas operativos Windows, macOS y Unix, y te ayudará a hacer el trabajo más rápidamente.

Python es fácil de utilizar y es un verdadero lenguaje de programación ofreciendo mucha más estructura y soporte para programas grandes que la que ofrecen scripts de shell o archivos por lotes. Por otro lado, Python también ofrece mayor comprobación de errores que C y siendo un `lenguaje de muy alto nivel' tiene tipos de datos de alto nivel incorporados como listas flexibles y diccionarios. Debido a sus tipos de datos más generales, Python es aplicable a más dominios que Awk o Perl, aunque hay muchas cosas que son tan sencillas en Python como en esos lenguajes.

Python te permite dividir tu programa en módulos que pueden reutilizarse en otros programas de Python. Tiene una gran colección de módulos estándar que puedes utilizar como la base de tus programas o como ejemplos para empezar a aprender Python. Algunos de estos módulos proporcionan cosas como entrada/salida de ficheros, llamadas a sistema, sockets e incluso interfaces a herramientas de interfaz gráfica como Tk.

Python es un lenguaje interpretado, lo cual puede ahorrarte mucho tiempo durante el desarrollo ya que no es necesario compilar ni enlazar. El intérprete puede usarse interactivamente, lo que facilita experimentar con características del lenguaje, escribir programas desechables o probar funciones cuando se hace desarrollo de programas de abajo hacia arriba. Es también una calculadora de escritorio práctica.

Python permite escribir programas compactos y legibles. Los programas en Python son típicamente más cortos que sus programas equivalentes en C, C++ o Java por varios motivos:


@itemize *

@item 
los tipos de datos de alto nivel permiten expresar operaciones complejas en una sola instrucción;

@item 
la agrupación de instrucciones se hace mediante indentación en vez de llaves de apertura y cierre;

@item 
no es necesario declarar variables ni argumentos.
@end itemize

Python es `extensible': si ya sabes programar en C es fácil añadir nuevas funciones o módulos al intérprete, ya sea para realizar operaciones críticas a velocidad máxima, o para enlazar programas de Python con bibliotecas que tal vez sólo estén disponibles de forma binaria (por ejemplo bibliotecas gráficas específicas de un fabricante). Una vez estés realmente entusiasmado, puedes enlazar el intérprete Python en una aplicación hecha en C y usarlo como lenguaje de extensión o de comando para esa aplicación.

Por cierto, el lenguaje recibe su nombre del programa de televisión de la BBC «Monty Python’s Flying Circus» y no tiene nada que ver con reptiles. Hacer referencias sobre Monty Python en la documentación no sólo esta permitido, ¡sino que también está bien visto!

Ahora que estás emocionado con Python, querrás verlo en más detalle. Como la mejor forma de aprender un lenguaje es usarlo, el tutorial te invita a que juegues con el intérprete de Python a medida que vas leyendo.

En el próximo capítulo se explicará la mecánica de uso del intérprete. Esta es información bastante mundana, pero es esencial para poder probar los ejemplos que aparecerán más adelante.

El resto del tutorial introduce varias características del lenguaje y el sistema Python a través de ejemplos, empezando con expresiones, instrucciones y tipos de datos simples, pasando por funciones y módulos, y finalmente tocando conceptos avanzados como excepciones y clases definidas por el usuario.

@node Usando el intérprete de Python,Una introducción informal a Python,Abriendo el apetito,El tutorial de Python
@anchor{tutorial/interpreter doc}@anchor{1be8}@anchor{tutorial/interpreter tut-using}@anchor{1be9}@anchor{tutorial/interpreter using-the-python-interpreter}@anchor{1bea}
@section Usando el intérprete de Python


@menu
* Invocar el intérprete:: 
* El intérprete y su entorno:: 

@end menu

@node Invocar el intérprete,El intérprete y su entorno,,Usando el intérprete de Python
@anchor{tutorial/interpreter invoking-the-interpreter}@anchor{1beb}@anchor{tutorial/interpreter tut-invoking}@anchor{1bec}
@subsection Invocar el intérprete


The Python interpreter is usually installed as @code{/usr/local/bin/python3.14}
on those machines where it is available; putting @code{/usr/local/bin} in your
Unix shell’s search path makes it possible to start it by typing the command:

@example
python3.14
@end example

en el terminal @footnote{
En Unix, el intérprete de Python 3.x no está instalado por defecto con el ejecutable llamado @code{python}, por lo que no entra en conflicto con un ejecutable de Python 2.x instalado simultáneamente.
}. Ya que la elección del directorio dónde vivirá el intérprete es una opción del proceso de instalación, puede estar en otros lugares; consulta a tu gurú de Python local o administrador de sistemas. (Por ejemplo, @code{/usr/local/python} es una alternativa popular).

On Windows machines where you have installed Python from the @ref{1bed,,Microsoft Store}, the @code{python3.14} command will be available. If you have
the @ref{65f,,py.exe launcher} installed, you can use the @code{py}
command. See @ref{1bee,,Excurso; configurar variables de entorno} for other ways to launch Python.

Se puede salir del intérprete con estado de salida cero ingresando el carácter de fin de archivo (@code{Control-D} en Unix, @code{Control-Z} en Windows). Si eso no funciona, puedes salir del intérprete escribiendo el comando: @code{quit()}.

Las características para edición de líneas del intérprete incluyen edición interactiva, sustitución de historial y completado de código en sistemas que soportan la biblioteca GNU Readline@footnote{https://tiswww.case.edu/php/chet/readline/rltop.html} . Quizás la forma más rápida para comprobar si las características de edición se encuentran disponibles es presionar @code{Control-P} en el primer prompt de Python que aparezca. Si se escucha un sonido, tienes edición de línea de comandos; ver Apéndice @ref{1bef,,Edición de entrada interactiva y sustitución de historial} para una introducción a las teclas. Si parece que no ocurre nada, o si se muestra @code{^P}, estas características no están disponibles; solo vas a poder usar la tecla de retroceso (`backspace') para borrar los caracteres de la línea actual.

El intérprete funciona de manera similar al shell de Unix: cuando se le llama con una entrada estándar conectada a un terminal, lee y ejecuta comandos de manera interactiva; cuando se le llama con un argumento de nombre de archivo o con un archivo como entrada estándar, lee y ejecuta un `script' desde ese archivo.

Una segunda forma de iniciar el intérprete es @code{python -c comando [arg] ...}, que ejecuta las sentencias en `comando', similar a la opción de shell @ref{681,,-c} . Como las sentencias de Python a menudo contienen espacios u otros caracteres que son especiales para el shell, generalmente se recomienda citar `comando' en su totalidad.

Algunos módulos de Python también son útiles como scripts. Estos pueden invocarse utilizando @code{python -m módulo [arg] ...}, que ejecuta el archivo fuente para `módulo' como si se hubiera escrito el nombre completo en la línea de comandos.

Cuando se usa un script, a veces es útil poder ejecutar el script y luego ingresar al modo interactivo. Esto se puede hacer pasando la @ref{151b,,-i} antes del nombre del script.

Todas las opciones de la línea de comandos se describen en @ref{19c8,,Línea de comandos y entorno}.

@menu
* Paso de argumentos:: 
* Modo interactivo:: 

@end menu

@node Paso de argumentos,Modo interactivo,,Invocar el intérprete
@anchor{tutorial/interpreter argument-passing}@anchor{1bf0}@anchor{tutorial/interpreter tut-argpassing}@anchor{1bf1}
@subsubsection Paso de argumentos


Cuando son conocidos por el intérprete, el nombre del script y los argumentos adicionales se convierten a una lista de cadenas de texto asignada a la variable @code{argv} del módulo @code{sys}. Puedes acceder a esta lista haciendo @code{import sys}. La longitud de la lista es al menos uno; cuando no se utiliza ningún script o argumento, @code{sys.argv[0]} es una cadena vacía. Cuando se pasa el nombre del script con @code{'-'} (lo que significa la entrada estándar), @code{sys.argv[0]} vale @code{'-'}. Cuando se usa @ref{681,,-c} `comando', @code{sys.argv[0]} vale @code{'-c'}. Cuando se usa @ref{187,,-m} `módulo', @code{sys.argv[0]} contiene el valor del nombre completo del módulo. Las opciones encontradas después de @ref{681,,-c} `comando' o @ref{187,,-m} `módulo' no son consumidas por el procesador de opciones de Python pero de todas formas se almacenan en @code{sys.argv} para ser manejadas por el comando o módulo.

@node Modo interactivo,,Paso de argumentos,Invocar el intérprete
@anchor{tutorial/interpreter interactive-mode}@anchor{1bf2}@anchor{tutorial/interpreter tut-interactive}@anchor{1045}
@subsubsection Modo interactivo


Cuando se leen los comandos desde un terminal, se dice que el intérprete está en `modo interactivo'. En este modo, espera el siguiente comando con el `prompt primario', generalmente tres signos de mayor que (@code{>>>}); para las líneas de continuación, aparece el `prompt secundario', por defecto tres puntos (@code{...}). El intérprete imprime un mensaje de bienvenida que indica su número de versión y un aviso de copyright antes de imprimir el primer `prompt primario':

@example
$ python3.14
Python 3.14 (default, April 4 2024, 09:25:04)
[GCC 10.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
@end example

@c XXX update for new releases

Las líneas de continuación son necesarias cuando se ingresa una construcción multilínea. Como ejemplo, echa un vistazo a la sentencia @ref{1ec,,if}:

@example
>>> the_world_is_flat = True
>>> if the_world_is_flat:
...     print("Be careful not to fall off!")
...
Be careful not to fall off!
@end example

Para más información sobre el modo interactivo, ver @ref{2db,,Modo interactivo}.

@node El intérprete y su entorno,,Invocar el intérprete,Usando el intérprete de Python
@anchor{tutorial/interpreter the-interpreter-and-its-environment}@anchor{1bf3}@anchor{tutorial/interpreter tut-interp}@anchor{1bf4}
@subsection El intérprete y su entorno


@menu
* Codificación del código fuente:: 

@end menu

@node Codificación del código fuente,,,El intérprete y su entorno
@anchor{tutorial/interpreter source-code-encoding}@anchor{1bf5}@anchor{tutorial/interpreter tut-source-encoding}@anchor{1bf6}
@subsubsection Codificación del código fuente


De forma predeterminada, los archivos fuente de Python se tratan como codificados en UTF-8. En esa codificación, los caracteres de la mayoría de los idiomas del mundo se pueden usar simultáneamente en literales, identificadores y comentarios, aunque la biblioteca estándar solo usa caracteres ASCII para los identificadores, una convención que debería seguir cualquier código que sea portable.Para mostrar todos estos caracteres correctamente, tu editor debe reconocer que el archivo es UTF-8, y debe usar una fuente que admita todos los caracteres del archivo.

Para declarar una codificación que no sea la predeterminada, se debe agregar una línea de comentario especial como la `primera' línea del archivo. La sintaxis es la siguiente:

@example
# -*- coding: encoding -*-
@end example

donde `encoding' es uno de los @ref{1c,,codecs} soportados por Python.

Por ejemplo, para declarar que se utilizará la codificación de Windows-1252, la primera línea del archivo de código fuente debe ser:

@example
# -*- coding: cp1252 -*-
@end example

Una excepción a la regla de `primera línea' es cuando el código fuente comienza con una @ref{1bf7,,linea UNIX «shebang»}. En ese caso, la declaración de codificación debe agregarse como la segunda línea del archivo. Por ejemplo:

@example
#!/usr/bin/env python3
# -*- coding: cp1252 -*-
@end example

@subsubheading Notas al pie


@node Una introducción informal a Python,Más herramientas para control de flujo,Usando el intérprete de Python,El tutorial de Python
@anchor{tutorial/introduction doc}@anchor{1bf8}@anchor{tutorial/introduction an-informal-introduction-to-python}@anchor{1bf9}@anchor{tutorial/introduction tut-informal}@anchor{1bfa}
@section Una introducción informal a Python


En los siguientes ejemplos, la entrada y la salida se distinguen por la presencia o ausencia de prompts (@ref{2d8,,>>>} y @ref{2d9,,…}): para repetir el ejemplo, escribe todo después del prompt, cuando aparece; las líneas que no comienzan con un prompt son emitidas desde el intérprete. Ten en cuenta que en un ejemplo un prompt secundario en una linea en solitario significa que debes escribir una línea en blanco. Esto se utiliza para finalizar un comando multilínea.


@geindex # (hash);comentario

Muchos de los ejemplos de este manual, incluso aquellos ingresados en el prompt interactivo, incluyen comentarios. Los comentarios en Python comienzan con el carácter numeral, @code{#}, y se extienden hasta el final visible de la línea. Un comentario quizás aparezca al comienzo de la línea o seguido de espacios en blanco o código, pero no dentro de una cadena de caracteres. Un carácter numeral dentro de una cadena de caracteres es sólo un carácter numeral. Ya que los comentarios son para aclarar código y no son interpretados por Python, pueden omitirse cuando se escriben los ejemplos.

Algunos ejemplos:

@example
# this is the first comment
spam = 1  # and this is the second comment
          # ... and now a third!
text = "# This is not a comment because it's inside quotes."
@end example

@menu
* Usando Python como una calculadora:: 
* Primeros pasos hacia la programación:: 

@end menu

@node Usando Python como una calculadora,Primeros pasos hacia la programación,,Una introducción informal a Python
@anchor{tutorial/introduction tut-calculator}@anchor{1bfb}@anchor{tutorial/introduction using-python-as-a-calculator}@anchor{1bfc}
@subsection Usando Python como una calculadora


Probemos algunos comandos simples de Python. Inicia el intérprete y espera el prompt primario, @code{>>>}. (No debería tardar mucho.)

@menu
* Números:: 
* Texto:: 
* Listas:: 

@end menu

@node Números,Texto,,Usando Python como una calculadora
@anchor{tutorial/introduction numbers}@anchor{1bfd}@anchor{tutorial/introduction tut-numbers}@anchor{1bfe}
@subsubsection Números


El intérprete funciona como una simple calculadora: puedes introducir una expresión en él y este escribirá los valores. La sintaxis es sencilla: los operadores @code{+}, @code{-}, @code{*} y @code{/} se pueden usar para realizar operaciones aritméticas; los paréntesis (@code{()}) pueden ser usados para agrupar. Por ejemplo:

@example
>>> 2 + 2
4
>>> 50 - 5*6
20
>>> (50 - 5*6) / 4
5.0
>>> 8 / 5  # division always returns a floating-point number
1.6
@end example

Los números enteros (ej. @code{2}, @code{4}, @code{20}) tienen tipo @ref{1f0,,int}, los que tienen una parte fraccionaria (por ejemplo @code{5.0}, @code{1.6}) tiene el tipo @ref{153,,float}. Vamos a ver más acerca de los tipos numéricos más adelante en el tutorial.

La división (@code{/}) siempre retorna un número decimal de punto flotante. Para hacer @ref{9d7,,floor division} y obtener un número entero como resultado  puede usarse el operador @code{//}; para calcular el resto puedes usar @code{%}:

@example
>>> 17 / 3  # classic division returns a float
5.666666666666667
>>>
>>> 17 // 3  # floor division discards the fractional part
5
>>> 17 % 3  # the % operator returns the remainder of the division
2
>>> 5 * 3 + 2  # floored quotient * divisor + remainder
17
@end example

Con Python, es posible usar el operador @code{**} para calcular potencias @footnote{
Debido a que @code{**} tiene una prioridad mayor que @code{-}, @code{-3**2} se interpretará como @code{-(3**2)}, por lo tanto dará como resultado @code{-9}. Para evitar esto y obtener @code{9}, puedes usar @code{(-3)**2}.
}:

@example
>>> 5 ** 2  # 5 squared
25
>>> 2 ** 7  # 2 to the power of 7
128
@end example

El signo igual (@code{=}) se usa para asignar un valor a una variable. Después, no se muestra ningún resultado antes del siguiente prompt interactivo:

@example
>>> width = 20
>>> height = 5 * 9
>>> width * height
900
@end example

Si una variable no está «definida» (no se le ha asignado un valor), al intentar usarla dará un error:

@example
>>> n  # try to access an undefined variable
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'n' is not defined
@end example

Hay soporte completo de punto flotante; operadores con operando mezclados convertirán los enteros a punto flotante:

@example
>>> 4 * 3.75 - 1
14.0
@end example

En el modo interactivo, la última expresión impresa se asigna a la variable @code{_}.  Esto significa que cuando se está utilizando Python como calculadora, es más fácil seguir calculando, por ejemplo:

@example
>>> tax = 12.5 / 100
>>> price = 100.50
>>> price * tax
12.5625
>>> price + _
113.0625
>>> round(_, 2)
113.06
@end example

Esta variable debe ser tratada como de sólo lectura por el usuario. No le asignes explícitamente un valor; crearás una variable local independiente con el mismo nombre enmascarando la variable con el comportamiento mágico.

Además de @ref{1f0,,int} y @ref{153,,float}, Python admite otros tipos de números, como @ref{16a,,Decimal} y @ref{177,,Fraction}. Python también tiene soporte incorporado para @ref{1bff,,complex numbers}, y usa el sufijo @code{j} o @code{J} para indicar la parte imaginaria (por ejemplo, @code{3+5j}).

@node Texto,Listas,Números,Usando Python como una calculadora
@anchor{tutorial/introduction text}@anchor{1c00}@anchor{tutorial/introduction tut-strings}@anchor{1c01}
@subsubsection Texto


Python puede manipular texto (representado por el tipo @ref{237,,str}, conocido como «cadenas de caracteres») al igual que números. Esto incluye caracteres «@code{!}», palabras «@code{conejo}», nombres «@code{París}», oraciones «@code{¡Te tengo a la vista!}», etc. «@code{Yay! :)}». Se pueden encerrar en comillas simples (@code{'...'}) o comillas dobles (@code{"..."}) con el mismo resultado @footnote{
A diferencia de otros lenguajes, caracteres especiales como @code{\n} tienen el mismo significado con simple(@code{'...'}) y dobles (@code{"..."}) comillas. La única diferencia entre las dos es que dentro de las comillas simples no existe la necesidad de escapar @code{"} (pero tienes que escapar @code{\'}) y viceversa.
}.

@example
>>> 'spam eggs'  # single quotes
'spam eggs'
>>> "Paris rabbit got your back :)! Yay!"  # double quotes
'Paris rabbit got your back :)! Yay!'
>>> '1975'  # digits and numerals enclosed in quotes are also strings
'1975'
@end example

Para citar una cita, debemos «escapar» la cita precediéndola con @code{\}. Alternativamente, podemos usar el otro tipo de comillas:

@example
>>> 'doesn\'t'  # use \' to escape the single quote...
"doesn't"
>>> "doesn't"  # ...or use double quotes instead
"doesn't"
>>> '"Yes," they said.'
'"Yes," they said.'
>>> "\"Yes,\" they said."
'"Yes," they said.'
>>> '"Isn\'t," they said.'
'"Isn\'t," they said.'
@end example

En el intérprete de Python, la definición de cadena y la cadena de salida pueden verse diferentes. La función @ref{ff4,,print()} produce una salida más legible, omitiendo las comillas de encuadre e imprimiendo caracteres escapados y especiales:

@example
>>> s = 'First line.\nSecond line.'  # \n means newline
>>> s  # without print(), special characters are included in the string
'First line.\nSecond line.'
>>> print(s)  # with print(), special characters are interpreted, so \n produces new line
First line.
Second line.
@end example

Si no quieres que los caracteres precedidos por @code{\} se interpreten como caracteres especiales, puedes usar `cadenas sin formato' agregando una @code{r} antes de la primera comilla:

@example
>>> print('C:\some\name')  # here \n means newline!
C:\some
ame
>>> print(r'C:\some\name')  # note the r before the quote
C:\some\name
@end example

Hay un aspecto sutil en las cadenas sin formato: una cadena sin formato no puede terminar en un número impar de caracteres @code{\}; consultar @ref{1c02,,en preguntas frequentes} para obtener más información y soluciones.

String literals can span multiple lines.  One way is using triple-quotes:
@code{"""..."""} or @code{'@w{'}'...'@w{'}'}.  End of lines are automatically
included in the string, but it’s possible to prevent this by adding a @code{\} at
the end of the line.  In the following example, the initial newline is not
included:

@example
>>> print("""\
... Usage: thingy [OPTIONS]
...      -h                        Display this usage message
...      -H hostname               Hostname to connect to
... """)
Usage: thingy [OPTIONS]
     -h                        Display this usage message
     -H hostname               Hostname to connect to

>>>
@end example

Las cadenas se pueden concatenar (pegar juntas) con el operador @code{+} y se pueden repetir con @code{*}:

@example
>>> # 3 times 'un', followed by 'ium'
>>> 3 * 'un' + 'ium'
'unununium'
@end example

Dos o más `cadenas literales' (es decir, las encerradas entre comillas) una al lado de la otra se concatenan automáticamente.

@example
>>> 'Py' 'thon'
'Python'
@end example

Esta característica es particularmente útil cuando quieres dividir cadenas largas:

@example
>>> text = ('Put several strings within parentheses '
...         'to have them joined together.')
>>> text
'Put several strings within parentheses to have them joined together.'
@end example

Esto solo funciona con dos literales, no con variables ni expresiones:

@example
>>> prefix = 'Py'
>>> prefix 'thon'  # can't concatenate a variable and a string literal
  File "<stdin>", line 1
    prefix 'thon'
           ^^^^^^
SyntaxError: invalid syntax
>>> ('un' * 3) 'ium'
  File "<stdin>", line 1
    ('un' * 3) 'ium'
               ^^^^^
SyntaxError: invalid syntax
@end example

Si quieres concatenar variables o una variable y un literal, usa @code{+}:

@example
>>> prefix + 'thon'
'Python'
@end example

Las cadenas de texto se pueden `indexar' (subíndices), el primer carácter de la cadena tiene el índice 0. No hay un tipo de dato diferente para los caracteres; un carácter es simplemente una cadena de longitud uno:

@example
>>> word = 'Python'
>>> word[0]  # character in position 0
'P'
>>> word[5]  # character in position 5
'n'
@end example

Los índices también pueden ser números negativos, para empezar a contar desde la derecha:

@example
>>> word[-1]  # last character
'n'
>>> word[-2]  # second-last character
'o'
>>> word[-6]
'P'
@end example

Nótese que -0 es lo mismo que 0, los índice negativos comienzan desde -1.

Además de los índices, las `rebanadas' (slicing) también están soportadas. Mientras que la indexación se utiliza para obtener caracteres individuales, `rebanar' te permite obtener una subcadena:

@example
>>> word[0:2]  # characters from position 0 (included) to 2 (excluded)
'Py'
>>> word[2:5]  # characters from position 2 (included) to 5 (excluded)
'tho'
@end example

Los índices de las rebanadas tienen valores por defecto útiles; el valor por defecto para el primer índice es cero, el valor por defecto para el segundo índice es la longitud de la cadena a rebanar.

@example
>>> word[:2]   # character from the beginning to position 2 (excluded)
'Py'
>>> word[4:]   # characters from position 4 (included) to the end
'on'
>>> word[-2:]  # characters from the second-last (included) to the end
'on'
@end example

Nótese cómo el inicio siempre se incluye y el final siempre se excluye. Esto asegura que @code{s[:i] + s[i:]} siempre sea igual a @code{s}:

@example
>>> word[:2] + word[2:]
'Python'
>>> word[:4] + word[4:]
'Python'
@end example

Una forma de recordar cómo funcionan las rebanadas es pensar que los índices apuntan `entre' caracteres, con el borde izquierdo del primer carácter numerado 0. Luego, el punto derecho del último carácter de una cadena de `n' caracteres tiene un índice `n', por ejemplo

@example
 +---+---+---+---+---+---+
 | P | y | t | h | o | n |
 +---+---+---+---+---+---+
 0   1   2   3   4   5   6
-6  -5  -4  -3  -2  -1
@end example

La primera fila de números da la posición de los índices 0…6 en la cadena; La segunda fila da los correspondientes indices negativos. La rebanada desde `i' hasta `j' consta de todos los caracteres entre los bordes etiquetados `i' y `j', respectivamente.

Para índices no negativos, la longitud de la rebanada es la diferencia de los índices, si ambos están dentro de los límites. Por ejemplo, la longitud de @code{word[1:3]} es 2.

Intentar usar un índice que es muy grande resultará en un error:

@example
>>> word[42]  # the word only has 6 characters
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
IndexError: string index out of range
@end example

Sin embargo, los índices de rebanadas fuera de rango se manejan satisfactoriamente cuando se usan para rebanar:

@example
>>> word[4:42]
'on'
>>> word[42:]
'@w{'}
@end example

Las cadenas de Python no se pueden modificar, son @ref{1c03,,immutable}. Por eso, asignar a una posición indexada de la cadena resulta en un error:

@example
>>> word[0] = 'J'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
>>> word[2:] = 'py'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
@end example

Si necesitas una cadena diferente, deberías crear una nueva:

@example
>>> 'J' + word[1:]
'Jython'
>>> word[:2] + 'py'
'Pypy'
@end example

La función incorporada @ref{6cf,,len()} retorna la longitud de una cadena:

@example
>>> s = 'supercalifragilisticexpialidocious'
>>> len(s)
34
@end example


@subsubheading Ver también



@table @asis

@item @ref{1c04,,Cadenas de caracteres — str}

Las cadenas de texto son ejemplos de `tipos secuencias' y soportan las operaciones comunes para esos tipos.

@item @ref{1c05,,Métodos de las cadenas de caracteres}

Las cadenas de texto soportan una gran cantidad de métodos para transformaciones básicas y búsqueda.

@item @ref{a3b,,f-strings}

Literales de cadena que tienen expresiones embebidas.

@item @ref{13f0,,Sintaxis de formateo de cadena}

Aquí se da información sobre formateo de cadenas de texto con @ref{6c2,,str.format()}.

@item @ref{76d,,Formateo de cadenas al estilo *printf*}

Aquí se describen con más detalle las antiguas operaciones para formateo utilizadas cuando una cadena de texto está a la izquierda del operador @code{%}.
@end table


@node Listas,,Texto,Usando Python como una calculadora
@anchor{tutorial/introduction lists}@anchor{1c06}@anchor{tutorial/introduction tut-lists}@anchor{1c07}
@subsubsection Listas


Python tiene varios tipos de datos `compuestos', utilizados para agrupar otros valores. El más versátil es la `lista', la cual puede ser escrita como una lista de valores separados por coma (ítems) entre corchetes. Las listas pueden contener ítems de diferentes tipos, pero usualmente los ítems son del mismo tipo.

@example
>>> squares = [1, 4, 9, 16, 25]
>>> squares
[1, 4, 9, 16, 25]
@end example

Al igual que las cadenas (y todas las demás tipos integrados @ref{597,,sequence}), las listas se pueden indexar y segmentar:

@example
>>> squares[0]  # indexing returns the item
1
>>> squares[-1]
25
>>> squares[-3:]  # slicing returns a new list
[9, 16, 25]
@end example

Las listas también admiten operaciones como concatenación:

@example
>>> squares + [36, 49, 64, 81, 100]
[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]
@end example

A diferencia de las cadenas, que son @ref{1c03,,immutable}, las listas son de tipo @ref{1c08,,mutable}, es decir, es posible cambiar su contenido:

@example
>>> cubes = [1, 8, 27, 65, 125]  # something's wrong here
>>> 4 ** 3  # the cube of 4 is 64, not 65!
64
>>> cubes[3] = 64  # replace the wrong value
>>> cubes
[1, 8, 27, 64, 125]
@end example

You can also add new items at the end of the list, by using
the @code{list.append()} `method' (we will see more about methods later):

@example
>>> cubes.append(216)  # add the cube of 6
>>> cubes.append(7 ** 3)  # and the cube of 7
>>> cubes
[1, 8, 27, 64, 125, 216, 343]
@end example

Simple assignment in Python never copies data. When you assign a list
to a variable, the variable refers to the `existing list'.
Any changes you make to the list through one variable will be seen
through all other variables that refer to it.:

@example
>>> rgb = ["Red", "Green", "Blue"]
>>> rgba = rgb
>>> id(rgb) == id(rgba)  # they reference the same object
True
>>> rgba.append("Alph")
>>> rgb
["Red", "Green", "Blue", "Alph"]
@end example

Todas las operaciones de rebanado retornan una nueva lista que contiene los elementos pedidos. Esto significa que la siguiente rebanada retorna una @ref{1c09,,shallow copy} de la lista:

@example
>>> correct_rgba = rgba[:]
>>> correct_rgba[-1] = "Alpha"
>>> correct_rgba
["Red", "Green", "Blue", "Alpha"]
>>> rgba
["Red", "Green", "Blue", "Alph"]
@end example

También es posible asignar a una rebanada, y esto incluso puede cambiar la longitud de la lista o vaciarla totalmente:

@example
>>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> letters
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> # replace some values
>>> letters[2:5] = ['C', 'D', 'E']
>>> letters
['a', 'b', 'C', 'D', 'E', 'f', 'g']
>>> # now remove them
>>> letters[2:5] = []
>>> letters
['a', 'b', 'f', 'g']
>>> # clear the list by replacing all the elements with an empty list
>>> letters[:] = []
>>> letters
[]
@end example

La función predefinida @ref{6cf,,len()} también sirve para las listas

@example
>>> letters = ['a', 'b', 'c', 'd']
>>> len(letters)
4
@end example

Es posible anidar listas (crear listas que contengan otras listas), por ejemplo:

@example
>>> a = ['a', 'b', 'c']
>>> n = [1, 2, 3]
>>> x = [a, n]
>>> x
[['a', 'b', 'c'], [1, 2, 3]]
>>> x[0]
['a', 'b', 'c']
>>> x[0][1]
'b'
@end example

@node Primeros pasos hacia la programación,,Usando Python como una calculadora,Una introducción informal a Python
@anchor{tutorial/introduction first-steps-towards-programming}@anchor{1c0a}@anchor{tutorial/introduction tut-firststeps}@anchor{1c0b}
@subsection Primeros pasos hacia la programación


Of course, we can use Python for more complicated tasks than adding two and two
together.  For instance, we can write an initial sub-sequence of the
Fibonacci series@footnote{https://en.wikipedia.org/wiki/Fibonacci_sequence}
as follows:

@example
>>> # Fibonacci series:
>>> # the sum of two elements defines the next
>>> a, b = 0, 1
>>> while a < 10:
...     print(a)
...     a, b = b, a+b
...
0
1
1
2
3
5
8
@end example

Este ejemplo introduce varias características nuevas.


@itemize *

@item 
La primera línea contiene una `asignación múltiple': las variables @code{a} y @code{b} obtienen simultáneamente los nuevos valores 0 y 1. En la última línea esto se usa nuevamente, demostrando que las expresiones de la derecha son evaluadas primero antes de que se realice cualquiera de las asignaciones. Las expresiones del lado derecho se evalúan de izquierda a derecha.

@item 
El bucle @ref{1611,,while} se ejecuta mientras la condición (aquí: @code{a < 10}) sea verdadera. En Python, como en C, cualquier valor entero que no sea cero es verdadero; cero es falso. La condición también puede ser una cadena de texto o una lista, de hecho, cualquier secuencia; cualquier cosa con una longitud distinta de cero es verdadera, las secuencias vacías son falsas. La prueba utilizada en el ejemplo es una comparación simple. Los operadores de comparación estándar se escriben igual que en C: @code{<} (menor que), @code{>} (mayor que), @code{==} (igual a), @code{<=} (menor que o igual a), @code{>=} (mayor que o igual a) y @code{!=} (distinto a).

@item 
El cuerpo del bucle está `indentado': la indentación es la forma que usa Python para agrupar declaraciones. En el intérprete interactivo debes teclear un tabulador o espacio(s) para cada línea indentada. En la práctica vas a preparar entradas más complicadas para Python con un editor de texto; todos los editores de texto modernos tienen la facilidad de agregar la indentación automáticamente. Cuando se ingresa una instrucción compuesta de forma interactiva, se debe finalizar con una línea en blanco para indicar que está completa (ya que el analizador no puede adivinar cuando tecleaste la última línea). Nota que cada línea de un bloque básico debe estar sangrada de la misma forma.

@item 
The @ref{ff4,,print()} function writes the value of the argument(s) it is given.
It differs from just writing the expression you want to write (as we did
earlier in the calculator examples) in the way it handles multiple arguments,
floating-point quantities, and strings.  Strings are printed without quotes,
and a space is inserted between items, so you can format things nicely, like
this:

@example
>>> i = 256*256
>>> print('The value of i is', i)
The value of i is 65536
@end example

El parámetro nombrado `end' puede usarse para evitar el salto de linea al final de la salida, o terminar la salida con una cadena diferente:

@example
>>> a, b = 0, 1
>>> while a < 1000:
...     print(a, end=',')
...     a, b = b, a+b
...
0,1,1,2,3,5,8,13,21,34,55,89,144,233,377,610,987,
@end example
@end itemize

@subsubheading Notas al pie


@node Más herramientas para control de flujo,Estructuras de datos,Una introducción informal a Python,El tutorial de Python
@anchor{tutorial/controlflow doc}@anchor{1c0c}@anchor{tutorial/controlflow more-control-flow-tools}@anchor{1c0d}@anchor{tutorial/controlflow tut-morecontrol}@anchor{1c0e}
@section Más herramientas para control de flujo


Además de la sentencia @ref{1611,,while} que acabamos de introducir, Python utiliza algunas más que encontraremos en este capítulo.

@menu
* La sentencia if:: 
* La sentencia for:: 
* La función range(): La función range. 
* break and continue Statements:: 
* else Clauses on Loops:: 
* La sentencia pass:: 
* La sentencia match:: 
* Definir funciones:: 
* Más sobre definición de funciones:: 
* Intermezzo; Estilo de programación: Intermezzo Estilo de programación. 

@end menu

@node La sentencia if,La sentencia for,,Más herramientas para control de flujo
@anchor{tutorial/controlflow if-statements}@anchor{1c0f}@anchor{tutorial/controlflow tut-if}@anchor{1c10}
@subsection La sentencia @code{if}


Tal vez el tipo más conocido de sentencia sea el @ref{1ec,,if}. Por ejemplo:

@example
>>> x = int(input("Please enter an integer: "))
Please enter an integer: 42
>>> if x < 0:
...     x = 0
...     print('Negative changed to zero')
... elif x == 0:
...     print('Zero')
... elif x == 1:
...     print('Single')
... else:
...     print('More')
...
More
@end example

Puede haber cero o más bloques @ref{1c11,,elif}, y el bloque @ref{1ea,,else} es opcional. La palabra reservada @code{elif} es una abreviación de “else if”, y es útil para evitar un sangrado excesivo. Una secuencia @code{if} … @code{elif} … @code{elif} … sustituye las sentencias @code{switch} o @code{case} encontradas en otros lenguajes.

Si necesitas comparar un mismo valor con muchas constantes, o comprobar que tenga un tipo o atributos específicos puede que encuentres útil la sentencia @code{match}. Para más detalles véase @ref{1c12,,La sentencia match}.

@node La sentencia for,La función range,La sentencia if,Más herramientas para control de flujo
@anchor{tutorial/controlflow for-statements}@anchor{1c13}@anchor{tutorial/controlflow tut-for}@anchor{1c14}
@subsection La sentencia @code{for}


@geindex statement;for

La sentencia @ref{1eb,,for} en Python difiere un poco de lo que uno puede estar acostumbrado en lenguajes como C o Pascal. En lugar de siempre iterar sobre una progresión aritmética de números (como en Pascal) o darle al usuario la posibilidad de definir tanto el paso de la iteración como la condición de fin (como en C), la sentencia @code{for} de Python itera sobre los ítems de cualquier secuencia (una lista o una cadena de texto), en el orden que aparecen en la secuencia. Por ejemplo:

@c One suggestion was to give a real C example here, but that may only serve to
@c confuse non-C programmers.

@example
>>> # Measure some strings:
>>> words = ['cat', 'window', 'defenestrate']
>>> for w in words:
...     print(w, len(w))
...
cat 3
window 6
defenestrate 12
@end example

Código que modifica una colección mientras se itera sobre la misma colección puede ser complejo de hacer bien. Sin embargo, suele ser más directo iterar sobre una copia de la colección o crear una nueva colección:

@example
# Create a sample collection
users = @{'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'@}

# Strategy:  Iterate over a copy
for user, status in users.copy().items():
    if status == 'inactive':
        del users[user]

# Strategy:  Create a new collection
active_users = @{@}
for user, status in users.items():
    if status == 'active':
        active_users[user] = status
@end example

@node La función range,break and continue Statements,La sentencia for,Más herramientas para control de flujo
@anchor{tutorial/controlflow the-range-function}@anchor{1c15}@anchor{tutorial/controlflow tut-range}@anchor{1c16}
@subsection La función @code{range()}


Si se necesita iterar sobre una secuencia de números, es apropiado utilizar la función integrada @ref{9d6,,range()}, la cual genera progresiones aritméticas:

@example
>>> for i in range(5):
...     print(i)
...
0
1
2
3
4
@end example

El valor final dado nunca es parte de la secuencia; @code{range(10)} genera 10 valores, los índices correspondientes para los ítems de una secuencia de longitud 10. Es posible hacer que el rango empiece con otro número, o especificar un incremento diferente (incluso negativo; algunas veces se lo llama “paso”):

@example
>>> list(range(5, 10))
[5, 6, 7, 8, 9]

>>> list(range(0, 10, 3))
[0, 3, 6, 9]

>>> list(range(-10, -100, -30))
[-10, -40, -70]
@end example

Para iterar sobre los índices de una secuencia, puedes combinar @ref{9d6,,range()} y @ref{6cf,,len()} así:

@example
>>> a = ['Mary', 'had', 'a', 'little', 'lamb']
>>> for i in range(len(a)):
...     print(i, a[i])
...
0 Mary
1 had
2 a
3 little
4 lamb
@end example

En la mayoría de los casos, sin embargo, conviene usar la función @ref{14bb,,enumerate()}, ver @ref{1c17,,Técnicas de iteración}.

Algo extraño sucede si tan sólo muestras un @code{range}:

@example
>>> range(10)
range(0, 10)
@end example

El objeto retornado por @ref{9d6,,range()} se comporta de muchas maneras como si fuera una lista, pero no lo es. Es un objeto que retorna los ítems sucesivos de la secuencia deseada cuando iteras sobre él, pero realmente no construye la lista, ahorrando entonces espacio.

Decimos que tal objeto es @ref{1294,,iterable}; esto es, que se puede usar en funciones y construcciones que esperan algo de lo cual obtener ítems sucesivos hasta que se termine. Hemos visto que la declaración @ref{1eb,,for} es una de esas construcciones, mientras que un ejemplo de función que toma un iterable es la función @ref{515,,sum()}:

@example
>>> sum(range(4))  # 0 + 1 + 2 + 3
6
@end example

Más adelante veremos otras funciones que aceptan iterables cómo argumentos o retornan iterables. En el capítulo @ref{1c18,,Estructuras de datos}, discutiremos en más detalle sobre la @ref{18e,,list()}.

@node break and continue Statements,else Clauses on Loops,La función range,Más herramientas para control de flujo
@anchor{tutorial/controlflow break-and-continue-statements}@anchor{1c19}@anchor{tutorial/controlflow tut-break}@anchor{1c1a}
@subsection @code{break} and @code{continue} Statements


The @ref{b34,,break} statement breaks out of the innermost enclosing
@ref{1eb,,for} or @ref{1611,,while} loop:

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(f"@{n@} equals @{x@} * @{n//x@}")
...             break
...
4 equals 2 * 2
6 equals 2 * 3
8 equals 2 * 4
9 equals 3 * 3
@end example

The @ref{a5b,,continue} statement continues with the next
iteration of the loop:

@example
>>> for num in range(2, 10):
...     if num % 2 == 0:
...         print(f"Found an even number @{num@}")
...         continue
...     print(f"Found an odd number @{num@}")
...
Found an even number 2
Found an odd number 3
Found an even number 4
Found an odd number 5
Found an even number 6
Found an odd number 7
Found an even number 8
Found an odd number 9
@end example
@anchor{tutorial/controlflow tut-for-else}@anchor{1c1b}
@node else Clauses on Loops,La sentencia pass,break and continue Statements,Más herramientas para control de flujo
@anchor{tutorial/controlflow break-and-continue-statements-and-else-clauses-on-loops}@anchor{1c1c}@anchor{tutorial/controlflow else-clauses-on-loops}@anchor{1c1d}
@subsection @code{else} Clauses on Loops


In a @code{for} or @code{while} loop the @code{break} statement
may be paired with an @code{else} clause.  If the loop finishes without
executing the @code{break}, the @code{else} clause executes.

In a @ref{1eb,,for} loop, the @code{else} clause is executed
after the loop finishes its final iteration, that is, if no break occurred.

En un bucle @ref{1611,,while}, se ejecuta después de que la condición del bucle se vuelva falsa.

In either kind of loop, the @code{else} clause is `not' executed if the
loop was terminated by a @ref{b34,,break}.  Of course, other ways of ending the
loop early, such as a @ref{a60,,return} or a raised exception, will also skip
execution of the @ref{1ea,,else} clause.

Esto se ejemplifica en el siguiente bucle @code{for}, que busca números primos:

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(n, 'equals', x, '*', n//x)
...             break
...     else:
...         # loop fell through without finding a factor
...         print(n, 'is a prime number')
...
2 is a prime number
3 is a prime number
4 equals 2 * 2
5 is a prime number
6 equals 2 * 3
7 is a prime number
8 equals 2 * 4
9 equals 3 * 3
@end example

(Yes, this is the correct code.  Look closely: the @code{else} clause belongs to
the @code{for} loop, `not' the @code{if} statement.)

One way to think of the else clause is to imagine it paired with the @code{if}
inside the loop.  As the loop executes, it will run a sequence like
if/if/if/else. The @code{if} is inside the loop, encountered a number of times. If
the condition is ever true, a @code{break} will happen. If the condition is never
true, the @code{else} clause outside the loop will execute.

When used with a loop, the @code{else} clause has more in common with the @code{else}
clause of a @ref{789,,try} statement than it does with that of @code{if}
statements: a @code{try} statement’s @code{else} clause runs when no exception
occurs, and a loop’s @code{else} clause runs when no @code{break} occurs. For more on
the @code{try} statement and exceptions, see @ref{1c1e,,Gestionando excepciones}.

@node La sentencia pass,La sentencia match,else Clauses on Loops,Más herramientas para control de flujo
@anchor{tutorial/controlflow pass-statements}@anchor{1c1f}@anchor{tutorial/controlflow tut-pass}@anchor{1c20}
@subsection La sentencia @code{pass}


La sentencia @ref{1c21,,pass} no hace nada. Se puede usar cuando una sentencia es requerida por la sintaxis pero el programa no requiere ninguna acción. Por ejemplo:

@example
>>> while True:
...     pass  # Busy-wait for keyboard interrupt (Ctrl+C)
...
@end example

Se usa normalmente para crear clases en su mínima expresión:

@example
>>> class MyEmptyClass:
...     pass
...
@end example

Otro lugar donde se puede usar @ref{1c21,,pass} es como una marca de lugar para una función o un cuerpo condicional cuando estás trabajando en código nuevo, lo cual te permite pensar a un nivel de abstracción mayor. El @code{pass} se ignora silenciosamente:

@example
>>> def initlog(*args):
...     pass   # Remember to implement this!
...
@end example

@node La sentencia match,Definir funciones,La sentencia pass,Más herramientas para control de flujo
@anchor{tutorial/controlflow match-statements}@anchor{1c22}@anchor{tutorial/controlflow tut-match}@anchor{1c12}
@subsection La sentencia @code{match}


Una sentencia @ref{8a4,,match} recibe una expresión y compara su valor con patrones sucesivos dados en uno o más bloques case. Esto es similar a grandes rasgos con una sentencia switch en C, Java o JavaScript (y muchos otros lenguajes) pero es más similar a la comparación de patrones en lenguajes como Rust o Haskell. Sólo se ejecuta el primer patrón que coincide y también es capaz de extraer componentes (elementos de una secuencia o atributos de un objeto) de un valor y ponerlos en variables.

La forma más simple compara un valor expuesto con uno o más literales:

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
        case _:
            return "Something's wrong with the internet"
@end example

Observa el último bloque: el «nombre de variable» @code{_} funciona como un `comodín' y nunca fracasa la coincidencia. Si ninguno de los casos @code{case} coincide, ninguna de las ramas es ejecutada.

Se pueden combinar varios literales en un solo patrón usando @code{|} («o»):

@example
case 401 | 403 | 404:
    return "Not allowed"
@end example

Los patrones pueden también verse como asignaciones que desempaquetan, y pueden usarse para ligar variables:

@example
# point is an (x, y) tuple
match point:
    case (0, 0):
        print("Origin")
    case (0, y):
        print(f"Y=@{y@}")
    case (x, 0):
        print(f"X=@{x@}")
    case (x, y):
        print(f"X=@{x@}, Y=@{y@}")
    case _:
        raise ValueError("Not a point")
@end example

¡Observa éste caso con cuidado! El primer patrón tiene dos literales y puede considerarse una extensión del patrón literal que se mostró anteriormente. Pero los siguientes dos patrones combinan un literal y una variable, y la variable `liga' uno de los elementos del sujeto (@code{point}). El cuarto patrón captura ambos elementos, lo que lo hace conceptualmente similar a la asignación que desempaqueta @code{(x, y) = point}.

Si estás usando clases para estructurar tus datos, puedes usar el nombre de la clase seguida de una lista de argumentos similar a la de un constructor, pero con la capacidad de capturar atributos en variables:

@example
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

def where_is(point):
    match point:
        case Point(x=0, y=0):
            print("Origin")
        case Point(x=0, y=y):
            print(f"Y=@{y@}")
        case Point(x=x, y=0):
            print(f"X=@{x@}")
        case Point():
            print("Somewhere else")
        case _:
            print("Not a point")
@end example

Puedes usar argumentos posicionales en algunas clases incorporadas que proveen un orden para sus atributos (por ej. dataclasses). También puedes definir una posición especifica para los atributos de los patrones si asignas en tu clase el atributo especial @code{__match_args__}. Si le asignas («x», «y»), los siguientes patrones son todos equivalentes entre sí (y todos ligan el atributo @code{y} a la variable @code{var}):

@example
Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
@end example

Una recomendación para leer patrones es verlos como una forma extendida de lo que pondrías en el lado izquierdo de una asignación, para así entender cuáles variables tomarían qué valores. Sólo los nombres que aparecen por si solos (cómo @code{var} arriba) son asignados por una sentencia match. Nunca se asigna a los nombres con puntos (como @code{foo.bar}), nombres de atributos (los @code{x=} e @code{y=} arriba) o nombres de clases (reconocidos por los «(…)» junto a ellos, como @code{Point} arriba).

Los patrones pueden anidarse arbitrariamente. Por ejemplo, si tuviéramos una lista corta de puntos, con @code{__match_args__} añadido, podríamos aplicar match así:

@example
class Point:
    __match_args__ = ('x', 'y')
    def __init__(self, x, y):
        self.x = x
        self.y = y

match points:
    case []:
        print("No points")
    case [Point(0, 0)]:
        print("The origin")
    case [Point(x, y)]:
        print(f"Single point @{x@}, @{y@}")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Two on the Y axis at @{y1@}, @{y2@}")
    case _:
        print("Something else")
@end example

Podemos añadir una clausula @code{if} a un patrón, conocida como «guarda». Si la guarda es falsa, @code{match} pasa a intentar el siguiente bloque case. Obsérvese que la captura de valores sucede antes de que la guarda sea evaluada:

@example
match point:
    case Point(x, y) if x == y:
        print(f"Y=X at @{x@}")
    case Point(x, y):
        print(f"Not on the diagonal")
@end example

Algunas otras propiedades importantes de esta sentencia:


@itemize -

@item 
Al igual que las asignaciones con desempaquetado, los patrones de lista o tupla tienen exactamente el mismo sentido y realmente coinciden con cualquier secuencia arbitraria. Una excepción importante es que no coinciden ni con iteradores ni con cadenas de caracteres.

@item 
Los patrones de secuencia soportan desempaquetado extendido: @code{[x, y, *otros]} y @code{(x, y, *otros)} funcionan de manera similar a las asignaciones con desempaquetado.  El nombre luego de @code{*} también puede ser @code{_}, con lo cual @code{(x, y, *_)} coincide con cualquier secuencia de al menos dos elementos, sin ligar ninguno de los demás elementos.

@item 
Los patrones de mapeo: @code{@{"ancho_de_banda": c, "latencia": l@}} capturan los valores @code{"ancho_de_banda"} y @code{"latencia"} de un diccionario. A diferencia de los patrones de secuencia, las claves adicionales son ignoradas. Puede usarse un desempaquetado como @code{**otros} . (Aunque @code{**_} sería redundante, con lo cual no está permitido)

@item 
Pueden capturarse subpatrones usando la palabra clave @code{as}:

@example
case (Point(x1, y1), Point(x2, y2) as p2): ...
@end example

capturará el segundo elemento de la entrada en @code{p2} (siempre y cuando la entrada sea una secuencia de dos puntos)

@item 
La mayoría de los literales se comparan por igualdad, pero las instancias únicas @code{True}, @code{False} y @code{None} se comparan por identidad.

@item 
En un patrón pueden usarse constantes con nombres. Los nombres deben tener puntos para impedir que sean interpretados como variables a capturar:

@example
from enum import Enum
class Color(Enum):
    RED = 'red'
    GREEN = 'green'
    BLUE = 'blue'

color = Color(input("Enter your choice of 'red', 'blue' or 'green': "))

match color:
    case Color.RED:
        print("I see red!")
    case Color.GREEN:
        print("Grass is green")
    case Color.BLUE:
        print("I'm feeling the blues :(")
@end example
@end itemize

Para una explicación más detallada y más ejemplos, puede leerse 
@geindex Python Enhancement Proposals; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} que está escrita en un formato de tutorial.

@node Definir funciones,Más sobre definición de funciones,La sentencia match,Más herramientas para control de flujo
@anchor{tutorial/controlflow defining-functions}@anchor{1c23}@anchor{tutorial/controlflow tut-functions}@anchor{1c24}
@subsection Definir funciones


Podemos crear una función que escriba la serie de Fibonacci hasta un límite determinado:

@example
>>> def fib(n):    # write Fibonacci series less than n
...     """Print a Fibonacci series less than n."""
...     a, b = 0, 1
...     while a < n:
...         print(a, end=' ')
...         a, b = b, a+b
...     print()
...
>>> # Now call the function we just defined:
>>> fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
@end example

@geindex documentation strings
@geindex docstrings
@geindex strings@comma{} documentation

La palabra reservada @ref{1497,,def} se usa para definir funciones. Debe seguirle el nombre de la función y la lista de parámetros formales entre paréntesis. Las sentencias que forman el cuerpo de la función empiezan en la línea siguiente, y deben estar con sangría.

La primera sentencia del cuerpo de la función puede ser opcionalmente una cadena de texto literal; esta es la cadena de texto de documentación de la función, o `docstring'. (Puedes encontrar más acerca de docstrings en la sección @ref{1c25,,Cadenas de texto de documentación}.). Existen herramientas que usan las @code{docstrings} para producir documentación imprimible o disponible en línea, o para dejar que los usuarios busquen interactivamente a través del código; es una buena práctica incluir @code{docstrings} en el código que escribes, así que acostúmbrate a hacerlo.

La `ejecución' de una función introduce una nueva tabla de símbolos usada para las variables locales de la función. Más precisamente, todas las asignaciones de variables en la función almacenan el valor en la tabla de símbolos local; así mismo la referencia a variables primero mira la tabla de símbolos local, luego en la tabla de símbolos local de las funciones externas, luego la tabla de símbolos global, y finalmente la tabla de nombres predefinidos. Así, a variables globales y a variables de funciones que engloban a una función no se les puede asignar directamente un valor dentro de una función (a menos que se las nombre en la sentencia @ref{2f5,,global}, o mediante la sentencia @ref{1313,,nonlocal} para variables de funciones que engloban la función local), aunque si pueden ser referenciadas.

Los parámetros reales (argumentos) para una llamada de función se introducen en la tabla de símbolos local de la función llamada cuando ésta se llama; por lo tanto, los argumentos se pasan usando `llamada por valor' (donde el `valor' es siempre una `referencia' al objeto, no el valor del objeto). @footnote{
En realidad, `llamadas por referencia de objeto' sería una mejor descripción, ya que si se pasa un objeto mutable, quien realiza la llamada verá cualquier cambio que se realice sobre el mismo (por ejemplo ítems insertados en una lista).
} Cuando una función llama a otra función, o se llama a sí misma de forma recursiva, se crea una nueva tabla de símbolos locales para esa llamada.

Una definición de función asocia el nombre de la función con el objeto de función en la tabla de símbolos actual. El intérprete reconoce el objeto al que apunta ese nombre como una función definida por el usuario. Otros nombres también pueden apuntar a ese mismo objeto de función y también se pueden usar para acceder a la función:

@example
>>> fib
<function fib at 10042ed0>
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89
@end example

Viniendo de otros lenguajes, puedes objetar que @code{fib} no es una función, sino un procedimiento, porque no retorna un valor. De hecho, técnicamente hablando, los procedimientos sin @ref{a60,,return} sí retornan un valor, aunque uno bastante aburrido. Este valor se llama @code{None} (es un nombre predefinido). El intérprete por lo general no escribe el valor @code{None} si va a ser el único valor escrito. Puede verlo si realmente lo desea utilizando @ref{ff4,,print()}:

@example
>>> fib(0)
>>> print(fib(0))
None
@end example

Es simple escribir una función que retorne una lista con los números de la serie de Fibonacci en lugar de imprimirlos:

@example
>>> def fib2(n):  # return Fibonacci series up to n
...     """Return a list containing the Fibonacci series up to n."""
...     result = []
...     a, b = 0, 1
...     while a < n:
...         result.append(a)    # see below
...         a, b = b, a+b
...     return result
...
>>> f100 = fib2(100)    # call it
>>> f100                # write the result
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
@end example

Este ejemplo, como es usual, demuestra algunas características más de Python:


@itemize *

@item 
La sentencia @ref{a60,,return} retorna un valor en una función. @code{return} sin una expresión como argumento retorna @code{None}. Si se alcanza el final de una función, también se retorna @code{None}.

@item 
La sentencia @code{result.append(a)} llama a un `método' del objeto lista @code{result}. Un método es una función que “pertenece” a un objeto y se nombra @code{obj.methodname}, dónde @code{obj} es algún objeto (puede ser una expresión), y @code{methodname} es el nombre del método que está definido por el tipo del objeto. Distintos tipos definen distintos métodos. Métodos de diferentes tipos pueden tener el mismo nombre sin causar ambigüedad. (Es posible definir tus propios tipos de objetos y métodos, usando `clases', ver @ref{1c26,,Clases}). El método @code{append()} mostrado en el ejemplo está definido para objetos lista; añade un nuevo elemento al final de la lista. En este ejemplo es equivalente a @code{result = result + [a]}, pero más eficiente.
@end itemize

@node Más sobre definición de funciones,Intermezzo Estilo de programación,Definir funciones,Más herramientas para control de flujo
@anchor{tutorial/controlflow more-on-defining-functions}@anchor{1c27}@anchor{tutorial/controlflow tut-defining}@anchor{1c28}
@subsection Más sobre definición de funciones


También es posible definir funciones con un número variable de argumentos. Hay tres formas que pueden ser combinadas.

@menu
* Argumentos con valores por omisión:: 
* Palabras claves como argumentos:: 
* Parámetros especiales:: 
* Listas de argumentos arbitrarios:: 
* Desempaquetando una lista de argumentos:: 
* Expresiones lambda:: 
* Cadenas de texto de documentación:: 
* Anotación de funciones:: 

@end menu

@node Argumentos con valores por omisión,Palabras claves como argumentos,,Más sobre definición de funciones
@anchor{tutorial/controlflow default-argument-values}@anchor{1c29}@anchor{tutorial/controlflow tut-defaultargs}@anchor{1c2a}
@subsubsection Argumentos con valores por omisión


La forma más útil es especificar un valor por omisión para uno o más argumentos. Esto crea una función que puede ser llamada con menos argumentos que los que permite. Por ejemplo:

@example
def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        reply = input(prompt)
        if reply in @{'y', 'ye', 'yes'@}:
            return True
        if reply in @{'n', 'no', 'nop', 'nope'@}:
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        print(reminder)
@end example

Esta función puede ser llamada de distintas maneras:


@itemize *

@item 
pasando sólo el argumento obligatorio: @code{ask_ok('Do you really want to quit?')}

@item 
pasando uno de los argumentos opcionales: @code{ask_ok('OK to overwrite the file?', 2)}

@item 
o pasando todos los argumentos: @code{ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')}
@end itemize

Este ejemplo también introduce la palabra reservada @ref{1ed,,in}, la cual prueba si una secuencia contiene o no un determinado valor.

Los valores por omisión son evaluados en el momento de la definición de la función en el ámbito de la definición, entonces:

@example
i = 5

def f(arg=i):
    print(arg)

i = 6
f()
@end example

imprimirá @code{5}.

`Advertencia importante:' El valor por omisión es evaluado solo una vez. Existe una diferencia cuando el valor por omisión es un objeto mutable como una lista, diccionario, o instancia de la mayoría de las clases. Por ejemplo, la siguiente función acumula los argumentos que se le pasan en subsiguientes llamadas:

@example
def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))
@end example

Imprimirá

@example
[1]
[1, 2]
[1, 2, 3]
@end example

Si no se quiere que el valor por omisión sea compartido entre subsiguientes llamadas, se pueden escribir la función así:

@example
def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L
@end example

@node Palabras claves como argumentos,Parámetros especiales,Argumentos con valores por omisión,Más sobre definición de funciones
@anchor{tutorial/controlflow keyword-arguments}@anchor{1c2b}@anchor{tutorial/controlflow tut-keywordargs}@anchor{1c2c}
@subsubsection Palabras claves como argumentos


Las funciones también puede ser llamadas usando @ref{d99,,argumentos de palabras clave} (o argumentos nombrados) de la forma @code{kwarg=value}. Por ejemplo, la siguiente función:

@example
def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
    print("-- This parrot wouldn't", action, end=' ')
    print("if you put", voltage, "volts through it.")
    print("-- Lovely plumage, the", type)
    print("-- It's", state, "!")
@end example

…acepta un argumento obligatorio (@code{voltage})) y tres argumentos opcionales (@code{state}, @code{action}, y @code{type}). Esta función puede llamarse de cualquiera de las siguientes maneras:

@example
parrot(1000)                                          # 1 positional argument
parrot(voltage=1000)                                  # 1 keyword argument
parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword
@end example

…pero estas otras llamadas serían todas inválidas:

@example
parrot()                     # required argument missing
parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
parrot(110, voltage=220)     # duplicate value for the same argument
parrot(actor='John Cleese')  # unknown keyword argument
@end example

En una llamada a una función, los argumentos nombrados deben seguir a los argumentos posicionales. Cada uno de los argumentos nombrados pasados deben coincidir con un argumento aceptado por la función (por ejemplo, @code{actor} no es un argumento válido para la función @code{parrot}), y el orden de los mismos no es importante. Esto también se aplica a los argumentos obligatorios (por ejemplo, @code{parrot(voltage=1000)} también es válido). Ningún argumento puede recibir más de un valor al mismo tiempo. Aquí hay un ejemplo que falla debido a esta restricción:

@example
>>> def function(a):
...     pass
...
>>> function(0, a=0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: function() got multiple values for argument 'a'
@end example

Cuando un parámetro formal de la forma @code{**nombre} está presente al final, recibe un diccionario (ver @ref{b51,,Tipos mapa — dict}) conteniendo todos los argumentos nombrados excepto aquellos correspondientes a un parámetro formal. Esto puede ser combinado con un parámetro formal de la forma @code{*nombre} (descrito en la siguiente sección) que recibe una @ref{1c2d,,tupla} conteniendo los argumentos posicionales además de la lista de parámetros formales. (@code{*nombre} debe ocurrir antes de @code{**nombre}). Por ejemplo, si definimos una función así:

@example
def cheeseshop(kind, *arguments, **keywords):
    print("-- Do you have any", kind, "?")
    print("-- I'm sorry, we're all out of", kind)
    for arg in arguments:
        print(arg)
    print("-" * 40)
    for kw in keywords:
        print(kw, ":", keywords[kw])
@end example

Puede ser llamada así:

@example
cheeseshop("Limburger", "It's very runny, sir.",
           "It's really very, VERY runny, sir.",
           shopkeeper="Michael Palin",
           client="John Cleese",
           sketch="Cheese Shop Sketch")
@end example

…y por supuesto imprimirá:

@example
-- Do you have any Limburger ?
-- I'm sorry, we're all out of Limburger
It's very runny, sir.
It's really very, VERY runny, sir.
----------------------------------------
shopkeeper : Michael Palin
client : John Cleese
sketch : Cheese Shop Sketch
@end example

Se debe notar que el orden en el cual los argumentos nombrados son impresos está garantizado para coincidir con el orden en el cual fueron provistos en la llamada a la función.

@node Parámetros especiales,Listas de argumentos arbitrarios,Palabras claves como argumentos,Más sobre definición de funciones
@anchor{tutorial/controlflow special-parameters}@anchor{1c2e}
@subsubsection Parámetros especiales


Por defecto, los argumentos pueden enviarse a una función Python o bien por posición o explícitamente por clave. Para legibilidad y rendimiento tiene sentido restringir como se pueden enviar los argumentos, así un desarrollador necesitará mirar solamente la definición de la función para determinar si los argumentos se deben enviar por posición, por posición o clave, o por clave.

La definición de una función puede ser como la siguiente:

@example
def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        Positional or keyword   |
        |                                - Keyword only
         -- Positional only
@end example

donde @code{/} y @code{*} son posicionales. Si se utilizan, esos símbolos indican el tipo de parámetro según la forma en que los argumentos deben enviarse a la función: solo por posición (`positional-only'), por posición o clave (`positional-or-keyword') y solo por clave (`keyword-only'). Parámetros por clave pueden también denominarse parámetros por nombre o nombrados.

@menu
* Argumentos posicionales o de palabras claves:: 
* Parámetros únicamente posicionales:: 
* Argumentos únicamente de palabras clave:: 
* Ejemplos de Funciones:: 
* Resumen:: 

@end menu

@node Argumentos posicionales o de palabras claves,Parámetros únicamente posicionales,,Parámetros especiales
@anchor{tutorial/controlflow positional-or-keyword-arguments}@anchor{1c2f}
@subsubsection Argumentos posicionales o de palabras claves


Si @code{/} y @code{*} no están presentes en la definición de la función, los parámetros pueden ser pasados a una función posicionalmente o por palabra clave.

@node Parámetros únicamente posicionales,Argumentos únicamente de palabras clave,Argumentos posicionales o de palabras claves,Parámetros especiales
@anchor{tutorial/controlflow positional-only-parameters}@anchor{1c30}
@subsubsection Parámetros únicamente posicionales


Mirando esto con un poco más de detalle, es posible señalar algunos parámetros como `únicamente posicionales'. En ese caso el orden de los parámetros es importante, y los parámetros no pueden ser indicados utilizando palabras claves. Parámetros únicamente posicionales son ubicados antes de una @code{/} (barra). La @code{/} es utilizada para separar lógicamente parámetros únicamente posicionales del resto. Si no existe una @code{/} en la definición de la función, no existen parámetros únicamente posicionales.

Los parámetros luego de una @code{/} pueden ser `únicamente posicionales' o `unicamente de palabras claves'.

@node Argumentos únicamente de palabras clave,Ejemplos de Funciones,Parámetros únicamente posicionales,Parámetros especiales
@anchor{tutorial/controlflow keyword-only-arguments}@anchor{1c31}
@subsubsection Argumentos únicamente de palabras clave


Para señalar parámetros como `unicamente de palabras clave', indicando que los parámetros deben ser pasados con una palabra clave, indiqué un @code{*} en la lista de argumentos antes del primer parámetro `únicamente de palabras clave'.

@node Ejemplos de Funciones,Resumen,Argumentos únicamente de palabras clave,Parámetros especiales
@anchor{tutorial/controlflow function-examples}@anchor{1c32}
@subsubsection Ejemplos de Funciones


Considere el siguiente ejemplo de definiciones de funciones prestando especial atención a los marcadores @code{/} y @code{*}:

@example
>>> def standard_arg(arg):
...     print(arg)
...
>>> def pos_only_arg(arg, /):
...     print(arg)
...
>>> def kwd_only_arg(*, arg):
...     print(arg)
...
>>> def combined_example(pos_only, /, standard, *, kwd_only):
...     print(pos_only, standard, kwd_only)
@end example

La primer definición de función, @code{standard_arg}, la forma mas familiar, no indica ninguna restricción en las condiciones para llamarla y los parámetros deben ser pasados por posición o utilizando palabras clave:

@example
>>> standard_arg(2)
2

>>> standard_arg(arg=2)
2
@end example

La segunda función @code{pos_only_arg} está restringida a utilizar únicamente parámetros posicionales ya que existe una @code{/} en la definición de la función:

@example
>>> pos_only_arg(1)
1

>>> pos_only_arg(arg=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: pos_only_arg() got some positional-only arguments passed as keyword arguments: 'arg'
@end example

The third function @code{kwd_only_arg} only allows keyword arguments as indicated
by a @code{*} in the function definition:

@example
>>> kwd_only_arg(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given

>>> kwd_only_arg(arg=3)
3
@end example

La última utiliza las tres convenciones en una misma definición de función:

@example
>>> combined_example(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() takes 2 positional arguments but 3 were given

>>> combined_example(1, 2, kwd_only=3)
1 2 3

>>> combined_example(1, standard=2, kwd_only=3)
1 2 3

>>> combined_example(pos_only=1, standard=2, kwd_only=3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() got some positional-only arguments passed as keyword arguments: 'pos_only'
@end example

Finalmente, considere esta definición de función que contiene una colisión potencial entre los parámetros posicionales @code{name} y @code{**kwds} que incluye @code{name} como una clave:

@example
def foo(name, **kwds):
    return 'name' in kwds
@end example

No hay una llamada posible que lo haga retornar @code{True} ya que la palabra clave @code{'name'} siempre se vinculará al primer parámetro. Por ejemplo:

@example
>>> foo(1, **@{'name': 2@})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got multiple values for argument 'name'
>>>
@end example

Pero utilizando @code{/} (parámetros únicamente posicionales), es posible ya que permite utilizar @code{name} como un parámetro posicional y @code{name} como un parámetro de palabras clave:

@example
>>> def foo(name, /, **kwds):
...     return 'name' in kwds
...
>>> foo(1, **@{'name': 2@})
True
@end example

En otras palabras, los nombres de parámetros únicamente posicionales pueden ser utilizados en @code{**kwds} sin ambigüedad.

@node Resumen,,Ejemplos de Funciones,Parámetros especiales
@anchor{tutorial/controlflow recap}@anchor{1c33}
@subsubsection Resumen


El caso de uso determinará qué parámetros utilizar en una definición de función:

@example
def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
@end example

A modo de guía:


@itemize *

@item 
Utilice únicamente posicionales si quiere que el nombre del parámetro esté disponible para el usuario. Esto es útil cuando el nombre del parámetro no tiene un significado real, si se quiere imponer el orden de los parámetros cuando una función es llamada o si necesita tomar algunos parámetros posicionales y palabras claves arbitrarias.

@item 
Utilice parámetros únicamente de palabras clave cuando los nombres de los parámetros tienen un significado y la definición de la función será más entendible usando nombres explícitos o cuando desea evitar que los usuarios dependan de la posición de los parámetros que se pasan.

@item 
En el caso de una API, use solo posicional para evitar que se rompan los cambios de la API si el nombre del parámetro se modifica en el futuro.
@end itemize

@node Listas de argumentos arbitrarios,Desempaquetando una lista de argumentos,Parámetros especiales,Más sobre definición de funciones
@anchor{tutorial/controlflow arbitrary-argument-lists}@anchor{1c34}@anchor{tutorial/controlflow tut-arbitraryargs}@anchor{1c35}
@subsubsection Listas de argumentos arbitrarios


@geindex * (asterisco);in function calls

Finalmente, la opción menos frecuentemente usada es especificar que una función puede ser llamada con un número arbitrario de argumentos. Estos argumentos serán organizados en una tupla (ver @ref{1c2d,,Tuplas y secuencias}). Antes del número variable de argumentos, cero o más argumentos normales pueden estar presentes.:

@example
def write_multiple_items(file, separator, *args):
    file.write(separator.join(args))
@end example

Normalmente estos argumentos `variádicos' serán los últimos en la lista de parámetros formales, porque toman todo el remanente de argumentos que se pasan a la función. Cualquier parámetro que suceda luego del @code{*args} será “sólo de palabra clave”, o sea que sólo se pueden usar como argumentos nombrados y no como posicionales.

@example
>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("earth", "mars", "venus")
'earth/mars/venus'
>>> concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'
@end example

@node Desempaquetando una lista de argumentos,Expresiones lambda,Listas de argumentos arbitrarios,Más sobre definición de funciones
@anchor{tutorial/controlflow tut-unpacking-arguments}@anchor{1c36}@anchor{tutorial/controlflow unpacking-argument-lists}@anchor{1c37}
@subsubsection Desempaquetando una lista de argumentos


La situación inversa ocurre cuando los argumentos ya están en una lista o tupla pero necesitan ser desempaquetados para llamar a una función que requiere argumentos posicionales separados. Por ejemplo, la función predefinida @ref{9d6,,range()} espera los parámetros `inicio' y `fin'. Si estos no están disponibles en forma separada, se puede escribir la llamada a la función con el operador @code{*} para desempaquetar argumentos desde una lista o una tupla:

@example
>>> list(range(3, 6))            # normal call with separate arguments
[3, 4, 5]
>>> args = [3, 6]
>>> list(range(*args))            # call with arguments unpacked from a list
[3, 4, 5]
@end example

@geindex **;in function calls

Del mismo modo, los diccionarios pueden entregar argumentos nombrados con el operador @code{**}:

@example
>>> def parrot(voltage, state='a stiff', action='voom'):
...     print("-- This parrot wouldn't", action, end=' ')
...     print("if you put", voltage, "volts through it.", end=' ')
...     print("E's", state, "!")
...
>>> d = @{"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"@}
>>> parrot(**d)
-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !
@end example

@node Expresiones lambda,Cadenas de texto de documentación,Desempaquetando una lista de argumentos,Más sobre definición de funciones
@anchor{tutorial/controlflow lambda-expressions}@anchor{1c38}@anchor{tutorial/controlflow tut-lambda}@anchor{1c39}
@subsubsection Expresiones lambda


Pequeñas funciones anónimas pueden ser creadas con la palabra reservada @ref{1309,,lambda}. Esta función retorna la suma de sus dos argumentos: @code{lambda a, b: a+b} Las funciones Lambda pueden ser usadas en cualquier lugar donde sea requerido un objeto de tipo función. Están sintácticamente restringidas a una sola expresión. Semánticamente, son solo azúcar sintáctica para definiciones normales de funciones. Al igual que las funciones anidadas, las funciones lambda pueden hacer referencia a variables desde el ámbito que la contiene:

@example
>>> def make_incrementor(n):
...     return lambda x: x + n
...
>>> f = make_incrementor(42)
>>> f(0)
42
>>> f(1)
43
@end example

El ejemplo anterior muestra el uso de una expresión lambda para retornar una función. Otro uso es para pasar pequeñas funciones como argumentos

@example
>>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
>>> pairs.sort(key=lambda pair: pair[1])
>>> pairs
[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]
@end example

@node Cadenas de texto de documentación,Anotación de funciones,Expresiones lambda,Más sobre definición de funciones
@anchor{tutorial/controlflow documentation-strings}@anchor{1c3a}@anchor{tutorial/controlflow tut-docstrings}@anchor{1c25}
@subsubsection Cadenas de texto de documentación


@geindex docstrings
@geindex documentation strings
@geindex strings@comma{} documentation

Acá hay algunas convenciones sobre el contenido y formato de las cadenas de texto de documentación.

La primera línea debe ser siempre un resumen corto y conciso del propósito del objeto. Para ser breve, no se debe mencionar explícitamente el nombre o tipo del objeto, ya que estos están disponibles de otros modos (excepto si el nombre es un verbo que describe el funcionamiento de la función). Esta línea debe empezar con una letra mayúscula y terminar con un punto.

Si hay más líneas en la cadena de texto de documentación, la segunda línea debe estar en blanco, separando visualmente el resumen del resto de la descripción. Las líneas siguientes deben ser uno o más párrafos describiendo las convenciones para llamar al objeto, efectos secundarios, etc.

El analizador de Python no quita el sangrado de las cadenas de texto literales multi-líneas, entonces las herramientas que procesan documentación tienen que quitarlo si así lo desean. Esto se hace mediante la siguiente convención. La primera línea que no está en blanco `siguiente' a la primer línea de la cadena determina la cantidad de sangría para toda la cadena de documentación. (No podemos usar la primer línea ya que generalmente es adyacente a las comillas de apertura de la cadena y el sangrado no se nota en la cadena de texto). Los espacios en blanco «equivalentes» a este sangrado son luego quitados del comienzo de cada línea en la cadena. No deberían haber líneas con una sangría menor, pero si las hay todos los espacios en blanco del comienzo deben ser quitados. La equivalencia de espacios en blanco debe ser verificada luego de la expansión de tabuladores (a 8 espacios, normalmente).

Este es un ejemplo de un @code{docstring} multi-línea:

@example
>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything.
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.
@end example

@node Anotación de funciones,,Cadenas de texto de documentación,Más sobre definición de funciones
@anchor{tutorial/controlflow function-annotations}@anchor{1c3b}@anchor{tutorial/controlflow tut-annotations}@anchor{1c3c}
@subsubsection Anotación de funciones


@geindex function;annotations
@geindex ->;function annotations
@geindex ; (dos puntos);function annotations

Las @ref{1c3d,,anotaciones de funciones} son información completamente opcional sobre los tipos usadas en funciones definidas por el usuario (ver 
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} y 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para más información).

Las @ref{1c3e,,anotaciones} se almacenan en el atributo @code{__annotations__} de la función como un diccionario y no tienen efecto en ninguna otra parte de la función. Las anotaciones de los parámetros se definen luego de dos puntos después del nombre del parámetro, seguido de una expresión que evalúa al valor de la anotación. Las anotaciones de retorno son definidas por el literal @code{->}, seguidas de una expresión, entre la lista de parámetros y los dos puntos que marcan el final de la declaración @ref{1497,,def}. El siguiente ejemplo tiene un argumento posicional, uno nombrado, y el valor de retorno anotado:

@example
>>> def f(ham: str, eggs: str = 'eggs') -> str:
...     print("Annotations:", f.__annotations__)
...     print("Arguments:", ham, eggs)
...     return ham + ' and ' + eggs
...
>>> f('spam')
Annotations: @{'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>@}
Arguments: spam eggs
'spam and eggs'
@end example

@node Intermezzo Estilo de programación,,Más sobre definición de funciones,Más herramientas para control de flujo
@anchor{tutorial/controlflow intermezzo-coding-style}@anchor{1c3f}@anchor{tutorial/controlflow tut-codingstyle}@anchor{1c40}
@subsection Intermezzo: Estilo de programación


@geindex coding;style

Ahora que estás a punto de escribir piezas de Python más largas y complejas, es un buen momento para hablar sobre `estilo de programación'. La mayoría de los lenguajes pueden ser escritos (o mejor dicho, `formateados') con diferentes estilos; algunos son mas fáciles de leer que otros. Hacer que tu código sea más fácil de leer por otros es siempre una buena idea, y adoptar un buen estilo de programación ayuda tremendamente a lograrlo.

Para Python, 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} se erigió como la guía de estilo a la que más proyectos adhirieron; promueve un estilo de programación fácil de leer y visualmente agradable. Todos los desarrolladores Python deben leerlo en algún momento; aquí están extraídos los puntos más importantes:


@itemize *

@item 
Usar sangrías de 4 espacios, no tabuladores.

4 espacios son un buen compromiso entre una sangría pequeña (permite mayor nivel de sangrado)y una sangría grande (más fácil de leer). Los tabuladores introducen confusión y es mejor dejarlos de lado.

@item 
Recortar las líneas para que no superen los 79 caracteres.

Esto ayuda a los usuarios con pantallas pequeñas y hace posible tener varios archivos de código abiertos, uno al lado del otro, en pantallas grandes.

@item 
Usar líneas en blanco para separar funciones y clases, y bloques grandes de código dentro de funciones.

@item 
Cuando sea posible, poner comentarios en una sola línea.

@item 
Usar @code{docstrings}.

@item 
Usar espacios alrededor de operadores y luego de las comas, pero no directamente dentro de paréntesis: @code{a = f(1, 2) + g(3, 4)}.

@item 
Nombrar las clases y funciones consistentemente; la convención es usar @code{NotacionCamello} para clases y @code{minusculas_con_guiones_bajos} para funciones y métodos. Siempre usa @code{self} como el nombre para el primer argumento en los métodos (ver @ref{1c41,,Un primer vistazo a las clases} para más información sobre clases y métodos).

@item 
No uses codificaciones estrafalarias si esperas usar el código en entornos internacionales. El default de Python, UTF-8, o incluso ASCII plano funcionan bien en la mayoría de los casos.

@item 
De la misma manera, no uses caracteres no-ASCII en los identificadores si hay incluso una pequeñísima chance de que gente que hable otro idioma tenga que leer o mantener el código.
@end itemize

@subsubheading Notas al pie


@node Estructuras de datos,Módulos<2>,Más herramientas para control de flujo,El tutorial de Python
@anchor{tutorial/datastructures doc}@anchor{1c42}@anchor{tutorial/datastructures data-structures}@anchor{1c43}@anchor{tutorial/datastructures tut-structures}@anchor{1c18}
@section Estructuras de datos


Este capítulo describe en más detalle algunas cosas que ya has aprendido y agrega algunas cosas nuevas también.

@menu
* Más sobre listas:: 
* La instrucción del:: 
* Tuplas y secuencias:: 
* Conjuntos:: 
* Diccionarios:: 
* Técnicas de iteración:: 
* Más acerca de condiciones:: 
* Comparando secuencias y otros tipos:: 

@end menu

@node Más sobre listas,La instrucción del,,Estructuras de datos
@anchor{tutorial/datastructures more-on-lists}@anchor{1c44}@anchor{tutorial/datastructures tut-morelists}@anchor{1c45}
@subsection Más sobre listas


El tipo de dato lista tiene algunos métodos más. Aquí están todos los métodos de los objetos lista:


@deffn {Método} list.append (x)

Add an item to the end of the list.  Similar to @code{a[len(a):] = [x]}.
@end deffn


@deffn {Método} list.extend (iterable)

Extend the list by appending all the items from the iterable.  Similar to
@code{a[len(a):] = iterable}.
@end deffn


@deffn {Método} list.insert (i, x)

Inserta un ítem en una posición dada. El primer argumento es el índice del ítem delante del cual se insertará, por lo tanto @code{a.insert(0, x)} inserta al principio de la lista y @code{a.insert(len(a), x)} equivale a @code{a.append(x)}.
@end deffn


@deffn {Método} list.remove (x)

Quita el primer ítem de la lista cuyo valor sea `x'. Lanza un @ref{360,,ValueError} si no existe tal ítem.
@end deffn


@deffn {Método} list.pop ([i])

Remove the item at the given position in the list, and return it.  If no index
is specified, @code{a.pop()} removes and returns the last item in the list.
It raises an @ref{1575,,IndexError} if the list is empty or the index is
outside the list range.
@end deffn


@deffn {Método} list.clear ()

Remove all items from the list.  Similar to @code{del a[:]}.
@end deffn


@deffn {Método} list.index (x[, start[, end]])

Retorna el índice basado en cero del primer elemento cuyo valor sea igual a `x'. Lanza una excepción @ref{360,,ValueError} si no existe tal elemento.

Los argumentos opcionales `start' y `end' son interpretados como la notación de rebanadas y se usan para limitar la búsqueda a un segmento particular de la lista. El índice retornado se calcula de manera relativa al inicio de la secuencia completa en lugar de hacerlo con respecto al argumento `start'.
@end deffn


@deffn {Método} list.count (x)

Retorna el número de veces que `x' aparece en la lista.
@end deffn


@deffn {Método} list.sort (*, key=None, reverse=False)

Ordena los elementos de la lista in situ (los argumentos pueden ser usados para personalizar el orden de la lista, ver @ref{c56,,sorted()} para su explicación).
@end deffn


@deffn {Método} list.reverse ()

Invierte los elementos de la lista in situ.
@end deffn


@deffn {Método} list.copy ()

Return a shallow copy of the list.  Similar to @code{a[:]}.
@end deffn

Un ejemplo que usa la mayoría de los métodos de la lista:

@example
>>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana']
>>> fruits.count('apple')
2
>>> fruits.count('tangerine')
0
>>> fruits.index('banana')
3
>>> fruits.index('banana', 4)  # Find next banana starting at position 4
6
>>> fruits.reverse()
>>> fruits
['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange']
>>> fruits.append('grape')
>>> fruits
['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange', 'grape']
>>> fruits.sort()
>>> fruits
['apple', 'apple', 'banana', 'banana', 'grape', 'kiwi', 'orange', 'pear']
>>> fruits.pop()
'pear'
@end example

Quizás hayas notado que métodos como @code{insert}, @code{remove} o @code{sort} que únicamente modifican la lista no tienen un valor de retorno impreso – retornan el valor por defecto @code{None}. @footnote{
Otros lenguajes podrían retornar un objeto mutado, que permite encadenamiento de métodos como @code{d->insert("a")->remove("b")->sort();}.
} Esto es un principio de diseño para todas las estructuras de datos mutables en Python.

Another thing you might notice is that not all data can be sorted or
compared.  For instance, @code{[None, 'hello', 10]} doesn’t sort because
integers can’t be compared to strings and @code{None} can’t be compared to
other types.  Also, there are some types that don’t have a defined
ordering relation.  For example, @code{3+4j < 5+7j} isn’t a valid
comparison.

@menu
* Usar listas como pilas:: 
* Usar listas como colas:: 
* Comprensión de listas: Comprensión de listas<2>. 
* Listas por comprensión anidadas:: 

@end menu

@node Usar listas como pilas,Usar listas como colas,,Más sobre listas
@anchor{tutorial/datastructures tut-lists-as-stacks}@anchor{1c46}@anchor{tutorial/datastructures using-lists-as-stacks}@anchor{1c47}
@subsubsection Usar listas como pilas


Los métodos de lista hacen que resulte muy fácil usar una lista como una pila, donde el último elemento añadido es el primer elemento retirado («último en entrar, primero en salir»). Para agregar un elemento a la cima de la pila, utiliza @code{append()}. Para retirar un elemento de la cima de la pila, utiliza @code{pop()} sin un índice explícito. Por ejemplo:

@example
>>> stack = [3, 4, 5]
>>> stack.append(6)
>>> stack.append(7)
>>> stack
[3, 4, 5, 6, 7]
>>> stack.pop()
7
>>> stack
[3, 4, 5, 6]
>>> stack.pop()
6
>>> stack.pop()
5
>>> stack
[3, 4]
@end example

@node Usar listas como colas,Comprensión de listas<2>,Usar listas como pilas,Más sobre listas
@anchor{tutorial/datastructures tut-lists-as-queues}@anchor{1c48}@anchor{tutorial/datastructures using-lists-as-queues}@anchor{1c49}
@subsubsection Usar listas como colas


También es posible usar una lista como una cola, donde el primer elemento añadido es el primer elemento retirado («primero en entrar, primero en salir»); sin embargo, las listas no son eficientes para este propósito. Agregar y sacar del final de la lista es rápido, pero insertar o sacar del comienzo de una lista es lento (porque todos los otros elementos tienen que ser desplazados en uno).

Para implementar una cola, utiliza @ref{67d,,collections.deque} el cual fue diseñado para añadir y quitar de ambas puntas de forma rápida. Por ejemplo:

@example
>>> from collections import deque
>>> queue = deque(["Eric", "John", "Michael"])
>>> queue.append("Terry")           # Terry arrives
>>> queue.append("Graham")          # Graham arrives
>>> queue.popleft()                 # The first to arrive now leaves
'Eric'
>>> queue.popleft()                 # The second to arrive now leaves
'John'
>>> queue                           # Remaining queue in order of arrival
deque(['Michael', 'Terry', 'Graham'])
@end example

@node Comprensión de listas<2>,Listas por comprensión anidadas,Usar listas como colas,Más sobre listas
@anchor{tutorial/datastructures list-comprehensions}@anchor{1c4a}@anchor{tutorial/datastructures tut-listcomps}@anchor{1c4b}
@subsubsection Comprensión de listas


Las comprensiones de listas ofrecen una manera concisa de crear listas. Sus usos comunes son para hacer nuevas listas donde cada elemento es el resultado de algunas operaciones aplicadas a cada miembro de otra secuencia o iterable, o para crear un segmento de la secuencia de esos elementos para satisfacer una condición determinada.

Por ejemplo, asumamos que queremos crear una lista de cuadrados, como:

@example
>>> squares = []
>>> for x in range(10):
...     squares.append(x**2)
...
>>> squares
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@end example

Nótese que esto crea (o sobreescribe) una variable llamada @code{x} que sigue existiendo luego de que el bucle haya terminado. Podemos calcular la lista de cuadrados sin ningún efecto secundario haciendo:

@example
squares = list(map(lambda x: x**2, range(10)))
@end example

o, un equivalente:

@example
squares = [x**2 for x in range(10)]
@end example

que es más conciso y legible.

Una lista de comprensión consiste de corchetes rodeando una expresión seguida de la declaración @code{for} y luego cero o más declaraciones @code{for} o @code{if}.  El resultado será una nueva lista que sale de evaluar la expresión en el contexto de los @code{for} o @code{if} que le siguen.  Por ejemplo, esta lista de comprensión combina los elementos de dos listas si no son iguales:

@example
>>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y]
[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
@end example

y es equivalente a:

@example
>>> combs = []
>>> for x in [1,2,3]:
...     for y in [3,1,4]:
...         if x != y:
...             combs.append((x, y))
...
>>> combs
[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
@end example

Nótese como el orden de los @ref{1eb,,for} y @ref{1ec,,if} es el mismo en ambos pedacitos de código.

Si la expresión es una tupla (como el @code{(x, y)} en el ejemplo anterior), debe estar entre paréntesis.

@example
>>> vec = [-4, -2, 0, 2, 4]
>>> # create a new list with the values doubled
>>> [x*2 for x in vec]
[-8, -4, 0, 4, 8]
>>> # filter the list to exclude negative numbers
>>> [x for x in vec if x >= 0]
[0, 2, 4]
>>> # apply a function to all the elements
>>> [abs(x) for x in vec]
[4, 2, 0, 2, 4]
>>> # call a method on each element
>>> freshfruit = ['  banana', '  loganberry ', 'passion fruit  ']
>>> [weapon.strip() for weapon in freshfruit]
['banana', 'loganberry', 'passion fruit']
>>> # create a list of 2-tuples like (number, square)
>>> [(x, x**2) for x in range(6)]
[(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
>>> # the tuple must be parenthesized, otherwise an error is raised
>>> [x, x**2 for x in range(6)]
  File "<stdin>", line 1
    [x, x**2 for x in range(6)]
     ^^^^^^^
SyntaxError: did you forget parentheses around the comprehension target?
>>> # flatten a list using a listcomp with two 'for'
>>> vec = [[1,2,3], [4,5,6], [7,8,9]]
>>> [num for elem in vec for num in elem]
[1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

Las comprensiones de listas pueden contener expresiones complejas y funciones anidadas:

@example
>>> from math import pi
>>> [str(round(pi, i)) for i in range(1, 6)]
['3.1', '3.14', '3.142', '3.1416', '3.14159']
@end example

@node Listas por comprensión anidadas,,Comprensión de listas<2>,Más sobre listas
@anchor{tutorial/datastructures nested-list-comprehensions}@anchor{1c4c}
@subsubsection Listas por comprensión anidadas


La expresión inicial de una comprensión de listas puede ser cualquier expresión arbitraria, incluyendo otra comprensión de listas.

Considerá el siguiente ejemplo de una matriz de 3x4 implementada como una lista de tres listas de largo 4:

@example
>>> matrix = [
...     [1, 2, 3, 4],
...     [5, 6, 7, 8],
...     [9, 10, 11, 12],
... ]
@end example

La siguiente comprensión de lista transpondrá las filas y columnas:

@example
>>> [[row[i] for row in matrix] for i in range(4)]
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

Como vimos en la sección anterior, la lista de comprensión anidada se evalúa en el contexto del @ref{1eb,,for} que lo sigue, por lo que este ejemplo equivale a:

@example
>>> transposed = []
>>> for i in range(4):
...     transposed.append([row[i] for row in matrix])
...
>>> transposed
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

el cual, a la vez, es lo mismo que:

@example
>>> transposed = []
>>> for i in range(4):
...     # the following 3 lines implement the nested listcomp
...     transposed_row = []
...     for row in matrix:
...         transposed_row.append(row[i])
...     transposed.append(transposed_row)
...
>>> transposed
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

En el mundo real, deberías preferir funciones predefinidas a declaraciones con flujo complejo. La función @ref{14d,,zip()} haría un buen trabajo para este caso de uso:

@example
>>> list(zip(*matrix))
[(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]
@end example

Ver @ref{1c36,,Desempaquetando una lista de argumentos} para detalles sobre el asterisco de esta línea.

@node La instrucción del,Tuplas y secuencias,Más sobre listas,Estructuras de datos
@anchor{tutorial/datastructures the-del-statement}@anchor{1c4d}@anchor{tutorial/datastructures tut-del}@anchor{1c4e}
@subsection La instrucción @code{del}


Hay una manera de quitar un ítem de una lista dado su índice en lugar de su valor: la instrucción @ref{17ae,,del}. Esta es diferente del método @code{pop()}, el cual retorna un valor. La instrucción @code{del} también puede usarse para quitar secciones de una lista o vaciar la lista completa (lo que hacíamos antes asignando una lista vacía a la rebanada). Por ejemplo:

@example
>>> a = [-1, 1, 66.25, 333, 333, 1234.5]
>>> del a[0]
>>> a
[1, 66.25, 333, 333, 1234.5]
>>> del a[2:4]
>>> a
[1, 66.25, 1234.5]
>>> del a[:]
>>> a
[]
@end example

@ref{17ae,,del} puede usarse también para eliminar variables:

@example
>>> del a
@end example

Hacer referencia al nombre @code{a} de aquí en más es un error (al menos hasta que se le asigne otro valor). Veremos otros usos para @ref{17ae,,del} más adelante.

@node Tuplas y secuencias,Conjuntos,La instrucción del,Estructuras de datos
@anchor{tutorial/datastructures tuples-and-sequences}@anchor{1c4f}@anchor{tutorial/datastructures tut-tuples}@anchor{1c2d}
@subsection Tuplas y secuencias


Vimos que las listas y cadenas tienen propiedades en común, como el indexado y las operaciones de rebanado. Estas son dos ejemplos de datos de tipo `secuencia' (ver @ref{1c50,,Tipos secuencia — list@comma{} tuple@comma{} range}). Como Python es un lenguaje en evolución, otros datos de tipo secuencia pueden agregarse. Existe otro dato de tipo secuencia estándar: la `tupla'.

Una tupla está formada por un número de valores separados por comas, por ejemplo:

@example
>>> t = 12345, 54321, 'hello!'
>>> t[0]
12345
>>> t
(12345, 54321, 'hello!')
>>> # Tuples may be nested:
>>> u = t, (1, 2, 3, 4, 5)
>>> u
((12345, 54321, 'hello!'), (1, 2, 3, 4, 5))
>>> # Tuples are immutable:
>>> t[0] = 88888
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'tuple' object does not support item assignment
>>> # but they can contain mutable objects:
>>> v = ([1, 2, 3], [3, 2, 1])
>>> v
([1, 2, 3], [3, 2, 1])
@end example

Como puedes ver, en la salida las tuplas siempre se encierran entre paréntesis para que las tuplas anidadas puedan interpretarse correctamente; pueden ingresarse con o sin paréntesis, aunque a menudo los paréntesis son necesarios de todas formas (si la tupla es parte de una expresión más grande). No es posible asignar a los ítems individuales de una tupla, pero sin embargo sí se puede crear tuplas que contengan objetos mutables, como las listas.

A pesar de que las tuplas puedan parecerse a las listas, frecuentemente se utilizan en distintas situaciones y para distintos propósitos. Las tuplas son @ref{1c03,,immutable} y normalmente contienen una secuencia heterogénea de elementos que son accedidos al desempaquetar (ver más adelante en esta sección) o indizar (o incluso acceder por atributo en el caso de las @ref{32d,,namedtuples}). Las listas son @ref{1c08,,mutable}, y sus elementos son normalmente homogéneos y se acceden iterando a la lista.

Un problema particular es la construcción de tuplas que contengan 0 o 1 ítem: la sintaxis presenta algunas peculiaridades para estos casos. Las tuplas vacías se construyen mediante un par de paréntesis vacío; una tupla con un ítem se construye poniendo una coma a continuación del valor (no alcanza con encerrar un único valor entre paréntesis). Feo, pero efectivo. Por ejemplo:

@example
>>> empty = ()
>>> singleton = 'hello',    # <-- note trailing comma
>>> len(empty)
0
>>> len(singleton)
1
>>> singleton
('hello',)
@end example

La declaración @code{t = 12345, 54321, 'hola!'} es un ejemplo de `empaquetado de tuplas': los valores @code{12345}, @code{54321} y @code{'hola!'} se empaquetan juntos en una tupla. La operación inversa también es posible:

@example
>>> x, y, z = t
@end example

Esto se llama, apropiadamente, `desempaquetado de secuencias', y funciona para cualquier secuencia en el lado derecho del igual. El desempaquetado de secuencias requiere que la cantidad de variables a la izquierda del signo igual sea el tamaño de la secuencia. Nótese que la asignación múltiple es en realidad sólo una combinación de empaquetado de tuplas y desempaquetado de secuencias.

@node Conjuntos,Diccionarios,Tuplas y secuencias,Estructuras de datos
@anchor{tutorial/datastructures sets}@anchor{1c51}@anchor{tutorial/datastructures tut-sets}@anchor{1c52}
@subsection Conjuntos


Python también incluye un tipo de dato para `conjuntos'. Un conjunto es una colección no ordenada y sin elementos repetidos. Los usos básicos de éstos incluyen verificación de pertenencia y eliminación de entradas duplicadas. Los conjuntos también soportan operaciones matemáticas como la unión, intersección, diferencia, y diferencia simétrica.

Las llaves o la función @ref{67a,,set()} pueden usarse para crear conjuntos. Notá que para crear un conjunto vacío tenés que usar @code{set()}, no @code{@{@}}; esto último crea un diccionario vacío, una estructura de datos que discutiremos en la sección siguiente.

Una pequeña demostración:

@example
>>> basket = @{'apple', 'orange', 'apple', 'pear', 'orange', 'banana'@}
>>> print(basket)                      # show that duplicates have been removed
@{'orange', 'banana', 'pear', 'apple'@}
>>> 'orange' in basket                 # fast membership testing
True
>>> 'crabgrass' in basket
False

>>> # Demonstrate set operations on unique letters from two words
>>>
>>> a = set('abracadabra')
>>> b = set('alacazam')
>>> a                                  # unique letters in a
@{'a', 'r', 'b', 'c', 'd'@}
>>> a - b                              # letters in a but not in b
@{'r', 'd', 'b'@}
>>> a | b                              # letters in a or b or both
@{'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'@}
>>> a & b                              # letters in both a and b
@{'a', 'c'@}
>>> a ^ b                              # letters in a or b but not both
@{'r', 'd', 'b', 'm', 'z', 'l'@}
@end example

De forma similar a las @ref{1c4b,,comprensiones de listas}, la comprensión de conjuntos está también soportada:

@example
>>> a = @{x for x in 'abracadabra' if x not in 'abc'@}
>>> a
@{'r', 'd'@}
@end example

@node Diccionarios,Técnicas de iteración,Conjuntos,Estructuras de datos
@anchor{tutorial/datastructures dictionaries}@anchor{1c53}@anchor{tutorial/datastructures tut-dictionaries}@anchor{1c54}
@subsection Diccionarios


Otro tipo de dato útil incluido en Python es el `diccionario' (ver @ref{b51,,Tipos mapa — dict}). Los diccionarios se encuentran a veces en otros lenguajes como «memorias asociativas» o «arreglos asociativos». A diferencia de las secuencias, que se indexan mediante un rango numérico, los diccionarios se indexan con `claves', que pueden ser cualquier tipo inmutable; las cadenas y números siempre pueden ser claves. Las tuplas pueden usarse como claves si solamente contienen cadenas, números o tuplas; si una tupla contiene cualquier objeto mutable directa o indirectamente, no puede usarse como clave. No podés usar listas como claves, ya que las listas pueden modificarse usando asignación por índice, asignación por sección, o métodos como @code{append()} y @code{extend()}.

Es mejor pensar en un diccionario como un conjunto de pares `clave:valor' con el requerimiento de que las claves sean únicas (dentro de un diccionario). Un par de llaves crean un diccionario vacío: @code{@{@}}. Colocar una lista de pares clave:valor separada por comas dentro de las llaves añade pares clave:valor iniciales al diccionario; esta es también la forma en que los diccionarios se muestran en la salida.

Las operaciones principales sobre un diccionario son guardar un valor con una clave y extraer ese valor dada la clave. También es posible borrar un par clave:valor con @code{del}. Si usás una clave que ya está en uso para guardar un valor, el valor que estaba asociado con esa clave se pierde. Es un error extraer un valor usando una clave inexistente.

Ejecutando @code{list(d)} en un diccionario retornará una lista con todas las claves usadas en el diccionario, en el orden de inserción (si deseas que esté ordenada simplemente usa @code{sorted(d)} en su lugar). Para comprobar si una clave está en el diccionario usa la palabra clave @ref{1ed,,in}.

Un pequeño ejemplo de uso de un diccionario:

@example
>>> tel = @{'jack': 4098, 'sape': 4139@}
>>> tel['guido'] = 4127
>>> tel
@{'jack': 4098, 'sape': 4139, 'guido': 4127@}
>>> tel['jack']
4098
>>> del tel['sape']
>>> tel['irv'] = 4127
>>> tel
@{'jack': 4098, 'guido': 4127, 'irv': 4127@}
>>> list(tel)
['jack', 'guido', 'irv']
>>> sorted(tel)
['guido', 'irv', 'jack']
>>> 'guido' in tel
True
>>> 'jack' not in tel
False
@end example

El constructor @ref{190,,dict()} crea un diccionario directamente desde secuencias de pares clave-valor:

@example
>>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

Además, las comprensiones de diccionarios se pueden usar para crear diccionarios desde expresiones arbitrarias de clave y valor:

@example
>>> @{x: x**2 for x in (2, 4, 6)@}
@{2: 4, 4: 16, 6: 36@}
@end example

Cuando las claves son cadenas simples, a veces resulta más fácil especificar los pares usando argumentos por palabra clave:

@example
>>> dict(sape=4139, guido=4127, jack=4098)
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

@node Técnicas de iteración,Más acerca de condiciones,Diccionarios,Estructuras de datos
@anchor{tutorial/datastructures looping-techniques}@anchor{1c55}@anchor{tutorial/datastructures tut-loopidioms}@anchor{1c17}
@subsection Técnicas de iteración


Cuando iteramos sobre diccionarios, se pueden obtener al mismo tiempo la clave y su valor correspondiente usando el método @ref{868,,items()}.

@example
>>> knights = @{'gallahad': 'the pure', 'robin': 'the brave'@}
>>> for k, v in knights.items():
...     print(k, v)
...
gallahad the pure
robin the brave
@end example

Cuando se itera sobre una secuencia, se puede obtener el índice de posición junto a su valor correspondiente usando la función @ref{14bb,,enumerate()}.

@example
>>> for i, v in enumerate(['tic', 'tac', 'toe']):
...     print(i, v)
...
0 tic
1 tac
2 toe
@end example

Para iterar sobre dos o más secuencias al mismo tiempo, los valores pueden emparejarse con la función @ref{14d,,zip()}.

@example
>>> questions = ['name', 'quest', 'favorite color']
>>> answers = ['lancelot', 'the holy grail', 'blue']
>>> for q, a in zip(questions, answers):
...     print('What is your @{0@}?  It is @{1@}.'.format(q, a))
...
What is your name?  It is lancelot.
What is your quest?  It is the holy grail.
What is your favorite color?  It is blue.
@end example

Para iterar sobre una secuencia en orden inverso, se especifica primero la secuencia al derecho y luego se llama a la función @ref{8fc,,reversed()}.

@example
>>> for i in reversed(range(1, 10, 2)):
...     print(i)
...
9
7
5
3
1
@end example

Para iterar sobre una secuencia ordenada, se utiliza la función @ref{c56,,sorted()} la cual retorna una nueva lista ordenada dejando a la original intacta.

@example
>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for i in sorted(basket):
...     print(i)
...
apple
apple
banana
orange
orange
pear
@end example

El uso de @ref{67a,,set()} en una secuencia elimina los elementos duplicados. El uso de @ref{c56,,sorted()} en combinación con @ref{67a,,set()} sobre una secuencia es una forma idiomática de recorrer elementos únicos de la secuencia ordenada.

@example
>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for f in sorted(set(basket)):
...     print(f)
...
apple
banana
orange
pear
@end example

A veces uno intenta cambiar una lista mientras la está iterando; sin embargo, a menudo es más simple y seguro crear una nueva lista:

@example
>>> import math
>>> raw_data = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8]
>>> filtered_data = []
>>> for value in raw_data:
...     if not math.isnan(value):
...         filtered_data.append(value)
...
>>> filtered_data
[56.2, 51.7, 55.3, 52.5, 47.8]
@end example

@node Más acerca de condiciones,Comparando secuencias y otros tipos,Técnicas de iteración,Estructuras de datos
@anchor{tutorial/datastructures more-on-conditions}@anchor{1c56}@anchor{tutorial/datastructures tut-conditions}@anchor{1c57}
@subsection Más acerca de condiciones


Las condiciones usadas en las instrucciones @code{while} e @code{if} pueden contener cualquier operador, no sólo comparaciones.

Los operadores de comparación @code{in} y @code{not in} verifican si un valor ocurre (o no ocurre) en una secuencia. Los operadores @code{is} e @code{is not} comparan si dos objetos son realmente el mismo objeto. Todos los operadores de comparación tienen la misma prioridad, que es menor que la de todos los operadores numéricos.

Las comparaciones pueden encadenarse. Por ejemplo, @code{a < b == c} verifica si @code{a} es menor que @code{b} y además si @code{b} es igual a @code{c}.

Las comparaciones pueden combinarse mediante los operadores booleanos @code{and} y @code{or}, y el resultado de una comparación (o de cualquier otra expresión booleana) puede negarse con @code{not}. Estos tienen prioridades menores que los operadores de comparación; entre ellos @code{not} tiene la mayor prioridad y @code{or} la menor, o sea que @code{A and not B or C} equivale a @code{(A and (not B)) or C}. Como siempre, los paréntesis pueden usarse para expresar la composición deseada.

Los operadores booleanos @code{and} y @code{or} son los llamados operadores `cortocircuito': sus argumentos se evalúan de izquierda a derecha, y la evaluación se detiene en el momento en que se determina su resultado. Por ejemplo, si @code{A} y @code{C} son verdaderas pero @code{B} es falsa, en @code{A and B and C} no se evalúa la expresión @code{C}. Cuando se usa como un valor general y no como un booleano, el valor retornado de un operador cortocircuito es el último argumento evaluado.

Es posible asignar el resultado de una comparación u otra expresión booleana a una variable. Por ejemplo,

@example
>>> string1, string2, string3 = '@w{'}, 'Trondheim', 'Hammer Dance'
>>> non_null = string1 or string2 or string3
>>> non_null
'Trondheim'
@end example

Nótese que en Python, a diferencia de C, asignaciones dentro de expresiones deben realizarse explícitamente con el @ref{1c58,,operador walrus} @code{:=}. Esto soluciona algunos problemas comunes encontrados en C: escribiendo @code{=} en una expresión cuando se intentaba escribir @code{==}.

@node Comparando secuencias y otros tipos,,Más acerca de condiciones,Estructuras de datos
@anchor{tutorial/datastructures comparing-sequences-and-other-types}@anchor{1c59}@anchor{tutorial/datastructures tut-comparing}@anchor{1c5a}
@subsection Comparando secuencias y otros tipos


Las secuencias pueden compararse con otros objetos del mismo tipo de secuencia. La comparación usa orden `lexicográfico': primero se comparan los dos primeros ítems, si son diferentes esto ya determina el resultado de la comparación; si son iguales, se comparan los siguientes dos ítems, y así sucesivamente hasta llegar al final de alguna de las secuencias. Si dos ítems a comparar son ambos secuencias del mismo tipo, la comparación lexicográfica es recursiva. Si todos los ítems de dos secuencias resultan iguales, se considera que las secuencias son iguales. Si una secuencia es la parte inicial de la otra, la secuencia más corta es la más pequeña. El orden lexicográfico de las cadenas de caracteres utiliza el punto de código Unicode para ordenar caracteres individuales. Algunos ejemplos de comparación entre secuencias del mismo tipo:

@example
(1, 2, 3)              < (1, 2, 4)
[1, 2, 3]              < [1, 2, 4]
'ABC' < 'C' < 'Pascal' < 'Python'
(1, 2, 3, 4)           < (1, 2, 4)
(1, 2)                 < (1, 2, -1)
(1, 2, 3)             == (1.0, 2.0, 3.0)
(1, 2, ('aa', 'ab'))   < (1, 2, ('abc', 'a'), 4)
@end example

Observá que comparar objetos de diferentes tipos con @code{<} o @code{>} es legal siempre y cuando los objetos tenga los métodos de comparación apropiados. Por ejemplo, los tipos de números mezclados son comparados de acuerdo a su valor numérico, o sea 0 es igual a 0.0, etc. Si no es el caso, en lugar de proveer un ordenamiento arbitrario, el intérprete lanzará una excepción @ref{228,,TypeError}.

@subsubheading Notas al pie


@node Módulos<2>,Entrada y salida,Estructuras de datos,El tutorial de Python
@anchor{tutorial/modules doc}@anchor{1c5b}@anchor{tutorial/modules modules}@anchor{1c5c}@anchor{tutorial/modules tut-modules}@anchor{1c5d}
@section Módulos


Si sales del intérprete de Python y vuelves a entrar, las definiciones que habías hecho (funciones y variables) se pierden. Por lo tanto, si quieres escribir un programa más o menos largo, es mejor que utilices un editor de texto para preparar la entrada para el intérprete y ejecutarlo con ese archivo como entrada. Esto se conoce como crear un `script'. A medida que tu programa crezca, quizás quieras separarlo en varios archivos para que el mantenimiento sea más sencillo. Quizás también quieras usar una función útil que has escrito en distintos programas sin copiar su definición en cada programa.

Para soportar esto, Python tiene una manera de poner definiciones en un archivo y usarlos en un script o en una instancia del intérprete. Este tipo de ficheros se llama `módulo'; las definiciones de un módulo pueden ser `importadas' a otros módulos o al módulo `principal' (la colección de variables a las que tienes acceso en un script ejecutado en el nivel superior y en el modo calculadora).

Un módulo es un fichero conteniendo definiciones y declaraciones de Python. El nombre de archivo es el nombre del módulo con el sufijo @code{.py} agregado. Dentro de un módulo, el nombre del mismo módulo (como cadena) está disponible en el valor de la variable global @code{__name__}. Por ejemplo, utiliza tu editor de texto favorito para crear un archivo llamado @code{fibo.py} en el directorio actual, con el siguiente contenido:

@example
# Fibonacci numbers module

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()

def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result
@end example

Ahora entra en el intérprete de Python e importa este modulo con el siguiente comando:

@example
>>> import fibo
@end example

Esto no añade los nombres de las funciones definidas en @code{fibo} directamente al actual @ref{1c5e,,namespace} (ver @ref{1c5f,,Ámbitos y espacios de nombres en Python} para más detalles); sólo añade el nombre del módulo @code{fibo} allí. Usando el nombre del módulo puedes acceder a las funciones:

@example
>>> fibo.fib(1000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
>>> fibo.fib2(100)
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
>>> fibo.__name__
'fibo'
@end example

Si pretendes utilizar una función frecuentemente puedes asignarla a un nombre local:

@example
>>> fib = fibo.fib
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

@menu
* Más sobre los módulos:: 
* Módulos estándar:: 
* La función dir(): La función dir. 
* Paquetes:: 

@end menu

@node Más sobre los módulos,Módulos estándar,,Módulos<2>
@anchor{tutorial/modules more-on-modules}@anchor{1c60}@anchor{tutorial/modules tut-moremodules}@anchor{1c61}
@subsection Más sobre los módulos


Un módulo puede contener tanto declaraciones ejecutables como definiciones de funciones. Estas declaraciones están pensadas para inicializar el módulo. Se ejecutan únicamente la `primera' vez que el módulo se encuentra en una declaración import. @footnote{
De hecho, las definiciones de funciones también son «declaraciones» que se «ejecutan»; la ejecución de una definición de función a nivel de módulo, añade el nombre de la función en el espacio de nombres global del módulo.
} (También se ejecutan si el archivo se ejecuta como script.)

Cada módulo tiene su propio espacio de nombres privado, que es utilizado como espacio de nombres global por todas las funciones definidas en el módulo. De este modo, el autor de un módulo puede utilizar variables globales en el módulo sin preocuparse por choques accidentales con las variables globales de un usuario. Por otro lado, si sabes lo que estás haciendo puedes tocar las variables globales de un módulo con la misma notación que se utiliza para referirse a sus funciones, @code{modname.itemname}.

Los módulos pueden importar otros módulos. Es costumbre pero no obligatorio ubicar todas las declaraciones @ref{682,,import} al principio del módulo (o script, para el caso). Los nombres de los módulos importados, si se colocan en el nivel superior de un módulo (fuera de cualquier función o clase), se añaden al espacio de nombres global del módulo.

Hay una variante de la declaración @ref{682,,import} que importa los nombres de un módulo directamente al espacio de nombres del módulo que hace la importación. Por ejemplo:

@example
>>> from fibo import fib, fib2
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

Esto no introduce en el espacio de nombres local el nombre del módulo desde el cual se está importando (por lo tanto, en el ejemplo, @code{fibo} no esta definido).

Hay incluso una variante para importar todos los nombres que un módulo define:

@example
>>> from fibo import *
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

Esto importa todos los nombres excepto los que inician con un guión bajo (@code{_}). La mayoría de las veces los programadores de Python no usan esto ya que introduce en el intérprete un conjunto de nombres desconocido, posiblemente escondiendo algunas de las definiciones previas.

Nótese que en general la práctica de importar @code{*} de un módulo o paquete está muy mal vista, ya que frecuentemente genera código poco legible. Sin embargo, está bien usarlo para ahorrar tecleo en sesiones interactivas.

Si el nombre del módulo es seguido por @code{as}, el nombre siguiendo @code{as} queda ligado directamente al módulo importado.

@example
>>> import fibo as fib
>>> fib.fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

Esto es básicamente importar el módulo de la misma forma que se haría con @code{import fibo}, con la única diferencia en que se encuentra accesible como @code{fib}.

También se puede utilizar cuando se utiliza @ref{1317,,from} con efectos similares:

@example
>>> from fibo import fib as fibonacci
>>> fibonacci(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

@cartouche
@quotation Nota 
Por razones de eficiencia, cada módulo es importado solo una vez por sesión del intérprete. Por lo tanto, si cambias tus módulos, debes reiniciar el interprete – ó, si es un solo módulo que quieres probar de forma interactiva, usa @ref{5bd,,importlib.reload()}, por ejemplo: @code{import importlib; importlib.reload(modulename)}.
@end quotation
@end cartouche

@menu
* Ejecutar módulos como scripts:: 
* El camino de búsqueda de los módulos:: 
* Archivos «compilados» de Python:: 

@end menu

@node Ejecutar módulos como scripts,El camino de búsqueda de los módulos,,Más sobre los módulos
@anchor{tutorial/modules executing-modules-as-scripts}@anchor{1c62}@anchor{tutorial/modules tut-modulesasscripts}@anchor{1c63}
@subsubsection Ejecutar módulos como scripts


Cuando ejecutes un módulo de Python con

@example
python fibo.py <arguments>
@end example

el código en el módulo será ejecutado, tal como si lo hubieses importado, pero con @code{__name__} con el valor de @code{"__main__"}.  Eso significa que agregando este código al final de tu módulo:

@example
if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))
@end example

puedes hacer que el archivo sea utilizable tanto como script, como módulo importable, porque el código que analiza la línea de órdenes sólo se ejecuta si el módulo es ejecutado como archivo principal:

@example
$ python fibo.py 50
0 1 1 2 3 5 8 13 21 34
@end example

Si el módulo se importa, ese código no se ejecuta:

@example
>>> import fibo
>>>
@end example

Esto es frecuentemente usado para proveer al módulo una interfaz de usuario conveniente, o para fines de prueba (ejecutar el módulo como un script que ejecuta un conjunto de pruebas).

@node El camino de búsqueda de los módulos,Archivos «compilados» de Python,Ejecutar módulos como scripts,Más sobre los módulos
@anchor{tutorial/modules the-module-search-path}@anchor{1c64}@anchor{tutorial/modules tut-searchpath}@anchor{1c65}
@subsubsection El camino de búsqueda de los módulos


@geindex module;search;path

Cuando se importa un módulo llamado @code{spam}, el intérprete busca primero por un módulo con ese nombre que esté integrado en el intérprete. Estos nombres de módulos están listados en @ref{1c66,,sys.builtin_module_names}. Si no lo encuentra, entonces busca un archivo llamado @code{spam.py} en una lista de directorios especificada por la variable @ref{27e,,sys.path}. @ref{27e,,sys.path} se inicializa con las siguientes ubicaciones:


@itemize *

@item 
El directorio que contiene el script de entrada (o el directorio actual cuando no se especifica archivo).

@item 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} (una lista de nombres de directorios, con la misma sintaxis que la variable de la terminal 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}).

@item 
El valor predeterminado dependiente de la instalación (por convención incluye un directorio @code{site-packages}, manejado por el módulo @ref{c7,,site}).
@end itemize

Más detalles en @ref{1c67,,La inicialización de la ruta de búsqueda de módulo de sys.path}.

@cartouche
@quotation Nota 
En los sistemas de archivo que soportan enlaces simbólicos, el directorio que contiene el script de entrada es calculado luego de seguir el enlace simbólico. En otras palabras, el directorio que contiene el enlace simbólico `no' es agregado al camino de búsqueda del módulo.
@end quotation
@end cartouche

Luego de la inicialización, los programas Python pueden modificar @ref{27e,,sys.path}. El directorio que contiene el script que se está ejecutando se ubica al principio de la búsqueda, adelante de la biblioteca estándar. Esto significa que se cargarán scripts en ese directorio en lugar de módulos de la biblioteca estándar con el mismo nombre. Esto es un error a menos que se esté reemplazando intencionalmente. Mirá la sección @ref{1c68,,Módulos estándar} para más información.

@c %
@c Do we need stuff on zip files etc. ? DUBOIS

@node Archivos «compilados» de Python,,El camino de búsqueda de los módulos,Más sobre los módulos
@anchor{tutorial/modules compiled-python-files}@anchor{1c69}@anchor{tutorial/modules tut-pycache}@anchor{77c}
@subsubsection Archivos «compilados» de Python


Para acelerar la carga de módulos, Python cachea las versiones compiladas de cada módulo en el directorio @code{__pycache__} bajo el nombre @code{module.`version'.pyc}, dónde la versión codifica el formato del archivo compilado; generalmente contiene el número de versión de Python. Por ejemplo, en CPython `release' 3.3 la versión compilada de spam.py sería cacheada como @code{__pycache__/spam.cpython-33.pyc}. Este convención de nombre permite compilar módulos desde diferentes `releases' y versiones de Python para coexistir.

Python chequea la fecha de modificación de la fuente contra la versión compilada para ver si esta es obsoleta y necesita ser recompilada. Esto es un proceso completamente automático. También, los módulos compilados son independientes de la plataforma, así que la misma biblioteca puede ser compartida a través de sistemas con diferentes arquitecturas.

Python no chequea el caché en dos circunstancias. Primero, siempre recompila y no graba el resultado del módulo que es cargado directamente desde la línea de comando. Segundo, no chequea el caché si no hay módulo fuente. Para soportar una distribución sin fuente (solo compilada), el módulo compilado debe estar en el directorio origen, y no debe haber un módulo fuente.

Algunos consejos para expertos:


@itemize *

@item 
Puedes usar los modificadores @ref{14f,,-O} o @ref{e3b,,-OO} en el comando de Python para reducir el tamaño del módulo compilado. El modificador @code{-O} remueve las declaraciones `assert', el modificador @code{-OO} remueve declaraciones `assert' y cadenas `__doc__'. Dado que algunos programas pueden confiar en tenerlos disponibles, solo deberías usar esta opción si conoces lo que estás haciendo. Los módulos «optimizados» tienen una etiqueta @code{opt-} y generalmente son mas pequeños. `Releases' futuras pueden cambiar los efectos de la optimización.

@item 
Un programa no se ejecuta mas rápido cuando es leído de un archivo @code{.pyc} que cuando es leído de un archivo @code{.py}; la única cosa que es mas rápida en los archivos @code{.pyc} es la velocidad con la cual son cargados.

@item 
El módulo @ref{21,,compileall} puede crear archivos .pyc para todos los módulos en un directorio.

@item 
Hay mas detalle de este proceso, incluyendo un diagrama de flujo de decisiones, en 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}.
@end itemize

@node Módulos estándar,La función dir,Más sobre los módulos,Módulos<2>
@anchor{tutorial/modules standard-modules}@anchor{1c6a}@anchor{tutorial/modules tut-standardmodules}@anchor{1c68}
@subsection Módulos estándar


@geindex module;sys

Python viene con una biblioteca de módulos estándar, descrita en un documento separado, la Referencia de la Biblioteca de Python (de aquí en más, «Referencia de la Biblioteca»). Algunos módulos se integran en el intérprete; estos proveen acceso a operaciones que no son parte del núcleo del lenguaje pero que sin embargo están integrados, tanto por eficiencia como para proveer acceso a primitivas del sistema operativo, como llamadas al sistema. El conjunto de tales módulos es una opción de configuración que también depende de la plataforma subyacente. Por ejemplo, el módulo @ref{116,,winreg} sólo se provee en sistemas Windows. Un módulo en particular merece algo de atención: @ref{d9,,sys}, el que está integrado en todos los intérpretes de Python. Las variables @code{sys.ps1} y @code{sys.ps2} definen las cadenas usadas como cursores primarios y secundarios:

@example
>>> import sys
>>> sys.ps1
'>>> '
>>> sys.ps2
'... '
>>> sys.ps1 = 'C> '
C> print('Yuck!')
Yuck!
C>
@end example

Estas dos variables están solamente definidas si el intérprete está en modo interactivo.

La variable @code{sys.path} es una lista de cadenas que determinan el camino de búsqueda del intérprete para los módulos. Se inicializa por omisión a un camino tomado de la variable de entorno 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}, o a un valor predefinido en el intérprete si 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} no está configurada. Lo puedes modificar usando las operaciones estándar de listas:

@example
>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')
@end example

@node La función dir,Paquetes,Módulos estándar,Módulos<2>
@anchor{tutorial/modules the-dir-function}@anchor{1c6b}@anchor{tutorial/modules tut-dir}@anchor{1c6c}
@subsection La función @code{dir()}


La función integrada @ref{6d3,,dir()} se usa para encontrar qué nombres define un módulo.  Retorna una lista ordenada de cadenas:

@example
>>> import fibo, sys
>>> dir(fibo)
['__name__', 'fib', 'fib2']
>>> dir(sys)  
['__breakpointhook__', '__displayhook__', '__doc__', '__excepthook__',
 '__interactivehook__', '__loader__', '__name__', '__package__', '__spec__',
 '__stderr__', '__stdin__', '__stdout__', '__unraisablehook__',
 '_clear_type_cache', '_current_frames', '_debugmallocstats', '_framework',
 '_getframe', '_git', '_home', '_xoptions', 'abiflags', 'addaudithook',
 'api_version', 'argv', 'audit', 'base_exec_prefix', 'base_prefix',
 'breakpointhook', 'builtin_module_names', 'byteorder', 'call_tracing',
 'callstats', 'copyright', 'displayhook', 'dont_write_bytecode', 'exc_info',
 'excepthook', 'exec_prefix', 'executable', 'exit', 'flags', 'float_info',
 'float_repr_style', 'get_asyncgen_hooks', 'get_coroutine_origin_tracking_depth',
 'getallocatedblocks', 'getdefaultencoding', 'getdlopenflags',
 'getfilesystemencodeerrors', 'getfilesystemencoding', 'getprofile',
 'getrecursionlimit', 'getrefcount', 'getsizeof', 'getswitchinterval',
 'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info',
 'intern', 'is_finalizing', 'last_traceback', 'last_type', 'last_value',
 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path', 'path_hooks',
 'path_importer_cache', 'platform', 'prefix', 'ps1', 'ps2', 'pycache_prefix',
 'set_asyncgen_hooks', 'set_coroutine_origin_tracking_depth', 'setdlopenflags',
 'setprofile', 'setrecursionlimit', 'setswitchinterval', 'settrace', 'stderr',
 'stdin', 'stdout', 'thread_info', 'unraisablehook', 'version', 'version_info',
 'warnoptions']
@end example

Sin argumentos, @ref{6d3,,dir()} lista los nombres que tienes actualmente definidos:

@example
>>> a = [1, 2, 3, 4, 5]
>>> import fibo
>>> fib = fibo.fib
>>> dir()
['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']
@end example

Nótese que lista todos los tipos de nombres: variables, módulos, funciones, etc.

@geindex module;builtins

@ref{6d3,,dir()} no lista los nombres de las funciones y variables integradas. Si quieres una lista de esos, están definidos en el módulo estándar @ref{13,,builtins}:

@example
>>> import builtins
>>> dir(builtins)  
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException',
 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning',
 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError',
 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning',
 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False',
 'FileExistsError', 'FileNotFoundError', 'FloatingPointError',
 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError',
 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError',
 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError',
 'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented',
 'NotImplementedError', 'OSError', 'OverflowError',
 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError',
 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning',
 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError',
 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError',
 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError',
 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning',
 'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__',
 '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs',
 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable',
 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits',
 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit',
 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',
 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass',
 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview',
 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property',
 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice',
 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars',
 'zip']
@end example

@node Paquetes,,La función dir,Módulos<2>
@anchor{tutorial/modules packages}@anchor{1c6d}@anchor{tutorial/modules tut-packages}@anchor{1c6e}
@subsection Paquetes


Los Paquetes son una forma de estructurar el espacio de nombres de módulos de Python usando «nombres de módulo con puntos». Por ejemplo, el nombre del módulo @code{A.B} designa un submódulo @code{B} en un paquete llamado @code{A}. Así como el uso de módulos salva a los autores de diferentes módulos de tener que preocuparse por los nombres de las variables globales de los demás, el uso de nombres de módulo con puntos evita que los autores de paquetes multimódulos, como NumPy o Pillow, tengan que preocuparse por los nombres de los módulos de los demás.

Supongamos que quieres designar una colección de módulos (un «paquete») para el manejo uniforme de archivos y datos de sonidos.  Hay diferentes formatos de archivos de sonido (normalmente reconocidos por su extensión, por ejemplo: @code{.wav}, @code{.aiff}, @code{.au}), por lo que tienes que crear y mantener una colección siempre creciente de módulos para la conversión entre los distintos formatos de archivos. Hay muchas operaciones diferentes que quizás quieras ejecutar en los datos de sonido (como mezclarlos, añadir eco, aplicar una función ecualizadora, crear un efecto estéreo artificial), por lo que además estarás escribiendo una lista sin fin de módulos para realizar estas operaciones.  Aquí hay una posible estructura para tu paquete (expresados en términos de un sistema jerárquico de archivos):

@example
sound/                          Top-level package
      __init__.py               Initialize the sound package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...
@end example

Al importar el paquete, Python busca a través de los directorios en @code{sys.path}, buscando el sub-directorio del paquete.

The @code{__init__.py} files are required to make Python treat directories
containing the file as packages (unless using a @ref{1b8,,namespace package}, a
relatively advanced feature). This prevents directories with a common name,
such as @code{string}, from unintentionally hiding valid modules that occur later
on the module search path. In the simplest case, @code{__init__.py} can just be
an empty file, but it can also execute initialization code for the package or
set the @code{__all__} variable, described later.

Los usuarios del paquete pueden importar módulos individuales del mismo, por ejemplo:

@example
import sound.effects.echo
@end example

Esto carga el submódulo @code{sound.effects.echo}. Debe hacerse referencia al mismo con el nombre completo.

@example
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)
@end example

Otra alternativa para importar el submódulo es:

@example
from sound.effects import echo
@end example

Esto también carga el submódulo @code{echo}, y lo deja disponible sin su prefijo de paquete, por lo que puede usarse así:

@example
echo.echofilter(input, output, delay=0.7, atten=4)
@end example

Otra variación más es importar la función o variable deseadas directamente:

@example
from sound.effects.echo import echofilter
@end example

De nuevo, esto carga el submódulo @code{echo}, pero deja directamente disponible a la función @code{echofilter()}:

@example
echofilter(input, output, delay=0.7, atten=4)
@end example

Nótese que al usar @code{from package import item}, el ítem puede ser tanto un submódulo (o subpaquete) del paquete, o algún otro nombre definido en el paquete, como una función, clase, o variable. La declaración @code{import} primero verifica si el ítem está definido en el paquete; si no, asume que es un módulo y trata de cargarlo. Si no lo puede encontrar, se genera una excepción @ref{4d7,,ImportError}.

Por otro lado, cuando se usa la sintaxis como @code{import item.subitem.subsubitem}, cada ítem excepto el último debe ser un paquete; el mismo puede ser un módulo o un paquete pero no puede ser una clase, función o variable definida en el ítem previo.

@menu
* Importar * desde un paquete:: 
* Referencias internas en paquetes:: 
* Paquetes en múltiples directorios:: 

@end menu

@node Importar * desde un paquete,Referencias internas en paquetes,,Paquetes
@anchor{tutorial/modules importing-from-a-package}@anchor{1c6f}@anchor{tutorial/modules tut-pkg-import-star}@anchor{1c70}
@subsubsection Importar * desde un paquete


@geindex __all__

Ahora, ¿qué sucede cuando el usuario escribe @code{from sound.effects import *}? Idealmente, uno esperaría que esto de alguna manera vaya al sistema de archivos, encuentre cuales submódulos están presentes en el paquete, y los importe a todos. Esto puede tardar mucho y el importar sub-módulos puede tener efectos secundarios no deseados que sólo deberían ocurrir cuando se importe explícitamente el sub-módulo.

La única solución es que el autor del paquete provea un índice explícito del paquete.  La declaración @ref{682,,import} usa la siguiente convención: si el código del @code{__init__.py} de un paquete define una lista llamada @code{__all__}, se toma como la lista de los nombres de módulos que deberían ser importados cuando se hace @code{from package import *}.  Es tarea del autor del paquete mantener actualizada esta lista cuando se libera una nueva versión del paquete.  Los autores de paquetes podrían decidir no soportarlo, si no ven un uso para importar * en sus paquetes.  Por ejemplo, el archivo @code{sound/effects/__init__.py} podría contener el siguiente código:

@example
__all__ = ["echo", "surround", "reverse"]
@end example

Esto significaría que @code{from sound.effects import *} importaría esos tres submódulos del paquete @code{sound.effects}.

Ten en cuenta que los submódulos pueden quedar ocultos por nombres definidos localmente. Por ejemplo, si agregaste una función llamada @code{reverse} al archivo @code{sound/effects/__init__.py}, @code{from sound.effects import *} solo importaría los dos submódulos @code{echo} y @code{surround}, pero `no' el submódulo @code{reverse} porque queda oculto por la función @code{reverse} definida localmente:

@example
__all__ = [
    "echo",      # refers to the 'echo.py' file
    "surround",  # refers to the 'surround.py' file
    "reverse",   # !!! refers to the 'reverse' function now !!!
]

def reverse(msg: str):  # <-- this name shadows the 'reverse.py' submodule
    return msg[::-1]    #     in the case of a 'from sound.effects import *'
@end example

Si no se define @code{__all__}, la declaración @code{from sound.effects import *} `no' importa todos los submódulos del paquete @code{sound.effects} al espacio de nombres actual; sólo se asegura que se haya importado el paquete @code{sound.effects} (posiblemente ejecutando algún código de inicialización que haya en @code{__init__.py}) y luego importa aquellos nombres que estén definidos en el paquete. Esto incluye cualquier nombre definido (y submódulos explícitamente cargados) por @code{__init__.py}. También incluye cualquier submódulo del paquete que pudiera haber sido explícitamente cargado por declaraciones @ref{682,,import} previas. Considere este código:

@example
import sound.effects.echo
import sound.effects.surround
from sound.effects import *
@end example

En este ejemplo, los módulos @code{echo} y @code{surround} se importan en el espacio de nombre actual porque están definidos en el paquete @code{sound.effects} cuando se ejecuta la declaración @code{from...import}. (Esto también funciona cuando se define @code{__all__}).

A pesar de que ciertos módulos están diseñados para exportar solo nombres que siguen ciertos patrones cuando uses @code{import *}, también se considera una mala práctica en código de producción.

Recuerda, ¡no hay nada malo al usar @code{from package import specific_submodule}! De hecho, esta es la notación recomendada a menos que el módulo que importamos necesite usar submódulos con el mismo nombre desde un paquete diferente.

@node Referencias internas en paquetes,Paquetes en múltiples directorios,Importar * desde un paquete,Paquetes
@anchor{tutorial/modules id2}@anchor{1c71}@anchor{tutorial/modules intra-package-references}@anchor{1c72}
@subsubsection Referencias internas en paquetes


Cuando se estructuran los paquetes en sub-paquetes (como en el ejemplo @code{sound}), puedes usar imports absolutos para referirte a submódulos de paquetes hermanos. Por ejemplo, si el módulo @code{sound.filters.vocoder} necesita usar el módulo @code{echo} en el paquete @code{sound.effects}, puede hacer @code{from sound.effects import echo}.

También puedes escribir imports relativos con la forma @code{from module import name}. Estos imports usan puntos adelante para indicar los paquetes actuales o paquetes padres involucrados en el import relativo. En el ejemplo @code{surround}, podrías hacer:

@example
from . import echo
from .. import formats
from ..filters import equalizer
@end example

Nótese que los imports relativos se basan en el nombre del módulo actual. Ya que el nombre del módulo principal es siempre @code{"__main__"}, los módulos pensados para usarse como módulo principal de una aplicación Python siempre deberían usar @code{import} absolutos.

@node Paquetes en múltiples directorios,,Referencias internas en paquetes,Paquetes
@anchor{tutorial/modules packages-in-multiple-directories}@anchor{1c73}
@subsubsection Paquetes en múltiples directorios


Packages support one more special attribute, @ref{1c74,,__path__}.  This is
initialized to be a @ref{597,,sequence} of strings containing the name of the
directory holding the
package’s @code{__init__.py} before the code in that file is executed.  This
variable can be modified; doing so affects future searches for modules and
subpackages contained in the package.

Aunque esta característica no se necesita frecuentemente, puede usarse para extender el conjunto de módulos que se encuentran en el paquete.

@subsubheading Notas al pie


@node Entrada y salida,Errores y excepciones,Módulos<2>,El tutorial de Python
@anchor{tutorial/inputoutput doc}@anchor{1c75}@anchor{tutorial/inputoutput input-and-output}@anchor{1c76}@anchor{tutorial/inputoutput tut-io}@anchor{1c77}
@section Entrada y salida


Hay diferentes métodos de presentar la salida de un programa; los datos pueden ser impresos de una forma legible por humanos, o escritos a un archivo para uso futuro. Este capítulo discutirá algunas de las posibilidades.

@menu
* Formateo elegante de la salida:: 
* Leyendo y escribiendo archivos:: 

@end menu

@node Formateo elegante de la salida,Leyendo y escribiendo archivos,,Entrada y salida
@anchor{tutorial/inputoutput fancier-output-formatting}@anchor{1c78}@anchor{tutorial/inputoutput tut-formatting}@anchor{1c79}
@subsection Formateo elegante de la salida


Hasta ahora encontramos dos maneras de escribir valores: `declaraciones de expresión' y la función @ref{ff4,,print()}. (Una tercera manera es usando el método @ref{1c7a,,write()} de los objetos tipo archivo; el archivo de salida estándar puede referenciarse como @code{sys.stdout}. Mirá la Referencia de la Biblioteca para más información sobre esto).

A menudo se querrá tener más control sobre el formato de la salida, y no simplemente imprimir valores separados por espacios. Para ello, hay varias maneras de dar formato a la salida.


@itemize *

@item 
Para usar @ref{1c7b,,literales de cadena formateados}, comience una cadena con @code{f} o @code{F} antes de la comilla de apertura o comillas triples. Dentro de esta cadena,  se puede escribir una expresión de Python entre los caracteres @code{@{} y @code{@}} que pueden hacer referencia a variables o valores literales.

@example
>>> year = 2016
>>> event = 'Referendum'
>>> f'Results of the @{year@} @{event@}'
'Results of the 2016 Referendum'
@end example

@item 
The @ref{6c2,,str.format()} method of strings requires more manual
effort.  You’ll still use @code{@{} and @code{@}} to mark where a variable
will be substituted and can provide detailed formatting directives,
but you’ll also need to provide the information to be formatted. In the following code
block there are two examples of how to format variables:

@example
>>> yes_votes = 42_572_654
>>> total_votes = 85_705_149
>>> percentage = yes_votes / total_votes
>>> '@{:-9@} YES votes  @{:2.2%@}'.format(yes_votes, percentage)
' 42572654 YES votes  49.67%'
@end example

Notice how the @code{yes_votes} are padded with spaces and a negative sign only for negative numbers.
The example also prints @code{percentage} multiplied by 100, with 2 decimal
places and followed by a percent sign (see @ref{347,,Especificación de formato Mini-Lenguaje} for details).

@item 
Por último, puede realizar todo el control de cadenas usted mismo mediante operaciones de concatenación y segmentación de cadenas para crear cualquier diseño que se pueda imaginar.  El tipo de cadena tiene algunos métodos que realizan operaciones útiles para rellenar cadenas a un ancho de columna determinado.
@end itemize

Cuando no necesita una salida elegante, pero solo desea una visualización rápida de algunas variables con fines de depuración, puede convertir cualquier valor en una cadena con las funciones @ref{894,,repr()} o @ref{237,,str()}.

La función @ref{237,,str()} retorna representaciones de los valores que son bastante legibles por humanos, mientras que @ref{894,,repr()} genera representaciones que pueden ser leídas por el intérprete (o forzarían un @ref{150,,SyntaxError} si no hay sintaxis equivalente). Para objetos que no tienen una representación en particular para consumo humano, @ref{237,,str()} retornará el mismo valor que @ref{894,,repr()}. Muchos valores, como números o estructuras como listas y diccionarios, tienen la misma representación usando cualquiera de las dos funciones.  Las cadenas, en particular, tienen dos representaciones distintas.

Algunos ejemplos:

@example
>>> s = 'Hello, world.'
>>> str(s)
'Hello, world.'
>>> repr(s)
"'Hello, world.'"
>>> str(1/7)
'0.14285714285714285'
>>> x = 10 * 3.25
>>> y = 200 * 200
>>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
>>> print(s)
The value of x is 32.5, and y is 40000...
>>> # The repr() of a string adds string quotes and backslashes:
>>> hello = 'hello, world\n'
>>> hellos = repr(hello)
>>> print(hellos)
'hello, world\n'
>>> # The argument to repr() may be any Python object:
>>> repr((x, y, ('spam', 'eggs')))
"(32.5, 40000, ('spam', 'eggs'))"
@end example

El módulo @ref{d3,,string} contiene una clase @ref{728,,Template} que ofrece otra forma de sustituir valores en cadenas, utilizando marcadores de posición como @code{$x} y reemplazarlos con valores desde un diccionario, pero esto ofrece mucho menos control en el formato.

@geindex formatted string literal
@geindex interpolated string literal
@geindex string;formatted literal
@geindex string;interpolated literal
@geindex f-string
@geindex fstring

@menu
* Formatear cadenas literales:: 
* El método format() de cadenas: El método format de cadenas. 
* Formateo manual de cadenas:: 
* Viejo formateo de cadenas:: 

@end menu

@node Formatear cadenas literales,El método format de cadenas,,Formateo elegante de la salida
@anchor{tutorial/inputoutput formatted-string-literals}@anchor{1c7c}@anchor{tutorial/inputoutput tut-f-strings}@anchor{1c7b}
@subsubsection Formatear cadenas literales


@ref{a3b,,Literales de cadena formateados} (también llamados f-strings para abreviar) le permiten incluir el valor de las expresiones de Python dentro de una cadena prefijando la cadena con @code{f} o @code{F} y escribiendo expresiones como @code{@{expresion@}}.

La expresión puede ir seguida de un especificador de formato opcional . Esto permite un mayor control sobre cómo se formatea el valor. En el ejemplo siguiente se redondea pi a tres lugares después del decimal:

@example
>>> import math
>>> print(f'The value of pi is approximately @{math.pi:.3f@}.')
The value of pi is approximately 3.142.
@end example

Pasar un entero después de @code{':'} hará que ese campo sea un número mínimo de caracteres de ancho. Esto es útil para hacer que las columnas se alineen.

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678@}
>>> for name, phone in table.items():
...     print(f'@{name:10@} ==> @{phone:10d@}')
...
Sjoerd     ==>       4127
Jack       ==>       4098
Dcab       ==>       7678
@end example

Se pueden utilizar otros modificadores para convertir el valor antes de formatearlo. @code{'!a'} se aplica @ref{1426,,ascii()}, @code{'!s'} se aplica @ref{237,,str()}, y @code{'!r'} se aplica @ref{894,,repr()}:

@example
>>> animals = 'eels'
>>> print(f'My hovercraft is full of @{animals@}.')
My hovercraft is full of eels.
>>> print(f'My hovercraft is full of @{animals!r@}.')
My hovercraft is full of 'eels'.
@end example

El especificador @code{=} puede utilizarse para expandir una expresión al texto de la expresión, un signo igual y, a continuación, la representación de la expresión evaluada:

@example
>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging @{bugs=@} @{count=@} @{area=@}')
Debugging bugs='roaches' count=13 area='living room'
@end example

Véase @ref{a39,,expresiones auto-documentadas} para más información en el especificador @code{=}. Para obtener una referencia sobre estas especificaciones de formato, consulte la guía de referencia para @ref{347,,Especificación de formato Mini-Lenguaje}.

@node El método format de cadenas,Formateo manual de cadenas,Formatear cadenas literales,Formateo elegante de la salida
@anchor{tutorial/inputoutput the-string-format-method}@anchor{1c7d}@anchor{tutorial/inputoutput tut-string-format}@anchor{1c7e}
@subsubsection El método format() de cadenas


El uso básico del método @ref{6c2,,str.format()} es como esto:

@example
>>> print('We are the @{@} who say "@{@}!"'.format('knights', 'Ni'))
We are the knights who say "Ni!"
@end example

Las llaves y caracteres dentro de las mismas (llamados campos de formato) son reemplazadas con los objetos pasados en el método @ref{6c2,,str.format()}.  Un número en las llaves se refiere a la posición del objeto pasado en el método @ref{6c2,,str.format()}.

@example
>>> print('@{0@} and @{1@}'.format('spam', 'eggs'))
spam and eggs
>>> print('@{1@} and @{0@}'.format('spam', 'eggs'))
eggs and spam
@end example

Si se usan argumentos nombrados en el método @ref{6c2,,str.format()}, sus valores se referencian usando el nombre del argumento.

@example
>>> print('This @{food@} is @{adjective@}.'.format(
...       food='spam', adjective='absolutely horrible'))
This spam is absolutely horrible.
@end example

Se pueden combinar arbitrariamente argumentos posicionales y nombrados:

@example
>>> print('The story of @{0@}, @{1@}, and @{other@}.'.format('Bill', 'Manfred',
...                                                    other='Georg'))
The story of Bill, Manfred, and Georg.
@end example

Si tiene una cadena de caracteres de formato realmente larga que no desea dividir, sería bueno si pudiera hacer referencia a las variables que se formatearán por nombre en lugar de por posición. Esto se puede hacer simplemente pasando el diccionario y usando corchetes @code{'[]'} para acceder a las claves.

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{0[Jack]:d@}; Sjoerd: @{0[Sjoerd]:d@}; '
...       'Dcab: @{0[Dcab]:d@}'.format(table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

Esto se podría hacer, también, pasando el diccionario @code{table} como argumentos por palabra clave con la notación “**”.

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{Jack:d@}; Sjoerd: @{Sjoerd:d@}; Dcab: @{Dcab:d@}'.format(**table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

This is particularly useful in combination with the built-in function
@ref{1a49,,vars()}, which returns a dictionary containing all local variables:

@example
>>> table = @{k: str(v) for k, v in vars().items()@}
>>> message = " ".join([f'@{k@}: ' + '@{' + k +'@};' for k in table.keys()])
>>> print(message.format(**table))
__name__: __main__; __doc__: None; __package__: None; __loader__: ...
@end example

Como ejemplo, las siguientes líneas producen un conjunto ordenado de columnas que dan enteros y sus cuadrados y cubos:

@example
>>> for x in range(1, 11):
...     print('@{0:2d@} @{1:3d@} @{2:4d@}'.format(x, x*x, x*x*x))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000
@end example

Para una completa descripción del formateo de cadenas con @ref{6c2,,str.format()}, ver @ref{1c7f,,Formato de cadena de caracteres personalizado}.

@node Formateo manual de cadenas,Viejo formateo de cadenas,El método format de cadenas,Formateo elegante de la salida
@anchor{tutorial/inputoutput manual-string-formatting}@anchor{1c80}
@subsubsection Formateo manual de cadenas


Aquí está la misma tabla de cuadrados y cubos, formateados manualmente:

@example
>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # Note use of 'end' on previous line
...     print(repr(x*x*x).rjust(4))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000
@end example

(Nótese que el espacio existente entre cada columna es añadido debido a como funciona @ref{ff4,,print()}: siempre añade espacios entre sus argumentos.)

El método @ref{1c81,,str.rjust()} de los objetos cadena justifica a la derecha en un campo de anchura predeterminada rellenando con espacios a la izquierda. Métodos similares a este son @ref{1c82,,str.ljust()} y @ref{1c83,,str.center()}. Estos métodos no escriben nada, simplemente retornan una nueva cadena. Si la cadena de entrada es demasiado larga no la truncarán sino que la retornarán sin cambios; esto desordenará la disposición de la columna que es, normalmente, mejor que la alternativa, la cual podría falsear un valor. (Si realmente deseas truncar siempre puedes añadir una operación de rebanado, como en @code{x.ljust(n)[:n]}.)

Hay otro método, @ref{14ee,,str.zfill()}, el cual rellena una cadena numérica a la izquierda con ceros. Entiende signos positivos y negativos:

@example
>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'
@end example

@node Viejo formateo de cadenas,,Formateo manual de cadenas,Formateo elegante de la salida
@anchor{tutorial/inputoutput old-string-formatting}@anchor{1c84}
@subsubsection Viejo formateo de cadenas


The % operator (modulo) can also be used for string formatting.
Given @code{format % values} (where `format' is a string),
@code{%} conversion specifications in `format' are replaced with
zero or more elements of `values'.
This operation is commonly known as string
interpolation. For example:

@example
>>> import math
>>> print('The value of pi is approximately %5.3f.' % math.pi)
The value of pi is approximately 3.142.
@end example

Podés encontrar más información en la sección @ref{76d,,Formateo de cadenas al estilo *printf*}.

@node Leyendo y escribiendo archivos,,Formateo elegante de la salida,Entrada y salida
@anchor{tutorial/inputoutput reading-and-writing-files}@anchor{1c85}@anchor{tutorial/inputoutput tut-files}@anchor{1c86}
@subsection Leyendo y escribiendo archivos


@geindex función incorporada;open
@geindex object;file

La función @ref{1be,,open()} retorna un @ref{1230,,file object}, y se usa normalmente con dos argumentos posicionales y un argumento nombrado: @code{open(nombre_de_archivo, modo, encoding=None)}

@example
>>> f = open('workfile', 'w', encoding="utf-8")
@end example

@c XXX str(f) is <io.TextIOWrapper object at 0x82e8dc4>
@c 
@c >>> print(f)
@c <open file 'workfile', mode 'w' at 80a0960>

El primer argumento es una cadena que contiene el nombre del fichero. El segundo argumento es otra cadena que contiene unos pocos caracteres describiendo la forma en que el fichero será usado. `mode' puede ser @code{'r'} cuando el fichero solo se leerá, @code{'w'} para solo escritura (un fichero existente con el mismo nombre se borrará) y @code{'a'} abre el fichero para agregar; cualquier dato que se escribe en el fichero se añade automáticamente al final. @code{'r+'} abre el fichero tanto para lectura como para escritura. El argumento `mode' es opcional; se asume que se usará @code{'r'} si se omite.

Normalmente, los ficheros se abren en `modo texto', es decir, se leen y escriben cadenas desde y hacia el fichero, que están codificadas en una `codificación' específica. Si no se especifica `codificación', el valor por defecto depende de la plataforma (véase @ref{1be,,open()}). Dado que UTF-8 es el estándar moderno de facto, se recomienda @code{encoding="utf-8"} a menos que sepa que necesita usar una codificación diferente. Añadiendo @code{'b'} al modo se abre el fichero en `modo binario'. Los datos en modo binario se leen y escriben como objetos @ref{325,,bytes}. No se puede especificar `codificación' al abrir un fichero en modo binario.

Cuando se lee en modo texto, por defecto se convierten los fin de lineas que son específicos a las plataformas (@code{\n} en Unix, @code{\r\n} en Windows) a solamente @code{\n}. Cuando se escribe en modo texto, por defecto se convierten los @code{\n} a los fin de linea específicos de la plataforma. Este cambio automático está bien para archivos de texto, pero corrompería datos binarios como los de archivos @code{JPEG} o @code{EXE}. Asegúrese de usar modo binario cuando lea y escriba tales archivos.

Es una buena práctica usar la declaración @ref{673,,with} cuando manejamos objetos archivo. Tiene la ventaja de que el archivo es cerrado apropiadamente luego de que el bloque termina, incluso si se generó una excepción. También es mucho más corto que escribir los equivalentes bloques @ref{789,,try}-@ref{a5c,,finally}

@example
>>> with open('workfile', encoding="utf-8") as f:
...     read_data = f.read()

>>> # We can check that the file has been automatically closed.
>>> f.closed
True
@end example

Si no está utilizando la palabra clave @ref{673,,with}, entonces debe llamar a @code{f.close()} para cerrar el archivo y liberar inmediatamente los recursos del sistema utilizados por él.

@cartouche
@quotation Advertencia 
Llamar a @code{f.write()} sin usar la palabra clave @code{with} o sin llamar a @code{f.close()} `podría' dar como resultado que los argumentos de @code{f.write()} no se escriban completamente en disco, incluso si el programa se termina correctamente.
@end quotation
@end cartouche

@c See also https://bugs.python.org/issue17852

Después de que un objeto de archivo es cerrado, ya sea por @ref{673,,with} o llamando a @code{f.close()}, intentar volver a utilizarlo fallará automáticamente:

@example
>>> f.close()
>>> f.read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: I/O operation on closed file.
@end example

@menu
* Métodos de los objetos Archivo:: 
* Guardar datos estructurados con json:: 

@end menu

@node Métodos de los objetos Archivo,Guardar datos estructurados con json,,Leyendo y escribiendo archivos
@anchor{tutorial/inputoutput methods-of-file-objects}@anchor{1c87}@anchor{tutorial/inputoutput tut-filemethods}@anchor{1c88}
@subsubsection Métodos de los objetos Archivo


El resto de los ejemplos en esta sección asumirán que ya se creó un objeto archivo llamado @code{f}.

Para leer el contenido de una archivo utiliza @code{f.read(size)}, el cual lee alguna cantidad de datos y los retorna como una cadena (en modo texto) o un objeto de bytes (en modo binario). `size' es un argumento numérico opcional. Cuando se omite `size' o es negativo, el contenido entero del archivo será leído y retornado; es tu problema si el archivo es el doble de grande que la memoria de tu máquina. De otra manera, son leídos y retornados como máximo `size' caracteres (en modo texto) o `size' bytes (en modo binario). Si se alcanzó el fin del archivo, @code{f.read()} retornará una cadena vacía (@code{'@w{'}}).

@example
>>> f.read()
'This is the entire file.\n'
>>> f.read()
'@w{'}
@end example

@code{f.readline()} lee una sola linea del archivo; el carácter de fin de linea (@code{\n}) se deja al final de la cadena, y sólo se omite en la última linea del archivo si el mismo no termina en un fin de linea. Esto hace que el valor de retorno no sea ambiguo; si @code{f.readline()} retorna una cadena vacía, es que se alcanzó el fin del archivo, mientras que una linea en blanco es representada por @code{'\n'}, una cadena conteniendo sólo un único fin de linea.

@example
>>> f.readline()
'This is the first line of the file.\n'
>>> f.readline()
'Second line of the file\n'
>>> f.readline()
'@w{'}
@end example

Para leer líneas de un archivo, puedes iterar sobre el objeto archivo. Esto es eficiente en memoria, rápido, y conduce a un código más simple:

@example
>>> for line in f:
...     print(line, end='@w{'})
...
This is the first line of the file.
Second line of the file
@end example

Si querés leer todas las líneas de un archivo en una lista también podés usar @code{list(f)} o @code{f.readlines()}.

@code{f.write(cadena)} escribe el contenido de la `cadena' al archivo, retornando la cantidad de caracteres escritos.

@example
>>> f.write('This is a test\n')
15
@end example

Otros tipos de objetos necesitan ser convertidos – tanto a una cadena (en modo texto) o a un objeto de bytes (en modo binario) – antes de escribirlos:

@example
>>> value = ('the answer', 42)
>>> s = str(value)  # convert the tuple to string
>>> f.write(s)
18
@end example

@code{f.tell()} retorna un entero que indica la posición actual en el archivo representada como número de bytes desde el comienzo del archivo en modo binario y un número opaco en modo texto.

Para cambiar la posición del objeto archivo, utiliza @code{f.seek(offset, whence)}. La posición es calculada agregando el `offset' a un punto de referencia; el punto de referencia se selecciona del argumento `whence'. Un valor `whence' de 0 mide desde el comienzo del archivo, 1 usa la posición actual del archivo, y 2 usa el fin del archivo como punto de referencia.  `whence' puede omitirse, el valor por defecto es 0, usando el comienzo del archivo como punto de referencia.

@example
>>> f = open('workfile', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # Go to the 6th byte in the file
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # Go to the 3rd byte before the end
13
>>> f.read(1)
b'd'
@end example

En los archivos de texto (aquellos que se abrieron sin una @code{b} en el modo), se permiten solamente desplazamientos con @code{seek} relativos al comienzo (con la excepción de ir justo al final con @code{seek(0, 2)}) y los únicos valores de `desplazamiento' válidos son aquellos retornados por @code{f.tell()}, o cero. Cualquier otro valor de `desplazamiento' produce un comportamiento indefinido.

Los objetos archivo tienen algunos métodos más, como @ref{1c89,,isatty()} y @ref{1379,,truncate()} que son usados menos frecuentemente; consultá la Referencia de la Biblioteca para una guía completa sobre los objetos archivo.

@node Guardar datos estructurados con json,,Métodos de los objetos Archivo,Leyendo y escribiendo archivos
@anchor{tutorial/inputoutput saving-structured-data-with-json}@anchor{1c8a}@anchor{tutorial/inputoutput tut-json}@anchor{1c8b}
@subsubsection Guardar datos estructurados con @code{json}


@geindex módulo;json

Las cadenas pueden fácilmente escribirse y leerse de un archivo. Los números toman algo más de esfuerzo, ya que el método @ref{1c8c,,read()} sólo retorna cadenas, que tendrán que ser pasadas a una función como @ref{1f0,,int()}, que toma una cadena como @code{'123'} y retorna su valor numérico 123. Sin embargo, cuando querés guardar tipos de datos más complejos como listas, diccionarios, o instancias de clases, las cosas se ponen más complicadas.

En lugar de tener a los usuarios constantemente escribiendo y debugueando código para guardar tipos de datos complicados, Python te permite usar el popular formato intercambiable de datos llamado JSON (JavaScript Object Notation)@footnote{http://json.org}. El módulo estándar llamado @ref{82,,json} puede tomar datos de Python con una jerarquía, y convertirlo a representaciones de cadena de caracteres; este proceso es llamado `serialización'. Reconstruir los datos desde la representación de cadena de caracteres es llamado `deserialización'. Entre serialización y deserialización, la cadena de caracteres representando el objeto quizás haya sido guardado en un archivo o datos, o enviado a una máquina distante por una conexión de red.

@cartouche
@quotation Nota 
El formato JSON es comúnmente usado por aplicaciones modernas para permitir el intercambio de datos. Muchos programadores ya están familiarizados con él, lo cual lo convierte en una buena opción para la interoperabilidad.
@end quotation
@end cartouche

Si tienes un objeto @code{x}, puedes ver su representación JSON con una simple línea de código:

@example
>>> import json
>>> x = [1, 'simple', 'list']
>>> json.dumps(x)
'[1, "simple", "list"]'
@end example

Otra variante de la función @ref{dcc,,dumps()}, llamada @ref{dcb,,dump()}, simplemente serializa el objeto a un @ref{1c8d,,archivo de texto}. Así que, si @code{f} es un objeto @ref{1c8d,,archivo de texto} abierto para escritura, podemos hacer:

@example
json.dump(x, f)
@end example

Para decodificar un objeto nuevamente, si @code{f} es un objeto @ref{1c8e,,binary file} o @ref{1c8d,,text file} que fue abierto para lectura:

@example
x = json.load(f)
@end example

@cartouche
@quotation Nota 
Los archivos JSON deben estar codificados en UTF-8. Utilice @code{encoding="utf-8"} al abrir un archivo JSON como @ref{1c8d,,text file} tanto para lectura como para escritura.
@end quotation
@end cartouche

La simple técnica de serialización puede manejar listas y diccionarios, pero serializar instancias de clases arbitrarias en JSON requiere un poco de esfuerzo extra. La referencia del módulo @ref{82,,json} contiene una explicación de esto.


@subsubheading Ver también


@ref{a6,,pickle} - El módulo `pickle'

Contrariamente a @ref{1c8b,,JSON}, `pickle' es un protocolo que permite la serialización de objetos Python arbitrariamente complejos. Como tal, es específico de Python y no se puede utilizar para comunicarse con aplicaciones escritas en otros lenguajes. También es inseguro de forma predeterminada: deserializar los datos de `pickle' procedentes de un origen que no es de confianza puede ejecutar código arbitrario, si los datos fueron creados por un atacante experto.


@node Errores y excepciones,Clases,Entrada y salida,El tutorial de Python
@anchor{tutorial/errors doc}@anchor{1c8f}@anchor{tutorial/errors errors-and-exceptions}@anchor{1c90}@anchor{tutorial/errors tut-errors}@anchor{1c91}
@section Errores y excepciones


Hasta ahora los mensajes de error apenas habían sido mencionados, pero si has probado los ejemplos anteriores probablemente hayas visto algunos.  Hay (al menos) dos tipos diferentes de errores: `errores de sintaxis' y `excepciones'.

@menu
* Errores de sintaxis:: 
* Excepciones:: 
* Gestionando excepciones:: 
* Lanzando excepciones:: 
* Encadenamiento de excepciones:: 
* Excepciones definidas por el usuario:: 
* Definiendo acciones de limpieza:: 
* Acciones predefinidas de limpieza:: 
* Lanzando y gestionando múltiples excepciones no relacionadas:: 
* Enriqueciendo excepciones con notas:: 

@end menu

@node Errores de sintaxis,Excepciones,,Errores y excepciones
@anchor{tutorial/errors syntax-errors}@anchor{1c92}@anchor{tutorial/errors tut-syntaxerrors}@anchor{1c93}
@subsection Errores de sintaxis


Los errores de sintaxis, también conocidos como errores de interpretación, son quizás el tipo de queja más común que tenés cuando todavía estás aprendiendo Python:

@example
>>> while True print('Hello world')
  File "<stdin>", line 1
    while True print('Hello world')
               ^^^^^
SyntaxError: invalid syntax
@end example

The parser repeats the offending line and displays little “arrow’s pointing
at the token in the line where the error was detected.  The error may be
caused by the absence of a token `before' the indicated token.  In the
example, the error is detected at the function @ref{ff4,,print()}, since a colon
(@code{':'}) is missing before it.  File name and line number are printed so you
know where to look in case the input came from a script.

@node Excepciones,Gestionando excepciones,Errores de sintaxis,Errores y excepciones
@anchor{tutorial/errors exceptions}@anchor{1c94}@anchor{tutorial/errors tut-exceptions}@anchor{1c95}
@subsection Excepciones


Incluso si una declaración o expresión es sintácticamente correcta, puede generar un error cuando se intenta ejecutar.  Los errores detectados durante la ejecución se llaman `excepciones', y no son incondicionalmente fatales: pronto aprenderás a gestionarlos en programas Python.  Sin embargo, la mayoría de las excepciones no son gestionadas por el código, y resultan en mensajes de error como los mostrados aquí:

@example
>>> 10 * (1/0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    10 * (1/0)
          ~^~
ZeroDivisionError: division by zero
>>> 4 + spam*3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    4 + spam*3
        ^^^^
NameError: name 'spam' is not defined
>>> '2' + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    '2' + 2
    ~~~~^~~
TypeError: can only concatenate str (not "int") to str
@end example

La última línea de los mensajes de error indica qué ha sucedido.  Hay excepciones de diferentes tipos, y el tipo se imprime como parte del mensaje: los tipos en el ejemplo son: @ref{9d8,,ZeroDivisionError}, @ref{4ec,,NameError} y @ref{228,,TypeError}.  La cadena mostrada como tipo de la excepción es el nombre de la excepción predefinida que ha ocurrido.  Esto es válido para todas las excepciones predefinidas del intérprete, pero no tiene por que ser así para excepciones definidas por el usuario (aunque es una convención útil).  Los nombres de las excepciones estándar son identificadores incorporados al intérprete (no son palabras clave reservadas).

El resto de la línea provee información basado en el tipo de la excepción y qué la causó.

La parte anterior del mensaje de error muestra el contexto donde ocurrió la excepción, en forma de seguimiento de pila. En general, contiene un seguimiento de pila que enumera las líneas de origen; sin embargo, no mostrará las líneas leídas desde la entrada estándar.

@ref{188b,,Excepciones incorporadas} lista las excepciones predefinidas y sus significados.

@node Gestionando excepciones,Lanzando excepciones,Excepciones,Errores y excepciones
@anchor{tutorial/errors handling-exceptions}@anchor{1c96}@anchor{tutorial/errors tut-handling}@anchor{1c1e}
@subsection Gestionando excepciones


Es posible escribir programas que gestionen determinadas excepciones.  Véase el siguiente ejemplo, que le pide al usuario una entrada hasta que ingrese un entero válido, pero permite al usuario interrumpir el programa (usando @code{Control-C} o lo que soporte el sistema operativo); nótese que una interrupción generada por el usuario es señalizada generando la excepción @ref{a63,,KeyboardInterrupt}.

@example
>>> while True:
...     try:
...         x = int(input("Please enter a number: "))
...         break
...     except ValueError:
...         print("Oops!  That was no valid number.  Try again...")
...
@end example

La sentencia @ref{789,,try} funciona de la siguiente manera.


@itemize *

@item 
Primero, se ejecuta la cláusula `try' (la(s) linea(s) entre las palabras reservadas @ref{789,,try} y la @ref{2f6,,except}).

@item 
Si no ocurre ninguna excepción, la cláusula `except' se omite y la ejecución de la cláusula @ref{789,,try} finaliza.

@item 
Si ocurre una excepción durante la ejecución de la cláusula @ref{789,,try}, se omite el resto de la cláusula. Luego, si su tipo coincide con la excepción nombrada después de la palabra clave @ref{2f6,,except}, se ejecuta la `cláusula except', y luego la ejecución continúa después del bloque try/except.

@item 
If an exception occurs which does not match the exception named in the `except
clause', it is passed on to outer @ref{789,,try} statements; if no handler is
found, it is an `unhandled exception' and execution stops with an error message.
@end itemize

Una declaración @ref{789,,try} puede tener más de una `cláusula except', para especificar gestores para diferentes excepciones. Como máximo, se ejecutará un gestor. Los gestores solo manejan las excepciones que ocurren en la `cláusula try' correspondiente, no en otros gestores de la misma declaración @code{try}. Una `cláusula except' puede nombrar múltiples excepciones como una tupla entre paréntesis, por ejemplo:

@example
... except (RuntimeError, TypeError, NameError):
...     pass
@end example

A class in an @ref{2f6,,except} clause matches exceptions which are instances of the
class itself or one of its derived classes (but not the other way around — an
`except clause' listing a derived class does not match instances of its base classes).
For example, the following code will print B, C, D in that order:

@example
class B(Exception):
    pass

class C(B):
    pass

class D(C):
    pass

for cls in [B, C, D]:
    try:
        raise cls()
    except D:
        print("D")
    except C:
        print("C")
    except B:
        print("B")
@end example

Nótese que si las `cláusulas except' estuvieran invertidas (con @code{except B} primero), habría impreso B, B, B — se usa la primera `cláusula except' coincidente.

Cuando ocurre una excepción, puede tener un valor asociado, también conocido como el `argumento' de la excepción.  La presencia y el tipo de argumento depende del tipo de excepción.

La `cláusula except' puede especificar una variable después del nombre de la excepción. La variable está ligada a la instancia de la excepción, que normalmente tiene un atributo @code{args} que almacena los argumentos. Por conveniencia, los tipos de excepción incorporados definen @ref{6be,,__str__()} para imprimir todos los argumentos sin acceder explícitamente a @code{.args}.

@example
>>> try:
...     raise Exception('spam', 'eggs')
... except Exception as inst:
...     print(type(inst))    # the exception type
...     print(inst.args)     # arguments stored in .args
...     print(inst)          # __str__ allows args to be printed directly,
...                          # but may be overridden in exception subclasses
...     x, y = inst.args     # unpack args
...     print('x =', x)
...     print('y =', y)
...
<class 'Exception'>
('spam', 'eggs')
('spam', 'eggs')
x = spam
y = eggs
@end example

La salida @ref{6be,,__str__()} de la excepción se imprime como la última parte (“detalle”) del mensaje para las excepciones no gestionadas.

@ref{65c,,BaseException} es la clase base común de todas las excepciones. Una de sus subclases, @ref{a6b,,Exception}, es la clase base de todas las excepciones no fatales. Las excepciones que no son subclases de @ref{a6b,,Exception} no se suelen manejar, porque se utilizan para indicar que el programa debe terminar. Entre ellas se incluyen @ref{dc7,,SystemExit}, que es lanzada por @ref{13b0,,sys.exit()} y @ref{a63,,KeyboardInterrupt}, que se lanza cuando un usuario desea interrumpir el programa.

@ref{a6b,,Exception} se puede utilizar como un comodín que atrapa (casi) todo. Sin embargo, es una buena práctica ser lo más específico posible con los tipos de excepciones que pretendemos manejar, y permitir que cualquier excepción inesperada se propague.

El patrón más común para gestionar @ref{a6b,,Exception} es imprimir o registrar la excepción y luego volver a re-lanzarla (permitiendo a un llamador manejar la excepción también):

@example
import sys

try:
    f = open('myfile.txt')
    s = f.readline()
    i = int(s.strip())
except OSError as err:
    print("OS error:", err)
except ValueError:
    print("Could not convert data to an integer.")
except Exception as err:
    print(f"Unexpected @{err=@}, @{type(err)=@}")
    raise
@end example

La declaración @ref{789,,try} … @ref{2f6,,except} tiene una `cláusula else' opcional, que, cuando está presente, debe seguir todas las `cláusulas except'. Es útil para el código que debe ejecutarse si la `cláusula try' no lanza una excepción. Por ejemplo:

@example
for arg in sys.argv[1:]:
    try:
        f = open(arg, 'r')
    except OSError:
        print('cannot open', arg)
    else:
        print(arg, 'has', len(f.readlines()), 'lines')
        f.close()
@end example

El uso de la cláusula @code{else} es mejor que agregar código adicional en la cláusula @ref{789,,try} porque evita capturar accidentalmente una excepción que no fue generada por el código que está protegido por la declaración @code{try} … @code{except}.

Los gestores de excepciones no sólo gestionan excepciones que ocurren inmediatamente en la `cláusula try', sino también aquellas que ocurren dentro de funciones que son llamadas (incluso indirectamente) en la `cláusula try'. Por ejemplo:

@example
>>> def this_fails():
...     x = 1/0
...
>>> try:
...     this_fails()
... except ZeroDivisionError as err:
...     print('Handling run-time error:', err)
...
Handling run-time error: division by zero
@end example

@node Lanzando excepciones,Encadenamiento de excepciones,Gestionando excepciones,Errores y excepciones
@anchor{tutorial/errors raising-exceptions}@anchor{1c97}@anchor{tutorial/errors tut-raising}@anchor{1c98}
@subsection Lanzando excepciones


La declaración @ref{68d,,raise} permite al programador forzar a que ocurra una excepción específica.  Por ejemplo:

@example
>>> raise NameError('HiThere')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    raise NameError('HiThere')
NameError: HiThere
@end example

El único argumento de @ref{68d,,raise} indica la excepción a lanzar. Debe ser una instancia de excepción o una clase de excepción (una clase que derive de @ref{65c,,BaseException}, como @ref{a6b,,Exception} o una de sus subclases). Si se pasa una clase de excepción, se instanciará implícitamente llamando a su constructor sin argumentos:

@example
raise ValueError  # shorthand for 'raise ValueError()'
@end example

Si es necesario determinar si una excepción fue lanzada pero sin intención de gestionarla, una versión simplificada de la instrucción @ref{68d,,raise} te permite relanzarla:

@example
>>> try:
...     raise NameError('HiThere')
... except NameError:
...     print('An exception flew by!')
...     raise
...
An exception flew by!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise NameError('HiThere')
NameError: HiThere
@end example

@node Encadenamiento de excepciones,Excepciones definidas por el usuario,Lanzando excepciones,Errores y excepciones
@anchor{tutorial/errors exception-chaining}@anchor{1c99}@anchor{tutorial/errors tut-exception-chaining}@anchor{1c9a}
@subsection Encadenamiento de excepciones


Si se produce una excepción no gestionada dentro de una sección @ref{2f6,,except}, se le adjuntará la excepción que se está gestionando y se incluirá en el mensaje de error:

@example
>>> try:
...     open("database.sqlite")
... except OSError:
...     raise RuntimeError("unable to handle error")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    open("database.sqlite")
    ~~~~^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'database.sqlite'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("unable to handle error")
RuntimeError: unable to handle error
@end example

Para indicar que una excepción es consecuencia directa de otra, la sentencia @ref{68d,,raise} permite una cláusula opcional @ref{68d,,from}:

@example
# exc must be exception instance or None.
raise RuntimeError from exc
@end example

Esto puede resultar útil cuando está transformando excepciones. Por ejemplo:

@example
>>> def func():
...     raise ConnectionError
...
>>> try:
...     func()
... except ConnectionError as exc:
...     raise RuntimeError('Failed to open database') from exc
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    func()
    ~~~~^^
  File "<stdin>", line 2, in func
ConnectionError

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError('Failed to open database') from exc
RuntimeError: Failed to open database
@end example

También permite deshabilitar el encadenamiento automático de excepciones utilizando el modismo @code{from None}:

@example
>>> try:
...     open('database.sqlite')
... except OSError:
...     raise RuntimeError from None
...
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError from None
RuntimeError
@end example

Para obtener más información sobre la mecánica del encadenamiento, consulte @ref{188b,,Excepciones incorporadas}.

@node Excepciones definidas por el usuario,Definiendo acciones de limpieza,Encadenamiento de excepciones,Errores y excepciones
@anchor{tutorial/errors tut-userexceptions}@anchor{1c9b}@anchor{tutorial/errors user-defined-exceptions}@anchor{1c9c}
@subsection Excepciones definidas por el usuario


Los programas pueden nombrar sus propias excepciones creando una nueva clase excepción (mirá @ref{1c26,,Clases} para más información sobre las clases de Python).  Las excepciones, típicamente, deberán derivar de la clase @ref{a6b,,Exception}, directa o indirectamente.

Las clases de Excepción pueden ser definidas de la misma forma que cualquier otra clase, pero es habitual mantenerlas lo más simples posible, a menudo ofreciendo solo un número de atributos con información sobre el error que leerán los gestores de la excepción.

La mayoría de las excepciones se definen con nombres acabados en «Error», de manera similar a la nomenclatura de las excepciones estándar.

Muchos módulos estándar definen sus propias excepciones para reportar errores que pueden ocurrir en funciones propias.

@node Definiendo acciones de limpieza,Acciones predefinidas de limpieza,Excepciones definidas por el usuario,Errores y excepciones
@anchor{tutorial/errors defining-clean-up-actions}@anchor{1c9d}@anchor{tutorial/errors tut-cleanup}@anchor{1c9e}
@subsection Definiendo acciones de limpieza


La declaración @ref{789,,try} tiene otra cláusula opcional cuyo propósito es definir acciones de limpieza que serán ejecutadas bajo ciertas circunstancias. Por ejemplo:

@example
>>> try:
...     raise KeyboardInterrupt
... finally:
...     print('Goodbye, world!')
...
Goodbye, world!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise KeyboardInterrupt
KeyboardInterrupt
@end example

Si una cláusula @ref{a5c,,finally} está presente, el bloque @code{finally} se ejecutará al final antes de que todo el bloque @ref{789,,try} se complete. La cláusula @code{finally} se ejecuta independientemente de que la cláusula @code{try} produzca o no una excepción. Los siguientes puntos explican casos más complejos en los que se produce una excepción:


@itemize *

@item 
Si ocurre una excepción durante la ejecución de la cláusula @code{try}, la excepción podría ser gestionada por una cláusula @ref{2f6,,except}. Si la excepción no es gestionada por una cláusula @code{except}, la excepción es relanzada después de que se ejecute el bloque de la cláusula @code{finally}.

@item 
Podría aparecer una excepción durante la ejecución de una cláusula @code{except} o @code{else}. De nuevo, la excepción será relanzada después de que el bloque de la cláusula @code{finally} se ejecute.

@item 
Si la cláusula @code{finally} ejecuta una declaración @ref{b34,,break}, @ref{a5b,,continue} o @ref{a60,,return}, las excepciones no se vuelven a lanzar.

@item 
Si el bloque @code{try} llega a una sentencia @ref{b34,,break}, @ref{a5b,,continue} o @ref{a60,,return}, la cláusula @code{finally} se ejecutará justo antes de la ejecución de dicha sentencia.

@item 
Si una cláusula @code{finally} incluye una sentencia @code{return}, el valor retornado será el de la cláusula @code{finally}, no la del de la sentencia @code{return} de la cláusula @code{try}.
@end itemize

Por ejemplo:

@example
>>> def bool_return():
...     try:
...         return True
...     finally:
...         return False
...
>>> bool_return()
False
@end example

Un ejemplo más complicado:

@example
>>> def divide(x, y):
...     try:
...         result = x / y
...     except ZeroDivisionError:
...         print("division by zero!")
...     else:
...         print("result is", result)
...     finally:
...         print("executing finally clause")
...
>>> divide(2, 1)
result is 2.0
executing finally clause
>>> divide(2, 0)
division by zero!
executing finally clause
>>> divide("2", "1")
executing finally clause
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    divide("2", "1")
    ~~~~~~^^^^^^^^^^
  File "<stdin>", line 3, in divide
    result = x / y
             ~~^~~
TypeError: unsupported operand type(s) for /: 'str' and 'str'
@end example

Como se puede ver, la cláusula @ref{a5c,,finally} siempre se ejecuta.  La excepción @ref{228,,TypeError} lanzada al dividir dos cadenas de texto no es gestionado por la cláusula @ref{2f6,,except} y por lo tanto es relanzada luego de que se ejecuta la cláusula @code{finally}.

En aplicaciones reales, la cláusula @ref{a5c,,finally} es útil para liberar recursos externos (como archivos o conexiones de red), sin importar si el uso del recurso fue exitoso.

@node Acciones predefinidas de limpieza,Lanzando y gestionando múltiples excepciones no relacionadas,Definiendo acciones de limpieza,Errores y excepciones
@anchor{tutorial/errors predefined-clean-up-actions}@anchor{1c9f}@anchor{tutorial/errors tut-cleanup-with}@anchor{1ca0}
@subsection Acciones predefinidas de limpieza


Algunos objetos definen acciones de limpieza estándar para llevar a cabo cuando el objeto ya no necesario, independientemente de que las operaciones sobre el objeto hayan sido exitosas o no. Véase el siguiente ejemplo, que intenta abrir un archivo e imprimir su contenido en la pantalla.

@example
for line in open("myfile.txt"):
    print(line, end="")
@end example

El problema con este código es que deja el archivo abierto por un periodo de tiempo indeterminado luego de que esta parte termine de ejecutarse.  Esto no es un problema en `scripts' simples, pero puede ser un problema en aplicaciones más grandes.  La declaración @ref{673,,with} permite que los objetos como archivos sean usados de una forma que asegure que siempre se los libera rápido y en forma correcta.:

@example
with open("myfile.txt") as f:
    for line in f:
        print(line, end="")
@end example

Una vez que la declaración se ejecuta, el fichero `f' siempre se cierra, incluso si aparece algún error durante el procesado de las líneas.  Los objetos que, como los ficheros, posean acciones predefinidas de limpieza lo indicarán en su documentación.

@node Lanzando y gestionando múltiples excepciones no relacionadas,Enriqueciendo excepciones con notas,Acciones predefinidas de limpieza,Errores y excepciones
@anchor{tutorial/errors raising-and-handling-multiple-unrelated-exceptions}@anchor{1ca1}@anchor{tutorial/errors tut-exception-groups}@anchor{1ca2}
@subsection Lanzando y gestionando múltiples excepciones no relacionadas


Hay situaciones en las que es necesario informar de varias excepciones que se han producido. Este es a menudo el caso en los marcos de concurrencia, cuando varias tareas pueden haber fallado en paralelo, pero también hay otros casos de uso en los que es deseable continuar la ejecución y recoger múltiples errores en lugar de lanzar la primera excepción.

El incorporado @ref{31d,,ExceptionGroup} envuelve una lista de instancias de excepción para que puedan ser lanzadas juntas. Es una excepción en sí misma, por lo que puede capturarse como cualquier otra excepción.

@example
>>> def f():
...     excs = [OSError('error 1'), SystemError('error 2')]
...     raise ExceptionGroup('there were problems', excs)
...
>>> f()
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     f()
  |     ~^^
  |   File "<stdin>", line 3, in f
  |     raise ExceptionGroup('there were problems', excs)
  | ExceptionGroup: there were problems (2 sub-exceptions)
  +-+---------------- 1 ----------------
    | OSError: error 1
    +---------------- 2 ----------------
    | SystemError: error 2
    +------------------------------------
>>> try:
...     f()
... except Exception as e:
...     print(f'caught @{type(e)@}: e')
...
caught <class 'ExceptionGroup'>: e
>>>
@end example

Utilizando @code{except*} en lugar de @code{except}, podemos manejar selectivamente sólo las excepciones del grupo que coincidan con un determinado tipo. En el siguiente ejemplo, que muestra un grupo de excepciones anidado, cada cláusula @code{except*} extrae del grupo las excepciones de un tipo determinado, mientras que deja que el resto de excepciones se propaguen a otras cláusulas y, finalmente, se vuelvan a lanzar.

@example
>>> def f():
...     raise ExceptionGroup(
...         "group1",
...         [
...             OSError(1),
...             SystemError(2),
...             ExceptionGroup(
...                 "group2",
...                 [
...                     OSError(3),
...                     RecursionError(4)
...                 ]
...             )
...         ]
...     )
...
>>> try:
...     f()
... except* OSError as e:
...     print("There were OSErrors")
... except* SystemError as e:
...     print("There were SystemErrors")
...
There were OSErrors
There were SystemErrors
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 2, in <module>
  |     f()
  |     ~^^
  |   File "<stdin>", line 2, in f
  |     raise ExceptionGroup(
  |     ...<12 lines>...
  |     )
  | ExceptionGroup: group1 (1 sub-exception)
  +-+---------------- 1 ----------------
    | ExceptionGroup: group2 (1 sub-exception)
    +-+---------------- 1 ----------------
      | RecursionError: 4
      +------------------------------------
>>>
@end example

Tenga en cuenta que las excepciones anidadas en un grupo de excepciones deben ser instancias, no tipos. Esto se debe a que en la práctica las excepciones serían típicamente las que ya han sido planteadas y capturadas por el programa, siguiendo el siguiente patrón:

@example
>>> excs = []
... for test in tests:
...     try:
...         test.run()
...     except Exception as e:
...         excs.append(e)
...
>>> if excs:
...    raise ExceptionGroup("Test Failures", excs)
...
@end example

@node Enriqueciendo excepciones con notas,,Lanzando y gestionando múltiples excepciones no relacionadas,Errores y excepciones
@anchor{tutorial/errors enriching-exceptions-with-notes}@anchor{1ca3}@anchor{tutorial/errors tut-exception-notes}@anchor{1ca4}
@subsection Enriqueciendo excepciones con notas


Cuando se crea una excepción para ser lanzada, normalmente se inicializa con información que describe el error que se ha producido. Hay casos en los que es útil añadir información después de que la excepción haya sido capturada. Para este propósito, las excepciones tienen un método @code{add_note(note)} que acepta una cadena y la añade a la lista de notas de la excepción. La representación estándar del rastreo incluye todas las notas, en el orden en que fueron añadidas, después de la excepción.

@example
>>> try:
...     raise TypeError('bad type')
... except Exception as e:
...     e.add_note('Add some information')
...     e.add_note('Add some more information')
...     raise
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise TypeError('bad type')
TypeError: bad type
Add some information
Add some more information
>>>
@end example

Por ejemplo, al recopilar excepciones en un grupo de excepciones, es posible que queramos añadir información de contexto para los errores individuales. A continuación, cada excepción del grupo tiene una nota que indica cuándo se ha producido ese error.

@example
>>> def f():
...     raise OSError('operation failed')
...
>>> excs = []
>>> for i in range(3):
...     try:
...         f()
...     except Exception as e:
...         e.add_note(f'Happened in Iteration @{i+1@}')
...         excs.append(e)
...
>>> raise ExceptionGroup('We have some problems', excs)
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     raise ExceptionGroup('We have some problems', excs)
  | ExceptionGroup: We have some problems (3 sub-exceptions)
  +-+---------------- 1 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 1
    +---------------- 2 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 2
    +---------------- 3 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 3
    +------------------------------------
>>>
@end example

@node Clases,Breve recorrido por la Biblioteca Estándar,Errores y excepciones,El tutorial de Python
@anchor{tutorial/classes doc}@anchor{1ca5}@anchor{tutorial/classes classes}@anchor{1ca6}@anchor{tutorial/classes tut-classes}@anchor{1c26}
@section Clases


Las clases proveen una forma de empaquetar datos y funcionalidad juntos. Al crear una nueva clase, se crea un nuevo `tipo' de objeto, permitiendo crear nuevas `instancias' de ese tipo. Cada instancia de clase puede tener atributos adjuntos para mantener su estado. Las instancias de clase también pueden tener métodos (definidos por su clase) para modificar su estado.

Comparado con otros lenguajes de programación, el mecanismo de clases de Python agrega clases con un mínimo de nuevas sintaxis y semánticas.  Es una mezcla de los mecanismos de clases encontrados en C++ y Modula-3.  Las clases de Python proveen todas las características normales de la Programación Orientada a Objetos: el mecanismo de la herencia de clases permite múltiples clases base, una clase derivada puede sobre escribir cualquier método de su(s) clase(s) base, y un método puede llamar al método de la clase base con el mismo nombre.  Los objetos pueden tener una cantidad arbitraria de datos de cualquier tipo.  Igual que con los módulos, las clases participan de la naturaleza dinámica de Python: se crean en tiempo de ejecución, y pueden modificarse luego de la creación.

En terminología de C++, normalmente los miembros de las clases (incluyendo los miembros de datos), son `públicos' (excepto ver abajo @ref{1ca7,,Variables privadas}), y todas las funciones miembro son `virtuales'.  Como en Modula-3, no hay atajos para hacer referencia a los miembros del objeto desde sus métodos: la función método se declara con un primer argumento explícito que representa al objeto, el cual se provee implícitamente por la llamada.  Como en Smalltalk, las clases mismas son objetos.  Esto provee una semántica para importar y renombrar.  A diferencia de C++ y Modula-3, los tipos de datos integrados pueden usarse como clases base para que el usuario los extienda.  También, como en C++ pero a diferencia de Modula-3, la mayoría de los operadores integrados con sintaxis especial (operadores aritméticos, de sub-índice, etc.) pueden volver a ser definidos por instancias de la clase.

(Sin haber una terminología universalmente aceptada sobre clases, haré uso ocasional de términos de Smalltalk y C++.  Usaría términos de Modula-3, ya que su semántica orientada a objetos es más cercana a Python que C++, pero no espero que muchos lectores hayan escuchado hablar de él.)

@menu
* Unas palabras sobre nombres y objetos:: 
* Ámbitos y espacios de nombres en Python:: 
* Un primer vistazo a las clases:: 
* Algunas observaciones:: 
* Herencia:: 
* Variables privadas:: 
* Detalles y Cuestiones Varias:: 
* Iteradores:: 
* Generadores:: 
* Expresiones generadoras:: 

@end menu

@node Unas palabras sobre nombres y objetos,Ámbitos y espacios de nombres en Python,,Clases
@anchor{tutorial/classes a-word-about-names-and-objects}@anchor{1ca8}@anchor{tutorial/classes tut-object}@anchor{1ca9}
@subsection Unas palabras sobre nombres y objetos


Los objetos tienen individualidad, y múltiples nombres (en muchos ámbitos) pueden vincularse al mismo objeto.  Esto se conoce como `aliasing' en otros lenguajes.  Normalmente no se aprecia esto a primera vista en Python, y puede ignorarse sin problemas cuando se maneja tipos básicos inmutables (números, cadenas, tuplas).  Sin embargo, el `aliasing', o renombrado,  tiene un efecto posiblemente sorpresivo sobre la semántica de código Python que involucra objetos mutables como listas, diccionarios, y la mayoría de otros tipos.  Esto se usa normalmente para beneficio del programa, ya que los renombres funcionan como punteros en algunos aspectos.  Por ejemplo, pasar un objeto es barato ya que la implementación solamente pasa el puntero; y si una función modifica el objeto que fue pasado, el que la llama verá el cambio; esto elimina la necesidad de tener dos formas diferentes de pasar argumentos, como en Pascal.

@node Ámbitos y espacios de nombres en Python,Un primer vistazo a las clases,Unas palabras sobre nombres y objetos,Clases
@anchor{tutorial/classes python-scopes-and-namespaces}@anchor{1caa}@anchor{tutorial/classes tut-scopes}@anchor{1c5f}
@subsection Ámbitos y espacios de nombres en Python


Antes de ver clases, primero debo decirte algo acerca de las reglas de ámbito de Python.  Las definiciones de clases hacen unos lindos trucos con los espacios de nombres, y necesitás saber cómo funcionan los alcances y espacios de nombres para entender por completo cómo es la cosa.  De paso, los conocimientos en este tema son útiles para cualquier programador Python avanzado.

Comencemos con unas definiciones.

Un `espacio de nombres' es una relación de nombres a objetos.  Muchos espacios de nombres están implementados en este momento como diccionarios de Python, pero eso no se nota para nada (excepto por el desempeño), y puede cambiar en el futuro.  Como ejemplos de espacios de nombres tenés: el conjunto de nombres incluidos (conteniendo funciones como @ref{1cab,,abs()}, y los nombres de excepciones integradas); los nombres globales en un módulo; y los nombres locales en la invocación a una función.  Lo que es importante saber de los espacios de nombres es que no hay relación en absoluto entre los nombres de espacios de nombres distintos; por ejemplo, dos módulos diferentes pueden tener definidos los dos una función @code{maximizar} sin confusión; los usuarios de los módulos deben usar el nombre del módulo como prefijo.

Por cierto, yo uso la palabra `atributo' para cualquier cosa después de un punto; por ejemplo, en la expresión @code{z.real}, @code{real} es un atributo del objeto @code{z}.  Estrictamente hablando, las referencias a nombres en módulos son referencias a atributos: en la expresión @code{modulo.funcion}, @code{modulo} es un objeto módulo y @code{funcion} es un atributo de éste.  En este caso hay una relación directa entre los atributos del módulo y los nombres globales definidos en el módulo: ¡están compartiendo el mismo espacio de nombres! @footnote{
Except for one thing.  Module objects have a secret read-only attribute called
@ref{5fe,,__dict__} which returns the dictionary used to implement the module’s
namespace; the name @code{__dict__} is an attribute but not a global name.
Obviously, using this violates the abstraction of namespace implementation, and
should be restricted to things like post-mortem debuggers.
}

Los atributos pueden ser de solo lectura, o de escritura. En el segundo caso, es posible asignar valores a los atributos. Los atributos de módulo son modificables: puedes escribir @code{modname.the_answer = 42}. Los atributos modificables también se pueden eliminar con la declaración @ref{17ae,,del}. Por ejemplo, @code{del modname.the_answer} eliminará el atributo @code{the_answer} del objeto nombrado por @code{modname}.

Los espacios de nombres se crean en diferentes momentos y con diferentes tiempos de vida.  El espacio de nombres que contiene los nombres incluidos se crea cuando se inicia el intérprete, y nunca se borra.  El espacio de nombres global de un módulo se crea cuando se lee la definición de un módulo; normalmente, los espacios de nombres de módulos también duran hasta que el intérprete finaliza.  Las instrucciones ejecutadas en el nivel de llamadas superior del intérprete, ya sea desde un script o interactivamente, se consideran parte del módulo llamado @ref{1,,__main__}, por lo tanto tienen su propio espacio de nombres global.  (Los nombres incluidos en realidad también viven en un módulo; este se llama @ref{13,,builtins}.)

El espacio de nombres local a una función se crea cuando la función es llamada, y se elimina cuando la función retorna o lanza una excepción que no se maneje dentro de la función.  (Podríamos decir que lo que pasa en realidad es que ese espacio de nombres se «olvida».)  Por supuesto, las llamadas recursivas tienen cada una su propio espacio de nombres local.

Un `ámbito' es una región textual de un programa en Python donde un espacio de nombres es accesible directamente.  «Accesible directamente» significa que una referencia sin calificar a un nombre intenta encontrar dicho nombre dentro del espacio de nombres.

Aunque los alcances se determinan de forma estática, se utilizan de forma dinámica. En cualquier momento durante la ejecución, hay 3 o 4 ámbitos anidados cuyos espacios de nombres son directamente accesibles:


@itemize *

@item 
el alcance más interno, que es inspeccionado primero, contiene los nombres locales

@item 
los alcances de cualquier función que encierra a otra, son inspeccionados a partir del alcance más cercano, contienen nombres no locales, pero también no globales

@item 
el penúltimo alcance contiene nombres globales del módulo actual

@item 
el alcance más externo (el último inspeccionado) es el espacio de nombres que contiene los nombres integrados
@end itemize

Si un nombre se declara global, entonces todas las referencias y asignaciones se realizan directamente en el ámbito penúltimo que contiene los nombres globales del módulo. Para volver a enlazar variables encontradas fuera del ámbito más interno, se puede utilizar la declaración @ref{1313,,nonlocal}; si no se declara nonlocal, esas variables serán de sólo lectura (un intento de escribir en una variable de este tipo simplemente creará una `nueva' variable local en el ámbito más interno, dejando sin cambios la variable con el mismo nombre en el ámbito externo).

Habitualmente, el ámbito local referencia los nombres locales de la función actual.  Fuera de una función, el ámbito local referencia al mismo espacio de nombres que el ámbito global: el espacio de nombres del módulo. Las definiciones de clases crean un espacio de nombres más en el ámbito local.

Es importante notar que los alcances se determinan textualmente: el ámbito global de una función definida en un módulo es el espacio de nombres de ese módulo, no importa desde dónde o con qué alias se llame a la función.  Por otro lado, la búsqueda de nombres se hace dinámicamente, en tiempo de ejecución; sin embargo, la definición del lenguaje está evolucionando a hacer resolución de nombres estáticamente, en tiempo de «compilación», ¡así que no te confíes de la resolución de nombres dinámica! (De hecho, las variables locales ya se determinan estáticamente.)

Una peculiaridad especial de Python es que, si no hay una declaración @ref{2f5,,global} o @ref{1313,,nonlocal} en efecto, las asignaciones a nombres siempre van al ámbito interno.  Las asignaciones no copian datos, solamente asocian nombres a objetos.  Lo mismo cuando se borra: la declaración @code{del x} quita la asociación de @code{x} del espacio de nombres referenciado por el ámbito local.  De hecho, todas las operaciones que introducen nuevos nombres usan el ámbito local: en particular, las instrucciones @ref{682,,import} y las definiciones de funciones asocian el módulo o nombre de la función al espacio de nombres en el ámbito local.

La declaración @ref{2f5,,global} puede usarse para indicar que ciertas variables viven en el ámbito global y deberían reasignarse allí; la declaración @ref{1313,,nonlocal} indica que ciertas variables viven en un ámbito encerrado y deberían reasignarse allí.

@menu
* Ejemplo de ámbitos y espacios de nombre:: 

@end menu

@node Ejemplo de ámbitos y espacios de nombre,,,Ámbitos y espacios de nombres en Python
@anchor{tutorial/classes scopes-and-namespaces-example}@anchor{1cac}@anchor{tutorial/classes tut-scopeexample}@anchor{1cad}
@subsubsection Ejemplo de ámbitos y espacios de nombre


Este es un ejemplo que muestra como hacer referencia a distintos ámbitos y espacios de nombres, y cómo las declaraciones @ref{2f5,,global} y @ref{1313,,nonlocal} afectan la asignación de variables:

@example
def scope_test():
    def do_local():
        spam = "local spam"

    def do_nonlocal():
        nonlocal spam
        spam = "nonlocal spam"

    def do_global():
        global spam
        spam = "global spam"

    spam = "test spam"
    do_local()
    print("After local assignment:", spam)
    do_nonlocal()
    print("After nonlocal assignment:", spam)
    do_global()
    print("After global assignment:", spam)

scope_test()
print("In global scope:", spam)
@end example

El resultado del código ejemplo es:

@example
After local assignment: test spam
After nonlocal assignment: nonlocal spam
After global assignment: nonlocal spam
In global scope: global spam
@end example

Notá como la asignación `local' (que es el comportamiento normal) no cambió la vinculación de `spam' de `scope_test'.  La asignación @ref{1313,,nonlocal} cambió la vinculación de `spam' de `scope_test', y la asignación @ref{2f5,,global} cambió la vinculación a nivel de módulo.

También podés ver que no había vinculación para `spam' antes de la asignación @ref{2f5,,global}.

@node Un primer vistazo a las clases,Algunas observaciones,Ámbitos y espacios de nombres en Python,Clases
@anchor{tutorial/classes a-first-look-at-classes}@anchor{1cae}@anchor{tutorial/classes tut-firstclasses}@anchor{1c41}
@subsection Un primer vistazo a las clases


Las clases introducen un poquito de sintaxis nueva, tres nuevos tipos de objetos y algo de semántica nueva.

@menu
* Sintaxis de definición de clases:: 
* Objetos clase:: 
* Objetos instancia:: 
* Objetos método:: 
* Variables de clase y de instancia:: 

@end menu

@node Sintaxis de definición de clases,Objetos clase,,Un primer vistazo a las clases
@anchor{tutorial/classes class-definition-syntax}@anchor{1caf}@anchor{tutorial/classes tut-classdefinition}@anchor{1cb0}
@subsubsection Sintaxis de definición de clases


La forma más sencilla de definición de una clase se ve así:

@example
class ClassName:
    <statement-1>
    .
    .
    .
    <statement-N>
@end example

Las definiciones de clases, al igual que las definiciones de funciones (instrucciones @ref{1497,,def}) deben ejecutarse antes de que tengan efecto alguno.  (Es concebible poner una definición de clase dentro de una rama de un @ref{1ec,,if}, o dentro de una función.)

En la práctica, las declaraciones dentro de una clase son definiciones de funciones, pero otras declaraciones son permitidas, y a veces resultan útiles; veremos esto más adelante.  Las definiciones de funciones dentro de una clase normalmente tienen una lista de argumentos peculiar, dictada por las convenciones de invocación de métodos; a esto también lo veremos más adelante.

Cuando se ingresa una definición de clase, se crea un nuevo espacio de nombres, el cual se usa como ámbito local; por lo tanto, todas las asignaciones a variables locales van a este nuevo espacio de nombres.  En particular, las definiciones de funciones asocian el nombre de las funciones nuevas allí.

Cuando una definición de clase se finaliza normalmente (al llegar al final) se crea un `objeto clase'. Básicamente, este objeto envuelve los contenidos del espacio de nombres creado por la definición de la clase; aprenderemos más acerca de los objetos clase en la sección siguiente. El ámbito local original (el que tenía efecto justo antes de que ingrese la definición de la clase) es restablecido, y el objeto clase se asocia allí al nombre que se le puso a la clase en el encabezado de su definición (@code{ClassName} en el ejemplo).

@node Objetos clase,Objetos instancia,Sintaxis de definición de clases,Un primer vistazo a las clases
@anchor{tutorial/classes class-objects}@anchor{1cb1}@anchor{tutorial/classes tut-classobjects}@anchor{1cb2}
@subsubsection Objetos clase


Los objetos clase soportan dos tipos de operaciones: hacer referencia a atributos e instanciación.

Para `hacer referencia a atributos' se usa la sintaxis estándar de todas las referencias a atributos en Python: @code{objeto.nombre}.  Los nombres de atributo válidos son todos los nombres que estaban en el espacio de nombres de la clase cuando ésta se creó.  Por lo tanto, si la definición de la clase es así:

@example
class MyClass:
    """A simple example class"""
    i = 12345

    def f(self):
        return 'hello world'
@end example

then @code{MyClass.i} and @code{MyClass.f} are valid attribute references, returning
an integer and a function object, respectively. Class attributes can also be
assigned to, so you can change the value of @code{MyClass.i} by assignment.
@ref{1cb3,,__doc__} is also a valid attribute, returning the docstring
belonging to the class: @code{"A simple example class"}.

La `instanciación' de clases usa la notación de funciones.  Hacé de cuenta que el objeto de clase es una función sin parámetros que retorna una nueva instancia de la clase.  Por ejemplo (para la clase de más arriba):

@example
x = MyClass()
@end example

crea una nueva `instancia' de la clase y asigna este objeto a la variable local @code{x}.

La operación de instanciación («llamar» a un objeto clase) crea un objeto vacío. Muchas clases necesitan crear objetos con instancias en un estado inicial particular. Por lo tanto una clase puede definir un método especial llamado @ref{751,,__init__()}, de esta forma:

@example
def __init__(self):
    self.data = []
@end example

Cuando una clase define un método @ref{751,,__init__()}, la instanciación de la clase automáticamente invoca a @code{__init__()} para la instancia recién creada. Entonces, en este ejemplo, una instancia nueva e inicializada se puede obtener haciendo:

@example
x = MyClass()
@end example

Por supuesto, el método @ref{751,,__init__()} puede tener argumentos para mayor flexibilidad. En ese caso, los argumentos que se pasen al operador de instanciación de la clase van a parar al método @code{__init__()}. Por ejemplo,

@example
>>> class Complex:
...     def __init__(self, realpart, imagpart):
...         self.r = realpart
...         self.i = imagpart
...
>>> x = Complex(3.0, -4.5)
>>> x.r, x.i
(3.0, -4.5)
@end example

@node Objetos instancia,Objetos método,Objetos clase,Un primer vistazo a las clases
@anchor{tutorial/classes instance-objects}@anchor{1cb4}@anchor{tutorial/classes tut-instanceobjects}@anchor{1cb5}
@subsubsection Objetos instancia


Ahora, ¿Qué podemos hacer con los objetos instancia?  La única operación que es entendida por los objetos instancia es la referencia de atributos.  Hay dos tipos de nombres de atributos válidos, atributos de datos y métodos.

Los `atributos de datos' se corresponden con las «variables de instancia» en Smalltalk, y con las «variables miembro» en C++. Los atributos de datos no necesitan ser declarados; tal como las variables locales son creados la primera vez que se les asigna algo. Por ejemplo, si @code{x} es la instancia de @code{MyClass} creada más arriba, el siguiente pedazo de código va a imprimir el valor @code{16}, sin dejar ningún rastro:

@example
x.counter = 1
while x.counter < 10:
    x.counter = x.counter * 2
print(x.counter)
del x.counter
@end example

The other kind of instance attribute reference is a `method'. A method is a
function that «belongs to» an object.

@geindex objeto;método

Los nombres válidos de métodos de un objeto instancia dependen de su clase. Por definición, todos los atributos de clase que son objetos funciones definen métodos correspondientes de sus instancias.  Entonces, en nuestro ejemplo, @code{x.f} es una referencia a un método válido, dado que @code{MyClass.f} es una función, pero @code{x.i} no lo es, dado que @code{MyClass.i} no lo es.  Pero @code{x.f} no es la misma cosa que @code{MyClass.f}; es un `objeto método', no un objeto función.

@node Objetos método,Variables de clase y de instancia,Objetos instancia,Un primer vistazo a las clases
@anchor{tutorial/classes method-objects}@anchor{1cb6}@anchor{tutorial/classes tut-methodobjects}@anchor{1cb7}
@subsubsection Objetos método


Generalmente, un método es llamado luego de ser vinculado:

@example
x.f()
@end example

En el ejemplo @code{MyClass}, esto retorna la cadena @code{'hello world'}. Pero no es necesario llamar al método justo en ese momento: @code{x.f} es un objeto método, y puede ser guardado y llamado más tarde. Por ejemplo:

@example
xf = x.f
while True:
    print(xf())
@end example

continuará imprimiendo @code{hello world} hasta el fin de los días.

¿Qué sucede exactamente cuando un método es llamado? Debés haber notado que @code{x.f()} fue llamado más arriba sin ningún argumento, a pesar de que la definición de función de @code{f()} especificaba un argumento. ¿Qué pasó con ese argumento? Seguramente Python lanza una excepción cuando una función que requiere un argumento es llamada sin ninguno, aún si el argumento no es utilizado…

De hecho, tal vez hayas adivinado la respuesta: lo que tienen de especial los métodos es que el objeto es pasado como el primer argumento de la función. En nuestro ejemplo, la llamada @code{x.f()} es exactamente equivalente a @code{MyClass.f(x)}.  En general, llamar a un método con una lista de `n' argumentos es equivalente a llamar a la función correspondiente con una lista de argumentos que es creada insertando el objeto del método antes del primer argumento.

In general, methods work as follows.  When a non-data attribute
of an instance is referenced, the instance’s class is searched.
If the name denotes a valid class attribute that is a function object,
references to both the instance object and the function object
are packed into a method object.  When the method object is called
with an argument list, a new argument list is constructed from the instance
object and the argument list, and the function object is called with this new
argument list.

@node Variables de clase y de instancia,,Objetos método,Un primer vistazo a las clases
@anchor{tutorial/classes class-and-instance-variables}@anchor{1cb8}@anchor{tutorial/classes tut-class-and-instance-variables}@anchor{1cb9}
@subsubsection Variables de clase y de instancia


En general, las variables de instancia son para datos únicos de cada instancia y las variables de clase son para atributos y métodos compartidos por todas las instancias de la clase:

@example
class Dog:

    kind = 'canine'         # class variable shared by all instances

    def __init__(self, name):
        self.name = name    # instance variable unique to each instance

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.kind                  # shared by all dogs
'canine'
>>> e.kind                  # shared by all dogs
'canine'
>>> d.name                  # unique to d
'Fido'
>>> e.name                  # unique to e
'Buddy'
@end example

Como se vio en @ref{1ca9,,Unas palabras sobre nombres y objetos}, los datos compartidos pueden tener efectos inesperados que involucren objetos @ref{1c08,,mutable} como ser listas y diccionarios. Por ejemplo, la lista `tricks' en el siguiente código no debería ser usada como variable de clase porque una sola lista sería compartida por todos las instancias de `Dog':

@example
class Dog:

    tricks = []             # mistaken use of a class variable

    def __init__(self, name):
        self.name = name

    def add_trick(self, trick):
        self.tricks.append(trick)

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks                # unexpectedly shared by all dogs
['roll over', 'play dead']
@end example

El diseño correcto de esta clase sería usando una variable de instancia:

@example
class Dog:

    def __init__(self, name):
        self.name = name
        self.tricks = []    # creates a new empty list for each dog

    def add_trick(self, trick):
        self.tricks.append(trick)

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks
['roll over']
>>> e.tricks
['play dead']
@end example

@node Algunas observaciones,Herencia,Un primer vistazo a las clases,Clases
@anchor{tutorial/classes random-remarks}@anchor{1cba}@anchor{tutorial/classes tut-remarks}@anchor{1cbb}
@subsection Algunas observaciones


@c These should perhaps be placed more carefully...

Si el mismo nombre de atributo aparece tanto en la instancia como en la clase, la búsqueda del atributo prioriza la instancia:

@example
>>> class Warehouse:
...    purpose = 'storage'
...    region = 'west'
...
>>> w1 = Warehouse()
>>> print(w1.purpose, w1.region)
storage west
>>> w2 = Warehouse()
>>> w2.region = 'east'
>>> print(w2.purpose, w2.region)
storage east
@end example

A los atributos de datos los pueden hacer referencia tanto los métodos como los usuarios («clientes») ordinarios de un objeto.  En otras palabras, las clases no se usan para implementar tipos de datos abstractos puros.  De hecho, en Python no hay nada que haga cumplir el ocultar datos; todo se basa en convención.  (Por otro lado, la implementación de Python, escrita en C, puede ocultar por completo detalles de implementación y el control de acceso a un objeto si es necesario; esto se puede usar en extensiones a Python escritas en C.)

Los clientes deben usar los atributos de datos con cuidado; éstos pueden romper invariantes que mantienen los métodos si pisan los atributos de datos. Observá que los clientes pueden añadir sus propios atributos de datos a una instancia sin afectar la validez de sus métodos, siempre y cuando se eviten conflictos de nombres; de nuevo, una convención de nombres puede ahorrar un montón de dolores de cabeza.

No hay un atajo para hacer referencia a atributos de datos (¡u otros métodos!) desde dentro de un método.  A mi parecer, esto en realidad aumenta la legibilidad de los métodos: no existe posibilidad alguna de confundir variables locales con variables de instancia cuando repasamos un método.

A menudo, el primer argumento de un método se llama @code{self} (uno mismo).  Esto no es nada más que una convención: el nombre @code{self} no significa nada en especial para Python.  Observá que, sin embargo, si no seguís la convención tu código puede resultar menos legible a otros programadores de Python, y puede llegar a pasar que un programa `navegador de clases' pueda escribirse de una manera que dependa de dicha convención.

Cualquier objeto función que es un atributo de clase define un método para instancias de esa clase.  No es necesario que el la definición de la función esté textualmente dentro de la definición de la clase: asignando un objeto función a una variable local en la clase también está bien.  Por ejemplo:

@example
# Function defined outside the class
def f1(self, x, y):
    return min(x, x+y)

class C:
    f = f1

    def g(self):
        return 'hello world'

    h = g
@end example

Ahora @code{f}, @code{g} y @code{h} son todos atributos de la clase @code{C} que hacen referencia a objetos función, y consecuentemente son todos métodos de las instancias de @code{C} — @code{h} siendo exactamente equivalente a @code{g}. Fijate que esta práctica normalmente sólo sirve para confundir al que lea un programa.

Los métodos pueden llamar a otros métodos de la instancia usando el argumento @code{self}:

@example
class Bag:
    def __init__(self):
        self.data = []

    def add(self, x):
        self.data.append(x)

    def addtwice(self, x):
        self.add(x)
        self.add(x)
@end example

Los métodos pueden hacer referencia a nombres globales de la misma manera que lo hacen las funciones comunes.  El ámbito global asociado a un método es el módulo que contiene su definición.  (Una clase nunca se usa como un ámbito global).  Si bien es raro encontrar una buena razón para usar datos globales en un método, hay muchos usos legítimos del ámbito global: por lo menos, las funciones y módulos importados en el ámbito global pueden usarse por los métodos, al igual que las funciones y clases definidas en él. Habitualmente, la clase que contiene el método está definida en este ámbito global, y en la siguiente sección veremos algunas buenas razones por las que un método querría hacer referencia a su propia clase.

Todo valor es un objeto, y por lo tanto tiene una `clase' (también llamado su `tipo'). Ésta se almacena como @code{objeto.__class__}.

@node Herencia,Variables privadas,Algunas observaciones,Clases
@anchor{tutorial/classes inheritance}@anchor{1cbc}@anchor{tutorial/classes tut-inheritance}@anchor{1cbd}
@subsection Herencia


Por supuesto, una característica del lenguaje no sería digna del nombre «clase» si no soportara herencia.  La sintaxis para una definición de clase derivada se ve así:

@example
class DerivedClassName(BaseClassName):
    <statement-1>
    .
    .
    .
    <statement-N>
@end example

El nombre @code{BaseClassName} debe estar definido en un ámbito que contenga a la definición de la clase derivada. En el lugar del nombre de la clase base se permiten otras expresiones arbitrarias. Esto puede ser útil, por ejemplo, cuando la clase base está definida en otro módulo:

@example
class DerivedClassName(modname.BaseClassName):
@end example

La ejecución de una definición de clase derivada procede de la misma forma que una clase base.  Cuando el objeto clase se construye, se tiene en cuenta a la clase base.  Esto se usa para resolver referencias a atributos: si un atributo solicitado no se encuentra en la clase, la búsqueda continúa por la clase base. Esta regla se aplica recursivamente si la clase base misma deriva de alguna otra clase.

No hay nada en especial en la instanciación de clases derivadas: @code{DerivedClassName()} crea una nueva instancia de la clase.  Las referencias a métodos se resuelven de la siguiente manera: se busca el atributo de clase correspondiente, descendiendo por la cadena de clases base si es necesario, y la referencia al método es válida si se entrega un objeto función.

Las clases derivadas pueden redefinir métodos de su clase base.  Como los métodos no tienen privilegios especiales cuando llaman a otros métodos del mismo objeto, un método de la clase base que llame a otro método definido en la misma clase base puede terminar llamando a un método de la clase derivada que lo haya redefinido.  (Para los programadores de C++: en Python todos los métodos son en efecto @code{virtuales}.)

Un método redefinido en una clase derivada puede de hecho querer extender en vez de simplemente reemplazar al método de la clase base con el mismo nombre. Hay una manera simple de llamar al método de la clase base directamente: simplemente llamás a @code{BaseClassName.methodname(self, arguments)}.  En ocasiones esto es útil para los clientes también.  (Observá que esto sólo funciona si la clase base es accesible como @code{BaseClassName} en el ámbito global).

Python tiene dos funciones integradas que funcionan con herencia:


@itemize *

@item 
Usar @ref{4ef,,isinstance()} para verificar el tipo de una instancia: @code{isinstance(obj, int)} será @code{True} sólo si @code{obj.__class__} es @ref{1f0,,int} o alguna clase derivada de @ref{1f0,,int}.

@item 
Usar @ref{85a,,issubclass()} para verificar la herencia de clases: @code{issubclass(bool, int)} es @code{True} ya que @ref{513,,bool} es una subclase de @ref{1f0,,int}. Sin embargo, @code{issubclass(float, int)} es @code{False} ya que @ref{153,,float} no es una subclase de @ref{1f0,,int}.
@end itemize

@menu
* Herencia múltiple:: 

@end menu

@node Herencia múltiple,,,Herencia
@anchor{tutorial/classes multiple-inheritance}@anchor{1cbe}@anchor{tutorial/classes tut-multiple}@anchor{1cbf}
@subsubsection Herencia múltiple


Python también soporta una forma de herencia múltiple.  Una definición de clase con múltiples clases base se ve así:

@example
class DerivedClassName(Base1, Base2, Base3):
    <statement-1>
    .
    .
    .
    <statement-N>
@end example

Para la mayoría de los propósitos, en los casos más simples, podés pensar en la búsqueda de los atributos heredados de una clase padre como una búsqueda en profundidad, de izquierda a derecha, sin repetir la misma clase cuando está dos veces en la jerarquía. Por lo tanto, si un atributo no se encuentra en @code{DerivedClassName}, se busca en @code{Base1}, luego (recursivamente) en las clases base de @code{Base1}, y solo si no se encuentra allí se lo busca en @code{Base2}, y así sucesivamente.

En realidad es un poco más complejo que eso; el orden de resolución de métodos cambia dinámicamente para soportar las llamadas cooperativas a @ref{155,,super()}.  Este enfoque es conocido en otros lenguajes con herencia múltiple como «llámese al siguiente método» y es más poderoso que la llamada al superior que se encuentra en lenguajes con sólo herencia simple.

Dynamic ordering is necessary because all cases of multiple inheritance exhibit
one or more diamond relationships (where at least one of the parent classes
can be accessed through multiple paths from the bottommost class).  For example,
all classes inherit from @ref{b18,,object}, so any case of multiple inheritance
provides more than one path to reach @ref{b18,,object}.  To keep the base classes
from being accessed more than once, the dynamic algorithm linearizes the search
order in a way that preserves the left-to-right ordering specified in each
class, that calls each parent only once, and that is monotonic (meaning that a
class can be subclassed without affecting the precedence order of its parents).
Taken together, these properties make it possible to design reliable and
extensible classes with multiple inheritance.  For more detail, see
@ref{14e6,,The Python 2.3 Method Resolution Order}.

@node Variables privadas,Detalles y Cuestiones Varias,Herencia,Clases
@anchor{tutorial/classes private-variables}@anchor{1cc0}@anchor{tutorial/classes tut-private}@anchor{1ca7}
@subsection Variables privadas


Las variables «privadas» de instancia, que no pueden accederse excepto desde dentro de un objeto, no existen en Python.  Sin embargo, hay una convención que se sigue en la mayoría del código Python: un nombre prefijado con un guión bajo (por ejemplo, @code{_spam}) debería tratarse como una parte no pública de la API (más allá de que sea una función, un método, o un dato).  Debería considerarse un detalle de implementación y que está sujeto a cambios sin aviso.

@geindex nombre;alteración

Ya que hay un caso de uso válido para los identificadores privados de clase (a saber: colisión de nombres con nombres definidos en las subclases), hay un soporte limitado para este mecanismo.  Cualquier identificador con la forma @code{__spam} (al menos dos guiones bajos al principio, como mucho un guión bajo al final) es textualmente reemplazado por @code{_nombredeclase__spam}, donde @code{nombredeclase} es el nombre de clase actual al que se le sacan guiones bajos del comienzo (si los tuviera).  Se modifica el nombre del identificador sin importar su posición sintáctica, siempre y cuando ocurra dentro de la definición de una clase.


@subsubheading Ver también


The @ref{1cc1,,private name mangling specifications}
for details and special cases.


La modificación de nombres es útil para dejar que las subclases sobreescriban los métodos sin romper las llamadas a los métodos desde la misma clase.  Por ejemplo:

@example
class Mapping:
    def __init__(self, iterable):
        self.items_list = []
        self.__update(iterable)

    def update(self, iterable):
        for item in iterable:
            self.items_list.append(item)

    __update = update   # private copy of original update() method

class MappingSubclass(Mapping):

    def update(self, keys, values):
        # provides new signature for update()
        # but does not break __init__()
        for item in zip(keys, values):
            self.items_list.append(item)
@end example

El ejemplo de arriba funcionaría incluso si @code{MappingSubclass} introdujera un identificador @code{__update} ya que se reemplaza con @code{_Mapping__update} en la clase @code{Mapping}  y @code{_MappingSubclass__update} en la clase @code{MappingSubclass} respectivamente.

Hay que aclarar que las reglas de modificación de nombres están diseñadas principalmente para evitar accidentes; es posible acceder o modificar una variable que es considerada como privada.  Esto hasta puede resultar útil en circunstancias especiales, tales como en el depurador.

Notar que el código pasado a @code{exec} o @code{eval()} no considera que el nombre de clase de la clase que invoca sea la clase actual; esto es similar al efecto de la sentencia @code{global}, efecto que es de similar manera restringido a código que es compilado en conjunto.  La misma restricción aplica a @code{getattr()}, @code{setattr()} y @code{delattr()}, así como cuando se referencia a @code{__dict__} directamente.

@node Detalles y Cuestiones Varias,Iteradores,Variables privadas,Clases
@anchor{tutorial/classes odds-and-ends}@anchor{1cc2}@anchor{tutorial/classes tut-odds}@anchor{1cc3}
@subsection Detalles y Cuestiones Varias


A veces es útil tener un tipo de datos similar al «registro» de Pascal o la «estructura» de C, que sirva para juntar algunos pocos ítems con nombre. El enfoque idiomático es utilizar @ref{30,,dataclasses} con este propósito:

@example
from dataclasses import dataclass

@@dataclass
class Employee:
    name: str
    dept: str
    salary: int
@end example

@example
>>> john = Employee('john', 'computer lab', 1000)
>>> john.dept
'computer lab'
>>> john.salary
1000
@end example

Un fragmento de código en Python que espera un tipo de dato abstracto en particular a menudo puede recibir una clase que emule los métodos de ese tipo de dato en su lugar. Por ejemplo, si tienes una función que formatea algunos datos de un objeto de archivo, puedes definir una clase con los métodos @ref{1c8c,,read()} y @ref{1cc4,,readline()} que obtienen los datos de un búfer de cadena en su lugar, y pasarla como argumento.

@c (Unfortunately, this technique has its limitations: a class can't define
@c operations that are accessed by special syntax such as sequence subscripting
@c or arithmetic operators, and assigning such a "pseudo-file" to sys.stdin will
@c not cause the interpreter to read further input from it.)

@ref{1cc5,,Instance method objects} have attributes, too:
@ref{1408,,m.__self__} is the instance
object with the method @code{m()}, and @ref{1363,,m.__func__} is
the @ref{3eb,,function object}
corresponding to the method.

@node Iteradores,Generadores,Detalles y Cuestiones Varias,Clases
@anchor{tutorial/classes iterators}@anchor{1cc6}@anchor{tutorial/classes tut-iterators}@anchor{1cc7}
@subsection Iteradores


Es probable que hayas notado que la mayoría de los objetos contenedores pueden ser recorridos usando una sentencia @ref{1eb,,for}:

@example
for element in [1, 2, 3]:
    print(element)
for element in (1, 2, 3):
    print(element)
for key in @{'one':1, 'two':2@}:
    print(key)
for char in "123":
    print(char)
for line in open("myfile.txt"):
    print(line, end='@w{'})
@end example

Este estilo de acceso es limpio, conciso y conveniente.  El uso de iteradores está impregnado y unifica a Python.  En bambalinas, la sentencia @ref{1eb,,for} llama a @ref{86e,,iter()} en el objeto contenedor.  La función retorna un objeto iterador que define el método @code{__next__()} que accede elementos en el contenedor de a uno por vez.  Cuando no hay más elementos, @ref{1335,,__next__()} lanza una excepción @ref{c82,,StopIteration} que le avisa al bucle del @code{for} que hay que terminar.  Podés llamar al método @ref{1335,,__next__()} usando la función integrada @ref{86f,,next()}; este ejemplo muestra como funciona todo esto:

@example
>>> s = 'abc'
>>> it = iter(s)
>>> it
<str_iterator object at 0x10c90e650>
>>> next(it)
'a'
>>> next(it)
'b'
>>> next(it)
'c'
>>> next(it)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    next(it)
StopIteration
@end example

Habiendo visto la mecánica del protocolo de iteración, es fácil agregar comportamiento de iterador a tus clases. Definí un método @ref{1cc8,,__iter__()} que retorne un objeto con un método @ref{1335,,__next__()}. Si la clase define @code{__next__()}, entonces alcanza con que @code{__iter__()} retorne @code{self}:

@example
class Reverse:
    """Iterator for looping over a sequence backwards."""
    def __init__(self, data):
        self.data = data
        self.index = len(data)

    def __iter__(self):
        return self

    def __next__(self):
        if self.index == 0:
            raise StopIteration
        self.index = self.index - 1
        return self.data[self.index]
@end example

@example
>>> rev = Reverse('spam')
>>> iter(rev)
<__main__.Reverse object at 0x00A1DB50>
>>> for char in rev:
...     print(char)
...
m
a
p
s
@end example

@node Generadores,Expresiones generadoras,Iteradores,Clases
@anchor{tutorial/classes generators}@anchor{1cc9}@anchor{tutorial/classes tut-generators}@anchor{1cca}
@subsection Generadores


@ref{10dd,,Generators} son una herramienta simple y poderosa para crear iteradores. Están escritas como funciones regulares pero usan la palabra clave @ref{a5f,,yield} siempre que quieran retornar datos. Cada vez que se llama a @ref{86f,,next()}, el generador se reanuda donde lo dejó (recuerda todos los valores de datos y qué instrucción se ejecutó por última vez). Un ejemplo muestra que los generadores pueden ser trivialmente fáciles de crear:

@example
def reverse(data):
    for index in range(len(data)-1, -1, -1):
        yield data[index]
@end example

@example
>>> for char in reverse('golf'):
...     print(char)
...
f
l
o
g
@end example

Todo lo que puede ser hecho con generadores también puede ser hecho con iteradores basados en clases, como se describe en la sección anterior. Lo que hace que los generadores sean tan compactos es que los métodos @ref{1ccb,,__iter__()} y @ref{1ccc,,__next__()} son creados automáticamente.

Otra característica clave es que las variables locales y el estado de la ejecución son guardados automáticamente entre llamadas.  Esto hace que la función sea más fácil de escribir y quede mucho más claro que hacerlo usando variables de instancia tales como @code{self.indice} y @code{self.datos}.

Además de la creación automática de métodos y el guardar el estado del programa, cuando los generadores terminan automáticamente lanzan @ref{c82,,StopIteration}.  Combinadas, estas características facilitan la creación de iteradores, y hacen que no sea más esfuerzo que escribir una función regular.

@node Expresiones generadoras,,Generadores,Clases
@anchor{tutorial/classes generator-expressions}@anchor{1ccd}@anchor{tutorial/classes tut-genexps}@anchor{1cce}
@subsection Expresiones generadoras


Algunos generadores simples pueden ser escritos de manera concisa como expresiones usando una sintaxis similar a las comprensiones de listas pero con paréntesis en lugar de corchetes. Estas expresiones están hechas para situaciones donde el generador es utilizado de inmediato por la función que lo encierra. Las expresiones generadoras son más compactas pero menos versátiles que las definiciones completas de generadores y tienden a ser más amigables con la memoria que sus comprensiones de listas equivalentes.

Ejemplos:

@example
>>> sum(i*i for i in range(10))                 # sum of squares
285

>>> xvec = [10, 20, 30]
>>> yvec = [7, 5, 3]
>>> sum(x*y for x,y in zip(xvec, yvec))         # dot product
260

>>> unique_words = set(word for line in page  for word in line.split())

>>> valedictorian = max((student.gpa, student.name) for student in graduates)

>>> data = 'golf'
>>> list(data[i] for i in range(len(data)-1, -1, -1))
['f', 'l', 'o', 'g']
@end example

@subsubheading Notas al pie


@node Breve recorrido por la Biblioteca Estándar,Pequeño paseo por la Biblioteca Estándar— Parte II,Clases,El tutorial de Python
@anchor{tutorial/stdlib doc}@anchor{1ccf}@anchor{tutorial/stdlib brief-tour-of-the-standard-library}@anchor{1cd0}@anchor{tutorial/stdlib tut-brieftour}@anchor{1cd1}
@section Breve recorrido por la Biblioteca Estándar


@menu
* Interfaz del sistema operativo:: 
* Comodines de archivos:: 
* Argumentos de Líneas de Comandos:: 
* Redirigir la salida de error y finalización del programa:: 
* Coincidencia de patrones de cadena:: 
* Matemáticas: Matemáticas<4>. 
* Acceso a Internet:: 
* Fechas y tiempos:: 
* Compresión de datos:: 
* Medición de rendimiento:: 
* Control de calidad:: 
* Pilas incluidas:: 

@end menu

@node Interfaz del sistema operativo,Comodines de archivos,,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib operating-system-interface}@anchor{1cd2}@anchor{tutorial/stdlib tut-os-interface}@anchor{1cd3}
@subsection Interfaz del sistema operativo


El módulo @ref{a1,,os} proporciona docenas de funciones para interactuar con el sistema operativo:

@example
>>> import os
>>> os.getcwd()      # Return the current working directory
'C:\\Python314'
>>> os.chdir('/server/accesslogs')   # Change current working directory
>>> os.system('mkdir today')   # Run the command mkdir in the system shell
0
@end example

Asegúrate de utilizar el estilo @code{import os} en lugar de @code{from os import *}. Esto evitará que @ref{e18,,os.open()} oculte la función integrada @ref{1be,,open()}, que funciona de manera muy diferente.

@geindex función incorporada;ayuda

Las funciones integradas @ref{6d3,,dir()} y @ref{96e,,help()} son útiles como ayudas interactivas para trabajar con módulos grandes como @ref{a1,,os}:

@example
>>> import os
>>> dir(os)
<returns a list of all module functions>
>>> help(os)
<returns an extensive manual page created from the module's docstrings>
@end example

Para las tareas diarias de administración de archivos y directorios, el módulo @ref{c5,,shutil} proporciona una interfaz en un nivel superior que es más fácil de usar:

@example
>>> import shutil
>>> shutil.copyfile('data.db', 'archive.db')
'archive.db'
>>> shutil.move('/build/executables', 'installdir')
'installdir'
@end example

@node Comodines de archivos,Argumentos de Líneas de Comandos,Interfaz del sistema operativo,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib file-wildcards}@anchor{1cd4}@anchor{tutorial/stdlib tut-file-wildcards}@anchor{1cd5}
@subsection Comodines de archivos


El módulo @ref{64,,glob} proporciona una función para hacer listas de archivos a partir de búsquedas con comodines en directorios:

@example
>>> import glob
>>> glob.glob('*.py')
['primes.py', 'random.py', 'quote.py']
@end example

@node Argumentos de Líneas de Comandos,Redirigir la salida de error y finalización del programa,Comodines de archivos,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib command-line-arguments}@anchor{1cd6}@anchor{tutorial/stdlib tut-command-line-arguments}@anchor{1cd7}
@subsection Argumentos de Líneas de Comandos


Los programas frecuentemente necesitan procesar argumentos de linea de comandos. Estos argumentos se almacenan en el atributo `argv' del módulo @ref{d9,,sys} como una lista.   Por ejemplo, consideremos el siguiente archivo :file: “demo.py”:

@example
# File demo.py
import sys
print(sys.argv)
@end example

Este es el resultado de ejecutar @code{python demo.py one two three} en la línea de comandos:

@example
['demo.py', 'one', 'two', 'three']
@end example

El modulo @ref{7,,argparse} provee un mecanismo más sofisticado para procesar argumentos recibidos vía línea de comandos. El siguiente `script' extrae uno o más nombres de archivos y un número opcional de líneas para mostrar:

@example
import argparse

parser = argparse.ArgumentParser(
    prog='top',
    description='Show top lines from each file')
parser.add_argument('filenames', nargs='+')
parser.add_argument('-l', '--lines', type=int, default=10)
args = parser.parse_args()
print(args)
@end example

Cuando se ejecuta en la línea de comandos con @code{python top.py --lines=5 alpha.txt beta.txt}, el `script' establece @code{args.lines} a @code{5} y @code{args.filenames} a @code{['alpha.txt', 'beta.txt']}.

@node Redirigir la salida de error y finalización del programa,Coincidencia de patrones de cadena,Argumentos de Líneas de Comandos,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib error-output-redirection-and-program-termination}@anchor{1cd8}@anchor{tutorial/stdlib tut-stderr}@anchor{1cd9}
@subsection Redirigir la salida de error y finalización del programa


El módulo @ref{d9,,sys} también tiene sus atributos para `stdin', `stdout', y `stderr'.  Este último es útil para emitir mensajes de alerta y error para que se vean incluso cuando se haya redirigido `stdout':

@example
>>> sys.stderr.write('Warning, log file not found starting a new one\n')
Warning, log file not found starting a new one
@end example

La forma más directa de terminar un programa es usar @code{sys.exit()}.

@node Coincidencia de patrones de cadena,Matemáticas<4>,Redirigir la salida de error y finalización del programa,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib string-pattern-matching}@anchor{1cda}@anchor{tutorial/stdlib tut-string-pattern-matching}@anchor{1cdb}
@subsection Coincidencia de patrones de cadena


El módulo @ref{b9,,re} provee herramientas de expresiones regulares para un procesamiento avanzado de cadenas.  Para manipulación y coincidencias complejas, las expresiones regulares ofrecen soluciones concisas y optimizadas:

@example
>>> import re
>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
['foot', 'fell', 'fastest']
>>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat')
'cat in the hat'
@end example

Cuando sólo se necesitan funciones sencillas, se prefieren los métodos de cadenas porque son más fáciles de leer y depurar:

@example
>>> 'tea for too'.replace('too', 'two')
'tea for two'
@end example

@node Matemáticas<4>,Acceso a Internet,Coincidencia de patrones de cadena,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib mathematics}@anchor{1cdc}@anchor{tutorial/stdlib tut-mathematics}@anchor{1cdd}
@subsection Matemáticas


The @ref{8e,,math} module gives access to the underlying C library functions for
floating-point math:

@example
>>> import math
>>> math.cos(math.pi / 4)
0.70710678118654757
>>> math.log(1024, 2)
10.0
@end example

El módulo @ref{b8,,random} provee herramientas para realizar selecciones aleatorias:

@example
>>> import random
>>> random.choice(['apple', 'pear', 'banana'])
'apple'
>>> random.sample(range(100), 10)   # sampling without replacement
[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
>>> random.random()    # random float from the interval [0.0, 1.0)
0.17970987693706186
>>> random.randrange(6)    # random integer chosen from range(6)
4
@end example

El módulo @ref{d2,,statistics} calcula propiedades de estadística básica (la media, mediana, varianza, etc) de datos numéricos:

@example
>>> import statistics
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> statistics.mean(data)
1.6071428571428572
>>> statistics.median(data)
1.25
>>> statistics.variance(data)
1.3720238095238095
@end example

El proyecto SciPy <@indicateurl{https://scipy.org}> tiene muchos otros módulos para cálculos numéricos.

@node Acceso a Internet,Fechas y tiempos,Matemáticas<4>,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib internet-access}@anchor{1cde}@anchor{tutorial/stdlib tut-internet-access}@anchor{1cdf}
@subsection Acceso a Internet


Hay varios módulos para acceder a Internet y procesar sus protocolos.  Dos de los más simples son @ref{10b,,urllib.request} para traer data de URLs y @ref{ca,,smtplib} para enviar correos:

@example
>>> from urllib.request import urlopen
>>> with urlopen('http://worldtimeapi.org/api/timezone/etc/UTC.txt') as response:
...     for line in response:
...         line = line.decode()             # Convert bytes to a str
...         if line.startswith('datetime'):
...             print(line.rstrip())         # Remove trailing newline
...
datetime: 2022-01-01T01:36:47.689215+00:00

>>> import smtplib
>>> server = smtplib.SMTP('localhost')
>>> server.sendmail('soothsayer@@example.org', 'jcaesar@@example.org',
... """To: jcaesar@@example.org
... From: soothsayer@@example.org
...
... Beware the Ides of March.
... """)
>>> server.quit()
@end example

(Nota que el segundo ejemplo necesita un servidor de correo corriendo en la máquina local)

@node Fechas y tiempos,Compresión de datos,Acceso a Internet,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib dates-and-times}@anchor{1ce0}@anchor{tutorial/stdlib tut-dates-and-times}@anchor{1ce1}
@subsection Fechas y tiempos


El módulo @ref{31,,datetime} ofrece clases para gestionar fechas y tiempos tanto de manera simple como compleja.  Aunque soporta aritmética sobre fechas y tiempos, la aplicación se centra en la extracción eficiente de elementos para el formateo y la manipulación de los datos de salida.  El módulo también admite objetos que tienen en cuenta la zona horaria.

@example
>>> # dates are easily constructed and formatted
>>> from datetime import date
>>> now = date.today()
>>> now
datetime.date(2003, 12, 2)
>>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.")
'12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.'

>>> # dates support calendar arithmetic
>>> birthday = date(1964, 7, 31)
>>> age = now - birthday
>>> age.days
14368
@end example

@node Compresión de datos,Medición de rendimiento,Fechas y tiempos,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib data-compression}@anchor{1ce2}@anchor{tutorial/stdlib tut-data-compression}@anchor{1ce3}
@subsection Compresión de datos


Los módulos admiten directamente los formatos más comunes de archivo y compresión de datos, entre ellos : @ref{132,,zlib}, @ref{67,,gzip}, @ref{14,,bz2}, @ref{8a,,lzma}, @ref{130,,zipfile} y @ref{de,,tarfile}.

@example
>>> import zlib
>>> s = b'witch which has which witches wrist watch'
>>> len(s)
41
>>> t = zlib.compress(s)
>>> len(t)
37
>>> zlib.decompress(t)
b'witch which has which witches wrist watch'
>>> zlib.crc32(s)
226805979
@end example

@node Medición de rendimiento,Control de calidad,Compresión de datos,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib performance-measurement}@anchor{1ce4}@anchor{tutorial/stdlib tut-performance-measurement}@anchor{1ce5}
@subsection Medición de rendimiento


Algunos usuarios de Python desarrollan un profundo interés en conocer el rendimiento relativo de las diferentes soluciones al mismo problema.  Python provee una herramienta de medición que responde inmediatamente a esas preguntas.

Por ejemplo, puede ser tentador usar la característica de empaquetado y desempaquetado de las tuplas en lugar de la solución tradicional para intercambiar argumentos.  El módulo @ref{ef,,timeit} muestra rápidamente una ligera ventaja de rendimiento:

@example
>>> from timeit import Timer
>>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit()
0.57535828626024577
>>> Timer('a,b = b,a', 'a=1; b=2').timeit()
0.54962537085770791
@end example

En contraste con el fino nivel de medición del módulo @ref{ef,,timeit}, los módulos @ref{af,,profile} y @ref{b0,,pstats} proveen herramientas para identificar secciones críticas de tiempo en bloques de código más grandes.

@node Control de calidad,Pilas incluidas,Medición de rendimiento,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib quality-control}@anchor{1ce6}@anchor{tutorial/stdlib tut-quality-control}@anchor{1ce7}
@subsection Control de calidad


Una forma para desarrollar software de alta calidad consiste en escribir pruebas para cada función mientras se desarrolla y correr esas pruebas frecuentemente durante el proceso de desarrollo.

El módulo @ref{3b,,doctest} provee una herramienta para revisar un módulo y validar las pruebas integradas en las cadenas de documentación (o `docstring') del programa.  La construcción de las pruebas es tan sencillo como cortar y pegar una ejecución típica junto con sus resultados en los docstrings.  Esto mejora la documentación al proveer al usuario un ejemplo y permite que el módulo `doctest' se asegure que el código permanece fiel a la documentación:

@example
def average(values):
    """Computes the arithmetic mean of a list of numbers.

    >>> print(average([20, 30, 70]))
    40.0
    """
    return sum(values) / len(values)

import doctest
doctest.testmod()   # automatically validate the embedded tests
@end example

El módulo @ref{106,,unittest} no es tan sencillo como el módulo @ref{3b,,doctest}, pero permite mantener un conjunto más completo de pruebas en un archivo independiente:

@example
import unittest

class TestStatisticalFunctions(unittest.TestCase):

    def test_average(self):
        self.assertEqual(average([20, 30, 70]), 40.0)
        self.assertEqual(round(average([1, 5, 7]), 1), 4.3)
        with self.assertRaises(ZeroDivisionError):
            average([])
        with self.assertRaises(TypeError):
            average(20, 30, 70)

unittest.main()  # Calling from the command line invokes all tests
@end example

@node Pilas incluidas,,Control de calidad,Breve recorrido por la Biblioteca Estándar
@anchor{tutorial/stdlib batteries-included}@anchor{1ce8}@anchor{tutorial/stdlib tut-batteries-included}@anchor{1ce9}
@subsection Pilas incluidas


Python tiene una filosofía de «pilas incluidas».  Esto se ve mejor en las capacidades robustas y sofisticadas de sus paquetes más grandes.  Por ejemplo:


@itemize *

@item 
Los módulos @ref{12d,,xmlrpc.client} y @ref{12e,,xmlrpc.server} convierten la implementación de llamadas a procedimientos remotos en una tarea casi trivial.  A pesar de los nombres de los módulos, no se necesita ningún conocimiento o manejo directo de XML.

@item 
El paquete @ref{3c,,email} es una biblioteca para administrar mensajes de correo electrónico, incluidos MIME y otros documentos de mensajes basados en 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. A diferencia de @ref{ca,,smtplib} y @ref{ac,,poplib} que realmente envían y reciben mensajes, el paquete de correo electrónico tiene un conjunto de herramientas completo para crear o decodificar estructuras de mensajes complejas (incluidos los archivos adjuntos) y para implementar protocolos de codificación y encabezado de Internet.

@item 
El paquete @ref{82,,json} proporciona un sólido soporte para analizar este popular formato de intercambio de datos.  El módulo @ref{2a,,csv} permite la lectura y escritura directa de archivos en formato de valor separado por comas, comúnmente compatible con bases de datos y hojas de cálculo.  El procesamiento XML es compatible con los paquetes @ref{125,,xml.etree.ElementTree}, @ref{121,,xml.dom} y @ref{129,,xml.sax}. Juntos, estos módulos y paquetes simplifican en gran medida el intercambio de datos entre aplicaciones de Python y otras herramientas.

@item 
El módulo @ref{cf,,sqlite3} es un wrapper de la biblioteca de bases de datos SQLite, proporciona una base de datos constante que se puede actualizar y a la que se puede acceder utilizando una sintaxis SQL ligeramente no estándar.

@item 
La internacionalización es compatible con una serie de módulos, incluyendo @ref{63,,gettext}, @ref{86,,locale}, y el paquete @ref{1c,,codecs}.
@end itemize

@node Pequeño paseo por la Biblioteca Estándar— Parte II,Entornos virtuales y paquetes,Breve recorrido por la Biblioteca Estándar,El tutorial de Python
@anchor{tutorial/stdlib2 doc}@anchor{1cea}@anchor{tutorial/stdlib2 brief-tour-of-the-standard-library-part-ii}@anchor{1ceb}@anchor{tutorial/stdlib2 tut-brieftourtwo}@anchor{1cec}
@section Pequeño paseo por la Biblioteca Estándar— Parte II


Este segundo paseo cubre módulos más avanzados que facilitan necesidades de programación complejas.  Estos módulos raramente se usan en scripts cortos.

@menu
* Formato de salida:: 
* Plantillas:: 
* Trabajar con registros estructurados conteniendo datos binarios:: 
* Multi-hilos:: 
* Registrando:: 
* Referencias débiles:: 
* Herramientas para trabajar con listas:: 
* Decimal Floating-Point Arithmetic:: 

@end menu

@node Formato de salida,Plantillas,,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 output-formatting}@anchor{1ced}@anchor{tutorial/stdlib2 tut-output-formatting}@anchor{1cee}
@subsection Formato de salida


El módulo @ref{bb,,reprlib} provee una versión de @ref{894,,repr()} ajustada para mostrar contenedores grandes o profundamente anidados, en forma abreviada:

@example
>>> import reprlib
>>> reprlib.repr(set('supercalifragilisticexpialidocious'))
"@{'a', 'c', 'd', 'e', 'f', 'g', ...@}"
@end example

El módulo @ref{ae,,pprint} ofrece un control más sofisticado de la forma en que se imprimen tanto los objetos predefinidos como los objetos definidos por el usuario, de manera que sean legibles por el intérprete. Cuando el resultado ocupa más de una línea, el generador de «impresiones lindas» agrega saltos de línea y sangrías para mostrar la estructura de los datos más claramente:

@example
>>> import pprint
>>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
...     'yellow'], 'blue']]]
...
>>> pprint.pprint(t, width=30)
[[[['black', 'cyan'],
   'white',
   ['green', 'red']],
  [['magenta', 'yellow'],
   'blue']]]
@end example

El módulo @ref{ec,,textwrap} formatea párrafos de texto para que quepan dentro de cierto ancho de pantalla:

@example
>>> import textwrap
>>> doc = """The wrap() method is just like fill() except that it returns
... a list of strings instead of one big string with newlines to separate
... the wrapped lines."""
...
>>> print(textwrap.fill(doc, width=40))
The wrap() method is just like fill()
except that it returns a list of strings
instead of one big string with newlines
to separate the wrapped lines.
@end example

El módulo @ref{86,,locale} accede a una base de datos de formatos específicos a una cultura.  El atributo `grouping' de la función `format' permite una forma directa de formatear números con separadores de grupo:

@example
>>> import locale
>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
'English_United States.1252'
>>> conv = locale.localeconv()          # get a mapping of conventions
>>> x = 1234567.8
>>> locale.format_string("%d", x, grouping=True)
'1,234,567'
>>> locale.format_string("%s%.*f", (conv['currency_symbol'],
...                      conv['frac_digits'], x), grouping=True)
'$1,234,567.80'
@end example

@node Plantillas,Trabajar con registros estructurados conteniendo datos binarios,Formato de salida,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 templating}@anchor{1cef}@anchor{tutorial/stdlib2 tut-templating}@anchor{1cf0}
@subsection Plantillas


El módulo @ref{d3,,string} incluye una clase versátil @ref{728,,Template} (plantilla) con una sintaxis simplificada apta para ser editada por usuarios finales.  Esto permite que los usuarios personalicen sus aplicaciones sin necesidad de modificar la aplicación en sí.

El formato usa marcadores cuyos nombres se forman con @code{$} seguido de identificadores Python válidos (caracteres alfanuméricos y guión de subrayado). Si se los encierra entre llaves, pueden seguir más caracteres alfanuméricos sin necesidad de dejar espacios en blanco. @code{$$} genera un @code{$}:

@example
>>> from string import Template
>>> t = Template('$@{village@}folk send $$10 to $cause.')
>>> t.substitute(village='Nottingham', cause='the ditch fund')
'Nottinghamfolk send $10 to the ditch fund.'
@end example

El método @ref{1cf1,,substitute()} lanza @ref{438,,KeyError} cuando no se suministra ningún valor para un marcador mediante un diccionario o argumento por nombre.  Para algunas aplicaciones los datos suministrados por el usuario puede ser incompletos, y el método @ref{1cf2,,safe_substitute()} puede ser más apropiado: deja los marcadores inalterados cuando falten datos:

@example
>>> t = Template('Return the $item to $owner.')
>>> d = dict(item='unladen swallow')
>>> t.substitute(d)
Traceback (most recent call last):
  ...
KeyError: 'owner'
>>> t.safe_substitute(d)
'Return the unladen swallow to $owner.'
@end example

Las subclases de `Template' pueden especificar un delimitador propio. Por ejemplo, una utilidad de renombrado por lotes para una galería de fotos puede escoger usar signos de porcentaje para los marcadores tales como la fecha actual, el número de secuencia de la imagen, o el formato de archivo:

@example
>>> import time, os.path
>>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
>>> class BatchRename(Template):
...     delimiter = '%'
...
>>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format):  ')
Enter rename style (%d-date %n-seqnum %f-format):  Ashley_%n%f

>>> t = BatchRename(fmt)
>>> date = time.strftime('%d%b%y')
>>> for i, filename in enumerate(photofiles):
...     base, ext = os.path.splitext(filename)
...     newname = t.substitute(d=date, n=i, f=ext)
...     print('@{0@} --> @{1@}'.format(filename, newname))

img_1074.jpg --> Ashley_0.jpg
img_1076.jpg --> Ashley_1.jpg
img_1077.jpg --> Ashley_2.jpg
@end example

Las plantillas también pueden ser usadas para separar la lógica del programa de los detalles de múltiples formatos de salida.  Esto permite sustituir plantillas específicas para archivos XML, reportes en texto plano, y reportes web en HTML.

@node Trabajar con registros estructurados conteniendo datos binarios,Multi-hilos,Plantillas,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 tut-binary-formats}@anchor{1cf3}@anchor{tutorial/stdlib2 working-with-binary-data-record-layouts}@anchor{1cf4}
@subsection Trabajar con registros estructurados conteniendo datos binarios


El módulo @ref{d5,,struct} provee las funciones @ref{12e4,,pack()} y @ref{17ce,,unpack()} para trabajar con formatos de registros binarios de longitud variable.  El siguiente ejemplo muestra cómo recorrer la información de encabezado en un archivo ZIP sin usar el módulo @ref{130,,zipfile}.  Los códigos @code{"H"} e @code{"I"} representan números sin signo de dos y cuatro bytes respectivamente.  El @code{"<"} indica que son de tamaño estándar y los bytes tienen ordenamiento @cite{little-endian}:

@example
import struct

with open('myfile.zip', 'rb') as f:
    data = f.read()

start = 0
for i in range(3):                      # show the first 3 file headers
    start += 14
    fields = struct.unpack('<IIIHH', data[start:start+16])
    crc32, comp_size, uncomp_size, filenamesize, extra_size = fields

    start += 16
    filename = data[start:start+filenamesize]
    start += filenamesize
    extra = data[start:start+extra_size]
    print(filename, hex(crc32), comp_size, uncomp_size)

    start += extra_size + comp_size     # skip to the next header
@end example

@node Multi-hilos,Registrando,Trabajar con registros estructurados conteniendo datos binarios,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 multi-threading}@anchor{1cf5}@anchor{tutorial/stdlib2 tut-multi-threading}@anchor{1cf6}
@subsection Multi-hilos


La técnica de multi-hilos (o `multi-threading') permite desacoplar tareas que no tienen dependencia secuencial.  Los hilos se pueden usar para mejorar el grado de reacción de las aplicaciones que aceptan entradas del usuario mientras otras tareas se ejecutan en segundo plano.  Un caso de uso relacionado es ejecutar E/S en paralelo con cálculos en otro hilo.

El código siguiente muestra cómo el módulo de alto nivel @ref{ed,,threading} puede ejecutar tareas en segundo plano mientras el programa principal continúa su ejecución:

@example
import threading, zipfile

class AsyncZip(threading.Thread):
    def __init__(self, infile, outfile):
        threading.Thread.__init__(self)
        self.infile = infile
        self.outfile = outfile

    def run(self):
        f = zipfile.ZipFile(self.outfile, 'w', zipfile.ZIP_DEFLATED)
        f.write(self.infile)
        f.close()
        print('Finished background zip of:', self.infile)

background = AsyncZip('mydata.txt', 'myarchive.zip')
background.start()
print('The main program continues to run in foreground.')

background.join()    # Wait for the background task to finish
print('Main program waited until background was done.')
@end example

El desafío principal de las aplicaciones multi-hilo es la coordinación entre los hilos que comparten datos u otros recursos.  A ese fin, el módulo `threading' provee una serie de primitivas de sincronización que incluyen bloqueos, eventos, variables de condición, y semáforos.

Aún cuando esas herramientas son poderosas, pequeños errores de diseño pueden resultar en problemas difíciles de reproducir.  La forma preferida de coordinar tareas es concentrar todos los accesos a un recurso en un único hilo y después usar el módulo @ref{b6,,queue} para alimentar dicho hilo con pedidos desde otros hilos.  Las aplicaciones que usan objetos @ref{13ee,,Queue} para comunicación y coordinación entre hilos son más fáciles de diseñar, más legibles, y más confiables.

@node Registrando,Referencias débiles,Multi-hilos,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 logging}@anchor{1cf7}@anchor{tutorial/stdlib2 tut-logging}@anchor{1cf8}
@subsection Registrando


El módulo @ref{87,,logging} ofrece un sistema de registros (`logs') completo y flexible.  En su forma más simple, los mensajes de registro se envían a un archivo o a @code{sys.stderr}:

@example
import logging
logging.debug('Debugging information')
logging.info('Informational message')
logging.warning('Warning:config file %s not found', 'server.conf')
logging.error('Error occurred')
logging.critical('Critical error -- shutting down')
@end example

Ésta es la salida obtenida:

@example
WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down
@end example

De forma predeterminada, los mensajes de depuración e informativos se suprimen, y la salida se envía al error estándar.  Otras opciones de salida incluyen mensajes de enrutamiento a través de correo electrónico, datagramas, sockets, o un servidor HTTP.  Nuevos filtros pueden seleccionar diferentes rutas basadas en la prioridad del mensaje: @ref{1cf9,,DEBUG}, @ref{1cfa,,INFO}, @ref{1cfb,,WARNING}, @ref{1cfc,,ERROR}, y @ref{1cfd,,CRITICAL} (Depuración, Informativo, Atención, Error y Crítico respectivamente)

El sistema de registro puede configurarse directamente desde Python o puede cargarse la configuración desde un archivo modificable por el usuario para personalizar el registro sin alterar la aplicación.

@node Referencias débiles,Herramientas para trabajar con listas,Registrando,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 tut-weak-references}@anchor{1cfe}@anchor{tutorial/stdlib2 weak-references}@anchor{1cff}
@subsection Referencias débiles


Python realiza administración de memoria automática (cuenta de referencias para la mayoría de los objetos, y @ref{1922,,garbage collection} para eliminar ciclos).  La memoria se libera poco después de que la última referencia a la misma haya sido eliminada.

Este enfoque funciona bien para la mayoría de las aplicaciones pero de vez en cuando existe la necesidad de controlar objetos sólo mientras estén siendo utilizados por otra cosa. Desafortunadamente, el sólo hecho de controlarlos crea una referencia que los convierte en permanentes. El módulo @ref{114,,weakref} provee herramientas para controlar objetos sin crear una referencia. Cuando el objeto no se necesita mas, es removido automáticamente de una tabla de referencias débiles y se dispara una `callback' para objetos `weakref'. Comúnmente las aplicaciones incluyen cacheo de objetos que son costosos de crear:

@example
>>> import weakref, gc
>>> class A:
...     def __init__(self, value):
...         self.value = value
...     def __repr__(self):
...         return str(self.value)
...
>>> a = A(10)                   # create a reference
>>> d = weakref.WeakValueDictionary()
>>> d['primary'] = a            # does not create a reference
>>> d['primary']                # fetch the object if it is still alive
10
>>> del a                       # remove the one reference
>>> gc.collect()                # run garbage collection right away
0
>>> d['primary']                # entry was automatically removed
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    d['primary']                # entry was automatically removed
  File "C:/python314/lib/weakref.py", line 46, in __getitem__
    o = self.data[key]()
KeyError: 'primary'
@end example

@node Herramientas para trabajar con listas,Decimal Floating-Point Arithmetic,Referencias débiles,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 tools-for-working-with-lists}@anchor{1d00}@anchor{tutorial/stdlib2 tut-list-tools}@anchor{1d01}
@subsection Herramientas para trabajar con listas


Muchas necesidades de estructuras de datos pueden ser satisfechas con el tipo integrado lista.  Sin embargo, a veces se hacen necesarias implementaciones alternativas con rendimientos distintos.

The @ref{8,,array} module provides an @ref{308,,array} object that is like
a list that stores only homogeneous data and stores it more compactly.  The
following example shows an array of numbers stored as two byte unsigned binary
numbers (typecode @code{"H"}) rather than the usual 16 bytes per entry for regular
lists of Python int objects:

@example
>>> from array import array
>>> a = array('H', [4000, 10, 700, 22222])
>>> sum(a)
26932
>>> a[1:3]
array('H', [10, 700])
@end example

The @ref{1e,,collections} module provides a @ref{67d,,deque} object
that is like a list with faster appends and pops from the left side but slower
lookups in the middle. These objects are well suited for implementing queues
and breadth first tree searches:

@example
>>> from collections import deque
>>> d = deque(["task1", "task2", "task3"])
>>> d.append("task4")
>>> print("Handling", d.popleft())
Handling task1
@end example

@example
unsearched = deque([starting_node])
def breadth_first_search(unsearched):
    node = unsearched.popleft()
    for m in gen_moves(node):
        if is_goal(m):
            return m
        unsearched.append(m)
@end example

Además de las implementaciones alternativas de listas, la biblioteca ofrece otras herramientas como el módulo @ref{12,,bisect} con funciones para manipular listas ordenadas:

@example
>>> import bisect
>>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
>>> bisect.insort(scores, (300, 'ruby'))
>>> scores
[(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]
@end example

El módulo @ref{69,,heapq} provee funciones para implementar pilas (`heaps') basados en listas comunes.  El menor valor ingresado se mantiene en la posición cero. Esto es útil para aplicaciones que acceden a menudo al elemento más chico pero no quieren hacer un orden completo de la lista:

@example
>>> from heapq import heapify, heappop, heappush
>>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
>>> heapify(data)                      # rearrange the list into heap order
>>> heappush(data, -5)                 # add a new entry
>>> [heappop(data) for i in range(3)]  # fetch the three smallest entries
[-5, 0, 1]
@end example

@node Decimal Floating-Point Arithmetic,,Herramientas para trabajar con listas,Pequeño paseo por la Biblioteca Estándar— Parte II
@anchor{tutorial/stdlib2 decimal-floating-point-arithmetic}@anchor{1d02}@anchor{tutorial/stdlib2 tut-decimal-fp}@anchor{1d03}
@subsection Decimal Floating-Point Arithmetic


The @ref{37,,decimal} module offers a @ref{16a,,Decimal} datatype for
decimal floating-point arithmetic.  Compared to the built-in @ref{153,,float}
implementation of binary floating point, the class is especially helpful for


@itemize *

@item 
aplicaciones financieras y otros usos que requieren representación decimal exacta,

@item 
control sobre la precisión,

@item 
control sobre el redondeo para cumplir requisitos legales,

@item 
seguimiento de dígitos decimales significativos, o

@item 
aplicaciones donde el usuario espera que los resultados coincidan con cálculos hecho a mano.
@end itemize

Por ejemplo, calcular un impuesto del 5% de una tarifa telefónica de 70 centavos da resultados distintos con punto flotante decimal y punto flotante binario. La diferencia se vuelve significativa si los resultados se redondean al centavo más próximo:

@example
>>> from decimal import *
>>> round(Decimal('0.70') * Decimal('1.05'), 2)
Decimal('0.74')
>>> round(.70 * 1.05, 2)
0.73
@end example

El resultado con @ref{16a,,Decimal} conserva un cero al final, calculando automáticamente cuatro cifras significativas a partir de los multiplicandos con dos cifras significativas.  Decimal reproduce la matemática como se la hace a mano, y evita problemas que pueden surgir cuando el punto flotante binario no puede representar exactamente cantidades decimales.

La representación exacta permite a la clase @ref{16a,,Decimal} hacer cálculos de modulo y pruebas de igualdad que son inadecuadas para punto flotante binario:

@example
>>> Decimal('1.00') % Decimal('.10')
Decimal('0.00')
>>> 1.00 % 0.10
0.09999999999999995

>>> sum([Decimal('0.1')]*10) == Decimal('1.0')
True
>>> 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 == 1.0
False
@end example

El módulo @ref{37,,decimal} provee aritmética con tanta precisión como haga falta:

@example
>>> getcontext().prec = 36
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857')
@end example

@node Entornos virtuales y paquetes,¿Y ahora qué?,Pequeño paseo por la Biblioteca Estándar— Parte II,El tutorial de Python
@anchor{tutorial/venv doc}@anchor{1d04}@anchor{tutorial/venv tut-venv}@anchor{1d05}@anchor{tutorial/venv virtual-environments-and-packages}@anchor{1d06}
@section Entornos virtuales y paquetes


@menu
* Introducción: Introducción<4>. 
* Creando entornos virtuales:: 
* Manejando paquetes con pip:: 

@end menu

@node Introducción<4>,Creando entornos virtuales,,Entornos virtuales y paquetes
@anchor{tutorial/venv introduction}@anchor{1d07}
@subsection Introducción


Las aplicaciones en Python usualmente hacen uso de paquetes y módulos que no forman parte de la librería estándar. Las aplicaciones a veces necesitan una versión específica de una librería, debido a que dicha aplicación requiere que un bug particular haya sido solucionado o bien la aplicación ha sido escrita usando una versión obsoleta de la interfaz de la librería.

Esto significa que tal vez no sea posible para una instalación de Python cumplir los requerimientos de todas las aplicaciones. Si la aplicación A necesita la versión 1.0 de un módulo particular y la aplicación B necesita la versión 2.0, entonces los requerimientos entran en conflicto e instalar la versión 1.0 o 2.0 dejará una de las aplicaciones sin funcionar.

La solución a este problema es crear un @ref{1d08,,entorno virtual},  un directorio que contiene una instalación de Python de una versión en particular,  además de unos cuantos paquetes adicionales.

Diferentes aplicaciones pueden entonces usar entornos virtuales diferentes.  Para resolver el ejemplo de requerimientos en conflicto citado anteriormente, la aplicación A puede tener su propio entorno virtual con la versión 1.0 instalada mientras que la aplicación B tiene otro entorno virtual con la versión 2.0.  Si la aplicación B requiere que actualizar la librería a la versión 3.0, ésto no afectará el entorno virtual de la aplicación A.

@node Creando entornos virtuales,Manejando paquetes con pip,Introducción<4>,Entornos virtuales y paquetes
@anchor{tutorial/venv creating-virtual-environments}@anchor{1d09}
@subsection Creando entornos virtuales


The module used to create and manage virtual environments is called
@ref{111,,venv}.  @ref{111,,venv} will install the Python version from which
the command was run (as reported by the @ref{da2,,--version} option).
For instance, executing the command with @code{python3.12} will install
version 3.12.

Para crear un entorno virtual, decide en que carpeta quieres crearlo y ejecuta el módulo @ref{111,,venv} como script con la ruta a la carpeta:

@example
python -m venv tutorial-env
@end example

Esto creará el directorio @code{tutorial-env} si no existe, y también creará directorios dentro de él que contienen una copia del intérprete de Python y varios archivos de soporte.

Una ruta común para el directorio de un entorno virtual es @code{.venv}. Ese nombre mantiene el directorio típicamente escondido en la consola y fuera de vista mientras le da un nombre que explica cuál es el motivo de su existencia. También permite que no haya conflicto con los ficheros de definición de variables de entorno @code{.env} que algunas herramientas soportan.

Una vez creado el entorno virtual, podrás activarlo.

En Windows, ejecuta:

@example
tutorial-env\Scripts\activate
@end example

En Unix o MacOS, ejecuta:

@example
source tutorial-env/bin/activate
@end example

(Este script está escrito para la consola bash. Si usas las consolas @code{csh} or @code{fish}, hay scripts alternativos @code{activate.csh} y @code{activate.fish} que deberá usar en su lugar.)

Activar el entorno virtual cambiará el prompt de tu consola para mostrar que entorno virtual está usando, y modificará el entorno para que al ejecutar @code{python} sea con esa versión e instalación en particular.  Por ejemplo:

@example
$ source ~/envs/tutorial-env/bin/activate
(tutorial-env) $ python
Python 3.5.1 (default, May  6 2016, 10:59:36)
  ...
>>> import sys
>>> sys.path
['@w{'}, '/usr/local/lib/python35.zip', ...,
'~/envs/tutorial-env/lib/python3.5/site-packages']
>>>
@end example

Para desactivar el entorno virtual, digita:

@example
deactivate
@end example

en el terminal.

@node Manejando paquetes con pip,,Creando entornos virtuales,Entornos virtuales y paquetes
@anchor{tutorial/venv managing-packages-with-pip}@anchor{1d0a}
@subsection Manejando paquetes con pip


Puede instalar, actualizar y eliminar paquetes usando un programa llamado @code{pip}. De forma predeterminada, @code{pip} instalará paquetes desde el Indice de Paquetes de Python@footnote{https://pypi.org}. Puede navegar por el índice de paquetes de Python yendo a él en su navegador web.

@code{pip} tiene varios subcomandos: «install», «uninstall», «freeze», etc. (Consulte la guía @ref{f78,,Instalando módulos de Python} para obtener la documentación completa de @code{pip}).

Se puede instalar la última versión de un paquete especificando el nombre del paquete:

@example
(tutorial-env) $ python -m pip install novas
Collecting novas
  Downloading novas-3.1.1.3.tar.gz (136kB)
Installing collected packages: novas
  Running setup.py install for novas
Successfully installed novas-3.1.1.3
@end example

También se puede instalar una versión específica de un paquete ingresando el nombre del paquete seguido de @code{==} y el número de versión:

@example
(tutorial-env) $ python -m pip install requests==2.6.0
Collecting requests==2.6.0
  Using cached requests-2.6.0-py2.py3-none-any.whl
Installing collected packages: requests
Successfully installed requests-2.6.0
@end example

Si se ejecuta de nuevo el comando, @code{pip} detectará que la versión ya está instalada y no hará nada. Se puede ingresar un número de versión diferente para instalarlo, o se puede ejecutar @code{pip install --upgrade} para actualizar el paquete a la última versión:

@example
(tutorial-env) $ python -m pip install --upgrade requests
Collecting requests
Installing collected packages: requests
  Found existing installation: requests 2.6.0
    Uninstalling requests-2.6.0:
      Successfully uninstalled requests-2.6.0
Successfully installed requests-2.7.0
@end example

@code{pip -m pip uninstall} seguido de uno o varios nombres de paquetes eliminará los paquetes del entorno virtual.

@code{python -m pip show} mostrará información de un paquete en particular:

@example
(tutorial-env) $ python -m pip show requests
---
Metadata-Version: 2.0
Name: requests
Version: 2.7.0
Summary: Python HTTP for Humans.
Home-page: http://python-requests.org
Author: Kenneth Reitz
Author-email: me@@kennethreitz.com
License: Apache 2.0
Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
Requires:
@end example

@code{python -m pip list} mostrará todos los paquetes instalados en el entorno virtual:

@example
(tutorial-env) $ python -m pip list
novas (3.1.1.3)
numpy (1.9.2)
pip (7.0.3)
requests (2.7.0)
setuptools (16.0)
@end example

@code{python -m pip freeze} retorna una lista de paquetes instalados, pero el formato de salida es el requerido por @code{python -m pip install}.  Una convención común es poner esta lista en un archivo @code{requirements.txt}:

@example
(tutorial-env) $ python -m pip freeze > requirements.txt
(tutorial-env) $ cat requirements.txt
novas==3.1.1.3
numpy==1.9.2
requests==2.7.0
@end example

El archivo @code{requirements.txt} puede ser agregado al controlador de versiones y distribuido como parte de la aplicación. Los usuarios pueden entonces instalar todos los paquetes necesarios con @code{install -r}:

@example
(tutorial-env) $ python -m pip install -r requirements.txt
Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
  ...
Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
  ...
Collecting requests==2.7.0 (from -r requirements.txt (line 3))
  ...
Installing collected packages: novas, numpy, requests
  Running setup.py install for novas
Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0
@end example

@code{pip} tiene muchas más opciones.  Consulte la guía @ref{f78,,Instalando módulos de Python} para obtener documentación completa de @code{pip}.  Cuando haya escrito un paquete y desee que esté disponible en el índice de paquetes de Python, consulte la Guía de usuario de empaquetado de Python@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}.

@node ¿Y ahora qué?,Edición de entrada interactiva y sustitución de historial,Entornos virtuales y paquetes,El tutorial de Python
@anchor{tutorial/whatnow doc}@anchor{1d0b}@anchor{tutorial/whatnow tut-whatnow}@anchor{1d0c}@anchor{tutorial/whatnow what-now}@anchor{1d0d}
@section ¿Y ahora qué?


Leer este tutorial probablemente reforzó tu interés por usar Python, deberías estar ansioso por aplicar Python a la resolución de tus problemas reales. ¿A dónde deberías ir para aprender más?

Este tutorial forma parte del conjunto de documentación de Python. Algunos otros documentos que encontrarás en este conjunto son:


@itemize *

@item 
@ref{2b1,,La biblioteca estándar de Python}:

Deberías navegar a través de este manual, que da una completa (aunque breve) referencia sobre los tipos, funciones y módulos en la librería estándar. La distribución estándar de Python incluye `mucho' más código adicional. Hay módulos para leer buzones Unix, recuperar documentos vía HTTP, generar números aleatorios, analizar opciones de línea de comandos, escribir programas CGI, comprimir datos y muchas más tareas. Echar una ojeada a la Librería de Referencia te dará una idea de lo que está disponible.

@item 
@ref{f78,,Instalando módulos de Python}  explica como instalar módulos adicionales escritos por otros usuarios de Python.

@item 
@ref{2b2,,Referencia del Lenguaje Python}: Una explicación detallada de la sintaxis y la semántica de Python. Es una lectura pesada, pero es muy útil como guía complete del lenguaje.
@end itemize

Más recursos sobre Python:


@itemize *

@item 
@indicateurl{https://www.python.org}:  El mayor sitio web de Python. Contiene código, documentación, y enlaces a páginas web relacionadas con Python.

@item 
@indicateurl{https://docs.python.org}:  Acceso rápido a la documentación de Python.

@item 
@indicateurl{https://pypi.org}: El Python Package Index, apodado previamente la Tienda de Queso @footnote{
La tienda de queso, `Cheese Shop', es un chiste de `Monty Python': un cliente entra a una tienda de queso pero para cualquier queso que pide, el vendedor le dice que no lo tienen.
}, es un índice de módulos de Python creados por usuarios que están disponibles para su descarga. Cuando empiezas a distribuir código, lo puedes registrar allí para que otros lo encuentren.

@item 
@indicateurl{https://code.activestate.com/recipes/langs/python/}: El Python Cookbook es una gran colección de ejemplos de código, módulos grandes y scripts útiles. Las contribuciones más notables también están recogidas en un libro titulado Python Cookbook (O’Reilly & Associates, ISBN 0-596-00797-3.)

@item 
@indicateurl{http://www.pyvideo.org} recoge enlaces a vídeos relacionados con Python provenientes de conferencias y reuniones de grupos de usuarios.

@item 
@indicateurl{https://scipy.org}: El proyecto de Python científico incluye módulos para el cálculo rápido de operaciones y manipulaciones sobre arrays además de muchos paquetes para cosas como Álgebra Lineal, Transformadas de Fourier, solucionadores de sistemas no-lineales, distribuciones de números aleatorios, análisis estadísticos y otras herramientas.
@end itemize

Para preguntas relacionadas con Python y reportes de problemas puedes escribir al grupo de noticias @code{comp.lang.python}, o enviarlas a la lista de correo que hay en @email{python-list@@python.org}. El grupo de noticias y la lista de correo están conectados, por lo que los mensajes enviados a uno serán retransmitidos al otro.  Hay alrededor de cientos de mensajes diarios (con picos de hasta varios cientos), haciendo (y respondiendo) preguntas, sugiriendo nuevas características, y anunciando nuevos módulos. Los archivos de la lista de correos están disponibles en @indicateurl{https://mail.python.org/pipermail/}.

Antes de escribir, asegúrate de haber revisado la lista de @ref{1d0e,,Frequently Asked Questions} (también llamado el `FAQ'). Muchas veces responde las preguntas que se hacen una y otra vez, y quizás contenga la solución a tu problema.

@subsubheading Notas al pie


@node Edición de entrada interactiva y sustitución de historial,Floating-Point Arithmetic Issues and Limitations,¿Y ahora qué?,El tutorial de Python
@anchor{tutorial/interactive doc}@anchor{1d0f}@anchor{tutorial/interactive interactive-input-editing-and-history-substitution}@anchor{1d10}@anchor{tutorial/interactive tut-interacting}@anchor{1bef}
@section Edición de entrada interactiva y sustitución de historial


Algunas versiones del intérprete de Python permiten editar la línea de entrada actual, y sustituir en base al historial, de forma similar a las capacidades del intérprete de comandos `Korn' y el GNU bash.  Esto se implementa con la biblioteca GNU Readline@footnote{https://tiswww.case.edu/php/chet/readline/rltop.html}, que soporta varios estilos de edición.  Esta biblioteca tiene su propia documentación la cuál no vamos a duplicar aquí.

@menu
* Autocompletado con tab e historial de edición:: 
* Alternativas al intérprete interactivo:: 

@end menu

@node Autocompletado con tab e historial de edición,Alternativas al intérprete interactivo,,Edición de entrada interactiva y sustitución de historial
@anchor{tutorial/interactive tab-completion-and-history-editing}@anchor{1d11}@anchor{tutorial/interactive tut-keybindings}@anchor{1d12}
@subsection Autocompletado con tab e historial de edición


El autocompletado de variables y nombres de módulos es @ref{1048,,automatically enabled} al iniciar el intérprete, por lo tanto la tecla @code{Tab} invoca la función de autocompletado; ésta mira en los nombres de sentencia, las variables locales y los nombres de módulos disponibles. Para expresiones con puntos como @code{string.a}, va a evaluar la expresión hasta el @code{'.'} final y entonces sugerir autocompletado para los atributos del objeto resultante. Nota que esto quizás ejecute código de aplicaciones definidas si un objeto con un método @ref{57a,,__getattr__()} es parte de la expresión. La configuración por omisión también guarda tu historial en un archivo llamado @code{.python_history} en tu directorio de usuario. El historial estará disponible durante la próxima sesión interactiva del intérprete.

@node Alternativas al intérprete interactivo,,Autocompletado con tab e historial de edición,Edición de entrada interactiva y sustitución de historial
@anchor{tutorial/interactive alternatives-to-the-interactive-interpreter}@anchor{1d13}@anchor{tutorial/interactive tut-commentary}@anchor{1d14}
@subsection Alternativas al intérprete interactivo


Esta funcionalidad es un paso enorme hacia adelante comparado con versiones anteriores del interprete; de todos modos, quedan pendientes algunos deseos: sería bueno que el sangrado correcto se sugiriera en las lineas de continuación (el `parser' sabe si se requiere un sangrado a continuación). El mecanismo de completado podría usar la tabla de símbolos del intérprete. Un comando para verificar (o incluso sugerir) coincidencia de paréntesis, comillas, etc. también sería útil.

Un intérprete interactivo mejorado alternativo que está dando vueltas desde hace rato es IPython@footnote{https://ipython.org/}, que ofrece completado por tab, exploración de objetos, y administración avanzada del historial.  También puede ser configurado en profundidad, e integrarse en otras aplicaciones.  Otro entorno interactivo mejorado similar es bpython@footnote{https://bpython-interpreter.org/}.

@c import math
@c from fractions import Fraction

@node Floating-Point Arithmetic Issues and Limitations,Apéndice,Edición de entrada interactiva y sustitución de historial,El tutorial de Python
@anchor{tutorial/floatingpoint doc}@anchor{1d15}@anchor{tutorial/floatingpoint floating-point-arithmetic-issues-and-limitations}@anchor{1d16}@anchor{tutorial/floatingpoint tut-fp-issues}@anchor{1d17}
@section Floating-Point Arithmetic:  Issues and Limitations


Los números de punto flotante se representan en el hardware de computadoras como fracciones en base 2 (binarias). Por ejemplo, la fracción `decimal' @code{0.625} tiene un valor de 6/10 + 2/100 + 5/1000, y de la misma manera, la fracción binaria @code{0.101} tiene un valor de 1/2 + 0/4 + 1/8. Estas dos fracciones tienen valores idénticos; la única diferencia real radica en que la primera se escribe en notación fraccional en base 10, y la segunda en base 2.

Desafortunadamente, la mayoría de las fracciones decimales no pueden representarse exactamente como fracciones binarias.  Como consecuencia, en general los números de punto flotante decimal que ingresás en la computadora son sólo aproximados por los números de punto flotante binario que realmente se guardan en la máquina.

El problema es más fácil de entender primero en base 10.  Considerá la fracción 1/3.  Podés aproximarla como una fracción de base 10

@example
0.3
@end example

…o, mejor,

@example
0.33
@end example

…o, mejor,

@example
0.333
@end example

…y así.  No importa cuantos dígitos desees escribir, el resultado nunca será exactamente 1/3, pero será una aproximación cada vez mejor de 1/3.

De la misma manera, no importa cuantos dígitos en base 2 quieras usar, el valor decimal 0.1 no puede representarse exactamente como una fracción en base 2.  En base 2, 1/10 es la siguiente fracción que se repite infinitamente:

@example
0.0001100110011001100110011001100110011001100110011...
@end example

Frená en cualquier número finito de bits, y tendrás una aproximación.  En la mayoría de las máquinas hoy en día, los float se aproximan usando una fracción binaria con el numerador usando los primeros 53 bits con el bit más significativos y el denominador como una potencia de dos.  En el caso de 1/10, la fracción binaria es @code{3602879701896397 / 2 ** 55} que está cerca pero no es exactamente el valor verdadero de 1/10.

La mayoría de los usuarios no son conscientes de esta aproximación por la forma en que se muestran los valores. Python solamente muestra una aproximación decimal al valor verdadero decimal de la aproximación binaria almacenada por la máquina. En la mayoría de las máquinas, si Python fuera a imprimir el verdadero valor decimal de la aproximación binaria almacenada para 0.1, debería mostrar:

@example
>>> 0.1
0.1000000000000000055511151231257827021181583404541015625
@end example

Esos son más dígitos que lo que la mayoría de la gente encuentra útil, por lo que Python mantiene manejable la cantidad de dígitos al mostrar un valor redondeado en su lugar:

@example
>>> 1 / 10
0.1
@end example

Sólo recordá que, a pesar de que el valor mostrado resulta ser exactamente 1/10, el valor almacenado realmente es la fracción binaria más cercana posible.

Interesantemente, hay varios números decimales que comparten la misma fracción binaria más aproximada. Por ejemplo, los números @code{0.1}, @code{0.10000000000000001} y @code{0.1000000000000000055511151231257827021181583404541015625} son todos aproximados por @code{3602879701896397 / 2 ** 55}.  Ya que todos estos valores decimales comparten la misma aproximación, se podría mostrar cualquiera de ellos para preservar el invariante @code{eval(repr(x)) == x}.

Históricamente, el prompt de Python y la función integrada @ref{894,,repr()} eligieron el valor con los 17 dígitos, @code{0.10000000000000001}.  Desde Python 3.1, en la mayoría de los sistemas Python ahora es capaz de elegir la forma más corta de ellos y mostrar @code{0.1}.

Note that this is in the very nature of binary floating point: this is not a bug
in Python, and it is not a bug in your code either.  You’ll see the same kind of
thing in all languages that support your hardware’s floating-point arithmetic
(although some languages may not `display' the difference by default, or in all
output modes).

Para una salida más elegante, quizás quieras usar el formateo de cadenas de texto para generar un número limitado de dígitos significativos:

@example
>>> format(math.pi, '.12g')  # give 12 significant digits
'3.14159265359'

>>> format(math.pi, '.2f')   # give 2 digits after the point
'3.14'

>>> repr(math.pi)
'3.141592653589793'
@end example

Es importante darse cuenta que esto es, realmente, una ilusión: estás simplemente redondeando al `mostrar' el valor verdadero de la máquina.

Una ilusión puede generar otra. Por ejemplo, ya que 0.1 no es exactamente 1/10, sumar tres veces 0.1 podría también no generar exactamente 0.3:

@example
>>> 0.1 + 0.1 + 0.1 == 0.3
False
@end example

También, ya que 0.1 no puede acercarse más al valor exacto de 1/10 y 0.3 no puede acercarse más al valor exacto de 3/10, redondear primero con la función @ref{1342,,round()} no puede ayudar:

@example
>>> round(0.1, 1) + round(0.1, 1) + round(0.1, 1) == round(0.3, 1)
False
@end example

Aunque los números no pueden acercarse más a sus valores exactos previstos, la función @ref{e36,,math.isclose()} puede ser útil para comparar valores inexactos:

@example
>>> math.isclose(0.1 + 0.1 + 0.1, 0.3)
True
@end example

Alternatively, the @ref{1342,,round()} function can be used to compare rough
approximations:

@example
>>> round(math.pi, ndigits=2) == round(22 / 7, ndigits=2)
True
@end example

Binary floating-point arithmetic holds many surprises like this.  The problem
with «0.1» is explained in precise detail below, in the «Representation Error»
section.  See Examples of Floating Point Problems@footnote{https://jvns.ca/blog/2023/01/13/examples-of-floating-point-problems/} for
a pleasant summary of how binary floating point works and the kinds of
problems commonly encountered in practice.  Also see
The Perils of Floating Point@footnote{http://www.indowsway.com/floatingpoint.htm}
for a more complete account of other common surprises.

As that says near the end, «there are no easy answers.»  Still, don’t be unduly
wary of floating point!  The errors in Python float operations are inherited
from the floating-point hardware, and on most machines are on the order of no
more than 1 part in 2**53 per operation.  That’s more than adequate for most
tasks, but you do need to keep in mind that it’s not decimal arithmetic and
that every float operation can suffer a new rounding error.

A pesar de que existen casos patológicos, para la mayoría de usos casuales de la aritmética de punto flotante al final verás el resultado que esperás si simplemente redondeás lo que mostrás de tus resultados finales al número de dígitos decimales que esperás.  @ref{237,,str()} es normalmente suficiente, y para un control más fino mirá los parámetros del método de formateo @ref{6c2,,str.format()} en @ref{1c7f,,Formato de cadena de caracteres personalizado}.

Para los casos de uso que necesitan una representación decimal exacta, probá el módulo @ref{37,,decimal}, que implementa aritmética decimal útil para aplicaciones de contabilidad y de alta precisión.

El módulo @ref{5d,,fractions} soporta otra forma de aritmética exacta, ya que implementa aritmética basada en números racionales (por lo que números como 1/3 pueden ser representados exactamente).

Si eres un usuario intensivo de operaciones de punto flotante, deberías echar un vistazo al paquete NumPy y a muchos otros paquetes para operaciones matemáticas y estadísticas proporcionados por el proyecto SciPy. Ver <@indicateurl{https://scipy.org}>.

Python provee herramientas que pueden ayudar en esas raras ocasiones cuando realmente `querés' saber el valor exacto de un punto flotante. El método @ref{1d18,,float.as_integer_ratio()} expresa el valor del punto flotante como una fracción:

@example
>>> x = 3.14159
>>> x.as_integer_ratio()
(3537115888337719, 1125899906842624)
@end example

Ya que la fracción es exacta, se puede usar para recrear sin pérdidas el valor original:

@example
>>> x == 3537115888337719 / 1125899906842624
True
@end example

El método @ref{1d19,,float.hex()} expresa un punto flotante en hexadecimal (base 16), nuevamente retornando el valor exacto almacenado por tu computadora:

@example
>>> x.hex()
'0x1.921f9f01b866ep+1'
@end example

Esta representación hexadecimal precisa se puede usar para reconstruir el valor exacto del punto flotante:

@example
>>> x == float.fromhex('0x1.921f9f01b866ep+1')
True
@end example

Ya que la representación es exacta, es útil para portar valores a través de diferentes versiones de Python de manera confiable (independencia de plataformas) e intercambiar datos con otros lenguajes que soportan el mismo formato (como Java y C99).

Otra herramienta útil es la función @ref{515,,sum()} que ayuda a mitigar la pérdida de precisión durante la suma. Utiliza precisión extendida para pasos de redondeo intermedios a medida que se agregan valores a un total en ejecución. Esto puede marcar la diferencia en la precisión general para que los errores no se acumulen hasta el punto en que afecten el total final:

@example
>>> 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 == 1.0
False
>>> sum([0.1] * 10) == 1.0
True
@end example

The @ref{1414,,math.fsum()} goes further and tracks all of the «lost digits»
as values are added onto a running total so that the result has only a
single rounding.  This is slower than @ref{515,,sum()} but will be more
accurate in uncommon cases where large magnitude inputs mostly cancel
each other out leaving a final sum near zero:

@example
>>> arr = [-0.10430216751806065, -266310978.67179024, 143401161448607.16,
...        -143401161400469.7, 266262841.31058735, -0.003244936839808227]
>>> float(sum(map(Fraction, arr)))   # Exact summation with single rounding
8.042173697819788e-13
>>> math.fsum(arr)                   # Single rounding
8.042173697819788e-13
>>> sum(arr)                         # Multiple roundings in extended precision
8.042178034628478e-13
>>> total = 0.0
>>> for x in arr:
...     total += x                   # Multiple roundings in standard precision
...
>>> total                            # Straight addition has no correct digits!
-0.0051575902860057365
@end example

@menu
* Error de Representación:: 

@end menu

@node Error de Representación,,,Floating-Point Arithmetic Issues and Limitations
@anchor{tutorial/floatingpoint representation-error}@anchor{1d1a}@anchor{tutorial/floatingpoint tut-fp-error}@anchor{1d1b}
@subsection Error de Representación


Esta sección explica el ejemplo «0.1» en detalle, y muestra como en la mayoría de los casos vos mismo podés realizar un análisis exacto como este. Se asume un conocimiento básico de la representación de punto flotante binario.

`Error de representación' se refiere al hecho de que algunas (la mayoría) de las fracciones decimales no pueden representarse exactamente como fracciones binarias (en base 2).  Esta es la razón principal de por qué Python (o Perl, C, C++, Java, Fortran, y tantos otros) frecuentemente no mostrarán el número decimal exacto que esperás.

¿Por qué sucede esto? 1/10 no es exactamente representable como una fracción binaria. Desde al menos el año 2000, casi todas las máquinas utilizan la aritmética de punto flotante binaria IEEE 754, y casi todas las plataformas asignan los números de punto flotante de Python a valores binarios de 64 bits de precisión «doble» de IEEE 754. Los valores binarios de IEEE 754 de 64 bits contienen 53 bits de precisión, por lo que en la entrada, la computadora se esfuerza por convertir 0.1 en la fracción más cercana de la forma `J'/2**`N' donde `J' es un número entero que contiene exactamente 53 bits. Reescribiendo

@example
1 / 10 ~= J / (2**N)
@end example

…como

@example
J ~= 2**N / 10
@end example

…y recordando que `J' tiene exactamente 53 bits (es @code{>= 2**52} pero @code{< 2**53}), el mejor valor para `N' es 56:

@example
>>> 2**52 <=  2**56 // 10  < 2**53
True
@end example

O sea, 56 es el único valor para `N' que deja `J' con exactamente 53 bits. El mejor valor posible para `J' es entonces el cociente redondeado:

@example
>>> q, r = divmod(2**56, 10)
>>> r
6
@end example

Ya que el resto es más que la mitad de 10, la mejor aproximación se obtiene redondeándolo:

@example
>>> q+1
7205759403792794
@end example

Por lo tanto la mejor aproximación a 1/10 en doble precisión IEEE 754 es:

@example
7205759403792794 / 2 ** 56
@end example

El dividir tanto el numerador como el denominador reduce la fracción a:

@example
3602879701896397 / 2 ** 55
@end example

Notá que como lo redondeamos, esto es un poquito más grande que 1/10; si no lo hubiéramos redondeado, el cociente hubiese sido un poquito menor que 1/10.  ¡Pero no hay caso en que sea `exactamente' 1/10!

Entonces la computadora nunca «ve» 1/10: lo que ve es la fracción exacta de arriba, la mejor aproximación al flotante doble IEEE 754 que puede obtener:

@example
>>> 0.1 * 2 ** 55
3602879701896397.0
@end example

Si multiplicamos esa fracción por 10**55, podemos ver el valor hasta los 55 dígitos decimales:

@example
>>> 3602879701896397 * 10 ** 55 // 2 ** 55
1000000000000000055511151231257827021181583404541015625
@end example

lo que significa que el valor exacto almacenado en la computadora es igual al valor decimal 0.1000000000000000055511151231257827021181583404541015625. En lugar de mostrar el valor decimal completo, muchos lenguajes (incluyendo versiones anteriores de Python), redondean el resultado a 17 dígitos significativos:

@example
>>> format(0.1, '.17f')
'0.10000000000000001'
@end example

Los módulos @ref{5d,,fractions} y @ref{37,,decimal} hacen fácil estos cálculos:

@example
>>> from decimal import Decimal
>>> from fractions import Fraction

>>> Fraction.from_float(0.1)
Fraction(3602879701896397, 36028797018963968)

>>> (0.1).as_integer_ratio()
(3602879701896397, 36028797018963968)

>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')

>>> format(Decimal.from_float(0.1), '.17')
'0.10000000000000001'
@end example

@node Apéndice,,Floating-Point Arithmetic Issues and Limitations,El tutorial de Python
@anchor{tutorial/appendix doc}@anchor{1d1c}@anchor{tutorial/appendix appendix}@anchor{1d1d}@anchor{tutorial/appendix tut-appendix}@anchor{1d1e}
@section Apéndice


@menu
* Modo interactivo: Modo interactivo<2>. 

@end menu

@node Modo interactivo<2>,,,Apéndice
@anchor{tutorial/appendix interactive-mode}@anchor{1d1f}@anchor{tutorial/appendix tut-interac}@anchor{2db}
@subsection Modo interactivo


There are two variants of the interactive @ref{2d6,,REPL}.  The classic
basic interpreter is supported on all platforms with minimal line
control capabilities.

On Windows, or Unix-like systems with @ref{2c,,curses} support,
a new interactive shell is used by default.
This one supports color, multiline editing, history browsing, and
paste mode.  To disable color, see @ref{2d7,,Controlling color} for
details.  Function keys provide some additional functionality.
@code{F1} enters the interactive help browser @ref{b5,,pydoc}.
@code{F2} allows for browsing command-line history with neither output nor the
@ref{2d8,,>>>} and @ref{2d9,,…} prompts. @code{F3} enters «paste mode», which
makes pasting larger blocks of code easier. Press @code{F3} to return to
the regular prompt.

When using the new interactive shell, exit the shell by typing @code{exit}
or @code{quit}. Adding call parentheses after those commands is not
required.

If the new interactive shell is not desired, it can be disabled via
the 
@geindex PYTHON_BASIC_REPL
@geindex variables de entorno; PYTHON_BASIC_REPL
@ref{2da,,PYTHON_BASIC_REPL} environment variable.

@menu
* Manejo de errores:: 
* Programas ejecutables de Python:: 
* El archivo de inicio interactivo:: 
* Los módulos de customización:: 

@end menu

@node Manejo de errores,Programas ejecutables de Python,,Modo interactivo<2>
@anchor{tutorial/appendix error-handling}@anchor{1d20}@anchor{tutorial/appendix tut-error}@anchor{1d21}
@subsubsection Manejo de errores


When an error occurs, the interpreter prints an error message and a stack trace.
In interactive mode, it then returns to the primary prompt; when input came from
a file, it exits with a nonzero exit status after printing the stack trace.
(Exceptions handled by an @ref{2f6,,except} clause in a @ref{789,,try} statement
are not errors in this context.)  Some errors are unconditionally fatal and
cause an exit with a nonzero exit status; this applies to internal inconsistencies and
some cases of running out of memory.  All error messages are written to the
standard error stream; normal output from executed commands is written to
standard output.

Al ingresar el carácter de interrupción (por lo general @code{Control-C} o @code{Supr}) en el prompt primario o secundario, se cancela la entrada y retorna al prompt primario.  @footnote{
Un problema con el paquete GNU Readline puede prevenir esto.
} Tipear una interrupción mientras un comando se están ejecutando lanza la excepción @ref{a63,,KeyboardInterrupt}, que puede ser manejada con una sentencia @ref{789,,try}.

@node Programas ejecutables de Python,El archivo de inicio interactivo,Manejo de errores,Modo interactivo<2>
@anchor{tutorial/appendix executable-python-scripts}@anchor{1d22}@anchor{tutorial/appendix tut-scripts}@anchor{1bf7}
@subsubsection Programas ejecutables de Python


En los sistemas Unix y tipo BSD, los programas Python pueden convertirse directamente en ejecutables, como programas del intérprete de comandos, poniendo la linea:

@example
#!/usr/bin/env python3
@end example

…al principio del script y dándole al archivo permisos de ejecución (asumiendo que el intérprete están en la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} del usuario).  @code{#!} deben ser los primeros dos caracteres del archivo.  En algunas plataformas, la primera línea debe terminar al estilo Unix (@code{'\n'}), no como en Windows (@code{'\r\n'}).  Notá que el carácter numeral @code{'#'} se usa en Python para comenzar un comentario.

Se le puede dar permisos de ejecución al script usando el comando @code{chmod}.

@example
$ chmod +x myscript.py
@end example

En sistemas Windows, no existe la noción de «modo ejecutable».  El instalador de Python asocia automáticamente la extensión @code{.py} con @code{python.exe} para que al hacerle doble clic a un archivo Python se corra el script.  La extensión también puede ser @code{.pyw}, en este caso se omite la ventana con la consola que normalmente aparece.

@node El archivo de inicio interactivo,Los módulos de customización,Programas ejecutables de Python,Modo interactivo<2>
@anchor{tutorial/appendix the-interactive-startup-file}@anchor{1d23}@anchor{tutorial/appendix tut-startup}@anchor{1d24}
@subsubsection El archivo de inicio interactivo


Cuando usas Python en forma interactiva, suele ser útil que algunos comandos estándar se ejecuten cada vez que el intérprete se inicia.  Puedes hacer esto configurando la variable de entorno 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP} con el nombre de un archivo que contenga tus comandos de inicio.  Esto es similar al archivo @code{.profile} en los intérpretes de comandos de Unix.

Este archivo es solo leído en las sesiones interactivas del intérprete, no cuando Python lee comandos de un script ni cuando @code{/dev/tty} se explicita como una fuente de comandos (que de otro modo se comporta como una sesión interactiva).  Se ejecuta en el mismo espacio de nombres en el que los comandos interactivos se ejecutan, entonces los objetos que define o importa pueden ser usados sin cualificaciones en la sesión interactiva.  En este archivo también puedes cambiar los prompts @code{sys.ps1} y @code{sys.ps2}.

Si quieres leer un archivo de inicio adicional desde el directorio actual, puedes programarlo en el archivo de inicio global usando algo como @code{if os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read())}.  Si quieres usar el archivo de inicio en un script, tienes que hacer lo siguiente de forma explícita en el script:

@example
import os
filename = os.environ.get('PYTHONSTARTUP')
if filename and os.path.isfile(filename):
    with open(filename) as fobj:
        startup_file = fobj.read()
    exec(startup_file)
@end example

@node Los módulos de customización,,El archivo de inicio interactivo,Modo interactivo<2>
@anchor{tutorial/appendix the-customization-modules}@anchor{1d25}@anchor{tutorial/appendix tut-customize}@anchor{1d26}
@subsubsection Los módulos de customización


Python provee dos formas para customizarlo: 
@geindex sitecustomize
sitecustomize y 
@geindex usercustomize
usercustomize.  Para ver cómo funciona, necesitas primero encontrar dónde está tu directorio para tu usuario de paquetes del sistema.  Inicia Python y ejecuta el siguiente código:

@example
>>> import site
>>> site.getusersitepackages()
'/home/user/.local/lib/python3.x/site-packages'
@end example

Ahora puedes crear un archivo llamado @code{usercustomize.py} en ese directorio y poner lo que quieras en él.  Eso afectará cada ejecución de Python, a menos que se inicie con la opción @ref{13eb,,-s} para deshabilitar esta importación automática.

@geindex sitecustomize
sitecustomize funciona de la misma manera, pero normalmente lo crea el administrador de la computadora en el directorio global de paquetes del sistema, y se importa antes que 
@geindex usercustomize
usercustomize. Para más detalles, mira la documentación del módulo @ref{c7,,site}.

@subsubheading Notas al pie


@node Configuración y uso de Python,Referencia del Lenguaje Python,El tutorial de Python,Top
@anchor{using/index doc}@anchor{1d27}@anchor{using/index python-setup-and-usage}@anchor{1d28}@anchor{using/index using-index}@anchor{1d29}
@chapter Configuración y uso de Python


Esta parte de la documentación está dedicada a información general sobre la configuración del entorno Python en diferentes plataformas, la invocación del intérprete y cosas que facilitan el trabajo con Python.

@c ATTENTION: You probably should update Misc/python.man, too, if you modify
@c this file.

@menu
* Línea de comandos y entorno:: 
* Uso de Python en plataformas Unix:: 
* Configurar Python:: 
* Uso de Python en Windows:: 
* Using Python on macOS:: 
* Using Python on Android:: 
* Using Python on iOS:: 
* Editores e IDEs:: 

@end menu

@node Línea de comandos y entorno,Uso de Python en plataformas Unix,,Configuración y uso de Python
@anchor{using/cmdline doc}@anchor{1d2a}@anchor{using/cmdline command-line-and-environment}@anchor{1d2b}@anchor{using/cmdline using-on-general}@anchor{19c8}
@section Línea de comandos y entorno


El intérprete de CPython analiza la línea de comandos y el entorno en busca de varias configuraciones.

`Detalles de implementación de CPython:' Los esquemas de línea de comandos de otras implementaciones pueden diferir.  Véase @ref{1d2c,,Implementaciones alternativas} para obtener más recursos.

@menu
* Línea de comando:: 
* Variables de entorno:: 

@end menu

@node Línea de comando,Variables de entorno,,Línea de comandos y entorno
@anchor{using/cmdline command-line}@anchor{1d2d}@anchor{using/cmdline using-on-cmdline}@anchor{1083}
@subsection Línea de comando


Al invocar Python, puede especificar cualquiera de estas opciones:

@example
python [-bBdEhiIOPqRsSuvVWx?] [-c command | -m module-name | script | - ] [args]
@end example

El caso de uso más común es, por supuesto, una simple invocación de un script:

@example
python myscript.py
@end example

@menu
* Opciones de interfaz:: 
* Opciones genéricas:: 
* Opciones diversas:: 
* Controlling color:: 
* Opciones que no se deben usar:: 

@end menu

@node Opciones de interfaz,Opciones genéricas,,Línea de comando
@anchor{using/cmdline interface-options}@anchor{1d2e}@anchor{using/cmdline using-on-interface-options}@anchor{1d2f}
@subsubsection Opciones de interfaz


La interfaz del intérprete es similar a la del shell UNIX, pero proporciona algunos métodos adicionales de invocación:


@itemize *

@item 
When called with standard input connected to a tty device, it prompts for
commands and executes them until an EOF (an end-of-file character, you can
produce that with @code{Ctrl-D} on UNIX or @code{Ctrl-Z, Enter} on Windows) is read.
For more on interactive mode, see @ref{2db,,Modo interactivo}.

@item 
Cuando se llama con un argumento de nombre de archivo o con un archivo como entrada estándar, lee y ejecuta un script de ese archivo.

@item 
Cuando se llama con un argumento de nombre de directorio, lee y ejecuta un script con el nombre adecuado desde ese directorio.

@item 
Cuando se llama con @code{-c comando}, ejecuta las instrucciones de Python dadas como `command'.  Aquí `comando' puede contener varias instrucciones separadas por nuevas líneas. ¡El espacio en blanco principal es significativo en las instrucciones de Python!

@item 
Cuando se llama con @code{-m module-name}, el módulo dado se encuentra en la ruta del módulo Python y se ejecuta como un script.
@end itemize

En el modo no interactivo, toda la entrada se analiza antes de ejecutarse.

Una opción de interfaz termina la lista de opciones consumidas por el intérprete, todos los argumentos consecutivos terminarán en @ref{12d2,,sys.argv} – tenga en cuenta que el primer elemento, subíndice cero (@code{sys.argv[0]}), es una cadena que refleja el origen del programa.

@geindex opción de línea de comando; -c
@anchor{using/cmdline cmdoption-c}@anchor{681}
@deffn {Option} @w{-}c <command>

Ejecute el código de Python en `comando'.  `comando' puede ser una o más sentencias separadas por nuevas líneas, con espacio en blanco inicial significativo como en el código normal del módulo.

Si se proporciona esta opción, el primer elemento de @ref{12d2,,sys.argv} será @code{"-c"} y el directorio actual se agregará al inicio de @ref{27e,,sys.path} (permitiendo que los módulos de ese directorio se importen como módulos de nivel superior).

Lanza un @ref{18c3,,auditing event} @code{cpython.run_command} con el argumento @code{command}.
@end deffn

@geindex opción de línea de comando; -m
@anchor{using/cmdline cmdoption-m}@anchor{187}
@deffn {Option} @w{-}m <module@w{-}name>

Busque @ref{27e,,sys.path} para el módulo con nombre y ejecute su contenido como el módulo @ref{1,,__main__}.

Dado que el argumento es un nombre `módulo', no debe dar una extensión de archivo (@code{.py}).  El nombre del módulo debe ser un nombre de módulo Python absoluto válido, pero es posible que la implementación no siempre lo aplique (por ejemplo, puede permitirle usar un nombre que incluya un guión).

También se permiten los nombres de paquetes (incluidos los paquetes de espacio de nombres). Cuando se proporciona un nombre de paquete en lugar de un módulo normal, el intérprete ejecutará @code{<pkg>.__main__} como módulo principal. Este comportamiento es deliberadamente similar al manejo de directorios y archivos zip que se pasan al intérprete como argumento del script.

@cartouche
@quotation Nota 
Esta opción no se puede utilizar con módulos integrados y módulos de extensión escritos en C, ya que no tienen archivos de módulo Python. Sin embargo, todavía se puede utilizar para módulos precompilados, incluso si el archivo de origen original no está disponible.
@end quotation
@end cartouche

Si se da esta opción, el primer elemento de @ref{12d2,,sys.argv} será la ruta de acceso completa al archivo de módulo (mientras se encuentra el archivo de módulo, el primer elemento se establecerá en @code{"-m"}). Al igual que con la opción @ref{681,,-c}, el directorio actual se agregará al inicio de @ref{27e,,sys.path}.

@ref{9f1,,-I} option can  be used to run the script in isolated mode where
@ref{27e,,sys.path} contains neither the current directory nor the user’s
site-packages directory. All @code{PYTHON*} environment variables are
ignored, too.

Muchos módulos de biblioteca estándar contienen código que se invoca en su ejecución como script.  Un ejemplo es el módulo @ref{ef,,timeit}:

@example
python -m timeit -s "setup here" "benchmarked code here"
python -m timeit -h # for details
@end example

Retorna un @ref{18c3,,auditing event} @code{cpython.run_module} con el argumento @code{nombre-módulo}.


@subsubheading Ver también



@table @asis

@item @ref{1813,,runpy.run_module()}

Funcionalidad equivalente directamente disponible para el código Python
@end table

@geindex Python Enhancement Proposals; PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} – Ejecución de módulos como scripts



Distinto en la versión 3.1: Proporcione el nombre del paquete para ejecutar un submódulo @code{__main__}.



Distinto en la versión 3.4: paquetes de espacio de nombres también son compatibles

@end deffn

@anchor{using/cmdline cmdarg-dash}@anchor{1d30}
@deffn {Describe} @w{-}

Leer comandos de entrada estándar (@ref{5df,,sys.stdin}).  Si la entrada estándar es un terminal, @ref{151b,,-i} está implícita.

Si se da esta opción, el primer elemento de @ref{12d2,,sys.argv} será @code{"-"} y el directorio actual se agregará al inicio de @ref{27e,,sys.path}.

Lanza un evento @ref{18c3,,auditing event} @code{cpython.run_stdin} sin argumentos.
@end deffn

@anchor{using/cmdline cmdarg-script}@anchor{1d31}
@deffn {Describe} <script>

Ejecute el código Python contenido en `script', que debe ser una ruta de acceso del sistema de archivos (absoluta o relativa) que haga referencia a un archivo Python, un directorio que contenga un archivo @code{__main__.py} o un archivo zip que contenga un archivo @code{__main__.py}.

Si se proporciona esta opción, el primer elemento de @ref{12d2,,sys.argv} será el nombre del script como se indica en la línea de comandos.

Si el nombre del script hace referencia directamente a un archivo Python, el directorio que contiene ese archivo se agrega al inicio de @ref{27e,,sys.path}, y el archivo se ejecuta como el módulo @ref{1,,__main__}.

Si el nombre del script hace referencia a un directorio o zipfile, el nombre del script se agrega al inicio de @ref{27e,,sys.path} y el archivo @code{__main__.py} en esa ubicación se ejecuta como el módulo @ref{1,,__main__}.

@ref{9f1,,-I} option can  be used to run the script in isolated mode where
@ref{27e,,sys.path} contains neither the script’s directory nor the user’s
site-packages directory. All @code{PYTHON*} environment variables are
ignored, too.

Lanza un  @ref{18c3,,auditing event} @code{cpython.run_file} con el argumento @code{filename}.


@subsubheading Ver también



@table @asis

@item @ref{2ec,,runpy.run_path()}

Funcionalidad equivalente directamente disponible para el código Python
@end table

@end deffn

Si no se da ninguna opción de interfaz, @ref{151b,,-i} está implícita, @code{sys.argv[0]} es una cadena vacía (@code{"}) y el directorio actual se agregará al inicio de @ref{27e,,sys.path}.  Además, la finalización de tabulación y la edición del historial se habilitan automáticamente, si están disponibles en su plataforma (consulte @ref{1048,,Configuración de Readline}).


@subsubheading Ver también


@ref{1bec,,Invocar el intérprete}



Distinto en la versión 3.4: Habilitación automática de la finalización de pestañas y edición del historial.


@node Opciones genéricas,Opciones diversas,Opciones de interfaz,Línea de comando
@anchor{using/cmdline generic-options}@anchor{1d32}@anchor{using/cmdline using-on-generic-options}@anchor{1d33}
@subsubsection Opciones genéricas


@geindex opción de línea de comando; -?
@geindex opción de línea de comando; -h
@geindex opción de línea de comando; --help
@anchor{using/cmdline cmdoption-0}@anchor{1467}
@deffn {Option} @w{-}?
@anchor{using/cmdline cmdoption-h}@anchor{1d34}
@deffnx {Option} @w{-}h
@anchor{using/cmdline cmdoption-help}@anchor{690}
@deffnx {Option} @w{-}@w{-}help

Imprime una breve descripción de todas las opciones de la línea de comandos.
@end deffn

@geindex opción de línea de comando; --help-env
@anchor{using/cmdline cmdoption-help-env}@anchor{692}
@deffn {Option} @w{-}@w{-}help@w{-}env

Imprima una breve descripción de las variables de entorno específicas de Python y salga.


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; --help-xoptions
@anchor{using/cmdline cmdoption-help-xoptions}@anchor{693}
@deffn {Option} @w{-}@w{-}help@w{-}xoptions

Imprima una descripción de las opciones @ref{2e2,,-X} específicas de la implementación y salga.


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; --help-all
@anchor{using/cmdline cmdoption-help-all}@anchor{694}
@deffn {Option} @w{-}@w{-}help@w{-}all

Imprima información completa de uso y salga.


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; -V
@geindex opción de línea de comando; --version
@anchor{using/cmdline cmdoption-V}@anchor{2e3}
@deffn {Option} @w{-}V
@anchor{using/cmdline cmdoption-version}@anchor{da2}
@deffnx {Option} @w{-}@w{-}version

Imprima el número de versión de Python y salga.  Ejemplo de salida podría ser:

@example
Python 3.8.0b2+
@end example

Cuando se le dé dos veces, imprima más información sobre la compilación, como:

@example
Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
[GCC 6.2.0 20161005]
@end example


Added in version 3.6: La opción @code{-VV}.

@end deffn

@node Opciones diversas,Controlling color,Opciones genéricas,Línea de comando
@anchor{using/cmdline miscellaneous-options}@anchor{1d35}@anchor{using/cmdline using-on-misc-options}@anchor{1084}
@subsubsection Opciones diversas


@geindex opción de línea de comando; -b
@anchor{using/cmdline cmdoption-b}@anchor{683}
@deffn {Option} @w{-}b

Issue a warning when converting @ref{325,,bytes} or @ref{5e0,,bytearray} to
@ref{237,,str} without specifying encoding or comparing @code{bytes} or
@code{bytearray} with @code{str} or @code{bytes} with @ref{1f0,,int}.
Issue an error when the option is given twice (@code{-bb}).


Distinto en la versión 3.5: Affects also comparisons of @ref{325,,bytes} with @ref{1f0,,int}.

@end deffn

@geindex opción de línea de comando; -B
@anchor{using/cmdline cmdoption-B}@anchor{140d}
@deffn {Option} @w{-}B

Si se da, Python no intentará escribir archivos @code{.pyc} en la importación de módulos de origen.  Véase también 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE}.
@end deffn

@geindex opción de línea de comando; --check-hash-based-pycs
@anchor{using/cmdline cmdoption-check-hash-based-pycs}@anchor{1d36}
@deffn {Option} @w{-}@w{-}check@w{-}hash@w{-}based@w{-}pycs default|always|never

Controle el comportamiento de validación de los archivos @code{.pyc} basados en hash. Véase @ref{68c,,Invalidación del código de bytes en caché}. Cuando se establece en @code{default}, los archivos de caché de código de bytes basados en hash marcados y desmarcados se validan según su semántica predeterminada. Cuando se establece en @code{always}, todos los archivos basados en hash @code{.pyc}, ya estén marcados o desmarcados, se validan con su archivo de origen correspondiente. Cuando se establece en @code{never}, los archivos basados en hash @code{.pyc} no se validan con sus archivos de origen correspondientes.

Esta opción no afecta a la semántica de los archivos @code{.pyc} basados en la marca de tiempo.
@end deffn

@geindex opción de línea de comando; -d
@anchor{using/cmdline cmdoption-d}@anchor{1d37}
@deffn {Option} @w{-}d

Activa la salida de depuración (solo para expertos, dependiendo de las opciones de compilación).  Véase también la variable de ambiente 
@geindex PYTHONDEBUG
@geindex variables de entorno; PYTHONDEBUG
@ref{1d38,,PYTHONDEBUG}.

Esta opción necesita una @ref{357,,compilación de depuración de Python}, de lo contrario será ignorado.
@end deffn

@geindex opción de línea de comando; -E
@anchor{using/cmdline cmdoption-E}@anchor{9f0}
@deffn {Option} @w{-}E

Ignore all @code{PYTHON*} environment variables, e.g.
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} and 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}, that might be set.

Véase también las opciones @ref{645,,-P} e @ref{9f1,,-I} (aisladas).
@end deffn

@geindex opción de línea de comando; -i
@anchor{using/cmdline cmdoption-i}@anchor{151b}
@deffn {Option} @w{-}i

Enter interactive mode after execution.

Using the @ref{151b,,-i} option will enter interactive mode in any of the following circumstances:


@itemize *

@item 
When a script is passed as first argument

@item 
When the @ref{681,,-c} option is used

@item 
When the @ref{187,,-m} option is used
@end itemize

Interactive mode will start even when @ref{5df,,sys.stdin} does not appear to be a terminal. The
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP} file is not read.

Esto puede ser útil para inspeccionar variables globales o un seguimiento de pila cuando un script lanza una excepción.  Véase también 
@geindex PYTHONINSPECT
@geindex variables de entorno; PYTHONINSPECT
@ref{151a,,PYTHONINSPECT}.
@end deffn

@geindex opción de línea de comando; -I
@anchor{using/cmdline cmdoption-I}@anchor{9f1}
@deffn {Option} @w{-}I

Ejecute Python en modo aislado. Esto también implica las opciones @ref{9f0,,-E}, @ref{645,,-P} y @ref{13eb,,-s}.

In isolated mode @ref{27e,,sys.path} contains neither the script’s directory nor
the user’s site-packages directory. All @code{PYTHON*} environment
variables are ignored, too. Further restrictions may be imposed to prevent
the user from injecting malicious code.


Added in version 3.4.

@end deffn

@geindex opción de línea de comando; -O
@anchor{using/cmdline cmdoption-O}@anchor{14f}
@deffn {Option} @w{-}O

Quite las instrucciones assert y cualquier código condicionado al valor de @ref{871,,__debug__}.  Aumente el nombre de archivo para los archivos compilados (@ref{2f2,,bytecode}) agregando @code{.opt-1} antes de la extensión @code{.pyc} (consulte 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}).  Véase también 
@geindex PYTHONOPTIMIZE
@geindex variables de entorno; PYTHONOPTIMIZE
@ref{1d39,,PYTHONOPTIMIZE}.


Distinto en la versión 3.5: Modifique los nombres de archivo @code{.pyc} según 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}.

@end deffn

@geindex opción de línea de comando; -OO
@anchor{using/cmdline cmdoption-OO}@anchor{e3b}
@deffn {Option} @w{-}OO

Haga @ref{14f,,-O} y también deseche las docstrings.  Aumente el nombre de archivo para los archivos compilados (@ref{2f2,,bytecode}) agregando @code{.opt-2} antes de la extensión @code{.pyc} (consulte 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}).


Distinto en la versión 3.5: Modifique los nombres de archivo @code{.pyc} según 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}.

@end deffn

@geindex opción de línea de comando; -P
@anchor{using/cmdline cmdoption-P}@anchor{645}
@deffn {Option} @w{-}P

No anteponga una ruta potencialmente insegura a @ref{27e,,sys.path}:


@itemize *

@item 
@code{python -m module} command line: No anteponga el directorio de trabajo actual.

@item 
@code{python script.py} command line: No anteponga el directorio del script. Si es un enlace simbólico, resuelva los enlaces simbólicos.

@item 
@code{python -c code} y @code{python} (REPL) command lines: No anteponga una cadena vacía, lo que significa el directorio de trabajo actual.
@end itemize

Consulte también la variable de entorno 
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH} y las opciones @ref{9f0,,-E} y @ref{9f1,,-I} (aisladas).


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; -q
@anchor{using/cmdline cmdoption-q}@anchor{1d3a}
@deffn {Option} @w{-}q

No muestres los mensajes de copyright y versión incluso en modo interactivo.


Added in version 3.2.

@end deffn

@geindex opción de línea de comando; -R
@anchor{using/cmdline cmdoption-R}@anchor{1a9e}
@deffn {Option} @w{-}R

Active la aleatorización de hash. Esta opción solo tiene efecto si la variable de entorno 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} está establecida en @code{0}, ya que la aleatorización de hash está habilitada de forma predeterminada.

On previous versions of Python, this option turns on hash randomization,
so that the @ref{b86,,__hash__()} values of str and bytes objects
are «salted» with an unpredictable random value.  Although they remain
constant within an individual Python process, they are not predictable
between repeated invocations of Python.

Hash randomization is intended to provide protection against a
denial-of-service caused by carefully chosen inputs that exploit the worst
case performance of a dict construction, `O'(`n'@w{^2}) complexity.  See
@indicateurl{http://ocert.org/advisories/ocert-2011-003.html} for details.

@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} le permite establecer un valor fijo para el secreto de inicialización hash.


Added in version 3.2.3.



Distinto en la versión 3.7: La opción ya no se omite.

@end deffn

@geindex opción de línea de comando; -s
@anchor{using/cmdline cmdoption-s}@anchor{13eb}
@deffn {Option} @w{-}s

No agregue el @ref{1d3b,,user site-packages directory} a @ref{27e,,sys.path}.

See also 
@geindex PYTHONNOUSERSITE
@geindex variables de entorno; PYTHONNOUSERSITE
@ref{13ec,,PYTHONNOUSERSITE}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Directorio de paquetes de sitio por usuario

@end deffn

@geindex opción de línea de comando; -S
@anchor{using/cmdline cmdoption-S}@anchor{1217}
@deffn {Option} @w{-}S

Deshabilite la importación del módulo @ref{c7,,site} y las manipulaciones dependientes del sitio de @ref{27e,,sys.path} que conlleva.  También deshabilite estas manipulaciones si @ref{c7,,site} se importa explícitamente más tarde (llame a @ref{1d3c,,site.main()} si desea que se activen).
@end deffn

@geindex opción de línea de comando; -u
@anchor{using/cmdline cmdoption-u}@anchor{19ad}
@deffn {Option} @w{-}u

Forzar que las corrientes stdout y stderr no estén en búfer.  Esta opción no tiene ningún efecto en la secuencia stdin.

Véase también 
@geindex PYTHONUNBUFFERED
@geindex variables de entorno; PYTHONUNBUFFERED
@ref{19ae,,PYTHONUNBUFFERED}.


Distinto en la versión 3.7: La capa de texto de las secuencias stdout y stderr ahora no está en búfer.

@end deffn

@geindex opción de línea de comando; -v
@anchor{using/cmdline cmdoption-v}@anchor{1464}
@deffn {Option} @w{-}v

Imprime un mensaje cada vez que se inicialice un módulo, mostrando el lugar (nombre de archivo o módulo integrado) desde el que se carga. Cuando se le pasa dos veces (@code{-vv}), imprime un mensaje para cada archivo que se comprueba al buscar un módulo. También proporciona información sobre la limpieza del módulo en la salida.


Distinto en la versión 3.10: El módulo @ref{c7,,site} informa las rutas específicas del sitio y los archivos @code{.pth} que se están procesando.


Véase también 
@geindex PYTHONVERBOSE
@geindex variables de entorno; PYTHONVERBOSE
@ref{1d3d,,PYTHONVERBOSE}.
@end deffn

@geindex opción de línea de comando; -W
@anchor{using/cmdline using-on-warnings}@anchor{1d3e}@anchor{using/cmdline cmdoption-W}@anchor{95e}
@deffn {Option} @w{-}W arg

Control de advertencia.  La maquinaria de advertencia de Python por defecto imprime mensajes de advertencia en @ref{9cc,,sys.stderr}.

La configuración más sencilla aplica una acción determinada incondicionalmente a todas las advertencias emitidas por un proceso (incluso aquellas que de otro modo se ignoran de forma predeterminada):

@example
-Wdefault  # Warn once per call location
-Werror    # Convert to exceptions
-Walways   # Warn every time
-Wall      # Same as -Walways
-Wmodule   # Warn once per calling module
-Wonce     # Warn once per Python process
-Wignore   # Never warn
@end example

Los nombres de acción se pueden abreviar como se desee y el intérprete los resolverá con el nombre de acción adecuado. Por ejemplo, @code{-Wi} es lo mismo que @code{-Wignore}.

La forma completa del argumento es:

@example
action:message:category:module:lineno
@end example

Los campos vacíos cuadran con todos los valores; los campos vacíos finales pueden omitirse. Por ejemplo, @code{-W ignore::DeprecationWarning} ignora todas las advertencias de DeprecationWarning.

El campo `action' es como se explicó anteriormente, pero solo se aplica a las advertencias que coinciden con los campos restantes.

El campo `message' debe coincidir con el mensaje de advertencia completo; esta coincidencia no distingue entre mayúsculas y minúsculas.

El campo `category' coincide con la categoría de advertencia (por ej. @code{DeprecationWarning}). Debe ser un nombre de clase; la coincidencia prueba si la categoría de advertencia real del mensaje es una subclase de la categoría de advertencia especificada.

El campo `module' coincide con el nombre de dominio completo del módulo; esta coincidencia distingue entre mayúsculas y minúsculas.

El campo `lineno' coincide con el número de línea, donde cero corresponde a todos los números de línea y, por lo tanto, es equivalente a número de línea omitido.

Se pueden dar varias opciones @ref{95e,,-W}; cuando una advertencia coincide con más de una opción, se realiza la acción para la última opción de coincidencia. Las opciones invalidas @ref{95e,,-W} son ignoradas (aunque se imprime un mensaje de advertencia sobre opciones no válidas cuando se emite la primera advertencia).

Las advertencias también se pueden controlar utilizando la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} y desde un programa Python utilizando el módulo @ref{112,,warnings}. Por ejemplo, la función @ref{14e5,,warnings.filterwarnings()} puede ser usarse con una expresión regular en el mensaje de advertencia.

Consulte @ref{960,,El filtro de advertencias} y @ref{1d3f,,Descripción de los filtros de advertencia} para obtener más detalles.
@end deffn

@geindex opción de línea de comando; -x
@anchor{using/cmdline cmdoption-x}@anchor{1d40}
@deffn {Option} @w{-}x

Omita la primera línea de la fuente, permitiendo el uso de formas que no sean de Unix de @code{#!cmd}.  Esto está destinado a un hackeo específico de DOS solamente.
@end deffn

@geindex opción de línea de comando; -X
@anchor{using/cmdline cmdoption-X}@anchor{2e2}
@deffn {Option} @w{-}X

Reservado para varias opciones específicas de la implementación.  CPython define actualmente los siguientes valores posibles:


@itemize *

@item 
@code{-X faulthandler} para habilitar @ref{58,,faulthandler}. Véase 
@geindex PYTHONFAULTHANDLER
@geindex variables de entorno; PYTHONFAULTHANDLER
@ref{10fc,,PYTHONFAULTHANDLER} para obtener más información.


Added in version 3.3.


@item 
@code{-X showrefcount} para generar el recuento total de referencias y el número de bloques de memoria utilizados cuando finalice el programa o después de cada instrucción en el intérprete interactivo. Esto sólo funciona en @ref{357,,compilaciones de depuración}.


Added in version 3.4.


@item 
@code{-X tracemalloc} para iniciar el seguimiento de las asignaciones de memoria de Python mediante el módulo @ref{ff,,tracemalloc}. De forma predeterminada, solo el marco más reciente se almacena en un seguimiento de un seguimiento. Utilice @code{-X tracemalloc=NFRAME} para iniciar el seguimiento con un límite de rastreo de marcos `NFRAME'. Consulte el @ref{1d41,,tracemalloc.start()} y 
@geindex PYTHONTRACEMALLOC
@geindex variables de entorno; PYTHONTRACEMALLOC
@ref{1d42,,PYTHONTRACEMALLOC} para obtener más información.


Added in version 3.4.


@item 
@code{-X int_max_str_digits} configura la @ref{695,,limitación de longitud de conversión de cadena de tipo entero}. Véase también 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS}.


Added in version 3.11.


@item 
@code{-X importtime} para mostrar cuánto tiempo tarda cada importación. Muestra el nombre del módulo, el tiempo acumulado (incluidas las importaciones anidadas) y el tiempo de autoestima (excluyendo las importaciones anidadas).  Tenga en cuenta que su salida puede romperse en aplicaciones multiproceso.  El uso típico es @code{python3 -X importtime -c 'import asyncio'}.  Véase también 
@geindex PYTHONPROFILEIMPORTTIME
@geindex variables de entorno; PYTHONPROFILEIMPORTTIME
@ref{b80,,PYTHONPROFILEIMPORTTIME}.


Added in version 3.7.


@item 
@code{-X dev}: enable @ref{356,,Python Development Mode}, introducing
additional runtime checks that are too expensive to be enabled by
default.  See also 
@geindex PYTHONDEVMODE
@geindex variables de entorno; PYTHONDEVMODE
@ref{b78,,PYTHONDEVMODE}.


Added in version 3.7.


@item 
@code{-X utf8} habilita el @ref{6f7,,modo Python UTF-8}. @code{-X utf8=0} desactiva explícitamente el @ref{6f7,,modo Python UTF-8} (incluso cuando al contrario se activaría automáticamente). Véase 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8}.


Added in version 3.7.


@item 
@code{-X pycache_prefix=PATH} permite escribir archivos @code{.pyc} en un árbol paralelo enraizado en el directorio dado en lugar de en el árbol de código. Véase también 
@geindex PYTHONPYCACHEPREFIX
@geindex variables de entorno; PYTHONPYCACHEPREFIX
@ref{a35,,PYTHONPYCACHEPREFIX}.


Added in version 3.8.


@item 
@code{-X warn_default_encoding} emite un @ref{1d43,,EncodingWarning} cuando se usa la codificación predeterminada específica de la configuración regional para abrir archivos. Vea también 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variables de entorno; PYTHONWARNDEFAULTENCODING
@ref{855,,PYTHONWARNDEFAULTENCODING}.


Added in version 3.10.


@item 
@code{-X no_debug_ranges} deshabilita la inclusión de tablas que asignan información de ubicación adicional (línea final, desplazamiento de columna inicial y desplazamiento de columna final) a cada instrucción en los objetos de código. Esto es útil cuando se desean objetos de código más pequeños y archivos pyc, además de suprimir los indicadores de ubicación visuales adicionales cuando el intérprete muestra rastreos. Véase también 
@geindex PYTHONNODEBUGRANGES
@geindex variables de entorno; PYTHONNODEBUGRANGES
@ref{657,,PYTHONNODEBUGRANGES}.


Added in version 3.11.


@item 
@code{-X frozen_modules} determines whether or not frozen modules are
ignored by the import machinery.  A value of @code{on} means they get
imported and @code{off} means they are ignored.  The default is @code{on}
if this is an installed Python (the normal case).  If it’s under
development (running from the source tree) then the default is @code{off}.
Note that the @code{importlib_bootstrap} and
@code{importlib_bootstrap_external} frozen modules are always used, even
if this flag is set to @code{off}. See also 
@geindex PYTHON_FROZEN_MODULES
@geindex variables de entorno; PYTHON_FROZEN_MODULES
@ref{2f7,,PYTHON_FROZEN_MODULES}.


Added in version 3.11.


@item 
@code{-X perf} habilita el soporte para el perfilador @code{perf} de Linux. Cuando se proporciona esta opción, el perfilador @code{perf} podrá informar llamadas de Python. Esta opción sólo está disponible en algunas plataformas y no hará nada si no es compatible con el sistema actual. El valor predeterminado es «off». Consulte también 
@geindex PYTHONPERFSUPPORT
@geindex variables de entorno; PYTHONPERFSUPPORT
@ref{519,,PYTHONPERFSUPPORT} y @ref{2f8,,Soporte de Python para el perfilador perf de Linux}.


Added in version 3.12.


@item 
@code{-X perf_jit} enables support for the Linux @code{perf} profiler with DWARF
support. When this option is provided, the @code{perf} profiler will be able
to report Python calls using DWARF information. This option is only available on
some platforms and will do nothing if is not supported on the current
system. The default value is «off». See also 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variables de entorno; PYTHON_PERF_JIT_SUPPORT
@ref{2f9,,PYTHON_PERF_JIT_SUPPORT}
and @ref{2f8,,Soporte de Python para el perfilador perf de Linux}.


Added in version 3.13.


@item 
@code{-X cpu_count=@var{n}} overrides @ref{328,,os.cpu_count()},
@ref{327,,os.process_cpu_count()}, and @ref{fee,,multiprocessing.cpu_count()}.
`n' must be greater than or equal to 1.
This option may be useful for users who need to limit CPU resources of a
container system. See also 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT}.
If `n' is @code{default}, nothing is overridden.


Added in version 3.13.


@item 
@code{-X presite=@var{package.module}} specifies a module that should be
imported before the @ref{c7,,site} module is executed and before the
@ref{1,,__main__} module exists.  Therefore, the imported module isn’t
@ref{1,,__main__}. This can be used to execute code early during Python
initialization. Python needs to be @ref{357,,built in debug mode}
for this option to exist.  See also 
@geindex PYTHON_PRESITE
@geindex variables de entorno; PYTHON_PRESITE
@ref{1d44,,PYTHON_PRESITE}.


Added in version 3.13.


@item 
@code{-X gil=@var{0,1}} forces the GIL to be disabled or enabled,
respectively. Setting to @code{0} is only available in builds configured with
@ref{2e0,,--disable-gil}. See also 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL} and
@ref{2ac,,Free-threaded CPython}.


Added in version 3.13.

@end itemize

También permite pasar valores arbitrarios y recuperarlos a través del diccionario @ref{1d45,,sys._xoptions}.


Added in version 3.2.



Distinto en la versión 3.9: Removed the @code{-X showalloccount} option.



Distinto en la versión 3.10: Removed the @code{-X oldparser} option.

@end deffn

@node Controlling color,Opciones que no se deben usar,Opciones diversas,Línea de comando
@anchor{using/cmdline controlling-color}@anchor{1d46}@anchor{using/cmdline using-on-controlling-color}@anchor{2d7}
@subsubsection Controlling color


The Python interpreter is configured by default to use colors to highlight
output in certain situations such as when displaying tracebacks. This
behavior can be controlled by setting different environment variables.

Setting the environment variable @code{TERM} to @code{dumb} will disable color.

If the FORCE_COLOR@footnote{https://force-color.org/} environment variable is set, then color will be
enabled regardless of the value of TERM. This is useful on CI systems which
aren’t terminals but can still display ANSI escape sequences.

If the NO_COLOR@footnote{https://no-color.org/} environment variable is set, Python will disable all color
in the output. This takes precedence over @code{FORCE_COLOR}.

All these environment variables are used also by other tools to control color
output. To control the color output only in the Python interpreter, the
@geindex PYTHON_COLORS
@geindex variables de entorno; PYTHON_COLORS
@ref{2b7,,PYTHON_COLORS} environment variable can be used. This variable takes
precedence over @code{NO_COLOR}, which in turn takes precedence over
@code{FORCE_COLOR}.

@c Apparently this how you hack together a formatted link:

@node Opciones que no se deben usar,,Controlling color,Línea de comando
@anchor{using/cmdline no-color}@anchor{1d47}@anchor{using/cmdline options-you-shouldn-t-use}@anchor{1d48}
@subsubsection Opciones que no se deben usar


@geindex opción de línea de comando; -J
@anchor{using/cmdline cmdoption-J}@anchor{140c}
@deffn {Option} @w{-}J

Reservado para su uso por Jython@footnote{https://www.jython.org/}.
@end deffn

@node Variables de entorno,,Línea de comando,Línea de comandos y entorno
@anchor{using/cmdline environment-variables}@anchor{1d49}@anchor{using/cmdline using-on-envvars}@anchor{691}
@subsection Variables de entorno


Estas variables de entorno influyen en el comportamiento de Python, se procesan antes de que los modificadores de línea de comandos distintos de -E o -I.  Es habitual que los modificadores de línea de comandos anulen variables de entorno donde hay un conflicto.

@geindex variables de entorno; PYTHONHOME
@anchor{using/cmdline envvar-PYTHONHOME}@anchor{287}
@deffn {Variables De Entorno} PYTHONHOME

Cambie la ubicación de las bibliotecas estándar de Python.  De forma predeterminada, las bibliotecas se buscan en @code{`prefix'/lib/python`version'} y @code{`exec_prefix'/lib/python`version'}, donde @code{`prefix'} y @code{`exec_prefix'} son directorios dependientes de la instalación, ambos predeterminados @code{/usr/local}.

Cuando 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} se establece en un único directorio, su valor reemplaza tanto al @code{`prefix'} como a @code{`exec_prefix'}.  Para especificar valores diferentes para estos, establezca 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} en @code{`prefix':`exec_prefix'}.
@end deffn

@geindex variables de entorno; PYTHONPATH
@anchor{using/cmdline envvar-PYTHONPATH}@anchor{1099}
@deffn {Variables De Entorno} PYTHONPATH

Aumente la ruta de búsqueda predeterminada para los archivos de módulo.  El formato es el mismo que el de shell 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}: uno o más nombres de ruta de directorio separados por @ref{1d4a,,os.pathsep} (por ejemplo, dos puntos en Unix o punto y coma en Windows). Los directorios inexistentes se omiten silenciosamente.

Además de los directorios normales, las entradas individuales 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} pueden referirse a archivos zip que contienen módulos Python puros (ya sea en forma de origen o compilado). Los módulos de extensión no se pueden importar desde zipfiles.

La ruta de búsqueda predeterminada depende de la instalación, pero generalmente comienza con @code{`prefix'/lib/python`version'} (consulte 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} arriba).  Es `always' anexado a 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}.

Se insertará un directorio adicional en la ruta de búsqueda delante de 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} como se describió anteriormente en @ref{1d2f,,Opciones de interfaz}. La ruta de búsqueda se puede manipular desde un programa Python como la variable @ref{27e,,sys.path}.
@end deffn

@geindex variables de entorno; PYTHONSAFEPATH
@anchor{using/cmdline envvar-PYTHONSAFEPATH}@anchor{646}
@deffn {Variables De Entorno} PYTHONSAFEPATH

Si se establece en una cadena no vacía, no anteponga una ruta potencialmente insegura a @ref{27e,,sys.path}: véase la opción @ref{19ad,,-u} para más información.


Added in version 3.11.

@end deffn

@geindex variables de entorno; PYTHONPLATLIBDIR
@anchor{using/cmdline envvar-PYTHONPLATLIBDIR}@anchor{1949}
@deffn {Variables De Entorno} PYTHONPLATLIBDIR

Si se establece en una cadena no vacía, anula el valor @ref{9cb,,sys.platlibdir}.


Added in version 3.9.

@end deffn

@geindex variables de entorno; PYTHONSTARTUP
@anchor{using/cmdline envvar-PYTHONSTARTUP}@anchor{1047}
@deffn {Variables De Entorno} PYTHONSTARTUP

Si este es el nombre de un archivo legible, los comandos de Python de ese archivo se ejecutan antes de que el primer mensaje se muestre en modo interactivo.  El archivo se ejecuta en el mismo espacio de nombres donde se ejecutan comandos interactivos para que los objetos definidos o importados en él se puedan usar sin calificación en la sesión interactiva.  También puede cambiar las solicitudes @ref{1d4b,,sys.ps1} y @ref{1d4c,,sys.ps2} y el enlace @ref{1046,,sys.__interactivehook__} en este archivo.

Lanza @ref{18c3,,auditing event} @code{cpython.run_startup} con el nombre de archivo como argumento cuando se llama al inicio.
@end deffn

@geindex variables de entorno; PYTHONOPTIMIZE
@anchor{using/cmdline envvar-PYTHONOPTIMIZE}@anchor{1d39}
@deffn {Variables De Entorno} PYTHONOPTIMIZE

Si se establece en una cadena no vacía, equivale a especificar la opción @ref{14f,,-O}.  Si se establece en un entero, es equivalente a especificar @ref{14f,,-O} varias veces.
@end deffn

@geindex variables de entorno; PYTHONBREAKPOINT
@anchor{using/cmdline envvar-PYTHONBREAKPOINT}@anchor{b66}
@deffn {Variables De Entorno} PYTHONBREAKPOINT

Si se establece, nombra un nombre que se puede llamar mediante la notación de trayecto de puntos.  El módulo que contiene el invocable se importará y, a continuación, el invocable se ejecutará por la implementación predeterminada de @ref{b65,,sys.breakpointhook()} que a su vez se llama por incorporado @ref{1a6,,breakpoint()}.  Si no se establece o se establece en la cadena vacía, es equivalente al valor «pdb.set_trace».  Establecer esto en la cadena «0» hace que la implementación predeterminada de @ref{b65,,sys.breakpointhook()} no haga nada más que retornar inmediatamente.


Added in version 3.7.

@end deffn

@geindex variables de entorno; PYTHONDEBUG
@anchor{using/cmdline envvar-PYTHONDEBUG}@anchor{1d38}
@deffn {Variables De Entorno} PYTHONDEBUG

Si se establece en una cadena no vacía, equivale a especificar la opción @ref{1d37,,-d}.  Si se establece en un entero, equivale a especificar @ref{1d37,,-d} varias veces.

Esta variable de entorno necesita una @ref{357,,compilación de depuración de Python}, de lo contrario será ignorada.
@end deffn

@geindex variables de entorno; PYTHONINSPECT
@anchor{using/cmdline envvar-PYTHONINSPECT}@anchor{151a}
@deffn {Variables De Entorno} PYTHONINSPECT

Si se establece en una cadena no vacía, equivale a especificar la opción @ref{151b,,-i}.

Esta variable también se puede modificar mediante código Python mediante @ref{196,,os.environ} para forzar el modo de inspección en la terminación del programa.

Lanza un evento @ref{18c3,,auditing event} @code{cpython.run_stdin} sin argumentos.


Distinto en la versión 3.12.5: (also 3.11.10, 3.10.15, 3.9.20, and 3.8.20)
Emits audit events.



Distinto en la versión 3.13: Uses PyREPL if possible, in which case 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP} is
also executed. Emits audit events.

@end deffn

@geindex variables de entorno; PYTHONUNBUFFERED
@anchor{using/cmdline envvar-PYTHONUNBUFFERED}@anchor{19ae}
@deffn {Variables De Entorno} PYTHONUNBUFFERED

Si se establece en una cadena no vacía, equivale a especificar la opción @ref{19ad,,-u}.
@end deffn

@geindex variables de entorno; PYTHONVERBOSE
@anchor{using/cmdline envvar-PYTHONVERBOSE}@anchor{1d3d}
@deffn {Variables De Entorno} PYTHONVERBOSE

Si se establece en una cadena no vacía, equivale a especificar la opción @ref{1464,,-v}.  Si se establece en un entero, equivale a especificar @ref{1464,,-v} varias veces.
@end deffn

@geindex variables de entorno; PYTHONCASEOK
@anchor{using/cmdline envvar-PYTHONCASEOK}@anchor{9ef}
@deffn {Variables De Entorno} PYTHONCASEOK

Si se establece, Python omite mayúsculas y minúsculas en las instrucciones @ref{682,,import}. Esto sólo funciona en Windows y macOS.
@end deffn

@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@anchor{using/cmdline envvar-PYTHONDONTWRITEBYTECODE}@anchor{140e}
@deffn {Variables De Entorno} PYTHONDONTWRITEBYTECODE

Si se establece en una cadena no vacía, Python no intentará escribir archivos @code{.pyc} en la importación de módulos de origen.  Esto equivale a especificar la opción @ref{140d,,-B}.
@end deffn

@geindex variables de entorno; PYTHONPYCACHEPREFIX
@anchor{using/cmdline envvar-PYTHONPYCACHEPREFIX}@anchor{a35}
@deffn {Variables De Entorno} PYTHONPYCACHEPREFIX

Si se establece, Python escribirá archivos @code{.pyc} en un árbol de directorios reflejado en esta ruta de acceso, en lugar de en directorios @code{__pycache__} dentro del árbol de origen. Esto equivale a especificar la opción @ref{2e2,,-X} @code{pycache_prefix=PATH}.


Added in version 3.8.

@end deffn

@geindex variables de entorno; PYTHONHASHSEED
@anchor{using/cmdline envvar-PYTHONHASHSEED}@anchor{10f9}
@deffn {Variables De Entorno} PYTHONHASHSEED

Si esta variable no se establece o se establece en @code{random}, se utiliza un valor aleatorio para sembrar los hashes de los objetos str y bytes.

Si 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} se establece en un valor entero, se utiliza como una semilla fija para generar el hash() de los tipos cubiertos por la aleatorización hash.

Su propósito es permitir el hash repetible, como para las autocomprobaciónes para el propio intérprete, o permitir que un grupo de procesos python comparta valores hash.

El entero debe ser un número decimal en el intervalo [0,4294967295].  Especificar el valor 0 deshabilitará la aleatorización de hash.


Added in version 3.2.3.

@end deffn

@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@anchor{using/cmdline envvar-PYTHONINTMAXSTRDIGITS}@anchor{17c5}
@deffn {Variables De Entorno} PYTHONINTMAXSTRDIGITS

Si esta variable se establece en un número entero, se utiliza para configurar la @ref{695,,limitación de longitud de conversión de cadena entera}.


Added in version 3.11.

@end deffn

@geindex variables de entorno; PYTHONIOENCODING
@anchor{using/cmdline envvar-PYTHONIOENCODING}@anchor{1086}
@deffn {Variables De Entorno} PYTHONIOENCODING

Si se establece antes de ejecutar el intérprete, invalida la codificación utilizada para stdin/stdout/stderr, en la sintaxis @code{encodingname:errorhandler}.  Tanto las partes @code{encodingname} como @code{:errorhandler} son opcionales y tienen el mismo significado que en @ref{96c,,str.encode()}.

Para stderr, se omite la parte @code{:errorhandler}; el manejador siempre será @code{'backslashreplace'}.


Distinto en la versión 3.4: La parte @code{encodingname} ahora es opcional.



Distinto en la versión 3.6: En Windows, la codificación especificada por esta variable se omite para los búferes de consola interactivos a menos que también se especifique 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@ref{ce3,,PYTHONLEGACYWINDOWSSTDIO}. Los archivos y canalizaciones redirigidos a través de las corrientes estándar no se ven afectados.

@end deffn

@geindex variables de entorno; PYTHONNOUSERSITE
@anchor{using/cmdline envvar-PYTHONNOUSERSITE}@anchor{13ec}
@deffn {Variables De Entorno} PYTHONNOUSERSITE

Si se establece, Python no agregará  @ref{1d3b,,user site-packages directory} a @ref{27e,,sys.path}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Directorio de paquetes de sitio por usuario

@end deffn

@geindex variables de entorno; PYTHONUSERBASE
@anchor{using/cmdline envvar-PYTHONUSERBASE}@anchor{13ea}
@deffn {Variables De Entorno} PYTHONUSERBASE

Define el @ref{1384,,user base directory}, que se utiliza para calcular la ruta de acceso de @ref{1d3b,,user site-packages directory} y @ref{1d4d,,installation paths} para @code{python -m pie install --user}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Directorio de paquetes de sitio por usuario

@end deffn

@geindex variables de entorno; PYTHONEXECUTABLE
@anchor{using/cmdline envvar-PYTHONEXECUTABLE}@anchor{1d4e}
@deffn {Variables De Entorno} PYTHONEXECUTABLE

Si se establece esta variable de entorno, @code{sys.argv[0]} se establecerá en su valor en lugar del valor conseguido a través del tiempo de ejecución de C. Sólo funciona en macOS.
@end deffn

@geindex variables de entorno; PYTHONWARNINGS
@anchor{using/cmdline envvar-PYTHONWARNINGS}@anchor{c32}
@deffn {Variables De Entorno} PYTHONWARNINGS

Esto es equivalente a la opción @ref{95e,,-W}. Si se establece en una cadena separada por comas, es equivalente a especificar @ref{95e,,-W} varias veces, con filtros más adelante en la lista que tienen prioridad sobre los anteriores de la lista.

La configuración más sencilla aplica una acción determinada incondicionalmente a todas las advertencias emitidas por un proceso (incluso aquellas que de otro modo se ignoran de forma predeterminada):

@example
PYTHONWARNINGS=default  # Warn once per call location
PYTHONWARNINGS=error    # Convert to exceptions
PYTHONWARNINGS=always   # Warn every time
PYTHONWARNINGS=all      # Same as PYTHONWARNINGS=always
PYTHONWARNINGS=module   # Warn once per calling module
PYTHONWARNINGS=once     # Warn once per Python process
PYTHONWARNINGS=ignore   # Never warn
@end example

Consulte @ref{960,,El filtro de advertencias} y @ref{1d3f,,Descripción de los filtros de advertencia} para obtener más detalles.
@end deffn

@geindex variables de entorno; PYTHONFAULTHANDLER
@anchor{using/cmdline envvar-PYTHONFAULTHANDLER}@anchor{10fc}
@deffn {Variables De Entorno} PYTHONFAULTHANDLER

If this environment variable is set to a non-empty string,
@ref{d27,,faulthandler.enable()} is called at startup: install a handler for
@ref{1d4f,,SIGSEGV}, @ref{1d50,,SIGFPE},
@ref{1d51,,SIGABRT}, @ref{1d52,,SIGBUS} and
@ref{1d53,,SIGILL} signals to dump the Python traceback.
This is equivalent to @ref{2e2,,-X} @code{faulthandler} option.


Added in version 3.3.

@end deffn

@geindex variables de entorno; PYTHONTRACEMALLOC
@anchor{using/cmdline envvar-PYTHONTRACEMALLOC}@anchor{1d42}
@deffn {Variables De Entorno} PYTHONTRACEMALLOC

Si esta variable de entorno se establece en una cadena no vacía, comience a trazar las asignaciones de memoria de Python mediante el módulo @ref{ff,,tracemalloc}. El valor de la variable es el número máximo de marcos almacenados en un rastreo de un seguimiento. Por ejemplo, @code{PYTHONTRACEMALLOC=1} almacena sólo el marco más reciente. Consulte la función @ref{1d41,,tracemalloc.start()} para obtener más información. Esto equivale a configurar la opción @ref{2e2,,-X} @code{tracemalloc}.


Added in version 3.4.

@end deffn

@geindex variables de entorno; PYTHONPROFILEIMPORTTIME
@anchor{using/cmdline envvar-PYTHONPROFILEIMPORTTIME}@anchor{b80}
@deffn {Variables De Entorno} PYTHONPROFILEIMPORTTIME

Si esta variable de entorno se establece en una cadena no vacía, Python mostrará cuánto tiempo tarda cada importación. Esto equivale exactamente a establecer @ref{2e2,,-X} @code{importtime} en la línea de comandos.


Added in version 3.7.

@end deffn

@geindex variables de entorno; PYTHONASYNCIODEBUG
@anchor{using/cmdline envvar-PYTHONASYNCIODEBUG}@anchor{1d54}
@deffn {Variables De Entorno} PYTHONASYNCIODEBUG

Si esta variable de entorno se establece en una cadena no vacía, habilite el modo @ref{1d55,,debug mode} del módulo @ref{b,,asyncio}.


Added in version 3.4.

@end deffn

@geindex variables de entorno; PYTHONMALLOC
@anchor{using/cmdline envvar-PYTHONMALLOC}@anchor{cec}
@deffn {Variables De Entorno} PYTHONMALLOC

Establezca los asignadores de memoria de Python y/o instale enlaces de depuración.

Establezca la familia de asignadores de memoria utilizados por Python:


@itemize *

@item 
@code{default}: utilice @ref{1d56,,default memory allocators}.

@item 
@code{malloc}: utilice la función @code{malloc()} de la biblioteca C para todos los dominios (@ref{1d57,,PYMEM_DOMAIN_RAW}, @ref{cf1,,PYMEM_DOMAIN_MEM}, @ref{cef,,PYMEM_DOMAIN_OBJ}).

@item 
@code{pymalloc}: utilice el @ref{d96,,pymalloc allocator} para @ref{cf1,,PYMEM_DOMAIN_MEM} y dominios @ref{cef,,PYMEM_DOMAIN_OBJ} y utilice la función @code{malloc()} para el dominio @ref{1d57,,PYMEM_DOMAIN_RAW}.

@item 
@code{mimalloc}: use the @ref{1d58,,mimalloc allocator} for
@ref{cf1,,PYMEM_DOMAIN_MEM} and @ref{cef,,PYMEM_DOMAIN_OBJ} domains and use
the @code{malloc()} function for the @ref{1d57,,PYMEM_DOMAIN_RAW} domain.
@end itemize

Instalar @ref{1d59,,enlaces de depuración}:


@itemize *

@item 
@code{debug}: instale los enlaces de depuración encima de @ref{1d56,,default memory allocators}.

@item 
@code{malloc_debug}: igual que @code{malloc} pero también instalar ganchos de depuración.

@item 
@code{pymalloc_debug}: igual que @code{pymalloc} pero también instalar enlaces de depuración.

@item 
@code{mimalloc_debug}: same as @code{mimalloc} but also install debug hooks.
@end itemize


Added in version 3.6.



Distinto en la versión 3.7: Se ha añadido el asignador @code{"predeterminado"}.

@end deffn

@geindex variables de entorno; PYTHONMALLOCSTATS
@anchor{using/cmdline envvar-PYTHONMALLOCSTATS}@anchor{1b5d}
@deffn {Variables De Entorno} PYTHONMALLOCSTATS

Si se establece en una cadena no vacía, Python imprimirá estadísticas de @ref{d96,,pymalloc memory allocator} cada vez que se crea una nueva arena de objetos pymalloc y al apagarse.

Esta variable se omite si la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} se utiliza para forzar el asignador @code{malloc()} de la biblioteca C, o si Python está configurado sin compatibilidad con @code{pymalloc}.


Distinto en la versión 3.6: Esta variable ahora también se puede utilizar en Python compilado en modo de versión. Ahora no tiene ningún efecto si se establece en una cadena vacía.

@end deffn

@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSFSENCODING}@anchor{1e7}
@deffn {Variables De Entorno} PYTHONLEGACYWINDOWSFSENCODING

Si se establece en una cadena no vacía, el @ref{5dd,,filesystem encoding and error handler} predeterminado volverá a sus valores pre-3.6 de @cite{mbcs} y @cite{replace}, respectivamente. De lo contrario, se utilizan los nuevos valores predeterminados “utf-8” y “surrogatepass”.

This may also be enabled at runtime with
@ref{1e6,,sys._enablelegacywindowsfsencoding()}.

@ref{1d5a,,Availability}: Windows.


Added in version 3.6: Consulte 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para obtener más detalles.

@end deffn

@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSSTDIO}@anchor{ce3}
@deffn {Variables De Entorno} PYTHONLEGACYWINDOWSSTDIO

Si se establece en una cadena no vacía, no utiliza el nuevo lector y escritor de consola. Esto significa que los caracteres Unicode se codificarán de acuerdo con la página de códigos de la consola activa, en lugar de usar utf-8.

Esta variable se omite si se redirigen las secuencias estándar (a archivos o canalizaciones) en lugar de hacer referencia a búferes de consola.

@ref{1d5a,,Availability}: Windows.


Added in version 3.6.

@end deffn

@geindex variables de entorno; PYTHONCOERCECLOCALE
@anchor{using/cmdline envvar-PYTHONCOERCECLOCALE}@anchor{b60}
@deffn {Variables De Entorno} PYTHONCOERCECLOCALE

Si se establece en el valor @code{0}, hace que la aplicación principal de línea de comandos de Python omita la coerción de las configuraciones regionales C y POSIX basadas en ASCII heredadas a una alternativa basada en UTF-8 más capaz.

Si esta variable es `no' establecida (o se establece en un valor distinto de @code{0}), tampoco se establece la variable de entorno de invalidación local @code{LC_ALL}, y la configuración local actual notificada para la categoría @code{LC_CTYPE} es la configuración local @code{C} predeterminada, o bien la configuración local basada explícitamente en ASCII @code{POSIX}, entonces la CLI de Python intentará configurar las siguientes configuraciones locales para la categoría @code{LC_CTYPE} en el orden indicado antes de cargar el tiempo de ejecución del intérprete:


@itemize *

@item 
@code{C.UTF-8}

@item 
@code{C.utf8}

@item 
@code{UTF-8}
@end itemize

Si la configuración de una de estas categorías de configuración local se realiza correctamente, la variable de entorno @code{LC_CTYPE} también se establecerá en consecuencia en el entorno de proceso actual antes de que se inicialice el tiempo de ejecución de Python. Esto garantiza que, además de ser visto tanto por el propio intérprete como por otros componentes compatibles con la configuración local que se ejecutan en el mismo proceso (como la biblioteca GNU @code{readline}), la configuración actualizada también se ve en los subprocesos (independientemente de si esos procesos están ejecutando o no un intérprete de Python), así como en las operaciones que consultan el entorno en lugar de la configuración regional de C actual (como la propia de Python @ref{1d0,,locale.getdefaultlocale()}).

La configuración de una de estas configuraciones regionales (ya sea explícitamente o a través de la coerción de configuración regional implícita anterior) habilita automáticamente el @code{surrogateescape} @ref{17ed,,error handler} para @ref{5df,,sys.stdin} y @ref{b61,,sys.stdout} (@ref{9cc,,sys.stderr} continúa utilizando @code{backslashreplace} como lo hace en cualquier otra configuración local). Este comportamiento de control de secuencias se puede invalidar mediante 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING} como de costumbre.

Para fines de depuración, establecer @code{PYTHONCOERCECLOCALE-warn} hará que Python emita mensajes de advertencia en @code{stderr} si se activa la coerción de configuración regional, o si una configuración regional que `would' ha activado la coerción sigue activa cuando se inicializa el tiempo de ejecución de Python.

También tenga en cuenta que incluso cuando la coerción de configuración regional está desactivada, o cuando no puede encontrar una configuración regional de destino adecuada, 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} se activará de forma predeterminada en las configuraciones regionales heredadas basadas en ASCII. Ambas funciones deben estar deshabilitadas para obligar al intérprete a usar @code{ASCII} en lugar de @code{UTF-8} para las interfaces del sistema.

@ref{1d5a,,Availability}: Unix.


Added in version 3.7: Consulte 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} para obtener más detalles.

@end deffn

@geindex variables de entorno; PYTHONDEVMODE
@anchor{using/cmdline envvar-PYTHONDEVMODE}@anchor{b78}
@deffn {Variables De Entorno} PYTHONDEVMODE

Si esta variable de entorno se establece en una cadena no vacía, habilite @ref{356,,Python Development Mode}, introduciendo comprobaciones de tiempo de ejecución adicionales que son demasiado caras para habilitarse de forma predeterminada. Esto equivale a configurar la opción @ref{2e2,,-X} @code{dev}.


Added in version 3.7.

@end deffn

@geindex variables de entorno; PYTHONUTF8
@anchor{using/cmdline envvar-PYTHONUTF8}@anchor{b63}
@deffn {Variables De Entorno} PYTHONUTF8

Si se establece en @code{1}, habilita el @ref{6f7,,modo Python UTF-8}.

Si se establece en @code{0}, deshabilita el @ref{6f7,,modo Python UTF-8}.

Establecer cualquier otra cadena no vacía produce un error durante la inicialización del intérprete.


Added in version 3.7.

@end deffn

@geindex variables de entorno; PYTHONWARNDEFAULTENCODING
@anchor{using/cmdline envvar-PYTHONWARNDEFAULTENCODING}@anchor{855}
@deffn {Variables De Entorno} PYTHONWARNDEFAULTENCODING

Si esta variable de entorno se establece como una cadena de caracteres no vacía, emite un @ref{1d43,,EncodingWarning} cuando se utilice la codificación predeterminada específica de la configuración regional.

Ver @ref{1d5b,,EncodingWarning opcional} para más detalles.


Added in version 3.10.

@end deffn

@geindex variables de entorno; PYTHONNODEBUGRANGES
@anchor{using/cmdline envvar-PYTHONNODEBUGRANGES}@anchor{657}
@deffn {Variables De Entorno} PYTHONNODEBUGRANGES

Si se establece esta variable, deshabilita la inclusión de tablas que asignan información de ubicación adicional (línea final, desplazamiento de columna inicial y desplazamiento de columna final) a cada instrucción en los objetos de código. Esto es útil cuando se desean objetos de código más pequeños y archivos pyc, además de suprimir los indicadores de ubicación visuales adicionales cuando el intérprete muestra rastreos.


Added in version 3.11.

@end deffn

@geindex variables de entorno; PYTHONPERFSUPPORT
@anchor{using/cmdline envvar-PYTHONPERFSUPPORT}@anchor{519}
@deffn {Variables De Entorno} PYTHONPERFSUPPORT

Si esta variable se establece en un valor distinto de cero, habilita la compatibilidad con el perfilador @code{perf} de Linux para que pueda detectar las llamadas de Python.

Si se establece en @code{0}, deshabilite la compatibilidad con el generador de perfiles @code{perf} de Linux.

Consulte también la opción de línea de comandos @ref{2e2,,-X perf} y @ref{2f8,,Soporte de Python para el perfilador perf de Linux}.


Added in version 3.12.

@end deffn

@geindex variables de entorno; PYTHON_PERF_JIT_SUPPORT
@anchor{using/cmdline envvar-PYTHON_PERF_JIT_SUPPORT}@anchor{2f9}
@deffn {Variables De Entorno} PYTHON_PERF_JIT_SUPPORT

If this variable is set to a nonzero value, it enables support for
the Linux @code{perf} profiler so Python calls can be detected by it
using DWARF information.

Si se establece en @code{0}, deshabilite la compatibilidad con el generador de perfiles @code{perf} de Linux.

See also the @ref{2e2,,-X perf_jit} command-line option
and @ref{2f8,,Soporte de Python para el perfilador perf de Linux}.


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_CPU_COUNT
@anchor{using/cmdline envvar-PYTHON_CPU_COUNT}@anchor{36d}
@deffn {Variables De Entorno} PYTHON_CPU_COUNT

If this variable is set to a positive integer, it overrides the return
values of @ref{328,,os.cpu_count()} and @ref{327,,os.process_cpu_count()}.

See also the @ref{2e2,,-X cpu_count} command-line option.


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_FROZEN_MODULES
@anchor{using/cmdline envvar-PYTHON_FROZEN_MODULES}@anchor{2f7}
@deffn {Variables De Entorno} PYTHON_FROZEN_MODULES

If this variable is set to @code{on} or @code{off}, it determines whether or not
frozen modules are ignored by the import machinery.  A value of @code{on} means
they get imported and @code{off} means they are ignored.  The default is @code{on}
for non-debug builds (the normal case) and @code{off} for debug builds.
Note that the @code{importlib_bootstrap} and
@code{importlib_bootstrap_external} frozen modules are always used, even
if this flag is set to @code{off}.

See also the @ref{2e2,,-X frozen_modules} command-line option.


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_COLORS
@anchor{using/cmdline envvar-PYTHON_COLORS}@anchor{2b7}
@deffn {Variables De Entorno} PYTHON_COLORS

If this variable is set to @code{1}, the interpreter will colorize various kinds
of output. Setting it to @code{0} deactivates this behavior.
See also @ref{2d7,,Controlling color}.


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_BASIC_REPL
@anchor{using/cmdline envvar-PYTHON_BASIC_REPL}@anchor{2da}
@deffn {Variables De Entorno} PYTHON_BASIC_REPL

If this variable is set to @code{1}, the interpreter will not attempt to
load the Python-based @ref{2d6,,REPL} that requires @ref{2c,,curses} and
@ref{ba,,readline}, and will instead use the traditional parser-based
@ref{2d6,,REPL}.


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_HISTORY
@anchor{using/cmdline envvar-PYTHON_HISTORY}@anchor{2fa}
@deffn {Variables De Entorno} PYTHON_HISTORY

This environment variable can be used to set the location of a
@code{.python_history} file (by default, it is @code{.python_history} in the
user’s home directory).


Added in version 3.13.

@end deffn

@geindex variables de entorno; PYTHON_GIL
@anchor{using/cmdline envvar-PYTHON_GIL}@anchor{2e1}
@deffn {Variables De Entorno} PYTHON_GIL

If this variable is set to @code{1}, the global interpreter lock (GIL) will be
forced on. Setting it to @code{0} forces the GIL off (needs Python configured with
the @ref{2e0,,--disable-gil} build option).

See also the @ref{2e2,,-X gil} command-line option, which takes
precedence over this variable, and @ref{2ac,,Free-threaded CPython}.


Added in version 3.13.

@end deffn

@menu
* Variables de modo de depuración:: 

@end menu

@node Variables de modo de depuración,,,Variables de entorno
@anchor{using/cmdline debug-mode-variables}@anchor{1d5c}
@subsubsection Variables de modo de depuración


@geindex variables de entorno; PYTHONDUMPREFS
@anchor{using/cmdline envvar-PYTHONDUMPREFS}@anchor{a38}
@deffn {Variables De Entorno} PYTHONDUMPREFS

Si se establece, Python volcará objetos y recuentos de referencias aún vivos después de apagar el intérprete.

Needs Python configured with the @ref{487,,--with-trace-refs} build option.
@end deffn

@geindex variables de entorno; PYTHONDUMPREFSFILE
@anchor{using/cmdline envvar-PYTHONDUMPREFSFILE}@anchor{189a}
@deffn {Variables De Entorno} PYTHONDUMPREFSFILE

If set, Python will dump objects and reference counts still alive
after shutting down the interpreter into a file under the path given
as the value to this environment variable.

Needs Python configured with the @ref{487,,--with-trace-refs} build option.


Added in version 3.11.

@end deffn

@geindex variables de entorno; PYTHON_PRESITE
@anchor{using/cmdline envvar-PYTHON_PRESITE}@anchor{1d44}
@deffn {Variables De Entorno} PYTHON_PRESITE

If this variable is set to a module, that module will be imported
early in the interpreter lifecycle, before the @ref{c7,,site} module is
executed, and before the @ref{1,,__main__} module is created.
Therefore, the imported module is not treated as @ref{1,,__main__}.

This can be used to execute code early during Python initialization.

To import a submodule, use @code{package.module} as the value, like in
an import statement.

See also the @ref{2e2,,-X presite} command-line option,
which takes precedence over this variable.

Needs Python configured with the @ref{4e0,,--with-pydebug} build option.


Added in version 3.13.

@end deffn

@node Uso de Python en plataformas Unix,Configurar Python,Línea de comandos y entorno,Configuración y uso de Python
@anchor{using/unix doc}@anchor{1d5d}@anchor{using/unix using-on-unix}@anchor{1d5e}@anchor{using/unix using-python-on-unix-platforms}@anchor{1d5f}
@section Uso de Python en plataformas Unix


@menu
* Obteniendo e instalando la última versión de Python:: 
* Construyendo Python:: 
* Rutas y archivos relacionados con Python:: 
* Miscelánea:: 
* OpenSSL personalizado:: 

@end menu

@node Obteniendo e instalando la última versión de Python,Construyendo Python,,Uso de Python en plataformas Unix
@anchor{using/unix getting-and-installing-the-latest-version-of-python}@anchor{1d60}
@subsection Obteniendo e instalando la última versión de Python


@menu
* En Linux:: 
* En FreeBSD y OpenBSD:: 

@end menu

@node En Linux,En FreeBSD y OpenBSD,,Obteniendo e instalando la última versión de Python
@anchor{using/unix on-linux}@anchor{1d61}
@subsubsection En Linux


Python comes preinstalled on most Linux distributions, and is available as a
package on all others.  However there are certain features you might want to use
that are not available on your distro’s package.  You can compile the
latest version of Python from source.

In the event that the latest version of Python doesn’t come preinstalled and isn’t
in the repositories as well, you can make packages for your own distro.  Have a
look at the following links:


@subsubheading Ver también



@table @asis

@item @indicateurl{https://www.debian.org/doc/manuals/maint-guide/first.en.html}

para usuarios de Debian

@item @indicateurl{https://en.opensuse.org/Portal:Packaging}

para los usuarios de OpenSuse

@item @indicateurl{https://docs.fedoraproject.org/en-US/package-maintainers/Packaging_Tutorial_GNU_Hello/}

para los usuarios de Fedora

@item @indicateurl{https://slackbook.org/html/package-management-making-packages.html}

para los usuarios de Slackware
@end table


@node En FreeBSD y OpenBSD,,En Linux,Obteniendo e instalando la última versión de Python
@anchor{using/unix on-freebsd-and-openbsd}@anchor{1d62}
@subsubsection En FreeBSD y OpenBSD



@itemize *

@item 
Usuarios FreeBSD, para añadir al paquete use:

@example
pkg install python3
@end example

@item 
Usuarios OpenBSD, para añadir al paquete use:

@example
pkg_add -r python

pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/<insert your architecture here>/python-<version>.tgz
@end example

Por ejemplo, los usuarios de i386 obtienen la versión 2.5.1 de Python usando:

@example
pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz
@end example
@end itemize

@node Construyendo Python,Rutas y archivos relacionados con Python,Obteniendo e instalando la última versión de Python,Uso de Python en plataformas Unix
@anchor{using/unix building-python}@anchor{1d63}@anchor{using/unix building-python-on-unix}@anchor{f76}
@subsection Construyendo Python


Si desea compilar CPython por sí mismo, lo primero que debería hacer es obtener la fuente@footnote{https://www.python.org/downloads/source/}. Puede descargar la fuente de la última versión o simplemente conseguir un nuevo clon@footnote{https://devguide.python.org/setup/#get-the-source-code}. (Si desea contribuir con parches, necesitará un clon.)

El proceso de construcción consta de los comandos habituales:

@example
./configure
make
make install
@end example

@ref{1d64,,Opciones de configuración} y las advertencias para plataformas Unix específicas están ampliamente documentadas en el archivo README.rst@footnote{https://github.com/python/cpython/tree/main/README.rst} en la raíz del árbol de fuentes de Python.

@cartouche
@quotation Advertencia 
@code{make install} puede sobreescribir o enmascarar el binario @code{python3}. Por lo tanto se recomienda @code{make altinstall} en lugar de @code{make install} debido a que sólo instala @code{`exec_prefix'/bin/python`version'}.
@end quotation
@end cartouche

@node Rutas y archivos relacionados con Python,Miscelánea,Construyendo Python,Uso de Python en plataformas Unix
@anchor{using/unix python-related-paths-and-files}@anchor{1d65}
@subsection Rutas y archivos relacionados con Python


Estos están sujetos a diferencias según las convenciones de instalación locales; @ref{1d66,,prefix} y @ref{1d67,,exec_prefix} son dependientes de la instalación y deben interpretarse como en el software GNU; pueden ser iguales.

Por ejemplo, en la mayoría de los sistemas Linux, el valor predeterminado para ambos es @code{/usr}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Archivo/directorio

@tab

Significado

@item

@code{`exec_prefix'/bin/python3}

@tab

Ubicación recomendada del intérprete.

@item

@code{`prefix'/lib/python`version'},
@code{`exec_prefix'/lib/python`version'}

@tab

Ubicaciones recomendadas de los directorios que contienen los módulos estándar.

@item

@code{`prefix'/include/python`version'},
@code{`exec_prefix'/include/python`version'}

@tab

Ubicaciones recomendadas de los directorios que contienen los archivos de inclusión necesarios para desarrollar extensiones de Python e incrustar el intérprete.

@end multitable


@node Miscelánea,OpenSSL personalizado,Rutas y archivos relacionados con Python,Uso de Python en plataformas Unix
@anchor{using/unix miscellaneous}@anchor{1d68}
@subsection Miscelánea


Para usar fácilmente los scripts de Python en Unix, debe hacerlos ejecutables, p. ej. con

@example
$ chmod +x script
@end example

y coloque una línea `Shebang' adecuada en la parte superior del script. Una buena opción es usualmente

@example
#!/usr/bin/env python3
@end example

que busca el intérprete de Python en el conjunto 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. Sin embargo, algunos Unices puede que no tengan el comando @code{env}, por lo que es posible que deba codificar @code{/usr/bin/python3} como la ruta intérprete.

Para usar comandos de shell en sus scripts de Python, mire el módulo @ref{d6,,subprocess}.

@node OpenSSL personalizado,,Miscelánea,Uso de Python en plataformas Unix
@anchor{using/unix custom-openssl}@anchor{1d69}@anchor{using/unix unix-custom-openssl}@anchor{1d6a}
@subsection OpenSSL personalizado



@enumerate 

@item 
Para utilizar la configuración de OpenSSL de su proveedor y el almacén de confianza del sistema, busque el directorio con el archivo @code{openssl.cnf} o el enlace simbólico en @code{/etc}. En la mayoría de las distribuciones, el archivo está en @code{/etc/ssl} o @code{/etc/pki/tls}. El directorio también debe contener un archivo @code{cert.pem} y / o un directorio @code{certs}.

@example
$ find /etc/ -name openssl.cnf -printf "%h\n"
/etc/ssl
@end example

@item 
Descargue, compile e instale OpenSSL. Asegúrese de utilizar @code{install_sw} y no @code{install}. El destino @code{install_sw} no anula @code{openssl.cnf}.

@example
$ curl -O https://www.openssl.org/source/openssl-VERSION.tar.gz
$ tar xzf openssl-VERSION
$ pushd openssl-VERSION
$ ./config \
    --prefix=/usr/local/custom-openssl \
    --libdir=lib \
    --openssldir=/etc/ssl
$ make -j1 depend
$ make -j8
$ make install_sw
$ popd
@end example

@item 
Construir Python con OpenSSL personalizado (consulte las opciones configure @code{--with-openssl} y @code{--with-openssl-rpath})

@example
$ pushd python-3.x.x
$ ./configure -C \
    --with-openssl=/usr/local/custom-openssl \
    --with-openssl-rpath=auto \
    --prefix=/usr/local/python-3.x.x
$ make -j8
$ make altinstall
@end example
@end enumerate

@cartouche
@quotation Nota 
Las versiones de parche de OpenSSL tienen una ABI compatible con versiones anteriores. No es necesario volver a compilar Python para actualizar OpenSSL. Es suficiente reemplazar la instalación personalizada de OpenSSL con una versión más nueva.
@end quotation
@end cartouche

@node Configurar Python,Uso de Python en Windows,Uso de Python en plataformas Unix,Configuración y uso de Python
@anchor{using/configure doc}@anchor{1d6b}@anchor{using/configure configure-python}@anchor{1d6c}
@section Configurar Python


@menu
* Requisitos de compilación:: 
* Archivos generados:: 
* Configurar opciones:: 
* Sistema de compilación Python:: 
* Banderas de compilador y vinculación:: 

@end menu

@node Requisitos de compilación,Archivos generados,,Configurar Python
@anchor{using/configure build-requirements}@anchor{1d6d}
@subsection Requisitos de compilación


Features and minimum versions required to build CPython:


@itemize *

@item 
Un compilador C11@footnote{https://en.cppreference.com/w/c/11}. Características opcionales de C11@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features} no son necesarias.

@item 
En Windows, se necesita Microsoft Visual Studio 2017 o posterior.

@item 
Support for IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754}
floating-point numbers and floating-point Not-a-Number (NaN)@footnote{https://en.wikipedia.org/wiki/NaN#Floating_point}.

@item 
Soporte para hilos.

@item 
OpenSSL 1.1.1 is the minimum version and OpenSSL 3.0.9 is the recommended
minimum version for the @ref{d0,,ssl} and @ref{68,,hashlib} extension modules.

@item 
SQLite 3.15.2 for the @ref{cf,,sqlite3} extension module.

@item 
Tcl/Tk 8.5.12 for the @ref{f0,,tkinter} module.

@item 
Autoconf 2.71 and aclocal 1.16.5 are required to regenerate the
@code{configure} script.
@end itemize


Distinto en la versión 3.1: Tcl/Tk version 8.3.1 is now required.



Distinto en la versión 3.5: On Windows, Visual Studio 2015 or later is now required.
Tcl/Tk version 8.4 is now required.



Distinto en la versión 3.6: Ahora se necesitan características seleccionadas de C99, como @code{<stdint.h>} y funciones @code{static inline}.



Distinto en la versión 3.7: Ahora se necesita soporte de hilos y OpenSSL 1.0.2.



Distinto en la versión 3.10: OpenSSL 1.1.1 is now required.
Require SQLite 3.7.15.



Distinto en la versión 3.11: C11 compiler, IEEE 754 and NaN support are now required.
On Windows, Visual Studio 2017 or later is required.
Tcl/Tk version 8.5.12 is now required for the @ref{f0,,tkinter} module.



Distinto en la versión 3.13: Autoconf 2.71, aclocal 1.16.5 and SQLite 3.15.2 are now required.


Ver también 
@geindex Python Enhancement Proposals; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} «Style Guide for C Code» y 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} «CPython platform support».

@node Archivos generados,Configurar opciones,Requisitos de compilación,Configurar Python
@anchor{using/configure generated-files}@anchor{1d6e}
@subsection Archivos generados


Para reducir las dependencias de compilación, el código fuente de Python contiene varios archivos generados. Comandos para regenerar todos los archivos generados:

@example
make regen-all
make regen-stdlib-module-names
make regen-limited-abi
make regen-configure
@end example

El archivo @code{Makefile.pre.in} documenta archivos generados, sus entradas y las herramientas que se usaron para regenerarlos. Busque los objetivos make @code{regen-*}.

@menu
* configure script:: 

@end menu

@node configure script,,,Archivos generados
@anchor{using/configure configure-script}@anchor{1d6f}
@subsubsection configure script


The @code{make regen-configure} command regenerates the @code{aclocal.m4} file and
the @code{configure} script using the @code{Tools/build/regen-configure.sh} shell
script which uses an Ubuntu container to get the same tools versions and have a
reproducible output.

The container is optional, the following command can be run locally:

@example
autoreconf -ivf -Werror
@end example

The generated files can change depending on the exact @code{autoconf-archive},
@code{aclocal} and @code{pkg-config} versions.

@node Configurar opciones,Sistema de compilación Python,Archivos generados,Configurar Python
@anchor{using/configure configure-options}@anchor{1d64}@anchor{using/configure id1}@anchor{1d70}
@subsection Configurar opciones


List all @code{configure} script options using:

@example
./configure --help
@end example

Consultar también @code{Misc/SpecialBuilds.txt} en la distribución fuente de Python.

@menu
* Opciones generales:: 
* C compiler options:: 
* Opciones del enlazador:: 
* Options for third-party dependencies:: 
* Opciones de WebAssembly:: 
* Opciones de instalación:: 
* Opciones de desempeño:: 
* Compilación de depuración de Python:: 
* Opciones de depuración:: 
* Opciones del enlazador: Opciones del enlazador<2>. 
* Opciones de bibliotecas:: 
* Opciones de seguridad:: 
* Opciones macOS:: 
* iOS Options:: 
* Opciones de compilación cruzada:: 

@end menu

@node Opciones generales,C compiler options,,Configurar opciones
@anchor{using/configure general-options}@anchor{1d71}
@subsubsection Opciones generales


@geindex opción de línea de comando; --enable-loadable-sqlite-extensions
@anchor{using/configure cmdoption-enable-loadable-sqlite-extensions}@anchor{1d72}
@deffn {Option} @w{-}@w{-}enable@w{-}loadable@w{-}sqlite@w{-}extensions

Admite extensiones cargables en el módulo de extensión @code{_sqlite} (el valor por defecto es no) del módulo @ref{cf,,sqlite3}.

Consultar el método @ref{8d5,,sqlite3.Connection.enable_load_extension()} del módulo @ref{cf,,sqlite3}.


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --disable-ipv6
@anchor{using/configure cmdoption-disable-ipv6}@anchor{1d73}
@deffn {Option} @w{-}@w{-}disable@w{-}ipv6

Deshabilita la compatibilidad con IPv6 (habilitada de forma predeterminada si es compatible), consulte el módulo @ref{cc,,socket}.
@end deffn

@geindex opción de línea de comando; --enable-big-digits
@anchor{using/configure cmdoption-enable-big-digits}@anchor{7e7}
@deffn {Option} @w{-}@w{-}enable@w{-}big@w{-}digits=[15|30]

Define el tamaño en bits de los dígitos @ref{1f0,,int} de Python: 15 o 30 bits.

Por defecto, el tamaño del dígito es 30.

Define el @code{PYLONG_BITS_IN_DIGIT} en @code{15} o @code{30}.

Consultar @ref{1300,,sys.int_info.bits_per_digit}.
@end deffn

@geindex opción de línea de comando; --with-suffix
@anchor{using/configure cmdoption-with-suffix}@anchor{1d74}
@deffn {Option} @w{-}@w{-}with@w{-}suffix=SUFFIX

Establece el sufijo ejecutable de Python en `SUFFIX'.

El sufijo predeterminado es @code{.exe} en Windows y macOS (ejecutable @code{python.exe}), @code{.js} en el nodo Emscripten, @code{.html} en el navegador Emscripten, @code{.wasm} en WASI y una cadena vacía en otras plataformas (ejecutable @code{python}).


Distinto en la versión 3.11: El sufijo predeterminado en la plataforma WASM es uno de @code{.js}, @code{.html} o @code{.wasm}.

@end deffn

@geindex opción de línea de comando; --with-tzpath
@anchor{using/configure cmdoption-with-tzpath}@anchor{1d75}
@deffn {Option} @w{-}@w{-}with@w{-}tzpath=<list of absolute paths separated by pathsep>

Selecciona la ruta de búsqueda de zona horaria predeterminada para @ref{1d76,,zoneinfo.TZPATH}. Consultar la @ref{1d77,,Configuración en tiempo de compilación} del módulo @ref{133,,zoneinfo}.

Por defecto: @code{/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo}.

Consultar separador de rutas @ref{1d4a,,os.pathsep} .


Added in version 3.9.

@end deffn

@geindex opción de línea de comando; --without-decimal-contextvar
@anchor{using/configure cmdoption-without-decimal-contextvar}@anchor{1d78}
@deffn {Option} @w{-}@w{-}without@w{-}decimal@w{-}contextvar

Construye el módulo de extensión @code{_decimal} usando un contexto local de hilos en lugar de un contexto local de corutinas (predeterminado), consultar el módulo @ref{37,,decimal}.

Consultar @ref{1d79,,decimal.HAVE_CONTEXTVAR} y el módulo @ref{25,,contextvars}.


Added in version 3.9.

@end deffn

@geindex opción de línea de comando; --with-dbmliborder
@anchor{using/configure cmdoption-with-dbmliborder}@anchor{1d7a}
@deffn {Option} @w{-}@w{-}with@w{-}dbmliborder=<list of backend names>

Sobrescribe el orden para verificar los de las bases datos para el módulo @ref{32,,dbm}

Un valor válido es una cadena de caracteres separada por dos puntos (@code{:}) con los nombres de los backends:


@itemize *

@item 
@code{ndbm};

@item 
@code{gdbm};

@item 
@code{bdb}.
@end itemize
@end deffn

@geindex opción de línea de comando; --without-c-locale-coercion
@anchor{using/configure cmdoption-without-c-locale-coercion}@anchor{1d7b}
@deffn {Option} @w{-}@w{-}without@w{-}c@w{-}locale@w{-}coercion

Deshabilita la coerción de configuración regional C a una configuración regional basada en UTF-8 (habilitada de forma predeterminada).

No define la macro @code{PY_COERCE_C_LOCALE}.

Consultar 
@geindex PYTHONCOERCECLOCALE
@geindex variables de entorno; PYTHONCOERCECLOCALE
@ref{b60,,PYTHONCOERCECLOCALE} y el 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}.
@end deffn

@geindex opción de línea de comando; --with-platlibdir
@anchor{using/configure cmdoption-with-platlibdir}@anchor{1d7c}
@deffn {Option} @w{-}@w{-}with@w{-}platlibdir=DIRNAME

Nombre del directorio de la biblioteca de Python (por defecto es @code{lib}).

Fedora y SuSE usan @code{lib64} en plataformas 64-bit.

Consultar @ref{9cb,,sys.platlibdir}.


Added in version 3.9.

@end deffn

@geindex opción de línea de comando; --with-wheel-pkg-dir
@anchor{using/configure cmdoption-with-wheel-pkg-dir}@anchor{925}
@deffn {Option} @w{-}@w{-}with@w{-}wheel@w{-}pkg@w{-}dir=PATH

Directorio de los paquetes `wheel' usados por el módulo @ref{55,,ensurepip} (ninguno por defecto)

Algunas políticas de empaquetado de distribución de Linux recomiendan no empaquetar dependencias. Por ejemplo, Fedora instala paquetes `wheel' en el directorio @code{/usr/share/python-wheels/} y no instala el paquete @code{ensurepip._bundled}.


Added in version 3.10.

@end deffn

@geindex opción de línea de comando; --with-pkg-config
@anchor{using/configure cmdoption-with-pkg-config}@anchor{1d7d}
@deffn {Option} @w{-}@w{-}with@w{-}pkg@w{-}config=[check|yes|no]

Si configure debe usar @code{pkg-config} para detectar dependencias de compilación.


@itemize *

@item 
@code{check} (predeterminado): @code{pkg-config} es opcional

@item 
@code{yes}: @code{pkg-config} es obligatorio

@item 
@code{no}: configure no usa @code{pkg-config} incluso cuando está presente
@end itemize


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; --enable-pystats
@anchor{using/configure cmdoption-enable-pystats}@anchor{17c3}
@deffn {Option} @w{-}@w{-}enable@w{-}pystats

Turn on internal Python performance statistics gathering.

By default, statistics gathering is off. Use @code{python3 -X pystats} command
or set @code{PYTHONSTATS=1} environment variable to turn on statistics
gathering at Python startup.

At Python exit, dump statistics if statistics gathering was on and not
cleared.

Efectos:


@itemize *

@item 
Add @ref{2e2,,-X pystats} command line option.

@item 
Add @code{PYTHONSTATS} environment variable.

@item 
Define the @code{Py_STATS} macro.

@item 
Add functions to the @ref{d9,,sys} module:


@itemize *

@item 
@code{sys._stats_on()}: Turns on statistics gathering.

@item 
@code{sys._stats_off()}: Turns off statistics gathering.

@item 
@code{sys._stats_clear()}: Clears the statistics.

@item 
@code{sys._stats_dump()}: Dump statistics to file, and clears the statistics.
@end itemize
@end itemize

The statistics will be dumped to a arbitrary (probably unique) file in
@code{/tmp/py_stats/} (Unix) or @code{C:\temp\py_stats\} (Windows). If that
directory does not exist, results will be printed on stderr.

Usa @code{Tools/scripts/summarize_stats.py} para leer las estadísticas.

Statistics:


@itemize *

@item 
Opcode:


@itemize *

@item 
Specialization: success, failure, hit, deferred, miss, deopt, failures;

@item 
Execution count;

@item 
Pair count.
@end itemize

@item 
Call:


@itemize *

@item 
Inlined Python calls;

@item 
PyEval calls;

@item 
Frames pushed;

@item 
Frame object created;

@item 
Eval calls: vector, generator, legacy, function VECTORCALL, build class,
slot, function «ex», API, method.
@end itemize

@item 
Object:


@itemize *

@item 
incref and decref;

@item 
interpreter incref and decref;

@item 
allocations: all, 512 bytes, 4 kiB, big;

@item 
free;

@item 
to/from free lists;

@item 
dictionary materialized/dematerialized;

@item 
type cache;

@item 
optimization attempts;

@item 
optimization traces created/executed;

@item 
uops executed.
@end itemize

@item 
Garbage collector:


@itemize *

@item 
Garbage collections;

@item 
Objects visited;

@item 
Objects collected.
@end itemize
@end itemize


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; --disable-gil
@anchor{using/configure free-threading-build}@anchor{1d7e}@anchor{using/configure cmdoption-disable-gil}@anchor{2e0}
@deffn {Option} @w{-}@w{-}disable@w{-}gil

Enables `experimental' support for running Python without the
@ref{2b5,,global interpreter lock} (GIL): free threading build.

Defines the @code{Py_GIL_DISABLED} macro and adds @code{"t"} to
@ref{af4,,sys.abiflags}.

See @ref{2ac,,Free-threaded CPython} for more detail.


Added in version 3.13.

@end deffn

@geindex opción de línea de comando; --enable-experimental-jit
@anchor{using/configure cmdoption-enable-experimental-jit}@anchor{1d7f}
@deffn {Option} @w{-}@w{-}enable@w{-}experimental@w{-}jit=[no|yes|yes@w{-}off|interpreter]

Indicate how to integrate the @ref{2ad,,JIT compiler}.


@itemize *

@item 
@code{no} - build the interpreter without the JIT.

@item 
@code{yes} - build the interpreter with the JIT.

@item 
@code{yes-off} - build the interpreter with the JIT but disable it by default.

@item 
@code{interpreter} - build the interpreter without the JIT, but with the tier 2 enabled interpreter.
@end itemize

By convention, @code{--enable-experimental-jit} is a shorthand for @code{--enable-experimental-jit=yes}.


Added in version 3.13.

@end deffn

@geindex opción de línea de comando; PKG_CONFIG
@anchor{using/configure cmdoption-arg-PKG_CONFIG}@anchor{1d80}
@deffn {Option} PKG_CONFIG

Path to @code{pkg-config} utility.
@end deffn

@geindex opción de línea de comando; PKG_CONFIG_LIBDIR
@anchor{using/configure cmdoption-arg-PKG_CONFIG_LIBDIR}@anchor{1d81}
@deffn {Option} PKG_CONFIG_LIBDIR
@end deffn

@geindex opción de línea de comando; PKG_CONFIG_PATH
@anchor{using/configure cmdoption-arg-PKG_CONFIG_PATH}@anchor{1d82}
@deffn {Option} PKG_CONFIG_PATH

@code{pkg-config} options.
@end deffn

@node C compiler options,Opciones del enlazador,Opciones generales,Configurar opciones
@anchor{using/configure c-compiler-options}@anchor{1d83}
@subsubsection C compiler options


@geindex opción de línea de comando; CC
@anchor{using/configure cmdoption-arg-CC}@anchor{1d84}
@deffn {Option} CC

Comando del compilador C.
@end deffn

@geindex opción de línea de comando; CFLAGS
@anchor{using/configure cmdoption-arg-CFLAGS}@anchor{1d85}
@deffn {Option} CFLAGS

Banderas del compilador de C.
@end deffn

@geindex opción de línea de comando; CPP
@anchor{using/configure cmdoption-arg-CPP}@anchor{1d86}
@deffn {Option} CPP

C preprocessor command.
@end deffn

@geindex opción de línea de comando; CPPFLAGS
@anchor{using/configure cmdoption-arg-CPPFLAGS}@anchor{1d87}
@deffn {Option} CPPFLAGS

C preprocessor flags, e.g. @code{-I@var{include_dir}}.
@end deffn

@node Opciones del enlazador,Options for third-party dependencies,C compiler options,Configurar opciones
@anchor{using/configure linker-options}@anchor{1d88}
@subsubsection Opciones del enlazador


@geindex opción de línea de comando; LDFLAGS
@anchor{using/configure cmdoption-arg-LDFLAGS}@anchor{1d89}
@deffn {Option} LDFLAGS

Linker flags, e.g. @code{-L@var{library_directory}}.
@end deffn

@geindex opción de línea de comando; LIBS
@anchor{using/configure cmdoption-arg-LIBS}@anchor{1d8a}
@deffn {Option} LIBS

Libraries to pass to the linker, e.g. @code{-l@var{library}}.
@end deffn

@geindex opción de línea de comando; MACHDEP
@anchor{using/configure cmdoption-arg-MACHDEP}@anchor{1d8b}
@deffn {Option} MACHDEP

Name for machine-dependent library files.
@end deffn

@node Options for third-party dependencies,Opciones de WebAssembly,Opciones del enlazador,Configurar opciones
@anchor{using/configure options-for-third-party-dependencies}@anchor{1d8c}
@subsubsection Options for third-party dependencies



Added in version 3.11.


@geindex opción de línea de comando; BZIP2_CFLAGS
@anchor{using/configure cmdoption-arg-BZIP2_CFLAGS}@anchor{1d8d}
@deffn {Option} BZIP2_CFLAGS
@end deffn

@geindex opción de línea de comando; BZIP2_LIBS
@anchor{using/configure cmdoption-arg-BZIP2_LIBS}@anchor{1d8e}
@deffn {Option} BZIP2_LIBS

C compiler and linker flags to link Python to @code{libbz2}, used by @ref{14,,bz2}
module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; CURSES_CFLAGS
@anchor{using/configure cmdoption-arg-CURSES_CFLAGS}@anchor{1d8f}
@deffn {Option} CURSES_CFLAGS
@end deffn

@geindex opción de línea de comando; CURSES_LIBS
@anchor{using/configure cmdoption-arg-CURSES_LIBS}@anchor{1d90}
@deffn {Option} CURSES_LIBS

C compiler and linker flags for @code{libncurses} or @code{libncursesw}, used by
@ref{2c,,curses} module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; GDBM_CFLAGS
@anchor{using/configure cmdoption-arg-GDBM_CFLAGS}@anchor{1d91}
@deffn {Option} GDBM_CFLAGS
@end deffn

@geindex opción de línea de comando; GDBM_LIBS
@anchor{using/configure cmdoption-arg-GDBM_LIBS}@anchor{1d92}
@deffn {Option} GDBM_LIBS

C compiler and linker flags for @code{gdbm}.
@end deffn

@geindex opción de línea de comando; LIBB2_CFLAGS
@anchor{using/configure cmdoption-arg-LIBB2_CFLAGS}@anchor{1d93}
@deffn {Option} LIBB2_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBB2_LIBS
@anchor{using/configure cmdoption-arg-LIBB2_LIBS}@anchor{1d94}
@deffn {Option} LIBB2_LIBS

C compiler and linker flags for @code{libb2} (@ref{1d95,,BLAKE2}),
used by @ref{68,,hashlib} module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBEDIT_CFLAGS
@anchor{using/configure cmdoption-arg-LIBEDIT_CFLAGS}@anchor{1d96}
@deffn {Option} LIBEDIT_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBEDIT_LIBS
@anchor{using/configure cmdoption-arg-LIBEDIT_LIBS}@anchor{1d97}
@deffn {Option} LIBEDIT_LIBS

C compiler and linker flags for @code{libedit}, used by @ref{ba,,readline} module,
overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBFFI_CFLAGS
@anchor{using/configure cmdoption-arg-LIBFFI_CFLAGS}@anchor{1d98}
@deffn {Option} LIBFFI_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBFFI_LIBS
@anchor{using/configure cmdoption-arg-LIBFFI_LIBS}@anchor{1d99}
@deffn {Option} LIBFFI_LIBS

C compiler and linker flags for @code{libffi}, used by @ref{2b,,ctypes} module,
overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBMPDEC_CFLAGS
@anchor{using/configure cmdoption-arg-LIBMPDEC_CFLAGS}@anchor{1d9a}
@deffn {Option} LIBMPDEC_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBMPDEC_LIBS
@anchor{using/configure cmdoption-arg-LIBMPDEC_LIBS}@anchor{1d9b}
@deffn {Option} LIBMPDEC_LIBS

C compiler and linker flags for @code{libmpdec}, used by @ref{37,,decimal} module,
overriding @code{pkg-config}.

@cartouche
@quotation Nota 
These environment variables have no effect unless
@ref{4d2,,--with-system-libmpdec} is specified.
@end quotation
@end cartouche
@end deffn

@geindex opción de línea de comando; LIBLZMA_CFLAGS
@anchor{using/configure cmdoption-arg-LIBLZMA_CFLAGS}@anchor{1d9c}
@deffn {Option} LIBLZMA_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBLZMA_LIBS
@anchor{using/configure cmdoption-arg-LIBLZMA_LIBS}@anchor{1d9d}
@deffn {Option} LIBLZMA_LIBS

C compiler and linker flags for @code{liblzma}, used by @ref{8a,,lzma} module,
overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBREADLINE_CFLAGS
@anchor{using/configure cmdoption-arg-LIBREADLINE_CFLAGS}@anchor{1d9e}
@deffn {Option} LIBREADLINE_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBREADLINE_LIBS
@anchor{using/configure cmdoption-arg-LIBREADLINE_LIBS}@anchor{1d9f}
@deffn {Option} LIBREADLINE_LIBS

C compiler and linker flags for @code{libreadline}, used by @ref{ba,,readline}
module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBSQLITE3_CFLAGS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_CFLAGS}@anchor{1da0}
@deffn {Option} LIBSQLITE3_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBSQLITE3_LIBS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_LIBS}@anchor{1da1}
@deffn {Option} LIBSQLITE3_LIBS

C compiler and linker flags for @code{libsqlite3}, used by @ref{cf,,sqlite3}
module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; LIBUUID_CFLAGS
@anchor{using/configure cmdoption-arg-LIBUUID_CFLAGS}@anchor{1da2}
@deffn {Option} LIBUUID_CFLAGS
@end deffn

@geindex opción de línea de comando; LIBUUID_LIBS
@anchor{using/configure cmdoption-arg-LIBUUID_LIBS}@anchor{1da3}
@deffn {Option} LIBUUID_LIBS

C compiler and linker flags for @code{libuuid}, used by @ref{110,,uuid} module,
overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; PANEL_CFLAGS
@anchor{using/configure cmdoption-arg-PANEL_CFLAGS}@anchor{1da4}
@deffn {Option} PANEL_CFLAGS
@end deffn

@geindex opción de línea de comando; PANEL_LIBS
@anchor{using/configure cmdoption-arg-PANEL_LIBS}@anchor{1da5}
@deffn {Option} PANEL_LIBS

C compiler and linker flags for PANEL, overriding @code{pkg-config}.

C compiler and linker flags for @code{libpanel} or @code{libpanelw}, used by
@ref{2e,,curses.panel} module, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; TCLTK_CFLAGS
@anchor{using/configure cmdoption-arg-TCLTK_CFLAGS}@anchor{1da6}
@deffn {Option} TCLTK_CFLAGS
@end deffn

@geindex opción de línea de comando; TCLTK_LIBS
@anchor{using/configure cmdoption-arg-TCLTK_LIBS}@anchor{1da7}
@deffn {Option} TCLTK_LIBS

C compiler and linker flags for TCLTK, overriding @code{pkg-config}.
@end deffn

@geindex opción de línea de comando; ZLIB_CFLAGS
@anchor{using/configure cmdoption-arg-ZLIB_CFLAGS}@anchor{1da8}
@deffn {Option} ZLIB_CFLAGS
@end deffn

@geindex opción de línea de comando; ZLIB_LIBS
@anchor{using/configure cmdoption-arg-ZLIB_LIBS}@anchor{1da9}
@deffn {Option} ZLIB_LIBS

C compiler and linker flags for @code{libzlib}, used by @ref{67,,gzip} module,
overriding @code{pkg-config}.
@end deffn

@node Opciones de WebAssembly,Opciones de instalación,Options for third-party dependencies,Configurar opciones
@anchor{using/configure webassembly-options}@anchor{1daa}
@subsubsection Opciones de WebAssembly


@geindex opción de línea de comando; --enable-wasm-dynamic-linking
@anchor{using/configure cmdoption-enable-wasm-dynamic-linking}@anchor{1834}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}dynamic@w{-}linking

Active la compatibilidad con enlaces dinámicos para WASM.

La vinculación dinámica habilita @code{dlopen}. El tamaño del archivo del ejecutable aumenta debido a la eliminación limitada de código muerto y características adicionales.


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; --enable-wasm-pthreads
@anchor{using/configure cmdoption-enable-wasm-pthreads}@anchor{1807}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}pthreads

Active la compatibilidad con pthreads para WASM.


Added in version 3.11.

@end deffn

@node Opciones de instalación,Opciones de desempeño,Opciones de WebAssembly,Configurar opciones
@anchor{using/configure install-options}@anchor{1dab}
@subsubsection Opciones de instalación


@geindex opción de línea de comando; --prefix
@anchor{using/configure cmdoption-prefix}@anchor{1d66}
@deffn {Option} @w{-}@w{-}prefix=PREFIX

Instala archivos independientes de la arquitectura en PREFIX. En Unix, el valor predeterminado es @code{/usr/local}.

Este valor se puede recuperar en tiempo de ejecución al usar @ref{281,,sys.prefix}.

Como ejemplo, se puede utilizar @code{--prefix="$HOME/.local/"} para instalar Python en su directorio raíz.
@end deffn

@geindex opción de línea de comando; --exec-prefix
@anchor{using/configure cmdoption-exec-prefix}@anchor{1d67}
@deffn {Option} @w{-}@w{-}exec@w{-}prefix=EPREFIX

Instala archivos independientes de la arquitectura en EPREFIX, el valor predeterminado es @ref{1d66,,--prefix}.

Este valor se puede recuperar en tiempo de ejecución al usar @ref{27c,,sys.exec_prefix}.
@end deffn

@geindex opción de línea de comando; --disable-test-modules
@anchor{using/configure cmdoption-disable-test-modules}@anchor{924}
@deffn {Option} @w{-}@w{-}disable@w{-}test@w{-}modules

No construya ni instale módulos de prueba, como el paquete @ref{e2,,test} o el módulo de extensión @code{_testcapi} (construido e instalado por defecto).


Added in version 3.10.

@end deffn

@geindex opción de línea de comando; --with-ensurepip
@anchor{using/configure cmdoption-with-ensurepip}@anchor{1dac}
@deffn {Option} @w{-}@w{-}with@w{-}ensurepip=[upgrade|install|no]

Selecciona el comando @ref{55,,ensurepip} que se ejecuta en la instalación de Python:


@itemize *

@item 
@code{upgrade} (por defecto): ejecutar el comando @code{python -m ensurepip --altinstall --upgrade}.

@item 
@code{install}: ejecutar el comando @code{python -m ensurepip --altinstall};

@item 
@code{no}: no ejecuta ensurepip;
@end itemize


Added in version 3.6.

@end deffn

@node Opciones de desempeño,Compilación de depuración de Python,Opciones de instalación,Configurar opciones
@anchor{using/configure performance-options}@anchor{1dad}
@subsubsection Opciones de desempeño


Se recomienda configurar Python usando @code{--enable-optimizations --with-lto} (PGO + LTO) para obtener el mejor rendimiento. El indicador experimental @code{--enable-bolt} también se puede usar para mejorar el rendimiento.

@geindex opción de línea de comando; --enable-optimizations
@anchor{using/configure cmdoption-enable-optimizations}@anchor{8f9}
@deffn {Option} @w{-}@w{-}enable@w{-}optimizations

Habilite la Optimización Guiada por Perfiles (`PGO' por sus siglas en inglés) usando 
@geindex PROFILE_TASK
@geindex variables de entorno; PROFILE_TASK
@ref{1716,,PROFILE_TASK} (deshabilitado de forma predeterminada).

El compilador de C Clang requiere el programa @code{llvm-profdata} para PGO. En macOS, GCC también lo requiere: GCC es solo un alias de Clang en macOS.

Desactiva también la interposición semántica en libpython si se usa @code{--enable-shared} y GCC: agregar @code{-fno-semantic-interposition} a los flags del compilador y del enlazador.

@cartouche
@quotation Nota 
During the build, you may encounter compiler warnings about
profile data not being available for some source files.
These warnings are harmless, as only a subset of the code is exercised
during profile data acquisition.
To disable these warnings on Clang, manually suppress them by adding
@code{-Wno-profile-instr-unprofiled} to 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS}.
@end quotation
@end cartouche


Added in version 3.6.



Distinto en la versión 3.10: Usar @code{-fno-semantic-interposition} en GCC.

@end deffn

@geindex variables de entorno; PROFILE_TASK
@anchor{using/configure envvar-PROFILE_TASK}@anchor{1716}
@deffn {Variables De Entorno} PROFILE_TASK

Variable de entorno utilizada en el Makefile: argumentos de la línea de comando Python para la tarea de generación de PGO.

Por defecto: @code{-m test --pgo --timeout=$(TESTTIMEOUT)}.


Added in version 3.8.



Distinto en la versión 3.13: Task failure is no longer ignored silently.

@end deffn

@geindex opción de línea de comando; --with-lto
@anchor{using/configure cmdoption-with-lto}@anchor{7e6}
@deffn {Option} @w{-}@w{-}with@w{-}lto=[full|thin|no|yes]

Habilita la Optimización de Tiempo de Enlace (`LTO' por sus siglas en inglés) en cualquier compilación (deshabilitado de forma predeterminada).

El compilador de C Clang requiere @code{llvm-ar} para LTO (@code{ar} en macOS), así como un enlazador compatible con LTO (@code{ld.gold} o @code{lld}).


Added in version 3.6.



Added in version 3.11: Para usar la función ThinLTO, use @code{--with-lto=thin} en Clang.



Distinto en la versión 3.12: Utiliza ThinLTO como política de optimización predeterminada en Clang si el compilador acepta el indicador.

@end deffn

@geindex opción de línea de comando; --enable-bolt
@anchor{using/configure cmdoption-enable-bolt}@anchor{1dae}
@deffn {Option} @w{-}@w{-}enable@w{-}bolt

Habilita el uso del optimizador binario post-enlace BOLT@footnote{https://github.com/llvm/llvm-project/tree/main/bolt} (deshabilitado de forma predeterminada).

BOLT es parte del proyecto LLVM pero no siempre se incluye en sus distribuciones binarias. Este indicador necesita que @code{llvm-bolt} y @code{merge-fdata} estén disponibles.

BOLT aún es un proyecto bastante nuevo, así que este indicador debería considerarse experimental por ahora. Debido a que esta herramienta opera en código máquina, su éxito depende de una combinación del entorno de compilación + los otros argumentos de configuración de optimización + la arquitectura del CPU, y no todas las combinaciones son compatibles. Se sabe que las versiones de BOLT anteriores a LLVM 16 bloquean BOLT en algunos escenarios. Se recomienda encarecidamente utilizar LLVM 16 o posterior para la optimización de BOLT.

Las variables @code{configure} @code{BOLT_INSTRUMENT_FLAGS} y @code{BOLT_APPLY_FLAGS} se pueden definir para sobrescribir el conjunto predeterminado de argumentos de @code{llvm-bolt} para instrumentar y aplicar datos BOLT a binarios, respectivamente.


Added in version 3.12.

@end deffn

@geindex opción de línea de comando; BOLT_APPLY_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_APPLY_FLAGS}@anchor{1daf}
@deffn {Option} BOLT_APPLY_FLAGS

Arguments to @code{llvm-bolt} when creating a BOLT optimized binary@footnote{https://github.com/facebookarchive/BOLT}.


Added in version 3.12.

@end deffn

@geindex opción de línea de comando; BOLT_INSTRUMENT_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_INSTRUMENT_FLAGS}@anchor{1db0}
@deffn {Option} BOLT_INSTRUMENT_FLAGS

Arguments to @code{llvm-bolt} when instrumenting binaries.


Added in version 3.12.

@end deffn

@geindex opción de línea de comando; --with-computed-gotos
@anchor{using/configure cmdoption-with-computed-gotos}@anchor{1db1}
@deffn {Option} @w{-}@w{-}with@w{-}computed@w{-}gotos

Habilita los `gotos' calculados en el ciclo de evaluación (habilitado de forma predeterminada en los compiladores compatibles).
@end deffn

@geindex opción de línea de comando; --without-mimalloc
@anchor{using/configure cmdoption-without-mimalloc}@anchor{1db2}
@deffn {Option} @w{-}@w{-}without@w{-}mimalloc

Disable the fast @ref{1d58,,mimalloc} allocator
(enabled by default).

Consultar también la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC}.
@end deffn

@geindex opción de línea de comando; --without-pymalloc
@anchor{using/configure cmdoption-without-pymalloc}@anchor{1db3}
@deffn {Option} @w{-}@w{-}without@w{-}pymalloc

Deshabilita el asignador de memoria especializado de Python @ref{d96,,pymalloc} (habilitado de forma predeterminada).

Consultar también la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC}.
@end deffn

@geindex opción de línea de comando; --without-doc-strings
@anchor{using/configure cmdoption-without-doc-strings}@anchor{1db4}
@deffn {Option} @w{-}@w{-}without@w{-}doc@w{-}strings

Deshabilita las cadenas de caracteres de documentación estáticas para reducir el espacio de memoria (habilitado de forma predeterminada). Las cadenas de caracteres de documentación definidas en Python no se ven afectadas.

No define la macro @code{WITH_DOC_STRINGS}.

Consultar la macro @code{PyDoc_STRVAR()}.
@end deffn

@geindex opción de línea de comando; --enable-profiling
@anchor{using/configure cmdoption-enable-profiling}@anchor{1db5}
@deffn {Option} @w{-}@w{-}enable@w{-}profiling

Habilita el análisis de rendimiento de código (`profiling') de nivel C con @code{gprof} (deshabilitado de forma predeterminada).
@end deffn

@geindex opción de línea de comando; --with-strict-overflow
@anchor{using/configure cmdoption-with-strict-overflow}@anchor{176a}
@deffn {Option} @w{-}@w{-}with@w{-}strict@w{-}overflow

Agrega @code{-fstrict-overflow} a los indicadores del compilador de C (el valor predeterminado que agregamos en su lugar es @code{-fno-strict-overflow}).
@end deffn

@node Compilación de depuración de Python,Opciones de depuración,Opciones de desempeño,Configurar opciones
@anchor{using/configure debug-build}@anchor{357}@anchor{using/configure python-debug-build}@anchor{1db6}
@subsubsection Compilación de depuración de Python


Una compilación de depuración es Python construido con la opción de configuración @ref{4e0,,--with-pydebug}.

Efectos de una compilación de depuración:


@itemize *

@item 
Muestra todas las advertencias de forma predeterminada: la lista de filtros de advertencia predeterminados está vacía en el módulo @ref{112,,warnings}.

@item 
Agrega @code{d} a @ref{af4,,sys.abiflags}.

@item 
Agrega la función @code{sys.gettotalrefcount()}.

@item 
Agrega la opción de línea de comando @ref{2e2,,-X showrefcount}.

@item 
Agrega la opción de línea de comando @ref{1d37,,-d} y la variable de entorno 
@geindex PYTHONDEBUG
@geindex variables de entorno; PYTHONDEBUG
@ref{1d38,,PYTHONDEBUG} para depurar el analizador.

@item 
Agregue soporte para la variable @code{__lltrace__}: habilite el seguimiento de bajo nivel en el ciclo de evaluación del código de bytes si la variable está definida.

@item 
Instala @ref{1d56,,ganchos de depuración en los asignadores de memoria} para detectar el desbordamiento del búfer y otros errores de memoria.

@item 
Define las macros @code{Py_DEBUG} y @code{Py_REF_DEBUG}.

@item 
Agregue verificaciones de tiempo de ejecución: código rodeado por @code{#ifdef Py_DEBUG} y @code{#endif}. Habilite las aserciones @code{assert(...)} y @code{_PyObject_ASSERT(...)}: no configure la macro @code{NDEBUG} (vea también la opción de configuración @ref{47e,,--with-assertions}). Comprobaciones principales de tiempo de ejecución:


@itemize *

@item 
Agregue controles de sanidad en los argumentos de la función.

@item 
Los objetos unicode e int se crean con su memoria completa con un patrón para detectar el uso de objetos no inicializados.

@item 
Asegúrese de que las funciones que pueden borrar o reemplazar la excepción actual no se invocan con una excepción lanzada.

@item 
Verifique que las funciones de desasignador no cambien la excepción actual.

@item 
El recolector de basura (función @ref{acc,,gc.collect()}) ejecuta algunas comprobaciones básicas sobre la consistencia de los objetos.

@item 
La macro @code{Py_SAFE_DOWNCAST()} comprueba el subdesbordamiento y el desbordamiento de enteros al realizar una conversión descendente de tipos anchos a tipos estrechos.
@end itemize
@end itemize

Consultar también @ref{356,,Modo de Desarrollo de Python} y la opción de configuración @ref{487,,--with-trace-refs}.


Distinto en la versión 3.8: Release builds and debug builds are now ABI compatible: defining the
@code{Py_DEBUG} macro no longer implies the @code{Py_TRACE_REFS} macro (see the
@ref{487,,--with-trace-refs} option).


@node Opciones de depuración,Opciones del enlazador<2>,Compilación de depuración de Python,Configurar opciones
@anchor{using/configure debug-options}@anchor{1db7}
@subsubsection Opciones de depuración


@geindex opción de línea de comando; --with-pydebug
@anchor{using/configure cmdoption-with-pydebug}@anchor{4e0}
@deffn {Option} @w{-}@w{-}with@w{-}pydebug

@ref{357,,Compila Python en modo de depuración}: define la macro @code{Py_DEBUG} (deshabilitada por defecto).
@end deffn

@geindex opción de línea de comando; --with-trace-refs
@anchor{using/configure cmdoption-with-trace-refs}@anchor{487}
@deffn {Option} @w{-}@w{-}with@w{-}trace@w{-}refs

Habilita las referencias de seguimiento con fines de depuración (deshabilitado de forma predeterminada).

Efectos:


@itemize *

@item 
Define la macro @code{Py_TRACE_REFS}.

@item 
Add @ref{1b5,,sys.getobjects()} function.

@item 
Agrega la variable de entorno 
@geindex PYTHONDUMPREFS
@geindex variables de entorno; PYTHONDUMPREFS
@ref{a38,,PYTHONDUMPREFS}.
@end itemize

The 
@geindex PYTHONDUMPREFS
@geindex variables de entorno; PYTHONDUMPREFS
@ref{a38,,PYTHONDUMPREFS} environment variable can be used to dump
objects and reference counts still alive at Python exit.

@ref{819,,Statically allocated objects} are not traced.


Added in version 3.8.



Distinto en la versión 3.13: This build is now ABI compatible with release build and @ref{357,,debug build}.

@end deffn

@geindex opción de línea de comando; --with-assertions
@anchor{using/configure cmdoption-with-assertions}@anchor{47e}
@deffn {Option} @w{-}@w{-}with@w{-}assertions

Compila con las aserciones de C habilitadas (el valor predeterminado es no): @code{assert(...);} y @code{_PyObject_ASSERT(...);}.

Si se establece, la macro @code{NDEBUG} no está definida en la variable del compilador 
@geindex OPT
@geindex variables de entorno; OPT
@ref{1db8,,OPT}.

Consultar también la opción @ref{4e0,,--with-pydebug} (@ref{357,,compilación de depuración}) que también habilita las aserciones.


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --with-valgrind
@anchor{using/configure cmdoption-with-valgrind}@anchor{1db9}
@deffn {Option} @w{-}@w{-}with@w{-}valgrind

Habilite la compatibilidad con Valgrind (el valor predeterminado es no).
@end deffn

@geindex opción de línea de comando; --with-dtrace
@anchor{using/configure cmdoption-with-dtrace}@anchor{1dba}
@deffn {Option} @w{-}@w{-}with@w{-}dtrace

Habilite la compatibilidad con DTrace (el valor predeterminado es no).

Consultar @ref{cf4,,Instrumentación de CPython con DTrace y SystemTap}.


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --with-address-sanitizer
@anchor{using/configure cmdoption-with-address-sanitizer}@anchor{1dbb}
@deffn {Option} @w{-}@w{-}with@w{-}address@w{-}sanitizer

Habilita el detector de errores de memoria AddressSanitizer, @code{asan} (el valor predeterminado es no).


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --with-memory-sanitizer
@anchor{using/configure cmdoption-with-memory-sanitizer}@anchor{1dbc}
@deffn {Option} @w{-}@w{-}with@w{-}memory@w{-}sanitizer

Habilita el detector de errores de asignación MemorySanitizer, @code{msan} (el valor predeterminado es no).


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --with-undefined-behavior-sanitizer
@anchor{using/configure cmdoption-with-undefined-behavior-sanitizer}@anchor{1dbd}
@deffn {Option} @w{-}@w{-}with@w{-}undefined@w{-}behavior@w{-}sanitizer

Habilita el detector de comportamiento indefinido UndefinedBehaviorSanitizer, @code{ubsan} (el valor predeterminado es no).


Added in version 3.6.

@end deffn

@geindex opción de línea de comando; --with-thread-sanitizer
@anchor{using/configure cmdoption-with-thread-sanitizer}@anchor{1dbe}
@deffn {Option} @w{-}@w{-}with@w{-}thread@w{-}sanitizer

Enable ThreadSanitizer data race detector, @code{tsan}
(default is no).


Added in version 3.13.

@end deffn

@node Opciones del enlazador<2>,Opciones de bibliotecas,Opciones de depuración,Configurar opciones
@anchor{using/configure id2}@anchor{1dbf}
@subsubsection Opciones del enlazador


@geindex opción de línea de comando; --enable-shared
@anchor{using/configure cmdoption-enable-shared}@anchor{8fa}
@deffn {Option} @w{-}@w{-}enable@w{-}shared

Habilita la compilación de una biblioteca compartida de Python :@code{libpython} (el valor predeterminado es no).
@end deffn

@geindex opción de línea de comando; --without-static-libpython
@anchor{using/configure cmdoption-without-static-libpython}@anchor{926}
@deffn {Option} @w{-}@w{-}without@w{-}static@w{-}libpython

No compila @code{libpythonMAJOR.MINOR.a} y no instala @code{python.o} (compilado y habilitado de forma predeterminada).


Added in version 3.10.

@end deffn

@node Opciones de bibliotecas,Opciones de seguridad,Opciones del enlazador<2>,Configurar opciones
@anchor{using/configure libraries-options}@anchor{1dc0}
@subsubsection Opciones de bibliotecas


@geindex opción de línea de comando; --with-libs
@anchor{using/configure cmdoption-with-libs}@anchor{1dc1}
@deffn {Option} @w{-}@w{-}with@w{-}libs='lib1 ...'

Enlace con bibliotecas adicionales (el valor predeterminado es no).
@end deffn

@geindex opción de línea de comando; --with-system-expat
@anchor{using/configure cmdoption-with-system-expat}@anchor{17ba}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}expat

Compila el módulo @code{pyexpat} usando la biblioteca instalada @code{expat} instalada (por defecto es no).
@end deffn

@geindex opción de línea de comando; --with-system-libmpdec
@anchor{using/configure cmdoption-with-system-libmpdec}@anchor{4d2}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}libmpdec

Build the @code{_decimal} extension module using an installed @code{mpdecimal}
library, see the @ref{37,,decimal} module (default is yes).


Added in version 3.3.



Distinto en la versión 3.13: Default to using the installed @code{mpdecimal} library.



Deprecated since version 3.13, will be removed in version 3.15: A copy of the @code{mpdecimal} library sources will no longer be distributed
with Python 3.15.



@subsubheading Ver también


@ref{1d9a,,LIBMPDEC_CFLAGS} and @ref{1d9b,,LIBMPDEC_LIBS}.

@end deffn

@geindex opción de línea de comando; --with-readline
@anchor{using/configure cmdoption-with-readline}@anchor{1dc2}
@deffn {Option} @w{-}@w{-}with@w{-}readline=readline|editline

Designate a backend library for the @ref{ba,,readline} module.


@itemize *

@item 
readline: Use readline as the backend.

@item 
editline: Use editline as the backend.
@end itemize


Added in version 3.10.

@end deffn

@geindex opción de línea de comando; --without-readline
@anchor{using/configure cmdoption-without-readline}@anchor{1dc3}
@deffn {Option} @w{-}@w{-}without@w{-}readline

No cree el módulo @ref{ba,,readline} (es construido por defecto).

No defina la macro @code{HAVE_LIBREADLINE}.


Added in version 3.10.

@end deffn

@geindex opción de línea de comando; --with-libm
@anchor{using/configure cmdoption-with-libm}@anchor{1dc4}
@deffn {Option} @w{-}@w{-}with@w{-}libm=STRING

Sobreescribe la biblioteca matemática @code{libm} a `STRING' (el valor predeterminado es dependiente del sistema).
@end deffn

@geindex opción de línea de comando; --with-libc
@anchor{using/configure cmdoption-with-libc}@anchor{1dc5}
@deffn {Option} @w{-}@w{-}with@w{-}libc=STRING

Sobreescribe la biblioteca C @code{libc} a `STRING' (el valor predeterminado es dependiente del sistema).
@end deffn

@geindex opción de línea de comando; --with-openssl
@anchor{using/configure cmdoption-with-openssl}@anchor{1dc6}
@deffn {Option} @w{-}@w{-}with@w{-}openssl=DIR

Raíz del directorio OpenSSL.


Added in version 3.7.

@end deffn

@geindex opción de línea de comando; --with-openssl-rpath
@anchor{using/configure cmdoption-with-openssl-rpath}@anchor{927}
@deffn {Option} @w{-}@w{-}with@w{-}openssl@w{-}rpath=[no|auto|DIR]

Configura el directorio de la biblioteca en tiempo de ejecución (rpath) para las bibliotecas OpenSSL:


@itemize *

@item 
@code{no} (por defecto): no establece rpath;

@item 
@code{auto}: autodetecta rpath desde @ref{1dc6,,--with-openssl} y @code{pkg-config};

@item 
`DIR': establece un rpath explícito.
@end itemize


Added in version 3.10.

@end deffn

@node Opciones de seguridad,Opciones macOS,Opciones de bibliotecas,Configurar opciones
@anchor{using/configure security-options}@anchor{1dc7}
@subsubsection Opciones de seguridad


@geindex opción de línea de comando; --with-hash-algorithm
@anchor{using/configure cmdoption-with-hash-algorithm}@anchor{1dc8}
@deffn {Option} @w{-}@w{-}with@w{-}hash@w{-}algorithm=[fnv|siphash13|siphash24]

Selecciona el algoritmo hash para usar en @code{Python/pyhash.c}:


@itemize *

@item 
@code{siphash13} (por defecto);

@item 
@code{siphash24};

@item 
@code{fnv}.
@end itemize


Added in version 3.4.



Added in version 3.11: Se agrega @code{siphash13} y es el nuevo valor predeterminado.

@end deffn

@geindex opción de línea de comando; --with-builtin-hashlib-hashes
@anchor{using/configure cmdoption-with-builtin-hashlib-hashes}@anchor{1dc9}
@deffn {Option} @w{-}@w{-}with@w{-}builtin@w{-}hashlib@w{-}hashes=md5,sha1,sha256,sha512,sha3,blake2

Módulos hash incorporados:


@itemize *

@item 
@code{md5};

@item 
@code{sha1};

@item 
@code{sha256};

@item 
@code{sha512};

@item 
@code{sha3} (con shake);

@item 
@code{blake2}.
@end itemize


Added in version 3.9.

@end deffn

@geindex opción de línea de comando; --with-ssl-default-suites
@anchor{using/configure cmdoption-with-ssl-default-suites}@anchor{1dca}
@deffn {Option} @w{-}@w{-}with@w{-}ssl@w{-}default@w{-}suites=[python|openssl|STRING]

Sobreescribe la cadena de conjuntos de cifrado predeterminada de OpenSSL:


@itemize *

@item 
@code{python} (por defecto): usa la selección principal de Python;

@item 
@code{openssl}: deja intactos los valores predeterminados de OpenSSL;

@item 
`STRING': usa una cadena de caracteres personalizada
@end itemize

Consultar el módulo @ref{d0,,ssl}.


Added in version 3.7.



Distinto en la versión 3.10: Las configuraciones @code{python} y `STRING' también establecen TLS 1.2 como versión mínima del protocolo.

@end deffn

@geindex opción de línea de comando; --disable-safety
@anchor{using/configure cmdoption-disable-safety}@anchor{1dcb}
@deffn {Option} @w{-}@w{-}disable@w{-}safety

Disable compiler options that are recommended by OpenSSF@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md} for security reasons with no performance overhead.
If this option is not enabled, CPython will be built based on safety compiler options with no slow down.
When this option is enabled, CPython will not be built with the compiler options listed below.

The following compiler options are disabled with @code{--disable-safety}:


@itemize *

@item 
-fstack-protector-strong@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#enable-run-time-checks-for-stack-based-buffer-overflows}: Enable run-time checks for stack-based buffer overflows.

@item 
-Wtrampolines@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#enable-warning-about-trampolines-that-require-executable-stacks}: Enable warnings about trampolines that require executable stacks.
@end itemize


Added in version 3.14.

@end deffn

@geindex opción de línea de comando; --enable-slower-safety
@anchor{using/configure cmdoption-enable-slower-safety}@anchor{1dcc}
@deffn {Option} @w{-}@w{-}enable@w{-}slower@w{-}safety

Enable compiler options that are recommended by OpenSSF@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md} for security reasons which require overhead.
If this option is not enabled, CPython will not be built based on safety compiler options which performance impact.
When this option is enabled, CPython will be built with the compiler options listed below.

The following compiler options are enabled with @code{--enable-slower-safety}:


@itemize *

@item 
-D_FORTIFY_SOURCE=3@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#fortify-sources-for-unsafe-libc-usage-and-buffer-overflows}: Fortify sources with compile- and run-time checks for unsafe libc usage and buffer overflows.
@end itemize


Added in version 3.14.

@end deffn

@node Opciones macOS,iOS Options,Opciones de seguridad,Configurar opciones
@anchor{using/configure macos-options}@anchor{1dcd}
@subsubsection Opciones macOS


See Mac/README.rst@footnote{https://github.com/python/cpython/tree/main/Mac/README.rst}.

@geindex opción de línea de comando; --enable-universalsdk
@anchor{using/configure cmdoption-enable-universalsdk}@anchor{9fd}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk
@end deffn

@geindex opción de línea de comando; --enable-universalsdk
@anchor{using/configure cmdoption-0}@anchor{1dce}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk=SDKDIR

Crea una compilación binaria universal. `SDKDIR' especifica qué macOS SDK debe usarse para realizar la compilación (el valor predeterminado es no).
@end deffn

@geindex opción de línea de comando; --enable-framework
@anchor{using/configure cmdoption-enable-framework}@anchor{1dcf}
@deffn {Option} @w{-}@w{-}enable@w{-}framework
@end deffn

@geindex opción de línea de comando; --enable-framework
@anchor{using/configure cmdoption-1}@anchor{1dd0}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

Crear un Python.framework en lugar de una instalación Unix tradicional. Opcionalmente `INSTALLDIR' especifica la ruta de instalación (el valor predeterminado es no).
@end deffn

@geindex opción de línea de comando; --with-universal-archs
@anchor{using/configure cmdoption-with-universal-archs}@anchor{1dd1}
@deffn {Option} @w{-}@w{-}with@w{-}universal@w{-}archs=ARCH

Especifique el tipo de binario universal que se debe crear. Esta opción solo es válida cuando se establece @ref{9fd,,--enable-universalsdk}.

Opciones:


@itemize *

@item 
@code{universal2};

@item 
@code{32-bit};

@item 
@code{64-bit};

@item 
@code{3-way};

@item 
@code{intel};

@item 
@code{intel-32};

@item 
@code{intel-64};

@item 
@code{all}.
@end itemize
@end deffn

@geindex opción de línea de comando; --with-framework-name
@anchor{using/configure cmdoption-with-framework-name}@anchor{1dd2}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

Especifica el nombre del framework de Python en macOS, solo es válido cuando @ref{1dcf,,--enable-framework} está configurada (por defecto: @code{Python}).
@end deffn

@geindex opción de línea de comando; --with-app-store-compliance
@anchor{using/configure cmdoption-with-app-store-compliance}@anchor{162e}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance
@end deffn

@geindex opción de línea de comando; --with-app-store-compliance
@anchor{using/configure cmdoption-2}@anchor{1dd3}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance=PATCH@w{-}FILE

The Python standard library contains strings that are known to trigger
automated inspection tool errors when submitted for distribution by
the macOS and iOS App Stores. If enabled, this option will apply the list of
patches that are known to correct app store compliance. A custom patch
file can also be specified. This option is disabled by default.


Added in version 3.13.

@end deffn

@node iOS Options,Opciones de compilación cruzada,Opciones macOS,Configurar opciones
@anchor{using/configure ios-options}@anchor{1dd4}
@subsubsection iOS Options


See iOS/README.rst@footnote{https://github.com/python/cpython/tree/main/iOS/README.rst}.

@geindex opción de línea de comando; --enable-framework
@anchor{using/configure cmdoption-3}@anchor{1dd5}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

Create a Python.framework. Unlike macOS, the `INSTALLDIR' argument
specifying the installation path is mandatory.
@end deffn

@geindex opción de línea de comando; --with-framework-name
@anchor{using/configure cmdoption-4}@anchor{1dd6}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

Specify the name for the framework (default: @code{Python}).
@end deffn

@node Opciones de compilación cruzada,,iOS Options,Configurar opciones
@anchor{using/configure cross-compiling-options}@anchor{1dd7}
@subsubsection Opciones de compilación cruzada


La compilación cruzada, también conocida como construcción cruzada, se puede usar para construir Python para otra plataforma o arquitectura de CPU. La compilación cruzada requiere un intérprete de Python para la plataforma de compilación. La versión de Python de compilación debe coincidir con la versión de Python host de compilación cruzada.

@geindex opción de línea de comando; --build
@anchor{using/configure cmdoption-build}@anchor{1dd8}
@deffn {Option} @w{-}@w{-}build=BUILD

configure para construir en BUILD, generalmente adivinado por @code{config.guess}.
@end deffn

@geindex opción de línea de comando; --host
@anchor{using/configure cmdoption-host}@anchor{1dd9}
@deffn {Option} @w{-}@w{-}host=HOST

compilación cruzada para crear programas que se ejecuten en HOST (plataforma de destino)
@end deffn

@geindex opción de línea de comando; --with-build-python
@anchor{using/configure cmdoption-with-build-python}@anchor{1dda}
@deffn {Option} @w{-}@w{-}with@w{-}build@w{-}python=path/to/python

ruta para construir el binario @code{python} para compilación cruzada


Added in version 3.11.

@end deffn

@geindex opción de línea de comando; CONFIG_SITE
@anchor{using/configure cmdoption-arg-CONFIG_SITE}@anchor{1ddb}
@deffn {Option} CONFIG_SITE=file

Una variable de entorno que apunta a un archivo con anulaciones de configuración.

Example `config.site' file:

@example
# config.site-aarch64
ac_cv_buggy_getaddrinfo=no
ac_cv_file__dev_ptmx=yes
ac_cv_file__dev_ptc=no
@end example
@end deffn

@geindex opción de línea de comando; HOSTRUNNER
@anchor{using/configure cmdoption-arg-HOSTRUNNER}@anchor{1ddc}
@deffn {Option} HOSTRUNNER

Program to run CPython for the host platform for cross-compilation.


Added in version 3.11.

@end deffn

Ejemplo de compilación cruzada:

@example
CONFIG_SITE=config.site-aarch64 ../configure \
    --build=x86_64-pc-linux-gnu \
    --host=aarch64-unknown-linux-gnu \
    --with-build-python=../x86_64/python
@end example

@node Sistema de compilación Python,Banderas de compilador y vinculación,Configurar opciones,Configurar Python
@anchor{using/configure python-build-system}@anchor{1ddd}
@subsection Sistema de compilación Python


@menu
* Archivos principales del sistema de compilación:: 
* Pasos principales de compilación:: 
* Objetivos principales de Makefile:: 
* Extensiones C:: 

@end menu

@node Archivos principales del sistema de compilación,Pasos principales de compilación,,Sistema de compilación Python
@anchor{using/configure main-files-of-the-build-system}@anchor{1dde}
@subsubsection Archivos principales del sistema de compilación



@itemize *

@item 
@code{configure.ac} => @code{configure};

@item 
@code{Makefile.pre.in} => @code{Makefile} (creado por @code{configure});

@item 
@code{pyconfig.h} (creado por @code{configure});

@item 
@code{Modules/Setup}: Extensiones C creadas por Makefile usando el script de shell @code{Module/makesetup};
@end itemize

@node Pasos principales de compilación,Objetivos principales de Makefile,Archivos principales del sistema de compilación,Sistema de compilación Python
@anchor{using/configure main-build-steps}@anchor{1ddf}
@subsubsection Pasos principales de compilación



@itemize *

@item 
Los archivos C (@code{.c}) se crean como archivos objeto (@code{.o}).

@item 
La biblioteca estática @code{libpython} (@code{.a}) se crea a a partir de archivos de objetos.

@item 
@code{python.o} y la biblioteca estática @code{libpython} están enlazadas al programa final @code{python}.

@item 
Las extensiones C son creadas por Makefile (ver @code{Modules/Setup}).
@end itemize

@node Objetivos principales de Makefile,Extensiones C,Pasos principales de compilación,Sistema de compilación Python
@anchor{using/configure main-makefile-targets}@anchor{1de0}
@subsubsection Objetivos principales de Makefile


@menu
* make:: 
* make platform:: 
* make profile-opt:: 
* make clean:: 
* make distclean:: 
* make install:: 
* make test:: 
* make ci:: 
* make buildbottest:: 
* make regen-all:: 

@end menu

@node make,make platform,,Objetivos principales de Makefile
@anchor{using/configure make}@anchor{1de1}
@subsubsection make


For the most part, when rebuilding after editing some code or
refreshing your checkout from upstream, all you need to do is execute
@code{make}, which (per Make’s semantics) builds the default target, the
first one defined in the Makefile.  By tradition (including in the
CPython project) this is usually the @code{all} target. The
@code{configure} script expands an @code{autoconf} variable,
@code{@@DEF_MAKE_ALL_RULE@@} to describe precisely which targets @code{make
all} will build. The three choices are:


@itemize *

@item 
@code{profile-opt} (configured with @code{--enable-optimizations})

@item 
@code{build_wasm} (chosen if the host platform matches @code{wasm32-wasi*} or
@code{wasm32-emscripten})

@item 
@code{build_all} (configured without explicitly using either of the others)
@end itemize

Depending on the most recent source file changes, Make will rebuild
any targets (object files and executables) deemed out-of-date,
including running @code{configure} again if necessary. Source/target
dependencies are many and maintained manually however, so Make
sometimes doesn’t have all the information necessary to correctly
detect all targets which need to be rebuilt.  Depending on which
targets aren’t rebuilt, you might experience a number of problems. If
you have build or test problems which you can’t otherwise explain,
@code{make clean && make} should work around most dependency problems, at
the expense of longer build times.

@node make platform,make profile-opt,make,Objetivos principales de Makefile
@anchor{using/configure make-platform}@anchor{1de2}
@subsubsection make platform


Build the @code{python} program, but don’t build the standard library
extension modules. This generates a file named @code{platform} which
contains a single line describing the details of the build platform,
e.g., @code{macosx-14.3-arm64-3.12} or @code{linux-x86_64-3.13}.

@node make profile-opt,make clean,make platform,Objetivos principales de Makefile
@anchor{using/configure make-profile-opt}@anchor{1de3}
@subsubsection make profile-opt


Build Python using profile-guided optimization (PGO).  You can use the
configure @ref{8f9,,--enable-optimizations} option to make this the
default target of the @code{make} command (@code{make all} or just
@code{make}).

@node make clean,make distclean,make profile-opt,Objetivos principales de Makefile
@anchor{using/configure make-clean}@anchor{1de4}
@subsubsection make clean


Remove built files.

@node make distclean,make install,make clean,Objetivos principales de Makefile
@anchor{using/configure make-distclean}@anchor{1de5}
@subsubsection make distclean


In addition to the work done by @code{make clean}, remove files
created by the configure script.  @code{configure} will have to be run
before building again. @footnote{
@code{git clean -fdx} is an even more extreme way to «clean» your
checkout. It removes all files not known to Git.
When bug hunting using @code{git bisect}, this is
@uref{https://github.com/python/cpython/issues/114505#issuecomment-1907021718,recommended between probes}
to guarantee a completely clean build. `Use with care', as it
will delete all files not checked into Git, including your
new, uncommitted work.
}

@node make install,make test,make distclean,Objetivos principales de Makefile
@anchor{using/configure make-install}@anchor{1de6}
@subsubsection make install


Build the @code{all} target and install Python.

@node make test,make ci,make install,Objetivos principales de Makefile
@anchor{using/configure make-test}@anchor{1de7}
@subsubsection make test


Build the @code{all} target and run the Python test suite with the
@code{--fast-ci} option without GUI tests. Variables:


@itemize *

@item 
@code{TESTOPTS}: additional regrtest command-line options.

@item 
@code{TESTPYTHONOPTS}: additional Python command-line options.

@item 
@code{TESTTIMEOUT}: timeout in seconds (default: 10 minutes).
@end itemize

@node make ci,make buildbottest,make test,Objetivos principales de Makefile
@anchor{using/configure make-ci}@anchor{1de8}
@subsubsection make ci


This is similar to @code{make test}, but uses the @code{-ugui} to also run GUI tests.


Added in version 3.14.


@node make buildbottest,make regen-all,make ci,Objetivos principales de Makefile
@anchor{using/configure make-buildbottest}@anchor{1de9}
@subsubsection make buildbottest


This is similar to @code{make test}, but uses the @code{--slow-ci}
option and default timeout of 20 minutes, instead of @code{--fast-ci} option.

@node make regen-all,,make buildbottest,Objetivos principales de Makefile
@anchor{using/configure make-regen-all}@anchor{1dea}
@subsubsection make regen-all


Regenerate (almost) all generated files. These include (but are not
limited to) bytecode cases, and parser generator file.
@code{make regen-stdlib-module-names} and @code{autoconf} must be run
separately for the remaining @ref{1d6e,,generated files}.

@node Extensiones C,,Objetivos principales de Makefile,Sistema de compilación Python
@anchor{using/configure c-extensions}@anchor{1deb}
@subsubsection Extensiones C


Some C extensions are built as built-in modules, like the @code{sys} module.
They are built with the @code{Py_BUILD_CORE_BUILTIN} macro defined.
Built-in modules have no @code{__file__} attribute:

@example
>>> import sys
>>> sys
<module 'sys' (built-in)>
>>> sys.__file__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'sys' has no attribute '__file__'
@end example

Other C extensions are built as dynamic libraries, like the @code{_asyncio} module.
They are built with the @code{Py_BUILD_CORE_MODULE} macro defined.
Example on Linux x86-64:

@example
>>> import _asyncio
>>> _asyncio
<module '_asyncio' from '/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'>
>>> _asyncio.__file__
'/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'
@end example

@code{Modules/Setup} se usa para generar objetivos Makefile para compilar extensiones C. Al principio de los archivos, las extensiones C se crean como módulos incorporados. Las extensiones definidas después del marcador @code{*shared*} se crean como bibliotecas dinámicas.

Las macros @code{PyAPI_FUNC()}, @code{PyAPI_DATA()} y @ref{1513,,PyMODINIT_FUNC} de @code{Include/exports.h} se definen de manera diferente dependiendo si es definida la macro @code{Py_BUILD_CORE_MODULE}:


@itemize *

@item 
Use @code{Py_EXPORTED_SYMBOL} si @code{Py_BUILD_CORE_MODULE} es definido

@item 
Use @code{Py_IMPORTED_SYMBOL} de lo contrario.
@end itemize

Si la macro @code{Py_BUILD_CORE_BUILTIN} se usa por error en una extensión de C compilada como una biblioteca compartida, su función @code{PyInit_@var{xxx}()} no se exporta, provocando un @ref{4d7,,ImportError} en la importación.

@node Banderas de compilador y vinculación,,Sistema de compilación Python,Configurar Python
@anchor{using/configure compiler-and-linker-flags}@anchor{1dec}
@subsection Banderas de compilador y vinculación


Opciones establecidas por el script @code{./configure} y las variables de entorno y utilizadas por @code{Makefile}.

@menu
* Banderas del preprocesador:: 
* Banderas del compilador:: 
* Banderas de vinculación:: 

@end menu

@node Banderas del preprocesador,Banderas del compilador,,Banderas de compilador y vinculación
@anchor{using/configure preprocessor-flags}@anchor{1ded}
@subsubsection Banderas del preprocesador


@geindex variables de entorno; CONFIGURE_CPPFLAGS
@anchor{using/configure envvar-CONFIGURE_CPPFLAGS}@anchor{1dee}
@deffn {Variables De Entorno} CONFIGURE_CPPFLAGS

Valor de la variable 
@geindex CPPFLAGS
@geindex variables de entorno; CPPFLAGS
@ref{14f5,,CPPFLAGS} pasado al script @code{./configure}.


Added in version 3.6.

@end deffn

@geindex variables de entorno; CPPFLAGS
@anchor{using/configure envvar-CPPFLAGS}@anchor{14f5}
@deffn {Variables De Entorno} CPPFLAGS

(Objetivo) Indicadores del preprocesador C/C++, p. ej. @code{-I@var{include_dir}} si tiene encabezados en un directorio no estándar `include_dir'.

Ambos 
@geindex CPPFLAGS
@geindex variables de entorno; CPPFLAGS
@ref{14f5,,CPPFLAGS} y 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} necesitan contener el valor del shell para poder compilar módulos de extensión usando los directorios especificados en las variables de entorno.
@end deffn

@geindex variables de entorno; BASECPPFLAGS
@anchor{using/configure envvar-BASECPPFLAGS}@anchor{1def}
@deffn {Variables De Entorno} BASECPPFLAGS


Added in version 3.4.

@end deffn

@geindex variables de entorno; PY_CPPFLAGS
@anchor{using/configure envvar-PY_CPPFLAGS}@anchor{1df0}
@deffn {Variables De Entorno} PY_CPPFLAGS

Se agregaron indicadores de preprocesador adicionales para construir los archivos de objeto del intérprete.

Por defecto: @code{$(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS)}.


Added in version 3.2.

@end deffn

@node Banderas del compilador,Banderas de vinculación,Banderas del preprocesador,Banderas de compilador y vinculación
@anchor{using/configure compiler-flags}@anchor{1df1}
@subsubsection Banderas del compilador


@geindex variables de entorno; CC
@anchor{using/configure envvar-CC}@anchor{14f2}
@deffn {Variables De Entorno} CC

Comando del compilador C.

Ejemplo: @code{gcc -pthread}.
@end deffn

@geindex variables de entorno; CXX
@anchor{using/configure envvar-CXX}@anchor{1df2}
@deffn {Variables De Entorno} CXX

Comando del compilador de C++.

Ejemplo: @code{g++ -pthread}.
@end deffn

@geindex variables de entorno; CFLAGS
@anchor{using/configure envvar-CFLAGS}@anchor{14f3}
@deffn {Variables De Entorno} CFLAGS

Banderas del compilador de C.
@end deffn

@geindex variables de entorno; CFLAGS_NODIST
@anchor{using/configure envvar-CFLAGS_NODIST}@anchor{1df3}
@deffn {Variables De Entorno} CFLAGS_NODIST

@geindex CFLAGS_NODIST
@geindex variables de entorno; CFLAGS_NODIST
@ref{1df3,,CFLAGS_NODIST} se usa para compilar el intérprete y las extensiones stdlib C. Úselo cuando un indicador del compilador `no' deba ser parte de 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS} una vez que Python esté instalado (gh-65320@footnote{https://github.com/python/cpython/issues/65320}).

En particular, 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS} no debe contener:


@itemize *

@item 
el indicador del compilador @code{-I} (para configurar la ruta de búsqueda de archivos de inclusión). Los indicadores @code{-I} se procesan de izquierda a derecha, y cualquier indicador en 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS} tendrá prioridad sobre los indicadores @code{-I} proporcionados por el usuario y el paquete.

@item 
banderas de endurecimiento como @code{-Werror} porque las distribuciones no pueden controlar si los paquetes instalados por los usuarios cumplen con estándares tan elevados.
@end itemize


Added in version 3.5.

@end deffn

@geindex variables de entorno; COMPILEALL_OPTS
@anchor{using/configure envvar-COMPILEALL_OPTS}@anchor{1df4}
@deffn {Variables De Entorno} COMPILEALL_OPTS

Las opciones pasadas a la línea de comando @ref{21,,compileall} al crear archivos PYC en @code{make install}. El valor predeterminado: @code{-j0}.


Added in version 3.12.

@end deffn

@geindex variables de entorno; EXTRA_CFLAGS
@anchor{using/configure envvar-EXTRA_CFLAGS}@anchor{1df5}
@deffn {Variables De Entorno} EXTRA_CFLAGS

Banderas adicionales del compilador de C.
@end deffn

@geindex variables de entorno; CONFIGURE_CFLAGS
@anchor{using/configure envvar-CONFIGURE_CFLAGS}@anchor{1df6}
@deffn {Variables De Entorno} CONFIGURE_CFLAGS

Valor de la variable 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS} pasada al script @code{./configure}.


Added in version 3.2.

@end deffn

@geindex variables de entorno; CONFIGURE_CFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_CFLAGS_NODIST}@anchor{1df7}
@deffn {Variables De Entorno} CONFIGURE_CFLAGS_NODIST

Valor de la variable 
@geindex CFLAGS_NODIST
@geindex variables de entorno; CFLAGS_NODIST
@ref{1df3,,CFLAGS_NODIST} pasada al script @code{./configure}.


Added in version 3.5.

@end deffn

@geindex variables de entorno; BASECFLAGS
@anchor{using/configure envvar-BASECFLAGS}@anchor{1df8}
@deffn {Variables De Entorno} BASECFLAGS

Banderas base del compilador.
@end deffn

@geindex variables de entorno; OPT
@anchor{using/configure envvar-OPT}@anchor{1db8}
@deffn {Variables De Entorno} OPT

Banderas de optimización.
@end deffn

@geindex variables de entorno; CFLAGS_ALIASING
@anchor{using/configure envvar-CFLAGS_ALIASING}@anchor{1df9}
@deffn {Variables De Entorno} CFLAGS_ALIASING

Banderas de alias estrictos o no estrictos que se utilizan para compilar @code{Python/dtoa.c}.


Added in version 3.7.

@end deffn

@geindex variables de entorno; CCSHARED
@anchor{using/configure envvar-CCSHARED}@anchor{1dfa}
@deffn {Variables De Entorno} CCSHARED

Banderas del compilador que se utilizan para compilar una biblioteca compartida.

Por ejemplo, @code{-fPIC} se usa en Linux y BSD.
@end deffn

@geindex variables de entorno; CFLAGSFORSHARED
@anchor{using/configure envvar-CFLAGSFORSHARED}@anchor{1dfb}
@deffn {Variables De Entorno} CFLAGSFORSHARED

Se agregaron banderas C adicionales para compilar los archivos de objeto del intérprete.

Por defecto: @code{$(CCSHARED)} cuando se usa @ref{8fa,,--enable-shared}, o una cadena de caracteres vacía en caso contrario.
@end deffn

@geindex variables de entorno; PY_CFLAGS
@anchor{using/configure envvar-PY_CFLAGS}@anchor{1dfc}
@deffn {Variables De Entorno} PY_CFLAGS

Por defecto: @code{$(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS)}.
@end deffn

@geindex variables de entorno; PY_CFLAGS_NODIST
@anchor{using/configure envvar-PY_CFLAGS_NODIST}@anchor{1dfd}
@deffn {Variables De Entorno} PY_CFLAGS_NODIST

Por defecto: @code{$(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal}.


Added in version 3.5.

@end deffn

@geindex variables de entorno; PY_STDMODULE_CFLAGS
@anchor{using/configure envvar-PY_STDMODULE_CFLAGS}@anchor{1dfe}
@deffn {Variables De Entorno} PY_STDMODULE_CFLAGS

Banderas de C que se utilizan para compilar los archivos de objeto del intérprete.

Por defecto: @code{$(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)}.


Added in version 3.7.

@end deffn

@geindex variables de entorno; PY_CORE_CFLAGS
@anchor{using/configure envvar-PY_CORE_CFLAGS}@anchor{1dff}
@deffn {Variables De Entorno} PY_CORE_CFLAGS

Por defecto: @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE}.


Added in version 3.2.

@end deffn

@geindex variables de entorno; PY_BUILTIN_MODULE_CFLAGS
@anchor{using/configure envvar-PY_BUILTIN_MODULE_CFLAGS}@anchor{1e00}
@deffn {Variables De Entorno} PY_BUILTIN_MODULE_CFLAGS

Banderas del compilador para construir un módulo de extensión de biblioteca estándar como un módulo incorporado, como el módulo @ref{ad,,posix}.

Por defecto: @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN}.


Added in version 3.8.

@end deffn

@geindex variables de entorno; PURIFY
@anchor{using/configure envvar-PURIFY}@anchor{1e01}
@deffn {Variables De Entorno} PURIFY

Comando Purify. Purify es un programa de depuración de memoria.

Por defecto: cadena de caracteres vacía (no utilizado).
@end deffn

@node Banderas de vinculación,,Banderas del compilador,Banderas de compilador y vinculación
@anchor{using/configure linker-flags}@anchor{1e02}
@subsubsection Banderas de vinculación


@geindex variables de entorno; LINKCC
@anchor{using/configure envvar-LINKCC}@anchor{1e03}
@deffn {Variables De Entorno} LINKCC

Comando de vinculación usado para compilar programas como @code{python} y @code{_testembed}.

Por defecto: @code{$(PURIFY) $(CC)}.
@end deffn

@geindex variables de entorno; CONFIGURE_LDFLAGS
@anchor{using/configure envvar-CONFIGURE_LDFLAGS}@anchor{1e04}
@deffn {Variables De Entorno} CONFIGURE_LDFLAGS

Valor de la variable 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} pasada al script @code{./configure}.

Evite asignar 
@geindex CFLAGS
@geindex variables de entorno; CFLAGS
@ref{14f3,,CFLAGS}, 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS}, etc. así los usuarios pueden usarlos en la línea de comando para agregar estos valores sin pisar los valores preestablecidos.


Added in version 3.2.

@end deffn

@geindex variables de entorno; LDFLAGS_NODIST
@anchor{using/configure envvar-LDFLAGS_NODIST}@anchor{1e05}
@deffn {Variables De Entorno} LDFLAGS_NODIST

@geindex LDFLAGS_NODIST
@geindex variables de entorno; LDFLAGS_NODIST
@ref{1e05,,LDFLAGS_NODIST} se usa de la misma manera que 
@geindex CFLAGS_NODIST
@geindex variables de entorno; CFLAGS_NODIST
@ref{1df3,,CFLAGS_NODIST}. Usar cuando un indicador del enlazador `no' deba ser parte de 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} una vez que Python esté instalado (gh-65320@footnote{https://github.com/python/cpython/issues/65320}).

En particular, 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} no debe contener:


@itemize *

@item 
el indicador del compilador @code{-L} (para establecer la ruta de búsqueda de bibliotecas). Los indicadores @code{-L} se procesan de izquierda a derecha, y cualquier indicador en 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} tendrá prioridad sobre los indicadores @code{-L} proporcionados por el usuario y el paquete.
@end itemize
@end deffn

@geindex variables de entorno; CONFIGURE_LDFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_LDFLAGS_NODIST}@anchor{1e06}
@deffn {Variables De Entorno} CONFIGURE_LDFLAGS_NODIST

Valor de la variable 
@geindex LDFLAGS_NODIST
@geindex variables de entorno; LDFLAGS_NODIST
@ref{1e05,,LDFLAGS_NODIST} pasado al script @code{./configure}.


Added in version 3.8.

@end deffn

@geindex variables de entorno; LDFLAGS
@anchor{using/configure envvar-LDFLAGS}@anchor{14f4}
@deffn {Variables De Entorno} LDFLAGS

Indicadores de vinculación, p. ej. @code{-L@var{lib_dir}} si tiene bibliotecas en un directorio no estándar `lib_dir'.

Ambos 
@geindex CPPFLAGS
@geindex variables de entorno; CPPFLAGS
@ref{14f5,,CPPFLAGS} y 
@geindex LDFLAGS
@geindex variables de entorno; LDFLAGS
@ref{14f4,,LDFLAGS} necesitan contener el valor del shell para poder compilar módulos de extensión usando los directorios especificados en las variables de entorno.
@end deffn

@geindex variables de entorno; LIBS
@anchor{using/configure envvar-LIBS}@anchor{1e07}
@deffn {Variables De Entorno} LIBS

Banderas de vinculación para pasar bibliotecas al vinculador al enlazar el ejecutable de Python.

Ejemplo: @code{-lrt}.
@end deffn

@geindex variables de entorno; LDSHARED
@anchor{using/configure envvar-LDSHARED}@anchor{1e08}
@deffn {Variables De Entorno} LDSHARED

Comando para construir una biblioteca compartida.

Por defecto: @code{@@LDSHARED@@ $(PY_LDFLAGS)}.
@end deffn

@geindex variables de entorno; BLDSHARED
@anchor{using/configure envvar-BLDSHARED}@anchor{1e09}
@deffn {Variables De Entorno} BLDSHARED

Comando para compilar la biblioteca compartida @code{libpython}.

Por defecto: @code{@@BLDSHARED@@ $(PY_CORE_LDFLAGS)}.
@end deffn

@geindex variables de entorno; PY_LDFLAGS
@anchor{using/configure envvar-PY_LDFLAGS}@anchor{1e0a}
@deffn {Variables De Entorno} PY_LDFLAGS

Por defecto: @code{$(CONFIGURE_LDFLAGS) $(LDFLAGS)}.
@end deffn

@geindex variables de entorno; PY_LDFLAGS_NODIST
@anchor{using/configure envvar-PY_LDFLAGS_NODIST}@anchor{1e0b}
@deffn {Variables De Entorno} PY_LDFLAGS_NODIST

Por defecto: @code{$(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST)}.


Added in version 3.8.

@end deffn

@geindex variables de entorno; PY_CORE_LDFLAGS
@anchor{using/configure envvar-PY_CORE_LDFLAGS}@anchor{1e0c}
@deffn {Variables De Entorno} PY_CORE_LDFLAGS

Banderas de vinculación que se utilizan para crear los archivos de objeto del intérprete.


Added in version 3.8.

@end deffn

@node Uso de Python en Windows,Using Python on macOS,Configurar Python,Configuración y uso de Python
@anchor{using/windows doc}@anchor{1e0d}@anchor{using/windows using-on-windows}@anchor{b32}@anchor{using/windows using-python-on-windows}@anchor{1e0e}
@section Uso de Python en Windows


Este documento pretende dar una visión general del comportamiento específico de Windows que se debería conocer al usar Python en Microsoft Windows.

Unlike most Unix systems and services, Windows does not include a system
supported installation of Python. To make Python available, the CPython team
has compiled Windows installers with every release@footnote{https://www.python.org/downloads/} for many years. These installers
are primarily intended to add a per-user installation of Python, with the
core interpreter and library being used by a single user. The installer is also
able to install for all users of a single machine, and a separate ZIP file is
available for application-local distributions.

As specified in 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, a Python release only supports a Windows platform
while Microsoft considers the platform under extended support. This means that
Python 3.14 supports Windows 10 and newer. If you require Windows 7
support, please install Python 3.8. If you require Windows 8.1 support,
please install Python 3.12.

Hay varios instaladores diferentes disponibles para Windows, cada uno con determinados beneficios y desventajas.

@ref{1e0f,,El instalador completo} contiene todos los componentes y es la mejor opción para desarrolladores que usan Python para cualquier clase de proyecto.

@ref{1bed,,El paquete Microsoft Store} es una instalación simple de Python que es adecuada para ejecutar scripts y paquetes y usar IDLE u otros entornos de desarrollo. Requiere Windows 10 o superior, pero se puede instalar de forma segura sin corromper otros programas. También proporciona muchos comandos convenientes para iniciar Python y sus herramientas.

@ref{1e10,,El paquete de nuget.org} son instalaciones ligeras destinadas a sistemas de integración continua. Puede ser usada para crear paquetes de Python o para ejecutar scripts, pero no es actualizable y no posee herramientas de interfaz de usuario.

@ref{1e11,,El paquete incrustable} es un paquete de Python mínimo que es adecuado para incrustar en una aplicación más grande.

@menu
* El instalador completo:: 
* El paquete Microsoft Store:: 
* El paquete de nuget.org: El paquete de nuget org. 
* El paquete incrustable:: 
* Distribuciones alternativas:: 
* Configuración de Python:: 
* Modo UTF-8:: 
* Lanzador de Python para Windows:: 
* Encontrar módulos:: 
* Módulos adicionales:: 
* Compilar Python en Windows:: 
* Otras plataformas:: 

@end menu

@node El instalador completo,El paquete Microsoft Store,,Uso de Python en Windows
@anchor{using/windows the-full-installer}@anchor{1e12}@anchor{using/windows windows-full}@anchor{1e0f}
@subsection El instalador completo


@menu
* Pasos para la instalación:: 
* Quitar el límite de MAX_PATH:: 
* Instalación sin interfaz de usuario:: 
* Instalación sin descargas:: 
* Modificar una instalación:: 
* Installing Free-threaded Binaries:: 

@end menu

@node Pasos para la instalación,Quitar el límite de MAX_PATH,,El instalador completo
@anchor{using/windows installation-steps}@anchor{1e13}
@subsubsection Pasos para la instalación


Cuatro instaladores de Python 3.14 están disponibles para descargar - dos por cada una de las versiones de 32-bit y 64-bit del intérprete. El `instalador web' es una pequeña descarga inicial que automáticamente descargará los componentes requeridos cuando sea necesario. El `instalador fuera de línea' incluye los componentes necesarios para una instalación por defecto y solo requiere de una conexión a internet para características opcionales. Consultar @ref{1e14,,Instalación sin descargas} para conocer otras formas de evitar descargas durante la instalación.

Luego de iniciar el instalador, se puede seleccionar una de estas dos opciones:

@image{python-figures/win_installer,,,,png}

Si se selecciona «Install Now»:


@itemize *

@item 
`No' necesitarás ser administrador (a menos que se requiera una actualización de sistema para C Runtime Library o se necesite instalar el @ref{65f,,Lanzador de Python para Windows} para todos los usuarios)

@item 
Python será instalado en su directorio de usuario

@item 
El @ref{65f,,Lanzador de Python para Windows} será instalado de acuerdo con la opción en la parte inferior de la primera página

@item 
La biblioteca estándar, conjunto de pruebas, lanzador y pip serán instalados

@item 
Si se selecciona, el directorio de instalación se agregará a su 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}

@item 
Los accesos directos solo serán visibles para al usuario actual
@end itemize

Si selecciona «Customize installation» podrá elegir qué funciones instalar, el destino de la instalación y otras opciones o acciones posinstalación. Para instalar símbolos de depuración o binarios, necesitará usar esta opción.

Para realizar una instalación para todos los usuarios, deberá seleccionar «Customize installation». En este caso:


@itemize *

@item 
Es posible que deba proporcionar credenciales administrativas o aprobación

@item 
Python será instalado en el directorio Program Files

@item 
El @ref{65f,,Lanzador de Python para Windows} será instalado en el directorio Windows

@item 
Se pueden seleccionar características opcionales durante la instalación

@item 
La biblioteca estándar puede ser precompilada a bytecode

@item 
Si se selecciona, el directorio de instalación será agregado al 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} del sistema

@item 
Los accesos directos están disponibles para todos los usuarios
@end itemize

@node Quitar el límite de MAX_PATH,Instalación sin interfaz de usuario,Pasos para la instalación,El instalador completo
@anchor{using/windows max-path}@anchor{cc9}@anchor{using/windows removing-the-max-path-limitation}@anchor{1e15}
@subsubsection Quitar el límite de MAX_PATH


Windows históricamente ha limitado la longitud de las rutas a 260 caracteres. Esto significaba que rutas de mayor longitud no resolverían y se producirían errores.

En las últimas versiones de Windows, esta limitación se puede ampliar a aproximadamente 32.000 caracteres. Su administrador deberá activar la política de grupo «Habilitar rutas largas de Win32» o establecer @code{LongPathsEnabled} en @code{1} en la clave de registro @code{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem}.

Esto permite que la función @ref{1be,,open()}, el módulo @ref{a1,,os} y la mayoría de las demás funciones de ruta acepten y retornen rutas de más de 260 caracteres.

Luego de cambiar la opción anterior, no es necesaria ninguna otra configuración.


Distinto en la versión 3.6: Se habilitó el soporte para rutas largas en Python.


@node Instalación sin interfaz de usuario,Instalación sin descargas,Quitar el límite de MAX_PATH,El instalador completo
@anchor{using/windows install-quiet-option}@anchor{68e}@anchor{using/windows installing-without-ui}@anchor{1e16}
@subsubsection Instalación sin interfaz de usuario


Todas las opciones disponibles desde la interfaz de usuario del instalador también pueden especificarse desde la línea de comandos, lo cual permite que instaladores mediante scripts repliquen una instalación en muchas máquinas sin la interacción del usuario. Estas opciones también pueden ser configuradas sin anular la interfaz de usuario con el fin de cambiar alguno de los valores predeterminados.

Las siguientes opciones (encontradas al ejecutar el instalador con @code{/?}) pueden ser pasadas al instalador


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Descripción

@item

/passive

@tab

para mostrar el progreso sin requerir interacción del usuario

@item

/quiet

@tab

para instalar/desinstalar sin mostrar ninguna interfaz

@item

/simple

@tab

para prevenir la personalización del usuario

@item

/uninstall

@tab

para eliminar Python (sin confirmación)

@item

/layout [directorio]

@tab

para pre-descargar todos los componentes

@item

/log [nombre de archivo]

@tab

para especificar la ubicación de los archivos de registro

@end multitable


Todas las otras opciones se especifican con la forma @code{nombre=valor}, siendo el valor usualmente @code{0} para deshabilitar una funcionalidad, @code{1} para habilitar una funcionalidad, o una ruta. La lista completa de opciones disponibles se muestra a continuación.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Descripción

@tab

Predeterminado

@item

InstallAllUsers

@tab

Realizar una instalación en todo el sistema.

@tab

0

@item

TargetDir

@tab

El directorio de instalación

@tab

Seleccionado de acuerdo a InstallAllUsers

@item

DefaultAllUsersTargetDir

@tab

El directorio predeterminado de instalación cuando se instala para todos los usuarios

@tab

@code{%ProgramFiles%\Python X.Y} o @code{%ProgramFiles(x86)%\Python X.Y}

@item

DefaultJustForMeTargetDir

@tab

El directorio predeterminado de instalación para instalaciones del usuario actual solamente

@tab

@code{%LocalAppData%\Programs\Python\PythonXY} or
@code{%LocalAppData%\Programs\Python\PythonXY-32} or
@code{%LocalAppData%\Programs\Python\PythonXY-64}

@item

DefaultCustomTargetDir

@tab

El valor predeterminado de directorio de instalación personalizado que se muestra en la interfaz de usuario

@tab

(vacío)

@item

AssociateFiles

@tab

Crear asociaciones de archivos si el lanzador también es instalado.

@tab

1

@item

CompileAll

@tab

Compilar todos los archivos @code{.py} a @code{.pyc}.

@tab

0

@item

PrependPath

@tab

Anteponga los directorios de instalación y scripts a 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} y agregue @code{.PY} a 
@geindex PATHEXT
@geindex variables de entorno; PATHEXT
@code{PATHEXT}

@tab

0

@item

AppendPath

@tab

Agregue directorios de instalación y scripts a 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} y agregue @code{.PY} a 
@geindex PATHEXT
@geindex variables de entorno; PATHEXT
@code{PATHEXT}

@tab

0

@item

Shortcuts

@tab

Crear accesos directos para el intérprete, documentación e IDLE si está instalado.

@tab

1

@item

Include_doc

@tab

Instalar el manual de Python

@tab

1

@item

Include_debug

@tab

Instalar los binarios de depuración

@tab

0

@item

Include_dev

@tab

Instale encabezados y bibliotecas de desarrollador. Omitir esto puede conducir a una instalación inutilizable.

@tab

1

@item

Include_exe

@tab

Instale @code{python.exe} y archivos relacionados. Omitir esto puede conducir a una instalación inutilizable.

@tab

1

@item

Include_launcher

@tab

Instalar @ref{65f,,Lanzador de Python para Windows}.

@tab

1

@item

InstallLauncherAllUsers

@tab

Instala el lanzador para todos los usuarios. También requiere que @code{Include_launcher} se establezca en 1

@tab

1

@item

Include_lib

@tab

Instale la biblioteca estándar y los módulos de extensión. Omitir esto puede conducir a una instalación inutilizable.

@tab

1

@item

Include_pip

@tab

Instalar los paquetes pip y setuptools

@tab

1

@item

Include_symbols

@tab

Instalar los símbolos de depuración (@code{*.pdb})

@tab

0

@item

Include_tcltk

@tab

Instalar IDLE y soporte para Tcl/Tk

@tab

1

@item

Include_test

@tab

Instalar el conjunto de pruebas de la biblioteca estándar

@tab

1

@item

Include_tools

@tab

Instalar scripts de utilidades

@tab

1

@item

LauncherOnly

@tab

Instalar solo el lanzador. Esto anulará la mayoría de las otras opciones.

@tab

0

@item

SimpleInstall

@tab

Deshabilitar muchas de las partes de la interfaz de usuario

@tab

0

@item

SimpleInstallDescription

@tab

Un mensaje personalizado para mostrar cuando se use la versión simplificada de la interfaz de usuario de instalación.

@tab

(vacío)

@end multitable


Por ejemplo, para realizar de forma silenciosa una instalación predeterminada de Python para todo el sistema, se puede usar el siguiente comando (desde un símbolo del sistema con privilegios elevados):

@example
python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0
@end example

Para permitir que los usuarios instalen fácilmente una copia personal de Python sin el conjunto de pruebas, se puede proporcionar un acceso directo con el siguiente comando. Esto mostrará una página inicial simplificada y no permitirá la personalización:

@example
python-3.9.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
    SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."
@end example

(Tener en cuenta que al omitir el lanzador también se omiten las asociaciones de archivos y solo es recomendable hacerlo para instalaciones por usuario cuando ya hay una instalación en todo el sistema que incluye el lanzador.)

Las opciones enumeradas anteriormente también se pueden proporcionar en un archivo de nombre @code{unattend.xml} junto al ejecutable. Este archivo especifica una lista de opciones y valores. Cuando un valor se proporciona como un atributo, se convertirá a número si es posible. Los valores proporcionados como elementos de texto siempre se dejan como cadenas. Este archivo de ejemplo configura las mismas opciones que el ejemplo anterior:

@example
<Options>
    <Option Name="InstallAllUsers" Value="no" />
    <Option Name="Include_launcher" Value="0" />
    <Option Name="Include_test" Value="no" />
    <Option Name="SimpleInstall" Value="yes" />
    <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
</Options>
@end example

@node Instalación sin descargas,Modificar una instalación,Instalación sin interfaz de usuario,El instalador completo
@anchor{using/windows install-layout-option}@anchor{1e14}@anchor{using/windows installing-without-downloading}@anchor{1e17}
@subsubsection Instalación sin descargas


Como algunas características de Python no se incluyen con la descarga inicial del instalador, la selección de estas características podría requerir de una conexión a internet. Para evitar esta necesidad, todos los posibles componentes pueden ser descargados a pedido para crear una estructura que no necesitará una conexión a internet, independientemente de las características que se seleccionen. Tener en cuenta que esta descarga puede ser más grande de lo necesario, pero si se va a realizar un gran número de instalaciones es muy útil tener una copia en la caché local.

Ejecute el siguiente comando desde el símbolo del sistema para descargar todos los archivos necesarios posibles. Recuerde sustituir @code{python-3.9.0.exe} por el nombre real de su instalador y crear diseños en sus propios directorios para evitar colisiones entre archivos con el mismo nombre.

@example
python-3.9.0.exe /layout [optional target directory]
@end example

También se puede especificar la opción @code{/quiet} para no mostrar el progreso.

@node Modificar una instalación,Installing Free-threaded Binaries,Instalación sin descargas,El instalador completo
@anchor{using/windows modifying-an-install}@anchor{1e18}
@subsubsection Modificar una instalación


Una vez que Python ha sido instalado, se puede agregar o quitar funciones a través de la herramienta Programas y características que es parte de Windows. Seleccionar la entrada Python y elegir «Desinstalar/Cambiar» para abrir el instalador en modo mantenimiento.

«Cambiar» permite agregar o eliminar características modificando las casillas de verificación - aquellas casillas que no se cambien no agregarán ni quitarán nada. Algunas opciones no pueden cambiarse de esta forma, como el directorio de instalación; para modificarlas es necesario eliminar y reinstalar Python completamente.

«Reparar» verificará todos los archivos que deben instalarse con la configuración actual y reemplazará los que se hayan eliminado o modificado.

«Desinstalar» eliminará Python completamente, a excepción del @ref{65f,,Lanzador de Python para Windows}, el cual posee su propia entrada en Programas y características.

@node Installing Free-threaded Binaries,,Modificar una instalación,El instalador completo
@anchor{using/windows install-freethreaded-windows}@anchor{2de}@anchor{using/windows installing-free-threaded-binaries}@anchor{1e19}
@subsubsection Installing Free-threaded Binaries



Added in version 3.13: (Experimental)


@cartouche
@quotation Nota 
Everything described in this section is considered experimental,
and should be expected to change in future releases.
@end quotation
@end cartouche

To install pre-built binaries with free-threading enabled (see 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}), you
should select «Customize installation». The second page of options includes the
«Download free-threaded binaries» checkbox.

@image{python-figures/win_install_freethreaded,,,,png}

Selecting this option will download and install additional binaries to the same
location as the main Python install. The main executable is called
@code{python3.13t.exe}, and other binaries either receive a @code{t} suffix or a full
ABI suffix. Python source files and bundled third-party dependencies are shared
with the main install.

The free-threaded version is registered as a regular Python install with the
tag @code{3.13t} (with a @code{-32} or @code{-arm64} suffix as normal for those
platforms). This allows tools to discover it, and for the @ref{65f,,Lanzador de Python para Windows} to
support @code{py.exe -3.13t}. Note that the launcher will interpret @code{py.exe -3}
(or a @code{python3} shebang) as «the latest 3.x install», which will prefer the
free-threaded binaries over the regular ones, while @code{py.exe -3.13} will not.
If you use the short style of option, you may prefer to not install the
free-threaded binaries at this time.

To specify the install option at the command line, use
@code{Include_freethreaded=1}. See @ref{1e14,,Instalación sin descargas} for instructions on
pre-emptively downloading the additional binaries for offline install. The
options to include debug symbols and binaries also apply to the free-threaded
builds.

Free-threaded binaries are also available @ref{1e10,,on nuget.org}.

@node El paquete Microsoft Store,El paquete de nuget org,El instalador completo,Uso de Python en Windows
@anchor{using/windows the-microsoft-store-package}@anchor{1e1a}@anchor{using/windows windows-store}@anchor{1bed}
@subsection El paquete Microsoft Store



Added in version 3.7.2.


El paquete de Microsoft Store es un intérprete de Python fácilmente instalable destinado principalmente al uso interactivo, por ejemplo, por estudiantes.

Para instalar el paquete, asegúrate de tener las últimas actualizaciones de Windows 10 y busca «Python 3.14» en Microsoft Store. Comprueba que la aplicación que seleccionas es una publicación de la Python Software Foundation y procede a instalarla.

@cartouche
@quotation Advertencia 
Python siempre estará disponible de forma gratuita en Microsoft Store. Si se te solicita que pagues por él, entonces el paquete seleccionado no es el correcto.
@end quotation
@end cartouche

Luego de la instalación, Python puede iniciarse a través del menú de Inicio. Como alternativa, también estará disponible desde cualquier símbolo del sistema o sesión de PowerShell al escribir @code{python}. Además, pip e IDLE pueden ser usados escribiendo @code{pip} o @code{idle}. IDLE también puede ser encontrado en el Inicio.

Los tres comandos también están disponibles con el número de versión como sufijo, por ejemplo, como @code{python3.exe} y @code{python3.x.exe} así como también @code{python.exe} (donde @code{3.x} es la versión específica que se quiera iniciar, como 3.14). Abrir «Administrar alias de ejecución de aplicaciones» a través del menú de Inicio para seleccionar cuál versión de Python se asocia con cada comando. Se recomienda asegurarse de que @code{pip} e @code{idle} sean consistentes con la versión de @code{python} que esté seleccionada.

Los entornos virtuales se pueden crear con @code{python -m venv} y se activan y usan normalmente.

Si ha instalado otra versión de Python que se haya agregado a la variable @code{PATH}, estará disponible como @code{python.exe} en lugar de la de Microsoft Store. Para acceder a la nueva instalación, use @code{python3.exe} o @code{python3.x.exe}.

El lanzador @code{py.exe} detectará esta instalación de Python, pero priorizará instalaciones realizadas con el instalador tradicional.

Para eliminar Python, abra Configuración y utilice Aplicaciones y características, o encuentre Python en el Inicio y mediante click derecho seleccione Desinstalar. La desinstalación eliminará todos los paquetes instalados directamente en esta instalación de Python, pero no eliminará ningún entorno virtual

@menu
* Problemas conocidos:: 

@end menu

@node Problemas conocidos,,,El paquete Microsoft Store
@anchor{using/windows known-issues}@anchor{1e1b}
@subsubsection Problemas conocidos


@menu
* Redirección de datos locales@comma{} registro y rutas temporales: Redirección de datos locales registro y rutas temporales. 

@end menu

@node Redirección de datos locales registro y rutas temporales,,,Problemas conocidos
@anchor{using/windows redirection-of-local-data-registry-and-temporary-paths}@anchor{1e1c}
@subsubsection Redirección de datos locales, registro y rutas temporales


Debido a las restricciones de las aplicaciones de Microsoft Store, es posible que los scripts de Python no tengan acceso de escritura completo a ubicaciones compartidas, como 
@geindex TEMP
@geindex variables de entorno; TEMP
@code{TEMP} y el registro. En su lugar, escribirá en una copia privada. Si sus scripts deben modificar las ubicaciones compartidas, deberá instalar el instalador completo.

En tiempo de ejecución, Python usará una copia privada de carpetas conocidas de Windows y el registro. Por ejemplo, si la variable de entorno 
@geindex %APPDATA%
@geindex variables de entorno; %APPDATA%
@code{%APPDATA%} es @code{c:\Users\<user>\AppData\}, al escribir en @code{C:\Users\<user>\AppData\Local} se escribirá en @code{C:\Users\<user>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\LocalCache\Local\}.

Al leer archivos, Windows retornará el archivo de la carpeta privada, o si no existe, el directorio real de Windows. Por ejemplo, leer @code{C:\Windows\System32} retorna el contenido de @code{C:\Windows\System32} más el contenido de @code{C:\Program Files\WindowsApps\package_name\VFS\SystemX86}.

Puede encontrar la ruta real de cualquier archivo existente usando @ref{381,,os.path.realpath()}:

@example
>>> import os
>>> test_file = 'C:\\Users\\example\\AppData\\Local\\test.txt'
>>> os.path.realpath(test_file)
'C:\\Users\\example\\AppData\\Local\\Packages\\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\\LocalCache\\Local\\test.txt'
@end example

Al escribir en el Registro de Windows, existen los siguientes comportamientos:


@itemize *

@item 
Se permite la lectura desde @code{HKLM\\Software} y los resultados se fusionan con el archivo @code{registry.dat} en el paquete.

@item 
No se permite escribir en @code{HKLM\\Software} si existe la clave/valor correspondiente, es decir, modificar las claves existentes.

@item 
Se permite escribir en @code{HKLM\\Software} siempre que no exista una clave/valor correspondiente en el paquete y el usuario tenga los permisos de acceso correctos.
@end itemize

For more detail on the technical basis for these limitations, please consult
Microsoft’s documentation on packaged full-trust apps, currently available at
docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-behind-the-scenes@footnote{https://learn.microsoft.com/windows/msix/desktop/desktop-to-uwp-behind-the-scenes}

@node El paquete de nuget org,El paquete incrustable,El paquete Microsoft Store,Uso de Python en Windows
@anchor{using/windows the-nuget-org-packages}@anchor{1e1d}@anchor{using/windows windows-nuget}@anchor{1e10}
@subsection El paquete de nuget.org



Added in version 3.5.2.


El paquete de nuget.org es un entorno Python de tamaño reducido destinado a usarse en sistemas de integración continua y compilación que no posean una instalación de Python a nivel de sistema. Si bien nuget es «el administrador de paquetes para .NET», también funciona perfectamente para paquetes que contienen herramientas de tiempo de compilación.

Visite nuget.org@footnote{https://www.nuget.org/} para obtener la información más actualizada sobre cómo usar nuget. Lo que sigue es un resumen que es suficiente para desarrolladores Python.

La herramienta de línea de comandos @code{nuget.exe} puede ser descargada directamente desde @code{https://aka.ms/nugetclidl}, por ejemplo usando curl o PowerShell. Con esta herramienta, la última versión de Python para máquinas de 64 o 32 bit se instala con:

@example
nuget.exe install python -ExcludeVersion -OutputDirectory .
nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .
@end example

Para seleccionar una versión en particular, agregue un @code{-Version 3.x.y}. El directorio de salida se puede cambiar de @code{.} y el paquete se instalará en un subdirectorio. De forma predeterminada, el subdirectorio tiene el mismo nombre que el paquete y, sin la opción @code{-ExcludeVersion}, este nombre incluirá la versión específica instalada. Dentro del subdirectorio hay un directorio @code{tools} que contiene la instalación de Python:

@example
# Without -ExcludeVersion
> .\python.3.5.2\tools\python.exe -V
Python 3.5.2

# With -ExcludeVersion
> .\python\tools\python.exe -V
Python 3.5.2
@end example

En general, los paquetes nuget no son actualizables, y versiones más nuevas deben ser instaladas en paralelo y referenciadas usando la ruta completa. Otra opción es borrar el directorio del paquete de forma manual e instalarlo de nuevo. Muchos sistemas de CI harán esto automáticamente si no mantienen archivos entre compilaciones.

Junto al directorio @code{tools} está el directorio @code{build\native}. Este contiene un archivo de propiedades MSBuild @code{Python.props} que puede ser usado en un proyecto C++ para referenciar la instalación de Python. Al incluir las configuraciones, automáticamente se usarán los encabezados y se importarán las bibliotecas en la compilación.

The package information pages on nuget.org are
www.nuget.org/packages/python@footnote{https://www.nuget.org/packages/python}
for the 64-bit version, www.nuget.org/packages/pythonx86@footnote{https://www.nuget.org/packages/pythonx86} for the 32-bit version, and
www.nuget.org/packages/pythonarm64@footnote{https://www.nuget.org/packages/pythonarm64} for the ARM64 version

@menu
* Free-threaded packages:: 

@end menu

@node Free-threaded packages,,,El paquete de nuget org
@anchor{using/windows free-threaded-packages}@anchor{1e1e}
@subsubsection Free-threaded packages



Added in version 3.13: (Experimental)


@cartouche
@quotation Nota 
Everything described in this section is considered experimental,
and should be expected to change in future releases.
@end quotation
@end cartouche

Packages containing free-threaded binaries are named
python-freethreaded@footnote{https://www.nuget.org/packages/python-freethreaded}
for the 64-bit version, pythonx86-freethreaded@footnote{https://www.nuget.org/packages/pythonx86-freethreaded} for the 32-bit
version, and pythonarm64-freethreaded@footnote{https://www.nuget.org/packages/pythonarm64-freethreaded} for the ARM64
version. These packages contain both the @code{python3.13t.exe} and
@code{python.exe} entry points, both of which run free threaded.

@node El paquete incrustable,Distribuciones alternativas,El paquete de nuget org,Uso de Python en Windows
@anchor{using/windows the-embeddable-package}@anchor{1e1f}@anchor{using/windows windows-embeddable}@anchor{1e11}
@subsection El paquete incrustable



Added in version 3.5.


La distribución incrustable consiste en un archivo ZIP que contiene un mínimo entorno de Python. Está destinado a ser usado como parte de otra aplicación, en lugar de ser accedido directamente por los usuarios finales.

Al ser extraída, la distribución incrustable está (casi) completamente aislada del sistema del usuario, incluyendo variables de entorno, configuraciones del registro del sistema y paquetes instalados. La biblioteca estándar se incluye como archivos @code{.pyc} precompilados y optimizados dentro de un ZIP, y @code{python3.dll}, @code{python37.dll}, @code{python.exe} y @code{pythonw.exe} están todos proporcionados. Tcl/tk (incluidas sus dependencias, como Idle), pip y la documentación de Python no están incluidos.

@cartouche
@quotation Nota 
The embedded distribution does not include the Microsoft C Runtime@footnote{https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist#visual-studio-2015-2017-2019-and-2022} and it is
the responsibility of the application installer to provide this. The
runtime may have already been installed on a user’s system previously or
automatically via Windows Update, and can be detected by finding
@code{ucrtbase.dll} in the system directory.
@end quotation
@end cartouche

Los paquetes de terceros deben ser instalados por el instalador de la aplicación junto a la distribución incrustada. El uso de pip para administrar dependencias como en una instalación de Python regular no es soportado por esta distribución, aunque con cierto cuidado es posible incluir y usar pip para automatizar las actualizaciones. En general, los paquetes de terceros deben ser tratados como parte de la aplicación («vendoring») para que el desarrollador pueda asegurar la compatibilidad con las nuevas versiones antes de proporcionar actualizaciones a los usuarios.

Los dos casos de uso recomendados para esta distribución se describen a continuación.

@menu
* Aplicación Python:: 
* Incrustar Python:: 

@end menu

@node Aplicación Python,Incrustar Python,,El paquete incrustable
@anchor{using/windows python-application}@anchor{1e20}
@subsubsection Aplicación Python


Una aplicación escrita en Python no necesariamente requiere que los usuarios sean conscientes de ese hecho. La distribución incrustada puede ser usada en este caso para incluir una versión privada de Python en un paquete de instalación. Dependiendo de lo transparente que deba ser (o por el contrario, de lo profesional que deba parecer), hay dos opciones.

El uso de un ejecutable especializado como lanzador requiere algo de código, pero proporciona la experiencia más transparente para los usuarios. Con un lanzador personalizado, no hay indicadores obvios de que el programa se ejecuta en Python: los íconos pueden ser personalizados, se puede especificar información de la compañía y de la versión, y las asociaciones de archivos se comportan correctamente. En la mayoría de los casos, un lanzador personalizado debería simplemente poder invocar @code{Py_Main} utilizando una línea de comandos codificada.

El enfoque más simple es proporcionar un archivo por lotes o un acceso directo generado que directamente invoque @code{python.exe} o @code{pythonw.exe} con los argumentos de línea de comandos requeridos. En este caso, la aplicación aparecerá como Python y no con su nombre real, y los usuarios podrían tener problemas para distinguirla de otros procesos Python en ejecución o asociaciones de archivos.

Con este último enfoque, los paquetes deben instalarse como directorios junto al ejecutable de Python para asegurar su disponibilidad en la ruta. Con el lanzador especializado, los paquetes pueden encontrarse en otras ubicaciones ya que hay oportunidad de especificar la ruta de búsqueda antes de iniciar la aplicación.

@node Incrustar Python,,Aplicación Python,El paquete incrustable
@anchor{using/windows embedding-python}@anchor{1e21}
@subsubsection Incrustar Python


Las aplicaciones escritas en código nativo frecuentemente requieren algún tipo de lenguaje de scripting, y la distribución de Python incrustada puede ser utilizada con ese propósito. En general, la mayoría de la aplicación utiliza código nativo, y alguna parte invocará @code{python.exe} o usará @code{python3.dll} directamente. Para cualquiera de estos casos, la extracción de la distribución incrustable a un subdirectorio de la instalación de la aplicación es suficiente para proporcionar un intérprete de Python invocable.

Al igual que con el uso de la aplicación, los paquetes pueden ser instalados en cualquier ubicación, ya que existe la posibilidad de especificar rutas de búsqueda antes de inicializar el intérprete. Más allá de esto, no existen diferencias fundamentales entre el uso de la distribución incrustada y una instalación normal.

@node Distribuciones alternativas,Configuración de Python,El paquete incrustable,Uso de Python en Windows
@anchor{using/windows alternative-bundles}@anchor{1e22}
@subsection Distribuciones alternativas


Además de la distribución estándar de CPython, hay paquetes modificados que incluyen funcionalidad adicional. La siguiente es una lista de versiones populares y sus características clave:


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

Instalador compatible con múltiples plataformas, documentación, PyWin32

@item Anaconda@footnote{https://www.anaconda.com/download/}

Módulos científicos populares (como numpy, scipy y pandas) y el gestor de paquetes @code{conda}.

@item Enthought Deployment Manager@footnote{https://assets.enthought.com/downloads/edm/}

«El administrador de paquetes y entorno de Python de próxima generación».

Anteriormente, Enthought proporcionaba Canopy, pero llegó al final de su vida en2016@footnote{https://support.enthought.com/hc/en-us/articles/360038600051-Canopy-GUI-end-of-life-transition-to-the-Enthought-Deployment-Manager-EDM-and-Visual-Studio-Code}.

@item WinPython@footnote{https://winpython.github.io/}

Distribución específica para Windows con paquetes científicos precompilados y herramientas para construir paquetes.
@end table

Tenga en cuenta que estos paquetes pueden no incluir la última versión de Python u otras bibliotecas, y no son mantenidos ni respaldados por el equipo central de Python.

@node Configuración de Python,Modo UTF-8,Distribuciones alternativas,Uso de Python en Windows
@anchor{using/windows configuring-python}@anchor{1e23}
@subsection Configuración de Python


Para ejecutar Python convenientemente desde el símbolo del sistema, puede considerar cambiar algunas variables de entorno predeterminadas de Windows. Si bien el instalador proporciona una opción para configurar las variables PATH y PATHEXT, esto solo es confiable para una única instalación en todo el sistema. Si utiliza varias versiones de Python con regularidad, considere usar el @ref{65f,,Lanzador de Python para Windows}.

@menu
* Excurso; configurar variables de entorno: Excurso configurar variables de entorno. 
* Encontrar el ejecutable de Python:: 

@end menu

@node Excurso configurar variables de entorno,Encontrar el ejecutable de Python,,Configuración de Python
@anchor{using/windows excursus-setting-environment-variables}@anchor{1e24}@anchor{using/windows setting-envvars}@anchor{1bee}
@subsubsection Excurso: configurar variables de entorno


Windows permite configurar las variables de entorno de forma permanente a nivel de usuario y a nivel de sistema, o temporalmente en el símbolo del sistema.

Para configurar una variable de entorno temporal, abra el símbolo del sistema y utilice el comando @code{set}:

@example
C:\>set PATH=C:\Program Files\Python 3.9;%PATH%
C:\>set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
C:\>python
@end example

Estos cambios serán aplicados a cualquier comando que de aquí en más se ejecute en esa consola, y serán heredados por cualquier aplicación iniciada desde esa consola.

Si se incluye el nombre de la variable entre signos de porcentaje, esta se expande al valor existente, permitiendo agregar un nuevo valor tanto al principio como al final. Modificar 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} agregando el directorio que contiene @code{python.exe} al comienzo es una forma común de asegurar que se ejecuta la versión correcta de Python.

Para modificar permanentemente las variables de entorno predeterminadas, haga click en Inicio y busque “editar las variables de entorno”, o abra Sistema, Configuración avanzada del sistema y haga click en el botón Variables de entorno. En este diálogo, se pueden agregar o modificar variables del usuario o del sistema. Para cambiar variables del sistema, se necesita acceso no restringido al equipo (por ej. con credenciales de administrador).

@cartouche
@quotation Nota 
Windows concatenará las variables de usuario `luego' de las variables del sistema, lo cual puede causar resultados inesperados cuando se modifica 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.

Todas las versiones de Python utilizan la variable 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}, por lo que no debe configurarla de forma permanente a menos que las rutas enumeradas solo incluyan código compatible con todas las versiones de Python instaladas.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item @indicateurl{https://learn.microsoft.com/windows/win32/procthread/environment-variables}

Descripción general de las variables de entorno en Windows

@item @indicateurl{https://learn.microsoft.com/windows-server/administration/windows-commands/set_1}

El comando @code{set}, para modificar temporalmente las variables de entorno

@item @indicateurl{https://learn.microsoft.com/windows-server/administration/windows-commands/setx}

El comando @code{setx}, para modificar permanentemente las variables de entorno
@end table


@node Encontrar el ejecutable de Python,,Excurso configurar variables de entorno,Configuración de Python
@anchor{using/windows finding-the-python-executable}@anchor{1e25}@anchor{using/windows windows-path-mod}@anchor{10cc}
@subsubsection Encontrar el ejecutable de Python



Distinto en la versión 3.5.


Además de utilizar la entrada para el intérprete de Python creada automáticamente en el menú de Inicio, es posible que desee iniciar Python desde el símbolo del sistema. El instalador posee una opción para realizar esa configuración.

En la primera página del instalador, la opción llamada «Add Python to PATH» puede ser seleccionada para que el instalador agregue la ubicación de instalación a 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. La ubicación del directorio @code{Scripts\} también es agregada. Esto permite escribir @code{python} para iniciar el intérprete, y @code{pip} para el instalador de paquetes. De esta manera los scripts también pueden ser ejecutados con opciones de línea de comandos, consulte la documentación de @ref{1083,,Línea de comando}.

Si no se activa esta opción durante la instalación, en cualquier momento se puede ejecutar nuevamente el instalador, seleccionar Modify, y activarla. Otra alternativa es modificar 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} manualmente siguiendo las instrucciones en @ref{1bee,,Excurso; configurar variables de entorno}. Se necesita configurar la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} para que incluya el directorio de instalación de Python, separándolo con punto y coma (;) de las otras entradas. Una variable de ejemplo pude verse así (suponiendo que las dos primeras entradas ya existían):

@example
C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.9
@end example

@node Modo UTF-8,Lanzador de Python para Windows,Configuración de Python,Uso de Python en Windows
@anchor{using/windows utf-8-mode}@anchor{1e26}@anchor{using/windows win-utf8-mode}@anchor{1e27}
@subsection Modo UTF-8



Added in version 3.7.


Windows todavía usa codificaciones heredadas para la codificación del sistema (la página de códigos ANSI). Python lo usa para la codificación predeterminada de archivos de texto (por ejemplo, @ref{1d3,,locale.getencoding()}).

Esto puede causar problemas porque UTF-8 es ampliamente utilizado en internet y en la mayoría de los sistemas Unix, incluido WSL (subsistema de Windows para Linux).

Se puede utilizar el @ref{6f7,,modo UTF-8} para cambiar la codificación predeterminada a UTF-8. El @ref{6f7,,modo UTF-8} se puede activar mediante la opción de línea de comandos @code{-X utf-8}, o con la variable de entorno @code{PYTHONUTF8=1}. Consulte 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} para activar el modo UTF-8, y @ref{1bee,,Excurso; configurar variables de entorno} para saber cómo modificar las variables de entorno.

Cuando el @ref{6f7,,modo UTF-8 de Python} es activado, usted puede seguir usando la codificación del sistema (La página de código ANSI) a través del códec «mbcs».

Tenga en cuenta que agregar @code{PYTHONUTF8=1} a las variables de entorno predeterminadas afectará a todas las aplicaciones de Python 3.7+ en el sistema. Si utiliza alguna aplicación de Python 3.7+ que depende de la codificación heredada del sistema, se recomienda que se configure la variable de entorno solo temporalmente o se use la opción de línea de comandos @code{-X utf8}.

@cartouche
@quotation Nota 
Aún con el modo UTF-8 desactivado, Python utiliza UTF-8 de forma predeterminada en Windows para:


@itemize *

@item 
E/S de consola, incluida la E/S estándar (consultar 
@geindex Python Enhancement Proposals; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} para más detalles).

@item 
La @ref{5dd,,codificación del sistema} (vea 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para más detalles).
@end itemize
@end quotation
@end cartouche

@node Lanzador de Python para Windows,Encontrar módulos,Modo UTF-8,Uso de Python en Windows
@anchor{using/windows launcher}@anchor{65f}@anchor{using/windows python-launcher-for-windows}@anchor{1e28}
@subsection Lanzador de Python para Windows



Added in version 3.3.


El lanzador de Python para Windows es una utilidad que ayuda en la ubicación y ejecución de diferentes versiones de Python. Este permite que los scripts (o la línea de comandos) indiquen preferencia por una versión específica de Python, y ubicará y ejecutará esa versión.

A diferencia de la variable 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}, el lanzador seleccionará correctamente la versión más apropiada de Python. Priorizará instalaciones del usuario por sobre instalaciones de todo el sistema, y ordenará por versión del lenguaje en lugar de utilizar la más recientemente instalada.

El lanzador se especificó originalmente en 
@geindex Python Enhancement Proposals; PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/}.

@menu
* Comenzar:: 
* Líneas shebang:: 
* Argumentos en líneas shebang:: 
* Personalización:: 
* Diagnóstico:: 
* Ejecución en seco:: 
* Instalación bajo demanda:: 
* Códigos de retorno:: 

@end menu

@node Comenzar,Líneas shebang,,Lanzador de Python para Windows
@anchor{using/windows getting-started}@anchor{1e29}
@subsubsection Comenzar


@menu
* Desde la línea de comandos:: 
* Entornos virtuales:: 
* Desde un script:: 
* Desde asociaciones de archivos:: 

@end menu

@node Desde la línea de comandos,Entornos virtuales,,Comenzar
@anchor{using/windows from-the-command-line}@anchor{1e2a}
@subsubsection Desde la línea de comandos



Distinto en la versión 3.6.


Las instalaciones de todo el sistema de Python 3.3 y versiones posteriores colocarán el lanzador en su 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. El lanzador es compatible con todas las versiones disponibles de Python, por lo que no importa qué versión esté instalada. Para comprobar que el lanzador está disponible, ejecute el siguiente comando en el símbolo del sistema:

@example
py
@end example

Debería suceder que se inicia la última versión de Python instalada - se puede cerrar normalmente, y todo argumento adicional especificado por línea de comandos será enviado directamente a Python.

Si tiene varias versiones de Python instaladas (por ejemplo, 3.7 y 3.14), habrá notado que Python 3.14 se inició: para iniciar Python 3.7, pruebe el comando:

@example
py -3.7
@end example

Si quieres la última versión de Python 2 que tienes instalada, prueba el comando:

@example
py -2
@end example

Si ve el siguiente error, no tiene instalado el lanzador:

@example
'py' is not recognized as an internal or external command,
operable program or batch file.
@end example

El comando:

@example
py --list
@end example

muestra la(s) versión(es) actualmente instalada(s) de Python.

El argumento @code{-x.y} es la forma corta del argumento @code{-V:Compañía/Etiqueta}, que permite seleccionar un entorno de ejecución Python específico, incluidos aquellos que pueden haber provenido de lugares diferentes a python.org. Cualquier entorno registrado siguiendo el 
@geindex Python Enhancement Proposals; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} será detectable. El comando @code{--list} muestra todos los entornos disponibles usando el formato @code{-V:}.

Al usar el argumento @code{-V:}, especificar la Compañía limitará la selección a entornos de ese proveedor, mientras que especificar solo la Etiqueta seleccionará de todos los proveedores. Tenga en cuenta que omitir la barra implica una etiqueta:

@example
# Select any '3.*' tagged runtime
py -V:3

# Select any 'PythonCore' released runtime
py -V:PythonCore/

# Select PythonCore's latest Python 3 runtime
py -V:PythonCore/3
@end example

La forma corta del argumento (@code{-3}) solo selecciona de las versiones principales de Python y no de otras distribuciones. Sin embargo, la forma más larga (@code{-V:3}) seleccionará de cualquiera.

The Company is matched on the full string, case-insensitive. The Tag is matched
on either the full string, or a prefix, provided the next character is a dot or a
hyphen. This allows @code{-V:3.1} to match @code{3.1-32}, but not @code{3.10}. Tags are
sorted using numerical ordering (@code{3.10} is newer than @code{3.1}), but are
compared using text (@code{-V:3.01} does not match @code{3.1}).

@node Entornos virtuales,Desde un script,Desde la línea de comandos,Comenzar
@anchor{using/windows virtual-environments}@anchor{1e2b}
@subsubsection Entornos virtuales



Added in version 3.5.


Si el lanzador es ejecutado sin explícita especificación de la versión de Python, y un entorno virtual se encuentra activo (creado con el módulo @ref{111,,venv} de la biblioteca estándar o con la herramienta externa @code{virtualenv}), el lanzador ejecutará el intérprete del entorno virtual en lugar del global. Para ejecutar el intérprete global, desactive el entorno virtual o especifique explícitamente la versión global de Python.

@node Desde un script,Desde asociaciones de archivos,Entornos virtuales,Comenzar
@anchor{using/windows from-a-script}@anchor{1e2c}
@subsubsection Desde un script


Vamos a crear un script de Python para una prueba - cree un archivo llamado @code{hello.py} con el siguiente contenido

@example
#! python
import sys
sys.stdout.write("hello from Python %s\n" % (sys.version,))
@end example

Desde el directorio en el que vive hello.py, ejecute el comando:

@example
py hello.py
@end example

Debería notar que se imprime el número de versión de la última instalación de Python 2.x. Ahora pruebe cambiando la primera línea por:

@example
#! python3
@end example

Volver a ejecutar el comando ahora debería imprimir la información más reciente de Python 3.x. Al igual que con los ejemplos de línea de comandos anteriores, puede especificar un calificador de versión más explícito. Suponiendo que tiene instalado Python 3.7, intente cambiar la primera línea a @code{#! python3.7} y debería encontrar la información de la versión 3.7 impresa.

Tenga en cuenta que a diferencia del uso interactivo, el comando «python» (a secas) utilizará la última versión de Python 2.x que esté instalada. Esto es así por compatibilidad con versiones anteriores y por compatibilidad con Unix, donde el comando @code{python} usualmente refiere a Python 2.

@node Desde asociaciones de archivos,,Desde un script,Comenzar
@anchor{using/windows from-file-associations}@anchor{1e2d}
@subsubsection Desde asociaciones de archivos


El lanzador debería haber sido asociado con archivos de Python (por ej. archivos @code{.py}, @code{.pyw} y @code{.pyc}) cuando fue instalado. Esto significa que cuando se haga doble click sobre alguno de estos archivos desde el explorador de Windows se utilizará el lanzador, por lo que se pueden utilizar las mismas funciones descritas anteriormente para que el script especifique la versión que debería usarse.

El beneficio clave de esto es que un único lanzador puede soportar múltiples versiones de Python al mismo tiempo dependiendo del contenido de la primera línea.

@node Líneas shebang,Argumentos en líneas shebang,Comenzar,Lanzador de Python para Windows
@anchor{using/windows shebang-lines}@anchor{1e2e}
@subsubsection Líneas shebang


Si la primera línea de un script comienza con @code{#!}, esta se denomina línea «shebang». Linux y otros sistemas operativos tipo Unix soportan de forma nativa este tipo de líneas y son comúnmente utilizadas en dichos sistemas para indicar cómo debería ser ejecutado un script. Este lanzador permite que la misma funcionalidad pueda ser utilizada con scripts de Python en Windows, y los ejemplos anteriores demuestran su uso.

Para permitir que las líneas shebang de scripts de Python sean trasladables entre Unix y Windows, este lanzador soporta varios comandos “virtuales” para especificar qué intérprete utilizar. Los comandos virtuales soportados son:


@itemize *

@item 
@code{/usr/bin/env}

@item 
@code{/usr/bin/python}

@item 
@code{/usr/local/bin/python}

@item 
@code{python}
@end itemize

Por ejemplo, si la primera línea del script comienza con

@example
#! /usr/bin/python
@end example

The default Python or an active virtual environment will be located and used.
As many Python scripts written to work on Unix will already have this line,
you should find these scripts can be used by the launcher without modification.
If you are writing a new script on Windows which you hope will be useful on
Unix, you should use one of the shebang lines starting with @code{/usr}.

Any of the above virtual commands can be suffixed with an explicit version
(either just the major version, or the major and minor version).
Furthermore the 32-bit version can be requested by adding «-32» after the
minor version. I.e. @code{/usr/bin/python3.7-32} will request usage of the
32-bit Python 3.7. If a virtual environment is active, the version will be
ignored and the environment will be used.


Added in version 3.7: Desde la versión 3.7 del lanzador de Python es posible solicitar la versión de 64 bit con el sufijo «-64». Además es posible especificar una versión mayor y la arquitectura sin la versión menor (por ej. @code{/usr/bin/python3-64}).



Distinto en la versión 3.11: El sufijo «-64» está en desuso y ahora implica «cualquier arquitectura que comprobable no sea i386/32 bits». Para solicitar un entorno específico, use el nuevo argumento @code{-V:@var{TAG}} con la etiqueta completa.



Distinto en la versión 3.13: Virtual commands referencing @code{python} now prefer an active virtual
environment rather than searching 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. This handles cases where
the shebang specifies @code{/usr/bin/env python3} but @code{python3.exe} is
not present in the active environment.


La forma @code{/usr/bin/env} de la línea shebang tiene otra propiedad especial adicional. Antes de buscar intérpretes de Python instalados, esta forma buscará en el 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} de ejecución un ejecutable de Python que coincida con el nombre proporcionado como primer argumento. Esto corresponde al comportamiento del programa Unix @code{env}, que realiza una búsqueda en 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. Si no se puede encontrar un ejecutable que coincida con el primer argumento después del comando @code{env} pero el argumento comienza con @code{python}, será manejado como se describe para los otros comandos virtuales. La variable de entorno 
@geindex PYLAUNCHER_NO_SEARCH_PATH
@geindex variables de entorno; PYLAUNCHER_NO_SEARCH_PATH
@code{PYLAUNCHER_NO_SEARCH_PATH} puede ser establecida (a cualquier valor) para omitir esta búsqueda en 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.

Las líneas shebang que no coincidan con ninguno de estos patrones se buscan en la sección @code{[commands]} del @ref{1e2f,,archivo .INI} del lanzador. Esto se puede usar para manejar ciertos comandos de una manera que tenga sentido para tu sistema. El nombre del comando debe ser un único argumento (sin espacios en el ejecutable shebang), y el valor sustituido es la ruta completa al ejecutable (los argumentos adicionales especificados en el .INI se citarán como parte del nombre del archivo).

@example
[commands]
/bin/xpython=C:\Program Files\XPython\python.exe
@end example

Cualquier comando que no se encuentre en el archivo .INI se trata como rutas ejecutables de `Windows' que son absolutas o relativas al directorio que contiene el archivo de script. Esto es una comodidad para los scripts solo para Windows, como aquellos generados por un instalador, ya que el comportamiento no es compatible con los shells al estilo Unix. Estas rutas pueden estar entre comillas y pueden incluir varios argumentos, tras los cuales se añadirá la ruta al script y cualquier argumento adicional.

@node Argumentos en líneas shebang,Personalización,Líneas shebang,Lanzador de Python para Windows
@anchor{using/windows arguments-in-shebang-lines}@anchor{1e30}
@subsubsection Argumentos en líneas shebang


Las líneas shebang también pueden especificar opciones adicionales para que sean pasadas al intérprete de Python. Por ej. si se tiene esta línea shebang:

@example
#! /usr/bin/python -v
@end example

Entonces Python se iniciará con la opción @code{-v}

@node Personalización,Diagnóstico,Argumentos en líneas shebang,Lanzador de Python para Windows
@anchor{using/windows customization}@anchor{1e31}
@subsubsection Personalización


@menu
* Personalización con archivos INI:: 
* Personalizar las versiones de Python predeterminadas:: 

@end menu

@node Personalización con archivos INI,Personalizar las versiones de Python predeterminadas,,Personalización
@anchor{using/windows customization-via-ini-files}@anchor{1e32}@anchor{using/windows launcher-ini}@anchor{1e2f}
@subsubsection Personalización con archivos INI


El lanzador buscará dos archivos .ini - @code{py.ini} en el directorio de datos de aplicación del usuario actual (@code{%LOCALAPPDATA%} o @code{$env:LocalAppData}) y @code{py.ini} en el mismo directorio que el lanzador. Los mismos archivos .ini son utilizados tanto para la versión “consola” del lanzador (es decir, py.exe) como para la version “windows” (es decir pyw.exe).

La personalización especificada en el «directorio de aplicación» tendrá precedencia por sobre la que esté junto al ejecutable, por lo que un usuario, que podría no tener acceso de escritura al archivo .ini que está junto al lanzador, puede sobrescribir comandos en ese archivo .ini global.

@node Personalizar las versiones de Python predeterminadas,,Personalización con archivos INI,Personalización
@anchor{using/windows customizing-default-python-versions}@anchor{1e33}
@subsubsection Personalizar las versiones de Python predeterminadas


En algunos casos, un calificador de versión puede ser incluido en un comando para dictar qué versión de Python será utilizada por dicho comando. Un calificador de versión comienza con el número mayor de la versión y pude ser seguido opcionalmente por un punto (“.”) y el número menor de la versión. Además es posible especificar si se solicita una implementación de 32 o 64 bit agregando «-32» o «-64».

Por ejemplo, una línea shebang como @code{#!python} no posee calificador de versión, mientras que @code{#!python3} sí tiene un calificador de versión el cual especifica solo el número mayor de la versión.

Si no se encuentra un calificador de versión en el comando, la variable de entorno 
@geindex PY_PYTHON
@geindex variables de entorno; PY_PYTHON
@code{PY_PYTHON} puede configurarse para especificar un calificador de versión predeterminado. Si esta no está configurada, por defecto es «3». La variable puede especificar cualquier valor que pueda ser pasado por línea de comandos, como «3», «3.7», «3.7-32» o «3.7-64». (Tener en cuenta que la opción «-64» solo está disponible con el lanzador incluido con Python 3.7 o versiones posteriores.)

Si no se encuentra ningún calificador de versión menor, la variable de entorno @code{PY_PYTHON@{major@}} (donde @code{@{major@}} es el actual calificador de versión mayor según lo determinado antes) puede ser configurada para especificar la versión completa. Si dicha opción no se encuentra, el lanzador enumerará las versiones de Python instaladas y utilizará la última versión menor encontrada para la versión mayor, la cual es probable, aunque no se garantiza, que sea la versión más recientemente instalada de esa familia.

En un Windows de 64 bit con ambas implementaciones de 32 y 64 bit de la misma versión (mayor.menor) de Python instaladas, la versión de 64 bit siempre tendrá precedencia. Esto se cumple para ambas implementaciones de 32 y 64 bit del lanzador - un lanzador de 32 bit priorizará ejecutar una instalación de Python de 64 bit de la versión especificada si está disponible. Esto es así para que el comportamiento del lanzador pueda ser predecible sabiendo solamente qué versiones están instaladas en la PC y sin importar el orden en el cual fueron instaladas (esto es, sin saber si una versión de Python de 32 o 64 bit y su correspondiente lanzador fue la última instalada). Como se especificó antes, el sufijo «-32» o «-64» puede ser utilizado en el especificador de versión para cambiar este comportamiento.

Ejemplos:


@itemize *

@item 
Si no se configura ninguna opción relevante, los comandos @code{python} y @code{python2} utilizarán la última versión de Python 2.x instalada y el comando @code{python3} utilizará el último Python 3.x instalado.

@item 
El comando @code{python3.7} no consultará ninguna opción ya que las versiones están completamente especificadas.

@item 
Si @code{PY_PYTHON=3}, los comandos @code{python} y @code{python3} utilizarán ambos la última versión instalada de Python 3.

@item 
Si es @code{PY_PYTHON=3.7-32}, el comando @code{python} usará la implementación de 32 bits de 3.7, mientras que el comando @code{python3} usará la última versión de Python instalada (PY_PYTHON no se consideró en absoluto porque se especificó una versión principal).

@item 
Si @code{PY_PYTHON=3} y @code{PY_PYTHON3=3.7}, los comandos @code{python} y @code{python3} usarán específicamente 3.7
@end itemize

Además de las variables de entorno, las mismas configuraciones pueden realizarse desde el archivo .INI utilizado por el lanzador. La sección en el archivo INI se llama @code{[defaults]} y el nombre de cada clave será igual al de la variable de entorno pero sin el prefijo @code{PY_} (tenga en cuenta que los nombres de clave en el archivo INI son indiferentes a mayúsculas y minúsculas). El contenido de las variables de entorno sobrescribirá los valores especificados en el archivo INI.

Por ejemplo:


@itemize *

@item 
La configuración de @code{PY_PYTHON=3.7} es equivalente al archivo INI que contiene:
@end itemize

@example
[defaults]
python=3.7
@end example


@itemize *

@item 
La configuración de @code{PY_PYTHON=3} y @code{PY_PYTHON3=3.7} es equivalente al archivo INI que contiene:
@end itemize

@example
[defaults]
python=3
python3=3.7
@end example

@node Diagnóstico,Ejecución en seco,Personalización,Lanzador de Python para Windows
@anchor{using/windows diagnostics}@anchor{1e34}
@subsubsection Diagnóstico


Si se establece una variable de entorno 
@geindex PYLAUNCHER_DEBUG
@geindex variables de entorno; PYLAUNCHER_DEBUG
@code{PYLAUNCHER_DEBUG} (en cualquier valor), el lanzador imprimirá información de diagnóstico en stderr (es decir, en la consola). Si bien esta información logra ser simultáneamente detallada `and' concisa, debería permitirle ver qué versiones de Python se ubicaron, por qué se eligió una versión en particular y la línea de comando exacta utilizada para ejecutar el Python de destino. Está destinado principalmente a pruebas y depuración.

@node Ejecución en seco,Instalación bajo demanda,Diagnóstico,Lanzador de Python para Windows
@anchor{using/windows dry-run}@anchor{1e35}
@subsubsection Ejecución en seco


Si se establece una variable de entorno 
@geindex PYLAUNCHER_DRYRUN
@geindex variables de entorno; PYLAUNCHER_DRYRUN
@code{PYLAUNCHER_DRYRUN} (en cualquier valor), el lanzador generará el comando que habría ejecutado, pero en realidad no iniciará Python. Esto puede ser útil para las herramientas que desean usar el lanzador para detectar y luego iniciar Python directamente. Tenga en cuenta que el comando escrito en la salida estándar siempre se codifica con UTF-8 y es posible que no se represente correctamente en la consola.

@node Instalación bajo demanda,Códigos de retorno,Ejecución en seco,Lanzador de Python para Windows
@anchor{using/windows install-on-demand}@anchor{1e36}
@subsubsection Instalación bajo demanda


Si se establece una variable de entorno 
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex variables de entorno; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} (en cualquier valor) y la versión de Python solicitada no está instalada pero está disponible en Microsoft Store, el lanzador intentará instalarla. Esto puede requerir la interacción del usuario para completarse y es posible que deba ejecutar el comando nuevamente.

Una variable 
@geindex PYLAUNCHER_ALWAYS_INSTALL
@geindex variables de entorno; PYLAUNCHER_ALWAYS_INSTALL
@code{PYLAUNCHER_ALWAYS_INSTALL} adicional hace que el lanzador siempre intente instalar Python, incluso si se detecta. Esto está diseñado principalmente para pruebas (y debe usarse con 
@geindex PYLAUNCHER_DRYRUN
@geindex variables de entorno; PYLAUNCHER_DRYRUN
@code{PYLAUNCHER_DRYRUN}).

@node Códigos de retorno,,Instalación bajo demanda,Lanzador de Python para Windows
@anchor{using/windows return-codes}@anchor{1e37}
@subsubsection Códigos de retorno


El lanzador de Python puede retornar los siguientes códigos de salida. Desafortunadamente, no hay forma de distinguirlos del código de salida de Python.

Los nombres de los códigos son como se usan en las fuentes y son solo para referencia. No hay forma de acceder a ellos o resolverlos aparte de leer esta página. Las entradas se enumeran en orden alfabético de nombres.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Valor

@tab

Descripción

@item

RC_BAD_VENV_CFG

@tab

107

@tab

Se encontró un @code{pyvenv.cfg} pero está corrupto.

@item

RC_CREATE_PROCESS

@tab

101

@tab

No se pudo iniciar Python.

@item

RC_INSTALLING

@tab

111

@tab

Se inició una instalación, pero será necesario volver a ejecutar el comando una vez que se complete.

@item

RC_INTERNAL_ERROR

@tab

109

@tab

Error inesperado. Por favor, informe de un error.

@item

RC_NO_COMMANDLINE

@tab

108

@tab

No se puede obtener la línea de comandos del sistema operativo.

@item

RC_NO_PYTHON

@tab

103

@tab

No se puede encontrar la versión solicitada.

@item

RC_NO_VENV_CFG

@tab

106

@tab

Se requería un @code{pyvenv.cfg} pero no se encontró.

@end multitable


@node Encontrar módulos,Módulos adicionales,Lanzador de Python para Windows,Uso de Python en Windows
@anchor{using/windows finding-modules}@anchor{1e38}@anchor{using/windows windows-finding-modules}@anchor{ca9}
@subsection Encontrar módulos


Estas notas complementan la descripción en @ref{1c67,,La inicialización de la ruta de búsqueda de módulo de sys.path} con notas detalladas de Windows.

Cuando no se encuentre ningún archivo @code{._pth}, así es como @ref{27e,,sys.path} es completado en Windows:


@itemize *

@item 
Se agrega una entrada vacía al comienzo, que corresponde al directorio actual.

@item 
Si existe la variable de entorno 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}, de acuerdo a lo descrito en @ref{691,,Variables de entorno}, sus entradas se agregan a continuación. Tenga en cuenta que en Windows, las rutas en esta variable deben estar separadas por punto y coma (;), para distinguirlas de los dos puntos utilizados en los identificadores de disco (@code{C:\}, etc.).

@item 
Se pueden agregar al registro «rutas de aplicación» adicionales como subclaves de @code{\SOFTWARE\Python\PythonCore@{version@}\PythonPath} bajo los subárboles @code{HKEY_CURRENT_USER} y @code{HKEY_LOCAL_MACHINE}. Las subclaves que contienen un valor por defecto compuesto por cadenas de ruta separadas por punto y coma causan que cada una de esas rutas sea agregada a @ref{27e,,sys.path}. (Tenga en cuenta que todos los instaladores conocidos solo utilizan HKLM, por lo que HKCU comúnmente se encuentra vacío.)

@item 
Si se configura la variable de entorno 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}, es asumida como el «Python Home» (el directorio de origen de Python). De lo contrario, la ruta del ejecutable principal de Python es utilizada para ubicar un «archivo de referencia» (ya sea @code{Lib\os.py} o @code{pythonXY.zip}) para deducir el «Python Home». Si el directorio de origen de Python es encontrado, los subdirectorios relevantes que se agregan a @ref{27e,,sys.path} (@code{Lib}, @code{plat-win}, etc.) se basan en ese directorio. Por el contrario, la ruta principal de Python se construye a partir del PythonPath guardado en el registro.

@item 
Si el Python Home no puede ser ubicado, 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} no está especificado en el entorno y no se encuentra ninguna entrada en el registro, se usa una ruta predeterminada con entradas relativas (por ej. @code{.\Lib;.\plat-win}, etc.).
@end itemize

Si se encuentra el archivo @code{pyvenv.cfg} junto al ejecutable principal o en el directorio un nivel arriba del ejecutable, se aplica la siguiente variación:


@itemize *

@item 
Si @code{home} es una ruta absoluta y 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} no está configurada, se usa esta ruta en lugar de la ruta al ejecutable principal para deducir la ubicación del directorio de origen.
@end itemize

El resultado final de todo esto es:


@itemize *

@item 
Cuando se ejecuta @code{python.exe}, o cualquier otro .exe en el directorio principal de Python (tanto la versión instalada como directamente desde el directorio PCbuild), se deduce la ruta principal, y se ignoran las rutas principales en el registro. Siempre se leen otras «rutas de aplicación» del registro.

@item 
Cuando se aloja Python en otro .exe (distinto directorio, incrustado mediante COM, etc.), el «Python Home» no se deduce, y se utiliza la ruta principal del registro. Siempre se leen otras «rutas de aplicación» del registro.

@item 
Si Python no puede encontrar su directorio de origen y no hay valores en el registro (un .exe congelado, una muy rara configuración de instalación) se obtiene una ruta relativa predeterminada.
@end itemize

Para aquellos que quieran incluir Python en su aplicación o distribución, los siguientes consejos evitarán conflictos con otras instalaciones:


@itemize *

@item 
Incluya un archivo @code{._pth} junto al ejecutable, que contenga los directorios a incluir. Esto hará que se ignoren las rutas enumeradas en el registro y en las variables de entorno, y que también se ignore @ref{c7,,site} a menos que se especifique @code{import site}.

@item 
If you are loading @code{python3.dll} or @code{python37.dll} in your own
executable, explicitly set @ref{495,,PyConfig.module_search_paths} before
@ref{4a6,,Py_InitializeFromConfig()}.

@item 
Limpie y/o sobrescriba 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} y configure 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} antes de iniciar @code{python.exe} desde su aplicación.

@item 
Si no se pueden utilizar las sugerencias previas (por ejemplo, en una distribución que permite a los usuarios ejecutar @code{python.exe} directamente), hay que asegurarse de que el archivo de referencia (@code{Lib\os.py}) exista en el directorio de instalación. (Tener en cuenta que este no será detectado dentro de un archivo ZIP, pero si se detectará un ZIP correctamente nombrado.)
@end itemize

Esto asegura que los archivos de una instalación del sistema no tendrán precedencia por sobre la copia de la biblioteca estándar incluida en su aplicación. De otra manera, los usuarios podrían experimentar problemas al utilizar su aplicación. Tenga en cuenta que la primera sugerencia es la mejor, ya que las otras aún pueden ser afectadas por rutas no estándar en el registro y en el site-packages del usuario.


Distinto en la versión 3.6: Add @code{._pth} file support and removes @code{applocal} option from
@code{pyvenv.cfg}.



Distinto en la versión 3.6: Add @code{python`XX'.zip} as a potential landmark when directly adjacent
to the executable.



Obsoleto desde la versión 3.6: Los módulos especificados en el registro bajo @code{Modules} (no @code{PythonPath}) pueden ser importados por @ref{db1,,importlib.machinery.WindowsRegistryFinder}. Este buscador está habilitado en Windows en la versión 3.6.0 y anteriores, pero es posible que deba agregarse explícitamente a @ref{db2,,sys.meta_path} en el futuro.


@node Módulos adicionales,Compilar Python en Windows,Encontrar módulos,Uso de Python en Windows
@anchor{using/windows additional-modules}@anchor{1e39}
@subsection Módulos adicionales


Aunque Python pretende ser portátil entre todas las plataformas, hay características que son exclusivas de Windows. Existen un par de módulos, de la biblioteca estándar y externos, y fragmentos de código para utilizar estas funciones.

Los módulos estándar específicos para Windows se encuentran documentados en @ref{1e3a,,Servicios Específicos para MS Windows}.

@menu
* PyWin32:: 
* cx_Freeze:: 

@end menu

@node PyWin32,cx_Freeze,,Módulos adicionales
@anchor{using/windows pywin32}@anchor{1e3b}
@subsubsection PyWin32


The PyWin32@footnote{https://pypi.org/project/PyWin32/} module by Mark Hammond
is a collection of modules for advanced Windows-specific support.  This includes
utilities for:


@itemize *

@item 
Component Object Model@footnote{https://learn.microsoft.com/windows/win32/com/component-object-model--com--portal}
(COM)

@item 
Invocación de la API Win32

@item 
Registro

@item 
Registro de eventos

@item 
Microsoft Foundation Classes@footnote{https://learn.microsoft.com/cpp/mfc/mfc-desktop-applications}
(MFC) user interfaces
@end itemize

PythonWin@footnote{https://web.archive.org/web/20060524042422/https://www.python.org/windows/pythonwin/} es una aplicación MFC de muestra distribuida con PyWin32. Es un IDE incrustable con depurador incorporado.


@subsubheading Ver también



@table @asis

@item Win32 How Do I...?@footnote{https://timgolden.me.uk/python/win32_how_do_i.html}

por Tim Golden

@item Python and COM@footnote{https://www.boddie.org.uk/python/COM.html}

por David y Paul Boddie
@end table


@node cx_Freeze,,PyWin32,Módulos adicionales
@anchor{using/windows cx-freeze}@anchor{1e3c}
@subsubsection cx_Freeze


cx_Freeze@footnote{https://cx-freeze.readthedocs.io/en/latest/} envuelve scripts de Python en programas ejecutables de Windows (archivos @code{`*'.exe}).Cuando hayas hecho esto, puedes distribuir tu aplicación sin requerir que tus usuarios instalen Python.

@node Compilar Python en Windows,Otras plataformas,Módulos adicionales,Uso de Python en Windows
@anchor{using/windows compiling-python-on-windows}@anchor{1e3d}
@subsection Compilar Python en Windows


Si desea compilar CPython usted mismo, lo primero que debe hacer es obtener el source@footnote{https://www.python.org/downloads/source/}. Puede descargar la fuente de la última versión o simplemente obtener un checkout@footnote{https://devguide.python.org/setup/#get-the-source-code} nuevo.

El árbol fuente contiene una solución de compilación y archivos de proyecto para Microsoft Visual Studio, que es el compilador que se usa para compilar las versiones oficiales de Python. Estos archivos están en el directorio @code{PCbuild}.

Consulte @code{PCbuild/readme.txt} para obtener información general acerca del proceso de compilación.

Para módulos de extensión, consulte @ref{1e3e,,Creación de extensiones C y C++ en Windows}.

@node Otras plataformas,,Compilar Python en Windows,Uso de Python en Windows
@anchor{using/windows other-platforms}@anchor{1e3f}
@subsection Otras plataformas


Con el continuo desarrollo de Python, algunas plataformas que solían ser compatibles ya no lo son (debido a la falta de usuarios o desarrolladores). Consulte 
@geindex Python Enhancement Proposals; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} para detalles sobre las plataformas no soportadas.


@itemize *

@item 
Windows CE@footnote{https://pythonce.sourceforge.net/} es no longer supported@footnote{https://github.com/python/cpython/issues/71542} desde Python 3 (si alguna vez lo fue).

@item 
El instalador Cygwin@footnote{https://cygwin.com/} ofrece instalar también el Python interpreter@footnote{https://cygwin.com/packages/summary/python3.html}
@end itemize

Para obtener información detallada acerca de las plataformas con instaladores precompilados consulte Python for Windows@footnote{https://www.python.org/downloads/windows/}.

@node Using Python on macOS,Using Python on Android,Uso de Python en Windows,Configuración y uso de Python
@anchor{using/mac doc}@anchor{1e40}@anchor{using/mac using-on-mac}@anchor{1e41}@anchor{using/mac using-python-on-macos}@anchor{1e42}
@section Using Python on macOS


This document aims to give an overview of macOS-specific behavior you should
know about to get started with Python on Mac computers.
Python on a Mac running macOS is very similar to Python on other Unix-derived platforms,
but there are some differences in installation and some features.

There are various ways to obtain and install Python for macOS.
Pre-built versions of the most recent versions of Python are available
from a number of distributors. Much of this document describes use of
the Pythons provided by the CPython release team for download from
the python.org website@footnote{https://www.python.org/downloads/}. See
@ref{1e43,,Alternative Distributions} for some other options.
@anchor{using/mac getting-osx}@anchor{1e44}
@menu
* Using Python for macOS from python.org: Using Python for macOS from python org. 
* Alternative Distributions:: 
* Instalación de paquetes adicionales de Python:: 
* GUI Programming:: 
* Advanced Topics:: 
* Otros recursos:: 

@end menu

@node Using Python for macOS from python org,Alternative Distributions,,Using Python on macOS
@anchor{using/mac getting-and-installing-macpython}@anchor{1e45}@anchor{using/mac using-python-for-macos-from-python-org}@anchor{1e46}
@subsection Using Python for macOS from @code{python.org}


@menu
* Installation steps:: 
* Cómo ejecutar un script de Python:: 

@end menu

@node Installation steps,Cómo ejecutar un script de Python,,Using Python for macOS from python org
@anchor{using/mac installation-steps}@anchor{1e47}
@subsubsection Installation steps


For current Python versions@footnote{https://www.python.org/downloads/}
(other than those in @code{security} status), the release team produces a
`Python for macOS' installer package for each new release.
A list of available installers
is available here@footnote{https://www.python.org/downloads/macos/}.
We recommend using the most recent supported Python version where possible.
Current installers provide a
universal2 binary@footnote{https://en.wikipedia.org/wiki/Universal_binary} build
of Python which runs natively on all Macs (Apple Silicon and Intel) that are
supported by a wide range of macOS versions,
currently typically from at least `macOS 10.13 High Sierra' on.

The downloaded file is a standard macOS installer package file (@code{.pkg}).
File integrity information (checksum, size, sigstore signature, etc) for each file is included
on the release download page. Installer packages and their contents are signed and notarized
with @code{Python Software Foundation} Apple Developer ID certificates
to meet macOS Gatekeeper requirements@footnote{https://support.apple.com/en-us/102445}.

For a default installation, double-click on the downloaded installer package file.
This should launch the standard macOS Installer app and display the first of several
installer windows steps.

@image{python-figures/mac_installer_01_introduction,,,,png}

Clicking on the `Continue' button brings up the `Read Me' for this installer.
Besides other important information, the `Read Me' documents which Python version is
going to be installed and on what versions of macOS it is supported. You may need
to scroll through to read the whole file. By default, this `Read Me' will also be
installed in @code{/Applications/Python 3.13/} and available to read anytime.

@image{python-figures/mac_installer_02_readme,,,,png}

Clicking on `Continue' proceeds to display the license for Python and for
other included software. You will then need to `Agree' to the license terms
before proceeding to the next step. This license file will also be installed
and available to be read later.

@image{python-figures/mac_installer_03_license,,,,png}

After the license terms are accepted, the next step is the `Installation Type'
display. For most uses, the standard set of installation operations is appropriate.

@image{python-figures/mac_installer_04_installation_type,,,,png}

By pressing the `Customize' button, you can choose to omit or select certain package
components of the installer. Click on each package name to see a description of
what it installs.
To also install support for the optional experimental free-threaded feature,
see @ref{2df,,Installing Free-threaded Binaries}.

@image{python-figures/mac_installer_05_custom_install,,,,png}

In either case, clicking `Install' will begin the install process by asking
permission to install new software. A macOS user name with @code{Administrator} privilege
is needed as the installed Python will be available to all users of the Mac.

When the installation is complete, the `Summary' window will appear.

@image{python-figures/mac_installer_06_summary,,,,png}

Double-click on the @code{Install Certificates.command}
icon or file in the @code{/Applications/Python 3.13/} window to complete the
installation.

@image{python-figures/mac_installer_07_applications,,,,png}

This will open a temporary @code{Terminal} shell window that
will use the new Python to download and install SSL root certificates
for its use.

@image{python-figures/mac_installer_08_install_certificates,,,,png}

If @code{Successfully installed certifi} and @code{update complete} appears
in the terminal window, the installation is complete.
Close this terminal window and the installer window.

A default install will include:


@itemize *

@item 
A @code{Python 3.13} folder in your @code{Applications} folder. In here
you find @code{IDLE}, the development environment that is a standard part of official
Python distributions; and @code{Python Launcher}, which handles double-clicking Python
scripts from the macOS Finder@footnote{https://support.apple.com/en-us/HT201732}.

@item 
A framework @code{/Library/Frameworks/Python.framework}, which includes the
Python executable and libraries. The installer adds this location to your shell
path. To uninstall Python, you can remove these three things.
Symlinks to the Python executable are placed in @code{/usr/local/bin/}.
@end itemize

@cartouche
@quotation Nota 
Recent versions of macOS include a @code{python3} command in @code{/usr/bin/python3}
that links to a usually older and incomplete version of Python provided by and for use by
the Apple development tools, @code{Xcode} or the @code{Command Line Tools for Xcode}.
You should never modify or attempt to delete this installation, as it is
Apple-controlled and is used by Apple-provided or third-party software.  If
you choose to install a newer Python version from @code{python.org}, you will have
two different but functional Python installations on your computer that
can co-exist. The default installer options should ensure that its @code{python3}
will be used instead of the system @code{python3}.
@end quotation
@end cartouche

@node Cómo ejecutar un script de Python,,Installation steps,Using Python for macOS from python org
@anchor{using/mac how-to-run-a-python-script}@anchor{1e48}
@subsubsection Cómo ejecutar un `script' de Python


There are two ways to invoke the Python interpreter.
If you are familiar with using a Unix shell in a terminal
window, you can invoke @code{python3.13} or @code{python3} optionally
followed by one or more command line options (described in @ref{19c8,,Línea de comandos y entorno}).
The Python tutorial also has a useful section on
@ref{2db,,using Python interactively from a shell}.

You can also invoke the interpreter through an integrated
development environment.
@ref{1091,,IDLE} is a basic editor and interpreter environment
which is included with the standard distribution of Python.
@code{IDLE} includes a Help menu that allows you to access Python documentation. If you
are completely new to Python, you can read the tutorial introduction
in that document.

There are many other editors and IDEs available, see @ref{1e49,,Editores e IDEs}
for more information.

To run a Python script file from the terminal window, you can
invoke the interpreter with the name of the script file:

@quotation

@code{python3.13} @code{myscript.py}
@end quotation

To run your script from the Finder, you can either:


@itemize *

@item 
Drag it to @code{Python Launcher}.

@item 
Select @code{Python Launcher} as the default application to open your
script (or any @code{.py} script) through the Finder Info window and double-click it.
@code{Python Launcher} has various preferences to control how your script is
launched. Option-dragging allows you to change these for one invocation, or use
its @code{Preferences} menu to change things globally.
@end itemize

Be aware that running the script directly from the macOS Finder might
produce different results than when running from a terminal window as
the script will not be run in the usual shell environment including
any setting of environment variables in shell profiles.
And, as with any other script or program,
be certain of what you are about to run.

@node Alternative Distributions,Instalación de paquetes adicionales de Python,Using Python for macOS from python org,Using Python on macOS
@anchor{using/mac alternative-bundles}@anchor{1e43}@anchor{using/mac alternative-distributions}@anchor{1e4a}
@subsection Alternative Distributions


Besides the standard @code{python.org} for macOS installer, there are third-party
distributions for macOS that may include additional functionality.
Some popular distributions and their key features:


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

Installer with multi-platform compatibility, documentation

@item Anaconda@footnote{https://www.anaconda.com/download/}

Popular scientific modules (such as numpy, scipy, and pandas) and the
@code{conda} package manager.

@item Homebrew@footnote{https://brew.sh}

Package manager for macOS including multiple versions of Python and many
third-party Python-based packages (including numpy, scipy, and pandas).

@item MacPorts@footnote{https://www.macports.org}

Another package manager for macOS including multiple versions of Python and many
third-party Python-based packages. May include pre-built versions of Python and
many packages for older versions of macOS.
@end table

Note that distributions might not include the latest versions of Python or
other libraries, and are not maintained or supported by the core Python team.

@node Instalación de paquetes adicionales de Python,GUI Programming,Alternative Distributions,Using Python on macOS
@anchor{using/mac installing-additional-python-packages}@anchor{1e4b}@anchor{using/mac mac-package-manager}@anchor{1e4c}
@subsection Instalación de paquetes adicionales de Python


Refer to the Python Packaging User Guide@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/} for more information.
@anchor{using/mac osx-gui-scripts}@anchor{1e4d}
@node GUI Programming,Advanced Topics,Instalación de paquetes adicionales de Python,Using Python on macOS
@anchor{using/mac gui-programming}@anchor{1e4e}@anchor{using/mac gui-programming-on-the-mac}@anchor{1e4f}
@subsection GUI Programming


Hay varias opciones para crear aplicaciones GUI en Mac con Python.

The standard Python GUI toolkit is @ref{f0,,tkinter}, based on the cross-platform
Tk toolkit (@indicateurl{https://www.tcl.tk}). A macOS-native version of Tk is included with
the installer.

`PyObjC' is a Python binding to Apple’s Objective-C/Cocoa framework.
Information on PyObjC is available from pyobjc@footnote{https://pypi.org/project/pyobjc/}.

A number of alternative macOS GUI toolkits are available including:


@itemize *

@item 
PySide@footnote{https://www.qt.io/qt-for-python}: Official Python bindings to the
Qt GUI toolkit@footnote{https://wiki.qt.io/Qt_for_Python}.

@item 
PyQt@footnote{https://riverbankcomputing.com/software/pyqt/}: Alternative
Python bindings to Qt.

@item 
Kivy@footnote{https://kivy.org}: A cross-platform GUI toolkit that supports
desktop and mobile platforms.

@item 
Toga@footnote{https://toga.readthedocs.io}: Part of the BeeWare Project@footnote{https://beeware.org}; supports desktop, mobile, web and console apps.

@item 
wxPython@footnote{https://wxpython.org}: A cross-platform toolkit that
supports desktop operating systems.
@end itemize

@node Advanced Topics,Otros recursos,GUI Programming,Using Python on macOS
@anchor{using/mac advanced-topics}@anchor{1e50}
@subsection Advanced Topics


@menu
* Installing Free-threaded Binaries: Installing Free-threaded Binaries<2>. 
* Installing using the command line:: 
* Distributing Python Applications:: 
* App Store Compliance:: 

@end menu

@node Installing Free-threaded Binaries<2>,Installing using the command line,,Advanced Topics
@anchor{using/mac install-freethreaded-macos}@anchor{2df}@anchor{using/mac installing-free-threaded-binaries}@anchor{1e51}
@subsubsection Installing Free-threaded Binaries



Added in version 3.13: (Experimental)


@cartouche
@quotation Nota 
Everything described in this section is considered experimental,
and should be expected to change in future releases.
@end quotation
@end cartouche

The @code{python.org} @ref{1e45,,Python for macOS}
installer package can optionally install an additional build of
Python 3.13 that supports 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}, the experimental free-threading feature
(running with the @ref{2b5,,global interpreter lock} disabled).
Check the release page on @code{python.org} for possible updated information.

Because this feature is still considered experimental, the support for it
is not installed by default. It is packaged as a separate install option,
available by clicking the `Customize' button on the `Installation Type'
step of the installer as described above.

@image{python-figures/mac_installer_09_custom_install_free_threaded,,,,png}

If the box next to the `Free-threaded Python' package name is checked,
a separate @code{PythonT.framework} will also be installed
alongside the normal @code{Python.framework} in @code{/Library/Frameworks}.
This configuration allows a free-threaded Python 3.13 build to co-exist
on your system with a traditional (GIL only) Python 3.13 build with
minimal risk while installing or testing. This installation layout is itself
experimental and is subject to change in future releases.

Known cautions and limitations:


@itemize -

@item 
The `UNIX command-line tools' package, which is selected by default,
will install links in @code{/usr/local/bin} for @code{python3.13t},
the free-threaded interpreter, and @code{python3.13t-config},
a configuration utility which may be useful for package builders.
Since @code{/usr/local/bin} is typically included in your shell @code{PATH},
in most cases no changes to your @code{PATH} environment variables should
be needed to use @code{python3.13t}.

@item 
For this release, the `Shell profile updater' package and the
@code{Update Shell Profile.command} in @code{/Applications/Python 3.13/}
do not support the free-threaded package.

@item 
The free-threaded build and the traditional build have separate search
paths and separate @code{site-packages} directories so, by default,
if you need a package available in both builds, it may need to be installed in both.
The free-threaded package will install a separate instance of @code{pip} for use
with @code{python3.13t}.


@itemize -

@item 
To install a package using @code{pip} without a @code{venv}:

@quotation

@code{python3.13t} @code{-m pip install <package_name>}
@end quotation
@end itemize

@item 
When working with multiple Python environments, it is usually safest and easiest
to @ref{1d05,,create and use virtual environments}.
This can avoid possible command name conflicts and confusion about which Python is in use:

@quotation

@code{python3.13t} @code{-m venv <venv_name>}
@end quotation

then @code{activate}.

@item 
To run a free-threaded version of IDLE:

@quotation

@code{python3.13t} @code{-m idlelib}
@end quotation

@item 
The interpreters in both builds respond to the same
@ref{691,,PYTHON environment variables}
which may have unexpected results, for example, if you have @code{PYTHONPATH}
set in a shell profile. If necessary, there are
@ref{1d2f,,command line options} like @code{-E}
to ignore these environment variables.

@item 
The free-threaded build links to the third-party shared libraries,
such as @code{OpenSSL} and @code{Tk}, installed in the traditional framework.
This means that both builds also share one set of trust certificates
as installed by the @code{Install Certificates.command} script,
thus it only needs to be run once.

@item 
If you cannot depend on the link in @code{/usr/local/bin} pointing to the
@code{python.org} free-threaded @code{python3.13t} (for example, if you want
to install your own version there or some other distribution does),
you can explicitly set your shell @code{PATH} environment variable to
include the @code{PythonT} framework @code{bin} directory:

@example
export PATH="/Library/Frameworks/PythonT.framework/Versions/3.13/bin":"$PATH"
@end example

The traditional framework installation by default does something similar,
except for @code{Python.framework}. Be aware that having both framework @code{bin}
directories in @code{PATH} can lead to confusion if there are duplicate names
like @code{python3.13} in both; which one is actually used depends on the order
they appear in @code{PATH}. The @code{which python3.x} or @code{which python3.xt}
commands can show which path is being used. Using virtual environments
can help avoid such ambiguities. Another option might be to create
a shell @code{alias} to the desired interpreter, like:

@example
alias py3.13="/Library/Frameworks/Python.framework/Versions/3.13/bin/python3.13"
alias py3.13t="/Library/Frameworks/PythonT.framework/Versions/3.13/bin/python3.13t"
@end example
@end itemize

@node Installing using the command line,Distributing Python Applications,Installing Free-threaded Binaries<2>,Advanced Topics
@anchor{using/mac installing-using-the-command-line}@anchor{1e52}
@subsubsection Installing using the command line


If you want to use automation to install the @code{python.org} installer package
(rather than by using the familiar macOS @code{Installer} GUI app),
the macOS command line @code{installer} utility lets you select non-default
options, too. If you are not familiar with @code{installer}, it can be
somewhat cryptic (see @code{man installer} for more information).
As an example, the following shell snippet shows one way to do it,
using the @code{3.13.0b2} release and selecting the free-threaded interpreter
option:

@example
RELEASE="python-3.13.0b2-macos11.pkg"

# download installer pkg
curl -O https://www.python.org/ftp/python/3.13.0/$@{RELEASE@}

# create installer choicechanges to customize the install:
#    enable the PythonTFramework-3.13 package
#    while accepting the other defaults (install all other packages)
cat > ./choicechanges.plist <<EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
        <dict>
                <key>attributeSetting</key>
                <integer>1</integer>
                <key>choiceAttribute</key>
                <string>selected</string>
                <key>choiceIdentifier</key>
                <string>org.python.Python.PythonTFramework-3.13</string>
        </dict>
</array>
</plist>
EOF

sudo installer -pkg ./$@{RELEASE@} -applyChoiceChangesXML ./choicechanges.plist -target /
@end example

You can then test that both installer builds are now available with something like:

@example
$ # test that the free-threaded interpreter was installed if the Unix Command Tools package was enabled
$ /usr/local/bin/python3.13t -VV
Python 3.13.0b2 experimental free-threading build (v3.13.0b2:3a83b172af, Jun  5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
$ #    and the traditional interpreter
$ /usr/local/bin/python3.13 -VV
Python 3.13.0b2 (v3.13.0b2:3a83b172af, Jun  5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
$ # test that they are also available without the prefix if /usr/local/bin is on $PATH
$ python3.13t -VV
Python 3.13.0b2 experimental free-threading build (v3.13.0b2:3a83b172af, Jun  5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
$ python3.13 -VV
Python 3.13.0b2 (v3.13.0b2:3a83b172af, Jun  5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
@end example

@cartouche
@quotation Nota 
Current @code{python.org} installers only install to fixed locations like
@code{/Library/Frameworks/}, @code{/Applications}, and @code{/usr/local/bin}.
You cannot use the @code{installer} @code{-domain} option to install to
other locations.
@end quotation
@end cartouche

@node Distributing Python Applications,App Store Compliance,Installing using the command line,Advanced Topics
@anchor{using/mac distributing-python-applications}@anchor{1e53}@anchor{using/mac distributing-python-applications-on-the-mac}@anchor{1e54}
@subsubsection Distributing Python Applications


A range of tools exist for converting your Python code into a standalone
distributable application:


@itemize *

@item 
py2app@footnote{https://pypi.org/project/py2app/}: Supports creating macOS @code{.app}
bundles from a Python project.

@item 
Briefcase@footnote{https://briefcase.readthedocs.io}: Part of the BeeWare Project@footnote{https://beeware.org}; a cross-platform packaging tool that supports
creation of @code{.app} bundles on macOS, as well as managing signing and
notarization.

@item 
PyInstaller@footnote{https://pyinstaller.org/}: A cross-platform packaging tool that creates
a single file or folder as a distributable artifact.
@end itemize

@node App Store Compliance,,Distributing Python Applications,Advanced Topics
@anchor{using/mac app-store-compliance}@anchor{1e55}
@subsubsection App Store Compliance


Apps submitted for distribution through the macOS App Store must pass Apple’s
app review process. This process includes a set of automated validation rules
that inspect the submitted application bundle for problematic code.

The Python standard library contains some code that is known to violate these
automated rules. While these violations appear to be false positives, Apple’s
review rules cannot be challenged. Therefore, it is necessary to modify the
Python standard library for an app to pass App Store review.

The Python source tree contains
a patch file@footnote{https://github.com/python/cpython/tree/main/Mac/Resources/app-store-compliance.patch} that will remove
all code that is known to cause issues with the App Store review process. This
patch is applied automatically when CPython is configured with the
@ref{162e,,--with-app-store-compliance} option.

This patch is not normally required to use CPython on a Mac; nor is it required
if you are distributing an app `outside' the macOS App Store. It is `only'
required if you are using the macOS App Store as a distribution channel.

@node Otros recursos,,Advanced Topics,Using Python on macOS
@anchor{using/mac other-resources}@anchor{1e56}
@subsection Otros recursos


The python.org Help page@footnote{https://www.python.org/about/help/} has links to many useful resources.
The Pythonmac-SIG mailing list@footnote{https://www.python.org/community/sigs/current/pythonmac-sig/}
is another support resource specifically for Python users and developers on the Mac.

@node Using Python on Android,Using Python on iOS,Using Python on macOS,Configuración y uso de Python
@anchor{using/android doc}@anchor{1e57}@anchor{using/android using-android}@anchor{1e58}@anchor{using/android using-python-on-android}@anchor{1e59}
@section Using Python on Android


Python on Android is unlike Python on desktop platforms. On a desktop platform,
Python is generally installed as a system resource that can be used by any user
of that computer. Users then interact with Python by running a @code{python}
executable and entering commands at an interactive prompt, or by running a
Python script.

On Android, there is no concept of installing as a system resource. The only unit
of software distribution is an «app». There is also no console where you could
run a @code{python} executable, or interact with a Python REPL.

As a result, the only way you can use Python on Android is in embedded mode – that
is, by writing a native Android application, embedding a Python interpreter
using @code{libpython}, and invoking Python code using the @ref{1e5a,,Python embedding API}. The full Python interpreter, the standard library, and all
your Python code is then packaged into your app for its own private use.

The Python standard library has some notable omissions and restrictions on
Android. See the @ref{1e5b,,API availability guide} for
details.

@menu
* Adding Python to an Android app:: 

@end menu

@node Adding Python to an Android app,,,Using Python on Android
@anchor{using/android adding-python-to-an-android-app}@anchor{1e5c}
@subsection Adding Python to an Android app


These instructions are only needed if you’re planning to compile Python for
Android yourself. Most users should `not' need to do this. Instead, use one of
the following tools, which will provide a much easier experience:


@itemize *

@item 
Briefcase@footnote{https://briefcase.readthedocs.io}, from the BeeWare project

@item 
Buildozer@footnote{https://buildozer.readthedocs.io}, from the Kivy project

@item 
Chaquopy@footnote{https://chaquo.com/chaquopy}

@item 
pyqtdeploy@footnote{https://www.riverbankcomputing.com/static/Docs/pyqtdeploy/}

@item 
Termux@footnote{https://termux.dev/en/}
@end itemize

If you’re sure you want to do all of this manually, read on. You can use the
testbed app@footnote{https://github.com/python/cpython/tree/main/Android/testbed} as a guide; each step below contains a
link to the relevant file.


@itemize *

@item 
Build Python by following the instructions in Android/README.md@footnote{https://github.com/python/cpython/tree/main/Android/README.md}.

@item 
Add code to your build.gradle@footnote{https://github.com/python/cpython/tree/main/Android/testbed/app/build.gradle.kts}
file to copy the following items into your project. All except your own Python
code can be copied from @code{cross-build/HOST/prefix/lib}:


@itemize *

@item 
In your JNI libraries:


@itemize *

@item 
@code{libpython*.*.so}

@item 
@code{lib*_python.so} (external libraries such as OpenSSL)
@end itemize

@item 
In your assets:


@itemize *

@item 
@code{python*.*} (the Python standard library)

@item 
@code{python*.*/site-packages} (your own Python code)
@end itemize
@end itemize

@item 
Add code to your app to extract the assets to the filesystem@footnote{https://github.com/python/cpython/tree/main/Android/testbed/app/src/main/java/org/python/testbed/MainActivity.kt}.

@item 
Add code to your app to start Python in embedded mode@footnote{https://github.com/python/cpython/tree/main/Android/testbed/app/src/main/c/main_activity.c}. This will need to be C code
called via JNI.
@end itemize

@node Using Python on iOS,Editores e IDEs,Using Python on Android,Configuración y uso de Python
@anchor{using/ios doc}@anchor{1e5d}@anchor{using/ios using-ios}@anchor{1e5e}@anchor{using/ios using-python-on-ios}@anchor{1e5f}
@section Using Python on iOS


@*Authors: 
Russell Keith-Magee (2024-03)


Python on iOS is unlike Python on desktop platforms. On a desktop platform,
Python is generally installed as a system resource that can be used by any user
of that computer. Users then interact with Python by running a @code{python}
executable and entering commands at an interactive prompt, or by running a
Python script.

On iOS, there is no concept of installing as a system resource. The only unit
of software distribution is an «app». There is also no console where you could
run a @code{python} executable, or interact with a Python REPL.

As a result, the only way you can use Python on iOS is in embedded mode - that
is, by writing a native iOS application, and embedding a Python interpreter
using @code{libPython}, and invoking Python code using the @ref{1e5a,,Python embedding API}. The full Python interpreter, the standard library, and all
your Python code is then packaged as a standalone bundle that can be
distributed via the iOS App Store.

If you’re looking to experiment for the first time with writing an iOS app in
Python, projects such as BeeWare@footnote{https://beeware.org} and Kivy@footnote{https://kivy.org} will provide a much more approachable user experience.
These projects manage the complexities associated with getting an iOS project
running, so you only need to deal with the Python code itself.

@menu
* Python at runtime on iOS:: 
* Installing Python on iOS:: 
* App Store Compliance: App Store Compliance<2>. 

@end menu

@node Python at runtime on iOS,Installing Python on iOS,,Using Python on iOS
@anchor{using/ios python-at-runtime-on-ios}@anchor{1e60}
@subsection Python at runtime on iOS


@menu
* iOS version compatibility:: 
* Platform identification:: 
* Standard library availability:: 
* Binary extension modules:: 
* Compiler stub binaries:: 

@end menu

@node iOS version compatibility,Platform identification,,Python at runtime on iOS
@anchor{using/ios ios-version-compatibility}@anchor{1e61}
@subsubsection iOS version compatibility


The minimum supported iOS version is specified at compile time, using the
@ref{1dd9,,--host} option to @code{configure}. By default, when compiled for iOS,
Python will be compiled with a minimum supported iOS version of 13.0. To use a
different minimum iOS version, provide the version number as part of the
@code{--host} argument - for example,
@code{--host=arm64-apple-ios15.4-simulator} would compile an ARM64 simulator build
with a deployment target of 15.4.

@node Platform identification,Standard library availability,iOS version compatibility,Python at runtime on iOS
@anchor{using/ios platform-identification}@anchor{1e62}
@subsubsection Platform identification


When executing on iOS, @code{sys.platform} will report as @code{ios}. This value will
be returned on an iPhone or iPad, regardless of whether the app is running on
the simulator or a physical device.

Information about the specific runtime environment, including the iOS version,
device model, and whether the device is a simulator, can be obtained using
@ref{1e63,,platform.ios_ver()}. @ref{1e64,,platform.system()} will report @code{iOS} or
@code{iPadOS}, depending on the device.

@ref{1188,,os.uname()} reports kernel-level details; it will report a name of
@code{Darwin}.

@node Standard library availability,Binary extension modules,Platform identification,Python at runtime on iOS
@anchor{using/ios standard-library-availability}@anchor{1e65}
@subsubsection Standard library availability


The Python standard library has some notable omissions and restrictions on
iOS. See the @ref{1e5b,,API availability guide for iOS} for
details.

@node Binary extension modules,Compiler stub binaries,Standard library availability,Python at runtime on iOS
@anchor{using/ios binary-extension-modules}@anchor{1e66}
@subsubsection Binary extension modules


One notable difference about iOS as a platform is that App Store distribution
imposes hard requirements on the packaging of an application. One of these
requirements governs how binary extension modules are distributed.

The iOS App Store requires that `all' binary modules in an iOS app must be
dynamic libraries, contained in a framework with appropriate metadata, stored
in the @code{Frameworks} folder of the packaged app. There can be only a single
binary per framework, and there can be no executable binary material outside
the @code{Frameworks} folder.

This conflicts with the usual Python approach for distributing binaries, which
allows a binary extension module to be loaded from any location on
@code{sys.path}. To ensure compliance with App Store policies, an iOS project must
post-process any Python packages, converting @code{.so} binary modules into
individual standalone frameworks with appropriate metadata and signing. For
details on how to perform this post-processing, see the guide for @ref{1e67,,adding Python to your project}.

To help Python discover binaries in their new location, the original @code{.so}
file on @code{sys.path} is replaced with a @code{.fwork} file. This file is a text
file containing the location of the framework binary, relative to the app
bundle. To allow the framework to resolve back to the original location, the
framework must contain a @code{.origin} file that contains the location of the
@code{.fwork} file, relative to the app bundle.

For example, consider the case of an import @code{from foo.bar import _whiz},
where @code{_whiz} is implemented with the binary module
@code{sources/foo/bar/_whiz.abi3.so}, with @code{sources} being the location
registered on @code{sys.path}, relative to the application bundle. This module
`must' be distributed as @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz}
(creating the framework name from the full import path of the module), with an
@code{Info.plist} file in the @code{.framework} directory identifying the binary as a
framework. The @code{foo.bar._whiz} module would be represented in the original
location with a @code{sources/foo/bar/_whiz.abi3.fwork} marker file, containing
the path @code{Frameworks/foo.bar._whiz/foo.bar._whiz}. The framework would also
contain @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}, containing
the path to the @code{.fwork} file.

When running on iOS, the Python interpreter will install an
@ref{1e68,,AppleFrameworkLoader} that is able to read and
import @code{.fwork} files. Once imported, the @code{__file__} attribute of the
binary module will report as the location of the @code{.fwork} file. However, the
@ref{1e69,,ModuleSpec} for the loaded module will report the
@code{origin} as the location of the binary in the framework folder.

@node Compiler stub binaries,,Binary extension modules,Python at runtime on iOS
@anchor{using/ios compiler-stub-binaries}@anchor{1e6a}
@subsubsection Compiler stub binaries


Xcode doesn’t expose explicit compilers for iOS; instead, it uses an @code{xcrun}
script that resolves to a full compiler path (e.g., @code{xcrun --sdk iphoneos
clang} to get the @code{clang} for an iPhone device). However, using this script
poses two problems:


@itemize *

@item 
The output of @code{xcrun} includes paths that are machine specific, resulting
in a sysconfig module that cannot be shared between users; and

@item 
It results in @code{CC}/@code{CPP}/@code{LD}/@code{AR} definitions that include spaces.
There is a lot of C ecosystem tooling that assumes that you can split a
command line at the first space to get the path to the compiler executable;
this isn’t the case when using @code{xcrun}.
@end itemize

To avoid these problems, Python provided stubs for these tools. These stubs are
shell script wrappers around the underingly @code{xcrun} tools, distributed in a
@code{bin} folder distributed alongside the compiled iOS framework. These scripts
are relocatable, and will always resolve to the appropriate local system paths.
By including these scripts in the bin folder that accompanies a framework, the
contents of the @code{sysconfig} module becomes useful for end-users to compile
their own modules. When compiling third-party Python modules for iOS, you
should ensure these stub binaries are on your path.

@node Installing Python on iOS,App Store Compliance<2>,Python at runtime on iOS,Using Python on iOS
@anchor{using/ios installing-python-on-ios}@anchor{1e6b}
@subsection Installing Python on iOS


@menu
* Tools for building iOS apps:: 
* Adding Python to an iOS project:: 

@end menu

@node Tools for building iOS apps,Adding Python to an iOS project,,Installing Python on iOS
@anchor{using/ios tools-for-building-ios-apps}@anchor{1e6c}
@subsubsection Tools for building iOS apps


Building for iOS requires the use of Apple’s Xcode tooling. It is strongly
recommended that you use the most recent stable release of Xcode. This will
require the use of the most (or second-most) recently released macOS version,
as Apple does not maintain Xcode for older macOS versions. The Xcode Command
Line Tools are not sufficient for iOS development; you need a `full' Xcode
install.

If you want to run your code on the iOS simulator, you’ll also need to install
an iOS Simulator Platform. You should be prompted to select an iOS Simulator
Platform when you first run Xcode. Alternatively, you can add an iOS Simulator
Platform by selecting from the Platforms tab of the Xcode Settings panel.

@node Adding Python to an iOS project,,Tools for building iOS apps,Installing Python on iOS
@anchor{using/ios adding-ios}@anchor{1e67}@anchor{using/ios adding-python-to-an-ios-project}@anchor{1e6d}
@subsubsection Adding Python to an iOS project


Python can be added to any iOS project, using either Swift or Objective C. The
following examples will use Objective C; if you are using Swift, you may find a
library like PythonKit@footnote{https://github.com/pvieito/PythonKit} to be
helpful.

To add Python to an iOS Xcode project:


@enumerate 

@item 
Build or obtain a Python @code{XCFramework}. See the instructions in
iOS/README.rst@footnote{https://github.com/python/cpython/tree/main/iOS/README.rst} (in the CPython source distribution) for details on
how to build a Python @code{XCFramework}. At a minimum, you will need a build
that supports @code{arm64-apple-ios}, plus one of either
@code{arm64-apple-ios-simulator} or @code{x86_64-apple-ios-simulator}.

@item 
Drag the @code{XCframework} into your iOS project. In the following
instructions, we’ll assume you’ve dropped the @code{XCframework} into the root
of your project; however, you can use any other location that you want by
adjusting paths as needed.

@item 
Drag the @code{iOS/Resources/dylib-Info-template.plist} file into your project,
and ensure it is associated with the app target.

@item 
Add your application code as a folder in your Xcode project. In the
following instructions, we’ll assume that your user code is in a folder
named @code{app} in the root of your project; you can use any other location by
adjusting paths as needed. Ensure that this folder is associated with your
app target.

@item 
Select the app target by selecting the root node of your Xcode project, then
the target name in the sidebar that appears.

@item 
In the «General» settings, under «Frameworks, Libraries and Embedded
Content», add @code{Python.xcframework}, with «Embed & Sign» selected.

@item 
In the «Build Settings» tab, modify the following:


@itemize -

@item 
Build Options


@itemize *

@item 
User Script Sandboxing: No

@item 
Enable Testability: Yes
@end itemize

@item 
Search Paths


@itemize *

@item 
Framework Search Paths: @code{$(PROJECT_DIR)}

@item 
Header Search Paths: @code{"$(BUILT_PRODUCTS_DIR)/Python.framework/Headers"}
@end itemize

@item 
Apple Clang - Warnings - All languages


@itemize *

@item 
Quoted Include In Framework Header: No
@end itemize
@end itemize

@item 
Add a build step that copies the Python standard library into your app. In
the «Build Phases» tab, add a new «Run Script» build step `before' the
«Embed Frameworks» step, but `after' the «Copy Bundle Resources» step. Name
the step «Install Target Specific Python Standard Library», disable the
«Based on dependency analysis» checkbox, and set the script content to:

@example
set -e

mkdir -p "$CODESIGNING_FOLDER_PATH/python/lib"
if [ "$EFFECTIVE_PLATFORM_NAME" = "-iphonesimulator" ]; then
    echo "Installing Python modules for iOS Simulator"
    rsync -au --delete "$PROJECT_DIR/Python.xcframework/ios-arm64_x86_64-simulator/lib/" "$CODESIGNING_FOLDER_PATH/python/lib/"
else
    echo "Installing Python modules for iOS Device"
    rsync -au --delete "$PROJECT_DIR/Python.xcframework/ios-arm64/lib/" "$CODESIGNING_FOLDER_PATH/python/lib/"
fi
@end example

Note that the name of the simulator «slice» in the XCframework may be
different, depending the CPU architectures your @code{XCFramework} supports.

@item 
Add a second build step that processes the binary extension modules in the
standard library into «Framework» format. Add a «Run Script» build step
`directly after' the one you added in step 8, named «Prepare Python Binary
Modules». It should also have «Based on dependency analysis» unchecked, with
the following script content:

@example
set -e

install_dylib () @{
    INSTALL_BASE=$1
    FULL_EXT=$2

    # The name of the extension file
    EXT=$(basename "$FULL_EXT")
    # The location of the extension file, relative to the bundle
    RELATIVE_EXT=$@{FULL_EXT#$CODESIGNING_FOLDER_PATH/@}
    # The path to the extension file, relative to the install base
    PYTHON_EXT=$@{RELATIVE_EXT/$INSTALL_BASE/@}
    # The full dotted name of the extension module, constructed from the file path.
    FULL_MODULE_NAME=$(echo $PYTHON_EXT | cut -d "." -f 1 | tr "/" ".");
    # A bundle identifier; not actually used, but required by Xcode framework packaging
    FRAMEWORK_BUNDLE_ID=$(echo $PRODUCT_BUNDLE_IDENTIFIER.$FULL_MODULE_NAME | tr "_" "-")
    # The name of the framework folder.
    FRAMEWORK_FOLDER="Frameworks/$FULL_MODULE_NAME.framework"

    # If the framework folder doesn't exist, create it.
    if [ ! -d "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER" ]; then
        echo "Creating framework for $RELATIVE_EXT"
        mkdir -p "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER"
        cp "$CODESIGNING_FOLDER_PATH/dylib-Info-template.plist" "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/Info.plist"
        plutil -replace CFBundleExecutable -string "$FULL_MODULE_NAME" "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/Info.plist"
        plutil -replace CFBundleIdentifier -string "$FRAMEWORK_BUNDLE_ID" "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/Info.plist"
    fi

    echo "Installing binary for $FRAMEWORK_FOLDER/$FULL_MODULE_NAME"
    mv "$FULL_EXT" "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/$FULL_MODULE_NAME"
    # Create a placeholder .fwork file where the .so was
    echo "$FRAMEWORK_FOLDER/$FULL_MODULE_NAME" > $@{FULL_EXT%.so@}.fwork
    # Create a back reference to the .so file location in the framework
    echo "$@{RELATIVE_EXT%.so@}.fwork" > "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/$FULL_MODULE_NAME.origin"
 @}

 PYTHON_VER=$(ls -1 "$CODESIGNING_FOLDER_PATH/python/lib")
 echo "Install Python $PYTHON_VER standard library extension modules..."
 find "$CODESIGNING_FOLDER_PATH/python/lib/$PYTHON_VER/lib-dynload" -name "*.so" | while read FULL_EXT; do
    install_dylib python/lib/$PYTHON_VER/lib-dynload/ "$FULL_EXT"
 done

 # Clean up dylib template
 rm -f "$CODESIGNING_FOLDER_PATH/dylib-Info-template.plist"

 echo "Signing frameworks as $EXPANDED_CODE_SIGN_IDENTITY_NAME ($EXPANDED_CODE_SIGN_IDENTITY)..."
 find "$CODESIGNING_FOLDER_PATH/Frameworks" -name "*.framework" -exec /usr/bin/codesign --force --sign "$EXPANDED_CODE_SIGN_IDENTITY" $@{OTHER_CODE_SIGN_FLAGS:-@} -o runtime --timestamp=none --preserve-metadata=identifier,entitlements,flags --generate-entitlement-der "@{@}" \;
@end example

@item 
Add Objective C code to initialize and use a Python interpreter in embedded
mode. You should ensure that:
@end enumerate

@quotation


@itemize *

@item 
@ref{4cb,,UTF-8 mode} is `enabled';

@item 
@ref{4c0,,Buffered stdio} is `disabled';

@item 
@ref{4bc,,Writing bytecode} is `disabled';

@item 
@ref{955,,Signal handlers} are `enabled';

@item 
@code{PYTHONHOME} for the interpreter is configured to point at the
@code{python} subfolder of your app’s bundle; and

@item 
The @code{PYTHONPATH} for the interpreter includes:


@itemize -

@item 
the @code{python/lib/python3.X} subfolder of your app’s bundle,

@item 
the @code{python/lib/python3.X/lib-dynload} subfolder of your app’s bundle, and

@item 
the @code{app} subfolder of your app’s bundle
@end itemize
@end itemize

Your app’s bundle location can be determined using @code{[[NSBundle mainBundle]
resourcePath]}.
@end quotation

Steps 8, 9 and 10 of these instructions assume that you have a single folder of
pure Python application code, named @code{app}. If you have third-party binary
modules in your app, some additional steps will be required:


@itemize *

@item 
You need to ensure that any folders containing third-party binaries are
either associated with the app target, or copied in as part of step 8. Step 8
should also purge any binaries that are not appropriate for the platform a
specific build is targeting (i.e., delete any device binaries if you’re
building an app targeting the simulator).

@item 
Any folders that contain third-party binaries must be processed into
framework form by step 9. The invocation of @code{install_dylib} that processes
the @code{lib-dynload} folder can be copied and adapted for this purpose.

@item 
If you’re using a separate folder for third-party packages, ensure that folder
is included as part of the @code{PYTHONPATH} configuration in step 10.
@end itemize

@node App Store Compliance<2>,,Installing Python on iOS,Using Python on iOS
@anchor{using/ios app-store-compliance}@anchor{1e6e}
@subsection App Store Compliance


The only mechanism for distributing apps to third-party iOS devices is to
submit the app to the iOS App Store; apps submitted for distribution must pass
Apple’s app review process. This process includes a set of automated validation
rules that inspect the submitted application bundle for problematic code.

The Python standard library contains some code that is known to violate these
automated rules. While these violations appear to be false positives, Apple’s
review rules cannot be challenged; so, it is necessary to modify the Python
standard library for an app to pass App Store review.

The Python source tree contains
a patch file@footnote{https://github.com/python/cpython/tree/main/Mac/Resources/app-store-compliance.patch} that will remove
all code that is known to cause issues with the App Store review process. This
patch is applied automatically when building for iOS.

@node Editores e IDEs,,Using Python on iOS,Configuración y uso de Python
@anchor{using/editors doc}@anchor{1e6f}@anchor{using/editors editors}@anchor{1e49}@anchor{using/editors editors-and-ides}@anchor{1e70}
@section Editores e IDEs


Existen numerosos IDEs que admiten el lenguaje de programación Python. Muchos editores e IDEs proporcionan resaltado de sintaxis, herramientas de depuración y comprobaciones de 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}.

Diríjase a Python Editors@footnote{https://wiki.python.org/moin/PythonEditors} y a Integrated Development Environments@footnote{https://wiki.python.org/moin/IntegratedDevelopmentEnvironments} para obtener una lista completa.

@node Referencia del Lenguaje Python,La biblioteca estándar de Python,Configuración y uso de Python,Top
@anchor{reference/index doc}@anchor{1e71}@anchor{reference/index reference-index}@anchor{2b2}@anchor{reference/index the-python-language-reference}@anchor{1e72}
@chapter Referencia del Lenguaje Python


Este manual de referencia describe la sintaxis y la «semántica base» del lenguaje. Es conciso, pero intenta ser exacto y completo. La semántica de los tipos de objetos integrados no esenciales y de las funciones y módulos integrados están descritos en @ref{2b1,,La biblioteca estándar de Python}. Para obtener una introducción informal al lenguaje, consulte @ref{1be1,,El tutorial de Python}. Para programadores C o C++, existen dos manuales adicionales: @ref{1be2,,Ampliación e incrustación del intérprete de Python} describe detalladamente cómo escribir un módulo de extensión de Python, y @ref{1be3,,Manual de referencia de la API en C de Python} describe en detalle las interfaces disponibles para los programadores C/C++.

@menu
* Introducción: Introducción<5>. 
* Análisis léxico:: 
* Modelo de datos:: 
* Modelo de ejecución:: 
* El sistema de importación:: 
* Expresiones:: 
* Declaraciones simples:: 
* Sentencias compuestas:: 
* Componentes de nivel superior:: 
* Especificación completa de la gramática:: 

@end menu

@node Introducción<5>,Análisis léxico,,Referencia del Lenguaje Python
@anchor{reference/introduction doc}@anchor{1e73}@anchor{reference/introduction id1}@anchor{1e74}@anchor{reference/introduction introduction}@anchor{1e75}
@section Introducción


Este manual de referencia describe el lenguaje de programación Python. No pretende ser un tutorial.

Aunque intento ser lo más preciso posible, he optado por utilizar el Español (N. de T.: del original en inglés "I chose to use English")» en lugar de especificaciones formales para todo, excepto para la sintaxis y el análisis léxico. Esto debería hacer el documento más comprensible para el lector medio, pero dejará espacio para ambigüedades. En consecuencia, si vienes de Marte y tratas de re implementar Python sólo a partir de este documento, puede que tengas que adivinar cosas y, de hecho, probablemente acabarías implementando un lenguaje bastante diferente. Por otro lado, si estás usando Python y te preguntas cuáles son las reglas precisas sobre un área particular del lenguaje, deberías poder encontrarlas aquí. Si te gustaría ver una definición más formal del lenguaje, quizás podrías ofrecer tu tiempo — o inventar una máquina clonadora :-).

Es peligroso añadir muchos detalles de implementación en un documento de referencia: la implementación puede cambiar y otras implementaciones del lenguaje pueden funcionar de forma diferente. Por otro lado, CPython es la implementación de Python más usada (aunque implementaciones alternativas están ganando soporte), y es importante mencionar sus detalles particulares especialmente donde la implementación  impone limitaciones adicionales. Por lo tanto, encontrarás pequeñas «notas sobre la implementación» repartidas por todo el texto.

Cada implementación de Python viene con un número de módulos estándar incorporados. Éstos están documentados en @ref{2b1,,La biblioteca estándar de Python}. Unos pocos de estos módulos son citados cuando interactúan de forma significativa con la definición del lenguaje.

@menu
* Implementaciones alternativas:: 
* Notación:: 

@end menu

@node Implementaciones alternativas,Notación,,Introducción<5>
@anchor{reference/introduction alternate-implementations}@anchor{1e76}@anchor{reference/introduction implementations}@anchor{1d2c}
@subsection Implementaciones alternativas


Aunque hay una implementación de Python que es, de lejos, la más popular, hay otras implementaciones alternativas que pueden ser de particular interés para diferentes audiencias.

Las implementaciones conocidas incluyen:


@table @asis

@item CPython

Es la implementación original, y la más mantenida, de Python y está escrita en C. Las nuevas características del lenguaje normalmente aparecen primero aquí.

@item Jython

Python implementado en Java. Esta implementación puede utilizarse como lenguaje de scripting para aplicaciones Java, o puede utilizarse para crear aplicaciones utilizando las bibliotecas de clases Java.  También se utiliza a menudo para crear pruebas para bibliotecas Java. Puede encontrar más información en the Jython website@footnote{https://www.jython.org/}.

@item Python para .NET

Esta implementación, de hecho, usa la implementación CPython, pero es una aplicación .NET gestionada y usa librerías .NET. Ha sido creada por Brian Lloyd. Para más información ir al sitio web de Python for .NET@footnote{https://pythonnet.github.io/}.

@item IronPython

Una alternativa de Python para .NET.  A diferencia de Python.NET, esta es una implementación completa de Python que genera IL, y compila código Python directamente a ensamblados .NET.  Fue creado por Jim Hugunin, el creador original de Jython. Para más información, consulte el sitio web de IronPython@footnote{https://ironpython.net/}.

@item PyPy

An implementation of Python written completely in Python. It supports several
advanced features not found in other implementations like stackless support
and a Just in Time compiler. One of the goals of the project is to encourage
experimentation with the language itself by making it easier to modify the
interpreter (since it is written in Python).  Additional information is
available on the PyPy project's home page@footnote{https://pypy.org/}.
@end table

Cada una de estas implementaciones varía de una forma u otra del lenguaje tal y como está documentado en este manual, o introduce información específica más allá de lo cubierto por la documentación estándar de Python. Por favor, consulte la documentación específica de cada implementación para saber qué tienes que saber acerca de la implementación específica que uses.

@node Notación,,Implementaciones alternativas,Introducción<5>
@anchor{reference/introduction id2}@anchor{1e77}@anchor{reference/introduction notation}@anchor{1e78}
@subsection Notación


@geindex BNF
@geindex grammar
@geindex syntax
@geindex notation

The descriptions of lexical analysis and syntax use a modified
Backus–Naur form (BNF)@footnote{https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form} grammar
notation.  This uses the following style of definition:

@example
@anchor{reference/introduction grammar-token-notation-name}@anchor{1e79}name      ::= lc_letter (lc_letter | "_")*
@anchor{reference/introduction grammar-token-notation-lc_letter}@anchor{1e7a}lc_letter ::= "a"..."z"
@end example

La primera línea dice que un @code{name} es una @code{lc_letter} seguida de una secuencia de cero o más @code{lc_letter}s y guiones bajos. Una @code{lc_letter} es, a su vez, cualquiera de los caracteres de la @code{'a'} a la @code{'z'}. (Esta regla se cumple realmente para los nombres definidos en las reglas léxicas y gramaticales en este documento.)

Cada regla empieza con un nombre (que es el nombre definido por la regla) y @code{::=}. Una barra vertical (@code{|}) se usa para separar alternativas; es el operador menos vinculante en esta notación. Un asterisco (@code{*}) significa cero o más repeticiones del elemento anterior; del mismo modo, un signo más (@code{+}) significa una o más repeticiones, y una frase entre corchetes (@code{[]}) significa cero o una ocurrencia (en otras palabras, la frase adjunta es opcional). Los operadores @code{*} y @code{+} se vinculan lo más firmemente posible; los paréntesis se usan para agrupar. Las cadenas de caracteres literales están entre comillas. El espacio en blanco sólo es útil para separar tokens. Las reglas normalmente están contenidas en una sola línea; las reglas con varias alternativas se pueden formatear, de forma alternativa, con una barra vertical con cada línea después del primer comienzo.

@geindex lexical definitions
@geindex ASCII

En las definiciones léxicas (como el ejemplo anterior), se utilizan dos convenciones más: Dos caracteres literales separados por tres puntos significan que se puede elegir cualquier carácter de la gama dada (inclusiva) de caracteres ASCII. Una frase entre corchetes angulares (@code{<...>}) ofrece una descripción informal del símbolo definido; por ejemplo, podría utilizarse para describir la noción de «carácter de control» si fuera necesario.

Aunque la notación utilizada es casi la misma, hay una gran diferencia entre el significado de las definiciones léxicas y sintácticas: una definición léxica opera sobre los caracteres individuales de la fuente de entrada, mientras que una definición sintáctica opera sobre el flujo de tokens generado por el análisis léxico. Todos los usos de BNF en el próximo capítulo ("Análisis léxico") son definiciones léxicas; los usos en los capítulos siguientes son definiciones sintácticas.

@node Análisis léxico,Modelo de datos,Introducción<5>,Referencia del Lenguaje Python
@anchor{reference/lexical_analysis doc}@anchor{1e7b}@anchor{reference/lexical_analysis lexical}@anchor{1e7c}@anchor{reference/lexical_analysis lexical-analysis}@anchor{1e7d}
@section Análisis léxico


@geindex lexical analysis
@geindex parser
@geindex token

Un programa de Python es leído por un `parser' (analizador sintáctico).  Los datos introducidos en el analizador son un flujo de `tokens', generados por el `analizador léxico'.  Este capítulo describe cómo el analizador léxico desglosa un archivo en tokens.

Python lee el texto del programa como puntos de código Unicode; la codificación de un archivo fuente puede ser dada por una declaración de codificación y por defecto es UTF-8, ver 
@geindex Python Enhancement Proposals; PEP 3120
PEP 3120@footnote{https://peps.python.org/pep-3120/} para más detalles.  Si el archivo fuente no puede ser decodificado, se genera un @ref{150,,SyntaxError}.

@menu
* Estructura de línea:: 
* Otros tokens:: 
* Identificadores y palabras clave:: 
* Literales:: 
* Operadores:: 
* Delimitadores:: 

@end menu

@node Estructura de línea,Otros tokens,,Análisis léxico
@anchor{reference/lexical_analysis id1}@anchor{1e7e}@anchor{reference/lexical_analysis line-structure}@anchor{1e7f}
@subsection Estructura de línea


@geindex line structure

Un programa Python se divide en un número de `líneas lógicas'.

@menu
* Líneas lógicas:: 
* Líneas físicas:: 
* Comentarios:: 
* Declaración de Codificación:: 
* Unión explícita de líneas:: 
* Unión implícita de líneas:: 
* Líneas en blanco:: 
* Sangría:: 
* Espacios en blanco entre tokens:: 

@end menu

@node Líneas lógicas,Líneas físicas,,Estructura de línea
@anchor{reference/lexical_analysis id2}@anchor{1e80}@anchor{reference/lexical_analysis logical-lines}@anchor{1e81}
@subsubsection Líneas lógicas


@geindex logical line
@geindex physical line
@geindex line joining
@geindex NEWLINE token

El final de una línea lógica está representado por el token NEWLINE (nueva línea).  Las declaraciones no pueden cruzar los límites de la línea lógica, excepto cuando la sintaxis permite la utilización de NEWLINE (por ejemplo, entre declaraciones en declaraciones compuestas). Una línea lógica se construye a partir de una o más `líneas físicas' siguiendo las reglas explícitas o implícitas de `unión de líneas'.

@node Líneas físicas,Comentarios,Líneas lógicas,Estructura de línea
@anchor{reference/lexical_analysis id3}@anchor{1e82}@anchor{reference/lexical_analysis physical-lines}@anchor{1e83}
@subsubsection Líneas físicas


Una línea física es una secuencia de caracteres terminada por una secuencia de final de línea.  En los archivos fuente y las cadenas, se puede utilizar cualquiera de las secuencias de terminación de línea de la plataforma estándar: el formulario Unix que utiliza ASCII LF (salto de línea, por el inglés `linefeed'), el formulario Windows que utiliza la secuencia ASCII CR LF (retorno seguido de salto de línea), o el antiguo formulario Macintosh que utiliza el carácter ASCII CR (retorno).  Todas estas formas pueden ser utilizadas por igual, independientemente de la plataforma. El final de la introducción de datos también sirve como un terminador implícito para la línea física final.

Al incrustar Python, las cadenas de código fuente deben ser pasadas a las APIs de Python usando las convenciones estándar de C para los caracteres de nueva línea (el carácter @code{\n}, que representa ASCII LF, es el terminador de línea).

@node Comentarios,Declaración de Codificación,Líneas físicas,Estructura de línea
@anchor{reference/lexical_analysis comments}@anchor{1e84}@anchor{reference/lexical_analysis id4}@anchor{1e85}
@subsubsection Comentarios


@geindex comment
@geindex hash character
@geindex # (hash);comment

Un comentario comienza con un carácter de almohadilla (@code{#}) que no es parte de un literal de cadena, y termina al final de la línea física.  Un comentario implica el final de la línea lógica, a menos que se invoque la regla implícita de unión de líneas. Los comentarios son ignorados por la sintaxis.

@node Declaración de Codificación,Unión explícita de líneas,Comentarios,Estructura de línea
@anchor{reference/lexical_analysis encoding-declarations}@anchor{1e86}@anchor{reference/lexical_analysis encodings}@anchor{1e87}
@subsubsection Declaración de Codificación


@geindex source character set
@geindex encoding declarations (source file)
@geindex # (hash);source encoding declaration

Si un comentario en la primera o segunda línea del script de Python coincide con la expresión regular @code{coding[=:]\s*([-\w.]+)}, este comentario se procesa como una declaración de codificación; el primer grupo de esta expresión denomina la codificación del archivo de código fuente. La declaración de codificación debe aparecer en una línea propia. Si se trata de la segunda línea, la primera línea debe ser también una línea solamente de comentario. Las formas recomendadas de una expresión de codificación son

@example
# -*- coding: <encoding-name> -*-
@end example

que también es reconocido por GNU Emacs y

@example
# vim:fileencoding=<encoding-name>
@end example

que es reconocido por el VIM de Bram Moolenaar.

If no encoding declaration is found, the default encoding is UTF-8.  If the
implicit or explicit encoding of a file is UTF-8, an initial UTF-8 byte-order
mark (b”xefxbbxbf”) is ignored rather than being a syntax error.

Si se declara una codificación, Python debe reconocer el nombre de la codificación (ver @ref{e3e,,Codificaciones estándar}). La codificación se utiliza para todos los análisis léxicos, incluidos las cadenas literales, los comentarios y los identificadores.

@node Unión explícita de líneas,Unión implícita de líneas,Declaración de Codificación,Estructura de línea
@anchor{reference/lexical_analysis explicit-joining}@anchor{1e88}@anchor{reference/lexical_analysis explicit-line-joining}@anchor{1e89}
@subsubsection Unión explícita de líneas


@geindex physical line
@geindex line joining
@geindex line continuation
@geindex backslash character

Dos o más líneas físicas pueden unirse en líneas lógicas utilizando caracteres de barra invertida (@code{\}), de la siguiente manera: cuando una línea física termina en una barra invertida que no es parte de literal de cadena o de un comentario, se une con la siguiente formando una sola línea lógica, borrando la barra invertida y el siguiente carácter de fin de línea.  Por ejemplo:

@example
if 1900 < year < 2100 and 1 <= month <= 12 \
   and 1 <= day <= 31 and 0 <= hour < 24 \
   and 0 <= minute < 60 and 0 <= second < 60:   # Looks like a valid date
        return 1
@end example

Una línea que termina en una barra invertida no puede llevar un comentario.  Una barra invertida no continúa un comentario.  Una barra invertida no continúa un token excepto para los literales de la cadena (es decir, los tokens que no sean literales de la cadena no pueden ser divididos a través de líneas físicas usando una barra invertida).  La barra invertida es ilegal en cualquier parte de una línea fuera del literal de la cadena.

@node Unión implícita de líneas,Líneas en blanco,Unión explícita de líneas,Estructura de línea
@anchor{reference/lexical_analysis implicit-joining}@anchor{1e8a}@anchor{reference/lexical_analysis implicit-line-joining}@anchor{1e8b}
@subsubsection Unión implícita de líneas


Las expresiones entre paréntesis, entre corchetes o entre rizos pueden dividirse en más de una línea física sin usar barras invertidas. Por ejemplo:

@example
month_names = ['Januari', 'Februari', 'Maart',      # These are the
               'April',   'Mei',      'Juni',       # Dutch names
               'Juli',    'Augustus', 'September',  # for the months
               'Oktober', 'November', 'December']   # of the year
@end example

Las líneas continuas implícitas pueden llevar comentarios.  La sangría de las líneas de continuación no es importante.  Se permiten líneas de continuación en blanco. No hay ningún token NEWLINE (nueva línea) entre las líneas de continuación implícitas.  Las líneas de continuación implícitas también pueden aparecer dentro de cadenas de triple comilla ( ver más adelante); en ese caso no pueden llevar comentarios.

@node Líneas en blanco,Sangría,Unión implícita de líneas,Estructura de línea
@anchor{reference/lexical_analysis blank-lines}@anchor{1e8c}@anchor{reference/lexical_analysis id5}@anchor{1e8d}
@subsubsection Líneas en blanco


@geindex blank line

Una línea lógica que contiene sólo espacios, tabulaciones, saltos de página y posiblemente un comentario, es ignorada (es decir, no se genera un símbolo de NEWLINE).  Durante la introducción interactiva de declaraciones, el manejo de una línea en blanco puede variar dependiendo de la implementación del bucle de `read-eval-print' (lectura-evaluación-impresión).  En el intérprete interactivo estándar, una línea lógica completamente en blanco (es decir, una que no contiene ni siquiera un espacio en blanco o un comentario) termina una declaración de varias líneas.

@node Sangría,Espacios en blanco entre tokens,Líneas en blanco,Estructura de línea
@anchor{reference/lexical_analysis id6}@anchor{1e8e}@anchor{reference/lexical_analysis indentation}@anchor{1e8f}
@subsubsection Sangría


@geindex indentation
@geindex leading whitespace
@geindex space
@geindex tab
@geindex grouping
@geindex statement grouping

El espacio en blanco ( espacios y tabulaciones) al principio de una línea lógica se utiliza para calcular el nivel de sangría de la línea, que a su vez se utiliza para determinar la agrupación de las declaraciones.

Los tabuladores se sustituyen (de izquierda a derecha) por uno a ocho espacios, de manera que el número total de caracteres hasta el reemplazo inclusive es un múltiplo de ocho (se pretende que sea la misma regla que la utilizada por Unix).  El número total de espacios que preceden al primer carácter no en blanco determina entonces la sangría de la línea.  La sangría no puede dividirse en múltiples líneas físicas utilizando barras invertidas; el espacio en blanco hasta la primera barra invertida determina la sangría.

La indentación se rechaza como inconsistente si un archivo fuente mezcla tabulaciones y espacios de manera que el significado depende del valor de una tabulación en los espacios; un @ref{5e6,,TabError} se produce en ese caso.

`Nota de compatibilidad entre plataformas:' debido a la naturaleza de los editores de texto en plataformas que no sean UNIX, no es aconsejable utilizar una mezcla de espacios y tabuladores para la sangría en un solo archivo de origen.  También debe tenerse en cuenta que las diferentes plataformas pueden limitar explícitamente el nivel máximo de sangría.

Un carácter `formfeed' puede estar presente al comienzo de la línea; será ignorado para los cálculos de sangría anteriores.  Los caracteres `formfeed' que aparecen en otras partes del espacio en blanco inicial tienen un efecto indefinido (por ejemplo, pueden poner a cero el recuento de espacio).

@geindex INDENT token
@geindex DEDENT token

Los niveles de sangría de las líneas consecutivas se utilizan para generar tokens INDENT y DEDENT, utilizando una pila, de la siguiente manera.

Antes de que se lea la primera línea del archivo, se empuja un solo cero en la pila; esto no volverá a saltar.  Los números empujados en la pila siempre irán aumentando estrictamente de abajo hacia arriba.  Al principio de cada línea lógica, el nivel de sangría de la línea se compara con la parte superior de la pila. Si es igual, no pasa nada. Si es mayor, se empuja en la pila, y se genera un token INDENT.  Si es más pequeño, `debe' ser uno de los números de la pila; todos los números de la pila que son más grandes se sacan, y por cada número sacado se genera un token DEDENT.  Al final del archivo, se genera un token DEDENT por cada número restante de la pila que sea mayor que cero.

Aquí hay un ejemplo de un código de Python con una correcta (aunque no tan clara) sangría:

@example
def perm(l):
        # Compute the list of all permutations of l
    if len(l) <= 1:
                  return [l]
    r = []
    for i in range(len(l)):
             s = l[:i] + l[i+1:]
             p = perm(s)
             for x in p:
              r.append(l[i:i+1] + x)
    return r
@end example

El siguiente ejemplo muestra varios errores de sangría:

@example
 def perm(l):                       # error: first line indented
for i in range(len(l)):             # error: not indented
    s = l[:i] + l[i+1:]
        p = perm(l[:i] + l[i+1:])   # error: unexpected indent
        for x in p:
                r.append(l[i:i+1] + x)
            return r                # error: inconsistent dedent
@end example

(En realidad, los tres primeros errores son detectados por el analizador; sólo el último error es encontrado por el analizador léxico — la sangría de @code{return r} no coincide con un nivel sacado de la pila.)

@node Espacios en blanco entre tokens,,Sangría,Estructura de línea
@anchor{reference/lexical_analysis whitespace}@anchor{1e90}@anchor{reference/lexical_analysis whitespace-between-tokens}@anchor{1e91}
@subsubsection Espacios en blanco entre tokens


A excepción del comienzo de una línea lógica o en los literales de cadenas, los caracteres de espacio en blanco, tabulación y formfeed pueden utilizarse indistintamente para separar tokens.  Los espacios en blanco se necesitan entre dos tokens sólo si su concatenación podría interpretarse de otra manera como un token diferente (por ejemplo, ab es un token, pero a b corresponde a dos tokens).

@node Otros tokens,Identificadores y palabras clave,Estructura de línea,Análisis léxico
@anchor{reference/lexical_analysis id7}@anchor{1e92}@anchor{reference/lexical_analysis other-tokens}@anchor{1e93}
@subsection Otros tokens


Además de NEWLINE, INDENT y DEDENT, existen las siguientes categorías de fichas: `identifiers' (identificadores), `keywords' (palabras clave), `literals' (literales), `operators' (operadores) y `delimiters' (delimitadores). Los caracteres de espacio en blanco (distintos de los terminadores de línea, discutidos anteriormente) no son tokens, pero sirven para delimitarlos. En los casos en que exista ambigüedad, un token comprende la cadena más larga posible que forma un token legal cuando se lee de izquierda a derecha.

@node Identificadores y palabras clave,Literales,Otros tokens,Análisis léxico
@anchor{reference/lexical_analysis identifiers}@anchor{1e94}@anchor{reference/lexical_analysis identifiers-and-keywords}@anchor{1e95}
@subsection Identificadores y palabras clave


@geindex identifier
@geindex name

Los identificadores (también denominados `nombres') se describen mediante las siguientes definiciones léxicas.

La sintaxis de los identificadores en Python se basa en el anexo estándar de Unicode UAX-31, con la elaboración y los cambios que se definen a continuación; ver también 
@geindex Python Enhancement Proposals; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/} para más detalles.

Within the ASCII range (U+0001..U+007F), the valid characters for identifiers
include the uppercase and lowercase letters @code{A} through
@code{Z}, the underscore @code{_} and, except for the first character, the digits
@code{0} through @code{9}.
Python 3.0 introduced additional characters from outside the ASCII range (see
@geindex Python Enhancement Proposals; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}).  For these characters, the classification uses the version of the
Unicode Character Database as included in the @ref{105,,unicodedata} module.

Los identificadores son de extensión ilimitada.  Las mayúsculas y minúsculas son significativas.

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-identifier}@anchor{1e96}identifier   ::= xid_start xid_continue*
@anchor{reference/lexical_analysis grammar-token-python-grammar-id_start}@anchor{1e97}id_start     ::= <all characters in general categories Lu, Ll, Lt, Lm, Lo, Nl, the underscore, and characters with the Other_ID_Start property>
@anchor{reference/lexical_analysis grammar-token-python-grammar-id_continue}@anchor{1e98}id_continue  ::= <all characters in id_start, plus characters in the categories Mn, Mc, Nd, Pc and others with the Other_ID_Continue property>
@anchor{reference/lexical_analysis grammar-token-python-grammar-xid_start}@anchor{1e99}xid_start    ::= <all characters in id_start whose NFKC normalization is in "id_start xid_continue*">
@anchor{reference/lexical_analysis grammar-token-python-grammar-xid_continue}@anchor{1e9a}xid_continue ::= <all characters in id_continue whose NFKC normalization is in "id_continue*">
@end example

Los códigos de la categoría Unicode mencionados anteriormente representan:


@itemize *

@item 
`Lu' - letras mayúsculas

@item 
`Ll' - letras minúsculas

@item 
`Lt' - letras de `titlecase'

@item 
`Lm' - letras modificadoras

@item 
`Lo' - otras letras

@item 
`Nl' - números de letra

@item 
`Mn' - marcas sin separación

@item 
`Mc' - marcas de combinación de separación

@item 
`Nd' - números decimales

@item 
`Pc' - puntuaciones conectoras

@item 
`Other_ID_Start' - explicit list of characters in PropList.txt@footnote{https://www.unicode.org/Public/16.0.0/ucd/PropList.txt} to support backwards
compatibility

@item 
`Other_ID_Continue' - Así mismo
@end itemize

Todos los identificadores se convierten en la forma normal NFKC mientras se analizan; la comparación de los identificadores se basa en NFKC.

A non-normative HTML file listing all valid identifier characters for Unicode
16.0.0 can be found at
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/DerivedCoreProperties.txt}

@menu
* Palabras clave:: 
* Palabras clave suaves:: 
* Clases reservadas de identificadores:: 

@end menu

@node Palabras clave,Palabras clave suaves,,Identificadores y palabras clave
@anchor{reference/lexical_analysis id8}@anchor{1e9b}@anchor{reference/lexical_analysis keywords}@anchor{1e9c}
@subsubsection Palabras clave


@geindex keyword
@geindex reserved word

Los siguientes identificadores se utilizan como palabras reservadas, o `palabras clave' del idioma, y no pueden utilizarse como identificadores ordinarios.  Deben escribirse exactamente como están escritas aquí:

@example
False      await      else       import     pass
None       break      except     in         raise
True       class      finally    is         return
and        continue   for        lambda     try
as         def        from       nonlocal   while
assert     del        global     not        with
async      elif       if         or         yield
@end example

@node Palabras clave suaves,Clases reservadas de identificadores,Palabras clave,Identificadores y palabras clave
@anchor{reference/lexical_analysis id9}@anchor{1e9d}@anchor{reference/lexical_analysis soft-keywords}@anchor{8a3}
@subsubsection Palabras clave suaves


@geindex soft keyword
@geindex keyword


Added in version 3.10.


Some identifiers are only reserved under specific contexts. These are known as
`soft keywords'.  The identifiers @code{match}, @code{case}, @code{type} and @code{_} can
syntactically act as keywords in certain contexts,
but this distinction is done at the parser level, not when tokenizing.

As soft keywords, their use in the grammar is possible while still
preserving compatibility with existing code that uses these names as
identifier names.

@code{match}, @code{case}, and @code{_} are used in the @ref{8a4,,match} statement.
@code{type} is used in the @ref{4e6,,type} statement.


Distinto en la versión 3.12: @code{type} is now a soft keyword.


@geindex _@comma{} identifiers
@geindex __@comma{} identifiers

@node Clases reservadas de identificadores,,Palabras clave suaves,Identificadores y palabras clave
@anchor{reference/lexical_analysis id-classes}@anchor{1e9e}@anchor{reference/lexical_analysis reserved-classes-of-identifiers}@anchor{1e9f}
@subsubsection Clases reservadas de identificadores


Ciertas clases de identificadores (además de las palabras clave) tienen significados especiales.  Estas clases se identifican por los patrones de los caracteres de guión bajo que van delante y detrás:


@table @asis

@item @code{_*}

No importado por @code{from module import *}.

@item @code{_}

En un patrón @code{case} dentro de una declaración @ref{8a4,,match}, @code{_} es una @ref{8a3,,palabra clave suave} que denota un comodín @ref{8a5,,wildcard}.

Por separado, el intérprete interactivo pone a disposición el resultado de la última evaluación en la variable @code{_}. (Se almacena en el módulo @ref{13,,builtins}, junto con funciones incorporadas como @code{print}).

En otros lugares, @code{_} es un identificador regular. A menudo se usa para nombrar elementos «especiales», pero no es especial para Python en sí.

@cartouche
@quotation Nota 
El nombre @code{_} se usa a menudo en conjunción con la internacionalización; consultar la documentación del módulo @code{gettext`} para más información sobre esta convención.

También se usa comúnmente para variables no utilizadas.
@end quotation
@end cartouche

@item @code{__*__}

Nombres definidos por el sistema, conocidos informalmente como nombres «`dunder'». Estos nombres son definidos por el intérprete y su aplicación (incluida la biblioteca estándar). Los nombres actuales del sistema se discuten en la sección @ref{cf6,,Nombres especiales de método} y en otros lugares. Es probable que se definan más en futuras versiones de Python.  `Cualquier' uso de nombres @code{__*__}, en cualquier contexto, que no siga un uso explícitamente documentado, está sujeto a que se rompa sin previo aviso.

@item @code{__*}

Nombres de clase privada.  Los nombres de esta categoría, cuando se utilizan en el contexto de una definición de clase, se reescriben para utilizar una forma desfigurada que ayude a evitar conflictos de nombres entre los atributos «privados» de las clases base y derivadas. Ver la sección @ref{1ea0,,Identificadores (Nombres)}.
@end table

@node Literales,Operadores,Identificadores y palabras clave,Análisis léxico
@anchor{reference/lexical_analysis id10}@anchor{1ea1}@anchor{reference/lexical_analysis literals}@anchor{1ea2}
@subsection Literales


@geindex literal
@geindex constant

Los literales son notaciones para los valores constantes de algunos tipos incorporados.

@geindex string literal
@geindex bytes literal
@geindex ASCII
@geindex ' (single quote);string literal
@geindex " (double quote);string literal
@geindex u';string literal
@geindex u";string literal

@menu
* Literales de cadenas y bytes:: 
* Concatenación de literales de cadena:: 
* f-strings:: 
* Literales numéricos:: 
* Literales enteros:: 
* Floating-point literals:: 
* Literales imaginarios:: 

@end menu

@node Literales de cadenas y bytes,Concatenación de literales de cadena,,Literales
@anchor{reference/lexical_analysis string-and-bytes-literals}@anchor{1ea3}@anchor{reference/lexical_analysis strings}@anchor{1ea4}
@subsubsection Literales de cadenas y bytes


Los literales de cadena se describen mediante las siguientes definiciones léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringliteral}@anchor{1ea5}stringliteral   ::= [stringprefix](shortstring | longstring)
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringprefix}@anchor{1ea6}stringprefix    ::= "r" | "u" | "R" | "U" | "f" | "F"
                    | "fr" | "Fr" | "fR" | "FR" | "rf" | "rF" | "Rf" | "RF"
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortstring}@anchor{1ea7}shortstring     ::= "'" shortstringitem* "'" | '"' shortstringitem* '"'
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstring}@anchor{1ea8}longstring      ::= "'@w{'}'" longstringitem* "'@w{'}'" | '"""' longstringitem* '"""'
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortstringitem}@anchor{1ea9}shortstringitem ::= shortstringchar | stringescapeseq
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstringitem}@anchor{1eaa}longstringitem  ::= longstringchar | stringescapeseq
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortstringchar}@anchor{1eab}shortstringchar ::= <any source character except "\" or newline or the quote>
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstringchar}@anchor{1eac}longstringchar  ::= <any source character except "\">
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringescapeseq}@anchor{1ead}stringescapeseq ::= "\" <any source character>
@end example

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesliteral}@anchor{1eae}bytesliteral   ::= bytesprefix(shortbytes | longbytes)
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesprefix}@anchor{1eaf}bytesprefix    ::= "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB"
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbytes}@anchor{1eb0}shortbytes     ::= "'" shortbytesitem* "'" | '"' shortbytesitem* '"'
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbytes}@anchor{1eb1}longbytes      ::= "'@w{'}'" longbytesitem* "'@w{'}'" | '"""' longbytesitem* '"""'
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbytesitem}@anchor{1eb2}shortbytesitem ::= shortbyteschar | bytesescapeseq
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbytesitem}@anchor{1eb3}longbytesitem  ::= longbyteschar | bytesescapeseq
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbyteschar}@anchor{1eb4}shortbyteschar ::= <any ASCII character except "\" or newline or the quote>
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbyteschar}@anchor{1eb5}longbyteschar  ::= <any ASCII character except "\">
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesescapeseq}@anchor{1eb6}bytesescapeseq ::= "\" <any ASCII character>
@end example

Una restricción sintáctica no indicada por estas producciones es que no se permiten espacios en blanco entre @ref{1ea6,,stringprefix} o @ref{1eaf,,bytesprefix} y el resto del literal. El conjunto de caracteres de origen se define mediante la declaración de codificación; es UTF-8 si no se proporciona una declaración de codificación en el archivo fuente; ver apartado @ref{1e87,,Declaración de Codificación}.

@geindex triple-quoted string
@geindex Unicode Consortium
@geindex raw string
@geindex """;string literal
@geindex '@w{'}';string literal

In plain English: Both types of literals can be enclosed in matching single quotes
(@code{'}) or double quotes (@code{"}).  They can also be enclosed in matching groups
of three single or double quotes (these are generally referred to as
`triple-quoted strings'). The backslash (@code{\}) character is used to give special
meaning to otherwise ordinary characters like @code{n}, which means “newline” when
escaped (@code{\n}). It can also be used to escape characters that otherwise have a
special meaning, such as newline, backslash itself, or the quote character.
See @ref{505,,escape sequences} below for examples.

@geindex b';bytes literal
@geindex b";bytes literal

Los literales de bytes siempre se prefijan con @code{'b'} o @code{'B'}; producen una instancia del tipo @ref{325,,bytes} en lugar del tipo @ref{237,,str}.  Sólo pueden contener caracteres ASCII; los bytes con un valor numérico de 128 o mayor deben ser expresados con escapes.

@geindex r';raw string literal
@geindex r";raw string literal

Both string and bytes literals may optionally be prefixed with a letter @code{'r'}
or @code{'R'}; such constructs are called `raw string literals'
and `raw bytes literals' respectively and treat backslashes as
literal characters.  As a result, in raw string literals, @code{'\U'} and @code{'\u'}
escapes are not treated specially.


Added in version 3.3: El prefijo @code{'rb'} de literales de bytes raw se ha añadido como sinónimo de @code{'br'}.

Se reintrodujo el soporte para el legado unicode literal (@code{u'value'}) para simplificar el mantenimiento de las bases de código dual Python 2.x y 3.x. Ver 
@geindex Python Enhancement Proposals; PEP 414
PEP 414@footnote{https://peps.python.org/pep-0414/} para más información.


@geindex f';formatted string literal
@geindex f";formatted string literal

Un literal de cadena con @code{'f'} o @code{'F'} en su prefijo es un `formatted string literal'; ver @ref{a3b,,f-strings}.  La @code{'f'} puede combinarse con la @code{'r'}, pero no con la @code{'b'} o @code{'u'}, por lo que las cadenas `raw' formateadas son posibles, pero los literales de bytes formateados no lo son.

En los literales de triple cita, se permiten (y se retienen) nuevas líneas y citas no escapadas, excepto cuando tres citas no escapadas seguidas finalizan el literal.  (Una «cita» es el carácter utilizado para abrir el literal, es decir, ya sea @code{'} o @code{"}.)

@geindex physical line
@geindex escape sequence
@geindex Standard C
@geindex C
@geindex \ (backslash);escape sequence
@geindex \\;escape sequence
@geindex \a;escape sequence
@geindex \b;escape sequence
@geindex \f;escape sequence
@geindex \n;escape sequence
@geindex \r;escape sequence
@geindex \t;escape sequence
@geindex \v;escape sequence
@geindex \x;escape sequence
@geindex \N;escape sequence
@geindex \u;escape sequence
@geindex \U;escape sequence

@menu
* Escape sequences:: 

@end menu

@node Escape sequences,,,Literales de cadenas y bytes
@anchor{reference/lexical_analysis escape-sequences}@anchor{505}@anchor{reference/lexical_analysis id11}@anchor{1eb7}
@subsubsection Escape sequences


A menos que un prefijo @code{'r'} o @code{'R'} esté presente, las secuencias de escape en literales de cadena y bytes se interpretan según reglas similares a las usadas por C estándar. Las secuencias de escape reconocidas son:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Secuencia de escape

@tab

Significado

@tab

Notas

@item

@code{\}<newline>

@tab

Barra inversa y línea nueva ignoradas

@tab

(1)

@item

@code{\\}

@tab

Barra inversa (@code{\})

@tab

@item

@code{\'}

@tab

Comilla simple (@code{'})

@tab

@item

@code{\"}

@tab

Comilla doble (@code{"})

@tab

@item

@code{\a}

@tab

ASCII Bell (BEL)

@tab

@item

@code{\b}

@tab

ASCII Retroceso (BS)

@tab

@item

@code{\f}

@tab

ASCII Formfeed (FF)

@tab

@item

@code{\n}

@tab

ASCII Linefeed (LF)

@tab

@item

@code{\r}

@tab

ASCII Retorno de carro (CR)

@tab

@item

@code{\t}

@tab

ASCII Sangría horizontal (TAB)

@tab

@item

@code{\v}

@tab

ASCII Sangría vertical (VT)

@tab

@item

@code{\@var{ooo}}

@tab

Carácter con valor octal `ooo'

@tab

(2,4)

@item

@code{\x@var{hh}}

@tab

Carácter con valor hexadecimal `hh'

@tab

(3,4)

@end multitable


Las secuencias de escape que sólo se reconocen en los literales de cadena son:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Secuencia de escape

@tab

Significado

@tab

Notas

@item

@code{\N@{@var{name}@}}

@tab

El carácter llamado `name' en la base de datos de Unicode

@tab

(5)

@item

@code{\u@var{xxxx}}

@tab

Carácter con valor hexadecimal de 16 bits `xxxx'

@tab

(6)

@item

@code{\U@var{xxxxxxxx}}

@tab

Carácter con valor hexadecimal de 32 bits `xxxxxxxx'

@tab

(7)

@end multitable


Notas:


@enumerate 

@item 
Se puede agregar una barra invertida al final de una línea para ignorar la nueva línea:

@example
>>> 'This string will not include \
... backslashes or newline characters.'
'This string will not include backslashes or newline characters.'
@end example

Se puede lograr el mismo resultado usando @ref{1ea4,,triple-quoted strings}, o paréntesis y @ref{1eb8,,string literal concatenation}.

@item 
Como en C estándar, se aceptan hasta tres dígitos octales.


Distinto en la versión 3.11: Octal escapes with value larger than @code{0o377} produce a
@ref{1da,,DeprecationWarning}.



Distinto en la versión 3.12: Octal escapes with value larger than @code{0o377} produce a
@ref{511,,SyntaxWarning}. In a future Python version they will be eventually
a @ref{150,,SyntaxError}.


@item 
A diferencia de C estándar, se requieren exactamente dos dígitos hexadecimales.

@item 
En un literal de bytes, los escapes hexadecimal y octal denotan el byte con el valor dado. En un literal de cadena, estos escapes denotan un carácter Unicode con el valor dado.

@item 

Distinto en la versión 3.3: Se ha añadido el soporte para los alias de nombres @footnote{
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/NameAliases.txt}
}.


@item 
Se requieren exactamente cuatro dígitos hexadecimales.

@item 
Cualquier carácter Unicode puede ser codificado de esta manera.  Se requieren exactamente ocho dígitos hexadecimales.
@end enumerate

@geindex unrecognized escape sequence

A diferencia de C estándar, todas las secuencias de escape no reconocidas se dejan en la cadena sin cambios, es decir, `la barra invertida se deja en el resultado'.  (Este comportamiento es útil para la depuración: si una secuencia de escape se escribe mal, la salida resultante se reconoce más fácilmente como rota).  También es importante señalar que las secuencias de escape sólo reconocidas en los literales de cadena caen en la categoría de escapes no reconocidos para los literales de bytes.


Distinto en la versión 3.6: Unrecognized escape sequences produce a @ref{1da,,DeprecationWarning}.



Distinto en la versión 3.12: Unrecognized escape sequences produce a @ref{511,,SyntaxWarning}. In a future
Python version they will be eventually a @ref{150,,SyntaxError}.


Incluso en un literal `raw', las comillas se pueden escapar con una barra inversa, pero la barra inversa permanece en el resultado; por ejemplo, @code{r"\""} es un literal de cadena válido que consiste en dos caracteres: una barra inversa y una comilla doble; @code{r"\"} no es un literal de cadena válido (incluso una cadena en bruto no puede terminar en un número impar de barras inversas).  Específicamente, `un literal raw no puede terminar en una sola barra inversa' (ya que la barra inversa se escaparía del siguiente carácter de comillas). Nótese también que una sola barra inversa seguida de una nueva línea se interpreta como esos dos caracteres como parte del literal, `no' como una continuación de línea.

@node Concatenación de literales de cadena,f-strings,Literales de cadenas y bytes,Literales
@anchor{reference/lexical_analysis string-concatenation}@anchor{1eb8}@anchor{reference/lexical_analysis string-literal-concatenation}@anchor{1eb9}
@subsubsection Concatenación de literales de cadena


Se permiten múltiples literales de cadenas o bytes adyacentes (delimitados por espacios en blanco), posiblemente utilizando diferentes convenciones de citas, y su significado es el mismo que su concatenación.  Por lo tanto, @code{"hola" 'mundo'} es equivalente a @code{"holamundo"}.  Esta característica puede ser utilizada para reducir el número de barras inversas necesarias, para dividir largas cadenas convenientemente a través de largas líneas, o incluso para añadir comentarios a partes de las cadenas, por ejemplo:

@example
re.compile("[A-Za-z_]"       # letter or underscore
           "[A-Za-z0-9_]*"   # letter, digit or underscore
          )
@end example

Téngase en cuenta que esta característica se define a nivel sintáctico, pero se implementa en el momento de la compilación.  El operador “+” debe ser usado para concatenar expresiones de cadena al momento de la ejecución.  Observar también que la concatenación de literales puede utilizar diferentes estilos de citas para cada componente (incluso mezclando cadenas `raw' y cadenas con triple comilla), y los literales de cadena formateados pueden ser concatenados con los literales de cadena simples.

@geindex formatted string literal
@geindex interpolated string literal
@geindex string;formatted literal
@geindex string;interpolated literal
@geindex f-string
@geindex fstring
@geindex @{@} (curly brackets);in formatted string literal
@geindex ! (exclamation);in formatted string literal
@geindex ; (colon);in formatted string literal
@geindex = (equals);for help in debugging using string literals
@anchor{reference/lexical_analysis f-strings}@anchor{a3b}
@node f-strings,Literales numéricos,Concatenación de literales de cadena,Literales
@anchor{reference/lexical_analysis formatted-string-literals}@anchor{1eba}@anchor{reference/lexical_analysis id13}@anchor{1ebb}
@subsubsection f-strings



Added in version 3.6.


Un `formatted string literal' o `f-string' es un literal de cadena que se prefija con @code{'f'} o @code{'F'}.  Estas cadenas pueden contener campos de reemplazo, que son expresiones delimitadas por llaves @code{@{@}}. Mientras que otros literales de cadena siempre tienen un valor constante, las cadenas formateadas son realmente expresiones evaluadas en tiempo de ejecución.

Las secuencias de escape se decodifican como en los literales de cadena ordinarios (excepto cuando un literal también se marca como cadena `raw').  Después de la decodificación, la gramática para el contenido de la cadena es:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_string}@anchor{1ebc}f_string          ::= (literal_char | "@{@{" | "@}@}" | replacement_field)*
@anchor{reference/lexical_analysis grammar-token-python-grammar-replacement_field}@anchor{1ebd}replacement_field ::= "@{" f_expression ["="] ["!" conversion] [":" format_spec] "@}"
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_expression}@anchor{1ebe}f_expression      ::= (conditional_expression | "*" or_expr)
                        ("," conditional_expression | "," "*" or_expr)* [","]
                      | yield_expression
@anchor{reference/lexical_analysis grammar-token-python-grammar-conversion}@anchor{1ebf}conversion        ::= "s" | "r" | "a"
@anchor{reference/lexical_analysis grammar-token-python-grammar-format_spec}@anchor{1ec0}format_spec       ::= (literal_char | replacement_field)*
@anchor{reference/lexical_analysis grammar-token-python-grammar-literal_char}@anchor{1ec1}literal_char      ::= <any code point except "@{", "@}" or NULL>
@end example

Las partes de la cadena fuera de las llaves se tratan literalmente, excepto que las llaves dobles @code{'@{@{'} o @code{'@}@}'} se reemplazan con la llave simple correspondiente. Un solo corchete de apertura @code{'@{'} marca un campo de reemplazo, que comienza con una expresión de Python. Para mostrar tanto el texto de la expresión como su valor después de la evaluación (útil en la depuración), se puede agregar un signo igual @code{'='} después de la expresión. Puede seguir un campo de conversión, introducido por un signo de exclamación @code{'!'}. También se puede agregar un especificador de formato, introducido por dos puntos @code{':'}. Un campo de reemplazo termina con un corchete de cierre @code{'@}'}.

Expressions in formatted string literals are treated like regular
Python expressions surrounded by parentheses, with a few exceptions.
An empty expression is not allowed, and both @ref{1309,,lambda}  and
assignment expressions @code{:=} must be surrounded by explicit parentheses.
Each expression is evaluated in the context where the formatted string literal
appears, in order from left to right.  Replacement expressions can contain
newlines in both single-quoted and triple-quoted f-strings and they can contain
comments.  Everything that comes after a @code{#} inside a replacement field
is a comment (even closing braces and quotes). In that case, replacement fields
must be closed in a different line.

@example
>>> f"abc@{a # This is a comment @}"
... + 3@}"
'abc5'
@end example


Distinto en la versión 3.7: Antes de Python 3.7, una expresión @ref{14e,,await} y comprensiones que contenían una cláusula @ref{b36,,async for} eran ilegales en las expresiones en literales de cadenas formateadas debido a un problema con la implementación.



Distinto en la versión 3.12: Prior to Python 3.12, comments were not allowed inside f-string replacement
fields.


Cuando se proporciona el signo igual @code{'='}, la salida tendrá el texto de expresión, el @code{'='} y el valor evaluado. Los espacios después de la llave de apertura @code{'@{'}, dentro de la expresión y después de @code{'='} se conservan en la salida. Por defecto, el @code{'='} hace que se proporcione @ref{894,,repr()} de la expresión, a menos que haya un formato especificado. Cuando se especifica un formato, el valor predeterminado es @ref{237,,str()} de la expresión a menos que se declare una conversión @code{'!r'}.


Added in version 3.8: El símbolo igual @code{'='}.


Si se especifica una conversión, el resultado de la evaluación de la expresión se convierte antes del formateo.  La conversión @code{`!s'} llama @ref{237,,str()} al resultado, @code{`!r'} llama @ref{894,,repr()}, y @code{`!a'} llama @ref{1426,,ascii()}.

The result is then formatted using the @ref{6c0,,format()} protocol.  The
format specifier is passed to the @ref{6bf,,__format__()} method of the
expression or conversion result.  An empty string is passed when the
format specifier is omitted.  The formatted result is then included in
the final value of the whole string.

Los especificadores de formato de nivel superior pueden incluir campos de reemplazo anidados. Estos campos anidados pueden incluir sus propios campos de conversión y @ref{347,,format specifiers}, pero no pueden incluir campos de reemplazo anidados más profundos. El @ref{347,,format specifier mini-language} es el mismo que usa el método @ref{6c2,,str.format()}.

Los literales de cadena formateados pueden ser concatenados, pero los campos de reemplazo no pueden ser divididos entre los literales.

Algunos ejemplos de literales de cadena formateados:

@example
>>> name = "Fred"
>>> f"He said his name is @{name!r@}."
"He said his name is 'Fred'."
>>> f"He said his name is @{repr(name)@}."  # repr() is equivalent to !r
"He said his name is 'Fred'."
>>> width = 10
>>> precision = 4
>>> value = decimal.Decimal("12.34567")
>>> f"result: @{value:@{width@}.@{precision@}@}"  # nested fields
'result:      12.35'
>>> today = datetime(year=2017, month=1, day=27)
>>> f"@{today:%B %d, %Y@}"  # using date format specifier
'January 27, 2017'
>>> f"@{today=:%B %d, %Y@}" # using date format specifier and debugging
'today=January 27, 2017'
>>> number = 1024
>>> f"@{number:#0x@}"  # using integer format specifier
'0x400'
>>> foo = "bar"
>>> f"@{ foo = @}" # preserves whitespace
" foo = 'bar'"
>>> line = "The mill's closed"
>>> f"@{line = @}"
'line = "The mill\'s closed"'
>>> f"@{line = :20@}"
"line = The mill's closed   "
>>> f"@{line = !r:20@}"
'line = "The mill\'s closed" '
@end example

Reusing the outer f-string quoting type inside a replacement field is
permitted:

@example
>>> a = dict(x=2)
>>> f"abc @{a["x"]@} def"
'abc 2 def'
@end example


Distinto en la versión 3.12: Prior to Python 3.12, reuse of the same quoting type of the outer f-string
inside a replacement field was not possible.


Backslashes are also allowed in replacement fields and are evaluated the same
way as in any other context:

@example
>>> a = ["a", "b", "c"]
>>> print(f"List a contains:\n@{"\n".join(a)@}")
List a contains:
a
b
c
@end example


Distinto en la versión 3.12: Prior to Python 3.12, backslashes were not permitted inside an f-string
replacement field.


Los literales de cadena formateados no pueden ser usados como cadenas de documentos (`docstrings'), aunque no incluyan expresiones.

@example
>>> def foo():
...     f"Not a docstring"
...
>>> foo.__doc__ is None
True
@end example

Ver también 
@geindex Python Enhancement Proposals; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} para la propuesta que añadió literales de cadenas formateados, y @ref{6c2,,str.format()}, que utiliza un mecanismo de cadenas formateadas relacionado.

@node Literales numéricos,Literales enteros,f-strings,Literales
@anchor{reference/lexical_analysis numbers}@anchor{1ec2}@anchor{reference/lexical_analysis numeric-literals}@anchor{1ec3}
@subsubsection Literales numéricos


@geindex number
@geindex numeric literal
@geindex integer literal
@geindex floating-point literal
@geindex hexadecimal literal
@geindex octal literal
@geindex binary literal
@geindex decimal literal
@geindex imaginary literal
@geindex complex literal

There are three types of numeric literals: integers, floating-point numbers, and
imaginary numbers.  There are no complex literals (complex numbers can be formed
by adding a real number and an imaginary number).

Nótese que los literales numéricos no incluyen un signo; una frase como @code{-1} es en realidad una expresión compuesta por el operador unario “@code{-}” y el literal @code{1}.

@geindex 0b;integer literal
@geindex 0o;integer literal
@geindex 0x;integer literal
@geindex _ (underscore);in numeric literal

@node Literales enteros,Floating-point literals,Literales numéricos,Literales
@anchor{reference/lexical_analysis integer-literals}@anchor{1ec4}@anchor{reference/lexical_analysis integers}@anchor{1ec5}
@subsubsection Literales enteros


Los literales enteros se describen mediante las siguientes definiciones léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-integer}@anchor{1ec6}integer      ::= decinteger | bininteger | octinteger | hexinteger
@anchor{reference/lexical_analysis grammar-token-python-grammar-decinteger}@anchor{1ec7}decinteger   ::= nonzerodigit (["_"] digit)* | "0"+ (["_"] "0")*
@anchor{reference/lexical_analysis grammar-token-python-grammar-bininteger}@anchor{1ec8}bininteger   ::= "0" ("b" | "B") (["_"] bindigit)+
@anchor{reference/lexical_analysis grammar-token-python-grammar-octinteger}@anchor{1ec9}octinteger   ::= "0" ("o" | "O") (["_"] octdigit)+
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexinteger}@anchor{1eca}hexinteger   ::= "0" ("x" | "X") (["_"] hexdigit)+
@anchor{reference/lexical_analysis grammar-token-python-grammar-nonzerodigit}@anchor{1ecb}nonzerodigit ::= "1"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-digit}@anchor{1ecc}digit        ::= "0"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-bindigit}@anchor{1ecd}bindigit     ::= "0" | "1"
@anchor{reference/lexical_analysis grammar-token-python-grammar-octdigit}@anchor{1ece}octdigit     ::= "0"..."7"
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexdigit}@anchor{1ecf}hexdigit     ::= digit | "a"..."f" | "A"..."F"
@end example

No hay límite para la longitud de los literales enteros aparte de lo que se puede almacenar en la memoria disponible.

Los guiones bajos se ignoran para determinar el valor numérico del literal.  Se pueden utilizar para agrupar los dígitos para mejorar la legibilidad.  Un guión bajo puede ocurrir entre dígitos y después de especificadores de base como @code{0x}.

Nótese que no se permiten los ceros a la izquierda en un número decimal que no sea cero. Esto es para desambiguar con los literales octales de estilo C, que Python usaba antes de la versión 3.0.

Algunos ejemplos de literales enteros:

@example
7     2147483647                        0o177    0b100110111
3     79228162514264337593543950336     0o377    0xdeadbeef
      100_000_000_000                   0b_1110_0101
@end example


Distinto en la versión 3.6: Los guiones bajos están ahora permitidos para agrupar en literales.


@geindex . (dot);in numeric literal
@geindex e;in numeric literal
@geindex _ (underscore);in numeric literal

@node Floating-point literals,Literales imaginarios,Literales enteros,Literales
@anchor{reference/lexical_analysis floating}@anchor{1ed0}@anchor{reference/lexical_analysis floating-point-literals}@anchor{1ed1}
@subsubsection Floating-point literals


Floating-point literals are described by the following lexical definitions:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-floatnumber}@anchor{1ed2}floatnumber   ::= pointfloat | exponentfloat
@anchor{reference/lexical_analysis grammar-token-python-grammar-pointfloat}@anchor{1ed3}pointfloat    ::= [digitpart] fraction | digitpart "."
@anchor{reference/lexical_analysis grammar-token-python-grammar-exponentfloat}@anchor{1ed4}exponentfloat ::= (digitpart | pointfloat) exponent
@anchor{reference/lexical_analysis grammar-token-python-grammar-digitpart}@anchor{1ed5}digitpart     ::= digit (["_"] digit)*
@anchor{reference/lexical_analysis grammar-token-python-grammar-fraction}@anchor{1ed6}fraction      ::= "." digitpart
@anchor{reference/lexical_analysis grammar-token-python-grammar-exponent}@anchor{1ed7}exponent      ::= ("e" | "E") ["+" | "-"] digitpart
@end example

Note that the integer and exponent parts are always interpreted using radix 10.
For example, @code{077e010} is legal, and denotes the same number as @code{77e10}. The
allowed range of floating-point literals is implementation-dependent.  As in
integer literals, underscores are supported for digit grouping.

Some examples of floating-point literals:

@example
3.14    10.    .001    1e100    3.14e-10    0e0    3.14_15_93
@end example


Distinto en la versión 3.6: Los guiones bajos están ahora permitidos para agrupar en literales.


@geindex j;in numeric literal

@node Literales imaginarios,,Floating-point literals,Literales
@anchor{reference/lexical_analysis imaginary}@anchor{1ed8}@anchor{reference/lexical_analysis imaginary-literals}@anchor{1ed9}
@subsubsection Literales imaginarios


Los literales imaginarios se describen en las siguientes definiciones léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-imagnumber}@anchor{1eda}imagnumber ::= (floatnumber | digitpart) ("j" | "J")
@end example

An imaginary literal yields a complex number with a real part of 0.0.  Complex
numbers are represented as a pair of floating-point numbers and have the same
restrictions on their range.  To create a complex number with a nonzero real
part, add a floating-point number to it, e.g., @code{(3+4j)}.  Some examples of
imaginary literals:

@example
3.14j   10.j    10j     .001j   1e100j   3.14e-10j   3.14_15_93j
@end example

@node Operadores,Delimitadores,Literales,Análisis léxico
@anchor{reference/lexical_analysis id14}@anchor{1edb}@anchor{reference/lexical_analysis operators}@anchor{1edc}
@subsection Operadores


@geindex operators

Los siguientes tokens son operadores:

@example
+       -       *       **      /       //      %      @@
<<      >>      &       |       ^       ~       :=
<       >       <=      >=      ==      !=
@end example

@node Delimitadores,,Operadores,Análisis léxico
@anchor{reference/lexical_analysis delimiters}@anchor{1edd}@anchor{reference/lexical_analysis id15}@anchor{1ede}
@subsection Delimitadores


@geindex delimiters

Los siguientes tokens sirven como delimitadores en la gramática:

@example
(       )       [       ]       @{       @}
,       :       !       .       ;       @@       =
->      +=      -=      *=      /=      //=     %=
@@=      &=      |=      ^=      >>=     <<=     **=
@end example

El punto también puede ocurrir en los literales de punto flotante e imaginarios.  Una secuencia de tres períodos tiene un significado especial como un literal de elipsis. La segunda mitad de la lista, los operadores de asignación aumentada, sirven léxicamente como delimitadores, pero también realizan una operación.

Los siguientes caracteres ASCII de impresión tienen un significado especial como parte de otros tokens o son de alguna manera significativos para el analizador léxico:

@example
'       "       #       \
@end example

Los siguientes caracteres ASCII de impresión no se utilizan en Python.  Su presencia fuera de las cadenas de caracteres y comentarios es un error incondicional:

@example
$       ?       `
@end example

@subsubheading Notas al pie de página


@node Modelo de datos,Modelo de ejecución,Análisis léxico,Referencia del Lenguaje Python
@anchor{reference/datamodel doc}@anchor{1edf}@anchor{reference/datamodel data-model}@anchor{1ee0}@anchor{reference/datamodel datamodel}@anchor{197a}
@section Modelo de datos


@menu
* Objetos@comma{} valores y tipos: Objetos valores y tipos. 
* Jerarquía de tipos estándar:: 
* Nombres especiales de método:: 
* Corrutinas:: 

@end menu

@node Objetos valores y tipos,Jerarquía de tipos estándar,,Modelo de datos
@anchor{reference/datamodel objects}@anchor{1ee1}@anchor{reference/datamodel objects-values-and-types}@anchor{1ee2}
@subsection Objetos, valores y tipos


@geindex Objetos
@geindex datos

`Objects' son la abstracción de Python para los datos. Todos los datos en un programa Python están representados por objetos o por relaciones entre objetos. (En cierto sentido y de conformidad con el modelo de Von Neumann de una «programa almacenado de computadora», el código también está representado por objetos.)

@geindex Funciones incorporadas;identificación
@geindex Funciones incorporadas;Tipos
@geindex identidad de un objeto
@geindex valor de un objeto
@geindex Tipos de objeto
@geindex Objetos mutables
@geindex Objetos inmutables

@c XXX it *is* now possible in some cases to change an object's
@c type, under certain controlled conditions

Every object has an identity, a type and a value.  An object’s `identity' never
changes once it has been created; you may think of it as the object’s address in
memory.  The @ref{1ee,,is} operator compares the identity of two objects; the
@ref{1462,,id()} function returns an integer representing its identity.

`Detalles de implementación de CPython:' Para CPython, @code{id(x)} es la dirección de memoria donde se almacena @code{x}.

El tipo de un objeto determina las operaciones que admite el objeto (por ejemplo, «¿tiene una longitud?») y también define los posibles valores para los objetos de ese tipo. La función @ref{dcf,,type()} retorna el tipo de un objeto (que es un objeto en sí mismo). Al igual que su identidad, también el `type' de un objeto es inmutable. @footnote{
Es posible cambiar en algunos casos un tipo de objeto bajo ciertas circunstancias controladas. Generalmente no es buena idea, ya que esto puede llevar a un comportamiento bastante extraño de no ser tratado correctamente.
}

El `valor' de algunos objetos puede cambiar. Se dice que los objetos cuyo valor puede cambiar son `mutables'; Los objetos cuyo valor no se puede modificar una vez que se crean se denominan `inmutables'. (El valor de un objeto contenedor inmutable que contiene una referencia a un objeto mutable puede cambiar cuando se cambia el valor de este último; sin embargo, el contenedor todavía se considera inmutable, porque la colección de objetos que contiene no se puede cambiar. Por lo tanto, la inmutabilidad no es estrictamente lo mismo que tener un valor inmutable, es más sutil). La mutabilidad de un objeto está determinada por su tipo; por ejemplo, los números, las cadenas de caracteres y las tuplas son inmutables, mientras que los diccionarios y las listas son mutables.

@geindex recolección de basura
@geindex conteo de referencias
@geindex objetos que no se pueden acceder

Los objetos nunca se destruyen explícitamente; sin embargo, cuando se vuelven inalcanzables, se pueden recolectar basura. Se permite a una implementación posponer la recolección de basura u omitirla por completo; es una cuestión de calidad de la implementación cómo se implementa la recolección de basura, siempre que no se recolecten objetos que todavía sean accesibles.

`Detalles de implementación de CPython:' CPython actualmente utiliza un esquema de conteo de referencias con detección retardada (opcional) de basura enlazada cíclicamente, que recolecta la mayoría de los objetos tan pronto como se vuelven inalcanzables, pero no se garantiza que recolecte basura que contenga referencias circulares. Vea la documentación del módulo @ref{60,,gc} para información sobre el control de la recolección de basura cíclica. Otras implementaciones actúan de manera diferente y CPython puede cambiar. No dependa de la finalización inmediata de los objetos cuando se vuelvan inalcanzables (por lo que siempre debe cerrar los archivos explícitamente).

Note that the use of the implementation’s tracing or debugging facilities may
keep objects alive that would normally be collectable. Also note that catching
an exception with a @ref{789,,try}…@ref{2f6,,except} statement may keep
objects alive.

Some objects contain references to «external» resources such as open files or
windows.  It is understood that these resources are freed when the object is
garbage-collected, but since garbage collection is not guaranteed to happen,
such objects also provide an explicit way to release the external resource,
usually a @code{close()} method. Programs are strongly recommended to explicitly
close such objects.  The @ref{789,,try}…@ref{a5c,,finally} statement
and the @ref{673,,with} statement provide convenient ways to do this.

@geindex contenedores

Algunos objetos contienen referencias a otros objetos; estos se llaman `contenedores'. Ejemplos de contenedores son tuplas, listas y diccionarios. Las referencias son parte del valor de un contenedor. En la mayoría de los casos, cuando hablamos del valor de un contenedor, implicamos los valores, no las identidades de los objetos contenidos; sin embargo, cuando hablamos de la mutabilidad de un contenedor, solo se implican las identidades de los objetos contenidos inmediatamente. Entonces, si un contenedor inmutable (como una tupla) contiene una referencia a un objeto mutable, su valor cambia si se cambia ese objeto mutable.

Types affect almost all aspects of object behavior.  Even the importance of
object identity is affected in some sense: for immutable types, operations that
compute new values may actually return a reference to any existing object with
the same type and value, while for mutable objects this is not allowed.
For example, after @code{a = 1; b = 1}, `a' and `b' may or may not refer to
the same object with the value one, depending on the implementation.
This is because @ref{1f0,,int} is an immutable type, so the reference to @code{1}
can be reused. This behaviour depends on the implementation used, so should
not be relied upon, but is something to be aware of when making use of object
identity tests.
However, after @code{c = []; d = []}, `c' and `d' are guaranteed to refer to two
different, unique, newly created empty lists. (Note that @code{e = f = []} assigns
the `same' object to both `e' and `f'.)

@node Jerarquía de tipos estándar,Nombres especiales de método,Objetos valores y tipos,Modelo de datos
@anchor{reference/datamodel the-standard-type-hierarchy}@anchor{1ee3}@anchor{reference/datamodel types}@anchor{1ee4}
@subsection Jerarquía de tipos estándar


@geindex Tipos
@geindex datos;Tipos
@geindex Tipos;jerarquía
@geindex extensión;Módulo
@geindex C;lenguaje

A continuación se muestra una lista de los tipos integrados en Python. Los módulos de extensión (escritos en C, Java u otros lenguajes, dependiendo de la implementación) pueden definir tipos adicionales. Las versiones futuras de Python pueden agregar tipos a la jerarquía de tipos (por ejemplo, números racionales, matrices de enteros almacenados de manera eficiente, etc.), aunque tales adiciones a menudo se proporcionarán a través de la biblioteca estándar.

@geindex atributo
@geindex especial;atributo
@geindex genérico;especial;atributo

Algunas de las descripciones de tipos a continuación contienen un párrafo que enumera “atributos especiales”. Estos son atributos que proporcionan acceso a la implementación y no están destinados para uso general. Su definición puede cambiar en el futuro.

@menu
* None:: 
* NotImplemented:: 
* Elipsis:: 
* numbers.Number: numbers Number. 
* Secuencias:: 
* Tipos de conjuntos:: 
* Mapeos:: 
* Tipos invocables:: 
* Módulos: Módulos<3>. 
* Clases personalizadas:: 
* Instancias de clase:: 
* Objetos E/S (también conocidos como objetos de archivo): Objetos E/S también conocidos como objetos de archivo. 
* Tipos internos:: 

@end menu

@node None,NotImplemented,,Jerarquía de tipos estándar
@anchor{reference/datamodel none}@anchor{1ee5}
@subsubsection None


@geindex Objetos;None

Este tipo tiene un solo valor. Hay un solo objeto con este valor. Se accede a este objeto a través del nombre incorporado @code{None}. Se utiliza para indicar la ausencia de un valor en muchas situaciones, por ejemplo, se retorna desde funciones que no retornan nada explícitamente. Su valor de verdad es falso.

@node NotImplemented,Elipsis,None,Jerarquía de tipos estándar
@anchor{reference/datamodel notimplemented}@anchor{1ee6}
@subsubsection NotImplemented


@geindex Objetos;NotImplemented

This type has a single value.  There is a single object with this value. This
object is accessed through the built-in name @ref{227,,NotImplemented}. Numeric methods
and rich comparison methods should return this value if they do not implement the
operation for the operands provided.  (The interpreter will then try the
reflected operation, or some other fallback, depending on the operator.)  It
should not be evaluated in a boolean context.

Vea @ref{1ee7,,Implementar operaciones aritméticas} para más detalles.


Distinto en la versión 3.9: Evaluating @ref{227,,NotImplemented} in a boolean context was deprecated.



Distinto en la versión 3.14: Evaluating @ref{227,,NotImplemented} in a boolean context now raises a @ref{228,,TypeError}.
It previously evaluated to @ref{c95,,True} and emitted a @ref{1da,,DeprecationWarning}
since Python 3.9.


@node Elipsis,numbers Number,NotImplemented,Jerarquía de tipos estándar
@anchor{reference/datamodel ellipsis}@anchor{1ee8}
@subsubsection Elipsis


@geindex Objetos;Elipsis
@geindex ...;elipsis literal

Este tipo tiene un solo valor. Hay un solo objeto con este valor. Se accede a este objeto a través del literal @code{...} o el nombre incorporado @code{Ellipsis}. Su valor de verdad es verdadero.

@node numbers Number,Secuencias,Elipsis,Jerarquía de tipos estándar
@anchor{reference/datamodel numbers-number}@anchor{1ee9}
@subsubsection @code{numbers.Number}


@geindex Objetos;numérico

Estos son creados por literales numéricos y retornados como resultados por operadores aritméticos y funciones aritméticas integradas. Los objetos numéricos son inmutables; una vez creado su valor nunca cambia. Los números de Python están, por supuesto, fuertemente relacionados con los números matemáticos, pero están sujetos a las limitaciones de la representación numérica en las computadoras.

Las representaciones de cadena de caracteres de las clases numéricas, calculadas por @ref{6bd,,__repr__()} y @ref{6be,,__str__()}, tienen las siguientes propiedades:


@itemize *

@item 
Son literales numéricos válidos que, cuando se pasan a su constructor de clase, producen un objeto que tiene el valor del numérico original.

@item 
La representación está en base 10, cuando sea posible.

@item 
Los ceros iniciales, posiblemente excepto un solo cero antes de un punto decimal, no se muestran.

@item 
Los ceros finales, posiblemente excepto un solo cero después de un punto decimal, no se muestran.

@item 
Solo se muestra un signo cuando el número es negativo.
@end itemize

Python distinguishes between integers, floating-point numbers, and complex
numbers:

@menu
* numbers.Integral: numbers Integral. 
* numbers.Real (float): numbers Real float. 
* numbers.Complex (complex): numbers Complex complex. 

@end menu

@node numbers Integral,numbers Real float,,numbers Number
@anchor{reference/datamodel numbers-integral}@anchor{1eea}
@subsubsection @code{numbers.Integral}


@geindex Objetos;entero

Estos representan elementos del conjunto matemático de números enteros (positivo y negativo).

@cartouche
@quotation Nota 
@geindex entero;representación

Las reglas para la representación de enteros están destinadas a dar la interpretación más significativa de las operaciones de cambio y máscara que involucran enteros negativos.
@end quotation
@end cartouche

Hay dos tipos de números enteros:


@table @asis

@item Enteros (@ref{1f0,,int})

Estos representan números en un rango ilimitado, sujetos solo a la memoria (virtual) disponible. Para las operaciones de desplazamiento y máscara, se asume una representación binaria, y los números negativos se representan en una variante del complemento de 2 que da la ilusión de una cadena de caracteres infinita de bits con signo que se extiende hacia la izquierda.

@item Booleanos (@ref{513,,bool})

@geindex Objetos;booleano
@geindex Falso
@geindex Verdad

Estos representan los valores de verdad Falso y Verdadero. Los dos objetos que representan los valores @code{False} y @code{True} son los únicos objetos booleanos. El tipo booleano es un subtipo del tipo entero y los valores booleanos se comportan como los valores 0 y 1 respectivamente, en casi todos los contextos, con la excepción de que cuando se convierten en una cadena de caracteres, las cadenas de caracteres @code{"False"} o @code{"True"} son retornadas respectivamente.
@end table

@node numbers Real float,numbers Complex complex,numbers Integral,numbers Number
@anchor{reference/datamodel numbers-real-float}@anchor{1eeb}
@subsubsection @code{numbers.Real} (@code{float})


@geindex Objetos;floating-point
@geindex floating-point;número
@geindex C;lenguaje
@geindex Java;lenguaje

These represent machine-level double precision floating-point numbers. You are
at the mercy of the underlying machine architecture (and C or Java
implementation) for the accepted range and handling of overflow. Python does not
support single-precision floating-point numbers; the savings in processor and
memory usage that are usually the reason for using these are dwarfed by the
overhead of using objects in Python, so there is no reason to complicate the
language with two kinds of floating-point numbers.

@node numbers Complex complex,,numbers Real float,numbers Number
@anchor{reference/datamodel numbers-complex-complex}@anchor{1eec}
@subsubsection @code{numbers.Complex} (@code{complex})


@geindex Objetos;complejo
@geindex complejo;número

These represent complex numbers as a pair of machine-level double precision
floating-point numbers.  The same caveats apply as for floating-point numbers.
The real and imaginary parts of a complex number @code{z} can be retrieved through
the read-only attributes @code{z.real} and @code{z.imag}.

@node Secuencias,Tipos de conjuntos,numbers Number,Jerarquía de tipos estándar
@anchor{reference/datamodel sequences}@anchor{1eed}
@subsubsection Secuencias


@geindex Funciones incorporadas;len
@geindex Objetos;Secuencias
@geindex operación de índice
@geindex selección de artículos
@geindex suscripción

These represent finite ordered sets indexed by non-negative numbers. The
built-in function @ref{6cf,,len()} returns the number of items of a sequence. When
the length of a sequence is `n', the index set contains the numbers 0, 1,
…, `n'-1.  Item `i' of sequence `a' is selected by @code{a[i]}. Some sequences,
including built-in sequences, interpret negative subscripts by adding the
sequence length. For example, @code{a[-2]} equals @code{a[n-2]}, the second to last
item of sequence a with length @code{n}.

@geindex rebanar

Sequences also support slicing: @code{a[i:j]} selects all items with index `k' such
that `i' @code{<=} `k' @code{<} `j'.  When used as an expression, a slice is a
sequence of the same type. The comment above about negative indexes also applies
to negative slice positions.

Algunas secuencias también admiten «segmentación extendida» con un tercer parámetro «paso» : @code{a[i:j:k]} selecciona todos los elementos de `a' con índice `x' donde @code{x = i + n*k}, `n' @code{>=} @code{0} y `i' @code{<=} `x' @code{<} `j'.

Las secuencias se distinguen según su mutabilidad:

@menu
* Secuencias inmutables:: 
* Secuencias mutables:: 

@end menu

@node Secuencias inmutables,Secuencias mutables,,Secuencias
@anchor{reference/datamodel immutable-sequences}@anchor{1eee}
@subsubsection Secuencias inmutables


@geindex Objetos;Secuencia inmutable
@geindex Objetos;inmutable

Un objeto de un tipo de secuencia inmutable no puede cambiar una vez que se crea. (Si el objeto contiene referencias a otros objetos, estos otros objetos pueden ser mutables y pueden cambiarse; sin embargo, la colección de objetos a los que hace referencia directamente un objeto inmutable no puede cambiar).

Los siguientes tipos son secuencias inmutables:

@geindex cadenas de caracteres;secuencias inmutables


@table @asis

@item Cadenas de caracteres

@geindex Funciones incorporadas;chr
@geindex Funciones incorporadas;ord
@geindex caracter
@geindex entero
@geindex Unicode

Una cadena es una secuencia de valores que representan puntos de código Unicode. Todos los puntos de código en el rango @code{U+0000 - U+10FFFF} se pueden representar en una cadena. Python no tiene un tipo char; en su lugar, cada punto de código de la cadena se representa como un objeto de cadena con una longitud @code{1}. La función integrada @ref{1eef,,ord()} convierte un punto de código de su forma de cadena a un entero en el rango @code{0 - 10FFFF}; @ref{167d,,chr()} convierte un entero en el rango @code{0 - 10FFFF} al objeto de cadena @code{1} de longitud correspondiente. @ref{96c,,str.encode()} se puede usar para convertir un @ref{237,,str} a @ref{325,,bytes} usando la codificación de texto dada, y @ref{96d,,bytes.decode()} se puede usar para lograr lo contrario.

@item Tuplas

@geindex Objetos;tupla
@geindex único;tupla
@geindex vacío;tupla

Los elementos de una tupla son objetos arbitrarios de Python. Las tuplas de dos o más elementos están formadas por listas de expresiones separadas por comas. Se puede formar una tupla de un elemento (un “singleton”) al colocar una coma en una expresión (una expresión en sí misma no crea una tupla, ya que los paréntesis deben ser utilizables para agrupar expresiones). Una tupla vacía puede estar formada por un par de paréntesis vacío.

@item Bytes

@geindex bytes
@geindex byte

A bytes object is an immutable array.  The items are 8-bit bytes,
represented by integers in the range 0 <= x < 256.  Bytes literals
(like @code{b'abc'}) and the built-in @ref{325,,bytes()} constructor
can be used to create bytes objects.  Also, bytes objects can be
decoded to strings via the @ref{96d,,decode()} method.
@end table

@node Secuencias mutables,,Secuencias inmutables,Secuencias
@anchor{reference/datamodel mutable-sequences}@anchor{1ef0}
@subsubsection Secuencias mutables


@geindex Objetos;secuencia mutable
@geindex Objetos;mutable
@geindex asignación;declaración
@geindex suscripción
@geindex rebanar

Las secuencias mutables se pueden cambiar después de su creación. Las anotaciones de suscripción y segmentación se pueden utilizar como el objetivo de asignaciones y declaraciones @ref{17ae,,del} (eliminar).

@cartouche
@quotation Nota 
@geindex Módulo;arreglo

@geindex Módulo;colecciones

Los módulos @ref{1e,,collections} y @ref{8,,array} proporcionan ejemplos adicionales de tipos de secuencias mutables.
@end quotation
@end cartouche

Actualmente hay dos tipos intrínsecos de secuencias mutable:


@table @asis

@item Listas

@geindex Objetos;lista

Los elementos de una lista son objetos de Python arbitrarios.  Las listas se forman colocando una lista de expresiones separadas por comas entre corchetes. (Tome en cuenta que no hay casos especiales necesarios para formar listas de longitud 0 o 1.)

@item Colecciones de bytes

@geindex arreglo de bytes

Un objeto bytearray es una colección mutable. Son creados por el constructor incorporado @ref{5e0,,bytearray()}.  Además de ser mutables (y, por lo tanto, inquebrantable), las colecciones de bytes proporcionan la misma interfaz y funcionalidad que los objetos inmutables @ref{325,,bytes}.
@end table

@node Tipos de conjuntos,Mapeos,Secuencias,Jerarquía de tipos estándar
@anchor{reference/datamodel set-types}@anchor{1ef1}
@subsubsection Tipos de conjuntos


@geindex Funciones incorporadas;len
@geindex Objetos;tipo conjunto

Estos representan conjuntos finitos no ordenados de objetos únicos e inmutables. Como tal, no pueden ser indexados por ningún `subscript'. Sin embargo, pueden repetirse y la función incorporada @ref{6cf,,len()} retorna el número de elementos en un conjunto. Los usos comunes de los conjuntos son pruebas rápidas de membresía, eliminación de duplicados de una secuencia y cálculo de operaciones matemáticas como intersección, unión, diferencia y diferencia simétrica.

Para elementos del conjunto, se aplican las mismas reglas de inmutabilidad que para las claves de diccionario. Tenga en cuenta que los tipos numéricos obedecen las reglas normales para la comparación numérica: si dos números se comparan igual (por ejemplo, @code{1} y @code{1.0}), solo uno de ellos puede estar contenido en un conjunto.

Actualmente hay dos tipos de conjuntos intrínsecos:


@table @asis

@item Conjuntos

@geindex Objetos;conjunto

Estos representan un conjunto mutable. Son creados por el constructor incorporado @ref{67a,,set()} y puede ser modificado posteriormente por varios métodos, como @code{add()}.

@item Conjuntos congelados

@geindex Objetos;conjunto congelado

Estos representan un conjunto inmutable. Son creados por el  constructor incorporado @ref{67b,,frozenset()}. Como un conjunto congelado es inmutable y @ref{6b1,,hashable}, se puede usar nuevamente como un elemento de otro conjunto o como una clave de un diccionario.
@end table

@node Mapeos,Tipos invocables,Tipos de conjuntos,Jerarquía de tipos estándar
@anchor{reference/datamodel mappings}@anchor{1ef2}
@subsubsection Mapeos


@geindex Funciones incorporadas;len
@geindex suscripción
@geindex Objetos;mapeos

Estos representan conjuntos finitos de objetos indexados por conjuntos de índices arbitrarios. La notación de subíndice @code{a[k]} selecciona el elemento indexado por @code{k} del mapeo @code{a}; esto se puede usar en expresiones y como el objetivo de asignaciones o declaraciones @ref{17ae,,del}. La función incorporada @ref{6cf,,len()} retorna el número de elementos en un mapeo.

Actualmente hay un único tipo de mapeo intrínseco:

@menu
* Diccionarios: Diccionarios<2>. 

@end menu

@node Diccionarios<2>,,,Mapeos
@anchor{reference/datamodel dictionaries}@anchor{1ef3}
@subsubsection Diccionarios


@geindex Objetos;diccionario

Estos representan conjuntos finitos de objetos indexados por valores casi arbitrarios. Los únicos tipos de valores no aceptables como claves son valores que contienen listas o diccionarios u otros tipos mutables que se comparan por valor en lugar de por identidad de objeto, la razón es que la implementación eficiente de los diccionarios requiere que el valor `hash' de una clave permanezca constante. Los tipos numéricos utilizados para las claves obedecen las reglas normales para la comparación numérica: si dos números se comparan igual (por ejemplo, @code{1} y @code{1.0}) entonces se pueden usar indistintamente para indexar la misma entrada del diccionario.

Los diccionarios conservan el orden de inserción, lo que significa que las claves se mantendrán en el mismo orden en que se agregaron secuencialmente sobre el diccionario. Reemplazar una clave existente no cambia el orden, sin embargo, eliminar una clave y volver a insertarla la agregará al final en lugar de mantener su lugar anterior.

Dictionaries are mutable; they can be created by the @code{@{@}} notation (see
section @ref{e04,,Despliegues de diccionario}).

@geindex Módulo;dbm.ndbm
@geindex Módulo;dbm.gnu

Los módulos de extensión @ref{35,,dbm.ndbm} y @ref{34,,dbm.gnu} proporcionan ejemplos adicionales de tipos de mapeo, al igual que el módulo @ref{1e,,collections}.


Distinto en la versión 3.7: Los diccionarios no conservaban el orden de inserción en las versiones de Python anteriores a 3.6. En CPython 3.6, el orden de inserción se conserva, pero se consideró un detalle de implementación en ese momento en lugar de una garantía de idioma.


@node Tipos invocables,Módulos<3>,Mapeos,Jerarquía de tipos estándar
@anchor{reference/datamodel callable-types}@anchor{1ef4}
@subsubsection Tipos invocables


@geindex Objetos;invocable
@geindex función;llamada
@geindex invocación
@geindex función;argumento

Estos son los tipos a los que la operación de llamada de función (vea la sección @ref{e02,,Invocaciones}) puede ser aplicado:

@menu
* Funciones definidas por el usuario:: 
* Métodos de instancia:: 
* Funciones generadoras:: 
* Funciones de corrutina:: 
* Funciones generadoras asincrónicas:: 
* Funciones incorporadas:: 
* Métodos incorporados:: 
* Clases: Clases<2>. 
* Instancias de clases:: 

@end menu

@node Funciones definidas por el usuario,Métodos de instancia,,Tipos invocables
@anchor{reference/datamodel user-defined-funcs}@anchor{3eb}@anchor{reference/datamodel user-defined-functions}@anchor{1ef5}
@subsubsection Funciones definidas por el usuario


@geindex definida por el usuario;función
@geindex Objetos;función
@geindex Objetos;función definida por el usuario

Un objeto función definido por el usuario, es creado por un definición de función (vea la sección @ref{1c3d,,Definiciones de funciones}). Debe llamarse con una lista de argumentos que contenga el mismo número de elementos que la lista de parámetros formales de la función.

@menu
* Special read-only attributes:: 
* Special writable attributes:: 

@end menu

@node Special read-only attributes,Special writable attributes,,Funciones definidas por el usuario
@anchor{reference/datamodel special-read-only-attributes}@anchor{1ef6}
@subsubsection Special read-only attributes


@geindex __closure__ (atributo función)
@geindex __globals__ (atributo función)
@geindex global;espacio de nombre


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __globals__ (atributo de function)
@anchor{reference/datamodel function __globals__}@anchor{133b}
@deffn {Atributo} function.__globals__
@end deffn

@tab

A reference to the @ref{190,,dictionary} that holds the function’s
@ref{1ef7,,global variables} – the global namespace of the module
in which the function was defined.

@item

@geindex __closure__ (atributo de function)
@anchor{reference/datamodel function __closure__}@anchor{1338}
@deffn {Atributo} function.__closure__
@end deffn

@tab

@code{None} or a @ref{464,,tuple} of cells that contain bindings for the names specified
in the @ref{1ef8,,co_freevars} attribute of the function’s
@ref{3ec,,code object}.

Un objeto de celda tiene el atributo @code{cell_contents}. Esto se puede usar para obtener el valor de la celda, así como para establecer el valor.

@end multitable


@node Special writable attributes,,Special read-only attributes,Funciones definidas por el usuario
@anchor{reference/datamodel special-writable-attributes}@anchor{1ef9}
@subsubsection Special writable attributes


@geindex __doc__ (atributo función)
@geindex __name__ (atributo función)
@geindex __module__ (atributo función)
@geindex __dict__ (atributo función)
@geindex __defaults__ (atributo función)
@geindex __code__ (atributo función)
@geindex __annotations__ (atributo función)
@geindex __annotate__ (function attribute)
@geindex __kwdefaults__ (atributo función)
@geindex __type_params__ (atributo función)

Most of these attributes check the type of the assigned value:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __doc__ (atributo de function)
@anchor{reference/datamodel function __doc__}@anchor{1246}
@deffn {Atributo} function.__doc__
@end deffn

@tab

The function’s documentation string, or @code{None} if unavailable.

@item

@geindex __name__ (atributo de function)
@anchor{reference/datamodel function __name__}@anchor{133c}
@deffn {Atributo} function.__name__
@end deffn

@tab

The function’s name.
See also: @ref{10e2,,__name__ attributes}.

@item

@geindex __qualname__ (atributo de function)
@anchor{reference/datamodel function __qualname__}@anchor{1efa}
@deffn {Atributo} function.__qualname__
@end deffn

@tab

The function’s @ref{194a,,qualified name}.
See also: @ref{10e1,,__qualname__ attributes}.


Added in version 3.3.


@item

@geindex __module__ (atributo de function)
@anchor{reference/datamodel function __module__}@anchor{1efb}
@deffn {Atributo} function.__module__
@end deffn

@tab

El nombre del módulo en el que se definió la función, o @code{None} si no está disponible.

@item

@geindex __defaults__ (atributo de function)
@anchor{reference/datamodel function __defaults__}@anchor{1339}
@deffn {Atributo} function.__defaults__
@end deffn

@tab

A @ref{464,,tuple} containing default @ref{1efc,,parameter} values
for those parameters that have defaults,
or @code{None} if no parameters have a default value.

@item

@geindex __code__ (atributo de function)
@anchor{reference/datamodel function __code__}@anchor{3ec}
@deffn {Atributo} function.__code__
@end deffn

@tab

The @ref{335,,code object} representing
the compiled function body.

@item

@geindex __dict__ (atributo de function)
@anchor{reference/datamodel function __dict__}@anchor{133a}
@deffn {Atributo} function.__dict__
@end deffn

@tab

The namespace supporting arbitrary function attributes.
See also: @ref{5fe,,__dict__ attributes}.

@item

@geindex __annotations__ (atributo de function)
@anchor{reference/datamodel function __annotations__}@anchor{1245}
@deffn {Atributo} function.__annotations__
@end deffn

@tab

A @ref{190,,dictionary} containing annotations of
@ref{1efc,,parameters}.
The keys of the dictionary are the parameter names,
and @code{'return'} for the return annotation, if provided.
See also: @ref{e08,,object.__annotations__}.


Distinto en la versión 3.14: Annotations are now @ref{503,,lazily evaluated}.
See 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}.


@item

@geindex __annotate__ (atributo de function)
@anchor{reference/datamodel function __annotate__}@anchor{1efd}
@deffn {Atributo} function.__annotate__
@end deffn

@tab

The @ref{141,,annotate function} for this function, or @code{None}
if the function has no annotations. See @ref{161a,,object.__annotate__}.


Added in version 3.14.


@item

@geindex __kwdefaults__ (atributo de function)
@anchor{reference/datamodel function __kwdefaults__}@anchor{10a4}
@deffn {Atributo} function.__kwdefaults__
@end deffn

@tab

A @ref{190,,dictionary} containing defaults for keyword-only
@ref{1efc,,parameters}.

@item

@geindex __type_params__ (atributo de function)
@anchor{reference/datamodel function __type_params__}@anchor{1efe}
@deffn {Atributo} function.__type_params__
@end deffn

@tab

A @ref{464,,tuple} containing the @ref{3fc,,type parameters} of
a @ref{4ff,,generic function}.


Added in version 3.12.


@end multitable


Function objects also support getting and setting arbitrary attributes, which
can be used, for example, to attach metadata to functions.  Regular attribute
dot-notation is used to get and set such attributes.

`Detalles de implementación de CPython:' CPython’s current implementation only supports function attributes
on user-defined functions. Function attributes on
@ref{1eff,,built-in functions} may be supported in the
future.

Additional information about a function’s definition can be retrieved from its
@ref{335,,code object}
(accessible via the @ref{3ec,,__code__} attribute).

@node Métodos de instancia,Funciones generadoras,Funciones definidas por el usuario,Tipos invocables
@anchor{reference/datamodel id2}@anchor{1f00}@anchor{reference/datamodel instance-methods}@anchor{1cc5}
@subsubsection Métodos de instancia


@geindex Objetos;método
@geindex Objetos;método definido por el usuario
@geindex definida por el usuario;método

Un objeto de método de instancia combina una clase, una instancia de clase y cualquier objeto invocable (normalmente una función definida por el usuario).

@geindex __func__ (atributo método)
@geindex __self__ (atributo método)
@geindex __doc__ (atributo método)
@geindex __name__ (atributo método)
@geindex __module__ (atributo método)

Special read-only attributes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex __self__ (atributo de method)
@anchor{reference/datamodel method __self__}@anchor{1408}
@deffn {Atributo} method.__self__
@end deffn

@tab

Refers to the class instance object to which the method is
@ref{1f01,,bound}

@item

@geindex __func__ (atributo de method)
@anchor{reference/datamodel method __func__}@anchor{1363}
@deffn {Atributo} method.__func__
@end deffn

@tab

Refers to the original @ref{3eb,,function object}

@item

@geindex __doc__ (atributo de method)
@anchor{reference/datamodel method __doc__}@anchor{1f02}
@deffn {Atributo} method.__doc__
@end deffn

@tab

The method’s documentation
(same as @ref{1246,,method.__func__.__doc__}).
A @ref{237,,string} if the original function had a docstring, else
@code{None}.

@item

@geindex __name__ (atributo de method)
@anchor{reference/datamodel method __name__}@anchor{1f03}
@deffn {Atributo} method.__name__
@end deffn

@tab

The name of the method
(same as @ref{133c,,method.__func__.__name__})

@item

@geindex __module__ (atributo de method)
@anchor{reference/datamodel method __module__}@anchor{1f04}
@deffn {Atributo} method.__module__
@end deffn

@tab

The name of the module the method was defined in, or @code{None} if
unavailable.

@end multitable


Methods also support accessing (but not setting) the arbitrary function
attributes on the underlying @ref{3eb,,function object}.

User-defined method objects may be created when getting an attribute of a
class (perhaps via an instance of that class), if that attribute is a
user-defined @ref{3eb,,function object} or a
@ref{2d2,,classmethod} object.
@anchor{reference/datamodel method-binding}@anchor{1f01}
When an instance method object is created by retrieving a user-defined
@ref{3eb,,function object} from a class via one of its
instances, its @ref{1408,,__self__} attribute is the instance, and the
method object is said to be `bound'.  The new method’s @ref{1363,,__func__}
attribute is the original function object.

When an instance method object is created by retrieving a @ref{2d2,,classmethod}
object from a class or instance, its @ref{1408,,__self__} attribute is the
class itself, and its @ref{1363,,__func__} attribute is the function object
underlying the class method.

When an instance method object is called, the underlying function
(@ref{1363,,__func__}) is called, inserting the class instance
(@ref{1408,,__self__}) in front of the argument list.  For instance, when
@code{C} is a class which contains a definition for a function
@code{f()}, and @code{x} is an instance of @code{C}, calling @code{x.f(1)} is
equivalent to calling @code{C.f(x, 1)}.

When an instance method object is derived from a @ref{2d2,,classmethod} object, the
«class instance» stored in @ref{1408,,__self__} will actually be the class
itself, so that calling either @code{x.f(1)} or @code{C.f(1)} is equivalent to
calling @code{f(C,1)} where @code{f} is the underlying function.

It is important to note that user-defined functions
which are attributes of a class instance are not converted to bound
methods; this `only' happens when the function is an attribute of the
class.

@node Funciones generadoras,Funciones de corrutina,Métodos de instancia,Tipos invocables
@anchor{reference/datamodel generator-functions}@anchor{1f05}
@subsubsection Funciones generadoras


@geindex generador;función
@geindex generador;iterador

Una función o método que utiliza la instrucción @ref{a5f,,yield} (consulte la sección @ref{a5f,,La declaración yield}) se denomina `función generadora'. Una función de este tipo, cuando se llama, siempre retorna un objeto @ref{313,,iterator} que se puede usar para ejecutar el cuerpo de la función: llamar al método @ref{1335,,iterator.__next__()} del iterador hará que la función se ejecute hasta que proporcione un valor usando la instrucción @code{yield}. Cuando la función ejecuta una instrucción @ref{a60,,return} o se sale del final, se genera una excepción @ref{c82,,StopIteration} y el iterador habrá llegado al final del conjunto de valores que se retornarán.

@node Funciones de corrutina,Funciones generadoras asincrónicas,Funciones generadoras,Tipos invocables
@anchor{reference/datamodel coroutine-functions}@anchor{1f06}
@subsubsection Funciones de corrutina


@geindex corrutina;función

Una función o método que es definido utilizando @ref{672,,async def} se llama `coroutine function'.  Dicha función, cuando es invocada, retorna un objeto @ref{53a,,coroutine}.  Éste puede contener expresiones @ref{14e,,await}, así como declaraciones @ref{676,,async with} y @ref{b36,,async for}. Ver también la sección @ref{1f07,,Objetos de corrutina}.

@node Funciones generadoras asincrónicas,Funciones incorporadas,Funciones de corrutina,Tipos invocables
@anchor{reference/datamodel asynchronous-generator-functions}@anchor{1f08}
@subsubsection Funciones generadoras asincrónicas


@geindex generador asíncrono;función
@geindex generador asíncrono;iterador asíncrono

Una función o método que se define usando @ref{672,,async def} y que usa la declaración @ref{a5f,,yield} se llama `función generadora asíncrona'. Una función de este tipo, cuando se llama, retorna un objeto @ref{312,,asynchronous iterator} que se puede utilizar en una instrucción @ref{b36,,async for} para ejecutar el cuerpo de la función.

Llamar al método @ref{1f09,,aiterator.__anext__} del iterador asíncrono retornará un @ref{314,,awaitable} que, cuando se espere, se ejecutará hasta que proporcione un valor utilizando la expresión @ref{a5f,,yield}. Cuando la función ejecuta una instrucción @ref{a60,,return} vacía o se sale del final, se genera una excepción @ref{1a34,,StopAsyncIteration} y el iterador asincrónico habrá llegado al final del conjunto de valores que se generarán.

@node Funciones incorporadas,Métodos incorporados,Funciones generadoras asincrónicas,Tipos invocables
@anchor{reference/datamodel built-in-functions}@anchor{1f0a}@anchor{reference/datamodel builtin-functions}@anchor{1eff}
@subsubsection Funciones incorporadas


@geindex Objetos;Funciones incorporadas
@geindex Objetos;función
@geindex C;lenguaje

A built-in function object is a wrapper around a C function.  Examples of
built-in functions are @ref{6cf,,len()} and @ref{14fa,,math.sin()} (@ref{8e,,math} is a
standard built-in module). The number and type of the arguments are
determined by the C function. Special read-only attributes:


@itemize *

@item 
@code{__doc__} is the function’s documentation string, or @code{None} if
unavailable. See @ref{1246,,function.__doc__}.

@item 
@code{__name__} is the function’s name. See @ref{133c,,function.__name__}.

@item 
@code{__self__} is set to @code{None} (but see the next item).

@item 
@code{__module__} is the name of
the module the function was defined in or @code{None} if unavailable.
See @ref{1efb,,function.__module__}.
@end itemize

@node Métodos incorporados,Clases<2>,Funciones incorporadas,Tipos invocables
@anchor{reference/datamodel built-in-methods}@anchor{1f0b}@anchor{reference/datamodel builtin-methods}@anchor{1f0c}
@subsubsection Métodos incorporados


@geindex Objetos;método incorporado
@geindex Objetos;método
@geindex incorporado;método

This is really a different disguise of a built-in function, this time containing
an object passed to the C function as an implicit extra argument.  An example of
a built-in method is @code{alist.append()}, assuming `alist' is a list object. In
this case, the special read-only attribute @code{__self__} is set to the object
denoted by `alist'. (The attribute has the same semantics as it does with
@ref{1408,,other instance methods}.)

@node Clases<2>,Instancias de clases,Métodos incorporados,Tipos invocables
@anchor{reference/datamodel classes}@anchor{1f0d}@anchor{reference/datamodel id3}@anchor{1f0e}
@subsubsection Clases


Classes are callable.  These objects normally act as factories for new
instances of themselves, but variations are possible for class types that
override @ref{624,,__new__()}.  The arguments of the call are passed to
@code{__new__()} and, in the typical case, to @ref{751,,__init__()} to
initialize the new instance.

@node Instancias de clases,,Clases<2>,Tipos invocables
@anchor{reference/datamodel class-instances}@anchor{1f0f}
@subsubsection Instancias de clases


Las instancias de clases arbitrarias se pueden hacer invocables definiendo un método @ref{5fb,,__call__()} en su clase.

@node Módulos<3>,Clases personalizadas,Tipos invocables,Jerarquía de tipos estándar
@anchor{reference/datamodel module-objects}@anchor{1f10}@anchor{reference/datamodel modules}@anchor{1f11}
@subsubsection Módulos


@geindex declaración;importar
@geindex Objetos;Módulo

Modules are a basic organizational unit of Python code, and are created by
the @ref{1f12,,import system} as invoked either by the
@ref{682,,import} statement, or by calling
functions such as @ref{5bc,,importlib.import_module()} and built-in
@ref{96b,,__import__()}.  A module object has a namespace implemented by a
@ref{190,,dictionary} object (this is the dictionary referenced by the
@ref{133b,,__globals__}
attribute of functions defined in the module).  Attribute references are
translated to lookups in this dictionary, e.g., @code{m.x} is equivalent to
@code{m.__dict__["x"]}. A module object does not contain the code object used
to initialize the module (since it isn’t needed once the initialization is
done).

La asignación de atributos actualiza el diccionario de espacio de nombres del módulo, p. ej., @code{m.x = 1} es equivalente a @code{m.__dict__[“x”] = 1}.

@geindex __name__ (atributo módulo)
@geindex __spec__ (module attribute)
@geindex __package__ (module attribute)
@geindex __loader__ (module attribute)
@geindex __path__ (module attribute)
@geindex __file__ (atributo módulo)
@geindex __cached__ (module attribute)
@geindex __doc__ (atributo módulo)
@geindex __annotations__ (atributo módulo)
@geindex __annotate__ (module attribute)
@geindex Módulo;espacio de nombre

@menu
* Import-related attributes on module objects:: 
* Other writable attributes on module objects:: 
* Module dictionaries:: 

@end menu

@node Import-related attributes on module objects,Other writable attributes on module objects,,Módulos<3>
@anchor{reference/datamodel import-mod-attrs}@anchor{1f13}@anchor{reference/datamodel import-related-attributes-on-module-objects}@anchor{1f14}
@subsubsection Import-related attributes on module objects


Module objects have the following attributes that relate to the
@ref{1f12,,import system}. When a module is created using the machinery associated
with the import system, these attributes are filled in based on the module’s
@ref{1f15,,spec}, before the @ref{16b8,,loader} executes and loads the
module.

To create a module dynamically rather than using the import system,
it’s recommended to use @ref{e97,,importlib.util.module_from_spec()},
which will set the various import-controlled attributes to appropriate values.
It’s also possible to use the @ref{e98,,types.ModuleType} constructor to create
modules directly, but this technique is more error-prone, as most attributes
must be manually set on the module object after it has been created when using
this approach.

@cartouche
@quotation Prudencia 
With the exception of @ref{13e8,,__name__}, it is `strongly'
recommended that you rely on @ref{1f16,,__spec__} and its attributes
instead of any of the other individual attributes listed in this subsection.
Note that updating an attribute on @code{__spec__} will not update the
corresponding attribute on the module itself:

@example
>>> import typing
>>> typing.__name__, typing.__spec__.name
('typing', 'typing')
>>> typing.__spec__.name = 'spelling'
>>> typing.__name__, typing.__spec__.name
('typing', 'spelling')
>>> typing.__name__ = 'keyboard_smashing'
>>> typing.__name__, typing.__spec__.name
('keyboard_smashing', 'spelling')
@end example
@end quotation
@end cartouche

@geindex __name__ (atributo de module)
@anchor{reference/datamodel module __name__}@anchor{13e8}
@deffn {Atributo} module.__name__

The name used to uniquely identify the module in the import system.
For a directly executed module, this will be set to @code{"__main__"}.

This attribute must be set to the fully qualified name of the module.
It is expected to match the value of
@ref{1f17,,module.__spec__.name}.
@end deffn

@geindex __spec__ (atributo de module)
@anchor{reference/datamodel module __spec__}@anchor{1f16}
@deffn {Atributo} module.__spec__

A record of the module’s import-system-related state.

Set to the @ref{1e69,,module spec} that was
used when importing the module. See @ref{1f18,,Module specs} for more details.


Added in version 3.4.

@end deffn

@geindex __package__ (atributo de module)
@anchor{reference/datamodel module __package__}@anchor{1cd}
@deffn {Atributo} module.__package__

The @ref{185,,package} a module belongs to.

If the module is top-level (that is, not a part of any specific package)
then the attribute should be set to @code{'@w{'}} (the empty string). Otherwise,
it should be set to the name of the module’s package (which can be equal to
@ref{13e8,,module.__name__} if the module itself is a package). See 
@geindex Python Enhancement Proposals; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/}
for further details.

This attribute is used instead of @ref{13e8,,__name__} to calculate
explicit relative imports for main modules. It defaults to @code{None} for
modules created dynamically using the @ref{e98,,types.ModuleType} constructor;
use @ref{e97,,importlib.util.module_from_spec()} instead to ensure the attribute
is set to a @ref{237,,str}.

It is `strongly' recommended that you use
@ref{1ce,,module.__spec__.parent}
instead of @code{module.__package__}. @ref{1cd,,__package__} is now only used
as a fallback if @code{__spec__.parent} is not set, and this fallback
path is deprecated.


Distinto en la versión 3.4: This attribute now defaults to @code{None} for modules created dynamically
using the @ref{e98,,types.ModuleType} constructor.
Previously the attribute was optional.



Distinto en la versión 3.6: The value of @code{__package__} is expected to be the same as
@ref{1ce,,__spec__.parent}.
@ref{1cd,,__package__} is now only used as a fallback during import
resolution if @code{__spec__.parent} is not defined.



Distinto en la versión 3.10: @ref{59f,,ImportWarning} is raised if an import resolution falls back to
@code{__package__} instead of
@ref{1ce,,__spec__.parent}.



Distinto en la versión 3.12: Raise @ref{1da,,DeprecationWarning} instead of @ref{59f,,ImportWarning} when
falling back to @code{__package__} during import resolution.



Deprecated since version 3.13, will be removed in version 3.15: @code{__package__} will cease to be set or taken into consideration
by the import system or standard library.

@end deffn

@geindex __loader__ (atributo de module)
@anchor{reference/datamodel module __loader__}@anchor{1e2}
@deffn {Atributo} module.__loader__

The @ref{16b8,,loader} object that the import machinery used to load the module.

This attribute is mostly useful for introspection, but can be used for
additional loader-specific functionality, for example getting data
associated with a loader.

@code{__loader__} defaults to @code{None} for modules created dynamically
using the @ref{e98,,types.ModuleType} constructor;
use @ref{e97,,importlib.util.module_from_spec()} instead to ensure the attribute
is set to a @ref{16b8,,loader} object.

It is `strongly' recommended that you use
@ref{1e3,,module.__spec__.loader}
instead of @code{module.__loader__}.


Distinto en la versión 3.4: This attribute now defaults to @code{None} for modules created dynamically
using the @ref{e98,,types.ModuleType} constructor.
Previously the attribute was optional.



Deprecated since version 3.12, will be removed in version 3.16: Setting @code{__loader__} on a module while failing to set
@code{__spec__.loader} is deprecated. In Python 3.16,
@code{__loader__} will cease to be set or taken into consideration by
the import system or the standard library.

@end deffn

@geindex __path__ (atributo de module)
@anchor{reference/datamodel module __path__}@anchor{1c74}
@deffn {Atributo} module.__path__

A (possibly empty) @ref{597,,sequence} of strings enumerating the locations
where the package’s submodules will be found. Non-package modules should
not have a @code{__path__} attribute. See @ref{1f19,,__path__ attributes on modules} for
more details.

It is `strongly' recommended that you use
@ref{1f1a,,module.__spec__.submodule_search_locations}
instead of @code{module.__path__}.
@end deffn

@geindex __file__ (atributo de module)
@anchor{reference/datamodel module __file__}@anchor{1f1b}
@deffn {Atributo} module.__file__
@end deffn

@geindex __cached__ (atributo de module)
@anchor{reference/datamodel module __cached__}@anchor{1cb}
@deffn {Atributo} module.__cached__

@code{__file__} and @code{__cached__} are both optional attributes that
may or may not be set. Both attributes should be a @ref{237,,str} when they
are available.

@code{__file__} indicates the pathname of the file from which the module
was loaded (if loaded from a file), or the pathname of the shared library
file for extension modules loaded dynamically from a shared library.
It might be missing for certain types of modules, such as C modules that are
statically linked into the interpreter, and the
@ref{1f12,,import system} may opt to leave it unset if it
has no semantic meaning (for example, a module loaded from a database).

If @code{__file__} is set then the @code{__cached__} attribute might
also be set,  which is the path to any compiled version of
the code (for example, a byte-compiled file). The file does not need to exist
to set this attribute; the path can simply point to where the
compiled file `would' exist (see 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}).

Note that @code{__cached__} may be set even if @code{__file__} is not
set.  However, that scenario is quite atypical.  Ultimately, the
@ref{16b8,,loader} is what makes use of the module spec provided by the
@ref{1f1c,,finder} (from which @code{__file__} and @code{__cached__} are
derived).  So if a loader can load from a cached module but otherwise does
not load from a file, that atypical scenario may be appropriate.

It is `strongly' recommended that you use
@ref{1cc,,module.__spec__.cached}
instead of @code{module.__cached__}.


Deprecated since version 3.13, will be removed in version 3.15: Setting @code{__cached__} on a module while failing to set
@code{__spec__.cached} is deprecated. In Python 3.15,
@code{__cached__} will cease to be set or taken into consideration by
the import system or standard library.

@end deffn

@node Other writable attributes on module objects,Module dictionaries,Import-related attributes on module objects,Módulos<3>
@anchor{reference/datamodel other-writable-attributes-on-module-objects}@anchor{1f1d}
@subsubsection Other writable attributes on module objects


As well as the import-related attributes listed above, module objects also have
the following writable attributes:

@geindex __doc__ (atributo de module)
@anchor{reference/datamodel module __doc__}@anchor{185a}
@deffn {Atributo} module.__doc__

The module’s documentation string, or @code{None} if unavailable.
See also: @ref{9bb,,__doc__ attributes}.
@end deffn

@geindex __annotations__ (atributo de module)
@anchor{reference/datamodel module __annotations__}@anchor{1f1e}
@deffn {Atributo} module.__annotations__

A dictionary containing @ref{ddb,,variable annotations}
collected during module body execution.  For best practices on working with
@code{__annotations__}, see @ref{6,,annotationlib}.


Distinto en la versión 3.14: Annotations are now @ref{503,,lazily evaluated}.
See 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}.

@end deffn

@geindex __annotate__ (atributo de module)
@anchor{reference/datamodel module __annotate__}@anchor{1f1f}
@deffn {Atributo} module.__annotate__

The @ref{141,,annotate function} for this module, or @code{None} if the module has
no annotations. See also: @ref{161a,,__annotate__} attributes.


Added in version 3.14.

@end deffn

@node Module dictionaries,,Other writable attributes on module objects,Módulos<3>
@anchor{reference/datamodel module-dictionaries}@anchor{1f20}
@subsubsection Module dictionaries


Module objects also have the following special read-only attribute:

@geindex __dict__ (atributo módulo)

@geindex __dict__ (atributo de module)
@anchor{reference/datamodel module __dict__}@anchor{1f21}
@deffn {Atributo} module.__dict__

The module’s namespace as a dictionary object. Uniquely among the attributes
listed here, @code{__dict__} cannot be accessed as a global variable from
within a module; it can only be accessed as an attribute on module objects.

`Detalles de implementación de CPython:' Debido a la manera en la que CPython limpia los diccionarios de módulo, el diccionario de módulo será limpiado cuando el módulo se encuentra fuera de alcance, incluso si el diccionario aún tiene referencias existentes.  Para evitar esto, copie el diccionario o mantenga el módulo cerca mientras usa el diccionario directamente.
@end deffn

@node Clases personalizadas,Instancias de clase,Módulos<3>,Jerarquía de tipos estándar
@anchor{reference/datamodel class-attrs-and-methods}@anchor{1f22}@anchor{reference/datamodel custom-classes}@anchor{1f23}
@subsubsection Clases personalizadas


Custom class types are typically created by class definitions (see section
@ref{133f,,Definiciones de clase}).  A class has a namespace implemented by a dictionary object.
Class attribute references are translated to lookups in this dictionary, e.g.,
@code{C.x} is translated to @code{C.__dict__["x"]} (although there are a number of
hooks which allow for other means of locating attributes). When the attribute
name is not found there, the attribute search continues in the base classes.
This search of the base classes uses the C3 method resolution order which
behaves correctly even in the presence of “diamond” inheritance structures
where there are multiple inheritance paths leading back to a common ancestor.
Additional details on the C3 MRO used by Python can be found at
@ref{14e6,,The Python 2.3 Method Resolution Order}.

@geindex Objetos;clase
@geindex Objetos;instancia de clase
@geindex Objetos;instancia
@geindex objeto de clase;llamada
@geindex contenedores
@geindex Objetos;diccionario
@geindex clase;atributo

When a class attribute reference (for class @code{C}, say) would yield a
class method object, it is transformed into an instance method object whose
@ref{1408,,__self__} attribute is @code{C}.
When it would yield a @ref{22e,,staticmethod} object,
it is transformed into the object wrapped by the static method
object. See section @ref{cd7,,Implementando descriptores} for another way in which attributes
retrieved from a class may differ from those actually contained in its
@ref{5fe,,__dict__}.

@geindex clase;atributo;asignación

Las asignaciones de atributos de clase actualizan el diccionario de la clase, nunca el diccionario de la clase base.

@geindex objeto de clase;llamada

Un objeto de clase puede ser invocado (ver arriba) para producir una instancia de clase (ver a continuación).

@menu
* Special attributes:: 
* Special methods:: 

@end menu

@node Special attributes,Special methods,,Clases personalizadas
@anchor{reference/datamodel special-attributes}@anchor{1f24}
@subsubsection Special attributes


@geindex __name__ (atributo de clase)
@geindex __module__ (atributo de clase)
@geindex __dict__ (atributo de clase)
@geindex __bases__ (atributo de clase)
@geindex __doc__ (atributo de clase)
@geindex __annotations__ (atributo de clase)
@geindex __annotate__ (class attribute)
@geindex __type_params__ (atributo de clase)
@geindex __static_attributes__ (class attribute)
@geindex __firstlineno__ (class attribute)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __name__ (atributo de type)
@anchor{reference/datamodel type __name__}@anchor{14e7}
@deffn {Atributo} type.__name__
@end deffn

@tab

The class’s name.
See also: @ref{10e2,,__name__ attributes}.

@item

@geindex __qualname__ (atributo de type)
@anchor{reference/datamodel type __qualname__}@anchor{1f25}
@deffn {Atributo} type.__qualname__
@end deffn

@tab

The class’s @ref{194a,,qualified name}.
See also: @ref{10e1,,__qualname__ attributes}.

@item

@geindex __module__ (atributo de type)
@anchor{reference/datamodel type __module__}@anchor{468}
@deffn {Atributo} type.__module__
@end deffn

@tab

El nombre del módulo en el que se definió la clase.

@item

@geindex __dict__ (atributo de type)
@anchor{reference/datamodel type __dict__}@anchor{ce5}
@deffn {Atributo} type.__dict__
@end deffn

@tab

A @ref{518,,mapping proxy}
providing a read-only view of the class’s namespace.
See also: @ref{5fe,,__dict__ attributes}.

@item

@geindex __bases__ (atributo de type)
@anchor{reference/datamodel type __bases__}@anchor{14e8}
@deffn {Atributo} type.__bases__
@end deffn

@tab

A @ref{464,,tuple} containing the class’s bases.
In most cases, for a class defined as @code{class X(A, B, C)},
@code{X.__bases__} will be exactly equal to @code{(A, B, C)}.

@item

@geindex __doc__ (atributo de type)
@anchor{reference/datamodel type __doc__}@anchor{1cb3}
@deffn {Atributo} type.__doc__
@end deffn

@tab

The class’s documentation string, or @code{None} if undefined.
Not inherited by subclasses.

@item

@geindex __annotations__ (atributo de type)
@anchor{reference/datamodel type __annotations__}@anchor{1f26}
@deffn {Atributo} type.__annotations__
@end deffn

@tab

A dictionary containing
@ref{ddb,,variable annotations}
collected during class body execution. See also:
@ref{e08,,__annotations__ attributes}.

For best practices on working with @ref{e08,,__annotations__},
please see @ref{6,,annotationlib}.

@cartouche
@quotation Prudencia 
Accessing the @code{__annotations__} attribute of a class
object directly may yield incorrect results in the presence of
metaclasses. In addition, the attribute may not exist for
some classes. Use @ref{147,,annotationlib.get_annotations()} to
retrieve class annotations safely.
@end quotation
@end cartouche


Distinto en la versión 3.14: Annotations are now @ref{503,,lazily evaluated}.
See 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}.


@item

@geindex __annotate__() (método de type)
@anchor{reference/datamodel type __annotate__}@anchor{1f27}
@deffn {Método} type.__annotate__ ()
@end deffn

@tab

The @ref{141,,annotate function} for this class, or @code{None}
if the class has no annotations.
See also: @ref{161a,,__annotate__ attributes}.

@cartouche
@quotation Prudencia 
Accessing the @code{__annotate__} attribute of a class
object directly may yield incorrect results in the presence of
metaclasses. Use @ref{1f28,,annotationlib.get_annotate_function()} to
retrieve the annotate function safely.
@end quotation
@end cartouche


Added in version 3.14.


@item

@geindex __type_params__ (atributo de type)
@anchor{reference/datamodel type __type_params__}@anchor{1f29}
@deffn {Atributo} type.__type_params__
@end deffn

@tab

A @ref{464,,tuple} containing the @ref{3fc,,type parameters} of
a @ref{4fe,,generic class}.


Added in version 3.12.


@item

@geindex __static_attributes__ (atributo de type)
@anchor{reference/datamodel type __static_attributes__}@anchor{2b8}
@deffn {Atributo} type.__static_attributes__
@end deffn

@tab

A @ref{464,,tuple} containing names of attributes of this class which are
assigned through @code{self.X} from any function in its body.


Added in version 3.13.


@item

@geindex __firstlineno__ (atributo de type)
@anchor{reference/datamodel type __firstlineno__}@anchor{2b9}
@deffn {Atributo} type.__firstlineno__
@end deffn

@tab

The line number of the first line of the class definition,
including decorators.
Setting the @code{__module__} attribute removes the
@code{__firstlineno__} item from the type’s dictionary.


Added in version 3.13.


@item

@geindex __mro__ (atributo de type)
@anchor{reference/datamodel type __mro__}@anchor{1f2a}
@deffn {Atributo} type.__mro__
@end deffn

@tab

The @ref{464,,tuple} of classes that are considered when looking for
base classes during method resolution.

@end multitable


@node Special methods,,Special attributes,Clases personalizadas
@anchor{reference/datamodel special-methods}@anchor{1f2b}
@subsubsection Special methods


In addition to the special attributes described above, all Python classes also
have the following two methods available:

@geindex mro() (método de type)
@anchor{reference/datamodel type mro}@anchor{1f2c}
@deffn {Método} type.mro ()

This method can be overridden by a metaclass to customize the method
resolution order for its instances.  It is called at class instantiation,
and its result is stored in @ref{1f2a,,__mro__}.
@end deffn

@geindex __subclasses__() (método de type)
@anchor{reference/datamodel type __subclasses__}@anchor{617}
@deffn {Método} type.__subclasses__ ()

Each class keeps a list of weak references to its immediate subclasses. This
method returns a list of all those references still alive. The list is in
definition order. Example:

@example
>>> class A: pass
>>> class B(A): pass
>>> A.__subclasses__()
[<class 'B'>]
@end example
@end deffn

@node Instancias de clase,Objetos E/S también conocidos como objetos de archivo,Clases personalizadas,Jerarquía de tipos estándar
@anchor{reference/datamodel id4}@anchor{1f2d}
@subsubsection Instancias de clase


@geindex Objetos;instancia de clase
@geindex Objetos;instancia
@geindex clase;instancia
@geindex instancia de clase;atributo

A class instance is created by calling a class object (see above).  A class
instance has a namespace implemented as a dictionary which is the first place
in which attribute references are searched.  When an attribute is not found
there, and the instance’s class has an attribute by that name, the search
continues with the class attributes.  If a class attribute is found that is a
user-defined function object, it is transformed into an instance method
object whose @ref{1408,,__self__} attribute is the instance.  Static method and
class method objects are also transformed; see above under «Classes».  See
section @ref{cd7,,Implementando descriptores} for another way in which attributes of a class
retrieved via its instances may differ from the objects actually stored in
the class’s @ref{5fe,,__dict__}.  If no class attribute is found, and the
object’s class has a @ref{57a,,__getattr__()} method, that is called to satisfy
the lookup.

@geindex instancia de clase;atributo;asignación

Las asignaciones y eliminaciones de atributos actualizan el diccionario de la instancia, nunca el diccionario de una clase. Si la clase tiene un método @ref{1f2e,,__setattr__()} o @ref{1f2f,,__delattr__()}, se llama a este en lugar de actualizar el diccionario de instancia directamente.

@geindex Objetos;numérico
@geindex Objetos;Secuencias
@geindex Objetos;mapeos

Instancias de clases pueden pretender ser números, secuencias o mapeos si tienen métodos con ciertos nombres especiales.  Ver sección @ref{cf6,,Nombres especiales de método}.

@menu
* Special attributes: Special attributes<2>. 

@end menu

@node Special attributes<2>,,,Instancias de clase
@anchor{reference/datamodel id5}@anchor{1f30}
@subsubsection Special attributes


@geindex __dict__ (atributo de instancia)
@geindex __class__ (atributo de instancia)

@geindex __class__ (atributo de object)
@anchor{reference/datamodel object __class__}@anchor{14e9}
@deffn {Atributo} object.__class__

The class to which a class instance belongs.
@end deffn

@geindex __dict__ (atributo de object)
@anchor{reference/datamodel object __dict__}@anchor{5fe}
@deffn {Atributo} object.__dict__

A dictionary or other mapping object used to store an object’s (writable)
attributes. Not all instances have a @code{__dict__} attribute; see the
section on @ref{1f31,,__slots__} for more details.
@end deffn

@node Objetos E/S también conocidos como objetos de archivo,Tipos internos,Instancias de clase,Jerarquía de tipos estándar
@anchor{reference/datamodel i-o-objects-also-known-as-file-objects}@anchor{1f32}
@subsubsection Objetos E/S (también conocidos como objetos de archivo)


@geindex Funciones incorporadas;abrir
@geindex Módulo;io
@geindex popen() (en el módulo os)
@geindex makefile() (método de socket)
@geindex sys.stdin
@geindex sys.stdout
@geindex sys.stderr
@geindex stdio
@geindex stdin (en el módulo sys)
@geindex stdout (en el módulo sys)
@geindex stderr (en el módulo sys)

Un @ref{1230,,file object} representa un archivo abierto.  Diversos accesos directos se encuentran disponibles para crear objetos de archivo: la función incorporada @ref{1be,,open()}, así como @ref{1c5,,os.popen()}, @ref{1f33,,os.fdopen()}, y el método de objetos socket @code{makefile()} (y quizás por otras funciones y métodos proporcionados por módulos de extensión).

Los objetos @code{sys.stdin}, @code{sys.stdout} y @code{sys.stderr} son iniciados a objetos de archivos correspondientes a la entrada y salida estándar del intérprete, así como flujos de error; todos ellos están abiertos en el modo de texto y por lo tanto siguen la interface definida por la clase abstracta @ref{736,,io.TextIOBase}.

@node Tipos internos,,Objetos E/S también conocidos como objetos de archivo,Jerarquía de tipos estándar
@anchor{reference/datamodel internal-types}@anchor{1f34}
@subsubsection Tipos internos


@geindex tipo interno
@geindex tipos@comma{} interno

Algunos tipos utilizados internamente por el intérprete son expuestos al usuario. Sus definiciones pueden cambiar en futuras versiones del intérprete, pero son mencionadas aquí para complementar.

@menu
* Objetos de código:: 
* Objetos de marco:: 
* Objetos de seguimiento de pila (traceback): Objetos de seguimiento de pila traceback. 
* Objetos de segmento (Slice objects): Objetos de segmento Slice objects. 
* Objetos de método estático:: 
* Objetos de método de clase:: 

@end menu

@node Objetos de código,Objetos de marco,,Tipos internos
@anchor{reference/datamodel code-objects}@anchor{335}@anchor{reference/datamodel id6}@anchor{1f35}
@subsubsection Objetos de código


@geindex bytecode
@geindex Objetos;code
@geindex objeto de código

Los objetos de código representan código de Python ejecutable `compilado por bytes', o @ref{2f2,,bytecode}. La diferencia entre un objeto de código y un objeto de función es que el objeto de función contiene una referencia explícita a los globales de la función (el módulo en el que fue definido), mientras el objeto de código no contiene contexto; de igual manera los valores por defecto de los argumentos son almacenados en el objeto de función, no en el objeto de código (porque representan valores calculados en tiempo de ejecución).  A diferencia de objetos de función, los objetos de código son inmutables y no contienen referencias (directas o indirectas) a objetos mutables.

@geindex co_argcount (atributo de objeto de código)
@geindex co_posonlyargcount (atributo de objeto de código)
@geindex co_kwonlyargcount (atributo de objeto de código)
@geindex co_code (atributo de objeto de código)
@geindex co_consts (atributo de objeto de código)
@geindex co_filename (atributo de objeto de código)
@geindex co_firstlineno (atributo de objeto de código)
@geindex co_flags (atributo de objeto de código)
@geindex co_lnotab (atributo de objeto de código)
@geindex co_name (atributo de objeto de código)
@geindex co_names (atributo de objeto de código)
@geindex co_nlocals (atributo de objeto de código)
@geindex co_stacksize (atributo de objeto de código)
@geindex co_varnames (atributo de objeto de código)
@geindex co_cellvars (atributo de objeto de código)
@geindex co_freevars (atributo de objeto de código)
@geindex co_qualname (atributo de objeto de código)

@menu
* Special read-only attributes: Special read-only attributes<2>. 
* Methods on code objects:: 

@end menu

@node Special read-only attributes<2>,Methods on code objects,,Objetos de código
@anchor{reference/datamodel id7}@anchor{1f36}
@subsubsection Special read-only attributes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex co_name (atributo de codeobject)
@anchor{reference/datamodel codeobject co_name}@anchor{1f37}
@deffn {Atributo} codeobject.co_name
@end deffn

@tab

The function name

@item

@geindex co_qualname (atributo de codeobject)
@anchor{reference/datamodel codeobject co_qualname}@anchor{1f38}
@deffn {Atributo} codeobject.co_qualname
@end deffn

@tab

The fully qualified function name


Added in version 3.11.


@item

@geindex co_argcount (atributo de codeobject)
@anchor{reference/datamodel codeobject co_argcount}@anchor{1f39}
@deffn {Atributo} codeobject.co_argcount
@end deffn

@tab

The total number of positional @ref{1efc,,parameters}
(including positional-only parameters and parameters with default values)
that the function has

@item

@geindex co_posonlyargcount (atributo de codeobject)
@anchor{reference/datamodel codeobject co_posonlyargcount}@anchor{1f3a}
@deffn {Atributo} codeobject.co_posonlyargcount
@end deffn

@tab

The number of positional-only @ref{1efc,,parameters}
(including arguments with default values) that the function has

@item

@geindex co_kwonlyargcount (atributo de codeobject)
@anchor{reference/datamodel codeobject co_kwonlyargcount}@anchor{1f3b}
@deffn {Atributo} codeobject.co_kwonlyargcount
@end deffn

@tab

The number of keyword-only @ref{1efc,,parameters}
(including arguments with default values) that the function has

@item

@geindex co_nlocals (atributo de codeobject)
@anchor{reference/datamodel codeobject co_nlocals}@anchor{1f3c}
@deffn {Atributo} codeobject.co_nlocals
@end deffn

@tab

The number of @ref{1ef7,,local variables} used by the function
(including parameters)

@item

@geindex co_varnames (atributo de codeobject)
@anchor{reference/datamodel codeobject co_varnames}@anchor{1f3d}
@deffn {Atributo} codeobject.co_varnames
@end deffn

@tab

A @ref{464,,tuple} containing the names of the local variables in the
function (starting with the parameter names)

@item

@geindex co_cellvars (atributo de codeobject)
@anchor{reference/datamodel codeobject co_cellvars}@anchor{1f3e}
@deffn {Atributo} codeobject.co_cellvars
@end deffn

@tab

A @ref{464,,tuple} containing the names of @ref{1ef7,,local variables}
that are referenced from at least one @ref{1f3f,,nested scope} inside the function

@item

@geindex co_freevars (atributo de codeobject)
@anchor{reference/datamodel codeobject co_freevars}@anchor{1ef8}
@deffn {Atributo} codeobject.co_freevars
@end deffn

@tab

A @ref{464,,tuple} containing the names of
@ref{1f40,,free (closure) variables} that a @ref{1f3f,,nested scope}
references in an outer scope. See also @ref{1338,,function.__closure__}.

Note: references to global and builtin names are `not' included.

@item

@geindex co_code (atributo de codeobject)
@anchor{reference/datamodel codeobject co_code}@anchor{1f41}
@deffn {Atributo} codeobject.co_code
@end deffn

@tab

A string representing the sequence of @ref{2f2,,bytecode} instructions in
the function

@item

@geindex co_consts (atributo de codeobject)
@anchor{reference/datamodel codeobject co_consts}@anchor{15ad}
@deffn {Atributo} codeobject.co_consts
@end deffn

@tab

A @ref{464,,tuple} containing the literals used by the @ref{2f2,,bytecode} in
the function

@item

@geindex co_names (atributo de codeobject)
@anchor{reference/datamodel codeobject co_names}@anchor{1f42}
@deffn {Atributo} codeobject.co_names
@end deffn

@tab

A @ref{464,,tuple} containing the names used by the @ref{2f2,,bytecode} in
the function

@item

@geindex co_filename (atributo de codeobject)
@anchor{reference/datamodel codeobject co_filename}@anchor{13cd}
@deffn {Atributo} codeobject.co_filename
@end deffn

@tab

The name of the file from which the code was compiled

@item

@geindex co_firstlineno (atributo de codeobject)
@anchor{reference/datamodel codeobject co_firstlineno}@anchor{1f43}
@deffn {Atributo} codeobject.co_firstlineno
@end deffn

@tab

The line number of the first line of the function

@item

@geindex co_lnotab (atributo de codeobject)
@anchor{reference/datamodel codeobject co_lnotab}@anchor{1d9}
@deffn {Atributo} codeobject.co_lnotab
@end deffn

@tab

A string encoding the mapping from @ref{2f2,,bytecode} offsets to line
numbers. For details, see the source code of the interpreter.


Obsoleto desde la versión 3.12: This attribute of code objects is deprecated, and may be removed in
Python 3.15.


@item

@geindex co_stacksize (atributo de codeobject)
@anchor{reference/datamodel codeobject co_stacksize}@anchor{1f44}
@deffn {Atributo} codeobject.co_stacksize
@end deffn

@tab

The required stack size of the code object

@item

@geindex co_flags (atributo de codeobject)
@anchor{reference/datamodel codeobject co_flags}@anchor{15ae}
@deffn {Atributo} codeobject.co_flags
@end deffn

@tab

An @ref{1f0,,integer} encoding a number of flags for the
interpreter.

@end multitable


@geindex Objetos;generador

The following flag bits are defined for @ref{15ae,,co_flags}:
bit @code{0x04} is set if
the function uses the @code{*arguments} syntax to accept an arbitrary number of
positional arguments; bit @code{0x08} is set if the function uses the
@code{**keywords} syntax to accept arbitrary keyword arguments; bit @code{0x20} is set
if the function is a generator. See @ref{1f45,,Objetos de código Bit Flags} for details
on the semantics of each flags that might be present.

Future feature declarations (@code{from __future__ import division}) also use bits
in @ref{15ae,,co_flags} to indicate whether a code object was compiled with a
particular feature enabled: bit @code{0x2000} is set if the function was compiled
with future division enabled; bits @code{0x10} and @code{0x1000} were used in earlier
versions of Python.

Other bits in @ref{15ae,,co_flags} are reserved for internal use.

@geindex cadena de caracteres de documentación

If a code object represents a function and has a docstring,
the first item in @ref{15ad,,co_consts} is
the docstring of the function.

@node Methods on code objects,,Special read-only attributes<2>,Objetos de código
@anchor{reference/datamodel methods-on-code-objects}@anchor{1f46}
@subsubsection Methods on code objects


@geindex co_positions() (método de codeobject)
@anchor{reference/datamodel codeobject co_positions}@anchor{654}
@deffn {Método} codeobject.co_positions ()

Returns an iterable over the source code positions of each @ref{2f2,,bytecode}
instruction in the code object.

The iterator returns @ref{464,,tuple}s containing the @code{(start_line, end_line,
start_column, end_column)}. The `i-th' tuple corresponds to the
position of the source code that compiled to the `i-th' code unit.
Column information is 0-indexed utf-8 byte offsets on the given source
line.

Esta información posicional puede faltar. Una lista no exhaustiva de casos en los que esto puede suceder:


@itemize -

@item 
Ejecutando el intérprete con @ref{2e2,,-X} @code{no_debug_ranges}.

@item 
Cargando un archivo pyc compilado usando @ref{2e2,,-X} @code{no_debug_ranges}.

@item 
Tuplas de posición correspondientes a instrucciones artificiales.

@item 
Números de línea y columna que no se pueden representar debido a limitaciones específicas de la implementación.
@end itemize

Cuando esto ocurre, algunos o todos los elementos de la tupla pueden ser @ref{716,,None}.


Added in version 3.11.


@cartouche
@quotation Nota 
Esta función requiere el almacenamiento de posiciones de columna en objetos de código, lo que puede resultar en un pequeño aumento del uso del disco de archivos de Python compilados o del uso de la memoria del intérprete. Para evitar almacenar la información extra y/o desactivar la impresión de la información extra de seguimiento, se puede usar el indicador de línea de comando @ref{2e2,,-X} @code{no_debug_ranges} o la variable de entorno 
@geindex PYTHONNODEBUGRANGES
@geindex variables de entorno; PYTHONNODEBUGRANGES
@ref{657,,PYTHONNODEBUGRANGES}.
@end quotation
@end cartouche
@end deffn

@geindex co_lines() (método de codeobject)
@anchor{reference/datamodel codeobject co_lines}@anchor{1f3}
@deffn {Método} codeobject.co_lines ()

Returns an iterator that yields information about successive ranges of
@ref{2f2,,bytecode}s. Each item yielded is a @code{(start, end, lineno)}
@ref{464,,tuple}:


@itemize *

@item 
@code{start} (an @ref{1f0,,int}) represents the offset (inclusive) of the start
of the @ref{2f2,,bytecode} range

@item 
@code{end} (an @ref{1f0,,int}) represents the offset (exclusive) of the end of
the @ref{2f2,,bytecode} range

@item 
@code{lineno} is an @ref{1f0,,int} representing the line number of the
@ref{2f2,,bytecode} range, or @code{None} if the bytecodes in the given range
have no line number
@end itemize

The items yielded will have the following properties:


@itemize *

@item 
The first range yielded will have a @code{start} of 0.

@item 
The @code{(start, end)} ranges will be non-decreasing and consecutive. That
is, for any pair of @ref{464,,tuple}s, the @code{start} of the second will be
equal to the @code{end} of the first.

@item 
No range will be backwards: @code{end >= start} for all triples.

@item 
The last @ref{464,,tuple} yielded will have @code{end} equal to the size of the
@ref{2f2,,bytecode}.
@end itemize

Zero-width ranges, where @code{start == end}, are allowed. Zero-width ranges
are used for lines that are present in the source code, but have been
eliminated by the @ref{2f2,,bytecode} compiler.


Added in version 3.10.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 626

@item PEP 626@footnote{https://peps.python.org/pep-0626/} - Precise line numbers for debugging and other tools.

The PEP that introduced the @code{co_lines()} method.
@end table

@end deffn

@geindex replace() (método de codeobject)
@anchor{reference/datamodel codeobject replace}@anchor{1f47}
@deffn {Método} codeobject.replace (**kwargs)

Return a copy of the code object with new values for the specified fields.

Code objects are also supported by the generic function @ref{15f,,copy.replace()}.


Added in version 3.8.

@end deffn

@node Objetos de marco,Objetos de seguimiento de pila traceback,Objetos de código,Tipos internos
@anchor{reference/datamodel frame-objects}@anchor{780}@anchor{reference/datamodel id8}@anchor{1f48}
@subsubsection Objetos de marco


@geindex Objetos;frame

Frame objects represent execution frames.  They may occur in
@ref{b7f,,traceback objects},
and are also passed to registered trace functions.

@geindex f_back (atributo de frame)
@geindex f_code (atributo de frame)
@geindex f_globals (atributo de frame)
@geindex f_locals (atributo de frame)
@geindex f_lasti (atributo de frame)
@geindex f_builtins (atributo de frame)

@menu
* Special read-only attributes: Special read-only attributes<3>. 
* Special writable attributes: Special writable attributes<2>. 
* Frame object methods:: 

@end menu

@node Special read-only attributes<3>,Special writable attributes<2>,,Objetos de marco
@anchor{reference/datamodel id9}@anchor{1f49}
@subsubsection Special read-only attributes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_back (atributo de frame)
@anchor{reference/datamodel frame f_back}@anchor{825}
@deffn {Atributo} frame.f_back
@end deffn

@tab

Points to the previous stack frame (towards the caller),
or @code{None} if this is the bottom stack frame

@item

@geindex f_code (atributo de frame)
@anchor{reference/datamodel frame f_code}@anchor{1f4a}
@deffn {Atributo} frame.f_code
@end deffn

@tab

The @ref{335,,code object} being executed in this frame.
Accessing this attribute raises an @ref{18c3,,auditing event}
@code{object.__getattr__} with arguments @code{obj} and @code{"f_code"}.

@item

@geindex f_locals (atributo de frame)
@anchor{reference/datamodel frame f_locals}@anchor{2ed}
@deffn {Atributo} frame.f_locals
@end deffn

@tab

The mapping used by the frame to look up
@ref{1ef7,,local variables}.
If the frame refers to an @ref{2e9,,optimized scope},
this may return a write-through proxy object.


Distinto en la versión 3.13: Return a proxy for optimized scopes.


@item

@geindex f_globals (atributo de frame)
@anchor{reference/datamodel frame f_globals}@anchor{1f4b}
@deffn {Atributo} frame.f_globals
@end deffn

@tab

The dictionary used by the frame to look up
@ref{1ef7,,global variables}

@item

@geindex f_builtins (atributo de frame)
@anchor{reference/datamodel frame f_builtins}@anchor{1f4c}
@deffn {Atributo} frame.f_builtins
@end deffn

@tab

The dictionary used by the frame to look up
@ref{1ef7,,built-in (intrinsic) names}

@item

@geindex f_lasti (atributo de frame)
@anchor{reference/datamodel frame f_lasti}@anchor{920}
@deffn {Atributo} frame.f_lasti
@end deffn

@tab

The «precise instruction» of the frame object
(this is an index into the @ref{2f2,,bytecode} string of the
@ref{335,,code object})

@end multitable


@geindex f_trace (atributo de frame)
@geindex f_trace_lines (atributo de frame)
@geindex f_trace_opcodes (atributo de frame)
@geindex f_lineno (atributo de frame)

@node Special writable attributes<2>,Frame object methods,Special read-only attributes<3>,Objetos de marco
@anchor{reference/datamodel id10}@anchor{1f4d}
@subsubsection Special writable attributes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_trace (atributo de frame)
@anchor{reference/datamodel frame f_trace}@anchor{1f4e}
@deffn {Atributo} frame.f_trace
@end deffn

@tab

If not @code{None}, this is a function called for various events during
code execution (this is used by debuggers). Normally an event is
triggered for each new source line (see @ref{c63,,f_trace_lines}).

@item

@geindex f_trace_lines (atributo de frame)
@anchor{reference/datamodel frame f_trace_lines}@anchor{c63}
@deffn {Atributo} frame.f_trace_lines
@end deffn

@tab

Set this attribute to @ref{bbf,,False} to disable triggering a tracing
event for each source line.

@item

@geindex f_trace_opcodes (atributo de frame)
@anchor{reference/datamodel frame f_trace_opcodes}@anchor{c64}
@deffn {Atributo} frame.f_trace_opcodes
@end deffn

@tab

Set this attribute to @ref{c95,,True} to allow per-opcode events to be
requested. Note that this may lead to
undefined interpreter behaviour if exceptions raised by the trace
function escape to the function being traced.

@item

@geindex f_lineno (atributo de frame)
@anchor{reference/datamodel frame f_lineno}@anchor{845}
@deffn {Atributo} frame.f_lineno
@end deffn

@tab

The current line number of the frame – writing to this
from within a trace function jumps to the given line (only for the bottom-most
frame).  A debugger can implement a Jump command (aka Set Next Statement)
by writing to this attribute.

@end multitable


@node Frame object methods,,Special writable attributes<2>,Objetos de marco
@anchor{reference/datamodel frame-object-methods}@anchor{1f4f}
@subsubsection Frame object methods


Objetos de marco soportan un método:

@geindex clear() (método de frame)
@anchor{reference/datamodel frame clear}@anchor{3d5}
@deffn {Método} frame.clear ()

This method clears all references to @ref{1ef7,,local variables} held by the
frame.  Also, if the frame belonged to a @ref{10dd,,generator}, the generator
is finalized.  This helps break reference cycles involving frame
objects (for example when catching an @ref{188b,,exception}
and storing its @ref{b7f,,traceback} for later use).

@ref{1e5,,RuntimeError} is raised if the frame is currently executing
or suspended.


Added in version 3.4.



Distinto en la versión 3.13: Attempting to clear a suspended frame raises @ref{1e5,,RuntimeError}
(as has always been the case for executing frames).

@end deffn

@node Objetos de seguimiento de pila traceback,Objetos de segmento Slice objects,Objetos de marco,Tipos internos
@anchor{reference/datamodel id11}@anchor{1f50}@anchor{reference/datamodel traceback-objects}@anchor{b7f}
@subsubsection Objetos de seguimiento de pila (traceback)


@geindex Objetos;traceback
@geindex stack;trace
@geindex excepción;manejador
@geindex execution;stack
@geindex exc_info (en el módulo sys)
@geindex last_traceback (en el módulo sys)
@geindex sys.exc_info
@geindex sys.exception
@geindex sys.last_traceback

Traceback objects represent the stack trace of an @ref{1c91,,exception}.
A traceback object
is implicitly created when an exception occurs, and may also be explicitly
created by calling @ref{b7d,,types.TracebackType}.


Distinto en la versión 3.7: Traceback objects can now be explicitly instantiated from Python code.


For implicitly created tracebacks, when the search for an exception handler
unwinds the execution stack, at each unwound level a traceback object is
inserted in front of the current traceback.  When an exception handler is
entered, the stack trace is made available to the program. (See section
@ref{789,,La sentencia try}.) It is accessible as the third item of the
tuple returned by @ref{72b,,sys.exc_info()}, and as the
@ref{1330,,__traceback__} attribute
of the caught exception.

When the program contains no suitable
handler, the stack trace is written (nicely formatted) to the standard error
stream; if the interpreter is interactive, it is also made available to the user
as @ref{568,,sys.last_traceback}.

For explicitly created tracebacks, it is up to the creator of the traceback
to determine how the @ref{b7e,,tb_next} attributes should be linked to
form a full stack trace.

@geindex tb_frame (atributo de traceback)
@geindex tb_lineno (atributo de traceback)
@geindex tb_lasti (atributo de traceback)
@geindex declaración;try

Special read-only attributes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex tb_frame (atributo de traceback)
@anchor{reference/datamodel traceback tb_frame}@anchor{1f51}
@deffn {Atributo} traceback.tb_frame
@end deffn

@tab

Points to the execution @ref{780,,frame} of the current
level.

Accessing this attribute raises an
@ref{18c3,,auditing event} @code{object.__getattr__} with arguments
@code{obj} and @code{"tb_frame"}.

@item

@geindex tb_lineno (atributo de traceback)
@anchor{reference/datamodel traceback tb_lineno}@anchor{1f52}
@deffn {Atributo} traceback.tb_lineno
@end deffn

@tab

Gives the line number where the exception occurred

@item

@geindex tb_lasti (atributo de traceback)
@anchor{reference/datamodel traceback tb_lasti}@anchor{1f53}
@deffn {Atributo} traceback.tb_lasti
@end deffn

@tab

Indicates the «precise instruction».

@end multitable


The line number and last instruction in the traceback may differ from the
line number of its @ref{780,,frame object} if the exception
occurred in a
@ref{789,,try} statement with no matching except clause or with a
@ref{a5c,,finally} clause.

@geindex tb_next (atributo de traceback)

@geindex tb_next (atributo de traceback)
@anchor{reference/datamodel traceback tb_next}@anchor{b7e}
@deffn {Atributo} traceback.tb_next

The special writable attribute @code{tb_next} is the next level in the
stack trace (towards the frame where the exception occurred), or @code{None} if
there is no next level.


Distinto en la versión 3.7: This attribute is now writable

@end deffn

@node Objetos de segmento Slice objects,Objetos de método estático,Objetos de seguimiento de pila traceback,Tipos internos
@anchor{reference/datamodel slice-objects}@anchor{1f54}
@subsubsection Objetos de segmento (Slice objects)


@geindex Funciones incorporadas;slice

Los objetos de sector se utilizan para representar sectores para métodos @ref{3d8,,__getitem__()}. También son creados por la función integrada @ref{514,,slice()}.

@geindex comienzo (atributo de objeto slice)
@geindex stop (atributo de objeto slice)
@geindex step (atributo de objeto slice)

Atributos especiales de solo lectura: @ref{1f55,,start} es el límite inferior; @ref{1f56,,stop} es el límite superior; @ref{1f57,,step} es el valor de paso; cada uno es @code{None} si es omitido. Estos atributos pueden ser de cualquier tipo.

Los objetos de segmento soportan un método:

@geindex indices() (método de slice)
@anchor{reference/datamodel slice indices}@anchor{10a3}
@deffn {Método} slice.indices (self, length)

Este método toma un argumento `length' de entero simple y calcula información relacionada con el segmento que el mismo describiría si fuera aplicado a una secuencia de elementos `length'. Retorna una tupla de tres enteros; respectivamente estos son los índices `start' y `stop' y el `step' o longitud del paso del segmento. Índices faltantes o fuera de los límites son manipulados de manera consistente con segmentos regulares.
@end deffn

@node Objetos de método estático,Objetos de método de clase,Objetos de segmento Slice objects,Tipos internos
@anchor{reference/datamodel static-method-objects}@anchor{1f58}
@subsubsection Objetos de método estático


Los objetos de método estático proveen una forma de anular la transformación de objetos de función a objetos de método descritos anteriormente. Un objeto de método estático es una envoltura (`wrapper') alrededor de cualquier otro objeto, usualmente un objeto de método definido por usuario. Cuando un objeto de método estático es obtenido desde una clase o una instancia de clase, usualmente el objeto retornado es el objeto envuelto, el cual no está objeto a ninguna transformación adicional. Los objetos de método estático también pueden ser llamados. Los objetos de método estático son creados por el constructor incorporado @ref{22e,,staticmethod()}.

@node Objetos de método de clase,,Objetos de método estático,Tipos internos
@anchor{reference/datamodel class-method-objects}@anchor{1f59}
@subsubsection Objetos de método de clase


A class method object, like a static method object, is a wrapper around another
object that alters the way in which that object is retrieved from classes and
class instances. The behaviour of class method objects upon such retrieval is
described above, under @ref{1cc5,,«instance methods»}. Class method objects are created
by the built-in @ref{2d2,,classmethod()} constructor.

@node Nombres especiales de método,Corrutinas,Jerarquía de tipos estándar,Modelo de datos
@anchor{reference/datamodel special-method-names}@anchor{1f5a}@anchor{reference/datamodel specialnames}@anchor{cf6}
@subsection Nombres especiales de método


@geindex operador;sobrecarga
@geindex __getitem__() (método de objeto mapping)

Una clase puede implementar ciertas operaciones que se invocan mediante una sintaxis especial (como operaciones aritméticas o subíndices y divisiones) definiendo métodos con nombres especiales. Este es el enfoque de Python para `sobrecarga de operadores', permitiendo a las clases definir su propio comportamiento con respecto a los operadores del lenguaje. Por ejemplo, si una clase define un método denominado @ref{3d8,,__getitem__()} y @code{x} es una instancia de esta clase, entonces @code{x[i]} es aproximadamente equivalente a @code{type(x).__getitem__(x, i)}. Excepto donde se mencione, los intentos de ejecutar una operación generan una excepción cuando no se define ningún método apropiado (normalmente @ref{441,,AttributeError} o @ref{228,,TypeError}).

Establecer un método especial en @code{None} indica que la operación correspondiente no está disponible. Por ejemplo, si una clase establece @ref{1f5b,,__iter__()} en @code{None}, la clase no es iterable, por lo que llamar a @ref{86e,,iter()} en sus instancias generará un @ref{228,,TypeError} (sin recurrir a @ref{3d8,,__getitem__()}). @footnote{
The @ref{b86,,__hash__()}, @ref{1f5b,,__iter__()},
@ref{1f5c,,__reversed__()}, @ref{1f5d,,__contains__()},
@ref{7d6,,__class_getitem__()} and @ref{cda,,__fspath__()}
methods have special handling for this. Others
will still raise a @ref{228,,TypeError}, but may do so by relying on
the behavior that @code{None} is not callable.
}

Cuando se implementa una clase que emula cualquier tipo incorporado, es importante que la emulación solo sea implementado al grado que hace sentido para el objeto que está siendo modelado. Por ejemplo, algunas secuencias pueden trabajar bien con la obtención de elementos individuales, pero extraer un segmento puede no tener mucho sentido. (Un ejemplo de esto es la interfaz @code{NodeList}, en el Modelo de Objetos del Documento del W3C.)

@menu
* Personalización básica:: 
* Personalizando acceso a atributos:: 
* Personalización de creación de clases:: 
* Personalizando revisiones de instancia y subclase:: 
* Emulando tipos genéricos:: 
* Emulando objetos que se pueden llamar:: 
* Emulando tipos de contenedores:: 
* Emulando tipos numéricos:: 
* Gestores de Contexto en la Declaración with:: 
* Personalización de argumentos posicionales en la coincidencia de patrones de clase:: 
* Emulando tipos de búfer:: 
* Annotations:: 
* Búsqueda de método especial:: 

@end menu

@node Personalización básica,Personalizando acceso a atributos,,Nombres especiales de método
@anchor{reference/datamodel basic-customization}@anchor{1f5e}@anchor{reference/datamodel customization}@anchor{1f5f}
@subsubsection Personalización básica


@geindex __new__() (método de object)
@anchor{reference/datamodel object __new__}@anchor{624}
@deffn {Método} object.__new__ (cls[, ...])

@geindex subclase;tipos inmutables

Es llamado para crear una nueva instancia de clase `cls'. @ref{624,,__new__()} es un método estático (como un caso especial, así que no se necesita declarar como tal) que toma la clase de donde fue solicitada una instancia como su primer argumento. Los argumentos restantes son aquellos que se pasan a la expresión del constructor de objetos (para llamar a la clase). El valor retornado de @ref{624,,__new__()} deberá ser la nueva instancia de objeto (normalmente una instancia de `cls').

Las implementaciones típicas crean una nueva instancia de la clase invocando el método @ref{624,,__new__()} de la superclase usando @code{super().__new__(cls[, ...])} con los argumentos apropiados y luego modificando la instancia recién creada según sea necesario antes de retornarla.

Si @ref{624,,__new__()} es invocado durante la construcción del objeto y éste retorna una instancia de `cls', entonces el nuevo método @ref{751,,__init__()} de la instancia será invocado como @code{__init__(self[, …])}, donde `self' es la nueva instancia y los argumentos restantes son iguales a como fueron pasados hacia el constructor de objetos.

Si @ref{624,,__new__()} no retorna una instancia de `cls', entonces el nuevo método @ref{751,,__init__()} de la instancia no será invocado.

@ref{624,,__new__()} es destinado principalmente para permitir a subclases de tipos inmutables (como int, str, o tuple) personalizar la creación de instancias. También es comúnmente anulado en metaclases personalizadas con el fin de personalizar la creación de clase.
@end deffn

@geindex __init__() (método de object)
@anchor{reference/datamodel object __init__}@anchor{751}
@deffn {Método} object.__init__ (self[, ...])

@geindex clase;constructor

Llamado después de que la instancia ha sido creada (por @ref{624,,__new__()}), pero antes es retornada a quien produce la llamada. Los argumentos son aquellos pasados a la expresión del constructor de la clase. Si una clase base tiene un método @ref{751,,__init__()}, el método @ref{751,,__init__()} de clase derivada, de existir, debe llamarlo explícitamente para asegurar la inicialización apropiada de la clase base que es parte de la instancia; por ejemplo: @code{super().__init__([args…])}.

Debido a que @ref{624,,__new__()} y @ref{751,,__init__()} trabajan juntos construyendo objetos (@ref{624,,__new__()} para crearlo y @ref{751,,__init__()} para personalizarlo), ningún valor distinto a @code{None} puede ser retornado por @ref{751,,__init__()}; hacer esto puede causar que se lance una excepción @ref{228,,TypeError} en tiempo de ejecución.
@end deffn

@geindex __del__() (método de object)
@anchor{reference/datamodel object __del__}@anchor{1f60}
@deffn {Método} object.__del__ (self)

@geindex destructor
@geindex finalizador
@geindex declaración;del

Llamado cuando la instancia es a punto de ser destruida. Esto también es llamado finalizador o (indebidamente) destructor. Si una clase base tiene un método @ref{1f60,,__del__()} el método @ref{1f60,,__del__()} de la clase derivada, de existir, debe llamarlo explícitamente para asegurar la eliminación adecuada de la parte de la clase base de la instancia.

Es posible (¡aunque no recomendable!) para el método @ref{1f60,,__del__()} posponer la destrucción de la instancia al crear una nueva referencia hacia ésta. Esto es llamado `resurrección' de objeto. Es dependiente de la implementación si @ref{1f60,,__del__()} es llamado una segunda vez cuando un objeto resucitado está por ser destruido; la implementación @ref{796,,CPython} actual únicamente lo llama una vez.

It is not guaranteed that @ref{1f60,,__del__()} methods are called for objects
that still exist when the interpreter exits.
@ref{b09,,weakref.finalize} provides a straightforward way to register
a cleanup function to be called when an object is garbage collected.

@cartouche
@quotation Nota 
@code{del x} no llama directamente @code{x.__del__()} — el primero disminuye el conteo de referencia para @code{x} uno por uno, y el segundo es llamado únicamente cuando el conteo de referencias de @code{x} llega a cero.
@end quotation
@end cartouche

`Detalles de implementación de CPython:' Es posible que un ciclo de referencia evite que el recuento de referencia de un objeto llegue a cero. En este caso, el ciclo será posteriormente detectado y eliminado por el @ref{1922,,cyclic garbage collector}. Una causa común de los ciclos de referencia es cuando se detecta una excepción en una variable local. Luego, los locales del marco hacen referencia a la excepción, que hace referencia a su propio rastreo, que hace referencia a los locales de todos los marcos capturados en el rastreo.


@subsubheading Ver también


Documentación para el módulo @ref{60,,gc}.


@cartouche
@quotation Advertencia 
Debido a las circunstancias inciertas bajo las que los métodos @ref{1f60,,__del__()} son invocados, las excepciones que ocurren durante su ejecución son ignoradas, y una advertencia es mostrada hacia @code{sys.stderr}. En particular:


@itemize *

@item 
@ref{1f60,,__del__()} puede ser invocado cuando código arbitrario es ejecutado, incluyendo el de cualquier hilo arbitrario. Si @ref{1f60,,__del__()} necesita realizar un cierre de exclusión mutua (`lock') o invocar cualquier otro recurso que lo esté bloqueando, podría provocar un bloqueo muto (`deadlock') ya que el recurso podría estar siendo utilizado por el código que se interrumpe al ejecutar @ref{1f60,,__del__()}.

@item 
@ref{1f60,,__del__()} puede ser ejecutado durante el cierre del intérprete. Como consecuencia, las variables globales que necesita para acceder (incluyendo otros módulos) podrían haber sido borradas o establecidas a @code{None}. Python garantiza que los globales cuyo nombre comienza con un guión bajo simple sean borrados de su módulo antes que los globales sean borrados; si no existen otras referencias a dichas globales, esto puede ayudar asegurando que los módulos importados aún se encuentren disponibles al momento de llamar al método @ref{1f60,,__del__()}.
@end itemize
@end quotation
@end cartouche

@geindex repr() (función incorporada);__repr__() (método objeto)
@end deffn

@geindex __repr__() (método de object)
@anchor{reference/datamodel object __repr__}@anchor{6bd}
@deffn {Método} object.__repr__ (self)

Llamado por la función incorporada @ref{894,,repr()} para calcular la cadena “oficial” de representación de un objeto. Si es posible, esto debería verse como una expresión de Python válida que puede ser utilizada para recrear un objeto con el mismo valor (bajo el ambiente adecuado). Si no es posible, una cadena con la forma @code{<…some useful description…>} debe ser retornada. El valor de retorno debe ser un objeto de cadena (`string'). Si una clase define @ref{6bd,,__repr__()} pero no @ref{6be,,__str__()}, entonces @ref{6bd,,__repr__()} también es utilizado cuando una cadena “informal” de representación de instancias de esas clases son requeridas.

This is typically used for debugging, so it is important that the representation
is information-rich and unambiguous. A default implementation is provided by the
@ref{b18,,object} class itself.

@geindex cadenas de caracteres;__str__() (método objeto)
@geindex format() (función incorporada);__str__() (método objeto)
@geindex print() (función incorporada);__str__() (método objeto)
@end deffn

@geindex __str__() (método de object)
@anchor{reference/datamodel object __str__}@anchor{6be}
@deffn {Método} object.__str__ (self)

Called by @ref{237,,str(object)}, the default @ref{6bf,,__format__()} implementation,
and the built-in function @ref{ff4,,print()}, to compute the «informal» or nicely
printable string representation of an object.  The return value must be a
@ref{1c04,,str} object.

Este método difiere de @ref{6bd,,object.__repr__()} en que no hay expectativas de que @ref{6be,,__str__()} retorne una expresión de Python válida: una representación más conveniente o concisa pueda ser utilizada.

La implementación por defecto definida por el tipo incorporado @ref{b18,,object} llama a @ref{6bd,,object.__repr__()}.

@c XXX what about subclasses of string?
@end deffn

@geindex __bytes__() (método de object)
@anchor{reference/datamodel object __bytes__}@anchor{688}
@deffn {Método} object.__bytes__ (self)

@geindex Funciones incorporadas;bytes

Called by @ref{1ac0,,bytes} to compute a byte-string representation
of an object. This should return a @ref{325,,bytes} object. The @ref{b18,,object}
class itself does not provide this method.

@geindex cadenas de caracteres;__format__() (método objeto)
@geindex cadenas de caracteres;conversión
@geindex Funciones incorporadas;print
@end deffn

@geindex __format__() (método de object)
@anchor{reference/datamodel object __format__}@anchor{6bf}
@deffn {Método} object.__format__ (self, format_spec)

Llamado por la función incorporada @ref{6c0,,format()}, y por extensión, la evaluación de @ref{a3b,,formatted string literals} y el método @ref{6c2,,str.format()}, para producir la representación “formateada” de un objeto. El argumento `format_spec' es una cadena que contiene una descripción de las opciones de formato deseadas. La interpretación del argumento `format_spec' depende del tipo que implementa @ref{6bf,,__format__()}, sin embargo, ya sea que la mayoría de las clases deleguen el formato a uno de los tipos incorporados, o utilicen una sintaxis de opción de formato similar.

Ver @ref{347,,Especificación de formato Mini-Lenguaje} para una descripción de la sintaxis de formato estándar.

El valor de retorno debe ser un objeto de cadena.

The default implementation by the @ref{b18,,object} class should be given
an empty `format_spec' string. It delegates to @ref{6be,,__str__()}.


Distinto en la versión 3.4: El método __format__ del mismo @code{object} lanza un @ref{228,,TypeError} si se la pasa una cadena no vacía.



Distinto en la versión 3.7: @code{object.__format__(x, ‘’)} es ahora equivalente a @code{str(x)} en lugar de @code{format(str(self), ‘’)}.

@end deffn

@geindex __lt__() (método de object)
@geindex __le__() (método de object)
@geindex __eq__() (método de object)
@geindex __ne__() (método de object)
@geindex __gt__() (método de object)
@geindex __ge__() (método de object)
@anchor{reference/datamodel richcmpfuncs}@anchor{1f61}@anchor{reference/datamodel object __lt__}@anchor{1372}
@deffn {Método} object.__lt__ (self, other)
@anchor{reference/datamodel object __le__}@anchor{1373}
@deffnx {Método} object.__le__ (self, other)
@anchor{reference/datamodel object __eq__}@anchor{b85}
@deffnx {Método} object.__eq__ (self, other)
@anchor{reference/datamodel object __ne__}@anchor{1558}
@deffnx {Método} object.__ne__ (self, other)
@anchor{reference/datamodel object __gt__}@anchor{1374}
@deffnx {Método} object.__gt__ (self, other)
@anchor{reference/datamodel object __ge__}@anchor{1375}
@deffnx {Método} object.__ge__ (self, other)

@geindex comparaciones

Estos son los llamados métodos de comparación `rich'. La correspondencia entre símbolos de operador y los nombres de método es de la siguiente manera: @code{x<y} llama @code{x.__lt__(y)}, @code{x<=y} llama @code{x.__le__(y)}, @code{x==y} llama @code{x.__eq__(y)}, @code{x!=y} llama @code{x.__ne__(y)}, @code{x>y} llama @code{x.__gt__(y)}, y @code{x>=y} llama @code{x.__ge__(y)}.

A rich comparison method may return the singleton @ref{227,,NotImplemented} if it does
not implement the operation for a given pair of arguments. By convention,
@code{False} and @code{True} are returned for a successful comparison. However, these
methods can return any value, so if the comparison operator is used in a Boolean
context (e.g., in the condition of an @code{if} statement), Python will call
@ref{513,,bool()} on the value to determine if the result is true or false.

By default, @code{object} implements @ref{b85,,__eq__()} by using @code{is}, returning
@ref{227,,NotImplemented} in the case of a false comparison:
@code{True if x is y else NotImplemented}. For @ref{1558,,__ne__()}, by default it
delegates to @ref{b85,,__eq__()} and inverts the result unless it is
@code{NotImplemented}.  There are no other implied relationships among the
comparison operators or default implementations; for example, the truth of
@code{(x<y or x==y)} does not imply @code{x<=y}. To automatically generate ordering
operations from a single root operation, see @ref{fc2,,functools.total_ordering()}.

By default, the @ref{b18,,object} class provides implementations consistent
with @ref{1883,,Comparaciones de valor}: equality compares according to
object identity, and order comparisons raise @ref{228,,TypeError}. Each default
method may generate these results directly, but may also return
@ref{227,,NotImplemented}.

Ver el párrafo sobre @ref{b86,,__hash__()} para más notas importantes sobre la creación de objetos @ref{6b1,,hashable} que soportan operaciones de comparación personalizadas y son utilizables como llaves de diccionario.

There are no swapped-argument versions of these methods (to be used when the
left argument does not support the operation but the right argument does);
rather, @ref{1372,,__lt__()} and @ref{1374,,__gt__()} are each other’s reflection,
@ref{1373,,__le__()} and @ref{1375,,__ge__()} are each other’s reflection, and
@ref{b85,,__eq__()} and @ref{1558,,__ne__()} are their own reflection.
If the operands are of different types, and the right operand’s type is
a direct or indirect subclass of the left operand’s type,
the reflected method of the right operand has priority, otherwise
the left operand’s method has priority.  Virtual subclassing is
not considered.

When no appropriate method returns any value other than @ref{227,,NotImplemented}, the
@code{==} and @code{!=} operators will fall back to @code{is} and @code{is not}, respectively.
@end deffn

@geindex __hash__() (método de object)
@anchor{reference/datamodel object __hash__}@anchor{b86}
@deffn {Método} object.__hash__ (self)

@geindex Objetos;diccionario
@geindex Funciones incorporadas;hash

Lo llama la función integrada @ref{68b,,hash()} y para operaciones en miembros de colecciones hash, incluidas @ref{67a,,set}, @ref{67b,,frozenset} y @ref{190,,dict}. El método @code{__hash__()} debería retornar un número entero. La única propiedad requerida es que los objetos que se comparan iguales tengan el mismo valor hash; Se recomienda mezclar los valores hash de los componentes del objeto que también desempeñan un papel en la comparación de objetos empaquetándolos en una tupla y aplicando hash a la tupla. Ejemplo:

@example
def __hash__(self):
    return hash((self.name, self.nick, self.color))
@end example

@cartouche
@quotation Nota 
@ref{68b,,hash()} trunca el valor retornado del método personalizado @ref{b86,,__hash__()} del objeto al tamaño de @ref{af0,,Py_ssize_t}. Esto normalmente son 8 bytes en estructuras de 64-bits y 4 bytes en estructuras de 32 bits. Si el @ref{b86,,__hash__()} de un objeto debe interoperar en estructuras de tamaños de bits diferentes, asegúrese de revisar la amplitud en todas las estructuras soportadas. Una forma fácil de hacer esto es con @code{python -c “import sys; print(sys.hash_info.width)”}.
@end quotation
@end cartouche

Si una clase no define un método @ref{b85,,__eq__()} tampoco debería definir una operación @ref{b86,,__hash__()}; si define @ref{b85,,__eq__()} pero no @ref{b86,,__hash__()}, sus instancias no se podrán utilizar como elementos en colecciones hash. Si una clase define objetos mutables e implementa un método @ref{b85,,__eq__()}, no debería implementar @ref{b86,,__hash__()}, ya que la implementación de colecciones @ref{6b1,,hashable} requiere que el valor hash de una clave sea inmutable (si el valor hash del objeto cambia, estará en el depósito hash incorrecto).

User-defined classes have @ref{b85,,__eq__()} and @ref{b86,,__hash__()} methods
by default (inherited from the @ref{b18,,object} class); with them, all objects compare
unequal (except with themselves) and @code{x.__hash__()} returns an appropriate
value such that @code{x == y} implies both that @code{x is y} and @code{hash(x) == hash(y)}.

Una clase que anula @ref{b85,,__eq__()} y no define @ref{b86,,__hash__()} tendrá implícito su @ref{b86,,__hash__()} establecido a @code{None}. Cuando el método @ref{b86,,__hash__()} de una clase es @code{None}, instancias de la clase lanzarán un @ref{228,,TypeError} cuando el programa intente obtener el valor del hash, y también será correctamente identificado como de hash no calculable cuando se verifique @code{isinstance(obj, collections.abc.Hashable)}.

Si una clase que anula @ref{b85,,__eq__()} necesita conservar la implementación de @ref{b86,,__hash__()} de una clase padre, al intérprete se le debe informar explícitamente estableciendo @code{__hash__ = <ParentClass>.__hash__}.

Si una clase que no anula @ref{b85,,__eq__()} desea eliminar el soporte de `hash', debe incluir @code{__hash__ = None} en la definición de clase. Una clase que define su propio @ref{b86,,__hash__()} y que explícitamente lanza un @ref{228,,TypeError} será identificado de manera incorrecta como de hash calculable por una llamada @code{isinstance(obj, collections.abc.Hashable)}.

@cartouche
@quotation Nota 
Por defecto los valores de objetos str y bytes de @ref{b86,,__hash__()} son “salados” con un valor aleatorio impredecible. Aunque se mantienen constantes dentro de un proceso Python particular, no son predecibles entre invocaciones repetidas de Python.

This is intended to provide protection against a denial-of-service caused
by carefully chosen inputs that exploit the worst case performance of a
dict insertion, `O'(`n'@w{^2}) complexity.  See
@indicateurl{http://ocert.org/advisories/ocert-2011-003.html} for details.

Cambiar los valores hash afectan el orden de la iteración de los sets. Python nunca ha dado garantías en relación a este orden (y típicamente varía entre estructuras de 32-bits y 64-bits).

Ver también 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED}.
@end quotation
@end cartouche


Distinto en la versión 3.3: La aleatorización de hash es habilitada por defecto.

@end deffn

@geindex __bool__() (método de object)
@anchor{reference/datamodel object __bool__}@anchor{133d}
@deffn {Método} object.__bool__ (self)

@geindex __len__() (método objeto mapping)

Called to implement truth value testing and the built-in operation
@code{bool()}; should return @code{False} or @code{True}.  When this method is not
defined, @ref{1f62,,__len__()} is called, if it is defined, and the object is
considered true if its result is nonzero.  If a class defines neither
@code{__len__()} nor @code{__bool__()} (which is true of the @ref{b18,,object}
class itself), all its instances are considered true.
@end deffn

@node Personalizando acceso a atributos,Personalización de creación de clases,Personalización básica,Nombres especiales de método
@anchor{reference/datamodel attribute-access}@anchor{1f63}@anchor{reference/datamodel customizing-attribute-access}@anchor{1f64}
@subsubsection Personalizando acceso a atributos


Los siguientes métodos pueden ser definidos para personalizar el significado de acceso a atributos (uso de, asignación a, o borrado de @code{x.name}) para instancias de clase.

@c XXX explain how descriptors interfere here!

@geindex __getattr__() (método de object)
@anchor{reference/datamodel object __getattr__}@anchor{57a}
@deffn {Método} object.__getattr__ (self, name)

Called when the default attribute access fails with an @ref{441,,AttributeError}
(either @ref{c5a,,__getattribute__()} raises an @ref{441,,AttributeError} because
`name' is not an instance attribute or an attribute in the class tree
for @code{self}; or @ref{1527,,__get__()} of a `name' property raises
@ref{441,,AttributeError}).  This method should either return the (computed)
attribute value or raise an @ref{441,,AttributeError} exception.
The @ref{b18,,object} class itself does not provide this method.

Note that if the attribute is found through the normal mechanism,
@ref{57a,,__getattr__()} is not called.  (This is an intentional asymmetry between
@ref{57a,,__getattr__()} and @ref{1f2e,,__setattr__()}.) This is done both for efficiency
reasons and because otherwise @ref{57a,,__getattr__()} would have no way to access
other attributes of the instance.  Note that at least for instance variables,
you can take total control by not inserting any values in the instance attribute
dictionary (but instead inserting them in another object).  See the
@ref{c5a,,__getattribute__()} method below for a way to actually get total control
over attribute access.
@end deffn

@geindex __getattribute__() (método de object)
@anchor{reference/datamodel object __getattribute__}@anchor{c5a}
@deffn {Método} object.__getattribute__ (self, name)

Es llamado incondicionalmente para implementar acceso de atributo por instancias de clase. Si la clase también define @ref{57a,,__getattr__()}, éste no será llamado a menos que @ref{c5a,,__getattribute__()} lo llame de manera explícita o lance una excepción @ref{441,,AttributeError}. Este método deberá retornar el valor de atributo (calculado) o lanzar una excepción @ref{441,,AttributeError}. Para evitar la recursividad infinita en este método, su implementación deberá siempre llamar al método de la clase base con el mismo nombre para acceder cualquier atributo que necesite, por ejemplo, @code{object.__getattribute__(self, name)}.

@cartouche
@quotation Nota 
This method may still be bypassed when looking up special methods as the
result of implicit invocation via language syntax or
@ref{1eff,,built-in functions}.
See @ref{1f65,,Búsqueda de método especial}.
@end quotation
@end cartouche

Para ciertos accesos a atributos sensibles, lanza un @ref{18c3,,evento de auditoría} @code{object.__getattr__} con los argumentos @code{obj} y @code{name}.
@end deffn

@geindex __setattr__() (método de object)
@anchor{reference/datamodel object __setattr__}@anchor{1f2e}
@deffn {Método} object.__setattr__ (self, name, value)

Es llamado cuando se intenta la asignación de atributos. Éste es llamado en lugar del mecanismo normal (p. ej. guardar el valor en el diccionario de instancias). `name' es el nombre de atributo, `value' es el valor que se le asigna.

Si @ref{1f2e,,__setattr__()} quiere asignar a un atributo de instancia, debe llamar al método de la clase base con el mismo nombre, por ejemplo, @code{object.__setattr__(self, name, value)}.

Para ciertas asignaciones de atributos sensibles, lanza un @ref{18c3,,evento de auditoría} @code{object.__setattr__} con argumentos @code{obj}, @code{name}, @code{value}.
@end deffn

@geindex __delattr__() (método de object)
@anchor{reference/datamodel object __delattr__}@anchor{1f2f}
@deffn {Método} object.__delattr__ (self, name)

Al igual que @ref{1f2e,,__setattr__()} pero para borrado de atributos en lugar de establecerlos. Esto solo de ser implementado si @code{del obj.name} es significativo para el objeto.

Para ciertas eliminaciones de atributos sensibles, lanza un @ref{18c3,,evento de auditoría} @code{object.__delattr__} con argumentos @code{obj} y @code{name}.
@end deffn

@geindex __dir__() (método de object)
@anchor{reference/datamodel object __dir__}@anchor{1f66}
@deffn {Método} object.__dir__ (self)

Called when @ref{6d3,,dir()} is called on the object. An iterable must be
returned. @ref{6d3,,dir()} converts the returned iterable to a list and sorts it.
@end deffn

@menu
* Personalizando acceso a atributos de módulo:: 
* Implementando descriptores:: 
* Invocando descriptores:: 
* __slots__: __slots__<2>. 

@end menu

@node Personalizando acceso a atributos de módulo,Implementando descriptores,,Personalizando acceso a atributos
@anchor{reference/datamodel customizing-module-attribute-access}@anchor{1f67}
@subsubsection Personalizando acceso a atributos de módulo


@geindex __getattr__ (atributo de módulo)
@geindex __dir__ (atributo de módulo)
@geindex __class__ (atributo de módulo)

Nombres especiales @code{__getattr__} y @code{__dir__} también pueden ser utilizados para personalizar acceso a atributos de módulo. La función @code{__getattr__} a nivel del módulo debe aceptar un argumento que es el nombre del atributo y retornar el valor calculado o lanzar una excepción @ref{441,,AttributeError}. Si un atributo no es encontrado en el objeto de módulo a través de una búsqueda normal, p. ej. @ref{c5a,,object.__getattribute__()}, entonces @code{__getattr__} es buscado en el módulo @code{__dict__} antes de lanzar una excepción @ref{441,,AttributeError}. Si es encontrado, es llamado con el nombre de atributo y el resultado es retornado.

The @code{__dir__} function should accept no arguments, and return an iterable of
strings that represents the names accessible on module. If present, this
function overrides the standard @ref{6d3,,dir()} search on a module.

Para una personalización más precisa sobre el comportamiento del módulo (estableciendo atributos, propiedades, etc.), se puede establecer el atributo @code{__class__} de un objeto de módulo a una subclase de @ref{e98,,types.ModuleType}. Por ejemplo:

@example
import sys
from types import ModuleType

class VerboseModule(ModuleType):
    def __repr__(self):
        return f'Verbose @{self.__name__@}'

    def __setattr__(self, attr, value):
        print(f'Setting @{attr@}...')
        super().__setattr__(attr, value)

sys.modules[__name__].__class__ = VerboseModule
@end example

@cartouche
@quotation Nota 
Definiendo un módulo @code{__getattr__} y estableciendo un módulo @code{__class__} solo afecta búsquedas que utilizan la sintaxis de acceso a atributo – acceder directamente a las globales del módulo (ya sea por código dentro del módulo, o a través de una referencia al diccionario de globales del módulo) no se ve afectado.
@end quotation
@end cartouche


Distinto en la versión 3.5: El atributo de módulo @code{__class__} es ahora escribible.



Added in version 3.7: Atributos de módulo @code{__getattr__} y @code{__dir__}.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} - Módulos __getattr__ y __dir__

Describe las funciones @code{__getattr__} y @code{__dir__} en módulos.
@end table


@node Implementando descriptores,Invocando descriptores,Personalizando acceso a atributos de módulo,Personalizando acceso a atributos
@anchor{reference/datamodel descriptors}@anchor{cd7}@anchor{reference/datamodel implementing-descriptors}@anchor{1f68}
@subsubsection Implementando descriptores


The following methods only apply when an instance of the class containing the
method (a so-called `descriptor' class) appears in an `owner' class (the
descriptor must be in either the owner’s class dictionary or in the class
dictionary for one of its parents).  In the examples below, «the attribute»
refers to the attribute whose name is the key of the property in the owner
class” @ref{5fe,,__dict__}.  The @ref{b18,,object} class itself does not
implement any of these protocols.

@geindex __get__() (método de object)
@anchor{reference/datamodel object __get__}@anchor{1527}
@deffn {Método} object.__get__ (self, instance, owner=None)

Es llamado para obtener el atributo de la clase propietaria (acceso a atributos de clase) o de una instancia de dicha clase (acceso a atributos de instancia). El argumento opcional `owner' es la clase propietaria, mientras que `instance' es la instancia a través de la cual el atributo fue accedido, o @code{None} cuando el atributo es accedido a través de `owner'.

Este método debe retornar el valor de atributo calculado o lanzar una excepción @ref{441,,AttributeError}.

@geindex Python Enhancement Proposals; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} especifica que @ref{1527,,__get__()} puede ser llamado con uno o dos argumentos. Los propios descriptores incorporados de Python soportan esta especificación; sin embargo, es probable que algunas herramientas de terceros tengan descriptores que requieran ambos argumentos. La propia implementación de @ref{c5a,,__getattribute__()} en Python siempre pasa ambos argumentos si son requeridos o no.
@end deffn

@geindex __set__() (método de object)
@anchor{reference/datamodel object __set__}@anchor{1f69}
@deffn {Método} object.__set__ (self, instance, value)

Es llamado para establecer el atributo en una instancia `instance' de la clase propietaria a un nuevo valor `value'.

Nota, agregar @ref{1f69,,__set__()} o @ref{15eb,,__delete__()} cambia el tipo de descriptor a un “descriptor de datos”. Ver @ref{1f6a,,Invocando descriptores} para más detalles.
@end deffn

@geindex __delete__() (método de object)
@anchor{reference/datamodel object __delete__}@anchor{15eb}
@deffn {Método} object.__delete__ (self, instance)

Es llamado para borrar el atributo en una instancia `instance' de la clase propietaria.
@end deffn

Instances of descriptors may also have the @code{__objclass__} attribute
present:

@geindex __objclass__ (atributo de object)
@anchor{reference/datamodel object __objclass__}@anchor{1f6b}
@deffn {Atributo} object.__objclass__

The attribute @code{__objclass__} is interpreted by the @ref{7e,,inspect} module
as specifying the class where this object was defined (setting this
appropriately can assist in runtime introspection of dynamic class attributes).
For callables, it may indicate that an instance of the given type (or a
subclass) is expected or required as the first positional argument (for example,
CPython sets this attribute for unbound methods that are implemented in C).
@end deffn

@node Invocando descriptores,__slots__<2>,Implementando descriptores,Personalizando acceso a atributos
@anchor{reference/datamodel descriptor-invocation}@anchor{1f6a}@anchor{reference/datamodel invoking-descriptors}@anchor{1f6c}
@subsubsection Invocando descriptores


En general, un descriptor es un atributo de objeto con «comportamiento vinculante», uno cuyo acceso al atributo ha sido anulado por métodos en el protocolo del descriptor: @ref{1527,,__get__()}, @ref{1f69,,__set__()} y @ref{15eb,,__delete__()}. Si alguno de esos métodos está definido para un objeto, se dice que es un descriptor.

El comportamiento por defecto para atributos de acceso es obtener (`get'), establecer (`set') o borrar (`delete') el atributo del diccionario del objeto. Por ejemplo, @code{a.x} tiene una cadena de búsqueda que comienza con @code{a.__dict__[‘x’]}, luego @code{type(a).__dict__[‘x’]}, y continúa por las clases base de @code{type(a)} excluyendo metaclases.

Sin embargo, si el valor buscado es un objeto definiendo uno de los métodos del descriptor, entonces Python puede anular el comportamiento por defecto e invocar al método del descriptor en su lugar. Dónde ocurre esto en la cadena de precedencia depende de qué métodos de descriptor fueron definidos y cómo son llamados.

El punto de inicio por invocación de descriptor es un enlace @code{a.x}. Cómo los argumentos son ensamblados dependen de @code{a}:


@table @asis

@item Llamado directo

El llamado más simple y menos común es cuando el código de usuario invoca directamente un método descriptor: @code{x.__get__(a)}.

@item Enlace de instancia

Al enlazar a una instancia de objeto, @code{a} es transformado en un llamado: @code{type(a).__dict__[‘x’].__get__(a, type(a))}.

@item Enlace de clase

Al enlazar a una clase, @code{A.x} es transformado en un llamado: @code{A.__dict__[‘x’].__get__(None, A)}.

@item Súper enlace

Una búsqueda punteada como @code{super(A, a).x} busca en @code{a.__class__.__mro__} una clase base @code{B} después de @code{A} y luego retorna @code{B.__dict__['x'].__get__(a, A)}. Si no es un descriptor, @code{x} se retorna sin cambios.
@end table

@c class Desc:
@c     def __get__(*args):
@c         return args
@c 
@c class B:
@c 
@c     x = Desc()
@c 
@c class A(B):
@c 
@c     x = 999
@c 
@c     def m(self):
@c         'Demonstrate these two descriptor invocations are equivalent'
@c         result1 = super(A, self).x
@c         result2 = B.__dict__['x'].__get__(self, A)
@c         return result1 == result2

@c >>> a = A()
@c >>> a.__class__.__mro__.index(B) > a.__class__.__mro__.index(A)
@c True
@c >>> super(A, a).x == B.__dict__['x'].__get__(a, A)
@c True
@c >>> a.m()
@c True

For instance bindings, the precedence of descriptor invocation depends on
which descriptor methods are defined.  A descriptor can define any combination
of @ref{1527,,__get__()}, @ref{1f69,,__set__()} and
@ref{15eb,,__delete__()}.  If it does not
define @code{__get__()}, then accessing the attribute will return the descriptor
object itself unless there is a value in the object’s instance dictionary.  If
the descriptor defines @code{__set__()} and/or @code{__delete__()}, it is a data
descriptor; if it defines neither, it is a non-data descriptor.  Normally, data
descriptors define both @code{__get__()} and @code{__set__()}, while non-data
descriptors have just the @code{__get__()} method.  Data descriptors with
@code{__get__()} and @code{__set__()} (and/or @code{__delete__()}) defined
always override a redefinition in an
instance dictionary.  In contrast, non-data descriptors can be overridden by
instances.

Los métodos de Python (incluidos los decorados con @ref{22e,,@@staticmethod} y @ref{2d2,,@@classmethod}) se implementan como descriptores sin datos. En consecuencia, las instancias pueden redefinir y anular métodos. Esto permite que las instancias individuales adquieran comportamientos que difieren de otras instancias de la misma clase.

La función @ref{2fd,,property()} es implementada como un descriptor de datos. Por lo tanto, las instancias no pueden anular el comportamiento de una propiedad.

@node __slots__<2>,,Invocando descriptores,Personalizando acceso a atributos
@anchor{reference/datamodel id13}@anchor{1f6d}@anchor{reference/datamodel slots}@anchor{1f31}
@subsubsection __slots__


`__slots__' nos permite declarar explícitamente miembros de datos (como propiedades) y denegar la creación de @ref{5fe,,__dict__} y `__weakref__' (a menos que se declare explícitamente en `__slots__' o esté disponible en un padre).

El espacio ahorrado al usar @ref{5fe,,__dict__} puede ser significativo. La velocidad de búsqueda de atributos también se puede mejorar significativamente.

@geindex object.__slots__ (variable incorporada)
@anchor{reference/datamodel object __slots__}@anchor{152a}
@deffn {Dato} object.__slots__

A esta variable de clase se le puede asignar una cadena, un iterable o una secuencia de cadenas con nombres de variables utilizados por las instancias. `__slots__' reserva espacio para las variables declaradas y evita la creación automática de @ref{5fe,,__dict__} y `__weakref__' para cada instancia.
@end deffn
@anchor{reference/datamodel datamodel-note-slots}@anchor{1f6e}
Notas sobre el uso de  `__slots__'


@itemize *

@item 
Al heredar de una clase sin `__slots__', los atributos @ref{5fe,,__dict__} y `__weakref__' de las instancias siempre estarán accesibles.

@item 
Sin una variable @ref{5fe,,__dict__}, a las instancias no se les pueden asignar nuevas variables que no figuran en la definición `__slots__'. Los intentos de asignar un nombre de variable no listado generan @ref{441,,AttributeError}. Si desea una asignación dinámica de nuevas variables, agregue @code{'__dict__'} a la secuencia de cadenas en la declaración `__slots__'.

@item 
Sin una variable `__weakref__' para cada instancia, las clases que definen `__slots__' no admiten @ref{114,,weak references} en sus instancias. Si se necesita soporte de referencia débil, agregue @code{'__weakref__'} a la secuencia de cadenas en la declaración `__slots__'.

@item 
`__slots__' se implementa a nivel de clase creando @ref{cd7,,descriptors} para cada nombre de variable. Como resultado, los atributos de clase no se pueden utilizar para establecer valores predeterminados, por ejemplo, variables definidas por `__slots__'; de lo contrario, el atributo de clase sobrescribiría la asignación del descriptor.

@item 
The action of a `__slots__' declaration is not limited to the class
where it is defined.  `__slots__' declared in parents are available in
child classes. However, instances of a child subclass will get a
@ref{5fe,,__dict__} and `__weakref__' unless the subclass also defines
`__slots__' (which should only contain names of any `additional' slots).

@item 
Si una clase define un espacio (`slot') también definido en una clase base, la variable de instancia definida por el espacio de la clase base es inaccesible (excepto al obtener su descriptor directamente de la clase base). Esto hace que el significado del programa sea indefinido. En el futuro se podría agregar una verificación para prevenir esto.

@item 
@ref{228,,TypeError} se generará si se definen `__slots__' no vacíos para una clase derivada de un @ref{1f6f,,"variable-length" built-in type} como @ref{1f0,,int}, @ref{325,,bytes} y @ref{464,,tuple}.

@item 
Cualquier @ref{1294,,iterable} que no sea una cadena se puede asignar a `__slots__'.

@item 
Si se utiliza un @ref{190,,dictionary} para asignar `__slots__', las claves del diccionario se utilizarán como nombres de ranura. Los valores del diccionario se pueden usar para proporcionar cadenas de documentos por atributo que @ref{a8c,,inspect.getdoc()} reconocerá y mostrará en la salida de @ref{96e,,help()}.

@item 
@ref{14e9,,__class__} assignment works only if both classes have the
same `__slots__'.

@item 
Se puede usar @ref{1cbf,,Multiple inheritance} con varias clases principales con ranuras, pero solo a una de las clases principales se le permite tener atributos creados por ranuras (las otras bases deben tener diseños de ranuras vacías); las infracciones generan @ref{228,,TypeError}.

@item 
Si se utiliza un @ref{313,,iterator} para `__slots__', entonces se crea un @ref{1f70,,descriptor} para cada uno de los valores del iterador. Sin embargo, el atributo `__slots__' será un iterador vacío.
@end itemize

@node Personalización de creación de clases,Personalizando revisiones de instancia y subclase,Personalizando acceso a atributos,Nombres especiales de método
@anchor{reference/datamodel class-customization}@anchor{cd3}@anchor{reference/datamodel customizing-class-creation}@anchor{1f71}
@subsubsection Personalización de creación de clases


Siempre que una clase hereda de otra clase, se llama a @ref{6d2,,__init_subclass__()} en la clase principal. De esta forma, es posible escribir clases que cambien el comportamiento de las subclases. Esto está estrechamente relacionado con los decoradores de clases, pero mientras los decoradores de clases solo afectan la clase específica a la que se aplican, @code{__init_subclass__} solo se aplica a futuras subclases de la clase que define el método.

@geindex __init_subclass__() (método de clase de object)
@anchor{reference/datamodel object __init_subclass__}@anchor{6d2}
@deffn {Método} classmethod object.__init_subclass__ (cls)

Este método es llamado siempre que la clase que lo contiene sea heredada. `cls' es entonces, la nueva subclase. Si se define como un método de instancia normal, éste es convertido de manera implícita a un método de clase.

Keyword arguments which are given to a new class are passed to
the parent class’s @code{__init_subclass__}. For compatibility with
other classes using @code{__init_subclass__}, one should take out the
needed keyword arguments and pass the others over to the base
class, as in:

@example
class Philosopher:
    def __init_subclass__(cls, /, default_name, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.default_name = default_name

class AustralianPhilosopher(Philosopher, default_name="Bruce"):
    pass
@end example

La implementación por defecto @code{object.__init_subclass__} no hace nada, pero lanza un error si es llamado con cualquier argumento.

@cartouche
@quotation Nota 
La sugerencia de metaclase @code{metaclass} es consumido por el resto de la maquinaria de tipos, y nunca se pasa a las implementaciones @code{__init_subclass__}. La clase meta actual (más que la sugerencia explícita) puede ser accedida como @code{type(cls)}.
@end quotation
@end cartouche


Added in version 3.6.

@end deffn

Cuando se crea una clase, @code{type.__new__()} escanea las variables de clase y realiza la retrollamada a aquellas con un enlace @ref{cd6,,__set_name__()}.

@geindex __set_name__() (método de object)
@anchor{reference/datamodel object __set_name__}@anchor{cd6}
@deffn {Método} object.__set_name__ (self, owner, name)

Llamado automáticamente al momento en el que se crea la clase propietaria `owner'. El objeto es asignado a `name' en esa clase:

@example
class A:
    x = C()  # Automatically calls: x.__set_name__(A, 'x')
@end example

Si la variable de clase se asigna después de crear la clase, @ref{cd6,,__set_name__()} no se llamará automáticamente. Si es necesario, @ref{cd6,,__set_name__()} se puede llamar directamente:

@example
class A:
   pass

c = C()
A.x = c                  # The hook is not called
c.__set_name__(A, 'x')   # Manually invoke the hook
@end example

Ver @ref{cd2,,Creando el objeto de clase} para más detalles.


Added in version 3.6.

@end deffn

@menu
* Metaclases:: 
* Resolviendo entradas de la Orden de Resolución de Métodos (MRU): Resolviendo entradas de la Orden de Resolución de Métodos MRU. 
* Determinando la metaclase adecuada:: 
* Preparando el espacio de nombres de la clase:: 
* Ejecutando el cuerpo de la clase:: 
* Creando el objeto de clase:: 
* Usos para metaclases:: 

@end menu

@node Metaclases,Resolviendo entradas de la Orden de Resolución de Métodos MRU,,Personalización de creación de clases
@anchor{reference/datamodel id14}@anchor{1f72}@anchor{reference/datamodel metaclasses}@anchor{1f73}
@subsubsection Metaclases


@geindex metaclases
@geindex Funciones incorporadas;Tipos
@geindex = (es igual a);definición de clase

Por defecto, las clases son construidas usando @ref{dcf,,type()}. El cuerpo de la clase es ejecutado en un nuevo espacio de nombres y el nombre de la clase es ligado de forma local al resultado de @code{type(name, bases, namespace)}.

El proceso de creación de clase puede ser personalizado pasando el argumento de palabra clave @code{metaclass} en la línea de definición de la clase, o al heredar de una clase existente que incluya dicho argumento. En el siguiente ejemplo, ambos @code{MyClass} y @code{MySubclass} son instancias de @code{Meta}:

@example
class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass
@end example

Cualquier otro argumento de palabra clave que sea especificado en la definición de clase es pasado mediante todas las operaciones de metaclase descritas a continuación.

Cuando una definición de clase es ejecutada, los siguientes pasos ocurren:


@itemize *

@item 
Entradas de la orden de resolución de método (MRU) son resueltas;

@item 
se determina la metaclase adecuada;

@item 
se prepara el espacio de nombres de clase;

@item 
se ejecuta el cuerpo de la clase;

@item 
se crea el objeto de clase.
@end itemize

@node Resolviendo entradas de la Orden de Resolución de Métodos MRU,Determinando la metaclase adecuada,Metaclases,Personalización de creación de clases
@anchor{reference/datamodel resolving-mro-entries}@anchor{1f74}
@subsubsection Resolviendo entradas de la Orden de Resolución de Métodos (MRU)


@geindex __mro_entries__() (método de object)
@anchor{reference/datamodel object __mro_entries__}@anchor{1f75}
@deffn {Método} object.__mro_entries__ (self, bases)

Si una base que aparece en una definición de clase no es una instancia de @ref{dcf,,type}, entonces se busca un método @code{__mro_entries__()} en la base. Si se encuentra un método @code{__mro_entries__()}, la base se sustituye por el resultado de una llamada a @code{__mro_entries__()} al crear la clase. El método se llama con la tupla de bases original pasada al parámetro `bases' y debe retornar una tupla de clases que se utilizará en lugar de la base. La tupla retornada puede estar vacía: en estos casos, se ignora la base original.
@end deffn


@subsubheading Ver también



@table @asis

@item @ref{c24,,types.resolve_bases()}

Resuelva dinámicamente bases que no sean instancias de @ref{dcf,,type}.

@item @ref{575,,types.get_original_bases()}

Recupera las «bases originales» de una clase antes de las modificaciones realizadas por @ref{1f75,,__mro_entries__()}.

@geindex Python Enhancement Proposals; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/}

Soporte principal para módulos de escritura y tipos genéricos.
@end table


@node Determinando la metaclase adecuada,Preparando el espacio de nombres de la clase,Resolviendo entradas de la Orden de Resolución de Métodos MRU,Personalización de creación de clases
@anchor{reference/datamodel determining-the-appropriate-metaclass}@anchor{1f76}
@subsubsection Determinando la metaclase adecuada


@geindex pista de metaclase

La metaclase adecuada para la definición de una clase es determinada de la siguiente manera:


@itemize *

@item 
si no se dan bases ni metaclases explícitas, entonces se utiliza @ref{dcf,,type()};

@item 
si se da una metaclase explícita y `no' es una instancia de @ref{dcf,,type()}, entonces se utiliza directamente como la metaclase;

@item 
si se da una instancia de @ref{dcf,,type()} como la metaclase explícita, o se definen bases, entonces se utiliza la metaclase más derivada.
@end itemize

La metaclase más derivada es elegida de la metaclase especificada explícitamente (si existe) y de la metaclase (p. ej. @code{type(cls)}) de todas las clases base especificadas.

@node Preparando el espacio de nombres de la clase,Ejecutando el cuerpo de la clase,Determinando la metaclase adecuada,Personalización de creación de clases
@anchor{reference/datamodel prepare}@anchor{ce6}@anchor{reference/datamodel preparing-the-class-namespace}@anchor{1f77}
@subsubsection Preparando el espacio de nombres de la clase


@geindex __prepare__ (método de metaclase)

Una vez que se ha identificado la metaclase adecuada, se prepara el espacio de nombres de la clase. Si la metaclase tiene un atributo @code{__prepare__}, se llama @code{namespace = metaclass.__prepare__(name, bases, **kwds)} (donde los argumentos de palabras clave adicionales, si los hay, provienen de la definición de clase). El método @code{__prepare__} debe implementarse como @ref{2d2,,classmethod}. El espacio de nombres retornado por @code{__prepare__} se pasa a @code{__new__}, pero cuando se crea el objeto de clase final, el espacio de nombres se copia en un nuevo @code{dict}.

Si la metaclase no tiene atributo @code{__prepare__}, entonces el espacio de nombres de clase es iniciado como un mapeo vacío ordenado.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclases en Python 3000

Introduce el enlace de espacio de nombres @code{__prepare__}
@end table


@node Ejecutando el cuerpo de la clase,Creando el objeto de clase,Preparando el espacio de nombres de la clase,Personalización de creación de clases
@anchor{reference/datamodel executing-the-class-body}@anchor{1f78}
@subsubsection Ejecutando el cuerpo de la clase


@geindex clase;cuerpo

El cuerpo de la clase es ejecutado como @code{exec(body, globals(), namespace)} (aproximadamente). La diferencia clave con un llamado normal a @ref{2ea,,exec()} es que el alcance léxico permite que el cuerpo de la clase (incluyendo cualquier método) haga referencia a nombres de los alcances actuales y externos cuando la definición de clase sucede dentro de la función.

Sin embargo, aún cuando la definición de clase sucede dentro de la función, los métodos definidos dentro de la clase aún no pueden ver nombres definidos dentro del alcance de la clase. Variables de clase deben ser accedidas a través del primer parámetro de instancia o métodos de clase, o a través de la referencia al léxico implícito @code{__class__} descrita en la siguiente sección.

@node Creando el objeto de clase,Usos para metaclases,Ejecutando el cuerpo de la clase,Personalización de creación de clases
@anchor{reference/datamodel class-object-creation}@anchor{cd2}@anchor{reference/datamodel creating-the-class-object}@anchor{1f79}
@subsubsection Creando el objeto de clase


@geindex __class__ (celda de método)
@geindex __classcell;__ (entrada de espacio de nombre de clase)

Una vez que el espacio de nombres de la clase ha sido poblado al ejecutar el cuerpo de la clase, el objeto de clase es creado al llamar @code{metaclass(name, bases, namespace, **kwds)} (las palabras clave adicionales que se pasan aquí, son las mismas que aquellas pasadas en @code{__prepare__}).

Este objeto de clase es el que será referenciado por la forma sin argumentos de @ref{155,,super()}. @code{__class__} es una referencia de cierre implícita creada por el compilador si cualquier método en el cuerpo de una clase se refiere tanto a @code{__class__} o @code{super}. Esto permite que la forma sin argumentos de @ref{155,,super()} identifique correctamente la clase definida en base al alcance léxico, mientras la clase o instancia que fue utilizada para hacer el llamado actual es identificado en base al primer argumento que se pasa al método.

`Detalles de implementación de CPython:' En CPython 3.6 y posterior, la celda @code{__class__} se pasa a la metaclase como una entrada @code{__classcell__} en el espacio de nombres de la clase. En caso de existir, esto debe ser propagado hacia el llamado @code{type.__new__} para que la clase se inicie correctamente. No hacerlo resultará en un error @ref{1e5,,RuntimeError} en Python 3.8.

Cuando se utiliza la metaclase por defecto @ref{dcf,,type}, o cualquier metaclase que finalmente llama a @code{type.__new__}, los siguientes pasos de personalización adicional son invocados después de crear el objeto de clase:


@enumerate 

@item 
El método @code{type.__new__} recolecta todos los atributos en el espacio de nombres de la clase que definen un método @ref{cd6,,__set_name__()};

@item 
Esos métodos @code{__set_name__} son llamados con la clase siendo definida y el nombre de ese atributo particular asignado;

@item 
El gancho @ref{6d2,,__init_subclass__()} llama al padre inmediato de la nueva clase en su orden de resolución del método.
@end enumerate

Después de que el objeto de clase es creado, se pasa al decorador de clase incluido en su definición (si existe) y el objeto resultante es enlazado en el espacio de nombres local como la clase definida.

When a new class is created by @code{type.__new__}, the object provided as the
namespace parameter is copied to a new ordered mapping and the original
object is discarded. The new copy is wrapped in a read-only proxy, which
becomes the @ref{ce5,,__dict__} attribute of the class object.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3135

@item PEP 3135@footnote{https://peps.python.org/pep-3135/} - Nuevo súper

Describe la referencia de cierre implícita @code{__class__}
@end table


@node Usos para metaclases,,Creando el objeto de clase,Personalización de creación de clases
@anchor{reference/datamodel uses-for-metaclasses}@anchor{1f7a}
@subsubsection Usos para metaclases


Los usos potenciales para metaclases son ilimitados. Algunas ideas que ya han sido exploradas incluyen enumeración, registros, revisión de interface, delegación automática, creación de propiedades automática, proxy, infraestructuras, y bloqueo/sincronización automática de recursos.

@node Personalizando revisiones de instancia y subclase,Emulando tipos genéricos,Personalización de creación de clases,Nombres especiales de método
@anchor{reference/datamodel customizing-instance-and-subclass-checks}@anchor{1f7b}
@subsubsection Personalizando revisiones de instancia y subclase


Los siguientes métodos son utilizados para anular el comportamiento por defecto de las funciones incorporadas @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}.

En particular, la metaclase @ref{f9b,,abc.ABCMeta} implementa estos métodos para permitir la adición de Clases Base Abstractas (ABCs, por su nombre en inglés `Abstract Base Clases') como “clases base virtuales” a cualquier clase o tipo (incluyendo tipos incorporados), incluyendo otros ABCs.

@geindex __instancecheck__() (método de type)
@anchor{reference/datamodel type __instancecheck__}@anchor{1f7c}
@deffn {Método} type.__instancecheck__ (self, instance)

Retorna `true' si la instancia `instance' debe ser considerada una instancia (directa o indirecta) de clase `class'. De ser definida, es llamado para implementar @code{isinstance(instance, class)}.
@end deffn

@geindex __subclasscheck__() (método de type)
@anchor{reference/datamodel type __subclasscheck__}@anchor{1f7d}
@deffn {Método} type.__subclasscheck__ (self, subclass)

Retorna `true' si la subclase `subclass' debe ser considerada una subclase (directa o indirecta) de clase `class'. De ser definida, es llamado para implementar @code{issubclass(subclass, class)}.
@end deffn

Tome en cuenta que estos métodos son buscados en el tipo (metaclase) de una clase. No pueden ser definidos como métodos de clase en la clase actual. Esto es consistente con la búsqueda de métodos especiales que son llamados en instancias, solo en este caso la instancia es por sí misma una clase.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - Introducción a Clases Base Abstractas (`Abstract Base Classes')

Includes the specification for customizing @ref{4ef,,isinstance()} and
@ref{85a,,issubclass()} behavior through @ref{1f7c,,__instancecheck__()} and
@ref{1f7d,,__subclasscheck__()}, with motivation for this functionality
in the context of adding Abstract Base Classes (see the @ref{4,,abc}
module) to the language.
@end table


@node Emulando tipos genéricos,Emulando objetos que se pueden llamar,Personalizando revisiones de instancia y subclase,Nombres especiales de método
@anchor{reference/datamodel emulating-generic-types}@anchor{1f7e}
@subsubsection Emulando tipos genéricos


Cuando se usa @ref{140,,type annotations}, a menudo es útil `parameterize' a @ref{157,,generic type} usando la notación de corchetes de Python. Por ejemplo, la anotación @code{list[int]} podría usarse para indicar un @ref{18e,,list} en el que todos los elementos son del tipo @ref{1f0,,int}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Sugerencias de tipo

Presentamos el marco de trabajo de Python para las anotaciones de tipo

@item @ref{753,,Generic Alias Types}

Documentación para objetos que representan clases genéricas parametrizadas

@item @ref{1f7f,,Genéricos}, @ref{576,,user-defined generics} y @ref{15f6,,typing.Generic}

Documentación sobre cómo implementar clases genéricas que se pueden parametrizar en tiempo de ejecución y que los verificadores de tipos estáticos pueden entender.
@end table


Una clase `generally' solo se puede parametrizar si define el método de clase especial @code{__class_getitem__()}.

@geindex __class_getitem__() (método de clase de object)
@anchor{reference/datamodel object __class_getitem__}@anchor{7d6}
@deffn {Método} classmethod object.__class_getitem__ (cls, key)

Retornar un objeto representando la especialización de una clase genérica por argumentos de tipo encontrados en `key'.

Cuando se define en una clase, @code{__class_getitem__()} es automáticamente un método de clase. Como tal, no es necesario decorarlo con @ref{2d2,,@@classmethod} cuando se define.
@end deffn

@menu
* El propósito de __class_getitem__:: 
* __class_getitem__ frente a __getitem__:: 

@end menu

@node El propósito de __class_getitem__,__class_getitem__ frente a __getitem__,,Emulando tipos genéricos
@anchor{reference/datamodel the-purpose-of-class-getitem}@anchor{1f80}
@subsubsection El propósito de `__class_getitem__'


El propósito de @ref{7d6,,__class_getitem__()} es permitir la parametrización en tiempo de ejecución de clases genéricas de biblioteca estándar para aplicar @ref{1f81,,type hints} a estas clases con mayor facilidad.

Para implementar clases genéricas personalizadas que se puedan parametrizar en tiempo de ejecución y que los verificadores de tipos estáticos las entiendan, los usuarios deben heredar de una clase de biblioteca estándar que ya implementa @ref{7d6,,__class_getitem__()}, o heredar de @ref{15f6,,typing.Generic}, que tiene su propia implementación de @code{__class_getitem__()}.

Es posible que los verificadores de tipos de terceros, como mypy, no entiendan las implementaciones personalizadas de @ref{7d6,,__class_getitem__()} en clases definidas fuera de la biblioteca estándar. Se desaconseja el uso de @code{__class_getitem__()} en cualquier clase para fines distintos a la sugerencia de tipo.

@node __class_getitem__ frente a __getitem__,,El propósito de __class_getitem__,Emulando tipos genéricos
@anchor{reference/datamodel class-getitem-versus-getitem}@anchor{1f82}@anchor{reference/datamodel classgetitem-versus-getitem}@anchor{1f83}
@subsubsection `__class_getitem__' frente a `__getitem__'


Por lo general, el @ref{1f84,,subscription} de un objeto que usa corchetes llamará al método de instancia @ref{3d8,,__getitem__()} definido en la clase del objeto. Sin embargo, si el objeto que se suscribe es en sí mismo una clase, se puede llamar al método de clase @ref{7d6,,__class_getitem__()} en su lugar. @code{__class_getitem__()} debería retornar un objeto @ref{753,,GenericAlias} si está definido correctamente.

Presentado con el @ref{1f85,,expression} @code{obj[x]}, el intérprete de Python sigue un proceso similar al siguiente para decidir si se debe llamar a @ref{3d8,,__getitem__()} o @ref{7d6,,__class_getitem__()}:

@example
from inspect import isclass

def subscribe(obj, x):
    """Return the result of the expression 'obj[x]'"""

    class_of_obj = type(obj)

    # If the class of obj defines __getitem__,
    # call class_of_obj.__getitem__(obj, x)
    if hasattr(class_of_obj, '__getitem__'):
        return class_of_obj.__getitem__(obj, x)

    # Else, if obj is a class and defines __class_getitem__,
    # call obj.__class_getitem__(x)
    elif isclass(obj) and hasattr(obj, '__class_getitem__'):
        return obj.__class_getitem__(x)

    # Else, raise an exception
    else:
        raise TypeError(
            f"'@{class_of_obj.__name__@}' object is not subscriptable"
        )
@end example

En Python, todas las clases son en sí mismas instancias de otras clases. La clase de una clase se conoce como @ref{1f86,,metaclass} de esa clase, y la mayoría de las clases tienen la clase @ref{dcf,,type} como su metaclase. @ref{dcf,,type} no define @ref{3d8,,__getitem__()}, lo que significa que expresiones como @code{list[int]}, @code{dict[str, float]} y @code{tuple[str, bytes]} dan como resultado que se llame a @ref{7d6,,__class_getitem__()}:

@example
>>> # list has class "type" as its metaclass, like most classes:
>>> type(list)
<class 'type'>
>>> type(dict) == type(list) == type(tuple) == type(str) == type(bytes)
True
>>> # "list[int]" calls "list.__class_getitem__(int)"
>>> list[int]
list[int]
>>> # list.__class_getitem__ returns a GenericAlias object:
>>> type(list[int])
<class 'types.GenericAlias'>
@end example

Sin embargo, si una clase tiene una metaclase personalizada que define @ref{3d8,,__getitem__()}, la suscripción de la clase puede generar un comportamiento diferente. Un ejemplo de esto se puede encontrar en el módulo @ref{56,,enum}:

@example
>>> from enum import Enum
>>> class Menu(Enum):
...     """A breakfast menu"""
...     SPAM = 'spam'
...     BACON = 'bacon'
...
>>> # Enum classes have a custom metaclass:
>>> type(Menu)
<class 'enum.EnumMeta'>
>>> # EnumMeta defines __getitem__,
>>> # so __class_getitem__ is not called,
>>> # and the result is not a GenericAlias object:
>>> Menu['SPAM']
<Menu.SPAM: 'spam'>
>>> type(Menu['SPAM'])
<enum 'Menu'>
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/}: soporte principal para módulo de escritura y tipos genéricos

Presentamos @ref{7d6,,__class_getitem__()} y describimos cuándo un @ref{1f84,,subscription} da como resultado que se llame a @code{__class_getitem__()} en lugar de @ref{3d8,,__getitem__()}
@end table


@node Emulando objetos que se pueden llamar,Emulando tipos de contenedores,Emulando tipos genéricos,Nombres especiales de método
@anchor{reference/datamodel emulating-callable-objects}@anchor{1f87}@anchor{reference/datamodel id15}@anchor{1f88}
@subsubsection Emulando objetos que se pueden llamar


@geindex __call__() (método de object)
@anchor{reference/datamodel object __call__}@anchor{5fb}
@deffn {Método} object.__call__ (self[, args...])

@geindex llamada;instancia

Called when the instance is «called» as a function; if this method is defined,
@code{x(arg1, arg2, ...)} roughly translates to @code{type(x).__call__(x, arg1, ...)}.
The @ref{b18,,object} class itself does not provide this method.
@end deffn

@node Emulando tipos de contenedores,Emulando tipos numéricos,Emulando objetos que se pueden llamar,Nombres especiales de método
@anchor{reference/datamodel emulating-container-types}@anchor{1f89}@anchor{reference/datamodel sequence-types}@anchor{1f8a}
@subsubsection Emulando tipos de contenedores


The following methods can be defined to implement container objects. None of them
are provided by the @ref{b18,,object} class itself. Containers usually are
@ref{597,,sequences} (such as @ref{18e,,lists} or
@ref{464,,tuples}) or @ref{1229,,mappings} (like
@ref{1f8b,,dictionaries}),
but can represent other containers as well.  The first set of methods is used
either to emulate a sequence or to emulate a mapping; the difference is that for
a sequence, the allowable keys should be the integers `k' for which @code{0 <= k <
N} where `N' is the length of the sequence, or @ref{514,,slice} objects, which define a
range of items.  It is also recommended that mappings provide the methods
@code{keys()}, @code{values()}, @code{items()}, @code{get()}, @code{clear()},
@code{setdefault()}, @code{pop()}, @code{popitem()}, @code{copy()}, and
@code{update()} behaving similar to those for Python’s standard @ref{190,,dictionary}
objects.  The @ref{1f,,collections.abc} module provides a
@ref{1123,,MutableMapping}
@ref{1224,,abstract base class} to help create those methods from a base set of
@ref{3d8,,__getitem__()}, @ref{1505,,__setitem__()},
@ref{1506,,__delitem__()}, and @code{keys()}.
Mutable sequences should provide methods @code{append()}, @code{count()},
@code{index()}, @code{extend()}, @code{insert()}, @code{pop()}, @code{remove()},
@code{reverse()} and @code{sort()}, like Python standard @ref{18e,,list}
objects. Finally,
sequence types should implement addition (meaning concatenation) and
multiplication (meaning repetition) by defining the methods
@ref{1f8c,,__add__()}, @ref{1f8d,,__radd__()}, @ref{1f8e,,__iadd__()},
@ref{1f8f,,__mul__()}, @ref{1f90,,__rmul__()} and @ref{1f91,,__imul__()}
described below; they should not define other numerical
operators.  It is recommended that both mappings and sequences implement the
@ref{1f5d,,__contains__()} method to allow efficient use of the @code{in}
operator; for
mappings, @code{in} should search the mapping’s keys; for sequences, it should
search through the values.  It is further recommended that both mappings and
sequences implement the @ref{1f5b,,__iter__()} method to allow efficient iteration
through the container; for mappings, @code{__iter__()} should iterate
through the object’s keys; for sequences, it should iterate through the values.

@geindex __len__() (método de object)
@anchor{reference/datamodel object __len__}@anchor{1f62}
@deffn {Método} object.__len__ (self)

@geindex Funciones incorporadas;len
@geindex __bool__() (método objeto)

Llamado para implementar la función incorporada @ref{6cf,,len()}. Debería retornar la longitud del objeto, un número entero @code{>=} 0. Además, un objeto que no define un método @ref{133d,,__bool__()} y cuyo método @code{__len__()} retorna cero se considera falso en un contexto booleano.

`Detalles de implementación de CPython:' En CPython, se requiere que la longitud sea como máximo @ref{1232,,sys.maxsize}. Si la longitud es mayor que @code{sys.maxsize}, algunas funciones (como @ref{6cf,,len()}) pueden generar @ref{919,,OverflowError}. Para evitar que se genere @code{OverflowError} mediante pruebas de valor de verdad, un objeto debe definir un método @ref{133d,,__bool__()}.
@end deffn

@geindex __length_hint__() (método de object)
@anchor{reference/datamodel object __length_hint__}@anchor{f8e}
@deffn {Método} object.__length_hint__ (self)

Called to implement @ref{fec,,operator.length_hint()}. Should return an estimated
length for the object (which may be greater or less than the actual length).
The length must be an integer @code{>=} 0. The return value may also be
@ref{227,,NotImplemented}, which is treated the same as if the
@code{__length_hint__} method didn’t exist at all. This method is purely an
optimization and is never required for correctness.


Added in version 3.4.

@end deffn

@geindex Objetos;slice

@cartouche
@quotation Nota 
La segmentación se hace exclusivamente con los siguientes tres métodos. Un llamado como

@example
a[1:2] = b
@end example

es traducido a

@example
a[slice(1, 2, None)] = b
@end example

etcétera. Elementos faltantes de segmentos siempre son llenados con @code{None}.
@end quotation
@end cartouche

@geindex __getitem__() (método de object)
@anchor{reference/datamodel object __getitem__}@anchor{3d8}
@deffn {Método} object.__getitem__ (self, key)

Called to implement evaluation of @code{self[key]}. For @ref{597,,sequence} types,
the accepted keys should be integers. Optionally, they may support
@ref{514,,slice} objects as well.  Negative index support is also optional.
If `key' is
of an inappropriate type, @ref{228,,TypeError} may be raised; if `key' is a value
outside the set of indexes for the sequence (after any special
interpretation of negative values), @ref{1575,,IndexError} should be raised. For
@ref{1229,,mapping} types, if `key' is missing (not in the container),
@ref{438,,KeyError} should be raised.

@cartouche
@quotation Nota 
ciclos @ref{1eb,,for} esperan que una excepción @ref{1575,,IndexError} sea lanzada para que índices ilegales permitan la detección adecuada del fin de una secuencia.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Cuando @ref{1f84,,subscripting} a `class', se puede llamar al método de clase especial @ref{7d6,,__class_getitem__()} en lugar de @code{__getitem__()}. Ver @ref{1f83,,__class_getitem__ frente a __getitem__} para más detalles.
@end quotation
@end cartouche
@end deffn

@geindex __setitem__() (método de object)
@anchor{reference/datamodel object __setitem__}@anchor{1505}
@deffn {Método} object.__setitem__ (self, key, value)

Es llamado para implementar la asignación a @code{self[key]}. Lo mismo con respecto a @ref{3d8,,__getitem__()}. Esto solo debe ser implementado para mapeos si los objetos permiten cambios a los valores de las llaves, o si nuevas llaves pueden ser añadidas, o para secuencias si los elementos pueden ser reemplazados. Las mismas excepciones deben ser lanzadas para valores de `key' inadecuados con respecto al método @ref{3d8,,__getitem__()}.
@end deffn

@geindex __delitem__() (método de object)
@anchor{reference/datamodel object __delitem__}@anchor{1506}
@deffn {Método} object.__delitem__ (self, key)

Es llamado para implementar el borrado de @code{self[key]}. Lo mismo con respecto a @ref{3d8,,__getitem__()}. Esto solo debe ser implementado para mapeos si los objetos permiten el borrado de llaves, o para secuencias si los elementos pueden ser eliminados de la secuencia. Las mismas excepciones deben ser lanzadas por valores de `key' inapropiados con respecto al método @ref{3d8,,__getitem__()}.
@end deffn

@geindex __missing__() (método de object)
@anchor{reference/datamodel object __missing__}@anchor{1f92}
@deffn {Método} object.__missing__ (self, key)

Es llamado por @ref{190,,dict}.@ref{3d8,,__getitem__()} para implementar @code{self[key]} para subclases de diccionarios cuando la llave no se encuentra en el diccionario.
@end deffn

@geindex __iter__() (método de object)
@anchor{reference/datamodel object __iter__}@anchor{1f5b}
@deffn {Método} object.__iter__ (self)

Se llama a este método cuando se requiere un @ref{313,,iterator} para un contenedor. Este método debería retornar un nuevo objeto iterador que pueda iterar sobre todos los objetos del contenedor. Para las asignaciones, debe iterar sobre las claves del contenedor.
@end deffn

@geindex __reversed__() (método de object)
@anchor{reference/datamodel object __reversed__}@anchor{1f5c}
@deffn {Método} object.__reversed__ (self)

Es llamado (si existe) por la función incorporada @ref{8fc,,reversed()} para implementar una interacción invertida. Debe retornar un nuevo objeto iterador que itere sobre todos los objetos en el contenedor en orden inverso.

Si el método @ref{1f5c,,__reversed__()} no es proporcionado, la función incorporada @ref{8fc,,reversed()} recurrirá a utilizar el protocolo de secuencia (@ref{1f62,,__len__()} y @ref{3d8,,__getitem__()}). Objetos que permiten el protocolo de secuencia deben únicamente proporcionar @ref{1f5c,,__reversed__()} si no pueden proporcionar una implementación que sea más eficiente que la proporcionada por @ref{8fc,,reversed()}.
@end deffn

Los operadores de prueba de pertenencia (@ref{1ed,,in} and @ref{6d0,,not in}) son normalmente implementados como una iteración sobre un contenedor. Sin embargo, los objetos de contenedor pueden proveer el siguiente método especial con una implementación más eficiente, que tampoco requiere que el objeto sea iterable.

@geindex __contains__() (método de object)
@anchor{reference/datamodel object __contains__}@anchor{1f5d}
@deffn {Método} object.__contains__ (self, item)

Es llamado para implementar operadores de prueba de pertenencia. Deben retornar `true' si `item' se encuentra en `self', de lo contrario `false'. Para objetos de mapeo, estos debe considerar las llaves del mapeo en lugar de los valores o los pares de llave-valor.

Para objetos que no definen @ref{1f5d,,__contains__()}, la prueba de pertenencia primero intenta la iteración a través de @ref{1f5b,,__iter__()}, y luego el antiguo protocolo de iteración de secuencia a través de @ref{3d8,,__getitem__()}, ver @ref{1f93,,esta sección en la referencia del lenguaje}.
@end deffn

@node Emulando tipos numéricos,Gestores de Contexto en la Declaración with,Emulando tipos de contenedores,Nombres especiales de método
@anchor{reference/datamodel emulating-numeric-types}@anchor{1f94}@anchor{reference/datamodel numeric-types}@anchor{1f95}
@subsubsection Emulando tipos numéricos


Los siguientes métodos pueden ser definidos para emular objetos numéricos. Métodos que corresponden a operaciones que no son permitidas por el número particular implementado (por ejemplo, operaciones bit a bit para números no enteros) se deben dejar sin definir.

@geindex __add__() (método de object)
@geindex __sub__() (método de object)
@geindex __mul__() (método de object)
@geindex __matmul__() (método de object)
@geindex __truediv__() (método de object)
@geindex __floordiv__() (método de object)
@geindex __mod__() (método de object)
@geindex __divmod__() (método de object)
@geindex __pow__() (método de object)
@geindex __lshift__() (método de object)
@geindex __rshift__() (método de object)
@geindex __and__() (método de object)
@geindex __xor__() (método de object)
@geindex __or__() (método de object)
@anchor{reference/datamodel object __add__}@anchor{1f8c}
@deffn {Método} object.__add__ (self, other)
@anchor{reference/datamodel object __sub__}@anchor{1f96}
@deffnx {Método} object.__sub__ (self, other)
@anchor{reference/datamodel object __mul__}@anchor{1f8f}
@deffnx {Método} object.__mul__ (self, other)
@anchor{reference/datamodel object __matmul__}@anchor{1f97}
@deffnx {Método} object.__matmul__ (self, other)
@anchor{reference/datamodel object __truediv__}@anchor{1533}
@deffnx {Método} object.__truediv__ (self, other)
@anchor{reference/datamodel object __floordiv__}@anchor{1534}
@deffnx {Método} object.__floordiv__ (self, other)
@anchor{reference/datamodel object __mod__}@anchor{1f98}
@deffnx {Método} object.__mod__ (self, other)
@anchor{reference/datamodel object __divmod__}@anchor{1f99}
@deffnx {Método} object.__divmod__ (self, other)
@anchor{reference/datamodel object __pow__}@anchor{86a}
@deffnx {Método} object.__pow__ (self, other[, modulo])
@anchor{reference/datamodel object __lshift__}@anchor{1f9a}
@deffnx {Método} object.__lshift__ (self, other)
@anchor{reference/datamodel object __rshift__}@anchor{1f9b}
@deffnx {Método} object.__rshift__ (self, other)
@anchor{reference/datamodel object __and__}@anchor{1f9c}
@deffnx {Método} object.__and__ (self, other)
@anchor{reference/datamodel object __xor__}@anchor{1f9d}
@deffnx {Método} object.__xor__ (self, other)
@anchor{reference/datamodel object __or__}@anchor{1f9e}
@deffnx {Método} object.__or__ (self, other)

@geindex Funciones incorporadas;divmod
@geindex Funciones incorporadas;pow
@geindex Funciones incorporadas;pow

Estos métodos se llaman para implementar las operaciones aritméticas binarias (@code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{a33,,divmod()}, @ref{a64,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}). Por ejemplo, para evaluar la expresión @code{x + y}, donde `x' es una instancia de una clase que tiene un método @ref{1f8c,,__add__()}, se llama a @code{type(x).__add__(x, y)}. El método @ref{1f99,,__divmod__()} debería ser equivalente al uso de @ref{1534,,__floordiv__()} y @ref{1f98,,__mod__()}; no debería estar relacionado con @ref{1533,,__truediv__()}. Tenga en cuenta que @ref{86a,,__pow__()} debe definirse para aceptar un tercer argumento opcional si se va a admitir la versión ternaria de la función incorporada @ref{a64,,pow()}.

If one of those methods does not support the operation with the supplied
arguments, it should return @ref{227,,NotImplemented}.
@end deffn

@geindex __radd__() (método de object)
@geindex __rsub__() (método de object)
@geindex __rmul__() (método de object)
@geindex __rmatmul__() (método de object)
@geindex __rtruediv__() (método de object)
@geindex __rfloordiv__() (método de object)
@geindex __rmod__() (método de object)
@geindex __rdivmod__() (método de object)
@geindex __rpow__() (método de object)
@geindex __rlshift__() (método de object)
@geindex __rrshift__() (método de object)
@geindex __rand__() (método de object)
@geindex __rxor__() (método de object)
@geindex __ror__() (método de object)
@anchor{reference/datamodel object __radd__}@anchor{1f8d}
@deffn {Método} object.__radd__ (self, other)
@anchor{reference/datamodel object __rsub__}@anchor{1f9f}
@deffnx {Método} object.__rsub__ (self, other)
@anchor{reference/datamodel object __rmul__}@anchor{1f90}
@deffnx {Método} object.__rmul__ (self, other)
@anchor{reference/datamodel object __rmatmul__}@anchor{1fa0}
@deffnx {Método} object.__rmatmul__ (self, other)
@anchor{reference/datamodel object __rtruediv__}@anchor{1fa1}
@deffnx {Método} object.__rtruediv__ (self, other)
@anchor{reference/datamodel object __rfloordiv__}@anchor{1fa2}
@deffnx {Método} object.__rfloordiv__ (self, other)
@anchor{reference/datamodel object __rmod__}@anchor{1fa3}
@deffnx {Método} object.__rmod__ (self, other)
@anchor{reference/datamodel object __rdivmod__}@anchor{1fa4}
@deffnx {Método} object.__rdivmod__ (self, other)
@anchor{reference/datamodel object __rpow__}@anchor{86b}
@deffnx {Método} object.__rpow__ (self, other[, modulo])
@anchor{reference/datamodel object __rlshift__}@anchor{1fa5}
@deffnx {Método} object.__rlshift__ (self, other)
@anchor{reference/datamodel object __rrshift__}@anchor{1fa6}
@deffnx {Método} object.__rrshift__ (self, other)
@anchor{reference/datamodel object __rand__}@anchor{1fa7}
@deffnx {Método} object.__rand__ (self, other)
@anchor{reference/datamodel object __rxor__}@anchor{1fa8}
@deffnx {Método} object.__rxor__ (self, other)
@anchor{reference/datamodel object __ror__}@anchor{1fa9}
@deffnx {Método} object.__ror__ (self, other)

@geindex Funciones incorporadas;divmod
@geindex Funciones incorporadas;pow

These methods are called to implement the binary arithmetic operations
(@code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{a33,,divmod()},
@ref{a64,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}) with reflected
(swapped) operands.  These functions are only called if the operands
are of different types, when the left operand does not support the corresponding
operation @footnote{
«Does not support» here means that the class has no such method, or
the method returns @ref{227,,NotImplemented}.  Do not set the method to
@code{None} if you want to force fallback to the right operand’s reflected
method—that will instead have the opposite effect of explicitly
`blocking' such fallback.
}, or the right operand’s class is derived from the left operand’s
class. @footnote{
For operands of the same type, it is assumed that if the non-reflected method
(such as @ref{1f8c,,__add__()}) fails then the operation is not supported, which is why the
reflected method is not called.
} For instance, to evaluate the expression @code{x - y}, where `y' is
an instance of a class that has an @ref{1f9f,,__rsub__()} method, @code{type(y).__rsub__(y, x)}
is called if @code{type(x).__sub__(x, y)} returns @ref{227,,NotImplemented} or @code{type(y)}
is a subclass of @code{type(x)}. @footnote{
If the right operand’s type is a subclass of the left operand’s type, the
reflected method having precedence allows subclasses to override their ancestors”
operations.
}

@geindex Funciones incorporadas;pow

Se debe tomar en cuenta que la función ternaria @ref{a64,,pow()} no intentará llamar a @ref{86b,,__rpow__()} (las reglas de coerción se volverían demasiado complicadas).

@cartouche
@quotation Nota 
Si el tipo del operando de la derecha es una subclase del tipo del operando de la izquierda y esa subclase proporciona el método reflejado para la operación, este método será llamado antes del método no reflejado del operando izquierdo. Este comportamiento permite que las subclases anulen las operaciones de sus predecesores.
@end quotation
@end cartouche
@end deffn

@geindex __iadd__() (método de object)
@geindex __isub__() (método de object)
@geindex __imul__() (método de object)
@geindex __imatmul__() (método de object)
@geindex __itruediv__() (método de object)
@geindex __ifloordiv__() (método de object)
@geindex __imod__() (método de object)
@geindex __ipow__() (método de object)
@geindex __ilshift__() (método de object)
@geindex __irshift__() (método de object)
@geindex __iand__() (método de object)
@geindex __ixor__() (método de object)
@geindex __ior__() (método de object)
@anchor{reference/datamodel object __iadd__}@anchor{1f8e}
@deffn {Método} object.__iadd__ (self, other)
@anchor{reference/datamodel object __isub__}@anchor{1faa}
@deffnx {Método} object.__isub__ (self, other)
@anchor{reference/datamodel object __imul__}@anchor{1f91}
@deffnx {Método} object.__imul__ (self, other)
@anchor{reference/datamodel object __imatmul__}@anchor{1fab}
@deffnx {Método} object.__imatmul__ (self, other)
@anchor{reference/datamodel object __itruediv__}@anchor{1fac}
@deffnx {Método} object.__itruediv__ (self, other)
@anchor{reference/datamodel object __ifloordiv__}@anchor{1fad}
@deffnx {Método} object.__ifloordiv__ (self, other)
@anchor{reference/datamodel object __imod__}@anchor{1fae}
@deffnx {Método} object.__imod__ (self, other)
@anchor{reference/datamodel object __ipow__}@anchor{869}
@deffnx {Método} object.__ipow__ (self, other[, modulo])
@anchor{reference/datamodel object __ilshift__}@anchor{1faf}
@deffnx {Método} object.__ilshift__ (self, other)
@anchor{reference/datamodel object __irshift__}@anchor{1fb0}
@deffnx {Método} object.__irshift__ (self, other)
@anchor{reference/datamodel object __iand__}@anchor{1fb1}
@deffnx {Método} object.__iand__ (self, other)
@anchor{reference/datamodel object __ixor__}@anchor{1fb2}
@deffnx {Método} object.__ixor__ (self, other)
@anchor{reference/datamodel object __ior__}@anchor{1fb3}
@deffnx {Método} object.__ior__ (self, other)

These methods are called to implement the augmented arithmetic assignments
(@code{+=}, @code{-=}, @code{*=}, @code{@@=}, @code{/=}, @code{//=}, @code{%=}, @code{**=}, @code{<<=},
@code{>>=}, @code{&=}, @code{^=}, @code{|=}).  These methods should attempt to do the
operation in-place (modifying `self') and return the result (which could be,
but does not have to be, `self').  If a specific method is not defined, or if
that method returns @ref{227,,NotImplemented}, the
augmented assignment falls back to the normal methods.  For instance, if `x'
is an instance of a class with an @ref{1f8e,,__iadd__()} method, @code{x += y} is
equivalent to @code{x = x.__iadd__(y)} . If @ref{1f8e,,__iadd__()} does not exist, or if @code{x.__iadd__(y)}
returns @code{NotImplemented}, @code{x.__add__(y)} and
@code{y.__radd__(x)} are considered, as with the evaluation of @code{x + y}. In
certain situations, augmented assignment can result in unexpected errors (see
@ref{1fb4,,¿Por qué hacer lo siguiente@comma{} a_tuple[i] += ['item']@comma{} lanza una excepción cuando la suma funciona?}), but this behavior is in fact
part of the data model.
@end deffn

@geindex __neg__() (método de object)
@geindex __pos__() (método de object)
@geindex __abs__() (método de object)
@geindex __invert__() (método de object)
@anchor{reference/datamodel object __neg__}@anchor{1fb5}
@deffn {Método} object.__neg__ (self)
@anchor{reference/datamodel object __pos__}@anchor{1fb6}
@deffnx {Método} object.__pos__ (self)
@anchor{reference/datamodel object __abs__}@anchor{1fb7}
@deffnx {Método} object.__abs__ (self)
@anchor{reference/datamodel object __invert__}@anchor{1fb8}
@deffnx {Método} object.__invert__ (self)

@geindex Funciones incorporadas;abs

Es llamado para implementar las operaciones aritméticas unarias (@code{-}, @code{+}, @ref{1cab,,abs()} and @code{~}).
@end deffn

@geindex __complex__() (método de object)
@geindex __int__() (método de object)
@geindex __float__() (método de object)
@anchor{reference/datamodel object __complex__}@anchor{687}
@deffn {Método} object.__complex__ (self)
@anchor{reference/datamodel object __int__}@anchor{22a}
@deffnx {Método} object.__int__ (self)
@anchor{reference/datamodel object __float__}@anchor{a5e}
@deffnx {Método} object.__float__ (self)

@geindex Funciones incorporadas;complejo
@geindex Funciones incorporadas;int
@geindex Funciones incorporadas;float

Es llamado para implementar las funciones incorporadas @ref{154,,complex()}, @ref{1f0,,int()} y @ref{153,,float()}. Debe retornar un valor del tipo apropiado.
@end deffn

@geindex __index__() (método de object)
@anchor{reference/datamodel object __index__}@anchor{22b}
@deffn {Método} object.__index__ (self)

Es llamado para implementar @ref{1917,,operator.index()}, y cuando sea que Python necesite convertir sin pérdidas el objeto numérico a un objeto entero (tal como en la segmentación o `slicing', o las funciones incorporadas @ref{1314,,bin()}, @ref{1337,,hex()} y @ref{1336,,oct()}). La presencia de este método indica que el objeto numérico es un tipo entero. Debe retornar un entero.

Si @ref{22a,,__int__()}, @ref{a5e,,__float__()} y @ref{687,,__complex__()} no son definidos, entonces todas las funciones incorporadas correspondientes @ref{1f0,,int()}, @ref{153,,float()} y @ref{154,,complex()} vuelven a @ref{22b,,__index__()}.
@end deffn

@geindex __round__() (método de object)
@geindex __trunc__() (método de object)
@geindex __floor__() (método de object)
@geindex __ceil__() (método de object)
@anchor{reference/datamodel object __round__}@anchor{1fb9}
@deffn {Método} object.__round__ (self[, ndigits])
@anchor{reference/datamodel object __trunc__}@anchor{229}
@deffnx {Método} object.__trunc__ (self)
@anchor{reference/datamodel object __floor__}@anchor{1fba}
@deffnx {Método} object.__floor__ (self)
@anchor{reference/datamodel object __ceil__}@anchor{1fbb}
@deffnx {Método} object.__ceil__ (self)

@geindex Funciones incorporadas;round

Es llamado para implementar la función incorporada @ref{1342,,round()} y las funciones @ref{8e,,math} @ref{1403,,trunc()}, @ref{1401,,floor()} y @ref{1402,,ceil()}. A menos que `ndigits' sea pasado a @code{__round__()} todos estos métodos deben retornar el valor del objeto truncado a @ref{1fbc,,Integral} (normalmente @ref{1f0,,int}).


Distinto en la versión 3.14: @ref{1f0,,int()} no longer delegates to the @ref{229,,__trunc__()} method.

@end deffn

@node Gestores de Contexto en la Declaración with,Personalización de argumentos posicionales en la coincidencia de patrones de clase,Emulando tipos numéricos,Nombres especiales de método
@anchor{reference/datamodel context-managers}@anchor{1fbd}@anchor{reference/datamodel with-statement-context-managers}@anchor{1fbe}
@subsubsection Gestores de Contexto en la Declaración `with'


Un `context manager' es un objeto que define el contexto en tiempo de ejecución a ser establecido cuando se ejecuta una declaración @ref{673,,with}. El gestor de contexto maneja la entrada y la salida del contexto en tiempo de ejecución deseado para la ejecución del bloque de código. Los gestores de contexto son normalmente invocados utilizando la declaración @code{with} (descritos en la sección @ref{673,,La sentencia with}), pero también pueden ser utilizados al invocar directamente sus métodos.

@geindex declaración;with
@geindex gestor de contexto

Usos típicos de los gestores de contexto incluyen guardar y restablecer diversos tipos de declaraciones globales, bloquear y desbloquear recursos, cerrar archivos abiertos, etc.

For more information on context managers, see @ref{1fbf,,Tipos gestores de contexto}.
The @ref{b18,,object} class itself does not provide the context manager methods.

@geindex __enter__() (método de object)
@anchor{reference/datamodel object __enter__}@anchor{669}
@deffn {Método} object.__enter__ (self)

Ingresa al contexto en tiempo de ejecución relacionado con este objeto. La declaración @ref{673,,with} ligará el valor de retorno de este método al objetivo especificado en cláusula @code{as} de la declaración, en caso de existir.
@end deffn

@geindex __exit__() (método de object)
@anchor{reference/datamodel object __exit__}@anchor{1367}
@deffn {Método} object.__exit__ (self, exc_type, exc_value, traceback)

Sale del contexto en tiempo de ejecución relacionado a este objeto. Los parámetros describen la excepción que causa la salida del contexto. Si éste se termina sin excepción, los tres argumentos serán @ref{716,,None}.

Si se proporciona una excepción, y el método desea eliminarla (por ejemplo, prevenir que sea propagada), debe retornar un valor verdadero. De lo contrario, la excepción será procesada de forma normal al salir de este método.

Note that @ref{1367,,__exit__()} methods should not reraise the passed-in exception;
this is the caller’s responsibility.
@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - La declaración “with”

La especificación, el antecedente, y los ejemplos para la declaración de Python @ref{673,,with}.
@end table


@node Personalización de argumentos posicionales en la coincidencia de patrones de clase,Emulando tipos de búfer,Gestores de Contexto en la Declaración with,Nombres especiales de método
@anchor{reference/datamodel class-pattern-matching}@anchor{1fc0}@anchor{reference/datamodel customizing-positional-arguments-in-class-pattern-matching}@anchor{1fc1}
@subsubsection Personalización de argumentos posicionales en la coincidencia de patrones de clase


Cuando se utiliza un nombre de clase en un patrón, los argumentos posicionales en el patrón no están permitidos de forma predeterminada, es decir, @code{case MyClass(x, y)} normalmente no es válido sin un soporte especial en @code{MyClass}. Para poder utilizar ese tipo de patrón, la clase necesita definir un atributo `__match_args__'.

@geindex object.__match_args__ (variable incorporada)
@anchor{reference/datamodel object __match_args__}@anchor{18c8}
@deffn {Dato} object.__match_args__

A esta variable de clase se le puede asignar una tupla de cadenas. Cuando esta clase se utiliza en un patrón de clase con argumentos posicionales, cada argumento posicional se convertirá en un argumento de palabra clave, utilizando el valor correspondiente en `__match_args__' como palabra clave. La ausencia de este atributo es equivalente a establecerlo en @code{()}.
@end deffn

Por ejemplo, si @code{MyClass.__match_args__} es @code{("left", "center", "right")} eso significa que @code{case MyClass(x, y)} es equivalente a @code{case MyClass(left=x, center=y)}. Ten en cuenta que el número de argumentos en el patrón debe ser menor o igual que el número de elementos en `__match_args__'; si es más grande, el intento de coincidencia de patrón producirá un @ref{228,,TypeError}.


Added in version 3.10.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 634

@item PEP 634@footnote{https://peps.python.org/pep-0634/} - Coincidencia de patrones estructurales

La especificación para la declaración @code{match} de Python.
@end table


@node Emulando tipos de búfer,Annotations,Personalización de argumentos posicionales en la coincidencia de patrones de clase,Nombres especiales de método
@anchor{reference/datamodel emulating-buffer-types}@anchor{1fc2}@anchor{reference/datamodel python-buffer-protocol}@anchor{1fc3}
@subsubsection Emulando tipos de búfer


@ref{48a,,buffer protocol} proporciona una forma para que los objetos Python expongan un acceso eficiente a una matriz de memoria de bajo nivel. Este protocolo se implementa mediante tipos integrados como @ref{325,,bytes} y @ref{156,,memoryview}, y bibliotecas de terceros pueden definir tipos de búfer adicionales.

Si bien los tipos de búfer generalmente se implementan en C, también es posible implementar el protocolo en Python.

@geindex __buffer__() (método de object)
@anchor{reference/datamodel object __buffer__}@anchor{50a}
@deffn {Método} object.__buffer__ (self, flags)

Se llama cuando se solicita un búfer desde `self' (por ejemplo, por el constructor @ref{156,,memoryview}). El argumento `flags' es un número entero que representa el tipo de búfer solicitado y afecta, por ejemplo, si el búfer retornado es de solo lectura o de escritura. @ref{50b,,inspect.BufferFlags} proporciona una manera conveniente de interpretar las banderas. El método debe retornar un objeto @ref{156,,memoryview}.
@end deffn

@geindex __release_buffer__() (método de object)
@anchor{reference/datamodel object __release_buffer__}@anchor{16f9}
@deffn {Método} object.__release_buffer__ (self, buffer)

Se llama cuando ya no se necesita un búfer. El argumento `buffer' es un objeto @ref{156,,memoryview} que @ref{50a,,__buffer__()} retornó anteriormente. El método debe liberar todos los recursos asociados con el búfer. Este método debería retornar @code{None}. Los objetos de búfer que no necesitan realizar ninguna limpieza no son necesarios para implementar este método.
@end deffn


Added in version 3.12.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 688

@item PEP 688@footnote{https://peps.python.org/pep-0688/}: hacer accesible el protocolo de búfer en Python

Presenta los métodos Python @code{__buffer__} y @code{__release_buffer__}.

@item @ref{3fe,,collections.abc.Buffer}

ABC para tipos de buffer.
@end table


@node Annotations,Búsqueda de método especial,Emulando tipos de búfer,Nombres especiales de método
@anchor{reference/datamodel annotations}@anchor{1fc4}
@subsubsection Annotations


Functions, classes, and modules may contain @ref{140,,annotations},
which are a way to associate information (usually @ref{1f81,,type hints})
with a symbol.

@geindex __annotations__ (atributo de object)
@anchor{reference/datamodel object __annotations__}@anchor{e08}
@deffn {Atributo} object.__annotations__

This attribute contains the annotations for an object. It is
@ref{503,,lazily evaluated}, so accessing the attribute may
execute arbitrary code and raise exceptions. If evaluation is successful, the
attribute is set to a dictionary mapping from variable names to annotations.


Distinto en la versión 3.14: Annotations are now lazily evaluated.

@end deffn

@geindex __annotate__() (método de object)
@anchor{reference/datamodel object __annotate__}@anchor{161a}
@deffn {Método} object.__annotate__ (format)

An @ref{141,,annotate function}.
Returns a new dictionary object mapping attribute/parameter names to their annotation values.

Takes a format parameter specifying the format in which annotations values should be provided.
It must be a member of the @ref{182,,annotationlib.Format} enum, or an integer with
a value corresponding to a member of the enum.

If an annotate function doesn’t support the requested format, it must raise
@ref{384,,NotImplementedError}. Annotate functions must always support
@ref{142,,VALUE} format; they must not raise
@ref{384,,NotImplementedError()} when called with this format.

When called with  @ref{142,,VALUE} format, an annotate function may raise
@ref{4ec,,NameError}; it must not raise @code{NameError} when called requesting any other format.

If an object does not have any annotations, @ref{161a,,__annotate__} should preferably be set
to @code{None} (it can’t be deleted), rather than set to a function that returns an empty dict.


Added in version 3.14.

@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 649

@item PEP 649@footnote{https://peps.python.org/pep-0649/} — Deferred evaluation of annotation using descriptors

Introduces lazy evaluation of annotations and the @code{__annotate__} function.
@end table


@node Búsqueda de método especial,,Annotations,Nombres especiales de método
@anchor{reference/datamodel special-lookup}@anchor{1f65}@anchor{reference/datamodel special-method-lookup}@anchor{1fc5}
@subsubsection Búsqueda de método especial


Para clases personalizadas, invocaciones implícitas de métodos especiales solo están garantizados para trabajar correctamente si son definidos en un tipo de objeto, no en el diccionario de instancia del objeto. Ese comportamiento es la razón por la que el siguiente código lanza una excepción:

@example
>>> class C:
...     pass
...
>>> c = C()
>>> c.__len__ = lambda: 5
>>> len(c)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: object of type 'C' has no len()
@end example

La razón detrás de este comportamiento radica en una serie de métodos especiales, como @ref{b86,,__hash__()} y @ref{6bd,,__repr__()}, que implementan todos los objetos, incluidos los objetos de tipo. Si la búsqueda implícita de estos métodos utilizara el proceso de búsqueda convencional, fallarían cuando se invocaran en el objeto de tipo mismo:

@example
>>> 1 .__hash__() == hash(1)
True
>>> int.__hash__() == hash(int)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: descriptor '__hash__' of 'int' object needs an argument
@end example

Intentar invocar de manera incorrecta el método no ligado de una clase de esta forma a veces es denominado como ‘confusión de metaclase’, y se evita sobrepasando la instancia al buscar métodos especiales:

@example
>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True
@end example

Además de omitir cualquier atributo de instancia en aras de la corrección, la búsqueda implícita de métodos especiales generalmente también omite el método @ref{c5a,,__getattribute__()} incluso de la metaclase del objeto:

@example
>>> class Meta(type):
...     def __getattribute__(*args):
...         print("Metaclass getattribute invoked")
...         return type.__getattribute__(*args)
...
>>> class C(object, metaclass=Meta):
...     def __len__(self):
...         return 10
...     def __getattribute__(*args):
...         print("Class getattribute invoked")
...         return object.__getattribute__(*args)
...
>>> c = C()
>>> c.__len__()                 # Explicit lookup via instance
Class getattribute invoked
10
>>> type(c).__len__(c)          # Explicit lookup via type
Metaclass getattribute invoked
10
>>> len(c)                      # Implicit lookup
10
@end example

Omitir la maquinaria @ref{c5a,,__getattribute__()} de esta manera proporciona un margen significativo para optimizar la velocidad dentro del intérprete, a costa de cierta flexibilidad en el manejo de métodos especiales (el método especial `must' debe configurarse en el propio objeto de clase para que el intérprete lo invoque consistentemente). ).

@geindex corrutina

@node Corrutinas,,Nombres especiales de método,Modelo de datos
@anchor{reference/datamodel coroutines}@anchor{1fc6}
@subsection Corrutinas


@menu
* Objetos esperables:: 
* Objetos de corrutina:: 
* Iteradores asíncronos:: 
* Gestores de contexto asíncronos:: 

@end menu

@node Objetos esperables,Objetos de corrutina,,Corrutinas
@anchor{reference/datamodel awaitable-objects}@anchor{1fc7}
@subsubsection Objetos esperables


Un objeto @ref{314,,awaitable} generalmente implementa un método @ref{1fc8,,__await__()}. @ref{53a,,Coroutine objects} retornado por las funciones @ref{672,,async def} están a la espera.

@cartouche
@quotation Nota 
Los objetos @ref{c66,,generator iterator} retornados por generadores decorados con @ref{f0b,,types.coroutine()} también están a la espera, pero no implementan @ref{1fc8,,__await__()}.
@end quotation
@end cartouche

@geindex __await__() (método de object)
@anchor{reference/datamodel object __await__}@anchor{1fc8}
@deffn {Método} object.__await__ (self)

Must return an @ref{313,,iterator}.  Should be used to implement
@ref{314,,awaitable} objects.  For instance, @ref{c55,,asyncio.Future} implements
this method to be compatible with the @ref{14e,,await} expression.
The @ref{b18,,object} class itself is not awaitable and does not provide
this method.

@cartouche
@quotation Nota 
El lenguaje no impone ninguna restricción sobre el tipo o valor de los objetos generados por el iterador retornado por @code{__await__}, ya que esto es específico de la implementación del marco de ejecución asincrónica (por ejemplo, @ref{b,,asyncio}) que administrará el objeto @ref{314,,awaitable}.
@end quotation
@end cartouche
@end deffn


Added in version 3.5.



@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} para información adicional sobre objetos esperables.


@node Objetos de corrutina,Iteradores asíncronos,Objetos esperables,Corrutinas
@anchor{reference/datamodel coroutine-objects}@anchor{1f07}@anchor{reference/datamodel id19}@anchor{1fc9}
@subsubsection Objetos de corrutina


@ref{53a,,Coroutine objects} son objetos @ref{314,,awaitable}. La ejecución de una corrutina se puede controlar llamando a @ref{1fc8,,__await__()} e iterando sobre el resultado. Cuando la rutina termina de ejecutarse y regresa, el iterador genera @ref{c82,,StopIteration} y el atributo @ref{1fca,,value} de la excepción contiene el valor de retorno. Si la rutina genera una excepción, el iterador la propaga. Las corrutinas no deberían generar directamente excepciones @ref{c82,,StopIteration} no controladas.

Las corrutinas también tienen los métodos mencionados a continuación, los cuales son análogos a los de los generadores. (ver @ref{1fcb,,Métodos generador-iterador}). Sin embargo, a diferencia de los generadores, las corrutinas no soportan directamente iteración.


Distinto en la versión 3.5.2: Es un error @ref{1e5,,RuntimeError} esperar a una corrutina más de una vez.


@geindex send() (método de coroutine)
@anchor{reference/datamodel coroutine send}@anchor{1fcc}
@deffn {Método} coroutine.send (value)

Starts or resumes execution of the coroutine.  If `value' is @code{None},
this is equivalent to advancing the iterator returned by
@ref{1fc8,,__await__()}.  If `value' is not @code{None}, this method delegates
to the @ref{1fcd,,send()} method of the iterator that caused
the coroutine to suspend.  The result (return value,
@ref{c82,,StopIteration}, or other exception) is the same as when
iterating over the @code{__await__()} return value, described above.
@end deffn

@geindex throw() (método de coroutine)
@anchor{reference/datamodel coroutine throw}@anchor{59c}
@deffn {Método} coroutine.throw (value)

@deffnx {Método} coroutine.throw (type[, value[, traceback]])

Genera la excepción especificada en la corrutina. Este método delega al método @ref{59d,,throw()} del iterador que provocó la suspensión de la rutina, si tiene dicho método. En caso contrario, la excepción se plantea en el punto de suspensión. El resultado (valor de retorno, @ref{c82,,StopIteration} u otra excepción) es el mismo que cuando se itera sobre el valor de retorno @ref{1fc8,,__await__()}, descrito anteriormente. Si la excepción no queda atrapada en la rutina, se propaga de nuevo a la persona que llama.


Distinto en la versión 3.12: La segunda firma (type[, value[, traceback]]) está obsoleta y puede eliminarse en una versión futura de Python.

@end deffn

@geindex close() (método de coroutine)
@anchor{reference/datamodel coroutine close}@anchor{1fce}
@deffn {Método} coroutine.close ()

Causa que la corrutina misma se borre a sí misma y termine su ejecución. Si la corrutina es suspendida, este método primero delega a @ref{16fa,,close()}, si existe, del iterador que causó la suspensión de la corrutina. Luego lanza una excepción @ref{1407,,GeneratorExit} en el punto de suspensión, causando que la corrutina se borre a sí misma. Finalmente, la corrutina es marcada como completada, aún si nunca inició.

Objetos de corrutina son cerrados automáticamente utilizando el proceso anterior cuando están a punto de ser destruidos.
@end deffn

@node Iteradores asíncronos,Gestores de contexto asíncronos,Objetos de corrutina,Corrutinas
@anchor{reference/datamodel async-iterators}@anchor{dff}@anchor{reference/datamodel asynchronous-iterators}@anchor{1fcf}
@subsubsection Iteradores asíncronos


Un `iterador asíncrono' puede llamar código asíncrono en su método @code{__anext__}.

Iteradores asíncronos pueden ser utilizados en la declaración @ref{b36,,async for}.

The @ref{b18,,object} class itself does not provide these methods.

@geindex __aiter__() (método de object)
@anchor{reference/datamodel object __aiter__}@anchor{c83}
@deffn {Método} object.__aiter__ (self)

Debe retornar un objeto de `iterador asíncrono'.
@end deffn

@geindex __anext__() (método de object)
@anchor{reference/datamodel object __anext__}@anchor{1f09}
@deffn {Método} object.__anext__ (self)

Debe retornar un `esperable' (awaitable) resultante en el siguiente valor del iterador. Debe levantar una excepción @ref{1a34,,StopAsyncIteration} cuando la iteración termina.
@end deffn

Un ejemplo de objeto iterable asíncrono:

@example
class Reader:
    async def readline(self):
        ...

    def __aiter__(self):
        return self

    async def __anext__(self):
        val = await self.readline()
        if val == b'@w{'}:
            raise StopAsyncIteration
        return val
@end example


Added in version 3.5.



Distinto en la versión 3.7: Antes de Python 3.7, @ref{c83,,__aiter__()} podía retornar un `awaitable' que se resolvería en un @ref{312,,asynchronous iterator}.

A partir de Python 3.7, @ref{c83,,__aiter__()} debe retornar un objeto iterador asincrónico. Retornar cualquier otra cosa resultará en un error @ref{228,,TypeError}.


@node Gestores de contexto asíncronos,,Iteradores asíncronos,Corrutinas
@anchor{reference/datamodel async-context-managers}@anchor{69c}@anchor{reference/datamodel asynchronous-context-managers}@anchor{1fd0}
@subsubsection Gestores de contexto asíncronos


Un `gestor de contexto asíncrono' es un `gestor de contexto' que puede suspender la ejecución en sus métodos @code{__aenter__} y @code{__aexit__}.

Los gestores de contexto asíncronos pueden ser utilizados en una declaración @ref{676,,async with}.

The @ref{b18,,object} class itself does not provide these methods.

@geindex __aenter__() (método de object)
@anchor{reference/datamodel object __aenter__}@anchor{1fd1}
@deffn {Método} object.__aenter__ (self)

Semantically similar to @ref{669,,__enter__()}, the only
difference being that it must return an `awaitable'.
@end deffn

@geindex __aexit__() (método de object)
@anchor{reference/datamodel object __aexit__}@anchor{1636}
@deffn {Método} object.__aexit__ (self, exc_type, exc_value, traceback)

Semantically similar to @ref{1367,,__exit__()}, the only
difference being that it must return an `awaitable'.
@end deffn

Un ejemplo de una clase de gestor de contexto asíncrono:

@example
class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')
@end example


Added in version 3.5.


@node Modelo de ejecución,El sistema de importación,Modelo de datos,Referencia del Lenguaje Python
@anchor{reference/executionmodel doc}@anchor{1fd2}@anchor{reference/executionmodel execmodel}@anchor{1fd3}@anchor{reference/executionmodel execution-model}@anchor{1fd4}
@section Modelo de ejecución


@geindex modelo de ejecución
@geindex código;bloque

@menu
* Estructura de un programa:: 
* Nombres y vínculos:: 
* Excepciones: Excepciones<2>. 

@end menu

@node Estructura de un programa,Nombres y vínculos,,Modelo de ejecución
@anchor{reference/executionmodel prog-structure}@anchor{1fd5}@anchor{reference/executionmodel structure-of-a-program}@anchor{1fd6}
@subsection Estructura de un programa


@geindex bloque

Un programa de Python se construye a partir de bloques de código. Un `block' es una parte del texto del programa Python que se ejecuta como una unidad. Los siguientes son bloques: un módulo, un cuerpo de función y una definición de clase. Cada comando escrito de forma interactiva es un bloque. Un archivo de secuencia de comandos (un archivo proporcionado como entrada estándar al intérprete o especificado como un argumento de línea de comando para el intérprete) es un bloque de código. Un comando de secuencia de comandos (un comando especificado en la línea de comandos del intérprete con la opción: @ref{681,,-c}) es un bloque de código. Un módulo que se ejecuta como un script de nivel superior (como módulo @code{__main__}) desde la línea de comando usando un argumento @ref{187,,-m} también es un bloque de código. El argumento de cadena pasado a las funciones integradas @ref{2eb,,eval()} y @ref{2ea,,exec()} es un bloque de código.

@geindex ejecución;marco

Un bloque de código se ejecuta en un `execution frame'. Un marco contiene alguna información administrativa (que se usa para depuración) y determina dónde y cómo continuará la ejecución una vez que el bloque de código se haya completado.

@node Nombres y vínculos,Excepciones<2>,Estructura de un programa,Modelo de ejecución
@anchor{reference/executionmodel naming}@anchor{1ef7}@anchor{reference/executionmodel naming-and-binding}@anchor{1fd7}
@subsection Nombres y vínculos


@geindex espacio de nombre
@geindex ámbito

@menu
* Vinculación de nombres:: 
* Resolución de nombres:: 
* Ámbitos de anotación:: 
* Evaluación perezosa:: 
* Integraciones y ejecución restringida:: 
* Interacción con funcionalidades dinámicas:: 

@end menu

@node Vinculación de nombres,Resolución de nombres,,Nombres y vínculos
@anchor{reference/executionmodel bind-names}@anchor{1fd8}@anchor{reference/executionmodel binding-of-names}@anchor{1fd9}
@subsubsection Vinculación de nombres


@geindex nombre
@geindex vinculación de nombres;nombre

Los `Names' refieren a objetos. Los nombres se introducen por las operaciones de vinculación de nombre (`name binding operations').

@geindex de;declaración de importación

Las siguientes construcciones enlazan nombres:


@itemize *

@item 
parámetros formales de las funciones,

@item 
definiciones de clase,

@item 
definiciones de funciones,

@item 
expresiones de asignación,

@item 
@ref{1fda,,targets} que son identificadores si aparecen en una asignación:


@itemize +

@item 
cabecera del bucle @ref{1eb,,for},

@item 
después de @code{as} en una declaración @ref{673,,with}, cláusula @ref{2f6,,except}, cláusula @ref{659,,except*}, o en el patrón as en la concordancia de patrones estructurales,

@item 
en un patrón de captura en la concordancia de patrones estructurales
@end itemize

@item 
declaraciones @ref{682,,import}.

@item 
declaraciones @ref{4e6,,type}.

@item 
@ref{3fc,,listas tipo de parámetros}.
@end itemize

La declaración @code{import} de la forma @code{from ... import *} vincula todos los nombres definidos en el módulo importado, excepto los que empiezan por guión bajo. Esta forma sólo puede utilizarse a nivel de módulo.

Un objetivo que aparece en una sentencia @ref{17ae,,del} también se considera vinculado para este propósito (aunque la semántica real es desvincular el nombre).

Cada declaración de asignación o importación ocurre dentro de un bloque determinado por una definición de clase o de función, o a nivel de módulo (el bloque de código de máximo nivel).

@geindex libre;variable

If a name is bound in a block, it is a local variable of that block, unless
declared as @ref{1313,,nonlocal} or @ref{2f5,,global}.  If a name is bound at
the module level, it is a global variable.  (The variables of the module code
block are local and global.)  If a variable is used in a code block but not
defined there, it is a @ref{1fdb,,free variable}.

Cada ocurrencia de un nombre en el texto del programa se refiere al `binding' de ese nombre, establecido por las siguientes reglas de resolución de nombres.

@node Resolución de nombres,Ámbitos de anotación,Vinculación de nombres,Nombres y vínculos
@anchor{reference/executionmodel resolution-of-names}@anchor{1fdc}@anchor{reference/executionmodel resolve-names}@anchor{1fdd}
@subsubsection Resolución de nombres


@geindex ámbito

Un `scope' define la visibilidad de un nombre en un bloque. Si una variable local se define en un bloque, su ámbito incluye ese bloque. Si la definición ocurre en un bloque de función, el ámbito se extiende a cualquier bloque contenido en el bloque en donde está la definición, a menos que uno de los bloques contenidos introduzca un vínculo diferente para el nombre.

@geindex ambiente

Cuando un nombre es utilizado en un bloque de código, se resuelve utilizando el ámbito de cierre más cercano. El conjunto de todos esos ámbitos visibles para un bloque de código se llama el `environment' del bloque.

@geindex NameError (excepción incorporada)
@geindex UnboundLocalError

Cuando un nombre no se encuentra, se lanza una excepción @ref{4ec,,NameError}. Si el ámbito actual es una función, y el nombre se refiere a una variable local que todavía no ha sido vinculada a un valor en el punto en el que nombre es utilizado, se lanza una excepción @ref{1576,,UnboundLocalError}. @ref{1576,,UnboundLocalError} es una subclase de @ref{4ec,,NameError}.

Si una operación de vinculación de nombre ocurre en cualquier parte dentro de un bloque de código, todos los usos del nombre dentro de ese bloque son tratados como referencias al bloque actual. Esto puede llevar a errores cuando el nombre es utilizado dentro del bloque antes de su vinculación. Esta regla es sutil. Python carece de declaraciones y permite que las operaciones de vinculación de nombres ocurran en cualquier lugar dentro del bloque de código. Las variables locales de un bloque de código pueden determinarse buscando operaciones de vinculación de nombres en el texto completo del bloque. Ver @ref{1fde,,la entrada del FAQ sobre UnboundLocalError} para ejemplos.

If the @ref{2f5,,global} statement occurs within a block, all uses of the names
specified in the statement refer to the bindings of those names in the top-level
namespace.  Names are resolved in the top-level namespace by searching the
global namespace, i.e. the namespace of the module containing the code block,
and the builtins namespace, the namespace of the module @ref{13,,builtins}.  The
global namespace is searched first.  If the names are not found there, the
builtins namespace is searched next. If the names are also not found in the
builtins namespace, new variables are created in the global namespace.
The global statement must precede all uses of the listed names.

La declaración @ref{2f5,,global} tiene el mismo ámbito que una operación de vinculación de nombre en el mismo bloque. Si el ámbito de cierre más cercano para una variable libre contiene una declaración global, se trata a la variable libre como global.

@c XXX say more about "nonlocal" semantics here

La declaración @ref{1313,,nonlocal} causa que los nombre correspondientes se refieran a variables previamente vinculadas en el ámbito de la función de cierre más cercano. Se lanza un @ref{150,,SyntaxError} en tiempo de compilación si el nombre dado no existe en ningún ámbito de las funciones dentro de las cuales está. @ref{3fc,,Parámetros de tipo} no puede recuperarse con la sentencia @code{nonlocal}.

@geindex módulo;__main__

El espacio de nombres (`namespace') para un módulo se crea automáticamente la primera vez que se importa el módulo. El módulo principal de un `script' siempre se llama @ref{1,,__main__}.

Los bloques de definición de clase y los argumentos para @ref{2ea,,exec()} y @ref{2eb,,eval()} son especiales en el contexto de la resolución de nombres. Una definición de clase es una declaración ejecutable que puede usar y definir nombres. Estas referencias siguen las reglas normales para la resolución de nombres con la excepción de que se buscan las variables locales no vinculadas en el espacio de nombres global. El espacio de nombres de la definición de clase se vuelve el diccionario de atributos de la clase. El ámbito de nombres definido en un bloque de clase está limitado a dicho bloque; no se extiende a los bloques de código de los métodos. Esto incluye las comprensiones y las expresiones generadoras pero no incluye @ref{2f3,,annotation scopes}, que tienen acceso a sus ámbitos de clase adjuntos. Esto significa que lo siguiente fallará:

@example
class A:
    a = 42
    b = list(a + i for i in range(10))
@end example

Sin embargo. lo siguiente tendrá éxito:

@example
class A:
    type Alias = Nested
    class Nested: pass

print(A.Alias.__value__)  # <type 'A.Nested'>
@end example

@node Ámbitos de anotación,Evaluación perezosa,Resolución de nombres,Nombres y vínculos
@anchor{reference/executionmodel annotation-scopes}@anchor{2f3}@anchor{reference/executionmodel id1}@anchor{1fdf}
@subsubsection Ámbitos de anotación


@ref{140,,Annotations}, @ref{3fc,,type parameter lists}
and @ref{4e6,,type} statements
introduce `annotation scopes', which behave mostly like function scopes,
but with some exceptions discussed below.

Los ámbitos de anotación se utilizan en los siguientes contextos:


@itemize *

@item 
@ref{1c3e,,Function annotations}.

@item 
@ref{ddb,,Variable annotations}.

@item 
Listas de tipo de parámetros para @ref{502,,generic type aliases}.

@item 
Escriba listas de parámetros para @ref{4ff,,generic functions}. Las anotaciones de una función genérica se ejecutan dentro del alcance de la anotación, pero sus valores predeterminados y decoradores no.

@item 
Tipo de parámetros de listas para @ref{4fe,,generic classes}. Las clases base y los argumentos de palabra clave de una clase genérica se ejecutan dentro del ámbito de la anotación, pero sus decoradores no.

@item 
The bounds, constraints, and default values for type parameters
(@ref{503,,lazily evaluated}).

@item 
El valor de los alias de tipo (@ref{503,,lazy evaluated}).
@end itemize

Los ámbitos de anotación difieren de los ámbitos de función en lo siguiente:


@itemize *

@item 
Los ámbitos de anotación tienen acceso al espacio de nombres de la clase que los rodea. Si un ámbito de anotación está inmediatamente dentro de un ámbito de clase, o dentro de otro ámbito de anotación que está inmediatamente dentro de un ámbito de clase, el código en el ámbito de anotación puede utilizar nombres definidos en el ámbito de clase como si se ejecutara directamente dentro del cuerpo de la clase. Esto contrasta con las funciones normales definidas dentro de las clases, que no pueden acceder a los nombres definidos en el ámbito de la clase.

@item 
Las expresiones en ámbitos de anotación no pueden contener expresiones @ref{a5f,,yield}, @code{yield from}, @ref{14e,,await}, o @ref{1fe0,,;=}. (Estas expresiones están permitidas en otros ámbitos contenidos dentro del ámbito de la anotación).

@item 
Los nombres definidos en ámbitos de anotación no pueden recuperarse con sentencias @ref{1313,,nonlocal} en ámbitos internos. Esto incluye sólo parámetros de tipo, ya que ningún otro elemento sintáctico que pueda aparecer dentro de ámbitos de anotación puede introducir nuevos nombres.

@item 
While annotation scopes have an internal name, that name is not reflected in the
@ref{194a,,qualified name} of objects defined within the scope.
Instead, the @ref{10e1,,__qualname__}
of such objects is as if the object were defined in the enclosing scope.
@end itemize


Added in version 3.12: Los ámbitos de anotación se introdujeron en Python 3.12 como parte de 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Distinto en la versión 3.13: Annotation scopes are also used for type parameter defaults, as
introduced by 
@geindex Python Enhancement Proposals; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}.



Distinto en la versión 3.14: Annotation scopes are now also used for annotations, as specified in
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} and 
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}.


@node Evaluación perezosa,Integraciones y ejecución restringida,Ámbitos de anotación,Nombres y vínculos
@anchor{reference/executionmodel id2}@anchor{1fe1}@anchor{reference/executionmodel lazy-evaluation}@anchor{503}
@subsubsection Evaluación perezosa


Most annotation scopes are `lazily evaluated'. This includes annotations,
the values of type aliases created through the @ref{4e6,,type} statement, and
the bounds, constraints, and default values of type
variables created through the @ref{3fc,,type parameter syntax}.
This means that they are not evaluated when the type alias or type variable is
created, or when the object carrying annotations is created. Instead, they
are only evaluated when necessary, for example when the @code{__value__}
attribute on a type alias is accessed.

Ejemplo:

@example
>>> type Alias = 1/0
>>> Alias.__value__
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
>>> def func[T: 1/0](): pass
>>> T = func.__type_params__[0]
>>> T.__bound__
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
@end example

Aquí la excepción se lanza sólo cuando se accede al atributo @code{__value__} del alias de tipo o al atributo @code{__bound__} de la variable de tipo.

Este comportamiento es útil principalmente para referencias a tipos que aún no se han definido cuando se crea el alias de tipo o la variable de tipo. Por ejemplo, la evaluación perezosa permite la creación de alias de tipo mutuamente recursivos:

@example
from typing import Literal

type SimpleExpr = int | Parenthesized
type Parenthesized = tuple[Literal["("], Expr, Literal[")"]]
type Expr = SimpleExpr | tuple[SimpleExpr, Literal["+", "-"], Expr]
@end example

Los valores evaluados perezosamente se evalúan en @ref{2f3,,annotation scope}, lo que significa que los nombres que aparecen dentro del valor evaluado se buscan como si se utilizaran en el ámbito inmediatamente adyacente.


Added in version 3.12.


@node Integraciones y ejecución restringida,Interacción con funcionalidades dinámicas,Evaluación perezosa,Nombres y vínculos
@anchor{reference/executionmodel builtins-and-restricted-execution}@anchor{1fe2}@anchor{reference/executionmodel restrict-exec}@anchor{1fe3}
@subsubsection Integraciones y ejecución restringida


@geindex restringido;ejecución

`Detalles de implementación de CPython:' Los usuarios no deberían tocar @code{__builtins__}; es un detalle de la implementación en sentido estricto. Los usuarios que quieran sobreescribir valores en los espacios de nombres incorporados deberían usar @ref{682,,import} con el módulo @ref{13,,builtins} y modificar sus atributos de un modo adecuado.

El espacio de nombres incorporado (`builtin namespace') asociado a la ejecución de un bloque de código es encontrado buscando el nombre @code{__builtins__} en su espacio de nombres global; debería ser un diccionario o un módulo (en este último caso, se usa el diccionario del módulo). Por defecto, en el módulo @ref{1,,__main__}, @code{__builtins__} es el módulo @ref{13,,builtins}. En cualquier otro módulo,  @code{__builtins__} es un alias para el diccionario del propio módulo @ref{13,,builtins}.

@node Interacción con funcionalidades dinámicas,,Integraciones y ejecución restringida,Nombres y vínculos
@anchor{reference/executionmodel dynamic-features}@anchor{1fe4}@anchor{reference/executionmodel interaction-with-dynamic-features}@anchor{1fe5}
@subsubsection Interacción con funcionalidades dinámicas


La resolución de variables libres sucede en tiempo de ejecución, no en tiempo de compilación. Esto significa que el siguiente código va a mostrar 42:

@example
i = 10
def f():
    print(i)
i = 42
f()
@end example

@c XXX from * also invalid with relative imports (at least currently)

Las funciones @ref{2eb,,eval()} y @ref{2ea,,exec()} no tienen acceso al entorno completo para resolver nombres. Los nombres pueden resolverse en los espacios de nombres locales y globales de la persona que llama. Las variables libres no se resuelven en el espacio de nombres adjunto más cercano, sino en el espacio de nombres global. @footnote{
Esta limitación se da porque el código ejecutado por estas operaciones no está disponible en el momento en que se compila el módulo.
} Las funciones @ref{2ea,,exec()} y @ref{2eb,,eval()} tienen argumentos opcionales para anular el espacio de nombres global y local. Si solo se especifica un espacio de nombres, se usa para ambos.

@c XXX(ncoghlan) above is only accurate for string execution. When executing code objects,
@c closure cells may now be passed explicitly to resolve co_freevars references.
@c Docs issue: https://github.com/python/cpython/issues/122826

@node Excepciones<2>,,Nombres y vínculos,Modelo de ejecución
@anchor{reference/executionmodel exceptions}@anchor{1fe6}@anchor{reference/executionmodel id4}@anchor{1fe7}
@subsection Excepciones


@geindex excepciones

@geindex lanzar una excepción
@geindex gestionar una excepción
@geindex gestor de excepciones
@geindex errores
@geindex manejo de errores

Las excepciones son un medio para salir del flujo de control normal de un bloque de código, para gestionar errores u otras condiciones excepcionales. Una excepción es `lanzada' (`raised') en el momento en que se detecta el error; puede ser `gestionada' (`handled') por el bloque de código que la rodea o por cualquier bloque de código que directa o indirectamente ha invocado al bloque de código en el que ocurrió el error.

El intérprete Python lanza una excepción cuando detecta un error en tiempo de ejecución (como una división por cero). Un programa Python también puede lanzar una excepción explícitamente, con la declaración @ref{68d,,raise}. Los gestores de excepciones se especifican con la declaración @ref{789,,try} … @ref{2f6,,except}. La cláusula @ref{a5c,,finally} de tales declaraciones puede utilizarse para especificar código de limpieza que no es el que gestiona la excepción, sino que se ejecutará en cualquier caso, tanto cuando la excepción ha ocurrido en el código que la precede, como cuando esto no ha sucedido.

@geindex modelo de finalización

Python usa el modelo de gestión de errores de «terminación» (»`termination'»): un gestor de excepción puede descubrir qué sucedió y continuar la ejecución en un nivel exterior, pero no puede reparar la causa del error y reintentar la operación que ha fallado (excepto que se reingrese al trozo de código fallido desde su inicio).

@geindex SystemExit (excepción incorporada)

Cuando una excepción no está gestionada en absoluto, el intérprete termina la ejecución del programa, o retorna a su bucle principal interactivo. En cualquier caso, imprime un seguimiento de pila, excepto cuando la excepción es @ref{dc7,,SystemExit}.

Las excepciones se identifican mediante instancias de clase.  La cláusula @ref{2f6,,except} se selecciona en función de la clase de la instancia: debe hacer referencia a la clase de la instancia o a un @ref{1224,,non-virtual base class} de la misma. La instancia puede ser recibida por el manejador y puede llevar información adicional sobre la condición excepcional.

@cartouche
@quotation Nota 
Los mensajes de excepción no forman parte de la API Python. Su contenido puede cambiar entre una versión de Python y la siguiente sin ningún tipo de advertencia; el código que corre bajo múltiples versiones del intérprete no debería basarse en estos mensajes.
@end quotation
@end cartouche

Mira también la descripción de la declaración @ref{789,,try} en la sección @ref{789,,La sentencia try}, y la declaración @ref{68d,,raise} en la sección @ref{68d,,La declaración raise}.

@subsubheading Notas al pie


@node El sistema de importación,Expresiones,Modelo de ejecución,Referencia del Lenguaje Python
@anchor{reference/import doc}@anchor{1fe8}@anchor{reference/import importsystem}@anchor{1f12}@anchor{reference/import the-import-system}@anchor{1fe9}
@section El sistema de importación


@geindex maquinaria de importación

El código Python en un @ref{166a,,módulo} obtiene acceso al código en otro módulo por el proceso de @ref{1fea,,importarlo}.  La instrucción @ref{682,,import} es la forma más común de invocar la maquinaria de importación, pero no es la única manera.  Funciones como @ref{5bc,,importlib.import_module()} y built-in @ref{96b,,__import__()} también se pueden utilizar para invocar la maquinaria de importación.

La instrucción @ref{682,,import} combina dos operaciones; busca el módulo con nombre y, a continuación, enlaza los resultados de esa búsqueda a un nombre en el ámbito local.  La operación de búsqueda de la instrucción @code{import} se define como una llamada a la función @ref{96b,,__import__()}, con los argumentos adecuados. El valor retornado de @ref{96b,,__import__()} se utiliza para realizar la operación de enlace de nombre de la instrucción @code{import}.  Consulte la instrucción @code{import} para obtener los detalles exactos de esa operación de enlace de nombres.

Una llamada directa a @ref{96b,,__import__()} realiza solo la búsqueda del módulo y, si se encuentra, la operación de creación del módulo.  Aunque pueden producirse ciertos efectos secundarios, como la importación de paquetes primarios y la actualización de varias memorias caché (incluidas @ref{1976,,sys.modules}), solo la instrucción @ref{682,,import} realiza una operación de enlace de nombres.

Cuando se ejecuta una instrucción @ref{682,,import}, se llama a la función estándar incorporada @ref{96b,,__import__()}. Otros mecanismos para invocar el sistema de importación (como @ref{5bc,,importlib.import_module()}) pueden optar por omitir @ref{96b,,__import__()} y utilizar sus propias soluciones para implementar la semántica de importación.

Cuando se importa un módulo por primera vez, Python busca el módulo y, si se encuentra, crea un objeto de módulo @footnote{
Véase @code{types. ModuleType}.
}, inicializándolo.  Si no se encuentra el módulo con nombre, se genera un @ref{bcf,,ModuleNotFoundError}.  Python implementa varias estrategias para buscar el módulo con nombre cuando se invoca la maquinaria de importación.  Estas estrategias se pueden modificar y ampliar mediante el uso de varios ganchos descritos en las secciones siguientes.


Distinto en la versión 3.3: El sistema de importación se ha actualizado para aplicar plenamente la segunda fase de 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. Ya no hay ninguna maquinaria de importación implícita: todo el sistema de importación se expone a través de @ref{db2,,sys.meta_path}. Además, se ha implementado la compatibilidad con paquetes de espacio de nombres nativos (consulte 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}).


@menu
* importlib: importlib<11>. 
* Paquetes: Paquetes<2>. 
* Buscando:: 
* Cargando:: 
* El buscador basado en rutas:: 
* Reemplazando el sistema de importación estándar:: 
* Paquete Importaciones relativas:: 
* Consideraciones especiales para __main__:: 
* Referencias:: 

@end menu

@node importlib<11>,Paquetes<2>,,El sistema de importación
@anchor{reference/import importlib}@anchor{1feb}
@subsection @code{importlib}


El módulo @ref{77,,importlib} proporciona una API enriquecida para interactuar con el sistema de importación.  Por ejemplo @ref{5bc,,importlib.import_module()} proporciona una API recomendada y más sencilla que la integrada @ref{96b,,__import__()} para invocar la maquinaria de importación.  Consulte la documentación de la biblioteca @ref{77,,importlib} para obtener más detalles.

@node Paquetes<2>,Buscando,importlib<11>,El sistema de importación
@anchor{reference/import packages}@anchor{1fec}
@subsection Paquetes


@geindex package

Python sólo tiene un tipo de objeto módulo, y todos los módulos son de este tipo, independientemente de si el módulo está implementado en Python, C, o en cualquier otro lenguaje.  Para ayudar a organizar los módulos y proporcionar una jerarquía de nombres, Python tiene un concepto de @ref{185,,paquete}.

Puedes pensar en los paquetes como los directorios de un sistema de archivos y en los módulos como archivos dentro de los directorios, pero no te tomes esta analogía demasiado literalmente, ya que los paquetes y los módulos no tienen por qué originarse en el sistema de archivos.  Para los propósitos de esta documentación, usaremos esta conveniente analogía de directorios y archivos.  Al igual que los directorios del sistema de archivos, los paquetes están organizados de forma jerárquica, y los paquetes pueden contener subpaquetes, así como módulos regulares.

Es importante tener en cuenta que todos los paquetes son módulos, pero no todos los módulos son paquetes.  O dicho de otro modo, los paquetes son sólo un tipo especial de módulo. Específicamente, cualquier módulo que contenga un atributo @code{__path__} se considera un paquete.

Todos los módulos tienen un nombre. Los nombres de los subpaquetes están separados de su nombre de paquete principal por un punto, similar a la sintaxis de acceso de atributo estándar de Python. Por lo tanto, podría tener un paquete llamado @ref{3c,,email}, que a su vez tiene un subpaquete llamado @ref{46,,email.mime} y un módulo dentro de ese subpaquete llamado @ref{4e,,email.mime.text}.

@menu
* Paquetes regulares:: 
* Paquetes de espacio de nombres:: 

@end menu

@node Paquetes regulares,Paquetes de espacio de nombres,,Paquetes<2>
@anchor{reference/import regular-packages}@anchor{1fed}
@subsubsection Paquetes regulares


@geindex package;regular

Python define dos tipos de paquetes, @ref{1fee,,paquetes regulares} y @ref{1b8,,paquetes de espacio de nombres}.  Los paquetes regulares son los paquetes tradicionales tal y como existían en Python 3.2 y anteriores. Un paquete regular se implementa típicamente como un directorio que contiene un archivo @code{init__.py}.  Cuando se importa un paquete regular, este archivo @code{__init__.py} se ejecuta implícitamente, y los objetos que define están vinculados a nombres en el espacio de nombres del paquete.  El archivo @code{__init__.py} puede contener el mismo código Python que puede contener cualquier otro módulo, y Python añadirá algunos atributos adicionales al módulo cuando se importe.

Por ejemplo, la siguiente disposición del sistema de archivos define un paquete @code{parent} de nivel superior con tres subpaquetes:

@example
parent/
    __init__.py
    one/
        __init__.py
    two/
        __init__.py
    three/
        __init__.py
@end example

Importando @code{parent.one} se ejecutará implícitamente @code{parent/__init__.py} y @code{parent/one/__init__.py}.  La importación posterior de @code{parent.two} o @code{parent.three} ejecutará @code{parent/two/__init__.py} y @code{parent/three/__init__.py} respectivamente.

@node Paquetes de espacio de nombres,,Paquetes regulares,Paquetes<2>
@anchor{reference/import namespace-packages}@anchor{1fef}
@subsubsection Paquetes de espacio de nombres


@geindex package;namespace
@geindex package;porción

Un paquete de espacio de nombres es un compuesto de varias @ref{1ff0,,porciones}, donde cada porción contribuye con un subpaquete al paquete padre.  Las porciones pueden residir en diferentes lugares del sistema de archivos.  Las porciones también pueden encontrarse en archivos zip, en la red, o en cualquier otro lugar que Python busque durante la importación.  Los paquetes de espacios de nombres pueden corresponder o no directamente a objetos del sistema de archivos; pueden ser módulos virtuales que no tienen una representación concreta.

Los paquetes de espacios de nombres no usan una lista ordinaria para su atributo @code{__path__}. En su lugar utilizan un tipo iterable personalizado que realizará automáticamente una nueva búsqueda de porciones de paquete en el siguiente intento de importación dentro de ese paquete si la ruta de su paquete padre (o @code{sys.path`} para un paquete de nivel superior) cambia.

Con los paquetes de espacio de nombres, no hay ningún archivo @code{parent/__init__.py}.  De hecho, puede haber varios directorios @code{padre} encontrados durante la búsqueda de importación, donde cada uno de ellos es proporcionado por una parte diferente.  Por lo tanto, @code{padre/one} no puede estar físicamente situado junto a @code{padre/two}.  En este caso, Python creará un paquete de espacio de nombres para el paquete @code{parent} de nivel superior siempre que se importe él o uno de sus subpaquetes.

Consulte también 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} para conocer la especificación del paquete de espacio de nombres.

@node Buscando,Cargando,Paquetes<2>,El sistema de importación
@anchor{reference/import searching}@anchor{1ff1}
@subsection Buscando


Para comenzar la búsqueda, Python necesita el nombre @ref{194a,,totalmente calificado} del módulo (o paquete, pero para los fines de esta discusión, la diferencia es irrelevante) que se está importando.  Este nombre puede provenir de varios argumentos a la instrucción @ref{682,,import}, o de los parámetros de las funciones @ref{5bc,,importlib.import_module()} o @ref{96b,,__import__()}.

Este nombre se utilizará en varias fases de la búsqueda de importación, y puede ser la ruta de acceso punteada a un submódulo, por ejemplo, @code{foo.bar.baz}.  En este caso, Python primero intenta importar @code{foo}, luego @code{foo.bar}, y finalmente @code{foo.bar.baz}. Si se produce un error en cualquiera de las importaciones intermedias, se genera un @ref{bcf,,ModuleNotFoundError}.

@menu
* La caché del módulo:: 
* Buscadores y cargadores:: 
* Ganchos de importación:: 
* La meta ruta (path): La meta ruta path. 

@end menu

@node La caché del módulo,Buscadores y cargadores,,Buscando
@anchor{reference/import the-module-cache}@anchor{1ff2}
@subsubsection La caché del módulo


@geindex sys.modules

El primer lugar comprobado durante la búsqueda de importación es @ref{1976,,sys.modules}.  Esta asignación sirve como caché de todos los módulos que se han importado previamente, incluidas las rutas intermedias.  Por lo tanto, si @code{foo.bar.baz} se importó previamente, @ref{1976,,sys.modules} contendrá entradas para @code{foo}, @code{foo.bar}, y @code{foo.bar.baz}.  Cada clave tendrá como valor el objeto de módulo correspondiente.

Durante la importación, el nombre del módulo se busca en @ref{1976,,sys.modules} y si está presente, el valor asociado es el módulo que satisface la importación y el proceso se completa.  Sin embargo, si el valor es @code{None}, se genera un @ref{bcf,,ModuleNotFoundError}.  Si falta el nombre del módulo, Python continuará buscando el módulo.

@ref{1976,,sys.modules} se puede escribir.  La eliminación de una clave no puede destruir el módulo asociado (ya que otros módulos pueden contener referencias a él), pero invalidará la entrada de caché para el módulo con nombre, lo que hará que Python busque de nuevo el módulo con nombre en su próxima importación. La clave también se puede asignar a @code{None}, lo que obliga a la siguiente importación del módulo a dar como resultado un @ref{bcf,,ModuleNotFoundError}.

Tenga cuidado, sin embargo, como si mantiene una referencia al objeto module, invalide su entrada de caché en @ref{1976,,sys.modules} y, a continuación, vuelva a importar el módulo con nombre, los dos objetos de módulo `no' serán los mismos. Por el contrario, @ref{5bd,,importlib.reload()} reutilizará el objeto de módulo `same' y simplemente reinicializará el contenido del módulo volviendo a ejecutar el código del módulo.

@node Buscadores y cargadores,Ganchos de importación,La caché del módulo,Buscando
@anchor{reference/import finders-and-loaders}@anchor{1ff3}@anchor{reference/import id2}@anchor{1ff4}
@subsubsection Buscadores y cargadores


@geindex buscador
@geindex loader
@geindex module spec

Si el módulo con nombre no se encuentra en @ref{1976,,sys.modules}, se invoca el protocolo de importación de Python para buscar y cargar el módulo.  Este protocolo consta de dos objetos conceptuales, @ref{1f1c,,buscadores} y @ref{16b8,,cargadores}. El trabajo de un buscador es determinar si puede encontrar el módulo con nombre utilizando cualquier estrategia que conozca. Los objetos que implementan ambas interfaces se conocen como @ref{1ff5,,importadores} se retornan a sí mismos cuando descubren que pueden cargar el módulo solicitado.

Python incluye una serie de buscadores e importadores predeterminados.  El primero sabe cómo localizar módulos integrados, y el segundo sabe cómo localizar módulos congelados.  Un tercer buscador predeterminado busca módulos en @ref{1ff6,,import path}.  El @ref{1ff6,,import path} es una lista de ubicaciones que pueden nombrar rutas del sistema de archivos o archivos zip.  También se puede ampliar para buscar cualquier recurso localizable, como los identificados por las direcciones URL.

La maquinaria de importación es extensible, por lo que se pueden añadir nuevos buscadores para ampliar el alcance y el alcance de la búsqueda de módulos.

En realidad, los buscadores no cargan módulos.  Si pueden encontrar el módulo con nombre, retornan un `module spec', una encapsulación de la información relacionada con la importación del módulo, que la maquinaria de importación utiliza al cargar el módulo.

En las secciones siguientes se describe el protocolo para buscadores y cargadores con más detalle, incluido cómo puede crear y registrar otros nuevos para ampliar la maquinaria de importación.


Distinto en la versión 3.4: En versiones anteriores de Python, los buscadores retornaban @ref{16b8,,cargadores} directamente, mientras que ahora retornen especificaciones de módulo que `contienen' cargadores. Los cargadores todavía se utilizan durante la importación, pero tienen menos responsabilidades.


@node Ganchos de importación,La meta ruta path,Buscadores y cargadores,Buscando
@anchor{reference/import import-hooks}@anchor{1ff7}
@subsubsection Ganchos de importación


@geindex import hooks
@geindex meta hooks
@geindex path hooks
@geindex ganchos;import
@geindex ganchos;meta
@geindex ganchos;path

La maquinaria de importación está diseñada para ser extensible; el mecanismo principal para esto son los `ganchos de importación' (import hooks).  Hay dos tipos de ganchos de importación: `meta hooks' (meta ganchos) y `import path hooks' (ganchos de ruta de acceso de importación).

Los meta ganchos se llaman al inicio del procesamiento de importación, antes de que se haya producido cualquier otro procesamiento de importación, que no sea búsqueda de caché de @ref{1976,,sys.modules}. Esto permite que los metaganchos reemplacen el procesamiento de @ref{27e,,sys.path}, módulos congelados o incluso módulos integrados.  Los meta ganchos se registran agregando nuevos objetos de buscador a @ref{db2,,sys.meta_path}, como se describe a continuación.

Los ganchos de ruta de acceso de importación se invocan como parte del procesamiento @ref{27e,,sys.path} (o @code{package.__path__}), en el punto donde se encuentra su elemento de ruta de acceso asociado. Los ganchos de ruta de acceso de importación se registran agregando nuevos invocables a @ref{10a0,,sys.path_hooks} como se describe a continuación.

@node La meta ruta path,,Ganchos de importación,Buscando
@anchor{reference/import the-meta-path}@anchor{1ff8}
@subsubsection La meta ruta (`path')


@geindex sys.meta_path
@geindex buscador;find_spec

When the named module is not found in @ref{1976,,sys.modules}, Python next
searches @ref{db2,,sys.meta_path}, which contains a list of meta path finder
objects.  These finders are queried in order to see if they know how to handle
the named module.  Meta path finders must implement a method called
@ref{8ff,,find_spec()} which takes three arguments:
a name, an import path, and (optionally) a target module.  The meta path
finder can use any strategy it wants to determine whether it can handle
the named module or not.

Si el buscador de metarutas sabe cómo controlar el módulo con nombre, retorna un objeto de especificación.  Si no puede controlar el módulo con nombre, retorna @code{None}.  Si el procesamiento de @ref{db2,,sys.meta_path} llega al final de su lista sin retornar una especificación, se genera un @ref{bcf,,ModuleNotFoundError}.  Cualquier otra excepción provocada simplemente se propaga hacia arriba, anulando el proceso de importación.

The @ref{8ff,,find_spec()} method of meta path
finders is called with two or three arguments.  The first is the fully
qualified name of the module being imported, for example @code{foo.bar.baz}.
The second argument is the path entries to use for the module search.  For
top-level modules, the second argument is @code{None}, but for submodules or
subpackages, the second argument is the value of the parent package’s
@code{__path__} attribute. If the appropriate @code{__path__} attribute cannot
be accessed, a @ref{bcf,,ModuleNotFoundError} is raised.  The third argument
is an existing module object that will be the target of loading later.
The import system passes in a target module only during reload.

La metaruta se puede recorrer varias veces para una sola solicitud de importación. Por ejemplo, suponiendo que ninguno de los módulos implicados ya se haya almacenado en caché, la importación de @code{foo.bar.baz} realizará primero una importación de nivel superior, llamando a @code{mpf.find_spec("foo", None, None)} en cada buscador de metarutas (@code{mpf}). Después de importar @code{foo} , @code{foo.bar} se importará atravesando la meta ruta por segunda vez, llamando a @code{mpf.find_spec("foo.bar", foo.__path__, None)}. Una vez importado @code{foo.bar}, el recorrido final llamará a @code{mpf.find_spec("foo.bar.baz", foo.bar.__path__, None)}.

Algunos buscadores de metarutas solo admiten importaciones de nivel superior. Estos importadores siempre retornarán @code{None} cuando se pase algo distinto de @code{None} como segundo argumento.

El valor predeterminado de Python @ref{db2,,sys.meta_path} tiene tres buscadores de metarutas, uno que sabe cómo importar módulos integrados, uno que sabe cómo importar módulos congelados y otro que sabe cómo importar módulos desde un @ref{1ff6,,import path} (es decir, el @ref{1ff9,,path based finder}).


Distinto en la versión 3.4: The @ref{8ff,,find_spec()} method of meta path
finders replaced @code{find_module()}, which
is now deprecated.  While it will continue to work without change, the
import machinery will try it only if the finder does not implement
@ref{8ff,,find_spec()}.



Distinto en la versión 3.10: Use of @code{find_module()} by the import system
now raises @ref{59f,,ImportWarning}.



Distinto en la versión 3.12: @code{find_module()} has been removed.
Use @ref{8ff,,find_spec()} instead.


@node Cargando,El buscador basado en rutas,Buscando,El sistema de importación
@anchor{reference/import loading}@anchor{1ffa}
@subsection Cargando


Si se encuentra una especificación de módulo, la maquinaria de importación la utilizará (y el cargador que contiene) al cargar el módulo.  Aquí está una aproximación de lo que sucede durante la porción de carga de la importación:

@example
module = None
if spec.loader is not None and hasattr(spec.loader, 'create_module'):
    # It is assumed 'exec_module' will also be defined on the loader.
    module = spec.loader.create_module(spec)
if module is None:
    module = ModuleType(spec.name)
# The import-related module attributes get set here:
_init_module_attrs(spec, module)

if spec.loader is None:
    # unsupported
    raise ImportError
if spec.origin is None and spec.submodule_search_locations is not None:
    # namespace package
    sys.modules[spec.name] = module
elif not hasattr(spec.loader, 'exec_module'):
    module = spec.loader.load_module(spec.name)
else:
    sys.modules[spec.name] = module
    try:
        spec.loader.exec_module(module)
    except BaseException:
        try:
            del sys.modules[spec.name]
        except KeyError:
            pass
        raise
return sys.modules[spec.name]
@end example

Tenga en cuenta los siguientes detalles:


@itemize *

@item 
Si hay un objeto de módulo existente con el nombre dado en @ref{1976,,sys.modules}, la importación ya lo habrá retornado.

@item 
El módulo existirá en @ref{1976,,sys.modules} antes de que el cargador ejecute el código del módulo.  Esto es crucial porque el código del módulo puede (directa o indirectamente) importarse a sí mismo; agregándolo a @ref{1976,,sys.modules} de antemano evita la recursividad sin límites en el peor de los casos y la carga múltiple en el mejor.

@item 
Si se produce un error en la carga, el módulo con errores – y solo el módulo con errores – se elimina de @ref{1976,,sys.modules}.  Cualquier módulo que ya esté en la caché de @ref{1976,,sys.modules} y cualquier módulo que se haya cargado correctamente como efecto secundario, debe permanecer en la memoria caché.  Esto contrasta con la recarga donde incluso el módulo que falla se deja en @ref{1976,,sys.modules}.

@item 
Después de crear el módulo pero antes de la ejecución, la maquinaria de importación establece los atributos del módulo relacionados con la importación («_init_module_attrs» en el ejemplo de pseudocódigo anterior), como se resume en una @ref{1f13,,sección posterior}.

@item 
La ejecución del módulo es el momento clave de la carga en el que se rellena el espacio de nombres del módulo.  La ejecución se delega por completo en el cargador, lo que llega a decidir qué se rellena y cómo.

@item 
El módulo creado durante la carga y pasado a exec_module() puede no ser el que se retorna al final de la importación @footnote{
La implementación de importlib evita usar el valor retornado directamente. En su lugar, obtiene el objeto module buscando el nombre del módulo en @ref{1976,,sys.modules}.  El efecto indirecto de esto es que un módulo importado puede sustituirse a sí mismo en @ref{1976,,sys.modules}.  Este es un comportamiento específico de la implementación que no se garantiza que funcione en otras implementaciones de Python.
}.
@end itemize


Distinto en la versión 3.4: El sistema de importación se ha hecho cargo de las responsabilidades reutilizables de los cargadores.  Estos fueron realizados previamente por el método @ref{900,,importlib.abc.Loader.load_module()}.


@menu
* Cargadores:: 
* Submódulos:: 
* Module specs:: 
* __path__ attributes on modules:: 
* Representación (Reprs) de módulos: Representación Reprs de módulos. 
* Invalidación del código de bytes en caché:: 

@end menu

@node Cargadores,Submódulos,,Cargando
@anchor{reference/import loaders}@anchor{1ffb}
@subsubsection Cargadores


Los cargadores de módulos proporcionan la función crítica de carga: ejecución del módulo. La maquinaria de importación llama al método @ref{901,,importlib.abc.Loader.exec_module()} con un único argumento, el objeto module que se va a ejecutar.  Se omite cualquier valor retornado de @ref{901,,exec_module()}.

Los cargadores deben cumplir los siguientes requisitos:


@itemize *

@item 
Si el módulo es un módulo Python (a diferencia de un módulo integrado o una extensión cargada dinámicamente), el cargador debe ejecutar el código del módulo en el espacio de nombres global del módulo (@code{module.__dict__}).

@item 
Si el cargador no puede ejecutar el módulo, debe generar un @ref{4d7,,ImportError}, aunque se propagará cualquier otra excepción provocada durante @ref{901,,exec_module()}.
@end itemize

En muchos casos, el buscador y el cargador pueden ser el mismo objeto; en tales casos, el método @ref{8ff,,find_spec()} simplemente retornaría una especificación con el cargador establecido en @code{self}.

Los cargadores de módulos pueden optar por crear el objeto de módulo durante la carga mediante la implementación de un método @ref{d37,,create_module()}. Toma un argumento, la especificación del módulo, y retorna el nuevo objeto de módulo que se usará durante la carga.  @code{create_module()} no necesita establecer ningún atributo en el objeto module.  Si el método retorna @code{None}, la maquinaria de importación creará el nuevo módulo en sí.


Added in version 3.4: El método de cargadores @ref{d37,,create_module()}.



Distinto en la versión 3.4: El método @ref{900,,load_module()} fue reemplazado por @ref{901,,exec_module()} y la maquinaria de importación asumió todas las responsabilidades reutilizables de la carga.

Para la compatibilidad con los cargadores existentes, la maquinaria de importación utilizará el método de cargadores @code{load_module()} si existe y el cargador no implementa también @code{exec_module()}.  Sin embargo, @code{load_module()} ha quedado obsoleto y los cargadores deben implementar @code{exec_module()} en su lugar.

El método @code{load_module()} debe implementar toda la funcionalidad de carga reutilizable descrita anteriormente, además de ejecutar el módulo.  Se aplican todas las mismas restricciones, con algunas aclaraciones adicionales:


@itemize *

@item 
Si hay un objeto de módulo existente con el nombre dado en @ref{1976,,sys.modules}, el cargador debe utilizar ese módulo existente. (De lo contrario, @ref{5bd,,importlib.reload()} no funcionará correctamente.)  Si el módulo con nombre no existe en @ref{1976,,sys.modules}, el cargador debe crear un nuevo objeto de módulo y agregarlo a @ref{1976,,sys.modules}.

@item 
El módulo `debe' existir en @ref{1976,,sys.modules} antes de que el cargador ejecute el código del módulo, para evitar la recursividad sin límites o la carga múltiple.

@item 
Si se produce un error en la carga, el cargador debe quitar los módulos que ha insertado en @ref{1976,,sys.modules}, pero debe quitar `solo' los módulos con errores, y solo si el propio cargador ha cargado los módulos explícitamente.
@end itemize



Distinto en la versión 3.5: A @ref{1da,,DeprecationWarning} se genera cuando se define @code{exec_module()} pero @code{create_module()} no lo es.



Distinto en la versión 3.6: Un @ref{4d7,,ImportError} se genera cuando @code{exec_module()} está definido, pero @code{create_module()} no lo es.



Distinto en la versión 3.10: El uso de @code{load_module()} lanzará @ref{59f,,ImportWarning}.


@node Submódulos,Module specs,Cargadores,Cargando
@anchor{reference/import submodules}@anchor{1ffc}
@subsubsection Submódulos


Cuando se carga un submódulo mediante cualquier mecanismo (por ejemplo, API @code{importlib}, las instrucciones @code{import} o @code{import-from}, o @code{__import__()}) integradas, se coloca un enlace en el espacio de nombres del módulo primario al objeto submodule. Por ejemplo, si el paquete @code{spam} tiene un submódulo @code{foo}, después de importar @code{spam.foo}, @code{spam} tendrá un atributo @code{foo} que está enlazado al submódulo.  Supongamos que tiene la siguiente estructura de directorios:

@example
spam/
    __init__.py
    foo.py
@end example

y @code{spam/__init__.py} tiene la siguiente línea:

@example
from .foo import Foo
@end example

a continuación, la ejecución de lo siguiente pone un nombre vinculante para @code{foo} y @code{Foo} en el módulo @code{spam}:

@example
>>> import spam
>>> spam.foo
<module 'spam.foo' from '/tmp/imports/spam/foo.py'>
>>> spam.Foo
<class 'spam.foo.Foo'>
@end example

Dadas las reglas de enlace de nombres familiares de Python, esto puede parecer sorprendente, pero en realidad es una característica fundamental del sistema de importación.  La retención invariable es que si tiene @code{sys.modules[`spam`]} y @code{sys.modules[`spam.foo`]} (como lo haría después de la importación anterior), este último debe aparecer como el atributo @code{foo} de la primera.

@node Module specs,__path__ attributes on modules,Submódulos,Cargando
@anchor{reference/import id4}@anchor{1ffd}@anchor{reference/import module-specs}@anchor{1f18}
@subsubsection Module specs


La maquinaria de importación utiliza una variedad de información sobre cada módulo durante la importación, especialmente antes de la carga.  La mayor parte de la información es común a todos los módulos.  El propósito de las especificaciones de un módulo es encapsular esta información relacionada con la importación por módulo.

El uso de una especificación durante la importación permite transferir el estado entre los componentes del sistema de importación, por ejemplo, entre el buscador que crea la especificación del módulo y el cargador que la ejecuta.  Lo más importante es que permite a la maquinaria de importación realizar las operaciones de caldera de carga, mientras que sin una especificación de módulo el cargador tenía esa responsabilidad.

The module’s spec is exposed as @ref{1f16,,module.__spec__}. Setting
@code{__spec__} appropriately applies equally to
@ref{1ffe,,modules initialized during interpreter startup}.
The one exception is @code{__main__}, where @code{__spec__} is
@ref{1fff,,set to None in some cases}.

See @ref{1e69,,ModuleSpec} for details on the contents of
the module spec.


Added in version 3.4.


@node __path__ attributes on modules,Representación Reprs de módulos,Module specs,Cargando
@anchor{reference/import package-path-rules}@anchor{1f19}@anchor{reference/import path-attributes-on-modules}@anchor{2000}
@subsubsection __path__ attributes on modules


The @ref{1c74,,__path__} attribute should be a (possibly empty)
@ref{597,,sequence} of strings enumerating the locations where the package’s
submodules will be found. By definition, if a module has a @code{__path__}
attribute, it is a @ref{185,,package}.

A package’s @ref{1c74,,__path__} attribute is used during imports of its
subpackages.
Within the import machinery, it functions much the same as @ref{27e,,sys.path},
i.e. providing a list of locations to search for modules during import.
However, @code{__path__} is typically much more constrained than
@code{sys.path}.

The same rules used for @ref{27e,,sys.path} also apply to a package’s
@code{__path__}. @ref{10a0,,sys.path_hooks} (described below) are
consulted when traversing a package’s @code{__path__}.

A package’s @code{__init__.py} file may set or alter the package’s
@ref{1c74,,__path__}
attribute, and this was typically the way namespace packages were implemented
prior to 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}.  With the adoption of 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}, namespace packages no
longer need to supply @code{__init__.py} files containing only @code{__path__}
manipulation code; the import machinery automatically sets @code{__path__}
correctly for the namespace package.

@node Representación Reprs de módulos,Invalidación del código de bytes en caché,__path__ attributes on modules,Cargando
@anchor{reference/import module-reprs}@anchor{2001}
@subsubsection Representación (`Reprs') de módulos


De forma predeterminada, todos los módulos tienen un repr utilizable, sin embargo, dependiendo de los atributos establecidos anteriormente, y en las especificaciones del módulo, puede controlar más explícitamente el repr de los objetos de módulo.

Si el módulo tiene una especificación (@code{__spec__}), la maquinaria de importación intentará generar un repr a partir de él.  Si eso falla o no hay ninguna especificación, el sistema de importación creará un repr predeterminado usando cualquier información disponible en el módulo.  Intentará utilizar el @code{module.__name__}, @code{module.__file__} y @code{module.__loader__} como entrada en el repr, con valores predeterminados para cualquier información que falte.

Aquí están las reglas exactas utilizadas:


@itemize *

@item 
Si el módulo tiene un atributo @code{__spec__}, la información de la especificación se utiliza para generar el repr.  Se consultan los atributos «name», «loader», «origin» y «has_location».

@item 
Si el módulo tiene un atributo @code{__file__}, se utiliza como parte del repr del módulo.

@item 
Si el módulo no tiene @code{__file__} pero tiene un @code{__loader__} que no es @code{None}, entonces el repr del cargador se utiliza como parte del repr del módulo.

@item 
De lo contrario, sólo tiene que utilizar el @code{__name__} del módulo en el repr.
@end itemize


Distinto en la versión 3.12: El uso de @code{module_repr()}, al ser obsoleto desde Python 3.4, fue eliminado en Python 3.12 y no es llamado durante la resolución de la representación (repr) de un módulo.


@node Invalidación del código de bytes en caché,,Representación Reprs de módulos,Cargando
@anchor{reference/import cached-bytecode-invalidation}@anchor{2002}@anchor{reference/import pyc-invalidation}@anchor{68c}
@subsubsection Invalidación del código de bytes en caché


Antes de que Python cargue el código de bytes en caché de un archivo @code{.pyc}, verifica si el caché está actualizado con el archivo @code{.py} de origen. De forma predeterminada, Python hace esto almacenando la marca de tiempo y el tamaño de la última modificación de la fuente en el archivo de caché al escribirlo. En tiempo de ejecución, el sistema de importación valida el archivo de caché comprobando los metadatos almacenados en el archivo de caché con los metadatos de la fuente.

Python también admite archivos de caché «basados en hash», que almacenan un hash del contenido del archivo de origen en lugar de sus metadatos. Hay dos variantes de archivos @code{.pyc} basados en hash: marcados y desmarcados. Para los archivos @code{.pyc} marcados basados en hash, Python valida el archivo de caché mediante el hash del archivo de origen y la comparación del hash resultante con el hash en el archivo de caché. Si se encuentra que un archivo de caché basado en hash comprobado no es válido, Python lo regenera y escribe un nuevo archivo de caché basado en hash comprobado. Para los archivos @code{.pyc} sin marcar en hash, Python simplemente asume que el archivo de caché es válido si existe. El comportamiento de validación de archivos basado en hash @code{.pyc} se puede invalidar con el indicador @ref{1d36,,--check-hash-based-pycs}.


Distinto en la versión 3.7: Se han añadido archivos @code{.pyc} basados en hash. Anteriormente, Python solo admitía la invalidación basada en la marca de tiempo de la caché del código de bytes.


@node El buscador basado en rutas,Reemplazando el sistema de importación estándar,Cargando,El sistema de importación
@anchor{reference/import the-path-based-finder}@anchor{2003}
@subsection El buscador basado en rutas


@geindex path based finder

Como se mencionó anteriormente, Python viene con varios buscadores de meta rutas predeterminados. Uno de ellos, llamado el buscador @ref{1ff9,,path based finder} (@ref{109f,,PathFinder}), busca una @ref{1ff6,,import path}, que contiene una lista de @ref{2004,,entradas de ruta}. Cada entrada de ruta de acceso nombra una ubicación para buscar módulos.

El buscador basado en rutas en sí no sabe cómo importar nada. En su lugar, atraviesa las entradas de ruta individuales, asociando cada una de ellas con un buscador de entrada de ruta que sabe cómo manejar ese tipo particular de ruta de acceso.

El conjunto predeterminado de buscadores de entradas de ruta implementa toda la semántica para encontrar módulos en el sistema de archivos, controlando tipos de archivos especiales como el código fuente de Python (archivos @code{`.py}), el código de bytes de Python (archivos @code{.pyc}) y las bibliotecas compartidas (por ejemplo, archivos @code{.so`}). Cuando es compatible con el módulo @ref{131,,zipimport} en la biblioteca estándar, los buscadores de entradas de ruta de acceso predeterminados también controlan la carga de todos estos tipos de archivo (excepto las bibliotecas compartidas) desde zipfiles.

Las entradas de ruta de acceso no deben limitarse a las ubicaciones del sistema de archivos.  Pueden hacer referencia a direcciones URL, consultas de base de datos o cualquier otra ubicación que se pueda especificar como una cadena.

El buscador basado en rutas proporciona enlaces y protocolos adicionales para que pueda ampliar y personalizar los tipos de entradas de ruta de acceso que se pueden buscar.  Por ejemplo, si desea admitir entradas de ruta de acceso como direcciones URL de red, podría escribir un enlace que implemente la semántica HTTP para buscar módulos en la web.  Este gancho (un al que se puede llamar) retornaría un @ref{10ed,,path entry finder} compatible con el protocolo descrito a continuación, que luego se utilizó para obtener un cargador para el módulo de la web.

Una palabra de advertencia: esta sección y la anterior utilizan el término `finder', distinguiendo entre ellos utilizando los términos @ref{10ec,,meta path finder} y @ref{10ed,,path entry finder}.  Estos dos tipos de buscadores son muy similares, admiten protocolos similares y funcionan de maneras similares durante el proceso de importación, pero es importante tener en cuenta que son sutilmente diferentes. En particular, los buscadores de meta path operan al principio del proceso de importación, como se indica en el recorrido @ref{db2,,sys.meta_path}.

Por el contrario, los buscadores de entradas de ruta son en cierto sentido un detalle de implementación del buscador basado en rutas y, de hecho, si el buscador basado en rutas se eliminara de @ref{db2,,sys.meta_path}, no se invocaría ninguna semántica del buscador de entradas de ruta.

@menu
* Buscadores de entradas de ruta:: 
* Buscadores de entradas de ruta: Buscadores de entradas de ruta<2>. 

@end menu

@node Buscadores de entradas de ruta,Buscadores de entradas de ruta<2>,,El buscador basado en rutas
@anchor{reference/import path-entry-finders}@anchor{2005}
@subsubsection Buscadores de entradas de ruta


@geindex sys.path
@geindex sys.path_hooks
@geindex sys.path_importer_cache
@geindex PYTHONPATH

El @ref{1ff9,,path based finder} es responsable de encontrar y cargar módulos y paquetes de Python cuya ubicación se especifica con una cadena @ref{2004,,path entry}.  La mayoría de las ubicaciones de nombres de entradas de ruta de acceso en el sistema de archivos, pero no es necesario limitarlas a esto.

Como buscador de meta rutas, el buscador @ref{1ff9,,path based finder} implementa el protocolo @ref{8ff,,find_spec()} descrito anteriormente, sin embargo, expone enlaces adicionales que se pueden usar para personalizar cómo se encuentran y cargan los módulos desde la ruta @ref{1ff6,,import path}.

Tres variables son usadas por @ref{1ff9,,path based finder}, @ref{27e,,sys.path}, @ref{10a0,,sys.path_hooks} y @ref{684,,sys.path_importer_cache}.  También se utilizan los atributos @code{__path__} en los objetos de paquete.  Estos proporcionan formas adicionales de personalizar la maquinaria de importación.

@ref{27e,,sys.path} contains a list of strings providing search locations for
modules and packages.  It is initialized from the 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}
environment variable and various other installation- and
implementation-specific defaults.  Entries in @ref{27e,,sys.path} can name
directories on the file system, zip files, and potentially other «locations»
(see the @ref{c7,,site} module) that should be searched for modules, such as
URLs, or database queries.  Only strings should be present on
@ref{27e,,sys.path}; all other data types are ignored.

El buscador @ref{1ff9,,path based finder} es un @ref{10ec,,meta path finder}, por lo que la maquinaria de importación comienza la búsqueda @ref{1ff6,,import path} llamando al método @ref{108d,,find_spec()} basado en la ruta de acceso, tal como se describió anteriormente.  Cuando se proporciona el argumento @code{path} a @ref{108d,,find_spec()}, será una lista de rutas de acceso de cadena para recorrer - normalmente el atributo @code{__path__} de un paquete para una importación dentro de ese paquete.  Si el argumento @code{path} es @code{None}, esto indica una importación de nivel superior y se utiliza @ref{27e,,sys.path}.

The path based finder iterates over every entry in the search path, and
for each of these, looks for an appropriate @ref{10ed,,path entry finder}
(@ref{906,,PathEntryFinder}) for the
path entry.  Because this can be an expensive operation (e.g. there may be
@code{stat()} call overheads for this search), the path based finder maintains
a cache mapping path entries to path entry finders.  This cache is maintained
in @ref{684,,sys.path_importer_cache} (despite the name, this cache actually
stores finder objects rather than being limited to @ref{1ff5,,importer} objects).
In this way, the expensive search for a particular @ref{2004,,path entry}
location’s @ref{10ed,,path entry finder} need only be done once.  User code is
free to remove cache entries from @ref{684,,sys.path_importer_cache} forcing
the path based finder to perform the path entry search again.

Si la entrada de ruta de acceso no está presente en la memoria caché, el buscador basado en rutas de acceso recorre en iteración cada llamada que se puede llamar en @ref{10a0,,sys.path_hooks}.  Cada uno de los enlaces de @ref{2006,,ganchos de rutas de entrada} en esta lista se llama con un solo argumento, la entrada de ruta de acceso que se va a buscar.  Esta invocable puede retornar un @ref{10ed,,path entry finder} que puede controlar la entrada de ruta de acceso, o puede generar @ref{4d7,,ImportError}.  Un @ref{4d7,,ImportError} es utilizado por el buscador basado en ruta para indicar que el gancho no puede encontrar un @ref{10ed,,path entry finder} para eso @ref{2004,,entrada de ruta}.  Se omite la excepción y la iteración @ref{1ff6,,import path} continúa.  El enlace debe esperar un objeto de rutas o bytes; la codificación de objetos bytes está hasta el enlace (por ejemplo, puede ser una codificación del sistema de archivos, UTF-8, o algo más), y si el gancho no puede decodificar el argumento, debe generar @ref{4d7,,ImportError}.

Si la iteración @ref{10a0,,sys.path_hooks} termina sin que se retorne ningún valor @ref{10ed,,path entry finder}, a continuación, el método de búsqueda basado en la ruta de acceso @ref{108d,,find_spec()} almacenará @code{None} en @ref{684,,sys.path_importer_cache} (para indicar que no hay ningún buscador para esta entrada de ruta) y retornará @code{None}, lo que indica que este @ref{10ec,,meta path finder} no pudo encontrar el módulo.

Si un @ref{10ed,,path entry finder} `is' retornado por uno de los @ref{2006,,path entry hook} invocables en @ref{10a0,,sys.path_hooks}, entonces el siguiente protocolo se utiliza para pedir al buscador una especificación de módulo, que luego se utiliza al cargar el módulo.

El directorio de trabajo actual, denotado por una cadena vacía, se controla de forma ligeramente diferente de otras entradas de @ref{27e,,sys.path}. En primer lugar, si se encuentra que el directorio de trabajo actual no existe, no se almacena ningún valor en @ref{684,,sys.path_importer_cache}. En segundo lugar, el valor del directorio de trabajo actual se busca actualizado para cada búsqueda de módulo. En tercer lugar, la ruta de acceso utilizada para @ref{684,,sys.path_importer_cache} y retornada por @ref{108d,,importlib.machinery.PathFinder.find_spec()} será el directorio de trabajo actual real y no la cadena vacía.

@node Buscadores de entradas de ruta<2>,,Buscadores de entradas de ruta,El buscador basado en rutas
@anchor{reference/import path-entry-finder-protocol}@anchor{2007}
@subsubsection Buscadores de entradas de ruta


Para admitir las importaciones de módulos y paquetes inicializados y también para contribuir con partes a paquetes de espacio de nombres, los buscadores de entradas de ruta de acceso deben implementar el método @ref{903,,importlib.abc.PathEntryFinder.find_spec()}.

@code{importlib.abc.PathEntryFinder.find_spec`()} toma dos argumentos: el nombre completo del módulo que se va a importar y el módulo de destino (opcional).  @code{find_spec()} retorna una especificación completamente poblada para el módulo. Esta especificación siempre tendrá «cargador» establecido (con una excepción).

To indicate to the import machinery that the spec represents a namespace
@ref{1ff0,,portion}, the path entry finder sets @code{submodule_search_locations} to
a list containing the portion.


Distinto en la versión 3.4: @ref{903,,find_spec()} replaced
@code{find_loader()} and
@code{find_module()}, both of which
are now deprecated, but will be used if @code{find_spec()} is not defined.

Los buscadores de entradas de ruta más antiguos pueden implementar uno de estos dos métodos en desuso en lugar de @code{find_spec()}.  Los métodos todavía se respetan en aras de la compatibilidad con versiones anteriores.  Sin embargo, si @code{find_spec()} se implementa en el buscador de entrada de ruta, se omiten los métodos heredados.

@code{find_loader()} takes one argument, the
fully qualified name of the module being imported.  @code{find_loader()}
returns a 2-tuple where the first item is the loader and the second item
is a namespace @ref{1ff0,,portion}.

Para la compatibilidad con versiones anteriores con otras implementaciones del protocolo de importación, muchos buscadores de entradas de ruta de acceso también admiten el mismo método tradicional @code{find_module()} que admiten los buscadores de rutas de acceso meta. Sin embargo, nunca se llama a los métodos del buscador de entradas de ruta @code{find_module()} con un argumento @code{path} (se espera que registren la información de ruta adecuada desde la llamada inicial al enlace de ruta).

El método @code{find_module()} en los buscadores de entrada de ruta está en desuso, ya que no permite que el buscador de entradas de ruta de acceso aporte partes a paquetes de espacio de nombres.  Si existen tanto @code{find_loader()} como @code{find_module()} en un buscador de entrada de ruta, el sistema de importación siempre llamará a @code{find_loader()} en lugar de @code{find_module()}.



Distinto en la versión 3.10: Calls to @code{find_module()} and
@code{find_loader()} by the import
system will raise @ref{59f,,ImportWarning}.



Distinto en la versión 3.12: Los métodos @code{find_module()} y @code{find_loader()} fueron eliminados.


@node Reemplazando el sistema de importación estándar,Paquete Importaciones relativas,El buscador basado en rutas,El sistema de importación
@anchor{reference/import replacing-the-standard-import-system}@anchor{2008}
@subsection Reemplazando el sistema de importación estándar


El mecanismo más confiable para reemplazar todo el sistema de importación es eliminar el contenido predeterminado de @ref{db2,,sys.meta_path}, sustituyéndolos por completo por un enlace de meta path personalizado.

Si es aceptable alterar únicamente el comportamiento de las declaraciones de importación sin afectar a otras API que acceden al sistema de importación, puede ser suficiente reemplazar la función incorporada @ref{96b,,__import__()}. Esta técnica también puede emplearse a nivel de módulo para alterar únicamente el comportamiento de las declaraciones de importación dentro de ese módulo.

Para evitar selectivamente la importación de algunos módulos de un enlace al principio de la meta path (en lugar de deshabilitar completamente el sistema de importación estándar), es suficiente elevar @ref{bcf,,ModuleNotFoundError} directamente desde @ref{8ff,,find_spec()} en lugar de retornar @code{None}. Este último indica que la búsqueda de meta path debe continuar, mientras que la generación de una excepción termina inmediatamente.

@node Paquete Importaciones relativas,Consideraciones especiales para __main__,Reemplazando el sistema de importación estándar,El sistema de importación
@anchor{reference/import package-relative-imports}@anchor{2009}@anchor{reference/import relativeimports}@anchor{200a}
@subsection Paquete Importaciones relativas


Las importaciones relativas utilizan puntos iniciales. Un único punto inicial indica una importación relativa, empezando por el paquete actual. Dos o más puntos iniciales indican una importación relativa a los elementos primarios del paquete actual, un nivel por punto después del primero. Por ejemplo, dado el siguiente diseño de paquete:

@example
package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py
@end example

En @code{subpackage1/moduleX.py} o @code{subpackage1/__init__.py}, las siguientes son importaciones relativas válidas:

@example
from .moduleY import spam
from .moduleY import spam as ham
from . import moduleY
from ..subpackage1 import moduleY
from ..subpackage2.moduleZ import eggs
from ..moduleA import foo
@end example

Las importaciones absolutas pueden utilizar la sintaxis @code{import <>} o @code{from <> import <>}, pero las importaciones relativas solo pueden usar el segundo formulario; la razón de esto es que:

@example
import XXX.YYY.ZZZ
@end example

debe exponer @code{XXX. Yyy. ZZZ} como una expresión utilizable, pero .moduleY no es una expresión válida.

@node Consideraciones especiales para __main__,Referencias,Paquete Importaciones relativas,El sistema de importación
@anchor{reference/import import-dunder-main}@anchor{200b}@anchor{reference/import special-considerations-for-main}@anchor{200c}
@subsection Consideraciones especiales para __main__


El módulo @ref{1,,__main__} es un caso especial relativo al sistema de importación de Python. Como se señaló @ref{1ffe,,elsewhere}, el módulo @code{__main__} se inicializa directamente al inicio del intérprete, al igual que @ref{d9,,sys} y @ref{13,,builtins}. Sin embargo, a diferencia de esos dos, no califica estrictamente como un módulo integrado. Esto se debe a que la forma en que se inicializa @code{__main__} depende de las marcas y otras opciones con las que se invoca el intérprete.

@menu
* __main__.__spec__: __main__ __spec__. 

@end menu

@node __main__ __spec__,,,Consideraciones especiales para __main__
@anchor{reference/import id5}@anchor{200d}@anchor{reference/import main-spec}@anchor{1fff}
@subsubsection __main__.__spec__


Dependiendo de cómo se inicializa @ref{1,,__main__}, @code{__main__.__spec__} se establece correctamente o en @code{None}.

Cuando Python se inicia con la opción @ref{187,,-m}, @code{__spec__} se establece en la especificación de módulo del módulo o paquete correspondiente. @code{__spec__} también se rellena cuando el módulo @code{__main__} se carga como parte de la ejecución de un directorio, zipfile u otro @ref{27e,,sys.path} entrada.

En @ref{1d2f,,los casos restantes} @code{__main__.__spec__} se establece en @code{None}, ya que el código utilizado para rellenar el @ref{1,,__main__} no se corresponde directamente con un módulo importable:


@itemize -

@item 
mensaje interactivo

@item 
opción @ref{681,,-c}

@item 
ejecutando desde stdin

@item 
que se ejecuta directamente desde un archivo de código fuente o de código de bytes
@end itemize

Tenga en cuenta que @code{__main__.__spec__} siempre es @code{None} en el último caso, `incluso si' el archivo técnicamente podría importarse directamente como un módulo en su lugar. Utilice el modificador @ref{187,,-m} si se desean metadatos de módulo válidos en @ref{1,,__main__}.

Tenga en cuenta también que incluso cuando @code{__main__} corresponde a un módulo importable y @code{__main__.__spec__} se establece en consecuencia, todavía se consideran módulos `distinct'. Esto se debe al hecho de que los bloques protegidos por las comprobaciones @code{if __name__ == "__main__":} solo se ejecutan cuando el módulo se utiliza para rellenar el espacio de nombres @code{__main__}, y no durante la importación normal.

@node Referencias,,Consideraciones especiales para __main__,El sistema de importación
@anchor{reference/import references}@anchor{200e}
@subsection Referencias


La maquinaria de importación ha evolucionado considerablemente desde los primeros días de Python.  La especificación original para paquetes@footnote{https://www.python.org/doc/essays/packages/} todavía está disponible para leer, aunque algunos detalles han cambiado desde la escritura de ese documento.

La especificación original de @ref{db2,,sys.meta_path} era 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}, con posterior extensión en 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}.

@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} introduced @ref{1b8,,namespace packages} for
Python 3.3.  
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} also introduced the @code{find_loader()} protocol as an
alternative to @code{find_module()}.

@geindex Python Enhancement Proposals; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} describe la adición del atributo @code{__package__} para las importaciones relativas explícitas en los módulos principales.

@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} introdujo importaciones relativas absolutas y explícitas e inicialmente propuestas @code{__name__} para la semántica 
@geindex Python Enhancement Proposals; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} eventualmente especificaría para @code{__package__}.

@geindex Python Enhancement Proposals; PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} define la ejecución de módulos como scripts.

@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} agrega la encapsulación del estado de importación por módulo en los objetos de especificación. También descargara la mayoría de las responsabilidades de los cargadores en la maquinaria de importación. Estos cambios permiten el desuso de varias API en el sistema de importación y también la adición de nuevos métodos a los buscadores y cargadores.

@subsubheading Notas al Pie de Pagina


@node Expresiones,Declaraciones simples,El sistema de importación,Referencia del Lenguaje Python
@anchor{reference/expressions doc}@anchor{200f}@anchor{reference/expressions expressions}@anchor{2010}@anchor{reference/expressions id1}@anchor{2011}
@section Expresiones


@geindex expression
@geindex BNF

Este capítulo explica el significado de los elementos de expresiones en Python.

`Notas de Sintaxis:' En este y los siguientes capítulos será usada notación BNF extendida para describir sintaxis, no análisis léxico. Cuando (una alternativa de) una regla de sintaxis tiene la forma

@example
@anchor{reference/expressions grammar-token-python-grammar-name}@anchor{2012}name ::= othername
@end example

y no han sido dadas semánticas, las semánticas de esta forma de @code{name} son las mismas que para @code{othername}.

@menu
* Conversiones aritméticas:: 
* Átomos:: 
* Primarios:: 
* Expresión await:: 
* El operador de potencia:: 
* Aritmética unaria y operaciones bit a bit:: 
* Operaciones aritméticas binarias:: 
* Operaciones de desplazamiento:: 
* Operaciones bit a bit binarias:: 
* Comparaciones:: 
* Operaciones booleanas:: 
* Expresiones de asignación: Expresiones de asignación<2>. 
* Expresiones condicionales:: 
* Lambdas:: 
* Listas de expresiones:: 
* Orden de evaluación:: 
* Prioridad de operador:: 

@end menu

@node Conversiones aritméticas,Átomos,,Expresiones
@anchor{reference/expressions arithmetic-conversions}@anchor{2013}@anchor{reference/expressions conversions}@anchor{2014}
@subsection Conversiones aritméticas


@geindex arithmetic;conversion

Cuando una descripción de un operador aritmético a continuación usa la frase «los argumentos numéricos son convertidos a un tipo común», esto significa que la implementación de operador para tipos incorporados funciona de la siguiente forma:


@itemize *

@item 
Si cualquiera de los argumentos es un número complejo, el otro es convertido a complejo;

@item 
otherwise, if either argument is a floating-point number, the other is
converted to floating point;

@item 
de otra forma, ambos deben ser enteros y no se necesita conversión.
@end itemize

Algunas reglas adicionales aplican para ciertos operadores (ej., una cadena de caracteres como argumento a la izquierda del operador “%”). Las extensiones deben definir su comportamiento de conversión.

@node Átomos,Primarios,Conversiones aritméticas,Expresiones
@anchor{reference/expressions atoms}@anchor{2015}@anchor{reference/expressions id2}@anchor{2016}
@subsection Átomos


@geindex atom

Los átomos son los elementos más básicos de las expresiones. Los átomos más simples son identificadores o literales. Las formas encerradas en paréntesis, corchetes o llaves son también sintácticamente categorizadas como átomos. La sintaxis para átomos es:

@example
@anchor{reference/expressions grammar-token-python-grammar-atom}@anchor{2017}atom      ::= identifier | literal | enclosure
@anchor{reference/expressions grammar-token-python-grammar-enclosure}@anchor{2018}enclosure ::= parenth_form | list_display | dict_display | set_display
              | generator_expression | yield_atom
@end example

@menu
* Identificadores (Nombres): Identificadores Nombres. 
* Literales: Literales<2>. 
* Formas entre paréntesis:: 
* Despliegues para listas@comma{} conjuntos y diccionarios: Despliegues para listas conjuntos y diccionarios. 
* Despliegues de lista:: 
* Despliegues de conjuntos:: 
* Despliegues de diccionario:: 
* Expresiones de generador:: 
* Expresiones yield:: 

@end menu

@node Identificadores Nombres,Literales<2>,,Átomos
@anchor{reference/expressions atom-identifiers}@anchor{1ea0}@anchor{reference/expressions identifiers-names}@anchor{2019}
@subsubsection Identificadores (Nombres)


@geindex name
@geindex identifier

Un identificador encontrándose como un átomo es un nombre. Vea la sección @ref{1e94,,Identificadores y palabras clave} para la definición léxica y la sección @ref{1ef7,,Nombres y vínculos} para documentación de nombrar y vincular.

@geindex exception;NameError

Cuando el nombre es vinculado a un objeto, la evaluación del átomo produce ese objeto. Cuando un nombre no es vinculado, un intento de evaluarlo genera una excepción @ref{4ec,,NameError}.

@geindex name;mangling
@geindex private;names
@anchor{reference/expressions private-name-mangling}@anchor{1cc1}
@menu
* Private name mangling:: 

@end menu

@node Private name mangling,,,Identificadores Nombres
@anchor{reference/expressions id3}@anchor{201a}
@subsubsection Private name mangling


When an identifier that textually occurs in a class definition begins with two
or more underscore characters and does not end in two or more underscores, it
is considered a `private name' of that class.


@subsubheading Ver también


The @ref{133f,,class specifications}.


More precisely, private names are transformed to a longer form before code is
generated for them.  If the transformed name is longer than 255 characters,
implementation-defined truncation may happen.

The transformation is independent of the syntactical context in which the
identifier is used but only the following private identifiers are mangled:


@itemize -

@item 
Any name used as the name of a variable that is assigned or read or any
name of an attribute being accessed.

The @ref{10e2,,__name__} attribute of nested functions, classes, and
type aliases is however not mangled.

@item 
The name of imported modules, e.g., @code{__spam} in @code{import __spam}.
If the module is part of a package (i.e., its name contains a dot),
the name is `not' mangled, e.g., the @code{__foo} in @code{import __foo.bar}
is not mangled.

@item 
The name of an imported member, e.g., @code{__f} in @code{from spam import __f}.
@end itemize

The transformation rule is defined as follows:


@itemize -

@item 
The class name, with leading underscores removed and a single leading
underscore inserted, is inserted in front of the identifier, e.g., the
identifier @code{__spam} occurring in a class named @code{Foo}, @code{_Foo} or
@code{__Foo} is transformed to @code{_Foo__spam}.

@item 
If the class name consists only of underscores, the transformation is the
identity, e.g., the identifier @code{__spam} occurring in a class named @code{_}
or @code{__} is left as is.
@end itemize

@node Literales<2>,Formas entre paréntesis,Identificadores Nombres,Átomos
@anchor{reference/expressions atom-literals}@anchor{201b}@anchor{reference/expressions literals}@anchor{201c}
@subsubsection Literales


@geindex literal

Python soporta literales de cadenas de caracteres y bytes y varios literales numéricos:

@example
@anchor{reference/expressions grammar-token-python-grammar-literal}@anchor{201d}literal ::= stringliteral | bytesliteral
            | integer | floatnumber | imagnumber
@end example

Evaluation of a literal yields an object of the given type (string, bytes,
integer, floating-point number, complex number) with the given value.  The value
may be approximated in the case of floating-point and imaginary (complex)
literals.  See section @ref{1ea2,,Literales} for details.

@geindex immutable;data;type
@geindex immutable;object

Todos los literales corresponden a tipos de datos inmutables y, por lo tanto, la identidad del objeto es menos importante que su valor. Múltiples evaluaciones de literales con el mismo valor (ya sea la misma ocurrencia en el texto del programa o una ocurrencia diferente) pueden obtener el mismo objeto o un objeto diferente con el mismo valor.

@node Formas entre paréntesis,Despliegues para listas conjuntos y diccionarios,Literales<2>,Átomos
@anchor{reference/expressions parenthesized}@anchor{201e}@anchor{reference/expressions parenthesized-forms}@anchor{201f}
@subsubsection Formas entre paréntesis


@geindex parenthesized form
@geindex () (parentheses);tuple display

Una forma entre paréntesis es una lista de expresiones opcionales encerradas entre paréntesis:

@example
@anchor{reference/expressions grammar-token-python-grammar-parenth_form}@anchor{2020}parenth_form ::= "(" [starred_expression] ")"
@end example

Una expresión entre paréntesis produce lo que la lista de expresión produce: si la lista contiene al menos una coma, produce una tupla; en caso contrario, produce la única expresión que que forma la lista de expresiones.

@geindex empty;tuple

Un par de paréntesis vacío producen un objeto de tupla vacío. Debido a que las tuplas son inmutables, se aplican las mismas reglas que aplican para literales (ej., dos ocurrencias de una tupla vacía puede o no producir el mismo objeto).

@geindex comma
@geindex @comma{} (comma)

Note that tuples are not formed by the parentheses, but rather by use of the
comma.  The exception is the empty tuple, for which parentheses `are'
required — allowing unparenthesized «nothing» in expressions would cause
ambiguities and allow common typos to pass uncaught.

@node Despliegues para listas conjuntos y diccionarios,Despliegues de lista,Formas entre paréntesis,Átomos
@anchor{reference/expressions comprehensions}@anchor{671}@anchor{reference/expressions displays-for-lists-sets-and-dictionaries}@anchor{2021}
@subsubsection Despliegues para listas, conjuntos y diccionarios


@geindex comprehensions

Para construir una lista, un conjunto o un diccionario, Python provee sintaxis especial denominada «despliegue», cada una de ellas en dos sabores:


@itemize *

@item 
los contenidos del contenedor son listados explícitamente o

@item 
son calculados mediante un conjunto de instrucciones de bucle y filtrado, denominadas una `comprehension'.
@end itemize

@geindex for;in comprehensions
@geindex if;in comprehensions
@geindex async for;in comprehensions

Los elementos comunes de sintaxis para las comprensiones son:

@example
@anchor{reference/expressions grammar-token-python-grammar-comprehension}@anchor{2022}comprehension ::= assignment_expression comp_for
@anchor{reference/expressions grammar-token-python-grammar-comp_for}@anchor{2023}comp_for      ::= ["async"] "for" target_list "in" or_test [comp_iter]
@anchor{reference/expressions grammar-token-python-grammar-comp_iter}@anchor{2024}comp_iter     ::= comp_for | comp_if
@anchor{reference/expressions grammar-token-python-grammar-comp_if}@anchor{2025}comp_if       ::= "if" or_test [comp_iter]
@end example

La comprensión consiste en una única expresión seguida por al menos una cláusula @code{for} y cero o más cláusulas @code{for} o @code{if}. En este caso, los elementos del nuevo contenedor son aquellos que serían producidos mediante considerar cada una de las cláusulas @code{for} o @code{if} un bloque, anidado de izquierda a derecha y evaluando la expresión para producir un elemento cada vez que se alcanza el bloque más interno.

Sin embargo, aparte de la expresión iterable en la cláusula @code{for} más a la izquierda, la comprensión es ejecutada en un alcance separado implícitamente anidado. Esto asegura que los nombres asignados a en la lista objetiva no se «filtren» en el alcance adjunto.

La expresión iterable en la cláusula más a la izquierda @code{for} es evaluada directamente en el alcance anidado y luego pasada como un argumento al alcance implícitamente anidado. Subsecuentes cláusulas @code{for} y cualquier condición de filtro en la cláusula @code{for} más a la izquierda no pueden ser evaluadas en el alcance adjunto ya que pueden depender de los valores obtenidos del iterable de más a la izquierda. Por ejemplo, @code{[x*y for x in range(10) for y in range(x, x+10)]}.

Para asegurar que la comprensión siempre resulta en un contenedor del tipo apropiado, las expresiones @code{yield} y @code{yield from} están prohibidas en el alcance implícitamente anidado.

@geindex await;in comprehensions

Since Python 3.6, in an @ref{672,,async def} function, an @code{async for}
clause may be used to iterate over a @ref{312,,asynchronous iterator}.
A comprehension in an @code{async def} function may consist of either a
@code{for} or @code{async for} clause following the leading
expression, may contain additional @code{for} or @code{async for}
clauses, and may also use @ref{14e,,await} expressions.

If a comprehension contains @code{async for} clauses, or if it contains
@code{await} expressions or other asynchronous comprehensions anywhere except
the iterable expression in the leftmost @code{for} clause, it is called an
`asynchronous comprehension'. An asynchronous comprehension may suspend the
execution of the coroutine function in which it appears.
See also 
@geindex Python Enhancement Proposals; PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/}.


Added in version 3.6: Fueron introducidas las comprensiones asincrónicas.



Distinto en la versión 3.8: Prohibidas @code{yield} y @code{yield from} en el alcance implícitamente anidado.



Distinto en la versión 3.11: Asynchronous comprehensions are now allowed inside comprehensions in
asynchronous functions. Outer comprehensions implicitly become
asynchronous.


@node Despliegues de lista,Despliegues de conjuntos,Despliegues para listas conjuntos y diccionarios,Átomos
@anchor{reference/expressions list-displays}@anchor{2026}@anchor{reference/expressions lists}@anchor{2027}
@subsubsection Despliegues de lista


@geindex list;display
@geindex list;comprehensions
@geindex empty;list
@geindex object;list
@geindex [] (square brackets);list expression
@geindex @comma{} (comma);expression list

Un despliegue de lista es una serie de expresiones posiblemente vacía encerrada entre corchetes:

@example
@anchor{reference/expressions grammar-token-python-grammar-list_display}@anchor{2028}list_display ::= "[" [flexible_expression_list | comprehension] "]"
@end example

Un despliegue de lista produce un nuevo objeto lista, el contenido se especifica por una lista de expresiones o una comprensión. Cuando se proporciona una lista de expresiones, sus elementos son evaluados desde la izquierda a la derecha y colocados en el objeto lista en ese orden. Cuando se proporciona una comprensión, la lista es construida desde los elementos resultantes de la comprensión.

@node Despliegues de conjuntos,Despliegues de diccionario,Despliegues de lista,Átomos
@anchor{reference/expressions set}@anchor{2029}@anchor{reference/expressions set-displays}@anchor{202a}
@subsubsection Despliegues de conjuntos


@geindex set;display
@geindex set;comprehensions
@geindex object;set
@geindex @{@} (curly brackets);set expression
@geindex @comma{} (comma);expression list

Un despliegue de conjunto se denota mediante llaves y se distinguen de los despliegues de diccionarios por la ausencia de caracteres de doble punto separando claves y valores:

@example
@anchor{reference/expressions grammar-token-python-grammar-set_display}@anchor{202b}set_display ::= "@{" (flexible_expression_list | comprehension) "@}"
@end example

Un despliegue de conjunto produce un nuevo objeto conjunto mutable, el contenido se especifica mediante una secuencia de expresiones o una comprensión. Cuando se proporciona una lista de expresiones separadas por comas, sus elementos son evaluados desde la izquierda a la derecha y añadidos al objeto de conjunto. Cuando se proporciona una comprensión, el conjunto es construido de los elementos resultantes de la comprensión.

Un conjunto vacío no puede ser construido con @code{@{@}}; este literal construye un diccionario vacío.

@node Despliegues de diccionario,Expresiones de generador,Despliegues de conjuntos,Átomos
@anchor{reference/expressions dict}@anchor{e04}@anchor{reference/expressions dictionary-displays}@anchor{202c}
@subsubsection Despliegues de diccionario


@geindex dictionary;display
@geindex dictionary;comprehensions
@geindex key
@geindex value
@geindex key/value pair
@geindex object;dictionary
@geindex @{@} (curly brackets);dictionary expression
@geindex ; (colon);in dictionary expressions
@geindex @comma{} (comma);in dictionary displays

A dictionary display is a possibly empty series of dict items (key/value pairs)
enclosed in curly braces:

@example
@anchor{reference/expressions grammar-token-python-grammar-dict_display}@anchor{202d}dict_display       ::= "@{" [dict_item_list | dict_comprehension] "@}"
@anchor{reference/expressions grammar-token-python-grammar-dict_item_list}@anchor{202e}dict_item_list     ::= dict_item ("," dict_item)* [","]
@anchor{reference/expressions grammar-token-python-grammar-dict_item}@anchor{202f}dict_item          ::= expression ":" expression | "**" or_expr
@anchor{reference/expressions grammar-token-python-grammar-dict_comprehension}@anchor{2030}dict_comprehension ::= expression ":" expression comp_for
@end example

Un despliegue de diccionario produce un nuevo objeto diccionario.

If a comma-separated sequence of dict items is given, they are evaluated
from left to right to define the entries of the dictionary: each key object is
used as a key into the dictionary to store the corresponding value.  This means
that you can specify the same key multiple times in the dict item list, and the
final dictionary’s value for that key will be the last one given.

@geindex unpacking;dictionary
@geindex **;in dictionary displays

A double asterisk @code{**} denotes `dictionary unpacking'.
Its operand must be a @ref{1229,,mapping}.  Each mapping item is added
to the new dictionary.  Later values replace values already set by
earlier dict items and earlier dictionary unpackings.


Added in version 3.5: Desempaquetar en despliegues de diccionarios, originalmente propuesto por 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/}.


Una comprensión de diccionario, en contraste a las compresiones de lista y conjunto, necesita dos expresiones separadas con un caracter de doble punto seguido por las cláusulas usuales «for» e «if». Cuando la comprensión se ejecuta, los elementos resultantes clave y valor son insertados en el nuevo diccionario en el orden que son producidos.

@geindex immutable;object
@geindex hashable

Restrictions on the types of the key values are listed earlier in section
@ref{1ee4,,Jerarquía de tipos estándar}.  (To summarize, the key type should be @ref{6b1,,hashable}, which excludes
all mutable objects.)  Clashes between duplicate keys are not detected; the last
value (textually rightmost in the display) stored for a given key value
prevails.


Distinto en la versión 3.8: Antes de Python 3.8, en las comprensiones de diccionarios, el orden de evaluación de clave y valor no fue bien definido. En CPython, el valor fue evaluado antes de la clave. A partir de 3.8, la clave es evaluada antes que el valor, como fue propuesto por 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}.


@node Expresiones de generador,Expresiones yield,Despliegues de diccionario,Átomos
@anchor{reference/expressions generator-expressions}@anchor{2031}@anchor{reference/expressions genexpr}@anchor{2032}
@subsubsection Expresiones de generador


@geindex generator;expression
@geindex object;generator
@geindex () (parentheses);generator expression

Una expresión de generador es una notación compacta de generador en paréntesis:

@example
@anchor{reference/expressions grammar-token-python-grammar-generator_expression}@anchor{2033}generator_expression ::= "(" expression comp_for ")"
@end example

Una expresión de generador produce un nuevo objeto generador. Su sintaxis es la misma que para las comprensiones, excepto que es encerrado en paréntesis en lugar de corchetes o llaves.

Las variables usadas en la expresión de generador son evaluadas perezosamente cuando se ejecuta el método @ref{1ccc,,__next__()} para el objeto generador (de la misma forma que los generadores normales). Sin embargo, la expresión iterable en la cláusula @code{for} más a la izquierda es inmediatamente evaluada, de forma que un error producido por ella será emitido en el punto en el que se define la expresión de generador, en lugar de en el punto donde se obtiene el primer valor. Subsecuentes cláusulas @code{for} y cualquier condición en la cláusula @code{for} más a la izquierda no pueden ser evaluadas en el alcance adjunto, ya que puede depender de los valores obtenidos por el iterable de más a la izquierda. Por ejemplo: @code{(x*y for x in range(10) for y in range(x, x+10))}.

Los paréntesis pueden ser omitidos en ejecuciones con un solo argumento. Vea la sección @ref{e02,,Invocaciones} para más detalles.

Para evitar interferir con la operación esperada de la expresión misma del generador, las expresiones @code{yield} y @code{yield from} están prohibidas en el generador definido implícitamente.

Si una expresión de generador contiene cláusulas @code{async for} o expresiones @ref{14e,,await}, se ejecuta una `asynchronous generator expression'. Una expresión de generador asincrónica retorna un nuevo objeto de generador asincrónico, el cual es un iterador asincrónico (ver @ref{dff,,Iteradores asíncronos}).


Added in version 3.6: Las expresiones de generador asincrónico fueron introducidas.



Distinto en la versión 3.7: Antes de Python 3.7, las expresiones de generador asincrónico podrían aparecer sólo en corrutinas @ref{672,,async def}. Desde 3.7, cualquier función puede usar expresiones de generador asincrónico.



Distinto en la versión 3.8: Prohibidas @code{yield} y @code{yield from} en el alcance implícitamente anidado.


@node Expresiones yield,,Expresiones de generador,Átomos
@anchor{reference/expressions yield-expressions}@anchor{2034}@anchor{reference/expressions yieldexpr}@anchor{2035}
@subsubsection Expresiones yield


@geindex keyword;yield
@geindex keyword;from
@geindex yield;expression
@geindex generator;function

@example
@anchor{reference/expressions grammar-token-python-grammar-yield_atom}@anchor{2036}yield_atom       ::= "(" yield_expression ")"
@anchor{reference/expressions grammar-token-python-grammar-yield_from}@anchor{2037}yield_from       ::= "yield" "from" expression
@anchor{reference/expressions grammar-token-python-grammar-yield_expression}@anchor{2038}yield_expression ::= "yield" yield_list | yield_from
@end example

The yield expression is used when defining a @ref{10dd,,generator} function
or an @ref{2039,,asynchronous generator} function and
thus can only be used in the body of a function definition.  Using a yield
expression in a function’s body causes that function to be a generator function,
and using it in an @ref{672,,async def} function’s body causes that
coroutine function to be an asynchronous generator function. For example:

@example
def gen():  # defines a generator function
    yield 123

async def agen(): # defines an asynchronous generator function
    yield 123
@end example

Debido a sus efectos secundarios sobre el alcance contenedor, las expresiones @code{yield} no están permitidas como parte de los alcances implícitamente definidos usados para implementar comprensiones y expresiones de generador.


Distinto en la versión 3.8: Expresiones yield prohibidas en los ámbitos anidados implícitamente utilizados para implementar comprensiones y expresiones de generador.


Las funciones generadoras son descritas a continuación, mientras que las funciones generadoras asincrónicas son descritas separadamente en la sección @ref{203a,,Funciones generadoras asincrónicas}.

When a generator function is called, it returns an iterator known as a
generator.  That generator then controls the execution of the generator
function.  The execution starts when one of the generator’s methods is called.
At that time, the execution proceeds to the first yield expression, where it is
suspended again, returning the value of @ref{203b,,yield_list}
to the generator’s caller,
or @code{None} if @ref{203b,,yield_list} is omitted.
By suspended, we mean that all local state is
retained, including the current bindings of local variables, the instruction
pointer, the internal evaluation stack, and the state of any exception handling.
When the execution is resumed by calling one of the generator’s methods, the
function can proceed exactly as if the yield expression were just another
external call.  The value of the yield expression after resuming depends on the
method which resumed the execution.  If @ref{1ccc,,__next__()} is used
(typically via either a @ref{1eb,,for} or the @ref{86f,,next()} builtin) then the
result is @ref{716,,None}.  Otherwise, if @ref{1fcd,,send()} is used, then
the result will be the value passed in to that method.

@geindex coroutine

Todo este hace a las funciones generadores similar a las corrutinas; producen múltiples veces, tienen más de un punto de entrada y su ejecución puede ser suspendida. La única diferencia es que una función generadora no puede controlar si la ejecución debe continuar después de producir; el control siempre es transferido al invocador del generador.

Las expresiones yield están permitidas en cualquier lugar en un constructo @ref{789,,try}. Si el generador no es reanudado antes de finalizar (alcanzando un recuento de referencia cero o colectando basura), el método generador-iterador @ref{16fa,,close()} será invocado, permitiendo la ejecución de cualquier cláusula @ref{a5c,,finally} pendiente.

@geindex from;yield from expression

Cuando se usa @code{yield from <expr>}, la expresión proporcionada debe ser iterable. Los valores producidos al iterar ese iterable se pasan directamente al llamador de los métodos del generador actual. Cualquier valor pasado con @ref{1fcd,,send()} y cualquier excepción pasada con @ref{59d,,throw()} se pasan al iterador subyacente si tiene los métodos apropiados. Si este no es el caso, entonces @ref{1fcd,,send()} lanzará @ref{441,,AttributeError} o @ref{228,,TypeError}, mientras que @ref{59d,,throw()} solo lanzará la excepción pasada inmediatamente.

Cuando el iterador subyacente está completo, el atributo @ref{1fca,,value} de la instancia @ref{c82,,StopIteration} generada se convierte en el valor de la expresión yield. Puede ser establecido explícitamente al generar @ref{c82,,StopIteration} o automáticamente cuando el subiterador es un generador (retornando un valor del subgenerador).


Distinto en la versión 3.3: Añadido @code{yield from <expr>} para delegar el control de flujo a un subiterador.


Los paréntesis pueden ser omitidos cuando la expresión yield es la única expresión en el lado derecho de una sentencia de asignación.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Generadores Simples

La propuesta para añadir generadores y la sentencia @ref{a5f,,yield} a Python.

@geindex Python Enhancement Proposals; PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - Corrutinas mediante Generadores Mejorados

La propuesta para mejorar la API y la sintaxis de generadores, haciéndolos utilizables como corrutinas simples.

@geindex Python Enhancement Proposals; PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - Sintaxis para Delegar a un Subgenerador

The proposal to introduce the @ref{2037,,yield_from} syntax,
making delegation to subgenerators easy.

@geindex Python Enhancement Proposals; PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/}- Generadores Asincrónicos

La propuesta que expandió 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} añadiendo capacidades de generador a las funciones corrutina.
@end table


@geindex object;generator

@menu
* Métodos generador-iterador:: 
* Ejemplos:: 
* Funciones generadoras asincrónicas: Funciones generadoras asincrónicas<2>. 
* Métodos asincrónicos de generador-iterador:: 

@end menu

@node Métodos generador-iterador,Ejemplos,,Expresiones yield
@anchor{reference/expressions generator-iterator-methods}@anchor{203c}@anchor{reference/expressions generator-methods}@anchor{1fcb}
@subsubsection Métodos generador-iterador


Esta subsección describe los métodos de un generador iterador. Estos pueden ser usados para controlar la ejecución de una función generadora.

Tenga en cuenta que invocar cualquiera de los métodos de generador siguientes cuando el generador está todavía en ejecución genera una excepción @ref{360,,ValueError}.

@geindex exception;StopIteration

@geindex __next__() (método de generator)
@anchor{reference/expressions generator __next__}@anchor{1ccc}
@deffn {Método} generator.__next__ ()

Starts the execution of a generator function or resumes it at the last
executed yield expression.  When a generator function is resumed with a
@ref{1ccc,,__next__()} method, the current yield expression always
evaluates to @ref{716,,None}.  The execution then continues to the next yield
expression, where the generator is suspended again, and the value of the
@ref{203b,,yield_list} is returned to @ref{1ccc,,__next__()}”s
caller.  If the generator exits without yielding another value, a
@ref{c82,,StopIteration} exception is raised.

Este método es normalmente invocado implícitamente, por ejemplo, por un bucle @ref{1eb,,for} o por la función incorporada @ref{86f,,next()}.
@end deffn

@geindex send() (método de generator)
@anchor{reference/expressions generator send}@anchor{1fcd}
@deffn {Método} generator.send (value)

Reanuda la ejecución y «envía» un valor dentro de la función generadora. El argumento `value' se convierte en el resultado de la expresión yield actual. El método @ref{1fcd,,send()} retorna el siguiente valor producido por el generador o genera @ref{c82,,StopIteration} si el generador termina sin producir otro valor. Cuando se ejecuta @ref{1fcd,,send()} para comenzar el generador, debe ser invocado con @ref{716,,None} como el argumento, debido a que no hay expresión yield que pueda recibir el valor.
@end deffn

@geindex throw() (método de generator)
@anchor{reference/expressions generator throw}@anchor{59d}
@deffn {Método} generator.throw (value)

@deffnx {Método} generator.throw (type[, value[, traceback]])

Raises an exception at the point where the generator was paused,
and returns the next value yielded by the generator function.  If the generator
exits without yielding another value, a @ref{c82,,StopIteration} exception is
raised.  If the generator function does not catch the passed-in exception, or
raises a different exception, then that exception propagates to the caller.

In typical use, this is called with a single exception instance similar to the
way the @ref{68d,,raise} keyword is used.

For backwards compatibility, however, the second signature is
supported, following a convention from older versions of Python.
The `type' argument should be an exception class, and `value'
should be an exception instance. If the `value' is not provided, the
`type' constructor is called to get an instance. If `traceback'
is provided, it is set on the exception, otherwise any existing
@ref{1330,,__traceback__} attribute stored in `value' may
be cleared.


Distinto en la versión 3.12: The second signature (type[, value[, traceback]]) is deprecated and
may be removed in a future version of Python.

@end deffn

@geindex exception;GeneratorExit

@geindex close() (método de generator)
@anchor{reference/expressions generator close}@anchor{16fa}
@deffn {Método} generator.close ()

Raises a @ref{1407,,GeneratorExit} at the point where the generator function was
paused.  If the generator function catches the exception and returns a
value, this value is returned from @ref{16fa,,close()}.  If the generator function
is already closed, or raises @ref{1407,,GeneratorExit} (by not catching the
exception), @ref{16fa,,close()} returns @ref{716,,None}.  If the generator yields a
value, a @ref{1e5,,RuntimeError} is raised.  If the generator raises any other
exception, it is propagated to the caller.  If the generator has already
exited due to an exception or normal exit, @ref{16fa,,close()} returns
@ref{716,,None} and has no other effect.


Distinto en la versión 3.13: If a generator returns a value upon being closed, the value is returned
by @ref{16fa,,close()}.

@end deffn

@geindex yield;examples

@node Ejemplos,Funciones generadoras asincrónicas<2>,Métodos generador-iterador,Expresiones yield
@anchor{reference/expressions examples}@anchor{203d}
@subsubsection Ejemplos


Aquí hay un ejemplo simple que demuestra el comportamiento de generadores y funciones generadoras:

@example
>>> def echo(value=None):
...     print("Execution starts when 'next()' is called for the first time.")
...     try:
...         while True:
...             try:
...                 value = (yield value)
...             except Exception as e:
...                 value = e
...     finally:
...         print("Don't forget to clean up when 'close()' is called.")
...
>>> generator = echo(1)
>>> print(next(generator))
Execution starts when 'next()' is called for the first time.
1
>>> print(next(generator))
None
>>> print(generator.send(2))
2
>>> generator.throw(TypeError, "spam")
TypeError('spam',)
>>> generator.close()
Don't forget to clean up when 'close()' is called.
@end example

Para ejemplos usando @code{yield from}, ver @ref{10b5,,PEP 380; Sintaxis para delegar en un subgenerador} en «Qué es nuevo en Python.»

@node Funciones generadoras asincrónicas<2>,Métodos asincrónicos de generador-iterador,Ejemplos,Expresiones yield
@anchor{reference/expressions asynchronous-generator-functions}@anchor{203a}@anchor{reference/expressions id4}@anchor{203e}
@subsubsection Funciones generadoras asincrónicas


La presencia de una expresión yield en una función o método definido usando @ref{672,,async def} adicionalmente define la función como una función @ref{2039,,asynchronous generator}.

Cuando se invoca una función generadora asincrónica, retorna un iterador asincrónico conocido como un objeto generador asincrónico. Este objeto entonces controla la ejecución de la función generadora. Un objeto generador asincrónico se usa típicamente en una sentencia @ref{b36,,async for} en una función corrutina análogamente a como sería usado un objeto generador en una sentencia @ref{1eb,,for}.

Calling one of the asynchronous generator’s methods returns an @ref{314,,awaitable}
object, and the execution starts when this object is awaited on. At that time,
the execution proceeds to the first yield expression, where it is suspended
again, returning the value of @ref{203b,,yield_list} to the
awaiting coroutine. As with a generator, suspension means that all local state
is retained, including the current bindings of local variables, the instruction
pointer, the internal evaluation stack, and the state of any exception handling.
When the execution is resumed by awaiting on the next object returned by the
asynchronous generator’s methods, the function can proceed exactly as if the
yield expression were just another external call. The value of the yield
expression after resuming depends on the method which resumed the execution.  If
@ref{203f,,__anext__()} is used then the result is @ref{716,,None}. Otherwise, if
@ref{970,,asend()} is used, then the result will be the value passed in to that
method.

Si un generador asincrónico sale temprano por @ref{b34,,break}, la tarea de la persona que llama se cancela u otras excepciones, el código de limpieza asíncrono del generador se ejecutará y posiblemente lanzará excepciones o accederá a variables de contexto en un contexto inesperado, tal vez después de la vida útil de las tareas de las que depende, o durante el cierre del ciclo de eventos cuando se llama al gancho de recolección de basura del generador asíncrono. Para evitar esto, la persona que llama debe cerrar explícitamente el generador asíncrono llamando al método @ref{96f,,aclose()} para finalizar el generador y finalmente desconectarlo del bucle de eventos.

En una función generadora asincrónica, las expresiones yield están permitidas en cualquier lugar de un constructo @ref{789,,try}. Sin embargo, si un generador asincrónico no es reanudado antes de finalizar (alcanzando un contador de referencia cero o recogiendo basura), entonces una expresión yield dentro de un constructo @code{try} podría fallar al ejecutar cláusulas @ref{a5c,,finally} pendientes. En este caso, es responsabilidad del bucle de eventos o del planificador ejecutando el generador asincrónico invocar el método @ref{96f,,aclose()} del generador-iterador asincrónico y ejecutar el objeto corrutina resultante, permitiendo así la ejecución de cualquier cláusula @code{finally} pendiente.

Para encargarse de la finalización tras la finalización del ciclo de eventos, un ciclo de eventos debe definir una función `finalizer' que tome un generador-iterador asíncrono y presumiblemente llame a @ref{96f,,aclose()} y ejecute la rutina. Este `finalizer' se puede registrar llamando a @ref{1632,,sys.set_asyncgen_hooks()}. Cuando se itera por primera vez, un generador-iterador asíncrono almacenará el `finalizer' registrado para ser llamado al finalizar. Para obtener un ejemplo de referencia de un método `finalizer', consulte la implementación de @code{asyncio.Loop.shutdown_asyncgens} en Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/base_events.py}.

La expresión @code{yield from <expr>} es un error de sintaxis cuando es usada en una función generadora asincrónica.

@geindex object;asynchronous-generator

@node Métodos asincrónicos de generador-iterador,,Funciones generadoras asincrónicas<2>,Expresiones yield
@anchor{reference/expressions asynchronous-generator-iterator-methods}@anchor{2040}@anchor{reference/expressions asynchronous-generator-methods}@anchor{2041}
@subsubsection Métodos asincrónicos de generador-iterador


Esta subsección describe los métodos de un generador iterador asincrónico, los cuales son usados para controlar la ejecución de una función generadora.

@geindex exception;StopAsyncIteration

@geindex __anext__() (método de agen)
@anchor{reference/expressions agen __anext__}@anchor{203f}
@deffn {Método} coroutine agen.__anext__ ()

Returns an awaitable which when run starts to execute the asynchronous
generator or resumes it at the last executed yield expression.  When an
asynchronous generator function is resumed with an @ref{203f,,__anext__()}
method, the current yield expression always evaluates to @ref{716,,None} in the
returned awaitable, which when run will continue to the next yield
expression. The value of the @ref{203b,,yield_list} of the
yield expression is the value of the @ref{c82,,StopIteration} exception raised by
the completing coroutine.  If the asynchronous generator exits without
yielding another value, the awaitable instead raises a
@ref{1a34,,StopAsyncIteration} exception, signalling that the asynchronous
iteration has completed.

Este método es invocado normalmente de forma implícita por un bucle @ref{b36,,async for}.
@end deffn

@geindex asend() (método de agen)
@anchor{reference/expressions agen asend}@anchor{970}
@deffn {Método} coroutine agen.asend (value)

Returns an awaitable which when run resumes the execution of the
asynchronous generator. As with the @ref{1fcd,,send()} method for a
generator, this «sends» a value into the asynchronous generator function,
and the `value' argument becomes the result of the current yield expression.
The awaitable returned by the @ref{970,,asend()} method will return the next
value yielded by the generator as the value of the raised
@ref{c82,,StopIteration}, or raises @ref{1a34,,StopAsyncIteration} if the
asynchronous generator exits without yielding another value.  When
@ref{970,,asend()} is called to start the asynchronous
generator, it must be called with @ref{716,,None} as the argument,
because there is no yield expression that could receive the value.
@end deffn

@geindex athrow() (método de agen)
@anchor{reference/expressions agen athrow}@anchor{59e}
@deffn {Método} coroutine agen.athrow (value)

@deffnx {Método} coroutine agen.athrow (type[, value[, traceback]])

Retorna un esperable que genera una excepción de tipo @code{type} en el punto donde el generador asincrónico fue pausado y retorna el siguiente valor producido por la función generadora como el valor de la excepción @ref{c82,,StopIteration} generada. Si el generador asincrónico termina sin producir otro valor, el esperable genera una excepción @ref{1a34,,StopAsyncIteration}. Si la función generadora no caza la excepción pasada o genera una excepción diferente, entonces cuando se ejecuta el esperable esa excepción se propaga al invocador del esperable.


Distinto en la versión 3.12: The second signature (type[, value[, traceback]]) is deprecated and
may be removed in a future version of Python.

@end deffn

@geindex exception;GeneratorExit

@geindex aclose() (método de agen)
@anchor{reference/expressions agen aclose}@anchor{96f}
@deffn {Método} coroutine agen.aclose ()

Retorna un esperable que cuando corre lanza un @ref{1407,,GeneratorExit} a la función generadora asincrónica en el punto donde fue pausada. Si la función generadora asincrónica termina exitosamente, ya está cerrada o genera  @ref{1407,,GeneratorExit} (sin cazar la excepción), el esperable retornado lanzará una excepción @ref{c82,,StopIteration}. Otros esperables retornados por subsecuentes invocaciones al generador asincrónico lanzarán una excepción @ref{1a34,,StopAsyncIteration}. Si el generador asincrónico produce un valor, el esperable genera un @ref{1e5,,RuntimeError}. Si el generador asincrónico genera cualquier otra excepción, esta es propagada al invocador del esperable. Si el generador asincrónico ha terminado debido a una excepción o una terminación normal, entonces futuras invocaciones a @ref{96f,,aclose()} retornarán un esperable que no hace nada.
@end deffn

@node Primarios,Expresión await,Átomos,Expresiones
@anchor{reference/expressions id5}@anchor{2042}@anchor{reference/expressions primaries}@anchor{2043}
@subsection Primarios


@geindex primary

Los primarios representan las operaciones más fuertemente ligadas al lenguaje. Su sintaxis es:

@example
@anchor{reference/expressions grammar-token-python-grammar-primary}@anchor{2044}primary ::= atom | attributeref | subscription | slicing | call
@end example

@menu
* Referencias de atributos:: 
* Suscripciones:: 
* Segmentos:: 
* Invocaciones:: 

@end menu

@node Referencias de atributos,Suscripciones,,Primarios
@anchor{reference/expressions attribute-references}@anchor{2045}@anchor{reference/expressions id6}@anchor{2046}
@subsubsection Referencias de atributos


@geindex attribute;reference
@geindex . (dot);attribute reference

Una referencia de atributo es un primario seguido de un punto y un nombre:

@example
@anchor{reference/expressions grammar-token-python-grammar-attributeref}@anchor{2047}attributeref ::= primary "." identifier
@end example

@geindex exception;AttributeError
@geindex object;module
@geindex object;list

The primary must evaluate to an object of a type that supports attribute
references, which most objects do.  This object is then asked to produce the
attribute whose name is the identifier. The type and value produced is
determined by the object.  Multiple evaluations of the same attribute
reference may yield different objects.

This production can be customized by overriding the
@ref{c5a,,__getattribute__()} method or the @ref{57a,,__getattr__()}
method.  The @code{__getattribute__()} method is called first and either
returns a value or raises @ref{441,,AttributeError} if the attribute is not
available.

If an @ref{441,,AttributeError} is raised and the object has a @code{__getattr__()}
method, that method is called as a fallback.

@node Suscripciones,Segmentos,Referencias de atributos,Primarios
@anchor{reference/expressions id7}@anchor{2048}@anchor{reference/expressions subscriptions}@anchor{1f84}
@subsubsection Suscripciones


@geindex subscription
@geindex [] (square brackets);subscription

@geindex object;sequence
@geindex object;mapping
@geindex object;string
@geindex object;tuple
@geindex object;list
@geindex object;dictionary
@geindex sequence;item

The subscription of an instance of a @ref{1f8a,,container class}
will generally select an element from the container. The subscription of a
@ref{157,,generic class} will generally return a
@ref{753,,GenericAlias} object.

@example
@anchor{reference/expressions grammar-token-python-grammar-subscription}@anchor{2049}subscription ::= primary "[" flexible_expression_list "]"
@end example

When an object is subscripted, the interpreter will evaluate the primary and
the expression list.

The primary must evaluate to an object that supports subscription. An object
may support subscription through defining one or both of
@ref{3d8,,__getitem__()} and @ref{7d6,,__class_getitem__()}. When the
primary is subscripted, the evaluated result of the expression list will be
passed to one of these methods. For more details on when @code{__class_getitem__}
is called instead of @code{__getitem__}, see @ref{1f83,,__class_getitem__ frente a __getitem__}.

If the expression list contains at least one comma, or if any of the expressions
are starred, the expression list will evaluate to a @ref{464,,tuple} containing
the items of the expression list. Otherwise, the expression list will evaluate
to the value of the list’s sole member.


Distinto en la versión 3.11: Expressions in an expression list may be starred. See 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


For built-in objects, there are two types of objects that support subscription
via @ref{3d8,,__getitem__()}:


@enumerate 

@item 
Mappings. If the primary is a @ref{1229,,mapping}, the expression list must
evaluate to an object whose value is one of the keys of the mapping, and the
subscription selects the value in the mapping that corresponds to that key.
An example of a builtin mapping class is the @ref{190,,dict} class.

@item 
Sequences. If the primary is a @ref{597,,sequence}, the expression list must
evaluate to an @ref{1f0,,int} or a @ref{514,,slice} (as discussed in the
following section). Examples of builtin sequence classes include the
@ref{237,,str}, @ref{18e,,list} and @ref{464,,tuple} classes.
@end enumerate

The formal syntax makes no special provision for negative indices in
@ref{597,,sequences}. However, built-in sequences all provide a @ref{3d8,,__getitem__()}
method that interprets negative indices by adding the length of the sequence
to the index so that, for example, @code{x[-1]} selects the last item of @code{x}. The
resulting value must be a nonnegative integer less than the number of items in
the sequence, and the subscription selects the item whose index is that value
(counting from zero). Since the support for negative indices and slicing
occurs in the object’s @ref{3d8,,__getitem__()} method, subclasses overriding
this method will need to explicitly add that support.

@geindex character
@geindex string;item

A @ref{237,,string} is a special kind of sequence whose items are
`characters'. A character is not a separate data type but a
string of exactly one character.

@node Segmentos,Invocaciones,Suscripciones,Primarios
@anchor{reference/expressions id8}@anchor{204a}@anchor{reference/expressions slicings}@anchor{204b}
@subsubsection Segmentos


@geindex slicing
@geindex slice
@geindex ; (colon);slicing
@geindex @comma{} (comma);slicing

@geindex object;sequence
@geindex object;string
@geindex object;tuple
@geindex object;list

Un segmento selecciona un rango de elementos en una objeto secuencia (ej., una cadena de caracteres, tupla o lista). Los segmentos pueden ser usados como expresiones o como objetivos en asignaciones o sentencias @ref{17ae,,del}. La sintaxis para un segmento:

@example
@anchor{reference/expressions grammar-token-python-grammar-slicing}@anchor{204c}slicing      ::= primary "[" slice_list "]"
@anchor{reference/expressions grammar-token-python-grammar-slice_list}@anchor{204d}slice_list   ::= slice_item ("," slice_item)* [","]
@anchor{reference/expressions grammar-token-python-grammar-slice_item}@anchor{204e}slice_item   ::= expression | proper_slice
@anchor{reference/expressions grammar-token-python-grammar-proper_slice}@anchor{204f}proper_slice ::= [lower_bound] ":" [upper_bound] [ ":" [stride] ]
@anchor{reference/expressions grammar-token-python-grammar-lower_bound}@anchor{2050}lower_bound  ::= expression
@anchor{reference/expressions grammar-token-python-grammar-upper_bound}@anchor{2051}upper_bound  ::= expression
@anchor{reference/expressions grammar-token-python-grammar-stride}@anchor{2052}stride       ::= expression
@end example

Hay ambigüedad en la sintaxis formal aquí: todo lo que parezca una expresión de lista también parece una segmento de lista, así que cualquier subscripción puede ser interpretada como un segmento. En lugar de complicar aún más la sintaxis, esta es desambiguada definiendo que en este caso la interpretación como una subscripción toma prioridad sobre la interpretación como un segmento (este es el caso si el segmento de lista no contiene un segmento adecuado).

@geindex start (slice object attribute)
@geindex stop (slice object attribute)
@geindex step (slice object attribute)

The semantics for a slicing are as follows.  The primary is indexed (using the
same @ref{3d8,,__getitem__()} method as
normal subscription) with a key that is constructed from the slice list, as
follows.  If the slice list contains at least one comma, the key is a tuple
containing the conversion of the slice items; otherwise, the conversion of the
lone slice item is the key.  The conversion of a slice item that is an
expression is that expression.  The conversion of a proper slice is a slice
object (see section @ref{1ee4,,Jerarquía de tipos estándar}) whose @ref{1f55,,start},
@ref{1f56,,stop} and @ref{1f57,,step} attributes are the values of the
expressions given as lower bound, upper bound and stride, respectively,
substituting @code{None} for missing expressions.

@geindex object;callable
@geindex call
@geindex argument;call semantics
@geindex () (parentheses);call
@geindex @comma{} (comma);argument list
@geindex = (equals);in function calls

@node Invocaciones,,Segmentos,Primarios
@anchor{reference/expressions calls}@anchor{e02}@anchor{reference/expressions id9}@anchor{2053}
@subsubsection Invocaciones


Una invocación invoca un objeto invocable (ej., una @ref{2054,,function}) con una serie posiblemente vacía de @ref{4f6,,argumentos}:

@example
@anchor{reference/expressions grammar-token-python-grammar-call}@anchor{2055}call                 ::= primary "(" [argument_list [","] | comprehension] ")"
@anchor{reference/expressions grammar-token-python-grammar-argument_list}@anchor{2056}argument_list        ::= positional_arguments ["," starred_and_keywords]
                           ["," keywords_arguments]
                         | starred_and_keywords ["," keywords_arguments]
                         | keywords_arguments
@anchor{reference/expressions grammar-token-python-grammar-positional_arguments}@anchor{2057}positional_arguments ::= positional_item ("," positional_item)*
@anchor{reference/expressions grammar-token-python-grammar-positional_item}@anchor{2058}positional_item      ::= assignment_expression | "*" expression
@anchor{reference/expressions grammar-token-python-grammar-starred_and_keywords}@anchor{2059}starred_and_keywords ::= ("*" expression | keyword_item)
                         ("," "*" expression | "," keyword_item)*
@anchor{reference/expressions grammar-token-python-grammar-keywords_arguments}@anchor{205a}keywords_arguments   ::= (keyword_item | "**" expression)
                         ("," keyword_item | "," "**" expression)*
@anchor{reference/expressions grammar-token-python-grammar-keyword_item}@anchor{205b}keyword_item         ::= identifier "=" expression
@end example

Una coma final opcional puede estar presente después de los argumentos posicionales y de palabra clave pero no afecta a las semánticas.

@geindex parameter;call semantics

The primary must evaluate to a callable object (user-defined functions, built-in
functions, methods of built-in objects, class objects, methods of class
instances, and all objects having a @ref{5fb,,__call__()} method are callable).  All
argument expressions are evaluated before the call is attempted.  Please refer
to section @ref{1c3d,,Definiciones de funciones} for the syntax of formal @ref{1efc,,parameter} lists.

@c XXX update with kwonly args PEP

If keyword arguments are present, they are first converted to positional
arguments, as follows.  First, a list of unfilled slots is created for the
formal parameters.  If there are N positional arguments, they are placed in the
first N slots.  Next, for each keyword argument, the identifier is used to
determine the corresponding slot (if the identifier is the same as the first
formal parameter name, the first slot is used, and so on).  If the slot is
already filled, a @ref{228,,TypeError} exception is raised. Otherwise, the
argument is placed in the slot, filling it (even if the expression is
@code{None}, it fills the slot).  When all arguments have been processed, the slots
that are still unfilled are filled with the corresponding default value from the
function definition.  (Default values are calculated, once, when the function is
defined; thus, a mutable object such as a list or dictionary used as default
value will be shared by all calls that don’t specify an argument value for the
corresponding slot; this should usually be avoided.)  If there are any unfilled
slots for which no default value is specified, a @ref{228,,TypeError} exception is
raised.  Otherwise, the list of filled slots is used as the argument list for
the call.

`Detalles de implementación de CPython:' Una implementación puede proveer funciones incorporadas cuyos argumentos posicionales no tienen nombres, incluso si son «nombrados» a efectos de documentación y los cuales por consiguiente no pueden ser suplidos por palabras clave. En CPython, este es el caso para funciones implementadas en C que usan @ref{615,,PyArg_ParseTuple()} para analizar sus argumentos.

Si hay más argumentos posicionales que ranuras formales de parámetros, se genera una excepción @ref{228,,TypeError}, a no ser que un parámetro formal usando la sintaxis @code{*identifier} se encuentre presente; en este caso, ese parámetro formal recibe una tupla conteniendo los argumentos posicionales sobrantes (o una tupla vacía su no hay argumentos posicionales sobrantes).

Si un argumento de palabra clave no corresponde a un nombre de parámetro formal, se genera una excepción @ref{228,,TypeError}, a no ser que un parámetro formal usando la sintaxis @code{**identifier} esté presente; en este caso, ese parámetro formal recibe un diccionario que contiene los argumentos de palabra clave sobrantes (usando las palabras clave como claves y los valores de argumento como sus valores correspondientes), o un (nuevo) diccionario vacío si no hay argumentos de palabra clave sobrantes.

@geindex * (asterisk);in function calls
@geindex unpacking;in function calls

Si la sintaxis @code{*expression} aparece en la invocación de función, @code{expression} debe evaluar a un @ref{1294,,iterable}. Elementos de esos iterables son tratados como si fueran argumentos posicionales adicionales. Para la invocación @code{f(x1, x2, *y, x3, x4)}, si `y' evalúa a una secuencia `y1', …, `yM', equivale a una invocación con M+4 argumentos posicionales `x1', `x2', `y1', …, `yM', `x3', `x4'.

Una consecuencia de esto es que aunque la sintaxis @code{*expression} puede aparecer `después' de argumentos de palabra clave explícitos, es procesada `antes' de los argumentos de palabra clave (y cualquiera de los argumentos @code{*expression} – ver abajo). Así que:

@example
>>> def f(a, b):
...     print(a, b)
...
>>> f(b=1, *(2,))
2 1
>>> f(a=1, *(2,))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: f() got multiple values for keyword argument 'a'
>>> f(1, *(2,))
1 2
@end example

It is unusual for both keyword arguments and the @code{*expression} syntax to be
used in the same call, so in practice this confusion does not often arise.

@geindex **;in function calls

If the syntax @code{**expression} appears in the function call, @code{expression} must
evaluate to a @ref{1229,,mapping}, the contents of which are treated as
additional keyword arguments. If a parameter matching a key has already been
given a value (by an explicit keyword argument, or from another unpacking),
a @ref{228,,TypeError} exception is raised.

When @code{**expression} is used, each key in this mapping must be
a string.
Each value from the mapping is assigned to the first formal parameter
eligible for keyword assignment whose name is equal to the key.
A key need not be a Python identifier (e.g. @code{"max-temp °F"} is acceptable,
although it will not match any formal parameter that could be declared).
If there is no match to a formal parameter
the key-value pair is collected by the @code{**} parameter, if there is one,
or if there is not, a @ref{228,,TypeError} exception is raised.

No pueden ser usados parámetros formales usando la sintaxis @code{*identifier} o @code{**identifier} como ranuras de argumentos posicionales o como nombres de argumentos de palabra clave.


Distinto en la versión 3.5: Las invocaciones de función aceptan cualquier número de desempaquetados @code{*} y @code{**}, los argumentos posicionales pueden seguir a desempaquetados de iterable (@code{*}) y los argumentos de palabra clave pueden seguir a desempaquetados de diccionario (@code{*}). Originalmente propuesto por 
@geindex Python Enhancement Proposals; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/}.


Una invocación siempre retorna algún valor, posiblemente @code{None}, a no ser que genere una excepción. Cómo se calcula este valor depende del tipo del objeto invocable.

Si es—


@table @asis

@item una función definida por el usuario:

@geindex function;call
@geindex user-defined;function;call
@geindex object;user-defined function
@geindex object;function

The code block for the function is executed, passing it the argument list.  The
first thing the code block will do is bind the formal parameters to the
arguments; this is described in section @ref{1c3d,,Definiciones de funciones}.  When the code block
executes a @ref{a60,,return} statement, this specifies the return value of the
function call.  If execution reaches the end of the code block without
executing a @ref{a60,,return} statement, the return value is @code{None}.

@item una función o método incorporado:

@geindex function;call
@geindex built-in function;call
@geindex method;call
@geindex built-in method;call
@geindex object;built-in method
@geindex object;built-in function
@geindex object;method
@geindex object;function

El resultado depende del intérprete; ver @ref{12ca,,Funciones incorporadas} para las descripciones de funciones y métodos incorporados.

@item un objeto de clase:

@geindex object;class
@geindex class object;call

Se retorna una nueva instancia de esa clase.

@item un método de una instancia de clase:

@geindex object;class instance
@geindex object;instance
@geindex class instance;call

Se invoca la función definida por el usuario correspondiente, con una lista de argumentos con un largo uno mayor que la lista de argumentos de la invocación: la instancia se convierte en el primer argumento.

@item una instancia de clase:

@geindex instance;call
@geindex __call__() (object method)

The class must define a @ref{5fb,,__call__()} method; the effect is then the same as
if that method was called.
@end table

@geindex keyword;await

@node Expresión await,El operador de potencia,Primarios,Expresiones
@anchor{reference/expressions await}@anchor{14e}@anchor{reference/expressions await-expression}@anchor{205c}
@subsection Expresión await


Suspende la ejecución de @ref{53a,,coroutine} o un objeto @ref{314,,awaitable}. Puede ser usado sólo dentro de una @ref{dfc,,coroutine function}.

@example
@anchor{reference/expressions grammar-token-python-grammar-await_expr}@anchor{205d}await_expr ::= "await" primary
@end example


Added in version 3.5.


@node El operador de potencia,Aritmética unaria y operaciones bit a bit,Expresión await,Expresiones
@anchor{reference/expressions power}@anchor{205e}@anchor{reference/expressions the-power-operator}@anchor{205f}
@subsection El operador de potencia


@geindex power;operation
@geindex operator;**

El operador de potencia se vincula más estrechamente que los operadores unarios a su izquierda; se vincula con menos fuerza que los operadores unarios a su derecha. La sintaxis es:

@example
@anchor{reference/expressions grammar-token-python-grammar-power}@anchor{2060}power ::= (await_expr | primary) ["**" u_expr]
@end example

Por lo tanto, en una secuencia sin paréntesis de operadores unarios y de potencia, los operadores son evaluados desde la derecha a la izquierda (este no se constriñe al orden de evaluación para los operandos): @code{-1**2} resulta en @code{-1}.

El operador de potencia tiene las mismas semánticas que la función incorporada @ref{a64,,pow()} cuando se invoca con dos argumentos: este produce su argumento de la izquierda elevado a la potencia de su argumento de la derecha. Los argumentos numéricos se convierten primero en un tipo común y el resultado es de ese tipo.

Para operandos int, el resultado tiene el mismo tipo que los operandos a no ser que el segundo argumento sea negativo; en ese caso, todos los argumentos son convertidos a float y se entrega un resultado float. Por ejemplo, @code{10**2} retorna @code{100}, pero @code{10**-2} retorna @code{0.01}.

Elevar @code{0.0} a una potencia negativa resulta en un @ref{9d8,,ZeroDivisionError}. Elevar un número negativo a una potencia fraccional resulta en un número @ref{154,,complex}. (En versiones anteriores se genera un @ref{360,,ValueError}.)

This operation can be customized using the special @ref{86a,,__pow__()} and
@ref{86b,,__rpow__()} methods.

@node Aritmética unaria y operaciones bit a bit,Operaciones aritméticas binarias,El operador de potencia,Expresiones
@anchor{reference/expressions unary}@anchor{2061}@anchor{reference/expressions unary-arithmetic-and-bitwise-operations}@anchor{2062}
@subsection Aritmética unaria y operaciones bit a bit


@geindex unary;arithmetic;operation
@geindex unary;bitwise;operation

Toda la aritmética unaria y las operaciones bit a bit tienen la misma prioridad:

@example
@anchor{reference/expressions grammar-token-python-grammar-u_expr}@anchor{2063}u_expr ::= power | "-" u_expr | "+" u_expr | "~" u_expr
@end example

@geindex negation
@geindex minus
@geindex operator;- (minus)
@geindex - (minus);unary operator

The unary @code{-} (minus) operator yields the negation of its numeric argument; the
operation can be overridden with the @ref{1fb5,,__neg__()} special method.

@geindex plus
@geindex operator;+ (plus)
@geindex + (plus);unary operator

The unary @code{+} (plus) operator yields its numeric argument unchanged; the
operation can be overridden with the @ref{1fb6,,__pos__()} special method.

@geindex inversion
@geindex operator;~ (tilde)

The unary @code{~} (invert) operator yields the bitwise inversion of its integer
argument.  The bitwise inversion of @code{x} is defined as @code{-(x+1)}.  It only
applies to integral numbers or to custom objects that override the
@ref{1fb8,,__invert__()} special method.

@geindex exception;TypeError

En todos los tres casos, si el argumento no tiene el tipo apropiado, se genera una excepción @ref{228,,TypeError}.

@node Operaciones aritméticas binarias,Operaciones de desplazamiento,Aritmética unaria y operaciones bit a bit,Expresiones
@anchor{reference/expressions binary}@anchor{2064}@anchor{reference/expressions binary-arithmetic-operations}@anchor{2065}
@subsection Operaciones aritméticas binarias


@geindex binary;arithmetic;operation

Las operaciones aritméticas binarias tienen los niveles convencionales de prioridad. Tenga en cuenta que algunas de esas operaciones también aplican a ciertos tipos no numéricos. Aparte del operador de potencia, hay sólo dos niveles, uno para operadores multiplicativos y uno para aditivos:

@example
@anchor{reference/expressions grammar-token-python-grammar-m_expr}@anchor{2066}m_expr ::= u_expr | m_expr "*" u_expr | m_expr "@@" m_expr |
           m_expr "//" u_expr | m_expr "/" u_expr |
           m_expr "%" u_expr
@anchor{reference/expressions grammar-token-python-grammar-a_expr}@anchor{2067}a_expr ::= m_expr | a_expr "+" m_expr | a_expr "-" m_expr
@end example

@geindex multiplication
@geindex operator;* (asterisk)

El operador @code{*} (multiplicación) produce el producto de sus argumentos. Los argumentos pueden ser ambos números, o un argumento debe ser un entero y el otro debe ser una secuencia. En el primer caso, los números se convierten a un tipo común y luego son multiplicados. En el segundo caso, se realiza una repetición de secuencia; un factor de repetición negativo produce una secuencia vacía.

This operation can be customized using the special @ref{1f8f,,__mul__()} and
@ref{1f90,,__rmul__()} methods.

@geindex matrix multiplication
@geindex operator;@@ (at)

El operador @code{@@} (en) está destinado a ser usado para multiplicación de matrices. Ningún tipo incorporado en Python implementa este operador.

This operation can be customized using the special @ref{1f97,,__matmul__()} and
@ref{1fa0,,__rmatmul__()} methods.


Added in version 3.5.


@geindex exception;ZeroDivisionError
@geindex division
@geindex operator;/ (slash)
@geindex operator;//

Los operadores @code{/} (división) y @code{//} (división entera a la baja) producen el cociente de sus argumentos. Los argumentos numéricos son primero convertidos a un tipo común. La división entre enteros producen un número de punto flotante, mientras que la división entera a la baja entre enteros resulta en un entero; el resultado es aquel de una división matemática con la función “floor” aplicada al resultado. Dividir entre 0 genera la excepción @ref{9d8,,ZeroDivisionError}.

The division operation can be customized using the special @ref{1533,,__truediv__()}
and @ref{1fa1,,__rtruediv__()} methods.
The floor division operation can be customized using the special
@ref{1534,,__floordiv__()} and @ref{1fa2,,__rfloordiv__()} methods.

@geindex modulo
@geindex operator;% (percent)

The @code{%} (modulo) operator yields the remainder from the division of the first
argument by the second.  The numeric arguments are first converted to a common
type.  A zero right argument raises the @ref{9d8,,ZeroDivisionError} exception.  The
arguments may be floating-point numbers, e.g., @code{3.14%0.7} equals @code{0.34}
(since @code{3.14} equals @code{4*0.7 + 0.34}.)  The modulo operator always yields a
result with the same sign as its second operand (or zero); the absolute value of
the result is strictly smaller than the absolute value of the second operand
@footnote{
Mientras @code{abs(x%y) < abs(y)} es matemáticamente verdadero, para números de punto flotante puede no ser verdadero numéricamente debido al redondeo. Por ejemplo, y asumiendo una plataforma en la cual un número de punto flotante de Python es un número de doble precisión IEEE 754, a fin de que @code{-1e-100 % 1e100} tenga el mismo signo que @code{1e100}, el resultado calculado es @code{-1e-100 + 1e100}, el cual es numéricamente exactamente igual a @code{1e100}. La función @ref{2068,,math.fmod()} retorna un resultado cuyo signo concuerda con el signo del primer argumento en su lugar, y por ello retorna @code{-1e-100} en este caso. La aproximación más apropiada depende de su aplicación.
}.

El operador de división entera a la baja y el de módulo están conectados por la siguiente identidad: @code{x == (x//y)*y + (x%y)}. La división entera a la baja y el módulo también están conectadas por la función incorporada @ref{a33,,divmod()}: @code{divmod(x, y) == (x//y, x%y)}. @footnote{
Si x está muy cerca de un entero exacto múltiple de y, es posible para @code{x//y} que sea uno mayor que @code{(x-x%y)//y} debido al redondeo. En tales casos, Python retorna el último resultado, a fin de preservar que @code{divmod(x,y)[0] * y + x % y} sea muy cercano a @code{x}.
}.

Adicionalmente a realizar la operación módulo en números, el operador @code{%} también está sobrecargado por objetos cadena de caracteres para realizar formateo de cadenas al estilo antiguo (también conocido como interpolación). La sintaxis para el formateo de cadenas está descrita en la Referencia de la Biblioteca de Python, sección @ref{76d,,Formateo de cadenas al estilo *printf*}.

The `modulo' operation can be customized using the special @ref{1f98,,__mod__()}
and @ref{1fa3,,__rmod__()} methods.

The floor division operator, the modulo operator, and the @ref{a33,,divmod()}
function are not defined for complex numbers.  Instead, convert to a
floating-point number using the @ref{1cab,,abs()} function if appropriate.

@geindex addition
@geindex operator;+ (plus)
@geindex + (plus);binary operator

El operador @code{+} (adición) produce la suma de sus argumentos. Los argumentos deben ser ambos números o ambos secuencias del mismo tipo. En el primer caso, los números son convertidos a un tipo común y luego sumados. En el segundo caso, las secuencias son concatenadas.

This operation can be customized using the special @ref{1f8c,,__add__()} and
@ref{1f8d,,__radd__()} methods.

@geindex subtraction
@geindex operator;- (minus)
@geindex - (minus);binary operator

El operador @code{-} (resta) produce la diferencia de sus argumentos. Los argumentos numéricos son primero convertidos a un tipo común.

This operation can be customized using the special @ref{1f96,,__sub__()} and
@ref{1f9f,,__rsub__()} methods.

@node Operaciones de desplazamiento,Operaciones bit a bit binarias,Operaciones aritméticas binarias,Expresiones
@anchor{reference/expressions shifting}@anchor{2069}@anchor{reference/expressions shifting-operations}@anchor{206a}
@subsection Operaciones de desplazamiento


@geindex shifting;operation
@geindex operator;<<
@geindex operator;>>

Las operaciones de desplazamiento tienen menos prioridad que las operaciones aritméticas:

@example
@anchor{reference/expressions grammar-token-python-grammar-shift_expr}@anchor{206b}shift_expr ::= a_expr | shift_expr ("<<" | ">>") a_expr
@end example

Estos operadores aceptan enteros como argumentos. Ellos desplazan el primer argumento a la izquierda o derecha el número de dígitos dados por el segundo argumento.

The left shift operation can be customized using the special @ref{1f9a,,__lshift__()}
and @ref{1fa5,,__rlshift__()} methods.
The right shift operation can be customized using the special @ref{1f9b,,__rshift__()}
and @ref{1fa6,,__rrshift__()} methods.

@geindex exception;ValueError

Un desplazamiento de `n' bits hacia la derecha se define como una división entera a la baja entre @code{pow(2,n)}. Un desplazamiento de `n' bits hacia la izquierda se define como una multiplicación por @code{pow(2,n)}.

@node Operaciones bit a bit binarias,Comparaciones,Operaciones de desplazamiento,Expresiones
@anchor{reference/expressions binary-bitwise-operations}@anchor{206c}@anchor{reference/expressions bitwise}@anchor{206d}
@subsection Operaciones bit a bit binarias


@geindex binary;bitwise;operation

Cada una de las tres operaciones de bits binarias tienen diferente nivel de prioridad:

@example
@anchor{reference/expressions grammar-token-python-grammar-and_expr}@anchor{206e}and_expr ::= shift_expr | and_expr "&" shift_expr
@anchor{reference/expressions grammar-token-python-grammar-xor_expr}@anchor{206f}xor_expr ::= and_expr | xor_expr "^" and_expr
@anchor{reference/expressions grammar-token-python-grammar-or_expr}@anchor{2070}or_expr  ::= xor_expr | or_expr "|" xor_expr
@end example

@geindex bitwise;and
@geindex operator;& (ampersand)

The @code{&} operator yields the bitwise AND of its arguments, which must be
integers or one of them must be a custom object overriding @ref{1f9c,,__and__()} or
@ref{1fa7,,__rand__()} special methods.

@geindex bitwise;xor
@geindex exclusive;or
@geindex operator;^ (caret)

The @code{^} operator yields the bitwise XOR (exclusive OR) of its arguments, which
must be integers or one of them must be a custom object overriding @ref{1f9d,,__xor__()} or
@ref{1fa8,,__rxor__()} special methods.

@geindex bitwise;or
@geindex inclusive;or
@geindex operator;| (vertical bar)

The @code{|} operator yields the bitwise (inclusive) OR of its arguments, which
must be integers or one of them must be a custom object overriding @ref{1f9e,,__or__()} or
@ref{1fa9,,__ror__()} special methods.

@node Comparaciones,Operaciones booleanas,Operaciones bit a bit binarias,Expresiones
@anchor{reference/expressions comparisons}@anchor{2071}@anchor{reference/expressions id12}@anchor{2072}
@subsection Comparaciones


@geindex comparison
@geindex C;language
@geindex operator;< (less)
@geindex operator;> (greater)
@geindex operator;<=
@geindex operator;>=
@geindex operator;==
@geindex operator;!=

A diferencia de C, todas las operaciones de comparación en Python tienen la misma prioridad, la cual es menor que la de cualquier operación aritmética, de desplazamiento o bit a bit. También, a diferencia de C, expresiones como @code{a < b < c} tienen la interpretación convencional en matemáticas:

@example
@anchor{reference/expressions grammar-token-python-grammar-comparison}@anchor{2073}comparison    ::= or_expr (comp_operator or_expr)*
@anchor{reference/expressions grammar-token-python-grammar-comp_operator}@anchor{2074}comp_operator ::= "<" | ">" | "==" | ">=" | "<=" | "!="
                  | "is" ["not"] | ["not"] "in"
@end example

Las comparaciones producen valores booleanos: @code{True} o @code{False}. Personalizado: dfn: los @cite{métodos de comparación enriquecidos} pueden retornar valores no booleanos. En este caso, Python llamará a @ref{513,,bool()} en dicho valor en contextos booleanos.

@geindex chaining;comparisons

Las comparaciones pueden ser encadenadas arbitrariamente, ej., @code{x < y <= z} es equivalente a @code{x < y and y <= z}, excepto que @code{y} es evaluado sólo una vez (pero en ambos casos @code{z} no es evaluado para nada cuando @code{x < y} se encuentra que es falso).

Formalmente, si `a', `b', `c', …, `y', `z' son expresiones y `op1', `op2', …, `opN' son operadores de comparación, entonces @code{a op1 b op2 c ... y opN z} es equivalente a @code{a op1 b and b op2 c and ... y opN z}, excepto que cada expresión es evaluada como mucho una vez.

Tenga en cuenta que @code{a op1 b op2 c} no implica ningún tipo de comparación entre `a' y `c', por lo que, por ejemplo, @code{x < y > z} es perfectamente legal (aunque quizás no es bonito).

@menu
* Comparaciones de valor:: 
* Operaciones de prueba de membresía:: 
* Comparaciones de identidad:: 

@end menu

@node Comparaciones de valor,Operaciones de prueba de membresía,,Comparaciones
@anchor{reference/expressions expressions-value-comparisons}@anchor{1883}@anchor{reference/expressions value-comparisons}@anchor{2075}
@subsubsection Comparaciones de valor


Los operadores @code{<}, @code{>}, @code{==}, @code{>=}, @code{<=}, y @code{!=} comparan los valores de dos objetos. Los objetos no necesitan ser del mismo tipo.

El capítulo @ref{1ee1,,Objetos@comma{} valores y tipos} afirma que los objetos tienen un valor (en adición al tipo e identidad). El valor de un objeto es una noción bastante abstracta en Python: Por ejemplo, no existe un método de acceso canónico para el valor de un objeto. Además, no se requiere que el valor de un objeto deba ser construido de una forma particular, ej. compuesto de todos sus atributos de datos. Los operadores de comparación implementan una noción particular de lo que es el valor de un objeto. Uno puede pensar en ellos definiendo el valor de un objeto indirectamente, mediante su implementación de comparación.

Because all types are (direct or indirect) subtypes of @ref{b18,,object}, they
inherit the default comparison behavior from @ref{b18,,object}.  Types can
customize their comparison behavior by implementing
`rich comparison methods' like @ref{1372,,__lt__()}, described in
@ref{1f5f,,Personalización básica}.

El comportamiento predeterminado para comparación de igualdad (@code{==} y @code{!=}) se basa en la identidad de los objetos. Por lo tanto, la comparación de instancias con la misma identidad resulta en igualdad, y la comparación de igualdad de instancias con diferentes entidades resulta en desigualdad. Una motivación para este comportamiento predeterminado es el deseo de que todos los objetos sean reflexivos (ej. @code{x is y} implica @code{x == y}).

No se provee un orden de comparación por defecto (@code{<}, @code{>}, @code{<=}, and @code{>=}); un intento genera @ref{228,,TypeError}. Una motivación para este comportamiento predeterminado es la falta de una invariante similar como para la igualdad.

El comportamiento de la comparación de igualdad predeterminado, que instancias con diferentes identidades siempre son desiguales, puede estar en contraste a que los tipos que necesitarán que tengan una definición sensata de valor de objeto e igualdad basada en el valor. Tales tipos necesitarán personalizar su comportamiento de comparación y, de hecho, un número de tipos incorporados lo han realizado.

La siguiente lista describe el comportamiento de comparación de los tipos incorporados más importantes.


@itemize *

@item 
Números de tipos numéricos incorporadas (@ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}) y tipos de la biblioteca estándar @ref{177,,fractions.Fraction} y @ref{16a,,decimal.Decimal} pueden ser comparados consigo mismos y entre sus tipos, con la restricción de que números complejos no soportan orden de comparación. Dentro de los límites de los tipos involucrados, se comparan matemáticamente (algorítmicamente) correctos sin pérdida de precisión.

Los valores no-un-número @code{float('NaN')} y @code{decimal.Decimal('NaN')} son especiales. Cualquier comparación ordenada de un número a un no-un-número es falsa. Una implicación contraintuitiva es que los valores no-un-número son son iguales a sí mismos. Por ejemplo, si @code{x = float('NaN')}, @code{3 < x}, @code{x < 3} y @code{x == x} son todos falso, mientras @code{x != x} es verdadero. Este comportamiento cumple con IEEE 754.

@item 
@code{None} and @ref{227,,NotImplemented} are singletons.  
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} advises that
comparisons for singletons should always be done with @code{is} or @code{is not},
never the equality operators.

@item 
Las secuencias binarias (instancias de @ref{325,,bytes} o @ref{5e0,,bytearray}) pueden ser comparadas entre sí y con otros tipos. Ellas comparan lexicográficamente utilizando los valores numéricos de sus elementos.

@item 
Las cadenas de caracteres (instancias de @ref{237,,str}) comparan lexicográficamente usando los puntos de códigos numéricos Unicode (el resultado de la función incorporada @ref{1eef,,ord()}) o sus caracteres. @footnote{
El estándar Unicode distingue entre `code points' (ej. U+0041) y `abstract characters' (ej. «LETRA MAYÚSCULA LATINA A»). Mientras la mayoría de caracteres abstractos en Unicode sólo son representados usando un punto de código, hay un número de caracteres abstractos que pueden adicionalmente ser representados usado una secuencia de más de un punto de código. Por ejemplo, el caracter abstracto «LETRA MAYÚSCULA C LATINA CON CEDILLA» puede ser representado como un único `precomposed character' en la posición de código U+00C7, o como una secuencia de un `base character' en la posición de código U+0043 (LETRA MAYÚSCULA C LATINA), seguida de un `combining character' en la posición de código U+0327 (CEDILLA COMBINADA).

Los operadores de comparación comparan en cadenas de caracteres al nivel de puntos de código Unicode. Esto puede ser contraintuitivo para humanos. Por ejemplo, @code{"\u00C7" == "\u0043\u0327"} es @code{False}, incluso aunque ambas cadenas presenten el mismo caracter abstracto «LETRA MAYÚSCULA C LATINA CON CEDILLA».

Para comparar cadenas al nivel de caracteres abstractos (esto es, de una forma intuitiva para humanos), usa @ref{775,,unicodedata.normalize()}.
}

Las cadenas de caracteres y las secuencias binarias no pueden ser comparadas directamente.

@item 
Las secuencias (instancias de @ref{464,,tuple}, @ref{18e,,list}, o @ref{9d6,,range}) pueden ser comparadas sólo entre cada uno de sus tipos, con la restricción de que los rangos no soportan comparación de orden. Comparación de igualdad entre esos tipos resulta en desigualdad y la comparación de orden entre esos tipos genera @ref{228,,TypeError}.

Las secuencias comparan lexicográficamente usando comparación de sus correspondientes elementos. Los contenedores incorporados asumen que los objetos idénticos son iguales a sí mismos. Eso les permite omitir las pruebas de igualdad para objetos idénticos para mejorar el rendimiento y mantener sus invariantes internos.

La comparación lexicográfica entre colecciones incorporadas funciona de la siguiente forma:


@itemize -

@item 
Para que dos colecciones sean comparadas iguales, ellas deben ser del mismo tipo, tener el mismo largo, y cada para de elementos correspondientes deben comparar iguales (por ejemplo, @code{[1,2] == (1,2)} es falso debido a que el tipo no es el mismo).

@item 
Las colecciones que soportan comparación de orden son ordenadas igual que sus primeros elementos desiguales (por ejemplo, @code{[1,2,x] <= [1,2,y]} tiene el mismo valor que @code{x <= y}). Si un elemento correspondiente no existe, la colección más corta es ordenada primero (por ejemplo, @code{[1,2] < [1,2,3]} es verdadero).
@end itemize

@item 
Mappings (instances of @ref{190,,dict}) compare equal if and only if they have
equal @code{(key, value)} pairs. Equality comparison of the keys and values
enforces reflexivity.

Comparaciones de orden (@code{<}, @code{>}, @code{<=}, and @code{>=}) generan @ref{228,,TypeError}.

@item 
Conjuntos (instancias de @ref{67a,,set} o @ref{67b,,frozenset}) pueden ser comparadas entre sí y entre sus tipos.

Ellas definen operadores de comparación de orden con la intención de comprobar subconjuntos y superconjuntos. Tales relaciones no definen ordenaciones completas (por ejemplo, los dos conjuntos @code{@{1,2@}} y @code{@{2,3@}} no son iguales, ni subconjuntos ni superconjuntos uno de otro). Acordemente, los conjuntos no son argumentos apropiados para funciones que dependen de ordenación completa (por ejemplo, @ref{f8b,,min()}, @ref{f8c,,max()} y @ref{c56,,sorted()} producen resultados indefinidos dados una lista de conjuntos como entradas).

La comparación de conjuntos refuerza la reflexibilidad de sus elementos.

@item 
La mayoría de los otros tipos incorporados no tienen métodos de comparación implementados, por lo que ellos heredan el comportamiento de comparación predeterminado.
@end itemize

Las clases definidas por el usuario que personalizan su comportamiento de comparación deben seguir algunas reglas de consistencia, si es posible:


@itemize *

@item 
La comparación de igualdad debe ser reflexiva. En otras palabras, los objetos idénticos deben comparar iguales:

@quotation

@code{x is y} implica @code{x == y}
@end quotation

@item 
La comparación debe ser simétrica. En otras palabras, las siguientes expresiones deben tener el mismo resultado:

@quotation

@code{x == y} y @code{y == x}

@code{x != y} y @code{y != x}

@code{x < y} y @code{y > x}

@code{x <= y} y @code{y >= x}
@end quotation

@item 
La comparación debe ser transitiva. Los siguientes ejemplos (no exhaustivos) ilustran esto:

@quotation

@code{x > y and y > z} implica @code{x > z}

@code{x < y and y <= z} implica @code{x < z}
@end quotation

@item 
La comparación inversa debe resultar en la negación booleana. En otras palabras, las siguientes expresiones deben tener el mismo resultado:

@quotation

@code{x == y} y @code{not x != y}

@code{x < y} y @code{not x >= y} (para ordenación completa)

@code{x > y} y @code{not x <= y} (para ordenación completa)
@end quotation

Las últimas dos expresiones aplican a colecciones completamente ordenadas (ej. a secuencias, pero no a conjuntos o mapeos). Vea también el decorador @ref{fc2,,total_ordering()}.

@item 
La función @ref{68b,,hash()} debe ser consistente con la igualdad. Los objetos que son iguales deben tener el mismo valor de hash o ser marcados como inhashables.
@end itemize

Python no fuerza a cumplir esas reglas de coherencia. De hecho, los valores no-un-número son u ejemplo para no seguir esas reglas.
@anchor{reference/expressions in}@anchor{1ed}@anchor{reference/expressions not-in}@anchor{6d0}
@node Operaciones de prueba de membresía,Comparaciones de identidad,Comparaciones de valor,Comparaciones
@anchor{reference/expressions membership-test-details}@anchor{1f93}@anchor{reference/expressions membership-test-operations}@anchor{2076}
@subsubsection Operaciones de prueba de membresía


Los operadores @ref{1ed,,in} y @ref{6d0,,not in} comprueban membresía. @code{x in s} evalúa a @code{True} si `x' es un miembro de `s' y @code{False} en caso contrario. @code{x not in s} retorna la negación de @code{x in s}. Todas las secuencias incorporadas y tipos conjuntos soportan esto, así como diccionarios, para los cuales @code{in} comprueba si un diccionario tiene una clave dada. Para tipos contenedores como list, tuple, set, frozenset, dict o collections.deque, la expresión @code{x in y} es equivalente a @code{any(x is e or x == e for e in y)}.

Para los tipos cadenas de caracteres y bytes, @code{x in y} es @code{True} si y sólo si `x' es una subcadena de `y'. Una comprobación equivalente es @code{y.find(x) != -1}. Las cadenas de caracteres vacías siempre son consideradas como subcadenas de cualquier otra cadena de caracteres, por lo que @code{"" in "abc"} retornará @code{True}.

For user-defined classes which define the @ref{1f5d,,__contains__()} method, @code{x in
y} returns @code{True} if @code{y.__contains__(x)} returns a true value, and
@code{False} otherwise.

For user-defined classes which do not define @ref{1f5d,,__contains__()} but do define
@ref{1f5b,,__iter__()}, @code{x in y} is @code{True} if some value @code{z}, for which the
expression @code{x is z or x == z} is true, is produced while iterating over @code{y}.
If an exception is raised during the iteration, it is as if @ref{1ed,,in} raised
that exception.

Lastly, the old-style iteration protocol is tried: if a class defines
@ref{3d8,,__getitem__()}, @code{x in y} is @code{True} if and only if there is a non-negative
integer index `i' such that @code{x is y[i] or x == y[i]}, and no lower integer index
raises the @ref{1575,,IndexError} exception.  (If any other exception is raised, it is as
if @ref{1ed,,in} raised that exception).

@geindex operator;in
@geindex operator;not in
@geindex membership;test
@geindex object;sequence

El operador @ref{6d0,,not in} es definido para tener el valor de veracidad inverso de @ref{1ed,,in}.

@geindex operator;is
@geindex operator;is not
@geindex identity;test
@anchor{reference/expressions is}@anchor{1ee}
@node Comparaciones de identidad,,Operaciones de prueba de membresía,Comparaciones
@anchor{reference/expressions identity-comparisons}@anchor{2077}@anchor{reference/expressions is-not}@anchor{2078}
@subsubsection Comparaciones de identidad


Los operadores @ref{1ee,,is} y @ref{2078,,is not} comprueban la identidad de un objeto. @code{x is y} es verdadero si y sólo si `x' e `y' son el mismo objeto. La identidad de un Objeto se determina usando la función @ref{1462,,id()}. @code{x is not y} produce el valor de veracidad inverso. @footnote{
Debido a la recolección automática de basura, listas libres y a la naturaleza dinámica de los descriptores, puede notar un comportamiento aparentemente inusual en ciertos usos del operador @ref{1ee,,is}, como aquellos involucrando comparaciones entre métodos de instancia, o constantes. Compruebe su documentación para más información.
}
@anchor{reference/expressions booleans}@anchor{2079}@anchor{reference/expressions and}@anchor{1e9}@anchor{reference/expressions or}@anchor{1ef}
@node Operaciones booleanas,Expresiones de asignación<2>,Comparaciones,Expresiones
@anchor{reference/expressions boolean-operations}@anchor{207a}@anchor{reference/expressions not}@anchor{207b}
@subsection Operaciones booleanas


@geindex Conditional;expression
@geindex Boolean;operation

@example
@anchor{reference/expressions grammar-token-python-grammar-or_test}@anchor{207c}or_test  ::= and_test | or_test "or" and_test
@anchor{reference/expressions grammar-token-python-grammar-and_test}@anchor{207d}and_test ::= not_test | and_test "and" not_test
@anchor{reference/expressions grammar-token-python-grammar-not_test}@anchor{207e}not_test ::= comparison | "not" not_test
@end example

In the context of Boolean operations, and also when expressions are used by
control flow statements, the following values are interpreted as false:
@code{False}, @code{None}, numeric zero of all types, and empty strings and containers
(including strings, tuples, lists, dictionaries, sets and frozensets).  All
other values are interpreted as true.  User-defined objects can customize their
truth value by providing a @ref{133d,,__bool__()} method.

@geindex operator;not

El operador @ref{207b,,not} produce @code{True} si su argumento es falso, @code{False} si no.

@geindex operator;and

La expresión @code{x and y} primero evalúa `x'; si `x' es falso, se retorna su valor; de otra forma, `y' es evaluado y se retorna el valor resultante.

@geindex operator;or

La expresión @code{x or y} primero evalúa `x'; si `x' es verdadero, se retorna su valor; de otra forma, `y' es evaluado y se retorna el valor resultante.

Tenga en cuenta que ni @ref{1e9,,and} ni @ref{1ef,,or} restringen el valor y el tipo que retornan a @code{False} y @code{True}, sino retornan el último argumento evaluado. Esto es útil a veces, ej., si @code{s} es una cadena de caracteres que debe ser remplazada por un valor predeterminado si está vacía, la expresión @code{s or 'foo'} produce el valor deseado. Debido a que @ref{207b,,not} tiene que crear un nuevo valor, retorna un valor booleano indiferentemente del tipo de su argumento (por ejemplo, @code{not 'foo'} produce @code{False} en lugar de @code{'@w{'}}.)

@geindex ;= (colon equals)
@geindex assignment expression
@geindex walrus operator
@geindex named expression
@geindex assignment;expression

@node Expresiones de asignación<2>,Expresiones condicionales,Operaciones booleanas,Expresiones
@anchor{reference/expressions assignment-expressions}@anchor{207f}@anchor{reference/expressions id15}@anchor{2080}
@subsection Expresiones de asignación


@example
@anchor{reference/expressions grammar-token-python-grammar-assignment_expression}@anchor{1fe0}assignment_expression ::= [identifier ":="] expression
@end example

An assignment expression (sometimes also called a «named expression» or
«walrus») assigns an @ref{2081,,expression} to an
@ref{1e96,,identifier}, while also returning the value of the
@ref{2081,,expression}.

Un caso de uso común es cuando se manejan expresiones regulares coincidentes:

@example
if matching := pattern.search(data):
    do_something(matching)
@end example

O, al procesar un flujo de archivos en fragmentos:

@example
while chunk := file.read(9000):
    process(chunk)
@end example

Assignment expressions must be surrounded by parentheses when
used as expression statements and when used as sub-expressions in
slicing, conditional, lambda,
keyword-argument, and comprehension-if expressions and
in @code{assert}, @code{with}, and @code{assignment} statements.
In all other places where they can be used, parentheses are not required,
including in @code{if} and @code{while} statements.


Added in version 3.8: Vea 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para más detalles sobre las expresiones de asignación.


@node Expresiones condicionales,Lambdas,Expresiones de asignación<2>,Expresiones
@anchor{reference/expressions conditional-expressions}@anchor{2082}@anchor{reference/expressions if-expr}@anchor{2083}
@subsection Expresiones condicionales


@geindex conditional;expression
@geindex ternary;operator
@geindex if;conditional expression
@geindex else;conditional expression

@example
@anchor{reference/expressions grammar-token-python-grammar-conditional_expression}@anchor{2084}conditional_expression ::= or_test ["if" or_test "else" expression]
@anchor{reference/expressions grammar-token-python-grammar-expression}@anchor{2081}expression             ::= conditional_expression | lambda_expr
@end example

Las expresiones condicionales (a veces denominadas un «operador ternario») tienen la prioridad más baja que todas las operaciones de Python.

La expresión @code{x if C else y} primero evalúa la condición, `C' en lugar de `x'. Si `C' es verdadero, `x' es evaluado y se retorna su valor; en caso contrario, `y' es evaluado y se retorna su valor.

Vea 
@geindex Python Enhancement Proposals; PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} para más detalles sobre expresiones condicionales.
@anchor{reference/expressions lambdas}@anchor{2085}
@node Lambdas,Listas de expresiones,Expresiones condicionales,Expresiones
@anchor{reference/expressions id16}@anchor{2086}@anchor{reference/expressions lambda}@anchor{1309}
@subsection Lambdas


@geindex lambda;expression
@geindex lambda;form
@geindex anonymous;function
@geindex ; (colon);lambda expression

@example
@anchor{reference/expressions grammar-token-python-grammar-lambda_expr}@anchor{2087}lambda_expr ::= "lambda" [parameter_list] ":" expression
@end example

Las expresiones lambda (a veces denominadas formas lambda) son usadas para crear funciones anónimas. La expresión @code{lambda parameters: expression} produce un objeto de función. El objeto sin nombre se comporta como un objeto función con:

@example
def <lambda>(parameters):
    return expression
@end example

Vea la sección @ref{1c3d,,Definiciones de funciones} para la sintaxis de listas de parámetros. Tenga en cuenta que las funciones creadas con expresiones lambda no pueden contener sentencias ni anotaciones.

@node Listas de expresiones,Orden de evaluación,Lambdas,Expresiones
@anchor{reference/expressions expression-lists}@anchor{2088}@anchor{reference/expressions exprlists}@anchor{e03}
@subsection Listas de expresiones


@geindex expression;list
@geindex @comma{} (comma);expression list

@example
@anchor{reference/expressions grammar-token-python-grammar-starred_expression}@anchor{2089}starred_expression       ::= ["*"] or_expr
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression}@anchor{208a}flexible_expression      ::= assignment_expression | starred_expression
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression_list}@anchor{208b}flexible_expression_list ::= flexible_expression ("," flexible_expression)* [","]
@anchor{reference/expressions grammar-token-python-grammar-starred_expression_list}@anchor{208c}starred_expression_list  ::= starred_expression ("," starred_expression)* [","]
@anchor{reference/expressions grammar-token-python-grammar-expression_list}@anchor{208d}expression_list          ::= expression ("," expression)* [","]
@anchor{reference/expressions grammar-token-python-grammar-yield_list}@anchor{203b}yield_list               ::= expression_list | starred_expression "," [starred_expression_list]
@end example

@geindex object;tuple

Excepto cuando son parte de un despliegue de lista o conjunto, una lista de expresión conteniendo al menos una coma produce una tupla. El largo de la tupla es el número de expresiones en la lista. Las expresiones son evaluadas de izquierda a derecha.

@geindex iterable;unpacking
@geindex * (asterisk);in expression lists

Un asterisco @code{*} denota `iterable unpacking'. Su operando deben ser un @ref{1294,,iterable}. El iterable es expandido en una secuencia de elementos, los cuales son incluidos en la nueva tupla, lista o conjunto en el lugar del desempaquetado.


Added in version 3.5: Desempaquetado iterable en listas de expresiones, originalmente propuesto por 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}.



Added in version 3.11: Any item in an expression list may be starred. See 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


@geindex trailing;comma

A trailing comma is required only to create a one-item tuple,
such as @code{1,}; it is optional in all other cases.
A single expression without a
trailing comma doesn’t create a tuple, but rather yields the value of that
expression. (To create an empty tuple, use an empty pair of parentheses:
@code{()}.)

@node Orden de evaluación,Prioridad de operador,Listas de expresiones,Expresiones
@anchor{reference/expressions evalorder}@anchor{208e}@anchor{reference/expressions evaluation-order}@anchor{208f}
@subsection Orden de evaluación


@geindex evaluation;order

Python evalúa las expresiones de izquierda a derecha. Note que mientras se evalúa una asignación, la parte derecha es evaluada antes que la parte izquierda.

En las siguientes líneas, las expresiones serán evaluadas en el orden aritmético de sus sufijos:

@example
expr1, expr2, expr3, expr4
(expr1, expr2, expr3, expr4)
@{expr1: expr2, expr3: expr4@}
expr1 + expr2 * (expr3 - expr4)
expr1(expr2, expr3, *expr4, **expr5)
expr3, expr4 = expr1, expr2
@end example

@node Prioridad de operador,,Orden de evaluación,Expresiones
@anchor{reference/expressions operator-precedence}@anchor{2090}@anchor{reference/expressions operator-summary}@anchor{2091}
@subsection Prioridad de operador


@geindex operator;precedence

The following table summarizes the operator precedence in Python, from highest
precedence (most binding) to lowest precedence (least binding).  Operators in
the same box have the same precedence.  Unless the syntax is explicitly given,
operators are binary.  Operators in the same box group left to right (except for
exponentiation and conditional expressions, which group from right to left).

Tenga en cuenta que las comparaciones, comprobaciones de membresía y las comprobaciones de identidad tienen la misma prioridad y una característica de encadenado de izquierda a derecha como son descritas en la sección @ref{2071,,Comparaciones}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operador

@tab

Descripción

@item

@code{(expressions...)},

@code{[expressions...]},
@code{@{key: value...@}},
@code{@{expressions...@}}

@tab

Expresión de enlace o entre paréntesis, despliegues de lista, diccionario y conjunto

@item

@code{x[index]}, @code{x[index:index]},
@code{x(arguments...)}, @code{x.attribute}

@tab

Subscripción, segmentación, invocación, referencia de atributo

@item

@ref{14e,,await x}

@tab

Expresión await

@item

@code{**}

@tab

Exponenciación @footnote{
El operador de potencia @code{**} vincula con menos fuerza que un operador unario aritmético uno bit a bit en su derecha, esto significa que @code{2**-1} is @code{0.5}.
}

@item

@code{+x}, @code{-x}, @code{~x}

@tab

NOT positivo, negativo, bit a bit

@item

@code{*}, @code{@@}, @code{/}, @code{//}, @code{%}

@tab

Multiplicación, multiplicación de matrices, división, división entera a la baja, resto (módulo) @footnote{
El operador @code{%} también es usado para formateo de cadenas; aplica la misma prioridad.
}

@item

@code{+}, @code{-}

@tab

Adición y sustracción

@item

@code{<<}, @code{>>}

@tab

Desplazamientos

@item

@code{&}

@tab

AND bit a bit

@item

@code{^}

@tab

XOR bit a bit

@item

@code{|}

@tab

OR bit a bit

@item

@ref{1ed,,in}, @ref{6d0,,not in},
@ref{1ee,,is}, @ref{2078,,is not}, @code{<},
@code{<=}, @code{>}, @code{>=}, @code{!=}, @code{==}

@tab

Comparaciones, incluyendo comprobaciones de membresía y de identidad

@item

@ref{207b,,not x}

@tab

Booleano NOT

@item

@ref{1e9,,and}

@tab

Booleano AND

@item

@ref{1ef,,or}

@tab

Booleano OR

@item

@ref{2083,,if} – @code{else}

@tab

Expresión condicional

@item

@ref{1309,,lambda}

@tab

Expresión lambda

@item

@code{:=}

@tab

Expresión de asignación

@end multitable


@subsubheading Notas al pie


@node Declaraciones simples,Sentencias compuestas,Expresiones,Referencia del Lenguaje Python
@anchor{reference/simple_stmts doc}@anchor{2092}@anchor{reference/simple_stmts simple}@anchor{2093}@anchor{reference/simple_stmts simple-statements}@anchor{2094}
@section Declaraciones simples


@geindex simple;statement

Una declaración simple se compone dentro de una sola línea lógica. Pueden producirse varias declaraciones simples en una sola línea separada por punto y coma.  La sintaxis de las declaraciones simples es:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-simple_stmt}@anchor{2095}simple_stmt ::= expression_stmt
                | assert_stmt
                | assignment_stmt
                | augmented_assignment_stmt
                | annotated_assignment_stmt
                | pass_stmt
                | del_stmt
                | return_stmt
                | yield_stmt
                | raise_stmt
                | break_stmt
                | continue_stmt
                | import_stmt
                | future_stmt
                | global_stmt
                | nonlocal_stmt
                | type_stmt
@end example

@menu
* Declaraciones de tipo expresión:: 
* Declaraciones de asignación:: 
* La declaración assert:: 
* La declaración pass:: 
* La declaración del:: 
* La declaración return:: 
* La declaración yield:: 
* La declaración raise:: 
* La declaración break:: 
* La declaración continue:: 
* La declaración import:: 
* La declaración global:: 
* La declaración nonlocal:: 
* The type statement:: 

@end menu

@node Declaraciones de tipo expresión,Declaraciones de asignación,,Declaraciones simples
@anchor{reference/simple_stmts expression-statements}@anchor{2096}@anchor{reference/simple_stmts exprstmts}@anchor{2097}
@subsection Declaraciones de tipo expresión


@geindex expression;statement
@geindex expression;list

@geindex expression;list

Las declaraciones de tipo expresión son usadas (en su mayoría interactivamente) para computar y escribir un valor, o (usualmente) para llamar a un método (una función que no retorna un resultado significativo;  en Python, los métodos retornan el valor @code{None}). Otros usos de las declaraciones de tipo expresión son permitidas y ocasionalmente útiles. La sintaxis para una declaración de tipo expresión es:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-expression_stmt}@anchor{2098}expression_stmt ::= starred_expression
@end example

Una declaración de tipo expresión evalúa la lista de expresiones (que puede ser una única expresión).

@geindex built-in function;repr
@geindex object;None
@geindex string;conversion
@geindex output
@geindex standard;output
@geindex writing;values
@geindex procedure;call

En modo interactivo, si el valor no es @code{None}, es convertido a cadena de caracteres usando la función built-in @ref{894,,repr()} y la cadena resultante es escrita en la salida estándar en una línea por si sola (excepto si el resultado es @code{None}, entonces el procedimiento llamado no produce ninguna salida.)

@node Declaraciones de asignación,La declaración assert,Declaraciones de tipo expresión,Declaraciones simples
@anchor{reference/simple_stmts assignment}@anchor{1fda}@anchor{reference/simple_stmts assignment-statements}@anchor{2099}
@subsection Declaraciones de asignación


@geindex = (equals);assignment statement
@geindex assignment;statement
@geindex binding;name
@geindex rebinding;name
@geindex object;mutable
@geindex attribute;assignment

Las declaraciones de asignación son usadas para (volver a) unir nombres a valores y para modificar atributos o elementos de objetos mutables:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assignment_stmt}@anchor{209a}assignment_stmt ::= (target_list "=")+ (starred_expression | yield_expression)
@anchor{reference/simple_stmts grammar-token-python-grammar-target_list}@anchor{209b}target_list     ::= target ("," target)* [","]
@anchor{reference/simple_stmts grammar-token-python-grammar-target}@anchor{209c}target          ::= identifier
                    | "(" [target_list] ")"
                    | "[" [target_list] "]"
                    | attributeref
                    | subscription
                    | slicing
                    | "*" target
@end example

(Ver sección @ref{2043,,Primarios} para las definiciones de sintaxis para  `attributeref', `subscription', y `slicing'.)

Una declaración de asignación evalúa la lista de expresiones (recuerda que ésta puede ser una única expresión o una lista separada por comas, la última produce una tupla) y asigna el único objeto resultante a cada una de las listas de objetivos, de izquierda a derecha.

@geindex target
@geindex target;list

Las asignaciones son definidas recursivamente dependiendo de la forma del objetivo (lista). Cuando el objetivo es parte de un objeto mutable (una referencia a un atributo, una subscripción o un segmento), el objeto mutable finalmente debe realizar la asignación y decidir sobre su validez, y puede lanzar una excepción si la asignación no es aceptable. Las reglas observadas por varios tipos y las excepciones lanzadas se dan con la definición de los tipos de objeto (ver sección @ref{1ee4,,Jerarquía de tipos estándar}).

@geindex target;list;assignment
@geindex @comma{} (comma);in target list
@geindex * (asterisk);in assignment target list
@geindex [] (square brackets);in assignment target list
@geindex () (parentheses);in assignment target list

La asignación de un objeto a una lista de destino, opcionalmente entre paréntesis o corchetes, se define de forma recursiva de la siguiente manera.


@itemize *

@item 
Si la lista de destino es un único objeto sin terminar en coma, opcionalmente entre paréntesis, el objeto es asignado a ese objetivo.

@item 
Sino:


@itemize *

@item 
Si la lista de objetivos contiene un objetivo prefijado con un asterisco, llamado objetivo “destacado”: El objeto debe ser iterable con al menos tantos elementos como objetivos en la lista de objetivos, menos uno. Los primeros elementos del iterable se asignan, de izquierda a derecha, a los objetivos antes del objetivo destacado. Los elementos finales del iterable se asignan a los objetivos después del objetivo destacado. Luego se asigna una lista de los elementos restantes en el iterable al objetivo destacado (la lista puede estar vacía).

@item 
Sino: el objeto debe ser iterable con el mismo número de elementos que los elementos en la lista de objetivos, y los elementos son asignados a sus respectivos objetivos de izquierda a derecha.
@end itemize
@end itemize

La asignación de un objeto a un único objetivo se define a continuación de manera recursiva.


@itemize *

@item 
Si el objetivo es un identificador (nombre):


@itemize *

@item 
Si el nombre no ocurre en una declaración @ref{2f5,,global} o @ref{1313,,nonlocal} en el actual bloque de código: el nombre es unido al objeto del actual espacio de nombres local.

@item 
Por otra parte: el nombre es unido al objeto en el nombre de espacio global o el nombre de espacio exterior determinado por @ref{1313,,nonlocal}, respectivamente.
@end itemize

@geindex destructor

El nombre se vuelve a unir si ya ha estado unido. Esto puede hacer que el recuento de referencia para el objeto previamente vinculado al nombre llegue a cero, provocando que el objeto se desasigne y se llame a su destructor (si tiene uno).

@geindex attribute;assignment

@item 
Si el destino es una referencia de atributo: se evalúa la expresión primaria en la referencia. Debe producir un objeto con atributos asignables; si este no es el caso, una excepción @ref{228,,TypeError} es lanzada.  Luego se le pide a ese objeto que asigne el objeto asignado al atributo dado; si no puede realizar la tarea, lanza una excepción (generalmente pero no necesariamente @ref{441,,AttributeError}).
@anchor{reference/simple_stmts attr-target-note}@anchor{209d}
Nota: Si el objeto es una instancia de clase y la referencia de atributo ocurre en ambos lados del operador de asignación, la expresión del lado derecho, @code{a.x} puede acceder a un atributo de instancia o (si no existe un atributo de instancia) a una clase atributo. El objetivo del lado izquierdo @code{a.x} siempre se establece como un atributo de instancia, creándolo si es necesario. Por lo tanto, las dos ocurrencias de @code{a.x} no necesariamente se refieren al mismo atributo: si la expresión del lado derecho se refiere a un atributo de clase, el lado izquierdo crea un nuevo atributo de instancia como el objetivo de la asignación:

@example
class Cls:
    x = 3             # class variable
inst = Cls()
inst.x = inst.x + 1   # writes inst.x as 4 leaving Cls.x as 3
@end example

Esta descripción no se aplica necesariamente a los atributos del descriptor, como las propiedades creadas con @ref{2fd,,property()}.

@geindex subscription;assignment
@geindex object;mutable

@item 
Si el objetivo es una suscripción: se evalúa la expresión primaria en la referencia. Debe producir un objeto de secuencia mutable (como una lista) o un objeto de mapeo (como un diccionario). A continuación, se evalúa la expresión del subíndice.

@geindex object;sequence
@geindex object;list

Si el primario es un objeto de secuencia mutable (como una lista), el subíndice debe producir un número entero. Si es negativo, se le suma la longitud de la secuencia. El valor resultante debe ser un número entero no negativo menor que la longitud de la secuencia, y se le pide a la secuencia que asigne el objeto asignado a su elemento con ese índice. Si el índice está fuera de rango, @ref{1575,,IndexError} se lanza (la asignación a una secuencia suscrita no puede agregar nuevos elementos a una lista).

@geindex object;mapping
@geindex object;dictionary

If the primary is a mapping object (such as a dictionary), the subscript must
have a type compatible with the mapping’s key type, and the mapping is then
asked to create a key/value pair which maps the subscript to the assigned
object.  This can either replace an existing key/value pair with the same key
value, or insert a new key/value pair (if no key with the same value existed).

For user-defined objects, the @ref{1505,,__setitem__()} method is called with
appropriate arguments.

@geindex slicing;assignment

@item 
Si el destino es un rebanado (`slicing'): la expresión principal de la referencia es evaluada. Debería producir un objeto de secuencia mutable (como una lista). El objeto asignado debe ser un objeto de secuencia del mismo tipo. A continuación, se evalúan las expresiones de límite superior e inferior, en la medida en que estén presentes; los valores predeterminados son cero y la longitud de la secuencia. Los límites deben evaluarse a números enteros. Si alguno de los límites es negativo, se le suma la longitud de la secuencia. Los límites resultantes se recortan para que se encuentren entre cero y la longitud de la secuencia, inclusive. Finalmente, se solicita al objeto de secuencia que reemplace el segmento con los elementos de la secuencia asignada. La longitud del corte puede ser diferente de la longitud de la secuencia asignada, cambiando así la longitud de la secuencia objetivo, si la secuencia objetivo lo permite.
@end itemize

`Detalles de implementación de CPython:' En la implementación actual, se considera que la sintaxis de los objetivos es la misma que la de las expresiones y se rechaza la sintaxis no válida durante la fase de generación del código, lo que genera mensajes de error menos detallados.

Aunque la definición de asignación implica que las superposiciones entre el lado izquierdo y el lado derecho son ‘simultáneas’ (por ejemplo, @code{a, b = b, a} intercambia dos variables), las superposiciones `dentro' de la colección de las variables asignadas ocurren de izquierda a derecha, lo que a veces genera confusión. Por ejemplo, el siguiente programa imprime @code{[0, 2]}:

@example
x = [0, 1]
i = 0
i, x[i] = 1, 2         # i is updated, then x[i] is updated
print(x)
@end example


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3132

@item PEP 3132@footnote{https://peps.python.org/pep-3132/} - Desembalaje Iterable Extendido

La especificación para la función @code{*target}.
@end table


@menu
* Declaraciones de asignación aumentada:: 
* Declaraciones de asignación anotadas:: 

@end menu

@node Declaraciones de asignación aumentada,Declaraciones de asignación anotadas,,Declaraciones de asignación
@anchor{reference/simple_stmts augassign}@anchor{209e}@anchor{reference/simple_stmts augmented-assignment-statements}@anchor{209f}
@subsubsection Declaraciones de asignación aumentada


@geindex augmented;assignment
@geindex statement;assignment@comma{} augmented
@geindex +=;augmented assignment
@geindex -=;augmented assignment
@geindex *=;augmented assignment
@geindex /=;augmented assignment
@geindex %=;augmented assignment
@geindex &=;augmented assignment
@geindex ^=;augmented assignment
@geindex |=;augmented assignment
@geindex **=;augmented assignment
@geindex //=;augmented assignment
@geindex >>=;augmented assignment
@geindex <<=;augmented assignment

La asignación aumentada es la combinación, en una sola declaración, de una operación binaria y una declaración de asignación:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-augmented_assignment_stmt}@anchor{20a0}augmented_assignment_stmt ::= augtarget augop (expression_list | yield_expression)
@anchor{reference/simple_stmts grammar-token-python-grammar-augtarget}@anchor{20a1}augtarget                 ::= identifier | attributeref | subscription | slicing
@anchor{reference/simple_stmts grammar-token-python-grammar-augop}@anchor{20a2}augop                     ::= "+=" | "-=" | "*=" | "@@=" | "/=" | "//=" | "%=" | "**="
                              | ">>=" | "<<=" | "&=" | "^=" | "|="
@end example

(Ver sección @ref{2043,,Primarios} para la definición de la sintaxis de los tres últimos símbolos.)

Una asignación aumentada evalúa el destino (que, a diferencia de las declaraciones de asignación normales, no puede ser un desempaquetado) y la lista de expresiones, realiza la operación binaria específica del tipo de asignación en los dos operandos y asigna el resultado al destino original.  El objetivo sólo se evalúa una vez.

An augmented assignment statement like @code{x += 1} can be rewritten as @code{x = x +
1} to achieve a similar, but not exactly equal effect. In the augmented
version, @code{x} is only evaluated once. Also, when possible, the actual operation
is performed `in-place', meaning that rather than creating a new object and
assigning that to the target, the old object is modified instead.

A diferencia de las asignaciones normales, las asignaciones aumentadas evalúan el lado izquierdo `antes' de evaluar el lado derecho.  Por ejemplo, @code{a[i] += f(x)} primero busca @code{a[i]}, entonces evalúa @code{f(x)} y realiza la suma, y finalmente, vuelve a escribir el resultado en @code{a[i]}.

Con la excepción de la asignación a tuplas y múltiples objetivos en una sola instrucción, la asignación realizada por las instrucciones de asignación aumentada se maneja de la misma manera que las asignaciones normales. De manera similar, con la excepción del posible comportamiento `in situ', la operación binaria realizada por la asignación aumentada es la misma que las operaciones binarias normales.

Para destinos que son referencias a atributos, lo mismo que @ref{209d,,caveat about class and instance attributes} se aplica para asignaciones regulares.

@node Declaraciones de asignación anotadas,,Declaraciones de asignación aumentada,Declaraciones de asignación
@anchor{reference/simple_stmts annassign}@anchor{20a3}@anchor{reference/simple_stmts annotated-assignment-statements}@anchor{20a4}
@subsubsection Declaraciones de asignación anotadas


@geindex annotated;assignment
@geindex statement;assignment@comma{} annotated
@geindex ; (colon);annotated variable

Asignación @ref{ddb,,Annotation} es la combinación, en una única declaración, de una variable o anotación de atributo y una declaración de asignación opcional:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-annotated_assignment_stmt}@anchor{20a5}annotated_assignment_stmt ::= augtarget ":" expression
                              ["=" (starred_expression | yield_expression)]
@end example

The difference from normal @ref{1fda,,Declaraciones de asignación} is that only a single target is allowed.

The assignment target is considered «simple» if it consists of a single
name that is not enclosed in parentheses.
For simple assignment targets, if in class or module scope,
the annotations are gathered in a lazily evaluated
@ref{2f3,,annotation scope}. The annotations can be
evaluated using the @ref{e08,,__annotations__} attribute of a
class or module, or using the facilities in the @ref{6,,annotationlib}
module.

If the assignment target is not simple (an attribute, subscript node, or
parenthesized name), the annotation is never evaluated.

Si se anota un nombre en el ámbito de una función, este nombre es local para ese ámbito. Las anotaciones nunca se evalúan y almacenan en ámbitos de función.

If the right hand side is present, an annotated
assignment performs the actual assignment as if there was no annotation
present. If the right hand side is not present for an expression
target, then the interpreter evaluates the target except for the last
@ref{1505,,__setitem__()} or @ref{1f2e,,__setattr__()} call.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - Sintaxis para anotaciones de variable

La propuesta que agregó sintaxis para anotar los tipos de variables (incluidas variables de clase y variables de instancia), en lugar de expresarlas a través de comentarios.

@geindex Python Enhancement Proposals; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Indicadores de tipo

La propuesta que agregó el módulo @ref{104,,typing} para proporcionar una sintaxis estándar para las anotaciones de tipo para ser utilizadas en herramientas de análisis estático e IDEs.
@end table



Distinto en la versión 3.8: Now annotated assignments allow the same expressions in the right hand side as
regular assignments. Previously, some expressions (like un-parenthesized
tuple expressions) caused a syntax error.



Distinto en la versión 3.14: Annotations are now lazily evaluated in a separate @ref{2f3,,annotation scope}.
If the assignment target is not simple, annotations are never evaluated.


@node La declaración assert,La declaración pass,Declaraciones de asignación,Declaraciones simples
@anchor{reference/simple_stmts assert}@anchor{9fa}@anchor{reference/simple_stmts the-assert-statement}@anchor{20a6}
@subsection La declaración @code{assert}


@geindex statement;assert
@geindex debugging;assertions
@geindex @comma{} (comma);expression list

Las declaraciones de afirmación son una forma conveniente de insertar afirmaciones de depuración en un programa:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assert_stmt}@anchor{20a7}assert_stmt ::= "assert" expression ["," expression]
@end example

La forma simple, @code{assert expressionn}, es equivalente a

@example
if __debug__:
    if not expression: raise AssertionError
@end example

La forma extendida, @code{assert expression1, expression2}, es equivalente a

@example
if __debug__:
    if not expression1: raise AssertionError(expression2)
@end example

@geindex __debug__
@geindex exception;AssertionError

These equivalences assume that @ref{871,,__debug__} and @ref{74a,,AssertionError} refer to
the built-in variables with those names.  In the current implementation, the
built-in variable @code{__debug__} is @code{True} under normal circumstances,
@code{False} when optimization is requested (command line option @ref{14f,,-O}).  The current
code generator emits no code for an @ref{9fa,,assert} statement when optimization is
requested at compile time.  Note that it is unnecessary to include the source
code for the expression that failed in the error message; it will be displayed
as part of the stack trace.

Asignaciones a @ref{871,,__debug__} son ilegales.  El valor para la variable se determina cuando arranca el intérprete.

@node La declaración pass,La declaración del,La declaración assert,Declaraciones simples
@anchor{reference/simple_stmts pass}@anchor{1c21}@anchor{reference/simple_stmts the-pass-statement}@anchor{20a8}
@subsection La declaración @code{pass}


@geindex statement;pass
@geindex null;operation
@geindex null;operation

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-pass_stmt}@anchor{20a9}pass_stmt ::= "pass"
@end example

@ref{1c21,,pass} es una operación nula — cuando se ejecuta, no sucede nada. Es útil como marcador de posición cuando se requiere una declaración sintácticamente, pero no es necesario ejecutar código, por ejemplo:

@example
def f(arg): pass    # a function that does nothing (yet)

class C: pass       # a class with no methods (yet)
@end example

@node La declaración del,La declaración return,La declaración pass,Declaraciones simples
@anchor{reference/simple_stmts del}@anchor{17ae}@anchor{reference/simple_stmts the-del-statement}@anchor{20aa}
@subsection La declaración @code{del}


@geindex statement;del
@geindex deletion;target
@geindex deletion;target;list

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-del_stmt}@anchor{20ab}del_stmt ::= "del" target_list
@end example

La eliminación se define de forma recursiva de manera muy similar a la forma en que se define la asignación. En lugar de explicarlo con todos los detalles, aquí hay algunas sugerencias.

La eliminación de una lista de objetivos elimina cada objetivo de forma recursiva, de izquierda a derecha.

@geindex statement;global
@geindex unbinding;name

La eliminación de un nombre elimina la vinculación de ese nombre del espacio de nombres local o global, dependiendo de si el nombre aparece en una declaración @ref{2f5,,global} en el mismo bloque de código.  Si el nombre no está vinculado, se lanzará una excepción @ref{4ec,,NameError}.

@geindex attribute;deletion

La supresión de referencias de atributo, suscripciones y rebanadas se pasa al objeto primario involucrado; la eliminación de una rebanada es en general equivalente a la asignación de una rebanada vacía del tipo correcto (pero incluso esto está determinado por el objeto rebanado).


Distinto en la versión 3.2: Anteriormente era ilegal eliminar un nombre del espacio de nombres local si aparece como una variable libre en un bloque anidado.


@node La declaración return,La declaración yield,La declaración del,Declaraciones simples
@anchor{reference/simple_stmts return}@anchor{a60}@anchor{reference/simple_stmts the-return-statement}@anchor{20ac}
@subsection La declaración @code{return}


@geindex statement;return
@geindex function;definition
@geindex class;definition

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-return_stmt}@anchor{20ad}return_stmt ::= "return" [expression_list]
@end example

El @ref{a60,,return} sólo puede ocurrir sintácticamente anidado en una definición de función, no dentro de una definición de clase anidada.

Si una lista de expresiones es presente, ésta es evaluada, sino es substituida por @code{None} .

@ref{a60,,return} deja la llamada a la función actual con la lista de expresiones (o @code{None}) como valor de retorno.

@geindex keyword;finally

Cuando @ref{a60,,return} pasa el control de una sentencia @ref{789,,try} con una cláusula @ref{a5c,,finally}, esa cláusula @code{finally} se ejecuta antes de dejar realmente la función.

En una función generadora, la declaración @ref{a60,,return} indica que el generador ha acabado y hará que @ref{c82,,StopIteration} se lance. El valor retornado (si lo hay) se utiliza como argumento para construir @ref{c82,,StopIteration} y se convierte en el atributo @ref{1fca,,StopIteration.value}.

En una función de generador asíncrono, una declaración @ref{a60,,return} vacía indica que el generador asíncrono ha acabado y va a lanzar un @ref{1a34,,StopAsyncIteration}.  Una declaración @code{return} no vacía es un error de sintaxis en una función generadora asíncrona.

@node La declaración yield,La declaración raise,La declaración return,Declaraciones simples
@anchor{reference/simple_stmts the-yield-statement}@anchor{20ae}@anchor{reference/simple_stmts yield}@anchor{a5f}
@subsection La declaración @code{yield}


@geindex statement;yield
@geindex generator;function
@geindex generator;iterator
@geindex function;generator
@geindex exception;StopIteration

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-yield_stmt}@anchor{20af}yield_stmt ::= yield_expression
@end example

A @ref{a5f,,yield} statement is semantically equivalent to a @ref{2035,,yield expression}. The @code{yield} statement can be used to omit the
parentheses that would otherwise be required in the equivalent yield expression
statement. For example, the yield statements

@example
yield <expr>
yield from <expr>
@end example

son equivalentes a las funciones que producen declaraciones

@example
(yield <expr>)
(yield from <expr>)
@end example

Yield expressions and statements are only used when defining a @ref{10dd,,generator}
function, and are only used in the body of the generator function.  Using @ref{a5f,,yield}
in a function definition is sufficient to cause that definition to create a
generator function instead of a normal function.

Para todos los detalles de la semántica de @ref{a5f,,yield}, referirse a la sección @ref{2035,,Expresiones yield}.

@node La declaración raise,La declaración break,La declaración yield,Declaraciones simples
@anchor{reference/simple_stmts raise}@anchor{68d}@anchor{reference/simple_stmts the-raise-statement}@anchor{20b0}
@subsection La declaración @code{raise}


@geindex statement;raise
@geindex exception
@geindex raising;exception
@geindex __traceback__ (exception attribute)

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-raise_stmt}@anchor{20b1}raise_stmt ::= "raise" [expression ["from" expression]]
@end example

Si no hay expresiones presentes, @ref{68d,,raise} vuelve a lanzar la excepción que se está manejando actualmente, que también se conoce como `excepción activa'. Si actualmente no hay una excepción activa, se lanza una excepción @ref{1e5,,RuntimeError} que indica que se trata de un error.

De lo contrario, @ref{68d,,raise} evalúa la primera expresión como el objeto de excepción.  Debe ser una subclase o una instancia de @ref{65c,,BaseException}. Si es una clase, la instancia de excepción se obtendrá cuando sea necesario creando una instancia de la clase sin argumentos.

El `type' de la excepción es la instancia de la clase excepción, el `value' es la propia instancia.

@geindex object;traceback

A traceback object is normally created automatically when an exception is raised
and attached to it as the @ref{1330,,__traceback__} attribute.
You can create an exception and set your own traceback in one step using the
@ref{20b2,,with_traceback()} exception method (which returns the
same exception instance, with its traceback set to its argument), like so:

@example
raise Exception("foo occurred").with_traceback(tracebackobj)
@end example

@geindex exception;chaining
@geindex __cause__ (exception attribute)
@geindex __context__ (exception attribute)

The @code{from} clause is used for exception chaining: if given, the second
`expression' must be another exception class or instance. If the second
expression is an exception instance, it will be attached to the raised
exception as the @ref{1332,,__cause__} attribute (which is writable). If the
expression is an exception class, the class will be instantiated and the
resulting exception instance will be attached to the raised exception as the
@code{__cause__} attribute. If the raised exception is not handled, both
exceptions will be printed:

@example
>>> try:
...     print(1 / 0)
... except Exception as exc:
...     raise RuntimeError("Something bad happened") from exc
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    print(1 / 0)
          ~~^~~
ZeroDivisionError: division by zero

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("Something bad happened") from exc
RuntimeError: Something bad happened
@end example

A similar mechanism works implicitly if a new exception is raised when
an exception is already being handled.  An exception may be handled
when an @ref{2f6,,except} or @ref{a5c,,finally} clause, or a
@ref{673,,with} statement, is used.  The previous exception is then
attached as the new exception’s @ref{1331,,__context__} attribute:

@example
>>> try:
...     print(1 / 0)
... except:
...     raise RuntimeError("Something bad happened")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    print(1 / 0)
          ~~^~~
ZeroDivisionError: division by zero

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("Something bad happened")
RuntimeError: Something bad happened
@end example

Exception chaining can be explicitly suppressed by specifying @ref{716,,None} in
the @code{from} clause:

@example
>>> try:
...     print(1 / 0)
... except:
...     raise RuntimeError("Something bad happened") from None
...
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
RuntimeError: Something bad happened
@end example

Se puede encontrar información adicional sobre excepciones en la sección @ref{1fe6,,Excepciones}, e información sobre manejo de excepciones en la sección @ref{789,,La sentencia try}.


Distinto en la versión 3.3: @ref{716,,None} ahora es permitido como @code{Y} en @code{raise X from Y}.

Added the @ref{20b3,,__suppress_context__} attribute to suppress
automatic display of the exception context.



Distinto en la versión 3.11: Si el rastreo de la excepción activa se modifica en una cláusula @ref{2f6,,except}, una instrucción @code{raise} posterior vuelve a generar la excepción con el rastreo modificado. Anteriormente, la excepción se volvía a generar con el rastreo que tenía cuando se detectó.


@node La declaración break,La declaración continue,La declaración raise,Declaraciones simples
@anchor{reference/simple_stmts break}@anchor{b34}@anchor{reference/simple_stmts the-break-statement}@anchor{20b4}
@subsection La declaración @code{break}


@geindex statement;break
@geindex statement;for
@geindex statement;while
@geindex loop;statement

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-break_stmt}@anchor{20b5}break_stmt ::= "break"
@end example

@ref{b34,,break} solo puede ocurrir sintácticamente anidado en un bucle @ref{1eb,,for} o @ref{1611,,while}, pero no anidado en una función o definición de clase dentro de ese bucle.

@geindex keyword;else
@geindex loop control;target

Termina el bucle adjunto más cercano, omitiendo la cláusula @code{else} opcional si el bucle tiene una.

Si un bucle @ref{1eb,,for} es terminado por @ref{b34,,break}, el objetivo de control de bucle mantiene su valor actual.

@geindex keyword;finally

Cuando @ref{b34,,break} pasa el control de una sentencia @ref{789,,try} con una cláusula @ref{a5c,,finally}, esa cláusula @code{finally} se ejecuta antes de dejar realmente el bucle.

@node La declaración continue,La declaración import,La declaración break,Declaraciones simples
@anchor{reference/simple_stmts continue}@anchor{a5b}@anchor{reference/simple_stmts the-continue-statement}@anchor{20b6}
@subsection La declaración @code{continue}


@geindex statement;continue
@geindex statement;for
@geindex statement;while
@geindex loop;statement
@geindex keyword;finally

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-continue_stmt}@anchor{20b7}continue_stmt ::= "continue"
@end example

@ref{a5b,,continue} sólo puede ocurrir sintácticamente anidado en el ciclo @ref{1eb,,for} o @ref{1611,,while}, pero no anidado en una función o definición de clase dentro de ese ciclo.  Continúa con la siguiente iteración del bucle envolvente más cercano.

Cuando @ref{a5b,,continue} pasa el control de una sentencia @ref{789,,try} con una cláusula @ref{a5c,,finally}, esa cláusula @code{finally} se ejecuta antes de empezar realmente el siguiente ciclo del bucle.
@anchor{reference/simple_stmts import}@anchor{682}
@node La declaración import,La declaración global,La declaración continue,Declaraciones simples
@anchor{reference/simple_stmts from}@anchor{1317}@anchor{reference/simple_stmts the-import-statement}@anchor{20b8}
@subsection La declaración @code{import}


@geindex statement;import
@geindex module;importing
@geindex name;binding
@geindex keyword;from
@geindex keyword;as
@geindex exception;ImportError
@geindex @comma{} (comma);import statement

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-import_stmt}@anchor{20b9}import_stmt     ::= "import" module ["as" identifier] ("," module ["as" identifier])*
                    | "from" relative_module "import" identifier ["as" identifier]
                    ("," identifier ["as" identifier])*
                    | "from" relative_module "import" "(" identifier ["as" identifier]
                    ("," identifier ["as" identifier])* [","] ")"
                    | "from" relative_module "import" "*"
@anchor{reference/simple_stmts grammar-token-python-grammar-module}@anchor{20ba}module          ::= (identifier ".")* identifier
@anchor{reference/simple_stmts grammar-token-python-grammar-relative_module}@anchor{20bb}relative_module ::= "."* module | "."+
@end example

La declaración básica de importación (sin la cláusula @ref{1317,,from}) es ejecutada en 2 pasos:


@enumerate 

@item 
encontrar un módulo, cargarlo e inicializarlo en caso de ser necesario

@item 
define un nombre o nombres en el espacio de nombres local para el alcance donde ocurre la instrucción @ref{682,,import}.
@end enumerate

Cuando la declaración contiene varias cláusulas (separadas por comas), los dos pasos se llevan a cabo por separado para cada cláusula, como si las cláusulas se hubieran separado en declaraciones de importación individuales.

The details of the first step, finding and loading modules, are described in
greater detail in the section on the @ref{1f12,,import system},
which also describes the various types of packages and modules that can
be imported, as well as all the hooks that can be used to customize
the import system. Note that failures in this step may indicate either
that the module could not be located, `or' that an error occurred while
initializing the module, which includes execution of the module’s code.

Si el módulo solicitado se recupera correctamente, estará disponible en el espacio de nombres local de una de estas tres formas:

@geindex as;import statement


@itemize *

@item 
Si el nombre del módulo va seguido de @code{as`}, entonces el nombre siguiente @code{as} está vinculado directamente al módulo importado.

@item 
Si no se especifica ningún otro nombre y el módulo que se está importando es un módulo de nivel superior, el nombre del módulo se enlaza en el espacio de nombres local como una referencia al módulo importado

@item 
Si el módulo que se está importando `no' es un módulo de nivel superior, entonces el nombre del paquete de nivel superior que contiene el módulo se enlaza en el espacio de nombres local como una referencia al paquete de nivel superior. Se debe acceder al módulo importado utilizando su nombre calificado completo en lugar de directamente
@end itemize

@geindex name;binding
@geindex from;import statement

La forma @ref{1317,,from} usa un complejo un poco más complicado:


@enumerate 

@item 
encuentra el módulo especificado en la cláusula @ref{1317,,from}, cargando e inicializándolo si es necesario;

@item 
para cada uno de los identificadores especificados en la cláusula @ref{682,,import}:


@enumerate 

@item 
compruebe si el módulo importado tiene un atributo con ese nombre

@item 
de lo contrario, intente importar un submódulo con ese nombre y luego verifique el módulo importado nuevamente para ese atributo

@item 
si el atributo no se encuentra, @ref{4d7,,ImportError} es lanzada.

@item 
de lo contrario, una referencia a ese valor se almacena en el espacio de nombres local, usando el nombre en la cláusula @code{as} si ésta está presente, de lo contrario usando el nombre del atributo
@end enumerate
@end enumerate

Ejemplos:

@example
import foo                 # foo imported and bound locally
import foo.bar.baz         # foo, foo.bar, and foo.bar.baz imported, foo bound locally
import foo.bar.baz as fbb  # foo, foo.bar, and foo.bar.baz imported, foo.bar.baz bound as fbb
from foo.bar import baz    # foo, foo.bar, and foo.bar.baz imported, foo.bar.baz bound as baz
from foo import attr       # foo imported and foo.attr bound as attr
@end example

@geindex * (asterisk);import statement

Si la lista de identificadores se reemplaza por una estrella (@code{’*’}), todos los nombres públicos definidos en el módulo se enlazan en el espacio de nombres local para el ámbito donde ocurre la declaración @ref{682,,import}.

@geindex __all__ (optional module attribute)

Los `nombres públicos' definidos por un módulo se determinan al verificar el espacio de nombres del módulo en busca de una variable llamada @code{__all__}; si se define, debe ser una secuencia de cadenas que son nombres definidos o importados por ese módulo.  Los nombres dados en @code{__all__} se consideran públicos y se requiere que existan.  Si @code{__all__} no está definido, el conjunto de nombres públicos incluye todos los nombres que se encuentran en el espacio de nombres del módulo que no comienzan con un carácter de subrayado (@code{’_’}).  @code{__all__} debe contener la API pública completa. Su objetivo es evitar la exportación accidental de elementos que no forman parte de la API (como los módulos de biblioteca que se importaron y utilizaron dentro del módulo).

La forma de importación comodín — @code{from module import *} — sólo se permite a nivel módulo.  Intentar usarlo en una definición de clase o función lanza una @ref{150,,SyntaxError}.

@geindex relative;import

Al especificar qué módulo importar, no es necesario especificar el nombre absoluto del módulo. Cuando un módulo o paquete está contenido dentro de otro paquete, es posible realizar una importación relativa dentro del mismo paquete superior sin tener que mencionar el nombre del paquete. Al usar puntos iniciales en el módulo o paquete especificado después de @ref{1317,,from}, puede especificar qué tan alto recorrer la jerarquía actual del paquete sin especificar nombres exactos. Un punto inicial significa el paquete actual donde existe el módulo que realiza la importación. Dos puntos significan un nivel de paquete. Tres puntos son dos niveles, etc. Entonces, si ejecuta @code{from . import mod} de un módulo en el paquete @code{pkg} terminará importando @code{pkg.mod}. Si ejecuta @code{from ..subpkg2 import mod} desde dentro de @code{pkg.subpkg1}, importará @code{pkg.subpkg2.mod}. La especificación para las importaciones relativas está contenida en la sección @ref{200a,,Paquete Importaciones relativas}.

@ref{5bc,,importlib.import_module()} se proporciona para soportar aplicaciones que determinan dinámicamente los módulos a cargar.

Lanza un @ref{18c3,,auditing event} @code{import} con argumentos @code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}.

@menu
* Declaraciones Futuras:: 

@end menu

@node Declaraciones Futuras,,,La declaración import
@anchor{reference/simple_stmts future}@anchor{2f4}@anchor{reference/simple_stmts future-statements}@anchor{20bc}
@subsubsection Declaraciones Futuras


@geindex future;statement
@geindex __future__;future statement

Una `future statement' es una directiva para el compilador para indicar que un módulo en particular debe compilarse usando la sintaxis o semántica que estará disponible en una versión futura específica de Python donde la característica se convierte en estándar.

La declaración futura está destinada a facilitar la migración a futuras versiones de Python que introducen cambios incompatibles en el lenguaje.  Permite el uso de las nuevas funciones por módulo antes del lanzamiento en el que la función se convierte en estándar.

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-future_stmt}@anchor{20bd}future_stmt ::= "from" "__future__" "import" feature ["as" identifier]
                ("," feature ["as" identifier])*
                | "from" "__future__" "import" "(" feature ["as" identifier]
                ("," feature ["as" identifier])* [","] ")"
@anchor{reference/simple_stmts grammar-token-python-grammar-feature}@anchor{20be}feature     ::= identifier
@end example

Una declaración futura debe aparecer cerca de la parte superior del módulo. Las únicas líneas que pueden aparecer antes de una declaración futura son:


@itemize *

@item 
el docstring del módulo (si hay),

@item 
comentarios,

@item 
lineas en blanco, y

@item 
otras declaraciones futuras.
@end itemize

La única característica en Python 3.7 que requiere el uso la declaración futuro es @code{annotations}.

108/5000
Python 3 aún reconoce todas las características históricas habilitadas por la declaración futura. La lista incluye @code{absolute_import}, @code{division}, @code{generators}, @code{generator_stop}, @code{unicode_literals}, @code{print_function}, @code{nested_scopes} y @code{with_statement}. Todos son redundantes porque siempre están habilitados y solo se conservan para compatibilidad con versiones anteriores.

Una declaración futura se reconoce y se trata especialmente en el momento de la compilación: los cambios en la semántica de las construcciones centrales a menudo se implementan generando código diferente. Incluso puede darse el caso de que una nueva característica introduzca una nueva sintaxis incompatible (como una nueva palabra reservada), en cuyo caso el compilador puede necesitar analizar el módulo de manera diferente. Tales decisiones no pueden postergarse hasta el tiempo de ejecución.

Para cualquier versión dada, el compilador sabe qué nombres de características se han definido y lanza un error en tiempo de compilación si una declaración futura contiene una característica que no conoce.

La semántica del tiempo de ejecución directo es la misma que para cualquier declaración de importación: hay un módulo estándar @ref{0,,__future__}, que se describe más adelante, y se importará de la forma habitual en el momento en que se ejecute la declaración futura.

La interesante semántica del tiempo de ejecución depende de la característica específica habilitada por la declaración futura.

Notar que no hay nada especial a cerca de la declaración:

@example
import __future__ [as name]
@end example

Esa no es una declaración futura; es una declaración de importación ordinaria sin restricciones especiales de semántica o sintaxis.

Code compiled by calls to the built-in functions @ref{2ea,,exec()} and @ref{2fb,,compile()}
that occur in a module @code{M} containing a future statement will, by default,
use the new syntax or semantics associated with the future statement.  This can
be controlled by optional arguments to @ref{2fb,,compile()} — see the documentation
of that function for details.

Una declaración futura escrita en una prompt interactiva del intérprete entrará en vigencia durante el resto de la sesión de dicho intérprete.  Si un intérprete se inicia con la opción @ref{151b,,-i}, se le pasa un nombre de script para ejecutar, y el script incluye una declaración futura, ésta estará en efecto en la sesión interactiva iniciada después de que se ejecute el script.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - Vuelta al __future__

La propuesta original para el mecanismo __future__.
@end table


@node La declaración global,La declaración nonlocal,La declaración import,Declaraciones simples
@anchor{reference/simple_stmts global}@anchor{2f5}@anchor{reference/simple_stmts the-global-statement}@anchor{20bf}
@subsection La declaración @code{global}


@geindex statement;global
@geindex global;name;binding
@geindex @comma{} (comma);identifier list

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-global_stmt}@anchor{20c0}global_stmt ::= "global" identifier ("," identifier)*
@end example

The @ref{2f5,,global} statement causes the listed identifiers to be interpreted
as globals. It would be impossible to assign to a global variable without
@code{global}, although free variables may refer to globals without being
declared global.

The @ref{2f5,,global} statement applies to the entire scope of a function or
class body. A @ref{150,,SyntaxError} is raised if a variable is used or
assigned to prior to its global declaration in the scope.

@geindex built-in function;exec
@geindex built-in function;eval
@geindex built-in function;compile

** Nota del programador: ** @ref{2f5,,global} es una directiva para el analizador.  Se aplica solo al código analizado al mismo tiempo que la declaración @code{global}. En particular, una declaración @code{global} contenida en una cadena u objeto de código suministrado a la función incorporada @ref{2ea,,exec()} no afecta el bloque de código `que contiene' la llamada a la función, y el código contenido en dicha función una cadena no se ve afectada por la declaración @code{global} en el código que contiene la llamada a la función.  Lo mismo se aplica a las funciones @ref{2eb,,eval()} y @ref{2fb,,compile()}.

@node La declaración nonlocal,The type statement,La declaración global,Declaraciones simples
@anchor{reference/simple_stmts nonlocal}@anchor{1313}@anchor{reference/simple_stmts the-nonlocal-statement}@anchor{20c1}
@subsection La declaración @code{nonlocal}


@geindex statement;nonlocal
@geindex @comma{} (comma);identifier list

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-nonlocal_stmt}@anchor{20c2}nonlocal_stmt ::= "nonlocal" identifier ("," identifier)*
@end example

When the definition of a function or class is nested (enclosed) within
the definitions of other functions, its nonlocal scopes are the local
scopes of the enclosing functions. The @ref{1313,,nonlocal} statement
causes the listed identifiers to refer to names previously bound in
nonlocal scopes. It allows encapsulated code to rebind such nonlocal
identifiers.  If a name is bound in more than one nonlocal scope, the
nearest binding is used. If a name is not bound in any nonlocal scope,
or if there is no nonlocal scope, a @ref{150,,SyntaxError} is raised.

The @ref{1313,,nonlocal} statement applies to the entire scope of a function or
class body. A @ref{150,,SyntaxError} is raised if a variable is used or
assigned to prior to its nonlocal declaration in the scope.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3104

@item PEP 3104@footnote{https://peps.python.org/pep-3104/} - Acceso a Nombres de Ámbitos externos

La especificación para la declaración @ref{1313,,nonlocal}.
@end table


`Programmer’s note:' @ref{1313,,nonlocal} is a directive to the parser
and applies only to code parsed along with it.  See the note for the
@ref{2f5,,global} statement.

@node The type statement,,La declaración nonlocal,Declaraciones simples
@anchor{reference/simple_stmts the-type-statement}@anchor{20c3}@anchor{reference/simple_stmts type}@anchor{4e6}
@subsection The @code{type} statement


@geindex statement;type

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-type_stmt}@anchor{20c4}type_stmt ::= 'type' identifier [type_params] "=" expression
@end example

The @code{type} statement declares a type alias, which is an instance
of @ref{501,,typing.TypeAliasType}.

For example, the following statement creates a type alias:

@example
type Point = tuple[float, float]
@end example

This code is roughly equivalent to:

@example
annotation-def VALUE_OF_Point():
    return tuple[float, float]
Point = typing.TypeAliasType("Point", VALUE_OF_Point())
@end example

@code{annotation-def} indicates an @ref{2f3,,annotation scope}, which behaves
mostly like a function, but with several small differences.

The value of the
type alias is evaluated in the annotation scope. It is not evaluated when the
type alias is created, but only when the value is accessed through the type alias’s
@code{__value__} attribute (see @ref{503,,Evaluación perezosa}).
This allows the type alias to refer to names that are not yet defined.

Type aliases may be made generic by adding a @ref{3fc,,type parameter list}
after the name. See @ref{502,,Generic type aliases} for more.

@code{type} is a @ref{8a3,,soft keyword}.


Added in version 3.12.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 695

@item PEP 695@footnote{https://peps.python.org/pep-0695/} - Type Parameter Syntax

Introduced the @code{type} statement and syntax for
generic classes and functions.
@end table


@node Sentencias compuestas,Componentes de nivel superior,Declaraciones simples,Referencia del Lenguaje Python
@anchor{reference/compound_stmts doc}@anchor{20c5}@anchor{reference/compound_stmts compound}@anchor{20c6}@anchor{reference/compound_stmts compound-statements}@anchor{20c7}
@section Sentencias compuestas


@geindex compound;statement

Las sentencias compuestas contienen (grupos de) otras sentencias; estas afectan o controlan la ejecución de esas otras sentencias de alguna manera. En general, las sentencias compuestas abarcan varias líneas, aunque en representaciones simples una sentencia compuesta completa puede estar contenida en una línea.

Las sentencias @ref{1ec,,if}, @ref{1611,,while} y @ref{1eb,,for} implementan construcciones de control de flujo tradicionales. @ref{789,,try} especifica gestores de excepción o código de limpieza para un grupo de sentencias, mientras que las sentencias @ref{673,,with} permite la ejecución del código de inicialización y finalización alrededor de un bloque de código. Las definiciones de función y clase también son sentencias sintácticamente compuestas.

@geindex clause
@geindex suite
@geindex ; (semicolon)

Una sentencia compuesta consta de una o más “cláusulas”. Una cláusula consta de un encabezado y una “suite”. Los encabezados de cláusula de una declaración compuesta particular están todos en el mismo nivel de indentación. Cada encabezado de cláusula comienza con una palabra clave de identificación única y termina con dos puntos. Una suite es un grupo de sentencias controladas por una cláusula. Una suite puede ser una o más sentencias simples separadas por punto y coma en la misma línea como el encabezado, siguiendo los dos puntos del encabezado, o puede ser una o puede ser una o más declaraciones indentadas en líneas posteriores. Solo la última forma de una suite puede contener sentencias compuestas anidadas; lo siguiente es ilegal, principalmente porque no estaría claro a qué cláusula @ref{1ec,,if} seguido de la cláusula @ref{1ea,,else} hace referencia:

@example
if test1: if test2: print(x)
@end example

También tenga en cuenta que el punto y coma se une más apretado que los dos puntos en este contexto, de modo que en el siguiente ejemplo, todas o ninguna de las llamadas @ref{ff4,,print()} se ejecutan:

@example
if x < y < z: print(x); print(y); print(z)
@end example

Resumiendo:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-compound_stmt}@anchor{20c8}compound_stmt ::= if_stmt
                  | while_stmt
                  | for_stmt
                  | try_stmt
                  | with_stmt
                  | match_stmt
                  | funcdef
                  | classdef
                  | async_with_stmt
                  | async_for_stmt
                  | async_funcdef
@anchor{reference/compound_stmts grammar-token-python-grammar-suite}@anchor{20c9}suite         ::= stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-statement}@anchor{20ca}statement     ::= stmt_list NEWLINE | compound_stmt
@anchor{reference/compound_stmts grammar-token-python-grammar-stmt_list}@anchor{20cb}stmt_list     ::= simple_stmt (";" simple_stmt)* [";"]
@end example

@geindex NEWLINE token
@geindex DEDENT token
@geindex dangling;else

Tenga en cuenta que las sentencias siempre terminan en un @code{NEWLINE} posiblemente seguida de @code{DEDENT}. También tenga en cuenta que las cláusulas de continuación opcionales siempre comienzan con una palabra clave que no puede iniciar una sentencia, por lo tanto, no hay ambigüedades (el problema de “colgado @ref{1ec,,if}” se resuelve en Python al requerir que las sentencias anidadas @ref{1ec,,if} deben estar indentadas).

El formato de las reglas gramaticales en las siguientes secciones coloca cada cláusula en una línea separada para mayor claridad.
@anchor{reference/compound_stmts if}@anchor{1ec}@anchor{reference/compound_stmts elif}@anchor{1c11}
@menu
* La sentencia if: La sentencia if<2>. 
* La sentencia while:: 
* La sentencia for: La sentencia for<2>. 
* La sentencia try:: 
* La sentencia with:: 
* La sentencia match: La sentencia match<2>. 
* Definiciones de funciones:: 
* Definiciones de clase:: 
* Corrutinas: Corrutinas<2>. 
* Type parameter lists:: 
* Annotations: Annotations<2>. 

@end menu

@node La sentencia if<2>,La sentencia while,,Sentencias compuestas
@anchor{reference/compound_stmts else}@anchor{1ea}@anchor{reference/compound_stmts the-if-statement}@anchor{20cc}
@subsection La sentencia @code{if}


@geindex statement;if
@geindex keyword;elif
@geindex keyword;else
@geindex ; (colon);compound statement

La sentencia @ref{1ec,,if} se usa para la ejecución condicional:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-if_stmt}@anchor{20cd}if_stmt ::= "if" assignment_expression ":" suite
            ("elif" assignment_expression ":" suite)*
            ["else" ":" suite]
@end example

Selecciona exactamente una de las suites evaluando las expresiones una por una hasta que se encuentre una verdadera (vea la sección @ref{2079,,Operaciones booleanas} para la definición de verdadero y falso); entonces esa suite se ejecuta (y ninguna otra parte de la sentencia @ref{1ec,,if} se ejecuta o evalúa). Si todas las expresiones son falsas, se ejecuta la suite de cláusulas @ref{1ea,,else}, si está presente.

@node La sentencia while,La sentencia for<2>,La sentencia if<2>,Sentencias compuestas
@anchor{reference/compound_stmts the-while-statement}@anchor{20ce}@anchor{reference/compound_stmts while}@anchor{1611}
@subsection La sentencia @code{while}


@geindex statement;while
@geindex keyword;else
@geindex loop;statement
@geindex ; (colon);compound statement

La sentencia @ref{1611,,while} se usa para la ejecución repetida siempre que una expresión sea verdadera:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-while_stmt}@anchor{20cf}while_stmt ::= "while" assignment_expression ":" suite
               ["else" ":" suite]
@end example

Esto prueba repetidamente la expresión y, si es verdadera, ejecuta la primera suite; si la expresión es falsa (que puede ser la primera vez que se prueba), se ejecuta el conjunto de cláusulas @code{else}, si está presente, y el bucle termina.

@geindex statement;break
@geindex statement;continue

La sentencia @ref{b34,,break} ejecutada en la primer suite termina el bucle sin ejecutar la suite de cláusulas @code{else}. La sentencia @ref{a5b,,continue} ejecutada en la primera suite omite el resto de la suite y vuelve a probar la expresión.

@node La sentencia for<2>,La sentencia try,La sentencia while,Sentencias compuestas
@anchor{reference/compound_stmts for}@anchor{1eb}@anchor{reference/compound_stmts the-for-statement}@anchor{20d0}
@subsection La sentencia @code{for}


@geindex statement;for
@geindex keyword;in
@geindex keyword;else
@geindex target;list
@geindex loop;statement
@geindex object;sequence
@geindex ; (colon);compound statement

La sentencia @ref{1eb,,for} se usa para iterar sobre los elementos de una secuencia (como una cadena de caracteres, tupla o lista) u otro objeto iterable:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-for_stmt}@anchor{20d1}for_stmt ::= "for" target_list "in" starred_list ":" suite
             ["else" ":" suite]
@end example

La expresión @code{starred_list} se evalúa una vez; debería producir un objeto @ref{1294,,iterable}. Se crea un @ref{313,,iterator} para ese iterable. A continuación, el primer elemento proporcionado por el iterador se asigna a la lista de destino utilizando las reglas estándar para las asignaciones (consulte @ref{1fda,,Declaraciones de asignación}) y se ejecuta la suite. Esto se repite para cada elemento proporcionado por el iterador. Cuando se agota el iterador, se ejecuta el conjunto de la cláusula @code{else}, si está presente, y el ciclo termina.

@geindex statement;break
@geindex statement;continue

La sentencia @ref{b34,,break} ejecutada en la primera suite termina el bucle sin ejecutar el conjunto de cláusulas @code{else}. La sentencia @ref{a5b,,continue} ejecutada en la primera suite omite el resto de las cláusulas y continúa con el siguiente elemento, o con la cláusula @code{else} si no hay un elemento siguiente.

El bucle @code{for} realiza asignaciones a las variables en la lista. Esto sobrescribe todas las asignaciones anteriores a esas variables, incluidas las realizadas en la suite del bucle @code{for}:

@example
for i in range(10):
    print(i)
    i = 5             # this will not affect the for-loop
                      # because i will be overwritten with the next
                      # index in the range
@end example

@geindex built-in function;range

Names in the target list are not deleted when the loop is finished, but if the
sequence is empty, they will not have been assigned to at all by the loop.  Hint:
the built-in type @ref{9d6,,range()} represents immutable arithmetic sequences of integers.
For instance, iterating @code{range(3)} successively yields 0, 1, and then 2.


Distinto en la versión 3.11: Los elementos destacados ahora están permitidos en la lista de expresiones.


@node La sentencia try,La sentencia with,La sentencia for<2>,Sentencias compuestas
@anchor{reference/compound_stmts the-try-statement}@anchor{20d2}@anchor{reference/compound_stmts try}@anchor{789}
@subsection La sentencia @code{try}


@geindex statement;try
@geindex keyword;except
@geindex keyword;finally
@geindex keyword;else
@geindex keyword;as
@geindex ; (colon);compound statement

La sentencia @code{try} especifica controladores de excepciones y/o código de limpieza para un grupo de sentencias:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-try_stmt}@anchor{20d3}try_stmt  ::= try1_stmt | try2_stmt | try3_stmt
@anchor{reference/compound_stmts grammar-token-python-grammar-try1_stmt}@anchor{20d4}try1_stmt ::= "try" ":" suite
              ("except" [expression ["as" identifier]] ":" suite)+
              ["else" ":" suite]
              ["finally" ":" suite]
@anchor{reference/compound_stmts grammar-token-python-grammar-try2_stmt}@anchor{20d5}try2_stmt ::= "try" ":" suite
              ("except" "*" expression ["as" identifier] ":" suite)+
              ["else" ":" suite]
              ["finally" ":" suite]
@anchor{reference/compound_stmts grammar-token-python-grammar-try3_stmt}@anchor{20d6}try3_stmt ::= "try" ":" suite
              "finally" ":" suite
@end example

Se puede encontrar información adicional sobre las excepciones en la sección @ref{1fe6,,Excepciones}, e información sobre el uso de la sentencia @ref{68d,,raise}, para lanzar excepciones se puede encontrar en la sección @ref{68d,,La declaración raise}.

@menu
* Cláusula except:: 
* Cláusula except*:: 
* La sentencia else:: 
* Cláusula finally:: 

@end menu

@node Cláusula except,Cláusula except*,,La sentencia try
@anchor{reference/compound_stmts except}@anchor{2f6}@anchor{reference/compound_stmts except-clause}@anchor{20d7}
@subsubsection Cláusula @code{except}


The @code{except} clause(s) specify one or more exception handlers. When no
exception occurs in the @ref{789,,try} clause, no exception handler is executed.
When an exception occurs in the @code{try} suite, a search for an exception
handler is started. This search inspects the @code{except} clauses in turn
until one is found that matches the exception.
An expression-less @code{except} clause, if present, must be last;
it matches any exception.

For an @code{except} clause with an expression, the
expression must evaluate to an exception type or a tuple of exception types.
The raised exception matches an @code{except} clause whose expression evaluates
to the class or a @ref{1224,,non-virtual base class} of the exception object,
or to a tuple that contains such a class.

Si ninguna cláusula @code{except} coincide con la excepción, la búsqueda de un controlador de excepciones continúa en el código circundante y en la pila de invocaciones. @footnote{
La excepción se propaga a la pila de invocación a menos que haya una cláusula @ref{a5c,,finally} que provoque otra excepción. Esa nueva excepción hace que se pierda la anterior.
}

Si la evaluación de una expresión en el encabezado de una cláusula @code{except} genera una excepción, la búsqueda original de un controlador se cancela y comienza una búsqueda de la nueva excepción en el código circundante y en la pila de llamadas (se trata como si toda la sentencia @ref{789,,try} generara la excepción).

@geindex as;except clause

Cuando se encuentra una cláusula @code{except} coincidente, la excepción se asigna al destino especificado después de la palabra clave @code{as} en esa cláusula @code{except}, si está presente, y se ejecuta el conjunto de la cláusula @code{except}. Todas las cláusulas @code{except} deben tener un bloque ejecutable. Cuando se alcanza el final de este bloque, la ejecución continúa normalmente después de la instrucción @ref{789,,try} completa. (Esto significa que si existen dos controladores anidados para la misma excepción y la excepción se produce en la cláusula @code{try} del controlador interno, el controlador externo no controlará la excepción).

Cuando se ha asignado una excepción mediante @code{as target}, se borra al final de la cláusula @code{except}. Esto es como si

@example
except E as N:
    foo
@end example

fue traducido a

@example
except E as N:
    try:
        foo
    finally:
        del N
@end example

Esto significa que la excepción debe asignarse a un nombre diferente para poder hacer referencia a ella después de la cláusula @code{except}. Las excepciones se borran porque con el rastreo adjunto, forman un ciclo de referencia con el marco de la pila, manteniendo todos los locales en ese marco vivos hasta que ocurra la próxima recolección de elementos no utilizados.

@geindex module;sys
@geindex object;traceback

Before an @code{except} clause’s suite is executed,
the exception is stored in the @ref{d9,,sys} module, where it can be accessed
from within the body of the @code{except} clause by calling
@ref{72c,,sys.exception()}. When leaving an exception handler, the exception
stored in the @ref{d9,,sys} module is reset to its previous value:

@example
>>> print(sys.exception())
None
>>> try:
...     raise TypeError
... except:
...     print(repr(sys.exception()))
...     try:
...          raise ValueError
...     except:
...         print(repr(sys.exception()))
...     print(repr(sys.exception()))
...
TypeError()
ValueError()
TypeError()
>>> print(sys.exception())
None
@end example

@geindex keyword;except_star

@node Cláusula except*,La sentencia else,Cláusula except,La sentencia try
@anchor{reference/compound_stmts except-star}@anchor{659}@anchor{reference/compound_stmts id2}@anchor{20d8}
@subsubsection Cláusula @code{except*}


La(s) cláusula(s) @code{except*} se utilizan para manejar @ref{31d,,ExceptionGroup}s. El tipo de excepción para la coincidencia se interpreta como en el caso de @ref{2f6,,except}, pero en el caso de los grupos de excepción podemos tener coincidencias parciales cuando el tipo coincide con algunas de las excepciones del grupo. Esto significa que se pueden ejecutar varias cláusulas @code{except*}, cada una de las cuales maneja parte del grupo de excepciones. Cada cláusula se ejecuta como máximo una vez y maneja un grupo de excepciones de todas las excepciones coincidentes. Cada excepción en el grupo es manejada por una cláusula @code{except*} como máximo, la primera que coincida.

@example
>>> try:
...     raise ExceptionGroup("eg",
...         [ValueError(1), TypeError(2), OSError(3), OSError(4)])
... except* TypeError as e:
...     print(f'caught @{type(e)@} with nested @{e.exceptions@}')
... except* OSError as e:
...     print(f'caught @{type(e)@} with nested @{e.exceptions@}')
...
caught <class 'ExceptionGroup'> with nested (TypeError(2),)
caught <class 'ExceptionGroup'> with nested (OSError(3), OSError(4))
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 2, in <module>
  | ExceptionGroup: eg
  +-+---------------- 1 ----------------
    | ValueError: 1
    +------------------------------------
@end example

Any remaining exceptions that were not handled by any @code{except*}
clause are re-raised at the end, along with all exceptions that were
raised from within the @code{except*} clauses. If this list contains
more than one exception to reraise, they are combined into an exception
group.

Si la excepción generada no es un grupo de excepciones y su tipo coincide con una de las cláusulas @code{except*}, un grupo de excepciones la captura y la encapsula con una cadena de mensaje vacía.

@example
>>> try:
...     raise BlockingIOError
... except* BlockingIOError as e:
...     print(repr(e))
...
ExceptionGroup('@w{'}, (BlockingIOError()))
@end example

An @code{except*} clause must have a matching expression; it cannot be @code{except*:}.
Furthermore, this expression cannot contain exception group types, because that would
have ambiguous semantics.

It is not possible to mix @ref{2f6,,except} and @code{except*}
in the same @ref{789,,try}.
@ref{b34,,break}, @ref{a5b,,continue} and @ref{a60,,return}
cannot appear in an @code{except*} clause.

@geindex keyword;else
@geindex statement;return
@geindex statement;break
@geindex statement;continue

@node La sentencia else,Cláusula finally,Cláusula except*,La sentencia try
@anchor{reference/compound_stmts else-clause}@anchor{20d9}@anchor{reference/compound_stmts except-else}@anchor{20da}
@subsubsection La sentencia @code{else}


La cláusula opcional @code{else} se ejecuta si el flujo de control sale de la suite @ref{789,,try}, no se produjo ninguna excepción, y no se ejecutó la sentencia @ref{a60,,return}, @ref{a5b,,continue} o @ref{b34,,break}. Las excepciones en la cláusula @code{else} no se gestionaron con las cláusulas precedentes @ref{2f6,,except}.

@geindex keyword;finally

@node Cláusula finally,,La sentencia else,La sentencia try
@anchor{reference/compound_stmts finally}@anchor{a5c}@anchor{reference/compound_stmts finally-clause}@anchor{20db}
@subsubsection Cláusula @code{finally}


Si @code{finally} está presente, especifica un controlador de “limpieza”. Se ejecuta la cláusula @ref{789,,try}, incluidas las cláusulas @ref{2f6,,except} y @ref{1ea,,else}. Si ocurre una excepción en cualquiera de las cláusulas y no se maneja, la excepción se guarda temporalmente. Se ejecuta la cláusula @code{finally}. Si hay una excepción guardada, se vuelve a generar al final de la cláusula @code{finally}. Si la cláusula @code{finally} genera otra excepción, la excepción guardada se establece como el contexto de la nueva excepción. Si la cláusula @code{finally} ejecuta una sentencia @ref{a60,,return}, @ref{b34,,break} o @ref{a5b,,continue}, la excepción guardada se descarta:

@example
>>> def f():
...     try:
...         1/0
...     finally:
...         return 42
...
>>> f()
42
@end example

La información de excepción no está disponible para el programa durante la ejecución de la cláusula @code{finally}.

@geindex statement;return
@geindex statement;break
@geindex statement;continue

Cuando se ejecuta una sentencia @ref{a60,,return}, @ref{b34,,break} o @ref{a5b,,continue} en el conjunto @ref{789,,try} de una sentencia @code{try}…@code{finally}, la cláusula @code{finally} también se ejecuta “al salir”.

El valor de retorno de una función está determinado por la última instrucción @ref{a60,,return} ejecutada. Dado que la cláusula @code{finally} siempre se ejecuta, una sentencia @code{return} ejecutada en la cláusula @code{finally} siempre será la última en ejecutarse:

@example
>>> def foo():
...     try:
...         return 'try'
...     finally:
...         return 'finally'
...
>>> foo()
'finally'
@end example


Distinto en la versión 3.8: Antes de Python 3.8, una declaración @ref{a5b,,continue} era ilegal en la cláusula @code{finally} debido a un problema con la implementación.

@anchor{reference/compound_stmts with}@anchor{673}
@node La sentencia with,La sentencia match<2>,La sentencia try,Sentencias compuestas
@anchor{reference/compound_stmts as}@anchor{20dc}@anchor{reference/compound_stmts the-with-statement}@anchor{20dd}
@subsection La sentencia @code{with}


@geindex statement;with
@geindex keyword;as
@geindex as;with statement
@geindex @comma{} (comma);with statement
@geindex ; (colon);compound statement

La sentencia @ref{673,,with} se usa para ajustar la ejecución de un bloque con métodos definidos por un administrador de contexto (ver sección @ref{1fbd,,Gestores de Contexto en la Declaración with}). Esto permite que los patrones de uso comunes @ref{789,,try}…@ref{2f6,,except}…@ref{a5c,,finally} se encapsulen para una reutilización conveniente.

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt}@anchor{20de}with_stmt          ::= "with" ( "(" with_stmt_contents ","? ")" | with_stmt_contents ) ":" suite
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt_contents}@anchor{20df}with_stmt_contents ::= with_item ("," with_item)*
@anchor{reference/compound_stmts grammar-token-python-grammar-with_item}@anchor{20e0}with_item          ::= expression ["as" target]
@end example

La ejecución de la sentencia @ref{673,,with} con un «item» se realiza de la siguiente manera:


@enumerate 

@item 
La expresión de contexto (la expresión dada en @ref{20e0,,with_item}) se evalúa para obtener un administrador de contexto.

@item 
The context manager’s @ref{669,,__enter__()} is loaded for later use.

@item 
The context manager’s @ref{1367,,__exit__()} is loaded for later use.

@item 
The context manager’s @ref{669,,__enter__()} method is invoked.

@item 
If a target was included in the @ref{673,,with} statement, the return value
from @ref{669,,__enter__()} is assigned to it.

@cartouche
@quotation Nota 
The @ref{673,,with} statement guarantees that if the @ref{669,,__enter__()}
method returns without an error, then @ref{1367,,__exit__()} will always be
called. Thus, if an error occurs during the assignment to the target list,
it will be treated the same as an error occurring within the suite would
be. See step 7 below.
@end quotation
@end cartouche

@item 
La suite se ejecuta.

@item 
The context manager’s @ref{1367,,__exit__()} method is invoked.  If an exception
caused the suite to be exited, its type, value, and traceback are passed as
arguments to @ref{1367,,__exit__()}. Otherwise, three @ref{716,,None} arguments are
supplied.

If the suite was exited due to an exception, and the return value from the
@ref{1367,,__exit__()} method was false, the exception is reraised.  If the return
value was true, the exception is suppressed, and execution continues with the
statement following the @ref{673,,with} statement.

If the suite was exited for any reason other than an exception, the return
value from @ref{1367,,__exit__()} is ignored, and execution proceeds at the normal
location for the kind of exit that was taken.
@end enumerate

El siguiente código:

@example
with EXPRESSION as TARGET:
    SUITE
@end example

es semánticamente equivalente a:

@example
manager = (EXPRESSION)
enter = type(manager).__enter__
exit = type(manager).__exit__
value = enter(manager)

try:
    TARGET = value
    SUITE
except:
    if not exit(manager, *sys.exc_info()):
        raise
else:
    exit(manager, None, None, None)
@end example

Con más de un elemento, los administradores de contexto se procesan como si varias sentencias @ref{673,,with} estuvieran anidadas:

@example
with A() as a, B() as b:
    SUITE
@end example

es semánticamente equivalente a:

@example
with A() as a:
    with B() as b:
        SUITE
@end example

También puedes escribir administradores de contexto de múltiples ítems en múltiples lineas si los ítems están entre paréntesis. Por ejemplo:

@example
with (
    A() as a,
    B() as b,
):
    SUITE
@end example


Distinto en la versión 3.1: Soporte para múltiples expresiones de contexto.



Distinto en la versión 3.10: Soporte para el uso de paréntesis de agrupación para separar la declaración en múltiples líneas.



@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - La sentencia «with»

La especificación, antecedentes y ejemplos de la sentencia de Python @ref{673,,with}.
@end table


@node La sentencia match<2>,Definiciones de funciones,La sentencia with,Sentencias compuestas
@anchor{reference/compound_stmts match}@anchor{8a4}@anchor{reference/compound_stmts the-match-statement}@anchor{20e1}
@subsection La sentencia @code{match}


@geindex statement;match
@geindex keyword;case
@geindex pattern matching
@geindex keyword;if
@geindex keyword;as
@geindex match;case
@geindex as;match statement
@geindex ; (colon);compound statement


Added in version 3.10.


La declaración match es usada para coincidencia de patrones.  Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-match_stmt}@anchor{20e2}match_stmt   ::= 'match' subject_expr ":" NEWLINE INDENT case_block+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-subject_expr}@anchor{20e3}subject_expr ::= star_named_expression "," star_named_expressions?
                 | named_expression
@anchor{reference/compound_stmts grammar-token-python-grammar-case_block}@anchor{20e4}case_block   ::= 'case' patterns [guard] ":" block
@end example

@cartouche
@quotation Nota 
Esta sección utiliza comillas simples para denotar las @ref{8a3,,palabras clave suaves}.
@end quotation
@end cartouche

La coincidencia de patrones toma un patrón como entrada (delante de @code{case}) y un valor de búsqueda (delante de @code{match}).  El patrón (que puede contener subpatrones) es comparado con el valor de búsqueda.  Los resultados son:


@itemize *

@item 
Una coincidencia exitosa o fallida (también llamada éxito o fracaso de un patrón).

@item 
Una posible vinculación de los valores coincidentes con un nombre.  Los requisitos previos para esto se discuten abajo.
@end itemize

Las palabras clave @code{match} y @code{case} son @ref{8a3,,palabras clave suaves}.


@subsubheading Ver también



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Coincidencia de patrones estructurales: Especificación

@item 
@geindex Python Enhancement Proposals; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} – Coincidencia de patrones estructurales: Tutorial
@end itemize


@menu
* Resumen: Resumen<2>. 
* Protecciones:: 
* Bloques de Casos Irrefutables:: 
* Patrones:: 

@end menu

@node Resumen<2>,Protecciones,,La sentencia match<2>
@anchor{reference/compound_stmts overview}@anchor{20e5}
@subsubsection Resumen


A continuación, un resumen del flujo lógico de una declaración de coincidencia:


@enumerate 

@item 
Se evalúa la expresión @code{subject_expr} y se obtiene un valor sujeto resultante. Si la expresión contiene una coma, se construye una tupla utilizando @ref{20e6,,las reglas estándar}.

@item 
Se intenta coincidir cada patrón en un @code{case_block} con el valor sujeto. Las reglas específicas para el éxito o el fracaso se describen abajo. El intento de coincidencia también puede enlazar algunos o todos los nombres independientes dentro del patrón. Las reglas precisas de enlace de patrones varían según el tipo de patrón y se especifican a continuación.  `Los enlaces de nombre realizados durante una coincidencia de patrones exitosa sobreviven al bloque ejecutado y se pueden usar después de la declaración de coincidencia'.

@cartouche
@quotation Nota 
Durante las coincidencias de patrones fallidas, algunos subpatrones pueden tener éxito.  No confíe en que los enlaces se realicen para una coincidencia fallida.  Por el contrario, no confíe en que las variables permanezcan sin cambios después de una coincidencia fallida.  El comportamiento exacto depende de la implementación y puede variar.  Esta es una decisión intencional para permitir que diferentes implementaciones añadan optimizaciones.
@end quotation
@end cartouche

@item 
Si el patrón es exitoso, se evalúa la protección correspondiente (si está presente). En este caso se garantiza que todos los enlaces de nombres han ocurrido.


@itemize *

@item 
Si la protección se evalúa como verdadera o no existe, se ejecuta el @code{block} dentro de @code{case_block}.

@item 
En caso contrario, se intenta con el siguiente @code{case_block} como se ha descrito anteriormente.

@item 
Si no hay más bloques de casos, la declaración de coincidencia se completa.
@end itemize
@end enumerate

@cartouche
@quotation Nota 
Por lo general, los usuarios no deben confiar en que se evalúe un patrón.  Dependiendo de la implementación, el intérprete puede almacenar en caché los valores o utilizar otras optimizaciones que omitan las evaluaciones repetidas.
@end quotation
@end cartouche

Un ejemplo de declaración de coincidencia:

@example
>>> flag = False
>>> match (100, 200):
...    case (100, 300):  # Mismatch: 200 != 300
...        print('Case 1')
...    case (100, 200) if flag:  # Successful match, but guard fails
...        print('Case 2')
...    case (100, y):  # Matches and binds y to 200
...        print(f'Case 3, y: @{y@}')
...    case _:  # Pattern not attempted
...        print('Case 4, I match anything!')
...
Case 3, y: 200
@end example

En este caso, @code{if flag} es una protección.  Lea más sobre eso en la siguiente sección.

@node Protecciones,Bloques de Casos Irrefutables,Resumen<2>,La sentencia match<2>
@anchor{reference/compound_stmts guards}@anchor{20e7}
@subsubsection Protecciones


@geindex guard

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-guard}@anchor{20e8}guard ::= "if" named_expression
@end example

Una @code{guard} (que es parte del @code{case}) debe ser exitosa para que el código dentro de @code{case} sea ejecutado.  Toma la forma: @ref{1ec,,if} seguida de una expresión.

El flujo lógico de un bloque @code{case} con una @code{guard} es el siguiente:


@enumerate 

@item 
Se comprueba que el patrón del bloque @code{case} fue exitoso.  Si el patrón falló, el @code{guard} no se evalúa y se comprueba el siguiente bloque @code{case}.

@item 
Si el patrón tuvo éxito, se evalúa el @code{guard}.


@itemize *

@item 
Si la condición del @code{guard} es verdadera, se selecciona el bloque de ese caso.

@item 
Si la condición del @code{guard} es falsa, el bloque de ese caso no es seleccionado.

@item 
Si el @code{guard} lanza una excepción durante la evaluación, se levanta la excepción.
@end itemize
@end enumerate

Se permite que las protecciones tengan efectos secundarios, ya que son expresiones.  La evaluación de la protección debe ir desde el primer al último bloque de casos, uno a la vez, saltando los bloques de casos cuyo(s) patrón(es) no tenga(n) éxito. (Es decir, la evaluación de las protecciones debe realizarse en orden.) La evaluación de las protecciones debe detenerse una vez que se selecciona un bloque de casos.

@node Bloques de Casos Irrefutables,Patrones,Protecciones,La sentencia match<2>
@anchor{reference/compound_stmts irrefutable-case}@anchor{20e9}@anchor{reference/compound_stmts irrefutable-case-blocks}@anchor{20ea}
@subsubsection Bloques de Casos Irrefutables


@geindex irrefutable case block
@geindex case block

Un bloque de casos irrefutable es un bloque de casos que coincide con todo.  Una declaración de coincidencia puede tener como máximo un bloque de casos irrefutable, y debe ser el último.

Un bloque de casos se considera irrefutable si no tiene protección y su patrón es irrefutable.  Un patrón se considera irrefutable si podemos demostrar, sólo por su sintaxis, que siempre tendrá éxito.  Sólo los siguientes patrones son irrefutables:


@itemize *

@item 
@ref{20eb,,patrones AS} cuyo lado izquierdo es irrefutable

@item 
@ref{20ec,,Patrones OR} que contienen al menos un patrón irrefutable

@item 
@ref{20ed,,Patrones de captura}

@item 
@ref{8a5,,Patrones comodín}

@item 
patrones irrefutables entre paréntesis
@end itemize

@node Patrones,,Bloques de Casos Irrefutables,La sentencia match<2>
@anchor{reference/compound_stmts patterns}@anchor{20ee}
@subsubsection Patrones


@geindex ! patterns
@geindex AS pattern@comma{} OR pattern@comma{} capture pattern@comma{} wildcard pattern

@cartouche
@quotation Nota 
Esta sección utiliza notaciones gramaticales más allá del estándar EBNF:


@itemize *

@item 
la notación @code{SEP.RULE+} es la abreviación de @code{RULE (SEP RULE)*}

@item 
la notación @code{!RULE} es la abreviación de una aserción de anticipación negativa
@end itemize
@end quotation
@end cartouche

La sintaxis de nivel superior para @code{patrones} es:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-patterns}@anchor{20ef}patterns       ::= open_sequence_pattern | pattern
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern}@anchor{20f0}pattern        ::= as_pattern | or_pattern
@anchor{reference/compound_stmts grammar-token-python-grammar-closed_pattern}@anchor{20f1}closed_pattern ::= | literal_pattern
                   | capture_pattern
                   | wildcard_pattern
                   | value_pattern
                   | group_pattern
                   | sequence_pattern
                   | mapping_pattern
                   | class_pattern
@end example

Las descripciones a continuación incluirán una descripción «en términos simples» de lo que hace un patrón con fines ilustrativos (créditos a Raymond Hettinger por un documento que inspiró la mayoría de las descripciones). Tenga en cuenta que estas descripciones tienen únicamente fines ilustrativos y que `may not' refleja la implementación subyacente. Además, no cubren todos los formularios válidos.

@menu
* Patrones OR:: 
* patrones AS:: 
* Patrones literales:: 
* Patrones de captura:: 
* Patrones comodín:: 
* Patrones de valor:: 
* Patrones de grupo:: 
* Patrones de secuencia:: 
* Patrones de mapeo:: 
* Patrones de clase:: 

@end menu

@node Patrones OR,patrones AS,,Patrones
@anchor{reference/compound_stmts id3}@anchor{20f2}@anchor{reference/compound_stmts or-patterns}@anchor{20ec}
@subsubsection Patrones OR


Un patrón OR son dos o más patrones separados por barras verticales @code{|}. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-or_pattern}@anchor{20f3}or_pattern ::= "|".closed_pattern+
@end example

Solo el subpatrón final puede ser @ref{20e9,,irrefutable}, y cada subpatrón debe vincular el mismo conjunto de nombres para evitar ambigüedades.

Un patrón OR hace coincidir cada uno de sus subpatrones a su vez con el valor del sujeto, hasta que uno tiene éxito. Entonces, el patrón OR se considera exitoso. De lo contrario, si ninguno de los subpatrones tiene éxito, el patrón OR falla.

En términos simples, @code{P1 | P2 | ...} intentará igualar @code{P1}, si falla, intentará igualar @code{P2}, teniendo éxito inmediatamente si alguno tiene éxito, fallando en caso contrario.

@node patrones AS,Patrones literales,Patrones OR,Patrones
@anchor{reference/compound_stmts as-patterns}@anchor{20eb}@anchor{reference/compound_stmts id4}@anchor{20f4}
@subsubsection patrones AS


Un patrón AS coincide con un patrón OR a la izquierda de la palabra clave @ref{20dc,,as} con un sujeto. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-as_pattern}@anchor{20f5}as_pattern ::= or_pattern "as" capture_pattern
@end example

If the OR pattern fails, the AS pattern fails.  Otherwise, the AS pattern binds
the subject to the name on the right of the as keyword and succeeds.
@code{capture_pattern} cannot be a @code{_}.

En términos simples, @code{P as NAME} coincidirá con @code{P} y, en caso de éxito, establecerá @code{NAME = <subject>}.

@node Patrones literales,Patrones de captura,patrones AS,Patrones
@anchor{reference/compound_stmts id5}@anchor{20f6}@anchor{reference/compound_stmts literal-patterns}@anchor{20f7}
@subsubsection Patrones literales


Un patrón literal corresponde a la mayoría de @ref{1ea2,,literals} en Python. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-literal_pattern}@anchor{20f8}literal_pattern ::= signed_number
                    | signed_number "+" NUMBER
                    | signed_number "-" NUMBER
                    | strings
                    | "None"
                    | "True"
                    | "False"
@anchor{reference/compound_stmts grammar-token-python-grammar-signed_number}@anchor{20f9}signed_number   ::= ["-"] NUMBER
@end example

La regla @code{strings} y el token @code{NUMBER} se definen en @ref{20fa,,standard Python grammar}. Se admiten cadenas entre comillas triples. Se admiten cadenas sin formato y cadenas de bytes. @ref{a3b,,f-strings} no es compatible.

Los formularios @code{signed_number '+' NUMBER} y @code{signed_number '-' NUMBER} son para expresar @ref{1ed8,,complex numbers}; requieren un número real a la izquierda y un número imaginario a la derecha. P.ej. @code{3 + 4j}.

En términos simples, @code{LITERAL} solo tendrá éxito si @code{<subject> == LITERAL}. Para los singleton @code{None}, @code{True} y @code{False}, se utiliza el operador @ref{1ee,,is}.

@node Patrones de captura,Patrones comodín,Patrones literales,Patrones
@anchor{reference/compound_stmts capture-patterns}@anchor{20ed}@anchor{reference/compound_stmts id6}@anchor{20fb}
@subsubsection Patrones de captura


Un patrón de captura vincula el valor del sujeto a un nombre. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-capture_pattern}@anchor{20fc}capture_pattern ::= !'_' NAME
@end example

Un solo guión bajo @code{_} no es un patrón de captura (esto es lo que expresa @code{!'_'}). En su lugar, se trata como un @ref{20fd,,wildcard_pattern}.

En un patrón dado, un nombre dado solo se puede vincular una vez. P.ej. @code{case x, x: ...} no es válido mientras @code{case [x] | x: ...} está permitido.

Los patrones de captura siempre tienen éxito. El enlace sigue las reglas de alcance establecidas por el operador de expresión de asignación en 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}; el nombre se convierte en una variable local en el alcance de la función contenedora más cercana, a menos que haya una declaración @ref{2f5,,global} o @ref{1313,,nonlocal} aplicable.

En términos simples, @code{NAME} siempre tendrá éxito y establecerá @code{NAME = <subject>}.

@node Patrones comodín,Patrones de valor,Patrones de captura,Patrones
@anchor{reference/compound_stmts id7}@anchor{20fe}@anchor{reference/compound_stmts wildcard-patterns}@anchor{8a5}
@subsubsection Patrones comodín


Un patrón comodín siempre tiene éxito (coincide con cualquier cosa) y no vincula ningún nombre. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-wildcard_pattern}@anchor{20fd}wildcard_pattern ::= '_'
@end example

@code{_} es un @ref{8a3,,soft keyword} dentro de cualquier patrón, pero solo dentro de patrones. Es un identificador, como de costumbre, incluso dentro de las expresiones de sujeto @code{match}, @code{guard} sy bloques @code{case}.

En términos simples, @code{_} siempre tendrá éxito.

@node Patrones de valor,Patrones de grupo,Patrones comodín,Patrones
@anchor{reference/compound_stmts id8}@anchor{20ff}@anchor{reference/compound_stmts value-patterns}@anchor{2100}
@subsubsection Patrones de valor


Un patrón de valor representa un valor con nombre en Python. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-value_pattern}@anchor{2101}value_pattern ::= attr
@anchor{reference/compound_stmts grammar-token-python-grammar-attr}@anchor{2102}attr          ::= name_or_attr "." NAME
@anchor{reference/compound_stmts grammar-token-python-grammar-name_or_attr}@anchor{2103}name_or_attr  ::= attr | NAME
@end example

El nombre con puntos en el patrón se busca usando el estándar Python @ref{1fdd,,name resolution rules}. El patrón tiene éxito si el valor encontrado se compara con el valor del sujeto (usando el operador de igualdad @code{==}).

En términos simples, @code{NAME1.NAME2} solo tendrá éxito si @code{<subject> == NAME1.NAME2}

@cartouche
@quotation Nota 
Si el mismo valor ocurre varias veces en la misma declaración de coincidencia, el intérprete puede almacenar en caché el primer valor encontrado y reutilizarlo en lugar de repetir la misma búsqueda. Este caché está estrictamente vinculado a una ejecución determinada de una declaración de coincidencia determinada.
@end quotation
@end cartouche

@node Patrones de grupo,Patrones de secuencia,Patrones de valor,Patrones
@anchor{reference/compound_stmts group-patterns}@anchor{2104}@anchor{reference/compound_stmts id9}@anchor{2105}
@subsubsection Patrones de grupo


Un patrón de grupo permite a los usuarios agregar paréntesis alrededor de los patrones para enfatizar la agrupación deseada. De lo contrario, no tiene sintaxis adicional. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-group_pattern}@anchor{2106}group_pattern ::= "(" pattern ")"
@end example

En términos simples, @code{(P)} tiene el mismo efecto que @code{P}.

@node Patrones de secuencia,Patrones de mapeo,Patrones de grupo,Patrones
@anchor{reference/compound_stmts id10}@anchor{2107}@anchor{reference/compound_stmts sequence-patterns}@anchor{2108}
@subsubsection Patrones de secuencia


Un patrón de secuencia contiene varios subpatrones para hacer coincidir con elementos de secuencia. La sintaxis es similar al desempaquetado de una lista o tupla.

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-sequence_pattern}@anchor{2109}sequence_pattern       ::= "[" [maybe_sequence_pattern] "]"
                           | "(" [open_sequence_pattern] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-open_sequence_pattern}@anchor{210a}open_sequence_pattern  ::= maybe_star_pattern "," [maybe_sequence_pattern]
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_sequence_pattern}@anchor{210b}maybe_sequence_pattern ::= ",".maybe_star_pattern+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_star_pattern}@anchor{210c}maybe_star_pattern     ::= star_pattern | pattern
@anchor{reference/compound_stmts grammar-token-python-grammar-star_pattern}@anchor{210d}star_pattern           ::= "*" (capture_pattern | wildcard_pattern)
@end example

No hay diferencia si se utilizan paréntesis o corchetes para los patrones de secuencia (es decir, @code{(...)} vs @code{[...]}).

@cartouche
@quotation Nota 
Un solo patrón encerrado entre paréntesis sin una coma final (por ejemplo, @code{(3 | 4)}) es un @ref{2104,,group pattern}. Mientras que un solo patrón encerrado entre corchetes (por ejemplo, @code{[3 | 4]}) sigue siendo un patrón de secuencia.
@end quotation
@end cartouche

A lo sumo, un subpatrón de estrella puede estar en un patrón de secuencia. El subpatrón de estrella puede ocurrir en cualquier posición. Si no hay ningún subpatrón de estrella, el patrón de secuencia es un patrón de secuencia de longitud fija; de lo contrario, es un patrón de secuencia de longitud variable.

El siguiente es el flujo lógico para hacer coincidir un patrón de secuencia con un valor de sujeto:


@enumerate 

@item 
Si el valor del sujeto no es una secuencia @footnote{
En la coincidencia de patrones, una secuencia se define como una de las siguientes:


@itemize *

@item 
una clase que hereda de @ref{1231,,collections.abc.Sequence}

@item 
una clase de Python que se ha registrado como @ref{1231,,collections.abc.Sequence}

@item 
a builtin class that has its (CPython) @ref{18ad,,Py_TPFLAGS_SEQUENCE} bit set

@item 
una clase que hereda de cualquiera de los anteriores
@end itemize

Las siguientes clases de biblioteca estándar son secuencias:


@itemize *

@item 
@ref{308,,array.array}

@item 
@ref{67d,,collections.deque}

@item 
@ref{18e,,list}

@item 
@ref{156,,memoryview}

@item 
@ref{9d6,,range}

@item 
@ref{464,,tuple}
@end itemize

@cartouche
@quotation Nota 
Los valores de sujeto de tipo @code{str}, @code{bytes} y @code{bytearray} no coinciden con los patrones de secuencia.
@end quotation
@end cartouche
}, el patrón de secuencia falla.

@item 
Si el valor del sujeto es una instancia de @code{str}, @code{bytes} o @code{bytearray}, el patrón de secuencia falla.

@item 
Los pasos subsiguientes dependen de si el patrón de secuencia es de longitud fija o variable.

Si el patrón de secuencia es de longitud fija:


@enumerate 

@item 
Si la longitud de la secuencia del sujeto no es igual al número de subpatrones, el patrón de secuencia falla

@item 
Los subpatrones del patrón de secuencia se hacen coincidir con sus elementos correspondientes en la secuencia del sujeto de izquierda a derecha. El emparejamiento se detiene tan pronto como falla un subpatrón. Si todos los subpatrones tienen éxito en hacer coincidir su elemento correspondiente, el patrón de secuencia tiene éxito.
@end enumerate

De lo contrario, si el patrón de secuencia es de longitud variable:


@enumerate 

@item 
Si la longitud de la secuencia del sujeto es menor que el número de subpatrones sin estrella, el patrón de secuencia falla.

@item 
Los subpatrones principales no en estrella se emparejan con sus elementos correspondientes como para las secuencias de longitud fija.

@item 
Si el paso anterior tiene éxito, el subpatrón en estrella coincide con una lista formada por los elementos restantes del sujeto, excluyendo los elementos restantes correspondientes a los subpatrones que no son en estrella que siguen el subpatrón en estrella.

@item 
Los subpatrones restantes que no son estrellas se emparejan con sus elementos temáticos correspondientes, como para una secuencia de longitud fija.
@end enumerate

@cartouche
@quotation Nota 
La longitud de la secuencia del sujeto se obtiene a través de @ref{6cf,,len()} (es decir, a través del protocolo @code{__len__()}). El intérprete puede almacenar en caché esta longitud de manera similar a @ref{2100,,value patterns}.
@end quotation
@end cartouche
@end enumerate

En términos simples, @code{[P1, P2, P3,} … @code{, P<N>]} solo coincide si ocurre todo lo siguiente:


@itemize *

@item 
comprobar que @code{<subject>} es una secuencia

@item 
@code{len(subject) == <N>}

@item 
@code{P1} coincide con @code{<subject>[0]} (tenga en cuenta que esta coincidencia también puede vincular nombres)

@item 
@code{P2} coincide con @code{<subject>[1]} (tenga en cuenta que esta coincidencia también puede vincular nombres)

@item 
… y así sucesivamente para el patrón/elemento correspondiente.
@end itemize

@node Patrones de mapeo,Patrones de clase,Patrones de secuencia,Patrones
@anchor{reference/compound_stmts id12}@anchor{210e}@anchor{reference/compound_stmts mapping-patterns}@anchor{210f}
@subsubsection Patrones de mapeo


Un patrón de asignación contiene uno o más patrones clave-valor. La sintaxis es similar a la construcción de un diccionario. Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-mapping_pattern}@anchor{2110}mapping_pattern     ::= "@{" [items_pattern] "@}"
@anchor{reference/compound_stmts grammar-token-python-grammar-items_pattern}@anchor{2111}items_pattern       ::= ",".key_value_pattern+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-key_value_pattern}@anchor{2112}key_value_pattern   ::= (literal_pattern | value_pattern) ":" pattern
                        | double_star_pattern
@anchor{reference/compound_stmts grammar-token-python-grammar-double_star_pattern}@anchor{2113}double_star_pattern ::= "**" capture_pattern
@end example

Como máximo, un patrón de estrella doble puede estar en un patrón de mapeo. El patrón de estrella doble debe ser el último subpatrón del patrón de mapeo.

No se permiten claves duplicadas en patrones de mapeo. Las claves literales duplicadas lanzarán un @ref{150,,SyntaxError}. Dos claves que de otro modo tendrían el mismo valor lanzarán un @ref{360,,ValueError} en tiempo de ejecución.

El siguiente es el flujo lógico para hacer coincidir un patrón de mapeo con un valor de sujeto:


@enumerate 

@item 
Si el valor del sujeto no es una asignación @footnote{
En la coincidencia de patrones, un mapeo se define como uno de los siguientes:


@itemize *

@item 
una clase que hereda de @ref{961,,collections.abc.Mapping}

@item 
una clase de Python que se ha registrado como @ref{961,,collections.abc.Mapping}

@item 
a builtin class that has its (CPython) @ref{18ac,,Py_TPFLAGS_MAPPING} bit set

@item 
una clase que hereda de cualquiera de los anteriores
@end itemize

Las clases de biblioteca estándar @ref{190,,dict} y @ref{518,,types.MappingProxyType} son asignaciones.
}, el patrón de asignación falla.

@item 
Si cada clave dada en el patrón de mapeo está presente en el mapeo del sujeto, y el patrón para cada clave coincide con el elemento correspondiente del mapeo del sujeto, el patrón de mapeo tiene éxito.

@item 
Si se detectan claves duplicadas en el patrón de mapeo, el patrón se considera inválido. Se lanza un @ref{150,,SyntaxError} para valores literales duplicados; o un @ref{360,,ValueError} para claves con nombre del mismo valor.
@end enumerate

@cartouche
@quotation Nota 
Key-value pairs are matched using the two-argument form of the mapping
subject’s @code{get()} method.  Matched key-value pairs must already be present
in the mapping, and not created on-the-fly via @code{__missing__()} or
@ref{3d8,,__getitem__()}.
@end quotation
@end cartouche

En términos simples, @code{@{KEY1: P1, KEY2: P2, ... @}} solo coincide si ocurre todo lo siguiente:


@itemize *

@item 
comprobar @code{<subject>} es un mapeo

@item 
@code{KEY1 in <subject>}

@item 
@code{P1} coincide con @code{<subject>[KEY1]}

@item 
… y así sucesivamente para el par correspondiente de KEY / patrón.
@end itemize

@node Patrones de clase,,Patrones de mapeo,Patrones
@anchor{reference/compound_stmts class-patterns}@anchor{2114}@anchor{reference/compound_stmts id14}@anchor{2115}
@subsubsection Patrones de clase


Un patrón de clase representa una clase y sus argumentos posicionales y de palabras clave (si los hay). Sintaxis:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-class_pattern}@anchor{2116}class_pattern       ::= name_or_attr "(" [pattern_arguments ","?] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern_arguments}@anchor{2117}pattern_arguments   ::= positional_patterns ["," keyword_patterns]
                        | keyword_patterns
@anchor{reference/compound_stmts grammar-token-python-grammar-positional_patterns}@anchor{2118}positional_patterns ::= ",".pattern+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_patterns}@anchor{2119}keyword_patterns    ::= ",".keyword_pattern+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_pattern}@anchor{211a}keyword_pattern     ::= NAME "=" pattern
@end example

La misma palabra clave no debe repetirse en los patrones de clase.

El siguiente es el flujo lógico para hacer coincidir un patrón de clase con un valor de materia:


@enumerate 

@item 
Si @code{name_or_attr} no es una instancia del @ref{dcf,,type} incorporado, genere @ref{228,,TypeError}.

@item 
Si el valor del sujeto no es una instancia de @code{name_or_attr} (probado a través de @ref{4ef,,isinstance()}), el patrón de clase falla.

@item 
Si no hay argumentos de patrón, el patrón tiene éxito. De lo contrario, los pasos siguientes dependen de si están presentes patrones de argumentos de posición o de palabras clave.

Para varios tipos integrados (especificados a continuación), se acepta un único subpatrón posicional que coincidirá con todo el tema; para estos tipos, los patrones de palabras clave también funcionan como para otros tipos.

Si solo hay patrones de palabras clave, se procesan de la siguiente manera, uno por uno:

I. La palabra clave se busca como un atributo del tema.

@quotation


@itemize *

@item 
Si esto lanza una excepción distinta de @ref{441,,AttributeError}, la excepción aparece.

@item 
Si esto lanza @ref{441,,AttributeError}, el patrón de clase ha fallado.

@item 
De lo contrario, el subpatrón asociado con el patrón de palabra clave se compara con el valor del atributo del sujeto. Si esto falla, el patrón de clase falla; si esto tiene éxito, la coincidencia continúa con la siguiente palabra clave.
@end itemize
@end quotation

II. Si todos los patrones de palabras clave tienen éxito, el patrón de clase tiene éxito.

Si hay algún patrón posicional presente, se convierte en patrones de palabras clave utilizando el atributo @ref{18c8,,__match_args__} en la clase @code{name_or_attr} antes de hacer coincidir:

I. Se llama el equivalente de @code{getattr(cls, "__match_args__", ())}.

@quotation


@itemize *

@item 
Si esto lanza una excepción, la excepción surge.

@item 
Si el valor retornado no es una tupla, la conversión falla y se lanza @ref{228,,TypeError}.

@item 
Si hay más patrones posicionales que @code{len(cls.__match_args__)}, se lanza @ref{228,,TypeError}.

@item 
De lo contrario, el patrón posicional @code{i} se convierte en un patrón de palabra clave utilizando @code{__match_args__[i]} como palabra clave. @code{__match_args__[i]} debe ser una cadena; si no, se lanza @ref{228,,TypeError}.

@item 
Si hay palabras clave duplicadas, se lanza @ref{228,,TypeError}.
@end itemize


@subsubheading Ver también


@ref{1fc0,,Personalización de argumentos posicionales en la coincidencia de patrones de clase}

@end quotation


@table @asis

@item II. Una vez que todos los patrones posicionales se hayan convertido en patrones de palabras clave,

la coincidencia procede como si solo hubiera patrones de palabras clave.
@end table

Para los siguientes tipos integrados, el manejo de subpatrones posicionales es diferente:


@itemize *

@item 
@ref{513,,bool}

@item 
@ref{5e0,,bytearray}

@item 
@ref{325,,bytes}

@item 
@ref{190,,dict}

@item 
@ref{153,,float}

@item 
@ref{67b,,frozenset}

@item 
@ref{1f0,,int}

@item 
@ref{18e,,list}

@item 
@ref{67a,,set}

@item 
@ref{237,,str}

@item 
@ref{464,,tuple}
@end itemize

Estas clases aceptan un solo argumento posicional, y el patrón allí se compara con el objeto completo en lugar de con un atributo. Por ejemplo, @code{int(0|1)} coincide con el valor @code{0}, pero no con el valor @code{0.0}.
@end enumerate

En términos simples, @code{CLS(P1, attr=P2)} solo coincide si ocurre lo siguiente:


@itemize *

@item 
@code{isinstance(<subject>, CLS)}

@item 
convierta @code{P1} en un patrón de palabra clave usando @code{CLS.__match_args__}

@item 
Para cada argumento de palabra clave @code{attr=P2}:


@itemize *

@item 
@code{hasattr(<subject>, "attr")}

@item 
@code{P2} coincide con @code{<subject>.attr}
@end itemize

@item 
… y así sucesivamente para el par de patrón / argumento de palabra clave correspondiente.
@end itemize


@subsubheading Ver también



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Coincidencia de patrones estructurales: Especificación

@item 
@geindex Python Enhancement Proposals; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} – Coincidencia de patrones estructurales: Tutorial
@end itemize


@geindex parameter;function definition
@anchor{reference/compound_stmts function}@anchor{1c3d}
@node Definiciones de funciones,Definiciones de clase,La sentencia match<2>,Sentencias compuestas
@anchor{reference/compound_stmts def}@anchor{1497}@anchor{reference/compound_stmts function-definitions}@anchor{211b}
@subsection Definiciones de funciones


@geindex statement;def
@geindex function;definition
@geindex function;name
@geindex name;binding
@geindex object;user-defined function
@geindex object;function
@geindex function;name
@geindex name;binding
@geindex () (parentheses);function definition
@geindex @comma{} (comma);parameter list
@geindex ; (colon);compound statement

Una definición de función define una función objeto determinada por el usuario (consulte la sección @ref{1ee4,,Jerarquía de tipos estándar}):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-funcdef}@anchor{211c}funcdef                   ::= [decorators] "def" funcname [type_params] "(" [parameter_list] ")"
                              ["->" expression] ":" suite
@anchor{reference/compound_stmts grammar-token-python-grammar-decorators}@anchor{211d}decorators                ::= decorator+
@anchor{reference/compound_stmts grammar-token-python-grammar-decorator}@anchor{211e}decorator                 ::= "@@" assignment_expression NEWLINE
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list}@anchor{211f}parameter_list            ::= defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]]
                                | parameter_list_no_posonly
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_no_posonly}@anchor{2120}parameter_list_no_posonly ::= defparameter ("," defparameter)* ["," [parameter_list_starargs]]
                              | parameter_list_starargs
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_starargs}@anchor{2121}parameter_list_starargs   ::= "*" [star_parameter] ("," defparameter)* ["," ["**" parameter [","]]]
                              | "**" parameter [","]
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter}@anchor{2122}parameter                 ::= identifier [":" expression]
@anchor{reference/compound_stmts grammar-token-python-grammar-star_parameter}@anchor{2123}star_parameter            ::= identifier [":" ["*"] expression]
@anchor{reference/compound_stmts grammar-token-python-grammar-defparameter}@anchor{2124}defparameter              ::= parameter ["=" expression]
@anchor{reference/compound_stmts grammar-token-python-grammar-funcname}@anchor{2125}funcname                  ::= identifier
@end example

Una definición de función es una sentencia ejecutable. Su ejecución vincula el nombre de la función en el espacio de nombres local actual a un objeto de función (un contenedor alrededor del código ejecutable para la función). Este objeto de función contiene una referencia al espacio de nombres global actual como el espacio de nombres global que se utilizará cuando se llama a la función.

La definición de la función no ejecuta el cuerpo de la función; esto se ejecuta solo cuando se llama a la función. @footnote{
A string literal appearing as the first statement in the function body is
transformed into the function’s @ref{1246,,__doc__} attribute and
therefore the function’s @ref{2126,,docstring}.
}

@geindex @@ (at);function definition

Una definición de función puede estar envuelta por una o más expresiones @ref{7cd,,decorator}. Las expresiones de decorador se evalúan cuando se define la función, en el ámbito que contiene la definición de la función. El resultado debe ser invocable, la cual se invoca con el objeto de función como único argumento. El valor retornado está vinculado al nombre de la función en lugar del objeto de la función. Se aplican múltiples decoradores de forma anidada. Por ejemplo, el siguiente código

@example
@@f1(arg)
@@f2
def func(): pass
@end example

es más o menos equivalente a

@example
def func(): pass
func = f1(arg)(f2(func))
@end example

excepto que la función original no está vinculada temporalmente al nombre @code{func}.


Distinto en la versión 3.9: Las funciones se pueden decorar con cualquier @ref{1fe0,,assignment_expression} válido. Anteriormente, la gramática era mucho más restrictiva; ver 
@geindex Python Enhancement Proposals; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para más detalles.


A list of @ref{3fc,,type parameters} may be given in square brackets
between the function’s name and the opening parenthesis for its parameter list.
This indicates to static type checkers that the function is generic. At runtime,
the type parameters can be retrieved from the function’s
@ref{1efe,,__type_params__}
attribute. See @ref{4ff,,Generic functions} for more.


Distinto en la versión 3.12: Type parameter lists are new in Python 3.12.


@geindex default;parameter;value
@geindex argument;function definition
@geindex = (equals);function definition

Cuando uno o más @ref{1efc,,parameters} tienen la forma `parameter' @code{=} `expression', se dice que la función tiene «valores de parámetros predeterminados». Para un parámetro con un valor predeterminado, el correspondiente @ref{4f6,,argument} puede omitirse desde una llamada, en cuyo caso se sustituye el valor predeterminado del parámetro. Si un parámetro tiene un valor predeterminado, todos los parámetros siguientes hasta el «@code{*}» también deben tener un valor predeterminado — esta es una restricción sintáctica que la gramática no expresa.

`Los valores de los parámetros predeterminados se evalúan de izquierda a derecha cuando se ejecuta la definición de la función.' Esto significa que la expresión se evalúa una vez, cuando se define la función, y que se utiliza el mismo valor «precalculado» para cada llamada . Esto es especialmente importante para entender cuando un parámetro predeterminado es un objeto mutable, como una lista o un diccionario: si la función modifica el objeto (por ejemplo, al agregar un elemento a una lista), el valor predeterminado está en efecto modificado. Esto generalmente no es lo que se pretendía. Una forma de evitar esto es usar @code{None} como valor predeterminado y probarlo explícitamente en el cuerpo de la función, por ejemplo:

@example
def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin
@end example

@geindex / (slash);function definition
@geindex * (asterisk);function definition
@geindex **;function definition

La semántica de llamadas de función se describe con más detalle en la sección @ref{e02,,Invocaciones}. Una llamada a la función siempre asigna valores a todos los parámetros mencionados en la lista de parámetros, ya sea desde argumentos de posición, desde argumentos por palabra clave o desde valores predeterminados. Si está presente la forma «@code{*identifier}», se inicializa en una tupla que recibe cualquier parámetro posicional excedente, por defecto en la tupla vacía. Si el formulario «@code{**identifier}» está presente, se inicializa a una nueva asignación ordenada que recibe cualquier exceso de argumentos por palabra clave, por defecto a una nueva asignación vacía del mismo tipo. Los parámetros después de «@code{*}» o «@code{*identifier}» son parámetros solo por palabra clave y solo pueden pasarse con argumentos de palabras claves usadas.


Distinto en la versión 3.8: La sintaxis del parámetro de función @code{/} se puede utilizar para indicar parámetros de posición únicamente. Consulte 
@geindex Python Enhancement Proposals; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} para obtener más detalles.


@geindex function;annotations
@geindex ->;function annotations
@geindex ; (colon);function annotations

Parameters may have an @ref{1c3e,,annotation} of the form «@code{: expression}»
following the parameter name.  Any parameter may have an annotation, even those of the form
@code{*identifier} or @code{**identifier}. (As a special case, parameters of the form
@code{*identifier} may have an annotation «@code{: *expression}».) Functions may have «return» annotation of
the form «@code{-> expression}» after the parameter list.  These annotations can be
any valid Python expression.  The presence of annotations does not change the
semantics of a function. See @ref{2127,,Annotations} for more information on annotations.


Distinto en la versión 3.11: Parameters of the form «@code{*identifier}» may have an annotation
«@code{: *expression}». See 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


@geindex lambda;expression

También es posible crear funciones anónimas (funciones no vinculadas a un nombre), para uso inmediato en expresiones. Utiliza expresiones lambda, descritas en la sección @ref{1309,,Lambdas}. Tenga en cuenta que la expresión lambda es simplemente una abreviatura para una definición de función simplificada; una función definida en una sentencia «@ref{1497,,def}» puede pasarse o asignarse a otro nombre al igual que una función definida por una expresión lambda. La forma «@code{def}» es en realidad más poderosa ya que permite la ejecución de múltiples sentencias y anotaciones.

`Nota del programador:' Las funciones son objetos de la primera-clase. Una sentencia «@code{def}» ejecutada dentro de una definición de función define una función local que se puede retornar o pasar. Las variables libres utilizadas en la función anidada pueden acceder a las variables locales de la función que contiene el def. Vea la sección @ref{1ef7,,Nombres y vínculos} para más detalles.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3107

@item PEP 3107@footnote{https://peps.python.org/pep-3107/} - Anotaciones de funciones

La especificación original para anotaciones de funciones.

@geindex Python Enhancement Proposals; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Sugerencias de tipo

Definición de un significado estándar para anotaciones: sugerencias de tipo.

@geindex Python Enhancement Proposals; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - Sintaxis para anotaciones variables

Ability to type hint variable declarations, including class
variables and instance variables.

@geindex Python Enhancement Proposals; PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} - Evaluación pospuesta de anotaciones

Admite referencias directas dentro de las anotaciones conservando las anotaciones en forma de cadena de caracteres en tiempo de ejecución en lugar de una evaluación apresurada.

@geindex Python Enhancement Proposals; PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} - Decorators for Functions and Methods

Function and method decorators were introduced.
Class decorators were introduced in 
@geindex Python Enhancement Proposals; PEP 3129
PEP 3129@footnote{https://peps.python.org/pep-3129/}.
@end table


@node Definiciones de clase,Corrutinas<2>,Definiciones de funciones,Sentencias compuestas
@anchor{reference/compound_stmts class}@anchor{133f}@anchor{reference/compound_stmts class-definitions}@anchor{2128}
@subsection Definiciones de clase


@geindex object;class
@geindex statement;class
@geindex class;definition
@geindex class;name
@geindex name;binding
@geindex execution;frame
@geindex inheritance
@geindex docstring
@geindex () (parentheses);class definition
@geindex @comma{} (comma);expression list
@geindex ; (colon);compound statement

Una definición de clase define un objeto de clase (ver sección @ref{1ee4,,Jerarquía de tipos estándar}):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-classdef}@anchor{2129}classdef    ::= [decorators] "class" classname [type_params] [inheritance] ":" suite
@anchor{reference/compound_stmts grammar-token-python-grammar-inheritance}@anchor{212a}inheritance ::= "(" [argument_list] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-classname}@anchor{212b}classname   ::= identifier
@end example

Una definición de clase es una sentencia ejecutable. La lista de herencia generalmente proporciona una lista de clases base (consulte @ref{1f73,,Metaclases} para usos más avanzados), por lo que cada elemento de la lista debe evaluar a un objeto de clase que permita la subclasificación. Las clases sin una lista de herencia heredan, por defecto, de la clase base @ref{b18,,object}; por lo tanto,

@example
class Foo:
    pass
@end example

es equivalente a

@example
class Foo(object):
    pass
@end example

La suite de la clase se ejecuta en un nuevo marco de ejecución (ver @ref{1ef7,,Nombres y vínculos}), usando un espacio de nombres local recién creado y el espacio de nombres global original. (Por lo general, el bloque contiene principalmente definiciones de funciones). Cuando la suite de la clase finaliza la ejecución, su marco de ejecución se descarta pero se guarda su espacio de nombres local. @footnote{
A string literal appearing as the first statement in the class body is
transformed into the namespace’s @ref{1cb3,,__doc__} item and therefore
the class’s @ref{2126,,docstring}.
} Luego se crea un objeto de clase utilizando la lista de herencia para las clases base y el espacio de nombres local guardado para el diccionario de atributos. El nombre de la clase está vinculado a este objeto de clase en el espacio de nombres local original.

The order in which attributes are defined in the class body is preserved
in the new class’s @ref{ce5,,__dict__}.  Note that this is reliable only right
after the class is created and only for classes that were defined using
the definition syntax.

La creación de clases se puede personalizar en gran medida usando @ref{1f73,,metaclasses}.

@geindex @@ (at);class definition

Las clases también se pueden decorar: al igual que cuando se decoran funciones,

@example
@@f1(arg)
@@f2
class Foo: pass
@end example

es más o menos equivalente a

@example
class Foo: pass
Foo = f1(arg)(f2(Foo))
@end example

Las reglas de evaluación para las expresiones de decorador son las mismas que para los decoradores de funciones. El resultado se vincula al nombre de la clase.


Distinto en la versión 3.9: Las clases se pueden decorar con cualquier @ref{1fe0,,assignment_expression} válido. Anteriormente, la gramática era mucho más restrictiva; ver 
@geindex Python Enhancement Proposals; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para más detalles.


A list of @ref{3fc,,type parameters} may be given in square brackets
immediately after the class’s name.
This indicates to static type checkers that the class is generic. At runtime,
the type parameters can be retrieved from the class’s
@ref{1f29,,__type_params__} attribute. See @ref{4fe,,Generic classes} for more.


Distinto en la versión 3.12: Type parameter lists are new in Python 3.12.


** Nota del programador: ** Las variables definidas en la definición de la clase son atributos de clase; son compartidos por instancias. Los atributos de instancia se pueden establecer en un método con @code{self.name = value}. Se puede acceder a los atributos de clase e instancia a través de la notación «@code{self.name}», y un atributo de instancia oculta un atributo de clase con el mismo nombre cuando se accede de esta manera. Los atributos de clase se pueden usar como valores predeterminados para los atributos de instancia, pero el uso de valores mutables puede generar resultados inesperados. @ref{cd7,,Descriptors} se puede usar para crear variables de instancia con diferentes detalles de implementación.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclases en Python 3000

La propuesta que cambió la declaración de metaclases a la sintaxis actual y la semántica de cómo se construyen las clases con metaclases.

@geindex Python Enhancement Proposals; PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - Decoradores de clase

La propuesta que agregó decoradores de clase. Los decoradores de funciones y métodos se introdujeron en 
@geindex Python Enhancement Proposals; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/}.
@end table


@node Corrutinas<2>,Type parameter lists,Definiciones de clase,Sentencias compuestas
@anchor{reference/compound_stmts async}@anchor{7ce}@anchor{reference/compound_stmts coroutines}@anchor{212c}
@subsection Corrutinas



Added in version 3.5.


@geindex statement;async def

@menu
* Definición de la función corrutina:: 
* La sentencia async for:: 
* La sentencia async with:: 

@end menu

@node Definición de la función corrutina,La sentencia async for,,Corrutinas<2>
@anchor{reference/compound_stmts async-def}@anchor{672}@anchor{reference/compound_stmts coroutine-function-definition}@anchor{212d}
@subsubsection Definición de la función corrutina


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_funcdef}@anchor{212e}async_funcdef ::= [decorators] "async" "def" funcname "(" [parameter_list] ")"
                  ["->" expression] ":" suite
@end example

@geindex keyword;async
@geindex keyword;await

La ejecución de corrutinas de Python se puede suspender y reanudar en muchos puntos (consulte @ref{53a,,coroutine}). Las expresiones @ref{14e,,await}, @ref{b36,,async for} y @ref{676,,async with} solo se pueden utilizar en el cuerpo de una función de corrutina.

Las funciones definidas con la sintaxis @code{async def} siempre son funciones de corrutina, incluso si no contienen palabras claves @code{await} o @code{async}.

Es un error del tipo @ref{150,,SyntaxError} usar una expresión @code{yield from} dentro del cuerpo de una función de corrutina.

Un ejemplo de una función corrutina:

@example
async def func(param1, param2):
    do_stuff()
    await some_coroutine()
@end example


Distinto en la versión 3.7: @code{await} y @code{async} ahora son palabras clave; anteriormente solo se los trataba como tales dentro del cuerpo de una función de rutina.


@geindex statement;async for

@node La sentencia async for,La sentencia async with,Definición de la función corrutina,Corrutinas<2>
@anchor{reference/compound_stmts async-for}@anchor{b36}@anchor{reference/compound_stmts the-async-for-statement}@anchor{212f}
@subsubsection La sentencia @code{async for}


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_for_stmt}@anchor{2130}async_for_stmt ::= "async" for_stmt
@end example

Un @ref{dfd,,asynchronous iterable} proporciona un método @code{__aiter__} que retorna directamente un @ref{312,,asynchronous iterator}, que puede llamar a código asincrónico en su método @code{__anext__}.

La sentencia @code{async for} permite una iteración apropiada sobre iteradores asincrónicos.

El siguiente código:

@example
async for TARGET in ITER:
    SUITE
else:
    SUITE2
@end example

Es semánticamente equivalente a:

@example
iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True

while running:
    try:
        TARGET = await type(iter).__anext__(iter)
    except StopAsyncIteration:
        running = False
    else:
        SUITE
else:
    SUITE2
@end example

Consulte también @ref{c83,,__aiter__()} y @ref{1f09,,__anext__()} para obtener más detalles.

Es un error del tipo @ref{150,,SyntaxError} usar una sentencia @code{async for} fuera del cuerpo de una función de corrutina.

@geindex statement;async with

@node La sentencia async with,,La sentencia async for,Corrutinas<2>
@anchor{reference/compound_stmts async-with}@anchor{676}@anchor{reference/compound_stmts the-async-with-statement}@anchor{2131}
@subsubsection La sentencia @code{async with}


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_with_stmt}@anchor{2132}async_with_stmt ::= "async" with_stmt
@end example

Un @ref{678,,asynchronous context manager} es un @ref{675,,context manager} que puede suspender la ejecución en sus métodos `enter' y `exit'.

El siguiente código:

@example
async with EXPRESSION as TARGET:
    SUITE
@end example

es semánticamente equivalente a:

@example
manager = (EXPRESSION)
aenter = type(manager).__aenter__
aexit = type(manager).__aexit__
value = await aenter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not await aexit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        await aexit(manager, None, None, None)
@end example

Consulte también @ref{1fd1,,__aenter__()} y @ref{1636,,__aexit__()} para obtener más detalles.

Es un error del tipo @ref{150,,SyntaxError} usar una sentencia @code{async with} fuera del cuerpo de una función de corrutina.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} - Corrutinas con sintaxis @code{async} y @code{await}

La propuesta que convirtió a las corrutinas en un concepto independiente adecuado en Python, y agregó una sintaxis de soporte.
@end table


@node Type parameter lists,Annotations<2>,Corrutinas<2>,Sentencias compuestas
@anchor{reference/compound_stmts type-parameter-lists}@anchor{2133}@anchor{reference/compound_stmts type-params}@anchor{3fc}
@subsection Type parameter lists



Added in version 3.12.



Distinto en la versión 3.13: Support for default values was added (see 
@geindex Python Enhancement Proposals; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}).


@geindex type parameters

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-type_params}@anchor{2134}type_params  ::= "[" type_param ("," type_param)* "]"
@anchor{reference/compound_stmts grammar-token-python-grammar-type_param}@anchor{2135}type_param   ::= typevar | typevartuple | paramspec
@anchor{reference/compound_stmts grammar-token-python-grammar-typevar}@anchor{2136}typevar      ::= identifier (":" expression)? ("=" expression)?
@anchor{reference/compound_stmts grammar-token-python-grammar-typevartuple}@anchor{2137}typevartuple ::= "*" identifier ("=" expression)?
@anchor{reference/compound_stmts grammar-token-python-grammar-paramspec}@anchor{2138}paramspec    ::= "**" identifier ("=" expression)?
@end example

@ref{1497,,Functions} (including @ref{672,,coroutines}),
@ref{133f,,classes} and @ref{4e6,,type aliases} may
contain a type parameter list:

@example
def max[T](args: list[T]) -> T:
    ...

async def amax[T](args: list[T]) -> T:
    ...

class Bag[T]:
    def __iter__(self) -> Iterator[T]:
        ...

    def add(self, arg: T) -> None:
        ...

type ListOrSet[T] = list[T] | set[T]
@end example

Semantically, this indicates that the function, class, or type alias is
generic over a type variable. This information is primarily used by static
type checkers, and at runtime, generic objects behave much like their
non-generic counterparts.

Type parameters are declared in square brackets (@code{[]}) immediately
after the name of the function, class, or type alias. The type parameters
are accessible within the scope of the generic object, but not elsewhere.
Thus, after a declaration @code{def func[T](): pass}, the name @code{T} is not available in
the module scope. Below, the semantics of generic objects are described
with more precision. The scope of type parameters is modeled with a special
function (technically, an @ref{2f3,,annotation scope}) that
wraps the creation of the generic object.

Generic functions, classes, and type aliases have a
@ref{2139,,__type_params__} attribute listing their type parameters.

Type parameters come in three kinds:


@itemize *

@item 
@ref{2c9,,typing.TypeVar}, introduced by a plain name (e.g., @code{T}). Semantically, this
represents a single type to a type checker.

@item 
@ref{2cb,,typing.TypeVarTuple}, introduced by a name prefixed with a single
asterisk (e.g., @code{*Ts}). Semantically, this stands for a tuple of any
number of types.

@item 
@ref{2ca,,typing.ParamSpec}, introduced by a name prefixed with two asterisks
(e.g., @code{**P}). Semantically, this stands for the parameters of a callable.
@end itemize

@ref{2c9,,typing.TypeVar} declarations can define `bounds' and `constraints' with
a colon (@code{:}) followed by an expression. A single expression after the colon
indicates a bound (e.g. @code{T: int}). Semantically, this means
that the @code{typing.TypeVar} can only represent types that are a subtype of
this bound. A parenthesized tuple of expressions after the colon indicates a
set of constraints (e.g. @code{T: (str, bytes)}). Each member of the tuple should be a
type (again, this is not enforced at runtime). Constrained type variables can only
take on one of the types in the list of constraints.

For @code{typing.TypeVar}s declared using the type parameter list syntax,
the bound and constraints are not evaluated when the generic object is created,
but only when the value is explicitly accessed through the attributes @code{__bound__}
and @code{__constraints__}. To accomplish this, the bounds or constraints are
evaluated in a separate @ref{2f3,,annotation scope}.

@ref{2cb,,typing.TypeVarTuple}s and @ref{2ca,,typing.ParamSpec}s cannot have bounds
or constraints.

All three flavors of type parameters can also have a `default value', which is used
when the type parameter is not explicitly provided. This is added by appending
a single equals sign (@code{=}) followed by an expression. Like the bounds and
constraints of type variables, the default value is not evaluated when the
object is created, but only when the type parameter’s @code{__default__} attribute
is accessed. To this end, the default value is evaluated in a separate
@ref{2f3,,annotation scope}. If no default value is specified
for a type parameter, the @code{__default__} attribute is set to the special
sentinel object @ref{3b9,,typing.NoDefault}.

The following example indicates the full set of allowed type parameter declarations:

@example
def overly_generic[
   SimpleTypeVar,
   TypeVarWithDefault = int,
   TypeVarWithBound: int,
   TypeVarWithConstraints: (str, bytes),
   *SimpleTypeVarTuple = (int, float),
   **SimpleParamSpec = (str, bytearray),
](
   a: SimpleTypeVar,
   b: TypeVarWithDefault,
   c: TypeVarWithBound,
   d: Callable[SimpleParamSpec, TypeVarWithConstraints],
   *e: SimpleTypeVarTuple,
): ...
@end example

@menu
* Generic functions:: 
* Generic classes:: 
* Generic type aliases:: 

@end menu

@node Generic functions,Generic classes,,Type parameter lists
@anchor{reference/compound_stmts generic-functions}@anchor{4ff}@anchor{reference/compound_stmts id17}@anchor{213a}
@subsubsection Generic functions


Generic functions are declared as follows:

@example
def func[T](arg: T): ...
@end example

This syntax is equivalent to:

@example
annotation-def TYPE_PARAMS_OF_func():
    T = typing.TypeVar("T")
    def func(arg: T): ...
    func.__type_params__ = (T,)
    return func
func = TYPE_PARAMS_OF_func()
@end example

Here @code{annotation-def} indicates an @ref{2f3,,annotation scope},
which is not actually bound to any name at runtime. (One
other liberty is taken in the translation: the syntax does not go through
attribute access on the @ref{104,,typing} module, but creates an instance of
@ref{2c9,,typing.TypeVar} directly.)

The annotations of generic functions are evaluated within the annotation scope
used for declaring the type parameters, but the function’s defaults and
decorators are not.

The following example illustrates the scoping rules for these cases,
as well as for additional flavors of type parameters:

@example
@@decorator
def func[T: int, *Ts, **P](*args: *Ts, arg: Callable[P, T] = some_default):
    ...
@end example

Except for the @ref{503,,lazy evaluation} of the
@ref{2c9,,TypeVar} bound, this is equivalent to:

@example
DEFAULT_OF_arg = some_default

annotation-def TYPE_PARAMS_OF_func():

    annotation-def BOUND_OF_T():
        return int
    # In reality, BOUND_OF_T() is evaluated only on demand.
    T = typing.TypeVar("T", bound=BOUND_OF_T())

    Ts = typing.TypeVarTuple("Ts")
    P = typing.ParamSpec("P")

    def func(*args: *Ts, arg: Callable[P, T] = DEFAULT_OF_arg):
        ...

    func.__type_params__ = (T, Ts, P)
    return func
func = decorator(TYPE_PARAMS_OF_func())
@end example

The capitalized names like @code{DEFAULT_OF_arg} are not actually
bound at runtime.

@node Generic classes,Generic type aliases,Generic functions,Type parameter lists
@anchor{reference/compound_stmts generic-classes}@anchor{4fe}@anchor{reference/compound_stmts id18}@anchor{213b}
@subsubsection Generic classes


Generic classes are declared as follows:

@example
class Bag[T]: ...
@end example

This syntax is equivalent to:

@example
annotation-def TYPE_PARAMS_OF_Bag():
    T = typing.TypeVar("T")
    class Bag(typing.Generic[T]):
        __type_params__ = (T,)
        ...
    return Bag
Bag = TYPE_PARAMS_OF_Bag()
@end example

Here again @code{annotation-def} (not a real keyword) indicates an
@ref{2f3,,annotation scope}, and the name
@code{TYPE_PARAMS_OF_Bag} is not actually bound at runtime.

Generic classes implicitly inherit from @ref{15f6,,typing.Generic}.
The base classes and keyword arguments of generic classes are
evaluated within the type scope for the type parameters,
and decorators are evaluated outside that scope. This is illustrated
by this example:

@example
@@decorator
class Bag(Base[T], arg=T): ...
@end example

This is equivalent to:

@example
annotation-def TYPE_PARAMS_OF_Bag():
    T = typing.TypeVar("T")
    class Bag(Base[T], typing.Generic[T], arg=T):
        __type_params__ = (T,)
        ...
    return Bag
Bag = decorator(TYPE_PARAMS_OF_Bag())
@end example

@node Generic type aliases,,Generic classes,Type parameter lists
@anchor{reference/compound_stmts generic-type-aliases}@anchor{502}@anchor{reference/compound_stmts id19}@anchor{213c}
@subsubsection Generic type aliases


The @ref{4e6,,type} statement can also be used to create a generic type alias:

@example
type ListOrSet[T] = list[T] | set[T]
@end example

Except for the @ref{503,,lazy evaluation} of the value,
this is equivalent to:

@example
annotation-def TYPE_PARAMS_OF_ListOrSet():
    T = typing.TypeVar("T")

    annotation-def VALUE_OF_ListOrSet():
        return list[T] | set[T]
    # In reality, the value is lazily evaluated
    return typing.TypeAliasType("ListOrSet", VALUE_OF_ListOrSet(), type_params=(T,))
ListOrSet = TYPE_PARAMS_OF_ListOrSet()
@end example

Here, @code{annotation-def} (not a real keyword) indicates an
@ref{2f3,,annotation scope}. The capitalized names
like @code{TYPE_PARAMS_OF_ListOrSet} are not actually bound at runtime.

@node Annotations<2>,,Type parameter lists,Sentencias compuestas
@anchor{reference/compound_stmts annotations}@anchor{2127}@anchor{reference/compound_stmts id20}@anchor{213d}
@subsection Annotations



Distinto en la versión 3.14: Annotations are now lazily evaluated by default.


Variables and function parameters may carry @ref{140,,annotations},
created by adding a colon after the name, followed by an expression:

@example
x: annotation = 1
def f(param: annotation): ...
@end example

Functions may also carry a return annotation following an arrow:

@example
def f() -> annotation: ...
@end example

Annotations are conventionally used for @ref{1f81,,type hints}, but this
is not enforced by the language, and in general annotations may contain arbitrary
expressions. The presence of annotations does not change the runtime semantics of
the code, except if some mechanism is used that introspects and uses the annotations
(such as @ref{30,,dataclasses} or @ref{6da,,functools.singledispatch()}).

By default, annotations are lazily evaluated in a @ref{2f3,,annotation scope}.
This means that they are not evaluated when the code containing the annotation is evaluated.
Instead, the interpreter saves information that can be used to evaluate the annotation later
if requested. The @ref{6,,annotationlib} module provides tools for evaluating annotations.

If the @ref{2f4,,future statement} @code{from __future__ import annotations} is present,
all annotations are instead stored as strings:

@example
>>> from __future__ import annotations
>>> def f(param: annotation): ...
>>> f.__annotations__
@{'param': 'annotation'@}
@end example

@subsubheading Notas al pie


@node Componentes de nivel superior,Especificación completa de la gramática,Sentencias compuestas,Referencia del Lenguaje Python
@anchor{reference/toplevel_components doc}@anchor{213e}@anchor{reference/toplevel_components top-level}@anchor{213f}@anchor{reference/toplevel_components top-level-components}@anchor{2140}
@section Componentes de nivel superior


@geindex interpreter

El intérprete de Python puede obtener su entrada de varias fuentes: de un script que se le pasa como entrada estándar o como argumento del programa, escrito interactivamente, de un archivo fuente de módulo, etc. Este capítulo proporciona la sintaxis utilizada en estos casos.

@menu
* Programas completos de Python:: 
* Entrada de archivo:: 
* Entrada interactiva:: 
* Entrada de expresión:: 

@end menu

@node Programas completos de Python,Entrada de archivo,,Componentes de nivel superior
@anchor{reference/toplevel_components complete-python-programs}@anchor{2141}@anchor{reference/toplevel_components programs}@anchor{1ffe}
@subsection Programas completos de Python


@geindex program

@geindex module;sys
@geindex module;__main__
@geindex module;builtins

Si bien una especificación de lenguaje no necesita prescribir cómo se invoca al intérprete de lenguaje, es útil tener una noción de un programa completo de Python. Un programa completo de Python se ejecuta en un entorno mínimamente inicializado: todos los módulos estándar e integrados están disponibles, pero ninguno ha sido inicializado, excepto @ref{d9,,sys} (varios servicios del sistema), @ref{13,,builtins} (funciones integradas, excepciones y @code{Ninguno}) y @ref{1,,__main__}. Este último se utiliza para proporcionar el espacio de nombres local y global para la ejecución del programa completo.

La sintaxis de un programa completo de Python es la entrada de archivos, que se describe en la siguiente sección.

@geindex interactive mode
@geindex module;__main__

El intérprete también puede invocarse en modo interactivo; en este caso, no lee ni ejecuta un programa completo, sino que lee y ejecuta una instrucción (posiblemente compuesta) a la vez. El entorno inicial es idéntico al de un programa completo; cada instrucción se ejecuta en el espacio de nombres de @ref{1,,__main__}.

@geindex UNIX
@geindex Windows
@geindex command line
@geindex standard input

Se puede pasar un programa completo al intérprete en tres formas: con la opción @ref{681,,-c} `string' de línea de comando, como un archivo pasado como primer argumento de línea de comando o como entrada estándar. Si el archivo o la entrada estándar es un dispositivo tty, el intérprete ingresa al modo interactivo; de lo contrario, ejecuta el archivo como un programa completo.

@node Entrada de archivo,Entrada interactiva,Programas completos de Python,Componentes de nivel superior
@anchor{reference/toplevel_components file-input}@anchor{2142}@anchor{reference/toplevel_components id1}@anchor{2143}
@subsection Entrada de archivo


Todas las entradas leídas de archivos no interactivos tienen la misma forma:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-file_input}@anchor{2144}file_input ::= (NEWLINE | statement)*
@end example

Esta sintaxis se utiliza en las siguientes situaciones:


@itemize *

@item 
al analizar un programa completo de Python (desde un archivo o desde una cadena);

@item 
al analizar un módulo;

@item 
al analizar una cadena pasada a la función: @ref{2ea,,exec()};
@end itemize

@node Entrada interactiva,Entrada de expresión,Entrada de archivo,Componentes de nivel superior
@anchor{reference/toplevel_components interactive}@anchor{2145}@anchor{reference/toplevel_components interactive-input}@anchor{2146}
@subsection Entrada interactiva


La entrada en modo interactivo se analiza utilizando la siguiente gramática:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-interactive_input}@anchor{2147}interactive_input ::= [stmt_list] NEWLINE | compound_stmt NEWLINE
@end example

Tenga en cuenta que una declaración compuesta (de nivel superior) debe ir seguida de una línea en blanco en modo interactivo; esto es necesario para ayudar al analizador sintáctico a detectar el final de la entrada.

@node Entrada de expresión,,Entrada interactiva,Componentes de nivel superior
@anchor{reference/toplevel_components expression-input}@anchor{2148}@anchor{reference/toplevel_components id2}@anchor{2149}
@subsection Entrada de expresión


@geindex input

@geindex built-in function;eval

@ref{2eb,,eval()} se utiliza para la entrada de expresiones. Ignora los espacios en blanco iniciales. El argumento de cadena para @ref{2eb,,eval()} debe tener la siguiente forma:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-eval_input}@anchor{214a}eval_input ::= expression_list NEWLINE*
@end example

@node Especificación completa de la gramática,,Componentes de nivel superior,Referencia del Lenguaje Python
@anchor{reference/grammar doc}@anchor{20fa}@anchor{reference/grammar full-grammar-specification}@anchor{214b}@anchor{reference/grammar id1}@anchor{214c}
@section Especificación completa de la gramática


Esta es la gramática completa de Python, derivada directamente de la gramática utilizada para generar el analizador CPython (ver Grammar/python.gram@footnote{https://github.com/python/cpython/tree/main/Grammar/python.gram}). La versión aquí omite detalles relacionados con la generación de código y la recuperación de errores.

The notation is a mixture of EBNF@footnote{https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form}
and PEG@footnote{https://en.wikipedia.org/wiki/Parsing_expression_grammar}.
In particular, @code{&} followed by a symbol, token or parenthesized
group indicates a positive lookahead (i.e., is required to match but
not consumed), while @code{!} indicates a negative lookahead (i.e., is
required `not' to match).  We use the @code{|} separator to mean PEG’s
«ordered choice» (written as @code{/} in traditional PEG grammars). See
@geindex Python Enhancement Proposals; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} for more details on the grammar’s syntax.

@example
# PEG grammar for Python

@@trailer '@w{'}'
void *
_PyPegen_parse(Parser *p)
@{
    // Initialize keywords
    p->keywords = reserved_keywords;
    p->n_keyword_lists = n_keyword_lists;
    p->soft_keywords = soft_keywords;

    // Run parser
    void *result = NULL;
    if (p->start_rule == Py_file_input) @{
        result = file_rule(p);
    @} else if (p->start_rule == Py_single_input) @{
        result = interactive_rule(p);
    @} else if (p->start_rule == Py_eval_input) @{
        result = eval_rule(p);
    @} else if (p->start_rule == Py_func_type_input) @{
        result = func_type_rule(p);
    @}

    return result;
@}
'@w{'}'

# ========================= START OF THE GRAMMAR =========================

# General grammatical elements and rules:
#
# * Strings with double quotes (") denote SOFT KEYWORDS
# * Strings with single quotes (') denote KEYWORDS
# * Upper case names (NAME) denote tokens in the Grammar/Tokens file
# * Rule names starting with "invalid_" are used for specialized syntax errors
#     - These rules are NOT used in the first pass of the parser.
#     - Only if the first pass fails to parse, a second pass including the invalid
#       rules will be executed.
#     - If the parser fails in the second phase with a generic syntax error, the
#       location of the generic failure of the first pass will be used (this avoids
#       reporting incorrect locations due to the invalid rules).
#     - The order of the alternatives involving invalid rules matter
#       (like any rule in PEG).
#
# Grammar Syntax (see PEP 617 for more information):
#
# rule_name: expression
#   Optionally, a type can be included right after the rule name, which
#   specifies the return type of the C or Python function corresponding to the
#   rule:
# rule_name[return_type]: expression
#   If the return type is omitted, then a void * is returned in C and an Any in
#   Python.
# e1 e2
#   Match e1, then match e2.
# e1 | e2
#   Match e1 or e2.
#   The first alternative can also appear on the line after the rule name for
#   formatting purposes. In that case, a | must be used before the first
#   alternative, like so:
#       rule_name[return_type]:
#            | first_alt
#            | second_alt
# ( e )
#   Match e (allows also to use other operators in the group like '(e)*')
# [ e ] or e?
#   Optionally match e.
# e*
#   Match zero or more occurrences of e.
# e+
#   Match one or more occurrences of e.
# s.e+
#   Match one or more occurrences of e, separated by s. The generated parse tree
#   does not include the separator. This is otherwise identical to (e (s e)*).
# &e
#   Succeed if e can be parsed, without consuming any input.
# !e
#   Fail if e can be parsed, without consuming any input.
# ~
#   Commit to the current alternative, even if it fails to parse.
# &&e
#   Eager parse e. The parser will not backtrack and will immediately 
#   fail with SyntaxError if e cannot be parsed.
#

# STARTING RULES
# ==============

file[mod_ty]: a=[statements] ENDMARKER @{ _PyPegen_make_module(p, a) @}
interactive[mod_ty]: a=statement_newline @{ _PyAST_Interactive(a, p->arena) @}
eval[mod_ty]: a=expressions NEWLINE* ENDMARKER @{ _PyAST_Expression(a, p->arena) @}
func_type[mod_ty]: '(' a=[type_expressions] ')' '->' b=expression NEWLINE* ENDMARKER @{ _PyAST_FunctionType(a, b, p->arena) @}

# GENERAL STATEMENTS
# ==================

statements[asdl_stmt_seq*]: a=statement+ @{ (asdl_stmt_seq*)_PyPegen_seq_flatten(p, a) @}

statement[asdl_stmt_seq*]: a=compound_stmt @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a) @} | a[asdl_stmt_seq*]=simple_stmts @{ a @}

statement_newline[asdl_stmt_seq*]:
    | a=compound_stmt NEWLINE @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a) @}
    | simple_stmts
    | NEWLINE @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, CHECK(stmt_ty, _PyAST_Pass(EXTRA))) @}
    | ENDMARKER @{ _PyPegen_interactive_exit(p) @}

simple_stmts[asdl_stmt_seq*]:
    | a=simple_stmt !';' NEWLINE @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a) @} # Not needed, there for speedup
    | a[asdl_stmt_seq*]=';'.simple_stmt+ [';'] NEWLINE @{ a @}

# NOTE: assignment MUST precede expression, else parsing a simple assignment
# will throw a SyntaxError.
simple_stmt[stmt_ty] (memo):
    | assignment
    | &"type" type_alias
    | e=star_expressions @{ _PyAST_Expr(e, EXTRA) @}
    | &'return' return_stmt
    | &('import' | 'from') import_stmt
    | &'raise' raise_stmt
    | 'pass' @{ _PyAST_Pass(EXTRA) @}
    | &'del' del_stmt
    | &'yield' yield_stmt
    | &'assert' assert_stmt
    | 'break' @{ _PyAST_Break(EXTRA) @}
    | 'continue' @{ _PyAST_Continue(EXTRA) @}
    | &'global' global_stmt
    | &'nonlocal' nonlocal_stmt

compound_stmt[stmt_ty]:
    | &('def' | '@@' | 'async') function_def
    | &'if' if_stmt
    | &('class' | '@@') class_def
    | &('with' | 'async') with_stmt
    | &('for' | 'async') for_stmt
    | &'try' try_stmt
    | &'while' while_stmt
    | match_stmt

# SIMPLE STATEMENTS
# =================

# NOTE: annotated_rhs may start with 'yield'; yield_expr must start with 'yield'
assignment[stmt_ty]:
    | a=NAME ':' b=expression c=['=' d=annotated_rhs @{ d @}] @{
        CHECK_VERSION(
            stmt_ty,
            6,
            "Variable annotation syntax is",
            _PyAST_AnnAssign(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), b, c, 1, EXTRA)
        ) @}
    | a=('(' b=single_target ')' @{ b @}
         | single_subscript_attribute_target) ':' b=expression c=['=' d=annotated_rhs @{ d @}] @{
        CHECK_VERSION(stmt_ty, 6, "Variable annotations syntax is", _PyAST_AnnAssign(a, b, c, 0, EXTRA)) @}
    | a[asdl_expr_seq*]=(z=star_targets '=' @{ z @})+ b=annotated_rhs !'=' tc=[TYPE_COMMENT] @{
         _PyAST_Assign(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | a=single_target b=augassign ~ c=annotated_rhs @{
         _PyAST_AugAssign(a, b->kind, c, EXTRA) @}
    | invalid_assignment

annotated_rhs[expr_ty]: yield_expr | star_expressions

augassign[AugOperator*]:
    | '+=' @{ _PyPegen_augoperator(p, Add) @}
    | '-=' @{ _PyPegen_augoperator(p, Sub) @}
    | '*=' @{ _PyPegen_augoperator(p, Mult) @}
    | '@@=' @{ CHECK_VERSION(AugOperator*, 5, "The '@@' operator is", _PyPegen_augoperator(p, MatMult)) @}
    | '/=' @{ _PyPegen_augoperator(p, Div) @}
    | '%=' @{ _PyPegen_augoperator(p, Mod) @}
    | '&=' @{ _PyPegen_augoperator(p, BitAnd) @}
    | '|=' @{ _PyPegen_augoperator(p, BitOr) @}
    | '^=' @{ _PyPegen_augoperator(p, BitXor) @}
    | '<<=' @{ _PyPegen_augoperator(p, LShift) @}
    | '>>=' @{ _PyPegen_augoperator(p, RShift) @}
    | '**=' @{ _PyPegen_augoperator(p, Pow) @}
    | '//=' @{ _PyPegen_augoperator(p, FloorDiv) @}

return_stmt[stmt_ty]:
    | 'return' a=[star_expressions] @{ _PyAST_Return(a, EXTRA) @}

raise_stmt[stmt_ty]:
    | 'raise' a=expression b=['from' z=expression @{ z @}] @{ _PyAST_Raise(a, b, EXTRA) @}
    | 'raise' @{ _PyAST_Raise(NULL, NULL, EXTRA) @}

global_stmt[stmt_ty]: 'global' a[asdl_expr_seq*]=','.NAME+ @{
    _PyAST_Global(CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p, a)), EXTRA) @}

nonlocal_stmt[stmt_ty]: 'nonlocal' a[asdl_expr_seq*]=','.NAME+ @{
    _PyAST_Nonlocal(CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p, a)), EXTRA) @}

del_stmt[stmt_ty]:
    | 'del' a=del_targets &(';' | NEWLINE) @{ _PyAST_Delete(a, EXTRA) @}
    | invalid_del_stmt

yield_stmt[stmt_ty]: y=yield_expr @{ _PyAST_Expr(y, EXTRA) @}

assert_stmt[stmt_ty]: 'assert' a=expression b=[',' z=expression @{ z @}] @{ _PyAST_Assert(a, b, EXTRA) @}

import_stmt[stmt_ty]:
    | invalid_import
    | import_name
    | import_from

# Import statements
# -----------------

import_name[stmt_ty]: 'import' a=dotted_as_names @{ _PyAST_Import(a, EXTRA) @}
# note below: the ('.' | '...') is necessary because '...' is tokenized as ELLIPSIS
import_from[stmt_ty]:
    | 'from' a=('.' | '...')* b=dotted_name 'import' c=import_from_targets @{
        _PyAST_ImportFrom(b->v.Name.id, c, _PyPegen_seq_count_dots(a), EXTRA) @}
    | 'from' a=('.' | '...')+ 'import' b=import_from_targets @{
        _PyAST_ImportFrom(NULL, b, _PyPegen_seq_count_dots(a), EXTRA) @}
import_from_targets[asdl_alias_seq*]:
    | '(' a=import_from_as_names [','] ')' @{ a @}
    | import_from_as_names !','
    | '*' @{ (asdl_alias_seq*)_PyPegen_singleton_seq(p, CHECK(alias_ty, _PyPegen_alias_for_star(p, EXTRA))) @}
    | invalid_import_from_targets
import_from_as_names[asdl_alias_seq*]:
    | a[asdl_alias_seq*]=','.import_from_as_name+ @{ a @}
import_from_as_name[alias_ty]:
    | a=NAME b=['as' z=NAME @{ z @}] @{ _PyAST_alias(a->v.Name.id,
                                               (b) ? ((expr_ty) b)->v.Name.id : NULL,
                                               EXTRA) @}
dotted_as_names[asdl_alias_seq*]:
    | a[asdl_alias_seq*]=','.dotted_as_name+ @{ a @}
dotted_as_name[alias_ty]:
    | a=dotted_name b=['as' z=NAME @{ z @}] @{ _PyAST_alias(a->v.Name.id,
                                                      (b) ? ((expr_ty) b)->v.Name.id : NULL,
                                                      EXTRA) @}
dotted_name[expr_ty]:
    | a=dotted_name '.' b=NAME @{ _PyPegen_join_names_with_dot(p, a, b) @}
    | NAME

# COMPOUND STATEMENTS
# ===================

# Common elements
# ---------------

block[asdl_stmt_seq*] (memo):
    | NEWLINE INDENT a=statements DEDENT @{ a @}
    | simple_stmts
    | invalid_block

decorators[asdl_expr_seq*]: a[asdl_expr_seq*]=('@@' f=named_expression NEWLINE @{ f @})+ @{ a @}

# Class definitions
# -----------------

class_def[stmt_ty]:
    | a=decorators b=class_def_raw @{ _PyPegen_class_def_decorators(p, a, b) @}
    | class_def_raw

class_def_raw[stmt_ty]:
    | invalid_class_def_raw
    | 'class' a=NAME t=[type_params] b=['(' z=[arguments] ')' @{ z @}] ':' c=block @{
        _PyAST_ClassDef(a->v.Name.id,
                     (b) ? ((expr_ty) b)->v.Call.args : NULL,
                     (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                     c, NULL, t, EXTRA) @}

# Function definitions
# --------------------

function_def[stmt_ty]:
    | d=decorators f=function_def_raw @{ _PyPegen_function_def_decorators(p, d, f) @}
    | function_def_raw

function_def_raw[stmt_ty]:
    | invalid_def_raw
    | 'def' n=NAME t=[type_params] '(' params=[params] ')' a=['->' z=expression @{ z @}] ':' tc=[func_type_comment] b=block @{
        _PyAST_FunctionDef(n->v.Name.id,
                        (params) ? params : CHECK(arguments_ty, _PyPegen_empty_arguments(p)),
                        b, NULL, a, NEW_TYPE_COMMENT(p, tc), t, EXTRA) @}
    | 'async' 'def' n=NAME t=[type_params] '(' params=[params] ')' a=['->' z=expression @{ z @}] ':' tc=[func_type_comment] b=block @{
        CHECK_VERSION(
            stmt_ty,
            5,
            "Async functions are",
            _PyAST_AsyncFunctionDef(n->v.Name.id,
                            (params) ? params : CHECK(arguments_ty, _PyPegen_empty_arguments(p)),
                            b, NULL, a, NEW_TYPE_COMMENT(p, tc), t, EXTRA)
        ) @}

# Function parameters
# -------------------

params[arguments_ty]:
    | invalid_parameters
    | parameters

parameters[arguments_ty]:
    | a=slash_no_default b[asdl_arg_seq*]=param_no_default* c=param_with_default* d=[star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, a, NULL, b, c, d)) @}
    | a=slash_with_default b=param_with_default* c=[star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, NULL, a, NULL, b, c)) @}
    | a[asdl_arg_seq*]=param_no_default+ b=param_with_default* c=[star_etc] @{
        _PyPegen_make_arguments(p, NULL, NULL, a, b, c) @}
    | a=param_with_default+ b=[star_etc] @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, a, b)@}
    | a=star_etc @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, NULL, a) @}

# Some duplication here because we can't write (',' | &')'),
# which is because we don't support empty alternatives (yet).

slash_no_default[asdl_arg_seq*]:
    | a[asdl_arg_seq*]=param_no_default+ '/' ',' @{ a @}
    | a[asdl_arg_seq*]=param_no_default+ '/' &')' @{ a @}
slash_with_default[SlashWithDefault*]:
    | a=param_no_default* b=param_with_default+ '/' ',' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}
    | a=param_no_default* b=param_with_default+ '/' &')' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}

star_etc[StarEtc*]:
    | invalid_star_etc
    | '*' a=param_no_default b=param_maybe_default* c=[kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' a=param_no_default_star_annotation b=param_maybe_default* c=[kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' ',' b=param_maybe_default+ c=[kwds] @{
        _PyPegen_star_etc(p, NULL, b, c) @}
    | a=kwds @{ _PyPegen_star_etc(p, NULL, NULL, a) @}

kwds[arg_ty]:
    | invalid_kwds
    | '**' a=param_no_default @{ a @}

# One parameter.  This *includes* a following comma and type comment.
#
# There are three styles:
# - No default
# - With default
# - Maybe with default
#
# There are two alternative forms of each, to deal with type comments:
# - Ends in a comma followed by an optional type comment
# - No comma, optional type comment, must be followed by close paren
# The latter form is for a final parameter without trailing comma.
#

param_no_default[arg_ty]:
    | a=param ',' tc=TYPE_COMMENT? @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
    | a=param tc=TYPE_COMMENT? &')' @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
param_no_default_star_annotation[arg_ty]:
    | a=param_star_annotation ',' tc=TYPE_COMMENT? @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
    | a=param_star_annotation tc=TYPE_COMMENT? &')' @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
param_with_default[NameDefaultPair*]:
    | a=param c=default ',' tc=TYPE_COMMENT? @{ _PyPegen_name_default_pair(p, a, c, tc) @}
    | a=param c=default tc=TYPE_COMMENT? &')' @{ _PyPegen_name_default_pair(p, a, c, tc) @}
param_maybe_default[NameDefaultPair*]:
    | a=param c=default? ',' tc=TYPE_COMMENT? @{ _PyPegen_name_default_pair(p, a, c, tc) @}
    | a=param c=default? tc=TYPE_COMMENT? &')' @{ _PyPegen_name_default_pair(p, a, c, tc) @}
param[arg_ty]: a=NAME b=annotation? @{ _PyAST_arg(a->v.Name.id, b, NULL, EXTRA) @}
param_star_annotation[arg_ty]: a=NAME b=star_annotation @{ _PyAST_arg(a->v.Name.id, b, NULL, EXTRA) @}
annotation[expr_ty]: ':' a=expression @{ a @}
star_annotation[expr_ty]: ':' a=star_expression @{ a @}
default[expr_ty]: '=' a=expression @{ a @} | invalid_default

# If statement
# ------------

if_stmt[stmt_ty]:
    | invalid_if_stmt
    | 'if' a=named_expression ':' b=block c=elif_stmt @{
        _PyAST_If(a, b, CHECK(asdl_stmt_seq*, _PyPegen_singleton_seq(p, c)), EXTRA) @}
    | 'if' a=named_expression ':' b=block c=[else_block] @{ _PyAST_If(a, b, c, EXTRA) @}
elif_stmt[stmt_ty]:
    | invalid_elif_stmt
    | 'elif' a=named_expression ':' b=block c=elif_stmt @{
        _PyAST_If(a, b, CHECK(asdl_stmt_seq*, _PyPegen_singleton_seq(p, c)), EXTRA) @}
    | 'elif' a=named_expression ':' b=block c=[else_block] @{ _PyAST_If(a, b, c, EXTRA) @}
else_block[asdl_stmt_seq*]:
    | invalid_else_stmt
    | 'else' &&':' b=block @{ b @}

# While statement
# ---------------

while_stmt[stmt_ty]:
    | invalid_while_stmt
    | 'while' a=named_expression ':' b=block c=[else_block] @{ _PyAST_While(a, b, c, EXTRA) @}

# For statement
# -------------

for_stmt[stmt_ty]:
    | invalid_for_stmt
    | 'for' t=star_targets 'in' ~ ex=star_expressions ':' tc=[TYPE_COMMENT] b=block el=[else_block] @{
        _PyAST_For(t, ex, b, el, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'async' 'for' t=star_targets 'in' ~ ex=star_expressions ':' tc=[TYPE_COMMENT] b=block el=[else_block] @{
        CHECK_VERSION(stmt_ty, 5, "Async for loops are", _PyAST_AsyncFor(t, ex, b, el, NEW_TYPE_COMMENT(p, tc), EXTRA)) @}
    | invalid_for_target

# With statement
# --------------

with_stmt[stmt_ty]:
    | invalid_with_stmt_indent
    | 'with' '(' a[asdl_withitem_seq*]=','.with_item+ ','? ')' ':' tc=[TYPE_COMMENT] b=block @{
       _PyAST_With(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'with' a[asdl_withitem_seq*]=','.with_item+ ':' tc=[TYPE_COMMENT] b=block @{
        _PyAST_With(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'async' 'with' '(' a[asdl_withitem_seq*]=','.with_item+ ','? ')' ':' b=block @{
       CHECK_VERSION(stmt_ty, 5, "Async with statements are", _PyAST_AsyncWith(a, b, NULL, EXTRA)) @}
    | 'async' 'with' a[asdl_withitem_seq*]=','.with_item+ ':' tc=[TYPE_COMMENT] b=block @{
       CHECK_VERSION(stmt_ty, 5, "Async with statements are", _PyAST_AsyncWith(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA)) @}
    | invalid_with_stmt

with_item[withitem_ty]:
    | e=expression 'as' t=star_target &(',' | ')' | ':') @{ _PyAST_withitem(e, t, p->arena) @}
    | invalid_with_item
    | e=expression @{ _PyAST_withitem(e, NULL, p->arena) @}

# Try statement
# -------------

try_stmt[stmt_ty]:
    | invalid_try_stmt
    | 'try' &&':' b=block f=finally_block @{ _PyAST_Try(b, NULL, NULL, f, EXTRA) @}
    | 'try' &&':' b=block ex[asdl_excepthandler_seq*]=except_block+ el=[else_block] f=[finally_block] @{ _PyAST_Try(b, ex, el, f, EXTRA) @}
    | 'try' &&':' b=block ex[asdl_excepthandler_seq*]=except_star_block+ el=[else_block] f=[finally_block] @{
        CHECK_VERSION(stmt_ty, 11, "Exception groups are",
                      _PyAST_TryStar(b, ex, el, f, EXTRA)) @}


# Except statement
# ----------------

except_block[excepthandler_ty]:
    | invalid_except_stmt_indent
    | 'except' e=expression t=['as' z=NAME @{ z @}] ':' b=block @{
        _PyAST_ExceptHandler(e, (t) ? ((expr_ty) t)->v.Name.id : NULL, b, EXTRA) @}
    | 'except' ':' b=block @{ _PyAST_ExceptHandler(NULL, NULL, b, EXTRA) @}
    | invalid_except_stmt
except_star_block[excepthandler_ty]:
    | invalid_except_star_stmt_indent
    | 'except' '*' e=expression t=['as' z=NAME @{ z @}] ':' b=block @{
        _PyAST_ExceptHandler(e, (t) ? ((expr_ty) t)->v.Name.id : NULL, b, EXTRA) @}
    | invalid_except_star_stmt
finally_block[asdl_stmt_seq*]:
    | invalid_finally_stmt
    | 'finally' &&':' a=block @{ a @}

# Match statement
# ---------------

match_stmt[stmt_ty]:
    | "match" subject=subject_expr ':' NEWLINE INDENT cases[asdl_match_case_seq*]=case_block+ DEDENT @{
        CHECK_VERSION(stmt_ty, 10, "Pattern matching is", _PyAST_Match(subject, cases, EXTRA)) @}
    | invalid_match_stmt

subject_expr[expr_ty]:
    | value=star_named_expression ',' values=star_named_expressions? @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, value, values)), Load, EXTRA) @}
    | named_expression

case_block[match_case_ty]:
    | invalid_case_block
    | "case" pattern=patterns guard=guard? ':' body=block @{
        _PyAST_match_case(pattern, guard, body, p->arena) @}

guard[expr_ty]: 'if' guard=named_expression @{ guard @}

patterns[pattern_ty]:
    | patterns[asdl_pattern_seq*]=open_sequence_pattern @{
        _PyAST_MatchSequence(patterns, EXTRA) @}
    | pattern

pattern[pattern_ty]:
    | as_pattern
    | or_pattern

as_pattern[pattern_ty]:
    | pattern=or_pattern 'as' target=pattern_capture_target @{
        _PyAST_MatchAs(pattern, target->v.Name.id, EXTRA) @}
    | invalid_as_pattern

or_pattern[pattern_ty]:
    | patterns[asdl_pattern_seq*]='|'.closed_pattern+ @{
        asdl_seq_LEN(patterns) == 1 ? asdl_seq_GET(patterns, 0) : _PyAST_MatchOr(patterns, EXTRA) @}

closed_pattern[pattern_ty] (memo):
    | literal_pattern
    | capture_pattern
    | wildcard_pattern
    | value_pattern
    | group_pattern
    | sequence_pattern
    | mapping_pattern
    | class_pattern

# Literal patterns are used for equality and identity constraints
literal_pattern[pattern_ty]:
    | value=signed_number !('+' | '-') @{ _PyAST_MatchValue(value, EXTRA) @}
    | value=complex_number @{ _PyAST_MatchValue(value, EXTRA) @}
    | value=strings @{ _PyAST_MatchValue(value, EXTRA) @}
    | 'None' @{ _PyAST_MatchSingleton(Py_None, EXTRA) @}
    | 'True' @{ _PyAST_MatchSingleton(Py_True, EXTRA) @}
    | 'False' @{ _PyAST_MatchSingleton(Py_False, EXTRA) @}

# Literal expressions are used to restrict permitted mapping pattern keys
literal_expr[expr_ty]:
    | signed_number !('+' | '-')
    | complex_number
    | strings
    | 'None' @{ _PyAST_Constant(Py_None, NULL, EXTRA) @}
    | 'True' @{ _PyAST_Constant(Py_True, NULL, EXTRA) @}
    | 'False' @{ _PyAST_Constant(Py_False, NULL, EXTRA) @}

complex_number[expr_ty]:
    | real=signed_real_number '+' imag=imaginary_number @{
        _PyAST_BinOp(real, Add, imag, EXTRA) @}
    | real=signed_real_number '-' imag=imaginary_number  @{
        _PyAST_BinOp(real, Sub, imag, EXTRA) @}

signed_number[expr_ty]:
    | NUMBER
    | '-' number=NUMBER @{ _PyAST_UnaryOp(USub, number, EXTRA) @}

signed_real_number[expr_ty]:
    | real_number
    | '-' real=real_number @{ _PyAST_UnaryOp(USub, real, EXTRA) @}

real_number[expr_ty]:
    | real=NUMBER @{ _PyPegen_ensure_real(p, real) @}

imaginary_number[expr_ty]:
    | imag=NUMBER @{ _PyPegen_ensure_imaginary(p, imag) @}

capture_pattern[pattern_ty]:
    | target=pattern_capture_target @{ _PyAST_MatchAs(NULL, target->v.Name.id, EXTRA) @}

pattern_capture_target[expr_ty]:
    | !"_" name=NAME !('.' | '(' | '=') @{
        _PyPegen_set_expr_context(p, name, Store) @}

wildcard_pattern[pattern_ty]:
    | "_" @{ _PyAST_MatchAs(NULL, NULL, EXTRA) @}

value_pattern[pattern_ty]:
    | attr=attr !('.' | '(' | '=') @{ _PyAST_MatchValue(attr, EXTRA) @}

attr[expr_ty]:
    | value=name_or_attr '.' attr=NAME @{
        _PyAST_Attribute(value, attr->v.Name.id, Load, EXTRA) @}

name_or_attr[expr_ty]:
    | attr
    | NAME

group_pattern[pattern_ty]:
    | '(' pattern=pattern ')' @{ pattern @}

sequence_pattern[pattern_ty]:
    | '[' patterns=maybe_sequence_pattern? ']' @{ _PyAST_MatchSequence(patterns, EXTRA) @}
    | '(' patterns=open_sequence_pattern? ')' @{ _PyAST_MatchSequence(patterns, EXTRA) @}

open_sequence_pattern[asdl_seq*]:
    | pattern=maybe_star_pattern ',' patterns=maybe_sequence_pattern? @{
        _PyPegen_seq_insert_in_front(p, pattern, patterns) @}

maybe_sequence_pattern[asdl_seq*]:
    | patterns=','.maybe_star_pattern+ ','? @{ patterns @}

maybe_star_pattern[pattern_ty]:
    | star_pattern
    | pattern

star_pattern[pattern_ty] (memo):
    | '*' target=pattern_capture_target @{
        _PyAST_MatchStar(target->v.Name.id, EXTRA) @}
    | '*' wildcard_pattern @{
        _PyAST_MatchStar(NULL, EXTRA) @}

mapping_pattern[pattern_ty]:
    | '@{' '@}' @{
        _PyAST_MatchMapping(NULL, NULL, NULL, EXTRA) @}
    | '@{' rest=double_star_pattern ','? '@}' @{
        _PyAST_MatchMapping(NULL, NULL, rest->v.Name.id, EXTRA) @}
    | '@{' items=items_pattern ',' rest=double_star_pattern ','? '@}' @{
        _PyAST_MatchMapping(
            CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, items)),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, items)),
            rest->v.Name.id,
            EXTRA) @}
    | '@{' items=items_pattern ','? '@}' @{
        _PyAST_MatchMapping(
            CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, items)),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, items)),
            NULL,
            EXTRA) @}

items_pattern[asdl_seq*]:
    | ','.key_value_pattern+

key_value_pattern[KeyPatternPair*]:
    | key=(literal_expr | attr) ':' pattern=pattern @{
        _PyPegen_key_pattern_pair(p, key, pattern) @}

double_star_pattern[expr_ty]:
    | '**' target=pattern_capture_target @{ target @}

class_pattern[pattern_ty]:
    | cls=name_or_attr '(' ')' @{
        _PyAST_MatchClass(cls, NULL, NULL, NULL, EXTRA) @}
    | cls=name_or_attr '(' patterns=positional_patterns ','? ')' @{
        _PyAST_MatchClass(cls, patterns, NULL, NULL, EXTRA) @}
    | cls=name_or_attr '(' keywords=keyword_patterns ','? ')' @{
        _PyAST_MatchClass(
            cls, NULL,
            CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p,
                CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, keywords)))),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, keywords)),
            EXTRA) @}
    | cls=name_or_attr '(' patterns=positional_patterns ',' keywords=keyword_patterns ','? ')' @{
        _PyAST_MatchClass(
            cls,
            patterns,
            CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p,
                CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, keywords)))),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, keywords)),
            EXTRA) @}
    | invalid_class_pattern

positional_patterns[asdl_pattern_seq*]:
    | args[asdl_pattern_seq*]=','.pattern+ @{ args @}

keyword_patterns[asdl_seq*]:
    | ','.keyword_pattern+

keyword_pattern[KeyPatternPair*]:
    | arg=NAME '=' value=pattern @{ _PyPegen_key_pattern_pair(p, arg, value) @}

# Type statement
# ---------------

type_alias[stmt_ty]:
    | "type" n=NAME t=[type_params] '=' b=expression @{
        CHECK_VERSION(stmt_ty, 12, "Type statement is",
        _PyAST_TypeAlias(CHECK(expr_ty, _PyPegen_set_expr_context(p, n, Store)), t, b, EXTRA)) @}

# Type parameter declaration
# --------------------------

type_params[asdl_type_param_seq*]: 
    | invalid_type_params
    | '[' t=type_param_seq ']' @{
        CHECK_VERSION(asdl_type_param_seq *, 12, "Type parameter lists are", t) @}

type_param_seq[asdl_type_param_seq*]: a[asdl_type_param_seq*]=','.type_param+ [','] @{ a @}

type_param[type_param_ty] (memo):
    | a=NAME b=[type_param_bound] c=[type_param_default] @{ _PyAST_TypeVar(a->v.Name.id, b, c, EXTRA) @}
    | invalid_type_param
    | '*' a=NAME b=[type_param_starred_default] @{ _PyAST_TypeVarTuple(a->v.Name.id, b, EXTRA) @}
    | '**' a=NAME b=[type_param_default] @{ _PyAST_ParamSpec(a->v.Name.id, b, EXTRA) @}

type_param_bound[expr_ty]: ':' e=expression @{ e @}
type_param_default[expr_ty]: '=' e=expression @{
    CHECK_VERSION(expr_ty, 13, "Type parameter defaults are", e) @}
type_param_starred_default[expr_ty]: '=' e=star_expression @{
    CHECK_VERSION(expr_ty, 13, "Type parameter defaults are", e) @}

# EXPRESSIONS
# -----------

expressions[expr_ty]:
    | a=expression b=(',' c=expression @{ c @})+ [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Load, EXTRA) @}
    | a=expression ',' @{ _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_singleton_seq(p, a)), Load, EXTRA) @}
    | expression

expression[expr_ty] (memo):
    | invalid_expression
    | invalid_legacy_expression
    | a=disjunction 'if' b=disjunction 'else' c=expression @{ _PyAST_IfExp(b, a, c, EXTRA) @}
    | disjunction
    | lambdef

yield_expr[expr_ty]:
    | 'yield' 'from' a=expression @{ _PyAST_YieldFrom(a, EXTRA) @}
    | 'yield' a=[star_expressions] @{ _PyAST_Yield(a, EXTRA) @}

star_expressions[expr_ty]:
    | a=star_expression b=(',' c=star_expression @{ c @})+ [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Load, EXTRA) @}
    | a=star_expression ',' @{ _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_singleton_seq(p, a)), Load, EXTRA) @}
    | star_expression

star_expression[expr_ty] (memo):
    | '*' a=bitwise_or @{ _PyAST_Starred(a, Load, EXTRA) @}
    | expression

star_named_expressions[asdl_expr_seq*]: a[asdl_expr_seq*]=','.star_named_expression+ [','] @{ a @}

star_named_expression[expr_ty]:
    | '*' a=bitwise_or @{ _PyAST_Starred(a, Load, EXTRA) @}
    | named_expression

assignment_expression[expr_ty]:
    | a=NAME ':=' ~ b=expression @{
        CHECK_VERSION(expr_ty, 8, "Assignment expressions are",
        _PyAST_NamedExpr(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), b, EXTRA)) @}

named_expression[expr_ty]:
    | assignment_expression
    | invalid_named_expression
    | expression !':='

disjunction[expr_ty] (memo):
    | a=conjunction b=('or' c=conjunction @{ c @})+ @{ _PyAST_BoolOp(
        Or,
        CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)),
        EXTRA) @}
    | conjunction

conjunction[expr_ty] (memo):
    | a=inversion b=('and' c=inversion @{ c @})+ @{ _PyAST_BoolOp(
        And,
        CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)),
        EXTRA) @}
    | inversion

inversion[expr_ty] (memo):
    | 'not' a=inversion @{ _PyAST_UnaryOp(Not, a, EXTRA) @}
    | comparison

# Comparison operators
# --------------------

comparison[expr_ty]:
    | a=bitwise_or b=compare_op_bitwise_or_pair+ @{
        _PyAST_Compare(
            a,
            CHECK(asdl_int_seq*, _PyPegen_get_cmpops(p, b)),
            CHECK(asdl_expr_seq*, _PyPegen_get_exprs(p, b)),
            EXTRA) @}
    | bitwise_or

compare_op_bitwise_or_pair[CmpopExprPair*]:
    | eq_bitwise_or
    | noteq_bitwise_or
    | lte_bitwise_or
    | lt_bitwise_or
    | gte_bitwise_or
    | gt_bitwise_or
    | notin_bitwise_or
    | in_bitwise_or
    | isnot_bitwise_or
    | is_bitwise_or

eq_bitwise_or[CmpopExprPair*]: '==' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Eq, a) @}
noteq_bitwise_or[CmpopExprPair*]:
    | (tok='!=' @{ _PyPegen_check_barry_as_flufl(p, tok) ? NULL : tok@}) a=bitwise_or @{_PyPegen_cmpop_expr_pair(p, NotEq, a) @}
lte_bitwise_or[CmpopExprPair*]: '<=' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, LtE, a) @}
lt_bitwise_or[CmpopExprPair*]: '<' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Lt, a) @}
gte_bitwise_or[CmpopExprPair*]: '>=' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, GtE, a) @}
gt_bitwise_or[CmpopExprPair*]: '>' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Gt, a) @}
notin_bitwise_or[CmpopExprPair*]: 'not' 'in' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, NotIn, a) @}
in_bitwise_or[CmpopExprPair*]: 'in' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, In, a) @}
isnot_bitwise_or[CmpopExprPair*]: 'is' 'not' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, IsNot, a) @}
is_bitwise_or[CmpopExprPair*]: 'is' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Is, a) @}

# Bitwise operators
# -----------------

bitwise_or[expr_ty]:
    | a=bitwise_or '|' b=bitwise_xor @{ _PyAST_BinOp(a, BitOr, b, EXTRA) @}
    | bitwise_xor

bitwise_xor[expr_ty]:
    | a=bitwise_xor '^' b=bitwise_and @{ _PyAST_BinOp(a, BitXor, b, EXTRA) @}
    | bitwise_and

bitwise_and[expr_ty]:
    | a=bitwise_and '&' b=shift_expr @{ _PyAST_BinOp(a, BitAnd, b, EXTRA) @}
    | shift_expr

shift_expr[expr_ty]:
    | a=shift_expr '<<' b=sum @{ _PyAST_BinOp(a, LShift, b, EXTRA) @}
    | a=shift_expr '>>' b=sum @{ _PyAST_BinOp(a, RShift, b, EXTRA) @}
    | invalid_arithmetic
    | sum

# Arithmetic operators
# --------------------

sum[expr_ty]:
    | a=sum '+' b=term @{ _PyAST_BinOp(a, Add, b, EXTRA) @}
    | a=sum '-' b=term @{ _PyAST_BinOp(a, Sub, b, EXTRA) @}
    | term

term[expr_ty]:
    | a=term '*' b=factor @{ _PyAST_BinOp(a, Mult, b, EXTRA) @}
    | a=term '/' b=factor @{ _PyAST_BinOp(a, Div, b, EXTRA) @}
    | a=term '//' b=factor @{ _PyAST_BinOp(a, FloorDiv, b, EXTRA) @}
    | a=term '%' b=factor @{ _PyAST_BinOp(a, Mod, b, EXTRA) @}
    | a=term '@@' b=factor @{ CHECK_VERSION(expr_ty, 5, "The '@@' operator is", _PyAST_BinOp(a, MatMult, b, EXTRA)) @}
    | invalid_factor
    | factor

factor[expr_ty] (memo):
    | '+' a=factor @{ _PyAST_UnaryOp(UAdd, a, EXTRA) @}
    | '-' a=factor @{ _PyAST_UnaryOp(USub, a, EXTRA) @}
    | '~' a=factor @{ _PyAST_UnaryOp(Invert, a, EXTRA) @}
    | power

power[expr_ty]:
    | a=await_primary '**' b=factor @{ _PyAST_BinOp(a, Pow, b, EXTRA) @}
    | await_primary

# Primary elements
# ----------------

# Primary elements are things like "obj.something.something", "obj[something]", "obj(something)", "obj" ...

await_primary[expr_ty] (memo):
    | 'await' a=primary @{ CHECK_VERSION(expr_ty, 5, "Await expressions are", _PyAST_Await(a, EXTRA)) @}
    | primary

primary[expr_ty]:
    | a=primary '.' b=NAME @{ _PyAST_Attribute(a, b->v.Name.id, Load, EXTRA) @}
    | a=primary b=genexp @{ _PyAST_Call(a, CHECK(asdl_expr_seq*, (asdl_expr_seq*)_PyPegen_singleton_seq(p, b)), NULL, EXTRA) @}
    | a=primary '(' b=[arguments] ')' @{
        _PyAST_Call(a,
                 (b) ? ((expr_ty) b)->v.Call.args : NULL,
                 (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                 EXTRA) @}
    | a=primary '[' b=slices ']' @{ _PyAST_Subscript(a, b, Load, EXTRA) @}
    | atom

slices[expr_ty]:
    | a=slice !',' @{ a @}
    | a[asdl_expr_seq*]=','.(slice | starred_expression)+ [','] @{ _PyAST_Tuple(a, Load, EXTRA) @}

slice[expr_ty]:
    | a=[expression] ':' b=[expression] c=[':' d=[expression] @{ d @}] @{ _PyAST_Slice(a, b, c, EXTRA) @}
    | a=named_expression @{ a @}

atom[expr_ty]:
    | NAME
    | 'True' @{ _PyAST_Constant(Py_True, NULL, EXTRA) @}
    | 'False' @{ _PyAST_Constant(Py_False, NULL, EXTRA) @}
    | 'None' @{ _PyAST_Constant(Py_None, NULL, EXTRA) @}
    | &(STRING|FSTRING_START) strings
    | NUMBER
    | &'(' (tuple | group | genexp)
    | &'[' (list | listcomp)
    | &'@{' (dict | set | dictcomp | setcomp)
    | '...' @{ _PyAST_Constant(Py_Ellipsis, NULL, EXTRA) @}

group[expr_ty]:
    | '(' a=(yield_expr | named_expression) ')' @{ a @}
    | invalid_group

# Lambda functions
# ----------------

lambdef[expr_ty]:
    | 'lambda' a=[lambda_params] ':' b=expression @{
        _PyAST_Lambda((a) ? a : CHECK(arguments_ty, _PyPegen_empty_arguments(p)), b, EXTRA) @}

lambda_params[arguments_ty]:
    | invalid_lambda_parameters
    | lambda_parameters

# lambda_parameters etc. duplicates parameters but without annotations
# or type comments, and if there's no comma after a parameter, we expect
# a colon, not a close parenthesis.  (For more, see parameters above.)
#
lambda_parameters[arguments_ty]:
    | a=lambda_slash_no_default b[asdl_arg_seq*]=lambda_param_no_default* c=lambda_param_with_default* d=[lambda_star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, a, NULL, b, c, d)) @}
    | a=lambda_slash_with_default b=lambda_param_with_default* c=[lambda_star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, NULL, a, NULL, b, c)) @}
    | a[asdl_arg_seq*]=lambda_param_no_default+ b=lambda_param_with_default* c=[lambda_star_etc] @{
        _PyPegen_make_arguments(p, NULL, NULL, a, b, c) @}
    | a=lambda_param_with_default+ b=[lambda_star_etc] @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, a, b)@}
    | a=lambda_star_etc @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, NULL, a) @}

lambda_slash_no_default[asdl_arg_seq*]:
    | a[asdl_arg_seq*]=lambda_param_no_default+ '/' ',' @{ a @}
    | a[asdl_arg_seq*]=lambda_param_no_default+ '/' &':' @{ a @}

lambda_slash_with_default[SlashWithDefault*]:
    | a=lambda_param_no_default* b=lambda_param_with_default+ '/' ',' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}
    | a=lambda_param_no_default* b=lambda_param_with_default+ '/' &':' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}

lambda_star_etc[StarEtc*]:
    | invalid_lambda_star_etc
    | '*' a=lambda_param_no_default b=lambda_param_maybe_default* c=[lambda_kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' ',' b=lambda_param_maybe_default+ c=[lambda_kwds] @{
        _PyPegen_star_etc(p, NULL, b, c) @}
    | a=lambda_kwds @{ _PyPegen_star_etc(p, NULL, NULL, a) @}

lambda_kwds[arg_ty]:
    | invalid_lambda_kwds
    | '**' a=lambda_param_no_default @{ a @}

lambda_param_no_default[arg_ty]:
    | a=lambda_param ',' @{ a @}
    | a=lambda_param &':' @{ a @}
lambda_param_with_default[NameDefaultPair*]:
    | a=lambda_param c=default ',' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
    | a=lambda_param c=default &':' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
lambda_param_maybe_default[NameDefaultPair*]:
    | a=lambda_param c=default? ',' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
    | a=lambda_param c=default? &':' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
lambda_param[arg_ty]: a=NAME @{ _PyAST_arg(a->v.Name.id, NULL, NULL, EXTRA) @}

# LITERALS
# ========

fstring_middle[expr_ty]:
    | fstring_replacement_field
    | t=FSTRING_MIDDLE @{ _PyPegen_constant_from_token(p, t) @}
fstring_replacement_field[expr_ty]:
    | '@{' a=annotated_rhs debug_expr='='? conversion=[fstring_conversion] format=[fstring_full_format_spec] rbrace='@}' @{
        _PyPegen_formatted_value(p, a, debug_expr, conversion, format, rbrace, EXTRA) @}
    | invalid_replacement_field
fstring_conversion[ResultTokenWithMetadata*]:
    | conv_token="!" conv=NAME @{ _PyPegen_check_fstring_conversion(p, conv_token, conv) @}
fstring_full_format_spec[ResultTokenWithMetadata*]:
    | colon=':' spec=fstring_format_spec* @{ _PyPegen_setup_full_format_spec(p, colon, (asdl_expr_seq *) spec, EXTRA) @}
fstring_format_spec[expr_ty]:
    | t=FSTRING_MIDDLE @{ _PyPegen_decoded_constant_from_token(p, t) @}
    | fstring_replacement_field
fstring[expr_ty]:
    | a=FSTRING_START b=fstring_middle* c=FSTRING_END @{ _PyPegen_joined_str(p, a, (asdl_expr_seq*)b, c) @}

string[expr_ty]: s[Token*]=STRING @{ _PyPegen_constant_from_string(p, s) @}
strings[expr_ty] (memo): a[asdl_expr_seq*]=(fstring|string)+ @{ _PyPegen_concatenate_strings(p, a, EXTRA) @}

list[expr_ty]:
    | '[' a=[star_named_expressions] ']' @{ _PyAST_List(a, Load, EXTRA) @}

tuple[expr_ty]:
    | '(' a=[y=star_named_expression ',' z=[star_named_expressions] @{ _PyPegen_seq_insert_in_front(p, y, z) @} ] ')' @{
        _PyAST_Tuple(a, Load, EXTRA) @}

set[expr_ty]: '@{' a=star_named_expressions '@}' @{ _PyAST_Set(a, EXTRA) @}

# Dicts
# -----

dict[expr_ty]:
    | '@{' a=[double_starred_kvpairs] '@}' @{
        _PyAST_Dict(
            CHECK(asdl_expr_seq*, _PyPegen_get_keys(p, a)),
            CHECK(asdl_expr_seq*, _PyPegen_get_values(p, a)),
            EXTRA) @}
    | '@{' invalid_double_starred_kvpairs '@}'

double_starred_kvpairs[asdl_seq*]: a=','.double_starred_kvpair+ [','] @{ a @}

double_starred_kvpair[KeyValuePair*]:
    | '**' a=bitwise_or @{ _PyPegen_key_value_pair(p, NULL, a) @}
    | kvpair

kvpair[KeyValuePair*]: a=expression ':' b=expression @{ _PyPegen_key_value_pair(p, a, b) @}

# Comprehensions & Generators
# ---------------------------

for_if_clauses[asdl_comprehension_seq*]:
    | a[asdl_comprehension_seq*]=for_if_clause+ @{ a @}

for_if_clause[comprehension_ty]:
    | 'async' 'for' a=star_targets 'in' ~ b=disjunction c[asdl_expr_seq*]=('if' z=disjunction @{ z @})* @{
        CHECK_VERSION(comprehension_ty, 6, "Async comprehensions are", _PyAST_comprehension(a, b, c, 1, p->arena)) @}
    | 'for' a=star_targets 'in' ~ b=disjunction c[asdl_expr_seq*]=('if' z=disjunction @{ z @})* @{
        _PyAST_comprehension(a, b, c, 0, p->arena) @}
    | invalid_for_if_clause
    | invalid_for_target

listcomp[expr_ty]:
    | '[' a=named_expression b=for_if_clauses ']' @{ _PyAST_ListComp(a, b, EXTRA) @}
    | invalid_comprehension

setcomp[expr_ty]:
    | '@{' a=named_expression b=for_if_clauses '@}' @{ _PyAST_SetComp(a, b, EXTRA) @}
    | invalid_comprehension

genexp[expr_ty]:
    | '(' a=( assignment_expression | expression !':=') b=for_if_clauses ')' @{ _PyAST_GeneratorExp(a, b, EXTRA) @}
    | invalid_comprehension

dictcomp[expr_ty]:
    | '@{' a=kvpair b=for_if_clauses '@}' @{ _PyAST_DictComp(a->key, a->value, b, EXTRA) @}
    | invalid_dict_comprehension

# FUNCTION CALL ARGUMENTS
# =======================

arguments[expr_ty] (memo):
    | a=args [','] &')' @{ a @}
    | invalid_arguments

args[expr_ty]:
    | a[asdl_expr_seq*]=','.(starred_expression | ( assignment_expression | expression !':=') !'=')+ b=[',' k=kwargs @{k@}] @{
        _PyPegen_collect_call_seqs(p, a, b, EXTRA) @}
    | a=kwargs @{ _PyAST_Call(_PyPegen_dummy_name(p),
                          CHECK_NULL_ALLOWED(asdl_expr_seq*, _PyPegen_seq_extract_starred_exprs(p, a)),
                          CHECK_NULL_ALLOWED(asdl_keyword_seq*, _PyPegen_seq_delete_starred_exprs(p, a)),
                          EXTRA) @}

kwargs[asdl_seq*]:
    | a=','.kwarg_or_starred+ ',' b=','.kwarg_or_double_starred+ @{ _PyPegen_join_sequences(p, a, b) @}
    | ','.kwarg_or_starred+
    | ','.kwarg_or_double_starred+

starred_expression[expr_ty]:
    | invalid_starred_expression_unpacking
    | '*' a=expression @{ _PyAST_Starred(a, Load, EXTRA) @}
    | invalid_starred_expression

kwarg_or_starred[KeywordOrStarred*]:
    | invalid_kwarg
    | a=NAME '=' b=expression @{
        _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(a->v.Name.id, b, EXTRA)), 1) @}
    | a=starred_expression @{ _PyPegen_keyword_or_starred(p, a, 0) @}

kwarg_or_double_starred[KeywordOrStarred*]:
    | invalid_kwarg
    | a=NAME '=' b=expression @{
        _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(a->v.Name.id, b, EXTRA)), 1) @}
    | '**' a=expression @{ _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(NULL, a, EXTRA)), 1) @}

# ASSIGNMENT TARGETS
# ==================

# Generic targets
# ---------------

# NOTE: star_targets may contain *bitwise_or, targets may not.
star_targets[expr_ty]:
    | a=star_target !',' @{ a @}
    | a=star_target b=(',' c=star_target @{ c @})* [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Store, EXTRA) @}

star_targets_list_seq[asdl_expr_seq*]: a[asdl_expr_seq*]=','.star_target+ [','] @{ a @}

star_targets_tuple_seq[asdl_expr_seq*]:
    | a=star_target b=(',' c=star_target @{ c @})+ [','] @{ (asdl_expr_seq*) _PyPegen_seq_insert_in_front(p, a, b) @}
    | a=star_target ',' @{ (asdl_expr_seq*) _PyPegen_singleton_seq(p, a) @}

star_target[expr_ty] (memo):
    | '*' a=(!'*' star_target) @{
        _PyAST_Starred(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), Store, EXTRA) @}
    | target_with_star_atom

target_with_star_atom[expr_ty] (memo):
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Store, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Store, EXTRA) @}
    | star_atom

star_atom[expr_ty]:
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=target_with_star_atom ')' @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=[star_targets_tuple_seq] ')' @{ _PyAST_Tuple(a, Store, EXTRA) @}
    | '[' a=[star_targets_list_seq] ']' @{ _PyAST_List(a, Store, EXTRA) @}

single_target[expr_ty]:
    | single_subscript_attribute_target
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=single_target ')' @{ a @}

single_subscript_attribute_target[expr_ty]:
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Store, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Store, EXTRA) @}

t_primary[expr_ty]:
    | a=t_primary '.' b=NAME &t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Load, EXTRA) @}
    | a=t_primary '[' b=slices ']' &t_lookahead @{ _PyAST_Subscript(a, b, Load, EXTRA) @}
    | a=t_primary b=genexp &t_lookahead @{
        _PyAST_Call(a, CHECK(asdl_expr_seq*, (asdl_expr_seq*)_PyPegen_singleton_seq(p, b)), NULL, EXTRA) @}
    | a=t_primary '(' b=[arguments] ')' &t_lookahead @{
        _PyAST_Call(a,
                 (b) ? ((expr_ty) b)->v.Call.args : NULL,
                 (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                 EXTRA) @}
    | a=atom &t_lookahead @{ a @}

t_lookahead: '(' | '[' | '.'

# Targets for del statements
# --------------------------

del_targets[asdl_expr_seq*]: a[asdl_expr_seq*]=','.del_target+ [','] @{ a @}

del_target[expr_ty] (memo):
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Del, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Del, EXTRA) @}
    | del_t_atom

del_t_atom[expr_ty]:
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Del) @}
    | '(' a=del_target ')' @{ _PyPegen_set_expr_context(p, a, Del) @}
    | '(' a=[del_targets] ')' @{ _PyAST_Tuple(a, Del, EXTRA) @}
    | '[' a=[del_targets] ']' @{ _PyAST_List(a, Del, EXTRA) @}

# TYPING ELEMENTS
# ---------------

# type_expressions allow */** but ignore them
type_expressions[asdl_expr_seq*]:
    | a=','.expression+ ',' '*' b=expression ',' '**' c=expression @{
        (asdl_expr_seq*)_PyPegen_seq_append_to_end(
            p,
            CHECK(asdl_seq*, _PyPegen_seq_append_to_end(p, a, b)),
            c) @}
    | a=','.expression+ ',' '*' b=expression @{ (asdl_expr_seq*)_PyPegen_seq_append_to_end(p, a, b) @}
    | a=','.expression+ ',' '**' b=expression @{ (asdl_expr_seq*)_PyPegen_seq_append_to_end(p, a, b) @}
    | '*' a=expression ',' '**' b=expression @{
        (asdl_expr_seq*)_PyPegen_seq_append_to_end(
            p,
            CHECK(asdl_seq*, _PyPegen_singleton_seq(p, a)),
            b) @}
    | '*' a=expression @{ (asdl_expr_seq*)_PyPegen_singleton_seq(p, a) @}
    | '**' a=expression @{ (asdl_expr_seq*)_PyPegen_singleton_seq(p, a) @}
    | a[asdl_expr_seq*]=','.expression+ @{a@}

func_type_comment[Token*]:
    | NEWLINE t=TYPE_COMMENT &(NEWLINE INDENT) @{ t @}  # Must be followed by indented block
    | invalid_double_type_comments
    | TYPE_COMMENT

# ========================= END OF THE GRAMMAR ===========================



# ========================= START OF INVALID RULES =======================

# From here on, there are rules for invalid syntax with specialised error messages
invalid_arguments:
    | ((','.(starred_expression | ( assignment_expression | expression !':=') !'=')+ ',' kwargs) | kwargs) a=',' ','.(starred_expression !'=')+ @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "iterable argument unpacking follows keyword argument unpacking") @}
    | a=expression b=for_if_clauses ',' [args | expression for_if_clauses] @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, _PyPegen_get_last_comprehension_item(PyPegen_last_item(b, comprehension_ty)), "Generator expression must be parenthesized") @}
    | a=NAME b='=' expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?")@}
    | (args ',')? a=NAME b='=' &(',' | ')') @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "expected argument value expression")@}
    | a=args b=for_if_clauses @{ _PyPegen_nonparen_genexp_in_call(p, a, b) @}
    | args ',' a=expression b=for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, _PyPegen_get_last_comprehension_item(PyPegen_last_item(b, comprehension_ty)), "Generator expression must be parenthesized") @}
    | a=args ',' args @{ _PyPegen_arguments_parsing_error(p, a) @}
invalid_kwarg:
    | a[Token*]=('True'|'False'|'None') b='=' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to %s", PyBytes_AS_STRING(a->bytes)) @}
    | a=NAME b='=' expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?")@}
    | !(NAME '=') a=expression b='=' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(
            a, b, "expression cannot contain assignment, perhaps you meant \"==\"?") @}
    | a='**' expression '=' b=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to keyword argument unpacking") @}

# IMPORTANT: Note that the "_without_invalid" suffix causes the rule to not call invalid rules under it
expression_without_invalid[expr_ty]:
    | a=disjunction 'if' b=disjunction 'else' c=expression @{ _PyAST_IfExp(b, a, c, EXTRA) @}
    | disjunction
    | lambdef
invalid_legacy_expression:
    | a=NAME !'(' b=star_expressions @{
        _PyPegen_check_legacy_stmt(p, a) ? RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b,
            "Missing parentheses in call to '%U'. Did you mean %U(...)?", a->v.Name.id, a->v.Name.id) : NULL@}

invalid_type_param:
    | '*' a=NAME colon=':' e=expression @{
            RAISE_SYNTAX_ERROR_STARTING_FROM(colon, e->kind == Tuple_kind
                ? "cannot use constraints with TypeVarTuple"
                : "cannot use bound with TypeVarTuple")
        @}
    | '**' a=NAME colon=':' e=expression @{
            RAISE_SYNTAX_ERROR_STARTING_FROM(colon, e->kind == Tuple_kind
                ? "cannot use constraints with ParamSpec"
                : "cannot use bound with ParamSpec")
        @}

invalid_expression:
    # !(NAME STRING) is not matched so we don't show this error with some invalid string prefixes like: kf"dsfsdf"
    # Soft keywords need to also be ignored because they can be parsed as NAME NAME
   | !(NAME STRING | SOFT_KEYWORD) a=disjunction b=expression_without_invalid @{
        _PyPegen_check_legacy_stmt(p, a) ? NULL : p->tokens[p->mark-1]->level == 0 ? NULL :
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Perhaps you forgot a comma?") @}
   | a=disjunction 'if' b=disjunction !('else'|':') @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "expected 'else' after 'if' expression") @}
   | a='lambda' [lambda_params] b=':' &FSTRING_MIDDLE  @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "f-string: lambda expressions are not allowed without parentheses") @}

invalid_named_expression(memo):
    | a=expression ':=' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use assignment expressions with %s", _PyPegen_get_expr_name(a)) @}
    | a=NAME '=' b=bitwise_or !('='|':=') @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?") @}
    | !(list|tuple|genexp|'True'|'None'|'False') a=bitwise_or b='=' bitwise_or !('='|':=') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot assign to %s here. Maybe you meant '==' instead of '='?",
                                          _PyPegen_get_expr_name(a)) @}

invalid_assignment:
    | a=invalid_ann_assign_target ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a,
            "only single target (not %s) can be annotated",
            _PyPegen_get_expr_name(a)
        )@}
    | a=star_named_expression ',' star_named_expressions* ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "only single target (not tuple) can be annotated") @}
    | a=expression ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "illegal target for annotation") @}
    | (star_targets '=')* a=star_expressions '=' @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(STAR_TARGETS, a) @}
    | (star_targets '=')* a=yield_expr '=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "assignment to yield expression not possible") @}
    | a=star_expressions augassign annotated_rhs @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a,
            "'%s' is an illegal expression for augmented assignment",
            _PyPegen_get_expr_name(a)
        )@}
invalid_ann_assign_target[expr_ty]:
    | list
    | tuple
    | '(' a=invalid_ann_assign_target ')' @{ a @}
invalid_del_stmt:
    | 'del' a=star_expressions @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(DEL_TARGETS, a) @}
invalid_block:
    | NEWLINE !INDENT @{ RAISE_INDENTATION_ERROR("expected an indented block") @}
invalid_comprehension:
    | ('[' | '(' | '@{') a=starred_expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "iterable unpacking cannot be used in comprehension") @}
    | ('[' | '@{') a=star_named_expression ',' b=star_named_expressions for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, PyPegen_last_item(b, expr_ty),
        "did you forget parentheses around the comprehension target?") @}
    | ('[' | '@{') a=star_named_expression b=',' for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "did you forget parentheses around the comprehension target?") @}
invalid_dict_comprehension:
    | '@{' a='**' bitwise_or for_if_clauses '@}' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "dict unpacking cannot be used in dict comprehension") @}
invalid_parameters:
    | a="/" ',' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "at least one argument must precede /") @}
    | (slash_no_default | slash_with_default) param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ may appear only once") @}
    | slash_no_default? param_no_default* invalid_parameters_helper a=param_no_default @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "parameter without a default follows parameter with a default") @}
    | param_no_default* a='(' param_no_default+ ','? b=')' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "Function parameters cannot be parenthesized") @}
    | (slash_no_default | slash_with_default)? param_maybe_default* '*' (',' | param_no_default) param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ must be ahead of *") @}
    | param_maybe_default+ '/' a='*' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected comma between / and *") @}
invalid_default:
    | a='=' &(')'|',') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected default value expression") @}
invalid_star_etc:
    | a='*' (')' | ',' (')' | '**')) @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "named arguments must follow bare *") @}
    | '*' ',' TYPE_COMMENT @{ RAISE_SYNTAX_ERROR("bare * has associated type comment") @}
    | '*' param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-positional argument cannot have default value") @}
    | '*' (param_no_default | ',') param_maybe_default* a='*' (param_no_default | ',') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "* argument may appear only once") @}
invalid_kwds:
    | '**' param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-keyword argument cannot have default value") @}
    | '**' param ',' a=param @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
    | '**' param ',' a[Token*]=('*'|'**'|'/') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
invalid_parameters_helper: # This is only there to avoid type errors
    | a=slash_with_default @{ _PyPegen_singleton_seq(p, a) @}
    | param_with_default+
invalid_lambda_parameters:
    | a="/" ',' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "at least one argument must precede /") @}
    | (lambda_slash_no_default | lambda_slash_with_default) lambda_param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ may appear only once") @}
    | lambda_slash_no_default? lambda_param_no_default* invalid_lambda_parameters_helper a=lambda_param_no_default @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "parameter without a default follows parameter with a default") @}
    | lambda_param_no_default* a='(' ','.lambda_param+ ','? b=')' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "Lambda expression parameters cannot be parenthesized") @}
    | (lambda_slash_no_default | lambda_slash_with_default)? lambda_param_maybe_default* '*' (',' | lambda_param_no_default) lambda_param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ must be ahead of *") @}
    | lambda_param_maybe_default+ '/' a='*' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected comma between / and *") @}
invalid_lambda_parameters_helper:
    | a=lambda_slash_with_default @{ _PyPegen_singleton_seq(p, a) @}
    | lambda_param_with_default+
invalid_lambda_star_etc:
    | '*' (':' | ',' (':' | '**')) @{ RAISE_SYNTAX_ERROR("named arguments must follow bare *") @}
    | '*' lambda_param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-positional argument cannot have default value") @}
    | '*' (lambda_param_no_default | ',') lambda_param_maybe_default* a='*' (lambda_param_no_default | ',') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "* argument may appear only once") @}
invalid_lambda_kwds:
    | '**' lambda_param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-keyword argument cannot have default value") @}
    | '**' lambda_param ',' a=lambda_param @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
    | '**' lambda_param ',' a[Token*]=('*'|'**'|'/') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
invalid_double_type_comments:
    | TYPE_COMMENT NEWLINE TYPE_COMMENT NEWLINE INDENT @{
        RAISE_SYNTAX_ERROR("Cannot have two type comments on def") @}
invalid_with_item:
    | expression 'as' a=expression &(',' | ')' | ':') @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(STAR_TARGETS, a) @}

invalid_for_if_clause:
    | 'async'? 'for' (bitwise_or (',' bitwise_or)* [',']) !'in' @{
        RAISE_SYNTAX_ERROR("'in' expected after for-loop variables") @}

invalid_for_target:
    | 'async'? 'for' a=star_expressions @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(FOR_TARGETS, a) @}

invalid_group:
    | '(' a=starred_expression ')' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use starred expression here") @}
    | '(' a='**' expression ')' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use double starred expression here") @}
invalid_import:
    | a='import' ','.dotted_name+ 'from' dotted_name @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "Did you mean to use 'from ... import ...' instead?") @}
    | 'import' token=NEWLINE @{ 
        RAISE_SYNTAX_ERROR_STARTING_FROM(token, "Expected one or more names after 'import'") @}

invalid_import_from_targets:
    | import_from_as_names ',' NEWLINE @{
        RAISE_SYNTAX_ERROR("trailing comma not allowed without surrounding parentheses") @}
    | token=NEWLINE @{ 
        RAISE_SYNTAX_ERROR_STARTING_FROM(token, "Expected one or more names after 'import'") @}

invalid_with_stmt:
    | ['async'] 'with' ','.(expression ['as' star_target])+ NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | ['async'] 'with' '(' ','.(expressions ['as' star_target])+ ','? ')' NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
invalid_with_stmt_indent:
    | ['async'] a='with' ','.(expression ['as' star_target])+ ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'with' statement on line %d", a->lineno) @}
    | ['async'] a='with' '(' ','.(expressions ['as' star_target])+ ','? ')' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'with' statement on line %d", a->lineno) @}

invalid_try_stmt:
    | a='try' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'try' statement on line %d", a->lineno) @}
    | 'try' ':' block !('except' | 'finally') @{ RAISE_SYNTAX_ERROR("expected 'except' or 'finally' block") @}
    | 'try' ':' block* except_block+ a='except' b='*' expression ['as' NAME] ':' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot have both 'except' and 'except*' on the same 'try'") @}
    | 'try' ':' block* except_star_block+ a='except' [expression ['as' NAME]] ':' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot have both 'except' and 'except*' on the same 'try'") @}
invalid_except_stmt:
    | 'except' a=expression ',' expressions ['as' NAME ] ':' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "multiple exception types must be parenthesized") @}
    | a='except' expression ['as' NAME ] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='except' NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | 'except' expression 'as' a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use except statement with %s", _PyPegen_get_expr_name(a)) @}
invalid_except_star_stmt:
    | 'except' '*' a=expression ',' expressions ['as' NAME ] ':' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "multiple exception types must be parenthesized") @}
    | a='except' '*' expression ['as' NAME ] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='except' '*' (NEWLINE | ':') @{ RAISE_SYNTAX_ERROR("expected one or more exception types") @}
    | 'except' '*' expression 'as' a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use except* statement with %s", _PyPegen_get_expr_name(a)) @}
invalid_finally_stmt:
    | a='finally' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'finally' statement on line %d", a->lineno) @}
invalid_except_stmt_indent:
    | a='except' expression ['as' NAME ] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'except' statement on line %d", a->lineno) @}
    | a='except' ':' NEWLINE !INDENT @{ RAISE_INDENTATION_ERROR("expected an indented block after 'except' statement on line %d", a->lineno) @}
invalid_except_star_stmt_indent:
    | a='except' '*' expression ['as' NAME ] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'except*' statement on line %d", a->lineno) @}
invalid_match_stmt:
    | "match" subject_expr NEWLINE @{ CHECK_VERSION(void*, 10, "Pattern matching is", RAISE_SYNTAX_ERROR("expected ':'") ) @}
    | a="match" subject=subject_expr ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'match' statement on line %d", a->lineno) @}
invalid_case_block:
    | "case" patterns guard? NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a="case" patterns guard? ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'case' statement on line %d", a->lineno) @}
invalid_as_pattern:
    | or_pattern 'as' a="_" @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use '_' as a target") @}
    | or_pattern 'as' a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use %s as pattern target", _PyPegen_get_expr_name(a)) @}
invalid_class_pattern:
    | name_or_attr '(' a=invalid_class_argument_pattern  @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(
        PyPegen_first_item(a, pattern_ty),
        PyPegen_last_item(a, pattern_ty),
        "positional patterns follow keyword patterns") @}
invalid_class_argument_pattern[asdl_pattern_seq*]:
    | [positional_patterns ','] keyword_patterns ',' a=positional_patterns @{ a @}
invalid_if_stmt:
    | 'if' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='if' a=named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'if' statement on line %d", a->lineno) @}
invalid_elif_stmt:
    | 'elif' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='elif' named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'elif' statement on line %d", a->lineno) @}
invalid_else_stmt:
    | a='else' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'else' statement on line %d", a->lineno) @}
invalid_while_stmt:
    | 'while' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='while' named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'while' statement on line %d", a->lineno) @}
invalid_for_stmt:
    | ['async'] 'for' star_targets 'in' star_expressions NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | ['async'] a='for' star_targets 'in' star_expressions ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'for' statement on line %d", a->lineno) @}
invalid_def_raw:
    | ['async'] a='def' NAME [type_params] '(' [params] ')' ['->' expression] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after function definition on line %d", a->lineno) @}
    | ['async'] 'def' NAME [type_params] &&'(' [params] ')' ['->' expression] &&':' [func_type_comment] block
invalid_class_def_raw:
    | 'class' NAME [type_params] ['(' [arguments] ')'] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='class' NAME [type_params] ['(' [arguments] ')'] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after class definition on line %d", a->lineno) @}

invalid_double_starred_kvpairs:
    | ','.double_starred_kvpair+ ',' invalid_kvpair
    | expression ':' a='*' bitwise_or @{ RAISE_SYNTAX_ERROR_STARTING_FROM(a, "cannot use a starred expression in a dictionary value") @}
    | expression a=':' &('@}'|',') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expression expected after dictionary key and ':'") @}
invalid_kvpair:
    | a=expression !(':') @{
        RAISE_ERROR_KNOWN_LOCATION(p, PyExc_SyntaxError, a->lineno, a->end_col_offset - 1, a->end_lineno, -1, "':' expected after dictionary key") @}
    | expression ':' a='*' bitwise_or @{ RAISE_SYNTAX_ERROR_STARTING_FROM(a, "cannot use a starred expression in a dictionary value") @}
    | expression a=':' &('@}'|',') @{RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expression expected after dictionary key and ':'") @}
invalid_starred_expression_unpacking:
    | a='*' expression '=' b=expression @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to iterable argument unpacking") @}
invalid_starred_expression:
    | '*' @{ RAISE_SYNTAX_ERROR("Invalid star expression") @}

invalid_replacement_field:
    | '@{' a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '='") @}
    | '@{' a='!' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '!'") @}
    | '@{' a=':' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before ':'") @}
    | '@{' a='@}' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '@}'") @}
    | '@{' !annotated_rhs @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting a valid expression after '@{'")@}
    | '@{' annotated_rhs !('=' | '!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '=', or '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '=' !('!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '='? invalid_conversion_character
    | '@{' annotated_rhs '='? ['!' NAME] !(':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting ':' or '@}'") @}
    | '@{' annotated_rhs '='? ['!' NAME] ':' fstring_format_spec* !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '@}', or format specs") @}
    | '@{' annotated_rhs '='? ['!' NAME] !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '@}'") @}

invalid_conversion_character:
    | '!' &(':' | '@}') @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: missing conversion character") @}
    | '!' !NAME @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: invalid conversion character") @}

invalid_arithmetic:
    | sum ('+'|'-'|'*'|'/'|'%'|'//'|'@@') a='not' b=inversion @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "'not' after an operator must be parenthesized") @}
invalid_factor:
    | ('+' | '-' | '~') a='not' b=factor @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "'not' after an operator must be parenthesized") @}

invalid_type_params:
    | '[' token=']' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(
            token, 
            "Type parameter list cannot be empty")@}
@end example

@node La biblioteca estándar de Python,Ampliación e incrustación del intérprete de Python,Referencia del Lenguaje Python,Top
@anchor{library/index doc}@anchor{214d}@anchor{library/index library-index}@anchor{2b1}@anchor{library/index the-python-standard-library}@anchor{214e}
@chapter La biblioteca estándar de Python


Aunque @ref{2b2,,Referencia del Lenguaje Python}  describe la sintaxis y semántica precisa del lenguaje Python, este manual de referencia de la biblioteca describe la biblioteca estándar que se distribuye con Python. También describe algunos componentes opcionales que son usualmente incluidos en las distribuciones de Python.

La biblioteca estándar de Python es muy amplia, y ofrece una gran cantidad de producciones como puede verse en la larga lista de contenidos. La biblioteca contiene módulos incorporados (escritos en C) que brindan acceso a las funcionalidades del sistema como entrada y salida de archivos que serían de otra forma inaccesibles para los programadores en Python, así como módulos escritos en Python que proveen soluciones estandarizadas para los diversos problemas que pueden ocurrir en el día a día en la programación. Algunos de éstos módulos están diseñados explícitamente para alentar y reforzar la portabilidad de los programas en Python abstrayendo especificidades de las plataformas para lograr APIs neutrales a la plataforma.

Los instaladores de Python para la plataforma Windows frecuentemente incluyen la biblioteca estándar completa y suelen también incluir muchos componentes adicionales. Para los sistemas operativos tipo Unix Python suele ser provisto como una colección de paquetes, así que puede requerirse usar las herramientas de empaquetado disponibles en los sistemas operativos para obtener algunos o todos los componentes opcionales.

Además de la biblioteca estándar, existe un colección creciente de varios miles de componentes (abarcando módulos o programas individuales, paquetes o `frameworks' completos de desarrollo de aplicaciones), disponibles en el Python Package Index@footnote{https://pypi.org}.

@c We don't use :numbered: option for the TOC below as it enforces
@c numbered sections for the entire stdlib docs.  If desired,
@c :numbered: can be enabled on a per-module basis.

@menu
* Introducción: Introducción<6>. 
* Funciones incorporadas: Funciones incorporadas<2>. 
* Constantes incorporadas:: 
* Tipos integrados:: 
* Excepciones incorporadas:: 
* Servicios de procesamiento de texto:: 
* Servicios de datos binarios:: 
* Tipos de datos:: 
* Módulos numéricos y matemáticos:: 
* Módulos de programación funcional:: 
* Acceso a archivos y directorios:: 
* Persistencia de datos:: 
* Compresión de datos y archivado:: 
* Formatos de archivo:: 
* Servicios criptográficos:: 
* Servicios genéricos del sistema operativo:: 
* Ejecución concurrente:: 
* Comunicación en redes y entre procesos:: 
* Manejo de datos de internet:: 
* Herramientas Para Procesar Formatos de Marcado Estructurado:: 
* Protocolos y soporte de Internet:: 
* Servicios Multimedia:: 
* Internacionalización:: 
* Frameworks de programa:: 
* Interfaces gráficas de usuario con Tk:: 
* Herramientas de desarrollo:: 
* Depuración y perfilado:: 
* Empaquetado y distribución de software:: 
* Servicios en tiempo de ejecución de Python:: 
* Intérpretes de Python personalizados:: 
* Importando módulos:: 
* Servicios del lenguaje Python:: 
* Servicios Específicos para MS Windows:: 
* Servicios específicos de Unix:: 
* Modules command-line interface (CLI): Modules command-line interface CLI. 
* Módulos reemplazados:: 
* Removed Modules:: 
* Consideraciones de seguridad: Consideraciones de seguridad<4>. 

@end menu

@node Introducción<6>,Funciones incorporadas<2>,,La biblioteca estándar de Python
@anchor{library/intro doc}@anchor{214f}@anchor{library/intro introduction}@anchor{2150}@anchor{library/intro library-intro}@anchor{2151}
@section Introducción


La «biblioteca Python» contiene varios tipos de componentes diferentes.

Contiene tipos de datos que normalmente se considerarían parte del «núcleo» de un lenguaje, como números y listas.  Para estos tipos, el núcleo del lenguaje Python define la forma de los literales y coloca algunas restricciones a su semántica, pero no define completamente la semántica.  (Por otro lado, el núcleo del lenguaje sí define propiedades sintácticas como la ortografía y las prioridades de los operadores.)

La biblioteca también contiene funciones y excepciones incorporadas — objetos que pueden ser utilizados por todo código Python sin la necesidad de una declaración @ref{682,,import}. Algunas de ellos están definidas por el núcleo del lenguaje, pero muchos no son esenciales para la semántica del núcleo y sólo se describen aquí.

La mayor parte de la biblioteca, sin embargo, consiste en una colección de módulos. Hay muchas maneras de diseccionar esta colección.  Algunos módulos están escritos en C y fueron incorporados en el intérprete de Python; otros están escritos en Python y se importan en código fuente.  Algunos módulos proporcionan interfaces muy específicas de Python, como la impresión de un `stack trace'; otros proporcionan interfaces que son específicas para determinados sistemas operativos, como el acceso a hardware específico; otros proveen interfaces específicas para un dominio de aplicación concreto, como la World Wide Web. Algunos módulos están disponibles en todas las versiones y plataformas de Python; otros sólo están disponibles cuando el sistema subyacente los soporta o los requiere; otros solo están disponibles cuando se ha elegido una opción de configuración particular en el momento en que compiló e instaló Python.

Este manual está organizado «desde adentro hacia afuera:» primero describe las funciones integradas, los tipos de datos y las excepciones, y finalmente describe los módulos, agrupados en capítulos de módulos relacionados.

Esto significa que si comienza a leer este manual desde el principio, y salta al siguiente capítulo cuando se aburra, obtendrá una visión general razonable de los módulos y áreas de aplicación disponibles que son soportados por la biblioteca de Python.  Por supuesto, no `tienes' que leerlo necesariamente como una novela — sino que también puedes navegar por la tabla de contenidos (al principio del manual), o buscar una función, módulo o término específico en el glosario (en la parte final del manual).  Y por último, si disfruta aprender sobre diferentes temas de manera aleatoria, puede escoger un número de página al azar (ver módulo @ref{b8,,random}) y leer una o dos secciones.  Independientemente del orden en que lea las secciones de este manual, es útil comenzar con el capítulo @ref{12ca,,Funciones incorporadas}, ya que el resto del manual asume la familiaridad con este material.

¡Que comience el espectáculo!

@menu
* Notas sobre la disponibilidad:: 

@end menu

@node Notas sobre la disponibilidad,,,Introducción<6>
@anchor{library/intro availability}@anchor{1d5a}@anchor{library/intro notes-on-availability}@anchor{2152}
@subsection Notas sobre la disponibilidad



@itemize *

@item 
Una nota de «Disponibilidad: Unix» significa que esta función se encuentra comúnmente en los sistemas Unix.  Pero no hace ninguna afirmación sobre su existencia en un sistema operativo específico.

@item 
If not separately noted, all functions that claim «Availability: Unix» are
supported on macOS, iOS and Android, all of which build on a Unix core.

@item 
Si una nota de disponibilidad contiene tanto una versión mínima del Kernel como una versión mínima de libc, entonces ambas condiciones deben cumplirse. Por ejemplo, una característica con la nota `Availability: Linux >= 3.17 with glibc >= 2.27' requiere tanto Linux 3.17 o posterior como glibc 2.27 o posterior.
@end itemize

@menu
* Plataformas WebAssembly:: 
* Mobile platforms:: 

@end menu

@node Plataformas WebAssembly,Mobile platforms,,Notas sobre la disponibilidad
@anchor{library/intro wasm-availability}@anchor{17e8}@anchor{library/intro webassembly-platforms}@anchor{2153}
@subsubsection Plataformas WebAssembly


Las plataformas WebAssembly@footnote{https://webassembly.org/} @code{wasm32-emscripten} (Emscripten@footnote{https://emscripten.org/}) y @code{wasm32-wasi} (WASI@footnote{https://wasi.dev/}) proporcionan un subconjunto de APIs POSIX. Los tiempos de ejecución de WebAssembly y los navegadores están aislados y tienen acceso limitado al host y a los recursos externos. Cualquier módulo de la biblioteca estándar de Python que utilice procesos, hilos, redes, señales u otras formas de comunicación entre procesos (IPC), no está disponible o puede no funcionar como en otros sistemas tipo Unix. La E/S de archivos, el sistema de archivos y las funciones relacionadas con permisos Unix también están restringidas. Emscripten no permite el bloqueo de E/S. Otras operaciones bloqueantes como @ref{73e,,sleep()} bloquean el bucle de eventos del navegador.

Las propiedades y el comportamiento de Python en plataformas WebAssembly dependen de la versión del SDK Emscripten@footnote{https://emscripten.org/} o del SDK WASI@footnote{https://wasi.dev/}, de los tiempos de ejecución WASM (navegador, NodeJS, wasmtime@footnote{https://wasmtime.dev/}) y de los indicadores de tiempo de compilación de Python. WebAssembly, Emscripten, y WASI son estándares en evolución; algunas características como las redes pueden ser soportadas en el futuro.

Para Python en el navegador, los usuarios deberían considerar Pyodide@footnote{https://pyodide.org/} o PyScript@footnote{https://pyscript.net/}. PyScript está construido sobre Pyodide, que a su vez está construido sobre CPython y Emscripten. Pyodide proporciona acceso a las APIs JavaScript y DOM de los navegadores, así como capacidades de red limitadas con las APIs @code{XMLHttpRequest} y @code{Fetch} de JavaScript.


@itemize *

@item 
Las APIs relacionadas con procesos no están disponibles o siempre fallan con un error. Esto incluye APIs que generan nuevos procesos (@ref{2ff,,fork()}, @ref{116b,,execve()}), esperan procesos (@ref{e20,,waitpid()}), envían señales (@ref{13c7,,kill()}), o interactúan con procesos. El @ref{d6,,subprocess} se puede importar pero no funciona.

@item 
El módulo @ref{cc,,socket} está disponible, pero es limitado y se comporta de forma diferente a otras plataformas. En Emscripten, los sockets son siempre no bloqueantes y requieren código JavaScript adicional y auxiliares en el servidor para proxy TCP a través de WebSockets; ver Emscripten Networking@footnote{https://emscripten.org/docs/porting/networking.html} para más información. Vista previa de instantánea WASI  1 permite sólo sockets desde un descriptor de fichero existente.

@item 
Algunas funciones son stubs que no hacen nada y siempre devuelven valores codificados.

@item 
Las funciones relacionadas con descriptores de archivos, permisos de archivos, propiedad de archivos y enlaces son limitadas y no admiten algunas operaciones. Por ejemplo, WASI no permite enlaces simbólicos con nombres de archivo absolutos.
@end itemize
@anchor{library/intro mobile-availability}@anchor{1e5b}
@node Mobile platforms,,Plataformas WebAssembly,Notas sobre la disponibilidad
@anchor{library/intro ios-availability}@anchor{2154}@anchor{library/intro mobile-platforms}@anchor{2155}
@subsubsection Mobile platforms


Android and iOS are, in most respects, POSIX operating systems. File I/O, socket handling,
and threading all behave as they would on any POSIX operating system. However,
there are several major differences:


@itemize *

@item 
Mobile platforms can only use Python in «embedded» mode. There is no Python
REPL, and no ability to use separate executables such as @code{python} or
@code{pip}. To add Python code to your mobile app, you must use
the @ref{1e5a,,Python embedding API}. For more details, see
@ref{1e58,,Using Python on Android} and @ref{1e5e,,Using Python on iOS}.

@item 
Subprocesses:


@itemize *

@item 
On Android, creating subprocesses is possible but officially unsupported@footnote{https://issuetracker.google.com/issues/128554619#comment4}.
In particular, Android does not support any part of the System V IPC API,
so @ref{94,,multiprocessing} is not available.

@item 
An iOS app cannot use any form of subprocessing, multiprocessing, or
inter-process communication. If an iOS app attempts to create a subprocess,
the process creating the subprocess will either lock up, or crash. An iOS app
has no visibility of other applications that are running, nor any ability to
communicate with other running applications, outside of the iOS-specific APIs
that exist for this purpose.
@end itemize

@item 
Mobile apps have limited access to modify system resources (such as the system
clock). These resources will often be `readable', but attempts to modify
those resources will usually fail.

@item 
Console input and output:


@itemize *

@item 
On Android, the native @code{stdout} and @code{stderr} are not connected to
anything, so Python installs its own streams which redirect messages to the
system log. These can be seen under the tags @code{python.stdout} and
@code{python.stderr} respectively.

@item 
iOS apps have a limited concept of console output. @code{stdout} and
@code{stderr} `exist', and content written to @code{stdout} and @code{stderr} will be
visible in logs when running in Xcode, but this content `won’t' be recorded
in the system log. If a user who has installed your app provides their app
logs as a diagnostic aid, they will not include any detail written to
@code{stdout} or @code{stderr}.

@item 
Mobile apps have no usable @code{stdin} at all. While apps can display an on-screen
keyboard, this is a software feature, not something that is attached to
@code{stdin}.

As a result, Python modules that involve console manipulation (such as
@ref{2c,,curses} and @ref{ba,,readline}) are not available on mobile platforms.
@end itemize
@end itemize

@c XXX document all delegations to __special__ methods

@node Funciones incorporadas<2>,Constantes incorporadas,Introducción<6>,La biblioteca estándar de Python
@anchor{library/functions doc}@anchor{2156}@anchor{library/functions built-in-funcs}@anchor{12ca}@anchor{library/functions built-in-functions}@anchor{2157}
@section Funciones incorporadas


El intérprete de Python tiene una serie de funciones y tipos incluidos en él que están siempre disponibles.  Están listados aquí en orden alfabético.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Funciones incorporadas

@tab

@tab

@tab

@item


@display
`A'@w{ }
@ref{1cab,,abs()}@w{ }
@ref{86c,,aiter()}@w{ }
@ref{1461,,all()}@w{ }
@ref{86d,,anext()}@w{ }
@ref{1460,,any()}@w{ }
@ref{1426,,ascii()}@w{ }
@w{ }
`B'@w{ }
@ref{1314,,bin()}@w{ }
@ref{513,,bool()}@w{ }
@ref{1a6,,breakpoint()}@w{ }
@ref{1ac1,,bytearray()}@w{ }
@ref{1ac0,,bytes()}@w{ }
@w{ }
`C'@w{ }
@ref{1233,,callable()}@w{ }
@ref{167d,,chr()}@w{ }
@ref{2d2,,classmethod()}@w{ }
@ref{2fb,,compile()}@w{ }
@ref{154,,complex()}@w{ }
@w{ }
`D'@w{ }
@ref{2158,,delattr()}@w{ }
@ref{2159,,dict()}@w{ }
@ref{6d3,,dir()}@w{ }
@ref{a33,,divmod()}@w{ }
@w{ }
@end display



@tab


@display
`E'@w{ }
@ref{14bb,,enumerate()}@w{ }
@ref{2eb,,eval()}@w{ }
@ref{2ea,,exec()}@w{ }
@w{ }
`F'@w{ }
@ref{8fb,,filter()}@w{ }
@ref{153,,float()}@w{ }
@ref{6c0,,format()}@w{ }
@ref{215a,,frozenset()}@w{ }
@w{ }
`G'@w{ }
@ref{c59,,getattr()}@w{ }
@ref{186f,,globals()}@w{ }
@w{ }
`H'@w{ }
@ref{579,,hasattr()}@w{ }
@ref{68b,,hash()}@w{ }
@ref{96e,,help()}@w{ }
@ref{1337,,hex()}@w{ }
@w{ }
`I'@w{ }
@ref{1462,,id()}@w{ }
@ref{1340,,input()}@w{ }
@ref{1f0,,int()}@w{ }
@ref{4ef,,isinstance()}@w{ }
@ref{85a,,issubclass()}@w{ }
@ref{86e,,iter()}@w{ }
@end display



@tab


@display
`L'@w{ }
@ref{6cf,,len()}@w{ }
@ref{215b,,list()}@w{ }
@ref{2ae,,locals()}@w{ }
@w{ }
`M'@w{ }
@ref{14c,,map()}@w{ }
@ref{f8c,,max()}@w{ }
@ref{215c,,memoryview()}@w{ }
@ref{f8b,,min()}@w{ }
@w{ }
`N'@w{ }
@ref{86f,,next()}@w{ }
@w{ }
`O'@w{ }
@ref{b18,,object()}@w{ }
@ref{1336,,oct()}@w{ }
@ref{1be,,open()}@w{ }
@ref{1eef,,ord()}@w{ }
@w{ }
`P'@w{ }
@ref{a64,,pow()}@w{ }
@ref{ff4,,print()}@w{ }
@ref{2fd,,property()}@w{ }
@w{ }
@w{ }
@w{ }
@w{ }
@end display



@tab


@display
`R'@w{ }
@ref{215d,,range()}@w{ }
@ref{894,,repr()}@w{ }
@ref{8fc,,reversed()}@w{ }
@ref{1342,,round()}@w{ }
@w{ }
`S'@w{ }
@ref{215e,,set()}@w{ }
@ref{215f,,setattr()}@w{ }
@ref{514,,slice()}@w{ }
@ref{c56,,sorted()}@w{ }
@ref{22e,,staticmethod()}@w{ }
@ref{2160,,str()}@w{ }
@ref{515,,sum()}@w{ }
@ref{155,,super()}@w{ }
@w{ }
`T'@w{ }
@ref{2161,,tuple()}@w{ }
@ref{dcf,,type()}@w{ }
@w{ }
`V'@w{ }
@ref{1a49,,vars()}@w{ }
@w{ }
`Z'@w{ }
@ref{14d,,zip()}@w{ }
@w{ }
`_'@w{ }
@ref{96b,,__import__()}@w{ }
@end display



@end multitable


@c using :func:`dict` would create a link to another page, so local targets are
@c used, with replacement texts to make the output in the table consistent

@geindex built-in function; abs()
@anchor{library/functions abs}@anchor{1cab}
@deffn {Función} abs (x)

Return the absolute value of a number.  The argument may be an
integer, a floating-point number, or an object implementing
@ref{1fb7,,__abs__()}.
If the argument is a complex number, its magnitude is returned.
@end deffn

@geindex built-in function; aiter()
@anchor{library/functions aiter}@anchor{86c}
@deffn {Función} aiter (async_iterable)

Retorna un @ref{312,,asynchronous iterator} para un @ref{dfd,,asynchronous iterable}. Equivalente a llamar @code{x.__aiter__()}.

Nota: A diferencia de @ref{86e,,iter()}, @ref{86c,,aiter()} no tiene una variante con 2 argumentos.


Added in version 3.10.

@end deffn

@geindex built-in function; all()
@anchor{library/functions all}@anchor{1461}
@deffn {Función} all (iterable)

Retorna  @code{True}  si todos los elementos del `iterable' son verdaderos (o si el iterable está vacío). Equivalente a:

@example
def all(iterable):
    for element in iterable:
        if not element:
            return False
    return True
@end example
@end deffn

@geindex built-in function; anext()
@anchor{library/functions anext}@anchor{86d}
@deffn {Función} awaitable anext (async_iterator)

@deffnx {Función} awaitable anext (async_iterator, default)

Cuando está esperado, retorna el siguiente elemento del @ref{312,,asynchronous iterator} otorgado, o `default' (por defecto) si se da y el iterador está agotado.

Esta es la variante asincrónica del @ref{86f,,next()} incorporado, y se comporta de manera similar.

Esto llama al método @ref{1f09,,__anext__()} de `async_iterator', retornando un @ref{314,,awaitable}. A la espera de esto se retorna el siguiente valor del iterador. Si se otorga `default' (por defecto), se retorna si el iterador está agotado, de lo contrario se lanza @ref{1a34,,StopAsyncIteration}.


Added in version 3.10.

@end deffn

@geindex built-in function; any()
@anchor{library/functions any}@anchor{1460}
@deffn {Función} any (iterable)

Retorna  @code{True} si un elemento cualquiera del `iterable' es verdadero. Si el iterable está vacío, retorna @code{False}. Equivalente a:

@example
def any(iterable):
    for element in iterable:
        if element:
            return True
    return False
@end example
@end deffn

@geindex built-in function; ascii()
@anchor{library/functions ascii}@anchor{1426}
@deffn {Función} ascii (object)

Como @ref{894,,repr()}, retorna una cadena que contiene una representación imprimible de un objeto, pero que escapa los caracteres no ASCII que @ref{894,,repr()} retorna usando @code{\x}, @code{\u} or @code{\U}. Esto genera una cadena similar a la retornada por @ref{894,,repr()} en Python 2.
@end deffn

@geindex built-in function; bin()
@anchor{library/functions bin}@anchor{1314}
@deffn {Función} bin (x)

Convierte un número entero a una cadena binaria con prefijo «0b». El resultado es una expresión de Python válida. Si `x' no es un objeto de clase @ref{1f0,,int} en Python, tiene que definir un método @ref{22b,,__index__()} que retorne un entero. Algunos ejemplos:

@example
>>> bin(3)
'0b11'
>>> bin(-10)
'-0b1010'
@end example

Según se desee o no el prefijo «0b», se puede usar uno u otro de las siguientes maneras.

@example
>>> format(14, '#b'), format(14, 'b')
('0b1110', '1110')
>>> f'@{14:#b@}', f'@{14:b@}'
('0b1110', '1110')
@end example

Véase también @ref{6c0,,format()} para más información.
@end deffn

@geindex bool (clase incorporada)
@anchor{library/functions bool}@anchor{513}
@deffn {Clase} bool (object=False, /)

Return a Boolean value, i.e. one of @code{True} or @code{False}.  The argument
is converted using the standard @ref{2162,,truth testing procedure}.
If the argument is false
or omitted, this returns @code{False}; otherwise, it returns @code{True}.  The
@ref{513,,bool} class is a subclass of @ref{1f0,,int} (see @ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}).
It cannot be subclassed further.  Its only instances are @code{False} and
@code{True} (see @ref{2163,,Boolean Type - bool}).

@geindex Booleano;tipo


Distinto en la versión 3.7: The parameter is now positional-only.

@end deffn

@geindex built-in function; breakpoint()
@anchor{library/functions breakpoint}@anchor{1a6}
@deffn {Función} breakpoint (*args, **kws)

This function drops you into the debugger at the call site.  Specifically,
it calls @ref{b65,,sys.breakpointhook()}, passing @code{args} and @code{kws} straight
through.  By default, @code{sys.breakpointhook()} calls
@ref{1a7,,pdb.set_trace()} expecting no arguments.  In this case, it is
purely a convenience function so you don’t have to explicitly import
@ref{a5,,pdb} or type as much code to enter the debugger.  However,
@ref{b65,,sys.breakpointhook()} can be set to some other function and
@ref{1a6,,breakpoint()} will automatically call that, allowing you to drop into
the debugger of choice.
If @ref{b65,,sys.breakpointhook()} is not accessible, this function will
raise @ref{1e5,,RuntimeError}.

Por defecto, el comportamiento de @ref{1a6,,breakpoint()} se puede cambiar con la variable de entorno 
@geindex PYTHONBREAKPOINT
@geindex variables de entorno; PYTHONBREAKPOINT
@ref{b66,,PYTHONBREAKPOINT}. Véase @ref{b65,,sys.breakpointhook()} para obtener detalles de uso.

Tenga en cuenta que esto no está garantizado si se ha reemplazado @ref{b65,,sys.breakpointhook()}.

Lanza un @ref{18c3,,evento de auditoría} @code{builtins.breakpoint} con @code{breakpointhook} como argumento.


Added in version 3.7.

@end deffn

@anchor{library/functions func-bytearray}@anchor{1ac1}
@deffn {Clase} bytearray (source=b'@w{'})

@deffnx {Clase} bytearray (source, encoding)

@deffnx {Clase} bytearray (source, encoding, errors)

Retorna un nuevo array de bytes. La clase  @ref{5e0,,bytearray} es una secuencia mutable de enteros en el rango 0 <= x < 256. Tiene la mayoría de los métodos comunes en las secuencias mutables, descritos en @ref{2164,,Tipos de secuencia mutables}, así como la mayoría de los métodos que la clase @ref{325,,bytes} tiene, véase @ref{2165,,Operaciones de bytes y bytearray}.

El parámetro opcional `source' puede ser empleado para inicializar el vector (`array') de varias maneras distintas:


@itemize *

@item 
Si es una `string', debes proporcionar también el parámetro `encoding' (y opcionalmente, `errors'; entonces @ref{5e0,,bytearray()} convierte la cadena a bytes empleando @ref{96c,,str.encode()}.

@item 
Si es un `integer', el array tendrá ese tamaño y será inicializado con bytes nulos.

@item 
Si es un objeto conforme a @ref{48a,,interfaz de búfer}, se utilizará un búfer de solo lectura del objeto para inicializar el arreglo de bytes.

@item 
Si es un `iterable', debe ser un iterable de enteros en el rango @code{0 <= x < 256}, que son usados como los contenidos iniciales del array.
@end itemize

Sin argumento, se crea un array de tamaño 0.

Ver también: @ref{2166,,Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview} y @ref{2167,,Objetos de tipo Bytearray}.
@end deffn

@anchor{library/functions func-bytes}@anchor{1ac0}
@deffn {Clase} bytes (source=b'@w{'})

@deffnx {Clase} bytes (source, encoding)

@deffnx {Clase} bytes (source, encoding, errors)

Retorna un nuevo objeto «bytes», que es una secuencia inmutable de enteros en el rango @code{0 <= x < 256}. @ref{325,,bytes} es una versión inmutable de @ref{5e0,,bytearray} – tiene los mismos métodos no mutables y el mismo comportamiento en términos de indexación y segmentación.

En consecuencia, los argumentos del constructor son interpretados como los de @ref{5e0,,bytearray()}.

Los objetos de bytes también pueden ser creados con literales, ver @ref{1ea4,,Literales de cadenas y bytes}.

Ver también @ref{2166,,Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview}, @ref{2168,,Objetos de tipo Bytes}, y @ref{2165,,Operaciones de bytes y bytearray}.
@end deffn

@geindex built-in function; callable()
@anchor{library/functions callable}@anchor{1233}
@deffn {Función} callable (object)

Return @ref{c95,,True} if the `object' argument appears callable,
@ref{bbf,,False} if not.  If this returns @code{True}, it is still possible that a
call fails, but if it is @code{False}, calling `object' will never succeed.
Note that classes are callable (calling a class returns a new instance);
instances are callable if their class has a @ref{5fb,,__call__()} method.


Added in version 3.2: Está función fue eliminada en Python 3.0 pero traída de vuelta en Python 3.2.

@end deffn

@geindex built-in function; chr()
@anchor{library/functions chr}@anchor{167d}
@deffn {Función} chr (i)

Retorna la cadena que representa un carácter cuyo código Unicode es el entero `i'. Por ejemplo, @code{chr(97)} retorna la cadena @code{’a’}, mientras que @code{chr(8364)} retorna la cadena @code{’€’}. Esta función es la inversa de @ref{1eef,,ord()}.

El rango válido para el argumento `i' es desde 0 a 1,114,111 (0x10FFFF en base 16). Se lanzará una excepción @ref{360,,ValueError} si `i' está fuera de ese rango.
@end deffn

@geindex built-in function; classmethod()
@anchor{library/functions classmethod}@anchor{2d2}
@deffn {Función} @@classmethod

Transforma un método en un método de clase.

Un método de clase recibe la clase como primer argumento implícito, de la misma forma que un método de instancia recibe la instancia. Para declarar un método de clase, emplea la siguiente expresión:

@example
class C:
    @@classmethod
    def f(cls, arg1, arg2): ...
@end example

La forma @code{@@classmethod} es una función @ref{7cd,,decorator} — ver @ref{1c3d,,Definiciones de funciones} para más detalles.

Un método de clase puede ser llamado en la clase (como @code{C.f()}) o en la instancia (como @code{C().f()}). La instancia es ignorada salvo por su clase. Si un método de clase es llamado desde una clase derivada, entonces el objeto de la clase derivada se pasa como primer argumento implícito.

Los métodos de clase son diferentes a los métodos estáticos de C++ o Java. Si los desea, consulte @ref{22e,,staticmethod()} en esta sección. Para obtener más información sobre los métodos de clase, consulte @ref{1ee4,,Jerarquía de tipos estándar}.


Distinto en la versión 3.9: Los métodos de clase ahora pueden envolver otros @ref{1f70,,descriptores} como @ref{2fd,,property()}.



Distinto en la versión 3.10: Class methods now inherit the method attributes
(@ref{1efb,,__module__}, @ref{133c,,__name__},
@ref{1efa,,__qualname__}, @ref{1246,,__doc__} and
@ref{1245,,__annotations__}) and have a new @code{__wrapped__}
attribute.



Deprecated since version 3.11, removed in version 3.13: Los métodos de clase ya no pueden envolver otros @ref{1f70,,descriptores} como @ref{2fd,,property()}.

@end deffn

@geindex built-in function; compile()
@anchor{library/functions compile}@anchor{2fb}
@deffn {Función} compile (source, filename, mode, flags=0, dont_inherit=False, optimize=-1)

Compila el `source' en código o en un objeto AST (`Abstract Syntax Tree', árbol de sintaxis abstracta). Los objetos código pueden ser ejecutados por las funciones @ref{2ea,,exec()} or @ref{2eb,,eval()}. `source' puede ser una cadena normal, una cadena de bytes o un objeto AST. Para más información sobre cómo trabajar con objetos AST, revisa la documentación del módulo @ref{9,,ast}.

El argumento `filename' debería dar el fichero desde el que el código fue leído; pasará un valor reconocible en caso este no fuera leído de un fichero  (@code{’<string>’} es usado comúnmente para esto).

El argumento `mode' especifica que tipo de código debe ser compilado; puede ser  @code{’exec’} si `source' consiste en una secuencia de declaraciones, @code{’eval’} si consiste de una expresión sencilla, o @code{’single’} si consiste en una declaración única interactiva (en este último caso, las declaraciones de expresiones que evalúen a algo distinto de @code{None} serán impresas).

Los argumentos opcionales `flags' y `dont_inherit' controlan qué @ref{2169,,opciones del compilador} deben activarse y cuáles @ref{2f4,,características futuras} deben permitirse. Si ninguno está presente (o ambos son cero), el código se compila con los mismos flags que afectan al código que llama @ref{2fb,,compile()}. Si se proporciona el argumento `flags' y `dont_inherit' no es (o es cero), las opciones del compilador y las declaraciones futuras especificadas por el argumento `flags' se utilizan además de las que se utilizarían de todos modos. Si `dont_inherit' es un número entero distinto de cero, entonces el argumento `flags' lo es: los indicadores (características futuras y opciones del compilador) en el código circundante se ignoran.

Las opciones del compilador y las declaraciones futuras se especifican mediante bits que pueden combinarse mediante OR bit a bit para especificar varias opciones. El campo de bits requerido para especificar una característica futura dada se puede encontrar como el atributo @ref{216a,,compiler_flag} en la instancia @ref{216b,,_Feature} en el módulo @ref{0,,__future__}. @ref{2169,,Las flags del compilador} se pueden encontrar en el módulo @ref{9,,ast}, con el prefijo @code{PyCF_}.

El argumento `optimize' especifica el nivel de optimización del compilador; el valor por defecto de @code{-1} selecciona el nivel de optimización del intérprete de la misma forma que las opciones @ref{14f,,-O}. Los niveles explícitos son @code{0} (sin optimización; @code{__debug__} es true), @code{1} (se eliminan los asserts, @code{__debug__} es false) or @code{2} (las `docstrings' también son eliminadas).

Esta función lanza un @ref{150,,SyntaxError} si el código compilado es inválido, y un @ref{360,,ValueError}  si contiene bytes nulos.

Si quieres transformar código Python a su representación AST, revisa @ref{30f,,ast.parse()}.

Lanza un @ref{18c3,,evento de auditoría} @code{compile} con argumentos @code{source} y @code{filename}. Este evento también puede ser lanzado por la compilación implícita.

@cartouche
@quotation Nota 
Cuando se compile una cadena multilínea de código en los modos @code{’single’} o @code{’eval’}, la entrada debe terminar con un carácter de nueva línea como mínimo. Esto facilita la detección de declaraciones completas e incompletas en el módulo @ref{1b,,code}.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Con una cadena lo suficientemente larga o compleja, al compilar a un objeto AST es posible que el intérprete de Python pare inesperadamente debido a las limitaciones de la profundidad de la pila en el compilador del AST de Python.
@end quotation
@end cartouche


Distinto en la versión 3.2: Permite el uso de caracteres de nueva línea de Windows y Mac. También, la entrada en el modo @code{’exec’} ya no tiene que terminar necesariamente en una nueva línea. Se añade el parámetro `optimize'.



Distinto en la versión 3.5: Anteriormente, un @ref{228,,TypeError} era lanzado cuando se encontraban bytes nulos en `source'.



Added in version 3.8: @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT}  puede ahora ser pasado en `flags' para permitir el soporte de @code{await}, @code{async for}, y @code{async with} en niveles superiores.

@end deffn

@geindex complex (clase incorporada)
@anchor{library/functions complex}@anchor{154}
@deffn {Clase} complex (number=0, /)

@deffnx {Clase} complex (string, /)

@deffnx {Clase} complex (real=0, imag=0)

Convert a single string or number to a complex number, or create a
complex number from real and imaginary parts.

Examples:

@example
>>> complex('+1.23')
(1.23+0j)
>>> complex('-4.5j')
-4.5j
>>> complex('-1.23+4.5j')
(-1.23+4.5j)
>>> complex('\t( -1.23+4.5J )\n')
(-1.23+4.5j)
>>> complex('-Infinity+NaNj')
(-inf+nanj)
>>> complex(1.23)
(1.23+0j)
>>> complex(imag=-4.5)
-4.5j
>>> complex(-1.23, 4.5)
(-1.23+4.5j)
@end example

If the argument is a string, it must contain either a real part (in the
same format as for @ref{153,,float()}) or an imaginary part (in the same
format but with a @code{'j'} or @code{'J'} suffix), or both real and imaginary
parts (the sign of the imaginary part is mandatory in this case).
The string can optionally be surrounded by whitespaces and the round
parentheses @code{'('} and @code{')'}, which are ignored.
The string must not contain whitespace between @code{'+'}, @code{'-'}, the
@code{'j'} or @code{'J'} suffix, and the decimal number.
For example, @code{complex('1+2j')} is fine, but @code{complex('1 + 2j')} raises
@ref{360,,ValueError}.
More precisely, the input must conform to the @ref{216c,,complexvalue}
production rule in the following grammar, after parentheses and leading and
trailing whitespace characters are removed:

@example
@anchor{library/functions grammar-token-float-complexvalue}@anchor{216c}complexvalue ::= floatvalue |
                 floatvalue ("j" | "J") |
                 floatvalue sign absfloatvalue ("j" | "J")
@end example

If the argument is a number, the constructor serves as a numeric
conversion like @ref{1f0,,int} and @ref{153,,float}.
For a general Python object @code{x}, @code{complex(x)} delegates to
@code{x.__complex__()}.
If @ref{687,,__complex__()} is not defined then it falls back
to @ref{a5e,,__float__()}.
If @code{__float__()} is not defined then it falls back
to @ref{22b,,__index__()}.

If two arguments are provided or keyword arguments are used, each argument
may be any numeric type (including complex).
If both arguments are real numbers, return a complex number with the real
component `real' and the imaginary component `imag'.
If both arguments are complex numbers, return a complex number with the real
component @code{real.real-imag.imag} and the imaginary component
@code{real.imag+imag.real}.
If one of arguments is a real number, only its real component is used in
the above expressions.

See also @ref{152,,complex.from_number()} which only accepts a single numeric argument.

If all arguments are omitted, returns @code{0j}.

El tipo complejo está descrito en @ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}.


Distinto en la versión 3.6: Agrupar dígitos con guiones bajos como en los literales de código está permitido.



Distinto en la versión 3.8: Recurre a @ref{22b,,__index__()} si @ref{687,,__complex__()} y @ref{a5e,,__float__()} no están definidos.



Obsoleto desde la versión 3.14: Passing a complex number as the `real' or `imag' argument is now
deprecated; it should only be passed as a single positional argument.

@end deffn

@geindex built-in function; delattr()
@anchor{library/functions delattr}@anchor{2158}
@deffn {Función} delattr (object, name)

Esta función es relativa a @ref{215f,,setattr()}. Los argumentos son un objeto y una cadena. La cadena debe ser el mismo nombre que alguno de los atributos del objeto. La función elimina el atributo nombrado, si es que el objeto lo permite. Por ejemplo @code{delattr(x, ‘foobar’)} es equivalente a @code{del x.foobar}. `name' necesita no ser un identificador Python (ver @ref{215f,,setattr()}).
@end deffn

@anchor{library/functions func-dict}@anchor{2159}
@deffn {Clase} dict (**kwarg)

@deffnx {Clase} dict (mapping, **kwarg)

@deffnx {Clase} dict (iterable, **kwarg)

Crea un nuevo diccionario. El objeto @ref{190,,dict} es la clase diccionario. Véase @ref{190,,dict}  y @ref{b51,,Tipos mapa — dict} para más información sobre esta clase.

Para otros contenedores véase las clases incorporadas (`built-in') @ref{18e,,list}, @ref{67a,,set}, y @ref{464,,tuple}, así como el módulo @ref{1e,,collections}.
@end deffn

@geindex built-in function; dir()
@anchor{library/functions dir}@anchor{6d3}
@deffn {Función} dir ()

@deffnx {Función} dir (object)

Sin argumentos, retorna la lista de nombres en el ámbito local. Con un argumento, intenta retornar una lista de atributos válidos para ese objeto.

If the object has a method named @ref{1f66,,__dir__()},
this method will be called and
must return the list of attributes. This allows objects that implement a custom
@ref{57a,,__getattr__()} or @ref{c5a,,__getattribute__()} function
to customize the way
@ref{6d3,,dir()} reports their attributes.

If the object does not provide @ref{1f66,,__dir__()},
the function tries its best to gather information from the object’s
@ref{5fe,,__dict__} attribute, if defined, and
from its type object.  The resulting list is not necessarily complete and may
be inaccurate when the object has a custom @ref{57a,,__getattr__()}.

El mecanismo por defecto de @ref{6d3,,dir()}  se comporta de forma distinta con diferentes tipos de objeto, ya que intenta producir la información más relevante en vez de la más completa:


@itemize *

@item 
Si el objeto es un módulo, la lista contiene los nombres de los atributos del módulo.

@item 
Si el objeto es un tipo o una clase, la lista contiene los nombres de sus atributos, y recursivamente la de los atributos de sus clases base.

@item 
En cualquier otro caso, la lista contiene los nombres de los atributos del objeto, los nombres de los atributos de su clase, y recursivamente los atributos de sus clases base.
@end itemize

La lista resultante está ordenada alfabéticamente. Por ejemplo:

@example
>>> import struct
>>> dir()   # show the names in the module namespace  
['__builtins__', '__name__', 'struct']
>>> dir(struct)   # show the names in the struct module 
['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__',
 '__initializing__', '__loader__', '__name__', '__package__',
 '_clearcache', 'calcsize', 'error', 'pack', 'pack_into',
 'unpack', 'unpack_from']
>>> class Shape:
...     def __dir__(self):
...         return ['area', 'perimeter', 'location']
...
>>> s = Shape()
>>> dir(s)
['area', 'location', 'perimeter']
@end example

@cartouche
@quotation Nota 
Ya que @ref{6d3,,dir()}  se ofrece como una herramienta para uso en una terminal de forma interactiva, intenta ofrecer un grupo interesante de nombres más que un uno rigurosamente definido, y su comportamiento detallado puede cambiar entre versiones. Por ejemplo, los atributos de metaclase no están en la lista resultante cuando el argumento es una clase.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; divmod()
@anchor{library/functions divmod}@anchor{a33}
@deffn {Función} divmod (a, b)

Take two (non-complex) numbers as arguments and return a pair of numbers
consisting of their quotient and remainder when using integer division.  With
mixed operand types, the rules for binary arithmetic operators apply.  For
integers, the result is the same as @code{(a // b, a % b)}. For floating-point
numbers the result is @code{(q, a % b)}, where `q' is usually @code{math.floor(a /
b)} but may be 1 less than that.  In any case @code{q * b + a % b} is very
close to `a', if @code{a % b} is non-zero it has the same sign as `b', and @code{0
<= abs(a % b) < abs(b)}.
@end deffn

@geindex built-in function; enumerate()
@anchor{library/functions enumerate}@anchor{14bb}
@deffn {Función} enumerate (iterable, start=0)

Retorna un objeto enumerador. `iterable' tiene que ser una secuencia, un @ref{313,,iterator}, o algún otro objeto que soporte la iteración. El método @ref{1335,,__next__()} del iterador retornado por la función @ref{14bb,,enumerate()} retorna una tupla que contiene un contador (desde `start', cuyo valor por defecto es 0) y los valores obtenidos al iterar sobre `iterable'.

@example
>>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
>>> list(enumerate(seasons))
[(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')]
>>> list(enumerate(seasons, start=1))
[(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')]
@end example

Equivalente a:

@example
def enumerate(iterable, start=0):
    n = start
    for elem in iterable:
        yield n, elem
        n += 1
@end example
@end deffn

@geindex built-in function; eval()
@anchor{library/functions func-eval}@anchor{216d}@anchor{library/functions eval}@anchor{2eb}
@deffn {Función} eval (source, /, globals=None, locals=None)

@*Parámetros: 

@itemize *

@item 
@code{source} (@ref{237,,str} | @ref{335,,code object}) – A Python expression.

@item 
@code{globals} (@ref{190,,dict} | @code{None}) – The global namespace (default: @code{None}).

@item 
@code{locals} (@ref{1229,,mapping} | @code{None}) – The local namespace (default: @code{None}).
@end itemize


@*Devuelve: 
The result of the evaluated expression.


@*Raises: 
Syntax errors are reported as exceptions.


@cartouche
@quotation Advertencia 
This function executes arbitrary code. Calling it with
user-supplied input may lead to security vulnerabilities.
@end quotation
@end cartouche

The `expression' argument is parsed and evaluated as a Python expression
(technically speaking, a condition list) using the `globals' and `locals'
mappings as global and local namespace.  If the `globals' dictionary is
present and does not contain a value for the key @code{__builtins__}, a
reference to the dictionary of the built-in module @ref{13,,builtins} is
inserted under that key before `expression' is parsed.  That way you can
control what builtins are available to the executed code by inserting your
own @code{__builtins__} dictionary into `globals' before passing it to
@ref{2eb,,eval()}.  If the `locals' mapping is omitted it defaults to the
`globals' dictionary.  If both mappings are omitted, the expression is
executed with the `globals' and `locals' in the environment where
@ref{2eb,,eval()} is called.  Note, `eval()' will only have access to the
@ref{1f3f,,nested scopes} (non-locals) in the enclosing
environment if they are already referenced in the scope that is calling
@ref{2eb,,eval()} (e.g. via a @ref{1313,,nonlocal} statement).

Example:

@example
>>> x = 1
>>> eval('x+1')
2
@end example

Esta función también puede ser utilizada para ejecutar objetos de código arbitrario (como los que crea la función @ref{2fb,,compile()}). En este caso, se pasa un objeto de código en vez de una cadena de caracteres. Si el objeto de código ha sido compilado usando @code{'exec'} como el argumento `mode', el valor que retornará @ref{2eb,,eval()}será @code{None}.

Consejos: la ejecución dinámica de declaraciones está soportada por la función @ref{2ea,,exec()}. Las funciones @ref{186f,,globals()} y @ref{2ae,,locals()} retornan los diccionarios global y local en ese momento, respectivamente, lo cual puede ser útil para su uso en @ref{2eb,,eval()} o @ref{2ea,,exec()}.

Si la fuente dada es una cadena de caracteres, se eliminan los espacios y tabulaciones principales y finales.

Véase @ref{ca0,,ast.literal_eval()}, una función que puede evaluar de forma segura cadenas con expresiones que contienen solo literales.

Lanza un @ref{18c3,,evento de auditoría} @code{exec} con el objeto código como el argumento. También podrían ser lanzados eventos de compilación de código.


Distinto en la versión 3.13: The `globals' and `locals' arguments can now be passed as keywords.



Distinto en la versión 3.13: The semantics of the default `locals' namespace have been adjusted as
described for the @ref{2ae,,locals()} builtin.

@end deffn

@geindex función incorporada;exec

@geindex built-in function; exec()
@anchor{library/functions exec}@anchor{2ea}
@deffn {Función} exec (source, /, globals=None, locals=None, *, closure=None)

@cartouche
@quotation Advertencia 
This function executes arbitrary code. Calling it with
user-supplied input may lead to security vulnerabilities.
@end quotation
@end cartouche

This function supports dynamic execution of Python code. `source' must be
either a string or a code object.  If it is a string, the string is parsed as
a suite of Python statements which is then executed (unless a syntax error
occurs). @footnote{
Ten en cuenta que el `parser' sólo acepta la convención de final de línea de tipo Unix. Si estás leyendo el código de un fichero, asegúrate de usar la el modo de conversión de nueva línea para convertir las líneas de tipo Windows o Mac.
} If it is a code object, it is simply executed.  In all cases,
the code that’s executed is expected to be valid as file input (see the
section @ref{2142,,Entrada de archivo} in the Reference Manual). Be aware that the
@ref{1313,,nonlocal}, @ref{a5f,,yield},  and @ref{a60,,return}
statements may not be used outside of
function definitions even within the context of code passed to the
@ref{2ea,,exec()} function. The return value is @code{None}.

In all cases, if the optional parts are omitted, the code is executed in the
current scope.  If only `globals' is provided, it must be a dictionary
(and not a subclass of dictionary), which
will be used for both the global and the local variables.  If `globals' and
`locals' are given, they are used for the global and local variables,
respectively.  If provided, `locals' can be any mapping object.  Remember
that at the module level, globals and locals are the same dictionary.

@cartouche
@quotation Nota 
When @code{exec} gets two separate objects as `globals' and `locals', the
code will be executed as if it were embedded in a class definition. This
means functions and classes defined in the executed code will not be able
to access variables assigned at the top level (as the «top level»
variables are treated as class variables in a class definition).
@end quotation
@end cartouche

Si el diccionario `globals' no contiene un valor para la clave @code{__builtins__}, una referencia al diccionario del módulo built-in @ref{13,,builtins} se inserta bajo esa clave. De esta forma puedes controlar que `builtins' están disponibles para el código ejecutado insertando tu propio diccionario @code{__builtins__} en `globals' antes de pasárselo a @ref{2ea,,exec()}.

The `closure' argument specifies a closure–a tuple of cellvars.
It’s only valid when the `object' is a code object containing
@ref{1f40,,free (closure) variables}.
The length of the tuple must exactly match the length of the code object’s
@ref{1ef8,,co_freevars} attribute.

Lanza un @ref{18c3,,evento de auditoría} @code{exec} con el objeto código como el argumento. También podrían ser lanzados eventos de compilación de código.

@cartouche
@quotation Nota 
The built-in functions @ref{186f,,globals()} and @ref{2ae,,locals()} return the current
global and local namespace, respectively, which may be useful to pass around
for use as the second and third argument to @ref{2ea,,exec()}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
The default `locals' act as described for function @ref{2ae,,locals()} below.
Pass an explicit `locals' dictionary if you need to see effects of the
code on `locals' after function @ref{2ea,,exec()} returns.
@end quotation
@end cartouche


Distinto en la versión 3.11: Añadido el parámetro `closure'.



Distinto en la versión 3.13: The `globals' and `locals' arguments can now be passed as keywords.



Distinto en la versión 3.13: The semantics of the default `locals' namespace have been adjusted as
described for the @ref{2ae,,locals()} builtin.

@end deffn

@geindex built-in function; filter()
@anchor{library/functions filter}@anchor{8fb}
@deffn {Función} filter (function, iterable)

Construye un iterador a partir de aquellos elementos de `iterable' para los cuales `function' retorna true. `iterable' puede ser una secuencia, un contenedor que soporta iteración, o un iterador. Si `function' es @code{None}, se asume la función identidad, es decir, todos los elementos de `iterable' que son false son eliminados.

Ten en cuenta que @code{filter(function, iterable)} es equivalente a la expresión de un generador @code{(item for item in iterable if function(item))} si `function' no es @code{None} y a @code{(item for item in iterable if item)} si `function' es @code{None}.

Ver @ref{216e,,itertools.filterfalse()} para la función complementaria que retorna los elementos de `iterable' para los cuales `function' retorna false.
@end deffn

@geindex float (clase incorporada)
@anchor{library/functions float}@anchor{153}
@deffn {Clase} float (number=0.0, /)

@deffnx {Clase} float (string, /)

@geindex NaN
@geindex Infinito

Return a floating-point number constructed from a number or a string.

Examples:

@example
>>> float('+1.23')
1.23
>>> float('   -12345\n')
-12345.0
>>> float('1e-003')
0.001
>>> float('+1E6')
1000000.0
>>> float('-Infinity')
-inf
@end example

If the argument is a string, it should contain a decimal number, optionally
preceded by a sign, and optionally embedded in whitespace.  The optional
sign may be @code{'+'} or @code{'-'}; a @code{'+'} sign has no effect on the value
produced.  The argument may also be a string representing a NaN
(not-a-number), or positive or negative infinity.
More precisely, the input must conform to the @ref{216f,,floatvalue}
production rule in the following grammar, after leading and trailing
whitespace characters are removed:

@example
@anchor{library/functions grammar-token-float-sign}@anchor{2170}sign          ::= "+" | "-"
@anchor{library/functions grammar-token-float-infinity}@anchor{2171}infinity      ::= "Infinity" | "inf"
@anchor{library/functions grammar-token-float-nan}@anchor{2172}nan           ::= "nan"
@anchor{library/functions grammar-token-float-digit}@anchor{2173}digit         ::= <a Unicode decimal digit, i.e. characters in Unicode general category Nd>
@anchor{library/functions grammar-token-float-digitpart}@anchor{2174}digitpart     ::= digit (["_"] digit)*
@anchor{library/functions grammar-token-float-number}@anchor{2175}number        ::= [digitpart] "." digitpart | digitpart ["."]
@anchor{library/functions grammar-token-float-exponent}@anchor{2176}exponent      ::= ("e" | "E") [sign] digitpart
@anchor{library/functions grammar-token-float-floatnumber}@anchor{2177}floatnumber   ::= number [exponent]
@anchor{library/functions grammar-token-float-absfloatvalue}@anchor{2178}absfloatvalue ::= floatnumber | infinity | nan
@anchor{library/functions grammar-token-float-floatvalue}@anchor{216f}floatvalue    ::= [sign] absfloatvalue
@end example

Case is not significant, so, for example, «inf», «Inf», «INFINITY», and
«iNfINity» are all acceptable spellings for positive infinity.

Otherwise, if the argument is an integer or a floating-point number, a
floating-point number with the same value (within Python’s floating-point
precision) is returned.  If the argument is outside the range of a Python
float, an @ref{919,,OverflowError} will be raised.

Para el objeto general de Python @code{x}, @code{float(x)} delega a @code{x.__float__()}. Si @ref{a5e,,__float__()} no está definido entonces recurre a @ref{22b,,__index__()}.

See also @ref{151,,float.from_number()} which only accepts a numeric argument.

Si no se le da un argumento, retorna @code{0.0}.

El tipo float está descrito en @ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}.


Distinto en la versión 3.6: Agrupar dígitos con guiones bajos como en los literales de código está permitido.



Distinto en la versión 3.7: The parameter is now positional-only.



Distinto en la versión 3.8: Recurre a @ref{22b,,__index__()} si @ref{a5e,,__float__()} no está definido.

@end deffn

@geindex __format__
@geindex string;format() (función incorporada)

@geindex built-in function; format()
@anchor{library/functions format}@anchor{6c0}
@deffn {Función} format (value, format_spec='@w{'})

Convierte `value' a su representación «con formato», de forma controlada por `format_spec'. La interpretación de `format_spec' dependerá del tipo del argumento `value'. Sin embargo, hay una sintaxis estándar de formato que emplean la mayoría de los tipos incorporados: @ref{347,,Especificación de formato Mini-Lenguaje}.

El `format_spec' por defecto es una cadena vacía que normalmente produce el mismo efecto que llamar a @ref{237,,str(value)}.

A call to @code{format(value, format_spec)} is translated to
@code{type(value).__format__(value, format_spec)} which bypasses the instance
dictionary when searching for the value’s @ref{6bf,,__format__()} method.
A @ref{228,,TypeError} exception is raised if the method search reaches
@ref{b18,,object} and the `format_spec' is non-empty, or if either the
`format_spec' or the return value are not strings.


Distinto en la versión 3.4: @code{object().__format__(format_spec)} lanza @ref{228,,TypeError} si `format_spec' no es una cadena vacía.

@end deffn

@anchor{library/functions func-frozenset}@anchor{215a}
@deffn {Clase} frozenset (iterable=set())

Retorna un nuevo objeto @ref{67b,,frozenset} , opcionalmente con elementos tomados de  `iterable'.  @code{frozenset} es una clase built-in.  Ver @ref{67b,,frozenset} y @ref{2179,,Conjuntos — set@comma{} frozenset} para documentación sobre esta clase.

Para otro tipo de contenedores, ver las clases built-in  @ref{67a,,set}, @ref{18e,,list}, @ref{464,,tuple}, y @ref{190,,dict}, así como el módulo @ref{1e,,collections}.
@end deffn

@geindex built-in function; getattr()
@anchor{library/functions getattr}@anchor{c59}
@deffn {Función} getattr (object, name)

@deffnx {Función} getattr (object, name, default)

Retorna el valor del atributo nombrado de `object'. `name' debe ser una cadena. Si la cadena es el nombre de uno de los atributos del objeto, el resultado es el valor de ese atributo. Por ejemplo, @code{getattr(x, ‘foobar’)} es equivalente a @code{x.foobar}. Si el atributo nombrado no existe, se retorna `default' si ha sido proporcionado como argumento, y sino se lanza una excepción @ref{441,,AttributeError}. `name' no necesita ser un identificador de Python (ver @ref{215f,,setattr()}).

@cartouche
@quotation Nota 
Dado que @ref{1cc1,,private name mangling} ocurre en el momento de la compilación, uno debe enredar manualmente el nombre de un atributo privado (atributos con dos guiones bajos principales) para recuperarlo con @ref{c59,,getattr()}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; globals()
@anchor{library/functions globals}@anchor{186f}
@deffn {Función} globals ()

Retorna un diccionario que implementa el espacio de nombres del módulo actual. Para el código dentro de las funciones, esto se establece cuando se define la función y permanece igual independientemente de dónde se llame a la función.
@end deffn

@geindex built-in function; hasattr()
@anchor{library/functions hasattr}@anchor{579}
@deffn {Función} hasattr (object, name)

Los argumentos son un objeto y una cadena. El resultado es @code{True}  si la cadena es el nombre de uno de los atributos del objeto, y @code{False} en caso contrario. (Está implementado mediante una llamada a @code{getattr(object, name)} que comprueba si se lanza una excepción @ref{441,,AttributeError}  o no).
@end deffn

@geindex built-in function; hash()
@anchor{library/functions hash}@anchor{68b}
@deffn {Función} hash (object)

Retorna el valor hash del objeto (si tiene uno). Los valores hash son enteros. Se usan para comparar de forma rápida claves de diccionarios durante las operaciones de búsqueda. Valores numéricos que son iguales tienen el mismo valor hash (incluso si son de tipos diferentes, como es el caso para 1 y 1.0).

@cartouche
@quotation Nota 
For objects with custom @ref{b86,,__hash__()} methods,
note that @ref{68b,,hash()}
truncates the return value based on the bit width of the host machine.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; help()
@anchor{library/functions help}@anchor{96e}
@deffn {Función} help ()

@deffnx {Función} help (request)

Invoca el sistema de ayuda integrado (built-in). (Esta función está indicada para su uso interactivo). Si no se le da argumento, el sistema interactivo de ayuda se inicia en la consola del intérprete. Si el argumento es una cadena, entonces es buscada como nombre de un módulo, función, clase, método, palabra clave o tema de documentación, y una página de ayuda es impresa en la consola. Si el argumento es cualquier otro tipo de objeto, una página de ayuda sobre el objeto es generada.

Ten en cuenta que si aparece una barra(/) en la lista de parámetros de una función al invocar @ref{96e,,help()}, significa que los parámetros anteriores a la barra son solo posicionales. Para más información, puedes ver @ref{217a,,the FAQ entry on positional-only parameters}.

Esta función se añade al espacio de nombres built-in a través del módulo @ref{c7,,site}.


Distinto en la versión 3.4: Cambios a los módulos @ref{b5,,pydoc} y @ref{7e,,inspect} implican que las signaturas reportadas para objetos invocables son más completas y consistentes.

@end deffn

@geindex built-in function; hex()
@anchor{library/functions hex}@anchor{1337}
@deffn {Función} hex (x)

Convierte un número entero a una cadena hexadecimal de minúsculas con el prefijo «0x». Si `x' no es un objeto de la clase Python @ref{1f0,,int}, tiene que definir un método @ref{22b,,__index__()} que retorne un entero. Algunos ejemplos:

@example
>>> hex(255)
'0xff'
>>> hex(-42)
'-0x2a'
@end example

Si quieres convertir un número entero a una cadena hexadecimal de mayúsculas o minúsculas con prefijo o sin el, puedes usar cualquiera de las siguientes formas:

@example
>>> '%#x' % 255, '%x' % 255, '%X' % 255
('0xff', 'ff', 'FF')
>>> format(255, '#x'), format(255, 'x'), format(255, 'X')
('0xff', 'ff', 'FF')
>>> f'@{255:#x@}', f'@{255:x@}', f'@{255:X@}'
('0xff', 'ff', 'FF')
@end example

Véase también @ref{6c0,,format()} para más información.

Ver también @ref{1f0,,int()} para convertir una cadena hexadecimal a un entero usando una base de 16.

@cartouche
@quotation Nota 
Para obtener una cadena hexadecimal que represente un punto flotante, utiliza el método @ref{1d19,,float.hex()}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; id()
@anchor{library/functions id}@anchor{1462}
@deffn {Función} id (object)

Retorna la «identidad» de un objeto. Esto es un entero que está garantizado que es único y constante para este objeto durante toda su existencia. Dos objetos con existencias en el tiempo que no coincidan pueden tener el mismo valor de @ref{1462,,id()}.

`Detalles de implementación de CPython:' Esta es la dirección del objeto en memoria.

Lanza un @ref{18c3,,evento de auditoría} @code{builtins.id} con el argumento @code{id}.
@end deffn

@geindex built-in function; input()
@anchor{library/functions input}@anchor{1340}
@deffn {Función} input ()

@deffnx {Función} input (prompt)

Si el argumento `prompt' está presente, se escribe a la salida estándar sin una nueva línea a continuación. La función lee entonces una línea de la entrada, la convierte en una cadena (eliminando la nueva línea), y retorna eso. Cuando se lee EOF, se lanza una excepción @ref{1341,,EOFError}. Ejemplo:

@example
>>> s = input('--> ')  
--> Monty Python's Flying Circus
>>> s  
"Monty Python's Flying Circus"
@end example

Si el módulo @ref{ba,,readline} estaba cargado, entonces @ref{1340,,input()} lo usará para proporcionar características más elaboradas de edición de líneas e historiales.

Lanza un @ref{18c3,,evento de auditoría} @code{builtins.input} con el argumento @code{prompt} antes de leer entrada

Lanza un @ref{18c3,,evento de auditoría} @code{builtins.input/result} con el resultado justo después de haber leído con éxito la entrada.
@end deffn

@geindex int (clase incorporada)
@anchor{library/functions int}@anchor{1f0}
@deffn {Clase} int (number=0, /)

@deffnx {Clase} int (string, /, base=10)

Return an integer object constructed from a number or a string, or return
@code{0} if no arguments are given.

Examples:

@example
>>> int(123.45)
123
>>> int('123')
123
>>> int('   -12_345\n')
-12345
>>> int('FACE', 16)
64206
>>> int('0xface', 0)
64206
>>> int('01110011', base=2)
115
@end example

If the argument defines @ref{22a,,__int__()},
@code{int(x)} returns @code{x.__int__()}.  If the argument defines
@ref{22b,,__index__()}, it returns @code{x.__index__()}.
For floating-point numbers, this truncates towards zero.

If the argument is not a number or if `base' is given, then it must be a string,
@ref{325,,bytes}, or @ref{5e0,,bytearray} instance representing an integer
in radix `base'.  Optionally, the string can be preceded by @code{+} or @code{-}
(with no space in between), have leading zeros, be surrounded by whitespace,
and have single underscores interspersed between digits.

Una cadena de enteros de base n contiene dígitos, cada uno de los cuales representa un valor de 0 a n-1. Los valores 0–9 se pueden representar por cualquier dígito decimal Unicode. Los valores 10–35 se pueden representar de @code{a} a @code{z} (o de @code{A} a @code{Z}). La `base' predeterminada es 10. Las bases permitidas son 0 y 2–36. Las cadenas de caracteres de base 2, 8 y 16 pueden tener opcionalmente el prefijo @code{0b}/@code{0B}, @code{0o}/@code{0O} o @code{0x}/@code{0X}, como ocurre con los literales enteros en el código. Para base 0, la cadena de caracteres se interpreta de manera similar a un @ref{1ec5,,literal entero en el código}, en el que la base de verdad es 2, 8, 10 o 16 según lo determine el prefijo. La base 0 tampoco permite los ceros a la izquierda: @code{int('010', 0)} no es legal, mientras que @code{int('010')} e @code{int('010', 8)} sí lo son.

El tipo entero se describe en @ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}.


Distinto en la versión 3.4: Si `base' no es una instancia de @ref{1f0,,int} y el objeto `base' tiene un método @ref{22b,,base.__index__}, ese método es llamado para obtener un entero para esa base. En versiones anteriores se empleaba @ref{22a,,base.__int__} en vez de @ref{22b,,base.__index__}.



Distinto en la versión 3.6: Agrupar dígitos con guiones bajos como en los literales de código está permitido.



Distinto en la versión 3.7: The first parameter is now positional-only.



Distinto en la versión 3.8: Recurre a @ref{22b,,__index__()} si no está definido @ref{22a,,__int__()}.



Distinto en la versión 3.11: @ref{1f0,,int} string inputs and string representations can be limited to
help avoid denial of service attacks. A @ref{360,,ValueError} is raised when
the limit is exceeded while converting a string to an @ref{1f0,,int} or
when converting an @ref{1f0,,int} into a string would exceed the limit.
See the @ref{695,,integer string conversion length limitation} documentation.



Distinto en la versión 3.14: @ref{1f0,,int()} no longer delegates to the @ref{229,,__trunc__()} method.

@end deffn

@geindex built-in function; isinstance()
@anchor{library/functions isinstance}@anchor{4ef}
@deffn {Función} isinstance (object, classinfo)

Retorna @code{True} si el argumento `object' es una instancia del argumento `classinfo', o de una subclase (directa, indirecta o @ref{1224,,virtual}) del mismo. Si `object' no es un objeto del tipo indicado, esta función siempre retorna @code{False}.  Si `classinfo' es una tupla de objetos de tipo (o recursivamente, otras tuplas lo son) o @ref{85b,,Tipo de conversión} de múltiples tipos , retorna @code{True} si `object' es una instancia de alguno de los tipos. Si `classinfo' no es un tipo, una tupla de tipos, o una tupla de tuplas de tipos, una excepción @ref{228,,TypeError} es lanzada. Es posible que @ref{228,,TypeError} no se genere para un tipo no válido si una verificación anterior tiene éxito.


Distinto en la versión 3.10: `classinfo' puede ser una @ref{85b,,Tipo de conversión}.

@end deffn

@geindex built-in function; issubclass()
@anchor{library/functions issubclass}@anchor{85a}
@deffn {Función} issubclass (class, classinfo)

Retorna @code{True} si `class' es una subclase (directa, indirecta o @ref{1224,,virtual}) de `classinfo'.  Una clase es considerada una subclase de sí misma.  `classinfo' puede ser una tupla de objetos de clase o una @ref{85b,,Tipo de conversión}, en cuyo caso retorna @code{True} si `class' es una subclase de cualquier entrada en `classinfo'. En cualquier otro caso, se lanzará una excepción @ref{228,,TypeError}.


Distinto en la versión 3.10: `classinfo' puede ser una @ref{85b,,Tipo de conversión}.

@end deffn

@geindex built-in function; iter()
@anchor{library/functions iter}@anchor{86e}
@deffn {Función} iter (object)

@deffnx {Función} iter (object, sentinel)

Return an @ref{313,,iterator} object.  The first argument is interpreted very
differently depending on the presence of the second argument. Without a
second argument, `object' must be a collection object which supports the
@ref{1294,,iterable} protocol (the @ref{1f5b,,__iter__()} method),
or it must support
the sequence protocol (the @ref{3d8,,__getitem__()} method with integer arguments
starting at @code{0}).  If it does not support either of those protocols,
@ref{228,,TypeError} is raised. If the second argument, `sentinel', is given,
then `object' must be a callable object.  The iterator created in this case
will call `object' with no arguments for each call to its
@ref{1335,,__next__()} method; if the value returned is equal to
`sentinel', @ref{c82,,StopIteration} will be raised, otherwise the value will
be returned.

Ver también @ref{217b,,Tipos de iteradores}.

Una aplicación muy útil de la segunda forma de @ref{86e,,iter()} es la construcción de un lector de bloques. Por ejemplo, leer bloques de ancho fijo de una base de datos binaria hasta que el fin del fichero sea alcanzado:

@example
from functools import partial
with open('mydata.db', 'rb') as f:
    for block in iter(partial(f.read, 64), b'@w{'}):
        process_block(block)
@end example
@end deffn

@geindex built-in function; len()
@anchor{library/functions len}@anchor{6cf}
@deffn {Función} len (s)

Retorna el tamaño (el número de elementos) de un objeto. El argumento puede ser una secuencia (como una cadena, un objeto byte, una tupla, lista o rango) o una colección (como un diccionario, un set o un `frozen set').

`Detalles de implementación de CPython:' @code{len} aumenta @ref{919,,OverflowError} en longitudes mayores que @ref{1232,,sys.maxsize}, como @ref{9d6,,range(2 ** 100)}.
@end deffn

@anchor{library/functions func-list}@anchor{215b}
@deffn {Clase} list

@deffnx {Clase} list (iterable)

Más que una función, @ref{18e,,list} es realmente un tipo de secuencia mutable, como está documentado en @ref{217c,,Listas} y @ref{1c50,,Tipos secuencia — list@comma{} tuple@comma{} range}.
@end deffn

@geindex built-in function; locals()
@anchor{library/functions locals}@anchor{2ae}
@deffn {Función} locals ()

@quotation

Return a mapping object representing the current local symbol table, with
variable names as the keys, and their currently bound references as the
values.

At module scope, as well as when using @ref{2ea,,exec()} or @ref{2eb,,eval()} with
a single namespace, this function returns the same namespace as
@ref{186f,,globals()}.

At class scope, it returns the namespace that will be passed to the
metaclass constructor.

When using @code{exec()} or @code{eval()} with separate local and global
arguments, it returns the local namespace passed in to the function call.

In all of the above cases, each call to @code{locals()} in a given frame of
execution will return the `same' mapping object. Changes made through
the mapping object returned from @code{locals()} will be visible as assigned,
reassigned, or deleted local variables, and assigning, reassigning, or
deleting local variables will immediately affect the contents of the
returned mapping object.

In an @ref{2e9,,optimized scope} (including functions, generators, and
coroutines), each call to @code{locals()} instead returns a fresh dictionary
containing the current bindings of the function’s local variables and any
nonlocal cell references. In this case, name binding changes made via the
returned dict are `not' written back to the corresponding local variables
or nonlocal cell references, and assigning, reassigning, or deleting local
variables and nonlocal cell references does `not' affect the contents
of previously returned dictionaries.

Calling @code{locals()} as part of a comprehension in a function, generator, or
coroutine is equivalent to calling it in the containing scope, except that
the comprehension’s initialised iteration variables will be included. In
other scopes, it behaves as if the comprehension were running as a nested
function.

Calling @code{locals()} as part of a generator expression is equivalent to
calling it in a nested generator function.
@end quotation


Distinto en la versión 3.12: The behaviour of @code{locals()} in a comprehension has been updated as
described in 
@geindex Python Enhancement Proposals; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}.



Distinto en la versión 3.13: As part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, the semantics of mutating the mapping objects
returned from this function are now defined. The behavior in
@ref{2e9,,optimized scopes} is now as described above.
Aside from being defined, the behaviour in other scopes remains
unchanged from previous versions.

@end deffn

@geindex built-in function; map()
@anchor{library/functions map}@anchor{14c}
@deffn {Función} map (function, iterable, /, *iterables, strict=False)

Return an iterator that applies `function' to every item of `iterable',
yielding the results.  If additional `iterables' arguments are passed,
`function' must take that many arguments and is applied to the items from all
iterables in parallel.  With multiple iterables, the iterator stops when the
shortest iterable is exhausted.  If `strict' is @code{True} and one of the
iterables is exhausted before the others, a @ref{360,,ValueError} is raised. For
cases where the function inputs are already arranged into argument tuples,
see @ref{1157,,itertools.starmap()}.


Distinto en la versión 3.14: Added the `strict' parameter.

@end deffn

@geindex built-in function; max()
@anchor{library/functions max}@anchor{f8c}
@deffn {Función} max (iterable, *, key=None)

@deffnx {Función} max (iterable, *, default, key=None)

@deffnx {Función} max (arg1, arg2, *args, key=None)

Retorna el elemento mayor en un iterable o el mayor de dos o más argumentos.

Si un argumento posicional es dado, debe ser un @ref{1294,,iterable}.  El elemento mayor en el iterable es retornado. Si dos o más argumentos posicionales son indicados, el mayor de los argumentos posicionales será retornado.

Hay dos argumentos de solo palabra clave que son opcionales. El argumento `key' especifica una función de ordenación de un sólo argumento, como la usada para @ref{c57,,list.sort()}. El argumento `default' especifica un objeto a retornar si el iterable proporcionado está vacío. Si el iterable está vacío y `default' no ha sido indicado, se lanza un @ref{360,,ValueError}.

Si hay múltiples elementos con el valor máximo, la función retorna el primero que ha encontrado.  Esto es consistente con otras herramientas para preservar la estabilidad de la ordenación como @code{sorted(iterable, key=keyfunc, reverse=True)[0]} y @code{heapq.nlargest(1, iterable, key=keyfunc)}.


Distinto en la versión 3.4: Added the `default' keyword-only parameter.



Distinto en la versión 3.8: `key' puede ser @code{None}.

@end deffn

@anchor{library/functions func-memoryview}@anchor{215c}
@deffn {Clase} memoryview (object)

Retorna un objeto `«memory view»' creado a partir del argumento indicado. Para más información ver @ref{217d,,Vistas de memoria}.
@end deffn

@geindex built-in function; min()
@anchor{library/functions min}@anchor{f8b}
@deffn {Función} min (iterable, *, key=None)

@deffnx {Función} min (iterable, *, default, key=None)

@deffnx {Función} min (arg1, arg2, *args, key=None)

Retorna el menor elemento en un iterable o el menor de dos o más argumentos.

Si se le indica un argumento posicional, debe ser un @ref{1294,,iterable}.   El menor elemento del iterable es retornado. Si dos o más argumentos posicionales son indicados, el menor de los argumentos posicionales es retornado.

Hay dos argumentos de solo palabra clave que son opcionales. El argumento `key' especifica una función de ordenación de un sólo argumento, como la usada para @ref{c57,,list.sort()}. El argumento `default' especifica un objeto a retornar si el iterable proporcionado está vacío. Si el iterable está vacío y `default' no ha sido indicado, se lanza un @ref{360,,ValueError}.

Si hay múltiples elementos con el valor mínimo, la función retorna el primero que encuentra. Esto es consistente con otras herramientas que preservan la estabilidad de la ordenación como @code{sorted(iterable, key=keyfunc)[0]} y @code{heapq.nsmallest(1, iterable, key=keyfunc)}.


Distinto en la versión 3.4: Added the `default' keyword-only parameter.



Distinto en la versión 3.8: `key' puede ser @code{None}.

@end deffn

@geindex built-in function; next()
@anchor{library/functions next}@anchor{86f}
@deffn {Función} next (iterator)

@deffnx {Función} next (iterator, default)

Extrae el siguiente elemento de @ref{313,,iterator} llamando a su método @ref{1335,,__next__()}. Si se le indica `default', éste será retornado si se agota el iterador, de lo contrario, se lanza un  @ref{c82,,StopIteration}.
@end deffn

@geindex object (clase incorporada)
@anchor{library/functions object}@anchor{b18}
@deffn {Clase} object

This is the ultimate base class of all other classes. It has methods
that are common to all instances of Python classes. When the constructor
is called, it returns a new featureless object. The constructor does not
accept any arguments.

@cartouche
@quotation Nota 
@ref{b18,,object} instances do `not' have @ref{5fe,,__dict__}
attributes, so you can’t assign arbitrary attributes to an instance of
@ref{b18,,object}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; oct()
@anchor{library/functions oct}@anchor{1336}
@deffn {Función} oct (x)

Convierte un número entero a una cadena octal con prefijo «0o». El resultado es una expresión válida de Python. Si `x' no es un objeto de la clase Python @ref{1f0,,int}, tiene que definir un método @ref{22b,,__index__()} que retorne un entero. Por ejemplo:

@example
>>> oct(8)
'0o10'
>>> oct(-56)
'-0o70'
@end example

Si quieres convertir un número entero a una cadena octal, tanto con prefijo «0o» como sin el, puedes usar cualquiera de las siguientes formas.

@example
>>> '%#o' % 10, '%o' % 10
('0o12', '12')
>>> format(10, '#o'), format(10, 'o')
('0o12', '12')
>>> f'@{10:#o@}', f'@{10:o@}'
('0o12', '12')
@end example

Véase también @ref{6c0,,format()} para más información.
@end deffn

@geindex objeto file;open() función incorporada

@geindex built-in function; open()
@anchor{library/functions open}@anchor{1be}
@deffn {Función} open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Abre `file' y retorna un @ref{1230,,file object} correspondiente. Si el archivo no se puede abrir, se lanza un @ref{4d5,,OSError}. Consulte @ref{1c86,,Leyendo y escribiendo archivos} para obtener más ejemplos de cómo utilizar esta función.

`file' es un @ref{3f0,,path-like object} que da la ruta (absoluta o relativa al directorio de trabajo actual) del fichero a ser abierto o un descriptor de fichero entero del fichero a ser envuelto. (Si un descriptor de fichero es dado, será cerrado cuando el objeto de entrada-salida sea cerrado, a menos que `closefd' esté puesto a @code{False}.)

`mode' is an optional string that specifies the mode in which the file is
opened.  It defaults to @code{'r'} which means open for reading in text mode.
Other common values are @code{'w'} for writing (truncating the file if it
already exists), @code{'x'} for exclusive creation, and @code{'a'} for appending
(which on `some' Unix systems, means that `all' writes append to the end of
the file regardless of the current seek position).  In text mode, if
`encoding' is not specified the encoding used is platform-dependent:
@ref{1d3,,locale.getencoding()} is called to get the current locale encoding.
(For reading and writing raw bytes use binary mode and leave
`encoding' unspecified.)  The available modes are:

@geindex file;modos
@anchor{library/functions filemodes}@anchor{217e}

@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Carácter

@tab

Significado

@item

@code{’r’}

@tab

abierto para lectura (por defecto)

@item

@code{'w'}

@tab

abierto para escritura, truncando primero el fichero

@item

@code{'x'}

@tab

abierto para creación en exclusiva, falla si el fichero ya existe

@item

@code{’a’}

@tab

abierto para escritura, añadiendo al final del fichero si este existe

@item

@code{'b'}

@tab

modo binario

@item

@code{’t’}

@tab

modo texto (por defecto)

@item

@code{’+’}

@tab

abierto para actualizar (lectura y escritura)

@end multitable


El modo por defecto es  @code{’r’}  (abierto para lectura de texto, sinónimo de  @code{’rt’}. Los modos @code{’w+’} y @code{’w+b’} abren y truncan el fichero.  Los modos @code{’r+’} y @code{’r+b’} abren el fichero sin truncarlo.

Como se menciona en @ref{217f,,Resumen}, Python distingue entre I/O binario y de texto. Los ficheros abiertos en modo binario (incluyendo @code{’b’} en el argumento `mode') retornan su contenido como objetos de @ref{325,,bytes}  sin ninguna descodificación. En modo de texto (por defecto, o cuando se incluye  @code{’t’} en el argumento `mode'), los contenidos del fichero se retornan como @ref{237,,str}, tras descodificar los `bytes' usando una codificación dependiente de plataforma o usando el `encoding' especificado como argumento.

@cartouche
@quotation Nota 
Python no depende de la noción de ficheros de texto del sistema operativo subyacente; todo el procesado lo hace Python, y es por tanto independiente de plataforma.
@end quotation
@end cartouche

`buffering' is an optional integer used to set the buffering policy.  Pass 0
to switch buffering off (only allowed in binary mode), 1 to select line
buffering (only usable when writing in text mode), and an integer > 1 to indicate the size
in bytes of a fixed-size chunk buffer. Note that specifying a buffer size this
way applies for binary buffered I/O, but @code{TextIOWrapper} (i.e., files opened
with @code{mode='r+'}) would have another buffering. To disable buffering in
@code{TextIOWrapper}, consider using the @code{write_through} flag for
@ref{bd1,,io.TextIOWrapper.reconfigure()}. When no `buffering' argument is
given, the default buffering policy works as follows:


@itemize *

@item 
Los ficheros binarios son transmitidos por búferes con tamaños fijos de bloque; el tamaño del búfer se escoge mediante un intento heurístico para determinar el “”tamaño de bloque”” del dispositivo subyacente y recurre a @ref{16d1,,io.DEFAULT_BUFFER_SIZE}. En muchos sistemas, el búfer tendrá normalmente un tamaño de 4096 u 8192 bytes.

@item 
Los ficheros de texto «interactivos» (ficheros para los cuales @ref{1c89,,isatty()} retorna @code{True}) usan buffering por líneas.  Otros ficheros de texto emplean la norma descrita anteriormente para ficheros binarios.
@end itemize

`encoding' es el nombre de la codificación empleada con el fichero. Esto solo debe ser usado en el modo texto.  La codificación por defecto es dependiente de plataforma (aquello que retorna  @ref{1d3,,locale.getencoding()}), pero puede emplearse cualquier  @ref{2180,,text encoding}  soportado por Python.  Ver el módulo @ref{1c,,codecs}  para la lista de codificaciones soportadas.

`errors' es una cadena opcional que especifica como deben manejarse los errores de codificación y descodificación – esto no puede ser usado en modo binario. Están disponibles varios gestores de error  (listados en @ref{17ed,,Manejadores de errores}), pero también es válido cualquier nombre de gestión de error registrado con @ref{14d5,,codecs.register_error()}. Los nombres estándar incluyen:


@itemize *

@item 
@code{'strict'} para lanzar una excepción @ref{360,,ValueError} si hay un error de codificación.  El valor por defecto, @code{None}, produce el mismo efecto.

@item 
@code{'ignore'} ignora los errores.  Nótese que ignorar errores de codificación puede conllevar la pérdida de datos.

@item 
@code{'replace'}  provoca que se inserte un marcador de reemplazo (como  @code{'?'})  en aquellos sitios donde hay datos malformados.

@item 
@code{'surrogateescape'} representará cualquier bytes incorrectos como unidades de código sustituto bajo que van desde U+DC80 a U+DCFF.  Estas unidades de código sustituto volverán a convertirse en los mismos bytes cuando el gestor de errores @code{surrogateescape} sea usado al escribir datos.  Esto es útil para el procesado de ficheros con una codificación desconocida.

@item 
@code{'xmlcharrefreplace'} está soportado solamente cuando se escribe a un fichero. Los caracteres que no estén soportados por la codificación son reemplazados por la referencia al carácter XML apropiado @code{&#@var{nnn};}.

@item 
@code{'backslashreplace'} reemplaza datos malformados con las secuencias de escapes de barra invertida de Python.

@item 
@code{'namereplace'} reemplaza caracteres no soportados con secuencias de escape  @code{\N@{...@}} (y también está sólo soportado en escritura).
@end itemize

@geindex nuevas líneas universales;open() función incorporada
@anchor{library/functions open-newline-parameter}@anchor{7dc}
`newline' determina cómo analizar los caracteres de nueva línea de la secuencia.  Puede ser  @code{None}, @code{'@w{'}}, @code{'\n'}, @code{'\r'}, y @code{'\r\n'}.  Funciona de la siguiente manera:


@itemize *

@item 
Cuando se está leyendo entrada desde el flujo, si `newline' es @code{None}, el modo `universal newlines' es activado.  Las líneas en la entrada pueden terminar en  @code{'\n'}, @code{'\r'}, o @code{'\r\n'}, y serán traducidas a  @code{'\n'}  antes de ser retornadas a la entidad que llama. Si es @code{'@w{'}}, el modo `universal newlines' estará activado pero los finales de línea se retornan sin traducir a la entidad que llama. Si tiene cualquiera de los otros valoras válidos, las líneas de entrada estarán terminadas sólo por la cadena dada, y los finales de línea serán retornados sin traducir a la entidad que llama.

@item 
Cuando se escribe salida al flujo, si `newline' es  @code{None}, cualquier carácter @code{'\n'} escrito es traducido al separador de línea por defecto en el sistema, @ref{2181,,os.linesep}. Si `newline' es @code{'@w{'}} o @code{'\n'}, entonces no se produce ninguna traducción.  Si `newline' toma cualquiera de los otros valores válidos, entonces cualquier carácter @code{'\n'}  escrito es traducido a la cadena indicada.
@end itemize

Si `closefd' es @code{False}  y se indica un descriptor de fichero en vez de un nombre de fichero, el descriptor del fichero se mantendrá abierto cuando se cierre el fichero. Si se indica un nombre de fichero, `closefd'  debe ser @code{True} (lo es por defecto), ya que de otra forma se lanzará un error.

Un abridor personalizado puede emplearse pasando un invocable como `opener'. El descriptor de fichero del objeto se obtiene llamando a `opener' con (`file', `flags'). `opener' debe retornar un descriptor de fichero abierto (pasando @ref{e18,,os.open} como `opener' resulta en una funcionalidad similar a @code{None}).

El nuevo fichero creado es @ref{f7c,,no-heredable}.

El siguiente ejemplo emplea el parámetro @ref{115d,,dir_fd}  de la función @ref{e18,,os.open()}  para abrir un fichero relativo a un directorio dado:

@example
>>> import os
>>> dir_fd = os.open('somedir', os.O_RDONLY)
>>> def opener(path, flags):
...     return os.open(path, flags, dir_fd=dir_fd)
...
>>> with open('spamspam.txt', 'w', opener=opener) as f:
...     print('This will be written to somedir/spamspam.txt', file=f)
...
>>> os.close(dir_fd)  # don't leak a file descriptor
@end example

El tipo de @ref{1230,,file object} retornado por la función @ref{1be,,open()}  depende del modo. Cuando se emplea  @ref{1be,,open()} para abrir un fichero en modo texto (@code{'w'}, @code{'r'}, @code{'wt'}, @code{'rt'}, etc.), retorna una subclase de @ref{736,,io.TextIOBase} (específicamente @ref{854,,io.TextIOWrapper}).  Cuando se emplea para abrir un fichero en modo binario con buffering, la clase retornada es una subclase de @ref{735,,io.BufferedIOBase}.  La clase exacta varía: en modo binario de lectura, retorna @ref{127b,,io.BufferedReader}; en modo de escritura y adición en binario, retorna @ref{2182,,io.BufferedWriter}, y en modo de escritura/lectura, retorna @ref{2183,,io.BufferedRandom}.  Si el buffering está desactivado, el flujo en crudo, una subclase de @ref{1144,,io.RawIOBase}, @ref{1378,,io.FileIO}, es retornada.

@geindex I/O con búfer de línea
@geindex I/O sin búfer
@geindex tamaño del búfer@comma{} I/O
@geindex control de I/O;buffering
@geindex modo binario
@geindex modo texto
@geindex módulo;sys

Véase también los módulos para manejo de ficheros, como @ref{5b,,fileinput}, @ref{7f,,io} (donde es declarada @ref{1be,,open()}), @ref{a1,,os}, @ref{a2,,os.path}, @ref{e0,,tempfile}, y @ref{c5,,shutil}.

Raises an @ref{18c3,,auditing event} @code{open} with arguments @code{path}, @code{mode}, @code{flags}.

Los argumentos @code{mode} y @code{flags} pueden haber sido modificados o inferidos de la llamada original.


Distinto en la versión 3.3: 


@itemize *

@item 
El parámetro `opener' fue añadido.

@item 
El modo  @code{'x'} fue añadido.

@item 
@ref{10ce,,IOError}  era la excepción lanzada anteriormente, ahora es un alias de @ref{4d5,,OSError}.

@item 
Se lanza @ref{109c,,FileExistsError}  si ya existe el fichero abierto en modo de creación exclusiva  (@code{'x'}).
@end itemize



Distinto en la versión 3.4: 


@itemize *

@item 
El fichero ahora es no-heredable.
@end itemize



Distinto en la versión 3.5: 


@itemize *

@item 
Si la llamada al sistema es interrumpida y el gestor de señales no lanza una excepción, ahora la función reintenta la llamada de sistema en vez de lanzar una excepción @ref{e0e,,InterruptedError} (véase  
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@item 
El gestor de errores  @code{'namereplace'} fue añadido.
@end itemize



Distinto en la versión 3.6: 


@itemize *

@item 
Añadido el soporte para aceptar objetos que implementan @ref{cd9,,os.PathLike}.

@item 
En Windows, abrir un búfer en la consola puede retornar una subclase de @ref{1144,,io.RawIOBase}  en vez de @ref{1378,,io.FileIO}.
@end itemize



Distinto en la versión 3.11: El modo  @code{'X'} has ido eliminado.

@end deffn

@geindex built-in function; ord()
@anchor{library/functions ord}@anchor{1eef}
@deffn {Función} ord (c)

Al proporcionarle una cadena representando un carácter Unicode, retorna un entero que representa el código Unicode de ese carácter.  Por ejemplo,  @code{ord('a')} retorna el entero @code{97} y @code{ord('€')} (símbolo del Euro) retorna @code{8364}.  Esta es la función inversa de @ref{167d,,chr()}.
@end deffn

@geindex built-in function; pow()
@anchor{library/functions pow}@anchor{a64}
@deffn {Función} pow (base, exp, mod=None)

Retorna `base' elevado a `exp'; si `mod' está presente, retorna `base' elevado a `exp', módulo `mod' (calculado de manera más eficiente que @code{pow(base, exp) % mod}).  La forma con dos argumentos @code{pow(base, exp)} es equivalente a usar el operador potencia: @code{base**exp}.

The arguments must have numeric types.  With mixed operand types, the
coercion rules for binary arithmetic operators apply.  For @ref{1f0,,int}
operands, the result has the same type as the operands (after coercion)
unless the second argument is negative; in that case, all arguments are
converted to float and a float result is delivered.  For example, @code{pow(10, 2)}
returns @code{100}, but @code{pow(10, -2)} returns @code{0.01}.  For a negative base of
type @ref{1f0,,int} or @ref{153,,float} and a non-integral exponent, a complex
result is delivered.  For example, @code{pow(-9, 0.5)} returns a value close
to @code{3j}. Whereas, for a negative base of type @ref{1f0,,int} or @ref{153,,float}
with an integral exponent, a float result is delivered. For example,
@code{pow(-9, 2.0)} returns @code{81.0}.

Para operandos @ref{1f0,,int} como `base' y `exp', si `mod' está presente, `mod' debe ser también de tipo entero y distinto de cero. Si `mod' está presente y `exp' es negativo, `base' debe ser un número primo relativo a `mod'.  En ese caso, se retorna  @code{pow(inv_base, -exp, mod)}, dónde `inv_base' es la inversa al módulo `mod' de `base'.

Aquí tienes un ejemplo de cómo calcular la inversa de @code{38} módulo @code{97}:

@example
>>> pow(38, -1, mod=97)
23
>>> 23 * 38 % 97 == 1
True
@end example


Distinto en la versión 3.8: Para operandos @ref{1f0,,int}, la forma de @code{pow} con tres argumentos acepta ahora que el segundo argumento sea negativo, lo que permite el cálculo de inversos modulares.



Distinto en la versión 3.8: Permite argumentos de palabra clave. Anteriormente, solo se soportaba el uso de argumentos posicionales.

@end deffn

@geindex built-in function; print()
@anchor{library/functions print}@anchor{ff4}
@deffn {Función} print (*objects, sep=' ', end='\n', file=None, flush=False)

Imprime `objects' al flujo de texto `file', separándolos por `sep' y seguidos por `end'.  `sep', `end', `file' y `flush', si están presentes, deben ser dados como argumentos por palabra clave.

Todos los argumentos que no son por palabra clave se convierten a cadenas tal y como @ref{237,,str()} hace y se escriben al flujo, separados por `sep' y seguidos por `end'.  Tanto `sep' como `end' deben ser cadenas; también pueden ser @code{None}, lo cual significa que se empleen los valores por defecto. Si no se indica `objects', @ref{ff4,,print()} escribirá `end'.

El argumento `file' debe ser un objeto que implemente un método @code{write(string)}; si éste no está presente o es @code{None}, se usará @ref{b61,,sys.stdout}.  Dado que los argumentos mostrados son convertidos a cadenas de texto, @ref{ff4,,print()} no puede ser utilizada con objetos fichero en modo binario.  Para esos, utiliza en cambio @code{file.write(…)}.

El almacenamiento en búfer de salida generalmente está determinado por `file'. Sin embargo, si `flush' es verdadero, el flujo se vacía forzosamente.


Distinto en la versión 3.3: Añadido el argumento por palabra clave `flush'.

@end deffn

@geindex property (clase incorporada)
@anchor{library/functions property}@anchor{2fd}
@deffn {Clase} property (fget=None, fset=None, fdel=None, doc=None)

Retorna un atributo propiedad.

`fget' es una función para obtener el valor de un atributo. `fset' es una función para asignar el valor de un atributo. `fdel' es una función para eliminar el valor de un atributo. Y `doc' crea un `docstring' para el atributo.

Un caso de uso típico es la definición de un atributo gestionado @code{x}:

@example
class C:
    def __init__(self):
        self._x = None

    def getx(self):
        return self._x

    def setx(self, value):
        self._x = value

    def delx(self):
        del self._x

    x = property(getx, setx, delx, "I'm the 'x' property.")
@end example

Si `c' es una instancia de `C', @code{c.x} invocará el obtenedor (`getter'), @code{c.x = value} invocará el asignador (`setter') y @code{del c.x} el suprimidor (`deleter').

Si está indicada, `doc' será la docstring del atributo propiedad. En caso contrario, la propiedad copiará la `dosctring' de `fget' si ésta existe.  Esto permite crear propiedades de sólo lectura de forma fácil empleando  @ref{2fd,,property()} como @ref{7cd,,decorator}:

@example
class Parrot:
    def __init__(self):
        self._voltage = 100000

    @@property
    def voltage(self):
        """Get the current voltage."""
        return self._voltage
@end example

The @code{@@property} decorator turns the @code{voltage()} method into a «getter»
for a read-only attribute with the same name, and it sets the docstring for
`voltage' to «Get the current voltage.»

@geindex built-in function; property.getter()
@anchor{library/functions property getter}@anchor{1665}
@deffn {Función} @@getter
@end deffn

@geindex built-in function; property.setter()
@anchor{library/functions property setter}@anchor{1666}
@deffn {Función} @@setter
@end deffn

@geindex built-in function; property.deleter()
@anchor{library/functions property deleter}@anchor{1667}
@deffn {Función} @@deleter

A property object has @code{getter}, @code{setter},
and @code{deleter} methods usable as decorators that create a
copy of the property with the corresponding accessor function set to the
decorated function.  This is best explained with an example:

@example
class C:
    def __init__(self):
        self._x = None

    @@property
    def x(self):
        """I'm the 'x' property."""
        return self._x

    @@x.setter
    def x(self, value):
        self._x = value

    @@x.deleter
    def x(self):
        del self._x
@end example

Este código equivale exactamente al primer ejemplo.  Asegúrese de otorgarle a las funciones adicionales el mismo nombre que la propiedad original (@code{x} en este caso.)

El objeto propiedad retornado tiene también los atributos @code{fget}, @code{fset}, y @code{fdel} correspondientes a los argumentos del constructor.
@end deffn


Distinto en la versión 3.5: Las `docstrings' de los objetos propiedad son escribibles.


@geindex __name__ (atributo de property)
@anchor{library/functions property __name__}@anchor{2fc}
@deffn {Atributo} __name__

Attribute holding the name of the property. The name of the property
can be changed at runtime.


Added in version 3.13.

@end deffn
@end deffn

@anchor{library/functions func-range}@anchor{215d}
@deffn {Clase} range (stop)

@deffnx {Clase} range (start, stop, step=1)

@ref{9d6,,range}, más que una función, es en realidad un tipo de secuencia inmutable, tal y como está documentado en @ref{2184,,Rangos} y @ref{1c50,,Tipos secuencia — list@comma{} tuple@comma{} range}.
@end deffn

@geindex built-in function; repr()
@anchor{library/functions repr}@anchor{894}
@deffn {Función} repr (object)

Return a string containing a printable representation of an object.  For many
types, this function makes an attempt to return a string that would yield an
object with the same value when passed to @ref{2eb,,eval()}; otherwise, the
representation is a string enclosed in angle brackets that contains the name
of the type of the object together with additional information often
including the name and address of the object.  A class can control what this
function returns for its instances
by defining a @ref{6bd,,__repr__()} method.
If @ref{1560,,sys.displayhook()} is not accessible, this function will raise
@ref{1e5,,RuntimeError}.

This class has a custom representation that can be evaluated:

@example
class Person:
   def __init__(self, name, age):
      self.name = name
      self.age = age

   def __repr__(self):
      return f"Person('@{self.name@}', @{self.age@})"
@end example
@end deffn

@geindex built-in function; reversed()
@anchor{library/functions reversed}@anchor{8fc}
@deffn {Función} reversed (seq)

Return a reverse @ref{313,,iterator}.  `seq' must be an object which has
a @ref{1f5c,,__reversed__()} method or supports the sequence protocol (the
@ref{1f62,,__len__()} method and the @ref{3d8,,__getitem__()} method
with integer arguments starting at @code{0}).
@end deffn

@geindex built-in function; round()
@anchor{library/functions round}@anchor{1342}
@deffn {Función} round (number, ndigits=None)

Retorna `number' redondeado a `ndigits' de precisión después del punto decimal. Si `ndigits' es omitido o es @code{None}, retorna el entero más cercano a su entrada.

Para los tipos integrados que admiten @ref{1342,,round()}, los valores se redondean al múltiplo más cercano de 10 a la potencia menos `ndigits'; si dos múltiplos están igualmente cerca, el redondeo se realiza hacia la opción par (así, por ejemplo, tanto @code{round(0.5)} como @code{round(-0.5)} son @code{0}, y @code{round(1.5)} es @code{2}).  Cualquier valor entero es válido para `ndigits' (positivo, cero o negativo).  El valor retornado es un entero si se omite `ndigits' o @code{None}. De lo contrario, el valor retornado tiene el mismo tipo que `number'.

Para un objeto @code{number} general de Python,  @code{round} delega a @code{number.__round__}.

@cartouche
@quotation Nota 
El comportamiento de @ref{1342,,round()} para flotantes puede ser sorprendente: por ejemplo, @code{round(2.675, 2)} da @code{2.67} en vez de los @code{2.68} esperados. Esto no es un error: es el resultado del hecho de que la mayoría de fracciones decimales no se puede representar de forma exacta como flotantes. Véase @ref{1d17,,Floating-Point Arithmetic; Issues and Limitations} para más información.
@end quotation
@end cartouche
@end deffn

@anchor{library/functions func-set}@anchor{215e}
@deffn {Clase} set

@deffnx {Clase} set (iterable)

Retorna un nuevo objeto @ref{67a,,set} , opcionalmente con elementos tomados de `iterable'.   @code{set} es una clase integrada (`built-in'). Véase @ref{67a,,set} y @ref{2179,,Conjuntos — set@comma{} frozenset}  para documentación sobre esta clase.

Para otros contenedores ver las clases integradas (`built-in') @ref{67b,,frozenset}, @ref{18e,,list}, @ref{464,,tuple}, y @ref{190,,dict}, así como el módulo @ref{1e,,collections}.
@end deffn

@geindex built-in function; setattr()
@anchor{library/functions setattr}@anchor{215f}
@deffn {Función} setattr (object, name, value)

Es la función complementaria a @ref{c59,,getattr()}.  Los argumentos son un objeto, una cadena de caracteres, y un valor arbitrario. La cadena de caracteres puede nombrar un atributo existente o uno nuevo. La función asigna el valor al atributo si el objeto lo permite. Por ejemplo, @code{setattr(x, 'foobar', 123)} es equivalente a @code{x.foobar = 123}.

`name' no necesita ser un identificador de Python como se define en @ref{1e94,,Identificadores y palabras clave} a menos que el objeto decida imponerlo, por ejemplo, en un  @ref{c5a,,__getattribute__()} personalizado o a través de @ref{152a,,__slots__}. Un atributo cuyo nombre no es un identificador no será accesible usando la notación de puntos, pero sí a través de @ref{c59,,getattr()} etc..

@cartouche
@quotation Nota 
Dado que @ref{1cc1,,private name mangling} ocurre en el momento de la compilación, uno debe enredar manualmente el nombre de un atributo privado (atributos con dos guiones bajos principales) para recuperarlo con @ref{c59,,getattr()}.
@end quotation
@end cartouche
@end deffn

@geindex slice (clase incorporada)
@anchor{library/functions slice}@anchor{514}
@deffn {Clase} slice (stop)

@deffnx {Clase} slice (start, stop, step=None)

Return a @ref{2185,,slice} object representing the set of indices specified by
@code{range(start, stop, step)}.  The `start' and `step' arguments default to
@code{None}.

@geindex start (atributo de slice)
@anchor{library/functions slice start}@anchor{1f55}
@deffn {Atributo} start
@end deffn

@geindex stop (atributo de slice)
@anchor{library/functions slice stop}@anchor{1f56}
@deffn {Atributo} stop
@end deffn

@geindex step (atributo de slice)
@anchor{library/functions slice step}@anchor{1f57}
@deffn {Atributo} step

Slice objects have read-only data attributes @code{start},
@code{stop}, and @code{step} which merely return the argument
values (or their default).  They have no other explicit functionality;
however, they are used by NumPy and other third-party packages.
@end deffn

Slice objects are also generated when extended indexing syntax is used.  For
example: @code{a[start:stop:step]} or @code{a[start:stop, i]}.  See
@ref{bd4,,itertools.islice()} for an alternate version that returns an
@ref{313,,iterator}.


Distinto en la versión 3.12: Ahora los objetos slice son @ref{6b1,,hashable} (siempre que @ref{1f55,,start}, @ref{1f56,,stop} y @ref{1f57,,step} sean `hashable').

@end deffn

@geindex built-in function; sorted()
@anchor{library/functions sorted}@anchor{c56}
@deffn {Función} sorted (iterable, /, *, key=None, reverse=False)

Retorna una nueva lista ordenada a partir de los elementos en `iterable'.

Tiene dos argumentos opcionales que deben ser especificados como argumentos de palabra clave.

`key' especifica una función de un argumento que es empleada para extraer una clave de comparación de cada elemento en `iterable' (por ejemplo, @code{key=str.lower}). El valor por defecto es @code{None} (compara los elementos directamente).

`reverse' es un valor boleado. Si está puesto a @code{True}, entonces la lista de elementos se ordena como si cada comparación fuera reversa.

Puedes usar @ref{1247,,functools.cmp_to_key()} para convertir las funciones `cmp' a la antigua usanza en funciones `key'.

La función built-in @ref{c56,,sorted()} está garantizada en cuanto a su estabilidad. Un ordenamiento es estable si garantiza que no cambia el orden relativo de elementos que resultan igual en la comparación — esto es de gran ayuda para ordenar en múltiples pases (por ejemplo, ordenar por departamento, después por el escalafón de salario).

El algoritmo de ordenación utiliza sólo comparaciones de @code{<} entre items. Mientras que al definir un método @ref{1372,,__lt__()} será suficiente para ordenar, 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} recomienda que las seis comparaciones @ref{2071,,rich comparisons} se implementen. Esto ayudará a evitar errores al usar los mismos datos con otras herramientas de ordenado como @ref{f8c,,max()} que se basan en un método subyacente diferente. La implementación de las seis comparaciones también ayuda a evitar confusiones por comparaciones de tipos mixtos que pueden llamar reflejado al método @ref{1374,,__gt__()}.

Para ejemplos de ordenamiento y para un breve tutorial sobre ello, ver @ref{2186,,Sorting Techniques}.
@end deffn

@geindex built-in function; staticmethod()
@anchor{library/functions staticmethod}@anchor{22e}
@deffn {Función} @@staticmethod

Transforma un método en un método estático.

Un método estático no recibe un primer argumento implícito. Para declarar un método estático, utiliza esta expresión:

@example
class C:
    @@staticmethod
    def f(arg1, arg2, argN): ...
@end example

La forma @code{@@staticmethod} es una función @ref{7cd,,decorator} — ver @ref{1c3d,,Definiciones de funciones}  para más detalles.

A static method can be called either on the class (such as @code{C.f()}) or on
an instance (such as @code{C().f()}).
Moreover, the static method @ref{1f70,,descriptor} is also callable, so it can
be used in the class definition (such as @code{f()}).

Los métodos estáticos en Python son similares a los que se encuentran en Java o C++. Ver también @ref{2d2,,classmethod()} para una variante que es útil para crear constructores de clase alternativos.

Como todos los decoradores, es también posible llamar a @code{staticmethod} como una función normal y hacer algo con su resultado. Esto es necesario a veces cuando necesitas una referencia a una función desde el cuerpo de una clase y quieres evitar la transformación automática a un método de la instancia. Para dichos casos, emplea esta expresión:

@example
def regular_function():
    ...

class C:
    method = staticmethod(regular_function)
@end example

Para más información sobre métodos estáticos, ver @ref{1ee4,,Jerarquía de tipos estándar}.


Distinto en la versión 3.10: Static methods now inherit the method attributes
(@ref{1efb,,__module__}, @ref{133c,,__name__},
@ref{1efa,,__qualname__}, @ref{1246,,__doc__} and
@ref{1245,,__annotations__}), have a new @code{__wrapped__} attribute,
and are now callable as regular functions.

@end deffn

@geindex string;str() (función incorporada)

@anchor{library/functions func-str}@anchor{2160}
@deffn {Clase} str (object='@w{'})

@deffnx {Clase} str (object=b'@w{'}, encoding='utf-8', errors='strict')

Retorna una versión @ref{237,,str} del `object'. Ver @ref{237,,str()} para más detalles.

@code{str} es la @ref{193b,,class} cadena built-in . Para información general sobre strings, ver @ref{1c04,,Cadenas de caracteres — str}.
@end deffn

@geindex built-in function; sum()
@anchor{library/functions sum}@anchor{515}
@deffn {Función} sum (iterable, /, start=0)

Suma `start' y los elementos de un `iterable' de izquierda a derecha y Retorna el total. Los elementos del `iterable' son normalmente números, y el valor `start' no puede ser una cadena.

For some use cases, there are good alternatives to @ref{515,,sum()}.
The preferred, fast way to concatenate a sequence of strings is by calling
@code{'@w{'}.join(sequence)}.  To add floating-point values with extended precision,
see @ref{1414,,math.fsum()}.  To concatenate a series of iterables, consider using
@ref{2187,,itertools.chain()}.


Distinto en la versión 3.8: El parámetro `start' puede ser especificado como un argumento de palabra clave.



Distinto en la versión 3.12: Summation of floats switched to an algorithm
that gives higher accuracy and better commutativity on most builds.



Distinto en la versión 3.14: Added specialization for summation of complexes,
using same algorithm as for summation of floats.

@end deffn

@geindex super (clase incorporada)
@anchor{library/functions super}@anchor{155}
@deffn {Clase} super

@deffnx {Clase} super (type, object_or_type=None)

Retorna un objeto proxy que delega las llamadas de métodos a clases padre o hermanas de `type'. Esto es útil para acceder métodos heredados que han sido invalidados en una clase.

`object-or-type' determina el @ref{2188,,method resolution order} a ser buscado. La búsqueda empieza desde la clase justo después de `type'.

For example, if @ref{1f2a,,__mro__} of `object_or_type' is
@code{D -> B -> C -> A -> object} and the value of `type' is @code{B},
then @ref{155,,super()} searches @code{C -> A -> object}.

The @ref{1f2a,,__mro__} attribute of the class corresponding to
`object_or_type' lists the method resolution search order used by both
@ref{c59,,getattr()} and @ref{155,,super()}.  The attribute is dynamic and can change
whenever the inheritance hierarchy is updated.

Si se omite el segundo argumento, el objeto super retornado no está vinculado.  Si el segundo argumento es un objeto, @code{isinstance(obj, type)} debe ser verdadero.  Si el segundo argumento es un tipo, @code{issubclass(type2, type)} debe ser verdadero (esto es útil para classmethods).

When called directly within an ordinary method of a class, both arguments may
be omitted («zero-argument @code{super()}»). In this case, `type' will be the
enclosing class, and `obj' will be the first argument of the immediately
enclosing function (typically @code{self}). (This means that zero-argument
@code{super()} will not work as expected within nested functions, including
generator expressions, which implicitly create nested functions.)

Hay dos casos de uso típicos para `super'.  En una jerarquía de clases con herencia única, `super' puede ser utilizado para referirse a las clases padre sin llamarlas explícitamente, haciendo el código más sencillo de mantener. Este uso es muy similar al de `super' en otros lenguajes de programación.

El segundo caso de uso es el soporte de herencia múltiple cooperativa en un entorno de ejecución dinámica.  Este caso de uso es único en Python y no se encuentra en lenguajes estáticos compilados o que solo soportan herencia única.  Esto hace posible implementar los «diagramas de diamantes», donde múltiples clases base implementan el mismo método. Las buenas prácticas de diseño dictan que estas implementaciones tengan la misma signatura de llamada en cada caso (porque el orden de llamadas se determina en tiempo de ejecución, porque ese orden se adapta a los cambios en la jerarquía de clase y porque ese orden puede incluir clases hermanas que son desconocidas antes de la ejecución).

Para ambos casos, la llamada típica de una superclase se parece a:

@example
class C(B):
    def method(self, arg):
        super().method(arg)    # This does the same thing as:
                               # super(C, self).method(arg)
@end example

Además de para los métodos de búsqueda, @ref{155,,super()}  también funciona para búsquedas de atributos.  Un caso de uso posible para esto es llamar a  @ref{1f70,,descriptores}  en una clase padre o hermana.

Note that @ref{155,,super()} is implemented as part of the binding process for
explicit dotted attribute lookups such as @code{super().__getitem__(name)}.
It does so by implementing its own @ref{c5a,,__getattribute__()} method
for searching
classes in a predictable order that supports cooperative multiple inheritance.
Accordingly, @ref{155,,super()} is undefined for implicit lookups using statements or
operators such as @code{super()[name]}.

Nótese también, que aparte de en su forma sin argumentos,  @ref{155,,super()}  no está limitada a su uso dentro de métodos.  La forma con dos argumentos especifica de forma exacta los argumentos y hace las referencias apropiadas.  La forma sin argumentos solo funciona dentro de una definición de clase, ya que el compilador completa los detalles necesarios para obtener correctamente la clase que está siendo definida, así como accediendo a la instancia actual para métodos ordinarios.

Para sugerencias prácticas sobre como diseñas clases cooperativas usando  @ref{155,,super()}, véase guía de uso de super()@footnote{https://rhettinger.wordpress.com/2011/05/26/super-considered-super/}.


Distinto en la versión 3.14: @ref{155,,super} objects are now @ref{a6,,pickleable} and
 @ref{26,,copyable}.

@end deffn

@anchor{library/functions func-tuple}@anchor{2161}
@deffn {Clase} tuple

@deffnx {Clase} tuple (iterable)

Más que una función, @ref{464,,tuple}  es en realidad un tipo de secuencia inmutable, tal y como está documentado en @ref{20e6,,Tuplas} y  @ref{1c50,,Tipos secuencia — list@comma{} tuple@comma{} range}.
@end deffn

@geindex type (clase incorporada)
@anchor{library/functions type}@anchor{dcf}
@deffn {Clase} type (object)

@deffnx {Clase} type (name, bases, dict, **kwds)

@geindex object;tipo

With one argument, return the type of an `object'.  The return value is a
type object and generally the same object as returned by
@ref{14e9,,object.__class__}.

La función integrada  @ref{4ef,,isinstance()} es la recomendada para testear el tipo de un objeto, ya que tiene en cuenta las subclases.

With three arguments, return a new type object.  This is essentially a
dynamic form of the @ref{133f,,class} statement. The `name' string is
the class name and becomes the @ref{14e7,,__name__} attribute.
The `bases' tuple contains the base classes and becomes the
@ref{14e8,,__bases__} attribute; if empty, @ref{b18,,object}, the
ultimate base of all classes, is added.  The `dict' dictionary contains
attribute and method definitions for the class body; it may be copied
or wrapped before becoming the @ref{ce5,,__dict__} attribute.
The following two statements create identical @code{type} objects:

@example
>>> class X:
...     a = 1
...
>>> X = type('X', (), dict(a=1))
@end example

See also:


@itemize *

@item 
@ref{1f22,,Documentation on attributes and methods on classes}.

@item 
@ref{2189,,Objetos Tipo}
@end itemize

Los argumentos de palabras clave proporcionados al formulario de tres argumentos se pasan a la maquinaria de metaclase apropiada (generalmente @ref{6d2,,__init_subclass__()}) de la misma manera que lo harían las palabras clave en una definición de clase (además de `metaclase').

Ver también  @ref{cd3,,Personalización de creación de clases}.


Distinto en la versión 3.6: Subclasses of @code{type} which don’t override @code{type.__new__} may no
longer use the one-argument form to get the type of an object.

@end deffn

@geindex built-in function; vars()
@anchor{library/functions vars}@anchor{1a49}
@deffn {Función} vars ()

@deffnx {Función} vars (object)

Return the @ref{5fe,,__dict__} attribute for a module, class, instance,
or any other object with a @code{__dict__} attribute.

Objects such as modules and instances have an updateable @ref{5fe,,__dict__}
attribute; however, other objects may have write restrictions on their
@code{__dict__} attributes (for example, classes use a
@ref{518,,types.MappingProxyType} to prevent direct dictionary updates).

Without an argument, @ref{1a49,,vars()} acts like @ref{2ae,,locals()}.

Una excepción @ref{228,,TypeError} se genera si se especifica un objeto pero no tiene un atributo @ref{5fe,,__dict__} (por ejemplo, si su clase define el atributo @ref{152a,,__slots__}).


Distinto en la versión 3.13: The result of calling this function without an argument has been
updated as described for the @ref{2ae,,locals()} builtin.

@end deffn

@geindex built-in function; zip()
@anchor{library/functions zip}@anchor{14d}
@deffn {Función} zip (*iterables, strict=False)

Iterar sobre varios iterables en paralelo, generando tuplas con un item para cada una.

Ejemplo:

@example
>>> for item in zip([1, 2, 3], ['sugar', 'spice', 'everything nice']):
...     print(item)
...
(1, 'sugar')
(2, 'spice')
(3, 'everything nice')
@end example

Más formalmente: @ref{14d,,zip()} retorna un iterador de tuplas, donde la tupla `i'-ésima contiene el elemento `i'-ésimo de cada uno de los argumentos iterables.

Otra forma de pensar en @ref{14d,,zip()} es que convierte las filas en columnas y las columnas en filas.  Esto es similar a transponer una matriz@footnote{https://en.wikipedia.org/wiki/Transpose}.

@ref{14d,,zip()} es perezoso: los elementos no se procesarán hasta que el iterable sea iterado, por ejemplo, mediante un bucle @code{for} o envolviendo en un @ref{18e,,list}.

Una cosa a considerar es que los iterables pasados a @ref{14d,,zip()} podrían tener diferentes longitudes; a veces por diseño, y a veces por un error en el código que preparó estos iterables. Python ofrece tres enfoques diferentes para tratar este problema:


@itemize *

@item 
De forma predeterminada, @ref{14d,,zip()} se detiene cuando se agota el iterable más corto. Ignorará los elementos restantes en las iteraciones más largas, cortando el resultado a la longitud del iterable más corto:

@example
>>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum']))
[(0, 'fee'), (1, 'fi'), (2, 'fo')]
@end example

@item 
@ref{14d,,zip()} se usa a menudo en los casos en que se supone que los iterables son de igual longitud. En tales casos, se recomienda usar la opción @code{strict=True}. Su salida es la misma que la normal @ref{14d,,zip()}:

@example
>>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True))
[('a', 1), ('b', 2), ('c', 3)]
@end example

A diferencia del comportamiento predeterminado, lanza una excepción @ref{360,,ValueError} si un iterable se agota antes que los demás:

@example
>>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True):  
...     print(item)
...
(0, 'fee')
(1, 'fi')
(2, 'fo')
Traceback (most recent call last):
  ...
ValueError: zip() argument 2 is longer than argument 1
@end example

@c This doctest is disabled because doctest does not support capturing
@c output and exceptions in the same code unit.
@c https://github.com/python/cpython/issues/65382

Sin el argumento @code{strict=True}, cualquier error que resulte en iterables de diferentes longitudes será silenciado, posiblemente manifestándose como un error difícil de encontrar en otra parte del programa.

@item 
Las iteraciones más cortas se pueden acolchar con un valor constante para que todas las iteraciones tengan la misma longitud.  Esto lo hace @ref{130a,,itertools.zip_longest()}.
@end itemize

Casos extremos: con un único argumento iterable, @ref{14d,,zip()} retorna un iterador de 1-tuplas. Sin argumentos, retorna un iterador vacío.

Consejos y trucos:


@itemize *

@item 
La evaluación de izquierda a derecha de los iterables está garantizada. Esto permite emplear una expresión idiomática para agregar una serie de datos en grupos de tamaño `n' usando  @code{zip(*[iter(s)]*n, strict=True)}. Esto repite el `mismo' iterador @code{n} veces de forma que cada tupla de salida tiene el resultado de  @code{n} llamadas al iterador. Esto tiene el efecto de dividir la entrada en trozos de longitud `n'.

@item 
@ref{14d,,zip()}  en conjunción con el operador  @code{*}  puede usar para descomprimir (`unzip') una lista:

@example
>>> x = [1, 2, 3]
>>> y = [4, 5, 6]
>>> list(zip(x, y))
[(1, 4), (2, 5), (3, 6)]
>>> x2, y2 = zip(*zip(x, y))
>>> x == list(x2) and y == list(y2)
True
@end example
@end itemize


Distinto en la versión 3.10: Añadido el argumento @code{strict}.

@end deffn

@geindex built-in function; __import__()
@anchor{library/functions import__}@anchor{96b}
@deffn {Función} __import__ (name, globals=None, locals=None, fromlist=(), level=0)

@geindex declaración;import
@geindex módulo;builtins

@cartouche
@quotation Nota 
Ésta es una función avanzada que no se necesita en el uso cotidiano de programación en Python, a diferencia de @ref{5bc,,importlib.import_module()}.
@end quotation
@end cartouche

Esta función es invocada por la declaración @ref{682,,import}. Puede ser reemplazada para cambiar la semántica de la declaración @code{import} (mediante la importación del módulo @ref{13,,builtins} y su asignación a @code{builtins.__import__}), pero esto está `fuertemente' no recomendado ya que es normalmente mucho más simple usar ganchos (`hooks') de importación (ver 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}) para obtener los mismos objetivos y sin causar problemas en código que asume que la implementación por defecto de importaciones está siendo utilizada. El uso directo de  @ref{96b,,__import__()} tampoco está recomendado y se prefiere  @ref{5bc,,importlib.import_module()}.

La función importa el módulo `name', usando potencialmente las `globals' y `locals' indicadas para determinar como interpretar el nombre en el contexto de un paquete. `fromlist' indica los nombres de objetos o submódulos que deberían ser importados del módulo indicado por `name'.  La implementación estándar no utiliza su argumento `locals' para nada, y usa `globals' solo para determinar el contexto en un paquete de la declaración @ref{682,,import}.

`level' especifica si usar importaciones absolutas o relativas. @code{0} (por defecto) significa sólo realizar importaciones absolutas. Valores positivos de  `level' indican el número de directorios progenitores relativos al del módulo para buscar llamando a @ref{96b,,__import__()} (ver 
@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} para los detalles).

Cuando la variable `name' tiene la forma @code{package.module}, normalmente el paquete del nivel más alto (el nombre hasta el primer punto) se retorna, `no' el modulo llamado por `name'.  Sin embargo, cuando un argumento `fromlist' no vacío es indicado, el módulo llamado por `name' es retornado.

Por ejemplo, la declaración @code{import spam} resulta en un bytecode similar al siguiente código:

@example
spam = __import__('spam', globals(), locals(), [], 0)
@end example

La declaración @code{import spam.ham}  resulta en esta llamada:

@example
spam = __import__('spam.ham', globals(), locals(), [], 0)
@end example

Nótese cómo @ref{96b,,__import__()} retorna el módulo del nivel superior en este caso porque este es el objeto que está enlazado a un nombre por la declaración @ref{682,,import}.

Por otra parte, la declaración  @code{from spam.ham import eggs, sausage as saus} resulta en

@example
_temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0)
eggs = _temp.eggs
saus = _temp.sausage
@end example

Aquí, el módulo @code{spam.ham} es retornado desde  @ref{96b,,__import__()}.  Desde este objeto, los nombres a importar son obtenidos y asignados a sus nombres respectivos.

Si simplemente quieres importar un módulo (potencialmente dentro de un paquete) por nombre, usa  @ref{5bc,,importlib.import_module()}.


Distinto en la versión 3.3: Valores negativos para `level' ya no están soportados (lo que también cambia el valor por defecto a 0).



Distinto en la versión 3.9: Cuando se utilizan las opciones de línea de comando @ref{9f0,,-E} o @ref{9f1,,-I}, la variable de entorno 
@geindex PYTHONCASEOK
@geindex variables de entorno; PYTHONCASEOK
@ref{9ef,,PYTHONCASEOK} ahora se ignora.

@end deffn

@subsubheading Notas al pie


@node Constantes incorporadas,Tipos integrados,Funciones incorporadas<2>,La biblioteca estándar de Python
@anchor{library/constants doc}@anchor{218a}@anchor{library/constants built-in-constants}@anchor{218b}@anchor{library/constants built-in-consts}@anchor{218c}
@section Constantes incorporadas


Un pequeño número de constantes viven en el espacio de nombres incorporado. Ellas son:

@geindex False (variable incorporada)
@anchor{library/constants False}@anchor{bbf}
@deffn {Dato} False

El valor falso del tipo @ref{513,,bool}. Las asignaciones a @code{False} son ilegales y generan un @ref{150,,SyntaxError}.
@end deffn

@geindex True (variable incorporada)
@anchor{library/constants True}@anchor{c95}
@deffn {Dato} True

El valor verdadero del tipo @ref{513,,bool}. Las asignaciones a @code{True} son ilegales y generan un @ref{150,,SyntaxError}.
@end deffn

@geindex None (variable incorporada)
@anchor{library/constants None}@anchor{716}
@deffn {Dato} None

An object frequently used to represent the absence of a value, as when
default arguments are not passed to a function. Assignments to @code{None}
are illegal and raise a @ref{150,,SyntaxError}.
@code{None} is the sole instance of the @ref{8e9,,NoneType} type.
@end deffn

@geindex NotImplemented (variable incorporada)
@anchor{library/constants NotImplemented}@anchor{227}
@deffn {Dato} NotImplemented

A special value which should be returned by the binary special methods
(e.g. @ref{b85,,__eq__()}, @ref{1372,,__lt__()}, @ref{1f8c,,__add__()}, @ref{1f9f,,__rsub__()},
etc.) to indicate that the operation is not implemented with respect to
the other type; may be returned by the in-place binary special methods
(e.g. @ref{1f91,,__imul__()}, @ref{1fb1,,__iand__()}, etc.) for the same purpose.
It should not be evaluated in a boolean context.
@code{NotImplemented} is the sole instance of the @ref{8ea,,types.NotImplementedType} type.

@cartouche
@quotation Nota 
When a binary (or in-place) method returns @code{NotImplemented} the
interpreter will try the reflected operation on the other type (or some
other fallback, depending on the operator).  If all attempts return
@code{NotImplemented}, the interpreter will raise an appropriate exception.
Incorrectly returning @code{NotImplemented} will result in a misleading
error message or the @code{NotImplemented} value being returned to Python code.

Consulte @ref{1ee7,,Implementar operaciones aritméticas} para ver ejemplos.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@code{NotImplementedError} and @code{NotImplemented} are not interchangeable,
even though they have similar names and purposes.
See @ref{384,,NotImplementedError} for details on when to use it.
@end quotation
@end cartouche


Distinto en la versión 3.9: Evaluating @code{NotImplemented} in a boolean context was deprecated.



Distinto en la versión 3.14: Evaluating @code{NotImplemented} in a boolean context now raises a @ref{228,,TypeError}.
It previously evaluated to @ref{c95,,True} and emitted a @ref{1da,,DeprecationWarning}
since Python 3.9.

@end deffn

@geindex ...;ellipsis literal

@geindex Ellipsis (variable incorporada)
@anchor{library/constants Ellipsis}@anchor{218d}
@deffn {Dato} Ellipsis

Lo mismo que la elipsis literal «@code{...}». Valor especial que se utiliza principalmente junto con la sintaxis de segmentación extendida para tipos de datos de contenedor definidos por el usuario.`@w{`}Ellipsis`@w{`} es la única instancia del tipo @ref{8e8,,types.EllipsisType}.
@end deffn

@geindex __debug__ (variable incorporada)
@anchor{library/constants debug__}@anchor{871}
@deffn {Dato} __debug__

Esta constante es verdadera si Python no se inició con una opción @ref{14f,,-O}. Vea también la instrucción @ref{9fa,,assert}.
@end deffn

@cartouche
@quotation Nota 
Los nombres: @ref{716,,None}, @ref{bbf,,False}, @ref{c95,,True} y @ref{871,,__debug__} no se pueden reasignar (asignaciones a ellos, incluso como un nombre de atributo, lanza @ref{150,,SyntaxError} ), por lo que pueden considerarse constantes «verdaderas».
@end quotation
@end cartouche

@menu
* Constantes agregadas por el módulo site:: 

@end menu

@node Constantes agregadas por el módulo site,,,Constantes incorporadas
@anchor{library/constants constants-added-by-the-site-module}@anchor{218e}@anchor{library/constants site-consts}@anchor{218f}
@subsection Constantes agregadas por el módulo @code{site}


El módulo @ref{c7,,site} (que se importa automáticamente durante el inicio, excepto si se proporciona la opción @ref{1217,,-S} en la línea de comandos) agrega varias constantes al espacio de nombres integrado. Son útiles para el intérprete interactivo y no deben usarse en programas.

@geindex quit (variable incorporada)
@geindex exit (variable incorporada)
@anchor{library/constants quit}@anchor{2190}
@deffn {Dato} quit (code=None)
@anchor{library/constants exit}@anchor{2191}
@deffnx {Dato} exit (code=None)

Objetos que cuando se imprimen, muestra un mensaje como «Use quit() o Ctrl-D (i.e. EOF) to exit», y cuando se llama, lanza @ref{dc7,,SystemExit} con el código de salida especificado.
@end deffn


@deffn {Dato} help

Object that when printed, prints the message «Type help() for interactive
help, or help(object) for help about object.», and when called,
acts as described @ref{96e,,elsewhere}.
@end deffn

@geindex copyright (variable incorporada)
@geindex credits (variable incorporada)
@anchor{library/constants copyright}@anchor{2192}
@deffn {Dato} copyright
@anchor{library/constants credits}@anchor{2193}
@deffnx {Dato} credits

Objetos que al ser impresos o llamados imprimen el texto de derechos de autor o créditos, respectivamente.
@end deffn

@geindex license (variable incorporada)
@anchor{library/constants license}@anchor{2194}
@deffn {Dato} license

Objeto que cuando se imprime, muestra el mensaje «Escriba licencia () para ver el texto completo de la licencia», y cuando se le llama, muestra el texto completo de la licencia en forma de buscapersonas (una pantalla a la vez).
@end deffn

@c XXX: reference/datamodel and this have quite a few overlaps!

@node Tipos integrados,Excepciones incorporadas,Constantes incorporadas,La biblioteca estándar de Python
@anchor{library/stdtypes doc}@anchor{2195}@anchor{library/stdtypes bltin-types}@anchor{2196}@anchor{library/stdtypes built-in-types}@anchor{2197}
@section Tipos integrados


Esta sección describe los tipos de datos estándar que vienen incluidos en el intérprete.

@geindex built-in;types

Los principales tipos de datos son: numéricos, secuencias, mapas, clases, instancias y excepciones.

Algunas clases de tipo colección son mutables. Los métodos que añaden, retiran u ordenan sus miembros en su lugar, y a no ser que retornen un elemento concreto, nunca retornan la propia instancia contenedora, sino @code{None}.

Algunas operaciones son soportadas por varios tipos de objetos diferentes; por ejemplo, prácticamente todos los objetos pueden ser comparados por igualdad, evaluados para ser considerados como valores booleanos, o representarse en forma de cadena de caracteres (ya sea con la función @ref{894,,repr()} o con la función ligeramente diferente @ref{237,,str()}). Esta última es la usada implícitamente cuando un objeto se escribe con la función @ref{ff4,,print()}.

@menu
* Evaluar como valor verdadero/falso:: 
* Operaciones booleanas — and@comma{} or@comma{} not: Operaciones booleanas — and or not. 
* Comparaciones: Comparaciones<2>. 
* Tipos numéricos — int@comma{} float@comma{} complex: Tipos numéricos — int float complex. 
* Boolean Type - bool:: 
* Tipos de iteradores:: 
* Tipos secuencia — list@comma{} tuple@comma{} range: Tipos secuencia — list tuple range. 
* Cadenas de caracteres — str:: 
* Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview: Tipos de secuencias binarias — bytes bytearray y memoryview. 
* Conjuntos — set@comma{} frozenset: Conjuntos — set frozenset. 
* Tipos mapa — dict:: 
* Tipos gestores de contexto:: 
* Tipos de anotaciones de type — alias genérico@comma{} Union: Tipos de anotaciones de type — alias genérico Union. 
* Otros tipos predefinidos:: 
* Atributos especiales:: 
* Limitación de longitud de conversión de cadena de tipo entero:: 

@end menu

@node Evaluar como valor verdadero/falso,Operaciones booleanas — and or not,,Tipos integrados
@anchor{library/stdtypes truth}@anchor{2162}@anchor{library/stdtypes truth-value-testing}@anchor{2198}
@subsection Evaluar como valor verdadero/falso


@geindex statement;if
@geindex statement;while
@geindex truth;value
@geindex Boolean;operations
@geindex false

Cualquier objeto puede ser evaluado como si fuera un valor verdadero o falso, para ser usado directamente en sentencias @ref{1ec,,if} o @ref{1611,,while}, o como un operador en una operación booleana como las que veremos más adelante.

@geindex true

By default, an object is considered true unless its class defines either a
@ref{133d,,__bool__()} method that returns @code{False} or a
@ref{1f62,,__len__()} method that
returns zero, when called with the object. @footnote{
Se puede consultar información adicional sobre estos métodos especiales en el manual de referencia de Python (@ref{1f5f,,Personalización básica}).
}  Here are most of the built-in
objects considered false:

@geindex None (Built-in object)
@geindex False (Built-in object)


@itemize *

@item 
constants defined to be false: @code{None} and @code{False}

@item 
cero en cualquiera de los diferentes tipos numéricos: @code{0}, @code{0.0}, @code{0j}, @code{Decimal(0)}, @code{Fraction(0, 1)}

@item 
cualquier colección o secuencia vacía: @code{'@w{'}}, @code{()}, @code{[]}, @code{@{@}}, @code{set()}, @code{range(0)}
@end itemize

@geindex operator;or
@geindex operator;and
@geindex False
@geindex True

Las operaciones y funciones integradas que tienen como resultado un booleano siempre retornan @code{0} o @code{False} para un valor falso, y @code{1} o @code{True} para un valor verdadero, a no ser que se indique otra cosa. (Hay una excepción importante: Las operaciones booleanas @code{or} y @code{and} siempre retornan uno de los dos operadores.)

@node Operaciones booleanas — and or not,Comparaciones<2>,Evaluar como valor verdadero/falso,Tipos integrados
@anchor{library/stdtypes boolean}@anchor{2199}@anchor{library/stdtypes boolean-operations-and-or-not}@anchor{219a}
@subsection Operaciones booleanas — @code{and}, @code{or}, @code{not}


@geindex Boolean;operations

Estas son las operaciones booleanas, ordenadas de menor a mayor prioridad:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@tab

Notas

@item

@code{x or y}

@tab

if `x' is true, then `x', else
`y'

@tab

(1)

@item

@code{x and y}

@tab

si `x' es falso, entonces `x', si no, `y'

@tab

(2)

@item

@code{not x}

@tab

si `x' es falso, entonces @code{True}, si no, @code{False}

@tab

(3)

@end multitable


@geindex operator;and
@geindex operator;or
@geindex operator;not

Notas:


@enumerate 

@item 
Este operador usa lógica cortocircuitada, por lo que solo evalúa el segundo argumento si el primero es falso.

@item 
Este operador usa lógica cortocircuitada, por lo que solo evalúa el segundo argumento si el primero es verdadero.

@item 
El operador @code{not} tiene menos prioridad que los operadores no booleanos, así que @code{not a == b} se interpreta como @code{not (a == b)}, y @code{a == not b} es un error sintáctico.
@end enumerate

@node Comparaciones<2>,Tipos numéricos — int float complex,Operaciones booleanas — and or not,Tipos integrados
@anchor{library/stdtypes comparisons}@anchor{219b}@anchor{library/stdtypes stdcomparisons}@anchor{219c}
@subsection Comparaciones


@geindex chaining;comparisons
@geindex operator;comparison
@geindex operator;==
@geindex operator;< (less)
@geindex operator;<=
@geindex operator;> (greater)
@geindex operator;>=
@geindex operator;!=
@geindex operator;is
@geindex operator;is not

Existen ocho operadores de comparación en Python. Todos comparten el mismo nivel de prioridad (que es mayor que el nivel de las operaciones booleanas). Las comparaciones pueden encadenarse de cualquier manera; por ejemplo, @code{x < y <= z} equivale a @code{x < y and y <= z}, excepto porque `y' solo se evalúa una vez (no obstante, en ambos casos `z' no se evalúa si no es verdad que @code{x < y}).

Esta tabla resume las operaciones de comparación:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Significado

@item

@code{<}

@tab

estrictamente menor que

@item

@code{<=}

@tab

menor o igual que

@item

@code{>}

@tab

estrictamente mayor que

@item

@code{>=}

@tab

mayor o igual que

@item

@code{==}

@tab

igual que

@item

@code{!=}

@tab

diferente que

@item

@code{is}

@tab

igualdad a nivel de identidad (Son el mismo objeto)

@item

@code{is not}

@tab

desigualdad a nivel de identidad (no son el mismo objeto)

@end multitable


@geindex object;numeric
@geindex objects;comparing

Nunca se comparan iguales los objetos que son de tipos diferentes, con la excepción de los tipos numéricos. El operador @code{==} siempre está definido, pero en algunos tipos de objetos (como por ejemplo, las clases) es equivalente al operador @ref{1ee,,is}. Los operadores @code{<}, @code{<=}, @code{>} y @code{>=} solo están definidos cuando tienen sentido; por ejemplo, si uno de los operadores es un número complejo, la comparación lanzará una excepción de tipo @ref{228,,TypeError}.

@geindex __eq__() (instance method)
@geindex __ne__() (instance method)
@geindex __lt__() (instance method)
@geindex __le__() (instance method)
@geindex __gt__() (instance method)
@geindex __ge__() (instance method)

Las instancias de una clase que no son idénticas normalmente se comparan como diferentes, a no ser que la clase defina el método @ref{b85,,__eq__()}.

Las instancias de una clase no pueden ordenarse con respecto a otras instancias de la misma clase, ni con otro tipo de objetos, a no ser que la clase defina suficientes métodos @ref{1372,,__lt__()}, @ref{1373,,__le__()}, @ref{1374,,__gt__()} y @ref{1375,,__ge__()} (en general, @ref{1372,,__lt__()} y @ref{b85,,__eq__()} son suficientes, si solo necesitas los significados convencionales de los operadores de comparación).

El comportamiento de los operadores @ref{1ee,,is} e @ref{2078,,is not} no se puede personalizar; además, se pueden aplicar a dos objetos cualquiera y nunca lanzar una excepción.

@geindex operator;in
@geindex operator;not in

Two more operations with the same syntactic priority, @ref{1ed,,in} and
@ref{6d0,,not in}, are supported by types that are @ref{1294,,iterable} or
implement the @ref{1f5d,,__contains__()} method.

@node Tipos numéricos — int float complex,Boolean Type - bool,Comparaciones<2>,Tipos integrados
@anchor{library/stdtypes numeric-types-int-float-complex}@anchor{219d}@anchor{library/stdtypes typesnumeric}@anchor{1bff}
@subsection Tipos numéricos — @code{int}, @code{float}, @code{complex}


@geindex object;numeric
@geindex object;Boolean
@geindex object;integer
@geindex object;floating-point
@geindex object;complex number
@geindex C;language

There are three distinct numeric types: `integers', `floating-point
numbers', and `complex numbers'.  In addition, Booleans are a
subtype of integers.  Integers have unlimited precision.  Floating-point
numbers are usually implemented using double in C; information
about the precision and internal representation of floating-point
numbers for the machine on which your program is running is available
in @ref{19f4,,sys.float_info}.  Complex numbers have a real and imaginary
part, which are each a floating-point number.  To extract these parts
from a complex number `z', use @code{z.real} and @code{z.imag}. (The standard
library includes the additional numeric types @ref{177,,fractions.Fraction}, for
rationals, and @ref{16a,,decimal.Decimal}, for floating-point numbers with
user-definable precision.)

@geindex numeric;literals
@geindex integer;literals
@geindex floating-point;literals
@geindex complex number;literals
@geindex hexadecimal;literals
@geindex octal;literals
@geindex binary;literals

Numbers are created by numeric literals or as the result of built-in functions
and operators.  Unadorned integer literals (including hex, octal and binary
numbers) yield integers.  Numeric literals containing a decimal point or an
exponent sign yield floating-point numbers.  Appending @code{'j'} or @code{'J'} to a
numeric literal yields an imaginary number (a complex number with a zero real
part) which you can add to an integer or float to get a complex number with real
and imaginary parts.

@geindex arithmetic
@geindex built-in function;int
@geindex built-in function;float
@geindex built-in function;complex
@geindex operator;+ (plus)
@geindex + (plus);unary operator
@geindex + (plus);binary operator
@geindex operator;- (minus)
@geindex - (minus);unary operator
@geindex - (minus);binary operator
@geindex operator;* (asterisk)
@geindex operator;/ (slash)
@geindex operator;//
@geindex operator;% (percent)
@geindex operator;**

Python soporta completamente una aritmética mixta: cuando un operador binario de tipo aritmético se encuentra con que los operandos son de tipos numéricos diferentes, el operando con el tipo de dato más «estrecho» o restrictivo se convierte o amplía hasta el nivel del otro operando, donde el número entero es más estrecho que el coma flotante, que es más estrecho que el número complejo. Las comparaciones entre números de diferentes tipos se comportan como si se compararan los valores exactos de estos. @footnote{
En consecuencia, la lista @code{[1, 2]} se considera igual que @code{[1.0, 2.0]}, y de forma similar para las tuplas.
}

Las funciones constructoras @ref{1f0,,int()}, @ref{153,,float()} y @ref{154,,complex()} se pueden usar para generar números de cada tipo determinado.

Todos los tipos numéricos (menos los complejos) soportan las siguientes operaciones (para las prioridades de las operaciones, véase @ref{2091,,Prioridad de operador}):


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@tab

Notas

@tab

Documentación completa

@item

@code{x + y}

@tab

suma de `x' e `y'

@tab

@tab

@item

@code{x - y}

@tab

resta de `x' e `y'

@tab

@tab

@item

@code{x * y}

@tab

multiplicación de `x' por `y'

@tab

@tab

@item

@code{x / y}

@tab

división de `x' entre `y'

@tab

@tab

@item

@code{x // y}

@tab

división entera a la baja de `x' entre `y'

@tab

(1)(2)

@tab

@item

@code{x % y}

@tab

resto o residuo de @code{x / y}

@tab

(2)

@tab

@item

@code{-x}

@tab

valor de `x', negado

@tab

@tab

@item

@code{+x}

@tab

valor de `x', sin cambiar

@tab

@tab

@item

@code{abs(x)}

@tab

valor absoluto de la magnitud de `x'

@tab

@tab

@ref{1cab,,abs()}

@item

@code{int(x)}

@tab

valor de `x' convertido a entero

@tab

(3)(6)

@tab

@ref{1f0,,int()}

@item

@code{float(x)}

@tab

valor de `x' convertido a número de coma flotante

@tab

(4)(6)

@tab

@ref{153,,float()}

@item

@code{complex(re, im)}

@tab

un número complejo, con parte real `re' y parte imaginaria `im'. El valor de `im' por defecto vale cero.

@tab

(6)

@tab

@ref{154,,complex()}

@item

@code{c.conjugate()}

@tab

conjugado del número complejo `c'

@tab

@tab

@item

@code{divmod(x, y)}

@tab

el par de valores @code{(x // y, x % y)}

@tab

(2)

@tab

@ref{a33,,divmod()}

@item

@code{pow(x, y)}

@tab

`x' elevado a `y'

@tab

(5)

@tab

@ref{a64,,pow()}

@item

@code{x ** y}

@tab

`x' elevado a `y'

@tab

(5)

@tab

@end multitable


@geindex operations on;numeric;types
@geindex conjugate() (complex number method)

Notas:


@enumerate 

@item 
También conocida como división entera a la baja. Para operandos de tipo @ref{1f0,,int}, el resultado será de tipo @ref{1f0,,int}. Para operandos de tipo @ref{153,,float}, el resultado será de tipo @ref{153,,float}. En general, el resultado es un número entero en el sentido matemático, pero no necesariamente de tipo entero @ref{1f0,,int}. El resultado se redondea de forma automática hacia menos infinito: @code{1//2} es @code{0}, @code{(-1)//2} es @code{-1}, @code{1//(-2)} es @code{-1} y @code{(-1)//(-2)} es @code{0}.

@item 
No es apropiada para números complejos. Es preferible convertir a valores en coma flotante usando la función @ref{1cab,,abs()} si fuera apropiado.

@item 
@geindex module;math
@geindex floor() (in module math)
@geindex ceil() (in module math)
@geindex trunc() (in module math)
@geindex numeric;conversions

Conversion from @ref{153,,float} to @ref{1f0,,int} truncates, discarding the
fractional part. See functions @ref{1401,,math.floor()} and @ref{1402,,math.ceil()} for
alternative conversions.

@item 
float también acepta las cadenas de caracteres «`nan'» e «`inf'», con un prefijo opcional «+» o «-», para los valores `Not a Number' (`NaN') e infinito positivo o negativo.

@item 
Python define @code{pow(0, 0)} y @code{0 ** 0} para que valgan @code{1}, como es práctica habitual en los lenguajes de programación.

@item 
Los literales numéricos aceptables incluyen los dígitos desde el @code{0} hasta el @code{9}, así como cualquier carácter Unicode equivalente (puntos de código con la propiedad @code{Nd}).

See the Unicode Standard@footnote{https://unicode.org/Public/UNIDATA/extracted/DerivedNumericType.txt}
for a complete list of code points with the @code{Nd} property.
@end enumerate

Todas las clases derivadas de @ref{219e,,numbers.Real} (@ref{1f0,,int} y @ref{153,,float}) también soportan las siguientes operaciones:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@item

@ref{1403,,math.trunc(x)}

@tab

`x' truncado a @ref{1fbc,,Integral}

@item

@ref{1342,,round(x[@comma{} n])}

@tab

El valor de `x' redondeado a `n' dígitos, redondeando la mitad al número par más cercano (redondeo del banquero). Si no se especifica valor para `n', se asume 0.

@item

@ref{1401,,math.floor(x)}

@tab

el mayor número @ref{1fbc,,Integral} que sea <= `x'

@item

@ref{1402,,math.ceil(x)}

@tab

el menor número @ref{1fbc,,Integral} que sea >= `x'

@end multitable


Para más operaciones numéricas consulta los módulos @ref{8e,,math} y @ref{19,,cmath}.

@c XXXJH exceptions: overflow (when? what operations?) zerodivision

@menu
* Operaciones de bits en números enteros:: 
* Métodos adicionales de los enteros:: 
* Métodos adicionales de float:: 
* Additional Methods on Complex:: 
* Calculo del hash de tipos numéricos:: 

@end menu

@node Operaciones de bits en números enteros,Métodos adicionales de los enteros,,Tipos numéricos — int float complex
@anchor{library/stdtypes bitstring-ops}@anchor{219f}@anchor{library/stdtypes bitwise-operations-on-integer-types}@anchor{21a0}
@subsubsection Operaciones de bits en números enteros


@geindex operations on;integer;types
@geindex bitwise;operations
@geindex shifting;operations
@geindex masking;operations
@geindex operator;| (vertical bar)
@geindex operator;^ (caret)
@geindex operator;& (ampersand)
@geindex operator;<<
@geindex operator;>>
@geindex operator;~ (tilde)

Las operaciones a nivel de bit solo tienen sentido con números enteros. El resultado de una de estas operaciones se calcula como si se hubiera realizado en una representación en complemento a dos que tuviera un número infinito de bits de signo.

La prioridad de todas las operaciones de bits son menores que las operaciones numéricas, pero mayores que las comparaciones; la operación unaria @code{~} tiene la misma prioridad que las otras operaciones unarias numéricas (@code{+} y @code{-}).

Esta tabla lista las operaciones de bits, ordenadas de menor a mayor prioridad:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@tab

Notas

@item

@code{x | y}

@tab

la operación `or' entre `x' e `y'

@tab

(4)

@item

@code{x ^ y}

@tab

la operación `exclusive or' entre `x' e `y'

@tab

(4)

@item

@code{x & y}

@tab

la operación `and' entre `x' e `y'

@tab

(4)

@item

@code{x << n}

@tab

valor de `x' desplazado a la izquierda `n' bits

@tab

(1)(2)

@item

@code{x >> n}

@tab

valor de `x' desplazado a la derecha `n' bits

@tab

(1)(3)

@item

@code{~x}

@tab

invierte los bits de `x'

@tab

@end multitable


Notas:


@enumerate 

@item 
Los desplazamientos negativos son ilegales y lanzarán una excepción de tipo @ref{360,,ValueError}.

@item 
Un desplazamiento de `n' bits a la izquierda es equivalente a multiplicar por @code{pow(2, n)}.

@item 
Un desplazamiento de `n' bits a la derecha es equivalente a efectuar la división entera a la baja entre @code{pow(2, n)}.

@item 
Realizar estos cálculos con al menos un bit extra de signo en una representación finita de un número en complemento a dos (un ancho de bits de trabajo de @code{1 + max(x.bit_length(), y.bit_length())} o más) es suficiente para obtener el mismo resultado que si se hubiera realizado con un número infinito de bits de signo.
@end enumerate

@node Métodos adicionales de los enteros,Métodos adicionales de float,Operaciones de bits en números enteros,Tipos numéricos — int float complex
@anchor{library/stdtypes additional-methods-on-integer-types}@anchor{21a1}
@subsubsection Métodos adicionales de los enteros


El tipo int implementa la @ref{1224,,clase base abstracta} @ref{1fbc,,numbers.Integral}. Además, proporciona los siguientes métodos:

@geindex bit_length() (método de int)
@anchor{library/stdtypes int bit_length}@anchor{21a2}
@deffn {Método} int.bit_length ()

Retorna el número de bits necesarios para representar un número entero, excluyendo el bit de signo y los ceros a la izquierda:

@example
>>> n = -37
>>> bin(n)
'-0b100101'
>>> n.bit_length()
6
@end example

De forma más precisa, si @code{x} es distinto de cero, entonces @code{x.bit_length()} es el único número entero positivo @code{k} tal que @code{2**(k-1) <= abs(x) < 2**k}. De igual manera, cuando @code{abs(x)} es lo suficientemente pequeño para tener un logaritmo redondeado correctamente, entonces @code{k = 1 + int(log(abs(x), 2))}. Si @code{x} es cero, entonces @code{x.bit_length()} retorna @code{0}.

Equivale a:

@example
def bit_length(self):
    s = bin(self)       # binary representation:  bin(-37) --> '-0b100101'
    s = s.lstrip('-0b') # remove leading zeros and minus sign
    return len(s)       # len('100101') --> 6
@end example


Added in version 3.1.

@end deffn

@geindex bit_count() (método de int)
@anchor{library/stdtypes int bit_count}@anchor{865}
@deffn {Método} int.bit_count ()

Retorna el número de unos en la representación binaria del valor absoluto del entero. Esto también se conoce como el recuento de la población. Ejemplo:

@example
>>> n = 19
>>> bin(n)
'0b10011'
>>> n.bit_count()
3
>>> (-n).bit_count()
3
@end example

Equivale a:

@example
def bit_count(self):
    return bin(self).count("1")
@end example


Added in version 3.10.

@end deffn

@geindex to_bytes() (método de int)
@anchor{library/stdtypes int to_bytes}@anchor{1897}
@deffn {Método} int.to_bytes (length=1, byteorder='big', *, signed=False)

Retorna un arreglo de bytes que representan el número entero.

@example
>>> (1024).to_bytes(2, byteorder='big')
b'\x04\x00'
>>> (1024).to_bytes(10, byteorder='big')
b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'
>>> (-1024).to_bytes(10, byteorder='big', signed=True)
b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'
>>> x = 1000
>>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little')
b'\xe8\x03'
@end example

El número entero se representa usando el número de bits indicados con `length' y el valor predeterminado es 1. Se lanzará la excepción @ref{919,,OverflowError} si no se puede representar el entero con ese número de bits.

El argumento `byteorder' determina el orden de representación del número entero y el valor predeterminado es @code{"big"}. Si `byteorder' es @code{"big"}, el byte más significativo ocupa la primera posición del arreglo del byte. Si `byteorder' es @code{"little"}, el byte más significativo estará en la última posición.

El parámetro `signed' determina si se usa el complemento a dos para representar los números enteros. Si `signed' es @code{False}, y se usa un valor entero negativo, se lanzará la excepción @ref{919,,OverflowError}. El valor por defecto para `signed' es @code{False}.

The default values can be used to conveniently turn an integer into a
single byte object:

@example
>>> (65).to_bytes()
b'A'
@end example

However, when using the default arguments, don’t try
to convert a value greater than 255 or you’ll get an @ref{919,,OverflowError}.

Equivale a:

@example
def to_bytes(n, length=1, byteorder='big', signed=False):
    if byteorder == 'little':
        order = range(length)
    elif byteorder == 'big':
        order = reversed(range(length))
    else:
        raise ValueError("byteorder must be either 'little' or 'big'")

    return bytes((n >> i*8) & 0xff for i in order)
@end example


Added in version 3.2.



Distinto en la versión 3.11: Se agregaron valores de argumentos predeterminados para @code{length} y @code{byteorder}.

@end deffn

@geindex from_bytes() (método de clase de int)
@anchor{library/stdtypes int from_bytes}@anchor{1857}
@deffn {Método} classmethod int.from_bytes (bytes, byteorder='big', *, signed=False)

Retorna el número entero que se representa por el arreglo de bytes.

@example
>>> int.from_bytes(b'\x00\x10', byteorder='big')
16
>>> int.from_bytes(b'\x00\x10', byteorder='little')
4096
>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=True)
-1024
>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=False)
64512
>>> int.from_bytes([255, 0, 0], byteorder='big')
16711680
@end example

El argumento `bytes' debe ser o bien un @ref{db4,,objeto tipo binario} o un iterable que produzca bytes.

El argumento `byteorder' determina el orden de representación del número entero y el valor predeterminado es @code{"big"}. Si `byteorder' es @code{"big"}, el byte más significativo ocupa la primera posición en el arreglo del byte. Si `byteorder' es @code{"little"}, el byte más significativo estará en la última posición. Para solicitar el orden de bytes nativo del sistema host, usa @ref{21a3,,sys.byteorder} como valor de orden de bytes.

El argumento `signed' indica si se representará el número entero usando complemento a dos.

Equivale a:

@example
def from_bytes(bytes, byteorder='big', signed=False):
    if byteorder == 'little':
        little_ordered = list(bytes)
    elif byteorder == 'big':
        little_ordered = list(reversed(bytes))
    else:
        raise ValueError("byteorder must be either 'little' or 'big'")

    n = sum(b << i*8 for i, b in enumerate(little_ordered))
    if signed and little_ordered and (little_ordered[-1] & 0x80):
        n -= 1 << 8*len(little_ordered)

    return n
@end example


Added in version 3.2.



Distinto en la versión 3.11: Se agregó valor de argumento predeterminado para @code{byteorder}.

@end deffn

@geindex as_integer_ratio() (método de int)
@anchor{library/stdtypes int as_integer_ratio}@anchor{a5d}
@deffn {Método} int.as_integer_ratio ()

Return a pair of integers whose ratio is equal to the original
integer and has a positive denominator.  The integer ratio of integers
(whole numbers) is always the integer as the numerator and @code{1} as the
denominator.


Added in version 3.8.

@end deffn

@geindex is_integer() (método de int)
@anchor{library/stdtypes int is_integer}@anchor{1783}
@deffn {Método} int.is_integer ()

Returns @code{True}. Exists for duck type compatibility with @ref{21a4,,float.is_integer()}.


Added in version 3.12.

@end deffn

@node Métodos adicionales de float,Additional Methods on Complex,Métodos adicionales de los enteros,Tipos numéricos — int float complex
@anchor{library/stdtypes additional-methods-on-float}@anchor{21a5}
@subsubsection Métodos adicionales de float


El tipo float implementa la @ref{1224,,clase base abstracta} @ref{219e,,numbers.Real}. Los números float tienen además los siguientes métodos.

@geindex from_number() (método de clase de float)
@anchor{library/stdtypes float from_number}@anchor{151}
@deffn {Método} classmethod float.from_number (x)

Class method to return a floating-point number constructed from a number `x'.

If the argument is an integer or a floating-point number, a
floating-point number with the same value (within Python’s floating-point
precision) is returned.  If the argument is outside the range of a Python
float, an @ref{919,,OverflowError} will be raised.

For a general Python object @code{x}, @code{float.from_number(x)} delegates to
@code{x.__float__()}.
If @ref{a5e,,__float__()} is not defined then it falls back
to @ref{22b,,__index__()}.


Added in version 3.14.

@end deffn

@geindex as_integer_ratio() (método de float)
@anchor{library/stdtypes float as_integer_ratio}@anchor{1d18}
@deffn {Método} float.as_integer_ratio ()

Return a pair of integers whose ratio is exactly equal to the
original float. The ratio is in lowest terms and has a positive denominator.  Raises
@ref{919,,OverflowError} on infinities and a @ref{360,,ValueError} on
NaNs.
@end deffn

@geindex is_integer() (método de float)
@anchor{library/stdtypes float is_integer}@anchor{21a4}
@deffn {Método} float.is_integer ()

Retorna @code{True} si el valor en coma flotante es finita con valor integral, y @code{False} en caso contrario:

@example
>>> (-2.0).is_integer()
True
>>> (3.2).is_integer()
False
@end example
@end deffn

Hay dos métodos que convierten desde y hacia cadenas de caracteres en hexadecimal. Como los valores en coma flotante en Python se almacenan internamente en binario, las conversiones desde o hacia cadenas `decimales' pueden implicar un pequeño error de redondeo. Pero con cadenas de caracteres en hexadecimal, las cadenas se corresponden y permiten representar de forma exacta los números en coma flotante. Esto puede ser útil, ya sea a la hora de depurar errores, o en procesos numéricos.

@geindex hex() (método de float)
@anchor{library/stdtypes float hex}@anchor{1d19}
@deffn {Método} float.hex ()

Retorna la representación de un valor en coma flotante en forma de cadena de caracteres en hexadecimal. Para números finitos, la representación siempre empieza con el prefijo @code{0x}, y con una @code{p} justo antes del exponente.
@end deffn

@geindex fromhex() (método de clase de float)
@anchor{library/stdtypes float fromhex}@anchor{21a6}
@deffn {Método} classmethod float.fromhex (s)

Método de clase que retorna el valor en coma flotante que se representa por la cadena de caracteres en hexadecimal `s'. La cadena de caracteres `s' puede tener espacios en blanco al principio o al final.
@end deffn

Nótese que @ref{1d19,,float.hex()} es un método de instancia, mientras que @ref{21a6,,float.fromhex()} es un método de clase.

Una cadena de caracteres en hexadecimal sigue este formato:

@example
[sign] ['0x'] integer ['.' fraction] ['p' exponent]
@end example

donde el componente opcional @code{sign} puede ser o bien @code{+} o @code{-}, las componentes @code{integer} y @code{fraction} son cadenas de caracteres que solo usan dígitos hexadecimales, y @code{exponent} es un número decimal, precedido con un signo opcional. No se distingue entre mayúsculas y minúsculas, y debe haber al menos un dígito hexadecimal tanto en la parte entera como en la fracción. Esta sintaxis es similar a la sintaxis especificada en la sección 6.4.4.2 del estándar C99, y es también la sintaxis usada en Java desde la versión 1.5. En particular, la salida de @ref{1d19,,float.hex()} se puede usar como una cadena de caracteres en hexadecimal en código C o Java, y las cadenas de caracteres hexadecimal producidas por el carácter de formato @code{%a} en C, o por el método Java, @code{Double.toHexString}, son aceptadas por @ref{21a6,,float.fromhex()}.

Nótese que el valor del exponente se expresa en decimal, no en hexadecimal, e indica la potencia de 2 por la que debemos multiplicar el coeficiente. Por ejemplo, la cadena de caracteres hexadecimal @code{0x3.a7p10} representa el número en coma flotante @code{(3 + 10./16 + 7./16**2) * 2.0**10}, o @code{3740.0}:

@example
>>> float.fromhex('0x3.a7p10')
3740.0
@end example

Si aplicamos la operación inversa a @code{3740.0} retorna una cadena de caracteres hexadecimal diferente que, aun así, representa el mismo número:

@example
>>> float.hex(3740.0)
'0x1.d380000000000p+11'
@end example

@node Additional Methods on Complex,Calculo del hash de tipos numéricos,Métodos adicionales de float,Tipos numéricos — int float complex
@anchor{library/stdtypes additional-methods-on-complex}@anchor{21a7}
@subsubsection Additional Methods on Complex


The @code{complex} type implements the @ref{21a8,,numbers.Complex}
@ref{1224,,abstract base class}.
@code{complex} also has the following additional methods.

@geindex from_number() (método de clase de complex)
@anchor{library/stdtypes complex from_number}@anchor{152}
@deffn {Método} classmethod complex.from_number (x)

Class method to convert a number to a complex number.

For a general Python object @code{x}, @code{complex.from_number(x)} delegates to
@code{x.__complex__()}.  If @ref{687,,__complex__()} is not defined then it falls back
to @ref{a5e,,__float__()}.  If @code{__float__()} is not defined then it falls back
to @ref{22b,,__index__()}.


Added in version 3.14.

@end deffn

@node Calculo del hash de tipos numéricos,,Additional Methods on Complex,Tipos numéricos — int float complex
@anchor{library/stdtypes hashing-of-numeric-types}@anchor{21a9}@anchor{library/stdtypes numeric-hash}@anchor{21aa}
@subsubsection Calculo del `hash' de tipos numéricos


For numbers @code{x} and @code{y}, possibly of different types, it’s a requirement
that @code{hash(x) == hash(y)} whenever @code{x == y} (see the @ref{b86,,__hash__()}
method documentation for more details).  For ease of implementation and
efficiency across a variety of numeric types (including @ref{1f0,,int},
@ref{153,,float}, @ref{16a,,decimal.Decimal} and @ref{177,,fractions.Fraction})
Python’s hash for numeric types is based on a single mathematical function
that’s defined for any rational number, and hence applies to all instances of
@ref{1f0,,int} and @ref{177,,fractions.Fraction}, and all finite instances of
@ref{153,,float} and @ref{16a,,decimal.Decimal}.  Essentially, this function is
given by reduction modulo @code{P} for a fixed prime @code{P}.  The value of @code{P} is
made available to Python as the @ref{21ab,,modulus} attribute of
@ref{107b,,sys.hash_info}.

`Detalles de implementación de CPython:' Actualmente, el número primo usado es @code{P = 2**31 - 1} para máquinas de 32 bits, y @code{P = 2**61 - 1} en máquinas de 64 bits.

Aquí están las reglas en detalle:


@itemize -

@item 
Si @code{x = m / n} es un número racional no negativo y @code{n} no es divisible por @code{P}, se define @code{hash(x)} como @code{m * invmod(n, P) % P}, donde @code{invmod(n, P)} retorna la inversa de @code{n} módulo @code{P}.

@item 
Si @code{x = m / n} es un número racional no negativo y @code{n} es divisible por @code{P} (pero no así @code{m}), entonces @code{n} no tiene módulo inverso de @code{P} y no se puede aplicar la regla anterior; en este caso, @code{hash(x)} retorna el valor constante definido en @code{sys.hash_info.inf}.

@item 
Si @code{x = m / n} es un número racional negativo se define @code{hash(x)} como @code{-hash(-x)}. Si el resultado fuera @code{-1}, lo cambia por @code{-2}.

@item 
Los valores concretos @code{sys.hash_info.inf} y @code{-sys.hash_info.inf} se usan como valores `hash' para infinito positivo o infinito negativo (respectivamente).

@item 
Para un número complejo @code{z} (una instancia de la clase @ref{154,,complex}), el valor de `hash' se calcula combinando los valores de `hash' de la parte real e imaginaria, usando la fórmula @code{hash(z.real) + sys.hash_info.imag * hash(z.imag)}, módulo reducido @code{2**sys.hash_info.width}, de forma que el valor obtenido esté en rango @code{range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - 1))}. De nuevo, si el resultado fuera @code{-1}, se reemplaza por @code{-2}.
@end itemize

Para clarificar las reglas previas, aquí mostramos un ejemplo de código Python, equivalente al cálculo realizado en la función `hash', para calcular el `hash' de un número racional de tipo @ref{153,,float} o @ref{154,,complex}:

@example
import sys, math

def hash_fraction(m, n):
    """Compute the hash of a rational number m / n.

    Assumes m and n are integers, with n positive.
    Equivalent to hash(fractions.Fraction(m, n)).

    """
    P = sys.hash_info.modulus
    # Remove common factors of P.  (Unnecessary if m and n already coprime.)
    while m % P == n % P == 0:
        m, n = m // P, n // P

    if n % P == 0:
        hash_value = sys.hash_info.inf
    else:
        # Fermat's Little Theorem: pow(n, P-1, P) is 1, so
        # pow(n, P-2, P) gives the inverse of n modulo P.
        hash_value = (abs(m) % P) * pow(n, P - 2, P) % P
    if m < 0:
        hash_value = -hash_value
    if hash_value == -1:
        hash_value = -2
    return hash_value

def hash_float(x):
    """Compute the hash of a float x."""

    if math.isnan(x):
        return object.__hash__(x)
    elif math.isinf(x):
        return sys.hash_info.inf if x > 0 else -sys.hash_info.inf
    else:
        return hash_fraction(*x.as_integer_ratio())

def hash_complex(z):
    """Compute the hash of a complex number z."""

    hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag)
    # do a signed reduction modulo 2**sys.hash_info.width
    M = 2**(sys.hash_info.width - 1)
    hash_value = (hash_value & (M - 1)) - (hash_value & M)
    if hash_value == -1:
        hash_value = -2
    return hash_value
@end example
@anchor{library/stdtypes bltin-boolean-values}@anchor{21ac}
@node Boolean Type - bool,Tipos de iteradores,Tipos numéricos — int float complex,Tipos integrados
@anchor{library/stdtypes boolean-type-bool}@anchor{21ad}@anchor{library/stdtypes typebool}@anchor{2163}
@subsection Boolean Type - @code{bool}


Booleans represent truth values. The @ref{513,,bool} type has exactly two
constant instances: @code{True} and @code{False}.

@geindex False
@geindex True
@geindex Boolean;values

The built-in function @ref{513,,bool()}  converts any value to a boolean, if the
value can be interpreted as a truth value (see section @ref{2162,,Evaluar como valor verdadero/falso} above).

For logical operations, use the @ref{2199,,boolean operators} @code{and},
@code{or} and @code{not}.
When applying the bitwise operators @code{&}, @code{|}, @code{^} to two booleans, they
return a bool equivalent to the logical operations «and», «or», «xor». However,
the logical operators @code{and}, @code{or} and @code{!=} should be preferred
over @code{&}, @code{|} and @code{^}.


Obsoleto desde la versión 3.12: The use of the bitwise inversion operator @code{~} is deprecated and will
raise an error in Python 3.16.


@ref{513,,bool} is a subclass of @ref{1f0,,int} (see @ref{1bff,,Tipos numéricos — int@comma{} float@comma{} complex}). In
many numeric contexts, @code{False} and @code{True} behave like the integers 0 and 1, respectively.
However, relying on this is discouraged; explicitly convert using @ref{1f0,,int()}
instead.

@node Tipos de iteradores,Tipos secuencia — list tuple range,Boolean Type - bool,Tipos integrados
@anchor{library/stdtypes iterator-types}@anchor{21ae}@anchor{library/stdtypes typeiter}@anchor{217b}
@subsection Tipos de iteradores


@geindex iterator protocol
@geindex protocol;iterator
@geindex sequence;iteration
@geindex container;iteration over

Python soporta el concepto de iteradores sobre contenedores. Esto se implementa usando dos métodos diferentes: Estos son usados por las clases definidas por el usuario para soportar iteración. Las secuencias, que se describirán con mayor detalle, siempre soportan la iteración.

Es necesario definir un método para que los objetos contenedores proporcionen compatibilidad @ref{1294,,iterable}:

@c XXX duplicated in reference/datamodel!

@geindex __iter__() (método de container)
@anchor{library/stdtypes container __iter__}@anchor{1cc8}
@deffn {Método} container.__iter__ ()

Retorna un objeto @ref{313,,iterator}. Este objeto es requerido para soportar el protocolo de iteración que se describe a continuación. Si un contenedor soporta diferentes tipos de iteración, se pueden implementar métodos adicionales para estos iteradores. (Por ejemplo, un tipo de contenedor que puede soportar distintas formas de iteración podría ser una estructura de tipo árbol que proporcione a la vez un recorrido en profundidad o en anchura). Este método se corresponde al `slot' @ref{152e,,tp_iter} de la estructura usada para los objetos Python en la API Python/C.
@end deffn

Los objetos iteradores en si necesitan definir los siguientes dos métodos, que forma juntos el `iterator protocol':

@geindex __iter__() (método de iterator)
@anchor{library/stdtypes iterator __iter__}@anchor{1ccb}
@deffn {Método} iterator.__iter__ ()

Retorna el propio objeto @ref{313,,iterator}. Este método es necesario para permitir tanto a los contenedores como a los iteradores usar la palabras clave @ref{1eb,,for} o @ref{1ed,,in}. Este método se corresponde con el `slot' @ref{152e,,tp_iter} de la estructura usada para los objetos Python en la API Python/C.
@end deffn

@geindex __next__() (método de iterator)
@anchor{library/stdtypes iterator __next__}@anchor{1335}
@deffn {Método} iterator.__next__ ()

Retorna el siguiente elemento del @ref{313,,iterator}. Si no hubiera más elementos, lanza la excepción @ref{c82,,StopIteration}. Este método se corresponde con el `slot' @ref{152f,,tp_iternext} de la estructura usada para los objetos Python en la API Python/C.
@end deffn

Python define varios objetos iteradores que permiten iterar sobre las secuencias, ya sean generales o específicas, diccionarios y otras estructuras de datos especializadas. Los tipos específicos no son tan importantes como la implementación del protocolo iterador.

Una vez que la ejecución del método @ref{1335,,__next__()} lanza la excepción @ref{c82,,StopIteration}, debe continuar haciéndolo en subsiguientes llamadas al método. Si una implementación no cumple esto, se considera rota.

@menu
* Tipos generador:: 

@end menu

@node Tipos generador,,,Tipos de iteradores
@anchor{library/stdtypes generator-types}@anchor{21af}@anchor{library/stdtypes id3}@anchor{21b0}
@subsubsection Tipos generador


Python’s @ref{10dd,,generator}s provide a convenient way to implement the iterator
protocol.  If a container object’s @ref{1ccb,,__iter__()} method is implemented as a
generator, it will automatically return an iterator object (technically, a
generator object) supplying the @code{__iter__()} and @ref{1ccc,,__next__()}
methods.
More information about generators can be found in @ref{2035,,the documentation for the yield expression}.

@node Tipos secuencia — list tuple range,Cadenas de caracteres — str,Tipos de iteradores,Tipos integrados
@anchor{library/stdtypes sequence-types-list-tuple-range}@anchor{21b1}@anchor{library/stdtypes typesseq}@anchor{1c50}
@subsection Tipos secuencia — @code{list}, @code{tuple}, @code{range}


Hay tres tipos básicos de secuencia: listas, tuplas y objetos de tipo rango. Existen tipos de secuencia especiales usados para el procesado de @ref{2166,,datos binarios} y @ref{1c04,,cadenas de caracteres} que se describirán en secciones específicas.

@menu
* Operaciones comunes de las secuencias:: 
* Tipos de secuencia inmutables:: 
* Tipos de secuencia mutables:: 
* Listas: Listas<2>. 
* Tuplas:: 
* Rangos:: 

@end menu

@node Operaciones comunes de las secuencias,Tipos de secuencia inmutables,,Tipos secuencia — list tuple range
@anchor{library/stdtypes common-sequence-operations}@anchor{21b2}@anchor{library/stdtypes typesseq-common}@anchor{21b3}
@subsubsection Operaciones comunes de las secuencias


@geindex object;sequence

Las operaciones de la siguiente tabla están soportadas por la mayoría de los tipos secuencia, tanto mutables como inmutables. La clase ABC @ref{1231,,collections.abc.Sequence} se incluye para facilitar la implementación correcta de estas operaciones en nuestros propios tipos de secuencias.

La tabla lista las operaciones ordenadas de menor a mayor prioridad. En la tabla, `s' y `t' representan secuencias del mismo tipo, `n', `i', `j' y `k' son números enteros y `x' es un objeto arbitrario que cumple con cualquier restricción de tipo o valor impuesta por `s'.

Las operaciones @code{in} y @code{not in} tienen la misma prioridad que los operadores de comparación. Las operaciones @code{+} (concatenación) y @code{*} (repetición) tienen la misma prioridad que sus equivalentes numéricos. @footnote{
Deben haberlo hecho, ya que el analizador no puede decir el tipo de operandos.
}

@geindex operations on;sequence;types
@geindex built-in function;len
@geindex built-in function;min
@geindex built-in function;max
@geindex concatenation;operation
@geindex repetition;operation
@geindex subscript;operation
@geindex slice;operation
@geindex operator;in
@geindex operator;not in
@geindex count() (sequence method)
@geindex index() (sequence method)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@tab

Notas

@item

@code{x in s}

@tab

@code{True} si un elemento de `s' es igual a `x', @code{False} en caso contrario

@tab

(1)

@item

@code{x not in s}

@tab

@code{False} si un elemento de `s' es igual a `x', @code{True} en caso contrario

@tab

(1)

@item

@code{s + t}

@tab

la concatenación de `s' y `t'

@tab

(6)(7)

@item

@code{s * n} o @code{n * s}

@tab

equivale a concatenar `s' consigo mismo `n' veces

@tab

(2)(7)

@item

@code{s[i]}

@tab

El elemento `i-esimo' de `s', empezando a contar en 0

@tab

(3)

@item

@code{s[i:j]}

@tab

el segmento de `s' desde `i' hasta `j'

@tab

(3)(4)

@item

@code{s[i:j:k]}

@tab

el segmento de `s' desde `i' hasta `j', con paso `k'

@tab

(3)(5)

@item

@code{len(s)}

@tab

longitud de `s'

@tab

@item

@code{min(s)}

@tab

el elemento más pequeño de `s'

@tab

@item

@code{max(s)}

@tab

el elemento más grande de `s'

@tab

@item

@code{s.index(x[, i[, j]])}

@tab

índice de la primera ocurrencia de `x' en `s' (en la posición `i' o superior, y antes de `j')

@tab

(8)

@item

@code{s.count(x)}

@tab

número total de ocurrencias de `x' en `s'

@tab

@end multitable


También se pueden comparar secuencias del mismo tipo. En particular, las tuplas y las listas se comparan por orden lexicográfico, comparando los elementos en la misma posición. Esto significa que, para que se consideren iguales, todos los elementos correspondientes deben ser iguales entre si, y las dos secuencias deben ser del mismo tipo y de la misma longitud. (Para más detalles, véase @ref{2071,,Comparaciones} en la referencia del lenguaje).

@geindex loop;over mutable sequence
@geindex mutable sequence;loop over

Los iteradores directos e inversos sobre secuencias mutables acceden a valores al usar un índice. Este índice continuará avanzando (o retrocediendo) incluso si la secuencia subyacente está mutada. El iterador termina solo cuando se encuentra un @ref{1575,,IndexError} o un @ref{c82,,StopIteration} (o cuando el índice cae por debajo de cero).

Notas:


@enumerate 

@item 
Aunque las operaciones @code{in} y @code{not in} se usan generalmente para comprobar si un elemento está dentro de un contenedor, en algunas secuencias especializadas (como @ref{237,,str}, @ref{325,,bytes} y @ref{5e0,,bytearray}) también se pueden usar para comprobar si está incluida una secuencia:

@example
>>> "gg" in "eggs"
True
@end example

@item 
Valores de `n' menores que @code{0} se consideran como @code{0} (que produce una secuencia vacía del mismo tipo que `s'). Nótese que los elementos de la secuencia `s' no se copian, sino que se referencian múltiples veces. Esto a menudo confunde a programadores noveles de Python; considérese:

@example
>>> lists = [[]] * 3
>>> lists
[[], [], []]
>>> lists[0].append(3)
>>> lists
[[3], [3], [3]]
@end example

Lo que ha pasado es que @code{[[]]} es una lista de un elemento, siendo este elemento una lista vacía, así que los tres elementos de @code{[[]] * 3} son referencias a la misma lista vacía. Modificar cualquiera de los elementos de @code{lists} modifica la lista inicial. Para crear una lista de listas independientes entre si, se puede hacer:

@example
>>> lists = [[] for i in range(3)]
>>> lists[0].append(3)
>>> lists[1].append(5)
>>> lists[2].append(7)
>>> lists
[[3], [5], [7]]
@end example

Se puede consultar una explicación más completa en esta entrada de la lista de preguntas más frecuentes @ref{21b4,,¿Cómo puedo crear una lista multidimensional?}.

@item 
Si `i' o `j' es negativo, el índice es relativo al final de la secuencia `s': Se realiza la sustitución @code{len(s) + i} o @code{len(s) + j}. Nótese que @code{-0} sigue siendo @code{0}.

@item 
El segmento de `s' desde `i' hasta `j' se define como la secuencia de elementos con índice `k', de forma que @code{i <= k < j}. Si `i' o `j' es mayor que @code{len(s)} se usa @code{len(s)}. Si `i' se omite o es @code{None}, se usa @code{0}. Si `j' se omite o es @code{None}, se usa @code{len(s)}. Si `i' es mayor o igual a `j', el segmento está vacío.

@item 
El segmento de `s', desde `i' hasta `j' con paso `k', se define como la secuencia de elementos con índice @code{x = i + n*k} tal que @code{0 <= n < (j-i)/k}. En otras palabras, los índices son @code{i}, @code{i+k}, @code{i+2*k}, @code{i+3*k} y así consecutivamente, hasta que se alcance el valor de `j' (pero sin incluir nunca `j'). Cuando `k' es positivo, `i' y `j' se limitan al valor de @code{len(s)}, si fueran mayores. Si `k' es negativo, `i' y `j' se reducen de @code{len(s) - 1}. Si `i' o `j' se omiten o su valor es @code{None}, se convierten es valores «finales» (donde el sentido de final depende del signo de `k'). Nótese que `k' no puede valer @code{0}. Si `k' vale @code{None}, se considera como @code{1}.

@item 
La concatenación de secuencias inmutables siempre produce un nuevo objeto. Esto significa que construir una secuencia usando la concatenación tiene un coste en ejecución cuadrático respecto al tamaño de la secuencia final. Para obtener un rendimiento lineal, se puede optar por una de las alternativas siguientes:


@itemize *

@item 
en vez de concatenar objetos de tipo @ref{237,,str}, se puede construir una lista y usar finalmente el método @ref{21b5,,str.join()}, o bien utilizar una instancia de la clase @ref{fa9,,io.StringIO} y recuperar el valor final completo

@item 
de forma similar, en vez de concatenar objetos de tipo @ref{325,,bytes} se puede usar el método @ref{21b6,,bytes.join()}, la clase @ref{f25,,io.BytesIO}, o se puede realizar una modificación interna usando un objeto de la clase @ref{5e0,,bytearray}. Los objetos de tipo @ref{5e0,,bytearray} son mutables y tienen un mecanismo interno de gestión muy eficiente

@item 
en vez de concatenar tuplas (instancias de @ref{464,,tuple}), usar una lista (@ref{18e,,list}) y expandirla

@item 
para otros tipos, investiga la documentación relevante de la clase
@end itemize

@item 
Algunos tipos de secuencia (como la clase @ref{9d6,,range}) solo soportan elementos que siguen un patrón específico, y por tanto no soportan la concatenación ni la repetición.

@item 
El método @code{index} lanza la excepción @ref{360,,ValueError} si `x' no se encuentra en `s'. No todas las implementaciones soportan los parámetros opcionales `i' y `j'. Estos parámetros permiten una búsqueda eficiente de partes de una secuencia. Usar estos parámetros es más o menos equivalente a usar @code{s[i:j].index(x)}, pero sin copiar ningún dato y con el valor de índice retornado como valor relativo al inicio de la secuencia, en vez de al inicio del segmento.
@end enumerate

@node Tipos de secuencia inmutables,Tipos de secuencia mutables,Operaciones comunes de las secuencias,Tipos secuencia — list tuple range
@anchor{library/stdtypes immutable-sequence-types}@anchor{21b7}@anchor{library/stdtypes typesseq-immutable}@anchor{21b8}
@subsubsection Tipos de secuencia inmutables


@geindex immutable;sequence;types
@geindex object;tuple
@geindex built-in function;hash

La única operación que las secuencias inmutables implementan generalmente, y que no esta definida también en las secuencias mutables, es el soporte para el cálculo de la función predefinida @ref{68b,,hash()}.

Este soporte permite usar secuencias inmutables, como por ejemplo las instancias de la clase @ref{464,,tuple}, como claves para diccionarios (@ref{190,,dict}), así como ser almacenadas en conjuntos (@ref{67a,,set}) o conjuntos congelados (@ref{67b,,frozenset}).

Intentar calcular el `hash' de una secuencia inmutable que contenga objetos mutables producirá una excepción de tipo @ref{228,,TypeError}.

@node Tipos de secuencia mutables,Listas<2>,Tipos de secuencia inmutables,Tipos secuencia — list tuple range
@anchor{library/stdtypes mutable-sequence-types}@anchor{21b9}@anchor{library/stdtypes typesseq-mutable}@anchor{2164}
@subsubsection Tipos de secuencia mutables


@geindex mutable;sequence;types
@geindex object;list
@geindex object;bytearray

Las operaciones de la siguiente tabla están definidas para todas los tipos de secuencia mutables. La clase ABC @ref{309,,collections.abc.MutableSequence} se incluye para facilitar la implementación correcta de un tipo de secuencia propio.

En la tabla, `s' es una instancia de una secuencia de tipo mutable, `t' es cualquier objeto iterable y `x' es un objeto arbitrario que cumple las restricciones de tipo y valor que vengan impuestas por `s' (como ejemplo, la clase @ref{5e0,,bytearray} solo acepta enteros que cumplan la condición @code{0 <= x <= 255}).

@geindex operations on;sequence;types
@geindex operations on;list;type
@geindex subscript;assignment
@geindex slice;assignment
@geindex statement;del
@geindex append() (sequence method)
@geindex clear() (sequence method)
@geindex copy() (sequence method)
@geindex extend() (sequence method)
@geindex insert() (sequence method)
@geindex pop() (sequence method)
@geindex remove() (sequence method)
@geindex reverse() (sequence method)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@tab

Notas

@item

@code{s[i] = x}

@tab

el elemento `i' de `s' es reemplazado por `x'

@tab

@item

@code{s[i:j] = t}

@tab

el segmento de valores de `s' que van de `i' a `j' es reemplazada por el contenido del iterador `t'

@tab

@item

@code{del s[i:j]}

@tab

equivalente a @code{s[i:j] = []}

@tab

@item

@code{s[i:j:k] = t}

@tab

los elementos de @code{s[i:j:k]} son reemplazados por los elementos de `t'

@tab

(1)

@item

@code{del s[i:j:k]}

@tab

borra los elementos de @code{s[i:j:k]} de la lista

@tab

@item

@code{s.append(x)}

@tab

añade `x' al final de la secuencia (equivale a @code{s[len(s):len(s)] = [x]})

@tab

@item

@code{s.clear()}

@tab

elimina todos los elementos de `s' (equivale a @code{del s[:]})

@tab

(5)

@item

@code{s.copy()}

@tab

crea una copia superficial de `s' (equivale a @code{s[:]})

@tab

(5)

@item

@code{s.extend(t)} o @code{s += t}

@tab

extiende `s' con los contenidos de `t' (en la mayoría de los casos equivale a @code{s[len(s):len(s)] = t})

@tab

@item

@code{s *= n}

@tab

actualiza `s' con su contenido repetido `n' veces

@tab

(6)

@item

@code{s.insert(i, x)}

@tab

inserta `x' en `s' en la posición indicada por el índice `i' (equivale a @code{s[i:i] = [x]})

@tab

@item

@code{s.pop()} o @code{s.pop(i)}

@tab

retorna el elemento en la posición indicada por `i', y a la vez lo elimina de la secuencia `s'

@tab

(2)

@item

@code{s.remove(x)}

@tab

removes the first item from
`s' where @code{s[i]} is equal to
`x'

@tab

(3)

@item

@code{s.reverse()}

@tab

invierte el orden de los elementos de `s', a nivel interno

@tab

(4)

@end multitable


Notas:


@enumerate 

@item 
If `k' is not equal to @code{1}, `t' must have the same length as the slice it is replacing.

@item 
El parámetro opcional `i' tiene un valor por defecto de @code{-1}, así que si no se especifica se retorna el último valor y este se elimina de la secuencia.

@item 
El método @code{remove()} lanza la excepción @ref{360,,ValueError} cuando no se encuentra `x' en `s'.

@item 
El método @code{reverse()} modifica la secuencia internamente, por motivos de eficiencia espacial para secuencias muy grandes. Como recordatorio al usuario de que el método produce un efecto secundario, no se retorna la secuencia invertida.

@item 
Ambos métodos @code{clear()} y @code{copy()} se incluyen por consistencia con las interfaces de clases que no soportan operaciones de segmentación (como las clases @ref{190,,dict} y @ref{67a,,set}). El método @code{copy()} no es parte de la clase ABC @ref{309,,collections.abc.MutableSequence}, pero la mayoría de las clases finales de tipo secuencia mutable lo incluyen.


Added in version 3.3: Los métodos @code{clear()} y @code{copy()}.


@item 
El valor de `n' es un entero, o un objeto que implemente el método @ref{22b,,__index__()}. Los valores negativos, junto con el cero, producen una lista vacía. Los elementos de la secuencia no son copiados, sino que se referencian múltiples veces, tal y como se explicó para @code{s * n} en @ref{21b3,,Operaciones comunes de las secuencias}.
@end enumerate

@node Listas<2>,Tuplas,Tipos de secuencia mutables,Tipos secuencia — list tuple range
@anchor{library/stdtypes lists}@anchor{21ba}@anchor{library/stdtypes typesseq-list}@anchor{217c}
@subsubsection Listas


@geindex object;list

Las listas son secuencia mutables, usadas normalmente para almacenar colecciones de elementos homogéneos (donde el grado de similitud de los mismos depende de la aplicación).

@geindex list (clase incorporada)
@anchor{library/stdtypes list}@anchor{18e}
@deffn {Clase} list ([iterable])

Las listas se pueden construir de diferentes formas:


@itemize *

@item 
Usando un par de corchetes para definir una lista vacía: @code{[]}

@item 
Usando corchetes, separando los elementos incluidos con comas: @code{[a]}, @code{[a, b, c]}

@item 
Usando una lista intensiva o por comprensión: @code{[x for x in iterable]}

@item 
Usando el constructor de tipo: @code{list()} o @code{list(iterable)}
@end itemize

La lista se construye con los mismos elementos y en el mismo orden que `iterable', donde `iterable' puede ser una secuencia, un contenedor que soporta iteración, o un objeto iterador. Si `iterable' es de por si una lista, se construye y retorna una copia, como si se hubiera llamado a @code{iterable[:]}. Por ejemplo, @code{list('abc')} retorna @code{['a', 'b', 'c']} y @code{list( (1, 2, 3) )} retorna @code{[1, 2, 3]}. Si no se pasan parámetros, se construye una nueva lista vacía, @code{[]}.

Muchas otras operaciones también producen listas, incluyendo la función incorporada @ref{c56,,sorted()}.

Las listas implementan todas las operaciones @ref{21b3,,comunes} y @ref{2164,,mutables} propias de las secuencias. Además, las listas incorporan los siguientes métodos:

@geindex sort() (método de list)
@anchor{library/stdtypes list sort}@anchor{c57}
@deffn {Método} sort (*, key=None, reverse=False)

Este método ordena la lista `in situ' (se modifica internamente), usando únicamente comparaciones de tipo @code{<}. Las excepciones no son capturadas internamente: si alguna comparación falla, la operación entera de ordenación falla (y la lista probablemente haya quedado modificada parcialmente).

El método @ref{c57,,sort()} acepta dos parámetros, que solo pueden pasarse por nombre (@ref{3f4,,keyword-only arguments}):

El parámetro `key' especifica una función de un argumento que se usa para obtener, para cada elemento de la lista, un valor concreto o clave (`key') a usar en las operaciones de comparación (por ejemplo, @code{key=str.lower}). El elemento clave para cada elemento se calcula una única vez y se reutiliza para todo el proceso de ordenamiento. El valor por defecto, @code{None}, hace que la lista se ordene comparando directamente los elementos, sin obtener valores clave.

La utilidad @ref{1247,,functools.cmp_to_key()} se puede usar para convertir una función `cmp' del estilo de la versión 2.x a una función `key'.

El valor de `reverse' es un valor booleano. Si se define como @code{True}, entonces los elementos de la lista se ordenan como si las operaciones de comparación se hubiesen invertido.

Este método modifica la lista `in situ', para ahorrar espacio cuando se ordena una secuencia muy grande. Para recordar a los usuarios que funciona de esta manera, no se retorna la secuencia ordenada (puedes usar @ref{c56,,sorted()} para obtener de forma explicita una nueva secuencia ordenada).

El método @ref{c57,,sort()} es estable. Un algoritmo de ordenación es estable si garantiza que no se cambia el orden relativo que mantienen inicialmente los elementos que se consideran iguales — esto es útil para realizar ordenaciones en múltiples fases (por ejemplo, ordenar por departamento y después por salario).

Para ver ejemplos de ordenación y un breve tutorial sobre el tema, véase @ref{2186,,Sorting Techniques}.

`Detalles de implementación de CPython:' Mientras una lista está siendo ordenada, los efectos de intentar modificarla, o incluso examinarla, no están definidos. La implementación en C de Python hace que la lista parezca vacía durante la ordenación, y lanza una excepción del tipo @ref{360,,ValueError} si detecta un cambio en la lista durante el proceso de ordenación.
@end deffn
@end deffn

@node Tuplas,Rangos,Listas<2>,Tipos secuencia — list tuple range
@anchor{library/stdtypes tuples}@anchor{21bb}@anchor{library/stdtypes typesseq-tuple}@anchor{20e6}
@subsubsection Tuplas


@geindex object;tuple

Las tuplas son secuencias inmutables, usadas normalmente para almacenar colecciones de datos heterogéneos (como las duplas o tuplas de dos elementos producidas por la función incorporada @ref{14bb,,enumerate()}). También son usadas en aquellos casos donde se necesite una secuencia inmutable de datos homogéneos (como por ejemplo permitir el almacenamiento en un objeto de tipo @ref{67a,,set} o @ref{190,,dict}).

@geindex tuple (clase incorporada)
@anchor{library/stdtypes tuple}@anchor{464}
@deffn {Clase} tuple ([iterable])

Las tuplas se pueden construir de diferentes maneras:


@itemize *

@item 
Usando un par de símbolos de paréntesis, para indicar una tupla vacía: @code{()}

@item 
Usando una coma al final, para crear una tupla de un único elemento: @code{a,} o @code{(a,)}

@item 
Separando los elementos por comas: @code{a, b, c} o @code{(a, b, c)}

@item 
Usando la función incorporada @ref{464,,tuple()}: @code{tuple()} o @code{tuple(iterable)}
@end itemize

El constructor genera una tupla cuyos elementos son los mismos y están en el mismo orden que los elementos del `iterable', donde `iterable' puede ser una secuencia, un contenedor que soporta iteración, o un objeto de tipo `iterator'. Si `iterable' es ya de por si una tupla, se retorna sin cambiar. Por ejemplo, @code{tuple('abc')} retorna @code{('a', 'b', 'c')} y @code{tuple( [1, 2, 3] )} retorna @code{(1, 2, 3)}. Si no se indica ningún parámetro, el constructor creará una nueva tupla vacía. @code{()}.

Nótese que es la coma la que realmente construye la tupla, no los paréntesis. Los paréntesis son opcionales, excepto en el caso de la tupla vacía, o cuando se necesitan para evitar una ambigüedad sintáctica. Por ejemplo, @code{f(a, b, c)} es una llamada a una función con tres parámetros, pero @code{f((a, b, c))} es una llamada a una función con un único parámetro, en este caso una tupla de tres elementos.

Las tuplas implementan todas las operaciones de secuencia @ref{21b3,,comunes}.
@end deffn

Para colecciones de datos heterogéneos donde el acceso por nombre resulta más claro que por índice, quizá crear una tupla con nombres (@ref{32d,,collections.namedtuple()}) pueden ser más apropiado.

@node Rangos,,Tuplas,Tipos secuencia — list tuple range
@anchor{library/stdtypes ranges}@anchor{21bc}@anchor{library/stdtypes typesseq-range}@anchor{2184}
@subsubsection Rangos


@geindex object;range

Los objetos de tipo @ref{9d6,,range} representan una secuencia inmutable de números y se usan habitualmente para ejecutar un bucle @ref{1eb,,for} un número determinado de veces.

@geindex range (clase incorporada)
@anchor{library/stdtypes range}@anchor{9d6}
@deffn {Clase} range (stop)

@deffnx {Clase} range (start, stop[, step])

Los parámetros usados por el constructor del rango deben ser números enteros (o bien objetos de tipo @ref{1f0,,int} o instancias de una clase que implemente el método especial @ref{22b,,__index__()}). Si el parámetro `step' se omite, se asume el valor @code{1}. Si se omite el parámetro @code{start}, se toma como @code{0}. Si `step' es cero, se lanza una excepción de tipo @ref{360,,ValueError}.

Para un valor positivo de `step', el contenido del rango @code{r} viene determinado por la fórmula @code{r[i] = start + step*i} donde @code{i >= 0} y @code{r[i] < stop}.

Para un valor negativo de `step', el contenido del rango sigue estando determinado por la fórmula @code{r[i] = start + step*i}, pero las restricciones ahora son @code{i >= 0} y @code{r[i] > stop}.

Un objeto de tipo rango se considera vacío si @code{r[0]} no cumple con las restricciones de valor. Los rangos soportan índices negativos, pero estos son interpretados como índices considerados desde el final de la secuencia determinada por los índices positivos.

Los rangos que contengan valores mayores que @ref{1232,,sys.maxsize} se permiten, pero algunas capacidades (como la función @ref{6cf,,len()}) pueden lanzar una excepción de tipo @ref{919,,OverflowError}.

Ejemplos de rangos:

@example
>>> list(range(10))
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> list(range(1, 11))
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> list(range(0, 30, 5))
[0, 5, 10, 15, 20, 25]
>>> list(range(0, 10, 3))
[0, 3, 6, 9]
>>> list(range(0, -10, -1))
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
>>> list(range(0))
[]
>>> list(range(1, 0))
[]
@end example

Los rangos implementan todas las operaciones @ref{21b3,,comunes} de las secuencias, excepto la concatenación y la repetición (esto es porque los objetos de tipo rango solamente pueden representar secuencias que siguen un patrón estricto, y tanto la repetición como la concatenación pueden romperlo).

@geindex start (atributo de range)
@anchor{library/stdtypes range start}@anchor{21bd}
@deffn {Atributo} start

El valor del parámetro `start' (@code{0} si no se utiliza el parámetro)
@end deffn

@geindex stop (atributo de range)
@anchor{library/stdtypes range stop}@anchor{21be}
@deffn {Atributo} stop

El valor del parámetro `stop'
@end deffn

@geindex step (atributo de range)
@anchor{library/stdtypes range step}@anchor{21bf}
@deffn {Atributo} step

El valor del parámetro `step' (@code{1} si no se utiliza el parámetro)
@end deffn
@end deffn

La ventaja de usar un objeto de tipo @ref{9d6,,range} en vez de uno de tipo @ref{18e,,list} o @ref{464,,tuple} es que con @ref{9d6,,range} siempre se usa una cantidad fija (y pequeña) de memoria, independientemente del rango que represente (ya que solamente necesita almacenar los valores para @code{start}, @code{stop} y @code{step}, y calcula los valores intermedios a medida que los va necesitando).

Los objetos rango implementan la clase ABC @ref{1231,,collections.abc.Sequence}, y proporcionan capacidades como comprobación de inclusión, búsqueda de elementos por índice, operaciones de segmentación y soporte de índices negativos (véase @ref{1c50,,Tipos secuencia — list@comma{} tuple@comma{} range}):

@example
>>> r = range(0, 20, 2)
>>> r
range(0, 20, 2)
>>> 11 in r
False
>>> 10 in r
True
>>> r.index(10)
5
>>> r[5]
10
>>> r[:5]
range(0, 10, 2)
>>> r[-1]
18
@end example

La comparación entre rangos usando los operadores @code{==} y @code{!=} se realiza como con las secuencias. Esto es, dos rangos se consideran iguales si representan exactamente la misma secuencia de elementos. (Fíjate que, según esta definición, dos rangos pueden considerarse iguales aunque tengan diferentes valores para @ref{21bd,,start}, @ref{21be,,stop} y @ref{21bf,,step}, por ejemplo @code{range(0) == range(2, 1, 3)} y @code{range(0, 3, 2) == range(0, 4, 2)}).


Distinto en la versión 3.2: Implementa la secuencia ABC. Soporta operaciones de segmentación e índices negativos. Comprueba si un entero de tipo @ref{1f0,,int} está incluido en un rango que se realiza en un tiempo constante, en lugar de iterar a través de todos los elementos.



Distinto en la versión 3.3: Define los operadores “==” y “!=” para comparar rangos en base a la secuencia de valores que definen (en vez de compararse en base a la identidad).

Added the @ref{21bd,,start}, @ref{21be,,stop} and @ref{21bf,,step}
attributes.



@subsubheading Ver también



@itemize *

@item 
The linspace recipe@footnote{https://code.activestate.com/recipes/579000-equally-spaced-numbers-linspace/}
shows how to implement a lazy version of range suitable for floating-point
applications.
@end itemize


@geindex string;text sequence type
@geindex str (built-in class);(see also string)
@geindex object;string

@node Cadenas de caracteres — str,Tipos de secuencias binarias — bytes bytearray y memoryview,Tipos secuencia — list tuple range,Tipos integrados
@anchor{library/stdtypes text-sequence-type-str}@anchor{21c0}@anchor{library/stdtypes textseq}@anchor{1c04}
@subsection Cadenas de caracteres — @code{str}


La información textual se representa en Python con objetos de tipo @ref{237,,str}, normalmente llamados cadenas de caracteres o simplemente `strings'. Las cadenas de caracteres son @ref{1c50,,secuencias} inmutables de puntos de código Unicode. Las cadenas se pueden definir de diferentes maneras:


@itemize *

@item 
Comillas simples: @code{'permite incluir comillas "dobles"'}

@item 
Comillas dobles: @code{"permite incluir comillas 'simples'"}

@item 
Triples comillas: ya sea con comillas simples @code{'@w{'}'Triples comillas simples'@w{'}'} o dobles @code{"""Triples comillas dobles"""}
@end itemize

Las cadenas definidas con comillas tripes pueden incluir varias líneas - todos los espacios en blancos incluidos se incorporan a la cadena de forma literal.

Cadenas literales que forman parte de una expresión y que solo estén separados por espacios en blanco, se convertirán implícitamente a una única cadena. Esto es, @code{("spam " "eggs") == "spam eggs"}.

See @ref{1ea4,,Literales de cadenas y bytes} for more about the various forms of string literal,
including supported @ref{505,,escape sequences}, and the @code{r} («raw») prefix that
disables most escape sequence processing.

Las cadenas de caracteres también se pueden crear usando el constructor @ref{237,,str}.

Como no hay un tipo separado para los «caracteres», indexar una cadena produce una cadena de longitud 1. Esto es, para una cadena de caracteres no vacía `s', @code{s[0] == s[0:1]}.

@geindex object;io.StringIO

Tampoco hay una versión mutable de las cadenas de caracteres, pero el método @ref{21b5,,str.join()} o la clase @ref{fa9,,io.StringIO} pueden usarse para construir de forma eficiente una cadena de caracteres a partir de fragmentos.


Distinto en la versión 3.3: Para facilitar la compatibilidad hacia atrás con la versión 2, el prefijo @code{u} se permite en las cadenas de caracteres. No tiene ningún efecto en la interpretación del literal y no se puede combinar con el prefijo @code{r}.


@geindex string;str (built-in class)

@geindex str (clase incorporada)
@anchor{library/stdtypes str}@anchor{237}
@deffn {Clase} str (object='@w{'})

@deffnx {Clase} str (object=b'@w{'}, encoding='utf-8', errors='strict')

Retorna una representación en forma de @ref{1c04,,cadena de caracteres} de `object'. Si no se proporciona ningún valor, retorna una cadena vacía. Si se proporciona, el comportamiento de @code{str()} depende de los valores pasados en los parámetros `encoding' y `errors', como veremos.

If neither `encoding' nor `errors' is given, @code{str(object)} returns
@ref{6be,,type(object).__str__(object)},
which is the «informal» or nicely
printable string representation of `object'.  For string objects, this is
the string itself.  If `object' does not have a @ref{6be,,__str__()}
method, then @ref{237,,str()} falls back to returning
@ref{894,,repr(object)}.

@geindex buffer protocol;str (built-in class)
@geindex bytes;str (built-in class)

Si se indica alguno de los dos parámetros `encoding' o `errors', entonces `object' debe ser un objeto binario o similar (@ref{db4,,bytes-like object}, es decir, una instancia de @ref{325,,bytes} o @ref{5e0,,bytearray}). En este caso, si `object' es de tipo @ref{325,,bytes} o @ref{5e0,,bytearray}, la llamada a @code{str(bytes, encoding, errors)} es equivalente a @ref{96d,,bytes.decode(encoding@comma{} errors)}. Si no, el objeto de tipo `bytes' que esta subyacente en el objeto `buffer' se obtiene mediante una llamada a @ref{96d,,bytes.decode()}. Véase @ref{2166,,Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview} y @ref{48a,,Protocolo búfer} para más información sobre los objetos `buffer'.

Si se pasa un objeto de tipo @ref{325,,bytes} a la función @ref{237,,str()} sin especificar o bien el parámetro `encoding' o bien el `errors', se vuelve al caso normal donde se retorna la representación informal de la cadena de caracteres (véase también la @ref{683,,-b} de las opciones de línea de órdenes de Python). Por ejemplo:

@example
>>> str(b'Zoot!')
"b'Zoot!'"
@end example

Para más información sobre la clase @code{str} y sus métodos, consulta @ref{1c04,,Cadenas de caracteres — str} y la sección @ref{1c05,,Métodos de las cadenas de caracteres} a continuación. Para las opciones de formateo de cadenas, lee las secciones @ref{a3b,,f-strings} y @ref{13f0,,Sintaxis de formateo de cadena}. También puedes consultar la sección @ref{21c1,,Servicios de procesamiento de texto}.
@end deffn

@geindex string;methods

@menu
* Métodos de las cadenas de caracteres:: 
* Formateo de cadenas al estilo *printf*:: 

@end menu

@node Métodos de las cadenas de caracteres,Formateo de cadenas al estilo *printf*,,Cadenas de caracteres — str
@anchor{library/stdtypes id5}@anchor{21c2}@anchor{library/stdtypes string-methods}@anchor{1c05}
@subsubsection Métodos de las cadenas de caracteres


@geindex module;re

Todas las cadenas de caracteres implementan las operaciones @ref{21b3,,comunes} de las secuencias, junto con los métodos descritos a continuación.

Las cadenas soportan dos estilos de formateo, uno proporciona un grado muy completo de flexibilidad y personalización (véase @ref{6c2,,str.format()}, @ref{13f0,,Sintaxis de formateo de cadena} y @ref{1c7f,,Formato de cadena de caracteres personalizado}) mientras que el otro se basa en la función C @code{printf}, que soporta un menor número de tipos y es ligeramente más complicada de usar, pero es a menudo más rápida para los casos que puede manejar (@ref{76d,,Formateo de cadenas al estilo *printf*}).

La sección @ref{21c3,,Servicios de procesamiento de texto} de la librería estándar cubre una serie de módulos que proporcionan varias utilidades para trabajar con textos (incluyendo las expresiones regulares en el módulo @ref{b9,,re}).

@geindex capitalize() (método de str)
@anchor{library/stdtypes str capitalize}@anchor{21c4}
@deffn {Método} str.capitalize ()

Retorna una copia de la cadena con el primer carácter en mayúsculas y el resto en minúsculas.


Distinto en la versión 3.8: El primer carácter se pasa ahora a título, más que a mayúsculas. Esto significa que caracteres como dígrafos solo tendrán la primera letra en mayúsculas, en vez de todo el carácter.

@end deffn

@geindex casefold() (método de str)
@anchor{library/stdtypes str casefold}@anchor{e5b}
@deffn {Método} str.casefold ()

Retorna el texto de la cadena, normalizado a minúsculas. Los textos así normalizados pueden usarse para realizar búsquedas textuales independientes de mayúsculas y minúsculas.

El texto normalizado a minúsculas es más agresivo que el texto en minúsculas normal, porque se intenta unificar todas las grafías distintas de la letras. Por ejemplo, en Alemán la letra minúscula @code{'ß'} equivale a @code{"ss"}. Como ya está en minúsculas, el método @ref{17f4,,lower()} no modifica @code{'ß'}, pero el método @ref{e5b,,casefold()} lo convertirá a @code{"ss"}.

The casefolding algorithm is
described in section 3.13 'Default Case Folding' of the Unicode Standard@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992}.


Added in version 3.3.

@end deffn

@geindex center() (método de str)
@anchor{library/stdtypes str center}@anchor{1c83}
@deffn {Método} str.center (width[, fillchar])

Retorna el texto de la cadena, centrado en una cadena de longitud `width'. El relleno a izquierda y derecha se realiza usando el carácter definido por el parámetro `fillchar' (por defecto se usa el carácter espacio ASCII). Si la cadena original tiene una longitud @code{len(s)} igual o superior a `width', se retorna el texto sin modificar.
@end deffn

@geindex count() (método de str)
@anchor{library/stdtypes str count}@anchor{1617}
@deffn {Método} str.count (sub[, start[, end]])

Retorna el número de ocurrencias no solapadas de la cadena `sub' en el rango [`start', `end']. Los parámetros opcionales `start' y `end' se interpretan como en una expresión de segmento.

If `sub' is empty, returns the number of empty strings between characters
which is the length of the string plus one.
@end deffn

@geindex encode() (método de str)
@anchor{library/stdtypes str encode}@anchor{96c}
@deffn {Método} str.encode (encoding='utf-8', errors='strict')

Return the string encoded to @ref{325,,bytes}.

`encoding' defaults to @code{'utf-8'};
see @ref{e3e,,Codificaciones estándar} for possible values.

`errors' controls how encoding errors are handled.
If @code{'strict'} (the default), a @ref{130f,,UnicodeError} exception is raised.
Other possible values are @code{'ignore'},
@code{'replace'}, @code{'xmlcharrefreplace'}, @code{'backslashreplace'} and any
other name registered via @ref{14d5,,codecs.register_error()}.
See @ref{17ed,,Manejadores de errores} for details.

For performance reasons, the value of `errors' is not checked for validity
unless an encoding error actually occurs,
@ref{356,,Modo de desarrollo de Python} is enabled
or a @ref{357,,debug build} is used.


Distinto en la versión 3.1: Añadido soporte para poder usar parámetros por nombre.



Distinto en la versión 3.9: The value of the `errors' argument is now checked in @ref{356,,Modo de desarrollo de Python} and
in @ref{357,,debug mode}.

@end deffn

@geindex endswith() (método de str)
@anchor{library/stdtypes str endswith}@anchor{f4d}
@deffn {Método} str.endswith (suffix[, start[, end]])

Retorna @code{True} si la cadena termina con el `suffix' especificado y @code{False} en caso contrario. También podemos usar `suffix' para pasar una tupla de sufijos a buscar. Si especificamos el parámetro opcional `start', la comprobación empieza en esa posición. Con el parámetro opcional `stop', la comprobación termina en esa posición.
@end deffn

@geindex expandtabs() (método de str)
@anchor{library/stdtypes str expandtabs}@anchor{21c5}
@deffn {Método} str.expandtabs (tabsize=8)

Retorna una copia de la cadena, con todos los caracteres de tipo tabulador reemplazados por uno o más espacios, dependiendo de la columna actual y del tamaño definido para el tabulador. Las posiciones de tabulación ocurren cada `tabsize' caracteres (siendo el valor por defecto de `tabsize' 8, lo que produce las posiciones de tabulación 0, 8, 16,…). Para expandir la cadena, la columna actual se pone a cero y se va examinando el texto carácter a carácter. Si se encuentra un tabulador, (@code{\t}), se insertan uno o más espacios hasta que sea igual a la siguiente posición de tabulación (El carácter tabulador en sí es descartado). Si el carácter en un indicador de salto de línea (@code{\n}) o de retorno (@code{\r}), se copia y el valor de columna actual se vuelve a poner a cero. Cualquier otro carácter es copiado sin cambios y hace que el contador de columna se incremente en 1, sin tener en cuenta como se representa gráficamente el carácter.

@example
>>> '01\t012\t0123\t01234'.expandtabs()
'01      012     0123    01234'
>>> '01\t012\t0123\t01234'.expandtabs(4)
'01  012 0123    01234'
@end example
@end deffn

@geindex find() (método de str)
@anchor{library/stdtypes str find}@anchor{f29}
@deffn {Método} str.find (sub[, start[, end]])

Retorna el menor índice de la cadena `s' donde se puede encontrar la cadena `sub', considerando solo el intervalo @code{s[start:end]}. Los parámetros opcionales `start' y `end' se interpretan como notación de segmento. Retorna @code{-1} si no se encuentra la cadena.

@cartouche
@quotation Nota 
El método @ref{f29,,find()} se debe usar solo si se necesita saber la posición de la cadena `sub'. Si solo se necesita comprobar si `sub' es una parte de `s', es mejor usar el operador @ref{1ed,,in}:

@example
>>> 'Py' in 'Python'
True
@end example
@end quotation
@end cartouche
@end deffn

@geindex format() (método de str)
@anchor{library/stdtypes str format}@anchor{6c2}
@deffn {Método} str.format (*args, **kwargs)

Realiza una operación de formateo. La cadena de caracteres sobre la que se está ejecutando este método puede contener texto literal y también marcas de reemplazo de texto definidas mediante llaves @code{@{@}}. Cada sección a reemplazar contiene o bien un índice numérico que hace referencia a un parámetro por posición, o el nombre de un parámetro por nombre. Retorna una copia de la cadena donde se han sustituido las marcas de reemplazo por los valores correspondientes pasados como parámetros.

@example
>>> "The sum of 1 + 2 is @{0@}".format(1+2)
'The sum of 1 + 2 is 3'
@end example

Véase @ref{13f0,,Sintaxis de formateo de cadena} para una descripción de las distintas opciones de formateo que se pueden usar.

@cartouche
@quotation Nota 
Cuando se formatea un número (@ref{1f0,,int}, @ref{153,,float}, @ref{154,,complex}, @ref{16a,,decimal.Decimal} y clases derivadas) usando la @code{n} (por ejemplo, @code{'@{:n@}'.format(1234)}), la función ajusta temporalmente el valor de la variable de entorno local @code{LC_TYPE} a @code{LC_NUMERIC} para decodificar los campos @code{decimal_point} y @code{thousands_sep} de la función @code{localeconv()}, si usan caracteres que no son ASCII o si ocupan más de un byte, y el valor definido en @code{LC_NUMERIC} es diferente del definido en @code{LC_CTYPE}. Estos cambios temporales pueden afectar a otros `threads'.
@end quotation
@end cartouche


Distinto en la versión 3.7: Cuando se formatea un número usando la @code{n}, la función puede asignar de forma temporal la variable @code{LC_CTYPE} a @code{LC_NUMERIC} en algunos casos.

@end deffn

@geindex format_map() (método de str)
@anchor{library/stdtypes str format_map}@anchor{e5c}
@deffn {Método} str.format_map (mapping, /)

Similar a @code{str.format(**mapping)}, pero se usa @code{mapping} de forma directa y no se copia a un diccionario. Esto es útil si @code{mapping} es, por ejemplo, una instancia de una subclase de @ref{190,,dict}:

@example
>>> class Default(dict):
...     def __missing__(self, key):
...         return key
...
>>> '@{name@} was born in @{country@}'.format_map(Default(name='Guido'))
'Guido was born in country'
@end example


Added in version 3.2.

@end deffn

@geindex index() (método de str)
@anchor{library/stdtypes str index}@anchor{1650}
@deffn {Método} str.index (sub[, start[, end]])

Como @ref{f29,,find()}, pero lanza una excepción de tipo @ref{360,,ValueError} si no se encuentra la cadena a buscar.
@end deffn

@geindex isalnum() (método de str)
@anchor{library/stdtypes str isalnum}@anchor{21c6}
@deffn {Método} str.isalnum ()

Retorna @code{True} si todos los caracteres de la cadena son alfanuméricos y hay, al menos, un carácter, en caso contrario, retorna @code{False}. Un carácter @code{c} se considera alfanumérico si alguna de las siguientes funciones retorna @code{True}: @code{c.isalpha()}, @code{c.isdecimal()}, @code{c.isdigit()} o @code{c.isnumeric()}.
@end deffn

@geindex isalpha() (método de str)
@anchor{library/stdtypes str isalpha}@anchor{21c7}
@deffn {Método} str.isalpha ()

Return @code{True} if all characters in the string are alphabetic and there is at least
one character, @code{False} otherwise.  Alphabetic characters are those characters defined
in the Unicode character database as «Letter», i.e., those with general category
property being one of «Lm», «Lt», «Lu», «Ll», or «Lo».  Note that this is different
from the Alphabetic property defined in the section 4.10 'Letters@comma{} Alphabetic@comma{} and Ideographic' of the Unicode Standard@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-4/#G91002}.
@end deffn

@geindex isascii() (método de str)
@anchor{library/stdtypes str isascii}@anchor{b7c}
@deffn {Método} str.isascii ()

Retorna @code{True} si la cadena de caracteres está vacía, o si todos los caracteres de la cadena son ASCII, en caso contrario, retorna @code{False}. Los caracteres ASCII son aquellos cuyos puntos de código Unicode que están en el rango U+0000-U+007F.


Added in version 3.7.

@end deffn

@geindex isdecimal() (método de str)
@anchor{library/stdtypes str isdecimal}@anchor{21c8}
@deffn {Método} str.isdecimal ()

Retorna @code{True} si todos los caracteres de la cadena son caracteres decimales y hay, al menos, un carácter, en caso contrario, retorna @code{False}. Los caracteres decimales son aquellos que se pueden usar para formar números en base 10, por ejemplo, U+0660, ARABIC-INDIC DIGIT ZERO. Formalmente, un carácter decimal es un carácter en la categoría general «@cite{Nd}» de Unicode.
@end deffn

@geindex isdigit() (método de str)
@anchor{library/stdtypes str isdigit}@anchor{21c9}
@deffn {Método} str.isdigit ()

Retorna @code{True} si todos los caracteres de la cadena son dígitos y hay, al menos, un carácter, en caso contrario, retorna @code{False}. Los dígitos incluyen los caracteres decimales y dígitos que requieren un tratamiento especial, como por ejemplo los usados para superíndices. Esto incluye dígitos que no pueden ser usados para formar números en base 10, como los números Kharosthi. Formalmente, un dígito es un carácter que tiene la propiedad @code{Numeric_Type} definida como @code{Digit} o @code{Decimal}.
@end deffn

@geindex isidentifier() (método de str)
@anchor{library/stdtypes str isidentifier}@anchor{1964}
@deffn {Método} str.isidentifier ()

Retorna @code{True} si la cadena de caracteres es un identificador válido de acuerdo a la especificación del lenguaje, véase @ref{1e94,,Identificadores y palabras clave}.

@ref{21ca,,keyword.iskeyword()} can be used to test whether string @code{s} is a reserved
identifier, such as @ref{1497,,def} and @ref{133f,,class}.

Ejemplo:

@example
>>> from keyword import iskeyword

>>> 'hello'.isidentifier(), iskeyword('hello')
(True, False)
>>> 'def'.isidentifier(), iskeyword('def')
(True, True)
@end example
@end deffn

@geindex islower() (método de str)
@anchor{library/stdtypes str islower}@anchor{21cb}
@deffn {Método} str.islower ()

Retorna @code{True} si todos los caracteres de la cadena que tengan formas en mayúsculas y minúsculas @footnote{
Los caracteres con versiones mayúsculas/minúsculas son aquellos cuya categoría general corresponde con «Lu» (Letra, Mayúscula), «Ll» (Letra, minúscula) o «Lt» (Letra, `titlecase').
} están en minúsculas y hay, al menos, un carácter de ese tipo, en caso contrario, retorna @code{False}.
@end deffn

@geindex isnumeric() (método de str)
@anchor{library/stdtypes str isnumeric}@anchor{21cc}
@deffn {Método} str.isnumeric ()

Retorna @code{True} si todos los caracteres de la cadena son caracteres numéricos y hay, al menos, un carácter, en caso contrario, retorna @code{False}. Los caracteres numéricos incluyen los dígitos, y todos los caracteres Unicode que tienen definida la propiedad de valor numérico, por ejemplo U+2155, VULGAR FRACTION ONE FIFTH. Formalmente, los caracteres numéricos son aquellos que la propiedad @code{Numeric_Type} definida como @code{Digit}, @code{Decimal} o @code{Numeric}.
@end deffn

@geindex isprintable() (método de str)
@anchor{library/stdtypes str isprintable}@anchor{e5d}
@deffn {Método} str.isprintable ()

Retorna @code{True} si todos los caracteres de la cadena son imprimibles o si la cadena está vacía, en caso contrario, retorna @code{False}. Los caracteres no imprimibles son aquellos definidos en la base de datos de Unicode como «`Other'» o «`Separator'», con la excepción del carácter ASCII espacio (0x20), que se considera imprimible. (Nótese que en este contexto, imprimible son aquellos caracteres que no necesitan ser escapados cuando se imprimen con la función @ref{894,,repr()}. No tiene relevancia en cadenas escritas a @ref{b61,,sys.stdout} o @ref{9cc,,sys.stderr}.)
@end deffn

@geindex isspace() (método de str)
@anchor{library/stdtypes str isspace}@anchor{21cd}
@deffn {Método} str.isspace ()

Retorna @code{True} si todos los caracteres de la cadena son espacios en blanco y hay, al menos, un carácter, en caso contrario, retorna @code{False}.

Un carácter se considera espacio en blanco si, en la base de datos de Unicode (véase @ref{105,,unicodedata}), está clasificado en la categoría general @code{Zs} («Separador, espacio») o la clase bidireccional es @code{WS}, @code{B} o @code{S}.
@end deffn

@geindex istitle() (método de str)
@anchor{library/stdtypes str istitle}@anchor{21ce}
@deffn {Método} str.istitle ()

Retorna @code{True} si las palabras en la cadena tiene forma de título y hay, al menos, un carácter, por ejemplo una mayúscula solo puede aparecer al principio o después de un carácter que no tenga formas alternativas mayúsculas-minúsculas, y las minúsculas solo después de carácter que si tiene formas alternativas mayúsculas-minúsculas. En caso contrario, retorna @code{False}.
@end deffn

@geindex isupper() (método de str)
@anchor{library/stdtypes str isupper}@anchor{21cf}
@deffn {Método} str.isupper ()

Retorna @code{True} si todos los caracteres de la cadena que tengan formas en mayúsculas y minúsculas @footnote{
Los caracteres con versiones mayúsculas/minúsculas son aquellos cuya categoría general corresponde con «Lu» (Letra, Mayúscula), «Ll» (Letra, minúscula) o «Lt» (Letra, `titlecase').
} están en mayúsculas y hay, al menos, un carácter de ese tipo, en caso contrario, retorna @code{False}.

@example
>>> 'BANANA'.isupper()
True
>>> 'banana'.isupper()
False
>>> 'baNana'.isupper()
False
>>> ' '.isupper()
False
@end example
@end deffn

@geindex join() (método de str)
@anchor{library/stdtypes meth-str-join}@anchor{21d0}@anchor{library/stdtypes str join}@anchor{21b5}
@deffn {Método} str.join (iterable)

Retorna una cadena de caracteres formada por la concatenación de las cadenas en el `iterable'. Se lanza una excepción de tipo @ref{228,,TypeError} si alguno de los elementos en el `iterable' no es una cadena, incluyendo objetos de tipo @ref{325,,bytes}. Se usa como separador entre los elementos la cadena de caracteres pasada como parámetro.
@end deffn

@geindex ljust() (método de str)
@anchor{library/stdtypes str ljust}@anchor{1c82}
@deffn {Método} str.ljust (width[, fillchar])

Retorna el texto de la cadena, justificado a la izquierda en una cadena de longitud `width'. El carácter de relleno a usar viene definido por el parámetro `fillchar' (por defecto se usa el carácter espacio ASCII). Si la cadena original tiene una longitud @code{len(s)} igual o superior a `width', se retorna el texto sin modificar.
@end deffn

@geindex lower() (método de str)
@anchor{library/stdtypes str lower}@anchor{17f4}
@deffn {Método} str.lower ()

Retorna una copia de la cadena de caracteres con todas las letras en minúsculas @footnote{
Los caracteres con versiones mayúsculas/minúsculas son aquellos cuya categoría general corresponde con «Lu» (Letra, Mayúscula), «Ll» (Letra, minúscula) o «Lt» (Letra, `titlecase').
}.

The lowercasing algorithm used is
described in section 3.13 'Default Case Folding' of the Unicode Standard@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992}.
@end deffn

@geindex lstrip() (método de str)
@anchor{library/stdtypes str lstrip}@anchor{14ec}
@deffn {Método} str.lstrip ([chars])

Retorna una copia de la cadena, eliminado determinados caracteres si se encuentren al principio. El parámetro `chars' especifica el conjunto de caracteres a eliminar. Si se omite o si se especifica @code{None}, se eliminan todos los espacios en blanco. No debe entenderse el valor de `chars' como un prefijo, sino que se elimina cualquier combinación de sus caracteres:

@example
>>> '   spacious   '.lstrip()
'spacious   '
>>> 'www.example.com'.lstrip('cmowz.')
'example.com'
@end example

Véase  @ref{966,,str.removeprefix()} para un método que removerá una única cadena de prefijo en lugar de todas las ocurrencias dentro de un set de caracteres. Por ejemplo:

@example
>>> 'Arthur: three!'.lstrip('Arthur: ')
'ee!'
>>> 'Arthur: three!'.removeprefix('Arthur: ')
'three!'
@end example
@end deffn

@geindex maketrans() (método estático de str)
@anchor{library/stdtypes str maketrans}@anchor{e5e}
@deffn {Método} static str.maketrans (x[, y[, z]])

Este método estático retorna una tabla de traducción apta para ser usada por el método @ref{21d1,,str.translate()}.

Si solo se usa un parámetro, este debe ser un diccionario que mapea valores de punto Unicode (enteros) o caracteres (cadenas de longitud 1) a valores Unicode, cadenas (de cualquier longitud) o @code{None}. Las claves se convertirán a ordinales.

Si se pasan dos parámetros, deben ser cadenas de la misma longitud, y en la tabla resultante, cada carácter en `x' se mapea al carácter en la misma posición en `y'. Si se añade un tercer parámetro, debe ser una cadena de caracteres, los cuales se mapearán a @code{None} en la tabla resultante.
@end deffn

@geindex partition() (método de str)
@anchor{library/stdtypes str partition}@anchor{f2c}
@deffn {Método} str.partition (sep)

Divide la cadena en la primera ocurrencia de `sep', y retorna una tupla de tres elementos, que contiene la parte anterior al separador, el separador en sí y la parte posterior al separador. Si no se encuentra el separador, retorna una tupla de tres elementos, el primero contiene la cadena original y los dos siguientes son cadenas vacías.
@end deffn

@geindex removeprefix() (método de str)
@anchor{library/stdtypes str removeprefix}@anchor{966}
@deffn {Método} str.removeprefix (prefix, /)

Si la cadena de caracteres empieza con la cadena `prefix', retorna @code{string[len(prefix):]}. De otra manera, retorna una copia de la cadena original:

@example
>>> 'TestHook'.removeprefix('Test')
'Hook'
>>> 'BaseTestCase'.removeprefix('Test')
'BaseTestCase'
@end example


Added in version 3.9.

@end deffn

@geindex removesuffix() (método de str)
@anchor{library/stdtypes str removesuffix}@anchor{967}
@deffn {Método} str.removesuffix (suffix, /)

Si la cadena de caracteres termina con la cadena `suffix' y `suffix' no está vacío, retorna @code{string[:-len(suffix)]}. De otra manera, retorna una copia de la cadena original:

@example
>>> 'MiscTests'.removesuffix('Tests')
'Misc'
>>> 'TmpDirMixin'.removesuffix('Tests')
'TmpDirMixin'
@end example


Added in version 3.9.

@end deffn

@geindex replace() (método de str)
@anchor{library/stdtypes str replace}@anchor{302}
@deffn {Método} str.replace (old, new, count=-1)

Return a copy of the string with all occurrences of substring `old' replaced by
`new'.  If `count' is given, only the first `count' occurrences are replaced.
If `count' is not specified or @code{-1}, then all occurrences are replaced.


Distinto en la versión 3.13: `count' is now supported as a keyword argument.

@end deffn

@geindex rfind() (método de str)
@anchor{library/stdtypes str rfind}@anchor{f2a}
@deffn {Método} str.rfind (sub[, start[, end]])

Retorna el mayor índice dentro de la cadena `s' donde se puede encontrar la cadena `sub', estando `sub' incluida en @code{s[start:end]}. Los parámetros opcionales `start' y `end' se interpretan igual que en las operaciones de segmentado. Retorna @code{-1} si no se encuentra `sub'.
@end deffn

@geindex rindex() (método de str)
@anchor{library/stdtypes str rindex}@anchor{12c5}
@deffn {Método} str.rindex (sub[, start[, end]])

Como el método @ref{f2a,,rfind()}, pero lanza la excepción @ref{360,,ValueError} si no se encuentra la cadena `sub'.
@end deffn

@geindex rjust() (método de str)
@anchor{library/stdtypes str rjust}@anchor{1c81}
@deffn {Método} str.rjust (width[, fillchar])

Retorna el texto de la cadena, justificado a la derecha en una cadena de longitud `width'. El carácter de relleno a usar viene definido por el parámetro `fillchar' (por defecto se usa el carácter espacio ASCII). Si `width' es menor o igual que @code{len(s)}, se retorna el texto sin modificar.
@end deffn

@geindex rpartition() (método de str)
@anchor{library/stdtypes str rpartition}@anchor{12c6}
@deffn {Método} str.rpartition (sep)

Divide la cadena en la última ocurrencia de `sep', y retorna una tupla de tres elementos, conteniendo la parte anterior al separador, el separador en sí y la parte posterior al separador. Si no se encuentra el separador, retorna una tupla de tres elementos, los dos primeras son posiciones con cadenas vacías y en la tercera la cadena original.
@end deffn

@geindex rsplit() (método de str)
@anchor{library/stdtypes str rsplit}@anchor{12c3}
@deffn {Método} str.rsplit (sep=None, maxsplit=-1)

Retorna una lista con las palabras que componen la cadena de caracteres original, usando como separador el valor de `sep'. Si se utiliza el parámetro `maxsplit', se realizan como máximo `maxsplit' divisiones, retornando los que están más a la derecha. Si no se especifica `sep' o se pasa con valor @code{None}, se usa como separador cualquier carácter de espacio en blanco. Si no contamos la diferencia de empezar las divisiones desde la derecha, el comportamiento de este método @ref{12c3,,rsplit()} es equivalente al de @ref{f2b,,split()}, que se describe con detalle más adelante.
@end deffn

@geindex rstrip() (método de str)
@anchor{library/stdtypes str rstrip}@anchor{14ed}
@deffn {Método} str.rstrip ([chars])

Retorna una copia de la cadena, eliminado determinados caracteres si se encuentren al final. El parámetro `chars' especifica el conjunto de caracteres a eliminar. Si se omite o si se especifica @code{None}, se eliminan todos los espacios en blanco. No debe entenderse el valor de `chars' como un sufijo, sino que se elimina cualquier combinación de sus caracteres:

@example
>>> '   spacious   '.rstrip()
'   spacious'
>>> 'mississippi'.rstrip('ipz')
'mississ'
@end example

Véase @ref{967,,str.removesuffix()} para un método que removerá una única cadena de sufijo en lugar de todas las ocurrencias dentro de un set de caracteres. Por ejemplo:

@example
>>> 'Monty Python'.rstrip(' Python')
'M'
>>> 'Monty Python'.removesuffix(' Python')
'Monty'
@end example
@end deffn

@geindex split() (método de str)
@anchor{library/stdtypes str split}@anchor{f2b}
@deffn {Método} str.split (sep=None, maxsplit=-1)

Retorna una lista con las palabras que componen la cadena de caracteres original, usando como separador el valor de `sep'. Si se utiliza el parámetro `maxsplit', se realizan como máximo `maxsplit' divisiones (por tanto, la lista resultante tendrá @code{maxsplit+1} elementos). Si no se especifica `maxsplit' o se pasa con valor @code{-1}, entonces no hay límite al número de divisiones a realizar (se harán todas las que se puedan).

If `sep' is given, consecutive delimiters are not grouped together and are
deemed to delimit empty strings (for example, @code{'1,,2'.split(',')} returns
@code{['1', '@w{'}, '2']}).  The `sep' argument may consist of multiple characters
as a single delimiter (to split with multiple delimiters, use
@ref{3f1,,re.split()}). Splitting an empty string with a specified separator
returns @code{['@w{'}]}.

Por ejemplo:

@example
>>> '1,2,3'.split(',')
['1', '2', '3']
>>> '1,2,3'.split(',', maxsplit=1)
['1', '2,3']
>>> '1,2,,3,'.split(',')
['1', '2', '@w{'}, '3', '@w{'}]
>>> '1<>2<>3<4'.split('<>')
['1', '2', '3<4']
@end example

Si no se especifica `sep' o es @code{None}, se usa un algoritmo de división diferente: secuencias consecutivas de caracteres de espacio en blanco se consideran como un único separador, y el resultado no contendrá cadenas vacías ni al principio ni al final de la lista, aunque la cadena original tuviera espacios en blanco al principio o al final. En consecuencia, dividir una cadena vacía o una cadena que solo contenga espacios en blanco usando @code{None} como separador siempre retornará una lista vacía @code{[]}.

Por ejemplo:

@example
>>> '1 2 3'.split()
['1', '2', '3']
>>> '1 2 3'.split(maxsplit=1)
['1', '2 3']
>>> '   1   2   3   '.split()
['1', '2', '3']
@end example
@end deffn

@geindex universal newlines;str.splitlines method

@geindex splitlines() (método de str)
@anchor{library/stdtypes str splitlines}@anchor{12c4}
@deffn {Método} str.splitlines (keepends=False)

Retorna una lista con las líneas en la cadena, dividiendo por los saltos de línea. Los caracteres de salto de línea en sí no se incluyen a no ser que se especifique lo contrario pasando el valor @code{True} en al parámetro `keepends'.

Este método considera como saltos de línea los siguientes caracteres. En concreto, estos son un superconjunto de los @ref{dc1,,saltos de líneas universales}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Representación

@tab

Descripción

@item

@code{\n}

@tab

Salto de línea

@item

@code{\r}

@tab

Retorno de carro

@item

@code{\r\n}

@tab

Retorno de carro + salto de línea

@item

@code{\v} o @code{\x0b}

@tab

Tabulación de línea

@item

@code{\f} o @code{\x0c}

@tab

Avance de página

@item

@code{\x1c}

@tab

Separador de archivo

@item

@code{\x1d}

@tab

Separador de grupo

@item

@code{\x1e}

@tab

Separador de registro

@item

@code{\x85}

@tab

Siguiente línea (Código de control C1)

@item

@code{\u2028}

@tab

Separador de línea

@item

@code{\u2029}

@tab

Separador de párrafo

@end multitable



Distinto en la versión 3.2: Se añadieron @code{\v} y @code{\f} a la lista de separadores.


Por ejemplo:

@example
>>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
['ab c', '@w{'}, 'de fg', 'kl']
>>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
['ab c\n', '\n', 'de fg\r', 'kl\r\n']
@end example

Al contrario que con @ref{f2b,,split()}, cuando se especifica una cadena con `sep', el método retorna una lista vacía para la cadena vacía, y un salto de línea al final del texto no produce una línea extra:

@example
>>> "".splitlines()
[]
>>> "One line\n".splitlines()
['One line']
@end example

Por comparación, @code{split('\n')} entrega:

@example
>>> '@w{'}.split('\n')
['@w{'}]
>>> 'Two lines\n'.split('\n')
['Two lines', '@w{'}]
@end example
@end deffn

@geindex startswith() (método de str)
@anchor{library/stdtypes str startswith}@anchor{f4c}
@deffn {Método} str.startswith (prefix[, start[, end]])

Retorna @code{True} si la cadena empieza por `prefix', en caso contrario retorna @code{False}. El valor de `prefix' puede ser también una tupla de prefijos por los que buscar. Con el parámetro opcional `start', la comprobación empieza en esa posición de la cadena. Con el parámetro opcional `end', la comprobación se detiene en esa posición de la cadena.
@end deffn

@geindex strip() (método de str)
@anchor{library/stdtypes str strip}@anchor{14eb}
@deffn {Método} str.strip ([chars])

Retorna una copia de la cadena con los caracteres indicados eliminados, tanto si están al principio como al final de la cadena. El parámetro opcional `chars' es una cadena que especifica el conjunto de caracteres a eliminar. Si se omite o se usa @code{None}, se eliminan los caracteres de espacio en blanco. No debe entenderse el valor de `chars' como un prefijo o sufijo, sino que se elimina cualquier combinación de sus caracteres:

@example
>>> '   spacious   '.strip()
'spacious'
>>> 'www.example.com'.strip('cmowz.')
'example'
@end example

Los caracteres indicados por `chars' se eliminan de los extremos al principio y al final de la cadena. Se elimina los caracteres del inicio hasta que se encuentra un carácter que no esté incluido en el conjunto definido por `chars'. Se procede de manera similar para los caracteres al final. Por ejemplo:

@example
>>> comment_string = '#....... Section 3.2.1 Issue #32 .......'
>>> comment_string.strip('.#! ')
'Section 3.2.1 Issue #32'
@end example
@end deffn

@geindex swapcase() (método de str)
@anchor{library/stdtypes str swapcase}@anchor{21d2}
@deffn {Método} str.swapcase ()

Retorna una copia de la cadena con los caracteres en mayúsculas convertidos a minúsculas, y viceversa. Nótese que no es necesariamente cierto que @code{s.swapcase().swapcase() == s}.
@end deffn

@geindex title() (método de str)
@anchor{library/stdtypes str title}@anchor{21d3}
@deffn {Método} str.title ()

Retorna una versión en forma de título de la cadena, con la primera letra de cada palabra en mayúsculas y el resto en minúsculas.

Por ejemplo:

@example
>>> 'Hello world'.title()
'Hello World'
@end example

El algoritmo usa una definición sencilla e independiente del lenguaje, consistente en considerar una palabra como un grupo de letras consecutivas. Esta definición funciona en varios entornos, pero implica que, por ejemplo en inglés, los apóstrofos en las contracciones y en los posesivos constituyen una separación entre palabras, que puede que no sea el efecto deseado:

@example
>>> "they're bill's friends from the UK".title()
"They'Re Bill'S Friends From The Uk"
@end example

La función @ref{21d4,,string.capwords()} no tiene este problema, ya que solo divide palabras en espacios.

Alternativamente, se puede solucionar parcialmente el problema de los apóstrofos usando expresiones regulares:

@example
>>> import re
>>> def titlecase(s):
...     return re.sub(r"[A-Za-z]+('[A-Za-z]+)?",
...                   lambda mo: mo.group(0).capitalize(),
...                   s)
...
>>> titlecase("they're bill's friends.")
"They're Bill's Friends."
@end example
@end deffn

@geindex translate() (método de str)
@anchor{library/stdtypes str translate}@anchor{21d1}
@deffn {Método} str.translate (table)

Return a copy of the string in which each character has been mapped through
the given translation table.  The table must be an object that implements
indexing via @ref{3d8,,__getitem__()}, typically a @ref{1229,,mapping} or
@ref{597,,sequence}.  When indexed by a Unicode ordinal (an integer), the
table object can do any of the following: return a Unicode ordinal or a
string, to map the character to one or more other characters; return
@code{None}, to delete the character from the return string; or raise a
@ref{21d5,,LookupError} exception, to map the character to itself.

Se puede usar @ref{e5e,,str.maketrans()} para crear un mapa de traducción carácter a carácter de diferentes formas.

Véase también el módulo @ref{1c,,codecs} para una aproximación más flexible al mapeo de caracteres.
@end deffn

@geindex upper() (método de str)
@anchor{library/stdtypes str upper}@anchor{21d6}
@deffn {Método} str.upper ()

Retorna una copia de la cadena, con todos los caracteres con formas mayúsculas/minúsculas @footnote{
Los caracteres con versiones mayúsculas/minúsculas son aquellos cuya categoría general corresponde con «Lu» (Letra, Mayúscula), «Ll» (Letra, minúscula) o «Lt» (Letra, `titlecase').
} pasados a mayúsculas. Nótese que @code{s.upper().isupper()} puede ser @code{False} si @code{s} contiene caracteres que no tengan las dos formas, o si la categoría Unicode del carácter o caracteres resultantes no es «Lu» (Letra, mayúsculas), sino, por ejemplo, «Lt» (Letra, Título).

The uppercasing algorithm used is
described in section 3.13 'Default Case Folding' of the Unicode Standard@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992}.
@end deffn

@geindex zfill() (método de str)
@anchor{library/stdtypes str zfill}@anchor{14ee}
@deffn {Método} str.zfill (width)

Retorna una copia de la cadena, rellena por la izquierda con dígitos @code{'0'} de ASCII necesarios para conseguir una cadena de longitud `width'. El carácter prefijo de signo (@code{'+'}/@code{'-'}) se gestiona insertando el relleno `después' del carácter de signo en vez de antes. Si `width' es menor o igual que @code{len(s)}, se retorna la cadena original.

Por ejemplo:

@example
>>> "42".zfill(5)
'00042'
>>> "-42".zfill(5)
'-0042'
@end example
@end deffn

@node Formateo de cadenas al estilo *printf*,,Métodos de las cadenas de caracteres,Cadenas de caracteres — str
@anchor{library/stdtypes old-string-formatting}@anchor{76d}@anchor{library/stdtypes printf-style-string-formatting}@anchor{21d7}
@subsubsection Formateo de cadenas al estilo @code{*printf*}


@geindex formatting@comma{} string (%)
@geindex interpolation@comma{} string (%)
@geindex string;formatting@comma{} printf
@geindex string;interpolation@comma{} printf
@geindex printf-style formatting
@geindex sprintf-style formatting
@geindex % (percent);printf-style formatting

@cartouche
@quotation Nota 
Las operaciones de formateo explicadas aquí tienen una serie de peculiaridades que conducen a ciertos errores comunes (como fallar al representar tuplas y diccionarios correctamente). Se pueden evitar estos errores usando las nuevas @ref{a3b,,cadenas de caracteres con formato}, el método @ref{6c2,,str.format()}, o @ref{21d8,,plantillas de cadenas de caracteres}. Cada una de estas alternativas proporcionan sus propios compromisos entre facilidad de uso, flexibilidad y capacidad de extensión.
@end quotation
@end cartouche

String objects have one unique built-in operation: the @code{%} operator (modulo).
This is also known as the string `formatting' or `interpolation' operator.
Given @code{format % values} (where `format' is a string), @code{%} conversion
specifications in `format' are replaced with zero or more elements of `values'.
The effect is similar to using the @code{sprintf()} function in the C language.
For example:

@example
>>> print('%s has %d quote types.' % ('Python', 2))
Python has 2 quote types.
@end example

Si `formato' tiene un único marcador, `valores' puede ser un objeto sencillo, no una tupla. @footnote{
Para formatear solo una tupla se debe, por tanto, usar una tupla conteniendo un único elemento, que sería la tupla a ser formateada.
} En caso contrario, `valores' debe ser una tupla con exactamente el mismo número de elementos que marcadores usados en la cadena de formato, o un único objeto de tipo mapa (por ejemplo, un diccionario).

@geindex () (parentheses);in printf-style formatting
@geindex * (asterisk);in printf-style formatting
@geindex . (dot);in printf-style formatting

Un especificador de conversión consiste en dos o más caracteres y tiene los siguientes componentes, que deben aparecer en el siguiente orden:


@enumerate 

@item 
El carácter @code{'%'}, que identifica el inicio del marcador.

@item 
Una clave de mapeo (opcional), consistente en una secuencia de caracteres entre paréntesis, como por ejemplo, @code{(somename)}.

@item 
Indicador de conversión (opcional), que afecta el resultado de ciertas conversiones de tipos.

@item 
Valor de ancho mínimo (opcional). Si se especifica un @code{'*'} (asterisco), el ancho real se lee del siguiente elemento de la tupla `valores', y el objeto a convertir viene después del ancho mínimo, con un indicador de precisión opcional.

@item 
Precisión (opcional), en la forma @code{'.'} (punto) seguido de la precisión. Si se especifica un @code{'*'} (asterisco), el valor de precisión real se lee del siguiente elemento de la tupla `valores', y el valor a convertir viene después de la precisión.

@item 
Modificador de longitud (opcional).

@item 
Tipo de conversión.
@end enumerate

Cuando el operador derecho es un diccionario (o cualquier otro objeto de tipo mapa), los marcadores en la cadena `deben' incluir un valor de clave entre paréntesis, inmediatamente después del carácter @code{'%'}. El valor de la clave se usa para seleccionar el valor a formatear desde el mapa. Por ejemplo:

@example
>>> print('%(language)s has %(number)03d quote types.' %
...       @{'language': "Python", "number": 2@})
Python has 002 quote types.
@end example

En este caso, no se puede usar el especificador @code{*} en la cadena de formato (dado que requiere una lista secuencial de parámetros).

Los indicadores de conversión son:

@geindex # (hash);in printf-style formatting
@geindex - (minus);in printf-style formatting
@geindex + (plus);in printf-style formatting
@geindex space;in printf-style formatting


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@item

@code{'#'}

@tab

El valor a convertir usara la «forma alternativa» (que se definirá más adelante)

@item

@code{'0'}

@tab

La conversión rellena con ceros por la izquierda para valores numéricos.

@item

@code{'-'}

@tab

El valor convertido se ajusta a la izquierda (sobreescribe la conversión @code{'0'} si se especifican los dos)

@item

@code{' '}

@tab

(Un espacio) Se debe añadir un espacio en blanco antes de un número positivo (o una cadena vacía) si se usa una conversión con signo.

@item

@code{'+'}

@tab

Un carácter signo (@code{'+'} o @code{'-'}) precede a la conversión (sobreescribe el indicador de «espacio»)

@end multitable


Puede estar presente un modificador de longitud (@code{h}, @code{l} o @code{L}), pero se ignora y no es necesario para Python – por lo que, por ejemplo, la salida de @code{%ld} es idéntica a @code{%d}.

Los tipos de conversión son:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Conversión

@tab

Significado

@tab

Notas

@item

@code{'d'}

@tab

Entero decimal con signo.

@tab

@item

@code{'i'}

@tab

Entero decimal con signo.

@tab

@item

@code{'o'}

@tab

Valor octal con signo.

@tab

(1)

@item

@code{'u'}

@tab

Obsoleto – es idéntico a @code{'d'}.

@tab

(6)

@item

@code{'x'}

@tab

Hexadecimal con signo (en minúsculas).

@tab

(2)

@item

@code{'X'}

@tab

Hexadecimal con signo (en mayúsculas).

@tab

(2)

@item

@code{'e'}

@tab

Floating-point exponential format (lowercase).

@tab

(3)

@item

@code{'E'}

@tab

Floating-point exponential format (uppercase).

@tab

(3)

@item

@code{'f'}

@tab

Floating-point decimal format.

@tab

(3)

@item

@code{'F'}

@tab

Floating-point decimal format.

@tab

(3)

@item

@code{'g'}

@tab

Floating-point format. Uses lowercase exponential
format if exponent is less than -4 or not less than
precision, decimal format otherwise.

@tab

(4)

@item

@code{'G'}

@tab

Floating-point format. Uses uppercase exponential
format if exponent is less than -4 or not less than
precision, decimal format otherwise.

@tab

(4)

@item

@code{'c'}

@tab

Un único carácter (acepta números enteros o cadenas de caracteres de longitud 1).

@tab

@item

@code{'r'}

@tab

Cadena de caracteres (representará cualquier objeto usando la función @ref{894,,repr()}).

@tab

(5)

@item

@code{'s'}

@tab

Cadena de caracteres (representará cualquier objeto usando la función @ref{237,,str()}).

@tab

(5)

@item

@code{'a'}

@tab

Cadena de caracteres (representará cualquier objeto usando la función @ref{1426,,ascii()}).

@tab

(5)

@item

@code{'%'}

@tab

No se representa ningún argumento, obteniéndose en el resultado la cadena @code{'%'}.

@tab

@end multitable


Notas:


@enumerate 

@item 
La forma alternativa hace que se inserte antes del primer dígito un prefijo indicativo del formato octal (@code{'0o'})

@item 
La forma alternativa hace que se inserte antes del primer dígito uno de los dos prefijos indicativos del formato hexadecimal @code{'0x'} o @code{'0X'} (que se use uno u otro depende de que indicador de formato se haya usado, @code{'x'} o @code{'X'}).

@item 
La forma alternativa hace que se incluya siempre el símbolo del punto o coma decimal, incluso si no hubiera dígitos después.

La precisión determina el número de dígitos que vienen después del punto decimal, y por defecto es 6.

@item 
La forma alternativa hace que se incluya siempre el símbolo del punto o coma decimal, y los ceros a su derecha no se eliminan, como seria el caso en la forma normal.

La precisión determina el número de dígitos significativos que vienen antes y después del punto decimal, y por defecto es 6.

@item 
Si la precisión es @code{N}, la salida se trunca a @code{N} caracteres.

@item 
Véase 
@geindex Python Enhancement Proposals; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}.
@end enumerate

Como en Python las cadenas de caracteres tiene una longitud explícita, la conversión de @code{%s} no requiere que la cadena termine con @code{'\0'}.

@c XXX Examples?


Distinto en la versión 3.1: Las conversiones @code{%f} para números con valores absolutos mayores que 1e50 ya no son reemplazadas por conversiones @code{%g}.


@geindex buffer protocol;binary sequence types

@node Tipos de secuencias binarias — bytes bytearray y memoryview,Conjuntos — set frozenset,Cadenas de caracteres — str,Tipos integrados
@anchor{library/stdtypes binary-sequence-types-bytes-bytearray-memoryview}@anchor{21d9}@anchor{library/stdtypes binaryseq}@anchor{2166}
@subsection Tipos de secuencias binarias — @code{bytes}, @code{bytearray} y @code{memoryview}


@geindex object;bytes
@geindex object;bytearray
@geindex object;memoryview
@geindex module;array

Los tipos básicos para trabajar con datos binarios son las clases @ref{325,,bytes} y @ref{5e0,,bytearray}. Ambas pueden ser usadas por la clase @ref{156,,memoryview}, que usa el @ref{48a,,protocolo buffer} para acceder a la memoria de otros objetos binarios sin necesidad de hacer una copia.

El módulo @ref{8,,array} soporta un almacenamiento eficiente de tipos de datos básicos como enteros de 32 bits o números en formato de doble precisión en coma flotante IEEE754.

@menu
* Objetos de tipo Bytes:: 
* Objetos de tipo Bytearray:: 
* Operaciones de bytes y bytearray:: 
* Usando el formateo tipo printf con bytes:: 
* Vistas de memoria:: 

@end menu

@node Objetos de tipo Bytes,Objetos de tipo Bytearray,,Tipos de secuencias binarias — bytes bytearray y memoryview
@anchor{library/stdtypes bytes-objects}@anchor{21da}@anchor{library/stdtypes typebytes}@anchor{2168}
@subsubsection Objetos de tipo Bytes


@geindex object;bytes

Los objetos `bytes' son secuencias inmutables de bytes. Como muchos de los protocolos binarios más usados se basan en la codificación ASCII para texto, los objetos `bytes' ofrecen varios métodos que solo son válidos cuando se trabaja con datos compatibles ASCII y son, en varios aspectos, muy cercanos a los cadenas de caracteres.

@geindex bytes (clase incorporada)
@anchor{library/stdtypes bytes}@anchor{325}
@deffn {Clase} bytes ([source[, encoding[, errors]]])

Para empezar, la sintaxis de los valores literales de `bytes' son prácticamente iguales que para las cadenas de caracteres, con la diferencia de que se añade el carácter @code{b} como prefijo:


@itemize *

@item 
Comillas sencillas: @code{b'Se siguen aceptando comillas "dobles" embebidas'}

@item 
Comillas dobles: @code{b"Se siguen aceptando comillas 'simples' embebidas"}

@item 
Comillas triples: @code{b'@w{'}'3 comillas simples'@w{'}'}, @code{b"""3 comillas dobles"""}
@end itemize

Solo se admiten caracteres ASCII en representaciones literales de `bytes' (con independencia del tipo de codificación declarado). Cualquier valor por encima de 127 debe ser definido usando su secuencia de escape.

Al igual que con las cadenas, los literales de `bytes' pueden usar el prefijo @code{r} para deshabilitar el procesado de las secuencias de escape. Véase @ref{1ea4,,Literales de cadenas y bytes} para más información acerca de los diferentes formas de expresar `bytes' de forma literal, incluyendo el soporte de secuencias de escape.

Aunque las secuencias de bytes y sus representaciones se basen en texto ASCII, los objetos `bytes' se comportan más como secuencias inmutables de números enteros, donde cada elemento de la secuencia está restringido a los valores de `x' tal que @code{0 <= x < 256} (si se intenta violar esta restricción se lanzará una excepción de tipo @ref{360,,ValueError}). Esto se ha hecho de forma intencionada para enfatizar que, aunque muchos formatos binarios incluyen elementos basados en caracteres ASCII y pueden ser manipulados mediante algunas técnicas de procesado de textos, este no es el caso general para los datos binarios (aplicar algoritmos pensados para proceso de textos a datos binarios que no se compatibles con ASCII normalmente corromperán dichos datos).

Además de con literales, se pueden crear objetos de tipo `byte' de las siguientes maneras:


@itemize *

@item 
Un secuencia de una longitud especificada rellena con ceros: @code{bytes(10)}

@item 
A partir de un iterable de números enteros: @code{bytes(range(20))}

@item 
Copiando datos binarios ya existentes mediante el protocolo `buffer': @code{bytes(obj)}
@end itemize

Véase además la función incorporada @ref{1ac0,,bytes}.

Como dos dígitos hexadecimales se corresponden exactamente con un byte, suelen usase números hexadecimales para describir datos binarios. Por ello, los objetos de tipo `byte' disponen de un método adicional para leer datos en ese formato:

@geindex fromhex() (método de clase de bytes)
@anchor{library/stdtypes bytes fromhex}@anchor{b7a}
@deffn {Método} classmethod fromhex (string)

Este método de clase de @ref{325,,bytes} retorna un objeto binario, decodificado a partir de la cadena suministrada como parámetro. La cadena de caracteres debe consistir en dos dígitos hexadecimales por cada byte, ignorándose los caracteres ASCII de espacio en blanco, si los hubiera.

@example
>>> bytes.fromhex('2Ef0 F1f2  ')
b'.\xf0\xf1\xf2'
@end example


Distinto en la versión 3.7: El método @ref{b7a,,bytes.fromhex()} ignora ahora todos los caracteres ASCII de espacio en blanco, no solo el carácter espacio.

@end deffn

Existe una función que realiza la operación inversa, es decir, transforma un objeto binario en una representación textual usando hexadecimal.

@geindex hex() (método de bytes)
@anchor{library/stdtypes bytes hex}@anchor{dee}
@deffn {Método} hex ([sep[, bytes_per_sep]])

Retorna una cadena de caracteres que contiene dos dígitos hexadecimales por cada byte de la instancia.

@example
>>> b'\xf0\xf1\xf2'.hex()
'f0f1f2'
@end example

Si quieres que la cadena en hexadecimal sea más fácil de leer, se puede especificar un único carácter separador con el parámetro `sep' para que se añada a la salida. Por defecto, este separador se incluirá entre cada byte. Un segundo parámetro opcional, `bytes_per_sep', controla los espacios. Valores positivos calculan la posición del separador desde la derecha, los negativos lo hacen desde la izquierda.

@example
>>> value = b'\xf0\xf1\xf2'
>>> value.hex('-')
'f0-f1-f2'
>>> value.hex('_', 2)
'f0_f1f2'
>>> b'UUDDLRLRAB'.hex(' ', -4)
'55554444 4c524c52 4142'
@end example


Added in version 3.5.



Distinto en la versión 3.8: El método @ref{dee,,bytes.hex()} ahora soporta los parámetros opcionales `sep' y `bytes_per_sep', que permiten insertar separadores entre los bytes de la cadena de salida.

@end deffn
@end deffn

Como los objetos de tipo `bytes' son secuencias de números enteros (similares a tuplas), para un objeto binario `b', @code{b[0]} retorna un entero, mientras que @code{b[0:1]} retorna un objeto de tipo `bytes' de longitud 1. (Mientras que las cadenas de caracteres siempre retornan una cadena de longitud 1, ya sea accediendo por índice o mediante una operación de segmentado).

La representación de los objetos tipo `bytes' usa el formato literal (@code{b'...'}) ya que es, por lo general, más útil que, digamos, @code{bytes([46, 46, 46])}. Siempre se puede convertir un objeto binario en una lista de enteros usando @code{list(b)}.

@node Objetos de tipo Bytearray,Operaciones de bytes y bytearray,Objetos de tipo Bytes,Tipos de secuencias binarias — bytes bytearray y memoryview
@anchor{library/stdtypes bytearray-objects}@anchor{21db}@anchor{library/stdtypes typebytearray}@anchor{2167}
@subsubsection Objetos de tipo `Bytearray'


@geindex object;bytearray

Los objetos de tipo @ref{5e0,,bytearray} son versiones mutables de los objetos de tipo @ref{325,,bytes}.

@geindex bytearray (clase incorporada)
@anchor{library/stdtypes bytearray}@anchor{5e0}
@deffn {Clase} bytearray ([source[, encoding[, errors]]])

No existe una sintaxis específica para crear objetos de tipo `bytearray', hay que crearlos siempre llamando a su constructor:


@itemize *

@item 
Creando una secuencia vacía: @code{bytearray()}

@item 
Creando una instancia de una longitud determinada, rellena con ceros: @code{bytearray(10)}

@item 
A partir de un iterable de números enteros: @code{bytearray(range(20))}

@item 
Copiando datos binarios ya existentes mediante el protocolo `buffer': @code{bytearray(b'Hi!')}
@end itemize

Como los objetos `bytearray' son mutables, soportan todas las operaciones aplicables a tipos @ref{2164,,mutables}, además de las operaciones propias de los `bytearrays' descritas en @ref{2165,,Operaciones de bytes y bytearray}.

Véase también la función incorporada @ref{1ac1,,bytearray}.

Como dos dígitos hexadecimales se corresponden exactamente con un byte, suelen usase números hexadecimales para describir datos binarios. Por ello, los objetos de tipo `bytearray' disponen de un método de clase adicional para leer datos en ese formato:

@geindex fromhex() (método de clase de bytearray)
@anchor{library/stdtypes bytearray fromhex}@anchor{b7b}
@deffn {Método} classmethod fromhex (string)

Este método de clase de @ref{5e0,,bytearray} retorna un objeto `bytearray', decodificado a partir de la cadena suministrada como parámetro. La cadena de caracteres debe consistir en dos dígitos hexadecimales por cada byte, ignorándose los caracteres ASCII de espacio en blanco, si los hubiera.

@example
>>> bytearray.fromhex('2Ef0 F1f2  ')
bytearray(b'.\xf0\xf1\xf2')
@end example


Distinto en la versión 3.7: El método @ref{b7b,,bytearray.fromhex()} ignora ahora todos los caracteres ASCII de espacio en blanco, no solo el carácter espacio.

@end deffn

Existe una función que realiza la operación inversa, es decir, transforma un objeto `bytearray' en una representación textual usando hexadecimal.

@geindex hex() (método de bytearray)
@anchor{library/stdtypes bytearray hex}@anchor{def}
@deffn {Método} hex ([sep[, bytes_per_sep]])

Retorna una cadena de caracteres que contiene dos dígitos hexadecimales por cada byte de la instancia.

@example
>>> bytearray(b'\xf0\xf1\xf2').hex()
'f0f1f2'
@end example


Added in version 3.5.



Distinto en la versión 3.8: De forma similar a @ref{dee,,bytes.hex()}, @ref{def,,bytearray.hex()} soporta ahora los parámetros opcionales `sep' y `bytes_per_sep' para insertar separadores entre los bytes en la cadena hexadecimal de salida.

@end deffn
@end deffn

Como los objetos de tipo `bytearray' son secuencias de números enteros (similares a listas), para un objeto `bytearray' `b', @code{b[0]} retorna un entero, mientras que @code{b[0:1]} retorna un objeto de tipo `bytearray' de longitud 1. (Mientras que las cadenas de caracteres siempre retornan una cadena de longitud 1, ya sea accediendo por índice o mediante una operación de segmentado).

La representación de los objetos tipo `bytearray' usa el formato literal (@code{bytearray(b'...')}) ya que es, por lo general, más útil que, digamos, @code{bytearray([46, 46, 46])}. Siempre se puede convertir un objeto `bytearray' en una lista de enteros usando @code{list(b)}.

@node Operaciones de bytes y bytearray,Usando el formateo tipo printf con bytes,Objetos de tipo Bytearray,Tipos de secuencias binarias — bytes bytearray y memoryview
@anchor{library/stdtypes bytes-and-bytearray-operations}@anchor{21dc}@anchor{library/stdtypes bytes-methods}@anchor{2165}
@subsubsection Operaciones de `bytes' y `bytearray'


@geindex bytes;methods
@geindex bytearray;methods

Ambos tipos, `bytes' y `bytearray' soportan las operaciones @ref{21b3,,comunes} de las secuencias. Los operadores no funcionan solo con operandos del mismo tipo, sino con cualquier @ref{db4,,objeto tipo binario}. Gracias a esta flexibilidad, estos tipos pueden combinarse libremente en expresiones sin que se produzcan errores. Sin embargo, el tipo del valor resultante puede depender del orden de los operandos.

@cartouche
@quotation Nota 
Los métodos de objetos de tipo `bytes' y `bytesarray' no aceptan cadenas de caracteres como parámetros, de la misma manera que los métodos de las cadenas tampoco aceptan `bytes' como parámetros. Por ejemplo, debes escribir:

@example
a = "abc"
b = a.replace("a", "f")
@end example

y:

@example
a = b"abc"
b = a.replace(b"a", b"f")
@end example
@end quotation
@end cartouche

Algunas operaciones de `bytes' y `bytearrays' asumen el uso de formatos binarios compatibles ASCII, y por tanto deben ser evitadas cuando trabajamos con datos binarios arbitrarios. Estas restricciones se explican a continuación.

@cartouche
@quotation Nota 
Usar estas operaciones basadas en ASCII para manipular datos binarios que no se almacenan en un formato basado en ASCII pueden producir corrupción de datos.
@end quotation
@end cartouche

Los siguientes métodos de `bytes' y `bytearrays' pueden ser usados con datos en formatos binarios arbitrarios.

@geindex count() (método de bytes)
@geindex count() (método de bytearray)
@anchor{library/stdtypes bytes count}@anchor{1618}
@deffn {Método} bytes.count (sub[, start[, end]])
@anchor{library/stdtypes bytearray count}@anchor{1619}
@deffnx {Método} bytearray.count (sub[, start[, end]])

Retorna el número de secuencias no solapadas de la subsecuencia `sub' en el rango [`start', `end']. Los parámetros opcionales `start' y `end' se interpretan como en las operaciones de segmentado.

La subsecuencia a buscar puede ser cualquier @ref{db4,,objeto tipo binario} o un número entero entre 0 y 255.

If `sub' is empty, returns the number of empty slices between characters
which is the length of the bytes object plus one.


Distinto en la versión 3.3: También acepta como subsecuencia un número entero entre 0 y 255.

@end deffn

@geindex removeprefix() (método de bytes)
@geindex removeprefix() (método de bytearray)
@anchor{library/stdtypes bytes removeprefix}@anchor{21dd}
@deffn {Método} bytes.removeprefix (prefix, /)
@anchor{library/stdtypes bytearray removeprefix}@anchor{21de}
@deffnx {Método} bytearray.removeprefix (prefix, /)

Si los datos binarios comienzan con la cadena `prefix', retorna @code{bytes[len(prefix):]}. De otra manera, retorna una copia de los datos binarios originales:

@example
>>> b'TestHook'.removeprefix(b'Test')
b'Hook'
>>> b'BaseTestCase'.removeprefix(b'Test')
b'BaseTestCase'
@end example

El argumento `prefix' puede ser cualquier @ref{db4,,objeto tipo binario}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex removesuffix() (método de bytes)
@geindex removesuffix() (método de bytearray)
@anchor{library/stdtypes bytes removesuffix}@anchor{21df}
@deffn {Método} bytes.removesuffix (suffix, /)
@anchor{library/stdtypes bytearray removesuffix}@anchor{21e0}
@deffnx {Método} bytearray.removesuffix (suffix, /)

Si los datos binarios terminan con la cadena expresada en `suffix' y el argumento `suffix' no está vacío, retorna @code{bytes[:-len(suffix)]}. De otra manera, retorna una copia de los datos binarios originales:

@example
>>> b'MiscTests'.removesuffix(b'Tests')
b'Misc'
>>> b'TmpDirMixin'.removesuffix(b'Tests')
b'TmpDirMixin'
@end example

El argumento `suffix' puede ser cualquier @ref{db4,,objeto tipo binario}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex decode() (método de bytes)
@geindex decode() (método de bytearray)
@anchor{library/stdtypes bytes decode}@anchor{96d}
@deffn {Método} bytes.decode (encoding='utf-8', errors='strict')
@anchor{library/stdtypes bytearray decode}@anchor{21e1}
@deffnx {Método} bytearray.decode (encoding='utf-8', errors='strict')

Return the bytes decoded to a @ref{237,,str}.

`encoding' defaults to @code{'utf-8'};
see @ref{e3e,,Codificaciones estándar} for possible values.

`errors' controls how decoding errors are handled.
If @code{'strict'} (the default), a @ref{130f,,UnicodeError} exception is raised.
Other possible values are @code{'ignore'}, @code{'replace'},
and any other name registered via @ref{14d5,,codecs.register_error()}.
See @ref{17ed,,Manejadores de errores} for details.

For performance reasons, the value of `errors' is not checked for validity
unless a decoding error actually occurs,
@ref{356,,Modo de desarrollo de Python} is enabled or a @ref{357,,debug build} is used.

@cartouche
@quotation Nota 
Passing the `encoding' argument to @ref{237,,str} allows decoding any
@ref{db4,,bytes-like object} directly, without needing to make a temporary
@code{bytes} or @code{bytearray} object.
@end quotation
@end cartouche


Distinto en la versión 3.1: Añadido soporte para poder usar parámetros por nombre.



Distinto en la versión 3.9: The value of the `errors' argument is now checked in @ref{356,,Modo de desarrollo de Python} and
in @ref{357,,debug mode}.

@end deffn

@geindex endswith() (método de bytes)
@geindex endswith() (método de bytearray)
@anchor{library/stdtypes bytes endswith}@anchor{21e2}
@deffn {Método} bytes.endswith (suffix[, start[, end]])
@anchor{library/stdtypes bytearray endswith}@anchor{21e3}
@deffnx {Método} bytearray.endswith (suffix[, start[, end]])

Retorna @code{True} si los datos binarios acaban con el valor indicado por `suffix', en caso contrario retorna @code{False}. El valor de `suffix' puede ser también una tupla de sufijos para buscar. Con el parámetro opcional `start', la comparación empieza a partir de esa posición. Si se especifica el parámetro opcional `end', la comparación termina en esa posición.

El sufijo (o sufijos) a buscar puede ser cualquier @ref{db4,,objeto tipo binario}.
@end deffn

@geindex find() (método de bytes)
@geindex find() (método de bytearray)
@anchor{library/stdtypes bytes find}@anchor{1844}
@deffn {Método} bytes.find (sub[, start[, end]])
@anchor{library/stdtypes bytearray find}@anchor{21e4}
@deffnx {Método} bytearray.find (sub[, start[, end]])

Retorna el mínimo índice dentro de los datos donde se ha encontrado la subsecuencia `sub', de forma que `sub' está contenida en el segmento @code{s[start:end]}. Los parámetros opcionales `start' y `end' se interpretan como en las operaciones de segmentado. Retorna @code{-1} si no se puede encontrar `sub'.

La subsecuencia a buscar puede ser cualquier @ref{db4,,objeto tipo binario} o un número entero entre 0 y 255.

@cartouche
@quotation Nota 
El método @ref{1844,,find()} se debe usar solo si se necesita saber la posición de `sub'. Si solo se necesita comprobar si `sub' es una parte de `s', es mejor usar el operador @ref{1ed,,in}:

@example
>>> b'Py' in b'Python'
True
@end example
@end quotation
@end cartouche


Distinto en la versión 3.3: También acepta como subsecuencia un número entero entre 0 y 255.

@end deffn

@geindex index() (método de bytes)
@geindex index() (método de bytearray)
@anchor{library/stdtypes bytes index}@anchor{21e5}
@deffn {Método} bytes.index (sub[, start[, end]])
@anchor{library/stdtypes bytearray index}@anchor{21e6}
@deffnx {Método} bytearray.index (sub[, start[, end]])

Como @ref{1844,,find()}, pero lanza una excepción de tipo @ref{360,,ValueError} si no se encuentra la subsecuencia a buscar.

La subsecuencia a buscar puede ser cualquier @ref{db4,,objeto tipo binario} o un número entero entre 0 y 255.


Distinto en la versión 3.3: También acepta como subsecuencia un número entero entre 0 y 255.

@end deffn

@geindex join() (método de bytes)
@geindex join() (método de bytearray)
@anchor{library/stdtypes bytes join}@anchor{21b6}
@deffn {Método} bytes.join (iterable)
@anchor{library/stdtypes bytearray join}@anchor{21e7}
@deffnx {Método} bytearray.join (iterable)

Retorna un objeto de tipo `bytes' o `bytearray' que es la concatenación de las secuencias binarias en `iterable'. Si alguno de los objetos de la secuencia no es un @ref{db4,,objeto tipo binario} se lanza la excepción @ref{228,,TypeError}, incluso si son cadenas de caracteres (objetos @ref{237,,str}). El separador entre los distintos elementos es el contenido del objeto `bytes' o `bytearray' usando para invocar el método.
@end deffn

@geindex maketrans() (método estático de bytes)
@geindex maketrans() (método estático de bytearray)
@anchor{library/stdtypes bytes maketrans}@anchor{12e2}
@deffn {Método} static bytes.maketrans (from, to)
@anchor{library/stdtypes bytearray maketrans}@anchor{12e3}
@deffnx {Método} static bytearray.maketrans (from, to)

Este método estático retorna una tabla de traducción apta para ser usada por el método @ref{21e8,,bytes.translate()}, que mapea cada carácter en `from' en la misma posición en `to'; tanto `from' como `to' deben ser @ref{db4,,objetos tipo binario} y deben tener la misma longitud.


Added in version 3.1.

@end deffn

@geindex partition() (método de bytes)
@geindex partition() (método de bytearray)
@anchor{library/stdtypes bytes partition}@anchor{21e9}
@deffn {Método} bytes.partition (sep)
@anchor{library/stdtypes bytearray partition}@anchor{21ea}
@deffnx {Método} bytearray.partition (sep)

Divide la secuencia en la primera ocurrencia de `sep', y retorna una tupla de tres elementos que contiene la parte antes del separador, el separador en sí o una copia de tipo `bytearray' y la parte después del separador. Si no se encuentra el separador, retorna una tupla de tres elementos, con la primera posición ocupada por la secuencia original, y las dos posiciones siguientes rellenas con objetos `bytes' o `bytearray' vacíos.

El separador a buscar puede ser cualquier @ref{db4,,objeto tipo binario}.
@end deffn

@geindex replace() (método de bytes)
@geindex replace() (método de bytearray)
@anchor{library/stdtypes bytes replace}@anchor{21eb}
@deffn {Método} bytes.replace (old, new[, count])
@anchor{library/stdtypes bytearray replace}@anchor{21ec}
@deffnx {Método} bytearray.replace (old, new[, count])

Retorna una copia de la secuencia con todas las ocurrencias de `old' sustituidas por `new'. Si se utiliza el parámetro `count', solo se cambian las primeras `count' ocurrencias.

La subsecuencia a buscar y su reemplazo puede ser cualquier @ref{db4,,objeto tipo binario}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex rfind() (método de bytes)
@geindex rfind() (método de bytearray)
@anchor{library/stdtypes bytes rfind}@anchor{1845}
@deffn {Método} bytes.rfind (sub[, start[, end]])
@anchor{library/stdtypes bytearray rfind}@anchor{21ed}
@deffnx {Método} bytearray.rfind (sub[, start[, end]])

Retorna el mayor índice dentro de la secuencia `s' donde se puede encontrar `sub', estando `sub' incluida en @code{s[start:end]}. Los parámetros opcionales `start' y `end' se interpretan igual que en las operaciones de segmentado. Retorna @code{-1} si no se encuentra `sub'.

La subsecuencia a buscar puede ser cualquier @ref{db4,,objeto tipo binario} o un número entero entre 0 y 255.


Distinto en la versión 3.3: También acepta como subsecuencia un número entero entre 0 y 255.

@end deffn

@geindex rindex() (método de bytes)
@geindex rindex() (método de bytearray)
@anchor{library/stdtypes bytes rindex}@anchor{21ee}
@deffn {Método} bytes.rindex (sub[, start[, end]])
@anchor{library/stdtypes bytearray rindex}@anchor{21ef}
@deffnx {Método} bytearray.rindex (sub[, start[, end]])

Como el método @ref{1845,,rfind()}, pero lanza la excepción @ref{360,,ValueError} si no se encuentra `sub'.

La subsecuencia a buscar puede ser cualquier @ref{db4,,objeto tipo binario} o un número entero entre 0 y 255.


Distinto en la versión 3.3: También acepta como subsecuencia un número entero entre 0 y 255.

@end deffn

@geindex rpartition() (método de bytes)
@geindex rpartition() (método de bytearray)
@anchor{library/stdtypes bytes rpartition}@anchor{21f0}
@deffn {Método} bytes.rpartition (sep)
@anchor{library/stdtypes bytearray rpartition}@anchor{21f1}
@deffnx {Método} bytearray.rpartition (sep)

Divide la secuencia en la primera ocurrencia de `sep', y retorna una tupla de tres elementos que contiene la parte antes del separador, el separador en sí o una copia de tipo `bytearray' y la parte después del separador. Si no se encuentra el separador, retorna una tupla de tres elementos, con las dos primeras posiciones rellenas con objetos `bytes' o `bytearray' vacíos, y la tercera posición ocupada por la secuencia original.

El separador a buscar puede ser cualquier @ref{db4,,objeto tipo binario}.
@end deffn

@geindex startswith() (método de bytes)
@geindex startswith() (método de bytearray)
@anchor{library/stdtypes bytes startswith}@anchor{21f2}
@deffn {Método} bytes.startswith (prefix[, start[, end]])
@anchor{library/stdtypes bytearray startswith}@anchor{21f3}
@deffnx {Método} bytearray.startswith (prefix[, start[, end]])

Retorna @code{True} si los datos binarios empiezan con el valor indicado por `prefix', en caso contrario retorna @code{False}. El valor de `prefix' puede ser también una tupla de prefijos para buscar. Con el parámetro opcional `start', la comparación empieza a partir de esa posición. Si se especifica el parámetro opcional `end', la comparación termina en esa posición.

El prefijo (o prefijos) a buscar puede ser cualquier @ref{db4,,objeto tipo binario}.
@end deffn

@geindex translate() (método de bytes)
@geindex translate() (método de bytearray)
@anchor{library/stdtypes bytes translate}@anchor{21e8}
@deffn {Método} bytes.translate (table, /, delete=b'@w{'})
@anchor{library/stdtypes bytearray translate}@anchor{1362}
@deffnx {Método} bytearray.translate (table, /, delete=b'@w{'})

Retorna una copia del objeto `bytes' o `bytearray' donde todas las ocurrencias de bytes especificados en el parámetro `delete' han sido borrados, y el resto han sido mapeados a través de la tabla de traducción indicada, que debe ser un objeto de tipo `bytes' con una longitud de 256 elementos.

Puedes usar el método @ref{12e2,,bytes.maketrans()} para crear la tabla de traducción.

Se puede ajustar el parámetro `table' a @code{None} para conseguir una traducción que solo borra caracteres:

@example
>>> b'read this short text'.translate(None, b'aeiou')
b'rd ths shrt txt'
@end example


Distinto en la versión 3.6: El parámetro `delete' se puede ahora especificar por nombre.

@end deffn

Los siguientes métodos de los objetos `bytes' y `bytearray' presentan un comportamiento por defecto que asume el uso de formatos binarios compatibles con ASCII, pero aun así pueden ser usados con datos binarios arbitrarios usando los parámetros apropiados. Nótese que todos los métodos de `bytearray' en esta sección nunca operan in situ, sino que siempre retornan objetos nuevos.

@geindex center() (método de bytes)
@geindex center() (método de bytearray)
@anchor{library/stdtypes bytes center}@anchor{21f4}
@deffn {Método} bytes.center (width[, fillbyte])
@anchor{library/stdtypes bytearray center}@anchor{21f5}
@deffnx {Método} bytearray.center (width[, fillbyte])

Retorna una copia del objeto centrado en una secuencia de longitud `width'. El relleno se realiza usando el valor definido en el parámetro `fillbyte' (por defecto, el carácter espacio en ASCII). Para los objetos de tipo @ref{325,,bytes}, se retorna la secuencia original intacta si `width' es menor o igual que @code{len(s)}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex ljust() (método de bytes)
@geindex ljust() (método de bytearray)
@anchor{library/stdtypes bytes ljust}@anchor{21f6}
@deffn {Método} bytes.ljust (width[, fillbyte])
@anchor{library/stdtypes bytearray ljust}@anchor{21f7}
@deffnx {Método} bytearray.ljust (width[, fillbyte])

Retorna una copia del objeto justificado por la izquierda en una secuencia de longitud `width'. El relleno se realiza usando el valor definido en el parámetro `fillbyte' (por defecto, el carácter espacio en ASCII). Para los objetos de tipo @ref{325,,bytes}, se retorna la secuencia original intacta si `width' es menor o igual que @code{len(s)}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex lstrip() (método de bytes)
@geindex lstrip() (método de bytearray)
@anchor{library/stdtypes bytes lstrip}@anchor{21f8}
@deffn {Método} bytes.lstrip ([chars])
@anchor{library/stdtypes bytearray lstrip}@anchor{21f9}
@deffnx {Método} bytearray.lstrip ([chars])

Retorna una copia de la secuencia con los caracteres iniciales especificados eliminados. El parámetro `chars' es una secuencia binaria que especifica el conjunto bytes a ser eliminados; el nombre hace referencia a que este método se usa normalmente con secuencias de caracteres ASCII. Si no se indica o si se especifica @code{None}, el comportamiento por defecto será eliminar los caracteres de espacio ASCII. No debe entenderse el valor de `chars' como un prefijo, sino que se elimina cualquier combinación de sus caracteres:

@example
>>> b'   spacious   '.lstrip()
b'spacious   '
>>> b'www.example.com'.lstrip(b'cmowz.')
b'example.com'
@end example

La secuencia binaria que especifica el conjunto bytes a ser eliminados puede ser cualquier @ref{db4,,objeto de tipo binario}. Véase @ref{21dd,,removeprefix()} para un método que removerá una única cadena de prefijo en lugar de todas las ocurrencias dentro de un set de caracteres. Por ejemplo:

@example
>>> b'Arthur: three!'.lstrip(b'Arthur: ')
b'ee!'
>>> b'Arthur: three!'.removeprefix(b'Arthur: ')
b'three!'
@end example

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex rjust() (método de bytes)
@geindex rjust() (método de bytearray)
@anchor{library/stdtypes bytes rjust}@anchor{21fa}
@deffn {Método} bytes.rjust (width[, fillbyte])
@anchor{library/stdtypes bytearray rjust}@anchor{21fb}
@deffnx {Método} bytearray.rjust (width[, fillbyte])

Retorna una copia del objeto justificado por la derecha en una secuencia de longitud `width'. El relleno se realiza usando el valor definido en el parámetro `fillbyte' (por defecto, el carácter espacio en ASCII). Para los objetos de tipo @ref{325,,bytes}, se retorna la secuencia original intacta si `width' es menor o igual que @code{len(s)}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex rsplit() (método de bytes)
@geindex rsplit() (método de bytearray)
@anchor{library/stdtypes bytes rsplit}@anchor{21fc}
@deffn {Método} bytes.rsplit (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray rsplit}@anchor{21fd}
@deffnx {Método} bytearray.rsplit (sep=None, maxsplit=-1)

Divide una secuencia binaria en subsecuencias del mismo tipo, usando como separador el valor de `sep'. Si se utiliza el parámetro `maxsplit', se realizan como máximo `maxsplit' divisiones, retornando los que están más a la derecha. Si no se especifica `sep' o se pasa con valor @code{None}, se usa como separador el carácter espacio en ASCII. Si no contamos la diferencia de empezar las divisiones desde la derecha, el comportamiento de este método @ref{21fd,,rsplit()} es equivalente al de @ref{21fe,,split()}, que se describe con detalle más adelante.
@end deffn

@geindex rstrip() (método de bytes)
@geindex rstrip() (método de bytearray)
@anchor{library/stdtypes bytes rstrip}@anchor{21ff}
@deffn {Método} bytes.rstrip ([chars])
@anchor{library/stdtypes bytearray rstrip}@anchor{2200}
@deffnx {Método} bytearray.rstrip ([chars])

Retorna una copia de la cadena, eliminado determinados bytes si se encuentren al final. El parámetro `chars' es una secuencia binaria que especifica el conjunto de bytes a eliminar; el nombre hace referencia a que este método se usa normalmente con secuencias de caracteres ASCII. Si se omite o si se especifica @code{None}, se eliminan los caracteres espacio en ASCII. No debe entenderse el valor de `chars' como un prefijo, sino que se elimina cualquier combinación de sus caracteres:

@example
>>> b'   spacious   '.rstrip()
b'   spacious'
>>> b'mississippi'.rstrip(b'ipz')
b'mississ'
@end example

La secuencia binaria que especifica el conjunto bytes a ser eliminados puede ser cualquier @ref{db4,,objeto de tipo binario}. Véase @ref{21df,,removesuffix()} para un método que removerá una única cadena de sufijo en lugar de todas las ocurrencias dentro de un set de caracteres. Por ejemplo:

@example
>>> b'Monty Python'.rstrip(b' Python')
b'M'
>>> b'Monty Python'.removesuffix(b' Python')
b'Monty'
@end example

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex split() (método de bytes)
@geindex split() (método de bytearray)
@anchor{library/stdtypes bytes split}@anchor{2201}
@deffn {Método} bytes.split (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray split}@anchor{21fe}
@deffnx {Método} bytearray.split (sep=None, maxsplit=-1)

Divide una secuencia binaria en subsecuencias del mismo tipo, usando como separador el valor de `sep'. Si se utiliza el parámetro `maxsplit' y es un número positivo, se realizan como máximo `maxsplit' divisiones (resultando en una secuencia de como mucho @code{maxsplit+1} elementos). Si no se especifica `maxsplit' o se pasa @code{'-1}, no hay límite al número de divisiones (se hacen todas las posibles divisiones).

If `sep' is given, consecutive delimiters are not grouped together and are
deemed to delimit empty subsequences (for example, @code{b'1,,2'.split(b',')}
returns @code{[b'1', b'@w{'}, b'2']}).  The `sep' argument may consist of a
multibyte sequence as a single delimiter. Splitting an empty sequence with
a specified separator returns @code{[b'@w{'}]} or @code{[bytearray(b'@w{'})]} depending
on the type of object being split.  The `sep' argument may be any
@ref{db4,,bytes-like object}.

Por ejemplo:

@example
>>> b'1,2,3'.split(b',')
[b'1', b'2', b'3']
>>> b'1,2,3'.split(b',', maxsplit=1)
[b'1', b'2,3']
>>> b'1,2,,3,'.split(b',')
[b'1', b'2', b'@w{'}, b'3', b'@w{'}]
>>> b'1<>2<>3<4'.split(b'<>')
[b'1', b'2', b'3<4']
@end example

Si no se especifica `sep' o es @code{None}, se usa un algoritmo de división diferente: secuencias consecutivas de caracteres de espacio en ASCII se consideran como un único separador, y el resultado no contendrá cadenas vacías ni al principio ni al final de la lista, aunque la cadena original tuviera espacios en blanco al principio o al final. En consecuencia, dividir una secuencia vacía o que solo contenga espacios en blanco usando @code{None} como separador siempre retornará una lista vacía @code{[]}.

Por ejemplo:

@example
>>> b'1 2 3'.split()
[b'1', b'2', b'3']
>>> b'1 2 3'.split(maxsplit=1)
[b'1', b'2 3']
>>> b'   1   2   3   '.split()
[b'1', b'2', b'3']
@end example
@end deffn

@geindex strip() (método de bytes)
@geindex strip() (método de bytearray)
@anchor{library/stdtypes bytes strip}@anchor{2202}
@deffn {Método} bytes.strip ([chars])
@anchor{library/stdtypes bytearray strip}@anchor{2203}
@deffnx {Método} bytearray.strip ([chars])

Retorna una copia de la secuencia con los bytes indicados eliminados, tanto si están al principio como al final de la cadena. El parámetro opcional `chars' es una secuencia de bytes que especifica el conjunto de caracteres a eliminar; el nombre hace referencia a que este método se usa normalmente con secuencias de caracteres ASCII. Si se omite o se usa @code{None}, se eliminan los caracteres de espacio ASCII. No debe entenderse el valor de `chars' como un prefijo o sufijo, sino que se elimina cualquier combinación de sus valores:

@example
>>> b'   spacious   '.strip()
b'spacious'
>>> b'www.example.com'.strip(b'cmowz.')
b'example'
@end example

La secuencia binaria de bytes a eliminar debe ser un @ref{db4,,objeto tipo binario}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

Los siguientes métodos de los objetos `bytes' y `bytearray' asumen el uso de formatos binarios compatibles con ASCII, y no deben ser usados con datos binarios arbitrarios. Nótese que todos los métodos de `bytearray' en esta sección nunca operan in situ, sino que siempre retornan objetos nuevos.

@geindex capitalize() (método de bytes)
@geindex capitalize() (método de bytearray)
@anchor{library/stdtypes bytes capitalize}@anchor{2204}
@deffn {Método} bytes.capitalize ()
@anchor{library/stdtypes bytearray capitalize}@anchor{2205}
@deffnx {Método} bytearray.capitalize ()

Retorna una copia de la secuencia con cada byte interpretado como un carácter ASCII, y el primer byte en mayúsculas y el resto en minúsculas. Los valores que no sean ASCII no se ven modificados.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex expandtabs() (método de bytes)
@geindex expandtabs() (método de bytearray)
@anchor{library/stdtypes bytes expandtabs}@anchor{2206}
@deffn {Método} bytes.expandtabs (tabsize=8)
@anchor{library/stdtypes bytearray expandtabs}@anchor{2207}
@deffnx {Método} bytearray.expandtabs (tabsize=8)

Retorna una copia de la secuencia, con todos los caracteres ASCII `tab' reemplazados por uno o más espacios ASCII, dependiendo de la columna actual y del tamaño definido para el tabulador. Las posiciones de tabulación ocurren cada `tabsize' caracteres (siendo el valor por defecto de `tabsize' 8, lo que produce las posiciones de tabulación 0, 8, 16,…). Para expandir la secuencia, la columna actual se pone a cero y se va examinando byte a byte. Si se encuentra un tabulador, (@code{b'\t'}), se insertan uno o más espacios hasta que sea igual a la siguiente posición de tabulación. (El carácter tabulador en sí es descartado). Si el byte es un indicador de salto de línea (@code{b'\n'}) o de retorno (@code{b'\r'}), se copia y el valor de columna actual se vuelve a poner a cero. Cualquier otro carácter es copiado sin cambios y hace que el contador de columna se incremente en 1, sin tener en cuenta como se representa impreso el byte:

@example
>>> b'01\t012\t0123\t01234'.expandtabs()
b'01      012     0123    01234'
>>> b'01\t012\t0123\t01234'.expandtabs(4)
b'01  012 0123    01234'
@end example

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex isalnum() (método de bytes)
@geindex isalnum() (método de bytearray)
@anchor{library/stdtypes bytes isalnum}@anchor{2208}
@deffn {Método} bytes.isalnum ()
@anchor{library/stdtypes bytearray isalnum}@anchor{2209}
@deffnx {Método} bytearray.isalnum ()

Retorna @code{True} si todos los bytes de la secuencia son caracteres alfabéticos ASCII o caracteres decimales ASCII y la secuencia no está vacía, en cualquier otro caso retorna @code{False}. Los caracteres alfabéticos ASCII son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'}. Los caracteres decimales ASCII son los bytes incluidos en la secuencia @code{b'0123456789'}.

Por ejemplo:

@example
>>> b'ABCabc1'.isalnum()
True
>>> b'ABC abc1'.isalnum()
False
@end example
@end deffn

@geindex isalpha() (método de bytes)
@geindex isalpha() (método de bytearray)
@anchor{library/stdtypes bytes isalpha}@anchor{220a}
@deffn {Método} bytes.isalpha ()
@anchor{library/stdtypes bytearray isalpha}@anchor{220b}
@deffnx {Método} bytearray.isalpha ()

Retorna @code{True} si todos los bytes de la secuencia son caracteres alfabéticos ASCII y la secuencia no está vacía, en cualquier otro caso retorna @code{False}. Los caracteres alfabéticos ASCII son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

Por ejemplo:

@example
>>> b'ABCabc'.isalpha()
True
>>> b'ABCabc1'.isalpha()
False
@end example
@end deffn

@geindex isascii() (método de bytes)
@geindex isascii() (método de bytearray)
@anchor{library/stdtypes bytes isascii}@anchor{220c}
@deffn {Método} bytes.isascii ()
@anchor{library/stdtypes bytearray isascii}@anchor{220d}
@deffnx {Método} bytearray.isascii ()

Retorna @code{True} si la secuencia está vacía o si todos los bytes de la secuencia son caracteres ASCII, en cualquier otro caso retorna @code{False}. Los caracteres ASCII son los bytes incluidos en el rango 0-0x7F.


Added in version 3.7.

@end deffn

@geindex isdigit() (método de bytes)
@geindex isdigit() (método de bytearray)
@anchor{library/stdtypes bytes isdigit}@anchor{220e}
@deffn {Método} bytes.isdigit ()
@anchor{library/stdtypes bytearray isdigit}@anchor{220f}
@deffnx {Método} bytearray.isdigit ()

Retorna @code{True} si todos los bytes de la secuencia son caracteres decimales ASCII y la secuencia no está vacía, en cualquier otro caso retorna @code{False}. Los caracteres decimales ASCII son los bytes incluidos en la secuencia @code{b'0123456789'}.

Por ejemplo:

@example
>>> b'1234'.isdigit()
True
>>> b'1.23'.isdigit()
False
@end example
@end deffn

@geindex islower() (método de bytes)
@geindex islower() (método de bytearray)
@anchor{library/stdtypes bytes islower}@anchor{2210}
@deffn {Método} bytes.islower ()
@anchor{library/stdtypes bytearray islower}@anchor{2211}
@deffnx {Método} bytearray.islower ()

Retorna @code{True} si hay al menos un carácter ASCII en minúsculas, y no hay ningún carácter ASCII en mayúsculas, en cualquier otro caso retorna @code{False}.

Por ejemplo:

@example
>>> b'hello world'.islower()
True
>>> b'Hello world'.islower()
False
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.
@end deffn

@geindex isspace() (método de bytes)
@geindex isspace() (método de bytearray)
@anchor{library/stdtypes bytes isspace}@anchor{2212}
@deffn {Método} bytes.isspace ()
@anchor{library/stdtypes bytearray isspace}@anchor{2213}
@deffnx {Método} bytearray.isspace ()

Retorna @code{True} si todos los bytes de la secuencia son caracteres ASCII de espacio en blanco y la secuencia no está vacía, en cualquier otro caso retorna @code{False}. Los caracteres de espacio en blanco ASCII son los bytes incluidos en la secuencia @code{b' \t\n\r\x0b\f'} (espacio, tabulador, nueva línea, retorno de carro, tabulador vertical y avance de página).
@end deffn

@geindex istitle() (método de bytes)
@geindex istitle() (método de bytearray)
@anchor{library/stdtypes bytes istitle}@anchor{2214}
@deffn {Método} bytes.istitle ()
@anchor{library/stdtypes bytearray istitle}@anchor{2215}
@deffnx {Método} bytearray.istitle ()

Retorna @code{True} si la secuencia ASCII está en forma de título, y la secuencia no está vacía, en cualquier otro caso retorna @code{False}. Véase el método @ref{2216,,bytes.title()} para más detalles en la definición de «En forma de título».

Por ejemplo:

@example
>>> b'Hello World'.istitle()
True
>>> b'Hello world'.istitle()
False
@end example
@end deffn

@geindex isupper() (método de bytes)
@geindex isupper() (método de bytearray)
@anchor{library/stdtypes bytes isupper}@anchor{2217}
@deffn {Método} bytes.isupper ()
@anchor{library/stdtypes bytearray isupper}@anchor{2218}
@deffnx {Método} bytearray.isupper ()

Retorna @code{True} si hay al menos un carácter ASCII en mayúsculas, y no hay ningún carácter ASCII en minúsculas, en cualquier otro caso retorna @code{False}.

Por ejemplo:

@example
>>> b'HELLO WORLD'.isupper()
True
>>> b'Hello world'.isupper()
False
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.
@end deffn

@geindex lower() (método de bytes)
@geindex lower() (método de bytearray)
@anchor{library/stdtypes bytes lower}@anchor{2219}
@deffn {Método} bytes.lower ()
@anchor{library/stdtypes bytearray lower}@anchor{221a}
@deffnx {Método} bytearray.lower ()

Retorna una copia de la secuencia con todos los caracteres ASCII en mayúsculas sustituidos por su versión correspondiente en minúsculas.

Por ejemplo:

@example
>>> b'Hello World'.lower()
b'hello world'
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex universal newlines;bytes.splitlines method
@geindex universal newlines;bytearray.splitlines method

@geindex splitlines() (método de bytes)
@geindex splitlines() (método de bytearray)
@anchor{library/stdtypes bytes splitlines}@anchor{221b}
@deffn {Método} bytes.splitlines (keepends=False)
@anchor{library/stdtypes bytearray splitlines}@anchor{221c}
@deffnx {Método} bytearray.splitlines (keepends=False)

Retorna una lista de las líneas en la secuencia binaria, usando como separadores los @ref{dc1,,saltos de líneas universales}. Los caracteres usados como separadores no se incluyen en la lista de resultados a no ser que se pase el parámetro `keepends' a @code{True}.

Por ejemplo:

@example
>>> b'ab c\n\nde fg\rkl\r\n'.splitlines()
[b'ab c', b'@w{'}, b'de fg', b'kl']
>>> b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
[b'ab c\n', b'\n', b'de fg\r', b'kl\r\n']
@end example

Al contrario que el método @ref{2201,,split()}, cuando se especifica una cadena delimitadora con el parámetro `sep', este método retorna una lista vacía para la cadena vacía, y un carácter de salto de línea al final de la secuencia no resulta en una línea extra:

@example
>>> b"".split(b'\n'), b"Two lines\n".split(b'\n')
([b'@w{'}], [b'Two lines', b'@w{'}])
>>> b"".splitlines(), b"One line\n".splitlines()
([], [b'One line'])
@end example
@end deffn

@geindex swapcase() (método de bytes)
@geindex swapcase() (método de bytearray)
@anchor{library/stdtypes bytes swapcase}@anchor{221d}
@deffn {Método} bytes.swapcase ()
@anchor{library/stdtypes bytearray swapcase}@anchor{221e}
@deffnx {Método} bytearray.swapcase ()

Retorna una copia de la secuencia con todos los caracteres ASCII en minúsculas sustituidos por su versión correspondiente en mayúsculas, y viceversa.

Por ejemplo:

@example
>>> b'Hello World'.swapcase()
b'hELLO wORLD'
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

Unlike @ref{21d2,,str.swapcase()}, it is always the case that
@code{bin.swapcase().swapcase() == bin} for the binary versions. Case
conversions are symmetrical in ASCII, even though that is not generally
true for arbitrary Unicode code points.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex title() (método de bytes)
@geindex title() (método de bytearray)
@anchor{library/stdtypes bytes title}@anchor{2216}
@deffn {Método} bytes.title ()
@anchor{library/stdtypes bytearray title}@anchor{221f}
@deffnx {Método} bytearray.title ()

Retorna una versión en forma de título de la secuencia binaria, con la primera letra de cada palabra en mayúsculas y el resto en minúsculas. Los valores de bytes sin mayúsculas y minúsculas se dejan sin modificar.

Por ejemplo:

@example
>>> b'Hello world'.title()
b'Hello World'
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}. El resto de los caracteres no presentan diferencias entre mayúsculas y minúsculas.

El algoritmo usa una definición sencilla e independiente del lenguaje, consistente en considerar una palabra como un grupo de letras consecutivas. Esta definición funciona en varios entornos, pero implica que, por ejemplo en inglés, los apóstrofos en las contracciones y en los posesivos constituyen una separación entre palabras, que puede que no sea el efecto deseado:

@example
>>> b"they're bill's friends from the UK".title()
b"They'Re Bill'S Friends From The Uk"
@end example

Se puede solucionar parcialmente el problema de los apóstrofos usando expresiones regulares:

@example
>>> import re
>>> def titlecase(s):
...     return re.sub(rb"[A-Za-z]+('[A-Za-z]+)?",
...                   lambda mo: mo.group(0)[0:1].upper() +
...                              mo.group(0)[1:].lower(),
...                   s)
...
>>> titlecase(b"they're bill's friends.")
b"They're Bill's Friends."
@end example

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex upper() (método de bytes)
@geindex upper() (método de bytearray)
@anchor{library/stdtypes bytes upper}@anchor{2220}
@deffn {Método} bytes.upper ()
@anchor{library/stdtypes bytearray upper}@anchor{2221}
@deffnx {Método} bytearray.upper ()

Retorna una copia de la secuencia con todos los caracteres ASCII en minúsculas sustituidos por su versión correspondiente en mayúsculas.

Por ejemplo:

@example
>>> b'Hello World'.upper()
b'HELLO WORLD'
@end example

Los caracteres ASCII en minúsculas son los bytes incluidos en la secuencia @code{b'abcdefghijklmnopqrstuvwxyz'}. Los caracteres ASCII en mayúsculas son los bytes en la secuencia @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@geindex zfill() (método de bytes)
@geindex zfill() (método de bytearray)
@anchor{library/stdtypes bytes zfill}@anchor{2222}
@deffn {Método} bytes.zfill (width)
@anchor{library/stdtypes bytearray zfill}@anchor{2223}
@deffnx {Método} bytearray.zfill (width)

Retorna una copia de la secuencia rellenada por la izquierda con los caracteres ASCII @code{b'0'} necesarios para conseguir una cadena de longitud `width'. El carácter prefijo de signo (@code{b'+'}/@code{b'-'}) se gestiona insertando el relleno `después' del carácter de signo en vez de antes. Para objetos @ref{325,,bytes}, se retorna la secuencia original si `width' es menor o igual que @code{len(s)}.

Por ejemplo:

@example
>>> b"42".zfill(5)
b'00042'
>>> b"-42".zfill(5)
b'-0042'
@end example

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche
@end deffn

@node Usando el formateo tipo printf con bytes,Vistas de memoria,Operaciones de bytes y bytearray,Tipos de secuencias binarias — bytes bytearray y memoryview
@anchor{library/stdtypes bytes-formatting}@anchor{e06}@anchor{library/stdtypes printf-style-bytes-formatting}@anchor{2224}
@subsubsection Usando el formateo tipo @code{printf} con bytes


@geindex formatting;bytes (%)
@geindex formatting;bytearray (%)
@geindex interpolation;bytes (%)
@geindex interpolation;bytearray (%)
@geindex bytes;formatting
@geindex bytearray;formatting
@geindex bytes;interpolation
@geindex bytearray;interpolation
@geindex printf-style formatting
@geindex sprintf-style formatting
@geindex % (percent);printf-style formatting

@cartouche
@quotation Nota 
Las operaciones de formateo explicadas aquí tienen una serie de peculiaridades que conducen a ciertos errores comunes (como fallar al representar tuplas y diccionarios correctamente). Si el valor a representar es una tupla o un diccionario, hay que envolverlos en una tupla.
@end quotation
@end cartouche

Los objetos binarios (@code{bytes}/@code{bytearray}) tienen una operación incorporada: el operador @code{%} (módulo). Esta operación se conoce también como operador de `formateo' o de `interpolación'. Dada la expresión @code{formato % valores} (donde `formato' es un objeto binario), las especificaciones de conversión indicadas en la cadena con el símbolo @code{%} son reemplazadas por cero o más elementos de `valores'. El efecto es similar a usar la función del lenguaje C @code{sprintf()}.

Si `formato' tiene un único marcador, `valores' puede ser un objeto sencillo, no una tupla. @footnote{
Para formatear solo una tupla se debe, por tanto, usar una tupla conteniendo un único elemento, que sería la tupla a ser formateada.
} En caso contrario, `valores' debe ser una tupla con exactamente el mismo número de elementos que marcadores usados en el objeto binario, o un único objeto de tipo mapa (por ejemplo, un diccionario).

@geindex () (parentheses);in printf-style formatting
@geindex * (asterisk);in printf-style formatting
@geindex . (dot);in printf-style formatting

Un especificador de conversión consiste en dos o más caracteres y tiene los siguientes componentes, que deben aparecer en el siguiente orden:


@enumerate 

@item 
El carácter @code{'%'}, que identifica el inicio del marcador.

@item 
Una clave de mapeo (opcional), consistente en una secuencia de caracteres entre paréntesis, como por ejemplo, @code{(somename)}.

@item 
Indicador de conversión (opcional), que afecta el resultado de ciertas conversiones de tipos.

@item 
Valor de ancho mínimo (opcional). Si se especifica un @code{'*'} (asterisco), el ancho real se lee del siguiente elemento de la tupla `valores', y el objeto a convertir viene después del ancho mínimo, con un indicador de precisión opcional.

@item 
Precisión (opcional), en la forma @code{'.'} (punto) seguido de la precisión. Si se especifica un @code{'*'} (asterisco), el valor de precisión real se lee del siguiente elemento de la tupla `valores', y el valor a convertir viene después de la precisión.

@item 
Modificador de longitud (opcional).

@item 
Tipo de conversión.
@end enumerate

Cuando el argumento derecho es un diccionario (o cualquier otro objeto de tipo mapa), los marcadores en el objeto binario `deben' incluir un valor de clave entre paréntesis, inmediatamente después del carácter @code{'%'}. El valor de la clave se usa para seleccionar el valor a formatear desde el mapa. Por ejemplo:

@example
>>> print(b'%(language)s has %(number)03d quote types.' %
...       @{b'language': b"Python", b"number": 2@})
b'Python has 002 quote types.'
@end example

En este caso, no se puede usar el especificador @code{*} en la cadena de formato (dado que requiere una lista secuencial de parámetros).

Los indicadores de conversión son:

@geindex # (hash);in printf-style formatting
@geindex - (minus);in printf-style formatting
@geindex + (plus);in printf-style formatting
@geindex space;in printf-style formatting


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@item

@code{'#'}

@tab

El valor a convertir usara la «forma alternativa» (que se definirá más adelante)

@item

@code{'0'}

@tab

La conversión rellena con ceros por la izquierda para valores numéricos.

@item

@code{'-'}

@tab

El valor convertido se ajusta a la izquierda (sobreescribe la conversión @code{'0'} si se especifican los dos)

@item

@code{' '}

@tab

(Un espacio) Se debe añadir un espacio en blanco antes de un número positivo (o una cadena vacía) si se usa una conversión con signo.

@item

@code{'+'}

@tab

Un carácter signo (@code{'+'} o @code{'-'}) precede a la conversión (sobreescribe el indicador de «espacio»)

@end multitable


Puede estar presente un modificador de longitud (@code{h}, @code{l} o @code{L}), pero se ignora y no es necesario para Python – por lo que, por ejemplo, la salida de @code{%ld} es idéntica a @code{%d}.

Los tipos de conversión son:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Conversión

@tab

Significado

@tab

Notas

@item

@code{'d'}

@tab

Entero decimal con signo.

@tab

@item

@code{'i'}

@tab

Entero decimal con signo.

@tab

@item

@code{'o'}

@tab

Valor octal con signo.

@tab

(1)

@item

@code{'u'}

@tab

Obsoleto – es idéntico a @code{'d'}.

@tab

(8)

@item

@code{'x'}

@tab

Hexadecimal con signo (en minúsculas).

@tab

(2)

@item

@code{'X'}

@tab

Hexadecimal con signo (en mayúsculas).

@tab

(2)

@item

@code{'e'}

@tab

Floating-point exponential format (lowercase).

@tab

(3)

@item

@code{'E'}

@tab

Floating-point exponential format (uppercase).

@tab

(3)

@item

@code{'f'}

@tab

Floating-point decimal format.

@tab

(3)

@item

@code{'F'}

@tab

Floating-point decimal format.

@tab

(3)

@item

@code{'g'}

@tab

Floating-point format. Uses lowercase exponential
format if exponent is less than -4 or not less than
precision, decimal format otherwise.

@tab

(4)

@item

@code{'G'}

@tab

Floating-point format. Uses uppercase exponential
format if exponent is less than -4 or not less than
precision, decimal format otherwise.

@tab

(4)

@item

@code{'c'}

@tab

Byte único (acepta números enteros o binarios de un único byte).

@tab

@item

@code{'b'}

@tab

Bytes (any object that follows the
@ref{48a,,buffer protocol} or has
@ref{688,,__bytes__()}).

@tab

(5)

@item

@code{'s'}

@tab

@code{'s'} es un alias de @code{'b'} y solo debe ser usado para bases de código Python2/3.

@tab

(6)

@item

@code{'a'}

@tab

Bytes (convierte cualquier objeto Python usando @code{repr(obj).encode('ascii','backslashreplace')}).

@tab

(5)

@item

@code{'r'}

@tab

@code{'r'} es un alias de @code{'a'} y solo debe ser usado para bases de código Python2/3.

@tab

(7)

@item

@code{'%'}

@tab

No se representa ningún argumento, obteniéndose en el resultado la cadena @code{'%'}.

@tab

@end multitable


Notas:


@enumerate 

@item 
La forma alternativa hace que se inserte antes del primer dígito un prefijo indicativo del formato octal (@code{'0o'})

@item 
La forma alternativa hace que se inserte antes del primer dígito uno de los dos prefijos indicativos del formato hexadecimal @code{'0x'} o @code{'0X'} (que se use uno u otro depende de que indicador de formato se haya usado, @code{'x'} o @code{'X'}).

@item 
La forma alternativa hace que se incluya siempre el símbolo del punto o coma decimal, incluso si no hubiera dígitos después.

La precisión determina el número de dígitos que vienen después del punto decimal, y por defecto es 6.

@item 
La forma alternativa hace que se incluya siempre el símbolo del punto o coma decimal, y los ceros a su derecha no se eliminan, como seria el caso en la forma normal.

La precisión determina el número de dígitos significativos que vienen antes y después del punto decimal, y por defecto es 6.

@item 
Si la precisión es @code{N}, la salida se trunca a @code{N} caracteres.

@item 
@code{b'%s'} está obsoleto, pero no se retirará durante la serie 3.x.

@item 
@code{b'%r'} está obsoleto, pero no se retirará durante la serie 3.x.

@item 
Véase 
@geindex Python Enhancement Proposals; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}.
@end enumerate

@cartouche
@quotation Nota 
La versión `bytearray' de este método `no' opera in situ - siempre produce un nuevo objeto, aún si no se hubiera realizado ningún cambio.
@end quotation
@end cartouche


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} - Añadiendo % formatea a bytes y bytearray



Added in version 3.5.


@node Vistas de memoria,,Usando el formateo tipo printf con bytes,Tipos de secuencias binarias — bytes bytearray y memoryview
@anchor{library/stdtypes memory-views}@anchor{2225}@anchor{library/stdtypes typememoryview}@anchor{217d}
@subsubsection Vistas de memoria


Los objetos de tipo @ref{156,,memoryview} permiten al código Python acceder a los datos internos de objetos que soporten el @ref{48a,,protocolo buffer} sin necesidad de hacer copias.

@geindex memoryview (clase incorporada)
@anchor{library/stdtypes memoryview}@anchor{156}
@deffn {Clase} memoryview (object)

Crea un @ref{156,,memoryview} que referencia `object'. La variable `object' debe soportar el protocolo buffer. Los objetos incorporados que soportan el protocolo buffer incluyen los @ref{325,,bytes} y @ref{5e0,,bytearray}.

La clase @ref{156,,memoryview} usa el concepto de `elemento', que es la unidad de memoria atómica gestionada por el objeto original `object'. Para muchos tipos de datos simples como @ref{325,,bytes} y @ref{5e0,,bytearray}, un elemento es un único byte, pero otros tipos, como la clase @ref{308,,array.array} pueden tener elementos más grandes.

@code{len(view)} is equal to the length of @ref{2226,,tolist}, which
is the nested list representation of the view. If @code{view.ndim = 1},
this is equal to the number of elements in the view.


Distinto en la versión 3.12: If @code{view.ndim == 0}, @code{len(view)} now raises @ref{228,,TypeError} instead of returning 1.


The @ref{2227,,itemsize} attribute will give you the number of
bytes in a single element.

Un objeto de tipo @ref{156,,memoryview} soporta operaciones de segmentado y acceso por índices a sus datos. Un segmentado unidimensional producirá una sub-vista:

@example
>>> v = memoryview(b'abcefg')
>>> v[1]
98
>>> v[-1]
103
>>> v[1:4]
<memory at 0x7f3ddc9f4350>
>>> bytes(v[1:4])
b'bce'
@end example

Si @ref{2228,,format} es uno de los especificadores de formato nativos del módulo @ref{d5,,struct}, el indexado con un número entero o una tupla de números enteros también es posible, y retorna un único `elemento' con el tipo adecuado. Objetos `memoryview' unidimensionales pueden ser indexados con un entero o con una tupla de enteros. Los `memoryview' con múltiples dimensiones pueden ser indexados con tuplas de exactamente `ndim' enteros, donde `ndim' es el número de dimensiones. Vistas `memoryviews' con cero dimensiones pueden ser indexados con una tupla vacía.

Aquí hay un ejemplo con un formato que no es un byte:

@example
>>> import array
>>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444])
>>> m = memoryview(a)
>>> m[0]
-11111111
>>> m[-1]
44444444
>>> m[::2].tolist()
[-11111111, -33333333]
@end example

Si el objeto usado para crear la vista es modificable, la vista `memoryview' soporta asignación unidimensional mediante segmentos. Sin embargo, no se permite el cambio de tamaño:

@example
>>> data = bytearray(b'abcefg')
>>> v = memoryview(data)
>>> v.readonly
False
>>> v[0] = ord(b'z')
>>> data
bytearray(b'zbcefg')
>>> v[1:4] = b'123'
>>> data
bytearray(b'z123fg')
>>> v[2:3] = b'spam'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: memoryview assignment: lvalue and rvalue have different structures
>>> v[2:6] = b'spam'
>>> data
bytearray(b'z1spam')
@end example

One-dimensional memoryviews of @ref{6b1,,hashable} (read-only) types with formats
“B”, “b” or “c” are also hashable. The hash is defined as
@code{hash(m) == hash(m.tobytes())}:

@example
>>> v = memoryview(b'abcefg')
>>> hash(v) == hash(b'abcefg')
True
>>> hash(v[2:4]) == hash(b'ce')
True
>>> hash(v[::-2]) == hash(b'abcefg'[::-2])
True
@end example


Distinto en la versión 3.3: One-dimensional memoryviews can now be sliced.
One-dimensional memoryviews with formats “B”, “b” or “c” are now @ref{6b1,,hashable}.



Distinto en la versión 3.4: los objetos `memoryview' son registrados automáticamente con la clase @ref{1231,,collections.abc.Sequence}



Distinto en la versión 3.5: los objetos `memoryviews' se pueden ahora acceder usando como índices una tupla de números enteros.



Distinto en la versión 3.14.0a1 (unreleased): memoryview is now a @ref{157,,generic type}.


La clase @ref{156,,memoryview} tiene varios métodos:

@geindex __eq__() (método de memoryview)
@anchor{library/stdtypes memoryview __eq__}@anchor{2229}
@deffn {Método} __eq__ (exporter)

Un objeto `memoryview' y un exportador 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} son iguales si sus formas son equivalentes y todos los valores correspondientes son iguales cuando los formatos respectivos de los operandos son interpretados usando la sintaxis de @ref{d5,,struct}.

Para el subconjunto de formatos de @ref{d5,,struct} soportados actualmente por @ref{2226,,tolist()}, @code{v} y @code{w} son iguales si @code{v.tolist() == w.tolist()}:

@example
>>> import array
>>> a = array.array('I', [1, 2, 3, 4, 5])
>>> b = array.array('d', [1.0, 2.0, 3.0, 4.0, 5.0])
>>> c = array.array('b', [5, 3, 1])
>>> x = memoryview(a)
>>> y = memoryview(b)
>>> x == a == y == b
True
>>> x.tolist() == a.tolist() == y.tolist() == b.tolist()
True
>>> z = y[::-2]
>>> z == c
True
>>> z.tolist() == c.tolist()
True
@end example

Si cualquiera de las cadenas de formato no es soportada por el módulo @ref{d5,,struct}, entonces la comparación de los objetos siempre los considerará diferentes (incluso si las cadenas de formato y el contenido del `buffer' son idénticos):

@example
>>> from ctypes import BigEndianStructure, c_long
>>> class BEPoint(BigEndianStructure):
...     _fields_ = [("x", c_long), ("y", c_long)]
...
>>> point = BEPoint(100, 200)
>>> a = memoryview(point)
>>> b = memoryview(point)
>>> a == point
False
>>> a == b
False
@end example

Note that, as with floating-point numbers, @code{v is w} does `not' imply
@code{v == w} for memoryview objects.


Distinto en la versión 3.3: Versiones previas comparaban la memoria directamente, sin considerar ni el formato de los elementos ni la estructura lógica del arreglo.

@end deffn

@geindex tobytes() (método de memoryview)
@anchor{library/stdtypes memoryview tobytes}@anchor{222a}
@deffn {Método} tobytes (order='C')

Retorna los datos en el `buffer' en forma de cadena de bytes. Equivale a llamar al constructor de la clase @ref{325,,bytes} en el objeto `memoryview':

@example
>>> m = memoryview(b"abc")
>>> m.tobytes()
b'abc'
>>> bytes(m)
b'abc'
@end example

Para arreglos no contiguos el resultado es igual a la representación en forma de lista aplanada, con todos los elementos convertidos a bytes. El método @ref{222a,,tobytes()} soporta todos los formatos de cadenas de caracteres, incluidos aquellos que no se encuentran en la sintaxis del módulo @ref{d5,,struct}.


Added in version 3.8: El valor de `order' puede ser @{“C”, “F”, “A”@}. Cuando `order' es “C” o “F”, los datos en el arreglo original se convierten al orden de C o Fortran. Para vistas contiguas, “A” retorna una copia exacta de la memoria física. En particular, el orden en memoria de Fortran se mantiene inalterado. Para vistas no contiguas, los datos se convierten primero a C. Definir `order=None' es lo mismo que `order=”C”'.

@end deffn

@geindex hex() (método de memoryview)
@anchor{library/stdtypes memoryview hex}@anchor{df0}
@deffn {Método} hex ([sep[, bytes_per_sep]])

Retorna una cadena de caracteres que contiene dos dígitos hexadecimales por cada byte en el `buffer':

@example
>>> m = memoryview(b"abc")
>>> m.hex()
'616263'
@end example


Added in version 3.5.



Distinto en la versión 3.8: De forma similar a @ref{dee,,bytes.hex()}, @ref{df0,,memoryview.hex()} soporta ahora los parámetros opcionales `sep' y `bytes_per_sep' para insertar separadores entre los bytes en la cadena hexadecimal de salida.

@end deffn

@geindex tolist() (método de memoryview)
@anchor{library/stdtypes memoryview tolist}@anchor{2226}
@deffn {Método} tolist ()

Retorna los datos en el `buffer' como una lista de elementos.

@example
>>> memoryview(b'abc').tolist()
[97, 98, 99]
>>> import array
>>> a = array.array('d', [1.1, 2.2, 3.3])
>>> m = memoryview(a)
>>> m.tolist()
[1.1, 2.2, 3.3]
@end example


Distinto en la versión 3.3: El método @ref{2226,,tolist()} soporta ahora todos los formatos nativos de un solo carácter definidos en el módulo @ref{d5,,struct}, así como las representaciones de múltiples dimensiones.

@end deffn

@geindex toreadonly() (método de memoryview)
@anchor{library/stdtypes memoryview toreadonly}@anchor{222b}
@deffn {Método} toreadonly ()

Retorna una versión de solo lectura del objeto `memoryview'. El objeto original permanece inalterado:

@example
>>> m = memoryview(bytearray(b'abc'))
>>> mm = m.toreadonly()
>>> mm.tolist()
[97, 98, 99]
>>> mm[0] = 42
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot modify read-only memory
>>> m[0] = 43
>>> mm.tolist()
[43, 98, 99]
@end example


Added in version 3.8.

@end deffn

@geindex release() (método de memoryview)
@anchor{library/stdtypes memoryview release}@anchor{122b}
@deffn {Método} release ()

Libera el buffer subyacente expuesto por el objeto `memoryview'. Muchos objetos realizan operaciones especiales cuando una vista los está conteniendo (por ejemplo, un objeto @ref{5e0,,bytearray} temporalmente prohíbe el cambio de tamaño); la llamada a `release()' sirve para eliminar estas restricciones (así como para tratar con los recursos pendientes) lo más pronto posible.

After this method has been called, any further operation on the view
raises a @ref{360,,ValueError} (except @ref{122b,,release()} itself which can
be called multiple times):

@example
>>> m = memoryview(b'abc')
>>> m.release()
>>> m[0]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: operation forbidden on released memoryview object
@end example

El protocolo de gestión de contexto puede ser usado para obtener un efecto similar, usando la sentencia @code{with}:

@example
>>> with memoryview(b'abc') as m:
...     m[0]
...
97
>>> m[0]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: operation forbidden on released memoryview object
@end example


Added in version 3.2.

@end deffn

@geindex cast() (método de memoryview)
@anchor{library/stdtypes memoryview cast}@anchor{222c}
@deffn {Método} cast (format[, shape])

Transforma el formato o el tamaño de un objeto `memoryview'. El parámetro `shape' por defecto vale @code{[byte_length//new_itemsize]}, lo que significa que el resultado será unidimensional. El valor de retorno es un nuevo objeto de tipo `memoryview', pero el buffer en sí no se copia. Las transformaciones pueden ser 1D -> C-@ref{222d,,contiguo} y C-contiguo -> 1D.

The destination format is restricted to a single element native format in
@ref{d5,,struct} syntax. One of the formats must be a byte format
(“B”, “b” or “c”). The byte length of the result must be the same
as the original length.
Note that all byte lengths may depend on the operating system.

Transforma de @code{1D/long} a bytes @code{1D/unsigned}:

@example
>>> import array
>>> a = array.array('l', [1,2,3])
>>> x = memoryview(a)
>>> x.format
'l'
>>> x.itemsize
8
>>> len(x)
3
>>> x.nbytes
24
>>> y = x.cast('B')
>>> y.format
'B'
>>> y.itemsize
1
>>> len(y)
24
>>> y.nbytes
24
@end example

Transforma de @code{1D/unsigned} a bytes @code{1D/char}:

@example
>>> b = bytearray(b'zyz')
>>> x = memoryview(b)
>>> x[0] = b'a'
Traceback (most recent call last):
  ...
TypeError: memoryview: invalid type for format 'B'
>>> y = x.cast('c')
>>> y[0] = b'a'
>>> b
bytearray(b'ayz')
@end example

Transforma de @code{1D/bytes} a @code{3D/ints} a caracteres @code{1D/signed}:

@example
>>> import struct
>>> buf = struct.pack("i"*12, *list(range(12)))
>>> x = memoryview(buf)
>>> y = x.cast('i', shape=[2,2,3])
>>> y.tolist()
[[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]]
>>> y.format
'i'
>>> y.itemsize
4
>>> len(y)
2
>>> y.nbytes
48
>>> z = y.cast('b')
>>> z.format
'b'
>>> z.itemsize
1
>>> len(z)
48
>>> z.nbytes
48
@end example

Transforma de `long' @code{1D/unsigned} a `long' @code{2D/unsigned}:

@example
>>> buf = struct.pack("L"*6, *list(range(6)))
>>> x = memoryview(buf)
>>> y = x.cast('L', shape=[2,3])
>>> len(y)
2
>>> y.nbytes
48
>>> y.tolist()
[[0, 1, 2], [3, 4, 5]]
@end example


Added in version 3.3.



Distinto en la versión 3.5: El formato de origen ya no está restringido cuando se transforma a una vista de bytes.

@end deffn

Hay disponibles varios atributos de solo lectura:

@geindex obj (atributo de memoryview)
@anchor{library/stdtypes memoryview obj}@anchor{222e}
@deffn {Atributo} obj

El objeto subyacente del `memoryview':

@example
>>> b  = bytearray(b'xyz')
>>> m = memoryview(b)
>>> m.obj is b
True
@end example


Added in version 3.3.

@end deffn

@geindex nbytes (atributo de memoryview)
@anchor{library/stdtypes memoryview nbytes}@anchor{222f}
@deffn {Atributo} nbytes

@code{nbytes == product(shape) * itemsize == len(m.tobytes())}. Este es el espacio, medido en bytes, que usará el arreglo en una representación continua. No tiene que ser necesariamente igual a @code{len(m)}:

@example
>>> import array
>>> a = array.array('i', [1,2,3,4,5])
>>> m = memoryview(a)
>>> len(m)
5
>>> m.nbytes
20
>>> y = m[::2]
>>> len(y)
3
>>> y.nbytes
12
>>> len(y.tobytes())
12
@end example

Arreglos de múltiples dimensiones:

@example
>>> import struct
>>> buf = struct.pack("d"*12, *[1.5*x for x in range(12)])
>>> x = memoryview(buf)
>>> y = x.cast('d', shape=[3,4])
>>> y.tolist()
[[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]]
>>> len(y)
3
>>> y.nbytes
96
@end example


Added in version 3.3.

@end deffn

@geindex readonly (atributo de memoryview)
@anchor{library/stdtypes memoryview readonly}@anchor{2230}
@deffn {Atributo} readonly

Un booleano que indica si la memoria es de solo lectura.
@end deffn

@geindex format (atributo de memoryview)
@anchor{library/stdtypes memoryview format}@anchor{2228}
@deffn {Atributo} format

Una cadena de caracteres que contiene el formato (en el estilo del módulo @ref{d5,,struct}) para cada elemento de la vista. Un objeto `memoryview' se puede crear a partir de un exportador con textos de formato arbitrarios, pero algunos métodos (como, por ejemplo, @ref{2226,,tolist()}) están restringidos a usar formatos de elementos nativos sencillos.


Distinto en la versión 3.3: el formato @code{'B'} se gestiona ahora de acuerdo a la sintaxis descrita en el módulo @code{struct}. Esto significa que @code{memoryview(b'abc')[0] == b'abc'[0] == 97}.

@end deffn

@geindex itemsize (atributo de memoryview)
@anchor{library/stdtypes memoryview itemsize}@anchor{2227}
@deffn {Atributo} itemsize

El tamaño en bytes de cada elemento del objeto `memoryview':

@example
>>> import array, struct
>>> m = memoryview(array.array('H', [32000, 32001, 32002]))
>>> m.itemsize
2
>>> m[0]
32000
>>> struct.calcsize('H') == m.itemsize
True
@end example
@end deffn

@geindex ndim (atributo de memoryview)
@anchor{library/stdtypes memoryview ndim}@anchor{2231}
@deffn {Atributo} ndim

Un número entero que indica cuantas dimensiones de un arreglo multi-dimensional representa la memoria.
@end deffn

@geindex shape (atributo de memoryview)
@anchor{library/stdtypes memoryview shape}@anchor{2232}
@deffn {Atributo} shape

Una tupla de números enteros, de longitud @ref{2231,,ndim}, que indica la forma de la memoria en un arreglo de `N' dimensiones.


Distinto en la versión 3.3: Una tupla vacía, en vez de @code{None}, cuando @code{ndim = 0}.

@end deffn

@geindex strides (atributo de memoryview)
@anchor{library/stdtypes memoryview strides}@anchor{2233}
@deffn {Atributo} strides

Una tupla de números enteros, de longitud @ref{2231,,ndim}, que indica el tamaño en bytes para acceder a cada dimensión del arreglo.


Distinto en la versión 3.3: Una tupla vacía, en vez de @code{None}, cuando @code{ndim = 0}.

@end deffn

@geindex suboffsets (atributo de memoryview)
@anchor{library/stdtypes memoryview suboffsets}@anchor{2234}
@deffn {Atributo} suboffsets

De uso interno para los arreglos estilo `PIL'. El valor es solo informativo.
@end deffn

@geindex c_contiguous (atributo de memoryview)
@anchor{library/stdtypes memoryview c_contiguous}@anchor{2235}
@deffn {Atributo} c_contiguous

Un booleano que indica si la memoria es @ref{222d,,contiguous} al estilo C.


Added in version 3.3.

@end deffn

@geindex f_contiguous (atributo de memoryview)
@anchor{library/stdtypes memoryview f_contiguous}@anchor{2236}
@deffn {Atributo} f_contiguous

Un booleano que indica si la memoria es @ref{222d,,contiguous} al estilo Fortran.


Added in version 3.3.

@end deffn

@geindex contiguous (atributo de memoryview)
@anchor{library/stdtypes memoryview contiguous}@anchor{2237}
@deffn {Atributo} contiguous

Un booleano que indica si la memoria es @ref{222d,,contiguous}.


Added in version 3.3.

@end deffn
@end deffn

@node Conjuntos — set frozenset,Tipos mapa — dict,Tipos de secuencias binarias — bytes bytearray y memoryview,Tipos integrados
@anchor{library/stdtypes set-types-set-frozenset}@anchor{2238}@anchor{library/stdtypes types-set}@anchor{2179}
@subsection Conjuntos — @code{set}, @code{frozenset}


@geindex object;set

Un objeto de tipo `set' es una colección no ordenada de distintos objetos @ref{6b1,,hashable}. Los casos de uso habituales incluyen comprobar la pertenencia al conjunto de un elemento, eliminar duplicados de una secuencia y realizar operaciones matemáticas como la intersección, la unión, la diferencia o la diferencia simétrica. (Para otros tipos de contenedores véanse las clases incorporadas @ref{190,,dict}, @ref{18e,,list}, y @ref{464,,tuple}, así como el módulo @ref{1e,,collections}).

Como otras colecciones, los conjuntos soportan @code{x in set}, @code{len(set)} y @code{for x in set}. Como es una colección sin orden, los conjuntos no registran ni la posición ni el orden de inserción de los elementos. Por lo mismo, los conjuntos no soportan indexado, ni operaciones de segmentado, ni otras capacidades propias de las secuencias.

En la actualidad hay dos tipos de conjuntos incorporados: @ref{67a,,set} y @ref{67b,,frozenset}. La clase @ref{67a,,set} es mutable, es decir, el contenido del conjunto puede ser modificado con métodos como @code{add()} y @code{remove()}. Como es mutable, no tiene un valor de `hash' y no pueden ser usados como claves de diccionarios ni como elementos de otros conjuntos. La clase @ref{67b,,frozenset} es inmutable y @ref{6b1,,hashable}, es decir, que sus contenidos no pueden ser modificados después de creados. Puede ser usado, por tanto, como claves de diccionario o como elemento de otro conjunto.

Se pueden crear conjuntos no vacíos (`sets', no `frozensets') escribiendo una lista de elementos separados por comas, entre llaves, por ejemplo @code{@{'jack', 'sjoerd'@}}, además de con el constructor de la clase @ref{67a,,set}.

El constructor para ambas clases se usa de la misma forma:

@geindex set (clase incorporada)
@geindex frozenset (clase incorporada)
@anchor{library/stdtypes set}@anchor{67a}
@deffn {Clase} set ([iterable])
@anchor{library/stdtypes frozenset}@anchor{67b}
@deffnx {Clase} frozenset ([iterable])

Retorna un nuevo `set' o `frozenset', tomando los elementos a partir de `iterable'. Los elementos de un conjunto tienen que tener la propiedad de ser @ref{6b1,,hashable}. Para representar conjuntos anidados, o conjuntos de conjuntos, los conjuntos interiores tienen que ser instancias de @ref{67b,,frozenset}. Si no se especifica el parámetro `iterable', se retorna un conjunto vacío.

Los conjuntos (`sets') se pueden construir de diferentes formas:


@itemize *

@item 
Usando una lista de elementos separados por coma entre corchetes: @code{@{'jack', 'sjoerd'@}}

@item 
Usando un `set comprehention': @code{@{c for c in 'abracadabra' if c not in 'abc'@}}

@item 
Usando un constructor de tipo: @code{set()}, @code{set('foobar')}, @code{set(['a', 'b', 'foo'])}
@end itemize

Las instancias de @ref{67a,,set} y @ref{67b,,frozenset} proporcionan las siguientes operaciones:


@deffn {Describe} len(s)

Retorna el número de elementos en el conjunto `s' (cardinalidad de `s').
@end deffn


@deffn {Describe} x in s

Comprueba que el elemento `x' está incluido en `s'.
@end deffn


@deffn {Describe} x not in s

Comprueba que el elemento `x' no está incluido en `s'.
@end deffn

@geindex isdisjoint() (método de frozenset)
@anchor{library/stdtypes frozenset isdisjoint}@anchor{2239}
@deffn {Método} isdisjoint (other)

Retorna @code{True} si el conjunto no tienen ningún elemento en común con `other'. Dos conjuntos son disjuntos si y solo si su intersección es el conjunto vacío.
@end deffn

@geindex issubset() (método de frozenset)
@anchor{library/stdtypes frozenset issubset}@anchor{223a}
@deffn {Método} issubset (other)

@deffnx {Método} set <= other

Comprueba si cada elemento del conjunto también se encuentra en `other'.
@end deffn


@deffn {Método} set < other

Comprueba si el conjunto es un subconjunto propio de `other', es decir, @code{set <= other and set != other}.
@end deffn

@geindex issuperset() (método de frozenset)
@anchor{library/stdtypes frozenset issuperset}@anchor{223b}
@deffn {Método} issuperset (other)

@deffnx {Método} set >= other

Comprueba que cada elemento de `other' está incluido en el conjunto.
@end deffn


@deffn {Método} set > other

Comprueba si el conjunto es un superconjunto propio de `other', es decir, @code{set >= other and set != other}.
@end deffn

@geindex union() (método de frozenset)
@anchor{library/stdtypes frozenset union}@anchor{14bd}
@deffn {Método} union (*others)

@deffnx {Método} set | other | ...

Retorna un conjunto nuevo que contiene todos los elementos del conjunto y de `others'.
@end deffn

@geindex intersection() (método de frozenset)
@anchor{library/stdtypes frozenset intersection}@anchor{14be}
@deffn {Método} intersection (*others)

@deffnx {Método} set & other & ...

Retorna un conjunto nuevo que contiene todos los elementos que están a la vez en conjunto y en `others'.
@end deffn

@geindex difference() (método de frozenset)
@anchor{library/stdtypes frozenset difference}@anchor{223c}
@deffn {Método} difference (*others)

@deffnx {Método} set @w{-} other @w{-} ...

Retorna un conjunto nuevo que contiene todos los elementos del conjunto y que no están incluidos en `others'.
@end deffn

@geindex symmetric_difference() (método de frozenset)
@anchor{library/stdtypes frozenset symmetric_difference}@anchor{223d}
@deffn {Método} symmetric_difference (other)

@deffnx {Método} set ^ other

Retorna un conjunto nuevo que contiene elementos que están incluidos en el conjunto o en `others', pero no en los dos a la vez.
@end deffn

@geindex copy() (método de frozenset)
@anchor{library/stdtypes frozenset copy}@anchor{223e}
@deffn {Método} copy ()

Retorna una copia superficial del conjunto.
@end deffn

Hay que señalar que las versiones de las operaciones que son métodos (no los operadores) como @ref{14bd,,union()}, @ref{14be,,intersection()}, @ref{223c,,difference()}, @ref{223d,,symmetric_difference()}, @ref{223a,,issubset()}, y @ref{223b,,issuperset()} aceptan cualquier iterable como parámetro. Por el contrario, los operadores requieren que los argumentos sean siempre conjuntos. Esto evita ciertas construcciones propensas a errores como @code{set('abc') & 'cbs'}, favoreciendo el uso de formas más legibles como @code{set('abc').intersection('cbs')}.

Ambas clases @ref{67a,,set} y @ref{67b,,frozenset} soportan comparaciones entre sí. Dos conjuntos son iguales si y solo si cada elemento de cada conjunto está incluido en el otro (cada uno de ellos es subconjunto del otro). Un conjunto es menor que otro si y solo si el primero es un subconjunto propio del segundo (es un subconjunto, pero no son iguales). Un conjunto es mayor que otro si y solo si el primero es un superconjunto propio del segundo (es un superconjunto, pero no son iguales).

Las instancias de @ref{67a,,set} se comparan con las instancias de @ref{67b,,frozenset} en base a sus elementos. Por ejemplo @code{set('abc') == frozenset('abc')} retorna @code{True} y lo mismo hace @code{set('abc') in set([frozenset('abc')])}.

Las comparaciones de subconjunto e igualdad no son tan generales que permitan una función de ordenación total. Por ejemplo, dos conjuntos cualesquiera que no estén vacíos y que sean disjuntos no son iguales y tampoco son subconjuntos uno del otro, así que todas estas operaciones retornan @code{False}: @code{a<b}, @code{a==b} o @code{a>b}.

Como los conjuntos solo definen un orden parcial (relaciones de conjuntos), la salida del método @ref{c57,,list.sort()} no está definida para listas de conjuntos.

Los elementos de un conjunto, al igual que las claves de un diccionario, deben ser @ref{6b1,,hashable}.

Las operaciones binarias que mezclan instancias de @ref{67a,,set} y @ref{67b,,frozenset} retornan el tipo del primer operando. Por ejemplo: @code{frozenset('ab') | set('bc')} retornará una instancia de @ref{67b,,frozenset}.

La siguiente tabla muestra las operaciones disponibles para la clase @ref{67a,,set} que no son aplicables a los conjuntos inmutables @ref{67b,,frozenset}:

@geindex update() (método de frozenset)
@anchor{library/stdtypes frozenset update}@anchor{223f}
@deffn {Método} update (*others)

@deffnx {Método} set |= other | ...

Actualiza el conjunto, añadiendo los elementos que se encuentren en `others'.
@end deffn

@geindex intersection_update() (método de frozenset)
@anchor{library/stdtypes frozenset intersection_update}@anchor{14bf}
@deffn {Método} intersection_update (*others)

@deffnx {Método} set &= other & ...

Actualiza el conjunto, manteniendo solo los elementos que se encuentren en si mismo y en `others'.
@end deffn

@geindex difference_update() (método de frozenset)
@anchor{library/stdtypes frozenset difference_update}@anchor{2240}
@deffn {Método} difference_update (*others)

@deffnx {Método} set @w{-}= other | ...

Actualiza el conjunto, eliminado los elementos que se encuentren en `others'.
@end deffn

@geindex symmetric_difference_update() (método de frozenset)
@anchor{library/stdtypes frozenset symmetric_difference_update}@anchor{14c0}
@deffn {Método} symmetric_difference_update (other)

@deffnx {Método} set ^= other

Actualiza el conjunto, manteniendo solo los elementos que se encuentren en el conjunto o en `others', pero no en los dos a la vez.
@end deffn

@geindex add() (método de frozenset)
@anchor{library/stdtypes frozenset add}@anchor{2241}
@deffn {Método} add (elem)

Añade al conjunto el elemento `elem'.
@end deffn

@geindex remove() (método de frozenset)
@anchor{library/stdtypes frozenset remove}@anchor{2242}
@deffn {Método} remove (elem)

Elimina del conjunto el elemento `elem'. Lanza la excepción @ref{438,,KeyError} si `elem' no estaba incluido en el conjunto.
@end deffn

@geindex discard() (método de frozenset)
@anchor{library/stdtypes frozenset discard}@anchor{2243}
@deffn {Método} discard (elem)

Elimina del conjunto el elemento `elem', si estuviera incluido.
@end deffn

@geindex pop() (método de frozenset)
@anchor{library/stdtypes frozenset pop}@anchor{2244}
@deffn {Método} pop ()

Elimina y retorna un elemento cualquiera del conjunto. Lanza la excepción @ref{438,,KeyError} si el conjunto está vacío.
@end deffn

@geindex clear() (método de frozenset)
@anchor{library/stdtypes frozenset clear}@anchor{2245}
@deffn {Método} clear ()

Elimina todos los elementos del conjunto.
@end deffn

Hay que señalar que los métodos (no los operadores) @ref{223f,,update()}, @ref{14bf,,intersection_update()}, @ref{2240,,difference_update()}, y @ref{14c0,,symmetric_difference_update()} aceptan cualquier iterable como parámetro.

Note, the `elem' argument to the @ref{1f5d,,__contains__()},
@ref{2242,,remove()}, and
@ref{2243,,discard()} methods may be a set.  To support searching for an equivalent
frozenset, a temporary one is created from `elem'.
@end deffn

@node Tipos mapa — dict,Tipos gestores de contexto,Conjuntos — set frozenset,Tipos integrados
@anchor{library/stdtypes mapping-types-dict}@anchor{2246}@anchor{library/stdtypes typesmapping}@anchor{b51}
@subsection Tipos mapa — @code{dict}


@geindex object;mapping
@geindex object;dictionary
@geindex operations on;mapping;types
@geindex operations on;dictionary;type
@geindex statement;del
@geindex built-in function;len

Un objeto de tipo @ref{1229,,mapping} relaciona valores (que deben ser @ref{6b1,,hashable}) con objetos de cualquier tipo. Los mapas son objetos mutables. En este momento solo hay un tipo estándar de mapa, los `dictionary'. (Para otros tipos contenedores, véanse las clases incorporadas @ref{18e,,list}, @ref{67a,,set}, y @ref{464,,tuple}, así como el módulo @ref{1e,,collections}).

A dictionary’s keys are `almost' arbitrary values.  Values that are not
@ref{6b1,,hashable}, that is, values containing lists, dictionaries or other
mutable types (that are compared by value rather than by object identity) may
not be used as keys.
Values that compare equal (such as @code{1}, @code{1.0}, and @code{True})
can be used interchangeably to index the same dictionary entry.

@geindex dict (clase incorporada)
@anchor{library/stdtypes dict}@anchor{190}
@deffn {Clase} dict (**kwargs)

@deffnx {Clase} dict (mapping, **kwargs)

@deffnx {Clase} dict (iterable, **kwargs)

Retorna un diccionario creado a partir de un parámetro opcional por posición, y por una serie de parámetros por nombre, también opcionales.

Los diccionarios se pueden construir de diferentes formas:


@itemize *

@item 
Usando una lista separada por comas de pares @code{key: value} entre llaves: @code{@{'jack': 4098, 'sjoerd': 4127@}} o @code{@{4098: 'jack', 4127: 'sjoerd'@}}

@item 
Usando una comprensión de diccionario: @code{@{@}}, @code{@{x: x ** 2 for x in range(10)@}}

@item 
Usando un constructor de tipo: @code{dict()}, @code{dict([('foo', 100), ('bar', 200)])}, @code{dict(foo=100, bar=200)}
@end itemize

If no positional argument is given, an empty dictionary is created.
If a positional argument is given and it defines a @code{keys()} method, a
dictionary is created by calling @ref{3d8,,__getitem__()} on the argument with
each returned key from the method.  Otherwise, the positional argument must be an
@ref{1294,,iterable} object.  Each item in the iterable must itself be an iterable
with exactly two elements.  The first element of each item becomes a key in the
new dictionary, and the second element the corresponding value.  If a key occurs
more than once, the last value for that key becomes the corresponding value in
the new dictionary.

Si se usan parámetros por nombre, los nombres de los parámetros y los valores asociados se añaden al diccionario creado a partir del parámetro por posición. Si un valor de clave ya estaba presente, el valor pasado con el parámetro por nombre reemplazará el valor del parámetro por posición.

A modo de ejemplo, los siguientes ejemplos retornan todos el mismo diccionario @code{@{"one": 1, "two": 2, "three": 3@}}:

@example
>>> a = dict(one=1, two=2, three=3)
>>> b = @{'one': 1, 'two': 2, 'three': 3@}
>>> c = dict(zip(['one', 'two', 'three'], [1, 2, 3]))
>>> d = dict([('two', 2), ('one', 1), ('three', 3)])
>>> e = dict(@{'three': 3, 'one': 1, 'two': 2@})
>>> f = dict(@{'one': 1, 'three': 3@}, two=2)
>>> a == b == c == d == e == f
True
@end example

Si queremos definir claves con parámetros por nombre, como en el primer ejemplo, entonces los valores de clave solo puede ser cadenas de texto conteniendo identificadores de Python válidos. En los otros casos, se puede usar cualquier valor como clave.

Estas son las operaciones soportados por los diccionarios (y que, por tanto, deberían ser soportados por los tipos de mapa personalizados):


@deffn {Describe} list(d)

Retorna una lista de todas las claves usadas en el diccionario `d'.
@end deffn


@deffn {Describe} len(d)

Retorna el número de elementos almacenados en el diccionario `d'.
@end deffn


@deffn {Describe} d[key]

Retorna el elemento dentro de `d' almacenado bajo la clave `key'. Lanza una excepción de tipo @ref{438,,KeyError} si la clave `key' no se encuentra en el diccionario `d'.

@geindex __missing__()

Si una subclase de un diccionario define el método @code{__missing__()} y `key' no está presente, la operación @code{d[key]} llama a este método pasando como parámetro el valor de `key'. La operación @code{d[key]} o bien retorna un valor o lanza la excepción que sea retornada por la llamada a @code{__missing__(key)}. Ninguna otra operación o método llama a @code{__missing__()}. Si el método @code{__missing__()} no está definido, se lanza @ref{438,,KeyError}. Si se define @code{__missing__()}, debe ser de forma obligatoria un método, no puede ser una variable de instancia:

@example
>>> class Counter(dict):
...     def __missing__(self, key):
...         return 0
...
>>> c = Counter()
>>> c['red']
0
>>> c['red'] += 1
>>> c['red']
1
@end example

El ejemplo anterior muestra parte de la implementación de la clase @ref{110e,,collections.Counter}. Otro ejemplo de uso del método @code{__missing__} se puede encontrar en la clase @ref{122a,,collections.defaultdict}.
@end deffn


@deffn {Describe} d[key] = value

Asigna el valor `value' a @code{d[key]}.
@end deffn


@deffn {Describe} del d[key]

Elimina @code{d[key]} de `d'. Lanza una excepción @ref{438,,KeyError} si `key' no está en el mapa.
@end deffn


@deffn {Describe} key in d

Retorna @code{True} si `d' tiene una entrada en la clave `key', @code{False} en caso contrario.
@end deffn


@deffn {Describe} key not in d

Equivale a @code{not key in d}.
@end deffn


@deffn {Describe} iter(d)

Retorna un iterador que recorre todas las claves de un diccionario. Es una forma abreviada de @code{iter(d.keys())}.
@end deffn

@geindex clear() (método de dict)
@anchor{library/stdtypes dict clear}@anchor{2247}
@deffn {Método} clear ()

Elimina todos los elementos del diccionario.
@end deffn

@geindex copy() (método de dict)
@anchor{library/stdtypes dict copy}@anchor{c58}
@deffn {Método} copy ()

Retorna una copia superficial del diccionario.
@end deffn

@geindex fromkeys() (método de clase de dict)
@anchor{library/stdtypes dict fromkeys}@anchor{18f}
@deffn {Método} classmethod fromkeys (iterable, value=None, /)

Crea un nuevo diccionario con las claves obtenidos a partir del `iterable' y con valor `value'.

El método @ref{18f,,fromkeys()} es un método de clase que retorna un diccionario nuevo. El valor de `value' por defecto es @code{None}. Todos los valores harán referencia a una única instancia, por lo que en general no tiene sentido que `value' sea un objeto mutable, como una lista vacía. Para poder obtener valores diferentes, se puede usar mejor un @ref{e04,,diccionario por comprensión}.
@end deffn

@geindex get() (método de dict)
@anchor{library/stdtypes dict get}@anchor{2248}
@deffn {Método} get (key, default=None)

Retorna el elemento dentro de `d' almacenado bajo la clave `key', si `key' está en el diccionario; si no, retorna `default'. El valor de `default' por defecto es @code{None}, por lo que esta función nunca lanza la excepción @ref{438,,KeyError}.
@end deffn

@geindex items() (método de dict)
@anchor{library/stdtypes dict items}@anchor{868}
@deffn {Método} items ()

Retorna una nueva vista de los elementos del diccionario (pares @code{(key, value)}). Véase la @ref{2249,,documentación de los objetos vistas}.
@end deffn

@geindex keys() (método de dict)
@anchor{library/stdtypes dict keys}@anchor{866}
@deffn {Método} keys ()

Retorna una nueva vista de las claves del diccionario. Véase la @ref{2249,,documentación de las vistas}.
@end deffn

@geindex pop() (método de dict)
@anchor{library/stdtypes dict pop}@anchor{437}
@deffn {Método} pop (key[, default])

Si `key' está en el diccionario, lo elimina del diccionario y retorna su valor; si no está, retorna `default'. Si no se especifica valor para `default' y la `key' no se encuentra en el diccionario, se lanza la excepción @ref{438,,KeyError}.
@end deffn

@geindex popitem() (método de dict)
@anchor{library/stdtypes dict popitem}@anchor{1567}
@deffn {Método} popitem ()

Elimina y retorna una pareja @code{(key, value)} del diccionario. Las parejas se retornan en el orden @abbr{LIFO,*last-in@comma{} first-out*: Último en entrar@comma{} primero en salir}.

El método @ref{1567,,popitem()} es útil para recorrer y a la vez vaciar un diccionario, un proceso usado a menudo en algoritmos de conjuntos. Si el diccionario está vacío, llamar a @ref{1567,,popitem()} lanza la excepción @ref{438,,KeyError}.


Distinto en la versión 3.7: El orden `LIFO' ahora está garantizado. En versiones anteriores, el método @ref{1567,,popitem()} retorna una pareja clave/valor arbitraria.

@end deffn


@deffn {Describe} reversed(d)

Retorna un iterador que recorre las claves en orden inverso. Es una forma abreviada de @code{reversed(d.keys())}.


Added in version 3.8.

@end deffn

@geindex setdefault() (método de dict)
@anchor{library/stdtypes dict setdefault}@anchor{10f5}
@deffn {Método} setdefault (key, default=None)

Si `key' está incluida en el diccionario, retorna el valor almacenado. Si no, inserta con la clave `key' el valor definido en `default' y retorna `default'. El valor por defecto de `default' es @code{None}.
@end deffn

@geindex update() (método de dict)
@anchor{library/stdtypes dict update}@anchor{14a2}
@deffn {Método} update ([other])

Actualiza el diccionario con las parejas clave/valor obtenidas de `other', escribiendo encima de las claves existentes. Retorna @code{None}.

@ref{14a2,,update()} accepts either another object with a @code{keys()} method (in
which case @ref{3d8,,__getitem__()} is called with every key returned from
the method) or an iterable of key/value pairs (as tuples or other iterables
of length two). If keyword arguments are specified, the dictionary is then
updated with those key/value pairs: @code{d.update(red=1, blue=2)}.
@end deffn

@geindex values() (método de dict)
@anchor{library/stdtypes dict values}@anchor{867}
@deffn {Método} values ()

Retorna una nueva vista de los valores del diccionario. Véase la @ref{2249,,documentación sobre objetos vistas}.

Una comparación de igualdad entre una vista @code{dict.values()} y otra siempre retornará @code{False}. Esto también pasa cuando se compara @code{dict.values()} consigo mismo:

@example
>>> d = @{'a': 1@}
>>> d.values() == d.values()
False
@end example
@end deffn


@deffn {Describe} d | other

Crea un nuevo diccionario con las claves y valores fusionados de `d' y `other', por lo cual ambos deben ser diccionarios. Los valores de `other' tienen prioridad cuando `d' y `other' tienen claves compartidas.


Added in version 3.9.

@end deffn


@deffn {Describe} d |= other

Actualiza el diccionario `d' con las claves y valores de `other', el cual podría ser ya sea un a @ref{1229,,mapping} o un @ref{1294,,iterable} de pares clave/valor. Los valores de `other' tienen prioridad cuando `d' y `other' tienen claves compartidas.


Added in version 3.9.

@end deffn

Los diccionarios se consideran iguales si y solo si tienen el mismo conjunto de parejas @code{(key, value)} (independiente de su orden). Los intentos de comparar usando los operadores “<”, “<=”, “>=”, “>” lanzan una excepción de tipo @ref{228,,TypeError}.

Los diccionarios mantienen de forma interna el orden de inserción. Actualizar una clave no modifica ese orden. Las claves que vuelven a ser insertadas después de haber sido borradas se añaden al final.:

@example
>>> d = @{"one": 1, "two": 2, "three": 3, "four": 4@}
>>> d
@{'one': 1, 'two': 2, 'three': 3, 'four': 4@}
>>> list(d)
['one', 'two', 'three', 'four']
>>> list(d.values())
[1, 2, 3, 4]
>>> d["one"] = 42
>>> d
@{'one': 42, 'two': 2, 'three': 3, 'four': 4@}
>>> del d["two"]
>>> d["two"] = None
>>> d
@{'one': 42, 'three': 3, 'four': 4, 'two': None@}
@end example


Distinto en la versión 3.7: Se garantiza que el orden del diccionario es el de inserción. Este comportamiento era un detalle de implementación en CPython desde la versión 3.6.


Tanto los diccionarios como las vistas basadas en diccionarios son reversibles:

@example
>>> d = @{"one": 1, "two": 2, "three": 3, "four": 4@}
>>> d
@{'one': 1, 'two': 2, 'three': 3, 'four': 4@}
>>> list(reversed(d))
['four', 'three', 'two', 'one']
>>> list(reversed(d.values()))
[4, 3, 2, 1]
>>> list(reversed(d.items()))
[('four', 4), ('three', 3), ('two', 2), ('one', 1)]
@end example


Distinto en la versión 3.8: Los diccionarios son ahora reversibles.

@end deffn


@subsubheading Ver también


Se puede usar un objeto de tipo @ref{518,,types.MappingProxyType} para crear una vista de solo lectura de un objeto @ref{190,,dict}.


@menu
* Objetos tipos vista de diccionario:: 

@end menu

@node Objetos tipos vista de diccionario,,,Tipos mapa — dict
@anchor{library/stdtypes dict-views}@anchor{2249}@anchor{library/stdtypes dictionary-view-objects}@anchor{224a}
@subsubsection Objetos tipos vista de diccionario


Los objetos retornados por los métodos @ref{866,,dict.keys()}, @ref{867,,dict.values()} y @ref{868,,dict.items()} son objetos tipo vista o `view'. Estos objetos proporcionan una vista dinámica del contenido del diccionario, lo que significa que si el diccionario cambia, las vistas reflejan estos cambios.

Las vistas de un diccionario pueden ser iteradas para retornar sus datos respectivos, y soportan operaciones de comprobación de pertenencia:


@deffn {Describe} len(dictview)

Retorna el número de entradas en un diccionario.
@end deffn


@deffn {Describe} iter(dictview)

Retorna un iterador sobre las claves, valores o elementos (representados en forma de tuplas @code{(key, value)}) de un diccionario.

Las claves y los valores se iteran en orden de inserción. Esto permite la creación de parejas @code{(value, key)} usando la función @ref{14d,,zip()}: @code{pairs = zip(d.values(), d.keys())}. Otra forma de crear la misma lista es @code{pairs = [(v, k) for (k, v) in d.items()]}.

Iterar sobre un diccionario a la vez que se borran o añaden entradas puede lanzar una excepción de tipo @ref{1e5,,RuntimeError}, o puede provocar que no se iteren sobre todas las entradas.


Distinto en la versión 3.7: Se garantiza que el orden de los diccionarios es el de inserción.

@end deffn


@deffn {Describe} x in dictview

Retorna @code{True} si `x' está incluido en las claves, los valores o los elementos del diccionario (en el último caso, `x' debe ser una tupla @code{(key, value)}).
@end deffn


@deffn {Describe} reversed(dictview)

Retorna un iterador inverso sobre las claves, los valores o los elementos del diccionario. El orden de la vista será el inverso del orden de inserción.


Distinto en la versión 3.8: Las vistas de un diccionario no son reversibles.

@end deffn


@deffn {Describe} dictview.mapping

Retorna un @ref{518,,types.MappingProxyType} que envuelve el diccionario original al que se refiere la vista.


Added in version 3.10.

@end deffn

Keys views are set-like since their entries are unique and @ref{6b1,,hashable}.
Items views also have set-like operations since the (key, value) pairs
are unique and the keys are hashable.
If all values in an items view are hashable as well,
then the items view can interoperate with other sets.
(Values views are not treated as set-like
since the entries are generally not unique.)  For set-like views, all of the
operations defined for the abstract base class @ref{224b,,collections.abc.Set} are
available (for example, @code{==}, @code{<}, or @code{^}).  While using set operators,
set-like views accept any iterable as the other operand,
unlike sets which only accept sets as the input.

Un ejemplo de uso de una vista de diccionario:

@example
>>> dishes = @{'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500@}
>>> keys = dishes.keys()
>>> values = dishes.values()

>>> # iteration
>>> n = 0
>>> for val in values:
...     n += val
...
>>> print(n)
504

>>> # keys and values are iterated over in the same order (insertion order)
>>> list(keys)
['eggs', 'sausage', 'bacon', 'spam']
>>> list(values)
[2, 1, 1, 500]

>>> # view objects are dynamic and reflect dict changes
>>> del dishes['eggs']
>>> del dishes['sausage']
>>> list(keys)
['bacon', 'spam']

>>> # set operations
>>> keys & @{'eggs', 'bacon', 'salad'@}
@{'bacon'@}
>>> keys ^ @{'sausage', 'juice'@} == @{'juice', 'sausage', 'bacon', 'spam'@}
True
>>> keys | ['juice', 'juice', 'juice'] == @{'bacon', 'spam', 'juice'@}
True

>>> # get back a read-only proxy for the original dictionary
>>> values.mapping
mappingproxy(@{'bacon': 1, 'spam': 500@})
>>> values.mapping['spam']
500
@end example

@node Tipos gestores de contexto,Tipos de anotaciones de type — alias genérico Union,Tipos mapa — dict,Tipos integrados
@anchor{library/stdtypes context-manager-types}@anchor{224c}@anchor{library/stdtypes typecontextmanager}@anchor{1fbf}
@subsection Tipos gestores de contexto


@geindex context manager
@geindex context management protocol
@geindex protocol;context management

La expresión @ref{673,,with} de Python soporta el concepto de un contexto en tiempo de ejecución definido mediante un gestor de contexto. Para implementar esto, se permite al usuario crear clases para definir estos contextos definiendo dos métodos, uno a ejecutar antes de entrar del bloque de código y otro a ejecutar justo después de salir del mismo:

@geindex __enter__() (método de contextmanager)
@anchor{library/stdtypes contextmanager __enter__}@anchor{224d}
@deffn {Método} contextmanager.__enter__ ()

Entra en el contexto en tiempo de ejecución, y retorna o bien este objeto u otro relacionado con el contexto. El valor retornado por este método se vincula al identificador que viene tras la palabra clave @code{as} usada en la sentencia @ref{673,,with} que define el contexto.

Un ejemplo de gestor de contexto que se retorna a si mismo es un objeto de tipo @ref{1230,,file object}. Los objetos de tipo @code{File} se retornan a si mismo en la llamada a @code{__enter__()}, lo que permite que @ref{1be,,open()} sea usado como gestores de contexto en una sentencia @ref{673,,with}.

Un ejemplo de gestor de contexto que retorna otro objeto relacionado en el que define la función @ref{180b,,decimal.localcontext()}. Este gestor define el contexto de uso en operaciones decimales a partir de una copia del contexto original, y retorna esa copia. De esta manera se puede cambiar el contexto decimal dentro del cuerpo del @ref{673,,with} sin afectar al código fuera de @code{with}.
@end deffn

@geindex __exit__() (método de contextmanager)
@anchor{library/stdtypes contextmanager __exit__}@anchor{224e}
@deffn {Método} contextmanager.__exit__ (exc_type, exc_val, exc_tb)

Sale del contexto y retorna un indicador booleano que indica si se debe ignorar cualquier posible excepción que hubiera ocurrido dentro del mismo. Si se produce una excepción mientras se ejecutan las sentencias definidas en el cuerpo de la sentencia @ref{673,,with}, los parámetros de esta función contienen el tipo y valor de la excepción, así como la información relativa a la traza de ejecución. Si no se produce ninguna excepción, los tres parámetros valen @code{None}.

Si este método retorna un valor @code{True}, la sentencia @ref{673,,with} ignora la excepción y el flujo del programa continua con la primera sentencia inmediatamente después de la sentencia @code{with}. En caso contrario la excepción producida continua propagándose después de que este método termine de ejecutarse. Cualquier excepción que pudieran producirse dentro de este método reemplaza a la excepción que se hubiera producido en el cuerpo del @code{with}.

The exception passed in should never be reraised explicitly - instead, this
method should return a false value to indicate that the method completed
successfully and does not want to suppress the raised exception. This allows
context management code to easily detect whether or not an @ref{1367,,__exit__()}
method has actually failed.
@end deffn

Python define varios gestores de contexto para facilitar la sincronía entre hilos, asegurarse del cierre de ficheros y otros objetos similares y para modificar de forma simple el contexto para las expresiones aritméticas con decimales. Los tipos específicos no se tratan especialmente fuera de su implementación del protocolo de administración de contexto. Véase el módulo @ref{24,,contextlib} para algunos ejemplos.

Los @ref{10dd,,generator} de Python y el decorador definidos en la clase @ref{126f,,contextlib.contextmanager} permiten implementar de forma sencilla estos protocolos. Si una función generadora se decora con la clase @ref{126f,,contextlib.contextmanager}, retornará un gestor de contexto que incluye los métodos necesarios @ref{224d,,__enter__()} y @ref{224e,,__exit__()}, en vez del iterador que se produciría si no se decora la función generadora.

Nótese que no hay una ranura específica para ninguno de estos métodos en la estructura usada para los objetos Python en el nivel de la API de Python/C. Objetos que quieran definir estos métodos deben implementarlos como métodos normales de Python. Comparado con la complejidad de definir un contexto en tiempo de ejecución, lo complejidad de una búsqueda simple en un diccionario es mínima.

@node Tipos de anotaciones de type — alias genérico Union,Otros tipos predefinidos,Tipos gestores de contexto,Tipos integrados
@anchor{library/stdtypes type-annotation-types-generic-alias-union}@anchor{224f}
@subsection Tipos de anotaciones de type — alias genérico, Union


@geindex annotation;type annotation; type hint

Los tipos principales integrados para @ref{140,,anotaciones de tipo} son @ref{753,,alias genérico} y @ref{85b,,Union}.

@menu
* Tipo Alias Genérico:: 
* Tipo de conversión:: 

@end menu

@node Tipo Alias Genérico,Tipo de conversión,,Tipos de anotaciones de type — alias genérico Union
@anchor{library/stdtypes generic-alias-type}@anchor{2250}@anchor{library/stdtypes types-genericalias}@anchor{753}
@subsubsection Tipo Alias Genérico


@geindex object;GenericAlias
@geindex Generic;Alias

Los objetos @code{GenericAlias} generalmente se crean para @ref{1f84,,suscribir} a una clase. Se utilizan con mayor frecuencia con @ref{1f8a,,clases contenedoras}, como @ref{18e,,list} o @ref{190,,dict}. Por ejemplo, @code{list[int]} es un objeto @code{GenericAlias} que se creó para suscribir la clase @code{list} con el argumento @ref{1f0,,int}. Los objetos @code{GenericAlias} están pensados principalmente para usar con @ref{140,,anotaciones de tipo}.

@cartouche
@quotation Nota 
Generalmente solo es posible suscribir a una clase si ésta implementa el método especial @ref{7d6,,__class_getitem__()}.
@end quotation
@end cartouche

El objeto @code{GenericAlias} actúa como `proxy' para @ref{157,,tipo genérico}, implementando `parameterized generics'.

Para una clase contenedora, el argumento (o los argumentos) proporcionado(s) a una @ref{1f84,,suscripción} de la clase puede indicar el tipo (o tipos) de los elementos que contiene un objeto. Por ejemplo, se puede usar @code{set[bytes]} en anotaciones de tipo para significar un @ref{67a,,set} en el que todos los elementos son del tipo @ref{325,,bytes}.

Para una clase que define el método @ref{7d6,,__class_getitem__()} pero no es un contenedor, el argumento (o los argumentos) proporcionado(s) a una suscripción de la clase a menudo indicarán el tipo (o los tipos) de retorno de uno o más métodos definidos en un objeto. Por ejemplo, las @ref{b9,,expresiones regulares} se pueden usar tanto para el tipo de datos @ref{237,,str} y el tipo de datos @ref{325,,bytes}:


@itemize *

@item 
Si @code{x = re.search('foo', 'foo')}, @code{x} será un objeto @ref{1006,,re.Match} donde los valores de retorno de @code{x.group(0)} y @code{x[0]} serán de tipo @ref{237,,str}. Podemos representar este tipo de objeto en anotaciones de type con el @code{GenericAlias} de @code{re.Match[str]}.

@item 
Si @code{y = re.search(b'bar', b'bar')}, (nótese que @code{b} es para @ref{325,,bytes}), @code{y} también será una instancia de @code{re.Match}, pero los valores de retorno de @code{y.group(0)} y @code{y[0]} serán de tipo @ref{325,,bytes}. En anotaciones de type, representaríamos esta variedad de objetos @ref{1006,,re.Match} con @code{re.Match[bytes]}.
@end itemize

Los objetos @code{GenericAlias} son instancias de la clase @ref{882,,types.GenericAlias}, que también se puede usar para crear directamente objetos @code{GenericAlias}.


@deffn {Describe} T[X, Y, ...]

Crea un @code{GenericAlias} que representa un tipo @code{T} parametrizado por tipos `X', `Y' y más dependiendo de la @code{T} usada. Por ejemplo, una función espera un @ref{18e,,list} que contenga elementos @ref{153,,float}:

@example
def average(values: list[float]) -> float:
    return sum(values) / len(values)
@end example

Otro ejemplo para el @ref{1229,,mapping} de objetos, usando un @ref{190,,dict}, el cual es un tipo genérico que espera dos parámetros de tipo que representan el tipo de la clave y el tipo del valor. En este ejemplo, la función espera un @code{dict} con claves de tipo @ref{237,,str} y valores de tipo @ref{1f0,,int}:

@example
def send_post_request(url: str, body: dict[str, int]) -> None:
    ...
@end example
@end deffn

Las funciones integradas @ref{4ef,,isinstance()} y @ref{85a,,issubclass()} no aceptan tipos @code{GenericAlias} como segundo argumento:

@example
>>> isinstance([1, 2], list[str])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: isinstance() argument 2 cannot be a parameterized generic
@end example

Python en tiempo de ejecución no hace cumplir las @ref{140,,anotaciones de tipo}. Esto se extiende para tipos genéricos y sus parámetros. Cuando se crea un objeto contenedor desde un @code{GenericAlias}, los elementos del contenedor no se verifican con su tipo. Por ejemplo, el siguiente código no es recomendado en lo absoluto, pero correrá sin errores:

@example
>>> t = list[str]
>>> t([1, 2, 3])
[1, 2, 3]
@end example

Además, los genéricos parametrizados borran parámetros de type durante la creación de objetos:

@example
>>> t = list[str]
>>> type(t)
<class 'types.GenericAlias'>

>>> l = t()
>>> type(l)
<class 'list'>
@end example

Llamando a @ref{894,,repr()} o @ref{237,,str()} en un genérico se muestra el tipo parametrizado:

@example
>>> repr(list[int])
'list[int]'

>>> str(list[int])
'list[int]'
@end example

El método @ref{3d8,,__getitem__()} de contenedores genéricos lanzarán una excepción para rechazar los errores como @code{dict[str][str]}:

@example
>>> dict[str][str]
Traceback (most recent call last):
  ...
TypeError: dict[str] is not a generic class
@end example

Sin embargo, estas expresiones son válidas cuando se usan @ref{1f7f,,variables de type}. El índice debe tener tantos elementos como los elementos de variable de type en los @ref{2251,,__args__} del objeto @code{GenericAlias}:

@example
>>> from typing import TypeVar
>>> Y = TypeVar('Y')
>>> dict[str, Y][int]
dict[str, int]
@end example

@menu
* Clases genéricas estándar:: 
* Atributos especiales de los objetos GenericAlias:: 

@end menu

@node Clases genéricas estándar,Atributos especiales de los objetos GenericAlias,,Tipo Alias Genérico
@anchor{library/stdtypes standard-generic-classes}@anchor{2252}
@subsubsection Clases genéricas estándar


Las siguientes clases de la biblioteca estándar soportan genéricos parametrizados. Esta lista no es exhaustiva.


@itemize *

@item 
@ref{464,,tuple}

@item 
@ref{18e,,list}

@item 
@ref{190,,dict}

@item 
@ref{67a,,set}

@item 
@ref{67b,,frozenset}

@item 
@ref{dcf,,type}

@item 
@ref{67d,,collections.deque}

@item 
@ref{122a,,collections.defaultdict}

@item 
@ref{67c,,collections.OrderedDict}

@item 
@ref{110e,,collections.Counter}

@item 
@ref{ca4,,collections.ChainMap}

@item 
@ref{e61,,collections.abc.Awaitable}

@item 
@ref{e62,,collections.abc.Coroutine}

@item 
@ref{e64,,collections.abc.AsyncIterable}

@item 
@ref{e63,,collections.abc.AsyncIterator}

@item 
@ref{d13,,collections.abc.AsyncGenerator}

@item 
@ref{2253,,collections.abc.Iterable}

@item 
@ref{2254,,collections.abc.Iterator}

@item 
@ref{e60,,collections.abc.Generator}

@item 
@ref{d12,,collections.abc.Reversible}

@item 
@ref{2255,,collections.abc.Container}

@item 
@ref{d11,,collections.abc.Collection}

@item 
@ref{881,,collections.abc.Callable}

@item 
@ref{224b,,collections.abc.Set}

@item 
@ref{2256,,collections.abc.MutableSet}

@item 
@ref{961,,collections.abc.Mapping}

@item 
@ref{1123,,collections.abc.MutableMapping}

@item 
@ref{1231,,collections.abc.Sequence}

@item 
@ref{309,,collections.abc.MutableSequence}

@item 
@ref{2257,,collections.abc.MappingView}

@item 
@ref{2258,,collections.abc.KeysView}

@item 
@ref{2259,,collections.abc.ItemsView}

@item 
@ref{225a,,collections.abc.ValuesView}

@item 
@ref{d16,,contextlib.AbstractContextManager}

@item 
@ref{bb4,,contextlib.AbstractAsyncContextManager}

@item 
@ref{15f8,,dataclasses.Field}

@item 
@ref{5e4,,functools.cached_property}

@item 
@ref{17b,,functools.partialmethod}

@item 
@ref{cd9,,os.PathLike}

@item 
@ref{225b,,queue.LifoQueue}

@item 
@ref{13ee,,queue.Queue}

@item 
@ref{225c,,queue.PriorityQueue}

@item 
@ref{bf2,,queue.SimpleQueue}

@item 
@ref{1005,,re.Pattern}

@item 
@ref{1006,,re.Match}

@item 
@ref{225d,,shelve.BsdDbShelf}

@item 
@ref{225e,,shelve.DbfilenameShelf}

@item 
@ref{1019,,shelve.Shelf}

@item 
@ref{518,,types.MappingProxyType}

@item 
@ref{15be,,weakref.WeakKeyDictionary}

@item 
@ref{106c,,weakref.WeakMethod}

@item 
@ref{67e,,weakref.WeakSet}

@item 
@ref{15bf,,weakref.WeakValueDictionary}
@end itemize

@node Atributos especiales de los objetos GenericAlias,,Clases genéricas estándar,Tipo Alias Genérico
@anchor{library/stdtypes special-attributes-of-genericalias-objects}@anchor{225f}
@subsubsection Atributos especiales de los objetos @code{GenericAlias}


Todos los genéricos parametrizados implementan atributos especiales de solo lectura.

@geindex __origin__ (atributo de genericalias)
@anchor{library/stdtypes genericalias __origin__}@anchor{2260}
@deffn {Atributo} genericalias.__origin__

Este atributo apunta a la clase genérica no parametrizada:

@example
>>> list[int].__origin__
<class 'list'>
@end example
@end deffn

@geindex __args__ (atributo de genericalias)
@anchor{library/stdtypes genericalias __args__}@anchor{2251}
@deffn {Atributo} genericalias.__args__

Este atributo es una clase @ref{464,,tuple} (posiblemente de longitud 1) de tipos genéricos pasados al método original @ref{7d6,,__class_getitem__()} de la clase genérica:

@example
>>> dict[str, list[int]].__args__
(<class 'str'>, list[int])
@end example
@end deffn

@geindex __parameters__ (atributo de genericalias)
@anchor{library/stdtypes genericalias __parameters__}@anchor{2261}
@deffn {Atributo} genericalias.__parameters__

Este atributo es una tupla (posiblemente vacía) computada perezosamente con las variables de tipo únicas encontradas en @code{__args__}:

@example
>>> from typing import TypeVar

>>> T = TypeVar('T')
>>> list[T].__parameters__
(~T,)
@end example

@cartouche
@quotation Nota 
Un objeto @code{GenericAlias} con @ref{2ca,,typing.ParamSpec} parámetros puede no tener los @code{__parameters__} correctos después de la sustitución porque @ref{2ca,,typing.ParamSpec} está destinado principalmente a la verificación de tipos estáticos.
@end quotation
@end cartouche
@end deffn

@geindex __unpacked__ (atributo de genericalias)
@anchor{library/stdtypes genericalias __unpacked__}@anchor{2262}
@deffn {Atributo} genericalias.__unpacked__

Un booleano que es verdadero si el alias ha sido desempaquetado usando el operador @code{*} (véase @ref{2cb,,TypeVarTuple}).


Added in version 3.11.

@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Type Hints

Presentación del marco de trabajo de Python para anotaciones de tipo.

@geindex Python Enhancement Proposals; PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - Sugerencias de tipo genéricas en colecciones estándar

Introducción a la capacidad de parametrizar de forma nativa clases de la biblioteca estándar, siempre que implementen el método de clase especial @ref{7d6,,__class_getitem__()}.

@item @ref{1f7f,,Genéricos}, @ref{576,,tipos genéricos definidos por el usuario} y @ref{15f6,,typing.Generic}

Documentación sobre cómo implementar clases genéricas que se pueden parametrizar en tiempo de ejecución y que los validadores estático de tipos pueden entender.
@end table



Added in version 3.9.


@node Tipo de conversión,,Tipo Alias Genérico,Tipos de anotaciones de type — alias genérico Union
@anchor{library/stdtypes types-union}@anchor{85b}@anchor{library/stdtypes union-type}@anchor{2263}
@subsubsection Tipo de conversión


@geindex object;Union
@geindex union;type

Un objeto de conversión contiene el valor de la operación @code{|} (bit a bit o) en varios @ref{2189,,objetos de tipo}. Estos tipos están destinados principalmente a @ref{140,,anotaciones de tipo}. La expresión de tipo de conversión permite una sintaxis de sugerencia de tipo más limpia en comparación con @ref{6dc,,typing.Union}.


@deffn {Describe} X | Y | ...

Define un objeto de conversión que contiene tipos `X', `Y', etc. @code{X | Y} significa X o Y. Es equivalente a @code{typing.Union[X, Y]}. Por ejemplo, la siguiente función espera un argumento de tipo @ref{1f0,,int} or @ref{153,,float}:

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

@cartouche
@quotation Nota 
The @code{|} operand cannot be used at runtime to define unions where one or
more members is a forward reference. For example, @code{int | "Foo"}, where
@code{"Foo"} is a reference to a class not yet defined, will fail at
runtime. For unions which include forward references, present the
whole expression as a string, e.g. @code{"int | Foo"}.
@end quotation
@end cartouche
@end deffn


@deffn {Describe} union_object == other

Los objetos de conversión se pueden probar para determinar su igualdad con otros objetos de conversión. Detalles:


@itemize *

@item 
Las conversiones de conversión se aplanan:

@example
(int | str) | float == int | str | float
@end example

@item 
Se eliminan los tipos redundantes:

@example
int | str | int == int | str
@end example

@item 
Al comparar conversiones, se ignora el orden:

@example
int | str == str | int
@end example

@item 
Es compatible con @ref{6dc,,typing.Union}:

@example
int | str == typing.Union[int, str]
@end example

@item 
Los tipos opcionales se pueden escribir como una unión con @code{None}:

@example
str | None == typing.Optional[str]
@end example
@end itemize
@end deffn


@deffn {Describe} isinstance(obj, union_object)
@end deffn


@deffn {Describe} issubclass(obj, union_object)

Las llamadas a @ref{4ef,,isinstance()} y @ref{85a,,issubclass()} también son compatibles con un objeto de conversión:

@example
>>> isinstance("", int | str)
True
@end example

However, @ref{753,,parameterized generics} in
union objects cannot be checked:

@example
>>> isinstance(1, int | list[int])  # short-circuit evaluation
True
>>> isinstance([1], int | list[int])
Traceback (most recent call last):
  ...
TypeError: isinstance() argument 2 cannot be a parameterized generic
@end example
@end deffn

El tipo expuesto por el usuario para el objeto de conversión puede ser accedido desde @ref{6db,,types.UnionType} y usado por chequeos @ref{4ef,,isinstance()}. Un objeto no puede ser instancia por el tipo:

@example
>>> import types
>>> isinstance(int | str, types.UnionType)
True
>>> types.UnionType()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot create 'types.UnionType' instances
@end example

@cartouche
@quotation Nota 
The @code{__or__()} method for type objects was added to support the syntax
@code{X | Y}.  If a metaclass implements @code{__or__()}, the Union may
override it:

@example
>>> class M(type):
...     def __or__(self, other):
...         return "Hello"
...
>>> class C(metaclass=M):
...     pass
...
>>> C | int
'Hello'
>>> int | C
int | C
@end example
@end quotation
@end cartouche


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} — PEP propone la sintaxis @code{X | Y} y tipo Conversión.



Added in version 3.10.


@node Otros tipos predefinidos,Atributos especiales,Tipos de anotaciones de type — alias genérico Union,Tipos integrados
@anchor{library/stdtypes other-built-in-types}@anchor{2264}@anchor{library/stdtypes typesother}@anchor{2265}
@subsection Otros tipos predefinidos


El intérprete soporta otros tipos de objetos variados. La mayoría de ellos solo implementan una o dos operaciones.

@menu
* Módulos: Módulos<4>. 
* Clases e instancias de clase:: 
* Funciones:: 
* Métodos:: 
* Objetos código:: 
* Objetos Tipo:: 
* El objeto nulo (Null): El objeto nulo Null. 
* El objeto puntos suspensivos (Ellipsis): El objeto puntos suspensivos Ellipsis. 
* El objeto NotImplemented:: 
* Objetos internos:: 

@end menu

@node Módulos<4>,Clases e instancias de clase,,Otros tipos predefinidos
@anchor{library/stdtypes modules}@anchor{2266}@anchor{library/stdtypes typesmodules}@anchor{2267}
@subsubsection Módulos


La única operación especial que implementan los módulos es el acceso como atributos: @code{m.name}, donde `m' es un módulo y `name' accede a un nombre definido en la tabla de símbolos del módulo `m'. También se puede asignar valores a los atributos de un módulo (nótese que la sentencia @ref{682,,import} no es, estrictamente hablando, una operación del objeto de tipo módulo; la sentencia @code{import foo} no requiere la existencia de un módulo llamado `foo', sino una `definición' (externa) de un módulo `foo' en alguna parte).

Un atributo especial de cada módulo es @ref{5fe,,__dict__}. Es un diccionario que contiene la tabla de símbolos del módulo. Cambiar el diccionario cambiará por tanto el contenido de la tabla de símbolos, pero no es posible realizar una asignación directa al atributo @ref{5fe,,__dict__} (se puede realizar una asignación como @code{m.__dict__['a'] = 1}, que define el valor de @code{m.a} como @code{1}, pero no se puede hacer @code{m.__dict__ = @{@}}). No se recomienda manipular los contenidos del atributo @ref{5fe,,__dict__} directamente.

Los módulos incluidos en el intérprete se escriben así: @code{<module 'sys' (built-in)>}. Si se cargan desde un archivo, se escriben como @code{<module 'os' from '/usr/local/lib/pythonX.Y/os.pyc'>}.

@node Clases e instancias de clase,Funciones,Módulos<4>,Otros tipos predefinidos
@anchor{library/stdtypes classes-and-class-instances}@anchor{2268}@anchor{library/stdtypes typesobjects}@anchor{2269}
@subsubsection Clases e instancias de clase


Véase @ref{1ee1,,Objetos@comma{} valores y tipos} y @ref{133f,,Definiciones de clase} para más información.

@node Funciones,Métodos,Clases e instancias de clase,Otros tipos predefinidos
@anchor{library/stdtypes functions}@anchor{226a}@anchor{library/stdtypes typesfunctions}@anchor{226b}
@subsubsection Funciones


Los objetos de tipo función se crean mediante definiciones de función. La única operación posible con un objeto de tipo función es llamarla: @code{func(argument-list)}.

Hay dos tipos de funciones: Las funciones básicas o predefinidas y las funciones definidas por el usuario. Las dos soportan la misma operación (ser llamadas), pero la implementación es diferente, de ahí que se consideren de distintos tipo.

Véase @ref{1c3d,,Definiciones de funciones} para más información.

@node Métodos,Objetos código,Funciones,Otros tipos predefinidos
@anchor{library/stdtypes methods}@anchor{226c}@anchor{library/stdtypes typesmethods}@anchor{226d}
@subsubsection Métodos


@geindex object;method

Methods are functions that are called using the attribute notation. There are
two flavors: @ref{1f0c,,built-in methods} (such as @code{append()}
on lists) and @ref{1cc5,,class instance method}.
Built-in methods are described with the types that support them.

If you access a method (a function defined in a class namespace) through an
instance, you get a special object: a `bound method' (also called
@ref{1cc5,,instance method}) object. When called, it will add
the @code{self} argument
to the argument list.  Bound methods have two special read-only attributes:
@ref{1408,,m.__self__} is the object on which the method
operates, and @ref{1363,,m.__func__} is
the function implementing the method.  Calling @code{m(arg-1, arg-2, ..., arg-n)}
is completely equivalent to calling @code{m.__func__(m.__self__, arg-1, arg-2, ...,
arg-n)}.

Like @ref{3eb,,function objects}, bound method objects support
getting arbitrary
attributes.  However, since method attributes are actually stored on the
underlying function object (@ref{1363,,method.__func__}), setting method attributes on
bound methods is disallowed.  Attempting to set an attribute on a method
results in an @ref{441,,AttributeError} being raised.  In order to set a method
attribute, you need to explicitly set it on the underlying function object:

@example
>>> class C:
...     def method(self):
...         pass
...
>>> c = C()
>>> c.method.whoami = 'my name is method'  # can't set on the method
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'method' object has no attribute 'whoami'
>>> c.method.__func__.whoami = 'my name is method'
>>> c.method.whoami
'my name is method'
@end example

See @ref{1cc5,,Métodos de instancia} for more information.

@geindex object;code
@geindex code object

@node Objetos código,Objetos Tipo,Métodos,Otros tipos predefinidos
@anchor{library/stdtypes bltin-code-objects}@anchor{226e}@anchor{library/stdtypes code-objects}@anchor{226f}
@subsubsection Objetos código


@geindex built-in function;compile
@geindex __code__ (function object attribute)

Code objects are used by the implementation to represent «pseudo-compiled»
executable Python code such as a function body. They differ from function
objects because they don’t contain a reference to their global execution
environment.  Code objects are returned by the built-in @ref{2fb,,compile()} function
and can be extracted from function objects through their
@ref{3ec,,__code__} attribute. See also the @ref{1b,,code} module.

Accessing @ref{3ec,,__code__} raises an @ref{18c3,,auditing event}
@code{object.__getattr__} with arguments @code{obj} and @code{"__code__"}.

@geindex built-in function;exec
@geindex built-in function;eval

Un objeto de tipo código puede ser evaluado o ejecutando pasándolo como parámetros a las funciones incorporadas @ref{2ea,,exec()} o @ref{2eb,,eval()} (que también aceptan código Python en forma de cadena de caracteres).

Véase @ref{1ee4,,Jerarquía de tipos estándar} para más información.

@node Objetos Tipo,El objeto nulo Null,Objetos código,Otros tipos predefinidos
@anchor{library/stdtypes bltin-type-objects}@anchor{2189}@anchor{library/stdtypes type-objects}@anchor{2270}
@subsubsection Objetos Tipo


@geindex built-in function;type
@geindex module;types

Los objetos de tipo Tipo (`Type') representan a los distintos tipos de datos. El tipo de un objeto particular puede ser consultado usando la función incorporada @ref{dcf,,type()}. Los objetos Tipo no tienen ninguna operación especial. El módulo @ref{103,,types} define nombres para todos los tipos básicos definidos en la biblioteca estándar.

Los tipos se escriben de la siguiente forma: @code{<class 'int'>}.

@node El objeto nulo Null,El objeto puntos suspensivos Ellipsis,Objetos Tipo,Otros tipos predefinidos
@anchor{library/stdtypes bltin-null-object}@anchor{2271}@anchor{library/stdtypes the-null-object}@anchor{2272}
@subsubsection El objeto nulo (`Null')


Todas las funciones que no definen de forma explícita un valor de retorno retornan este objeto. Los objetos nulos no soportan ninguna operación especial. Solo existe un único objeto nulo, llamado @code{None} (un nombre predefinido o básico). La expresión @code{type(None)()} produce el mismo objeto @code{None}, esto se conoce como `Singleton'.

Se escribe @code{None}.

@geindex ...;ellipsis literal

@node El objeto puntos suspensivos Ellipsis,El objeto NotImplemented,El objeto nulo Null,Otros tipos predefinidos
@anchor{library/stdtypes bltin-ellipsis-object}@anchor{2273}@anchor{library/stdtypes the-ellipsis-object}@anchor{2274}
@subsubsection El objeto puntos suspensivos (`Ellipsis')


Este objeto es usado a menudo en operaciones de segmentado (véase @ref{204b,,Segmentos}). No soporta ninguna operación especial. Solo existe un único objeto de puntos suspensivos, llamado @ref{218d,,Ellipsis} (un nombre predefinido o básico). La expresión @code{type(Ellipsis)()} produce el mismo objeto @ref{218d,,Ellipsis}, esto se conoce como `Singleton'.

Se puede escribir como @code{Ellipsis} o @code{...}.

@node El objeto NotImplemented,Objetos internos,El objeto puntos suspensivos Ellipsis,Otros tipos predefinidos
@anchor{library/stdtypes bltin-notimplemented-object}@anchor{2275}@anchor{library/stdtypes the-notimplemented-object}@anchor{2276}
@subsubsection El objeto `NotImplemented'


This object is returned from comparisons and binary operations when they are
asked to operate on types they don’t support. See @ref{2071,,Comparaciones} for more
information.  There is exactly one @ref{227,,NotImplemented} object.
@code{type(NotImplemented)()} produces the singleton instance.

It is written as @code{NotImplemented}.

@node Objetos internos,,El objeto NotImplemented,Otros tipos predefinidos
@anchor{library/stdtypes internal-objects}@anchor{2277}@anchor{library/stdtypes typesinternal}@anchor{2278}
@subsubsection Objetos internos


See @ref{1ee4,,Jerarquía de tipos estándar} for this information.  It describes
@ref{780,,stack frame objects},
@ref{b7f,,traceback objects}, and slice objects.

@node Atributos especiales,Limitación de longitud de conversión de cadena de tipo entero,Otros tipos predefinidos,Tipos integrados
@anchor{library/stdtypes special-attributes}@anchor{2279}@anchor{library/stdtypes specialattrs}@anchor{227a}
@subsection Atributos especiales


La implementación añade unos cuantos atributos de solo lectura a varios tipos de objetos, cuando resulta relevante. Algunos de estos atributos son reportados por la función incorporada @ref{6d3,,dir()}.

@geindex __name__ (atributo de definition)
@anchor{library/stdtypes definition __name__}@anchor{10e2}
@deffn {Atributo} definition.__name__

El nombre de la clase, función, método, descriptor o instancia generadora.
@end deffn

@geindex __qualname__ (atributo de definition)
@anchor{library/stdtypes definition __qualname__}@anchor{10e1}
@deffn {Atributo} definition.__qualname__

El nombre calificado (@ref{194a,,qualified name}) de la clase, función, método, descriptor o instancia generadora.


Added in version 3.3.

@end deffn

@geindex __module__ (atributo de definition)
@anchor{library/stdtypes definition __module__}@anchor{227b}
@deffn {Atributo} definition.__module__

The name of the module in which a class or function was defined.
@end deffn

@geindex __doc__ (atributo de definition)
@anchor{library/stdtypes definition __doc__}@anchor{9bb}
@deffn {Atributo} definition.__doc__

The documentation string of a class or function, or @code{None} if undefined.
@end deffn

@geindex __type_params__ (atributo de definition)
@anchor{library/stdtypes definition __type_params__}@anchor{2139}
@deffn {Atributo} definition.__type_params__

The @ref{3fc,,type parameters} of generic classes, functions,
and @ref{500,,type aliases}. For classes and functions that
are not generic, this will be an empty tuple.


Added in version 3.12.

@end deffn

@node Limitación de longitud de conversión de cadena de tipo entero,,Atributos especiales,Tipos integrados
@anchor{library/stdtypes int-max-str-digits}@anchor{695}@anchor{library/stdtypes integer-string-conversion-length-limitation}@anchor{227c}
@subsection Limitación de longitud de conversión de cadena de tipo entero


CPython tiene un límite global para conversiones entre @ref{1f0,,int} y @ref{237,,str} para mitigar los ataques de denegación de servicio. Este límite `solo' se aplica a decimales u otras bases numéricas que no sean potencias de dos. Las conversiones hexadecimales, octales y binarias son ilimitadas. Se puede configurar el límite.

The @ref{1f0,,int} type in CPython is an arbitrary length number stored in binary
form (commonly known as a «bignum»). There exists no algorithm that can convert
a string to a binary integer or a binary integer to a string in linear time,
`unless' the base is a power of 2. Even the best known algorithms for base 10
have sub-quadratic complexity. Converting a large value such as @code{int('1' *
500_000)} can take over a second on a fast CPU.

Limiting conversion size offers a practical way to avoid 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.

El límite se aplica al número de caracteres de dígitos en la cadena de entrada o salida cuando estaría involucrado un algoritmo de conversión no lineal. Los guiones bajos y el signo no se cuentan para el límite.

Cuando una operación excede el límite, se lanza una excepción @ref{360,,ValueError}:

@example
>>> import sys
>>> sys.set_int_max_str_digits(4300)  # Illustrative, this is the default.
>>> _ = int('2' * 5432)
Traceback (most recent call last):
...
ValueError: Exceeds the limit (4300 digits) for integer string conversion: value has 5432 digits; use sys.set_int_max_str_digits() to increase the limit
>>> i = int('2' * 4300)
>>> len(str(i))
4300
>>> i_squared = i*i
>>> len(str(i_squared))
Traceback (most recent call last):
...
ValueError: Exceeds the limit (4300 digits) for integer string conversion; use sys.set_int_max_str_digits() to increase the limit
>>> len(hex(i_squared))
7144
>>> assert int(hex(i_squared), base=16) == i*i  # Hexadecimal is unlimited.
@end example

El límite predeterminado es de 4300 dígitos como se indica en @ref{1300,,sys.int_info.default_max_str_digits}. El límite más bajo que se puede configurar es de 640 dígitos como se indica en @ref{1300,,sys.int_info.str_digits_check_threshold}.

Verificación:

@example
>>> import sys
>>> assert sys.int_info.default_max_str_digits == 4300, sys.int_info
>>> assert sys.int_info.str_digits_check_threshold == 640, sys.int_info
>>> msg = int('578966293710682886880994035146873798396722250538762761564'
...           '9252925514383915483333812743580549779436104706260696366600'
...           '571186405732').to_bytes(53, 'big')
...
@end example


Added in version 3.11.


@menu
* APIs afectadas:: 
* Configuración del límite:: 
* Configuración recomendada:: 

@end menu

@node APIs afectadas,Configuración del límite,,Limitación de longitud de conversión de cadena de tipo entero
@anchor{library/stdtypes affected-apis}@anchor{227d}
@subsubsection APIs afectadas


La limitación solo se aplica a conversiones potencialmente lentas entre @ref{1f0,,int} y @ref{237,,str} o @ref{325,,bytes}:


@itemize *

@item 
@code{int(string)} con base predeterminada a 10.

@item 
@code{int(string, base)} para todas las bases que no sean una potencia de 2.

@item 
@code{str(integer)}.

@item 
@code{repr(integer)}.

@item 
cualquier otra conversión de cadena a base 10, por ejemplo, @code{f"@{integer@}"}, @code{"@{@}".format(integer)} o @code{b"%d" % integer}.
@end itemize

Las limitaciones no se aplican a funciones con un algoritmo lineal:


@itemize *

@item 
@code{int(string, base)} con base 2, 4, 8, 16 o 32.

@item 
@ref{1857,,int.from_bytes()} y @ref{1897,,int.to_bytes()}.

@item 
@ref{1337,,hex()}, @ref{1336,,oct()}, @ref{1314,,bin()}.

@item 
@ref{347,,Especificación de formato Mini-Lenguaje} para números hexadecimales, octales y binarios.

@item 
@ref{237,,str} a @ref{153,,float}.

@item 
@ref{237,,str} a @ref{16a,,decimal.Decimal}.
@end itemize

@node Configuración del límite,Configuración recomendada,APIs afectadas,Limitación de longitud de conversión de cadena de tipo entero
@anchor{library/stdtypes configuring-the-limit}@anchor{227e}
@subsubsection Configuración del límite


Antes de que se inicie Python, puedes usar una variable de entorno o un indicador de línea de comandos del intérprete para configurar el límite:


@itemize *

@item 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS}, por ejemplo, @code{PYTHONINTMAXSTRDIGITS=640 python3} para configurar el límite a 640 o @code{PYTHONINTMAXSTRDIGITS=0 python3} para desactivar la limitación.

@item 
@ref{2e2,,-X int_max_str_digits}, por ejemplo, @code{python3 -X int_max_str_digits=640}

@item 
@ref{227f,,sys.flags.int_max_str_digits} contains the value of
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS} or @ref{2e2,,-X int_max_str_digits}.
If both the env var and the @code{-X} option are set, the @code{-X} option takes
precedence. A value of `-1' indicates that both were unset, thus a value of
@ref{2280,,sys.int_info.default_max_str_digits} was used during initialization.
@end itemize

Desde el código, puedes inspeccionar el límite actual y configurar uno nuevo al usar estas APIs de @ref{d9,,sys}:


@itemize *

@item 
@ref{2281,,sys.get_int_max_str_digits()} y @ref{17c6,,sys.set_int_max_str_digits()} son un getter y un setter para el límite de todo el intérprete. Los subintérpretes tienen su propio límite.
@end itemize

Information about the default and minimum can be found in @ref{1300,,sys.int_info}:


@itemize *

@item 
@ref{1300,,sys.int_info.default_max_str_digits} es el límite predeterminado compilado.

@item 
@ref{1300,,sys.int_info.str_digits_check_threshold} es el valor más bajo aceptado para el límite (aparte de 0, que lo desactiva).
@end itemize


Added in version 3.11.


@cartouche
@quotation Prudencia 
Configurar un límite bajo `puede' generar problemas. Si bien es raro, existe un código que contiene constantes enteras en decimal en su origen que excede el umbral mínimo. Una consecuencia de configurar el límite es que el código fuente de Python que contiene literales enteros decimales más grandes que el límite encontrará un error durante el análisis, generalmente en el momento de inicio o en el momento de importación o incluso en el momento de instalación - en cualquier momento y actualizado, @code{.pyc} no existe ya para el código. Una solución para la fuente que contiene constantes tan grandes es convertirlas a la forma hexadecimal @code{0x} ya que no tiene límite.

Prueba tu aplicación minuciosamente si utilizas un límite bajo. Asegúrate de que tus pruebas se ejecuten con el límite configurado temprano a través del entorno o del indicador para que se aplique durante el inicio e incluso durante cualquier paso de instalación que pueda invocar a Python para precompilar las fuentes @code{.py} a los archivos @code{.pyc}.
@end quotation
@end cartouche

@node Configuración recomendada,,Configuración del límite,Limitación de longitud de conversión de cadena de tipo entero
@anchor{library/stdtypes recommended-configuration}@anchor{2282}
@subsubsection Configuración recomendada


The default @ref{2280,,sys.int_info.default_max_str_digits} is expected to be
reasonable for most applications. If your application requires a different
limit, set it from your main entry point using Python version agnostic code as
these APIs were added in security patch releases in versions before 3.12.

Por ejemplo:

@example
>>> import sys
>>> if hasattr(sys, "set_int_max_str_digits"):
...     upper_bound = 68000
...     lower_bound = 4004
...     current_limit = sys.get_int_max_str_digits()
...     if current_limit == 0 or current_limit > upper_bound:
...         sys.set_int_max_str_digits(upper_bound)
...     elif current_limit < lower_bound:
...         sys.set_int_max_str_digits(lower_bound)
@end example

Si necesitas deshabilitarlo por completo, configúralo en @code{0}.

@subsubheading Notas al pie


@node Excepciones incorporadas,Servicios de procesamiento de texto,Tipos integrados,La biblioteca estándar de Python
@anchor{library/exceptions doc}@anchor{2283}@anchor{library/exceptions bltin-exceptions}@anchor{188b}@anchor{library/exceptions built-in-exceptions}@anchor{2284}
@section Excepciones incorporadas


@geindex statement;try
@geindex statement;except

En Python, todas las excepciones deben ser instancias de una clase que se derive de @ref{65c,,BaseException}. En una instrucción @ref{789,,try} con una cláusula @ref{2f6,,except} que menciona una clase determinada, esa cláusula también controla las clases de excepción derivadas de esa clase (excepto las clases de excepción de las que se deriva `it'). Dos clases de excepción que no están relacionadas mediante subclases nunca son equivalentes, incluso si tienen el mismo nombre.

@geindex statement;raise

The built-in exceptions listed in this chapter can be generated by the interpreter or
built-in functions.  Except where mentioned, they have an «associated value»
indicating the detailed cause of the error.  This may be a string or a tuple of
several items of information (e.g., an error code and a string explaining the
code).  The associated value is usually passed as arguments to the exception
class’s constructor.

El código de usuario puede lanzar excepciones predefinidas. Esto puede ser usado para probar un gestor de excepciones o para notificar una condición de error «igual» a la situación en la cual el intérprete lance la misma excepción; pero tenga en cuenta que no hay nada que impida que el código del usuario produzca un error inapropiado.

Las clases de excepción predefinidas pueden ser usadas como subclases para definir otras nuevas; se recomienda a los programadores que deriven nuevas excepciones a partir de la clase @ref{a6b,,Exception} o de una de sus subclases, y no de @ref{65c,,BaseException}. Hay disponible más información sobre la definición de excepciones en el Tutorial de Python en @ref{1c9b,,Excepciones definidas por el usuario}.

@menu
* Contexto de una excepción:: 
* Heredando de excepciones incorporadas:: 
* Clases base:: 
* Excepciones específicas:: 
* Advertencias:: 
* Grupos de excepciones:: 
* Jerarquía de excepción:: 

@end menu

@node Contexto de una excepción,Heredando de excepciones incorporadas,,Excepciones incorporadas
@anchor{library/exceptions exception-context}@anchor{2285}
@subsection Contexto de una excepción


@geindex exception;chaining
@geindex __cause__ (exception attribute)
@geindex __context__ (exception attribute)
@geindex __suppress_context__ (exception attribute)

Three attributes on exception objects provide information about the context in
which the exception was raised:

@geindex __context__ (atributo de BaseException)
@geindex __cause__ (atributo de BaseException)
@geindex __suppress_context__ (atributo de BaseException)
@anchor{library/exceptions BaseException __context__}@anchor{1331}
@deffn {Atributo} BaseException.__context__
@anchor{library/exceptions BaseException __cause__}@anchor{1332}
@deffnx {Atributo} BaseException.__cause__
@anchor{library/exceptions BaseException __suppress_context__}@anchor{20b3}
@deffnx {Atributo} BaseException.__suppress_context__

When raising a new exception while another exception
is already being handled, the new exception’s
@code{__context__} attribute is automatically set to the handled
exception.  An exception may be handled when an @ref{2f6,,except} or
@ref{a5c,,finally} clause, or a @ref{673,,with} statement, is used.

Este contexto de excepción implícita se puede complementar con una causa explícita usando @code{from} con @ref{68d,,raise}:

@example
raise new_exc from original_exc
@end example

The expression following @ref{68d,,from} must be an exception or @code{None}. It
will be set as @code{__cause__} on the raised exception. Setting
@code{__cause__} also implicitly sets the @code{__suppress_context__}
attribute to @code{True}, so that using @code{raise new_exc from None}
effectively replaces the old exception with the new one for display
purposes (e.g. converting @ref{438,,KeyError} to @ref{441,,AttributeError}), while
leaving the old exception available in @code{__context__} for introspection
when debugging.

The default traceback display code shows these chained exceptions in
addition to the traceback for the exception itself. An explicitly chained
exception in @code{__cause__} is always shown when present. An implicitly
chained exception in @code{__context__} is shown only if @code{__cause__}
is @ref{716,,None} and @code{__suppress_context__} is false.

En cualquier caso, la excepción en sí siempre se muestra después de cualquier excepción encadenada para que la línea final del seguimiento siempre muestre la última excepción que se generó.
@end deffn

@node Heredando de excepciones incorporadas,Clases base,Contexto de una excepción,Excepciones incorporadas
@anchor{library/exceptions inheriting-from-built-in-exceptions}@anchor{2286}
@subsection Heredando de excepciones incorporadas


El código del usuario puede crear subclases que heredan de una excepción. Se recomienda heredar solo de una clase de tipo excepción a la vez para evitar cualquier conflicto posible en el manejo del atributo @code{args} por parte de las clases base, como también por posibles incompatibilidades en de la memoria.

`Detalles de implementación de CPython:' La mayoría de las excepciones integradas están implementadas en C por eficiencia, vea: Objects/exceptions.c@footnote{https://github.com/python/cpython/tree/main/Objects/exceptions.c}.  Algunas tienen distribuciones de memoria personalizadas, lo que hace imposible crear una subclase que herede de múltiples tipos de excepciones. La distribución de memoria de un tipo es un detalle de implementación y podría cambiar entre versiones de Python, llevando a nuevos conflictos en el futuro.  Por lo tanto, se recomienda evitar la herencia de múltiples tipos de excepción.

@node Clases base,Excepciones específicas,Heredando de excepciones incorporadas,Excepciones incorporadas
@anchor{library/exceptions base-classes}@anchor{2287}
@subsection Clases base


Las siguientes excepciones se utilizan principalmente como clases base para otras excepciones.

@geindex BaseException
@anchor{library/exceptions BaseException}@anchor{65c}
@deffn {Excepción} BaseException

La clase base para todas las excepciones predefinidas. No está pensada para ser heredada directamente por las clases definidas por el usuario (para eso, use @ref{a6b,,Exception}). Si se llama a @ref{237,,str()} en una instancia de esta clase, se retorna la representación de los argumentos de la instancia o la cadena vacía cuando no había argumentos.

@geindex args (atributo de BaseException)
@anchor{library/exceptions BaseException args}@anchor{610}
@deffn {Atributo} args

La tupla de argumentos dada al constructor de excepción. Algunas excepciones predefinidas (como @ref{4d5,,OSError}) esperan un cierto número de argumentos y asignan un significado especial a los elementos de esta tupla, mientras que otras normalmente se llaman solo con una sola cadena que da un mensaje de error.
@end deffn

@geindex with_traceback() (método de BaseException)
@anchor{library/exceptions BaseException with_traceback}@anchor{20b2}
@deffn {Método} with_traceback (tb)

Este método establece `tb' como el nuevo rastreo para la excepción y retorna el objeto de excepción. Se usaba con más frecuencia antes de que las características de encadenamiento de excepciones de 
@geindex Python Enhancement Proposals; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/} estuvieran disponibles. El siguiente ejemplo muestra cómo podemos convertir una instancia de @code{SomeException} en una instancia de @code{OtherException} mientras se conserva el rastreo. Una vez generado, el marco actual se inserta en el rastreo del @code{OtherException}, como habría sucedido con el rastreo del @code{SomeException} original si hubiéramos permitido que se propagara al llamador.

@example
try:
    ...
except SomeException:
    tb = sys.exception().__traceback__
    raise OtherException(...).with_traceback(tb)
@end example
@end deffn

@geindex __traceback__ (atributo de BaseException)
@anchor{library/exceptions BaseException __traceback__}@anchor{1330}
@deffn {Atributo} __traceback__

A writable field that holds the
@ref{b7f,,traceback object} associated with this
exception. See also: @ref{68d,,La declaración raise}.
@end deffn

@geindex add_note() (método de BaseException)
@anchor{library/exceptions BaseException add_note}@anchor{65b}
@deffn {Método} add_note (note)

Agrega la cadena @code{note} a las notas de la excepción, las cuales aparecen en el rastreo después de la cadena de la excepción. Se lanza un @ref{228,,TypeError} si @code{note} no es una cadena de caracteres.


Added in version 3.11.

@end deffn

@geindex __notes__ (atributo de BaseException)
@anchor{library/exceptions BaseException __notes__}@anchor{2288}
@deffn {Atributo} __notes__

Una lista de las notas de esta excepción, las cuales fueron añadidas con el método @ref{65b,,add_note()}. Este atributo es creado cuando se llama a @ref{65b,,add_note()}.


Added in version 3.11.

@end deffn
@end deffn

@geindex Exception
@anchor{library/exceptions Exception}@anchor{a6b}
@deffn {Excepción} Exception

Todas las excepciones predefinidas `non-system-exiting', que no salen del sistema se derivan de esta clase. Todas las excepciones definidas por el usuario también deben derivarse de esta clase.
@end deffn

@geindex ArithmeticError
@anchor{library/exceptions ArithmeticError}@anchor{2289}
@deffn {Excepción} ArithmeticError

La clase base para las excepciones predefinidas que se generan para varios errores aritméticos: @ref{919,,OverflowError}, @ref{9d8,,ZeroDivisionError}, @ref{228a,,FloatingPointError}.
@end deffn

@geindex BufferError
@anchor{library/exceptions BufferError}@anchor{182b}
@deffn {Excepción} BufferError

Se genera cuando @ref{48a,,buffer} no se puede realizar una operación relacionada.
@end deffn

@geindex LookupError
@anchor{library/exceptions LookupError}@anchor{21d5}
@deffn {Excepción} LookupError

La clase base para las excepciones que se generan cuando una clave o índice utilizado en un mapa o secuencia que no es válido: @ref{1575,,IndexError}, @ref{438,,KeyError}. Esto se puede lanzar directamente por @ref{9f6,,codecs.lookup()}.
@end deffn

@node Excepciones específicas,Advertencias,Clases base,Excepciones incorporadas
@anchor{library/exceptions concrete-exceptions}@anchor{228b}
@subsection Excepciones específicas


Las siguientes excepciones son las excepciones que normalmente se generan.

@geindex AssertionError
@anchor{library/exceptions AssertionError}@anchor{74a}
@deffn {Excepción} AssertionError

@geindex statement;assert

Se genera cuando se produce un error en una instrucción @ref{9fa,,assert}.
@end deffn

@geindex AttributeError
@anchor{library/exceptions AttributeError}@anchor{441}
@deffn {Excepción} AttributeError

Se genera cuando se produce un error en una referencia de atributo (ver @ref{2045,,Referencias de atributos}) o la asignación falla. (Cuando un objeto no admite referencias de atributos o asignaciones de atributos en absoluto, se genera @ref{228,,TypeError}.)

Los atributos @code{name} y @code{obj} se pueden configurar utilizando argumentos de solo palabras clave para el constructor. Cuando se establecen, representan el nombre del atributo al que se intentó acceder y el objeto al que se accedió para dicho atributo, respectivamente.


Distinto en la versión 3.10: Se agregaron los atributos @code{name} y @code{obj}.

@end deffn

@geindex EOFError
@anchor{library/exceptions EOFError}@anchor{1341}
@deffn {Excepción} EOFError

Se genera cuando la función @ref{1340,,input()} alcanza una condición de fin de archivo (EOF) sin leer ningún dato. (Note que el @code{io. IOBase.read()} y @ref{1391,,io.IOBase.readline()} retornan una cadena vacía cuando llegan a EOF.)
@end deffn

@geindex FloatingPointError
@anchor{library/exceptions FloatingPointError}@anchor{228a}
@deffn {Excepción} FloatingPointError

No se usa actualmente.
@end deffn

@geindex GeneratorExit
@anchor{library/exceptions GeneratorExit}@anchor{1407}
@deffn {Excepción} GeneratorExit

Se genera cuando un @ref{10dd,,generator} o @ref{53a,,coroutine} está cerrado; ver @ref{16fa,,generator.close()} y @ref{1fce,,coroutine.close()}. Hereda directamente de @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception} ya que técnicamente no es un error.
@end deffn

@geindex ImportError
@anchor{library/exceptions ImportError}@anchor{4d7}
@deffn {Excepción} ImportError

Se genera cuando la instrucción @ref{682,,import} tiene problemas al intentar cargar un módulo. También se produce cuando la `from list' en @code{from ... import} tiene un nombre que no se puede encontrar.

Los argumentos opcionales `name' y `path' de solo palabras clave establecen los atributos correspondientes:

@geindex name (atributo de ImportError)
@anchor{library/exceptions ImportError name}@anchor{228c}
@deffn {Atributo} name

El nombre del módulo que se intentó importar.
@end deffn

@geindex path (atributo de ImportError)
@anchor{library/exceptions ImportError path}@anchor{228d}
@deffn {Atributo} path

La ruta a cualquier archivo que provocó la excepción.
@end deffn


Distinto en la versión 3.3: Se han añadido los atributos @ref{228c,,name} y @ref{228d,,path}.

@end deffn

@geindex ModuleNotFoundError
@anchor{library/exceptions ModuleNotFoundError}@anchor{bcf}
@deffn {Excepción} ModuleNotFoundError

Una subclase de @ref{4d7,,ImportError} que se genera mediante @ref{682,,import} cuando no se pudo encontrar un módulo. También se genera cuando @code{None} se encuentra en @ref{1976,,sys.modules}.


Added in version 3.6.

@end deffn

@geindex IndexError
@anchor{library/exceptions IndexError}@anchor{1575}
@deffn {Excepción} IndexError

Se genera cuando un subíndice de secuencia está fuera del rango. (Los índices de la rebanada son truncados silenciosamente para caer en el intervalo permitido; si un índice no es un entero, se genera @ref{228,,TypeError}.)

@c XXX xref to sequences
@end deffn

@geindex KeyError
@anchor{library/exceptions KeyError}@anchor{438}
@deffn {Excepción} KeyError

Se genera cuando no se encuentra una clave de asignación (diccionario) en el conjunto de claves existentes (mapa).

@c XXX xref to mapping objects?
@end deffn

@geindex KeyboardInterrupt
@anchor{library/exceptions KeyboardInterrupt}@anchor{a63}
@deffn {Excepción} KeyboardInterrupt

Se genera cuando el usuario pulsa la tecla de interrupción (normalmente @code{Control-C} o @code{Delete}). Durante la ejecución, se realiza una comprobación de interrupciones con regularidad. La excepción hereda de @ref{65c,,BaseException} para no ser detectada de forma accidental por @ref{a6b,,Exception} y, por lo tanto, prevenir que el intérprete salga.

@cartouche
@quotation Nota 
Capturar una @ref{a63,,KeyboardInterrupt} requiere especial consideración. Debido a que puede ser lanzada en puntos impredecibles, puede, en algunas circunstancias, dejar al programa en ejecución en un estado inconsistente. Por lo general, es mejor permitir que @ref{a63,,KeyboardInterrupt} termine el programa tan pronto como sea o evitar lanzarla por completo. (Vea @ref{228e,,Nota sobre Manejadores de Señales y Excepciones}.)
@end quotation
@end cartouche
@end deffn

@geindex MemoryError
@anchor{library/exceptions MemoryError}@anchor{16cb}
@deffn {Excepción} MemoryError

Se genera cuando una operación se queda sin memoria pero la situación aún puede ser recuperada (eliminando algunos objetos). El valor asociado es una cadena que indica que tipo de operación (interna) se quedó sin memoria. Tenga en cuenta que debido a la arquitectura de administración de memoria (función @code{malloc()} de C), el intérprete no siempre puede recuperarse completamente de esta situación; sin embargo, plantea una excepción para que se pueda imprimir un seguimiento de la pila, en caso de que un programa fuera de servicio fuera lo causa.
@end deffn

@geindex NameError
@anchor{library/exceptions NameError}@anchor{4ec}
@deffn {Excepción} NameError

Se genera cuando no se encuentra un nombre local o global. Esto se aplica solo a nombres no calificados. El valor asociado es un mensaje de error que incluye el nombre que no se pudo encontrar.

El atributo @code{name} se puede establecer utilizando un argumento de solo palabras clave para el constructor. Cuando se establece, representa el nombre de la variable a la que se intentó acceder.


Distinto en la versión 3.10: Se agregó el atributo @code{name}.

@end deffn

@geindex NotImplementedError
@anchor{library/exceptions NotImplementedError}@anchor{384}
@deffn {Excepción} NotImplementedError

Esta excepción se deriva de @ref{1e5,,RuntimeError}. En las clases base definidas por el usuario, los métodos abstractos deberían lanzar esta excepción cuando requieren clases derivadas para anular el método, o mientras se desarrolla la clase para indicar que la implementación real aún necesita ser agregada.

@cartouche
@quotation Nota 
No debe usarse para indicar que un operador o método no debe ser admitido en absoluto – en ese caso, deje el operador / método sin definir o, si es una subclase, se establece en @ref{716,,None}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@code{NotImplementedError} and @ref{227,,NotImplemented} are not interchangeable,
even though they have similar names and purposes.  See
@code{NotImplemented} for details on when to use it.
@end quotation
@end cartouche
@end deffn

@geindex OSError
@anchor{library/exceptions OSError}@anchor{4d5}
@deffn {Excepción} OSError ([arg])

@deffnx {Excepción} OSError (errno, strerror[, filename[, winerror[, filename2]]])

@geindex module;errno

Esta excepción se produce cuando una función del sistema retorna un error relacionado con el sistema, que incluye fallas de E/S como @code{file not found} o @code{disk full} (no para tipos de argumentos ilegales u otros errores incidentales).

La segunda forma del constructor establece los atributos correspondientes, que se describen a continuación. Los atributos predeterminados son @ref{716,,None} si no se especifican. Para compatibilidad con versiones anteriores, si se pasan tres argumentos, el atributo @ref{610,,args} contiene solo una tupla de 2 de los dos primeros argumentos del constructor.

El constructor a menudo retorna una subclase de @ref{4d5,,OSError}, como se describe en @ref{228f,,OS exceptions} a continuación. La subclase particular depende del valor final @ref{2290,,errno}. Este comportamiento solo ocurre cuando se construye @ref{4d5,,OSError} directamente o mediante un alias, y no se hereda al derivar.

@geindex errno (atributo de OSError)
@anchor{library/exceptions OSError errno}@anchor{2290}
@deffn {Atributo} errno

Un código de error numérico de la variable C, @code{errno}.
@end deffn

@geindex winerror (atributo de OSError)
@anchor{library/exceptions OSError winerror}@anchor{2291}
@deffn {Atributo} winerror

En Windows, esto le proporciona el código de error nativo de Windows. El atributo @ref{2290,,errno} es entonces una traducción aproximada, en términos POSIX, de ese código de error nativo.

En Windows, si el argumento del constructor @code{winerror} es un entero, el atributo @ref{2290,,errno} se determina a partir del código de error de Windows y el argumento @code{errno} se ignora. En otras plataformas, el argumento @code{winerror} se ignora y el atributo @ref{2291,,winerror} no existe.
@end deffn

@geindex strerror (atributo de OSError)
@anchor{library/exceptions OSError strerror}@anchor{2292}
@deffn {Atributo} strerror

El mensaje de error correspondiente, tal como lo proporciona el sistema operativo. Está formateado por las funciones de C, @code{perror()} en POSIX, y @code{FormatMessage()} en Windows.
@end deffn

@geindex filename (atributo de OSError)
@geindex filename2 (atributo de OSError)
@anchor{library/exceptions OSError filename}@anchor{2293}
@deffn {Atributo} filename
@anchor{library/exceptions OSError filename2}@anchor{2294}
@deffnx {Atributo} filename2

Para las excepciones que involucran una ruta del sistema de archivos (como @ref{1be,,open()} o @ref{1168,,os.unlink()}), @ref{2293,,filename} es el nombre del archivo pasado a la función. Para las funciones que involucran dos rutas del sistema de archivos (como @ref{1164,,os.rename()}), @ref{2294,,filename2} corresponde al segundo nombre de archivo pasado a la función.
@end deffn


Distinto en la versión 3.3: @ref{10cf,,EnvironmentError}, @ref{10ce,,IOError}, @ref{10d0,,WindowsError}, @ref{10d1,,socket.error}, @ref{10d2,,select.error} y @code{mmap.error} se han fusionado en @ref{4d5,,OSError}, y el constructor puede retornar una subclase.



Distinto en la versión 3.4: El atributo @ref{2293,,filename} es ahora el nombre de archivo original pasado a la función, en lugar del nombre codificado o decodificado desde @ref{5dd,,filesystem encoding and error handler}. Además, se agregaron el argumento y atributo del constructor `filename2'.

@end deffn

@geindex OverflowError
@anchor{library/exceptions OverflowError}@anchor{919}
@deffn {Excepción} OverflowError

Raised when the result of an arithmetic operation is too large to be
represented.  This cannot occur for integers (which would rather raise
@ref{16cb,,MemoryError} than give up).  However, for historical reasons,
OverflowError is sometimes raised for integers that are outside a required
range.   Because of the lack of standardization of floating-point exception
handling in C, most floating-point operations are not checked.
@end deffn

@geindex PythonFinalizationError
@anchor{library/exceptions PythonFinalizationError}@anchor{2ba}
@deffn {Excepción} PythonFinalizationError

This exception is derived from @ref{1e5,,RuntimeError}.  It is raised when
an operation is blocked during interpreter shutdown also known as
@ref{2bb,,Python finalization}.

Examples of operations which can be blocked with a
@ref{2ba,,PythonFinalizationError} during the Python finalization:


@itemize *

@item 
Creating a new Python thread.

@item 
@ref{2ff,,os.fork()}.
@end itemize

See also the @ref{ef5,,sys.is_finalizing()} function.


Added in version 3.13: Anteriormente, se planteó un simple @ref{1e5,,RuntimeError}.

@end deffn

@geindex RecursionError
@anchor{library/exceptions RecursionError}@anchor{df1}
@deffn {Excepción} RecursionError

Esta excepción se deriva de @ref{1e5,,RuntimeError}. Se lanza cuando el intérprete detecta que se excede la profundidad máxima de recursión (ver @ref{56b,,sys.getrecursionlimit()}).


Added in version 3.5: Anteriormente, se planteó un simple @ref{1e5,,RuntimeError}.

@end deffn

@geindex ReferenceError
@anchor{library/exceptions ReferenceError}@anchor{154f}
@deffn {Excepción} ReferenceError

Esta excepción se produce cuando un proxy de referencia débil, creado por la función @ref{189b,,weakref.proxy()}, se utiliza para acceder a un atributo del referente después de que se ha recolectado basura. Para obtener más información sobre referencias débiles, consulte el módulo @ref{114,,weakref} .
@end deffn

@geindex RuntimeError
@anchor{library/exceptions RuntimeError}@anchor{1e5}
@deffn {Excepción} RuntimeError

Se genera cuando se detecta un error que no corresponde a ninguna de las otras categorías. El valor asociado es una cadena que indica exactamente qué salió mal.
@end deffn

@geindex StopIteration
@anchor{library/exceptions StopIteration}@anchor{c82}
@deffn {Excepción} StopIteration

Generado por la función incorporada @ref{86f,,next()} y un @ref{313,,iterator}'s @ref{1335,,__next__()} para indicar que no hay más elementos producidos por el iterador.

@geindex value (atributo de StopIteration)
@anchor{library/exceptions StopIteration value}@anchor{1fca}
@deffn {Atributo} value

The exception object has a single attribute @code{value}, which is
given as an argument when constructing the exception, and defaults
to @ref{716,,None}.
@end deffn

Cuando se retorna una función @ref{10dd,,generator} o @ref{53a,,coroutine}, se genera una nueva instancia @ref{c82,,StopIteration}, y el valor retornado por la función se utiliza como parámetro @ref{1fca,,value} para constructor de la excepción.

Si un generador lanza directa o indirectamente @ref{c82,,StopIteration}, se convierte en @ref{1e5,,RuntimeError} (conservando @ref{c82,,StopIteration} como la causa de la nueva excepción).


Distinto en la versión 3.3: Se agregó el atributo @cite{*value*} y la capacidad de las funciones del generador de usarlo para retornar un valor.



Distinto en la versión 3.5: Introdujo la transformación `RuntimeError' a través de @code{from __future__ import generator_stop}, ver 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.



Distinto en la versión 3.7: Habilitar 
@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} para todo el código por defecto: a @ref{c82,,StopIteration} generado en un generador se transforma en @ref{1e5,,RuntimeError}.

@end deffn

@geindex StopAsyncIteration
@anchor{library/exceptions StopAsyncIteration}@anchor{1a34}
@deffn {Excepción} StopAsyncIteration

Se debe lanzar mediante el método @ref{1f09,,__anext__()} de un objeto @ref{312,,asynchronous iterator} para detener la iteración.


Added in version 3.5.

@end deffn

@geindex SyntaxError
@anchor{library/exceptions SyntaxError}@anchor{150}
@deffn {Excepción} SyntaxError (message, details)

Se genera cuando el analizador encuentra un error de sintaxis. Esto puede ocurrir en una instrucción @ref{682,,import}, en una llamada a las funciones integradas @ref{2fb,,compile()}, @ref{2ea,,exec()} o @ref{2eb,,eval()}, o al leer el script inicial o la entrada estándar (también de forma interactiva).

El @ref{237,,str()} de la instancia de excepción retorna solo el mensaje de error. Detalles es una tupla cuyos miembros también están disponibles como atributos separados.

@geindex filename (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError filename}@anchor{2295}
@deffn {Atributo} filename

El nombre del archivo en el que se produjo el error de sintaxis.
@end deffn

@geindex lineno (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError lineno}@anchor{2296}
@deffn {Atributo} lineno

En qué número de línea del archivo se produjo el error. Tiene un índice 1: la primera línea del archivo tiene un @code{lineno} de 1.
@end deffn

@geindex offset (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError offset}@anchor{2297}
@deffn {Atributo} offset

La columna de la línea donde ocurrió el error. Está indexado a 1: el primer carácter de la línea tiene un @code{offset} de 1.
@end deffn

@geindex text (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError text}@anchor{2298}
@deffn {Atributo} text

El texto del código fuente involucrado en el error.
@end deffn

@geindex end_lineno (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError end_lineno}@anchor{2299}
@deffn {Atributo} end_lineno

En qué número de línea del archivo termina el error. Está indexado a 1: la primera línea del archivo tiene un @code{lineno} de 1.
@end deffn

@geindex end_offset (atributo de SyntaxError)
@anchor{library/exceptions SyntaxError end_offset}@anchor{229a}
@deffn {Atributo} end_offset

Finaliza la columna de la línea final donde ocurrió el error. Está indexado a 1: el primer carácter de la línea tiene un @code{offset} de 1.
@end deffn

Para errores en los campos de cadena f, el mensaje tiene el prefijo «cadena f:» y las compensaciones son compensaciones en un texto construido a partir de la expresión de reemplazo. Por ejemplo, compilar f’Bad @{ab@} field “da como resultado este atributo args: (” f-string: … “, (” “, 1, 2,” (ab) n “, 1, 5)) .


Distinto en la versión 3.10: Se agregaron los atributos @ref{2299,,end_lineno} y @ref{229a,,end_offset}.

@end deffn

@geindex IndentationError
@anchor{library/exceptions IndentationError}@anchor{841}
@deffn {Excepción} IndentationError

Clase base para errores de sintaxis relacionados con sangría incorrecta. Esta es una subclase de @ref{150,,SyntaxError}.
@end deffn

@geindex TabError
@anchor{library/exceptions TabError}@anchor{5e6}
@deffn {Excepción} TabError

Se genera cuando la sangría contiene un uso inconsistente de pestañas y espacios. Esta es una subclase de @ref{841,,IndentationError}.
@end deffn

@geindex SystemError
@anchor{library/exceptions SystemError}@anchor{619}
@deffn {Excepción} SystemError

Se genera cuando el intérprete encuentra un error interno, pero la situación no parece tan grave como para abandonar toda esperanza. El valor asociado es una cadena que indica qué salió mal (a bajo nivel).

Debe informar esto al autor o responsable de su intérprete de Python. Asegúrese de informar la versión del intérprete de Python (@code{sys.version}; también se imprime al comienzo de una sesión interactiva de Python), el mensaje de error exacto (el valor asociado de la excepción) y, si es posible, la fuente del programa que activó el error.
@end deffn

@geindex SystemExit
@anchor{library/exceptions SystemExit}@anchor{dc7}
@deffn {Excepción} SystemExit

Esta excepción es provocada por la función @ref{13b0,,sys.exit()}. Hereda de @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception} para que no sea gestionada accidentalmente por el código que captura @ref{a6b,,Exception}. Esto permite que la excepción se propague correctamente y que el intérprete salga. Cuando no se maneja, el intérprete de Python sale; no se imprime el seguimiento de pila. El constructor acepta el mismo argumento opcional pasado a @ref{13b0,,sys.exit()}. Si el valor es un entero, especifica el estado de salida del sistema (se pasa a la función @code{exit()} de C); si es @code{None}, el estado de salida es cero; Si tiene otro tipo (como una cadena), se imprime el valor del objeto y el estado de salida es uno.

Una llamada @ref{13b0,,sys.exit()} se traduce en una excepción para que los gestores de limpieza (@ref{a5c,,finally} cláusulas de @ref{789,,try}) puedan ejecutarse, y para que un depurador pueda ejecutar un `script' sin correr el riesgo de perder el control. La función @ref{229b,,os._exit()} se puede usar si es absolutamente necesario salir (por ejemplo, en el proceso secundario después de una llamada a @ref{2ff,,os.fork()}).

@geindex code (atributo de SystemExit)
@anchor{library/exceptions SystemExit code}@anchor{229c}
@deffn {Atributo} code

El estado de salida o mensaje de error que se pasa al constructor. (El valor predeterminado es @code{None}.)
@end deffn
@end deffn

@geindex TypeError
@anchor{library/exceptions TypeError}@anchor{228}
@deffn {Excepción} TypeError

Se genera cuando una operación o función se aplica a un objeto de tipo inapropiado. El valor asociado es una cadena que proporciona detalles sobre la falta de coincidencia de tipos.

El código de usuario puede lanzar esta excepción para indicar que un intento de operación en un objeto no es compatible y no debe serlo. Si un objeto está destinado a soportar una operación dada pero aún no ha proporcionado una implementación, @ref{384,,NotImplementedError} es la excepción adecuada para lanzar.

Pasar argumentos del tipo incorrecto (por ejemplo, pasar a @ref{18e,,list} cuando se espera un @ref{1f0,,int}) debería dar como resultado @ref{228,,TypeError}, pero pasar argumentos con el valor incorrecto (por ejemplo, un número fuera límites esperados) debería dar como resultado @ref{360,,ValueError}.
@end deffn

@geindex UnboundLocalError
@anchor{library/exceptions UnboundLocalError}@anchor{1576}
@deffn {Excepción} UnboundLocalError

Se genera cuando se hace referencia a una variable local en una función o método, pero no se ha vinculado ningún valor a esa variable. Esta es una subclase de @ref{4ec,,NameError}.
@end deffn

@geindex UnicodeError
@anchor{library/exceptions UnicodeError}@anchor{130f}
@deffn {Excepción} UnicodeError

Se genera cuando se produce un error de codificación o decodificación relacionado con Unicode. Es una subclase de @ref{360,,ValueError}.

@ref{130f,,UnicodeError} tiene atributos que describen el error de codificación o decodificación. Por ejemplo, @code{err.object[err.start:err.end]} proporciona la entrada inválida particular en la que falló el códec.

@geindex encoding (atributo de UnicodeError)
@anchor{library/exceptions UnicodeError encoding}@anchor{229d}
@deffn {Atributo} encoding

El nombre de la codificación que provocó el error.
@end deffn

@geindex reason (atributo de UnicodeError)
@anchor{library/exceptions UnicodeError reason}@anchor{229e}
@deffn {Atributo} reason

Una cadena que describe el error de códec específico.
@end deffn

@geindex object (atributo de UnicodeError)
@anchor{library/exceptions UnicodeError object}@anchor{229f}
@deffn {Atributo} object

El objeto que el códec intentaba codificar o decodificar.
@end deffn

@geindex start (atributo de UnicodeError)
@anchor{library/exceptions UnicodeError start}@anchor{160b}
@deffn {Atributo} start

El primer índice de datos no válidos en @ref{b18,,object}.
@end deffn

@geindex end (atributo de UnicodeError)
@anchor{library/exceptions UnicodeError end}@anchor{160c}
@deffn {Atributo} end

El índice después de los últimos datos no válidos en @ref{b18,,object}.
@end deffn
@end deffn

@geindex UnicodeEncodeError
@anchor{library/exceptions UnicodeEncodeError}@anchor{718}
@deffn {Excepción} UnicodeEncodeError

Se genera cuando se produce un error relacionado con Unicode durante la codificación. Es una subclase de @ref{130f,,UnicodeError}.
@end deffn

@geindex UnicodeDecodeError
@anchor{library/exceptions UnicodeDecodeError}@anchor{aa5}
@deffn {Excepción} UnicodeDecodeError

Se genera cuando se produce un error relacionado con Unicode durante la codificación. Es una subclase de @ref{130f,,UnicodeError}.
@end deffn

@geindex UnicodeTranslateError
@anchor{library/exceptions UnicodeTranslateError}@anchor{22a0}
@deffn {Excepción} UnicodeTranslateError

Se genera cuando se produce un error relacionado con Unicode durante la codificación. Es una subclase de @ref{130f,,UnicodeError}.
@end deffn

@geindex ValueError
@anchor{library/exceptions ValueError}@anchor{360}
@deffn {Excepción} ValueError

Se genera cuando una operación o función recibe un argumento que tiene el tipo correcto pero un valor inapropiado, y la situación no se describe con una excepción más precisa como @ref{1575,,IndexError}.
@end deffn

@geindex ZeroDivisionError
@anchor{library/exceptions ZeroDivisionError}@anchor{9d8}
@deffn {Excepción} ZeroDivisionError

Se genera cuando el segundo argumento de una operación de división o módulo es cero. El valor asociado es una cadena que indica el tipo de operandos y la operación.
@end deffn

Las siguientes excepciones se mantienen por compatibilidad con versiones anteriores; a partir de Python 3.3, son alias de @ref{4d5,,OSError}.

@geindex EnvironmentError
@anchor{library/exceptions EnvironmentError}@anchor{10cf}
@deffn {Excepción} EnvironmentError
@end deffn

@geindex IOError
@anchor{library/exceptions IOError}@anchor{10ce}
@deffn {Excepción} IOError
@end deffn

@geindex WindowsError
@anchor{library/exceptions WindowsError}@anchor{10d0}
@deffn {Excepción} WindowsError

Solo disponible en Windows.
@end deffn

@menu
* Excepciones del sistema operativo:: 

@end menu

@node Excepciones del sistema operativo,,,Excepciones específicas
@anchor{library/exceptions os-exceptions}@anchor{228f}
@subsubsection Excepciones del sistema operativo


Las siguientes excepciones son subclases de @ref{4d5,,OSError}, se generan según el código de error del sistema.

@geindex BlockingIOError
@anchor{library/exceptions BlockingIOError}@anchor{10d3}
@deffn {Excepción} BlockingIOError

Se lanza cuando una operación se bloquearía en un objeto (ejemplo: `socket') configurado para una operación no bloqueante. Corresponde a @code{errno} @ref{22a1,,EAGAIN}, @ref{22a2,,EALREADY}, @ref{22a3,,EWOULDBLOCK} y @ref{22a4,,EINPROGRESS}.

Además de los de @ref{4d5,,OSError}, @ref{10d3,,BlockingIOError} puede tener un atributo más:

@geindex characters_written (atributo de BlockingIOError)
@anchor{library/exceptions BlockingIOError characters_written}@anchor{22a5}
@deffn {Atributo} characters_written

Un entero que contiene el número de caracteres escritos en la secuencia antes de que se bloquee. Este atributo está disponible cuando se utilizan las clases de E/S almacenadas en el modulo @ref{7f,,io}.
@end deffn
@end deffn

@geindex ChildProcessError
@anchor{library/exceptions ChildProcessError}@anchor{10d4}
@deffn {Excepción} ChildProcessError

Se lanza cuando falla una operación en un proceso secundario. Corresponde a @code{errno} @ref{22a6,,ECHILD}.
@end deffn

@geindex ConnectionError
@anchor{library/exceptions ConnectionError}@anchor{e8f}
@deffn {Excepción} ConnectionError

Una clase base para problemas relacionados con la conexión.

Las subclases son @ref{10d8,,BrokenPipeError}, @ref{10d9,,ConnectionAbortedError}, @ref{10da,,ConnectionRefusedError} y @ref{10db,,ConnectionResetError}.
@end deffn

@geindex BrokenPipeError
@anchor{library/exceptions BrokenPipeError}@anchor{10d8}
@deffn {Excepción} BrokenPipeError

Una subclase de @ref{e8f,,ConnectionError}, que se lanza cuando se intenta escribir en una tubería mientras el otro extremo se ha cerrado, o cuando se intenta escribir en un `socket' que se ha cerrado para escritura. Corresponde a @code{errno} @ref{22a7,,EPIPE} y @ref{22a8,,ESHUTDOWN}.
@end deffn

@geindex ConnectionAbortedError
@anchor{library/exceptions ConnectionAbortedError}@anchor{10d9}
@deffn {Excepción} ConnectionAbortedError

Una subclase de @ref{e8f,,ConnectionError}, que se lanza cuando el par aborta un intento de conexión. Corresponde a @code{errno} @ref{22a9,,ECONNABORTED}.
@end deffn

@geindex ConnectionRefusedError
@anchor{library/exceptions ConnectionRefusedError}@anchor{10da}
@deffn {Excepción} ConnectionRefusedError

Una subclase de @ref{e8f,,ConnectionError}, que se lanza cuando el par rechaza un intento de conexión. Corresponde a @code{errno} @ref{22aa,,ECONNREFUSED}.
@end deffn

@geindex ConnectionResetError
@anchor{library/exceptions ConnectionResetError}@anchor{10db}
@deffn {Excepción} ConnectionResetError

Una subclase de @ref{e8f,,ConnectionError}, que se lanza cuando el par restablece una conexión. Corresponde a @code{errno} @ref{22ab,,ECONNRESET}.
@end deffn

@geindex FileExistsError
@anchor{library/exceptions FileExistsError}@anchor{109c}
@deffn {Excepción} FileExistsError

Se lanza al intentar crear un archivo o directorio que ya existe. Corresponde a @code{errno} @ref{22ac,,EEXIST}.
@end deffn

@geindex FileNotFoundError
@anchor{library/exceptions FileNotFoundError}@anchor{f46}
@deffn {Excepción} FileNotFoundError

Se lanza cuando se solicita un archivo o directorio pero no existe. Corresponde a @code{errno} @ref{22ad,,ENOENT}.
@end deffn

@geindex InterruptedError
@anchor{library/exceptions InterruptedError}@anchor{e0e}
@deffn {Excepción} InterruptedError

Se lanza cuando una señal entrante interrumpe una llamada del sistema. Corresponde a @code{errno} @ref{e0d,,EINTR}.


Distinto en la versión 3.5: Python ahora vuelve a intentar las llamadas del sistema cuando una señal interrumpe un `syscall', excepto si el gestor de señales lanza una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de lanzar @ref{e0e,,InterruptedError}.

@end deffn

@geindex IsADirectoryError
@anchor{library/exceptions IsADirectoryError}@anchor{10d5}
@deffn {Excepción} IsADirectoryError

Se lanza cuando se solicita una operación de archivo (como @ref{1163,,os.remove()}) en un directorio. Corresponde a @code{errno} @ref{22ae,,EISDIR}.
@end deffn

@geindex NotADirectoryError
@anchor{library/exceptions NotADirectoryError}@anchor{10d6}
@deffn {Excepción} NotADirectoryError

Se lanza cuando se solicita una operación de directorio (como @ref{116c,,os.listdir()}) en algo que no es un directorio.  En la mayoría de las plataformas POSIX, también se puede lanzar si una operación intenta abrir o recorrer un archivo que no es de directorio como si fuera un directorio. Corresponde a @code{errno} @ref{22af,,ENOTDIR}.
@end deffn

@geindex PermissionError
@anchor{library/exceptions PermissionError}@anchor{dc9}
@deffn {Excepción} PermissionError

Se lanza cuando se intenta ejecutar una operación sin los permisos de acceso adecuados, por ejemplo permisos del sistema de archivos. Corresponde a @code{errno} @ref{22b0,,EACCES}, @ref{17d3,,EPERM} y @ref{17c7,,ENOTCAPABLE}.


Distinto en la versión 3.11.1: El error @ref{17c7,,ENOTCAPABLE} de WASI ahora se mapea a @ref{dc9,,PermissionError}.

@end deffn

@geindex ProcessLookupError
@anchor{library/exceptions ProcessLookupError}@anchor{10d7}
@deffn {Excepción} ProcessLookupError

Se lanza cuando un proceso dado no existe. Corresponde a @code{errno} @ref{22b1,,ESRCH}.
@end deffn

@geindex TimeoutError
@anchor{library/exceptions TimeoutError}@anchor{8cc}
@deffn {Excepción} TimeoutError

Se lanza cuando se agota el tiempo de espera de una función del sistema a nivel del sistema. Corresponde a @code{errno} @ref{22b2,,ETIMEDOUT}.
@end deffn


Added in version 3.3: Por lo anterior se agregaron las subclases @ref{4d5,,OSError}.



@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/} - Reelaborando el sistema operativo y la jerarquía de excepciones E/S


@node Advertencias,Grupos de excepciones,Excepciones específicas,Excepciones incorporadas
@anchor{library/exceptions warning-categories-as-exceptions}@anchor{22b3}@anchor{library/exceptions warnings}@anchor{22b4}
@subsection Advertencias


Las siguientes excepciones se utilizan como categorías de advertencia; consulte la documentación de @ref{22b5,,Categorías de advertencia} para obtener más detalles.

@geindex Warning
@anchor{library/exceptions Warning}@anchor{22b6}
@deffn {Excepción} Warning

Clase base para categorías de advertencia.
@end deffn

@geindex UserWarning
@anchor{library/exceptions UserWarning}@anchor{22b7}
@deffn {Excepción} UserWarning

Clase base para advertencias generadas por código de usuario.
@end deffn

@geindex DeprecationWarning
@anchor{library/exceptions DeprecationWarning}@anchor{1da}
@deffn {Excepción} DeprecationWarning

Clase base para advertencias sobre características obsoletas cuando esas advertencias están destinadas a otros desarrolladores de Python.

Ignorado por los filtros de advertencia predeterminados, excepto en el módulo @code{__main__} (
@geindex Python Enhancement Proposals; PEP 565
PEP 565@footnote{https://peps.python.org/pep-0565/}). Habilitando @ref{356,,Modo Desarrollo de Python} muestra esta advertencia.

La política de obsolescencia se describe en 
@geindex Python Enhancement Proposals; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}.
@end deffn

@geindex PendingDeprecationWarning
@anchor{library/exceptions PendingDeprecationWarning}@anchor{95f}
@deffn {Excepción} PendingDeprecationWarning

Clase base para advertencias sobre características que están obsoletas y que se espera que sean obsoletas en el futuro, pero que no lo son en este momento.

Esta clase rara vez se usa para emitir una advertencia sobre una posible desaprobación próxima es inusual, y @ref{1da,,DeprecationWarning} se prefiere para las desaprobaciones ya activas.

Ignorado por los filtros de advertencia predeterminados. Habilitando @ref{356,,Modo Desarrollo de Python} muestra esta advertencia.

La política de obsolescencia se describe en 
@geindex Python Enhancement Proposals; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}.
@end deffn

@geindex SyntaxWarning
@anchor{library/exceptions SyntaxWarning}@anchor{511}
@deffn {Excepción} SyntaxWarning

Clase base para advertencias sobre sintaxis dudosa.
@end deffn

@geindex RuntimeWarning
@anchor{library/exceptions RuntimeWarning}@anchor{323}
@deffn {Excepción} RuntimeWarning

Clase base para advertencias sobre comportamiento dudoso en tiempo de ejecución.
@end deffn

@geindex FutureWarning
@anchor{library/exceptions FutureWarning}@anchor{4d4}
@deffn {Excepción} FutureWarning

Clase base para advertencias sobre características en desuso cuando esas advertencias están destinadas a usuarios finales de aplicaciones escritas en Python.
@end deffn

@geindex ImportWarning
@anchor{library/exceptions ImportWarning}@anchor{59f}
@deffn {Excepción} ImportWarning

Clase base para advertencias sobre posibles errores en la importación de módulos.

Ignorado por los filtros de advertencia predeterminados. Habilitando @ref{356,,Modo Desarrollo de Python} muestra esta advertencia.
@end deffn

@geindex UnicodeWarning
@anchor{library/exceptions UnicodeWarning}@anchor{1463}
@deffn {Excepción} UnicodeWarning

Clase base para advertencias relacionadas con Unicode.
@end deffn

@geindex EncodingWarning
@anchor{library/exceptions EncodingWarning}@anchor{1d43}
@deffn {Excepción} EncodingWarning

Clase base para advertencias relacionadas con codificaciones.

Consulte @ref{1d5b,,EncodingWarning opcional} para obtener más detalles.


Added in version 3.10.

@end deffn

@geindex BytesWarning
@anchor{library/exceptions BytesWarning}@anchor{cab}
@deffn {Excepción} BytesWarning

Clase base para advertencias relacionadas con @ref{325,,bytes} y @ref{5e0,,bytearray}.
@end deffn

@geindex ResourceWarning
@anchor{library/exceptions ResourceWarning}@anchor{39d}
@deffn {Excepción} ResourceWarning

Clase base para advertencias relacionadas con el uso de recursos.

Ignorado por los filtros de advertencia predeterminados. Habilitando @ref{356,,Modo Desarrollo de Python} muestra esta advertencia.


Added in version 3.2.

@end deffn

@node Grupos de excepciones,Jerarquía de excepción,Advertencias,Excepciones incorporadas
@anchor{library/exceptions exception-groups}@anchor{22b8}@anchor{library/exceptions lib-exception-groups}@anchor{22b9}
@subsection Grupos de excepciones


Las siguientes se utilizan cuando es necesario lanzar múltiples excepciones no relacionadas. Forman parte de la jerarquía de excepciones, por lo que pueden ser manejadas con @ref{2f6,,except} como todas las demás excepciones. Además, son reconocidas por @ref{659,,except*}, lo que hace coincidir sus subgrupos basándose en los tipos de las excepciones contenidas.

@geindex ExceptionGroup
@anchor{library/exceptions ExceptionGroup}@anchor{31d}
@deffn {Excepción} ExceptionGroup (msg, excs)
@end deffn

@geindex BaseExceptionGroup
@anchor{library/exceptions BaseExceptionGroup}@anchor{3b6}
@deffn {Excepción} BaseExceptionGroup (msg, excs)

Ambos tipos de excepción envuelven las excepciones en la secuencia @code{excs}. El parámetro @code{msg} debe ser una cadena de caracteres. La diferencia entre las dos clases es que @ref{3b6,,BaseExceptionGroup} extiende a @ref{65c,,BaseException} y puede envolver cualquier excepción, mientras que @ref{31d,,ExceptionGroup} extiende a @ref{a6b,,Exception} y solo puede envolver subclases de @ref{a6b,,Exception}. Este diseño está pensado para que @code{except Exception} capture un @ref{31d,,ExceptionGroup} pero no @ref{3b6,,BaseExceptionGroup}

El constructor @ref{3b6,,BaseExceptionGroup} retorna una @ref{31d,,ExceptionGroup} en lugar de una @ref{3b6,,BaseExceptionGroup} si todas las excepciones contenidas son instancias de @ref{a6b,,Exception} , por lo que puede utilizarse para hacer la selección automática. El constructor @ref{31d,,ExceptionGroup}, por su parte, lanza un @ref{228,,TypeError} si alguna de las excepciones contenidas no es una subclase de @ref{a6b,,Exception}.

@geindex message (atributo de BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup message}@anchor{22ba}
@deffn {Atributo} message

El argumento @code{msg} para el constructor. Este atributo es de sólo lectura.
@end deffn

@geindex exceptions (atributo de BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup exceptions}@anchor{22bb}
@deffn {Atributo} exceptions

Una tupla de la excepciones en la secuencia @code{excs} pasada al constructor. Este atributo es de sólo lectura.
@end deffn

@geindex subgroup() (método de BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup subgroup}@anchor{16c9}
@deffn {Método} subgroup (condition)

Retorna un grupo de excepciones que contiene sólo las excepciones del grupo actual que cumplen con `condition', o @code{None} si el resultado está vacío.

The condition can be an exception type or tuple of exception types, in which
case each exception is checked for a match using the same check that is used
in an @code{except} clause.  The condition can also be a callable (other than
a type object) that accepts an exception as its single argument and returns
true for the exceptions that should be in the subgroup.

The nesting structure of the current exception is preserved in the result,
as are the values of its @ref{22ba,,message},
@ref{1330,,__traceback__}, @ref{1332,,__cause__},
@ref{1331,,__context__} and
@ref{2288,,__notes__} fields.
Empty nested groups are omitted from the result.

La condición se comprueba para todas las excepciones del grupo de excepción anidado, incluyendo el nivel superior y cualquier grupo de excepción anidado. Si la condición es verdadera para dicho grupo de excepción, se incluye en el resultado en su totalidad.


Added in version 3.13: @code{condition} can be any callable which is not a type object.

@end deffn

@geindex split() (método de BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup split}@anchor{16ca}
@deffn {Método} split (condition)

Al igual que @ref{16c9,,subgroup()}, pero retorna el par @code{(match, rest)} donde @code{match} es @code{subgroup(condition)} y @code{rest} es la parte restante que no coincide.
@end deffn

@geindex derive() (método de BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup derive}@anchor{16c8}
@deffn {Método} derive (excs)

Retorna un grupo de excepción con los mismos @ref{22ba,,message}, pero que envuelve las excepciones en @code{excs}.

This method is used by @ref{16c9,,subgroup()} and @ref{16ca,,split()}, which
are used in various contexts to break up an exception group. A
subclass needs to override it in order to make @ref{16c9,,subgroup()}
and @ref{16ca,,split()} return instances of the subclass rather
than @ref{31d,,ExceptionGroup}.

@ref{16c9,,subgroup()} and @ref{16ca,,split()} copy the
@ref{1330,,__traceback__},
@ref{1332,,__cause__}, @ref{1331,,__context__} and
@ref{2288,,__notes__} fields from
the original exception group to the one returned by @ref{16c8,,derive()}, so
these fields do not need to be updated by @ref{16c8,,derive()}.

@example
>>> class MyGroup(ExceptionGroup):
...     def derive(self, excs):
...         return MyGroup(self.message, excs)
...
>>> e = MyGroup("eg", [ValueError(1), TypeError(2)])
>>> e.add_note("a note")
>>> e.__context__ = Exception("context")
>>> e.__cause__ = Exception("cause")
>>> try:
...    raise e
... except Exception as e:
...    exc = e
...
>>> match, rest = exc.split(ValueError)
>>> exc, exc.__context__, exc.__cause__, exc.__notes__
(MyGroup('eg', [ValueError(1), TypeError(2)]), Exception('context'), Exception('cause'), ['a note'])
>>> match, match.__context__, match.__cause__, match.__notes__
(MyGroup('eg', [ValueError(1)]), Exception('context'), Exception('cause'), ['a note'])
>>> rest, rest.__context__, rest.__cause__, rest.__notes__
(MyGroup('eg', [TypeError(2)]), Exception('context'), Exception('cause'), ['a note'])
>>> exc.__traceback__ is match.__traceback__ is rest.__traceback__
True
@end example
@end deffn

Note that @ref{3b6,,BaseExceptionGroup} defines @ref{624,,__new__()}, so
subclasses that need a different constructor signature need to
override that rather than @ref{751,,__init__()}. For example, the following
defines an exception group subclass which accepts an exit_code and
and constructs the group’s message from it.

@example
class Errors(ExceptionGroup):
   def __new__(cls, errors, exit_code):
      self = super().__new__(Errors, f"exit code: @{exit_code@}", errors)
      self.exit_code = exit_code
      return self

   def derive(self, excs):
      return Errors(excs, self.exit_code)
@end example

Al igual que @ref{31d,,ExceptionGroup}, cualquier subclase de @ref{3b6,,BaseExceptionGroup} que también es una subclase de @ref{a6b,,Exception} sólo puede envolver instancias de @ref{a6b,,Exception}.


Added in version 3.11.

@end deffn

@node Jerarquía de excepción,,Grupos de excepciones,Excepciones incorporadas
@anchor{library/exceptions exception-hierarchy}@anchor{22bc}
@subsection Jerarquía de excepción


La jerarquía de clases para las excepciones incorporadas es:

@example
BaseException
 ├── BaseExceptionGroup
 ├── GeneratorExit
 ├── KeyboardInterrupt
 ├── SystemExit
 └── Exception
      ├── ArithmeticError
      │    ├── FloatingPointError
      │    ├── OverflowError
      │    └── ZeroDivisionError
      ├── AssertionError
      ├── AttributeError
      ├── BufferError
      ├── EOFError
      ├── ExceptionGroup [BaseExceptionGroup]
      ├── ImportError
      │    └── ModuleNotFoundError
      ├── LookupError
      │    ├── IndexError
      │    └── KeyError
      ├── MemoryError
      ├── NameError
      │    └── UnboundLocalError
      ├── OSError
      │    ├── BlockingIOError
      │    ├── ChildProcessError
      │    ├── ConnectionError
      │    │    ├── BrokenPipeError
      │    │    ├── ConnectionAbortedError
      │    │    ├── ConnectionRefusedError
      │    │    └── ConnectionResetError
      │    ├── FileExistsError
      │    ├── FileNotFoundError
      │    ├── InterruptedError
      │    ├── IsADirectoryError
      │    ├── NotADirectoryError
      │    ├── PermissionError
      │    ├── ProcessLookupError
      │    └── TimeoutError
      ├── ReferenceError
      ├── RuntimeError
      │    ├── NotImplementedError
      │    ├── PythonFinalizationError
      │    └── RecursionError
      ├── StopAsyncIteration
      ├── StopIteration
      ├── SyntaxError
      │    └── IndentationError
      │         └── TabError
      ├── SystemError
      ├── TypeError
      ├── ValueError
      │    └── UnicodeError
      │         ├── UnicodeDecodeError
      │         ├── UnicodeEncodeError
      │         └── UnicodeTranslateError
      └── Warning
           ├── BytesWarning
           ├── DeprecationWarning
           ├── EncodingWarning
           ├── FutureWarning
           ├── ImportWarning
           ├── PendingDeprecationWarning
           ├── ResourceWarning
           ├── RuntimeWarning
           ├── SyntaxWarning
           ├── UnicodeWarning
           └── UserWarning
@end example
@anchor{library/text stringservices}@anchor{21c1}
@node Servicios de procesamiento de texto,Servicios de datos binarios,Excepciones incorporadas,La biblioteca estándar de Python
@anchor{library/text doc}@anchor{22bd}@anchor{library/text text-processing-services}@anchor{22be}@anchor{library/text textservices}@anchor{21c3}
@section Servicios de procesamiento de texto


Los módulos descritos en este capítulo proporcionan una amplia gama de operaciones de manipulación de cadenas de texto y otros servicios de procesamiento de texto.

El módulo @ref{1c,,codecs} descrito en @ref{22bf,,Servicios de datos binarios} también es muy relevante para el procesamiento de texto. Además, consulta la documentación para el tipo `string' de Python en @ref{1c04,,Cadenas de caracteres — str}.

@menu
* string — Common string operations:: 
* re — Regular expression operations:: 
* difflib — Helpers for computing deltas:: 
* textwrap — Text wrapping and filling:: 
* unicodedata — Unicode Database:: 
* stringprep — Internet String Preparation:: 
* readline — GNU readline interface:: 
* rlcompleter — Completion function for GNU readline:: 

@end menu

@node string — Common string operations,re — Regular expression operations,,Servicios de procesamiento de texto
@anchor{library/string doc}@anchor{22c0}@anchor{library/string module-string}@anchor{d3}@anchor{library/string string-common-string-operations}@anchor{22c1}
@subsection @code{string} — Common string operations


@geindex module; string

`Source code:' Lib/string.py@footnote{https://github.com/python/cpython/tree/main/Lib/string.py}


__________________________________________________________________



@subsubheading Ver también


@ref{1c04,,Cadenas de caracteres — str}

@ref{1c05,,Métodos de las cadenas de caracteres}


@menu
* Constantes de cadenas:: 
* Formato de cadena de caracteres personalizado:: 
* Sintaxis de formateo de cadena:: 
* Cadenas de plantillas:: 
* Funciones de ayuda:: 

@end menu

@node Constantes de cadenas,Formato de cadena de caracteres personalizado,,string — Common string operations
@anchor{library/string string-constants}@anchor{22c2}
@subsubsection Constantes de cadenas


Las constantes definidas en este módulo son:

@geindex ascii_letters (en el módulo string)
@anchor{library/string string ascii_letters}@anchor{132d}
@deffn {Dato} string.ascii_letters

La concatenación de las constantes abajo descriptas @ref{22c3,,ascii_lowercase} y @ref{22c4,,ascii_uppercase}.  Este valor es independiente de la configuración regional.
@end deffn

@geindex ascii_lowercase (en el módulo string)
@anchor{library/string string ascii_lowercase}@anchor{22c3}
@deffn {Dato} string.ascii_lowercase

Las letras minúsculas @code{'abcdefghijklmnopqrstuvwxyz'}.  Este valor es independiente de la configuración regional y no cambiará.
@end deffn

@geindex ascii_uppercase (en el módulo string)
@anchor{library/string string ascii_uppercase}@anchor{22c4}
@deffn {Dato} string.ascii_uppercase

Las letras mayúsculas @code{'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.  Este valor es independiente de la configuración regional y no cambiará.
@end deffn

@geindex digits (en el módulo string)
@anchor{library/string string digits}@anchor{22c5}
@deffn {Dato} string.digits

La cadena @code{'0123456789'}.
@end deffn

@geindex hexdigits (en el módulo string)
@anchor{library/string string hexdigits}@anchor{22c6}
@deffn {Dato} string.hexdigits

La cadena @code{'0123456789abcdefABCDEF'}.
@end deffn

@geindex octdigits (en el módulo string)
@anchor{library/string string octdigits}@anchor{22c7}
@deffn {Dato} string.octdigits

La cadena de caracteres @code{'01234567'}.
@end deffn

@geindex punctuation (en el módulo string)
@anchor{library/string string punctuation}@anchor{22c8}
@deffn {Dato} string.punctuation

Cadena de caracteres ASCII que se consideran caracteres de puntuación en la configuración regional @code{C}: @code{!" #$%&'()*+,-./:;<=>?@@[\]^_`@{|@} ~}.
@end deffn

@geindex printable (en el módulo string)
@anchor{library/string string printable}@anchor{22c9}
@deffn {Dato} string.printable

Cadena de caracteres ASCII que se consideran imprimibles.  Esta es una combinación de @ref{22c5,,digits}, @ref{132d,,ascii_letters}, @ref{22c8,,punctuation}, y @ref{22ca,,whitespace}.
@end deffn

@geindex whitespace (en el módulo string)
@anchor{library/string string whitespace}@anchor{22ca}
@deffn {Dato} string.whitespace

Una cadena cuyos caracteres ASCII se consideran todos espacios en blanco. Esto incluye los caracteres espacio, tabulador, salto de línea, retorno, salto de página y tabulador vertical.
@end deffn

@node Formato de cadena de caracteres personalizado,Sintaxis de formateo de cadena,Constantes de cadenas,string — Common string operations
@anchor{library/string custom-string-formatting}@anchor{22cb}@anchor{library/string string-formatting}@anchor{1c7f}
@subsubsection Formato de cadena de caracteres personalizado


La clase cadena es una clase incorporada (`built-in') que proporciona la capacidad de realizar sustituciones complejas de variables y formateo de valor a través del método @ref{6c2,,format()} descrito en 
@geindex Python Enhancement Proposals; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/}.  La clase @ref{f3d,,Formatter} del módulo @ref{d3,,string} permite crear y personalizar sus propios comportamientos de formateo de cadena utilizando la misma implementación que el método integrado @ref{6c2,,format()}.

@geindex Formatter (clase en string)
@anchor{library/string string Formatter}@anchor{f3d}
@deffn {Clase} string.Formatter

La clase @ref{f3d,,Formatter} tiene los siguientes métodos públicos:

@geindex format() (método de string.Formatter)
@anchor{library/string string Formatter format}@anchor{c88}
@deffn {Método} format (format_string, /, *args, **kwargs)

Método principal de la API.  Recibe una cadena de formato y argumentos posicionales y de palabra clave arbitrarios. Es sólo un envoltorio que llama a @ref{22cc,,vformat()}.


Distinto en la versión 3.7: Un argumento de cadena de formato ahora es @ref{b12,,solo posicional}.

@end deffn

@geindex vformat() (método de string.Formatter)
@anchor{library/string string Formatter vformat}@anchor{22cc}
@deffn {Método} vformat (format_string, args, kwargs)

Esta función realiza es la que realmente hace el trabajo de formateo.  Se expone como una función independiente para los casos en los que desea pasar un diccionario predefinido de argumentos, en lugar de desempaquetar y volver a empaquetar el diccionario como argumentos individuales mediante la sintaxis @code{*args} y @code{**kwargs}.  @ref{22cc,,vformat()} hace el trabajo de dividir la cadena de formato en datos de caracteres y campos de reemplazo.  Llama a los diversos métodos descritos a continuación.
@end deffn

Además de eso, la clase @ref{f3d,,Formatter} define varios métodos que se espera sean reemplazados por las subclases:

@geindex parse() (método de string.Formatter)
@anchor{library/string string Formatter parse}@anchor{22cd}
@deffn {Método} parse (format_string)

Itera sobre `format_string' y retorna un iterable de tuplas (`literal_text', `field_name', `format_spec', `conversion'). Es usado por @ref{22cc,,vformat()} para dividir la cadena de caracteres en texto literal o en campos de reemplazo.

Los valores en la tupla representan conceptualmente un intervalo de texto literal seguido por un único campo de reemplazo. Si no hay ningún texto literal (lo cual puede darse si dos campos de reemplazo ocurren consecutivamente), `literal_text' será una cadena de caracteres de longitud cero. Si no hay ningún campo de reemplazo, los valores de `field_name', `format_spec' y `conversion' serán @code{None}.
@end deffn

@geindex get_field() (método de string.Formatter)
@anchor{library/string string Formatter get_field}@anchor{22ce}
@deffn {Método} get_field (field_name, args, kwargs)

Dado un `field_name' retornado por @ref{22cd,,parse()} (véase arriba), el mismo es convertido a un objeto a formatear. retorna una tupla (`obj', `used_key'). La versión por defecto toma cadenas de caracteres acorde a lo definido en 
@geindex Python Enhancement Proposals; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/}, tales como «0[`name']» o «`label.title'». `args' y `kwargs' se pasan al método @ref{22cc,,vformat()}. El valor retornado `used_key' tiene el mismo significado que el parámetro `key' para @ref{22cf,,get_value()}.
@end deffn

@geindex get_value() (método de string.Formatter)
@anchor{library/string string Formatter get_value}@anchor{22cf}
@deffn {Método} get_value (key, args, kwargs)

Recuperar un valor de campo determinado.  El argumento `key' será un entero o una cadena de caracteres.  Si es un entero, representa el índice del argumento posicional en `args'; si es una cadena, representa un argumento definido en `kwargs'.

El parámetro `args' se establece como lista de argumentos posicionales en @ref{22cc,,vformat()}, y el parámetro `kwargs' se establece como diccionario de argumentos de palabra clave.

Para nombres de campo compuesto, estas funciones son únicamente llamadas para el primer componente del campo. Los componentes que le siguen son tratados a través de operaciones normales de atributo e indexación.

Por ejemplo, la expresión de campo “0.name” haría que @ref{22cf,,get_value()} se llame con un argumento `key' igual a 0.  El atributo “”name”” se buscará después del retorno de @ref{22cf,,get_value()} llamando a la función incorporada @ref{c59,,getattr()}.

Si el índice o la palabra clave hace referencia a un elemento que no existe, se debe generar un @ref{1575,,IndexError} o un @ref{438,,KeyError}.
@end deffn

@geindex check_unused_args() (método de string.Formatter)
@anchor{library/string string Formatter check_unused_args}@anchor{22d0}
@deffn {Método} check_unused_args (used_args, args, kwargs)

Implementa el chequeo de argumentos no utilizados si así se desea.  Los argumentos de esta función son el conjunto de todas las claves de argumento a las que se hizo referencia en la cadena de formato (enteros para argumentos posicionales y cadenas de caracteres para argumentos con nombre) y una referencia a los `args' y `kwargs' que se pasaron a `vformat'.  El conjunto de `args' no utilizados se puede calcular a partir de estos parámetros. se asume que @ref{22d0,,check_unused_args()} genera una excepción si se produce un error en el chequeo.
@end deffn

@geindex format_field() (método de string.Formatter)
@anchor{library/string string Formatter format_field}@anchor{22d1}
@deffn {Método} format_field (value, format_spec)

@ref{22d1,,format_field()} simplemente llama a la función incorporada @ref{6c0,,format()}.  El método se proporciona para que las subclases puedan sobrescribirlo.
@end deffn

@geindex convert_field() (método de string.Formatter)
@anchor{library/string string Formatter convert_field}@anchor{22d2}
@deffn {Método} convert_field (value, conversion)

Convierte el valor (retornado por @ref{22ce,,get_field()}) dado un tipo de conversión (tal como la tupla retornada por el método @ref{22cd,,parse()}). La versión por defecto entiende los tipos de conversión “s” (str), “r” (repr) y “a” (ascii).
@end deffn
@end deffn

@node Sintaxis de formateo de cadena,Cadenas de plantillas,Formato de cadena de caracteres personalizado,string — Common string operations
@anchor{library/string format-string-syntax}@anchor{22d3}@anchor{library/string formatstrings}@anchor{13f0}
@subsubsection Sintaxis de formateo de cadena


El método @ref{6c2,,str.format()} y la clase @ref{f3d,,Formatter} comparten la misma sintaxis para las cadenas de caracteres de formato (aunque en el caso de @ref{f3d,,Formatter} las subclases pueden definir su propia sintaxis de cadena de caracteres de formato).  La sintaxis es similar a la de @ref{a3b,,literales de cadena con formato} pero hay algunas diferencias.

@geindex @{@} (paréntesis de llave);en formato de cadena de caracteres
@geindex . (punto);en formato de cadena de caracteres
@geindex [] (paréntesis corchete o rectos);en formato de cadena de caracteres
@geindex ! (exclamación);en formato de cadena de caracteres
@geindex ; (dos puntos);en formato de cadena de caracteres

Las cadenas de caracteres de formato contienen «campos de reemplazo» rodeados de llaves @code{@{@}}. Todo lo que no está contenido entre llaves se considera texto literal, que se copia sin cambios en la salida.  Si se necesita incluir un carácter de llave en el texto literal, se puede escapar duplicando: @code{@{@{} `and' @code{@}@}}.

La gramática para un campo de reemplazo es la siguiente:

@example
@anchor{library/string grammar-token-format-string-replacement_field}@anchor{22d4}replacement_field ::= "@{" [field_name] ["!" conversion] [":" format_spec] "@}"
@anchor{library/string grammar-token-format-string-field_name}@anchor{22d5}field_name        ::= arg_name ("." attribute_name | "[" element_index "]")*
@anchor{library/string grammar-token-format-string-arg_name}@anchor{22d6}arg_name          ::= [identifier | digit+]
@anchor{library/string grammar-token-format-string-attribute_name}@anchor{22d7}attribute_name    ::= identifier
@anchor{library/string grammar-token-format-string-element_index}@anchor{22d8}element_index     ::= digit+ | index_string
@anchor{library/string grammar-token-format-string-index_string}@anchor{22d9}index_string      ::= <any source character except "]"> +
@anchor{library/string grammar-token-format-string-conversion}@anchor{22da}conversion        ::= "r" | "s" | "a"
@anchor{library/string grammar-token-format-string-format_spec}@anchor{22db}format_spec       ::= format-spec:format_spec
@end example

En términos menos formales, el campo de reemplazo puede comenzar con un `field_name' (nombre de campo) que especifica el objeto cuyo valor se va a formatear e insertar en la salida en lugar del campo de reemplazo. El nombre de campo (`field_name') va seguido opcionalmente de un campo `conversion' (conversión), que va precedido de un signo de exclamación @code{'!'}, y un `format_spec', que va precedido de dos puntos @code{':'}.  Estos especifican un formato no predeterminado para el valor de reemplazo.

Véase también la sección @ref{347,,Especificación de formato Mini-Lenguaje}.

The `field_name' itself begins with an `arg_name' that is either a number or a
keyword.  If it’s a number, it refers to a positional argument, and if it’s a keyword,
it refers to a named keyword argument. An `arg_name' is treated as a number if
a call to @ref{21c8,,str.isdecimal()} on the string would return true.
If the numerical arg_names in a format string
are 0, 1, 2, … in sequence, they can all be omitted (not just some)
and the numbers 0, 1, 2, … will be automatically inserted in that order.
Because `arg_name' is not quote-delimited, it is not possible to specify arbitrary
dictionary keys (e.g., the strings @code{'10'} or @code{':-]'}) within a format string.
The `arg_name' can be followed by any number of index or
attribute expressions. An expression of the form @code{'.name'} selects the named
attribute using @ref{c59,,getattr()}, while an expression of the form @code{'[index]'}
does an index lookup using @ref{3d8,,__getitem__()}.


Distinto en la versión 3.1: Los especificadores de argumentos posicionales pueden ser omitidos en @ref{6c2,,str.format()}, así @code{'@{@} @{@}'.format(a, b)} es equivalente a @code{'@{0@} @{1@}'.format(a, b)}.



Distinto en la versión 3.4: Para la clase @ref{f3d,,Formatter}, los especificadores de argumento posicional pueden ser omitidos.


Algunos ejemplos simples de cadena de formato:

@example
"First, thou shalt count to @{0@}"  # References first positional argument
"Bring me a @{@}"                   # Implicitly references the first positional argument
"From @{@} to @{@}"                   # Same as "From @{0@} to @{1@}"
"My quest is @{name@}"              # References keyword argument 'name'
"Weight in tons @{0.weight@}"       # 'weight' attribute of first positional arg
"Units destroyed: @{players[0]@}"   # First element of keyword argument 'players'.
@end example

The `conversion' field causes a type coercion before formatting.  Normally, the
job of formatting a value is done by the @ref{6bf,,__format__()} method of the value
itself.  However, in some cases it is desirable to force a type to be formatted
as a string, overriding its own definition of formatting.  By converting the
value to a string before calling @ref{6bf,,__format__()}, the normal formatting logic
is bypassed.

Tres banderas de conversión son admitidas actualmente: @code{'!s'}, que llama a @ref{237,,str()} con el valor; @code{'!r'}, que llama a @ref{894,,repr()}; y @code{'!a'} que llama a @ref{1426,,ascii()}.

Algunos ejemplos:

@example
"Harold's a clever @{0!s@}"        # Calls str() on the argument first
"Bring out the holy @{name!r@}"    # Calls repr() on the argument first
"More @{!a@}"                      # Calls ascii() on the argument first
@end example

El campo `format_spec' contiene la especificación de cómo presentar el valor, incluyendo detalles como ancho del campo, alineación, relleno, precisión decimal, etc. Cada tipo de valor puede definir su propio «mini lenguaje de formateo» o interpretación de `format_spec'.

La mayoría de los tipos integrados admiten un formateo común de mini-idioma descrito en la siguiente sección.

Un campo `format_spec' también puede incluir campos de reemplazo anidados dentro de él. Estos campos de reemplazo anidados pueden contener un nombre de campo, una bandera de conversión y una especificación de formato, pero no se permite anidamiento más profundo.  Los campos de reemplazo dentro de `format_spec' se sustituyen antes de que la cadena `format_spec' se interprete. Esto permite especificar dinámicamente el formato de un valor.

Para más ejemplos, véase la sección @ref{22dc,,Ejemplos de formateo}.

@menu
* Especificación de formato Mini-Lenguaje:: 
* Ejemplos de formateo:: 

@end menu

@node Especificación de formato Mini-Lenguaje,Ejemplos de formateo,,Sintaxis de formateo de cadena
@anchor{library/string format-specification-mini-language}@anchor{22dd}@anchor{library/string formatspec}@anchor{347}
@subsubsection Especificación de formato Mini-Lenguaje


Las «especificaciones de formato» son usadas dentro de campos de reemplazo contenidos en una cadena de formateo para definir como se presentan los valores individuales (véase @ref{13f0,,Sintaxis de formateo de cadena} y @ref{a3b,,f-strings}). Los mismos pueden también ser pasados directamente a la función incorporada @ref{6c0,,format()}. Cada tipo formateable puede definir cómo interpretar la especificación de formato.

La mayoría de los tipos integrados implementan las siguientes opciones para especificaciones de formato, aunque algunas de las opciones de formateo sólo son posibles con los tipos numéricos.

Una convención general es que una especificación de formato vacía produce el mismo resultado que llamar a la función @ref{237,,str()} con el valor. Una especificación no vacía típicamente modifica el resultado.

La forma general de un `especificador estándar de formato' es:

@example
@anchor{library/string grammar-token-format-spec-format_spec}@anchor{22de}format_spec     ::= [[fill]align][sign]["z"]["#"]["0"][width][grouping_option]["." precision][type]
@anchor{library/string grammar-token-format-spec-fill}@anchor{22df}fill            ::= <any character>
@anchor{library/string grammar-token-format-spec-align}@anchor{22e0}align           ::= "<" | ">" | "=" | "^"
@anchor{library/string grammar-token-format-spec-sign}@anchor{22e1}sign            ::= "+" | "-" | " "
@anchor{library/string grammar-token-format-spec-width}@anchor{22e2}width           ::= digit+
@anchor{library/string grammar-token-format-spec-grouping_option}@anchor{22e3}grouping_option ::= "_" | ","
@anchor{library/string grammar-token-format-spec-precision}@anchor{22e4}precision       ::= digit+
@anchor{library/string grammar-token-format-spec-type}@anchor{22e5}type            ::= "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"
@end example

Si se especifica un valor `align' válido, puede ir precedido por un carácter `fill', que puede ser cualquier carácter y cuyo valor predeterminado es un espacio si se omite. No es posible utilizar una llave literal (»@code{@{}» or «@code{@}}») como el carácter `fill' en un @ref{a3b,,formato literal de cadena} o cuando se utiliza el método @ref{6c2,,str.format()}.  Sin embargo, es posible insertar una llave con un campo de reemplazo anidado.  Esta limitación no afecta a la función @ref{6c0,,format()}.

El significado de las distintas opciones de alineación es el siguiente:

@geindex < (menor que);en formato de cadena de caracteres
@geindex > (mayor que);en formato de cadena de caracteres
@geindex = (igual);en formato de cadena de caracteres
@geindex ^ (caret);en formato de cadena de caracteres


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Significado

@item

@code{'<'}

@tab

Fuerza el campo a ser alineado a la izquierda dentro del espacio disponible (éste es el comportamiento por defecto para la mayoría de los objetos).

@item

@code{'>'}

@tab

Fuerza el campo a ser alineado a la derecha dentro del espacio disponible (éste es el comportamiento por defecto para números).

@item

@code{'='}

@tab

Forces the padding to be placed after the sign (if any)
but before the digits.  This is used for printing fields
in the form “+000000120”. This alignment option is only
valid for numeric types, excluding @ref{154,,complex}.
It becomes the default for numbers when “0” immediately
precedes the field width.

@item

@code{'^'}

@tab

Fuerza el centrado del campo dentro del espacio disponible.

@end multitable


Notar que, a menos que se defina un ancho de campo mínimo, el ancho del campo siempre tendrá el mismo tamaño que los datos para rellenarlo, de modo que la opción de alineación no tiene ningún significado en este caso.

La opción `sign' (signo) sólo es válida para los tipos numéricos y puede ser una de las siguientes:

@geindex + (más);en formato de cadena de caracteres
@geindex - (menos);en formato de cadena de caracteres
@geindex espacio;en formato de cadena de caracteres


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Significado

@item

@code{'+'}

@tab

indica que el signo debe ser usado tanto para los números positivos como negativos.

@item

@code{'-'}

@tab

indica que el signo debe ser usado sólo para números negativos (éste es el comportamiento por defecto).

@item

espacio

@tab

indica que el espacio inicial debe ser usado para números positivos y el signo menos para números negativos.

@end multitable


@geindex z;en formato de cadena de caracteres

La opción @code{'z'} convierte los valores de coma flotante de cero negativos en cero positivos después de redondear al formato de precisión. Esta opción solo es válida para los tipos de presentación de coma flotante.


Distinto en la versión 3.11: Se agregó la opción @code{'z'} (véase también 
@geindex Python Enhancement Proposals; PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/}).


@geindex # (numeral o almohadilla);en formato de cadena de caracteres

La opción @code{'#'} hace que la «forma alternativa» se utilice para la conversión.  La forma alternativa se define de forma diferente para diferentes tipos.  Esta opción solo es válida para los tipos entero, flotante y complejo. Para los enteros, cuando se utiliza la salida binaria, octal o hexadecimal, esta opción agrega el respectivo prefijo @code{'0b'}, @code{'0o'} o @code{'0x'} al valor de salida. Para los flotantes y complejos, la forma alternativa hace que el resultado de la conversión siempre contenga un carácter de punto decimal, incluso si no hay dígitos que lo sigan. Normalmente, un carácter de punto decimal aparece en el resultado de estas conversiones sólo si un dígito lo sigue. Además, para las conversiones @code{'g'} y @code{'G'}, los ceros finales no se eliminan del resultado.

@geindex @comma{} (coma);en formato de cadena de caracteres

La opción @code{','} señala el uso de una coma como separador de miles. En cambio, para un separador consciente de localización (`local aware'), usar el tipo de presentación de enteros @code{'n'}.


Distinto en la versión 3.1: Se agregó la opción @code{','} (véase también 
@geindex Python Enhancement Proposals; PEP 378
PEP 378@footnote{https://peps.python.org/pep-0378/}).


@geindex _ (guion bajo);en formato de cadena de caracteres

The @code{'_'} option signals the use of an underscore for a thousands
separator for floating-point presentation types and for integer
presentation type @code{'d'}.  For integer presentation types @code{'b'},
@code{'o'}, @code{'x'}, and @code{'X'}, underscores will be inserted every 4
digits.  For other presentation types, specifying this option is an
error.


Distinto en la versión 3.6: Se agregó la opción @code{'_'} (véase también 
@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}).


`width' es un entero decimal que define el ancho total de campo mínimo, incluyendo prefijos, separadores y otros caracteres de formateo. Si no se especifica, el ancho de campo será determinado por el contenido.

When no explicit alignment is given, preceding the `width' field by a zero
(@code{'0'}) character enables sign-aware zero-padding for numeric types,
excluding @ref{154,,complex}.  This is equivalent to a `fill' character of
@code{'0'} with an `alignment' type of @code{'='}.


Distinto en la versión 3.10: Anteponer el campo `width' por @code{'0'} ya no afecta el alineamiento por defecto para cadenas de caracteres.


La `precisión' es un entero decimal que indica cuántos dígitos deben mostrarse después del punto decimal para los tipos de presentación @code{'f'} y @code{'F'}, o antes y después del punto decimal para los tipos de presentación @code{'g'} o @code{'G'}. Para los tipos de presentación de cadena, el campo indica el tamaño máximo del campo; en otras palabras, cuántos caracteres se utilizarán del contenido del campo. La `precisión' no está permitida para los tipos de presentación de enteros.

Finalmente, `type' (el tipo) determina como presentar los datos.

Los tipos de presentación cadena disponibles son:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'s'}

@tab

Formato de cadena de caracteres. Éste es el tipo por defecto y puede ser omitido.

@item

None

@tab

Lo mismo que @code{'s'}.

@end multitable

@end quotation

Los tipos disponibles para la presentación de enteros son:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'b'}

@tab

Formato binario. retorna el número en base 2.

@item

@code{'c'}

@tab

Carácter. Convierte el entero en el carácter unicode correspondiente antes de imprimirlo.

@item

@code{'d'}

@tab

Decimal entero. retorna el número en base 10.

@item

@code{'o'}

@tab

Formato octal. retorna el número en base 8.

@item

@code{'x'}

@tab

Formato hexadecimal. retorna el número en base 16, utilizando letras minúsculas para los dígitos superiores a 9.

@item

@code{'X'}

@tab

Formato hexadecimal. retorna el número en base 16, utilizando letras mayúsculas para los dígitos superiores a 9. En caso de que @code{'#'} se especifique, el prefijo @code{'0x'} convertirá en @code{'0X'} también.

@item

@code{'n'}

@tab

Número. Es lo mismo que @code{'d'}, excepto que usa la configuración regional actual para insertar el número apropiado de caracteres separadores.

@item

None

@tab

Lo mismo que @code{'d'}.

@end multitable

@end quotation

In addition to the above presentation types, integers can be formatted
with the floating-point presentation types listed below (except
@code{'n'} and @code{None}). When doing so, @ref{153,,float()} is used to convert the
integer to a floating-point number before formatting.

Los tipos de presentación disponibles para valores  @ref{153,,float} y @ref{16a,,Decimal} son:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'e'}

@tab

Scientific notation. For a given precision @code{p},
formats the number in scientific notation with the
letter “e” separating the coefficient from the exponent.
The coefficient has one digit before and @code{p} digits
after the decimal point, for a total of @code{p + 1}
significant digits. With no precision given, uses a
precision of @code{6} digits after the decimal point for
@ref{153,,float}, and shows all coefficient digits
for @ref{16a,,Decimal}.  If @code{p=0}, the decimal
point is omitted unless the @code{#} option is used.

@item

@code{'E'}

@tab

Notación científica. Igual que @code{'e'} excepto que utiliza una “E” mayúscula como carácter separador.

@item

@code{'f'}

@tab

Fixed-point notation. For a given precision @code{p},
formats the number as a decimal number with exactly
@code{p} digits following the decimal point. With no
precision given, uses a precision of @code{6} digits after
the decimal point for @ref{153,,float}, and uses a
precision large enough to show all coefficient digits
for @ref{16a,,Decimal}.  If @code{p=0}, the decimal
point is omitted unless the @code{#} option is used.

@item

@code{'F'}

@tab

Notación de punto fijo. Igual que @code{'f'}, pero convierte (nulos) @code{nan} a @code{NAN} e @code{inf} a @code{INF}.

@item

@code{'g'}

@tab

Formato general. Para una precisión dada @code{p >= 1}, redondea el número a @code{p} dígitos significativos y luego formatea el resultado como formato de punto fijo o en notación científica, dependiendo de su magnitud. Una precisión de @code{0} es tratada como equivalente a una precisión de @code{1}.

Las reglas precisas son las siguientes: supongamos que el resultado formateado con el tipo de presentación @code{'e'} y la precisión @code{p-1} tiene exponente @code{exp}.  Entonces, si @code{m <= exp < p}, donde @code{m} es -4 para `floats' y -6 para @ref{16a,,Decimals}, el número se formatea con el tipo de presentación @code{'f'} y la precisión @code{p-1-exp}.  De lo contrario, el número se formatea con el tipo de presentación @code{'e'} y precisión @code{p-1}. En ambos casos, los ceros finales insignificantes se eliminan del significado, y el punto decimal también se elimina si no hay dígitos restantes que lo sigan, a menos que se utilice la opción @code{'#'}.

Si no se da una precisión, usa una precisión de @code{6} dígitos significativos para @ref{153,,float}. Para @ref{16a,,Decimal} el coeficiente del resultado se construye usando los dígitos del coeficiente del valor; se usa notación científica para valores menores a @code{1e-6} en valor absoluto y valores donde el valor posicional del dígito menos significativo es mayor a 1, de otra forma se usa notación de punto fijo.

Infinito positivo y negativo, cero positivo y negativo, y nulos (`nans') son respectivamente formateados como @code{inf}, @code{-inf}, @code{0}, @code{-0} y @code{nan}, independientemente de la precisión.

@item

@code{'G'}

@tab

Formato general. Igual que @code{'g'} excepto que cambia a @code{'E'} si el número se vuelve muy grande. Las representaciones de infinito y NaN también se convierten a mayúsculas.

@item

@code{'n'}

@tab

Número. Es lo mismo que @code{'g'}, excepto que usa la configuración local para insertar los caracteres separadores de número apropiados.

@item

@code{'%'}

@tab

Porcentaje. Multiplica el número por 100 y lo muestra en formato fijo (@code{'f'}) seguido del signo porcentaje.

@item

None

@tab

For @ref{153,,float} this is like the @code{'g'} type, except
that when fixed-point notation is used to format the
result, it always includes at least one digit past the
decimal point, and switches to the scientific notation
when @code{exp >= p - 1}.  When the precision is not
specified, the latter will be as large as needed to
represent the given value faithfully.

Para @ref{16a,,Decimal}, esto es lo mismo que @code{'g'} o @code{'G'} dependiendo del valor de @code{context.capitals} para el contexto decimal actual.

El efecto general es el de igualar la salida de @ref{237,,str()} al ser alterada  por los otros modificadores de formato.

@end multitable

@end quotation

The result should be correctly rounded to a given precision @code{p} of digits
after the decimal point.  The rounding mode for @ref{153,,float} matches that
of the @ref{1342,,round()} builtin.  For @ref{16a,,Decimal}, the rounding
mode of the current @ref{22e6,,context} will be used.

The available presentation types for @ref{154,,complex} are the same as those for
@ref{153,,float} (@code{'%'} is not allowed).  Both the real and imaginary components
of a complex number are formatted as floating-point numbers, according to the
specified presentation type.  They are separated by the mandatory sign of the
imaginary part, the latter being terminated by a @code{j} suffix.  If the presentation
type is missing, the result will match the output of @ref{237,,str()} (complex numbers with
a non-zero real part are also surrounded by parentheses), possibly altered by
other format modifiers.

@node Ejemplos de formateo,,Especificación de formato Mini-Lenguaje,Sintaxis de formateo de cadena
@anchor{library/string format-examples}@anchor{22e7}@anchor{library/string formatexamples}@anchor{22dc}
@subsubsection Ejemplos de formateo


Esta sección contiene ejemplos de la sintaxis @ref{6c2,,str.format()} y comparaciones con el antiguo método de formateo usando @code{%}.

En la mayoría de los casos, la sintaxis es similar al antiguo formato @code{%}, con la adición de @code{@{@}} y con @code{:} utilizado en lugar de @code{%}. Por ejemplo, @code{'%03.2f'} puede ser traducido como @code{'@{:03.2f@}'}.

La nueva sintaxis de formato también soporta opciones diferentes y nuevas que se muestran en los ejemplos siguientes.

Accediendo argumentos por posición:

@example
>>> '@{0@}, @{1@}, @{2@}'.format('a', 'b', 'c')
'a, b, c'
>>> '@{@}, @{@}, @{@}'.format('a', 'b', 'c')  # 3.1+ only
'a, b, c'
>>> '@{2@}, @{1@}, @{0@}'.format('a', 'b', 'c')
'c, b, a'
>>> '@{2@}, @{1@}, @{0@}'.format(*'abc')      # unpacking argument sequence
'c, b, a'
>>> '@{0@}@{1@}@{0@}'.format('abra', 'cad')   # arguments' indices can be repeated
'abracadabra'
@end example

Accediendo argumentos por nombre:

@example
>>> 'Coordinates: @{latitude@}, @{longitude@}'.format(latitude='37.24N', longitude='-115.81W')
'Coordinates: 37.24N, -115.81W'
>>> coord = @{'latitude': '37.24N', 'longitude': '-115.81W'@}
>>> 'Coordinates: @{latitude@}, @{longitude@}'.format(**coord)
'Coordinates: 37.24N, -115.81W'
@end example

Accediendo los atributos de los argumentos:

@example
>>> c = 3-5j
>>> ('The complex number @{0@} is formed from the real part @{0.real@} '
...  'and the imaginary part @{0.imag@}.').format(c)
'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.'
>>> class Point:
...     def __init__(self, x, y):
...         self.x, self.y = x, y
...     def __str__(self):
...         return 'Point(@{self.x@}, @{self.y@})'.format(self=self)
...
>>> str(Point(4, 2))
'Point(4, 2)'
@end example

Accediendo ítems de los argumentos:

@example
>>> coord = (3, 5)
>>> 'X: @{0[0]@};  Y: @{0[1]@}'.format(coord)
'X: 3;  Y: 5'
@end example

Reemplazar @code{%s} y @code{%r}:

@example
>>> "repr() shows quotes: @{!r@}; str() doesn't: @{!s@}".format('test1', 'test2')
"repr() shows quotes: 'test1'; str() doesn't: test2"
@end example

Alinear el texto y especificar el ancho:

@example
>>> '@{:<30@}'.format('left aligned')
'left aligned                  '
>>> '@{:>30@}'.format('right aligned')
'                 right aligned'
>>> '@{:^30@}'.format('centered')
'           centered           '
>>> '@{:*^30@}'.format('centered')  # use '*' as a fill char
'***********centered***********'
@end example

Reemplazar @code{%+f}, @code{%-f}, y @code{% f} y especificar el signo:

@example
>>> '@{:+f@}; @{:+f@}'.format(3.14, -3.14)  # show it always
'+3.140000; -3.140000'
>>> '@{: f@}; @{: f@}'.format(3.14, -3.14)  # show a space for positive numbers
' 3.140000; -3.140000'
>>> '@{:-f@}; @{:-f@}'.format(3.14, -3.14)  # show only the minus -- same as '@{:f@}; @{:f@}'
'3.140000; -3.140000'
@end example

Reemplazando @code{%x} y @code{%o} y convirtiendo el valor a diferentes bases:

@example
>>> # format also supports binary numbers
>>> "int: @{0:d@};  hex: @{0:x@};  oct: @{0:o@};  bin: @{0:b@}".format(42)
'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
>>> # with 0x, 0o, or 0b as prefix:
>>> "int: @{0:d@};  hex: @{0:#x@};  oct: @{0:#o@};  bin: @{0:#b@}".format(42)
'int: 42;  hex: 0x2a;  oct: 0o52;  bin: 0b101010'
@end example

Usando la coma como separador de los miles:

@example
>>> '@{:,@}'.format(1234567890)
'1,234,567,890'
@end example

Expresar un porcentaje:

@example
>>> points = 19
>>> total = 22
>>> 'Correct answers: @{:.2%@}'.format(points/total)
'Correct answers: 86.36%'
@end example

Uso del formateo específico de tipo:

@example
>>> import datetime
>>> d = datetime.datetime(2010, 7, 4, 12, 15, 58)
>>> '@{:%Y-%m-%d %H:%M:%S@}'.format(d)
'2010-07-04 12:15:58'
@end example

Anidando argumentos y ejemplos más complejos:

@example
>>> for align, text in zip('<^>', ['left', 'center', 'right']):
...     '@{0:@{fill@}@{align@}16@}'.format(text, fill=align, align=align)
...
'left<<<<<<<<<<<<'
'^^^^^center^^^^^'
'>>>>>>>>>>>right'
>>>
>>> octets = [192, 168, 0, 1]
>>> '@{:02X@}@{:02X@}@{:02X@}@{:02X@}'.format(*octets)
'C0A80001'
>>> int(_, 16)
3232235521
>>>
>>> width = 5
>>> for num in range(5,12): 
...     for base in 'dXob':
...         print('@{0:@{width@}@{base@}@}'.format(num, base=base, width=width), end=' ')
...     print()
...
    5     5     5   101
    6     6     6   110
    7     7     7   111
    8     8    10  1000
    9     9    11  1001
   10     A    12  1010
   11     B    13  1011
@end example

@node Cadenas de plantillas,Funciones de ayuda,Sintaxis de formateo de cadena,string — Common string operations
@anchor{library/string id1}@anchor{22e8}@anchor{library/string template-strings}@anchor{21d8}
@subsubsection Cadenas de plantillas


Las cadenas de plantilla proporcionan sustituciones de cadenas de caracteres más sencillas como se describe en 
@geindex Python Enhancement Proposals; PEP 292
PEP 292@footnote{https://peps.python.org/pep-0292/}.  Un caso de uso principal para las cadenas de plantilla es la internacionalización (i18n) ya que en ese contexto, la sintaxis y la funcionalidad más sencillas hacen la traducción más fácil que otras instalaciones de formato de cadena de caracteres integradas en Python.  Como ejemplo de una biblioteca creada sobre cadenas de plantilla para i18n, véase el paquete flufl.i18n@footnote{http://flufli18n.readthedocs.io/en/latest/}.

@geindex $ (signo dólar);en plantillas de cadenas de caracteres

Las cadenas de caracteres de plantilla admiten sustituciones basadas en @code{$} de acuerdo a las siguientes reglas:


@itemize *

@item 
@code{$$} es un escape. Es reemplazado con un único @code{$}.

@item 
@code{$identifier} (identificador) nombra un comodín de sustitución que coincide con una clave de asignación de @code{"identifier"} (identificador).  De forma predeterminada, @code{"identifier"} está restringido a cualquier cadena alfanumérica ASCII (insensible a mayúsculas/minúsculas e incluyendo los guiones bajos) que comience con un guión bajo o una letra ASCII.  El primer carácter no identificador después del carácter @code{$} termina esta especificación de comodín.

@item 
@code{$@{identifier@}} es equivalente a @code{$identifier}. Es requerido cuando caracteres identificadores válidos siguen al comodín pero no son parte de él, por ejemplo @code{"$@{noun@}ification"}.
@end itemize

Cualquier otra aparición de @code{$} en la cadena de caracteres resultará en una excepción @ref{360,,ValueError}.

El módulo @ref{d3,,string} provee una clase @ref{728,,Template} que implementa esas reglas. Los métodos de @ref{728,,Template} son:

@geindex Template (clase en string)
@anchor{library/string string Template}@anchor{728}
@deffn {Clase} string.Template (template)

El constructor sólo lleva un argumento, la cadena plantilla.

@geindex substitute() (método de string.Template)
@anchor{library/string string Template substitute}@anchor{1cf1}
@deffn {Método} substitute (mapping=@{@}, /, **kwds)

Realiza la sustitución de plantilla y retorna una nueva cadena de caracteres. `mapping' (mapeo) es un objeto tipo diccionario con claves (`keys') que coinciden con los `placeholders' (comodines) de la plantilla. Como alternativa, es posible pasar argumentos de palabra clave cuyas palabras clave son los `placeholders' (comodines). Cuando `mapping' y `kwds' son dados y hay elementos duplicados, los `placeholders' (comodines) de `kwds' tienen prioridad.
@end deffn

@geindex safe_substitute() (método de string.Template)
@anchor{library/string string Template safe_substitute}@anchor{1cf2}
@deffn {Método} safe_substitute (mapping=@{@}, /, **kwds)

Igual que @ref{1cf1,,substitute()}, excepto que si faltan comodines de `mapping' y `kwds', en lugar de generar una excepción @ref{438,,KeyError}, el comodín original aparecerá en la cadena de caracteres resultante intacta.  Además, a diferencia de @ref{1cf1,,substitute()}, cualquier otra aparición de @code{$} simplemente retornará @code{$} en lugar de generar @ref{360,,ValueError}.

Mientras que otras excepciones aún pueden ocurrir, este método es llamado «seguro» (`safe') porque siempre intenta retornar una cadena de caracteres que pueda ser usada en lugar de levantar una excepción. Desde otro punto de vista, el método @ref{1cf2,,safe_substitute()} es en realidad para nada seguro, dado que ignorará plantillas defectuosas con delimitadores colgados, llaves sin cerrar, o comodines que no son identificadores válidos en Python.
@end deffn

@geindex is_valid() (método de string.Template)
@anchor{library/string string Template is_valid}@anchor{727}
@deffn {Método} is_valid ()

Retorna false si la plantilla tiene marcadores de posición no válidos que harán que @ref{1cf1,,substitute()} lance @ref{360,,ValueError}.


Added in version 3.11.

@end deffn

@geindex get_identifiers() (método de string.Template)
@anchor{library/string string Template get_identifiers}@anchor{726}
@deffn {Método} get_identifiers ()

Retorna una lista de los identificadores válidos en la plantilla, en el orden en que aparecen por primera vez, ignorando cualquier identificador no válido.


Added in version 3.11.

@end deffn

Las instancias de @ref{728,,Template} también proporcionan un atributo de datos públicos:

@geindex template (atributo de string.Template)
@anchor{library/string string Template template}@anchor{22e9}
@deffn {Atributo} template

Éste es el objeto que se le pasa como argumento `template' al constructor. En general, no debería ser modificado, pero el acceso de sólo lectura (`read-only') no es impuesto.
@end deffn
@end deffn

Aquí un ejemplo de cómo usar una plantilla (`Template'):

@example
>>> from string import Template
>>> s = Template('$who likes $what')
>>> s.substitute(who='tim', what='kung pao')
'tim likes kung pao'
>>> d = dict(who='tim')
>>> Template('Give $who $100').substitute(d)
Traceback (most recent call last):
...
ValueError: Invalid placeholder in string: line 1, col 11
>>> Template('$who likes $what').substitute(d)
Traceback (most recent call last):
...
KeyError: 'what'
>>> Template('$who likes $what').safe_substitute(d)
'tim likes $what'
@end example

Uso avanzado: es posible derivar subclases de @ref{728,,Template} para personalizar la sintaxis de `placeholder', caracteres de delimitación, o bien la expresión regular entera usada para procesar cadenas de plantillas. Para ello, es posible sobrescribir los siguientes atributos de clase:


@itemize *

@item 
`delimiter': es la cadena de caracteres literal que describe al delimitador que introduce un comodín.  El valor predeterminado es @code{$}.  Notar que esto `no debe' ser una expresión regular, ya que la implementación llamará a @ref{c91,,re.escape()} en esta cadena de caracteres según sea necesario.  Tener en cuenta además, que se no puede cambiar el delimitador después haber creado la clase (es decir, se debe establecer un delimitador diferente en el espacio de nombres de la subclase).

@item 
`idpattern' – Esta es la expresión regular que describe el patrón para comodines fuera de las llaves.  El valor predeterminado es la expresión regular @code{(?a:[_a-z][_a-z0-9]*)}.  Si se proporciona este argumento y `braceidpattern' es @code{None} este patrón también se aplicará a los comodines entre llaves.

@cartouche
@quotation Nota 
Dado que el valor predeterminado de `flags' es @code{re.IGNORECASE}, el patrón @code{[a-z]} puede coincidir con algunos caracteres que no son ASCII. Por ello se utiliza aquí la bandera local @code{a}.
@end quotation
@end cartouche


Distinto en la versión 3.7: `braceidpattern' puede ser usado para definir patrones separados, usados dentro y fuera de los corchetes.


@item 
`braceidpattern' – Es como `idpattern' pero describe el patrón para comodines entre llaves.  El valor por defecto es @code{None}, lo que significa volver a `idpattern' (es decir, el mismo patrón se utiliza tanto dentro como fuera de las llaves). Si se proporciona, esto le permite definir diferentes patrones para comodines dentro y fuera de las llaves.


Added in version 3.7.


@item 
`flags' – Banderas de expresión regular que se aplicarán al compilar la expresión regular utilizada para reconocer sustituciones.  El valor por defecto es @code{re.IGNORECASE}.  Téngase en cuenta que @code{re.VERBOSE} siempre se agregará a las banderas, por lo que `idpattern' (s) personalizado(s) debe(n) seguir las convenciones de expresiones regulares detalladas.


Added in version 3.2.

@end itemize

Como alternativa, se puede proporcionar el patrón de expresión regular completo, reemplazando así el atributo de clase `pattern'.  Si eso ocurre, el valor debe ser un objeto de expresión regular con cuatro grupos de captura con nombre.  Los grupos de captura corresponden a las reglas indicadas anteriormente, junto con la regla de marcador de posición no válida:


@itemize *

@item 
`escaped' – Este grupo coincide con la secuencia de escape en el patrón predeterminado, por ejemplo, @code{$$}.

@item 
`named' – Este grupo coincide con el nombre comodín fuera de las llaves. No debe incluir el delimitador del grupo de captura.

@item 
`braced' – Este grupo coincide con el nombre del comodín adjunto; no debe incluir ni el delimitador ni las llaves en el grupo de captura.

@item 
`invalid' – Este grupo se empareja con cualquier otro patrón de delimitación (usualmente un único carácter) y debe ser lo último en aparecer en la expresión regular.
@end itemize

Los métodos de esta clase generarán @ref{360,,ValueError} si el patrón coincide con la plantilla sin que coincida uno de estos grupos nombrados.

@node Funciones de ayuda,,Cadenas de plantillas,string — Common string operations
@anchor{library/string helper-functions}@anchor{22ea}
@subsubsection Funciones de ayuda


@geindex capwords() (en el módulo string)
@anchor{library/string string capwords}@anchor{21d4}
@deffn {Función} string.capwords (s, sep=None)

Separa el argumento en dos palabras utilizando el método @ref{f2b,,str.split()}, convierte a mayúsculas vía @ref{21c4,,str.capitalize()} y une las palabras en mayúscula con el método @ref{21b5,,str.join()}. Si el segundo argumento opcional `sep' está ausente o es @code{None}, los espacios en blanco se reemplazarán con un único espacio y los espacios en blanco iniciales y finales se eliminarán; caso contrario, `sep' se usa para separar y unir las palabras.
@end deffn

@node re — Regular expression operations,difflib — Helpers for computing deltas,string — Common string operations,Servicios de procesamiento de texto
@anchor{library/re doc}@anchor{22eb}@anchor{library/re module-re}@anchor{b9}@anchor{library/re re-regular-expression-operations}@anchor{22ec}
@subsection @code{re} — Regular expression operations


@geindex module; re

`Código fuente:' Lib/re/@footnote{https://github.com/python/cpython/tree/main/Lib/re/}


__________________________________________________________________


Este módulo proporciona operaciones de coincidencia de expresiones regulares similares a las encontradas en Perl.

Both patterns and strings to be searched can be Unicode strings (@ref{237,,str})
as well as 8-bit strings (@ref{325,,bytes}).
However, Unicode strings and 8-bit strings cannot be mixed:
that is, you cannot match a Unicode string with a bytes pattern or
vice-versa; similarly, when asking for a substitution, the replacement
string must be of the same type as both the pattern and the search string.

Las expresiones regulares usan el carácter de barra inversa (@code{'\'}) para indicar formas especiales o para permitir el uso de caracteres especiales sin invocar su significado especial.  Esto choca con el uso de Python de este carácter para el mismo propósito con los literales de cadena; por ejemplo, para hacer coincidir una barra inversa literal, se podría escribir @code{'\\\\'} como patrón, porque la expresión regular debe ser @code{\\}, y cada barra inversa debe ser expresada como @code{\\} dentro de un literal de cadena regular de Python.  También, notar que cualquier secuencia de escape inválida mientras se use la barra inversa de Python en los literales de cadena ahora genera un @ref{511,,SyntaxWarning} y en el futuro esto se convertirá en un @ref{150,,SyntaxError}.  Este comportamiento ocurrirá incluso si es una secuencia de escape válida para una expresión regular.

La solución es usar la notación de cadena `raw' de Python para los patrones de expresiones regulares; las barras inversas no se manejan de ninguna manera especial en un literal de cadena prefijado con @code{'r'}.  Así que @code{r"\n"} es una cadena de dos caracteres que contiene @code{'\'} y @code{'n'}, mientras que @code{"\n"} es una cadena de un carácter que contiene una nueva línea.  Normalmente los patrones se expresan en código Python usando esta notación de cadena `raw'.

Es importante señalar que la mayoría de las operaciones de expresiones regulares están disponibles como funciones y métodos a nivel de módulo en @ref{1005,,expresiones regulares compiladas} (expresiones regulares compiladas).  Las funciones son atajos que no requieren de compilar un objeto regex primero, aunque pasan por alto algunos parámetros de ajuste.


@subsubheading Ver también


The third-party regex@footnote{https://pypi.org/project/regex/} module,
which has an API compatible with the standard library @ref{b9,,re} module,
but offers additional functionality and a more thorough Unicode support.


@menu
* Sintaxis de expresiones regulares:: 
* Contenidos del módulo:: 
* Objetos expresión regular:: 
* Objetos de coincidencia:: 
* Ejemplos de expresiones regulares:: 

@end menu

@node Sintaxis de expresiones regulares,Contenidos del módulo,,re — Regular expression operations
@anchor{library/re re-syntax}@anchor{7c0}@anchor{library/re regular-expression-syntax}@anchor{22ed}
@subsubsection Sintaxis de expresiones regulares


Una expresión regular (o RE, por sus siglas en inglés) especifica un conjunto de cadenas que coinciden con ella; las funciones de este módulo permiten comprobar si una determinada cadena coincide con una expresión regular dada (o si una expresión regular dada coincide con una determinada cadena, que se reduce a lo mismo).

Las expresiones regulares pueden ser concatenadas para formar nuevas expresiones regulares; si `A' y `B' son ambas expresiones regulares, entonces `AB' es también una expresión regular. En general, si una cadena `p' coincide con `A' y otra cadena `q' coincide con `B', la cadena `porque' coincidirá con AB.  Esto se mantiene a menos que `A' o `B' contengan operaciones de baja precedencia; condiciones límite entre `A' y `B'; o tengan referencias de grupo numeradas.  Así, las expresiones complejas pueden construirse fácilmente a partir de expresiones primitivas más simples como las que se describen aquí.  Para detalles de la teoría e implementación de las expresiones regulares, consulte el libro de Friedl @ref{22ee,,[Frie09]}, o casi cualquier libro de texto sobre la construcción de compiladores.

A continuación se explica brevemente el formato de las expresiones regulares.  Para más información y una presentación más amena, consultar la @ref{22ef,,Expresiones regulares COMOS (HOWTO)}.

Las expresiones regulares pueden contener tanto caracteres especiales como ordinarios. La mayoría de los caracteres ordinarios, como @code{'A'}, @code{'a'}, o @code{'0'} son las expresiones regulares más sencillas; simplemente se ajustan a sí mismas.  Se pueden concatenar caracteres ordinarios, así que @code{last} coincide con la cadena @code{'last'}.  (En el resto de esta sección, se escribirán los RE en @code{este estilo especial}, normalmente sin comillas, y las cadenas que deban coincidir @code{'entre comillas simples'}.)

Algunos caracteres, como @code{'|'} o @code{'('}, son especiales. Los caracteres especiales representan clases de caracteres ordinarios, o afectan a la forma en que se interpretan las expresiones regulares que los rodean.

Los operadores de repetición o cuantificadores (@code{*}, @code{+}, @code{?}, @code{@{m,n@}}, etc.) no pueden ser anidados directamente. Esto evita la ambigüedad con el sufijo modificador no codicioso @code{?}, y con otros modificadores en otras implementaciones. Para aplicar una segunda repetición a una repetición interna, se pueden usar paréntesis. Por ejemplo, la expresión @code{(?:a@{6@})*} coincide con cualquier múltiplo de seis caracteres @code{'a'}.

Los caracteres especiales son:

@geindex . (dot);en expresiones regulares


@table @asis

@item @code{.}

(Dot.)  In the default mode, this matches any character except a newline.  If
the @ref{22f0,,DOTALL} flag has been specified, this matches any character
including a newline.  @code{(?s:.)} matches any character regardless of flags.
@end table

@geindex ^ (caret);en expresiones regulares


@table @asis

@item @code{^}

(Circunflejo.)  Coincide con el comienzo de la cadena, y en modo @ref{22f1,,MULTILINE} también coincide inmediatamente después de cada nueva línea.
@end table

@geindex $ (dólar);en expresiones regulares


@table @asis

@item @code{$}

Coincide con el final de la cadena o justo antes de la nueva línea al final de la cadena, y en modo @ref{22f1,,MULTILINE} también coincide antes de una nueva línea.  @code{foo} coincide con “foo” y “foobar”, mientras que la expresión regular @code{foo$} sólo coincide con “foo”.  Más interesante aún, al buscar @code{foo.$} en @code{'foo1\nfoo2\n'} coincide con “foo2” normalmente, pero solo “foo1” en @code{MULTILINE`}; si busca un solo @code{$} en @code{'foo\n'} encontrará dos coincidencias (vacías): una justo antes de una nueva línea, y otra al final de la cadena.
@end table

@geindex (asterisco);en expresiones regulares


@table @asis

@item @code{*}

Hace que el RE resultante coincida con 0 o más repeticiones del RE precedente, tantas repeticiones como sean posibles.  @code{ab*} coincidirá con “a”, “ab” o “a” seguido de cualquier número de “b”.
@end table

@geindex + (mas);en expresiones regulares


@table @asis

@item @code{+}

Hace que la RE resultante coincida con 1 o más repeticiones de la RE precedente. @code{ab+} coincidirá con “a” seguido de cualquier número distinto de cero de “b”; no coincidirá solo con “a”.
@end table

@geindex ? (signo de interrogación);en expresiones regulares


@table @asis

@item @code{?}

Hace que la RE resultante coincida con 0 o 1 repeticiones de la RE precedente. @code{ab?} coincidirá con “a” o “ab”.
@end table

@geindex *?;en expresiones regulares
@geindex +?;en expresiones regulares
@geindex ??;en expresiones regulares


@table @asis

@item @code{*?}, @code{+?}, @code{??}

Los delimitadores @code{'*'}, @code{'+'}, y @code{'?'} son todos `greedy'; coinciden con la mayor cantidad de texto posible.  A veces este comportamiento no es deseado; si el RE @code{<.*>} se utiliza para coincidir con @code{'<a> b <c>'}, coincidirá con toda la cadena, y no sólo con @code{'<a>'}.  Añadiendo @code{?} después del delimitador hace que se realice la coincidencia de manera `non-greedy' o `minimal'; coincidirá la `mínima' cantidad de caracteres como sea posible.  Usando el RE @code{<.*?>} sólo coincidirá con @code{'<a>'}.
@end table

@geindex *+;en expresiones regulares
@geindex ++;en expresiones regulares
@geindex ?+;en expresiones regulares


@table @asis

@item @code{*+}, @code{++}, @code{?+}

Como los cuantificadores @code{'*'}, @code{'+'}, y @code{'?'} , aquellos en los que se agrega @code{'+'} también coinciden tantas veces como sea posible. Sin embargo, a diferencia de los verdaderos cuantificadores codiciosos, estos no permiten retroceder cuando la expresión que le sigue no coincide. Estos se conocen como cuantificadores `possessive'. Por ejemplo, @code{a*a} coincidirá con @code{'aaaa'} porque la @code{a*} coincidirá con los 4 @code{'a'}s, pero, cuando se encuentra la @code{'a'} final, la expresión retrocede de modo que al final la @code{a*} termina coincidiendo con 3 @code{'a'}s total, y la cuarta @code{'a'} coincide con la final @code{'a'}. Sin embargo, cuando @code{a*+a} se usa para que coincida con @code{'aaaa'}, el @code{a*+} coincidirá con los 4 @code{'a'}, pero cuando el @code{'a'} final no encuentra más caracteres para coincidir, la expresión no puede retroceder y, por lo tanto, no coincidirá. @code{x*+}, @code{x++} and @code{x?+} son equivalentes a @code{(?>x*)}, @code{(?>x+)} and @code{(?>x?)} correspondientemente.


Added in version 3.11.

@end table

@geindex @{@} (llaves o corchetes curvos);en expresiones regulares


@table @asis

@item @code{@{m@}}

Especifica que exactamente `m' copias de la RE anterior deben coincidir; menos coincidencias hacen que la RE entera no coincida.  Por ejemplo, @code{a@{6@}} coincidirá exactamente con seis caracteres @code{'a'}, pero no con cinco.

@item @code{@{m,n@}}

Hace que el RE resultante coincida de `m' a `n' repeticiones del RE precedente, tratando de coincidir con el mayor número de repeticiones posible.  Por ejemplo, @code{a@{3,5@}} coincidirá de 3 a 5 caracteres @code{'a'}.  Omitiendo `m' se especifica un límite inferior de cero, y omitiendo `n' se especifica un límite superior infinito.  Por ejemplo, @code{a@{4,@}b} coincidirá con @code{'aaaab'} o mil caracteres @code{'a'} seguidos de una @code{'b'}, pero no @code{'aaab'}. La coma no puede ser omitida o el modificador se confundiría con la forma descrita anteriormente.

@item @code{@{m,n@}?}

Hace que el RE resultante coincida de `m' a `n' repeticiones del RE precedente, tratando de coincidir con el `mínimo de' repeticiones posible.  Esta es la versión `non-greedy' (no codiciosa) del delimitador anterior.  Por ejemplo, en la cadena de 6 caracteres @code{'aaaaaa'}, @code{a@{3,5@}} coincidirá con 5 caracteres @code{'a'}, mientras que @code{a@{3,5@}?} solo coincidirá con 3 caracteres.

@item @code{@{m,n@}+}

Hace que el RE resultante coincida de `m' a `n' repeticiones del RE anterior, intentando hacer coincidir tantas repeticiones como sea posible `sin' establecer ningún punto de retroceso. Esta es la versión posesiva del cuantificador anterior. Por ejemplo, en la cadena de 6 caracteres @code{'aaaaaa'}, @code{a@{3,5@}+aa} intenta hacer coincidir 5 caracteres @code{'a'}, entonces, al requerir 2 más @code{'a'}s, necesitará más caracteres de los disponibles y, por lo tanto, fallará, mientras que @code{a@{3,5@}aa} coincidirá con @code{a@{3,5@}} capturando 5, luego 4 @code{'a'}s por retroceso y luego los últimos 2 @code{'a'}s son emparejados por el @code{aa} final en el patrón. @code{x@{m,n@}+} es equivalente a @code{(?>x@{m,n@})}.


Added in version 3.11.

@end table

@geindex \ (barra inversa);en expresiones regulares


@table @asis

@item @code{\}

O bien se escapan a los caracteres especiales (lo que le permite hacer coincidir caracteres como @code{'*'}, @code{'?'}, y así sucesivamente), o se señala una secuencia especial; las secuencias especiales se explican más adelante.

Si no se utiliza una cadena `raw' para expresar el patrón, recuerde que Python también utiliza la barra inversa como secuencia de escape en los literales de la cadena; si el analizador sintáctico de Python no reconoce la secuencia de escape, la barra inversa y el carácter subsiguiente se incluyen en la cadena resultante.  Sin embargo, si Python quisiera reconocer la secuencia resultante, la barra inversa debería repetirse dos veces.  Esto es complicado y difícil de entender, por lo que se recomienda encarecidamente utilizar cadenas `raw' para todas las expresiones salvo las más simples.
@end table

@geindex [] (corchetes);en expresiones regulares


@table @asis

@item @code{[]}

Se utiliza para indicar un conjunto de caracteres.  En un conjunto:


@itemize *

@item 
Los caracteres pueden ser listados individualmente, ej. @code{[amk]} coincidirá con @code{'a'}, @code{'m'}, o @code{'k'}.
@end itemize

@geindex - (menos);en expresiones regulares


@itemize *

@item 
Los rangos de caracteres se pueden indicar mediante dos caracteres y separándolos con un @code{'-'}. Por ejemplo, @code{[a-z]} coincidirá con cualquier letra ASCII en minúscula, @code{[0-5][0-9]} coincidirá con todos los números de dos dígitos desde el @code{00} hasta el @code{59}, y @code{[0-9A-Fa-f]} coincidirá con cualquier dígito hexadecimal.  Si se escapa @code{-} (por ejemplo, @code{[a\-z]}) o si se coloca como el primer o el último carácter (por ejemplo, @code{[-a]} o @code{[a-]}), coincidirá con un literal @code{'-'}.

@item 
Los caracteres especiales pierden su significado especial dentro de los sets.  Por ejemplo, @code{[(+*)]} coincidirá con cualquiera de los caracteres literales @code{'('}, @code{'+'}, @code{'*'}, o @code{')'}.
@end itemize

@geindex \ (barra inversa);en expresiones regulares


@itemize *

@item 
Character classes such as @code{\w} or @code{\S} (defined below) are also accepted
inside a set, although the characters they match depend on the @ref{22f2,,flags} used.
@end itemize

@geindex ^ (caret);en expresiones regulares


@itemize *

@item 
Los caracteres que no están dentro de un rango pueden ser coincidentes con `complementing' el conjunto. Si el primer carácter del conjunto es @code{'^'}, todos los caracteres que `no' están en el conjunto coincidirán. Por ejemplo, @code{[^5]} coincidirá con cualquier carácter excepto con @code{'5'}, y @code{[^^]} coincidirá con cualquier carácter excepto con @code{'^'}. @code{^} no tiene un significado especial si no es el primer carácter del conjunto.

@item 
Para coincidir con un @code{']'} literal dentro de un set, se debe preceder con una barra inversa, o colocarlo al principio del set. Por ejemplo, tanto @code{[()[\]@{@}]} como @code{[]()[@{@}]} coincidirá con los paréntesis, corchetes y llaves.
@end itemize

@c .. index:: single: --; in regular expressions

@c .. index:: single: &&; in regular expressions

@c .. index:: single: ~~; in regular expressions

@c .. index:: single: ||; in regular expressions


@itemize *

@item 
El soporte de conjuntos anidados y operaciones de conjuntos como en Unicode Technical Standard #18@footnote{https://unicode.org/reports/tr18/} podría ser añadido en el futuro. Esto cambiaría la sintaxis, así que por el momento se planteará un @ref{4d4,,FutureWarning} en casos ambiguos para facilitar este cambio. Ello incluye conjuntos que empiecen con un literal @code{'['} o que contengan secuencias de caracteres literales @code{'—'}, @code{'&&'}, @code{'~~'} y @code{'||'}. Para evitar una advertencia, utilizar el código de escape con una barra inversa.
@end itemize


Distinto en la versión 3.7: @ref{4d4,,FutureWarning} se genera si un conjunto de caracteres contiene construcciones que cambiarán semánticamente en el futuro.

@end table

@geindex | (barra vertical);en expresiones regulares


@table @asis

@item @code{|}

@code{A|B}, donde `A' y `B' pueden ser RE arbitrarias, crea una expresión regular que coincidirá con `A' or `B'. Un número arbitrario de RE puede ser separado por @code{'|'} de esta manera. Esto puede también ser usado dentro de grupos (ver más adelante). Cuando la cadena de destino es procesada, los RE separados por @code{'|'} son probados de izquierda a derecha. Cuando un patrón coincide completamente, esa rama es aceptada. Esto significa que una vez que `A' coincida, `B' no se comprobará más, incluso si se produce una coincidencia general más larga. En otras palabras, el operador de @code{'|'} nunca es codicioso. Para emparejar un literal @code{'|'}, se usa @code{\|}, o se envuelve dentro de una clase de caracteres, como en @code{[|]}.
@end table

@geindex () (paréntesis);en expresiones regulares


@table @asis

@item @code{(...)}

Coincide con cualquier expresión regular que esté dentro de los paréntesis, e indica el comienzo y el final de un grupo; el contenido de un grupo puede ser recuperado después de que se haya realizado una coincidencia, y puede coincidir más adelante en la cadena con la secuencia especial @code{\number}, que se describe más adelante. Para hacer coincidir los literales @code{`'('} o @code{')'}, se usa @code{\(} o @code{\)}, o se envuelve dentro de una clase de caracteres: @code{[(]}, @code{[)]}.
@end table

@geindex (?;en expresiones regulares


@table @asis

@item @code{(?...)}

Esta es una notación de extensión (un @code{'?'} después de un @code{'('} no tiene ningún otro significado). El primer carácter después de @code{'?'} determina el significado y la sintaxis de la construcción. Las extensiones normalmente no crean un nuevo grupo; @code{(?P<name>…)} es la única excepción a esta regla. A continuación se muestran las extensiones actualmente soportadas.

@item @code{(?aiLmsux)}

(One or more letters from the set
@code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'}.)
The group matches the empty string;
the letters set the corresponding flags for the entire regular expression:


@itemize *

@item 
@ref{22f3,,re.A} (ASCII-only matching)

@item 
@ref{22f4,,re.I} (ignore case)

@item 
@ref{22f5,,re.L} (locale dependent)

@item 
@ref{22f6,,re.M} (multi-line)

@item 
@ref{22f7,,re.S} (dot matches all)

@item 
@ref{22f8,,re.U} (Unicode matching)

@item 
@ref{22f9,,re.X} (verbose)
@end itemize

(The flags are described in @ref{22fa,,Contenidos del módulo}.)
This is useful if you wish to include the flags as part of the
regular expression, instead of passing a `flag' argument to the
@ref{c5b,,re.compile()} function.
Flags should be used first in the expression string.


Distinto en la versión 3.11: Esta construcción solo se puede usar al comienzo de la expresión.

@end table

@geindex (?;;en expresiones regulares


@table @asis

@item @code{(?:...)}

Una versión no capturable de los paréntesis regulares. Hace coincidir cualquier expresión regular que esté dentro de los paréntesis, pero la subcadena coincidente con el grupo `no puede' ser recuperada después de realizar una coincidencia o referenciada más adelante en el patrón.

@item @code{(?aiLmsux-imsx:...)}

(Zero or more letters from the set
@code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'},
optionally followed by @code{'-'} followed by
one or more letters from the @code{'i'}, @code{'m'}, @code{'s'}, @code{'x'}.)
The letters set or remove the corresponding flags for the part of the expression:


@itemize *

@item 
@ref{22f3,,re.A} (ASCII-only matching)

@item 
@ref{22f4,,re.I} (ignore case)

@item 
@ref{22f5,,re.L} (locale dependent)

@item 
@ref{22f6,,re.M} (multi-line)

@item 
@ref{22f7,,re.S} (dot matches all)

@item 
@ref{22f8,,re.U} (Unicode matching)

@item 
@ref{22f9,,re.X} (verbose)
@end itemize

(The flags are described in @ref{22fa,,Contenidos del módulo}.)

The letters @code{'a'}, @code{'L'} and @code{'u'} are mutually exclusive when used
as inline flags, so they can’t be combined or follow @code{'-'}.  Instead,
when one of them appears in an inline group, it overrides the matching mode
in the enclosing group.  In Unicode patterns @code{(?a:...)} switches to
ASCII-only matching, and @code{(?u:...)} switches to Unicode matching
(default).  In bytes patterns @code{(?L:...)} switches to locale dependent
matching, and @code{(?a:...)} switches to ASCII-only matching (default).
This override is only in effect for the narrow inline group, and the
original matching mode is restored outside of the group.


Added in version 3.6.



Distinto en la versión 3.7: Las letras @code{'a'}, @code{'L'} y @code{'u'} también pueden ser usadas en un grupo.


@item @code{(?>...)}

Intenta hacer coincidir @code{...} como si fuera una expresión regular separada, y si tiene éxito, continúa coincidiendo con el resto del patrón que la sigue. Si el patrón posterior no coincide, la pila solo se puede desenrollar a un punto `antes' del @code{(?>...)} Porque una vez que salió, la expresión, conocida como `grupo atomico <atomic group>', ha desechado todos los puntos de pila dentro de sí misma. Por lo tanto, @code{(?>.*).} nunca coincidiría con nada porque primero el @code{.*} coincidiría con todos los caracteres posibles, luego, al no tener nada que igualar, el @code{.} final no coincidiría. Dado que no hay puntos de pila guardados en el Grupo Atómico, y no hay ningún punto de pila antes de él, toda la expresión no coincidiría.


Added in version 3.11.

@end table

@geindex (?P<;en expresiones regulares


@table @asis

@item @code{(?P<name>...)}

Similar a los paréntesis regulares, pero la subcadena coincidente con el grupo es accesible a través del nombre simbólico del grupo, `name'. Los nombres de grupo deben ser identificadores válidos de Python, y en los patrones de @ref{325,,bytes} solo pueden contener bytes en el rango ASCII.  Cada nombre de grupo debe ser definido sólo una vez dentro de una expresión regular.  Un grupo simbólico es también un grupo numerado, del mismo modo que si el grupo no tuviera nombre.

Los grupos con nombre pueden ser referenciados en tres contextos. Si el patrón es @code{(?P<quote>['"]).*?(?P=quote)} (es decir, hacer coincidir una cadena citada con comillas simples o dobles):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Contexto de la referencia al grupo `quote' (cita)

@tab

Formas de hacer referencia

@item

en el mismo patrón en sí mismo

@tab


@itemize *

@item 
@code{(?P=quote)} (como se muestra)

@item 
@code{\1}
@end itemize

@item

cuando se procesa el objeto de la coincidencia `m'

@tab


@itemize *

@item 
@code{m.group('quote')}

@item 
@code{m.end('quote')} (etc.)
@end itemize

@item

en una cadena pasada al argumento `repl' de @code{re.sub()}

@tab


@itemize *

@item 
@code{\g<quote>}

@item 
@code{\g<1>}

@item 
@code{\1}
@end itemize

@end multitable



Distinto en la versión 3.12: En patrones de tipo @ref{325,,bytes}, el nombre del grupo `name' solo puede contener bytes en el rango ASCII (@code{b'\x00'}-@code{b'\x7f'}).

@end table

@geindex (?P=;en expresiones regulares


@table @asis

@item @code{(?P=name)}

Una referencia inversa a un grupo nombrado; coincide con cualquier texto correspondido por el grupo anterior llamado `name'.
@end table

@geindex (?#;en expresiones regulares


@table @asis

@item @code{(?#...)}

Un comentario; el contenido de los paréntesis es simplemente ignorado.
@end table

@geindex (?=;en expresiones regulares


@table @asis

@item @code{(?=...)}

Coincide si @code{…} coincide con el siguiente patrón, pero no procesa nada de la cadena. Esto se llama una `lookahead assertion' (aserción de búsqueda anticipada). Por ejemplo, @code{Isaac (?=Asimov)} coincidirá con @code{'Isaac '} sólo si va seguido de @code{'Asimov'}.
@end table

@geindex (?!;en expresiones regulares


@table @asis

@item @code{(?!...)}

Coincide si @code{…} no coincide con el siguiente. Esta es una `negative lookahead assertion' (aserción negativa de búsqueda anticipada). Por ejemplo, @code{Isaac (?!Asimov)} coincidirá con @code{'Isaac '} sólo si `no' es seguido por @code{'Asimov'}.
@end table

@geindex (?<=;en expresiones regulares


@table @asis

@item @code{(?<=...)}

Coincide si la posición actual en la cadena es precedida por una coincidencia para @code{…} que termina en la posición actual.  Esto se llama una `positive lookbehind assertion' (aserciones positivas de búsqueda tardía). @code{(?<=abc)def} encontrará una coincidencia en @code{'abcdef'}, ya que la búsqueda tardía hará una copia de seguridad de 3 caracteres y comprobará si el patrón contenido coincide. El patrón contenido sólo debe coincidir con cadenas de alguna longitud fija, lo que significa que @code{abc} o @code{a|b} están permitidas, pero @code{a*} y @code{a@{3,4@}} no lo están.  Hay que tener en cuenta que los patrones que empiezan con aserciones positivas de búsqueda tardía no coincidirán con el principio de la cadena que se está buscando; lo más probable es que se quiera usar la función @ref{1299,,search()} en lugar de la función @ref{129a,,match()}:

@example
>>> import re
>>> m = re.search('(?<=abc)def', 'abcdef')
>>> m.group(0)
'def'
@end example

Este ejemplo busca una palabra seguida de un guión:

@example
>>> m = re.search(r'(?<=-)\w+', 'spam-egg')
>>> m.group(0)
'egg'
@end example


Distinto en la versión 3.5: Se añadió soporte a las referencias de grupo de longitud fija.

@end table

@geindex (?<!;en expresiones regulares


@table @asis

@item @code{(?<!...)}

Coincide si la posición actual en la cadena no está precedida por una coincidencia de «…».  Esto se llama una `negative lookbehind assertion' (Aserciones negativas de búsqueda tardía).  Similar a las aserciones positivas de búsqueda tardía, el patrón contenido sólo debe coincidir con cadenas de alguna longitud fija.  Los patrones que empiezan con aserciones negativas pueden coincidir al principio de la cadena que se busca.
@end table

@geindex (?(;en expresiones regulares
@anchor{library/re re-conditional-expression}@anchor{17b5}

@table @asis

@item @code{(?(id/name)yes-pattern|no-pattern)}

Tratará de coincidir con el @code{yes-pattern} (con patrón) si el grupo con un `id' o  `nombre' existe, y con el @code{no-pattern} (sin patrón) si no existe. El @code{no-pattern} es opcional y puede ser omitido. Por ejemplo, @code{(<)?(\w+@@\w+(?:\.\w+)+)(?(1)>||$)} es un patrón de coincidencia de correo electrónico deficiente, ya que coincidirá con @code{'<user@@host.com>'} así como con @code{'user@@host.com'}, pero no con @code{'<user@@host.com'} ni con @code{'user@@host.com>'}.


Distinto en la versión 3.12: El `id' del grupo solo puede contener dígitos ASCII. En patrones de tipo @ref{325,,bytes}, el `name' del grupo solo puede contener bytes en el rango ASCII (@code{b'\x00'}-@code{b'\x7f'}).

@end table
@anchor{library/re re-special-sequences}@anchor{22fb}
Las secuencias especiales consisten en @code{'\'} y un carácter de la lista que aparece más adelante. Si el carácter ordinario no es un dígito ASCII o una letra ASCII, entonces el RE resultante coincidirá con el segundo carácter.  Por ejemplo, @code{\$} coincide con el carácter @code{'$'}.

@geindex \ (barra inversa);en expresiones regulares


@table @asis

@item @code{\number}

Coincide con el contenido del grupo del mismo número.  Los grupos se numeran empezando por el 1. Por ejemplo, @code{(.+) \1} coincide con @code{'el el'} o @code{'55 55'}, pero no con @code{'elel'} (notar el espacio después del grupo).  Esta secuencia especial sólo puede ser usada para hacer coincidir uno de los primeros 99 grupos.  Si el primer dígito del `número' es 0, o el `número' tiene 3 dígitos octales, no se interpretará como una coincidencia de grupo, sino como el carácter con valor octal `número'. Dentro de los @code{'['} y @code{']'} de una clase de caracteres, todos los escapes numéricos son tratados como caracteres.
@end table

@geindex \A;en expresiones regulares


@table @asis

@item @code{\A}

Coincide sólo al principio de la cadena.
@end table

@geindex \b;en expresiones regulares


@table @asis

@item @code{\b}

Matches the empty string, but only at the beginning or end of a word.
A word is defined as a sequence of word characters.
Note that formally, @code{\b} is defined as the boundary
between a @code{\w} and a @code{\W} character (or vice versa),
or between @code{\w} and the beginning or end of the string.
This means that @code{r'\bat\b'} matches @code{'at'}, @code{'at.'}, @code{'(at)'},
and @code{'as at ay'} but not @code{'attempt'} or @code{'atlas'}.

The default word characters in Unicode (str) patterns
are Unicode alphanumerics and the underscore,
but this can be changed by using the @ref{6cd,,ASCII} flag.
Word boundaries are determined by the current locale
if the @ref{bf4,,LOCALE} flag is used.

@cartouche
@quotation Nota 
Inside a character range, @code{\b} represents the backspace character,
for compatibility with Python’s string literals.
@end quotation
@end cartouche
@end table

@geindex \B;en expresiones regulares


@table @asis

@item @code{\B}

Matches the empty string,
but only when it is `not' at the beginning or end of a word.
This means that @code{r'at\B'} matches @code{'athens'}, @code{'atom'},
@code{'attorney'}, but not @code{'at'}, @code{'at.'}, or @code{'at!'}.
@code{\B} is the opposite of @code{\b},
so word characters in Unicode (str) patterns
are Unicode alphanumerics or the underscore,
although this can be changed by using the @ref{6cd,,ASCII} flag.
Word boundaries are determined by the current locale
if the @ref{bf4,,LOCALE} flag is used.

@cartouche
@quotation Nota 
Note that @code{\B} does not match an empty string, which differs from
RE implementations in other programming languages such as Perl.
This behavior is kept for compatibility reasons.
@end quotation
@end cartouche
@end table

@geindex \d;en expresiones regulares


@table @asis

@item @code{\d}


@table @asis

@item Para los patrones de Unicode (str):

Matches any Unicode decimal digit
(that is, any character in Unicode character category [Nd]@footnote{https://www.unicode.org/versions/Unicode15.0.0/ch04.pdf#G134153}).
This includes @code{[0-9]}, and also many other digit characters.

Matches @code{[0-9]} if the @ref{6cd,,ASCII} flag is used.

@item Para patrones de 8 bits (bytes):

Matches any decimal digit in the ASCII character set;
this is equivalent to @code{[0-9]}.
@end table
@end table

@geindex \D;en expresiones regulares


@table @asis

@item @code{\D}

Matches any character which is not a decimal digit.
This is the opposite of @code{\d}.

Matches @code{[^0-9]} if the @ref{6cd,,ASCII} flag is used.
@end table

@geindex \s;en expresiones regulares


@table @asis

@item @code{\s}


@table @asis

@item Para los patrones de Unicode (str):

Matches Unicode whitespace characters (as defined by @ref{21cd,,str.isspace()}).
This includes @code{[ \t\n\r\f\v]}, and also many other characters, for example the
non-breaking spaces mandated by typography rules in many languages.

Matches @code{[ \t\n\r\f\v]} if the @ref{6cd,,ASCII} flag is used.

@item Para patrones de 8 bits (bytes):

Coincide con los caracteres considerados como espacios en blanco en el conjunto de caracteres ASCII, lo que equivale a @code{[ \t\n\r\f\v]}.
@end table
@end table

@geindex \S;en expresiones regulares


@table @asis

@item @code{\S}

Matches any character which is not a whitespace character. This is
the opposite of @code{\s}.

Matches @code{[^ \t\n\r\f\v]} if the @ref{6cd,,ASCII} flag is used.
@end table

@geindex \w;en expresiones regulares


@table @asis

@item @code{\w}


@table @asis

@item Para los patrones de Unicode (str):

Matches Unicode word characters;
this includes all Unicode alphanumeric characters
(as defined by @ref{21c6,,str.isalnum()}),
as well as the underscore (@code{_}).

Matches @code{[a-zA-Z0-9_]} if the @ref{6cd,,ASCII} flag is used.

@item Para patrones de 8 bits (bytes):

Matches characters considered alphanumeric in the ASCII character set;
this is equivalent to @code{[a-zA-Z0-9_]}.
If the @ref{bf4,,LOCALE} flag is used,
matches characters considered alphanumeric in the current locale and the underscore.
@end table
@end table

@geindex \W;en expresiones regulares


@table @asis

@item @code{\W}

Matches any character which is not a word character.
This is the opposite of @code{\w}.
By default, matches non-underscore (@code{_}) characters
for which @ref{21c6,,str.isalnum()} returns @code{False}.

Matches @code{[^a-zA-Z0-9_]} if the @ref{6cd,,ASCII} flag is used.

If the @ref{bf4,,LOCALE} flag is used,
matches characters which are neither alphanumeric in the current locale
nor the underscore.
@end table

@geindex \Z;en expresiones regulares


@table @asis

@item @code{\Z}

Coincide sólo el final de la cadena.
@end table

@geindex \a;en expresiones regulares
@geindex \b;en expresiones regulares
@geindex \f;en expresiones regulares
@geindex \n;en expresiones regulares
@geindex \N;en expresiones regulares
@geindex \r;en expresiones regulares
@geindex \t;en expresiones regulares
@geindex \u;en expresiones regulares
@geindex \U;en expresiones regulares
@geindex \v;en expresiones regulares
@geindex \x;en expresiones regulares
@geindex \\;en expresiones regulares

La mayoría de las @ref{505,,secuencias de escape} soportadas por los literales de cadena de Python también son aceptadas por el analizador de expresiones regulares:

@example
\a      \b      \f      \n
\N      \r      \t      \u
\U      \v      \x      \\
@end example

(Notar que @code{\b} se usa para representar los límites de las palabras, y significa «retroceso» (`backspace') sólo dentro de las clases de caracteres.)

@code{'\u'}, @code{'\U'}, and @code{'\N'} escape sequences are
only recognized in Unicode (str) patterns.
In bytes patterns they are errors.
Unknown escapes of ASCII letters are reserved
for future use and treated as errors.

Los escapes octales se incluyen en una forma limitada.  Si el primer dígito es un 0, o si hay tres dígitos octales, se considera un escape octal. De lo contrario, es una referencia de grupo.  En cuanto a los literales de cadena, los escapes octales siempre tienen como máximo tres dígitos de longitud.


Distinto en la versión 3.3: Se han añadido las secuencias de escape @code{'\u'} y @code{'\U'}.



Distinto en la versión 3.6: Los escapes desconocidos que consisten en @code{'\'} y una letra ASCII ahora son errores.



Distinto en la versión 3.8: Se añadió la secuencia de escape @code{'\N@{@var{name}@}'}. Como en los literales de cadena, se expande al carácter Unicode nombrado (p. ej. @code{'\N@{EM DASH@}'}).


@node Contenidos del módulo,Objetos expresión regular,Sintaxis de expresiones regulares,re — Regular expression operations
@anchor{library/re contents-of-module-re}@anchor{22fa}@anchor{library/re module-contents}@anchor{22fc}
@subsubsection Contenidos del módulo


El módulo define varias funciones, constantes y una excepción. Algunas de las funciones son versiones simplificadas de los métodos completos de las expresiones regulares compiladas.  La mayoría de las aplicaciones no triviales utilizan siempre la forma compilada.

@menu
* Indicadores:: 
* Funciones: Funciones<2>. 
* Excepciones: Excepciones<3>. 

@end menu

@node Indicadores,Funciones<2>,,Contenidos del módulo
@anchor{library/re flags}@anchor{22f2}
@subsubsection Indicadores



Distinto en la versión 3.6: Ahora las constantes de indicadores son instancias de @ref{6ce,,RegexFlag}, que es una subclase de @ref{22fd,,enum.IntFlag}.


@geindex RegexFlag (clase en re)
@anchor{library/re re RegexFlag}@anchor{6ce}
@deffn {Clase} re.RegexFlag

Una clase @ref{22fd,,enum.IntFlag} contiene las opciones regex que se enumeran a continuación.


Added in version 3.11: - added to @code{__all__}

@end deffn

@geindex A (en el módulo re)
@geindex ASCII (en el módulo re)
@anchor{library/re re A}@anchor{22f3}
@deffn {Dato} re.A
@anchor{library/re re ASCII}@anchor{6cd}
@deffnx {Dato} re.ASCII

Make @code{\w}, @code{\W}, @code{\b}, @code{\B}, @code{\d}, @code{\D}, @code{\s} and @code{\S}
perform ASCII-only matching instead of full Unicode matching.  This is only
meaningful for Unicode (str) patterns, and is ignored for bytes patterns.

Corresponds to the inline flag @code{(?a)}.

@cartouche
@quotation Nota 
The @ref{22f8,,U} flag still exists for backward compatibility,
but is redundant in Python 3 since
matches are Unicode by default for @code{str} patterns,
and Unicode matching isn’t allowed for bytes patterns.
@ref{bf5,,UNICODE} and the inline flag @code{(?u)} are similarly redundant.
@end quotation
@end cartouche
@end deffn

@geindex DEBUG (en el módulo re)
@anchor{library/re re DEBUG}@anchor{22fe}
@deffn {Dato} re.DEBUG

Display debug information about compiled expression.

No corresponding inline flag.
@end deffn

@geindex I (en el módulo re)
@geindex IGNORECASE (en el módulo re)
@anchor{library/re re I}@anchor{22f4}
@deffn {Dato} re.I
@anchor{library/re re IGNORECASE}@anchor{172c}
@deffnx {Dato} re.IGNORECASE

Perform case-insensitive matching;
expressions like @code{[A-Z]} will also  match lowercase letters.
Full Unicode matching (such as @code{Ü} matching @code{ü})
also works unless the @ref{6cd,,ASCII} flag
is used to disable non-ASCII matches.
The current locale does not change the effect of this flag
unless the @ref{bf4,,LOCALE} flag is also used.

Corresponds to the inline flag @code{(?i)}.

Note that when the Unicode patterns @code{[a-z]} or @code{[A-Z]} are used in
combination with the @ref{172c,,IGNORECASE} flag, they will match the 52 ASCII
letters and 4 additional non-ASCII letters: “İ” (U+0130, Latin capital
letter I with dot above), “ı” (U+0131, Latin small letter dotless i),
“ſ” (U+017F, Latin small letter long s) and “K” (U+212A, Kelvin sign).
If the @ref{6cd,,ASCII} flag is used, only letters “a” to “z”
and “A” to “Z” are matched.
@end deffn

@geindex L (en el módulo re)
@geindex LOCALE (en el módulo re)
@anchor{library/re re L}@anchor{22f5}
@deffn {Dato} re.L
@anchor{library/re re LOCALE}@anchor{bf4}
@deffnx {Dato} re.LOCALE

Make @code{\w}, @code{\W}, @code{\b}, @code{\B} and case-insensitive matching
dependent on the current locale.
This flag can be used only with bytes patterns.

Corresponds to the inline flag @code{(?L)}.

@cartouche
@quotation Advertencia 
This flag is discouraged; consider Unicode matching instead.
The locale mechanism is very unreliable
as it only handles one «culture» at a time
and only works with 8-bit locales.
Unicode matching is enabled by default for Unicode (str) patterns
and it is able to handle different locales and languages.
@end quotation
@end cartouche


Distinto en la versión 3.6: @ref{bf4,,LOCALE} can be used only with bytes patterns
and is not compatible with @ref{6cd,,ASCII}.



Distinto en la versión 3.7: Compiled regular expression objects with the @ref{bf4,,LOCALE} flag
no longer depend on the locale at compile time.
Only the locale at matching time affects the result of matching.

@end deffn

@geindex M (en el módulo re)
@geindex MULTILINE (en el módulo re)
@anchor{library/re re M}@anchor{22f6}
@deffn {Dato} re.M
@anchor{library/re re MULTILINE}@anchor{22f1}
@deffnx {Dato} re.MULTILINE

When specified, the pattern character @code{'^'} matches at the beginning of the
string and at the beginning of each line (immediately following each newline);
and the pattern character @code{'$'} matches at the end of the string and at the
end of each line (immediately preceding each newline).  By default, @code{'^'}
matches only at the beginning of the string, and @code{'$'} only at the end of the
string and immediately before the newline (if any) at the end of the string.

Corresponds to the inline flag @code{(?m)}.
@end deffn

@geindex NOFLAG (en el módulo re)
@anchor{library/re re NOFLAG}@anchor{22ff}
@deffn {Dato} re.NOFLAG

Indica que no se aplica ninguna bandera, el valor es @code{0}. Esta bandera puede ser utilizada como valor predeterminado para un argumento de palabra clave de función o como un valor que será condicionalmente combinado con otras banderas usando el operador binario OR. Ejemplo de uso como valor predeterminado:

@example
def myfunc(text, flag=re.NOFLAG):
    return re.match(text, flag)
@end example


Added in version 3.11.

@end deffn

@geindex S (en el módulo re)
@geindex DOTALL (en el módulo re)
@anchor{library/re re S}@anchor{22f7}
@deffn {Dato} re.S
@anchor{library/re re DOTALL}@anchor{22f0}
@deffnx {Dato} re.DOTALL

Make the @code{'.'} special character match any character at all, including a
newline; without this flag, @code{'.'} will match anything `except' a newline.

Corresponds to the inline flag @code{(?s)}.
@end deffn

@geindex U (en el módulo re)
@geindex UNICODE (en el módulo re)
@anchor{library/re re U}@anchor{22f8}
@deffn {Dato} re.U
@anchor{library/re re UNICODE}@anchor{bf5}
@deffnx {Dato} re.UNICODE

In Python 3, Unicode characters are matched by default
for @code{str} patterns.
This flag is therefore redundant with `no effect'
and is only kept for backward compatibility.

See @ref{6cd,,ASCII} to restrict matching to ASCII characters instead.
@end deffn

@geindex X (en el módulo re)
@geindex VERBOSE (en el módulo re)
@anchor{library/re re X}@anchor{22f9}
@deffn {Dato} re.X
@anchor{library/re re VERBOSE}@anchor{2300}
@deffnx {Dato} re.VERBOSE

@geindex # (hash);en expresiones regulares

Esta bandera permite escribir expresiones regulares que se ven mejor y son más legibles, facilitando la separación visual de las secciones lógicas del patrón y la adición de comentarios. Los espacios en blanco dentro del patrón se ignoran, excepto cuando están en una clase de caracteres, o cuando están precedidos por una barra inversa sin escapar, o dentro de tokens como @code{*?}, @code{(?:} o @code{(?P<...>}. Por ejemplo, @code{(? :} y @code{* ?} no están permitidos. Cuando una línea contiene un @code{#} que no está en una clase de caracteres y no está precedida por una barra inversa sin escapar, todos los caracteres desde el @code{#} más a la izquierda hasta el final de la línea son ignorados.

Esto significa que los dos siguientes objetos expresión regular que coinciden con un número decimal son funcionalmente iguales:

@example
a = re.compile(r"""\d +  # the integral part
                   \.    # the decimal point
                   \d *  # some fractional digits""", re.X)
b = re.compile(r"\d+\.\d*")
@end example

Corresponde al indicador en línea @code{(?x)}.
@end deffn

@node Funciones<2>,Excepciones<3>,Indicadores,Contenidos del módulo
@anchor{library/re functions}@anchor{2301}
@subsubsection Funciones


@geindex compile() (en el módulo re)
@anchor{library/re re compile}@anchor{c5b}
@deffn {Función} re.compile (pattern, flags=0)

Compila un patrón de expresión regular en un @ref{1005,,objeto de expresión regular}, que puede ser usado para las coincidencias usando @ref{2302,,match()}, @ref{2303,,search()} y otros métodos, descritos más adelante.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).

La secuencia

@example
prog = re.compile(pattern)
result = prog.match(string)
@end example

es equivalente a

@example
result = re.match(pattern, string)
@end example

pero usando @ref{c5b,,re.compile()} y guardando el objeto resultante de la expresión regular para su reutilización es más eficiente cuando la expresión será usada varias veces en un solo programa.

@cartouche
@quotation Nota 
Las versiones compiladas de los patrones más recientes pasaron a @ref{c5b,,re.compile()} y las funciones de coincidencia a nivel de módulo están en caché, así que los programas que usan sólo unas pocas expresiones regulares a la vez no tienen que preocuparse de compilar expresiones regulares.
@end quotation
@end cartouche
@end deffn

@geindex search() (en el módulo re)
@anchor{library/re re search}@anchor{1299}
@deffn {Función} re.search (pattern, string, flags=0)

Explora la cadena de caracteres `string' en busca de la primera ubicación donde el patrón `pattern' de la expresión regular produce una coincidencia, y retorna un @ref{d4f,,Match} correspondiente. Retorna @code{None} si ninguna posición en la cadena coincide con el patrón; nota que esto es diferente a encontrar una coincidencia de longitud cero en algún punto de la cadena.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).
@end deffn

@geindex match() (en el módulo re)
@anchor{library/re re match}@anchor{129a}
@deffn {Función} re.match (pattern, string, flags=0)

Si cero o más caracteres al principio de la cadena `string' coinciden con el patrón `pattern' de la expresión regular, retorna un @ref{d4f,,Match} correspondiente. Retorna @code{None} si la cadena no coincide con el patrón; notar que esto es diferente de una coincidencia de longitud cero.

Notar que incluso en el modo @ref{22f1,,MULTILINE}, @ref{129a,,re.match()} sólo coincidirá al principio de la cadena y no al principio de cada línea.

Si se quiere localizar una coincidencia en cualquier lugar de la `string' («cadena»), se utiliza @ref{1299,,search()} en su lugar (ver también @ref{2304,,search() vs. match()}).

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).
@end deffn

@geindex fullmatch() (en el módulo re)
@anchor{library/re re fullmatch}@anchor{1004}
@deffn {Función} re.fullmatch (pattern, string, flags=0)

Si toda la cadena `string' coincide con el patrón `pattern' de la expresión regular, retorna un @ref{d4f,,Match} correspondiente. Retorna @code{None} si la cadena no coincide con el patrón; notar que esto es diferente de una coincidencia de longitud cero.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).


Added in version 3.4.

@end deffn

@geindex split() (en el módulo re)
@anchor{library/re re split}@anchor{3f1}
@deffn {Función} re.split (pattern, string, maxsplit=0, flags=0)

Divide la `string' («cadena») por el número de ocurrencias del `pattern' («patrón»).  Si se utilizan paréntesis de captura en `pattern', entonces el texto de todos los grupos en el patrón también se retornan como parte de la lista resultante. Si `maxsplit' (máxima divisibilidad) es distinta de cero, como mucho se producen `maxsplit' divisiones, y el resto de la cadena se retorna como elemento final de la lista.

@example
>>> re.split(r'\W+', 'Words, words, words.')
['Words', 'words', 'words', '@w{'}]
>>> re.split(r'(\W+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '@w{'}]
>>> re.split(r'\W+', 'Words, words, words.', maxsplit=1)
['Words', 'words, words.']
>>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
['0', '3', '9']
@end example

Si hay grupos de captura en el separador y coincide al principio de la cadena, el resultado comenzará con una cadena vacía.  Lo mismo ocurre con el final de la cadena:

@example
>>> re.split(r'(\W+)', '...words, words...')
['@w{'}, '...', 'words', ', ', 'words', '...', '@w{'}]
@end example

De esa manera, los componentes de los separadores se encuentran siempre en los mismos índices relativos dentro de la lista de resultados.

Las coincidencias vacías para el patrón dividen la cadena sólo cuando no están adyacentes a una coincidencia vacía anterior.

@example
>>> re.split(r'\b', 'Words, words, words.')
['@w{'}, 'Words', ', ', 'words', ', ', 'words', '.']
>>> re.split(r'\W*', '...words...')
['@w{'}, '@w{'}, 'w', 'o', 'r', 'd', 's', '@w{'}, '@w{'}]
>>> re.split(r'(\W*)', '...words...')
['@w{'}, '...', '@w{'}, '@w{'}, 'w', '@w{'}, 'o', '@w{'}, 'r', '@w{'}, 'd', '@w{'}, 's', '...', '@w{'}, '@w{'}, '@w{'}]
@end example

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).


Distinto en la versión 3.1: Se añadió el argumento de los indicadores opcionales.



Distinto en la versión 3.7: Se añadió el soporte de la división en un patrón que podría coincidir con una cadena vacía.



Obsoleto desde la versión 3.13: Passing `maxsplit' and `flags' as positional arguments is deprecated.
In future Python versions they will be
@ref{3f4,,keyword-only parameters}.

@end deffn

@geindex findall() (en el módulo re)
@anchor{library/re re findall}@anchor{10a6}
@deffn {Función} re.findall (pattern, string, flags=0)

Retorna todas las coincidencias no superpuestas de `pattern' en `string', como una lista de strings o tuplas. El `string' se escanea de izquierda a derecha y las coincidencias se retornan en el orden en que se encuentran. Las coincidencias vacías se incluyen en el resultado.

El resultado depende del número de grupos detectados en el patrón. Si no hay grupos, retorna una lista de strings que coincidan con el patrón completo. Si existe exactamente un grupo, retorna una lista de strings que coincidan con ese grupo. Si hay varios grupos presentes, retorna una lista de tuplas de strings que coinciden con los grupos. Los grupos que no son detectados no afectan la forma del resultado.

@example
>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
['foot', 'fell', 'fastest']
>>> re.findall(r'(\w+)=(\d+)', 'set width=20 and height=10')
[('width', '20'), ('height', '10')]
@end example

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).


Distinto en la versión 3.7: Las coincidencias no vacías ahora pueden empezar justo después de una coincidencia vacía anterior.

@end deffn

@geindex finditer() (en el módulo re)
@anchor{library/re re finditer}@anchor{153a}
@deffn {Función} re.finditer (pattern, string, flags=0)

Retorna un @ref{313,,iterador} que produce objetos @ref{d4f,,Match} sobre todas las coincidencias no superpuestas para el patrón de RE `pattern' en la `string'. La `string' es examinada de izquierda a derecha, y las coincidencias son retornadas en el orden en que se encuentran. Las coincidencias vacías se incluyen en el resultado.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).


Distinto en la versión 3.7: Las coincidencias no vacías ahora pueden empezar justo después de una coincidencia vacía anterior.

@end deffn

@geindex sub() (en el módulo re)
@anchor{library/re re sub}@anchor{3f2}
@deffn {Función} re.sub (pattern, repl, string, count=0, flags=0)

Retorna la cadena obtenida reemplazando las ocurrencias no superpuestas del `pattern' («patrón») en la `string' («cadena») por el reemplazo de `repl'.  Si el patrón no se encuentra, se retorna `string' sin cambios.  `repl' puede ser una cadena o una función; si es una cadena, cualquier barra inversa escapada en ella es procesada.  Es decir, @code{\n} se convierte en un carácter de una sola línea nueva, @code{\r} se convierte en un retorno de carro, y así sucesivamente.  Los escapes desconocidos de las letras ASCII se reservan para un uso futuro y se tratan como errores.  Otros escapes desconocidos como @code{\&} no se utilizan. Las referencias inversas, como @code{\6}, se reemplazan por la subcadena que corresponde al grupo 6 del patrón. Por ejemplo:

@example
>>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):',
...        r'static PyObject*\npy_\1(void)\n@{',
...        'def myfunc():')
'static PyObject*\npy_myfunc(void)\n@{'
@end example

Si `repl' es una función, se llama para cada ocurrencia no superpuesta de `pattern'.  La función toma un solo argumento @ref{d4f,,Match}, y retorna la cadena de sustitución.  Por ejemplo:

@example
>>> def dashrepl(matchobj):
...     if matchobj.group(0) == '-': return ' '
...     else: return '-'
...
>>> re.sub('-@{1,2@}', dashrepl, 'pro----gram-files')
'pro--gram files'
>>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE)
'Baked Beans & Spam'
@end example

El patrón puede ser una cadena o un @ref{17e4,,Pattern}.

El argumento opcional `count' («recuento») es el número máximo de ocurrencias de patrones a ser reemplazados; `count' debe ser un número entero no negativo.  Si se omite o es cero, todas las ocurrencias serán reemplazadas. Las coincidencias vacías del patrón se reemplazan sólo cuando no están adyacentes a una coincidencia vacía anterior, así que @code{sub('x*', '-', 'abxd')} retorna @code{'-a-b--d-'}.

@geindex \g;en expresiones regulares

En los argumentos `repl' de tipo cadena, además de los escapes de caracteres y las referencias inversas descritas anteriormente, @code{\g<name>} usará la subcadena coincidente con el grupo llamado @code{name}, como se define en la sintaxis @code{(?P<name>...)}. @code{\g<number>} utiliza el número de grupo correspondiente; @code{\g<2>} es por lo tanto equivalente a @code{\2}, pero no es ambiguo en un reemplazo como sucede con @code{\g<2>0}.  @code{\20} se interpretaría como una referencia al grupo 20, no como una referencia al grupo 2 seguido del carácter literal @code{'0'}.  La referencia inversa @code{\g<0>} sustituye en toda la subcadena coincidente con la RE.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).


Distinto en la versión 3.1: Se añadió el argumento de los indicadores opcionales.



Distinto en la versión 3.5: Los grupos no coincidentes son reemplazados por una cadena vacía.



Distinto en la versión 3.6: Los escapes desconocidos en el `pattern' que consisten en @code{'\'} y una letra ASCII ahora son errores.



Distinto en la versión 3.7: Unknown escapes in `repl' consisting of @code{'\'} and an ASCII letter
now are errors.
Empty matches for the pattern are replaced when adjacent to a previous
non-empty match.



Distinto en la versión 3.12: El `id' del grupo solo puede contener dígitos ASCII. En las cadenas de reemplazo @ref{325,,bytes}, el nombre del grupo `name' solo puede contener bytes en el rango ASCII (@code{b'\x00'}-@code{b'\x7f'}).



Obsoleto desde la versión 3.13: Passing `count' and `flags' as positional arguments is deprecated.
In future Python versions they will be
@ref{3f4,,keyword-only parameters}.

@end deffn

@geindex subn() (en el módulo re)
@anchor{library/re re subn}@anchor{3f3}
@deffn {Función} re.subn (pattern, repl, string, count=0, flags=0)

Realiza la misma operación que @ref{3f2,,sub()}, pero retorna una tupla @code{(new_string, number_of_subs_made)}.

The expression’s behaviour can be modified by specifying a `flags' value.
Values can be any of the @ref{22f2,,flags} variables, combined using bitwise OR
(the @code{|} operator).
@end deffn

@geindex escape() (en el módulo re)
@anchor{library/re re escape}@anchor{c91}
@deffn {Función} re.escape (pattern)

Caracteres de escape especiales en `pattern' (» patrón»). Esto es útil si quieres hacer coincidir una cadena literal arbitraria que puede tener metacaracteres de expresión regular en ella.  Por ejemplo:

@example
>>> print(re.escape('https://www.python.org'))
https://www\.python\.org

>>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:"
>>> print('[%s]+' % re.escape(legal_chars))
[abcdefghijklmnopqrstuvwxyz0123456789!\#\$%\&'\*\+\-\.\^_`\|\~:]+

>>> operators = ['+', '-', '*', '/', '**']
>>> print('|'.join(map(re.escape, sorted(operators, reverse=True))))
/|\-|\+|\*\*|\*
@end example

Esta función no debe usarse para la cadena de reemplazo en @ref{3f2,,sub()} y @ref{3f3,,subn()}, sólo deben escaparse las barras inversas.  Por ejemplo:

@example
>>> digits_re = r'\d+'
>>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings'
>>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample))
/usr/sbin/sendmail - \d+ errors, \d+ warnings
@end example


Distinto en la versión 3.3: El carácter de @code{'_'} ya no se escapa.



Distinto en la versión 3.7: Sólo se escapan los caracteres que pueden tener un significado especial en una expresión regular. Como resultado, @code{'!'}, @code{'"'}, @code{'%'}, @code{"'"}, @code{','}, @code{'/'}, @code{':'}, @code{';'}, @code{'<'}, @code{'='}, @code{'>'}, @code{'@@'} y @code{"`"} ya no se escapan.

@end deffn

@geindex purge() (en el módulo re)
@anchor{library/re re purge}@anchor{2305}
@deffn {Función} re.purge ()

Despeja la caché de expresión regular.
@end deffn

@node Excepciones<3>,,Funciones<2>,Contenidos del módulo
@anchor{library/re exceptions}@anchor{2306}
@subsubsection Excepciones


@geindex PatternError
@anchor{library/re re PatternError}@anchor{397}
@deffn {Excepción} re.PatternError (msg, pattern=None, pos=None)

Exception raised when a string passed to one of the functions here is not a
valid regular expression (for example, it might contain unmatched parentheses)
or when some other error occurs during compilation or matching.  It is never an
error if a string contains no match for a pattern.  The @code{PatternError} instance has
the following additional attributes:

@geindex msg (atributo de re.PatternError)
@anchor{library/re re PatternError msg}@anchor{2307}
@deffn {Atributo} msg

El mensaje de error sin formato.
@end deffn

@geindex pattern (atributo de re.PatternError)
@anchor{library/re re PatternError pattern}@anchor{2308}
@deffn {Atributo} pattern

El patrón de expresión regular.
@end deffn

@geindex pos (atributo de re.PatternError)
@anchor{library/re re PatternError pos}@anchor{2309}
@deffn {Atributo} pos

El índice en `pattern' («patrón») donde la compilación falló (puede ser @code{None}).
@end deffn

@geindex lineno (atributo de re.PatternError)
@anchor{library/re re PatternError lineno}@anchor{230a}
@deffn {Atributo} lineno

La línea correspondiente a `pos' (puede ser @code{None}).
@end deffn

@geindex colno (atributo de re.PatternError)
@anchor{library/re re PatternError colno}@anchor{230b}
@deffn {Atributo} colno

La columna correspondiente a `pos' (puede ser @code{None}).
@end deffn


Distinto en la versión 3.5: Se añadieron atributos adicionales.



Distinto en la versión 3.13: @code{PatternError} was originally named @code{error}; the latter is kept as an alias for
backward compatibility.

@end deffn

@node Objetos expresión regular,Objetos de coincidencia,Contenidos del módulo,re — Regular expression operations
@anchor{library/re re-objects}@anchor{1005}@anchor{library/re regular-expression-objects}@anchor{230c}
@subsubsection Objetos expresión regular


@geindex Pattern (clase en re)
@anchor{library/re re Pattern}@anchor{17e4}
@deffn {Clase} re.Pattern

Objeto de expresión regular compilada devuelto por @ref{c5b,,re.compile()}.


Distinto en la versión 3.9: @ref{17e4,,re.Pattern} soporta @code{[]} para indicar un patrón Unicode (str) o de bytes. Ver @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex search() (método de re.Pattern)
@anchor{library/re re Pattern search}@anchor{2303}
@deffn {Método} Pattern.search (string[, pos[, endpos]])

Escanea a través de la cadena `string' buscando la primera ubicación donde esta expresión regular produce una coincidencia, y retorna un @ref{d4f,,Match} correspondiente.  Retorna @code{None} si ninguna posición en la cadena coincide con el patrón; notar que esto es diferente a encontrar una coincidencia de longitud cero en algún punto de la cadena.

El segundo parámetro opcional `pos' proporciona un índice en la cadena donde la búsqueda debe comenzar; por defecto es @code{0}.  Esto no es completamente equivalente a dividir la cadena; el patrón de carácter @code{'^'} coincide en el inicio real de la cadena y en las posiciones justo después de una nueva línea, pero no necesariamente en el índice donde la búsqueda va a comenzar.

El parámetro opcional `endpos' limita hasta dónde se buscará la cadena; será como si la cadena fuera de `endpos' caracteres de largo, por lo que sólo se buscará una coincidencia entre los caracteres de `pos' a @code{endpos - 1}.  Si `endpos' es menor que `pos', no se encontrará ninguna coincidencia; de lo contrario, si `rx' es un objeto de expresión regular compilado, @code{rx.search(string, 0, 50)} es equivalente a @code{rx.search(string[:50], 0)}.

@example
>>> pattern = re.compile("d")
>>> pattern.search("dog")     # Match at index 0
<re.Match object; span=(0, 1), match='d'>
>>> pattern.search("dog", 1)  # No match; search doesn't include the "d"
@end example
@end deffn

@geindex match() (método de re.Pattern)
@anchor{library/re re Pattern match}@anchor{2302}
@deffn {Método} Pattern.match (string[, pos[, endpos]])

Si cero o más caracteres en el comienzo `beginning' de la cadena `string' coinciden con esta expresión regular, retorna un @ref{d4f,,Match} correspondiente. Retorna @code{None} si la cadena no coincide con el patrón; notar que esto es diferente de una coincidencia de longitud cero.

Los parámetros opcionales `pos' y `endpos' tienen el mismo significado que para el método @ref{2303,,search()}.

@example
>>> pattern = re.compile("o")
>>> pattern.match("dog")      # No match as "o" is not at the start of "dog".
>>> pattern.match("dog", 1)   # Match as "o" is the 2nd character of "dog".
<re.Match object; span=(1, 2), match='o'>
@end example

Si se quiere encontrar una coincidencia en cualquier lugar de `string', utilizar @ref{2303,,search()} en su lugar (ver también @ref{2304,,search() vs. match()}).
@end deffn

@geindex fullmatch() (método de re.Pattern)
@anchor{library/re re Pattern fullmatch}@anchor{180a}
@deffn {Método} Pattern.fullmatch (string[, pos[, endpos]])

Si toda la cadena `string' coincide con esta expresión regular, retorna un @ref{d4f,,Match} correspondiente.  Retorna @code{None} si la cadena no coincide con el patrón; notar que esto es diferente de una coincidencia de longitud cero.

Los parámetros opcionales `pos' y `endpos' tienen el mismo significado que para el método @ref{2303,,search()}.

@example
>>> pattern = re.compile("o[gh]")
>>> pattern.fullmatch("dog")      # No match as "o" is not at the start of "dog".
>>> pattern.fullmatch("ogre")     # No match as not the full string matches.
>>> pattern.fullmatch("doggie", 1, 3)   # Matches within given limits.
<re.Match object; span=(1, 3), match='og'>
@end example


Added in version 3.4.

@end deffn

@geindex split() (método de re.Pattern)
@anchor{library/re re Pattern split}@anchor{230d}
@deffn {Método} Pattern.split (string, maxsplit=0)

Idéntico a la función @ref{3f1,,split()}, usando el patrón compilado.
@end deffn

@geindex findall() (método de re.Pattern)
@anchor{library/re re Pattern findall}@anchor{230e}
@deffn {Método} Pattern.findall (string[, pos[, endpos]])

Similar a la función @ref{10a6,,findall()}, usando el patrón compilado, pero también acepta parámetros opcionales `pos' y `endpos' que limitan la región de búsqueda como para @ref{1299,,search()}.
@end deffn

@geindex finditer() (método de re.Pattern)
@anchor{library/re re Pattern finditer}@anchor{230f}
@deffn {Método} Pattern.finditer (string[, pos[, endpos]])

Similar a la función @ref{153a,,finditer()}, usando el patrón compilado, pero también acepta parámetros opcionales `pos' y `endpos' que limitan la región de búsqueda como para @ref{1299,,search()}.
@end deffn

@geindex sub() (método de re.Pattern)
@anchor{library/re re Pattern sub}@anchor{2310}
@deffn {Método} Pattern.sub (repl, string, count=0)

Idéntico a la función @ref{3f2,,sub()}, usando el patrón compilado.
@end deffn

@geindex subn() (método de re.Pattern)
@anchor{library/re re Pattern subn}@anchor{2311}
@deffn {Método} Pattern.subn (repl, string, count=0)

Idéntico a la función @ref{3f3,,subn()}, usando el patrón compilado.
@end deffn

@geindex flags (atributo de re.Pattern)
@anchor{library/re re Pattern flags}@anchor{2312}
@deffn {Atributo} Pattern.flags

The regex matching flags.  This is a combination of the flags given to
@ref{c5b,,compile()}, any @code{(?...)} inline flags in the pattern, and implicit
flags such as @ref{bf5,,UNICODE} if the pattern is a Unicode string.
@end deffn

@geindex groups (atributo de re.Pattern)
@anchor{library/re re Pattern groups}@anchor{2313}
@deffn {Atributo} Pattern.groups

El número de grupos de captura en el patrón.
@end deffn

@geindex groupindex (atributo de re.Pattern)
@anchor{library/re re Pattern groupindex}@anchor{2314}
@deffn {Atributo} Pattern.groupindex

Un diccionario que mapea cualquier nombre de grupo simbólico definido por @code{(?P<id>)} para agrupar números.  El diccionario está vacío si no se utilizaron grupos simbólicos en el patrón.
@end deffn

@geindex pattern (atributo de re.Pattern)
@anchor{library/re re Pattern pattern}@anchor{2315}
@deffn {Atributo} Pattern.pattern

La cadena de patrones a partir de la cual el objeto de patrón fue compilado.
@end deffn


Distinto en la versión 3.7: Se añadió el soporte de @ref{5d7,,copy.copy()} y @ref{bf6,,copy.deepcopy()}.  Los objetos expresión regular compilados se consideran atómicos.


@node Objetos de coincidencia,Ejemplos de expresiones regulares,Objetos expresión regular,re — Regular expression operations
@anchor{library/re id3}@anchor{2316}@anchor{library/re match-objects}@anchor{1006}
@subsubsection Objetos de coincidencia


Los objetos de coincidencia siempre tienen un valor booleano de @code{True} («Verdadero»). Ya que @ref{2302,,match()} y @ref{2303,,search()} retornan @code{None} cuando no hay coincidencia. Se puede probar si hubo una coincidencia con una simple declaración @code{if}:

@example
match = re.search(pattern, string)
if match:
    process(match)
@end example

@geindex Match (clase en re)
@anchor{library/re re Match}@anchor{d4f}
@deffn {Clase} re.Match

Objeto Match devuelto por llamadas exitosas a @code{match} y @code{search}.


Distinto en la versión 3.9: @ref{d4f,,re.Match} soporta @code{[]} para indicar una coincidencia Unicode (str) o de bytes. Ver @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex expand() (método de re.Match)
@anchor{library/re re Match expand}@anchor{2317}
@deffn {Método} Match.expand (template)

Return the string obtained by doing backslash substitution on the template
string `template', as done by the @ref{2310,,sub()} method.
Escapes such as @code{\n} are converted to the appropriate characters,
and numeric backreferences (@code{\1}, @code{\2}) and named backreferences
(@code{\g<1>}, @code{\g<name>}) are replaced by the contents of the
corresponding group. The backreference @code{\g<0>} will be
replaced by the entire match.


Distinto en la versión 3.5: Los grupos no coincidentes son reemplazados por una cadena vacía.

@end deffn

@geindex group() (método de re.Match)
@anchor{library/re re Match group}@anchor{2318}
@deffn {Método} Match.group ([group1, ...])

Retorna uno o más subgrupos de la coincidencia.  Si hay un solo argumento, el resultado es una sola cadena; si hay múltiples argumentos, el resultado es una tupla con un elemento por argumento. Sin argumentos, `group1' tiene un valor por defecto de cero (se retorna la coincidencia completa). Si un argumento `groupN' es cero, el valor de retorno correspondiente es toda la cadena coincidente; si está en el rango inclusivo [1..99], es la cadena coincidente con el grupo correspondiente entre paréntesis.  Si un número de grupo es negativo o mayor que el número de grupos definidos en el patrón, se produce una excepción @ref{1575,,IndexError}. Si un grupo está contenido en una parte del patrón que no coincidió, el resultado correspondiente es @code{None}. Si un grupo está contenido en una parte del patrón que coincidió varias veces, se retorna la última coincidencia.

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m.group(0)       # The entire match
'Isaac Newton'
>>> m.group(1)       # The first parenthesized subgroup.
'Isaac'
>>> m.group(2)       # The second parenthesized subgroup.
'Newton'
>>> m.group(1, 2)    # Multiple arguments give us a tuple.
('Isaac', 'Newton')
@end example

Si la expresión regular usa la sintaxis @code{(?P<name>...)}, los argumentos `groupN' también pueden ser cadenas que identifican a los grupos por su nombre de grupo.  Si un argumento de cadena no se usa como nombre de grupo en el patrón, se produce una excepción @ref{1575,,IndexError}.

Un ejemplo moderadamente complicado:

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.group('first_name')
'Malcolm'
>>> m.group('last_name')
'Reynolds'
@end example

Los grupos nombrados también pueden ser referidos por su índice:

@example
>>> m.group(1)
'Malcolm'
>>> m.group(2)
'Reynolds'
@end example

Si un grupo coincide varias veces, sólo se puede acceder a la última coincidencia:

@example
>>> m = re.match(r"(..)+", "a1b2c3")  # Matches 3 times.
>>> m.group(1)                        # Returns only the last match.
'c3'
@end example
@end deffn

@geindex __getitem__() (método de re.Match)
@anchor{library/re re Match __getitem__}@anchor{2319}
@deffn {Método} Match.__getitem__ (g)

Esto es idéntico a @code{m.group(g)}.  Esto permite un acceso más fácil a un grupo individual de una coincidencia:

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m[0]       # The entire match
'Isaac Newton'
>>> m[1]       # The first parenthesized subgroup.
'Isaac'
>>> m[2]       # The second parenthesized subgroup.
'Newton'
@end example

Los grupos con nombre también son compatibles:

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Isaac Newton")
>>> m['first_name']
'Isaac'
>>> m['last_name']
'Newton'
@end example


Added in version 3.6.

@end deffn

@geindex groups() (método de re.Match)
@anchor{library/re re Match groups}@anchor{231a}
@deffn {Método} Match.groups (default=None)

Retorna una tupla que contenga todos los subgrupos de la coincidencia, desde 1 hasta tantos grupos como haya en el patrón.  El argumento `default' («por defecto») se utiliza para los grupos que no participaron en la coincidencia; por defecto es @code{None}.

Por ejemplo:

@example
>>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
>>> m.groups()
('24', '1632')
@end example

Si hacemos que el decimal y todo lo que sigue sea opcional, no todos los grupos podrían participar en la coincidencia.  Estos grupos serán por defecto @code{None} a menos que se utilice el argumento `default':

@example
>>> m = re.match(r"(\d+)\.?(\d+)?", "24")
>>> m.groups()      # Second group defaults to None.
('24', None)
>>> m.groups('0')   # Now, the second group defaults to '0'.
('24', '0')
@end example
@end deffn

@geindex groupdict() (método de re.Match)
@anchor{library/re re Match groupdict}@anchor{231b}
@deffn {Método} Match.groupdict (default=None)

Retorna un diccionario que contiene todos los subgrupos `nombrados' de la coincidencia, tecleado por el nombre del subgrupo.  El argumento `por defecto' se usa para los grupos que no participaron en la coincidencia; por defecto es @code{None}.  Por ejemplo:

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.groupdict()
@{'first_name': 'Malcolm', 'last_name': 'Reynolds'@}
@end example
@end deffn

@geindex start() (método de re.Match)
@geindex end() (método de re.Match)
@anchor{library/re re Match start}@anchor{231c}
@deffn {Método} Match.start ([group])
@anchor{library/re re Match end}@anchor{231d}
@deffnx {Método} Match.end ([group])

Retorna los índices del comienzo y el final de la subcadena coincidiendo con el `group'; el `group' por defecto es cero (es decir, toda la subcadena coincidente). Retorna @code{-1} si `grupo' existe pero no ha contribuido a la coincidencia.  Para un objeto coincidente `m', y un grupo `g' que sí contribuyó a la coincidencia, la subcadena coincidente con el grupo `g' (equivalente a @code{m.group(g)}) es

@example
m.string[m.start(g):m.end(g)]
@end example

Notar que @code{m.start(group)} será igual a @code{m.end(group)} si `group' coincidió con una cadena nula.  Por ejemplo, después de @code{m = re.search('b(c?)', 'cba')}, @code{m.start(0)} es 1, @code{m.end(0)} es 2, @code{m.start(1)} y @code{m.end(1)} son ambos 2, y @code{m.start(2)} produce una excepción @ref{1575,,IndexError}.

Un ejemplo que eliminará `remove_this' («quita esto») de las direcciones de correo electrónico:

@example
>>> email = "tony@@tiremove_thisger.net"
>>> m = re.search("remove_this", email)
>>> email[:m.start()] + email[m.end():]
'tony@@tiger.net'
@end example
@end deffn

@geindex span() (método de re.Match)
@anchor{library/re re Match span}@anchor{231e}
@deffn {Método} Match.span ([group])

Para una coincidencia `m', retorna la tupla-2 @code{(m.inicio(grupo), m.fin(grupo))}. Notar que si `group' no contribuyó a la coincidencia, esto es @code{(-1, -1)}. `group' por se convierte a cero para toda la coincidencia.
@end deffn

@geindex pos (atributo de re.Match)
@anchor{library/re re Match pos}@anchor{231f}
@deffn {Atributo} Match.pos

El valor de `pos' que fue pasado al método @ref{2303,,search()} o @ref{2302,,match()} de un @ref{1005,,objeto regex}.  Este es el índice de la cadena en la que el motor RE comenzó a buscar una coincidencia.
@end deffn

@geindex endpos (atributo de re.Match)
@anchor{library/re re Match endpos}@anchor{2320}
@deffn {Atributo} Match.endpos

El valor de `endpos' que se pasó al método @ref{2303,,search()} o @ref{2302,,match()} de un @ref{1005,,objeto regex}.  Este es el índice de la cadena más allá de la cual el motor RE no irá.
@end deffn

@geindex lastindex (atributo de re.Match)
@anchor{library/re re Match lastindex}@anchor{2321}
@deffn {Atributo} Match.lastindex

El índice entero del último grupo de captura coincidente, o`@w{`}None`@w{`} si no hay ningún grupo coincidente. Por ejemplo, las expresiones @code{(a)b}, @code{((a)(b))} y @code{((ab))} tendrán @code{lastindex == 1} si se aplican a la cadena @code{'ab'}, mientras que la expresión @code{(a)(b)} tendrá @code{lastindex == 2}, si se aplica a la misma cadena.
@end deffn

@geindex lastgroup (atributo de re.Match)
@anchor{library/re re Match lastgroup}@anchor{2322}
@deffn {Atributo} Match.lastgroup

El nombre del último grupo capturador coincidente, o`@w{`}None`@w{`} si el grupo no tenía nombre, o si no había ningún grupo coincidente.
@end deffn

@geindex re (atributo de re.Match)
@anchor{library/re re Match re}@anchor{2323}
@deffn {Atributo} Match.re

El @ref{1005,,objeto de expresión regular} cuyo método @ref{2302,,match()} o @ref{2303,,search()} produce esta instancia de coincidencia.
@end deffn

@geindex string (atributo de re.Match)
@anchor{library/re re Match string}@anchor{2324}
@deffn {Atributo} Match.string

La cadena pasada a @ref{2302,,match()} o @ref{2303,,search()}.
@end deffn


Distinto en la versión 3.7: Se añadió el soporte de @ref{5d7,,copy.copy()} y @ref{bf6,,copy.deepcopy()}.  Los objetos de coincidencia se consideran atómicos.


@node Ejemplos de expresiones regulares,,Objetos de coincidencia,re — Regular expression operations
@anchor{library/re re-examples}@anchor{12cb}@anchor{library/re regular-expression-examples}@anchor{2325}
@subsubsection Ejemplos de expresiones regulares


@menu
* Buscando un par:: 
* Simular scanf(): Simular scanf. 
* search() vs. match(): search vs match. 
* Haciendo una guía telefónica:: 
* Mungear texto:: 
* Encontrar todos los adverbios:: 
* Encontrar todos los adverbios y sus posiciones:: 
* Notación de cadena raw:: 
* Escribir un Tokenizador:: 

@end menu

@node Buscando un par,Simular scanf,,Ejemplos de expresiones regulares
@anchor{library/re checking-for-a-pair}@anchor{2326}
@subsubsection Buscando un par


En este ejemplo, se utilizará la siguiente función de ayuda para mostrar los objetos de coincidencia con un poco más de elegancia:

@example
def displaymatch(match):
    if match is None:
        return None
    return '<Match: %r, groups=%r>' % (match.group(), match.groups())
@end example

Supongamos que se está escribiendo un programa de póquer en el que la mano de un jugador se representa como una cadena de 5 caracteres en la que cada carácter representa una carta, «a» para el as, «k» para el rey, «q» para la reina, «j» para la jota, «t» para el 10, y del « 2» al «9» representando la carta con ese valor.

Para ver si una cadena dada es una mano válida, se podría hacer lo siguiente:

@example
>>> valid = re.compile(r"^[a2-9tjqk]@{5@}$")
>>> displaymatch(valid.match("akt5q"))  # Valid.
"<Match: 'akt5q', groups=()>"
>>> displaymatch(valid.match("akt5e"))  # Invalid.
>>> displaymatch(valid.match("akt"))    # Invalid.
>>> displaymatch(valid.match("727ak"))  # Valid.
"<Match: '727ak', groups=()>"
@end example

Esa última mano, @code{"727ak"}, contenía un par, o dos de las mismas cartas de valor. Para igualar esto con una expresión regular, se podrían usar referencias inversas como tales:

@example
>>> pair = re.compile(r".*(.).*\1")
>>> displaymatch(pair.match("717ak"))     # Pair of 7s.
"<Match: '717', groups=('7',)>"
>>> displaymatch(pair.match("718ak"))     # No pairs.
>>> displaymatch(pair.match("354aa"))     # Pair of aces.
"<Match: '354aa', groups=('a',)>"
@end example

Para averiguar en qué carta consiste el par, se podría utilizar el método @ref{2318,,group()} del objeto de coincidencia de la siguiente manera:

@example
>>> pair = re.compile(r".*(.).*\1")
>>> pair.match("717ak").group(1)
'7'

# Error because re.match() returns None, which doesn't have a group() method:
>>> pair.match("718ak").group(1)
Traceback (most recent call last):
  File "<pyshell#23>", line 1, in <module>
    re.match(r".*(.).*\1", "718ak").group(1)
AttributeError: 'NoneType' object has no attribute 'group'

>>> pair.match("354aa").group(1)
'a'
@end example

@node Simular scanf,search vs match,Buscando un par,Ejemplos de expresiones regulares
@anchor{library/re simulating-scanf}@anchor{2327}
@subsubsection Simular scanf()


@geindex scanf (C function)

Actualmente, Python no tiene un equivalente a @code{scanf()}. Las expresiones regulares son generalmente más poderosas, aunque también más detalladas, que las cadenas de formato de @code{scanf()}. La tabla siguiente ofrece algunas correspondencias más o menos equivalentes entre los tokens de formato de @code{scanf()} y expresiones regulares.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Token @code{scanf()}

@tab

Expresión regular

@item

@code{%c}

@tab

@code{.}

@item

@code{%5c}

@tab

@code{.@{5@}}

@item

@code{%d}

@tab

@code{[-+]?\d+}

@item

@code{%e}, @code{%E}, @code{%f}, @code{%g}

@tab

@code{[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?}

@item

@code{%i}

@tab

@code{[-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)}

@item

@code{%o}

@tab

@code{[-+]?[0-7]+}

@item

@code{%s}

@tab

@code{\S+}

@item

@code{%u}

@tab

@code{\d+}

@item

@code{%x}, @code{%X}

@tab

@code{[-+]?(0[xX])?[\dA-Fa-f]+}

@end multitable


Para extraer el nombre de archivo y los números de una cadena como

@example
/usr/sbin/sendmail - 0 errors, 4 warnings
@end example

utilizaría un formato @code{scanf()} como

@example
%s - %d errors, %d warnings
@end example

La expresión regular equivalente sería

@example
(\S+) - (\d+) errors, (\d+) warnings
@end example

@node search vs match,Haciendo una guía telefónica,Simular scanf,Ejemplos de expresiones regulares
@anchor{library/re id4}@anchor{2328}@anchor{library/re search-vs-match}@anchor{2304}
@subsubsection search() vs. match()


Python ofrece diferentes operaciones primitivas basadas en expresiones regulares:


@itemize +

@item 
@ref{129a,,re.match()} verifica una coincidencia solo al principio de la cadena

@item 
@ref{1299,,re.search()} busca una coincidencia en cualquier parte de la cadena (esto es lo que Perl hace por defecto)

@item 
@ref{1004,,re.fullmatch()} verifica si la cadena completa es una coincidencia
@end itemize

Por ejemplo:

@example
>>> re.match("c", "abcdef")    # No match
>>> re.search("c", "abcdef")   # Match
<re.Match object; span=(2, 3), match='c'>
>>> re.fullmatch("p.*n", "python") # Match
<re.Match object; span=(0, 6), match='python'>
>>> re.fullmatch("r.*n", "python") # No match
@end example

Las expresiones regulares que comienzan con @code{'^'} pueden ser usadas con @ref{1299,,search()} para restringir la coincidencia al principio de la cadena:

@example
>>> re.match("c", "abcdef")    # No match
>>> re.search("^c", "abcdef")  # No match
>>> re.search("^a", "abcdef")  # Match
<re.Match object; span=(0, 1), match='a'>
@end example

Notar, sin embargo, que en el modo @ref{22f1,,MULTILINE} @ref{129a,,match()} sólo coincide al principio de la cadena, mientras que usando @ref{1299,,search()} con una expresión regular que comienza con @code{'^'} coincidirá al principio de cada línea.

@example
>>> re.match("X", "A\nB\nX", re.MULTILINE)  # No match
>>> re.search("^X", "A\nB\nX", re.MULTILINE)  # Match
<re.Match object; span=(4, 5), match='X'>
@end example

@node Haciendo una guía telefónica,Mungear texto,search vs match,Ejemplos de expresiones regulares
@anchor{library/re making-a-phonebook}@anchor{2329}
@subsubsection Haciendo una guía telefónica


@ref{3f1,,split()} divide una cadena en una lista delimitada por el patrón recibido.  El método es muy útil para convertir datos textuales en estructuras de datos que pueden ser fácilmente leídas y modificadas por Python, como se demuestra en el siguiente ejemplo en el que se crea una guía telefónica.

Primero, aquí está la información.  Normalmente puede venir de un archivo, aquí se usa la sintaxis de cadena de triple comilla

@example
>>> text = """Ross McFluff: 834.345.1254 155 Elm Street
...
... Ronald Heathmore: 892.345.3428 436 Finley Avenue
... Frank Burger: 925.541.7625 662 South Dogwood Way
...
...
... Heather Albrecht: 548.326.4584 919 Park Place"""
@end example

Las entradas (`entries') están separadas por una o más líneas nuevas. Ahora se convierte la cadena en una lista en la que cada línea no vacía tiene su propia entrada:

@example
>>> entries = re.split("\n+", text)
>>> entries
['Ross McFluff: 834.345.1254 155 Elm Street',
'Ronald Heathmore: 892.345.3428 436 Finley Avenue',
'Frank Burger: 925.541.7625 662 South Dogwood Way',
'Heather Albrecht: 548.326.4584 919 Park Place']
@end example

Finalmente, se divide cada entrada en una lista con nombre, apellido, número de teléfono y dirección.  Se utiliza el parámetro @code{maxsplit} (división máxima) de @ref{3f1,,split()} porque la dirección tiene espacios dentro del patrón de división:

@example
>>> [re.split(":? ", entry, maxsplit=3) for entry in entries]
[['Ross', 'McFluff', '834.345.1254', '155 Elm Street'],
['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'],
['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'],
['Heather', 'Albrecht', '548.326.4584', '919 Park Place']]
@end example

El patrón @code{:?} coincide con los dos puntos después del apellido, de manera que no aparezca en la lista de resultados.  Con @code{maxsplit} de @code{4}, se podría separar el número de casa del nombre de la calle:

@example
>>> [re.split(":? ", entry, maxsplit=4) for entry in entries]
[['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'],
['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'],
['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'],
['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']]
@end example

@node Mungear texto,Encontrar todos los adverbios,Haciendo una guía telefónica,Ejemplos de expresiones regulares
@anchor{library/re text-munging}@anchor{232a}
@subsubsection Mungear texto


@ref{3f2,,sub()} reemplaza cada ocurrencia de un patrón con una cadena o el resultado de una función.  Este ejemplo demuestra el uso de @ref{3f2,,sub()} con una función para «mungear» (`munge') el texto, o aleatorizar el orden de todos los caracteres en cada palabra de una frase excepto el primer y último carácter:

@example
>>> def repl(m):
...     inner_word = list(m.group(2))
...     random.shuffle(inner_word)
...     return m.group(1) + "".join(inner_word) + m.group(3)
...
>>> text = "Professor Abdolmalek, please report your absences promptly."
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.'
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.'
@end example

@node Encontrar todos los adverbios,Encontrar todos los adverbios y sus posiciones,Mungear texto,Ejemplos de expresiones regulares
@anchor{library/re finding-all-adverbs}@anchor{232b}
@subsubsection Encontrar todos los adverbios


@ref{10a6,,findall()} coincide con `todas' las ocurrencias de un patrón, no sólo con la primera, como lo hace @ref{1299,,search()}.  Por ejemplo, si un escritor quisiera encontrar todos los adverbios en algún texto, podría usar @ref{10a6,,findall()} de la siguiente manera:

@example
>>> text = "He was carefully disguised but captured quickly by police."
>>> re.findall(r"\w+ly\b", text)
['carefully', 'quickly']
@end example

@node Encontrar todos los adverbios y sus posiciones,Notación de cadena raw,Encontrar todos los adverbios,Ejemplos de expresiones regulares
@anchor{library/re finding-all-adverbs-and-their-positions}@anchor{232c}
@subsubsection Encontrar todos los adverbios y sus posiciones


Si se desea obtener más información sobre todas las coincidencias de un patrón en lugar del texto coincidente, @ref{153a,,finditer()} es útil ya que proporciona @ref{d4f,,Match} objetos en lugar de cadenas. Continuando con el ejemplo anterior, si un escritor quisiera encontrar todos los adverbios `y sus posiciones' en algún texto, usaría @ref{153a,,finditer()} de la siguiente manera:

@example
>>> text = "He was carefully disguised but captured quickly by police."
>>> for m in re.finditer(r"\w+ly\b", text):
...     print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0)))
07-16: carefully
40-47: quickly
@end example

@node Notación de cadena raw,Escribir un Tokenizador,Encontrar todos los adverbios y sus posiciones,Ejemplos de expresiones regulares
@anchor{library/re raw-string-notation}@anchor{232d}
@subsubsection Notación de cadena `raw'


La notación de cadena `raw' (@code{r "text"}) permite escribir expresiones regulares razonables.  Sin ella, para «escapar» cada barra inversa (@code{'\'}) en una expresión regular tendría que ser precedida por otra.  Por ejemplo, las dos siguientes líneas de código son funcionalmente idénticas:

@example
>>> re.match(r"\W(.)\1\W", " ff ")
<re.Match object; span=(0, 4), match=' ff '>
>>> re.match("\\W(.)\\1\\W", " ff ")
<re.Match object; span=(0, 4), match=' ff '>
@end example

Cuando uno quiere igualar una barra inversa literal, debe escaparse en la expresión regular.  Con la notación de cadena `raw', esto significa @code{r"\\"}.  Sin la notación de cadena, uno debe usar @code{"\\\\"}, haciendo que las siguientes líneas de código sean funcionalmente idénticas:

@example
>>> re.match(r"\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>
>>> re.match("\\\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>
@end example

@node Escribir un Tokenizador,,Notación de cadena raw,Ejemplos de expresiones regulares
@anchor{library/re writing-a-tokenizer}@anchor{232e}
@subsubsection Escribir un Tokenizador


Un tokenizador o analizador léxico@footnote{https://es.wikipedia.org/wiki/Analizador_léxico} analiza una cadena para categorizar grupos de caracteres.  Este es un primer paso útil para escribir un compilador o intérprete.

Las categorías de texto se especifican con expresiones regulares.  La técnica consiste en combinarlas en una única expresión regular maestra y en hacer un bucle sobre las sucesivas coincidencias:

@example
from typing import NamedTuple
import re

class Token(NamedTuple):
    type: str
    value: str
    line: int
    column: int

def tokenize(code):
    keywords = @{'IF', 'THEN', 'ENDIF', 'FOR', 'NEXT', 'GOSUB', 'RETURN'@}
    token_specification = [
        ('NUMBER',   r'\d+(\.\d*)?'),  # Integer or decimal number
        ('ASSIGN',   r':='),           # Assignment operator
        ('END',      r';'),            # Statement terminator
        ('ID',       r'[A-Za-z]+'),    # Identifiers
        ('OP',       r'[+\-*/]'),      # Arithmetic operators
        ('NEWLINE',  r'\n'),           # Line endings
        ('SKIP',     r'[ \t]+'),       # Skip over spaces and tabs
        ('MISMATCH', r'.'),            # Any other character
    ]
    tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification)
    line_num = 1
    line_start = 0
    for mo in re.finditer(tok_regex, code):
        kind = mo.lastgroup
        value = mo.group()
        column = mo.start() - line_start
        if kind == 'NUMBER':
            value = float(value) if '.' in value else int(value)
        elif kind == 'ID' and value in keywords:
            kind = value
        elif kind == 'NEWLINE':
            line_start = mo.end()
            line_num += 1
            continue
        elif kind == 'SKIP':
            continue
        elif kind == 'MISMATCH':
            raise RuntimeError(f'@{value!r@} unexpected on line @{line_num@}')
        yield Token(kind, value, line_num, column)

statements = '@w{'}'
    IF quantity THEN
        total := total + price * quantity;
        tax := price * 0.05;
    ENDIF;
'@w{'}'

for token in tokenize(statements):
    print(token)
@end example

El tokenizador produce el siguiente resultado:

@example
Token(type='IF', value='IF', line=2, column=4)
Token(type='ID', value='quantity', line=2, column=7)
Token(type='THEN', value='THEN', line=2, column=16)
Token(type='ID', value='total', line=3, column=8)
Token(type='ASSIGN', value=':=', line=3, column=14)
Token(type='ID', value='total', line=3, column=17)
Token(type='OP', value='+', line=3, column=23)
Token(type='ID', value='price', line=3, column=25)
Token(type='OP', value='*', line=3, column=31)
Token(type='ID', value='quantity', line=3, column=33)
Token(type='END', value=';', line=3, column=41)
Token(type='ID', value='tax', line=4, column=8)
Token(type='ASSIGN', value=':=', line=4, column=12)
Token(type='ID', value='price', line=4, column=15)
Token(type='OP', value='*', line=4, column=21)
Token(type='NUMBER', value=0.05, line=4, column=23)
Token(type='END', value=';', line=4, column=27)
Token(type='ENDIF', value='ENDIF', line=5, column=4)
Token(type='END', value=';', line=5, column=9)
@end example

@anchor{library/re frie09}@anchor{22ee}@w{(Frie09)} 
Friedl, Jeffrey. `Mastering Regular Expressions'. 3a ed., O’Reilly Media, 2009. La tercera edición del libro ya no abarca a Python en absoluto, pero la primera edición cubría la escritura de buenos patrones de expresiones regulares con gran detalle.

@node difflib — Helpers for computing deltas,textwrap — Text wrapping and filling,re — Regular expression operations,Servicios de procesamiento de texto
@anchor{library/difflib doc}@anchor{232f}@anchor{library/difflib difflib-helpers-for-computing-deltas}@anchor{2330}@anchor{library/difflib module-difflib}@anchor{38}
@subsection @code{difflib} — Helpers for computing deltas


@geindex module; difflib

@c Markup by Fred L. Drake, Jr. <fdrake@acm.org>

`Código fuente:' Lib/difflib.py@footnote{https://github.com/python/cpython/tree/main/Lib/difflib.py}

@c import sys
@c from difflib import *


__________________________________________________________________


Este módulo proporciona clases y funciones para comparar secuencias. Se puede utilizar, por ejemplo, para comparar archivos y puede producir información sobre diferencias de archivo en varios formatos, incluidos HTML y contexto y diferencias unificadas. Para comparar directorios y archivos, consulte también el módulo @ref{5a,,filecmp}.


@deffn {Clase} difflib.SequenceMatcher

Esta es una clase flexible para comparar pares de secuencias de cualquier tipo, siempre que los elementos de la secuencia sean @ref{6b1,,hashable}.  El algoritmo básico es anterior, y un poco mas agradable, que el publicado a fines de los 80” por Ratcliff y Obershelp, bajo el nombre hiperbólico de «`gestalt pattern matching'».  La idea es encontrar la subsecuencia coincidente contigua mas larga que no contenga elementos «no deseados»; estos elementos «no deseados» son aquellos que no son de interés por algún motivo, como ser lineas en blanco o espacios.  (El tratamiento de elementos no deseados es una extensión al algoritmo de Ratcliff y Obershelp). La misma idea se aplica recursivamente a las partes de la secuencia a la derecha e izquierda de cada subsecuencia correspondiente.  Esto no proporciona secuencias de edición mínimas, pero tiende a producir coincidencias que «parecen correctas» a las personas.

`Complejidad temporal:' En el peor de los casos el algoritmo Ratcliff-Obershelp básico es de complejidad cúbica y de complejidad temporal cuadrática en el caso esperado. @ref{1095,,SequenceMatcher} es de complejidad temporal cuadrática en el peor de los casos y el comportamiento del caso esperado depende de manera complicada de cuántos elementos tienen en común las secuencias; en el mejor de los casos la complejidad temporal es lineal.

`Heurística automática de elementos no deseados:' @ref{1095,,SequenceMatcher} implementa un método heurístico que identifica automáticamente a ciertos elementos como no deseados.   El método heurístico consiste en contar cuantas veces aparece cada elemento en la secuencia. Si las apariciones del duplicado de un elemento (después del primero) contabilizan mas del 1% de la secuencia, y a su vez la secuencia contiene mas de 200 elementos, este es identificado como «popular» y es considerado no deseado. Este método heurístico puede desactivarse estableciendo el argumento @code{autojunk} como @code{False} al crear la clase @ref{1095,,SequenceMatcher}.


Distinto en la versión 3.2: Added the `autojunk' parameter.

@end deffn

@geindex Differ (clase en difflib)
@anchor{library/difflib difflib Differ}@anchor{2331}
@deffn {Clase} difflib.Differ

Esta clase se utiliza para comparar secuencias de lineas de texto y producir diferencias o deltas en una forma legible por humanos.  Differ usa @ref{1095,,SequenceMatcher} tanto para comparar secuencias de lineas, como para comparar secuencias de caracteres entre lineas similares.

Cada linea de un delta de @ref{2331,,Differ} comienza con un código de dos letras:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código

@tab

Significado

@item

@code{'- '}

@tab

línea única para la secuencia 1

@item

@code{'+ '}

@tab

línea única para la secuencia 2

@item

@code{'  '}

@tab

línea común a ambas secuencias

@item

@code{'? '}

@tab

línea ausente en todas las secuencias de entrada

@end multitable


Lines beginning with “@code{?}” attempt to guide the eye to intraline differences,
and were not present in either input sequence. These lines can be confusing if
the sequences contain whitespace characters, such as spaces, tabs or line breaks.
@end deffn

@geindex HtmlDiff (clase en difflib)
@anchor{library/difflib difflib HtmlDiff}@anchor{2332}
@deffn {Clase} difflib.HtmlDiff

Esta clase puede ser usada para crear una tabla HTML (o un archivo HTML completo que contenga la tabla) mostrando comparaciones lado a lado y linea por linea del texto, con cambios interlineales e intralineales. La tabla se puede generar en modo de diferencia completa o contextual.

El constructor de esta clase es:

@geindex __init__() (método de difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff __init__}@anchor{2333}
@deffn {Método} __init__ (tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)

Inicializa una instancia de @ref{2332,,HtmlDiff}.

`tabsize' es un argumento por palabra clave opcional para especificar el espaciado de tabulación. Su valor predeterminado es @code{8}.

`wrapcolumn' es un argumento por palabra clave opcional para especificar el número de columnas donde las lineas serán divididas y ajustadas al ancho de columna, su valor por defecto es @code{None}, donde las lineas no son ajustadas.

`linejunk' y `charjunk' son argumentos por palabra clave opcionales que serán pasados a @ref{2334,,ndiff()} (que es utilizado por @ref{2332,,HtmlDiff} para generar las diferencias lado a lado en HTML). Refiérase a la documentación de @ref{2334,,ndiff()} para conocer los detalles y valores por defecto de sus argumentos.
@end deffn

Los siguientes métodos son públicos:

@geindex make_file() (método de difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff make_file}@anchor{e74}
@deffn {Método} make_file (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5, *, charset='utf-8')

Compara `fromlines' y `tolines' (listas de cadenas de texto) y retorna una cadena de caracteres que representa un archivo HTML completo que contiene una tabla mostrando diferencias línea por línea del texto con cambios interlineales e intralineales resaltados.

`fromdesc' y `todesc' son argumentos por palabra clave opcionales para especificar los encabezados de las columnas desde `fromdesc' hasta `todesc' en el archivo (ambas cadenas están vacías por defecto).

`context' y `numlines' son parámetros opcionales. Establezca `context' como @code{True} para mostrar diferencias contextuales, de lo contrario su valor por defecto es @code{False} que muestra los archivos completos. El valor por defecto de `numlines' es @code{5}. Cuando `context' es @code{True}, `numlines' controla el número de lineas de contexto que rodean las diferencias resaltadas. Cuando `context' es @code{False}, `numlines' controla el número de líneas que se muestran antes de una diferencia resaltada cuando se usan los hipervínculos «next» (un valor de cero produce que los hipervínculos «next» ubiquen el siguiente resaltado en la parte superior del navegador, sin ningún contexto principal).

@cartouche
@quotation Nota 
`fromdesc' y `todesc' se interpretan como HTML no escapado y se deben escapar correctamente si los datos son recibidos de fuentes no confiables.
@end quotation
@end cartouche


Distinto en la versión 3.5: Se agregó el argumento sólo de palabra clave `charset'.  La codificación de caracteres por defecto para documentos HTML se cambió de @code{'ISO-8859-1'} a @code{'utf-8'}.

@end deffn

@geindex make_table() (método de difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff make_table}@anchor{2335}
@deffn {Método} make_table (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5)

Compara `fromlines' y `tolines' (listas de cadenas de texto) y retorna una cadena de caracteres que representa una tabla HTML mostrando comparaciones lado a lado y línea por línea del texto con cambios interlineales e intralineales.

Los argumentos para este método son los mismos que los del método @ref{e74,,make_file()}.
@end deffn
@end deffn

@geindex context_diff() (en el módulo difflib)
@anchor{library/difflib difflib context_diff}@anchor{161d}
@deffn {Función} difflib.context_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

Compara `a' y `b' (listas de cadenas de texto); retorna un delta (un @ref{10dd,,generator} que genera las lineas delta) en formato de diferencias de contexto.

El formato de diferencias de contexto es una forma compacta de mostrar solamente las líneas que fueron modificadas y algunas líneas adicionales de contexto.  Los cambios son mostrados utilizando el estilo antes/después.  El número de líneas de contexto es determinado por `n', cuyo valor por defecto es @code{3}.

Por defecto, las líneas de control (aquellas que comienzan con @code{***} o @code{---}) son creadas con una línea nueva. Esto es de ayuda para que las entradas creadas por @ref{2336,,io.IOBase.readlines()} generen diferencias que puedan ser utilizadas con @ref{2337,,io.IOBase.writelines()} ya que ambas, la entrada y la salida, tienen líneas nuevas al final.

Para entradas que no tienen nuevas líneas finales, establezca el argumento `lineterm' como @code{""} de forma que la salida sea uniforme y libre de nuevas líneas.

El formato de diferencias de contexto normalmente tiene un encabezado para nombres de archivos y tiempos de modificaciones. Alguno o todos estos debe ser especificado utilizando las cadenas de texto para `fromfile', `tofile', `fromfiledate' y `tofiledate'. Los tiempos de modificación son normalmente expresados en formato ISO 8601. Si no es especificado las cadenas por defecto son espacios en blanco.

@example
>>> import sys
>>> from difflib import *
>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
>>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py',
...                        tofile='after.py'))
*** before.py
--- after.py
***************
*** 1,4 ****
! bacon
! eggs
! ham
  guido
--- 1,4 ----
! python
! eggy
! hamster
  guido
@end example

Vea @ref{2338,,Una interfaz de línea de comandos para difflib} para un ejemplo mas detallado.
@end deffn

@geindex get_close_matches() (en el módulo difflib)
@anchor{library/difflib difflib get_close_matches}@anchor{2339}
@deffn {Función} difflib.get_close_matches (word, possibilities, n=3, cutoff=0.6)

Retorna una lista de las mejores coincidencias «lo suficientemente buenas». `word' es una secuencia para la cual coincidencias cercanas son deseadas (usualmente una cadena de texto), y `possibilities' es una lista de secuencias contra la cual se compara `word' (comúnmente una lista de cadenas de caracteres).

Argumento opcional `n' (por defecto @code{3}) es el máximo número de coincidencias cercanas a retornar; `n' debe ser mayor que @code{0}.

Argumento opcional `cutoff' (por defecto @code{0.6}) es un flotante en el rango [0, 1]. Las posibilidades que no alcanzan un puntaje al menos similar al de `word' son ignoradas.

Las mejores (no mas de `n') coincidencias entre las posibilidades son retornadas en una lista, ordenadas por similitud de puntaje, las mas similares primero.

@example
>>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])
['apple', 'ape']
>>> import keyword
>>> get_close_matches('wheel', keyword.kwlist)
['while']
>>> get_close_matches('pineapple', keyword.kwlist)
[]
>>> get_close_matches('accept', keyword.kwlist)
['except']
@end example
@end deffn

@geindex ndiff() (en el módulo difflib)
@anchor{library/difflib difflib ndiff}@anchor{2334}
@deffn {Función} difflib.ndiff (a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)

Compara `a' y `b' (listas de cadenas de texto); retorna un delta del estilo @ref{2331,,Differ} (un @ref{10dd,,generator} que genera los deltas de las líneas).

Parámetros de palabra clave opcional `linejunk' y `charjunk' son funciones de filtrado (o @code{None}):

`linejunk': Una función que acepta una sola cadena de caracteres como argumento, y retorna verdadero si la cadena de texto es un elemento no deseado, o falso si no lo es. Su valor por defecto es @code{None}. Hay también una función a nivel del módulo @ref{233a,,IS_LINE_JUNK()}, que filtra líneas sin caracteres visibles, excepto como mucho un carácter de libra (@code{'#'}) – de cualquier forma la clase subyacente @ref{1095,,SequenceMatcher} realiza un análisis dinámico sobre cuáles lineas son tan frecuentes como para constituir ruido, y esto usualmente funciona mejor que utilizando esta función.

`charjunk': Una función que acepta un carácter (una cadena de caracteres de longitud 1) como argumento, y retorna @cite{True} si el carácter es un elemento no deseado, o @cite{False} si no lo es. El valor por defecto es una función a nivel del módulo @ref{233b,,IS_CHARACTER_JUNK()}, que filtra caracteres de espacios en blanco (un espacio en blanco o tabulación; es una mala idea incluir saltos de lineas en esto!)

@example
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
...              'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> print('@w{'}.join(diff), end="")
- one
?  ^
+ ore
?  ^
- two
- three
?  -
+ tree
+ emu
@end example
@end deffn

@geindex restore() (en el módulo difflib)
@anchor{library/difflib difflib restore}@anchor{233c}
@deffn {Función} difflib.restore (sequence, which)

Retorna uno de las dos secuencias que generaron un delta.

Dada una `sequence' producida por @ref{233d,,Differ.compare()} o @ref{2334,,ndiff()}, extrae las líneas originadas por el archivo 1 o 2 (parámetro `which'), quitando los prefijos de la línea.

Ejemplo:

@example
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
...              'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> diff = list(diff) # materialize the generated delta into a list
>>> print('@w{'}.join(restore(diff, 1)), end="")
one
two
three
>>> print('@w{'}.join(restore(diff, 2)), end="")
ore
tree
emu
@end example
@end deffn

@geindex unified_diff() (en el módulo difflib)
@anchor{library/difflib difflib unified_diff}@anchor{161c}
@deffn {Función} difflib.unified_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

Compara `a' y `b' (listas de cadenas de caracteres); retorna un delta (un @ref{10dd,,generator} que genera los delta de líneas) en formato de diferencias unificado.

Las diferencias unificadas son una forma compacta de mostrar sólo las líneas que presentan cambios y algunas líneas de contexto adicionales. Los cambios son mostrados en una sola línea (en lugar de bloques separados antes y después). El número de líneas de contexto se establece mediante `n', cuyo valor por defecto es tres.

Por defecto, las líneas de control de diferencias (aquellas con @code{---}, @code{+++}, o @code{@@@@}) son creadas con un salto de línea nuevo. Esto es de ayuda para que las entradas creadas por @ref{2336,,io.IOBase.readlines()} generen diferencias que puedan ser utilizadas con @ref{2337,,io.IOBase.writelines()} ya que ambas, la entrada y la salida, tienen líneas nuevas al final.

Para entradas que no tienen nuevas líneas finales, establezca el argumento `lineterm' como @code{""} de forma que la salida sea uniforme y libre de nuevas líneas.

The unified diff format normally has a header for filenames and modification
times.  Any or all of these may be specified using strings for `fromfile',
`tofile', `fromfiledate', and `tofiledate'.  The modification times are normally
expressed in the ISO 8601 format. If not specified, the
strings default to blanks.

@example
>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
>>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))
--- before.py
+++ after.py
@@@@ -1,4 +1,4 @@@@
-bacon
-eggs
-ham
+python
+eggy
+hamster
 guido
@end example

Vea @ref{2338,,Una interfaz de línea de comandos para difflib} para un ejemplo mas detallado.
@end deffn

@geindex diff_bytes() (en el módulo difflib)
@anchor{library/difflib difflib diff_bytes}@anchor{e75}
@deffn {Función} difflib.diff_bytes (dfunc, a, b, fromfile=b'@w{'}, tofile=b'@w{'}, fromfiledate=b'@w{'}, tofiledate=b'@w{'}, n=3, lineterm=b'\n')

Compara `a' y `b' (listas de objetos de bytes) usando `dfunc'; produce una secuencia de líneas delta (también bytes) en el formato retornado por `dfunc'. `dfunc' debe ser invocable, comúnmente cualquiera de @ref{161c,,unified_diff()} o @ref{161d,,context_diff()}.

Permite comparar datos con codificación desconocida o inconsistente. Todas las entradas, excepto `n', deben ser objetos de bytes, no cadenas de texto. Funciona convirtiendo sin pérdidas todas las entradas (excepto `n') a cadenas de texto, e invoca @code{dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n, lineterm)}. La salida de `dfunc' es entonces convertida nuevamente a bytes, de forma que las líneas delta que son recibidas tienen la misma codificación desconocida/inconsistente que `a' y `b'.


Added in version 3.5.

@end deffn

@geindex IS_LINE_JUNK() (en el módulo difflib)
@anchor{library/difflib difflib IS_LINE_JUNK}@anchor{233a}
@deffn {Función} difflib.IS_LINE_JUNK (line)

Retorna @code{True} para líneas que deben ser ignoradas. La línea `line' es ignorada si `line' es un espacio vacío o contiene un solo @code{'#'}, en cualquier otro caso no es ignorado. Es usado como valor por defecto para el parámetro `linejunk' por @ref{2334,,ndiff()} en versiones anteriores.
@end deffn

@geindex IS_CHARACTER_JUNK() (en el módulo difflib)
@anchor{library/difflib difflib IS_CHARACTER_JUNK}@anchor{233b}
@deffn {Función} difflib.IS_CHARACTER_JUNK (ch)

Retorna @code{True} para los caracteres que deben ser ignorados. El carácter `ch' es ignorado si `ch' es un espacio en blanco o tabulación, en cualquier otro caso no es ignorado. Es utilizado como valor por defecto para el parámetro `charjunk' en @ref{2334,,ndiff()}.
@end deffn


@subsubheading Ver también



@table @asis

@item Pattern Matching: The Gestalt Approach@footnote{https://www.drdobbs.com/database/pattern-matching-the-gestalt-approach/184407970}

Discussion of a similar algorithm by John W. Ratcliff and D. E. Metzener. This
was published in Dr. Dobb's Journal@footnote{https://www.drdobbs.com/} in July, 1988.
@end table


@menu
* Objetos SequenceMatcher:: 
* SequenceMatcher Ejemplos:: 
* Objetos Differ:: 
* Ejemplo de Differ:: 
* Una interfaz de línea de comandos para difflib:: 
* ndiff example:: 

@end menu

@node Objetos SequenceMatcher,SequenceMatcher Ejemplos,,difflib — Helpers for computing deltas
@anchor{library/difflib sequence-matcher}@anchor{233e}@anchor{library/difflib sequencematcher-objects}@anchor{233f}
@subsubsection Objetos `SequenceMatcher'


La clase @ref{1095,,SequenceMatcher} tiene este constructor:

@geindex SequenceMatcher (clase en difflib)
@anchor{library/difflib difflib SequenceMatcher}@anchor{1095}
@deffn {Clase} difflib.SequenceMatcher (isjunk=None, a='@w{'}, b='@w{'}, autojunk=True)

El argumento opcional `isjunk' debe ser @code{None} (que es su valor por defecto) o una función de un solo argumento que reciba un elemento de la secuencia y retorne verdadero si y solo si el elemento es no deseado y deba ser ignorado. Pasar el argumento `isjunk' como @code{None} es equivalente a pasar @code{lambda x: False}; en otras palabras, ningún elemento es ignorado. Por ejemplo, pasar:

@example
lambda x: x in " \t"
@end example

si se están comparando líneas como secuencias de caracteres, y no se quiere sincronizar en espacios blancos o tabulaciones.

Los argumentos opcionales `a' y `b' son las secuencias a comparar; ambos tienen como valor por defecto una cadena de texto vacía. Los elementos de ambas secuencias deben ser @ref{6b1,,hashable}.

El argumento opcional `autojunk' puede ser usado para deshabilitar la heurística automática de elementos no deseados.


Distinto en la versión 3.2: Added the `autojunk' parameter.


Los objetos @cite{SequenceMatcher} reciben tres atributos: `bjunk' es el conjunto de elementos de `b' para los cuales `isjunk' es @code{True}; `bpopular' es el set de elementos que no son basura considerados populares por la heurística (si no es que fue deshabilitada); `b2j' es un diccionario que mapea elementos de `b' a una lista de posiciones donde estos ocurren. Los tres atributos son reseteados cuando `b' es reseteado mediante @ref{2340,,set_seqs()} o @ref{2341,,set_seq2()}.


Added in version 3.2: Los atributos `bjunk' y `bpopular'.


Los objetos @ref{1095,,SequenceMatcher} tienen los siguientes métodos:

@geindex set_seqs() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seqs}@anchor{2340}
@deffn {Método} set_seqs (a, b)

Establece las dos secuencias a ser comparadas.
@end deffn

@ref{1095,,SequenceMatcher} calcula y almacena información detallada sobre la segunda secuencia, con lo cual si quieres comparar una secuencia contra muchas otras, usa @ref{2341,,set_seq2()} para establecer la secuencia común una sola vez y llamar @ref{2342,,set_seq1()} repetidamente, una vez por cada una de las otras secuencias.

@geindex set_seq1() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seq1}@anchor{2342}
@deffn {Método} set_seq1 (a)

Establece la primer secuencia a ser comparada. La segunda secuencia a ser comparada no es modificada.
@end deffn

@geindex set_seq2() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seq2}@anchor{2341}
@deffn {Método} set_seq2 (b)

Establece la segunda secuencia a ser comparada. La primera secuencia a ser comparada no es modificada.
@end deffn

@geindex find_longest_match() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher find_longest_match}@anchor{1969}
@deffn {Método} find_longest_match (alo=0, ahi=None, blo=0, bhi=None)

Encuentra el bloque de coincidencia mas largo en @code{a[alo:ahi]} y @code{b[blo:bhi]}.

Si `isjunk' fue omitido o es @code{None}, @ref{1969,,find_longest_match()} retorna @code{(i, j, k)} tal que @code{a[i:i+k]} es igual a @code{b[j:j+k]}, donde @code{alo <= i <= i+k <= ahi} y @code{blo <= j <= j+k <= bhi}. Para todo @code{(i', j', k')} cumpliendo esas condiciones, las condiciones adicionales @code{k >= k'}, @code{i <= i'}, y si @code{i == i'}, @code{j <= j'} también se cumplen. En otras palabras, de todos los bloques coincidentes máximos, retorna aquel que comienza antes en `a', y de todos esos bloques coincidentes máximos que comienzan antes en `a', retorna aquel que comienza antes en `b'.

@example
>>> s = SequenceMatcher(None, " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=0, b=4, size=5)
@end example

Si se porporcionó `isjunk', primero se determina el bloque coincidente mas largo como fue indicado anteriormente, pero con la restricción adicional de que no aparezca ningún elemento no deseado en el bloque. Entonces, ese bloque se extiende tan lejos como sea posible haciendo coincidir (solo) elementos no deseados de ambos lados. Por lo tanto, el bloque resultante nunca hará coincidir ningún elemento no deseado, excepto que un elemento no deseado idéntico pase a ser adyacente a una coincidencia interesante.

Este es el mismo ejemplo que el mostrado anteriormente, pero considerando elementos en blanco como no deseados. Esto previene que @code{' abcd'} sea coincidente con @code{'abcd'} en el final de la segunda secuencia directamente. En cambio, sólo el @code{'abcd'} puede coincidir, y coincide con el @code{'abcd'} que se encuentre mas a la izquierda en la segunda secuencia:

@example
>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=1, b=0, size=4)
@end example

Si no coincide ningún bloque, esto retorna @code{(alo, blo, 0)}.

Este método retorna un @ref{6ef,,named tuple} @code{Match(a, b, size)}.


Distinto en la versión 3.9: Se agregaron argumentos predeterminados.

@end deffn

@geindex get_matching_blocks() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_matching_blocks}@anchor{2343}
@deffn {Método} get_matching_blocks ()

Retorna una lista de triplas (tuplas de tres elementos) describiendo subsecuencias coincidentes no superpuestas. Cada tripla sigue el formato @code{(i, j, n)}, y significa que @code{a[i:i+n] == b[j:j+n]}. Las triplas son monótonamente crecientes en `i' y `j'.

La última tripla es un objeto ficticio (dummy), y tiene el valor @code{(len(a), len(b), 0)}. Es la única tripla con @code{n == 0}.  Si @code{(i, j, n)} y @code{(i', j', n')} son triplas adyacentes en la lista, y la segunda no es el último elemento de la lista, entonces @code{i+n < i'} o @code{j+n < j'}; en otras palabras, las triplas adyacentes describen bloques iguales no adyacentes.

@c XXX Explain why a dummy is used!

@example
>>> s = SequenceMatcher(None, "abxcd", "abcd")
>>> s.get_matching_blocks()
[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]
@end example
@end deffn

@geindex get_opcodes() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_opcodes}@anchor{2344}
@deffn {Método} get_opcodes ()

Retorna una lista de quíntuplas (tuplas de cinco elementos) describiendo como convertir `a' en `b'. Cada tupla tiene la forma @code{(tag, i1, i2, j1, j2)}. En la primer tupla se cumple que @code{i1 == j1 == 0}, y las tuplas restantes tienen `i1' igual al `i2' de la tupla precedente, y de igual manera, `j1' igual al `j2' de la tupla anterior.

Los valores de `tag' son cadenas de caracteres, con el siguiente significado:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'replace'}

@tab

@code{a[i1:i2]} debe ser reemplazado por @code{b[j1:j2]}.

@item

@code{'delete'}

@tab

@code{a[i1:i2]} debe ser eliminado.  Nótese que en este caso @code{j1 == j2}.

@item

@code{'insert'}

@tab

@code{b[j1:j2]} debe ser insertado en @code{a[i1:i1]}. Nótese que en este caso @code{i1 == i2}.

@item

@code{'equal'}

@tab

@code{a[i1:i2] == b[j1:j2]} (las subsecuencias son iguales).

@end multitable


Por ejemplo:

@example
>>> a = "qabxcd"
>>> b = "abycdf"
>>> s = SequenceMatcher(None, a, b)
>>> for tag, i1, i2, j1, j2 in s.get_opcodes():
...     print('@{:7@}   a[@{@}:@{@}] --> b[@{@}:@{@}] @{!r:>8@} --> @{!r@}'.format(
...         tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))
delete    a[0:1] --> b[0:0]      'q' --> '@w{'}
equal     a[1:3] --> b[0:2]     'ab' --> 'ab'
replace   a[3:4] --> b[2:3]      'x' --> 'y'
equal     a[4:6] --> b[3:5]     'cd' --> 'cd'
insert    a[6:6] --> b[5:6]       '@w{'} --> 'f'
@end example
@end deffn

@geindex get_grouped_opcodes() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_grouped_opcodes}@anchor{2345}
@deffn {Método} get_grouped_opcodes (n=3)

Retorna un @ref{10dd,,generator} de grupos de hasta `n' líneas de contexto.

Empezando con los grupos retornados por @ref{2344,,get_opcodes()}, este método separa grupos con cambios menores y elimina los rangos intermedios que no tienen cambios.

Los grupos son retornados en el mismo formato que @ref{2344,,get_opcodes()}.
@end deffn

@geindex ratio() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher ratio}@anchor{2346}
@deffn {Método} ratio ()

Retorna una medida de la similitud de las secuencias como un flotante en el rango [0, 1].

Donde T es el número total de elementos en ambas secuencias y M es el número de coincidencias, esto es 2.0*M / T. Nótese que esto es @code{1.0} si las secuencias son idénticas y @code{0.0} si no tienen nada en común.

Esto es computacionalmente costoso si @ref{2343,,get_matching_blocks()} o @ref{2344,,get_opcodes()} no fueron ejecutados, in tal caso deberías considerar primero @ref{2347,,quick_ratio()} o @ref{2348,,real_quick_ratio()} para obtener un límite superior.

@cartouche
@quotation Nota 
Precaución: El resultado de una llamada a @ref{2346,,ratio()} puede depender del orden de los argumentos. Por ejemplo:

@example
>>> SequenceMatcher(None, 'tide', 'diet').ratio()
0.25
>>> SequenceMatcher(None, 'diet', 'tide').ratio()
0.5
@end example
@end quotation
@end cartouche
@end deffn

@geindex quick_ratio() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher quick_ratio}@anchor{2347}
@deffn {Método} quick_ratio ()

Retorna un límite superior en @ref{2346,,ratio()} relativamente rápido.
@end deffn

@geindex real_quick_ratio() (método de difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher real_quick_ratio}@anchor{2348}
@deffn {Método} real_quick_ratio ()

Retorna un límite superior en @ref{2346,,ratio()} muy rápido.
@end deffn
@end deffn

The three methods that return the ratio of matching to total characters can give
different results due to differing levels of approximation, although
@ref{2347,,quick_ratio()} and @ref{2348,,real_quick_ratio()}
are always at least as large as @ref{2346,,ratio()}:

@example
>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.quick_ratio()
0.75
>>> s.real_quick_ratio()
1.0
@end example

@node SequenceMatcher Ejemplos,Objetos Differ,Objetos SequenceMatcher,difflib — Helpers for computing deltas
@anchor{library/difflib id1}@anchor{2349}@anchor{library/difflib sequencematcher-examples}@anchor{234a}
@subsubsection @code{SequenceMatcher} Ejemplos


Este ejemplo compara dos cadenas de texto, considerando los espacios en blanco como caracteres no deseados:

@example
>>> s = SequenceMatcher(lambda x: x == " ",
...                     "private Thread currentThread;",
...                     "private volatile Thread currentThread;")
@end example

@ref{2346,,ratio()} returns a float in [0, 1], measuring the similarity of the
sequences.  As a rule of thumb, a @ref{2346,,ratio()} value over 0.6 means the
sequences are close matches:

@example
>>> print(round(s.ratio(), 3))
0.866
@end example

If you’re only interested in where the sequences match,
@ref{2343,,get_matching_blocks()} is handy:

@example
>>> for block in s.get_matching_blocks():
...     print("a[%d] and b[%d] match for %d elements" % block)
a[0] and b[0] match for 8 elements
a[8] and b[17] match for 21 elements
a[29] and b[38] match for 0 elements
@end example

Note that the last tuple returned by @ref{2343,,get_matching_blocks()}
is always a dummy, @code{(len(a), len(b), 0)}, and this is the only case in which the last
tuple element (number of elements matched) is @code{0}.

If you want to know how to change the first sequence into the second, use
@ref{2344,,get_opcodes()}:

@example
>>> for opcode in s.get_opcodes():
...     print("%6s a[%d:%d] b[%d:%d]" % opcode)
 equal a[0:8] b[0:8]
insert a[8:8] b[8:17]
 equal a[8:29] b[17:38]
@end example


@subsubheading Ver también



@itemize *

@item 
La función @ref{2339,,get_close_matches()} en este módulo que muestra lo simple que es el código que construye @ref{1095,,SequenceMatcher} puede ser utilizada para hacer un trabajo útil.

@item 
Simple version control recipe@footnote{https://code.activestate.com/recipes/576729-simple-version-control/} for a small application
built with @ref{1095,,SequenceMatcher}.
@end itemize


@node Objetos Differ,Ejemplo de Differ,SequenceMatcher Ejemplos,difflib — Helpers for computing deltas
@anchor{library/difflib differ-objects}@anchor{234b}@anchor{library/difflib id2}@anchor{234c}
@subsubsection Objetos `Differ'


Nótese que los deltas generados por @ref{2331,,Differ} no dicen ser diferencias `mínimas'. Todo lo contrario, las diferencias mínimas suelen ser contra-intuitivas, ya que se sincronizan en cualquier lugar posible, a veces coinciden accidentalmente con 100 páginas de diferencia. Restringiendo los puntos de sincronización a coincidencias contiguas se preserva cierta noción de cercanía, con el costo adicional de producir diferencias mas largas.

La clase @ref{2331,,Differ} tiene el siguiente constructor:


@deffn {Clase} difflib.Differ (linejunk=None, charjunk=None)

Parámetros de palabra clave opcionales `linejunk' y `charjunk' son para funciones de filtrado (o @code{None}):

`linejunk': Una función que acepta una sola cadena de texto como argumento y retorna verdadero si la cadena de texto es un elemento no deseado. Su valor por defecto es @code{None}, lo que significa que ninguna línea es considerada no deseada.

`charjunk': Una función que acepta un solo carácter como argumento (una cadena de caracteres de longitud 1) y retorna verdadero si el carácter es un elemento no deseado. Su valor por defecto es @code{None}, lo que significa que ningún carácter es considerado no deseado.

Estas funciones de elementos no deseados aceleran la coincidencia para encontrar diferencies y no hacen que se ignoren líneas o caracteres diferentes. Lea la descripción del parámetro `isjunk' en el método @ref{1969,,find_longest_match()} para una explicación mas detallada.

Los objetos @ref{2331,,Differ} son usados (una vez generados los deltas) mediante un solo método:

@geindex compare() (método de difflib.Differ)
@anchor{library/difflib difflib Differ compare}@anchor{233d}
@deffn {Método} compare (a, b)

Compara dos secuencias de líneas y genera el delta correspondiente (una secuencia de líneas).

Cada secuencia debe contener cadenas de texto individuales de una sola linea terminadas con una línea nueva. Este tipo de secuencias pueden ser obtenidas mediante el método @ref{2336,,readlines()} de objetos de tipo archivo. Los delta generados consisten también en cadenas de texto terminadas en nuevas lineas, listas para imprimirse tal cual a través del método @ref{2337,,writelines()} de un objeto de tipo archivo.
@end deffn
@end deffn

@node Ejemplo de Differ,Una interfaz de línea de comandos para difflib,Objetos Differ,difflib — Helpers for computing deltas
@anchor{library/difflib differ-example}@anchor{234d}@anchor{library/difflib differ-examples}@anchor{234e}
@subsubsection Ejemplo de `Differ'


This example compares two texts. First we set up the texts, sequences of
individual single-line strings ending with newlines (such sequences can also be
obtained from the @ref{2336,,readlines()} method of file-like objects):

@example
>>> text1 = '@w{'}'  1. Beautiful is better than ugly.
...   2. Explicit is better than implicit.
...   3. Simple is better than complex.
...   4. Complex is better than complicated.
... '@w{'}'.splitlines(keepends=True)
>>> len(text1)
4
>>> text1[0][-1]
'\n'
>>> text2 = '@w{'}'  1. Beautiful is better than ugly.
...   3.   Simple is better than complex.
...   4. Complicated is better than complex.
...   5. Flat is better than nested.
... '@w{'}'.splitlines(keepends=True)
@end example

Luego instanciamos el objeto `Differ':

@example
>>> d = Differ()
@end example

Nótese que cuando instanciamos un objeto @ref{2331,,Differ} deberíamos pasar funciones para filtrar lineas y caracteres no deseados. Consulte el constructor de @ref{2331,,Differ()} para mas detalles.

Finalmente, comparamos las dos:

@example
>>> result = list(d.compare(text1, text2))
@end example

@code{result} es una lista de cadenas de caracteres, entonces vamos a mostrarlo de una forma elegante:

@example
>>> from pprint import pprint
>>> pprint(result)
['    1. Beautiful is better than ugly.\n',
 '-   2. Explicit is better than implicit.\n',
 '-   3. Simple is better than complex.\n',
 '+   3.   Simple is better than complex.\n',
 '?     ++\n',
 '-   4. Complex is better than complicated.\n',
 '?            ^                     ---- ^\n',
 '+   4. Complicated is better than complex.\n',
 '?           ++++ ^                      ^\n',
 '+   5. Flat is better than nested.\n']
@end example

Representado como una sola cadena de caracteres de múltiples líneas se ve así:

@example
>>> import sys
>>> sys.stdout.writelines(result)
    1. Beautiful is better than ugly.
-   2. Explicit is better than implicit.
-   3. Simple is better than complex.
+   3.   Simple is better than complex.
?     ++
-   4. Complex is better than complicated.
?            ^                     ---- ^
+   4. Complicated is better than complex.
?           ++++ ^                      ^
+   5. Flat is better than nested.
@end example

@node Una interfaz de línea de comandos para difflib,ndiff example,Ejemplo de Differ,difflib — Helpers for computing deltas
@anchor{library/difflib a-command-line-interface-to-difflib}@anchor{234f}@anchor{library/difflib difflib-interface}@anchor{2338}
@subsubsection Una interfaz de línea de comandos para @code{difflib}


This example shows how to use difflib to create a @code{diff}-like utility.

@example
""" Command line interface to difflib.py providing diffs in four formats:

* ndiff:    lists every line and highlights interline changes.
* context:  highlights clusters of changes in a before/after format.
* unified:  highlights clusters of changes in an inline format.
* html:     generates side by side comparison with change highlights.

"""

import sys, os, difflib, argparse
from datetime import datetime, timezone

def file_mtime(path):
    t = datetime.fromtimestamp(os.stat(path).st_mtime,
                               timezone.utc)
    return t.astimezone().isoformat()

def main():

    parser = argparse.ArgumentParser()
    parser.add_argument('-c', action='store_true', default=False,
                        help='Produce a context format diff (default)')
    parser.add_argument('-u', action='store_true', default=False,
                        help='Produce a unified format diff')
    parser.add_argument('-m', action='store_true', default=False,
                        help='Produce HTML side by side diff '
                             '(can use -c and -l in conjunction)')
    parser.add_argument('-n', action='store_true', default=False,
                        help='Produce a ndiff format diff')
    parser.add_argument('-l', '--lines', type=int, default=3,
                        help='Set number of context lines (default 3)')
    parser.add_argument('fromfile')
    parser.add_argument('tofile')
    options = parser.parse_args()

    n = options.lines
    fromfile = options.fromfile
    tofile = options.tofile

    fromdate = file_mtime(fromfile)
    todate = file_mtime(tofile)
    with open(fromfile) as ff:
        fromlines = ff.readlines()
    with open(tofile) as tf:
        tolines = tf.readlines()

    if options.u:
        diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)
    elif options.n:
        diff = difflib.ndiff(fromlines, tolines)
    elif options.m:
        diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)
    else:
        diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)

    sys.stdout.writelines(diff)

if __name__ == '__main__':
    main()
@end example

@node ndiff example,,Una interfaz de línea de comandos para difflib,difflib — Helpers for computing deltas
@anchor{library/difflib ndiff-example}@anchor{2350}
@subsubsection ndiff example


This example shows how to use @ref{2334,,difflib.ndiff()}.

@example
"""ndiff [-q] file1 file2
    or
ndiff (-r1 | -r2) < ndiff_output > file1_or_file2

Print a human-friendly file difference report to stdout.  Both inter-
and intra-line differences are noted.  In the second form, recreate file1
(-r1) or file2 (-r2) on stdout, from an ndiff report on stdin.

In the first form, if -q ("quiet") is not specified, the first two lines
of output are

-: file1
+: file2

Each remaining line begins with a two-letter code:

    "- "    line unique to file1
    "+ "    line unique to file2
    "  "    line common to both files
    "? "    line not present in either input file

Lines beginning with "? " attempt to guide the eye to intraline
differences, and were not present in either input file.  These lines can be
confusing if the source files contain tab characters.

The first file can be recovered by retaining only lines that begin with
"  " or "- ", and deleting those 2-character prefixes; use ndiff with -r1.

The second file can be recovered similarly, but by retaining only "  " and
"+ " lines; use ndiff with -r2; or, on Unix, the second file can be
recovered by piping the output through

    sed -n '/^[+ ] /s/^..//p'
"""

__version__ = 1, 7, 0

import difflib, sys

def fail(msg):
    out = sys.stderr.write
    out(msg + "\n\n")
    out(__doc__)
    return 0

# open a file & return the file object; gripe and return 0 if it
# couldn't be opened
def fopen(fname):
    try:
        return open(fname)
    except IOError as detail:
        return fail("couldn't open " + fname + ": " + str(detail))

# open two files & spray the diff to stdout; return false iff a problem
def fcompare(f1name, f2name):
    f1 = fopen(f1name)
    f2 = fopen(f2name)
    if not f1 or not f2:
        return 0

    a = f1.readlines(); f1.close()
    b = f2.readlines(); f2.close()
    for line in difflib.ndiff(a, b):
        print(line, end=' ')

    return 1

# crack args (sys.argv[1:] is normal) & compare;
# return false iff a problem

def main(args):
    import getopt
    try:
        opts, args = getopt.getopt(args, "qr:")
    except getopt.error as detail:
        return fail(str(detail))
    noisy = 1
    qseen = rseen = 0
    for opt, val in opts:
        if opt == "-q":
            qseen = 1
            noisy = 0
        elif opt == "-r":
            rseen = 1
            whichfile = val
    if qseen and rseen:
        return fail("can't specify both -q and -r")
    if rseen:
        if args:
            return fail("no args allowed with -r option")
        if whichfile in ("1", "2"):
            restore(whichfile)
            return 1
        return fail("-r value must be 1 or 2")
    if len(args) != 2:
        return fail("need 2 filename args")
    f1name, f2name = args
    if noisy:
        print('-:', f1name)
        print('+:', f2name)
    return fcompare(f1name, f2name)

# read ndiff output from stdin, and print file1 (which=='1') or
# file2 (which=='2') to stdout

def restore(which):
    restored = difflib.restore(sys.stdin.readlines(), which)
    sys.stdout.writelines(restored)

if __name__ == '__main__':
    main(sys.argv[1:])
@end example

@node textwrap — Text wrapping and filling,unicodedata — Unicode Database,difflib — Helpers for computing deltas,Servicios de procesamiento de texto
@anchor{library/textwrap doc}@anchor{2351}@anchor{library/textwrap module-textwrap}@anchor{ec}@anchor{library/textwrap textwrap-text-wrapping-and-filling}@anchor{2352}
@subsection @code{textwrap} — Text wrapping and filling


@geindex module; textwrap

`Source code:' Lib/textwrap.py@footnote{https://github.com/python/cpython/tree/main/Lib/textwrap.py}


__________________________________________________________________


El módulo @ref{ec,,textwrap} proporciona algunas funciones de conveniencia, así como @ref{104c,,TextWrapper}, la clase que hace todo el trabajo. Si sólo estás envolviendo o rellenando una o dos cadenas de texto, las funciones de conveniencia deberían ser lo suficientemente buenas; de lo contrario, deberías usar una instancia de @ref{104c,,TextWrapper} para mayor eficiencia.

@geindex wrap() (en el módulo textwrap)
@anchor{library/textwrap textwrap wrap}@anchor{1503}
@deffn {Función} textwrap.wrap (text, width=70, *, initial_indent='@w{'}, subsequent_indent='@w{'}, expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

Envuelve el párrafo individual en `text' (una cadena) para que cada línea tenga como máximo `width' de caracteres de largo.  Retorna una lista de líneas de salida, sin las nuevas líneas finales.

Los argumentos de palabras clave opcionales corresponden a los atributos de instancia de @ref{104c,,TextWrapper}, que se documentan a continuación.

Ver el método @ref{2353,,TextWrapper.wrap()} para más detalles sobre el comportamiento de @ref{1503,,wrap()}.
@end deffn

@geindex fill() (en el módulo textwrap)
@anchor{library/textwrap textwrap fill}@anchor{1502}
@deffn {Función} textwrap.fill (text, width=70, *, initial_indent='@w{'}, subsequent_indent='@w{'}, expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

Envuelve el único párrafo en `text', y retorna una sola cadena que contiene el párrafo envuelto. @ref{1502,,fill()} es la abreviatura de

@example
"\n".join(wrap(text, ...))
@end example

En particular, @ref{1502,,fill()} acepta exactamente los mismos argumentos de palabras clave que @ref{1503,,wrap()}.
@end deffn

@geindex shorten() (en el módulo textwrap)
@anchor{library/textwrap textwrap shorten}@anchor{104f}
@deffn {Función} textwrap.shorten (text, width, *, fix_sentence_endings=False, break_long_words=True, break_on_hyphens=True, placeholder=' [...]')

Colapsa y trunca el `text' dado para que encaje en el `width' dado.

Primero el espacio blanco en `text' se colapsa (todos los espacios blancos son reemplazados por espacios sencillos).  Si el resultado cabe en el `width', se retorna. En caso contrario, se eliminan suficientes palabras del final para que las palabras restantes más el `placeholder' encajen dentro de `width':

@example
>>> textwrap.shorten("Hello  world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello  world!", width=11)
'Hello [...]'
>>> textwrap.shorten("Hello world", width=10, placeholder="...")
'Hello...'
@end example

Los argumentos opcionales de las palabras clave corresponden a los atributos de la instancia de @ref{104c,,TextWrapper}, documentados a continuación.  Observe que el espacio en blanco se colapsa antes de pasar el texto a la función @ref{104c,,TextWrapper} @ref{1502,,fill()}, por lo que cambiar el valor de @ref{2354,,tabsize}, @ref{2355,,expand_tabs}, @ref{2356,,drop_whitespace}, y @ref{2357,,replace_whitespace} no tendrá ningún efecto.


Added in version 3.4.

@end deffn

@geindex dedent() (en el módulo textwrap)
@anchor{library/textwrap textwrap dedent}@anchor{2358}
@deffn {Función} textwrap.dedent (text)

Elimina cualquier espacio en blanco común de cada línea de `text'.

Esto puede utilizarse para hacer que las cadenas con comillas triples se alineen con el borde izquierdo de la pantalla, mientras que se siguen presentando en el código fuente en forma indentada.

Nótese que los tabuladores y los espacios se tratan como espacios en blanco, pero no son iguales: las líneas @code{"  hello"} y @code{"\thello"} se consideran que no tienen un espacio en blanco común.

Las líneas que sólo contienen espacios en blanco se ignoran en la entrada y se normalizan a un solo carácter de nueva línea en la salida.

Por ejemplo:

@example
def test():
    # end first line with \ to avoid the empty line!
    s = '@w{'}'\
    hello
      world
    '@w{'}'
    print(repr(s))          # prints '    hello\n      world\n    '
    print(repr(dedent(s)))  # prints 'hello\n  world\n'
@end example
@end deffn

@geindex indent() (en el módulo textwrap)
@anchor{library/textwrap textwrap indent}@anchor{3cd}
@deffn {Función} textwrap.indent (text, prefix, predicate=None)

Añade `prefix' al principio de las líneas seleccionadas en `text'.

Las líneas se separan llamando a @code{text.splitlines(True)}.

Por defecto, se añade `prefix' a todas las líneas que no consisten únicamente en espacios en blanco (incluyendo cualquier terminación de línea).

Por ejemplo:

@example
>>> s = 'hello\n\n \nworld'
>>> indent(s, '  ')
'  hello\n\n \n  world'
@end example

El argumento opcional `predicate' puede ser usado para controlar qué líneas están indentadas. Por ejemplo, es fácil añadir `prefix' incluso a las líneas vacías y de espacio en blanco:

@example
>>> print(indent(s, '+ ', lambda line: True))
+ hello
+
+
+ world
@end example


Added in version 3.3.

@end deffn

@ref{1503,,wrap()}, @ref{1502,,fill()} y @ref{104f,,shorten()} funcionan creando una instancia @ref{104c,,TextWrapper} y llamando a un solo método en ella.  Esa instancia no se reutiliza, por lo que para las aplicaciones que procesan muchas cadenas de texto usando @ref{1503,,wrap()} y/o @ref{1502,,fill()}, puede ser más eficiente crear su propio objeto @ref{104c,,TextWrapper}.

El texto se envuelve preferentemente en espacios en blanco y justo después de los guiones en palabras con guión; sólo entonces se romperán las palabras largas si es necesario, a menos que @ref{2359,,TextWrapper.break_long_words} sea falso.

@geindex TextWrapper (clase en textwrap)
@anchor{library/textwrap textwrap TextWrapper}@anchor{104c}
@deffn {Clase} textwrap.TextWrapper (**kwargs)

El constructor @ref{104c,,TextWrapper} acepta un número de argumentos de palabras clave opcionales.  Cada argumento de palabra clave corresponde a un atributo de la instancia, por ejemplo

@example
wrapper = TextWrapper(initial_indent="* ")
@end example

es lo mismo que

@example
wrapper = TextWrapper()
wrapper.initial_indent = "* "
@end example

You can reuse the same @ref{104c,,TextWrapper} object many times, and you can
change any of its options through direct assignment to instance attributes
between uses.

Los atributos de la instancia @ref{104c,,TextWrapper} (y los argumentos de las palabras clave para el constructor) son los siguientes:

@geindex width (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper width}@anchor{235a}
@deffn {Atributo} width

(default: @code{70}) La longitud máxima de las líneas envueltas.  Mientras no haya palabras individuales en el texto de entrada más largas que @ref{235a,,width}, @ref{104c,,TextWrapper} garantiza que ninguna línea de salida será más larga que los caracteres  @ref{235a,,width}.
@end deffn

@geindex expand_tabs (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper expand_tabs}@anchor{2355}
@deffn {Atributo} expand_tabs

(default: @code{True}) Si es verdadero, entonces todos los caracteres de tabulación en `text' serán expandidos a espacios usando el método @ref{21c5,,expandtabs()} de `text'.
@end deffn

@geindex tabsize (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper tabsize}@anchor{2354}
@deffn {Atributo} tabsize

(default: @code{8}) Si @ref{2355,,expand_tabs} es verdadero, entonces todos los caracteres de tabulación en `text' se expandirán a cero o más espacios, dependiendo de la columna actual y el tamaño de tabulación dado.


Added in version 3.3.

@end deffn

@geindex replace_whitespace (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper replace_whitespace}@anchor{2357}
@deffn {Atributo} replace_whitespace

(default: @code{True}) Si es verdadero, después de la expansión por tabulador pero antes de envolver, el método @ref{1503,,wrap()} reemplazará cada carácter de espacio en blanco con un espacio sencillo.  Los caracteres de los espacios en blanco reemplazados son los siguientes: tab, nueva línea, tab vertical, `formfeed' y `carriage return' (@code{'\t\n\v\f\r'}).

@cartouche
@quotation Nota 
Si @ref{2355,,expand_tabs} es falso y @ref{2357,,replace_whitespace} es verdadero, cada carácter del tabulador será reemplazado por un solo espacio, que `no' es lo mismo que la expansión del tabulador.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Si @ref{2357,,replace_whitespace} es falso, las nuevas líneas pueden aparecer en medio de una línea y causar una salida extraña. Por esta razón, el texto debe ser dividido en párrafos (usando @ref{12c4,,str.splitlines()} o similar) que se envuelven por separado.
@end quotation
@end cartouche
@end deffn

@geindex drop_whitespace (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper drop_whitespace}@anchor{2356}
@deffn {Atributo} drop_whitespace

(default: @code{True}) Si es verdadero, se eliminan los espacios en blanco al principio y al final de cada línea (después de la envoltura pero antes del indentado). Sin embargo, el espacio en blanco al principio del párrafo no se elimina si lo sigue un espacio en blanco.  Si el espacio blanco que se deja caer ocupa una línea entera, se deja caer toda la línea.
@end deffn

@geindex initial_indent (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper initial_indent}@anchor{235b}
@deffn {Atributo} initial_indent

(default: @code{'@w{'}}) Cadena que será preparada para la primera línea de salida envuelta.  Cuenta hacia la longitud de la primera línea.  La cadena vacía no está indentada.
@end deffn

@geindex subsequent_indent (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper subsequent_indent}@anchor{235c}
@deffn {Atributo} subsequent_indent

(default: @code{'@w{'}}) Cadena que se preparará para todas las líneas de salida envueltas excepto la primera.  Cuenta hacia la longitud de cada línea excepto la primera.
@end deffn

@geindex fix_sentence_endings (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper fix_sentence_endings}@anchor{235d}
@deffn {Atributo} fix_sentence_endings

(default: @code{False}) If true, @ref{104c,,TextWrapper} attempts to detect
sentence endings and ensure that sentences are always separated by exactly
two spaces.  This is generally desired for text in a monospaced font.
However, the sentence detection algorithm is imperfect: it assumes that a
sentence ending consists of a lowercase letter followed by one of @code{'.'},
@code{'!'}, or @code{'?'}, possibly followed by one of @code{'"'} or @code{"'"},
followed by a space.  One problem with this algorithm is that it is
unable to detect the difference between «Dr.» in

@example
[...] Dr. Frankenstein's monster [...]
@end example

y «Spot.» en:

@example
[...] See Spot. See Spot run [...]
@end example

@ref{235d,,fix_sentence_endings} es falso por defecto.

Dado que el algoritmo de detección de oraciones se basa en @code{string.lowercase} para la definición de «letra en minúscula», y en la convención de utilizar dos espacios después de un punto para separar las oraciones en la misma línea, es específico para los textos en inglés.
@end deffn

@geindex break_long_words (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper break_long_words}@anchor{2359}
@deffn {Atributo} break_long_words

(default: @code{True}) Si es verdadero, entonces las palabras más largas que @ref{235a,,width} se romperán para asegurar que ninguna línea sea más larga que @ref{235a,,width}.  Si es falso, las palabras largas no se romperán, y algunas líneas pueden ser más largas que @ref{235a,,width}.  (Las palabras largas se pondrán en una línea por sí mismas, para minimizar la cantidad en que se excede @ref{235a,,width}).
@end deffn

@geindex break_on_hyphens (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper break_on_hyphens}@anchor{235e}
@deffn {Atributo} break_on_hyphens

(predeterminado: @code{True}) Si es verdadero, el ajuste se producirá preferiblemente en espacios en blanco y justo después de los guiones en palabras compuestas, como es habitual en inglés. Si es falso, solo los espacios en blanco se considerarán lugares potencialmente buenos para los saltos de línea, pero debe establecer @ref{2359,,break_long_words} en falso si desea palabras verdaderamente insecables. El comportamiento predeterminado en versiones anteriores era permitir siempre romper palabras con guiones.
@end deffn

@geindex max_lines (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper max_lines}@anchor{104d}
@deffn {Atributo} max_lines

(default: @code{None}) Si es @code{None}, entonces la salida contendrá como máximo `max_lines', con un `placeholder' que aparecerá al final de la salida.


Added in version 3.4.

@end deffn

@geindex ...;placeholder

@geindex placeholder (atributo de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper placeholder}@anchor{104e}
@deffn {Atributo} placeholder

(default: @code{' [...]'}) Cadena que aparecerá al final del texto de salida si ha sido truncado.


Added in version 3.4.

@end deffn

@ref{104c,,TextWrapper} también proporciona algunos métodos públicos, análogos a las funciones de conveniencia a nivel de módulo:

@geindex wrap() (método de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper wrap}@anchor{2353}
@deffn {Método} wrap (text)

Envuelve el párrafo individual en `text' (una cadena) para que cada línea tenga como máximo @ref{235a,,width} caracteres de largo.  Todas las opciones de envoltura se toman de los atributos de la instancia @ref{104c,,TextWrapper}.  Retorna una lista de líneas de salida, sin las nuevas líneas finales.  Si la salida envuelta no tiene contenido, la lista retornada estará vacía.
@end deffn

@geindex fill() (método de textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper fill}@anchor{235f}
@deffn {Método} fill (text)

Envuelve el único párrafo en `text', y retorna una única cadena que contiene el párrafo envuelto.
@end deffn
@end deffn

@node unicodedata — Unicode Database,stringprep — Internet String Preparation,textwrap — Text wrapping and filling,Servicios de procesamiento de texto
@anchor{library/unicodedata doc}@anchor{2360}@anchor{library/unicodedata module-unicodedata}@anchor{105}@anchor{library/unicodedata unicodedata-unicode-database}@anchor{2361}
@subsection @code{unicodedata} — Unicode Database


@geindex module; unicodedata

@geindex Unicode
@geindex character
@geindex Unicode;database


__________________________________________________________________


This module provides access to the Unicode Character Database (UCD) which
defines character properties for all Unicode characters. The data contained in
this database is compiled from the UCD version 16.0.0@footnote{https://www.unicode.org/Public/16.0.0/ucd}.

El módulo utiliza los mismos nombres y símbolos definidos por el Anexo #44 del estándar Unicode de la "Base de datos de caracteres Unicode"@footnote{https://www.unicode.org/reports/tr44/}. Define las siguientes funciones:

@geindex lookup() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata lookup}@anchor{10f4}
@deffn {Función} unicodedata.lookup (name)

Busca el carácter por su nombre. Si se encuentra un carácter con el nombre proporcionado, retornará el carácter correspondiente. Si no se encuentra, se lanza una excepción @ref{438,,KeyError}.


Distinto en la versión 3.3: Se ha agregado soporte para alias de nombre @footnote{
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/NameAliases.txt}
} y secuencias con nombre @footnote{
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/NamedSequences.txt}
}.

@end deffn

@geindex name() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata name}@anchor{2362}
@deffn {Función} unicodedata.name (chr[, default])

Retorna el nombre asignado al carácter `chr' como una cadena de caracteres. Si no se define ningún nombre, se retorna `default' o, si no se proporciona, se lanza una excepción @ref{360,,ValueError}.
@end deffn

@geindex decimal() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata decimal}@anchor{2363}
@deffn {Función} unicodedata.decimal (chr[, default])

Retorna el valor decimal asignado al carácter `chr' como un entero. Si no se define dicho valor, se retorna `default' o, si no se proporciona, se lanza una excepción @ref{360,,ValueError}.
@end deffn

@geindex digit() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata digit}@anchor{2364}
@deffn {Función} unicodedata.digit (chr[, default])

Retorna el valor del dígito asignado al carácter `chr' como un entero. Si no se define dicho valor, se retorna `default' o, si no se proporciona, se genera una excepción @ref{360,,ValueError}.
@end deffn

@geindex numeric() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata numeric}@anchor{12d0}
@deffn {Función} unicodedata.numeric (chr[, default])

Retorna el valor numérico asignado al carácter `chr' como un flotante. Si no se define dicho valor, se retorna `default' o, si no se proporciona, se lanza una excepción @ref{360,,ValueError}.
@end deffn

@geindex category() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata category}@anchor{2365}
@deffn {Función} unicodedata.category (chr)

Retorna la categoría general asignada al carácter `chr' como una cadena de caracteres.
@end deffn

@geindex bidirectional() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata bidirectional}@anchor{2366}
@deffn {Función} unicodedata.bidirectional (chr)

Retorna la clase bidireccional asignada al carácter `chr' como una cadena de caracteres. Si no se define tal valor, se retorna una cadena de caracteres vacía.
@end deffn

@geindex combining() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata combining}@anchor{2367}
@deffn {Función} unicodedata.combining (chr)

Retorna la clase de combinación canónica asignada al carácter `chr' como un entero. Retorna @code{0} si no se define ninguna clase de combinación.
@end deffn

@geindex east_asian_width() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata east_asian_width}@anchor{2368}
@deffn {Función} unicodedata.east_asian_width (chr)

Retorna el ancho asignado al carácter `chr' para el este asiático como una cadena de caracteres.
@end deffn

@geindex mirrored() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata mirrored}@anchor{2369}
@deffn {Función} unicodedata.mirrored (chr)

Retorna la propiedad reflejada asignada al carácter `chr' como un entero. Retorna @code{1} si el carácter se ha identificado como un carácter «reflejado» en texto bidireccional y @code{0} en caso contrario.
@end deffn

@geindex decomposition() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata decomposition}@anchor{236a}
@deffn {Función} unicodedata.decomposition (chr)

Retorna el mapeo de descomposición de caracteres asignado al carácter `chr' como una cadena de caracteres. Se retorna una cadena de caracteres vacía en caso de que no se defina tal mapeo.
@end deffn

@geindex normalize() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata normalize}@anchor{775}
@deffn {Función} unicodedata.normalize (form, unistr)

Retorna la forma normalizada `form' para la cadena Unicode `unistr'. Los valores válidos para `form' son “NFC”, “NFKC”, “NFD” y “NFKD”.

El estándar Unicode define varias formas de normalización de una cadena Unicode, basándose en la definición de equivalencia canónica y equivalencia de compatibilidad. En Unicode, varios caracteres se pueden expresar de diversas formas. Por ejemplo, el carácter U+00C7 (LETRA C LATINA MAYÚSCULA CON CEDILLA) también se puede expresar con la secuencia U+0043 (LETRA C LATINA MAYÚSCULA) U+0327 (CEDILLA COMBINABLE).

Para cada carácter, hay dos formas normalizadas: la forma normal C y la forma normal D. La forma normal D (NFD) también se conoce como descomposición canónica y traduce cada carácter a su forma descompuesta. La forma normal C (NFC) primero aplica una descomposición canónica y luego vuelve a componer los caracteres combinados previamente.

Además de las dos anteriores, hay dos formas normalizadas adicionales basadas en la equivalencia de compatibilidad. En Unicode, se admiten ciertos caracteres que normalmente se unificarán con otros caracteres. Por ejemplo, U+2160 (NUMERAL ROMANO UNO) es realmente lo mismo que U+0049 (LETRA LATINA MAYÚSCULA I). Sin embargo, esta característica está soportada por Unicode para ser compatible con los conjuntos de caracteres existentes (por ejemplo, gb2312).

La forma normalizada KD (NFKD) aplicará la descomposición de compatibilidad, es decir, reemplazará todos los caracteres de compatibilidad con sus equivalentes. La forma normalizada KC (NFKC) primero aplica la descomposición de compatibilidad, seguida de la composición canónica.

Incluso si dos cadenas Unicode están normalizadas y parecen iguales para un lector humano, si una tiene caracteres combinados y la otra no, es posible que no se comparen como iguales.
@end deffn

@geindex is_normalized() (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata is_normalized}@anchor{adb}
@deffn {Función} unicodedata.is_normalized (form, unistr)

Retorna si la cadena Unicode `unistr' está en la forma normalizada `form'. Los valores válidos para `form' son “NFC”, “NFKC”, “NFD” y “NFKD”.


Added in version 3.8.

@end deffn

Además, el módulo expone las siguientes constantes:

@geindex unidata_version (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata unidata_version}@anchor{236b}
@deffn {Dato} unicodedata.unidata_version

La versión de la base de datos Unicode usada en este módulo.
@end deffn

@geindex ucd_3_2_0 (en el módulo unicodedata)
@anchor{library/unicodedata unicodedata ucd_3_2_0}@anchor{1473}
@deffn {Dato} unicodedata.ucd_3_2_0

Este es un objeto que tiene los mismos métodos que el módulo completo, pero usa la versión 3.2 de la base de datos Unicode en su lugar. Es útil para aplicaciones que requieren esta versión específica de la base de datos Unicode (como IDNA).
@end deffn

Ejemplos:

@example
>>> import unicodedata
>>> unicodedata.lookup('LEFT CURLY BRACKET')
'@{'
>>> unicodedata.name('/')
'SOLIDUS'
>>> unicodedata.decimal('9')
9
>>> unicodedata.decimal('a')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: not a decimal
>>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
'Lu'
>>> unicodedata.bidirectional('\u0660') # 'A'rabic, 'N'umber
'AN'
@end example

@subsubheading Notas al pie


@node stringprep — Internet String Preparation,readline — GNU readline interface,unicodedata — Unicode Database,Servicios de procesamiento de texto
@anchor{library/stringprep doc}@anchor{236c}@anchor{library/stringprep module-stringprep}@anchor{d4}@anchor{library/stringprep stringprep-internet-string-preparation}@anchor{236d}
@subsection @code{stringprep} — Internet String Preparation


@geindex module; stringprep

`Código fuente:' Lib/stringprep.py@footnote{https://github.com/python/cpython/tree/main/Lib/stringprep.py}


__________________________________________________________________


Cuando se quiere identificar cosas (como nombres de host) en internet, generalmente es necesario comparar tales identificaciones para «igualdad». La manera en la que esta comparación se ejecuta dependerá del dominio de la aplicación, ej. si tiene o no tiene que distinguir entre mayúsculas y minúsculas. Además, en algunos casos será necesario restringir las posibles identificaciones, de tal manera que solo se permitan identificadores de caracteres que se puedan «imprimir».

@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} define el proceso para la «preparación» de cadenas Unicode para protocolos de internet. Antes de pasar cadenas a un cable, se procesan con el proceso de preparación, después del cual tienen una forma normalizada. El RFC define un conjunto de tablas, que pueden ser combinadas en perfiles. Cada perfil debe definir qué tablas usa, y que partes opcionales del proceso @code{stringprep} son parte del perfil. Un ejemplo de perfil de @code{stringprep} es @code{nameprep}, que se usa para nombres de dominios internacionalizados.

El modulo @ref{d4,,stringprep} solo expone las tablas de 
@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html}. Como estas tablas serían muy grandes para representarlas como diccionarios o listas, el módulo usa la base de datos de los caracteres de Unicode de manera interna. El código fuente del módulo en sí ha sido generado usando la herramienta @code{mkstringprep.py}.

Como resultado, estas tablas son presentadas como funciones, no como estructuras de datos. Hay dos tipos de tablas en el RFC: conjuntos  y mapeos. Para un conjunto, @ref{d4,,stringprep} proporciona una «función característica», es decir, la función retorna @code{True} si el parámetro es parte del conjunto. Para los mapas, proporciona una función de mapeado: dada una clave, retorna el valor asociado. Abajo se encuentra una lista con todas las funciones disponibles para este módulo.

@geindex in_table_a1() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_a1}@anchor{236e}
@deffn {Función} stringprep.in_table_a1 (code)

Determina si `code' está en la tablaA.1 (Puntos de Código sin asignar en Unicode 3.2).
@end deffn

@geindex in_table_b1() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_b1}@anchor{236f}
@deffn {Función} stringprep.in_table_b1 (code)

Determina si `code' está en la tablaB.1 (Generalmente mapeado a nada).
@end deffn

@geindex map_table_b2() (en el módulo stringprep)
@anchor{library/stringprep stringprep map_table_b2}@anchor{2370}
@deffn {Función} stringprep.map_table_b2 (code)

Retorna el valor mapeado para `code' de acuerdo a la tablaB.2 (Mapeo para `case-folding' usado con NFKC).
@end deffn

@geindex map_table_b3() (en el módulo stringprep)
@anchor{library/stringprep stringprep map_table_b3}@anchor{2371}
@deffn {Función} stringprep.map_table_b3 (code)

Retorna el valor mapeado para `code' de acuerdo a tablaB.3 (Mapeo para `case-folding' usado sin normalización).
@end deffn

@geindex in_table_c11() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c11}@anchor{2372}
@deffn {Función} stringprep.in_table_c11 (code)

Determina si `code' está en la tablaC.1.1 (Caracteres de espacio ASCII).
@end deffn

@geindex in_table_c12() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c12}@anchor{2373}
@deffn {Función} stringprep.in_table_c12 (code)

Determina si `code' está en la tablaC.1.2 (Caracteres de espacio no-ASCII).
@end deffn

@geindex in_table_c11_c12() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c11_c12}@anchor{2374}
@deffn {Función} stringprep.in_table_c11_c12 (code)

Determina si `code' está en la tablaC.1 (Caracteres de espacio, unión de C.1.1 y C.1.2).
@end deffn

@geindex in_table_c21() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c21}@anchor{2375}
@deffn {Función} stringprep.in_table_c21 (code)

Determina si `code' está en la tablaC.2.1 (Caracteres de control ASCII).
@end deffn

@geindex in_table_c22() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c22}@anchor{2376}
@deffn {Función} stringprep.in_table_c22 (code)

Determina si `code' está en la tablaC.2.2 (Caracteres de control no ASCII).
@end deffn

@geindex in_table_c21_c22() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c21_c22}@anchor{2377}
@deffn {Función} stringprep.in_table_c21_c22 (code)

Determina si `code' está en la tablaC.2 (Caracteres de control, unión de C.2.1 y C.2.2).
@end deffn

@geindex in_table_c3() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c3}@anchor{2378}
@deffn {Función} stringprep.in_table_c3 (code)

Determina si `code' está en la tablaC.3 (Uso privado).
@end deffn

@geindex in_table_c4() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c4}@anchor{2379}
@deffn {Función} stringprep.in_table_c4 (code)

Determina si `code' está en la tablaC.4 (Puntos de código sin caracteres)
@end deffn

@geindex in_table_c5() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c5}@anchor{237a}
@deffn {Función} stringprep.in_table_c5 (code)

Determina si `code' está en la tablaC.5 (Códigos surrogados).
@end deffn

@geindex in_table_c6() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c6}@anchor{237b}
@deffn {Función} stringprep.in_table_c6 (code)

Determina si `code' está en la tablaC.6 (Inadecuado para texto plano).
@end deffn

@geindex in_table_c7() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c7}@anchor{237c}
@deffn {Función} stringprep.in_table_c7 (code)

Determina si `code' está en la tablaC.7 (Inadecuado para la representación canónica).
@end deffn

@geindex in_table_c8() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c8}@anchor{237d}
@deffn {Función} stringprep.in_table_c8 (code)

Determina si `code' está en la tablaC.8 (Cambia las propiedades de apariencia o están obsoletas).
@end deffn

@geindex in_table_c9() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_c9}@anchor{237e}
@deffn {Función} stringprep.in_table_c9 (code)

Determina si `code' está en la tablaC.9 (Caracteres de etiquetado).
@end deffn

@geindex in_table_d1() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_d1}@anchor{237f}
@deffn {Función} stringprep.in_table_d1 (code)

Determina si `code' está en la tablaD.1 (Caracteres con propiedad bidireccional «R» o «AL»).
@end deffn

@geindex in_table_d2() (en el módulo stringprep)
@anchor{library/stringprep stringprep in_table_d2}@anchor{2380}
@deffn {Función} stringprep.in_table_d2 (code)

Determina si `code' está en la tablaD.2 (Caracteres con propiedad bidireccional «L»).
@end deffn

@node readline — GNU readline interface,rlcompleter — Completion function for GNU readline,stringprep — Internet String Preparation,Servicios de procesamiento de texto
@anchor{library/readline doc}@anchor{2381}@anchor{library/readline module-readline}@anchor{ba}@anchor{library/readline readline-gnu-readline-interface}@anchor{2382}
@subsection @code{readline} — GNU readline interface


@geindex module; readline


__________________________________________________________________


El módulo @ref{ba,,readline} define una serie de funciones para facilitar la finalización y lectura/escritura de archivos de historial desde el intérprete de Python. Este módulo se puede usar directamente o mediante el módulo @ref{bd,,rlcompleter}, que administra la finalización de identificadores de Python en la solicitud interactiva. Los ajustes realizados con este módulo afectan el comportamiento tanto del aviso interactivo del intérprete como de los avisos ofrecidos por la función incorporada @ref{1340,,input()}.

Las combinaciones de teclas de Readline se pueden configurar mediante un archivo de inicialización, generalmente @code{.inputrc} en su directorio de inicio. Consulte Readline Init File@footnote{https://tiswww.cwru.edu/php/chet/readline/rluserman.html#Readline-Init-File} en el manual de GNU Readline para obtener información sobre el formato y las construcciones permitidas de ese archivo, y las capacidades de la biblioteca Readline en general.

@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@cartouche
@quotation Nota 
The underlying Readline library API may be implemented by
the @code{editline} (@code{libedit}) library instead of GNU readline.
On macOS the @ref{ba,,readline} module detects which library is being used
at run time.

The configuration file for @code{editline} is different from that
of GNU readline. If you programmatically load configuration strings
you can use @ref{16b7,,backend} to determine which library is being used.

If you use @code{editline}/@code{libedit} readline emulation on macOS, the
initialization file located in your home directory is named
@code{.editrc}. For example, the following content in @code{~/.editrc} will
turn ON `vi' keybindings and TAB completion:

@example
python:bind -v
python:bind ^I rl_complete
@end example

Also note that different libraries may use different history file formats.
When switching the underlying library, existing history files may become
unusable.
@end quotation
@end cartouche

@geindex backend (en el módulo readline)
@anchor{library/readline readline backend}@anchor{16b7}
@deffn {Dato} readline.backend

The name of the underlying Readline library being used, either
@code{"readline"} or @code{"editline"}.


Added in version 3.13.

@end deffn

@menu
* Archivo de inicio:: 
* Búfer de línea:: 
* Archivo de historial:: 
* Lista del historial:: 
* Ganchos (hooks) de inicialización: Ganchos hooks de inicialización. 
* Terminación:: 
* Ejemplo:: 

@end menu

@node Archivo de inicio,Búfer de línea,,readline — GNU readline interface
@anchor{library/readline init-file}@anchor{2383}
@subsubsection Archivo de inicio


Las siguientes funciones se relacionan con el archivo de inicio y la configuración del usuario:

@geindex parse_and_bind() (en el módulo readline)
@anchor{library/readline readline parse_and_bind}@anchor{2384}
@deffn {Función} readline.parse_and_bind (string)

Ejecuta la línea de inicio proporcionada en el argumento `string'. Esto llama a la función @code{rl_parse_and_bind()} de la biblioteca subyacente.
@end deffn

@geindex read_init_file() (en el módulo readline)
@anchor{library/readline readline read_init_file}@anchor{2385}
@deffn {Función} readline.read_init_file ([filename])

Ejecuta un archivo de inicialización readline. El nombre de archivo predeterminado es el último nombre de archivo utilizado. Esto llama a la función @code{rl_read_init_file()} de la biblioteca subyacente.
@end deffn

@node Búfer de línea,Archivo de historial,Archivo de inicio,readline — GNU readline interface
@anchor{library/readline line-buffer}@anchor{2386}
@subsubsection Búfer de línea


Las siguientes funciones operan en el búfer de línea:

@geindex get_line_buffer() (en el módulo readline)
@anchor{library/readline readline get_line_buffer}@anchor{2387}
@deffn {Función} readline.get_line_buffer ()

Retorna el contenido actual del búfer de línea (@code{rl_line_buffer} en la biblioteca subyacente).
@end deffn

@geindex insert_text() (en el módulo readline)
@anchor{library/readline readline insert_text}@anchor{2388}
@deffn {Función} readline.insert_text (string)

Inserta texto en el búfer de línea en la posición del cursor. Esto llama a la función @code{rl_insert_text()} de la biblioteca subyacente, pero ignora el valor de retorno.
@end deffn

@geindex redisplay() (en el módulo readline)
@anchor{library/readline readline redisplay}@anchor{1501}
@deffn {Función} readline.redisplay ()

Cambia lo que se muestra en la pantalla para reflejar el contenido actual del búfer de línea. Esto llama a la función @code{rl_redisplay()} de la biblioteca subyacente.
@end deffn

@node Archivo de historial,Lista del historial,Búfer de línea,readline — GNU readline interface
@anchor{library/readline history-file}@anchor{2389}
@subsubsection Archivo de historial


Las siguientes funciones operan en un archivo de historial:

@geindex read_history_file() (en el módulo readline)
@anchor{library/readline readline read_history_file}@anchor{238a}
@deffn {Función} readline.read_history_file ([filename])

Carga un archivo de historial readline y lo adjunta a la lista de historial. El nombre de archivo predeterminado es @code{~/.history}. Esto llama a la función @code{read_history()} de la biblioteca subyacente.
@end deffn

@geindex write_history_file() (en el módulo readline)
@anchor{library/readline readline write_history_file}@anchor{238b}
@deffn {Función} readline.write_history_file ([filename])

Guarda la lista de historial en un archivo de historial readline, sobrescribiendo cualquier archivo existente. El nombre de archivo predeterminado es @code{~/.history}. Esto llama a la función @code{write_history()} de la biblioteca subyacente.
@end deffn

@geindex append_history_file() (en el módulo readline)
@anchor{library/readline readline append_history_file}@anchor{ed1}
@deffn {Función} readline.append_history_file (nelements[, filename])

Agrega los últimos `nelements' del historial a un archivo. El nombre de archivo predeterminado es @code{~/.history}. El archivo ya debe existir. Esto llama a la función @code{append_history()} de la biblioteca subyacente. Esta función solo existe si Python se compiló para una versión de la biblioteca que lo admita.


Added in version 3.5.

@end deffn

@geindex get_history_length() (en el módulo readline)
@geindex set_history_length() (en el módulo readline)
@anchor{library/readline readline get_history_length}@anchor{238c}
@deffn {Función} readline.get_history_length ()
@anchor{library/readline readline set_history_length}@anchor{15bb}
@deffnx {Función} readline.set_history_length (length)

Establece o retorna el número deseado de líneas para guardar en el archivo de historial. La función @ref{238b,,write_history_file()} usa este valor para truncar el archivo de historial, llamando a la función @code{history_truncate_file()} en la biblioteca subyacente. Los valores negativos implican un tamaño de archivo de historial ilimitado.
@end deffn

@node Lista del historial,Ganchos hooks de inicialización,Archivo de historial,readline — GNU readline interface
@anchor{library/readline history-list}@anchor{238d}
@subsubsection Lista del historial


Las siguientes funciones operan en una lista de historial global:

@geindex clear_history() (en el módulo readline)
@anchor{library/readline readline clear_history}@anchor{238e}
@deffn {Función} readline.clear_history ()

Borra el historial actual. Esto llama a la función @code{clear_history()} en la biblioteca subyacente. La función de Python solo existe si Python se compiló para una versión de la biblioteca que lo admita.
@end deffn

@geindex get_current_history_length() (en el módulo readline)
@anchor{library/readline readline get_current_history_length}@anchor{1500}
@deffn {Función} readline.get_current_history_length ()

Retorna el número de elementos actuales en el historial. (Esto es diferente de la función @ref{238c,,get_history_length()}, que retorna el número máximo de líneas que se escribirán en un archivo de historial).
@end deffn

@geindex get_history_item() (en el módulo readline)
@anchor{library/readline readline get_history_item}@anchor{14ff}
@deffn {Función} readline.get_history_item (index)

Retorna el contenido actual de historial en `index'. El índice comienza en 1. Esto llama a la función @code{history_get()} en la biblioteca subyacente.
@end deffn

@geindex remove_history_item() (en el módulo readline)
@anchor{library/readline readline remove_history_item}@anchor{238f}
@deffn {Función} readline.remove_history_item (pos)

Elimina el objeto del historial definido por su posición del historial. La posición comienza en cero. Esto llama a la función @code{remove_history()} en la biblioteca subyacente.
@end deffn

@geindex replace_history_item() (en el módulo readline)
@anchor{library/readline readline replace_history_item}@anchor{2390}
@deffn {Función} readline.replace_history_item (pos, line)

Reemplaza el elemento del historial especificado por su posición con `line'. La posición comienza en cero. Esto llama a la función @code{replace_history_entry()} en la biblioteca subyacente.
@end deffn

@geindex add_history() (en el módulo readline)
@anchor{library/readline readline add_history}@anchor{2391}
@deffn {Función} readline.add_history (line)

Agrega `line' al búfer de historial, como si fuera la última línea escrita. Esto llama a la función @code{add_history()} en la biblioteca subyacente.
@end deffn

@geindex set_auto_history() (en el módulo readline)
@anchor{library/readline readline set_auto_history}@anchor{d51}
@deffn {Función} readline.set_auto_history (enabled)

Habilita o deshabilita las llamadas automáticas a la función @code{add_history()} al leer la entrada a través de readline. El argumento `enabled' debe ser un valor booleano que cuando es verdadero, habilita el historial automático, y que cuando es falso, desactiva el historial automático.


Added in version 3.6.


`Detalles de implementación de CPython:' `Auto history' está habilitado de forma predeterminada, y cambiarlo no hará que persista en múltiples sesiones.
@end deffn

@node Ganchos hooks de inicialización,Terminación,Lista del historial,readline — GNU readline interface
@anchor{library/readline startup-hooks}@anchor{2392}
@subsubsection Ganchos (`hooks') de inicialización


@geindex set_startup_hook() (en el módulo readline)
@anchor{library/readline readline set_startup_hook}@anchor{2393}
@deffn {Función} readline.set_startup_hook ([function])

Establece o elimina la función invocada por la función de retorno @code{rl_startup_hook} de la biblioteca subyacente. Si se especifica `function', se utilizará como la nueva función de enlace; Si se omite o es @code{None}, se elimina cualquier función ya instalada. La función de devolución de llamada se llama sin argumentos justo antes de que readline muestre el primer símbolo del sistema.
@end deffn

@geindex set_pre_input_hook() (en el módulo readline)
@anchor{library/readline readline set_pre_input_hook}@anchor{2394}
@deffn {Función} readline.set_pre_input_hook ([function])

Establece o elimina la función invocada por la función de retorno @code{rl_pre_input_hook} de la biblioteca subyacente. Si se especifica `function', se utilizará como la nueva función de devolución de llamada; Si se omite o es @code{None}, se elimina cualquier función ya instalada. La función de devolución de llamada se llama sin argumentos después de que se haya visualizado el primer símbolo del sistema y justo antes de que readline comience a leer los caracteres ingresados. Esta función solo existe si Python se ha compilado para una versión de la biblioteca que lo admite.
@end deffn

@node Terminación,Ejemplo,Ganchos hooks de inicialización,readline — GNU readline interface
@anchor{library/readline completion}@anchor{2395}@anchor{library/readline readline-completion}@anchor{2396}
@subsubsection Terminación


Las siguientes funciones se relacionan con la implementación de una función de finalización de palabra personalizada. Esto típicamente es operado por la tecla `Tab' y puede sugerir y completar automáticamente una palabra que se está escribiendo. Por defecto, Readline está configurado para ser utilizado por @ref{bd,,rlcompleter} para completar los identificadores de Python para el intérprete interactivo. Si el módulo @ref{ba,,readline} se va a utilizar con una terminación específica, se debe definir un conjunto de palabras delimitadoras.

@geindex set_completer() (en el módulo readline)
@anchor{library/readline readline set_completer}@anchor{2397}
@deffn {Función} readline.set_completer ([function])

Establece o elimina la función de finalización. Si se especifica `function', se usará como la nueva función de finalización; Si se omite o es @code{None}, se elimina cualquier función de finalización ya instalada. La función completa se llama como @code{function(text, state)}, para `state' en @code{0}, @code{1}, @code{2}, …, hasta que retorna un valor que no es una cadena de caracteres. Debería retornar las siguientes terminaciones posibles comenzando con `text'.

La función de finalización instalada es invocada por la función de retorno `entry_func' que se pasa a @code{rl_completion_matches()} en la biblioteca subyacente. La cadena de texto va desde el primer parámetro a la función de retorno @code{rl_attempted_completion_function} de la biblioteca subyacente.
@end deffn

@geindex get_completer() (en el módulo readline)
@anchor{library/readline readline get_completer}@anchor{2398}
@deffn {Función} readline.get_completer ()

Obtiene la función de finalización o @code{None} si no se ha definido ninguna función de finalización.
@end deffn

@geindex get_completion_type() (en el módulo readline)
@anchor{library/readline readline get_completion_type}@anchor{2399}
@deffn {Función} readline.get_completion_type ()

Obtiene el tipo de finalización que se está intentando. Esto retorna la variable @code{rl_completion_type} en la biblioteca subyacente como un entero.
@end deffn

@geindex get_begidx() (en el módulo readline)
@geindex get_endidx() (en el módulo readline)
@anchor{library/readline readline get_begidx}@anchor{18ef}
@deffn {Función} readline.get_begidx ()
@anchor{library/readline readline get_endidx}@anchor{18f0}
@deffnx {Función} readline.get_endidx ()

Obtenga el índice inicial o final del alcance de finalización. Estos índices son los argumentos `start' y `end' pasados a la devolución de llamada @code{rl_attempted_completion_function} de la biblioteca subyacente. Los valores pueden ser diferentes en el mismo escenario de edición de entrada según la implementación de la línea de lectura de C subyacente. Ejemplo: se sabe que libedit se comporta de manera diferente a libreadline.
@end deffn

@geindex set_completer_delims() (en el módulo readline)
@geindex get_completer_delims() (en el módulo readline)
@anchor{library/readline readline set_completer_delims}@anchor{16bb}
@deffn {Función} readline.set_completer_delims (string)
@anchor{library/readline readline get_completer_delims}@anchor{239a}
@deffnx {Función} readline.get_completer_delims ()

Define o recupera palabras delimitadoras para completar. Estos determinan el comienzo de la palabra que se considerará para su finalización (el contexto de finalización). Estas funciones acceden a la variable @code{rl_completer_word_break_characters} desde la biblioteca subyacente.
@end deffn

@geindex set_completion_display_matches_hook() (en el módulo readline)
@anchor{library/readline readline set_completion_display_matches_hook}@anchor{239b}
@deffn {Función} readline.set_completion_display_matches_hook ([function])

Establece o elimina la función de visualización de finalización. Si se especifica `function', se utilizará como una nueva función de visualización de finalización; si se omite o es @code{None}, se elimina cualquier función de finalización ya instalada. Esto establece o elimina la función de retorno @code{rl_completion_display_matches_hook} de la biblioteca subyacente. La función de visualización de finalización se llama tal como la @code{function(substitution, [matches], longest_match_length)} solo una vez cuando se muestran las coincidencias.
@end deffn

@node Ejemplo,,Terminación,readline — GNU readline interface
@anchor{library/readline example}@anchor{239c}@anchor{library/readline readline-example}@anchor{239d}
@subsubsection Ejemplo


El siguiente ejemplo muestra cómo usar las funciones de lectura y escritura del historial del módulo @ref{ba,,readline} para cargar o guardar automáticamente un archivo de historial llamado @code{.python_history} desde el directorio de inicio del usuario. El siguiente código normalmente debe ejecutarse automáticamente durante una sesión interactiva desde el archivo de usuario 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}.

@example
import atexit
import os
import readline

histfile = os.path.join(os.path.expanduser("~"), ".python_history")
try:
    readline.read_history_file(histfile)
    # default history len is -1 (infinite), which may grow unruly
    readline.set_history_length(1000)
except FileNotFoundError:
    pass

atexit.register(readline.write_history_file, histfile)
@end example

Este código se ejecuta automáticamente cuando Python se ejecuta en @ref{1045,,modo interactivo} (ver @ref{1048,,Configuración de Readline}).

El siguiente ejemplo logra el mismo objetivo pero administra sesiones interactivas concurrentes, agregando solo el nuevo historial.

@example
import atexit
import os
import readline
histfile = os.path.join(os.path.expanduser("~"), ".python_history")

try:
    readline.read_history_file(histfile)
    h_len = readline.get_current_history_length()
except FileNotFoundError:
    open(histfile, 'wb').close()
    h_len = 0

def save(prev_h_len, histfile):
    new_h_len = readline.get_current_history_length()
    readline.set_history_length(1000)
    readline.append_history_file(new_h_len - prev_h_len, histfile)
atexit.register(save, h_len, histfile)
@end example

El siguiente ejemplo amplía la clase @ref{239e,,code.InteractiveConsole} para administrar el guardado/restauración del historial.

@example
import atexit
import code
import os
import readline

class HistoryConsole(code.InteractiveConsole):
    def __init__(self, locals=None, filename="<console>",
                 histfile=os.path.expanduser("~/.console-history")):
        code.InteractiveConsole.__init__(self, locals, filename)
        self.init_history(histfile)

    def init_history(self, histfile):
        readline.parse_and_bind("tab: complete")
        if hasattr(readline, "read_history_file"):
            try:
                readline.read_history_file(histfile)
            except FileNotFoundError:
                pass
            atexit.register(self.save_history, histfile)

    def save_history(self, histfile):
        readline.set_history_length(1000)
        readline.write_history_file(histfile)
@end example

@node rlcompleter — Completion function for GNU readline,,readline — GNU readline interface,Servicios de procesamiento de texto
@anchor{library/rlcompleter doc}@anchor{239f}@anchor{library/rlcompleter module-rlcompleter}@anchor{bd}@anchor{library/rlcompleter rlcompleter-completion-function-for-gnu-readline}@anchor{23a0}
@subsection @code{rlcompleter} — Completion function for GNU readline


@geindex module; rlcompleter

`Código fuente:' Lib/rlcompleter.py@footnote{https://github.com/python/cpython/tree/main/Lib/rlcompleter.py}


__________________________________________________________________


The @code{rlcompleter} module defines a completion function suitable to be
passed to @ref{2397,,set_completer()} in the @ref{ba,,readline} module.

When this module is imported on a Unix platform with the @ref{ba,,readline} module
available, an instance of the @ref{194e,,Completer} class is automatically created
and its @ref{23a1,,complete()} method is set as the
@ref{2396,,readline completer}. The method provides
completion of valid Python @ref{1e94,,identifiers and keywords}.

Ejemplo:

@example
>>> import rlcompleter
>>> import readline
>>> readline.parse_and_bind("tab: complete")
>>> readline. <TAB PRESSED>
readline.__doc__          readline.get_line_buffer(  readline.read_init_file(
readline.__file__         readline.insert_text(      readline.set_completer(
readline.__name__         readline.parse_and_bind(
>>> readline.
@end example

The @code{rlcompleter} module is designed for use with Python’s
@ref{1045,,interactive mode}.  Unless Python is run with the
@ref{1217,,-S} option, the module is automatically imported and configured
(see @ref{1048,,Configuración de Readline}).

En plataformas sin @ref{ba,,readline}, la clase @ref{194e,,Completer} definida por este módulo puede ser usada igualmente para fines personalizados.

@geindex Completer (clase en rlcompleter)
@anchor{library/rlcompleter completer-objects}@anchor{23a2}@anchor{library/rlcompleter rlcompleter Completer}@anchor{194e}
@deffn {Clase} rlcompleter.Completer

Los objetos de completado tienen el siguiente método:

@geindex complete() (método de rlcompleter.Completer)
@anchor{library/rlcompleter rlcompleter Completer complete}@anchor{23a1}
@deffn {Método} complete (text, state)

Return the next possible completion for `text'.

When called by the @ref{ba,,readline} module, this method is called
successively with @code{state == 0, 1, 2, ...} until the method returns
@code{None}.

Si es invocado para `text' que no incluye un caracter de punto (@code{'.'}), este completará con nombres actualmente definidos en @ref{1,,__main__}, @ref{13,,builtins} y las palabras clave (tal y como están definidas en el módulo @ref{84,,keyword}).

If called for a dotted name, it will try to evaluate anything without obvious
side-effects (functions will not be evaluated, but it can generate calls to
@ref{57a,,__getattr__()}) up to the last part, and find matches for the
rest via the @ref{6d3,,dir()} function.  Any exception raised during the
evaluation of the expression is caught, silenced and @ref{716,,None} is
returned.
@end deffn
@end deffn

@node Servicios de datos binarios,Tipos de datos,Servicios de procesamiento de texto,La biblioteca estándar de Python
@anchor{library/binary doc}@anchor{23a3}@anchor{library/binary binary-data-services}@anchor{23a4}@anchor{library/binary binaryservices}@anchor{22bf}
@section Servicios de datos binarios


Los módulos descritos en este capítulo proporcionan algunas operaciones básicas de servicios para la manipulación de datos binarios. Otras operaciones sobre datos binarios específicamente relacionadas con formatos de archivo y protocolos de red están descritas en las secciones relevantes.

Algunas bibliotecas descritas bajo @ref{21c3,,Servicios de procesamiento de texto} también funcionan o bien sobre formatos binarios compatibles con ASCII (por ejemplo @ref{b9,,re}), o bien sobre todos los datos binarios (por ejemplo @ref{38,,difflib}).

Adicionalmente, véase la documentación para los tipos de datos binarios incorporados en Python en @ref{2166,,Tipos de secuencias binarias — bytes@comma{} bytearray y memoryview}.

@menu
* struct — Interpret bytes as packed binary data:: 
* codecs — Codec registry and base classes:: 

@end menu

@node struct — Interpret bytes as packed binary data,codecs — Codec registry and base classes,,Servicios de datos binarios
@anchor{library/struct doc}@anchor{23a5}@anchor{library/struct struct-interpret-bytes-as-packed-binary-data}@anchor{23a6}
@subsection @code{struct} — Interpret bytes as packed binary data


@c from struct import *

@geindex module; struct
@anchor{library/struct module-struct}@anchor{d5}
`Código fuente:' Lib/struct.py@footnote{https://github.com/python/cpython/tree/main/Lib/struct.py}

@geindex C;estructuras
@geindex empaquetado;binario;datos


__________________________________________________________________


Este módulo convierte entre valores de Python y estructuras de C representadas como objetos de Python @ref{325,,bytes}. Las @ref{23a7,,cadenas de formato} compacto describen las conversiones previstas hacia/desde valores de Python. Las funciones y objetos del módulo se pueden utilizar para dos aplicaciones en gran medida distintas, el intercambio de datos con fuentes externas (archivos o conexiones de red) o la transferencia de datos entre la aplicación de Python y la capa de C.

@cartouche
@quotation Nota 
Cuando no se proporciona ningún carácter de prefijo, el modo nativo es el predeterminado. Empaqueta o desempaqueta datos según la plataforma y el compilador en el que se creó el intérprete de Python. El resultado de empaquetar una estructura C determinada incluye bytes de relleno que mantienen la alineación adecuada para los tipos C involucrados; asimismo, se tiene en cuenta la alineación al desempaquetar. Por el contrario, cuando se comunican datos entre fuentes externas, el programador es responsable de definir el orden de bytes y el relleno entre elementos. Ver @ref{23a8,,Orden de bytes@comma{} tamaño y alineación} para más detalles.
@end quotation
@end cartouche

Varias funciones @ref{d5,,struct} (y métodos de @ref{16b9,,Struct}) toman un argumento `buffer'.  Esto hace referencia a los objetos que implementan @ref{48a,,Protocolo búfer} y proporcionan un búfer de lectura o de lectura/escritura.  Los tipos más comunes utilizados para ese propósito son @ref{325,,bytes} y @ref{5e0,,bytearray}, pero muchos otros tipos que se pueden ver como una lista de bytes implementan el protocolo de búfer, para que se puedan leer/rellenar sin necesidad de copiar a partir de un objeto @ref{325,,bytes}.

@menu
* Funciones y excepciones:: 
* Cadenas de formato:: 
* Aplicaciones:: 
* Clases: Clases<3>. 

@end menu

@node Funciones y excepciones,Cadenas de formato,,struct — Interpret bytes as packed binary data
@anchor{library/struct functions-and-exceptions}@anchor{23a9}
@subsubsection Funciones y excepciones


El módulo define la siguiente excepción y funciones:

@geindex error
@anchor{library/struct struct error}@anchor{138b}
@deffn {Excepción} struct.error

Excepción lanzada en varias ocasiones; el argumento es una `string' que describe lo que está mal.
@end deffn

@geindex pack() (en el módulo struct)
@anchor{library/struct struct pack}@anchor{12e4}
@deffn {Función} struct.pack (format, v1, v2, ...)

Retorna un objeto bytes que contiene los valores `v1', `v2', … empaquetado de acuerdo con la cadena de formato `format'.  Los argumentos deben coincidir exactamente con los valores requeridos por el formato.
@end deffn

@geindex pack_into() (en el módulo struct)
@anchor{library/struct struct pack_into}@anchor{23aa}
@deffn {Función} struct.pack_into (format, buffer, offset, v1, v2, ...)

Empaqueta los valores `v1', `v2', … de acuerdo con la cadena de formato `format' y escribe los bytes empaquetados en el búfer de escritura `buffer' comenzando en la posición `offset'.  Nota: `offset' es un argumento obligatorio.
@end deffn

@geindex unpack() (en el módulo struct)
@anchor{library/struct struct unpack}@anchor{17ce}
@deffn {Función} struct.unpack (format, buffer)

Desempaqueta del búfer `buffer' (normalmente empaquetado por @code{pack(format, ...)}) según la cadena de formato `format'.  El resultado es una tupla incluso si contiene un solo elemento.  El tamaño del búfer en bytes debe coincidir con el tamaño requerido por el formato, como se refleja en @ref{19cd,,calcsize()}.
@end deffn

@geindex unpack_from() (en el módulo struct)
@anchor{library/struct struct unpack_from}@anchor{23ab}
@deffn {Función} struct.unpack_from (format, /, buffer, offset=0)

Desempaqueta del `buffer' comenzando en la posición `offset', según la cadena de formato `format'.  El resultado es una tupla incluso si contiene un solo elemento.  El tamaño del búfer en bytes, comenzando en la posición `offset', debe tener al menos el tamaño requerido por el formato, como se refleja en @ref{19cd,,calcsize()}.
@end deffn

@geindex iter_unpack() (en el módulo struct)
@anchor{library/struct struct iter_unpack}@anchor{103d}
@deffn {Función} struct.iter_unpack (format, buffer)

Desempaqueta de manera iterativa desde el búfer `buffer' según la cadena de formato `format'.  Esta función retorna un iterador que leerá fragmentos de igual tamaño desde el búfer hasta que se haya consumido todo su contenido. El tamaño del búfer en bytes debe ser un múltiplo del tamaño requerido por el formato, como se refleja en @ref{19cd,,calcsize()}.

Cada iteración produce una tupla según lo especificado por la cadena de formato.


Added in version 3.4.

@end deffn

@geindex calcsize() (en el módulo struct)
@anchor{library/struct struct calcsize}@anchor{19cd}
@deffn {Función} struct.calcsize (format)

Retorna el tamaño de la estructura (y, por lo tanto, del objeto bytes generado por @code{pack(format, ...)}) correspondiente a la cadena de formato `format'.
@end deffn

@node Cadenas de formato,Aplicaciones,Funciones y excepciones,struct — Interpret bytes as packed binary data
@anchor{library/struct format-strings}@anchor{23ac}@anchor{library/struct struct-format-strings}@anchor{23a7}
@subsubsection Cadenas de formato


Las cadenas de formato describen el diseño de los datos cuando empaquetan y desempaquetan datos. Se construyen a partir @ref{23ad,,caracteres de formato}, que especifican el tipo de datos que se empaquetan/desempaquetan. Además, los caracteres especiales controlan el @ref{23a8,,orden de bytes@comma{} tamaño y alineación}. Cada cadena de formato consta de un carácter de prefijo opcional que describe las propiedades generales de los datos y uno o más caracteres de formato que describen los valores de datos actuales y el relleno.

@menu
* Orden de bytes@comma{} tamaño y alineación: Orden de bytes tamaño y alineación. 
* Caracteres de formato:: 
* Ejemplos: Ejemplos<2>. 

@end menu

@node Orden de bytes tamaño y alineación,Caracteres de formato,,Cadenas de formato
@anchor{library/struct byte-order-size-and-alignment}@anchor{23ae}@anchor{library/struct struct-alignment}@anchor{23a8}
@subsubsection Orden de bytes, tamaño y alineación


Por defecto, los tipos C se representan en el formato nativo y el orden de bytes de la máquina, y se alinean correctamente omitiendo `bytes' de relleno si es necesario (según las reglas utilizadas por el compilador de C). Se elige este comportamiento para que los bytes de una estructura empaquetada correspondan correctamente al diseño de memoria de la estructura C correspondiente. El uso de ordenamiento y relleno de bytes nativos o formatos estándar depende de la aplicación.

@geindex @@ (en);en cadenas de formato de estructura
@geindex = (igual a);en cadenas de formato de estructura
@geindex < (menor que);en cadenas de formato de estructura
@geindex > (mayor que);en cadenas de formato de estructura
@geindex ! (exclamación);en cadenas de formato de estructura

Como alternativa, el primer carácter de la cadena de formato se puede utilizar para indicar el orden de bytes, el tamaño y la alineación de los datos empaquetados, según la tabla siguiente:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Carácter

@tab

Orden de bytes

@tab

Tamaño

@tab

Alineamiento

@item

@code{@@}

@tab

nativo

@tab

nativo

@tab

nativo

@item

@code{=}

@tab

nativo

@tab

standard

@tab

none

@item

@code{<}

@tab

little-endian

@tab

standard

@tab

none

@item

@code{>}

@tab

big-endian

@tab

standard

@tab

none

@item

@code{!}

@tab

red (= big-endian)

@tab

standard

@tab

none

@end multitable


Si el primer carácter no es uno de estos, se asume @code{'@@'}.

@cartouche
@quotation Nota 
The number 1023 (@code{0x3ff} in hexadecimal) has the following byte representations:


@itemize *

@item 
@code{03 ff} in big-endian (@code{>})

@item 
@code{ff 03} in little-endian (@code{<})
@end itemize

Python example:

@example
>>> import struct
>>> struct.pack('>h', 1023)
b'\x03\xff'
>>> struct.pack('<h', 1023)
b'\xff\x03'
@end example
@end quotation
@end cartouche

El orden de bytes nativo es big-endian o little-endian, dependiendo del sistema host. Por ejemplo, Intel x86, AMD64 (x86-64) y Apple M1 son little-endian; IBM z y muchas arquitecturas heredadas son big-endian; ARM e Intel `Itanium' tienen la propiedad de trabajar con ambos formatos (middle-endian). Utiliza @ref{21a3,,sys.byteorder} para comprobar la endianness («extremidad») de tu sistema.

El tamaño y la alineación nativos se determinan mediante la expresión @code{sizeof} del compilador de C.  Esto siempre se combina con el orden de bytes nativo.

El tamaño estándar depende únicamente del carácter de formato;  ver la tabla en la sección @ref{23ad,,Caracteres de formato}.

Nótese la diferencia entre @code{'@@'} y @code{'='} : ambos utilizan el orden de bytes nativo, pero el tamaño y la alineación de este último está estandarizado.

La forma @code{'!'} representa el orden de bytes en la red, el cuál siempre es big-endian tal como se define en IETF RFC 1700@footnote{https://datatracker.ietf.org/doc/html/rfc1700}.

No hay manera de indicar el orden de bytes no nativo (forzar el intercambio de bytes); utiliza la elección adecuada de @code{'<'} o @code{'>'}.

Notas:


@enumerate 

@item 
El relleno solo se agrega automáticamente entre los miembros sucesivos de la estructura. No se agrega ningún relleno al principio o al final de la estructura codificada.

@item 
No se añade ningún relleno cuando se utiliza el tamaño y la alineación no nativos, por ejemplo, con “<”, “>”, “=” y “!”.

@item 
Para alinear el final de una estructura con el requisito de alineación de un tipo determinado, termina el formato con el código de ese tipo con un conteo repetido de ceros.  Véase @ref{23af,,Ejemplos}.
@end enumerate

@node Caracteres de formato,Ejemplos<2>,Orden de bytes tamaño y alineación,Cadenas de formato
@anchor{library/struct format-characters}@anchor{23ad}@anchor{library/struct id1}@anchor{23b0}
@subsubsection Caracteres de formato


Los caracteres de formato tienen el siguiente significado; la conversión entre los valores de C y Python debe ser obvia dados sus tipos.  La columna “Tamaño estándar” hace referencia al tamaño del valor empaquetado en bytes cuando se utiliza el tamaño estándar; es decir, cuando la cadena de formato comienza con uno de @code{'<'}, @code{'>'}, @code{'!'} o @code{'='}.  Cuando se utiliza el tamaño nativo, el tamaño del valor empaquetado depende de la plataforma.


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Formato

@tab

Tipo C

@tab

Tipo Python

@tab

Tamaño estándar

@tab

Notas

@item

@code{x}

@tab

byte de relleno

@tab

sin valor

@tab

@tab

(7)

@item

@code{c}

@tab

char

@tab

bytes de longitud 1

@tab

1

@tab

@item

@code{b}

@tab

signed char

@tab

integer

@tab

1

@tab

(1), (2)

@item

@code{B}

@tab

unsigned char

@tab

integer

@tab

1

@tab

(2)

@item

(2)

@tab

_Bool

@tab

bool

@tab

1

@tab

(1)

@item

@code{h}

@tab

short

@tab

integer

@tab

2

@tab

(2)

@item

@code{H}

@tab

unsigned short

@tab

integer

@tab

2

@tab

(2)

@item

@code{i}

@tab

int

@tab

integer

@tab

4

@tab

(2)

@item

@code{I}

@tab

unsigned int

@tab

integer

@tab

4

@tab

(2)

@item

@code{l}

@tab

long

@tab

integer

@tab

4

@tab

(2)

@item

@code{L}

@tab

unsigned long

@tab

integer

@tab

4

@tab

(2)

@item

@code{q}

@tab

long long

@tab

integer

@tab

8

@tab

(2)

@item

@code{Q}

@tab

unsigned long long

@tab

integer

@tab

8

@tab

(2)

@item

@code{n}

@tab

@code{ssize_t}

@tab

integer

@tab

@tab

(3)

@item

@code{N}

@tab

@code{size_t}

@tab

integer

@tab

@tab

(3)

@item

@code{e}

@tab

(6)

@tab

float

@tab

2

@tab

(4)

@item

@code{f}

@tab

float

@tab

float

@tab

4

@tab

(4)

@item

@code{d}

@tab

double

@tab

float

@tab

8

@tab

(4)

@item

@code{s}

@tab

char[]

@tab

bytes

@tab

@tab

(9)

@item

@code{p}

@tab

char[]

@tab

bytes

@tab

@tab

(8)

@item

@code{P}

@tab

void*

@tab

integer

@tab

@tab

(5)

@end multitable


Additionally, if IEC 60559 compatible complex arithmetic (Annex G of the
C11 standard) is supported, the following format characters are available:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Formato

@tab

Tipo C

@tab

Tipo Python

@tab

Tamaño estándar

@tab

Notas

@item

@code{E}

@tab

float complex

@tab

complex

@tab

8

@tab

(10)

@item

@code{C}

@tab

double complex

@tab

complex

@tab

16

@tab

(10)

@end multitable



Distinto en la versión 3.3: Soporte añadido para los formatos @code{'n'} y @code{'N'}.



Distinto en la versión 3.6: Soporte añadido para el formato @code{'e'}.



Distinto en la versión 3.14: Added support for the @code{'E'} and @code{'C'} formats.


Notas:


@enumerate 

@item 
@geindex ? (signo de interrogación);en cadenas de formato de estructura

The @code{'?'} conversion code corresponds to the _Bool type
defined by C standards since C99.  In standard mode, it is
represented by one byte.

@item 
Al intentar empaquetar un no entero mediante cualquiera de los códigos de conversión de enteros, si el no entero tiene un método @ref{22b,,__index__()}, se llama a ese método para convertir el argumento en un entero antes de empaquetar.


Distinto en la versión 3.2: Agregado el uso del método @ref{22b,,__index__()} para los no enteros.


@item 
Los códigos de conversión @code{'n'} y @code{'N'} solo están disponibles para el tamaño nativo (seleccionado como predeterminado o con el carácter de orden de bytes @code{'@@'}). Para el tamaño estándar, puedes usar cualquiera de los otros formatos enteros que se ajusten a tu aplicación.

@item 
Para los códigos de conversión @code{'f'}, @code{'d'} y @code{'e'}, la representación empaquetada utiliza el formato IEEE 754 binary32, binary64 o binary16 (para @code{'f'}, @code{'d'} o @code{'e'} respectivamente), independientemente del formato de punto flotante utilizado por la plataforma.

@item 
El carácter de formato @code{'P'} solo está disponible para el orden nativo de bytes (seleccionado como predeterminado o con el carácter de orden de bytes @code{'@@'}). El carácter de orden de bytes @code{'='} elige utilizar el orden little- o big-endian basado en el sistema host. El módulo `struct' no interpreta esto como un orden nativo, por lo que el formato @code{'P'} no está disponible.

@item 
El tipo IEEE 754 binary16 «half precision» se introdujo en la revisión de 2008 del IEEE 754 estándar@footnote{https://en.wikipedia.org/wiki/IEEE_754-2008_revision}. Tiene un bit de signo, un exponente de 5 bits y una precisión de 11 bits (con 10 bits almacenados explícitamente) y puede representar números entre aproximadamente @code{6.1e-05} y @code{6.5e+04} con total precisión. Este tipo no es ampliamente compatible con los compiladores de C: en un equipo típico, un `unsigned' short se puede usar para el almacenamiento, pero no para las operaciones matemáticas. Consulte la página de Wikipedia en el formato de punto flotante de media precisión@footnote{https://en.wikipedia.org/wiki/Half-precision_floating-point_format} para obtener más información.

@item 
Al empaquetar, @code{'x'} inserta un byte NUL.

@item 
El carácter de formato @code{'p'} codifica una «cadena de Pascal», lo que significa una cadena de longitud variable corta almacenada en un número `fijo de bytes', dado por el recuento. El primer byte almacenado es el valor mínimo entre la longitud de la cadena o 255.  A continuación se encuentran los bytes de la cadena.  Si la cadena pasada a @ref{12e4,,pack()} es demasiado larga (más larga que la cuenta menos 1), solo se almacenan los bytes iniciales @code{count-1} de la cadena.  Si la cadena es más corta que @code{count-1}, se rellena con bytes nulos para que se utilicen exactamente los bytes de recuento en total.  Tenga en cuenta que para @ref{17ce,,unpack()}, el carácter de formato @code{'p'} consume bytes @code{count}, pero que la cadena retornada nunca puede contener más de 255 bytes.

@item 
Para el carácter de formato @code{'s'}, el recuento se interpreta como la longitud de los bytes, no un recuento de repetición como para los otros caracteres de formato; por ejemplo, @code{'10s'} significa una sola cadena de 10 bytes asignada hacia o desde una sola cadena de bytes de Python, mientras que @code{'10c'} significa 10 elementos de caracteres separados de un byte (por ejemplo, @code{cccccccccc}) asignada hacia o desde diez objetos de `bytes' de Python diferentes. (Ver @ref{23af,,Ejemplos} para una demostración concreta de la diferencia.) Si no se da un recuento, el valor predeterminado es 1. Para el empaquetado, la cadena es truncada o rellenada con bytes nulos según corresponda para que se ajuste. Para desempaquetar, el objeto bytes resultante siempre tiene exactamente el número especificado de bytes. Como caso especial, @code{'0s'} significa una sola cadena vacía (mientras que @code{'0c'} significa 0 caracteres).

@item 
For the @code{'E'} and @code{'C'} format characters, the packed representation uses
the IEEE 754 binary32 and binary64 format for components of the complex
number, regardless of the floating-point format used by the platform.
@end enumerate

Un carácter de formato puede ir precedido de un número de recuento que repite tantas veces el carácter.  Por ejemplo, la cadena de formato @code{'4h'} significa exactamente lo mismo que @code{'hhhh'} .

Se omiten los caracteres de espacio entre formatos; sin embargo, un recuento y su formato no deben contener espacios en blanco.

Al empaquetar un valor @code{x} utilizando uno de los formatos enteros (@code{'b'}, @code{'B'}, @code{'h'}, @code{'H'}, @code{'i'}, @code{'I'}, @code{'l'}, @code{'L'}, @code{'q'}, @code{'Q'}), si @code{x} está fuera de un rango válido para ese formato, entonces se lanza la excepción @ref{138b,,struct.error}.


Distinto en la versión 3.1: Anteriormente, algunos de los formatos enteros ajustaban los valores fuera de rango y lanzaban @ref{1da,,DeprecationWarning} en vez de @ref{138b,,struct.error}.


@geindex ? (signo de interrogación);en cadenas de formato de estructura

Para el carácter de formato @code{'?'}, el valor retornado es @ref{c95,,True} o @ref{bbf,,False}. Al empaquetar, se utiliza el valor verdadero del objeto del argumento. Se empaquetará 0 o 1 en la representación `bool' nativa o estándar, y cualquier valor distinto de cero será @code{True} al desempaquetar.

@node Ejemplos<2>,,Caracteres de formato,Cadenas de formato
@anchor{library/struct examples}@anchor{23b1}@anchor{library/struct struct-examples}@anchor{23af}
@subsubsection Ejemplos


@cartouche
@quotation Nota 
Los ejemplos de orden de bytes nativos (designados por el prefijo de formato @code{'@@'} o la falta de cualquier carácter de prefijo) pueden no coincidir con lo que produce la máquina del lector, ya que eso depende de la plataforma y el compilador.
@end quotation
@end cartouche

Empaqueta y desempaqueta enteros de tres tamaños diferentes, utilizando el orden `big endian':

@example
>>> from struct import *
>>> pack(">bhl", 1, 2, 3)
b'\x01\x00\x02\x00\x00\x00\x03'
>>> unpack('>bhl', b'\x01\x00\x02\x00\x00\x00\x03')
(1, 2, 3)
>>> calcsize('>bhl')
7
@end example

Intenta empaquetar un entero que es demasiado grande para el campo definido:

@example
>>> pack(">h", 99999)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
struct.error: 'h' format requires -32768 <= number <= 32767
@end example

Demuestra la diferencia entre los caracteres de formato @code{'s'} y @code{'c'}:

@example
>>> pack("@@ccc", b'1', b'2', b'3')
b'123'
>>> pack("@@3s", b'123')
b'123'
@end example

Los campos desempaquetados se pueden nombrar asignándolos a variables o ajustando el resultado en una tupla con nombre:

@example
>>> record = b'raymond   \x32\x12\x08\x01\x08'
>>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)

>>> from collections import namedtuple
>>> Student = namedtuple('Student', 'name serialnum school gradelevel')
>>> Student._make(unpack('<10sHHb', record))
Student(name=b'raymond   ', serialnum=4658, school=264, gradelevel=8)
@end example

El orden de los caracteres de formato puede afectar el tamaño en el modo nativo, ya que el relleno está implícito. En el modo estándar, el usuario es responsable de insertar el relleno que desee. Toma en cuenta que en la primera llamada @code{pack} a continuación se agregaron tres bytes NUL después del @code{'#'} empaquetado para alinear el siguiente entero en un límite de cuatro bytes. En este ejemplo, el resultado se produjo en una máquina little endian:

@example
>>> pack('@@ci', b'#', 0x12131415)
b'#\x00\x00\x00\x15\x14\x13\x12'
>>> pack('@@ic', 0x12131415, b'#')
b'\x15\x14\x13\x12#'
>>> calcsize('@@ci')
8
>>> calcsize('@@ic')
5
@end example

El siguiente formato @code{'llh0l'} especifica dos bytes de relleno al final, suponiendo que los tipos `longs' están alineados en los límites de 4 bytes:

@example
>>> pack('@@llh0l', 1, 2, 3)
b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{8,,array}

Almacenamiento binario empaquetado de datos homogéneos.

@item Módulo @ref{82,,json}

Codificador y decodificador JSON.

@item Módulo @ref{a6,,pickle}

Serialización de objetos Python.
@end table


@node Aplicaciones,Clases<3>,Cadenas de formato,struct — Interpret bytes as packed binary data
@anchor{library/struct applications}@anchor{23b2}@anchor{library/struct id2}@anchor{23b3}
@subsubsection Aplicaciones


Existen dos aplicaciones principales para el módulo @ref{d5,,struct}, el intercambio de datos entre el código Python y C dentro de una aplicación u otra aplicación compilada usando el mismo compilador (@ref{23b4,,formatos nativos}) y el intercambio de datos entre aplicaciones usando un diseño de datos acordado (@ref{23b5,,formatos estándar}). En términos generales, las cadenas de formato construidas para estos dos dominios son distintas.

@menu
* Formatos nativos:: 
* Formatos estándar:: 

@end menu

@node Formatos nativos,Formatos estándar,,Aplicaciones
@anchor{library/struct native-formats}@anchor{23b6}@anchor{library/struct struct-native-formats}@anchor{23b4}
@subsubsection Formatos nativos


Al construir cadenas de formato que imitan diseños nativos, el compilador y la arquitectura de la máquina determinan el orden y el relleno de los bytes. En tales casos, se debe utilizar el carácter de formato @code{@@} para especificar el orden de bytes nativo y el tamaño de los datos. Los bytes de relleno internos normalmente se insertan automáticamente. Es posible que se necesite un código de formato de repetición cero al final de una cadena de formato para redondear hasta el límite de bytes correcto para una alineación adecuada de fragmentos de datos consecutivos.

Considera estos dos ejemplos sencillos (en una máquina little-endian de 64 bits):

@example
>>> calcsize('@@lhl')
24
>>> calcsize('@@llh')
18
@end example

Los datos no se rellenan hasta un límite de 8 bytes al final de la segunda cadena de formato sin el uso de relleno adicional. Un código de formato de repetición cero resuelve ese problema:

@example
>>> calcsize('@@llh0l')
24
@end example

El código de formato @code{'x'} se puede utilizar para especificar la repetición, pero para formatos nativos es mejor utilizar un formato de repetición cero como @code{'0l'}.

De forma predeterminada, se utiliza el orden y la alineación de bytes nativos, pero es mejor ser explícito y utilizar el carácter de prefijo @code{'@@'}.

@node Formatos estándar,,Formatos nativos,Aplicaciones
@anchor{library/struct standard-formats}@anchor{23b7}@anchor{library/struct struct-standard-formats}@anchor{23b5}
@subsubsection Formatos estándar


Cuando intercambia datos más allá de su proceso, como redes o almacenamiento, sé preciso. Especifica el orden de bytes, el tamaño y la alineación exactos. No asumas que coinciden con el orden nativo de una máquina en particular. Por ejemplo, el orden de los bytes de la red es big-endian, mientras que muchas CPU populares son little-endian. Al definir esto explícitamente, el usuario no necesita preocuparse por las especificaciones de la plataforma en la que se ejecuta su código. El primer carácter normalmente debería ser @code{<} o @code{>} (o @code{!}). El relleno es responsabilidad del programador. El carácter de formato de repetición cero no funcionará. En su lugar, el usuario debe agregar explícitamente @code{'x'} bytes de relleno donde sea necesario. Revisando los ejemplos de la sección anterior, tenemos:

@example
>>> calcsize('<qh6xq')
24
>>> pack('<qh6xq', 1, 2, 3) == pack('@@lhl', 1, 2, 3)
True
>>> calcsize('@@llh')
18
>>> pack('@@llh', 1, 2, 3) == pack('<qqh', 1, 2, 3)
True
>>> calcsize('<qqh6x')
24
>>> calcsize('@@llh0l')
24
>>> pack('@@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
True
@end example

No se garantiza que los resultados anteriores (ejecutados en una máquina de 64 bits) coincidan cuando se ejecutan en diferentes máquinas. Por ejemplo, los siguientes ejemplos se ejecutaron en una máquina de 32 bits:

@example
>>> calcsize('<qqh6x')
24
>>> calcsize('@@llh0l')
12
>>> pack('@@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
False
@end example

@node Clases<3>,,Aplicaciones,struct — Interpret bytes as packed binary data
@anchor{library/struct classes}@anchor{23b8}@anchor{library/struct struct-objects}@anchor{23b9}
@subsubsection Clases


El módulo @ref{d5,,struct} también define el siguiente tipo:

@geindex Struct (clase en struct)
@anchor{library/struct struct Struct}@anchor{16b9}
@deffn {Clase} struct.Struct (format)

Retorna un nuevo objeto Struct que escribe y lee datos binarios según la cadena de formato `format'. Crear un objeto @code{Struct} una vez y llamar a sus métodos es más eficaz que llamar a las funciones a nivel de módulo con el mismo formato, ya que la cadena de formato solo se compila una vez.

@cartouche
@quotation Nota 
Las versiones compiladas de las cadenas de formato más recientes pasadas a las funciones de nivel de módulo se almacenan en caché, por lo que los programas que utilizan solo unas pocas cadenas de formato no necesitan preocuparse por volver a usar una sola instancia @ref{16b9,,Struct}.
@end quotation
@end cartouche

Los objetos Struct compilados admiten los siguientes métodos y atributos:

@geindex pack() (método de struct.Struct)
@anchor{library/struct struct Struct pack}@anchor{23ba}
@deffn {Método} pack (v1, v2, ...)

Idéntico a la función @ref{12e4,,pack()}, utilizando el formato compilado. (@code{len(result)} será igual a @ref{23bb,,size}.)
@end deffn

@geindex pack_into() (método de struct.Struct)
@anchor{library/struct struct Struct pack_into}@anchor{23bc}
@deffn {Método} pack_into (buffer, offset, v1, v2, ...)

Idéntico a la función @ref{23aa,,pack_into()}, utilizando el formato compilado.
@end deffn

@geindex unpack() (método de struct.Struct)
@anchor{library/struct struct Struct unpack}@anchor{23bd}
@deffn {Método} unpack (buffer)

Idéntico a la función @ref{17ce,,unpack()}, utilizando el formato compilado. El tamaño del búfer en bytes debe ser igual a @ref{23bb,,size}.
@end deffn

@geindex unpack_from() (método de struct.Struct)
@anchor{library/struct struct Struct unpack_from}@anchor{23be}
@deffn {Método} unpack_from (buffer, offset=0)

Idéntico a la función @ref{23ab,,unpack_from()}, utilizando el formato compilado. El tamaño del búfer en bytes, comenzando en la posición `offset', debe ser al menos @ref{23bb,,size}.
@end deffn

@geindex iter_unpack() (método de struct.Struct)
@anchor{library/struct struct Struct iter_unpack}@anchor{103e}
@deffn {Método} iter_unpack (buffer)

Idéntico a la función @ref{103d,,iter_unpack()}, utilizando el formato compilado. El tamaño del búfer en bytes debe ser un múltiplo de @ref{23bb,,size}.


Added in version 3.4.

@end deffn

@geindex format (atributo de struct.Struct)
@anchor{library/struct struct Struct format}@anchor{c8e}
@deffn {Atributo} format

Cadena de formato utilizada para construir este objeto Struct.


Distinto en la versión 3.7: El tipo de cadena de formato es ahora @ref{237,,str} en lugar de @ref{325,,bytes}.

@end deffn

@geindex size (atributo de struct.Struct)
@anchor{library/struct struct Struct size}@anchor{23bb}
@deffn {Atributo} size

El tamaño calculado de la estructura (y, por lo tanto, del objeto bytes generado por el método @ref{12e4,,pack()}) correspondiente a @ref{6c0,,format}.
@end deffn


Distinto en la versión 3.13: The `repr()' of structs has changed.  It
is now:

@example
>>> Struct('i')
Struct('i')
@end example

@end deffn

@node codecs — Codec registry and base classes,,struct — Interpret bytes as packed binary data,Servicios de datos binarios
@anchor{library/codecs doc}@anchor{23bf}@anchor{library/codecs codecs-codec-registry-and-base-classes}@anchor{23c0}@anchor{library/codecs module-codecs}@anchor{1c}
@subsection @code{codecs} — Codec registry and base classes


@geindex module; codecs

`Código fuente:' Lib/codecs.py@footnote{https://github.com/python/cpython/tree/main/Lib/codecs.py}

@geindex Unicode
@geindex Códecs
@geindex Códecs;encode
@geindex Códecs;decode
@geindex streams
@geindex stackable;streams


__________________________________________________________________


Este módulo define las clases base para los códecs estándar de Python (codificadores y decodificadores) y proporciona acceso al registro interno de códecs de Python, que administra el códec y el proceso de búsqueda del manejo de errores. La mayoría de los códecs estándar son @ref{2180,,text encodings}, que codifican texto a bytes (y decodifican bytes a texto), pero también se proporcionan códecs que codifican texto a texto y bytes a bytes. Los códecs personalizados pueden codificar y decodificar entre tipos arbitrarios, pero algunas características del módulo están restringidas para usarse específicamente con @ref{2180,,text encodings} o con códecs que codifican a @ref{325,,bytes}.

El módulo define las siguientes funciones para codificar y decodificar con cualquier códec:

@geindex encode() (en el módulo codecs)
@anchor{library/codecs codecs encode}@anchor{f84}
@deffn {Función} codecs.encode (obj, encoding='utf-8', errors='strict')

Codifica `obj' utilizando el códec registrado para `encoding'.

Se pueden dar `errors' para establecer el esquema de manejo de errores deseado. El manejador de errores predeterminado es @code{'estricto'}, lo que significa que los errores de codificación provocan @ref{360,,ValueError} (o una subclase más específica del códec, como @ref{718,,UnicodeEncodeError}). Consulte @ref{23c1,,Clases Base de Códec} para obtener más información sobre el manejo de errores de códec.
@end deffn

@geindex decode() (en el módulo codecs)
@anchor{library/codecs codecs decode}@anchor{f85}
@deffn {Función} codecs.decode (obj, encoding='utf-8', errors='strict')

Decodifica `obj' utilizando el códec registrado para `encoding'.

Se pueden dar `errors' para establecer el esquema de manejo de errores deseado. El manejador de errores predeterminado es @code{'estricto'}, lo que significa que los errores de decodificación generan @ref{360,,ValueError} (o una subclase más específica de códec, como @ref{aa5,,UnicodeDecodeError}). Consulte @ref{23c1,,Clases Base de Códec} para obtener más información sobre el manejo de errores de códec.
@end deffn

Los detalles completos de cada códec también se pueden consultar directamente:

@geindex lookup() (en el módulo codecs)
@anchor{library/codecs codecs lookup}@anchor{9f6}
@deffn {Función} codecs.lookup (encoding)

Busca la información de códec en el registro de códec de Python y retorna un objeto @ref{1701,,CodecInfo} como se define a continuación.

Las codificaciones se buscan primero en la memoria caché del registro. Si no se encuentran, se explora la lista de funciones de búsqueda registradas. Si no se encuentran objetos @ref{1701,,CodecInfo}, se lanza un @ref{21d5,,LookupError}. De lo contrario, el objeto @ref{1701,,CodecInfo} se almacena en la memoria caché y se retorna a quien llama.
@end deffn

@geindex CodecInfo (clase en codecs)
@anchor{library/codecs codecs CodecInfo}@anchor{1701}
@deffn {Clase} codecs.CodecInfo (encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)

Detalles de códec al buscar el registro de códec. Los argumentos del constructor se almacenan en atributos del mismo nombre:

@geindex name (atributo de codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo name}@anchor{23c2}
@deffn {Atributo} name

El nombre de la codificación.
@end deffn

@geindex encode (atributo de codecs.CodecInfo)
@geindex decode (atributo de codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo encode}@anchor{23c3}
@deffn {Atributo} encode
@anchor{library/codecs codecs CodecInfo decode}@anchor{23c4}
@deffnx {Atributo} decode

Las funciones de codificación y decodificación sin estado. Deben ser funciones o métodos que tengan la misma interfaz que los métodos @ref{23c5,,encode()} y @ref{23c6,,decode()} de instancias de `Codec' (ver @ref{23c7,,Codec Interface}). Se espera que las funciones o métodos funcionen en modo sin estado.
@end deffn

@geindex incrementalencoder (atributo de codecs.CodecInfo)
@geindex incrementaldecoder (atributo de codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo incrementalencoder}@anchor{23c8}
@deffn {Atributo} incrementalencoder
@anchor{library/codecs codecs CodecInfo incrementaldecoder}@anchor{23c9}
@deffnx {Atributo} incrementaldecoder

Clases de codificación y decodificación incremental o funciones de fábrica. Deben proporcionar la interfaz definida por las clases base @ref{23ca,,IncrementalEncoder} y @ref{23cb,,IncrementalDecoder}, respectivamente. Los códecs incrementales pueden mantener el estado.
@end deffn

@geindex streamwriter (atributo de codecs.CodecInfo)
@geindex streamreader (atributo de codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo streamwriter}@anchor{23cc}
@deffn {Atributo} streamwriter
@anchor{library/codecs codecs CodecInfo streamreader}@anchor{23cd}
@deffnx {Atributo} streamreader

Las clases `stream', tanto `writer' como `reader' o funciones de fábrica. Estos tienen que proporcionar la interfaz definida por las clases base @ref{23ce,,StreamWriter} y @ref{23cf,,StreamReader}, respectivamente. Los códecs de flujo pueden mantener el estado.
@end deffn
@end deffn

Para simplificar el acceso a los diversos componentes de códec, el módulo proporciona estas funciones adicionales que utilizan @ref{9f6,,lookup()} para la búsqueda de códec:

@geindex getencoder() (en el módulo codecs)
@anchor{library/codecs codecs getencoder}@anchor{23d0}
@deffn {Función} codecs.getencoder (encoding)

Busca el códec para la codificación dada y retorna su función de codificador.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación.
@end deffn

@geindex getdecoder() (en el módulo codecs)
@anchor{library/codecs codecs getdecoder}@anchor{23d1}
@deffn {Función} codecs.getdecoder (encoding)

Busca el códec para la codificación dada y retorna su función de decodificador.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación.
@end deffn

@geindex getincrementalencoder() (en el módulo codecs)
@anchor{library/codecs codecs getincrementalencoder}@anchor{23d2}
@deffn {Función} codecs.getincrementalencoder (encoding)

Busca el códec para la codificación dada y retorna su clase de codificador incremental o función de fábrica.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación o el códec no admita un codificador incremental.
@end deffn

@geindex getincrementaldecoder() (en el módulo codecs)
@anchor{library/codecs codecs getincrementaldecoder}@anchor{23d3}
@deffn {Función} codecs.getincrementaldecoder (encoding)

Busca el códec para la codificación dada y retorna su clase de decodificador incremental o función de fábrica.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación o el códec no admita un decodificador incremental.
@end deffn

@geindex getreader() (en el módulo codecs)
@anchor{library/codecs codecs getreader}@anchor{23d4}
@deffn {Función} codecs.getreader (encoding)

Busca el códec para la codificación dada y retorna su clase @ref{23cf,,StreamReader} o función de fábrica.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación.
@end deffn

@geindex getwriter() (en el módulo codecs)
@anchor{library/codecs codecs getwriter}@anchor{23d5}
@deffn {Función} codecs.getwriter (encoding)

Busca el códec para la codificación dada y retorna su clase @ref{23ce,,StreamWriter} o función de fábrica.

Lanza un @ref{21d5,,LookupError} en caso de que no se encuentre la codificación.
@end deffn

Los códecs personalizados se ponen a disposición registrando una función de búsqueda de códecs adecuada:

@geindex register() (en el módulo codecs)
@anchor{library/codecs codecs register}@anchor{23d6}
@deffn {Función} codecs.register (search_function)

Registra una función de búsqueda de códec. Se espera que las funciones de búsqueda tomen un argumento, que sea el nombre de codificación en minúsculas con guiones y espacios convertidos a guiones bajos, y que retorne un objeto @ref{1701,,CodecInfo}. En caso de que una función de búsqueda no pueda encontrar una codificación dada, debería retornar @code{None}.


Distinto en la versión 3.9: Guiones y espacios se convierten a guiones bajos.

@end deffn

@geindex unregister() (en el módulo codecs)
@anchor{library/codecs codecs unregister}@anchor{87f}
@deffn {Función} codecs.unregister (search_function)

Anula el registro de una función de búsqueda de códecs y elimina el caché del registro. Si la función de búsqueda no está registrada, no hace nada.


Added in version 3.10.

@end deffn

Mientras que la función incorporada @ref{1be,,open()} y el módulo asociado @ref{7f,,io} son el enfoque recomendado para trabajar con archivos de texto codificados, este módulo proporciona funciones y clases de utilidad adicionales que permiten el uso de una gama más amplia de códecs cuando se trabaja con archivos binarios:

@geindex open() (en el módulo codecs)
@anchor{library/codecs codecs open}@anchor{7db}
@deffn {Función} codecs.open (filename, mode='r', encoding=None, errors='strict', buffering=-1)

Abre un archivo codificado utilizando el modo dado y retorna una instancia de @ref{23d7,,StreamReaderWriter}, proporcionando codificación/decodificación transparente. El modo de archivo predeterminado es @code{'r'}, que significa abrir el archivo en modo de lectura.

@cartouche
@quotation Nota 
Si el valor de `encoding' no es @code{None}, entonces, los archivos codificados subyacentes siempre se abren en modo binario. No se realiza ninguna conversión automática de @code{'\n'} al leer y escribir. El argumento `mode' puede ser cualquier modo binario aceptable para la función integrada @ref{1be,,open()}; la @code{'b'} se añade automáticamente.
@end quotation
@end cartouche

`encoding' especifica la codificación que se utilizará para el archivo. Se permite cualquier codificación que codifique y decodifique desde bytes, y los tipos de datos admitidos por los métodos de archivo dependen del códec utilizado.

pueden proporcionarse `errors' para definir el manejo de errores. El valor predeterminado es @code{'estricto'}, lo que hace que se genere un @ref{360,,ValueError} en caso de que ocurra un error de codificación.

`buffering' tiene el mismo significado que para la función incorporada @ref{1be,,open()}. Su valor predeterminado es -1, lo que significa que se utilizará el tamaño predeterminado del búfer.


Distinto en la versión 3.11: El modo @code{'U'} ha sido eliminado.

@end deffn

@geindex EncodedFile() (en el módulo codecs)
@anchor{library/codecs codecs EncodedFile}@anchor{23d8}
@deffn {Función} codecs.EncodedFile (file, data_encoding, file_encoding=None, errors='strict')

Retorna una instancia de @ref{19fa,,StreamRecoder}, una versión envuelta de `file' que proporciona transcodificación transparente. El archivo original se cierra cuando se cierra la versión empaquetada.

Los datos escritos en el archivo empaquetado se decodifican de acuerdo con la `data_encoding' dada y luego se escriben en el archivo original como bytes usando `file_encoding'. Los bytes leídos del archivo original se decodifican según `file_encoding', y el resultado se codifica utilizando `data_encoding'.

Si no se proporciona `file_encoding', el valor predeterminado es `data_encoding'.

Pueden proporcionarse `errors' para definir el manejo de errores. Su valor predeterminado es @code{'estricto'}, lo que hace que se genere @ref{360,,ValueError} en caso de que ocurra un error de codificación.
@end deffn

@geindex iterencode() (en el módulo codecs)
@anchor{library/codecs codecs iterencode}@anchor{23d9}
@deffn {Función} codecs.iterencode (iterator, encoding, errors='strict', **kwargs)

Utiliza un codificador incremental para codificar iterativamente la entrada proporcionada por `iterator'. Esta función es un @ref{10dd,,generator}. El argumento `errors' (así como cualquier otro argumento de palabra clave) se pasa al codificador incremental.

Esta función requiere que el códec acepte texto en objetos @ref{237,,str} para codificar. Por lo tanto, no admite codificadores de bytes a bytes, como @code{base64_codec}.
@end deffn

@geindex iterdecode() (en el módulo codecs)
@anchor{library/codecs codecs iterdecode}@anchor{23da}
@deffn {Función} codecs.iterdecode (iterator, encoding, errors='strict', **kwargs)

Utiliza un decodificador incremental para decodificar iterativamente la entrada proporcionada por `iterator'. Esta función es un @ref{10dd,,generator}. El argumento `errors' (así como cualquier otro argumento de palabra clave) se pasa al decodificador incremental.

Esta función requiere que el códec acepte objetos @ref{325,,bytes} para decodificar. Por lo tanto, no admite codificadores de texto a texto como @code{rot_13}, aunque @code{rot_13} puede usarse de manera equivalente con @ref{23d9,,iterencode()}.
@end deffn

El módulo también proporciona las siguientes constantes que son útiles para leer y escribir en archivos dependientes de la plataforma:

@geindex BOM (en el módulo codecs)
@geindex BOM_BE (en el módulo codecs)
@geindex BOM_LE (en el módulo codecs)
@geindex BOM_UTF8 (en el módulo codecs)
@geindex BOM_UTF16 (en el módulo codecs)
@geindex BOM_UTF16_BE (en el módulo codecs)
@geindex BOM_UTF16_LE (en el módulo codecs)
@geindex BOM_UTF32 (en el módulo codecs)
@geindex BOM_UTF32_BE (en el módulo codecs)
@geindex BOM_UTF32_LE (en el módulo codecs)
@anchor{library/codecs codecs BOM}@anchor{23db}
@deffn {Dato} codecs.BOM
@anchor{library/codecs codecs BOM_BE}@anchor{23dc}
@deffnx {Dato} codecs.BOM_BE
@anchor{library/codecs codecs BOM_LE}@anchor{23dd}
@deffnx {Dato} codecs.BOM_LE
@anchor{library/codecs codecs BOM_UTF8}@anchor{23de}
@deffnx {Dato} codecs.BOM_UTF8
@anchor{library/codecs codecs BOM_UTF16}@anchor{23df}
@deffnx {Dato} codecs.BOM_UTF16
@anchor{library/codecs codecs BOM_UTF16_BE}@anchor{23e0}
@deffnx {Dato} codecs.BOM_UTF16_BE
@anchor{library/codecs codecs BOM_UTF16_LE}@anchor{23e1}
@deffnx {Dato} codecs.BOM_UTF16_LE
@anchor{library/codecs codecs BOM_UTF32}@anchor{23e2}
@deffnx {Dato} codecs.BOM_UTF32
@anchor{library/codecs codecs BOM_UTF32_BE}@anchor{23e3}
@deffnx {Dato} codecs.BOM_UTF32_BE
@anchor{library/codecs codecs BOM_UTF32_LE}@anchor{23e4}
@deffnx {Dato} codecs.BOM_UTF32_LE

Estas constantes definen varias secuencias de bytes, que son marcas de orden de bytes Unicode (BOM) para varias codificaciones. Se utilizan en flujos de datos UTF-16 y UTF-32 para indicar el orden de bytes utilizado, y en UTF-8 como firma Unicode. @ref{23df,,BOM_UTF16} es @ref{23e0,,BOM_UTF16_BE} o @ref{23e1,,BOM_UTF16_LE} dependiendo del orden de bytes nativo de la plataforma, @ref{23db,,BOM} es un alias para @ref{23df,,BOM_UTF16}, @ref{23dd,,BOM_LE} para @ref{23e1,,BOM_UTF16_LE} y @ref{23dc,,BOM_BE} para @ref{23e0,,BOM_UTF16_BE}. Los otros representan la lista de materiales en las codificaciones UTF-8 y UTF-32.
@end deffn

@menu
* Clases Base de Códec:: 
* Codificaciones y Unicode:: 
* Codificaciones estándar:: 
* Codificaciones específicas de Python:: 
* encodings.idna — Nombres de dominio internacionalizados en aplicaciones: encodings idna — Nombres de dominio internacionalizados en aplicaciones. 
* encodings.mbcs — Página de códigos ANSI de Windows: encodings mbcs — Página de códigos ANSI de Windows. 
* encodings.utf_8_sig — Códec UTF-8 con firma BOM: encodings utf_8_sig — Códec UTF-8 con firma BOM. 

@end menu

@node Clases Base de Códec,Codificaciones y Unicode,,codecs — Codec registry and base classes
@anchor{library/codecs codec-base-classes}@anchor{23c1}@anchor{library/codecs id1}@anchor{23e5}
@subsubsection Clases Base de Códec


El módulo @ref{1c,,codecs} define un conjunto de clases base que definen las interfaces para trabajar con objetos de códec, y también puede usarse como base para implementaciones de códec personalizadas.

Cada códec tiene que definir cuatro interfaces para que pueda usarse como códec en Python: codificador sin estado, decodificador sin estado, lector de flujo y escritor de flujo. El lector de flujo y los escritores suelen reutilizar el codificador/decodificador sin estado para implementar los protocolos de archivo. Los autores de códecs también necesitan definir cómo manejará los errores de codificación y decodificación.
@anchor{library/codecs surrogateescape}@anchor{23e6}
@menu
* Manejadores de errores:: 
* Codificación y decodificación sin estado:: 
* Codificación y decodificación incrementales:: 
* Codificación y decodificación de flujos:: 

@end menu

@node Manejadores de errores,Codificación y decodificación sin estado,,Clases Base de Códec
@anchor{library/codecs error-handlers}@anchor{17ed}@anchor{library/codecs id2}@anchor{23e7}
@subsubsection Manejadores de errores


Para simplificar y estandarizar el manejo de errores, los códecs pueden implementar diferentes esquemas de manejo de errores aceptando el argumento de cadena `errors':

@example
>>> 'German ß, ♬'.encode(encoding='ascii', errors='backslashreplace')
b'German \\xdf, \\u266c'
>>> 'German ß, ♬'.encode(encoding='ascii', errors='xmlcharrefreplace')
b'German &#223;, &#9836;'
@end example

@geindex strict;nombre de gestor de errores
@geindex ignore;nombre de gestor de errores
@geindex replace;nombre de gestor de errores
@geindex backslashreplace;nombre de gestor de errores
@geindex surrogateescape;nombre de gestor de errores
@geindex ? (signo de pregunta);caracter de reemplazo
@geindex \ (barra inversa);secuencia de escape
@geindex \x;secuencia de escape
@geindex \u;secuencia de escape
@geindex \U;secuencia de escape

Los siguientes manejadores de errores se pueden emplear con todos los códecs Python @ref{e3e,,Codificaciones estándar}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'strict'}

@tab

Lanza @ref{130f,,UnicodeError} (o una subclase), este es el valor predeterminado. Implementado en @code{strictly_errors()}.

@item

@code{'ignore'}

@tab

Ignore los datos mal formados y continúe sin previo aviso. Implementado en @ref{23e8,,ignore_errors()}.

@item

@code{'replace'}

@tab

Sustituir con un marcador de reemplazo. Al codificar, emplear @code{?} (carácter ASCII). Al decodificar, usar @code{�} (U+FFFD, el CARÁCTER DE REEMPLAZO oficial). Implementado en @ref{23e9,,replace_errors()}.

@item

@code{'backslashreplace'}

@tab

Reemplazar con secuencias de escape mediante barra invertida. Al codificar, emplear la forma hexadecimal del punto de código Unicode con los formatos @code{\x@var{hh}} @code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}}. Al decodificar, usa la forma hexadecimal del valor del byte con el formato @code{\x@var{hh}}. Implementado en @ref{23ea,,backslashreplace_errors()}.

@item

@code{'surrogateescape'}

@tab

En la decodificación, reemplace el byte con código sustituto individual que va desde @code{U+DC80} a @code{U+DCFF}. Este código se volverá a convertir en el mismo byte cuando se use el manejador de errores @code{'sustituto de paisaje'} al codificar los datos. (Ver 
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} para más información).

@end multitable


@geindex xmlcharrefreplace;nombre de gestor de errores
@geindex namereplace;nombre de gestor de errores
@geindex \N;secuencia de escape

Los siguientes manejadores de errores solo son aplicables a @ref{2180,,codificaciones de texto}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'xmlcharrefreplace'}

@tab

Reemplazar con una referencia de carácter numérico XML/HTML, que es una forma decimal del punto de código Unicode con formato @code{&#@var{num};}. Implementado en @ref{23eb,,xmlcharrefreplace_errors()}.

@item

@code{'namereplace'}

@tab

Reemplazar con secuencias de escape @code{\N@{...@}}, lo que aparece entre llaves, es la propiedad Nombre de la Base de datos de Caracteres Unicode. Implementado en @ref{23ec,,namereplace_errors()}.

@end multitable


@geindex surrogatepass;nombre de gestor de errores

Además, el siguiente manejador de errores es específico de los códecs dados:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Códecs

@tab

Significado

@item

@code{'surrogatepass'}

@tab

utf-8, utf-16, utf-32,
utf-16-be, utf-16-le,
utf-32-be, utf-32-le

@tab

Permite la codificación y decodificación del punto de código sustituto (@code{U+D800} - @code{U+DFFF}) como punto de código normal. De lo contrario, estos códecs tratan la presencia de un punto de código sustituto en @ref{237,,str} como un error.

@end multitable



Added in version 3.1: Los manejadores de errores @code{'surrogateescape'} y @code{'surrogatepass'}.



Distinto en la versión 3.4: Los manejadores de errores @code{'surrogatepass'} ahora funcionan con los códecs utf-16* y utf-32*.



Added in version 3.5: El manejador de errores @code{'namereplace'}.



Distinto en la versión 3.5: El manejador de errores @code{'backslashreplace'} ahora funciona con decodificación y traducción.


El conjunto de valores permitidos puede ampliarse registrando un nuevo manejador de errores con nombre:

@geindex register_error() (en el módulo codecs)
@anchor{library/codecs codecs register_error}@anchor{14d5}
@deffn {Función} codecs.register_error (name, error_handler)

Registre la función de manejo de errores `error_handler' bajo el nombre `name'. Se invocará el argumento `error_handler' durante la codificación y decodificación en caso de error, cuando `name' se especifica como el parámetro de errores.

Para la codificación, se llamará a `error_handler' con una instancia @ref{718,,UnicodeEncodeError}, que contiene información sobre la ubicación del error. El manejador de errores debe generar esta o una excepción diferente, o retornar una tupla con un reemplazo para la parte no codificable de la entrada y una posición donde la codificación debe continuar. El reemplazo puede ser @ref{237,,str} o @ref{325,,bytes}. Si el reemplazo son bytes, el codificador simplemente los copiará en el búfer de salida. Si el reemplazo es una cadena de caracteres, el codificador codificará el reemplazo. La codificación continúa en la entrada original en la posición especificada. Los valores de posición negativos se tratarán como relativos al final de la cadena de entrada. Si la posición resultante está fuera del límite, se lanzará @ref{1575,,IndexError}.

La decodificación y la traducción funcionan de manera similar, excepto que @ref{aa5,,UnicodeDecodeError} o @ref{22a0,,UnicodeTranslateError} se pasarán al manejador y el sustituto del manejador de errores se colocará directamente en la salida.
@end deffn

Los manejadores de errores registrados previamente (incluidos los manejadores de error estándar) se pueden buscar por nombre:

@geindex lookup_error() (en el módulo codecs)
@anchor{library/codecs codecs lookup_error}@anchor{14d6}
@deffn {Función} codecs.lookup_error (name)

Retorna el manejador de errores previamente registrado con el nombre `name'.

Lanza un @ref{21d5,,LookupError} en caso de que no se pueda encontrar el controlador.
@end deffn

Los siguientes manejadores de errores estándar también están disponibles como funciones de nivel de módulo:

@geindex strict_errors() (en el módulo codecs)
@anchor{library/codecs codecs strict_errors}@anchor{23ed}
@deffn {Función} codecs.strict_errors (exception)

Implementa el manejo de errores @code{'strict'}.

Cada error de codificación o decodificación genera un @ref{130f,,UnicodeError}.
@end deffn

@geindex ignore_errors() (en el módulo codecs)
@anchor{library/codecs codecs ignore_errors}@anchor{23e8}
@deffn {Función} codecs.ignore_errors (exception)

Implementa el manejo de errores @code{'ignore'}.

Los datos con formato incorrecto se ignoran; la codificación o decodificación continúa sin previo aviso.
@end deffn

@geindex replace_errors() (en el módulo codecs)
@anchor{library/codecs codecs replace_errors}@anchor{23e9}
@deffn {Función} codecs.replace_errors (exception)

Implementa el manejo de errores @code{'replace'} .

Sustituye @code{?} (carácter ASCII) por errores de codificación o @code{�} (U+FFFD, el CARÁCTER DE REEMPLAZO oficial) por errores de decodificación.
@end deffn

@geindex backslashreplace_errors() (en el módulo codecs)
@anchor{library/codecs codecs backslashreplace_errors}@anchor{23ea}
@deffn {Función} codecs.backslashreplace_errors (exception)

Implementa el manejador de errores @code{'backslashreplace'}.

Los datos con formato incorrecto se reemplazan por una secuencia de escape con barra invertida. Al codificar, emplea la forma hexadecimal del punto de código Unicode con los formatos @code{\x@var{hh}} @code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}}. Al decodificar, usa la forma hexadecimal del valor del byte con el formato @code{\x@var{hh}}.


Distinto en la versión 3.5: Funciona con la decodificación y traducción.

@end deffn

@geindex xmlcharrefreplace_errors() (en el módulo codecs)
@anchor{library/codecs codecs xmlcharrefreplace_errors}@anchor{23eb}
@deffn {Función} codecs.xmlcharrefreplace_errors (exception)

Implementa el manejador de errores @code{'xmlcharrefreplace'} (solo para codificar dentro de @ref{2180,,text encoding}).

El carácter no codificable se reemplaza por una referencia de carácter numérico XML/HTML adecuada, que es una forma decimal del punto de código Unicode con formato @code{&#@var{num};} .
@end deffn

@geindex namereplace_errors() (en el módulo codecs)
@anchor{library/codecs codecs namereplace_errors}@anchor{23ec}
@deffn {Función} codecs.namereplace_errors (exception)

Implementa el manejo de errores @code{'namereplace} (solo para codificar dentro de @ref{2180,,text encoding}).

El carácter no codificable se reemplaza por una secuencia de escape @code{\N@{...@}}. El conjunto de caracteres que aparecen entre llaves es la propiedad Nombre de la Base de datos de Caracteres Unicode. Por ejemplo, la letra minúscula alemana @code{'ß'} se convertirá en la secuencia de bytes @code{\N@{LATIN SMALL LETTER SHARP S@}} .


Added in version 3.5.

@end deffn

@node Codificación y decodificación sin estado,Codificación y decodificación incrementales,Manejadores de errores,Clases Base de Códec
@anchor{library/codecs codec-objects}@anchor{23c7}@anchor{library/codecs stateless-encoding-and-decoding}@anchor{23ee}
@subsubsection Codificación y decodificación sin estado


La clase base @ref{23ef,,Codec} define estos métodos que también definen las interfaces de función del codificador y decodificador sin estado:

@geindex Codec (clase en codecs)
@anchor{library/codecs codecs Codec}@anchor{23ef}
@deffn {Clase} codecs.Codec

@geindex encode() (método de codecs.Codec)
@anchor{library/codecs codecs Codec encode}@anchor{23c5}
@deffn {Método} encode (input, errors='strict')

Codifica el objeto `input' y retorna una tupla (objeto de salida, longitud consumida). Por ejemplo @ref{2180,,text encoding} convierte un objeto de cadena de caracteres en un objeto de bytes utilizando una codificación de juego de caracteres particular (por ejemplo,`@w{`}cp1252`@w{`} o @code{iso-8859-1}).

El argumento `errors' define el manejo de errores a aplicar. El valor predeterminado es el manejo @code{estricto}.

Es posible que el método no almacene estado en la instancia @ref{23ef,,Codec}. Use @ref{23ce,,StreamWriter} para códecs que deben mantener el estado para que la codificación sea eficiente.

El codificador debe poder manejar la entrada de longitud cero y retornar un objeto vacío del tipo de objeto de salida en esta situación.
@end deffn

@geindex decode() (método de codecs.Codec)
@anchor{library/codecs codecs Codec decode}@anchor{23c6}
@deffn {Método} decode (input, errors='strict')

Decodifica el objeto `input' y retorna una tupla (objeto de salida, longitud consumida). Por ejemplo, para un @ref{2180,,codificación de texto}, la decodificación convierte un objeto de bytes codificado usando una codificación de juego de caracteres particular en un objeto de cadena de caracteres.

Para codificaciones de texto y códecs de bytes a bytes, `input' debe ser un objeto de bytes o uno que proporcione la interfaz de búfer de solo lectura, por ejemplo, objetos de búfer y archivos mapeados en memoria.

El argumento `errors' define el manejo de errores a aplicar. El valor predeterminado es el manejo @code{estricto}.

Es posible que el método no almacene estado en la instancia de @ref{23ef,,Codec}. Use @ref{23cf,,StreamReader} para códecs que deben mantener el estado para que la decodificación sea eficiente.

El decodificador debe poder manejar la entrada de longitud cero y retornar un objeto vacío del tipo de objeto de salida en esta situación.
@end deffn
@end deffn

@node Codificación y decodificación incrementales,Codificación y decodificación de flujos,Codificación y decodificación sin estado,Clases Base de Códec
@anchor{library/codecs incremental-encoding-and-decoding}@anchor{23f0}
@subsubsection Codificación y decodificación incrementales


Las clases @ref{23ca,,IncrementalEncoder} y @ref{23cb,,IncrementalDecoder} proporcionan la interfaz básica para la codificación y decodificación incrementales. La codificación/decodificación de la entrada no se realiza con una llamada a la función de codificador/decodificador sin estado, sino con varias llamadas al método @ref{23f1,,encode()}/@ref{23f2,,decode()} del codificador incremental /decodificador. El codificador/decodificador incremental realiza un seguimiento del proceso de codificación/decodificación durante las llamadas a métodos.

La salida combinada de las llamadas al método @ref{23f1,,encode()}/@ref{23f2,,decode()} es el mismo que si todas las entradas individuales se unieran en una, y esta entrada se codificara/decodificara con codificador/decodificador sin estado.

@menu
* Objetos IncrementalEncoder:: 
* Objetos IncrementalDecoder:: 

@end menu

@node Objetos IncrementalEncoder,Objetos IncrementalDecoder,,Codificación y decodificación incrementales
@anchor{library/codecs incremental-encoder-objects}@anchor{23f3}@anchor{library/codecs incrementalencoder-objects}@anchor{23f4}
@subsubsection Objetos IncrementalEncoder


La clase @ref{23ca,,IncrementalEncoder} se usa para codificar una entrada en varios pasos. Define los siguientes métodos que cada codificador incremental debe definir para ser compatible con el registro de códec Python.

@geindex IncrementalEncoder (clase en codecs)
@anchor{library/codecs codecs IncrementalEncoder}@anchor{23ca}
@deffn {Clase} codecs.IncrementalEncoder (errors='strict')

Constructor para una clase instancia de @ref{23ca,,IncrementalEncoder}.

Todos los codificadores incrementales deben proporcionar esta interfaz de constructor. Son libres de agregar argumentos de palabras clave adicionales, pero el registro de códecs de Python solo utiliza los definidos aquí.

La clase @ref{23ca,,IncrementalEncoder} puede implementar diferentes esquemas de manejo de errores al proporcionar el argumento de palabra clave `errors'. Ver @ref{17ed,,Manejadores de errores} para posibles valores.

El argumento `errors' se asignará a un atributo del mismo nombre. La asignación a este atributo hace posible cambiar entre diferentes estrategias de manejo de errores durante la vida útil del objeto @ref{23ca,,IncrementalEncoder}.

@geindex encode() (método de codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder encode}@anchor{23f1}
@deffn {Método} encode (object, final=False)

Codifica `object' (teniendo en cuenta el estado actual del codificador) y retorna el objeto codificado resultante. Si esta es la última llamada a @ref{f84,,encode()} `final' debe ser verdadero (el valor predeterminado es falso).
@end deffn

@geindex reset() (método de codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder reset}@anchor{23f5}
@deffn {Método} reset ()

Restablece el codificador al estado inicial. La salida se descarta: llama a @code{.encode(object, final=True)}, pasando un byte vacío o una cadena de texto si es necesario, para restablecer el codificador y obtener la salida.
@end deffn

@geindex getstate() (método de codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder getstate}@anchor{23f6}
@deffn {Método} getstate ()

Retorna el estado actual del codificador que debe ser un número entero. La implementación debe asegurarse de que @code{0} sea el estado más común. (Los estados que son más complicados que los enteros se pueden convertir en un entero al empaquetar/serializar el estado y codificar los bytes de la cadena resultante en un entero).
@end deffn

@geindex setstate() (método de codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder setstate}@anchor{23f7}
@deffn {Método} setstate (state)

Establece el estado del codificador en `state'. `state' debe ser un estado de codificador retornado por @ref{23f6,,getstate()}.
@end deffn
@end deffn

@node Objetos IncrementalDecoder,,Objetos IncrementalEncoder,Codificación y decodificación incrementales
@anchor{library/codecs incremental-decoder-objects}@anchor{23f8}@anchor{library/codecs incrementaldecoder-objects}@anchor{23f9}
@subsubsection Objetos IncrementalDecoder


La clase @ref{23cb,,IncrementalDecoder} se usa para decodificar una entrada en varios pasos. Define los siguientes métodos que cada decodificador incremental debe definir para ser compatible con el registro de códec Python.

@geindex IncrementalDecoder (clase en codecs)
@anchor{library/codecs codecs IncrementalDecoder}@anchor{23cb}
@deffn {Clase} codecs.IncrementalDecoder (errors='strict')

Constructor para una instancia de @ref{23cb,,IncrementalDecoder}.

Todos los decodificadores incrementales deben proporcionar esta interfaz de constructor. Son libres de agregar argumentos de palabras clave adicionales, pero el registro de códecs de Python solo utiliza los definidos aquí.

La clase @ref{23cb,,IncrementalDecoder} puede implementar diferentes esquemas de manejo de errores al proporcionar el argumento de palabra clave `errors'. Ver @ref{17ed,,Manejadores de errores} para posibles valores.

El argumento `errors' se asignará a un atributo del mismo nombre. La asignación a este atributo hace posible cambiar entre diferentes estrategias de manejo de errores durante la vida útil del objeto @ref{23cb,,IncrementalDecoder}.

@geindex decode() (método de codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder decode}@anchor{23f2}
@deffn {Método} decode (object, final=False)

Decodifica `object' (teniendo en cuenta el estado actual del decodificador) y retorna el objeto decodificado resultante. Si esta es la última llamada a @ref{f85,,decode()} `final' debe ser verdadero (el valor predeterminado es falso). Si `final' es verdadero, el decodificador debe decodificar la entrada por completo y debe vaciar todos los búferes. Si esto no es posible (por ejemplo, debido a secuencias de bytes incompletas al final de la entrada), debe iniciar el manejo de errores al igual que en el caso sin estado (lo que podría generar una excepción).
@end deffn

@geindex reset() (método de codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder reset}@anchor{23fa}
@deffn {Método} reset ()

Restablece el decodificador al estado inicial.
@end deffn

@geindex getstate() (método de codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder getstate}@anchor{23fb}
@deffn {Método} getstate ()

Retorna el estado actual del decodificador. Debe ser una tupla con dos elementos, el primero debe ser el búfer que contiene la entrada aún sin codificar. El segundo debe ser un número entero y puede ser información de estado adicional. (La implementación debe asegurarse de que @code{0} sea la información de estado adicional más común). Si esta información de estado adicional es @code{0}, debe ser posible establecer el decodificador en el estado que no tiene entrada almacenada y @code{0} como información de estado adicional, de modo que alimentar la entrada previamente almacenada en el búfer al decodificador la retorna al estado anterior sin producir ninguna salida. (La información de estado adicional que es más complicada que los enteros se puede convertir en un entero al empaquetar/serializar la información y codificar los bytes de la cadena resultante en un entero).
@end deffn

@geindex setstate() (método de codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder setstate}@anchor{23fc}
@deffn {Método} setstate (state)

Establezca el estado del decodificador en `state'. `state' debe ser un estado de decodificador retornado por @ref{23fb,,getstate()}.
@end deffn
@end deffn

@node Codificación y decodificación de flujos,,Codificación y decodificación incrementales,Clases Base de Códec
@anchor{library/codecs stream-encoding-and-decoding}@anchor{23fd}
@subsubsection Codificación y decodificación de flujos


The @ref{23ce,,StreamWriter} and @ref{23cf,,StreamReader} classes provide generic
working interfaces which can be used to implement new encoding submodules very
easily. See @code{encodings.utf_8} for an example of how this is done.

@menu
* Objetos StreamWriter:: 
* Objetos StreamReader:: 
* Objetos StreamReaderWriter:: 
* Objetos StreamRecoder:: 

@end menu

@node Objetos StreamWriter,Objetos StreamReader,,Codificación y decodificación de flujos
@anchor{library/codecs stream-writer-objects}@anchor{23fe}@anchor{library/codecs streamwriter-objects}@anchor{23ff}
@subsubsection Objetos StreamWriter


La clase @ref{23ce,,StreamWriter} es una subclase de @ref{23ef,,Codec} y define los siguientes métodos que cada escritor del flujo debe definir para ser compatible con el registro de códecs Python.

@geindex StreamWriter (clase en codecs)
@anchor{library/codecs codecs StreamWriter}@anchor{23ce}
@deffn {Clase} codecs.StreamWriter (stream, errors='strict')

Constructor para una instancia de @ref{23ce,,StreamWriter}.

Todos los escritores de flujos deben proporcionar esta interfaz de constructor. Son libres de agregar argumentos de palabras clave adicionales, pero el registro de códecs de Python solo utiliza los definidos aquí.

El argumento `stream' debe ser un objeto tipo archivo abierto para escribir texto o datos binarios, según corresponda para el códec específico.

La clase @ref{23ce,,StreamWriter} puede implementar diferentes esquemas de manejo de errores al proporcionar el argumento de palabra clave `errors'. Consulte @ref{17ed,,Manejadores de errores} para ver los manejadores de errores estándar que puede admitir el códec de flujo subyacente.

El argumento `errors' se asignará a un atributo del mismo nombre. La asignación a este atributo hace posible cambiar entre diferentes estrategias de manejo de errores durante la vida útil del objeto @ref{23ce,,StreamWriter}.

@geindex write() (método de codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter write}@anchor{2400}
@deffn {Método} write (object)

Escribe el contenido del objeto codificado en el flujo.
@end deffn

@geindex writelines() (método de codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter writelines}@anchor{2401}
@deffn {Método} writelines (list)

Escribe una lista concatenada de cadenas en el flujo (posiblemente reutilizando el método @ref{2400,,write()}). No se admiten iterables infinitos o muy grandes. Los códecs estándar de bytes a bytes no admiten este método.
@end deffn

@geindex reset() (método de codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter reset}@anchor{2402}
@deffn {Método} reset ()

Restablece los búfers de códec utilizados para mantener el estado interno.

Llamar a este método debería garantizar que los datos en la salida se pongan en un estado limpio que permita agregar datos nuevos sin tener que volver a escanear todo el flujo para recuperar el estado.
@end deffn
@end deffn

Además de los métodos anteriores, la clase @ref{23ce,,StreamWriter} también debe heredar todos los demás métodos y atributos del flujo subyacente.

@node Objetos StreamReader,Objetos StreamReaderWriter,Objetos StreamWriter,Codificación y decodificación de flujos
@anchor{library/codecs stream-reader-objects}@anchor{2403}@anchor{library/codecs streamreader-objects}@anchor{2404}
@subsubsection Objetos StreamReader


La clase @ref{23cf,,StreamReader} es una subclase de @ref{23ef,,Codec} y define los siguientes métodos que cada lector de flujo debe definir para ser compatible con el registro de códecs de Python.

@geindex StreamReader (clase en codecs)
@anchor{library/codecs codecs StreamReader}@anchor{23cf}
@deffn {Clase} codecs.StreamReader (stream, errors='strict')

Constructor para una instancia de @ref{23cf,,StreamReader}.

Todos los lectores de flujo deben proporcionar esta interfaz de constructor. Son libres de agregar argumentos de palabras clave adicionales, pero el registro de códecs de Python solo utiliza los definidos aquí.

El argumento `stream' debe ser un objeto tipo archivo abierto para leer texto o datos binarios, según corresponda para el códec específico.

La clase @ref{23cf,,StreamReader} puede implementar diferentes esquemas de manejo de errores al proporcionar el argumento de palabra clave `errors'. Consulte @ref{17ed,,Manejadores de errores} para ver los manejadores de errores estándar que puede admitir el códec de flujo subyacente.

El argumento `errors' se asignará a un atributo del mismo nombre. La asignación a este atributo hace posible cambiar entre diferentes estrategias de manejo de errores durante la vida útil del objeto @ref{23cf,,StreamReader}.

El conjunto de valores permitidos para el argumento `errors' se puede ampliar con @ref{14d5,,register_error()}.

@geindex read() (método de codecs.StreamReader)
@anchor{library/codecs codecs StreamReader read}@anchor{2405}
@deffn {Método} read (size=-1, chars=-1, firstline=False)

Decodifica datos del flujo y retorna el objeto resultante.

El argumento `chars' indica el número de puntos de código decodificados o bytes a retornar. El método @ref{2405,,read()} nunca retornará más datos de los solicitados, pero podría retornar menos, si no hay suficientes disponibles.

El argumento `size' indica el número máximo aproximado de bytes codificados o puntos de código para leer para la decodificación. El decodificador puede modificar esta configuración según corresponda. El valor predeterminado -1 indica leer y decodificar tanto como sea posible. Este parámetro está diseñado para evitar tener que decodificar archivos grandes en un solo paso.

La bandera `firstline' indica que sería suficiente retornar solo la primera línea, si hay errores de decodificación en las líneas posteriores.

El método debe usar una estrategia de lectura codiciosa, lo que significa que debe leer la mayor cantidad de datos permitidos dentro de la definición de la codificación y el tamaño dado, por ejemplo si las terminaciones de codificación opcionales o los marcadores de estado están disponibles en la transmisión, también deben leerse.
@end deffn

@geindex readline() (método de codecs.StreamReader)
@anchor{library/codecs codecs StreamReader readline}@anchor{2406}
@deffn {Método} readline (size=None, keepends=True)

Lee una línea del flujo de entrada y retorna los datos decodificados.

`size', si se da, se pasa como argumento de tamaño al método @ref{2405,,read()} del `stream'.

Si `keepends' es falso, las terminaciones de línea se eliminarán de las líneas retornadas.
@end deffn

@geindex readlines() (método de codecs.StreamReader)
@anchor{library/codecs codecs StreamReader readlines}@anchor{2407}
@deffn {Método} readlines (sizehint=None, keepends=True)

Lee todas las líneas disponibles en el flujo de entrada y las retorna como una lista de líneas.

Los finales de línea se implementan utilizando el método @ref{f85,,decode()} del códec y se incluyen en las entradas de la lista si `keepends' es verdadero.

`sizehint', si se proporciona, se pasa como argumento `size' al método @ref{2405,,read()} del `stream'.
@end deffn

@geindex reset() (método de codecs.StreamReader)
@anchor{library/codecs codecs StreamReader reset}@anchor{2408}
@deffn {Método} reset ()

Restablece los búfers de códec utilizados para mantener el estado interno.

Tenga en cuenta que ningún reposicionamiento de flujo debe suceder. Este método está destinado principalmente a poder recuperarse de errores de decodificación.
@end deffn
@end deffn

Además de los métodos anteriores, la clase @ref{23cf,,StreamReader} también debe heredar todos los demás métodos y atributos del flujo subyacente.

@node Objetos StreamReaderWriter,Objetos StreamRecoder,Objetos StreamReader,Codificación y decodificación de flujos
@anchor{library/codecs stream-reader-writer}@anchor{2409}@anchor{library/codecs streamreaderwriter-objects}@anchor{240a}
@subsubsection Objetos StreamReaderWriter


La clase @ref{23d7,,StreamReaderWriter} es una clase de conveniencia que permite envolver flujos que funcionan tanto en modo de lectura como de escritura.

El diseño es tal que uno puede usar las funciones de fábrica retornadas por la función @ref{9f6,,lookup()} para construir la instancia.

@geindex StreamReaderWriter (clase en codecs)
@anchor{library/codecs codecs StreamReaderWriter}@anchor{23d7}
@deffn {Clase} codecs.StreamReaderWriter (stream, Reader, Writer, errors='strict')

Crea una instancia de @ref{23d7,,StreamReaderWriter}. `stream' debe ser un objeto similar a un archivo. `Reader' y `Writer' deben ser funciones o clases de fábrica que proporcionen la interfaz @ref{23cf,,StreamReader} y @ref{23ce,,StreamWriter} respectivamente. El manejo de errores se realiza de la misma manera que se define para los lectores y escritores de flujos.
@end deffn

Las instancias @ref{23d7,,StreamReaderWriter} definen las interfaces combinadas de @ref{23cf,,StreamReader} y clases @ref{23ce,,StreamWriter}. Heredan todos los demás métodos y atributos del flujo subyacente.

@node Objetos StreamRecoder,,Objetos StreamReaderWriter,Codificación y decodificación de flujos
@anchor{library/codecs stream-recoder-objects}@anchor{240b}@anchor{library/codecs streamrecoder-objects}@anchor{240c}
@subsubsection Objetos StreamRecoder


La clase @ref{19fa,,StreamRecoder} traduce datos de una codificación a otra, lo que a veces es útil cuando se trata de diferentes entornos de codificación.

El diseño es tal que uno puede usar las funciones de fábrica retornadas por la función @ref{9f6,,lookup()} para construir la instancia.

@geindex StreamRecoder (clase en codecs)
@anchor{library/codecs codecs StreamRecoder}@anchor{19fa}
@deffn {Clase} codecs.StreamRecoder (stream, encode, decode, Reader, Writer, errors='strict')

Creates a @ref{19fa,,StreamRecoder} instance which implements a two-way conversion:
`encode' and `decode' work on the frontend — the data visible to
code calling @ref{2405,,read()} and @ref{2400,,write()},
while `Reader' and `Writer'
work on the backend — the data in `stream'.

Puede usar estos objetos para realizar transcodificaciones transparentes, por ejemplo, de Latin-1 a UTF-8 y viceversa.

El argumento `stream' debe ser un objeto similar a un archivo.

Los argumentos `encode' y `decode' deben cumplir con la interfaz de @ref{23ef,,Codec}. `Reader' y `Writer' deben ser funciones o clases de fábrica que proporcionen objetos de la interfaz @ref{23cf,,StreamReader} y @ref{23ce,,StreamWriter} respectivamente.

El manejo de errores se realiza de la misma manera que se define para los lectores y escritores de flujos.
@end deffn

las instancias @ref{19fa,,StreamRecoder} definen las interfaces combinadas de las clases @ref{23cf,,StreamReader} y @ref{23ce,,StreamWriter}. Heredan todos los demás métodos y atributos del flujo subyacente.

@node Codificaciones y Unicode,Codificaciones estándar,Clases Base de Códec,codecs — Codec registry and base classes
@anchor{library/codecs encodings-and-unicode}@anchor{240d}@anchor{library/codecs encodings-overview}@anchor{240e}
@subsubsection Codificaciones y Unicode


Las cadenas de caracteres se almacenan internamente como secuencias de puntos de código en el rango @code{U+0000}–@code{U+10FFFF}. (Consultar 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} para obtener más detalles sobre la implementación). Una vez utilizado un objeto de cadena de caracteres fuera de la CPU y de la memoria, la `endianness' y cómo se almacenan estas matrices como bytes se convierte en un problema. Al igual que con otros códecs, la serialización de una cadena en una secuencia de bytes se conoce como codificación, y la recreación de la cadena a partir de los bytes se conoce como decodificación. Hay múltiples códecs para la serialización de texto, a los que se puede consultar colectivamente mediante @ref{2180,,text encodings}.

La codificación de texto más simple (llamada @code{'latin-1'} o @code{'iso-8859-1'}) asigna los puntos de código 0–255 a los bytes @code{0x0} – @code{0xff}, lo que significa que un objeto de cadena de caracteres que contiene puntos de código encima de @code{U+00FF} no se puede codificar con este códec. Al hacerlo, lanzará un @ref{718,,UnicodeEncodeError} que se parece a lo siguiente (aunque los detalles del mensaje de error pueden diferir): @code{UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' 'in position 3: ordinal not in range(256)}.

Hay otro grupo de codificaciones (las llamadas codificaciones de mapa de caracteres) que eligen un subconjunto diferente de todos los puntos de código Unicode y cómo estos puntos de código se asignan a los bytes @code{0x0} – @code{0xff}. Para ver cómo se hace esto, simplemente abra, por ejemplo @code{encodings/cp1252.py} (que es una codificación que se usa principalmente en Windows). Hay una cadena constante con 256 caracteres que le muestra qué carácter está asignado a qué valor de byte.

Todas estas codificaciones solo pueden codificar 256 de los 1114112 puntos de código definidos en Unicode. Una manera simple y directa que permita almacenar cada punto de código Unicode, es almacenar cada punto de código como cuatro bytes consecutivos. Hay dos posibilidades: almacenar los bytes en orden `big endian' o `little endian'. Estas dos codificaciones se denominan @code{UTF-32-BE} y @code{UTF-32-LE} respectivamente. Su desventaja es que, si por ejemplo, usa @code{UTF-32-BE} en una pequeña máquina `endian', siempre tendrá que intercambiar bytes en la codificación y decodificación. @code{UTF-32} evita este problema: los bytes siempre estarán en `endianness' natural. Cuando estos bytes son leídos por una CPU con una `endianness' diferente, entonces los bytes deben intercambiarse. Para poder detectar el `endian' de una secuencia de bytes @code{UTF-16} o @code{UTF-32}, existe la llamada BOM («Marca de orden de bytes», o en inglés `Byte Order Mark'). Este es el carácter Unicode @code{U+FEFF}. Este carácter puede anteponerse a cada secuencia de bytes @code{UTF-16} o @code{UTF-32}. La versión intercambiada de bytes de este carácter (@code{0xFFFE}) es un carácter ilegal que puede no aparecer en un texto Unicode. Entonces, cuando el primer carácter en una secuencia de bytes @code{UTF-16} o @code{UTF-32} parece ser un @code{U+FFFE}, los bytes deben intercambiarse en la decodificación. Desafortunadamente, el carácter @code{U+FEFF} tenía un segundo propósito como @code{ESPACIO DE ANCHO CERO SIN QUIEBRA}: un carácter que no tiene ancho y no permite dividir una palabra. Por ejemplo, puede ser usado para dar pistas a un algoritmo de ligadura. Con Unicode 4.0, el uso de @code{U+FEFF} como @code{ESPACIO DE ANCHO CERO SIN QUIEBRA} ha quedado obsoleto (con @code{U+2060} (@code{WORD JOINER}) asumiendo este rol). Sin embargo, el software Unicode aún debe ser capaz de manejar @code{U+FEFF} en ambos roles: como BOM, es un dispositivo para determinar el diseño de almacenamiento de los bytes codificados, y desaparece una vez que la secuencia de bytes ha sido decodificada en una cadena; como un @code{ESPACIO DE ANCHO CERO SIN QUIEBRA} es un carácter normal que se decodificará como cualquier otro.

Hay otra codificación que puede codificar el rango completo de caracteres Unicode: UTF-8. UTF-8 es una codificación de 8 bits, lo que significa que no hay problemas con el orden de bytes en UTF-8. Cada byte en una secuencia de bytes UTF-8 consta de dos partes: bits marcadores (los bits más significativos) y bits de carga útil. Los bits marcadores son una secuencia de cero a cuatro bits @code{1} seguidos de un bit @code{0}. Los caracteres Unicode se codifican de esta manera (con x siendo bits de carga útil, que cuando se concatenan dan el carácter Unicode):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Rango

@tab

Codificación

@item

@code{U-00000000} … @code{U-0000007F}

@tab

0xxxxxxx

@item

@code{U-00000080} … @code{U-000007FF}

@tab

110xxxxx 10xxxxxx

@item

@code{U-00000800} … @code{U-0000FFFF}

@tab

1110xxxx 10xxxxxx 10xxxxxx

@item

@code{U-00010000} … @code{U-0010FFFF}

@tab

11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

@end multitable


El bit menos significativo del carácter Unicode es el bit x más a la derecha.

Como UTF-8 es una codificación de 8 bits, no se requiere una lista de materiales y cualquier carácter @code{U+FEFF} en la cadena decodificada (incluso si es el primer carácter) se trata como un @code{ESPACIO SIN QUIEBRE DE ANCHO CERO} (``@w{`}ZERO WIDTH NO-BREAK SPACE`@w{`}').

Sin información externa, es imposible determinar de manera fidedigna qué codificación se utilizó para codificar una cadena de caracteres. Cada codificación de mapa de caracteres puede decodificar cualquier secuencia de bytes aleatoria. Sin embargo, eso no es posible con UTF-8, ya que las secuencias de bytes UTF-8 tienen una estructura que no permite secuencias de bytes arbitrarias. Para aumentar la confiabilidad con la que se puede detectar una codificación UTF-8, Microsoft inventó una variante de UTF-8 (que Python 2.5 llama @code{"utf-8-sig"}) para su programa Bloc de notas: Antes de que cualquier carácter Unicode sea escrito en un archivo, se escribe un BOM codificado en UTF-8 (que se muestra como una secuencia de bytes: @code{0xef}, @code{0xbb}, @code{0xbf}). Como es bastante improbable que cualquier archivo codificado del mapa de caracteres comience con estos valores de bytes (que, por ejemplo, se asignarían a

@quotation


@display
LETRA LATINA PEQUEÑA I CON DIAERESIS@w{ }
SEÑALADO A LA DERECHA DE DOBLE ÁNGULO MARCA DE CITA@w{ }
SIGNO DE PREGUNTA INVERTIDO@w{ }
@end display


@end quotation

en iso-8859-1), esto aumenta la probabilidad de que una codificación @code{utf-8-sig} pueda adivinarse correctamente a partir de la secuencia de bytes. Por lo tanto, aquí la lista de materiales no se utiliza para poder determinar el orden de bytes utilizado para generar la secuencia de bytes, sino como una firma que ayuda a adivinar la codificación. Al codificar, el códec utf-8-sig escribirá @code{0xef}, @code{0xbb}, @code{0xbf} como los primeros tres bytes del archivo. Al decodificar, @code{utf-8-sig} omitirá esos tres bytes si aparecen como los primeros tres bytes en el archivo. En UTF-8, se desaconseja el uso de la lista de materiales y, en general, debe evitarse.

@node Codificaciones estándar,Codificaciones específicas de Python,Codificaciones y Unicode,codecs — Codec registry and base classes
@anchor{library/codecs id3}@anchor{240f}@anchor{library/codecs standard-encodings}@anchor{e3e}
@subsubsection Codificaciones estándar


Python viene con una serie de códecs integrados, ya sea implementados como funciones C o con diccionarios como tablas de mapeo. La siguiente tabla enumera los códecs por nombre, junto con algunos alias comunes y los idiomas para los que probablemente se usa la codificación. Ni la lista de alias ni la lista de idiomas deben ser exhaustivas. Tenga en cuenta que las alternativas de ortografía que solo difieren en el caso o usan un guión en lugar de un guión bajo también son alias válidos; por lo tanto, por ejemplo @code{'utf-8'} es un alias válido para el códec @code{'utf_8'}.

`Detalles de implementación de CPython:' Algunas codificaciones comunes pueden omitir la maquinaria de búsqueda de códecs para mejorar el rendimiento. CPython solo reconoce estas oportunidades de optimización para un conjunto limitado de alias (sin distinción entre mayúsculas y minúsculas): utf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (solo Windows), ascii, us-ascii, utf-16, utf16, utf-32, utf32, y lo mismo usando guiones bajos en lugar de guiones. El uso de alias alternativos para estas codificaciones puede resultar en una ejecución más lenta.


Distinto en la versión 3.6: Oportunidad de optimización reconocida para us-ascii.


Muchos de los juegos de caracteres admiten los mismos idiomas. Varían en caracteres individuales (por ejemplo, si el SIGNO EURO es compatible o no), y en la asignación de caracteres para codificar posiciones. Para los idiomas europeos en particular, generalmente existen las siguientes variantes:


@itemize *

@item 
un conjunto de códigos ISO 8859

@item 
una página de códigos de Microsoft Windows, que generalmente se deriva de un conjunto de códigos 8859, pero reemplaza los caracteres de control con caracteres gráficos adicionales

@item 
una página de códigos EBCDIC de IBM

@item 
una página de códigos de IBM PC, que es compatible con ASCII
@end itemize


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Códec

@tab

Aliases

@tab

Lenguajes

@item

ascii

@tab

646, us-ascii

@tab

Inglés

@item

big5

@tab

big5-tw, csbig5

@tab

Chino Tradicional

@item

big5hkscs

@tab

big5-hkscs, hkscs

@tab

Chino Tradicional

@item

cp037

@tab

IBM037, IBM039

@tab

Inglés

@item

cp273

@tab

273, IBM273, csIBM273

@tab

Alemán


Added in version 3.4.


@item

cp424

@tab

EBCDIC-CP-HE, IBM424

@tab

Hebreo

@item

cp437

@tab

437, IBM437

@tab

Inglés

@item

cp500

@tab

EBCDIC-CP-BE, EBCDIC-CP-CH,
IBM500

@tab

Europa Occidental

@item

cp720

@tab

@tab

Árabe

@item

cp737

@tab

@tab

Griego

@item

cp775

@tab

IBM775

@tab

Lenguajes bálticos

@item

cp850

@tab

850, IBM850

@tab

Europa Occidental

@item

cp852

@tab

852, IBM852

@tab

Europa central y del este

@item

cp855

@tab

855, IBM855

@tab

Búlgaro, Bielorruso, Macedonio, Ruso, Serbio

@item

cp856

@tab

@tab

Hebreo

@item

cp857

@tab

857, IBM857

@tab

Turco

@item

cp858

@tab

858, IBM858

@tab

Europa Occidental

@item

cp860

@tab

860, IBM860

@tab

Portugués

@item

cp861

@tab

861, CP-IS, IBM861

@tab

Islandés

@item

cp862

@tab

862, IBM862

@tab

Hebreo

@item

cp863

@tab

863, IBM863

@tab

Canadiense

@item

cp864

@tab

IBM864

@tab

Árabe

@item

cp865

@tab

865, IBM865

@tab

Danés, Noruego

@item

cp866

@tab

866, IBM866

@tab

Ruso

@item

cp869

@tab

869, CP-GR, IBM869

@tab

Griego

@item

cp874

@tab

@tab

Tailandés

@item

cp875

@tab

@tab

Griego

@item

cp932

@tab

932, ms932, mskanji, ms-kanji,
windows-31j

@tab

Japonés

@item

cp949

@tab

949, ms949, uhc

@tab

Coreano

@item

cp950

@tab

950, ms950

@tab

Chino Tradicional

@item

cp1006

@tab

@tab

Urdu

@item

cp1026

@tab

ibm1026

@tab

Turco

@item

cp1125

@tab

1125, ibm1125, cp866u, ruscii

@tab

Ucraniano


Added in version 3.4.


@item

cp1140

@tab

ibm1140

@tab

Europa Occidental

@item

cp1250

@tab

windows-1250

@tab

Europa central y del este

@item

cp1251

@tab

windows-1251

@tab

Búlgaro, Bielorruso, Macedonio, Ruso, Serbio

@item

cp1252

@tab

windows-1252

@tab

Europa Occidental

@item

cp1253

@tab

windows-1253

@tab

Griego

@item

cp1254

@tab

windows-1254

@tab

Turco

@item

cp1255

@tab

windows-1255

@tab

Hebreo

@item

cp1256

@tab

windows-1256

@tab

Árabe

@item

cp1257

@tab

windows-1257

@tab

Lenguajes bálticos

@item

cp1258

@tab

windows-1258

@tab

Vietnamita

@item

euc_jp

@tab

eucjp, ujis, u-jis

@tab

Japonés

@item

euc_jis_2004

@tab

jisx0213, eucjis2004

@tab

Japonés

@item

euc_jisx0213

@tab

eucjisx0213

@tab

Japonés

@item

euc_kr

@tab

euckr, korean, ksc5601,
ks_c-5601, ks_c-5601-1987,
ksx1001, ks_x-1001

@tab

Coreano

@item

gb2312

@tab

chinese, csiso58gb231280,
euc-cn, euccn, eucgb2312-cn,
gb2312-1980, gb2312-80,
iso-ir-58

@tab

Chino simplificado

@item

gbk

@tab

936, cp936, ms936

@tab

Chino Unificado

@item

gb18030

@tab

gb18030-2000

@tab

Chino Unificado

@item

hz

@tab

hzgb, hz-gb, hz-gb-2312

@tab

Chino simplificado

@item

iso2022_jp

@tab

csiso2022jp, iso2022jp,
iso-2022-jp

@tab

Japonés

@item

iso2022_jp_1

@tab

iso2022jp-1, iso-2022-jp-1

@tab

Japonés

@item

iso2022_jp_2

@tab

iso2022jp-2, iso-2022-jp-2

@tab

Japonés, Coreano, Chino simplificado, Europa occidental, Griego

@item

iso2022_jp_2004

@tab

iso2022jp-2004,
iso-2022-jp-2004

@tab

Japonés

@item

iso2022_jp_3

@tab

iso2022jp-3, iso-2022-jp-3

@tab

Japonés

@item

iso2022_jp_ext

@tab

iso2022jp-ext, iso-2022-jp-ext

@tab

Japonés

@item

iso2022_kr

@tab

csiso2022kr, iso2022kr,
iso-2022-kr

@tab

Coreano

@item

latin_1

@tab

iso-8859-1, iso8859-1, 8859,
cp819, latin, latin1, L1

@tab

Europa Occidental

@item

iso8859_2

@tab

iso-8859-2, latin2, L2

@tab

Europa central y del este

@item

iso8859_3

@tab

iso-8859-3, latin3, L3

@tab

Esperanto, Maltés

@item

iso8859_4

@tab

iso-8859-4, latin4, L4

@tab

Lenguajes bálticos

@item

iso8859_5

@tab

iso-8859-5, cyrillic

@tab

Búlgaro, Bielorruso, Macedonio, Ruso, Serbio

@item

iso8859_6

@tab

iso-8859-6, arabic

@tab

Árabe

@item

iso8859_7

@tab

iso-8859-7, greek, greek8

@tab

Griego

@item

iso8859_8

@tab

iso-8859-8, hebrew

@tab

Hebreo

@item

iso8859_9

@tab

iso-8859-9, latin5, L5

@tab

Turco

@item

iso8859_10

@tab

iso-8859-10, latin6, L6

@tab

Lenguajes nórdicos

@item

iso8859_11

@tab

iso-8859-11, thai

@tab

Lenguajes tailandeses

@item

iso8859_13

@tab

iso-8859-13, latin7, L7

@tab

Lenguajes bálticos

@item

iso8859_14

@tab

iso-8859-14, latin8, L8

@tab

Lenguajes Celtas

@item

iso8859_15

@tab

iso-8859-15, latin9, L9

@tab

Europa Occidental

@item

iso8859_16

@tab

iso-8859-16, latin10, L10

@tab

Europa sudoriental

@item

johab

@tab

cp1361, ms1361

@tab

Coreano

@item

koi8_r

@tab

@tab

Ruso

@item

koi8_t

@tab

@tab

Tayiko


Added in version 3.5.


@item

koi8_u

@tab

@tab

Ucraniano

@item

kz1048

@tab

kz_1048, strk1048_2002, rk1048

@tab

Kazajo


Added in version 3.5.


@item

mac_cyrillic

@tab

maccyrillic

@tab

Búlgaro, Bielorruso, Macedonio, Ruso, Serbio

@item

mac_greek

@tab

macgreek

@tab

Griego

@item

mac_iceland

@tab

maciceland

@tab

Islandés

@item

mac_latin2

@tab

maclatin2, maccentraleurope,
mac_centeuro

@tab

Europa central y del este

@item

mac_roman

@tab

macroman, macintosh

@tab

Europa Occidental

@item

mac_turkish

@tab

macturkish

@tab

Turco

@item

ptcp154

@tab

csptcp154, pt154, cp154,
cyrillic-asian

@tab

Kazajo

@item

shift_jis

@tab

csshiftjis, shiftjis, sjis,
s_jis

@tab

Japonés

@item

shift_jis_2004

@tab

shiftjis2004, sjis_2004,
sjis2004

@tab

Japonés

@item

shift_jisx0213

@tab

shiftjisx0213, sjisx0213,
s_jisx0213

@tab

Japonés

@item

utf_32

@tab

U32, utf32

@tab

todos los lenguajes

@item

utf_32_be

@tab

UTF-32BE

@tab

todos los lenguajes

@item

utf_32_le

@tab

UTF-32LE

@tab

todos los lenguajes

@item

utf_16

@tab

U16, utf16

@tab

todos los lenguajes

@item

utf_16_be

@tab

UTF-16BE

@tab

todos los lenguajes

@item

utf_16_le

@tab

UTF-16LE

@tab

todos los lenguajes

@item

utf_7

@tab

U7, unicode-1-1-utf-7

@tab

todos los lenguajes

@item

utf_8

@tab

U8, UTF, utf8, cp65001

@tab

todos los lenguajes

@item

utf_8_sig

@tab

@tab

todos los lenguajes

@end multitable



Distinto en la versión 3.4: Los codificadores utf-16* y utf-32* ya no permiten codificar puntos de código sustitutos (@code{U+D800} – @code{U+DFFF}). Los decodificadores utf-32* ya no decodifican secuencias de bytes que corresponden a puntos de código sustituto.



Distinto en la versión 3.8: @code{cp65001} ahora es un alias de @code{utf_8}.


@node Codificaciones específicas de Python,encodings idna — Nombres de dominio internacionalizados en aplicaciones,Codificaciones estándar,codecs — Codec registry and base classes
@anchor{library/codecs python-specific-encodings}@anchor{2410}
@subsubsection Codificaciones específicas de Python


Varios códecs predefinidos son específicos de Python, por lo que sus nombres de códec no tienen significado fuera de Python. Estos se enumeran en las tablas a continuación según los tipos de entrada y salida esperados (tenga en cuenta que si bien las codificaciones de texto son el caso de uso más común para los códecs, la infraestructura de códecs subyacente admite transformaciones de datos arbitrarias en lugar de solo codificaciones de texto). Para los códecs asimétricos, el significado indicado describe la dirección de codificación.

@menu
* Codificaciones de texto:: 
* Transformaciones Binarias:: 
* Transformaciones de texto:: 

@end menu

@node Codificaciones de texto,Transformaciones Binarias,,Codificaciones específicas de Python
@anchor{library/codecs text-encodings}@anchor{2411}
@subsubsection Codificaciones de texto


Los siguientes códecs proporcionan codificación de @ref{237,,str} a @ref{325,,bytes} y decodificación de @ref{db4,,bytes-like object} a @ref{237,,str}, similar a las codificaciones de texto Unicode.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Códec

@tab

Aliases

@tab

Significado

@item

idna

@tab

@tab

Implementar 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}, ver también @ref{52,,encodings.idna}. Solo se admite @code{errors='strict'}.

@item

mbcs

@tab

ansi,
dbcs

@tab

Solo Windows: codifique el operando de acuerdo con la página de códigos ANSI (CP_ACP).

@item

oem

@tab

@tab

Solo Windows: codifique el operando de acuerdo con la página de códigos OEM (CP_OEMCP).


Added in version 3.6.


@item

palmos

@tab

@tab

Codificación de PalmOS 3.5.

@item

punycode

@tab

@tab

Implementar 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html}. Los códecs con estado no son compatibles.

@item

raw_unicode_escape

@tab

@tab

Codificación Latin-1 con @code{\u@var{XXXX}} y @code{\U@var{XXXXXXXX}} para otros puntos de código. Las barras invertidas existentes no se escapan de ninguna manera. Se usa en el protocolo Python `pickle'.

@item

indefinido

@tab

@tab

Lanza una excepción para todas las conversiones, incluso cadenas vacías. El manejador de errores se ignora.

@item

unicode_escape

@tab

@tab

Codificación adecuada como contenido de un literal Unicode en código fuente Python codificado en ASCII, excepto que no se escapan las comillas. Decodificar desde el código fuente Latin-1. Tenga en cuenta que el código fuente de Python realmente usa UTF-8 por defecto.

@end multitable



Distinto en la versión 3.8: Se elimina el códec «unicode_internal».


@node Transformaciones Binarias,Transformaciones de texto,Codificaciones de texto,Codificaciones específicas de Python
@anchor{library/codecs binary-transforms}@anchor{f86}@anchor{library/codecs id4}@anchor{2412}
@subsubsection Transformaciones Binarias


Los siguientes códecs proporcionan transformaciones binarias: mapeos de @ref{db4,,bytes-like object} a @ref{325,,bytes}. No son compatibles con @ref{96d,,bytes.decode()} (que solo produce @ref{237,,str} de salida).


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Códec

@tab

Aliases

@tab

Significado

@tab

Codificador / decodificador

@item

base64_codec @footnote{
Además de @ref{db4,,objetos similares a bytes}, @code{'base64_codec'} también acepta instancias solo ASCII de @ref{237,,str} para decodificación
}

@tab

base64, base_64

@tab

Convierta el operando a MIME base64 multilínea (el resultado siempre incluye un @code{'\n'} final).


Distinto en la versión 3.4: acepta cualquier @ref{db4,,bytes-like object} como entrada para codificar y decodificar


@tab

@ref{9e6,,base64.encodebytes()} /
@ref{9e7,,base64.decodebytes()}

@item

bz2_codec

@tab

bz2

@tab

Comprime el operando usando bz2.

@tab

@ref{2413,,bz2.compress()} /
@ref{110b,,bz2.decompress()}

@item

hex_codec

@tab

hex

@tab

Convierte el operando en representación hexadecimal, con dos dígitos por byte.

@tab

@ref{2414,,binascii.b2a_hex()} /
@ref{2415,,binascii.a2b_hex()}

@item

quopri_codec

@tab

quopri,
quotedprintable,
quoted_printable

@tab

Convierte el operando a MIME citado imprimible.

@tab

@ref{2416,,quopri.encode()} con @code{quotetabs=True} / @ref{2417,,quopri.decode()}

@item

uu_codec

@tab

uu

@tab

Convierte el operando usando uuencode.

@tab

@item

zlib_codec

@tab

zip, zlib

@tab

Comprime el operando usando gzip.

@tab

@ref{6e0,,zlib.compress()} /
@ref{d94,,zlib.decompress()}

@end multitable



Added in version 3.2: Restauración de las transformaciones binarias.



Distinto en la versión 3.4: Restauración de los alias para las transformaciones binarias.


@node Transformaciones de texto,,Transformaciones Binarias,Codificaciones específicas de Python
@anchor{library/codecs id6}@anchor{2418}@anchor{library/codecs text-transforms}@anchor{f87}
@subsubsection Transformaciones de texto


El siguiente códec proporciona una transformación de texto: un mapeo de @ref{237,,str} a @ref{237,,str}. No es compatible con @ref{96c,,str.encode()} (que solo produce @ref{325,,bytes} de salida).


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Códec

@tab

Aliases

@tab

Significado

@item

rot_13

@tab

rot13

@tab

Retorna el cifrado César (`Caesar-cypher') del operando.

@end multitable



Added in version 3.2: Restauración de la transformación de texto @code{rot_13}.



Distinto en la versión 3.4: Restauración del alias @code{rot13}.


@node encodings idna — Nombres de dominio internacionalizados en aplicaciones,encodings mbcs — Página de códigos ANSI de Windows,Codificaciones específicas de Python,codecs — Codec registry and base classes
@anchor{library/codecs encodings-idna-internationalized-domain-names-in-applications}@anchor{2419}@anchor{library/codecs module-encodings idna}@anchor{52}
@subsubsection @code{encodings.idna} — Nombres de dominio internacionalizados en aplicaciones


@geindex module; encodings.idna

Este módulo implementa 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html} (nombres de dominio internacionalizados en aplicaciones) y 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html} (`Nameprep': un perfil de `Stringprep' para nombres de dominio internacionalizados (IDN)). Se basa en la codificación @code{punycode} y @ref{d4,,stringprep}.

If you need the IDNA 2008 standard from 
@geindex RFC; RFC 5891
RFC 5891@footnote{https://datatracker.ietf.org/doc/html/rfc5891.html} and 
@geindex RFC; RFC 5895
RFC 5895@footnote{https://datatracker.ietf.org/doc/html/rfc5895.html}, use the
third-party idna@footnote{https://pypi.org/project/idna/} module.

Estas RFC juntas definen un protocolo para admitir caracteres no ASCII en los nombres de dominio. Un nombre de dominio que contiene caracteres no ASCII (como @code{www.Alliancefrançaise.nu}) se convierte en una codificación compatible con ASCII (ACE, como @code{www.xn--alliancefranaise-npb.nu}). La forma ACE del nombre de dominio se utiliza en todos los lugares donde el protocolo no permite caracteres arbitrarios, como consultas DNS, campos HTTP @code{Host}, etc. Esta conversión se lleva a cabo en la aplicación; si es posible invisible para el usuario: la aplicación debe convertir de forma transparente las etiquetas de dominio Unicode a IDNA en el cable, y volver a convertir las etiquetas ACE a Unicode antes de presentarlas al usuario.

Python admite esta conversión de varias maneras: el códec @code{idna} realiza la conversión entre Unicode y ACE, separando una cadena de entrada en etiquetas basadas en los caracteres separadores definidos en la sección 3.1 de RFC 3490 
@geindex RFC; RFC 3490 Section 3.1
RFC 3490 Section 3.1@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html#section-3.1} y convertir cada etiqueta a ACE según sea necesario, y por el contrario, separar una cadena de bytes de entrada en etiquetas basadas en el separador @code{.} y convertir cualquier etiqueta ACE encontrada en unicode. Además, el módulo @ref{cc,,socket} convierte de forma transparente los nombres de host Unicode a ACE, por lo que las aplicaciones no necesitan preocuparse por convertir los nombres de host ellos mismos cuando los pasan al módulo de socket. Además de eso, los módulos que tienen nombres de host como parámetros de función, como @ref{6f,,http.client} y @ref{5e,,ftplib}, aceptan nombres de host Unicode (@ref{6f,,http.client} y luego también envían un mensaje transparente IDNA `hostname' en el campo @code{Host} si envía ese campo).

Al recibir nombres de host desde el cable (como en la búsqueda inversa de nombres), no se realiza una conversión automática a Unicode: las aplicaciones que deseen presentar dichos nombres de host al usuario deben decodificarlos en Unicode.

El módulo @ref{52,,encodings.idna} también implementa el procedimiento `nameprep', que realiza ciertas normalizaciones en los nombres de host, para lograr la insensibilidad a mayúsculas y minúsculas de los nombres de dominio internacionales y unificar caracteres similares. Las funciones `nameprep' se pueden usar directamente si lo desea.

@geindex nameprep() (en el módulo encodings.idna)
@anchor{library/codecs encodings idna nameprep}@anchor{241a}
@deffn {Función} encodings.idna.nameprep (label)

Retorna la versión pasada por `nameprep' (o versión `nameprepped') de `label'. La implementación actualmente asume cadenas de caracteres de consulta, por lo que @code{AllowUnassigned} es verdadero.
@end deffn

@geindex ToASCII() (en el módulo encodings.idna)
@anchor{library/codecs encodings idna ToASCII}@anchor{241b}
@deffn {Función} encodings.idna.ToASCII (label)

Convierte una etiqueta a ASCII, como se especifica en 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}. Se supone que @code{UseSTD3ASCIIRules} es falso.
@end deffn

@geindex ToUnicode() (en el módulo encodings.idna)
@anchor{library/codecs encodings idna ToUnicode}@anchor{241c}
@deffn {Función} encodings.idna.ToUnicode (label)

Convierte una etiqueta a Unicode, como se especifica en 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}.
@end deffn

@node encodings mbcs — Página de códigos ANSI de Windows,encodings utf_8_sig — Códec UTF-8 con firma BOM,encodings idna — Nombres de dominio internacionalizados en aplicaciones,codecs — Codec registry and base classes
@anchor{library/codecs encodings-mbcs-windows-ansi-codepage}@anchor{241d}@anchor{library/codecs module-encodings mbcs}@anchor{53}
@subsubsection @code{encodings.mbcs} — Página de códigos ANSI de Windows


@geindex module; encodings.mbcs

Este módulo implementa la página de códigos ANSI (CP_ACP).

@ref{1d5a,,Availability}: Windows.


Distinto en la versión 3.2: Antes de 3.2, se ignoraba el argumento `errors'; @code{'replace'} siempre se usó para codificar e @code{'ignore'} para decodificar.



Distinto en la versión 3.3: Admite cualquier manejador de errores.


@node encodings utf_8_sig — Códec UTF-8 con firma BOM,,encodings mbcs — Página de códigos ANSI de Windows,codecs — Codec registry and base classes
@anchor{library/codecs encodings-utf-8-sig-utf-8-codec-with-bom-signature}@anchor{241e}@anchor{library/codecs module-encodings utf_8_sig}@anchor{54}
@subsubsection @code{encodings.utf_8_sig} — Códec UTF-8 con firma BOM


@geindex module; encodings.utf_8_sig

Este módulo implementa una variante del códec UTF-8. Al codificar, una lista de materiales codificada en UTF-8 se antepondrá a los bytes codificados en UTF-8. Para el codificador con estado esto solo se hace una vez (en la primera escritura en el flujo de bytes). En la decodificación, se omitirá una lista de materiales opcional codificada en UTF-8 al comienzo de los datos.

@node Tipos de datos,Módulos numéricos y matemáticos,Servicios de datos binarios,La biblioteca estándar de Python
@anchor{library/datatypes doc}@anchor{241f}@anchor{library/datatypes data-types}@anchor{2420}@anchor{library/datatypes datatypes}@anchor{2421}
@section Tipos de datos


Los módulos descritos en este capítulo proporcionan una variedad de tipos de datos especializados, como fechas y horas, matrices de tipo fijo (`fixed-type arrays'), colas de montículos (`heap queues'), colas de doble extremo (`double-ended queues') y enumeraciones.

Python también proporciona algunos tipos de datos integrados, concretamente @ref{190,,dict}, @ref{18e,,list}, @ref{67a,,set} y @ref{67b,,frozenset}, y @ref{464,,tuple}. La clase @ref{237,,str} se utiliza para contener cadenas de caracteres Unicode, y las clases @ref{325,,bytes} y @ref{5e0,,bytearray} se utilizan para contener datos binarios.

En este capítulo se documentan los siguientes módulos:

@menu
* datetime — Basic date and time types:: 
* zoneinfo — IANA time zone support:: 
* calendar — General calendar-related functions:: 
* collections — Container datatypes:: 
* collections.abc — Abstract Base Classes for Containers: collections abc — Abstract Base Classes for Containers. 
* heapq — Heap queue algorithm:: 
* bisect — Array bisection algorithm:: 
* array — Efficient arrays of numeric values:: 
* weakref — Referencias débiles:: 
* types — Dynamic type creation and names for built-in types:: 
* copy — Shallow and deep copy operations:: 
* pprint — Data pretty printer:: 
* reprlib — Alternate repr() implementation: reprlib — Alternate repr implementation. 
* enum — Support for enumerations:: 
* graphlib — Functionality to operate with graph-like structures:: 

@end menu

@node datetime — Basic date and time types,zoneinfo — IANA time zone support,,Tipos de datos
@anchor{library/datetime doc}@anchor{2422}@anchor{library/datetime datetime-basic-date-and-time-types}@anchor{2423}@anchor{library/datetime module-datetime}@anchor{31}
@subsection @code{datetime} — Basic date and time types


@geindex module; datetime

`Código fuente:' Lib/datetime.py@footnote{https://github.com/python/cpython/tree/main/Lib/datetime.py}


__________________________________________________________________


@c XXX what order should the types be discussed in?

The @code{datetime} module supplies classes for manipulating dates and times.

Si bien la implementación permite operaciones aritméticas con fechas y horas, su principal objetivo es poder extraer campos de forma eficiente para su posterior manipulación o formateo.

@cartouche
@quotation Truco 
Skip to @ref{2424,,the format codes}.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item Módulo @ref{15,,calendar}

Funciones generales relacionadas a `calendar'.

@item Módulo @ref{ee,,time}

Acceso a tiempo y conversiones.

@item Módulo @ref{133,,zoneinfo}

Zonas horarias concretas que representan la base de datos de zonas horarias de la IANA.

@item Paquete dateutil@footnote{https://dateutil.readthedocs.io/en/stable/}

Biblioteca de terceros con zona horaria ampliada y soporte de análisis.

@item Package DateType@footnote{https://pypi.org/project/DateType/}

Third-party library that introduces distinct static types to e.g. allow
@ref{3c4,,static type checkers}
to differentiate between naive and aware datetimes.
@end table


@menu
* Objetos conscientes (aware) y naífs (naive): Objetos conscientes aware y naífs naive. 
* Constantes:: 
* Tipos disponibles:: 
* Objetos timedelta:: 
* Objeto date:: 
* Objetos datetime:: 
* Objetos time:: 
* Objetos tzinfo:: 
* Objetos timezone:: 
* strftime() and strptime() Behavior: strftime and strptime Behavior. 

@end menu

@node Objetos conscientes aware y naífs naive,Constantes,,datetime — Basic date and time types
@anchor{library/datetime aware-and-naive-objects}@anchor{2425}@anchor{library/datetime datetime-naive-aware}@anchor{2426}
@subsubsection Objetos conscientes (`aware') y naífs (`naive')


Date and time objects may be categorized as «aware» or «naive» depending on
whether or not they include time zone information.

Con suficiente conocimiento de los ajustes de tiempo políticos y algorítmicos aplicables, como la zona horaria y la información del horario de verano, un objeto `consciente' puede ubicarse en relación con otros objetos conscientes. Un objeto consciente representa un momento específico en el tiempo que no está abierto a interpretación. @footnote{
Es decir, si ignoramos los efectos de la relatividad
}

A `naive' object does not contain enough information to unambiguously locate
itself relative to other date/time objects. Whether a naive object represents
Coordinated Universal Time (UTC), local time, or time in some other time zone is
purely up to the program, just like it is up to the program whether a
particular number represents metres, miles, or mass. Naive objects are easy to
understand and to work with, at the cost of ignoring some aspects of reality.

Para las aplicaciones que requieren objetos conscientes, los objetos @ref{32f,,datetime} y @ref{331,,time} tienen un atributo de información de zona horaria opcional, @code{tzinfo}, que se puede establecer en una instancia de una subclase de la clase abstracta @ref{67f,,tzinfo}. Estos objetos @ref{67f,,tzinfo} capturan información sobre el desplazamiento de la hora UTC, el nombre de la zona horaria y si el horario de verano está en vigor.

Only one concrete @ref{67f,,tzinfo} class, the @ref{1134,,timezone} class, is
supplied by the @code{datetime} module. The @code{timezone} class can
represent simple time zones with fixed offsets from UTC, such as UTC itself or
North American EST and EDT time zones. Supporting time zones at deeper levels of
detail is up to the application. The rules for time adjustment across the
world are more political than rational, change frequently, and there is no
standard suitable for every application aside from UTC.

@node Constantes,Tipos disponibles,Objetos conscientes aware y naífs naive,datetime — Basic date and time types
@anchor{library/datetime constants}@anchor{2427}
@subsubsection Constantes


The @code{datetime} module exports the following constants:

@geindex MINYEAR (en el módulo datetime)
@anchor{library/datetime datetime MINYEAR}@anchor{2428}
@deffn {Dato} datetime.MINYEAR

The smallest year number allowed in a @ref{330,,date} or @ref{32f,,datetime} object.
@ref{2428,,MINYEAR} is 1.
@end deffn

@geindex MAXYEAR (en el módulo datetime)
@anchor{library/datetime datetime MAXYEAR}@anchor{2429}
@deffn {Dato} datetime.MAXYEAR

The largest year number allowed in a @ref{330,,date} or @ref{32f,,datetime} object.
@ref{2429,,MAXYEAR} is 9999.
@end deffn

@geindex UTC (en el módulo datetime)
@anchor{library/datetime datetime UTC}@anchor{594}
@deffn {Atributo} datetime.UTC

Alias for the UTC time zone singleton @ref{6b4,,datetime.timezone.utc}.


Added in version 3.11.

@end deffn

@node Tipos disponibles,Objetos timedelta,Constantes,datetime — Basic date and time types
@anchor{library/datetime available-types}@anchor{242a}
@subsubsection Tipos disponibles



@deffn {Clase} datetime.date

Una fecha naíf (`naive') idealizada, suponiendo que el calendario gregoriano actual siempre estuvo, y siempre estará, vigente. Atributos: @ref{242b,,year}, @ref{242c,,month}, y @ref{242d,,day}.
@end deffn


@deffn {Clase} datetime.time

Un tiempo idealizado, independiente de cualquier día en particular, suponiendo que cada día tenga exactamente 24* 60* 60 segundos. (Aquí no hay noción de «segundos intercalares».) Atributos: @ref{242e,,hour}, @ref{242f,,minute}, @ref{2430,,second}, @ref{2431,,microsecond}, y @ref{2432,,tzinfo}.
@end deffn


@deffn {Clase} datetime.datetime

Una combinación de una fecha y una hora. Atributos: @ref{2433,,year}, @ref{2434,,month}, @ref{2435,,day}, @ref{2436,,hour}, @ref{2437,,minute}, @ref{2438,,second}, @ref{2439,,microsecond} , y @ref{243a,,tzinfo}.
@end deffn


@deffn {Clase} datetime.timedelta

A duration expressing the difference between two @ref{32f,,datetime}
or @ref{330,,date} instances to microsecond resolution.
@end deffn


@deffn {Clase} datetime.tzinfo

Una clase base abstracta para objetos de información de zona horaria. Estos son utilizados por las clases @ref{32f,,datetime} y @ref{331,,time} para proporcionar una noción personalizable de ajuste de hora (por ejemplo, para tener en cuenta la zona horaria y / o el horario de verano).
@end deffn


@deffn {Clase} datetime.timezone

Una clase que implementa la clase de base abstracta @ref{67f,,tzinfo} como un desplazamiento fijo desde el UTC.


Added in version 3.2.

@end deffn

Los objetos de este tipo son inmutables.

Relaciones de subclase:

@example
object
    timedelta
    tzinfo
        timezone
    time
    date
        datetime
@end example

@menu
* Propiedades comunes:: 
* Determinando si un objeto es Consciente (Aware) o Naíf (Naive): Determinando si un objeto es Consciente Aware o Naíf Naive. 

@end menu

@node Propiedades comunes,Determinando si un objeto es Consciente Aware o Naíf Naive,,Tipos disponibles
@anchor{library/datetime common-properties}@anchor{243b}
@subsubsection Propiedades comunes


Las clases @ref{330,,date}, @ref{32f,,datetime}, @ref{331,,time}, y @ref{1134,,timezone} comparten estas características comunes:


@itemize -

@item 
Los objetos de este tipo son inmutables.

@item 
Objects of these types are @ref{6b1,,hashable}, meaning that they can be used as
dictionary keys.

@item 
Los objetos de este tipo admiten el `pickling' eficiente a través del módulo @ref{a6,,pickle}.
@end itemize

@node Determinando si un objeto es Consciente Aware o Naíf Naive,,Propiedades comunes,Tipos disponibles
@anchor{library/datetime determining-if-an-object-is-aware-or-naive}@anchor{243c}
@subsubsection Determinando si un objeto es Consciente (`Aware') o Naíf (`Naive')


Los objetos del tipo @ref{330,,date} son siempre naíf (`naive').

Un objeto de tipo @ref{331,,time} o @ref{32f,,datetime} puede ser consciente (`aware') o naíf (`naive').

A @ref{32f,,datetime} object @code{d} is aware if both of the following hold:


@enumerate 

@item 
@code{d.tzinfo} no es @code{None}

@item 
@code{d.tzinfo.utcoffset(d)} no retorna @code{None}
@end enumerate

Otherwise, @code{d} is naive.

A @ref{331,,time} object @code{t} is aware if both of the following hold:


@enumerate 

@item 
@code{t.tzinfo} no es @code{None}

@item 
@code{t.tzinfo.utcoffset(None)} no retorna @code{None}.
@end enumerate

Otherwise, @code{t} is naive.

La distinción entre los objetos consciente (`aware') y naíf (`naive') no se aplica a @ref{a61,,timedelta}.

@node Objetos timedelta,Objeto date,Tipos disponibles,datetime — Basic date and time types
@anchor{library/datetime datetime-timedelta}@anchor{243d}@anchor{library/datetime timedelta-objects}@anchor{243e}
@subsubsection Objetos @code{timedelta}


A @ref{a61,,timedelta} object represents a duration, the difference between two
@ref{32f,,datetime} or @ref{330,,date} instances.

@geindex timedelta (clase en datetime)
@anchor{library/datetime datetime timedelta}@anchor{a61}
@deffn {Clase} datetime.timedelta (days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

All arguments are optional and default to 0. Arguments may be integers
or floats, and may be positive or negative.

Solo `days', `seconds' y `microseconds' se almacenan internamente. Los argumentos se convierten a esas unidades:


@itemize *

@item 
Un milisegundo se convierte a 1000 microsegundos.

@item 
Un minuto se convierte a 60 segundos.

@item 
Una hora se convierte a 3600 segundos.

@item 
Una semana se convierte a 7 días.
@end itemize

y los días, segundos y microsegundos se normalizan para que la representación sea única, con


@itemize *

@item 
@code{0 <= microsegundos < 1000000}

@item 
@code{0 <= segundos< 3600*24} (el número de segundos en un día)

@item 
@code{-999999999 <= days <= 999999999}
@end itemize

El siguiente ejemplo ilustra cómo cualquier argumento además de `days', `seconds' y `microseconds' se «fusionan» y normalizan en esos tres atributos resultantes:

@example
>>> from datetime import timedelta
>>> delta = timedelta(
...     days=50,
...     seconds=27,
...     microseconds=10,
...     milliseconds=29000,
...     minutes=5,
...     hours=8,
...     weeks=2
... )
>>> # Only days, seconds, and microseconds remain
>>> delta
datetime.timedelta(days=64, seconds=29156, microseconds=10)
@end example

Si algún argumento es flotante y hay microsegundos fraccionarios, los microsegundos fraccionarios que quedan de todos los argumentos se combinan y su suma se redondea al microsegundo más cercano utilizando el desempate de medio redondeo a par. Si ningún argumento es flotante, los procesos de conversión y normalización son exactos (no se pierde información).

Si el valor normalizado de los días se encuentra fuera del rango indicado, se lanza @ref{919,,OverflowError}.

Tenga en cuenta que la normalización de los valores negativos puede ser sorprendente al principio. Por ejemplo:

@example
>>> from datetime import timedelta
>>> d = timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)
@end example
@end deffn

Atributos de clase:

@geindex min (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta min}@anchor{243f}
@deffn {Atributo} timedelta.min

El objeto más negativo en @ref{a61,,timedelta}, @code{timedelta(-999999999)}.
@end deffn

@geindex max (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta max}@anchor{2440}
@deffn {Atributo} timedelta.max

El objeto más positivo de la @ref{a61,,timedelta}, @code{timedelta(days=999999999, hours=23, minutes=59, seconds=59, microseconds=999999)}.
@end deffn

@geindex resolution (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta resolution}@anchor{2441}
@deffn {Atributo} timedelta.resolution

La diferencia más pequeña posible entre los objetos no iguales @ref{a61,,timedelta} @code{timedelta(microseconds=1)}.
@end deffn

Note that, because of normalization, @code{timedelta.max} is greater than @code{-timedelta.min}.
@code{-timedelta.max} is not representable as a @ref{a61,,timedelta} object.

Atributos de instancia (solo lectura):

@geindex days (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta days}@anchor{2442}
@deffn {Atributo} timedelta.days

Between -999,999,999 and 999,999,999 inclusive.
@end deffn

@geindex seconds (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta seconds}@anchor{2443}
@deffn {Atributo} timedelta.seconds

Between 0 and 86,399 inclusive.

@cartouche
@quotation Prudencia 
It is a somewhat common bug for code to unintentionally use this attribute
when it is actually intended to get a @ref{136d,,total_seconds()}
value instead:

@example
>>> from datetime import timedelta
>>> duration = timedelta(seconds=11235813)
>>> duration.days, duration.seconds
(130, 3813)
>>> duration.total_seconds()
11235813.0
@end example
@end quotation
@end cartouche
@end deffn

@geindex microseconds (atributo de datetime.timedelta)
@anchor{library/datetime datetime timedelta microseconds}@anchor{2444}
@deffn {Atributo} timedelta.microseconds

Between 0 and 999,999 inclusive.
@end deffn

Operaciones soportadas:

@c XXX this table is too wide!


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@item

@code{t1 = t2 + t3}

@tab

Sum of @code{t2} and @code{t3}.
Afterwards @code{t1 - t2 == t3} and
@code{t1 - t3 == t2} are true. (1)

@item

@code{t1 = t2 - t3}

@tab

Difference of @code{t2}  and @code{t3}. Afterwards
@code{t1 == t2 - t3} and @code{t2 == t1 + t3} are
true. (1)(6)

@item

@code{t1 = t2 * i o t1 = i * t2}

@tab

Delta multiplied by an integer.
Afterwards @code{t1 // i == t2} is true,
provided @code{i != 0}.

@item

@tab

In general, @code{t1  * i == t1 * (i-1) + t1}
is true. (1)

@item

@code{t1 = t2 * f o t1 = f * t2}

@tab

Delta multiplicado por un número decimal. El resultado se redondea al múltiplo mas cercano de `timedelta.resolution' usando redondeo de medio a par.

@item

@code{f = t2 / t3}

@tab

Division (3) of overall duration @code{t2} by
interval unit @code{t3}. Returns a @ref{153,,float}
object.

@item

@code{t1 = t2 / f o t1 = t2 / i}

@tab

Delta dividido por un número decimal o un entero. El resultado se redondea al múltiplo más cercano de `timedelta.resolution' usando redondeo de medio a par.

@item

@code{t1 = t2 // i} o @code{t1 = t2 // t3}

@tab

El piso (`floor') se calcula y el resto (si lo hay) se descarta. En el segundo caso, se retorna un entero. (3)

@item

@code{t1 = t2 % t3}

@tab

El resto se calcula como un objeto @ref{a61,,timedelta}. (3)

@item

@code{q, r = divmod(t1, t2)}

@tab

Computes the quotient and the remainder:
@code{q = t1 // t2} (3) and @code{r = t1 % t2}.
@code{q} is an integer and @code{r} is a
@ref{a61,,timedelta} object.

@item

@code{+t1}

@tab

Retorna un objeto @ref{a61,,timedelta} con el mismo valor. (2)

@item

@code{-t1}

@tab

Equivalent to @code{timedelta(-t1.days,
-t1.seconds, -t1.microseconds)},
and to @code{t1 * -1}. (1)(4)

@item

@code{abs(t)}

@tab

Equivalent to @code{+t} when @code{t.days >= 0},
and to @code{-t} when @code{t.days < 0}. (2)

@item

@code{str(t)}

@tab

Retorna una cadena de caracteres en la forma @code{[D day[s], ][H]H:MM:SS[.UUUUUU]}, donde D es negativo para negativo @code{t}. (5)

@item

@code{repr(t)}

@tab

Retorna una representación de cadena del objeto @ref{a61,,timedelta} como una llamada de constructor con valores de atributos canónicos.

@end multitable


Notas:


@enumerate 

@item 
Esto es exacto pero puede desbordarse.

@item 
Esto es exacto pero no puede desbordarse.

@item 
Division by zero raises @ref{9d8,,ZeroDivisionError}.

@item 
@code{-timedelta.max} is not representable as a @ref{a61,,timedelta} object.

@item 
Las representaciones de cadena de caracteres de los objetos @ref{a61,,timedelta} se normalizan de manera similar a su representación interna. Esto conduce a resultados algo inusuales para `timedeltas' negativos. Por ejemplo:

@example
>>> timedelta(hours=-5)
datetime.timedelta(days=-1, seconds=68400)
>>> print(_)
-1 day, 19:00:00
@end example

@item 
La expresión @code{t2 - t3} siempre será igual a la expresión @code{t2 + (-t3)} excepto cuando `t3' es igual a @code{timedelta.max}; en ese caso, el primero producirá un resultado mientras que el segundo se desbordará.
@end enumerate

Además de las operaciones enumeradas anteriormente, los objetos @ref{a61,,timedelta} admiten ciertas sumas y restas con objetos @ref{330,,date} y @ref{32f,,datetime} (ver más abajo).


Distinto en la versión 3.2: La división entera a la baja y la división verdadera de un objeto @ref{a61,,timedelta} entre otro @ref{a61,,timedelta} ahora son compatibles, al igual que las operaciones de resto y la función @ref{a33,,divmod()}. La división verdadera y multiplicación de un objeto @ref{a61,,timedelta} por un objeto @ref{153,,float} ahora son compatibles.


@ref{a61,,timedelta} objects support equality and order comparisons.

En contextos booleanos, un objeto @ref{a61,,timedelta} se considera verdadero si y solo si no es igual a @code{timedelta (0)}.

Métodos de instancia:

@geindex total_seconds() (método de datetime.timedelta)
@anchor{library/datetime datetime timedelta total_seconds}@anchor{136d}
@deffn {Método} timedelta.total_seconds ()

Retorna el número total de segundos contenidos en la duración. Equivalente a @code{td / timedelta(segundos=1)}. Para unidades de intervalo que no sean segundos, use la forma de división directamente (por ejemplo, @code{td / timedelta(microseconds=1)}).

Tenga en cuenta que para intervalos de tiempo muy largos (más de 270 años en la mayoría de las plataformas) este método perderá precisión de microsegundos.


Added in version 3.2.

@end deffn

@menu
* Ejemplos de uso; timedelta: Ejemplos de uso timedelta. 

@end menu

@node Ejemplos de uso timedelta,,,Objetos timedelta
@anchor{library/datetime examples-of-usage-timedelta}@anchor{2445}
@subsubsection Ejemplos de uso: @code{timedelta}


Ejemplos adicionales de normalización:

@example
>>> # Components of another_year add up to exactly 365 days
>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> another_year = timedelta(weeks=40, days=84, hours=23,
...                          minutes=50, seconds=600)
>>> year == another_year
True
>>> year.total_seconds()
31536000.0
@end example

Ejemplos de @ref{a61,,timedelta} aritmética:

@example
>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> ten_years = 10 * year
>>> ten_years
datetime.timedelta(days=3650)
>>> ten_years.days // 365
10
>>> nine_years = ten_years - year
>>> nine_years
datetime.timedelta(days=3285)
>>> three_years = nine_years // 3
>>> three_years, three_years.days // 365
(datetime.timedelta(days=1095), 3)
@end example

@node Objeto date,Objetos datetime,Objetos timedelta,datetime — Basic date and time types
@anchor{library/datetime date-objects}@anchor{2446}@anchor{library/datetime datetime-date}@anchor{2447}
@subsubsection Objeto @code{date}


El objeto @ref{330,,date} representa una fecha (año, mes y día) en un calendario idealizado, el calendario gregoriano actual se extiende indefinidamente en ambas direcciones.

El 1 de enero del año 1 se llama día número 1, el 2 de enero del año 1 se llama día número 2, y así sucesivamente. @footnote{
Esto coincide con la definición del calendario «proléptico gregoriano» en el libro de `Dershowitz y Reingold' `Cálculos calendáricos', donde es el calendario base para todos los cálculos. Consulte el libro sobre algoritmos para convertir entre ordinales gregorianos prolépticos y muchos otros sistemas de calendario.
}

@geindex date (clase en datetime)
@anchor{library/datetime datetime date}@anchor{330}
@deffn {Clase} datetime.date (year, month, day)

Todos los argumentos son obligatorios. Los argumentos deben ser enteros, en los siguientes rangos:


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR}

@item 
@code{1 <= month <= 12}

@item 
@code{1 <= day <= number of days in the given month and year}
@end itemize

Si se proporciona un argumento fuera de esos rangos, @ref{360,,ValueError} se genera.
@end deffn

Otros constructores, todos los métodos de clase:

@geindex today() (método de clase de datetime.date)
@anchor{library/datetime datetime date today}@anchor{150a}
@deffn {Método} classmethod date.today ()

Retorna la fecha local actual.

Esto es equivalente a @code{date.fromtimestamp(time.time())}.
@end deffn

@geindex fromtimestamp() (método de clase de datetime.date)
@anchor{library/datetime datetime date fromtimestamp}@anchor{15cc}
@deffn {Método} classmethod date.fromtimestamp (timestamp)

Retorna la fecha local correspondiente a la marca de tiempo POSIX, tal como la retorna @ref{3ad,,time.time()}.

Esto puede generar @ref{919,,OverflowError}, si la marca de tiempo está fuera del rango de valores admitidos por la plataforma `C' @code{localtime()}, y @ref{4d5,,OSError} en @code{localtime()} falla . Es común que esto se restrinja a años desde 1970 hasta 2038. Tenga en cuenta que en los sistemas que no son POSIX que incluyen segundos bisiestos en su noción de marca de tiempo, los segundos bisiestos son ignorados por @ref{15cc,,fromtimestamp()}.


Distinto en la versión 3.3: Se genera @ref{919,,OverflowError} en lugar de @ref{360,,ValueError} si la marca de tiempo está fuera del rango de valores admitidos por la plataforma `C' @code{localtime()}. Se genera @ref{4d5,,OSError} en lugar de @ref{360,,ValueError} cuando @code{localtime()}, falla.

@end deffn

@geindex fromordinal() (método de clase de datetime.date)
@anchor{library/datetime datetime date fromordinal}@anchor{2448}
@deffn {Método} classmethod date.fromordinal (ordinal)

Retorna la fecha correspondiente al ordinal gregoriano proléptico, donde el 1 de enero del año 1 tiene el ordinal 1.

@ref{360,,ValueError} is raised unless @code{1 <= ordinal <=
date.max.toordinal()}. For any date @code{d},
@code{date.fromordinal(d.toordinal()) == d}.
@end deffn

@geindex fromisoformat() (método de clase de datetime.date)
@anchor{library/datetime datetime date fromisoformat}@anchor{6b5}
@deffn {Método} classmethod date.fromisoformat (date_string)

Return a @ref{330,,date} corresponding to a `date_string' given in any valid
ISO 8601 format, with the following exceptions:


@enumerate 

@item 
Reduced precision dates are not currently supported (@code{YYYY-MM},
@code{YYYY}).

@item 
Extended date representations are not currently supported
(@code{±YYYYYY-MM-DD}).

@item 
Ordinal dates are not currently supported (@code{YYYY-OOO}).
@end enumerate

Ejemplos:

@example
>>> from datetime import date
>>> date.fromisoformat('2019-12-04')
datetime.date(2019, 12, 4)
>>> date.fromisoformat('20191204')
datetime.date(2019, 12, 4)
>>> date.fromisoformat('2021-W01-1')
datetime.date(2021, 1, 4)
@end example


Added in version 3.7.



Distinto en la versión 3.11: Anteriormente, este método solo admitía el formato @code{YYYY-MM-DD}.

@end deffn

@geindex fromisocalendar() (método de clase de datetime.date)
@anchor{library/datetime datetime date fromisocalendar}@anchor{a7e}
@deffn {Método} classmethod date.fromisocalendar (year, week, day)

Retorna @ref{330,,date} correspondiente a la fecha del calendario ISO especificada por año, semana y día. Esta es la inversa de la función @ref{98b,,date.isocalendar()}.


Added in version 3.8.

@end deffn

@geindex strptime() (método de clase de datetime.date)
@anchor{library/datetime datetime date strptime}@anchor{16e}
@deffn {Método} classmethod date.strptime (date_string, format)

Return a @ref{330,,date} corresponding to `date_string', parsed according to
`format'. This is equivalent to:

@example
date(*(time.strptime(date_string, format)[0:3]))
@end example

@ref{360,,ValueError} is raised if the date_string and format
can’t be parsed by @ref{146c,,time.strptime()} or if it returns a value which isn’t a
time tuple.  See also @ref{17d1,,strftime() and strptime() Behavior} and
@ref{6b5,,date.fromisoformat()}.

@cartouche
@quotation Nota 
If `format' specifies a day of month without a year a
@ref{1da,,DeprecationWarning} is emitted.  This is to avoid a quadrennial
leap year bug in code seeking to parse only a month and day as the
default year used in absence of one in the format is not a leap year.
Such `format' values may raise an error as of Python 3.15.  The
workaround is to always include a year in your `format'.  If parsing
`date_string' values that do not have a year, explicitly add a year that
is a leap year before parsing:

@example
>>> from datetime import date
>>> date_string = "02/29"
>>> when = date.strptime(f"@{date_string@};1984", "%m/%d;%Y")  # Avoids leap year bug.
>>> when.strftime("%B %d")  
'February 29'
@end example
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

Atributos de clase:

@geindex min (atributo de datetime.date)
@anchor{library/datetime datetime date min}@anchor{2449}
@deffn {Atributo} date.min

La fecha representable más antigua, @code{date(MINYEAR, 1, 1)}.
@end deffn

@geindex max (atributo de datetime.date)
@anchor{library/datetime datetime date max}@anchor{244a}
@deffn {Atributo} date.max

La última fecha representable, @code{date(MAXYEAR, 12, 31)}.
@end deffn

@geindex resolution (atributo de datetime.date)
@anchor{library/datetime datetime date resolution}@anchor{244b}
@deffn {Atributo} date.resolution

La menor diferencia entre objetos de fecha no iguales, @code{timedelta(days=1)}.
@end deffn

Atributos de instancia (solo lectura):

@geindex year (atributo de datetime.date)
@anchor{library/datetime datetime date year}@anchor{242b}
@deffn {Atributo} date.year

Entre @ref{2428,,MINYEAR} y @ref{2429,,MAXYEAR} inclusive.
@end deffn

@geindex month (atributo de datetime.date)
@anchor{library/datetime datetime date month}@anchor{242c}
@deffn {Atributo} date.month

Entre 1 y 12 inclusive.
@end deffn

@geindex day (atributo de datetime.date)
@anchor{library/datetime datetime date day}@anchor{242d}
@deffn {Atributo} date.day

Entre 1 y el número de días en el mes dado del año dado.
@end deffn

Operaciones soportadas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@item

@code{date2 = date1 + timedelta}

@tab

@code{date2} will be @code{timedelta.days} days
after @code{date1}. (1)

@item

@code{date2 = date1 - timedelta}

@tab

Computes @code{date2} such that @code{date2 +
timedelta == date1}. (2)

@item

@code{timedelta = date1 - date2}

@tab

(3)

@item


@display
@code{date1 == date2}@w{ }
@code{date1 != date2}@w{ }
@end display



@tab

Equality comparison. (4)

@item


@display
@code{date1 < date2}@w{ }
@code{date1 > date2}@w{ }
@code{date1 <= date2}@w{ }
@code{date1 >= date2}@w{ }
@end display



@tab

Order comparison. (5)

@end multitable


Notas:


@enumerate 

@item 
`date2' se mueve hacia adelante en el tiempo si @code{timedelta.days > 0}, o hacia atrás si @code{timedelta.days < 0}. Después @code{date2 - date1 == timedelta. days}. @code{timedelta.seconds} y @code{timedelta.microseconds} se ignoran. @ref{919,,OverflowError} se lanza si @code{date2.year} sería menor que @ref{2428,,MINYEAR} o mayor que @ref{2429,,MAXYEAR}.

@item 
@code{timedelta.seconds} y @code{timedelta.microseconds} son ignorados.

@item 
This is exact, and cannot overflow. @code{timedelta.seconds} and
@code{timedelta.microseconds} are 0, and @code{date2 + timedelta == date1} after.

@item 
@ref{330,,date} objects are equal if they represent the same date.

@code{date} objects that are not also @ref{32f,,datetime} instances
are never equal to @code{datetime} objects, even if they represent
the same date.

@item 
`date1' is considered less than `date2' when `date1' precedes `date2' in time.
In other words, @code{date1 < date2} if and only if @code{date1.toordinal() <
date2.toordinal()}.

Order comparison between a @code{date} object that is not also a
@ref{32f,,datetime} instance and a @code{datetime} object raises
@ref{228,,TypeError}.
@end enumerate


Distinto en la versión 3.13: Comparison between @ref{32f,,datetime} object and an instance of
the @ref{330,,date} subclass that is not a @code{datetime} subclass
no longer converts the latter to @code{date}, ignoring the time part
and the time zone.
The default behavior can be changed by overriding the special comparison
methods in subclasses.


En contextos booleanos, todos los objetos @ref{330,,date} se consideran verdaderos.

Métodos de instancia:

@geindex replace() (método de datetime.date)
@anchor{library/datetime datetime date replace}@anchor{1688}
@deffn {Método} date.replace (year=self.year, month=self.month, day=self.day)

Retorna una fecha con el mismo valor, a excepción de aquellos parámetros dados nuevos valores por cualquier argumento de palabra clave especificado.

Ejemplo:

@example
>>> from datetime import date
>>> d = date(2002, 12, 31)
>>> d.replace(day=26)
datetime.date(2002, 12, 26)
@end example

@ref{330,,date} objects are also supported by generic function
@ref{15f,,copy.replace()}.
@end deffn

@geindex timetuple() (método de datetime.date)
@anchor{library/datetime datetime date timetuple}@anchor{244c}
@deffn {Método} date.timetuple ()

Retorna una @ref{d71,,time.struct_time} como la que retorna @ref{1539,,time.localtime()}.

Las horas, minutos y segundos son 0, y el indicador DST es -1.

@code{d.timetuple()} es equivalente a:

@example
time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))
@end example

where @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1}
is the day number within the current year starting with 1 for January 1st.
@end deffn

@geindex toordinal() (método de datetime.date)
@anchor{library/datetime datetime date toordinal}@anchor{244d}
@deffn {Método} date.toordinal ()

Return the proleptic Gregorian ordinal of the date, where January 1 of year 1
has ordinal 1. For any @ref{330,,date} object @code{d},
@code{date.fromordinal(d.toordinal()) == d}.
@end deffn

@geindex weekday() (método de datetime.date)
@anchor{library/datetime datetime date weekday}@anchor{244e}
@deffn {Método} date.weekday ()

Retorna el día de la semana como un número entero, donde el lunes es 0 y el domingo es 6. Por ejemplo, @code{date(2002, 12, 4).weekday() == 2}, un miércoles. Ver también @ref{244f,,isoweekday()}.
@end deffn

@geindex isoweekday() (método de datetime.date)
@anchor{library/datetime datetime date isoweekday}@anchor{244f}
@deffn {Método} date.isoweekday ()

Retorna el día de la semana como un número entero, donde el lunes es 1 y el domingo es 7. Por ejemplo, @code{date(2002, 12, 4).isoweekday() == 3}, un miércoles. Ver también @ref{244e,,weekday()}, @ref{98b,,isocalendar()}.
@end deffn

@geindex isocalendar() (método de datetime.date)
@anchor{library/datetime datetime date isocalendar}@anchor{98b}
@deffn {Método} date.isocalendar ()

Retorna un objeto @ref{6ef,,named tuple} con tres componentes: @code{year}, @code{week} y @code{weekday}.

El calendario ISO es una variante amplia utilizada del calendario gregoriano. @footnote{
Consulte @uref{https://web.archive.org/web/20220531051136/https://webspace.science.uu.nl/~gent0113/calendar/isocalendar.htm,guide to the mathematics of the ISO 8601 calendar} de R. H. van Gent para obtener una buena explicación.
}

El año ISO consta de 52 o 53 semanas completas, y donde una semana comienza un lunes y termina un domingo. La primera semana de un año ISO es la primera semana calendario (gregoriana) de un año que contiene un jueves. Esto se llama semana número 1, y el año ISO de ese jueves es el mismo que el año gregoriano.

Por ejemplo, 2004 comienza en jueves, por lo que la primera semana del año ISO 2004 comienza el lunes 29 de diciembre de 2003 y termina el domingo 4 de enero de 2004

@example
>>> from datetime import date
>>> date(2003, 12, 29).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=1)
>>> date(2004, 1, 4).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=7)
@end example


Distinto en la versión 3.9: El resultado cambió de una tupla a un @ref{6ef,,named tuple}.

@end deffn

@geindex isoformat() (método de datetime.date)
@anchor{library/datetime datetime date isoformat}@anchor{2450}
@deffn {Método} date.isoformat ()

Retorna una cadena de caracteres que representa la fecha en formato ISO 8601, @code{AAAA-MM-DD}:

@example
>>> from datetime import date
>>> date(2002, 12, 4).isoformat()
'2002-12-04'
@end example
@end deffn

@geindex __str__() (método de datetime.date)
@anchor{library/datetime datetime date __str__}@anchor{2451}
@deffn {Método} date.__str__ ()

For a date @code{d}, @code{str(d)} is equivalent to @code{d.isoformat()}.
@end deffn

@geindex ctime() (método de datetime.date)
@anchor{library/datetime datetime date ctime}@anchor{2452}
@deffn {Método} date.ctime ()

Retorna una cadena de caracteres que representa la fecha:

@example
>>> from datetime import date
>>> date(2002, 12, 4).ctime()
'Wed Dec  4 00:00:00 2002'
@end example

@code{d.ctime()} es equivalente a:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

en plataformas donde la función nativa C @code{ctime()} (donde @ref{2453,,time.ctime()} llama, pero que @ref{2452,,date.ctime()} no se llama) se ajusta al estándar C.
@end deffn

@geindex strftime() (método de datetime.date)
@anchor{library/datetime datetime date strftime}@anchor{d1a}
@deffn {Método} date.strftime (format)

Return a string representing the date, controlled by an explicit format string.
Format codes referring to hours, minutes or seconds will see 0 values.
See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{2450,,date.isoformat()}.
@end deffn

@geindex __format__() (método de datetime.date)
@anchor{library/datetime datetime date __format__}@anchor{2454}
@deffn {Método} date.__format__ (format)

Same as @ref{d1a,,date.strftime()}. This makes it possible to specify a format
string for a @ref{330,,date} object in @ref{a3b,,formatted string literals} and when using @ref{6c2,,str.format()}.
See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{2450,,date.isoformat()}.
@end deffn

@menu
* Ejemplos de uso; date: Ejemplos de uso date. 

@end menu

@node Ejemplos de uso date,,,Objeto date
@anchor{library/datetime examples-of-usage-date}@anchor{2455}
@subsubsection Ejemplos de uso: @code{date}


Ejemplo de contar días para un evento:

@example
>>> import time
>>> from datetime import date
>>> today = date.today()
>>> today
datetime.date(2007, 12, 5)
>>> today == date.fromtimestamp(time.time())
True
>>> my_birthday = date(today.year, 6, 24)
>>> if my_birthday < today:
...     my_birthday = my_birthday.replace(year=today.year + 1)
...
>>> my_birthday
datetime.date(2008, 6, 24)
>>> time_to_birthday = abs(my_birthday - today)
>>> time_to_birthday.days
202
@end example

Más ejemplos de trabajo con @ref{330,,date}:

@example
>>> from datetime import date
>>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001
>>> d
datetime.date(2002, 3, 11)

>>> # Methods related to formatting string output
>>> d.isoformat()
'2002-03-11'
>>> d.strftime("%d/%m/%y")
'11/03/02'
>>> d.strftime("%A %d. %B %Y")
'Monday 11. March 2002'
>>> d.ctime()
'Mon Mar 11 00:00:00 2002'
>>> 'The @{1@} is @{0:%d@}, the @{2@} is @{0:%B@}.'.format(d, "day", "month")
'The day is 11, the month is March.'

>>> # Methods for to extracting 'components' under different calendars
>>> t = d.timetuple()
>>> for i in t:     
...     print(i)
2002                # year
3                   # month
11                  # day
0
0
0
0                   # weekday (0 = Monday)
70                  # 70th day in the year
-1
>>> ic = d.isocalendar()
>>> for i in ic:    
...     print(i)
2002                # ISO year
11                  # ISO week number
1                   # ISO day number ( 1 = Monday )

>>> # A date object is immutable; all operations produce a new object
>>> d.replace(year=2005)
datetime.date(2005, 3, 11)
@end example

@node Objetos datetime,Objetos time,Objeto date,datetime — Basic date and time types
@anchor{library/datetime datetime-datetime}@anchor{2456}@anchor{library/datetime datetime-objects}@anchor{2457}
@subsubsection Objetos @code{datetime}


El objeto @ref{32f,,datetime} es un único objeto que contiene toda la información de un objeto @ref{330,,date} y un objeto @ref{331,,time}.

Como un objeto @ref{330,,date}, @ref{32f,,datetime} asume el calendario gregoriano actual extendido en ambas direcciones; como un objeto @ref{331,,time}, @ref{32f,,datetime} supone que hay exactamente 3600*24 segundos en cada día.

Constructor:

@geindex datetime (clase en datetime)
@anchor{library/datetime datetime datetime}@anchor{32f}
@deffn {Clase} datetime.datetime (year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Se requieren los argumentos `year', `month' y `day'. `tzinfo' puede ser @code{None}, o una instancia de una subclase @ref{67f,,tzinfo}. Los argumentos restantes deben ser enteros en los siguientes rangos:


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR},

@item 
@code{1 <= month <= 12},

@item 
@code{1 <= day <= number of days in the given month and year},

@item 
@code{0 <= hour < 24},

@item 
@code{0 <= minute < 60},

@item 
@code{0 <= second < 60},

@item 
@code{0 <= microsecond < 1000000},

@item 
@code{fold in [0, 1]}.
@end itemize

Si se proporciona un argumento fuera de esos rangos, @ref{360,,ValueError} se genera.


Distinto en la versión 3.6: Added the `fold' parameter.

@end deffn

Otros constructores, todos los métodos de clase:

@geindex today() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime today}@anchor{2458}
@deffn {Método} classmethod datetime.today ()

Return the current local date and time, with @ref{243a,,tzinfo} @code{None}.

Equivalente a:

@example
datetime.fromtimestamp(time.time())
@end example

Ver también @ref{592,,now()}, @ref{593,,fromtimestamp()}.

Este método es funciona como @ref{592,,now()}, pero sin un parámetro @code{tz}.
@end deffn

@geindex now() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime now}@anchor{592}
@deffn {Método} classmethod datetime.now (tz=None)

Retorna la fecha y hora local actual.

Si el argumento opcional `tz' es @code{None} o no se especifica, es como @ref{2458,,today()}, pero, si es posible, proporciona más precisión de la que se puede obtener al pasar por @ref{3ad,,time.time()} marca de tiempo (por ejemplo, esto puede ser posible en plataformas que suministran la función C @code{gettimeofday()}).

Si `tz' no es @code{None}, debe ser una instancia de una subclase @ref{67f,,tzinfo}, y la fecha y hora actuales se convierten en la zona horaria de `tz'.

Esta función es preferible a @ref{2458,,today()} y @ref{1f4,,utcnow()}.

@cartouche
@quotation Nota 
Subsequent calls to @code{datetime.now()} may return the same
instant depending on the precision of the underlying clock.
@end quotation
@end cartouche
@end deffn

@geindex utcnow() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime utcnow}@anchor{1f4}
@deffn {Método} classmethod datetime.utcnow ()

Retorna la fecha y hora UTC actual, con @ref{243a,,tzinfo} @code{None}.

Esto es como @ref{592,,now()}, pero retorna la fecha y hora UTC actual, como un objeto naíf (`naive'): @ref{32f,,datetime}. Se puede obtener una fecha y hora UTC actual consciente (`aware') llamando a @code{datetime.now (timezone.utc)}. Ver también @ref{592,,now()}.

@cartouche
@quotation Advertencia 
Debido a que los objetos naífs (`naive') de @code{datetime} son tratados por muchos métodos de @code{datetime} como horas locales, se prefiere usar fechas y horas conscientes(`aware') para representar las horas en UTC. Como tal, la forma recomendada de crear un objeto que represente la hora actual en UTC es llamando a @code{datetime.now(timezone.utc)}.
@end quotation
@end cartouche


Obsoleto desde la versión 3.12: Use @ref{592,,datetime.now()} with @ref{594,,UTC} instead.

@end deffn

@geindex fromtimestamp() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime fromtimestamp}@anchor{593}
@deffn {Método} classmethod datetime.fromtimestamp (timestamp, tz=None)

Retorna la fecha y hora local correspondiente a la marca de tiempo POSIX, tal como la retorna @ref{3ad,,time.time()}. Si el argumento opcional `tz' es @code{None} o no se especifica, la marca de tiempo se convierte a la fecha y hora local de la plataforma, y el objeto retornado @ref{32f,,datetime} es naíf (`naive').

Si `tz' no es @code{None}, debe ser una instancia de una subclase @ref{67f,,tzinfo}, y la fecha y hora actuales se convierten en la zona horaria de `tz'.

@ref{593,,fromtimestamp()} puede aumentar @ref{919,,OverflowError}, si la marca de tiempo está fuera del rango de valores admitidos por la plataforma `C' @code{localtime()} o @code{gmtime()}, y @ref{4d5,,OSError} en @code{localtime()} o @code{gmtime()} falla. Es común que esto se restrinja a los años 1970 a 2038. Tenga en cuenta que en los sistemas que no son POSIX que incluyen segundos bisiestos en su noción de marca de tiempo, los segundos bisiestos son ignorados por @ref{593,,fromtimestamp()}, y luego es posible tener dos marcas de tiempo que difieren en un segundo que producen objetos idénticos @ref{32f,,datetime}. Se prefiere este método sobre @ref{1f5,,utcfromtimestamp()}.


Distinto en la versión 3.3: Se genera @ref{919,,OverflowError} en lugar de @ref{360,,ValueError} si la marca de tiempo está fuera del rango de valores admitidos por la plataforma `C' @code{localtime()} o @code{gmtime()}. genera @ref{4d5,,OSError} en lugar de la función @ref{360,,ValueError} en @code{localtime()} o error @code{gmtime()}.



Distinto en la versión 3.6: @ref{593,,fromtimestamp()} puede retornar instancias con @ref{cdf,,fold} establecido en 1.

@end deffn

@geindex utcfromtimestamp() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime utcfromtimestamp}@anchor{1f5}
@deffn {Método} classmethod datetime.utcfromtimestamp (timestamp)

Retorna el UTC @ref{32f,,datetime} correspondiente a la marca de tiempo POSIX, con @ref{243a,,tzinfo} @code{None}. (El objeto resultante es naíf (`naive').)

Esto puede generar @ref{919,,OverflowError}, si la marca de tiempo está fuera del rango de valores admitidos por la plataforma C @code{gmtime()}, y error en @ref{4d5,,OSError} en @code{gmtime()}. Es común que esto se restrinja a los años entre1970 a 2038.

Para conocer un objeto @ref{32f,,datetime}, llama a @ref{593,,fromtimestamp()}:

@example
datetime.fromtimestamp(timestamp, timezone.utc)
@end example

En las plataformas compatibles con POSIX, es equivalente a la siguiente expresión:

@example
datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)
@end example

excepto que la última fórmula siempre admite el rango de años completo: entre @ref{2428,,MINYEAR} y @ref{2429,,MAXYEAR} inclusive.

@cartouche
@quotation Advertencia 
Debido a que los objetos naíf (`naive') de @code{datetime} son tratados por muchos métodos de @code{datetime} como horas locales, se prefiere usar fechas y horas conscientes para representar las horas en UTC. Como tal, la forma recomendada de crear un objeto que represente una marca de tiempo específica en UTC es llamando a @code{datetime.fromtimestamp(timestamp, tz=timezone.utc)}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se genera @ref{919,,OverflowError} en lugar de @ref{360,,ValueError} si la marca de tiempo está fuera del rango de valores admitidos por la plataforma `C' @code{gmtime()}. genera @ref{4d5,,OSError} en lugar de @ref{360,,ValueError} en el error de @code{gmtime()}.



Obsoleto desde la versión 3.12: Use @ref{593,,datetime.fromtimestamp()} with @ref{594,,UTC} instead.

@end deffn

@geindex fromordinal() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime fromordinal}@anchor{2459}
@deffn {Método} classmethod datetime.fromordinal (ordinal)

Se genera @ref{32f,,datetime} correspondiente al ordinal del proléptico gregoriano, donde el 1 de enero del año 1 tiene ordinal 1. @ref{360,,ValueError} se genera a menos que @code{1 <= ordinal <= datetime.max.toordinal()}. La hora, minuto, segundo y microsegundo del resultado son todos 0, y @ref{243a,,tzinfo} es @code{None}.
@end deffn

@geindex combine() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime combine}@anchor{d1b}
@deffn {Método} classmethod datetime.combine (date, time, tzinfo=time.tzinfo)

Return a new @ref{32f,,datetime} object whose date components are equal to the
given @ref{330,,date} object’s, and whose time components
are equal to the given @ref{331,,time} object’s. If the `tzinfo'
argument is provided, its value is used to set the @ref{243a,,tzinfo} attribute
of the result, otherwise the @ref{2432,,tzinfo} attribute of the `time' argument
is used.  If the `date' argument is a @ref{32f,,datetime} object, its time components
and @ref{243a,,tzinfo} attributes are ignored.

For any @ref{32f,,datetime} object @code{d},
@code{d == datetime.combine(d.date(), d.time(), d.tzinfo)}.


Distinto en la versión 3.6: Se agregó el argumento `tzinfo'.

@end deffn

@geindex fromisoformat() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime fromisoformat}@anchor{6b7}
@deffn {Método} classmethod datetime.fromisoformat (date_string)

Devuelve un @ref{32f,,datetime} correspondiente a un `date_string' en cualquier formato ISO 8601 válido, con las siguientes excepciones:


@enumerate 

@item 
Las compensaciones de zona horaria pueden tener fracciones de segundo.

@item 
El separador @code{T} se puede reemplazar por cualquier carácter Unicode único.

@item 
No se admiten fracciones de horas y minutos.

@item 
Reduced precision dates are not currently supported (@code{YYYY-MM},
@code{YYYY}).

@item 
Extended date representations are not currently supported
(@code{±YYYYYY-MM-DD}).

@item 
Ordinal dates are not currently supported (@code{YYYY-OOO}).
@end enumerate

Ejemplos:

@example
>>> from datetime import datetime
>>> datetime.fromisoformat('2011-11-04')
datetime.datetime(2011, 11, 4, 0, 0)
>>> datetime.fromisoformat('20111104')
datetime.datetime(2011, 11, 4, 0, 0)
>>> datetime.fromisoformat('2011-11-04T00:05:23')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> datetime.fromisoformat('2011-11-04T00:05:23Z')
datetime.datetime(2011, 11, 4, 0, 5, 23, tzinfo=datetime.timezone.utc)
>>> datetime.fromisoformat('20111104T000523')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> datetime.fromisoformat('2011-W01-2T00:05:23.283')
datetime.datetime(2011, 1, 4, 0, 5, 23, 283000)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283+00:00')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000, tzinfo=datetime.timezone.utc)
>>> datetime.fromisoformat('2011-11-04T00:05:23+04:00')   
datetime.datetime(2011, 11, 4, 0, 5, 23,
    tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))
@end example


Added in version 3.7.



Distinto en la versión 3.11: Previously, this method only supported formats that could be emitted by
@ref{2450,,date.isoformat()} or @ref{bb9,,datetime.isoformat()}.

@end deffn

@geindex fromisocalendar() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime fromisocalendar}@anchor{a7f}
@deffn {Método} classmethod datetime.fromisocalendar (year, week, day)

Retorna @ref{32f,,datetime} correspondiente a la fecha del calendario ISO especificada por año, semana y día. Los componentes que no son de fecha de fecha y hora se rellenan con sus valores predeterminados normales. Esta es la inversa de la función @ref{98c,,datetime.isocalendar()}.


Added in version 3.8.

@end deffn

@geindex strptime() (método de clase de datetime.datetime)
@anchor{library/datetime datetime datetime strptime}@anchor{15ec}
@deffn {Método} classmethod datetime.strptime (date_string, format)

Retorna @ref{32f,,datetime} correspondiente a `date_string', analizado según `format'.

If `format' does not contain microseconds or time zone information, this is equivalent to:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

@ref{360,,ValueError} is raised if the date_string and format
can’t be parsed by @ref{146c,,time.strptime()} or if it returns a value which isn’t a
time tuple.  See also @ref{17d1,,strftime() and strptime() Behavior} and
@ref{6b7,,datetime.fromisoformat()}.


Distinto en la versión 3.13: If `format' specifies a day of month without a year a
@ref{1da,,DeprecationWarning} is now emitted.  This is to avoid a quadrennial
leap year bug in code seeking to parse only a month and day as the
default year used in absence of one in the format is not a leap year.
Such `format' values may raise an error as of Python 3.15.  The
workaround is to always include a year in your `format'.  If parsing
`date_string' values that do not have a year, explicitly add a year that
is a leap year before parsing:

@example
>>> from datetime import datetime
>>> date_string = "02/29"
>>> when = datetime.strptime(f"@{date_string@};1984", "%m/%d;%Y")  # Avoids leap year bug.
>>> when.strftime("%B %d")  
'February 29'
@end example

@end deffn

Atributos de clase:

@geindex min (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime min}@anchor{17e2}
@deffn {Atributo} datetime.min

La primera fecha representable @ref{32f,,datetime}, @code{datetime(MINYEAR, 1, 1, tzinfo=None)}.
@end deffn

@geindex max (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime max}@anchor{245a}
@deffn {Atributo} datetime.max

La última fecha representable @ref{32f,,datetime}, @code{datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None)}.
@end deffn

@geindex resolution (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime resolution}@anchor{245b}
@deffn {Atributo} datetime.resolution

La diferencia más pequeña posible entre objetos no iguales @ref{32f,,datetime}, @code{timedelta(microseconds=1)}.
@end deffn

Atributos de instancia (solo lectura):

@geindex year (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime year}@anchor{2433}
@deffn {Atributo} datetime.year

Entre @ref{2428,,MINYEAR} y @ref{2429,,MAXYEAR} inclusive.
@end deffn

@geindex month (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime month}@anchor{2434}
@deffn {Atributo} datetime.month

Entre 1 y 12 inclusive.
@end deffn

@geindex day (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime day}@anchor{2435}
@deffn {Atributo} datetime.day

Entre 1 y el número de días en el mes dado del año dado.
@end deffn

@geindex hour (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime hour}@anchor{2436}
@deffn {Atributo} datetime.hour

En @code{range(24)}.
@end deffn

@geindex minute (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime minute}@anchor{2437}
@deffn {Atributo} datetime.minute

En @code{range(60)}.
@end deffn

@geindex second (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime second}@anchor{2438}
@deffn {Atributo} datetime.second

En @code{range(60)}.
@end deffn

@geindex microsecond (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime microsecond}@anchor{2439}
@deffn {Atributo} datetime.microsecond

En @code{range(1000000)}.
@end deffn

@geindex tzinfo (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime tzinfo}@anchor{243a}
@deffn {Atributo} datetime.tzinfo

El objeto pasó como argumento `tzinfo' al constructor @ref{32f,,datetime}, o @code{None} si no se pasó ninguno.
@end deffn

@geindex fold (atributo de datetime.datetime)
@anchor{library/datetime datetime datetime fold}@anchor{cdf}
@deffn {Atributo} datetime.fold

In @code{[0, 1]}. Used to disambiguate wall times during a repeated interval. (A
repeated interval occurs when clocks are rolled back at the end of daylight saving
time or when the UTC offset for the current zone is decreased for political reasons.)
The values 0 and 1 represent, respectively, the earlier and later of the two
moments with the same wall time representation.


Added in version 3.6.

@end deffn

Operaciones soportadas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Resultado

@item

@code{datetime2 = datetime1 + timedelta}

@tab

(1)

@item

@code{datetime2 = datetime1 - timedelta}

@tab

(2)

@item

@code{timedelta = datetime1 - datetime2}

@tab

(3)

@item


@display
@code{datetime1 == datetime2}@w{ }
@code{datetime1 != datetime2}@w{ }
@end display



@tab

Equality comparison. (4)

@item


@display
@code{datetime1 < datetime2}@w{ }
@code{datetime1 > datetime2}@w{ }
@code{datetime1 <= datetime2}@w{ }
@code{datetime1 >= datetime2}@w{ }
@end display



@tab

Order comparison. (5)

@end multitable



@enumerate 

@item 
@code{datetime2} is a duration of @code{timedelta} removed from @code{datetime1}, moving forward in
time if @code{timedelta.days > 0}, or backward if @code{timedelta.days < 0}. The
result has the same @ref{243a,,tzinfo} attribute as the input datetime, and
@code{datetime2 - datetime1 == timedelta} after. @ref{919,,OverflowError} is raised if
@code{datetime2.year} would be smaller than @ref{2428,,MINYEAR} or larger than
@ref{2429,,MAXYEAR}. Note that no time zone adjustments are done even if the
input is an aware object.

@item 
Computes the @code{datetime2} such that @code{datetime2 + timedelta == datetime1}. As for
addition, the result has the same @ref{243a,,tzinfo} attribute as the input
datetime, and no time zone adjustments are done even if the input is aware.

@item 
La resta de @ref{32f,,datetime} de la @ref{32f,,datetime} se define solo si ambos operandos son naíf(`naive'), o si ambos son conscientes(`aware'). Si uno es consciente y el otro es naíf, @ref{228,,TypeError} aparece.

If both are naive, or both are aware and have the same @ref{243a,,tzinfo} attribute,
the @ref{243a,,tzinfo} attributes are ignored, and the result is a @ref{a61,,timedelta}
object @code{t} such that @code{datetime2 + t == datetime1}. No time zone adjustments
are done in this case.

If both are aware and have different @ref{243a,,tzinfo} attributes, @code{a-b} acts
as if @code{a} and @code{b} were first converted to naive UTC datetimes. The
result is @code{(a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None)
- b.utcoffset())} except that the implementation never overflows.

@item 
@ref{32f,,datetime} objects are equal if they represent the same date
and time, taking into account the time zone.

Naive and aware @code{datetime} objects are never equal.

If both comparands are aware, and have the same @code{tzinfo} attribute,
the @code{tzinfo} and @ref{cdf,,fold} attributes are ignored and
the base datetimes are compared.
If both comparands are aware and have different @ref{243a,,tzinfo}
attributes, the comparison acts as comparands were first converted to UTC
datetimes except that the implementation never overflows.
@code{datetime} instances in a repeated interval are never equal to
@code{datetime} instances in other time zone.

@item 
`datetime1' is considered less than `datetime2' when `datetime1' precedes
`datetime2' in time, taking into account the time zone.

Order comparison between naive and aware @ref{32f,,datetime} objects
raises @ref{228,,TypeError}.

If both comparands are aware, and have the same @code{tzinfo} attribute,
the @code{tzinfo} and @ref{cdf,,fold} attributes are ignored and
the base datetimes are compared.
If both comparands are aware and have different @ref{243a,,tzinfo}
attributes, the comparison acts as comparands were first converted to UTC
datetimes except that the implementation never overflows.
@end enumerate


Distinto en la versión 3.3: Las comparaciones de igualdad entre las instancias conscientes (`aware') y naíf (`naive') @ref{32f,,datetime} no generan @ref{228,,TypeError}.



Distinto en la versión 3.13: Comparison between @ref{32f,,datetime} object and an instance of
the @ref{330,,date} subclass that is not a @code{datetime} subclass
no longer converts the latter to @code{date}, ignoring the time part
and the time zone.
The default behavior can be changed by overriding the special comparison
methods in subclasses.


Métodos de instancia:

@geindex date() (método de datetime.datetime)
@anchor{library/datetime datetime datetime date}@anchor{245c}
@deffn {Método} datetime.date ()

Retorna el objeto @ref{330,,date} con el mismo año, mes y día.
@end deffn

@geindex time() (método de datetime.datetime)
@anchor{library/datetime datetime datetime time}@anchor{245d}
@deffn {Método} datetime.time ()

Retorna el objeto @ref{331,,time} con la misma hora, minuto, segundo, microsegundo y doblado(`fold'). @ref{243a,,tzinfo} es @code{None}. Ver también método @ref{245e,,timetz()}.


Distinto en la versión 3.6: El valor de plegado (`fold value') se copia en el objeto @ref{331,,time} retornado.

@end deffn

@geindex timetz() (método de datetime.datetime)
@anchor{library/datetime datetime datetime timetz}@anchor{245e}
@deffn {Método} datetime.timetz ()

Retorna el objeto @ref{331,,time} con los mismos atributos de hora, minuto, segundo, microsegundo, pliegue y `tzinfo'. Ver también método @ref{ee,,time()}.


Distinto en la versión 3.6: El valor de plegado (`fold value') se copia en el objeto @ref{331,,time} retornado.

@end deffn

@geindex replace() (método de datetime.datetime)
@anchor{library/datetime datetime datetime replace}@anchor{150b}
@deffn {Método} datetime.replace (year=self.year, month=self.month, day=self.day, hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Retorna una fecha y hora con los mismos atributos, a excepción de aquellos atributos a los que se les asignan nuevos valores según los argumentos de palabras clave especificados. Tenga en cuenta que @code{tzinfo = None} se puede especificar para crear una fecha y hora naíf (`naive') a partir de una fecha y hora consciente(`aware') sin conversión de datos de fecha y hora.

@ref{32f,,datetime} objects are also supported by generic function
@ref{15f,,copy.replace()}.


Distinto en la versión 3.6: Added the `fold' parameter.

@end deffn

@geindex astimezone() (método de datetime.datetime)
@anchor{library/datetime datetime datetime astimezone}@anchor{a62}
@deffn {Método} datetime.astimezone (tz=None)

Retorna un objeto @ref{32f,,datetime} con el atributo nuevo @ref{243a,,tzinfo} `tz', ajustando los datos de fecha y hora para que el resultado sea la misma hora UTC que `self', pero en hora local `tz'.

If provided, `tz' must be an instance of a @ref{67f,,tzinfo} subclass, and its
@ref{245f,,utcoffset()} and @ref{2460,,dst()} methods must not return @code{None}. If `self'
is naive, it is presumed to represent time in the system time zone.

If called without arguments (or with @code{tz=None}) the system local
time zone is assumed for the target time zone. The @code{.tzinfo} attribute of the converted
datetime instance will be set to an instance of @ref{1134,,timezone}
with the zone name and offset obtained from the OS.

If @code{self.tzinfo} is `tz', @code{self.astimezone(tz)} is equal to `self':  no
adjustment of date or time data is performed. Else the result is local
time in the time zone `tz', representing the same UTC time as `self':  after
@code{astz = dt.astimezone(tz)}, @code{astz - astz.utcoffset()} will have
the same date and time data as @code{dt - dt.utcoffset()}.

If you merely want to attach a @ref{1134,,timezone} object `tz' to a datetime `dt' without
adjustment of date and time data, use @code{dt.replace(tzinfo=tz)}. If you
merely want to remove the @code{timezone} object from an aware datetime `dt' without
conversion of date and time data, use @code{dt.replace(tzinfo=None)}.

Tenga en cuenta que el método predeterminado @ref{2461,,tzinfo.fromutc()} se puede reemplazar en una subclase @ref{67f,,tzinfo} para afectar el resultado retornado por @ref{a62,,astimezone()}. @ref{a62,,astimezone()} ignora los casos de error, actúa como:

@example
def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # Convert self to UTC, and attach the new timezone object.
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # Convert from UTC to tz's local time.
    return tz.fromutc(utc)
@end example


Distinto en la versión 3.3: `tz' ahora puede ser omitido.



Distinto en la versión 3.6: El método @ref{a62,,astimezone()} ahora se puede invocar en instancias naíf (`naive') que se supone representan la hora local del sistema.

@end deffn

@geindex utcoffset() (método de datetime.datetime)
@anchor{library/datetime datetime datetime utcoffset}@anchor{245f}
@deffn {Método} datetime.utcoffset ()

Si @ref{243a,,tzinfo} es @code{None}, retorna @code{None}, de lo contrario retorna @code{self.tzinfo.utcoffset (self)}, y genera una excepción si este último no retorna @code{None} o un objeto @ref{a61,,timedelta} con magnitud inferior a un día.


Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.

@end deffn

@geindex dst() (método de datetime.datetime)
@anchor{library/datetime datetime datetime dst}@anchor{2460}
@deffn {Método} datetime.dst ()

Si @ref{243a,,tzinfo} es @code{None}, retorna @code{None}, de lo contrario retorna @code{self.tzinfo.utcoffset (self)}, y genera una excepción si este último no retorna @code{None} o un objeto @ref{a61,,timedelta} con magnitud inferior a un día.


Distinto en la versión 3.7: El desfase DST no está restringido a un número entero de minutos.

@end deffn

@geindex tzname() (método de datetime.datetime)
@anchor{library/datetime datetime datetime tzname}@anchor{2462}
@deffn {Método} datetime.tzname ()

Si @ref{243a,,tzinfo} es @code{None}, retorna @code{None}, de lo contrario retorna @code{self.tzinfo.tzname(self)}, genera una excepción si este último no retorna @code{None} o un objeto de cadena de caracteres,
@end deffn

@geindex timetuple() (método de datetime.datetime)
@anchor{library/datetime datetime datetime timetuple}@anchor{2463}
@deffn {Método} datetime.timetuple ()

Retorna una @ref{d71,,time.struct_time} como la que retorna @ref{1539,,time.localtime()}.

@code{d.timetuple()} es equivalente a:

@example
time.struct_time((d.year, d.month, d.day,
                  d.hour, d.minute, d.second,
                  d.weekday(), yday, dst))
@end example

where @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1}
is the day number within the current year starting with 1 for January
1st. The @ref{2464,,tm_isdst} flag of the result is set according to the
@ref{2460,,dst()} method: @ref{243a,,tzinfo} is @code{None} or @ref{2460,,dst()} returns
@code{None}, @code{tm_isdst} is set to @code{-1}; else if @ref{2460,,dst()} returns a
non-zero value, @code{tm_isdst} is set to 1; else @code{tm_isdst} is
set to 0.
@end deffn

@geindex utctimetuple() (método de datetime.datetime)
@anchor{library/datetime datetime datetime utctimetuple}@anchor{2465}
@deffn {Método} datetime.utctimetuple ()

If @ref{32f,,datetime} instance @code{d} is naive, this is the same as
@code{d.timetuple()} except that @ref{2464,,tm_isdst} is forced to 0 regardless of what
@code{d.dst()} returns. DST is never in effect for a UTC time.

If @code{d} is aware, @code{d} is normalized to UTC time, by subtracting
@code{d.utcoffset()}, and a @ref{d71,,time.struct_time} for the
normalized time is returned. @code{tm_isdst} is forced to 0. Note
that an @ref{919,,OverflowError} may be raised if @code{d.year} was
@code{MINYEAR} or @code{MAXYEAR} and UTC adjustment spills over a year
boundary.

@cartouche
@quotation Advertencia 
Because naive @code{datetime} objects are treated by many @code{datetime} methods
as local times, it is preferred to use aware datetimes to represent times
in UTC; as a result, using @ref{2465,,datetime.utctimetuple()} may give misleading
results. If you have a naive @code{datetime} representing UTC, use
@code{datetime.replace(tzinfo=timezone.utc)} to make it aware, at which point
you can use @ref{2463,,datetime.timetuple()}.
@end quotation
@end cartouche
@end deffn

@geindex toordinal() (método de datetime.datetime)
@anchor{library/datetime datetime datetime toordinal}@anchor{2466}
@deffn {Método} datetime.toordinal ()

Retorna el ordinal gregoriano proléptico de la fecha. Lo mismo que @code{self.date().toordinal()}.
@end deffn

@geindex timestamp() (método de datetime.datetime)
@anchor{library/datetime datetime datetime timestamp}@anchor{1116}
@deffn {Método} datetime.timestamp ()

Retorna la marca de tiempo (`timestamp') POSIX correspondiente a la instancia @ref{32f,,datetime}. El valor de retorno es @ref{153,,float} similar al retornado por @ref{3ad,,time.time()}.

Naive @ref{32f,,datetime} instances are assumed to represent local
time and this method relies on the platform C @code{mktime()}
function to perform the conversion. Since @ref{32f,,datetime}
supports wider range of values than @code{mktime()} on many
platforms, this method may raise @ref{919,,OverflowError} or @ref{4d5,,OSError}
for times far in the past or far in the future.

Para las instancias de @ref{32f,,datetime}, el valor de retorno se calcula como:

@example
(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()
@end example


Added in version 3.3.



Distinto en la versión 3.6: El método @ref{1116,,timestamp()} utiliza el atributo @ref{cdf,,fold} para desambiguar los tiempos durante un intervalo repetido.


@cartouche
@quotation Nota 
There is no method to obtain the POSIX timestamp directly from a
naive @ref{32f,,datetime} instance representing UTC time. If your
application uses this convention and your system time zone is not
set to UTC, you can obtain the POSIX timestamp by supplying
@code{tzinfo=timezone.utc}:

@example
timestamp = dt.replace(tzinfo=timezone.utc).timestamp()
@end example

o calculando la marca de tiempo (`timestamp') directamente:

@example
timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
@end example
@end quotation
@end cartouche
@end deffn

@geindex weekday() (método de datetime.datetime)
@anchor{library/datetime datetime datetime weekday}@anchor{2467}
@deffn {Método} datetime.weekday ()

Retorna el día de la semana como un entero, donde el lunes es 0 y el domingo es 6. Lo mismo que @code{self.date().weekday()}. Ver también @ref{2468,,isoweekday()}.
@end deffn

@geindex isoweekday() (método de datetime.datetime)
@anchor{library/datetime datetime datetime isoweekday}@anchor{2468}
@deffn {Método} datetime.isoweekday ()

Retorna el día de la semana como un número entero, donde el lunes es 1 y el domingo es 7. Lo mismo que @code{self.date().isoweekday()}. Ver también @ref{2467,,weekday()}, @ref{98c,,isocalendar()}.
@end deffn

@geindex isocalendar() (método de datetime.datetime)
@anchor{library/datetime datetime datetime isocalendar}@anchor{98c}
@deffn {Método} datetime.isocalendar ()

Retorna una  @ref{6ef,,named tuple} con tres componentes: @code{year}, @code{week}, y @code{weekday}. Lo mismo que @code{self.date().isocalendar()}.
@end deffn

@geindex isoformat() (método de datetime.datetime)
@anchor{library/datetime datetime datetime isoformat}@anchor{bb9}
@deffn {Método} datetime.isoformat (sep='T', timespec='auto')

Retorna una cadena de caracteres representando la fecha y la hora en formato ISO 8601:


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff}, si @ref{2439,,microsecond} no es 0

@item 
@code{YYYY-MM-DDTHH:MM:SS}, si @ref{2439,,microsecond} es 0
@end itemize

Si @ref{245f,,utcoffset()} no retorna @code{None}, se agrega una cadena de caracteres dando el desplazamiento UTC:


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}, si @ref{2439,,microsecond} no es 0

@item 
@code{YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]}, si @ref{2439,,microsecond} es 0
@end itemize

Ejemplos:

@example
>>> from datetime import datetime, timezone
>>> datetime(2019, 5, 18, 15, 17, 8, 132263).isoformat()
'2019-05-18T15:17:08.132263'
>>> datetime(2019, 5, 18, 15, 17, tzinfo=timezone.utc).isoformat()
'2019-05-18T15:17:00+00:00'
@end example

El argumento opcional `sep' (default @code{’T’}) es un separador de un carácter, ubicado entre las porciones de fecha y hora del resultado. Por ejemplo:

@example
>>> from datetime import tzinfo, timedelta, datetime
>>> class TZ(tzinfo):
...     """A time zone with an arbitrary, constant -06:39 offset."""
...     def utcoffset(self, dt):
...         return timedelta(hours=-6, minutes=-39)
...
>>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
'2002-12-25 00:00:00-06:39'
>>> datetime(2009, 11, 27, microsecond=100, tzinfo=TZ()).isoformat()
'2009-11-27T00:00:00.000100-06:39'
@end example

El argumento opcional `timespec' especifica el número de componentes adicionales del tiempo a incluir (el valor predeterminado es @code{‘auto’}). Puede ser uno de los siguientes:


@itemize -

@item 
@code{’auto’}: Igual que @code{’seconds’} si @ref{2439,,microsecond} es 0, igual que @code{’microseconds’} de lo contrario.

@item 
@code{’hours’}: incluye el @ref{2436,,hour} en el formato de dos dígitos @code{HH}.

@item 
@code{’minutes’}: Incluye @ref{2436,,hour} y @ref{2437,,minute} en formato @code{HH:MM}.

@item 
@code{’seconds’}: Incluye @ref{2436,,hour}, @ref{2437,,minute}, y @ref{2438,,second} en formato @code{HH:MM:SS}.

@item 
@code{’milliseconds’}: Incluye tiempo completo, pero trunca la segunda parte fraccionaria a milisegundos. Formato @code{HH:MM:SS.sss}.

@item 
@code{’microseconds’}: Incluye tiempo completo en formato @code{HH:MM:SS.ffffff}.
@end itemize

@cartouche
@quotation Nota 
Los componentes de tiempo excluidos están truncados, no redondeados.
@end quotation
@end cartouche

@ref{360,,ValueError} lanzará un argumento inválido `timespec':

@example
>>> from datetime import datetime
>>> datetime.now().isoformat(timespec='minutes')   
'2002-12-25T00:00'
>>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'
@end example


Distinto en la versión 3.6: Added the `timespec' parameter.

@end deffn

@geindex __str__() (método de datetime.datetime)
@anchor{library/datetime datetime datetime __str__}@anchor{2469}
@deffn {Método} datetime.__str__ ()

For a @ref{32f,,datetime} instance @code{d}, @code{str(d)} is equivalent to
@code{d.isoformat(' ')}.
@end deffn

@geindex ctime() (método de datetime.datetime)
@anchor{library/datetime datetime datetime ctime}@anchor{246a}
@deffn {Método} datetime.ctime ()

Retorna una cadena de caracteres que representa la fecha y la hora:

@example
>>> from datetime import datetime
>>> datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'
@end example

La cadena de salida `no' incluirá información de zona horaria, independientemente de si la entrada es consciente (`aware') o naíf (`naive').

@code{d.ctime()} es equivalente a:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

en plataformas donde la función nativa C @code{ctime()} (que @ref{2453,,time.ctime()} invoca, pero que @ref{246a,,datetime.ctime()} no invoca) se ajusta al estándar `C'.
@end deffn

@geindex strftime() (método de datetime.datetime)
@anchor{library/datetime datetime datetime strftime}@anchor{d19}
@deffn {Método} datetime.strftime (format)

Return a string representing the date and time,
controlled by an explicit format string.
See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{bb9,,datetime.isoformat()}.
@end deffn

@geindex __format__() (método de datetime.datetime)
@anchor{library/datetime datetime datetime __format__}@anchor{246b}
@deffn {Método} datetime.__format__ (format)

Same as @ref{d19,,datetime.strftime()}. This makes it possible to specify a format
string for a @ref{32f,,datetime} object in @ref{a3b,,formatted string literals} and when using @ref{6c2,,str.format()}.
See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{bb9,,datetime.isoformat()}.
@end deffn

@menu
* Ejemplos de uso; datetime: Ejemplos de uso datetime. 

@end menu

@node Ejemplos de uso datetime,,,Objetos datetime
@anchor{library/datetime examples-of-usage-datetime}@anchor{246c}
@subsubsection Ejemplos de uso: @code{datetime}


Examples of working with @ref{32f,,datetime} objects:

@example
>>> from datetime import datetime, date, time, timezone

>>> # Using datetime.combine()
>>> d = date(2005, 7, 14)
>>> t = time(12, 30)
>>> datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)

>>> # Using datetime.now()
>>> datetime.now()   
datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
>>> datetime.now(timezone.utc)   
datetime.datetime(2007, 12, 6, 15, 29, 43, 79060, tzinfo=datetime.timezone.utc)

>>> # Using datetime.strptime()
>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> dt
datetime.datetime(2006, 11, 21, 16, 30)

>>> # Using datetime.timetuple() to get tuple of all attributes
>>> tt = dt.timetuple()
>>> for it in tt:   
...     print(it)
...
2006    # year
11      # month
21      # day
16      # hour
30      # minute
0       # second
1       # weekday (0 = Monday)
325     # number of days since 1st January
-1      # dst - method tzinfo.dst() returned None

>>> # Date in ISO format
>>> ic = dt.isocalendar()
>>> for it in ic:   
...     print(it)
...
2006    # ISO year
47      # ISO week
2       # ISO weekday

>>> # Formatting a datetime
>>> dt.strftime("%A, %d. %B %Y %I:%M%p")
'Tuesday, 21. November 2006 04:30PM'
>>> 'The @{1@} is @{0:%d@}, the @{2@} is @{0:%B@}, the @{3@} is @{0:%I:%M%p@}.'.format(dt, "day", "month", "time")
'The day is 21, the month is November, the time is 04:30PM.'
@end example

El siguiente ejemplo define una subclase @ref{67f,,tzinfo} que captura la información de zona horaria de `Kabul', Afganistán, que utilizó +4 UTC hasta 1945 y +4:30 UTC a partir de entonces:

@example
from datetime import timedelta, datetime, tzinfo, timezone

class KabulTz(tzinfo):
    # Kabul used +4 until 1945, when they moved to +4:30
    UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc)

    def utcoffset(self, dt):
        if dt.year < 1945:
            return timedelta(hours=4)
        elif (1945, 1, 1, 0, 0) <= dt.timetuple()[:5] < (1945, 1, 1, 0, 30):
            # An ambiguous ("imaginary") half-hour range representing
            # a 'fold' in time due to the shift from +4 to +4:30.
            # If dt falls in the imaginary range, use fold to decide how
            # to resolve. See PEP495.
            return timedelta(hours=4, minutes=(30 if dt.fold else 0))
        else:
            return timedelta(hours=4, minutes=30)

    def fromutc(self, dt):
        # Follow same validations as in datetime.tzinfo
        if not isinstance(dt, datetime):
            raise TypeError("fromutc() requires a datetime argument")
        if dt.tzinfo is not self:
            raise ValueError("dt.tzinfo is not self")

        # A custom implementation is required for fromutc as
        # the input to this function is a datetime with utc values
        # but with a tzinfo set to self.
        # See datetime.astimezone or fromtimestamp.
        if dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE:
            return dt + timedelta(hours=4, minutes=30)
        else:
            return dt + timedelta(hours=4)

    def dst(self, dt):
        # Kabul does not observe daylight saving time.
        return timedelta(0)

    def tzname(self, dt):
        if dt >= self.UTC_MOVE_DATE:
            return "+04:30"
        return "+04"
@end example

Uso de @code{KabulTz} desde arriba

@example
>>> tz1 = KabulTz()

>>> # Datetime before the change
>>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
>>> print(dt1.utcoffset())
4:00:00

>>> # Datetime after the change
>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
>>> print(dt2.utcoffset())
4:30:00

>>> # Convert datetime to another time zone
>>> dt3 = dt2.astimezone(timezone.utc)
>>> dt3
datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc)
>>> dt2
datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz())
>>> dt2 == dt3
True
@end example

@node Objetos time,Objetos tzinfo,Objetos datetime,datetime — Basic date and time types
@anchor{library/datetime datetime-time}@anchor{246d}@anchor{library/datetime time-objects}@anchor{246e}
@subsubsection Objetos @code{time}


A @ref{331,,time} object represents a (local) time of day, independent of any particular
day, and subject to adjustment via a @ref{67f,,tzinfo} object.

@geindex time (clase en datetime)
@anchor{library/datetime datetime time}@anchor{331}
@deffn {Clase} datetime.time (hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Todos los argumentos son opcionales. `tzinfo' puede ser @code{None}, o una instancia de una subclase @ref{67f,,tzinfo}. Los argumentos restantes deben ser enteros en los siguientes rangos:


@itemize *

@item 
@code{0 <= hour < 24},

@item 
@code{0 <= minute < 60},

@item 
@code{0 <= second < 60},

@item 
@code{0 <= microsecond < 1000000},

@item 
@code{fold in [0, 1]}.
@end itemize

If an argument outside those ranges is given, @ref{360,,ValueError} is raised. All
default to 0 except `tzinfo', which defaults to @code{None}.
@end deffn

Atributos de clase:

@geindex min (atributo de datetime.time)
@anchor{library/datetime datetime time min}@anchor{246f}
@deffn {Atributo} time.min

El primero representable @ref{331,,time},`@w{`}time (0, 0, 0, 0)`@w{`}.
@end deffn

@geindex max (atributo de datetime.time)
@anchor{library/datetime datetime time max}@anchor{2470}
@deffn {Atributo} time.max

El último representable @ref{331,,time}, @code{time(23, 59, 59, 999999)}.
@end deffn

@geindex resolution (atributo de datetime.time)
@anchor{library/datetime datetime time resolution}@anchor{2471}
@deffn {Atributo} time.resolution

La diferencia más pequeña posible entre los objetos no iguales @ref{331,,time}, @code{timedelta(microseconds=1)}, aunque tenga en cuenta que la aritmética en objetos @ref{331,,time} no es compatible.
@end deffn

Atributos de instancia (solo lectura):

@geindex hour (atributo de datetime.time)
@anchor{library/datetime datetime time hour}@anchor{242e}
@deffn {Atributo} time.hour

En @code{range(24)}.
@end deffn

@geindex minute (atributo de datetime.time)
@anchor{library/datetime datetime time minute}@anchor{242f}
@deffn {Atributo} time.minute

En @code{range(60)}.
@end deffn

@geindex second (atributo de datetime.time)
@anchor{library/datetime datetime time second}@anchor{2430}
@deffn {Atributo} time.second

En @code{range(60)}.
@end deffn

@geindex microsecond (atributo de datetime.time)
@anchor{library/datetime datetime time microsecond}@anchor{2431}
@deffn {Atributo} time.microsecond

En @code{range(1000000)}.
@end deffn

@geindex tzinfo (atributo de datetime.time)
@anchor{library/datetime datetime time tzinfo}@anchor{2432}
@deffn {Atributo} time.tzinfo

El objeto pasado como argumento `tzinfo' al constructor de la clase @ref{331,,time} , o @code{None} si no se pasó ninguno.
@end deffn

@geindex fold (atributo de datetime.time)
@anchor{library/datetime datetime time fold}@anchor{2472}
@deffn {Atributo} time.fold

In @code{[0, 1]}. Used to disambiguate wall times during a repeated interval. (A
repeated interval occurs when clocks are rolled back at the end of daylight saving
time or when the UTC offset for the current zone is decreased for political reasons.)
The values 0 and 1 represent, respectively, the earlier and later of the two
moments with the same wall time representation.


Added in version 3.6.

@end deffn

@ref{331,,time} objects support equality and order comparisons,
where @code{a} is considered less than @code{b} when @code{a} precedes @code{b} in time.

Naive and aware @code{time} objects are never equal.
Order comparison between naive and aware @code{time} objects raises
@ref{228,,TypeError}.

If both comparands are aware, and have the same @ref{2432,,tzinfo}
attribute, the @code{tzinfo} and @code{fold} attributes are
ignored and the base times are compared. If both comparands are aware and
have different @code{tzinfo} attributes, the comparands are first adjusted by
subtracting their UTC offsets (obtained from @code{self.utcoffset()}).


Distinto en la versión 3.3: Equality comparisons between aware and naive @ref{331,,time} instances
don’t raise @ref{228,,TypeError}.


En contextos booleanos, un objeto @ref{331,,time} siempre se considera verdadero.


Distinto en la versión 3.5: Antes de Python 3.5, un objeto @ref{331,,time} se consideraba falso si representaba la medianoche en UTC. Este comportamiento se consideró oscuro y propenso a errores y se ha eliminado en Python 3.5. Ver bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936} para más detalles.


Other constructors:

@geindex fromisoformat() (método de clase de datetime.time)
@anchor{library/datetime datetime time fromisoformat}@anchor{6b6}
@deffn {Método} classmethod time.fromisoformat (time_string)

Devuelve un @ref{331,,time} correspondiente a un `time_string' en cualquier formato ISO 8601 válido, con las siguientes excepciones:


@enumerate 

@item 
Las compensaciones de zona horaria pueden tener fracciones de segundo.

@item 
No se requiere el @code{T} inicial, que normalmente se requiere en los casos en que puede haber ambigüedad entre una fecha y una hora.

@item 
Las fracciones de segundo pueden tener cualquier número de dígitos (cualquier número más allá de 6 será truncado).

@item 
No se admiten fracciones de horas y minutos.
@end enumerate

Examples:

@example
>>> from datetime import time
>>> time.fromisoformat('04:23:01')
datetime.time(4, 23, 1)
>>> time.fromisoformat('T04:23:01')
datetime.time(4, 23, 1)
>>> time.fromisoformat('T042301')
datetime.time(4, 23, 1)
>>> time.fromisoformat('04:23:01.000384')
datetime.time(4, 23, 1, 384)
>>> time.fromisoformat('04:23:01,000384')
datetime.time(4, 23, 1, 384)
>>> time.fromisoformat('04:23:01+04:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))
>>> time.fromisoformat('04:23:01Z')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)
>>> time.fromisoformat('04:23:01+00:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)
@end example


Added in version 3.7.



Distinto en la versión 3.11: Previously, this method only supported formats that could be emitted by
@ref{2473,,time.isoformat()}.

@end deffn

@geindex strptime() (método de clase de datetime.time)
@anchor{library/datetime datetime time strptime}@anchor{16d}
@deffn {Método} classmethod time.strptime (date_string, format)

Return a @ref{331,,time} corresponding to `date_string', parsed according to
`format'.

If `format' does not contain microseconds or timezone information, this is equivalent to:

@example
time(*(time.strptime(date_string, format)[3:6]))
@end example

@ref{360,,ValueError} is raised if the `date_string' and `format'
cannot be parsed by @ref{146c,,time.strptime()} or if it returns a value which is not a
time tuple.  See also @ref{17d1,,strftime() and strptime() Behavior} and
@ref{6b6,,time.fromisoformat()}.


Added in version 3.14.

@end deffn

Métodos de instancia:

@geindex replace() (método de datetime.time)
@anchor{library/datetime datetime time replace}@anchor{1689}
@deffn {Método} time.replace (hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Retorna una @ref{331,,time} con el mismo valor, excepto para aquellos atributos a los que se les otorgan nuevos valores según los argumentos de palabras clave especificados. Tenga en cuenta que @code{tzinfo = None} se puede especificar para crear una @ref{331,,time} naíf (`naive') desde un consciente (`aware') @ref{331,,time}, sin conversión de los datos de tiempo.

@ref{331,,time} objects are also supported by generic function
@ref{15f,,copy.replace()}.


Distinto en la versión 3.6: Added the `fold' parameter.

@end deffn

@geindex isoformat() (método de datetime.time)
@anchor{library/datetime datetime time isoformat}@anchor{2473}
@deffn {Método} time.isoformat (timespec='auto')

Retorna una cadena que representa la hora en formato ISO 8601, una de:


@itemize -

@item 
@code{HH:MM:SS.ffffff}, si @ref{2431,,microsecond} no es 0

@item 
@code{HH:MM:SS}, si @ref{2431,,microsecond} es 0

@item 
@code{HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}, si @ref{2474,,utcoffset()} no retorna @code{None}

@item 
@code{HH:MM:SS+HH:MM[:SS[.ffffff]]}, si @ref{2431,,microsecond} es 0 y @ref{2474,,utcoffset()} no retorna @code{None}
@end itemize

El argumento opcional `timespec' especifica el número de componentes adicionales del tiempo a incluir (el valor predeterminado es @code{‘auto’}). Puede ser uno de los siguientes:


@itemize -

@item 
@code{’auto’}: Igual que @code{’seconds’} si @ref{2431,,microsecond} es 0, igual que @code{’microseconds’} de lo contrario.

@item 
@code{’hours’}: incluye el @ref{242e,,hour} en el formato de dos dígitos @code{HH}.

@item 
@code{’minutes’}: Incluye @ref{242e,,hour} y @ref{242f,,minute} en formato @code{HH:MM}.

@item 
@code{’seconds’}: Incluye @ref{242e,,hour}, @ref{242f,,minute}, y @ref{2430,,second} en formato @code{HH:MM:SS}.

@item 
@code{’milliseconds’}: Incluye tiempo completo, pero trunca la segunda parte fraccionaria a milisegundos. Formato @code{HH:MM:SS.sss}.

@item 
@code{’microseconds’}: Incluye tiempo completo en formato @code{HH:MM:SS.ffffff}.
@end itemize

@cartouche
@quotation Nota 
Los componentes de tiempo excluidos están truncados, no redondeados.
@end quotation
@end cartouche

@ref{360,,ValueError} lanzará un argumento inválido `timespec'.

Ejemplo:

@example
>>> from datetime import time
>>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
'12:34'
>>> dt = time(hour=12, minute=34, second=56, microsecond=0)
>>> dt.isoformat(timespec='microseconds')
'12:34:56.000000'
>>> dt.isoformat(timespec='auto')
'12:34:56'
@end example


Distinto en la versión 3.6: Added the `timespec' parameter.

@end deffn

@geindex __str__() (método de datetime.time)
@anchor{library/datetime datetime time __str__}@anchor{2475}
@deffn {Método} time.__str__ ()

For a time @code{t}, @code{str(t)} is equivalent to @code{t.isoformat()}.
@end deffn

@geindex strftime() (método de datetime.time)
@anchor{library/datetime datetime time strftime}@anchor{178b}
@deffn {Método} time.strftime (format)

Return a string representing the time, controlled by an explicit format
string.  See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{2473,,time.isoformat()}.
@end deffn

@geindex __format__() (método de datetime.time)
@anchor{library/datetime datetime time __format__}@anchor{2476}
@deffn {Método} time.__format__ (format)

Same as @ref{178b,,time.strftime()}. This makes it possible to specify
a format string for a @ref{331,,time} object in @ref{a3b,,formatted string literals} and when using @ref{6c2,,str.format()}.
See also @ref{17d1,,strftime() and strptime() Behavior} and @ref{2473,,time.isoformat()}.
@end deffn

@geindex utcoffset() (método de datetime.time)
@anchor{library/datetime datetime time utcoffset}@anchor{2474}
@deffn {Método} time.utcoffset ()

Si @ref{2432,,tzinfo} es @code{None}, retorna @code{None}, sino retorna @code{self.tzinfo.utcoffset(None)}, y genera una excepción si este último no retorna @code{None} o un objeto de @ref{a61,,timedelta} con magnitud inferior a un día.


Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.

@end deffn

@geindex dst() (método de datetime.time)
@anchor{library/datetime datetime time dst}@anchor{2477}
@deffn {Método} time.dst ()

Si @ref{2432,,tzinfo} es @code{None}, retorna @code{None}, sino retorna @code{self.tzinfo.utcoffset(None)}, y genera una excepción si este último no retorna @code{None}, o un objeto de @ref{a61,,timedelta} con magnitud inferior a un día.


Distinto en la versión 3.7: El desfase DST no está restringido a un número entero de minutos.

@end deffn

@geindex tzname() (método de datetime.time)
@anchor{library/datetime datetime time tzname}@anchor{2478}
@deffn {Método} time.tzname ()

Si @ref{2432,,tzinfo} es @code{None}, retorna @code{None}, sino retorna @code{self.tzinfo.tzname(None)}, o genera una excepción si este último no retorna @code{None} o un objeto de cadena.
@end deffn

@menu
* Ejemplos de uso; time: Ejemplos de uso time. 

@end menu

@node Ejemplos de uso time,,,Objetos time
@anchor{library/datetime examples-of-usage-time}@anchor{2479}
@subsubsection Ejemplos de uso: @code{time}


Ejemplos de trabajo con el objeto @ref{331,,time}:

@example
>>> from datetime import time, tzinfo, timedelta
>>> class TZ1(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=1)
...     def dst(self, dt):
...         return timedelta(0)
...     def tzname(self,dt):
...         return "+01:00"
...     def  __repr__(self):
...         return f"@{self.__class__.__name__@}()"
...
>>> t = time(12, 10, 30, tzinfo=TZ1())
>>> t
datetime.time(12, 10, 30, tzinfo=TZ1())
>>> t.isoformat()
'12:10:30+01:00'
>>> t.dst()
datetime.timedelta(0)
>>> t.tzname()
'+01:00'
>>> t.strftime("%H:%M:%S %Z")
'12:10:30 +01:00'
>>> 'The @{@} is @{:%H:%M@}.'.format("time", t)
'The time is 12:10.'
@end example

@node Objetos tzinfo,Objetos timezone,Objetos time,datetime — Basic date and time types
@anchor{library/datetime datetime-tzinfo}@anchor{247a}@anchor{library/datetime tzinfo-objects}@anchor{247b}
@subsubsection Objetos @code{tzinfo}


@geindex tzinfo (clase en datetime)
@anchor{library/datetime datetime tzinfo}@anchor{67f}
@deffn {Clase} datetime.tzinfo

Esta es una clase base abstracta, lo que significa que esta clase no debe ser instanciada directamente. Defina una subclase de @ref{67f,,tzinfo} para capturar información sobre una zona horaria particular.

Una instancia (de una subclase concreta) @ref{67f,,tzinfo} se puede pasar a los constructores para objetos de @ref{32f,,datetime} y @ref{331,,time}. Los últimos objetos ven sus atributos como en la hora local, y el objeto @ref{67f,,tzinfo} admite métodos que revelan el desplazamiento de la hora local desde UTC, el nombre de la zona horaria y el desplazamiento DST, todo en relación con un objeto de fecha u hora pasó a ellos.

You need to derive a concrete subclass, and (at least)
supply implementations of the standard @ref{67f,,tzinfo} methods needed by the
@ref{32f,,datetime} methods you use. The @code{datetime} module provides
@ref{1134,,timezone}, a simple concrete subclass of @ref{67f,,tzinfo} which can
represent time zones with fixed offset from UTC such as UTC itself or North
American EST and EDT.

Special requirement for pickling:  A @ref{67f,,tzinfo} subclass must have an
@ref{751,,__init__()} method that can be called with no arguments,
otherwise it can be
pickled but possibly not unpickled again. This is a technical requirement that
may be relaxed in the future.

A concrete subclass of @ref{67f,,tzinfo} may need to implement the following
methods. Exactly which methods are needed depends on the uses made of aware
@code{datetime} objects. If in doubt, simply implement all of them.
@end deffn

@geindex utcoffset() (método de datetime.tzinfo)
@anchor{library/datetime datetime tzinfo utcoffset}@anchor{247c}
@deffn {Método} tzinfo.utcoffset (dt)

Retorna el desplazamiento de la hora local desde UTC, como un objeto @ref{a61,,timedelta} que es positivo al este de UTC. Si la hora local es al oeste de UTC, esto debería ser negativo.

Esto representa el desplazamiento `total' de UTC; por ejemplo, si un objeto @ref{67f,,tzinfo} representa ajustes de zona horaria y DST, @ref{247c,,utcoffset()} debería retornar su suma. Si no se conoce el desplazamiento UTC, retorna @code{None} . De lo contrario, el valor detonado debe ser un objeto de @ref{a61,,timedelta} estrictamente entre @code{-timedelta(hours = 24)} y @code{timedelta (hours = 24)} (la magnitud del desplazamiento debe ser inferior a un día) La mayoría de las implementaciones de @ref{247c,,utcoffset()} probablemente se parecerán a una de estas dos:

@example
return CONSTANT                 # fixed-offset class
return CONSTANT + self.dst(dt)  # daylight-aware class
@end example

Si @ref{247c,,utcoffset()} no retorna @code{None}, @ref{247d,,dst()} no debería retornar @code{None} tampoco.

La implementación por defecto de @ref{247c,,utcoffset()} genera @ref{384,,NotImplementedError}.


Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.

@end deffn

@geindex dst() (método de datetime.tzinfo)
@anchor{library/datetime datetime tzinfo dst}@anchor{247d}
@deffn {Método} tzinfo.dst (dt)

Retorna el ajuste del horario de verano (DST), como un objeto de @ref{a61,,timedelta} o @code{None} si no se conoce la información de DST.

Return @code{timedelta(0)} if DST is not in effect.
If DST is in effect, return the offset as a @ref{a61,,timedelta} object
(see @ref{247c,,utcoffset()} for details). Note that DST offset, if applicable, has
already been added to the UTC offset returned by @ref{247c,,utcoffset()}, so there’s
no need to consult @ref{247d,,dst()} unless you’re interested in obtaining DST info
separately. For example, @ref{2463,,datetime.timetuple()} calls its @ref{243a,,tzinfo}
attribute’s @ref{247d,,dst()} method to determine how the @ref{2464,,tm_isdst} flag
should be set, and @ref{2461,,tzinfo.fromutc()} calls @ref{247d,,dst()} to account for
DST changes when crossing time zones.

Una instancia `tz' de una subclase @ref{67f,,tzinfo} que modela los horarios estándar y diurnos debe ser coherente en este sentido:

@code{tz.utcoffset(dt) - tz.dst(dt)}

must return the same result for every @ref{32f,,datetime} `dt' with @code{dt.tzinfo ==
tz}. For sane @ref{67f,,tzinfo} subclasses, this expression yields the time
zone’s «standard offset», which should not depend on the date or the time, but
only on geographic location. The implementation of @ref{a62,,datetime.astimezone()}
relies on this, but cannot detect violations; it’s the programmer’s
responsibility to ensure it. If a @ref{67f,,tzinfo} subclass cannot guarantee
this, it may be able to override the default implementation of
@ref{2461,,tzinfo.fromutc()} to work correctly with @ref{a62,,astimezone()} regardless.

La mayoría de las implementaciones de @ref{247d,,dst()} probablemente se parecerán a una de estas dos:

@example
def dst(self, dt):
    # a fixed-offset class:  doesn't account for DST
    return timedelta(0)
@end example

o:

@example
def dst(self, dt):
    # Code to set dston and dstoff to the time zone's DST
    # transition times based on the input dt.year, and expressed
    # in standard local time.

    if dston <= dt.replace(tzinfo=None) < dstoff:
        return timedelta(hours=1)
    else:
        return timedelta(0)
@end example

La implementación predeterminada de @ref{247d,,dst()} genera @ref{384,,NotImplementedError}.


Distinto en la versión 3.7: El desfase DST no está restringido a un número entero de minutos.

@end deffn

@geindex tzname() (método de datetime.tzinfo)
@anchor{library/datetime datetime tzinfo tzname}@anchor{247e}
@deffn {Método} tzinfo.tzname (dt)

Return the time zone name corresponding to the @ref{32f,,datetime} object `dt', as
a string. Nothing about string names is defined by the @code{datetime} module,
and there’s no requirement that it mean anything in particular. For example,
@code{"GMT"}, @code{"UTC"}, @code{"-500"}, @code{"-5:00"}, @code{"EDT"}, @code{"US/Eastern"}, @code{"America/New York"} are all
valid replies. Return @code{None} if a string name isn’t known. Note that this is
a method rather than a fixed string primarily because some @ref{67f,,tzinfo}
subclasses will wish to return different names depending on the specific value
of `dt' passed, especially if the @ref{67f,,tzinfo} class is accounting for
daylight time.

La implementación predeterminada de @ref{247e,,tzname()} genera @ref{384,,NotImplementedError}.
@end deffn

Estos métodos son llamados por un objeto @ref{32f,,datetime} o @ref{331,,time}, en respuesta a sus métodos con los mismos nombres. El objeto de @ref{32f,,datetime} se pasa a sí mismo como argumento, y un objeto @ref{331,,time} pasa a @code{None} como argumento. Los métodos de la subclase @ref{67f,,tzinfo} deben, por lo tanto, estar preparados para aceptar un argumento `dt' de @code{None}, o de clase @ref{32f,,datetime}.

Cuando se pasa @code{None}, corresponde al diseñador de la clase decidir la mejor respuesta. Por ejemplo, retornar @code{None} es apropiado si la clase desea decir que los objetos de tiempo no participan en los protocolos @ref{67f,,tzinfo}. Puede ser más útil que @code{utcoffset(None)} retorne el desplazamiento UTC estándar, ya que no existe otra convención para descubrir el desplazamiento estándar.

When a @ref{32f,,datetime} object is passed in response to a @ref{32f,,datetime}
method, @code{dt.tzinfo} is the same object as `self'. @ref{67f,,tzinfo} methods can
rely on this, unless user code calls @ref{67f,,tzinfo} methods directly. The
intent is that the @ref{67f,,tzinfo} methods interpret `dt' as being in local
time, and not need worry about objects in other time zones.

Hay un método más @ref{67f,,tzinfo} que una subclase puede desear anular:

@geindex fromutc() (método de datetime.tzinfo)
@anchor{library/datetime datetime tzinfo fromutc}@anchor{2461}
@deffn {Método} tzinfo.fromutc (dt)

This is called from the default @ref{a62,,datetime.astimezone()}
implementation. When called from that, @code{dt.tzinfo} is `self', and `dt'’s
date and time data are to be viewed as expressing a UTC time. The purpose
of @ref{2461,,fromutc()} is to adjust the date and time data, returning an
equivalent datetime in `self'’s local time.

Most @ref{67f,,tzinfo} subclasses should be able to inherit the default
@ref{2461,,fromutc()} implementation without problems. It’s strong enough to handle
fixed-offset time zones, and time zones accounting for both standard and
daylight time, and the latter even if the DST transition times differ in
different years. An example of a time zone the default @ref{2461,,fromutc()}
implementation may not handle correctly in all cases is one where the standard
offset (from UTC) depends on the specific date and time passed, which can happen
for political reasons. The default implementations of @ref{a62,,astimezone()} and
@ref{2461,,fromutc()} may not produce the result you want if the result is one of the
hours straddling the moment the standard offset changes.

Código de omisión para casos de error, el valor predeterminado @ref{2461,,fromutc()} la implementación actúa como

@example
def fromutc(self, dt):
    # raise ValueError error if dt.tzinfo is not self
    dtoff = dt.utcoffset()
    dtdst = dt.dst()
    # raise ValueError if dtoff is None or dtdst is None
    delta = dtoff - dtdst  # this is self's standard offset
    if delta:
        dt += delta   # convert to standard local time
        dtdst = dt.dst()
        # raise ValueError if dtdst is None
    if dtdst:
        return dt + dtdst
    else:
        return dt
@end example
@end deffn

En el siguiente archivo @code{tzinfo_examples.py} hay algunos ejemplos de clases @ref{67f,,tzinfo}:

@example
from datetime import tzinfo, timedelta, datetime

ZERO = timedelta(0)
HOUR = timedelta(hours=1)
SECOND = timedelta(seconds=1)

# A class capturing the platform's idea of local time.
# (May result in wrong values on historical times in
#  timezones where UTC offset and/or the DST rules had
#  changed in the past.)
import time as _time

STDOFFSET = timedelta(seconds = -_time.timezone)
if _time.daylight:
    DSTOFFSET = timedelta(seconds = -_time.altzone)
else:
    DSTOFFSET = STDOFFSET

DSTDIFF = DSTOFFSET - STDOFFSET

class LocalTimezone(tzinfo):

    def fromutc(self, dt):
        assert dt.tzinfo is self
        stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND
        args = _time.localtime(stamp)[:6]
        dst_diff = DSTDIFF // SECOND
        # Detect fold
        fold = (args == _time.localtime(stamp - dst_diff))
        return datetime(*args, microsecond=dt.microsecond,
                        tzinfo=self, fold=fold)

    def utcoffset(self, dt):
        if self._isdst(dt):
            return DSTOFFSET
        else:
            return STDOFFSET

    def dst(self, dt):
        if self._isdst(dt):
            return DSTDIFF
        else:
            return ZERO

    def tzname(self, dt):
        return _time.tzname[self._isdst(dt)]

    def _isdst(self, dt):
        tt = (dt.year, dt.month, dt.day,
              dt.hour, dt.minute, dt.second,
              dt.weekday(), 0, 0)
        stamp = _time.mktime(tt)
        tt = _time.localtime(stamp)
        return tt.tm_isdst > 0

Local = LocalTimezone()


# A complete implementation of current DST rules for major US time zones.

def first_sunday_on_or_after(dt):
    days_to_go = 6 - dt.weekday()
    if days_to_go:
        dt += timedelta(days_to_go)
    return dt


# US DST Rules
#
# This is a simplified (i.e., wrong for a few cases) set of rules for US
# DST start and end times. For a complete and up-to-date set of DST rules
# and timezone definitions, visit the Olson Database (or try pytz):
# http://www.twinsun.com/tz/tz-link.htm
# https://sourceforge.net/projects/pytz/ (might not be up-to-date)
#
# In the US, since 2007, DST starts at 2am (standard time) on the second
# Sunday in March, which is the first Sunday on or after Mar 8.
DSTSTART_2007 = datetime(1, 3, 8, 2)
# and ends at 2am (DST time) on the first Sunday of Nov.
DSTEND_2007 = datetime(1, 11, 1, 2)
# From 1987 to 2006, DST used to start at 2am (standard time) on the first
# Sunday in April and to end at 2am (DST time) on the last
# Sunday of October, which is the first Sunday on or after Oct 25.
DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
DSTEND_1987_2006 = datetime(1, 10, 25, 2)
# From 1967 to 1986, DST used to start at 2am (standard time) on the last
# Sunday in April (the one on or after April 24) and to end at 2am (DST time)
# on the last Sunday of October, which is the first Sunday
# on or after Oct 25.
DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
DSTEND_1967_1986 = DSTEND_1987_2006

def us_dst_range(year):
    # Find start and end times for US DST. For years before 1967, return
    # start = end for no DST.
    if 2006 < year:
        dststart, dstend = DSTSTART_2007, DSTEND_2007
    elif 1986 < year < 2007:
        dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
    elif 1966 < year < 1987:
        dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
    else:
        return (datetime(year, 1, 1), ) * 2

    start = first_sunday_on_or_after(dststart.replace(year=year))
    end = first_sunday_on_or_after(dstend.replace(year=year))
    return start, end


class USTimeZone(tzinfo):

    def __init__(self, hours, reprname, stdname, dstname):
        self.stdoffset = timedelta(hours=hours)
        self.reprname = reprname
        self.stdname = stdname
        self.dstname = dstname

    def __repr__(self):
        return self.reprname

    def tzname(self, dt):
        if self.dst(dt):
            return self.dstname
        else:
            return self.stdname

    def utcoffset(self, dt):
        return self.stdoffset + self.dst(dt)

    def dst(self, dt):
        if dt is None or dt.tzinfo is None:
            # An exception may be sensible here, in one or both cases.
            # It depends on how you want to treat them.  The default
            # fromutc() implementation (called by the default astimezone()
            # implementation) passes a datetime with dt.tzinfo is self.
            return ZERO
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        # Can't compare naive to aware objects, so strip the timezone from
        # dt first.
        dt = dt.replace(tzinfo=None)
        if start + HOUR <= dt < end - HOUR:
            # DST is in effect.
            return HOUR
        if end - HOUR <= dt < end:
            # Fold (an ambiguous hour): use dt.fold to disambiguate.
            return ZERO if dt.fold else HOUR
        if start <= dt < start + HOUR:
            # Gap (a non-existent hour): reverse the fold rule.
            return HOUR if dt.fold else ZERO
        # DST is off.
        return ZERO

    def fromutc(self, dt):
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        start = start.replace(tzinfo=self)
        end = end.replace(tzinfo=self)
        std_time = dt + self.stdoffset
        dst_time = std_time + HOUR
        if end <= dst_time < end + HOUR:
            # Repeated hour
            return std_time.replace(fold=1)
        if std_time < start or dst_time >= end:
            # Standard time
            return std_time
        if start <= std_time < end - HOUR:
            # Daylight saving time
            return dst_time


Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
Central  = USTimeZone(-6, "Central",  "CST", "CDT")
Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")
@end example

Tenga en cuenta que hay sutilezas inevitables dos veces al año en una subclase @ref{67f,,tzinfo} que representa tanto el horario estándar como el horario de verano, en los puntos de transición DST. Para mayor concreción, considere `US Eastern' (UTC -0500), donde EDT comienza el minuto después de 1:59 (EST) el segundo domingo de marzo y termina el minuto después de 1:59 (EDT) el primer domingo de noviembre

@example
  UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
  EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
  EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM

start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM

  end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM
@end example

Cuando comienza el horario de verano (la línea de «inicio»),tiempo real transcurrido (`wall time') salta de 1:59 a 3:00. Un tiempo de pared de la forma 2: MM realmente no tiene sentido ese día, por lo que @code{astimezone (Eastern)} no entregará un resultado con @code{hour == 2} el día en que comienza el horario de verano. Por ejemplo, en la transición de primavera de 2016, obtenemos

@example
>>> from datetime import datetime, timezone
>>> from tzinfo_examples import HOUR, Eastern
>>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname())
...
05:00:00 UTC = 00:00:00 EST
06:00:00 UTC = 01:00:00 EST
07:00:00 UTC = 03:00:00 EDT
08:00:00 UTC = 04:00:00 EDT
@end example

When DST ends (the «end» line), there’s a potentially worse problem: there’s an
hour that can’t be spelled unambiguously in local wall time: the last hour of
daylight time. In Eastern, that’s times of the form 5:MM UTC on the day
daylight time ends. The local wall clock leaps from 1:59 (daylight time) back
to 1:00 (standard time) again. Local times of the form 1:MM are ambiguous.
@ref{a62,,astimezone()} mimics the local clock’s behavior by mapping two adjacent UTC
hours into the same local hour then. In the Eastern example, UTC times of the
form 5:MM and 6:MM both map to 1:MM when converted to Eastern, but earlier times
have the @ref{cdf,,fold} attribute set to 0 and the later times have it set to 1.
For example, at the Fall back transition of 2016, we get:

@example
>>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0
@end example

Note that the @ref{32f,,datetime} instances that differ only by the value of the
@ref{cdf,,fold} attribute are considered equal in comparisons.

Applications that can’t bear wall-time ambiguities should explicitly check the
value of the @ref{cdf,,fold} attribute or avoid using hybrid
@ref{67f,,tzinfo} subclasses; there are no ambiguities when using @ref{1134,,timezone},
or any other fixed-offset @ref{67f,,tzinfo} subclass (such as a class representing
only EST (fixed offset -5 hours), or only EDT (fixed offset -4 hours)).


@subsubheading Ver también


@quotation


@table @asis

@item @ref{133,,zoneinfo}

The @code{datetime} module has a basic @ref{1134,,timezone} class (for
handling arbitrary fixed offsets from UTC) and its @ref{6b4,,timezone.utc}
attribute (a UTC @code{timezone} instance).

@code{zoneinfo} brings the `IANA time zone database' (also known as the Olson
database) to Python, and its usage is recommended.
@end table
@end quotation


@table @asis

@item IANA time zone database@footnote{https://www.iana.org/time-zones}

La base de datos de zonas horarias (a menudo llamada `tz, tzdata o zoneinfo') contiene código y datos que representan el historial de la hora local de muchos lugares representativos de todo el mundo. Se actualiza periódicamente para reflejar los cambios realizados por los cuerpos políticos en los límites de la zona horaria, las compensaciones UTC y las reglas de horario de verano.
@end table


@node Objetos timezone,strftime and strptime Behavior,Objetos tzinfo,datetime — Basic date and time types
@anchor{library/datetime datetime-timezone}@anchor{247f}@anchor{library/datetime timezone-objects}@anchor{2480}
@subsubsection Objetos @code{timezone}


The @ref{1134,,timezone} class is a subclass of @ref{67f,,tzinfo}, each
instance of which represents a time zone defined by a fixed offset from
UTC.

Objects of this class cannot be used to represent time zone information in the
locations where different offsets are used in different days of the year or
where historical changes have been made to civil time.

@geindex timezone (clase en datetime)
@anchor{library/datetime datetime timezone}@anchor{1134}
@deffn {Clase} datetime.timezone (offset, name=None)

El argumento `offset' debe especificarse como un objeto de @ref{a61,,timedelta} que representa la diferencia entre la hora local y UTC. Debe estar estrictamente entre @code{-timedelta(horas = 24)} y @code{timedelta(horas = 24)}, de lo contrario @ref{360,,ValueError} se genera.

El argumento `name' es opcional. Si se especifica, debe ser una cadena de caracteres que se utilizará como el valor retornado por el método @ref{2462,,datetime.tzname()}.


Added in version 3.2.



Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.

@end deffn

@geindex utcoffset() (método de datetime.timezone)
@anchor{library/datetime datetime timezone utcoffset}@anchor{2481}
@deffn {Método} timezone.utcoffset (dt)

Retorna el valor fijo especificado cuando se construye la instancia @ref{1134,,timezone}.

El argumento `dt' se ignora. El valor de retorno es una instancia de @ref{a61,,timedelta} igual a la diferencia entre la hora local y UTC.


Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.

@end deffn

@geindex tzname() (método de datetime.timezone)
@anchor{library/datetime datetime timezone tzname}@anchor{2482}
@deffn {Método} timezone.tzname (dt)

Retorna el valor fijo especificado cuando se construye la instancia @ref{1134,,timezone}.

Si no se proporciona `name' en el constructor, el nombre retornado por @code{tzname(dt)} se genera a partir del valor del @code{offset} de la siguiente manera. Si `offset' es @code{timedelta (0)}, el nombre es «UTC», de lo contrario es una cadena en el formato @code{UTC±HH:MM}, donde ± es el signo de @code{offset}, HH y MM son dos dígitos de @code{offset.hours} y @code{offset.minutes} respectivamente.


Distinto en la versión 3.6: El nombre generado a partir de @code{offset=timedelta(0)} ahora es simplemente @code{'UTC'}, no @code{'UTC+00:00'}.

@end deffn

@geindex dst() (método de datetime.timezone)
@anchor{library/datetime datetime timezone dst}@anchor{2483}
@deffn {Método} timezone.dst (dt)

Siempre retorna @code{None}.
@end deffn

@geindex fromutc() (método de datetime.timezone)
@anchor{library/datetime datetime timezone fromutc}@anchor{2484}
@deffn {Método} timezone.fromutc (dt)

Retorna @code{dt + offset}. El argumento `dt' debe ser una instancia consciente (`aware') @ref{32f,,datetime}, con @code{tzinfo} establecido en @code{self}.
@end deffn

Atributos de clase:

@geindex utc (atributo de datetime.timezone)
@anchor{library/datetime datetime timezone utc}@anchor{6b4}
@deffn {Atributo} timezone.utc

The UTC time zone, @code{timezone(timedelta(0))}.
@end deffn

@geindex % (percent);datetime format

@node strftime and strptime Behavior,,Objetos timezone,datetime — Basic date and time types
@anchor{library/datetime strftime-and-strptime-behavior}@anchor{2485}@anchor{library/datetime strftime-strptime-behavior}@anchor{17d1}
@subsubsection @code{strftime()} and @code{strptime()} Behavior


@ref{330,,date}, @ref{32f,,datetime}, y @ref{331,,time} los objetos admiten un método @code{strftime(format)}, para crear una cadena que represente el tiempo bajo el control de una cadena de caracteres de formato explícito.

Conversely, the @ref{16e,,date.strptime()}, @ref{15ec,,datetime.strptime()} and
@ref{146c,,time.strptime()} class methods create an object from a string
representing the time and a corresponding format string.

The table below provides a high-level comparison of @ref{d19,,strftime()}
versus @ref{15ec,,strptime()}:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

@code{strftime}

@tab

@code{strptime}

@item

Uso

@tab

Convierte objetos en una cadena de caracteres de acuerdo con un formato dado

@tab

Parse a string into an object given a corresponding format

@item

Tipo de método

@tab

Método de instancia

@tab

Método de clase

@item

Firma

@tab

@code{strftime(format)}

@tab

@code{strptime(date_string, format)}

@end multitable


@quotation
@anchor{library/datetime format-codes}@anchor{2424}
@end quotation

@menu
* strftime() and strptime() Format Codes: strftime and strptime Format Codes. 
* Detalle técnico:: 

@end menu

@node strftime and strptime Format Codes,Detalle técnico,,strftime and strptime Behavior
@anchor{library/datetime strftime-and-strptime-format-codes}@anchor{2486}
@subsubsection @code{strftime()} and @code{strptime()} Format Codes


These methods accept format codes that can be used to parse and format dates:

@example
>>> datetime.strptime('31/01/22 23:59:59.999999',
...                   '%d/%m/%y %H:%M:%S.%f')
datetime.datetime(2022, 1, 31, 23, 59, 59, 999999)
>>> _.strftime('%a %d %b %Y, %I:%M%p')
'Mon 31 Jan 2022, 11:59PM'
@end example

La siguiente es una lista de todos los códigos de formato que requiere el estándar 1989 C, y estos funcionan en todas las plataformas con una implementación estándar C.


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Directiva

@tab

Significado

@tab

Ejemplo

@tab

Notas

@item

@code{%a}

@tab

Día de la semana como nombre abreviado según la configuración regional.

@tab


@display
`Sun, Mon, …, Sat (en_US)';@w{ }
`So, Mo, …, Sa (de_DE)'@w{ }
@end display



@tab

(1)

@item

@code{%A}

@tab

Día de la semana como nombre completo de la localidad.

@tab


@display
`Sunday, Monday, …, Saturday (en_US)';@w{ }
`Sonntag, Montag, …, Samstag (de_DE)'@w{ }
@end display



@tab

(1)

@item

@code{%w}

@tab

Día de la semana como un número decimal, donde 0 es domingo y 6 es sábado.

@tab

0, 1, …, 6

@tab

@item

@code{%d}

@tab

Día del mes como un número decimal rellenado con ceros.

@tab

01, 02, …, 31

@tab

(9)

@item

@code{%b}

@tab

Mes como nombre abreviado según la configuración regional.

@tab


@display
`Jan, Feb, …, Dec (en_US)';@w{ }
`Jan, Feb, …, Dez (de_DE)'@w{ }
@end display



@tab

(1)

@item

@code{%B}

@tab

Mes como nombre completo según la configuración regional.

@tab


@display
`January, February, …, December (en_US)';@w{ }
`Januar, Februar, …, Dezember (de_DE)'@w{ }
@end display



@tab

(1)

@item

@code{%m}

@tab

Mes como un número decimal rellenado con ceros.

@tab

01, 02, …, 12

@tab

(9)

@item

@code{%y}

@tab

Año sin siglo como un número decimal rellenado con ceros.

@tab

00, 01, …, 99

@tab

(9)

@item

@code{%Y}

@tab

Año con siglo como número decimal.

@tab

0001, 0002, …, 2013, 2014, …, 9998, 9999

@tab

(2)

@item

@code{%H}

@tab

Hora (reloj de 24 horas) como un número decimal rellenado con ceros.

@tab

00, 01, …, 23

@tab

(9)

@item

@code{%I}

@tab

Hora (reloj de 12 horas) como un número decimal rellenado con ceros.

@tab

01, 02, …, 12

@tab

(9)

@item

@code{%p}

@tab

El equivalente de la configuración regional de AM o PM.

@tab


@display
AM, PM (en_US);@w{ }
am, pm (de_DE)@w{ }
@end display



@tab

(1),
(3)

@item

@code{%M}

@tab

Minuto como un número decimal rellenado con ceros.

@tab

00, 01, …, 59

@tab

(9)

@item

@code{%S}

@tab

Segundo como un número decimal rellenado con ceros.

@tab

00, 01, …, 59

@tab

(4),
(9)

@item

@code{%f}

@tab

Microsegundo como número decimal, con ceros hasta 6 dígitos.

@tab

000000, 000001, …, 999999

@tab

(5)

@item

@code{%z}

@tab

Desplazamiento (`offset') UTC en la forma @code{±HHMM[SS[.ffffff]]} (cadena de caracteres vacía si el objeto es naíf (`naive')).

@tab

(vacío), +0000, -0400, +1030, +063415, -030712.345216

@tab

(6)

@item

@code{%Z}

@tab

Nombre de zona horaria (cadena de caracteres vacía si el objeto es naíf (`naive')).

@tab

(vacío), UTC, GMT

@tab

(6)

@item

@code{%j}

@tab

Día del año como un número decimal rellenado con ceros.

@tab

001, 002, …, 366

@tab

(9)

@item

@code{%U}

@tab

Número de semana del año (domingo como primer día de la semana) como un número decimal con ceros. Todos los días de un nuevo año que preceden al primer domingo se consideran en la semana 0.

@tab

00, 01, …, 53

@tab

(7),
(9)

@item

@code{%W}

@tab

Número de semana del año (lunes como primer día de la semana) como un número decimal con ceros. Todos los días de un nuevo año que preceden al primer lunes se consideran en la semana 0.

@tab

00, 01, …, 53

@tab

(7),
(9)

@item

@code{%c}

@tab

Representación apropiada de fecha y hora de la configuración regional.

@tab


@display
`Tue Aug 16 21:30:00 1988 (en_US)';@w{ }
`Di 16 Aug 21:30:00 1988 (de_DE)'@w{ }
@end display



@tab

(1)

@item

@code{%x}

@tab

Representación de fecha apropiada de la configuración regional.

@tab


@display
08/16/88 (`None');@w{ }
08/16/1988 (en_US);@w{ }
16.08.1988 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%X}

@tab

Representación de la hora apropiada de la configuración regional.

@tab


@display
21:30:00 (en_US);@w{ }
21:30:00 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%%}

@tab

Un carácter literal @code{’%’}.

@tab

%

@tab

@end multitable


Se incluyen varias directivas adicionales no requeridas por el estándar C89 por conveniencia. Todos estos parámetros corresponden a valores de fecha ISO 8601.


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Directiva

@tab

Significado

@tab

Ejemplo

@tab

Notas

@item

@code{%G}

@tab

ISO 8601 año con siglo que representa el año que contiene la mayor parte de la semana ISO (@code{%V}).

@tab

0001, 0002, …, 2013, 2014, …, 9998, 9999

@tab

(8)

@item

@code{%u}

@tab

ISO 8601 día de la semana como un número decimal donde 1 es lunes.

@tab

1, 2, …, 7

@tab

@item

@code{%V}

@tab

ISO 8601 semana como un número decimal con lunes como primer día de la semana. La semana 01 es la semana que contiene el 4 de enero.

@tab

01, 02, …, 53

@tab

(8),
(9)

@item

@code{%:z}

@tab

UTC offset in the form
@code{±HH:MM[:SS[.ffffff]]}
(empty string if the object is
naive).

@tab

(empty), +00:00,
-04:00, +10:30,
+06:34:15,
-03:07:12.345216

@tab

(6)

@end multitable


These may not be available on all platforms when used with the @ref{d19,,strftime()}
method. The ISO 8601 year and ISO 8601 week directives are not interchangeable
with the year and week number directives above. Calling @ref{15ec,,strptime()} with
incomplete or ambiguous ISO 8601 directives will raise a @ref{360,,ValueError}.

The full set of format codes supported varies across platforms, because Python
calls the platform C library’s @code{strftime()} function, and platform
variations are common. To see the full set of format codes supported on your
platform, consult the @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}} documentation. There are also
differences between platforms in handling of unsupported format specifiers.


Added in version 3.6: @code{%G}, @code{%u} y @code{%V} fueron añadidos.



Added in version 3.12: @code{%:z} was added.


@node Detalle técnico,,strftime and strptime Format Codes,strftime and strptime Behavior
@anchor{library/datetime technical-detail}@anchor{2487}
@subsubsection Detalle técnico


Broadly speaking, @code{d.strftime(fmt)} acts like the @ref{ee,,time} module’s
@code{time.strftime(fmt, d.timetuple())} although not all objects support a
@ref{244c,,timetuple()} method.

For the @ref{15ec,,datetime.strptime()} class method, the default value is
@code{1900-01-01T00:00:00.000}: any components not specified in the format string
will be pulled from the default value. @footnote{
Passing @code{datetime.strptime('Feb 29', '%b %d')} will fail since 1900 is not a leap year.
}

Usar @code{datetime.strptime(date_string, format)} es equivalente a:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

except when the format includes sub-second components or time zone offset
information, which are supported in @code{datetime.strptime} but are discarded by
@code{time.strptime}.

For @ref{331,,time} objects, the format codes for year, month, and day should not
be used, as @code{time} objects have no such values. If they’re used anyway,
1900 is substituted for the year, and 1 for the month and day.

For @ref{330,,date} objects, the format codes for hours, minutes, seconds, and
microseconds should not be used, as @ref{330,,date} objects have no such
values. If they’re used anyway, 0 is substituted for them.

Por la misma razón, el manejo de cadenas de formato que contienen puntos de código Unicode que no se pueden representar en el conjunto de caracteres del entorno local actual también depende de la plataforma. En algunas plataformas, estos puntos de código se conservan intactos en la salida, mientras que en otros @code{strftime} puede generar @ref{130f,,UnicodeError} o retornar una cadena vacía.

Notas:


@enumerate 

@item 
Because the format depends on the current locale, care should be taken when
making assumptions about the output value. Field orderings will vary (for
example, «month/day/year» versus «day/month/year»), and the output may
contain non-ASCII characters.

@item 
The @ref{15ec,,strptime()} method can parse years in the full [1, 9999] range, but
years < 1000 must be zero-filled to 4-digit width.


Distinto en la versión 3.2: In previous versions, @ref{d19,,strftime()} method was restricted to
years >= 1900.



Distinto en la versión 3.3: In version 3.2, @ref{d19,,strftime()} method was restricted to
years >= 1000.


@item 
When used with the @ref{15ec,,strptime()} method, the @code{%p} directive only affects
the output hour field if the @code{%I} directive is used to parse the hour.

@item 
Unlike the @ref{ee,,time} module, the @code{datetime} module does not support
leap seconds.

@item 
When used with the @ref{15ec,,strptime()} method, the @code{%f} directive
accepts from one to six digits and zero pads on the right. @code{%f} is
an extension to the set of format characters in the C standard (but
implemented separately in datetime objects, and therefore always
available).

@item 
For a naive object, the @code{%z}, @code{%:z} and @code{%Z} format codes are replaced
by empty strings.

Para un objeto consciente (`aware')


@table @asis

@item @code{%z}

@ref{245f,,utcoffset()} is transformed into a string of the form
@code{±HHMM[SS[.ffffff]]}, where @code{HH} is a 2-digit string giving the number
of UTC offset hours, @code{MM} is a 2-digit string giving the number of UTC
offset minutes, @code{SS} is a 2-digit string giving the number of UTC offset
seconds and @code{ffffff} is a 6-digit string giving the number of UTC
offset microseconds. The @code{ffffff} part is omitted when the offset is a
whole number of seconds and both the @code{ffffff} and the @code{SS} part is
omitted when the offset is a whole number of minutes. For example, if
@ref{245f,,utcoffset()} returns @code{timedelta(hours=-3, minutes=-30)}, @code{%z} is
replaced with the string @code{'-0330'}.
@end table


Distinto en la versión 3.7: El desfase UTC no está restringido a un número entero de minutos.



Distinto en la versión 3.7: When the @code{%z} directive is provided to the  @ref{15ec,,strptime()} method,
the UTC offsets can have a colon as a separator between hours, minutes
and seconds.
For example, @code{'+01:00:00'} will be parsed as an offset of one hour.
In addition, providing @code{'Z'} is identical to @code{'+00:00'}.



@table @asis

@item @code{%:z}

Behaves exactly as @code{%z}, but has a colon separator added between
hours, minutes and seconds.

@item @code{%Z}

In @ref{d19,,strftime()}, @code{%Z} is replaced by an empty string if
@ref{2462,,tzname()} returns @code{None}; otherwise @code{%Z} is replaced by the
returned value, which must be a string.

@ref{15ec,,strptime()} only accepts certain values for @code{%Z}:


@enumerate 

@item 
cualquier valor en @code{time.tzname} para la configuración regional de su máquina

@item 
los valores codificados de forma rígida @code{UTC} y @code{GMT}
@end enumerate

Entonces, alguien que viva en Japón puede tener @code{JST}, @code{UTC} y @code{GMT} como valores válidos, pero probablemente no @code{EST}. Lanzará @code{ValueError} para valores no válidos.
@end table


Distinto en la versión 3.2: When the @code{%z} directive is provided to the @ref{15ec,,strptime()} method, an
aware @ref{32f,,datetime} object will be produced. The @code{tzinfo} of the
result will be set to a @ref{1134,,timezone} instance.


@item 
When used with the @ref{15ec,,strptime()} method, @code{%U} and @code{%W} are only used
in calculations when the day of the week and the calendar year (@code{%Y})
are specified.

@item 
Similar to @code{%U} and @code{%W}, @code{%V} is only used in calculations when the
day of the week and the ISO year (@code{%G}) are specified in a
@ref{15ec,,strptime()} format string. Also note that @code{%G} and @code{%Y} are not
interchangeable.

@item 
When used with the @ref{15ec,,strptime()} method, the leading zero is optional
for  formats @code{%d}, @code{%m}, @code{%H}, @code{%I}, @code{%M}, @code{%S}, @code{%j}, @code{%U},
@code{%W}, and @code{%V}. Format @code{%y} does require a leading zero.

@item 
When parsing a month and day using @ref{15ec,,strptime()}, always
include a year in the format.  If the value you need to parse lacks a year,
append an explicit dummy leap year.  Otherwise your code will raise an
exception when it encounters leap day because the default year used by the
parser is not a leap year.  Users run into this bug every four years…

@example
>>> month_day = "02/29"
>>> datetime.strptime(f"@{month_day@};1984", "%m/%d;%Y")  # No leap year bug.
datetime.datetime(1984, 2, 29, 0, 0)
@end example


Deprecated since version 3.13, will be removed in version 3.15: @ref{15ec,,strptime()} calls using a format string containing
a day of month without a year now emit a
@ref{1da,,DeprecationWarning}. In 3.15 or later we may change this into
an error or change the default year to a leap year. See gh-70647@footnote{https://github.com/python/cpython/issues/70647}.

@end enumerate

@subsubheading Pie de notas


@node zoneinfo — IANA time zone support,calendar — General calendar-related functions,datetime — Basic date and time types,Tipos de datos
@anchor{library/zoneinfo doc}@anchor{2488}@anchor{library/zoneinfo module-zoneinfo}@anchor{133}@anchor{library/zoneinfo zoneinfo-iana-time-zone-support}@anchor{2489}
@subsection @code{zoneinfo} — IANA time zone support


@geindex module; zoneinfo


Added in version 3.9.


`Código fuente:' Lib/zoneinfo@footnote{https://github.com/python/cpython/tree/main/Lib/zoneinfo}


__________________________________________________________________


The @ref{133,,zoneinfo} module provides a concrete time zone implementation to
support the IANA time zone database as originally specified in 
@geindex Python Enhancement Proposals; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}. By
default, @ref{133,,zoneinfo} uses the system’s time zone data if available; if no
system time zone data is available, the library will fall back to using the
first-party tzdata@footnote{https://pypi.org/project/tzdata/} package available on PyPI.


@subsubheading Ver también



@table @asis

@item Modulo: @ref{31,,datetime}

Proporciona los tipos @ref{331,,time} y @ref{32f,,datetime} con los que está diseñada la clase @ref{976,,ZoneInfo}.

@item Package tzdata@footnote{https://pypi.org/project/tzdata/}

Paquete de origen mantenido por los desarrolladores del núcleo de CPython para suministrar datos de zonas horarias a través de PyPI.
@end table


@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@menu
* Usando ZoneInfo:: 
* Fuentes de datos:: 
* La clase ZoneInfo:: 
* Funciones: Funciones<3>. 
* Globales:: 
* Excepciones y advertencias:: 

@end menu

@node Usando ZoneInfo,Fuentes de datos,,zoneinfo — IANA time zone support
@anchor{library/zoneinfo using-zoneinfo}@anchor{248a}
@subsubsection Usando @code{ZoneInfo}


@ref{976,,ZoneInfo} es una implementación concreta de la clase base abstracta @ref{67f,,datetime.tzinfo}, y está pensada para ser adjuntada a @code{tzinfo}, bien a través del constructor, del método @ref{150b,,datetime.replace} o de @ref{a62,,datetime.astimezone}:

@example
>>> from zoneinfo import ZoneInfo
>>> from datetime import datetime, timedelta

>>> dt = datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-10-31 12:00:00-07:00

>>> dt.tzname()
'PDT'
@end example

Las fechas construidas de esta manera son compatibles con la aritmética de fechas y manejan las transiciones del horario de verano sin ninguna otra intervención:

@example
>>> dt_add = dt + timedelta(days=1)

>>> print(dt_add)
2020-11-01 12:00:00-08:00

>>> dt_add.tzname()
'PST'
@end example

Estas zonas horarias también soportan el atributo @ref{cdf,,fold} introducido en 
@geindex Python Enhancement Proposals; PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/}.  Durante las transiciones de desfase que inducen tiempos ambiguos (como una transición de horario de verano a horario estándar), se utiliza el desfase de `antes' de la transición cuando @code{fold=0}, y el desfase `después' de la transición cuando @code{fold=1}, por ejemplo:

@example
>>> dt = datetime(2020, 11, 1, 1, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-11-01 01:00:00-07:00

>>> print(dt.replace(fold=1))
2020-11-01 01:00:00-08:00
@end example

Al convertir desde otra zona horaria, el pliegue se ajustará al valor correcto:

@example
>>> from datetime import timezone
>>> LOS_ANGELES = ZoneInfo("America/Los_Angeles")
>>> dt_utc = datetime(2020, 11, 1, 8, tzinfo=timezone.utc)

>>> # Before the PDT -> PST transition
>>> print(dt_utc.astimezone(LOS_ANGELES))
2020-11-01 01:00:00-07:00

>>> # After the PDT -> PST transition
>>> print((dt_utc + timedelta(hours=1)).astimezone(LOS_ANGELES))
2020-11-01 01:00:00-08:00
@end example

@node Fuentes de datos,La clase ZoneInfo,Usando ZoneInfo,zoneinfo — IANA time zone support
@anchor{library/zoneinfo data-sources}@anchor{248b}
@subsubsection Fuentes de datos


The @code{zoneinfo} module does not directly provide time zone data, and instead
pulls time zone information from the system time zone database or the
first-party PyPI package tzdata@footnote{https://pypi.org/project/tzdata/}, if available. Some systems, including
notably Windows systems, do not have an IANA database available, and so for
projects targeting cross-platform compatibility that require time zone data, it
is recommended to declare a dependency on tzdata. If neither system data nor
tzdata are available, all calls to @ref{976,,ZoneInfo} will raise
@ref{248c,,ZoneInfoNotFoundError}.

@menu
* Configurando los orígenes de datos:: 

@end menu

@node Configurando los orígenes de datos,,,Fuentes de datos
@anchor{library/zoneinfo configuring-the-data-sources}@anchor{248d}@anchor{library/zoneinfo zoneinfo-data-configuration}@anchor{248e}
@subsubsection Configurando los orígenes de datos


Cuando se llama a @code{ZoneInfo(key)}, el constructor busca primero en los directorios especificados en @ref{1d76,,TZPATH} un archivo que coincida con @code{key}, y en caso de fallo busca una coincidencia en el paquete tzdata. Este comportamiento puede configurarse de tres maneras:


@enumerate 

@item 
El @ref{1d76,,TZPATH} por defecto cuando no se especifica otra cosa puede configurarse en @ref{1d77,,tiempo de compilación}.

@item 
@ref{1d76,,TZPATH} puede configurarse utilizando @ref{248f,,una variable de entorno}.

@item 
En @ref{2490,,runtime}, la ruta de búsqueda puede ser manipulada usando la función @ref{2491,,reset_tzpath()}.
@end enumerate

@menu
* Configuración en tiempo de compilación:: 
* Configuración del entorno:: 
* Configuración de tiempo de ejecución:: 

@end menu

@node Configuración en tiempo de compilación,Configuración del entorno,,Configurando los orígenes de datos
@anchor{library/zoneinfo compile-time-configuration}@anchor{2492}@anchor{library/zoneinfo zoneinfo-data-compile-time-config}@anchor{1d77}
@subsubsection Configuración en tiempo de compilación


El @ref{1d76,,TZPATH} predeterminado incluye varias ubicaciones de implementación comunes para la base de datos de la zona horaria (excepto en Windows, donde no hay ubicaciones «conocidas» para los datos de la zona horaria). En los sistemas POSIX, los distribuidores posteriores y aquellos que compilan Python desde la fuente que saben dónde se implementan los datos de la zona horaria del sistema pueden cambiar la ruta de la zona horaria predeterminada especificando la opción de tiempo de compilación @code{TZPATH} (o, más probablemente, el @ref{1d75,,configure flag --with-tzpath}), que debería ser una cadena delimitada por @ref{1d4a,,os.pathsep}.

En todas las plataformas, el valor configurado está disponible como la clave @code{TZPATH} en @ref{10a7,,sysconfig.get_config_var()}.

@node Configuración del entorno,Configuración de tiempo de ejecución,Configuración en tiempo de compilación,Configurando los orígenes de datos
@anchor{library/zoneinfo environment-configuration}@anchor{2493}@anchor{library/zoneinfo zoneinfo-data-environment-var}@anchor{248f}
@subsubsection Configuración del entorno


Cuando se inicializa @ref{1d76,,TZPATH} (ya sea en el momento de la importación o cuando se llama a @ref{2491,,reset_tzpath()} sin argumentos), el módulo @code{zoneinfo} utilizará la variable de entorno @code{PYTHONTZPATH}, si existe, para establecer la ruta de búsqueda.

@geindex variables de entorno; PYTHONTZPATH
@anchor{library/zoneinfo envvar-PYTHONTZPATH}@anchor{2494}
@deffn {Variables De Entorno} PYTHONTZPATH

Se trata de una cadena separada por @ref{1d4a,,os.pathsep} que contiene la ruta de búsqueda de la zona horaria a utilizar. Debe consistir sólo en rutas absolutas y no relativas. Los componentes relativos especificados en @code{PYTHONTZPATH} no se utilizarán, pero por lo demás el comportamiento cuando se especifica una ruta relativa es definido por la implementación; CPython lanzará @ref{2495,,InvalidTZPathWarning}, pero otras implementaciones son libres de ignorar silenciosamente el componente erróneo o lanzar una excepción.
@end deffn

Para que el sistema ignore los datos del sistema y utilice el paquete tzdata en su lugar, establezca @code{PYTHONTZPATH=""}.

@node Configuración de tiempo de ejecución,,Configuración del entorno,Configurando los orígenes de datos
@anchor{library/zoneinfo runtime-configuration}@anchor{2496}@anchor{library/zoneinfo zoneinfo-data-runtime-config}@anchor{2490}
@subsubsection Configuración de tiempo de ejecución


La ruta de búsqueda de TZ también puede configurarse en tiempo de ejecución mediante la función @ref{2491,,reset_tzpath()}. Por lo general, esta operación no es aconsejable, aunque es razonable utilizarla en funciones de prueba que requieran el uso de una ruta de zona horaria específica (o que requieran deshabilitar el acceso a las zonas horarias del sistema).

@node La clase ZoneInfo,Funciones<3>,Fuentes de datos,zoneinfo — IANA time zone support
@anchor{library/zoneinfo the-zoneinfo-class}@anchor{2497}
@subsubsection La clase @code{ZoneInfo}


@geindex ZoneInfo (clase en zoneinfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo}@anchor{976}
@deffn {Clase} zoneinfo.ZoneInfo (key)

Una subclase concreta de @ref{67f,,datetime.tzinfo} que representa una zona horaria IANA especificada por la cadena @code{key}. Las llamadas al constructor primario siempre devolverán objetos que se comparan de forma idéntica; dicho de otro modo, salvo la invalidación de la caché mediante @ref{2498,,ZoneInfo.clear_cache()}, para todos los valores de @code{key}, la siguiente afirmación siempre será verdadera:

@example
a = ZoneInfo(key)
b = ZoneInfo(key)
assert a is b
@end example

La @code{key} debe tener la forma de una ruta POSIX relativa y normalizada, sin referencias de nivel superior. El constructor lanzará @ref{360,,ValueError} si se pasa una clave no conforme.

Si no se encuentra ningún archivo que coincida con la @code{clave}, el constructor lanzará @ref{248c,,ZoneInfoNotFoundError}.
@end deffn

La clase @code{ZoneInfo} tiene dos constructores alternativos:

@geindex from_file() (método de clase de zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo from_file}@anchor{2499}
@deffn {Método} classmethod ZoneInfo.from_file (fobj, /, key=None)

Construye un objeto @code{ZoneInfo} a partir de un objeto tipo archivo que retorna bytes (por ejemplo, un archivo abierto en modo binario o un objeto @ref{f25,,io.BytesIO}). A diferencia del constructor primario, éste siempre construye un nuevo objeto.

El parámetro @code{key} establece el nombre de la zona a efectos de @ref{6be,,__str__()} y @ref{6bd,,__repr__()}.

Los objetos creados a través de este constructor no pueden ser serializados (ver @ref{249a,,pickling}).
@end deffn

@geindex no_cache() (método de clase de zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo no_cache}@anchor{249b}
@deffn {Método} classmethod ZoneInfo.no_cache (key)

Un constructor alternativo que omite la caché del constructor. Es idéntico al constructor principal, pero retorna un nuevo objeto en cada llamada. Es muy probable que esto sea útil para propósitos de prueba o demostración, pero también se puede utilizar para crear un sistema con una estrategia de invalidación de caché diferente.

Los objetos creados a través de este constructor también pasarán por encima de la caché de un proceso de deserialización cuando sean deserializados.

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation Prudencia 
El uso de este constructor puede cambiar la semántica de tus datetimes de manera sorprendente, sólo úsalo si sabes que lo necesitas.
@end quotation
@end cartouche
@end deffn

También están disponibles los siguientes métodos de clase:

@geindex clear_cache() (método de clase de zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo clear_cache}@anchor{2498}
@deffn {Método} classmethod ZoneInfo.clear_cache (*, only_keys=None)

Un método para invalidar la caché de la clase @code{ZoneInfo}. Si no se pasan argumentos, se invalidan todas las cachés y la siguiente llamada al constructor primario de cada clave devolverá una nueva instancia.

Si se pasa un iterable de nombres de claves al parámetro @code{only_keys}, sólo se eliminarán de la caché las claves especificadas. Las claves pasadas a @code{only_keys} pero que no se encuentran en la caché se ignoran.

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation Advertencia 
Invocar esta función puede cambiar la semántica de las fechas y horas que utilizan @code{ZoneInfo} de formas sorprendentes; esto modifica el estado del módulo y, por lo tanto, puede tener efectos de gran alcance. Utilícela solo si sabe que la necesita.
@end quotation
@end cartouche
@end deffn

La clase tiene un atributo:

@geindex key (atributo de zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo key}@anchor{249c}
@deffn {Atributo} ZoneInfo.key

Se trata de un @ref{249d,,attribute} de sólo lectura que retorna el valor de @code{key} pasado al constructor, que debe ser una clave de búsqueda en la base de datos de zonas horarias de la IANA (por ejemplo, @code{America/New_York}, @code{Europe/Paris} o @code{Asia/Tokyo}.

Para las zonas construidas a partir de un archivo sin especificar un parámetro @code{key}, se establecerá como @code{None}.

@cartouche
@quotation Nota 
Aunque es una práctica algo común exponerlos a los usuarios finales, estos valores están diseñados para ser claves primarias para representar las zonas relevantes y no necesariamente elementos orientados al usuario.  Se pueden utilizar proyectos como CLDR (Unicode Common Locale Data Repository) para obtener cadenas más fáciles de usar a partir de estas claves.
@end quotation
@end cartouche
@end deffn

@menu
* Representaciones de cadenas:: 
* Serialización de Pickle:: 

@end menu

@node Representaciones de cadenas,Serialización de Pickle,,La clase ZoneInfo
@anchor{library/zoneinfo string-representations}@anchor{249e}
@subsubsection Representaciones de cadenas


La representación de cadena que se retorna al llamar a @ref{237,,str} sobre un objeto @ref{976,,ZoneInfo} utiliza por defecto el atributo @ref{249c,,ZoneInfo.key} (ver la nota de uso en la documentación del atributo):

@example
>>> zone = ZoneInfo("Pacific/Kwajalein")
>>> str(zone)
'Pacific/Kwajalein'

>>> dt = datetime(2020, 4, 1, 3, 15, tzinfo=zone)
>>> f"@{dt.isoformat()@} [@{dt.tzinfo@}]"
'2020-04-01T03:15:00+12:00 [Pacific/Kwajalein]'
@end example

Para los objetos construidos a partir de un fichero sin especificar un parámetro @code{key}, @code{str} vuelve a llamar a @code{repr`()}. El parámetro @code{repr} de @code{ZoneInfo} está definido por la implementación y no es necesariamente estable entre versiones, pero se garantiza que no es una clave válida de @code{ZoneInfo}.Pickled.

@node Serialización de Pickle,,Representaciones de cadenas,La clase ZoneInfo
@anchor{library/zoneinfo pickle-serialization}@anchor{249f}@anchor{library/zoneinfo pickling}@anchor{249a}
@subsubsection Serialización de Pickle


En lugar de serializar todos los datos de transición, los objetos @code{ZoneInfo} se serializan por clave, y los objetos @code{ZoneInfo} construidos a partir de archivos (incluso los que tienen un valor por @code{key} especifico) no pueden ser serializados.

El comportamiento de un archivo @code{ZoneInfo} depende de cómo se haya construido:


@enumerate 

@item 
@code{ZoneInfo(key)}: Cuando se construye con el constructor primario, un objeto @code{ZoneInfo} se serializa por la clave, y cuando se deserializa, el proceso de deserialización utiliza el primario y por lo tanto se espera que estos sean el mismo objeto que otras referencias a la misma zona horaria.  Por ejemplo, si @code{europe_berlin_pkl} es una cadena que contiene un pickle construido a partir de @code{ZoneInfo("Europe/Berlin")}, se esperaría el siguiente comportamiento:

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl)
>>> a is b
True
@end example

@item 
@code{ZoneInfo.no_cache(key)}: Cuando se construye a partir del constructor que evita la caché, el objeto @code{ZoneInfo} también se serializa por clave, pero cuando se deserializa, el proceso de deserialización utiliza el constructor que evita la caché. Si @code{europe_berlin_pkl_nc} es una cadena que contiene un pickle construido a partir de @code{ZoneInfo.no_cache("Europe/Berlin")}, cabría esperar el siguiente comportamiento:

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl_nc)
>>> a is b
False
@end example

@item 
@code{ZoneInfo.from_file(fobj, /, key=None)}: Cuando se construye a partir de un fichero, el objeto @code{ZoneInfo} lanza una excepción al ser recogido. Si un usuario final quiere recoger un @code{ZoneInfo} construido a partir de un archivo, se recomienda que utilice un tipo de envoltura o una función de serialización personalizada: ya sea serializando por clave o almacenando el contenido del objeto archivo y serializándolo.
@end enumerate

Este método de serialización requiere que los datos de la zona horaria para la clave requerida estén disponibles tanto en el lado de serialización como en el de deserialización, de forma similar a como se espera que las referencias a las clases y funciones existan tanto en el entorno de serialización como en el de deserialización. También significa que no se garantiza la consistencia de los resultados cuando se retira un @code{ZoneInfo} recogido en un entorno con una versión diferente de los datos de la zona horaria.

@node Funciones<3>,Globales,La clase ZoneInfo,zoneinfo — IANA time zone support
@anchor{library/zoneinfo functions}@anchor{24a0}
@subsubsection Funciones


@geindex available_timezones() (en el módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo available_timezones}@anchor{1966}
@deffn {Función} zoneinfo.available_timezones ()

Obtiene un conjunto que contiene todas las claves válidas para las zonas horarias de la IANA disponibles en cualquier lugar de la ruta de zonas horarias. Se recalcula en cada llamada a la función.

Esta función sólo incluye los nombres de zona canónicos y no incluye las zonas «especiales» como las que se encuentran bajo los directorios @code{posix/} y @code{right/}, o la zona @code{posixrules}.

@cartouche
@quotation Prudencia 
Esta función puede abrir un gran número de archivos, ya que la mejor manera de determinar si un archivo en la ruta de la zona horaria es una zona horaria válida es leer la «magic string» (cadena mágica) al principio.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Estos valores no están diseñados para ser expuestos a los usuarios finales; para los elementos de cara al usuario, las aplicaciones deberían utilizar algo como CLDR (el Unicode Common Locale Data Repository) para obtener cadenas más fáciles de usar. Véase también la nota de advertencia sobre @ref{249c,,ZoneInfo.key}.
@end quotation
@end cartouche
@end deffn

@geindex reset_tzpath() (en el módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo reset_tzpath}@anchor{2491}
@deffn {Función} zoneinfo.reset_tzpath (to=None)

Establece o restablece la ruta de búsqueda de la zona horaria (@ref{1d76,,TZPATH}) para el módulo. Cuando se llama sin argumentos, @ref{1d76,,TZPATH} se establece en el valor por defecto.

La llamada a @code{reset_tzpath} no invalidará la caché de @ref{976,,ZoneInfo}, por lo que las llamadas al constructor primario de @code{ZoneInfo} sólo utilizarán el nuevo @code{TZPATH} en caso de que se pierda la caché.

El parámetro @code{to} debe ser un @ref{597,,sequence} de cadenas o @ref{cd9,,os.PathLike} y no una cadena, todos los cuales deben ser rutas absolutas. @ref{360,,ValueError} se lanzará si se pasa algo que no sea una ruta absoluta.
@end deffn

@node Globales,Excepciones y advertencias,Funciones<3>,zoneinfo — IANA time zone support
@anchor{library/zoneinfo globals}@anchor{24a1}
@subsubsection Globales


@geindex TZPATH (en el módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo TZPATH}@anchor{1d76}
@deffn {Dato} zoneinfo.TZPATH

Una secuencia de sólo lectura que representa la ruta de búsqueda de zonas horarias – cuando se construye un @code{ZoneInfo} a partir de una clave, la clave se une a cada entrada del @code{TZPATH}, y se utiliza el primer archivo encontrado.

@code{TZPATH} sólo puede contener rutas absolutas, nunca relativas, independientemente de cómo esté configurado.

El objeto al que apunta @code{zoneinfo.TZPATH} puede cambiar en respuesta a una llamada a @ref{2491,,reset_tzpath()}, por lo que se recomienda utilizar @code{zoneinfo.TZPATH} en lugar de importar @code{TZPATH} desde @code{zoneinfo} o asignar una variable de larga duración a @code{zoneinfo.TZPATH}.

Para más información sobre la configuración de la ruta de búsqueda de zonas horarias, consulte @ref{248e,,Configurando los orígenes de datos}.
@end deffn

@node Excepciones y advertencias,,Globales,zoneinfo — IANA time zone support
@anchor{library/zoneinfo exceptions-and-warnings}@anchor{24a2}
@subsubsection Excepciones y advertencias


@geindex ZoneInfoNotFoundError
@anchor{library/zoneinfo zoneinfo ZoneInfoNotFoundError}@anchor{248c}
@deffn {Excepción} zoneinfo.ZoneInfoNotFoundError

Se lanza cuando la construcción de un objeto @ref{976,,ZoneInfo} falla porque la clave especificada no puede encontrarse en el sistema. Es una subclase de @ref{438,,KeyError}.
@end deffn

@geindex InvalidTZPathWarning
@anchor{library/zoneinfo zoneinfo InvalidTZPathWarning}@anchor{2495}
@deffn {Excepción} zoneinfo.InvalidTZPathWarning

Se lanza cuando 
@geindex PYTHONTZPATH
@geindex variables de entorno; PYTHONTZPATH
@ref{2494,,PYTHONTZPATH} contiene un componente no válido que será filtrado, como una ruta relativa.
@end deffn

@c Links and references:

@node calendar — General calendar-related functions,collections — Container datatypes,zoneinfo — IANA time zone support,Tipos de datos
@anchor{library/calendar doc}@anchor{24a3}@anchor{library/calendar calendar-general-calendar-related-functions}@anchor{24a4}@anchor{library/calendar module-calendar}@anchor{15}
@subsection @code{calendar} — General calendar-related functions


@geindex module; calendar

`Código fuente:' Lib/calendar.py@footnote{https://github.com/python/cpython/tree/main/Lib/calendar.py}


__________________________________________________________________


Este módulo te permite generar calendarios como el programa Unix @code{cal}, y proporciona funciones útiles adicionales relacionadas con el calendario. Por defecto, estos calendarios tienen el lunes como el primer día de la semana, y el domingo como el último (la convención europea). Use @ref{24a5,,setfirstweekday()} para establecer el primer día de la semana en domingo (6) o en cualquier otro día de la semana. Los parámetros que especifican fechas se indican como enteros. Para la funcionalidad relacionada, consulta también los módulos @ref{31,,datetime} y @ref{ee,,time}.

Las funciones y clases definidas en este módulo utilizan un calendario idealizado, el calendario gregoriano actual extendido indefinidamente en ambas direcciones. Esto coincide con la definición del calendario «Gregoriano proléptico» en el libro «Calendrical Calculations» de Dershowitz y Reingold, donde es el calendario base para todos los cálculos. Los años cero y negativos se interpretan según lo prescrito por la norma ISO 8601. El año 0 es 1 A. C., el año -1 es 2 a. C., y así sucesivamente.

@geindex Calendar (clase en calendar)
@anchor{library/calendar calendar Calendar}@anchor{24a6}
@deffn {Clase} calendar.Calendar (firstweekday=0)

Crea un objeto @ref{24a6,,Calendar}. `firstweekday' es un entero que especifica el primer día de la semana. @ref{24a7,,MONDAY} es @code{0} (por defecto), @ref{24a8,,SUNDAY} es @code{6}.

Un objeto @ref{24a6,,Calendar} proporciona varios métodos que se pueden utilizar para preparar los datos del calendario para dar formato. Esta clase no hace ningún formato en sí. Este es el trabajo de las subclases.

Las instancias de @ref{24a6,,Calendar} tienen los siguientes métodos:

@geindex iterweekdays() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar iterweekdays}@anchor{24a9}
@deffn {Método} iterweekdays ()

Retorna un iterador para los números del día de la semana que se usará durante una semana. El primer valor del iterador será el mismo que el valor de la propiedad @ref{24aa,,firstweekday}.
@end deffn

@geindex itermonthdates() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdates}@anchor{ca1}
@deffn {Método} itermonthdates (year, month)

Retorna un iterador para el mes `month' (1–12) en el año `year'. Este iterador retornará todos los días (como objetos @ref{330,,datetime.date}) para el mes y todos los días antes del inicio del mes o después del final del mes que se requieren para obtener una semana completa.
@end deffn

@geindex itermonthdays() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays}@anchor{24ab}
@deffn {Método} itermonthdays (year, month)

Retorna un iterador para el mes `month' en el año `year' similar a @ref{ca1,,itermonthdates()}, pero no restringido por el intervalo @ref{330,,datetime.date}. Los días retornados serán simplemente el día de los números del mes. Para los días fuera del mes especificado, el número de día es @code{0}.
@end deffn

@geindex itermonthdays2() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays2}@anchor{24ac}
@deffn {Método} itermonthdays2 (year, month)

Retorna un iterador para el mes `month' del año `year' similar a @ref{ca1,,itermonthdates()}, pero no restringido por el rango @ref{330,,datetime.date}. Los días retornados serán tuplas que consisten en un número de día del mes y un número de día de la semana.
@end deffn

@geindex itermonthdays3() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays3}@anchor{ca2}
@deffn {Método} itermonthdays3 (year, month)

Retorna un iterador para el mes `month' del año `year' similar a @ref{ca1,,itermonthdates()}, pero no restringido por el rango @ref{330,,datetime.date}. Los días retornados serán tuplas que consisten en un año, un mes y un día del mes.


Added in version 3.7.

@end deffn

@geindex itermonthdays4() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays4}@anchor{ca3}
@deffn {Método} itermonthdays4 (year, month)

Retorna un iterador para el mes `month' del año `year' similar a @ref{ca1,,itermonthdates()}, pero no restringido por el rango @ref{330,,datetime.date}. Los días retornados serán tuplas que consisten en un año, un mes, un día del mes y un día de la semana.


Added in version 3.7.

@end deffn

@geindex monthdatescalendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdatescalendar}@anchor{24ad}
@deffn {Método} monthdatescalendar (year, month)

Retorna una lista de las semanas del mes `month' del año `year' como semanas completas. Las semanas son listas de siete objetos @ref{330,,datetime.date}.
@end deffn

@geindex monthdays2calendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdays2calendar}@anchor{24ae}
@deffn {Método} monthdays2calendar (year, month)

Retorna una lista de las semanas del mes `month' del año `year' como semanas completas. Las semanas son listas de siete tuplas de números de días y números de días de la semana.
@end deffn

@geindex monthdayscalendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdayscalendar}@anchor{24af}
@deffn {Método} monthdayscalendar (year, month)

Retorna una lista de las semanas del mes `month' del año `year' como semanas completas. Las semanas son listas de números de siete días.
@end deffn

@geindex yeardatescalendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardatescalendar}@anchor{24b0}
@deffn {Método} yeardatescalendar (year, width=3)

Retorna los datos del año especificado listos para ser formateados. El valor de retorno es una lista de filas de mes. Cada fila de mes contiene hasta `width' meses (por defecto hasta 3). Cada mes contiene entre 4 y 6 semanas y cada semana contiene 1–7 días. Los días son objetos @ref{330,,datetime.date}.
@end deffn

@geindex yeardays2calendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardays2calendar}@anchor{24b1}
@deffn {Método} yeardays2calendar (year, width=3)

Retorna los datos del año especificado listos para ser formateados (similar a @ref{24b0,,yeardatescalendar()}). Las entradas en las listas de la semana son tuplas de números de días y números de días de la semana. Los números de los días fuera de este mes son cero.
@end deffn

@geindex yeardayscalendar() (método de calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardayscalendar}@anchor{24b2}
@deffn {Método} yeardayscalendar (year, width=3)

Retorna los datos del año especificado listos para ser formateados (similar a @ref{24b0,,yeardatescalendar()}). Las entradas en las listas de la semana son números de día. Los números de día fuera de este mes son cero.
@end deffn
@end deffn

@geindex TextCalendar (clase en calendar)
@anchor{library/calendar calendar TextCalendar}@anchor{24b3}
@deffn {Clase} calendar.TextCalendar (firstweekday=0)

Esta clase puede ser usada para generar calendarios de texto simple.

Las instancias de @ref{24b3,,TextCalendar} tienen los siguientes métodos:

@geindex formatmonth() (método de calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatmonth}@anchor{24b4}
@deffn {Método} formatmonth (theyear, themonth, w=0, l=0)

Retorna el calendario de un mes en una cadena de varias líneas. Si se proporciona `w', especifica el ancho de las columnas de fecha, que están centradas. Si se proporciona `l', especifica el número de líneas que se utilizarán cada semana. Depende del primer día de la semana como se especifica en el constructor o se establece por el método @ref{24a5,,setfirstweekday()}.
@end deffn

@geindex prmonth() (método de calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar prmonth}@anchor{24b5}
@deffn {Método} prmonth (theyear, themonth, w=0, l=0)

Imprime el calendario de un mes como lo retorna @ref{24b4,,formatmonth()}.
@end deffn

@geindex formatyear() (método de calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatyear}@anchor{24b6}
@deffn {Método} formatyear (theyear, w=2, l=1, c=6, m=3)

Retorna un calendario de `m' columnas para todo un año como una cadena de varias líneas. Los parámetros opcionales `w', `l' y `c' son para el ancho de la columna de la fecha, las líneas por semana y el número de espacios entre las columnas del mes, respectivamente. Depende del primer día de la semana como se especifica en el constructor o se establece por el método @ref{24a5,,setfirstweekday()}. El primer año para el que se puede generar un calendario depende de la plataforma.
@end deffn

@geindex pryear() (método de calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar pryear}@anchor{24b7}
@deffn {Método} pryear (theyear, w=2, l=1, c=6, m=3)

Imprime el calendario de un año entero como lo retorna @ref{24b6,,formatyear()}.
@end deffn
@end deffn

@geindex HTMLCalendar (clase en calendar)
@anchor{library/calendar calendar HTMLCalendar}@anchor{24b8}
@deffn {Clase} calendar.HTMLCalendar (firstweekday=0)

Esta clase puede utilizarse para generar calendarios HTML.

Las instancias de @code{HTMLCalendar} tienen los siguientes métodos:

@geindex formatmonth() (método de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatmonth}@anchor{24b9}
@deffn {Método} formatmonth (theyear, themonth, withyear=True)

Retorna el calendario de un mes como una tabla HTML. Si `withyear' es verdadero, el año será incluido en el encabezado, de lo contrario sólo se usará el nombre del mes.
@end deffn

@geindex formatyear() (método de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatyear}@anchor{24ba}
@deffn {Método} formatyear (theyear, width=3)

Retorna el calendario de un año como una tabla HTML. `width' (por defecto a 3) especifica el número de meses por fila.
@end deffn

@geindex formatyearpage() (método de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatyearpage}@anchor{24bb}
@deffn {Método} formatyearpage (theyear, width=3, css='calendar.css', encoding=None)

Retorna el calendario de un año como una página HTML completa. `width' (por defecto a 3) especifica el número de meses por fila. `css' es el nombre de la hoja de estilo en cascada que se debe usar. @ref{716,,None} puede ser pasada si no se debe usar una hoja de estilo. `encoding' especifica la codificación a ser usada para la salida (por defecto a la codificación por defecto del sistema).
@end deffn

@geindex formatmonthname() (método de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatmonthname}@anchor{24bc}
@deffn {Método} formatmonthname (theyear, themonth, withyear=True)

Return a month name as an HTML table row. If `withyear' is true the year
will be included in the row, otherwise just the month name will be
used.
@end deffn

@code{HTMLCalendar} tiene los siguientes atributos que puedes sobrescribir para personalizar las clases CSS utilizadas por el calendario:

@geindex cssclasses (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclasses}@anchor{24bd}
@deffn {Atributo} cssclasses

Una lista de clases CSS utilizadas para cada día de la semana. La lista de clases predeterminada es:

@example
cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
@end example

se pueden añadir más estilos para cada día:

@example
cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
@end example

Ten en cuenta que la longitud de esta lista debe ser de siete elementos.
@end deffn

@geindex cssclass_noday (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_noday}@anchor{24be}
@deffn {Atributo} cssclass_noday

La clase CSS para un día de la semana que ocurre en el mes anterior o siguiente.


Added in version 3.7.

@end deffn

@geindex cssclasses_weekday_head (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclasses_weekday_head}@anchor{24bf}
@deffn {Atributo} cssclasses_weekday_head

Una lista de clases CSS utilizadas para los nombres de los días de la semana en la fila del encabezado. El valor por defecto es el mismo que @ref{24bd,,cssclasses}.


Added in version 3.7.

@end deffn

@geindex cssclass_month_head (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_month_head}@anchor{24c0}
@deffn {Atributo} cssclass_month_head

La clase de CSS del mes (usada por @ref{24bc,,formatmonthname()}). El valor por defecto es @code{"month"}.


Added in version 3.7.

@end deffn

@geindex cssclass_month (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_month}@anchor{24c1}
@deffn {Atributo} cssclass_month

La clase de CSS para la tabla de todo el mes (usada por @ref{24b9,,formatmonth()}). El valor por defecto es @code{"month"}.


Added in version 3.7.

@end deffn

@geindex cssclass_year (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_year}@anchor{24c2}
@deffn {Atributo} cssclass_year

La clase de CSS para la tabla de tablas de todo el año (usada por @ref{24ba,,formatyear()}). El valor por defecto es @code{"year"}.


Added in version 3.7.

@end deffn

@geindex cssclass_year_head (atributo de calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_year_head}@anchor{24c3}
@deffn {Atributo} cssclass_year_head

La clase de CSS para el encabezado de la tabla para todo el año (usado por @ref{24ba,,formatyear()}). El valor por defecto es @code{"year"}.


Added in version 3.7.

@end deffn

Nótese que aunque la denominación de los atributos de clase descritos anteriormente es singular (por ejemplo, @code{cssclass_month} @code{cssclass_noday}), uno puede reemplazar la clase CSS única con una lista de clases CSS separadas por espacios, por ejemplo:

@example
"text-bold text-red"
@end example

Aquí hay un ejemplo de cómo @code{HTMLCalendar} puede ser personalizado:

@example
class CustomHTMLCal(calendar.HTMLCalendar):
    cssclasses = [style + " text-nowrap" for style in
                  calendar.HTMLCalendar.cssclasses]
    cssclass_month_head = "text-center month-head"
    cssclass_month = "text-center month"
    cssclass_year = "text-italic lead"
@end example
@end deffn

@geindex LocaleTextCalendar (clase en calendar)
@anchor{library/calendar calendar LocaleTextCalendar}@anchor{7df}
@deffn {Clase} calendar.LocaleTextCalendar (firstweekday=0, locale=None)

Esta subclase de @ref{24b3,,TextCalendar} se le puede pasar un nombre de configuración regional en el constructor y retornará los nombres de los meses y días de la semana en la configuración regional especificada.
@end deffn

@geindex LocaleHTMLCalendar (clase en calendar)
@anchor{library/calendar calendar LocaleHTMLCalendar}@anchor{7e0}
@deffn {Clase} calendar.LocaleHTMLCalendar (firstweekday=0, locale=None)

Esta subclase de @ref{24b8,,HTMLCalendar} se le puede pasar un nombre de configuración regional en el constructor y retornará los nombres de los meses y días de la semana en la configuración regional especificada.
@end deffn

@cartouche
@quotation Nota 
The constructor, @code{formatweekday()} and @code{formatmonthname()} methods
of these two classes temporarily change the @code{LC_TIME} locale to the given
`locale'. Because the current locale is a process-wide setting, they are
not thread-safe.
@end quotation
@end cartouche

Para los calendarios de texto simples este módulo proporciona las siguientes funciones.

@geindex setfirstweekday() (en el módulo calendar)
@anchor{library/calendar calendar setfirstweekday}@anchor{24a5}
@deffn {Función} calendar.setfirstweekday (weekday)

Establece el día de la semana (el @code{0} es el lunes, el @code{6} es el domingo) para empezar cada semana. Los valores @ref{24a7,,MONDAY}, @ref{24c4,,TUESDAY}, @ref{24c5,,WEDNESDAY}, @ref{24c6,,THURSDAY}, @ref{24c7,,FRIDAY}, @ref{24c8,,SATURDAY}, y @ref{24a8,,SUNDAY} se proporcionan por conveniencia. Por ejemplo, para fijar el primer día de la semana en domingo:

@example
import calendar
calendar.setfirstweekday(calendar.SUNDAY)
@end example
@end deffn

@geindex firstweekday() (en el módulo calendar)
@anchor{library/calendar calendar firstweekday}@anchor{24aa}
@deffn {Función} calendar.firstweekday ()

Retorna la configuración actual para el día de la semana para empezar cada semana.
@end deffn

@geindex isleap() (en el módulo calendar)
@anchor{library/calendar calendar isleap}@anchor{24c9}
@deffn {Función} calendar.isleap (year)

Retorna @ref{c95,,True} si `year' es un año bisiesto, si no @ref{bbf,,False}.
@end deffn

@geindex leapdays() (en el módulo calendar)
@anchor{library/calendar calendar leapdays}@anchor{24ca}
@deffn {Función} calendar.leapdays (y1, y2)

Retorna el número de años bisiestos en el rango de `y1' a `y2' (exclusivo), donde `y1' y `y2' son años.

Esta función opera para rangos que abarcan un cambio de siglo.
@end deffn

@geindex weekday() (en el módulo calendar)
@anchor{library/calendar calendar weekday}@anchor{24cb}
@deffn {Función} calendar.weekday (year, month, day)

Retorna el día de la semana (@code{0} es lunes) para `year' (@code{1970}–…), `month' (@code{1}–@code{12}), `day' (@code{1}–@code{31}).
@end deffn

@geindex weekheader() (en el módulo calendar)
@anchor{library/calendar calendar weekheader}@anchor{24cc}
@deffn {Función} calendar.weekheader (n)

Retorna un encabezado con nombres abreviados de los días de la semana. `n' especifica el ancho en caracteres de un día de la semana.
@end deffn

@geindex monthrange() (en el módulo calendar)
@anchor{library/calendar calendar monthrange}@anchor{24cd}
@deffn {Función} calendar.monthrange (year, month)

Retorna el día de la semana del primer día del mes y el número de días del mes, para el `year' y `month' especificados.
@end deffn

@geindex monthcalendar() (en el módulo calendar)
@anchor{library/calendar calendar monthcalendar}@anchor{24ce}
@deffn {Función} calendar.monthcalendar (year, month)

Retorna una matriz que representa el calendario de un mes. Cada fila representa una semana; los días fuera del mes se representan con ceros. Cada semana comienza con el lunes a menos que lo establezca @ref{24a5,,setfirstweekday()}.
@end deffn

@geindex prmonth() (en el módulo calendar)
@anchor{library/calendar calendar prmonth}@anchor{24cf}
@deffn {Función} calendar.prmonth (theyear, themonth, w=0, l=0)

Imprime el calendario de un mes según lo retorna @ref{159e,,month()}.
@end deffn

@geindex month() (en el módulo calendar)
@anchor{library/calendar calendar month}@anchor{159e}
@deffn {Función} calendar.month (theyear, themonth, w=0, l=0)

Returns a month’s calendar in a multi-line string using the @ref{24b4,,formatmonth()}
of the @ref{24b3,,TextCalendar} class.
@end deffn

@geindex prcal() (en el módulo calendar)
@anchor{library/calendar calendar prcal}@anchor{24d0}
@deffn {Función} calendar.prcal (year, w=0, l=0, c=6, m=3)

Imprime el calendario de todo un año como lo retorna @ref{15,,calendar()}.
@end deffn

@geindex calendar() (en el módulo calendar)
@anchor{library/calendar calendar calendar}@anchor{24d1}
@deffn {Función} calendar.calendar (year, w=2, l=1, c=6, m=3)

Returns a 3-column calendar for an entire year as a multi-line string using
the @ref{24b6,,formatyear()} of the @ref{24b3,,TextCalendar} class.
@end deffn

@geindex timegm() (en el módulo calendar)
@anchor{library/calendar calendar timegm}@anchor{24d2}
@deffn {Función} calendar.timegm (tuple)

Una función no relacionada pero útil que toma una tupla de tiempo como la retornada por la función @ref{122d,,gmtime()} en el módulo @ref{ee,,time}, y retorna el valor correspondiente a la marca de tiempo (`timestamp') Unix, asumiendo una época de 1970, y la codificación POSIX. De hecho, @ref{122d,,time.gmtime()} y @ref{24d2,,timegm()} son el inverso de cada uno de ellos.
@end deffn

El módulo @ref{15,,calendar} exporta los siguientes atributos de datos:

@geindex day_name (en el módulo calendar)
@anchor{library/calendar calendar day_name}@anchor{24d3}
@deffn {Dato} calendar.day_name

A sequence that represents the days of the week in the current locale,
where Monday is day number 0.

@example
>>> import calendar
>>> list(calendar.day_name)
['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
@end example
@end deffn

@geindex day_abbr (en el módulo calendar)
@anchor{library/calendar calendar day_abbr}@anchor{24d4}
@deffn {Dato} calendar.day_abbr

A sequence that represents the abbreviated days of the week in the current locale,
where Mon is day number 0.

@example
>>> import calendar
>>> list(calendar.day_abbr)
['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
@end example
@end deffn

@geindex MONDAY (en el módulo calendar)
@geindex TUESDAY (en el módulo calendar)
@geindex WEDNESDAY (en el módulo calendar)
@geindex THURSDAY (en el módulo calendar)
@geindex FRIDAY (en el módulo calendar)
@geindex SATURDAY (en el módulo calendar)
@geindex SUNDAY (en el módulo calendar)
@anchor{library/calendar calendar MONDAY}@anchor{24a7}
@deffn {Dato} calendar.MONDAY
@anchor{library/calendar calendar TUESDAY}@anchor{24c4}
@deffnx {Dato} calendar.TUESDAY
@anchor{library/calendar calendar WEDNESDAY}@anchor{24c5}
@deffnx {Dato} calendar.WEDNESDAY
@anchor{library/calendar calendar THURSDAY}@anchor{24c6}
@deffnx {Dato} calendar.THURSDAY
@anchor{library/calendar calendar FRIDAY}@anchor{24c7}
@deffnx {Dato} calendar.FRIDAY
@anchor{library/calendar calendar SATURDAY}@anchor{24c8}
@deffnx {Dato} calendar.SATURDAY
@anchor{library/calendar calendar SUNDAY}@anchor{24a8}
@deffnx {Dato} calendar.SUNDAY

Alias para los días de la semana, donde @code{MONDAY} es @code{0} y @code{SUNDAY} es @code{6}.


Added in version 3.12.

@end deffn

@geindex Day (clase en calendar)
@anchor{library/calendar calendar Day}@anchor{52b}
@deffn {Clase} calendar.Day

Enumeración que define los días de la semana como constantes enteras. Los miembros de esta enumeración se exportan al alcance del módulo como @ref{24a7,,MONDAY} hasta @ref{24a8,,SUNDAY}.


Added in version 3.12.

@end deffn

@geindex month_name (en el módulo calendar)
@anchor{library/calendar calendar month_name}@anchor{24d5}
@deffn {Dato} calendar.month_name

A sequence that represents the months of the year in the current locale.  This
follows normal convention of January being month number 1, so it has a length of
13 and  @code{month_name[0]} is the empty string.

@example
>>> import calendar
>>> list(calendar.month_name)
['@w{'}, 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
@end example
@end deffn

@geindex month_abbr (en el módulo calendar)
@anchor{library/calendar calendar month_abbr}@anchor{24d6}
@deffn {Dato} calendar.month_abbr

A sequence that represents the abbreviated months of the year in the current
locale.  This follows normal convention of January being month number 1, so it
has a length of 13 and  @code{month_abbr[0]} is the empty string.

@example
>>> import calendar
>>> list(calendar.month_abbr)
['@w{'}, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
@end example
@end deffn

@geindex JANUARY (en el módulo calendar)
@geindex FEBRUARY (en el módulo calendar)
@geindex MARCH (en el módulo calendar)
@geindex APRIL (en el módulo calendar)
@geindex MAY (en el módulo calendar)
@geindex JUNE (en el módulo calendar)
@geindex JULY (en el módulo calendar)
@geindex AUGUST (en el módulo calendar)
@geindex SEPTEMBER (en el módulo calendar)
@geindex OCTOBER (en el módulo calendar)
@geindex NOVEMBER (en el módulo calendar)
@geindex DECEMBER (en el módulo calendar)
@anchor{library/calendar calendar JANUARY}@anchor{1f1}
@deffn {Dato} calendar.JANUARY
@anchor{library/calendar calendar FEBRUARY}@anchor{1f2}
@deffnx {Dato} calendar.FEBRUARY
@anchor{library/calendar calendar MARCH}@anchor{24d7}
@deffnx {Dato} calendar.MARCH
@anchor{library/calendar calendar APRIL}@anchor{24d8}
@deffnx {Dato} calendar.APRIL
@anchor{library/calendar calendar MAY}@anchor{24d9}
@deffnx {Dato} calendar.MAY
@anchor{library/calendar calendar JUNE}@anchor{24da}
@deffnx {Dato} calendar.JUNE
@anchor{library/calendar calendar JULY}@anchor{24db}
@deffnx {Dato} calendar.JULY
@anchor{library/calendar calendar AUGUST}@anchor{24dc}
@deffnx {Dato} calendar.AUGUST
@anchor{library/calendar calendar SEPTEMBER}@anchor{24dd}
@deffnx {Dato} calendar.SEPTEMBER
@anchor{library/calendar calendar OCTOBER}@anchor{24de}
@deffnx {Dato} calendar.OCTOBER
@anchor{library/calendar calendar NOVEMBER}@anchor{24df}
@deffnx {Dato} calendar.NOVEMBER
@anchor{library/calendar calendar DECEMBER}@anchor{24e0}
@deffnx {Dato} calendar.DECEMBER

Alias para los meses del año, donde @code{JANUARY} es @code{1} y @code{DECEMBER} es @code{12}.


Added in version 3.12.

@end deffn

@geindex Month (clase en calendar)
@anchor{library/calendar calendar Month}@anchor{52a}
@deffn {Clase} calendar.Month

Enumeración que define los meses del año como constantes enteras. Los miembros de esta enumeración se exportan al alcance del módulo como @ref{1f1,,JANUARY} hasta @ref{24e0,,DECEMBER}.


Added in version 3.12.

@end deffn

El módulo @ref{15,,calendar} define las siguientes excepciones:

@geindex IllegalMonthError
@anchor{library/calendar calendar IllegalMonthError}@anchor{159d}
@deffn {Excepción} calendar.IllegalMonthError (month)

Una subclase de @ref{360,,ValueError}, que se lanza cuando el número del mes proporcionado está fuera del rango 1-12 (inclusive).

@geindex month (atributo de calendar.IllegalMonthError)
@anchor{library/calendar calendar IllegalMonthError month}@anchor{24e1}
@deffn {Atributo} month

El número del mes no válido.
@end deffn
@end deffn

@geindex IllegalWeekdayError
@anchor{library/calendar calendar IllegalWeekdayError}@anchor{24e2}
@deffn {Excepción} calendar.IllegalWeekdayError (weekday)

Una subclase de @ref{360,,ValueError}, que se lanza cuando el número del día de la semana proporcionado está fuera del rango 0-6 (inclusive).

@geindex weekday (atributo de calendar.IllegalWeekdayError)
@anchor{library/calendar calendar IllegalWeekdayError weekday}@anchor{24e3}
@deffn {Atributo} weekday

El número de día de la semana laborable no válido.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{31,,datetime}

Interfaz orientada a objetos para fechas y horas con una funcionalidad similar a la del módulo @ref{ee,,time}.

@item Módulo @ref{ee,,time}

Funciones de bajo nivel relacionadas con el tiempo.
@end table


@menu
* Uso de la línea de comandos:: 

@end menu

@node Uso de la línea de comandos,,,calendar — General calendar-related functions
@anchor{library/calendar calendar-cli}@anchor{24e4}@anchor{library/calendar command-line-usage}@anchor{24e5}
@subsubsection Uso de la línea de comandos



Added in version 2.5.


El módulo @ref{15,,calendar} se puede ejecutar como un script desde la línea de comandos para imprimir un calendario de forma interactiva.

@example
python -m calendar [-h] [-L LOCALE] [-e ENCODING] [-t @{text,html@}]
                   [-w WIDTH] [-l LINES] [-s SPACING] [-m MONTHS] [-c CSS]
                   [-f FIRST_WEEKDAY] [year] [month]
@end example

Por ejemplo, para imprimir un calendario para el año 2000:

@example
$ python -m calendar 2000
                                  2000

      January                   February                   March
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2          1  2  3  4  5  6             1  2  3  4  5
 3  4  5  6  7  8  9       7  8  9 10 11 12 13       6  7  8  9 10 11 12
10 11 12 13 14 15 16      14 15 16 17 18 19 20      13 14 15 16 17 18 19
17 18 19 20 21 22 23      21 22 23 24 25 26 27      20 21 22 23 24 25 26
24 25 26 27 28 29 30      28 29                     27 28 29 30 31
31

       April                      May                       June
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2       1  2  3  4  5  6  7                1  2  3  4
 3  4  5  6  7  8  9       8  9 10 11 12 13 14       5  6  7  8  9 10 11
10 11 12 13 14 15 16      15 16 17 18 19 20 21      12 13 14 15 16 17 18
17 18 19 20 21 22 23      22 23 24 25 26 27 28      19 20 21 22 23 24 25
24 25 26 27 28 29 30      29 30 31                  26 27 28 29 30

        July                     August                  September
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2          1  2  3  4  5  6                   1  2  3
 3  4  5  6  7  8  9       7  8  9 10 11 12 13       4  5  6  7  8  9 10
10 11 12 13 14 15 16      14 15 16 17 18 19 20      11 12 13 14 15 16 17
17 18 19 20 21 22 23      21 22 23 24 25 26 27      18 19 20 21 22 23 24
24 25 26 27 28 29 30      28 29 30 31               25 26 27 28 29 30
31

      October                   November                  December
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                   1             1  2  3  4  5                   1  2  3
 2  3  4  5  6  7  8       6  7  8  9 10 11 12       4  5  6  7  8  9 10
 9 10 11 12 13 14 15      13 14 15 16 17 18 19      11 12 13 14 15 16 17
16 17 18 19 20 21 22      20 21 22 23 24 25 26      18 19 20 21 22 23 24
23 24 25 26 27 28 29      27 28 29 30               25 26 27 28 29 30 31
30 31
@end example

Se aceptan las siguientes opciones:

@geindex opción de línea de comando calendar; --help
@geindex opción de línea de comando calendar; -h
@anchor{library/calendar cmdoption-calendar-help}@anchor{24e6}@anchor{library/calendar cmdoption-calendar-h}@anchor{24e7}
@deffn {Option} @w{-}@w{-}help, @w{-}h

Muestra el mensaje de ayuda y salida.
@end deffn

@geindex opción de línea de comando calendar; --locale
@geindex opción de línea de comando calendar; -L
@anchor{library/calendar cmdoption-calendar-locale}@anchor{24e8}@anchor{library/calendar cmdoption-calendar-L}@anchor{24e9}
@deffn {Option} @w{-}@w{-}locale LOCALE, @w{-}L LOCALE

La configuración regional que se utiliza para los nombres de meses y días de la semana. El valor predeterminado es inglés.
@end deffn

@geindex opción de línea de comando calendar; --encoding
@geindex opción de línea de comando calendar; -e
@anchor{library/calendar cmdoption-calendar-encoding}@anchor{24ea}@anchor{library/calendar cmdoption-calendar-e}@anchor{24eb}
@deffn {Option} @w{-}@w{-}encoding ENCODING, @w{-}e ENCODING

La codificación que se utiliza para la salida. Se necesita @ref{24ea,,--encoding} si @ref{24e8,,--locale} está configurada.
@end deffn

@geindex opción de línea de comando calendar; --type
@geindex opción de línea de comando calendar; -t
@anchor{library/calendar cmdoption-calendar-type}@anchor{24ec}@anchor{library/calendar cmdoption-calendar-t}@anchor{24ed}
@deffn {Option} @w{-}@w{-}type @{text,html@}, @w{-}t @{text,html@}

Imprime el calendario en la terminal como texto o como un documento HTML.
@end deffn

@geindex opción de línea de comando calendar; --first-weekday
@geindex opción de línea de comando calendar; -f
@anchor{library/calendar cmdoption-calendar-first-weekday}@anchor{24ee}@anchor{library/calendar cmdoption-calendar-f}@anchor{24ef}
@deffn {Option} @w{-}@w{-}first@w{-}weekday FIRST_WEEKDAY, @w{-}f FIRST_WEEKDAY

The weekday to start each week.
Must be a number between 0 (Monday) and 6 (Sunday).
Defaults to 0.


Added in version 3.13.

@end deffn

@geindex opción de línea de comando calendar; year
@anchor{library/calendar cmdoption-calendar-arg-year}@anchor{24f0}
@deffn {Option} year

The year to print the calendar for.
Defaults to the current year.
@end deffn

@geindex opción de línea de comando calendar; month
@anchor{library/calendar cmdoption-calendar-arg-month}@anchor{24f1}
@deffn {Option} month

El mes de @ref{24f0,,year} especificado para imprimir el calendario. Debe ser un número entre 1 y 12 y sólo se puede usar en modo texto. El valor predeterminado es imprimir un calendario para el año completo.
@end deffn

`Opciones de modo texto:'

@geindex opción de línea de comando calendar; --width
@geindex opción de línea de comando calendar; -w
@anchor{library/calendar cmdoption-calendar-width}@anchor{24f2}@anchor{library/calendar cmdoption-calendar-w}@anchor{24f3}
@deffn {Option} @w{-}@w{-}width WIDTH, @w{-}w WIDTH

El ancho de la columna de fecha en las columnas terminales. La fecha se imprime centrada en la columna. Cualquier valor inferior a 2 se ignora. El valor predeterminado es 2.
@end deffn

@geindex opción de línea de comando calendar; --lines
@geindex opción de línea de comando calendar; -l
@anchor{library/calendar cmdoption-calendar-lines}@anchor{24f4}@anchor{library/calendar cmdoption-calendar-l}@anchor{24f5}
@deffn {Option} @w{-}@w{-}lines LINES, @w{-}l LINES

El número de líneas para cada semana en filas terminales. La fecha se imprime alineada en la parte superior. Cualquier valor inferior a 1 se ignora. El valor predeterminado es 1.
@end deffn

@geindex opción de línea de comando calendar; --spacing
@geindex opción de línea de comando calendar; -s
@anchor{library/calendar cmdoption-calendar-spacing}@anchor{24f6}@anchor{library/calendar cmdoption-calendar-s}@anchor{24f7}
@deffn {Option} @w{-}@w{-}spacing SPACING, @w{-}s SPACING

El espacio entre meses en columnas. Cualquier valor inferior a 2 se ignora. El valor predeterminado es 6.
@end deffn

@geindex opción de línea de comando calendar; --months
@geindex opción de línea de comando calendar; -m
@anchor{library/calendar cmdoption-calendar-months}@anchor{24f8}@anchor{library/calendar cmdoption-calendar-m}@anchor{24f9}
@deffn {Option} @w{-}@w{-}months MONTHS, @w{-}m MONTHS

El número de meses se imprimen por fila. El valor predeterminado es 3.
@end deffn

`Opciones de modo HTML:'

@geindex opción de línea de comando calendar; --css
@geindex opción de línea de comando calendar; -c
@anchor{library/calendar cmdoption-calendar-css}@anchor{24fa}@anchor{library/calendar cmdoption-calendar-c}@anchor{24fb}
@deffn {Option} @w{-}@w{-}css CSS, @w{-}c CSS

La ruta de una hoja de estilos CSS que se utiliza para el calendario. Esta debe ser relativa al HTML generado, o un HTTP absoluto o una URL @code{file:///}.
@end deffn

@node collections — Container datatypes,collections abc — Abstract Base Classes for Containers,calendar — General calendar-related functions,Tipos de datos
@anchor{library/collections doc}@anchor{24fc}@anchor{library/collections collections-container-datatypes}@anchor{24fd}@anchor{library/collections module-collections}@anchor{1e}
@subsection @code{collections} — Container datatypes


@geindex module; collections

`Source code:' Lib/collections/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/collections/__init__.py}

@c from collections import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


Este módulo implementa tipos de datos de contenedores especializados que proporcionan alternativas a los contenedores integrados de uso general de Python, @ref{190,,dict}, @ref{18e,,list}, @ref{67a,,set}, and @ref{464,,tuple}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{32d,,namedtuple()}

@tab

función `factory' para crear subclases de `tuplas' con campos con nombre

@item

@ref{67d,,deque}

@tab

contenedor similar a una lista con `appends' y `pops' rápidos en ambos extremos

@item

@ref{ca4,,ChainMap}

@tab

clase similar a `dict' para crear una vista única de múltiples `mapeados'

@item

@ref{110e,,Counter}

@tab

subclase de `dict' para contar objetos @ref{6b1,,hashable}

@item

@ref{67c,,OrderedDict}

@tab

subclase de `dict' que recuerda las entradas de la orden que se agregaron

@item

@ref{122a,,defaultdict}

@tab

subclase de `dict' que llama a una función de `factory' para suministrar valores faltantes

@item

@ref{199d,,UserDict}

@tab

envoltura alrededor de los objetos de diccionario para facilitar subclasificaciones `dict'

@item

@ref{1523,,UserList}

@tab

envoltura alrededor de los objetos de lista para facilitar la subclasificación de un `list'

@item

@ref{e5a,,UserString}

@tab

envoltura alrededor de objetos de cadena para facilitar la subclasificación de `string'

@end multitable


@menu
* Objetos ChainMap:: 
* Objetos Counter:: 
* Objetos deque:: 
* Objetos defaultdict:: 
* namedtuple() Funciones Factory para Tuplas y Campos con Nombres: namedtuple Funciones Factory para Tuplas y Campos con Nombres. 
* Objetos OrderedDict:: 
* Objetos UserDict:: 
* Objetos UserList:: 
* Objetos UserString:: 

@end menu

@node Objetos ChainMap,Objetos Counter,,collections — Container datatypes
@anchor{library/collections chainmap-objects}@anchor{24fe}
@subsubsection Objetos @code{ChainMap}



Added in version 3.3.


Una clase @ref{ca4,,ChainMap} se proporciona para vincular rápidamente una serie de `mappings' de modo que puedan tratarse como una sola unidad.  Suele ser mucho más rápido que crear un diccionario nuevo y ejecutar varias llamadas a @ref{14a2,,update()}.

La clase se puede utilizar para simular ámbitos anidados y es útil para crear plantillas.

@geindex ChainMap (clase en collections)
@anchor{library/collections collections ChainMap}@anchor{ca4}
@deffn {Clase} collections.ChainMap (*maps)

Un @ref{ca4,,ChainMap} agrupa varios diccionarios u otros `mappings' para crear una vista única y actualizable. Si no se especifican `maps', se proporciona un solo diccionario vacío para que una nueva cadena siempre tenga al menos un `mapeo'.

Las asignaciones subyacentes se almacenan en una lista. Esa lista es pública y se puede acceder a ella o actualizarla usando el atributo `maps'. No hay otro estado.

Las búsquedas buscan los mapeos subyacentes sucesivamente hasta que se encuentra una clave. Por el contrario, las escrituras, actualizaciones y eliminaciones solo operan en el primer `mapeo'.

Un @ref{ca4,,ChainMap} incorpora los mapeos subyacentes por referencia.  Entonces, si una de los mapeos subyacentes se actualiza, esos cambios se reflejarán en @ref{ca4,,ChainMap}.

Se admiten todos los métodos habituales de un diccionario. Además, hay un atributo `maps', un método para crear nuevos sub contextos y una propiedad para acceder a todos menos al primer mapeo:

@geindex maps (atributo de collections.ChainMap)
@anchor{library/collections collections ChainMap maps}@anchor{24ff}
@deffn {Atributo} maps

Una lista de mapeos actualizable por el usuario. La lista está ordenada desde la primera búsqueda hasta la última búsqueda. Es el único estado almacenado y se puede modificar para cambiar los mapeos que se buscan. La lista siempre debe contener al menos un mapeo.
@end deffn

@geindex new_child() (método de collections.ChainMap)
@anchor{library/collections collections ChainMap new_child}@anchor{fa5}
@deffn {Método} new_child (m=None, **kwargs)

Retorna un nuevo @ref{ca4,,ChainMap} conteniendo un nuevo mapa seguido de todos los mapas de la instancia actual.  Si se especifica @code{m}, se convierte en el nuevo mapa al principio de la lista de asignaciones; si no se especifica, se usa un diccionario vacío, de modo que una llamada a @code{d.new_child()} es equivalente a: @code{ChainMap(@{@}, *d.maps)}. Si se especifica algún argumento de palabra clave, actualiza el mapa pasado o el nuevo diccionario vacío. Este método se utiliza para crear sub contextos que se pueden actualizar sin alterar los valores en ninguna de los mapeos padre.


Distinto en la versión 3.4: Se agregó el parámetro opcional @code{m} .



Distinto en la versión 3.10: Se añadió soporte para argumentos por palabras clave.

@end deffn

@geindex parents (atributo de collections.ChainMap)
@anchor{library/collections collections ChainMap parents}@anchor{2500}
@deffn {Atributo} parents

Propiedad que retorna un nuevo @ref{ca4,,ChainMap} conteniendo todos los mapas de la instancia actual excepto el primero.  Esto es útil para omitir el primer mapa en la búsqueda.  Los casos de uso son similares a los de @ref{1313,,nonlocal} la palabra clave usada en @ref{1f3f,,alcances anidados}.  Los casos de uso también son paralelos a los de la función incorporada @ref{155,,super()}.  Una referencia a @code{d.parents} es equivalente a: @code{ChainMap(*d.maps[1:])}.
@end deffn

Note, the iteration order of a @ref{ca4,,ChainMap} is determined by
scanning the mappings last to first:

@example
>>> baseline = @{'music': 'bach', 'art': 'rembrandt'@}
>>> adjustments = @{'art': 'van gogh', 'opera': 'carmen'@}
>>> list(ChainMap(adjustments, baseline))
['music', 'art', 'opera']
@end example

Esto da el mismo orden que una serie de llamadas a @ref{14a2,,dict.update()} comenzando con el último mapeo:

@example
>>> combined = baseline.copy()
>>> combined.update(adjustments)
>>> list(combined)
['music', 'art', 'opera']
@end example


Distinto en la versión 3.9: Se agregó soporte para los operadores @code{|} y @code{|=}, especificados en 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn


@subsubheading Ver también



@itemize *

@item 
La clase MultiContext@footnote{https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py} en el paquete de Enthought llamado CodeTools@footnote{https://github.com/enthought/codetools} tiene opciones para admitir la escritura en cualquier mapeo de la cadena.

@item 
La clase de Django Context@footnote{https://github.com/django/django/blob/master/django/template/context.py} para crear plantillas es una cadena de mapeo de solo lectura. También presenta características de pushing y popping de contextos similar al método @ref{fa5,,new_child()} y a la propiedad @ref{2500,,parents} .

@item 
The Nested Contexts recipe@footnote{https://code.activestate.com/recipes/577434-nested-contexts-a-chain-of-mapping-objects/} has options to control
whether writes and other mutations apply only to the first mapping or to
any mapping in the chain.

@item 
Una versión de solo lectura muy simplificada de Chainmap@footnote{https://code.activestate.com/recipes/305268/}.
@end itemize


@menu
* Ejemplos y recetas ChainMap:: 

@end menu

@node Ejemplos y recetas ChainMap,,,Objetos ChainMap
@anchor{library/collections chainmap-examples-and-recipes}@anchor{2501}
@subsubsection Ejemplos y recetas @code{ChainMap}


Esta sección muestra varios enfoques para trabajar con mapas encadenados.

Ejemplo de simulación de la cadena de búsqueda interna de Python:

@example
import builtins
pylookup = ChainMap(locals(), globals(), vars(builtins))
@end example

Ejemplo de dejar que los argumentos de la línea de comandos especificados por el usuario tengan prioridad sobre las variables de entorno que, a su vez, tienen prioridad sobre los valores predeterminados:

@example
import os, argparse

defaults = @{'color': 'red', 'user': 'guest'@}

parser = argparse.ArgumentParser()
parser.add_argument('-u', '--user')
parser.add_argument('-c', '--color')
namespace = parser.parse_args()
command_line_args = @{k: v for k, v in vars(namespace).items() if v is not None@}

combined = ChainMap(command_line_args, os.environ, defaults)
print(combined['color'])
print(combined['user'])
@end example

Patrones de ejemplo para usar la clase @ref{ca4,,ChainMap} para simular contextos anidados:

@example
c = ChainMap()        # Create root context
d = c.new_child()     # Create nested child context
e = c.new_child()     # Child of c, independent from d
e.maps[0]             # Current context dictionary -- like Python's locals()
e.maps[-1]            # Root context -- like Python's globals()
e.parents             # Enclosing context chain -- like Python's nonlocals

d['x'] = 1            # Set value in current context
d['x']                # Get first key in the chain of contexts
del d['x']            # Delete from current context
list(d)               # All nested values
k in d                # Check all nested values
len(d)                # Number of nested values
d.items()             # All nested items
dict(d)               # Flatten into a regular dictionary
@end example

La clase @ref{ca4,,ChainMap} solo realiza actualizaciones (escrituras y eliminaciones) en el primer mapeo de la cadena, mientras que las búsquedas buscarán en la cadena completa. Sin embargo, si se desean escrituras y eliminaciones profundas, es fácil crear una subclase que actualice las claves que se encuentran más profundas en la cadena:

@example
class DeepChainMap(ChainMap):
    'Variant of ChainMap that allows direct updates to inner scopes'

    def __setitem__(self, key, value):
        for mapping in self.maps:
            if key in mapping:
                mapping[key] = value
                return
        self.maps[0][key] = value

    def __delitem__(self, key):
        for mapping in self.maps:
            if key in mapping:
                del mapping[key]
                return
        raise KeyError(key)

>>> d = DeepChainMap(@{'zebra': 'black'@}, @{'elephant': 'blue'@}, @{'lion': 'yellow'@})
>>> d['lion'] = 'orange'         # update an existing key two levels down
>>> d['snake'] = 'red'           # new keys get added to the topmost dict
>>> del d['elephant']            # remove an existing key one level down
>>> d                            # display result
DeepChainMap(@{'zebra': 'black', 'snake': 'red'@}, @{@}, @{'lion': 'orange'@})
@end example

@node Objetos Counter,Objetos deque,Objetos ChainMap,collections — Container datatypes
@anchor{library/collections counter-objects}@anchor{2502}
@subsubsection Objetos @code{Counter}


Se proporciona una herramienta de contador para respaldar recuentos rápidos y convenientes. Por ejemplo:

@example
>>> # Tally occurrences of words in a list
>>> cnt = Counter()
>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
...     cnt[word] += 1
...
>>> cnt
Counter(@{'blue': 3, 'red': 2, 'green': 1@})

>>> # Find the ten most common words in Hamlet
>>> import re
>>> words = re.findall(r'\w+', open('hamlet.txt').read().lower())
>>> Counter(words).most_common(10)
[('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631),
 ('you', 554),  ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)]
@end example

@geindex Counter (clase en collections)
@anchor{library/collections collections Counter}@anchor{110e}
@deffn {Clase} collections.Counter ([iterable-or-mapping])

Una clase @ref{110e,,Counter} es una subclase @ref{190,,dict} para contar objetos @ref{6b1,,hashable}. Es una colección donde los elementos se almacenan como claves de diccionario y sus conteos se almacenan como valores de diccionario. Se permite que los conteos sean cualquier valor entero, incluidos los conteos de cero o negativos. La clase @ref{110e,,Counter} es similar a los `bags' o multiconjuntos en otros idiomas.

Los elementos se cuentan desde un `iterable' o se inicializan desde otro `mapeo' (o contador):

@example
>>> c = Counter()                           # a new, empty counter
>>> c = Counter('gallahad')                 # a new counter from an iterable
>>> c = Counter(@{'red': 4, 'blue': 2@})      # a new counter from a mapping
>>> c = Counter(cats=4, dogs=8)             # a new counter from keyword args
@end example

Los objetos Counter tienen una interfaz de diccionario, excepto que retornan un conteo de cero para los elementos faltantes en lugar de levantar una @ref{438,,KeyError}:

@example
>>> c = Counter(['eggs', 'ham'])
>>> c['bacon']                              # count of a missing element is zero
0
@end example

Establecer un conteo en cero no elimina un elemento de un contador. Utilice @code{del} para eliminarlo por completo:

@example
>>> c['sausage'] = 0                        # counter entry with a zero count
>>> del c['sausage']                        # del actually removes the entry
@end example


Added in version 3.1.



Distinto en la versión 3.7: Como subclase de @ref{190,,dict} , @ref{110e,,Counter} heredó la capacidad de recordar el orden de inserción. Las operaciones matemáticas en objetos `Counter' también preservan el orden. Los resultados se ordenan en función de cuándo se encuentra un elemento por primera vez en el operando izquierdo y, a continuación, por el orden en que se encuentra en el operando derecho.


Los objetos Counter admiten métodos adicionales a los disponibles para todos los diccionarios:

@geindex elements() (método de collections.Counter)
@anchor{library/collections collections Counter elements}@anchor{136b}
@deffn {Método} elements ()

Retorna un iterador sobre los elementos que se repiten tantas veces como su conteo. Los elementos se retornan en el orden en que se encontraron por primera vez. Si el conteo de un elemento es menor que uno, @ref{136b,,elements()} lo ignorará.

@example
>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> sorted(c.elements())
['a', 'a', 'a', 'a', 'b', 'b']
@end example
@end deffn

@geindex most_common() (método de collections.Counter)
@anchor{library/collections collections Counter most_common}@anchor{136a}
@deffn {Método} most_common ([n])

Retorna una lista de los `n' elementos mas comunes y sus conteos, del mas común al menos común. Si se omite `n' o @code{None}, @ref{136a,,most_common()} retorna `todos' los elementos del contador. Los elementos con conteos iguales se ordenan en el orden en que se encontraron por primera vez:

@example
>>> Counter('abracadabra').most_common(3)
[('a', 5), ('b', 2), ('r', 2)]
@end example
@end deffn

@geindex subtract() (método de collections.Counter)
@anchor{library/collections collections Counter subtract}@anchor{124b}
@deffn {Método} subtract ([iterable-or-mapping])

Los elementos se restan de un `iterable' o de otro `mapeo' (o contador). Como @ref{14a2,,dict.update()} pero resta los conteos en lugar de reemplazarlos. Tanto las entradas como las salidas pueden ser cero o negativas.

@example
>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> d = Counter(a=1, b=2, c=3, d=4)
>>> c.subtract(d)
>>> c
Counter(@{'a': 3, 'b': 0, 'c': -3, 'd': -6@})
@end example


Added in version 3.2.

@end deffn

@geindex total() (método de collections.Counter)
@anchor{library/collections collections Counter total}@anchor{2503}
@deffn {Método} total ()

Computa la suma de las cuentas.

@example
>>> c = Counter(a=10, b=5, c=0)
>>> c.total()
15
@end example


Added in version 3.10.

@end deffn

Los métodos de diccionario habituales están disponibles para objetos @ref{110e,,Counter} excepto dos que funcionan de manera diferente para los contadores.

@geindex fromkeys() (método de collections.Counter)
@anchor{library/collections collections Counter fromkeys}@anchor{2504}
@deffn {Método} fromkeys (iterable)

Este método de clase no está implementado para objetos @ref{110e,,Counter} .
@end deffn

@geindex update() (método de collections.Counter)
@anchor{library/collections collections Counter update}@anchor{2505}
@deffn {Método} update ([iterable-or-mapping])

Los elementos se cuentan desde un `iterable' o agregados desde otro `mapeo' (o contador). Como @ref{14a2,,dict.update()} pero agrega conteos en lugar de reemplazarlos. Además, se espera que el `iterable' sea una secuencia de elementos, no una secuencia de parejas @code{(clave, valor)} .
@end deffn
@end deffn

Los contadores admiten operadores de comparación ricos para las relaciones de igualdad, subconjunto, y superconjunto: @code{==}, @code{!=}, @code{<}, @code{<=}, @code{>}, @code{>=}. Todas esas pruebas tratan los elementos faltantes como si tuvieran cero recuentos, por lo que @code{Counter(a=1) == Counter(a=1, b=0)} retorne verdadero.


Distinto en la versión 3.10: Se han añadido operaciones de comparación enriquecidas.



Distinto en la versión 3.10: En pruebas de igualdad, los elementos faltantes son tratados como si tuvieran cero recuentos. Anteriormente, @code{Counter(a=3)} y @code{Counter(a=3, b=0)} se consideraban distintos.


Patrones comunes para trabajar con objetos @ref{110e,,Counter}:

@example
c.total()                       # total of all counts
c.clear()                       # reset all counts
list(c)                         # list unique elements
set(c)                          # convert to a set
dict(c)                         # convert to a regular dictionary
c.items()                       # access the (elem, cnt) pairs
Counter(dict(list_of_pairs))    # convert from a list of (elem, cnt) pairs
c.most_common()[:-n-1:-1]       # n least common elements
+c                              # remove zero and negative counts
@end example

Existen varias operaciones matemáticas que permiten combinar objetos @ref{110e,,Counter} para producir conjuntos múltiples (contadores con recuentos superiores a cero). La suma y la resta combinan contadores sumando o restando los recuentos de los elementos correspondientes.  La intersección y la unión retornan el mínimo y el máximo de los recuentos correspondientes.  La igualdad y la inclusión comparan los recuentos correspondientes.  Cada operación puede aceptar entradas con recuentos con signo, pero la salida excluirá los resultados con recuentos iguales o inferiores a cero.

@example
>>> c = Counter(a=3, b=1)
>>> d = Counter(a=1, b=2)
>>> c + d                       # add two counters together:  c[x] + d[x]
Counter(@{'a': 4, 'b': 3@})
>>> c - d                       # subtract (keeping only positive counts)
Counter(@{'a': 2@})
>>> c & d                       # intersection:  min(c[x], d[x])
Counter(@{'a': 1, 'b': 1@})
>>> c | d                       # union:  max(c[x], d[x])
Counter(@{'a': 3, 'b': 2@})
>>> c == d                      # equality:  c[x] == d[x]
False
>>> c <= d                      # inclusion:  c[x] <= d[x]
False
@end example

La suma y resta unaria son atajos para agregar un contador vacío o restar de un contador vacío.

@example
>>> c = Counter(a=2, b=-4)
>>> +c
Counter(@{'a': 2@})
>>> -c
Counter(@{'b': 4@})
@end example


Added in version 3.3: Se agregó soporte para operaciones unarias de adición, resta y multiconjunto en su lugar (`in-place').


@cartouche
@quotation Nota 
Los Counters se diseñaron principalmente para trabajar con números enteros positivos para representar conteos continuos; sin embargo, se tuvo cuidado de no excluir innecesariamente los casos de uso que necesitan otros tipos o valores negativos. Para ayudar con esos casos de uso, esta sección documenta el rango mínimo y las restricciones de tipo.


@itemize *

@item 
La clase @ref{110e,,Counter} en sí misma es una subclase de diccionario sin restricciones en sus claves y valores. Los valores están pensados para ser números que representan conteos, pero `podría' almacenar cualquier cosa en el campo de valor.

@item 
El método @ref{136a,,most_common()} solo requiere que los valores se puedan ordenar.

@item 
Para operaciones en su lugar (`in-place') como @code{c[key] += 1}, el tipo de valor solo necesita admitir la suma y la resta. Por lo tanto, las fracciones, flotantes y decimales funcionarían y se admiten valores negativos. Lo mismo ocurre con @ref{2505,,update()} y @ref{124b,,subtract()} que permiten valores negativos y cero para las entradas y salidas.

@item 
Los métodos de multiconjuntos están diseñados solo para casos de uso con valores positivos. Las entradas pueden ser negativas o cero, pero solo se crean salidas con valores positivos. No hay restricciones de tipo, pero el tipo de valor debe admitir la suma, la resta y la comparación.

@item 
El método @ref{136b,,elements()} requiere conteos enteros. Ignora los conteos de cero y negativos.
@end itemize
@end quotation
@end cartouche


@subsubheading Ver también



@itemize *

@item 
Clase Bag@footnote{https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html} en Smalltalk.

@item 
Entrada de Wikipedia para Multiconjuntos@footnote{https://es.wikipedia.org/wiki/Multiconjunto}.

@item 
Tutorial de multiconjuntos de C++@footnote{http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm} con ejemplos.

@item 
Para operaciones matemáticas en multiconjuntos y sus casos de uso, consulte `Knuth, Donald. The Art of Computer Programming Volume II, Sección 4.6.3, Ejercicio 19'.

@item 
Para enumerar todos los distintos multiconjuntos de un tamaño dado sobre un conjunto dado de elementos, consulte @ref{12ee,,itertools.combinations_with_replacement()}:

@example
map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC
@end example
@end itemize


@node Objetos deque,Objetos defaultdict,Objetos Counter,collections — Container datatypes
@anchor{library/collections deque-objects}@anchor{2506}
@subsubsection Objetos @code{deque}


@geindex deque (clase en collections)
@anchor{library/collections collections deque}@anchor{67d}
@deffn {Clase} collections.deque ([iterable[, maxlen]])

Retorna un nuevo objeto deque inicializado de izquierda a derecha (usando @ref{2507,,append()}) con datos de `iterable'. Si no se especifica `iterable', el nuevo deque estará vacío.

Deques are a generalization of stacks and queues (the name is pronounced «deck»
and is short for «double-ended queue»).  Deques support thread-safe, memory
efficient appends and pops from either side of the deque with approximately the
same `O'(1) performance in either direction.

Though @ref{18e,,list} objects support similar operations, they are optimized for
fast fixed-length operations and incur `O'(`n') memory movement costs for
@code{pop(0)} and @code{insert(0, v)} operations which change both the size and
position of the underlying data representation.

Si no se especifica `maxlen' o es @code{None}, los deques pueden crecer hasta una longitud arbitraria. De lo contrario, el deque está limitado a la longitud máxima especificada. Una vez que un deque de longitud limitada esta lleno, cuando se agregan nuevos elementos, se descarta el número correspondiente de elementos del extremo opuesto. Los deques de longitud limitada proporcionan una funcionalidad similar al filtro @code{tail} en Unix. También son útiles para rastrear transacciones y otros grupos de datos donde solo la actividad más reciente es de interés.

Los objetos deque admiten los siguientes métodos:

@geindex append() (método de collections.deque)
@anchor{library/collections collections deque append}@anchor{2507}
@deffn {Método} append (x)

Agregue `x' al lado derecho del deque.
@end deffn

@geindex appendleft() (método de collections.deque)
@anchor{library/collections collections deque appendleft}@anchor{2508}
@deffn {Método} appendleft (x)

Agregue `x' al lado izquierdo del deque.
@end deffn

@geindex clear() (método de collections.deque)
@anchor{library/collections collections deque clear}@anchor{2509}
@deffn {Método} clear ()

Retire todos los elementos del deque dejándolo con longitud 0.
@end deffn

@geindex copy() (método de collections.deque)
@anchor{library/collections collections deque copy}@anchor{e59}
@deffn {Método} copy ()

Crea una copia superficial del deque.


Added in version 3.5.

@end deffn

@geindex count() (método de collections.deque)
@anchor{library/collections collections deque count}@anchor{124d}
@deffn {Método} count (x)

Cuente el número de elementos deque igual a `x'.


Added in version 3.2.

@end deffn

@geindex extend() (método de collections.deque)
@anchor{library/collections collections deque extend}@anchor{250a}
@deffn {Método} extend (iterable)

Extienda el lado derecho del deque agregando elementos del argumento iterable.
@end deffn

@geindex extendleft() (método de collections.deque)
@anchor{library/collections collections deque extendleft}@anchor{250b}
@deffn {Método} extendleft (iterable)

Extienda el lado izquierdo del deque agregando elementos de `iterable'. Tenga en cuenta que la serie de appends a la izquierda da como resultado la inversión del orden de los elementos en el argumento iterable.
@end deffn

@geindex index() (método de collections.deque)
@anchor{library/collections collections deque index}@anchor{e57}
@deffn {Método} index (x[, start[, stop]])

Retorna la posición de `x' en el deque (en o después del índice `start' y antes del índice `stop'). Retorna la primera coincidencia o lanza @ref{360,,ValueError} si no se encuentra.


Added in version 3.5.

@end deffn

@geindex insert() (método de collections.deque)
@anchor{library/collections collections deque insert}@anchor{e58}
@deffn {Método} insert (i, x)

Ingrese `x' en el dique en la posición `i'.

Si la inserción causara que un deque limitado crezca más allá de `maxlen', se lanza un @ref{1575,,IndexError}.


Added in version 3.5.

@end deffn

@geindex pop() (método de collections.deque)
@anchor{library/collections collections deque pop}@anchor{250c}
@deffn {Método} pop ()

Elimina y retorna un elemento del lado derecho del deque. Si no hay elementos presentes, lanza un @ref{1575,,IndexError}.
@end deffn

@geindex popleft() (método de collections.deque)
@anchor{library/collections collections deque popleft}@anchor{250d}
@deffn {Método} popleft ()

Elimina y retorna un elemento del lado izquierdo del deque. Si no hay elementos presentes, lanza un @ref{1575,,IndexError}.
@end deffn

@geindex remove() (método de collections.deque)
@anchor{library/collections collections deque remove}@anchor{1914}
@deffn {Método} remove (value)

Elimina la primera aparición de `value'. Si no se encuentra, lanza un @ref{360,,ValueError}.
@end deffn

@geindex reverse() (método de collections.deque)
@anchor{library/collections collections deque reverse}@anchor{124e}
@deffn {Método} reverse ()

Invierte los elementos del deque en su lugar (`in-place') y luego retorna @code{None}.


Added in version 3.2.

@end deffn

@geindex rotate() (método de collections.deque)
@anchor{library/collections collections deque rotate}@anchor{18df}
@deffn {Método} rotate (n=1)

Gira el deque `n' pasos a la derecha. Si `n' es negativo, lo gira hacia la izquierda.

Cuando el deque no está vacío, girar un paso hacia la derecha equivale a @code{d.appendleft(d.pop())}, y girar un paso hacia la izquierda equivale a @code{d.append(d.popleft())}.
@end deffn

Los objetos deque también proporcionan un atributo de solo lectura:

@geindex maxlen (atributo de collections.deque)
@anchor{library/collections collections deque maxlen}@anchor{136c}
@deffn {Atributo} maxlen

Tamaño máximo de un deque o @code{None} si no está limitado.


Added in version 3.1.

@end deffn
@end deffn

In addition to the above, deques support iteration, pickling, @code{len(d)},
@code{reversed(d)}, @code{copy.copy(d)}, @code{copy.deepcopy(d)}, membership testing with
the @ref{1ed,,in} operator, and subscript references such as @code{d[0]} to access
the first element.  Indexed access is `O'(1) at both ends but slows to `O'(`n') in
the middle.  For fast random access, use lists instead.

A partir de la versión 3.5, los deques admiten @code{__add__()}, @code{__mul__()}, y @code{__imul__()}.

Ejemplo:

@example
>>> from collections import deque
>>> d = deque('ghi')                 # make a new deque with three items
>>> for elem in d:                   # iterate over the deque's elements
...     print(elem.upper())
G
H
I

>>> d.append('j')                    # add a new entry to the right side
>>> d.appendleft('f')                # add a new entry to the left side
>>> d                                # show the representation of the deque
deque(['f', 'g', 'h', 'i', 'j'])

>>> d.pop()                          # return and remove the rightmost item
'j'
>>> d.popleft()                      # return and remove the leftmost item
'f'
>>> list(d)                          # list the contents of the deque
['g', 'h', 'i']
>>> d[0]                             # peek at leftmost item
'g'
>>> d[-1]                            # peek at rightmost item
'i'

>>> list(reversed(d))                # list the contents of a deque in reverse
['i', 'h', 'g']
>>> 'h' in d                         # search the deque
True
>>> d.extend('jkl')                  # add multiple elements at once
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> d.rotate(1)                      # right rotation
>>> d
deque(['l', 'g', 'h', 'i', 'j', 'k'])
>>> d.rotate(-1)                     # left rotation
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])

>>> deque(reversed(d))               # make a new deque in reverse order
deque(['l', 'k', 'j', 'i', 'h', 'g'])
>>> d.clear()                        # empty the deque
>>> d.pop()                          # cannot pop from an empty deque
Traceback (most recent call last):
    File "<pyshell#6>", line 1, in -toplevel-
        d.pop()
IndexError: pop from an empty deque

>>> d.extendleft('abc')              # extendleft() reverses the input order
>>> d
deque(['c', 'b', 'a'])
@end example

@menu
* Recetas deque:: 

@end menu

@node Recetas deque,,,Objetos deque
@anchor{library/collections deque-recipes}@anchor{250e}
@subsubsection Recetas @code{deque}


Esta sección muestra varios enfoques para trabajar con deques.

Los deques de longitud limitada proporcionan una funcionalidad similar al filtro @code{tail} en Unix:

@example
def tail(filename, n=10):
    'Return the last n lines of a file'
    with open(filename) as f:
        return deque(f, n)
@end example

Otro enfoque para usar deques es mantener una secuencia de elementos agregados recientemente haciendo appending a la derecha y popping a la izquierda:

@example
def moving_average(iterable, n=3):
    # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0
    # https://en.wikipedia.org/wiki/Moving_average
    it = iter(iterable)
    d = deque(itertools.islice(it, n-1))
    d.appendleft(0)
    s = sum(d)
    for elem in it:
        s += elem - d.popleft()
        d.append(elem)
        yield s / n
@end example

Un scheduler round-robin@footnote{https://en.wikipedia.org/wiki/Round-robin_scheduling} se puede implementar con iteradores de entrada almacenados en @ref{67d,,deque}. Los valores son producidos del iterador activo en la posición cero. Si ese iterador está agotado, se puede eliminar con @ref{250d,,popleft()}; de lo contrario, se puede volver en ciclos al final con el método @ref{18df,,rotate()}

@example
def roundrobin(*iterables):
    "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
    iterators = deque(map(iter, iterables))
    while iterators:
        try:
            while True:
                yield next(iterators[0])
                iterators.rotate(-1)
        except StopIteration:
            # Remove an exhausted iterator.
            iterators.popleft()
@end example

El método @ref{18df,,rotate()} proporciona una forma de implementar eliminación y rebanado de @ref{67d,,deque}. Por ejemplo, una implementación pura de Python de @code{del d[n]} se basa en el método @code{rotate()} para colocar los elementos que se van a extraer:

@example
def delete_nth(d, n):
    d.rotate(-n)
    d.popleft()
    d.rotate(n)
@end example

Para implementar el rebanado de un @ref{67d,,deque}, use un enfoque similar aplicando @ref{18df,,rotate()} para traer un elemento objetivo al lado izquierdo del deque. Elimine las entradas antiguas con @ref{250d,,popleft()}, agregue nuevas entradas con @ref{250a,,extend()}, y luego invierta la rotación. Con variaciones menores en ese enfoque, es fácil implementar manipulaciones de pila de estilo hacia adelante como @code{dup}, @code{drop}, @code{swap}, @code{over}, @code{pick}, @code{rot}, y @code{roll}.

@node Objetos defaultdict,namedtuple Funciones Factory para Tuplas y Campos con Nombres,Objetos deque,collections — Container datatypes
@anchor{library/collections defaultdict-objects}@anchor{250f}
@subsubsection Objetos @code{defaultdict}


@geindex defaultdict (clase en collections)
@anchor{library/collections collections defaultdict}@anchor{122a}
@deffn {Clase} collections.defaultdict (default_factory=None, /[, ...])

Retorna un nuevo objeto similar a un diccionario. @ref{122a,,defaultdict} es una subclase de la clase incorporada @ref{190,,dict}.  Anula un método y agrega una variable de instancia de escritura.  La funcionalidad restante es la misma que para la clase @ref{190,,dict} y no está documentada aquí.

El primer argumento proporciona el valor inicial para el atributo @ref{2510,,default_factory}; por defecto es @code{None}. Todos los argumentos restantes se tratan de la misma forma que si se pasaran al constructor @ref{190,,dict}, incluidos los argumentos de palabras clave.

Los objetos @ref{122a,,defaultdict} admiten el siguiente método además de las operaciones estándar de @ref{190,,dict}:

@geindex __missing__() (método de collections.defaultdict)
@anchor{library/collections collections defaultdict __missing__}@anchor{2511}
@deffn {Método} __missing__ (key)

Si el atributo @ref{2510,,default_factory} es @code{None}, lanza una excepción @ref{438,,KeyError} con la `key' como argumento.

Si @ref{2510,,default_factory} no es @code{None}, se llama sin argumentos para proporcionar un valor predeterminado para la `key' dada, este valor se inserta en el diccionario para la `key' y se retorna.

Si llamar a @ref{2510,,default_factory} lanza una excepción, esta excepción se propaga sin cambios.

This method is called by the @ref{3d8,,__getitem__()} method of the
@ref{190,,dict} class when the requested key is not found; whatever it
returns or raises is then returned or raised by @ref{3d8,,__getitem__()}.

Note that @ref{2511,,__missing__()} is `not' called for any operations besides
@ref{3d8,,__getitem__()}. This means that @code{get()} will, like normal
dictionaries, return @code{None} as a default rather than using
@ref{2510,,default_factory}.
@end deffn

los objetos @ref{122a,,defaultdict} admiten la siguiente variable de instancia:

@geindex default_factory (atributo de collections.defaultdict)
@anchor{library/collections collections defaultdict default_factory}@anchor{2510}
@deffn {Atributo} default_factory

Este atributo es utilizado por el método @ref{2511,,__missing__()} ; se inicializa desde el primer argumento al constructor, si está presente, o en @code{None}, si está ausente.
@end deffn


Distinto en la versión 3.9: Se agregaron los operadores unir (@code{|}) y actualizar (@code{|=}), especificados en 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

@menu
* Ejemplos defaultdict:: 

@end menu

@node Ejemplos defaultdict,,,Objetos defaultdict
@anchor{library/collections defaultdict-examples}@anchor{2512}
@subsubsection Ejemplos @code{defaultdict}


Usando @ref{18e,,list} como @ref{2510,,default_factory}, es fácil agrupar una secuencia de pares clave-valor en un diccionario de listas:

@example
>>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
>>> d = defaultdict(list)
>>> for k, v in s:
...     d[k].append(v)
...
>>> sorted(d.items())
[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
@end example

Cuando se encuentra cada clave por primera vez, no está ya en el mapping; por lo que una entrada se crea automáticamente usando la función @ref{2510,,default_factory} que retorna una @ref{18e,,list} vacía. La operación @code{list.append()} luego adjunta el valor a la nueva lista. Cuando se vuelven a encontrar claves, la búsqueda procede normalmente (retornando la lista para esa clave) y la operación @code{list.append()} agrega otro valor a la lista. Esta técnica es más simple y rápida que una técnica equivalente usando @ref{10f5,,dict.setdefault()}:

@example
>>> d = @{@}
>>> for k, v in s:
...     d.setdefault(k, []).append(v)
...
>>> sorted(d.items())
[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
@end example

Establecer @ref{2510,,default_factory} en @ref{1f0,,int} hace que @ref{122a,,defaultdict} sea útil para contar (como un bag o multiconjunto en otros idiomas):

@example
>>> s = 'mississippi'
>>> d = defaultdict(int)
>>> for k in s:
...     d[k] += 1
...
>>> sorted(d.items())
[('i', 4), ('m', 1), ('p', 2), ('s', 4)]
@end example

Cuando se encuentra una letra por primera vez, falta en el mapping, por lo que la función @ref{2510,,default_factory} llama a @ref{1f0,,int()} para proporcionar una cuenta predeterminada de cero. La operación de incremento luego acumula el conteo de cada letra.

La función @ref{1f0,,int()} que siempre retorna cero es solo un caso especial de funciones constantes. Una forma más rápida y flexible de crear funciones constantes es utilizar una función lambda que pueda proporcionar cualquier valor constante (no solo cero):

@example
>>> def constant_factory(value):
...     return lambda: value
...
>>> d = defaultdict(constant_factory('<missing>'))
>>> d.update(name='John', action='ran')
>>> '%(name)s %(action)s to %(object)s' % d
'John ran to <missing>'
@end example

Establecer @ref{2510,,default_factory} en @ref{67a,,set} hace que @ref{122a,,defaultdict} sea útil para construir un diccionario de conjuntos:

@example
>>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)]
>>> d = defaultdict(set)
>>> for k, v in s:
...     d[k].add(v)
...
>>> sorted(d.items())
[('blue', @{2, 4@}), ('red', @{1, 3@})]
@end example

@node namedtuple Funciones Factory para Tuplas y Campos con Nombres,Objetos OrderedDict,Objetos defaultdict,collections — Container datatypes
@anchor{library/collections namedtuple-factory-function-for-tuples-with-named-fields}@anchor{2513}
@subsubsection @code{namedtuple()} Funciones `Factory' para Tuplas y Campos con Nombres


Las tuplas con nombre asignan significado a cada posición en una tupla y permiten un código más legible y autodocumentado. Se pueden usar donde se usen tuplas regulares y agregan la capacidad de acceder a los campos por nombre en lugar del índice de posición.

@geindex namedtuple() (en el módulo collections)
@anchor{library/collections collections namedtuple}@anchor{32d}
@deffn {Función} collections.namedtuple (typename, field_names, *, rename=False, defaults=None, module=None)

Retorna una nueva subclase de tupla llamada `typename'. La nueva subclase se utiliza para crear objetos tipo tupla que tienen campos accesibles mediante búsqueda de atributos, además de ser indexables e iterables. Las instancias de la subclase también tienen un docstring útil (con typename y field_names) y un método útil @code{__repr__()} que lista el contenido de la tupla en un formato de @code{nombre=valor}.

Los `nombres de campo' son una secuencia de cadenas como @code{[‘x’, ‘y’]}. Alternativamente, `nombres de campo' puede ser una sola cadena con cada nombre de campo separado por espacios en blanco y/o comas, por ejemplo @code{’x y’} or @code{’x, y’}.

Se puede usar cualquier identificador de Python válido para un `fieldname', excepto para los nombres que comienzan con un guión bajo. Los identificadores válidos constan de letras, dígitos y guiones bajos, pero no comienzan con un dígito o guion bajo y no pueden ser @ref{84,,keyword} como `class', `for', `return', `global', `pass', o `raise'.

Si `rename' es verdadero, los nombres de campo no válidos se reemplazan automáticamente con nombres posicionales. Por ejemplo, @code{[‘abc’, ‘def’, ‘ghi’, ‘abc’]} se convierte en @code{[‘abc’, ‘_1’, ‘ghi’, ‘_3’]}, eliminando la palabra clave @code{def} y el nombre de campo duplicado @code{abc}.

`defaults' pueden ser @code{None} o un @ref{1294,,iterable} de los valores predeterminados. Dado que los campos con un valor predeterminado deben venir después de cualquier campo sin un valor predeterminado, los `defaults' se aplican a los parámetros situados más a la derecha. Por ejemplo, si los nombres de campo son @code{[‘x’, ‘y’, ‘z’]} y los valores predeterminados son @code{(1, 2)}, entonces @code{x} será un argumento obligatorio, @code{y} tendrá el valor predeterminado de @code{1}, y @code{z} el valor predeterminado de @code{2}.

If `module' is defined, the @ref{468,,__module__} attribute of the
named tuple is set to that value.

Las instancias de tuplas con nombre no tienen diccionarios por instancia, por lo que son livianas y no requieren más memoria que las tuplas normales.

Para admitir el serializado (`pickling'), la clase tupla con nombre debe asignarse a una variable que coincida con `typename'.


Distinto en la versión 3.1: Se agregó soporte para `rename'.



Distinto en la versión 3.6: Los parámetros `verbose' y `rename' se convirtieron en @ref{3f4,,argumentos de solo palabra clave}.



Distinto en la versión 3.6: Se agregó el parámetro `module'.



Distinto en la versión 3.7: Se eliminaron el parámetro `verbose' y el atributo @code{_source}.



Distinto en la versión 3.7: Se agregaron el parámetro `defaults' y él atributo @code{_field_defaults}.

@end deffn

@example
>>> # Basic example
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
>>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
33
>>> x, y = p                # unpack like a regular tuple
>>> x, y
(11, 22)
>>> p.x + p.y               # fields also accessible by name
33
>>> p                       # readable __repr__ with a name=value style
Point(x=11, y=22)
@end example

Las tuplas con nombre son especialmente útiles para asignar nombres de campo a las tuplas de resultado retornadas por los módulos @ref{2a,,csv} o @ref{cf,,sqlite3}:

@example
EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')

import csv
for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
    print(emp.name, emp.title)

import sqlite3
conn = sqlite3.connect('/companydata')
cursor = conn.cursor()
cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
for emp in map(EmployeeRecord._make, cursor.fetchall()):
    print(emp.name, emp.title)
@end example

Además de los métodos heredados de las tuplas, las tuplas con nombre admiten tres métodos adicionales y dos atributos. Para evitar conflictos con los nombres de campo, los nombres de método y atributo comienzan con un guión bajo.

@geindex _make() (método de clase de collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _make}@anchor{2514}
@deffn {Método} classmethod somenamedtuple._make (iterable)

Método de clase que crea una nueva instancia a partir de una secuencia existente o iterable.

@example
>>> t = [11, 22]
>>> Point._make(t)
Point(x=11, y=22)
@end example
@end deffn

@geindex _asdict() (método de collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _asdict}@anchor{a73}
@deffn {Método} somenamedtuple._asdict ()

Retorna un nuevo @ref{190,,dict} que asigna los nombres de los campos a sus valores correspondientes:

@example
>>> p = Point(x=11, y=22)
>>> p._asdict()
@{'x': 11, 'y': 22@}
@end example


Distinto en la versión 3.1: Retorna un @ref{67c,,OrderedDict} en lugar de un @ref{190,,dict} regular.



Distinto en la versión 3.8: Retorna un @ref{190,,dict} normal en lugar de un @ref{67c,,OrderedDict}. A partir de Python 3.7, se garantiza el orden de los diccionarios normales. Si se requieren las características adicionales de @ref{67c,,OrderedDict} , la corrección sugerida es emitir el resultado al tipo deseado: @code{OrderedDict(nt._asdict())}.

@end deffn

@geindex _replace() (método de collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _replace}@anchor{2515}
@deffn {Método} somenamedtuple._replace (**kwargs)

Retorna una nueva instancia de la tupla nombrada reemplazando los campos especificados con nuevos valores:

@example
>>> p = Point(x=11, y=22)
>>> p._replace(x=33)
Point(x=33, y=22)

>>> for partnum, record in inventory.items():
...     inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
@end example

Named tuples are also supported by generic function @ref{15f,,copy.replace()}.


Distinto en la versión 3.13: Raise @ref{228,,TypeError} instead of @ref{360,,ValueError} for invalid
keyword arguments.

@end deffn

@geindex _fields (atributo de collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _fields}@anchor{2516}
@deffn {Atributo} somenamedtuple._fields

Tupla de cadenas que lista los nombres de los campos. Útil para la introspección y para crear nuevos tipos de tuplas con nombre a partir de tuplas con nombre existentes.

@example
>>> p._fields            # view the field names
('x', 'y')

>>> Color = namedtuple('Color', 'red green blue')
>>> Pixel = namedtuple('Pixel', Point._fields + Color._fields)
>>> Pixel(11, 22, 128, 255, 0)
Pixel(x=11, y=22, red=128, green=255, blue=0)
@end example
@end deffn

@geindex _field_defaults (atributo de collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _field_defaults}@anchor{2517}
@deffn {Atributo} somenamedtuple._field_defaults

Diccionario de nombres de campos mapeados a valores predeterminados.

@example
>>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
>>> Account._field_defaults
@{'balance': 0@}
>>> Account('premium')
Account(type='premium', balance=0)
@end example
@end deffn

Para recuperar un campo cuyo nombre está almacenado en una cadena, use la función @ref{c59,,getattr()}:

@example
>>> getattr(p, 'x')
11
@end example

Para convertir un diccionario en una tupla con nombre, use el operador de doble estrella (como se describe en @ref{1c36,,Desempaquetando una lista de argumentos}):

@example
>>> d = @{'x': 11, 'y': 22@}
>>> Point(**d)
Point(x=11, y=22)
@end example

Dado que una tupla con nombre es una clase Python normal, es fácil agregar o cambiar la funcionalidad con una subclase. A continuación, se explica cómo agregar un campo calculado y un formato de impresión de ancho fijo:

@example
>>> class Point(namedtuple('Point', ['x', 'y'])):
...     __slots__ = ()
...     @@property
...     def hypot(self):
...         return (self.x ** 2 + self.y ** 2) ** 0.5
...     def __str__(self):
...         return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)

>>> for p in Point(3, 4), Point(14, 5/7):
...     print(p)
Point: x= 3.000  y= 4.000  hypot= 5.000
Point: x=14.000  y= 0.714  hypot=14.018
@end example

La subclase que se muestra arriba establece @code{__slots__} a una tupla vacía. Esto ayuda a mantener bajos los requisitos de memoria al evitar la creación de diccionarios de instancia.

La subclasificación no es útil para agregar campos nuevos almacenados. En su lugar, simplemente cree un nuevo tipo de tupla con nombre a partir del atributo @ref{2516,,_fields}:

@example
>>> Point3D = namedtuple('Point3D', Point._fields + ('z',))
@end example

Los docstrings se pueden personalizar realizando asignaciones directas a los campos @code{__doc__} :

@example
>>> Book = namedtuple('Book', ['id', 'title', 'authors'])
>>> Book.__doc__ += ': Hardcover book in active collection'
>>> Book.id.__doc__ = '13-digit ISBN'
>>> Book.title.__doc__ = 'Title of first printing'
>>> Book.authors.__doc__ = 'List of authors sorted by last name'
@end example


Distinto en la versión 3.5: Los docstrings de propiedad se pueden escribir.



@subsubheading Ver también



@itemize *

@item 
Consulte @ref{1db,,typing.NamedTuple} para ver una forma de agregar sugerencias de tipo para tuplas con nombre. También proporciona una notación elegante usando la palabra clave @ref{133f,,class}:

@example
class Component(NamedTuple):
    part_number: int
    weight: float
    description: Optional[str] = None
@end example

@item 
Vea @ref{334,,types.SimpleNamespace()} para un espacio de nombres mutable basado en un diccionario subyacente en lugar de una tupla.

@item 
El módulo @ref{30,,dataclasses} proporciona un decorador y funciones para agregar automáticamente métodos especiales generados a clases definidas por el usuario.
@end itemize


@node Objetos OrderedDict,Objetos UserDict,namedtuple Funciones Factory para Tuplas y Campos con Nombres,collections — Container datatypes
@anchor{library/collections ordereddict-objects}@anchor{2518}
@subsubsection Objetos @code{OrderedDict}


Los diccionarios ordenados son como los diccionarios normales, pero tienen algunas capacidades adicionales relacionadas con las operaciones de ordenado. Se han vuelto menos importantes ahora que la clase incorporada @ref{190,,dict} ganó la capacidad de recordar el orden de inserción (este nuevo comportamiento quedó garantizado en Python 3.7).

Aún quedan algunas diferencias con @ref{190,,dict} :


@itemize *

@item 
El @ref{190,,dict} normal fue diseñado para ser muy bueno en operaciones de mapeo. El seguimiento del pedido de inserción era secundario.

@item 
La @ref{67c,,OrderedDict} fue diseñada para ser buena para reordenar operaciones. La eficiencia del espacio, la velocidad de iteración y el rendimiento de las operaciones de actualización fueron secundarios.

@item 
El algoritmo @ref{67c,,OrderedDict} puede manejar operaciones frecuentes de re-ordenamiento mejor que @ref{190,,dict}. Como se muestra en las recetas siguientes, esto lo vuelve adecuado para implementar varios tipos de caches LRU.

@item 
La operación de igualdad para @ref{67c,,OrderedDict} comprueba el orden coincidente.

Un @ref{190,,dict} regular puede emular la prueba de igualdad sensible al orden con @code{p == q and all(k1 == k2 for k1, k2 in zip(p, q))}.

@item 
El método @code{popitem()} de @ref{67c,,OrderedDict} tiene una firma diferente. Acepta un argumento opcional para especificar qué elemento es `popped'.

Un @ref{190,,dict} regular puede emular @code{od.popitem(last=True)} de OrderedDict con @code{d.popitem()} que se garantiza que salte el elemento situado más a la derecha (el último).

Un @ref{190,,dict} regular puede emular @code{od.popitem(last=False)} de OrderedDict con @code{(k := next(iter(d)), d.pop(k))} que retornará y eliminará el elemento situado más a la izquierda (el primero) si existe.

@item 
@ref{67c,,OrderedDict} tiene un método @code{move_to_end()} para reposiciones eficientemente un elemento a un punto final.

Un @ref{190,,dict} regular puede emular @code{od.move_to_end(k, last=True)} de OrderedDict con @code{d[k] = d.pop(k)} que desplazará la clave y su valor asociado a la posición más a la derecha (última).

Un @ref{190,,dict} regular no tiene un equivalente eficiente para @code{od.move_to_end(k, last=False)} de OrderedDict que desplaza la clave y su valor asociado a la posición más a la izquierda (primera).

@item 
Hasta Python 3.8, @ref{190,,dict} carecía de un método @code{__reversed__()}.
@end itemize

@geindex OrderedDict (clase en collections)
@anchor{library/collections collections OrderedDict}@anchor{67c}
@deffn {Clase} collections.OrderedDict ([items])

Retorna una instancia de una subclase @ref{190,,dict} que tiene métodos especializados para reorganizar el orden del diccionario.


Added in version 3.1.


@geindex popitem() (método de collections.OrderedDict)
@anchor{library/collections collections OrderedDict popitem}@anchor{1354}
@deffn {Método} popitem (last=True)

El método @ref{1354,,popitem()} para diccionarios ordenados retorna y elimina un par (clave, valor). Los pares se retornan en orden @abbr{LIFO} si el `último' es verdadero o en orden @abbr{FIFO,first-in@comma{} first-out} si es falso.
@end deffn

@geindex move_to_end() (método de collections.OrderedDict)
@anchor{library/collections collections OrderedDict move_to_end}@anchor{124c}
@deffn {Método} move_to_end (key, last=True)

Mueve una `clave' existente a cualquiera de los extremos de un diccionario ordenado.  El elemento se mueve al extremo derecho si `last' es verdadero (por defecto) o al principio si `last' es falso.  Lanza @ref{438,,KeyError} si la `clave' no existe:

@example
>>> d = OrderedDict.fromkeys('abcde')
>>> d.move_to_end('b')
>>> '@w{'}.join(d)
'acdeb'
>>> d.move_to_end('b', last=False)
>>> '@w{'}.join(d)
'bacde'
@end example


Added in version 3.2.

@end deffn
@end deffn

Además de los métodos de mapeo habituales, los diccionarios ordenados también admiten la iteración inversa usando @ref{8fc,,reversed()}.
@anchor{library/collections collections-ordereddict-eq}@anchor{15e2}
Equality tests between @ref{67c,,OrderedDict} objects are order-sensitive
and are roughly equivalent to @code{list(od1.items())==list(od2.items())}.

Equality tests between @ref{67c,,OrderedDict} objects and other
@ref{961,,Mapping} objects are order-insensitive like regular
dictionaries.  This allows @ref{67c,,OrderedDict} objects to be substituted
anywhere a regular dictionary is used.


Distinto en la versión 3.5: Los elementos, claves y valores @ref{2519,,vistas} de @ref{67c,,OrderedDict} ahora admiten la iteración inversa usando @ref{8fc,,reversed()}.



Distinto en la versión 3.6: Con la aceptación de 
@geindex Python Enhancement Proposals; PEP 468
PEP 468@footnote{https://peps.python.org/pep-0468/}, el orden se mantiene para los argumentos de palabras clave pasados al constructor @ref{67c,,OrderedDict} y su método @code{update()}.



Distinto en la versión 3.9: Se agregaron los operadores unir (@code{|}) y actualizar (@code{|=}), especificados en 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.


@menu
* Ejemplos y recetas OrderedDict:: 

@end menu

@node Ejemplos y recetas OrderedDict,,,Objetos OrderedDict
@anchor{library/collections ordereddict-examples-and-recipes}@anchor{251a}
@subsubsection Ejemplos y recetas @code{OrderedDict}


Es sencillo crear una variante de diccionario ordenado que recuerde el orden en que las claves se insertaron por `última vez'. Si una nueva entrada sobrescribe una entrada existente, la posición de inserción original se cambia y se mueve al final:

@example
class LastUpdatedOrderedDict(OrderedDict):
    'Store items in the order the keys were last added'

    def __setitem__(self, key, value):
        super().__setitem__(key, value)
        self.move_to_end(key)
@end example

Un @ref{67c,,OrderedDict} también sería útil para implementar variantes de @ref{a81,,functools.lru_cache()}:

@example
from collections import OrderedDict
from time import time

class TimeBoundedLRU:
    "LRU Cache that invalidates and refreshes old entries."

    def __init__(self, func, maxsize=128, maxage=30):
        self.cache = OrderedDict()      # @{ args : (timestamp, result)@}
        self.func = func
        self.maxsize = maxsize
        self.maxage = maxage

    def __call__(self, *args):
        if args in self.cache:
            self.cache.move_to_end(args)
            timestamp, result = self.cache[args]
            if time() - timestamp <= self.maxage:
                return result
        result = self.func(*args)
        self.cache[args] = time(), result
        if len(self.cache) > self.maxsize:
            self.cache.popitem(last=False)
        return result
@end example

@example
class MultiHitLRUCache:
    """ LRU cache that defers caching a result until
        it has been requested multiple times.

        To avoid flushing the LRU cache with one-time requests,
        we don't cache until a request has been made more than once.

    """

    def __init__(self, func, maxsize=128, maxrequests=4096, cache_after=1):
        self.requests = OrderedDict()   # @{ uncached_key : request_count @}
        self.cache = OrderedDict()      # @{ cached_key : function_result @}
        self.func = func
        self.maxrequests = maxrequests  # max number of uncached requests
        self.maxsize = maxsize          # max number of stored return values
        self.cache_after = cache_after

    def __call__(self, *args):
        if args in self.cache:
            self.cache.move_to_end(args)
            return self.cache[args]
        result = self.func(*args)
        self.requests[args] = self.requests.get(args, 0) + 1
        if self.requests[args] <= self.cache_after:
            self.requests.move_to_end(args)
            if len(self.requests) > self.maxrequests:
                self.requests.popitem(last=False)
        else:
            self.requests.pop(args, None)
            self.cache[args] = result
            if len(self.cache) > self.maxsize:
                self.cache.popitem(last=False)
        return result
@end example

@c >>> def square(x):
@c ...     return x * x
@c ...
@c >>> f = MultiHitLRUCache(square, maxsize=4, maxrequests=6)
@c >>> list(map(f, range(10)))  # First requests, don't cache
@c [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@c >>> f(4)  # Cache the second request
@c 16
@c >>> f(6)  # Cache the second request
@c 36
@c >>> f(2)  # The first request aged out, so don't cache
@c 4
@c >>> f(6)  # Cache hit
@c 36
@c >>> f(4)  # Cache hit and move to front
@c 16
@c >>> list(f.cache.values())
@c [36, 16]
@c >>> set(f.requests).isdisjoint(f.cache)
@c True
@c >>> list(map(f, [9, 8, 7]))   # Cache these second requests
@c [81, 64, 49]
@c >>> list(map(f, [7, 9]))  # Cache hits
@c [49, 81]
@c >>> list(f.cache.values())
@c [16, 64, 49, 81]
@c >>> set(f.requests).isdisjoint(f.cache)
@c True

@node Objetos UserDict,Objetos UserList,Objetos OrderedDict,collections — Container datatypes
@anchor{library/collections userdict-objects}@anchor{251b}
@subsubsection Objetos @code{UserDict}


La clase, @ref{199d,,UserDict} actúa como un contenedor alrededor de los objetos del diccionario. La necesidad de esta clase ha sido parcialmente suplantada por la capacidad de crear subclases directamente desde @ref{190,,dict}; sin embargo, es más fácil trabajar con esta clase porque se puede acceder al diccionario subyacente como un atributo.

@geindex UserDict (clase en collections)
@anchor{library/collections collections UserDict}@anchor{199d}
@deffn {Clase} collections.UserDict ([initialdata])

Clase que simula un diccionario.  El contenido de la instancia se guarda en un diccionario normal, al que se puede acceder mediante el atributo @ref{251c,,data} de las instancias de @ref{199d,,UserDict}.  Si se proporciona `initialdata', @ref{251c,,data} se inicializa con su contenido; tenga en cuenta que no se mantendrá una referencia a `initialdata', lo que permite que se utilice para otros fines.

Además de admitir los métodos y operaciones de los mappings, las instancias @ref{199d,,UserDict} proporcionan el siguiente atributo:

@geindex data (atributo de collections.UserDict)
@anchor{library/collections collections UserDict data}@anchor{251c}
@deffn {Atributo} data

Un diccionario real utilizado para almacenar el contenido de la clase @ref{199d,,UserDict} .
@end deffn
@end deffn

@node Objetos UserList,Objetos UserString,Objetos UserDict,collections — Container datatypes
@anchor{library/collections userlist-objects}@anchor{251d}
@subsubsection Objetos @code{UserList}


Esta clase actúa como un contenedor alrededor de los objetos de lista. Es una clase base útil para tus propias clases tipo lista que pueden heredar de ellas y anular métodos existentes o agregar nuevos. De esta forma, se pueden agregar nuevos comportamientos a las listas.

La necesidad de esta clase ha sido parcialmente suplantada por la capacidad de crear subclases directamente desde @ref{18e,,list}; sin embargo, es más fácil trabajar con esta clase porque se puede acceder a la lista subyacente como atributo.

@geindex UserList (clase en collections)
@anchor{library/collections collections UserList}@anchor{1523}
@deffn {Clase} collections.UserList ([list])

Clase que simula una lista. El contenido de la instancia se mantiene en una lista normal, a la que se puede acceder mediante el atributo @ref{251e,,data} de las instancias @ref{1523,,UserList}. El contenido de la instancia se establece inicialmente en una copia de `list', por defecto a la lista vacía @code{[]}. `list' puede ser cualquier iterable, por ejemplo, una lista de Python real o un objeto @ref{1523,,UserList}.

Además de admitir los métodos y operaciones de secuencias mutables, las instancias @ref{1523,,UserList} proporcionan el siguiente atributo:

@geindex data (atributo de collections.UserList)
@anchor{library/collections collections UserList data}@anchor{251e}
@deffn {Atributo} data

Un objeto real @ref{18e,,list} usado para almacenar el contenido de la clase @ref{1523,,UserList} .
@end deffn
@end deffn

`Requisitos de subclases:' Se espera que las subclases de @ref{1523,,UserList} ofrezcan un constructor al que se pueda llamar sin argumentos o con un solo argumento. Las operaciones de lista que retornan una nueva secuencia intentan crear una instancia de la clase de implementación real. Para hacerlo, asume que se puede llamar al constructor con un solo parámetro, que es un objeto de secuencia utilizado como fuente de datos.

Si una clase derivada no desea cumplir con este requisito, todos los métodos especiales admitidos por esta clase deberán de anularse; consulte las fuentes para obtener información sobre los métodos que deben proporcionarse en ese caso.

@node Objetos UserString,,Objetos UserList,collections — Container datatypes
@anchor{library/collections userstring-objects}@anchor{251f}
@subsubsection Objetos @code{UserString}


La clase, @ref{e5a,,UserString} actúa como un envoltorio alrededor de los objetos de cadena. La necesidad de esta clase ha sido parcialmente suplantada por la capacidad de crear subclases directamente de @ref{237,,str}; sin embargo, es más fácil trabajar con esta clase porque se puede acceder a la cadena subyacente como atributo.

@geindex UserString (clase en collections)
@anchor{library/collections collections UserString}@anchor{e5a}
@deffn {Clase} collections.UserString (seq)

Clase que simula un objeto de cadena. El contenido de la instancia se mantiene en un objeto de cadena normal, al que se puede acceder a través del atributo @ref{2520,,data} de las instancias @ref{e5a,,UserString}. El contenido de la instancia se establece inicialmente en una copia de `seq'. El argumento `seq' puede ser cualquier objeto que se pueda convertir en una cadena usando la función incorporada @ref{237,,str()}.

Además de admitir los métodos y operaciones de cadenas, las instancias @ref{e5a,,UserString} proporcionan el siguiente atributo:

@geindex data (atributo de collections.UserString)
@anchor{library/collections collections UserString data}@anchor{2520}
@deffn {Atributo} data

Un objeto real @ref{237,,str} usado para almacenar el contenido de la clase @ref{e5a,,UserString}.
@end deffn


Distinto en la versión 3.5: Nuevos métodos @code{__getnewargs__}, @code{__rmod__}, @code{casefold}, @code{format_map}, @code{isprintable}, y @code{maketrans}.

@end deffn

@node collections abc — Abstract Base Classes for Containers,heapq — Heap queue algorithm,collections — Container datatypes,Tipos de datos
@anchor{library/collections abc doc}@anchor{2521}@anchor{library/collections abc collections-abc-abstract-base-classes-for-containers}@anchor{2522}@anchor{library/collections abc module-collections abc}@anchor{1f}
@subsection @code{collections.abc} — Abstract Base Classes for Containers


@geindex module; collections.abc


Added in version 3.3: Anteriormente, este módulo formaba parte del módulo @ref{1e,,collections}.


`Código fuente:' Lib/_collections_abc.py@footnote{https://github.com/python/cpython/tree/main/Lib/_collections_abc.py}

@c from collections.abc import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


This module provides @ref{1224,,abstract base classes} that
can be used to test whether a class provides a particular interface; for
example, whether it is @ref{6b1,,hashable} or whether it is a @ref{1229,,mapping}.

Una prueba @ref{85a,,issubclass()} o @ref{4ef,,isinstance()} para una interfaz funciona de tres formas.

1) A newly written class can inherit directly from one of the
abstract base classes.  The class must supply the required abstract
methods.  The remaining mixin methods come from inheritance and can be
overridden if desired.  Other methods may be added as needed:

@example
class C(Sequence):                      # Direct inheritance
    def __init__(self): ...             # Extra method not required by the ABC
    def __getitem__(self, index):  ...  # Required abstract method
    def __len__(self):  ...             # Required abstract method
    def count(self, value): ...         # Optionally override a mixin method
@end example

@example
>>> issubclass(C, Sequence)
True
>>> isinstance(C(), Sequence)
True
@end example

2) Existing classes and built-in classes can be registered as «virtual
subclasses» of the ABCs.  Those classes should define the full API
including all of the abstract methods and all of the mixin methods.
This lets users rely on @ref{85a,,issubclass()} or @ref{4ef,,isinstance()} tests
to determine whether the full interface is supported.  The exception to
this rule is for methods that are automatically inferred from the rest
of the API:

@example
class D:                                 # No inheritance
    def __init__(self): ...              # Extra method not required by the ABC
    def __getitem__(self, index):  ...   # Abstract method
    def __len__(self):  ...              # Abstract method
    def count(self, value): ...          # Mixin method
    def index(self, value): ...          # Mixin method

Sequence.register(D)                     # Register instead of inherit
@end example

@example
>>> issubclass(D, Sequence)
True
>>> isinstance(D(), Sequence)
True
@end example

In this example, class @code{D} does not need to define
@code{__contains__}, @code{__iter__}, and @code{__reversed__} because the
@ref{2071,,in-operator}, the @ref{1294,,iteration}
logic, and the @ref{8fc,,reversed()} function automatically fall back to
using @code{__getitem__} and @code{__len__}.

3) Some simple interfaces are directly recognizable by the presence of
the required methods (unless those methods have been set to
@ref{716,,None}):

@example
class E:
    def __iter__(self): ...
    def __next__(self): ...
@end example

@example
>>> issubclass(E, Iterable)
True
>>> isinstance(E(), Iterable)
True
@end example

Las interfaces complejas no admiten esta última técnica porque una interfaz es más que la simple presencia de nombres de métodos. Las interfaces especifican la semántica y las relaciones entre métodos que no se pueden inferir únicamente de la presencia de nombres de métodos específicos. Por ejemplo, saber que una clase proporciona @code{__getitem__}, @code{__len__} y @code{__iter__} no es suficiente para distinguir un @ref{1231,,Sequence} de un @ref{961,,Mapping}.


Added in version 3.9: Estas clases abstractas ahora soportan @code{[]}. Vea @ref{753,,Tipo Alias Genérico} y 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}.


@menu
* Colecciones clases base abstractas:: 
* Colecciones Clases base abstractas - Descripciones detalladas:: 
* Ejemplos y Recetas:: 

@end menu

@node Colecciones clases base abstractas,Colecciones Clases base abstractas - Descripciones detalladas,,collections abc — Abstract Base Classes for Containers
@anchor{library/collections abc collections-abstract-base-classes}@anchor{90f}@anchor{library/collections abc id1}@anchor{2523}
@subsubsection Colecciones clases base abstractas


El módulo de colecciones ofrece lo siguiente @ref{1224,,ABCs}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ABC

@tab

Hereda de

@tab

Métodos abstractos

@tab

Métodos mixin

@item

@ref{2255,,Container} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__contains__}

@tab

@item

@ref{59a,,Hashable} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__hash__}

@tab

@item

@ref{2253,,Iterable} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
} @footnote{
Checking @code{isinstance(obj, Iterable)} detects classes that are
registered as @ref{2253,,Iterable} or that have an @ref{1cc8,,__iter__()}
method, but it does not detect classes that iterate with the
@ref{3d8,,__getitem__()} method.  The only reliable way to determine
whether an object is @ref{1294,,iterable} is to call @code{iter(obj)}.
}

@tab

@tab

@code{__iter__}

@tab

@item

@ref{2254,,Iterator} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{2253,,Iterable}

@tab

@code{__next__}

@tab

@code{__iter__}

@item

@ref{d12,,Reversible} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{2253,,Iterable}

@tab

@code{__reversed__}

@tab

@item

@ref{e60,,Generator} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{2254,,Iterator}

@tab

@code{send}, @code{throw}

@tab

@code{close}, @code{__iter__}, @code{__next__}

@item

@ref{59b,,Sized} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__len__}

@tab

@item

@ref{881,,Callable} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__call__}

@tab

@item

@ref{d11,,Collection} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{59b,,Sized},
@ref{2253,,Iterable},
@ref{2255,,Container}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__}

@tab

@item

@ref{1231,,Sequence}

@tab

@ref{d12,,Reversible},
@ref{d11,,Collection}

@tab

@code{__getitem__},
@code{__len__}

@tab

@code{__contains__}, @code{__iter__}, @code{__reversed__},
@code{index}, and @code{count}

@item

@ref{309,,MutableSequence}

@tab

@ref{1231,,Sequence}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__len__},
@code{insert}

@tab

Inherited @ref{1231,,Sequence} methods and
@code{append}, @code{clear}, @code{reverse}, @code{extend},
@code{pop}, @code{remove}, and @code{__iadd__}

@item

@ref{224b,,Set}

@tab

@ref{d11,,Collection}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__}

@tab

@code{__le__}, @code{__lt__}, @code{__eq__}, @code{__ne__},
@code{__gt__}, @code{__ge__}, @code{__and__}, @code{__or__},
@code{__sub__}, @code{__rsub__}, @code{__xor__}, @code{__rxor__}
and @code{isdisjoint}

@item

@ref{2256,,MutableSet}

@tab

@ref{224b,,Set}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__},
@code{add},
@code{discard}

@tab

Métodos heredados @ref{224b,,Set} y @code{clear}, @code{pop}, @code{remove}, @code{__ior__}, @code{__iand__}, @code{__ixor__}, and @code{__isub__}

@item

@ref{961,,Mapping}

@tab

@ref{d11,,Collection}

@tab

@code{__getitem__},
@code{__iter__},
@code{__len__}

@tab

@code{__contains__}, @code{keys}, @code{items}, @code{values},
@code{get}, @code{__eq__}, and @code{__ne__}

@item

@ref{1123,,MutableMapping}

@tab

@ref{961,,Mapping}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__iter__},
@code{__len__}

@tab

Métodos heredados @ref{961,,Mapping} y @code{pop}, @code{popitem}, @code{clear}, @code{update}, and @code{setdefault}

@item

@ref{2257,,MappingView}

@tab

@ref{59b,,Sized}

@tab

@tab

@code{__init__}, @code{__len__} and @code{__repr__}

@item

@ref{2259,,ItemsView}

@tab

@ref{2257,,MappingView},
@ref{224b,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{2258,,KeysView}

@tab

@ref{2257,,MappingView},
@ref{224b,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{225a,,ValuesView}

@tab

@ref{2257,,MappingView},
@ref{d11,,Collection}

@tab

@tab

@code{__contains__}, @code{__iter__}

@item

@ref{e61,,Awaitable} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__await__}

@tab

@item

@ref{e62,,Coroutine} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{e61,,Awaitable}

@tab

@code{send}, @code{throw}

@tab

@code{close}

@item

@ref{e64,,AsyncIterable} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__aiter__}

@tab

@item

@ref{e63,,AsyncIterator} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{e64,,AsyncIterable}

@tab

@code{__anext__}

@tab

@code{__aiter__}

@item

@ref{d13,,AsyncGenerator} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@ref{e63,,AsyncIterator}

@tab

@code{asend}, @code{athrow}

@tab

@code{aclose}, @code{__aiter__}, @code{__anext__}

@item

@ref{3fe,,Buffer} @footnote{
These ABCs override @ref{2524,,__subclasshook__()} to support
testing an interface by verifying the required methods are present
and have not been set to @ref{716,,None}.  This only works for simple
interfaces.  More complex interfaces require registration or direct
subclassing.
}

@tab

@tab

@code{__buffer__}

@tab

@end multitable


@subsubheading Notas al pie


@node Colecciones Clases base abstractas - Descripciones detalladas,Ejemplos y Recetas,Colecciones clases base abstractas,collections abc — Abstract Base Classes for Containers
@anchor{library/collections abc collections-abstract-base-classes-detailed-descriptions}@anchor{2525}
@subsubsection Colecciones Clases base abstractas - Descripciones detalladas


@geindex Container (clase en collections.abc)
@anchor{library/collections abc collections abc Container}@anchor{2255}
@deffn {Clase} collections.abc.Container

ABC for classes that provide the @ref{1f5d,,__contains__()} method.
@end deffn

@geindex Hashable (clase en collections.abc)
@anchor{library/collections abc collections abc Hashable}@anchor{59a}
@deffn {Clase} collections.abc.Hashable

ABC for classes that provide the @ref{b86,,__hash__()} method.
@end deffn

@geindex Sized (clase en collections.abc)
@anchor{library/collections abc collections abc Sized}@anchor{59b}
@deffn {Clase} collections.abc.Sized

ABC for classes that provide the @ref{1f62,,__len__()} method.
@end deffn

@geindex Callable (clase en collections.abc)
@anchor{library/collections abc collections abc Callable}@anchor{881}
@deffn {Clase} collections.abc.Callable

ABC for classes that provide the @ref{5fb,,__call__()} method.

See @ref{2526,,Annotating callable objects} for details on how to use
@code{Callable} in type annotations.
@end deffn

@geindex Iterable (clase en collections.abc)
@anchor{library/collections abc collections abc Iterable}@anchor{2253}
@deffn {Clase} collections.abc.Iterable

ABC for classes that provide the @ref{1cc8,,__iter__()} method.

Checking @code{isinstance(obj, Iterable)} detects classes that are registered
as @ref{2253,,Iterable} or that have an @ref{1cc8,,__iter__()} method,
but it does
not detect classes that iterate with the @ref{3d8,,__getitem__()} method.
The only reliable way to determine whether an object is @ref{1294,,iterable}
is to call @code{iter(obj)}.
@end deffn

@geindex Collection (clase en collections.abc)
@anchor{library/collections abc collections abc Collection}@anchor{d11}
@deffn {Clase} collections.abc.Collection

ABC para clases de contenedor iterables de tamaño.


Added in version 3.6.

@end deffn

@geindex Iterator (clase en collections.abc)
@anchor{library/collections abc collections abc Iterator}@anchor{2254}
@deffn {Clase} collections.abc.Iterator

ABC para clases que proporcionan el método @ref{1ccb,,__iter__()} y @ref{1335,,__next__()}. Ver también la definición de @ref{313,,iterator}.
@end deffn

@geindex Reversible (clase en collections.abc)
@anchor{library/collections abc collections abc Reversible}@anchor{d12}
@deffn {Clase} collections.abc.Reversible

ABC for iterable classes that also provide the @ref{1f5c,,__reversed__()}
method.


Added in version 3.6.

@end deffn

@geindex Generator (clase en collections.abc)
@anchor{library/collections abc collections abc Generator}@anchor{e60}
@deffn {Clase} collections.abc.Generator

ABC for @ref{10dd,,generator} classes that implement the protocol defined in
@geindex Python Enhancement Proposals; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} that extends @ref{313,,iterators} with the
@ref{1fcd,,send()},
@ref{59d,,throw()} and @ref{16fa,,close()} methods.

See @ref{2527,,Annotating generators and coroutines}
for details on using @code{Generator} in type annotations.


Added in version 3.5.

@end deffn

@geindex Sequence (clase en collections.abc)
@geindex MutableSequence (clase en collections.abc)
@anchor{library/collections abc collections abc Sequence}@anchor{1231}
@deffn {Clase} collections.abc.Sequence
@anchor{library/collections abc collections abc MutableSequence}@anchor{309}
@deffnx {Clase} collections.abc.MutableSequence

ABC para solo lectura y mutable @ref{597,,secuencias}.

Implementation note: Some of the mixin methods, such as
@ref{1cc8,,__iter__()}, @ref{1f5c,,__reversed__()} and @code{index()}, make
repeated calls to the underlying @ref{3d8,,__getitem__()} method.
Consequently, if @ref{3d8,,__getitem__()} is implemented with constant
access speed, the mixin methods will have linear performance;
however, if the underlying method is linear (as it would be with a
linked list), the mixins will have quadratic performance and will
likely need to be overridden.


Distinto en la versión 3.5: El método index() agregó soporte para los argumentos `stop' y `start'.

@end deffn

@geindex Set (clase en collections.abc)
@geindex MutableSet (clase en collections.abc)
@anchor{library/collections abc collections abc Set}@anchor{224b}
@deffn {Clase} collections.abc.Set
@anchor{library/collections abc collections abc MutableSet}@anchor{2256}
@deffnx {Clase} collections.abc.MutableSet

ABCs for read-only and mutable @ref{2179,,sets}.
@end deffn

@geindex Mapping (clase en collections.abc)
@geindex MutableMapping (clase en collections.abc)
@anchor{library/collections abc collections abc Mapping}@anchor{961}
@deffn {Clase} collections.abc.Mapping
@anchor{library/collections abc collections abc MutableMapping}@anchor{1123}
@deffnx {Clase} collections.abc.MutableMapping

ABC para solo lectura y mutable @ref{1229,,mapeos}.
@end deffn

@geindex MappingView (clase en collections.abc)
@geindex ItemsView (clase en collections.abc)
@geindex KeysView (clase en collections.abc)
@geindex ValuesView (clase en collections.abc)
@anchor{library/collections abc collections abc MappingView}@anchor{2257}
@deffn {Clase} collections.abc.MappingView
@anchor{library/collections abc collections abc ItemsView}@anchor{2259}
@deffnx {Clase} collections.abc.ItemsView
@anchor{library/collections abc collections abc KeysView}@anchor{2258}
@deffnx {Clase} collections.abc.KeysView
@anchor{library/collections abc collections abc ValuesView}@anchor{225a}
@deffnx {Clase} collections.abc.ValuesView

ABC para mapeo, elementos, claves y valores @ref{2519,,vistas}.
@end deffn

@geindex Awaitable (clase en collections.abc)
@anchor{library/collections abc collections abc Awaitable}@anchor{e61}
@deffn {Clase} collections.abc.Awaitable

ABC for @ref{314,,awaitable} objects, which can be used in @ref{14e,,await}
expressions.  Custom implementations must provide the
@ref{1fc8,,__await__()} method.

@ref{53a,,Coroutine} objetos e instancias de la clase @ref{e62,,Coroutine} ABC son todas las instancias de este ABC.

@cartouche
@quotation Nota 
In CPython, generator-based coroutines (@ref{10dd,,generators}
decorated with @ref{f0b,,@@types.coroutine}) are
`awaitables', even though they do not have an @ref{1fc8,,__await__()} method.
Using @code{isinstance(gencoro, Awaitable)} for them will return @code{False}.
Use @ref{e9c,,inspect.isawaitable()} to detect them.
@end quotation
@end cartouche


Added in version 3.5.

@end deffn

@geindex Coroutine (clase en collections.abc)
@anchor{library/collections abc collections abc Coroutine}@anchor{e62}
@deffn {Clase} collections.abc.Coroutine

ABC for @ref{53a,,coroutine} compatible classes.  These implement the
following methods, defined in @ref{1f07,,Objetos de corrutina}:
@ref{1fcc,,send()}, @ref{59c,,throw()}, and
@ref{1fce,,close()}.  Custom implementations must also implement
@ref{1fc8,,__await__()}.  All @ref{e62,,Coroutine} instances are also
instances of @ref{e61,,Awaitable}.

@cartouche
@quotation Nota 
In CPython, generator-based coroutines (@ref{10dd,,generators}
decorated with @ref{f0b,,@@types.coroutine}) are
`awaitables', even though they do not have an @ref{1fc8,,__await__()} method.
Using @code{isinstance(gencoro, Coroutine)} for them will return @code{False}.
Use @ref{e9c,,inspect.isawaitable()} to detect them.
@end quotation
@end cartouche

See @ref{2527,,Annotating generators and coroutines}
for details on using @code{Coroutine} in type annotations.
The variance and order of type parameters correspond to those of
@ref{e60,,Generator}.


Added in version 3.5.

@end deffn

@geindex AsyncIterable (clase en collections.abc)
@anchor{library/collections abc collections abc AsyncIterable}@anchor{e64}
@deffn {Clase} collections.abc.AsyncIterable

ABC for classes that provide an @code{__aiter__} method.  See also the
definition of @ref{dfd,,asynchronous iterable}.


Added in version 3.5.

@end deffn

@geindex AsyncIterator (clase en collections.abc)
@anchor{library/collections abc collections abc AsyncIterator}@anchor{e63}
@deffn {Clase} collections.abc.AsyncIterator

ABC para clases que proveen métodos @code{__aiter__} and @code{__anext__}. Ver también la definición de @ref{312,,asynchronous iterator}.


Added in version 3.5.

@end deffn

@geindex AsyncGenerator (clase en collections.abc)
@anchor{library/collections abc collections abc AsyncGenerator}@anchor{d13}
@deffn {Clase} collections.abc.AsyncGenerator

ABC for @ref{2039,,asynchronous generator} classes that implement the protocol
defined in 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} and 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.

See @ref{2527,,Annotating generators and coroutines}
for details on using @code{AsyncGenerator} in type annotations.


Added in version 3.6.

@end deffn

@geindex Buffer (clase en collections.abc)
@anchor{library/collections abc collections abc Buffer}@anchor{3fe}
@deffn {Clase} collections.abc.Buffer

ABC para clases que proveen el método @ref{50a,,__buffer__()}, implementando el @ref{48a,,protocolo búfer}. Ver 
@geindex Python Enhancement Proposals; PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/}.


Added in version 3.12.

@end deffn

@node Ejemplos y Recetas,,Colecciones Clases base abstractas - Descripciones detalladas,collections abc — Abstract Base Classes for Containers
@anchor{library/collections abc examples-and-recipes}@anchor{2528}
@subsubsection Ejemplos y Recetas


Los ABC nos permiten preguntar a las clases o instancias si brindan una funcionalidad particular, por ejemplo:

@example
size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)
@end example

Several of the ABCs are also useful as mixins that make it easier to develop
classes supporting container APIs.  For example, to write a class supporting
the full @ref{224b,,Set} API, it is only necessary to supply the three underlying
abstract methods: @ref{1f5d,,__contains__()}, @ref{1cc8,,__iter__()}, and
@ref{1f62,,__len__()}. The ABC supplies the remaining methods such as
@code{__and__()} and @ref{2239,,isdisjoint()}:

@example
class ListBasedSet(collections.abc.Set):
    '@w{'}' Alternate set implementation favoring space over speed
        and not requiring the set elements to be hashable. '@w{'}'
    def __init__(self, iterable):
        self.elements = lst = []
        for value in iterable:
            if value not in lst:
                lst.append(value)

    def __iter__(self):
        return iter(self.elements)

    def __contains__(self, value):
        return value in self.elements

    def __len__(self):
        return len(self.elements)

s1 = ListBasedSet('abcdef')
s2 = ListBasedSet('defghi')
overlap = s1 & s2            # The __and__() method is supported automatically
@end example

Notas sobre el uso de @ref{224b,,Set} y @ref{2256,,MutableSet} como un mixin:


@enumerate 

@item 
Since some set operations create new sets, the default mixin methods need
a way to create new instances from an @ref{1294,,iterable}. The class constructor is
assumed to have a signature in the form @code{ClassName(iterable)}.
That assumption is factored-out to an internal @ref{2d2,,classmethod} called
@code{_from_iterable()} which calls @code{cls(iterable)} to produce a new set.
If the @ref{224b,,Set} mixin is being used in a class with a different
constructor signature, you will need to override @code{_from_iterable()}
with a classmethod or regular method that can construct new instances from
an iterable argument.

@item 
To override the comparisons (presumably for speed, as the
semantics are fixed), redefine @ref{1373,,__le__()} and
@ref{1375,,__ge__()},
then the other operations will automatically follow suit.

@item 
The @ref{224b,,Set} mixin provides a @code{_hash()} method to compute a hash value
for the set; however, @ref{b86,,__hash__()} is not defined because not all sets
are @ref{6b1,,hashable} or immutable.  To add set hashability using mixins,
inherit from both @ref{224b,,Set()} and @ref{59a,,Hashable()}, then define
@code{__hash__ = Set._hash}.
@end enumerate


@subsubheading Ver también



@itemize *

@item 
OrderedSet receta@footnote{https://code.activestate.com/recipes/576694/} para un ejemplo basado en @ref{2256,,MutableSet}.

@item 
Para obtener más información sobre ABCs, ver el módulo @ref{4,,abc} y 
@geindex Python Enhancement Proposals; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}.
@end itemize


@node heapq — Heap queue algorithm,bisect — Array bisection algorithm,collections abc — Abstract Base Classes for Containers,Tipos de datos
@anchor{library/heapq doc}@anchor{2529}@anchor{library/heapq heapq-heap-queue-algorithm}@anchor{252a}@anchor{library/heapq module-heapq}@anchor{69}
@subsection @code{heapq} — Heap queue algorithm


@geindex module; heapq

`Código fuente:' Lib/heapq.py@footnote{https://github.com/python/cpython/tree/main/Lib/heapq.py}


__________________________________________________________________


Este módulo proporciona una implementación del algoritmo de montículos, también conocido como algoritmo de cola con prioridad.

Heaps are binary trees for which every parent node has a value less than or
equal to any of its children.  We refer to this condition as the heap invariant.

This implementation uses arrays for which
@code{heap[k] <= heap[2*k+1]} and @code{heap[k] <= heap[2*k+2]} for all `k', counting
elements from zero.  For the sake of comparison, non-existing elements are
considered to be infinite.  The interesting property of a heap is that its
smallest element is always the root, @code{heap[0]}.

El API que se presenta a continuación difiere de los algoritmos de los libros de texto en dos aspectos: (a) Utilizamos la indexación basada en cero. Esto hace que la relación entre el índice de un nodo y los índices de sus hijos sea un poco menos evidente, pero es más adecuado ya que Python utiliza la indexación basada en cero. (b) Nuestro método «pop» retorna el elemento más pequeño, no el más grande (llamado «min heap» o montículo por mínimo en los libros de texto; un «max heap» o montículo por máximos es más común en los textos debido a su idoneidad para la clasificación in situ).

Estos dos permiten ver el montículo como una lista Python normal sin sorpresas: @code{heap[0]} es el ítem más pequeño, y @code{heap.sort()} mantiene el montículo invariable!

Para crear un montículo, usa una lista inicializada como @code{[]}, o puedes transformar una lista poblada en un montículo a través de la función @ref{252b,,heapify()}.

Las siguientes funciones están provistas:

@geindex heappush() (en el módulo heapq)
@anchor{library/heapq heapq heappush}@anchor{14f8}
@deffn {Función} heapq.heappush (heap, item)

Empujar el valor `item' en el `heap', manteniendo el montículo invariable.
@end deffn

@geindex heappop() (en el módulo heapq)
@anchor{library/heapq heapq heappop}@anchor{14f9}
@deffn {Función} heapq.heappop (heap)

Desapila o `pop' y retorna el elemento más pequeño del `heap', manteniendo el montículo invariable. Si el montículo está vacío, @ref{1575,,IndexError} se lanza. Para acceder al elemento más pequeño sin necesidad de desapilar, usa @code{heap[0]}.
@end deffn

@geindex heappushpop() (en el módulo heapq)
@anchor{library/heapq heapq heappushpop}@anchor{252c}
@deffn {Función} heapq.heappushpop (heap, item)

Apila el elemento o `iem' en el montículo, y luego desapila y retorna el elemento más pequeño del montículo. La acción combinada se ejecuta más eficientemente que @ref{14f8,,heappush()} seguido de una llamada separada a @ref{14f9,,heappop()}.
@end deffn

@geindex heapify() (en el módulo heapq)
@anchor{library/heapq heapq heapify}@anchor{252b}
@deffn {Función} heapq.heapify (x)

Transformar la lista `x' en un montículo, en el lugar, en tiempo lineal.
@end deffn

@geindex heapreplace() (en el módulo heapq)
@anchor{library/heapq heapq heapreplace}@anchor{252d}
@deffn {Función} heapq.heapreplace (heap, item)

Desapila y retorna el elemento más pequeño del `heap', y también apile el nuevo `item'. El tamaño del montículo no cambia. Si el montículo está vacío, @ref{1575,,IndexError} se lanza.

Esta operación de un solo paso es más eficiente que un @ref{14f9,,heappop()} seguido por @ref{14f8,,heappush()} y puede ser más apropiada cuando se utiliza un montículo de tamaño fijo. La combinación pop/push siempre retorna un elemento del montículo y lo reemplaza con `item'.

El valor retornado puede ser mayor que el `item' añadido. Si no se desea eso, considere usar @ref{252c,,heappushpop()} en su lugar. Su combinación push/pop retorna el menor de los dos valores, dejando el mayor valor en el montículo.
@end deffn

El módulo también ofrece tres funciones de propósito general basadas en los montículos.

@geindex merge() (en el módulo heapq)
@anchor{library/heapq heapq merge}@anchor{e89}
@deffn {Función} heapq.merge (*iterables, key=None, reverse=False)

Fusionar varias entradas ordenadas en una sola salida ordenada (por ejemplo, fusionar entradas con marca de tiempo de varios archivos de registro). Retorna un @ref{313,,iterator} sobre los valores ordenados.

Similar a @code{sorted(itertools.chain(*iterables))} pero retorna un iterable, no hala los datos a la memoria de una sola vez, y asume que cada uno de los flujos de entrada ya están ordenado (de menor a mayor).

Tiene dos argumentos opcionales que deben ser especificados como argumentos de palabras clave.

`key' especifica una @ref{e8a,,key function} de un argumento que se utiliza para extraer una clave de comparación de cada elemento de entrada. El valor por defecto es @code{None} (compara los elementos directamente).

`reverse' es un valor booleano. Si se establece en @code{True}, entonces los elementos de entrada se fusionan como si cada comparación se invirtiera. Para lograr un comportamiento similar a @code{sorted(itertools.chain(*iterables), reverse=True)}, todos los iterables deben ser ordenados de mayor a menor.


Distinto en la versión 3.5: Añadió los parámetros opcionales de `key' y `reverse'.

@end deffn

@geindex nlargest() (en el módulo heapq)
@anchor{library/heapq heapq nlargest}@anchor{252e}
@deffn {Función} heapq.nlargest (n, iterable, key=None)

Retorna una lista con los `n' elementos más grandes del conjunto de datos definidos por `iterable'. `key', si se proporciona, especifica una función de un argumento que se utiliza para extraer una clave de comparación de cada elemento en `iterable' (por ejemplo, @code{key=str.lower}). Equivalente a:  @code{sorted(iterable, key=clave, reverse=True)[:n]}.
@end deffn

@geindex nsmallest() (en el módulo heapq)
@anchor{library/heapq heapq nsmallest}@anchor{252f}
@deffn {Función} heapq.nsmallest (n, iterable, key=None)

Retorna una lista con los `n' elementos más pequeños del conjunto de datos definidos por `iterable'. `key', si se proporciona, especifica una función de un argumento que se utiliza para extraer una clave de comparación de cada elemento en `iterable' (por ejemplo, @code{key=str.lower}). Equivalente a:  @code{sorted(iterable, key=clave)[:n]}.
@end deffn

Las dos últimas funciones funcionan mejor para valores más pequeños de `n'. Para valores más grandes, es más eficiente usar la función @ref{c56,,sorted()}. Además, cuando @code{n==1}, es más eficiente usar las funciones incorporadas @ref{f8b,,min()} y @code{max`()}. Si se requiere el uso repetido de estas funciones, considere convertir lo iterable en un verdadero montículo.

@menu
* Ejemplos Básicos:: 
* Notas de Aplicación de la Cola de Prioridades:: 
* Teoría:: 

@end menu

@node Ejemplos Básicos,Notas de Aplicación de la Cola de Prioridades,,heapq — Heap queue algorithm
@anchor{library/heapq basic-examples}@anchor{2530}
@subsubsection Ejemplos Básicos


Un heapsort"@footnote{https://en.wikipedia.org/wiki/Heapsort} puede ser implementado empujando todos los valores en un montículo y luego desapilando los valores más pequeños uno a la vez:

@example
>>> def heapsort(iterable):
...     h = []
...     for value in iterable:
...         heappush(h, value)
...     return [heappop(h) for i in range(len(h))]
...
>>> heapsort([1, 3, 5, 7, 9, 2, 4, 6, 8, 0])
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

Esto es similar a @code{sorted(iterable)}, pero a diferencia de @ref{c56,,sorted()}, esta implementación no es estable.

Los elementos del montículo pueden ser tuplas. Esto es útil para asignar valores de comparación (como las prioridades de las tareas) junto con el registro principal que se está rastreando:

@example
>>> h = []
>>> heappush(h, (5, 'write code'))
>>> heappush(h, (7, 'release product'))
>>> heappush(h, (1, 'write spec'))
>>> heappush(h, (3, 'create tests'))
>>> heappop(h)
(1, 'write spec')
@end example

@node Notas de Aplicación de la Cola de Prioridades,Teoría,Ejemplos Básicos,heapq — Heap queue algorithm
@anchor{library/heapq priority-queue-implementation-notes}@anchor{2531}
@subsubsection Notas de Aplicación de la Cola de Prioridades


Una cola de prioridad@footnote{https://en.wikipedia.org/wiki/Priority_queue} es de uso común para un montículo, y presenta varios desafíos de implementación:


@itemize *

@item 
Estabilidad de la clasificación: ¿cómo se consigue que dos tareas con iguales prioridades sean retornadas en el orden en que fueron añadidas originalmente?

@item 
Interrupciones de comparación en tupla para pares (prioridad, tarea) si las prioridades son iguales y las tareas no tienen un orden de comparación por defecto.

@item 
¿Si la prioridad de una tarea cambia, cómo la mueves a una nueva posición en el montículo?

@item 
¿O si una tarea pendiente necesita ser borrada, cómo la encuentras y la eliminas de la cola?
@end itemize

Una solución a los dos primeros desafíos es almacenar las entradas como una lista de 3 elementos que incluya la prioridad, un recuento de entradas y la tarea. El recuento de entradas sirve como un desempate para que dos tareas con la misma prioridad sean retornadas en el orden en que fueron añadidas. Y como no hay dos recuentos de entradas iguales, la comparación tupla nunca intentará comparar directamente dos tareas.

Otra solución al problema de las tareas no comparables es crear una clase envolvente que ignore el elemento de la tarea y sólo compare el campo de prioridad:

@example
from dataclasses import dataclass, field
from typing import Any

@@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)
@end example

Los desafíos restantes giran en torno a encontrar una tarea pendiente y hacer cambios en su prioridad o eliminarla por completo. Encontrar una tarea se puede hacer con un diccionario que apunta a una entrada en la cola.

Eliminar la entrada o cambiar su prioridad es más difícil porque rompería las invariantes de la estructura del montículo. Por lo tanto, una posible solución es marcar la entrada como eliminada y añadir una nueva entrada con la prioridad revisada:

@example
pq = []                         # list of entries arranged in a heap
entry_finder = @{@}               # mapping of tasks to entries
REMOVED = '<removed-task>'      # placeholder for a removed task
counter = itertools.count()     # unique sequence count

def add_task(task, priority=0):
    'Add a new task or update the priority of an existing task'
    if task in entry_finder:
        remove_task(task)
    count = next(counter)
    entry = [priority, count, task]
    entry_finder[task] = entry
    heappush(pq, entry)

def remove_task(task):
    'Mark an existing task as REMOVED.  Raise KeyError if not found.'
    entry = entry_finder.pop(task)
    entry[-1] = REMOVED

def pop_task():
    'Remove and return the lowest priority task. Raise KeyError if empty.'
    while pq:
        priority, count, task = heappop(pq)
        if task is not REMOVED:
            del entry_finder[task]
            return task
    raise KeyError('pop from an empty priority queue')
@end example

@node Teoría,,Notas de Aplicación de la Cola de Prioridades,heapq — Heap queue algorithm
@anchor{library/heapq theory}@anchor{2532}
@subsubsection Teoría


Los montículos son conjuntos para los cuales @code{a[k] <= a[2*k+1]} y @code{a[k] <= a[2*k+2]} para todos los `k', contando los elementos desde 0. Para comparar, los elementos no existentes se consideran infinitos. La interesante propiedad de un montículo es que @code{a[0]} es siempre su elemento más pequeño.

La extraña invariante de arriba intenta ser una representación eficiente de la memoria para un torneo. Los números de abajo son `k', no @code{a[k]}:

@example
                               0

              1                                 2

      3               4                5               6

  7       8       9       10      11      12      13      14

15 16   17 18   19 20   21 22   23 24   25 26   27 28   29 30
@end example

En el árbol de arriba, cada celda `k' está coronada por @code{2*k+1} y @code{2*k+2}. En un torneo binario habitual que vemos en los deportes, cada celda es el ganador sobre las dos celdas que supera, y podemos rastrear al ganador hasta el árbol para ver todos los oponentes que tuvo. Sin embargo, en muchas aplicaciones informáticas de tales torneos, no necesitamos rastrear la historia de un ganador. Para ser más eficientes en la memoria, cuando un ganador es ascendido, tratamos de reemplazarlo por algo más en un nivel inferior, y la regla se convierte en que una celda y las dos celdas que supera contienen tres elementos diferentes, pero la celda superior «gana» sobre las dos celdas superiores.

If this heap invariant is protected at all time, index 0 is clearly the overall
winner.  The simplest algorithmic way to remove it and find the «next» winner is
to move some loser (let’s say cell 30 in the diagram above) into the 0 position,
and then percolate this new 0 down the tree, exchanging values, until the
invariant is re-established. This is clearly logarithmic on the total number of
items in the tree. By iterating over all items, you get an `O'(`n' log `n') sort.

Una buena característica de este tipo es que puedes insertar nuevos elementos de manera eficiente mientras se realiza la clasificación, siempre y cuando los elementos insertados no sean «mejores» que el último 0’th elemento que has extraído. Esto es especialmente útil en contextos de simulación, donde el árbol contiene todos los eventos entrantes, y la condición de «ganar» significa el menor tiempo programado. Cuando un evento programa otros eventos para su ejecución, se programan en el futuro, para que puedan ir fácilmente al montículo. Por lo tanto, un montículo es una buena estructura para implementar planificadores o `schedulers' (esto es lo que usé para mi secuenciador MIDI :-).

Se han estudiado extensamente varias estructuras para implementar los planificadores, y los montículos son buenos para ello, ya que son razonablemente rápidos, la velocidad es casi constante, y el peor de los casos no es muy diferente del caso promedio. Sin embargo, hay otras representaciones que son más eficientes en general, aunque los peores casos podrían ser terribles.

Los montículos también son muy útiles en las grandes  ordenaciones de elementos en discos de memoria. Lo más probable es que todos sepan que un tipo grande implica la producción de «ejecuciones» (que son secuencias preclasificadas, cuyo tamaño suele estar relacionado con la cantidad de memoria de la CPU), seguidas de una fusión de pases para estas ejecuciones, cuya fusión suele estar muy inteligentemente organizada @footnote{
Los algoritmos de balanceo de discos que están vigentes hoy en día, son más molestos que inteligentes, y esto es una consecuencia de las capacidades de búsqueda de los discos. En los dispositivos que no pueden buscar, como las grandes unidades de cinta, la historia era muy diferente, y había que ser muy inteligente para asegurarse (con mucha antelación) de que cada movimiento de la cinta fuera el más efectivo (es decir, que participara mejor en el «progreso» de la fusión). Algunas cintas eran incluso capaces de leer al revés, y esto también se utilizó para evitar el tiempo rebobinado. Créanme, ¡la ordenación de elementos en cinta realmente buenos fueron espectaculares de ver! ¡Desde todos los tiempos, la ordenación de elementos siempre ha sido un Gran Arte! :-)
}. Es muy importante que la clasificación inicial produzca las ejecuciones posibles más largas. Los torneos son una buena manera de lograrlo. Si, utilizando toda la memoria disponible para celebrar un torneo, sustituyes y filtras los elementos que encajan en la carrera actual, producirás carreras que tienen el doble del tamaño de la memoria para la entrada aleatoria, y mucho mejor para la entrada ordenada de forma difusa.

Además, si se da salida al `0’th item' en el disco y se obtiene una entrada que no puede caber en el torneo actual (porque el valor «gana» sobre el último valor de salida), no puede caber en el montículo, por lo que el tamaño del montículo disminuye. La memoria liberada podría ser ingeniosamente reutilizada inmediatamente para construir progresivamente un segundo montículo, que crece exactamente al mismo ritmo que el primer montículo se está fundiendo. Cuando el primer montículo se desvanece completamente, se cambia de montículo y se inicia una nueva carrera. ¡Ingenioso y muy efectivo!

En una palabra, los montículos son estructuras de memoria útiles a conocer. Las uso en algunas aplicaciones, y creo que es bueno tener un módulo “heap” alrededor. :-)

@subsubheading Notas al pie de página


@node bisect — Array bisection algorithm,array — Efficient arrays of numeric values,heapq — Heap queue algorithm,Tipos de datos
@anchor{library/bisect doc}@anchor{2533}@anchor{library/bisect bisect-array-bisection-algorithm}@anchor{2534}@anchor{library/bisect module-bisect}@anchor{12}
@subsection @code{bisect} — Array bisection algorithm


@geindex module; bisect

@c example based on the PyModules FAQ entry by Aaron Watters <arw@pythonpros.com>

`Código fuente:' Lib/bisect.py@footnote{https://github.com/python/cpython/tree/main/Lib/bisect.py}


__________________________________________________________________


Este módulo brinda soporte para mantener una lista ordenada sin tener que reordenar la lista tras cada nueva inserción. Para listas largas de elementos que tienen operaciones de comparación costosas, esto puede suponer una mejora con respecto a las búsquedas lineales o el reordenado frecuente.

The module is called @ref{12,,bisect} because it uses a basic bisection
algorithm to do its work.  Unlike other bisection tools that search for a
specific value, the functions in this module are designed to locate an
insertion point. Accordingly, the functions never call an @ref{b85,,__eq__()}
method to determine whether a value has been found.  Instead, the
functions only call the @ref{1372,,__lt__()} method and will return an insertion
point between values in an array.
@anchor{library/bisect bisect-functions}@anchor{2535}
Las siguientes funciones están disponibles:

@geindex bisect_left() (en el módulo bisect)
@anchor{library/bisect bisect bisect_left}@anchor{2536}
@deffn {Función} bisect.bisect_left (a, x, lo=0, hi=len(a), *, key=None)

Ubicar el punto de inserción para `x' en `a' para mantener el ordenamiento. Los parámetros `lo' (inferior) y `hi' (superior) pueden utilizarse para especificar un subconjunto de la lista que debería considerarse; por defecto se utiliza la lista completa. Si `x' ya está presente en `a', el punto de inserción será antes (a la izquierda) de cualquier elemento existente. El valor de retorno es adecuado para que se utilice como primer parámetro para @code{list.insert()}, suponiendo que `a' ya está ordenada.

El punto de inserción retornado `ip' divide el arreglo `a' en dos partes, de modo que @code{all(elem < x for elem in a[lo : ip])} es verdadero para el lado izquierdo y @code{all(elem >= x for elem in a[ip : hi])} es verdadero para el lado derecho.

`key' especifica una @ref{e8a,,función clave} de un argumento que es usada para extraer una clave de comparación de cada elemento en el arreglo. La función clave no se aplica a `x' para facilitar la búsqueda de registros complejos.

Si `key' es @code{None}, los elementos se comparan directamente y ninguna función clave es llamada.


Distinto en la versión 3.10: Se agregó el parámetro `key'.

@end deffn

@geindex bisect_right() (en el módulo bisect)
@geindex bisect() (en el módulo bisect)
@anchor{library/bisect bisect bisect_right}@anchor{2537}
@deffn {Función} bisect.bisect_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect bisect}@anchor{2538}
@deffnx {Función} bisect.bisect (a, x, lo=0, hi=len(a), *, key=None)

Similar a @ref{2536,,bisect_left()}, pero retorna un punto de inserción que viene después (a la derecha) de cualquier entrada existente de `x' en `a'.

El punto de inserción retornado `ip' divide el arreglo `a' en dos partes, de modo que @code{all(elem  <= x for elem in a[lo : ip])} es verdadero para el lado izquierdo y @code{all(elem > x for elem in a[ip : hi])} es verdadero para el lado derecho.


Distinto en la versión 3.10: Se agregó el parámetro `key'.

@end deffn

@geindex insort_left() (en el módulo bisect)
@anchor{library/bisect bisect insort_left}@anchor{2539}
@deffn {Función} bisect.insort_left (a, x, lo=0, hi=len(a), *, key=None)

Inserte `x' en `a' en orden ordenado.

This function first runs @ref{2536,,bisect_left()} to locate an insertion point.
Next, it runs the @code{insert()} method on `a' to insert `x' at the
appropriate position to maintain sort order.

Para mantener la inserción de registros en una tabla, la función `key' (en caso de existir) se aplica a `x' en el paso de búsqueda pero no en el paso de inserción.

Keep in mind that the `O'(log `n') search is dominated by the slow `O'(`n')
insertion step.


Distinto en la versión 3.10: Se agregó el parámetro `key'.

@end deffn

@geindex insort_right() (en el módulo bisect)
@geindex insort() (en el módulo bisect)
@anchor{library/bisect bisect insort_right}@anchor{253a}
@deffn {Función} bisect.insort_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect insort}@anchor{253b}
@deffnx {Función} bisect.insort (a, x, lo=0, hi=len(a), *, key=None)

Similar a @ref{2539,,insort_left()}, pero inserta `x' en `a' después de cualquier entrada de `x' existente.

This function first runs @ref{2537,,bisect_right()} to locate an insertion point.
Next, it runs the @code{insert()} method on `a' to insert `x' at the
appropriate position to maintain sort order.

Para mantener la inserción de registros en una tabla, la función `key' (en caso de existir) se aplica a `x' en el paso de búsqueda pero no en el paso de inserción.

Keep in mind that the `O'(log `n') search is dominated by the slow `O'(`n')
insertion step.


Distinto en la versión 3.10: Se agregó el parámetro `key'.

@end deffn

@menu
* Notas de rendimiento:: 
* Búsqueda en listas ordenadas:: 
* Ejemplos: Ejemplos<3>. 

@end menu

@node Notas de rendimiento,Búsqueda en listas ordenadas,,bisect — Array bisection algorithm
@anchor{library/bisect performance-notes}@anchor{253c}
@subsubsection Notas de rendimiento


Al escribir código sensible al tiempo usando `bisect()' y `insort()', tenga en cuenta estos pensamientos:


@itemize *

@item 
La bisección es eficaz para buscar rangos de valores. Para localizar valores específicos, los diccionarios son más eficaces.

@item 
The `insort()' functions are `O'(`n') because the logarithmic search step
is dominated by the linear time insertion step.

@item 
Las funciones de búsqueda no tienen estado y descartan los resultados de las funciones clave después de ser usadas.  En consecuencia, si las funciones de búsqueda se utilizan en un bucle, la función clave se puede llamar una y otra vez en los mismos elementos del arreglo.  Si la función clave no es rápida, considere envolverla con @ref{253d,,functools.cache()} para evitar cálculos duplicados. Alternativamente, considere buscar un arreglo de claves precalculadas para ubicar el punto de inserción (como se muestra en la sección de ejemplos a continuación).
@end itemize


@subsubheading Ver también



@itemize *

@item 
Sorted Collections@footnote{https://grantjenks.com/docs/sortedcollections/} es un módulo de alto rendimiento que utiliza `bisect' para gestionar colecciones de datos ordenadas.

@item 
El SortedCollection recipe@footnote{https://code.activestate.com/recipes/577197-sortedcollection/} usa bisect para construir una clase de colección con todas las funciones con métodos de búsqueda sencillos y soporte para una función clave. Las claves se calculan previamente para ahorrar llamadas innecesarias a la función clave durante las búsquedas.
@end itemize


@node Búsqueda en listas ordenadas,Ejemplos<3>,Notas de rendimiento,bisect — Array bisection algorithm
@anchor{library/bisect searching-sorted-lists}@anchor{253e}
@subsubsection Búsqueda en listas ordenadas


Las @ref{2535,,bisect functions} anteriores son útiles para encontrar puntos de inserción, pero pueden resultar difíciles o engorrosas para tareas de búsqueda habituales. Las siguientes cinco funciones muestran cómo convertirlas en búsquedas estándar para listas ordenadas:

@example
def index(a, x):
    'Locate the leftmost value exactly equal to x'
    i = bisect_left(a, x)
    if i != len(a) and a[i] == x:
        return i
    raise ValueError

def find_lt(a, x):
    'Find rightmost value less than x'
    i = bisect_left(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_le(a, x):
    'Find rightmost value less than or equal to x'
    i = bisect_right(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_gt(a, x):
    'Find leftmost value greater than x'
    i = bisect_right(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

def find_ge(a, x):
    'Find leftmost item greater than or equal to x'
    i = bisect_left(a, x)
    if i != len(a):
        return a[i]
    raise ValueError
@end example

@node Ejemplos<3>,,Búsqueda en listas ordenadas,bisect — Array bisection algorithm
@anchor{library/bisect examples}@anchor{253f}
@subsubsection Ejemplos

@anchor{library/bisect bisect-example}@anchor{2540}
La función @ref{2538,,bisect()} puede ser útil para búsquedas en tablas numéricas. Este ejemplo utiliza @ref{2538,,bisect()} para buscar una calificación de un examen (digamos) dada por una letra, basándose en un conjunto de punto de corte numéricos ordenados: 90 o más es una “A”, de 80 a 89 es una “B”, y así sucesivamente:

@example
>>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'):
...     i = bisect(breakpoints, score)
...     return grades[i]
...
>>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
['F', 'A', 'C', 'C', 'B', 'A', 'A']
@end example

Las funciones @ref{2538,,bisect()} y @ref{253b,,insort()} también funcionan con listas de tuplas. El argumento `key' puede usarse para extraer el campo usado para ordenar registros en una tabla:

@example
>>> from collections import namedtuple
>>> from operator import attrgetter
>>> from bisect import bisect, insort
>>> from pprint import pprint

>>> Movie = namedtuple('Movie', ('name', 'released', 'director'))

>>> movies = [
...     Movie('Jaws', 1975, 'Spielberg'),
...     Movie('Titanic', 1997, 'Cameron'),
...     Movie('The Birds', 1963, 'Hitchcock'),
...     Movie('Aliens', 1986, 'Cameron')
... ]

>>> # Find the first movie released after 1960
>>> by_year = attrgetter('released')
>>> movies.sort(key=by_year)
>>> movies[bisect(movies, 1960, key=by_year)]
Movie(name='The Birds', released=1963, director='Hitchcock')

>>> # Insert a movie while maintaining sort order
>>> romance = Movie('Love Story', 1970, 'Hiller')
>>> insort(movies, romance, key=by_year)
>>> pprint(movies)
[Movie(name='The Birds', released=1963, director='Hitchcock'),
 Movie(name='Love Story', released=1970, director='Hiller'),
 Movie(name='Jaws', released=1975, director='Spielberg'),
 Movie(name='Aliens', released=1986, director='Cameron'),
 Movie(name='Titanic', released=1997, director='Cameron')]
@end example

Para evitar llamadas repetidas a la función clave, cuando ésta usa muchos recursos, se puede buscar en una lista de claves previamente calculadas para encontrar el índice de un registro:

@example
>>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
>>> data.sort(key=lambda r: r[1])       # Or use operator.itemgetter(1).
>>> keys = [r[1] for r in data]         # Precompute a list of keys.
>>> data[bisect_left(keys, 0)]
('black', 0)
>>> data[bisect_left(keys, 1)]
('blue', 1)
>>> data[bisect_left(keys, 5)]
('red', 5)
>>> data[bisect_left(keys, 8)]
('yellow', 8)
@end example

@node array — Efficient arrays of numeric values,weakref — Referencias débiles,bisect — Array bisection algorithm,Tipos de datos
@anchor{library/array doc}@anchor{2541}@anchor{library/array array-efficient-arrays-of-numeric-values}@anchor{2542}@anchor{library/array module-array}@anchor{8}
@subsection @code{array} — Efficient arrays of numeric values


@geindex module; array

@geindex arrays


__________________________________________________________________


This module defines an object type which can compactly represent an array of
basic values: characters, integers, floating-point numbers.  Arrays are sequence
types and behave very much like lists, except that the type of objects stored in
them is constrained.  The type is specified at object creation time by using a
`type code', which is a single character.  The following type codes are
defined:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Código de tipo

@tab

Tipo C

@tab

Tipo Python

@tab

Tamaño mínimo en bytes

@tab

Notas

@item

@code{'b'}

@tab

signed char

@tab

int

@tab

1

@tab

@item

@code{'B'}

@tab

unsigned char

@tab

int

@tab

1

@tab

@item

@code{'u'}

@tab

wchar_t

@tab

Carácter unicode

@tab

2

@tab

(1)

@item

@code{'w'}

@tab

Py_UCS4

@tab

Carácter unicode

@tab

4

@tab

@item

@code{'h'}

@tab

signed short

@tab

int

@tab

2

@tab

@item

@code{'H'}

@tab

unsigned short

@tab

int

@tab

2

@tab

@item

@code{'i'}

@tab

signed int

@tab

int

@tab

2

@tab

@item

@code{'I'}

@tab

unsigned int

@tab

int

@tab

2

@tab

@item

@code{'l'}

@tab

signed long

@tab

int

@tab

4

@tab

@item

@code{'L'}

@tab

unsigned long

@tab

int

@tab

4

@tab

@item

@code{'q'}

@tab

signed long long

@tab

int

@tab

8

@tab

@item

@code{'Q'}

@tab

unsigned long long

@tab

int

@tab

8

@tab

@item

@code{'f'}

@tab

float

@tab

float

@tab

4

@tab

@item

@code{'d'}

@tab

double

@tab

float

@tab

8

@tab

@end multitable


Notas:


@enumerate 

@item 
Puede ser de 16 bits o 32 bits según la plataforma.


Distinto en la versión 3.9: @code{array('u')} now uses @code{wchar_t} as C type instead of deprecated
@code{Py_UNICODE}. This change doesn’t affect its behavior because
@code{Py_UNICODE} is alias of @code{wchar_t} since Python 3.3.



Deprecated since version 3.3, will be removed in version 3.16: Please migrate to @code{'w'} typecode.

@end enumerate

The actual representation of values is determined by the machine architecture
(strictly speaking, by the C implementation).  The actual size can be accessed
through the @ref{2543,,array.itemsize} attribute.

The module defines the following item:

@geindex typecodes (en el módulo array)
@anchor{library/array array typecodes}@anchor{2544}
@deffn {Dato} array.typecodes

Una cadena de caracteres con todos los códigos de tipos disponible.
@end deffn

El módulo define los siguientes tipos:

@geindex array (clase en array)
@anchor{library/array array array}@anchor{308}
@deffn {Clase} array.array (typecode[, initializer])

A new array whose items are restricted by `typecode', and initialized
from the optional `initializer' value, which must be a @ref{325,,bytes}
or @ref{5e0,,bytearray} object, a Unicode string, or iterable over elements
of the appropriate type.

If given a @ref{325,,bytes} or @ref{5e0,,bytearray} object, the initializer
is passed to the new array’s @ref{12df,,frombytes()} method;
if given a Unicode string, the initializer is passed to the
@ref{2545,,fromunicode()} method;
otherwise, the initializer’s iterator is passed to the @ref{2546,,extend()} method
to add initial items to the array.

Los objetos tipo arreglo soportan operaciones de secuencia ordinarias de indexación, segmentación, concatenación y multiplicación . Cuando se utiliza segmentación, el valor asignado debe ser un arreglo con el mismo código de tipo, en todos los otros casos se lanza @ref{228,,TypeError}. Los arreglos también implementan una interfaz de buffer, y puede ser utilizada en cualquier momento cuando los objetos @ref{db4,,bytes-like objects} son soportados.

Lanza un @ref{18c3,,evento de auditoría} @code{array.__new__} con argumentos @code{typecode}, @code{initializer}.

@geindex typecode (atributo de array.array)
@anchor{library/array array array typecode}@anchor{2547}
@deffn {Atributo} typecode

El carácter typecode utilizado para crear el arreglo.
@end deffn

@geindex itemsize (atributo de array.array)
@anchor{library/array array array itemsize}@anchor{2543}
@deffn {Atributo} itemsize

La longitud en bytes de un elemento del arreglo en su representación interna.
@end deffn

@geindex append() (método de array.array)
@anchor{library/array array array append}@anchor{2548}
@deffn {Método} append (x)

Añade un nuevo elemento con valor `x' al final del arreglo.
@end deffn

@geindex buffer_info() (método de array.array)
@anchor{library/array array array buffer_info}@anchor{2549}
@deffn {Método} buffer_info ()

Return a tuple @code{(address, length)} giving the current memory address and the
length in elements of the buffer used to hold array’s contents.  The size of the
memory buffer in bytes can be computed as @code{array.buffer_info()[1] *
array.itemsize}.  This is occasionally useful when working with low-level (and
inherently unsafe) I/O interfaces that require memory addresses, such as certain
@code{ioctl()} operations.  The returned numbers are valid as long as the array
exists and no length-changing operations are applied to it.

@cartouche
@quotation Nota 
Cuando utilizamos objetos tipo arreglo escritos en C o C++ (la única manera de utilizar esta información de forma más efectiva), tiene más sentido utilizar interfaces buffer que soporten objetos del tipo arreglo. Este método es mantenido con retro compatibilidad y tiene que ser evitado en el nuevo código. Las interfaces de buffer son documentadas en @ref{48a,,Protocolo búfer}.
@end quotation
@end cartouche
@end deffn

@geindex byteswap() (método de array.array)
@anchor{library/array array array byteswap}@anchor{254a}
@deffn {Método} byteswap ()

«Byteswap» todos los elementos del arreglo. Solo es soportado para valores de tamaño 1,2,3,4 o 8 bytes; para otros valores se lanza @ref{1e5,,RuntimeError}. Es útil cuando leemos información de un fichero en una máquina con diferente orden de bytes.
@end deffn

@geindex count() (método de array.array)
@anchor{library/array array array count}@anchor{254b}
@deffn {Método} count (x)

Retorna el número de ocurrencias de `x' en el arreglo.
@end deffn

@geindex extend() (método de array.array)
@anchor{library/array array array extend}@anchor{2546}
@deffn {Método} extend (iterable)

Añade los elementos del `iterable' al final del arreglo. Si el `iterable' es de otro arreglo, este debe ser `exactamente' del mismo tipo; si no, se lanza @ref{228,,TypeError}. Si el `iterable' no es un arreglo, este debe de ser un iterable y sus elementos deben ser del tipo correcto para ser añadidos al arreglo.
@end deffn

@geindex frombytes() (método de array.array)
@anchor{library/array array array frombytes}@anchor{12df}
@deffn {Método} frombytes (buffer)

Appends items from the @ref{db4,,bytes-like object}, interpreting
its content as an array of machine values (as if it had been read
from a file using the @ref{254c,,fromfile()} method).


Added in version 3.2: @code{fromstring()} is renamed to @ref{12df,,frombytes()} for clarity.

@end deffn

@geindex fromfile() (método de array.array)
@anchor{library/array array array fromfile}@anchor{254c}
@deffn {Método} fromfile (f, n)

Lee `n' elementos (como valores de máquina) del @ref{1230,,file object} `f' y los añade al final del arreglo. Si hay menos de `n' elementos disponibles, se lanza @ref{1341,,EOFError}, pero los elementos que estaban disponibles todavía se insertan en el arreglo.
@end deffn

@geindex fromlist() (método de array.array)
@anchor{library/array array array fromlist}@anchor{254d}
@deffn {Método} fromlist (list)

Añade los elementos de la lista. Es equivalente a @code{for x in list: a.append(x)} excepto que si hay un error de tipo, el arreglo no se modifica.
@end deffn

@geindex fromunicode() (método de array.array)
@anchor{library/array array array fromunicode}@anchor{2545}
@deffn {Método} fromunicode (s)

Extends this array with data from the given Unicode string.
The array must have type code @code{'u'} or @code{'w'}; otherwise a @ref{360,,ValueError} is raised.
Use @code{array.frombytes(unicodestring.encode(enc))} to append Unicode data to an
array of some other type.
@end deffn

@geindex index() (método de array.array)
@anchor{library/array array array index}@anchor{877}
@deffn {Método} index (x[, start[, stop]])

Retorna el `i' más pequeño de modo que `i' es el índice de la primera aparición de `x' en el arreglo. Los argumentos opcionales `start' y `stop' pueden ser especificados para buscar `x' dentro de una subsección del arreglo. Lanza @ref{360,,ValueError} si no se encuentra `x'.


Distinto en la versión 3.10: Se agregaron parámetros opcionales `start' y `stop'.

@end deffn

@geindex insert() (método de array.array)
@anchor{library/array array array insert}@anchor{254e}
@deffn {Método} insert (i, x)

Inserta un nuevo elemento con valor `x' en el arreglo antes de la posición `i'. Si hay valores negativos son tratados como relativos a la posición final del arreglo.
@end deffn

@geindex pop() (método de array.array)
@anchor{library/array array array pop}@anchor{254f}
@deffn {Método} pop ([i])

Elimina el elemento con índice `i' del arreglo y lo retorna. El argumento opcional por defecto es @code{-1}, en caso de utilizar el argumento por defecto el ultimo elemento es eliminado y retornado.
@end deffn

@geindex remove() (método de array.array)
@anchor{library/array array array remove}@anchor{2550}
@deffn {Método} remove (x)

Elimina la primera ocurrencia de `x' del arreglo.
@end deffn

@geindex clear() (método de array.array)
@anchor{library/array array array clear}@anchor{30a}
@deffn {Método} clear ()

Remove all elements from the array.


Added in version 3.13.

@end deffn

@geindex reverse() (método de array.array)
@anchor{library/array array array reverse}@anchor{2551}
@deffn {Método} reverse ()

Invierte el orden de los elementos en el arreglo.
@end deffn

@geindex tobytes() (método de array.array)
@anchor{library/array array array tobytes}@anchor{12de}
@deffn {Método} tobytes ()

Convierte el arreglo en un arreglo de valores máquina y retorna una representación en formato de bytes (la misma secuencia de bytes que se deben escribir en un fichero por el método @ref{2552,,tofile()}.)


Added in version 3.2: @code{tostring()} is renamed to @ref{12de,,tobytes()} for clarity.

@end deffn

@geindex tofile() (método de array.array)
@anchor{library/array array array tofile}@anchor{2552}
@deffn {Método} tofile (f)

Escribe todos los elementos (incluido elementos máquina) a el @ref{1230,,file object} `f'.
@end deffn

@geindex tolist() (método de array.array)
@anchor{library/array array array tolist}@anchor{2553}
@deffn {Método} tolist ()

Convierte el arreglo a una lista ordinaria con los mismos elementos.
@end deffn

@geindex tounicode() (método de array.array)
@anchor{library/array array array tounicode}@anchor{2554}
@deffn {Método} tounicode ()

Convert the array to a Unicode string.  The array must have a type @code{'u'} or @code{'w'};
otherwise a @ref{360,,ValueError} is raised. Use @code{array.tobytes().decode(enc)} to
obtain a Unicode string from an array of some other type.
@end deffn
@end deffn

The string representation of array objects has the form
@code{array(typecode, initializer)}.
The `initializer' is omitted if the array is empty, otherwise it is
a Unicode string if the `typecode' is @code{'u'} or @code{'w'}, otherwise it is
a list of numbers.
The string representation is guaranteed to be able to be converted back to an
array with the same type and value using @ref{2eb,,eval()}, so long as the
@ref{308,,array} class has been imported using @code{from array import array}.
Variables @code{inf} and @code{nan} must also be defined if it contains
corresponding floating-point values.
Examples:

@example
array('l')
array('w', 'hello \u2641')
array('l', [1, 2, 3, 4, 5])
array('d', [1.0, 2.0, 3.14, -inf, nan])
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{d5,,struct}

Empaquetado y desempaquetado de datos binarios heterogéneos.

@item NumPy@footnote{https://numpy.org/}

El paquete NumPy define otro tipo de arreglo.
@end table


@node weakref — Referencias débiles,types — Dynamic type creation and names for built-in types,array — Efficient arrays of numeric values,Tipos de datos
@anchor{library/weakref doc}@anchor{2555}@anchor{library/weakref mod-weakref}@anchor{f8d}@anchor{library/weakref module-weakref}@anchor{114}@anchor{library/weakref weakref-weak-references}@anchor{2556}
@subsection @code{weakref} — Referencias débiles


@geindex module; weakref

`Código Fuente:' Lib/weakref.py@footnote{https://github.com/python/cpython/tree/main/Lib/weakref.py}


__________________________________________________________________


El módulo @ref{114,,weakref} le permite al programador de Python crear `referencias débiles<weak references>' a objetos.

@c When making changes to the examples in this file, be sure to update
@c Lib/test/test_weakref.py::libreftest too!

En lo consecutivo, el término `referente' aludirá al objeto que es referenciado por una referencia débil.

Una referencia débil a un objeto no es suficiente para mantener al objeto con vida: cuando las únicas referencias que le queden a un referente son referencias débiles, la (@ref{1922,,recolección de basura}) es libre de destruir al referente y reusar su memoria para algo más.  Sin embargo, hasta que el objeto no sea realmente destruido, la referencia débil puede retornar el objeto incluso si no tiene referencias fuertes.

Un uso principal para las referencias débiles es para implementar caches o mapeados que mantienen objetos grandes, cuando no se desea que un objeto grande no sea mantenido con vida sólo porque aparece en un cache o mapeado.

Por ejemplo, si tienes un número de grandes objetos de imágenes binarias, puedes desear asociar un nombre con cada uno. Si usaras un diccionario de Python para mapear los nombres a imágenes, o imágenes a nombres, los objetos imagen quedarían con vida sólo porque aparecen como valores o llaves en los diccionarios.  Las clases @ref{15be,,WeakKeyDictionary} y @ref{15bf,,WeakValueDictionary} que se proporcionan por el módulo @ref{114,,weakref} son una alternativa, usando referencias débiles para construir mapeados que no mantengan con vida el objeto sólo porque aparecen en el mapeado de objetos.  Si, por ejemplo, un objeto imagen es un valor en un @ref{15bf,,WeakValueDictionary}, entonces cuando las últimas referencias que queden de ese objeto imagen sean las referencias débiles guardadas por mapeados débiles, la recolección de basura puede reclamar el objeto, y sus entradas correspondientes en mapeados débiles son simplemente eliminadas.

@ref{15be,,WeakKeyDictionary} y @ref{15bf,,WeakValueDictionary} usan referencias débiles en sus implementaciones, estableciendo retrollamadas (`callback') en las referencias débiles que notifiquen a los diccionarios débiles cuando una llave o valor ha sido reclamado por la recolección de basura. @ref{67e,,WeakSet} implementa la interfaz @ref{67a,,set}, pero mantiene referencias débiles de sus elementos, justo como lo hace @ref{15be,,WeakKeyDictionary}.

@ref{b09,,finalize} provee una forma directa de registrar una función de limpieza que se llame cuando un objeto es recogido por la recolección de basura. Esto es más simple que configurar una retrollamada en una referencia débil pura, ya que el módulo automáticamente se asegura que el finalizador se mantenga con vida hasta que el objeto sea recolectado.

La mayoría de programas deben descubrir que usar uno de estos tipos de contenedores débiles o la clase @ref{b09,,finalize} es todo lo que necesitan – usualmente no es necesario crear tus propias referencias débiles directamente.  La maquinaria de bajo nivel está expuesta por el módulo @ref{114,,weakref} para el beneficio de usuarios avanzados.

No todos los objetos pueden ser débilmente referenciados. Objetos que soportan referencias débiles pueden incluir instancias de clases, funciones escritas en Python (pero no en C), métodos de instancia, conjuntos, frozensets, algunos @ref{1230,,objetos archivo}, @ref{10dd,,generadores}, objetos de tipo, sockets, arreglos, deques, objetos de patrones de expresiones regulares, y objetos código.


Distinto en la versión 3.2: Se añadió el soporte para thread.lock, threading.Lock, y objetos código.


Varios tipos incorporados como @ref{18e,,list} y @ref{190,,dict} no soportan directamente referencias débiles pero pueden añadir soporte al crear una subclase:

@example
class Dict(dict):
    pass

obj = Dict(red=1, green=2, blue=3)   # this object is weak referenceable
@end example

`Detalles de implementación de CPython:' Otros tipos incorporados como @ref{464,,tuple} y @ref{1f0,,int} no soportan referencias débiles incluso cuando son usadas como clase base.

Los tipos de extensiones se pueden hacer para soportar referencias débiles; véase @ref{2557,,Soporte de referencia débil}.

Cuando @code{__slots__} es definido para un tipo específico, el soporte para referencia débil es deshabilitado a menos que una cadena @code{'__weakref__'} también esté presente en la secuencia de cadenas en la declaración @code{__slots__}. Véase @ref{1f31,,__slots__ documentation} para más detalles.

@geindex ref (clase en weakref)
@anchor{library/weakref weakref ref}@anchor{106d}
@deffn {Clase} weakref.ref (object[, callback])

Retorna una referencia débil de `object'.  El objeto original puede ser recuperado al llamar la referencia del objeto si el referente sigue con vida; si el referente ya no está con vida, llamar a la  referencia del objeto causará que se retorne un @ref{716,,None}.  Si se proporciona `callback' y no @ref{716,,None}, y el objeto weakref retornado aún sigue con vida, la retrollamada (`callback') será llamado cuando el objeto esté a punto de ser finalizado; el objeto de la referencia débil será pasado como el único parámetro a la retrollamada, el referente ya no estará disponible.

Se permite que muchas referencias débiles sean construidas por el mismo objeto. Las retrollamadas registradas por cada referencia débil serán llamados desde la retrollamada registrada más recientemente hasta la retrollamada registrada más antigua.

Las excepciones lanzadas por la retrollamada serán visibles en la salida de error estándar pero no pueden ser propagadas; son manejadas de la misma forma que las excepciones lanzadas por el método @ref{1f60,,__del__()} de un objeto.

Las referencias débiles son @ref{6b1,,hashable} si el `object' es mapeable.  Ellos mantendrán su valor del hash incluso cuando el `objet' haya sido eliminado.  Si @ref{68b,,hash()} es llamado por primera vez sólo después de que `object' sea eliminado, la llamada lanzará un @ref{228,,TypeError}.

Las referencias débiles soportan pruebas para igualdad, pero no para ordenación.  Si los referentes están todavía con vida, dos referencias tiene la misma relación de igualdad como sus referentes (sin importar el `callback').  Si un referente ha sido eliminado, las referencias son iguales sólo si el objetos de referencia son el mismo objeto.

Es un tipo del que se puede crear una subclase en vez de una función de fábrica.

@geindex __callback__ (atributo de weakref.ref)
@anchor{library/weakref weakref ref __callback__}@anchor{106e}
@deffn {Atributo} __callback__

Este atributo de sólo lectura retorna la llamada que está asociada actualmente con el weakref.  Si no hay retrollamadas o si el referente del weakref no está con vida entonces este atributo tendrá de valor @code{None}.
@end deffn


Distinto en la versión 3.4: Se añadió el atributo @ref{106e,,__callback__}.

@end deffn

@geindex proxy() (en el módulo weakref)
@anchor{library/weakref weakref proxy}@anchor{189b}
@deffn {Función} weakref.proxy (object[, callback])

Retorna un proxy a `object' que usa una referencia débil.  Esto soporta el uso del proxy en la mayoría de los contextos en vez de requerir la dereferencia explícita usada con los objetos de referencia débil. El objeto retornado tendrá un tipo @code{ProxyType} o @code{CallableProxyType}, dependiendo si `object' es invocable. Objetos Proxy no son @ref{6b1,,hashable} independiente de la referencia; esto evita un número de problemas relacionados a su naturaleza mutable fundamental, y evita su uso como clave de diccionario. `callback' corresponde al parámetro del mismo nombre de la función @ref{106d,,ref()}.

Acceder al atributo de un objeto proxy después de que el objeto referenciado haya sido recolectado por el recolector de basura lanza @ref{154f,,ReferenceError}.


Distinto en la versión 3.8: Se extendió el soporto de operadores en objetos proxy para incluir los operadores de multiplicación de matrices @code{@@} and @code{@@=}.

@end deffn

@geindex getweakrefcount() (en el módulo weakref)
@anchor{library/weakref weakref getweakrefcount}@anchor{2558}
@deffn {Función} weakref.getweakrefcount (object)

Retorna el número de referencias débiles y proxies que refieren a `object'.
@end deffn

@geindex getweakrefs() (en el módulo weakref)
@anchor{library/weakref weakref getweakrefs}@anchor{2559}
@deffn {Función} weakref.getweakrefs (object)

Retorna una lista de todas las referencias débiles y objetos proxy que refieren a `object'.
@end deffn

@geindex WeakKeyDictionary (clase en weakref)
@anchor{library/weakref weakref WeakKeyDictionary}@anchor{15be}
@deffn {Clase} weakref.WeakKeyDictionary ([dict])

Clase de mapeado que referencia llaves débilmente.  Las entradas en el diccionario serán descartadas cuando no haya una referencia fuerte a la llave.  Esto puede ser usado para asociar datos con un objeto apropiado por otras partes de una aplicación sin añadir atributos a esos objetos.  Esto puede ser especialmente útil con objetos que sobre escriben atributos de acceso.

Nótese que cuando una clave cuyo valor es igual a una clave ya existente (pero no tienen igual identidad) es insertado en el diccionario, el valor es reemplazado pero no se reemplaza la clave existente. Debido a esto, cuando la referencia a la clave original es eliminada, se elimina la entrada en el diccionario:

@example
>>> class T(str): pass
...
>>> k1, k2 = T(), T()
>>> d = weakref.WeakKeyDictionary()
>>> d[k1] = 1   # d = @{k1: 1@}
>>> d[k2] = 2   # d = @{k1: 2@}
>>> del k1      # d = @{@}
@end example

Una solución alternativa sería remover la clave antes de la reasignación:

@example
>>> class T(str): pass
...
>>> k1, k2 = T(), T()
>>> d = weakref.WeakKeyDictionary()
>>> d[k1] = 1   # d = @{k1: 1@}
>>> del d[k1]
>>> d[k2] = 2   # d = @{k2: 2@}
>>> del k1      # d = @{k2: 2@}
@end example


Distinto en la versión 3.9: Se agregó soporte para los operadores @code{|} y @code{|=}, como se especifica en 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

Los objetos @ref{15be,,WeakKeyDictionary} tiene un método adicional que expone las referencias internas directamente.  Las referencias no tienen garantía de estar con «vida» en el momento en que son usadas, por lo que el resultado de llamar las referencias necesita ser revisado antes de ser usado. Esto puede ser usado para evitar crear referencias que causen que recolector de basura mantenga las llaves en existencia más tiempo del que necesitan.

@geindex keyrefs() (método de weakref.WeakKeyDictionary)
@anchor{library/weakref weakref WeakKeyDictionary keyrefs}@anchor{255a}
@deffn {Método} WeakKeyDictionary.keyrefs ()

Retorna un iterable de las referencias débiles a las llaves.
@end deffn

@geindex WeakValueDictionary (clase en weakref)
@anchor{library/weakref weakref WeakValueDictionary}@anchor{15bf}
@deffn {Clase} weakref.WeakValueDictionary ([dict])

Clase de mapeado que referencia valores débilmente.  Las entradas en el diccionario serán descartadas cuando ya no existan las referencias fuertes a los valores.


Distinto en la versión 3.9: Se agregó soporte para los operadores @code{|} y @code{|=}, como se especifica en 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

Los objetos @ref{15bf,,WeakValueDictionary} tienen un método adicional que posee los mismos problemas que el método @ref{255a,,WeakKeyDictionary.keyrefs()}.

@geindex valuerefs() (método de weakref.WeakValueDictionary)
@anchor{library/weakref weakref WeakValueDictionary valuerefs}@anchor{255b}
@deffn {Método} WeakValueDictionary.valuerefs ()

Retorna un iterable de las referencias débiles a los valores.
@end deffn

@geindex WeakSet (clase en weakref)
@anchor{library/weakref weakref WeakSet}@anchor{67e}
@deffn {Clase} weakref.WeakSet ([elements])

Clase Conjunto que mantiene referencias débiles a sus elementos.  Un elemento será descartado cuando ya no existan referencias fuertes.
@end deffn

@geindex WeakMethod (clase en weakref)
@anchor{library/weakref weakref WeakMethod}@anchor{106c}
@deffn {Clase} weakref.WeakMethod (method[, callback])

Una subclase @ref{106d,,ref} personalizada que simula una referencia débil a un método vinculado (i.e., un método definido en una clase y visto en una instancia). Ya que un método atado es efímero, una referencia débil estándar no puede mantenerlo.  El @ref{106c,,WeakMethod} tiene un código especial para recrear el método atado hasta que o el objeto o la función original muera:

@example
>>> class C:
...     def method(self):
...         print("method called!")
...
>>> c = C()
>>> r = weakref.ref(c.method)
>>> r()
>>> r = weakref.WeakMethod(c.method)
>>> r()
<bound method C.method of <__main__.C object at 0x7fc859830220>>
>>> r()()
method called!
>>> del c
>>> gc.collect()
0
>>> r()
>>>
@end example

`callback' corresponde al parámetro del mismo nombre de la función @ref{106d,,ref()}.


Added in version 3.4.

@end deffn

@geindex finalize (clase en weakref)
@anchor{library/weakref weakref finalize}@anchor{b09}
@deffn {Clase} weakref.finalize (obj, func, /, *args, **kwargs)

Retorna un objeto finalizador invocable que será llamado cuando `obj' sea recolectado por el recolector de basura. A diferencia de referencias débiles ordinarias, un finalizador siempre sobrevivirá hasta que el objeto de referencia sea recolectado, simplificando enormemente la gestión del ciclo de vida.

Se considera a un finalizador como `vivo' hasta que sea llamado (o explícitamente o en la recolección de basura), y después que esté `muerto'.  Llamar a un finalizador vivo retorna el resultado de evaluar @code{func(*arg, **kwargs)}, mientras que llamar a un finalizador muerto retorna @ref{716,,None}.

Las excepciones lanzadas por retrollamadas de finalizadores durante la recolección de basura serán mostradas en la salida de error estándar, pero no pueden ser propagadas.  Son gestionados de la misma forma que las excepciones lanzadas por el método @ref{1f60,,__del__()} de un objeto o la retrollamada de una referencia débil.

Cuando el programa sale, cada finalizador vivo que quede es llamado a menos que su atributo @ref{d,,atexit} sea falso.  Son llamados en el orden reverso de creación.

Un finalizador nunca invocará su retrollamada durante la última parte del @ref{2bb,,apagado del intérprete} cuando las variables globales del módulo (globals) están sujetos a ser reemplazados por @ref{716,,None}.

@geindex __call__() (método de weakref.finalize)
@anchor{library/weakref weakref finalize __call__}@anchor{255c}
@deffn {Método} __call__ ()

Si `self' está vivo entonces lo marca como muerto y retorna el resultado de llamar a @code{func(*args, **kwargs)}.  Si `self' está muerto entonces retorna @ref{716,,None}.
@end deffn

@geindex detach() (método de weakref.finalize)
@anchor{library/weakref weakref finalize detach}@anchor{255d}
@deffn {Método} detach ()

Si `self' está vivo entonces lo marca como muerto y retorna la tupla @code{(obj, func, args, kwargs)}.  Si `self' está muerto entonces retorna @ref{716,,None}.
@end deffn

@geindex peek() (método de weakref.finalize)
@anchor{library/weakref weakref finalize peek}@anchor{255e}
@deffn {Método} peek ()

Si `self' está vivo entonces retorna la tupla @code{(obj, func, args, kwargs)}.  Si `self' está muerto entonces retorna @ref{716,,None}.
@end deffn

@geindex alive (atributo de weakref.finalize)
@anchor{library/weakref weakref finalize alive}@anchor{255f}
@deffn {Atributo} alive

Propiedad que es verdadera si el finalizador está vivo, caso contrario, falso.
@end deffn

@geindex atexit (atributo de weakref.finalize)
@anchor{library/weakref weakref finalize atexit}@anchor{2560}
@deffn {Atributo} atexit

Una propiedad booleana con permisos de escritura que por defecto es verdadero.  Cuando el programa sale, llama a todos los finalizadores vivos que queden para los cuales @ref{2560,,atexit} es verdadero.  Ellos son llamados en el orden reverso de creación.
@end deffn

@cartouche
@quotation Nota 
Es importante asegurar que `func', `args' y `kwargs' no sean dueños de ninguna referencia a `obj', o directamente o indirectamente, ya que de otra manera `obj' nunca será recolectado por el recolector de basura.  En particular, `func' no debe ser un método vinculado de `obj'.
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex ReferenceType (en el módulo weakref)
@anchor{library/weakref weakref ReferenceType}@anchor{17da}
@deffn {Dato} weakref.ReferenceType

El objeto de tipo para objetos de referencias débiles.
@end deffn

@geindex ProxyType (en el módulo weakref)
@anchor{library/weakref weakref ProxyType}@anchor{17db}
@deffn {Dato} weakref.ProxyType

El objeto de tipo para proxies de objetos que no son invocables.
@end deffn

@geindex CallableProxyType (en el módulo weakref)
@anchor{library/weakref weakref CallableProxyType}@anchor{17dc}
@deffn {Dato} weakref.CallableProxyType

El objeto de tipo para proxies de objetos invocables.
@end deffn

@geindex ProxyTypes (en el módulo weakref)
@anchor{library/weakref weakref ProxyTypes}@anchor{2561}
@deffn {Dato} weakref.ProxyTypes

Una secuencia que contiene todos los objetos de tipo para los proxies. Esto puede hacerlo más simple para pruebas si un objeto es un proxy sin ser dependiente en nombrar a ambos tipos proxy.
@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - Referencias Débiles

La propuesta y lógica de esta característica, incluyendo los enlaces a implementaciones tempranas e información acerca de características similares en otros lenguajes.
@end table


@menu
* Objetos de referencias débiles:: 
* Ejemplo: Ejemplo<2>. 
* Objetos finalizadores:: 
* Comparando finalizadores con los métodos __del__(): Comparando finalizadores con los métodos __del__. 

@end menu

@node Objetos de referencias débiles,Ejemplo<2>,,weakref — Referencias débiles
@anchor{library/weakref weak-reference-objects}@anchor{2562}@anchor{library/weakref weakref-objects}@anchor{2563}
@subsubsection Objetos de referencias débiles


Los objetos de referencias débiles no tiene métodos y atributos aparte de @code{ref.__calback__}. Un objeto de referencia débil permite que el referente sea obtenido, si todavía existe, al llamarlo:

@example
>>> import weakref
>>> class Object:
...     pass
...
>>> o = Object()
>>> r = weakref.ref(o)
>>> o2 = r()
>>> o is o2
True
@end example

Si el referente no existe, llamar al objeto de referencia retorna @ref{716,,None}:

@example
>>> del o, o2
>>> print(r())
None
@end example

Probar que un objeto de referencia débil está todavía con vida debe ser hecho usando la expresión @code{ref() is not None}.  Normalmente, el código de aplicación que necesite usar un objeto de referencia debe seguir este patrón:

@example
# r is a weak reference object
o = r()
if o is None:
    # referent has been garbage collected
    print("Object has been deallocated; can't frobnicate.")
else:
    print("Object is still live!")
    o.do_something_useful()
@end example

Usar una prueba separada para «vivacidad» crea una condición de carrera en aplicaciones con hilos; otro hilo puede hacer que una referencia débil sea invalidada antes de que la referencia débil sea llamada; El modismo mostrado arriba es seguro en aplicaciones con hilos también como aplicaciones de un sólo hilo.

Versiones especializadas de objetos @ref{106d,,ref} pueden ser creadas a través de creación por subclase. Esto es usado en la implementación de @ref{15bf,,WeakValueDictionary} para reducir la memoria elevada por cada entrada en el mapeado.  Esto puede ser lo más útil para asociar información adicional con un referencia, pero también puede ser usado para insertar procesamiento adicional en llamadas para recuperar el referente.

Este ejemplo muestra como una subclase de @ref{106d,,ref} puede ser usado para guardar información adicional sobre un objeto y afectar el valor que se retorna cuando el referente es accedido:

@example
import weakref

class ExtendedRef(weakref.ref):
    def __init__(self, ob, callback=None, /, **annotations):
        super().__init__(ob, callback)
        self.__counter = 0
        for k, v in annotations.items():
            setattr(self, k, v)

    def __call__(self):
        """Return a pair containing the referent and the number of
        times the reference has been called.
        """
        ob = super().__call__()
        if ob is not None:
            self.__counter += 1
            ob = (ob, self.__counter)
        return ob
@end example

@node Ejemplo<2>,Objetos finalizadores,Objetos de referencias débiles,weakref — Referencias débiles
@anchor{library/weakref example}@anchor{2564}@anchor{library/weakref weakref-example}@anchor{2565}
@subsubsection Ejemplo


Este simple ejemplo muestra como una aplicación puede usar objetos ID para recuperar objetos que han sido visto antes.  Los ID de los objetos pueden ser usados en otras estructuras de datos sin forzar que los objetos permanezcan con vida, pero los objetos pueden aún pueden ser recuperados por el ID si lo hacen.

@c Example contributed by Tim Peters.

@example
import weakref

_id2obj_dict = weakref.WeakValueDictionary()

def remember(obj):
    oid = id(obj)
    _id2obj_dict[oid] = obj
    return oid

def id2obj(oid):
    return _id2obj_dict[oid]
@end example

@node Objetos finalizadores,Comparando finalizadores con los métodos __del__,Ejemplo<2>,weakref — Referencias débiles
@anchor{library/weakref finalize-examples}@anchor{2566}@anchor{library/weakref finalizer-objects}@anchor{2567}
@subsubsection Objetos finalizadores


El principal beneficio de usar @ref{b09,,finalize} es que hace simple registrar una retrollamada sin necesitar preservar el objeto finalizador retornado.  Por ejemplo

@example
>>> import weakref
>>> class Object:
...     pass
...
>>> kenny = Object()
>>> weakref.finalize(kenny, print, "You killed Kenny!")  
<finalize object at ...; for 'Object' at ...>
>>> del kenny
You killed Kenny!
@end example

El finalizador puede ser llamado directamente también.  Sin embargo, el finalizador invocará la retrollamada como máximo una vez.

@example
>>> def callback(x, y, z):
...     print("CALLBACK")
...     return x + y + z
...
>>> obj = Object()
>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
>>> assert f.alive
>>> assert f() == 6
CALLBACK
>>> assert not f.alive
>>> f()                     # callback not called because finalizer dead
>>> del obj                 # callback not called because finalizer dead
@end example

Puedes de-registrar un finalizador usando su método @ref{255d,,detach()}. Esto mata el finalizador y retorna los argumentos pasados al constructor cuando fue creado.

@example
>>> obj = Object()
>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
>>> f.detach()                                           
(<...Object object ...>, <function callback ...>, (1, 2), @{'z': 3@})
>>> newobj, func, args, kwargs = _
>>> assert not f.alive
>>> assert newobj is obj
>>> assert func(*args, **kwargs) == 6
CALLBACK
@end example

A menos que pongas el atributo @ref{2560,,atexit} a @ref{bbf,,False}, un finalizador será llamado cuando el programa salga si todavía está con vida.  Por ejemplo

@example
>>> obj = Object()
>>> weakref.finalize(obj, print, "obj dead or exiting")
<finalize object at ...; for 'Object' at ...>
>>> exit()
obj dead or exiting
@end example

@node Comparando finalizadores con los métodos __del__,,Objetos finalizadores,weakref — Referencias débiles
@anchor{library/weakref comparing-finalizers-with-del-methods}@anchor{2568}
@subsubsection Comparando finalizadores con los métodos @code{__del__()}


Suponga que queremos crear una clase cuyas instancias representan directorios temporales.  Los directorios deben ser eliminados con sus contenidos cuando el primero de los siguiente eventos ocurre:


@itemize *

@item 
el objeto es recolectado por el recolector de basura,

@item 
el método @code{remove()} del objeto es llamado, o

@item 
el programa sale.
@end itemize

Podemos intentar implementar la clase usando un método @ref{1f60,,__del__()} como se muestra a continuación:

@example
class TempDir:
    def __init__(self):
        self.name = tempfile.mkdtemp()

    def remove(self):
        if self.name is not None:
            shutil.rmtree(self.name)
            self.name = None

    @@property
    def removed(self):
        return self.name is None

    def __del__(self):
        self.remove()
@end example

A partir de Python 3.4, los métodos @ref{1f60,,__del__()} ya no impiden que los ciclos de referencia sean recolectados como basura y las variables globales del módulo (globals) ya no son forzados a @ref{716,,None} durante el @ref{2bb,,apagado del intérprete}. Por lo tanto, este código debería funcionar sin ningún problema en CPython.

Sin embargo, la gestión de métodos @ref{1f60,,__del__()} es notoriamente específica a la implementación, ya que depende de detalles internos de la implementación del recolector de basura del intérprete.

Una alternativa más robusta puede ser para definir un finalizador que sólo hace referencia a funciones específicas y objetos que necesite, en vez de tener acceso al estado completo del objeto:

@example
class TempDir:
    def __init__(self):
        self.name = tempfile.mkdtemp()
        self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)

    def remove(self):
        self._finalizer()

    @@property
    def removed(self):
        return not self._finalizer.alive
@end example

Definido así, nuestro finalizador sólo recibe una referencia a los detalles que necesita limpiar los directorios apropiadamente. Si el objeto nueva llega a ser recolectado como basura el finalizador aún será llamado al salir.

La otra ventaja de weakref basados en finalizadores es que ellos pueden ser usados para registrar finalizadores para clases donde la definición es controlado por terceros, como un código que corre cuando un módulo es descargado:

@example
import weakref, sys
def unloading_module():
    # implicit reference to the module globals from the function body
weakref.finalize(sys.modules[__name__], unloading_module)
@end example

@cartouche
@quotation Nota 
Si creas un objeto finalizador en un hilo daemon sólo como el programa sale entonces hay la posibilidad de que el finalizador no llegue a ser llamado. Sin embargo, en un hilo daemonic @ref{915,,atexit.register()}, @code{try: ... finally: ...} y @code{with: ...} no garantizan que la limpieza ocurra tampoco.
@end quotation
@end cartouche

@node types — Dynamic type creation and names for built-in types,copy — Shallow and deep copy operations,weakref — Referencias débiles,Tipos de datos
@anchor{library/types doc}@anchor{2569}@anchor{library/types module-types}@anchor{103}@anchor{library/types types-dynamic-type-creation-and-names-for-built-in-types}@anchor{256a}
@subsection @code{types} — Dynamic type creation and names for built-in types


@geindex module; types

`Código fuente:' Lib/types.py@footnote{https://github.com/python/cpython/tree/main/Lib/types.py}


__________________________________________________________________


Este módulo define funciones de utilidad para ayudar en la creación dinámica de tipos nuevos.

Este también define nombres para algunos tipos de objetos que son utilizados por el intérprete estándar de Python, pero no expuestos como integrados como lo son @ref{1f0,,int} o @ref{237,,str}.

Por último, este proporciona algunas clases de utilidad y funciones adicionales relacionadas con tipos que no son lo suficientemente fundamentales como para ser integradas.

@menu
* Creación dinámica de tipos:: 
* Tipos de Intérpretes Estándar:: 
* Clases y funciones de utilidad adicionales:: 
* Funciones de utilidad de corutina:: 

@end menu

@node Creación dinámica de tipos,Tipos de Intérpretes Estándar,,types — Dynamic type creation and names for built-in types
@anchor{library/types dynamic-type-creation}@anchor{256b}
@subsubsection Creación dinámica de tipos


@geindex new_class() (en el módulo types)
@anchor{library/types types new_class}@anchor{11d2}
@deffn {Función} types.new_class (name, bases=(), kwds=None, exec_body=None)

Crea un objeto de clase dinámicamente utilizando la metaclase adecuada.

Los tres primeros argumentos son los componentes que componen un encabezado de definición de clase: el nombre de la clase, las clases base (en orden), los argumentos por palabra clave (tal como @code{metaclass}).

El argumento `exec_body' es una retrollamada que se usa para rellenar el espacio de nombres de clase recién creado. Debe aceptar el espacio de nombre de clase como su único argumento y actualizar el espacio de nombres directamente con el contenido de la clase. Si no se proporciona ninguna retrollamada, tiene el mismo efecto que pasar @code{lambda ns: None}.


Added in version 3.3.

@end deffn

@geindex prepare_class() (en el módulo types)
@anchor{library/types types prepare_class}@anchor{11d3}
@deffn {Función} types.prepare_class (name, bases=(), kwds=None)

Calcula la metaclase adecuada y crea el espacio de nombre de clase.

Los argumentos son los componentes que constituyen un encabezado de definición de clase: el nombre de la clase, las clases base (en orden) y los argumentos de palabra clave (como @code{metaclass}).

El valor retornado es una tupla de 3: @code{metaclass, namespace, kwds}

`metaclass' es la metaclase adecuada, `namespace' es el espacio de nombre de clase preparado y `kwds' es una copia actualizada del pasado en el argumento `kwds' con cualquier entrada @code{'metaclass'} eliminada. Si no se pasa ningún argumento `kwds', será un diccionario vacío.


Added in version 3.3.



Distinto en la versión 3.6: El valor predeterminado para el elemento @code{namespace} de la tupla retornada ha cambiado.  Ahora una asignación de inserción-orden-conservación es utilizada cuando la metaclase no tiene un método @code{__prepare__}.

@end deffn


@subsubheading Ver también



@table @asis

@item @ref{1f73,,Metaclases}

Detalles completos del proceso de creación de clases soportado por estas funciones

@geindex Python Enhancement Proposals; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclases en Python 3000

Se presenta el `hook' de espacio de nombres @code{__prepare__}
@end table


@geindex resolve_bases() (en el módulo types)
@anchor{library/types types resolve_bases}@anchor{c24}
@deffn {Función} types.resolve_bases (bases)

Resuelve las entradas MRO dinámicamente según lo especificado por 
@geindex Python Enhancement Proposals; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}.

This function looks for items in `bases' that are not instances of
@ref{dcf,,type}, and returns a tuple where each such object that has
an @ref{1f75,,__mro_entries__()} method is replaced with an unpacked result of
calling this method.  If a `bases' item is an instance of @ref{dcf,,type},
or it doesn’t have an @code{__mro_entries__()} method, then it is included in
the return tuple unchanged.


Added in version 3.7.

@end deffn

@geindex get_original_bases() (en el módulo types)
@anchor{library/types types get_original_bases}@anchor{575}
@deffn {Función} types.get_original_bases (cls, /)

Return the tuple of objects originally given as the bases of `cls' before
the @ref{1f75,,__mro_entries__()} method has been called on any bases
(following the mechanisms laid out in 
@geindex Python Enhancement Proposals; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}). This is useful for
introspecting @ref{576,,Generics}.

For classes that have an @code{__orig_bases__} attribute, this
function returns the value of @code{cls.__orig_bases__}.
For classes without the @code{__orig_bases__} attribute,
@ref{14e8,,cls.__bases__} is returned.

Examples:

@example
from typing import TypeVar, Generic, NamedTuple, TypedDict

T = TypeVar("T")
class Foo(Generic[T]): ...
class Bar(Foo[int], float): ...
class Baz(list[str]): ...
Eggs = NamedTuple("Eggs", [("a", int), ("b", str)])
Spam = TypedDict("Spam", @{"a": int, "b": str@})

assert Bar.__bases__ == (Foo, float)
assert get_original_bases(Bar) == (Foo[int], float)

assert Baz.__bases__ == (list,)
assert get_original_bases(Baz) == (list[str],)

assert Eggs.__bases__ == (tuple,)
assert get_original_bases(Eggs) == (NamedTuple,)

assert Spam.__bases__ == (dict,)
assert get_original_bases(Spam) == (TypedDict,)

assert int.__bases__ == (object,)
assert get_original_bases(int) == (object,)
@end example


Added in version 3.12.

@end deffn


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/} - Soporte principal para módulos de tipo y tipos genéricos


@node Tipos de Intérpretes Estándar,Clases y funciones de utilidad adicionales,Creación dinámica de tipos,types — Dynamic type creation and names for built-in types
@anchor{library/types standard-interpreter-types}@anchor{256c}
@subsubsection Tipos de Intérpretes Estándar


Este módulo proporciona nombres para muchos de los tipos necesarios para implementar un intérprete de Python. Esto evita deliberadamente incluir algunos de los tipos que surgen sólo accidentalmente durante el procesamiento, tal como el tipo @code{listiterator}.

El uso típico de estos nombres es para verificar @ref{4ef,,isinstance()} o @ref{85a,,issubclass()}.

Si se crea una instancia de cualquiera de estos tipos, tenga en cuenta que las firmas pueden variar entre las versiones de Python.

Los nombres estándar son definidos para los siguientes tipos:

@geindex NoneType (en el módulo types)
@anchor{library/types types NoneType}@anchor{8e9}
@deffn {Dato} types.NoneType

El tipo de @ref{716,,None}.


Added in version 3.10.

@end deffn

@geindex FunctionType (en el módulo types)
@geindex LambdaType (en el módulo types)
@anchor{library/types types FunctionType}@anchor{91b}
@deffn {Dato} types.FunctionType
@anchor{library/types types LambdaType}@anchor{256d}
@deffnx {Dato} types.LambdaType

El tipo de funciones definidas por el usuario y funciones creadas por expresiones  @ref{1309,,lambda}.

Lanza un @ref{18c3,,auditing event} @code{function.__new__} con el argumento @code{code}.

El evento auditor solo ocurre para la instanciación directa de objetos de código y no se genera para la compilación normal.
@end deffn

@geindex GeneratorType (en el módulo types)
@anchor{library/types types GeneratorType}@anchor{1641}
@deffn {Dato} types.GeneratorType

El tipo de iterador @ref{10dd,,generator} de objetos, creados por funciones generadoras.
@end deffn

@geindex CoroutineType (en el módulo types)
@anchor{library/types types CoroutineType}@anchor{f0c}
@deffn {Dato} types.CoroutineType

El tipo de objetos @ref{53a,,coroutine}, creados por funciones @ref{672,,async def}.


Added in version 3.5.

@end deffn

@geindex AsyncGeneratorType (en el módulo types)
@anchor{library/types types AsyncGeneratorType}@anchor{256e}
@deffn {Dato} types.AsyncGeneratorType

El tipo de iterador @ref{2039,,asynchronous generator} de objetos, creados por funciones generadoras asíncronas.


Added in version 3.6.

@end deffn

@geindex CodeType (clase en types)
@anchor{library/types types CodeType}@anchor{1d8}
@deffn {Clase} types.CodeType (**kwargs)

@geindex built-in function;compile

The type of @ref{335,,code objects} such as returned by @ref{2fb,,compile()}.

Lanza un @ref{18c3,,evento auditor} @code{code.__new__} con los argumentos @code{code}, @code{filename}, @code{name}, @code{argcount}, @code{posonlyargcount}, @code{kwonlyargcount}, @code{nlocals}, @code{stacksize}, @code{flags}.

Tenga en cuenta que los argumentos auditados pueden no coincidir con los nombres o posiciones requeridos por el inicializador. El evento auditor solo ocurre para la instanciación directa de objetos de código y no se genera para la compilación normal.
@end deffn

@geindex CellType (en el módulo types)
@anchor{library/types types CellType}@anchor{256f}
@deffn {Dato} types.CellType

The type for cell objects: such objects are used as containers for
a function’s @ref{1f40,,closure variables}.


Added in version 3.8.

@end deffn

@geindex MethodType (en el módulo types)
@anchor{library/types types MethodType}@anchor{1800}
@deffn {Dato} types.MethodType

El tipo de métodos de instancias de clase definidas por el usuario.
@end deffn

@geindex BuiltinFunctionType (en el módulo types)
@geindex BuiltinMethodType (en el módulo types)
@anchor{library/types types BuiltinFunctionType}@anchor{2570}
@deffn {Dato} types.BuiltinFunctionType
@anchor{library/types types BuiltinMethodType}@anchor{2571}
@deffnx {Dato} types.BuiltinMethodType

El tipo de funciones integradas como @ref{6cf,,len()} o @ref{13b0,,sys.exit()} y métodos de clases integradas.  (Aquí, el término «incorporado» significa «escrito en C».)
@end deffn

@geindex WrapperDescriptorType (en el módulo types)
@anchor{library/types types WrapperDescriptorType}@anchor{c21}
@deffn {Dato} types.WrapperDescriptorType

El tipo de métodos de algunos tipos de datos integrados y clases base como @ref{751,,object.__init__()} o @ref{1372,,object.__lt__()}.


Added in version 3.7.

@end deffn

@geindex MethodWrapperType (en el módulo types)
@anchor{library/types types MethodWrapperType}@anchor{6ec}
@deffn {Dato} types.MethodWrapperType

El tipo de métodos `bound' de algunos tipos de datos integrados y clases base. Por ejemplo, es el tipo de @code{object().__str__}.


Added in version 3.7.

@end deffn

@geindex NotImplementedType (en el módulo types)
@anchor{library/types types NotImplementedType}@anchor{8ea}
@deffn {Dato} types.NotImplementedType

El tipo de @ref{227,,NotImplemented}.


Added in version 3.10.

@end deffn

@geindex MethodDescriptorType (en el módulo types)
@anchor{library/types types MethodDescriptorType}@anchor{c22}
@deffn {Dato} types.MethodDescriptorType

El tipo de métodos de algunos tipos de datos integrados como @ref{21b5,,str.join()}.


Added in version 3.7.

@end deffn

@geindex ClassMethodDescriptorType (en el módulo types)
@anchor{library/types types ClassMethodDescriptorType}@anchor{c23}
@deffn {Dato} types.ClassMethodDescriptorType

El tipo de métodos de clase `unbound' de algunos tipos de datos integrados como @code{dict.__dict__['fromkeys']}.


Added in version 3.7.

@end deffn

@geindex ModuleType (clase en types)
@anchor{library/types types ModuleType}@anchor{e98}
@deffn {Clase} types.ModuleType (name, doc=None)

El tipo de @ref{166a,,módulos}. El constructor toma el nombre del módulo que se va a crear y de forma opcional su @ref{2126,,docstring}.


@subsubheading Ver también



@table @asis

@item @ref{1f10,,Documentation on module objects}

Provides details on the special attributes that can be found on
instances of @code{ModuleType}.

@item @ref{e97,,importlib.util.module_from_spec()}

Modules created using the @code{ModuleType} constructor are
created with many of their special attributes unset or set to default
values. @code{module_from_spec()} provides a more robust way of
creating @code{ModuleType} instances which ensures the various
attributes are set appropriately.
@end table

@end deffn

@geindex EllipsisType (en el módulo types)
@anchor{library/types types EllipsisType}@anchor{8e8}
@deffn {Dato} types.EllipsisType

El tipo de @ref{218d,,Ellipsis}.


Added in version 3.10.

@end deffn

@geindex GenericAlias (clase en types)
@anchor{library/types types GenericAlias}@anchor{882}
@deffn {Clase} types.GenericAlias (t_origin, t_args)

El tipo de @ref{753,,parameterized generics} como @code{list[int]}.

@code{t_origin} debería ser una clase genérica no parametrizada, como @code{list}, @code{tuple} o @code{dict}. @code{t_args} debe ser una @ref{464,,tuple} (posiblemente de longitud 1) de tipos que parametriza @code{t_origin}:

@example
>>> from types import GenericAlias

>>> list[int] == GenericAlias(list, (int,))
True
>>> dict[str, int] == GenericAlias(dict, (str, int))
True
@end example


Added in version 3.9.



Distinto en la versión 3.9.2: Este tipo ahora puede heredarse.



@subsubheading Ver también



@table @asis

@item @ref{753,,Generic Alias Types}

In-depth documentation on instances of @code{types.GenericAlias}

@geindex Python Enhancement Proposals; PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - Type Hinting Generics In Standard Collections

Introducing the @code{types.GenericAlias} class
@end table

@end deffn

@geindex UnionType (clase en types)
@anchor{library/types types UnionType}@anchor{6db}
@deffn {Clase} types.UnionType

El tipo de @ref{85b,,union type expressions}.


Added in version 3.10.

@end deffn

@geindex TracebackType (clase en types)
@anchor{library/types types TracebackType}@anchor{b7d}
@deffn {Clase} types.TracebackType (tb_next, tb_frame, tb_lasti, tb_lineno)

The type of traceback objects such as found in @code{sys.exception().__traceback__}.

Consulte @ref{b7f,,la referencia de lenguaje} para obtener detalles de los atributos y operaciones disponibles, y orientación sobre cómo crear `tracebacks' dinámicamente.
@end deffn

@geindex FrameType (en el módulo types)
@anchor{library/types types FrameType}@anchor{1859}
@deffn {Dato} types.FrameType

The type of @ref{780,,frame objects} such as found in
@ref{1f51,,tb.tb_frame} if @code{tb} is a traceback object.
@end deffn

@geindex GetSetDescriptorType (en el módulo types)
@anchor{library/types types GetSetDescriptorType}@anchor{2572}
@deffn {Dato} types.GetSetDescriptorType

The type of objects defined in extension modules with @code{PyGetSetDef}, such
as @ref{2ed,,FrameType.f_locals} or @code{array.array.typecode}.
This type is used as
descriptor for object attributes; it has the same purpose as the
@ref{2fd,,property} type, but for classes defined in extension modules.
@end deffn

@geindex MemberDescriptorType (en el módulo types)
@anchor{library/types types MemberDescriptorType}@anchor{2573}
@deffn {Dato} types.MemberDescriptorType

El tipo de objetos definidos en módulos de extensión con @code{PyMemberDef}, como @code{datetime.timedelta.days}.  Este tipo se utiliza como descriptor para miembros de datos C simples que utilizan funciones de conversión estándar; tiene el mismo propósito que el tipo @ref{2fd,,property}, pero para las clases definidas en los módulos de extensión.

In addition, when a class is defined with a @ref{152a,,__slots__} attribute, then for
each slot, an instance of @code{MemberDescriptorType} will be added as an attribute
on the class. This allows the slot to appear in the class’s @ref{ce5,,__dict__}.

`Detalles de implementación de CPython:' En otras implementaciones de Python, este tipo puede ser idéntico a @code{GetSetDescriptorType}.
@end deffn

@geindex MappingProxyType (clase en types)
@anchor{library/types types MappingProxyType}@anchor{518}
@deffn {Clase} types.MappingProxyType (mapping)

Proxy de solo lectura de un mapeo. Proporciona una vista dinámica en las entradas de la asignación, lo que significa que cuando cambia la asignación, la vista refleja estos cambios.


Added in version 3.3.



Distinto en la versión 3.9: Actualizado para soportar el nuevo operador de unión (@code{|}) de 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}, que simplemente delega al mapeo subyacente.



@deffn {Describe} key in proxy

Retorna @code{True} si la asignación subyacente tiene una clave `key', de lo contrario @code{False}.
@end deffn


@deffn {Describe} proxy[key]

Retorna el elemento de la asignación subyacente con la clave `key'.  Lanza un @ref{438,,KeyError} si `key' no está en la asignación subyacente.
@end deffn


@deffn {Describe} iter(proxy)

Retorna un iterador sobre las claves de la asignación subyacente.  Este es un método abreviado para @code{iter(proxy.keys())}.
@end deffn


@deffn {Describe} len(proxy)

Retorna el número de elementos de la asignación subyacente.
@end deffn

@geindex copy() (método de types.MappingProxyType)
@anchor{library/types types MappingProxyType copy}@anchor{2574}
@deffn {Método} copy ()

Retorna una copia superficial de la asignación subyacente.
@end deffn

@geindex get() (método de types.MappingProxyType)
@anchor{library/types types MappingProxyType get}@anchor{2575}
@deffn {Método} get (key[, default])

Retorna el valor de `key' si `key' está en la asignación subyacente, de lo contrario `default'.  Si no se proporciona `default', el valor predeterminado es @code{None}, por lo que este método nunca lanza un @ref{438,,KeyError}.
@end deffn

@geindex items() (método de types.MappingProxyType)
@anchor{library/types types MappingProxyType items}@anchor{2576}
@deffn {Método} items ()

Retorna una nueva vista de los elementos de la asignación subyacente (en pares @code{(key, value)}).
@end deffn

@geindex keys() (método de types.MappingProxyType)
@anchor{library/types types MappingProxyType keys}@anchor{2577}
@deffn {Método} keys ()

Retorna una nueva vista de las claves de la asignación subyacente.
@end deffn

@geindex values() (método de types.MappingProxyType)
@anchor{library/types types MappingProxyType values}@anchor{2578}
@deffn {Método} values ()

Retorna una nueva vista de los valores de la asignación subyacente.
@end deffn


@deffn {Describe} reversed(proxy)

Retorna un iterador inverso sobre las claves de la asignación subyacente.


Added in version 3.9.

@end deffn


@deffn {Describe} hash(proxy)

Return a hash of the underlying mapping.


Added in version 3.12.

@end deffn
@end deffn

@geindex CapsuleType (clase en types)
@anchor{library/types types CapsuleType}@anchor{2579}
@deffn {Clase} types.CapsuleType

The type of @ref{257a,,capsule objects}.


Added in version 3.13.

@end deffn

@node Clases y funciones de utilidad adicionales,Funciones de utilidad de corutina,Tipos de Intérpretes Estándar,types — Dynamic type creation and names for built-in types
@anchor{library/types additional-utility-classes-and-functions}@anchor{257b}
@subsubsection Clases y funciones de utilidad adicionales


@geindex SimpleNamespace (clase en types)
@anchor{library/types types SimpleNamespace}@anchor{334}
@deffn {Clase} types.SimpleNamespace

Una subclase simple @ref{b18,,object} que proporciona acceso de atributo a su espacio de nombre, así como una representación significativa.

Unlike @ref{b18,,object}, with @code{SimpleNamespace} you can add and remove
attributes.

@ref{334,,SimpleNamespace} objects may be initialized
in the same way as @ref{190,,dict}: either with keyword arguments,
with a single positional argument, or with both.
When initialized with keyword arguments,
those are directly added to the underlying namespace.
Alternatively, when initialized with a positional argument,
the underlying namespace will be updated with key-value pairs
from that argument (either a mapping object or
an @ref{1294,,iterable} object producing key-value pairs).
All such keys must be strings.

El tipo es aproximadamente equivalente al código siguiente:

@example
class SimpleNamespace:
    def __init__(self, mapping_or_iterable=(), /, **kwargs):
        self.__dict__.update(mapping_or_iterable)
        self.__dict__.update(kwargs)

    def __repr__(self):
        items = (f"@{k@}=@{v!r@}" for k, v in self.__dict__.items())
        return "@{@}(@{@})".format(type(self).__name__, ", ".join(items))

    def __eq__(self, other):
        if isinstance(self, SimpleNamespace) and isinstance(other, SimpleNamespace):
           return self.__dict__ == other.__dict__
        return NotImplemented
@end example

@code{SimpleNamespace} puede ser útil como reemplazo para @code{class NS: pass}. Sin embargo, para un tipo de registro estructurado, utilice @ref{32d,,namedtuple()} en su lugar.

@code{SimpleNamespace} objects are supported by @ref{15f,,copy.replace()}.


Added in version 3.3.



Distinto en la versión 3.9: El orden de los atributos en el `repr' cambió de alfabético a orden de inserción (como @code{dict}).



Distinto en la versión 3.13: Added support for an optional positional argument.

@end deffn

@geindex DynamicClassAttribute() (en el módulo types)
@anchor{library/types types DynamicClassAttribute}@anchor{6cb}
@deffn {Función} types.DynamicClassAttribute (fget=None, fset=None, fdel=None, doc=None)

Acceso de atributo de ruta en una clase para __getattr__.

Se trata de un descriptor, que se utiliza para definir atributos que actúan de forma diferente cuando se accede a través de una instancia y a través de una clase.  El acceso a la instancia sigue siendo normal, pero el acceso a un atributo a través de una clase se enrutará al método __getattr__ de la clase; esto se hace lanzando AttributeError.

Esto permite tener propiedades activas en una instancia y tener atributos virtuales en la clase con el mismo nombre (véase @ref{6d1,,enum.Enum} para obtener un ejemplo).


Added in version 3.4.

@end deffn

@node Funciones de utilidad de corutina,,Clases y funciones de utilidad adicionales,types — Dynamic type creation and names for built-in types
@anchor{library/types coroutine-utility-functions}@anchor{257c}
@subsubsection Funciones de utilidad de corutina


@geindex coroutine() (en el módulo types)
@anchor{library/types types coroutine}@anchor{f0b}
@deffn {Función} types.coroutine (gen_func)

This function transforms a @ref{10dd,,generator} function into a
@ref{dfc,,coroutine function} which returns a generator-based coroutine.
The generator-based coroutine is still a @ref{c66,,generator iterator},
but is also considered to be a @ref{53a,,coroutine} object and is
@ref{314,,awaitable}.  However, it may not necessarily implement
the @ref{1fc8,,__await__()} method.

Si `gen_func' es una función generadora, se modificará en el lugar.

Si `gen_func' no es una función generadora, se envolverá. Si retorna una instancia de @ref{e60,,collections.abc.Generator}, la instancia se ajustará en un objeto proxy `awaitable'.  Todos los demás tipos de objetos se retornarán tal cual.


Added in version 3.5.

@end deffn

@node copy — Shallow and deep copy operations,pprint — Data pretty printer,types — Dynamic type creation and names for built-in types,Tipos de datos
@anchor{library/copy doc}@anchor{257d}@anchor{library/copy copy-shallow-and-deep-copy-operations}@anchor{257e}@anchor{library/copy module-copy}@anchor{26}
@subsection @code{copy} — Shallow and deep copy operations


@geindex module; copy

`Código fuente:' Lib/copy.py@footnote{https://github.com/python/cpython/tree/main/Lib/copy.py}


__________________________________________________________________


Las declaraciones de asignación en Python no copian objetos, crean enlaces entre un objetivo y un objeto. Para colecciones que son mutables o que contienen elementos mutables, a veces se necesita una copia para que uno pueda cambiar una copia sin cambiar la otra. Este módulo proporciona operaciones genéricas de copia superficial y profunda (explicadas a continuación).

Resumen de la interfaz:

@geindex copy() (en el módulo copy)
@anchor{library/copy copy copy}@anchor{5d7}
@deffn {Función} copy.copy (obj)

Return a shallow copy of `obj'.
@end deffn

@geindex deepcopy() (en el módulo copy)
@anchor{library/copy copy deepcopy}@anchor{bf6}
@deffn {Función} copy.deepcopy (obj[, memo])

Return a deep copy of `obj'.
@end deffn

@geindex replace() (en el módulo copy)
@anchor{library/copy copy replace}@anchor{15f}
@deffn {Función} copy.replace (obj, /, **changes)

Creates a new object of the same type as `obj', replacing fields with values
from `changes'.


Added in version 3.13.

@end deffn

@geindex Error
@anchor{library/copy copy Error}@anchor{257f}
@deffn {Excepción} copy.Error

Levantado para errores específicos del módulo.
@end deffn
@anchor{library/copy shallow-vs-deep-copy}@anchor{1c09}
La diferencia entre copia superficial y profunda solo es relevante para objetos compuestos (objetos que contienen otros objetos, como listas o instancias de clase):


@itemize *

@item 
Una copia superficial (`shallow copy') construye un nuevo objeto compuesto y luego (en la medida de lo posible) inserta `references' en él a los objetos encontrados en el original.

@item 
Una copia profunda (`deep copy') construye un nuevo objeto compuesto y luego, recursivamente, inserta `copias' en él de los objetos encontrados en el original.
@end itemize

A menudo existen dos problemas con las operaciones de copia profunda que no existen con las operaciones de copia superficial:


@itemize *

@item 
Los objetos recursivos (objetos compuestos que, directa o indirectamente, contienen una referencia a sí mismos) pueden causar un bucle recursivo.

@item 
Debido a que la copia profunda copia todo, puede copiar demasiado, como los datos que deben compartirse entre copias.
@end itemize

La función @ref{bf6,,deepcopy()} evita estos problemas al:


@itemize *

@item 
mantener un diccionario @code{memo} de objetos ya copiados durante la aprobación de copia actual; y

@item 
permitiendo que las clases definidas por el usuario anulen la operación de copia o el conjunto de componentes copiados.
@end itemize

Este módulo no copia tipos como módulo, método, seguimiento de pila, marco de pila, archivo, socket, ventana,  o cualquier tipo similar.  Sí «copia» funciones y clases (superficiales y profundas), retornando el objeto original sin cambios; Esto es compatible con la forma en que son tratados por el módulo @ref{a6,,pickle}.

Se pueden hacer copias superficiales de los diccionarios usando @ref{c58,,dict.copy()}, y de las listas mediante la asignación de una porción de la lista completa, por ejemplo, @code{lista_copiada = lista_original[:]}.

@geindex módulo;pickle

Las clases pueden usar las mismas interfaces para controlar la copia que usan para controlar el `pickling'. Consulte la descripción del módulo @ref{a6,,pickle} para obtener información sobre estos métodos. De hecho, el módulo @ref{26,,copy} utiliza las funciones de `pickle' registradas del módulo @ref{27,,copyreg}.

@geindex __copy__() (protocolo de copia)
@geindex __deepcopy__() (protocolo de copia)

In order for a class to define its own copy implementation, it can define
special methods @ref{2580,,__copy__()} and @ref{2581,,__deepcopy__()}.

@anchor{library/copy object __copy__}@anchor{2580}
@deffn {Método} object.__copy__ (self)

Called to implement the shallow copy operation;
no additional arguments are passed.
@end deffn

@anchor{library/copy object __deepcopy__}@anchor{2581}
@deffn {Método} object.__deepcopy__ (self, memo)

Called to implement the deep copy operation; it is passed one
argument, the `memo' dictionary.  If the @code{__deepcopy__} implementation needs
to make a deep copy of a component, it should call the @ref{bf6,,deepcopy()} function
with the component as first argument and the `memo' dictionary as second argument.
The `memo' dictionary should be treated as an opaque object.
@end deffn

@geindex __replace__() (replace protocol)

Function @code{copy.replace()} is more limited
than @ref{5d7,,copy()} and @ref{bf6,,deepcopy()},
and only supports named tuples created by @ref{32d,,namedtuple()},
@ref{30,,dataclasses}, and other classes which define method @ref{2be,,__replace__()}.

@anchor{library/copy object __replace__}@anchor{2be}
@deffn {Método} object.__replace__ (self, /, **changes)

This method should create a new object of the same type,
replacing fields with values from `changes'.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{a6,,pickle}

Discusión de los métodos especiales utilizados para apoyar la recuperación y restauración del estado del objeto.
@end table


@node pprint — Data pretty printer,reprlib — Alternate repr implementation,copy — Shallow and deep copy operations,Tipos de datos
@anchor{library/pprint doc}@anchor{2582}@anchor{library/pprint module-pprint}@anchor{ae}@anchor{library/pprint pprint-data-pretty-printer}@anchor{2583}
@subsection @code{pprint} — Data pretty printer


@geindex module; pprint

`Código fuente:' Lib/pprint.py@footnote{https://github.com/python/cpython/tree/main/Lib/pprint.py}


__________________________________________________________________


El módulo @ref{ae,,pprint} proporciona la capacidad de «imprimir de forma bonita» estructuras de datos arbitrarias de Python de manera que se puede utilizar como entrada para el intérprete. Si las estructuras formateadas incluyen objetos que no son tipos fundamentales de Python, es posible que la representación no sea válida como tal para el intérprete. Esto puede darse si se incluyen objetos como archivos, sockets o clases, así como muchos otros objetos que no se pueden representar como literales de Python.

The formatted representation keeps objects on a single line if it can, and
breaks them onto multiple lines if they don’t fit within the allowed width,
adjustable by the `width' parameter defaulting to 80 characters.

Los diccionarios se ordenan por clave antes de que se calcule la representación en pantalla.


Distinto en la versión 3.9: Soporte añadido para imprimir de forma bonita @ref{334,,types.SimpleNamespace}.



Distinto en la versión 3.10: Soporte añadido para imprimir de forma bonita @ref{32e,,dataclasses.dataclass}.


@menu
* Functions:: 
* Objetos PrettyPrinter:: 
* Ejemplo: Ejemplo<3>. 

@end menu

@node Functions,Objetos PrettyPrinter,,pprint — Data pretty printer
@anchor{library/pprint functions}@anchor{2584}@anchor{library/pprint pprint-functions}@anchor{2585}
@subsubsection Functions


@geindex pp() (en el módulo pprint)
@anchor{library/pprint pprint pp}@anchor{ab5}
@deffn {Función} pprint.pp (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=False, underscore_numbers=False)

Prints the formatted representation of `object', followed by a newline.
This function may be used in the interactive interpreter
instead of the @ref{ff4,,print()} function for inspecting values.
Tip: you can reassign @code{print = pprint.pp} for use within a scope.

@*Parámetros: 

@itemize *

@item 
@code{object} – The object to be printed.

@item 
@code{stream} (@ref{2586,,file-like object} | None) – A file-like object to which the output will be written
by calling its @code{write()} method.
If @code{None} (the default), @ref{b61,,sys.stdout} is used.

@item 
@code{indent} (@ref{1f0,,int}) – The amount of indentation added for each nesting level.

@item 
@code{width} (@ref{1f0,,int}) – The desired maximum number of characters per line in the output.
If a structure cannot be formatted within the width constraint,
a best effort will be made.

@item 
@code{depth} (@ref{1f0,,int}@code{ | }@code{None}) – The number of nesting levels which may be printed.
If the data structure being printed is too deep,
the next contained level is replaced by @code{...}.
If @code{None} (the default), there is no constraint
on the depth of the objects being formatted.

@item 
@code{compact} (@ref{513,,bool}) – Control the way long @ref{597,,sequences} are formatted.
If @code{False} (the default),
each item of a sequence will be formatted on a separate line,
otherwise as many items as will fit within the `width'
will be formatted on each output line.

@item 
@code{sort_dicts} (@ref{513,,bool}) – If @code{True}, dictionaries will be formatted with
their keys sorted, otherwise
they will be displayed in insertion order (the default).

@item 
@code{underscore_numbers} (@ref{513,,bool}) – If @code{True},
integers will be formatted with the @code{_} character for a thousands separator,
otherwise underscores are not displayed (the default).
@end itemize


@example
>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff)
>>> pprint.pp(stuff)
[<Recursion on list with id=...>,
 'spam',
 'eggs',
 'lumberjack',
 'knights',
 'ni']
@end example


Added in version 3.8.

@end deffn

@geindex pprint() (en el módulo pprint)
@anchor{library/pprint pprint pprint}@anchor{8bf}
@deffn {Función} pprint.pprint (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Alias for @ref{ab5,,pp()} with `sort_dicts' set to @code{True} by default,
which would automatically sort the dictionaries” keys,
you might want to use @ref{ab5,,pp()} instead where it is @code{False} by default.
@end deffn

@geindex pformat() (en el módulo pprint)
@anchor{library/pprint pprint pformat}@anchor{fff}
@deffn {Función} pprint.pformat (object, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Return the formatted representation of `object' as a string.  `indent',
`width', `depth', `compact', `sort_dicts' and `underscore_numbers' are
passed to the @ref{ffe,,PrettyPrinter} constructor as formatting parameters
and their meanings are as described in the documentation above.
@end deffn

@geindex isreadable() (en el módulo pprint)
@anchor{library/pprint pprint isreadable}@anchor{2587}
@deffn {Función} pprint.isreadable (object)

@geindex built-in function;eval

Determina si la representación formateada de `object' es «legible» o si puede usarse para reconstruir el objeto usando @ref{2eb,,eval()}.  Siempre retorna @code{False} para objetos recursivos.

@example
>>> pprint.isreadable(stuff)
False
@end example
@end deffn

@geindex isrecursive() (en el módulo pprint)
@anchor{library/pprint pprint isrecursive}@anchor{2588}
@deffn {Función} pprint.isrecursive (object)

Determine if `object' requires a recursive representation.  This function is
subject to the same limitations as noted in @ref{2589,,saferepr()} below and may raise an
@ref{df1,,RecursionError} if it fails to detect a recursive object.
@end deffn

@geindex saferepr() (en el módulo pprint)
@anchor{library/pprint pprint saferepr}@anchor{2589}
@deffn {Función} pprint.saferepr (object)

Return a string representation of `object', protected against recursion in
some common data structures, namely instances of @ref{190,,dict}, @ref{18e,,list}
and @ref{464,,tuple} or subclasses whose @code{__repr__} has not been overridden.  If the
representation of object exposes a recursive entry, the recursive reference
will be represented as @code{<Recursion on typename with id=number>}.  The
representation is not otherwise formatted.

@example
>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"
@end example
@end deffn

@node Objetos PrettyPrinter,Ejemplo<3>,Functions,pprint — Data pretty printer
@anchor{library/pprint id1}@anchor{258a}@anchor{library/pprint prettyprinter-objects}@anchor{258b}
@subsubsection Objetos `PrettyPrinter'


@geindex ...;placeholder

@geindex PrettyPrinter (clase en pprint)
@anchor{library/pprint pprint PrettyPrinter}@anchor{ffe}
@deffn {Clase} pprint.PrettyPrinter (indent=1, width=80, depth=None, stream=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Construct a @ref{ffe,,PrettyPrinter} instance.

Arguments have the same meaning as for @ref{ab5,,pp()}.
Note that they are in a different order, and that `sort_dicts' defaults to @code{True}.

@example
>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff[:])
>>> pp = pprint.PrettyPrinter(indent=4)
>>> pp.pprint(stuff)
[   ['spam', 'eggs', 'lumberjack', 'knights', 'ni'],
    'spam',
    'eggs',
    'lumberjack',
    'knights',
    'ni']
>>> pp = pprint.PrettyPrinter(width=41, compact=True)
>>> pp.pprint(stuff)
[['spam', 'eggs', 'lumberjack',
  'knights', 'ni'],
 'spam', 'eggs', 'lumberjack', 'knights',
 'ni']
>>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
... ('parrot', ('fresh fruit',))))))))
>>> pp = pprint.PrettyPrinter(depth=6)
>>> pp.pprint(tup)
('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))
@end example


Distinto en la versión 3.4: Añadido el argumento `compact'.



Distinto en la versión 3.8: Añadido el argumento `sort_dicts'.



Distinto en la versión 3.10: Se agregó el parámetro `underscore_numbers'.



Distinto en la versión 3.11: No longer attempts to write to @code{sys.stdout} if it is @code{None}.

@end deffn

Las instancias de @ref{ffe,,PrettyPrinter} tienen los siguientes métodos:

@geindex pformat() (método de pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter pformat}@anchor{258c}
@deffn {Método} PrettyPrinter.pformat (object)

Retorna la representación formateada de `object'.  Tiene en cuenta las opciones pasadas al constructor de la clase @ref{ffe,,PrettyPrinter}.
@end deffn

@geindex pprint() (método de pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter pprint}@anchor{258d}
@deffn {Método} PrettyPrinter.pprint (object)

Imprime la representación formateada de `object' en la secuencia configurada, seguida de una nueva línea.
@end deffn

Los siguientes métodos proporcionan las implementaciones para las funciones correspondientes con los mismos nombres. Usar estos métodos en una instancia es algo más eficiente, ya que no es necesario crear nuevos objetos @ref{ffe,,PrettyPrinter}.

@geindex isreadable() (método de pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter isreadable}@anchor{258e}
@deffn {Método} PrettyPrinter.isreadable (object)

@geindex built-in function;eval

Determina si la representación formateada de `object' es «legible» o si se puede usar para reconstruir su valor usando @ref{2eb,,eval()}. Se debe tener en cuenta que se retorna @code{False} para objetos recursivos. Si el parámetro `depth' de @ref{ffe,,PrettyPrinter} es proporcionado y el objeto es más profundo de lo permitido, también se retorna @code{False}.
@end deffn

@geindex isrecursive() (método de pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter isrecursive}@anchor{258f}
@deffn {Método} PrettyPrinter.isrecursive (object)

Determina si `object' requiere una representación recursiva.
@end deffn

Este método se proporciona como un punto de entrada o método de enlace automático (`hook' en inglés) para permitir que las subclases modifiquen la forma en que los objetos se convierten en cadenas de caracteres. La implementación por defecto utiliza la implementación interna de @ref{2589,,saferepr()}.

@geindex format() (método de pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter format}@anchor{1928}
@deffn {Método} PrettyPrinter.format (object, context, maxlevels, level)

Retorna tres valores: la versión formateada de `object' como una cadena de caracteres, una bandera que indica si el resultado es legible y una bandera que indica si se detectó recursividad. El primer argumento es el objeto a representar. El segundo es un diccionario que contiene la @ref{1462,,id()} de los objetos que son parte del contexto de representación actual (contenedores directos e indirectos para `object' que están afectando a la representación), como las claves; si es necesario representar un objeto que ya está representado en `context', el tercer valor de retorno será @code{True}. Las llamadas recursivas al método @ref{1928,,format()} deben agregar entradas adicionales a los contenedores de este diccionario. El tercer argumento, `maxlevels', proporciona el límite máximo de recursividad; su valor por defecto es @code{0}. Este argumento debe pasarse sin modificaciones a las llamadas recursivas. El cuarto argumento, `level', da el nivel actual; las llamadas recursivas sucesivas deben pasar un valor menor que el de la llamada actual.
@end deffn

@node Ejemplo<3>,,Objetos PrettyPrinter,pprint — Data pretty printer
@anchor{library/pprint example}@anchor{2590}@anchor{library/pprint pprint-example}@anchor{2591}
@subsubsection Ejemplo


To demonstrate several uses of the @ref{ab5,,pp()} function and its parameters,
let’s fetch information about a project from PyPI@footnote{https://pypi.org}:

@example
>>> import json
>>> import pprint
>>> from urllib.request import urlopen
>>> with urlopen('https://pypi.org/pypi/sampleproject/1.2.0/json') as resp:
...     project_info = json.load(resp)['info']
@end example

In its basic form, @ref{ab5,,pp()} shows the whole object:

@example
>>> pprint.pp(project_info)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': ['Development Status :: 3 - Alpha',
                 'Intended Audience :: Developers',
                 'License :: OSI Approved :: MIT License',
                 'Programming Language :: Python :: 2',
                 'Programming Language :: Python :: 2.6',
                 'Programming Language :: Python :: 2.7',
                 'Programming Language :: Python :: 3',
                 'Programming Language :: Python :: 3.2',
                 'Programming Language :: Python :: 3.3',
                 'Programming Language :: Python :: 3.4',
                 'Topic :: Software Development :: Build Tools'],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{'last_day': -1, 'last_month': -1, 'last_week': -1@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{'Download': 'UNKNOWN',
                  'Homepage': 'https://github.com/pypa/sampleproject'@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

El resultado puede limitarse a una cierta profundidad asignando un valor al argumento `depth' (@code{...} se utiliza para contenidos más «profundos»):

@example
>>> pprint.pp(project_info, depth=1)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{...@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{...@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

Además, se puede establecer un valor máximo de caracteres por línea asignando un valor al parámetro `width'. Si un objeto largo no se puede dividir, el valor dado al ancho se anulará y será excedido:

@example
>>> pprint.pp(project_info, depth=1, width=60)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the '
                'project.\n'
                '\n'
                'The file should use UTF-8 encoding and be '
                'written using ReStructured Text. It\n'
                'will be used to generate the project '
                'webpage on PyPI, and should be written '
                'for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would '
                'include an overview of the project, '
                'basic\n'
                'usage examples, etc. Generally, including '
                'the project changelog in here is not\n'
                'a good idea, although a simple "What\'s '
                'New" section for the most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{...@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{...@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

@node reprlib — Alternate repr implementation,enum — Support for enumerations,pprint — Data pretty printer,Tipos de datos
@anchor{library/reprlib doc}@anchor{2592}@anchor{library/reprlib module-reprlib}@anchor{bb}@anchor{library/reprlib reprlib-alternate-repr-implementation}@anchor{2593}
@subsection @code{reprlib} — Alternate @code{repr()} implementation


@geindex module; reprlib

`Código fuente:' Lib/reprlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/reprlib.py}


__________________________________________________________________


The @code{reprlib} module provides a means for producing object representations
with limits on the size of the resulting strings. This is used in the Python
debugger and may be useful in other contexts as well.

Este módulo provee una clase, una instancia y una función:

@geindex Repr (clase en reprlib)
@anchor{library/reprlib reprlib Repr}@anchor{2594}
@deffn {Clase} reprlib.Repr (*, maxlevel=6, maxtuple=6, maxlist=6, maxarray=5, maxdict=4, maxset=6, maxfrozenset=6, maxdeque=6, maxstring=30, maxlong=40, maxother=30, fillvalue='...', indent=None)

Clase que provee de servicios de formateo útiles en la implementación de funciones similar a la integrada @ref{894,,repr()}; los límites de tamaño para diferentes tipos de objetos son añadidos para evitar la generación de representaciones que son excesivamente largas.

The keyword arguments of the constructor can be used as a shortcut to set the
attributes of the @ref{2594,,Repr} instance. Which means that the following
initialization:

@example
aRepr = reprlib.Repr(maxlevel=3)
@end example

Is equivalent to:

@example
aRepr = reprlib.Repr()
aRepr.maxlevel = 3
@end example

See section @ref{2595,,Repr Objects} for more information about @ref{2594,,Repr}
attributes.


Distinto en la versión 3.12: Allow attributes to be set via keyword arguments.

@end deffn

@geindex aRepr (en el módulo reprlib)
@anchor{library/reprlib reprlib aRepr}@anchor{2596}
@deffn {Dato} reprlib.aRepr

Esta es una instancia de @ref{2594,,Repr} que es usada para proveer la función @ref{2597,,repr()} descrita debajo. Cambiar los atributos de este objeto afectará los límites de tamaño usados por @ref{2597,,repr()} y el depurador de Python.
@end deffn

@geindex repr() (en el módulo reprlib)
@anchor{library/reprlib reprlib repr}@anchor{2597}
@deffn {Función} reprlib.repr (obj)

Este es el método @ref{2598,,repr()} de @code{aRepr}. Retorna una cadena similar a la retornada por la función integrada del mismo nombre, pero con límites en la mayoría de tamaños.
@end deffn

In addition to size-limiting tools, the module also provides a decorator for
detecting recursive calls to @ref{6bd,,__repr__()} and substituting a
placeholder string instead.

@geindex ...;placeholder

@geindex recursive_repr() (en el módulo reprlib)
@anchor{library/reprlib reprlib recursive_repr}@anchor{1260}
@deffn {Función} @@reprlib.recursive_repr (fillvalue='...')

Decorator for @ref{6bd,,__repr__()} methods to detect recursive calls within the
same thread.  If a recursive call is made, the `fillvalue' is returned,
otherwise, the usual @code{__repr__()} call is made.  For example:

@example
>>> from reprlib import recursive_repr
>>> class MyList(list):
...     @@recursive_repr()
...     def __repr__(self):
...         return '<' + '|'.join(map(repr, self)) + '>'
...
>>> m = MyList('abc')
>>> m.append(m)
>>> m.append('x')
>>> print(m)
<'a'|'b'|'c'|...|'x'>
@end example


Added in version 3.2.

@end deffn

@menu
* Objetos Repr:: 
* Subclasificando Objetos Repr:: 

@end menu

@node Objetos Repr,Subclasificando Objetos Repr,,reprlib — Alternate repr implementation
@anchor{library/reprlib id1}@anchor{2595}@anchor{library/reprlib repr-objects}@anchor{2599}
@subsubsection Objetos Repr


Las instancias @ref{2594,,Repr} proveen varios atributos que pueden ser usados para proporcionar límites de tamaño para las representaciones de diferentes tipos de objetos, y métodos que formatean tipos de objetos específicos.

@geindex fillvalue (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr fillvalue}@anchor{259a}
@deffn {Atributo} Repr.fillvalue

Esta cadena se muestra para referencias recursivas. El valor predeterminado es @code{...}.


Added in version 3.11.

@end deffn

@geindex maxlevel (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxlevel}@anchor{259b}
@deffn {Atributo} Repr.maxlevel

Límite de profundidad en la creación de representaciones recursivas. El valor por defecto es @code{6}.
@end deffn

@geindex maxdict (atributo de reprlib.Repr)
@geindex maxlist (atributo de reprlib.Repr)
@geindex maxtuple (atributo de reprlib.Repr)
@geindex maxset (atributo de reprlib.Repr)
@geindex maxfrozenset (atributo de reprlib.Repr)
@geindex maxdeque (atributo de reprlib.Repr)
@geindex maxarray (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxdict}@anchor{259c}
@deffn {Atributo} Repr.maxdict
@anchor{library/reprlib reprlib Repr maxlist}@anchor{259d}
@deffnx {Atributo} Repr.maxlist
@anchor{library/reprlib reprlib Repr maxtuple}@anchor{259e}
@deffnx {Atributo} Repr.maxtuple
@anchor{library/reprlib reprlib Repr maxset}@anchor{259f}
@deffnx {Atributo} Repr.maxset
@anchor{library/reprlib reprlib Repr maxfrozenset}@anchor{25a0}
@deffnx {Atributo} Repr.maxfrozenset
@anchor{library/reprlib reprlib Repr maxdeque}@anchor{25a1}
@deffnx {Atributo} Repr.maxdeque
@anchor{library/reprlib reprlib Repr maxarray}@anchor{25a2}
@deffnx {Atributo} Repr.maxarray

Límites en el número de entradas representadas por el tipo de objeto nombrado. El valor por defecto es @code{4} para @ref{259c,,maxdict}, @code{5} para  @ref{25a2,,maxarray}, y @code{6} para los otros.
@end deffn

@geindex maxlong (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxlong}@anchor{25a3}
@deffn {Atributo} Repr.maxlong

Máximo número de caracteres en la representación para un entero. Los dígitos son eliminados desde el medio. El valor por defecto es @code{40}.
@end deffn

@geindex maxstring (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxstring}@anchor{25a4}
@deffn {Atributo} Repr.maxstring

Límite en el número de caracteres en la representación de la cadena. Fíjese que la representación «normal» de la cadena  es la usada como la fuente de caracteres: si se necesitan secuencias de escape en la representación, estas pueden ser desordenadas cuando la representación se ha acortado. El valor por defecto es @code{30}.
@end deffn

@geindex maxother (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxother}@anchor{25a5}
@deffn {Atributo} Repr.maxother

Este límite es usado para controlar el tamaño de los tipos de objetos para los cuales no hay ningún método de formateo específico en el objeto @ref{2594,,Repr}. Se aplica de una manera similar a @ref{25a4,,maxstring}. El valor por defecto es @code{20}.
@end deffn

@geindex indent (atributo de reprlib.Repr)
@anchor{library/reprlib reprlib Repr indent}@anchor{25a6}
@deffn {Atributo} Repr.indent

If this attribute is set to @code{None} (the default), the output is formatted
with no line breaks or indentation, like the standard @ref{894,,repr()}.
For example:

@example
>>> example = [
...     1, 'spam', @{'a': 2, 'b': 'spam eggs', 'c': @{3: 4.5, 6: []@}@}, 'ham']
>>> import reprlib
>>> aRepr = reprlib.Repr()
>>> print(aRepr.repr(example))
[1, 'spam', @{'a': 2, 'b': 'spam eggs', 'c': @{3: 4.5, 6: []@}@}, 'ham']
@end example

If @ref{25a6,,indent} is set to a string, each recursion level
is placed on its own line, indented by that string:

@example
>>> aRepr.indent = '-->'
>>> print(aRepr.repr(example))
[
-->1,
-->'spam',
-->@{
-->-->'a': 2,
-->-->'b': 'spam eggs',
-->-->'c': @{
-->-->-->3: 4.5,
-->-->-->6: [],
-->-->@},
-->@},
-->'ham',
]
@end example

Setting @ref{25a6,,indent} to a positive integer value behaves as if it
was set to a string with that number of spaces:

@example
>>> aRepr.indent = 4
>>> print(aRepr.repr(example))
[
    1,
    'spam',
    @{
        'a': 2,
        'b': 'spam eggs',
        'c': @{
            3: 4.5,
            6: [],
        @},
    @},
    'ham',
]
@end example


Added in version 3.12.

@end deffn

@geindex repr() (método de reprlib.Repr)
@anchor{library/reprlib reprlib Repr repr}@anchor{2598}
@deffn {Método} Repr.repr (obj)

El equivalente a la función integrada @ref{894,,repr()} que usa el formateo  impuesto por la instancia.
@end deffn

@geindex repr1() (método de reprlib.Repr)
@anchor{library/reprlib reprlib Repr repr1}@anchor{25a7}
@deffn {Método} Repr.repr1 (obj, level)

Implementación recursiva usada por @ref{2598,,repr()}. Este usa el tipo de `obj' para determinar qué método invocar, pasándole `obj' y `level'. Los métodos de tipo específico deben invocar @ref{25a7,,repr1()} para realizar formateo recursivo, con @code{level - 1} para el valor de `level' en la invocación recursiva.
@end deffn


@deffn {Método} Repr.repr_TYPE (obj, level)

Métodos de formateo para tipos específicos son implementados como métodos con un nombre basado en el nombre del tipo. En el nombre del método, `TYPE' es reemplazado por @code{'_'.join(type(obj).__name__.split())}. El envío a estos métodos es gestionado por @ref{25a7,,repr1()}. Los métodos de tipo específico que necesitan formatear recursivamente un valor deben invocar @code{self.repr1(subobj, level - 1)}.
@end deffn

@node Subclasificando Objetos Repr,,Objetos Repr,reprlib — Alternate repr implementation
@anchor{library/reprlib subclassing-repr-objects}@anchor{25a8}@anchor{library/reprlib subclassing-reprs}@anchor{25a9}
@subsubsection Subclasificando Objetos Repr


The use of dynamic dispatching by @ref{25a7,,Repr.repr1()} allows subclasses of
@ref{2594,,Repr} to add support for additional built-in object types or to modify
the handling of types already supported. This example shows how special support
for file objects could be added:

@example
import reprlib
import sys

class MyRepr(reprlib.Repr):

    def repr_TextIOWrapper(self, obj, level):
        if obj.name in @{'<stdin>', '<stdout>', '<stderr>'@}:
            return obj.name
        return repr(obj)

aRepr = MyRepr()
print(aRepr.repr(sys.stdin))         # prints '<stdin>'
@end example

@example
<stdin>
@end example

@node enum — Support for enumerations,graphlib — Functionality to operate with graph-like structures,reprlib — Alternate repr implementation,Tipos de datos
@anchor{library/enum doc}@anchor{25aa}@anchor{library/enum enum-support-for-enumerations}@anchor{25ab}@anchor{library/enum module-enum}@anchor{56}
@subsection @code{enum} — Support for enumerations


@geindex module; enum


Added in version 3.4.


`Código fuente:' Lib/enum.py@footnote{https://github.com/python/cpython/tree/main/Lib/enum.py}

@subsubheading Important



Esta página contiene la información de referencia de la API. Para obtener información sobre tutoriales y debates sobre temas más avanzados, consulte


@itemize *

@item 
@ref{25ac,,Tutorial básico}

@item 
@ref{25ad,,Tutorial avanzado}

@item 
@ref{25ae,,Libro de recetas Enum}
@end itemize


__________________________________________________________________


Una enumeración:


@itemize *

@item 
es un conjunto de nombres simbólicos (miembros) vinculados a valores únicos

@item 
can be iterated over to return its canonical (i.e. non-alias) members in
definition order

@item 
usa la sintaxis `call' para retornar miembros por valor

@item 
usa la sintaxis `index' para retornar miembros por nombre
@end itemize

Las enumeraciones se crean mediante la sintaxis @ref{133f,,class} o mediante la sintaxis de llamadas a funciones:

@example
>>> from enum import Enum

>>> # class syntax
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3

>>> # functional syntax
>>> Color = Enum('Color', [('RED', 1), ('GREEN', 2), ('BLUE', 3)])
@end example

Aunque podemos usar la sintaxis @ref{133f,,class} para crear enumeraciones, las enumeraciones no son clases normales de Python. Ver @ref{25af,,¿En qué se diferencian las enumeraciones?} para más detalles.

@cartouche
@quotation Nota 
Nomenclatura


@itemize -

@item 
The class @code{Color} is an `enumeration' (or `enum')

@item 
The attributes @code{Color.RED}, @code{Color.GREEN}, etc., are
`enumeration members' (or `members') and are functionally constants.

@item 
The enum members have `names' and `values' (the name of
@code{Color.RED} is @code{RED}, the value of @code{Color.BLUE} is
@code{3}, etc.)
@end itemize
@end quotation
@end cartouche


__________________________________________________________________


@menu
* Contenido del Módulo:: 
* Tipos de datos: Tipos de datos<2>. 
* Utilidades y decoradores:: 
* Notas:: 

@end menu

@node Contenido del Módulo,Tipos de datos<2>,,enum — Support for enumerations
@anchor{library/enum module-contents}@anchor{25b0}
@subsubsection Contenido del Módulo


@quotation

@ref{6ba,,EnumType}

@quotation

El @code{type} para Enum y sus subclases.
@end quotation

@ref{6d1,,Enum}

@quotation

Clase base para crear constantes enumeradas.
@end quotation

@ref{d66,,IntEnum}

@quotation

Clase base para crear constantes enumeradas que también son subclases de @ref{1f0,,int}. (@ref{25b1,,Notes})
@end quotation

@ref{6bb,,StrEnum}

@quotation

Clase base para crear constantes enumeradas que también son subclases de @ref{237,,str}. (@ref{25b1,,Notes})
@end quotation

@ref{6c4,,Flag}

@quotation

Clase base para crear constantes enumeradas que se pueden combinar utilizando las operaciones `bitwise' sin perder su membresía @ref{6c4,,Flag}.
@end quotation

@ref{22fd,,IntFlag}

@quotation

Clase base para crear constantes enumeradas que se pueden combinar mediante los operadores bit a bit sin perder su pertenencia a @ref{22fd,,IntFlag}. Los miembros @ref{22fd,,IntFlag} también son subclases de @ref{1f0,,int}. (@ref{25b1,,Notes})
@end quotation

@ref{6bc,,ReprEnum}

@quotation

Usado por @ref{d66,,IntEnum}, @ref{6bb,,StrEnum} y @ref{22fd,,IntFlag} para mantener el @ref{237,,str()} del tipo mixto.
@end quotation

@ref{6c7,,EnumCheck}

@quotation

Una enumeración con los valores @code{CONTINUOUS}, @code{NAMED_FLAGS} y @code{UNIQUE}, para usar con @ref{6c6,,verify()} para garantizar que una enumeración determinada cumpla varias restricciones.
@end quotation

@ref{6c5,,FlagBoundary}

@quotation

Una enumeración con los valores @code{STRICT}, @code{CONFORM}, @code{EJECT} y @code{KEEP} que permite un control más detallado sobre cómo se tratan los valores no válidos en una enumeración.
@end quotation

@ref{d25,,auto}

@quotation

Las instancias se reemplazan con un valor apropiado para los miembros de Enum. @ref{6bb,,StrEnum} usa de manera predeterminada la versión en minúsculas del nombre del miembro, mientras que otras enumeraciones tienen el valor predeterminado de 1 y aumentan a partir de ahí.
@end quotation

@ref{6ca,,property()}

@quotation

Allows @ref{6d1,,Enum} members to have attributes without conflicting with
member names.  The @code{value} and @code{name} attributes are implemented this
way.
@end quotation

@ref{25b2,,unique()}

@quotation

El decorador de clase Enum que garantiza que solo un nombre esté vinculado a cualquier valor.
@end quotation

@ref{6c6,,verify()}

@quotation

Decorador de clase Enum que verifica las restricciones seleccionables por el usuario en una enumeración.
@end quotation

@ref{6c8,,member()}

@quotation

Convierta a @code{obj} en miembro. Se puede utilizar como decorador.
@end quotation

@ref{6c9,,nonmember()}

@quotation

No convierta a @code{obj} en miembro. Se puede utilizar como decorador.
@end quotation

@ref{6cc,,global_enum()}

@quotation

Modify the @ref{237,,str()} and @ref{894,,repr()} of an enum
to show its members as belonging to the module instead of its class,
and export the enum members to the global namespace.
@end quotation

@ref{25b3,,show_flag_values()}

@quotation

Retorna una lista de todos los enteros de potencia de dos contenidos en una bandera.
@end quotation
@end quotation


Added in version 3.6: @code{Flag}, @code{IntFlag}, @code{auto}



Added in version 3.11: @code{StrEnum}, @code{EnumCheck}, @code{ReprEnum}, @code{FlagBoundary}, @code{property}, @code{member}, @code{nonmember}, @code{global_enum}, @code{show_flag_values}



__________________________________________________________________


@node Tipos de datos<2>,Utilidades y decoradores,Contenido del Módulo,enum — Support for enumerations
@anchor{library/enum data-types}@anchor{25b4}
@subsubsection Tipos de datos


@geindex EnumType (clase en enum)
@anchor{library/enum enum EnumType}@anchor{6ba}
@deffn {Clase} enum.EnumType

`EnumType' es el @ref{1f86,,metaclass} para enumeraciones `enum'. Es posible subclasificar `EnumType'; consulte @ref{25b5,,Subclassing EnumType} para obtener más detalles.

@code{EnumType} is responsible for setting the correct @code{__repr__()},
@code{__str__()}, @code{__format__()}, and @code{__reduce__()} methods on the
final `enum', as well as creating the enum members, properly handling
duplicates, providing iteration over the enum class, etc.

@geindex __call__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __call__}@anchor{25b6}
@deffn {Método} __call__ (cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Este método se llama de dos maneras diferentes:


@itemize *

@item 
para buscar un miembro existente:

@quotation

@*cls: 
La clase de enumeración que se llama.


@*value: 
El valor a buscar.

@end quotation

@item 
to use the @code{cls} enum to create a new enum (only if the existing enum
does not have any members):

@quotation

@*cls: 
La clase de enumeración que se llama.


@*value: 
El nombre del nuevo Enum para crear.


@*names: 
Los nombres/valores de los miembros para el nuevo Enum.


@*module: 
El nombre del módulo en el que se crea el nuevo Enum.


@*qualname: 
La ubicación real en el módulo donde se puede encontrar este Enum.


@*type: 
Un tipo de mezcla para el nuevo Enum.


@*start: 
The first integer value for the Enum (used by @ref{d25,,auto}).


@*boundary: 
How to handle out-of-range values from bit operations (@ref{6c4,,Flag} only).

@end quotation
@end itemize
@end deffn

@geindex __contains__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __contains__}@anchor{25b7}
@deffn {Método} __contains__ (cls, member)

Retorna @code{True} si el miembro pertenece a @code{cls}:

@example
>>> some_var = Color.RED
>>> some_var in Color
True
>>> Color.RED.value in Color
True
@end example
@end deffn


Distinto en la versión 3.12: Before Python 3.12, a @code{TypeError} is raised if a
non-Enum-member is used in a containment check.


@geindex __dir__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __dir__}@anchor{25b8}
@deffn {Método} __dir__ (cls)

Retorna @code{['__class__', '__doc__', '__members__', '__module__']} y los nombres de los miembros en `cls':

@example
>>> dir(Color)
['BLUE', 'GREEN', 'RED', '__class__', '__contains__', '__doc__', '__getitem__', '__init_subclass__', '__iter__', '__len__', '__members__', '__module__', '__name__', '__qualname__']
@end example
@end deffn

@geindex __getitem__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __getitem__}@anchor{25b9}
@deffn {Método} __getitem__ (cls, name)

Returns the Enum member in `cls' matching `name', or raises a @ref{438,,KeyError}:

@example
>>> Color['BLUE']
<Color.BLUE: 3>
@end example
@end deffn

@geindex __iter__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __iter__}@anchor{25ba}
@deffn {Método} __iter__ (cls)

Retorna cada miembro en `cls' en orden de definición:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
@end example
@end deffn

@geindex __len__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __len__}@anchor{25bb}
@deffn {Método} __len__ (cls)

Retorna el número de miembro en `cls':

@example
>>> len(Color)
3
@end example
@end deffn

@geindex __members__ (atributo de enum.EnumType)
@anchor{library/enum enum EnumType __members__}@anchor{25bc}
@deffn {Atributo} __members__

Returns a mapping of every enum name to its member, including aliases
@end deffn

@geindex __reversed__() (método de enum.EnumType)
@anchor{library/enum enum EnumType __reversed__}@anchor{25bd}
@deffn {Método} __reversed__ (cls)

Retorna cada miembro en `cls' en orden de definición inverso:

@example
>>> list(reversed(Color))
[<Color.BLUE: 3>, <Color.GREEN: 2>, <Color.RED: 1>]
@end example
@end deffn

@geindex _add_alias_() (método de enum.EnumType)
@anchor{library/enum enum EnumType _add_alias_}@anchor{25be}
@deffn {Método} _add_alias_ ()

Adds a new name as an alias to an existing member.  Raises a
@ref{4ec,,NameError} if the name is already assigned to a different member.
@end deffn

@geindex _add_value_alias_() (método de enum.EnumType)
@anchor{library/enum enum EnumType _add_value_alias_}@anchor{25bf}
@deffn {Método} _add_value_alias_ ()

Adds a new value as an alias to an existing member.  Raises a
@ref{360,,ValueError} if the value is already linked with a different member.
@end deffn


Added in version 3.11: Before 3.11 @code{EnumType} was called @code{EnumMeta}, which is still available as an alias.

@end deffn

@geindex Enum (clase en enum)
@anchor{library/enum enum Enum}@anchor{6d1}
@deffn {Clase} enum.Enum

`Enum' es la clase base para todas las enumeraciones `enum'.

@geindex name (atributo de enum.Enum)
@anchor{library/enum enum Enum name}@anchor{25c0}
@deffn {Atributo} name

El nombre utilizado para definir el miembro @code{Enum}:

@example
>>> Color.BLUE.name
'BLUE'
@end example
@end deffn

@geindex value (atributo de enum.Enum)
@anchor{library/enum enum Enum value}@anchor{25c1}
@deffn {Atributo} value

El valor dado al miembro @code{Enum}:

@example
>>> Color.RED.value
1
@end example

Value of the member, can be set in @ref{25c2,,__new__()}.

@cartouche
@quotation Nota 
Valores de miembros de Enum

Member values can be anything: @ref{1f0,,int}, @ref{237,,str}, etc.  If
the exact value is unimportant you may use @ref{d25,,auto} instances and an
appropriate value will be chosen for you.  See @ref{d25,,auto} for the
details.

While mutable/unhashable values, such as @ref{190,,dict}, @ref{18e,,list} or
a mutable @ref{32e,,dataclass}, can be used, they will have a
quadratic performance impact during creation relative to the
total number of mutable/unhashable values in the enum.
@end quotation
@end cartouche
@end deffn

@geindex _name_ (atributo de enum.Enum)
@anchor{library/enum enum Enum _name_}@anchor{25c3}
@deffn {Atributo} _name_

Name of the member.
@end deffn

@geindex _value_ (atributo de enum.Enum)
@anchor{library/enum enum Enum _value_}@anchor{25c4}
@deffn {Atributo} _value_

Value of the member, can be set in @ref{25c2,,__new__()}.
@end deffn

@geindex _order_ (atributo de enum.Enum)
@anchor{library/enum enum Enum _order_}@anchor{25c5}
@deffn {Atributo} _order_

No longer used, kept for backward compatibility.
(class attribute, removed during class creation).
@end deffn

@geindex _ignore_ (atributo de enum.Enum)
@anchor{library/enum enum Enum _ignore_}@anchor{25c6}
@deffn {Atributo} _ignore_

@code{_ignore_} solo se usa durante la creación y se elimina de la enumeración una vez que se completa la creación.

@code{_ignore_} es una lista de nombres que no se convertirán en miembros y cuyos nombres también se eliminarán de la enumeración completa. Consulte @ref{25c7,,TimePeriod} para ver un ejemplo.
@end deffn

@geindex __dir__() (método de enum.Enum)
@anchor{library/enum enum Enum __dir__}@anchor{1869}
@deffn {Método} __dir__ (self)

Retorna @code{['__class__', '__doc__', '__module__', 'name', 'value']} y cualquier método público definido en `self.__class__':

@example
>>> from datetime import date
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
...     @@classmethod
...     def today(cls):
...         print('today is %s' % cls(date.today().isoweekday()).name)
...
>>> dir(Weekday.SATURDAY)
['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'today', 'value']
@end example
@end deffn

@geindex _generate_next_value_() (método de enum.Enum)
@anchor{library/enum enum Enum _generate_next_value_}@anchor{25c8}
@deffn {Método} _generate_next_value_ (name, start, count, last_values)

@quotation

@*name: 
El nombre del miembro que se está definiendo (por ejemplo, “RED”).


@*start: 
El valor inicial de Enum; el valor predeterminado es 1.


@*count: 
El número de miembros actualmente definidos, sin incluir este.


@*last_values: 
Una lista de los valores anteriores.

@end quotation

Un `staticmethod' que se usa para determinar el siguiente valor retornado por @ref{d25,,auto}:

@example
>>> from enum import auto
>>> class PowersOfThree(Enum):
...     @@staticmethod
...     def _generate_next_value_(name, start, count, last_values):
...         return 3 ** (count + 1)
...     FIRST = auto()
...     SECOND = auto()
...
>>> PowersOfThree.SECOND.value
9
@end example
@end deffn

@geindex __init__() (método de enum.Enum)
@anchor{library/enum enum Enum __init__}@anchor{25c9}
@deffn {Método} __init__ (self, *args, **kwds)

By default, does nothing.  If multiple values are given in the member
assignment, those values become separate arguments to @code{__init__}; e.g.

@example
>>> from enum import Enum
>>> class Weekday(Enum):
...     MONDAY = 1, 'Mon'
@end example

@code{Weekday.__init__()} would be called as @code{Weekday.__init__(self, 1, 'Mon')}
@end deffn

@geindex __init_subclass__() (método de enum.Enum)
@anchor{library/enum enum Enum __init_subclass__}@anchor{25ca}
@deffn {Método} __init_subclass__ (cls, **kwds)

Un `classmethod' que se usa para configurar más subclases subsiguientes. Por defecto, no hace nada.
@end deffn

@geindex _missing_() (método de enum.Enum)
@anchor{library/enum enum Enum _missing_}@anchor{25cb}
@deffn {Método} _missing_ (cls, value)

Un `classmethod' para buscar valores que no se encuentran en `cls'. De forma predeterminada, no hace nada, pero se puede anular para implementar un comportamiento de búsqueda personalizado:

@example
>>> from enum import StrEnum
>>> class Build(StrEnum):
...     DEBUG = auto()
...     OPTIMIZED = auto()
...     @@classmethod
...     def _missing_(cls, value):
...         value = value.lower()
...         for member in cls:
...             if member.value == value:
...                 return member
...         return None
...
>>> Build.DEBUG.value
'debug'
>>> Build('deBUG')
<Build.DEBUG: 'debug'>
@end example
@end deffn

@geindex __new__() (método de enum.Enum)
@anchor{library/enum enum Enum __new__}@anchor{25c2}
@deffn {Método} __new__ (cls, *args, **kwds)

By default, doesn’t exist.  If specified, either in the enum class
definition or in a mixin class (such as @code{int}), all values given
in the member assignment will be passed; e.g.

@example
>>> from enum import Enum
>>> class MyIntEnum(int, Enum):
...     TWENTYSIX = '1a', 16
@end example

results in the call @code{int('1a', 16)} and a value of @code{26} for the member.

@cartouche
@quotation Nota 
When writing a custom @code{__new__}, do not use @code{super().__new__} –
call the appropriate @code{__new__} instead.
@end quotation
@end cartouche
@end deffn

@geindex __repr__() (método de enum.Enum)
@anchor{library/enum enum Enum __repr__}@anchor{178d}
@deffn {Método} __repr__ (self)

Retorna la cadena utilizada para las llamadas `repr()'. De forma predeterminada, retorna el nombre `Enum', el nombre del miembro y el valor, pero se puede anular:

@example
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __repr__(self):
...         cls_name = self.__class__.__name__
...         return f'@{cls_name@}.@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(OtherStyle.ALTERNATE, 'OtherStyle.ALTERNATE', 'OtherStyle.ALTERNATE')
@end example
@end deffn

@geindex __str__() (método de enum.Enum)
@anchor{library/enum enum Enum __str__}@anchor{6c3}
@deffn {Método} __str__ (self)

Retorna la cadena utilizada para las llamadas `str()'. De forma predeterminada, retorna el nombre `Enum' y el nombre del miembro, pero se puede anular:

@example
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __str__(self):
...         return f'@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(<OtherStyle.ALTERNATE: 1>, 'ALTERNATE', 'ALTERNATE')
@end example
@end deffn

@geindex __format__() (método de enum.Enum)
@anchor{library/enum enum Enum __format__}@anchor{6c1}
@deffn {Método} __format__ (self)

Returns the string used for `format()' and `f-string' calls.  By default,
returns @ref{6c3,,__str__()} return value, but can be overridden:

@example
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __format__(self, spec):
...         return f'@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(<OtherStyle.ALTERNATE: 1>, 'OtherStyle.ALTERNATE', 'ALTERNATE')
@end example
@end deffn

@cartouche
@quotation Nota 
El uso de @ref{d25,,auto} con @ref{6d1,,Enum} da como resultado números enteros de valor creciente, comenzando con @code{1}.
@end quotation
@end cartouche


Distinto en la versión 3.12: Added @ref{178c,,Soporte de Dataclass}

@end deffn

@geindex IntEnum (clase en enum)
@anchor{library/enum enum IntEnum}@anchor{d66}
@deffn {Clase} enum.IntEnum

`IntEnum' is the same as @ref{6d1,,Enum}, but its members are also integers and can be
used anywhere that an integer can be used.  If any integer operation is performed
with an `IntEnum' member, the resulting value loses its enumeration status.

@example
>>> from enum import IntEnum
>>> class Number(IntEnum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...
>>> Number.THREE
<Number.THREE: 3>
>>> Number.ONE + Number.TWO
3
>>> Number.THREE + 5
8
>>> Number.THREE == 3
True
@end example

@cartouche
@quotation Nota 
El uso de @ref{d25,,auto} con @ref{d66,,IntEnum} da como resultado números enteros de valor creciente, comenzando con @code{1}.
@end quotation
@end cartouche


Distinto en la versión 3.11: @ref{6be,,__str__()} is now @code{int.__str__()} to
better support the `replacement of existing constants' use-case.
@ref{6bf,,__format__()} was already @code{int.__format__()} for that same reason.

@end deffn

@geindex StrEnum (clase en enum)
@anchor{library/enum enum StrEnum}@anchor{6bb}
@deffn {Clase} enum.StrEnum

@code{StrEnum} is the same as @ref{6d1,,Enum}, but its members are also strings and can be used
in most of the same places that a string can be used.  The result of any string
operation performed on or with a `StrEnum' member is not part of the enumeration.

@cartouche
@quotation Nota 
Hay lugares en stdlib que buscan un @ref{237,,str} exacto en lugar de una subclase @ref{237,,str} (es decir, @code{type(unknown) == str} en lugar de @code{isinstance(unknown, str)}), y en esos lugares necesitará usar @code{str(StrEnum.member)}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
El uso de @ref{d25,,auto} con @ref{6bb,,StrEnum} da como resultado el nombre de miembro en minúsculas como valor.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@ref{6be,,__str__()} is @code{str.__str__()} to better support the
`replacement of existing constants' use-case.  @ref{6bf,,__format__()} is likewise
@code{str.__format__()} for that same reason.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex Flag (clase en enum)
@anchor{library/enum enum Flag}@anchor{6c4}
@deffn {Clase} enum.Flag

@code{Flag} is the same as @ref{6d1,,Enum}, but its members support the bitwise
operators @code{&} (`AND'), @code{|} (`OR'), @code{^} (`XOR'), and @code{~} (`INVERT');
the results of those operations are (aliases of) members of the enumeration.

@geindex __contains__() (método de enum.Flag)
@anchor{library/enum enum Flag __contains__}@anchor{25cc}
@deffn {Método} __contains__ (self, value)

Retorna `True' si el valor está en sí mismo:

@example
>>> from enum import Flag, auto
>>> class Color(Flag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> purple = Color.RED | Color.BLUE
>>> white = Color.RED | Color.GREEN | Color.BLUE
>>> Color.GREEN in purple
False
>>> Color.GREEN in white
True
>>> purple in white
True
>>> white in purple
False
@end example
@end deffn


@deffn {Método} __iter__(self):

Returns all contained non-alias members:

@example
>>> list(Color.RED)
[<Color.RED: 1>]
>>> list(purple)
[<Color.RED: 1>, <Color.BLUE: 4>]
@end example


Added in version 3.11.

@end deffn


@deffn {Método} __len__(self):

Retorna el número de miembros en la bandera:

@example
>>> len(Color.GREEN)
1
>>> len(white)
3
@end example


Added in version 3.11.

@end deffn


@deffn {Método} __bool__(self):

Retorna `True' si hay algún miembro en la bandera, `False' de lo contrario:

@example
>>> bool(Color.GREEN)
True
>>> bool(white)
True
>>> black = Color(0)
>>> bool(black)
False
@end example
@end deffn

@geindex __or__() (método de enum.Flag)
@anchor{library/enum enum Flag __or__}@anchor{25cd}
@deffn {Método} __or__ (self, other)

Retorna la bandera actual binaria o con otra:

@example
>>> Color.RED | Color.GREEN
<Color.RED|GREEN: 3>
@end example
@end deffn

@geindex __and__() (método de enum.Flag)
@anchor{library/enum enum Flag __and__}@anchor{25ce}
@deffn {Método} __and__ (self, other)

Retorna el binario de la bandera actual y se combina con otro:

@example
>>> purple & white
<Color.RED|BLUE: 5>
>>> purple & Color.GREEN
<Color: 0>
@end example
@end deffn

@geindex __xor__() (método de enum.Flag)
@anchor{library/enum enum Flag __xor__}@anchor{25cf}
@deffn {Método} __xor__ (self, other)

Retorna la bandera actual binaria xor’ed con otra:

@example
>>> purple ^ white
<Color.GREEN: 2>
>>> purple ^ Color.GREEN
<Color.RED|GREEN|BLUE: 7>
@end example
@end deffn


@deffn {Método} __invert__(self):

Returns all the flags in `type(self)' that are not in `self':

@example
>>> ~white
<Color: 0>
>>> ~purple
<Color.GREEN: 2>
>>> ~Color.RED
<Color.GREEN|BLUE: 6>
@end example
@end deffn

@geindex _numeric_repr_() (método de enum.Flag)
@anchor{library/enum enum Flag _numeric_repr_}@anchor{25d0}
@deffn {Método} _numeric_repr_ ()

Función utilizada para dar formato a los valores numéricos restantes sin nombre. El valor predeterminado es la repr del valor; las opciones comunes son @ref{1337,,hex()} y @ref{1336,,oct()}.
@end deffn

@cartouche
@quotation Nota 
El uso de @ref{d25,,auto} con @ref{6c4,,Flag} da como resultado números enteros que son potencias de dos, comenzando con @code{1}.
@end quotation
@end cartouche


Distinto en la versión 3.11: The `repr()' of zero-valued flags has changed.  It
is now:

@example
>>> Color(0) 
<Color: 0>
@end example

@end deffn

@geindex IntFlag (clase en enum)
@anchor{library/enum enum IntFlag}@anchor{22fd}
@deffn {Clase} enum.IntFlag

@code{IntFlag} is the same as @ref{6c4,,Flag}, but its members are also integers and can be
used anywhere that an integer can be used.

@example
>>> from enum import IntFlag, auto
>>> class Color(IntFlag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> Color.RED & 2
<Color: 0>
>>> Color.RED | 2
<Color.RED|GREEN: 3>
@end example

Si se realiza alguna operación con enteros con un miembro `IntFlag', el resultado no es un `IntFlag':

@example
>>> Color.RED + 2
3
@end example

If a @ref{6c4,,Flag} operation is performed with an `IntFlag' member and:


@itemize *

@item 
el resultado es un `IntFlag' válido: se retorna un `IntFlag'

@item 
the result is not a valid `IntFlag': the result depends on the @ref{6c5,,FlagBoundary} setting
@end itemize

The @ref{894,,repr()} of unnamed zero-valued flags has changed.  It is now:

@example
>>> Color(0)
<Color: 0>
@end example

@cartouche
@quotation Nota 
El uso de @ref{d25,,auto} con @ref{22fd,,IntFlag} da como resultado números enteros que son potencias de dos, comenzando con @code{1}.
@end quotation
@end cartouche


Distinto en la versión 3.11: @ref{6be,,__str__()} is now @code{int.__str__()} to better support the
`replacement of existing constants' use-case.  @ref{6bf,,__format__()} was
already @code{int.__format__()} for that same reason.

Inversion of an @code{IntFlag} now returns a positive value that is the
union of all flags not in the given flag, rather than a negative value.
This matches the existing @ref{6c4,,Flag} behavior.

@end deffn

@geindex ReprEnum (clase en enum)
@anchor{library/enum enum ReprEnum}@anchor{6bc}
@deffn {Clase} enum.ReprEnum

@code{ReprEnum} uses the @ref{178d,,repr()} of @ref{6d1,,Enum},
but the @ref{237,,str()} of the mixed-in data type:


@itemize *

@item 
@code{int.__str__()} para @ref{d66,,IntEnum} y @ref{22fd,,IntFlag}

@item 
@code{str.__str__()} para @ref{6bb,,StrEnum}
@end itemize

Inherit from @code{ReprEnum} to keep the @ref{237,,str()} / @ref{6c0,,format()}
of the mixed-in data type instead of using the
@ref{6d1,,Enum}-default @ref{6c3,,str()}.


Added in version 3.11.

@end deffn

@geindex EnumCheck (clase en enum)
@anchor{library/enum enum EnumCheck}@anchor{6c7}
@deffn {Clase} enum.EnumCheck

`EnumCheck' contiene las opciones utilizadas por el decorador @ref{6c6,,verify()} para garantizar diversas restricciones; las restricciones fallidas dan como resultado un @ref{360,,ValueError}.

@geindex UNIQUE (atributo de enum.EnumCheck)
@anchor{library/enum enum EnumCheck UNIQUE}@anchor{25d1}
@deffn {Atributo} UNIQUE

Asegúrese de que cada valor tenga un solo nombre:

@example
>>> from enum import Enum, verify, UNIQUE
>>> @@verify(UNIQUE)
... class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
...     CRIMSON = 1
Traceback (most recent call last):
...
ValueError: aliases found in <enum 'Color'>: CRIMSON -> RED
@end example
@end deffn

@geindex CONTINUOUS (atributo de enum.EnumCheck)
@anchor{library/enum enum EnumCheck CONTINUOUS}@anchor{25d2}
@deffn {Atributo} CONTINUOUS

Asegúrese de que no falten valores entre el miembro de menor valor y el miembro de mayor valor:

@example
>>> from enum import Enum, verify, CONTINUOUS
>>> @@verify(CONTINUOUS)
... class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 5
Traceback (most recent call last):
...
ValueError: invalid enum 'Color': missing values 3, 4
@end example
@end deffn

@geindex NAMED_FLAGS (atributo de enum.EnumCheck)
@anchor{library/enum enum EnumCheck NAMED_FLAGS}@anchor{25d3}
@deffn {Atributo} NAMED_FLAGS

Ensure that any flag groups/masks contain only named flags – useful when
values are specified instead of being generated by @ref{d25,,auto()}:

@example
>>> from enum import Flag, verify, NAMED_FLAGS
>>> @@verify(NAMED_FLAGS)
... class Color(Flag):
...     RED = 1
...     GREEN = 2
...     BLUE = 4
...     WHITE = 15
...     NEON = 31
Traceback (most recent call last):
...
ValueError: invalid Flag 'Color': aliases WHITE and NEON are missing combined values of 0x18 [use enum.show_flag_values(value) for details]
@end example
@end deffn

@cartouche
@quotation Nota 
CONTINUOUS y NAMED_FLAGS están diseñados para funcionar con miembros con valores enteros.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex FlagBoundary (clase en enum)
@anchor{library/enum enum FlagBoundary}@anchor{6c5}
@deffn {Clase} enum.FlagBoundary

@code{FlagBoundary} controls how out-of-range values are handled in @ref{6c4,,Flag} and its
subclasses.

@geindex STRICT (atributo de enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary STRICT}@anchor{25d4}
@deffn {Atributo} STRICT

Out-of-range values cause a @ref{360,,ValueError} to be raised. This is the
default for @ref{6c4,,Flag}:

@example
>>> from enum import Flag, STRICT, auto
>>> class StrictFlag(Flag, boundary=STRICT):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> StrictFlag(2**2 + 2**4)
Traceback (most recent call last):
...
ValueError: <flag 'StrictFlag'> invalid value 20
    given 0b0 10100
  allowed 0b0 00111
@end example
@end deffn

@geindex CONFORM (atributo de enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary CONFORM}@anchor{25d5}
@deffn {Atributo} CONFORM

Out-of-range values have invalid values removed, leaving a valid @ref{6c4,,Flag}
value:

@example
>>> from enum import Flag, CONFORM, auto
>>> class ConformFlag(Flag, boundary=CONFORM):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> ConformFlag(2**2 + 2**4)
<ConformFlag.BLUE: 4>
@end example
@end deffn

@geindex EJECT (atributo de enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary EJECT}@anchor{25d6}
@deffn {Atributo} EJECT

Out-of-range values lose their @ref{6c4,,Flag} membership and revert to @ref{1f0,,int}.

@example
>>> from enum import Flag, EJECT, auto
>>> class EjectFlag(Flag, boundary=EJECT):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> EjectFlag(2**2 + 2**4)
20
@end example
@end deffn

@geindex KEEP (atributo de enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary KEEP}@anchor{25d7}
@deffn {Atributo} KEEP

Out-of-range values are kept, and the @ref{6c4,,Flag} membership is kept.
This is the default for @ref{22fd,,IntFlag}:

@example
>>> from enum import Flag, KEEP, auto
>>> class KeepFlag(Flag, boundary=KEEP):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> KeepFlag(2**2 + 2**4)
<KeepFlag.BLUE|16: 20>
@end example
@end deffn
@end deffn


Added in version 3.11.



__________________________________________________________________


@menu
* Nombres soportados __dunder__:: 
* Nombres _sunder_ compatibles:: 

@end menu

@node Nombres soportados __dunder__,Nombres _sunder_ compatibles,,Tipos de datos<2>
@anchor{library/enum supported-dunder-names}@anchor{25d8}
@subsubsection Nombres soportados @code{__dunder__}


@ref{25bc,,__members__} is a read-only ordered mapping of @code{member_name}:@code{member}
items.  It is only available on the class.

@ref{25c2,,__new__()}, if specified, must create and return the enum members;
it is also a very good idea to set the member’s @code{_value_} appropriately.
Once all the members are created it is no longer used.

@node Nombres _sunder_ compatibles,,Nombres soportados __dunder__,Tipos de datos<2>
@anchor{library/enum supported-sunder-names}@anchor{25d9}
@subsubsection Nombres @code{_sunder_} compatibles



@itemize -

@item 
@ref{25be,,_add_alias_()} – adds a new name as an alias to an existing
member.

@item 
@ref{25bf,,_add_value_alias_()} – adds a new value as an alias to an
existing member.

@item 
@ref{25c3,,_name_} – name of the member

@item 
@ref{25c4,,_value_} – value of the member; can be set in @code{__new__}

@item 
@ref{25cb,,_missing_()} – a lookup function used when a value is not found;
may be overridden

@item 
@ref{25c6,,_ignore_} – a list of names, either as a @ref{18e,,list} or a
@ref{237,,str}, that will not be transformed into members, and will be removed
from the final class

@item 
@ref{25c5,,_order_} – no longer used, kept for backward
compatibility (class attribute, removed during class creation)

@item 
@ref{25c8,,_generate_next_value_()} – used to get an appropriate value for
an enum member; may be overridden

@cartouche
@quotation Nota 
For standard @ref{6d1,,Enum} classes the next value chosen is the highest
value seen incremented by one.

For @ref{6c4,,Flag} classes the next value chosen will be the next highest
power-of-two.
@end quotation
@end cartouche

@item 
While @code{_sunder_} names are generally reserved for the further development
of the @ref{6d1,,Enum} class and can not be used, some are explicitly allowed:


@itemize -

@item 
@code{_repr_*} (e.g. @code{_repr_html_}), as used in IPython's rich display@footnote{https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display}
@end itemize
@end itemize


Added in version 3.6: @code{_missing_}, @code{_order_}, @code{_generate_next_value_}



Added in version 3.7: @code{_ignore_}



Added in version 3.13: @code{_add_alias_}, @code{_add_value_alias_}, @code{_repr_*}



__________________________________________________________________


@node Utilidades y decoradores,Notas,Tipos de datos<2>,enum — Support for enumerations
@anchor{library/enum ipython-s-rich-display}@anchor{25da}@anchor{library/enum utilities-and-decorators}@anchor{25db}
@subsubsection Utilidades y decoradores


@geindex auto (clase en enum)
@anchor{library/enum enum auto}@anchor{d25}
@deffn {Clase} enum.auto

`auto' can be used in place of a value.  If used, the `Enum' machinery will
call an @ref{6d1,,Enum}’s @ref{25c8,,_generate_next_value_()} to get an appropriate value.
For @ref{6d1,,Enum} and @ref{d66,,IntEnum} that appropriate value will be the last value plus
one; for @ref{6c4,,Flag} and @ref{22fd,,IntFlag} it will be the first power-of-two greater
than the highest value; for @ref{6bb,,StrEnum} it will be the lower-cased version of
the member’s name.  Care must be taken if mixing `auto()' with manually
specified values.

`auto' instances are only resolved when at the top level of an assignment:


@itemize *

@item 
@code{FIRST = auto()} will work (auto() is replaced with @code{1});

@item 
@code{SECOND = auto(), -2} will work (auto is replaced with @code{2}, so @code{2, -2} is
used to create the @code{SECOND} enum member;

@item 
@code{THREE = [auto(), -3]} will `not' work (@code{<auto instance>, -3} is used to
create the @code{THREE} enum member)
@end itemize


Distinto en la versión 3.11.1: In prior versions, @code{auto()} had to be the only thing
on the assignment line to work properly.


@code{_generate_next_value_} se puede anular para personalizar los valores utilizados por `auto'.

@cartouche
@quotation Nota 
in 3.13 the default @code{_generate_next_value_} will always return
the highest member value incremented by 1, and will fail if any
member is an incompatible type.
@end quotation
@end cartouche
@end deffn

@geindex property() (en el módulo enum)
@anchor{library/enum enum property}@anchor{6ca}
@deffn {Función} @@enum.property

Un decorador similar al `property' integrado, pero específico para enumeraciones. Permite que los atributos de los miembros tengan los mismos nombres que los propios miembros.

@cartouche
@quotation Nota 
el `property' y el miembro deben definirse en clases separadas; por ejemplo, los atributos `value' y `name' se definen en la clase `Enum' y las subclases `Enum' pueden definir miembros con los nombres @code{value} y @code{name}.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex unique() (en el módulo enum)
@anchor{library/enum enum unique}@anchor{25b2}
@deffn {Función} @@enum.unique

A @ref{133f,,class} decorator specifically for enumerations.  It searches an
enumeration’s @ref{25bc,,__members__}, gathering any aliases it finds; if any are
found @ref{360,,ValueError} is raised with the details:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Mistake(Enum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...     FOUR = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
@end example
@end deffn

@geindex verify() (en el módulo enum)
@anchor{library/enum enum verify}@anchor{6c6}
@deffn {Función} @@enum.verify

Un decorador @ref{133f,,class} específicamente para enumeraciones. Los miembros de @ref{6c7,,EnumCheck} se utilizan para especificar qué restricciones deben verificarse en la enumeración decorada.


Added in version 3.11.

@end deffn

@geindex member() (en el módulo enum)
@anchor{library/enum enum member}@anchor{6c8}
@deffn {Función} @@enum.member

Un decorador para usar en enumeraciones: su objetivo se convertirá en miembro.


Added in version 3.11.

@end deffn

@geindex nonmember() (en el módulo enum)
@anchor{library/enum enum nonmember}@anchor{6c9}
@deffn {Función} @@enum.nonmember

Un decorador para usar en enumeraciones: su destino no se convertirá en miembro.


Added in version 3.11.

@end deffn

@geindex global_enum() (en el módulo enum)
@anchor{library/enum enum global_enum}@anchor{6cc}
@deffn {Función} @@enum.global_enum

Un decorador para cambiar el @ref{237,,str()} y @ref{894,,repr()} de una enumeración para mostrar sus miembros como pertenecientes al módulo en lugar de a su clase. Solo debe usarse cuando los miembros de la enumeración se exportan al espacio de nombres global del módulo (consulte @ref{6ce,,re.RegexFlag} para ver un ejemplo).


Added in version 3.11.

@end deffn

@geindex show_flag_values() (en el módulo enum)
@anchor{library/enum enum show_flag_values}@anchor{25b3}
@deffn {Función} enum.show_flag_values (value)

Retorna una lista de todos los enteros de potencia de dos contenidos en un indicador `value'.


Added in version 3.11.

@end deffn


__________________________________________________________________


@node Notas,,Utilidades y decoradores,enum — Support for enumerations
@anchor{library/enum notes}@anchor{25b1}
@subsubsection Notas


@ref{d66,,IntEnum}, @ref{6bb,,StrEnum} y @ref{22fd,,IntFlag}

@quotation

Estos tres tipos de enumeración están diseñados para ser reemplazos directos de los valores existentes basados ​​en cadenas y enteros; como tales, tienen limitaciones adicionales:


@itemize -

@item 
@code{__str__} usa el valor y no el nombre del miembro de enumeración

@item 
@code{__format__}, debido a que usa @code{__str__}, también usará el valor del miembro de enumeración en lugar de su nombre
@end itemize

Si no necesita/quiere esas limitaciones, puede crear su propia clase base mezclando el tipo @code{int} o @code{str} usted mismo:

@example
>>> from enum import Enum
>>> class MyIntEnum(int, Enum):
...     pass
@end example

o puede reasignar el @ref{237,,str()} apropiado, etc., en su enumeración:

@example
>>> from enum import Enum, IntEnum
>>> class MyIntEnum(IntEnum):
...     __str__ = Enum.__str__
@end example
@end quotation

@node graphlib — Functionality to operate with graph-like structures,,enum — Support for enumerations,Tipos de datos
@anchor{library/graphlib doc}@anchor{25dc}@anchor{library/graphlib graphlib-functionality-to-operate-with-graph-like-structures}@anchor{25dd}@anchor{library/graphlib module-graphlib}@anchor{65}
@subsection @code{graphlib} — Functionality to operate with graph-like structures


@geindex module; graphlib

`Código fuente:' Lib/graphlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/graphlib.py}

@c import graphlib
@c from graphlib import *


__________________________________________________________________


@geindex TopologicalSorter (clase en graphlib)
@anchor{library/graphlib graphlib TopologicalSorter}@anchor{978}
@deffn {Clase} graphlib.TopologicalSorter (graph=None)

Provides functionality to topologically sort a graph of @ref{6b1,,hashable} nodes.

Un ordenamiento topológico es un ordenamiento lineal de los vértices en un grafo de modo que para cada arista dirigida u -> v desde el vértice u al vértice v, el vértice u viene antes del vértice v en el ordenamiento. Por ejemplo, los vértices del grafo pueden representar tareas a realizar y las aristas pueden representar restricciones de que una tarea debe realizarse antes que otra; en este ejemplo, un ordenamiento topológico es solo una secuencia válida para las tareas. Es posible un ordenamiento topológico completo si y solo si el grafo no tiene ciclos dirigidos, es decir, si es un grafo acíclico dirigido.

Si se proporciona el argumento opcional `graph', este debe ser un diccionario que represente un grafo acíclico dirigido donde las claves son nodos y los valores son iterables de todos los predecesores de ese nodo en el grafo (los nodos que tienen las aristas que apuntan al valor clave). Se pueden agregar nodos adicionales al grafo utilizando el @ref{25de,,add()} method.

En el caso general, los pasos necesarios para realizar el ordenamiento de un grafo son los siguientes:


@itemize *

@item 
Cree una instancia @ref{978,,TopologicalSorter} con un grafo inicial opcional.

@item 
Agregue nodos adicionales al grafo.

@item 
Llame a @ref{25df,,prepare()} en el grafo.

@item 
Mientras @ref{25e0,,is_active()} is @code{True}, itere sobre los nodos retornados por @ref{25e1,,get_ready()} y procéselos . Llame a @ref{25e2,,done()} en cada nodo a medida que finaliza el procesamiento.
@end itemize

En caso de que sólo se requiera una ordenación inmediata de los nodos del grafo y no haya paralelismo, se puede utilizar directamente el método de conveniencia @ref{25e3,,TopologicalSorter.static_order()}

@example
>>> graph = @{"D": @{"B", "C"@}, "C": @{"A"@}, "B": @{"A"@}@}
>>> ts = TopologicalSorter(graph)
>>> tuple(ts.static_order())
('A', 'C', 'B', 'D')
@end example

La clase está diseñada para soportar fácilmente el procesamiento en paralelo de los nodos a medida que estén listos. Para la instancia:

@example
topological_sorter = TopologicalSorter()

# Add nodes to 'topological_sorter'...

topological_sorter.prepare()
while topological_sorter.is_active():
    for node in topological_sorter.get_ready():
        # Worker threads or processes take nodes to work on off the
        # 'task_queue' queue.
        task_queue.put(node)

    # When the work for a node is done, workers put the node in
    # 'finalized_tasks_queue' so we can get more nodes to work on.
    # The definition of 'is_active()' guarantees that, at this point, at
    # least one node has been placed on 'task_queue' that hasn't yet
    # been passed to 'done()', so this blocking 'get()' must (eventually)
    # succeed.  After calling 'done()', we loop back to call 'get_ready()'
    # again, so put newly freed nodes on 'task_queue' as soon as
    # logically possible.
    node = finalized_tasks_queue.get()
    topological_sorter.done(node)
@end example

@geindex add() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter add}@anchor{25de}
@deffn {Método} add (node, *predecessors)

Add a new node and its predecessors to the graph. Both the `node' and all
elements in `predecessors' must be @ref{6b1,,hashable}.

Si se llama varias veces con el mismo argumento del nodo, el conjunto de dependencias será la unión de todas las dependencias pasadas.

Es posible añadir un nodo sin dependencias (no se proporciona `predecessors') o proporcionar una dependencia dos veces. Si un nodo que no se ha proporcionado antes se incluye entre los `predecessors', se añadirá automáticamente al grafo sin predecesores propios.

Provoca @ref{360,,ValueError} si se llama después de @ref{25df,,prepare()}.
@end deffn

@geindex prepare() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter prepare}@anchor{25df}
@deffn {Método} prepare ()

Marca el grafo como terminado y comprueba si existen ciclos en el grafo. Si se detecta algún ciclo, se lanzará @ref{25e4,,CycleError}, pero se puede seguir utilizando @ref{25e1,,get_ready()} para obtener tantos nodos como sea posible hasta que los ciclos bloqueen más el progreso. Después de una llamada a esta función, el grafo no puede ser modificado, y por lo tanto no se pueden añadir más nodos utilizando @ref{25de,,add()}.
@end deffn

@geindex is_active() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter is_active}@anchor{25e0}
@deffn {Método} is_active ()

Retorna @code{True} si se puede avanzar más y @code{False} en caso contrario. Se puede avanzar si los ciclos no bloquean la resolución y, o bien todavía existen nodos listos que aún no han sido retornados por @ref{25e1,,TopologicalSorter.get_ready()} o el número de nodos marcados con @ref{25e2,,TopologicalSorter.done()} es menor que el número que han sido retornados por @ref{25e1,,TopologicalSorter.get_ready()}.

The @ref{133d,,__bool__()} method of this class defers to
this function, so instead of:

@example
if ts.is_active():
    ...
@end example

es posible hacer simplemente:

@example
if ts:
    ...
@end example

Lanzar @ref{360,,ValueError} si se llama sin llamar previamente a @ref{25df,,prepare()}.
@end deffn

@geindex done() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter done}@anchor{25e2}
@deffn {Método} done (*nodes)

Marca un conjunto de nodos retornados por @ref{25e1,,TopologicalSorter.get_ready()} como procesados, desbloqueando cualquier sucesor de cada nodo en `nodes' para ser retornado en el futuro por una llamada a @ref{25e1,,TopologicalSorter.get_ready()}.

Lanza @ref{360,,ValueError} si algún nodo de `nodes' ya ha sido marcado como procesado por una llamada anterior a este método o si un nodo no fue añadido al grafo usando @ref{25de,,TopologicalSorter.add()}, si se llama sin llamar a @ref{25df,,prepare()} o si el nodo aún no ha sido retornado por @ref{25e1,,get_ready()}.
@end deffn

@geindex get_ready() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter get_ready}@anchor{25e1}
@deffn {Método} get_ready ()

Retorna una @code{tupla} con todos los nodos que están listos. Inicialmente retorna todos los nodos sin predecesores, y una vez que éstos se marcan como procesados llamando a @ref{25e2,,TopologicalSorter.done()}, las llamadas posteriores devolverán todos los nuevos nodos que tengan todos sus predecesores ya procesados. Una vez que no se puede avanzar más, se retornan tuplas vacías.

Lanzar @ref{360,,ValueError} si se llama sin llamar previamente a @ref{25df,,prepare()}.
@end deffn

@geindex static_order() (método de graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter static_order}@anchor{25e3}
@deffn {Método} static_order ()

Retorna un iterable de nodos en un ordenamiento topológico. El uso de este método no requiere llamar a @ref{25df,,TopologicalSorter.prepare()} o @ref{25e2,,TopologicalSorter.done()}. Este método es equivalente a:

@example
def static_order(self):
    self.prepare()
    while self.is_active():
        node_group = self.get_ready()
        yield from node_group
        self.done(*node_group)
@end example

El orden concreto que se retorna puede depender del orden específico en que se insertaron los elementos en el grafo. Por ejemplo:

@example
>>> ts = TopologicalSorter()
>>> ts.add(3, 2, 1)
>>> ts.add(1, 0)
>>> print([*ts.static_order()])
[2, 0, 1, 3]

>>> ts2 = TopologicalSorter()
>>> ts2.add(1, 0)
>>> ts2.add(3, 2, 1)
>>> print([*ts2.static_order()])
[0, 2, 1, 3]
@end example

Esto se debe a que «0» y «2» están en el mismo nivel en el gráfico (habrían sido retornados en la misma llamada a @ref{25e1,,get_ready()}) y el orden entre ellos está determinado por el orden de inserción.

Si se detecta algún ciclo, se lanzará @ref{25e4,,CycleError}.
@end deffn


Added in version 3.9.

@end deffn

@menu
* Excepciones: Excepciones<4>. 

@end menu

@node Excepciones<4>,,,graphlib — Functionality to operate with graph-like structures
@anchor{library/graphlib exceptions}@anchor{25e5}
@subsubsection Excepciones


El módulo @ref{65,,graphlib} define las siguientes clases de excepción:

@geindex CycleError
@anchor{library/graphlib graphlib CycleError}@anchor{25e4}
@deffn {Excepción} graphlib.CycleError

Subclase de @ref{360,,ValueError} planteada por @ref{25df,,TopologicalSorter.prepare()} si existen ciclos en el grafo de trabajo. Si existen múltiples ciclos, sólo se informará de una elección indefinida entre ellos y se incluirá en la excepción.

The detected cycle can be accessed via the second element in the @ref{610,,args}
attribute of the exception instance and consists in a list of nodes, such that each node is,
in the graph, an immediate predecessor of the next node in the list. In the reported list,
the first and the last node will be the same, to make it clear that it is cyclic.
@end deffn

@node Módulos numéricos y matemáticos,Módulos de programación funcional,Tipos de datos,La biblioteca estándar de Python
@anchor{library/numeric doc}@anchor{25e6}@anchor{library/numeric numeric}@anchor{25e7}@anchor{library/numeric numeric-and-mathematical-modules}@anchor{25e8}
@section Módulos numéricos y matemáticos


Los módulos descritos en este capítulo proporcionan funciones y tipos de datos numéricos y relacionados con las matemáticas. El módulo @ref{9e,,numbers} define una jerarquía abstracta de tipos numéricos. Los módulos @ref{8e,,math} y @ref{19,,cmath} contienen varias funciones matemáticas para números complejos y de punto flotante. El módulo @ref{37,,decimal} admite representaciones exactas de números decimales, utilizando aritmética de precisión arbitraria.

En este capítulo se documentan los siguientes módulos:

@menu
* numbers — Numeric abstract base classes:: 
* math — Mathematical functions:: 
* cmath — Mathematical functions for complex numbers:: 
* decimal — Decimal fixed-point and floating-point arithmetic:: 
* fractions — Rational numbers:: 
* random — Generate pseudo-random numbers:: 
* statistics — Mathematical statistics functions:: 

@end menu

@node numbers — Numeric abstract base classes,math — Mathematical functions,,Módulos numéricos y matemáticos
@anchor{library/numbers doc}@anchor{25e9}@anchor{library/numbers module-numbers}@anchor{9e}@anchor{library/numbers numbers-numeric-abstract-base-classes}@anchor{25ea}
@subsection @code{numbers} — Numeric abstract base classes


@geindex module; numbers

`Código fuente:' Lib/numbers.py@footnote{https://github.com/python/cpython/tree/main/Lib/numbers.py}


__________________________________________________________________


The @code{numbers} module (
@geindex Python Enhancement Proposals; PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/}) defines a hierarchy of numeric
@ref{1224,,abstract base classes} which progressively define
more operations.  None of the types defined in this module are intended to be instantiated.

@geindex Number (clase en numbers)
@anchor{library/numbers numbers Number}@anchor{25eb}
@deffn {Clase} numbers.Number

La raíz de la jerarquía numérica. Si desea validar si un argumento `x' es un número, sin importar su tipo, use @code{isinstance(x, Number)}.
@end deffn

@menu
* La torre numérica:: 
* Notes for type implementers:: 

@end menu

@node La torre numérica,Notes for type implementers,,numbers — Numeric abstract base classes
@anchor{library/numbers the-numeric-tower}@anchor{25ec}
@subsubsection La torre numérica


@geindex Complex (clase en numbers)
@anchor{library/numbers numbers Complex}@anchor{21a8}
@deffn {Clase} numbers.Complex

Las subclases de este tipo describen números complejos e incluyen las operaciones que funcionan en el tipo @ref{154,,complex} integrado. Estos son: conversiones a @ref{154,,complex} y @ref{513,,bool}, @ref{25ed,,real}, @ref{25ee,,imag}, @code{+}, @code{-}, @code{*}, @code{/}, @code{**}, @ref{1cab,,abs()}, @ref{25ef,,conjugate()}, @code{==} y @code{!=}. Todos excepto @code{-} y @code{!=} son abstractos.

@geindex real (atributo de numbers.Complex)
@anchor{library/numbers numbers Complex real}@anchor{25ed}
@deffn {Atributo} real

Abstracto. Recupera el componente real de este número.
@end deffn

@geindex imag (atributo de numbers.Complex)
@anchor{library/numbers numbers Complex imag}@anchor{25ee}
@deffn {Atributo} imag

Abstracto. Recupera el componente imaginario de este número.
@end deffn

@geindex conjugate() (método de numbers.Complex)
@anchor{library/numbers numbers Complex conjugate}@anchor{25ef}
@deffn {Método} abstractmethod conjugate ()

Abstracto. Retorna el complejo conjugado. Por ejemplo, @code{(1+3j).conjugate() == (1-3j)}.
@end deffn
@end deffn

@geindex Real (clase en numbers)
@anchor{library/numbers numbers Real}@anchor{219e}
@deffn {Clase} numbers.Real

To @ref{21a8,,Complex}, @code{Real} adds the operations that work on real
numbers.

En resumen, estos son: conversiones a @ref{153,,float}, @ref{1403,,math.trunc()}, @ref{1342,,round()}, @ref{1401,,math.floor()}, @ref{1402,,math.ceil()}, @ref{a33,,divmod()}, @code{//}, @code{%}, @code{<}, @code{<=}, @code{>}, y @code{>=}.

`Real' también proporciona valores predeterminados para  @ref{154,,complex()}, @ref{25ed,,real}, @ref{25ee,,imag}, y @ref{25ef,,conjugate()}.
@end deffn

@geindex Rational (clase en numbers)
@anchor{library/numbers numbers Rational}@anchor{132a}
@deffn {Clase} numbers.Rational

Subtipos @ref{219e,,Real} y agrega propiedades de @ref{25f0,,numerator} y @ref{25f1,,denominator}. También proporciona un valor predeterminado para @ref{153,,float()}.

Los valores del @ref{25f0,,numerator} y del @ref{25f1,,denominator} deben ser instancias de @ref{1fbc,,Integral} y deben estar en términos mínimos con @ref{25f1,,denominator} positivo.

@geindex numerator (atributo de numbers.Rational)
@anchor{library/numbers numbers Rational numerator}@anchor{25f0}
@deffn {Atributo} numerator

Abstracto.
@end deffn

@geindex denominator (atributo de numbers.Rational)
@anchor{library/numbers numbers Rational denominator}@anchor{25f1}
@deffn {Atributo} denominator

Abstracto.
@end deffn
@end deffn

@geindex Integral (clase en numbers)
@anchor{library/numbers numbers Integral}@anchor{1fbc}
@deffn {Clase} numbers.Integral

Subtipos @ref{132a,,Rational} y agrega una conversión a @ref{1f0,,int}. Proporciona valores predeterminados para @ref{153,,float()}, @ref{25f0,,numerator} y @ref{25f1,,denominator}. Agrega métodos abstractos para @ref{a64,,pow()} con operaciones de módulo y cadena de bits: @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}, @code{~}.
@end deffn

@node Notes for type implementers,,La torre numérica,numbers — Numeric abstract base classes
@anchor{library/numbers notes-for-type-implementers}@anchor{25f2}
@subsubsection Notes for type implementers


Implementers should be careful to make equal numbers equal and hash
them to the same values. This may be subtle if there are two different
extensions of the real numbers. For example, @ref{177,,fractions.Fraction}
implements @ref{68b,,hash()} as follows:

@example
def __hash__(self):
    if self.denominator == 1:
        # Get integers right.
        return hash(self.numerator)
    # Expensive check, but definitely correct.
    if self == float(self):
        return hash(float(self))
    else:
        # Use tuple's hash to avoid a high collision rate on
        # simple fractions.
        return hash((self.numerator, self.denominator))
@end example

@menu
* Agregar más ABCs numéricos:: 
* Implementar operaciones aritméticas:: 

@end menu

@node Agregar más ABCs numéricos,Implementar operaciones aritméticas,,Notes for type implementers
@anchor{library/numbers adding-more-numeric-abcs}@anchor{25f3}
@subsubsection Agregar más `ABCs' numéricos


Por supuesto, hay más `ABCs' posibles para los números, y esto sería una jerarquía deficiente si se excluye la posibilidad de añadirlos. Puede usar @code{MyFoo} entre @ref{21a8,,Complex} y @ref{219e,,Real} así:

@example
class MyFoo(Complex): ...
MyFoo.register(Real)
@end example

@node Implementar operaciones aritméticas,,Agregar más ABCs numéricos,Notes for type implementers
@anchor{library/numbers id1}@anchor{25f4}@anchor{library/numbers implementing-the-arithmetic-operations}@anchor{1ee7}
@subsubsection Implementar operaciones aritméticas


We want to implement the arithmetic operations so that mixed-mode
operations either call an implementation whose author knew about the
types of both arguments, or convert both to the nearest built in type
and do the operation there. For subtypes of @ref{1fbc,,Integral}, this
means that @ref{1f8c,,__add__()} and @ref{1f8d,,__radd__()} should be
defined as:

@example
class MyIntegral(Integral):

    def __add__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(self, other)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(self, other)
        else:
            return NotImplemented

    def __radd__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(other, self)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(other, self)
        elif isinstance(other, Integral):
            return int(other) + int(self)
        elif isinstance(other, Real):
            return float(other) + float(self)
        elif isinstance(other, Complex):
            return complex(other) + complex(self)
        else:
            return NotImplemented
@end example

Hay 5 casos diferentes para una operación de tipo mixto en subclases de @ref{21a8,,Complex}. Se explicará  todo el código anterior que no se refiere a @code{MyIntegral} y @code{OtherTypeIKnowAbout} como «repetitivo». @code{a} será una instancia de @code{A}, que es un subtipo de @ref{21a8,,Complex} (@code{a: A <: Complex}), y @code{b : B <: Complex}. Consideraré @code{a + b}:


@enumerate 

@item 
If @code{A} defines an @ref{1f8c,,__add__()} which accepts @code{b}, all is
well.

@item 
If @code{A} falls back to the boilerplate code, and it were to
return a value from @ref{1f8c,,__add__()}, we’d miss the possibility
that @code{B} defines a more intelligent @ref{1f8d,,__radd__()}, so the
boilerplate should return @ref{227,,NotImplemented} from
@code{__add__()}. (Or @code{A} may not implement @code{__add__()} at
all.)

@item 
Then @code{B}’s @ref{1f8d,,__radd__()} gets a chance. If it accepts
@code{a}, all is well.

@item 
Si se vuelve a caer en el código repetitivo, no hay más posibles métodos para probar, por lo que acá debería vivir la implementación predeterminada.

@item 
Si @code{B <: A}, Python probara @code{B.__radd__} antes que @code{A.__add__}. Esto está bien, porque se implementó con conocimiento de @code{A}, por lo que puede manejar instancias antes de delegar un @ref{21a8,,Complex}.
@end enumerate

If @code{A <: Complex} and @code{B <: Real} without sharing any other knowledge,
then the appropriate shared operation is the one involving the built
in @ref{154,,complex}, and both @ref{1f8d,,__radd__()} s land there, so @code{a+b
== b+a}.

Dado que la mayoría de las operaciones en un tipo determinado serán muy similares, puede ser útil definir una función auxiliar que genere las instancias `forward' y `reverse' de cualquier operador dado. Por ejemplo, @ref{177,,fractions.Fraction} así:

@example
def _operator_fallbacks(monomorphic_operator, fallback_operator):
    def forward(a, b):
        if isinstance(b, (int, Fraction)):
            return monomorphic_operator(a, b)
        elif isinstance(b, float):
            return fallback_operator(float(a), b)
        elif isinstance(b, complex):
            return fallback_operator(complex(a), b)
        else:
            return NotImplemented
    forward.__name__ = '__' + fallback_operator.__name__ + '__'
    forward.__doc__ = monomorphic_operator.__doc__

    def reverse(b, a):
        if isinstance(a, Rational):
            # Includes ints.
            return monomorphic_operator(a, b)
        elif isinstance(a, Real):
            return fallback_operator(float(a), float(b))
        elif isinstance(a, Complex):
            return fallback_operator(complex(a), complex(b))
        else:
            return NotImplemented
    reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
    reverse.__doc__ = monomorphic_operator.__doc__

    return forward, reverse

def _add(a, b):
    """a + b"""
    return Fraction(a.numerator * b.denominator +
                    b.numerator * a.denominator,
                    a.denominator * b.denominator)

__add__, __radd__ = _operator_fallbacks(_add, operator.add)

# ...
@end example

@node math — Mathematical functions,cmath — Mathematical functions for complex numbers,numbers — Numeric abstract base classes,Módulos numéricos y matemáticos
@anchor{library/math doc}@anchor{25f5}@anchor{library/math math-mathematical-functions}@anchor{25f6}@anchor{library/math module-math}@anchor{8e}
@subsection @code{math} — Mathematical functions


@geindex module; math

@c from math import fsum


__________________________________________________________________


Este módulo proporciona acceso a las funciones matemáticas definidas en el estándar de C.

Estas funciones no pueden ser usadas con números complejos; usa las funciones con el mismo nombre del módulo @ref{19,,cmath} si requieres soporte para números complejos. La distinción entre las funciones que admiten números complejos y las que no se hace debido a que la mayoría de los usuarios no quieren aprender tantas matemáticas como se requiere para comprender los números complejos. Recibir una excepción en lugar de un resultado complejo permite la detección temprana del número complejo inesperado utilizado como parámetro, de modo que el programador pueda determinar cómo y porqué se generó en primer lugar.

Este módulo proporciona las funciones descritas a continuación. Excepto cuando se indique lo contrario explícitamente, todos los valores retornados son flotantes.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

`Number-theoretic and representation functions'

@tab

@item

@ref{1402,,ceil(x)}

@tab

Ceiling of `x', the smallest integer greater than or equal to `x'

@item

@ref{770,,comb(n@comma{} k)}

@tab

Number of ways to choose `k' items from `n' items without repetition and without order

@item

@ref{1413,,copysign(x@comma{} y)}

@tab

Magnitude (absolute value) of `x' with the sign of `y'

@item

@ref{25f7,,fabs(x)}

@tab

Absolute value of `x'

@item

@ref{9da,,factorial(n)}

@tab

`n' factorial

@item

@ref{1401,,floor (x)}

@tab

Floor of `x', the largest integer less than or equal to `x'

@item

@ref{363,,fma(x@comma{} y@comma{} z)}

@tab

Fused multiply-add operation: @code{(x * y) + z}

@item

@ref{2068,,fmod(x@comma{} y)}

@tab

Remainder of division @code{x / y}

@item

@ref{25f8,,frexp(x)}

@tab

Mantissa and exponent of `x'

@item

@ref{1414,,fsum(iterable)}

@tab

Sum of values in the input `iterable'

@item

@ref{9a6,,gcd(*integers)}

@tab

Greatest common divisor of the integer arguments

@item

@ref{e36,,isclose(a@comma{} b@comma{} rel_tol@comma{} abs_tol)}

@tab

Check if the values `a' and `b' are close to each other

@item

@ref{1258,,isfinite(x)}

@tab

Check if `x' is neither an infinity nor a NaN

@item

@ref{1411,,isinf(x)}

@tab

Check if `x' is a positive or negative infinity

@item

@ref{1412,,isnan(x)}

@tab

Check if `x' is a NaN  (not a number)

@item

@ref{a97,,isqrt(n)}

@tab

Integer square root of a nonnegative integer `n'

@item

@ref{9a7,,lcm(*integers)}

@tab

Least common multiple of the integer arguments

@item

@ref{25f9,,ldexp(x@comma{} i)}

@tab

@code{x * (2**i)}, inverse of function @ref{25f8,,frexp()}

@item

@ref{25fa,,modf(x)}

@tab

Fractional and integer parts of `x'

@item

@ref{541,,nextafter(x@comma{} y@comma{} steps)}

@tab

Floating-point value `steps' steps after `x' towards `y'

@item

@ref{771,,perm(n@comma{} k)}

@tab

Number of ways to choose `k' items from `n' items without repetition and with order

@item

@ref{a96,,prod(iterable@comma{} start)}

@tab

Product of elements in the input `iterable' with a `start' value

@item

@ref{bdb,,remainder(x@comma{} y)}

@tab

Remainder of `x' with respect to `y'

@item

@ref{540,,sumprod(p@comma{} q)}

@tab

Sum of products from two iterables `p' and `q'

@item

@ref{1403,,trunc(x)}

@tab

Integer part of `x'

@item

@ref{9a8,,ulp(x)}

@tab

Value of the least significant bit of `x'

@item

`Power and logarithmic functions'

@tab

@item

@ref{702,,cbrt(x)}

@tab

Cube root of `x'

@item

@ref{137b,,exp(x)}

@tab

`e' raised to the power `x'

@item

@ref{701,,exp2(x)}

@tab

`2' raised to the power `x'

@item

@ref{1259,,expm1(x)}

@tab

`e' raised to the power `x', minus 1

@item

@ref{14fc,,log(x@comma{} base)}

@tab

Logarithm of `x' to the given base (`e' by default)

@item

@ref{1418,,log1p(x)}

@tab

Natural logarithm of `1+x' (base `e')

@item

@ref{114f,,log2(x)}

@tab

Base-2 logarithm of `x'

@item

@ref{15e1,,log10(x)}

@tab

Base-10 logarithm of `x'

@item

@ref{703,,pow(x@comma{} y)}

@tab

`x' raised to the power `y'

@item

@ref{a98,,sqrt(x)}

@tab

Square root of `x'

@item

`Trigonometric functions'

@tab

@item

@ref{25fb,,acos(x)}

@tab

Arc cosine of `x'

@item

@ref{25fc,,asin(x)}

@tab

Arc sine of `x'

@item

@ref{25fd,,atan(x)}

@tab

Arc tangent of `x'

@item

@ref{25fe,,atan2(y@comma{} x)}

@tab

@code{atan(y / x)}

@item

@ref{14fb,,cos(x)}

@tab

Cosine of `x'

@item

@ref{a94,,dist(p@comma{} q)}

@tab

Euclidean distance between two points `p' and `q' given as an iterable of coordinates

@item

@ref{a95,,hypot(*coordinates)}

@tab

Euclidean norm of an iterable of coordinates

@item

@ref{14fa,,sin(x)}

@tab

Sine of `x'

@item

@ref{25ff,,tan(x)}

@tab

Tangent of `x'

@item

`Angular conversion'

@tab

@item

@ref{2600,,degrees(x)}

@tab

Convert angle `x' from radians to degrees

@item

@ref{2601,,radians(x)}

@tab

Convert angle `x' from degrees to radians

@item

`Hyperbolic functions'

@tab

@item

@ref{1415,,acosh(x)}

@tab

Inverse hyperbolic cosine of `x'

@item

@ref{1416,,asinh(x)}

@tab

Inverse hyperbolic sine of `x'

@item

@ref{1417,,atanh(x)}

@tab

Inverse hyperbolic tangent of `x'

@item

@ref{2602,,cosh(x)}

@tab

Hyperbolic cosine of `x'

@item

@ref{2603,,sinh(x)}

@tab

Hyperbolic sine of `x'

@item

@ref{2604,,tanh(x)}

@tab

Hyperbolic tangent of `x'

@item

`Special functions'

@tab

@item

@ref{c60,,erf(x)}

@tab

Error function@footnote{https://en.wikipedia.org/wiki/Error_function} at `x'

@item

@ref{c61,,erfc(x)}

@tab

Complementary error function@footnote{https://en.wikipedia.org/wiki/Error_function} at `x'

@item

@ref{125a,,gamma(x)}

@tab

Gamma function@footnote{https://en.wikipedia.org/wiki/Gamma_function} at `x'

@item

@ref{125b,,lgamma(x)}

@tab

Natural logarithm of the absolute value of the Gamma function@footnote{https://en.wikipedia.org/wiki/Gamma_function} at `x'

@item

`Constants'

@tab

@item

@ref{2605,,pi}

@tab

`π' = 3.141592…

@item

@ref{2606,,e}

@tab

`e' = 2.718281…

@item

@ref{2607,,tau}

@tab

`τ' = 2`π' = 6.283185…

@item

@ref{d0d,,inf}

@tab

Positive infinity

@item

@ref{704,,nan}

@tab

«Not a number» (NaN)

@end multitable


@menu
* Teoría de números y funciones de representación:: 
* Funciones logarítmicas y exponenciales:: 
* Funciones trigonométricas:: 
* Conversión angular:: 
* Funciones hiperbólicas:: 
* Funciones especiales:: 
* Constantes: Constantes<2>. 

@end menu

@node Teoría de números y funciones de representación,Funciones logarítmicas y exponenciales,,math — Mathematical functions
@anchor{library/math number-theoretic-and-representation-functions}@anchor{2608}
@subsubsection Teoría de números y funciones de representación


@geindex ceil() (en el módulo math)
@anchor{library/math math ceil}@anchor{1402}
@deffn {Función} math.ceil (x)

Retorna el «techo» de `x', el número entero más pequeño que es mayor o igual que `x'. Si `x' no es un flotante, delega en @ref{1fbb,,x.__ceil__}, que debería retornar un valor @ref{1fbc,,Integral}.
@end deffn

@geindex comb() (en el módulo math)
@anchor{library/math math comb}@anchor{770}
@deffn {Función} math.comb (n, k)

Retorna el número de formas posibles de elegir `k' elementos de `n', de forma ordenada y sin repetición.

Se evalúa como @code{n! / (k! * (n - k)!)} cuando @code{k <= n} y como cero cuando @code{k > n}.

También llamado coeficiente binomial porque es equivalente al coeficiente del k-ésimo término en la expansión polinomial de @code{(1 + x)ⁿ}.

Lanza una excepción @ref{228,,TypeError} si alguno de los argumentos no es un entero. Lanza una excepción @ref{360,,ValueError} si alguno de los argumentos es negativo.


Added in version 3.8.

@end deffn

@geindex copysign() (en el módulo math)
@anchor{library/math math copysign}@anchor{1413}
@deffn {Función} math.copysign (x, y)

Retorna un flotante con la magnitud (valor absoluto) de `x' pero el signo de `y'. En plataformas que admiten ceros con signo, @code{copysign(1.0, -0.0)} retorna `-1.0'.
@end deffn

@geindex fabs() (en el módulo math)
@anchor{library/math math fabs}@anchor{25f7}
@deffn {Función} math.fabs (x)

Retorna el valor absoluto de `x'.
@end deffn

@geindex factorial() (en el módulo math)
@anchor{library/math math factorial}@anchor{9da}
@deffn {Función} math.factorial (n)

Retorna el factorial de `n' como un número entero. Lanza una excepción @ref{360,,ValueError} si `n' no es un entero o negativo.


Distinto en la versión 3.10: Floats with integral values (like @code{5.0}) are no longer accepted.

@end deffn

@geindex floor() (en el módulo math)
@anchor{library/math math floor}@anchor{1401}
@deffn {Función} math.floor (x)

Retorna el «suelo» de `x', el primer número entero menor o igual que `x'. Si `x' no es un flotante, delega en @ref{1fba,,x.__floor__}, que debería retornar un valor @ref{1fbc,,Integral}.
@end deffn

@geindex fma() (en el módulo math)
@anchor{library/math math fma}@anchor{363}
@deffn {Función} math.fma (x, y, z)

Fused multiply-add operation. Return @code{(x * y) + z}, computed as though with
infinite precision and range followed by a single round to the @code{float}
format. This operation often provides better accuracy than the direct
expression @code{(x * y) + z}.

This function follows the specification of the fusedMultiplyAdd operation
described in the IEEE 754 standard. The standard leaves one case
implementation-defined, namely the result of @code{fma(0, inf, nan)}
and @code{fma(inf, 0, nan)}. In these cases, @code{math.fma} returns a NaN,
and does not raise any exception.


Added in version 3.13.

@end deffn

@geindex fmod() (en el módulo math)
@anchor{library/math math fmod}@anchor{2068}
@deffn {Función} math.fmod (x, y)

Retorna @code{fmod(x, y)}, tal como se define en la biblioteca de C de la plataforma. Ten en cuenta que la expresión @code{x % y} de Python puede no retornar el mismo resultado. La intención del estándar de C es que @code{fmod(x, y)} sea exactamente (matemáticamente; con precisión infinita) igual a @code{x - n*y} para algún número entero `n' tal que el resultado tenga el mismo signo que `x' y magnitud menor que @code{abs(y)}. La expresión @code{x % y} de Python retorna un resultado con el signo de `y' en su lugar, y es posible que no pueda calcularse con exactitud para argumentos flotantes. Por ejemplo, @code{fmod(-1e-100, 1e100)} es @code{-1e-100}, pero el resultado de @code{-1e-100 % 1e100} en Python es @code{1e100-1e-100}, que no se puede representar exactamente como un flotante, y se redondea sorprendentemente a @code{1e100}. Por esta razón, generalmente se prefiere la función @ref{2068,,fmod()} cuando se trabaja con flotantes, mientras que se prefiere el uso de @code{x % y} de Python cuando se trabaja con enteros.
@end deffn

@geindex frexp() (en el módulo math)
@anchor{library/math math frexp}@anchor{25f8}
@deffn {Función} math.frexp (x)

Retorna la mantisa y el exponente de `x' como el par @code{(m, e)}. `m' es un flotante y `e' es un número entero tal que @code{x == m * 2**e} exactamente. Si `x' es cero, retorna @code{(0.0, 0)}, y retorna @code{0.5 <= abs(m) < 1} en caso contrario. Se utiliza como una forma portable de «extraer» la representación interna de un flotante.
@end deffn

@geindex fsum() (en el módulo math)
@anchor{library/math math fsum}@anchor{1414}
@deffn {Función} math.fsum (iterable)

Return an accurate floating-point sum of values in the iterable.  Avoids
loss of precision by tracking multiple intermediate partial sums.

La precisión del algoritmo depende de las garantías aritméticas de IEEE-754 y del caso típico en el que se usa el «medio redondo a par» (half-even) como método de redondeo. En algunas compilaciones que no son de Windows, la biblioteca de C subyacente utiliza la adición de precisión extendida y, ocasionalmente, puede realizar un doble redondeo en una suma intermedia, haciendo que el bit menos significativo tome el valor incorrecto.

For further discussion and two alternative approaches, see the ASPN cookbook recipes for accurate floating-point summation@footnote{https://code.activestate.com/recipes/393090-binary-floating-point-summation-accurate-to-full-p/}.
@end deffn

@geindex gcd() (en el módulo math)
@anchor{library/math math gcd}@anchor{9a6}
@deffn {Función} math.gcd (*integers)

Retorna el máximo común divisor de los argumentos enteros. Si cualquiera de los argumentos no es cero, entonces el valor retornado es el entero positivo más grande que divide a todos los argumentos. Si todos los argumentos son cero, entonces el valor retornado es @code{0}. @code{gcd()} sin argumentos retorna @code{0}.


Added in version 3.5.



Distinto en la versión 3.9: Agregado soporte para un número arbitrario de argumentos. Anteriormente sólo se soportaba dos argumentos.

@end deffn

@geindex isclose() (en el módulo math)
@anchor{library/math math isclose}@anchor{e36}
@deffn {Función} math.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

Retorna @code{True} si los valores `a' y `b' están cerca el uno del otro y @code{False} en caso contrario.

Whether or not two values are considered close is determined according to
given absolute and relative tolerances.  If no errors occur, the result will
be: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}.

`rel_tol' is the relative tolerance – it is the maximum allowed difference
between `a' and `b', relative to the larger absolute value of `a' or `b'.
For example, to set a tolerance of 5%, pass @code{rel_tol=0.05}.  The default
tolerance is @code{1e-09}, which assures that the two values are the same
within about 9 decimal digits.  `rel_tol' must be nonnegative and less
than @code{1.0}.

`abs_tol' is the absolute tolerance; it defaults to @code{0.0} and it must be
nonnegative.  When comparing @code{x} to @code{0.0}, @code{isclose(x, 0)} is computed
as @code{abs(x) <= rel_tol  * abs(x)}, which is @code{False} for any @code{x} and
rel_tol less than @code{1.0}.  So add an appropriate positive abs_tol argument
to the call.

Los valores especiales de IEEE 754 @code{NaN}, @code{inf} e @code{-inf} se manejarán de acuerdo con las reglas del IEEE. Concretamente, @code{NaN} no se considera cercano a ningún otro valor, incluido @code{NaN}. Por su parte, @code{inf} e @code{-inf} solo se consideran cercanos a sí mismos.


Added in version 3.5.



@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} – Una función para comprobar la igualdad aproximada

@end deffn

@geindex isfinite() (en el módulo math)
@anchor{library/math math isfinite}@anchor{1258}
@deffn {Función} math.isfinite (x)

Retorna @code{True} si `x' no es infinito ni NaN, o @code{False} en caso contrario. (Ten en cuenta que @code{0.0} `es' considerado finito.)


Added in version 3.2.

@end deffn

@geindex isinf() (en el módulo math)
@anchor{library/math math isinf}@anchor{1411}
@deffn {Función} math.isinf (x)

Retorna @code{True} si `x' es infinito positivo o negativo, o @code{False} en caso contrario.
@end deffn

@geindex isnan() (en el módulo math)
@anchor{library/math math isnan}@anchor{1412}
@deffn {Función} math.isnan (x)

Retorna @code{True} si `x' es NaN (not a number, en español: no es un número), o @code{False} en caso contrario.
@end deffn

@geindex isqrt() (en el módulo math)
@anchor{library/math math isqrt}@anchor{a97}
@deffn {Función} math.isqrt (n)

Retorna la raíz cuadrada del número entero no negativo `n'. Es el resultado de aplicar la función suelo al valor exacto de la raíz cuadrada de `n', o de forma equivalente, el mayor entero `a' tal que `a'² ≤ `n'.

Para algunas aplicaciones, puede ser más conveniente tener el menor número entero `a' tal que `n' ≤ `a'², en otras palabras, el resultado de aplicar la función techo a la raíz cuadrada exacta de `n'. Para `n' positivo, esto se puede calcular usando @code{a = 1 + isqrt(n - 1)}.


Added in version 3.8.

@end deffn

@geindex lcm() (en el módulo math)
@anchor{library/math math lcm}@anchor{9a7}
@deffn {Función} math.lcm (*integers)

Retorna el mínimo común múltiplo de los argumentos enteros. Si todos los argumentos no son cero, entonces el valor retornado es el entero positivo más pequeño que es un múltiplo de todos los argumentos. Si cualquiera de los argumentos es cero, entonces el valor retornado es @code{0}. @code{lcm()} sin argumentos retorna @code{1}.


Added in version 3.9.

@end deffn

@geindex ldexp() (en el módulo math)
@anchor{library/math math ldexp}@anchor{25f9}
@deffn {Función} math.ldexp (x, i)

Retorna @code{x * (2**i)}. Esta es esencialmente la función inversa de @ref{25f8,,frexp()}.
@end deffn

@geindex modf() (en el módulo math)
@anchor{library/math math modf}@anchor{25fa}
@deffn {Función} math.modf (x)

Retorna la parte fraccionaria y entera de `x'. Ambos resultados son flotantes y tienen el mismo signo que `x' .
@end deffn

@geindex nextafter() (en el módulo math)
@anchor{library/math math nextafter}@anchor{541}
@deffn {Función} math.nextafter (x, y, steps=1)

Retorna el valor en coma flotante `steps' pasos después `x' hacia `y'.

Si `x' es igual a `y', retorna `y', a menos que `steps' sea cero.

Ejemplos:


@itemize *

@item 
@code{math.nextafter(x, math.inf)} va hacia el infinito positivo.

@item 
@code{math.nextafter(x, -math.inf)} va hacia el infinito negativo.

@item 
@code{math.nextafter(x, 0.0)} va hacia cero.

@item 
@code{math.nextafter(x, math.copysign(math.inf, x))} se aleja de cero.
@end itemize

Ver también @ref{9a8,,math.ulp()}.


Added in version 3.9.



Distinto en la versión 3.12: Añadido el argumento `steps'.

@end deffn

@geindex perm() (en el módulo math)
@anchor{library/math math perm}@anchor{771}
@deffn {Función} math.perm (n, k=None)

Retorna el número de formas posibles de elegir `k' elementos de `n' elementos, sin repetición y en orden.

Se evalúa como @code{n! / (n - k)!} cuando @code{k <= n} y como cero cuando @code{k > n}.

If `k' is not specified or is @code{None}, then `k' defaults to `n'
and the function returns @code{n!}.

Lanza una excepción @ref{228,,TypeError} si alguno de los argumentos no es un entero. Lanza una excepción @ref{360,,ValueError} si alguno de los argumentos es negativo.


Added in version 3.8.

@end deffn

@geindex prod() (en el módulo math)
@anchor{library/math math prod}@anchor{a96}
@deffn {Función} math.prod (iterable, *, start=1)

Calcula el producto de todos los elementos en la entrada `iterable'. El valor `start' predeterminado para el producto es @code{1}.

Cuando el iterable está vacío, retorna el valor inicial. Esta función está diseñada específicamente para su uso con valores numéricos y puede rechazar tipos no numéricos.


Added in version 3.8.

@end deffn

@geindex remainder() (en el módulo math)
@anchor{library/math math remainder}
@deffn {Función} math.remainder (x, y)

Retorna el resto o residuo según la norma IEEE 754 de `x' con respecto a `y'. Para un valor `x' finito y un valor `y' finito distinto de cero, es la diferencia @code{x - n * y}, donde @code{n} es el número entero más cercano al valor exacto del cociente @code{x / y}. Si @code{x / y} está exactamente en mitad de dos enteros consecutivos, el entero `par' más cercano se utiliza para @code{n}. Por lo tanto, el residuo @code{r = remainder(x, y)} siempre satisface @code{abs(r) <= 0.5 * abs(y)}.

Los casos especiales siguen el estándar IEEE 754: en particular, @code{remainder(x, math.inf)} es `x' para todo `x' finito, y @code{remainder(x, 0)} junto a @code{remainder(math.inf, x)} lanzan una excepción @ref{360,,ValueError} para todo `x' que no sea NaN. Si el resultado de la operación residuo es cero, este cero tendrá el mismo signo que `x'.

On platforms using IEEE 754 binary floating point, the result of this
operation is always exactly representable: no rounding error is introduced.


Added in version 3.7.

@end deffn

@geindex sumprod() (en el módulo math)
@anchor{library/math math sumprod}@anchor{540}
@deffn {Función} math.sumprod (p, q)

Retorna la suma de productos de valores de dos iterables `p' y `q'.

Lanza @ref{360,,ValueError} si las entradas no tienen la misma longitud.

Aproximadamente equivalente a:

@example
sum(map(operator.mul, p, q, strict=True))
@end example

Para entradas flotantes y mixtas int/float, los productos intermedios y las sumas se calculan con precisión ampliada.


Added in version 3.12.

@end deffn

@geindex trunc() (en el módulo math)
@anchor{library/math math trunc}@anchor{1403}
@deffn {Función} math.trunc (x)

Retorna `x' con la parte fraccionaria eliminada, dejando la parte entera.Esto redondea hacia 0: @code{trunc()} es equivalente a @ref{1401,,floor()} para `x' positivo y equivalente a  @ref{1402,,ceil()}  para `x' negativo. Si `x' no es un flotante, delega a @ref{229,,x.__trunc__}, que debería retornar un valor @ref{1fbc,,Integral}.
@end deffn

@geindex ulp() (en el módulo math)
@anchor{library/math math ulp}@anchor{9a8}
@deffn {Función} math.ulp (x)

Retorna el valor del bit menos significativo del flotante `x':


@itemize *

@item 
Si `x' es un NaN (`not a number'), retorna `x'.

@item 
Si `x' es negativo, retorna @code{ulp(-x)}.

@item 
Si `x' es un infinito positivo, retorna `x'.

@item 
Si `x' es igual a cero, retorna el flotante representable `desnormalizado' positivo más pequeño (menor que el flotante `normalizado' positivo mínimo, @ref{19f4,,sys.float_info.min}).

@item 
Si `x' es igual al flotante representable positivo más pequeño, retorna el bit menos significativo de `x', de tal manera que el primer flotante menor que `x' es @code{x - ulp(x)}.

@item 
De lo contrario (`x' es un número finito positivo), retorna el valor del bit menos significativo de `x' , de tal forma que el primer flotante mayor a `x' es @code{x + ulp(x)}.
@end itemize

ULP significa `Unit in the Last Place' (unidad en el último lugar).

Ver también @ref{541,,math.nextafter()} y @ref{19f4,,sys.float_info.epsilon}.


Added in version 3.9.

@end deffn

Ten en cuenta que @ref{25f8,,frexp()} y @ref{25fa,,modf()} tienen un patrón de llamada/retorno diferente al de sus equivalentes en C: toman un solo argumento y retornan un par de valores, en lugar de retornar su segundo valor de retorno a través de un @cite{parámetro de salida} (no existe tal cosa en Python).

Para las funciones @ref{1402,,ceil()}, @ref{1401,,floor()} y @ref{25fa,,modf()}, ten en cuenta que `todos' los números de coma flotante de magnitud suficientemente grande son enteros exactos. Los flotantes de Python normalmente no tienen más de 53 bits de precisión (lo mismo que el tipo double de C en la plataforma), en cuyo caso cualquier flotante `x' con @code{abs(x) >= 2**52} no necesariamente tiene bits fraccionarios.

@node Funciones logarítmicas y exponenciales,Funciones trigonométricas,Teoría de números y funciones de representación,math — Mathematical functions
@anchor{library/math power-and-logarithmic-functions}@anchor{2609}
@subsubsection Funciones logarítmicas y exponenciales


@geindex cbrt() (en el módulo math)
@anchor{library/math math cbrt}@anchor{702}
@deffn {Función} math.cbrt (x)

Retorna la raíz cúbica de `x'.


Added in version 3.11.

@end deffn

@geindex exp() (en el módulo math)
@anchor{library/math math exp}@anchor{137b}
@deffn {Función} math.exp (x)

Retorna `e' elevado a la `x' potencia, dónde `e' = 2.718281… es la base de los logaritmos naturales. Esto generalmente es más preciso que @code{math.e ** x} o @code{pow(math.e, x)}.
@end deffn

@geindex exp2() (en el módulo math)
@anchor{library/math math exp2}@anchor{701}
@deffn {Función} math.exp2 (x)

Retorna `2' elevado a la potencia `x'.


Added in version 3.11.

@end deffn

@geindex expm1() (en el módulo math)
@anchor{library/math math expm1}@anchor{1259}
@deffn {Función} math.expm1 (x)

Retorna `e' elevado a la `x' potencia, menos 1. Aquí `e' es la base de los logaritmos naturales. Para flotantes `x' pequeños, la resta en @code{exp(x) - 1} puede resultar en una pérdida significativa de precisión@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}; la función @ref{1259,,expm1()} proporciona una forma de calcular este valor con una precisión total:

@example
>>> from math import exp, expm1
>>> exp(1e-5) - 1  # gives result accurate to 11 places
1.0000050000069649e-05
>>> expm1(1e-5)    # result accurate to full precision
1.0000050000166668e-05
@end example


Added in version 3.2.

@end deffn

@geindex log() (en el módulo math)
@anchor{library/math math log}@anchor{14fc}
@deffn {Función} math.log (x[, base])

Con un argumento, retorna el logaritmo natural de `x' (en base `e').

Con dos argumentos, retorna el logaritmo de `x' en la `base' dada, calculado como @code{log(x)/log(base)}.
@end deffn

@geindex log1p() (en el módulo math)
@anchor{library/math math log1p}@anchor{1418}
@deffn {Función} math.log1p (x)

Retorna el logaritmo natural de `1+x' (base `e'). El resultado se calcula de forma precisa para `x' cercano a cero.
@end deffn

@geindex log2() (en el módulo math)
@anchor{library/math math log2}@anchor{114f}
@deffn {Función} math.log2 (x)

Retorna el logaritmo en base 2 de `x'. Esto suele ser más preciso que @code{log(x, 2)}.


Added in version 3.3.



@subsubheading Ver también


@ref{21a2,,int.bit_length()} retorna el número de bits necesarios para representar un entero en binario, excluyendo el signo y los ceros iniciales.

@end deffn

@geindex log10() (en el módulo math)
@anchor{library/math math log10}@anchor{15e1}
@deffn {Función} math.log10 (x)

Retorna el logaritmo en base 10 de `x'. Esto suele ser más preciso que @code{log(x, 10)}.
@end deffn

@geindex pow() (en el módulo math)
@anchor{library/math math pow}@anchor{703}
@deffn {Función} math.pow (x, y)

Return `x' raised to the power `y'.  Exceptional cases follow
the IEEE 754 standard as far as possible.  In particular,
@code{pow(1.0, x)} and @code{pow(x, 0.0)} always return @code{1.0}, even
when `x' is a zero or a NaN.  If both `x' and `y' are finite,
`x' is negative, and `y' is not an integer then @code{pow(x, y)}
is undefined, and raises @ref{360,,ValueError}.

A diferencia del operador incorporado @code{**}, @ref{703,,math.pow()} convierte ambos argumentos al tipo @ref{153,,float}. Utiliza @code{**} o la función incorporada @ref{a64,,pow()} para calcular potencias enteras exactas.


Distinto en la versión 3.11: Los casos especiales @code{pow(0.0, -inf)} y @code{pow(-0.0, -inf)} se cambiaron para devolver  @code{inf} en lugar de generar @ref{360,,ValueError}, por consistencia con IEEE 754.

@end deffn

@geindex sqrt() (en el módulo math)
@anchor{library/math math sqrt}@anchor{a98}
@deffn {Función} math.sqrt (x)

Retorna la raíz cuadrada de `x'.
@end deffn

@node Funciones trigonométricas,Conversión angular,Funciones logarítmicas y exponenciales,math — Mathematical functions
@anchor{library/math trigonometric-functions}@anchor{260a}
@subsubsection Funciones trigonométricas


@geindex acos() (en el módulo math)
@anchor{library/math math acos}@anchor{25fb}
@deffn {Función} math.acos (x)

Retorna el arcocoseno de `x', en radianes. El resultado está entre @code{0} y @code{pi}.
@end deffn

@geindex asin() (en el módulo math)
@anchor{library/math math asin}@anchor{25fc}
@deffn {Función} math.asin (x)

Retorna el arcoseno de `x', en radianes. El resultado está entre @code{-pi/2} y @code{pi/2}.
@end deffn

@geindex atan() (en el módulo math)
@anchor{library/math math atan}@anchor{25fd}
@deffn {Función} math.atan (x)

Retorna la arcotangente de `x', en radianes. El resultado está entre @code{-pi/2} y @code{pi/2}.
@end deffn

@geindex atan2() (en el módulo math)
@anchor{library/math math atan2}@anchor{25fe}
@deffn {Función} math.atan2 (y, x)

Retorna @code{atan(y / x)}, en radianes. El resultado está entre @code{-pi} y @code{pi}. El vector del plano que va del origen al punto @code{(x, y)}, forma este ángulo con el eje X positivo. La ventaja de @ref{25fe,,atan2()} es que el signo de ambas entradas es conocido, por lo que se puede calcular el cuadrante correcto para el ángulo. Por ejemplo, @code{atan(1)} y @code{atan2(1, 1)} son ambas @code{pi/4}, pero @code{atan2(-1, -1)} es @code{-3*pi/4}.
@end deffn

@geindex cos() (en el módulo math)
@anchor{library/math math cos}@anchor{14fb}
@deffn {Función} math.cos (x)

Retorna el coseno de `x' radianes.
@end deffn

@geindex dist() (en el módulo math)
@anchor{library/math math dist}@anchor{a94}
@deffn {Función} math.dist (p, q)

Retorna la distancia euclidiana entre dos puntos `p' y `q', cada uno de ellos dado como una secuencia (o iterable) de coordenadas. Los dos puntos deben tener la misma dimensión.

Aproximadamente equivalente a:

@example
sqrt(sum((px - qx) ** 2.0 for px, qx in zip(p, q)))
@end example


Added in version 3.8.

@end deffn

@geindex hypot() (en el módulo math)
@anchor{library/math math hypot}@anchor{a95}
@deffn {Función} math.hypot (*coordinates)

Retorna la norma euclidiana, @code{sqrt(sum(x**2 for x in coordinates))}. Esta es la longitud del vector que va desde el origen hasta el punto dado por las coordenadas.

Para un punto bidimensional @code{(x, y)}, esto equivale a calcular la hipotenusa de un triángulo rectángulo usando el teorema de Pitágoras, @code{sqrt(x*x + y*y)}.


Distinto en la versión 3.8: Agregado soporte para puntos n-dimensionales. Anteriormente, solo se admitía el caso bidimensional.



Distinto en la versión 3.10: Se mejoró la precisión del algoritmo para que el error máximo sea inferior a 1 ulp (unidad en último lugar). Más típicamente, el resultado casi siempre se redondea correctamente dentro de 1/2 ulp.

@end deffn

@geindex sin() (en el módulo math)
@anchor{library/math math sin}@anchor{14fa}
@deffn {Función} math.sin (x)

Retorna el seno de `x' radianes.
@end deffn

@geindex tan() (en el módulo math)
@anchor{library/math math tan}@anchor{25ff}
@deffn {Función} math.tan (x)

Retorna la tangente de `x' radianes.
@end deffn

@node Conversión angular,Funciones hiperbólicas,Funciones trigonométricas,math — Mathematical functions
@anchor{library/math angular-conversion}@anchor{260b}
@subsubsection Conversión angular


@geindex degrees() (en el módulo math)
@anchor{library/math math degrees}@anchor{2600}
@deffn {Función} math.degrees (x)

Convierte el ángulo `x' de radianes a grados.
@end deffn

@geindex radians() (en el módulo math)
@anchor{library/math math radians}@anchor{2601}
@deffn {Función} math.radians (x)

Convierte el ángulo `x' de grados a radianes.
@end deffn

@node Funciones hiperbólicas,Funciones especiales,Conversión angular,math — Mathematical functions
@anchor{library/math hyperbolic-functions}@anchor{260c}
@subsubsection Funciones hiperbólicas


Las funciones hiperbólicas@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_hiperb%C3%B3lica} son análogas a las funciones trigonométricas que están basadas en hipérbolas en lugar de círculos.

@geindex acosh() (en el módulo math)
@anchor{library/math math acosh}@anchor{1415}
@deffn {Función} math.acosh (x)

Retorna el coseno hiperbólico inverso de `x'.
@end deffn

@geindex asinh() (en el módulo math)
@anchor{library/math math asinh}@anchor{1416}
@deffn {Función} math.asinh (x)

Retorna el seno hiperbólico inverso de `x'.
@end deffn

@geindex atanh() (en el módulo math)
@anchor{library/math math atanh}@anchor{1417}
@deffn {Función} math.atanh (x)

Retorna la tangente hiperbólica inversa de `x'.
@end deffn

@geindex cosh() (en el módulo math)
@anchor{library/math math cosh}@anchor{2602}
@deffn {Función} math.cosh (x)

Retorna el coseno hiperbólico de `x'.
@end deffn

@geindex sinh() (en el módulo math)
@anchor{library/math math sinh}@anchor{2603}
@deffn {Función} math.sinh (x)

Retorna el seno hiperbólico de `x'.
@end deffn

@geindex tanh() (en el módulo math)
@anchor{library/math math tanh}@anchor{2604}
@deffn {Función} math.tanh (x)

Retorna la tangente hiperbólica de `x'.
@end deffn

@node Funciones especiales,Constantes<2>,Funciones hiperbólicas,math — Mathematical functions
@anchor{library/math special-functions}@anchor{260d}
@subsubsection Funciones especiales


@geindex erf() (en el módulo math)
@anchor{library/math math erf}@anchor{c60}
@deffn {Función} math.erf (x)

Retorna la función error@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_error} en `x'.

The @ref{c60,,erf()} function can be used to compute traditional statistical
functions such as the cumulative standard normal distribution@footnote{https://en.wikipedia.org/wiki/Cumulative_distribution_function}:

@example
def phi(x):
    'Cumulative distribution function for the standard normal distribution'
    return (1.0 + erf(x / sqrt(2.0))) / 2.0
@end example


Added in version 3.2.

@end deffn

@geindex erfc() (en el módulo math)
@anchor{library/math math erfc}@anchor{c61}
@deffn {Función} math.erfc (x)

Retorna la función error complementaria en `x'. La función error complementaria@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_error} se define como @code{1.0 - erf(x)}. Se usa para valores grandes de `x' donde una resta de 1 causaría una pérdida de presición@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}.


Added in version 3.2.

@end deffn

@geindex gamma() (en el módulo math)
@anchor{library/math math gamma}@anchor{125a}
@deffn {Función} math.gamma (x)

Retorna la función gamma@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_gamma} en `x'.


Added in version 3.2.

@end deffn

@geindex lgamma() (en el módulo math)
@anchor{library/math math lgamma}@anchor{125b}
@deffn {Función} math.lgamma (x)

Retorna el logaritmo natural del valor absoluto de la función gamma en `x'.


Added in version 3.2.

@end deffn

@node Constantes<2>,,Funciones especiales,math — Mathematical functions
@anchor{library/math constants}@anchor{260e}
@subsubsection Constantes


@geindex pi (en el módulo math)
@anchor{library/math math pi}@anchor{2605}
@deffn {Dato} math.pi

La constante matemática `π' = 3.141592…, hasta la precisión disponible.
@end deffn

@geindex e (en el módulo math)
@anchor{library/math math e}@anchor{2606}
@deffn {Dato} math.e

La constante matemática `e' = 2.718281…, hasta la precisión disponible.
@end deffn

@geindex tau (en el módulo math)
@anchor{library/math math tau}@anchor{2607}
@deffn {Dato} math.tau

La constante matemática `τ' = 6.283185…, hasta la precisión disponible. Tau es una constante del círculo igual a 2`π', la razón entre la circunferencia de un círculo y su radio. Para obtener más información sobre Tau, consulta el video de Vi Hart, Pi is (still) Wrong@footnote{https://www.youtube.com/watch?v=jG7vhMMXagQ}, y comienza a celebrar el el día de Tau@footnote{https://tauday.com/} ¡comiendo el doble de tarta!


Added in version 3.6.

@end deffn

@geindex inf (en el módulo math)
@anchor{library/math math inf}@anchor{d0d}
@deffn {Dato} math.inf

Un valor infinito positivo en punto flotante. (Para un valor infinito negativo, usa @code{-math.inf}.) Equivalente a la salida de @code{float('inf')}.


Added in version 3.5.

@end deffn

@geindex nan (en el módulo math)
@anchor{library/math math nan}@anchor{704}
@deffn {Dato} math.nan

Un valor de coma flotante «no es un número» (NaN). Equivalente a la salida de @code{float('nan')}. Debido a los requisitos del estándar IEEE-754@footnote{https://es.wikipedia.org/wiki/IEEE_754}, @code{math.nan} y @code{float('nan')} no se consideran iguales a ningún otro valor numérico, incluidos ellos mismos. Para verificar si un número es NaN, use la función @ref{1412,,isnan()} para probar NaN en lugar de @code{is} o @code{==}. Ejemplo:

@example
>>> import math
>>> math.nan == math.nan
False
>>> float('nan') == float('nan')
False
>>> math.isnan(math.nan)
True
>>> math.isnan(float('nan'))
True
@end example


Added in version 3.5.



Distinto en la versión 3.11: Ahora está siempre disponible.

@end deffn

`Detalles de implementación de CPython:' El módulo @ref{8e,,math} consiste principalmente en delgados envoltorios alrededor de las funciones matemáticas de la biblioteca de C de la plataforma. El comportamiento en casos excepcionales sigue el Anexo F del estándar C99 cuando corresponda. La implementación actual lanzará un @ref{360,,ValueError} para operaciones no válidas como @code{sqrt(-1.0)} o @code{log(0.0)} (donde el estándar C99 recomienda señalar que la operación no es válida o que hay división entre cero), y un @ref{919,,OverflowError} para aquellos resultados de desbordamiento (por ejemplo, @code{exp(1000.0)}). No se retornará NaN para ninguna de las funciones anteriores, a no ser que al menos uno de los argumentos de la función sea NaN. En este caso, la mayoría de las funciones retornan NaN, pero de nuevo (de acuerdo con el apéndice F del estándar C99) hay algunas excepciones a esta regla, por ejemplo @code{pow(float('nan'), 0.0)} o @code{hypot(float('nan'), float('inf'))}.

Ten en cuenta que Python no hace ningún esfuerzo por distinguir los NaN de señalización de los NaN silenciosos, y el comportamiento de señalización de los NaN permanece sin especificar. El comportamiento estándar es tratar a todos los NaN como silenciosos.


@subsubheading Ver también



@table @asis

@item Módulo @ref{19,,cmath}

Versiones de muchas de estas funciones para números complejos.
@end table


@node cmath — Mathematical functions for complex numbers,decimal — Decimal fixed-point and floating-point arithmetic,math — Mathematical functions,Módulos numéricos y matemáticos
@anchor{library/cmath doc}@anchor{260f}@anchor{library/cmath cmath-mathematical-functions-for-complex-numbers}@anchor{2610}@anchor{library/cmath module-cmath}@anchor{19}
@subsection @code{cmath} — Mathematical functions for complex numbers


@geindex module; cmath


__________________________________________________________________


This module provides access to mathematical functions for complex numbers.  The
functions in this module accept integers, floating-point numbers or complex
numbers as arguments. They will also accept any Python object that has either a
@ref{687,,__complex__()} or a @ref{a5e,,__float__()} method: these methods are used to
convert the object to a complex or floating-point number, respectively, and
the function is then applied to the result of the conversion.

@cartouche
@quotation Nota 
For functions involving branch cuts, we have the problem of deciding how to
define those functions on the cut itself. Following Kahan’s «Branch cuts for
complex elementary functions» paper, as well as Annex G of C99 and later C
standards, we use the sign of zero to distinguish one side of the branch cut
from the other: for a branch cut along (a portion of) the real axis we look
at the sign of the imaginary part, while for a branch cut along the
imaginary axis we look at the sign of the real part.

For example, the @ref{2611,,cmath.sqrt()} function has a branch cut along the
negative real axis. An argument of @code{complex(-2.0, -0.0)} is treated as
though it lies `below' the branch cut, and so gives a result on the negative
imaginary axis:

@example
>>> cmath.sqrt(complex(-2.0, -0.0))
-1.4142135623730951j
@end example

But an argument of @code{complex(-2.0, 0.0)} is treated as though it lies above
the branch cut:

@example
>>> cmath.sqrt(complex(-2.0, 0.0))
1.4142135623730951j
@end example
@end quotation
@end cartouche

@menu
* Conversión a y desde coordenadas polares:: 
* Funciones logarítmicas y de potencias:: 
* Funciones trigonométricas: Funciones trigonométricas<2>. 
* Funciones hiperbólicas: Funciones hiperbólicas<2>. 
* Funciones de clasificación:: 
* Constantes: Constantes<3>. 

@end menu

@node Conversión a y desde coordenadas polares,Funciones logarítmicas y de potencias,,cmath — Mathematical functions for complex numbers
@anchor{library/cmath conversions-to-and-from-polar-coordinates}@anchor{2612}
@subsubsection Conversión a y desde coordenadas polares


A Python complex number @code{z} is stored internally using `rectangular'
or `Cartesian' coordinates.  It is completely determined by its `real
part' @code{z.real} and its `imaginary part' @code{z.imag}.

`Las coordenadas polares' dan una alternativa a la representación de números complejos. En las coordenadas polares, un número complejo `z' se define por los módulos `r' y el ángulo de fase `phi'. El módulo `r' es la distancia desde `z' hasta el origen, mientras que la fase `phi' es el ángulo que va en contra de las agujas del reloj, medido en radianes, desde el eje positivo de las X hasta el segmento de linea que une el origen con `z'.

Las siguientes funciones pueden ser usadas para convertir desde coordenadas rectangulares nativas hasta coordenadas polares y viceversa.

@geindex phase() (en el módulo cmath)
@anchor{library/cmath cmath phase}@anchor{2613}
@deffn {Función} cmath.phase (x)

Return the phase of `x' (also known as the `argument' of `x'), as a float.
@code{phase(x)} is equivalent to @code{math.atan2(x.imag, x.real)}.  The result
lies in the range [-`π', `π'], and the branch cut for this operation lies
along the negative real axis.  The sign of the result is the same as the
sign of @code{x.imag}, even when @code{x.imag} is zero:

@example
>>> phase(complex(-1.0, 0.0))
3.141592653589793
>>> phase(complex(-1.0, -0.0))
-3.141592653589793
@end example
@end deffn

@cartouche
@quotation Nota 
El módulo (valor absoluto) de un número complejo `x' puede ser calculado usado la función predeterminada @ref{1cab,,abs()}. No existe otra función aparte del módulo @ref{19,,cmath} para esta operación.
@end quotation
@end cartouche

@geindex polar() (en el módulo cmath)
@anchor{library/cmath cmath polar}@anchor{2614}
@deffn {Función} cmath.polar (x)

Retorna la representación de `x' en coordenadas polares. Retorna un par @code{(r, phi)} donde `r' es el módulo de `x' y phi es la fase de `x'. @code{polar(x)} es equivalente a @code{(abs(x), phase(x))}.
@end deffn

@geindex rect() (en el módulo cmath)
@anchor{library/cmath cmath rect}@anchor{2615}
@deffn {Función} cmath.rect (r, phi)

Return the complex number `x' with polar coordinates `r' and `phi'.
Equivalent to @code{complex(r * math.cos(phi), r * math.sin(phi))}.
@end deffn

@node Funciones logarítmicas y de potencias,Funciones trigonométricas<2>,Conversión a y desde coordenadas polares,cmath — Mathematical functions for complex numbers
@anchor{library/cmath power-and-logarithmic-functions}@anchor{2616}
@subsubsection Funciones logarítmicas y de potencias


@geindex exp() (en el módulo cmath)
@anchor{library/cmath cmath exp}@anchor{2617}
@deffn {Función} cmath.exp (x)

Retorna `e' elevado a la potencia de `x', donde `e' es la base de los logaritmos naturales.
@end deffn

@geindex log() (en el módulo cmath)
@anchor{library/cmath cmath log}@anchor{2618}
@deffn {Función} cmath.log (x[, base])

Returns the logarithm of `x' to the given `base'. If the `base' is not
specified, returns the natural logarithm of `x'. There is one branch cut,
from 0 along the negative real axis to -∞.
@end deffn

@geindex log10() (en el módulo cmath)
@anchor{library/cmath cmath log10}@anchor{2619}
@deffn {Función} cmath.log10 (x)

Retorna el logaritmo en base de 10 de `x'. Tiene el mismo tramo que @ref{2618,,log()}.
@end deffn

@geindex sqrt() (en el módulo cmath)
@anchor{library/cmath cmath sqrt}@anchor{2611}
@deffn {Función} cmath.sqrt (x)

Retorna la raíz cuadrada de `x'. Tiene el mismo tramo que @ref{2618,,log()}.
@end deffn

@node Funciones trigonométricas<2>,Funciones hiperbólicas<2>,Funciones logarítmicas y de potencias,cmath — Mathematical functions for complex numbers
@anchor{library/cmath trigonometric-functions}@anchor{261a}
@subsubsection Funciones trigonométricas


@geindex acos() (en el módulo cmath)
@anchor{library/cmath cmath acos}@anchor{261b}
@deffn {Función} cmath.acos (x)

Return the arc cosine of `x'. There are two branch cuts: One extends right
from 1 along the real axis to ∞. The other extends left from -1 along the
real axis to -∞.
@end deffn

@geindex asin() (en el módulo cmath)
@anchor{library/cmath cmath asin}@anchor{261c}
@deffn {Función} cmath.asin (x)

Retorna el arcoseno de `x'. Este tiene los mismos tramos que @ref{261b,,acos()}.
@end deffn

@geindex atan() (en el módulo cmath)
@anchor{library/cmath cmath atan}@anchor{261d}
@deffn {Función} cmath.atan (x)

Return the arc tangent of `x'. There are two branch cuts: One extends from
@code{1j} along the imaginary axis to @code{∞j}. The other extends from @code{-1j}
along the imaginary axis to @code{-∞j}.
@end deffn

@geindex cos() (en el módulo cmath)
@anchor{library/cmath cmath cos}@anchor{261e}
@deffn {Función} cmath.cos (x)

Retorna el coseno de `x'.
@end deffn

@geindex sin() (en el módulo cmath)
@anchor{library/cmath cmath sin}@anchor{261f}
@deffn {Función} cmath.sin (x)

Retorna el seno de `x'.
@end deffn

@geindex tan() (en el módulo cmath)
@anchor{library/cmath cmath tan}@anchor{2620}
@deffn {Función} cmath.tan (x)

Retorna la tangente de `x'.
@end deffn

@node Funciones hiperbólicas<2>,Funciones de clasificación,Funciones trigonométricas<2>,cmath — Mathematical functions for complex numbers
@anchor{library/cmath hyperbolic-functions}@anchor{2621}
@subsubsection Funciones hiperbólicas


@geindex acosh() (en el módulo cmath)
@anchor{library/cmath cmath acosh}@anchor{2622}
@deffn {Función} cmath.acosh (x)

Return the inverse hyperbolic cosine of `x'. There is one branch cut,
extending left from 1 along the real axis to -∞.
@end deffn

@geindex asinh() (en el módulo cmath)
@anchor{library/cmath cmath asinh}@anchor{2623}
@deffn {Función} cmath.asinh (x)

Return the inverse hyperbolic sine of `x'. There are two branch cuts:
One extends from @code{1j} along the imaginary axis to @code{∞j}.  The other
extends from @code{-1j} along the imaginary axis to @code{-∞j}.
@end deffn

@geindex atanh() (en el módulo cmath)
@anchor{library/cmath cmath atanh}@anchor{2624}
@deffn {Función} cmath.atanh (x)

Return the inverse hyperbolic tangent of `x'. There are two branch cuts: One
extends from @code{1} along the real axis to @code{∞}. The other extends from
@code{-1} along the real axis to @code{-∞}.
@end deffn

@geindex cosh() (en el módulo cmath)
@anchor{library/cmath cmath cosh}@anchor{2625}
@deffn {Función} cmath.cosh (x)

Retorna el coseno hiperbólico de `x'.
@end deffn

@geindex sinh() (en el módulo cmath)
@anchor{library/cmath cmath sinh}@anchor{2626}
@deffn {Función} cmath.sinh (x)

Retorna el seno hiperbólico de `x'.
@end deffn

@geindex tanh() (en el módulo cmath)
@anchor{library/cmath cmath tanh}@anchor{2627}
@deffn {Función} cmath.tanh (x)

Retorna la tangente hiperbólica de `x'.
@end deffn

@node Funciones de clasificación,Constantes<3>,Funciones hiperbólicas<2>,cmath — Mathematical functions for complex numbers
@anchor{library/cmath classification-functions}@anchor{2628}
@subsubsection Funciones de clasificación


@geindex isfinite() (en el módulo cmath)
@anchor{library/cmath cmath isfinite}@anchor{2629}
@deffn {Función} cmath.isfinite (x)

Retorna @code{True} si tanto la parte imaginaria como real de `x' son finitas, y @code{False} en cualquier otro caso.


Added in version 3.2.

@end deffn

@geindex isinf() (en el módulo cmath)
@anchor{library/cmath cmath isinf}@anchor{262a}
@deffn {Función} cmath.isinf (x)

Retorna @code{True} si la parte real o la imaginaria de `x' es un infinito, y @code{False} en el caso contrario.
@end deffn

@geindex isnan() (en el módulo cmath)
@anchor{library/cmath cmath isnan}@anchor{262b}
@deffn {Función} cmath.isnan (x)

Retorna @code{True} tanto si la parte real o imaginaria de `x' es NaN, y  @code{Falso} en cualquier otro caso.
@end deffn

@geindex isclose() (en el módulo cmath)
@anchor{library/cmath cmath isclose}@anchor{e37}
@deffn {Función} cmath.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

Retorna @code{True} si los valores `a' y `b' son cercanos el uno al otro y @code{Falso} de otro modo.

Whether or not two values are considered close is determined according to
given absolute and relative tolerances.  If no errors occur, the result will
be: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}.

`rel_tol' is the relative tolerance – it is the maximum allowed difference
between `a' and `b', relative to the larger absolute value of `a' or `b'.
For example, to set a tolerance of 5%, pass @code{rel_tol=0.05}.  The default
tolerance is @code{1e-09}, which assures that the two values are the same
within about 9 decimal digits.  `rel_tol' must be nonnegative and less
than @code{1.0}.

`abs_tol' is the absolute tolerance; it defaults to @code{0.0} and it must be
nonnegative.  When comparing @code{x} to @code{0.0}, @code{isclose(x, 0)} is computed
as @code{abs(x) <= rel_tol  * abs(x)}, which is @code{False} for any @code{x} and
rel_tol less than @code{1.0}.  So add an appropriate positive abs_tol argument
to the call.

Los valores especiales IEEE 754 de @code{NaN}, @code{inf} y @code{-inf} serán manejados de acuerdo al estándar de IEEE. Especialmente, @code{NaN} no se considera cercano a ningún otro valor, incluido @code{NaN}. @code{inf} y @code{-inf} solo son considerados cercanos a sí mismos.


Added in version 3.5.



@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} – Una función para probar igualdad aproximada.

@end deffn

@node Constantes<3>,,Funciones de clasificación,cmath — Mathematical functions for complex numbers
@anchor{library/cmath constants}@anchor{262c}
@subsubsection Constantes


@geindex pi (en el módulo cmath)
@anchor{library/cmath cmath pi}@anchor{262d}
@deffn {Dato} cmath.pi

La constante matemática `π', como número de coma flotante.
@end deffn

@geindex e (en el módulo cmath)
@anchor{library/cmath cmath e}@anchor{262e}
@deffn {Dato} cmath.e

La constante matemática `e', como número de coma flotante.
@end deffn

@geindex tau (en el módulo cmath)
@anchor{library/cmath cmath tau}@anchor{d0a}
@deffn {Dato} cmath.tau

La constante matemática `τ', como número de coma flotante.


Added in version 3.6.

@end deffn

@geindex inf (en el módulo cmath)
@anchor{library/cmath cmath inf}@anchor{d0b}
@deffn {Dato} cmath.inf

Números de coma flotante de +infinito. Equivalente a @code{float('inf')}.


Added in version 3.6.

@end deffn

@geindex infj (en el módulo cmath)
@anchor{library/cmath cmath infj}@anchor{d0e}
@deffn {Dato} cmath.infj

Números complejos con la parte real cero y números positivos infinitos como la parte imaginaria. Equivalente a @code{complex(0.0, float('inf'))}.


Added in version 3.6.

@end deffn

@geindex nan (en el módulo cmath)
@anchor{library/cmath cmath nan}@anchor{d0c}
@deffn {Dato} cmath.nan

El valor del número de coma flotante «not a number» (NaN) . Equivalente a @code{float('nan')}.


Added in version 3.6.

@end deffn

@geindex nanj (en el módulo cmath)
@anchor{library/cmath cmath nanj}@anchor{d0f}
@deffn {Dato} cmath.nanj

Números complejos con parte real cero y como parte imaginaria NaN. Equivalente a @code{complex(0.0, float('nan'))}.


Added in version 3.6.

@end deffn

@geindex module;math

Nótese que la selección de funciones es similar, pero no idéntica, a la del módulo  @ref{8e,,math}. El motivo de tener dos módulos se halla en que algunos usuarios no se encuentran interesados en números complejos, y quizás ni siquiera sepan que son. Preferirían que @code{math.sqrt(-1)} lance una excepción a que retorne un número complejo. Además fíjese que las funciones definidas en @ref{19,,cmath} siempre retornan un número complejo, incluso si la respuesta puede ser expresada como un número real  (en cuyo caso el número complejo tiene una parte imaginaria de cero).

Un apunte en los tramos: Se tratan de curvas en las cuales las funciones fallan a ser continua. Son un complemento necesario de muchas funciones complejas. Se asume que si se necesitan cálculos con funciones complejas, usted entenderá sobre tramos. Consulte casi cualquier(no muy elemental) libro sobre variables complejas para saber más. Para más información en la correcta elección de los tramos para propósitos numéricos, se recomienda la siguiente bibliografía:


@subsubheading Ver también


`Kahan, W:  Branch cuts for complex elementary functions; o, Much ado about nothing’s sign bit.  En Iserles, A., and Powell, M. (eds.), The state of the art in numerical analysis. Clarendon Press (1987) pp165–211'.


@node decimal — Decimal fixed-point and floating-point arithmetic,fractions — Rational numbers,cmath — Mathematical functions for complex numbers,Módulos numéricos y matemáticos
@anchor{library/decimal doc}@anchor{262f}@anchor{library/decimal decimal-decimal-fixed-point-and-floating-point-arithmetic}@anchor{2630}@anchor{library/decimal module-decimal}@anchor{37}
@subsection @code{decimal} — Decimal fixed-point and floating-point arithmetic


@geindex module; decimal

`Código fuente:' Lib/decimal.py@footnote{https://github.com/python/cpython/tree/main/Lib/decimal.py}

@c import modules for testing inline doctests with the Sphinx doctest builder

@c import decimal
@c import math
@c from decimal import *
@c # make sure each group gets a fresh context
@c setcontext(Context())

@c # make sure other tests (outside this file) get a fresh context
@c setcontext(Context())


__________________________________________________________________


The @ref{37,,decimal} module provides support for fast correctly rounded
decimal floating-point arithmetic. It offers several advantages over the
@ref{153,,float} datatype:


@itemize *

@item 
Decimal «se basa en un modelo de coma flotante que se diseñó pensando en las personas, y necesariamente tiene un principio rector supremo: las computadoras deben proporcionar una aritmética que funcione de la misma manera que la aritmética que las personas aprenden en la escuela.» – extracto (traducido) de la especificación de la aritmética decimal.

@item 
Los números decimales se pueden representar de forma exacta en coma flotante decimal. En cambio, números como @code{1.1} y @code{2.2} no tienen representaciones exactas en coma flotante binaria. Los usuarios finales normalmente no esperaran que @code{1.1 + 2.2} se muestre como @code{3.3000000000000003}, como ocurre al usar la representación binaria en coma flotante.

@item 
La exactitud se traslada a la aritmética. En coma flotante decimal, @code{0.1 + 0.1 + 0.1 - 0.3} es exactamente igual a cero. En coma flotante binaria, el resultado es @code{5.5511151231257827e-017}. Aunque cercanas a cero, las diferencias impiden pruebas de igualdad confiables y las diferencias pueden acumularse. Por estas razones, se recomienda el uso de decimal en aplicaciones de contabilidad con estrictas restricciones de confiabilidad.

@item 
El módulo decimal incorpora una noción de dígitos significativos, de modo que @code{1.30 + 1.20} es @code{2.50}. El cero final se mantiene para indicar el número de dígitos significativos. Esta es la representación habitual en aplicaciones monetarias. Para la multiplicación, el método de «libro escolar» utilizado usa todas las cifras de los multiplicandos. Por ejemplo, @code{1.3 * 1.2} es igual a @code{1.56}, mientras que @code{1.30 * 1.20} es igual a @code{1.5600}.

@item 
A diferencia del punto flotante binario basado en hardware, el módulo decimal tiene una precisión modificable por el usuario (por defecto es de 28 dígitos decimales) que puede ser tan grande como sea necesario para un problema dado:

@example
>>> from decimal import *
>>> getcontext().prec = 6
>>> Decimal(1) / Decimal(7)
Decimal('0.142857')
>>> getcontext().prec = 28
>>> Decimal(1) / Decimal(7)
Decimal('0.1428571428571428571428571429')
@end example

@item 
Tanto la representación en coma flotante binaria como la decimal se implementan de acuerdo a estándares publicados. Mientras que el tipo incorporado float expone solo una pequeña parte de sus capacidades, el módulo decimal expone todos los componentes requeridos del estándar. Cuando es necesario, el desarrollador tiene control total sobre el redondeo y la gestión de las señales. Esto incluye la capacidad de forzar la aritmética exacta, utilizando excepciones para bloquear cualquier operación inexacta.

@item 
El módulo decimal fue diseñado para admitir «indiscriminadamente, tanto aritmética decimal exacta sin redondeo (a veces llamada aritmética de coma fija) como la aritmética de coma flotante con redondeo.» – extracto (traducido) de la especificación de la aritmética decimal.
@end itemize

El módulo está diseñado en torno a tres conceptos: el número decimal, el contexto aritmético y las señales.

Un número decimal es inmutable. Tiene un signo, un coeficiente y un exponente. Para conservar el número de dígitos significativos, los ceros iniciales no se truncan. Los números decimales también incluyen valores especiales como @code{Infinity}, @code{-Infinity} y @code{NaN}. El estándar también marca la diferencia entre @code{-0} y @code{+0}.

El contexto aritmético es un entorno que permite especificar una precisión, reglas de redondeo, límites en los exponentes, flags que indican el resultado de las operaciones y habilitadores de trampas que especifican si las señales (reportadas durante operaciones ilegales) son tratadas o no como excepciones de Python. Las opciones de redondeo incluyen @ref{2631,,ROUND_CEILING}, @ref{2632,,ROUND_DOWN}, @ref{2633,,ROUND_FLOOR}, @ref{2634,,ROUND_HALF_DOWN}, @ref{2635,,ROUND_HALF_EVEN}, @ref{2636,,ROUND_HALF_UP}, @ref{2637,,ROUND_UP} y @ref{2638,,ROUND_05UP}.

Las señales son grupos de condiciones excepcionales que ocurren durante el cálculo. Dependiendo de las necesidades de la aplicación, las señales pueden ignorarse, tratarse como información o tratarse como excepciones. Las señales existentes en el módulo decimal son @ref{2639,,Clamped}, @ref{111f,,InvalidOperation}, @ref{263a,,DivisionByZero}, @ref{263b,,Inexact}, @ref{263c,,Rounded}, @ref{263d,,Subnormal}, @ref{263e,,Overflow}, @ref{263f,,Underflow} y @ref{1119,,FloatOperation}.

Por cada señal hay un flag y un habilitador de trampa. Cuando ocurre una operación ilegal, su flag se establece en uno, luego, si su habilitador de trampa está establecido en uno, se lanza una excepción. La configuración de los flags es persistente, por lo que el usuario debe restablecerlos antes de comenzar un cálculo que desee monitorear.


@subsubheading Ver también



@itemize *

@item 
Especificación general de la aritmética decimal de IBM, The General Decimal Arithmetic Specification@footnote{https://speleotrove.com/decimal/decarith.html}.
@end itemize


@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@menu
* Tutorial de inicio rápido:: 
* Objetos Decimal:: 
* Objetos context:: 
* Constantes: Constantes<4>. 
* Modos de redondeo:: 
* Señales:: 
* Floating-Point Notes:: 
* Trabajando con hilos:: 
* Casos prácticos:: 
* Preguntas frecuentes sobre decimal:: 

@end menu

@node Tutorial de inicio rápido,Objetos Decimal,,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-tutorial}@anchor{2640}@anchor{library/decimal quick-start-tutorial}@anchor{2641}
@subsubsection Tutorial de inicio rápido


El punto de partida habitual para usar decimales es importar el módulo, ver el contexto actual con @ref{15cd,,getcontext()} y, si es necesario, establecer nuevos valores para la precisión, el redondeo o trampas de señales habilitadas:

@example
>>> from decimal import *
>>> getcontext()
Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
        InvalidOperation])

>>> getcontext().prec = 7       # Set a new precision
@end example

Las instancias de la clase Decimal se pueden construir a partir de números enteros, cadenas de caracteres, flotantes o tuplas. La construcción a partir de un número entero o flotante realiza una conversión exacta del valor de ese número. Los números decimales incluyen valores especiales como @code{NaN}, que significa «No es un número», @code{Infinity} positivo y negativo o @code{-0}:

@example
>>> getcontext().prec = 28
>>> Decimal(10)
Decimal('10')
>>> Decimal('3.14')
Decimal('3.14')
>>> Decimal(3.14)
Decimal('3.140000000000000124344978758017532527446746826171875')
>>> Decimal((0, (3, 1, 4), -2))
Decimal('3.14')
>>> Decimal(str(2.0 ** 0.5))
Decimal('1.4142135623730951')
>>> Decimal(2) ** Decimal('0.5')
Decimal('1.414213562373095048801688724')
>>> Decimal('NaN')
Decimal('NaN')
>>> Decimal('-Infinity')
Decimal('-Infinity')
@end example

Si la señal @ref{1119,,FloatOperation} es atrapada, la mezcla accidental de decimales y flotantes en constructores o comparaciones de orden lanzará una excepción:

@example
>>> c = getcontext()
>>> c.traps[FloatOperation] = True
>>> Decimal(3.14)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') < 3.7
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') == 3.5
True
@end example


Added in version 3.3.


La significación de un nuevo objeto Decimal es determinada únicamente por el número de dígitos ingresados. La precisión y el redondeo establecidos en el contexto solo entran en juego durante las operaciones aritméticas.

@example
>>> getcontext().prec = 6
>>> Decimal('3.0')
Decimal('3.0')
>>> Decimal('3.1415926535')
Decimal('3.1415926535')
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85987')
>>> getcontext().rounding = ROUND_UP
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85988')
@end example

Se lanza una excepción @ref{111f,,InvalidOperation} si durante la construcción de un objeto Decimal se exceden los límites internos de la versión de C:

@example
>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]
@end example


Distinto en la versión 3.3.


Decimals interact well with much of the rest of Python.  Here is a small decimal
floating-point flying circus:

@example
>>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
>>> max(data)
Decimal('9.25')
>>> min(data)
Decimal('0.03')
>>> sorted(data)
[Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
 Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
>>> sum(data)
Decimal('19.29')
>>> a,b,c = data[:3]
>>> str(a)
'1.34'
>>> float(a)
1.34
>>> round(a, 1)
Decimal('1.3')
>>> int(a)
1
>>> a * 5
Decimal('6.70')
>>> a * b
Decimal('2.5058')
>>> c % a
Decimal('0.77')
@end example

Y algunas funciones matemáticas también están disponibles para Decimal:

@example
>>> getcontext().prec = 28
>>> Decimal(2).sqrt()
Decimal('1.414213562373095048801688724')
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal('10').ln()
Decimal('2.302585092994045684017991455')
>>> Decimal('10').log10()
Decimal('1')
@end example

El método @ref{1125,,quantize()} redondea un número a un exponente fijo. Este método es útil para aplicaciones monetarias, que a menudo redondean los resultados a un número fijo de dígitos significativos:

@example
>>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
Decimal('7.32')
>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
Decimal('8')
@end example

Como se muestra arriba, la función @ref{15cd,,getcontext()} accede al contexto actual y permite cambiar la configuración. Este enfoque satisface las necesidades de la mayoría de las aplicaciones.

Para trabajos más avanzados, puede resultar útil crear contextos alternativos utilizando el constructor Context(). Para activar un contexto alternativo, usa la función @ref{2642,,setcontext()}.

De acuerdo con el estándar, el módulo @ref{37,,decimal} proporciona dos contextos estándar listos para usar, @ref{111d,,BasicContext} y @ref{111e,,ExtendedContext}. El primero es particularmente útil para la depuración, ya que muchas de las trampas de señales están habilitadas por defecto:

@example
>>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
>>> setcontext(myothercontext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857142857142857142857142857')

>>> ExtendedContext
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[])
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857143')
>>> Decimal(42) / Decimal(0)
Decimal('Infinity')

>>> setcontext(BasicContext)
>>> Decimal(42) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#143>", line 1, in -toplevel-
    Decimal(42) / Decimal(0)
DivisionByZero: x / 0
@end example

Los objetos Context también tienen flags de señalización para detectar condiciones excepcionales detectadas durante los cálculos. Estos flags permanecen habilitados hasta que se restablecen explícitamente. Por esta razón, suele ser buena idea restablecerlos mediante el método @ref{2643,,clear_flags()} antes de proceder con cada conjunto de cálculos monitorizados.

@example
>>> setcontext(ExtendedContext)
>>> getcontext().clear_flags()
>>> Decimal(355) / Decimal(113)
Decimal('3.14159292')
>>> getcontext()
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])
@end example

La entrada `flags' muestra que la aproximación racional de Pi fue redondeada (los dígitos más allá de la precisión especificada por el contexto se descartaron) y que el resultado es inexacto (algunos de los dígitos descartados no eran cero).

Las trampas de señales se habilitan a través del diccionario expuesto por el atributo @code{traps} del objeto Context:

@example
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(0)
Decimal('Infinity')
>>> getcontext().traps[DivisionByZero] = 1
>>> Decimal(1) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#112>", line 1, in -toplevel-
    Decimal(1) / Decimal(0)
DivisionByZero: x / 0
@end example

La mayoría de los programas ajustan el contexto actual una sola vez, al comienzo del programa. Y, en muchas aplicaciones, los datos se convierten a @ref{16a,,Decimal} mediante una única conversión dentro de un bucle. Con el contexto establecido y los decimales creados, la mayor parte del programa manipula los datos de la misma forma que con otros tipos numéricos de Python.

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Objetos Decimal,Objetos context,Tutorial de inicio rápido,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-decimal}@anchor{2644}@anchor{library/decimal decimal-objects}@anchor{2645}
@subsubsection Objetos Decimal


@geindex Decimal (clase en decimal)
@anchor{library/decimal decimal Decimal}@anchor{16a}
@deffn {Clase} decimal.Decimal (value='0', context=None)

Construye un nuevo objeto @ref{16a,,Decimal} basado en `value'.

`value' puede ser un entero, una cadena de caracteres, una tupla, un @ref{153,,float} u otro objeto @ref{16a,,Decimal}. Si no se proporciona `value', retorna @code{Decimal('0')}. Si `value' es una cadena, debe ajustarse a la sintaxis de cadena numérica decimal después de que los espacios en blanco iniciales y finales, así como los guiones bajos, sean eliminados:

@example
sign           ::=  '+' | '-'
digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
indicator      ::=  'e' | 'E'
digits         ::=  digit [digit]...
decimal-part   ::=  digits '.' [digits] | ['.'] digits
exponent-part  ::=  indicator [sign] digits
infinity       ::=  'Infinity' | 'Inf'
nan            ::=  'NaN' [digits] | 'sNaN' [digits]
numeric-value  ::=  decimal-part [exponent-part] | infinity
numeric-string ::=  [sign] numeric-value | [sign] nan
@end example

También se permiten otros dígitos decimales Unicode en aquellos lugares en los que arriba aparece @code{digit}. Estos incluyen dígitos decimales de otros alfabetos (por ejemplo, dígitos del alfabeto árabe-índico y devanāgarī) junto con los dígitos de ancho completo desde @code{'\uff10'} a @code{'\uff19'}.

Si `value' es un objeto @ref{464,,tuple}, debe tener tres componentes, un signo (@code{0} para positivo o @code{1} para negativo), un objeto @ref{464,,tuple} con los dígitos y un exponente entero. Por ejemplo, @code{Decimal((0, (1, 4, 1, 4), -3))} retorna @code{Decimal('1.414')}.

If `value' is a @ref{153,,float}, the binary floating-point value is losslessly
converted to its exact decimal equivalent.  This conversion can often require
53 or more digits of precision.  For example, @code{Decimal(float('1.1'))}
converts to
@code{Decimal('1.100000000000000088817841970012523233890533447265625')}.

La precisión de `context' no afecta a la cantidad de dígitos almacenados. Eso está determinado exclusivamente por el número de dígitos en `value'. Por ejemplo, @code{Decimal('3.00000')} registra los cinco ceros incluso si la precisión del contexto es solo tres.

El propósito del argumento `context' es determinar qué hacer si `value' es una cadena de caracteres mal formada. Si el contexto atrapa la señal @ref{111f,,InvalidOperation}, se genera una excepción; de lo contrario, el constructor retorna un nuevo decimal con el valor @code{NaN}.

Una vez construidos, los objetos @ref{16a,,Decimal} son inmutables.


Distinto en la versión 3.2: Ahora se permite que el argumento del constructor sea una instancia @ref{153,,float}.



Distinto en la versión 3.3: Los argumentos @ref{153,,float} ahora generan una excepción si se establece la trampa @ref{1119,,FloatOperation}. Por defecto, la trampa está desactivada.



Distinto en la versión 3.6: Se permiten guiones bajos para la agrupación, como ocurre en el código con los literales enteros y de punto flotante.


Decimal floating-point objects share many properties with the other built-in
numeric types such as @ref{153,,float} and @ref{1f0,,int}.  All of the usual math
operations and special methods apply.  Likewise, decimal objects can be
copied, pickled, printed, used as dictionary keys, used as set elements,
compared, sorted, and coerced to another type (such as @ref{153,,float} or
@ref{1f0,,int}).

Hay algunas pequeñas diferencias entre la aritmética en objetos decimales y la aritmética en enteros y flotantes. Cuando el operador de resto @code{%} se aplica a objetos Decimal, el signo del resultado es el signo del `dividendo' en lugar del signo del divisor:

@example
>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')
@end example

El operador de división entera @code{//} se comporta de manera análoga, retornando la parte entera del cociente verdadero (truncando hacia cero) en lugar del resultado de aplicarle la función suelo. Esto se hace con la finalidad de preservar la identidad habitual @code{x == (x // y) * y + x % y}:

@example
>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')
@end example

Los operadores @code{%} y @code{//} implementan las operaciones @code{remainder} y @code{divide-integer} (respectivamente) como se describe en la especificación.

Los objetos de la clase Decimal generalmente no se pueden combinar con flotantes o instancias de @ref{177,,fractions.Fraction} en operaciones aritméticas: un intento de agregar un objeto @ref{16a,,Decimal} a un @ref{153,,float}, por ejemplo, lanzará una excepción @ref{228,,TypeError}. Sin embargo, es posible usar los operadores de comparación de Python para comparar una instancia de @ref{16a,,Decimal} @code{x} con otro número @code{y}. Esto evita resultados confusos al hacer comparaciones de igualdad entre números de diferentes tipos.


Distinto en la versión 3.2: Las comparaciones de tipo mixto entre instancias de @ref{16a,,Decimal} y otros tipos numéricos ahora son totalmente compatibles.


In addition to the standard numeric properties, decimal floating-point
objects also have a number of specialized methods:

@geindex adjusted() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal adjusted}@anchor{2646}
@deffn {Método} adjusted ()

Retorna el exponente ajustado después de desplazar los dígitos del extremo derecho del coeficiente hasta que solo quede el dígito principal: @code{Decimal('321e+5').adjusted()} retorna siete. Se utiliza para determinar la posición del dígito más significativo con respecto al punto decimal.
@end deffn

@geindex as_integer_ratio() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal as_integer_ratio}@anchor{d1d}
@deffn {Método} as_integer_ratio ()

Retorna un par de enteros @code{(n, d)} que representan la instancia de @ref{16a,,Decimal} proporcionada como una fracción irreducible y con un denominador positivo:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

La conversión es exacta. Lanza una excepción OverflowError si se proporcionan valores infinitos y ValueError con valores NaN.
@end deffn


Added in version 3.6.


@geindex as_tuple() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal as_tuple}@anchor{2647}
@deffn {Método} as_tuple ()

Retorna una representación en forma de @ref{6ef,,named tuple} del número: @code{DecimalTuple(sign, digits, exponent)}.
@end deffn

@geindex canonical() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal canonical}@anchor{2648}
@deffn {Método} canonical ()

Retorna la codificación canónica del argumento. Actualmente, la codificación de una instancia de @ref{16a,,Decimal} es siempre canónica, por lo que esta operación retorna su argumento sin cambios.
@end deffn

@geindex compare() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal compare}@anchor{2649}
@deffn {Método} compare (other, context=None)

Compara los valores de dos instancias de Decimal. El método @ref{2649,,compare()} retorna una instancia de Decimal, y si alguno de los operandos es un NaN, el resultado es un NaN:

@example
a or b is a NaN  ==> Decimal('NaN')
a < b            ==> Decimal('-1')
a == b           ==> Decimal('0')
a > b            ==> Decimal('1')
@end example
@end deffn

@geindex compare_signal() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_signal}@anchor{264a}
@deffn {Método} compare_signal (other, context=None)

Esta operación es idéntica al método @ref{2649,,compare()}, excepto que todos los valores NaN generan una señal. Es decir, si ninguno de los operandos es un NaN señalizador, cualquier operando de NaN silencioso se trata como si fuera un NaN señalizador.
@end deffn

@geindex compare_total() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_total}@anchor{264b}
@deffn {Método} compare_total (other, context=None)

Compara dos operandos utilizando su representación abstracta en lugar de su valor numérico. Similar al método @ref{2649,,compare()}, pero el resultado proporciona un ordenamiento total en las instancias de @ref{16a,,Decimal}. Dos instancias de @ref{16a,,Decimal} con el mismo valor numérico, pero diferentes representaciones, se comparan como desiguales usando este orden:

@example
>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')
@end example

Los NaN silenciosos y señalizadores también se incluyen en el ordenamiento total. El resultado de esta función es @code{Decimal('0')} si ambos operandos tienen la misma representación, @code{Decimal('-1')} si el primer operando es menor en el orden total que el segundo y @code{Decimal('1')} si el primer operando es mayor en el orden total que el segundo operando. Consulta las especificaciones para obtener detalles sobre el ordenamiento total.

Esta operación no se ve afectada por el contexto y es silenciosa: no se cambian los flags y no se realiza ningún redondeo. Como excepción, la versión de C puede lanzar InvalidOperation si el segundo operando no se puede convertir exactamente.
@end deffn

@geindex compare_total_mag() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_total_mag}@anchor{264c}
@deffn {Método} compare_total_mag (other, context=None)

Compara dos operandos usando su representación abstracta en lugar de su valor, como en @ref{264b,,compare_total()}, pero ignorando el signo de cada operando. @code{x.compare_total_mag(y)} es equivalente a @code{x.copy_abs().compare_total(y.copy_abs())}.

Esta operación no se ve afectada por el contexto y es silenciosa: no se cambian los flags y no se realiza ningún redondeo. Como excepción, la versión de C puede lanzar InvalidOperation si el segundo operando no se puede convertir exactamente.
@end deffn

@geindex conjugate() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal conjugate}@anchor{264d}
@deffn {Método} conjugate ()

Simplemente retorna self (el propio objeto al que pertenece el método invocado). Este método existe solo para cumplir con la Especificación decimal.
@end deffn

@geindex copy_abs() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_abs}@anchor{264e}
@deffn {Método} copy_abs ()

Retorna el valor absoluto del argumento. Esta operación no se ve afectada por el contexto y es silenciosa: no se modifican los flags y no se realiza ningún redondeo.
@end deffn

@geindex copy_negate() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_negate}@anchor{264f}
@deffn {Método} copy_negate ()

Retorna la negación del argumento. Esta operación no se ve afectada por el contexto y es silenciosa: no se cambian los flags y no se realiza ningún redondeo.
@end deffn

@geindex copy_sign() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_sign}@anchor{2650}
@deffn {Método} copy_sign (other, context=None)

Retorna una copia del primer operando pero con el signo establecido para que sea el mismo que el del segundo operando. Por ejemplo:

@example
>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')
@end example

Esta operación no se ve afectada por el contexto y es silenciosa: no se cambian los flags y no se realiza ningún redondeo. Como excepción, la versión de C puede lanzar InvalidOperation si el segundo operando no se puede convertir exactamente.
@end deffn

@geindex exp() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal exp}@anchor{1121}
@deffn {Método} exp (context=None)

Retorna el valor de la función exponencial (natural) @code{e**x} en el número dado. El resultado es correctamente redondeado utilizando el modo de redondeo @ref{2635,,ROUND_HALF_EVEN}.

@example
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal(321).exp()
Decimal('2.561702493119680037517373933E+139')
@end example
@end deffn

@geindex from_float() (método de clase de decimal.Decimal)
@anchor{library/decimal decimal Decimal from_float}@anchor{1271}
@deffn {Método} classmethod from_float (f)

Constructor alternativo que acepta únicamente instancias de @ref{153,,float} o @ref{1f0,,int}.

Fíjate que @code{Decimal.from_float(0.1)} no es lo mismo que @code{Decimal('0.1')}. Dado que 0.1 no es exactamente representable en coma flotante binaria, el valor se almacena como el valor representable más cercano, que es @code{0x1.999999999999ap-4}. Ese valor equivalente en decimal es @code{0.1000000000000000055511151231257827021181583404541015625}.

@cartouche
@quotation Nota 
Desde Python 3.2 en adelante, una instancia de @ref{16a,,Decimal} también se puede construir directamente desde una instancia de @ref{153,,float}.
@end quotation
@end cartouche

@example
>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_float(float('nan'))
Decimal('NaN')
>>> Decimal.from_float(float('inf'))
Decimal('Infinity')
>>> Decimal.from_float(float('-inf'))
Decimal('-Infinity')
@end example


Added in version 3.1.

@end deffn

@geindex from_number() (método de clase de decimal.Decimal)
@anchor{library/decimal decimal Decimal from_number}@anchor{16b}
@deffn {Método} classmethod from_number (number)

Alternative constructor that only accepts instances of
@ref{153,,float}, @ref{1f0,,int} or @ref{16a,,Decimal}, but not strings
or tuples.

@example
>>> Decimal.from_number(314)
Decimal('314')
>>> Decimal.from_number(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_number(Decimal('3.14'))
Decimal('3.14')
@end example


Added in version 3.14.

@end deffn

@geindex fma() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal fma}@anchor{2651}
@deffn {Método} fma (other, third, context=None)

Fusión de la multiplicación y la suma. Retorna self*other+third sin redondeo del producto intermedio self*other.

@example
>>> Decimal(2).fma(3, 5)
Decimal('11')
@end example
@end deffn

@geindex is_canonical() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_canonical}@anchor{2652}
@deffn {Método} is_canonical ()

Retorna @ref{c95,,True} si el argumento es canónico y @ref{bbf,,False} en caso contrario. Actualmente, una instancia de @ref{16a,,Decimal} es siempre canónica, por lo que esta operación siempre retorna @ref{c95,,True}.
@end deffn

@geindex is_finite() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_finite}@anchor{2653}
@deffn {Método} is_finite ()

Retorna @ref{c95,,True} si el argumento es un número finito y @ref{bbf,,False} si el argumento es un valor infinito o un NaN.
@end deffn

@geindex is_infinite() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_infinite}@anchor{2654}
@deffn {Método} is_infinite ()

Retorna @ref{c95,,True} si el argumento es un valor infinito positivo o negativo y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex is_nan() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_nan}@anchor{2655}
@deffn {Método} is_nan ()

Retorna @ref{c95,,True} si el argumento es un NaN (silencioso o señalizador) y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex is_normal() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_normal}@anchor{2656}
@deffn {Método} is_normal (context=None)

Retorna @ref{c95,,True} si el argumento es un número finito `normal'. Retorna @ref{bbf,,False} si el argumento es cero, subnormal, infinito o un NaN.
@end deffn

@geindex is_qnan() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_qnan}@anchor{2657}
@deffn {Método} is_qnan ()

Retorna @ref{c95,,True} si el argumento es un NaN silencioso y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex is_signed() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_signed}@anchor{2658}
@deffn {Método} is_signed ()

Retorna @ref{c95,,True} si el argumento tiene signo negativo y @ref{bbf,,False} en caso contrario. Ten en cuenta que tanto los ceros como los NaN pueden tener signo.
@end deffn

@geindex is_snan() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_snan}@anchor{2659}
@deffn {Método} is_snan ()

Retorna @ref{c95,,True} si el argumento es un NaN señalizador y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex is_subnormal() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_subnormal}@anchor{265a}
@deffn {Método} is_subnormal (context=None)

Retorna @ref{c95,,True} si el argumento es subnormal y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex is_zero() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal is_zero}@anchor{265b}
@deffn {Método} is_zero ()

Retorna @ref{c95,,True} si el argumento es un cero (positivo o negativo) y @ref{bbf,,False} en caso contrario.
@end deffn

@geindex ln() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal ln}@anchor{1122}
@deffn {Método} ln (context=None)

Retorna el logaritmo natural (base e) del operando. El resultado es correctamente redondeado utilizando el modo de redondeo @ref{2635,,ROUND_HALF_EVEN}.
@end deffn

@geindex log10() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal log10}@anchor{265c}
@deffn {Método} log10 (context=None)

Retorna el logaritmo en base diez del operando. El resultado es correctamente redondeado utilizando el modo de redondeo @ref{2635,,ROUND_HALF_EVEN}.
@end deffn

@geindex logb() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal logb}@anchor{265d}
@deffn {Método} logb (context=None)

Para un número distinto de cero, retorna el exponente ajustado de su operando como una instancia de @ref{16a,,Decimal}. Si el operando es cero, se retorna @code{Decimal('-Infinity')} y se activa el flag @ref{263a,,DivisionByZero}. Si el operando es infinito, se retorna @code{Decimal('Infinity')}.
@end deffn

@geindex logical_and() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_and}@anchor{265e}
@deffn {Método} logical_and (other, context=None)

@code{logic_and()} es una operación lógica que toma dos `operandos lógicos' (consultar @ref{265f,,Operandos lógicos}). El resultado es el @code{and} dígito por dígito de los dos operandos.
@end deffn

@geindex logical_invert() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_invert}@anchor{2660}
@deffn {Método} logical_invert (context=None)

@code{logic_invert()} es una operación lógica. El resultado es la inversión dígito a dígito del operando.
@end deffn

@geindex logical_or() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_or}@anchor{2661}
@deffn {Método} logical_or (other, context=None)

@ref{2661,,logical_or()} es una operación lógica que toma dos `operandos lógicos' (consultar @ref{265f,,Operandos lógicos}). El resultado es un @code{or} dígito a dígito de los dos operandos.
@end deffn

@geindex logical_xor() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_xor}@anchor{2662}
@deffn {Método} logical_xor (other, context=None)

@code{logic_xor()} es una operación lógica que toma dos `operandos lógicos' (consultar @ref{265f,,Operandos lógicos}). El resultado es la disyunción exclusiva («exclusive or») dígito a dígito de ambos operandos.
@end deffn

@geindex max() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal max}@anchor{2663}
@deffn {Método} max (other, context=None)

Como @code{max(self, other)}, excepto que la regla de redondeo del contexto se aplica antes de retornar y que los valores @code{NaN} generan una señal o son ignorados (dependiendo del contexto y de si son señalizadores o silenciosos).
@end deffn

@geindex max_mag() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal max_mag}@anchor{2664}
@deffn {Método} max_mag (other, context=None)

Similar al método @ref{2663,,max()}, pero la comparación se realiza utilizando los valores absolutos de los operandos.
@end deffn

@geindex min() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal min}@anchor{2665}
@deffn {Método} min (other, context=None)

Como @code{min(self, other)}, excepto que la regla de redondeo del contexto se aplica antes de retornar y que los valores @code{NaN} generan una señal o se ignoran (según el contexto y si son señalizadores o no).
@end deffn

@geindex min_mag() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal min_mag}@anchor{2666}
@deffn {Método} min_mag (other, context=None)

Similar al método @ref{2665,,min()}, pero la comparación se realiza utilizando los valores absolutos de los operandos.
@end deffn

@geindex next_minus() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal next_minus}@anchor{2667}
@deffn {Método} next_minus (context=None)

Retorna el número más grande representable en el contexto proporcionado (o en el contexto del hilo actual si no se proporciona un contexto) que sea más pequeño que el operando proporcionado.
@end deffn

@geindex next_plus() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal next_plus}@anchor{2668}
@deffn {Método} next_plus (context=None)

Retorna el número más pequeño representable en el contexto proporcionado (o en el contexto del hilo actual si no se proporciona ningún contexto) que sea más grande que el operando proporcionado.
@end deffn

@geindex next_toward() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal next_toward}@anchor{2669}
@deffn {Método} next_toward (other, context=None)

Si los dos operandos no son iguales, retorna el número más cercano al primer operando en la dirección del segundo operando. Si ambos operandos son numéricamente iguales, retorna una copia del primer operando con el signo establecido para que sea el mismo que el signo del segundo operando.
@end deffn

@geindex normalize() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal normalize}@anchor{266a}
@deffn {Método} normalize (context=None)

Usado para producir valores canónicos de una clase de equivalencia dentro del contexto actual o del contexto especificado.

Este tiene la misma semántica que el operador unario @code{+}, excepto que si el resultado final es finito, entonces se reduce a su forma más simple, eliminando todos los ceros finales y preservando el signo. Es decir, que mientras que el coeficiente sea distinto de cero y múltiplo de 10, el coeficiente se divide por 10 y el exponente se incremente por 1. En otro caso (el coeficiente es cero), el exponente se establece en 0. En todos los casos el signo no se modifica.

Por ejemplo, @code{Decimal('32.100')} y @code{Decimal('0.321000e+2')} ambos se normalizan al valor equivalente @code{Decimal('32.1')}.

Fíjate que el redondeo se aplica `antes' de reducir a la forma más simple.

En las últimas versiones de la especificación, esta operación también era conocida como @code{reduce}.
@end deffn

@geindex number_class() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal number_class}@anchor{266b}
@deffn {Método} number_class (context=None)

Retorna una cadena de caracteres que describe la `class' del operando. El valor retornado es una de las siguientes diez cadenas de caracteres.


@itemize *

@item 
@code{"-Infinity"}, que indica que el operando es un infinito negativo.

@item 
@code{"-Normal"}, que indica que el operando es un número normal negativo.

@item 
@code{"-Subnormal"}, que indica que el operando es negativo y subnormal.

@item 
@code{"-Zero"}, que indica que el operando es un cero negativo.

@item 
@code{"+Zero"}, que indica que el operando es un cero positivo.

@item 
@code{"+Subnormal"},que indica que el operando es positivo y subnormal.

@item 
@code{"+Normal"}, que indica que el operando es un número normal positivo.

@item 
@code{"+Infinity"}, que indica que el operando es un infinito positivo.

@item 
@code{"NaN"}, que indica que el operando es un NaN (no es un número) silencioso.

@item 
@code{"sNaN"}, que indica que el operando es un NaN (no es un número) señalizador.
@end itemize
@end deffn

@geindex quantize() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal quantize}@anchor{1125}
@deffn {Método} quantize (exp, rounding=None, context=None)

Retorna un valor igual al primer operando después de ser redondeado y de asignarle el exponente del segundo operando.

@example
>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')
@end example

A diferencia de otras operaciones, se genera una señal @ref{111f,,InvalidOperation} si la longitud del coeficiente después de la operación quantize es mayor que la precisión. Esto garantiza que, a menos que exista una condición de error, el exponente cuantificado sea siempre igual al del operando de la derecha.

Además, a diferencia de otras operaciones, quantize nunca genera una señal Underflow, incluso si el resultado es subnormal e inexacto.

Si el exponente del segundo operando es mayor que el del primero, puede ser necesario redondear. En este caso, el modo de redondeo está determinado por el argumento @code{rounding}, si se proporciona, o por el argumento @code{context} en caso contrario. Si no se proporciona ninguno de estos dos argumentos, se utiliza el modo de redondeo establecido en el contexto del hilo actual.

Se retorna un error siempre que el exponente resultante sea mayor que @code{Emax} o menor que @ref{266c,,Etiny()}.
@end deffn

@geindex radix() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal radix}@anchor{266d}
@deffn {Método} radix ()

Retorna @code{Decimal(10)}, que es la raíz (base) en la que la clase @ref{16a,,Decimal} hace toda su aritmética. Este método está incluido solo por compatibilidad con la especificación.
@end deffn

@geindex remainder_near() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal remainder_near}@anchor{266e}
@deffn {Método} remainder_near (other, context=None)

Retorna el resto de dividir `self' entre `other'. Esto difiere de la operación @code{self % other}, en la que el signo del resto se elige para minimizar su valor absoluto. Más precisamente, el valor de retorno es @code{self - n * other}, donde @code{n} es el número entero más cercano al valor exacto de @code{self / other}. Si dos enteros están igualmente cerca, entonces el valor par es el elegido.

Si el resultado es cero, entonces su signo será el signo de `self'.

@example
>>> Decimal(18).remainder_near(Decimal(10))
Decimal('-2')
>>> Decimal(25).remainder_near(Decimal(10))
Decimal('5')
>>> Decimal(35).remainder_near(Decimal(10))
Decimal('-5')
@end example
@end deffn

@geindex rotate() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal rotate}@anchor{266f}
@deffn {Método} rotate (other, context=None)

Retorna el resultado de rotar los dígitos del primer operando en una cantidad especificada por el segundo operando. El segundo operando debe ser un número entero en el rango comprendido desde -precisión hasta precisión. El valor absoluto del segundo operando da el número de lugares a rotar. Si el segundo operando es positivo, la rotación es hacia la izquierda; de lo contrario, la rotación es hacia la derecha. El coeficiente del primer operando se rellena con ceros a la izquierda para satisfacer la precisión de longitud si es necesario. El signo y el exponente del primer operando no se modifican.
@end deffn

@geindex same_quantum() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal same_quantum}@anchor{2670}
@deffn {Método} same_quantum (other, context=None)

Comprueba si self y other tienen el mismo exponente o si ambos son @code{NaN}.

Esta operación no se ve afectada por el contexto y es silenciosa: no se cambian los flags y no se realiza ningún redondeo. Como excepción, la versión de C puede lanzar InvalidOperation si el segundo operando no se puede convertir exactamente.
@end deffn

@geindex scaleb() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal scaleb}@anchor{2671}
@deffn {Método} scaleb (other, context=None)

Retorna el primer operando con su exponente ajustado por el segundo. De manera equivalente, retorna el primer operando multiplicado por @code{10**other}. El segundo operando debe ser un número entero.
@end deffn

@geindex shift() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal shift}@anchor{2672}
@deffn {Método} shift (other, context=None)

Retorna el resultado de cambiar los dígitos del primer operando en una cantidad especificada por el segundo operando. El segundo operando debe ser un número entero en el rango comprendido desde -precisión hasta precisión. El valor absoluto del segundo operando da el número de lugares a desplazar. Si el segundo operando es positivo, el desplazamiento es hacia la izquierda; de lo contrario, el desplazamiento es hacia la derecha. Los dígitos desplazados en el coeficiente son ceros. El signo y el exponente del primer operando no se modifican.
@end deffn

@geindex sqrt() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal sqrt}@anchor{2673}
@deffn {Método} sqrt (context=None)

Retorna la raíz cuadrada del argumento con precisión total.
@end deffn

@geindex to_eng_string() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal to_eng_string}@anchor{2674}
@deffn {Método} to_eng_string (context=None)

Convierte a una cadena de caracteres, usando notación de ingeniería si se necesita un exponente.

La notación de ingeniería tiene como exponente un múltiplo de 3. Esto puede dejar hasta 3 dígitos a la izquierda del punto decimal y puede requerir la adición de uno o dos ceros finales.

Por ejemplo, este método convierte @code{Decimal('123E+1')} en @code{Decimal('1.23E+3')}.
@end deffn

@geindex to_integral() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral}@anchor{2675}
@deffn {Método} to_integral (rounding=None, context=None)

Idéntico al método @ref{2676,,to_integral_value()}. El nombre @code{to_integral} se ha mantenido por compatibilidad con versiones anteriores.
@end deffn

@geindex to_integral_exact() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral_exact}@anchor{2677}
@deffn {Método} to_integral_exact (rounding=None, context=None)

Redondea al entero más cercano, generando la señal @ref{263b,,Inexact} o @ref{263c,,Rounded}, según corresponda, si se produce un redondeo. El modo de redondeo está determinado por el parámetro @code{rounding} si es proporcionado, o por el establecido en el @code{context} proporcionado en caso contrario. Si no se proporciona ninguno de estos dos parámetros, se utiliza el modo de redondeo establecido en el contexto actual.
@end deffn

@geindex to_integral_value() (método de decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral_value}@anchor{2676}
@deffn {Método} to_integral_value (rounding=None, context=None)

Redondea al entero más cercano sin generar la señal @ref{263b,,Inexact} o @ref{263c,,Rounded}. Si se proporciona, se aplica el método de redondeo especificado por `rounding'; en caso contrario, se utiliza el método de redondeo del `context' proporcionado o el del contexto actual.
@end deffn

Decimal numbers can be rounded using the @ref{1342,,round()} function:


@deffn {Describe} round(number)
@end deffn


@deffn {Describe} round(number, ndigits)

If `ndigits' is not given or @code{None},
returns the nearest @ref{1f0,,int} to `number',
rounding ties to even, and ignoring the rounding mode of the
@ref{16a,,Decimal} context.  Raises @ref{919,,OverflowError} if `number' is an
infinity or @ref{360,,ValueError} if it is a (quiet or signaling) NaN.

If `ndigits' is an @ref{1f0,,int}, the context’s rounding mode is respected
and a @ref{16a,,Decimal} representing `number' rounded to the nearest
multiple of @code{Decimal('1E-ndigits')} is returned; in this case,
@code{round(number, ndigits)} is equivalent to
@code{self.quantize(Decimal('1E-ndigits'))}.  Returns @code{Decimal('NaN')} if
`number' is a quiet NaN.  Raises @ref{111f,,InvalidOperation} if `number'
is an infinity, a signaling NaN, or if the length of the coefficient after
the quantize operation would be greater than the current context’s
precision.  In other words, for the non-corner cases:


@itemize *

@item 
if `ndigits' is positive, return `number' rounded to `ndigits' decimal
places;

@item 
if `ndigits' is zero, return `number' rounded to the nearest integer;

@item 
if `ndigits' is negative, return `number' rounded to the nearest
multiple of @code{10**abs(ndigits)}.
@end itemize

For example:

@example
>>> from decimal import Decimal, getcontext, ROUND_DOWN
>>> getcontext().rounding = ROUND_DOWN
>>> round(Decimal('3.75'))     # context rounding ignored
4
>>> round(Decimal('3.5'))      # round-ties-to-even
4
>>> round(Decimal('3.75'), 0)  # uses the context rounding
Decimal('3')
>>> round(Decimal('3.75'), 1)
Decimal('3.7')
>>> round(Decimal('3.75'), -1)
Decimal('0E+1')
@end example
@end deffn
@end deffn

@menu
* Operandos lógicos:: 

@end menu

@node Operandos lógicos,,,Objetos Decimal
@anchor{library/decimal logical-operands}@anchor{2678}@anchor{library/decimal logical-operands-label}@anchor{265f}
@subsubsection Operandos lógicos


Los métodos @ref{265e,,logical_and()}, @ref{2660,,logical_invert()}, @ref{2661,,logical_or()}, y @ref{2662,,logical_xor()} esperan que sus argumentos sean `operandos lógicos'. Un `operando lógico' es una instancia de @ref{16a,,Decimal} cuyo exponente y signo son ambos cero, y cuyos dígitos son todos @code{0} o @code{1}.

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Objetos context,Constantes<4>,Objetos Decimal,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal context-objects}@anchor{2679}@anchor{library/decimal decimal-context}@anchor{22e6}
@subsubsection Objetos context


Los contextos son entornos para operaciones aritméticas. Gobiernan la precisión, establecen reglas para el redondeo, determinan qué señales se tratan como excepciones y limitan el rango para los exponentes.

Cada hilo tiene su propio contexto actual, al que se accede o se reemplaza usando las funciones @ref{15cd,,getcontext()} y @ref{2642,,setcontext()} respectivamente:

@geindex getcontext() (en el módulo decimal)
@anchor{library/decimal decimal getcontext}@anchor{15cd}
@deffn {Función} decimal.getcontext ()

Retorna el contexto actual del hilo activo.
@end deffn

@geindex setcontext() (en el módulo decimal)
@anchor{library/decimal decimal setcontext}@anchor{2642}
@deffn {Función} decimal.setcontext (c)

Establece `c' como contexto actual para el hilo activo.
@end deffn

También puedes usar la declaración @ref{673,,with} y la función @ref{180b,,localcontext()} para cambiar temporalmente el contexto activo.

@geindex localcontext() (en el módulo decimal)
@anchor{library/decimal decimal localcontext}@anchor{180b}
@deffn {Función} decimal.localcontext (ctx=None, **kwargs)

Retorna un gestor de contexto que establecerá el contexto actual para el hilo activo en una copia de `ctx' al ingresar en la sentencia with y restaurará el contexto anterior al salir de la misma. Si no se especifica ningún contexto, se utiliza una copia del contexto actual. El argumento `kwargs' se usa para establecer los atributos del nuevo contexto.

Por ejemplo, el siguiente código establece la precisión decimal actual en 42 lugares, realiza un cálculo y luego restaura automáticamente el contexto anterior:

@example
from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Perform a high precision calculation
    s = calculate_something()
s = +s  # Round the final result back to the default precision
@end example

Usando argumentos de palabra clave, el código sería el siguiente:

@example
from decimal import localcontext

with localcontext(prec=42) as ctx:
    s = calculate_something()
s = +s
@end example

Lanza @ref{228,,TypeError} si `kwargs' proporciona un atributo que @ref{1124,,Context} no soporta. Lanza también @ref{228,,TypeError} o @ref{360,,ValueError} si `kwargs' proporciona un valor no válido para un atributo.


Distinto en la versión 3.11: @ref{180b,,localcontext()} ahora admite la configuración de atributos de contexto mediante el uso de argumentos de palabra clave.

@end deffn

También se pueden crear nuevos contextos utilizando el constructor de la clase @ref{1124,,Context} que se describe a continuación. Además, el módulo proporciona tres contextos prediseñados:

@geindex BasicContext (clase en decimal)
@anchor{library/decimal decimal BasicContext}@anchor{111d}
@deffn {Clase} decimal.BasicContext

Este es un contexto estándar definido por la Especificación general de la aritmética decimal. La precisión se establece en nueve. El redondeo se establece en @ref{2636,,ROUND_HALF_UP}. Se restablecen todos los flags. Todas las trampas están habilitadas (las señales son tratadas como excepciones) excepto @ref{263b,,Inexact}, @ref{263c,,Rounded} y @ref{263d,,Subnormal}.

Debido a que la mayoría de las trampas están habilitadas, este contexto es especialmente útil para la depuración.
@end deffn

@geindex ExtendedContext (clase en decimal)
@anchor{library/decimal decimal ExtendedContext}@anchor{111e}
@deffn {Clase} decimal.ExtendedContext

Este es un contexto estándar definido por la Especificación general de la aritmética decimal. La precisión se establece en nueve. El redondeo se establece en @ref{2635,,ROUND_HALF_EVEN}. Se restablecen todos los flags. No se habilitan trampas (para que no se generen excepciones durante los cálculos).

Debido a que las trampas están deshabilitadas, este contexto es útil para aplicaciones que prefieren tener un valor @code{NaN} o @code{Infinity} como resultado en lugar de lanzar excepciones. Esto permite que una aplicación complete una ejecución en presencia de condiciones que, de otra manera, detendrían el programa.
@end deffn

@geindex DefaultContext (clase en decimal)
@anchor{library/decimal decimal DefaultContext}@anchor{111c}
@deffn {Clase} decimal.DefaultContext

Este contexto es utilizado por el constructor de la clase @ref{1124,,Context} como un prototipo para nuevos contextos. Cambiar un campo (como la precisión) tiene el efecto de cambiar el valor predeterminado para los nuevos contextos creados por el constructor de @ref{1124,,Context}.

Este contexto es más útil en entornos con múltiples hilos. Cambiar uno de los campos antes de que se inicien los hilos tiene el efecto de establecer valores predeterminados en todo el sistema. No se recomienda cambiar los campos después de que se hayan iniciado los hilos, ya que requeriría el uso de mecanismos de sincronización para evitar condiciones de carrera entre los hilos.

En entornos de un solo hilo, es preferible no utilizar este contexto en absoluto. En su lugar, simplemente crea contextos explícitamente como se describe a continuación.

Los valores predeterminados son @code{Context.prec}=@code{28}, @code{Context.rounding}=@ref{2635,,ROUND_HALF_EVEN}, y trampas habilitadas para @ref{263e,,Overflow}, @ref{111f,,InvalidOperation}, y @ref{263a,,DivisionByZero}.
@end deffn

Además de los tres contextos proporcionados, se pueden crear nuevos contextos mediante el constructor de la clase @ref{1124,,Context}.

@geindex Context (clase en decimal)
@anchor{library/decimal decimal Context}@anchor{1124}
@deffn {Clase} decimal.Context (prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

Crea un nuevo contexto. Si no se especifica un campo, o es @ref{716,,None}, los valores predeterminados se copian de @ref{111c,,DefaultContext}. Si el campo `flags' no está especificado, o es @ref{716,,None}, se restablecen todas los flags.

`prec' es un número entero en el rango [@code{1}, @ref{267a,,MAX_PREC}] que establece la precisión para las operaciones aritméticas en el contexto.

La opción `rounding' es una de las constantes enumeradas en la sección @ref{267b,,Rounding Modes}.

Los campos `traps' y `flags' enumeran las señales que se deben establecer. Generalmente, los nuevos contextos solo deben establecer trampas y dejar los flags sin establecer.

Los campos `Emin' y `Emax' son números enteros que especifican los límites externos permitidos para los exponentes. `Emin' debe estar en el rango [@ref{267c,,MIN_EMIN}, @code{0}] y `Emax' en el rango [@code{0}, @ref{267d,,MAX_EMAX}].

El campo `capitals' es @code{0} o @code{1} (por defecto). Si se establece en @code{1}, los exponentes se imprimen usando una @code{E} mayúscula; de lo contrario, se usa una @code{e} minúscula: @code{Decimal('6.02e+23')}.

El campo `clamp' es @code{0} (por defecto) o @code{1}. Si se establece en @code{1}, el exponente @code{e} representable en este contexto de una instancia de @ref{16a,,Decimal} está estrictamente limitado al rango @code{Emin - prec + 1 <= e <= Emax - prec + 1}. Si `clamp' es @code{0}, entonces se cumple una condición más laxa: el exponente ajustado de la instancia de @ref{16a,,Decimal} es como máximo @code{Emax}. Cuando `clamp' es @code{1}, cuando sea posible, se reducirá el exponente de un número normal grande y se agregarán el número correspondiente de ceros a su coeficiente, a fin de que se ajuste a las restricciones del exponente; esto conserva el valor del número pero conlleva una pérdida de información causada por los ceros finales significativos. Por ejemplo:

@example
>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')
@end example

Un valor `clamp' de @code{1} permite la compatibilidad con los formatos de intercambio decimal de ancho fijo especificados en IEEE 754.

La clase @ref{1124,,Context} define varios métodos de propósito general, así como una gran cantidad de métodos para hacer aritmética directamente en un contexto dado. Además, para cada uno de los métodos de la clase @ref{16a,,Decimal} descritos anteriormente (con la excepción de los métodos @ref{2646,,adjusted()} y @ref{2647,,as_tuple()}) hay un método correspondiente en la clase @ref{1124,,Context}. Por ejemplo, para una instancia de @ref{1124,,Context} @code{C} y una instancia de @ref{16a,,Decimal} @code{x}, @code{C.exp(x)} es equivalente a @code{x.exp(context=C)}. Cada método @ref{1124,,Context} acepta también un entero de Python (una instancia de @ref{1f0,,int}) en cualquier lugar donde se acepte una instancia de Decimal.

@geindex clear_flags() (método de decimal.Context)
@anchor{library/decimal decimal Context clear_flags}@anchor{2643}
@deffn {Método} clear_flags ()

Restablece todos los flags a @code{0}.
@end deffn

@geindex clear_traps() (método de decimal.Context)
@anchor{library/decimal decimal Context clear_traps}@anchor{267e}
@deffn {Método} clear_traps ()

Restablece todas las trampas a @code{0}.


Added in version 3.3.

@end deffn

@geindex copy() (método de decimal.Context)
@anchor{library/decimal decimal Context copy}@anchor{267f}
@deffn {Método} copy ()

Retorna un duplicado del contexto.
@end deffn

@geindex copy_decimal() (método de decimal.Context)
@anchor{library/decimal decimal Context copy_decimal}@anchor{2680}
@deffn {Método} copy_decimal (num)

Retorna una copia de la instancia de Decimal num.
@end deffn

@geindex create_decimal() (método de decimal.Context)
@anchor{library/decimal decimal Context create_decimal}@anchor{1120}
@deffn {Método} create_decimal (num)

Crea una nueva instancia de Decimal a partir de `num' pero usando `self' como contexto. A diferencia del constructor de @ref{16a,,Decimal}, la precisión del contexto, el método de redondeo, los flags y las trampas se aplican a la conversión.

Esto es útil porque las constantes a menudo se proporcionan con una precisión mayor que la que necesita la aplicación. Otro beneficio es que el redondeo elimina inmediatamente los efectos no deseados de los dígitos más allá de la precisión actual. En el siguiente ejemplo, usar entradas no redondeadas significa que agregar cero a una suma puede cambiar el resultado:

@example
>>> getcontext().prec = 3
>>> Decimal('3.4445') + Decimal('1.0023')
Decimal('4.45')
>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
Decimal('4.44')
@end example

Este método implementa la operación to-number de la especificación de IBM. Si el argumento es una cadena de caracteres, no se permiten espacios en blanco ni guiones bajos, ni al principio ni al final.
@end deffn

@geindex create_decimal_from_float() (método de decimal.Context)
@anchor{library/decimal decimal Context create_decimal_from_float}@anchor{2681}
@deffn {Método} create_decimal_from_float (f)

Crea una nueva instancia de Decimal a partir de un flotante `f', pero redondeando usando `self' como contexto. A diferencia del método de clase @ref{1271,,Decimal.from_float()}, la precisión del contexto, el método de redondeo, los flags y las trampas se aplican a la conversión.

@example
>>> context = Context(prec=5, rounding=ROUND_DOWN)
>>> context.create_decimal_from_float(math.pi)
Decimal('3.1415')
>>> context = Context(prec=5, traps=[Inexact])
>>> context.create_decimal_from_float(math.pi)
Traceback (most recent call last):
    ...
decimal.Inexact: None
@end example


Added in version 3.1.

@end deffn

@geindex Etiny() (método de decimal.Context)
@anchor{library/decimal decimal Context Etiny}@anchor{266c}
@deffn {Método} Etiny ()

Retorna un valor igual a @code{Emin - prec + 1} que es el valor mínimo del exponente para resultados subnormales. Cuando ocurre un desbordamiento numérico negativo («underflow»), el exponente se establece en @ref{266c,,Etiny}.
@end deffn

@geindex Etop() (método de decimal.Context)
@anchor{library/decimal decimal Context Etop}@anchor{2682}
@deffn {Método} Etop ()

Retorna un valor igual a @code{Emax - prec + 1}.
@end deffn

El enfoque habitual para trabajar con decimales es crear instancias de la clase @ref{16a,,Decimal} y luego aplicar operaciones aritméticas que tienen lugar dentro del contexto actual para el hilo activo. Un enfoque alternativo es utilizar métodos de contexto para calcular dentro de un contexto específico. Los métodos son similares a los de la clase @ref{16a,,Decimal} y aquí solo se relatan brevemente.

@geindex abs() (método de decimal.Context)
@anchor{library/decimal decimal Context abs}@anchor{2683}
@deffn {Método} abs (x)

Retorna el valor absoluto de `x'.
@end deffn

@geindex add() (método de decimal.Context)
@anchor{library/decimal decimal Context add}@anchor{2684}
@deffn {Método} add (x, y)

Retorna la suma de `x' e `y'.
@end deffn

@geindex canonical() (método de decimal.Context)
@anchor{library/decimal decimal Context canonical}@anchor{136e}
@deffn {Método} canonical (x)

Retorna el mismo objeto Decimal `x'.
@end deffn

@geindex compare() (método de decimal.Context)
@anchor{library/decimal decimal Context compare}@anchor{2685}
@deffn {Método} compare (x, y)

Compara `x' e `y' numéricamente.
@end deffn

@geindex compare_signal() (método de decimal.Context)
@anchor{library/decimal decimal Context compare_signal}@anchor{2686}
@deffn {Método} compare_signal (x, y)

Compara los valores de los dos operandos numéricamente.
@end deffn

@geindex compare_total() (método de decimal.Context)
@anchor{library/decimal decimal Context compare_total}@anchor{2687}
@deffn {Método} compare_total (x, y)

Compara los dos operandos utilizando su representación abstracta.
@end deffn

@geindex compare_total_mag() (método de decimal.Context)
@anchor{library/decimal decimal Context compare_total_mag}@anchor{2688}
@deffn {Método} compare_total_mag (x, y)

Compara los dos operandos utilizando su representación abstracta, ignorando el signo.
@end deffn

@geindex copy_abs() (método de decimal.Context)
@anchor{library/decimal decimal Context copy_abs}@anchor{2689}
@deffn {Método} copy_abs (x)

Retorna una copia de `x' con el signo establecido en 0.
@end deffn

@geindex copy_negate() (método de decimal.Context)
@anchor{library/decimal decimal Context copy_negate}@anchor{268a}
@deffn {Método} copy_negate (x)

Retorna una copia de `x' con el signo invertido.
@end deffn

@geindex copy_sign() (método de decimal.Context)
@anchor{library/decimal decimal Context copy_sign}@anchor{268b}
@deffn {Método} copy_sign (x, y)

Copia el signo de `y' en `x'.
@end deffn

@geindex divide() (método de decimal.Context)
@anchor{library/decimal decimal Context divide}@anchor{268c}
@deffn {Método} divide (x, y)

Retorna `x' dividido entre `y'.
@end deffn

@geindex divide_int() (método de decimal.Context)
@anchor{library/decimal decimal Context divide_int}@anchor{268d}
@deffn {Método} divide_int (x, y)

Retorna `x' dividido entre `y', truncando el resultado a un número entero.
@end deffn

@geindex divmod() (método de decimal.Context)
@anchor{library/decimal decimal Context divmod}@anchor{268e}
@deffn {Método} divmod (x, y)

Divide dos números y retorna la parte entera del resultado.
@end deffn

@geindex exp() (método de decimal.Context)
@anchor{library/decimal decimal Context exp}@anchor{268f}
@deffn {Método} exp (x)

Retorna @code{e ** x}.
@end deffn

@geindex fma() (método de decimal.Context)
@anchor{library/decimal decimal Context fma}@anchor{2690}
@deffn {Método} fma (x, y, z)

Retorna `x' multiplicado por `y', más `z'.
@end deffn

@geindex is_canonical() (método de decimal.Context)
@anchor{library/decimal decimal Context is_canonical}@anchor{136f}
@deffn {Método} is_canonical (x)

Retorna @code{True} si `x' está en forma canónica, en caso contrario retorna @code{False}.
@end deffn

@geindex is_finite() (método de decimal.Context)
@anchor{library/decimal decimal Context is_finite}@anchor{2691}
@deffn {Método} is_finite (x)

Retorna @code{True} si `x' es un valor finito, en caso contrario retorna @code{False}.
@end deffn

@geindex is_infinite() (método de decimal.Context)
@anchor{library/decimal decimal Context is_infinite}@anchor{2692}
@deffn {Método} is_infinite (x)

Retorna @code{True} si `x' es un valor infinito, en caso contrario retorna @code{False}.
@end deffn

@geindex is_nan() (método de decimal.Context)
@anchor{library/decimal decimal Context is_nan}@anchor{2693}
@deffn {Método} is_nan (x)

Retorna @code{True} si `x' es un valor qNaN o sNaN , en caso contrario retorna @code{False}.
@end deffn

@geindex is_normal() (método de decimal.Context)
@anchor{library/decimal decimal Context is_normal}@anchor{2694}
@deffn {Método} is_normal (x)

Retorna @code{True} si `x' es un número normal, en caso contrario retorna @code{False}.
@end deffn

@geindex is_qnan() (método de decimal.Context)
@anchor{library/decimal decimal Context is_qnan}@anchor{2695}
@deffn {Método} is_qnan (x)

Retorna @code{True} si `x' es un NaN silencioso, en caso contrario retorna @code{False}.
@end deffn

@geindex is_signed() (método de decimal.Context)
@anchor{library/decimal decimal Context is_signed}@anchor{2696}
@deffn {Método} is_signed (x)

Retorna @code{True} si `x' es un valor negativo, en caso contrario retorna @code{False}.
@end deffn

@geindex is_snan() (método de decimal.Context)
@anchor{library/decimal decimal Context is_snan}@anchor{2697}
@deffn {Método} is_snan (x)

Retorna @code{True} si `x' es un NaN señalizador, en caso contrario retorna @code{False}.
@end deffn

@geindex is_subnormal() (método de decimal.Context)
@anchor{library/decimal decimal Context is_subnormal}@anchor{2698}
@deffn {Método} is_subnormal (x)

Retorna @code{True} si `x' es un número subnormal, en caso contrario retorna @code{False}.
@end deffn

@geindex is_zero() (método de decimal.Context)
@anchor{library/decimal decimal Context is_zero}@anchor{2699}
@deffn {Método} is_zero (x)

Retorna @code{True} si `x' es un cero, en caso contrario retorna @code{False}.
@end deffn

@geindex ln() (método de decimal.Context)
@anchor{library/decimal decimal Context ln}@anchor{269a}
@deffn {Método} ln (x)

Retorna el logaritmo natural (base e) de `x'.
@end deffn

@geindex log10() (método de decimal.Context)
@anchor{library/decimal decimal Context log10}@anchor{269b}
@deffn {Método} log10 (x)

Retorna el logaritmo en base 10 de `x'.
@end deffn

@geindex logb() (método de decimal.Context)
@anchor{library/decimal decimal Context logb}@anchor{269c}
@deffn {Método} logb (x)

Retorna el exponente de la magnitud del MSD («dígito más significativo») del operando.
@end deffn

@geindex logical_and() (método de decimal.Context)
@anchor{library/decimal decimal Context logical_and}@anchor{269d}
@deffn {Método} logical_and (x, y)

Aplica la operación lógica `and' entre los dígitos de cada operando.
@end deffn

@geindex logical_invert() (método de decimal.Context)
@anchor{library/decimal decimal Context logical_invert}@anchor{269e}
@deffn {Método} logical_invert (x)

Invierte todos los dígitos en `x'.
@end deffn

@geindex logical_or() (método de decimal.Context)
@anchor{library/decimal decimal Context logical_or}@anchor{269f}
@deffn {Método} logical_or (x, y)

Aplica la operación lógica `or' entre los dígitos de cada operando.
@end deffn

@geindex logical_xor() (método de decimal.Context)
@anchor{library/decimal decimal Context logical_xor}@anchor{26a0}
@deffn {Método} logical_xor (x, y)

Aplica la operación lógica `xor' entre los dígitos de cada operando.
@end deffn

@geindex max() (método de decimal.Context)
@anchor{library/decimal decimal Context max}@anchor{26a1}
@deffn {Método} max (x, y)

Compara dos valores numéricamente y retorna el mayor de ellos.
@end deffn

@geindex max_mag() (método de decimal.Context)
@anchor{library/decimal decimal Context max_mag}@anchor{26a2}
@deffn {Método} max_mag (x, y)

Compara los valores numéricamente ignorando sus signos.
@end deffn

@geindex min() (método de decimal.Context)
@anchor{library/decimal decimal Context min}@anchor{26a3}
@deffn {Método} min (x, y)

Compara dos valores numéricamente y retorna el menor de ellos.
@end deffn

@geindex min_mag() (método de decimal.Context)
@anchor{library/decimal decimal Context min_mag}@anchor{26a4}
@deffn {Método} min_mag (x, y)

Compara los valores numéricamente ignorando sus signos.
@end deffn

@geindex minus() (método de decimal.Context)
@anchor{library/decimal decimal Context minus}@anchor{26a5}
@deffn {Método} minus (x)

Se corresponde con el operador unario de resta (prefijo) de Python.
@end deffn

@geindex multiply() (método de decimal.Context)
@anchor{library/decimal decimal Context multiply}@anchor{26a6}
@deffn {Método} multiply (x, y)

Retorna el producto de `x' por `y'.
@end deffn

@geindex next_minus() (método de decimal.Context)
@anchor{library/decimal decimal Context next_minus}@anchor{26a7}
@deffn {Método} next_minus (x)

Retorna el número más grande representable menor que `x'.
@end deffn

@geindex next_plus() (método de decimal.Context)
@anchor{library/decimal decimal Context next_plus}@anchor{26a8}
@deffn {Método} next_plus (x)

Retorna el número más pequeño representable mayor que `x'.
@end deffn

@geindex next_toward() (método de decimal.Context)
@anchor{library/decimal decimal Context next_toward}@anchor{26a9}
@deffn {Método} next_toward (x, y)

Retorna el número más cercano a `x', en la dirección de `y'.
@end deffn

@geindex normalize() (método de decimal.Context)
@anchor{library/decimal decimal Context normalize}@anchor{26aa}
@deffn {Método} normalize (x)

Reduce `x' a su forma más simple.
@end deffn

@geindex number_class() (método de decimal.Context)
@anchor{library/decimal decimal Context number_class}@anchor{26ab}
@deffn {Método} number_class (x)

Retorna una cadena de caracteres indicando la clase de `x'.
@end deffn

@geindex plus() (método de decimal.Context)
@anchor{library/decimal decimal Context plus}@anchor{26ac}
@deffn {Método} plus (x)

Se corresponde con el operador unario de suma (prefijo) de Python. Esta operación aplica la precisión y el redondeo establecidos en el contexto, por lo que `no' es una operación de identidad.
@end deffn

@geindex power() (método de decimal.Context)
@anchor{library/decimal decimal Context power}@anchor{26ad}
@deffn {Método} power (x, y, modulo=None)

Retorna @code{x} elevado a la potencia @code{y}, reconduciendo al módulo @code{modulo} si se proporciona.

Con dos argumentos, calcula @code{x**y}. Si @code{x} es negativo, entonces @code{y} debe ser un entero. El resultado será inexacto, a menos que @code{y} sea un entero y el resultado sea finito y pueda expresarse exactamente con los dígitos de la “precisión” establecida. Se utiliza el modo de redondeo establecido en el contexto. Los resultados siempre se redondean correctamente en la versión de Python.

@code{Decimal(0) ** Decimal(0)} da como resultado @code{InvalidOperation}, y si @code{InvalidOperation} no es atrapada, entonces da como resultado @code{Decimal('NaN')}.


Distinto en la versión 3.3: El módulo C calcula @ref{26ad,,power()} en términos de las funciones @ref{268f,,exp()} y @ref{269a,,ln()} redondeadas correctamente. El resultado está bien definido pero sólo «casi siempre correctamente redondeado».


Con tres argumentos, calcula @code{(x**y) % modulo}. Para la forma de tres argumentos, se mantienen las siguientes restricciones sobre los argumentos:


@itemize -

@item 
los tres argumentos deben ser enteros

@item 
@code{y} debe ser un valor no negativo

@item 
al menos uno, @code{x} o @code{y} , no debe ser cero

@item 
@code{modulo} no debe ser cero y tener como mínimo los dígitos de la “precisión”
@end itemize

El valor resultante de @code{Context.power(x, y, modulo)} es igual al valor que se obtendría calculando @code{(x**y) % modulo} con precisión ilimitada, la diferencia es que se calcula de manera más eficiente . El exponente del resultado es cero, independientemente de los exponentes de @code{x}, @code{y} y  @code{modulo}. El resultado siempre es exacto.
@end deffn

@geindex quantize() (método de decimal.Context)
@anchor{library/decimal decimal Context quantize}@anchor{26ae}
@deffn {Método} quantize (x, y)

Retorna un valor igual a `x' (redondeado), pero que tiene el exponente de `y'.
@end deffn

@geindex radix() (método de decimal.Context)
@anchor{library/decimal decimal Context radix}@anchor{26af}
@deffn {Método} radix ()

Simplemente retorna 10, ya que es Decimal, :)
@end deffn

@geindex remainder() (método de decimal.Context)
@anchor{library/decimal decimal Context remainder}@anchor{26b0}
@deffn {Método} remainder (x, y)

Retorna el resto de la división entera.

El signo del resultado, si no es cero, es el mismo que el del dividendo original.
@end deffn

@geindex remainder_near() (método de decimal.Context)
@anchor{library/decimal decimal Context remainder_near}@anchor{26b1}
@deffn {Método} remainder_near (x, y)

Retorna @code{x - y * n}, donde `n' es el número entero más cercano al valor exacto de @code{x / y} (si el resultado es 0, entonces su signo será el signo de `x').
@end deffn

@geindex rotate() (método de decimal.Context)
@anchor{library/decimal decimal Context rotate}@anchor{26b2}
@deffn {Método} rotate (x, y)

Retorna una copia de `x' rotada `y' veces.
@end deffn

@geindex same_quantum() (método de decimal.Context)
@anchor{library/decimal decimal Context same_quantum}@anchor{26b3}
@deffn {Método} same_quantum (x, y)

Retorna @code{True} si los dos operandos tienen el mismo exponente.
@end deffn

@geindex scaleb() (método de decimal.Context)
@anchor{library/decimal decimal Context scaleb}@anchor{26b4}
@deffn {Método} scaleb (x, y)

Retorna el primer operando después de agregar el segundo valor a su exponente.
@end deffn

@geindex shift() (método de decimal.Context)
@anchor{library/decimal decimal Context shift}@anchor{26b5}
@deffn {Método} shift (x, y)

Retorna una copia de `x' desplazada `y' veces.
@end deffn

@geindex sqrt() (método de decimal.Context)
@anchor{library/decimal decimal Context sqrt}@anchor{26b6}
@deffn {Método} sqrt (x)

Retorna la raíz cuadrada de un número no negativo para la precisión del contexto.
@end deffn

@geindex subtract() (método de decimal.Context)
@anchor{library/decimal decimal Context subtract}@anchor{26b7}
@deffn {Método} subtract (x, y)

Retorna la diferencia entre `x' e `y'.
@end deffn

@geindex to_eng_string() (método de decimal.Context)
@anchor{library/decimal decimal Context to_eng_string}@anchor{26b8}
@deffn {Método} to_eng_string (x)

Convierte a una cadena de caracteres, usando notación de ingeniería si se necesita un exponente.

La notación de ingeniería tiene como exponente un múltiplo de 3. Esto puede dejar hasta 3 dígitos a la izquierda del punto decimal y puede requerir la adición de uno o dos ceros finales.
@end deffn

@geindex to_integral_exact() (método de decimal.Context)
@anchor{library/decimal decimal Context to_integral_exact}@anchor{26b9}
@deffn {Método} to_integral_exact (x)

Redondea a un entero.
@end deffn

@geindex to_sci_string() (método de decimal.Context)
@anchor{library/decimal decimal Context to_sci_string}@anchor{26ba}
@deffn {Método} to_sci_string (x)

Convierte un número en una cadena de caracteres usando notación científica.
@end deffn
@end deffn

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Constantes<4>,Modos de redondeo,Objetos context,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal constants}@anchor{26bb}@anchor{library/decimal decimal-rounding-modes}@anchor{26bc}
@subsubsection Constantes


Las constantes detalladas en esta sección solo son relevantes para el módulo de C. Se incluyen también en la versión pura de Python por compatibilidad.


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32-bit

@tab

64-bit

@item

@geindex MAX_PREC (en el módulo decimal)
@anchor{library/decimal decimal MAX_PREC}@anchor{267a}
@deffn {Dato} decimal.MAX_PREC
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MAX_EMAX (en el módulo decimal)
@anchor{library/decimal decimal MAX_EMAX}@anchor{267d}
@deffn {Dato} decimal.MAX_EMAX
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MIN_EMIN (en el módulo decimal)
@anchor{library/decimal decimal MIN_EMIN}@anchor{267c}
@deffn {Dato} decimal.MIN_EMIN
@end deffn

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@item

@geindex MIN_ETINY (en el módulo decimal)
@anchor{library/decimal decimal MIN_ETINY}@anchor{26bd}
@deffn {Dato} decimal.MIN_ETINY
@end deffn

@tab

@code{-849999999}

@tab

@code{-1999999999999999997}

@end multitable


@geindex HAVE_THREADS (en el módulo decimal)
@anchor{library/decimal decimal HAVE_THREADS}@anchor{111a}
@deffn {Dato} decimal.HAVE_THREADS

El valor es @code{True}. Está obsoleta, debido ha que Python ahora siempre tiene soporte para hilos.


Obsoleto desde la versión 3.9.

@end deffn

@geindex HAVE_CONTEXTVAR (en el módulo decimal)
@anchor{library/decimal decimal HAVE_CONTEXTVAR}@anchor{1d79}
@deffn {Dato} decimal.HAVE_CONTEXTVAR

El valor predeterminado es @code{True}. Si Python se @ref{1d78,,configura usando --without-decimal-contextvar}, la versión de C usa un contexto de hilos-locales en lugar de un contexto de corrutinas-locales y el valor de la constante es @code{False}. Esto es algo más rápido en algunos escenarios de contexto anidado.


Added in version 3.8.3.

@end deffn

@node Modos de redondeo,Señales,Constantes<4>,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal rounding-modes}@anchor{267b}
@subsubsection Modos de redondeo


@geindex ROUND_CEILING (en el módulo decimal)
@anchor{library/decimal decimal ROUND_CEILING}@anchor{2631}
@deffn {Dato} decimal.ROUND_CEILING

Redondear hacia @code{Infinity}.
@end deffn

@geindex ROUND_DOWN (en el módulo decimal)
@anchor{library/decimal decimal ROUND_DOWN}@anchor{2632}
@deffn {Dato} decimal.ROUND_DOWN

Redondear hacia cero.
@end deffn

@geindex ROUND_FLOOR (en el módulo decimal)
@anchor{library/decimal decimal ROUND_FLOOR}@anchor{2633}
@deffn {Dato} decimal.ROUND_FLOOR

Redondear hacia @code{-Infinity}.
@end deffn

@geindex ROUND_HALF_DOWN (en el módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_DOWN}@anchor{2634}
@deffn {Dato} decimal.ROUND_HALF_DOWN

Redondear al valor contiguo más cercano, con empates hacia cero.
@end deffn

@geindex ROUND_HALF_EVEN (en el módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_EVEN}@anchor{2635}
@deffn {Dato} decimal.ROUND_HALF_EVEN

Redondear al valor contiguo más cercano, con empates al entero par contiguo.
@end deffn

@geindex ROUND_HALF_UP (en el módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_UP}@anchor{2636}
@deffn {Dato} decimal.ROUND_HALF_UP

Redondear al valor contiguo más cercano, con empates alejándose de cero.
@end deffn

@geindex ROUND_UP (en el módulo decimal)
@anchor{library/decimal decimal ROUND_UP}@anchor{2637}
@deffn {Dato} decimal.ROUND_UP

Redondear alejándose de cero.
@end deffn

@geindex ROUND_05UP (en el módulo decimal)
@anchor{library/decimal decimal ROUND_05UP}@anchor{2638}
@deffn {Dato} decimal.ROUND_05UP

Si el último dígito después de redondear hacia cero es 0 ó 5, redondear alejándose de cero, en caso contrario, redondear hacia cero.
@end deffn

@node Señales,Floating-Point Notes,Modos de redondeo,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-signals}@anchor{26be}@anchor{library/decimal signals}@anchor{26bf}
@subsubsection Señales


Las señales representan condiciones que surgen durante el cálculo. Cada una se corresponde con un solo flag de contexto y un habilitador de trampas de contexto.

El flag de contexto se establece siempre que se encuentra la condición. Después del cálculo, los flags pueden comprobarse con fines informativos (por ejemplo, para determinar si un cálculo fue exacto). Después de verificar los flags, asegúrate de borrarlos antes de comenzar con el siguiente cálculo.

Si el habilitador de trampas del contexto está configurado para la señal, entonces la condición hace que se lance una excepción de Python. Por ejemplo, si se establece la trampa @ref{263a,,DivisionByZero}, se genera una excepción @ref{263a,,DivisionByZero} al encontrar la condición.

@geindex Clamped (clase en decimal)
@anchor{library/decimal decimal Clamped}@anchor{2639}
@deffn {Clase} decimal.Clamped

Cambia un exponente para ajustar las restricciones de representación.

Normalmente, la restricción ocurre cuando un exponente cae fuera de los límites @code{Emin} y @code{Emax} del contexto. Si es posible, el exponente se reduce para ajustar agregando ceros al coeficiente.
@end deffn

@geindex DecimalException (clase en decimal)
@anchor{library/decimal decimal DecimalException}@anchor{26c0}
@deffn {Clase} decimal.DecimalException

Clase base para otras señales. Es una subclase de @ref{2289,,ArithmeticError}.
@end deffn

@geindex DivisionByZero (clase en decimal)
@anchor{library/decimal decimal DivisionByZero}@anchor{263a}
@deffn {Clase} decimal.DivisionByZero

Señala la división de un número no infinito entre cero.

Puede ocurrir en la división, en la división modular o al elevar un número a una potencia negativa. Si esta señal no es atrapada, se retorna @code{Infinity} o @code{-Infinity}, con el signo determinado por las entradas del cálculo.
@end deffn

@geindex Inexact (clase en decimal)
@anchor{library/decimal decimal Inexact}@anchor{263b}
@deffn {Clase} decimal.Inexact

Indica que se produjo un redondeo y el resultado no es exacto.

Señala que se descartaron dígitos distintos de cero durante el redondeo. Se retorna el resultado redondeado. El flag o la trampa de señal se utiliza para detectar cuando los resultados son inexactos.
@end deffn

@geindex InvalidOperation (clase en decimal)
@anchor{library/decimal decimal InvalidOperation}@anchor{111f}
@deffn {Clase} decimal.InvalidOperation

Señala que se realizó una operación no válida.

Indica que se solicitó una operación que no tiene lógica. Si esta señal no está atrapada, se retorna @code{NaN}. Las posibles causas incluyen:

@example
Infinity - Infinity
0 * Infinity
Infinity / Infinity
x % 0
Infinity % x
sqrt(-x) and x > 0
0 ** 0
x ** (non-integer)
x ** Infinity
@end example
@end deffn

@geindex Overflow (clase en decimal)
@anchor{library/decimal decimal Overflow}@anchor{263e}
@deffn {Clase} decimal.Overflow

Desbordamiento numérico.

Indica que el exponente es mayor que @code{Context.Emax} después de que se haya producido el redondeo. Si no está atrapada, el resultado depende del modo de redondeo, ya sea tirando hacia adentro hasta el mayor número finito representable o redondeando hacia afuera a @code{Infinity}. En cualquier caso, también se activan las señales @ref{263b,,Inexact} y @ref{263c,,Rounded}.
@end deffn

@geindex Rounded (clase en decimal)
@anchor{library/decimal decimal Rounded}@anchor{263c}
@deffn {Clase} decimal.Rounded

Se produjo un redondeo, aunque posiblemente no hubo pérdida de información.

Señal lanzada cada vez que el redondeo descarta dígitos; incluso si esos dígitos son cero (como al redondear @code{5.00} a @code{5.0}). Si no está atrapada, se retorna el resultado sin cambios. Esta señal se utiliza para detectar la pérdida de dígitos significativos.
@end deffn

@geindex Subnormal (clase en decimal)
@anchor{library/decimal decimal Subnormal}@anchor{263d}
@deffn {Clase} decimal.Subnormal

El exponente antes del redondeo era menor que @code{Emin}.

Ocurre cuando el resultado de una operación es subnormal (el exponente es demasiado pequeño). Si no está atrapada, se retorna el resultado sin cambios.
@end deffn

@geindex Underflow (clase en decimal)
@anchor{library/decimal decimal Underflow}@anchor{263f}
@deffn {Clase} decimal.Underflow

Desbordamiento numérico negativo con resultado redondeado a cero.

Ocurre cuando un resultado subnormal se lleva a cero mediante redondeo. @ref{263b,,Inexact} y @ref{263d,,Subnormal} también se señalan.
@end deffn

@geindex FloatOperation (clase en decimal)
@anchor{library/decimal decimal FloatOperation}@anchor{1119}
@deffn {Clase} decimal.FloatOperation

Habilita una semántica más estricta para mezclar flotantes y objetos Decimal.

Si la señal no está atrapada (predeterminado), se permite mezclar flotantes y objetos Decimal en el constructor de @ref{16a,,Decimal}, en el método @ref{1120,,create_decimal()} y en todos los operadores de comparación. Tanto la conversión como las comparaciones son exactas. Cualquier ocurrencia de una operación mixta se registra silenciosamente estableciendo @ref{1119,,FloatOperation} a los flags del contexto. Las conversiones explícitas usando @ref{1271,,from_float()} o @ref{2681,,create_decimal_from_float()} no establecen el flag.

En caso contrario (la señal está atrapada), solo las comparaciones de igualdad y las conversiones explícitas permanecen silenciadas. Todas las demás operaciones mixtas lanzan una excepción @ref{1119,,FloatOperation}.
@end deffn

La siguiente tabla resume la jerarquía de señales:

@example
exceptions.ArithmeticError(exceptions.Exception)
    DecimalException
        Clamped
        DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
        Inexact
            Overflow(Inexact, Rounded)
            Underflow(Inexact, Rounded, Subnormal)
        InvalidOperation
        Rounded
        Subnormal
        FloatOperation(DecimalException, exceptions.TypeError)
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Floating-Point Notes,Trabajando con hilos,Señales,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-notes}@anchor{26c1}@anchor{library/decimal floating-point-notes}@anchor{26c2}
@subsubsection Floating-Point Notes


@menu
* Mitigación del error de redondeo usando mayor precisión:: 
* Valores especiales:: 

@end menu

@node Mitigación del error de redondeo usando mayor precisión,Valores especiales,,Floating-Point Notes
@anchor{library/decimal mitigating-round-off-error-with-increased-precision}@anchor{26c3}
@subsubsection Mitigación del error de redondeo usando mayor precisión


El uso de la coma flotante decimal elimina el error de representación decimal (haciendo posible representar @code{0.1} de forma exacta). Sin embargo, algunas operaciones aún pueden incurrir en errores de redondeo cuando los dígitos distintos de cero exceden la precisión fija.

The effects of round-off error can be amplified by the addition or subtraction
of nearly offsetting quantities resulting in loss of significance.  Knuth
provides two instructive examples where rounded floating-point arithmetic with
insufficient precision causes the breakdown of the associative and distributive
properties of addition:

@example
# Examples from Seminumerical Algorithms, Section 4.2.2.
>>> from decimal import Decimal, getcontext
>>> getcontext().prec = 8

>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.5111111')
>>> u + (v + w)
Decimal('10')

>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.01')
>>> u * (v+w)
Decimal('0.0060000')
@end example

El módulo @ref{37,,decimal} permite restaurar las identidades ampliando la precisión lo suficiente para evitar la pérdida de significación:

@example
>>> getcontext().prec = 20
>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.51111111')
>>> u + (v + w)
Decimal('9.51111111')
>>>
>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.0060000')
>>> u * (v+w)
Decimal('0.0060000')
@end example

@node Valores especiales,,Mitigación del error de redondeo usando mayor precisión,Floating-Point Notes
@anchor{library/decimal special-values}@anchor{26c4}
@subsubsection Valores especiales


El sistema numérico para el módulo @ref{37,,decimal} proporciona valores especiales que incluyen: @code{NaN}, @code{sNaN}, @code{-Infinity}, @code{Infinity}, y dos ceros, @code{+0} y @code{-0}.

Los infinitos se pueden construir directamente con @code{Decimal('Infinity')}. Además, pueden surgir al dividir entre cero cuando la señal @ref{263a,,DivisionByZero} no es interceptada. Asimismo, cuando la señal @ref{263e,,Overflow} no es interceptada, un infinito puede resultar del redondeo más allá de los límites del mayor número representable.

Los infinitos tienen signo (afín) y se pueden usar en operaciones aritméticas donde se tratan como números muy grandes e indeterminados. Por ejemplo, adicionar una constante a infinito resulta en otro infinito.

Algunas operaciones son indeterminadas y retornan @code{NaN}, o lanzan una excepción si la señal @ref{111f,,InvalidOperation} es atrapada. Por ejemplo, @code{0/0} retorna @code{NaN} que significa «no es un número». Esta variedad de @code{NaN} es silenciosa y, una vez creada, fluirá a través de otros cálculos dando siempre como resultado otro @code{NaN}. Este comportamiento puede ser útil para una serie de cálculos a los que ocasionalmente les faltan entradas, permitiendo que el cálculo continúe mientras se marcan resultados específicos como no válidos.

Una variante es @code{sNaN}, que emite una señal en lugar de permanecer en silencio después de cada operación. Este es un valor de retorno útil cuando un resultado no válido requiere interrumpir un cálculo para un manejo especial.

El comportamiento de los operadores de comparación de Python puede ser un poco sorprendente cuando está involucrado un valor @code{NaN}. Una prueba de igualdad donde uno de los operandos es un @code{NaN} silencioso o señalizador siempre retorna @code{False`} (incluso cuando se hace @code{Decimal('NaN')==Decimal('NaN')}), mientras que una prueba de desigualdad siempre retorna @ref{c95,,True}. Un intento de comparar dos objetos Decimal usando cualquiera de los operadores @code{<}, @code{<=}, @code{>} o @code{>=} lanzará la señal @ref{111f,,InvalidOperation} si alguno de los operandos es @code{NaN}, y retornará @ref{bbf,,False} si esta señal no es capturada. Ten en cuenta que la Especificación General de la Aritmética Decimal no especifica el comportamiento de las comparaciones directas. Estas reglas para las comparaciones que involucran a @code{NaN} se tomaron del estándar IEEE 854 (consulta la Tabla 3 en la sección 5.7). Utiliza en su lugar los métodos @ref{2649,,compare()} y @ref{264a,,compare_signal()} para garantizar el cumplimiento estricto de los estándares.

Los ceros con signo pueden resultar de cálculos que desbordan la precisión establecida. Mantienen el signo que habría resultado si el cálculo se hubiera realizado con mayor precisión. Dado que su magnitud es cero, los ceros positivos y negativos se tratan como iguales y su signo es solo informativo.

In addition to the two signed zeros which are distinct yet equal, there are
various representations of zero with differing precisions yet equivalent in
value.  This takes a bit of getting used to.  For an eye accustomed to
normalized floating-point representations, it is not immediately obvious that
the following calculation returns a value equal to zero:

@example
>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Trabajando con hilos,Casos prácticos,Floating-Point Notes,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-threads}@anchor{26c5}@anchor{library/decimal working-with-threads}@anchor{26c6}
@subsubsection Trabajando con hilos


La función @ref{15cd,,getcontext()} accede a un objeto @ref{1124,,Context} diferente para cada hilo. Tener contextos de hilo separados significa que los hilos pueden realizar cambios (como @code{getcontext().prec=10}) sin interferir con otros hilos.

Asimismo, la función @ref{2642,,setcontext()} asigna automáticamente su objetivo al hilo actual.

Si @ref{2642,,setcontext()} no ha sido invocada antes de @ref{15cd,,getcontext()}, entonces @ref{15cd,,getcontext()} creará automáticamente un nuevo contexto para usar en el hilo actual.

El nuevo contexto es copiado a partir de un contexto prototipo llamado `DefaultContext'. Modifica directamente el objeto `DefaultContext' para controlar los valores predeterminados, de modo que cada hilo utilice los mismos valores en toda la aplicación. Esto debe hacerse `antes' de que se inicien los hilos, para evitar que tenga lugar una condición de carrera entre los mismos al invocar a @ref{15cd,,getcontext()}. Por ejemplo:

@example
# Set applicationwide defaults for all threads about to be launched
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# Afterwards, the threads can be started
t1.start()
t2.start()
t3.start()
 . . .
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Casos prácticos,Preguntas frecuentes sobre decimal,Trabajando con hilos,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-recipes}@anchor{26c7}@anchor{library/decimal recipes}@anchor{26c8}
@subsubsection Casos prácticos


A continuación hay algunos casos prácticos que sirven como funciones de utilidad y que muestran formas de trabajar con la clase @ref{16a,,Decimal}:

@example
def moneyfmt(value, places=2, curr='@w{'}, sep=',', dp='.',
             pos='@w{'}, neg='-', trailneg='@w{'}):
    """Convert Decimal to a money formatted string.

    places:  required number of places after the decimal point
    curr:    optional currency symbol before the sign (may be blank)
    sep:     optional grouping separator (comma, period, space, or blank)
    dp:      decimal point indicator (comma or period)
             only specify as blank when places is zero
    pos:     optional sign for positive numbers: '+', space or blank
    neg:     optional sign for negative numbers: '-', '(', space or blank
    trailneg:optional trailing minus indicator:  '-', ')', space or blank

    >>> d = Decimal('-1234567.8901')
    >>> moneyfmt(d, curr='$')
    '-$1,234,567.89'
    >>> moneyfmt(d, places=0, sep='.', dp='@w{'}, neg='@w{'}, trailneg='-')
    '1.234.568-'
    >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
    '($1,234,567.89)'
    >>> moneyfmt(Decimal(123456789), sep=' ')
    '123 456 789.00'
    >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
    '<0.02>'

    """
    q = Decimal(10) ** -places      # 2 places --> '0.01'
    sign, digits, exp = value.quantize(q).as_tuple()
    result = []
    digits = list(map(str, digits))
    build, next = result.append, digits.pop
    if sign:
        build(trailneg)
    for i in range(places):
        build(next() if digits else '0')
    if places:
        build(dp)
    if not digits:
        build('0')
    i = 0
    while digits:
        build(next())
        i += 1
        if i == 3 and digits:
            i = 0
            build(sep)
    build(curr)
    build(neg if sign else pos)
    return '@w{'}.join(reversed(result))

def pi():
    """Compute Pi to the current precision.

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # extra digits for intermediate steps
    three = Decimal(3)      # substitute "three=3.0" for regular floats
    lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
    while s != lasts:
        lasts = s
        n, na = n+na, na+8
        d, da = d+da, da+32
        t = (t * n) / d
        s += t
    getcontext().prec -= 2
    return +s               # unary plus applies the new precision

def exp(x):
    """Return e raised to the power of x.  Result type matches input type.

    >>> print(exp(Decimal(1)))
    2.718281828459045235360287471
    >>> print(exp(Decimal(2)))
    7.389056098930650227230427461
    >>> print(exp(2.0))
    7.38905609893
    >>> print(exp(2+0j))
    (7.38905609893+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num = 0, 0, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 1
        fact *= i
        num *= x
        s += num / fact
    getcontext().prec -= 2
    return +s

def cos(x):
    """Return the cosine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(cos(Decimal('0.5')))
    0.8775825618903727161162815826
    >>> print(cos(0.5))
    0.87758256189
    >>> print(cos(0.5+0j))
    (0.87758256189+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

def sin(x):
    """Return the sine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(sin(Decimal('0.5')))
    0.4794255386042030002732879352
    >>> print(sin(0.5))
    0.479425538604
    >>> print(sin(0.5+0j))
    (0.479425538604+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Preguntas frecuentes sobre decimal,,Casos prácticos,decimal — Decimal fixed-point and floating-point arithmetic
@anchor{library/decimal decimal-faq}@anchor{26c9}@anchor{library/decimal id1}@anchor{26ca}
@subsubsection Preguntas frecuentes sobre decimal


P. Es engorroso escribir @code{decimal.Decimal('1234.5')}. ¿Hay alguna forma de minimizar la escritura cuando se usa el intérprete interactivo?

R. Algunos usuarios abrevian el constructor a una sola letra:

@example
>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')
@end example

P. En una aplicación de coma fija con dos decimales, algunas entradas tienen muchos dígitos decimales y deben redondearse. En cambio, otras no tienen dígitos en exceso y deben ser validadas. ¿Qué métodos deben utilizarse?

R. El método @ref{1125,,quantize()} redondea a un número fijo de decimales. Si se establece la trampa @ref{263b,,Inexact}, también es útil para la validación:

@example
>>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
@end example

@example
>>> # Round to two places
>>> Decimal('3.214').quantize(TWOPLACES)
Decimal('3.21')
@end example

@example
>>> # Validate that a number does not exceed two places
>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Decimal('3.21')
@end example

@example
>>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Traceback (most recent call last):
   ...
Inexact: None
@end example

P. Si tengo entradas validadas con dos dígitos decimales, ¿cómo mantengo eso invariante en una aplicación?

R. Algunas operaciones como la suma, la resta y la multiplicación por un número entero conservarán automáticamente el punto fijo. Otras operaciones, como la división y la multiplicación de números no enteros, cambiarán el número de lugares decimales y deberá aplicarse @ref{1125,,quantize()} después de ellas:

@example
>>> a = Decimal('102.72')           # Initial fixed-point values
>>> b = Decimal('3.17')
>>> a + b                           # Addition preserves fixed-point
Decimal('105.89')
>>> a - b
Decimal('99.55')
>>> a * 42                          # So does integer multiplication
Decimal('4314.24')
>>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
Decimal('325.62')
>>> (b / a).quantize(TWOPLACES)     # And quantize division
Decimal('0.03')
@end example

Al desarrollar aplicaciones de coma fija, es conveniente definir funciones para gestionar el paso @ref{1125,,quantize()}:

@example
>>> def mul(x, y, fp=TWOPLACES):
...     return (x * y).quantize(fp)
...
>>> def div(x, y, fp=TWOPLACES):
...     return (x / y).quantize(fp)
@end example

@example
>>> mul(a, b)                       # Automatically preserve fixed-point
Decimal('325.62')
>>> div(b, a)
Decimal('0.03')
@end example

P. Hay muchas formas de expresar un mismo valor. Los números @code{200}, @code{200.000}, @code{2E2} y @code{.02E+4} tienen todos el mismo valor pero con varias precisiones. ¿Hay alguna manera de transformarlos en un único valor canónico reconocible?

R. El método @ref{266a,,normalize()} mapea todos los valores equivalentes a un solo representante:

@example
>>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
>>> [v.normalize() for v in values]
[Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]
@end example

P. ¿Cuándo se realiza el redondeo en un cálculo?

R. Se realiza `después' del cálculo. La filosofía de la especificación de decimal es que los números se consideran exactos y se crean independientemente del contexto actual. Pueden incluso tener más precisión que en el contexto actual. Los cálculo se procesan con esas entradas exactas y luego se aplica el redondeo (u otras operaciones de contexto) al `resultado' del cálculo:

@example
>>> getcontext().prec = 5
>>> pi = Decimal('3.1415926535')   # More than 5 digits
>>> pi                             # All digits are retained
Decimal('3.1415926535')
>>> pi + 0                         # Rounded after an addition
Decimal('3.1416')
>>> pi - Decimal('0.00005')        # Subtract unrounded numbers, then round
Decimal('3.1415')
>>> pi + 0 - Decimal('0.00005').   # Intermediate values are rounded
Decimal('3.1416')
@end example

P. Algunos valores decimales siempre se imprimen usando notación exponencial. ¿Hay alguna forma de obtener una representación no exponencial?

R. Para algunos valores, la notación exponencial es la única forma de expresar el número de lugares significativos que tiene el coeficiente. Por ejemplo, expresar @code{5.0E+3} como @code{5000} mantiene el valor constante, pero no puede mostrar la significación de dos lugares que tiene el original.

Si una aplicación no necesita preocuparse por el seguimiento de significación, es fácil eliminar el exponente y los ceros finales, perdiendo significación, pero manteniendo el valor sin cambios:

@example
>>> def remove_exponent(d):
...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
@end example

@example
>>> remove_exponent(Decimal('5E+3'))
Decimal('5000')
@end example

P. ¿Hay alguna forma de convertir un flotante regular en un @ref{16a,,Decimal}?

A. Yes, any binary floating-point number can be exactly expressed as a
Decimal though an exact conversion may take more precision than intuition would
suggest:

@example
>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')
@end example

P. Dentro de un cálculo complejo, cómo puedo asegurarme de que no he obtenido un resultado adulterado debido a una precisión insuficiente o anomalías de redondeo.

R. El módulo decimal facilita la comprobación de resultados. Una buena práctica es volver a ejecutar los cálculos con mayor precisión y con varios modos de redondeo. La obtención de resultados muy dispares indica una precisión insuficiente, problemas relacionados con el modo de redondeo, entradas mal acondicionadas o un algoritmo numéricamente inestable.

P. Noté que la precisión del contexto se aplica a los resultados de las operaciones pero no a las entradas. ¿Hay algo a tener en cuenta al mezclar valores con distintas precisiones?

R. Sí. El principio es que todos los valores se consideran exactos y también lo es la aritmética de esos valores. Solo se redondean los resultados. La ventaja para las entradas es que «lo que escribes es lo que obtienes». Una desventaja es que los resultados pueden parecer extraños si olvidas que las entradas no se han redondeado:

@example
>>> getcontext().prec = 3
>>> Decimal('3.104') + Decimal('2.104')
Decimal('5.21')
>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
Decimal('5.20')
@end example

La solución es aumentar la precisión o forzar el redondeo de las entradas utilizando la operación unaria más:

@example
>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # unary plus triggers rounding
Decimal('1.23')
@end example

Alternativamente, las entradas se pueden redondear en el momento que se crean usando el método @ref{1120,,Context.create_decimal()}:

@example
>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')
@end example

P. ¿La implementación de CPython es rápida para números grandes?

A. Yes.  In the CPython and PyPy3 implementations, the C/CFFI versions of
the decimal module integrate the high speed libmpdec@footnote{https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html} library for
arbitrary precision correctly rounded decimal floating-point arithmetic @footnote{

Added in version 3.3.

}.
@code{libmpdec} uses Karatsuba multiplication@footnote{https://en.wikipedia.org/wiki/Karatsuba_algorithm}
for medium-sized numbers and the Number Theoretic Transform@footnote{https://en.wikipedia.org/wiki/Discrete_Fourier_transform_(general)#Number-theoretic_transform}
for very large numbers.

El contexto debe adaptarse para una aritmética de precisión arbitraria exacta. @code{Emin} y @code{Emax} siempre deben establecerse en sus valores máximos, @code{clamp} siempre debe ser 0 (el valor predeterminado). Establecer @code{prec} requiere cierto cuidado.

El enfoque más fácil para probar la aritmética bignum es usar también el valor máximo para @code{prec} @footnote{

Distinto en la versión 3.9: Este enfoque ahora funciona para todos los resultados exactos excepto para las potencias no enteras. También retro-portado a 3.7 y 3.8.

}:

@example
>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')
@end example

Para resultados inexactos, @ref{267a,,MAX_PREC} es demasiado grande en plataformas de 64 bits y la memoria disponible será insuficiente:

@example
>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError
@end example

En sistemas con sobreasignación (por ejemplo, Linux), un enfoque más sofisticado es establecer @code{prec} a la cantidad de RAM disponible. Supongamos que tenemos 8GB de RAM y esperamos 10 operandos simultáneos usando un máximo de 500 MB cada uno:

@example
>>> import sys
>>>
>>> # Maximum number of digits for a single operand using 500MB in 8-byte words
>>> # with 19 digits per word (4-byte and 9 digits for the 32-bit build):
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # Check that this works:
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # Fill the available precision with nines:
>>> x = Decimal(0).logical_invert() * 9
>>> sys.getsizeof(x)
524288112
>>> x + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  decimal.Inexact: [<class 'decimal.Inexact'>]
@end example

En general (y especialmente en sistemas sin sobreasignación), se recomienda estimar límites aún más estrictos y establecer la trampa @ref{263b,,Inexact} si se espera que todos los cálculos sean exactos.

@node fractions — Rational numbers,random — Generate pseudo-random numbers,decimal — Decimal fixed-point and floating-point arithmetic,Módulos numéricos y matemáticos
@anchor{library/fractions doc}@anchor{26cb}@anchor{library/fractions fractions-rational-numbers}@anchor{26cc}@anchor{library/fractions module-fractions}@anchor{5d}
@subsection @code{fractions} — Rational numbers


@geindex module; fractions

`Source code:' Lib/fractions.py@footnote{https://github.com/python/cpython/tree/main/Lib/fractions.py}


__________________________________________________________________


El módulo @ref{5d,,fractions} provee soporte para aritmética de números racionales.

Una instancia de `Fraction' puede construirse desde dos enteros, desde otro número racional, o desde una cadena de caracteres.

@geindex as_integer_ratio()

@geindex Fraction (clase en fractions)
@anchor{library/fractions fractions Fraction}@anchor{177}
@deffn {Clase} fractions.Fraction (numerator=0, denominator=1)

@deffnx {Clase} fractions.Fraction (number)

@deffnx {Clase} fractions.Fraction (string)

The first version requires that `numerator' and `denominator' are instances
of @ref{132a,,numbers.Rational} and returns a new @ref{177,,Fraction} instance
with value @code{numerator/denominator}. If `denominator' is @code{0}, it
raises a @ref{9d8,,ZeroDivisionError}.

The second version requires that `number' is an instance of
@ref{132a,,numbers.Rational} or has the @code{as_integer_ratio()} method
(this includes @ref{153,,float} and @ref{16a,,decimal.Decimal}).
It returns a @ref{177,,Fraction} instance with exactly the same value.
Assumed, that the @code{as_integer_ratio()} method returns a pair
of coprime integers and last one is positive.
Note that due to the
usual issues with binary point (see @ref{1d17,,Floating-Point Arithmetic; Issues and Limitations}), the
argument to @code{Fraction(1.1)} is not exactly equal to 11/10, and so
@code{Fraction(1.1)} does `not' return @code{Fraction(11, 10)} as one might expect.
(But see the documentation for the @ref{26cd,,limit_denominator()} method below.)

The last version of the constructor expects a string.
The usual form for this instance is:

@example
[sign] numerator ['/' denominator]
@end example

donde el @code{sign} opcional puede ser “+” o “-” y @code{numerator} y @code{denominator} (si están presentes) son cadenas de caracteres de dígitos decimales (guiones bajos se pueden usar para delimitar dígitos como con las integrales literales en el código). Además, cualquier cadena de caracteres que represente un valor finito y sea aceptado por el constructor de @ref{153,,float} también es aceptado por el constructor de @ref{177,,Fraction}. En cualquier caso, la cadena de caracteres de entrada también puede tener espacios en blanco iniciales y / o finales. Aquí hay unos ejemplos:

@example
>>> from fractions import Fraction
>>> Fraction(16, -10)
Fraction(-8, 5)
>>> Fraction(123)
Fraction(123, 1)
>>> Fraction()
Fraction(0, 1)
>>> Fraction('3/7')
Fraction(3, 7)
>>> Fraction(' -3/7 ')
Fraction(-3, 7)
>>> Fraction('1.414213 \t\n')
Fraction(1414213, 1000000)
>>> Fraction('-.125')
Fraction(-1, 8)
>>> Fraction('7e-6')
Fraction(7, 1000000)
>>> Fraction(2.25)
Fraction(9, 4)
>>> Fraction(1.1)
Fraction(2476979795053773, 2251799813685248)
>>> from decimal import Decimal
>>> Fraction(Decimal('1.1'))
Fraction(11, 10)
@end example

The @ref{177,,Fraction} class inherits from the abstract base class
@ref{132a,,numbers.Rational}, and implements all of the methods and
operations from that class.  @ref{177,,Fraction} instances are @ref{6b1,,hashable},
and should be treated as immutable.  In addition,
@ref{177,,Fraction} has the following properties and methods:


Distinto en la versión 3.2: El constructor de @ref{177,,Fraction} ahora acepta instancias de @ref{153,,float} y @ref{37,,decimal}.



Distinto en la versión 3.9: The @ref{9a6,,math.gcd()} function is now used to normalize the `numerator'
and `denominator'. @ref{9a6,,math.gcd()} always returns an @ref{1f0,,int} type.
Previously, the GCD type depended on `numerator' and `denominator'.



Distinto en la versión 3.11: Ahora se permiten guiones bajos al crear una instancia de @ref{177,,Fraction} a partir de una cadena de caracteres, siguiendo las reglas de 
@geindex Python Enhancement Proposals; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}.



Distinto en la versión 3.11: @ref{177,,Fraction} ahora implementa @code{__int__} para satisfacer las comprobaciones de instancia de @code{typing.SupportsInt}.



Distinto en la versión 3.12: Space is allowed around the slash for string inputs: @code{Fraction('2 / 3')}.



Distinto en la versión 3.12: @ref{177,,Fraction} instances now support float-style formatting, with
presentation types @code{"e"}, @code{"E"}, @code{"f"}, @code{"F"}, @code{"g"}, @code{"G"}
and @code{"%""}.



Distinto en la versión 3.13: Formatting of @ref{177,,Fraction} instances without a presentation type
now supports fill, alignment, sign handling, minimum width and grouping.



Distinto en la versión 3.14: The @ref{177,,Fraction} constructor now accepts any objects with the
@code{as_integer_ratio()} method.


@geindex numerator (atributo de fractions.Fraction)
@anchor{library/fractions fractions Fraction numerator}@anchor{26ce}
@deffn {Atributo} numerator

Numerador de la fracción irreducible.
@end deffn

@geindex denominator (atributo de fractions.Fraction)
@anchor{library/fractions fractions Fraction denominator}@anchor{26cf}
@deffn {Atributo} denominator

Denominador de la fracción irreducible.
@end deffn

@geindex as_integer_ratio() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction as_integer_ratio}@anchor{26d0}
@deffn {Método} as_integer_ratio ()

Return a tuple of two integers, whose ratio is equal
to the original Fraction.  The ratio is in lowest terms
and has a positive denominator.


Added in version 3.8.

@end deffn

@geindex is_integer() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction is_integer}@anchor{26d1}
@deffn {Método} is_integer ()

Return @code{True} if the Fraction is an integer.


Added in version 3.12.

@end deffn

@geindex from_float() (método de clase de fractions.Fraction)
@anchor{library/fractions fractions Fraction from_float}@anchor{1272}
@deffn {Método} classmethod from_float (flt)

Constructor alternativo que solo acepta instancias de @ref{153,,float} o @ref{1fbc,,numbers.Integral}. Ten cuidado que @code{Fraction.from_float(0.3)} no es lo mismo  que @code{Fraction(3, 10)}.

@cartouche
@quotation Nota 
Desde Python 3.2 en adelante, puedes construir una instancia @ref{177,,Fraction} directamente desde @ref{153,,float}.
@end quotation
@end cartouche
@end deffn

@geindex from_decimal() (método de clase de fractions.Fraction)
@anchor{library/fractions fractions Fraction from_decimal}@anchor{1273}
@deffn {Método} classmethod from_decimal (dec)

Constructor alternativo que solo acepta instancias de @ref{16a,,decimal.Decimal} o @ref{1fbc,,numbers.Integral}.

@cartouche
@quotation Nota 
Desde Python 3.2 en adelante, puedes construir una instancia @ref{177,,Fraction} directamente desde una instancia @ref{16a,,decimal.Decimal}.
@end quotation
@end cartouche
@end deffn

@geindex from_number() (método de clase de fractions.Fraction)
@anchor{library/fractions fractions Fraction from_number}@anchor{178}
@deffn {Método} classmethod from_number (number)

Alternative constructor which only accepts instances of
@ref{1fbc,,numbers.Integral}, @ref{132a,,numbers.Rational},
@ref{153,,float} or @ref{16a,,decimal.Decimal}, and objects with
the @code{as_integer_ratio()} method, but not strings.


Added in version 3.14.

@end deffn

@geindex limit_denominator() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction limit_denominator}@anchor{26cd}
@deffn {Método} limit_denominator (max_denominator=1000000)

Busca y retorna la instancia de @ref{177,,Fraction} mas cercana a @code{self} que tenga como denominador `max_denominator'. Este método es útil para encontrar aproximaciones racionales a un número en punto flotante determinado:

@example
>>> from fractions import Fraction
>>> Fraction('3.1415926535897932').limit_denominator(1000)
Fraction(355, 113)
@end example

o para recuperar un numero racional que esta representado como flotante:

@example
>>> from math import pi, cos
>>> Fraction(cos(pi/3))
Fraction(4503599627370497, 9007199254740992)
>>> Fraction(cos(pi/3)).limit_denominator()
Fraction(1, 2)
>>> Fraction(1.1).limit_denominator()
Fraction(11, 10)
@end example
@end deffn

@geindex __floor__() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction __floor__}@anchor{178a}
@deffn {Método} __floor__ ()

Retorna el máximo @ref{1f0,,int} @code{<= self}. Este método puede accederse también a través de la función @ref{1401,,math.floor()}:

@example
>>> from math import floor
>>> floor(Fraction(355, 113))
3
@end example
@end deffn

@geindex __ceil__() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction __ceil__}@anchor{1789}
@deffn {Método} __ceil__ ()

Retorna el mínimo @ref{1f0,,int} @code{>= self}. Este método puede accederse también a través de la función @ref{1402,,math.ceil()}.
@end deffn

@geindex __round__() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction __round__}@anchor{1788}
@deffn {Método} __round__ ()

@deffnx {Método} __round__ (ndigits)

La primera versión retorna el valor @ref{1f0,,int} mas cercano a @code{self} redondeando mitades al valor par. La segunda versión redondea @code{self} al múltiplo mas cercano de @code{Fraction(1, 10**ndigits)} (lógicamente, si @code{ndigits} es negativo), nuevamente redondeando mitades al valor par. Este método también puede accederse a través de la función @ref{1342,,round()}.
@end deffn

@geindex __format__() (método de fractions.Fraction)
@anchor{library/fractions fractions Fraction __format__}@anchor{26d2}
@deffn {Método} __format__ (format_spec, /)

Provides support for formatting of @ref{177,,Fraction} instances via the
@ref{6c2,,str.format()} method, the @ref{6c0,,format()} built-in function, or
@ref{a3b,,Formatted string literals}.

If the @code{format_spec} format specification string does not end with one
of the presentation types @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'},
@code{'G'} or @code{'%'} then formatting follows the general rules for fill,
alignment, sign handling, minimum width, and grouping as described in the
@ref{347,,format specification mini-language}. The «alternate
form» flag @code{'#'} is supported: if present, it forces the output string
to always include an explicit denominator, even when the value being
formatted is an exact integer. The zero-fill flag @code{'0'} is not
supported.

If the @code{format_spec} format specification string ends with one of
the presentation types @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'},
@code{'G'} or @code{'%'} then formatting follows the rules outlined for the
@ref{153,,float} type in the @ref{347,,Especificación de formato Mini-Lenguaje} section.

Here are some examples:

@example
>>> from fractions import Fraction
>>> format(Fraction(103993, 33102), '_')
'103_993/33_102'
>>> format(Fraction(1, 7), '.^+10')
'...+1/7...'
>>> format(Fraction(3, 1), '@w{'})
'3'
>>> format(Fraction(3, 1), '#')
'3/1'
>>> format(Fraction(1, 7), '.40g')
'0.1428571428571428571428571428571428571429'
>>> format(Fraction('1234567.855'), '_.2f')
'1_234_567.86'
>>> f"@{Fraction(355, 113):*>20.6e@}"
'********3.141593e+00'
>>> old_price, new_price = 499, 672
>>> "@{:.2%@} price increase".format(Fraction(new_price, old_price) - 1)
'34.67% price increase'
@end example
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{9e,,numbers}

Las clases base abstractas que representan la jerarquía de números.
@end table


@node random — Generate pseudo-random numbers,statistics — Mathematical statistics functions,fractions — Rational numbers,Módulos numéricos y matemáticos
@anchor{library/random doc}@anchor{26d3}@anchor{library/random module-random}@anchor{b8}@anchor{library/random random-generate-pseudo-random-numbers}@anchor{26d4}
@subsection @code{random} — Generate pseudo-random numbers


@geindex module; random

`Código fuente:' Lib/random.py@footnote{https://github.com/python/cpython/tree/main/Lib/random.py}


__________________________________________________________________


Este módulo implementa generadores de números pseudoaleatorios para varias distribuciones.

Para los enteros, existe una selección uniforme dentro de un rango. Para las secuencias, existe una selección uniforme de un elemento aleatorio, una función para generar una permutación aleatoria de una lista `in-situ' y una función para el muestreo aleatorio sin reemplazo.

Para números reales, existen funciones para calcular distribuciones uniformes, normales (Gaussianas), log-normales, exponenciales negativas, gamma y beta. Para generar distribuciones angulares está disponible la distribución de von Mises.

Almost all module functions depend on the basic function @ref{7e3,,random()}, which
generates a random float uniformly in the half-open range @code{0.0 <= X < 1.0}.
Python uses the Mersenne Twister as the core generator.  It produces 53-bit precision
floats and has a period of 2**19937-1.  The underlying implementation in C is
both fast and threadsafe.  The Mersenne Twister is one of the most extensively
tested random number generators in existence.  However, being completely
deterministic, it is not suitable for all purposes, and is completely unsuitable
for cryptographic purposes.

Las funciones proporcionadas por este módulo en realidad son métodos enlazados a instancias ocultas a la clase @ref{18b0,,random.Random}. Puedes instanciar tus propias instancias de @ref{18b0,,Random} para obtener generadores que no compartan estado.

Class @ref{18b0,,Random} can also be subclassed if you want to use a different
basic generator of your own devising: see the documentation on that class for
more details.

El módulo @ref{b8,,random} también proporciona la clase @ref{26d5,,SystemRandom}, la cuál usa la función del sistema @ref{5c6,,os.urandom()} para generar números aleatorios a partir de fuentes proporcionadas por el sistema operativo.

@cartouche
@quotation Advertencia 
Los generadores pseudoaleatorios de este módulo no deben ser utilizados con fines de seguridad. Para usos de seguridad o criptográficos, consulta el módulo @ref{c0,,secrets}.
@end quotation
@end cartouche


@subsubheading Ver también


M. Matsumoto y T. Nishimura, «`Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator'», ACM Transactions on Modeling and Computer Simulation Vol. 8, No. 1, January pp.3–30 1998.

Complementary-Multiply-with-Carry recipe@footnote{https://code.activestate.com/recipes/576707-long-period-random-number-generator/} for a compatible alternative
random number generator with a long period and comparatively simple update
operations.


@cartouche
@quotation Nota 
The global random number generator and instances of @ref{18b0,,Random} are thread-safe.
However, in the free-threaded build, concurrent calls to the global generator or
to the same instance of @ref{18b0,,Random} may encounter contention and poor performance.
Consider using separate instances of @ref{18b0,,Random} per thread instead.
@end quotation
@end cartouche

@menu
* Funciones de contabilidad:: 
* Funciones para los bytes:: 
* Funciones para enteros:: 
* Funciones para secuencias:: 
* Discrete distributions:: 
* Distribuciones para los nombres reales:: 
* Generador alternativo:: 
* Notas sobre la Reproducibilidad:: 
* Ejemplos: Ejemplos<4>. 
* Recetas:: 
* Command-line usage:: 
* Command-line example:: 

@end menu

@node Funciones de contabilidad,Funciones para los bytes,,random — Generate pseudo-random numbers
@anchor{library/random bookkeeping-functions}@anchor{26d6}
@subsubsection Funciones de contabilidad


@geindex seed() (en el módulo random)
@anchor{library/random random seed}@anchor{12e1}
@deffn {Función} random.seed (a=None, version=2)

Inicializa el generador de números aleatorios.

Si `a' es omitida o @code{None}, se utilizará la hora actual del sistema. Si las fuentes de aleatoriedad vienen del sistema operativo, éstas se usarán en vez de la hora del sistema (ver la función @ref{5c6,,os.urandom()} para detalles sobre su disponibilidad).

Si `a' es un entero, se usará directamente.

Con la versión 2 (la versión por defecto), un objeto @ref{237,,str}, @ref{325,,bytes}, o @ref{5e0,,bytearray} se convierte en @ref{1f0,,int} y se usarán todos sus bits.

Con la versión 1 (proporcionada para reproducir secuencias aleatorias desde versiones anteriores de Python), el algoritmo para @ref{237,,str} y @ref{325,,bytes} genera un rango de semillas más estrecho.


Distinto en la versión 3.2: El esquema que usa todos los bits en una semilla de tipo cadena, se ha movido a la versión 2.



Distinto en la versión 3.11: The `seed' must be one of the following types:
@code{None}, @ref{1f0,,int}, @ref{153,,float}, @ref{237,,str},
@ref{325,,bytes}, or @ref{5e0,,bytearray}.

@end deffn

@geindex getstate() (en el módulo random)
@anchor{library/random random getstate}@anchor{26d7}
@deffn {Función} random.getstate ()

Retorna un objeto capturando el estado interno del generador. Este objeto puede pasarse a @ref{26d8,,setstate()} para restaurar su estado.
@end deffn

@geindex setstate() (en el módulo random)
@anchor{library/random random setstate}@anchor{26d8}
@deffn {Función} random.setstate (state)

El `state' debería haberse obtenido de una llamada previa a @ref{26d7,,getstate()}, y @ref{26d8,,setstate()} reestablece el estado interno del generador al que tenia cuando se llamó a la función @ref{26d7,,getstate()}.
@end deffn

@node Funciones para los bytes,Funciones para enteros,Funciones de contabilidad,random — Generate pseudo-random numbers
@anchor{library/random functions-for-bytes}@anchor{26d9}
@subsubsection Funciones para los bytes


@geindex randbytes() (en el módulo random)
@anchor{library/random random randbytes}@anchor{1975}
@deffn {Función} random.randbytes (n)

Genera `n' bytes aleatorios.

Este método no debe utilizarse para generar tokens de seguridad. Utilice @ref{26da,,secrets.token_bytes()} en su lugar.


Added in version 3.9.

@end deffn

@node Funciones para enteros,Funciones para secuencias,Funciones para los bytes,random — Generate pseudo-random numbers
@anchor{library/random functions-for-integers}@anchor{26db}
@subsubsection Funciones para enteros


@geindex randrange() (en el módulo random)
@anchor{library/random random randrange}@anchor{902}
@deffn {Función} random.randrange (stop)

@deffnx {Función} random.randrange (start, stop[, step])

Return a randomly selected element from @code{range(start, stop, step)}.

This is roughly equivalent to @code{choice(range(start, stop, step))} but
supports arbitrarily large ranges and is optimized for common cases.

The positional argument pattern matches the @ref{9d6,,range()} function.

Keyword arguments should not be used because they can be interpreted
in unexpected ways. For example @code{randrange(start=100)} is interpreted
as @code{randrange(0, 100, 1)}.


Distinto en la versión 3.2: @ref{902,,randrange()} es más sofisticado produciendo valores igualmente distribuidos. Anteriormente utilizaba un estilo como @code{int(random()*n)} el cual puede producir distribuciones ligeramente desiguales.



Distinto en la versión 3.12: Automatic conversion of non-integer types is no longer supported.
Calls such as @code{randrange(10.0)} and @code{randrange(Fraction(10, 1))}
now raise a @ref{228,,TypeError}.

@end deffn

@geindex randint() (en el módulo random)
@anchor{library/random random randint}@anchor{129c}
@deffn {Función} random.randint (a, b)

Retorna un entero aleatorio `N' tal que @code{a <= N <= b}. Alias de @code{randrange(a, b+1)}.
@end deffn

@geindex getrandbits() (en el módulo random)
@anchor{library/random random getrandbits}@anchor{1089}
@deffn {Función} random.getrandbits (k)

Returns a non-negative Python integer with `k' random bits. This method
is supplied with the Mersenne Twister generator and some other generators
may also provide it as an optional part of the API. When available,
@ref{1089,,getrandbits()} enables @ref{902,,randrange()} to handle arbitrarily large
ranges.


Distinto en la versión 3.9: Este método ahora acepta cero para `k'.

@end deffn

@node Funciones para secuencias,Discrete distributions,Funciones para enteros,random — Generate pseudo-random numbers
@anchor{library/random functions-for-sequences}@anchor{26dc}
@subsubsection Funciones para secuencias


@geindex choice() (en el módulo random)
@anchor{library/random random choice}@anchor{129d}
@deffn {Función} random.choice (seq)

Retorna un elemento aleatorio de una secuencia `seq' no vacía. Si `seq' está vacía, lanza @ref{1575,,IndexError}.
@end deffn

@geindex choices() (en el módulo random)
@anchor{library/random random choices}@anchor{d4d}
@deffn {Función} random.choices (population, weights=None, *, cum_weights=None, k=1)

Retorna una lista de elementos de tamaño `k' elegidos de la `population' con reemplazo. Si la `population' está vacía, lanza @ref{1575,,IndexError}.

Si se especifica una secuencia `weights', las selecciones se realizan de acuerdo con las ponderaciones relativas. Alternativamente, si se da una secuencia `cum_weights', las selecciones se harán según los pesos cumulativos (posiblemente se calculen usando @ref{a8f,,itertools.accumulate()}). Por ejemplo, los pesos relativos @code{[10, 5, 30, 5]} son equivalentes a los pesos cumulativos @code{[10, 15, 45, 50]}. Internamente, los pesos relativos se convierten en pesos cumulativos antes de hacer selecciones, por lo cual suplir los pesos cumulativos ahorra trabajo.

Si ni `weights' ni `cum_weights' están especificadas, las selecciones se realizan con la misma probabilidad. Si se proporciona una secuencia de ponderaciones, debe tener la misma longitud que la secuencia `population'. Es un @ref{228,,TypeError} especificar ambas `weights' y `cum_weights'.

Los `weights' o los `cum_weights' pueden utilizar cualquier tipo numérico que interactúe con los valores @ref{153,,float} retornados por @ref{b8,,random()} (eso incluye enteros, flotantes y fracciones pero excluye decimales). Se asume que los pesos son no negativos y finitos.  Se lanza un @ref{360,,ValueError} si todos los pesos son cero.

For a given seed, the @ref{d4d,,choices()} function with equal weighting
typically produces a different sequence than repeated calls to
@ref{129d,,choice()}.  The algorithm used by @ref{d4d,,choices()} uses floating-point
arithmetic for internal consistency and speed.  The algorithm used
by @ref{129d,,choice()} defaults to integer arithmetic with repeated selections
to avoid small biases from round-off error.


Added in version 3.6.



Distinto en la versión 3.9: Genera un @ref{360,,ValueError} si todos los pesos son cero.

@end deffn

@geindex shuffle() (en el módulo random)
@anchor{library/random random shuffle}@anchor{7e2}
@deffn {Función} random.shuffle (x)

Mezcla la secuencia `x' in-situ.

Para mezclar una secuencia inmutable y retornar una nueva lista mezclada, utilice @code{muestra(x, k=len(x))} en su lugar.

Tenga en cuenta que incluso para pequeños @code{len(x)}, el número total de permutaciones de `x' puede crecer rápidamente más que el periodo de muchos generadores de números aleatorios. Esto implica que la mayoría de las permutaciones de una secuencia larga nunca se pueden generar. Por ejemplo, una secuencia de longitud 2080 es la más grande que cabe dentro del período del generador de números aleatorios de Mersenne Twister.


Distinto en la versión 3.11: Removed the optional parameter `random'.

@end deffn

@geindex sample() (en el módulo random)
@anchor{library/random random sample}@anchor{7e1}
@deffn {Función} random.sample (population, k, *, counts=None)

Return a `k' length list of unique elements chosen from the population
sequence.  Used for random sampling without replacement.

Retorna una nueva lista que contiene elementos de la población sin modificar la población original. La lista resultante está en orden de selección de forma que todos los subsectores también son muestras aleatorias válidas. Esto permite que los ganadores de la rifa (la muestra) se dividan en primer premio y ganadores del segundo lugar (los subsectores).

Los miembros de la población no tienen porqué ser @ref{6b1,,hashable} o únicos. Si la población incluye repeticiones, entonces cada ocurrencia es una posible selección en la muestra.

Los elementos repetidos pueden especificarse de uno en uno o con el parámetro opcional `counts', que es una palabra clave.  Por ejemplo, @code{sample(['red', 'blue'], counts=[4, 2], k=5)} es equivalente a @code{sample(['red', 'red', 'red', 'red', 'blue', 'blue'], k=5)}.

Para escoger una muestra de un rango de enteros, use un objeto @ref{9d6,,range()} como argumento. Esto es especialmente rápido y eficiente en espacio para el muestreo de poblaciones grandes: @code{sample(range(10000000), k=60)}.

Si el tamaño de la muestra es mayor que el tamaño de la población, se lanzará un @ref{360,,ValueError}.


Distinto en la versión 3.9: Se añadió el parámetro `counts'.



Distinto en la versión 3.11: La población debe ser una secuencia. La conversión automática de sets a listas ya no es compatible.

@end deffn

@node Discrete distributions,Distribuciones para los nombres reales,Funciones para secuencias,random — Generate pseudo-random numbers
@anchor{library/random discrete-distributions}@anchor{26dd}
@subsubsection Discrete distributions


The following function generates a discrete distribution.

@geindex binomialvariate() (en el módulo random)
@anchor{library/random random binomialvariate}@anchor{557}
@deffn {Función} random.binomialvariate (n=1, p=0.5)

Binomial distribution@footnote{https://mathworld.wolfram.com/BinomialDistribution.html}.
Return the number of successes for `n' independent trials with the
probability of success in each trial being `p':

Mathematically equivalent to:

@example
sum(random() < p for i in range(n))
@end example

The number of trials `n' should be a non-negative integer.
The probability of success `p' should be between @code{0.0 <= p <= 1.0}.
The result is an integer in the range @code{0 <= X <= n}.


Added in version 3.12.

@end deffn

@node Distribuciones para los nombres reales,Generador alternativo,Discrete distributions,random — Generate pseudo-random numbers
@anchor{library/random id1}@anchor{26de}@anchor{library/random real-valued-distributions}@anchor{26df}
@subsubsection Distribuciones para los nombres reales


Las siguientes funciones generan distribuciones específicas para números reales. Los parámetros de la función reciben el nombre de las variables correspondientes en la ecuación de distribución, tal y como se utilizan en la práctica matemática común.; la mayoría de estas ecuaciones se pueden encontrar en cualquier texto estadístico.

@geindex random() (en el módulo random)
@anchor{library/random random random}@anchor{7e3}
@deffn {Función} random.random ()

Return the next random floating-point number in the range @code{0.0 <= X < 1.0}
@end deffn

@geindex uniform() (en el módulo random)
@anchor{library/random random uniform}@anchor{26e0}
@deffn {Función} random.uniform (a, b)

Return a random floating-point number `N' such that @code{a <= N <= b} for
@code{a <= b} and @code{b <= N <= a} for @code{b < a}.

The end-point value @code{b} may or may not be included in the range
depending on floating-point rounding in the expression
@code{a + (b-a) * random()}.
@end deffn

@geindex triangular() (en el módulo random)
@anchor{library/random random triangular}@anchor{26e1}
@deffn {Función} random.triangular (low, high, mode)

Return a random floating-point number `N' such that @code{low <= N <= high} and
with the specified `mode' between those bounds.  The `low' and `high' bounds
default to zero and one.  The `mode' argument defaults to the midpoint
between the bounds, giving a symmetric distribution.
@end deffn

@geindex betavariate() (en el módulo random)
@anchor{library/random random betavariate}@anchor{26e2}
@deffn {Función} random.betavariate (alpha, beta)

Distribución beta. Las condiciones de los parámetros son @code{alpha > 0} y @code{beta > 0}. Retorna valores dentro del rango entre 0 y 1.
@end deffn

@geindex expovariate() (en el módulo random)
@anchor{library/random random expovariate}@anchor{558}
@deffn {Función} random.expovariate (lambd=1.0)

Distribución exponencial. `lambd' es 1.0 dividido entre la media deseada. Debe ser distinto a cero (El parámetro debería llamarse @code{lambda} pero esa es una palabra reservada en Python). Retorna valores dentro del rango de 0 a infinito positivo si `lambd' es positivo, y de infinito negativo a 0 si `lambd' es negativo.


Distinto en la versión 3.12: Added the default value for @code{lambd}.

@end deffn

@geindex gammavariate() (en el módulo random)
@anchor{library/random random gammavariate}@anchor{26e3}
@deffn {Función} random.gammavariate (alpha, beta)

Gamma distribution.  (`Not' the gamma function!)  The shape and
scale parameters, `alpha' and `beta', must have positive values.
(Calling conventions vary and some sources define “beta”
as the inverse of the scale).

La función de distribución de la probabilidad es:

@example
          x ** (alpha - 1) * math.exp(-x / beta)
pdf(x) =  --------------------------------------
            math.gamma(alpha) * beta ** alpha
@end example
@end deffn

@geindex gauss() (en el módulo random)
@anchor{library/random random gauss}@anchor{1848}
@deffn {Función} random.gauss (mu=0.0, sigma=1.0)

Normal distribution, also called the Gaussian distribution.
`mu' is the mean,
and `sigma' is the standard deviation.  This is slightly faster than
the @ref{1849,,normalvariate()} function defined below.

Nota sobre el multithreading: Cuando dos hilos llaman a esta función simultáneamente, es posible que reciban el mismo valor de retorno.  Esto se puede evitar de tres maneras. 1) Hacer que cada hilo utilice una instancia diferente del generador de números aleatorios. 2) Poner bloqueos alrededor de todas las llamadas. 3) Utilizar la función @ref{1849,,normalvariate()}, más lenta pero segura para los hilos, en su lugar.


Distinto en la versión 3.11: `mu' y `sigma' ahora tienen argumentos predeterminados.

@end deffn

@geindex lognormvariate() (en el módulo random)
@anchor{library/random random lognormvariate}@anchor{26e4}
@deffn {Función} random.lognormvariate (mu, sigma)

Logaritmo de la distribución normal. Si se usa un logaritmo natural de esta distribución, se obtendrá una distribución normal con media `mu' y desviación estándar `sigma'. `mu' puede tener cualquier valor, y `sigma' debe ser mayor que cero.
@end deffn

@geindex normalvariate() (en el módulo random)
@anchor{library/random random normalvariate}@anchor{1849}
@deffn {Función} random.normalvariate (mu=0.0, sigma=1.0)

Distribución normal. `mu' es la media y `sigma' es la desviación estándar.


Distinto en la versión 3.11: `mu' y `sigma' ahora tienen argumentos predeterminados.

@end deffn

@geindex vonmisesvariate() (en el módulo random)
@anchor{library/random random vonmisesvariate}@anchor{26e5}
@deffn {Función} random.vonmisesvariate (mu, kappa)

`mu' es el ángulo medio, expresado en radiantes entre 0 y 2*`pi', y `kappa' es el parámetro de concentración, que debe ser mayor o igual a cero. Si `kappa' es igual a cero, esta distribución se reduce a un ángulo aleatorio uniforme sobre el rango de 0 a 2*`pi'.
@end deffn

@geindex paretovariate() (en el módulo random)
@anchor{library/random random paretovariate}@anchor{26e6}
@deffn {Función} random.paretovariate (alpha)

Distribución de Pareto. `alpha' es el parámetro de forma.
@end deffn

@geindex weibullvariate() (en el módulo random)
@anchor{library/random random weibullvariate}@anchor{26e7}
@deffn {Función} random.weibullvariate (alpha, beta)

Distribución de Weibull. `alpha' es el parámetro de escala y `beta' es el parámetro de forma.
@end deffn

@node Generador alternativo,Notas sobre la Reproducibilidad,Distribuciones para los nombres reales,random — Generate pseudo-random numbers
@anchor{library/random alternative-generator}@anchor{26e8}
@subsubsection Generador alternativo


@geindex Random (clase en random)
@anchor{library/random random Random}@anchor{18b0}
@deffn {Clase} random.Random ([seed])

Esta clase implementa el generador de números pseudoaleatorios predeterminado que usa el módulo @ref{b8,,random} .


Distinto en la versión 3.11: Formerly the `seed' could be any hashable object.  Now it is limited to:
@code{None}, @ref{1f0,,int}, @ref{153,,float}, @ref{237,,str},
@ref{325,,bytes}, or @ref{5e0,,bytearray}.


Subclasses of @code{Random} should override the following methods if they
wish to make use of a different basic generator:

@geindex seed() (método de random.Random)
@anchor{library/random random Random seed}@anchor{198a}
@deffn {Método} seed (a=None, version=2)

Override this method in subclasses to customise the @ref{12e1,,seed()}
behaviour of @code{Random} instances.
@end deffn

@geindex getstate() (método de random.Random)
@anchor{library/random random Random getstate}@anchor{26e9}
@deffn {Método} getstate ()

Override this method in subclasses to customise the @ref{26d7,,getstate()}
behaviour of @code{Random} instances.
@end deffn

@geindex setstate() (método de random.Random)
@anchor{library/random random Random setstate}@anchor{26ea}
@deffn {Método} setstate (state)

Override this method in subclasses to customise the @ref{26d8,,setstate()}
behaviour of @code{Random} instances.
@end deffn

@geindex random() (método de random.Random)
@anchor{library/random random Random random}@anchor{26eb}
@deffn {Método} random ()

Override this method in subclasses to customise the @ref{7e3,,random()}
behaviour of @code{Random} instances.
@end deffn

Optionally, a custom generator subclass can also supply the following method:

@geindex getrandbits() (método de random.Random)
@anchor{library/random random Random getrandbits}@anchor{26ec}
@deffn {Método} getrandbits (k)

Override this method in subclasses to customise the
@ref{1089,,getrandbits()} behaviour of @code{Random} instances.
@end deffn
@end deffn

@geindex SystemRandom (clase en random)
@anchor{library/random random SystemRandom}@anchor{26d5}
@deffn {Clase} random.SystemRandom ([seed])

Clase que utiliza la función @ref{5c6,,os.urandom()} para generar números aleatorios a partir de fuentes proporcionadas por el sistema operativo. No está disponible en todos los sistemas. No se basa en el estado del software y las secuencias no son reproducibles. En consecuencia, el método @ref{12e1,,seed()} no tiene efecto y es ignorado. Los métodos @ref{26d7,,getstate()} y @ref{26d8,,setstate()} lanzan @ref{384,,NotImplementedError} si se les llama.
@end deffn

@node Notas sobre la Reproducibilidad,Ejemplos<4>,Generador alternativo,random — Generate pseudo-random numbers
@anchor{library/random notes-on-reproducibility}@anchor{26ed}
@subsubsection Notas sobre la Reproducibilidad


Sometimes it is useful to be able to reproduce the sequences given by a
pseudo-random number generator.  By reusing a seed value, the same sequence should be
reproducible from run to run as long as multiple threads are not running.

Muchos de los algoritmos y de las funciones de generación de semillas del módulo aleatorio pueden cambiar entre versiones de Python, pero se garantiza que dos aspectos no cambien:


@itemize *

@item 
Si se añade un nuevo método de generación de semilla, se ofrecerá un generador de semilla retrocompatible.

@item 
El método generador @ref{26eb,,random()} continuará produciendo la misma secuencia cuando se le da la misma semilla al generador de semilla compatible.
@end itemize

@node Ejemplos<4>,Recetas,Notas sobre la Reproducibilidad,random — Generate pseudo-random numbers
@anchor{library/random examples}@anchor{26ee}@anchor{library/random random-examples}@anchor{1249}
@subsubsection Ejemplos


Ejemplos básicos:

@example
>>> random()                          # Random float:  0.0 <= x < 1.0
0.37444887175646646

>>> uniform(2.5, 10.0)                # Random float:  2.5 <= x <= 10.0
3.1800146073117523

>>> expovariate(1 / 5)                # Interval between arrivals averaging 5 seconds
5.148957571865031

>>> randrange(10)                     # Integer from 0 to 9 inclusive
7

>>> randrange(0, 101, 2)              # Even integer from 0 to 100 inclusive
26

>>> choice(['win', 'lose', 'draw'])   # Single random element from a sequence
'draw'

>>> deck = 'ace two three four'.split()
>>> shuffle(deck)                     # Shuffle a list
>>> deck
['four', 'two', 'ace', 'three']

>>> sample([10, 20, 30, 40, 50], k=4) # Four samples without replacement
[40, 10, 50, 30]
@end example

Simulaciones:

@example
>>> # Six roulette wheel spins (weighted sampling with replacement)
>>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
['red', 'green', 'black', 'black', 'red', 'black']

>>> # Deal 20 cards without replacement from a deck
>>> # of 52 playing cards, and determine the proportion of cards
>>> # with a ten-value:  ten, jack, queen, or king.
>>> deal = sample(['tens', 'low cards'], counts=[16, 36], k=20)
>>> deal.count('tens') / 20
0.15

>>> # Estimate the probability of getting 5 or more heads from 7 spins
>>> # of a biased coin that settles on heads 60% of the time.
>>> sum(binomialvariate(n=7, p=0.6) >= 5 for i in range(10_000)) / 10_000
0.4169

>>> # Probability of the median of 5 samples being in middle two quartiles
>>> def trial():
...     return 2_500 <= sorted(choices(range(10_000), k=5))[2] < 7_500
...
>>> sum(trial() for i in range(10_000)) / 10_000
0.7958
@end example

Ejemplo de statistical bootstrapping@footnote{https://en.wikipedia.org/wiki/Bootstrapping_(statistics)} utilizando el remuestreo con reemplazo para estimar un intervalo de confianza para la media de una muestra:

@example
# https://www.thoughtco.com/example-of-bootstrapping-3126155
from statistics import fmean as mean
from random import choices

data = [41, 50, 29, 37, 81, 30, 73, 63, 20, 35, 68, 22, 60, 31, 95]
means = sorted(mean(choices(data, k=len(data))) for i in range(100))
print(f'The sample mean of @{mean(data):.1f@} has a 90% confidence '
      f'interval from @{means[5]:.1f@} to @{means[94]:.1f@}')
@end example

Ejemplo de un test de permutación en remuestreo (en)@footnote{https://en.wikipedia.org/wiki/Resampling_(statistics)#Permutation_tests} para determinar la significación estadística o p-valor@footnote{https://es.wikipedia.org/wiki/Valor_p} de una diferencia observada entre los efectos de un fármaco y un placebo:

@example
# Example from "Statistics is Easy" by Dennis Shasha and Manda Wilson
from statistics import fmean as mean
from random import shuffle

drug = [54, 73, 53, 70, 73, 68, 52, 65, 65]
placebo = [54, 51, 58, 44, 55, 52, 42, 47, 58, 46]
observed_diff = mean(drug) - mean(placebo)

n = 10_000
count = 0
combined = drug + placebo
for i in range(n):
    shuffle(combined)
    new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):])
    count += (new_diff >= observed_diff)

print(f'@{n@} label reshufflings produced only @{count@} instances with a difference')
print(f'at least as extreme as the observed difference of @{observed_diff:.1f@}.')
print(f'The one-sided p-value of @{count / n:.4f@} leads us to reject the null')
print(f'hypothesis that there is no difference between the drug and the placebo.')
@end example

Simulación de tiempos de llegada y entrega de servicios para una cola de múltiples servidores:

@example
from heapq import heapify, heapreplace
from random import expovariate, gauss
from statistics import mean, quantiles

average_arrival_interval = 5.6
average_service_time = 15.0
stdev_service_time = 3.5
num_servers = 3

waits = []
arrival_time = 0.0
servers = [0.0] * num_servers  # time when each server becomes available
heapify(servers)
for i in range(1_000_000):
    arrival_time += expovariate(1.0 / average_arrival_interval)
    next_server_available = servers[0]
    wait = max(0.0, next_server_available - arrival_time)
    waits.append(wait)
    service_duration = max(0.0, gauss(average_service_time, stdev_service_time))
    service_completed = arrival_time + wait + service_duration
    heapreplace(servers, service_completed)

print(f'Mean wait: @{mean(waits):.1f@}   Max wait: @{max(waits):.1f@}')
print('Quartiles:', [round(q, 1) for q in quantiles(waits)])
@end example


@subsubheading Ver también


*Statistics for Hackers*@footnote{https://www.youtube.com/watch?v=Iq9DzN6mvYA} un video tutorial de Jake Vanderplas@footnote{https://us.pycon.org/2016/speaker/profile/295/} sobre análisis estadístico usando sólo algunos conceptos fundamentales incluyendo simulación, muestreo, baraja y validación cruzada.

Economics Simulation@footnote{https://nbviewer.org/url/norvig.com/ipython/Economics.ipynb}
a simulation of a marketplace by
Peter Norvig@footnote{https://norvig.com/bio.html} that shows effective
use of many of the tools and distributions provided by this module
(gauss, uniform, sample, betavariate, choice, triangular, and randrange).

A Concrete Introduction to Probability (using Python)@footnote{https://nbviewer.org/url/norvig.com/ipython/Probability.ipynb}
a tutorial by Peter Norvig@footnote{https://norvig.com/bio.html} covering
the basics of probability theory, how to write simulations, and
how to perform data analysis using Python.


@node Recetas,Command-line usage,Ejemplos<4>,random — Generate pseudo-random numbers
@anchor{library/random recipes}@anchor{26ef}
@subsubsection Recetas


Estas recetas muestran cómo hacer de manera eficiente selecciones aleatorias de los iteradores combinatorios en el módulo @ref{81,,itertools}:

@example
def random_product(*args, repeat=1):
    "Random selection from itertools.product(*args, **kwds)"
    pools = [tuple(pool) for pool in args] * repeat
    return tuple(map(random.choice, pools))

def random_permutation(iterable, r=None):
    "Random selection from itertools.permutations(iterable, r)"
    pool = tuple(iterable)
    r = len(pool) if r is None else r
    return tuple(random.sample(pool, r))

def random_combination(iterable, r):
    "Random selection from itertools.combinations(iterable, r)"
    pool = tuple(iterable)
    n = len(pool)
    indices = sorted(random.sample(range(n), r))
    return tuple(pool[i] for i in indices)

def random_combination_with_replacement(iterable, r):
    "Choose r elements with replacement.  Order the result to match the iterable."
    # Result will be in set(itertools.combinations_with_replacement(iterable, r)).
    pool = tuple(iterable)
    n = len(pool)
    indices = sorted(random.choices(range(n), k=r))
    return tuple(pool[i] for i in indices)
@end example

La función @ref{7e3,,random()} por defecto devuelve múltiplos de 2⁻⁵³ en el rango `0.0 ≤ x < 1.0'.  Todos estos números están espaciados uniformemente y son representables exactamente como flotantes de Python.  Sin embargo, muchos otros flotadores representables en ese intervalo no son selecciones posibles.  Por ejemplo, @code{0.05954861408025609} no es un múltiplo entero de 2⁻⁵³.

La siguiente receta adopta un enfoque diferente.  Todos los flotantes en el intervalo son selecciones posibles.  La mantisa proviene de una distribución uniforme de enteros en el rango `2⁵² ≤ mantisa < 2⁵³'.  El exponente proviene de una distribución geométrica en la que los exponentes menores de `-53' ocurren con la mitad de frecuencia que el siguiente exponente mayor.

@example
from random import Random
from math import ldexp

class FullRandom(Random):

    def random(self):
        mantissa = 0x10_0000_0000_0000 | self.getrandbits(52)
        exponent = -53
        x = 0
        while not x:
            x = self.getrandbits(32)
            exponent += x.bit_length() - 32
        return ldexp(mantissa, exponent)
@end example

Todas las @ref{26df,,distribuciones de valor real} de la clase utilizarán el nuevo método:

@example
>>> fr = FullRandom()
>>> fr.random()
0.05954861408025609
>>> fr.expovariate(0.25)
8.87925541791544
@end example

La receta es conceptualmente equivalente a un algoritmo que elige entre todos los múltiplos de 2⁻¹⁰⁷⁴ en el rango `0,0 ≤ x < 1,0'.  Todos esos números son uniformes, pero la mayoría tienen que ser redondeados al flotante de Python representable más cercano.  (El valor 2⁻¹⁰⁷⁴ es el menor flotante positivo no normalizado y es igual a @code{math.ulp(0.0)}.)


@subsubheading Ver también


Generating Pseudo-random Floating-Point Values@footnote{https://allendowney.com/research/rand/downey07randfloat.pdf} un artículo de Allen B. Downey en el que se describen formas de generar flotantes más refinados que los generados normalmente por @ref{7e3,,random()}.


@node Command-line usage,Command-line example,Recetas,random — Generate pseudo-random numbers
@anchor{library/random command-line-usage}@anchor{26f0}@anchor{library/random random-cli}@anchor{2c0}
@subsubsection Command-line usage



Added in version 3.13.


The @code{random} module can be executed from the command line.

@example
python -m random [-h] [-c CHOICE [CHOICE ...] | -i N | -f N] [input ...]
@end example

The following options are accepted:

@geindex opción de línea de comando random; -h
@geindex opción de línea de comando random; --help
@anchor{library/random cmdoption-random-h}@anchor{26f1}@anchor{library/random cmdoption-random-help}@anchor{26f2}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Show the help message and exit.
@end deffn

@geindex opción de línea de comando random; -c
@geindex opción de línea de comando random; --choice
@anchor{library/random cmdoption-random-c}@anchor{26f3}
@deffn {Option} @w{-}c CHOICE [CHOICE ...]
@anchor{library/random cmdoption-random-choice}@anchor{26f4}
@deffnx {Option} @w{-}@w{-}choice CHOICE [CHOICE ...]

Print a random choice, using @ref{129d,,choice()}.
@end deffn

@geindex opción de línea de comando random; -i
@geindex opción de línea de comando random; --integer
@anchor{library/random cmdoption-random-i}@anchor{26f5}
@deffn {Option} @w{-}i <N>
@anchor{library/random cmdoption-random-integer}@anchor{26f6}
@deffnx {Option} @w{-}@w{-}integer <N>

Print a random integer between 1 and N inclusive, using @ref{129c,,randint()}.
@end deffn

@geindex opción de línea de comando random; -f
@geindex opción de línea de comando random; --float
@anchor{library/random cmdoption-random-f}@anchor{26f7}
@deffn {Option} @w{-}f <N>
@anchor{library/random cmdoption-random-float}@anchor{26f8}
@deffnx {Option} @w{-}@w{-}float <N>

Print a random floating-point number between 0 and N inclusive,
using @ref{26e0,,uniform()}.
@end deffn

If no options are given, the output depends on the input:


@itemize *

@item 
String or multiple: same as @ref{26f4,,--choice}.

@item 
Integer: same as @ref{26f6,,--integer}.

@item 
Float: same as @ref{26f8,,--float}.
@end itemize

@node Command-line example,,Command-line usage,random — Generate pseudo-random numbers
@anchor{library/random command-line-example}@anchor{26f9}@anchor{library/random random-cli-example}@anchor{26fa}
@subsubsection Command-line example


Here are some examples of the @code{random} command-line interface:

@example
$ # Choose one at random
$ python -m random egg bacon sausage spam "Lobster Thermidor aux crevettes with a Mornay sauce"
Lobster Thermidor aux crevettes with a Mornay sauce

$ # Random integer
$ python -m random 6
6

$ # Random floating-point number
$ python -m random 1.8
1.7080016272295635

$ # With explicit arguments
$ python  -m random --choice egg bacon sausage spam "Lobster Thermidor aux crevettes with a Mornay sauce"
egg

$ python -m random --integer 6
3

$ python -m random --float 1.8
1.5666339105010318

$ python -m random --integer 6
5

$ python -m random --float 6
3.1942323316565915
@end example

@node statistics — Mathematical statistics functions,,random — Generate pseudo-random numbers,Módulos numéricos y matemáticos
@anchor{library/statistics doc}@anchor{26fb}@anchor{library/statistics module-statistics}@anchor{d2}@anchor{library/statistics statistics-mathematical-statistics-functions}@anchor{26fc}
@subsection @code{statistics} — Mathematical statistics functions


@geindex module; statistics


Added in version 3.4.


`Código fuente:' Lib/statistics.py@footnote{https://github.com/python/cpython/tree/main/Lib/statistics.py}

@c from statistics import *
@c import math
@c __name__ = '<doctest>'


__________________________________________________________________


Este módulo proporciona funciones para calcular estadísticas matemáticas de datos numéricos (de tipo @ref{219e,,Real}).

Este módulo no pretende ser competidor o sustituto de bibliotecas de terceros como NumPy@footnote{https://numpy.org} o SciPy@footnote{https://scipy.org/}, ni de paquetes completos de software propietario para estadistas profesionales como Minitab, SAS o Matlab. Este módulo se ubica a nivel de calculadoras científicas y gráficas.

A menos que se indique explícitamente lo contrario, las funciones de este módulo manejan objetos @ref{1f0,,int}, @ref{153,,float}, @ref{16a,,Decimal} y @ref{177,,Fraction}. No se garantiza un correcto funcionamiento con otros tipos (numéricos o no). El comportamiento de estas funciones con colecciones mixtas que contengan objetos de diferente tipo no está definido y depende de la implementación. Si tus datos de entrada consisten en una mezcla de varios tipos, puedes usar @ref{14c,,map()} para asegurarte de que el resultado sea consistente, por ejemplo: @code{map(float, input_data)}.

Algunos conjuntos de datos utilizan valores @code{NaN} (no es un número) para representar los datos que faltan. Dado que los valores NaN tienen una semántica de comparación inusual, provocan comportamientos sorprendentes o indefinidos en las funciones estadísticas que ordenan los datos o que cuentan las ocurrencias.  Las funciones afectadas son @code{median()}, @code{median_low()}, @code{median_high()}, @code{median_grouped()}, @code{mode()}, @code{multimode()}, y @code{quantiles()}.  Los valores @code{NaN} deben eliminarse antes de llamar a estas funciones:

@example
>>> from statistics import median
>>> from math import isnan
>>> from itertools import filterfalse

>>> data = [20.7, float('NaN'),19.2, 18.3, float('NaN'), 14.4]
>>> sorted(data)  # This has surprising behavior
[20.7, nan, 14.4, 18.3, 19.2, nan]
>>> median(data)  # This result is unexpected
16.35

>>> sum(map(isnan, data))    # Number of missing values
2
>>> clean = list(filterfalse(isnan, data))  # Strip NaN values
>>> clean
[20.7, 19.2, 18.3, 14.4]
>>> sorted(clean)  # Sorting now works as expected
[14.4, 18.3, 19.2, 20.7]
>>> median(clean)       # This result is now well defined
18.75
@end example

@menu
* Promedios y medidas de tendencia central:: 
* Medidas de dispersión:: 
* Estadísticas para relaciones entre dos entradas:: 
* Detalles de las funciones:: 
* Excepciones: Excepciones<5>. 
* Objetos NormalDist:: 
* Examples and Recipes:: 

@end menu

@node Promedios y medidas de tendencia central,Medidas de dispersión,,statistics — Mathematical statistics functions
@anchor{library/statistics averages-and-measures-of-central-location}@anchor{26fd}
@subsubsection Promedios y medidas de tendencia central


Estas funciones calculan el promedio o el valor típico de una población o muestra.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{772,,mean()}

@tab

Media aritmética («promedio») de los datos.

@item

@ref{ac6,,fmean()}

@tab

Fast, floating-point arithmetic mean, with optional weighting.

@item

@ref{ac7,,geometric_mean()}

@tab

Media geométrica de los datos.

@item

@ref{d68,,harmonic_mean()}

@tab

Media armónica de los datos.

@item

@ref{3a3,,kde()}

@tab

Estimate the probability density distribution of the data.

@item

@ref{3a4,,kde_random()}

@tab

Random sampling from the PDF generated by kde().

@item

@ref{26fe,,median()}

@tab

Mediana (valor central) de los datos.

@item

@ref{26ff,,median_low()}

@tab

Mediana baja de los datos.

@item

@ref{2700,,median_high()}

@tab

Mediana alta de los datos.

@item

@ref{2701,,median_grouped()}

@tab

Median (50th percentile) of grouped data.

@item

@ref{b1d,,mode()}

@tab

Moda única (valor más común) de datos discretos o nominales.

@item

@ref{ac8,,multimode()}

@tab

Lista de modas (valores más comunes) de datos discretos o nominales.

@item

@ref{ac9,,quantiles()}

@tab

Divide los datos en intervalos equiprobables.

@end multitable


@node Medidas de dispersión,Estadísticas para relaciones entre dos entradas,Promedios y medidas de tendencia central,statistics — Mathematical statistics functions
@anchor{library/statistics measures-of-spread}@anchor{2702}
@subsubsection Medidas de dispersión


Estas funciones calculan una medida de cuánto tiende a desviarse la población o muestra de los valores típicos o promedios.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{2703,,pstdev()}

@tab

Desviación típica poblacional de los datos.

@item

@ref{2704,,pvariance()}

@tab

Varianza poblacional de los datos.

@item

@ref{774,,stdev()}

@tab

Desviación típica muestral de los datos.

@item

@ref{773,,variance()}

@tab

Varianza muestral de los datos.

@end multitable


@node Estadísticas para relaciones entre dos entradas,Detalles de las funciones,Medidas de dispersión,statistics — Mathematical statistics functions
@anchor{library/statistics statistics-for-relations-between-two-inputs}@anchor{2705}
@subsubsection Estadísticas para relaciones entre dos entradas


Estas funciones calculan estadísticas sobre las relaciones entre dos entradas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{8c7,,covariance()}

@tab

Covarianza muestral de dos variables.

@item

@ref{563,,correlation()}

@tab

Coeficiente de correlación de Pearson y Spearman.

@item

@ref{8c8,,linear_regression()}

@tab

Pendiente e intersección para regresión lineal simple.

@end multitable


@node Detalles de las funciones,Excepciones<5>,Estadísticas para relaciones entre dos entradas,statistics — Mathematical statistics functions
@anchor{library/statistics function-details}@anchor{2706}
@subsubsection Detalles de las funciones


Nota: Las funciones no requieren que se ordenen los datos que se les proporcionan. Sin embargo, para facilitar la lectura, la mayoría de los ejemplos muestran secuencias ordenadas.

@geindex mean() (en el módulo statistics)
@anchor{library/statistics statistics mean}@anchor{772}
@deffn {Función} statistics.mean (data)

Retorna la media aritmética muestral de `data', que puede ser una secuencia o un iterable.

La media aritmética es la suma de los valores dividida entre el número de observaciones. Es comúnmente denominada «promedio», aunque hay muchas formas de definir el promedio matemáticamente. Es una medida de tendencia central de los datos.

Se lanza una excepción @ref{2707,,StatisticsError} si `data' está vacío.

Algunos ejemplos de uso:

@example
>>> mean([1, 2, 3, 4, 4])
2.8
>>> mean([-1.0, 2.5, 3.25, 5.75])
2.625

>>> from fractions import Fraction as F
>>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)])
Fraction(13, 21)

>>> from decimal import Decimal as D
>>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")])
Decimal('0.5625')
@end example

@cartouche
@quotation Nota 
La media se ve muy afectada por los outliers@footnote{https://en.wikipedia.org/wiki/Outlier} y no es necesariamente un ejemplo típico de los puntos de datos. Para una medida más robusta, aunque menos eficiente, de la tendencia central@footnote{https://en.wikipedia.org/wiki/Central_tendency}, véase @ref{26fe,,median()}.

La media muestral proporciona una estimación no sesgada de la media real de la población. Por lo tanto, al calcular el promedio de todas las muestras posibles, @code{mean(sample)} converge con el promedio real de toda la población. Si `data' representa a una población completa, en lugar de a una muestra, entonces @code{mean(data)} equivale a calcular la media poblacional verdadera μ.
@end quotation
@end cartouche
@end deffn

@geindex fmean() (en el módulo statistics)
@anchor{library/statistics statistics fmean}@anchor{ac6}
@deffn {Función} statistics.fmean (data, weights=None)

Convierte los valores de `data' a flotantes y calcula la media aritmética.

Esta función se ejecuta más rápido que @ref{772,,mean()} y siempre retorna un @ref{153,,float}. `data' puede ser una secuencia o un iterable. Si el conjunto de datos de entrada está vacío, se lanza una excepción @ref{2707,,StatisticsError}.

@example
>>> fmean([3.5, 4.0, 5.25])
4.25
@end example

La ponderación es opcional.  Por ejemplo, un profesor asigna una nota a un curso ponderando las pruebas en un 20%, los deberes en un 20%, un examen parcial en un 30% y un examen final en un 30%:

@example
>>> grades = [85, 92, 83, 91]
>>> weights = [0.20, 0.20, 0.30, 0.30]
>>> fmean(grades, weights)
87.6
@end example

Si se proporciona `weights', debe tener la misma longitud que los `data' o se producirá un @ref{360,,ValueError}.


Added in version 3.8.



Distinto en la versión 3.11: Soporte añadido a `weights'.

@end deffn

@geindex geometric_mean() (en el módulo statistics)
@anchor{library/statistics statistics geometric_mean}@anchor{ac7}
@deffn {Función} statistics.geometric_mean (data)

Convierte los valores de `data' a flotantes y calcula la media geométrica.

La media geométrica indica la tendencia central o valor típico de `data' utilizando el producto de los valores (en oposición a la media aritmética, que utiliza su suma).

Lanza una excepción @ref{2707,,StatisticsError} si el conjunto de datos de entrada está vacío, o si contiene un cero o un valor negativo. `data' puede ser una secuencia o un iterable.

No se toman medidas especiales para garantizar que el resultado sea completamente preciso. (Sin embargo, esto puede cambiar en una versión futura.)

@example
>>> round(geometric_mean([54, 24, 36]), 1)
36.0
@end example


Added in version 3.8.

@end deffn

@geindex harmonic_mean() (en el módulo statistics)
@anchor{library/statistics statistics harmonic_mean}@anchor{d68}
@deffn {Función} statistics.harmonic_mean (data, weights=None)

Return the harmonic mean of `data', a sequence or iterable of
real-valued numbers.  If `weights' is omitted or @code{None}, then
equal weighting is assumed.

La media armónica es recíproco de la @ref{772,,mean()} aritmética de los recíprocos de los datos. Por ejemplo, la media armónica de tres valores `a', `b' and `c' es equivalente a @code{3/(1/a + 1/b + 1/c)}. Si alguno de los valores es cero, el resultado va a ser cero.

La media armónica es un tipo de promedio, una medida de la tendencia central de los datos. Generalmente es adecuada para calcular promedios de tasas o fracciones, por ejemplo, velocidades.

Supongamos que un automóvil viaja 10 km a 40 km/h, luego otros 10 km a 60 km/h. ¿Cuál es su velocidad media?

@example
>>> harmonic_mean([40, 60])
48.0
@end example

Supongamos que un un automóvil viaja 5 km a 40 km/h, y cuando el tráfico se despeja, acelera a 60 km/h durante los 30 km restantes del viaje. ¿Cuál es su velocidad media?

@example
>>> harmonic_mean([40, 60], weights=[5, 30])
56.0
@end example

Una excepción @ref{2707,,StatisticsError} es lanzada si `data' está vacío, algún elemento es menor que cero, o si la suma ponderada no es positiva.

El algoritmo actual tiene una salida anticipada cuando encuentra un cero en la entrada. Esto significa que no se comprueba la validez de las entradas posteriores al cero. (Este comportamiento puede cambiar en el futuro.)


Added in version 3.6.



Distinto en la versión 3.10: Soporte añadido a `weights'.

@end deffn

@geindex kde() (en el módulo statistics)
@anchor{library/statistics statistics kde}@anchor{3a3}
@deffn {Función} statistics.kde (data, h, kernel='normal', *, cumulative=False)

Kernel Density Estimation (KDE)@footnote{https://www.itm-conferences.org/articles/itmconf/pdf/2018/08/itmconf_sam2018_00037.pdf}:
Create a continuous probability density function or cumulative
distribution function from discrete samples.

The basic idea is to smooth the data using a kernel function@footnote{https://en.wikipedia.org/wiki/Kernel_(statistics)}.
to help draw inferences about a population from a sample.

The degree of smoothing is controlled by the scaling parameter `h'
which is called the bandwidth.  Smaller values emphasize local
features while larger values give smoother results.

The `kernel' determines the relative weights of the sample data
points.  Generally, the choice of kernel shape does not matter
as much as the more influential bandwidth smoothing parameter.

Kernels that give some weight to every sample point include
`normal' (`gauss'), `logistic', and `sigmoid'.

Kernels that only give weight to sample points within the bandwidth
include `rectangular' (`uniform'), `triangular', `parabolic'
(`epanechnikov'), `quartic' (`biweight'), `triweight', and `cosine'.

If `cumulative' is true, will return a cumulative distribution function.

A @ref{2707,,StatisticsError} will be raised if the `data' sequence is empty.

Wikipedia has an example@footnote{https://en.wikipedia.org/wiki/Kernel_density_estimation#Example}
where we can use @ref{3a3,,kde()} to generate and plot a probability
density function estimated from a small sample:

@example
>>> sample = [-2.1, -1.3, -0.4, 1.9, 5.1, 6.2]
>>> f_hat = kde(sample, h=1.5)
>>> xarr = [i/100 for i in range(-750, 1100)]
>>> yarr = [f_hat(x) for x in xarr]
@end example

Los puntos de @code{xarr} y @code{yarr} pueden utilizarse para hacer una gráfica de la función de densidad de probabilidad:

@image{python-figures/kde_example,,,Diagrama de dispersión de la función de densidad de probabilidad estimada.,png}


Added in version 3.13.

@end deffn

@geindex kde_random() (en el módulo statistics)
@anchor{library/statistics statistics kde_random}@anchor{3a4}
@deffn {Función} statistics.kde_random (data, h, kernel='normal', *, seed=None)

Return a function that makes a random selection from the estimated
probability density function produced by @code{kde(data, h, kernel)}.

Providing a `seed' allows reproducible selections. In the future, the
values may change slightly as more accurate kernel inverse CDF estimates
are implemented.  The seed may be an integer, float, str, or bytes.

A @ref{2707,,StatisticsError} will be raised if the `data' sequence is empty.

Continuing the example for @ref{3a3,,kde()}, we can use
@ref{3a4,,kde_random()} to generate new random selections from an
estimated probability density function:

@example
>>> data = [-2.1, -1.3, -0.4, 1.9, 5.1, 6.2]
>>> rand = kde_random(data, h=1.5, seed=8675309)
>>> new_selections = [rand() for i in range(10)]
>>> [round(x, 1) for x in new_selections]
[0.7, 6.2, 1.2, 6.9, 7.0, 1.8, 2.5, -0.5, -1.8, 5.6]
@end example


Added in version 3.13.

@end deffn

@geindex median() (en el módulo statistics)
@anchor{library/statistics statistics median}@anchor{26fe}
@deffn {Función} statistics.median (data)

Retorna la mediana (valor central) de los datos numéricos, utilizando el método clásico de «media de los dos del medio». Si `data' está vacío, se lanza una excepción @ref{2707,,StatisticsError}. `data' puede ser una secuencia o un iterable.

La mediana es una medida de tendencia central robusta y es menos sensible a la presencia de valores atípicos que la media. Cuando el número de casos es impar, se retorna el valor central:

@example
>>> median([1, 3, 5])
3
@end example

Cuando el número de observaciones es par, la mediana se interpola calculando el promedio de los dos valores centrales:

@example
>>> median([1, 3, 5, 7])
4.0
@end example

Este enfoque es adecuado para datos discretos, siempre que se acepte que la mediana no es necesariamente parte de las observaciones.

Si los datos son ordinales (se pueden ordenar) pero no numéricos (no se pueden sumar), considera usar @ref{26ff,,median_low()} o @ref{2700,,median_high()} en su lugar.
@end deffn

@geindex median_low() (en el módulo statistics)
@anchor{library/statistics statistics median_low}@anchor{26ff}
@deffn {Función} statistics.median_low (data)

Retorna la mediana baja de los datos numéricos. Se lanza una excepción @ref{2707,,StatisticsError} si `data' está vacío. `data' puede ser una secuencia o un iterable.

La mediana baja es siempre un valor presente en el conjunto de datos. Cuando el número de casos es impar, se retorna el valor central. Cuando el número de casos es par, se retorna el menor de los dos valores centrales.

@example
>>> median_low([1, 3, 5])
3
>>> median_low([1, 3, 5, 7])
3
@end example

Utiliza la mediana baja cuando tus datos sean discretos y prefieras que la mediana sea un valor representado en tus observaciones, en lugar de ser el resultado de una interpolación.
@end deffn

@geindex median_high() (en el módulo statistics)
@anchor{library/statistics statistics median_high}@anchor{2700}
@deffn {Función} statistics.median_high (data)

Retorna la mediana alta de los datos. Lanza una excepción @ref{2707,,StatisticsError} si `data' está vacío. `data' puede ser una secuencia o un iterable.

La mediana alta es siempre un valor presente en el conjunto de datos. Cuando el número de casos es impar, se retorna el valor central. Cuando el número de casos es par, se retorna el mayor de los dos valores centrales.

@example
>>> median_high([1, 3, 5])
3
>>> median_high([1, 3, 5, 7])
5
@end example

Utiliza la mediana alta cuando tus datos sean discretos y prefieras que la mediana sea un valor representado en tus observaciones, en lugar de ser el resultado de una interpolación.
@end deffn

@geindex median_grouped() (en el módulo statistics)
@anchor{library/statistics statistics median_grouped}@anchor{2701}
@deffn {Función} statistics.median_grouped (data, interval=1.0)

Estimates the median for numeric data that has been grouped or binned@footnote{https://en.wikipedia.org/wiki/Data_binning} around the midpoints
of consecutive, fixed-width intervals.

The `data' can be any iterable of numeric data with each value being
exactly the midpoint of a bin.  At least one value must be present.

The `interval' is the width of each bin.

For example, demographic information may have been summarized into
consecutive ten-year age groups with each group being represented
by the 5-year midpoints of the intervals:

@example
>>> from collections import Counter
>>> demographics = Counter(@{
...    25: 172,   # 20 to 30 years old
...    35: 484,   # 30 to 40 years old
...    45: 387,   # 40 to 50 years old
...    55:  22,   # 50 to 60 years old
...    65:   6,   # 60 to 70 years old
... @})
...
@end example

The 50th percentile (median) is the 536th person out of the 1071
member cohort.  That person is in the 30 to 40 year old age group.

The regular @ref{26fe,,median()} function would assume that everyone in the
tricenarian age group was exactly 35 years old.  A more tenable
assumption is that the 484 members of that age group are evenly
distributed between 30 and 40.  For that, we use
@ref{2701,,median_grouped()}:

@example
>>> data = list(demographics.elements())
>>> median(data)
35
>>> round(median_grouped(data, interval=10), 1)
37.5
@end example

The caller is responsible for making sure the data points are separated
by exact multiples of `interval'.  This is essential for getting a
correct result.  The function does not check this precondition.

Inputs may be any numeric type that can be coerced to a float during
the interpolation step.
@end deffn

@geindex mode() (en el módulo statistics)
@anchor{library/statistics statistics mode}@anchor{b1d}
@deffn {Función} statistics.mode (data)

Retorna el valor más común del conjunto de datos discretos o nominales `data'.La moda (cuando existe) es el valor más representativo y sirve como medida de tendencia central.

Si hay varias modas con la misma frecuencia, retorna la primera encontrada en `data'. Si deseas la menor o la mayor de ellas, usa @code{min(multimode(data))} o @code{max(multimode(data))}. Se lanza una excepción @ref{2707,,StatisticsError} si la entrada `data' está vacía.

@code{mode} asume que los datos de entrada son discretos y retorna un solo valor. Esta es la definición habitual de la moda que se enseña en las escuelas:

@example
>>> mode([1, 1, 2, 3, 3, 3, 3, 4])
3
@end example

La moda tiene la particularidad de ser la única estadística de este módulo que se puede calcular sobre datos nominales (no numéricos):

@example
>>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
'red'
@end example

Only hashable inputs are supported.  To handle type @ref{67a,,set},
consider casting to @ref{67b,,frozenset}.  To handle type @ref{18e,,list},
consider casting to @ref{464,,tuple}.  For mixed or nested inputs, consider
using this slower quadratic algorithm that only depends on equality tests:
@code{max(data, key=data.count)}.


Distinto en la versión 3.8: Ahora maneja conjuntos de datos multimodales, retornando la primera moda encontrada. Anteriormente, se lanzaba una excepción @ref{2707,,StatisticsError} cuando se daba esta situación.

@end deffn

@geindex multimode() (en el módulo statistics)
@anchor{library/statistics statistics multimode}@anchor{ac8}
@deffn {Función} statistics.multimode (data)

Retorna una lista de los valores más frecuentes en el orden en que aparecen en `data'. Retornará varios resultados en el caso de que existan varias modas, o una lista vacía si `data' está vacío:

@example
>>> multimode('aabbbbccddddeeffffgg')
['b', 'd', 'f']
>>> multimode('@w{'})
[]
@end example


Added in version 3.8.

@end deffn

@geindex pstdev() (en el módulo statistics)
@anchor{library/statistics statistics pstdev}@anchor{2703}
@deffn {Función} statistics.pstdev (data, mu=None)

Retorna la desviación típica poblacional (la raíz cuadrada de la varianza poblacional). Consultar @ref{2704,,pvariance()} para los argumentos y otros detalles.

@example
>>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
0.986893273527251
@end example
@end deffn

@geindex pvariance() (en el módulo statistics)
@anchor{library/statistics statistics pvariance}@anchor{2704}
@deffn {Función} statistics.pvariance (data, mu=None)

Retorna la varianza poblacional de `data', que debe ser una secuencia no vacía o un iterable de números reales. La varianza, o momento de segundo orden respecto a la media, es una medida de la variabilidad (o dispersión) de los datos. Una alta varianza indica una amplia dispersión de valores; una varianza baja indica que los valores están agrupados alrededor de la media.

If the optional second argument `mu' is given, it should be the `population'
mean of the `data'.  It can also be used to compute the second moment around
a point that is not the mean.  If it is missing or @code{None} (the default),
the arithmetic mean is automatically calculated.

Utiliza esta función para calcular la varianza de toda la población. Para estimar la varianza de una muestra, la función @ref{773,,variance()} suele ser una opción mejor.

Lanza una excepción @ref{2707,,StatisticsError} si `data' está vacío.

Ejemplos:

@example
>>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
>>> pvariance(data)
1.25
@end example

Si ya has calculado la media de tus datos, puedes pasarla como segundo argumento opcional `mu' para evitar que se tenga que volver a calcular:

@example
>>> mu = mean(data)
>>> pvariance(data, mu)
1.25
@end example

Se admiten decimales (Decimal) y fracciones (Fraction):

@example
>>> from decimal import Decimal as D
>>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
Decimal('24.815')

>>> from fractions import Fraction as F
>>> pvariance([F(1, 4), F(5, 4), F(1, 2)])
Fraction(13, 72)
@end example

@cartouche
@quotation Nota 
Esta función retorna la varianza poblacional σ² cuando se aplica a toda la población. Si se aplica solo a una muestra, el resultado es la varianza muestral s², conocida también como varianza con N grados de libertad.

Si se conoce de antemano la verdadera media poblacional μ, se puede usar esta función para calcular la varianza muestral, pasando la media poblacional conocida como segundo argumento. Suponiendo que las observaciones provienen de una selección aleatoria uniforme de la población, el resultado será una estimación no sesgada de la varianza poblacional.
@end quotation
@end cartouche
@end deffn

@geindex stdev() (en el módulo statistics)
@anchor{library/statistics statistics stdev}@anchor{774}
@deffn {Función} statistics.stdev (data, xbar=None)

Retorna la desviación típica muestral (la raíz cuadrada de la varianza muestral). Consultar @ref{773,,variance()} para los argumentos y otros detalles.

@example
>>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
1.0810874155219827
@end example
@end deffn

@geindex variance() (en el módulo statistics)
@anchor{library/statistics statistics variance}@anchor{773}
@deffn {Función} statistics.variance (data, xbar=None)

Retorna la varianza muestral de `data', que debe ser un iterable de al menos dos números reales. La varianza, o momento de segundo orden respecto a la media, es una medida de la variabilidad (difusión o dispersión) de los datos. Una alta varianza indica que los datos están dispersos; una baja varianza indica que los datos están agrupados estrechamente alrededor de la media.

If the optional second argument `xbar' is given, it should be the `sample'
mean of `data'.  If it is missing or @code{None} (the default), the mean is
automatically calculated.

Utiliza esta función cuando tus datos sean una muestra de una población. Para calcular la varianza de toda la población, consulta @ref{2704,,pvariance()}.

Lanza una excepción @ref{2707,,StatisticsError} si `data' tiene menos de dos valores.

Ejemplos:

@example
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> variance(data)
1.3720238095238095
@end example

If you have already calculated the sample mean of your data, you can pass it
as the optional second argument `xbar' to avoid recalculation:

@example
>>> m = mean(data)
>>> variance(data, m)
1.3720238095238095
@end example

Esta función no comprueba si el valor pasado al argumento `xbar' corresponde al promedio. El uso de valores arbitrarios para `xbar' produce resultados imposibles o incorrectos.

La función maneja decimales (Decimal) y fracciones (Fraction):

@example
>>> from decimal import Decimal as D
>>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
Decimal('31.01875')

>>> from fractions import Fraction as F
>>> variance([F(1, 6), F(1, 2), F(5, 3)])
Fraction(67, 108)
@end example

@cartouche
@quotation Nota 
Esta es la varianza muestral s² con la corrección de Bessel, también conocida como varianza con N-1 grados de libertad. Suponiendo que las observaciones son representativas de la población (es decir, independientes y distribuidas de forma idéntica), el resultado es una estimación no sesgada de la varianza.

Si conoces de antemano la verdadera media poblacional μ, debes pasarla a @ref{2704,,pvariance()} mediante el parámetro `mu' para obtener la varianza muestral.
@end quotation
@end cartouche
@end deffn

@geindex quantiles() (en el módulo statistics)
@anchor{library/statistics statistics quantiles}@anchor{ac9}
@deffn {Función} statistics.quantiles (data, *, n=4, method='exclusive')

Divide `data' en `n' intervalos continuos equiprobables. Retorna una lista de @code{n - 1} límites que delimitan los intervalos (cuantiles).

Establece `n' en 4 para obtener los cuartiles (el valor predeterminado), en 10 para obtener los deciles y en 100 para obtener los percentiles (lo que produce 99 valores que separan `data' en 100 grupos del mismo tamaño). Si `n' es menor que 1, se lanza una excepción @ref{2707,,StatisticsError}.

The `data' can be any iterable containing sample data.  For meaningful
results, the number of data points in `data' should be larger than `n'.
Raises @ref{2707,,StatisticsError} if there is not at least one data point.

Los límites de los intervalos se interpolan linealmente a partir de los dos valores más cercanos de la muestra. Por ejemplo, si un límite es un tercio de la distancia entre los valores 100 y 112 de la muestra, el límite será 104.

El argumento `method' indica el método que se utilizará para calcular los cuantiles y se puede modificar para especificar si se deben incluir o excluir valores de `data' extremos, altos y bajos, de la población.

El valor predeterminado para `method' es «exclusive» y es aplicable a los datos muestreados de una población que puede tener valores más extremos que los encontrados en las muestras. La proporción de la población que se encuentra por debajo del `i-ésimo' valor de `m' valores ordenados se calcula mediante la fórmula @code{i / (m + 1)}. Por ejemplo, asumiendo que hay 9 valores en la muestra, este método los ordena y los asocia con los siguientes percentiles: 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%.

Si se usa «inclusive» como valor para el parámetro `method', se asume que los datos corresponden a una población completa o que los valores extremos de la población están representados en la muestra. El valor mínimo de `data' se considera entonces como percentil 0 y el máximo como percentil 100. La proporción de la población que se encuentra por debajo del `i-ésimo' valor de `m' valores ordenados se calcula mediante la fórmula @code{(i - 1) / (m - 1)}. Suponiendo que tenemos 11 valores en la muestra, este método los ordena y los asocia con los siguientes percentiles: 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80 %, 90%, 100%.

@example
# Decile cut points for empirically sampled data
>>> data = [105, 129, 87, 86, 111, 111, 89, 81, 108, 92, 110,
...         100, 75, 105, 103, 109, 76, 119, 99, 91, 103, 129,
...         106, 101, 84, 111, 74, 87, 86, 103, 103, 106, 86,
...         111, 75, 87, 102, 121, 111, 88, 89, 101, 106, 95,
...         103, 107, 101, 81, 109, 104]
>>> [round(q, 1) for q in quantiles(data, n=10)]
[81.0, 86.2, 89.0, 99.4, 102.5, 103.6, 106.0, 109.8, 111.0]
@end example


Added in version 3.8.



Distinto en la versión 3.13: No longer raises an exception for an input with only a single data point.
This allows quantile estimates to be built up one sample point
at a time becoming gradually more refined with each new data point.

@end deffn

@geindex covariance() (en el módulo statistics)
@anchor{library/statistics statistics covariance}@anchor{8c7}
@deffn {Función} statistics.covariance (x, y, /)

Retorna la covarianza de muestra de dos entradas `x' y `y'. La covarianza es una medida de la variabilidad conjunta de dos entradas.

Ambas entradas deben ser del mismo largo (no menor a dos), de lo contrario se lanza @ref{2707,,StatisticsError}.

Ejemplos:

@example
>>> x = [1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> y = [1, 2, 3, 1, 2, 3, 1, 2, 3]
>>> covariance(x, y)
0.75
>>> z = [9, 8, 7, 6, 5, 4, 3, 2, 1]
>>> covariance(x, z)
-7.5
>>> covariance(z, x)
-7.5
@end example


Added in version 3.10.

@end deffn

@geindex correlation() (en el módulo statistics)
@anchor{library/statistics statistics correlation}@anchor{563}
@deffn {Función} statistics.correlation (x, y, /, *, method='linear')

Retorna el coeficiente de correlación de Pearson@footnote{https://es.wikipedia.org/wiki/Coeficiente_de_correlaci%C3%B3n_de_Spearman} para dos entradas. El coeficiente de correlación de Pearson `r' toma valores entre -1 y +1. Mide la fuerza y dirección de la relación lineal.

Si `method' es «`ranked'», calcula El coeficiente de correlación de Spearman@footnote{https://es.wikipedia.org/wiki/Coeficiente_de_correlaci%C3%B3n_de_Spearman} para dos entradas. Los datos se sustituyen por rangos. Los empates se promedian para que valores iguales reciban el mismo rango. El coeficiente resultante mide la fuerza de una relación monótona.

El coeficiente de correlación de Spearman es apropiado para datos ordinales o para datos continuos que no cumplen el requisito de proporción lineal para el coeficiente de correlación de Pearson.

Ambas entradas deben ser del mismo largo (no menor a dos), y no necesitan ser constantes, de lo contrario se lanza @ref{2707,,StatisticsError}.

Ejemplo con “Leyes de Kepler sobre el movimiento planetario <https://es.wikipedia.org/wiki/Leyes_de_Kepler’_@footnote{https://es.wikipedia.org/wiki/Leyes_de_Kepler'_}:

@example
>>> # Mercury, Venus, Earth, Mars, Jupiter, Saturn, Uranus, and  Neptune
>>> orbital_period = [88, 225, 365, 687, 4331, 10_756, 30_687, 60_190]    # days
>>> dist_from_sun = [58, 108, 150, 228, 778, 1_400, 2_900, 4_500] # million km

>>> # Show that a perfect monotonic relationship exists
>>> correlation(orbital_period, dist_from_sun, method='ranked')
1.0

>>> # Observe that a linear relationship is imperfect
>>> round(correlation(orbital_period, dist_from_sun), 4)
0.9882

>>> # Demonstrate Kepler's third law: There is a linear correlation
>>> # between the square of the orbital period and the cube of the
>>> # distance from the sun.
>>> period_squared = [p * p for p in orbital_period]
>>> dist_cubed = [d * d * d for d in dist_from_sun]
>>> round(correlation(period_squared, dist_cubed), 4)
1.0
@end example


Added in version 3.10.



Distinto en la versión 3.12: Soporte añadido para el coeficiente de correlación de Spearman.

@end deffn

@geindex linear_regression() (en el módulo statistics)
@anchor{library/statistics statistics linear_regression}@anchor{8c8}
@deffn {Función} statistics.linear_regression (x, y, /, *, proportional=False)

Retorna la pendiente e intersección de los parámetros de una regresión lineal simple@footnote{https://en.wikipedia.org/wiki/Simple_linear_regression} estimados usando mínimos cuadrados ordinarios. La regresión lineal simple describe la relación entre la variable independiente `x' y la variable dependiente `y' en términos de esta función lineal:

@quotation

`y = slope * x + intercept + noise'
@end quotation

donde  @code{slope} e @code{intercept} son los parámetros de regresión que son estimados, y @code{noise} representa la variabilidad de los datos que no fue explicado por la regresión lineal (es igual a la diferencia entre los valores predichos y reales de la variable dependiente).

Ambas entradas deben ser del mismo largo (no menor a dos), y la variable independiente `x' no puede ser constante, de lo contrario se lanza @ref{2707,,StatisticsError}.

Por ejemplo, podemos usar las fechas de lanzamiento de las películas de Monty Python@footnote{https://en.wikipedia.org/wiki/Monty_Python#Films} para predecir el número acumulativo de películas de Monty Python que se habría producido en 2019 asumiendo que hubiesen mantenido el ritmo:

@example
>>> year = [1971, 1975, 1979, 1982, 1983]
>>> films_total = [1, 2, 3, 4, 5]
>>> slope, intercept = linear_regression(year, films_total)
>>> round(slope * 2019 + intercept)
16
@end example

Si `proportional' es verdadero, se supone que la variable independiente `x' y la variable dependiente `y' son directamente proporcionales. Los datos se ajustan a una recta que pasa por el origen. Como la `intercept' siempre será 0,0, la función lineal subyacente se simplifica a:

@quotation

`y = slope * x + noise'
@end quotation

Continuing the example from @ref{563,,correlation()}, we look to see
how well a model based on major planets can predict the orbital
distances for dwarf planets:

@example
>>> model = linear_regression(period_squared, dist_cubed, proportional=True)
>>> slope = model.slope

>>> # Dwarf planets:   Pluto,  Eris,    Makemake, Haumea, Ceres
>>> orbital_periods = [90_560, 204_199, 111_845, 103_410, 1_680]  # days
>>> predicted_dist = [math.cbrt(slope * (p * p)) for p in orbital_periods]
>>> list(map(round, predicted_dist))
[5912, 10166, 6806, 6459, 414]

>>> [5_906, 10_152, 6_796, 6_450, 414]  # actual distance in million km
[5906, 10152, 6796, 6450, 414]
@end example


Added in version 3.10.



Distinto en la versión 3.11: Soporte añadido a `proportional'.

@end deffn

@node Excepciones<5>,Objetos NormalDist,Detalles de las funciones,statistics — Mathematical statistics functions
@anchor{library/statistics exceptions}@anchor{2708}
@subsubsection Excepciones


Se define una sola excepción:

@geindex StatisticsError
@anchor{library/statistics statistics StatisticsError}@anchor{2707}
@deffn {Excepción} statistics.StatisticsError

Subclase de @ref{360,,ValueError} para excepciones relacionadas con la estadística.
@end deffn

@node Objetos NormalDist,Examples and Recipes,Excepciones<5>,statistics — Mathematical statistics functions
@anchor{library/statistics normaldist-objects}@anchor{2709}
@subsubsection Objetos @code{NormalDist}


@ref{aca,,NormalDist} es una herramienta para crear y manipular distribuciones normales de una variable aleatoria@footnote{http://www.stat.yale.edu/Courses/1997-98/101/ranvar.htm}. Esta clase gestiona la desviación típica y la media de un conjunto de observaciones como una sola entidad.

Las distribuciones normales surgen del Teorema del límite central@footnote{https://es.wikipedia.org/wiki/Teorema_del_l%C3%ADmite_central} y tienen una amplia gama de aplicaciones en estadística.

@geindex NormalDist (clase en statistics)
@anchor{library/statistics statistics NormalDist}@anchor{aca}
@deffn {Clase} statistics.NormalDist (mu=0.0, sigma=1.0)

Retorna un nuevo objeto `NormalDist' donde `mu' representa la media aritmética@footnote{https://es.wikipedia.org/wiki/Media_aritm%C3%A9tica} y `sigma' representa la desviación típica@footnote{https://es.wikipedia.org/wiki/Desviaci%C3%B3n_t%C3%ADpica}.

Se lanza una excepción @ref{2707,,StatisticsError} si `sigma' es negativo.

@geindex mean (atributo de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist mean}@anchor{270a}
@deffn {Atributo} mean

Una propiedad de solo lectura para la media aritmética@footnote{https://es.wikipedia.org/wiki/Media_aritm%C3%A9tica} de una distribución normal.
@end deffn

@geindex median (atributo de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist median}@anchor{270b}
@deffn {Atributo} median

Una propiedad de solo lectura para la mediana@footnote{https://es.wikipedia.org/wiki/Mediana_(estad%C3%ADstica)} de una distribución normal.
@end deffn

@geindex mode (atributo de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist mode}@anchor{270c}
@deffn {Atributo} mode

Una propiedad de solo lectura para la moda@footnote{https://es.wikipedia.org/wiki/Moda_(estad%C3%ADstica)} de una distribución normal.
@end deffn

@geindex stdev (atributo de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist stdev}@anchor{270d}
@deffn {Atributo} stdev

Una propiedad de solo lectura para la desviación típica@footnote{https://es.wikipedia.org/wiki/Desviaci%C3%B3n_t%C3%ADpica} de una distribución normal.
@end deffn

@geindex variance (atributo de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist variance}@anchor{270e}
@deffn {Atributo} variance

Una propiedad de solo lectura para la varianza@footnote{https://es.wikipedia.org/wiki/Varianza} de una distribución normal. Es igual al cuadrado de la desviación típica.
@end deffn

@geindex from_samples() (método de clase de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist from_samples}@anchor{270f}
@deffn {Método} classmethod from_samples (data)

Crea una instancia de distribución normal con los parámetros `mu' y `sigma' estimados a partir de `data' usando @ref{ac6,,fmean()} y @ref{774,,stdev()}.

`data' puede ser cualquier @ref{1294,,iterable} de valores que se puedan convertir al tipo @ref{153,,float}. Se lanza una excepción @ref{2707,,StatisticsError} si `data' no contiene al menos dos elementos, esto se debe a que se necesita al menos un punto para estimar un valor central y al menos dos puntos para estimar la dispersión.
@end deffn

@geindex samples() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist samples}@anchor{2710}
@deffn {Método} samples (n, *, seed=None)

Genera `n' muestras aleatorias para una media y una desviación típica proporcionadas. Retorna un objeto @ref{18e,,list} de valores @ref{153,,float}.

Si se proporciona `seed', su valor se usa para inicializar una nueva instancia del generador de números aleatorios subyacente. Esto permite producir resultados reproducibles incluso en un contexto de paralelismo con múltiples hilos.


Distinto en la versión 3.13.


Switched to a faster algorithm.  To reproduce samples from previous
versions, use @ref{12e1,,random.seed()} and @ref{1848,,random.gauss()}.
@end deffn

@geindex pdf() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist pdf}@anchor{2711}
@deffn {Método} pdf (x)

Haciendo uso de una función de densidad de probabilidad (FPD o PDF en inglés)@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_de_densidad_de_probabilidad}, calcula la verosimilitud relativa de que una variable aleatoria `X' caiga en una región cercana al valor `x' proporcionado. Matemáticamente, esto corresponde al límite de la razón @code{P(x <= X < x+dx) / dx} cuando `dx' tiende a cero.

La verosimilitud relativa se calcula como la probabilidad de que una observación pertenezca a un intervalo estrecho dividida entre el ancho del intervalo (de ahí el término «densidad»). Como la verosimilitud es relativa a los otros puntos, su valor puede ser mayor que @code{1.0}.
@end deffn

@geindex cdf() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist cdf}@anchor{2712}
@deffn {Método} cdf (x)

Usando una función de distribución acumulada (FDA@comma{} CDF en inglés)@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_de_distribuci%C3%B3n}, calcula la probabilidad de que una variable aleatoria `X' sea menor o igual que `x'. Matemáticamente, se escribe @code{P(X <= x)}.
@end deffn

@geindex inv_cdf() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist inv_cdf}@anchor{2713}
@deffn {Método} inv_cdf (p)

Calcula la función de distribución acumulada inversa, también conocida como función cuantil@footnote{https://es.wikipedia.org/wiki/Funci%C3%B3n_cuantil} o función punto porcentual@footnote{https://web.archive.org/web/20190203145224/https://www.statisticshowto.datasciencecentral.com/inverse-distribution-function/}. Matemáticamente, se escribe @code{x : P(X <= x) = p}.

Calcula el valor `x' de la variable aleatoria `X' tal que la probabilidad de que la variable sea menor o igual a este valor es igual a la probabilidad `p' dada.
@end deffn

@geindex overlap() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist overlap}@anchor{2714}
@deffn {Método} overlap (other)

Mide la concordancia entre dos distribuciones de probabilidad normales. Retorna un valor entre 0.0 y 1.0 que indica el área de superposición de dos funciones de densidad de probabilidad@footnote{https://www.rasch.org/rmt/rmt101r.htm}.
@end deffn

@geindex quantiles() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist quantiles}@anchor{2715}
@deffn {Método} quantiles (n=4)

Divide la distribución normal en `n' intervalos continuos equiprobables. Retorna una lista de (n - 1) cuantiles que separan los intervalos.

Establece `n' en 4 para obtener los cuartiles (el valor predeterminado), en 10 para obtener los deciles y en 100 para obtener los percentiles (lo que produce 99 límites que separan los datos en 100 grupos del mismo tamaño).
@end deffn

@geindex zscore() (método de statistics.NormalDist)
@anchor{library/statistics statistics NormalDist zscore}@anchor{2716}
@deffn {Método} zscore (x)

Computa el Standard Score@footnote{https://www.statisticshowto.com/probability-and-statistics/z-score/} describiendo `x' en términos de los números de desviaciones estándar sobre o bajo la media de una distribución normal: @code{(x - mean) / stdev}.


Added in version 3.9.

@end deffn

Las instancias de la clase @ref{aca,,NormalDist} soportan la suma, resta, multiplicación y división por una constante. Estas operaciones se pueden utilizar para traducir o escalar, por ejemplo:

@example
>>> temperature_february = NormalDist(5, 2.5)             # Celsius
>>> temperature_february * (9/5) + 32                     # Fahrenheit
NormalDist(mu=41.0, sigma=4.5)
@end example

No se admite la división de una constante entre una instancia de @ref{aca,,NormalDist} debido a que el resultado no sería una distribución normal.

Dado que las distribuciones normales se derivan de las propiedades aditivas de variables independientes, es posible sumar o restar dos variables independientes con distribución normal@footnote{https://en.wikipedia.org/wiki/Sum_of_normally_distributed_random_variables} representadas por instancias de @ref{aca,,NormalDist}. Por ejemplo :

@example
>>> birth_weights = NormalDist.from_samples([2.5, 3.1, 2.1, 2.4, 2.7, 3.5])
>>> drug_effects = NormalDist(0.4, 0.15)
>>> combined = birth_weights + drug_effects
>>> round(combined.mean, 1)
3.1
>>> round(combined.stdev, 1)
0.5
@end example


Added in version 3.8.

@end deffn

@node Examples and Recipes,,Objetos NormalDist,statistics — Mathematical statistics functions
@anchor{library/statistics examples-and-recipes}@anchor{2717}
@subsubsection Examples and Recipes


@menu
* Problemas de probabilidad clásicos:: 
* Entradas de Monte Carlo para simulaciones:: 
* Aproximación de la distribución binomial:: 
* Clasificador bayesiano ingenuo:: 

@end menu

@node Problemas de probabilidad clásicos,Entradas de Monte Carlo para simulaciones,,Examples and Recipes
@anchor{library/statistics classic-probability-problems}@anchor{2718}
@subsubsection Problemas de probabilidad clásicos


@ref{aca,,NormalDist} permite resolver fácilmente problemas probabilísticos clásicos.

Por ejemplo, sabiendo que los datos históricos de los exámenes SAT@footnote{https://nces.ed.gov/programs/digest/d17/tables/dt17_226.40.asp} siguen una distribución normal con una media de 1060 y una desviación típica de 195, determinar el porcentaje de estudiantes con puntuaciones entre 1100 y 1200, redondeado al número entero más cercano:

@example
>>> sat = NormalDist(1060, 195)
>>> fraction = sat.cdf(1200 + 0.5) - sat.cdf(1100 - 0.5)
>>> round(fraction * 100.0, 1)
18.4
@end example

Determinar los cuartiles@footnote{https://es.wikipedia.org/wiki/Cuartil} y deciles@footnote{https://es.wikipedia.org/wiki/Decil_(estad%C3%ADstica)} de las puntuaciones del SAT:

@example
>>> list(map(round, sat.quantiles()))
[928, 1060, 1192]
>>> list(map(round, sat.quantiles(n=10)))
[810, 896, 958, 1011, 1060, 1109, 1162, 1224, 1310]
@end example

@node Entradas de Monte Carlo para simulaciones,Aproximación de la distribución binomial,Problemas de probabilidad clásicos,Examples and Recipes
@anchor{library/statistics monte-carlo-inputs-for-simulations}@anchor{2719}
@subsubsection Entradas de Monte Carlo para simulaciones


To estimate the distribution for a model that isn’t easy to solve
analytically, @ref{aca,,NormalDist} can generate input samples for a Monte Carlo simulation@footnote{https://en.wikipedia.org/wiki/Monte_Carlo_method}:

@example
>>> def model(x, y, z):
...     return (3*x + 7*x*y - 5*y) / (11 * z)
...
>>> n = 100_000
>>> X = NormalDist(10, 2.5).samples(n, seed=3652260728)
>>> Y = NormalDist(15, 1.75).samples(n, seed=4582495471)
>>> Z = NormalDist(50, 1.25).samples(n, seed=6582483453)
>>> quantiles(map(model, X, Y, Z))       
[1.4591308524824727, 1.8035946855390597, 2.175091447274739]
@end example

@node Aproximación de la distribución binomial,Clasificador bayesiano ingenuo,Entradas de Monte Carlo para simulaciones,Examples and Recipes
@anchor{library/statistics approximating-binomial-distributions}@anchor{271a}
@subsubsection Aproximación de la distribución binomial


Las distribuciones normales se pueden utilizar para aproximar distribuciones binomiales@footnote{https://mathworld.wolfram.com/BinomialDistribution.html} cuando el tamaño de la muestra es grande y la probabilidad de un ensayo exitoso es cercana al 50%.

Por ejemplo, 750 personas asisten a una conferencia sobre código abierto y se dispone de dos salas con capacidad para 500 personas cada una. En la primera sala hay una charla sobre Python, en la otra una sobre Ruby. En conferencias pasadas, el 65% de las personas prefirieron escuchar las charlas sobre Python. Suponiendo que las preferencias de la población no hayan cambiado, ¿cuál es la probabilidad de que la sala de Python permanezca por debajo de su capacidad máxima?

@example
>>> n = 750             # Sample size
>>> p = 0.65            # Preference for Python
>>> q = 1.0 - p         # Preference for Ruby
>>> k = 500             # Room capacity

>>> # Approximation using the cumulative normal distribution
>>> from math import sqrt
>>> round(NormalDist(mu=n*p, sigma=sqrt(n*p*q)).cdf(k + 0.5), 4)
0.8402

>>> # Exact solution using the cumulative binomial distribution
>>> from math import comb, fsum
>>> round(fsum(comb(n, r) * p**r * q**(n-r) for r in range(k+1)), 4)
0.8402

>>> # Approximation using a simulation
>>> from random import seed, binomialvariate
>>> seed(8675309)
>>> mean(binomialvariate(n, p) <= k for i in range(10_000))
0.8406
@end example

@node Clasificador bayesiano ingenuo,,Aproximación de la distribución binomial,Examples and Recipes
@anchor{library/statistics naive-bayesian-classifier}@anchor{271b}
@subsubsection Clasificador bayesiano ingenuo


Las distribuciones normales a menudo están involucradas en el aprendizaje automático.

Wikipedia detalla un buen ejemplo de un clasificador bayesiano ingenuo@footnote{https://es.wikipedia.org/wiki/Clasificador_bayesiano_ingenuo}. El reto consiste en predecir el género de una persona a partir de características físicas que siguen una distribución normal, como la altura, el peso y el tamaño del pie.

Disponemos de un conjunto de datos de entrenamiento que contiene las medidas de ocho personas. Se supone que estas medidas siguen una distribución normal, por lo que podemos sintetizar los datos usando @ref{aca,,NormalDist}:

@example
>>> height_male = NormalDist.from_samples([6, 5.92, 5.58, 5.92])
>>> height_female = NormalDist.from_samples([5, 5.5, 5.42, 5.75])
>>> weight_male = NormalDist.from_samples([180, 190, 170, 165])
>>> weight_female = NormalDist.from_samples([100, 150, 130, 150])
>>> foot_size_male = NormalDist.from_samples([12, 11, 12, 10])
>>> foot_size_female = NormalDist.from_samples([6, 8, 7, 9])
@end example

A continuación, nos encontramos con un nuevo individuo del que conocemos las medidas de sus características pero no su género:

@example
>>> ht = 6.0        # height
>>> wt = 130        # weight
>>> fs = 8          # foot size
@end example

Partiendo de una probabilidad a priori@footnote{https://es.wikipedia.org/wiki/Probabilidad_a_priori} del 50% de ser hombre o mujer, calculamos la probabilidad a posteriori como el producto de la probabilidad a priori y la verosimilitud de las diferentes medidas dado el género:

@example
>>> prior_male = 0.5
>>> prior_female = 0.5
>>> posterior_male = (prior_male * height_male.pdf(ht) *
...                   weight_male.pdf(wt) * foot_size_male.pdf(fs))

>>> posterior_female = (prior_female * height_female.pdf(ht) *
...                     weight_female.pdf(wt) * foot_size_female.pdf(fs))
@end example

La predicción final es la que tiene mayor probabilidad a posteriori. Este enfoque se denomina máximo a posteriori@footnote{https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation} o MAP:

@example
>>> 'male' if posterior_male > posterior_female else 'female'
'female'
@end example

@c # This modelines must appear within the last ten lines of the file.
@c kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8;

@node Módulos de programación funcional,Acceso a archivos y directorios,Módulos numéricos y matemáticos,La biblioteca estándar de Python
@anchor{library/functional doc}@anchor{271c}@anchor{library/functional functional-programming-modules}@anchor{271d}
@section Módulos de programación funcional


Los módulos descritos en este capítulo proporcionan funciones y clases que admiten un estilo de programación funcional y operaciones generales invocables (`callables').

En este capítulo se documentan los siguientes módulos:

@menu
* itertools — Functions creating iterators for efficient looping:: 
* functools — Higher-order functions and operations on callable objects:: 
* operator — Standard operators as functions:: 

@end menu

@node itertools — Functions creating iterators for efficient looping,functools — Higher-order functions and operations on callable objects,,Módulos de programación funcional
@anchor{library/itertools doc}@anchor{271e}@anchor{library/itertools itertools-functions-creating-iterators-for-efficient-looping}@anchor{271f}@anchor{library/itertools module-itertools}@anchor{81}
@subsection @code{itertools} — Functions creating iterators for efficient looping


@geindex module; itertools

@c from itertools import *
@c import collections
@c import math
@c import operator
@c import random


__________________________________________________________________


Este módulo implementa un número de piezas básicas @ref{313,,iterator} inspiradas en `constructs' de APL, Haskell y SML.  Cada pieza ha sido reconvertida a una forma apropiada para Python.

El módulo estandariza un conjunto base de herramientas rápidas y eficientes en memoria, útiles por sí mismas o en combinación con otras.  Juntas, forman un «álgebra de iteradores», haciendo posible la construcción de herramientas especializadas, sucintas y eficientes, en Python puro.

Por ejemplo, SML provee una herramienta de tabulación @code{tabulate(f)}, que produce una secuencia @code{f(0), f(1), ...}.  En Python, se puede lograr el mismo efecto al combinar @ref{14c,,map()} y @ref{12f0,,count()} para formar @code{map(f, count())}.

These tools and their built-in counterparts also work well with the high-speed
functions in the @ref{9f,,operator} module.  For example, the multiplication
operator can be mapped across two vectors to form an efficient dot-product:
@code{sum(starmap(operator.mul, zip(vec1, vec2, strict=True)))}.

`Iteradores infinitos:'


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultados

@tab

Ejemplo

@item

@ref{12f0,,count()}

@tab

[start[, step]]

@tab

start, start+step, start+2*step, …

@tab

@code{count(10) → 10 11 12 13 14 ...}

@item

@ref{2720,,cycle()}

@tab

p

@tab

p0, p1, … plast, p0, p1, …

@tab

@code{cycle('ABCD') → A B C D A B C D ...}

@item

@ref{2721,,repeat()}

@tab

elem [,n]

@tab

elem, elem, elem, … indefinidamente o hasta n veces

@tab

@code{repeat(10, 3) → 10 10 10}

@end multitable


`Iteradores que terminan en la secuencia de entrada más corta:'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultados

@tab

Ejemplo

@item

@ref{a8f,,accumulate()}

@tab

p [,func]

@tab

p0, p0+p1, p0+p1+p2, …

@tab

@code{accumulate([1,2,3,4,5]) → 1 3 6 10 15}

@item

@ref{35f,,batched()}

@tab

p, n

@tab

(p0, p1, …, p_n-1), …

@tab

@code{batched('ABCDEFG', n=3) → ABC DEF G}

@item

@ref{2187,,chain()}

@tab

p, q, …

@tab

p0, p1, … plast, q0, q1, …

@tab

@code{chain('ABC', 'DEF') → A B C D E F}

@item

@ref{2722,,chain.from_iterable()}

@tab

iterable

@tab

p0, p1, … plast, q0, q1, …

@tab

@code{chain.from_iterable(['ABC', 'DEF']) → A B C D E F}

@item

@ref{12ef,,compress()}

@tab

data, selectors

@tab

(d[0] if s[0]), (d[1] if s[1]), …

@tab

@code{compress('ABCDEF', [1,0,1,0,1,1]) → A C E F}

@item

@ref{2723,,dropwhile()}

@tab

predicate, seq

@tab

seq[n], seq[n+1], starting when predicate fails

@tab

@code{dropwhile(lambda x: x<5, [1,4,6,3,8]) → 6 3 8}

@item

@ref{216e,,filterfalse()}

@tab

predicate, seq

@tab

elements of seq where predicate(elem) fails

@tab

@code{filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8}

@item

@ref{2724,,groupby()}

@tab

iterable[, key]

@tab

sub-iteradores agrupados según el valor de key(v)

@tab

@code{groupby(['A','B','DEF'], len) → (1, A B) (3, DEF)}

@item

@ref{bd4,,islice()}

@tab

seq, [start,] stop [, step]

@tab

elementos de seq[start:stop:step]

@tab

@code{islice('ABCDEFG', 2, None) → C D E F G}

@item

@ref{8ac,,pairwise()}

@tab

iterable

@tab

(p[0], p[1]), (p[1], p[2])

@tab

@code{pairwise('ABCDEFG') → AB BC CD DE EF FG}

@item

@ref{1157,,starmap()}

@tab

func, seq

@tab

func(*seq[0]), func(*seq[1]), …

@tab

@code{starmap(pow, [(2,5), (3,2), (10,3)]) → 32 9 1000}

@item

@ref{2725,,takewhile()}

@tab

predicate, seq

@tab

seq[0], seq[1], until predicate fails

@tab

@code{takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4}

@item

@ref{2726,,tee()}

@tab

it, n

@tab

it1, it2, … itn  divide un iterador en n

@tab

@code{tee('ABC', 2) → A B C, A B C}

@item

@ref{130a,,zip_longest()}

@tab

p, q, …

@tab

(p[0], q[0]), (p[1], q[1]), …

@tab

@code{zip_longest('ABCD', 'xy', fillvalue='-') → Ax By C- D-}

@end multitable


`Iteradores combinatorios:'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultados

@item

@ref{1924,,product()}

@tab

p, q, … [repeat=1]

@tab

producto cartesiano, equivalente a un bucle @cite{for} anidado

@item

@ref{1923,,permutations()}

@tab

p[, r]

@tab

tuplas de longitud r, en todas los órdenes posibles, sin elementos repetidos

@item

@ref{137a,,combinations()}

@tab

p, r

@tab

tuplas de longitud r, ordenadas, sin elementos repetidos

@item

@ref{12ee,,combinations_with_replacement()}

@tab

p, r

@tab

tuplas de longitud r, ordenadas, con elementos repetidos

@end multitable



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Ejemplos

@tab

Resultados

@item

@code{product('ABCD', repeat=2)}

@tab

@code{AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD}

@item

@code{permutations('ABCD', 2)}

@tab

@code{AB AC AD BA BC BD CA CB CD DA DB DC}

@item

@code{combinations('ABCD', 2)}

@tab

@code{AB AC AD BC BD CD}

@item

@code{combinations_with_replacement('ABCD', 2)}

@tab

@code{AA AB AC AD BB BC BD CC CD DD}

@end multitable


@menu
* Itertool Functions:: 
* Fórmulas con itertools:: 

@end menu

@node Itertool Functions,Fórmulas con itertools,,itertools — Functions creating iterators for efficient looping
@anchor{library/itertools itertool-functions}@anchor{2727}@anchor{library/itertools itertools-functions}@anchor{2728}
@subsubsection Itertool Functions


The following functions all construct and return iterators. Some provide
streams of infinite length, so they should only be accessed by functions or
loops that truncate the stream.

@geindex accumulate() (en el módulo itertools)
@anchor{library/itertools itertools accumulate}@anchor{a8f}
@deffn {Función} itertools.accumulate (iterable[, function, *, initial=None])

Make an iterator that returns accumulated sums or accumulated
results from other binary functions.

The `function' defaults to addition.  The `function' should accept
two arguments, an accumulated total and a value from the `iterable'.

If an `initial' value is provided, the accumulation will start with
that value and the output will have one more element than the input
iterable.

Aproximadamente equivalente a:

@example
def accumulate(iterable, function=operator.add, *, initial=None):
    'Return running totals'
    # accumulate([1,2,3,4,5]) → 1 3 6 10 15
    # accumulate([1,2,3,4,5], initial=100) → 100 101 103 106 110 115
    # accumulate([1,2,3,4,5], operator.mul) → 1 2 6 24 120

    iterator = iter(iterable)
    total = initial
    if initial is None:
        try:
            total = next(iterator)
        except StopIteration:
            return

    yield total
    for element in iterator:
        total = function(total, element)
        yield total
@end example

To compute a running minimum, set `function' to @ref{f8b,,min()}.
For a running maximum, set `function' to @ref{f8c,,max()}.
Or for a running product, set `function' to @ref{2729,,operator.mul()}.
To build an amortization table@footnote{https://www.ramseysolutions.com/real-estate/amortization-schedule},
accumulate the interest and apply payments:

@example
>>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
>>> list(accumulate(data, max))              # running maximum
[3, 4, 6, 6, 6, 9, 9, 9, 9, 9]
>>> list(accumulate(data, operator.mul))     # running product
[3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]

# Amortize a 5% loan of 1000 with 10 annual payments of 90
>>> update = lambda balance, payment: round(balance * 1.05) - payment
>>> list(accumulate(repeat(90, 10), update, initial=1_000))
[1000, 960, 918, 874, 828, 779, 728, 674, 618, 559, 497]
@end example

Para una función similar que retorne únicamente el valor final acumulado, revisa @ref{17d,,functools.reduce()}.


Added in version 3.2.



Distinto en la versión 3.3: Added the optional `function' parameter.



Distinto en la versión 3.8: Adicionó el argumento opcional `initial'.

@end deffn

@geindex batched() (en el módulo itertools)
@anchor{library/itertools itertools batched}@anchor{35f}
@deffn {Función} itertools.batched (iterable, n, *, strict=False)

Batch data from the `iterable' into tuples of length `n'. The last
batch may be shorter than `n'.

If `strict' is true, will raise a @ref{360,,ValueError} if the final
batch is shorter than `n'.

Loops over the input iterable and accumulates data into tuples up to
size `n'.  The input is consumed lazily, just enough to fill a batch.
The result is yielded as soon as the batch is full or when the input
iterable is exhausted:

@example
>>> flattened_data = ['roses', 'red', 'violets', 'blue', 'sugar', 'sweet']
>>> unflattened = list(batched(flattened_data, 2))
>>> unflattened
[('roses', 'red'), ('violets', 'blue'), ('sugar', 'sweet')]
@end example

Aproximadamente equivalente a:

@example
def batched(iterable, n, *, strict=False):
    # batched('ABCDEFG', 3) → ABC DEF G
    if n < 1:
        raise ValueError('n must be at least one')
    iterator = iter(iterable)
    while batch := tuple(islice(iterator, n)):
        if strict and len(batch) != n:
            raise ValueError('batched(): incomplete batch')
        yield batch
@end example


Added in version 3.12.



Distinto en la versión 3.13: Added the `strict' option.

@end deffn

@geindex chain() (en el módulo itertools)
@anchor{library/itertools itertools chain}@anchor{2187}
@deffn {Función} itertools.chain (*iterables)

Make an iterator that returns elements from the first iterable until
it is exhausted, then proceeds to the next iterable, until all of the
iterables are exhausted.  This combines multiple data sources into a
single iterator.  Roughly equivalent to:

@example
def chain(*iterables):
    # chain('ABC', 'DEF') → A B C D E F
    for iterable in iterables:
        yield from iterable
@end example
@end deffn

@geindex from_iterable() (método de clase de itertools.chain)
@anchor{library/itertools itertools chain from_iterable}@anchor{2722}
@deffn {Método} classmethod chain.from_iterable (iterable)

Constructor alternativo para @ref{2187,,chain()}.  Obtiene entradas enlazadas de un mismo argumento que se evalúa perezosamente.  Aproximadamente equivalente a:

@example
def from_iterable(iterables):
    # chain.from_iterable(['ABC', 'DEF']) → A B C D E F
    for iterable in iterables:
        yield from iterable
@end example
@end deffn

@geindex combinations() (en el módulo itertools)
@anchor{library/itertools itertools combinations}@anchor{137a}
@deffn {Función} itertools.combinations (iterable, r)

Retorna subsecuencias de longitud `r' con elementos del `iterable' de entrada.

The output is a subsequence of @ref{1924,,product()} keeping only entries that
are subsequences of the `iterable'.  The length of the output is given
by @ref{770,,math.comb()} which computes @code{n! / r! / (n - r)!} when @code{0 ≤ r
≤ n} or zero when @code{r > n}.

The combination tuples are emitted in lexicographic order according to
the order of the input `iterable'. If the input `iterable' is sorted,
the output tuples will be produced in sorted order.

Elements are treated as unique based on their position, not on their
value.  If the input elements are unique, there will be no repeated
values within each combination.

Aproximadamente equivalente a:

@example
def combinations(iterable, r):
    # combinations('ABCD', 2) → AB AC AD BC BD CD
    # combinations(range(4), 3) → 012 013 023 123

    pool = tuple(iterable)
    n = len(pool)
    if r > n:
        return
    indices = list(range(r))

    yield tuple(pool[i] for i in indices)
    while True:
        for i in reversed(range(r)):
            if indices[i] != i + n - r:
                break
        else:
            return
        indices[i] += 1
        for j in range(i+1, r):
            indices[j] = indices[j-1] + 1
        yield tuple(pool[i] for i in indices)
@end example
@end deffn

@geindex combinations_with_replacement() (en el módulo itertools)
@anchor{library/itertools itertools combinations_with_replacement}@anchor{12ee}
@deffn {Función} itertools.combinations_with_replacement (iterable, r)

Retorna subsecuencias, de longitud `r', con elementos del `iterable' de entrada, permitiendo que haya elementos individuales repetidos más de una vez.

The output is a subsequence of @ref{1924,,product()} that keeps only entries
that are subsequences (with possible repeated elements) of the
`iterable'.  The number of subsequence returned is @code{(n + r - 1)! / r! /
(n - 1)!} when @code{n > 0}.

The combination tuples are emitted in lexicographic order according to
the order of the input `iterable'. if the input `iterable' is sorted,
the output tuples will be produced in sorted order.

Elements are treated as unique based on their position, not on their
value.  If the input elements are unique, the generated combinations
will also be unique.

Aproximadamente equivalente a:

@example
def combinations_with_replacement(iterable, r):
    # combinations_with_replacement('ABC', 2) → AA AB AC BB BC CC

    pool = tuple(iterable)
    n = len(pool)
    if not n and r:
        return
    indices = [0] * r

    yield tuple(pool[i] for i in indices)
    while True:
        for i in reversed(range(r)):
            if indices[i] != n - 1:
                break
        else:
            return
        indices[i:] = [indices[i] + 1] * (r - i)
        yield tuple(pool[i] for i in indices)
@end example


Added in version 3.1.

@end deffn

@geindex compress() (en el módulo itertools)
@anchor{library/itertools itertools compress}@anchor{12ef}
@deffn {Función} itertools.compress (data, selectors)

Make an iterator that returns elements from `data' where the
corresponding element in `selectors' is true.  Stops when either the
`data' or `selectors' iterables have been exhausted.  Roughly
equivalent to:

@example
def compress(data, selectors):
    # compress('ABCDEF', [1,0,1,0,1,1]) → A C E F
    return (datum for datum, selector in zip(data, selectors) if selector)
@end example


Added in version 3.1.

@end deffn

@geindex count() (en el módulo itertools)
@anchor{library/itertools itertools count}@anchor{12f0}
@deffn {Función} itertools.count (start=0, step=1)

Make an iterator that returns evenly spaced values beginning with
`start'. Can be used with @ref{14c,,map()} to generate consecutive data
points or with @ref{14d,,zip()} to add sequence numbers.  Roughly
equivalent to:

@example
def count(start=0, step=1):
    # count(10) → 10 11 12 13 14 ...
    # count(2.5, 0.5) → 2.5 3.0 3.5 ...
    n = start
    while True:
        yield n
        n += step
@end example

When counting with floating-point numbers, better accuracy can sometimes be
achieved by substituting multiplicative code such as: @code{(start + step * i
for i in count())}.


Distinto en la versión 3.1: Se adicionó el argumento `step' y se permitieron argumentos diferentes a enteros.

@end deffn

@geindex cycle() (en el módulo itertools)
@anchor{library/itertools itertools cycle}@anchor{2720}
@deffn {Función} itertools.cycle (iterable)

Make an iterator returning elements from the `iterable' and saving a
copy of each.  When the iterable is exhausted, return elements from
the saved copy.  Repeats indefinitely.  Roughly equivalent to:

@example
def cycle(iterable):
    # cycle('ABCD') → A B C D A B C D A B C D ...

    saved = []
    for element in iterable:
        yield element
        saved.append(element)

    while saved:
        for element in saved:
            yield element
@end example

This itertool may require significant auxiliary storage (depending on
the length of the iterable).
@end deffn

@geindex dropwhile() (en el módulo itertools)
@anchor{library/itertools itertools dropwhile}@anchor{2723}
@deffn {Función} itertools.dropwhile (predicate, iterable)

Make an iterator that drops elements from the `iterable' while the
`predicate' is true and afterwards returns every element.  Roughly
equivalent to:

@example
def dropwhile(predicate, iterable):
    # dropwhile(lambda x: x<5, [1,4,6,3,8]) → 6 3 8

    iterator = iter(iterable)
    for x in iterator:
        if not predicate(x):
            yield x
            break

    for x in iterator:
        yield x
@end example

Note this does not produce `any' output until the predicate first
becomes false, so this itertool may have a lengthy start-up time.
@end deffn

@geindex filterfalse() (en el módulo itertools)
@anchor{library/itertools itertools filterfalse}@anchor{216e}
@deffn {Función} itertools.filterfalse (predicate, iterable)

Make an iterator that filters elements from the `iterable' returning
only those for which the `predicate' returns a false value.  If
`predicate' is @code{None}, returns the items that are false.  Roughly
equivalent to:

@example
def filterfalse(predicate, iterable):
    # filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8

    if predicate is None:
        predicate = bool

    for x in iterable:
        if not predicate(x):
            yield x
@end example
@end deffn

@geindex groupby() (en el módulo itertools)
@anchor{library/itertools itertools groupby}@anchor{2724}
@deffn {Función} itertools.groupby (iterable, key=None)

Crea un iterador que retorna claves consecutivas y grupos del `iterable'. `key' es una función que calcula un valor clave para cada elemento.  Si no se especifica o es @code{None}, `key' es una función de identidad por defecto y retorna el elemento sin cambios.  Generalmente, el iterable necesita estar ordenado con la misma función `key'.

El funcionamiento de @ref{2724,,groupby()} es similar al del filtro @code{uniq} en Unix.  Genera un salto o un nuevo grupo cada vez que el valor de la función clave cambia (por lo que usualmente es necesario ordenar los datos usando la misma función clave).  Ese comportamiento difiere del de GROUP BY de SQL, el cual agrega elementos comunes sin importar el orden de entrada.

El grupo retornado es un iterador mismo que comparte el iterable subyacente con @ref{2724,,groupby()}.  Al compartir la fuente, cuando el objeto @ref{2724,,groupby()} se avanza, el grupo previo deja de ser visible.  En ese caso, si los datos se necesitan posteriormente, se deberían almacenar como lista:

@example
groups = []
uniquekeys = []
data = sorted(data, key=keyfunc)
for k, g in groupby(data, keyfunc):
    groups.append(list(g))      # Store group iterator as a list
    uniquekeys.append(k)
@end example

@ref{2724,,groupby()} es aproximadamente equivalente a:

@example
def groupby(iterable, key=None):
    # [k for k, g in groupby('AAAABBBCCDAABBB')] → A B C D A B
    # [list(g) for k, g in groupby('AAAABBBCCD')] → AAAA BBB CC D

    keyfunc = (lambda x: x) if key is None else key
    iterator = iter(iterable)
    exhausted = False

    def _grouper(target_key):
        nonlocal curr_value, curr_key, exhausted
        yield curr_value
        for curr_value in iterator:
            curr_key = keyfunc(curr_value)
            if curr_key != target_key:
                return
            yield curr_value
        exhausted = True

    try:
        curr_value = next(iterator)
    except StopIteration:
        return
    curr_key = keyfunc(curr_value)

    while not exhausted:
        target_key = curr_key
        curr_group = _grouper(target_key)
        yield curr_key, curr_group
        if curr_key == target_key:
            for _ in curr_group:
                pass
@end example
@end deffn

@geindex islice() (en el módulo itertools)
@anchor{library/itertools itertools islice}@anchor{bd4}
@deffn {Función} itertools.islice (iterable, stop)

@deffnx {Función} itertools.islice (iterable, start, stop[, step])

Make an iterator that returns selected elements from the iterable.
Works like sequence slicing but does not support negative values for
`start', `stop', or `step'.

If `start' is zero or @code{None}, iteration starts at zero.  Otherwise,
elements from the iterable are skipped until `start' is reached.

If `stop' is @code{None}, iteration continues until the input is
exhausted, if at all.  Otherwise, it stops at the specified position.

If `step' is @code{None}, the step defaults to one.  Elements are returned
consecutively unless `step' is set higher than one which results in
items being skipped.

Aproximadamente equivalente a:

@example
def islice(iterable, *args):
    # islice('ABCDEFG', 2) → A B
    # islice('ABCDEFG', 2, 4) → C D
    # islice('ABCDEFG', 2, None) → C D E F G
    # islice('ABCDEFG', 0, None, 2) → A C E G

    s = slice(*args)
    start = 0 if s.start is None else s.start
    stop = s.stop
    step = 1 if s.step is None else s.step
    if start < 0 or (stop is not None and stop < 0) or step <= 0:
        raise ValueError

    indices = count() if stop is None else range(max(start, stop))
    next_i = start
    for i, element in zip(indices, iterable):
        if i == next_i:
            yield element
            next_i += step
@end example

If the input is an iterator, then fully consuming the `islice'
advances the input iterator by @code{max(start, stop)} steps regardless
of the `step' value.
@end deffn

@geindex pairwise() (en el módulo itertools)
@anchor{library/itertools itertools pairwise}@anchor{8ac}
@deffn {Función} itertools.pairwise (iterable)

Retorna los sucesivos pares superpuestos tomados de la entrada `iterable'.

El número de tuplas de 2 elementos en el iterador de salida será uno menos que el número de entradas. Estará vacío si la entrada iterable tiene menos de dos valores.

Aproximadamente equivalente a:

@example
def pairwise(iterable):
    # pairwise('ABCDEFG') → AB BC CD DE EF FG

    iterator = iter(iterable)
    a = next(iterator, None)

    for b in iterator:
        yield a, b
        a = b
@end example


Added in version 3.10.

@end deffn

@geindex permutations() (en el módulo itertools)
@anchor{library/itertools itertools permutations}@anchor{1923}
@deffn {Función} itertools.permutations (iterable, r=None)

Return successive `r' length permutations of elements@footnote{https://www.britannica.com/science/permutation} from the `iterable'.

Si `r' no es especificado o si es @code{None}, entonces por defecto `r' será igual a la longitud de `iterable' y todas las permutaciones de máxima longitud serán generadas.

The output is a subsequence of @ref{1924,,product()} where entries with
repeated elements have been filtered out.  The length of the output is
given by @ref{771,,math.perm()} which computes @code{n! / (n - r)!} when
@code{0 ≤ r ≤ n} or zero when @code{r > n}.

The permutation tuples are emitted in lexicographic order according to
the order of the input `iterable'.  If the input `iterable' is sorted,
the output tuples will be produced in sorted order.

Elements are treated as unique based on their position, not on their
value.  If the input elements are unique, there will be no repeated
values within a permutation.

Aproximadamente equivalente a:

@example
def permutations(iterable, r=None):
    # permutations('ABCD', 2) → AB AC AD BA BC BD CA CB CD DA DB DC
    # permutations(range(3)) → 012 021 102 120 201 210

    pool = tuple(iterable)
    n = len(pool)
    r = n if r is None else r
    if r > n:
        return

    indices = list(range(n))
    cycles = list(range(n, n-r, -1))
    yield tuple(pool[i] for i in indices[:r])

    while n:
        for i in reversed(range(r)):
            cycles[i] -= 1
            if cycles[i] == 0:
                indices[i:] = indices[i+1:] + indices[i:i+1]
                cycles[i] = n - i
            else:
                j = cycles[i]
                indices[i], indices[-j] = indices[-j], indices[i]
                yield tuple(pool[i] for i in indices[:r])
                break
        else:
            return
@end example
@end deffn

@geindex product() (en el módulo itertools)
@anchor{library/itertools itertools product}@anchor{1924}
@deffn {Función} itertools.product (*iterables, repeat=1)

Cartesian product@footnote{https://en.wikipedia.org/wiki/Cartesian_product}
of the input iterables.

Aproximadamente equivalente a tener bucles @cite{for} anidados en un generador. Por ejemplo, @code{product(A, B)} es equivalente a @code{((x,y) for x in A for y in B)}.

Los bucles anidados hacen ciclos como un cuentapasos o taxímetro, con el elemento más hacia la derecha avanzando en cada iteración.  Este patrón crea un orden lexicográfico en el que, si los iterables de entrada están ordenados, las tuplas producidas son emitidas de manera ordenada.

Para calcular el producto de un iterable consigo mismo, especifica el número de repeticiones con el argumento opcional `repeat'.  Por ejemplo, @code{product(A, repeat=4)} es equivalente a @code{product(A, A, A, A)}.

Esta función es aproximadamente equivalente al código siguiente, exceptuando que la implementación real no acumula resultados intermedios en memoria:

@example
def product(*iterables, repeat=1):
    # product('ABCD', 'xy') → Ax Ay Bx By Cx Cy Dx Dy
    # product(range(2), repeat=3) → 000 001 010 011 100 101 110 111

    if repeat < 0:
        raise ValueError('repeat argument cannot be negative')
    pools = [tuple(pool) for pool in iterables] * repeat

    result = [[]]
    for pool in pools:
        result = [x+[y] for x in result for y in pool]

    for prod in result:
        yield tuple(prod)
@end example

Antes de que @ref{1924,,product()} se ejecute, consume completamente los iterables de entrada, manteniendo grupos de valores en la memoria para generar los productos. En consecuencia, solo es útil con entradas finitas.
@end deffn

@geindex repeat() (en el módulo itertools)
@anchor{library/itertools itertools repeat}@anchor{2721}
@deffn {Función} itertools.repeat (object[, times])

Crea un iterador que retorna `object' una y otra vez. Se ejecuta indefinidamente a menos que se especifique el argumento `times'.

Aproximadamente equivalente a:

@example
def repeat(object, times=None):
    # repeat(10, 3) → 10 10 10
    if times is None:
        while True:
            yield object
    else:
        for i in range(times):
            yield object
@end example

Un uso común de `repeat' es proporcionar un flujo de valores constantes a `map' o `zip':

@example
>>> list(map(pow, range(10), repeat(2)))
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@end example
@end deffn

@geindex starmap() (en el módulo itertools)
@anchor{library/itertools itertools starmap}@anchor{1157}
@deffn {Función} itertools.starmap (function, iterable)

Make an iterator that computes the `function' using arguments obtained
from the `iterable'.  Used instead of @ref{14c,,map()} when argument
parameters have already been «pre-zipped» into tuples.

La diferencia entre @ref{14c,,map()} y @ref{1157,,starmap()} es paralela a la distinción entre @code{function(a,b)} y @code{function(*c)}. Aproximadamente equivalente a:

@example
def starmap(function, iterable):
    # starmap(pow, [(2,5), (3,2), (10,3)]) → 32 9 1000
    for args in iterable:
        yield function(*args)
@end example
@end deffn

@geindex takewhile() (en el módulo itertools)
@anchor{library/itertools itertools takewhile}@anchor{2725}
@deffn {Función} itertools.takewhile (predicate, iterable)

Make an iterator that returns elements from the `iterable' as long as
the `predicate' is true.  Roughly equivalent to:

@example
def takewhile(predicate, iterable):
    # takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4
    for x in iterable:
        if not predicate(x):
            break
        yield x
@end example

Note, the element that first fails the predicate condition is
consumed from the input iterator and there is no way to access it.
This could be an issue if an application wants to further consume the
input iterator after `takewhile' has been run to exhaustion.  To work
around this problem, consider using more-iterools before_and_after()@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.before_and_after}
instead.
@end deffn

@geindex tee() (en el módulo itertools)
@anchor{library/itertools itertools tee}@anchor{2726}
@deffn {Función} itertools.tee (iterable, n=2)

Retorna `n' iteradores independientes de un mismo iterador.

Aproximadamente equivalente a:

@example
def tee(iterable, n=2):
    if n < 0:
        raise ValueError
    if n == 0:
        return ()
    iterator = _tee(iterable)
    result = [iterator]
    for _ in range(n - 1):
        result.append(_tee(iterator))
    return tuple(result)

class _tee:

    def __init__(self, iterable):
        it = iter(iterable)
        if isinstance(it, _tee):
            self.iterator = it.iterator
            self.link = it.link
        else:
            self.iterator = it
            self.link = [None, None]

    def __iter__(self):
        return self

    def __next__(self):
        link = self.link
        if link[1] is None:
            link[0] = next(self.iterator)
            link[1] = [None, None]
        value, self.link = link
        return value
@end example

When the input `iterable' is already a tee iterator object, all
members of the return tuple are constructed as if they had been
produced by the upstream @ref{2726,,tee()} call.  This «flattening step»
allows nested @ref{2726,,tee()} calls to share the same underlying data
chain and to have a single update step rather than a chain of calls.

The flattening property makes tee iterators efficiently peekable:

@example
def lookahead(tee_iterator):
     "Return the next value without moving the input forward"
     [forked_iterator] = tee(tee_iterator, 1)
     return next(forked_iterator)
@end example

@example
>>> iterator = iter('abcdef')
>>> [iterator] = tee(iterator, 1)   # Make the input peekable
>>> next(iterator)                  # Move the iterator forward
'a'
>>> lookahead(iterator)             # Check next value
'b'
>>> next(iterator)                  # Continue moving forward
'b'
@end example

@code{tee} iterators are not threadsafe. A @ref{1e5,,RuntimeError} may be
raised when simultaneously using iterators returned by the same @ref{2726,,tee()}
call, even if the original `iterable' is threadsafe.

Esta herramienta de iteración puede requerir almacenamiento auxiliar significativo (dependiendo de qué tantos datos necesitan ser almacenados). En general, si un iterador utiliza todos o la mayoría de los datos antes que otro iterador comience, es más rápido utilizar @ref{18e,,list()} en vez de @ref{2726,,tee()}.
@end deffn

@geindex zip_longest() (en el módulo itertools)
@anchor{library/itertools itertools zip_longest}@anchor{130a}
@deffn {Función} itertools.zip_longest (*iterables, fillvalue=None)

Make an iterator that aggregates elements from each of the
`iterables'.

If the iterables are of uneven length, missing values are filled-in
with `fillvalue'.  If not specified, `fillvalue' defaults to @code{None}.

Iteration continues until the longest iterable is exhausted.

Aproximadamente equivalente a:

@example
def zip_longest(*iterables, fillvalue=None):
    # zip_longest('ABCD', 'xy', fillvalue='-') → Ax By C- D-

    iterators = list(map(iter, iterables))
    num_active = len(iterators)
    if not num_active:
        return

    while True:
        values = []
        for i, iterator in enumerate(iterators):
            try:
                value = next(iterator)
            except StopIteration:
                num_active -= 1
                if not num_active:
                    return
                iterators[i] = repeat(fillvalue)
                value = fillvalue
            values.append(value)
        yield tuple(values)
@end example

If one of the iterables is potentially infinite, then the @ref{130a,,zip_longest()}
function should be wrapped with something that limits the number of calls
(for example @ref{bd4,,islice()} or @ref{2725,,takewhile()}).
@end deffn

@node Fórmulas con itertools,,Itertool Functions,itertools — Functions creating iterators for efficient looping
@anchor{library/itertools id1}@anchor{272a}@anchor{library/itertools itertools-recipes}@anchor{12cc}
@subsubsection Fórmulas con itertools


Esta sección muestra fórmulas para crear un conjunto de herramientas extendido usando las herramientas de itertools como piezas básicas.

The primary purpose of the itertools recipes is educational.  The recipes show
various ways of thinking about individual tools — for example, that
@code{chain.from_iterable} is related to the concept of flattening.  The recipes
also give ideas about ways that the tools can be combined — for example, how
@code{starmap()} and @code{repeat()} can work together.  The recipes also show patterns
for using itertools with the @ref{9f,,operator} and @ref{1e,,collections} modules as
well as with the built-in itertools such as @code{map()}, @code{filter()},
@code{reversed()}, and @code{enumerate()}.

A secondary purpose of the recipes is to serve as an incubator.  The
@code{accumulate()}, @code{compress()}, and @code{pairwise()} itertools started out as
recipes.  Currently, the @code{sliding_window()}, @code{iter_index()}, and @code{sieve()}
recipes are being tested to see whether they prove their worth.

Substantially all of these recipes and many, many others can be installed from
the more-itertools@footnote{https://pypi.org/project/more-itertools/} project found
on the Python Package Index:

@example
python -m pip install more-itertools
@end example

Many of the recipes offer the same high performance as the underlying toolset.
Superior memory performance is kept by processing elements one at a time rather
than bringing the whole iterable into memory all at once. Code volume is kept
small by linking the tools together in a functional style@footnote{https://www.cs.kent.ac.uk/people/staff/dat/miranda/whyfp90.pdf}.  High speed
is retained by preferring «vectorized» building blocks over the use of for-loops
and @ref{10dd,,generators} which incur interpreter overhead.

@example
import collections
import contextlib
import functools
import math
import operator
import random

def take(n, iterable):
    "Return first n items of the iterable as a list."
    return list(islice(iterable, n))

def prepend(value, iterable):
    "Prepend a single value in front of an iterable."
    # prepend(1, [2, 3, 4]) → 1 2 3 4
    return chain([value], iterable)

def tabulate(function, start=0):
    "Return function(0), function(1), ..."
    return map(function, count(start))

def repeatfunc(func, times=None, *args):
    "Repeat calls to func with specified arguments."
    if times is None:
        return starmap(func, repeat(args))
    return starmap(func, repeat(args, times))

def flatten(list_of_lists):
    "Flatten one level of nesting."
    return chain.from_iterable(list_of_lists)

def ncycles(iterable, n):
    "Returns the sequence elements n times."
    return chain.from_iterable(repeat(tuple(iterable), n))

def tail(n, iterable):
    "Return an iterator over the last n items."
    # tail(3, 'ABCDEFG') → E F G
    return iter(collections.deque(iterable, maxlen=n))

def consume(iterator, n=None):
    "Advance the iterator n-steps ahead. If n is None, consume entirely."
    # Use functions that consume iterators at C speed.
    if n is None:
        collections.deque(iterator, maxlen=0)
    else:
        next(islice(iterator, n, n), None)

def nth(iterable, n, default=None):
    "Returns the nth item or a default value."
    return next(islice(iterable, n, None), default)

def quantify(iterable, predicate=bool):
    "Given a predicate that returns True or False, count the True results."
    return sum(map(predicate, iterable))

def first_true(iterable, default=False, predicate=None):
    "Returns the first true value or the *default* if there is no true value."
    # first_true([a,b,c], x) → a or b or c or x
    # first_true([a,b], x, f) → a if f(a) else b if f(b) else x
    return next(filter(predicate, iterable), default)

def all_equal(iterable, key=None):
    "Returns True if all the elements are equal to each other."
    # all_equal('4٤௪౪໔', key=int) → True
    return len(take(2, groupby(iterable, key))) <= 1

def unique_justseen(iterable, key=None):
    "Yield unique elements, preserving order. Remember only the element just seen."
    # unique_justseen('AAAABBBCCDAABBB') → A B C D A B
    # unique_justseen('ABBcCAD', str.casefold) → A B c A D
    if key is None:
        return map(operator.itemgetter(0), groupby(iterable))
    return map(next, map(operator.itemgetter(1), groupby(iterable, key)))

def unique_everseen(iterable, key=None):
    "Yield unique elements, preserving order. Remember all elements ever seen."
    # unique_everseen('AAAABBBCCDAABBB') → A B C D
    # unique_everseen('ABBcCAD', str.casefold) → A B c D
    seen = set()
    if key is None:
        for element in filterfalse(seen.__contains__, iterable):
            seen.add(element)
            yield element
    else:
        for element in iterable:
            k = key(element)
            if k not in seen:
                seen.add(k)
                yield element

def unique(iterable, key=None, reverse=False):
   "Yield unique elements in sorted order. Supports unhashable inputs."
   # unique([[1, 2], [3, 4], [1, 2]]) → [1, 2] [3, 4]
   return unique_justseen(sorted(iterable, key=key, reverse=reverse), key=key)

def sliding_window(iterable, n):
    "Collect data into overlapping fixed-length chunks or blocks."
    # sliding_window('ABCDEFG', 4) → ABCD BCDE CDEF DEFG
    iterator = iter(iterable)
    window = collections.deque(islice(iterator, n - 1), maxlen=n)
    for x in iterator:
        window.append(x)
        yield tuple(window)

def grouper(iterable, n, *, incomplete='fill', fillvalue=None):
    "Collect data into non-overlapping fixed-length chunks or blocks."
    # grouper('ABCDEFG', 3, fillvalue='x') → ABC DEF Gxx
    # grouper('ABCDEFG', 3, incomplete='strict') → ABC DEF ValueError
    # grouper('ABCDEFG', 3, incomplete='ignore') → ABC DEF
    iterators = [iter(iterable)] * n
    match incomplete:
        case 'fill':
            return zip_longest(*iterators, fillvalue=fillvalue)
        case 'strict':
            return zip(*iterators, strict=True)
        case 'ignore':
            return zip(*iterators)
        case _:
            raise ValueError('Expected fill, strict, or ignore')

def roundrobin(*iterables):
    "Visit input iterables in a cycle until each is exhausted."
    # roundrobin('ABC', 'D', 'EF') → A D E B F C
    # Algorithm credited to George Sakkis
    iterators = map(iter, iterables)
    for num_active in range(len(iterables), 0, -1):
        iterators = cycle(islice(iterators, num_active))
        yield from map(next, iterators)

def subslices(seq):
    "Return all contiguous non-empty subslices of a sequence."
    # subslices('ABCD') → A AB ABC ABCD B BC BCD C CD D
    slices = starmap(slice, combinations(range(len(seq) + 1), 2))
    return map(operator.getitem, repeat(seq), slices)

def iter_index(iterable, value, start=0, stop=None):
    "Return indices where a value occurs in a sequence or iterable."
    # iter_index('AABCADEAF', 'A') → 0 1 4 7
    seq_index = getattr(iterable, 'index', None)
    if seq_index is None:
        iterator = islice(iterable, start, stop)
        for i, element in enumerate(iterator, start):
            if element is value or element == value:
                yield i
    else:
        stop = len(iterable) if stop is None else stop
        i = start
        with contextlib.suppress(ValueError):
            while True:
                yield (i := seq_index(value, i, stop))
                i += 1

def iter_except(func, exception, first=None):
    "Convert a call-until-exception interface to an iterator interface."
    # iter_except(d.popitem, KeyError) → non-blocking dictionary iterator
    with contextlib.suppress(exception):
        if first is not None:
            yield first()
        while True:
            yield func()
@end example

The following recipes have a more mathematical flavor:

@example
def powerset(iterable):
    "powerset([1,2,3]) → () (1,) (2,) (3,) (1,2) (1,3) (2,3) (1,2,3)"
    s = list(iterable)
    return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))

def sum_of_squares(iterable):
    "Add up the squares of the input values."
    # sum_of_squares([10, 20, 30]) → 1400
    return math.sumprod(*tee(iterable))

def reshape(matrix, cols):
    "Reshape a 2-D matrix to have a given number of columns."
    # reshape([(0, 1), (2, 3), (4, 5)], 3) →  (0, 1, 2), (3, 4, 5)
    return batched(chain.from_iterable(matrix), cols, strict=True)

def transpose(matrix):
    "Swap the rows and columns of a 2-D matrix."
    # transpose([(1, 2, 3), (11, 22, 33)]) → (1, 11) (2, 22) (3, 33)
    return zip(*matrix, strict=True)

def matmul(m1, m2):
    "Multiply two matrices."
    # matmul([(7, 5), (3, 5)], [(2, 5), (7, 9)]) → (49, 80), (41, 60)
    n = len(m2[0])
    return batched(starmap(math.sumprod, product(m1, transpose(m2))), n)

def convolve(signal, kernel):
    """Discrete linear convolution of two iterables.
    Equivalent to polynomial multiplication.

    Convolutions are mathematically commutative; however, the inputs are
    evaluated differently.  The signal is consumed lazily and can be
    infinite. The kernel is fully consumed before the calculations begin.

    Article:  https://betterexplained.com/articles/intuitive-convolution/
    Video:    https://www.youtube.com/watch?v=KuXjwB4LzSA
    """
    # convolve([1, -1, -20], [1, -3]) → 1 -4 -17 60
    # convolve(data, [0.25, 0.25, 0.25, 0.25]) → Moving average (blur)
    # convolve(data, [1/2, 0, -1/2]) → 1st derivative estimate
    # convolve(data, [1, -2, 1]) → 2nd derivative estimate
    kernel = tuple(kernel)[::-1]
    n = len(kernel)
    padded_signal = chain(repeat(0, n-1), signal, repeat(0, n-1))
    windowed_signal = sliding_window(padded_signal, n)
    return map(math.sumprod, repeat(kernel), windowed_signal)

def polynomial_from_roots(roots):
    """Compute a polynomial's coefficients from its roots.

       (x - 5) (x + 4) (x - 3)  expands to:   x³ -4x² -17x + 60
    """
    # polynomial_from_roots([5, -4, 3]) → [1, -4, -17, 60]
    factors = zip(repeat(1), map(operator.neg, roots))
    return list(functools.reduce(convolve, factors, [1]))

def polynomial_eval(coefficients, x):
    """Evaluate a polynomial at a specific value.

    Computes with better numeric stability than Horner's method.
    """
    # Evaluate x³ -4x² -17x + 60 at x = 5
    # polynomial_eval([1, -4, -17, 60], x=5) → 0
    n = len(coefficients)
    if not n:
        return type(x)(0)
    powers = map(pow, repeat(x), reversed(range(n)))
    return math.sumprod(coefficients, powers)

def polynomial_derivative(coefficients):
    """Compute the first derivative of a polynomial.

       f(x)  =  x³ -4x² -17x + 60
       f'(x) = 3x² -8x  -17
    """
    # polynomial_derivative([1, -4, -17, 60]) → [3, -8, -17]
    n = len(coefficients)
    powers = reversed(range(1, n))
    return list(map(operator.mul, coefficients, powers))

def sieve(n):
    "Primes less than n."
    # sieve(30) → 2 3 5 7 11 13 17 19 23 29
    if n > 2:
        yield 2
    data = bytearray((0, 1)) * (n // 2)
    for p in iter_index(data, 1, start=3, stop=math.isqrt(n) + 1):
        data[p*p : n : p+p] = bytes(len(range(p*p, n, p+p)))
    yield from iter_index(data, 1, start=3)

def factor(n):
    "Prime factors of n."
    # factor(99) → 3 3 11
    # factor(1_000_000_000_000_007) → 47 59 360620266859
    # factor(1_000_000_000_000_403) → 1000000000000403
    for prime in sieve(math.isqrt(n) + 1):
        while not n % prime:
            yield prime
            n //= prime
            if n == 1:
                return
    if n > 1:
        yield n

def totient(n):
    "Count of natural numbers up to n that are coprime to n."
    # https://mathworld.wolfram.com/TotientFunction.html
    # totient(12) → 4 because len([1, 5, 7, 11]) == 4
    for prime in set(factor(n)):
        n -= n // prime
    return n
@end example

@c These examples no longer appear in the docs but are guaranteed
@c to keep working.
@c 
@c >>> amounts = [120.15, 764.05, 823.14]
@c >>> for checknum, amount in zip(count(1200), amounts):
@c ...     print('Check %d is for $%.2f' % (checknum, amount))
@c ...
@c Check 1200 is for $120.15
@c Check 1201 is for $764.05
@c Check 1202 is for $823.14
@c 
@c >>> import operator
@c >>> for cube in map(operator.pow, range(1,4), repeat(3)):
@c ...    print(cube)
@c ...
@c 1
@c 8
@c 27
@c 
@c >>> reportlines = ['EuroPython', 'Roster', '', 'alex', '', 'laura', '', 'martin', '', 'walter', '', 'samuele']
@c >>> for name in islice(reportlines, 3, None, 2):
@c ...    print(name.title())
@c ...
@c Alex
@c Laura
@c Martin
@c Walter
@c Samuele
@c 
@c >>> from operator import itemgetter
@c >>> d = dict(a=1, b=2, c=1, d=2, e=1, f=2, g=3)
@c >>> di = sorted(sorted(d.items()), key=itemgetter(1))
@c >>> for k, g in groupby(di, itemgetter(1)):
@c ...     print(k, list(map(itemgetter(0), g)))
@c ...
@c 1 ['a', 'c', 'e']
@c 2 ['b', 'd', 'f']
@c 3 ['g']
@c 
@c # Find runs of consecutive numbers using groupby.  The key to the solution
@c # is differencing with a range so that consecutive numbers all appear in
@c # same group.
@c >>> data = [ 1,  4,5,6, 10, 15,16,17,18, 22, 25,26,27,28]
@c >>> for k, g in groupby(enumerate(data), lambda t:t[0]-t[1]):
@c ...     print(list(map(operator.itemgetter(1), g)))
@c ...
@c [1]
@c [4, 5, 6]
@c [10]
@c [15, 16, 17, 18]
@c [22]
@c [25, 26, 27, 28]
@c 
@c Now, we test all of the itertool recipes
@c 
@c >>> take(10, count())
@c [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@c >>> # Verify that the input is consumed lazily
@c >>> it = iter('abcdef')
@c >>> take(3, it)
@c ['a', 'b', 'c']
@c >>> list(it)
@c ['d', 'e', 'f']
@c 
@c 
@c >>> list(prepend(1, [2, 3, 4]))
@c [1, 2, 3, 4]
@c 
@c 
@c >>> list(enumerate('abc'))
@c [(0, 'a'), (1, 'b'), (2, 'c')]
@c 
@c 
@c >>> list(islice(tabulate(lambda x: 2*x), 4))
@c [0, 2, 4, 6]
@c 
@c 
@c >>> list(tail(3, 'ABCDEFG'))
@c ['E', 'F', 'G']
@c >>> # Verify the input is consumed greedily
@c >>> input_iterator = iter('ABCDEFG')
@c >>> output_iterator = tail(3, input_iterator)
@c >>> list(input_iterator)
@c []
@c 
@c 
@c >>> it = iter(range(10))
@c >>> consume(it, 3)
@c >>> # Verify the input is consumed lazily
@c >>> next(it)
@c 3
@c >>> # Verify the input is consumed completely
@c >>> consume(it)
@c >>> next(it, 'Done')
@c 'Done'
@c 
@c 
@c >>> nth('abcde', 3)
@c 'd'
@c >>> nth('abcde', 9) is None
@c True
@c >>> # Verify that the input is consumed lazily
@c >>> it = iter('abcde')
@c >>> nth(it, 2)
@c 'c'
@c >>> list(it)
@c ['d', 'e']
@c 
@c 
@c >>> [all_equal(s) for s in ('', 'A', 'AAAA', 'AAAB', 'AAABA')]
@c [True, True, True, False, False]
@c >>> [all_equal(s, key=str.casefold) for s in ('', 'A', 'AaAa', 'AAAB', 'AAABA')]
@c [True, True, True, False, False]
@c >>> # Verify that the input is consumed lazily and that only
@c >>> # one element of a second equivalence class is used to disprove
@c >>> # the assertion that all elements are equal.
@c >>> it = iter('aaabbbccc')
@c >>> all_equal(it)
@c False
@c >>> ''.join(it)
@c 'bbccc'
@c 
@c 
@c >>> quantify(range(99), lambda x: x%2==0)
@c 50
@c >>> quantify([True, False, False, True, True])
@c 3
@c >>> quantify(range(12), predicate=lambda x: x%2==1)
@c 6
@c 
@c 
@c >>> a = [[1, 2, 3], [4, 5, 6]]
@c >>> list(flatten(a))
@c [1, 2, 3, 4, 5, 6]
@c 
@c 
@c >>> list(ncycles('abc', 3))
@c ['a', 'b', 'c', 'a', 'b', 'c', 'a', 'b', 'c']
@c >>> # Verify greedy consumption of input iterator
@c >>> input_iterator = iter('abc')
@c >>> output_iterator = ncycles(input_iterator, 3)
@c >>> list(input_iterator)
@c []
@c 
@c 
@c >>> sum_of_squares([10, 20, 30])
@c 1400
@c 
@c 
@c >>> list(reshape([(0, 1), (2, 3), (4, 5)], 3))
@c [(0, 1, 2), (3, 4, 5)]
@c >>> M = [(0, 1, 2, 3), (4, 5, 6, 7), (8, 9, 10, 11)]
@c >>> list(reshape(M, 1))
@c [(0,), (1,), (2,), (3,), (4,), (5,), (6,), (7,), (8,), (9,), (10,), (11,)]
@c >>> list(reshape(M, 2))
@c [(0, 1), (2, 3), (4, 5), (6, 7), (8, 9), (10, 11)]
@c >>> list(reshape(M, 3))
@c [(0, 1, 2), (3, 4, 5), (6, 7, 8), (9, 10, 11)]
@c >>> list(reshape(M, 4))
@c [(0, 1, 2, 3), (4, 5, 6, 7), (8, 9, 10, 11)]
@c >>> list(reshape(M, 5))
@c Traceback (most recent call last):
@c ...
@c ValueError: batched(): incomplete batch
@c >>> list(reshape(M, 6))
@c [(0, 1, 2, 3, 4, 5), (6, 7, 8, 9, 10, 11)]
@c >>> list(reshape(M, 12))
@c [(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11)]
@c 
@c 
@c >>> list(transpose([(1, 2, 3), (11, 22, 33)]))
@c [(1, 11), (2, 22), (3, 33)]
@c >>> # Verify that the inputs are consumed lazily
@c >>> input1 = iter([1, 2, 3])
@c >>> input2 = iter([11, 22, 33])
@c >>> output_iterator = transpose([input1, input2])
@c >>> next(output_iterator)
@c (1, 11)
@c >>> list(zip(input1, input2))
@c [(2, 22), (3, 33)]
@c 
@c 
@c >>> list(matmul([(7, 5), (3, 5)], [[2, 5], [7, 9]]))
@c [(49, 80), (41, 60)]
@c >>> list(matmul([[2, 5], [7, 9], [3, 4]], [[7, 11, 5, 4, 9], [3, 5, 2, 6, 3]]))
@c [(29, 47, 20, 38, 33), (76, 122, 53, 82, 90), (33, 53, 23, 36, 39)]
@c 
@c 
@c >>> list(convolve([1, -1, -20], [1, -3])) == [1, -4, -17, 60]
@c True
@c >>> data = [20, 40, 24, 32, 20, 28, 16]
@c >>> list(convolve(data, [0.25, 0.25, 0.25, 0.25]))
@c [5.0, 15.0, 21.0, 29.0, 29.0, 26.0, 24.0, 16.0, 11.0, 4.0]
@c >>> list(convolve(data, [1, -1]))
@c [20, 20, -16, 8, -12, 8, -12, -16]
@c >>> list(convolve(data, [1, -2, 1]))
@c [20, 0, -36, 24, -20, 20, -20, -4, 16]
@c >>> # Verify signal is consumed lazily and the kernel greedily
@c >>> signal_iterator = iter([10, 20, 30, 40, 50])
@c >>> kernel_iterator = iter([1, 2, 3])
@c >>> output_iterator = convolve(signal_iterator, kernel_iterator)
@c >>> list(kernel_iterator)
@c []
@c >>> next(output_iterator)
@c 10
@c >>> next(output_iterator)
@c 40
@c >>> list(signal_iterator)
@c [30, 40, 50]
@c 
@c 
@c >>> from fractions import Fraction
@c >>> from decimal import Decimal
@c >>> polynomial_eval([1, -4, -17, 60], x=5)
@c 0
@c >>> x = 5; x**3 - 4*x**2 -17*x + 60
@c 0
@c >>> polynomial_eval([1, -4, -17, 60], x=2.5)
@c 8.125
@c >>> x = 2.5; x**3 - 4*x**2 -17*x + 60
@c 8.125
@c >>> polynomial_eval([1, -4, -17, 60], x=Fraction(2, 3))
@c Fraction(1274, 27)
@c >>> x = Fraction(2, 3); x**3 - 4*x**2 -17*x + 60
@c Fraction(1274, 27)
@c >>> polynomial_eval([1, -4, -17, 60], x=Decimal('1.75'))
@c Decimal('23.359375')
@c >>> x = Decimal('1.75'); x**3 - 4*x**2 -17*x + 60
@c Decimal('23.359375')
@c >>> polynomial_eval([], 2)
@c 0
@c >>> polynomial_eval([], 2.5)
@c 0.0
@c >>> polynomial_eval([], Fraction(2, 3))
@c Fraction(0, 1)
@c >>> polynomial_eval([], Decimal('1.75'))
@c Decimal('0')
@c >>> polynomial_eval([11], 7) == 11
@c True
@c >>> polynomial_eval([11, 2], 7) == 11 * 7 + 2
@c True
@c 
@c 
@c >>> polynomial_from_roots([5, -4, 3])
@c [1, -4, -17, 60]
@c >>> factored = lambda x: (x - 5) * (x + 4) * (x - 3)
@c >>> expanded = lambda x: x**3 -4*x**2 -17*x + 60
@c >>> all(factored(x) == expanded(x) for x in range(-10, 11))
@c True
@c 
@c 
@c >>> polynomial_derivative([1, -4, -17, 60])
@c [3, -8, -17]
@c 
@c 
@c >>> list(iter_index('AABCADEAF', 'A'))
@c [0, 1, 4, 7]
@c >>> list(iter_index('AABCADEAF', 'B'))
@c [2]
@c >>> list(iter_index('AABCADEAF', 'X'))
@c []
@c >>> list(iter_index('', 'X'))
@c []
@c >>> list(iter_index('AABCADEAF', 'A', 1))
@c [1, 4, 7]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 1))
@c [1, 4, 7]
@c >>> list(iter_index('AABCADEAF', 'A', 2))
@c [4, 7]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 2))
@c [4, 7]
@c >>> list(iter_index('AABCADEAF', 'A', 10))
@c []
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 10))
@c []
@c >>> list(iter_index('AABCADEAF', 'A', 1, 7))
@c [1, 4]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 1, 7))
@c [1, 4]
@c >>> # Verify that ValueErrors not swallowed (gh-107208)
@c >>> def assert_no_value(iterable, forbidden_value):
@c ...     for item in iterable:
@c ...         if item == forbidden_value:
@c ...             raise ValueError
@c ...         yield item
@c ...
@c >>> list(iter_index(assert_no_value('AABCADEAF', 'B'), 'A'))
@c Traceback (most recent call last):
@c ...
@c ValueError
@c >>> # Verify that both paths can find identical NaN values
@c >>> x = float('NaN')
@c >>> y = float('NaN')
@c >>> list(iter_index([0, x, x, y, 0], x))
@c [1, 2]
@c >>> list(iter_index(iter([0, x, x, y, 0]), x))
@c [1, 2]
@c >>> # Test list input. Lists do not support None for the stop argument
@c >>> list(iter_index(list('AABCADEAF'), 'A'))
@c [0, 1, 4, 7]
@c >>> # Verify that input is consumed lazily
@c >>> input_iterator = iter('AABCADEAF')
@c >>> output_iterator = iter_index(input_iterator, 'A')
@c >>> next(output_iterator)
@c 0
@c >>> next(output_iterator)
@c 1
@c >>> next(output_iterator)
@c 4
@c >>> ''.join(input_iterator)
@c 'DEAF'
@c 
@c 
@c >>> # Verify that the target value can be a sequence.
@c >>> seq = [[10, 20], [30, 40], 30, 40, [30, 40], 50]
@c >>> target = [30, 40]
@c >>> list(iter_index(seq, target))
@c [1, 4]
@c 
@c 
@c >>> # Verify faithfulness to type specific index() method behaviors.
@c >>> # For example, bytes and str perform continuous-subsequence searches
@c >>> # that do not match the general behavior specified
@c >>> # in collections.abc.Sequence.index().
@c >>> seq = 'abracadabra'
@c >>> target = 'ab'
@c >>> list(iter_index(seq, target))
@c [0, 7]
@c 
@c 
@c >>> list(sieve(30))
@c [2, 3, 5, 7, 11, 13, 17, 19, 23, 29]
@c >>> small_primes = [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97]
@c >>> all(list(sieve(n)) == [p for p in small_primes if p < n] for n in range(101))
@c True
@c >>> len(list(sieve(100)))
@c 25
@c >>> len(list(sieve(1_000)))
@c 168
@c >>> len(list(sieve(10_000)))
@c 1229
@c >>> len(list(sieve(100_000)))
@c 9592
@c >>> len(list(sieve(1_000_000)))
@c 78498
@c >>> carmichael = {561, 1105, 1729, 2465, 2821, 6601, 8911}  # https://oeis.org/A002997
@c >>> set(sieve(10_000)).isdisjoint(carmichael)
@c True
@c 
@c 
@c >>> list(factor(99))                    # Code example 1
@c [3, 3, 11]
@c >>> list(factor(1_000_000_000_000_007)) # Code example 2
@c [47, 59, 360620266859]
@c >>> list(factor(1_000_000_000_000_403)) # Code example 3
@c [1000000000000403]
@c >>> list(factor(0))
@c []
@c >>> list(factor(1))
@c []
@c >>> list(factor(2))
@c [2]
@c >>> list(factor(3))
@c [3]
@c >>> list(factor(4))
@c [2, 2]
@c >>> list(factor(5))
@c [5]
@c >>> list(factor(6))
@c [2, 3]
@c >>> list(factor(7))
@c [7]
@c >>> list(factor(8))
@c [2, 2, 2]
@c >>> list(factor(9))
@c [3, 3]
@c >>> list(factor(10))
@c [2, 5]
@c >>> list(factor(128_884_753_939))       # large prime
@c [128884753939]
@c >>> list(factor(999953 * 999983))       # large semiprime
@c [999953, 999983]
@c >>> list(factor(6 ** 20)) == [2] * 20 + [3] * 20   # large power
@c True
@c >>> list(factor(909_909_090_909))       # large multiterm composite
@c [3, 3, 7, 13, 13, 751, 113797]
@c >>> math.prod([3, 3, 7, 13, 13, 751, 113797])
@c 909909090909
@c >>> all(math.prod(factor(n)) == n for n in range(1, 2_000))
@c True
@c >>> all(set(factor(n)) <= set(sieve(n+1)) for n in range(2_000))
@c True
@c >>> all(list(factor(n)) == sorted(factor(n)) for n in range(2_000))
@c True
@c 
@c 
@c >>> totient(0)  # https://www.wolframalpha.com/input?i=totient+0
@c 0
@c >>> first_totients = [1, 1, 2, 2, 4, 2, 6, 4, 6, 4, 10, 4, 12, 6, 8, 8, 16, 6,
@c ... 18, 8, 12, 10, 22, 8, 20, 12, 18, 12, 28, 8, 30, 16, 20, 16, 24, 12, 36, 18,
@c ... 24, 16, 40, 12, 42, 20, 24, 22, 46, 16, 42, 20, 32, 24, 52, 18, 40, 24, 36,
@c ... 28, 58, 16, 60, 30, 36, 32, 48, 20, 66, 32, 44]  # https://oeis.org/A000010
@c ...
@c >>> list(map(totient, range(1, 70))) == first_totients
@c True
@c >>> reference_totient = lambda n: sum(math.gcd(t, n) == 1 for t in range(1, n+1))
@c >>> all(totient(n) == reference_totient(n) for n in range(1000))
@c True
@c >>> totient(128_884_753_939) == 128_884_753_938  # large prime
@c True
@c >>> totient(999953 * 999983) == 999952 * 999982  # large semiprime
@c True
@c >>> totient(6 ** 20) == 1 * 2**19 * 2 * 3**19    # repeated primes
@c True
@c 
@c 
@c >>> list(flatten([('a', 'b'), (), ('c', 'd', 'e'), ('f',), ('g', 'h', 'i')]))
@c ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i']
@c 
@c 
@c >>> list(repeatfunc(pow, 5, 2, 3))
@c [8, 8, 8, 8, 8]
@c >>> take(5, map(int, repeatfunc(random.random)))
@c [0, 0, 0, 0, 0]
@c >>> random.seed(85753098575309)
@c >>> list(repeatfunc(random.random, 3))
@c [0.16370491282496968, 0.45889608687313455, 0.3747076837820118]
@c >>> list(repeatfunc(chr, 3, 65))
@c ['A', 'A', 'A']
@c >>> list(repeatfunc(pow, 3, 2, 5))
@c [32, 32, 32]
@c 
@c 
@c >>> list(grouper('abcdefg', 3, fillvalue='x'))
@c [('a', 'b', 'c'), ('d', 'e', 'f'), ('g', 'x', 'x')]
@c 
@c 
@c >>> it = grouper('abcdefg', 3, incomplete='strict')
@c >>> next(it)
@c ('a', 'b', 'c')
@c >>> next(it)
@c ('d', 'e', 'f')
@c >>> next(it)
@c Traceback (most recent call last):
@c   ...
@c ValueError: zip() argument 2 is shorter than argument 1
@c 
@c >>> list(grouper('abcdefg', n=3, incomplete='ignore'))
@c [('a', 'b', 'c'), ('d', 'e', 'f')]
@c 
@c 
@c >>> list(sliding_window('ABCDEFG', 1))
@c [('A',), ('B',), ('C',), ('D',), ('E',), ('F',), ('G',)]
@c >>> list(sliding_window('ABCDEFG', 2))
@c [('A', 'B'), ('B', 'C'), ('C', 'D'), ('D', 'E'), ('E', 'F'), ('F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 3))
@c [('A', 'B', 'C'), ('B', 'C', 'D'), ('C', 'D', 'E'), ('D', 'E', 'F'), ('E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 4))
@c [('A', 'B', 'C', 'D'), ('B', 'C', 'D', 'E'), ('C', 'D', 'E', 'F'), ('D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 5))
@c [('A', 'B', 'C', 'D', 'E'), ('B', 'C', 'D', 'E', 'F'), ('C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 6))
@c [('A', 'B', 'C', 'D', 'E', 'F'), ('B', 'C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 7))
@c [('A', 'B', 'C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 8))
@c []
@c >>> try:
@c ...     list(sliding_window('ABCDEFG', -1))
@c ... except ValueError:
@c ...     'zero or negative n not supported'
@c ...
@c 'zero or negative n not supported'
@c >>> try:
@c ...     list(sliding_window('ABCDEFG', 0))
@c ... except ValueError:
@c ...     'zero or negative n not supported'
@c ...
@c 'zero or negative n not supported'
@c 
@c 
@c >>> list(roundrobin('abc', 'd', 'ef'))
@c ['a', 'd', 'e', 'b', 'f', 'c']
@c >>> ranges = [range(5, 1000), range(4, 3000), range(0), range(3, 2000), range(2, 5000), range(1, 3500)]
@c >>> collections.Counter(roundrobin(*ranges)) == collections.Counter(chain(*ranges))
@c True
@c >>> # Verify that the inputs are consumed lazily
@c >>> input_iterators = list(map(iter, ['abcd', 'ef', '', 'ghijk', 'l', 'mnopqr']))
@c >>> output_iterator = roundrobin(*input_iterators)
@c >>> ''.join(islice(output_iterator, 10))
@c 'aeglmbfhnc'
@c >>> ''.join(chain(*input_iterators))
@c 'dijkopqr'
@c 
@c 
@c >>> list(subslices('ABCD'))
@c ['A', 'AB', 'ABC', 'ABCD', 'B', 'BC', 'BCD', 'C', 'CD', 'D']
@c 
@c 
@c >>> list(powerset([1,2,3]))
@c [(), (1,), (2,), (3,), (1, 2), (1, 3), (2, 3), (1, 2, 3)]
@c >>> all(len(list(powerset(range(n)))) == 2**n for n in range(18))
@c True
@c >>> list(powerset('abcde')) == sorted(sorted(set(powerset('abcde'))), key=len)
@c True
@c 
@c 
@c >>> list(unique_everseen('AAAABBBCCDAABBB'))
@c ['A', 'B', 'C', 'D']
@c >>> list(unique_everseen('ABBCcAD', str.casefold))
@c ['A', 'B', 'C', 'D']
@c >>> list(unique_everseen('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'D']
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter('AAAABBBCCDAABBB')
@c >>> output_iterator = unique_everseen(input_iterator)
@c >>> next(output_iterator)
@c 'A'
@c >>> ''.join(input_iterator)
@c 'AAABBBCCDAABBB'
@c 
@c 
@c >>> list(unique_justseen('AAAABBBCCDAABBB'))
@c ['A', 'B', 'C', 'D', 'A', 'B']
@c >>> list(unique_justseen('ABBCcAD', str.casefold))
@c ['A', 'B', 'C', 'A', 'D']
@c >>> list(unique_justseen('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'A', 'D']
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter('AAAABBBCCDAABBB')
@c >>> output_iterator = unique_justseen(input_iterator)
@c >>> next(output_iterator)
@c 'A'
@c >>> ''.join(input_iterator)
@c 'AAABBBCCDAABBB'
@c 
@c 
@c >>> list(unique([[1, 2], [3, 4], [1, 2]]))
@c [[1, 2], [3, 4]]
@c >>> list(unique('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'D']
@c >>> list(unique('ABBcCAD', str.casefold, reverse=True))
@c ['D', 'c', 'B', 'A']
@c 
@c 
@c >>> d = dict(a=1, b=2, c=3)
@c >>> it = iter_except(d.popitem, KeyError)
@c >>> d['d'] = 4
@c >>> next(it)
@c ('d', 4)
@c >>> next(it)
@c ('c', 3)
@c >>> next(it)
@c ('b', 2)
@c >>> d['e'] = 5
@c >>> next(it)
@c ('e', 5)
@c >>> next(it)
@c ('a', 1)
@c >>> next(it, 'empty')
@c 'empty'
@c 
@c 
@c >>> first_true('ABC0DEF1', '9', str.isdigit)
@c '0'
@c >>> # Verify that inputs are consumed lazily
@c >>> it = iter('ABC0DEF1')
@c >>> first_true(it, predicate=str.isdigit)
@c '0'
@c >>> ''.join(it)
@c 'DEF1'

@c # Old recipes and their tests which are guaranteed to continue to work.
@c 
@c def sumprod(vec1, vec2):
@c     "Compute a sum of products."
@c     return sum(starmap(operator.mul, zip(vec1, vec2, strict=True)))
@c 
@c def dotproduct(vec1, vec2):
@c     return sum(map(operator.mul, vec1, vec2))
@c 
@c def pad_none(iterable):
@c     """Returns the sequence elements and then returns None indefinitely.
@c 
@c     Useful for emulating the behavior of the built-in map() function.
@c     """
@c     return chain(iterable, repeat(None))
@c 
@c def triplewise(iterable):
@c     "Return overlapping triplets from an iterable"
@c     # triplewise('ABCDEFG') → ABC BCD CDE DEF EFG
@c     for (a, _), (b, c) in pairwise(pairwise(iterable)):
@c         yield a, b, c
@c 
@c def nth_combination(iterable, r, index):
@c     "Equivalent to list(combinations(iterable, r))[index]"
@c     pool = tuple(iterable)
@c     n = len(pool)
@c     c = math.comb(n, r)
@c     if index < 0:
@c         index += c
@c     if index < 0 or index >= c:
@c         raise IndexError
@c     result = []
@c     while r:
@c         c, n, r = c*r//n, n-1, r-1
@c         while index >= c:
@c             index -= c
@c             c, n = c*(n-r)//n, n-1
@c         result.append(pool[-1-n])
@c     return tuple(result)
@c 
@c def before_and_after(predicate, it):
@c    """ Variant of takewhile() that allows complete
@c        access to the remainder of the iterator.
@c 
@c        >>> it = iter('ABCdEfGhI')
@c        >>> all_upper, remainder = before_and_after(str.isupper, it)
@c        >>> ''.join(all_upper)
@c        'ABC'
@c        >>> ''.join(remainder)     # takewhile() would lose the 'd'
@c        'dEfGhI'
@c 
@c        Note that the true iterator must be fully consumed
@c        before the remainder iterator can generate valid results.
@c    """
@c    it = iter(it)
@c    transition = []
@c 
@c    def true_iterator():
@c        for elem in it:
@c            if predicate(elem):
@c                yield elem
@c            else:
@c                transition.append(elem)
@c                return
@c 
@c    return true_iterator(), chain(transition, it)
@c 
@c def partition(predicate, iterable):
@c     """Partition entries into false entries and true entries.
@c 
@c     If *predicate* is slow, consider wrapping it with functools.lru_cache().
@c     """
@c     # partition(is_odd, range(10)) → 0 2 4 6 8   and  1 3 5 7 9
@c     t1, t2 = tee(iterable)
@c     return filterfalse(predicate, t1), filter(predicate, t2)

@c >>> dotproduct([1,2,3], [4,5,6])
@c 32
@c 
@c 
@c >>> sumprod([1,2,3], [4,5,6])
@c 32
@c 
@c 
@c >>> list(islice(pad_none('abc'), 0, 6))
@c ['a', 'b', 'c', None, None, None]
@c 
@c 
@c >>> list(triplewise('ABCDEFG'))
@c [('A', 'B', 'C'), ('B', 'C', 'D'), ('C', 'D', 'E'), ('D', 'E', 'F'), ('E', 'F', 'G')]
@c 
@c 
@c >>> population = 'ABCDEFGH'
@c >>> for r in range(len(population) + 1):
@c ...     seq = list(combinations(population, r))
@c ...     for i in range(len(seq)):
@c ...         assert nth_combination(population, r, i) == seq[i]
@c ...     for i in range(-len(seq), 0):
@c ...         assert nth_combination(population, r, i) == seq[i]
@c ...
@c >>> iterable = 'abcde'
@c >>> r = 3
@c >>> combos = list(combinations(iterable, r))
@c >>> all(nth_combination(iterable, r, i) == comb for i, comb in enumerate(combos))
@c True
@c 
@c 
@c >>> it = iter('ABCdEfGhI')
@c >>> all_upper, remainder = before_and_after(str.isupper, it)
@c >>> ''.join(all_upper)
@c 'ABC'
@c >>> ''.join(remainder)
@c 'dEfGhI'
@c 
@c 
@c >>> def is_odd(x):
@c ...     return x % 2 == 1
@c ...
@c >>> evens, odds = partition(is_odd, range(10))
@c >>> list(evens)
@c [0, 2, 4, 6, 8]
@c >>> list(odds)
@c [1, 3, 5, 7, 9]
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter(range(10))
@c >>> evens, odds = partition(is_odd, input_iterator)
@c >>> next(odds)
@c 1
@c >>> next(odds)
@c 3
@c >>> next(evens)
@c 0
@c >>> list(input_iterator)
@c [4, 5, 6, 7, 8, 9]

@node functools — Higher-order functions and operations on callable objects,operator — Standard operators as functions,itertools — Functions creating iterators for efficient looping,Módulos de programación funcional
@anchor{library/functools doc}@anchor{272b}@anchor{library/functools functools-higher-order-functions-and-operations-on-callable-objects}@anchor{272c}@anchor{library/functools module-functools}@anchor{5f}
@subsection @code{functools} — Higher-order functions and operations on callable objects


@geindex module; functools

`Código fuente:' Lib/functools.py@footnote{https://github.com/python/cpython/tree/main/Lib/functools.py}

@c import functools
@c from functools import *


__________________________________________________________________


El módulo @ref{5f,,functools} es para funciones de orden superior: funciones que actúan o retornan otras funciones. En general, cualquier objeto invocable puede ser tratado como una función para los propósitos de este módulo.

El módulo @ref{5f,,functools} define las siguientes funciones:

@geindex cache() (en el módulo functools)
@anchor{library/functools functools cache}@anchor{253d}
@deffn {Función} @@functools.cache (user_function)

Caché de funciones ilimitado, ligero y simple. Aveces llamado "memoización"@footnote{https://es.wikipedia.org/wiki/Memoizaci%C3%B3n}.

Returns the same as @code{lru_cache(maxsize=None)}, creating a thin
wrapper around a dictionary lookup for the function arguments.  Because it
never needs to evict old values, this is smaller and faster than
@ref{a81,,lru_cache()} with a size limit.

Por ejemplo:

@example
@@cache
def factorial(n):
    return n * factorial(n-1) if n else 1

>>> factorial(10)      # no previously cached result, makes 11 recursive calls
3628800
>>> factorial(5)       # just looks up cached value result
120
>>> factorial(12)      # makes two new recursive calls, the other 10 are cached
479001600
@end example

The cache is threadsafe so that the wrapped function can be used in
multiple threads.  This means that the underlying data structure will
remain coherent during concurrent updates.

It is possible for the wrapped function to be called more than once if
another thread makes an additional call before the initial call has been
completed and cached.


Added in version 3.9.

@end deffn

@geindex cached_property() (en el módulo functools)
@anchor{library/functools functools cached_property}@anchor{5e4}
@deffn {Función} @@functools.cached_property (func)

Transforma un método de una clase en una propiedad cuyo valor se computa una vez y luego se almacena como un atributo normal durante la vida de la instancia. Similar a @ref{2fd,,property()}, con la adición de caching. Útil para propiedades calculadas costosas de instancias que de otra manera son efectivamente inmutables.

Ejemplo:

@example
class DataSet:

    def __init__(self, sequence_of_numbers):
        self._data = tuple(sequence_of_numbers)

    @@cached_property
    def stdev(self):
        return statistics.stdev(self._data)
@end example

La mecánica de @ref{5e4,,cached_property()} es algo diferente de @ref{2fd,,property()}. Un atributo de bloques de propiedad normal escribe a menos que se defina un establecedor. Por el contrario, `cached_property' permite escrituras.

El decorador `cached_property' solo se ejecuta en búsquedas y solo cuando no existe un atributo con el mismo nombre. Cuando se ejecuta, `cached_property' escribe en el atributo con el mismo nombre. Las lecturas y escrituras de atributos posteriores tienen prioridad sobre el método `cached_property' y funciona como un atributo normal.

El valor en caché se puede borrar eliminando el atributo. Esto permite que el método `cached_property' se ejecute nuevamente.

The `cached_property' does not prevent a possible race condition in
multi-threaded usage. The getter function could run more than once on the
same instance, with the latest run setting the cached value. If the cached
property is idempotent or otherwise not harmful to run more than once on an
instance, this is fine. If synchronization is needed, implement the necessary
locking inside the decorated getter function or around the cached property
access.

Tenga en cuenta que este decorador interfiere con el funcionamiento de diccionarios de intercambio de claves 
@geindex Python Enhancement Proposals; PEP 412
PEP 412@footnote{https://peps.python.org/pep-0412/}. Esto significa que los diccionarios de instancias pueden ocupar más espacio de lo habitual.

Además, este decorador requiere que el atributo @code{__dict__} en cada instancia sea un mapeo mutable. Esto significa que no funcionará con algunos tipos, como las metaclases (ya que los atributos @code{__dict__} en las instancias de tipos son proxies de solo lectura para el espacio de nombres de la clase) y aquellos que especifican @code{__slots__} sin incluir @code{__dict__} como una de las ranuras definidas (ya que tales clases no proporcionan un atributo @code{__dict__} en absoluto).

If a mutable mapping is not available or if space-efficient key sharing is
desired, an effect similar to @ref{5e4,,cached_property()} can also be achieved by
stacking @ref{2fd,,property()} on top of @ref{a81,,lru_cache()}. See
@ref{272d,,¿Cómo cacheo llamadas de método?} for more details on how this differs from @ref{5e4,,cached_property()}.


Added in version 3.8.



Distinto en la versión 3.12: Prior to Python 3.12, @code{cached_property} included an undocumented lock to
ensure that in multi-threaded usage the getter function was guaranteed to
run only once per instance. However, the lock was per-property, not
per-instance, which could result in unacceptably high lock contention. In
Python 3.12+ this locking is removed.

@end deffn

@geindex cmp_to_key() (en el módulo functools)
@anchor{library/functools functools cmp_to_key}@anchor{1247}
@deffn {Función} functools.cmp_to_key (func)

Transformar una función de comparación de estilo antiguo en una @ref{e8a,,key function}.  Se utiliza con herramientas que aceptan funciones clave (como @ref{c56,,sorted()}, @ref{f8b,,min()}, @ref{f8c,,max()}, @ref{252e,,heapq.nlargest()}, @ref{252f,,heapq.nsmallest()}, @ref{2724,,itertools.groupby()}).  Esta función se utiliza principalmente como una herramienta de transición para los programas que se están convirtiendo a partir de Python 2, que soportaba el uso de funciones de comparación.

Una función de comparación es cualquier invocable que acepta dos argumentos, los compara y devuelve un número negativo para menor que, cero para igualdad o un número positivo para mayor que. Una función clave es una función invocable que acepta un argumento y devuelve otro valor para usar como clave de ordenación.

Ejemplo:

@example
sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order
@end example

Para ejemplos de clasificación y un breve tutorial de clasificación, ver @ref{2186,,Sorting Techniques}.


Added in version 3.2.

@end deffn

@geindex lru_cache() (en el módulo functools)
@anchor{library/functools functools lru_cache}@anchor{a81}
@deffn {Función} @@functools.lru_cache (user_function)

@deffnx {Función} @@functools.lru_cache (maxsize=128, typed=False)

Decorador para envolver una función con un memorizador invocable que guarda hasta el `maxsize' de las llamadas más recientes.  Puede salvar el tiempo cuando una función costosa o de E/S es llamada periódicamente con los mismos argumentos.

The cache is threadsafe so that the wrapped function can be used in
multiple threads.  This means that the underlying data structure will
remain coherent during concurrent updates.

It is possible for the wrapped function to be called more than once if
another thread makes an additional call before the initial call has been
completed and cached.

Since a dictionary is used to cache results, the positional and keyword
arguments to the function must be @ref{6b1,,hashable}.

Los patrones de argumentos distintos pueden considerarse llamadas distintas con entradas de memoria caché separadas. Por ejemplo, @code{f(a=1, b=2)} y @code{f(b=2, a=1)} difieren en el orden de sus argumentos de palabras clave y pueden tener dos entradas de caché separadas.

Si se especifica `user_function', debe ser una llamada. Esto permite que el decorador `lru_cache' se aplique directamente a una función de usuario, dejando el `maxsize' en su valor por defecto de 128:

@example
@@lru_cache
def count_vowels(sentence):
    return sum(sentence.count(vowel) for vowel in 'AEIOUaeiou')
@end example

Si `maxsize' está configurado como @code{None}, la función LRU está desactivada y la caché puede crecer sin límites.

Si `typed' se establece en verdadero, los argumentos de función de diferentes tipos se almacenarán en caché por separado. Si `typed' es falso, la implementación generalmente las considerará como llamadas equivalentes y solo almacenará en caché un único resultado. (Algunos tipos como `str' y `int' pueden almacenarse en caché por separado incluso cuando `typed' es falso).

Tenga en cuenta que la especificidad de tipo se aplica solo a los argumentos inmediatos de la función en lugar de a su contenido. Los argumentos escalares, @code{Decimal(42)} y @code{Fraction(42)} se tratan como llamadas distintas con resultados distintos. Por el contrario, los argumentos de tupla @code{('answer', Decimal(42))} y @code{('answer', Fraction(42))} se tratan como equivalentes.

The wrapped function is instrumented with a @code{cache_parameters()}
function that returns a new @ref{190,,dict} showing the values for `maxsize'
and `typed'.  This is for information purposes only.  Mutating the values
has no effect.

Para ayudar a medir la efectividad de la caché y afinar el parámetro `maxsize', la función envolvente está instrumentada con una función @code{cache_info()} que retorna un @ref{6ef,,named tuple} mostrando `hits', `misses', `maxsize' y `currsize'.

El decorador también proporciona una función @code{cache_clear()} para limpiar o invalidar la caché.

La función subyacente original es accesible a través del atributo @code{__wrapped__}.  Esto es útil para la introspección, para evitar el caché, o para volver a envolver la función con un caché diferente.

La caché mantiene referencias de los argumentos y retorna los valores hasta que se caduquen de la caché o hasta que se borre la caché.

Si un método se almacena en caché, el argumento de la instancia @code{self} se incluye en el caché. Ver @ref{272d,,¿Cómo cacheo llamadas de método?}

An LRU (least recently used) cache@footnote{https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_Recently_Used_(LRU)}
works best when the most recent calls are the best predictors of upcoming
calls (for example, the most popular articles on a news server tend to
change each day).  The cache’s size limit assures that the cache does not
grow without bound on long-running processes such as web servers.

In general, the LRU cache should only be used when you want to reuse
previously computed values.  Accordingly, it doesn’t make sense to cache
functions with side-effects, functions that need to create
distinct mutable objects on each call (such as generators and async functions),
or impure functions such as time() or random().

Ejemplo de un caché de la LRU para contenido web estático:

@example
@@lru_cache(maxsize=32)
def get_pep(num):
    'Retrieve text of a Python Enhancement Proposal'
    resource = f'https://peps.python.org/pep-@{num:04d@}'
    try:
        with urllib.request.urlopen(resource) as s:
            return s.read()
    except urllib.error.HTTPError:
        return 'Not Found'

>>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:
...     pep = get_pep(n)
...     print(n, len(pep))

>>> get_pep.cache_info()
CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)
@end example

Ejemplo de computar eficientemente los números de Fibonacci@footnote{https://en.wikipedia.org/wiki/Fibonacci_number} usando una memoria caché para implementar una técnica de programación dinámica@footnote{https://en.wikipedia.org/wiki/Dynamic_programming}:

@example
@@lru_cache(maxsize=None)
def fib(n):
    if n < 2:
        return n
    return fib(n-1) + fib(n-2)

>>> [fib(n) for n in range(16)]
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]

>>> fib.cache_info()
CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)
@end example


Added in version 3.2.



Distinto en la versión 3.3: Añadida la opción `typed' option.



Distinto en la versión 3.8: Añadida la opción `user_function'.



Distinto en la versión 3.9: Added the function @code{cache_parameters()}

@end deffn

@geindex total_ordering() (en el módulo functools)
@anchor{library/functools functools total_ordering}@anchor{fc2}
@deffn {Función} @@functools.total_ordering

Dada una clase que define uno o más métodos de ordenamiento de comparación ricos, este decorador de clase suministra el resto.  Esto simplifica el esfuerzo de especificar todas las posibles operaciones de comparación rica:

La clase debe definir uno de @code{__lt__()}, @code{__le__()}, @code{__gt__()}, o @code{__ge__()}. Además, la clase debe suministrar un método @code{__eq__()}. Dada una clase que define uno o más métodos de ordenamiento de comparación ricos, este decorador de clase suministra el resto.  Esto simplifica el esfuerzo de especificar todas las posibles operaciones de comparación rica.

Por ejemplo:

@example
@@total_ordering
class Student:
    def _is_valid_operand(self, other):
        return (hasattr(other, "lastname") and
                hasattr(other, "firstname"))
    def __eq__(self, other):
        if not self._is_valid_operand(other):
            return NotImplemented
        return ((self.lastname.lower(), self.firstname.lower()) ==
                (other.lastname.lower(), other.firstname.lower()))
    def __lt__(self, other):
        if not self._is_valid_operand(other):
            return NotImplemented
        return ((self.lastname.lower(), self.firstname.lower()) <
                (other.lastname.lower(), other.firstname.lower()))
@end example

@cartouche
@quotation Nota 
Mientras que este decorador facilita la creación de tipos bien comportados y totalmente ordenados, `does' a costa de una ejecución más lenta y de trazos de pila (`stack traces') más complejos para los métodos de comparación derivados. Si la evaluación comparativa del rendimiento indica que se trata de un cuello de botella para una aplicación determinada, la aplicación de los seis métodos de comparación ricos en su lugar es probable que proporcione un fácil aumento de la velocidad.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Este decorador no intenta anular métodos que han sido declarados en la clase `sus superclases'. Lo que significa que si una superclase define un operador de comparación, `total_ordering' no lo implementará de nuevo, incluso si el método original es abstracto.
@end quotation
@end cartouche


Added in version 3.2.



Distinto en la versión 3.4: Returning @code{NotImplemented} from the underlying comparison function for
unrecognised types is now supported.

@end deffn

@geindex Placeholder (en el módulo functools)
@anchor{library/functools functools Placeholder}@anchor{17c}
@deffn {Dato} functools.Placeholder

A singleton object used as a sentinel to reserve a place
for positional arguments when calling @ref{17a,,partial()}
and @ref{17b,,partialmethod()}.


Added in version 3.14.

@end deffn

@geindex partial() (en el módulo functools)
@anchor{library/functools functools partial}@anchor{17a}
@deffn {Función} functools.partial (func, /, *args, **keywords)

Retorna un nuevo @ref{272e,,partial object} que cuando sea llamado se comportará como `func' llamado con los argumentos posicionales `args' y los argumentos de palabras clave `keywords'. Si se suministran más argumentos a la llamada, se añaden a `args'. Si se suministran más argumentos de palabras clave, se extienden y anulan las `keywords'. Aproximadamente equivalente a:

@example
def partial(func, /, *args, **keywords):
    def newfunc(*more_args, **more_keywords):
        return func(*args, *more_args, **(keywords | more_keywords))
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc
@end example

The @code{partial()} function is used for partial function application which «freezes»
some portion of a function’s arguments and/or keywords resulting in a new object
with a simplified signature.  For example, @ref{17a,,partial()} can be used to create
a callable that behaves like the @ref{1f0,,int()} function where the `base' argument
defaults to @code{2}:

@example
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18
@end example

If @ref{17c,,Placeholder} sentinels are present in `args', they will be filled first
when @code{partial()} is called. This makes it possible to pre-fill any positional
argument with a call to @code{partial()}; without @code{Placeholder}, only the
first positional argument can be pre-filled.

If any @code{Placeholder} sentinels are present, all must be filled at call time:

@example
>>> say_to_world = partial(print, Placeholder, Placeholder, "world!")
>>> say_to_world('Hello', 'dear')
Hello dear world!
@end example

Calling @code{say_to_world('Hello')} raises a @ref{228,,TypeError}, because
only one positional argument is provided, but there are two placeholders
that must be filled in.

If @code{partial()} is applied to an existing @code{partial()} object,
@code{Placeholder} sentinels of the input object are filled in with
new positional arguments.
A placeholder can be retained by inserting a new
@code{Placeholder} sentinel to the place held by a previous @code{Placeholder}:

@example
>>> from functools import partial, Placeholder as _
>>> remove = partial(str.replace, _, _, '@w{'})
>>> message = 'Hello, dear dear world!'
>>> remove(message, ' dear')
'Hello, world!'
>>> remove_dear = partial(remove, _, ' dear')
>>> remove_dear(message)
'Hello, world!'
>>> remove_first_dear = partial(remove_dear, _, 1)
>>> remove_first_dear(message)
'Hello, dear world!'
@end example

@code{Placeholder} has no special treatment when used in a keyword
argument to @code{partial()}.


Distinto en la versión 3.14: Added support for @ref{17c,,Placeholder} in positional arguments.

@end deffn

@geindex partialmethod (clase en functools)
@anchor{library/functools functools partialmethod}@anchor{17b}
@deffn {Clase} functools.partialmethod (func, /, *args, **keywords)

Retorna un nuevo descriptor @ref{17b,,partialmethod} que se comporta como @ref{17a,,partial} excepto que está diseñado para ser usado como una definición de método en lugar de ser directamente invocable.

`func' debe ser un @ref{1f70,,descriptor} o un invocable (los objetos que son ambos, como las funciones normales, se manejan como descriptores).

Cuando `func' es un descriptor (como una función Python normal, @ref{2d2,,classmethod()}, @ref{22e,,staticmethod()}, @code{abstractmethod()} u otra instancia de @ref{17b,,partialmethod}), las llamadas a @code{__get__} se delegan al descriptor subyacente, y se retorna un @ref{272e,,partial object} apropiado como resultado.

Cuando `func' es una llamada no descriptiva, se crea dinámicamente un método de unión apropiado. Esto se comporta como una función Python normal cuando se usa como método: el argumento `self' se insertará como el primer argumento posicional, incluso antes de las `args' y `keywords' suministradas al constructor @ref{17b,,partialmethod}.

Ejemplo:

@example
>>> class Cell:
...     def __init__(self):
...         self._alive = False
...     @@property
...     def alive(self):
...         return self._alive
...     def set_state(self, state):
...         self._alive = bool(state)
...     set_alive = partialmethod(set_state, True)
...     set_dead = partialmethod(set_state, False)
...
>>> c = Cell()
>>> c.alive
False
>>> c.set_alive()
>>> c.alive
True
@end example


Added in version 3.4.

@end deffn

@geindex reduce() (en el módulo functools)
@anchor{library/functools functools reduce}@anchor{17d}
@deffn {Función} functools.reduce (function, iterable, /[, initial])

Apply `function' of two arguments cumulatively to the items of `iterable', from
left to right, so as to reduce the iterable to a single value.  For example,
@code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} calculates @code{((((1+2)+3)+4)+5)}.
The left argument, `x', is the accumulated value and the right argument, `y', is
the update value from the `iterable'.  If the optional `initial' is present,
it is placed before the items of the iterable in the calculation, and serves as
a default when the iterable is empty.  If `initial' is not given and
`iterable' contains only one item, the first item is returned.

Aproximadamente equivalente a:

@example
initial_missing = object()

def reduce(function, iterable, /, initial=initial_missing):
    it = iter(iterable)
    if initial is initial_missing:
        value = next(it)
    else:
        value = initial
    for element in it:
        value = function(value, element)
    return value
@end example

Ver @ref{a8f,,itertools.accumulate()} para un iterador que produce todos los valores intermedios.


Distinto en la versión 3.14.0a1 (unreleased): `initial' is now supported as a keyword argument.

@end deffn

@geindex singledispatch() (en el módulo functools)
@anchor{library/functools functools singledispatch}@anchor{6da}
@deffn {Función} @@functools.singledispatch

Transformar una función en una @ref{a84,,single-dispatch} @ref{a83,,generic function}.

Para definir una función genérica, decórala con el decorador @code{@@singledispatch}. Al definir una función usando @code{@@singledispatch}, tenga en cuenta que el envío ocurre en el tipo del primer argumento:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)
@end example

Para agregar implementaciones sobrecargadas a la función, use el atributo @code{register()} de la función genérica, que se puede usar como decorador. Para las funciones anotadas con tipos, el decorador inferirá automáticamente el tipo del primer argumento:

@example
>>> @@fun.register
... def _(arg: int, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> @@fun.register
... def _(arg: list, verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
@end example

También se pueden utilizar @ref{6db,,types.UnionType} y @ref{6dc,,typing.Union}:

@example
>>> @@fun.register
... def _(arg: int | float, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> from typing import Union
>>> @@fun.register
... def _(arg: Union[list, set], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
...
@end example

Para el código que no utiliza anotaciones de tipo, el argumento de tipo apropiado puede ser pasado explícitamente al propio decorador:

@example
>>> @@fun.register(complex)
... def _(arg, verbose=False):
...     if verbose:
...         print("Better than complicated.", end=" ")
...     print(arg.real, arg.imag)
...
@end example

For code that dispatches on a collections type (e.g., @code{list}), but wants
to typehint the items of the collection (e.g., @code{list[int]}), the
dispatch type should be passed explicitly to the decorator itself with the
typehint going into the function definition:

@example
>>> @@fun.register(list)
... def _(arg: list[int], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
@end example

@cartouche
@quotation Nota 
At runtime the function will dispatch on an instance of a list regardless
of the type contained within the list i.e. @code{[1,2,3]} will be
dispatched the same as @code{["foo", "bar", "baz"]}. The annotation
provided in this example is for static type checkers only and has no
runtime impact.
@end quotation
@end cartouche

Para habilitar el registro de @ref{272f,,lambdas} y funciones preexistentes, el atributo @code{register()} también se puede utilizar de forma funcional:

@example
>>> def nothing(arg, verbose=False):
...     print("Nothing.")
...
>>> fun.register(type(None), nothing)
@end example

El atributo @code{register()} devuelve la función sin decorar. Esto permite el apilamiento de decoradores, @ref{a6,,pickling}, y la creación de pruebas unitarias para cada variante de forma independiente:

@example
>>> @@fun.register(float)
... @@fun.register(Decimal)
... def fun_num(arg, verbose=False):
...     if verbose:
...         print("Half of your number:", end=" ")
...     print(arg / 2)
...
>>> fun_num is fun
False
@end example

Cuando se llama, la función genérica despacha sobre el tipo del primer argumento:

@example
>>> fun("Hello, world.")
Hello, world.
>>> fun("test.", verbose=True)
Let me just say, test.
>>> fun(42, verbose=True)
Strength in numbers, eh? 42
>>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)
Enumerate this:
0 spam
1 spam
2 eggs
3 spam
>>> fun(None)
Nothing.
>>> fun(1.23)
0.615
@end example

Cuando no hay una implementación registrada para un tipo específico, se usa su orden de resolución de métodos para encontrar una implementación más genérica. La función original decorada con @code{@@singledispatch} está registrada para el tipo base @ref{b18,,object}, lo que significa que se usa si no se encuentra una implementación mejor.

Si una implementación está registrada en un @ref{1224,,abstract base class}, las subclases virtuales de la clase base se enviarán a esa implementación:

@example
>>> from collections.abc import Mapping
>>> @@fun.register
... def _(arg: Mapping, verbose=False):
...     if verbose:
...         print("Keys & Values")
...     for key, value in arg.items():
...         print(key, "=>", value)
...
>>> fun(@{"a": "b"@})
a => b
@end example

Para verificar qué implementación elegirá la función genérica para un tipo dado, use el atributo @code{dispatch()}:

@example
>>> fun.dispatch(float)
<function fun_num at 0x1035a2840>
>>> fun.dispatch(dict)    # note: default implementation
<function fun at 0x103fe0000>
@end example

Para acceder a todas las implementaciones registradas, utilice el atributo @code{registry} de sólo lectura:

@example
>>> fun.registry.keys()
dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,
          <class 'decimal.Decimal'>, <class 'list'>,
          <class 'float'>])
>>> fun.registry[float]
<function fun_num at 0x1035a2840>
>>> fun.registry[object]
<function fun at 0x103fe0000>
@end example


Added in version 3.4.



Distinto en la versión 3.7: El atributo @code{register()} ahora admite el uso de anotaciones de tipo.



Distinto en la versión 3.11: El atributo @code{register()} ahora admite @ref{6db,,types.UnionType} y @ref{6dc,,typing.Union} como anotaciones de tipo.

@end deffn

@geindex singledispatchmethod (clase en functools)
@anchor{library/functools functools singledispatchmethod}@anchor{a82}
@deffn {Clase} functools.singledispatchmethod (func)

Transformar un método en un  @ref{a84,,single-dispatch} @ref{a83,,generic function}.

Para definir un método genérico, decóralo con el decorador @code{@@singledispatchmethod}. Al definir una función usando @code{@@singledispatchmethod}, tenga en cuenta que el envío ocurre en el tipo del primer argumento no `self' o no `cls':

@example
class Negator:
    @@singledispatchmethod
    def neg(self, arg):
        raise NotImplementedError("Cannot negate a")

    @@neg.register
    def _(self, arg: int):
        return -arg

    @@neg.register
    def _(self, arg: bool):
        return not arg
@end example

@code{@@singledispatchmethod} admite la anidación con otros decoradores como @ref{2d2,,@@classmethod}. Tenga en cuenta que para permitir @code{dispatcher.register}, @code{singledispatchmethod} debe ser el decorador `más externo'. Aquí está la clase @code{Negator} con los métodos @code{neg} vinculados a la clase, en lugar de una instancia de la clase:

@example
class Negator:
    @@singledispatchmethod
    @@classmethod
    def neg(cls, arg):
        raise NotImplementedError("Cannot negate a")

    @@neg.register
    @@classmethod
    def _(cls, arg: int):
        return -arg

    @@neg.register
    @@classmethod
    def _(cls, arg: bool):
        return not arg
@end example

El mismo patrón se puede utilizar para otros decoradores similares: @ref{22e,,@@staticmethod}, @ref{1102,,@@abstractmethod} y otros.


Added in version 3.8.

@end deffn

@geindex update_wrapper() (en el módulo functools)
@anchor{library/functools functools update_wrapper}@anchor{109e}
@deffn {Función} functools.update_wrapper (wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

Update a `wrapper' function to look like the `wrapped' function. The optional
arguments are tuples to specify which attributes of the original function are
assigned directly to the matching attributes on the wrapper function and which
attributes of the wrapper function are updated with the corresponding attributes
from the original function. The default values for these arguments are the
module level constants @code{WRAPPER_ASSIGNMENTS} (which assigns to the wrapper
function’s @ref{1efb,,__module__}, @ref{133c,,__name__},
@ref{1efa,,__qualname__}, @ref{1245,,__annotations__},
@ref{1efe,,__type_params__}, and @ref{1246,,__doc__}, the
documentation string) and @code{WRAPPER_UPDATES} (which updates the wrapper
function’s @ref{133a,,__dict__}, i.e. the instance dictionary).

Para permitir el acceso a la función original para la introspección y otros propósitos (por ejemplo, evitando un decorador de caché como @ref{a81,,lru_cache()}), esta función añade automáticamente un atributo @code{__wrapped__} al envoltorio que se refiere a la función que se está envolviendo.

El principal uso previsto para esta función es en @ref{7cd,,decorator} functions que envuelven la función decorada y retornan el envoltorio. Si la función de envoltura no se actualiza, los metadatos de la función retornada reflejarán la definición de la envoltura en lugar de la definición de la función original, lo que normalmente no es de gran ayuda.

@ref{109e,,update_wrapper()} puede ser usado con otros invocables que no sean funciones. Cualquier atributo nombrado en `assigned' o `updated' que falte en el objeto que se está invoca se ignora (es decir, esta función no intentará establecerlos en la función de envoltura (`wrapper')). @ref{441,,AttributeError} sigue apareciendo si la propia función de envoltura no tiene ningún atributo nombrado en `updated'.


Distinto en la versión 3.2: The @code{__wrapped__} attribute is now automatically added.
The @ref{1245,,__annotations__} attribute is now copied by default.
Missing attributes no longer trigger an @ref{441,,AttributeError}.



Distinto en la versión 3.4: El atributo @code{__wrapped__} ahora siempre se refiere a la función envuelta, incluso si esa función definió un atributo @code{__wrapped__}. (see bpo-17482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17482})



Distinto en la versión 3.12: The @ref{1efe,,__type_params__} attribute is now copied by default.

@end deffn

@geindex wraps() (en el módulo functools)
@anchor{library/functools functools wraps}@anchor{fdd}
@deffn {Función} @@functools.wraps (wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

Esta es una función conveniente para invocar @ref{109e,,update_wrapper()} como decorador de la función cuando se define una función de envoltura (`wrapper').  Es equivalente a @code{partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)}. Por ejemplo:

@example
>>> from functools import wraps
>>> def my_decorator(f):
...     @@wraps(f)
...     def wrapper(*args, **kwds):
...         print('Calling decorated function')
...         return f(*args, **kwds)
...     return wrapper
...
>>> @@my_decorator
... def example():
...     """Docstring"""
...     print('Called example function')
...
>>> example()
Calling decorated function
Called example function
>>> example.__name__
'example'
>>> example.__doc__
'Docstring'
@end example

Sin el uso de esta fábrica de decoradores, el nombre de la función de ejemplo habría sido @code{'wrapper'}, y el docstring de la @code{example()} se habría perdido.
@end deffn

@menu
* partial Objetos:: 

@end menu

@node partial Objetos,,,functools — Higher-order functions and operations on callable objects
@anchor{library/functools id1}@anchor{2730}@anchor{library/functools partial-objects}@anchor{272e}
@subsubsection @code{partial} Objetos


Los objetos @ref{17a,,partial} son objetos invocables creados por @ref{17a,,partial()}. Tienen tres atributos de sólo lectura:

@geindex func (atributo de functools.partial)
@anchor{library/functools functools partial func}@anchor{2731}
@deffn {Atributo} partial.func

Un objeto o función invocable.  Las llamadas al objeto @ref{17a,,partial} serán reenviadas a @ref{2731,,func} con nuevos argumentos y palabras clave.
@end deffn

@geindex args (atributo de functools.partial)
@anchor{library/functools functools partial args}@anchor{2732}
@deffn {Atributo} partial.args

Los argumentos posicionales de la izquierda que se prepararán para los argumentos posicionales proporcionados un llamado al objeto @ref{17a,,partial}.
@end deffn

@geindex keywords (atributo de functools.partial)
@anchor{library/functools functools partial keywords}@anchor{2733}
@deffn {Atributo} partial.keywords

Los argumentos de la palabra clave que se suministrarán cuando se llame al objeto @ref{17a,,partial}.
@end deffn

@ref{17a,,partial} objects are like @ref{3eb,,function objects} in that they are
callable, weak referenceable, and can have attributes.  There are some important
differences.  For instance, the @ref{10e2,,__name__} and @ref{9bb,,__doc__} attributes
are not created automatically.

@node operator — Standard operators as functions,,functools — Higher-order functions and operations on callable objects,Módulos de programación funcional
@anchor{library/operator doc}@anchor{2734}@anchor{library/operator module-operator}@anchor{9f}@anchor{library/operator operator-standard-operators-as-functions}@anchor{2735}
@subsection @code{operator} — Standard operators as functions


@geindex module; operator

`Código fuente:' Lib/operator.py@footnote{https://github.com/python/cpython/tree/main/Lib/operator.py}

@c import operator
@c from operator import itemgetter, iadd


__________________________________________________________________


El módulo @ref{9f,,operator} exporta un conjunto de funciones eficientes correspondientes a los operadores intrínsecos de Python.  Por ejemplo, @code{operator.add(x, y)} es equivalente a la expresión @code{x+y}. Muchos nombres de función son los utilizados para métodos especiales, sin los dobles guiones bajos.  Por compatibilidad con versiones anteriores, muchos de estos tienen una variante que conserva los dobles guiones bajos . Se prefieren las variantes sin los dobles guiones bajos para mayor claridad.

Las funciones se dividen en categorías que realizan comparaciones de objetos, operaciones lógicas, operaciones matemáticas y operaciones sobre secuencias.

Las funciones de comparación de objetos son útiles para todos los objetos, y llevan el nombre de los operadores de comparación enriquecida que soportan:

@geindex lt() (en el módulo operator)
@geindex le() (en el módulo operator)
@geindex eq() (en el módulo operator)
@geindex ne() (en el módulo operator)
@geindex ge() (en el módulo operator)
@geindex gt() (en el módulo operator)
@geindex __lt__() (en el módulo operator)
@geindex __le__() (en el módulo operator)
@geindex __eq__() (en el módulo operator)
@geindex __ne__() (en el módulo operator)
@geindex __ge__() (en el módulo operator)
@geindex __gt__() (en el módulo operator)
@anchor{library/operator operator lt}@anchor{2736}
@deffn {Función} operator.lt (a, b)
@anchor{library/operator operator le}@anchor{2737}
@deffnx {Función} operator.le (a, b)
@anchor{library/operator operator eq}@anchor{2738}
@deffnx {Función} operator.eq (a, b)
@anchor{library/operator operator ne}@anchor{2739}
@deffnx {Función} operator.ne (a, b)
@anchor{library/operator operator ge}@anchor{273a}
@deffnx {Función} operator.ge (a, b)
@anchor{library/operator operator gt}@anchor{273b}
@deffnx {Función} operator.gt (a, b)
@anchor{library/operator operator __lt__}@anchor{273c}
@deffnx {Función} operator.__lt__ (a, b)
@anchor{library/operator operator __le__}@anchor{273d}
@deffnx {Función} operator.__le__ (a, b)
@anchor{library/operator operator __eq__}@anchor{273e}
@deffnx {Función} operator.__eq__ (a, b)
@anchor{library/operator operator __ne__}@anchor{273f}
@deffnx {Función} operator.__ne__ (a, b)
@anchor{library/operator operator __ge__}@anchor{2740}
@deffnx {Función} operator.__ge__ (a, b)
@anchor{library/operator operator __gt__}@anchor{2741}
@deffnx {Función} operator.__gt__ (a, b)

Realiza «comparaciones enriquecidas» entre `a' y `b'. Específicamente, @code{lt(a, b)} es equivalente a @code{a < b}, @code{le(a, b)} es equivalente a @code{a <= b}, @code{eq(a, b)} es equivalente a @code{a == b}, @code{ne(a, b)} es equivalente a @code{a != b}, @code{gt(a, b)} es equivalente a @code{a > b} y @code{ge(a, b)} es equivalente a @code{a >= b}.  Tenga en cuenta que estas funciones pueden retornar cualquier valor, que puede o no ser interpretable como un valor booleano.  Consulte @ref{2071,,Comparaciones} para obtener más información sobre las comparaciones enriquecidas.
@end deffn

Las operaciones lógicas también son aplicables a todos los objetos, y admiten pruebas de verdad, pruebas de identidad y operaciones booleanas:

@geindex not_() (en el módulo operator)
@geindex __not__() (en el módulo operator)
@anchor{library/operator operator not_}@anchor{2742}
@deffn {Función} operator.not_ (obj)
@anchor{library/operator operator __not__}@anchor{2743}
@deffnx {Función} operator.__not__ (obj)

Return the outcome of @ref{207b,,not} `obj'.  (Note that there is no
@code{__not__()} method for object instances; only the interpreter core defines
this operation.  The result is affected by the @ref{133d,,__bool__()} and
@ref{1f62,,__len__()} methods.)
@end deffn

@geindex truth() (en el módulo operator)
@anchor{library/operator operator truth}@anchor{2744}
@deffn {Función} operator.truth (obj)

Retorna @ref{c95,,True} si `obj' es verdadero, y @ref{bbf,,False} de lo contrario.  Esto equivale a usar el constructor @ref{513,,bool}.
@end deffn

@geindex is_() (en el módulo operator)
@anchor{library/operator operator is_}@anchor{2745}
@deffn {Función} operator.is_ (a, b)

Retorna @code{a is b}.  Chequea la identidad del objeto.
@end deffn

@geindex is_not() (en el módulo operator)
@anchor{library/operator operator is_not}@anchor{2746}
@deffn {Función} operator.is_not (a, b)

Retorna @code{a is not b}.  Chequea la identidad del objeto.
@end deffn

@geindex is_none() (en el módulo operator)
@anchor{library/operator operator is_none}@anchor{192}
@deffn {Función} operator.is_none (a)

Return @code{a is None}.  Tests object identity.


Added in version 3.14.

@end deffn

@geindex is_not_none() (en el módulo operator)
@anchor{library/operator operator is_not_none}@anchor{193}
@deffn {Función} operator.is_not_none (a)

Return @code{a is not None}.  Tests object identity.


Added in version 3.14.

@end deffn

Las operaciones matemáticas y a nivel de bits son las más numerosas:

@geindex abs() (en el módulo operator)
@geindex __abs__() (en el módulo operator)
@anchor{library/operator operator abs}@anchor{2747}
@deffn {Función} operator.abs (obj)
@anchor{library/operator operator __abs__}@anchor{2748}
@deffnx {Función} operator.__abs__ (obj)

Retorna el valor absoluto de `obj'.
@end deffn

@geindex add() (en el módulo operator)
@geindex __add__() (en el módulo operator)
@anchor{library/operator operator add}@anchor{2749}
@deffn {Función} operator.add (a, b)
@anchor{library/operator operator __add__}@anchor{274a}
@deffnx {Función} operator.__add__ (a, b)

Retorna @code{a + b},  para los números `a' y `b'.
@end deffn

@geindex and_() (en el módulo operator)
@geindex __and__() (en el módulo operator)
@anchor{library/operator operator and_}@anchor{274b}
@deffn {Función} operator.and_ (a, b)
@anchor{library/operator operator __and__}@anchor{274c}
@deffnx {Función} operator.__and__ (a, b)

Retorna la «conjunción bit a bit» (`bitwise and') de `a' y `b'.
@end deffn

@geindex floordiv() (en el módulo operator)
@geindex __floordiv__() (en el módulo operator)
@anchor{library/operator operator floordiv}@anchor{274d}
@deffn {Función} operator.floordiv (a, b)
@anchor{library/operator operator __floordiv__}@anchor{274e}
@deffnx {Función} operator.__floordiv__ (a, b)

Retorna @code{a // b}.
@end deffn

@geindex index() (en el módulo operator)
@geindex __index__() (en el módulo operator)
@anchor{library/operator operator index}@anchor{1917}
@deffn {Función} operator.index (a)
@anchor{library/operator operator __index__}@anchor{274f}
@deffnx {Función} operator.__index__ (a)

Retorna `a' convertido a un número entero. Equivalente a @code{a.__index__()}.


Distinto en la versión 3.10: El resultado siempre tiene el tipo exacto @ref{1f0,,int}. Anteriormente, el resultado podría haber sido una instancia de una subclase de @code{int}.

@end deffn

@geindex inv() (en el módulo operator)
@geindex invert() (en el módulo operator)
@geindex __inv__() (en el módulo operator)
@geindex __invert__() (en el módulo operator)
@anchor{library/operator operator inv}@anchor{2750}
@deffn {Función} operator.inv (obj)
@anchor{library/operator operator invert}@anchor{2751}
@deffnx {Función} operator.invert (obj)
@anchor{library/operator operator __inv__}@anchor{2752}
@deffnx {Función} operator.__inv__ (obj)
@anchor{library/operator operator __invert__}@anchor{2753}
@deffnx {Función} operator.__invert__ (obj)

Retorna el «inverso bit a bit» (`bitwise inverse') del número `obj'. Esto es equivalente a @code{~obj}.
@end deffn

@geindex lshift() (en el módulo operator)
@geindex __lshift__() (en el módulo operator)
@anchor{library/operator operator lshift}@anchor{2754}
@deffn {Función} operator.lshift (a, b)
@anchor{library/operator operator __lshift__}@anchor{2755}
@deffnx {Función} operator.__lshift__ (a, b)

Retorna `a' desplazado a izquierda (`shift left') `b' bits.
@end deffn

@geindex mod() (en el módulo operator)
@geindex __mod__() (en el módulo operator)
@anchor{library/operator operator mod}@anchor{2756}
@deffn {Función} operator.mod (a, b)
@anchor{library/operator operator __mod__}@anchor{2757}
@deffnx {Función} operator.__mod__ (a, b)

Retorna @code{a % b}.
@end deffn

@geindex mul() (en el módulo operator)
@geindex __mul__() (en el módulo operator)
@anchor{library/operator operator mul}@anchor{2729}
@deffn {Función} operator.mul (a, b)
@anchor{library/operator operator __mul__}@anchor{2758}
@deffnx {Función} operator.__mul__ (a, b)

Retorna @code{a * b}, para los números  `a' y `b'.
@end deffn

@geindex matmul() (en el módulo operator)
@geindex __matmul__() (en el módulo operator)
@anchor{library/operator operator matmul}@anchor{eba}
@deffn {Función} operator.matmul (a, b)
@anchor{library/operator operator __matmul__}@anchor{2759}
@deffnx {Función} operator.__matmul__ (a, b)

Retorna @code{a @@ b}.


Added in version 3.5.

@end deffn

@geindex neg() (en el módulo operator)
@geindex __neg__() (en el módulo operator)
@anchor{library/operator operator neg}@anchor{275a}
@deffn {Función} operator.neg (obj)
@anchor{library/operator operator __neg__}@anchor{275b}
@deffnx {Función} operator.__neg__ (obj)

Retorna `obj' negado (@code{-obj}).
@end deffn

@geindex or_() (en el módulo operator)
@geindex __or__() (en el módulo operator)
@anchor{library/operator operator or_}@anchor{275c}
@deffn {Función} operator.or_ (a, b)
@anchor{library/operator operator __or__}@anchor{275d}
@deffnx {Función} operator.__or__ (a, b)

Retorna la «disyunción bit a bit» (`bitwise or') de `a' y `b'.
@end deffn

@geindex pos() (en el módulo operator)
@geindex __pos__() (en el módulo operator)
@anchor{library/operator operator pos}@anchor{275e}
@deffn {Función} operator.pos (obj)
@anchor{library/operator operator __pos__}@anchor{275f}
@deffnx {Función} operator.__pos__ (obj)

Retorna `obj' positivo (@code{+obj}).
@end deffn

@geindex pow() (en el módulo operator)
@geindex __pow__() (en el módulo operator)
@anchor{library/operator operator pow}@anchor{2760}
@deffn {Función} operator.pow (a, b)
@anchor{library/operator operator __pow__}@anchor{2761}
@deffnx {Función} operator.__pow__ (a, b)

Retorna @code{a ** b}, para los números `a' y `b'.
@end deffn

@geindex rshift() (en el módulo operator)
@geindex __rshift__() (en el módulo operator)
@anchor{library/operator operator rshift}@anchor{2762}
@deffn {Función} operator.rshift (a, b)
@anchor{library/operator operator __rshift__}@anchor{2763}
@deffnx {Función} operator.__rshift__ (a, b)

Retorna `a' desplazado a derecha (`shift right') `b' bits.
@end deffn

@geindex sub() (en el módulo operator)
@geindex __sub__() (en el módulo operator)
@anchor{library/operator operator sub}@anchor{2764}
@deffn {Función} operator.sub (a, b)
@anchor{library/operator operator __sub__}@anchor{2765}
@deffnx {Función} operator.__sub__ (a, b)

Retorna @code{a - b}.
@end deffn

@geindex truediv() (en el módulo operator)
@geindex __truediv__() (en el módulo operator)
@anchor{library/operator operator truediv}@anchor{2766}
@deffn {Función} operator.truediv (a, b)
@anchor{library/operator operator __truediv__}@anchor{2767}
@deffnx {Función} operator.__truediv__ (a, b)

Retorna  @code{a / b} donde 2/3 es .66 en lugar de 0. Esto también se conoce como división «real» (`true division').
@end deffn

@geindex xor() (en el módulo operator)
@geindex __xor__() (en el módulo operator)
@anchor{library/operator operator xor}@anchor{2768}
@deffn {Función} operator.xor (a, b)
@anchor{library/operator operator __xor__}@anchor{2769}
@deffnx {Función} operator.__xor__ (a, b)

Retorna la disyunción exclusiva bit a bit (`bitwise exclusive or') de `a' y `b'.
@end deffn

Las operaciones que funcionan con secuencias (y algunas de ellas también con mapeos) incluyen:

@geindex concat() (en el módulo operator)
@geindex __concat__() (en el módulo operator)
@anchor{library/operator operator concat}@anchor{276a}
@deffn {Función} operator.concat (a, b)
@anchor{library/operator operator __concat__}@anchor{276b}
@deffnx {Función} operator.__concat__ (a, b)

Retorna @code{a + b} para las secuencias `a' y `b'.
@end deffn

@geindex contains() (en el módulo operator)
@geindex __contains__() (en el módulo operator)
@anchor{library/operator operator contains}@anchor{971}
@deffn {Función} operator.contains (a, b)
@anchor{library/operator operator __contains__}@anchor{276c}
@deffnx {Función} operator.__contains__ (a, b)

Retorna el resultado del chequeo @code{b in a}. Notar que los operandos se invirtieron.
@end deffn

@geindex countOf() (en el módulo operator)
@anchor{library/operator operator countOf}@anchor{973}
@deffn {Función} operator.countOf (a, b)

Retorna el número de ocurrencias de `b' en `a'.
@end deffn

@geindex delitem() (en el módulo operator)
@geindex __delitem__() (en el módulo operator)
@anchor{library/operator operator delitem}@anchor{276d}
@deffn {Función} operator.delitem (a, b)
@anchor{library/operator operator __delitem__}@anchor{276e}
@deffnx {Función} operator.__delitem__ (a, b)

Remueve el valor de `a' en el índice `b'.
@end deffn

@geindex getitem() (en el módulo operator)
@geindex __getitem__() (en el módulo operator)
@anchor{library/operator operator getitem}@anchor{276f}
@deffn {Función} operator.getitem (a, b)
@anchor{library/operator operator __getitem__}@anchor{2770}
@deffnx {Función} operator.__getitem__ (a, b)

Retorna el valor de `a' en el índice `b'.
@end deffn

@geindex indexOf() (en el módulo operator)
@anchor{library/operator operator indexOf}@anchor{972}
@deffn {Función} operator.indexOf (a, b)

Retorna el índice de la primera ocurrencia de `b' en `a'.
@end deffn

@geindex setitem() (en el módulo operator)
@geindex __setitem__() (en el módulo operator)
@anchor{library/operator operator setitem}@anchor{2771}
@deffn {Función} operator.setitem (a, b, c)
@anchor{library/operator operator __setitem__}@anchor{2772}
@deffnx {Función} operator.__setitem__ (a, b, c)

Establece el valor de `a' en el índice `b' a `c'.
@end deffn

@geindex length_hint() (en el módulo operator)
@anchor{library/operator operator length_hint}@anchor{fec}
@deffn {Función} operator.length_hint (obj, default=0)

Return an estimated length for the object `obj'. First try to return its
actual length, then an estimate using @ref{f8e,,object.__length_hint__()}, and
finally return the default value.


Added in version 3.4.

@end deffn

La siguiente operación funciona con invocables:

@geindex call() (en el módulo operator)
@geindex __call__() (en el módulo operator)
@anchor{library/operator operator call}@anchor{1885}
@deffn {Función} operator.call (obj, /, *args, **kwargs)
@anchor{library/operator operator __call__}@anchor{2773}
@deffnx {Función} operator.__call__ (obj, /, *args, **kwargs)

Retorna @code{obj(*args, **kwargs)}.


Added in version 3.11.

@end deffn

El módulo @ref{9f,,operator} también define herramientas para la obtención generalizada de atributos e ítems. Estas herramientas son útiles para utilizar rápidamente extractores de campos como argumentos de @ref{14c,,map()}, @ref{c56,,sorted()}, @ref{2724,,itertools.groupby()}, u otras funciones que esperan una función como argumento.

@geindex attrgetter() (en el módulo operator)
@anchor{library/operator operator attrgetter}@anchor{eb8}
@deffn {Función} operator.attrgetter (attr)

@deffnx {Función} operator.attrgetter (*attrs)

Retorna un objeto invocable que obtiene `attr' de su operando. Si se solicita más de un atributo, retorna una tupla de los atributos. Los nombres de los atributos también pueden contener puntos. Por ejemplo:


@itemize *

@item 
Después de @code{f = attrgetter('name')}, la llamada @code{f(b)} retorna @code{b.name}.

@item 
Después de @code{f = attrgetter('name', 'date')}, la llamada @code{f(b)} retorna @code{(b.name, b.date)}.

@item 
Después de @code{f = attrgetter('name.first', 'name.last')}, la llamada @code{f(b)} retorna @code{(b.name.first, b.name.last)}.
@end itemize

Equivalente a:

@example
def attrgetter(*items):
    if any(not isinstance(item, str) for item in items):
        raise TypeError('attribute name must be a string')
    if len(items) == 1:
        attr = items[0]
        def g(obj):
            return resolve_attr(obj, attr)
    else:
        def g(obj):
            return tuple(resolve_attr(obj, attr) for attr in items)
    return g

def resolve_attr(obj, attr):
    for name in attr.split("."):
        obj = getattr(obj, name)
    return obj
@end example
@end deffn

@geindex itemgetter() (en el módulo operator)
@anchor{library/operator operator itemgetter}@anchor{af2}
@deffn {Función} operator.itemgetter (item)

@deffnx {Función} operator.itemgetter (*items)

Return a callable object that fetches `item' from its operand using the
operand’s @ref{3d8,,__getitem__()} method.  If multiple items are specified,
returns a tuple of lookup values.  For example:


@itemize *

@item 
Después de @code{f = itemgetter(2)}, la llamada @code{f(r)} retorna @code{r[2]}.

@item 
Después de @code{g = itemgetter(2, 5, 3)}, la llamada @code{g(r)} retorna @code{(r[2], r[5], r[3])}.
@end itemize

Equivalente a:

@example
def itemgetter(*items):
    if len(items) == 1:
        item = items[0]
        def g(obj):
            return obj[item]
    else:
        def g(obj):
            return tuple(obj[item] for item in items)
    return g
@end example

The items can be any type accepted by the operand’s @ref{3d8,,__getitem__()}
method.  Dictionaries accept any @ref{6b1,,hashable} value.  Lists, tuples, and
strings accept an index or a slice:

@example
>>> itemgetter(1)('ABCDEFG')
'B'
>>> itemgetter(1, 3, 5)('ABCDEFG')
('B', 'D', 'F')
>>> itemgetter(slice(2, None))('ABCDEFG')
'CDEFG'
>>> soldier = dict(rank='captain', name='dotterbart')
>>> itemgetter('rank')(soldier)
'captain'
@end example

Ejemplos que utilizan @ref{af2,,itemgetter()} para obtener campos específicos de un registro tupla:

@example
>>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
>>> getcount = itemgetter(1)
>>> list(map(getcount, inventory))
[3, 2, 5, 1]
>>> sorted(inventory, key=getcount)
[('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]
@end example
@end deffn

@geindex methodcaller() (en el módulo operator)
@anchor{library/operator operator methodcaller}@anchor{eb9}
@deffn {Función} operator.methodcaller (name, /, *args, **kwargs)

Retorna un objeto invocable que a su vez invoca al método `name' sobre su operando. Si se pasan argumentos adicionales y/o argumentos por palabra clave, estos serán a su vez pasados al método. Por ejemplo:


@itemize *

@item 
Después de @code{f = methodcaller('name')}, la llamada @code{f(b)} retorna @code{b.name()}.

@item 
Después de @code{f = methodcaller('name', 'foo', bar=1)}, la llamada @code{f(b)} retorna @code{b.name('foo', bar=1)}.
@end itemize

Equivalente a:

@example
def methodcaller(name, /, *args, **kwargs):
    def caller(obj):
        return getattr(obj, name)(*args, **kwargs)
    return caller
@end example
@end deffn

@menu
* Asignación de operadores a funciones:: 
* Operadores In-place:: 

@end menu

@node Asignación de operadores a funciones,Operadores In-place,,operator — Standard operators as functions
@anchor{library/operator mapping-operators-to-functions}@anchor{2774}@anchor{library/operator operator-map}@anchor{2775}
@subsubsection Asignación de operadores a funciones


Esta tabla muestra cómo operaciones abstractas se corresponden con operadores simbólicos en la sintaxis de Python y las funciones en el módulo @ref{9f,,operator}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operación

@tab

Sintaxis

@tab

Función

@item

Adición

@tab

@code{a + b}

@tab

@code{add(a, b)}

@item

Concatenación

@tab

@code{seq1 + seq2}

@tab

@code{concat(seq1, seq2)}

@item

Chequeo de pertenencia

@tab

@code{obj in seq}

@tab

@code{contains(seq, obj)}

@item

División

@tab

@code{a / b}

@tab

@code{truediv(a, b)}

@item

División

@tab

@code{a // b}

@tab

@code{floordiv(a, b)}

@item

Conjunción lógica bit a bit (`bitwise and')

@tab

@code{a & b}

@tab

@code{and_(a, b)}

@item

Disyunción lógica bit a bit (`bitwise exclusive or')

@tab

@code{a ^ b}

@tab

@code{xor(a, b)}

@item

Inversión bit a bit (`bitwise inversion')

@tab

@code{~ a}

@tab

@code{invert(a)}

@item

Disyunción lógica bit a bit (`bitwise or')

@tab

@code{a | b}

@tab

@code{or_(a, b)}

@item

Exponenciación

@tab

@code{a ** b}

@tab

@code{pow(a, b)}

@item

Identidad

@tab

@code{a is b}

@tab

@code{is_(a, b)}

@item

Identidad

@tab

@code{a is not b}

@tab

@code{is_not(a, b)}

@item

Identidad

@tab

@code{a is None}

@tab

@code{is_none(a)}

@item

Identidad

@tab

@code{a is not None}

@tab

@code{is_not_none(a)}

@item

Asignación indexada

@tab

@code{obj[k] = v}

@tab

@code{setitem(obj, k, v)}

@item

Eliminación indexada

@tab

@code{del obj[k]}

@tab

@code{delitem(obj, k)}

@item

Indexado

@tab

@code{obj[k]}

@tab

@code{getitem(obj, k)}

@item

Desplazamiento a izquierda (`left shift')

@tab

@code{a << b}

@tab

@code{lshift(a, b)}

@item

Módulo

@tab

@code{a % b}

@tab

@code{mod(a, b)}

@item

Multiplicación

@tab

@code{a * b}

@tab

@code{mul(a, b)}

@item

Multiplicación de matrices

@tab

@code{a @@ b}

@tab

@code{matmul(a, b)}

@item

Negación (aritmética)

@tab

@code{- a}

@tab

@code{neg(a)}

@item

Negación (lógica)

@tab

@code{not a}

@tab

@code{not_(a)}

@item

Positivo

@tab

@code{+ a}

@tab

@code{pos(a)}

@item

Desplazamiento a derecha (`right shift')

@tab

@code{a >> b}

@tab

@code{rshift(a, b)}

@item

Asignación por segmento

@tab

@code{seq[i:j] = values}

@tab

@code{setitem(seq, slice(i, j), values)}

@item

Eliminación por segmento

@tab

@code{del seq[i:j]}

@tab

@code{delitem(seq, slice(i, j))}

@item

Segmentación

@tab

@code{seq[i:j]}

@tab

@code{getitem(seq, slice(i, j))}

@item

Formateo de cadenas

@tab

@code{s % obj}

@tab

@code{mod(s, obj)}

@item

Sustracción

@tab

@code{a - b}

@tab

@code{sub(a, b)}

@item

Chequeo de verdad

@tab

@code{obj}

@tab

@code{truth(obj)}

@item

Ordenado

@tab

@code{a < b}

@tab

@code{lt(a, b)}

@item

Ordenado

@tab

@code{a <= b}

@tab

@code{le(a, b)}

@item

Igualdad

@tab

@code{a == b}

@tab

@code{eq(a, b)}

@item

Diferencia

@tab

@code{a != b}

@tab

@code{ne(a, b)}

@item

Ordenado

@tab

@code{a >= b}

@tab

@code{ge(a, b)}

@item

Ordenado

@tab

@code{a > b}

@tab

@code{gt(a, b)}

@end multitable


@node Operadores In-place,,Asignación de operadores a funciones,operator — Standard operators as functions
@anchor{library/operator in-place-operators}@anchor{2776}
@subsubsection Operadores `In-place'


Muchas operaciones tienen una versión `«in-place»'. Abajo se listan las funciones que proveen un acceso más primitivo a operadores `in-place' que la sintaxis usual; por ejemplo, el @ref{2777,,statement} @code{x += y} es equivalente a @code{x = operator.iadd(x, y)}. Otra forma de decirlo es que @code{z = operator.iadd(x, y)} es equivalente a la sentencia (`statement') compuesta @code{z = x; z += y}.

En esos ejemplo, notar que cuando se invoca un método `in-place', el cómputo y la asignación se realizan en dos pasos separados. Las funciones `in-place' que se listan aquí debajo solo hacen el primer paso, llamar al método `in-place'. El segundo paso, la asignación, no se gestiona.

Para objetivos inmutables como cadenas de caracteres, números, y tuplas, el valor actualizado es computado, pero no es asignado de nuevo a la variable de entrada:

@example
>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'
@end example

Para objetivos mutables como listas y diccionarios, el método `in-place' realiza la actualización, así que no es necesaria una asignación subsiguiente:

@example
>>> s = ['h', 'e', 'l', 'l', 'o']
>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
>>> s
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
@end example

@geindex iadd() (en el módulo operator)
@geindex __iadd__() (en el módulo operator)
@anchor{library/operator operator iadd}@anchor{2778}
@deffn {Función} operator.iadd (a, b)
@anchor{library/operator operator __iadd__}@anchor{2779}
@deffnx {Función} operator.__iadd__ (a, b)

@code{a = iadd(a, b)} es equivalente a @code{a += b}.
@end deffn

@geindex iand() (en el módulo operator)
@geindex __iand__() (en el módulo operator)
@anchor{library/operator operator iand}@anchor{277a}
@deffn {Función} operator.iand (a, b)
@anchor{library/operator operator __iand__}@anchor{277b}
@deffnx {Función} operator.__iand__ (a, b)

@code{a = iand(a, b)} es equivalente a @code{a &= b}.
@end deffn

@geindex iconcat() (en el módulo operator)
@geindex __iconcat__() (en el módulo operator)
@anchor{library/operator operator iconcat}@anchor{277c}
@deffn {Función} operator.iconcat (a, b)
@anchor{library/operator operator __iconcat__}@anchor{277d}
@deffnx {Función} operator.__iconcat__ (a, b)

@code{a = iconcat(a, b)} es equivalente a @code{a += b} para dos `a' y `b' secuencias.
@end deffn

@geindex ifloordiv() (en el módulo operator)
@geindex __ifloordiv__() (en el módulo operator)
@anchor{library/operator operator ifloordiv}@anchor{277e}
@deffn {Función} operator.ifloordiv (a, b)
@anchor{library/operator operator __ifloordiv__}@anchor{277f}
@deffnx {Función} operator.__ifloordiv__ (a, b)

@code{a = ifloordiv(a, b)} es equivalente a @code{a //= b}.
@end deffn

@geindex ilshift() (en el módulo operator)
@geindex __ilshift__() (en el módulo operator)
@anchor{library/operator operator ilshift}@anchor{2780}
@deffn {Función} operator.ilshift (a, b)
@anchor{library/operator operator __ilshift__}@anchor{2781}
@deffnx {Función} operator.__ilshift__ (a, b)

@code{a = ilshift(a, b)} es equivalente a @code{a <<= b}.
@end deffn

@geindex imod() (en el módulo operator)
@geindex __imod__() (en el módulo operator)
@anchor{library/operator operator imod}@anchor{2782}
@deffn {Función} operator.imod (a, b)
@anchor{library/operator operator __imod__}@anchor{2783}
@deffnx {Función} operator.__imod__ (a, b)

@code{a = imod(a, b)} es equivalente a @code{a %= b}.
@end deffn

@geindex imul() (en el módulo operator)
@geindex __imul__() (en el módulo operator)
@anchor{library/operator operator imul}@anchor{2784}
@deffn {Función} operator.imul (a, b)
@anchor{library/operator operator __imul__}@anchor{2785}
@deffnx {Función} operator.__imul__ (a, b)

@code{a = imul(a, b)} es equivalente a @code{a *= b}.
@end deffn

@geindex imatmul() (en el módulo operator)
@geindex __imatmul__() (en el módulo operator)
@anchor{library/operator operator imatmul}@anchor{ebb}
@deffn {Función} operator.imatmul (a, b)
@anchor{library/operator operator __imatmul__}@anchor{2786}
@deffnx {Función} operator.__imatmul__ (a, b)

@code{a = imul(a, b)} es equivalente a @code{a *= b}.


Added in version 3.5.

@end deffn

@geindex ior() (en el módulo operator)
@geindex __ior__() (en el módulo operator)
@anchor{library/operator operator ior}@anchor{2787}
@deffn {Función} operator.ior (a, b)
@anchor{library/operator operator __ior__}@anchor{2788}
@deffnx {Función} operator.__ior__ (a, b)

@code{a = ior(a, b)} es equivalente a @code{a |= b}.
@end deffn

@geindex ipow() (en el módulo operator)
@geindex __ipow__() (en el módulo operator)
@anchor{library/operator operator ipow}@anchor{2789}
@deffn {Función} operator.ipow (a, b)
@anchor{library/operator operator __ipow__}@anchor{278a}
@deffnx {Función} operator.__ipow__ (a, b)

@code{a = ipow(a, b)} es equivalente a @code{a **= b}.
@end deffn

@geindex irshift() (en el módulo operator)
@geindex __irshift__() (en el módulo operator)
@anchor{library/operator operator irshift}@anchor{278b}
@deffn {Función} operator.irshift (a, b)
@anchor{library/operator operator __irshift__}@anchor{278c}
@deffnx {Función} operator.__irshift__ (a, b)

@code{a = irshift(a, b)} es equivalente a @code{a >>= b}.
@end deffn

@geindex isub() (en el módulo operator)
@geindex __isub__() (en el módulo operator)
@anchor{library/operator operator isub}@anchor{278d}
@deffn {Función} operator.isub (a, b)
@anchor{library/operator operator __isub__}@anchor{278e}
@deffnx {Función} operator.__isub__ (a, b)

@code{a = isub(a, b)} es equivalente a @code{a -= b}.
@end deffn

@geindex itruediv() (en el módulo operator)
@geindex __itruediv__() (en el módulo operator)
@anchor{library/operator operator itruediv}@anchor{278f}
@deffn {Función} operator.itruediv (a, b)
@anchor{library/operator operator __itruediv__}@anchor{2790}
@deffnx {Función} operator.__itruediv__ (a, b)

@code{a = itruediv(a, b)} es equivalente a @code{a /= b}.
@end deffn

@geindex ixor() (en el módulo operator)
@geindex __ixor__() (en el módulo operator)
@anchor{library/operator operator ixor}@anchor{2791}
@deffn {Función} operator.ixor (a, b)
@anchor{library/operator operator __ixor__}@anchor{2792}
@deffnx {Función} operator.__ixor__ (a, b)

@code{a = ixor(a, b)} es equivalente a @code{a ^= b}.
@end deffn

@node Acceso a archivos y directorios,Persistencia de datos,Módulos de programación funcional,La biblioteca estándar de Python
@anchor{library/filesys doc}@anchor{2793}@anchor{library/filesys file-and-directory-access}@anchor{2794}@anchor{library/filesys filesys}@anchor{2795}
@section Acceso a archivos y directorios


Los módulos descritos en este capítulo tratan de archivos de disco y directorios.  Por ejemplo, hay módulos para leer las propiedades de los archivos, manipular rutas de acceso de forma portátil y crear archivos temporales.  La lista completa de módulos en este capítulo es:

@menu
* pathlib — Object-oriented filesystem paths:: 
* os.path — Common pathname manipulations: os path — Common pathname manipulations. 
* fileinput — Iterate over lines from multiple input streams:: 
* stat — Interpreting stat() results: stat — Interpreting stat results. 
* filecmp — File and Directory Comparisons:: 
* tempfile — Generate temporary files and directories:: 
* glob — Unix style pathname pattern expansion:: 
* fnmatch — Unix filename pattern matching:: 
* linecache — Random access to text lines:: 
* shutil — High-level file operations:: 

@end menu

@node pathlib — Object-oriented filesystem paths,os path — Common pathname manipulations,,Acceso a archivos y directorios
@anchor{library/pathlib doc}@anchor{2796}@anchor{library/pathlib module-pathlib}@anchor{a4}@anchor{library/pathlib pathlib-object-oriented-filesystem-paths}@anchor{2797}
@subsection @code{pathlib} — Object-oriented filesystem paths


@geindex module; pathlib


Added in version 3.4.


`Source code:' Lib/pathlib/@footnote{https://github.com/python/cpython/tree/main/Lib/pathlib/}

@geindex path;operations


__________________________________________________________________


Este módulo ofrece clases que representan rutas del sistema de archivos con semántica apropiada para diferentes sistemas operativos. Las clases ruta se dividen entre @ref{2798,,rutas puras}, que proporcionan operaciones puramente computacionales sin E/S; y @ref{2799,,rutas concretas}, que heredan de rutas puras pero también proporcionan operaciones de E/S.

@image{python-figures/pathlib-inheritance,,,Inheritance diagram showing the classes available in pathlib. The most basic class is PurePath@comma{} which has three direct subclasses: PurePosixPath@comma{} PureWindowsPath@comma{} and Path. Further to these four classes@comma{} there are two classes that use multiple inheritance: PosixPath subclasses PurePosixPath and Path@comma{} and WindowsPath subclasses PureWindowsPath and Path.,png}

Si nunca has usado este módulo o simplemente no estás seguro de qué clase es la adecuada para tu tarea, @ref{19b,,Path} es probablemente lo que necesitas. Crea una instancia @ref{2799,,ruta concreta} para la plataforma en la que se ejecuta el código.

Las rutas puras son útiles en algunos casos especiales, por ejemplo:


@enumerate 

@item 
Si deseas manipular las rutas de Windows en una máquina Unix (o viceversa). No puedes crear una instancia de @ref{279a,,WindowsPath} cuando se ejecuta en Unix, pero puedes crear una instancia de @ref{170a,,PureWindowsPath}.

@item 
Desea asegurar que su código solo manipule rutas sin acceder realmente al sistema operativo. En este caso, crear instancias de una de las clases puras puede ser útil, ya que simplemente no tienen ninguna operación de acceso al sistema operativo.
@end enumerate


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/}: El módulo pathlib – rutas de sistema orientadas a objetos.



@subsubheading Ver también


Para la manipulación de rutas de bajo nivel en cadenas, también puede usar el módulo @ref{a2,,os.path}.


@menu
* Uso básico:: 
* Exceptions:: 
* Rutas puras:: 
* Rutas concretas:: 
* Pattern language:: 
* Comparison to the glob module:: 
* Comparison to the os and os.path modules: Comparison to the os and os path modules. 

@end menu

@node Uso básico,Exceptions,,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib basic-use}@anchor{279b}
@subsubsection Uso básico


Importar la clase principal:

@example
>>> from pathlib import Path
@end example

Listado de subdirectorios:

@example
>>> p = Path('.')
>>> [x for x in p.iterdir() if x.is_dir()]
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
 PosixPath('__pycache__'), PosixPath('build')]
@end example

Listado de archivos fuente de Python en este árbol de directorios:

@example
>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
 PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
 PosixPath('build/lib/pathlib.py')]
@end example

Navegar dentro de un árbol de directorios:

@example
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')
@end example

Consultar propiedades de ruta:

@example
>>> q.exists()
True
>>> q.is_dir()
False
@end example

Abrir un archivo:

@example
>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'
@end example

@node Exceptions,Rutas puras,Uso básico,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib exceptions}@anchor{279c}
@subsubsection Exceptions


@geindex UnsupportedOperation
@anchor{library/pathlib pathlib UnsupportedOperation}@anchor{383}
@deffn {Excepción} pathlib.UnsupportedOperation

An exception inheriting @ref{384,,NotImplementedError} that is raised when an
unsupported operation is called on a path object.


Added in version 3.13.

@end deffn

@node Rutas puras,Rutas concretas,Exceptions,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib id1}@anchor{279d}@anchor{library/pathlib pure-paths}@anchor{2798}
@subsubsection Rutas puras


Los objetos ruta pura proporcionan operaciones de manejo de rutas que en realidad no acceden al sistema de archivos. Hay tres formas de acceder a estas clases, que llamaremos `familias':

@geindex PurePath (clase en pathlib)
@anchor{library/pathlib pathlib PurePath}@anchor{54e}
@deffn {Clase} pathlib.PurePath (*pathsegments)

Una clase genérica que representa la familia de rutas del sistema (al crear una instancia se crea @ref{279e,,PurePosixPath} o @ref{170a,,PureWindowsPath}):

@example
>>> PurePath('setup.py')      # Running on a Unix machine
PurePosixPath('setup.py')
@end example

Cada elemento de `pathsegments' puede ser una cadena que representa un segmento de ruta o un objeto que implemente la interfaz @ref{cd9,,os.PathLike} donde el método @ref{cda,,__fspath__()} retorna una cadena como otro objeto de ruta:

@example
>>> PurePath('foo', 'some/path', 'bar')
PurePosixPath('foo/some/path/bar')
>>> PurePath(Path('foo'), Path('bar'))
PurePosixPath('foo/bar')
@end example

Cuando `pathsegments' está vacío, se asume el directorio actual:

@example
>>> PurePath()
PurePosixPath('.')
@end example

Si un segmento es una ruta absoluta, se ignoran todos los segmentos anteriores (como @ref{163f,,os.path.join()}):

@example
>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')
@end example

En Windows, la unidad no se restablece cuando se encuentra un segmento de ruta relativa en la raíz (por ejemplo, @code{r'\foo'}):

@example
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

Las barras espurias y los puntos simples se colapsan, pero los puntos dobles (@code{'..'}) y las barras dobles iniciales (@code{'//'}) no, ya que esto cambiaría el significado de una ruta por varias razones (por ejemplo, enlaces simbólicos, rutas UNC):

@example
>>> PurePath('foo//bar')
PurePosixPath('foo/bar')
>>> PurePath('//foo/bar')
PurePosixPath('//foo/bar')
>>> PurePath('foo/./bar')
PurePosixPath('foo/bar')
>>> PurePath('foo/../bar')
PurePosixPath('foo/../bar')
@end example

(un enfoque naif haría pensar que @code{PurePosixPath('foo/../bar')} es equivalente a @code{PurePosixPath('bar')}, lo cual es incorrecto si @code{foo} es un enlace simbólico a otro directorio)

Los objetos ruta pura implementan la interfaz @ref{cd9,,os.PathLike}, lo que permite su uso en cualquier lugar donde se acepte la interfaz.


Distinto en la versión 3.6: Se agregó soporte para la interfaz @ref{cd9,,os.PathLike}.

@end deffn

@geindex PurePosixPath (clase en pathlib)
@anchor{library/pathlib pathlib PurePosixPath}@anchor{279e}
@deffn {Clase} pathlib.PurePosixPath (*pathsegments)

Una subclase de @ref{54e,,PurePath}, esta `familia' representa rutas que no son del sistema de archivos de Windows:

@example
>>> PurePosixPath('/etc/hosts')
PurePosixPath('/etc/hosts')
@end example

`pathsegments' se especifica de manera similar a @ref{54e,,PurePath}.
@end deffn

@geindex PureWindowsPath (clase en pathlib)
@anchor{library/pathlib pathlib PureWindowsPath}@anchor{170a}
@deffn {Clase} pathlib.PureWindowsPath (*pathsegments)

Una subclase de @ref{54e,,PurePath}, este tipo de ruta representa las rutas del sistema de archivos de Windows, incluido UNC paths@footnote{https://en.wikipedia.org/wiki/Path_(computing)#UNC}:

@example
>>> PureWindowsPath('c:/', 'Users', 'Ximénez')
PureWindowsPath('c:/Users/Ximénez')
>>> PureWindowsPath('//server/share/file')
PureWindowsPath('//server/share/file')
@end example

`pathsegments' se especifica de manera similar a @ref{54e,,PurePath}.
@end deffn

Independientemente del sistema en el que se encuentre, puede crear instancias de todas estas clases, ya que no proporcionan ninguna operación que llame al sistema operativo.

@menu
* Propiedades generales:: 
* Operadores: Operadores<2>. 
* Acceso a partes individuales:: 
* Métodos y propiedades:: 

@end menu

@node Propiedades generales,Operadores<2>,,Rutas puras
@anchor{library/pathlib general-properties}@anchor{279f}
@subsubsection Propiedades generales


Las rutas son inmutables y @ref{6b1,,hashable}. Las rutas de una misma familia son comparables y ordenables. Estas propiedades respetan el orden lexicográfico definido por la familia:

@example
>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in @{ PureWindowsPath('foo') @}
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True
@end example

Rutas de diferentes familias no son iguales y no se pueden ordenar:

@example
>>> PureWindowsPath('foo') == PurePosixPath('foo')
False
>>> PureWindowsPath('foo') < PurePosixPath('foo')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'
@end example

@node Operadores<2>,Acceso a partes individuales,Propiedades generales,Rutas puras
@anchor{library/pathlib operators}@anchor{27a0}
@subsubsection Operadores


El operador de barra inclinada ayuda a crear rutas hijas, como @ref{163f,,os.path.join()}. Si el argumento es una ruta absoluta, se ignora la ruta anterior. En Windows, la unidad no se restablece cuando el argumento es una ruta relativa en la raíz (por ejemplo, @code{r'\foo'}):

@example
>>> p = PurePath('/etc')
>>> p
PurePosixPath('/etc')
>>> p / 'init.d' / 'apache2'
PurePosixPath('/etc/init.d/apache2')
>>> q = PurePath('bin')
>>> '/usr' / q
PurePosixPath('/usr/bin')
>>> p / '/an_absolute_path'
PurePosixPath('/an_absolute_path')
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

Se puede usar un objeto ruta en cualquier lugar donde se acepte un objeto que implemente @ref{cd9,,os.PathLike}:

@example
>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'
@end example

La representación de una ruta en una cadena de caracteres es la ruta del sistema de archivos sin procesar en sí (en forma nativa, por ejemplo con barras invertidas en Windows), y que puede pasar a cualquier función que tome una ruta como una cadena de caracteres:

@example
>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'
@end example

Del mismo modo, llamar a @ref{325,,bytes} en una ruta proporciona la ruta cruda del sistema de archivos como un objeto bytes, codificado por @ref{cdd,,os.fsencode()}:

@example
>>> bytes(p)
b'/etc'
@end example

@cartouche
@quotation Nota 
Llamar a @ref{325,,bytes} solo se recomienda en Unix. En Windows, la forma unicode es la representación canónica de las rutas del sistema de archivos.
@end quotation
@end cartouche

@node Acceso a partes individuales,Métodos y propiedades,Operadores<2>,Rutas puras
@anchor{library/pathlib accessing-individual-parts}@anchor{27a1}
@subsubsection Acceso a partes individuales


Para acceder a las «partes» (componentes) individuales de una ruta, use la siguiente propiedad:

@geindex parts (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parts}@anchor{27a2}
@deffn {Atributo} PurePath.parts

Una tupla que da acceso a los diversos componentes de la ruta:

@example
>>> p = PurePath('/usr/bin/python3')
>>> p.parts
('/', 'usr', 'bin', 'python3')

>>> p = PureWindowsPath('c:/Program Files/PSF')
>>> p.parts
('c:\\', 'Program Files', 'PSF')
@end example

(obsérvese cómo la unidad y la raíz local se reagrupan en una sola parte)
@end deffn

@node Métodos y propiedades,,Acceso a partes individuales,Rutas puras
@anchor{library/pathlib methods-and-properties}@anchor{27a3}
@subsubsection Métodos y propiedades


@c from pathlib import PurePath, PurePosixPath, PureWindowsPath

Las rutas puras proporcionan los siguientes métodos y propiedades:

@geindex parser (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parser}@anchor{387}
@deffn {Atributo} PurePath.parser

The implementation of the @ref{a2,,os.path} module used for low-level path
parsing and joining: either @code{posixpath} or @code{ntpath}.


Added in version 3.13.

@end deffn

@geindex drive (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath drive}@anchor{27a4}
@deffn {Atributo} PurePath.drive

Una cadena que representa la letra o el nombre de la unidad, si corresponde:

@example
>>> PureWindowsPath('c:/Program Files/').drive
'c:'
>>> PureWindowsPath('/Program Files/').drive
'@w{'}
>>> PurePosixPath('/etc').drive
'@w{'}
@end example

Las localizaciones UNC también son consideradas como unidades:

@example
>>> PureWindowsPath('//host/share/foo.txt').drive
'\\\\host\\share'
@end example
@end deffn

@geindex root (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath root}@anchor{27a5}
@deffn {Atributo} PurePath.root

Una cadena que representa la raíz (local o global), si la hay:

@example
>>> PureWindowsPath('c:/Program Files/').root
'\\'
>>> PureWindowsPath('c:Program Files/').root
'@w{'}
>>> PurePosixPath('/etc').root
'/'
@end example

Las localizaciones UNC siempre tienen una raíz:

@example
>>> PureWindowsPath('//host/share').root
'\\'
@end example

Si la ruta comienza con más de dos barras diagonales sucesivas, @ref{279e,,PurePosixPath} las contrae:

@example
>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'
@end example

@cartouche
@quotation Nota 
Este comportamiento se ajusta a `The Open Group Base Specifications Issue 6', párrafo 4.11 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11}:

`«Un nombre de ruta que comienza con dos barras oblicuas sucesivas se puede interpretar de una manera definida por la implementación, aunque más de dos barras oblicuas iniciales se tratarán como una sola barra oblicua.»'
@end quotation
@end cartouche
@end deffn

@geindex anchor (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath anchor}@anchor{27a6}
@deffn {Atributo} PurePath.anchor

La concatenación de la unidad y la raíz:

@example
>>> PureWindowsPath('c:/Program Files/').anchor
'c:\\'
>>> PureWindowsPath('c:Program Files/').anchor
'c:'
>>> PurePosixPath('/etc').anchor
'/'
>>> PureWindowsPath('//host/share').anchor
'\\\\host\\share\\'
@end example
@end deffn

@geindex parents (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parents}@anchor{8b7}
@deffn {Atributo} PurePath.parents

Una secuencia inmutable que proporciona acceso a los ancestros lógicos de la ruta:

@example
>>> p = PureWindowsPath('c:/foo/bar/setup.py')
>>> p.parents[0]
PureWindowsPath('c:/foo/bar')
>>> p.parents[1]
PureWindowsPath('c:/foo')
>>> p.parents[2]
PureWindowsPath('c:/')
@end example


Distinto en la versión 3.10: La secuencia de padres ahora admite @ref{2185,,rebanada} y valores de índice negativos.

@end deffn

@geindex parent (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parent}@anchor{1734}
@deffn {Atributo} PurePath.parent

El padre lógico de la ruta

@example
>>> p = PurePosixPath('/a/b/c/d')
>>> p.parent
PurePosixPath('/a/b/c')
@end example

No puede ir más allá de un ancla o una ruta vacía:

@example
>>> p = PurePosixPath('/')
>>> p.parent
PurePosixPath('/')
>>> p = PurePosixPath('.')
>>> p.parent
PurePosixPath('.')
@end example

@cartouche
@quotation Nota 
Esta es una operación puramente léxica, de ahí el siguiente comportamiento:

@example
>>> p = PurePosixPath('foo/..')
>>> p.parent
PurePosixPath('foo')
@end example

Si desea recorrer una ruta de sistema de archivos arbitraria hacia arriba, se recomienda llamar primero a @ref{1702,,Path.resolve()} para resolver los enlaces simbólicos y eliminar los componentes @code{".."}.
@end quotation
@end cartouche
@end deffn

@geindex name (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath name}@anchor{27a7}
@deffn {Atributo} PurePath.name

Una cadena que representa el componente final de la ruta, excluyendo la unidad y la raíz, si hay alguna:

@example
>>> PurePosixPath('my/library/setup.py').name
'setup.py'
@end example

Los nombres de unidad UNC no se consideran:

@example
>>> PureWindowsPath('//some/share/setup.py').name
'setup.py'
>>> PureWindowsPath('//some/share').name
'@w{'}
@end example
@end deffn

@geindex suffix (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath suffix}@anchor{15f3}
@deffn {Atributo} PurePath.suffix

The last dot-separated portion of the final component, if any:

@example
>>> PurePosixPath('my/library/setup.py').suffix
'.py'
>>> PurePosixPath('my/library.tar.gz').suffix
'.gz'
>>> PurePosixPath('my/library').suffix
'@w{'}
@end example

This is commonly called the file extension.


Distinto en la versión 3.14: A single dot (»@code{.}») is considered a valid suffix.

@end deffn

@geindex suffixes (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath suffixes}@anchor{15f4}
@deffn {Atributo} PurePath.suffixes

A list of the path’s suffixes, often called file extensions:

@example
>>> PurePosixPath('my/library.tar.gar').suffixes
['.tar', '.gar']
>>> PurePosixPath('my/library.tar.gz').suffixes
['.tar', '.gz']
>>> PurePosixPath('my/library').suffixes
[]
@end example


Distinto en la versión 3.14: A single dot (»@code{.}») is considered a valid suffix.

@end deffn

@geindex stem (atributo de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath stem}@anchor{27a8}
@deffn {Atributo} PurePath.stem

El componente final de la ruta, sin su sufijo:

@example
>>> PurePosixPath('my/library.tar.gz').stem
'library.tar'
>>> PurePosixPath('my/library.tar').stem
'library'
>>> PurePosixPath('my/library').stem
'library'
@end example
@end deffn

@geindex as_posix() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath as_posix}@anchor{27a9}
@deffn {Método} PurePath.as_posix ()

Retorna una cadena que representa la ruta con barras invertidas (@code{/}):

@example
>>> p = PureWindowsPath('c:\\windows')
>>> str(p)
'c:\\windows'
>>> p.as_posix()
'c:/windows'
@end example
@end deffn

@geindex is_absolute() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_absolute}@anchor{1732}
@deffn {Método} PurePath.is_absolute ()

Retorna si la ruta es absoluta o no. Una ruta se considera absoluta si tiene una raíz y (si la `familia' lo permite) una unidad:

@example
>>> PurePosixPath('/a/b').is_absolute()
True
>>> PurePosixPath('a/b').is_absolute()
False

>>> PureWindowsPath('c:/a/b').is_absolute()
True
>>> PureWindowsPath('/a/b').is_absolute()
False
>>> PureWindowsPath('c:').is_absolute()
False
>>> PureWindowsPath('//some/share').is_absolute()
True
@end example
@end deffn

@geindex is_relative_to() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_relative_to}@anchor{21e}
@deffn {Método} PurePath.is_relative_to (other)

Retorna si esta ruta es relativa o no a la `otra' ruta.

@example
>>> p = PurePath('/etc/passwd')
>>> p.is_relative_to('/etc')
True
>>> p.is_relative_to('/usr')
False
@end example

This method is string-based; it neither accesses the filesystem nor treats
«@code{..}» segments specially. The following code is equivalent:

@example
>>> u = PurePath('/usr')
>>> u == p or u in p.parents
False
@end example


Added in version 3.9.



Deprecated since version 3.12, removed in version 3.14: Está obsoleto pasar argumentos adicionales; si se suministran, se juntan con `other'.

@end deffn

@geindex is_reserved() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_reserved}@anchor{1d4}
@deffn {Método} PurePath.is_reserved ()

Con @ref{170a,,PureWindowsPath}, retorna @code{True} si la ruta se considera reservada en Windows, @code{False} en caso contrario. Con @ref{279e,,PurePosixPath}, siempre retorna @code{False}.


Distinto en la versión 3.13: Windows path names that contain a colon, or end with a dot or a space,
are considered reserved. UNC paths may be reserved.



Deprecated since version 3.13, will be removed in version 3.15: This method is deprecated; use @ref{1d5,,os.path.isreserved()} to detect
reserved paths on Windows.

@end deffn

@geindex joinpath() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath joinpath}@anchor{27aa}
@deffn {Método} PurePath.joinpath (*pathsegments)

Llamar a este método es equivalente a combinar la ruta con cada uno de los `pathsegments' dados sucesivamente:

@example
>>> PurePosixPath('/etc').joinpath('passwd')
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
PurePosixPath('/etc/init.d/apache2')
>>> PureWindowsPath('c:').joinpath('/Program Files')
PureWindowsPath('c:/Program Files')
@end example
@end deffn

@geindex full_match() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath full_match}@anchor{386}
@deffn {Método} PurePath.full_match (pattern, *, case_sensitive=None)

Match this path against the provided glob-style pattern.  Return @code{True}
if matching is successful, @code{False} otherwise.  For example:

@example
>>> PurePath('a/b.py').full_match('a/*.py')
True
>>> PurePath('a/b.py').full_match('*.py')
False
>>> PurePath('/a/b/c.py').full_match('/a/**')
True
>>> PurePath('/a/b/c.py').full_match('**/*.py')
True
@end example


@subsubheading Ver también


@ref{27ab,,Pattern language} documentation.


Al igual que con otros métodos, la distinción entre mayúsculas y minúsculas sigue los valores predeterminados de la plataforma:

@example
>>> PurePosixPath('b.py').full_match('*.PY')
False
>>> PureWindowsPath('b.py').full_match('*.PY')
True
@end example

Establece `case_sensitive' en @code{True} o @code{False} para invalidar este comportamiento.


Added in version 3.13.

@end deffn

@geindex match() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath match}@anchor{554}
@deffn {Método} PurePath.match (pattern, *, case_sensitive=None)

Match this path against the provided non-recursive glob-style pattern.
Return @code{True} if matching is successful, @code{False} otherwise.

This method is similar to @ref{386,,full_match()}, but empty patterns
aren’t allowed (@ref{360,,ValueError} is raised), the recursive wildcard
«@code{**}» isn’t supported (it acts like non-recursive «@code{*}»), and if a
relative pattern is provided, then matching is done from the right:

@example
>>> PurePath('a/b.py').match('*.py')
True
>>> PurePath('/a/b/c.py').match('b/*.py')
True
>>> PurePath('/a/b/c.py').match('a/*.py')
False
@end example


Distinto en la versión 3.12: The `pattern' parameter accepts a @ref{3f0,,path-like object}.



Distinto en la versión 3.12: Se agregó el parámetro `case_sensitive'.

@end deffn

@geindex relative_to() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath relative_to}@anchor{21d}
@deffn {Método} PurePath.relative_to (other, walk_up=False)

Computa una versión de esta ruta relativa a la ruta representada por `other'. Si es imposible, se lanza @ref{360,,ValueError}:

@example
>>> p = PurePosixPath('/etc/passwd')
>>> p.relative_to('/')
PurePosixPath('etc/passwd')
>>> p.relative_to('/etc')
PurePosixPath('passwd')
>>> p.relative_to('/usr')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 941, in relative_to
    raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other is absolute.
@end example

When `walk_up' is false (the default), the path must start with `other'.
When the argument is true, @code{..} entries may be added to form the
relative path. In all other cases, such as the paths referencing
different drives, @ref{360,,ValueError} is raised.:

@example
>>> p.relative_to('/usr', walk_up=True)
PurePosixPath('../etc/passwd')
>>> p.relative_to('foo', walk_up=True)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 941, in relative_to
    raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not on the same drive as 'foo' OR one path is relative and the other is absolute.
@end example

@cartouche
@quotation Advertencia 
Esta función es parte de @ref{54e,,PurePath} y trabaja con cadenas de caracteres. No revisa ni accede a la estructura de archivos subyacentes. Esto puede afectar la opción `walk_up' ya que supone que no hay enlaces simbólicos en la ruta; si es necesario llame primero @ref{1702,,resolve()} para resolver los enlaces simbólicos.
@end quotation
@end cartouche


Distinto en la versión 3.12: Se agregó el parámetro `walk_up' (el comportamiento anterior es el mismo que @code{walk_up=False}).



Deprecated since version 3.12, removed in version 3.14: Está obsoleto pasar argumentos posicionales adicionales; si se suministran, se juntan con `other'.

@end deffn

@geindex with_name() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_name}@anchor{16fd}
@deffn {Método} PurePath.with_name (name)

Retorna una nueva ruta con @ref{27a7,,name} cambiado. Si la ruta original no tiene nombre, se genera `ValueError':

@example
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_name('setup.py')
PureWindowsPath('c:/Downloads/setup.py')
>>> p = PureWindowsPath('c:/')
>>> p.with_name('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name
@end example
@end deffn

@geindex with_stem() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_stem}@anchor{1668}
@deffn {Método} PurePath.with_stem (stem)

Retorna una nueva ruta con @ref{27a8,,stem} cambiado. Si la ruta original no tiene nombre, se lanza `ValueError':

@example
>>> p = PureWindowsPath('c:/Downloads/draft.txt')
>>> p.with_stem('final')
PureWindowsPath('c:/Downloads/final.txt')
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_stem('lib')
PureWindowsPath('c:/Downloads/lib.gz')
>>> p = PureWindowsPath('c:/')
>>> p.with_stem('@w{'})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 861, in with_stem
    return self.with_name(stem + self.suffix)
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 851, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name
@end example


Added in version 3.9.

@end deffn

@geindex with_suffix() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_suffix}@anchor{15f2}
@deffn {Método} PurePath.with_suffix (suffix)

Retorna una nueva ruta con @ref{15f3,,suffix} cambiado. Si la ruta original no tiene un sufijo, se agrega el nuevo `suffix'. Si `suffix' es una cadena vacía, el sufijo original se elimina:

@example
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_suffix('.bz2')
PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
>>> p = PureWindowsPath('README')
>>> p.with_suffix('.txt')
PureWindowsPath('README.txt')
>>> p = PureWindowsPath('README.txt')
>>> p.with_suffix('@w{'})
PureWindowsPath('README')
@end example


Distinto en la versión 3.14: A single dot (»@code{.}») is considered a valid suffix. In previous
versions, @ref{360,,ValueError} is raised if a single dot is supplied.

@end deffn

@geindex with_segments() (método de pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_segments}@anchor{54f}
@deffn {Método} PurePath.with_segments (*pathsegments)

Crea un nuevo objeto de ruta del mismo tipo combinando los `pathsegments' dados. Este método se llama siempre que se crea una ruta derivada, como @ref{1734,,parent} y @ref{21d,,relative_to()}. Las subclases pueden anular este método para pasar información a las rutas derivadas, por ejemplo:

@example
from pathlib import PurePosixPath

class MyPath(PurePosixPath):
    def __init__(self, *pathsegments, session_id):
        super().__init__(*pathsegments)
        self.session_id = session_id

    def with_segments(self, *pathsegments):
        return type(self)(*pathsegments, session_id=self.session_id)

etc = MyPath('/etc', session_id=42)
hosts = etc / 'hosts'
print(hosts.session_id)  # 42
@end example


Added in version 3.12.

@end deffn

@node Rutas concretas,Pattern language,Rutas puras,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib concrete-paths}@anchor{2799}@anchor{library/pathlib id2}@anchor{27ac}
@subsubsection Rutas concretas


Las rutas concretas son subclases de las rutas puras. Además de las operaciones proporcionadas por estas últimas, también proporcionan métodos realizar llamadas del sistema a objetos ruta. Hay tres formas de crear instancias de rutas concretas:

@geindex Path (clase en pathlib)
@anchor{library/pathlib pathlib Path}@anchor{19b}
@deffn {Clase} pathlib.Path (*pathsegments)

Una subclase de @ref{54e,,PurePath}, esta clase representa rutas concretas de la `familia' ruta del sistema (al crear una instancia crea ya sea @ref{27ad,,PosixPath} o @ref{279a,,WindowsPath}):

@example
>>> Path('setup.py')
PosixPath('setup.py')
@end example

`pathsegments' se especifica de manera similar a @ref{54e,,PurePath}.
@end deffn

@geindex PosixPath (clase en pathlib)
@anchor{library/pathlib pathlib PosixPath}@anchor{27ad}
@deffn {Clase} pathlib.PosixPath (*pathsegments)

Una subclase de @ref{19b,,Path} y @ref{279e,,PurePosixPath}, esta clase representa rutas concretas de sistemas de archivos que no son de Windows:

@example
>>> PosixPath('/etc/hosts')
PosixPath('/etc/hosts')
@end example

`pathsegments' se especifica de manera similar a @ref{54e,,PurePath}.


Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} on Windows. In previous versions,
@ref{384,,NotImplementedError} was raised instead.

@end deffn

@geindex WindowsPath (clase en pathlib)
@anchor{library/pathlib pathlib WindowsPath}@anchor{279a}
@deffn {Clase} pathlib.WindowsPath (*pathsegments)

Una subclase de @ref{19b,,Path} y @ref{170a,,PureWindowsPath}, esta clase representa rutas concretas del sistema de archivos de Windows:

@example
>>> WindowsPath('c:/', 'Users', 'Ximénez')
WindowsPath('c:/Users/Ximénez')
@end example

`pathsegments' se especifica de manera similar a @ref{54e,,PurePath}.


Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} on non-Windows platforms. In previous
versions, @ref{384,,NotImplementedError} was raised instead.

@end deffn

Solo puedes crear instancias de la `familia' de clase que corresponde a su sistema operativo (permitir llamadas del sistema no compatibles podría provocar errores o fallas en su aplicación):

@example
>>> import os
>>> os.name
'posix'
>>> Path('setup.py')
PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
>>> WindowsPath('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 798, in __new__
    % (cls.__name__,))
UnsupportedOperation: cannot instantiate 'WindowsPath' on your system
@end example

Some concrete path methods can raise an @ref{4d5,,OSError} if a system call fails
(for example because the path doesn’t exist).

@menu
* Parsing and generating URIs:: 
* Expanding and resolving paths:: 
* Querying file type and status:: 
* Reading and writing files:: 
* Reading directories:: 
* Creating files and directories:: 
* Copying@comma{} moving and deleting: Copying moving and deleting. 
* Permissions and ownership:: 

@end menu

@node Parsing and generating URIs,Expanding and resolving paths,,Rutas concretas
@anchor{library/pathlib parsing-and-generating-uris}@anchor{27ae}
@subsubsection Parsing and generating URIs


Concrete path objects can be created from, and represented as, “file” URIs
conforming to 
@geindex RFC; RFC 8089
RFC 8089@footnote{https://datatracker.ietf.org/doc/html/rfc8089.html}.

@cartouche
@quotation Nota 
File URIs are not portable across machines with different
@ref{27af,,filesystem encodings}.
@end quotation
@end cartouche

@geindex from_uri() (método de clase de pathlib.Path)
@anchor{library/pathlib pathlib Path from_uri}@anchor{385}
@deffn {Método} classmethod Path.from_uri (uri)

Return a new path object from parsing a “file” URI. For example:

@example
>>> p = Path.from_uri('file:///etc/hosts')
PosixPath('/etc/hosts')
@end example

On Windows, DOS device and UNC paths may be parsed from URIs:

@example
>>> p = Path.from_uri('file:///c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file://server/share')
WindowsPath('//server/share')
@end example

Several variant forms are supported:

@example
>>> p = Path.from_uri('file:////server/share')
WindowsPath('//server/share')
>>> p = Path.from_uri('file://///server/share')
WindowsPath('//server/share')
>>> p = Path.from_uri('file:c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file:/c|/windows')
WindowsPath('c:/windows')
@end example

@ref{360,,ValueError} is raised if the URI does not start with @code{file:}, or
the parsed path isn’t absolute.


Added in version 3.13.

@end deffn

@geindex as_uri() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path as_uri}@anchor{27b0}
@deffn {Método} Path.as_uri ()

Represent the path as a “file” URI.  @ref{360,,ValueError} is raised if
the path isn’t absolute.

@example
>>> p = PosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = WindowsPath('c:/Windows')
>>> p.as_uri()
'file:///c:/Windows'
@end example

For historical reasons, this method is also available from
@ref{54e,,PurePath} objects. However, its use of @ref{cdd,,os.fsencode()} makes
it strictly impure.
@end deffn

@node Expanding and resolving paths,Querying file type and status,Parsing and generating URIs,Rutas concretas
@anchor{library/pathlib expanding-and-resolving-paths}@anchor{27b1}
@subsubsection Expanding and resolving paths


@geindex home() (método de clase de pathlib.Path)
@anchor{library/pathlib pathlib Path home}@anchor{ec8}
@deffn {Método} classmethod Path.home ()

Retorna un nuevo objeto ruta que representa el directorio de inicio del usuario (como lo retorna @ref{aa6,,os.path.expanduser()} con el agregado @code{~}). Si el directorio de inicio no se puede resolver, se lanza @ref{1e5,,RuntimeError}.

@example
>>> Path.home()
PosixPath('/home/antoine')
@end example


Added in version 3.5.

@end deffn

@geindex expanduser() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path expanduser}@anchor{ec7}
@deffn {Método} Path.expanduser ()

Retorna una nueva ruta con las construcciones @code{~} y @code{~user} expandidas, como lo retorna @ref{aa6,,os.path.expanduser()}. Si el directorio de inicio no se puede resolver, se lanza @ref{1e5,,RuntimeError}.

@example
>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')
@end example


Added in version 3.5.

@end deffn

@geindex cwd() (método de clase de pathlib.Path)
@anchor{library/pathlib pathlib Path cwd}@anchor{1731}
@deffn {Método} classmethod Path.cwd ()

Retorna un nuevo objeto ruta que representa el directorio actual (como lo retorna @ref{159a,,os.getcwd()}):

@example
>>> Path.cwd()
PosixPath('/home/antoine/pathlib')
@end example
@end deffn

@geindex absolute() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path absolute}@anchor{16b6}
@deffn {Método} Path.absolute ()

Hace que la ruta sea absoluta, sin normalización ni resolución de enlaces simbólicos. Retorna un nuevo objeto de ruta:

@example
>>> p = Path('tests')
>>> p
PosixPath('tests')
>>> p.absolute()
PosixPath('/home/antoine/pathlib/tests')
@end example
@end deffn

@geindex resolve() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path resolve}@anchor{1702}
@deffn {Método} Path.resolve (strict=False)

Hace que la ruta sea absoluta, resolviendo los enlaces simbólicos. Se retorna un nuevo objeto ruta:

@example
>>> p = Path()
>>> p
PosixPath('.')
>>> p.resolve()
PosixPath('/home/antoine/pathlib')
@end example

Los componentes «@code{..}» también se eliminan (este es el único método para hacerlo):

@example
>>> p = Path('docs/../setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
@end example

If a path doesn’t exist or a symlink loop is encountered, and `strict' is
@code{True}, @ref{4d5,,OSError} is raised.  If `strict' is @code{False}, the path is
resolved as far as possible and any remainder is appended without checking
whether it exists.


Distinto en la versión 3.6: Se agregó el parámetro `strict' (el comportamiento previo a 3.6 es `strict').



Distinto en la versión 3.13: Symlink loops are treated like other errors: @ref{4d5,,OSError} is raised in
strict mode, and no exception is raised in non-strict mode. In previous
versions, @ref{1e5,,RuntimeError} is raised no matter the value of `strict'.

@end deffn

@geindex readlink() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path readlink}@anchor{9b3}
@deffn {Método} Path.readlink ()

Retorna la ruta a la que apunta el vínculo simbólico (como lo retorna @ref{9b4,,os.readlink()}):

@example
>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')
@end example


Added in version 3.9.



Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} if @ref{9b4,,os.readlink()} is not
available. In previous versions, @ref{384,,NotImplementedError} was raised.

@end deffn

@node Querying file type and status,Reading and writing files,Expanding and resolving paths,Rutas concretas
@anchor{library/pathlib querying-file-type-and-status}@anchor{27b2}
@subsubsection Querying file type and status



Distinto en la versión 3.8: @ref{aa8,,exists()}, @ref{38b,,is_dir()}, @ref{38a,,is_file()},
@ref{aa9,,is_mount()}, @ref{aaa,,is_symlink()},
@ref{aab,,is_block_device()}, @ref{aac,,is_char_device()},
@ref{aad,,is_fifo()}, @ref{aae,,is_socket()} now return @code{False}
instead of raising an exception for paths that contain characters
unrepresentable at the OS level.



Distinto en la versión 3.14: The methods given above now return @code{False} instead of raising any
@ref{4d5,,OSError} exception from the operating system. In previous versions,
some kinds of @ref{4d5,,OSError} exception are raised, and others suppressed.
The new behaviour is consistent with @ref{aa0,,os.path.exists()},
@ref{aa2,,os.path.isdir()}, etc. Use @ref{8ba,,stat()} to retrieve the file
status without suppressing exceptions.


@geindex stat() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path stat}@anchor{8ba}
@deffn {Método} Path.stat (*, follow_symlinks=True)

Return an @ref{14fd,,os.stat_result} object containing information about this path, like @ref{548,,os.stat()}.
The result is looked up at each call to this method.

Este método normalmente sigue enlaces simbólicos; para evitar enlaces simbólicos, agregue el argumento @code{follow_symlinks = False}, o use @code{lstat()}.

@example
>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554
@end example


Distinto en la versión 3.10: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex lstat() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path lstat}@anchor{27b3}
@deffn {Método} Path.lstat ()

Del mismo modo que @ref{8ba,,Path.stat()} pero si la ruta apunta a un enlace simbólico, retorna la información del enlace simbólico en lugar de la de su objetivo.
@end deffn

@geindex exists() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path exists}@anchor{aa8}
@deffn {Método} Path.exists (*, follow_symlinks=True)

Return @code{True} if the path points to an existing file or directory.
@code{False} will be returned if the path is invalid, inaccessible or missing.
Use @ref{8ba,,Path.stat()} to distinguish between these cases.

Este método normalmente sigue enlaces simbólicos; para comprobar si existe un enlace simbólico, agregue el argumento @code{follow_symlinks=False}.

@example
>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False
@end example


Distinto en la versión 3.12: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex is_file() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_file}@anchor{38a}
@deffn {Método} Path.is_file (*, follow_symlinks=True)

Return @code{True} if the path points to a regular file. @code{False} will be
returned if the path is invalid, inaccessible or missing, or if it points
to something other than a regular file. Use @ref{8ba,,Path.stat()} to
distinguish between these cases.

This method normally follows symlinks; to exclude symlinks, add the
argument @code{follow_symlinks=False}.


Distinto en la versión 3.13: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex is_dir() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_dir}@anchor{38b}
@deffn {Método} Path.is_dir (*, follow_symlinks=True)

Return @code{True} if the path points to a directory. @code{False} will be
returned if the path is invalid, inaccessible or missing, or if it points
to something other than a directory. Use @ref{8ba,,Path.stat()} to distinguish
between these cases.

This method normally follows symlinks; to exclude symlinks to directories,
add the argument @code{follow_symlinks=False}.


Distinto en la versión 3.13: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex is_symlink() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_symlink}@anchor{aaa}
@deffn {Método} Path.is_symlink ()

Return @code{True} if the path points to a symbolic link, even if that symlink
is broken. @code{False} will be returned if the path is invalid, inaccessible
or missing, or if it points to something other than a symbolic link. Use
@ref{8ba,,Path.stat()} to distinguish between these cases.
@end deffn

@geindex is_junction() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_junction}@anchor{553}
@deffn {Método} Path.is_junction ()

Retorna @code{True} si la ruta apunta a una unión y @code{False} para cualquier otro tipo de archivo. Actualmente, solo Windows admite uniones.


Added in version 3.12.

@end deffn

@geindex is_mount() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_mount}@anchor{aa9}
@deffn {Método} Path.is_mount ()

Retorna @code{True} si la ruta es un `mount point': un punto en un sistema de archivos donde otro sistema de archivo se encuentra montado. En POSIX, la función comprueba si el padre de `path' , @code{path/..}, se encuentra en un dispositivo diferente que `path', o si @code{path/..} y `path' apuntan al mismo i-nodo en el mismo dispositivo — esto debería detectar puntos de montajes para todas las variantes Unix y POSIX. En Windows, se considera que un punto de montaje es una letra de unidad de raíz (por ejemplo, @code{c:\}), un recurso compartido UNC (por ejemplo, @code{\\server\share}) o un directorio de sistema de archivos montado.


Added in version 3.7.



Distinto en la versión 3.12: Se agregó soporte para Windows.

@end deffn

@geindex is_socket() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_socket}@anchor{aae}
@deffn {Método} Path.is_socket ()

Return @code{True} if the path points to a Unix socket. @code{False} will be
returned if the path is invalid, inaccessible or missing, or if it points
to something other than a Unix socket. Use @ref{8ba,,Path.stat()} to
distinguish between these cases.
@end deffn

@geindex is_fifo() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_fifo}@anchor{aad}
@deffn {Método} Path.is_fifo ()

Return @code{True} if the path points to a FIFO. @code{False} will be returned if
the path is invalid, inaccessible or missing, or if it points to something
other than a FIFO. Use @ref{8ba,,Path.stat()} to distinguish between these
cases.
@end deffn

@geindex is_block_device() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_block_device}@anchor{aab}
@deffn {Método} Path.is_block_device ()

Return @code{True} if the path points to a block device. @code{False} will be
returned if the path is invalid, inaccessible or missing, or if it points
to something other than a block device. Use @ref{8ba,,Path.stat()} to
distinguish between these cases.
@end deffn

@geindex is_char_device() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path is_char_device}@anchor{aac}
@deffn {Método} Path.is_char_device ()

Return @code{True} if the path points to a character device. @code{False} will be
returned if the path is invalid, inaccessible or missing, or if it points
to something other than a character device. Use @ref{8ba,,Path.stat()} to
distinguish between these cases.
@end deffn

@geindex samefile() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path samefile}@anchor{ec5}
@deffn {Método} Path.samefile (other_path)

Retorna si la ruta apunta al mismo archivo que `other_path', que puede ser un objeto `Path' o una cadena. La semántica es similar a @ref{ff0,,os.path.samefile()} y @ref{fef,,os.path.samestat()}.

Se puede generar @ref{4d5,,OSError} si no se accede a alguno de los archivos por algún motivo.

@example
>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True
@end example


Added in version 3.5.

@end deffn

@node Reading and writing files,Reading directories,Querying file type and status,Rutas concretas
@anchor{library/pathlib reading-and-writing-files}@anchor{27b4}
@subsubsection Reading and writing files


@geindex open() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path open}@anchor{27b5}
@deffn {Método} Path.open (mode='r', buffering=-1, encoding=None, errors=None, newline=None)

Abre el archivo señalado por la ruta, como lo hace la función incorporada @ref{1be,,open()}:

@example
>>> p = Path('setup.py')
>>> with p.open() as f:
...     f.readline()
...
'#!/usr/bin/env python3\n'
@end example
@end deffn

@geindex read_text() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path read_text}@anchor{eca}
@deffn {Método} Path.read_text (encoding=None, errors=None, newline=None)

Retorna el contenido decodificado del archivo apuntado como una cadena:

@example
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
@end example

El archivo se abre y luego se cierra. Los parámetros opcionales funcionan de la misma manera que en @ref{1be,,open()}.


Added in version 3.5.



Distinto en la versión 3.13: Se agregó el parámetro `newline'.

@end deffn

@geindex read_bytes() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path read_bytes}@anchor{1bf}
@deffn {Método} Path.read_bytes ()

Retorna el contenido binario del archivo apuntado como un objeto bytes:

@example
>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'
@end example


Added in version 3.5.

@end deffn

@geindex write_text() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path write_text}@anchor{ec9}
@deffn {Método} Path.write_text (data, encoding=None, errors=None, newline=None)

Abre el archivo apuntado en modo texto, escribe `data' y cierra el archivo:

@example
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
@end example

Se sobrescribe un archivo existente con el mismo nombre. Los parámetros opcionales tienen el mismo significado que en @ref{1be,,open()}.


Added in version 3.5.



Distinto en la versión 3.10: Se agregó el parámetro `newline'.

@end deffn

@geindex write_bytes() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path write_bytes}@anchor{ecb}
@deffn {Método} Path.write_bytes (data)

Abre el archivo apuntado en modo bytes, escribe `data' y cierra el archivo:

@example
>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'
@end example

Se sobrescribe un archivo existente con el mismo nombre.


Added in version 3.5.

@end deffn

@node Reading directories,Creating files and directories,Reading and writing files,Rutas concretas
@anchor{library/pathlib reading-directories}@anchor{27b6}
@subsubsection Reading directories


@geindex iterdir() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path iterdir}@anchor{163d}
@deffn {Método} Path.iterdir ()

Cuando la ruta apunta a un directorio, produce objetos de ruta del contenido del directorio:

@example
>>> p = Path('docs')
>>> for child in p.iterdir(): child
...
PosixPath('docs/conf.py')
PosixPath('docs/_templates')
PosixPath('docs/make.bat')
PosixPath('docs/index.rst')
PosixPath('docs/_build')
PosixPath('docs/_static')
PosixPath('docs/Makefile')
@end example

The children are yielded in arbitrary order, and the special entries
@code{'.'} and @code{'..'} are not included.  If a file is removed from or added
to the directory after creating the iterator, it is unspecified whether
a path object for that file is included.

If the path is not a directory or otherwise inaccessible, @ref{4d5,,OSError} is
raised.
@end deffn

@geindex scandir() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path scandir}@anchor{1a0}
@deffn {Método} Path.scandir ()

When the path points to a directory, return an iterator of
@ref{1a1,,os.DirEntry} objects corresponding to entries in the directory. The
returned iterator supports the @ref{675,,context manager} protocol. It is
implemented using @ref{1a2,,os.scandir()} and gives the same guarantees.

Using @ref{1a0,,scandir()} instead of @ref{163d,,iterdir()} can
significantly increase the performance of code that also needs file type or
file attribute information, because @ref{1a1,,os.DirEntry} objects expose
this information if the operating system provides it when scanning a
directory.

The following example displays the names of subdirectories. The
@code{entry.is_dir()} check will generally not make an additional system call:

@example
>>> p = Path('docs')
>>> with p.scandir() as entries:
...     for entry in entries:
...         if entry.is_dir():
...             entry.name
...
'_templates'
'_build'
'_static'
@end example


Added in version 3.14.

@end deffn

@geindex glob() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path glob}@anchor{388}
@deffn {Método} Path.glob (pattern, *, case_sensitive=None, recurse_symlinks=False)

Analiza el patrón comodín relativo a esta ruta para producir todos los archivos coincidentes (de cualquier tipo):

@example
>>> sorted(Path('.').glob('*.py'))
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
>>> sorted(Path('.').glob('*/*.py'))
[PosixPath('docs/conf.py')]
>>> sorted(Path('.').glob('**/*.py'))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]
@end example


@subsubheading Ver también


@ref{27ab,,Pattern language} documentation.


De forma predeterminada, o cuando el argumento de sólo palabra clave `case_sensitive' está configurado en @code{None}, este método coincide con las rutas utilizando reglas de mayúsculas y minúsculas específicas de la plataforma: normalmente, distingue entre mayúsculas y minúsculas en POSIX y no distingue entre mayúsculas y minúsculas en Windows. Se configura `case_sensitive' en @code{True} o @code{False} para anular este comportamiento.

By default, or when the `recurse_symlinks' keyword-only argument is set to
@code{False}, this method follows symlinks except when expanding «@code{**}»
wildcards. Set `recurse_symlinks' to @code{True} to always follow symlinks.

Levanta un @ref{18c3,,auditing event} @code{pathlib.Path.glob} con argumentos @code{self}, @code{pattern}.


Distinto en la versión 3.12: Se agregó el parámetro `case_sensitive'.



Distinto en la versión 3.13: The `recurse_symlinks' parameter was added.



Distinto en la versión 3.13: The `pattern' parameter accepts a @ref{3f0,,path-like object}.



Distinto en la versión 3.13: Any @ref{4d5,,OSError} exceptions raised from scanning the filesystem are
suppressed. In previous versions, such exceptions are suppressed in many
cases, but not all.

@end deffn

@geindex rglob() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path rglob}@anchor{389}
@deffn {Método} Path.rglob (pattern, *, case_sensitive=None, recurse_symlinks=False)

Glob the given relative `pattern' recursively.  This is like calling
@ref{388,,Path.glob()} with «@code{**/}» added in front of the `pattern'.


@subsubheading Ver también


@ref{27ab,,Pattern language} and @ref{388,,Path.glob()} documentation.


Levanta un @ref{18c3,,auditing event} @code{pathlib.Path.rglob} con argumentos @code{self}, @code{pattern}.


Distinto en la versión 3.12: Se agregó el parámetro `case_sensitive'.



Distinto en la versión 3.13: The `recurse_symlinks' parameter was added.



Distinto en la versión 3.13: The `pattern' parameter accepts a @ref{3f0,,path-like object}.

@end deffn

@geindex walk() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path walk}@anchor{550}
@deffn {Método} Path.walk (top_down=True, on_error=None, follow_symlinks=False)

Genera los nombres de archivos en un árbol de directorios recorriendo el árbol de arriba hacia abajo o de abajo hacia arriba.

Para cada directorio en el árbol de directorios con raíz en `self' (incluyendo `self' pero excluyendo “.” y “..”), el método produce una tupla de 3 de elementos (o tripleta) @code{(dirpath, dirnames, filenames)}.

`dirpath' es un objeto @ref{19b,,Path} al directorio que se está recorriendo actualmente, `dirnames' es una lista de cadenas de caracteres para los nombres de los subdirectorios en `dirpath' (excluyendo @code{'.'} y @code{'..'}), y `filenames' es una lista de cadenas de caracteres para los nombres de los archivos que no son directorios en `dirpath'. Para obtener una ruta completa (que comienza con `self') a un archivo o directorio en `dirpath', se ejecuta @code{dirpath / name}. El orden de las listas depende del sistema de archivos.

Si el argumento opcional `top_down' es verdadero (que es el valor predeterminado), la tripleta de un directorio se genera antes que las tripletas de cualquiera de sus subdirectorios (los directorios se recorren de arriba hacia abajo). Si `top_down' es falso, la tripleta de un directorio se genera después de las tripletas de todos sus subdirectorios (los directorios se recorren de abajo hacia arriba). Sin importar el valor de `top_down', la lista de subdirectorios se recupera antes de que se recorran las tripletas del directorio y sus subdirectorios.

When `top_down' is true, the caller can modify the `dirnames' list in-place
(for example, using @ref{17ae,,del} or slice assignment), and @ref{550,,Path.walk()}
will only recurse into the subdirectories whose names remain in `dirnames'.
This can be used to prune the search, or to impose a specific order of visiting,
or even to inform @ref{550,,Path.walk()} about directories the caller creates or
renames before it resumes @ref{550,,Path.walk()} again. Modifying `dirnames' when
`top_down' is false has no effect on the behavior of @ref{550,,Path.walk()} since the
directories in `dirnames' have already been generated by the time `dirnames'
is yielded to the caller.

De forma predeterminada, los errores de @ref{1a2,,os.scandir()} se ignoran. Si se especifica el argumento opcional `on_error', debe ser un objeto invocable; se llamará con un argumento, una instancia de @ref{4d5,,OSError}. El objeto invocable puede manejar el error para continuar la ejecución o volver a generarlo para detenerla. Tenga en cuenta que el nombre del archivo está disponible como el atributo @code{filename} del objeto de excepción.

De forma predeterminada, @ref{550,,Path.walk()} no sigue los enlaces simbólicos, sino que los agrega a la lista `filenames'. Establezca `follow_symlinks' como verdadero para resolver los enlaces simbólicos y colocarlos en `dirnames' y `filenames' según corresponda para sus destinos y, en consecuencia, visitar los directorios a los que apuntan los enlaces simbólicos (donde sea compatible).

@cartouche
@quotation Nota 
Tener en cuenta que establecer `follow_symlinks' como verdadero puede generar una recursión infinita si un enlace apunta a un directorio principal de sí mismo. @ref{550,,Path.walk()} no realiza un seguimiento de los directorios que ya ha visitado.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@ref{550,,Path.walk()} asume que los directorios que recorre no se modifican durante la ejecución. Por ejemplo, si un directorio de `dirnames' ha sido reemplazado por un enlace simbólico y `follow_symlinks' es falso, @ref{550,,Path.walk()} intentará descender a él. Para evitar este comportamiento, elimine los directorios de `dirnames' según corresponda.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
A diferencia de @ref{551,,os.walk()}, @ref{550,,Path.walk()} enumera enlaces simbólicos a directorios en `filenames' si `follow_symlinks' es falso.
@end quotation
@end cartouche

Este ejemplo muestra la cantidad de bytes utilizados por todos los archivos en cada directorio, mientras ignora los directorios @code{__pycache__}:

@example
from pathlib import Path
for root, dirs, files in Path("cpython/Lib/concurrent").walk(on_error=print):
  print(
      root,
      "consumes",
      sum((root / file).stat().st_size for file in files),
      "bytes in",
      len(files),
      "non-directory files"
  )
  if '__pycache__' in dirs:
        dirs.remove('__pycache__')
@end example

El siguiente ejemplo es una implementación simple de @ref{1f9,,shutil.rmtree()}. Recorrer el árbol de abajo a arriba es esencial ya que @ref{27b7,,rmdir()} no permite eliminar un directorio antes de que esté vacío:

@example
# Delete everything reachable from the directory "top".
# CAUTION:  This is dangerous! For example, if top == Path('/'),
# it could delete all of your files.
for root, dirs, files in top.walk(top_down=False):
    for name in files:
        (root / name).unlink()
    for name in dirs:
        (root / name).rmdir()
@end example


Added in version 3.12.

@end deffn

@node Creating files and directories,Copying moving and deleting,Reading directories,Rutas concretas
@anchor{library/pathlib creating-files-and-directories}@anchor{27b8}
@subsubsection Creating files and directories


@geindex touch() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path touch}@anchor{27b9}
@deffn {Método} Path.touch (mode=0o666, exist_ok=True)

Create a file at this given path.  If `mode' is given, it is combined
with the process’s @code{umask} value to determine the file mode and access
flags.  If the file already exists, the function succeeds when `exist_ok'
is true (and its modification time is updated to the current time),
otherwise @ref{109c,,FileExistsError} is raised.


@subsubheading Ver también


The @ref{27b5,,open()}, @ref{ec9,,write_text()} and
@ref{ecb,,write_bytes()} methods are often used to create files.

@end deffn

@geindex mkdir() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path mkdir}@anchor{ec6}
@deffn {Método} Path.mkdir (mode=0o777, parents=False, exist_ok=False)

Create a new directory at this given path.  If `mode' is given, it is
combined with the process’s @code{umask} value to determine the file mode
and access flags.  If the path already exists, @ref{109c,,FileExistsError}
is raised.

Si `parents' es verdadero, los padres que faltan de esta ruta se crean según sea necesario; se crean con los permisos predeterminados sin tener en cuenta `mode' (imitando el comando POSIX @code{mkdir -p}).

Si `parents' es falso (el valor predeterminado), se genera un padre que falta @ref{f46,,FileNotFoundError}.

Si `exist_ok' es falso (el valor predeterminado), se genera @ref{109c,,FileExistsError} si el directorio de destino ya existe.

If `exist_ok' is true, @ref{109c,,FileExistsError} will not be raised unless the given
path already exists in the file system and is not a directory (same
behavior as the POSIX @code{mkdir -p} command).


Distinto en la versión 3.5: Se agregó el parámetro `exist_ok'.

@end deffn

@geindex symlink_to() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path symlink_to}@anchor{8b9}
@deffn {Método} Path.symlink_to (target, target_is_directory=False)

Make this path a symbolic link pointing to `target'.

On Windows, a symlink represents either a file or a directory, and does not
morph to the target dynamically.  If the target is present, the type of the
symlink will be created to match. Otherwise, the symlink will be created
as a directory if `target_is_directory' is true or a file symlink (the
default) otherwise.  On non-Windows platforms, `target_is_directory' is ignored.

@example
>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
>>> p.stat().st_size
956
>>> p.lstat().st_size
8
@end example

@cartouche
@quotation Nota 
El orden de los argumentos (`link', `target') es el reverso de @ref{1167,,os.symlink()}”s.
@end quotation
@end cartouche


Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} if @ref{1167,,os.symlink()} is not
available. In previous versions, @ref{384,,NotImplementedError} was raised.

@end deffn

@geindex hardlink_to() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path hardlink_to}@anchor{8b8}
@deffn {Método} Path.hardlink_to (target)

Hace de esta ruta un enlace fijo que apunta al mismo archivo que `target'.

@cartouche
@quotation Nota 
El orden de los argumentos (link, target) es el reverso de @ref{1162,,os.link()}.
@end quotation
@end cartouche


Added in version 3.10.



Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} if @ref{1162,,os.link()} is not
available. In previous versions, @ref{384,,NotImplementedError} was raised.

@end deffn

@node Copying moving and deleting,Permissions and ownership,Creating files and directories,Rutas concretas
@anchor{library/pathlib copying-moving-and-deleting}@anchor{27ba}
@subsubsection Copying, moving and deleting


@geindex copy() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path copy}@anchor{19c}
@deffn {Método} Path.copy (target, *, follow_symlinks=True, dirs_exist_ok=False, preserve_metadata=False)

Copy this file or directory tree to the given `target', and return a new
@code{Path} instance pointing to `target'.

If the source is a file, the target will be replaced if it is an existing
file. If the source is a symlink and `follow_symlinks' is true (the
default), the symlink’s target is copied. Otherwise, the symlink is
recreated at the destination.

If the source is a directory and `dirs_exist_ok' is false (the default), a
@ref{109c,,FileExistsError} is raised if the target is an existing directory.
If `dirs_exists_ok' is true, the copying operation will overwrite
existing files within the destination tree with corresponding files
from the source tree.

If `preserve_metadata' is false (the default), only directory structures
and file data are guaranteed to be copied. Set `preserve_metadata' to true
to ensure that file and directory permissions, flags, last access and
modification times, and extended attributes are copied where supported.
This argument has no effect when copying files on Windows (where
metadata is always preserved).

@cartouche
@quotation Nota 
Where supported by the operating system and file system, this method
performs a lightweight copy, where data blocks are only copied when
modified. This is known as copy-on-write.
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex copy_into() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path copy_into}@anchor{19d}
@deffn {Método} Path.copy_into (target_dir, *, follow_symlinks=True, dirs_exist_ok=False, preserve_metadata=False)

Copy this file or directory tree into the given `target_dir', which should
be an existing directory. Other arguments are handled identically to
@ref{19c,,Path.copy()}. Returns a new @code{Path} instance pointing to the
copy.


Added in version 3.14.

@end deffn

@geindex rename() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path rename}@anchor{27bb}
@deffn {Método} Path.rename (target)

Rename this file or directory to the given `target', and return a new
@code{Path} instance pointing to `target'.  On Unix, if `target' exists
and is a file, it will be replaced silently if the user has permission.
On Windows, if `target' exists, @ref{109c,,FileExistsError} will be raised.
`target' can be either a string or another path object:

@example
>>> p = Path('foo')
>>> p.open('w').write('some text')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'some text'
@end example

The target path may be absolute or relative. Relative paths are interpreted
relative to the current working directory, `not' the directory of the
@code{Path} object.

Se implementa en términos de @ref{1164,,os.rename()} y ofrece las mismas garantías.


Distinto en la versión 3.8: Added return value, return the new @code{Path} instance.

@end deffn

@geindex replace() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path replace}@anchor{27bc}
@deffn {Método} Path.replace (target)

Rename this file or directory to the given `target', and return a new
@code{Path} instance pointing to `target'.  If `target' points to an
existing file or empty directory, it will be unconditionally replaced.

The target path may be absolute or relative. Relative paths are interpreted
relative to the current working directory, `not' the directory of the
@code{Path} object.


Distinto en la versión 3.8: Added return value, return the new @code{Path} instance.

@end deffn

@geindex move() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path move}@anchor{19e}
@deffn {Método} Path.move (target)

Move this file or directory tree to the given `target', and return a new
@code{Path} instance pointing to `target'.

If the `target' doesn’t exist it will be created. If both this path and the
`target' are existing files, then the target is overwritten. If both paths
point to the same file or directory, or the `target' is a non-empty
directory, then @ref{4d5,,OSError} is raised.

If both paths are on the same filesystem, the move is performed with
@ref{1165,,os.replace()}. Otherwise, this path is copied (preserving metadata and
symlinks) and then deleted.


Added in version 3.14.

@end deffn

@geindex move_into() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path move_into}@anchor{19f}
@deffn {Método} Path.move_into (target_dir)

Move this file or directory tree into the given `target_dir', which should
be an existing directory. Returns a new @code{Path} instance pointing to
the moved path.


Added in version 3.14.

@end deffn

@geindex unlink() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path unlink}@anchor{19fb}
@deffn {Método} Path.unlink (missing_ok=False)

Elimine el archivo o enlace simbólico. Si la ruta apunta a un directorio, use @ref{27b7,,Path.rmdir()} en su lugar.

Si `missing_ok' es falso (el valor predeterminado), se genera @ref{f46,,FileNotFoundError} si la ruta no existe.

Si `missing_ok' es verdadero, las excepciones @ref{f46,,FileNotFoundError} serán ignoradas (el mismo comportamiento que el comando POSIX @code{rm -f}).


Distinto en la versión 3.8: Se agregó el parámetro `missing_ok'.

@end deffn

@geindex rmdir() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path rmdir}@anchor{27b7}
@deffn {Método} Path.rmdir ()

Elimina el directorio. El directorio debe estar vacío.
@end deffn

@node Permissions and ownership,,Copying moving and deleting,Rutas concretas
@anchor{library/pathlib permissions-and-ownership}@anchor{27bd}
@subsubsection Permissions and ownership


@geindex owner() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path owner}@anchor{38c}
@deffn {Método} Path.owner (*, follow_symlinks=True)

Return the name of the user owning the file. @ref{438,,KeyError} is raised
if the file’s user identifier (UID) isn’t found in the system database.

This method normally follows symlinks; to get the owner of the symlink, add
the argument @code{follow_symlinks=False}.


Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} if the @ref{b2,,pwd} module is not
available. In earlier versions, @ref{384,,NotImplementedError} was raised.



Distinto en la versión 3.13: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex group() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path group}@anchor{38d}
@deffn {Método} Path.group (*, follow_symlinks=True)

Return the name of the group owning the file. @ref{438,,KeyError} is raised
if the file’s group identifier (GID) isn’t found in the system database.

This method normally follows symlinks; to get the group of the symlink, add
the argument @code{follow_symlinks=False}.


Distinto en la versión 3.13: Raises @ref{383,,UnsupportedOperation} if the @ref{66,,grp} module is not
available. In earlier versions, @ref{384,,NotImplementedError} was raised.



Distinto en la versión 3.13: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex chmod() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path chmod}@anchor{8bb}
@deffn {Método} Path.chmod (mode, *, follow_symlinks=True)

Cambia el modo y los permisos de archivo, como @ref{378,,os.chmod()}.

Este método normalmente sigue enlaces simbólicos. Algunas versiones de Unix admiten el cambio de permisos en el enlace simbólico en sí; en estas plataformas puede agregar el argumento @code{follow_symlinks=False}, o usar @ref{27be,,lchmod()}.

@example
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
@end example


Distinto en la versión 3.10: Se agregó el parámetro `follow_symlinks'.

@end deffn

@geindex lchmod() (método de pathlib.Path)
@anchor{library/pathlib pathlib Path lchmod}@anchor{27be}
@deffn {Método} Path.lchmod (mode)

Del mismo modo que @ref{8bb,,Path.chmod()} pero si la ruta apunta a un enlace simbólico, el modo del enlace simbólico cambia en lugar del de su objetivo.
@end deffn

@node Pattern language,Comparison to the glob module,Rutas concretas,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib pathlib-pattern-language}@anchor{27ab}@anchor{library/pathlib pattern-language}@anchor{27bf}
@subsubsection Pattern language


The following wildcards are supported in patterns for
@ref{386,,full_match()}, @ref{388,,glob()} and @ref{389,,rglob()}:


@table @asis

@item @code{**} (entire segment)

Matches any number of file or directory segments, including zero.

@item @code{*} (entire segment)

Matches one file or directory segment.

@item @code{*} (part of a segment)

Matches any number of non-separator characters, including zero.

@item @code{?}

Matches one non-separator character.

@item @code{[seq]}

Matches one character in `seq'.

@item @code{[!seq]}

Matches one character not in `seq'.
@end table

For a literal match, wrap the meta-characters in brackets.
For example, @code{"[?]"} matches the character @code{"?"}.

The «@code{**}» wildcard enables recursive globbing. A few examples:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Pattern

@tab

Meaning

@item

«@code{**/*}»

@tab

Any path with at least one segment.

@item

«@code{**/*.py}»

@tab

Any path with a final segment ending «@code{.py}».

@item

«@code{assets/**}»

@tab

Any path starting with «@code{assets/}».

@item

«@code{assets/**/*}»

@tab

Any path starting with «@code{assets/}», excluding «@code{assets/}» itself.

@end multitable


@cartouche
@quotation Nota 
Globbing with the «@code{**}» wildcard visits every directory in the tree.
Large directory trees may take a long time to search.
@end quotation
@end cartouche


Distinto en la versión 3.13: Globbing with a pattern that ends with «@code{**}» returns both files and
directories. In previous versions, only directories were returned.


In @ref{388,,Path.glob()} and @ref{389,,rglob()}, a trailing slash may be added to
the pattern to match only directories.


Distinto en la versión 3.11: Globbing with a pattern that ends with a pathname components separator
(@ref{70b,,sep} or @ref{70c,,altsep}) returns only directories.


@node Comparison to the glob module,Comparison to the os and os path modules,Pattern language,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib comparison-to-the-glob-module}@anchor{27c0}
@subsubsection Comparison to the @code{glob} module


The patterns accepted and results generated by @ref{388,,Path.glob()} and
@ref{389,,Path.rglob()} differ slightly from those by the @ref{64,,glob} module:


@enumerate 

@item 
Files beginning with a dot are not special in pathlib. This is
like passing @code{include_hidden=True} to @ref{3ef,,glob.glob()}.

@item 
«@code{**}» pattern components are always recursive in pathlib. This is like
passing @code{recursive=True} to @ref{3ef,,glob.glob()}.

@item 
«@code{**}» pattern components do not follow symlinks by default in pathlib.
This behaviour has no equivalent in @ref{3ef,,glob.glob()}, but you can pass
@code{recurse_symlinks=True} to @ref{388,,Path.glob()} for compatible behaviour.

@item 
Like all @ref{54e,,PurePath} and @ref{19b,,Path} objects, the values returned
from @ref{388,,Path.glob()} and @ref{389,,Path.rglob()} don’t include trailing
slashes.

@item 
The values returned from pathlib’s @code{path.glob()} and @code{path.rglob()}
include the `path' as a prefix, unlike the results of
@code{glob.glob(root_dir=path)}.

@item 
The values returned from pathlib’s @code{path.glob()} and @code{path.rglob()}
may include `path' itself, for example when globbing «@code{**}», whereas the
results of @code{glob.glob(root_dir=path)} never include an empty string that
would correspond to `path'.
@end enumerate

@node Comparison to the os and os path modules,,Comparison to the glob module,pathlib — Object-oriented filesystem paths
@anchor{library/pathlib comparison-to-the-os-and-os-path-modules}@anchor{27c1}
@subsubsection Comparison to the @code{os} and @code{os.path} modules


pathlib implements path operations using @ref{54e,,PurePath} and @ref{19b,,Path}
objects, and so it’s said to be `object-oriented'. On the other hand, the
@ref{a1,,os} and @ref{a2,,os.path} modules supply functions that work with low-level
@code{str} and @code{bytes} objects, which is a more `procedural' approach. Some
users consider the object-oriented style to be more readable.

Many functions in @ref{a1,,os} and @ref{a2,,os.path} support @code{bytes} paths and
@ref{115d,,paths relative to directory descriptors}. These features aren’t
available in pathlib.

Python’s @code{str} and @code{bytes} types, and portions of the @ref{a1,,os} and
@ref{a2,,os.path} modules, are written in C and are very speedy. pathlib is
written in pure Python and is often slower, but rarely slow enough to matter.

pathlib’s path normalization is slightly more opinionated and consistent than
@ref{a2,,os.path}. For example, whereas @ref{1383,,os.path.abspath()} eliminates
«@code{..}» segments from a path, which may change its meaning if symlinks are
involved, @ref{16b6,,Path.absolute()} preserves these segments for greater safety.

pathlib’s path normalization may render it unsuitable for some applications:


@enumerate 

@item 
pathlib normalizes @code{Path("my_folder/")} to @code{Path("my_folder")}, which
changes a path’s meaning when supplied to various operating system APIs and
command-line utilities. Specifically, the absence of a trailing separator
may allow the path to be resolved as either a file or directory, rather
than a directory only.

@item 
pathlib normalizes @code{Path("./my_program")} to @code{Path("my_program")},
which changes a path’s meaning when used as an executable search path, such
as in a shell or when spawning a child process. Specifically, the absence
of a separator in the path may force it to be looked up in 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}
rather than the current directory.
@end enumerate

As a consequence of these differences, pathlib is not a drop-in replacement
for @ref{a2,,os.path}.

@menu
* Corresponding tools:: 

@end menu

@node Corresponding tools,,,Comparison to the os and os path modules
@anchor{library/pathlib corresponding-tools}@anchor{27c2}
@subsubsection Corresponding tools


A continuación se muestra una tabla que asigna varias funciones @ref{a1,,os} a sus equivalentes en @ref{54e,,PurePath}/@ref{19b,,Path}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@ref{a1,,os} y @ref{a2,,os.path}

@tab

@ref{a4,,pathlib}

@item

@ref{27c3,,os.path.dirname()}

@tab

@ref{1734,,PurePath.parent}

@item

@ref{27c4,,os.path.basename()}

@tab

@ref{27a7,,PurePath.name}

@item

@ref{15f5,,os.path.splitext()}

@tab

@ref{27a8,,PurePath.stem}, @ref{15f3,,PurePath.suffix}

@item

@ref{163f,,os.path.join()}

@tab

@ref{27aa,,PurePath.joinpath()}

@item

@ref{380,,os.path.isabs()}

@tab

@ref{1732,,PurePath.is_absolute()}

@item

@ref{552,,os.path.relpath()}

@tab

@ref{21d,,PurePath.relative_to()} @footnote{
@ref{552,,os.path.relpath()} calls @ref{1383,,abspath()} to make paths
absolute and remove «@code{..}» parts, whereas @ref{21d,,PurePath.relative_to()}
is a lexical operation that raises @ref{360,,ValueError} when its inputs”
anchors differ (e.g. if one path is absolute and the other relative.)
}

@item

@ref{aa6,,os.path.expanduser()}

@tab

@ref{ec7,,Path.expanduser()} @footnote{
@ref{aa6,,os.path.expanduser()} returns the path unchanged if the home
directory can’t be resolved, whereas @ref{ec7,,Path.expanduser()} raises
@ref{1e5,,RuntimeError}.
}

@item

@ref{381,,os.path.realpath()}

@tab

@ref{1702,,Path.resolve()}

@item

@ref{1383,,os.path.abspath()}

@tab

@ref{16b6,,Path.absolute()} @footnote{
@ref{1383,,os.path.abspath()} removes «@code{..}» components without resolving
symlinks, which may change the meaning of the path, whereas
@ref{16b6,,Path.absolute()} leaves any «@code{..}» components in the path.
}

@item

@ref{aa0,,os.path.exists()}

@tab

@ref{aa8,,Path.exists()}

@item

@ref{aa3,,os.path.isfile()}

@tab

@ref{38a,,Path.is_file()}

@item

@ref{aa2,,os.path.isdir()}

@tab

@ref{38b,,Path.is_dir()}

@item

@ref{a9e,,os.path.islink()}

@tab

@ref{aaa,,Path.is_symlink()}

@item

@ref{54b,,os.path.isjunction()}

@tab

@ref{553,,Path.is_junction()}

@item

@ref{aa4,,os.path.ismount()}

@tab

@ref{aa9,,Path.is_mount()}

@item

@ref{ff0,,os.path.samefile()}

@tab

@ref{ec5,,Path.samefile()}

@item

@ref{159a,,os.getcwd()}

@tab

@ref{1731,,Path.cwd()}

@item

@ref{548,,os.stat()}

@tab

@ref{8ba,,Path.stat()}

@item

@ref{549,,os.lstat()}

@tab

@ref{27b3,,Path.lstat()}

@item

@ref{116c,,os.listdir()}

@tab

@ref{163d,,Path.iterdir()}

@item

@ref{551,,os.walk()}

@tab

@ref{550,,Path.walk()} @footnote{
@ref{551,,os.walk()} always follows symlinks when categorizing paths into
`dirnames' and `filenames', whereas @ref{550,,Path.walk()} categorizes all
symlinks into `filenames' when `follow_symlinks' is false (the default.)
}

@item

@ref{37a,,os.mkdir()}, @ref{37b,,os.makedirs()}

@tab

@ref{ec6,,Path.mkdir()}

@item

@ref{1162,,os.link()}

@tab

@ref{8b8,,Path.hardlink_to()}

@item

@ref{1167,,os.symlink()}

@tab

@ref{8b9,,Path.symlink_to()}

@item

@ref{9b4,,os.readlink()}

@tab

@ref{9b3,,Path.readlink()}

@item

@ref{1164,,os.rename()}

@tab

@ref{27bb,,Path.rename()}

@item

@ref{1165,,os.replace()}

@tab

@ref{27bc,,Path.replace()}

@item

@ref{1163,,os.remove()}, @ref{1168,,os.unlink()}

@tab

@ref{19fb,,Path.unlink()}

@item

@ref{1166,,os.rmdir()}

@tab

@ref{27b7,,Path.rmdir()}

@item

@ref{378,,os.chmod()}

@tab

@ref{8bb,,Path.chmod()}

@item

@ref{377,,os.lchmod()}

@tab

@ref{27be,,Path.lchmod()}

@end multitable


@subsubheading Notas al pie


@node os path — Common pathname manipulations,fileinput — Iterate over lines from multiple input streams,pathlib — Object-oriented filesystem paths,Acceso a archivos y directorios
@anchor{library/os path doc}@anchor{27c5}@anchor{library/os path module-os path}@anchor{a2}@anchor{library/os path os-path-common-pathname-manipulations}@anchor{27c6}
@subsection @code{os.path} — Common pathname manipulations


@geindex module; os.path

`Source code:' Lib/genericpath.py@footnote{https://github.com/python/cpython/tree/main/Lib/genericpath.py}, Lib/posixpath.py@footnote{https://github.com/python/cpython/tree/main/Lib/posixpath.py} (for POSIX) and
Lib/ntpath.py@footnote{https://github.com/python/cpython/tree/main/Lib/ntpath.py} (for Windows).

@geindex path;operations


__________________________________________________________________


Este módulo implementa algunas funciones útiles sobre los nombres de rutas. Para leer o escribir archivos consulte @ref{1be,,open()}, y para acceder a archivos del sistema vea el @ref{a1,,os}. Los parámetros para las rutas pueden ser pasados como caracteres, o bytes ,o cualquier objeto implementado en el protocolo @ref{cd9,,os.PathLike}.

A diferencia de un shell Unix, Python no realiza ninguna expansión de ruta `automática'. Las funciones como @ref{aa6,,expanduser()} y @ref{1419,,expandvars()} puede ser invocadas de manera explicita cuando una aplicación desea realizar una expansión de ruta `shell-like'. (Consulte el módulo @ref{64,,glob}.)


@subsubheading Ver también


El módulo @ref{a4,,pathlib} ofrece objetos de ruta de alto nivel.


@cartouche
@quotation Nota 
Todas estas funciones aceptan solo bytes o solo objetos de cadena como sus parámetros. El resultado es un objeto del mismo tipo, si se retorna una ruta o un nombre de archivo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Dado que los diferentes sistemas operativos tienen diferentes convenciones de nombres de ruta, existen varias versiones de este módulo en la librería estándar. El módulo @ref{a2,,os.path} siempre es el módulo adecuado para el sistema operativo en el cual Python está operando, y por lo tanto es utilizable para rutas locales. Sin embargo, también puedes importar y utilizar los módulos individuales si deseas manipular una ruta que `siempre' está en uno de los diferentes formatos. Todos tienen la misma interfaz:


@itemize *

@item 
@code{posixpath} para rutas con estilo UNIX

@item 
@code{ntpath} para rutas Windows
@end itemize
@end quotation
@end cartouche


Distinto en la versión 3.8: @ref{aa0,,exists()}, @ref{aa1,,lexists()}, @ref{aa2,,isdir()}, @ref{aa3,,isfile()}, @ref{a9e,,islink()}, y @ref{aa4,,ismount()} ahora retornan @code{False} en lugar de lanzar una excepción para rutas que contienen caracteres o bytes que no se puedan representar a nivel de sistema operativo.


@geindex abspath() (en el módulo os.path)
@anchor{library/os path os path abspath}@anchor{1383}
@deffn {Función} os.path.abspath (path)

Retorna una versión normalizada y absoluta del nombre de ruta `path'. En la mayoría de las plataformas esto es el equivalente a invocar la función @ref{1382,,normpath()} de la siguiente manera: @code{normpath(join(os.getcwd(), path))}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex basename() (en el módulo os.path)
@anchor{library/os path os path basename}@anchor{27c4}
@deffn {Función} os.path.basename (path)

Retorna un nombre base de nombre de ruta `path'. Este es el segundo elemento del par retornado al pasar `path' a la función @ref{27c7,,split()}. Toma en cuenta que el resultado de esta función es diferente a la del programa de Unix @code{basename}; donde @code{basename} para @code{'/foo/bar/'} retorna @code{'bar'}, la función @ref{27c4,,basename()} retorna una cadena vacía (@code{'@w{'}}).


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex commonpath() (en el módulo os.path)
@anchor{library/os path os path commonpath}@anchor{ec2}
@deffn {Función} os.path.commonpath (paths)

Return the longest common sub-path of each pathname in the iterable
`paths'.  Raise @ref{360,,ValueError} if `paths' contain both absolute
and relative pathnames, if `paths' are on different drives, or
if `paths' is empty.  Unlike @ref{ec3,,commonprefix()}, this returns a
valid path.


Added in version 3.5.



Distinto en la versión 3.6: Acepta una secuencia de @ref{3f0,,path-like objects}.



Distinto en la versión 3.13: Any iterable can now be passed, rather than just sequences.

@end deffn

@geindex commonprefix() (en el módulo os.path)
@anchor{library/os path os path commonprefix}@anchor{ec3}
@deffn {Función} os.path.commonprefix (list)

Retorna el prefijo de ruta más largo (tomado carácter por carácter) que es un prefijo de todas las rutas en `list'. Si `list' está vacía, retorna la cadena vacía (@code{'@w{'}}).

@cartouche
@quotation Nota 
Esta función puede que retorne rutas invalidas porque trabaja un carácter a la vez. Para obtener una ruta valida, consulta @ref{ec2,,commonpath()}.

@example
>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'
@end example
@end quotation
@end cartouche


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex dirname() (en el módulo os.path)
@anchor{library/os path os path dirname}@anchor{27c3}
@deffn {Función} os.path.dirname (path)

Retorna el nombre del directorio de la ruta `path'. Es el primer elemento del par retornado al pasar `path' a la función @ref{27c7,,split()}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex exists() (en el módulo os.path)
@anchor{library/os path os path exists}@anchor{aa0}
@deffn {Función} os.path.exists (path)

Retorna @code{True} si `path' se refiere a una ruta existente o un descriptor de archivo abierto. Retorna @code{False} para enlaces simbólicos rotos. En algunas plataformas, esta función puede retornar @code{False} si no se concede permiso para ejecutar @ref{548,,os.stat()} en el archivo solicitado, incluso la ruta `path' existe físicamente.


Distinto en la versión 3.3: `path' ahora puede ser un valor entero: retorna @code{True} si es un descriptor de archivo abierto, de otro modo retorna @code{False}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex lexists() (en el módulo os.path)
@anchor{library/os path os path lexists}@anchor{aa1}
@deffn {Función} os.path.lexists (path)

Return @code{True} if `path' refers to an existing path, including
broken symbolic links.   Equivalent to @ref{aa0,,exists()} on platforms lacking
@ref{549,,os.lstat()}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex ~ (tilde);home directory expansion

@geindex expanduser() (en el módulo os.path)
@anchor{library/os path os path expanduser}@anchor{aa6}
@deffn {Función} os.path.expanduser (path)

En Unix y Windows, retorna el argumento con un componente inicial de @code{~} o @code{~user} reemplazado por el directorio `home' de `user'.

@geindex module;pwd

En Unix, el @code{~} inicial es reemplazado por la variable de entorno 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME} si está activada; si no, el directorio principal del usuario actual se busca en el directorio de contraseñas a través del módulo incorporado @ref{b2,,pwd}. Un @code{~user} inicial es buscado directamente en el directorio de contraseñas.

En Windows, se usará 
@geindex USERPROFILE
@geindex variables de entorno; USERPROFILE
@code{USERPROFILE} si se establece, de lo contrario se usará una combinación de 
@geindex HOMEPATH
@geindex variables de entorno; HOMEPATH
@code{HOMEPATH} y 
@geindex HOMEDRIVE
@geindex variables de entorno; HOMEDRIVE
@code{HOMEDRIVE}.  Un @code{~user}  inicial se maneja comprobando que el último componente de directorio del directorio de inicio del usuario actual coincide con 
@geindex USERNAME
@geindex variables de entorno; USERNAME
@code{USERNAME}, y reemplazándolo si es así.

Si la expansión falla o si la ruta no comienza con una tilde, la ruta se retorna sin cambios.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.8: Ya no utiliza 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME} en Windows.

@end deffn

@geindex $ (dollar);environment variables expansion
@geindex % (percent);environment variables expansion (Windows)

@geindex expandvars() (en el módulo os.path)
@anchor{library/os path os path expandvars}@anchor{1419}
@deffn {Función} os.path.expandvars (path)

Retorna el argumento con variables de entorno expandidas. Las sub-cadenas de la forma @code{$name} or @code{$@{name@}} se reemplazan por el valor de la variable de entorno `name'. Los nombres de variables mal formadas y las referencias a variables no existentes se dejan sin cambios.

En Windows, las expansiones @code{%name%} están soportadas además de @code{$name} y @code{$@{name@}}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex getatime() (en el módulo os.path)
@anchor{library/os path os path getatime}@anchor{27c8}
@deffn {Función} os.path.getatime (path)

Return the time of last access of `path'.  The return value is a floating-point number giving
the number of seconds since the epoch (see the  @ref{ee,,time} module).  Raise
@ref{4d5,,OSError} if the file does not exist or is inaccessible.
@end deffn

@geindex getmtime() (en el módulo os.path)
@anchor{library/os path os path getmtime}@anchor{27c9}
@deffn {Función} os.path.getmtime (path)

Return the time of last modification of `path'.  The return value is a floating-point number
giving the number of seconds since the epoch (see the  @ref{ee,,time} module).
Raise @ref{4d5,,OSError} if the file does not exist or is inaccessible.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex getctime() (en el módulo os.path)
@anchor{library/os path os path getctime}@anchor{27ca}
@deffn {Función} os.path.getctime (path)

Retorna el `ctime' del sistema que, en algunos sistemas (como Unix) es la hora del último cambio de metadatos y, en otros (como Windows), es el tiempo de creación de `path'. El valor retornado es un número que da el número de segundos desde la época (consulta el módulo @ref{ee,,time}). Lanza una excepción @ref{4d5,,OSError} si el archivo no existe o es inaccesible.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex getsize() (en el módulo os.path)
@anchor{library/os path os path getsize}@anchor{27cb}
@deffn {Función} os.path.getsize (path)

Retorna el tamaño en bytes de `path', Lanza una excepción @ref{4d5,,OSError} si el archivo no existe o es inaccesible.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex isabs() (en el módulo os.path)
@anchor{library/os path os path isabs}@anchor{380}
@deffn {Función} os.path.isabs (path)

Return @code{True} if `path' is an absolute pathname.  On Unix, that means it
begins with a slash, on Windows that it begins with two (back)slashes, or a
drive letter, colon, and (back)slash together.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.13: On Windows, returns @code{False} if the given path starts with exactly one
(back)slash.

@end deffn

@geindex isfile() (en el módulo os.path)
@anchor{library/os path os path isfile}@anchor{aa3}
@deffn {Función} os.path.isfile (path)

Retorna @code{True} si `path' es un archivo @ref{aa0,,existing}. Esto sigue los enlaces simbólicos, por lo que tanto @ref{a9e,,islink()} como @ref{aa3,,isfile()} pueden ser verdaderos para la misma ruta.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex isdir() (en el módulo os.path)
@anchor{library/os path os path isdir}@anchor{aa2}
@deffn {Función} os.path.isdir (path)

Retorna @code{True} si `path' es un directorio @ref{aa0,,existing}. Esto sigue los enlaces simbólicos, por lo que tanto @ref{a9e,,islink()} como @ref{aa2,,isdir()} pueden ser verdaderos para la misma ruta.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex isjunction() (en el módulo os.path)
@anchor{library/os path os path isjunction}@anchor{54b}
@deffn {Función} os.path.isjunction (path)

Return @code{True} if `path' refers to an @ref{aa1,,existing} directory
entry that is a junction.  Always return @code{False} if junctions are not
supported on the current platform.


Added in version 3.12.

@end deffn

@geindex islink() (en el módulo os.path)
@anchor{library/os path os path islink}@anchor{a9e}
@deffn {Función} os.path.islink (path)

Retorna  @code{True} si `path' hace referencia a una entrada de directorio @ref{aa0,,existing} que es un enlace simbólico. Siempre @code{False} si el entorno de ejecución de Python no admite vínculos simbólicos..


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex ismount() (en el módulo os.path)
@anchor{library/os path os path ismount}@anchor{aa4}
@deffn {Función} os.path.ismount (path)

Retorna @code{True} si el nombre de ruta `path' es un `mount point': un punto en un sistema de archivos donde se ha montado un sistema de archivos diferente. En POSIX, la función comprueba si el elemento primario de `path', @code{`path'/..}, se encuentra en un dispositivo diferente de `path', o si @code{`path'/..} y `path' apuntan al mismo `i-node' en el mismo dispositivo — esto debería detectar puntos de montaje para todas las variantes Unix y POSIX. No es capaz de detectar de forma fiable los montajes de enlace en el mismo sistema de archivos. En Windows, una raíz de letra de unidad y un recurso compartido UNC siempre son puntos de montaje, y para cualquier otra ruta de acceso @code{GetVolumePathName} se llama para ver si es diferente de la ruta de acceso de entrada.


Distinto en la versión 3.4: Added support for detecting non-root mount points on Windows.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex isdevdrive() (en el módulo os.path)
@anchor{library/os path os path isdevdrive}@anchor{1653}
@deffn {Función} os.path.isdevdrive (path)

Return @code{True} if pathname `path' is located on a Windows Dev Drive.
A Dev Drive is optimized for developer scenarios, and offers faster
performance for reading and writing files. It is recommended for use for
source code, temporary build directories, package caches, and other
IO-intensive operations.

May raise an error for an invalid path, for example, one without a
recognizable drive, but returns @code{False} on platforms that do not support
Dev Drives. See the Windows documentation@footnote{https://learn.microsoft.com/windows/dev-drive/}
for information on enabling and creating Dev Drives.


Added in version 3.12.



Distinto en la versión 3.13: The function is now available on all platforms, and will always return @code{False} on those that have no support for Dev Drives

@end deffn

@geindex isreserved() (en el módulo os.path)
@anchor{library/os path os path isreserved}@anchor{1d5}
@deffn {Función} os.path.isreserved (path)

Return @code{True} if `path' is a reserved pathname on the current system.

On Windows, reserved filenames include those that end with a space or dot;
those that contain colons (i.e. file streams such as «name:stream»),
wildcard characters (i.e. @code{'*?"<>'}), pipe, or ASCII control characters;
as well as DOS device names such as «NUL», «CON», «CONIN$», «CONOUT$»,
«AUX», «PRN», «COM1», and «LPT1».

@cartouche
@quotation Nota 
This function approximates rules for reserved paths on most Windows
systems. These rules change over time in various Windows releases.
This function may be updated in future Python releases as changes to
the rules become broadly available.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Windows.


Added in version 3.13.

@end deffn

@geindex join() (en el módulo os.path)
@anchor{library/os path os path join}@anchor{163f}
@deffn {Función} os.path.join (path, *paths)

Join one or more path segments intelligently.  The return value is the
concatenation of `path' and all members of `*paths', with exactly one
directory separator following each non-empty part, except the last. That is,
the result will only end in a separator if the last part is either empty or
ends in a separator. If a segment is an absolute path (which on Windows
requires both a drive and a root), then all previous segments are ignored and
joining continues from the absolute path segment.

On Windows, the drive is not reset when a rooted path segment (e.g.,
@code{r'\foo'}) is encountered. If a segment is on a different drive or is an
absolute path, all previous segments are ignored and the drive is reset. Note
that since there is a current directory for each drive,
@code{os.path.join("c:", "foo")} represents a path relative to the current
directory on drive @code{C:} (@code{c:foo}), not @code{c:\foo}.


Distinto en la versión 3.6: Acepta un objeto @ref{3f0,,path-like object} para `path' y `paths'.

@end deffn

@geindex normcase() (en el módulo os.path)
@anchor{library/os path os path normcase}@anchor{27cc}
@deffn {Función} os.path.normcase (path)

Normaliza las mayúsculas y minúsculas de un nombre de ruta. En Windows convierte todos los caracteres en el nombre de ruta a minúsculas y también convierte las barras inclinadas hacia atrás en barras inclinadas hacia atrás. En otros sistemas operativos, retorna la ruta sin cambios.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex normpath() (en el módulo os.path)
@anchor{library/os path os path normpath}@anchor{1382}
@deffn {Función} os.path.normpath (path)

Normaliza un nombre de ruta colapsando separadores redundantes y referencias de nivel superior para que @code{A//B}, @code{A/B/}, @code{A/./B} y @code{A/foo/../B} se transformen en @code{A/B}. Esta modificación de cadena puede que modifique el significado de la ruta que contenga enlaces simbólicos. En Windows, convierte las barras inclinadas hacia adelante en barras hacia atrás. Para normalizar mayúsculas y minúsculas, utiliza @ref{27cc,,normcase()}.

@cartouche
@quotation Nota 
En sistemas POSIX, de acuerdo con IEEE Std 1003.1 Edición 2013; 4.13 Resolución de Nombres de Rutas@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13}, si el nombre de ruta comienza con exactamente dos barras diagonales, el primer componente que sigue a los caracteres principales puede interpretarse de una manera definida por la implementación, aunque más de dos caracteres principales se tratarán como un solo carácter.
@end quotation
@end cartouche


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex realpath() (en el módulo os.path)
@anchor{library/os path os path realpath}@anchor{381}
@deffn {Función} os.path.realpath (path, *, strict=False)

Return the canonical path of the specified filename, eliminating any symbolic
links encountered in the path (if they are supported by the operating
system). On Windows, this function will also resolve MS-DOS (also called 8.3)
style names such as @code{C:\\PROGRA~1} to @code{C:\\Program Files}.

If a path doesn’t exist or a symlink loop is encountered, and `strict' is
@code{True}, @ref{4d5,,OSError} is raised. If `strict' is @code{False} these errors
are ignored, and so the result might be missing or otherwise inaccessible.

@cartouche
@quotation Nota 
Esta función emula el procedimiento del sistema operativo para hacer que una ruta sea canónica, que difiere ligeramente entre Windows y UNIX con respecto a cómo interactúan los enlaces y los componentes de la ruta posterior.

Las API del sistema operativo hacen que las rutas sean canónicas según sea necesario, por lo que normalmente no es necesario llamar a esta función.
@end quotation
@end cartouche


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.8: Los enlaces y uniones simbólicos ahora se resuelven en Windows.



Distinto en la versión 3.10: Se agregó el parámetro `strict'.

@end deffn

@geindex relpath() (en el módulo os.path)
@anchor{library/os path os path relpath}@anchor{552}
@deffn {Función} os.path.relpath (path, start=os.curdir)

Retorna un nombre de ruta relativo a `path' desde el directorio actual o de un directorio `start' opcional. Este es un cálculo de ruta: No se accede al sistema de archivos para confirmar la existencia o la naturaleza de `path' o `start'. En Windows, se lanza @ref{360,,ValueError}  cuando `path' y `start' están en discos diferentes.

`start' defaults to @ref{27cd,,os.curdir}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex samefile() (en el módulo os.path)
@anchor{library/os path os path samefile}@anchor{ff0}
@deffn {Función} os.path.samefile (path1, path2)

Retorna @code{True} si ambos argumentos de nombre de ruta refieren al mismo archivo o directorio. Esto se determina por el número de dispositivo y el número de `i-node' y lanza una excepción si una llamada de @ref{548,,os.stat()} en alguno de los nombres de ruta falla.


Distinto en la versión 3.2: Añadido soporte para Windows.



Distinto en la versión 3.4: Windows ahora utiliza la misma implementación que en el resto de las plataformas.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex sameopenfile() (en el módulo os.path)
@anchor{library/os path os path sameopenfile}@anchor{27ce}
@deffn {Función} os.path.sameopenfile (fp1, fp2)

Retorna @code{True} si los descriptores de archivo `fp1' y `fp2' se refieren al mismo archivo.


Distinto en la versión 3.2: Añadido soporte para Windows.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex samestat() (en el módulo os.path)
@anchor{library/os path os path samestat}@anchor{fef}
@deffn {Función} os.path.samestat (stat1, stat2)

Retorna @code{True} si las tuplas de `stat' (`stat1' y `stat2') refieren al mismo archivo. Estas estructuras pueden haber sido retornadas por @ref{e12,,os.fstat()}, @ref{549,,os.lstat()}, o @ref{548,,os.stat()}. Esta función implementa la comparación subyacente utilizada por: @ref{ff0,,samefile()} y @ref{27ce,,sameopenfile()}.


Distinto en la versión 3.4: Añadido soporte para Windows.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex split() (en el módulo os.path)
@anchor{library/os path os path split}@anchor{27c7}
@deffn {Función} os.path.split (path)

Divide el nombre de la ruta `path * en un par, `@w{`}(head, tail)`@w{`} donde *tail' es el último componente del nombre de la ruta y `head' es todo lo que conduce a eso. La parte `head' nunca contendrá una barra; si `head' termina en una barra, `tail' estará vacía. Si no hay barra inclinada en `path', `head' estará vacío. Si `path' está vacía, tanto `head' como `tail' estarán vacíos. Las barras diagonales finales se eliminan de `head' a menos que sea la raíz (solo una o más barras). En todos los casos, @code{join(head, tail)} retorna una ruta a la misma ubicación que `path' (pero las cadenas pueden diferir). Consulta las funciones @ref{27c3,,dirname()} y @ref{27c4,,basename()}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex splitdrive() (en el módulo os.path)
@anchor{library/os path os path splitdrive}@anchor{c7c}
@deffn {Función} os.path.splitdrive (path)

Divide el nombre de ruta `path' en un par @code{(drive, tail)} donde `drive' es un punto de montaje o una cadena vacía. En sistemas que no utilizan especificaciones de unidad, `drive' siempre será una cadena vacía. En todos los casos, @code{drive + tail} será lo mismo que `path'.

En Windows, divide un nombre de ruta en unidad / punto compartido UNC y ruta relativa.

Si la ruta contiene una letra de unidad, la unidad contendrá todo hasta los dos puntos inclusive:

@example
>>> splitdrive("c:/dir")
("c:", "/dir")
@end example

If the path contains a UNC path, drive will contain the host name
and share:

@example
>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")
@end example


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex splitroot() (en el módulo os.path)
@anchor{library/os path os path splitroot}@anchor{54c}
@deffn {Función} os.path.splitroot (path)

Split the pathname `path' into a 3-item tuple @code{(drive, root, tail)} where
`drive' is a device name or mount point, `root' is a string of separators
after the drive, and `tail' is everything after the root. Any of these
items may be the empty string. In all cases, @code{drive + root + tail} will
be the same as `path'.

On POSIX systems, `drive' is always empty. The `root' may be empty (if `path' is
relative), a single forward slash (if `path' is absolute), or two forward slashes
(implementation-defined per IEEE Std 1003.1-2017; 4.13 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13}.)
For example:

@example
>>> splitroot('/home/sam')
('@w{'}, '/', 'home/sam')
>>> splitroot('//home/sam')
('@w{'}, '//', 'home/sam')
>>> splitroot('///home/sam')
('@w{'}, '/', '//home/sam')
@end example

On Windows, `drive' may be empty, a drive-letter name, a UNC share, or a device
name. The `root' may be empty, a forward slash, or a backward slash. For
example:

@example
>>> splitroot('C:/Users/Sam')
('C:', '/', 'Users/Sam')
>>> splitroot('//Server/Share/Users/Sam')
('//Server/Share', '/', 'Users/Sam')
@end example


Added in version 3.12.

@end deffn

@geindex splitext() (en el módulo os.path)
@anchor{library/os path os path splitext}@anchor{15f5}
@deffn {Función} os.path.splitext (path)

Divide el nombre de la ruta `path' en un par @code{(root, ext)} de tal forma que @code{root + ext == path}, y `ext' queda vacío o inicia con un punto y contiene a lo mucho un punto.

Si la ruta no contiene ninguna extensión, `ext' será  @code{’’}:

@example
>>> splitext('bar')
('bar', '@w{'})
@end example

Si la ruta contiene una extensión, `ext' se establecerá como esta extensión, incluido el punto por delante. Tenga en cuenta que los puntos anteriores se ignorarán:

@example
>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
>>> splitext('/foo/bar.exe')
('/foo/bar', '.exe')
@end example

Los puntos que están por delante del último componente de la ruta son considerados parte de la raíz:

@example
>>> splitext('.cshrc')
('.cshrc', '@w{'})
>>> splitext('/foo/....jpg')
('/foo/....jpg', '@w{'})
@end example


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex supports_unicode_filenames (en el módulo os.path)
@anchor{library/os path os path supports_unicode_filenames}@anchor{14c8}
@deffn {Dato} os.path.supports_unicode_filenames

@code{True} si se pueden utilizar cadenas Unicode arbitrarias como nombres de archivo (dentro de las limitaciones impuestas por el sistema de archivos).
@end deffn

@node fileinput — Iterate over lines from multiple input streams,stat — Interpreting stat results,os path — Common pathname manipulations,Acceso a archivos y directorios
@anchor{library/fileinput doc}@anchor{27cf}@anchor{library/fileinput fileinput-iterate-over-lines-from-multiple-input-streams}@anchor{27d0}@anchor{library/fileinput module-fileinput}@anchor{5b}
@subsection @code{fileinput} — Iterate over lines from multiple input streams


@geindex module; fileinput

`Código fuente:' Lib/fileinput.py@footnote{https://github.com/python/cpython/tree/main/Lib/fileinput.py}


__________________________________________________________________


Este módulo implementa una clase auxiliar y funciones para escribir rápidamente un bucle sobre una entrada estándar o una lista de archivos. Si solo quiere leer o escribir un archivo, vea @ref{1be,,open()}.

El uso común es:

@example
import fileinput
for line in fileinput.input(encoding="utf-8"):
    process(line)
@end example

Esto itera sobre las líneas de todos los archivos enumerados en @code{sys.argv[1:]}, por defecto a @code{sys.stdin} si la lista está vacía. Si un nombre de archivo es @code{'-'}, también se reemplaza por @code{sys.stdin} y los argumentos opcionales `mode' y `openhook' se ignoran. Para especificar una lista alternativa de nombres de archivo, se pasa como primer argumento a @ref{896,,input()}. También se permite un único nombre de archivo.

Todos los archivos se abren en modo texto de manera predeterminada, pero puede anular esto especificando el parámetro `mode' en la llamada a @ref{896,,input()} o @ref{7d3,,FileInput}. Si se produce un error de E/S durante la apertura o lectura de un archivo, se lanza @ref{4d5,,OSError}.


Distinto en la versión 3.3: @ref{10ce,,IOError} solía ser lanzado; ahora es un alias de @ref{4d5,,OSError}.


Si @code{sys.stdin} se usa más de una vez, el segundo y siguientes usos no retornarán líneas, excepto tal vez para uso interactivo, o si se ha reiniciado explícitamente (por ejemplo, usando @code{sys.stdin.seek(0)}).

Los archivos vacíos se abren e inmediatamente se cierran; la única vez que su presencia en la lista de nombres de archivo es notable es cuando el último archivo abierto está vacío.

Las líneas se retornan con cualquier nueva línea intacta, lo que significa que la última línea en un archivo puede no tener una.

You can control how files are opened by providing an opening hook via the
`openhook' parameter to @ref{896,,fileinput.input()} or @ref{7d3,,FileInput()}. The
hook must be a function that takes two arguments, `filename' and `mode', and
returns an accordingly opened file-like object. If `encoding' and/or `errors'
are specified, they will be passed to the hook as additional keyword arguments.
This module provides a @ref{897,,hook_compressed()} to support compressed files.

La siguiente función es la interfaz principal de este módulo:

@geindex input() (en el módulo fileinput)
@anchor{library/fileinput fileinput input}@anchor{896}
@deffn {Función} fileinput.input (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

Crea una instancia de la clase @ref{7d3,,FileInput}. La instancia se usará como estado global para las funciones de este módulo y también se volverá a usar durante la iteración. Los parámetros de esta función se pasarán al constructor de la clase @ref{7d3,,FileInput}.

La instancia @ref{7d3,,FileInput} se puede usar como gestor de contexto en la declaración @ref{673,,with}. En este ejemplo, `input' se cierra después de salir de la instrucción @code{with}, incluso si se produce una excepción:

@example
with fileinput.input(files=('spam.txt', 'eggs.txt'), encoding="utf-8") as f:
    for line in f:
        process(line)
@end example


Distinto en la versión 3.2: Se puede usar como gestor de contexto.



Distinto en la versión 3.8: Los parámetros de palabras clave `mode' y `openhook' ahora son solo palabras clave.



Distinto en la versión 3.10: Los parámetros exclusivos de palabra clave `encoding' y `errors' son añadidos.

@end deffn

Las siguientes funciones utilizan el estado global creado por @ref{896,,fileinput.input()}; si no hay estado activo, es lanzado @ref{1e5,,RuntimeError}.

@geindex filename() (en el módulo fileinput)
@anchor{library/fileinput fileinput filename}@anchor{27d1}
@deffn {Función} fileinput.filename ()

Retorna el nombre del archivo que se está leyendo actualmente. Antes de leer la primera línea, retorna @code{None}.
@end deffn

@geindex fileno() (en el módulo fileinput)
@anchor{library/fileinput fileinput fileno}@anchor{146d}
@deffn {Función} fileinput.fileno ()

Retorna el entero «file descriptor» para el archivo actual. Cuando no se abre ningún archivo (antes de la primera línea y entre archivos), retorna @code{-1}.
@end deffn

@geindex lineno() (en el módulo fileinput)
@anchor{library/fileinput fileinput lineno}@anchor{27d2}
@deffn {Función} fileinput.lineno ()

Retorna el número de línea acumulativa de la línea que se acaba de leer. Antes de que se haya leído la primera línea, retorna @code{0}. Después de leer la última línea del último archivo, retorna el número de línea de esa línea.
@end deffn

@geindex filelineno() (en el módulo fileinput)
@anchor{library/fileinput fileinput filelineno}@anchor{27d3}
@deffn {Función} fileinput.filelineno ()

Retorna el número de línea en el archivo actual. Antes de que se haya leído la primera línea, retorna @code{0}. Después de leer la última línea del último archivo, retorna el número de línea de esa línea dentro del archivo.
@end deffn

@geindex isfirstline() (en el módulo fileinput)
@anchor{library/fileinput fileinput isfirstline}@anchor{27d4}
@deffn {Función} fileinput.isfirstline ()

Retorna @code{True} si la línea que acaba de leer es la primera línea de su archivo; de lo contrario, retorna @code{False}.
@end deffn

@geindex isstdin() (en el módulo fileinput)
@anchor{library/fileinput fileinput isstdin}@anchor{27d5}
@deffn {Función} fileinput.isstdin ()

Retorna @code{True} si la última línea se leyó de @code{sys.stdin}, de lo contrario, retorna @code{False}.
@end deffn

@geindex nextfile() (en el módulo fileinput)
@anchor{library/fileinput fileinput nextfile}@anchor{27d6}
@deffn {Función} fileinput.nextfile ()

Cierra el archivo actual para que la próxima iteración lea la primera línea del siguiente archivo (si corresponde); las líneas no leídas del archivo no contarán para el recuento de líneas acumuladas. El nombre del archivo no se cambia hasta que se haya leído la primera línea del siguiente archivo. Antes de que se haya leído la primera línea, esta función no tiene efecto; no se puede usar para omitir el primer archivo. Después de leer la última línea del último archivo, esta función no tiene efecto.
@end deffn

@geindex close() (en el módulo fileinput)
@anchor{library/fileinput fileinput close}@anchor{27d7}
@deffn {Función} fileinput.close ()

Cierra la secuencia.
@end deffn

La clase que implementa el comportamiento de secuencia proporcionado por el módulo también está disponible para la subclasificación:

@geindex FileInput (clase en fileinput)
@anchor{library/fileinput fileinput FileInput}@anchor{7d3}
@deffn {Clase} fileinput.FileInput (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

La Clase @ref{7d3,,FileInput} es la implementación; sus métodos @ref{27d1,,filename()}, @ref{146d,,fileno()}, @ref{27d2,,lineno()}, @ref{27d3,,filelineno()}, @ref{27d4,,isfirstline()}, @ref{27d5,,isstdin()}, @ref{27d6,,nextfile()} y @ref{27d7,,close()} corresponden a las funciones del mismo nombre en el módulo. Además es @ref{1294,,iterable} y tiene un método @ref{1cc4,,readline()} que retorna la siguiente línea de entrada. Se debe acceder a la secuencia en orden estrictamente secuencial; acceso aleatorio y @ref{1cc4,,readline()} no se pueden mezclar.

Con `mode' puede especificar qué modo de archivo se pasará a @ref{1be,,open()}. Debe ser uno de @code{'r'} y @code{'rb'}.

El `openhook', cuando se proporciona, debe ser una función que tome dos argumentos, `filename' y `mode', y retorne un objeto similar a un archivo abierto en consecuencia. No puede usar `inplace' y `openhook' juntos.

Puedes especificar `encoding' y `errors' que son pasados a @ref{1be,,open()} o `openhook'.

Una instancia @ref{7d3,,FileInput} se puede usar como gestor de contexto en la instrucción @ref{673,,with}. En este ejemplo, `input' se cierra después de salir de la palabra @code{with}, incluso si se produce una excepción:

@example
with FileInput(files=('spam.txt', 'eggs.txt')) as input:
    process(input)
@end example


Distinto en la versión 3.2: Se puede usar como gestor de contexto.



Distinto en la versión 3.8: El parámetro de palabra clave `mode' y `openhook' ahora son solo palabras clave.



Distinto en la versión 3.10: Los parámetros exclusivos de palabra clave `encoding' y `errors' son añadidos.



Distinto en la versión 3.11: Los modos @code{'rU'} y @code{'U'} y el método @code{__getitem__()} han sido eliminados.

@end deffn

`Filtrado al instante opcional:' si el argumento de la palabra clave @code{inplace=True} se pasa a @ref{896,,fileinput.input()} o al constructor @ref{7d3,,FileInput}, el archivo se mueve a una copia de seguridad y la salida estándar es dirigida al archivo de entrada (si ya existe un archivo con el mismo nombre que el archivo de copia de seguridad, se reemplazará en silencio). Esto hace posible escribir un filtro que reescribe su archivo de entrada en su lugar. Si se proporciona el parámetro `backup' (generalmente como @code{backup='.<some extension>'}), este especifica la extensión para el archivo de respaldo y el archivo de respaldo permanece; de forma predeterminada, la extensión es @code{'.bak'} y se elimina cuando se cierra el archivo de salida. El filtrado en el lugar se desactiva cuando se lee la entrada estándar.

Este módulo proporciona los dos enlaces de apertura siguientes:

@geindex hook_compressed() (en el módulo fileinput)
@anchor{library/fileinput fileinput hook_compressed}@anchor{897}
@deffn {Función} fileinput.hook_compressed (filename, mode, *, encoding=None, errors=None)

Abre de forma transparente archivos comprimidos con `gzip' y `bzip2' (reconocidos por las extensiones @code{'.gz'} and @code{'.bz2'}) utilizando los módulos @ref{67,,gzip} y @ref{14,,bz2}. Si la extensión del nombre de archivo no es @code{'.gz'} or @code{'.bz2'}, el archivo se abre normalmente (es decir, usando @ref{1be,,open()} sin descompresión).

Los valores `encoding' y `errors' se pasan a @ref{854,,io.TextIOWrapper} para archivos comprimidos y para abrir archivos normales.

Ejemplo de uso: @code{fi = fileinput.FileInput(openhook=fileinput.hook_compressed, encoding="utf-8")}


Distinto en la versión 3.10: Los parámetros exclusivos de palabra clave `encoding' y `errors' son añadidos.

@end deffn

@geindex hook_encoded() (en el módulo fileinput)
@anchor{library/fileinput fileinput hook_encoded}@anchor{d29}
@deffn {Función} fileinput.hook_encoded (encoding, errors=None)

Retorna un enlace que abre cada archivo con @ref{1be,,open()}, usando el `encoding' y `errors' dados para leer el archivo.

Ejemplo de uso: @code{fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))}


Distinto en la versión 3.6: Se agregó el parámetro opcional `errors'.



Obsoleto desde la versión 3.10: Esta función está en desuso ya que @ref{896,,fileinput.input()} y @ref{7d3,,FileInput} ahora tienen los parámetros `encoding' y `errors'.

@end deffn

@node stat — Interpreting stat results,filecmp — File and Directory Comparisons,fileinput — Iterate over lines from multiple input streams,Acceso a archivos y directorios
@anchor{library/stat doc}@anchor{27d8}@anchor{library/stat module-stat}@anchor{d1}@anchor{library/stat stat-interpreting-stat-results}@anchor{27d9}
@subsection @code{stat} — Interpreting @code{stat()} results


@geindex module; stat

`Código fuente:' Lib/stat.py@footnote{https://github.com/python/cpython/tree/main/Lib/stat.py}


__________________________________________________________________


The @ref{d1,,stat} module defines constants and functions for interpreting the
results of @ref{548,,os.stat()}, @ref{e12,,os.fstat()} and @ref{549,,os.lstat()} (if they
exist).  For complete details about the @code{stat()}, @code{fstat()} and
@code{lstat()} calls, consult the documentation for your system.


Distinto en la versión 3.4: El módulo `stat' se apoya en una implementación en C.


El módulo @ref{d1,,stat} define las siguientes funciones para comprobar tipos de archivo específicos:

@geindex S_ISDIR() (en el módulo stat)
@anchor{library/stat stat S_ISDIR}@anchor{27da}
@deffn {Función} stat.S_ISDIR (mode)

Retorna un valor no nulo si el modo es de un directorio.
@end deffn

@geindex S_ISCHR() (en el módulo stat)
@anchor{library/stat stat S_ISCHR}@anchor{27db}
@deffn {Función} stat.S_ISCHR (mode)

Retorna un valor no nulo si el modo es de un archivo de un dispositivo especial de caracteres.
@end deffn

@geindex S_ISBLK() (en el módulo stat)
@anchor{library/stat stat S_ISBLK}@anchor{27dc}
@deffn {Función} stat.S_ISBLK (mode)

Retorna un valor no nulo si el modo es de un archivo de un dispositivo especial de bloques.
@end deffn

@geindex S_ISREG() (en el módulo stat)
@anchor{library/stat stat S_ISREG}@anchor{27dd}
@deffn {Función} stat.S_ISREG (mode)

Retorna un valor no nulo si el modo es de un archivo normal.
@end deffn

@geindex S_ISFIFO() (en el módulo stat)
@anchor{library/stat stat S_ISFIFO}@anchor{27de}
@deffn {Función} stat.S_ISFIFO (mode)

Retorna un valor no nulo si el modo es de un `FIFO' (tubería con nombre).
@end deffn

@geindex S_ISLNK() (en el módulo stat)
@anchor{library/stat stat S_ISLNK}@anchor{27df}
@deffn {Función} stat.S_ISLNK (mode)

Retorna un valor no nulo si el modo es de un enlace simbólico.
@end deffn

@geindex S_ISSOCK() (en el módulo stat)
@anchor{library/stat stat S_ISSOCK}@anchor{27e0}
@deffn {Función} stat.S_ISSOCK (mode)

Retorna un valor no nulo si el modo es de un socket.
@end deffn

@geindex S_ISDOOR() (en el módulo stat)
@anchor{library/stat stat S_ISDOOR}@anchor{19cf}
@deffn {Función} stat.S_ISDOOR (mode)

Retorna un valor no nulo si el modo es de un `door'.


Added in version 3.4.

@end deffn

@geindex S_ISPORT() (en el módulo stat)
@anchor{library/stat stat S_ISPORT}@anchor{19d0}
@deffn {Función} stat.S_ISPORT (mode)

Retorna un valor no nulo si el modo es de un `event port'.


Added in version 3.4.

@end deffn

@geindex S_ISWHT() (en el módulo stat)
@anchor{library/stat stat S_ISWHT}@anchor{19d1}
@deffn {Función} stat.S_ISWHT (mode)

Retorna un valor no nulo si el modo es de un `whiteout'.


Added in version 3.4.

@end deffn

Se definen dos funciones adicionales para una manipulación más general del modo del archivo:

@geindex S_IMODE() (en el módulo stat)
@anchor{library/stat stat S_IMODE}@anchor{27e1}
@deffn {Función} stat.S_IMODE (mode)

Retorna la porción del modo del archivo que puede ser establecida por @ref{378,,os.chmod()}— esto es, los bits de los permisos del archivo más los bits `sticky bit', `set-group-id' y `set-user-id' (en los sistemas que lo soporten).
@end deffn

@geindex S_IFMT() (en el módulo stat)
@anchor{library/stat stat S_IFMT}@anchor{27e2}
@deffn {Función} stat.S_IFMT (mode)

Return the portion of the file’s mode that describes the file type (used by the
@code{S_IS*()} functions above).
@end deffn

Normally, you would use the @code{os.path.is*()} functions for testing the type
of a file; the functions here are useful when you are doing multiple tests of
the same file and wish to avoid the overhead of the @code{stat()} system call
for each test.  These are also useful when checking for information about a file
that isn’t handled by @ref{a2,,os.path}, like the tests for block and character
devices.

Ejemplo:

@example
import os, sys
from stat import *

def walktree(top, callback):
    '@w{'}'recursively descend the directory tree rooted at top,
       calling the callback function for each regular file'@w{'}'

    for f in os.listdir(top):
        pathname = os.path.join(top, f)
        mode = os.lstat(pathname).st_mode
        if S_ISDIR(mode):
            # It's a directory, recurse into it
            walktree(pathname, callback)
        elif S_ISREG(mode):
            # It's a file, call the callback function
            callback(pathname)
        else:
            # Unknown file type, print a message
            print('Skipping %s' % pathname)

def visitfile(file):
    print('visiting', file)

if __name__ == '__main__':
    walktree(sys.argv[1], visitfile)
@end example

Se proporciona una función de utilidad adicional para convertir el modo del archivo en una cadena de caracteres legible por humanos:

@geindex filemode() (en el módulo stat)
@anchor{library/stat stat filemode}@anchor{11bc}
@deffn {Función} stat.filemode (mode)

Convierte el modo del archivo a una cadena de caracteres de la forma “-rwxrwxrwx”.


Added in version 3.3.



Distinto en la versión 3.4: La función soporta @ref{1039,,S_IFDOOR}, @ref{103a,,S_IFPORT} y @ref{103b,,S_IFWHT}.

@end deffn

Todas las variables de debajo son simplemente índices simbólicos sobre la tupla de 10 elementos retornada por @ref{548,,os.stat()}, @ref{e12,,os.fstat()} o @ref{549,,os.lstat()}.

@geindex ST_MODE (en el módulo stat)
@anchor{library/stat stat ST_MODE}@anchor{1038}
@deffn {Dato} stat.ST_MODE

Modo de protección del `inode'.
@end deffn

@geindex ST_INO (en el módulo stat)
@anchor{library/stat stat ST_INO}@anchor{27e3}
@deffn {Dato} stat.ST_INO

Número del `inode'.
@end deffn

@geindex ST_DEV (en el módulo stat)
@anchor{library/stat stat ST_DEV}@anchor{27e4}
@deffn {Dato} stat.ST_DEV

Dispositivo en el que reside el `inode'.
@end deffn

@geindex ST_NLINK (en el módulo stat)
@anchor{library/stat stat ST_NLINK}@anchor{27e5}
@deffn {Dato} stat.ST_NLINK

Número de enlaces al `inode'.
@end deffn

@geindex ST_UID (en el módulo stat)
@anchor{library/stat stat ST_UID}@anchor{27e6}
@deffn {Dato} stat.ST_UID

`Id' de usuario del propietario.
@end deffn

@geindex ST_GID (en el módulo stat)
@anchor{library/stat stat ST_GID}@anchor{27e7}
@deffn {Dato} stat.ST_GID

`Id' del grupo del propietario.
@end deffn

@geindex ST_SIZE (en el módulo stat)
@anchor{library/stat stat ST_SIZE}@anchor{27e8}
@deffn {Dato} stat.ST_SIZE

Tamaño en bytes de un archivo normal; cantidad de datos esperando en algunos archivos especiales.
@end deffn

@geindex ST_ATIME (en el módulo stat)
@anchor{library/stat stat ST_ATIME}@anchor{27e9}
@deffn {Dato} stat.ST_ATIME

Momento del último acceso.
@end deffn

@geindex ST_MTIME (en el módulo stat)
@anchor{library/stat stat ST_MTIME}@anchor{27ea}
@deffn {Dato} stat.ST_MTIME

Momento de la última modificación.
@end deffn

@geindex ST_CTIME (en el módulo stat)
@anchor{library/stat stat ST_CTIME}@anchor{27eb}
@deffn {Dato} stat.ST_CTIME

El «ctime» reportado por el sistema operativo. En algunos sistemas (como Unix) es el momento del último cambio en los metadatos, y en otros (como Windows), es el momento de creación (véase la documentación de la plataforma para más detalles).
@end deffn

La interpretación de «tamaño de archivo» cambia dependiendo del tipo de archivo. Para archivos normales es el tamaño del archivo en bytes. En la mayoría de sistemas Unix (incluyendo Linux en particular), para `FIFOs' y sockets es el número de bytes que esperan ser leídos en el momento de la llamada a @ref{548,,os.stat()}, @ref{e12,,os.fstat()}, o @ref{549,,os.lstat()}; en ocasiones, esto puede ser útil, especialmente para sondear uno de estos archivos especiales después de una apertura no bloqueante. Para otros dispositivos de caracteres y bloques el significado del campo `size' es más variado, dependiendo de la implementación de la llamada al sistema subyacente.

Las variables de debajo definen los flags usados en el campo @ref{1038,,ST_MODE}.

El uso de las funciones de arriba es más portable que el uso del primer juego de flags:

@geindex S_IFSOCK (en el módulo stat)
@anchor{library/stat stat S_IFSOCK}@anchor{27ec}
@deffn {Dato} stat.S_IFSOCK

`Socket'.
@end deffn

@geindex S_IFLNK (en el módulo stat)
@anchor{library/stat stat S_IFLNK}@anchor{27ed}
@deffn {Dato} stat.S_IFLNK

Enlace simbólico.
@end deffn

@geindex S_IFREG (en el módulo stat)
@anchor{library/stat stat S_IFREG}@anchor{27ee}
@deffn {Dato} stat.S_IFREG

Archivo normal.
@end deffn

@geindex S_IFBLK (en el módulo stat)
@anchor{library/stat stat S_IFBLK}@anchor{27ef}
@deffn {Dato} stat.S_IFBLK

Dispositivo de bloques.
@end deffn

@geindex S_IFDIR (en el módulo stat)
@anchor{library/stat stat S_IFDIR}@anchor{27f0}
@deffn {Dato} stat.S_IFDIR

Directorio.
@end deffn

@geindex S_IFCHR (en el módulo stat)
@anchor{library/stat stat S_IFCHR}@anchor{27f1}
@deffn {Dato} stat.S_IFCHR

Dispositivo de caracteres.
@end deffn

@geindex S_IFIFO (en el módulo stat)
@anchor{library/stat stat S_IFIFO}@anchor{27f2}
@deffn {Dato} stat.S_IFIFO

`FIFO'.
@end deffn

@geindex S_IFDOOR (en el módulo stat)
@anchor{library/stat stat S_IFDOOR}@anchor{1039}
@deffn {Dato} stat.S_IFDOOR

`Door'.


Added in version 3.4.

@end deffn

@geindex S_IFPORT (en el módulo stat)
@anchor{library/stat stat S_IFPORT}@anchor{103a}
@deffn {Dato} stat.S_IFPORT

`Event port'.


Added in version 3.4.

@end deffn

@geindex S_IFWHT (en el módulo stat)
@anchor{library/stat stat S_IFWHT}@anchor{103b}
@deffn {Dato} stat.S_IFWHT

`Whiteout'.


Added in version 3.4.

@end deffn

@cartouche
@quotation Nota 
@ref{1039,,S_IFDOOR}, @ref{103a,,S_IFPORT} o @ref{103b,,S_IFWHT} se definen como 0 cuando la plataforma no soporta los tipos de archivo.
@end quotation
@end cartouche

Los siguientes flags también pueden usarse en el argumento `mode' de @ref{378,,os.chmod()}:

@geindex S_ISUID (en el módulo stat)
@anchor{library/stat stat S_ISUID}@anchor{27f3}
@deffn {Dato} stat.S_ISUID

Establecer el bit `UID'.
@end deffn

@geindex S_ISGID (en el módulo stat)
@anchor{library/stat stat S_ISGID}@anchor{27f4}
@deffn {Dato} stat.S_ISGID

Bit `Set-group-ID'. Este bit tiene varios usos especiales. Para un directorio indica que la semántica BSD debe usarse para ese directorio: los archivos creados ahí heredan el `ID' de grupo del directorio, no del `ID' de grupo efectivo del proceso que los crea, y los directorios creados ahí también tendrán activado el bit @ref{27f4,,S_ISGID}. Para un archivo que no tiene activado el bit de ejecución de grupo (@ref{27f5,,S_IXGRP}), el bit `Set-group-ID' indica el bloqueo obligatorio del archivo/registro (véase también @ref{27f6,,S_ENFMT}).
@end deffn

@geindex S_ISVTX (en el módulo stat)
@anchor{library/stat stat S_ISVTX}@anchor{27f7}
@deffn {Dato} stat.S_ISVTX

`Sticky bit'. Cuando este bit está activado en un directorio, significa que un archivo dentro de ese directorio puede ser renombrado o borrado sólo por el propietario del archivo, por el propietario del directorio, o por un proceso con privilegios.
@end deffn

@geindex S_IRWXU (en el módulo stat)
@anchor{library/stat stat S_IRWXU}@anchor{27f8}
@deffn {Dato} stat.S_IRWXU

Máscara para los permisos del propietario del archivo.
@end deffn

@geindex S_IRUSR (en el módulo stat)
@anchor{library/stat stat S_IRUSR}@anchor{27f9}
@deffn {Dato} stat.S_IRUSR

El propietario tiene permiso de lectura.
@end deffn

@geindex S_IWUSR (en el módulo stat)
@anchor{library/stat stat S_IWUSR}@anchor{27fa}
@deffn {Dato} stat.S_IWUSR

El propietario tiene permiso de escritura.
@end deffn

@geindex S_IXUSR (en el módulo stat)
@anchor{library/stat stat S_IXUSR}@anchor{27fb}
@deffn {Dato} stat.S_IXUSR

El propietario tiene permiso de ejecución.
@end deffn

@geindex S_IRWXG (en el módulo stat)
@anchor{library/stat stat S_IRWXG}@anchor{27fc}
@deffn {Dato} stat.S_IRWXG

Máscara para los permisos del grupo.
@end deffn

@geindex S_IRGRP (en el módulo stat)
@anchor{library/stat stat S_IRGRP}@anchor{27fd}
@deffn {Dato} stat.S_IRGRP

El grupo tiene permiso de lectura.
@end deffn

@geindex S_IWGRP (en el módulo stat)
@anchor{library/stat stat S_IWGRP}@anchor{27fe}
@deffn {Dato} stat.S_IWGRP

El grupo tiene permiso de escritura.
@end deffn

@geindex S_IXGRP (en el módulo stat)
@anchor{library/stat stat S_IXGRP}@anchor{27f5}
@deffn {Dato} stat.S_IXGRP

El grupo tiene permiso de ejecución.
@end deffn

@geindex S_IRWXO (en el módulo stat)
@anchor{library/stat stat S_IRWXO}@anchor{27ff}
@deffn {Dato} stat.S_IRWXO

Máscara para permisos de los otros (no en el grupo).
@end deffn

@geindex S_IROTH (en el módulo stat)
@anchor{library/stat stat S_IROTH}@anchor{2800}
@deffn {Dato} stat.S_IROTH

Los otros tienen permiso de lectura.
@end deffn

@geindex S_IWOTH (en el módulo stat)
@anchor{library/stat stat S_IWOTH}@anchor{2801}
@deffn {Dato} stat.S_IWOTH

Los otros tienen permiso de escritura.
@end deffn

@geindex S_IXOTH (en el módulo stat)
@anchor{library/stat stat S_IXOTH}@anchor{2802}
@deffn {Dato} stat.S_IXOTH

Los otros tienen permiso de ejecución.
@end deffn

@geindex S_ENFMT (en el módulo stat)
@anchor{library/stat stat S_ENFMT}@anchor{27f6}
@deffn {Dato} stat.S_ENFMT

Imposición del bloqueo de archivos de System V. Este flag se comparte con @ref{27f4,,S_ISGID}: se impone el bloqueo de archivos/registros en archivos que no tengan activado el bit de ejecución por el grupo (@ref{27f5,,S_IXGRP}).
@end deffn

@geindex S_IREAD (en el módulo stat)
@anchor{library/stat stat S_IREAD}@anchor{2803}
@deffn {Dato} stat.S_IREAD

Sinónimo de @ref{27f9,,S_IRUSR} en Unix V7.
@end deffn

@geindex S_IWRITE (en el módulo stat)
@anchor{library/stat stat S_IWRITE}@anchor{2804}
@deffn {Dato} stat.S_IWRITE

Sinónimo de @ref{27fa,,S_IWUSR} en Unix V7.
@end deffn

@geindex S_IEXEC (en el módulo stat)
@anchor{library/stat stat S_IEXEC}@anchor{2805}
@deffn {Dato} stat.S_IEXEC

Sinónimo de @ref{27fb,,S_IXUSR} en Unix V7.
@end deffn

Los siguientes flags pueden usarse como argumento `flags' de @ref{1160,,os.chflags()}:

@geindex UF_SETTABLE (en el módulo stat)
@anchor{library/stat stat UF_SETTABLE}@anchor{2806}
@deffn {Dato} stat.UF_SETTABLE

All user settable flags.


Added in version 3.13.

@end deffn

@geindex UF_NODUMP (en el módulo stat)
@anchor{library/stat stat UF_NODUMP}@anchor{2807}
@deffn {Dato} stat.UF_NODUMP

No volcar el archivo.
@end deffn

@geindex UF_IMMUTABLE (en el módulo stat)
@anchor{library/stat stat UF_IMMUTABLE}@anchor{2808}
@deffn {Dato} stat.UF_IMMUTABLE

El archivo no puede ser modificado.
@end deffn

@geindex UF_APPEND (en el módulo stat)
@anchor{library/stat stat UF_APPEND}@anchor{2809}
@deffn {Dato} stat.UF_APPEND

Sólo se puede añadir al archivo.
@end deffn

@geindex UF_OPAQUE (en el módulo stat)
@anchor{library/stat stat UF_OPAQUE}@anchor{280a}
@deffn {Dato} stat.UF_OPAQUE

El directorio es opaco cuando se mira a través de un `union stack'.
@end deffn

@geindex UF_NOUNLINK (en el módulo stat)
@anchor{library/stat stat UF_NOUNLINK}@anchor{280b}
@deffn {Dato} stat.UF_NOUNLINK

El archivo no puede ser renombrado o borrado.
@end deffn

@geindex UF_COMPRESSED (en el módulo stat)
@anchor{library/stat stat UF_COMPRESSED}@anchor{280c}
@deffn {Dato} stat.UF_COMPRESSED

El archivo se almacena comprimido (macOS 10.6+).
@end deffn

@geindex UF_TRACKED (en el módulo stat)
@anchor{library/stat stat UF_TRACKED}@anchor{280d}
@deffn {Dato} stat.UF_TRACKED

Used for handling document IDs (macOS)


Added in version 3.13.

@end deffn

@geindex UF_DATAVAULT (en el módulo stat)
@anchor{library/stat stat UF_DATAVAULT}@anchor{280e}
@deffn {Dato} stat.UF_DATAVAULT

The file needs an entitlement for reading or writing (macOS 10.13+)


Added in version 3.13.

@end deffn

@geindex UF_HIDDEN (en el módulo stat)
@anchor{library/stat stat UF_HIDDEN}@anchor{280f}
@deffn {Dato} stat.UF_HIDDEN

El archivo no debe ser mostrado en una GUI (macOS 10.5+).
@end deffn

@geindex SF_SETTABLE (en el módulo stat)
@anchor{library/stat stat SF_SETTABLE}@anchor{2810}
@deffn {Dato} stat.SF_SETTABLE

All super-user changeable flags


Added in version 3.13.

@end deffn

@geindex SF_SUPPORTED (en el módulo stat)
@anchor{library/stat stat SF_SUPPORTED}@anchor{2811}
@deffn {Dato} stat.SF_SUPPORTED

All super-user supported flags

@ref{1d5a,,Availability}: macOS


Added in version 3.13.

@end deffn

@geindex SF_SYNTHETIC (en el módulo stat)
@anchor{library/stat stat SF_SYNTHETIC}@anchor{2812}
@deffn {Dato} stat.SF_SYNTHETIC

All super-user read-only synthetic flags

@ref{1d5a,,Availability}: macOS


Added in version 3.13.

@end deffn

@geindex SF_ARCHIVED (en el módulo stat)
@anchor{library/stat stat SF_ARCHIVED}@anchor{2813}
@deffn {Dato} stat.SF_ARCHIVED

El archivo puede ser archivado.
@end deffn

@geindex SF_IMMUTABLE (en el módulo stat)
@anchor{library/stat stat SF_IMMUTABLE}@anchor{2814}
@deffn {Dato} stat.SF_IMMUTABLE

El archivo no puede ser modificado.
@end deffn

@geindex SF_APPEND (en el módulo stat)
@anchor{library/stat stat SF_APPEND}@anchor{2815}
@deffn {Dato} stat.SF_APPEND

Sólo se puede añadir al archivo.
@end deffn

@geindex SF_RESTRICTED (en el módulo stat)
@anchor{library/stat stat SF_RESTRICTED}@anchor{2816}
@deffn {Dato} stat.SF_RESTRICTED

The file needs an entitlement to write to (macOS 10.13+)


Added in version 3.13.

@end deffn

@geindex SF_NOUNLINK (en el módulo stat)
@anchor{library/stat stat SF_NOUNLINK}@anchor{2817}
@deffn {Dato} stat.SF_NOUNLINK

El archivo no puede ser renombrado o borrado.
@end deffn

@geindex SF_SNAPSHOT (en el módulo stat)
@anchor{library/stat stat SF_SNAPSHOT}@anchor{2818}
@deffn {Dato} stat.SF_SNAPSHOT

El archivo es una instantánea.
@end deffn

@geindex SF_FIRMLINK (en el módulo stat)
@anchor{library/stat stat SF_FIRMLINK}@anchor{2819}
@deffn {Dato} stat.SF_FIRMLINK

The file is a firmlink (macOS 10.15+)


Added in version 3.13.

@end deffn

@geindex SF_DATALESS (en el módulo stat)
@anchor{library/stat stat SF_DATALESS}@anchor{281a}
@deffn {Dato} stat.SF_DATALESS

The file is a dataless object (macOS 10.15+)


Added in version 3.13.

@end deffn

Consulte la página de manual de sistemas * BSD o macOS @code{chflags(2)@footnote{https://manpages.debian.org/chflags(2)}} para obtener más información.

En Windows, las siguientes constantes de atributos de fichero están disponibles para ser usadas al comprobar los bits del miembro @code{st_file_attributes} retornado por @ref{548,,os.stat()}. Véase Windows API documentation@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx} para más detalles sobre el significado de estas constantes.

@geindex FILE_ATTRIBUTE_ARCHIVE (en el módulo stat)
@geindex FILE_ATTRIBUTE_COMPRESSED (en el módulo stat)
@geindex FILE_ATTRIBUTE_DEVICE (en el módulo stat)
@geindex FILE_ATTRIBUTE_DIRECTORY (en el módulo stat)
@geindex FILE_ATTRIBUTE_ENCRYPTED (en el módulo stat)
@geindex FILE_ATTRIBUTE_HIDDEN (en el módulo stat)
@geindex FILE_ATTRIBUTE_INTEGRITY_STREAM (en el módulo stat)
@geindex FILE_ATTRIBUTE_NORMAL (en el módulo stat)
@geindex FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (en el módulo stat)
@geindex FILE_ATTRIBUTE_NO_SCRUB_DATA (en el módulo stat)
@geindex FILE_ATTRIBUTE_OFFLINE (en el módulo stat)
@geindex FILE_ATTRIBUTE_READONLY (en el módulo stat)
@geindex FILE_ATTRIBUTE_REPARSE_POINT (en el módulo stat)
@geindex FILE_ATTRIBUTE_SPARSE_FILE (en el módulo stat)
@geindex FILE_ATTRIBUTE_SYSTEM (en el módulo stat)
@geindex FILE_ATTRIBUTE_TEMPORARY (en el módulo stat)
@geindex FILE_ATTRIBUTE_VIRTUAL (en el módulo stat)
@anchor{library/stat stat FILE_ATTRIBUTE_ARCHIVE}@anchor{281b}
@deffn {Dato} stat.FILE_ATTRIBUTE_ARCHIVE
@anchor{library/stat stat FILE_ATTRIBUTE_COMPRESSED}@anchor{281c}
@deffnx {Dato} stat.FILE_ATTRIBUTE_COMPRESSED
@anchor{library/stat stat FILE_ATTRIBUTE_DEVICE}@anchor{281d}
@deffnx {Dato} stat.FILE_ATTRIBUTE_DEVICE
@anchor{library/stat stat FILE_ATTRIBUTE_DIRECTORY}@anchor{281e}
@deffnx {Dato} stat.FILE_ATTRIBUTE_DIRECTORY
@anchor{library/stat stat FILE_ATTRIBUTE_ENCRYPTED}@anchor{281f}
@deffnx {Dato} stat.FILE_ATTRIBUTE_ENCRYPTED
@anchor{library/stat stat FILE_ATTRIBUTE_HIDDEN}@anchor{2820}
@deffnx {Dato} stat.FILE_ATTRIBUTE_HIDDEN
@anchor{library/stat stat FILE_ATTRIBUTE_INTEGRITY_STREAM}@anchor{2821}
@deffnx {Dato} stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
@anchor{library/stat stat FILE_ATTRIBUTE_NORMAL}@anchor{2822}
@deffnx {Dato} stat.FILE_ATTRIBUTE_NORMAL
@anchor{library/stat stat FILE_ATTRIBUTE_NOT_CONTENT_INDEXED}@anchor{2823}
@deffnx {Dato} stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
@anchor{library/stat stat FILE_ATTRIBUTE_NO_SCRUB_DATA}@anchor{2824}
@deffnx {Dato} stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
@anchor{library/stat stat FILE_ATTRIBUTE_OFFLINE}@anchor{2825}
@deffnx {Dato} stat.FILE_ATTRIBUTE_OFFLINE
@anchor{library/stat stat FILE_ATTRIBUTE_READONLY}@anchor{2826}
@deffnx {Dato} stat.FILE_ATTRIBUTE_READONLY
@anchor{library/stat stat FILE_ATTRIBUTE_REPARSE_POINT}@anchor{2827}
@deffnx {Dato} stat.FILE_ATTRIBUTE_REPARSE_POINT
@anchor{library/stat stat FILE_ATTRIBUTE_SPARSE_FILE}@anchor{2828}
@deffnx {Dato} stat.FILE_ATTRIBUTE_SPARSE_FILE
@anchor{library/stat stat FILE_ATTRIBUTE_SYSTEM}@anchor{2829}
@deffnx {Dato} stat.FILE_ATTRIBUTE_SYSTEM
@anchor{library/stat stat FILE_ATTRIBUTE_TEMPORARY}@anchor{282a}
@deffnx {Dato} stat.FILE_ATTRIBUTE_TEMPORARY
@anchor{library/stat stat FILE_ATTRIBUTE_VIRTUAL}@anchor{282b}
@deffnx {Dato} stat.FILE_ATTRIBUTE_VIRTUAL


Added in version 3.5.

@end deffn

En Windows, las siguientes constantes están disponibles para la comparación con el miembro @code{st_reparse_tag} retornado por @ref{549,,os.lstat()}. Estas constantes son muy conocidas, pero no se trata de una lista exhaustiva.

@geindex IO_REPARSE_TAG_SYMLINK (en el módulo stat)
@geindex IO_REPARSE_TAG_MOUNT_POINT (en el módulo stat)
@geindex IO_REPARSE_TAG_APPEXECLINK (en el módulo stat)
@anchor{library/stat stat IO_REPARSE_TAG_SYMLINK}@anchor{282c}
@deffn {Dato} stat.IO_REPARSE_TAG_SYMLINK
@anchor{library/stat stat IO_REPARSE_TAG_MOUNT_POINT}@anchor{282d}
@deffnx {Dato} stat.IO_REPARSE_TAG_MOUNT_POINT
@anchor{library/stat stat IO_REPARSE_TAG_APPEXECLINK}@anchor{282e}
@deffnx {Dato} stat.IO_REPARSE_TAG_APPEXECLINK


Added in version 3.8.

@end deffn

@node filecmp — File and Directory Comparisons,tempfile — Generate temporary files and directories,stat — Interpreting stat results,Acceso a archivos y directorios
@anchor{library/filecmp doc}@anchor{282f}@anchor{library/filecmp filecmp-file-and-directory-comparisons}@anchor{2830}@anchor{library/filecmp module-filecmp}@anchor{5a}
@subsection @code{filecmp} — File and Directory Comparisons


@geindex module; filecmp

`Código fuente:'Lib/filecmp.py@footnote{https://github.com/python/cpython/tree/main/Lib/filecmp.py}


__________________________________________________________________


El módulo @ref{5a,,filecmp} define funciones para comparar ficheros y directorios, con varias compensaciones de tiempo/corrección. Para comparar ficheros, vea también el módulo @ref{38,,difflib}.

El módulo @ref{5a,,filecmp} define las siguientes funciones:

@geindex cmp() (en el módulo filecmp)
@anchor{library/filecmp filecmp cmp}@anchor{1669}
@deffn {Función} filecmp.cmp (f1, f2, shallow=True)

Compara los ficheros llamados `f1' y `f2', retornando @code{True} si son iguales, @code{False} en caso contrario.

Si `shallow' es verdadero y las firmas @ref{548,,os.stat()} (tipo de fichero, tamaño, y tiempo de modificación) de los dos ficheros son idénticas, los ficheros se consideran iguales

De lo contrario, los ficheros son tratados como diferentes si sus tamaños o contenidos difieren.

Note que ningún programa externo es llamado desde esta función, dándole portabilidad y eficiencia.

La función utiliza un caché para comparaciones pasadas y los resultados, con entradas de caché invalidadas si la información de @ref{548,,os.stat()} para el fichero cambia. El caché entero puede ser limpiado utilizando @ref{fbe,,clear_cache()}.
@end deffn

@geindex cmpfiles() (en el módulo filecmp)
@anchor{library/filecmp filecmp cmpfiles}@anchor{15de}
@deffn {Función} filecmp.cmpfiles (dir1, dir2, common, shallow=True)

Compara los ficheros en los dos directorios `dir1' y `dir2' cuyos nombres son dados por `common'.

Retorna tres listas de nombres de fichero: `match', `mismatch', `errors'. `match' contiene la lista de ficheros que coinciden, `mismatch' contiene los nombres de aquellos que no, y `errors' lista los nombres de los ficheros que no deberían ser comparados. Los ficheros son listados en `errors' si no existen en uno de los directorios, el usuario carece de permisos para leerlos o si la comparación no puede hacerse por alguna razón.

El parámetro `shallow' tiene el mismo significado y valor por defecto en cuanto a @ref{1669,,filecmp.cmp()}.

Por ejemplo, @code{cmpfiles('a', 'b', ['c', 'd/e'])} comparará @code{a/c} con @code{b/c} y @code{a/d/e} con @code{b/d/e}. @code{'c'} y @code{'d/e'} estará cada uno en una de las tres listas retornadas.
@end deffn

@geindex clear_cache() (en el módulo filecmp)
@anchor{library/filecmp filecmp clear_cache}@anchor{fbe}
@deffn {Función} filecmp.clear_cache ()

Limpia el caché de filecmp. Esto podría ser útil si un fichero es comparado muy rápido después de que es modificado que está dentro de la resolución mtime del sistema de archivos subyacente.


Added in version 3.4.

@end deffn

@menu
* La clase dircmp:: 

@end menu

@node La clase dircmp,,,filecmp — File and Directory Comparisons
@anchor{library/filecmp dircmp-objects}@anchor{2831}@anchor{library/filecmp the-dircmp-class}@anchor{2832}
@subsubsection La clase @code{dircmp}


@geindex dircmp (clase en filecmp)
@anchor{library/filecmp filecmp dircmp}@anchor{fc0}
@deffn {Clase} filecmp.dircmp (a, b, ignore=None, hide=None, *, shallow=True)

Construct a new directory comparison object, to compare the directories `a'
and `b'.  `ignore' is a list of names to ignore, and defaults to
@ref{fbf,,filecmp.DEFAULT_IGNORES}.  `hide' is a list of names to hide, and
defaults to @code{[os.curdir, os.pardir]}.

The @ref{fc0,,dircmp} class compares files by doing `shallow' comparisons
as described for @ref{1669,,filecmp.cmp()} by default using the `shallow'
parameter.


Distinto en la versión 3.13: Added the `shallow' parameter.


La clase @ref{fc0,,dircmp} provee los siguientes métodos:

@geindex report() (método de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report}@anchor{2833}
@deffn {Método} report ()

Imprime (a @ref{b61,,sys.stdout}) una comparación entre `a' y `b'.
@end deffn

@geindex report_partial_closure() (método de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report_partial_closure}@anchor{2834}
@deffn {Método} report_partial_closure ()

Imprime una comparación entre `a' y `b' y subdirectorios inmediatos comunes.
@end deffn

@geindex report_full_closure() (método de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report_full_closure}@anchor{2835}
@deffn {Método} report_full_closure ()

Imprime una comparación entre `a' y `b' y subdirectorios comunes (recursivamente).
@end deffn

La clase @ref{fc0,,dircmp} ofrece un número de atributos interesantes que pueden ser utilizados para obtener varios bits de información sobre los árboles de directorio que están siendo comparados.

Note that via @ref{57a,,__getattr__()} hooks, all attributes are computed lazily,
so there is no speed penalty if only those attributes which are lightweight
to compute are used.

@geindex left (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left}@anchor{2836}
@deffn {Atributo} left

El directorio `a'.
@end deffn

@geindex right (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right}@anchor{2837}
@deffn {Atributo} right

El directorio `b'.
@end deffn

@geindex left_list (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left_list}@anchor{2838}
@deffn {Atributo} left_list

Ficheros y subdirectorios en `a', filtrados por `hide' e `ignore'.
@end deffn

@geindex right_list (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right_list}@anchor{2839}
@deffn {Atributo} right_list

Ficheros y subdirectorios en `b', filtrados por `hide' e `ignore'.
@end deffn

@geindex common (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common}@anchor{283a}
@deffn {Atributo} common

Ficheros y subdirectorios en `a' y `b'.
@end deffn

@geindex left_only (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left_only}@anchor{283b}
@deffn {Atributo} left_only

Ficheros y subdirectorios sólo en `a'.
@end deffn

@geindex right_only (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right_only}@anchor{283c}
@deffn {Atributo} right_only

Ficheros y subdirectorios sólo en `b'.
@end deffn

@geindex common_dirs (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_dirs}@anchor{283d}
@deffn {Atributo} common_dirs

Subdirectorios en `a' y `b'.
@end deffn

@geindex common_files (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_files}@anchor{283e}
@deffn {Atributo} common_files

Ficheros en `a' y `b'.
@end deffn

@geindex common_funny (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_funny}@anchor{283f}
@deffn {Atributo} common_funny

Nombres en `a' y `b', de forma que el tipo difiera entre los directorios, o los nombres por los que @ref{548,,os.stat()} reporta un error.
@end deffn

@geindex same_files (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp same_files}@anchor{2840}
@deffn {Atributo} same_files

Ficheros que son idénticos en `a' y `b', utilizando el operador de comparación de fichero de la clase.
@end deffn

@geindex diff_files (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp diff_files}@anchor{2841}
@deffn {Atributo} diff_files

Ficheros que están en `a' y `b', cuyos contenidos difieren acorde al operador de comparación del fichero de clase.
@end deffn

@geindex funny_files (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp funny_files}@anchor{2842}
@deffn {Atributo} funny_files

Ficheros que están en `a' y `b', pero no deberían ser comparados.
@end deffn

@geindex subdirs (atributo de filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp subdirs}@anchor{1926}
@deffn {Atributo} subdirs

Un diccionario que asigna nombres en @ref{283d,,common_dirs} a instancias @ref{fc0,,dircmp} (o instancias MyDirCmp si esa instancias es del tipo MyDirCmp, una subclase de @ref{fc0,,dircmp}).


Distinto en la versión 3.10: Anteriormente las entradas siempre eran instancias @ref{fc0,,dircmp}. Ahora son del mismo tipo que `self', si `self' es una subclase de @ref{fc0,,dircmp}.

@end deffn
@end deffn

@geindex DEFAULT_IGNORES (en el módulo filecmp)
@anchor{library/filecmp filecmp DEFAULT_IGNORES}@anchor{fbf}
@deffn {Atributo} filecmp.DEFAULT_IGNORES


Added in version 3.4.


Lista de directorios ignorados por @ref{fc0,,dircmp} por defecto.
@end deffn

Aquí hay un ejemplo simplificado de uso del atributo @code{subdirs} para buscar recursivamente a través de dos directorios para mostrar diferentes ficheros comunes:

@example
>>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
...     for name in dcmp.diff_files:
...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
...               dcmp.right))
...     for sub_dcmp in dcmp.subdirs.values():
...         print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2') 
>>> print_diff_files(dcmp) 
@end example

@node tempfile — Generate temporary files and directories,glob — Unix style pathname pattern expansion,filecmp — File and Directory Comparisons,Acceso a archivos y directorios
@anchor{library/tempfile doc}@anchor{2843}@anchor{library/tempfile module-tempfile}@anchor{e0}@anchor{library/tempfile tempfile-generate-temporary-files-and-directories}@anchor{2844}
@subsection @code{tempfile} — Generate temporary files and directories


@geindex module; tempfile

`Código fuente:' Lib/tempfile.py@footnote{https://github.com/python/cpython/tree/main/Lib/tempfile.py}

@geindex temporary;file name
@geindex temporary;file


__________________________________________________________________


This module creates temporary files and directories.  It works on all
supported platforms. @ref{2845,,TemporaryFile}, @ref{56d,,NamedTemporaryFile},
@ref{12a1,,TemporaryDirectory}, and @ref{734,,SpooledTemporaryFile} are high-level
interfaces which provide automatic cleanup and can be used as
@ref{675,,context managers}. @ref{2846,,mkstemp()} and
@ref{37c,,mkdtemp()} are lower-level functions which require manual cleanup.

Todas las funciones y constructores invocables por el usuario toman argumentos adicionales que permiten el control directo sobre la ubicación y el nombre de los archivos y directorios temporales. Los nombres de archivos utilizados por este módulo incluyen una cadena de caracteres aleatorios que permite que esos archivos se creen de forma segura en directorios temporales compartidos. Para mantener la compatibilidad con versiones anteriores, el orden de argumentos es algo extraño; se recomienda utilizar argumentos nombrados para mayor claridad.

El módulo define los siguientes elementos invocables por el usuario:

@geindex TemporaryFile() (en el módulo tempfile)
@anchor{library/tempfile tempfile TemporaryFile}@anchor{2845}
@deffn {Función} tempfile.TemporaryFile (mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

Retorna un @ref{2586,,file-like object} que se puede usar como área de almacenamiento temporal. El archivo se crea de forma segura, usando las mismas reglas que @ref{2846,,mkstemp()}. Este se destruirá tan pronto como se cierre (incluido un cierre implícito cuando el objeto es recolectado como basura). Bajo Unix, la entrada de directorio para el archivo no se crea en lo absoluto o se elimina inmediatamente después de crear el archivo. Otras plataformas no soportan esto; tu código no debería depender en un archivo temporal creado con esta función teniendo o no un nombre visible en el sistema de archivos.

The resulting object can be used as a @ref{675,,context manager} (see
@ref{2847,,Ejemplos}).  On completion of the context or
destruction of the file object the temporary file will be removed
from the filesystem.

El parámetro `mode' por defecto es @code{'w+b'} para que el archivo creado pueda leerse y escribirse sin cerrarse.  El modo binario se utiliza para que se comporte consistentemente en todas las plataformas sin tener en cuenta los datos que se almacenan. `buffering', `encoding', `errors' y `newline' se interpretan como en @ref{1be,,open()}.

Los parámetros `dir', `prefix' y `suffix' tienen el mismo significado y valores predeterminados de @ref{2846,,mkstemp()}.

El objeto retornado es un objeto de archivo verdadero en las plataformas POSIX. En otras plataformas, es un objeto similar a un archivo cuyo atributo @code{file} es el objeto de archivo verdadero subyacente.

El indicador @ref{ff2,,os.O_TMPFILE} se usa si está disponible y funciona (específico de Linux, requiere el kernel de Linux 3.11 o posterior).

En plataformas que no son ni Posix ni Cygwin, TemporaryFile es un alias de NamedTemporaryFile.

Lanza un @ref{18c3,,evento de auditoria} @code{tempfile.mkstemp} con argumento @code{fullpath}.


Distinto en la versión 3.5: El indicador @ref{ff2,,os.O_TMPFILE} ahora se usa si está disponible.



Distinto en la versión 3.8: Se agregó el parámetro `errors'.

@end deffn

@geindex NamedTemporaryFile() (en el módulo tempfile)
@anchor{library/tempfile tempfile NamedTemporaryFile}@anchor{56d}
@deffn {Función} tempfile.NamedTemporaryFile (mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True, *, errors=None, delete_on_close=True)

Esta función opera exactamente como @ref{2845,,TemporaryFile()}, excepto por las siguientes diferencias:


@itemize *

@item 
Esta función retorna un archivo que tiene garantizado un nombre visible en el sistema de archivos.

@item 
Para administrar el archivo nombrado, amplía los parámetros de @ref{2845,,TemporaryFile()} con los parámetros `delete' y `delete_on_close' que determinan si el archivo nombrado debe eliminarse automáticamente y cómo.
@end itemize

The returned object is always a @ref{2586,,file-like object} whose @code{file}
attribute is the underlying true file object. This file-like object
can be used in a @ref{673,,with} statement, just like a normal file.  The
name of the temporary file can be retrieved from the @code{name} attribute
of the returned file-like object. On Unix, unlike with the
@ref{2845,,TemporaryFile()}, the directory entry does not get unlinked immediately
after the file creation.

Si `delete' es true (el valor predeterminado) y `delete_on_close' es true (el valor predeterminado), el archivo se elimina tan pronto como se cierra. Si `delete' es true y `delete_on_close' es false, el archivo se elimina solo al salir del administrador de contexto, o bien cuando se finaliza el @ref{2586,,file-like object}. La eliminación no siempre está garantizada en este caso (ver @ref{1f60,,object.__del__()}). Si `delete' es false, se omite el valor de `delete_on_close'.

Por lo tanto, para usar el nombre del archivo temporal para volver a abrir el archivo después de cerrarlo, asegúrese de no eliminar el archivo al cerrarlo (establezca el parámetro `delete' en false) o, en caso de que el archivo temporal se cree en una declaración @ref{673,,with}, establezca el parámetro `delete_on_close' en false. Se recomienda este último enfoque, ya que proporciona asistencia en la limpieza automática del archivo temporal al salir del administrador de contexto.

Abrir el archivo temporal de nuevo por su nombre mientras todavía está abierto funciona de la siguiente forma:


@itemize *

@item 
En POSIX el archivo siempre se puede volver a abrir.

@item 
En Windows, asegúrese de que se cumple al menos una de las siguientes condiciones:


@itemize *

@item 
`delete' es falso

@item 
la función de apertura adicional comparte el acceso de eliminación (por ejemplo, llamando @ref{e18,,os.open()} con la opción @code{O_TEMPORARY})

@item 
`delete' es verdadero, pero `delete_on_close' es falso. Tenga en cuenta que, en este caso, las funciones de apertura adicional que no comparten el acceso de eliminación (por ejemplo, creado mediante el tipo integrado @ref{1be,,open()}) deben cerrarse antes de salir del gestor de contexto, sino la llamada @ref{1168,,os.unlink()} al salir del gestor de contexto fallará con un @ref{dc9,,PermissionError}.
@end itemize
@end itemize

En Windows, si `delete_on_close' es falso y el archivo se crea en un directorio para el que el usuario carece de acceso de eliminación, la llamada @ref{1168,,os.unlink()} al salir del gestor de contexto fallará con un @ref{dc9,,PermissionError}. Esto no puede suceder cuando `delete_on_close' es true, porque el acceso de eliminación es solicitado por la función de apertura, que falla inmediatamente si no se concede el acceso solicitado.

En POSIX (solo), un proceso que finaliza abruptamente con SIGKILL no puede eliminar automáticamente ningún NamedTemporaryFiles que se haya creado.

Lanza un @ref{18c3,,evento de auditoria} @code{tempfile.mkstemp} con argumento @code{fullpath}.


Distinto en la versión 3.8: Se agregó el parámetro `errors'.



Distinto en la versión 3.12: Se agregó el parámetro `delete_on_close'.

@end deffn

@geindex SpooledTemporaryFile (clase en tempfile)
@anchor{library/tempfile tempfile SpooledTemporaryFile}@anchor{734}
@deffn {Clase} tempfile.SpooledTemporaryFile (max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

This class operates exactly as @ref{2845,,TemporaryFile()} does, except that
data is spooled in memory until the file size exceeds `max_size', or
until the file’s @ref{2848,,fileno()} method is called, at which point the
contents are written to disk and operation proceeds as with
@ref{2845,,TemporaryFile()}.

@geindex rollover() (método de tempfile.SpooledTemporaryFile)
@anchor{library/tempfile tempfile SpooledTemporaryFile rollover}@anchor{2849}
@deffn {Método} rollover ()

The resulting file has one additional method, @code{rollover()}, which
causes the file to roll over to an on-disk file regardless of its size.
@end deffn

The returned object is a file-like object whose @code{_file} attribute
is either an @ref{f25,,io.BytesIO} or @ref{854,,io.TextIOWrapper} object
(depending on whether binary or text `mode' was specified) or a true file
object, depending on whether @ref{2849,,rollover()} has been called.  This
file-like object can be used in a @ref{673,,with} statement, just like
a normal file.


Distinto en la versión 3.3: the truncate method now accepts a `size' argument.



Distinto en la versión 3.8: Se agregó el parámetro `errors'.



Distinto en la versión 3.11: Implementa completamente las clases base abstractas @ref{735,,io.BufferedIOBase} y @ref{736,,io.TextIOBase} (dependiendo de si se especificó `modo' binario o de texto).

@end deffn

@geindex TemporaryDirectory (clase en tempfile)
@anchor{library/tempfile tempfile TemporaryDirectory}@anchor{12a1}
@deffn {Clase} tempfile.TemporaryDirectory (suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False, *, delete=True)

This class securely creates a temporary directory using the same rules as @ref{37c,,mkdtemp()}.
The resulting object can be used as a @ref{675,,context manager} (see
@ref{2847,,Ejemplos}).  On completion of the context or destruction
of the temporary directory object, the newly created temporary directory
and all its contents are removed from the filesystem.

@geindex name (atributo de tempfile.TemporaryDirectory)
@anchor{library/tempfile tempfile TemporaryDirectory name}@anchor{284a}
@deffn {Atributo} name

The directory name can be retrieved from the @code{name} attribute of the
returned object.  When the returned object is used as a @ref{675,,context manager}, the
@code{name} will be assigned to the target of the @code{as} clause in
the @ref{673,,with} statement, if there is one.
@end deffn

@geindex cleanup() (método de tempfile.TemporaryDirectory)
@anchor{library/tempfile tempfile TemporaryDirectory cleanup}@anchor{284b}
@deffn {Método} cleanup ()

The directory can be explicitly cleaned up by calling the
@code{cleanup()} method. If `ignore_cleanup_errors' is true, any unhandled
exceptions during explicit or implicit cleanup (such as a
@ref{dc9,,PermissionError} removing open files on Windows) will be ignored,
and the remaining removable items deleted on a «best-effort» basis.
Otherwise, errors will be raised in whatever context cleanup occurs
(the @code{cleanup()} call, exiting the context manager, when the object
is garbage-collected or during interpreter shutdown).
@end deffn

El parámetro `delete' se puede utilizar para deshabilitar la limpieza del árbol de directorios al salir del contexto. Aunque puede parecer inusual que un administrador de contexto deshabilite la acción realizada al salir del contexto, puede ser útil durante la depuración o cuando necesita que el comportamiento de limpieza sea condicional en función de otra lógica.

Lanza un @ref{18c3,,evento de auditoria} @code{tempfile.mkdtemp} con argumento @code{fullpath}.


Added in version 3.2.



Distinto en la versión 3.10: Se agregó el parámetro `ignore_cleanup_errors'.



Distinto en la versión 3.12: Se agregó el parámetro `delete'.

@end deffn

@geindex mkstemp() (en el módulo tempfile)
@anchor{library/tempfile tempfile mkstemp}@anchor{2846}
@deffn {Función} tempfile.mkstemp (suffix=None, prefix=None, dir=None, text=False)

Crea un archivo temporal de la manera más segura posible.  No hay condiciones de carrera en la creación del archivo, suponiendo que la plataforma implemente correctamente el indicador @ref{284c,,os.O_EXCL} para @ref{e18,,os.open()}.  El archivo se puede leer y escribir solo mediante el ID del usuario que lo crea.  Aunque la plataforma utilice bits de permiso para indicar si un archivo es ejecutable, nadie puede ejecutar el archivo.  El descriptor de archivo no es heredado por los procesos hijos.

A diferencia de @ref{2845,,TemporaryFile()}, el usuario de @ref{2846,,mkstemp()} es responsable de eliminar el archivo temporal cuando haya terminado con él.

Si `suffix' no es @code{None}, el nombre del archivo terminará con ese sufijo, de lo contrario no habrá sufijo.  @ref{2846,,mkstemp()} no pone un punto entre el nombre del archivo y el sufijo; si necesita uno, póngalo al comienzo del `suffix'.

Si `prefix' no es @code{None}, el nombre del archivo comenzará con ese prefijo; de lo contrario, se usa un prefijo predeterminado.  El valor predeterminado es el valor de retorno de @ref{284d,,gettempprefix()} o @ref{284e,,gettempprefixb()}, según corresponda.

Si `dir' no es @code{None}, el archivo se creará en ese directorio; de lo contrario, se usa un directorio predeterminado. El directorio predeterminado se elige de una lista dependiente de la plataforma, pero el usuario de la aplicación puede controlar la ubicación del directorio configurando las variables de entorno `TMPDIR', `TEMP' o `TMP' .  Por lo tanto, no hay garantía de que el nombre de archivo generado tenga buenas propiedades, como no requerir comillas cuando se pasa a comandos externos a través de @code{os.popen()}.

Si alguno de los argumentos `suffix', `prefix', y `dir' no son @code{None}, estos deben ser del mismo tipo. Si son bytes, el nombre retornado será bytes en lugar de str. Si desea forzar un valor de retorno de bytes con un comportamiento predeterminado, pase @code{suffix=b’’}.

Si se especifica `text' y es verdadero, el archivo se abre en modo texto. De lo contrario, (por defecto) el archivo se abre en modo binario.

@ref{2846,,mkstemp()} retorna una tupla que contiene un controlador de nivel de sistema operativo a un archivo abierto (como sería retornado por @ref{e18,,os.open()}) y la ruta absoluta de ese archivo, en ese orden.

Lanza un @ref{18c3,,evento de auditoria} @code{tempfile.mkstemp} con argumento @code{fullpath}.


Distinto en la versión 3.5: `suffix', `prefix', y `dir' ahora se pueden suministrar en bytes para obtener el valor de retorno en bytes.  Antes de esto, solo str se permitía. `suffix' y `prefix' ahora aceptan y por defecto @code{None} para hacer que se use un valor predeterminado apropiado.



Distinto en la versión 3.6: El parámetro `dir' ahora acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex mkdtemp() (en el módulo tempfile)
@anchor{library/tempfile tempfile mkdtemp}@anchor{37c}
@deffn {Función} tempfile.mkdtemp (suffix=None, prefix=None, dir=None)

Crea un directorio temporal de la manera más segura posible. No hay condiciones de carrera en la creación del directorio.  El directorio se puede leer, escribir y buscar solo por el ID del usuario creador.

El usuario de @ref{37c,,mkdtemp()} es responsable de eliminar el directorio temporal y su contenido cuando haya terminado con él.

Los argumentos `prefix', `suffix', y `dir' son los mismos que para @ref{2846,,mkstemp()}.

@ref{37c,,mkdtemp()} retorna la ruta absoluta del nuevo directorio.

Lanza un @ref{18c3,,evento de auditoria} @code{tempfile.mkdtemp} con argumento @code{fullpath}.


Distinto en la versión 3.5: `suffix', `prefix', y `dir' ahora se pueden suministrar en bytes para obtener el valor de retorno en bytes.  Antes de esto, solo str se permitía. `suffix' y `prefix' ahora aceptan y por defecto @code{None} para hacer que se use un valor predeterminado apropiado.



Distinto en la versión 3.6: El parámetro `dir' ahora acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.12: @ref{37c,,mkdtemp()} no siempre retorna la ruta absoluta del nuevo directorio, incluso si `dir' es relativo.

@end deffn

@geindex gettempdir() (en el módulo tempfile)
@anchor{library/tempfile tempfile gettempdir}@anchor{18e2}
@deffn {Función} tempfile.gettempdir ()

Retorna el nombre del directorio utilizado para archivos temporales. Esto define el valor predeterminado para el argumento `dir' para todas las funciones en este módulo.

Python busca en una lista estándar de directorios para encontrar uno dentro del cual el usuario pueda crear archivos.  La lista es:


@enumerate 

@item 
El directorio nombrado por la variable de entorno 
@geindex TMPDIR
@geindex variables de entorno; TMPDIR
@code{TMPDIR}.

@item 
El directorio nombrado por la variable de entorno 
@geindex TEMP
@geindex variables de entorno; TEMP
@code{TEMP}.

@item 
El directorio nombrado por la variable de entorno 
@geindex TMP
@geindex variables de entorno; TMP
@code{TMP}.

@item 
Una ubicación especifica de la plataforma:


@itemize *

@item 
En Windows, los directorios @code{C:\TEMP}, @code{C:\TMP}, @code{\TEMP}, y @code{\TMP}, en ese orden.

@item 
En todas las otras plataformas, los directorios @code{/tmp}, @code{/var/tmp}, y @code{/usr/tmp}, en ese orden.
@end itemize

@item 
Y como última alternativa, el directorio de trabajo actual.
@end enumerate

El resultado de la búsqueda es cacheada, vea la descripción de @ref{18e1,,tempdir} abajo.


Distinto en la versión 3.10: Siempre retorna str. Anteriormente retornaría cualquier valor @ref{18e1,,tempdir} independientemente del tipo siempre que no fuera @code{None}.

@end deffn

@geindex gettempdirb() (en el módulo tempfile)
@anchor{library/tempfile tempfile gettempdirb}@anchor{18e3}
@deffn {Función} tempfile.gettempdirb ()

Igual a @ref{18e2,,gettempdir()} pero el valor retornado es en bytes.


Added in version 3.5.

@end deffn

@geindex gettempprefix() (en el módulo tempfile)
@anchor{library/tempfile tempfile gettempprefix}@anchor{284d}
@deffn {Función} tempfile.gettempprefix ()

Retorna el prefijo del nombre de archivo utilizado para crear archivos temporales. Este no contiene el componente de directorio.
@end deffn

@geindex gettempprefixb() (en el módulo tempfile)
@anchor{library/tempfile tempfile gettempprefixb}@anchor{284e}
@deffn {Función} tempfile.gettempprefixb ()

Igual que @ref{284d,,gettempprefix()} pero el valor retornado es en bytes.


Added in version 3.5.

@end deffn

El módulo utiliza una variable global para almacenar el nombre del directorio utilizado para los archivos temporales retornados por @ref{18e2,,gettempdir()}.  Se puede configurar directamente para sobrescribir el proceso de selección, pero esto no se recomienda. Todas las funciones en este módulo toman un argumento `dir' que puede usarse para especificar el directorio. Este es el enfoque recomendado que no toma por sorpresa otro código inesperado al cambiar el comportamiento global de la API.

@geindex tempdir (en el módulo tempfile)
@anchor{library/tempfile tempfile tempdir}@anchor{18e1}
@deffn {Dato} tempfile.tempdir

Cuando se establece en un valor distinto de @code{None}, esta variable define el valor predeterminado para el argumento `dir' para las funciones definidas en este módulo, incluyendo su tipo, bytes o str. No puede ser un @ref{3f0,,path-like object}.

Si @code{tempdir} es @code{None} (por defecto) en cualquier llamada a cualquiera de las funciones anteriores excepto @ref{284d,,gettempprefix()} se inicializa siguiendo el algoritmo descrito en @ref{18e2,,gettempdir()}.

@cartouche
@quotation Nota 
Tenga en cuenta que si establece @code{tempdir} en un valor de bytes, hay un efecto secundario desagradable: el tipo de retorno global predeterminado de @ref{2846,,mkstemp()} y @ref{37c,,mkdtemp()} cambia a bytes cuando no se proporcionan argumentos explícitos @code{prefix}, @code{suffix} o @code{dir} de tipo str. Por favor, no escriba código esperando o dependiendo de esto. Este comportamiento incómodo se mantiene por compatibilidad con la implementación histórica.
@end quotation
@end cartouche
@end deffn

@menu
* Ejemplos: Ejemplos<5>. 
* Funciones y variables deprecadas:: 

@end menu

@node Ejemplos<5>,Funciones y variables deprecadas,,tempfile — Generate temporary files and directories
@anchor{library/tempfile examples}@anchor{284f}@anchor{library/tempfile tempfile-examples}@anchor{2847}
@subsubsection Ejemplos


Estos son algunos ejemplos del uso típico del módulo @ref{e0,,tempfile}:

@example
>>> import tempfile

# create a temporary file and write some data to it
>>> fp = tempfile.TemporaryFile()
>>> fp.write(b'Hello world!')
# read data from file
>>> fp.seek(0)
>>> fp.read()
b'Hello world!'
# close the file, it will be removed
>>> fp.close()

# create a temporary file using a context manager
>>> with tempfile.TemporaryFile() as fp:
...     fp.write(b'Hello world!')
...     fp.seek(0)
...     fp.read()
b'Hello world!'
>>>
# file is now closed and removed

# create a temporary file using a context manager
# close the file, use the name to open the file again
>>> with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
...     fp.write(b'Hello world!')
...     fp.close()
... # the file is closed, but not removed
... # open the file again by using its name
...     with open(fp.name, mode='rb') as f:
...         f.read()
b'Hello world!'
>>>
# file is now removed

# create a temporary directory using the context manager
>>> with tempfile.TemporaryDirectory() as tmpdirname:
...     print('created temporary directory', tmpdirname)
>>>
# directory and contents have been removed
@end example

@node Funciones y variables deprecadas,,Ejemplos<5>,tempfile — Generate temporary files and directories
@anchor{library/tempfile deprecated-functions-and-variables}@anchor{2850}@anchor{library/tempfile tempfile-mktemp-deprecated}@anchor{2851}
@subsubsection Funciones y variables deprecadas


Una forma histórica de crear archivos temporales era generar primero un nombre de archivo con la función @ref{1895,,mktemp()} y luego crear un archivo con este nombre. Desafortunadamente, esto no es seguro, porque un proceso diferente puede crear un archivo con este nombre en el tiempo entre la llamada a @ref{1895,,mktemp()} y el intento posterior de crear el archivo mediante el primer proceso. La solución es combinar los dos pasos y crear el archivo de inmediato. Este enfoque es utilizado por @ref{2846,,mkstemp()} y las otras funciones descritas anteriormente.

@geindex mktemp() (en el módulo tempfile)
@anchor{library/tempfile tempfile mktemp}@anchor{1895}
@deffn {Función} tempfile.mktemp (suffix='@w{'}, prefix='tmp', dir=None)


Obsoleto desde la versión 2.3: Utilice @ref{2846,,mkstemp()} en su lugar.


Retorna el nombre de la ruta absoluta de un archivo que no existía en el momento en que se realiza la llamada. Los argumentos `prefix', `suffix' y `dir' son similares a los de @ref{2846,,mkstemp()}, excepto los nombres de archivo de bytes, @code{suffix=None} y @code{prefix=None} no son soportados.

@cartouche
@quotation Advertencia 
El uso de esta función puede introducir un agujero de seguridad en su programa. Para cuando llegues a hacer algo con el nombre de archivo que retorna, alguien más pudo haberse adelantado.  El uso de @ref{1895,,mktemp()} se puede reemplazar fácilmente con @ref{56d,,NamedTemporaryFile()}, pasándole el parámetro @code{delete=False}:

@example
>>> f = NamedTemporaryFile(delete=False)
>>> f.name
'/tmp/tmptjujjt'
>>> f.write(b"Hello World!\n")
13
>>> f.close()
>>> os.unlink(f.name)
>>> os.path.exists(f.name)
False
@end example
@end quotation
@end cartouche
@end deffn

@node glob — Unix style pathname pattern expansion,fnmatch — Unix filename pattern matching,tempfile — Generate temporary files and directories,Acceso a archivos y directorios
@anchor{library/glob doc}@anchor{2852}@anchor{library/glob glob-unix-style-pathname-pattern-expansion}@anchor{2853}@anchor{library/glob module-glob}@anchor{64}
@subsection @code{glob} — Unix style pathname pattern expansion


@geindex module; glob

`Código fuente:' Lib/glob.py@footnote{https://github.com/python/cpython/tree/main/Lib/glob.py}

@geindex filenames;pathname expansion


__________________________________________________________________


@geindex * (asterisk);in glob-style wildcards
@geindex ? (question mark);in glob-style wildcards
@geindex [] (square brackets);in glob-style wildcards
@geindex ! (exclamation);in glob-style wildcards
@geindex - (minus);in glob-style wildcards
@geindex . (dot);in glob-style wildcards

El módulo @ref{64,,glob} encuentra todos los nombres de rutas que se asemejan a un patrón especificado de acuerdo a las reglas que se siguen en una terminal Unix, aunque los resultados se retornan con un orden arbitrario.  No se realiza expansión de virgulilla (`tilde («~») expansion' en inglés) pero @code{*}, @code{?} y caracteres de rango expresados mediante @code{[]} serán emparejados correctamente.  Esto se realiza usando las funciones @ref{1a2,,os.scandir()} y @ref{18a8,,fnmatch.fnmatch()} de forma concertada sin invocar, realmente, a una `subshell'.

Nótese que, los archivos que comienzan con un punto (@code{.}) solo se puede combinar con patrones que también comiencen con un punto, a diferencia de @ref{18a8,,fnmatch.fnmatch()}, o @ref{388,,pathlib.Path.glob()}. (Para la expansión de virgulilla o variable de terminal, use @ref{aa6,,os.path.expanduser()}  y @ref{1419,,os.path.expandvars()}.)

Para una coincidencia literal, envuelve los meta-caracteres en corchetes. Por ejemplo, @code{'[?]'} empareja el caracter @code{'?'}.

The @ref{64,,glob} module defines the following functions:

@geindex glob() (en el módulo glob)
@anchor{library/glob glob glob}@anchor{3ef}
@deffn {Función} glob.glob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

Return a possibly empty list of path names that match `pathname', which must be
a string containing a path specification. `pathname' can be either absolute
(like @code{/usr/src/Python-1.5/Makefile}) or relative (like
@code{../../Tools/*/*.gif}), and can contain shell-style wildcards. Broken
symlinks are included in the results (as in the shell). Whether or not the
results are sorted depends on the file system.  If a file that satisfies
conditions is removed or added during the call of this function, whether
a path name for that file will be included is unspecified.

Si `root_dir' no es @code{None}, debería ser un @ref{3f0,,path-like object} que especifique el directorio raíz para la búsqueda. Tiene el mismo efecto en @ref{64,,glob()} que cambiar el directorio actual antes de llamarlo. Si `pathname' es relativo, el resultado contendrá rutas relativas a `root_dir'.

Esta función puede admitir @ref{115d,,rutas relativas a descriptores de directorio} con el parámetro `dir_fd'.

@geindex **;in glob-style wildcards

Si `recursive' es verdadero, el patrón «@code{**}» coincidirá con cualquier fichero y cero o más directorios, subdirectorios y enlaces simbólicos a directorios.  Si el patrón va seguido de un @ref{70b,,os.sep} o @ref{70c,,os.altsep} los ficheros no coincidirán.

Si `include_hidden' es verdadero, el patrón «@code{**}» coincidirá con los directorios ocultos.

Lanza un @ref{18c3,,evento de auditoría} @code{glob.glob} con los argumentos @code{pathname}, @code{recursive}.

Lanza un @ref{18c3,,auditing event} @code{glob.glob/2} con argumentos @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation Nota 
El uso del patrón «@code{**}» en árboles de directorios grandes podría consumir una cantidad de tiempo excesiva.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
This function may return duplicate path names if `pathname'
contains multiple «@code{**}» patterns and `recursive' is true.
@end quotation
@end cartouche


Distinto en la versión 3.5: Soporte para globs recursivos usando «@code{**}».



Distinto en la versión 3.10: Se agregaron los parámetros `root_dir' y `dir_fd'.



Distinto en la versión 3.11: Agregado el parámetro `include_hidden'.

@end deffn

@geindex iglob() (en el módulo glob)
@anchor{library/glob glob iglob}@anchor{89e}
@deffn {Función} glob.iglob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

Retorna un @ref{313,,iterador} el cual produce los mismos valores que @ref{64,,glob()} sin necesidad de almacenarlos todos de forma simultánea.

Lanza un @ref{18c3,,evento de auditoría} @code{glob.glob} con los argumentos @code{pathname}, @code{recursive}.

Lanza un @ref{18c3,,auditing event} @code{glob.glob/2} con argumentos @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation Nota 
This function may return duplicate path names if `pathname'
contains multiple «@code{**}» patterns and `recursive' is true.
@end quotation
@end cartouche


Distinto en la versión 3.5: Soporte para globs recursivos usando «@code{**}».



Distinto en la versión 3.10: Se agregaron los parámetros `root_dir' y `dir_fd'.



Distinto en la versión 3.11: Agregado el parámetro `include_hidden'.

@end deffn

@geindex escape() (en el módulo glob)
@anchor{library/glob glob escape}@anchor{fc6}
@deffn {Función} glob.escape (pathname)

Escapa todos los caracteres especiales (@code{'?'}, @code{'*'} y @code{'['}). Esto es útil si deseas coincidir una cadena de caracteres literal arbitraria que podría contener caracteres especiales.  Los caracteres especiales en unidades compartidas/UNC no se eluden, e.g. en Windows @code{escape('//?/c:/Quo vadis?.txt')} retorna @code{'//?/c:/Quo vadis[?].txt'}.


Added in version 3.4.

@end deffn

@geindex translate() (en el módulo glob)
@anchor{library/glob glob translate}@anchor{349}
@deffn {Función} glob.translate (pathname, *, recursive=False, include_hidden=False, seps=None)

Convert the given path specification to a regular expression for use with
@ref{129a,,re.match()}. The path specification can contain shell-style wildcards.

For example:

@example
>>> import glob, re
>>>
>>> regex = glob.translate('**/*.txt', recursive=True, include_hidden=True)
>>> regex
'(?s:(?:.+/)?[^/]*\\.txt)\\Z'
>>> reobj = re.compile(regex)
>>> reobj.match('foo/bar/baz.txt')
<re.Match object; span=(0, 15), match='foo/bar/baz.txt'>
@end example

Path separators and segments are meaningful to this function, unlike
@ref{1a4d,,fnmatch.translate()}. By default wildcards do not match path
separators, and @code{*} pattern segments match precisely one path segment.

If `recursive' is true, the pattern segment «@code{**}» will match any number
of path segments.

If `include_hidden' is true, wildcards can match path segments that start
with a dot (@code{.}).

A sequence of path separators may be supplied to the `seps' argument. If
not given, @ref{70b,,os.sep} and @ref{70c,,altsep} (if available) are used.


@subsubheading Ver también


@ref{386,,pathlib.PurePath.full_match()} and @ref{388,,pathlib.Path.glob()}
methods, which call this function to implement pattern matching and
globbing.



Added in version 3.13.

@end deffn

@menu
* Examples:: 

@end menu

@node Examples,,,glob — Unix style pathname pattern expansion
@anchor{library/glob examples}@anchor{2854}
@subsubsection Examples


Consider a directory containing the following files:
@code{1.gif}, @code{2.txt}, @code{card.gif} and a subdirectory @code{sub}
which contains only the file @code{3.txt}.  @ref{64,,glob()} will produce
the following results.  Notice how any leading components of the path are
preserved.

@example
>>> import glob
>>> glob.glob('./[0-9].*')
['./1.gif', './2.txt']
>>> glob.glob('*.gif')
['1.gif', 'card.gif']
>>> glob.glob('?.gif')
['1.gif']
>>> glob.glob('**/*.txt', recursive=True)
['2.txt', 'sub/3.txt']
>>> glob.glob('./**/', recursive=True)
['./', './sub/']
@end example

Si un directorio contiene ficheros que comienzan con @code{.} no coincidirá por defecto. Por ejemplo, considera un directorio que contiene @code{card.gif} y @code{.card.gif}:

@example
>>> import glob
>>> glob.glob('*.gif')
['card.gif']
>>> glob.glob('.c*')
['.card.gif']
@end example


@subsubheading Ver también


The @ref{5c,,fnmatch} module offers shell-style filename (not path) expansion.



@subsubheading Ver también


El módulo @ref{a4,,pathlib} ofrece objetos ruta de alto nivel.


@node fnmatch — Unix filename pattern matching,linecache — Random access to text lines,glob — Unix style pathname pattern expansion,Acceso a archivos y directorios
@anchor{library/fnmatch doc}@anchor{2855}@anchor{library/fnmatch fnmatch-unix-filename-pattern-matching}@anchor{2856}@anchor{library/fnmatch module-fnmatch}@anchor{5c}
@subsection @code{fnmatch} — Unix filename pattern matching


@geindex module; fnmatch

`Código fuente:' Lib/fnmatch.py@footnote{https://github.com/python/cpython/tree/main/Lib/fnmatch.py}

@geindex filenames;wildcard expansion

@geindex module;re


__________________________________________________________________


Este módulo proporciona soporte para comodines de estilo shell de Unix, que `no' son lo mismo que las expresiones regulares (que se documentan en el módulo @ref{b9,,re}). Los caracteres especiales utilizados en los comodines de estilo shell son:

@geindex * (asterisk);in glob-style wildcards
@geindex ? (question mark);in glob-style wildcards
@geindex [] (square brackets);in glob-style wildcards
@geindex ! (exclamation);in glob-style wildcards
@geindex - (minus);in glob-style wildcards


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Patrón

@tab

Significado

@item

@code{*}

@tab

coincide con todo

@item

@code{?}

@tab

coincide con un solo carácter

@item

@code{[seq]}

@tab

coincide con cualquier carácter presente en `seq'

@item

@code{[!seq]}

@tab

coincide con cualquier carácter ausente en `seq'

@end multitable


Para una coincidencia literal, envuelva los meta-caracteres entre paréntesis. Por ejemplo, @code{'[?]'} coincide con el carácter @code{'?'}.

@geindex module;glob

Ten en cuenta que el separador de nombre de archivo (@code{'/'} en Unix) `no' es tratado de forma especial en este módulo. Consulta el módulo @ref{64,,glob} para realizar expansiones de nombre de ruta (@ref{64,,glob} usa @ref{18aa,,filter()} para hacer coincidir con los componentes del nombre de ruta). Del mismo modo, los nombres de archivo que comienzan con un punto tampoco son tratados de forma especial por este módulo y se corresponden con los patrones @code{*} y @code{?}.

Also note that @ref{a81,,functools.lru_cache()} with the `maxsize' of 32768 is used to
cache the compiled regex patterns in the following functions: @ref{5c,,fnmatch()},
@ref{18a9,,fnmatchcase()}, @ref{18aa,,filter()}.

@geindex fnmatch() (en el módulo fnmatch)
@anchor{library/fnmatch fnmatch fnmatch}@anchor{18a8}
@deffn {Función} fnmatch.fnmatch (name, pat)

Test whether the filename string `name' matches the pattern string `pat',
returning @code{True} or @code{False}.  Both parameters are case-normalized
using @ref{27cc,,os.path.normcase()}. @ref{18a9,,fnmatchcase()} can be used to perform a
case-sensitive comparison, regardless of whether that’s standard for the
operating system.

Este ejemplo imprimirá todos los nombres de archivo en el directorio actual con la extensión @code{.txt}:

@example
import fnmatch
import os

for file in os.listdir('.'):
    if fnmatch.fnmatch(file, '*.txt'):
        print(file)
@end example
@end deffn

@geindex fnmatchcase() (en el módulo fnmatch)
@anchor{library/fnmatch fnmatch fnmatchcase}@anchor{18a9}
@deffn {Función} fnmatch.fnmatchcase (name, pat)

Test whether the filename string `name' matches the pattern string `pat',
returning @code{True} or @code{False};
the comparison is case-sensitive and does not apply @ref{27cc,,os.path.normcase()}.
@end deffn

@geindex filter() (en el módulo fnmatch)
@anchor{library/fnmatch fnmatch filter}@anchor{18aa}
@deffn {Función} fnmatch.filter (names, pat)

Construct a list from those elements of the @ref{1294,,iterable} `names'
that match pattern `pat'.
It is the same as @code{[n for n in names if fnmatch(n, pat)]},
but implemented more efficiently.
@end deffn

@geindex translate() (en el módulo fnmatch)
@anchor{library/fnmatch fnmatch translate}@anchor{1a4d}
@deffn {Función} fnmatch.translate (pat)

Return the shell-style pattern `pat' converted to a regular expression for
using with @ref{129a,,re.match()}.

Ejemplo:

@example
>>> import fnmatch, re
>>>
>>> regex = fnmatch.translate('*.txt')
>>> regex
'(?s:.*\\.txt)\\Z'
>>> reobj = re.compile(regex)
>>> reobj.match('foobar.txt')
<re.Match object; span=(0, 10), match='foobar.txt'>
@end example
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{64,,glob}

Expansión de ruta estilo shell en Unix.
@end table


@node linecache — Random access to text lines,shutil — High-level file operations,fnmatch — Unix filename pattern matching,Acceso a archivos y directorios
@anchor{library/linecache doc}@anchor{2857}@anchor{library/linecache linecache-random-access-to-text-lines}@anchor{2858}@anchor{library/linecache module-linecache}@anchor{85}
@subsection @code{linecache} — Random access to text lines


@geindex module; linecache

`Código fuente:' Lib/linecache.py@footnote{https://github.com/python/cpython/tree/main/Lib/linecache.py}


__________________________________________________________________


El módulo @ref{85,,linecache} permite obtener cualquier línea de un archivo fuente Python, mientras se intenta optimizar internamente, usando una caché, el caso común en el que se leen muchas líneas de un solo archivo. Esto es utilizado por el módulo @ref{fe,,traceback} para recuperar líneas de código fuente para incluirlas en el seguimiento de pila formateado.

La función @ref{2859,,tokenize.open()} se utiliza para abrir archivos. Esta función usa @ref{285a,,tokenize.detect_encoding()} para obtener la codificación del archivo; en la ausencia de un token de codificación, la codificación del archivo es por defecto UTF-8.

El módulo @ref{85,,linecache} define las siguientes funciones:

@geindex getline() (en el módulo linecache)
@anchor{library/linecache linecache getline}@anchor{ea8}
@deffn {Función} linecache.getline (filename, lineno, module_globals=None)

Obtiene la línea `lineno' del archivo llamado `filename'. Esta función nunca lanzará una excepción — retornará @code{'@w{'}} en los errores (el carácter de la nueva línea de terminación se incluirá para las líneas que se encuentren).

@geindex module;search;path

Si un archivo llamado `filename' no se encuentra, la función primero verifica un @code{__loader__} en `module_globals' 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. Si existe tal cargador y define un método @code{get_source}, entonces eso determina las líneas de origen (si @code{get_source()} retorna @code{None}, entonces se retorna @code{'@w{'}}). Finalmente, si `filename' es un nombre de fichero relativo, se busca en relación a las entradas en la ruta de búsqueda del módulo, @code{sys.path}.
@end deffn

@geindex clearcache() (en el módulo linecache)
@anchor{library/linecache linecache clearcache}@anchor{285b}
@deffn {Función} linecache.clearcache ()

Borra el caché. Use esta función si ya no necesita las líneas de archivos leídos previamente usando @ref{ea8,,getline()}.
@end deffn

@geindex checkcache() (en el módulo linecache)
@anchor{library/linecache linecache checkcache}@anchor{285c}
@deffn {Función} linecache.checkcache (filename=None)

Comprueba la validez de la caché. Use esta función si los archivos de la caché pueden haber cambiado en disco y necesita la versión actualizada. Si se omite `filename', comprobará todas las entradas en la caché.
@end deffn

@geindex lazycache() (en el módulo linecache)
@anchor{library/linecache linecache lazycache}@anchor{ea7}
@deffn {Función} linecache.lazycache (filename, module_globals)

Captura suficientes detalles sobre un módulo no basado en archivos para permitir obtener sus líneas más tarde a través de @ref{ea8,,getline()} incluso si `module_globals' es @code{None} en la llamada posterior. Esto evita hacer E/S hasta que una línea es realmente necesaria, sin tener que llevar los módulo globales indefinidamente.


Added in version 3.5.

@end deffn

Ejemplo:

@example
>>> import linecache
>>> linecache.getline(linecache.__file__, 8)
'import sys\n'
@end example

@node shutil — High-level file operations,,linecache — Random access to text lines,Acceso a archivos y directorios
@anchor{library/shutil doc}@anchor{285d}@anchor{library/shutil module-shutil}@anchor{c5}@anchor{library/shutil shutil-high-level-file-operations}@anchor{285e}
@subsection @code{shutil} — High-level file operations


@geindex module; shutil

@c partly based on the docstrings

Código fuente: Lib/shutil.py@footnote{https://github.com/python/cpython/tree/main/Lib/shutil.py}

@geindex file;copying
@geindex copying files


__________________________________________________________________


El módulo @ref{c5,,shutil} ofrece varias operaciones de alto nivel en archivos y colecciones de archivos. En particular, provee funciones que dan soporte a la copia y remoción de archivos. Para operaciones en archivos individuales, véase también el módulo @ref{a1,,os}.

@cartouche
@quotation Advertencia 
Incluso las funciones de copia de archivos de nivel superior (@ref{aeb,,shutil.copy()}, @ref{aec,,shutil.copy2()}) no pueden copiar todos los metadatos del archivo.

En las plataformas POSIX, esto significa que tanto el propietario como el grupo del archivo se pierden, al igual que las ACLs (`access control lists' o lista de control de acceso). En Mac OS, la bifurcación (`fork') de recursos y de otros metadatos no se utilizan. Esto quiere decir que los recursos se perderán y que el tipo de archivo y los códigos de creador no serán correctos. En Windows, los propietarios de archivos, las ACLs y secuencias de datos alternativas no se copian.
@end quotation
@end cartouche

@menu
* Operaciones de directorios y archivos:: 
* Operaciones de archivado:: 
* Consulta el tamaño de la terminal de salida:: 

@end menu

@node Operaciones de directorios y archivos,Operaciones de archivado,,shutil — High-level file operations
@anchor{library/shutil directory-and-files-operations}@anchor{285f}@anchor{library/shutil file-operations}@anchor{2860}
@subsubsection Operaciones de directorios y archivos


@geindex copyfileobj() (en el módulo shutil)
@anchor{library/shutil shutil copyfileobj}@anchor{aee}
@deffn {Función} shutil.copyfileobj (fsrc, fdst[, length])

Copy the contents of the @ref{1230,,file-like object} `fsrc' to the file-like object `fdst'.
The integer `length', if given, is the buffer size. In particular, a negative
`length' value means to copy the data without looping over the source data in
chunks; by default the data is read in chunks to avoid uncontrolled memory
consumption. Note that if the current file position of the `fsrc' object is not
0, only the contents from the current file position to the end of the file will
be copied.
@end deffn

@geindex copyfile() (en el módulo shutil)
@anchor{library/shutil shutil copyfile}@anchor{aea}
@deffn {Función} shutil.copyfile (src, dst, *, follow_symlinks=True)

Copy the contents (no metadata) of the file named `src' to a file named
`dst' and return `dst' in the most efficient way possible.
`src' and `dst' are @ref{3f0,,path-like objects} or path names given as strings.

`dst' debe ser el nombre completo del archivo destino; véase @ref{aeb,,shutil.copy()} para una copia que acepta una ruta de directorio destino. Si `src' y `dst' refieren al mismo archivo, se lanza @ref{101c,,SameFileError}.

El local de destino debe tener permisos de escritura; de lo contrario, se genera una excepción @ref{4d5,,OSError}. Si `dst' ya existe, se reemplazará. Los archivos especiales, como los dispositivos de caracteres o de bloques y `pipes', no se pueden copiar con esta función.

Si `follow_symlinks' es falso y `src' es un enlace simbólico, un enlace simbólico nuevo se creará en lugar de copiar el archivo al que `src' apunta.

Se genera un @ref{18c3,,evento de auditoría} @code{shutil.copyfile} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Solía generarse @ref{10ce,,IOError} en lugar de @ref{4d5,,OSError}. Se añadió el argumento `follow_symlinks'. Ahora retorna `dst'.



Distinto en la versión 3.4: Genera @ref{101c,,SameFileError} en lugar de @ref{101b,,Error}. Dado que la primera es una subclase de la segunda, el cambio es compatible con versiones anteriores.



Distinto en la versión 3.8: Las llamadas a sistema de copia rápida específicas de la plataforma se pueden usar internamente para copiar el archivo de manera más eficiente. Véase la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}.

@end deffn

@geindex SameFileError
@anchor{library/shutil shutil SameFileError}@anchor{101c}
@deffn {Excepción} shutil.SameFileError

Esta excepción se genera si el origen y destino en @ref{aea,,copyfile()} son el mismo archivo.


Added in version 3.4.

@end deffn

@geindex copymode() (en el módulo shutil)
@anchor{library/shutil shutil copymode}@anchor{16b4}
@deffn {Función} shutil.copymode (src, dst, *, follow_symlinks=True)

Copy the permission bits from `src' to `dst'.  The file contents, owner, and
group are unaffected.  `src' and `dst' are @ref{3f0,,path-like objects} or path names
given as strings.
If `follow_symlinks' is false, and both `src' and `dst' are symbolic links,
@ref{16b4,,copymode()} will attempt to modify the mode of `dst' itself (rather
than the file it points to).  This functionality is not available on every
platform; please see @ref{11a0,,copystat()} for more information.  If
@ref{16b4,,copymode()} cannot modify symbolic links on the local platform, and it
is asked to do so, it will do nothing and return.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.copymode} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Se añadió el argumento `follow_symlinks'.

@end deffn

@geindex copystat() (en el módulo shutil)
@anchor{library/shutil shutil copystat}@anchor{11a0}
@deffn {Función} shutil.copystat (src, dst, *, follow_symlinks=True)

Copy the permission bits, last access time, last modification time, and
flags from `src' to `dst'.  On Linux, @ref{11a0,,copystat()} also copies the
«extended attributes» where possible.  The file contents, owner, and
group are unaffected.  `src' and `dst' are @ref{3f0,,path-like objects} or path
names given as strings.

Si `follow_symlinks' es falso, y `src' y `dst' hacen referencia los enlaces simbólicos, @ref{11a0,,copystat()} funcionará con los enlaces simbólicos en lugar de en los archivos a los que estos se refieren: leer la información del enlace simbólico `src' y escribirla en el enlace simbólico `dst'.

@cartouche
@quotation Nota 
No todas las plataformas proporcionan la capacidad de examinar y modificar enlaces simbólicos. Python puede indicarte qué funcionalidad está disponible localmente.


@itemize *

@item 
Si @code{os.chmod in os.supports_follow_symlinks} es @code{True}, @ref{11a0,,copystat()} puede modificar los bits de permiso de un enlace simbólico.

@item 
Si @code{os.utime in os.supports_follow_symlinks} es @code{True}, @ref{11a0,,copystat()} puede modificar el último acceso y las veces que un enlace simbólico fue modificado.

@item 
Si @code{os.chflags in os.supports_follow_symlinks} es @code{True}, @ref{11a0,,copystat()} puede modificar las flags de un enlace simbólico. (@code{os.chflags} no está disponible en todas las plataformas.)
@end itemize

En plataformas donde parte o toda esta funcionalidad no está disponible, cuando se le pida modificar un enlace simbólico, @ref{11a0,,copystat()} copiará todo lo que pueda. @ref{11a0,,copystat()} nunca retorna un error.

Véase @ref{2861,,os.supports_follow_symlinks} para más información.
@end quotation
@end cartouche

Genera un @ref{18c3,,evento de auditoría} @code{shutil.copystat} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Se ha añadido el argumento `follow_symlinks' y el soporte para atributos extendidos de Linux.

@end deffn

@geindex copy() (en el módulo shutil)
@anchor{library/shutil shutil copy}@anchor{aeb}
@deffn {Función} shutil.copy (src, dst, *, follow_symlinks=True)

Copia el archivo `src' al archivo o directorio `dst'. `src' y `dst' deberían ser @ref{3f0,,objetos tipo ruta} o cadenas de caracteres (`strings'). Si `dst' especifica un directorio, el archivo será copiado en `dst' usando el nombre de archivo base de `src'. Si `dst' especifica un archivo que existe, será reemplazado. Retorna la ruta del archivo recién creado.

Si `follow_symlinks' es falso, y `src' es un enlace simbólico, `dst' se creará como enlace simbólico. Si `follow_symlinks' es verdadero y `src' es un enlace simbólico, `dst' será una copia del archivo al que `src' hace referencia.

@ref{aeb,,copy()} copia los datos del archivo y el modo de permiso del archivo (véase @ref{378,,os.chmod()}). Otros metadatos, como los tiempos de creación y modificación de archivos, no se preservan. Para preservar todos los metadatos del archivo, usa @ref{aec,,copy2()} en su lugar.

Se genera un @ref{18c3,,evento de auditoría} @code{shutil.copyfile} con argumentos @code{src}, @code{dst}.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.copymode} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Se ha añadido el argumento `follow_symlinks'. Ahora retorna la ruta de acceso al archivo recién creado.



Distinto en la versión 3.8: Las llamadas a sistema de copia rápida específicas de la plataforma se pueden usar internamente para copiar el archivo de manera más eficiente. Véase la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}.

@end deffn

@geindex copy2() (en el módulo shutil)
@anchor{library/shutil shutil copy2}@anchor{aec}
@deffn {Función} shutil.copy2 (src, dst, *, follow_symlinks=True)

Idéntico a @ref{aeb,,copy()} , excepto que @ref{aec,,copy2()} también intenta conservar los metadatos del archivo.

Cuando `follow_symlinks' es falso, y `src' es un enlace simbólico, @ref{aec,,copy2()} intenta copiar todos los metadatos del enlace simbólico `src' en el enlace simbólico `dst' recién creado. Sin embargo, esta funcionalidad no está disponible en todas las plataformas. En las plataformas donde parte o toda esta funcionalidad no está disponible, @ref{aec,,copy2()} conservará todos los metadatos que pueda; @ref{aec,,copy2()} nunca genera una excepción porque no puede conservar los metadatos del archivo.

@ref{aec,,copy2()} usa @ref{11a0,,copystat()} para copiar todos los metadatos del archivo. Véase @ref{11a0,,copystat()} para más información sobre la compatibilidad con la plataforma para modificar los metadatos del enlace simbólico.

Se genera un @ref{18c3,,evento de auditoría} @code{shutil.copyfile} con argumentos @code{src}, @code{dst}.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.copystat} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Añadido el argumento `follow_symlinks', intenta copiar también los atributos del sistema de archivos extendidos (actualmente solo en Linux). Ahora retorna la ruta de acceso al archivo recién creado.



Distinto en la versión 3.8: Las llamadas a sistema de copia rápida específicas de la plataforma se pueden usar internamente para copiar el archivo de manera más eficiente. Véase la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}.

@end deffn

@geindex ignore_patterns() (en el módulo shutil)
@anchor{library/shutil shutil ignore_patterns}@anchor{2862}
@deffn {Función} shutil.ignore_patterns (*patterns)

Esta función de fábrica crea una función que puede ser usada como un invocable para el argumento `ignore' de @ref{abb,,copytree()}, ignorando los archivos y directorios que coinciden con uno de los patrones `patterns' de estilo glob provistos. Véase el ejemplo siguiente.
@end deffn

@geindex copytree() (en el módulo shutil)
@anchor{library/shutil shutil copytree}@anchor{abb}
@deffn {Función} shutil.copytree (src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)

Copia recursivamente un directorio completo que inicia en `src' hasta un directorio llamado `dst' y devuelve el directorio destino. Todos los directorios intermedios necesarios para contener `dst' serán creados por default.

Los permisos y los tiempos de directorios son copiados con @ref{11a0,,copystat()}; los archivos individuales son copiados usando @ref{aec,,copy2()}.

Si `symlinks' es verdadero, los enlaces simbólicos en el árbol de origen son representados como enlaces simbólicos en el árbol nuevo y los metadatos de los enlaces originales serán copiados mientras la plataforma lo permita; si es falso o se omite, los contenidos y los metadatos de los archivos vinculados se copiarán en el árbol nuevo.

When `symlinks' is false, if the file pointed to by the symlink doesn’t
exist, an exception will be added in the list of errors raised in
an @ref{101b,,Error} exception at the end of the copy process.
You can set the optional `ignore_dangling_symlinks' flag to true if you
want to silence this exception. Notice that this option has no effect
on platforms that don’t support @ref{1167,,os.symlink()}.

Si se proporciona `ignore', debe ser un invocable que recibirá como argumentos el directorio visitado por @ref{abb,,copytree()} y una lista de sus contenidos, tal como los retorna @ref{116c,,os.listdir()}. Ya que @ref{abb,,copytree()} se invoca recursivamente, el invocable `ignore' se llamará una vez por cada directorio que se copia. El invocable debe retornar una secuencia de directorio y de nombres de archivo en relación con el directorio actual (es decir, un subconjunto de los elementos en su segundo argumento); estos nombres serán ignorados en el proceso de copia. @ref{2862,,ignore_patterns()} se pueden usar para crear un invocable que ignora los nombres basados en patrones de estilo gob.

Si ocurren excepciones, se genera, un @ref{101b,,Error} con una lista de razones.

Si `copy_function' está dado, debe ser un invocable que se usará para copiar cada archivo. Se le invocará con la ruta de origen y la ruta de destino como argumentos. Por defecto, se usa @ref{aec,,copy2()}, pero se puede usar cualquier función que admita la misma (como @ref{aeb,,copy()}).

Si `dirs_exist_ok' es falso (el default) y `dst' existe, la excepción @ref{109c,,FileExistsError} es lanzada. Si `dirs_exist_ok' es verdadero, la operación de copiado continuara si encuentra directorios existentes, los archivos dentro del árbol de `dst' serán sobreescritos por los archivos correspondientes del árbol `src'.

Se genera un @ref{18c3,,evento de auditoría} @code{shutil.copytree} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.2: Se añadió el argumento `copy_function' para poder proporcionar una función de copia personalizada. Se añadió el argumento `ignore_dangling_symlinks' para silenciar los errores de enlaces colgantes cuando `symlinks' es falso.



Distinto en la versión 3.3: Copia los metadatos cuando `symlinks' es falso. Ahora retorna `dst'.



Distinto en la versión 3.8: Las llamadas a sistema de copia rápida específicas de la plataforma se pueden usar internamente para copiar el archivo de manera más eficiente. Véase la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}.



Distinto en la versión 3.8: Added the `dirs_exist_ok' parameter.

@end deffn

@geindex rmtree() (en el módulo shutil)
@anchor{library/shutil shutil rmtree}@anchor{1f9}
@deffn {Función} shutil.rmtree (path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None)

@geindex directory;deleting

Delete an entire directory tree; `path' must point to a directory (but not a
symbolic link to a directory).  If `ignore_errors' is true, errors resulting
from failed removals will be ignored; if false or omitted, such errors are
handled by calling a handler specified by `onexc' or `onerror' or, if both
are omitted, exceptions are propagated to the caller.

Esta función puede soportar @ref{115d,,rutas relativas a descriptores de directorio}.

@cartouche
@quotation Nota 
En plataformas que admiten las funciones basadas en descriptores de archivo necesarias, una versión resistente de @ref{1f9,,rmtree()} al ataque de enlace simbólico se usa por defecto. En otras plataformas, la implementación @ref{1f9,,rmtree()} es susceptible a un ataque de enlace simbólico; dados el tiempo y las circunstancias adecuados, los atacantes pueden manipular los enlaces simbólicos en el sistema de archivos para eliminar archivos a los que no podrían acceder de otra manera. Las aplicaciones pueden usar el atributo de función @ref{2863,,rmtree.avoids_symlink_attacks} para determinar qué caso aplica.
@end quotation
@end cartouche

If `onexc' is provided, it must be a callable that accepts three parameters:
`function', `path', and `excinfo'.

The first parameter, `function', is the function which raised the exception;
it depends on the platform and implementation.  The second parameter,
`path', will be the path name passed to `function'.  The third parameter,
`excinfo', is the exception that was raised. Exceptions raised by `onexc'
will not be caught.

The deprecated `onerror' is similar to `onexc', except that the third
parameter it receives is the tuple returned from @ref{72b,,sys.exc_info()}.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.rmtree} con argumentos @code{path}, @code{dir_fd}.


Distinto en la versión 3.3: Se añadió una versión resistente a los ataques de enlaces simbólicos que se usan automáticamente si la plataforma admite funciones pasadas en descriptores de archivo.



Distinto en la versión 3.8: En Windows, ya no eliminará los contenidos de un cruce de directorios antes de quitar el cruce.



Distinto en la versión 3.11: Added the `dir_fd' parameter.



Distinto en la versión 3.12: Added the `onexc' parameter, deprecated `onerror'.



Distinto en la versión 3.13: @code{rmtree()} now ignores @ref{f46,,FileNotFoundError} exceptions for all
but the top-level path.
Exceptions other than @ref{4d5,,OSError} and subclasses of @code{OSError}
are now always propagated to the caller.


@geindex avoids_symlink_attacks (atributo de shutil.rmtree)
@anchor{library/shutil shutil rmtree avoids_symlink_attacks}@anchor{2863}
@deffn {Atributo} rmtree.avoids_symlink_attacks

Indica si la plataforma actual y la implementación proporciona una versión de @ref{1f9,,rmtree()} resistente al ataque de enlace simbólico. Actualmente, esto solo sucede para plataformas que admitan funciones de acceso a directorios basadas en descriptores de archivo.


Added in version 3.3.

@end deffn
@end deffn

@geindex move() (en el módulo shutil)
@anchor{library/shutil shutil move}@anchor{aed}
@deffn {Función} shutil.move (src, dst, copy_function=copy2)

Recursively move a file or directory (`src') to another location and return
the destination.

If `dst' is an existing directory or a symlink to a directory, then `src'
is moved inside that directory. The destination path in that directory must
not already exist.

If `dst' already exists but is not a directory, it may be overwritten
depending on @ref{1164,,os.rename()} semantics.

If the destination is on the current filesystem, then @ref{1164,,os.rename()} is
used. Otherwise, `src' is copied to the destination using `copy_function'
and then removed.  In case of symlinks, a new symlink pointing to the target
of `src' will be created as the destination and `src' will be removed.

If `copy_function' is given, it must be a callable that takes two arguments,
`src' and the destination, and will be used to copy `src' to the destination
if @ref{1164,,os.rename()} cannot be used.  If the source is a directory,
@ref{abb,,copytree()} is called, passing it the `copy_function'. The
default `copy_function' is @ref{aec,,copy2()}.  Using @ref{aeb,,copy()} as the
`copy_function' allows the move to succeed when it is not possible to also
copy the metadata, at the expense of not copying any of the metadata.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.move} con argumentos @code{src}, @code{dst}.


Distinto en la versión 3.3: Se añadió el manejo explícito de enlaces simbólicos para sistemas de archivos extranjeros, de manera que se adapta al comportamiento del @code{mv} del GNU. Ahora retorna `dst'.



Distinto en la versión 3.5: Se agregó el argumento de keyword `copy_function'.



Distinto en la versión 3.8: Las llamadas a sistema de copia rápida específicas de la plataforma se pueden usar internamente para copiar el archivo de manera más eficiente. Véase la sección @ref{aef,,Operaciones de copia eficientes dependientes de la plataforma}.



Distinto en la versión 3.9: Acepta un @ref{3f0,,objeto tipo ruta} como `src' y `dst'.

@end deffn

@geindex disk_usage() (en el módulo shutil)
@anchor{library/shutil shutil disk_usage}@anchor{119f}
@deffn {Función} shutil.disk_usage (path)

Retorna las estadísticas de uso de disco sobre la ruta de acceso dada como un @ref{6ef,,named tuple} con los atributos `total', `used' y `free', que son las cantidades del espacio total, el usado y el libre, en bytes. `path' puede ser un archivo o un directorio.

@cartouche
@quotation Nota 
On Unix filesystems, `path' must point to a path within a `mounted'
filesystem partition. On those platforms, CPython doesn’t attempt to
retrieve disk usage information from non-mounted filesystems.
@end quotation
@end cartouche


Added in version 3.3.



Distinto en la versión 3.8: En Windows, `path' ahora puede ser un archivo o un directorio.


@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex chown() (en el módulo shutil)
@anchor{library/shutil shutil chown}@anchor{399}
@deffn {Función} shutil.chown (path, user=None, group=None, *, dir_fd=None, follow_symlinks=True)

Cambia el propietario `user' y/o `group' de la `ruta' dada.

`user' puede ser un nombre usuario de sistema o un UID (identificador de usuario); lo mismo aplica a `group'. Se requiere al menos un argumento.

Véase también @ref{1161,,os.chown()}, la función subyacente.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.chown} con argumentos @code{path}, @code{user}, @code{group}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.



Distinto en la versión 3.13: Added `dir_fd' and `follow_symlinks' parameters.

@end deffn

@geindex which() (en el módulo shutil)
@anchor{library/shutil shutil which}@anchor{55b}
@deffn {Función} shutil.which (cmd, mode=os.F_OK | os.X_OK, path=None)

Retorna la ruta de acceso a un ejecutable que se ejecutaría si el `cmd' dado se invoca. Si no se invoca a `cmd', retorna @code{None}.

`mode' is a permission mask passed to @ref{115f,,os.access()}, by default
determining if the file exists and is executable.

`path' is a «@code{PATH} string» specifying the directories to look in,
delimited by @ref{1d4a,,os.pathsep}. When no `path' is specified, the
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} environment variable is read from @ref{196,,os.environ},
falling back to @ref{1a0a,,os.defpath} if it is not set.

On Windows, the current directory is prepended to the `path' if `mode' does
not include @code{os.X_OK}. When the `mode' does include @code{os.X_OK}, the
Windows API @code{NeedCurrentDirectoryForExePathW} will be consulted to
determine if the current directory should be prepended to `path'. To avoid
consulting the current working directory for executables: set the environment
variable @code{NoDefaultCurrentDirectoryInExePath}.

Also on Windows, the 
@geindex PATHEXT
@geindex variables de entorno; PATHEXT
@code{PATHEXT} environment variable is used to
resolve commands that may not already include an extension. For example,
if you call @code{shutil.which("python")}, @ref{55b,,which()} will search @code{PATHEXT}
to know that it should look for @code{python.exe} within the `path'
directories. For example, on Windows:

@example
>>> shutil.which("python")
'C:\\Python33\\python.EXE'
@end example

This is also applied when `cmd' is a path that contains a directory
component:

@example
>> shutil.which("C:\\Python33\\python")
'C:\\Python33\\python.EXE'
@end example


Added in version 3.3.



Distinto en la versión 3.8: Ahora se acepta el tipo @ref{325,,bytes}. Si el tipo `cmd' es @ref{325,,bytes}, el tipo resultante también es @ref{325,,bytes}.



Distinto en la versión 3.12: On Windows, the current directory is no longer prepended to the search
path if `mode' includes @code{os.X_OK} and WinAPI
@code{NeedCurrentDirectoryForExePathW(cmd)} is false, else the current
directory is prepended even if it is already in the search path;
@code{PATHEXT} is used now even when `cmd' includes a directory component
or ends with an extension that is in @code{PATHEXT}; and filenames that
have no extension can now be found.



Distinto en la versión 3.12.1: On Windows, if `mode' includes @code{os.X_OK}, executables with an
extension in @code{PATHEXT} will be preferred over executables without a
matching extension.
This brings behavior closer to that of Python 3.11.

@end deffn

@geindex Error
@anchor{library/shutil shutil Error}@anchor{101b}
@deffn {Excepción} shutil.Error

Esta excepción recopila las excepciones que se generan durante una operación de varios archivos. Para @ref{abb,,copytree()}, el argumento de excepción es una lista de 3 tuplas (`scrname', `dstname', `exception').
@end deffn

@menu
* Operaciones de copia eficientes dependientes de la plataforma:: 
* ejemplo de copytree:: 
* ejemplo de rmtree:: 

@end menu

@node Operaciones de copia eficientes dependientes de la plataforma,ejemplo de copytree,,Operaciones de directorios y archivos
@anchor{library/shutil platform-dependent-efficient-copy-operations}@anchor{2864}@anchor{library/shutil shutil-platform-dependent-efficient-copy-operations}@anchor{aef}
@subsubsection Operaciones de copia eficientes dependientes de la plataforma


A partir de Python 3.8, todas las funciones que incluyen una copia de archivo (@ref{aea,,copyfile()}, @ref{26,,copy()}, @ref{aec,,copy2()}, @ref{abb,,copytree()}, y @ref{aed,,move()}) puede usar llamadas a sistema de «copia rápida» específicas a cada plataforma para poder copiar el archivo de forma más eficiente (véase bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}). «copia rápida» significa que la operación de copia ocurre dentro del núcleo, evitando el uso de búferes en espacio de usuario en Python como en «@code{outfd.write(infd.read())}».

En macOS, se usa fcopyfile@footnote{http://www.manpagez.com/man/3/copyfile/} para copiar el contenido del archivo (pero no los metadatos).

On Linux and Solaris @ref{b9a,,os.sendfile()} is used.

En Windows, @ref{aea,,shutil.copyfile()} usa un tamaño de búfer predeterminado más grande (1 MiB en lugar de 64 KiB) y se usa una variante de @ref{aee,,shutil.copyfileobj()} basada en @ref{156,,memoryview()}.

Si ocurre un error en la operación de copia rápida y no se ha escrito ningún dato en el archivo de destino, entonces shutil recurrirá silenciosamente a usar la función @ref{aee,,copyfileobj()} menos eficiente internamente.


Distinto en la versión 3.8.



Distinto en la versión 3.14: Solaris now uses @ref{b9a,,os.sendfile()}.


@node ejemplo de copytree,ejemplo de rmtree,Operaciones de copia eficientes dependientes de la plataforma,Operaciones de directorios y archivos
@anchor{library/shutil copytree-example}@anchor{2865}@anchor{library/shutil shutil-copytree-example}@anchor{2866}
@subsubsection ejemplo de `copytree'


Un ejemplo que usa el auxiliar @ref{2862,,ignore_patterns()}:

@example
from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))
@end example

Esto copiará todo excepto archivos @code{.pyc} y archivos o directorios cuyo nombre comience con @code{tmp}.

Otro ejemplo que usa el argumento `ignore' para agregar una llamada a iniciar sesión:

@example
from shutil import copytree
import logging

def _logpath(path, names):
    logging.info('Working in %s', path)
    return []   # nothing will be ignored

copytree(source, destination, ignore=_logpath)
@end example

@node ejemplo de rmtree,,ejemplo de copytree,Operaciones de directorios y archivos
@anchor{library/shutil rmtree-example}@anchor{2867}@anchor{library/shutil shutil-rmtree-example}@anchor{2868}
@subsubsection ejemplo de rmtree


This example shows how to remove a directory tree on Windows where some
of the files have their read-only bit set. It uses the onexc callback
to clear the readonly bit and reattempt the remove. Any subsequent failure
will propagate.

@example
import os, stat
import shutil

def remove_readonly(func, path, _):
    "Clear the readonly bit and reattempt the removal"
    os.chmod(path, stat.S_IWRITE)
    func(path)

shutil.rmtree(directory, onexc=remove_readonly)
@end example

@node Operaciones de archivado,Consulta el tamaño de la terminal de salida,Operaciones de directorios y archivos,shutil — High-level file operations
@anchor{library/shutil archiving-operations}@anchor{1285}@anchor{library/shutil id1}@anchor{2869}
@subsubsection Operaciones de archivado



Added in version 3.2.



Distinto en la versión 3.5: Se agregó soporte para el formato `xztar'.


Se proveen también las utilidades de alto nivel para crear y leer archivos comprimidos y archivados. Utilizan para esto los módulos @ref{130,,zipfile} y @ref{de,,tarfile}.

@geindex make_archive() (en el módulo shutil)
@anchor{library/shutil shutil make_archive}@anchor{55a}
@deffn {Función} shutil.make_archive (base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

Crea un documento de archivado (como zip o tar) y retorna su nombre.

`base_name' is the name of the file to create, including the path, minus
any format-specific extension.

`format' is the archive format: one of
«zip» (if the @ref{132,,zlib} module is available), «tar», «gztar» (if the
@ref{132,,zlib} module is available), «bztar» (if the @ref{14,,bz2} module is
available), or «xztar» (if the @ref{8a,,lzma} module is available).

`root_dir' es un directorio que será el directorio raíz del archivo, todas las rutas en el archivo serán relativas a él; por ejemplo, típicamente nos cambiaremos de directorio (`chdir') a `root_dir' antes de crear el archivo.

`base_dir' es el directorio desde donde iniciamos el archivado; i.e, `base_dir' será el prefijo común para todos los archivos y directorios en el archivo. `base_dir' debe ser dado de forma relativa a `root_dir'. En @ref{286a,,Ejemplo de archivado con base_dir} se ve un ejemplo de cómo usar `base_dir' y `root_dir' juntos.

`root_dir' y `base_dir' irán por defecto al directorio actual.

If `dry_run' es verdadero, no se crea un archivo, pero las operaciones que se ejecutarán están registradas en `logger'.

`owner' y `group' se usan al crear un archivador tar. Por defecto, usa el propietario y el grupo actual.

`logger' debe ser un objeto compatible con  
@geindex Python Enhancement Proposals; PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/}, usualmente una instancia de @ref{bd7,,logging.Logger}.

El argumento `verbose' está fuera de uso y es obsoleto.

Genera un @ref{18c3,,evento de auditoría} @code{shutil.make_archive} con argumentos @code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}.

@cartouche
@quotation Nota 
This function is not thread-safe when custom archivers registered
with @ref{286b,,register_archive_format()} do not support the `root_dir'
argument.  In this case it
temporarily changes the current working directory of the process
to `root_dir' to perform archiving.
@end quotation
@end cartouche


Distinto en la versión 3.8: El formato de `pax' moderno (POSIX.1-2001) se usa ahora en lugar del formato de legado GNU para archivadores creados con @code{format="tar"}.



Distinto en la versión 3.10.6: Esta función ahora es segura para hilos durante la creación de archivos estándar @code{.zip} y tar.

@end deffn

@geindex get_archive_formats() (en el módulo shutil)
@anchor{library/shutil shutil get_archive_formats}@anchor{286c}
@deffn {Función} shutil.get_archive_formats ()

Retorna una lista de formatos admitidos para archivado. Cada elemento de una secuencia retornada es una tupla @code{(name, description)}.

Por defecto, @ref{c5,,shutil} provee los siguientes formatos:


@itemize -

@item 
`zip': archivo ZIP (si el módulo @ref{132,,zlib} está disponible).

@item 
`tar': archivo tar sin comprimir. Utiliza el formato pax POSIX.1-2001 para archivos nuevos.

@item 
`gztar': archivo tar comprimido con gzip (si el módulo @ref{132,,zlib} está disponible).

@item 
`bztar': archivo tar comprimido con bzip2 (si el módulo @ref{14,,bz2} está disponible).

@item 
`xztar': archivo tar comprimido con xz (si el módulo @ref{8a,,lzma} está disponible).
@end itemize

Puedes registrar formatos nuevos o proporcionar tu propio archivador para cualquier formato existente, usando @ref{286b,,register_archive_format()}.
@end deffn

@geindex register_archive_format() (en el módulo shutil)
@anchor{library/shutil shutil register_archive_format}@anchor{286b}
@deffn {Función} shutil.register_archive_format (name, function[, extra_args[, description]])

Registra un archivador para el formato `name'.

`function' es el invocable que se usará para desempacar archivos. El invocable recibirá el `base_name' del archivo para crearlo, seguido por `base_dir' (que cae por defecto en @ref{27cd,,os.curdir}) para comenzar a archivar desde allí. Otros argumentos se pasan como argumentos de palabras clave: `owner', `group', `dry_run' y `logger' (como se pasa en @ref{55a,,make_archive()}).

If `function' has the custom attribute @code{function.supports_root_dir} set to @code{True},
the `root_dir' argument is passed as a keyword argument.
Otherwise the current working directory of the process is temporarily
changed to `root_dir' before calling `function'.
In this case @ref{55a,,make_archive()} is not thread-safe.

Si está dado, `extra_args' es una secuencia de pares @code{(name, value)}  que se usarán como argumentos de palabras clave extra cuando se usa el archivador invocable.

`description' se usa por @ref{286c,,get_archive_formats()} que retorna la lista de archivadores. Cae por defecto en una cadena de caracteres vacía.


Distinto en la versión 3.12: Added support for functions supporting the `root_dir' argument.

@end deffn

@geindex unregister_archive_format() (en el módulo shutil)
@anchor{library/shutil shutil unregister_archive_format}@anchor{286d}
@deffn {Función} shutil.unregister_archive_format (name)

Elimina el formato de archivo `name' de la lista de formatos admitidos.
@end deffn

@geindex unpack_archive() (en el módulo shutil)
@anchor{library/shutil shutil unpack_archive}@anchor{516}
@deffn {Función} shutil.unpack_archive (filename[, extract_dir[, format[, filter]]])

Desempaqueta un archivo. `filename' es la ruta completa del archivo.

`extract_dir' es el nombre del directorio donde se desempaca el archivo. Si no está provisto, se usa el nombre del directorio actual.

`format' es el formato de archivo: uno de «zip», «tar», «gztar», «bztar», or «xztar». O cualquier otra formato registrado con @ref{286e,,register_unpack_format()}. Si no está provisto, @ref{516,,unpack_archive()} usará la extensión de archivo del archivador y verá si se registró un desempacador para esa extensión. En caso de que no se encuentre ninguno, se genera un @ref{360,,ValueError}.

The keyword-only `filter' argument is passed to the underlying unpacking
function. For zip files, `filter' is not accepted.
For tar files, it is recommended to use @code{'data'} (default since Python
3.14), unless using features specific to tar and UNIX-like filesystems.
(See @ref{517,,Extraction filters} for details.)

Se genera un @ref{18c3,,evento de auditoría} @code{shutil.unpack_archive} con argumentos @code{filename}, @code{extract_dir}, @code{format}.

@cartouche
@quotation Advertencia 
Nunca extraiga archivos de fuentes no confiables sin una inspección previa. Es posible que los archivos sean creados fuera de la ruta especificada en el argumento `extract_dir', p.e. miembros que tienen nombres de archivo absolutos comenzando con "/" or nombres de archivos con dos puntos "..".

Since Python 3.14, the defaults for both built-in formats (zip and tar
files) will prevent the most dangerous of such security issues,
but will not prevent `all' unintended behavior.
Read the @ref{286f,,Hints for further verification}
section for tar-specific details.
@end quotation
@end cartouche


Distinto en la versión 3.7: Acepta un @ref{3f0,,path-like object} como `filename' y `extract_dir'.



Distinto en la versión 3.12: Added the `filter' argument.

@end deffn

@geindex register_unpack_format() (en el módulo shutil)
@anchor{library/shutil shutil register_unpack_format}@anchor{286e}
@deffn {Función} shutil.register_unpack_format (name, extensions, function[, extra_args[, description]])

Registra un formato de desempaque. `name' es el nombre del formato y `extensions' es una lista de extensiones que corresponden al formato, como @code{.zip} para archivos zip.

`function' is the callable that will be used to unpack archives. The
callable will receive:


@itemize -

@item 
the path of the archive, as a positional argument;

@item 
the directory the archive must be extracted to, as a positional argument;

@item 
possibly a `filter' keyword argument, if it was given to
@ref{516,,unpack_archive()};

@item 
additional keyword arguments, specified by `extra_args' as a sequence
of @code{(name, value)} tuples.
@end itemize

`description' se puede proporcionar para describir el formato y será retornado por la función @ref{2870,,get_unpack_formats()}.
@end deffn

@geindex unregister_unpack_format() (en el módulo shutil)
@anchor{library/shutil shutil unregister_unpack_format}@anchor{2871}
@deffn {Función} shutil.unregister_unpack_format (name)

Anula el registro del formato de desempaque. `name' es el nombre del formato.
@end deffn

@geindex get_unpack_formats() (en el módulo shutil)
@anchor{library/shutil shutil get_unpack_formats}@anchor{2870}
@deffn {Función} shutil.get_unpack_formats ()

Retorna una lista de todos los formatos registrados para desempaquetar. Cada elemento de la secuencia es una tupla @code{(name, extensions, description)}.

Por defecto, @ref{c5,,shutil} provee los siguientes formatos:


@itemize -

@item 
`zip': archivo zip (desempaquetar archivos comprimidos funciona solo si el módulo correspondiente está disponible).

@item 
`tar': archivo tar sin comprimir.

@item 
`gztar': archivo tar comprimido con gzip (si el módulo @ref{132,,zlib} está disponible).

@item 
`bztar': archivo tar comprimido con bzip2 (si el módulo @ref{14,,bz2} está disponible).

@item 
`xztar': archivo tar comprimido con xz (si el módulo @ref{8a,,lzma} está disponible).
@end itemize

Puedes registrar formatos nuevos o proporcionar tu propio desempaquetado para cualquier formato existente, usando @ref{286e,,register_unpack_format()}.
@end deffn

@menu
* Ejemplo de archivado:: 
* Ejemplo de archivado con base_dir:: 

@end menu

@node Ejemplo de archivado,Ejemplo de archivado con base_dir,,Operaciones de archivado
@anchor{library/shutil archiving-example}@anchor{2872}@anchor{library/shutil shutil-archiving-example}@anchor{2873}
@subsubsection Ejemplo de archivado


En este ejemplo, creamos un archivo tar de tipo gzip que contiene todos los archivos que se encuentran en el directorio @code{.ssh} del usuario:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
>>> make_archive(archive_name, 'gztar', root_dir)
'/Users/tarek/myarchive.tar.gz'
@end example

El archivo resultante contiene:

@example
$ tar -tzvf /Users/tarek/myarchive.tar.gz
drwx------ tarek/staff       0 2010-02-01 16:23:40 ./
-rw-r--r-- tarek/staff     609 2008-06-09 13:26:54 ./authorized_keys
-rwxr-xr-x tarek/staff      65 2008-06-09 13:26:54 ./config
-rwx------ tarek/staff     668 2008-06-09 13:26:54 ./id_dsa
-rwxr-xr-x tarek/staff     609 2008-06-09 13:26:54 ./id_dsa.pub
-rw------- tarek/staff    1675 2008-06-09 13:26:54 ./id_rsa
-rw-r--r-- tarek/staff     397 2008-06-09 13:26:54 ./id_rsa.pub
-rw-r--r-- tarek/staff   37192 2010-02-06 18:23:10 ./known_hosts
@end example

@node Ejemplo de archivado con base_dir,,Ejemplo de archivado,Operaciones de archivado
@anchor{library/shutil archiving-example-with-base-dir}@anchor{2874}@anchor{library/shutil shutil-archiving-example-with-basedir}@anchor{286a}
@subsubsection Ejemplo de archivado con `base_dir'


En este ejemplo, similar al @ref{2873,,de arriba}, mostramos cómo usar @ref{55a,,make_archive()}, pero esta vez utilizando `base_dir'.  Ahora tenemos la siguiente estructura de directorios:

@example
$ tree tmp
tmp
└── root
    └── structure
        ├── content
            └── please_add.txt
        └── do_not_add.txt
@end example

En el archivo final, @code{please_add.txt} debería estar incluido, pero @code{do_not_add.txt} no.  Por lo tanto usamos lo siguiente:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> make_archive(
...     archive_name,
...     'tar',
...     root_dir='tmp/root',
...     base_dir='structure/content',
... )
'/Users/tarek/my_archive.tar'
@end example

Listando los archivos en el archivo resultante nos da:

@example
$ python -m tarfile -l /Users/tarek/myarchive.tar
structure/content/
structure/content/please_add.txt
@end example

@node Consulta el tamaño de la terminal de salida,,Operaciones de archivado,shutil — High-level file operations
@anchor{library/shutil querying-the-size-of-the-output-terminal}@anchor{2875}
@subsubsection Consulta el tamaño de la terminal de salida


@geindex get_terminal_size() (en el módulo shutil)
@anchor{library/shutil shutil get_terminal_size}@anchor{1175}
@deffn {Función} shutil.get_terminal_size (fallback=(columns, lines))

Obtén el tamaño de la ventana de la terminal.

Para cada una de las dos dimensiones, se comprueba la variable de entorno @code{COLUMNS} y @code{LINES} respectivamente. Si la variable está definida y el valor es un entero positivo, se utiliza.

Cuando @code{COLUMNS} o @code{LINES} no está definido, como suele ocurrir, la terminal conectada a @ref{2876,,sys.__stdout__} se consulta invocando @ref{1174,,os.get_terminal_size()}.

Si el tamaño de la terminal no se puede consultar correctamente, ya sea porque el sistema no admite consultas o porque no estamos conectados a una terminal, se usa el valor dado en el parámetro @code{fallback}. @code{fallback} tiene por defecto @code{(80, 24)}, que es el tamaño por defecto que se usa en muchos emuladores de terminal.

El valor retornado es una tupla con su respectivo nombre, de tipo @ref{2877,,os.terminal_size}.

Ver también: `The Single UNIX Specification', Versión 2, Other Environment Variables@footnote{https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003}.


Added in version 3.3.



Distinto en la versión 3.11: Los valores @code{fallback} son usados también si @ref{1174,,os.get_terminal_size()} devuelve zeros.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{a1,,os}

Interfaces del sistema operativo, incluidas las funciones para trabajar con archivos en un nivel inferior al de Python @ref{1230,,file objects}.

@item Módulo @ref{7f,,io}

La biblioteca de I/O integrada de Python, incluidas las clases abstractas y algunas clases concretas, como la I/O de archivos.

@item Función incorporada @ref{1be,,open()}

La forma estándar de abrir archivos para leer y escribir con Python.
@end table


@node Persistencia de datos,Compresión de datos y archivado,Acceso a archivos y directorios,La biblioteca estándar de Python
@anchor{library/persistence doc}@anchor{2878}@anchor{library/persistence data-persistence}@anchor{2879}@anchor{library/persistence persistence}@anchor{287a}
@section Persistencia de datos


Los módulos descritos en este capítulo soportan el almacenamiento de datos de Python de forma persistente en el disco. Los módulos @ref{a6,,pickle} y @ref{8d,,marshal} pueden convertir muchos tipos de datos de Python en un flujo de bytes y luego recrear los objetos a partir de los bytes. Los diversos módulos relacionados con DBM admiten una familia de formatos de archivo basados en hash que almacenan un mapeo de cadenas a otras cadenas.

La lista de módulos descritos en este capítulo es:

@menu
* pickle — Python object serialization:: 
* copyreg — Register pickle support functions:: 
* shelve — Python object persistence:: 
* marshal — Internal Python object serialization:: 
* dbm — Interfaces to Unix «databases»:: 
* sqlite3 — DB-API 2.0 interface for SQLite databases: sqlite3 — DB-API 2 0 interface for SQLite databases. 

@end menu

@node pickle — Python object serialization,copyreg — Register pickle support functions,,Persistencia de datos
@anchor{library/pickle doc}@anchor{287b}@anchor{library/pickle module-pickle}@anchor{a6}@anchor{library/pickle pickle-python-object-serialization}@anchor{287c}
@subsection @code{pickle} — Python object serialization


@geindex module; pickle

`Código fuente:' Lib/pickle.py@footnote{https://github.com/python/cpython/tree/main/Lib/pickle.py}

@geindex persistence
@geindex persistent;objects
@geindex serializing;objects
@geindex marshalling;objects
@geindex flattening;objects
@geindex pickling;objects


__________________________________________________________________


El modulo @ref{a6,,pickle} implementa protocolos binarios para serializar y deserializar una estructura de objetos Python.  `«Pickling»' es el proceso mediante el cual una jerarquía de objetos de Python se convierte en una secuencia de bytes, y el `«unpickling»' es la operación inversa, mediante la cual una secuencia de bytes de un archivo binario (@ref{1c8e,,binary file}) ó un objeto tipo binario (@ref{db4,,bytes-like object}) es convertido nuevamente en una jerarquía de objetos.  @cite{Pickling} (y @cite{unpickling}) son alternativamente conocidos como «serialización», «ensamblaje,» @footnote{
No confunda esto con el módulo @ref{8d,,marshal}
} o «aplanamiento»; sin embargo, para evitar confusiones, los términos utilizados aquí son «pickling» y «unpickling».

@cartouche
@quotation Advertencia 
El modulo @code{pickle} `no es seguro'. Solo deserialize con @cite{pickle} los datos en los que confía.

Es posible construir datos maliciosos con @cite{pickle} que `ejecuten código arbitrario durante el proceso de `unpickling`'. Nunca deserialize datos con @cite{pickle} que podrían haber venido de una fuente no confiable, o que podrían haber sido manipulados.

Considere firmar los datos con @ref{6a,,hmac} si necesita asegurarse de que no hayan sido alterados.

Los formatos de serialización más seguros como @ref{82,,json} pueden ser más apropiados si está procesando datos no confiables. Ver @ref{287d,,Comparación con json}.
@end quotation
@end cartouche

@menu
* Relación con otros módulos de Python:: 
* Formato de flujo de datos:: 
* Interfaz del módulo:: 
* ¿Qué se puede serializar (pickled) y deserializar (unpickled) con pickle?: ¿Qué se puede serializar pickled y deserializar unpickled con pickle?. 
* Pickling de Instancias de clases:: 
* Reducción personalizada para tipos@comma{} funciones y otros objetos: Reducción personalizada para tipos funciones y otros objetos. 
* Búferes fuera de banda:: 
* Restricción de globals:: 
* Performance:: 
* Ejemplos: Ejemplos<6>. 

@end menu

@node Relación con otros módulos de Python,Formato de flujo de datos,,pickle — Python object serialization
@anchor{library/pickle relationship-to-other-python-modules}@anchor{287e}
@subsubsection Relación con otros módulos de Python


@menu
* Comparación con marshal:: 
* Comparación con json:: 

@end menu

@node Comparación con marshal,Comparación con json,,Relación con otros módulos de Python
@anchor{library/pickle comparison-with-marshal}@anchor{287f}
@subsubsection Comparación con @code{marshal}


Python tiene un módulo de serialización más primitivo llamado @ref{8d,,marshal}, pero en general @ref{a6,,pickle} debería ser siempre la forma preferida de serializar objetos de Python.  @ref{8d,,marshal} existe principalmente para soportar archivos Python @code{.pyc}.

El modulo @ref{a6,,pickle} difiere de @ref{8d,,marshal} en varias formas significativas:


@itemize *

@item 
El modulo @ref{a6,,pickle} realiza un seguimiento de los objetos que ya ha serializado, para que las referencias posteriores al mismo objeto no se serializen nuevamente. @ref{8d,,marshal} no hace esto.

Esto tiene implicaciones tanto para los objetos recursivos como para compartir objetos.  Los objetos recursivos son objetos que contienen referencias a sí mismos.  @cite{Marshal} no los maneja y, de hecho, intentar agrupar objetos recursivos bloqueará su intérprete de Python.  El intercambio de objetos ocurre cuando hay múltiples referencias al mismo objeto en diferentes lugares de la jerarquía de objetos que se serializan.  @ref{a6,,pickle} almacena dichos objetos solo una vez y garantiza que todas las demás referencias apunten a la copia maestra.  Los objetos compartidos permanecen compartidos, lo cual puede ser muy importante para los objetos mutables.

@item 
@ref{8d,,marshal} no se puede usar para serializar clases definidas por el usuario y sus instancias.  @ref{a6,,pickle} puede guardar y restaurar instancias de clase de forma transparente, sin embargo, la definición de clase debe ser importable y vivir en el mismo módulo que cuando se almacenó el objeto.

@item 
No se garantiza que el formato de serialización @ref{8d,,marshal} sea portable a través de todas las versiones de Python.  Debido a que su trabajo principal es dar soporte a archivos @code{.pyc}, los implementadores de Python se reservan el derecho de cambiar el formato de serialización de formas no compatibles con versiones anteriores si surge la necesidad. El formato de serialización @ref{a6,,pickle} está garantizado para ser compatible con versiones anteriores de Python siempre que se elija un protocolo de @cite{pickle} compatible y el serializado y deserializado de código con @cite{pickle} se encargue de lidiar con las diferencias de tipos entre Python 2 y Python 3 si sus datos están cruzando ese limite único entre las versiones del lenguaje.
@end itemize

@node Comparación con json,,Comparación con marshal,Relación con otros módulos de Python
@anchor{library/pickle comparison-with-json}@anchor{287d}@anchor{library/pickle id2}@anchor{2880}
@subsubsection Comparación con @code{json}


Existen diferencias fundamentales entre los protocolos pickle y JSON (JavaScript Object Notation)@footnote{https://json.org}:


@itemize *

@item 
JSON es un formato de serialización de texto (genera texto unicode, aunque la mayoría de las veces se codifica a @code{utf-8}), mientras que @cite{pickle} es un formato de serialización binario;

@item 
JSON es legible por humanos, mientras que @cite{pickle} no lo es;

@item 
JSON es interoperable y ampliamente utilizado fuera del ecosistema de Python, mientras que @cite{pickle} es específico de Python;

@item 
JSON, por defecto, solo puede representar un subconjunto de los tipos integrados de Python, y no clases personalizadas; @cite{pickle} puede representar un número extremadamente grande de tipos de Python (muchos de ellos automáticamente, mediante el uso inteligente de la introspección de objetos en Python; los casos complejos se pueden abordar implementando API de objetos específicos, @ref{2881,,specific object APIs});

@item 
A diferencia de @cite{pickle}, deserializar JSON no confiable no crea en sí mismo una vulnerabilidad de ejecución de código arbitraria.
@end itemize


@subsubheading Ver también


El modulo @ref{82,,json}: un módulo de la biblioteca estándar que permite la serialización y deserialización de JSON.


@node Formato de flujo de datos,Interfaz del módulo,Relación con otros módulos de Python,pickle — Python object serialization
@anchor{library/pickle data-stream-format}@anchor{2882}@anchor{library/pickle pickle-protocols}@anchor{1ad}
@subsubsection Formato de flujo de datos


@geindex External Data Representation

The data format used by @ref{a6,,pickle} is Python-specific.  This has the
advantage that there are no restrictions imposed by external standards such as
JSON (which can’t represent pointer sharing); however it means that
non-Python programs may not be able to reconstruct pickled Python objects.

Por defecto, el formato de datos @ref{a6,,pickle} utiliza una representación binaria relativamente compacta.  Si necesita características de tamaño óptimas, puede eficientemente @ref{2883,,comprimir} datos serializados con @cite{pickle}.

El modulo @ref{a7,,pickletools} contiene herramientas para analizar flujos de datos generados por @ref{a6,,pickle}.  El código fuente de @ref{a7,,pickletools} tiene comentarios extensos sobre los códigos de operación utilizados por los protocolos de @cite{pickle}.

Actualmente hay 6 protocolos diferentes que se pueden utilizar para serializar con @cite{pickle}. Cuanto mayor sea el protocolo utilizado, más reciente será la versión de Python necesaria para leer el @cite{pickle} producido.


@itemize *

@item 
La versión 0 del protocolo es el protocolo original «legible para humanos» y es compatible con versiones anteriores de Python.

@item 
La versión 1 del protocolo es un formato binario antiguo que también es compatible con versiones anteriores de Python.

@item 
La versión 2 del protocolo se introdujo en Python 2.3. Proporciona un serializado con pickle mucho más eficiente de @ref{2884,,new-style classes}. Consulte 
@geindex Python Enhancement Proposals; PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} para obtener información sobre las mejoras que trae el protocolo 2.

@item 
Se agregó la versión 3 del protocolo en Python 3.0.  Tiene soporte explícito para objetos @ref{325,,bytes} y no puede ser deserializado con @cite{pickle} por Python 2.x.  Este era el protocolo predeterminado en Python 3.0–3.7.

@item 
Protocol version 4 was added in Python 3.4.  It adds support for very large
objects, pickling more kinds of objects, and some data format
optimizations.  This was the default protocol in Python 3.8–3.13.
Refer to 
@geindex Python Enhancement Proposals; PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/} for information about improvements brought by
protocol 4.

@item 
Protocol version 5 was added in Python 3.8.  It adds support for out-of-band
data and speedup for in-band data.  It is the default protocol starting with
Python 3.14.  Refer to 
@geindex Python Enhancement Proposals; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} for information about improvements brought
by protocol 5.
@end itemize

@cartouche
@quotation Nota 
La serialización es una noción más primitiva que la persistencia; aunque @ref{a6,,pickle} lee y escribe objetos de archivo, no maneja el problema de nombrar objetos persistentes, ni el problema (aún más complicado) de acceso concurrente a objetos persistentes.  El módulo @ref{a6,,pickle} puede transformar un objeto complejo en una secuencia de bytes y puede transformar la secuencia de bytes en un objeto con la misma estructura interna.  Quizás lo más obvio que hacer con estos flujos de bytes es escribirlos en un archivo, pero también es concebible enviarlos a través de una red o almacenarlos en una base de datos.  El módulo @ref{c3,,shelve} proporciona una interfaz simple para serializar y deserializar objetos con @cite{pickle} en archivos de bases de datos de estilo DBM.
@end quotation
@end cartouche

@node Interfaz del módulo,¿Qué se puede serializar pickled y deserializar unpickled con pickle?,Formato de flujo de datos,pickle — Python object serialization
@anchor{library/pickle module-interface}@anchor{2885}
@subsubsection Interfaz del módulo


Para serializar una jerarquía de objetos, simplemente llame a la función @ref{14de,,dumps()}. De manera similar, para deserializar un flujo de datos, llama a la función @ref{d98,,loads()}. Sin embargo, si desea tener más control sobre la serialización y la deserialización, puede crear un objeto @ref{ab0,,Pickler} o @ref{16b1,,Unpickler}, respectivamente.

El módulo @ref{a6,,pickle} proporciona las siguientes constantes:

@geindex HIGHEST_PROTOCOL (en el módulo pickle)
@anchor{library/pickle pickle HIGHEST_PROTOCOL}@anchor{14df}
@deffn {Dato} pickle.HIGHEST_PROTOCOL

Un entero, la versión de protocolo (@ref{1ad,,protocol version}) más alta disponible.  Este valor se puede pasar como un valor de `protocolo' a las funciones @ref{2886,,dump()} y @ref{14de,,dumps()} así como al constructor @ref{ab0,,Pickler}.
@end deffn

@geindex DEFAULT_PROTOCOL (en el módulo pickle)
@anchor{library/pickle pickle DEFAULT_PROTOCOL}@anchor{8c5}
@deffn {Dato} pickle.DEFAULT_PROTOCOL

An integer, the default @ref{1ad,,protocol version} used
for pickling.  May be less than @ref{14df,,HIGHEST_PROTOCOL}.  Currently the
default protocol is 5, introduced in Python 3.8 and incompatible
with previous versions. This version introduces support for out-of-band
buffers, where 
@geindex Python Enhancement Proposals; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/}-compatible data can be transmitted separately
from the main pickle stream.


Distinto en la versión 3.0: El protocolo predeterminado es 3.



Distinto en la versión 3.8: El protocolo predeterminado es 4.



Distinto en la versión 3.14: The default protocol is 5.

@end deffn

El módulo @ref{a6,,pickle} proporciona las siguientes funciones para que el proceso de @cite{pickling} sea más conveniente:

@geindex dump() (en el módulo pickle)
@anchor{library/pickle pickle dump}@anchor{2886}
@deffn {Función} pickle.dump (obj, file, protocol=None, *, fix_imports=True, buffer_callback=None)

Escribe la representación @cite{pickle} del objeto `obj' en el `archivo' abierto @ref{1230,,file object}.  Esto es equivalente a @code{Pickler(file, protocol).dump(obj)}.

Los argumentos `file', `protocol', `fix_imports' y `buffer_callback' tienen el mismo significado que en el constructor @ref{ab0,,Pickler}.


Distinto en la versión 3.8: Se agregó el argumento `buffer_callback'.

@end deffn

@geindex dumps() (en el módulo pickle)
@anchor{library/pickle pickle dumps}@anchor{14de}
@deffn {Función} pickle.dumps (obj, protocol=None, *, fix_imports=True, buffer_callback=None)

Retorna la representación @cite{pickle} del objeto `obj' como un objeto @ref{325,,bytes}, en lugar de escribirlo en un archivo.

Los argumentos `protocol', `fix_imports' y `buffer_callback' tienen el mismo significado que en el constructor @ref{ab0,,Pickler}.


Distinto en la versión 3.8: Se agregó el argumento `buffer_callback'.

@end deffn

@geindex load() (en el módulo pickle)
@anchor{library/pickle pickle load}@anchor{d97}
@deffn {Función} pickle.load (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Lee la representación @cite{pickle} de un objeto desde un `archivo' abierto @ref{1230,,file object} y retorna la jerarquía de objetos reconstituidos especificada en el mismo. Esto es equivalente a @code{Unpickler(file).load()}.

La versión de protocolo del @cite{pickle} se detecta automáticamente, por lo que no se necesita ningún argumento de protocolo.  Los bytes más allá de la representación empaquetada son ignorados.

Los argumentos `file', `fix_imports', `encoding', `errors', `strict' y `buffers' tienen el mismo significado que en el constructor @ref{16b1,,Unpickler}.


Distinto en la versión 3.8: Se agregó el argumento `buffers'.

@end deffn

@geindex loads() (en el módulo pickle)
@anchor{library/pickle pickle loads}@anchor{d98}
@deffn {Función} pickle.loads (data, /, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Retorna la jerarquía de objetos reconstruida de la representación @cite{pickle} `data' de un objeto. `data' debe ser un objeto tipo binario (@ref{db4,,bytes-like object}).

La versión de protocolo del @cite{pickle} se detecta automáticamente, por lo que no se necesita ningún argumento de protocolo.  Los bytes más allá de la representación empaquetada son ignorados.

Los argumentos `fix_imports', `encoding', `errors', `strict' y `buffers' tienen el mismo significado que en el constructor @ref{16b1,,Unpickler}.


Distinto en la versión 3.8: Se agregó el argumento `buffers'.

@end deffn

El módulo @ref{a6,,pickle} define tres excepciones:

@geindex PickleError
@anchor{library/pickle pickle PickleError}@anchor{2887}
@deffn {Excepción} pickle.PickleError

Common base class for the other pickling exceptions.  It inherits from
@ref{a6b,,Exception}.
@end deffn

@geindex PicklingError
@anchor{library/pickle pickle PicklingError}@anchor{15da}
@deffn {Excepción} pickle.PicklingError

Error raised when an unpicklable object is encountered by @ref{ab0,,Pickler}.
It inherits from @ref{2887,,PickleError}.

Consulte @ref{2888,,¿Qué se puede serializar (pickled) y deserializar (unpickled) con pickle?} para aprender qué tipos de objetos se pueden serializar con @cite{pickle}.
@end deffn

@geindex UnpicklingError
@anchor{library/pickle pickle UnpicklingError}@anchor{2889}
@deffn {Excepción} pickle.UnpicklingError

Error raised when there is a problem unpickling an object, such as a data
corruption or a security violation.  It inherits from @ref{2887,,PickleError}.

Tenga en cuenta que también se pueden generar otras excepciones durante la deserializacion con @cite{pickle}, incluyendo (pero no necesariamente limitado a) @cite{AttributeError}, @cite{EOFError}, @cite{ImportError}, e @cite{IndexError}.
@end deffn

El módulo @ref{a6,,pickle} exporta tres clases, @ref{ab0,,Pickler}, @ref{16b1,,Unpickler} y @ref{17ff,,PickleBuffer}:

@geindex Pickler (clase en pickle)
@anchor{library/pickle pickle Pickler}@anchor{ab0}
@deffn {Clase} pickle.Pickler (file, protocol=None, *, fix_imports=True, buffer_callback=None)

Esto toma un archivo binario para escribir un flujo de datos de @cite{pickle}.

El argumento opcional `protocol' , un entero, le dice al @cite{pickler} que use el protocolo dado; los protocolos admitidos son 0 para @ref{14df,,HIGHEST_PROTOCOL}. Si no se especifica, el valor predeterminado es @ref{8c5,,DEFAULT_PROTOCOL}.  Si se especifica un número negativo, @ref{14df,,HIGHEST_PROTOCOL} es seleccionado.

El argumento `file' debe tener un método `write()' que acepte un argumento de bytes individuales.  Por lo tanto, puede ser un archivo en disco abierto para escritura binaria, una instancia @ref{f25,,io.BytesIO} , o cualquier otro objeto personalizado que cumpla con esta interfaz.

Si `fix_imports' es verdadero y `protocol' es menor que 3, @cite{pickle} intentará asignar los nuevos nombres de Python 3 a los nombres de módulos antiguos utilizados en Python 2, de modo que la secuencia de datos de @cite{pickle} sea legible con Python 2.

If `buffer_callback' is @code{None} (the default), buffer views are
serialized into `file' as part of the pickle stream.

If `buffer_callback' is not @code{None}, then it can be called any number
of times with a buffer view.  If the callback returns a false value
(such as @code{None}), the given buffer is @ref{288a,,out-of-band};
otherwise the buffer is serialized in-band, i.e. inside the pickle stream.

It is an error if `buffer_callback' is not @code{None} and `protocol' is
@code{None} or smaller than 5.


Distinto en la versión 3.8: Se agregó el argumento `buffer_callback'.


@geindex dump() (método de pickle.Pickler)
@anchor{library/pickle pickle Pickler dump}@anchor{1a4c}
@deffn {Método} dump (obj)

Escribe la representación serializada con @cite{pickle} del objeto `obj' en el objeto archivo abierto dado en el constructor.
@end deffn

@geindex persistent_id() (método de pickle.Pickler)
@anchor{library/pickle pickle Pickler persistent_id}@anchor{159f}
@deffn {Método} persistent_id (obj)

No hacer nada por defecto. Esto existe para que una subclase pueda sobreescribirlo.

Si @ref{159f,,persistent_id()} retorna @code{None}, `obj' es serializado con @cite{pickle} como siempre.  Cualquier otro valor hace que @ref{ab0,,Pickler} emita el valor retornado como un ID persistente para `obj'.  El significado de este ID persistente debe definirse por @ref{15a9,,Unpickler.persistent_load()}.  Tenga en cuenta que el valor retornado por @ref{159f,,persistent_id()} no puede tener una ID persistente.

Ver @ref{288b,,Persistencia de objetos externos} para detalles y ejemplos de uso.


Distinto en la versión 3.13: Add the default implementation of this method in the C implementation
of @code{Pickler}.

@end deffn

@geindex dispatch_table (atributo de pickle.Pickler)
@anchor{library/pickle pickle Pickler dispatch_table}@anchor{1194}
@deffn {Atributo} dispatch_table

A pickler object’s dispatch table is a registry of `reduction
functions' of the kind which can be declared using
@ref{288c,,copyreg.pickle()}.  It is a mapping whose keys are classes
and whose values are reduction functions.  A reduction function
takes a single argument of the associated class and should
conform to the same interface as a @ref{a65,,__reduce__()}
method.

Por defecto, un objeto de @cite{pickle} no tendrá un atributo @ref{1194,,dispatch_table}, y en su lugar utilizará la tabla de despacho global administrada por el módulo @ref{27,,copyreg}. Sin embargo, para personalizar el @cite{pickling} para un objeto de @cite{pickle} específico, se puede establecer el atributo @ref{1194,,dispatch_table} en un objeto tipo dict.  Alternativamente, si una subclase de @ref{ab0,,Pickler} tiene un atributo @ref{1194,,dispatch_table} esto se usará como la tabla de despacho predeterminada para instancias de esa clase.

Ver @ref{288d,,Tablas de despacho} para ejemplos de uso.


Added in version 3.3.

@end deffn

@geindex reducer_override() (método de pickle.Pickler)
@anchor{library/pickle pickle Pickler reducer_override}@anchor{ab1}
@deffn {Método} reducer_override (obj)

Special reducer that can be defined in @ref{ab0,,Pickler} subclasses. This
method has priority over any reducer in the @ref{1194,,dispatch_table}.  It
should conform to the same interface as a @ref{a65,,__reduce__()} method, and
can optionally return @ref{227,,NotImplemented} to fallback on
@ref{1194,,dispatch_table}-registered reducers to pickle @code{obj}.

Para un ejemplo detallado, ver @ref{288e,,Reducción personalizada para tipos@comma{} funciones y otros objetos}.


Added in version 3.8.

@end deffn

@geindex fast (atributo de pickle.Pickler)
@anchor{library/pickle pickle Pickler fast}@anchor{288f}
@deffn {Atributo} fast

Obsoleto. Habilite el modo rápido si se establece en un valor verdadero. El modo rápido deshabilita el uso de memo, por lo tanto, acelera el proceso de @cite{pickling} al no generar códigos de operación PUT superfluos. No debe usarse con objetos autorreferenciales; de lo contrario, la clase @ref{ab0,,Pickler} se repetirá infinitamente.

Use @ref{2890,,pickletools.optimize()} si necesita @cite{pickles} más compactos.
@end deffn
@end deffn

@geindex Unpickler (clase en pickle)
@anchor{library/pickle pickle Unpickler}@anchor{16b1}
@deffn {Clase} pickle.Unpickler (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Esto toma un archivo binario para leer un flujo de datos de @cite{pickle}.

La versión de protocolo de @cite{pickle} se detecta automáticamente, por lo que no se necesita ningún argumento de protocolo.

El argumento `file' debe tener tres métodos, un método read() que toma un argumento entero, un método @cite{readinto()} que toma un argumento búfer y un método @cite{readline()} que no requiere argumentos, como en la interfaz @ref{735,,io.BufferedIOBase}.  Por lo tanto `file' puede ser un archivo en disco abierto para lectura binaria, un objeto @ref{f25,,io.BytesIO}, o cualquier otro objeto personalizado que cumpla con esta interfaz.

Los argumentos opcionales `fix_imports', `encoding' and `errors' se utilizan para controlar el soporte de compatibilidad para el flujo de @cite{pickle} generado por Python 2. Si `fix_imports' es verdadero, @cite{pickle} intentará asignar los nombres antiguos de Python 2 a los nuevos nombres utilizados en Python 3.  Tanto `encoding' como `errors' le indican a @cite{pickle} cómo decodificar instancias de cadenas de 8 bits seleccionadas por Python 2; estos son predeterminados a “ASCII” y “strict”, respectivamente.  `encoding' puede ser “bytes” para leer estas instancias de cadena de 8 bits como objetos de bytes. Se requiere el uso de @code{encoding='latin1'} para realizar el @cite{unpickling} de arreglos de NumPy e instancias de @ref{32f,,datetime}, @ref{330,,date} y @ref{331,,time} serializados con @cite{pickle} por Python 2.

If `buffers' is @code{None} (the default), then all data necessary for
deserialization must be contained in the pickle stream.  This means
that the `buffer_callback' argument was @code{None} when a @ref{ab0,,Pickler}
was instantiated (or when @ref{2886,,dump()} or @ref{14de,,dumps()} was called).

If `buffers' is not @code{None}, it should be an iterable of buffer-enabled
objects that is consumed each time the pickle stream references
an @ref{288a,,out-of-band} buffer view.  Such buffers have been
given in order to the `buffer_callback' of a Pickler object.


Distinto en la versión 3.8: Se agregó el argumento `buffers'.


@geindex load() (método de pickle.Unpickler)
@anchor{library/pickle pickle Unpickler load}@anchor{2891}
@deffn {Método} load ()

Lee la representación serializada con @cite{pickle} de un objeto desde el objeto de archivo abierto dado en el constructor, y retorne la jerarquía de objetos reconstituidos especificada allí.  Los Bytes más allá de la representación serializada con @cite{pickle} del objeto se ignoran.
@end deffn

@geindex persistent_load() (método de pickle.Unpickler)
@anchor{library/pickle pickle Unpickler persistent_load}@anchor{15a9}
@deffn {Método} persistent_load (pid)

Lanza un @ref{2889,,UnpicklingError} de forma predeterminada.

Si se define, @ref{15a9,,persistent_load()} debería retornar el objeto especificado por el ID persistente `pid'.  Si se encuentra un ID persistente no válido, se debe lanzar un @ref{2889,,UnpicklingError}.

Ver @ref{288b,,Persistencia de objetos externos} para detalles y ejemplos de uso.


Distinto en la versión 3.13: Add the default implementation of this method in the C implementation
of @code{Unpickler}.

@end deffn

@geindex find_class() (método de pickle.Unpickler)
@anchor{library/pickle pickle Unpickler find_class}@anchor{2892}
@deffn {Método} find_class (module, name)

Importa `module' si es necesario y retorna el objeto llamado `name' desde el, donde los argumentos `module' y `name' son objetos de @ref{237,,str}.  Tenga en cuenta que, a diferencia de lo que sugiere su nombre, @ref{2892,,find_class()} también se usa para buscar funciones.

Las subclases pueden sobreescribir esto para obtener control sobre qué tipo de objetos y cómo se pueden cargar, reduciendo potencialmente los riesgos de seguridad. Consulte @ref{2893,,Restricción de globals} para obtener más detalles.

Lanza un @ref{18c3,,auditing event} @code{pickle.find_class} con argumentos @code{module}, @code{name}.
@end deffn
@end deffn

@geindex PickleBuffer (clase en pickle)
@anchor{library/pickle pickle PickleBuffer}@anchor{17ff}
@deffn {Clase} pickle.PickleBuffer (buffer)

Un envoltorio (@cite{wrapper}) para un búfer que representa datos serializables con @cite{pickle} (@cite{picklable data}).  `buffer' debe ser un objeto que proporciona un búfer (@ref{48a,,buffer-providing}), como objeto tipo binario (@ref{db4,,bytes-like object}) o un arreglo N-dimensional.

@ref{17ff,,PickleBuffer} es en sí mismo un proveedor de búfer, por lo que es posible pasarlo a otras API que esperan un objeto que provea un búfer, como @ref{156,,memoryview}.

Los objetos @ref{17ff,,PickleBuffer} solo se pueden serializar usando el protocolo @cite{pickle} 5 o superior.  Son elegibles para serialización fuera de banda (@ref{288a,,out-of-band serialization}).


Added in version 3.8.


@geindex raw() (método de pickle.PickleBuffer)
@anchor{library/pickle pickle PickleBuffer raw}@anchor{2894}
@deffn {Método} raw ()

Retorna un @ref{156,,memoryview} del área de memoria subyacente a este búfer. El objeto retornado es una vista de memoria unidimensional, C-contigua con formato @code{B} (bytes sin firmar).  @ref{182b,,BufferError} es lanzado si el búfer no es contiguo a C ni a Fortran.
@end deffn

@geindex release() (método de pickle.PickleBuffer)
@anchor{library/pickle pickle PickleBuffer release}@anchor{2895}
@deffn {Método} release ()

Libera el búfer subyacente expuesto por el objeto PickleBuffer.
@end deffn
@end deffn

@node ¿Qué se puede serializar pickled y deserializar unpickled con pickle?,Pickling de Instancias de clases,Interfaz del módulo,pickle — Python object serialization
@anchor{library/pickle pickle-picklable}@anchor{2888}@anchor{library/pickle what-can-be-pickled-and-unpickled}@anchor{2896}
@subsubsection ¿Qué se puede serializar (pickled) y deserializar (unpickled) con @cite{pickle}?


Los siguientes tipos se pueden serializar con @cite{pickle} (pickled):


@itemize *

@item 
built-in constants (@code{None}, @code{True}, @code{False}, @code{Ellipsis}, and
@ref{227,,NotImplemented});

@item 
enteros, números de coma flotante, números complejos;

@item 
cadenas de caracteres, bytes, bytearrays;

@item 
tuplas, listas, conjuntos y diccionarios que contienen solo objetos serializables con pickle;

@item 
funciones (incorporadas y definidas por el usuario) accesibles desde el nivel superior de un módulo (usando @ref{1497,,def}, no @ref{1309,,lambda})

@item 
clases accesibles desde el nivel superior de un módulo;

@item 
instances of such classes whose the result of calling @ref{679,,__getstate__()}
is picklable  (see section @ref{2881,,Pickling de Instancias de clases} for details).
@end itemize

Los intentos de serializar objetos no serializables con @cite{pickle} lanzaran la excepción @ref{15da,,PicklingError}; cuando esto sucede, es posible que ya se haya escrito una cantidad no especificada de bytes en el archivo subyacente.  Intentar serializar con @cite{pickle} una estructura de datos altamente recursiva puede exceder la profundidad máxima de recursividad, en este caso se lanzará  un @ref{df1,,RecursionError}.  Puede aumentar cuidadosamente este límite con @ref{56a,,sys.setrecursionlimit()}.

Tenga en cuenta que las funciones (integradas y definidas por el usuario) están completamente serializadas con @cite{pickle} por @ref{194a,,qualified name}, no por valor. @footnote{
Esta es la razón por la que las funciones @ref{1309,,lambda} no se pueden serializar con @cite{pickle}:  todas las funciones @code{lambda} comparten el mismo nombre:  @code{<lambda>}.
} Esto significa que solo se serializa el nombre de la función, junto con el nombre del módulo y las clases que lo contienen. No se serializa ni el código de la función ni ninguno de sus atributos de función. Por lo tanto, el módulo de definición debe poder importarse en el entorno de deserialización y el módulo debe contener el objeto nombrado; de lo contrario, se generará una excepción. @footnote{
La excepción generada probablemente será un @ref{4d7,,ImportError} o un @ref{441,,AttributeError} pero podría ser otra cosa.
}

De manera similar, las clases se serializan por nombre completo, por lo que se aplican las mismas restricciones en el entorno de deserialización. Tenga en cuenta que ninguno de los códigos o datos de la clase se serializa, por lo que en el siguiente ejemplo, el atributo de clase @code{attr} no se restaura en el entorno de deserializado:

@example
class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)
@end example

Estas restricciones son la razón por la que las funciones y clases serializables con pickle deben definirse en el nivel superior de un módulo.

Similarly, when class instances are pickled, their class’s code and data are not
pickled along with them.  Only the instance data are pickled.  This is done on
purpose, so you can fix bugs in a class or add methods to the class and still
load objects that were created with an earlier version of the class.  If you
plan to have long-lived objects that will see many versions of a class, it may
be worthwhile to put a version number in the objects so that suitable
conversions can be made by the class’s @ref{14e0,,__setstate__()} method.

@node Pickling de Instancias de clases,Reducción personalizada para tipos funciones y otros objetos,¿Qué se puede serializar pickled y deserializar unpickled con pickle?,pickle — Python object serialization
@anchor{library/pickle pickle-inst}@anchor{2881}@anchor{library/pickle pickling-class-instances}@anchor{2897}
@subsubsection @cite{Pickling} de Instancias de clases


En esta sección, describimos los mecanismos generales disponibles para que usted defina, personalice y controle cómo se serializan y deserializan con @cite{Pickle} las instancias de clase.

In most cases, no additional code is needed to make instances picklable.  By
default, pickle will retrieve the class and the attributes of an instance via
introspection. When a class instance is unpickled, its @ref{751,,__init__()} method
is usually `not' invoked.  The default behaviour first creates an uninitialized
instance and then restores the saved attributes.  The following code shows an
implementation of this behaviour:

@example
def save(obj):
    return (obj.__class__, obj.__dict__)

def restore(cls, attributes):
    obj = cls.__new__(cls)
    obj.__dict__.update(attributes)
    return obj
@end example

Las clases pueden alterar el comportamiento predeterminado proporcionando uno o varios métodos especiales:

@geindex __getnewargs_ex__() (método de object)
@anchor{library/pickle object __getnewargs_ex__}@anchor{2898}
@deffn {Método} object.__getnewargs_ex__ ()

En los protocolos 2 y más recientes, las clases que implementan el método @ref{2898,,__getnewargs_ex__()} pueden dictar los valores pasados al método @ref{624,,__new__()} al hacer @cite{unpickling}.  El método debe retornar un par @code{(args, kwargs)} donde `args' es una tupla de argumentos posicionales y `kwargs' un diccionario de argumentos con nombre para construir el objeto.  Estos se pasarán al método @ref{624,,__new__()} al hacer @cite{unpickling}.

Debes implementar este método si el método @ref{624,,__new__()} de tu clase requiere argumentos de solo palabras clave.  De lo contrario, se recomienda para la compatibilidad implementar @ref{14e1,,__getnewargs__()}.


Distinto en la versión 3.6: @ref{2898,,__getnewargs_ex__()} ahora se usa en los protocolos 2 y 3.

@end deffn

@geindex __getnewargs__() (método de object)
@anchor{library/pickle object __getnewargs__}@anchor{14e1}
@deffn {Método} object.__getnewargs__ ()

Este método tiene un propósito similar a @ref{2898,,__getnewargs_ex__()}, pero solo admite argumentos posicionales.  Debe retornar una tupla de argumentos @code{args} que se pasarán al método @ref{624,,__new__()} al hacer @cite{unpickling}.

@ref{14e1,,__getnewargs__()} no se llamará si @ref{2898,,__getnewargs_ex__()} está definido.


Distinto en la versión 3.6: Antes de Python 3.6, se llamaba a, @ref{14e1,,__getnewargs__()} en lugar de @ref{2898,,__getnewargs_ex__()} en los protocolos 2 y 3.

@end deffn

@geindex __getstate__() (método de object)
@anchor{library/pickle object __getstate__}@anchor{679}
@deffn {Método} object.__getstate__ ()

Las clases pueden influir aún más en cómo se serializan con @cite{pickle} sus instancias sobrescribiendo el método @ref{679,,__getstate__()}. Se llama y el objeto devuelto se conserva como el contenido de la instancia, en lugar de un estado predeterminado. Hay varios casos:


@itemize *

@item 
Para una clase que no tiene instancias @ref{5fe,,__dict__} ni @ref{152a,,__slots__}, el estado predeterminado es @code{None}.

@item 
Para una clase que tiene una instancia @ref{5fe,,__dict__} y no tiene @ref{152a,,__slots__}, el estado predeterminado es @code{self.__dict__}.

@item 
Para una clase que tiene una instancia @ref{5fe,,__dict__} y @ref{152a,,__slots__}, el estado predeterminado es una tupla que consta de dos diccionarios: @code{self.__dict__} y un diccionario que asigna nombres de ranura a valores de ranura. Solo las ranuras que tienen un valor se incluyen en este último.

@item 
Para una clase que tiene @ref{152a,,__slots__} y ninguna instancia @ref{5fe,,__dict__}, el estado predeterminado es una tupla cuyo primer elemento es @code{None} y cuyo segundo elemento es un diccionario que asigna nombres de ranura a valores de ranura descritos en la viñeta anterior.
@end itemize


Distinto en la versión 3.11: Se agregó la implementación predeterminada del método @code{__getstate__()} en la clase @ref{b18,,object}.

@end deffn

@geindex __setstate__() (método de object)
@anchor{library/pickle object __setstate__}@anchor{14e0}
@deffn {Método} object.__setstate__ (state)

Al hacer @cite{unpickling}, si la clase define @ref{14e0,,__setstate__()}, este es llamado con el estado @cite{unpickled} (no serializado con @cite{pickle}).  En ese caso, no es necesario que el objeto de estado sea un diccionario.  De lo contrario, el estado @cite{pickled} (@cite{pickled state}) debe ser un diccionario y sus elementos se asignan al diccionario de la nueva instancia.

@cartouche
@quotation Nota 
If @ref{a65,,__reduce__()} returns a state with value @code{None} at pickling,
the @ref{14e0,,__setstate__()} method will not be called upon unpickling.
@end quotation
@end cartouche
@end deffn

Refer to the section @ref{2899,,Manejo de objetos con estado} for more information about how to use
the methods @ref{679,,__getstate__()} and @ref{14e0,,__setstate__()}.

@cartouche
@quotation Nota 
At unpickling time, some methods like @ref{57a,,__getattr__()},
@ref{c5a,,__getattribute__()}, or @ref{1f2e,,__setattr__()} may be called upon the
instance.  In case those methods rely on some internal invariant being
true, the type should implement @ref{624,,__new__()} to establish such an
invariant, as @ref{751,,__init__()} is not called when unpickling an
instance.
@end quotation
@end cartouche

@geindex copy;protocol

As we shall see, pickle does not use directly the methods described above.  In
fact, these methods are part of the copy protocol which implements the
@ref{a65,,__reduce__()} special method.  The copy protocol provides a unified
interface for retrieving the data necessary for pickling and copying
objects. @footnote{
El módulo @ref{26,,copy} utiliza este protocolo para operaciones de copia superficial y profunda.
}

Although powerful, implementing @ref{a65,,__reduce__()} directly in your classes is
error prone.  For this reason, class designers should use the high-level
interface (i.e., @ref{2898,,__getnewargs_ex__()}, @ref{679,,__getstate__()} and
@ref{14e0,,__setstate__()}) whenever possible.  We will show, however, cases where
using @code{__reduce__()} is the only option or leads to more efficient pickling
or both.

@geindex __reduce__() (método de object)
@anchor{library/pickle object __reduce__}@anchor{a65}
@deffn {Método} object.__reduce__ ()

La interfaz se define actualmente de la siguiente manera. El método @ref{a65,,__reduce__()} no toma ningún argumento y retornará una cadena o preferiblemente una tupla (el objeto retornado a menudo se denomina «valor reducido»).

Si se retorna una cadena, la cadena debe interpretarse como el nombre de una variable global.  Debe ser el nombre local del objeto relativo a su módulo; el módulo @cite{pickle} busca en el espacio de nombres del módulo para determinar el módulo del objeto. Este comportamiento suele ser útil para singletons.

Cuando se retorna una tupla, debe tener entre dos y seis elementos. Los elementos opcionales se pueden omitir o se puede proporcionar @code{None} como su valor.  La semántica de cada elemento está en orden:

@c XXX Mention __newobj__ special-case?


@itemize *

@item 
Un objeto invocable que se llamará para crear la versión inicial del objeto.

@item 
Una tupla de argumentos para el objeto invocable. Se debe proporcionar una tupla vacía si el invocable no acepta ningún argumento.

@item 
Opcionalmente, el estado del objeto, que se pasará al método @ref{14e0,,__setstate__()} del objeto como se describió anteriormente. Si el objeto no tiene dicho método, el valor debe ser un diccionario y se agregará al atributo @ref{5fe,,__dict__} del objeto.

@item 
Optionally, an iterator (and not a sequence) yielding successive items.
These items will be appended to the object either using
@code{obj.append(item)} or, in batch, using @code{obj.extend(list_of_items)}.
This is primarily used for list subclasses, but may be used by other
classes as long as they have
@ref{21b3,,append and extend methods} with
the appropriate signature.  (Whether @code{append()} or @code{extend()} is
used depends on which pickle protocol version is used as well as the number
of items to append, so both must be supported.)

@item 
Opcionalmente, un iterador (no una secuencia) que produce pares clave-valor sucesivos.  Estos elementos se almacenarán en el objeto usando @code{obj[key] = value}.  Esto se usa principalmente para subclases de diccionario, pero otras clases pueden usarlo siempre que implementen @ref{1505,,__setitem__()}.

@item 
Opcionalmente, un invocable con una firma @code{(obj, state)}. Este invocable permite al usuario controlar programáticamente el comportamiento de actualización de estado de un objeto específico, en lugar de usar el método estático de @code{obj} @ref{14e0,,__setstate__()}. Si no es @code{None}, este invocable tendrá prioridad sobre @code{obj}’s @ref{14e0,,__setstate__()}.


Added in version 3.8: Se agregó el sexto elemento opcional de tupla @code{(obj, state)}.

@end itemize
@end deffn

@geindex __reduce_ex__() (método de object)
@anchor{library/pickle object __reduce_ex__}@anchor{1609}
@deffn {Método} object.__reduce_ex__ (protocol)

Alternativamente, se puede definir un método @ref{1609,,__reduce_ex__()}.  La única diferencia es que este método debe tomar un único argumento entero, la versión del protocolo.  Cuando esté definido, @cite{pickle} lo preferirá en lugar del método @ref{a65,,__reduce__()}.  Además, @ref{a65,,__reduce__()} se convierte automáticamente en sinónimo de la versión extendida.  El uso principal de este método es proporcionar valores reducidos compatibles con versiones anteriores para versiones anteriores de Python.
@end deffn

@menu
* Persistencia de objetos externos:: 
* Tablas de despacho:: 
* Manejo de objetos con estado:: 

@end menu

@node Persistencia de objetos externos,Tablas de despacho,,Pickling de Instancias de clases
@anchor{library/pickle persistence-of-external-objects}@anchor{289a}@anchor{library/pickle pickle-persistent}@anchor{288b}
@subsubsection Persistencia de objetos externos


@geindex persistent_id (pickle protocol)
@geindex persistent_load (pickle protocol)

Para el beneficio de la persistencia del objeto, el módulo @ref{a6,,pickle} admite la noción de una referencia a un objeto fuera del flujo de datos serializados con @cite{pickle}.  Dichos objetos son referenciados por un ID persistente, que debe ser una cadena de caracteres alfanuméricos (para el protocolo 0) @footnote{
La limitación de caracteres alfanuméricos se debe a que los ID persistentes en el protocolo 0 están delimitados por el carácter de nueva línea. Por lo tanto, si se produce algún tipo de carácter de nueva línea en los ID persistentes, los datos serializados resultantes se volverán ilegibles.
} o simplemente un objeto arbitrario (para cualquier protocolo más nuevo).

La resolución de tales ID persistentes no está definida por el módulo @ref{a6,,pickle}; delegará esta resolución a los métodos definidos por el usuario en el @cite{pickler} y el @cite{unpickler}, @ref{159f,,persistent_id()} y @ref{15a9,,persistent_load()} respectivamente.

Para seleccionar objetos que tienen una ID persistente externo, el @cite{pickler} debe tener un método personalizado @ref{159f,,persistent_id()} que toma un objeto como argumento y retorna @code{None} o el ID persistente para ese objeto. Cuando se retorna @code{None}, el @cite{pickler} simplemente serializará el objeto de forma normal. Cuando se retorna una cadena de identificación persistente, el @cite{pickler} serializará ese objeto, junto con un marcador para que el @cite{unpickler} lo reconozca como una identificación persistente.

Para hacer el @cite{unpickling} objetos externos, el @cite{unpickler} debe tener un método personalizado @ref{15a9,,persistent_load()} que toma un objeto de identificación persistente y retorna el objeto referenciado.

Aquí hay un ejemplo completo que presenta cómo se puede usar la identificación persistente para hacer el @cite{pickling} objetos externos por referencia.

@example
# Simple example presenting how persistent ID can be used to pickle
# external objects by reference.

import pickle
import sqlite3
from collections import namedtuple

# Simple class representing a record in our database.
MemoRecord = namedtuple("MemoRecord", "key, task")

class DBPickler(pickle.Pickler):

    def persistent_id(self, obj):
        # Instead of pickling MemoRecord as a regular class instance, we emit a
        # persistent ID.
        if isinstance(obj, MemoRecord):
            # Here, our persistent ID is simply a tuple, containing a tag and a
            # key, which refers to a specific record in the database.
            return ("MemoRecord", obj.key)
        else:
            # If obj does not have a persistent ID, return None. This means obj
            # needs to be pickled as usual.
            return None


class DBUnpickler(pickle.Unpickler):

    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection

    def persistent_load(self, pid):
        # This method is invoked whenever a persistent ID is encountered.
        # Here, pid is the tuple returned by DBPickler.
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # Fetch the referenced record from the database and return it.
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # Always raises an error if you cannot return the correct object.
            # Otherwise, the unpickler will think None is the object referenced
            # by the persistent ID.
            raise pickle.UnpicklingError("unsupported persistent object")


def main():
    import io
    import pprint

    # Initialize and populate our database.
    conn = sqlite3.connect(":memory:")
    cursor = conn.cursor()
    cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
    tasks = (
        'give food to fish',
        'prepare group meeting',
        'fight with a zebra',
        )
    for task in tasks:
        cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))

    # Fetch the records to be pickled.
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # Save the records using our custom DBPickler.
    file = io.BytesIO()
    DBPickler(file).dump(memos)

    print("Pickled records:")
    pprint.pprint(memos)

    # Update a record, just for good measure.
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

    # Load the records from the pickle data stream.
    file.seek(0)
    memos = DBUnpickler(file, conn).load()

    print("Unpickled records:")
    pprint.pprint(memos)


if __name__ == '__main__':
    main()
@end example

@node Tablas de despacho,Manejo de objetos con estado,Persistencia de objetos externos,Pickling de Instancias de clases
@anchor{library/pickle dispatch-tables}@anchor{289b}@anchor{library/pickle pickle-dispatch}@anchor{288d}
@subsubsection Tablas de despacho


Si se desea personalizar el @cite{pickling} de algunas clases sin alterar ningún otro código que dependa del @cite{pickling}, se puede crear un @cite{pickler} con una tabla de despacho privada.

The global dispatch table managed by the @ref{27,,copyreg} module is
available as @code{copyreg.dispatch_table}.  Therefore, one may
choose to use a modified copy of @code{copyreg.dispatch_table} as a
private dispatch table.

Por ejemplo

@example
f = io.BytesIO()
p = pickle.Pickler(f)
p.dispatch_table = copyreg.dispatch_table.copy()
p.dispatch_table[SomeClass] = reduce_SomeClass
@end example

crea una instancia de @ref{ab0,,pickle.Pickler} con una tabla de despacho privada que maneja la clase @code{AlgunaClase} especialmente.  Alternativamente, el código

@example
class MyPickler(pickle.Pickler):
    dispatch_table = copyreg.dispatch_table.copy()
    dispatch_table[SomeClass] = reduce_SomeClass
f = io.BytesIO()
p = MyPickler(f)
@end example

hace lo mismo, pero todas las instancias de @code{MyPickler} compartirán de forma predeterminada la tabla de despacho privada. Por otro lado, el código

@example
copyreg.pickle(SomeClass, reduce_SomeClass)
f = io.BytesIO()
p = pickle.Pickler(f)
@end example

modifica la tabla de despacho global compartida por todos los usuarios del módulo @ref{27,,copyreg}.

@node Manejo de objetos con estado,,Tablas de despacho,Pickling de Instancias de clases
@anchor{library/pickle handling-stateful-objects}@anchor{289c}@anchor{library/pickle pickle-state}@anchor{2899}
@subsubsection Manejo de objetos con estado


@geindex __getstate__() (copy protocol)
@geindex __setstate__() (copy protocol)

Here’s an example that shows how to modify pickling behavior for a class.
The @code{TextReader} class below opens a text file, and returns the line number and
line contents each time its @code{readline()} method is called. If a
@code{TextReader} instance is pickled, all attributes `except' the file object
member are saved. When the instance is unpickled, the file is reopened, and
reading resumes from the last location. The @code{__setstate__()} and
@code{__getstate__()} methods are used to implement this behavior.

@example
class TextReader:
    """Print and number lines in a text file."""

    def __init__(self, filename):
        self.filename = filename
        self.file = open(filename)
        self.lineno = 0

    def readline(self):
        self.lineno += 1
        line = self.file.readline()
        if not line:
            return None
        if line.endswith('\n'):
            line = line[:-1]
        return "%i: %s" % (self.lineno, line)

    def __getstate__(self):
        # Copy the object's state from self.__dict__ which contains
        # all our instance attributes. Always use the dict.copy()
        # method to avoid modifying the original state.
        state = self.__dict__.copy()
        # Remove the unpicklable entries.
        del state['file']
        return state

    def __setstate__(self, state):
        # Restore instance attributes (i.e., filename and lineno).
        self.__dict__.update(state)
        # Restore the previously opened file's state. To do so, we need to
        # reopen it and read from it until the line count is restored.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Finally, save the file.
        self.file = file
@end example

Un ejemplo de uso podría ser algo como esto:

@example
>>> reader = TextReader("hello.txt")
>>> reader.readline()
'1: Hello world!'
>>> reader.readline()
'2: I am line number two.'
>>> new_reader = pickle.loads(pickle.dumps(reader))
>>> new_reader.readline()
'3: Goodbye!'
@end example

@node Reducción personalizada para tipos funciones y otros objetos,Búferes fuera de banda,Pickling de Instancias de clases,pickle — Python object serialization
@anchor{library/pickle custom-reduction-for-types-functions-and-other-objects}@anchor{289d}@anchor{library/pickle reducer-override}@anchor{288e}
@subsubsection Reducción personalizada para tipos, funciones y otros objetos



Added in version 3.8.


A veces, @ref{1194,,dispatch_table} puede no ser lo suficientemente flexible. En particular, es posible que deseemos personalizar el @cite{pickling} en función de otro criterio que no sea el tipo de objeto, o es posible que deseemos personalizar el @cite{pickling} de funciones y clases.

For those cases, it is possible to subclass from the @ref{ab0,,Pickler} class and
implement a @ref{ab1,,reducer_override()} method. This method can return an
arbitrary reduction tuple (see @ref{a65,,__reduce__()}). It can alternatively return
@ref{227,,NotImplemented} to fallback to the traditional behavior.

Si se definen tanto @ref{1194,,dispatch_table} como @ref{ab1,,reducer_override()}, entonces @ref{ab1,,reducer_override()} tiene prioridad.

@cartouche
@quotation Nota 
Por motivos de rendimiento, no se puede llamar a @ref{ab1,,reducer_override()} para los siguientes objetos: @code{None}, @code{True}, @code{False}, e instancias exactas de @ref{1f0,,int}, @ref{153,,float}, @ref{325,,bytes}, @ref{237,,str}, @ref{190,,dict}, @ref{67a,,set}, @ref{67b,,frozenset}, @ref{18e,,list} y @ref{464,,tuple}.
@end quotation
@end cartouche

Aquí hay un ejemplo simple donde permitimos el @cite{pickling} y reconstruir una clase dada class:

@example
import io
import pickle

class MyClass:
    my_attribute = 1

class MyPickler(pickle.Pickler):
    def reducer_override(self, obj):
        """Custom reducer for MyClass."""
        if getattr(obj, "__name__", None) == "MyClass":
            return type, (obj.__name__, obj.__bases__,
                          @{'my_attribute': obj.my_attribute@})
        else:
            # For any other object, fallback to usual reduction
            return NotImplemented

f = io.BytesIO()
p = MyPickler(f)
p.dump(MyClass)

del MyClass

unpickled_class = pickle.loads(f.getvalue())

assert isinstance(unpickled_class, type)
assert unpickled_class.__name__ == "MyClass"
assert unpickled_class.my_attribute == 1
@end example

@node Búferes fuera de banda,Restricción de globals,Reducción personalizada para tipos funciones y otros objetos,pickle — Python object serialization
@anchor{library/pickle out-of-band-buffers}@anchor{289e}@anchor{library/pickle pickle-oob}@anchor{288a}
@subsubsection Búferes fuera de banda



Added in version 3.8.


En algunos contextos, el módulo @ref{a6,,pickle} se usa para transferir cantidades masivas de datos.  Por lo tanto, puede ser importante minimizar el número de copias de memoria para preservar el rendimiento y el consumo de recursos.  Sin embargo, el funcionamiento normal del módulo @ref{a6,,pickle}, ya que transforma una estructura gráfica de objetos en un flujo secuencial de bytes, implica intrínsecamente copiar datos hacia y desde el flujo @cite{pickle}.

Esta restricción puede evitarse si tanto el `proveedor' (la implementación de los tipos de objeto a transferir) como el `consumidor' (a implementación del sistema de comunicaciones) admiten las facilidades de transferencia fuera de banda proporcionadas por el protocolo @cite{pickle} 5 y mayor.

@menu
* API de proveedor:: 
* API de consumidor:: 
* Ejemplo: Ejemplo<4>. 

@end menu

@node API de proveedor,API de consumidor,,Búferes fuera de banda
@anchor{library/pickle provider-api}@anchor{289f}
@subsubsection API de proveedor


The large data objects to be pickled must implement a @ref{1609,,__reduce_ex__()}
method specialized for protocol 5 and higher, which returns a
@ref{17ff,,PickleBuffer} instance (instead of e.g. a @ref{325,,bytes} object)
for any large data.

Un objeto @ref{17ff,,PickleBuffer} `indica' que el búfer subyacente es elegible para la transferencia de datos fuera de banda.  Estos objetos siguen siendo compatibles con el uso normal del módulo @ref{a6,,pickle} .  Sin embargo, los consumidores también pueden optar por decirle a @ref{a6,,pickle} que manejarán esos búferes por sí mismos.

@node API de consumidor,Ejemplo<4>,API de proveedor,Búferes fuera de banda
@anchor{library/pickle consumer-api}@anchor{28a0}
@subsubsection API de consumidor


Un sistema de comunicaciones puede permitir el manejo personalizado de los objetos @ref{17ff,,PickleBuffer} generados al serializar un gráfico de objetos.

En el lado del envío, necesita pasar un argumento `buffer_callback' a @ref{ab0,,Pickler} (o a las funciones @ref{2886,,dump()} o @ref{14de,,dumps()}), que se llamará con cada @ref{17ff,,PickleBuffer} generado al hacer @cite{pickling} del gráfico del objeto.  Los búferes acumulados por `buffer_callback' no verán sus datos copiados en el flujo de @cite{pickle}, solo se insertará un marcador barato.

En el lado receptor, necesita pasar un argumento `buffers' a @ref{16b1,,Unpickler} (o a las funciones @ref{d97,,load()} o @ref{d98,,loads()}), que es un iterable de los búferes que fueron pasado a `buffer_callback'. Ese iterable debería producir búferes en el mismo orden en que se pasaron a `buffer_callback'.   Esos búferes proporcionarán los datos esperados por los reconstructores de los objetos cuyo @cite{pickling} produjo los objetos originales @ref{17ff,,PickleBuffer}.

Entre el lado de envío y el lado de recepción, el sistema de comunicaciones es libre de implementar su propio mecanismo de transferencia para memorias intermedias fuera de banda. Las posibles optimizaciones incluyen el uso de memoria compartida o compresión dependiente del tipo de datos.

@node Ejemplo<4>,,API de consumidor,Búferes fuera de banda
@anchor{library/pickle example}@anchor{28a1}
@subsubsection Ejemplo


Aquí hay un ejemplo trivial donde implementamos una subclase @ref{5e0,,bytearray} capaz de participar en el @cite{pickling} de un búfer fuera de banda:

@example
class ZeroCopyByteArray(bytearray):

    def __reduce_ex__(self, protocol):
        if protocol >= 5:
            return type(self)._reconstruct, (PickleBuffer(self),), None
        else:
            # PickleBuffer is forbidden with pickle protocols <= 4.
            return type(self)._reconstruct, (bytearray(self),)

    @@classmethod
    def _reconstruct(cls, obj):
        with memoryview(obj) as m:
            # Get a handle over the original buffer object
            obj = m.obj
            if type(obj) is cls:
                # Original buffer object is a ZeroCopyByteArray, return it
                # as-is.
                return obj
            else:
                return cls(obj)
@end example

El reconstructor (el método de clase @code{_reconstruct}) retorna el objeto que proporciona el búfer si tiene el tipo correcto.  Esta es una manera fácil de simular el comportamiento de copia cero en este ejemplo de juguete.

En el lado del consumidor, podemos serializar con @cite{pickle} esos objetos de la forma habitual, que cuando no se serializan nos dará una copia del objeto original:

@example
b = ZeroCopyByteArray(b"abc")
data = pickle.dumps(b, protocol=5)
new_b = pickle.loads(data)
print(b == new_b)  # True
print(b is new_b)  # False: a copy was made
@end example

Pero si pasamos un `buffer_callback' y luego retornamos los búferes acumulados al anular la serialización, podemos recuperar el objeto original:

@example
b = ZeroCopyByteArray(b"abc")
buffers = []
data = pickle.dumps(b, protocol=5, buffer_callback=buffers.append)
new_b = pickle.loads(data, buffers=buffers)
print(b == new_b)  # True
print(b is new_b)  # True: no copy was made
@end example

Este ejemplo está limitado por el hecho de que @ref{5e0,,bytearray} asigna su propia memoria: no puedes crear una instancia de @ref{5e0,,bytearray} que esté respaldada por la memoria de otro objeto.  Sin embargo, los tipos de datos de terceros, como las matrices NumPy no tienen esta limitación y permiten el uso de @cite{pickling} de copia cero (o realizar la menor cantidad de copias posible) cuando se transfieren entre procesos o sistemas distintos.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} – Protocolo Pickle 5 con datos fuera de banda


@node Restricción de globals,Performance,Búferes fuera de banda,pickle — Python object serialization
@anchor{library/pickle pickle-restrict}@anchor{2893}@anchor{library/pickle restricting-globals}@anchor{28a2}
@subsubsection Restricción de globals


@geindex find_class() (pickle protocol)

De forma predeterminada, el @cite{unpickling} importará cualquier clase o función que encuentre en los datos de @cite{pickle}.  Para muchas aplicaciones, este comportamiento es inaceptable, ya que permite al @cite{unpickler} importar e invocar código arbitrario.  Solo considere lo que hace este flujo de datos de @cite{pickle} hechos a mano cuando se carga:

@example
>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0
@end example

En este ejemplo, el @cite{unpickler} importa la función @ref{149a,,os.system()} y luego aplica el argumento de cadena @cite{«echo hello world»}.  Aunque este ejemplo es inofensivo, no es difícil imaginar uno que pueda dañar su sistema.

Por esta razón, es posible que desee controlar lo que se deserializa con @cite{pickle} personalizando @ref{2892,,Unpickler.find_class()}.  A diferencia de lo que sugiere su nombre, @ref{2892,,Unpickler.find_class()} se llama siempre que se solicita un global (es decir, una clase o una función).  Por lo tanto, es posible prohibir completamente los globales o restringirlos a un subconjunto seguro.

Aquí hay un ejemplo de un @cite{unpickler} que permite cargar solo unas pocas clases seguras del módulo @ref{13,,builtins}:

@example
import builtins
import io
import pickle

safe_builtins = @{
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
@}

class RestrictedUnpickler(pickle.Unpickler):

    def find_class(self, module, name):
        # Only allow safe classes from builtins.
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # Forbid everything else.
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))

def restricted_loads(s):
    """Helper function analogous to pickle.loads()."""
    return RestrictedUnpickler(io.BytesIO(s)).load()
@end example

Un ejemplo de uso de nuestro deserializador que funciona según lo previsto:

@example
>>> restricted_loads(pickle.dumps([1, 2, range(15)]))
[1, 2, range(0, 15)]
>>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'os.system' is forbidden
>>> restricted_loads(b'cbuiltins\neval\n'
...                  b'(S\'getattr(__import__("os"), "system")'
...                  b'("echo hello world")\'\ntR.')
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'builtins.eval' is forbidden
@end example

@c XXX Add note about how extension codes could evade our protection
@c mechanism (e.g. cached classes do not invokes find_class()).

Como muestran nuestros ejemplos, debes tener cuidado con lo que permites que se deserialize con @cite{pickle}.  Por lo tanto, si la seguridad es un problema, puede considerar alternativas como la API de @cite{marshalling} en @ref{12d,,xmlrpc.client} o soluciones de terceros.

@node Performance,Ejemplos<6>,Restricción de globals,pickle — Python object serialization
@anchor{library/pickle performance}@anchor{28a3}
@subsubsection Performance


Las versiones recientes del protocolo @cite{pickle} (desde el protocolo 2 en adelante) cuentan con codificaciones binarias eficientes para varias características comunes y tipos integrados. Además, el módulo @ref{a6,,pickle} tiene un optimizador transparente escrito en C.

@node Ejemplos<6>,,Performance,pickle — Python object serialization
@anchor{library/pickle examples}@anchor{28a4}@anchor{library/pickle pickle-example}@anchor{28a5}
@subsubsection Ejemplos


Para obtener el código más simple, use las funciones @ref{2886,,dump()} y @ref{d97,,load()}.

@example
import pickle

# An arbitrary collection of objects supported by pickle.
data = @{
    'a': [1, 2.0, 3+4j],
    'b': ("character string", b"byte string"),
    'c': @{None, True, False@}
@}

with open('data.pickle', 'wb') as f:
    # Pickle the 'data' dictionary using the highest protocol available.
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)
@end example

El siguiente ejemplo lee los datos serializados con @cite{pickle} resultantes.

@example
import pickle

with open('data.pickle', 'rb') as f:
    # The protocol version used is detected automatically, so we do not
    # have to specify it.
    data = pickle.load(f)
@end example

@c XXX: Add examples showing how to optimize pickles for size (like using

@c pickletools.optimize() or the gzip module).


@subsubheading Ver también



@table @asis

@item Módulo @ref{27,,copyreg}

Registro de constructor de interfaz @cite{Pickle} para tipos de extensión.

@item Módulo @ref{a7,,pickletools}

Herramientas para trabajar y analizar datos serializados con @cite{pickle}.

@item Módulo @ref{c3,,shelve}

Bases de datos indexadas de objetos; usa @ref{a6,,pickle}.

@item Módulo @ref{26,,copy}

Copia de objetos superficial y profunda.

@item Módulo @ref{8d,,marshal}

Serialización de alto rendimiento de tipos integrados.
@end table


@subsubheading Notas al pie


@node copyreg — Register pickle support functions,shelve — Python object persistence,pickle — Python object serialization,Persistencia de datos
@anchor{library/copyreg doc}@anchor{28a6}@anchor{library/copyreg copyreg-register-pickle-support-functions}@anchor{28a7}@anchor{library/copyreg module-copyreg}@anchor{27}
@subsection @code{copyreg} — Register @code{pickle} support functions


@geindex module; copyreg

`Código fuente:' Lib/copyreg.py@footnote{https://github.com/python/cpython/tree/main/Lib/copyreg.py}

@geindex module;pickle
@geindex module;copy


__________________________________________________________________


El módulo @ref{27,,copyreg} ofrece una manera de definir las funciones usadas cuando se serializan (`pickling') objetos específicos. Los módulos @ref{a6,,pickle} y @ref{26,,copy} utilizan estas funciones cuando se realizan acciones de serializado/copiado en esos objetos. El módulo provee información de configuración acerca de los objetos constructores, los cuales no son clases. Estos objetos constructores pueden ser funciones-fábrica o instancias de clase.

@geindex constructor() (en el módulo copyreg)
@anchor{library/copyreg copyreg constructor}@anchor{28a8}
@deffn {Función} copyreg.constructor (object)

Declara que el `object' es un constructor válido. Si el `object' no es invocable (y por lo tanto, no es válido como constructor), lanza una excepción @ref{228,,TypeError}.
@end deffn

@geindex pickle() (en el módulo copyreg)
@anchor{library/copyreg copyreg pickle}@anchor{288c}
@deffn {Función} copyreg.pickle (type, function, constructor_ob=None)

Declares that `function' should be used as a «reduction» function for objects
of type `type'.  `function' must return either a string or a tuple
containing between two and six elements. See the @ref{1194,,dispatch_table}
for more details on the interface of `function'.

El parámetro `constructor_ob' es una característica heredada y ahora se ignora, pero si se pasa debe ser invocable.

Note que el atributo @ref{1194,,dispatch_table} de un objeto pickler o subclase de @ref{ab0,,pickle.Pickler} también puede ser utilizado para declarar funciones de reducción.
@end deffn

@menu
* Ejemplo: Ejemplo<5>. 

@end menu

@node Ejemplo<5>,,,copyreg — Register pickle support functions
@anchor{library/copyreg example}@anchor{28a9}
@subsubsection Ejemplo


El siguiente ejemplo pretende mostrar cómo registrar una función pickle y cómo se utilizará:

@example
>>> import copyreg, copy, pickle
>>> class C:
...     def __init__(self, a):
...         self.a = a
...
>>> def pickle_c(c):
...     print("pickling a C instance...")
...     return C, (c.a,)
...
>>> copyreg.pickle(C, pickle_c)
>>> c = C(1)
>>> d = copy.copy(c)  
pickling a C instance...
>>> p = pickle.dumps(c)  
pickling a C instance...
@end example

@node shelve — Python object persistence,marshal — Internal Python object serialization,copyreg — Register pickle support functions,Persistencia de datos
@anchor{library/shelve doc}@anchor{28aa}@anchor{library/shelve module-shelve}@anchor{c3}@anchor{library/shelve shelve-python-object-persistence}@anchor{28ab}
@subsection @code{shelve} — Python object persistence


@geindex module; shelve

`Source code:' Lib/shelve.py@footnote{https://github.com/python/cpython/tree/main/Lib/shelve.py}

@geindex module;pickle


__________________________________________________________________


Un «estante» o `shelve', es un objeto persistente similar a un diccionario.  La diferencia con las bases de datos «dbm» es que los valores (¡no las claves!) en un estante pueden ser esencialmente objetos Python arbitrarios — cualquier cosa que el módulo @ref{a6,,pickle} pueda manejar. Esto incluye la mayoría de las instancias de clase, tipos de datos recursivos y objetos que contienen muchos subobjetos compartidos.  Las claves son cadenas ordinarias.

@geindex open() (en el módulo shelve)
@anchor{library/shelve shelve open}@anchor{1706}
@deffn {Función} shelve.open (filename, flag='c', protocol=None, writeback=False)

Abre un diccionario persistente.  El nombre de archivo especificado es el nombre de archivo base para la base de datos subyacente.  Como efecto secundario, se puede agregar una extensión al nombre de archivo y se puede crear más de un archivo.  De forma predeterminada, el archivo de base de datos subyacente se abre para leer y escribir.  El parámetro opcional `flag' tiene la misma interpretación que el parámetro `flag' de @ref{fac,,dbm.open()}.

By default, pickles created with @ref{8c5,,pickle.DEFAULT_PROTOCOL} are used
to serialize values.  The version of the pickle protocol can be specified
with the `protocol' parameter.

Debido a la semántica de Python, un estante no puede saber cuándo se modifica una entrada de diccionario persistente mutable.  De forma predeterminada, los objetos modificados se escriben `sólo' cuando se asignan al estante (consulte @ref{28ac,,Ejemplo}).  Si el parámetro opcional `writeback' se establece en @code{True}, todas las entradas a las que se accede también se almacenan en caché en la memoria y se vuelven a escribir en @ref{28ad,,sync()} y @ref{28ae,,close()}; esto puede hacer que sea más práctico mutar entradas mutables en el diccionario persistente, pero, si se accede a muchas entradas, puede consumir grandes cantidades de memoria para la memoria caché, y puede hacer que la operación de cierre sea muy lenta ya que todas las entradas a las que se accede se vuelven a escribir (no hay manera de determinar qué entradas a las que se accede son mutables, ni cuáles se mutaron realmente).


Distinto en la versión 3.10: @ref{8c5,,pickle.DEFAULT_PROTOCOL} is now used as the default pickle
protocol.



Distinto en la versión 3.11: Acepta @ref{3f0,,path-like object} por nombre de archivo.


@cartouche
@quotation Nota 
No confíe en que el estante se cerrará automáticamente; siempre llame a @ref{28ae,,close()}  explícitamente cuando ya no lo necesite, o use @ref{1706,,shelve.open()} como administrador de contexto:

@example
with shelve.open('spam') as db:
    db['eggs'] = 'eggs'
@end example
@end quotation
@end cartouche
@end deffn
@anchor{library/shelve shelve-security}@anchor{28af}
@cartouche
@quotation Advertencia 
Debido a que el módulo @ref{c3,,shelve} está respaldado por @ref{a6,,pickle}, es inseguro cargar un estante desde una fuente que no es de confianza. Al igual que con el `pickle', cargar un estante puede ejecutar código arbitrario.
@end quotation
@end cartouche

Los objetos de estante admiten la mayoría de los métodos y operaciones admitidos por los diccionarios (excepto copiar, constructores y los operadores @code{|} y @code{|=}). Esto facilita la transición de scripts basados en diccionarios a aquellos que requieren almacenamiento persistente.

Se admiten dos métodos adicionales:

@geindex sync() (método de shelve.Shelf)
@anchor{library/shelve shelve Shelf sync}@anchor{28ad}
@deffn {Método} Shelf.sync ()

Escriba todas las entradas en la caché si el estante se abrió con `writeback' establecido en @ref{c95,,True}. También vacíe la caché y sincronice el diccionario persistente en el disco, si es posible. Esto se llama automáticamente cuando el estante se cierra con @ref{28ae,,close()}.
@end deffn

@geindex close() (método de shelve.Shelf)
@anchor{library/shelve shelve Shelf close}@anchor{28ae}
@deffn {Método} Shelf.close ()

Sincronice y cierre el objeto persistente `dict'. Las operaciones en un estante cerrado fallarán con un @ref{360,,ValueError}.
@end deffn


@subsubheading Ver también


Persistent dictionary recipe@footnote{https://code.activestate.com/recipes/576642-persistent-dict-with-multiple-standard-file-format/}
with widely supported storage formats and having the speed of native
dictionaries.


@menu
* Restricciones:: 
* Ejemplo: Ejemplo<6>. 

@end menu

@node Restricciones,Ejemplo<6>,,shelve — Python object persistence
@anchor{library/shelve restrictions}@anchor{28b0}
@subsubsection Restricciones


@geindex module;dbm.ndbm
@geindex module;dbm.gnu


@itemize *

@item 
La elección de qué paquete de base de datos se utilizará (como @ref{35,,dbm.ndbm} o @ref{34,,dbm.gnu}) depende de la interfaz disponible. Por lo tanto, no es seguro abrir la base de datos directamente usando @ref{32,,dbm}. La base de datos también está (desafortunadamente) sujeta a las limitaciones de @ref{32,,dbm}, si se usa — esto significa que (la representación `pickle' de) los objetos almacenados en la base de datos debe ser bastante pequeña, y en casos raros las colisiones de claves pueden hacer que la base de datos rechace las actualizaciones.

@item 
El módulo @ref{c3,,shelve} no admite el acceso `concurrent' de lectura/escritura a los objetos almacenados. (Los accesos de lectura múltiples simultáneos son seguros). Cuando un programa tiene un estante abierto para escritura, ningún otro programa debe tenerlo abierto para lectura o escritura. El bloqueo de archivos Unix se puede usar para resolver esto, pero esto difiere entre las versiones de Unix y requiere conocimiento sobre la implementación de la base de datos utilizada.

@item 
On macOS @ref{35,,dbm.ndbm} can silently corrupt the database file on updates,
which can cause hard crashes when trying to read from the database.
@end itemize

@geindex Shelf (clase en shelve)
@anchor{library/shelve shelve Shelf}@anchor{1019}
@deffn {Clase} shelve.Shelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

Una subclase de @ref{1123,,collections.abc.MutableMapping} que almacena valores `pickle' en el objeto `dict'.

By default, pickles created with @ref{8c5,,pickle.DEFAULT_PROTOCOL} are used
to serialize values.  The version of the pickle protocol can be specified
with the `protocol' parameter.  See the @ref{a6,,pickle} documentation for a
discussion of the pickle protocols.

Si el parámetro `writeback' es @code{True}, el objeto mantendrá un caché de todas las entradas a las que se accedió y las volverá a escribir en el `dict' en las horas de sincronización y cierre. Esto permite operaciones naturales en entradas mutables, pero puede consumir mucha más memoria y hacer que la sincronización y el cierre tomen mucho tiempo.

El parámetro `keyencoding' es la codificación utilizada para codificar las claves antes de que se utilicen con el `dict' subyacente.

El objeto @ref{1019,,Shelf} también se puede utilizar como administrador de contexto, en cuyo caso se cerrará automáticamente cuando finalice el bloque @ref{673,,with}.


Distinto en la versión 3.2: Se agregó el parámetro `keyencoding'; anteriormente, las claves siempre estaban codificadas en UTF-8.



Distinto en la versión 3.4: Agregado soporte para administrador de contexto.



Distinto en la versión 3.10: @ref{8c5,,pickle.DEFAULT_PROTOCOL} is now used as the default pickle
protocol.

@end deffn

@geindex BsdDbShelf (clase en shelve)
@anchor{library/shelve shelve BsdDbShelf}@anchor{225d}
@deffn {Clase} shelve.BsdDbShelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

A subclass of @ref{1019,,Shelf} which exposes @code{first()}, @code{next()},
@code{previous()}, @code{last()} and @code{set_location()} methods.
These are available
in the third-party @code{bsddb} module from pybsddb@footnote{https://www.jcea.es/programacion/pybsddb.htm} but not in other database
modules.  The `dict' object passed to the constructor must support those
methods.  This is generally accomplished by calling one of
@code{bsddb.hashopen()}, @code{bsddb.btopen()} or @code{bsddb.rnopen()}.  The
optional `protocol', `writeback', and `keyencoding' parameters have the same
interpretation as for the @ref{1019,,Shelf} class.
@end deffn

@geindex DbfilenameShelf (clase en shelve)
@anchor{library/shelve shelve DbfilenameShelf}@anchor{225e}
@deffn {Clase} shelve.DbfilenameShelf (filename, flag='c', protocol=None, writeback=False)

Una subclase de @ref{1019,,Shelf} que acepta un `filename' en lugar de un objeto tipo diccionario (`dict'). El archivo subyacente se abrirá usando @ref{fac,,dbm.open()}. De forma predeterminada, el archivo se creará y se abrirá tanto para lectura como para escritura. El parámetro opcional `flag' tiene la misma interpretación que para la función @ref{1706,,open()}. Los parámetros opcionales `protocol' y `writeback' tienen la misma interpretación que para la clase @ref{1019,,Shelf}.
@end deffn

@node Ejemplo<6>,,Restricciones,shelve — Python object persistence
@anchor{library/shelve example}@anchor{28b1}@anchor{library/shelve shelve-example}@anchor{28ac}
@subsubsection Ejemplo


Para resumir la interfaz (@code{key} es una cadena de caracteres, @code{data} es un objeto arbitrario):

@example
import shelve

d = shelve.open(filename)  # open -- file may get suffix added by low-level
                           # library

d[key] = data              # store data at key (overwrites old data if
                           # using an existing key)
data = d[key]              # retrieve a COPY of data at key (raise KeyError
                           # if no such key)
del d[key]                 # delete data stored at key (raises KeyError
                           # if no such key)

flag = key in d            # true if the key exists
klist = list(d.keys())     # a list of all existing keys (slow!)

# as d was opened WITHOUT writeback=True, beware:
d['xx'] = [0, 1, 2]        # this works as expected, but...
d['xx'].append(3)          # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]!

# having opened d without writeback=True, you need to code carefully:
temp = d['xx']             # extracts the copy
temp.append(5)             # mutates the copy
d['xx'] = temp             # stores the copy right back, to persist it

# or, d=shelve.open(filename,writeback=True) would let you just code
# d['xx'].append(5) and have it work as expected, BUT it would also
# consume more memory and make the d.close() operation slower.

d.close()                  # close it
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{32,,dbm}

Interfaz genérica para bases de datos estilo @code{dbm}.

@item Módulo @ref{a6,,pickle}

Serialización de objetos utilizada por @ref{c3,,shelve}.
@end table


@node marshal — Internal Python object serialization,dbm — Interfaces to Unix «databases»,shelve — Python object persistence,Persistencia de datos
@anchor{library/marshal doc}@anchor{28b2}@anchor{library/marshal marshal-internal-python-object-serialization}@anchor{28b3}@anchor{library/marshal module-marshal}@anchor{8d}
@subsection @code{marshal} — Internal Python object serialization


@geindex module; marshal


__________________________________________________________________


This module contains functions that can read and write Python values in a binary
format.  The format is specific to Python, but independent of machine
architecture issues (e.g., you can write a Python value to a file on a PC,
transport the file to a Mac, and read it back there).  Details of the format are
undocumented on purpose; it may change between Python versions (although it
rarely does). @footnote{
El nombre de este módulo proviene de algunos términos utilizados por los diseñadores de Modula-3 (entre otros), que utilizan el término «marshalling» para el envío de datos de forma auto-contenida. Estrictamente hablando «marshalling», significa convertir algunos datos internos en un formato externo (por ejemplo, en un búfer RPC) y «unmarshalling» es el proceso inverso.
}

@geindex module;pickle
@geindex module;shelve

This is not a general «persistence» module.  For general persistence and
transfer of Python objects through RPC calls, see the modules @ref{a6,,pickle} and
@ref{c3,,shelve}.  The @ref{8d,,marshal} module exists mainly to support reading and
writing the «pseudo-compiled» code for Python modules of @code{.pyc} files.
Therefore, the Python maintainers reserve the right to modify the marshal format
in backward incompatible ways should the need arise.
The format of code objects is not compatible between Python versions,
even if the version of the format is the same.
De-serializing a code object in the incorrect Python version has undefined behavior.
If you’re serializing and
de-serializing Python objects, use the @ref{a6,,pickle} module instead – the
performance is comparable, version independence is guaranteed, and pickle
supports a substantially wider range of objects than marshal.

@cartouche
@quotation Advertencia 
El módulo @ref{8d,,marshal} no está destinado a ser seguro contra datos erróneos o construidos maliciosamente.  Nunca deserializar con marshal los datos recibidos de una fuente no confiable o no autenticada.
@end quotation
@end cartouche

Hay funciones que leen/escriben archivos, así como funciones que operan en objetos similares a bytes.

@geindex object;code
@geindex code object

Not all Python object types are supported; in general, only objects whose value
is independent from a particular invocation of Python can be written and read by
this module.  The following types are supported:


@itemize *

@item 
Numeric types: @ref{1f0,,int}, @ref{513,,bool}, @ref{153,,float}, @ref{154,,complex}.

@item 
Strings (@ref{237,,str}) and @ref{325,,bytes}.
@ref{db4,,Bytes-like objects} like @ref{5e0,,bytearray} are
marshalled as @code{bytes}.

@item 
Containers: @ref{464,,tuple}, @ref{18e,,list}, @ref{67a,,set}, @ref{67b,,frozenset},
and (since @ref{28b4,,version} 5), @ref{514,,slice}.
It should be understood that these are supported only if the values contained
therein are themselves supported.
Recursive containers are supported since @ref{28b4,,version} 3.

@item 
The singletons @ref{716,,None}, @ref{218d,,Ellipsis} and @ref{c82,,StopIteration}.

@item 
@ref{1b,,code} objects, if `allow_code' is true. See note above about
version dependence.
@end itemize


Distinto en la versión 3.4: 


@itemize *

@item 
Added format version 3, which supports marshalling recursive lists, sets
and dictionaries.

@item 
Added format version 4, which supports efficient representations
of short strings.
@end itemize



Distinto en la versión 3.14.0a1 (unreleased): Added format version 5, which allows marshalling slices.


El módulo define estas funciones:

@geindex dump() (en el módulo marshal)
@anchor{library/marshal marshal dump}@anchor{28b5}
@deffn {Función} marshal.dump (value, file, version=version, /, *, allow_code=True)

Escribe el valor en el archivo abierto.  El valor debe ser un tipo admitido.  El archivo debe ser un archivo @ref{1c8e,,binary file} en el que se pueda escribir.

If the value has (or contains an object that has) an unsupported type, a
@ref{360,,ValueError} exception is raised — but garbage data will also be written
to the file.  The object will not be properly read back by @ref{1a1b,,load()}.
@ref{335,,Code objects} are only supported if `allow_code' is true.

El argumento `version' indica el formato de datos que @code{dump} debe usar (véase más adelante).

Lanza un @ref{18c3,,evento de auditoría} @code{marshal.dumps} con argumentos @code{value}, @code{version}.


Distinto en la versión 3.13: Added the `allow_code' parameter.

@end deffn

@geindex load() (en el módulo marshal)
@anchor{library/marshal marshal load}@anchor{1a1b}
@deffn {Función} marshal.load (file, /, *, allow_code=True)

Read one value from the open file and return it.  If no valid value is read
(e.g. because the data has a different Python version’s incompatible marshal
format), raise @ref{1341,,EOFError}, @ref{360,,ValueError} or @ref{228,,TypeError}.
@ref{335,,Code objects} are only supported if `allow_code' is true.
The file must be a readable @ref{1c8e,,binary file}.

Lanza un @ref{18c3,,evento de auditoría} @code{marshal.load} sin argumentos.

@cartouche
@quotation Nota 
Si un objeto que contiene un tipo no admitido se calcula con @ref{28b5,,dump()}, @ref{1a1b,,load()} sustituirá @code{None} por el tipo «unmarshallable».
@end quotation
@end cartouche


Distinto en la versión 3.10: Esta llamada solía lanzar un evento de auditoría @code{code.__new__} para cada objeto código. Ahora lanza un único evento @code{marshal.load} para toda la operación de carga.



Distinto en la versión 3.13: Added the `allow_code' parameter.

@end deffn

@geindex dumps() (en el módulo marshal)
@anchor{library/marshal marshal dumps}@anchor{f26}
@deffn {Función} marshal.dumps (value, version=version, /, *, allow_code=True)

Return the bytes object that would be written to a file by @code{dump(value, file)}.  The
value must be a supported type.  Raise a @ref{360,,ValueError} exception if value
has (or contains an object that has) an unsupported type.
@ref{335,,Code objects} are only supported if `allow_code' is true.

El argumento `version' indica el formato de datos que @code{dumps} debe usar (véase más adelante).

Lanza un @ref{18c3,,evento de auditoría} @code{marshal.dumps} con argumentos @code{value}, @code{version}.


Distinto en la versión 3.13: Added the `allow_code' parameter.

@end deffn

@geindex loads() (en el módulo marshal)
@anchor{library/marshal marshal loads}@anchor{28b6}
@deffn {Función} marshal.loads (bytes, /, *, allow_code=True)

Convert the @ref{db4,,bytes-like object} to a value.  If no valid value is found, raise
@ref{1341,,EOFError}, @ref{360,,ValueError} or @ref{228,,TypeError}.
@ref{335,,Code objects} are only supported if `allow_code' is true.
Extra bytes in the input are ignored.

Lanza un @ref{18c3,,evento de auditoría} @code{marshal.loads} con argumento @code{bytes}.


Distinto en la versión 3.10: Esta llamada solía lanzar un evento de auditoría @code{code.__new__} para cada objeto código. Ahora lanza un único evento @code{marshal.loads} para toda la operación de carga.



Distinto en la versión 3.13: Added the `allow_code' parameter.

@end deffn

Además, se definen las siguientes constantes:

@geindex version (en el módulo marshal)
@anchor{library/marshal marshal version}@anchor{28b4}
@deffn {Dato} marshal.version

Indicates the format that the module uses.
Version 0 is the historical first version; subsequent versions
add new features.
Generally, a new version becomes the default when it is introduced.


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Version

@tab

Available since

@tab

New features

@item

1

@tab

Python 2.4

@tab

Sharing interned strings

@item

2

@tab

Python 2.5

@tab

Binary representation of floats

@item

3

@tab

Python 3.4

@tab

Support for object instancing and recursion

@item

4

@tab

Python 3.4

@tab

Efficient representation of short strings

@item

5

@tab

Python 3.14

@tab

Support for @ref{514,,slice} objects

@end multitable

@end deffn

@subsubheading Notas al pie


@node dbm — Interfaces to Unix «databases»,sqlite3 — DB-API 2 0 interface for SQLite databases,marshal — Internal Python object serialization,Persistencia de datos
@anchor{library/dbm doc}@anchor{28b7}@anchor{library/dbm dbm-interfaces-to-unix-databases}@anchor{28b8}@anchor{library/dbm module-dbm}@anchor{32}
@subsection @code{dbm} — Interfaces to Unix «databases»


@geindex module; dbm

`Código fuente:' Lib/dbm/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/dbm/__init__.py}


__________________________________________________________________


@ref{32,,dbm} is a generic interface to variants of the DBM database:


@itemize *

@item 
@ref{36,,dbm.sqlite3}

@item 
@ref{34,,dbm.gnu}

@item 
@ref{35,,dbm.ndbm}
@end itemize

If none of these modules are installed, the
slow-but-simple implementation in module @ref{33,,dbm.dumb} will be used.  There
is a third party interface@footnote{https://www.jcea.es/programacion/pybsddb.htm} to
the Oracle Berkeley DB.

@geindex error
@anchor{library/dbm dbm error}@anchor{28b9}
@deffn {Excepción} dbm.error

Una tupla que contiene las excepciones que pueden ser lanzadas por cada uno de los módulos soportados, con una excepción única también denominada @ref{28b9,,dbm.error} como el primer elemento — el último se usa cuando se genera @ref{28b9,,dbm.error}.
@end deffn

@geindex whichdb() (en el módulo dbm)
@anchor{library/dbm dbm whichdb}@anchor{28ba}
@deffn {Función} dbm.whichdb (filename)

This function attempts to guess which of the several simple database modules
available — @ref{36,,dbm.sqlite3}, @ref{34,,dbm.gnu}, @ref{35,,dbm.ndbm},
or @ref{33,,dbm.dumb} — should be used to open a given file.

Return one of the following values:


@itemize *

@item 
@code{None} if the file can’t be opened because it’s unreadable or doesn’t exist

@item 
the empty string (@code{'@w{'}}) if the file’s format can’t be guessed

@item 
a string containing the required module name, such as @code{'dbm.ndbm'} or @code{'dbm.gnu'}
@end itemize


Distinto en la versión 3.11: `filename' accepts a @ref{3f0,,path-like object}.

@end deffn

@c Substitutions for the open() flag param docs;
@c all submodules use the same text.

@geindex open() (en el módulo dbm)
@anchor{library/dbm dbm open}@anchor{fac}
@deffn {Función} dbm.open (file, flag='r', mode=0o666)

Open a database and return the corresponding database object.

@*Parámetros: 

@itemize *

@item 
@code{file} (@ref{3f0,,path-like object}) – 
The database file to open.

If the database file already exists, the @ref{28ba,,whichdb()} function is used to
determine its type and the appropriate module is used; if it does not exist,
the first submodule listed above that can be imported is used.


@item 
@code{flag} (@ref{237,,str}) – 

@itemize *

@item 
@code{'r'} (default): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn’t exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{1f0,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize



Distinto en la versión 3.11: `file' accepts a @ref{3f0,,path-like object}.

@end deffn

The object returned by @ref{fac,,open()} supports the same basic functionality as a
@ref{190,,dict}; keys and their corresponding values can be stored, retrieved, and
deleted, and the @ref{1ed,,in} operator and the @code{keys()} method are
available, as well as @code{get()} and @code{setdefault()} methods.

Key and values are always stored as @ref{325,,bytes}. This means that when
strings are used they are implicitly converted to the default encoding before
being stored.

Estos objetos también admiten el uso en una instrucción @ref{673,,with}, que los cerrará automáticamente cuando termine.


Distinto en la versión 3.2: @code{get()} and @code{setdefault()} methods are now available for all
@ref{32,,dbm} backends.



Distinto en la versión 3.4: Added native support for the context management protocol to the objects
returned by @ref{fac,,open()}.



Distinto en la versión 3.8: Deleting a key from a read-only database raises a database module specific exception
instead of @ref{438,,KeyError}.


El siguiente ejemplo registra algunos nombres de host y un título correspondiente, y luego imprime el contenido de la base de datos:

@example
import dbm

# Open database, creating it if necessary.
with dbm.open('cache', 'c') as db:

    # Record some values
    db[b'hello'] = b'there'
    db['www.python.org'] = 'Python Website'
    db['www.cnn.com'] = 'Cable News Network'

    # Note that the keys are considered bytes now.
    assert db[b'www.python.org'] == b'Python Website'
    # Notice how the value is now in bytes.
    assert db['www.cnn.com'] == b'Cable News Network'

    # Often-used methods of the dict interface work too.
    print(db.get('python.org', b'not present'))

    # Storing a non-string key or value will raise an exception (most
    # likely a TypeError).
    db['www.yahoo.com'] = 4

# db is automatically closed when leaving the with statement.
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{c3,,shelve}

Módulo de persistencia que almacena datos que no son cadenas de caracteres.
@end table


Los submódulos individuales se describen en las siguientes secciones.

@menu
* dbm.sqlite3 — SQLite backend for dbm: dbm sqlite3 — SQLite backend for dbm. 
* dbm.gnu — GNU database manager: dbm gnu — GNU database manager. 
* dbm.ndbm — New Database Manager: dbm ndbm — New Database Manager. 
* dbm.dumb — Implementación de DBM portátil: dbm dumb — Implementación de DBM portátil. 

@end menu

@node dbm sqlite3 — SQLite backend for dbm,dbm gnu — GNU database manager,,dbm — Interfaces to Unix «databases»
@anchor{library/dbm dbm-sqlite3-sqlite-backend-for-dbm}@anchor{28bb}@anchor{library/dbm module-dbm sqlite3}@anchor{36}
@subsubsection @code{dbm.sqlite3} — SQLite backend for dbm


@geindex module; dbm.sqlite3


Added in version 3.13.


`Source code:' Lib/dbm/sqlite3.py@footnote{https://github.com/python/cpython/tree/main/Lib/dbm/sqlite3.py}


__________________________________________________________________


This module uses the standard library @ref{cf,,sqlite3} module to provide an
SQLite backend for the @ref{32,,dbm} module.
The files created by @ref{36,,dbm.sqlite3} can thus be opened by @ref{cf,,sqlite3},
or any other SQLite browser, including the SQLite CLI.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@geindex open() (en el módulo dbm.sqlite3)
@anchor{library/dbm dbm sqlite3 open}@anchor{28bc}
@deffn {Función} dbm.sqlite3.open (filename, /, flag='r', mode=0o666)

Open an SQLite database.
The returned object behaves like a @ref{1229,,mapping},
implements a @code{close()} method,
and supports a «closing» context manager via the @ref{673,,with} keyword.

@*Parámetros: 

@itemize *

@item 
@code{filename} (@ref{3f0,,path-like object}) – The path to the database to be opened.

@item 
@code{flag} (@ref{237,,str}) – 

@itemize *

@item 
@code{'r'} (default): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn’t exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize

@end deffn

@node dbm gnu — GNU database manager,dbm ndbm — New Database Manager,dbm sqlite3 — SQLite backend for dbm,dbm — Interfaces to Unix «databases»
@anchor{library/dbm dbm-gnu-gnu-database-manager}@anchor{28bd}@anchor{library/dbm module-dbm gnu}@anchor{34}
@subsubsection @code{dbm.gnu} — GNU database manager


@geindex module; dbm.gnu

`Código fuente:' Lib/dbm/gnu.py@footnote{https://github.com/python/cpython/tree/main/Lib/dbm/gnu.py}


__________________________________________________________________


The @ref{34,,dbm.gnu} module provides an interface to the @abbr{GDBM,GNU dbm}
library, similar to the @ref{35,,dbm.ndbm} module, but with additional
functionality like crash tolerance.

@cartouche
@quotation Nota 
The file formats created by @ref{34,,dbm.gnu} and @ref{35,,dbm.ndbm} are incompatible
and can not be used interchangeably.
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@geindex error
@anchor{library/dbm dbm gnu error}@anchor{b25}
@deffn {Excepción} dbm.gnu.error

Se lanza en errores específicos @ref{34,,dbm.gnu}, como errores de E/S. @ref{438,,KeyError} se genera para errores generales de asignación, como especificar una clave incorrecta.
@end deffn

@geindex open() (en el módulo dbm.gnu)
@anchor{library/dbm dbm gnu open}@anchor{1a46}
@deffn {Función} dbm.gnu.open (filename, flag='r', mode=0o666, /)

Open a GDBM database and return a @code{gdbm} object.

@*Parámetros: 

@itemize *

@item 
@code{filename} (@ref{3f0,,path-like object}) – The database file to open.

@item 
@code{flag} (@ref{237,,str}) – 

@itemize *

@item 
@code{'r'} (default): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn’t exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize

The following additional characters may be appended
to control how the database is opened:


@itemize *

@item 
@code{'f'}: Open the database in fast mode.
Writes to the database will not be synchronized.

@item 
@code{'s'}: Synchronized mode.
Changes to the database will be written immediately to the file.

@item 
@code{'u'}: Do not lock database.
@end itemize

Not all flags are valid for all versions of GDBM.
See the @ref{28be,,open_flags} member for a list of supported flag characters.


@item 
@code{mode} (@ref{1f0,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@*Muestra: 
@ref{b25,,error} – If an invalid `flag' argument is passed.



Distinto en la versión 3.11: `filename' accepts a @ref{3f0,,path-like object}.


@geindex open_flags (en el módulo dbm.gnu)
@anchor{library/dbm dbm gnu open_flags}@anchor{28be}
@deffn {Dato} dbm.gnu.open_flags

A string of characters the `flag' parameter of @ref{1a46,,open()} supports.
@end deffn

@code{gdbm} objects behave similar to @ref{1229,,mappings},
but @code{items()} and @code{values()} methods are not supported.
The following methods are also provided:

@geindex firstkey() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm firstkey}@anchor{28bf}
@deffn {Método} gdbm.firstkey ()

It’s possible to loop over every key in the database using this method  and the
@ref{28c0,,nextkey()} method.  The traversal is ordered by GDBM’s internal
hash values, and won’t be sorted by the key values.  This method returns
the starting key.
@end deffn

@geindex nextkey() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm nextkey}@anchor{28c0}
@deffn {Método} gdbm.nextkey (key)

Retorna la clave que sigue a `key' en el recorrido. El siguiente código imprime todas las claves en la base de datos @code{db}, sin tener que crear una lista en la memoria que las contenga todas:

@example
k = db.firstkey()
while k is not None:
    print(k)
    k = db.nextkey(k)
@end example
@end deffn

@geindex reorganize() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm reorganize}@anchor{28c1}
@deffn {Método} gdbm.reorganize ()

If you have carried out a lot of deletions and would like to shrink the space
used by the GDBM file, this routine will reorganize the database.  @code{gdbm}
objects will not shorten the length of a database file except by using this
reorganization; otherwise, deleted file space will be kept and reused as new
(key, value) pairs are added.
@end deffn

@geindex sync() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm sync}@anchor{28c2}
@deffn {Método} gdbm.sync ()

Cuando la base de datos se ha abierto en modo rápido, este método obliga a que los datos no escritos se escriban en el disco.
@end deffn

@geindex close() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm close}@anchor{28c3}
@deffn {Método} gdbm.close ()

Close the GDBM database.
@end deffn

@geindex clear() (método de dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm clear}@anchor{339}
@deffn {Método} gdbm.clear ()

Remove all items from the GDBM database.


Added in version 3.13.

@end deffn
@end deffn

@node dbm ndbm — New Database Manager,dbm dumb — Implementación de DBM portátil,dbm gnu — GNU database manager,dbm — Interfaces to Unix «databases»
@anchor{library/dbm dbm-ndbm-new-database-manager}@anchor{28c4}@anchor{library/dbm module-dbm ndbm}@anchor{35}
@subsubsection @code{dbm.ndbm} — New Database Manager


@geindex module; dbm.ndbm

`Código fuente:' Lib/dbm/ndbm.py@footnote{https://github.com/python/cpython/tree/main/Lib/dbm/ndbm.py}


__________________________________________________________________


The @ref{35,,dbm.ndbm} module provides an interface to the
@abbr{NDBM,New Database Manager} library.
This module can be used with the «classic» NDBM interface or the
@abbr{GDBM} compatibility interface.

@cartouche
@quotation Nota 
The file formats created by @ref{34,,dbm.gnu} and @ref{35,,dbm.ndbm} are incompatible
and can not be used interchangeably.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
The NDBM library shipped as part of macOS has an undocumented limitation on the
size of values, which can result in corrupted database files
when storing values larger than this limit. Reading such corrupted files can
result in a hard crash (segmentation fault).
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@geindex error
@anchor{library/dbm dbm ndbm error}@anchor{b26}
@deffn {Excepción} dbm.ndbm.error

Se lanza en errores específicos @code{bm.ndbm}, como errores de E/S. @ref{438,,KeyError} lanza para errores generales de asignación, como especificar una clave incorrecta.
@end deffn

@geindex library (en el módulo dbm.ndbm)
@anchor{library/dbm dbm ndbm library}@anchor{28c5}
@deffn {Dato} dbm.ndbm.library

Name of the NDBM implementation library used.
@end deffn

@geindex open() (en el módulo dbm.ndbm)
@anchor{library/dbm dbm ndbm open}@anchor{1a47}
@deffn {Función} dbm.ndbm.open (filename, flag='r', mode=0o666, /)

Open an NDBM database and return an @code{ndbm} object.

@*Parámetros: 

@itemize *

@item 
@code{filename} (@ref{3f0,,path-like object}) – The basename of the database file
(without the @code{.dir} or @code{.pag} extensions).

@item 
@code{flag} (@ref{237,,str}) – 

@itemize *

@item 
@code{'r'} (default): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn’t exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{1f0,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@code{ndbm} objects behave similar to @ref{1229,,mappings},
but @code{items()} and @code{values()} methods are not supported.
The following methods are also provided:


Distinto en la versión 3.11: Acepta @ref{3f0,,path-like object} como nombre de archivo.


@geindex close() (método de dbm.ndbm.ndbm)
@anchor{library/dbm dbm ndbm ndbm close}@anchor{28c6}
@deffn {Método} ndbm.close ()

Close the NDBM database.
@end deffn

@geindex clear() (método de dbm.ndbm.ndbm)
@anchor{library/dbm dbm ndbm ndbm clear}@anchor{33a}
@deffn {Método} ndbm.clear ()

Remove all items from the NDBM database.


Added in version 3.13.

@end deffn
@end deffn

@node dbm dumb — Implementación de DBM portátil,,dbm ndbm — New Database Manager,dbm — Interfaces to Unix «databases»
@anchor{library/dbm dbm-dumb-portable-dbm-implementation}@anchor{28c7}@anchor{library/dbm module-dbm dumb}@anchor{33}
@subsubsection @code{dbm.dumb} — Implementación de DBM portátil


@geindex module; dbm.dumb

`Código fuente:' Lib/dbm/dumb.py@footnote{https://github.com/python/cpython/tree/main/Lib/dbm/dumb.py}

@geindex databases

@cartouche
@quotation Nota 
El módulo @ref{33,,dbm.dumb} está pensado como último recurso para el módulo @ref{32,,dbm} cuando no hay disponible un módulo más robusto. El módulo @code{dbm.dymb} no está escrito para velocidad y no se usa tanto como los otros módulos de base de datos.
@end quotation
@end cartouche


__________________________________________________________________


The @ref{33,,dbm.dumb} module provides a persistent @ref{190,,dict}-like
interface which is written entirely in Python.
Unlike other @ref{32,,dbm} backends, such as @ref{34,,dbm.gnu}, no
external library is required.

The @code{dbm.dumb} module defines the following:

@geindex error
@anchor{library/dbm dbm dumb error}@anchor{b24}
@deffn {Excepción} dbm.dumb.error

Se lanza en errores específicos @ref{33,,dbm.dumb}, como errores de E/S. @ref{438,,KeyError} se lanza para errores de mapeo generales como especificar una clave incorrecta.
@end deffn

@geindex open() (en el módulo dbm.dumb)
@anchor{library/dbm dbm dumb open}@anchor{b21}
@deffn {Función} dbm.dumb.open (filename, flag='c', mode=0o666)

Open a @code{dbm.dumb} database.
The returned database object behaves similar to a @ref{1229,,mapping},
in addition to providing @ref{28c8,,sync()} and @ref{28c9,,close()}
methods.

@*Parámetros: 

@itemize *

@item 
@code{filename} – 
The basename of the database file (without extensions).
A new database creates the following files:


@itemize -

@item 
@code{`filename'.dat}

@item 
@code{`filename'.dir}
@end itemize


@item 
@code{flag} (@ref{237,,str}) – 

@itemize *

@item 
@code{'r'}: Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'} (default): Open database for reading and writing, creating it if it doesn’t exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{1f0,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@cartouche
@quotation Advertencia 
Es posible bloquear el intérprete de Python cuando se carga una base de datos con una entrada suficientemente grande/compleja debido a las limitaciones de profundidad de la pila en el compilador AST de Python.
@end quotation
@end cartouche


Distinto en la versión 3.5: @ref{b21,,open()} always creates a new database when `flag' is @code{'n'}.



Distinto en la versión 3.8: A database opened read-only if `flag' is @code{'r'}.
A database is not created if it does not exist if `flag' is @code{'r'} or @code{'w'}.



Distinto en la versión 3.11: `filename' accepts a @ref{3f0,,path-like object}.


In addition to the methods provided by the
@ref{1123,,collections.abc.MutableMapping} class,
the following methods are provided:

@geindex sync() (método de dbm.dumb.dumbdbm)
@anchor{library/dbm dbm dumb dumbdbm sync}@anchor{28c8}
@deffn {Método} dumbdbm.sync ()

Sincroniza el directorio en disco y los archivos de datos. Este método es llamado por el método @code{Shelve.sync()}.
@end deffn

@geindex close() (método de dbm.dumb.dumbdbm)
@anchor{library/dbm dbm dumb dumbdbm close}@anchor{28c9}
@deffn {Método} dumbdbm.close ()

Close the database.
@end deffn
@end deffn

@node sqlite3 — DB-API 2 0 interface for SQLite databases,,dbm — Interfaces to Unix «databases»,Persistencia de datos
@anchor{library/sqlite3 doc}@anchor{28ca}@anchor{library/sqlite3 module-sqlite3}@anchor{cf}@anchor{library/sqlite3 sqlite3-db-api-2-0-interface-for-sqlite-databases}@anchor{28cb}
@subsection @code{sqlite3} — DB-API 2.0 interface for SQLite databases


@geindex module; sqlite3

`Código fuente:' Lib/sqlite3/@footnote{https://github.com/python/cpython/tree/main/Lib/sqlite3/}

@c Make sure we always doctest the tutorial with an empty database.

@c import sqlite3
@c src = sqlite3.connect(":memory:", isolation_level=None)
@c dst = sqlite3.connect("tutorial.db", isolation_level=None)
@c src.backup(dst)
@c src.close()
@c dst.close()
@c del src, dst
@anchor{library/sqlite3 sqlite3-intro}@anchor{28cc}
SQLite es una biblioteca de C que provee una base de datos ligera basada en disco que no requiere un proceso de servidor separado y permite acceder a la base de datos usando una variación no estándar del lenguaje de consulta SQL. Algunas aplicaciones pueden usar SQLite para almacenamiento interno. También es posible prototipar una aplicación usando SQLite y luego transferir el código a una base de datos más grande como PostgreSQL u Oracle.

The @code{sqlite3} module was written by Gerhard Häring.  It provides an SQL interface
compliant with the DB-API 2.0 specification described by 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}, and
requires SQLite 3.15.2 or newer.

Esta documentación contiene cuatro secciones principales:


@itemize *

@item 
@ref{28cd,,Tutorial} enseña como usar el módulo @code{sqlite3} module.

@item 
@ref{28ce,,Referencia} describe las clases y funciones que se definen en este módulo.

@item 
@ref{28cf,,Guías prácticas} detalla como manipular tareas específicas.

@item 
@ref{28d0,,Explicación} proporciona en profundidad información sobre el control transaccional.
@end itemize


@subsubheading Ver también



@table @asis

@item @indicateurl{https://www.sqlite.org}

La página web SQLite; la documentación describe la sintaxis y los tipos de datos disponibles para el lenguaje SQL soportado.

@item @indicateurl{https://www.w3schools.com/sql/}

Tutorial, referencia y ejemplos para aprender sintaxis SQL.

@geindex Python Enhancement Proposals; PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - Especificación de la API 2.0 de base de datos

PEP escrito por Marc-André Lemburg.
@end table


@c We use the following practises for SQL code:
@c - UPPERCASE for keywords
@c - snake_case for schema
@c - single quotes for string literals
@c - singular for table names
@c - if needed, use double quotes for table and column names

@menu
* Tutorial:: 
* Referencia:: 
* Guías prácticas:: 
* Explicación:: 

@end menu

@node Tutorial,Referencia,,sqlite3 — DB-API 2 0 interface for SQLite databases
@anchor{library/sqlite3 sqlite3-tutorial}@anchor{28cd}@anchor{library/sqlite3 tutorial}@anchor{28d1}
@subsubsection Tutorial


En este tutorial, será creada una base de datos de películas Monty Python usando funcionalidades básicas de @code{sqlite3}. Se asume un entendimiento fundamental de conceptos de bases de dados, como cursors@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)} y transactions@footnote{https://en.wikipedia.org/wiki/Database_transaction}.

First, we need to create a new database and open
a database connection to allow @code{sqlite3} to work with it.
Call @ref{3f5,,sqlite3.connect()} to create a connection to
the database @code{tutorial.db} in the current working directory,
implicitly creating it if it does not exist:

@example
import sqlite3
con = sqlite3.connect("tutorial.db")
@end example

El retorno será un objecto de la clase @ref{39e,,Connection} representado en @code{con} como una base de datos local.

Con el fin de ejecutar sentencias SQL y obtener resultados de consultas SQL, necesitaremos usar un cursor para la base de datos. Llamando @ref{28d2,,con.cursor()} se creará el @ref{28d3,,Cursor}:

@example
cur = con.cursor()
@end example

Ahora que hemos configurado una conexión y un cursor, podemos crear una tabla @code{movie} con las columnas `title', `release year', y `review score'. Para simplificar, podemos solamente usar nombres de columnas en la declaración de la tabla – gracias al recurso de flexible typing@footnote{https://www.sqlite.org/flextypegood.html} SQLite, especificar los tipos de datos es opcional. Ejecuta la sentencia @code{CREATE TABLE} llamando @ref{400,,cur.execute(...)}:

@example
cur.execute("CREATE TABLE movie(title, year, score)")
@end example

@c Ideally, we'd use sqlite_schema instead of sqlite_master below,
@c but SQLite versions older than 3.33.0 do not recognise that variant.

Podemos verificar que una nueva tabla ha sido creada consultando la tabla @code{sqlite_master} incorporada en SQLite, la cual ahora debería contener una entrada para la tabla @code{movie} (consulte The Schema Table@footnote{https://www.sqlite.org/schematab.html} para más información). Ejecute esa consulta llamando a @ref{400,,cur.execute(...)}, asigne el resultado a @code{res} y llame a @ref{28d4,,res.fetchone()} para obtener la fila resultante:

@example
>>> res = cur.execute("SELECT name FROM sqlite_master")
>>> res.fetchone()
('movie',)
@end example

We can see that the table has been created,
as the query returns a @ref{464,,tuple} containing the table’s name.
If we query @code{sqlite_master} for a non-existent table @code{spam},
@code{res.fetchone()} will return @code{None}:

@example
>>> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'")
>>> res.fetchone() is None
True
@end example

Ahora, agrega dos filas de datos proporcionados como SQL literales, ejecutando la sentencia @code{INSERT}, una vez más llamando a @ref{400,,cur.execute(...)}:

@example
cur.execute("""
    INSERT INTO movie VALUES
        ('Monty Python and the Holy Grail', 1975, 8.2),
        ('And Now for Something Completely Different', 1971, 7.5)
""")
@end example

La sentencia @code{INSERT} implícitamente abre una transacción, la cual necesita ser confirmada antes que los cambios sean guardados en la base de datos (consulte @ref{28d5,,Control transaccional} para más información). Llamando a @ref{28d6,,con.commit()} sobre el objeto de la conexión, se confirmará la transacción:

@example
con.commit()
@end example

Podemos verificar que la información fue introducida correctamente ejecutando la consulta @code{SELECT}. Ejecute el ahora conocido @ref{400,,cur.execute(...)} para asignar el resultado a @code{res}, y luego llame a @ref{28d7,,res.fetchall()} para obtener todas las filas como resultado:

@example
>>> res = cur.execute("SELECT score FROM movie")
>>> res.fetchall()
[(8.2,), (7.5,)]
@end example

El resultado es una @ref{18e,,list} de dos @code{tuple}s, una por fila, cada una conteniendo el valor del @code{score} de esa fila.

Ahora, introduzca tres filas más llamando @ref{401,,cur.executemany(...)}:

@example
data = [
    ("Monty Python Live at the Hollywood Bowl", 1982, 7.9),
    ("Monty Python's The Meaning of Life", 1983, 7.5),
    ("Monty Python's Life of Brian", 1979, 8.0),
]
cur.executemany("INSERT INTO movie VALUES(?, ?, ?)", data)
con.commit()  # Remember to commit the transaction after executing INSERT.
@end example

Note que los marcadores de posición @code{?} son usados para enlazar @code{data} a la consulta. SIempre use marcadores de posición en lugar de @ref{1c79,,string formatting} para unir valores Python a sentencias SQL, y así evitará SQL injection attacks@footnote{https://en.wikipedia.org/wiki/SQL_injection} (consulte @ref{402,,Cómo usar marcadores de posición para vincular valores en consultas SQL} para más información).

Podemos verificar que las nuevas filas fueron introducidas ejecutando una consulta @code{SELECT}, esta vez iterando sobre los resultados de la consulta:

@example
>>> for row in cur.execute("SELECT year, title FROM movie ORDER BY year"):
...     print(row)
(1971, 'And Now for Something Completely Different')
(1975, 'Monty Python and the Holy Grail')
(1979, "Monty Python's Life of Brian")
(1982, 'Monty Python Live at the Hollywood Bowl')
(1983, "Monty Python's The Meaning of Life")
@end example

Cada fila es una @ref{464,,tuple} de dos items con @code{(year, title)}, donde las columnas seleccionadas coinciden con la consulta.

Finalmente, se puede verificar que la base de datos ha sido escrita en disco, llamando @ref{39f,,con.close()} para cerrar la conexión existente, abriendo una nueva, creando un nuevo cursor y luego consultando la base de datos:

@example
>>> con.close()
>>> new_con = sqlite3.connect("tutorial.db")
>>> new_cur = new_con.cursor()
>>> res = new_cur.execute("SELECT title, year FROM movie ORDER BY score DESC")
>>> title, year = res.fetchone()
>>> print(f'The highest scoring Monty Python movie is @{title!r@}, released in @{year@}')
The highest scoring Monty Python movie is 'Monty Python and the Holy Grail', released in 1975
>>> new_con.close()
@end example

Ahora ha creado una base de datos SQLite usando el módulo @code{sqlite3}, insertado datos y recuperado valores de varias maneras.


@subsubheading Ver también



@itemize *

@item 
@ref{28cf,,Guías prácticas} para lecturas de interés:


@itemize *

@item 
@ref{402,,Cómo usar marcadores de posición para vincular valores en consultas SQL}

@item 
@ref{28d8,,Cómo adaptar tipos de Python personalizados a valores de SQLite}

@item 
@ref{28d9,,Como convertir valores SQLite a tipos de Python personalizados}

@item 
@ref{17ea,,Como usar la conexión con un administrador de contexto}

@item 
@ref{28da,,How to create and use row factories}
@end itemize

@item 
@ref{28d0,,Explicación} para obtener información detallada sobre el control de transacciones..
@end itemize


@node Referencia,Guías prácticas,Tutorial,sqlite3 — DB-API 2 0 interface for SQLite databases
@anchor{library/sqlite3 reference}@anchor{28db}@anchor{library/sqlite3 sqlite3-reference}@anchor{28ce}
@subsubsection Referencia


@c We keep the old sqlite3-module-contents ref to prevent breaking links.
@anchor{library/sqlite3 sqlite3-module-contents}@anchor{28dc}
@menu
* Funciones del módulo:: 
* Constantes del módulo:: 
* Objetos de conexión:: 
* Objetos cursor:: 
* Objetos fila (Row): Objetos fila Row. 
* Objetos fila (Row): Objetos fila Row<2>. 
* Objetos PrepareProtocol:: 
* Excepciones: Excepciones<6>. 
* SQLite y tipos de Python:: 
* Default adapters and converters (deprecated): Default adapters and converters deprecated. 
* Command-line interface:: 

@end menu

@node Funciones del módulo,Constantes del módulo,,Referencia
@anchor{library/sqlite3 module-functions}@anchor{28dd}@anchor{library/sqlite3 sqlite3-module-functions}@anchor{28de}
@subsubsection Funciones del módulo


@geindex connect() (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 connect}@anchor{3f5}
@deffn {Función} sqlite3.connect (database, timeout=5.0, detect_types=0, isolation_level='DEFERRED', check_same_thread=True, factory=sqlite3.Connection, cached_statements=128, uri=False, *, autocommit=sqlite3.LEGACY_TRANSACTION_CONTROL)

Abre una conexión con una base de datos SQLite.

@*Parámetros: 

@itemize *

@item 
@code{database} (@ref{3f0,,path-like object}) – The path to the database file to be opened.
You can pass @code{":memory:"} to create an SQLite database existing only in memory@footnote{https://sqlite.org/inmemorydb.html}, and open a connection
to it.

@item 
@code{timeout} (@ref{153,,float}) – How many seconds the connection should wait before raising
an @ref{18a6,,OperationalError} when a table is locked.
If another connection opens a transaction to modify a table,
that table will be locked until the transaction is committed.
Default five seconds.

@item 
@code{detect_types} (@ref{1f0,,int}) – Controla si y cómo los tipos de datos no @ref{28df,,soportados de forma nativa po SQLite} son buscados para ser convertidos en tipos Python, usando convertidores registrados con @ref{28e0,,register_converter()}. Se puede establecer para cualquier combinación (usando @code{|}, bit a bit or) de @ref{28e1,,PARSE_DECLTYPES} y @ref{28e2,,PARSE_COLNAMES} para habilitarlo. Los nombres de columnas tienen prioridad sobre los tipos declarados si se establecen ambos indicadores. Algunos tipos no pueden ser detectados por campos generados (por ejemplo @code{max(data)}), incluso cuando el parámetro `detect_types' es establecido; @ref{237,,str} será el retorno en su lugar. Por defecto (@code{0}), la detección de tipos está deshabilitada.

@item 
@code{isolation_level} (@ref{237,,str}@code{ | }@code{None}) – Control legacy transaction handling behaviour.
See @ref{28e3,,Connection.isolation_level} and
@ref{28e4,,Transaction control via the isolation_level attribute} for more information.
Can be @code{"DEFERRED"} (default), @code{"EXCLUSIVE"} or @code{"IMMEDIATE"};
or @code{None} to disable opening transactions implicitly.
Has no effect unless @ref{55d,,Connection.autocommit} is set to
@ref{28e5,,LEGACY_TRANSACTION_CONTROL} (the default).

@item 
@code{check_same_thread} (@ref{513,,bool}) – If @code{True} (default), @ref{223,,ProgrammingError} will be raised
if the database connection is used by a thread
other than the one that created it.
If @code{False}, the connection may be accessed in multiple threads;
write operations may need to be serialized by the user
to avoid data corruption.
See @ref{71d,,threadsafety} for more information.

@item 
@code{factory} (@ref{39e,,Connection}) – Una subclase personalizada de @ref{39e,,Connection} con la que crear la conexión, sino la @ref{39e,,Connection} será la predeterminada.

@item 
@code{cached_statements} (@ref{1f0,,int}) – El número de instrucciones que @code{sqlite3} debe almacenar internamente en caché para esta conexión, para evitar la sobrecarga de análisis. El valor predeterminada, son 128 instrucciones.

@item 
@code{uri} (@ref{513,,bool}) – Si se establece en @code{True}, `database' es interpretada como una @abbr{URI,Uniform Resource Identifier} con la ruta de un archivo y una consulta de cadena de caracteres de modo opcional. La parte del esquema `debe' ser @code{"file:"}, y la ruta puede ser relativa o absoluta. La consulta permite pasar parámetros a SQLite, habilitando varias @ref{28e6,,Como trabajar con URIs SQLite}.

@item 
@code{autocommit} (@ref{513,,bool}) – Control 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} transaction handling behaviour.
See @ref{55d,,Connection.autocommit} and
@ref{55e,,Transaction control via the autocommit attribute} for more information.
`autocommit' currently defaults to
@ref{28e5,,LEGACY_TRANSACTION_CONTROL}.
The default will change to @code{False} in a future Python release.
@end itemize


@*Tipo del valor devuelto: 
@ref{39e,,Connection}


Lanza un @ref{18c3,,auditing event} @code{sqlite3.connect} con el argumento @code{database}.

Lanza un @ref{18c3,,auditing event} @code{sqlite3.connect/handle} con el argumento @code{connection_handle}.


Distinto en la versión 3.4: Added the `uri' parameter.



Distinto en la versión 3.7: `database' ahora también puede ser un @ref{3f0,,path-like object}, no solo una cadena de caracteres.



Distinto en la versión 3.10: Added the @code{sqlite3.connect/handle} auditing event.



Distinto en la versión 3.12: Added the `autocommit' parameter.



Distinto en la versión 3.13: Positional use of the parameters `timeout', `detect_types',
`isolation_level', `check_same_thread', `factory', `cached_statements',
and `uri' is deprecated.
They will become keyword-only parameters in Python 3.15.

@end deffn

@geindex complete_statement() (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 complete_statement}@anchor{28e7}
@deffn {Función} sqlite3.complete_statement (statement)

Retorna @code{True} si la cadena de caracteres `statement' pareciera contener uno o más sentencias SQL completas. No se realiza ninguna verificación o análisis sintáctico de ningún tipo, aparte de comprobar que no hay cadena de caracteres literales sin cerrar y que la sentencia se termine con un punto y coma.

Por ejemplo:

@example
>>> sqlite3.complete_statement("SELECT foo FROM bar;")
True
>>> sqlite3.complete_statement("SELECT foo")
False
@end example

Esta función puede ser útil con entradas de línea de comando para determinar si los textos introducidos parecen formar una sentencia completa SQL, o si una entrada adicional se necesita antes de llamar a @ref{400,,execute()}.

See @code{runsource()} in Lib/sqlite3/__main__.py@footnote{https://github.com/python/cpython/tree/main/Lib/sqlite3/__main__.py}
for real-world use.
@end deffn

@geindex enable_callback_tracebacks() (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 enable_callback_tracebacks}@anchor{28e8}
@deffn {Función} sqlite3.enable_callback_tracebacks (flag, /)

Habilita o deshabilita seguimiento de retrollamadas. Por defecto no se obtendrá ningún `tracebacks' en funciones `aggregates', `converters', autorizador de `callbacks' etc, definidas por el usuario. Si quieres depurarlas, se puede llamar esta función con `flag' establecida como @code{True}. Después se obtendrán `tracebacks' de los `callbacks' en @code{sys.stderr}. Usar @ref{bbf,,False} para deshabilitar la característica de nuevo.

@cartouche
@quotation Nota 
Errors in user-defined function callbacks are logged as unraisable exceptions.
Use an @ref{355,,unraisable hook handler} for
introspection of the failed callback.
@end quotation
@end cartouche
@end deffn

@geindex register_adapter() (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 register_adapter}@anchor{28e9}
@deffn {Función} sqlite3.register_adapter (type, adapter, /)

Register an `adapter' @ref{28ea,,callable} to adapt the Python type `type'
into an SQLite type.
The adapter is called with a Python object of type `type' as its sole
argument, and must return a value of a
@ref{28df,,type that SQLite natively understands}.
@end deffn

@geindex register_converter() (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 register_converter}@anchor{28e0}
@deffn {Función} sqlite3.register_converter (typename, converter, /)

Register the `converter' @ref{28ea,,callable} to convert SQLite objects of type
`typename' into a Python object of a specific type.
The converter is invoked for all SQLite values of type `typename';
it is passed a @ref{325,,bytes} object and should return an object of the
desired Python type.
Consult the parameter `detect_types' of
@ref{3f5,,connect()} for information regarding how type detection works.

Nota: `typename' y el nombre del tipo en tu consulta coinciden sin distinción entre mayúsculas y minúsculas.
@end deffn

@node Constantes del módulo,Objetos de conexión,Funciones del módulo,Referencia
@anchor{library/sqlite3 module-constants}@anchor{28eb}@anchor{library/sqlite3 sqlite3-module-constants}@anchor{28ec}
@subsubsection Constantes del módulo


@geindex LEGACY_TRANSACTION_CONTROL (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 LEGACY_TRANSACTION_CONTROL}@anchor{28e5}
@deffn {Dato} sqlite3.LEGACY_TRANSACTION_CONTROL

Set @ref{55d,,autocommit} to this constant to select
old style (pre-Python 3.12) transaction control behaviour.
See @ref{28e4,,Transaction control via the isolation_level attribute} for more information.
@end deffn

@geindex PARSE_COLNAMES (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 PARSE_COLNAMES}@anchor{28e2}
@deffn {Dato} sqlite3.PARSE_COLNAMES

Pasa este valor de flag como parámetro `detect_types' de la @ref{3f5,,connect()} para buscar una función `converter' usando el nombre del tipo, analizado del nombre de la columna consultada, como la llave de diccionario del conversor. El nombre del tipo debe estar entre corchetes (@code{[]}).

@example
SELECT p as "p [point]" FROM test;  ! will look up converter "point"
@end example

Esta flag puede ser combinada con @ref{28e1,,PARSE_DECLTYPES} usando el operador @code{|} (`bitwise or') .
@end deffn

@geindex PARSE_DECLTYPES (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 PARSE_DECLTYPES}@anchor{28e1}
@deffn {Dato} sqlite3.PARSE_DECLTYPES

Pasa este valor de flag como parámetro `detect_types' de la @ref{3f5,,connect()} para buscar una función `converter' usando los tipos declarados para cada columna. Los tipos son declarados cuando la tabla de la base de datos se creó. @code{sqlite3} buscará una función `converter' usando la primera palabra del tipo declarado como la llave del diccionario conversor. Por ejemplo:

@example
CREATE TABLE test(
   i integer primary key,  ! will look up a converter named "integer"
   p point,                ! will look up a converter named "point"
   n number(10)            ! will look up a converter named "number"
 )
@end example

Esta puede ser combinada con @ref{28e2,,PARSE_COLNAMES} usando el operador @code{|} (`bitwise or').
@end deffn

@geindex SQLITE_OK (en el módulo sqlite3)
@geindex SQLITE_DENY (en el módulo sqlite3)
@geindex SQLITE_IGNORE (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 SQLITE_OK}@anchor{28ed}
@deffn {Dato} sqlite3.SQLITE_OK
@anchor{library/sqlite3 sqlite3 SQLITE_DENY}@anchor{28ee}
@deffnx {Dato} sqlite3.SQLITE_DENY
@anchor{library/sqlite3 sqlite3 SQLITE_IGNORE}@anchor{28ef}
@deffnx {Dato} sqlite3.SQLITE_IGNORE

Flags that should be returned by the `authorizer_callback' @ref{28ea,,callable}
passed to @ref{3f8,,Connection.set_authorizer()}, to indicate whether:


@itemize *

@item 
Acceso es permitido (@code{SQLITE_OK}),

@item 
La sentencia SQL debería ser abortada con un error (@code{SQLITE_DENY})

@item 
La columna debería ser tratada como un valor @code{NULL} (@code{SQLITE_IGNORE})
@end itemize
@end deffn

@geindex apilevel (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 apilevel}@anchor{28f0}
@deffn {Dato} sqlite3.apilevel

Cadena de caracteres constante que indica el nivel DB-API soportado. Requerido por DB-API. Codificado de forma rígida en @code{"2.0"}.
@end deffn

@geindex paramstyle (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 paramstyle}@anchor{28f1}
@deffn {Dato} sqlite3.paramstyle

Cadena de caracteres que indica el tipo de formato del marcador de parámetros esperado por el módulo @code{sqlite3}. Requerido por DB-API. Codificado de forma rígida en @code{"qmark"}.

@cartouche
@quotation Nota 
The @code{named} DB-API parameter style is also supported.
@end quotation
@end cartouche
@end deffn

@geindex sqlite_version (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 sqlite_version}@anchor{28f2}
@deffn {Dato} sqlite3.sqlite_version

El número de versión de la librería SQLite en tiempo de ejecución, como una @ref{237,,cadena de caracteres}.
@end deffn

@geindex sqlite_version_info (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 sqlite_version_info}@anchor{28f3}
@deffn {Dato} sqlite3.sqlite_version_info

El número de versión de la librería SQLite en tiempo de ejecución, como una @ref{464,,tupla} de @ref{1f0,,enteros}.
@end deffn

@geindex threadsafety (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3 threadsafety}@anchor{71d}
@deffn {Dato} sqlite3.threadsafety

Constante de tipo entero requerida por la DB-API 2.0, la cual indica el nivel de seguridad de subproceso que @code{sqlite3} soporta. Este atributo se establece basándose en el modo de subprocesamiento@footnote{https://sqlite.org/threadsafe.html} por defecto con el que la biblioteca SQLite se compila. Los modos de subprocesamiento de SQLite son:


@enumerate 

@item 
`Single-thread': En este modo, todos los `mutexes' son deshabilitados y no es seguro usar SQLite en más de un solo hilo a la vez.

@item 
`Multi-thread': En este modo, es seguro usar SQLite desde varios hilos dado que que ninguna conexión de base de datos sea usada simultáneamente en dos o más hilos.

@item 
`Serialized': En el modo serializado, es seguro usar SQLite por varios hilos sin restricción.
@end enumerate

Las asignaciones de los modos de subprocesos SQLite a los niveles de seguridad de subprocesos de DB-API 2.0 son las siguientes:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modo de subprocesamiento SQLite

@tab

@geindex Python Enhancement Proposals; PEP 0249#threadsafety
threadsafety@footnote{https://peps.python.org/pep-0249/#threadsafety}

@tab

SQLITE_THREADSAFE@footnote{https://sqlite.org/compile.html#threadsafe}

@tab

Significado de DB-API 2.0

@item

single-thread

@tab

0

@tab

0

@tab

Hilos no pueden compartir el módulo

@item

multi-thread

@tab

1

@tab

2

@tab

Hilos pueden compartir el módulo, pero no conexiones

@item

serialized

@tab

3

@tab

1

@tab

Hilos pueden compartir el módulo, conexiones y cursores

@end multitable



Distinto en la versión 3.11: Establece `threadsafety' dinámicamente en vez de codificarlo rígidamente a @code{1}.

@end deffn

@geindex SQLITE_DBCONFIG_DEFENSIVE (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_DQS_DDL (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_DQS_DML (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_FKEY (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_QPSG (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_TRIGGER (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_VIEW (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_LEGACY_ALTER_TABLE (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_LEGACY_FILE_FORMAT (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_RESET_DATABASE (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_TRIGGER_EQP (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_TRUSTED_SCHEMA (en el módulo sqlite3)
@geindex SQLITE_DBCONFIG_WRITABLE_SCHEMA (en el módulo sqlite3)
@anchor{library/sqlite3 sqlite3-dbconfig-constants}@anchor{28f4}@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DEFENSIVE}@anchor{28f5}
@deffn {Dato} sqlite3.SQLITE_DBCONFIG_DEFENSIVE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DDL}@anchor{28f6}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_DQS_DDL
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DML}@anchor{28f7}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_DQS_DML
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FKEY}@anchor{28f8}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER}@anchor{28f9}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION}@anchor{28fa}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_QPSG}@anchor{28fb}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_TRIGGER}@anchor{28fc}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_VIEW}@anchor{28fd}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_ALTER_TABLE}@anchor{28fe}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_FILE_FORMAT}@anchor{28ff}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE}@anchor{2900}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_RESET_DATABASE}@anchor{2901}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_RESET_DATABASE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRIGGER_EQP}@anchor{2902}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRUSTED_SCHEMA}@anchor{2903}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_WRITABLE_SCHEMA}@anchor{2904}
@deffnx {Dato} sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA

These constants are used for the @ref{561,,Connection.setconfig()}
and @ref{560,,getconfig()} methods.

The availability of these constants varies depending on the version of SQLite
Python was compiled with.


Added in version 3.12.



@subsubheading Ver también



@table @asis

@item @indicateurl{https://www.sqlite.org/c3ref/c_dbconfig_defensive.html}

SQLite docs: Database Connection Configuration Options
@end table

@end deffn


Deprecated since version 3.12, removed in version 3.14: The @code{version} and @code{version_info} constants.


@node Objetos de conexión,Objetos cursor,Constantes del módulo,Referencia
@anchor{library/sqlite3 connection-objects}@anchor{2905}@anchor{library/sqlite3 sqlite3-connection-objects}@anchor{2906}
@subsubsection Objetos de conexión


@geindex Connection (clase en sqlite3)
@anchor{library/sqlite3 sqlite3 Connection}@anchor{39e}
@deffn {Clase} sqlite3.Connection

Cada base de datos SQLite abierta es representada por un objeto @code{Connection}, el cual se crea usando @ref{3f5,,sqlite3.connect()}. Su objetivo principal es crear objetos @ref{28d3,,Cursor}, y @ref{28d5,,Control transaccional}.


@subsubheading Ver también



@itemize *

@item 
@ref{2907,,Cómo utilizar los métodos de acceso directo de conexión}

@item 
@ref{17ea,,Como usar la conexión con un administrador de contexto}
@end itemize



Distinto en la versión 3.13: A @ref{39d,,ResourceWarning} is emitted if @ref{39f,,close()} is not called before
a @code{Connection} object is deleted.


Una conexión a una base de datos SQLite tiene los siguientes atributos y métodos:

@geindex cursor() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection cursor}@anchor{28d2}
@deffn {Método} cursor (factory=Cursor)

Create and return a @ref{28d3,,Cursor} object.
The cursor method accepts a single optional parameter `factory'. If
supplied, this must be a @ref{28ea,,callable} returning
an instance of @ref{28d3,,Cursor} or its subclasses.
@end deffn

@geindex blobopen() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection blobopen}@anchor{722}
@deffn {Método} blobopen (table, column, row, /, *, readonly=False, name='main')

Abre una @ref{723,,Blob} para manejar un @abbr{BLOB,Binary Large OBject} existente.

@*Parámetros: 

@itemize *

@item 
@code{table} (@ref{237,,str}) – El nombre de la tabla donde el `blob' está ubicado.

@item 
@code{column} (@ref{237,,str}) – El nombre de la columna donde el `blob' está ubicado.

@item 
@code{row} (@ref{237,,str}) – El nombre de la fila donde el `blob' está ubicado.

@item 
@code{readonly} (@ref{513,,bool}) – Se define como @code{True} si el `blob' deberá ser abierto sin permisos de escritura. El valor por defecto es @code{False}.

@item 
@code{name} (@ref{237,,str}) – El nombre de la base de datos donde el `blob' está ubicado. El valor por defecto es @code{"main"}.
@end itemize


@*Muestra: 
@ref{18a6,,OperationalError} – Cuando se intenta abrir un `blob' en una tabla @code{WITHOUT ROWID}.


@*Tipo del valor devuelto: 
@ref{723,,Blob}


@cartouche
@quotation Nota 
El tamaño de un `blob' no puede ser cambiado usando la clase @ref{723,,Blob}. Usa la función de SQL @code{zeroblob} para crear un `blob' con un tamaño fijo.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex commit() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection commit}@anchor{28d6}
@deffn {Método} commit ()

Commit any pending transaction to the database.
If @ref{55d,,autocommit} is @code{True}, or there is no open transaction,
this method does nothing.
If @code{autocommit} is @code{False}, a new transaction is implicitly
opened if a pending transaction was committed by this method.
@end deffn

@geindex rollback() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection rollback}@anchor{2908}
@deffn {Método} rollback ()

Roll back to the start of any pending transaction.
If @ref{55d,,autocommit} is @code{True}, or there is no open transaction,
this method does nothing.
If @code{autocommit} is @code{False}, a new transaction is implicitly
opened if a pending transaction was rolled back by this method.
@end deffn

@geindex close() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection close}@anchor{39f}
@deffn {Método} close ()

Close the database connection.
If @ref{55d,,autocommit} is @code{False},
any pending transaction is implicitly rolled back.
If @code{autocommit} is @code{True} or @ref{28e5,,LEGACY_TRANSACTION_CONTROL},
no implicit transaction control is executed.
Make sure to @ref{28d6,,commit()} before closing
to avoid losing pending changes.
@end deffn

@geindex execute() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection execute}@anchor{2909}
@deffn {Método} execute (sql, parameters=(), /)

Crea un nuevo objeto @ref{28d3,,Cursor} y llama @ref{400,,execute()} con los parámetros y el SQL dados. Retorna el nuevo objeto cursor.
@end deffn

@geindex executemany() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection executemany}@anchor{290a}
@deffn {Método} executemany (sql, parameters, /)

Crea una nueva @ref{28d3,,Cursor} object and call @ref{401,,executemany()} con los parámetros y el SQL dados. Retorna el nuevo objeto cursor.
@end deffn

@geindex executescript() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection executescript}@anchor{290b}
@deffn {Método} executescript (sql_script, /)

Crea una nueva @ref{28d3,,Cursor} object and call @ref{290c,,executescript()} con el `sql_script' dado. Retorna el nuevo objeto cursor.
@end deffn

@geindex create_function() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_function}@anchor{3f6}
@deffn {Método} create_function (name, narg, func, *, deterministic=False)

Crea o elimina una función SQL definida por el usuario.

@*Parámetros: 

@itemize *

@item 
@code{name} (@ref{237,,str}) – El nombre de la función SQL.

@item 
@code{narg} (@ref{1f0,,int}) – El número de argumentos que la función SQL puede aceptar. Si es @code{-1}, podrá entonces recibir cualquier cantidad de argumentos.

@item 
@code{func} (@ref{290d,,callback} | None) – A @ref{28ea,,callable} that is called when the SQL function is invoked.
The callable must return @ref{28df,,a type natively supported by SQLite}.
Set to @code{None} to remove an existing SQL function.

@item 
@code{deterministic} (@ref{513,,bool}) – Si se establece @code{True}, la función SQL creada se marcará como determinista@footnote{https://sqlite.org/deterministic.html}, lo cual permite a SQLite realizar optimizaciones adicionales.
@end itemize



Distinto en la versión 3.8: Added the `deterministic' parameter.


Ejemplo:

@example
>>> import hashlib
>>> def md5sum(t):
...     return hashlib.md5(t).hexdigest()
>>> con = sqlite3.connect(":memory:")
>>> con.create_function("md5", 1, md5sum)
>>> for row in con.execute("SELECT md5(?)", (b"foo",)):
...     print(row)
('acbd18db4cc2f85cedef654fccc4a4d8',)
>>> con.close()
@end example


Distinto en la versión 3.13: Passing `name', `narg', and `func' as keyword arguments is deprecated.
These parameters will become positional-only in Python 3.15.

@end deffn

@geindex create_aggregate() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_aggregate}@anchor{3f7}
@deffn {Método} create_aggregate (name, n_arg, aggregate_class)

Crea o elimina una función agregada SQL definida por el usuario.

@*Parámetros: 

@itemize *

@item 
@code{name} (@ref{237,,str}) – El nombre de la función agregada SQL.

@item 
@code{n_arg} (@ref{1f0,,int}) – El número de argumentos que la función agregada SQL puede aceptar. Si es @code{-1}, podrá entonces recibir cualquier cantidad de argumentos.

@item 
@code{aggregate_class} (@ref{193b,,class} | None) – Una clase debe implementar los siguientes métodos: * @code{step()}: Adiciona una fila al `aggregate'. * @code{finalize()}: Retorna el resultado final del `aggregate' como un @ref{28df,,tipo soportado nativamente por SQLite}. La cantidad de argumentos que el método @code{step()} puede aceptar, es controlado por `n_arg'. Establece @code{None} para eliminar una función agregada SQL existente.
@end itemize


Ejemplo:

@example
class MySum:
    def __init__(self):
        self.count = 0

    def step(self, value):
        self.count += value

    def finalize(self):
        return self.count

con = sqlite3.connect(":memory:")
con.create_aggregate("mysum", 1, MySum)
cur = con.execute("CREATE TABLE test(i)")
cur.execute("INSERT INTO test(i) VALUES(1)")
cur.execute("INSERT INTO test(i) VALUES(2)")
cur.execute("SELECT mysum(i) FROM test")
print(cur.fetchone()[0])

con.close()
@end example

@c 3


Distinto en la versión 3.13: Passing `name', `n_arg', and `aggregate_class' as keyword arguments is deprecated.
These parameters will become positional-only in Python 3.15.

@end deffn

@geindex create_window_function() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_window_function}@anchor{721}
@deffn {Método} create_window_function (name, num_params, aggregate_class, /)

Crea o elimina una función agregada de ventana definida por el usuario.

@*Parámetros: 

@itemize *

@item 
@code{name} (@ref{237,,str}) – El nombre de la función agregada de ventana a ser creada o eliminada.

@item 
@code{num_params} (@ref{1f0,,int}) – La cantidad de argumentos que la función agregada de ventana SQL acepta. Si es @code{-1}, podrá entonces recibir cualquier cantidad de argumentos.

@item 
@code{aggregate_class} (@ref{193b,,class} | None) – Una clase debe implementar los siguientes métodos:  * @code{step()}: Agrega una fila a la ventana actual. * @code{value()}: Retorna el valor actual del `aggregate' . * @code{inverse()}: Elimina una fila de la ventana actual. * @code{finalize()}: Retorna el resultado final del `aggregate' como una @ref{28df,,un tipo soportado nativamente por SQLite}. La cantidad de argumentos que los métodos @code{step()} y @code{value()} pueden aceptar son controlados por `num_params'. Establece @code{None} para eliminar una función agregada de ventana SQL.
@end itemize


@*Muestra: 
@ref{290e,,NotSupportedError} – Si es usado con una versión de SQLite inferior a 3.25.0, la cual no soporte funciones agregadas de ventana.



Added in version 3.11.


Ejemplo:

@example
# Example taken from https://www.sqlite.org/windowfunctions.html#udfwinfunc
class WindowSumInt:
    def __init__(self):
        self.count = 0

    def step(self, value):
        """Add a row to the current window."""
        self.count += value

    def value(self):
        """Return the current value of the aggregate."""
        return self.count

    def inverse(self, value):
        """Remove a row from the current window."""
        self.count -= value

    def finalize(self):
        """Return the final value of the aggregate.

        Any clean-up actions should be placed here.
        """
        return self.count


con = sqlite3.connect(":memory:")
cur = con.execute("CREATE TABLE test(x, y)")
values = [
    ("a", 4),
    ("b", 5),
    ("c", 3),
    ("d", 8),
    ("e", 1),
]
cur.executemany("INSERT INTO test VALUES(?, ?)", values)
con.create_window_function("sumint", 1, WindowSumInt)
cur.execute("""
    SELECT x, sumint(y) OVER (
        ORDER BY x ROWS BETWEEN 1 PRECEDING AND 1 FOLLOWING
    ) AS sum_y
    FROM test ORDER BY x
""")
print(cur.fetchall())
con.close()
@end example

@c [('a', 9), ('b', 12), ('c', 16), ('d', 12), ('e', 9)]
@end deffn

@geindex create_collation() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_collation}@anchor{717}
@deffn {Método} create_collation (name, callable, /)

Crea una colación nombrada `name' usando la función `collating' `callable'. A `callable' se le pasan dos argumentos @ref{237,,string}, y este debería retornar un @ref{1f0,,entero}:


@itemize *

@item 
@code{1} si el primero es ordenado más alto que el segundo

@item 
@code{-1} si el primero es ordenado más pequeño que el segundo

@item 
@code{0} si están ordenados de manera igual
@end itemize

El siguiente ejemplo muestra una ordenación de colación inversa:

@example
def collate_reverse(string1, string2):
    if string1 == string2:
        return 0
    elif string1 < string2:
        return 1
    else:
        return -1

con = sqlite3.connect(":memory:")
con.create_collation("reverse", collate_reverse)

cur = con.execute("CREATE TABLE test(x)")
cur.executemany("INSERT INTO test(x) VALUES(?)", [("a",), ("b",)])
cur.execute("SELECT x FROM test ORDER BY x COLLATE reverse")
for row in cur:
    print(row)
con.close()
@end example

@c ('b',)
@c ('a',)

Elimina una función de colación al establecer el `callable' como @code{None}.


Distinto en la versión 3.11: El nombre de la colación puede contener cualquier caracter Unicode. Anteriormente, solamente caracteres ASCII eran permitidos.

@end deffn

@geindex interrupt() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection interrupt}@anchor{290f}
@deffn {Método} interrupt ()

Call this method from a different thread to abort any queries that might
be executing on the connection.
Aborted queries will raise an @ref{18a6,,OperationalError}.
@end deffn

@geindex set_authorizer() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_authorizer}@anchor{3f8}
@deffn {Método} set_authorizer (authorizer_callback)

Register @ref{28ea,,callable} `authorizer_callback' to be invoked
for each attempt to access a column of a table in the database.
The callback should return one of @ref{28ed,,SQLITE_OK},
@ref{28ee,,SQLITE_DENY}, or @ref{28ef,,SQLITE_IGNORE}
to signal how access to the column should be handled
by the underlying SQLite library.

El primer argumento del callback significa que tipo de operación será autorizada. El segundo y tercer argumento serán argumentos o @code{None} dependiendo del primer argumento. El cuarto argumento es el nombre de la base de datos («main», «temp», etc.) si aplica. El quinto argumento es el nombre del disparador más interno o vista que es responsable por los intentos de acceso o @code{None} si este intento de acceso es directo desde el código SQL de entrada.

Por favor consulte la documentación de SQLite sobre los posibles valores para el primer argumento y el significado del segundo y tercer argumento dependiendo del primero. Todas las constantes necesarias están disponibles en el módulo @code{sqlite3}.

Pasando @code{None} como `authorizer_callback' deshabilitará el autorizador.


Distinto en la versión 3.11: Agregado soporte para deshabilitar el autorizador usando @code{None}.



Distinto en la versión 3.13: Passing `authorizer_callback' as a keyword argument is deprecated.
The parameter will become positional-only in Python 3.15.

@end deffn

@geindex set_progress_handler() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_progress_handler}@anchor{3f9}
@deffn {Método} set_progress_handler (progress_handler, n)

Register @ref{28ea,,callable} `progress_handler' to be invoked for every `n'
instructions of the SQLite virtual machine. This is useful if you want to
get called from SQLite during long-running operations, for example to update
a GUI.

Si se desea limpiar cualquier `progress_handler' instalado anteriormente, llame el método con @code{None} para `progress_handler'.

Returning a non-zero value from the handler function will terminate the
currently executing query and cause it to raise a @ref{2910,,DatabaseError}
exception.


Distinto en la versión 3.13: Passing `progress_handler' as a keyword argument is deprecated.
The parameter will become positional-only in Python 3.15.

@end deffn

@geindex set_trace_callback() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_trace_callback}@anchor{3fa}
@deffn {Método} set_trace_callback (trace_callback)

Register @ref{28ea,,callable} `trace_callback' to be invoked
for each SQL statement that is actually executed by the SQLite backend.

El único argumento pasado a la retrollamada es la declaración (como @ref{237,,str}) que se está ejecutando. El valor de retorno de la retrollamada es ignorado. Tenga en cuenta que el backend no solo ejecuta declaraciones pasadas a los métodos @ref{400,,Cursor.execute()}. Otras fuentes incluyen el @ref{28d5,,transaction management} del módulo @code{sqlite3} y la ejecución de disparadores definidos en la base de datos actual.

Pasando @code{None} como `trace_callback' deshabilitará el `trace callback'.

@cartouche
@quotation Nota 
Las excepciones que se producen en la llamada de retorno no se propagan. Como ayuda para el desarrollo y la depuración, utilice @ref{28e8,,enable_callback_tracebacks()} para habilitar la impresión de `tracebacks' de las excepciones que se producen en la llamada de retorno.
@end quotation
@end cartouche


Added in version 3.3.



Distinto en la versión 3.13: Passing `trace_callback' as a keyword argument is deprecated.
The parameter will become positional-only in Python 3.15.

@end deffn

@geindex enable_load_extension() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection enable_load_extension}@anchor{8d5}
@deffn {Método} enable_load_extension (enabled, /)

Habilita el motor de SQLite para cargar extensiones SQLite de bibliotecas compartidas si `enabled' se establece como @code{True}; sino deshabilitará la carga de extensiones SQLite. Las extensiones SQLite pueden definir implementaciones de nuevas funciones, agregaciones, o tablas virtuales enteras. Una extensión bien conocida es `fulltext-search' distribuida con SQLite.

@cartouche
@quotation Nota 
El módulo @code{sqlite3} no está construido con soporte de extensión cargable de forma predeterminada, porque algunas plataformas (especialmente macOS) tienen bibliotecas SQLite que se compilan sin esta función. Para obtener soporte para extensiones cargables, debe pasar la opción @ref{1d72,,--enable-loadable-sqlite-extensions} a @code{configure}.
@end quotation
@end cartouche

Lanza un @ref{18c3,,auditing event} @code{sqlite3.enable_load_extension} con los argumentos @code{connection}, @code{enabled}.


Added in version 3.2.



Distinto en la versión 3.10: Agregado el evento de auditoría @code{sqlite3.enable_load_extension}.


@c We cannot doctest the load extension API, since there is no convenient
@c way to skip it.

@example
con.enable_load_extension(True)

# Load the fulltext search extension
con.execute("select load_extension('./fts3.so')")

# alternatively you can load the extension using an API call:
# con.load_extension("./fts3.so")

# disable extension loading again
con.enable_load_extension(False)

# example from SQLite wiki
con.execute("CREATE VIRTUAL TABLE recipe USING fts3(name, ingredients)")
con.executescript("""
    INSERT INTO recipe (name, ingredients) VALUES('broccoli stew', 'broccoli peppers cheese tomatoes');
    INSERT INTO recipe (name, ingredients) VALUES('pumpkin stew', 'pumpkin onions garlic celery');
    INSERT INTO recipe (name, ingredients) VALUES('broccoli pie', 'broccoli cheese onions flour');
    INSERT INTO recipe (name, ingredients) VALUES('pumpkin pie', 'pumpkin sugar flour butter');
    """)
for row in con.execute("SELECT rowid, name, ingredients FROM recipe WHERE name MATCH 'pie'"):
    print(row)
@end example
@end deffn

@geindex load_extension() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection load_extension}@anchor{55f}
@deffn {Método} load_extension (path, /, *, entrypoint=None)

Load an SQLite extension from a shared library.
Enable extension loading with @ref{8d5,,enable_load_extension()} before
calling this method.

@*Parámetros: 

@itemize *

@item 
@code{path} (@ref{237,,str}) – The path to the SQLite extension.

@item 
@code{entrypoint} (@ref{237,,str}@code{ | }@code{None}) – Entry point name.
If @code{None} (the default),
SQLite will come up with an entry point name of its own;
see the SQLite docs Loading an Extension@footnote{https://www.sqlite.org/loadext.html#loading_an_extension} for details.
@end itemize


Lanza un @ref{18c3,,auditing event} @code{sqlite3.load_extension} con argumentos @code{connection}, @code{path}.


Added in version 3.2.



Distinto en la versión 3.10: Agregado el evento de auditoría @code{sqlite3.load_extension}.



Distinto en la versión 3.12: Added the `entrypoint' parameter.

@end deffn

@geindex iterdump() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection iterdump}@anchor{3a0}
@deffn {Método} iterdump (*, filter=None)

Retorna un @ref{313,,iterator} para volcar la base de datos en un texto de formato SQL. Es útil cuando guardamos una base de datos en memoria para una posterior restauración. Esta función provee las mismas capacidades que el comando @code{.dump} en el `shell' @code{sqlite3}.

@*Parámetros: 
@code{filter} (@ref{237,,str}@code{ | }@code{None}) – An optional @code{LIKE} pattern for database objects to dump, e.g. @code{prefix_%}.
If @code{None} (the default), all database objects will be included.


Ejemplo:

@example
# Convert file example.db to SQL dump file dump.sql
con = sqlite3.connect('example.db')
with open('dump.sql', 'w') as f:
    for line in con.iterdump():
        f.write('%s\n' % line)
con.close()
@end example


@subsubheading Ver también


@ref{2911,,How to handle non-UTF-8 text encodings}



Distinto en la versión 3.13: Added the `filter' parameter.

@end deffn

@geindex backup() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection backup}@anchor{c02}
@deffn {Método} backup (target, *, pages=-1, progress=None, name='main', sleep=0.250)

Crea una copia de seguridad de la base de datos SQLite.

Funciona incluso si la base de datos está siendo accedida por otros clientes al mismo tiempo sobre la misma conexión.

@*Parámetros: 

@itemize *

@item 
@code{target} (@ref{39e,,Connection}) – La conexión de la base de datos para guardar la copia de seguridad.

@item 
@code{pages} (@ref{1f0,,int}) – Cantidad de páginas que serán copiadas cada vez. Si es menor o igual a @code{0}, toda la base de datos será copiada en un solo paso. El valor por defecto es @code{-1}.

@item 
@code{progress} (@ref{290d,,callback} | None) – If set to a @ref{28ea,,callable},
it is invoked with three integer arguments for every backup iteration:
the `status' of the last iteration,
the `remaining' number of pages still to be copied,
and the `total' number of pages.
Defaults to @code{None}.

@item 
@code{name} (@ref{237,,str}) – El nombre de la base de datos a ser guardada. O bien sea @code{"main"} (valor por defecto) para la base de datos `main', @code{"temp"} para la base de datos temporal, o el nombre de una base de datos personalizada adjuntada usando la sentencia @code{ATTACH DATABASE}.

@item 
@code{sleep} (@ref{153,,float}) – Número de segundos a dormir entre sucesivos intentos para respaldar páginas restantes.
@end itemize


Ejemplo 1, copiar una base de datos existente en otra:

@example
def progress(status, remaining, total):
    print(f'Copied @{total-remaining@} of @{total@} pages...')

src = sqlite3.connect('example.db')
dst = sqlite3.connect('backup.db')
with dst:
    src.backup(dst, pages=1, progress=progress)
dst.close()
src.close()
@end example

@c Copied 0 of 0 pages...

Ejemplo 2: copiar una base de datos existente en una copia transitoria:

@example
src = sqlite3.connect('example.db')
dst = sqlite3.connect(':memory:')
src.backup(dst)
dst.close()
src.close()
@end example


Added in version 3.7.



@subsubheading Ver también


@ref{2911,,How to handle non-UTF-8 text encodings}

@end deffn

@geindex getlimit() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection getlimit}@anchor{71c}
@deffn {Método} getlimit (category, /)

Obtiene el límite de tiempo de ejecución de una conexión.

@*Parámetros: 
@code{category} (@ref{1f0,,int}) – La SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html} a ser consultada.


@*Tipo del valor devuelto: 
@ref{1f0,,int}


@*Muestra: 
@ref{223,,ProgrammingError} – Si `category' no se reconoce por las capas inferiores de la biblioteca SQLite.


Ejemplo, consulta el tamaño máximo de una sentencia SQL para la @ref{39e,,Connection} @code{con} (el valor por defecto es 1000000000):

@c import sqlite3
@c con = sqlite3.connect(":memory:")
@c con.setlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH, 1_000_000_000)
@c con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 10)

@example
>>> con.getlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH)
1000000000
@end example


Added in version 3.11.

@end deffn

@geindex setlimit() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection setlimit}@anchor{71b}
@deffn {Método} setlimit (category, limit, /)

Set a connection runtime limit.
Attempts to increase a limit above its hard upper bound are silently
truncated to the hard upper bound. Regardless of whether or not the limit
was changed, the prior value of the limit is returned.

@*Parámetros: 

@itemize *

@item 
@code{category} (@ref{1f0,,int}) – La SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html} a ser establecido.

@item 
@code{limit} (@ref{1f0,,int}) – El valor del nuevo límite. Si es negativo, el límite actual no cambia.
@end itemize


@*Tipo del valor devuelto: 
@ref{1f0,,int}


@*Muestra: 
@ref{223,,ProgrammingError} – Si `category' no se reconoce por las capas inferiores de la biblioteca SQLite.


Por ejemplo, limite el número de bases de datos adjuntas a 1 para la @ref{39e,,Connection} @code{con} (el valor por defecto es 10):

@example
>>> con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 1)
10
>>> con.getlimit(sqlite3.SQLITE_LIMIT_ATTACHED)
1
@end example

@c con.close()


Added in version 3.11.

@end deffn

@geindex getconfig() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection getconfig}@anchor{560}
@deffn {Método} getconfig (op, /)

Query a boolean connection configuration option.

@*Parámetros: 
@code{op} (@ref{1f0,,int}) – A @ref{28f4,,SQLITE_DBCONFIG code}.


@*Tipo del valor devuelto: 
@ref{513,,bool}



Added in version 3.12.

@end deffn

@geindex setconfig() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection setconfig}@anchor{561}
@deffn {Método} setconfig (op, enable=True, /)

Set a boolean connection configuration option.

@*Parámetros: 

@itemize *

@item 
@code{op} (@ref{1f0,,int}) – A @ref{28f4,,SQLITE_DBCONFIG code}.

@item 
@code{enable} (@ref{513,,bool}) – @code{True} if the configuration option should be enabled (default);
@code{False} if it should be disabled.
@end itemize



Added in version 3.12.

@end deffn

@geindex serialize() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection serialize}@anchor{71f}
@deffn {Método} serialize (*, name='main')

Serializa la base de datos en un objeto @ref{325,,bytes}. Para un archivo ordinario de base de datos en disco, la serialización es solo una copia del archivo de disco. Para el caso de una base de datos en memoria o una base de datos «temp», la serialización es la misma secuencia de bytes que se escribiría en el disco si se hiciera una copia de seguridad de esa base de datos en el disco.

@*Parámetros: 
@code{name} (@ref{237,,str}) – El nombre de la base de datos a ser serializada. El valor por defecto es @code{"main"}.


@*Tipo del valor devuelto: 
@ref{325,,bytes}


@cartouche
@quotation Nota 
Este método solo está disponible si las capas internas de la biblioteca SQLite tienen la API `serialise'.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex deserialize() (método de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection deserialize}@anchor{720}
@deffn {Método} deserialize (data, /, *, name='main')

Deserializa una base de datos @ref{71f,,serializsda} en una clase @ref{39e,,Connection}. Este método hace que la conexión de base de datos se desconecte de la base de datos `name', y la abre nuevamente como una base de datos en memoria, basada en la serialización contenida en `data'.

@*Parámetros: 

@itemize *

@item 
@code{data} (@ref{325,,bytes}) – Una base de datos serializada.

@item 
@code{name} (@ref{237,,str}) – El nombre de la base de datos a ser deserializada. El valor por defecto es @code{"main"}.
@end itemize


@*Muestra: 

@itemize *

@item 
@ref{18a6,,OperationalError} – Si la conexión con la base de datos está actualmente involucrada en una transacción de lectura o una operación de copia de seguridad.

@item 
@ref{2910,,DatabaseError} – Si `data' no contiene una base de datos SQLite válida.

@item 
@ref{919,,OverflowError} – Si @ref{6cf,,len(data)} es más grande que @code{2**63 - 1}.
@end itemize


@cartouche
@quotation Nota 
Este método solo está disponible si las capas internas de la biblioteca SQLite tienen la API `deserialize'.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex autocommit (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection autocommit}@anchor{55d}
@deffn {Atributo} autocommit

This attribute controls 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant transaction behaviour.
@code{autocommit} has three allowed values:


@itemize *

@item 
@code{False}: Select 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant transaction behaviour,
implying that @code{sqlite3} ensures a transaction is always open.
Use @ref{28d6,,commit()} and @ref{2908,,rollback()} to close transactions.

This is the recommended value of @code{autocommit}.

@item 
@code{True}: Use SQLite’s autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}.
@ref{28d6,,commit()} and @ref{2908,,rollback()} have no effect in this mode.

@item 
@ref{28e5,,LEGACY_TRANSACTION_CONTROL}:
Pre-Python 3.12 (non-
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant) transaction control.
See @ref{28e3,,isolation_level} for more details.

This is currently the default value of @code{autocommit}.
@end itemize

Changing @code{autocommit} to @code{False} will open a new transaction,
and changing it to @code{True} will commit any pending transaction.

See @ref{55e,,Transaction control via the autocommit attribute} for more details.

@cartouche
@quotation Nota 
The @ref{28e3,,isolation_level} attribute has no effect unless
@ref{55d,,autocommit} is @ref{28e5,,LEGACY_TRANSACTION_CONTROL}.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex in_transaction (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection in_transaction}@anchor{2912}
@deffn {Atributo} in_transaction

Este atributo de solo lectura corresponde al autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions} de SQLite de bajo nivel.

@code{True} si una transacción está activa (existen cambios sin confirmar),`@w{`}False`@w{`} en caso contrario.


Added in version 3.2.

@end deffn

@geindex isolation_level (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection isolation_level}@anchor{28e3}
@deffn {Atributo} isolation_level

Controls the @ref{28e4,,legacy transaction handling mode} of @code{sqlite3}.
If set to @code{None}, transactions are never implicitly opened.
If set to one of @code{"DEFERRED"}, @code{"IMMEDIATE"}, or @code{"EXCLUSIVE"},
corresponding to the underlying SQLite transaction behaviour@footnote{https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions},
@ref{28e4,,implicit transaction management} is performed.

Si no se sobreescribe por el parámetro `isolation_level' de @ref{3f5,,connect()}, el valor predeterminado es @code{""}, que es un alias para @code{"DEFERRED"}.

@cartouche
@quotation Nota 
Using @ref{55d,,autocommit} to control transaction handling is
recommended over using @code{isolation_level}.
@code{isolation_level} has no effect unless @ref{55d,,autocommit} is
set to @ref{28e5,,LEGACY_TRANSACTION_CONTROL} (the default).
@end quotation
@end cartouche
@end deffn

@geindex row_factory (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection row_factory}@anchor{163a}
@deffn {Atributo} row_factory

The initial @ref{2913,,row_factory}
for @ref{28d3,,Cursor} objects created from this connection.
Assigning to this attribute does not affect the @code{row_factory}
of existing cursors belonging to this connection, only new ones.
Is @code{None} by default,
meaning each row is returned as a @ref{464,,tuple}.

See @ref{28da,,How to create and use row factories} for more details.
@end deffn

@geindex text_factory (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection text_factory}@anchor{2914}
@deffn {Atributo} text_factory

A @ref{28ea,,callable} that accepts a @ref{325,,bytes} parameter
and returns a text representation of it.
The callable is invoked for SQLite values with the @code{TEXT} data type.
By default, this attribute is set to @ref{237,,str}.

See @ref{2911,,How to handle non-UTF-8 text encodings} for more details.
@end deffn

@geindex total_changes (atributo de sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection total_changes}@anchor{2915}
@deffn {Atributo} total_changes

Retorna el número total de filas de la base de datos que han sido modificadas, insertadas o borradas desde que la conexión a la base de datos fue abierta.
@end deffn
@end deffn

@node Objetos cursor,Objetos fila Row,Objetos de conexión,Referencia
@anchor{library/sqlite3 cursor-objects}@anchor{2916}@anchor{library/sqlite3 sqlite3-cursor-objects}@anchor{2917}
@subsubsection Objetos cursor


@quotation

Un objeto @code{Cursor} representa un database cursor@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)} que se utiliza para ejecutar sentencias SQL y administrar el contexto de una operación de búsqueda. Los cursores son creados usando @ref{28d2,,Connection.cursor()}, o por usar alguno de los @ref{2907,,connection shortcut methods}.

Los objetos cursores son @ref{313,,iterators}, lo que significa que si @ref{400,,execute()} una consulta @code{SELECT}, simplemente podrás iterar sobre el cursor para obtener las filas resultantes:

@c import sqlite3
@c con = sqlite3.connect(":memory:", isolation_level=None)
@c cur = con.execute("CREATE TABLE data(t)")
@c cur.execute("INSERT INTO data VALUES(1)")

@example
for row in cur.execute("SELECT t FROM data"):
    print(row)
@end example

@c (1,)
@end quotation

@geindex Cursor (clase en sqlite3)
@anchor{library/sqlite3 sqlite3 Cursor}@anchor{28d3}
@deffn {Clase} sqlite3.Cursor

Una instancia @ref{28d3,,Cursor} tiene los siguientes atributos y métodos.

@geindex ? (question mark);in SQL statements

@geindex ; (colon);in SQL statements

@geindex execute() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor execute}@anchor{400}
@deffn {Método} execute (sql, parameters=(), /)

Execute a single SQL statement,
optionally binding Python values using
@ref{402,,placeholders}.

@*Parámetros: 

@itemize *

@item 
@code{sql} (@ref{237,,str}) – A single SQL statement.

@item 
@code{parameters} (@ref{190,,dict} | @ref{597,,sequence}) – Python values to bind to placeholders in `sql'.
A @code{dict} if named placeholders are used.
A sequence if unnamed placeholders are used.
See @ref{402,,Cómo usar marcadores de posición para vincular valores en consultas SQL}.
@end itemize


@*Muestra: 
@ref{223,,ProgrammingError} – If `sql' contains more than one SQL statement.


If @ref{55d,,autocommit} is
@ref{28e5,,LEGACY_TRANSACTION_CONTROL},
@ref{28e3,,isolation_level} is not @code{None},
`sql' is an @code{INSERT}, @code{UPDATE}, @code{DELETE}, or @code{REPLACE} statement,
and there is no open transaction,
a transaction is implicitly opened before executing `sql'.


Deprecated since version 3.12, removed in version 3.14: @ref{1da,,DeprecationWarning} is emitted if
@ref{402,,named placeholders} are used
and `parameters' is a sequence instead of a @ref{190,,dict}.
Starting with Python 3.14, @ref{223,,ProgrammingError} will
be raised instead.


Use @ref{290c,,executescript()} to execute multiple SQL statements.
@end deffn

@geindex executemany() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor executemany}@anchor{401}
@deffn {Método} executemany (sql, parameters, /)

For every item in `parameters',
repeatedly execute the @ref{402,,parameterized}
@abbr{DML,Data Manipulation Language} SQL statement `sql'.

Uses the same implicit transaction handling as @ref{400,,execute()}.

@*Parámetros: 

@itemize *

@item 
@code{sql} (@ref{237,,str}) – A single SQL DML statement.

@item 
@code{parameters} (@ref{1294,,iterable}) – An iterable of parameters to bind with
the placeholders in `sql'.
See @ref{402,,Cómo usar marcadores de posición para vincular valores en consultas SQL}.
@end itemize


@*Muestra: 
@ref{223,,ProgrammingError} – If `sql' contains more than one SQL statement,
or is not a DML statement.


Ejemplo:

@example
rows = [
    ("row1",),
    ("row2",),
]
# cur is an sqlite3.Cursor object
cur.executemany("INSERT INTO data VALUES(?)", rows)
@end example

@c con.close()

@cartouche
@quotation Nota 
Any resulting rows are discarded,
including DML statements with RETURNING clauses@footnote{https://www.sqlite.org/lang_returning.html}.
@end quotation
@end cartouche


Deprecated since version 3.12, removed in version 3.14: @ref{1da,,DeprecationWarning} is emitted if
@ref{402,,named placeholders} are used
and the items in `parameters' are sequences
instead of @ref{190,,dict}s.
Starting with Python 3.14, @ref{223,,ProgrammingError} will
be raised instead.

@end deffn

@geindex executescript() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor executescript}@anchor{290c}
@deffn {Método} executescript (sql_script, /)

Execute the SQL statements in `sql_script'.
If the @ref{55d,,autocommit} is
@ref{28e5,,LEGACY_TRANSACTION_CONTROL}
and there is a pending transaction,
an implicit @code{COMMIT} statement is executed first.
No other implicit transaction control is performed;
any transaction control must be added to `sql_script'.

`sql_script' debe ser una instancia de @ref{237,,string}.

Ejemplo:

@example
# cur is an sqlite3.Cursor object
cur.executescript("""
    BEGIN;
    CREATE TABLE person(firstname, lastname, age);
    CREATE TABLE book(title, author, published);
    CREATE TABLE publisher(name, address);
    COMMIT;
""")
@end example
@end deffn

@geindex fetchone() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchone}@anchor{28d4}
@deffn {Método} fetchone ()

If @ref{2913,,row_factory} is @code{None},
return the next row query result set as a @ref{464,,tuple}.
Else, pass it to the row factory and return its result.
Return @code{None} if no more data is available.
@end deffn

@geindex fetchmany() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchmany}@anchor{2918}
@deffn {Método} fetchmany (size=cursor.arraysize)

Retorna el siguiente conjunto de filas del resultado de una consulta como una @ref{18e,,list}. Una lista vacía será retornada cuando no hay más filas disponibles.

El número de filas que se van a obtener por llamada se especifica mediante el parámetro `size'. Si `size' no es informado, entonces @ref{2919,,arraysize} determinará el número de filas que se van a recuperar. Si hay menos filas `size' disponibles, se retornan tantas filas como estén disponibles.

Nótese que hay consideraciones de desempeño involucradas con el parámetro `size'. Para un optimo desempeño, es usualmente mejor usar el atributo `arraysize'. Si el parámetro `size' es usado, entonces es mejor retener el mismo valor de una llamada @ref{2918,,fetchmany()} a la siguiente.
@end deffn

@geindex fetchall() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchall}@anchor{28d7}
@deffn {Método} fetchall ()

Retorna todas las filas (restantes) de un resultado de consulta como @ref{18e,,list}. Retorna una lista vacía si no hay filas disponibles. Tenga en cuenta que el atributo @ref{2919,,arraysize} puede afectar al rendimiento de esta operación.
@end deffn

@geindex close() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor close}@anchor{291a}
@deffn {Método} close ()

Cierra el cursor ahora (en lugar que cuando @code{__del__} es llamado)

El cursor no será usable de este punto en adelante; una excepción @ref{223,,ProgrammingError} será lanzada si se intenta cualquier operación con el cursor.
@end deffn

@geindex setinputsizes() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor setinputsizes}@anchor{291b}
@deffn {Método} setinputsizes (sizes, /)

Requerido por la DB-API. No hace nada en @code{sqlite3}.
@end deffn

@geindex setoutputsize() (método de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor setoutputsize}@anchor{291c}
@deffn {Método} setoutputsize (size, column=None, /)

Requerido por la DB-API. No hace nada en @code{sqlite3}.
@end deffn

@geindex arraysize (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor arraysize}@anchor{2919}
@deffn {Atributo} arraysize

Atributo de lectura/escritura que controla el número de filas retornadas por @ref{2918,,fetchmany()}. El valor por defecto es 1, lo cual significa que una única fila será obtenida por llamada.
@end deffn

@geindex connection (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor connection}@anchor{291d}
@deffn {Atributo} connection

Este atributo de solo lectura que provee la @ref{39e,,Connection} de la base de datos SQLite pertenece al cursor. Un objeto @ref{28d3,,Cursor} creado llamando a @ref{28d2,,con.cursor()} tendrá un atributo @ref{291d,,connection} que hace referencia a `con':

@example
>>> con = sqlite3.connect(":memory:")
>>> cur = con.cursor()
>>> cur.connection == con
True
>>> con.close()
@end example
@end deffn

@geindex description (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor description}@anchor{291e}
@deffn {Atributo} description

Este atributo de solo lectura provee el nombre de las columnas de la última consulta. Para seguir siendo compatible con la API de base de datos de Python, retornará una tupla de 7 elementos para cada columna donde los últimos seis elementos de cada tupla son @code{Ninguno}.

También es configurado para sentencias @code{SELECT} sin ninguna fila coincidente.
@end deffn

@geindex lastrowid (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor lastrowid}@anchor{d58}
@deffn {Atributo} lastrowid

Atributo de solo lectura que proporciona el identificador de fila de la última insertada. Solo se actualiza después de que las sentencias @code{INSERT} o @code{REPLACE} hayan sido exitosas usando el método @ref{400,,execute()}. Para otras instrucciones, después de @ref{401,,executemany()} o @ref{290c,,executescript()}, o si se produjo un error en la inserción, el valor de @code{lastrowid} se deja sin cambios. El valor inicial de @code{lastrowid} es @code{None}.

@cartouche
@quotation Nota 
Las inserciones en tablas @code{WITHOUT ROWID} no se registran.
@end quotation
@end cartouche


Distinto en la versión 3.6: Se agregó soporte para sentencias @code{REPLACE}.

@end deffn

@geindex rowcount (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor rowcount}@anchor{17dd}
@deffn {Atributo} rowcount

Read-only attribute that provides the number of modified rows for
@code{INSERT}, @code{UPDATE}, @code{DELETE}, and @code{REPLACE} statements;
is @code{-1} for other statements,
including @abbr{CTE,Common Table Expression} queries.
It is only updated by the @ref{400,,execute()} and @ref{401,,executemany()} methods,
after the statement has run to completion.
This means that any resulting rows must be fetched in order for
@code{rowcount} to be updated.
@end deffn

@geindex row_factory (atributo de sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor row_factory}@anchor{2913}
@deffn {Atributo} row_factory

Control how a row fetched from this @code{Cursor} is represented.
If @code{None}, a row is represented as a @ref{464,,tuple}.
Can be set to the included @ref{ef1,,sqlite3.Row};
or a @ref{28ea,,callable} that accepts two arguments,
a @ref{28d3,,Cursor} object and the @code{tuple} of row values,
and returns a custom object representing an SQLite row.

Defaults to what @ref{163a,,Connection.row_factory} was set to
when the @code{Cursor} was created.
Assigning to this attribute does not affect
@ref{163a,,Connection.row_factory} of the parent connection.

See @ref{28da,,How to create and use row factories} for more details.
@end deffn
@end deffn

@c The sqlite3.Row example used to be a how-to. It has now been incorporated
@c into the Row reference. We keep the anchor here in order not to break
@c existing links.
@anchor{library/sqlite3 sqlite3-columns-by-name}@anchor{291f}
@node Objetos fila Row,Objetos fila Row<2>,Objetos cursor,Referencia
@anchor{library/sqlite3 row-objects}@anchor{2920}@anchor{library/sqlite3 sqlite3-row-objects}@anchor{2921}
@subsubsection Objetos fila (`Row')


@geindex Row (clase en sqlite3)
@anchor{library/sqlite3 sqlite3 Row}@anchor{ef1}
@deffn {Clase} sqlite3.Row

Una instancia de @code{Row} sirve como una instancia @ref{163a,,row_factory} altamente optimizada para objetos @ref{39e,,Connection}. Admite iteración, pruebas de igualdad, acceso a @ref{6cf,,len()} y @ref{1229,,mapping} por nombre de columna e índice.

Two @code{Row} objects compare equal
if they have identical column names and values.

See @ref{28da,,How to create and use row factories} for more details.

@geindex keys() (método de sqlite3.Row)
@anchor{library/sqlite3 sqlite3 Row keys}@anchor{2922}
@deffn {Método} keys ()

Este método retorna una @ref{18e,,list} con los nombre de columnas como @ref{237,,strings}. Inmediatamente después de una consulta, es el primer miembro de cada tupla en @ref{291e,,Cursor.description}.
@end deffn


Distinto en la versión 3.5: Agrega soporte para segmentación.

@end deffn

@node Objetos fila Row<2>,Objetos PrepareProtocol,Objetos fila Row,Referencia
@anchor{library/sqlite3 blob-objects}@anchor{2923}@anchor{library/sqlite3 sqlite3-blob-objects}@anchor{2924}
@subsubsection Objetos fila (`Row')


@geindex Blob (clase en sqlite3)
@anchor{library/sqlite3 sqlite3 Blob}@anchor{723}
@deffn {Clase} sqlite3.Blob


Added in version 3.11.


Una instancia @ref{723,,Blob} es un @ref{2586,,file-like object} que puede leer y escribir datos en un SQLite @abbr{BLOB}. Llame a @ref{6cf,,len(blob)} para obtener el tamaño (número de bytes) del blob. Use índices y @ref{2185,,slices} para obtener acceso directo a los datos del blob.

Use @ref{723,,Blob} como @ref{675,,context manager} para asegurarse de que el identificador de blob se cierra después de su uso.

@example
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE test(blob_col blob)")
con.execute("INSERT INTO test(blob_col) VALUES(zeroblob(13))")

# Write to our blob, using two write operations:
with con.blobopen("test", "blob_col", 1) as blob:
    blob.write(b"hello, ")
    blob.write(b"world.")
    # Modify the first and last bytes of our blob
    blob[0] = ord("H")
    blob[-1] = ord("!")

# Read the contents of our blob
with con.blobopen("test", "blob_col", 1) as blob:
    greeting = blob.read()

print(greeting)  # outputs "b'Hello, world!'"
con.close()
@end example

@c b'Hello, world!'

@geindex close() (método de sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob close}@anchor{2925}
@deffn {Método} close ()

Cierra el `blob'.

El cursor no será usable de este punto en adelante; una excepción @ref{1888,,Error} (o subclase) será lanzada si se intenta cualquier operación con el cursor.
@end deffn

@geindex read() (método de sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob read}@anchor{2926}
@deffn {Método} read (length=-1, /)

Leer bytes `length' de datos del blob en la posición de desplazamiento actual. Si se alcanza el final del blob, se devolverán los datos hasta @abbr{EOF,End of File}. Cuando `length' no se especifica, o es negativo, @ref{2926,,read()} se leerá hasta el final del blob.
@end deffn

@geindex write() (método de sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob write}@anchor{2927}
@deffn {Método} write (data, /)

Escriba `data' en el blob en el desplazamiento actual. Esta función no puede cambiar la longitud del blob. Escribir más allá del final del blob generará un @ref{360,,ValueError}.
@end deffn

@geindex tell() (método de sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob tell}@anchor{2928}
@deffn {Método} tell ()

Devolver la posición de acceso actual del blob.
@end deffn

@geindex seek() (método de sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob seek}@anchor{2929}
@deffn {Método} seek (offset, origin=os.SEEK_SET, /)

Set the current access position of the blob to `offset'.  The `origin'
argument defaults to @ref{12fa,,os.SEEK_SET} (absolute blob positioning).
Other values for `origin' are @ref{12fb,,os.SEEK_CUR} (seek relative to the
current position) and @ref{12fc,,os.SEEK_END} (seek relative to the blob’s
end).
@end deffn
@end deffn

@node Objetos PrepareProtocol,Excepciones<6>,Objetos fila Row<2>,Referencia
@anchor{library/sqlite3 prepareprotocol-objects}@anchor{292a}
@subsubsection Objetos PrepareProtocol


@geindex PrepareProtocol (clase en sqlite3)
@anchor{library/sqlite3 sqlite3 PrepareProtocol}@anchor{17e9}
@deffn {Clase} sqlite3.PrepareProtocol

El único propósito del tipo `PrepareProtocol' es actuar como un protocolo de adaptación de estilo 
@geindex Python Enhancement Proposals; PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} para objetos que pueden @ref{292b,,adapt themselves} a @ref{28df,,native SQLite types}.
@end deffn

@node Excepciones<6>,SQLite y tipos de Python,Objetos PrepareProtocol,Referencia
@anchor{library/sqlite3 exceptions}@anchor{292c}@anchor{library/sqlite3 sqlite3-exceptions}@anchor{292d}
@subsubsection Excepciones


La jerarquía de excepciones está definida por DB-API 2.0 (
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}).

@geindex Warning
@anchor{library/sqlite3 sqlite3 Warning}@anchor{182c}
@deffn {Excepción} sqlite3.Warning

Esta excepción no se genera actualmente en el módulo @code{sqlite3}, pero puede ser provocada por aplicaciones que usan :mod:!sqlite3`, por ejemplo, si una función definida por el usuario trunca datos durante la inserción. @code{Warning} es una subclase de @ref{a6b,,Exception}.
@end deffn

@geindex Error
@anchor{library/sqlite3 sqlite3 Error}@anchor{1888}
@deffn {Excepción} sqlite3.Error

La clase base de las otras excepciones de este módulo. Use esto para detectar todos los errores con una sola instrucción @ref{2f6,,except}.`@w{`}Error`@w{`} is una subclase de @ref{a6b,,Exception}.

Si la excepción se originó dentro de la biblioteca SQLite, se agregan los siguientes dos atributos a la excepción:

@geindex sqlite_errorcode (atributo de sqlite3.Error)
@anchor{library/sqlite3 sqlite3 Error sqlite_errorcode}@anchor{719}
@deffn {Atributo} sqlite_errorcode

El código de error numérico de SQLite API@footnote{https://sqlite.org/rescode.html}


Added in version 3.11.

@end deffn

@geindex sqlite_errorname (atributo de sqlite3.Error)
@anchor{library/sqlite3 sqlite3 Error sqlite_errorname}@anchor{71a}
@deffn {Atributo} sqlite_errorname

El nombre simbólico del código de error numérico de SQLite API@footnote{https://sqlite.org/rescode.html}


Added in version 3.11.

@end deffn
@end deffn

@geindex InterfaceError
@anchor{library/sqlite3 sqlite3 InterfaceError}@anchor{71e}
@deffn {Excepción} sqlite3.InterfaceError

Excepción lanzada por el uso indebido de la API de SQLite C de bajo nivel. En otras palabras, si se lanza esta excepción, probablemente indica un error en el módulo @code{sqlite3}. @code{InterfaceError} es una subclase de @ref{1888,,Error}.
@end deffn

@geindex DatabaseError
@anchor{library/sqlite3 sqlite3 DatabaseError}@anchor{2910}
@deffn {Excepción} sqlite3.DatabaseError

Excepción lanzada por errores relacionados con la base de datos. Esto sirve como excepción base para varios tipos de errores de base de datos. Solo se genera implícitamente a través de las subclases especializadas. @code{DatabaseError} es una subclase de @ref{1888,,Error}.
@end deffn

@geindex DataError
@anchor{library/sqlite3 sqlite3 DataError}@anchor{18a5}
@deffn {Excepción} sqlite3.DataError

Excepción lanzada por errores causados por problemas con los datos procesados, como valores numéricos fuera de rango y cadenas de caracteres demasiado largas. @code{DataError} es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@geindex OperationalError
@anchor{library/sqlite3 sqlite3 OperationalError}@anchor{18a6}
@deffn {Excepción} sqlite3.OperationalError

Excepción lanzada por errores que están relacionados con el funcionamiento de la base de datos y no necesariamente bajo el control del programador. Por ejemplo, no se encuentra la ruta de la base de datos o no se pudo procesar una transacción. @code{OperationalError} es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@geindex IntegrityError
@anchor{library/sqlite3 sqlite3 IntegrityError}@anchor{292e}
@deffn {Excepción} sqlite3.IntegrityError

Excepción lanzada cuando la integridad de la base de datos es afectada, por ejemplo la comprobación de una llave foránea falla. Es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@geindex InternalError
@anchor{library/sqlite3 sqlite3 InternalError}@anchor{292f}
@deffn {Excepción} sqlite3.InternalError

Se genera una excepción cuando SQLite encuentra un error interno. Si se genera esto, puede indicar que hay un problema con la biblioteca SQLite en tiempo de ejecución. @code{InternalError} es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@geindex ProgrammingError
@anchor{library/sqlite3 sqlite3 ProgrammingError}@anchor{223}
@deffn {Excepción} sqlite3.ProgrammingError

Excepción lanzada por errores de programación de la API de @code{sqlite3}, por ejemplo, proporcionar el número incorrecto de enlaces a una consulta, o intentar operar en una @ref{39e,,Connection} cerrada. @code{ProgrammingError} es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@geindex NotSupportedError
@anchor{library/sqlite3 sqlite3 NotSupportedError}@anchor{290e}
@deffn {Excepción} sqlite3.NotSupportedError

Excepción lanzada en caso que la biblioteca SQLite subyacente no admita un método o una API de base de datos. Por ejemplo, establecer `determinista' como @code{Verdadero} en @ref{3f6,,create_function()}, si la biblioteca SQLite subyacente no admite funciones `deterministic'. @code{NotSupportedError} es una subclase de @ref{2910,,DatabaseError}.
@end deffn

@node SQLite y tipos de Python,Default adapters and converters deprecated,Excepciones<6>,Referencia
@anchor{library/sqlite3 sqlite-and-python-types}@anchor{2930}@anchor{library/sqlite3 sqlite3-types}@anchor{28df}
@subsubsection SQLite y tipos de Python


SQLite soporta de forma nativa los siguientes tipos: @code{NULL}, @code{INTEGER}, @code{REAL}, @code{TEXT}, @code{BLOB}.

Los siguientes tipos de Python se pueden enviar a SQLite sin problema alguno:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} 
@headitem

Tipo de Python

@tab

Tipo de SQLite

@item

@code{None}

@tab

@code{NULL}

@item

@ref{1f0,,int}

@tab

@code{INTEGER}

@item

@ref{153,,float}

@tab

@code{REAL}

@item

@ref{237,,str}

@tab

@code{TEXT}

@item

@ref{325,,bytes}

@tab

@code{BLOB}

@end multitable


De esta forma es como los tipos de SQLite son convertidos a tipos de Python por defecto:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo de SQLite

@tab

Tipo de Python

@item

@code{NULL}

@tab

@code{None}

@item

@code{INTEGER}

@tab

@ref{1f0,,int}

@item

@code{REAL}

@tab

@ref{153,,float}

@item

@code{TEXT}

@tab

depende de @ref{2914,,text_factory}, @ref{237,,str} por defecto

@item

@code{BLOB}

@tab

@ref{325,,bytes}

@end multitable


El sistema de tipos del módulo @code{sqlite3} es extensible en dos formas: se puede almacenar tipos de Python adicionales en una base de datos SQLite vía a @ref{28d8,,objetos adaptadores}, y se puede permitir que @code{sqlite3} convierta tipos SQLite a diferentes tipos de Python vía @ref{28d9,,converters}.

@node Default adapters and converters deprecated,Command-line interface,SQLite y tipos de Python,Referencia
@anchor{library/sqlite3 default-adapters-and-converters-deprecated}@anchor{2931}@anchor{library/sqlite3 sqlite3-default-converters}@anchor{595}
@subsubsection Default adapters and converters (deprecated)


@cartouche
@quotation Nota 
The default adapters and converters are deprecated as of Python 3.12.
Instead, use the @ref{596,,Ejemplos para adaptadores y convertidores}
and tailor them to your needs.
@end quotation
@end cartouche

The deprecated default adapters and converters consist of:


@itemize *

@item 
An adapter for @ref{330,,datetime.date} objects to @ref{237,,strings} in
ISO 8601@footnote{https://en.wikipedia.org/wiki/ISO_8601} format.

@item 
An adapter for @ref{32f,,datetime.datetime} objects to strings in
ISO 8601 format.

@item 
A converter for @ref{28d9,,declared} «date» types to
@ref{330,,datetime.date} objects.

@item 
A converter for declared «timestamp» types to
@ref{32f,,datetime.datetime} objects.
Fractional parts will be truncated to 6 digits (microsecond precision).
@end itemize

@cartouche
@quotation Nota 
El convertidor por defecto «timestamp» ignora las compensaciones UTC en la base de datos y siempre devuelve un objeto @ref{32f,,datetime.datetime} `naive'. Para conservar las compensaciones UTC en las marcas de tiempo, deje los convertidores deshabilitados o registre un convertidor que reconozca la compensación con @ref{28e0,,register_converter()}.
@end quotation
@end cartouche


Obsoleto desde la versión 3.12.


@node Command-line interface,,Default adapters and converters deprecated,Referencia
@anchor{library/sqlite3 command-line-interface}@anchor{2932}@anchor{library/sqlite3 sqlite3-cli}@anchor{4ee}
@subsubsection Command-line interface


The @code{sqlite3} module can be invoked as a script,
using the interpreter’s @ref{187,,-m} switch,
in order to provide a simple SQLite shell.
The argument signature is as follows:

@example
python -m sqlite3 [-h] [-v] [filename] [sql]
@end example

Type @code{.quit} or CTRL-D to exit the shell.

@geindex opción de línea de comando python--m-sqlite3-[-h]-[-v]-[filename]-[sql]; -h
@geindex opción de línea de comando python--m-sqlite3-[-h]-[-v]-[filename]-[sql]; --help
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-h}@anchor{2933}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-help}@anchor{2934}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Print CLI help.
@end deffn

@geindex opción de línea de comando python--m-sqlite3-[-h]-[-v]-[filename]-[sql]; -v
@geindex opción de línea de comando python--m-sqlite3-[-h]-[-v]-[filename]-[sql]; --version
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-v}@anchor{2935}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-version}@anchor{2936}
@deffn {Option} @w{-}v, @w{-}@w{-}version

Print underlying SQLite library version.
@end deffn


Added in version 3.12.


@node Guías prácticas,Explicación,Referencia,sqlite3 — DB-API 2 0 interface for SQLite databases
@anchor{library/sqlite3 how-to-guides}@anchor{2937}@anchor{library/sqlite3 sqlite3-howtos}@anchor{28cf}
@subsubsection Guías prácticas


@menu
* Cómo usar marcadores de posición para vincular valores en consultas SQL:: 
* Cómo adaptar tipos de Python personalizados a valores de SQLite:: 
* Como convertir valores SQLite a tipos de Python personalizados:: 
* Ejemplos para adaptadores y convertidores:: 
* Cómo utilizar los métodos de acceso directo de conexión:: 
* Como usar la conexión con un administrador de contexto:: 
* Como trabajar con URIs SQLite:: 
* How to create and use row factories:: 
* How to handle non-UTF-8 text encodings:: 

@end menu

@node Cómo usar marcadores de posición para vincular valores en consultas SQL,Cómo adaptar tipos de Python personalizados a valores de SQLite,,Guías prácticas
@anchor{library/sqlite3 how-to-use-placeholders-to-bind-values-in-sql-queries}@anchor{2938}@anchor{library/sqlite3 sqlite3-placeholders}@anchor{402}
@subsubsection Cómo usar marcadores de posición para vincular valores en consultas SQL


SQL operations usually need to use values from Python variables. However,
beware of using Python’s string operations to assemble queries, as they
are vulnerable to SQL injection attacks@footnote{https://en.wikipedia.org/wiki/SQL_injection}. For example, an attacker can simply
close the single quote and inject @code{OR TRUE} to select all rows:

@example
>>> # Never do this -- insecure!
>>> symbol = input()
' OR TRUE; --
>>> sql = "SELECT * FROM stocks WHERE symbol = '%s'" % symbol
>>> print(sql)
SELECT * FROM stocks WHERE symbol = '@w{'} OR TRUE; --'
>>> cur.execute(sql)
@end example

Instead, use the DB-API’s parameter substitution. To insert a variable into a
query string, use a placeholder in the string, and substitute the actual values
into the query by providing them as a @ref{464,,tuple} of values to the second
argument of the cursor’s @ref{400,,execute()} method.

An SQL statement may use one of two kinds of placeholders:
question marks (qmark style) or named placeholders (named style).
For the qmark style, `parameters' must be a
@ref{597,,sequence} whose length must match the number of placeholders,
or a @ref{223,,ProgrammingError} is raised.
For the named style, `parameters' must be
an instance of a @ref{190,,dict} (or a subclass),
which must contain keys for all named parameters;
any extra items are ignored.
Here’s an example of both styles:

@example
con = sqlite3.connect(":memory:")
cur = con.execute("CREATE TABLE lang(name, first_appeared)")

# This is the named style used with executemany():
data = (
    @{"name": "C", "year": 1972@},
    @{"name": "Fortran", "year": 1957@},
    @{"name": "Python", "year": 1991@},
    @{"name": "Go", "year": 2009@},
)
cur.executemany("INSERT INTO lang VALUES(:name, :year)", data)

# This is the qmark style used in a SELECT query:
params = (1972,)
cur.execute("SELECT * FROM lang WHERE first_appeared = ?", params)
print(cur.fetchall())
con.close()
@end example

@c [('C', 1972)]

@cartouche
@quotation Nota 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} numeric placeholders are `not' supported.
If used, they will be interpreted as named placeholders.
@end quotation
@end cartouche

@node Cómo adaptar tipos de Python personalizados a valores de SQLite,Como convertir valores SQLite a tipos de Python personalizados,Cómo usar marcadores de posición para vincular valores en consultas SQL,Guías prácticas
@anchor{library/sqlite3 how-to-adapt-custom-python-types-to-sqlite-values}@anchor{2939}@anchor{library/sqlite3 sqlite3-adapters}@anchor{28d8}
@subsubsection Cómo adaptar tipos de Python personalizados a valores de SQLite


SQLite solo admite un conjunto limitado de tipos de datos de forma nativa. Para almacenar tipos personalizados de Python en bases de datos SQLite, adáptelos a uno de los @ref{28df,,tipos Python que SQLite entiende de forma nativa}.

Hay dos formas de adaptar los objetos de Python a los tipos de SQLite: dejar que su objeto se adapte a sí mismo o usar un `adapter callable'. Este último prevalecerá sobre el primero. Para una biblioteca que exporta un tipo personalizado, puede tener sentido permitir que ese tipo se adapte. Como desarrollador de aplicaciones, puede tener más sentido tomar el control directo registrando funciones de adaptador personalizadas.

@menu
* Cómo escribir objetos adaptables:: 
* Como registrar un adaptador invocable:: 

@end menu

@node Cómo escribir objetos adaptables,Como registrar un adaptador invocable,,Cómo adaptar tipos de Python personalizados a valores de SQLite
@anchor{library/sqlite3 how-to-write-adaptable-objects}@anchor{293a}@anchor{library/sqlite3 sqlite3-conform}@anchor{292b}
@subsubsection Cómo escribir objetos adaptables


Supongamos que tenemos una clase @code{Point} que representa un par de coordenadas, @code{x} e @code{y}, en un sistema de coordenadas cartesianas. El par de coordenadas se almacenará como una cadena de texto en la base de datos, utilizando un punto y coma para separar las coordenadas. Esto se puede implementar agregando un método @code{__conform__(self, protocol)} que retorna el valor adaptado. El objeto pasado a `protocolo' será de tipo @ref{17e9,,PrepareProtocol}.

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __conform__(self, protocol):
        if protocol is sqlite3.PrepareProtocol:
            return f"@{self.x@};@{self.y@}"

con = sqlite3.connect(":memory:")
cur = con.cursor()

cur.execute("SELECT ?", (Point(4.0, -3.2),))
print(cur.fetchone()[0])
con.close()
@end example

@c 4.0;-3.2

@node Como registrar un adaptador invocable,,Cómo escribir objetos adaptables,Cómo adaptar tipos de Python personalizados a valores de SQLite
@anchor{library/sqlite3 how-to-register-adapter-callables}@anchor{293b}
@subsubsection Como registrar un adaptador invocable


La otra posibilidad es crear una función que convierta el objeto Python a un tipo compatible de SQLite. Esta función puede de esta forma ser registrada usando un @ref{28e9,,register_adapter()}.

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

def adapt_point(point):
    return f"@{point.x@};@{point.y@}"

sqlite3.register_adapter(Point, adapt_point)

con = sqlite3.connect(":memory:")
cur = con.cursor()

cur.execute("SELECT ?", (Point(1.0, 2.5),))
print(cur.fetchone()[0])
con.close()
@end example

@c 1.0;2.5

@node Como convertir valores SQLite a tipos de Python personalizados,Ejemplos para adaptadores y convertidores,Cómo adaptar tipos de Python personalizados a valores de SQLite,Guías prácticas
@anchor{library/sqlite3 how-to-convert-sqlite-values-to-custom-python-types}@anchor{293c}@anchor{library/sqlite3 sqlite3-converters}@anchor{28d9}
@subsubsection Como convertir valores SQLite a tipos de Python personalizados


Escribir un adaptador le permite convertir `de' tipos personalizados de Python `a' valores SQLite. Para poder convertir `de' valores SQLite `a' tipos personalizados de Python, usamos `convertidores'.

Regresemos a la clase @code{Point}. Almacenamos las coordenadas x y y separadas por punto y coma como una cadena de caracteres en SQLite.

Primero, se define una función de conversión que acepta la cadena de texto como un parámetro y construya un objeto @code{Point} de ahí.

@cartouche
@quotation Nota 
Las funciones de conversión `siempre' son llamadas con un objeto @ref{325,,bytes}, no importa bajo qué tipo de dato se envió el valor a SQLite.
@end quotation
@end cartouche

@example
def convert_point(s):
    x, y = map(float, s.split(b";"))
    return Point(x, y)
@end example

Ahora necesitamos decirle a @code{sqlite3} cuando debería convertir un valor dado SQLite. Esto se hace cuando se conecta a una base de datos, utilizando el parámetro `detect_types' de @ref{3f5,,connect()}. Hay tres opciones:


@itemize *

@item 
Implícito: establece `detect_types' para que @ref{28e1,,PARSE_DECLTYPES}

@item 
Explícito: establece `detect_types' para que @ref{28e2,,PARSE_COLNAMES}

@item 
Ambos: establece `detect_types' para @code{sqlite3.PARSE_DECLTYPES | sqlite3.PARSE_COLNAMES}. Los nombres de columna tienen prioridad sobre los tipos declarados.
@end itemize

El siguiente ejemplo ilustra ambos enfoques:

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __repr__(self):
        return f"Point(@{self.x@}, @{self.y@})"

def adapt_point(point):
    return f"@{point.x@};@{point.y@}"

def convert_point(s):
    x, y = list(map(float, s.split(b";")))
    return Point(x, y)

# Register the adapter and converter
sqlite3.register_adapter(Point, adapt_point)
sqlite3.register_converter("point", convert_point)

# 1) Parse using declared types
p = Point(4.0, -3.2)
con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES)
cur = con.execute("CREATE TABLE test(p point)")

cur.execute("INSERT INTO test(p) VALUES(?)", (p,))
cur.execute("SELECT p FROM test")
print("with declared types:", cur.fetchone()[0])
cur.close()
con.close()

# 2) Parse using column names
con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_COLNAMES)
cur = con.execute("CREATE TABLE test(p)")

cur.execute("INSERT INTO test(p) VALUES(?)", (p,))
cur.execute('SELECT p AS "p [point]" FROM test')
print("with column names:", cur.fetchone()[0])
cur.close()
con.close()
@end example

@c with declared types: Point(4.0, -3.2)
@c with column names: Point(4.0, -3.2)

@node Ejemplos para adaptadores y convertidores,Cómo utilizar los métodos de acceso directo de conexión,Como convertir valores SQLite a tipos de Python personalizados,Guías prácticas
@anchor{library/sqlite3 adapter-and-converter-recipes}@anchor{293d}@anchor{library/sqlite3 sqlite3-adapter-converter-recipes}@anchor{596}
@subsubsection Ejemplos para adaptadores y convertidores


En esta sección se muestran ejemplos para adaptadores y convertidores comunes.

@example
import datetime
import sqlite3

def adapt_date_iso(val):
    """Adapt datetime.date to ISO 8601 date."""
    return val.isoformat()

def adapt_datetime_iso(val):
    """Adapt datetime.datetime to timezone-naive ISO 8601 date."""
    return val.isoformat()

def adapt_datetime_epoch(val):
    """Adapt datetime.datetime to Unix timestamp."""
    return int(val.timestamp())

sqlite3.register_adapter(datetime.date, adapt_date_iso)
sqlite3.register_adapter(datetime.datetime, adapt_datetime_iso)
sqlite3.register_adapter(datetime.datetime, adapt_datetime_epoch)

def convert_date(val):
    """Convert ISO 8601 date to datetime.date object."""
    return datetime.date.fromisoformat(val.decode())

def convert_datetime(val):
    """Convert ISO 8601 datetime to datetime.datetime object."""
    return datetime.datetime.fromisoformat(val.decode())

def convert_timestamp(val):
    """Convert Unix epoch timestamp to datetime.datetime object."""
    return datetime.datetime.fromtimestamp(int(val))

sqlite3.register_converter("date", convert_date)
sqlite3.register_converter("datetime", convert_datetime)
sqlite3.register_converter("timestamp", convert_timestamp)
@end example

@c dt = datetime.datetime(2019, 5, 18, 15, 17, 8, 123456)
@c 
@c assert adapt_date_iso(dt.date()) == "2019-05-18"
@c assert convert_date(b"2019-05-18") == dt.date()
@c 
@c assert adapt_datetime_iso(dt) == "2019-05-18T15:17:08.123456"
@c assert convert_datetime(b"2019-05-18T15:17:08.123456") == dt
@c 
@c # Using current time as fromtimestamp() returns local date/time.
@c # Dropping microseconds as adapt_datetime_epoch truncates fractional second part.
@c now = datetime.datetime.now().replace(microsecond=0)
@c current_timestamp = int(now.timestamp())
@c 
@c assert adapt_datetime_epoch(now) == current_timestamp
@c assert convert_timestamp(str(current_timestamp).encode()) == now

@node Cómo utilizar los métodos de acceso directo de conexión,Como usar la conexión con un administrador de contexto,Ejemplos para adaptadores y convertidores,Guías prácticas
@anchor{library/sqlite3 how-to-use-connection-shortcut-methods}@anchor{293e}@anchor{library/sqlite3 sqlite3-connection-shortcuts}@anchor{2907}
@subsubsection Cómo utilizar los métodos de acceso directo de conexión


Usando los métodos @ref{2909,,execute()}, @ref{290a,,executemany()}, y @ref{290b,,executescript()} de la clase @ref{39e,,Connection}, su código se puede escribir de manera más concisa porque no tiene que crear los (a menudo superfluo) objetos @ref{28d3,,Cursor} explícitamente. Por el contrario, los objetos @ref{28d3,,Cursor} son creados implícitamente y esos métodos de acceso directo retornarán objetos cursores. De esta forma, se puede ejecutar una sentencia @code{SELECT} e iterar sobre ella directamente usando un simple llamado sobre el objeto de clase @ref{39e,,Connection}.

@example
# Create and fill the table.
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE lang(name, first_appeared)")
data = [
    ("C++", 1985),
    ("Objective-C", 1984),
]
con.executemany("INSERT INTO lang(name, first_appeared) VALUES(?, ?)", data)

# Print the table contents
for row in con.execute("SELECT name, first_appeared FROM lang"):
    print(row)

print("I just deleted", con.execute("DELETE FROM lang").rowcount, "rows")

# close() is not a shortcut method and it's not called automatically;
# the connection object should be closed manually
con.close()
@end example

@c ('C++', 1985)
@c ('Objective-C', 1984)
@c I just deleted 2 rows

@node Como usar la conexión con un administrador de contexto,Como trabajar con URIs SQLite,Cómo utilizar los métodos de acceso directo de conexión,Guías prácticas
@anchor{library/sqlite3 how-to-use-the-connection-context-manager}@anchor{293f}@anchor{library/sqlite3 sqlite3-connection-context-manager}@anchor{17ea}
@subsubsection Como usar la conexión con un administrador de contexto


A @ref{39e,,Connection} object can be used as a context manager that
automatically commits or rolls back open transactions when leaving the body of
the context manager.
If the body of the @ref{673,,with} statement finishes without exceptions,
the transaction is committed.
If this commit fails,
or if the body of the @code{with} statement raises an uncaught exception,
the transaction is rolled back.
If @ref{55d,,autocommit} is @code{False},
a new transaction is implicitly opened after committing or rolling back.

If there is no open transaction upon leaving the body of the @code{with} statement,
or if @ref{55d,,autocommit} is @code{True},
the context manager does nothing.

@cartouche
@quotation Nota 
The context manager neither implicitly opens a new transaction
nor closes the connection. If you need a closing context manager, consider
using @ref{2940,,contextlib.closing()}.
@end quotation
@end cartouche

@example
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE lang(id INTEGER PRIMARY KEY, name VARCHAR UNIQUE)")

# Successful, con.commit() is called automatically afterwards
with con:
    con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))

# con.rollback() is called after the with block finishes with an exception,
# the exception is still raised and must be caught
try:
    with con:
        con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))
except sqlite3.IntegrityError:
    print("couldn't add Python twice")

# Connection object used as context manager only commits or rollbacks transactions,
# so the connection object should be closed manually
con.close()
@end example

@c couldn't add Python twice

@node Como trabajar con URIs SQLite,How to create and use row factories,Como usar la conexión con un administrador de contexto,Guías prácticas
@anchor{library/sqlite3 how-to-work-with-sqlite-uris}@anchor{2941}@anchor{library/sqlite3 sqlite3-uri-tricks}@anchor{28e6}
@subsubsection Como trabajar con URIs SQLite


Algunos trucos útiles de URI incluyen:


@itemize *

@item 
Abra una base de datos en modo de solo lectura:
@end itemize

@example
>>> con = sqlite3.connect("file:tutorial.db?mode=ro", uri=True)
>>> con.execute("CREATE TABLE readonly(data)")
Traceback (most recent call last):
OperationalError: attempt to write a readonly database
>>> con.close()
@end example


@itemize *

@item 
No cree implícitamente un nuevo archivo de base de datos si aún no existe; esto lanzará un @ref{18a6,,OperationalError} si no puede crear un nuevo archivo:
@end itemize

@example
>>> con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)
Traceback (most recent call last):
OperationalError: unable to open database file
@end example


@itemize *

@item 
Crea un nombre compartido sobre una base de datos en memoria:
@end itemize

@example
db = "file:mem1?mode=memory&cache=shared"
con1 = sqlite3.connect(db, uri=True)
con2 = sqlite3.connect(db, uri=True)
with con1:
    con1.execute("CREATE TABLE shared(data)")
    con1.execute("INSERT INTO shared VALUES(28)")
res = con2.execute("SELECT data FROM shared")
assert res.fetchone() == (28,)

con1.close()
con2.close()
@end example

Más información sobre esta característica, incluyendo una lista de opciones reconocidas, pueden encontrarse en SQLite URI documentation@footnote{https://www.sqlite.org/uri.html}.

@node How to create and use row factories,How to handle non-UTF-8 text encodings,Como trabajar con URIs SQLite,Guías prácticas
@anchor{library/sqlite3 how-to-create-and-use-row-factories}@anchor{2942}@anchor{library/sqlite3 sqlite3-howto-row-factory}@anchor{28da}
@subsubsection How to create and use row factories


By default, @code{sqlite3} represents each row as a @ref{464,,tuple}.
If a @code{tuple} does not suit your needs,
you can use the @ref{ef1,,sqlite3.Row} class
or a custom @ref{2913,,row_factory}.

While @code{row_factory} exists as an attribute both on the
@ref{28d3,,Cursor} and the @ref{39e,,Connection},
it is recommended to set @ref{163a,,Connection.row_factory},
so all cursors created from the connection will use the same row factory.

@code{Row} provides indexed and case-insensitive named access to columns,
with minimal memory overhead and performance impact over a @code{tuple}.
To use @code{Row} as a row factory,
assign it to the @code{row_factory} attribute:

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = sqlite3.Row
@end example

Queries now return @code{Row} objects:

@example
>>> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius")
>>> row = res.fetchone()
>>> row.keys()
['name', 'radius']
>>> row[0]         # Access by index.
'Earth'
>>> row["name"]    # Access by name.
'Earth'
>>> row["RADIUS"]  # Column names are case-insensitive.
6378
>>> con.close()
@end example

@cartouche
@quotation Nota 
The @code{FROM} clause can be omitted in the @code{SELECT} statement, as in the
above example. In such cases, SQLite returns a single row with columns
defined by expressions, e.g. literals, with the given aliases
@code{expr AS alias}.
@end quotation
@end cartouche

You can create a custom @ref{2913,,row_factory}
that returns each row as a @ref{190,,dict}, with column names mapped to values:

@example
def dict_factory(cursor, row):
    fields = [column[0] for column in cursor.description]
    return @{key: value for key, value in zip(fields, row)@}
@end example

Using it, queries now return a @code{dict} instead of a @code{tuple}:

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = dict_factory
>>> for row in con.execute("SELECT 1 AS a, 2 AS b"):
...     print(row)
@{'a': 1, 'b': 2@}
>>> con.close()
@end example

The following row factory returns a @ref{6ef,,named tuple}:

@example
from collections import namedtuple

def namedtuple_factory(cursor, row):
    fields = [column[0] for column in cursor.description]
    cls = namedtuple("Row", fields)
    return cls._make(row)
@end example

@code{namedtuple_factory()} can be used as follows:

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = namedtuple_factory
>>> cur = con.execute("SELECT 1 AS a, 2 AS b")
>>> row = cur.fetchone()
>>> row
Row(a=1, b=2)
>>> row[0]  # Indexed access.
1
>>> row.b   # Attribute access.
2
>>> con.close()
@end example

With some adjustments, the above recipe can be adapted to use a
@ref{32e,,dataclass}, or any other custom class,
instead of a @ref{32d,,namedtuple}.

@node How to handle non-UTF-8 text encodings,,How to create and use row factories,Guías prácticas
@anchor{library/sqlite3 how-to-handle-non-utf-8-text-encodings}@anchor{2943}@anchor{library/sqlite3 sqlite3-howto-encoding}@anchor{2911}
@subsubsection How to handle non-UTF-8 text encodings


By default, @code{sqlite3} uses @ref{237,,str} to adapt SQLite values
with the @code{TEXT} data type.
This works well for UTF-8 encoded text, but it might fail for other encodings
and invalid UTF-8.
You can use a custom @ref{2914,,text_factory} to handle such cases.

Because of SQLite’s flexible typing@footnote{https://www.sqlite.org/flextypegood.html}, it is not uncommon to encounter table
columns with the @code{TEXT} data type containing non-UTF-8 encodings,
or even arbitrary data.
To demonstrate, let’s assume we have a database with ISO-8859-2 (Latin-2)
encoded text, for example a table of Czech-English dictionary entries.
Assuming we now have a @ref{39e,,Connection} instance @code{con}
connected to this database,
we can decode the Latin-2 encoded text using this @ref{2914,,text_factory}:

@example
con.text_factory = lambda data: str(data, encoding="latin2")
@end example

For invalid UTF-8 or arbitrary data in stored in @code{TEXT} table columns,
you can use the following technique, borrowed from the @ref{1310,,CÓMO (HOWTO) Unicode}:

@example
con.text_factory = lambda data: str(data, errors="surrogateescape")
@end example

@cartouche
@quotation Nota 
The @code{sqlite3} module API does not support strings
containing surrogates.
@end quotation
@end cartouche


@subsubheading Ver también


@ref{1310,,CÓMO (HOWTO) Unicode}


@node Explicación,,Guías prácticas,sqlite3 — DB-API 2 0 interface for SQLite databases
@anchor{library/sqlite3 explanation}@anchor{2944}@anchor{library/sqlite3 sqlite3-explanation}@anchor{28d0}
@subsubsection Explicación

@anchor{library/sqlite3 sqlite3-transaction-control}@anchor{2945}
@menu
* Control transaccional:: 

@end menu

@node Control transaccional,,,Explicación
@anchor{library/sqlite3 sqlite3-controlling-transactions}@anchor{28d5}@anchor{library/sqlite3 transaction-control}@anchor{2946}
@subsubsection Control transaccional


@code{sqlite3} offers multiple methods of controlling whether,
when and how database transactions are opened and closed.
@ref{55e,,Transaction control via the autocommit attribute} is recommended,
while @ref{28e4,,Transaction control via the isolation_level attribute}
retains the pre-Python 3.12 behaviour.

@menu
* Transaction control via the autocommit attribute:: 
* Transaction control via the isolation_level attribute:: 

@end menu

@node Transaction control via the autocommit attribute,Transaction control via the isolation_level attribute,,Control transaccional
@anchor{library/sqlite3 sqlite3-transaction-control-autocommit}@anchor{55e}@anchor{library/sqlite3 transaction-control-via-the-autocommit-attribute}@anchor{2947}
@subsubsection Transaction control via the @code{autocommit} attribute


The recommended way of controlling transaction behaviour is through
the @ref{55d,,Connection.autocommit} attribute,
which should preferably be set using the `autocommit' parameter
of @ref{3f5,,connect()}.

It is suggested to set `autocommit' to @code{False},
which implies 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant transaction control.
This means:


@itemize *

@item 
@code{sqlite3} ensures that a transaction is always open,
so @ref{3f5,,connect()}, @ref{28d6,,Connection.commit()}, and @ref{2908,,Connection.rollback()}
will implicitly open a new transaction
(immediately after closing the pending one, for the latter two).
@code{sqlite3} uses @code{BEGIN DEFERRED} statements when opening transactions.

@item 
Transactions should be committed explicitly using @code{commit()}.

@item 
Transactions should be rolled back explicitly using @code{rollback()}.

@item 
An implicit rollback is performed if the database is
@ref{39f,,close()}-ed with pending changes.
@end itemize

Set `autocommit' to @code{True} to enable SQLite’s autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}.
In this mode, @ref{28d6,,Connection.commit()} and @ref{2908,,Connection.rollback()}
have no effect.
Note that SQLite’s autocommit mode is distinct from
the 
@geindex Python Enhancement Proposals; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant @ref{55d,,Connection.autocommit} attribute;
use @ref{2912,,Connection.in_transaction} to query
the low-level SQLite autocommit mode.

Set `autocommit' to @ref{28e5,,LEGACY_TRANSACTION_CONTROL}
to leave transaction control behaviour to the
@ref{28e3,,Connection.isolation_level} attribute.
See @ref{28e4,,Transaction control via the isolation_level attribute} for more information.

@node Transaction control via the isolation_level attribute,,Transaction control via the autocommit attribute,Control transaccional
@anchor{library/sqlite3 sqlite3-transaction-control-isolation-level}@anchor{28e4}@anchor{library/sqlite3 transaction-control-via-the-isolation-level-attribute}@anchor{2948}
@subsubsection Transaction control via the @code{isolation_level} attribute


@cartouche
@quotation Nota 
The recommended way of controlling transactions is via the
@ref{55d,,autocommit} attribute.
See @ref{55e,,Transaction control via the autocommit attribute}.
@end quotation
@end cartouche

If @ref{55d,,Connection.autocommit} is set to
@ref{28e5,,LEGACY_TRANSACTION_CONTROL} (the default),
transaction behaviour is controlled using
the @ref{28e3,,Connection.isolation_level} attribute.
Otherwise, @code{isolation_level} has no effect.

Si el atributo de conexión @ref{28e3,,isolation_level} no es @code{None}, las nuevas transacciones se abrirán implícitamente antes de @ref{400,,execute()} y @ref{401,,executemany()} ejecutará sentencias @code{INSERT}, @code{UPDATE}, @code{DELETE} o @code{REPLACE}; para otras sentencias, no se realiza ningún manejo de transacción implícito. Utilice los métodos @ref{28d6,,commit()} y @ref{2908,,rollback()} para confirmar y deshacer respectivamente las transacciones pendientes. Puede elegir el SQLite transaction behaviour@footnote{https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions}  subyacente, es decir, si y qué tipo de declaraciones @code{BEGIN} @code{sqlite3} se ejecutarán implícitamente, a través del atributo @ref{28e3,,isolation_level}.

Si @ref{28e3,,isolation_level} se establece como @code{None}, no se abre ninguna transacción implícitamente. Esto deja la biblioteca SQLite subyacente en autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}, pero también permite que el usuario realice su propio manejo de transacciones usando declaraciones SQL explícitas. El modo de confirmación automática de la biblioteca SQLite subyacente se puede consultar mediante el atributo @ref{2912,,in_transaction}.

El método @ref{290c,,executescript()} guarda implícitamente cualquier transacción pendiente antes de la ejecución del script SQL dado, independientemente del valor de @ref{28e3,,isolation_level}.


Distinto en la versión 3.6: @code{sqlite3} solía realizar commit en transacciones implícitamente antes de sentencias DDL. Este ya no es el caso.



Distinto en la versión 3.12: The recommended way of controlling transactions is now via the
@ref{55d,,autocommit} attribute.


@c import os
@c os.remove("backup.db")
@c os.remove("dump.sql")
@c os.remove("example.db")
@c os.remove("tutorial.db")

@node Compresión de datos y archivado,Formatos de archivo,Persistencia de datos,La biblioteca estándar de Python
@anchor{library/archiving doc}@anchor{2883}@anchor{library/archiving archiving}@anchor{2949}@anchor{library/archiving data-compression-and-archiving}@anchor{294a}
@section Compresión de datos y archivado


Los módulos descritos en este capítulo soportan compresión de datos con los algoritmos zlib, gzip, bzip2 e lzma, y la creación de archivos con formato ZIP y tar. Véase también @ref{1285,,Operaciones de archivado} provistos por el módulo @ref{c5,,shutil}.

@menu
* zlib — Compression compatible with gzip:: 
* gzip — Support for gzip files:: 
* bz2 — Support for bzip2 compression:: 
* lzma — Compression using the LZMA algorithm:: 
* zipfile — Work with ZIP archives:: 
* tarfile — Read and write tar archive files:: 

@end menu

@node zlib — Compression compatible with gzip,gzip — Support for gzip files,,Compresión de datos y archivado
@anchor{library/zlib doc}@anchor{294b}@anchor{library/zlib module-zlib}@anchor{132}@anchor{library/zlib zlib-compression-compatible-with-gzip}@anchor{294c}
@subsection @code{zlib} — Compression compatible with @code{gzip}


@geindex module; zlib


__________________________________________________________________


Para aplicaciones que requieren compresión de datos, las funciones en este módulo permiten la compresión y descompresión mediante la biblioteca zlib. La biblioteca zlib tiene su propia página de inicio en @indicateurl{https://www.zlib.net}. Existen incompatibilidades conocidas entre el módulo de Python y las versiones de la biblioteca zlib anteriores a la 1.1.3; 1.1.3 tiene una vulnerabilidad de seguridad@footnote{https://zlib.net/zlib_faq.html#faq33}, por lo que recomendamos usar 1.1.4 o posterior.

Las funciones de zlib tienen muchas opciones y, a menudo, deben usarse en un orden particular. Esta documentación no intenta cubrir todas las permutaciones; consulte el manual de zlib en @indicateurl{http://www.zlib.net/manual.html} para obtener información autorizada.

Para leer y escribir archivos @code{.gz} consultar el módulo @ref{67,,gzip}.

La excepción y las funciones disponibles en este módulo son:

@geindex error
@anchor{library/zlib zlib error}@anchor{294d}
@deffn {Excepción} zlib.error

Excepción provocada en errores de compresión y descompresión.
@end deffn

@geindex adler32() (en el módulo zlib)
@anchor{library/zlib zlib adler32}@anchor{1830}
@deffn {Función} zlib.adler32 (data[, value])

Calcula una suma de comprobación Adler-32 de `data'. (Una suma de comprobación Adler-32 es casi tan confiable como un CRC32, pero se puede calcular mucho más rápidamente). El resultado es un entero de 32 bits sin signo. Si `value' está presente, se utiliza como el valor inicial de la suma de comprobación; de lo contrario, se utiliza un valor predeterminado de 1. Pasar `value' permite calcular una suma de comprobación en ejecución durante la concatenación de varias entradas. El algoritmo no es criptográficamente fuerte y no se debe utilizar para la autenticación o las firmas digitales. Puesto que está diseñado como un algoritmo de suma de comprobación, no es adecuado su uso como un algoritmo `hash' general.


Distinto en la versión 3.0: El resultado es siempre sin signo.

@end deffn

@geindex compress() (en el módulo zlib)
@anchor{library/zlib zlib compress}@anchor{6e0}
@deffn {Función} zlib.compress (data, /, level=-1, wbits=MAX_WBITS)

Comprime los bytes de `data', retornando un objeto bytes que contiene datos comprimidos. `level' es un entero de @code{0} a @code{9} o @code{-1} que controla el nivel de compresión; @code{1} (Z_BEST_SPEED) es más rápido y produce la menor compresión, @code{9} (Z_BEST_COMPRESSION) es más lento y produce mayor compresión. @code{0} (Z_NO_COMPRESSION) no comprimir. El valor predeterminado es @code{-1} (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION representa un compromiso predeterminado entre velocidad y compresión (actualmente equivalente al nivel 6)
@anchor{library/zlib compress-wbits}@anchor{294e}
El argumento `wbits' controla el tamaño del búfer histórico (o el «tamaño de ventana») utilizado al comprimir datos, y si se incluye un encabezado y un avance en la salida. Puede tomar varios rangos de valores, por defecto es @code{15} (MAX_WBITS):


@itemize *

@item 
+9 a +15: el logaritmo en base dos del tamaño de la ventana, que por lo tanto oscila entre 512 y 32768. Los valores más grandes producen una mejor compresión a expensas de un mayor uso de memoria. Como resultado se incluirá un encabezado y un avance específicos de zlib.

@item 
−9 a −15: utiliza el valor absoluto de `wbits' como el logaritmo del tamaño de la ventana, al tiempo que produce una secuencia de salida sin encabezado ni suma de verificación.

@item 
+25 a +31 = 16 + (9 a 15): utiliza los 4 bits bajos del valor como el logaritmo del tamaño de la ventana, mientras que incluye un encabezado básico @code{gzip} y suma de verificación en la salida.
@end itemize

Lanza la excepción @ref{294d,,error} si ocurre cualquier error.


Distinto en la versión 3.6: `level' ahora se puede utilizar como parámetro de palabra clave.



Distinto en la versión 3.11: El parámetro `wbits' está ahora disponible para establecer bits de la ventana y tipo de compresión.

@end deffn

@geindex compressobj() (en el módulo zlib)
@anchor{library/zlib zlib compressobj}@anchor{294f}
@deffn {Función} zlib.compressobj (level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])

Retorna un objeto de compresión, para ser usado para comprimir flujos de datos que no caben en la memoria de una vez.

`level' es el nivel de compresión – es un entero de @code{0} a @code{9} o @code{-1}. Un valor de @code{1} (Z_BEST_SPEED) es el más rápido y produce la menor compresión, mientras que un valor de @code{9} (Z_BEST_COMPRESSION) es el más lento y produce la mayor cantidad. @code{0} (Z_NO_COMPRESSION) no es compresión. El valor predeterminado es @code{-1} (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION representa un compromiso predeterminado entre velocidad y compresión (actualmente equivalente al nivel 6).

`method' es el algoritmo de compresión. Actualmente, el único valor admitido es @code{DEFLATED}.

El parámetro `wbits' controla el tamaño del búfer histórico (o el «tamaño de ventana») y qué formato de encabezado y cola será usado. Tiene el mismo significado que @ref{2950,,el descrito para decompress()}.

El argumento `memLevel' controla la cantidad de memoria utilizada para el estado de compresión interna. Los valores posibles varían de @code{1} a @code{9}. Los valores más altos usan más memoria, pero son más rápidos y producen una salida más pequeña.

`strategy' se usa para ajustar el algoritmo de compresión. Los valores posibles son @code{Z_DEFAULT_STRATEGY}, @code{Z_FILtered}, @code{Z_HUFFMAN_ONLY}, @code{Z_RLE} (zlib 1.2.0.1) y @code{Z_FIXED} (zlib 1.2.2.2).

`zdict' es un diccionario de compresión predefinido. Este es una secuencia de bytes (como un objeto @ref{325,,bytes}) que contiene subsecuencias que se espera que ocurran con frecuencia en los datos que se van a comprimir. Las subsecuencias que se espera que sean más comunes deben aparecer al final del diccionario.


Distinto en la versión 3.3: Se agregó el parámetro `zdict' y el soporte de argumentos de palabras clave.

@end deffn

@geindex crc32() (en el módulo zlib)
@anchor{library/zlib zlib crc32}@anchor{169f}
@deffn {Función} zlib.crc32 (data[, value])

@geindex Cyclic Redundancy Check
@geindex checksum;Cyclic Redundancy Check

Calcula un suma de comprobación CRC (comprobación de redundancia cíclica, por sus siglas en inglés `Cyclic Redundancy Check') de `datos'. El resultado es un entero de 32 bits sin signo. Si `value' está presente, se usa como el valor inicial de la suma de verificación; de lo contrario, se usa el valor predeterminado 0. Pasar `value' permite calcular una suma de verificación en ejecución sobre la concatenación de varias entradas. El algoritmo no es criptográficamente fuerte y no debe usarse para autenticación o firmas digitales. Dado que está diseñado para usarse como un algoritmo de suma de verificación, no es adecuado su uso como algoritmo `hash' general.


Distinto en la versión 3.0: El resultado es siempre sin signo.

@end deffn

@geindex decompress() (en el módulo zlib)
@anchor{library/zlib zlib decompress}@anchor{d94}
@deffn {Función} zlib.decompress (data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)

Descomprime los bytes en `data', retornando un objeto de bytes que contiene los datos sin comprimir. El parámetro `wbits' depende del formato de `data', y se trata más adelante. Si se da `bufsize', se usa como el tamaño inicial del búfer de salida. Provoca la excepción @ref{294d,,error} si se produce algún error.
@anchor{library/zlib decompress-wbits}@anchor{2950}
El parámetro `wbits' controla el tamaño del búfer histórico (o el «tamaño de ventana») y qué formato de encabezado y cola se espera. Es similar al parámetro para @ref{294f,,compressobj()}, pero acepta más rangos de valores:


@itemize *

@item 
+8 a +15: el logaritmo en base dos del tamaño del búfer. La entrada debe incluir encabezado y cola zlib.

@item 
0: determina automáticamente el tamaño del búfer desde el encabezado zlib. Solo se admite desde zlib 1.2.3.5.

@item 
-8 to -15: utiliza el valor absoluto de `wbits' como el logaritmo del tamaño del búfer. La entrada debe ser una transmisión sin formato, sin encabezado ni cola.

@item 
+24 a +31 = 16 + (8 a 15): utiliza los 4 bits de bajo orden del valor como el logaritmo del tamaño del búfer. La entrada debe incluir encabezado y cola gzip.

@item 
+40 a +47 = 32 + (8 a 15): utiliza los 4 bits de bajo orden del valor como el logaritmo del tamaño del búfer y acepta automáticamente el formato zlib o gzip.
@end itemize

Al descomprimir una secuencia, el tamaño del búfer no debe ser menor al tamaño utilizado originalmente para comprimir la secuencia; el uso de un valor demasiado pequeño puede generar una excepción @ref{294d,,error}. El valor predeterminado `wbits' corresponde al tamaño más grande de búfer y requiere que se incluya encabezado y cola zlib.

`bufsize' es el tamaño inicial del búfer utilizado para contener datos descomprimidos. Si se requiere más espacio, el tamaño del búfer aumentará según sea necesario, por lo que no hay que tomar este valor como exactamente correcto; al ajustarlo solo se guardarán algunas llamadas en @code{malloc()}.


Distinto en la versión 3.6: `wbits' y `bufsize' se pueden usar como argumentos de palabra clave.

@end deffn

@geindex decompressobj() (en el módulo zlib)
@anchor{library/zlib zlib decompressobj}@anchor{2951}
@deffn {Función} zlib.decompressobj (wbits=MAX_WBITS[, zdict])

Retorna un objeto de descompresión, que se utilizará para descomprimir flujos de datos que no caben en la memoria de una vez.

El parámetro `wbits' controla el tamaño del búfer histórico (o el «tamaño de ventana») y qué formato de encabezado y cola se espera. Tiene el mismo significado que @ref{2950,,described for decompress()}.

El parámetro `zdict' especifica un diccionario de compresión predefinido. Si se proporciona, este debe ser el mismo diccionario utilizado por el compresor que produjo los datos que se van a descomprimir.

@cartouche
@quotation Nota 
Si `zdict' es un objeto mutable (como @ref{5e0,,bytearray}), no se debe modificar su contenido entre la llamada @ref{2951,,decompressobj()} y la primera llamada al método descompresor @code{decompress()}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se agregó el parámetro `zdict'.

@end deffn

Los objetos de compresión admiten los siguientes métodos:

@geindex compress() (método de zlib.Compress)
@anchor{library/zlib zlib Compress compress}@anchor{2952}
@deffn {Método} Compress.compress (data)

Comprime `data', y retorna al menos algunos de los datos comprimidos como un objeto de bytes. Estos datos deben concatenarse a la salida producida por cualquier llamada anterior al método @ref{6e0,,compress()}. Algunas entradas pueden mantenerse en un búfer interno para su posterior procesamiento.
@end deffn

@geindex flush() (método de zlib.Compress)
@anchor{library/zlib zlib Compress flush}@anchor{2953}
@deffn {Método} Compress.flush ([mode])

Se procesan todas las entradas pendientes y se retorna un objeto de bytes que contiene la salida comprimida restante. El argumento `mode' acepta una de las siguientes constantes @code{Z_NO_FLUSH}, @code{Z_PARTIAL_FLUSH}, @code{Z_SYNC_FLUSH}, @code{Z_FULL_FLUSH}, @code{Z_BLOCK} (zlib 1.2.3.4), o @code{Z_FINISH}, por defecto @code{Z_FINISH}. Excepto @code{Z_FINISH}, todas las constantes permiten comprimir más cadenas de bytes, mientras que @code{Z_FINISH} finaliza el flujo comprimido y evita la compresión de más datos. Después de llamar a @ref{2953,,flush()} con `mode' establecido en @code{Z_FINISH}, el método @ref{6e0,,compress()} no se puede volver a llamar. La única acción posible es eliminar el objeto.
@end deffn

@geindex copy() (método de zlib.Compress)
@anchor{library/zlib zlib Compress copy}@anchor{2954}
@deffn {Método} Compress.copy ()

Retorna una copia del objeto compresor. Esto se puede utilizar para comprimir eficientemente un conjunto de datos que comparten un prefijo inicial común.
@end deffn


Distinto en la versión 3.8: Añadido @ref{5d7,,copy.copy()} y @ref{bf6,,copy.deepcopy()} para el soporte de objetos de compresión.


Los objetos de descompresión admiten los siguientes métodos y atributos:

@geindex unused_data (atributo de zlib.Decompress)
@anchor{library/zlib zlib Decompress unused_data}@anchor{2955}
@deffn {Atributo} Decompress.unused_data

Un objeto de bytes que contiene todos los bytes restantes después de los datos comprimidos. Es decir, esto permanece @code{b ""} hasta que esté disponible el último byte que contiene datos de compresión. Si la cadena de bytes completa resultó contener datos comprimidos, es @code{b""}, un objeto de bytes vacío.
@end deffn

@geindex unconsumed_tail (atributo de zlib.Decompress)
@anchor{library/zlib zlib Decompress unconsumed_tail}@anchor{2956}
@deffn {Atributo} Decompress.unconsumed_tail

Un objeto de bytes que contiene datos no procesados por la última llamada al método @code{descompress()} , debido a un desbordamiento del límite del búfer de datos descomprimidos. Estos datos aún no han sido procesados por la biblioteca zlib, por lo que debe enviarlos (potencialmente concatenando los datos nuevamente) mediante una llamada al método @code{descompress()} para obtener la salida correcta.
@end deffn

@geindex eof (atributo de zlib.Decompress)
@anchor{library/zlib zlib Decompress eof}@anchor{11de}
@deffn {Atributo} Decompress.eof

Un valor booleano que indica si se ha alcanzado el final del flujo de datos comprimido.

Esto hace posible distinguir entre un flujo comprimido correctamente y uno incompleto o truncado.


Added in version 3.3.

@end deffn

@geindex decompress() (método de zlib.Decompress)
@anchor{library/zlib zlib Decompress decompress}@anchor{2957}
@deffn {Método} Decompress.decompress (data, max_length=0)

Descomprime `data', retornando un objeto de bytes que contiene al menos parte de los datos descomprimidos en `string'. Estos datos deben concatenarse con la salida producida por cualquier llamada anterior al método @ref{d94,,decompress()}. Algunos de los datos de entrada pueden conservarse en búfer internos para su posterior procesamiento.

Si el parámetro opcional `max_length' no es cero, el valor de retorno no será más largo que `max_length'. Esto puede significar que no toda la entrada comprimida puede procesarse; y los datos no consumidos se almacenarán en el atributo @ref{2956,,unconsumed_tail}. Esta cadena de bytes debe pasarse a una llamada posterior a @ref{d94,,decompress()} si la descompresión ha de continuar. Si `max_length' es cero, toda la entrada se descomprime y @ref{2956,,unconsumed_tail} queda vacío.


Distinto en la versión 3.6: `max_length' puede ser utilizado como argumento de palabras clave.

@end deffn

@geindex flush() (método de zlib.Decompress)
@anchor{library/zlib zlib Decompress flush}@anchor{2958}
@deffn {Método} Decompress.flush ([length])

Se procesan todas las entradas pendientes y se retorna un objeto de bytes que contiene el resto de los datos que se descomprimirán. Después de llamar a @ref{2958,,flush()}, no se puede volver a llamar al método @ref{d94,,decompress()}. La única acción posible es eliminar el objeto.

El parámetro opcional `length' establece el tamaño inicial del búfer de salida.
@end deffn

@geindex copy() (método de zlib.Decompress)
@anchor{library/zlib zlib Decompress copy}@anchor{2959}
@deffn {Método} Decompress.copy ()

Retorna una copia del objeto de descompresión. Puede usarlo para guardar el estado de la descompresión actual, de modo que pueda regresar rápidamente a esta ubicación más tarde.
@end deffn


Distinto en la versión 3.8: Añadido @ref{5d7,,copy.copy()} y @ref{bf6,,copy.deepcopy()} para el soporte de objetos de compresión.


La información sobre la versión de la biblioteca zlib en uso está disponible a través de las siguientes constantes:

@geindex ZLIB_VERSION (en el módulo zlib)
@anchor{library/zlib zlib ZLIB_VERSION}@anchor{295a}
@deffn {Dato} zlib.ZLIB_VERSION

Versión de la biblioteca zlib utilizada al compilar el módulo. Puede ser diferente de la biblioteca zlib utilizada actualmente por el sistema, que puede ver en @ref{11df,,ZLIB_RUNTIME_VERSION}.
@end deffn

@geindex ZLIB_RUNTIME_VERSION (en el módulo zlib)
@anchor{library/zlib zlib ZLIB_RUNTIME_VERSION}@anchor{11df}
@deffn {Dato} zlib.ZLIB_RUNTIME_VERSION

Cadena que contiene la versión de la biblioteca zlib utilizada actualmente por el intérprete.


Added in version 3.3.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{67,,gzip}

Lectura y escritura de los archivos en formato @code{gzip}.

@item @indicateurl{http://www.zlib.net}

Página oficial de la biblioteca zlib.

@item @indicateurl{http://www.zlib.net/manual.html}

El manual de zlib explica la semántica y el uso de las numerosas funciones de la biblioteca.
@end table


@node gzip — Support for gzip files,bz2 — Support for bzip2 compression,zlib — Compression compatible with gzip,Compresión de datos y archivado
@anchor{library/gzip doc}@anchor{295b}@anchor{library/gzip gzip-support-for-gzip-files}@anchor{295c}@anchor{library/gzip module-gzip}@anchor{67}
@subsection @code{gzip} — Support for @code{gzip} files


@geindex module; gzip

`Código fuente:' Lib/gzip.py@footnote{https://github.com/python/cpython/tree/main/Lib/gzip.py}


__________________________________________________________________


Este módulo proporciona una interfaz simple para comprimir y descomprimir archivos como lo harían los programas GNU @code{gzip} y @code{gunzip}.

La compresión de datos la proporciona el módulo @ref{132,,zlib}.

El módulo @ref{67,,gzip} proporciona la clase @ref{4d8,,GzipFile}, así como las funciones de conveniencia @ref{295d,,open()}, @ref{6df,,compress()} y @ref{127a,,decompress()}. La clase @ref{4d8,,GzipFile} lee y escribe archivos de formato @code{gzip}, comprimiendo o descomprimiendo automáticamente los datos para que parezcan un @ref{1230,,file object} ordinario.

Tenga en cuenta que los formatos de archivo adicionales que pueden ser descomprimidos por los programas @code{gzip} y @code{gunzip}, como los producidos por @code{compress} y @code{pack}, no son compatibles con este módulo.

El módulo define los siguientes elementos:

@geindex open() (en el módulo gzip)
@anchor{library/gzip gzip open}@anchor{295d}
@deffn {Función} gzip.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

Abre un archivo comprimido gzip en modo binario o de texto, retornando un @ref{1230,,file object}.

El argumento `filename' puede ser un nombre de archivo real (un objeto @ref{237,,str} o @ref{325,,bytes}), o un objeto archivo existente para leer o escribir.

El argumento `mode' puede ser cualquiera de @code{'r'}, @code{'rb'}, @code{'a'}, @code{'ab'}, @code{'w'}, @code{'wb'}, @code{'x'} or @code{'xb'} para el modo binario, o @code{'rt'}, @code{'at'}, @code{'wt'}, or @code{'xt'} para el modo texto. El valor predeterminado es @code{'rb'}.

El argumento `compresslevel' es un número entero de 0 a 9, como para el constructor @ref{4d8,,GzipFile}.

Para el modo binario, esta función es equivalente al constructor @ref{4d8,,GzipFile}: @code{GzipFile (filename, mode, compresslevel)}. En este caso, no se deben proporcionar los argumentos `encoding', `errors' y `newline'.

Para el modo texto, se crea un objeto @ref{4d8,,GzipFile} y se envuelve en una instancia @ref{854,,io.TextIOWrapper} con la codificación especificada, comportamiento de manejo de errores y terminación(es) de línea.


Distinto en la versión 3.3: Se agregó soporte para que `filename' sea un objeto de archivo, soporte para el modo de texto y los argumentos `encoding', `errors' y `newline'.



Distinto en la versión 3.4: Se agregó soporte para los modos @code{'x'}, @code{'xb'} y @code{'xt'}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex BadGzipFile
@anchor{library/gzip gzip BadGzipFile}@anchor{a89}
@deffn {Excepción} gzip.BadGzipFile

An exception raised for invalid gzip files.  It inherits from @ref{4d5,,OSError}.
@ref{1341,,EOFError} and @ref{294d,,zlib.error} can also be raised for invalid gzip
files.


Added in version 3.8.

@end deffn

@geindex GzipFile (clase en gzip)
@anchor{library/gzip gzip GzipFile}@anchor{4d8}
@deffn {Clase} gzip.GzipFile (filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)

Constructor para la clase @ref{4d8,,GzipFile}, que simula la mayoría de los métodos de @ref{1230,,file object}, con la excepción del método @ref{1379,,truncate()}. Al menos uno de `fileobj' y `filename' debe recibir un valor no trivial.

La nueva instancia de clase se basa en `fileobj', que puede ser un archivo normal, un objeto @ref{f25,,io.BytesIO}, o cualquier otro objeto que simule un archivo. El valor predeterminado es @code{None}, en cuyo caso se abre `filename' para proporcionar un objeto de archivo.

Cuando `fileobj' no es @code{None}, el argumento `filename' solo se usa para ser incluido en el encabezado del archivo @code{gzip}, que puede incluir el nombre de archivo original del archivo sin comprimir. De forma predeterminada, el nombre de archivo es de `fileobj', si es discernible; de lo contrario, el valor predeterminado es la cadena vacía, y en este caso el nombre del archivo original no se incluye en el encabezado.

El argumento `mode' puede ser cualquiera de @code{'r'}, @code{'rb'}, @code{'a'}, @code{'ab'}, @code{'w'}, @code{'wb'}, @code{'x'}, or @code{'xb'}, dependiendo de si el archivo se leerá o escribirá. El valor predeterminado es el modo de `fileobj' si es discernible; de lo contrario, el valor predeterminado es @code{'rb'}. En futuras versiones de Python, no se utilizará el modo `fileobj'. Es mejor especificar siempre `mode' para escribir.

Tenga en cuenta que el archivo siempre se abre en modo binario. Para abrir un archivo comprimido en modo de texto, utilice @ref{295d,,open()} (o ajuste su @ref{4d8,,GzipFile} con un @ref{854,,io.TextIOWrapper}).

El argumento `compresslevel' es un entero de @code{0} a @code{9} que controla el nivel de compresión; @code{1} es más rápido y produce la menor compresión, y @code{9} es más lento y produce la mayor compresión. @code{0} no es una compresión. El valor predeterminado es @code{9}.

The optional `mtime' argument is the timestamp requested by gzip. The time
is in Unix format, i.e., seconds since 00:00:00 UTC, January 1, 1970.
If `mtime' is omitted or @code{None}, the current time is used. Use `mtime' = 0
to generate a compressed stream that does not depend on creation time.

See below for the @ref{295e,,mtime} attribute that is set when decompressing.

Calling a @ref{4d8,,GzipFile} object’s @code{close()} method does not close
`fileobj', since you might wish to append more material after the compressed
data.  This also allows you to pass an @ref{f25,,io.BytesIO} object opened for
writing as `fileobj', and retrieve the resulting memory buffer using the
@ref{f25,,io.BytesIO} object’s @ref{295f,,getvalue()} method.

@ref{4d8,,GzipFile} admite la interfaz @ref{735,,io.BufferedIOBase}, incluida la iteración y la declaración @ref{673,,with}. Solo el método @ref{1379,,truncate()} no está implementado.

@ref{4d8,,GzipFile} también proporciona el siguiente método y atributo:

@geindex peek() (método de gzip.GzipFile)
@anchor{library/gzip gzip GzipFile peek}@anchor{1279}
@deffn {Método} peek (n)

Lee `n' bytes no comprimidos sin avanzar en la posición del archivo. A lo sumo se realiza una sola lectura en la secuencia comprimida para satisfacer la llamada. El número de bytes retornados puede ser mayor o menor de lo solicitado.

@cartouche
@quotation Nota 
Al llamar a @ref{1279,,peek()} no cambia la posición del archivo @ref{4d8,,GzipFile}, puede cambiar la posición del objeto de archivo subyacente (por ejemplo, si el @ref{4d8,,GzipFile} se construyó con el parámetro `fileobj').
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex mode (atributo de gzip.GzipFile)
@anchor{library/gzip gzip GzipFile mode}@anchor{2960}
@deffn {Atributo} mode

@code{'rb'} for reading and @code{'wb'} for writing.


Distinto en la versión 3.13: In previous versions it was an integer @code{1} or @code{2}.

@end deffn

@geindex mtime (atributo de gzip.GzipFile)
@anchor{library/gzip gzip GzipFile mtime}@anchor{295e}
@deffn {Atributo} mtime

When decompressing, this attribute is set to the last timestamp in the most
recently read header.  It is an integer, holding the number of seconds
since the Unix epoch (00:00:00 UTC, January 1, 1970).
The initial value before reading any headers is @code{None}.
@end deffn

@geindex name (atributo de gzip.GzipFile)
@anchor{library/gzip gzip GzipFile name}@anchor{5b1}
@deffn {Atributo} name

La ruta al archivo gzip en disco, como @ref{237,,str} o @ref{325,,bytes}. Equivale a la salida de @ref{cdb,,os.fspath()} en la ruta de entrada original, sin ninguna otra normalización, resolución o expansión.
@end deffn


Distinto en la versión 3.1: Se ha agregado soporte para la declaración @ref{673,,with}, junto con el argumento del constructor `mtime' y el atributo @ref{295e,,mtime}.



Distinto en la versión 3.2: Se agregó soporte para archivos con relleno de ceros y que no se pueden buscar.



Distinto en la versión 3.3: El método @ref{2961,,io.BufferedIOBase.read1()} ahora está implementado.



Distinto en la versión 3.4: Se agregó soporte para los modos @code{'x'} y @code{'xb'}.



Distinto en la versión 3.5: Se ha añadido soporte para escribir objetos arbitrarios @ref{db4,,bytes-like objects}. El método @ref{1390,,read()} ahora acepta un argumento de @code{None}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.



Obsoleto desde la versión 3.9: Abriendo @ref{4d8,,GzipFile} para escribir sin especificar el argumento `mode' está obsoleto.



Distinto en la versión 3.12: Elimine el atributo @code{filename}, utilice en su lugar el atributo @code{name`}.

@end deffn

@geindex compress() (en el módulo gzip)
@anchor{library/gzip gzip compress}@anchor{6df}
@deffn {Función} gzip.compress (data, compresslevel=9, *, mtime=0)

Compress the `data', returning a @ref{325,,bytes} object containing
the compressed data.  `compresslevel' and `mtime' have the same meaning as in
the @ref{4d8,,GzipFile} constructor above,
but `mtime' defaults to 0 for reproducible output.


Added in version 3.2.



Distinto en la versión 3.8: Se agregó el parámetro `mtime' para una salida reproducible.



Distinto en la versión 3.11: Speed is improved by compressing all data at once instead of in a
streamed fashion. Calls with `mtime' set to @code{0} are delegated to
@ref{6e0,,zlib.compress()} for better speed. In this situation the
output may contain a gzip header «OS» byte value other than 255
«unknown» as supplied by the underlying zlib implementation.



Distinto en la versión 3.13: The gzip header OS byte is guaranteed to be set to 255 when this function
is used as was the case in 3.10 and earlier.



Distinto en la versión 3.14: The `mtime' parameter now defaults to 0 for reproducible output.
For the previous behaviour of using the current time,
pass @code{None} to `mtime'.

@end deffn

@geindex decompress() (en el módulo gzip)
@anchor{library/gzip gzip decompress}@anchor{127a}
@deffn {Función} gzip.decompress (data)

Descomprime `data', retornando un objeto @ref{325,,bytes} que contiene los datos sin comprimir. Esta función es capaz de descomprimir datos gzip de varios miembros (múltiples bloques gzip concatenados entre sí). Cuando se está seguro de que los datos contienen un solo miembro, la función @ref{d94,,zlib.decompress()} es más rápida si se establece `wbits' a 31.


Added in version 3.2.



Distinto en la versión 3.11: La velocidad se mejora al descomprimir los miembros simultáneamente en memoria en lugar de hacerlo de manera continua.

@end deffn

@menu
* Ejemplos de uso:: 
* Interfaz de Línea de Comandos:: 

@end menu

@node Ejemplos de uso,Interfaz de Línea de Comandos,,gzip — Support for gzip files
@anchor{library/gzip examples-of-usage}@anchor{2962}@anchor{library/gzip gzip-usage-examples}@anchor{2963}
@subsubsection Ejemplos de uso


Ejemplos de como leer un archivo comprimido:

@example
import gzip
with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
    file_content = f.read()
@end example

Ejemplos de como crear un archivo comprimido GZIP:

@example
import gzip
content = b"Lots of content here"
with gzip.open('/home/joe/file.txt.gz', 'wb') as f:
    f.write(content)
@end example

Ejemplos de como GZIP comprime un archivo existente:

@example
import gzip
import shutil
with open('/home/joe/file.txt', 'rb') as f_in:
    with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out:
        shutil.copyfileobj(f_in, f_out)
@end example

Ejemplo de como GZIP comprime una cadena binaria:

@example
import gzip
s_in = b"Lots of content here"
s_out = gzip.compress(s_in)
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{132,,zlib}

El módulo básico de compresión de datos necesario para admitir el formato de archivo @code{gzip}.
@end table


@node Interfaz de Línea de Comandos,,Ejemplos de uso,gzip — Support for gzip files
@anchor{library/gzip command-line-interface}@anchor{2964}@anchor{library/gzip gzip-cli}@anchor{2965}
@subsubsection Interfaz de Línea de Comandos


El módulo @ref{67,,gzip} proporciona una interfaz de línea de comandos simple para comprimir o descomprimir archivos.

Una vez ejecutado el módulo @ref{67,,gzip} conserva los archivos de entrada.


Distinto en la versión 3.8: Agrega una nueva interfaz de línea de comandos con un uso. De forma predeterminada, cuando ejecutará la CLI, el nivel de compresión predeterminado es 6.


@menu
* Opciones de línea de comandos:: 

@end menu

@node Opciones de línea de comandos,,,Interfaz de Línea de Comandos
@anchor{library/gzip command-line-options}@anchor{2966}
@subsubsection Opciones de línea de comandos


@geindex opción de línea de comando gzip; file
@anchor{library/gzip cmdoption-gzip-arg-file}@anchor{2967}
@deffn {Option} file

Si no se especifica `file', lee de @ref{5df,,sys.stdin}.
@end deffn

@geindex opción de línea de comando gzip; --fast
@anchor{library/gzip cmdoption-gzip-fast}@anchor{2968}
@deffn {Option} @w{-}@w{-}fast

Indica el método de compresión más rápido (menos compresión).
@end deffn

@geindex opción de línea de comando gzip; --best
@anchor{library/gzip cmdoption-gzip-best}@anchor{2969}
@deffn {Option} @w{-}@w{-}best

Indica el método de compresión más lento (mejor compresión).
@end deffn

@geindex opción de línea de comando gzip; -d
@geindex opción de línea de comando gzip; --decompress
@anchor{library/gzip cmdoption-gzip-d}@anchor{296a}@anchor{library/gzip cmdoption-gzip-decompress}@anchor{296b}
@deffn {Option} @w{-}d, @w{-}@w{-}decompress

Descomprime el archivo dado.
@end deffn

@geindex opción de línea de comando gzip; -h
@geindex opción de línea de comando gzip; --help
@anchor{library/gzip cmdoption-gzip-h}@anchor{296c}@anchor{library/gzip cmdoption-gzip-help}@anchor{296d}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Muestra el mensaje de ayuda.
@end deffn

@node bz2 — Support for bzip2 compression,lzma — Compression using the LZMA algorithm,gzip — Support for gzip files,Compresión de datos y archivado
@anchor{library/bz2 doc}@anchor{296e}@anchor{library/bz2 bz2-support-for-bzip2-compression}@anchor{296f}@anchor{library/bz2 module-bz2}@anchor{14}
@subsection @code{bz2} — Support for @code{bzip2} compression


@geindex module; bz2

`Código fuente:' Lib/bz2.py@footnote{https://github.com/python/cpython/tree/main/Lib/bz2.py}


__________________________________________________________________


Este módulo proporciona una interfaz completa para comprimir y descomprimir datos utilizando el algoritmo de compresión bzip2.

El módulo @ref{14,,bz2} contiene:


@itemize *

@item 
La función @ref{110a,,open()} y la clase @ref{8fd,,BZ2File} para leer y escribir archivos comprimidos.

@item 
Las clases @ref{1765,,BZ2Compressor} y @ref{1763,,BZ2Decompressor} para la (de)compresión incremental.

@item 
Las funciones @ref{2413,,compress()} y @ref{110b,,decompress()} para una (de)compresión en un solo paso.
@end itemize

@menu
* (De)compresión de archivos: De compresión de archivos. 
* (De)compresión incremental: De compresión incremental. 
* (Des)comprimir en un solo paso: Des comprimir en un solo paso. 
* Ejemplos de uso: Ejemplos de uso<2>. 

@end menu

@node De compresión de archivos,De compresión incremental,,bz2 — Support for bzip2 compression
@anchor{library/bz2 de-compression-of-files}@anchor{2970}
@subsubsection (De)compresión de archivos


@geindex open() (en el módulo bz2)
@anchor{library/bz2 bz2 open}@anchor{110a}
@deffn {Función} bz2.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

Abre un archivo comprimido con bzip2 en modo binario o texto, retorna un @ref{1230,,objeto archivo}.

Al igual que con el constructor para @ref{8fd,,BZ2File}, el argumento `filename' puede ser un nombre de archivo real (un objeto @ref{237,,str} o @ref{325,,bytes}), o un objeto de archivo existente para leer o escribirle.

El argumento `mode' puede ser cualquiera de @code{'r'}, @code{'rb'}, @code{'w'}, @code{'wb'}, @code{'x'}, @code{'xb'}, @code{'a'} o @code{'ab'} para modo binario, o @code{'rt'}, @code{'wt'}, @code{'xt'} , o @code{'a'} para el modo de texto. El valor predeterminado es @code{'rb'}.

El argumento `compresslevel' es un entero del 1 al 9, como para el constructor de @ref{8fd,,BZ2File}.

Para el modo binario, esta función es equivalente a @ref{8fd,,BZ2File} constructor: @code{BZ2File(filename, mode, compresslevel=compresslevel)}. En este caso, no se deben proporcionar los argumentos `encoding', `errors' y `newline' (nueva linea).

Para el modo de texto, se crea un objeto @ref{8fd,,BZ2File}, y se envuelve en una instancia @ref{854,,io.TextIOWrapper} con la codificación especificada, el comportamiento de manejo de errores y los final(es) de línea.


Added in version 3.3.



Distinto en la versión 3.4: El modo @code{'x'} (creación exclusiva) ha sido agregado.



Distinto en la versión 3.6: Acepta un objeto similar a una ruta (@ref{3f0,,path-like object}).

@end deffn

@geindex BZ2File (clase en bz2)
@anchor{library/bz2 bz2 BZ2File}@anchor{8fd}
@deffn {Clase} bz2.BZ2File (filename, mode='r', *, compresslevel=9)

Abre un archivo comprimido con bzip2 en modo binario.

Si `filename' es un objeto tipo @ref{237,,str} o @ref{325,,bytes}, abre el archivo nombrado directamente. De lo contrario, `filename' debería ser un @ref{1230,,file object}, que se utilizará para leer o escribir los datos comprimidos.

El argumento `mode' puede ser @code{'r'} para lectura (predeterminado), @code{'w'} para sobrescribir, @code{'x'} para creación exclusiva o @code{'a'} para anexar. Estos se pueden dar de manera equivalente como @code{'rb'}, @code{'wb'}, @code{'xb'} y @code{'ab'} respectivamente.

Si `filename' es un objeto de archivo (en lugar de un nombre de archivo real), el modo @code{'w'} no trunca el archivo, y es equivalente a @code{'a'}.

Si `mode' es @code{'w'} o @code{'a'}, `compresslevel' puede ser un número entero entre @code{1} y @code{9} especificando el nivel de compresión: @code{1} produce la menor compresión y @code{9} (predeterminado) produce la mayor compresión.

Si `mode' es @code{'r'}, el archivo de entrada puede ser la concatenación de múltiples flujos (streams) comprimidos.

@ref{8fd,,BZ2File} provides all of the members specified by the
@ref{735,,io.BufferedIOBase}, except for @ref{2971,,detach()}
and @ref{1379,,truncate()}.
Iteration and the @ref{673,,with} statement are supported.

@ref{8fd,,BZ2File} also provides the following methods and attributes:

@geindex peek() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File peek}@anchor{2972}
@deffn {Método} peek ([n])

Retorna datos almacenados en el búfer sin avanzar la posición del archivo. Se retornará al menos un byte de datos (a menos que sea EOF). El número exacto de bytes retornados no está especificado.

@cartouche
@quotation Nota 
Al invocar @ref{2972,,peek()} no cambia la posición del archivo de @ref{8fd,,BZ2File}, puede cambiar la posición del objeto de archivo subyacente (por ejemplo, si @ref{8fd,,BZ2File} se construyó pasando un objeto de archivo a `filename').
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex fileno() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File fileno}@anchor{2973}
@deffn {Método} fileno ()

Return the file descriptor for the underlying file.


Added in version 3.3.

@end deffn

@geindex readable() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File readable}@anchor{2974}
@deffn {Método} readable ()

Return whether the file was opened for reading.


Added in version 3.3.

@end deffn

@geindex seekable() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File seekable}@anchor{2975}
@deffn {Método} seekable ()

Return whether the file supports seeking.


Added in version 3.3.

@end deffn

@geindex writable() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File writable}@anchor{2976}
@deffn {Método} writable ()

Return whether the file was opened for writing.


Added in version 3.3.

@end deffn

@geindex read1() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File read1}@anchor{2977}
@deffn {Método} read1 (size=-1)

Read up to `size' uncompressed bytes, while trying to avoid
making multiple reads from the underlying stream. Reads up to a
buffer’s worth of data if size is negative.

Returns @code{b'@w{'}} if the file is at EOF.


Added in version 3.3.

@end deffn

@geindex readinto() (método de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File readinto}@anchor{2978}
@deffn {Método} readinto (b)

Read bytes into `b'.

Returns the number of bytes read (0 for EOF).


Added in version 3.3.

@end deffn

@geindex mode (atributo de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File mode}@anchor{2979}
@deffn {Atributo} mode

@code{'rb'} for reading and @code{'wb'} for writing.


Added in version 3.13.

@end deffn

@geindex name (atributo de bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File name}@anchor{297a}
@deffn {Atributo} name

The bzip2 file name.  Equivalent to the @ref{297b,,name}
attribute of the underlying @ref{1230,,file object}.


Added in version 3.13.

@end deffn


Distinto en la versión 3.1: Se agregó soporte para la declaración @ref{673,,with}.



Distinto en la versión 3.3: Se agregó soporte para `filename' siendo un objeto de archivo (@ref{1230,,file object}) en lugar de un nombre de archivo real.

Se agregó el modo @code{'a'} (agregar), junto con el soporte para leer archivos de flujo múltiple (multi-stream).



Distinto en la versión 3.4: El modo @code{'x'} (creación exclusiva) ha sido agregado.



Distinto en la versión 3.5: El método @ref{1390,,read()} ahora acepta el argumento @code{None}.



Distinto en la versión 3.6: Acepta un objeto similar a una ruta (@ref{3f0,,path-like object}).



Distinto en la versión 3.9: El parámetro `buffering' ha sido retirado. Desde Python 3.0 era ignorado y estaba obsoleto. Pasa un objeto archivo abierto para controlar cómo el archivo es abierto.

El parámetro `compresslevel' se convirtió en un argumento sólo por palabra clave.



Distinto en la versión 3.10: Esta clase es insegura en hilos frente a múltiples lectores o escritores, al igual que sus clases equivalentes en @ref{67,,gzip} y @ref{8a,,lzma} siempre lo han sido.

@end deffn

@node De compresión incremental,Des comprimir en un solo paso,De compresión de archivos,bz2 — Support for bzip2 compression
@anchor{library/bz2 incremental-de-compression}@anchor{297c}
@subsubsection (De)compresión incremental


@geindex BZ2Compressor (clase en bz2)
@anchor{library/bz2 bz2 BZ2Compressor}@anchor{1765}
@deffn {Clase} bz2.BZ2Compressor (compresslevel=9)

Crea un nuevo objeto compresor. Este objeto puede usarse para comprimir datos de forma incremental. Para comprimir en un solo paso, use la función @ref{2413,,compress()} en su lugar.

`compresslevel', si se proporciona, debe ser un número entero entre @code{1} y @code{9}. El valor predeterminado es @code{9}.

@geindex compress() (método de bz2.BZ2Compressor)
@anchor{library/bz2 bz2 BZ2Compressor compress}@anchor{297d}
@deffn {Método} compress (data)

Provee datos al objeto del compresor. Retorna un fragmento de datos comprimidos si es posible, o una cadena de bytes vacía de lo contrario.

Cuando haya terminado de proporcionar datos al compresor, llame al método @ref{297e,,flush()} para finalizar el proceso de compresión.
@end deffn

@geindex flush() (método de bz2.BZ2Compressor)
@anchor{library/bz2 bz2 BZ2Compressor flush}@anchor{297e}
@deffn {Método} flush ()

Termina el proceso de compresión. Retorna los datos comprimidos que quedan en los búferes internos.

El objeto compresor no puede usarse después de que se haya llamado a este método.
@end deffn
@end deffn

@geindex BZ2Decompressor (clase en bz2)
@anchor{library/bz2 bz2 BZ2Decompressor}@anchor{1763}
@deffn {Clase} bz2.BZ2Decompressor

Crea un nuevo objeto descompresor. Este objeto puede usarse para descomprimir datos de forma incremental. Para descomprimir en un solo paso, use la función @ref{110b,,decompress()} en su lugar.

@cartouche
@quotation Nota 
Esta clase no maneja de forma transparente las entradas que contienen múltiples flujos comprimidos, a diferencia de @ref{110b,,decompress()} y @ref{8fd,,BZ2File}. Si necesitas descomprimir una entrada de flujo múltiple con @ref{1763,,BZ2Decompressor}, debe usar un nuevo descompresor para cada flujo (stream).
@end quotation
@end cartouche

@geindex decompress() (método de bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor decompress}@anchor{e51}
@deffn {Método} decompress (data, max_length=-1)

Descomprime `datos' (un @ref{db4,,bytes-like object}), retornando datos sin comprimir como bytes. Algunos de los `datos' pueden almacenarse internamente para su uso en llamadas posteriores a @ref{110b,,decompress()}. Los datos retornados deben concatenarse con la salida de cualquier llamada anterior a @ref{110b,,decompress()}.

Si `max_length' no es negativo, retorna como máximo `max_length' bytes de datos descomprimidos. Si se alcanza este límite y se pueden producir más resultados, el atributo @ref{297f,,needs_input} se establecerá en @code{False}. En este caso, la siguiente llamada a @ref{e51,,decompress()} puede proporcionar `datos' como @code{b'@w{'}} para obtener más de la salida.

Si todos los datos de entrada se descomprimieron y retornaron (ya sea porque esto era menor que `max_length' bytes, o porque `max_length' era negativo), el atributo @ref{297f,,needs_input} se establecerá en @code{True}.

Attempting to decompress data after the end of stream is reached
raises an @ref{1341,,EOFError}.  Any data found after the end of the
stream is ignored and saved in the @ref{2980,,unused_data} attribute.


Distinto en la versión 3.5: Añadido el parámetro `max_length'.

@end deffn

@geindex eof (atributo de bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor eof}@anchor{2981}
@deffn {Atributo} eof

@code{True} si se ha alcanzado el marcador de fin de flujo.


Added in version 3.3.

@end deffn

@geindex unused_data (atributo de bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor unused_data}@anchor{2980}
@deffn {Atributo} unused_data

Datos encontrados después del final del flujo comprimido.

Si se accede a este atributo antes de que se haya alcanzado el final del flujo, su valor será @code{b'@w{'}}.
@end deffn

@geindex needs_input (atributo de bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor needs_input}@anchor{297f}
@deffn {Atributo} needs_input

@code{False} si el método @ref{e51,,decompress()} puede proporcionar más datos descomprimidos antes de requerir una nueva entrada sin comprimir.


Added in version 3.5.

@end deffn
@end deffn

@node Des comprimir en un solo paso,Ejemplos de uso<2>,De compresión incremental,bz2 — Support for bzip2 compression
@anchor{library/bz2 one-shot-de-compression}@anchor{2982}
@subsubsection (Des)comprimir en un solo paso


@geindex compress() (en el módulo bz2)
@anchor{library/bz2 bz2 compress}@anchor{2413}
@deffn {Función} bz2.compress (data, compresslevel=9)

Comprime `datos', un @ref{db4,,objetos tipo binarios}.

`compresslevel', si se proporciona, debe ser un número entero entre @code{1} y @code{9}. El valor predeterminado es @code{9}.

Para compresión incremental, use @ref{1765,,BZ2Compressor} en su lugar.
@end deffn

@geindex decompress() (en el módulo bz2)
@anchor{library/bz2 bz2 decompress}@anchor{110b}
@deffn {Función} bz2.decompress (data)

Descomprime `datos', un @ref{db4,,objetos tipo binarios}.

Si `data' es la concatenación de múltiples flujos comprimidos, descomprime todos los flujos.

Para la descompresión incremental, use @ref{1763,,BZ2Decompressor} en su lugar.


Distinto en la versión 3.3: Se agregó soporte para entradas de flujo múltiple.

@end deffn

@node Ejemplos de uso<2>,,Des comprimir en un solo paso,bz2 — Support for bzip2 compression
@anchor{library/bz2 bz2-usage-examples}@anchor{2983}@anchor{library/bz2 examples-of-usage}@anchor{2984}
@subsubsection Ejemplos de uso


Aquí hay algunos ejemplos del uso típico del modulo @ref{14,,bz2}.

Usando @ref{2413,,compress()} y @ref{110b,,decompress()} para demostrar una compresión de ida y vuelta (`round-trip'):

@example
>>> import bz2
>>> data = b"""\
... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
>>> c = bz2.compress(data)
>>> len(data) / len(c)  # Data compression ratio
1.513595166163142
>>> d = bz2.decompress(c)
>>> data == d  # Check equality to original object after round-trip
True
@end example

Usando @ref{1765,,BZ2Compressor} para compresión incremental:

@example
>>> import bz2
>>> def gen_data(chunks=10, chunksize=1000):
...     """Yield incremental blocks of chunksize bytes."""
...     for _ in range(chunks):
...         yield b"z" * chunksize
...
>>> comp = bz2.BZ2Compressor()
>>> out = b""
>>> for chunk in gen_data():
...     # Provide data to the compressor object
...     out = out + comp.compress(chunk)
...
>>> # Finish the compression process.  Call this once you have
>>> # finished providing data to the compressor.
>>> out = out + comp.flush()
@end example

The example above uses a very «nonrandom» stream of data
(a stream of @code{b"z"} chunks).  Random data tends to compress poorly,
while ordered, repetitive data usually yields a high compression ratio.

Escribiendo y leyendo un archivo comprimido con bzip2 en modo binario:

@example
>>> import bz2
>>> data = b"""\
... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
>>> with bz2.open("myfile.bz2", "wb") as f:
...     # Write compressed data to file
...     unused = f.write(data)
...
>>> with bz2.open("myfile.bz2", "rb") as f:
...     # Decompress data from file
...     content = f.read()
...
>>> content == data  # Check equality to original object after round-trip
True
@end example

@c import os
@c os.remove("myfile.bz2")

@node lzma — Compression using the LZMA algorithm,zipfile — Work with ZIP archives,bz2 — Support for bzip2 compression,Compresión de datos y archivado
@anchor{library/lzma doc}@anchor{2985}@anchor{library/lzma lzma-compression-using-the-lzma-algorithm}@anchor{2986}@anchor{library/lzma module-lzma}@anchor{8a}
@subsection @code{lzma} — Compression using the LZMA algorithm


@geindex module; lzma


Added in version 3.3.


`Código fuente:'Lib/lzma.py@footnote{https://github.com/python/cpython/tree/main/Lib/lzma.py}


__________________________________________________________________


Este módulo provee clases y funciones de conveniencia para comprimir y descomprimir datos utilizando el algoritmo de compresión LZMA. También se incluye una interfaz de fichero soportando el @code{.xz} y formatos de fichero @code{.lzma} heredados utilizados por la utilidad @code{xz}, así como flujos comprimidos sin procesar.

La interfaz proporcionada por este módulo es muy similar a la del módulo @ref{14,,bz2}. Tenga en cuenta que @ref{1088,,LZMAFile} y @ref{8fd,,bz2.BZ2File} son seguros para subprocesos `not', por lo que si necesita utilizar una única instancia @ref{1088,,LZMAFile} de varios subprocesos, es necesario protegerla con un candado.

@geindex LZMAError
@anchor{library/lzma lzma LZMAError}@anchor{2987}
@deffn {Excepción} lzma.LZMAError

Esta excepción es generada cuando un error ocurre durante la compresión o descompresión, o mientras se inicializa el estado de compresor/descompresor.
@end deffn

@menu
* Leyendo y escribiendo ficheros comprimidos:: 
* Comprimiendo y descomprimiendo datos en memoria:: 
* Misceláneas:: 
* Especificando cadenas de filtro personalizadas:: 
* Ejemplos: Ejemplos<7>. 

@end menu

@node Leyendo y escribiendo ficheros comprimidos,Comprimiendo y descomprimiendo datos en memoria,,lzma — Compression using the LZMA algorithm
@anchor{library/lzma reading-and-writing-compressed-files}@anchor{2988}
@subsubsection Leyendo y escribiendo ficheros comprimidos


@geindex open() (en el módulo lzma)
@anchor{library/lzma lzma open}@anchor{2989}
@deffn {Función} lzma.open (filename, mode='rb', *, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)

Abre un fichero comprimido LZMA in binario o modo texto, retornando un @ref{1230,,file object}.

El argumento `filename' puede ser un nombre de fichero real (dado como un objeto @ref{237,,str}, @ref{325,,bytes} o @ref{3f0,,path-like}), en cuyo caso el fichero nombrado es abierto, o puede ser un objeto de fichero existente para leer o escribir.

El argumento `mode' puede ser cualquiera de @code{"r"}, @code{"rb"}, @code{"w"}, @code{"wb"}, @code{"x"}, @code{"xb"}, @code{"a"} o @code{"a"} para modo binario, o @code{"rt"}, @code{"wt"}, @code{"xt"}, o @code{"at"} para modo texto. Por defecto es @code{"rb"}.

Al abrir un fichero para lectura, los argumentos `format' y `filters' tienen el mismo significado que para @ref{1762,,LZMADecompressor}. En este caso, los argumentos `check' y `preset' no deberían ser utilizados.

Al abrir un fichero para lectura, los argumentos `format', `check', `preset' y `filters' tienen el mismo significado que para @ref{1764,,LZMACompressor}.

Para modo binario, esta función es equivalente al constructor @ref{1088,,LZMAFile}: @code{LZMAFile(filename, mode, ...)}. En este caso, los argumentos `encoding', `errors' y `newline' no deben ser proveídos.

Para modo texto, un objeto @ref{1088,,LZMAFile} es creado, y envuelto en una instancia @ref{854,,io.TextIOWrapper} con codificación específica, comportamiento de manejo de errores, y codificación(es) de línea.


Distinto en la versión 3.4: Agregado soporte para los modos @code{"x"}, @code{"xb"} y @code{"xt"}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex LZMAFile (clase en lzma)
@anchor{library/lzma lzma LZMAFile}@anchor{1088}
@deffn {Clase} lzma.LZMAFile (filename=None, mode='r', *, format=None, check=-1, preset=None, filters=None)

Abre un fichero comprimido LZMA en modo binario.

Un @code{LZMAFIle} puede envolver un ya abierto @ref{1230,,file object}, u operar directamente en un fichero nombrado. El argumento `filename' especifica el objeto de fichero a envolver, o el nombre del fichero para abrir (como un @ref{237,,str}, @ref{325,,bytes} o un objeto @ref{3f0,,path-like}). Al envolver un objeto de fichero existente, el fichero envuelto no será cerrado cuando el @ref{1088,,LZMAFile} es cerrado.

El argumento `mode' puede ser @code{"r"} para lectura (por defecto), @code{"w"} para sobreescritura, @code{"x"} para creación exclusiva, o @code{"a"} para agregado, Estos pueden ser equivalentemente dados como @code{"rb"}, @code{"wb"}, @code{"xb"} y @code{"ab"} respectivamente.

Si `filename' es un objeto de fichero (en lugar de un nombre de fichero actual), un modo de @code{"w"} no trunca el fichero, y en cambio es equivalente a @code{"a"}.

Al abrir un fichero para escritura, el fichero de entrada puede ser la concatenación para múltiples flujos comprimidos separados. Estos son transparentemente decodificados como un único flujo lógico.

Al abrir un fichero para lectura, los argumentos `format' y `filters' tienen el mismo significado que para @ref{1762,,LZMADecompressor}. En este caso, los argumentos `check' y `preset' no deberían ser utilizados.

Al abrir un fichero para lectura, los argumentos `format', `check', `preset' y `filters' tienen el mismo significado que para @ref{1764,,LZMACompressor}.

@ref{1088,,LZMAFile} supports all the members specified by
@ref{735,,io.BufferedIOBase}, except for @ref{2971,,detach()}
and @ref{1379,,truncate()}.
Iteration and the @ref{673,,with} statement are supported.

The following method and attributes are also provided:

@geindex peek() (método de lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile peek}@anchor{298a}
@deffn {Método} peek (size=-1)

Retorna datos almacenados en búfer sin avanzar la posición del fichero. Al menos un byte de datos será retornado, a menos que EOF es alcanzado. El número exacto de bytes retornado no está especificado (el argumento `size' es ignorado).

@cartouche
@quotation Nota 
Mientras que llamar @ref{298a,,peek()} no cambia la posición de fichero del @ref{1088,,LZMAFile}, puede cambiar la posición del objeto de fichero subyacente (por ejemplo si el @ref{1088,,LZMAFile} fue construido pasando un objeto de fichero por `filename').
@end quotation
@end cartouche
@end deffn

@geindex mode (atributo de lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile mode}@anchor{298b}
@deffn {Atributo} mode

@code{'rb'} for reading and @code{'wb'} for writing.


Added in version 3.13.

@end deffn

@geindex name (atributo de lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile name}@anchor{298c}
@deffn {Atributo} name

The lzma file name.  Equivalent to the @ref{297b,,name}
attribute of the underlying @ref{1230,,file object}.


Added in version 3.13.

@end deffn


Distinto en la versión 3.4: Agregado soporte para los modos @code{"x"} y @code{"xb"}.



Distinto en la versión 3.5: El método @ref{1390,,read()} acepta ahora un argumento de @code{None}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@node Comprimiendo y descomprimiendo datos en memoria,Misceláneas,Leyendo y escribiendo ficheros comprimidos,lzma — Compression using the LZMA algorithm
@anchor{library/lzma compressing-and-decompressing-data-in-memory}@anchor{298d}
@subsubsection Comprimiendo y descomprimiendo datos en memoria


@geindex LZMACompressor (clase en lzma)
@anchor{library/lzma lzma LZMACompressor}@anchor{1764}
@deffn {Clase} lzma.LZMACompressor (format=FORMAT_XZ, check=-1, preset=None, filters=None)

Crea un objeto compresor, el cual puede ser utilizado para comprimir datos incrementalmente.

Para una forma más conveniente de comprimir un único fragmento de datos, vea @ref{298e,,compress()}.

El argumento `format' especifica qué formato de contenedor debería ser utilizado. Posibles valores son:


@itemize *

@item 

@table @asis

@item @code{FORMAT_XZ}: El formato de contenedor @code{.xz}.

Este es el formato por defecto.
@end table

@item 

@table @asis

@item @code{FORMAT_ALONE}: El formato de contenedor @code{.lzma} heredado.

Este formato es más limitado que @code{.xz} – no soporta chequeos de integridad o múltiples filtros.
@end table

@item 

@table @asis

@item @code{FORMAT_RAW}: Un flujo de datos sin procesar, sin utilizar ningún formato de contenedor.

Este especificador de formato no soporta chequeos de integridad, y requiere que siempre especifiques una cadena de filtro personalizada (para compresión y descompresión). Adicionalmente, los datos comprimidos de esta manera no pueden ser descomprimidos utilizando @code{FORMAT_AUTO} (vea @ref{1762,,LZMADecompressor}).
@end table
@end itemize

El argumento `check' especifica el tipo de chequeo de integridad a incluir en los datos descomprimidos. Este chequeo es utilizado al descomprimir, para asegurarse que los datos no han sido corrompidos. Los posibles valores son:


@itemize *

@item 
@code{CHECK_NONE}: Sin verificación de integridad. Este es el valor por defecto (y el único valor aceptable) para @code{FORMAT_ALONE} y @code{FORMAT_RAW}.

@item 
@code{CHECK_CRC32}: Chequeo de Redundancia Cíclica de 32 bits.

@item 
@code{CHECK_CRC64}: Chequeo de Redundancia Cíclica de 64 bits. Este es el valor por defecto para @code{FORMAT_XZ}.

@item 
@code{CHECK_SHA256}: Algoritmo Hash Seguro de 256 bits.
@end itemize

Si el chequeo especificado no es soportado, un @ref{2987,,LZMAError} es generado.

Las configuraciones de compresión pueden ser especificadas como un nivel de compresión predefinido (con el argumento `preset'), o en detalle como una cadena de filtro personalizada (con el argumento `filters').

El argumento `preset' (si es proveído) debería ser un entero entre @code{0} y @code{9} (inclusive), opcionalmente OR con la constante @code{PRESET_EXTREME}. Si no se proporciona `preset' ni `filters', el comportamiento por defecto es utilizar @code{PRESET_DEFAULT} (nivel preestablecido @code{6}). Altos preestablecidos producen salidas más pequeñas, pero vuelve el proceso de compresión más lento.

@cartouche
@quotation Nota 
En adición a ser más CPU-intensivo, la compresión con preestablecidos más altos también requiere mucha más memoria (y produce salida que necesita más memoria a descomprimir). Con un preestablecido de @code{9} por ejemplo, la sobrecarga para un objeto @ref{1764,,LZMACompressor} puede ser tan alto como 800MiB. Por esta razón, es generalmente mejor quedarse con el preestablecido por defecto.
@end quotation
@end cartouche

El argumento `filters' (si es proveído) debería ser un especificador de cadena de filtro. Vea @ref{298f,,Especificando cadenas de filtro personalizadas} para detalles.

@geindex compress() (método de lzma.LZMACompressor)
@anchor{library/lzma lzma LZMACompressor compress}@anchor{2990}
@deffn {Método} compress (data)

Comprime `data' (un objeto @ref{325,,bytes}), retornando un objeto @ref{325,,bytes} conteniendo información comprimida por al menos parte de la entrada. Algo de `data' puede ser almacenado internamente, para uso en llamadas posteriores a @ref{298e,,compress()} y @ref{2991,,flush()}. La información retornada debería ser concatenada con la salida en cualquier llamada previa a @ref{298e,,compress()}.
@end deffn

@geindex flush() (método de lzma.LZMACompressor)
@anchor{library/lzma lzma LZMACompressor flush}@anchor{2991}
@deffn {Método} flush ()

Finiquita el proceso de compresión, retornando un objeto @ref{325,,bytes} conteniendo cualquier información almacenada en los búferes internos del compresor.

El compresor no puede ser utilizado después de que este método es llamado.
@end deffn
@end deffn

@geindex LZMADecompressor (clase en lzma)
@anchor{library/lzma lzma LZMADecompressor}@anchor{1762}
@deffn {Clase} lzma.LZMADecompressor (format=FORMAT_AUTO, memlimit=None, filters=None)

Crea un objeto descompresor, el cual puede ser utilizado para descomprimir datos incrementalmente.

Para una forma más conveniente de descomprimir un flujo completo de compresión a la vez, vea @ref{2992,,decompress()}.

El argumento `format' especifica el formato de contenedor que debería ser utilizado. El valor por defecto es @code{FORMAT_AUTO}, el cual puede descomprimir los ficheros @code{.xz} y @code{.lzma}. Otros posibles valores son @code{FORMAT_XZ}, @code{FORMAT_ALONE}, y @code{FORMAT_RAW}.

El argumento `memlimit' especifica un límite (en bytes) en la cantidad de memoria que el descompresor puede utilizar. Cuando este argumento es utilizado, la descompresión fallará con un @ref{2987,,LZMAError} si no es posible descomprimir la entrada dentro del límite de memoria dado.

El argumento `filters' especifica la cadena de filtro que fue utilizado para crear el flujo que se descomprime. El argumento es requerido si `format' es @code{FORMAT_RAW}, pero no debería ser utilizado para otros formatos. Vea @ref{298f,,Especificando cadenas de filtro personalizadas} para más información sobre cadenas de filtro.

@cartouche
@quotation Nota 
Esta clase no maneja transparentemente entradas que contienen múltiples flujos comprimidos, a diferencia de @ref{2992,,decompress()} y @ref{1088,,LZMAFile}. Para descomprimir una entrada multi-flujo con @ref{1762,,LZMADecompressor}, debería crear un nuevo descompresor para cada flujo.
@end quotation
@end cartouche

@geindex decompress() (método de lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor decompress}@anchor{eb3}
@deffn {Método} decompress (data, max_length=-1)

Descomprime `data' (un @ref{db4,,bytes-like object}), retornando información sin comprimir como bytes. Alguna `data' puede ser almacenada internamente, para uso en llamadas posteriores a @ref{2992,,decompress()}. La información retornada debería ser concatenada con la salida de cualquier llamada anterior a @ref{2992,,decompress()}.

Si `max_length' no es negativo, retorna al menos `max_length' bytes para descomprimir información, Si este límite es alcanzado y salidas adicionales pueden ser producidas, el atributo @ref{2993,,needs_input} será establecido a @code{False}. En este caso, la siguiente llamada a @ref{eb3,,decompress()} podría proveer `data' como @code{"b'@w{'}} para obtener más de la salida.

Si toda la información ingresada fue descomprimida y retornada (ya sea porque esto fue menos que `max_length' bytes, o porque `max_length' fue negativo), el atributo @ref{2993,,needs_input} será establecido a @code{True}.

Attempting to decompress data after the end of stream is reached
raises an @ref{1341,,EOFError}.  Any data found after the end of the
stream is ignored and saved in the @ref{2994,,unused_data} attribute.


Distinto en la versión 3.5: Agregado el parámetro `max_length'.

@end deffn

@geindex check (atributo de lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor check}@anchor{2995}
@deffn {Atributo} check

El ID del chequeo de integridad utilizado por el flujo de entrada. Esto puede ser @code{CHECK_UNKNOWN} hasta que suficiente de la entrada ha sido decodificada para determinar qué chequeo de integridad utiliza.
@end deffn

@geindex eof (atributo de lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor eof}@anchor{2996}
@deffn {Atributo} eof

@code{True} si el marcador de fin-de-flujo ha sido alcanzado.
@end deffn

@geindex unused_data (atributo de lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor unused_data}@anchor{2994}
@deffn {Atributo} unused_data

Información encontrada después del fin del flujo comprimido.

Antes de que el fin del flujo es alcanzado, este será @code{"b"}.
@end deffn

@geindex needs_input (atributo de lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor needs_input}@anchor{2993}
@deffn {Atributo} needs_input

@code{False} si el método @ref{eb3,,decompress()} puede proveer más información descomprimida antes de requerir nueva entrada descomprimida.


Added in version 3.5.

@end deffn
@end deffn

@geindex compress() (en el módulo lzma)
@anchor{library/lzma lzma compress}@anchor{298e}
@deffn {Función} lzma.compress (data, format=FORMAT_XZ, check=-1, preset=None, filters=None)

Comprime `data' (un objeto @ref{325,,bytes}), retornando la información comprimida como un objeto @ref{325,,bytes}.

Vea @ref{1764,,LZMACompressor} arriba para una descripción de los argumentos `format', `check', `preset' y `filters'.
@end deffn

@geindex decompress() (en el módulo lzma)
@anchor{library/lzma lzma decompress}@anchor{2992}
@deffn {Función} lzma.decompress (data, format=FORMAT_AUTO, memlimit=None, filters=None)

Descomprime `data' (un objeto @ref{325,,bytes}), retornando la información descomprimida como un objeto @ref{325,,bytes}.

Si `data' es la concatenación de múltiples flujos comprimidos distintos, descomprime todos esos flujos, y retorna la concatenación de los resultados.

Vea @ref{1762,,LZMADecompressor} arriba para una descripción de los argumentos `format', `memlimit' y `filters'.
@end deffn

@node Misceláneas,Especificando cadenas de filtro personalizadas,Comprimiendo y descomprimiendo datos en memoria,lzma — Compression using the LZMA algorithm
@anchor{library/lzma miscellaneous}@anchor{2997}
@subsubsection Misceláneas


@geindex is_check_supported() (en el módulo lzma)
@anchor{library/lzma lzma is_check_supported}@anchor{2998}
@deffn {Función} lzma.is_check_supported (check)

Retorna @code{True} si el chequeo de integridad dado es soportado en este sistema.

@code{CHECK_NONE} y @code{CHECK_CRC32} son soportados siempre. @code{CHECK_CRC64} y @code{CHECK_SHA256} pueden no estar disponibles si está utilizando una versión de @code{liblzma} que fue compilada con un conjunto de funciones limitado.
@end deffn

@node Especificando cadenas de filtro personalizadas,Ejemplos<7>,Misceláneas,lzma — Compression using the LZMA algorithm
@anchor{library/lzma filter-chain-specs}@anchor{298f}@anchor{library/lzma specifying-custom-filter-chains}@anchor{2999}
@subsubsection Especificando cadenas de filtro personalizadas


Un especificador de cadena de filtro es una secuencia de diccionarios, donde cada diccionario contiene el ID y opciones para un único filtro. Cada diccionario debe contener la llave @code{"id"}, y puede contener llaves adicionales para especificar opciones filtro-dependientes. Los ID de filtro válidos son como sigue:


@itemize *

@item 
Filtro de compresión:


@itemize *

@item 
@code{FILTER_LZMA1} (para uso con @code{FORMAT_ALONE})

@item 
@code{FILTER_LZMA2} (para uso con @code{FORMAT_XZ} y @code{bytesFORMAT_RAW})
@end itemize

@item 
Filtro delta:


@itemize *

@item 
@code{FILTER_DELTA}
@end itemize

@item 
Filtros `Branch-Call-Jump (BCJ)':


@itemize *

@item 
@code{FILTER_X86}

@item 
@code{FILTER_IA64}

@item 
@code{FILTER_ARM}

@item 
@code{FILTER_ARMTHUMB}

@item 
@code{FILTER_POWERPC}

@item 
@code{FILTER_SPARC}
@end itemize
@end itemize

Una cadena de filtro puede consistir de hasta 4 filtros, y no puede estar vacía. El último filtro en la cadena debe ser un filtro de compresión, y cualquier otro filtro debe ser un filtro delta o BCJ.

Los filtros de compresión soportan las siguientes opciones (especificadas como entradas adicionales:


@itemize *

@item 
@code{preset}: Un ajuste de compresión a utilizar como una fuente de valores por defecto para opciones que no están especificadas explícitamente.

@item 
@code{dict_size}: Tamaño del diccionario en bytes. Esto debería estar entre 4 kiB y 1.5 GiB (inclusive).

@item 
@code{lc} Número de bits de contexto literal.

@item 
@code{lp}: Número de bits de posición literal. La suma @code{lc + lp} debe ser al menos 4.

@item 
@code{pb}: Número de bits de posición; debe ser al menos 4.

@item 
@code{mode}: @code{MODE_FAST} o @code{MODE_NORMAL}.

@item 
@code{nice_len}: Lo que debería ser considerado una «buena longitud» para una coincidencia. Esto debería ser 273 o menos.

@item 
@code{mf}: Qué buscador de coincidencias utilizar – @code{MF_HC3}, @code{MF_HC4}. @code{MF_BT2}, @code{MF_BT3}, o @code{MF_BT4}.

@item 
@code{depth}: Profundidad de búsqueda máxima utilizada por el buscador de coincidencias. 0 (por defecto) significa seleccionar automáticamente basado en otras opciones de filtro.
@end itemize

El filtro delta almacena las diferencias entre bytes, produciendo más entrada repetitiva para el compresor en ciertas circunstancias. Soporta una opción, @code{dist}. Esto indica la distancia entre bytes a ser sustraída. Por defecto es 1, por ejemplo toma las diferencias entre bytes adyacentes.

Los filtros BCJ están destinados a ser aplicados a código máquina. Convierten ramas, llamadas y saltos relativos en el código para utilizar el direccionamiento absoluto, con el objetivo de incrementar la redundancia que puede ser explotada por el compresor. Estos filtros soportan una opción, @code{start_offset}. Esto especifica la dirección que debería ser mapeada al comienzo de la entrada de información. Por defecto es 0.

@node Ejemplos<7>,,Especificando cadenas de filtro personalizadas,lzma — Compression using the LZMA algorithm
@anchor{library/lzma examples}@anchor{299a}
@subsubsection Ejemplos


Leyendo un fichero comprimido:

@example
import lzma
with lzma.open("file.xz") as f:
    file_content = f.read()
@end example

Creando un fichero comprimido:

@example
import lzma
data = b"Insert Data Here"
with lzma.open("file.xz", "w") as f:
    f.write(data)
@end example

Comprimiendo información en memoria:

@example
import lzma
data_in = b"Insert Data Here"
data_out = lzma.compress(data_in)
@end example

Compresión incremental:

@example
import lzma
lzc = lzma.LZMACompressor()
out1 = lzc.compress(b"Some data\n")
out2 = lzc.compress(b"Another piece of data\n")
out3 = lzc.compress(b"Even more data\n")
out4 = lzc.flush()
# Concatenate all the partial results:
result = b"".join([out1, out2, out3, out4])
@end example

Escribiendo información comprimida en fichero ya abierto:

@example
import lzma
with open("file.xz", "wb") as f:
    f.write(b"This data will not be compressed\n")
    with lzma.open(f, "w") as lzf:
        lzf.write(b"This *will* be compressed\n")
    f.write(b"Not compressed\n")
@end example

Creando un fichero comprimido utilizando una cadena de filtro personalizada:

@example
import lzma
my_filters = [
    @{"id": lzma.FILTER_DELTA, "dist": 5@},
    @{"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME@},
]
with lzma.open("file.xz", "w", filters=my_filters) as f:
    f.write(b"blah blah blah")
@end example

@node zipfile — Work with ZIP archives,tarfile — Read and write tar archive files,lzma — Compression using the LZMA algorithm,Compresión de datos y archivado
@anchor{library/zipfile doc}@anchor{299b}@anchor{library/zipfile module-zipfile}@anchor{130}@anchor{library/zipfile zipfile-work-with-zip-archives}@anchor{299c}
@subsection @code{zipfile} — Work with ZIP archives


@geindex module; zipfile

`Código fuente:' Lib/zipfile/@footnote{https://github.com/python/cpython/tree/main/Lib/zipfile/}


__________________________________________________________________


El formato de archivo ZIP es un estándar común de archivo y compresión. Este módulo proporciona herramientas para crear, leer, escribir, agregar y listar un archivo ZIP. Cualquier uso avanzado de este módulo requerirá una comprensión del formato, tal como se define en la PKZIP Application Note@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}.

Actualmente, este módulo no maneja archivos ZIP multi-disco. Puede manejar archivos ZIP que usan las extensiones ZIP64 (es decir, archivos ZIP que tienen más de 4 GB de tamaño). Admite el descifrado de archivos cifrados en archivos ZIP, pero actualmente no puede crear un archivo cifrado. El descifrado es extremadamente lento ya que se implementa en Python nativo en lugar de C.

El módulo define los siguientes elementos:

@geindex BadZipFile
@anchor{library/zipfile zipfile BadZipFile}@anchor{17e5}
@deffn {Excepción} zipfile.BadZipFile

El error lanzado para archivos ZIP incorrectos.


Added in version 3.2.

@end deffn

@geindex BadZipfile
@anchor{library/zipfile zipfile BadZipfile}@anchor{299d}
@deffn {Excepción} zipfile.BadZipfile

Alias de @ref{17e5,,BadZipFile}, para compatibilidad con versiones anteriores de Python.


Obsoleto desde la versión 3.2.

@end deffn

@geindex LargeZipFile
@anchor{library/zipfile zipfile LargeZipFile}@anchor{299e}
@deffn {Excepción} zipfile.LargeZipFile

El error lanzado cuando un archivo ZIP requiera la funcionalidad ZIP64 pero no ha sido habilitado.
@end deffn


@deffn {Clase} zipfile.ZipFile

La clase para leer y escribir archivos ZIP. Vea la sección @ref{299f,,Objetos ZipFile} para detalles del constructor.
@end deffn


@deffn {Clase} zipfile.Path

Clase que implementa un subconjunto de la interfaz proporcionada por @ref{19b,,pathlib.Path}, incluyendo la interfaz completa @ref{219,,importlib.resources.abc.Traversable}.


Added in version 3.8.

@end deffn


@deffn {Clase} zipfile.PyZipFile

Clase para crear archivos ZIP que contienen bibliotecas de Python.
@end deffn

@geindex ZipInfo (clase en zipfile)
@anchor{library/zipfile zipfile ZipInfo}@anchor{d91}
@deffn {Clase} zipfile.ZipInfo (filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))

Clase utilizada para representar información sobre un miembro de un archivo. Las instancias de esta clase son retornadas por los métodos @ref{29a0,,getinfo()} y @ref{29a1,,infolist()} de objetos @ref{765,,ZipFile}. La mayoría de los usuarios del módulo @ref{130,,zipfile} no necesitarán crearlos, sino que solo usarán aquellos creados por este módulo. `filename' debe ser el nombre completo del miembro del archivo, y `date_time' debe ser una tupla que contenga seis campos que describan la hora de la última modificación del archivo; los campos se describen en la sección @ref{29a2,,Objetos ZipInfo}.


Distinto en la versión 3.13: A public @code{compress_level} attribute has been added to expose the
formerly protected @code{_compresslevel}.  The older protected name
continues to work as a property for backwards compatibility.

@end deffn

@geindex is_zipfile() (en el módulo zipfile)
@anchor{library/zipfile zipfile is_zipfile}@anchor{1392}
@deffn {Función} zipfile.is_zipfile (filename)

Retorna @code{True} si `filename' es un archivo ZIP válido basado en su número mágico; de lo contrario, retorna @code{False}. `filename' también puede ser un archivo o un objeto similar a un archivo.


Distinto en la versión 3.1: Soporte para archivos y objetos similares a archivos.

@end deffn

@geindex ZIP_STORED (en el módulo zipfile)
@anchor{library/zipfile zipfile ZIP_STORED}@anchor{29a3}
@deffn {Dato} zipfile.ZIP_STORED

La constante numérica para un miembro de archivo sin comprimir.
@end deffn

@geindex ZIP_DEFLATED (en el módulo zipfile)
@anchor{library/zipfile zipfile ZIP_DEFLATED}@anchor{29a4}
@deffn {Dato} zipfile.ZIP_DEFLATED

La constante numérica para el método de compresión ZIP habitual. Esto requiere el módulo @ref{132,,zlib}.
@end deffn

@geindex ZIP_BZIP2 (en el módulo zipfile)
@anchor{library/zipfile zipfile ZIP_BZIP2}@anchor{29a5}
@deffn {Dato} zipfile.ZIP_BZIP2

La constante numérica para el método de compresión BZIP2. Esto requiere el módulo @ref{14,,bz2}.


Added in version 3.3.

@end deffn

@geindex ZIP_LZMA (en el módulo zipfile)
@anchor{library/zipfile zipfile ZIP_LZMA}@anchor{29a6}
@deffn {Dato} zipfile.ZIP_LZMA

La constante numérica para el método de compresión LZMA. Esto requiere el módulo @ref{8a,,lzma}.


Added in version 3.3.


@cartouche
@quotation Nota 
La especificación del formato del archivo ZIP ha incluido soporte para la compresión bzip2 desde 2001 y para la compresión LZMA desde 2006. Sin embargo, algunas herramientas (incluidas las versiones anteriores de Python) no admiten estos métodos de compresión y pueden negarse a procesar el archivo ZIP por completo o no puede extraer archivos individuales.
@end quotation
@end cartouche
@end deffn


@subsubheading Ver también



@table @asis

@item PKZIP Application Note@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

Documentación sobre el formato de archivo ZIP por Phil Katz, el creador del formato y los algoritmos utilizados.

@item Página principal de Info-ZIP@footnote{https://infozip.sourceforge.net/}

Información sobre los programas de archivo ZIP del proyecto Info-ZIP y las bibliotecas de desarrollo.
@end table


@menu
* Objetos ZipFile:: 
* Objetos de ruta:: 
* Objetos PyZipFile:: 
* Objetos ZipInfo:: 
* Interfaz de línea de comandos:: 
* Problemas de descompresión:: 

@end menu

@node Objetos ZipFile,Objetos de ruta,,zipfile — Work with ZIP archives
@anchor{library/zipfile id1}@anchor{29a7}@anchor{library/zipfile zipfile-objects}@anchor{299f}
@subsubsection Objetos ZipFile


@geindex ZipFile (clase en zipfile)
@anchor{library/zipfile zipfile ZipFile}@anchor{765}
@deffn {Clase} zipfile.ZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True, metadata_encoding=None)

Abra un archivo ZIP, donde `file' puede ser una ruta a un archivo (una cadena), un objeto similar a un archivo o un @ref{3f0,,path-like object}.

El parámetro `mode' debe ser @code{'r'} para leer un archivo existente, @code{'w'} para truncar y escribir un nuevo archivo, @code{'a'} para agregarlo a un archivo existente, o @code{'x'} para crear y escribir exclusivamente un nuevo archivo. Si `mode' es @code{'x'} y `file' se refiere a un archivo existente, se lanzará un @ref{109c,,FileExistsError}. Si `mode' es @code{'a'} y `file' se refiere a un archivo ZIP existente, entonces se le agregan archivos adicionales. Si `file' no se refiere a un archivo ZIP, se agrega un nuevo archivo ZIP al archivo. Esto está destinado a agregar un archivo ZIP a otro archivo (como @code{python.exe}). Si `mode' es @code{'a'} y el archivo no existe en absoluto, se crea. Si `mode' es @code{'r'} o @code{'a'}, el archivo debe poder buscarse.

`compression' es el método de compresión ZIP que se utiliza al escribir el archivo, y debe ser @ref{29a3,,ZIP_STORED}, @ref{29a4,,ZIP_DEFLATED}, @ref{29a5,,ZIP_BZIP2} o @ref{29a6,,ZIP_LZMA}; los valores no reconocidos harán que se lance @ref{384,,NotImplementedError}. Si @ref{29a4,,ZIP_DEFLATED}, @ref{29a5,,ZIP_BZIP2} o @ref{29a6,,ZIP_LZMA} se especifica pero el módulo correspondiente (@ref{132,,zlib}, @ref{14,,bz2} o @ref{8a,,lzma}) no está disponible, @ref{1e5,,RuntimeError} es lanzado. El valor predeterminado es @ref{29a3,,ZIP_STORED}.

Si `allowZip64' es @code{True} (el valor predeterminado) zipfile creará archivos ZIP que usan las extensiones ZIP64 cuando el archivo zip es mayor que 4 GB. Si es @code{False} @ref{130,,zipfile} lanzará una excepción cuando el archivo ZIP requiera extensiones ZIP64.

El parámetro `compresslevel' controla el nivel de compresión que se utilizará al escribir archivos en el archivo. Cuando se utiliza @ref{29a3,,ZIP_STORED} o @ref{29a6,,ZIP_LZMA} no tiene ningún efecto. Cuando se usa @ref{29a4,,ZIP_DEFLATED} se aceptan los enteros @code{0} a @code{9} (ver @ref{294f,,zlib} para más información). Cuando se utiliza @ref{29a5,,ZIP_BZIP2} se aceptan enteros @code{1} a @code{9} (consulte @ref{8fd,,bz2} para obtener más información).

El argumento `strictly_timestamps', cuando se establece en @code{False}, permite comprimir archivos anteriores a 1980-01-01 a costa de establecer la marca de tiempo en 1980-01-01. Un comportamiento similar ocurre con archivos más nuevos que 2107-12-31, la marca de tiempo también se establece en el límite.

Cuando el parámetro `mode' es @code{'r'}, el `metadata_encoding' podría ser asignado al nombre del codec, el cual será usado para decodificar metadata como los nombres de los miembros y comentarios ZIP.

Si el archivo se crea con el modo @code{'w'}, @code{'x'} o @code{'a'} y luego @ref{29a8,,closed} sin agregar ningún archivo al archivo, Las estructuras ZIP apropiadas para un archivo vacío se escribirán en el archivo.

ZipFile también es un manejador de contexto y por lo tanto, admite la declaración @ref{673,,with}. En el ejemplo, `myzip' se cierra después que el conjunto de instrucciones @code{with} se termine—incluso si se produce una excepción:

@example
with ZipFile('spam.zip', 'w') as myzip:
    myzip.write('eggs.txt')
@end example

@cartouche
@quotation Nota 
`metadata_encoding' es una configuración que se aplica a todas las instancias de ZipFile. Actualmente no es posible establecerlo individualmente para cada miembro.

Este atributo es una solución alterna para implementaciones heredadas que producen archivos con nombres basados en la codificación regional o la página de códigos actual (con mayor frecuencia en Windows). De acuerdo con el estándar .ZIP, la codificación de la metadata podría ser especificada por la página de códigos de IBM (por defecto) or por UTF-8 mediante un flag en la cabecera. Este flag toma precedencia sobre `metadata_encoding', el cual es una extensión específica a Python.
@end quotation
@end cartouche


Distinto en la versión 3.2: Se agregó la capacidad de usar @ref{765,,ZipFile} como administrador de contexto.



Distinto en la versión 3.3: Soporte agregado para @ref{14,,bzip2} y compresión @ref{8a,,lzma}.



Distinto en la versión 3.4: Las extensiones ZIP64 están habilitadas por defecto.



Distinto en la versión 3.5: Se agregó soporte para escribir en secuencias que no se pueden buscar. Se agregó soporte para el modo @code{'x'}.



Distinto en la versión 3.6: Anteriormente, se generó un simple @ref{1e5,,RuntimeError} para valores de compresión no reconocidos.



Distinto en la versión 3.6.2: El parámetro `file' acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.7: Agregue el parámetro `compresslevel'.



Distinto en la versión 3.8: The `strict_timestamps' keyword-only parameter.



Distinto en la versión 3.11: Se ha añadido soporte para especificar la codificación del nombre del miembro para leer metadatos en las cabeceras de directorio y archivo del archivo zip.

@end deffn

@geindex close() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile close}@anchor{29a8}
@deffn {Método} ZipFile.close ()

Cierra el archivo. Debe llamar a @ref{29a8,,close()} antes de salir de su programa o no se escribirán registros esenciales.
@end deffn

@geindex getinfo() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile getinfo}@anchor{29a0}
@deffn {Método} ZipFile.getinfo (name)

Retorna un objeto @ref{d91,,ZipInfo} con información sobre el miembro del archivo `name'. Llamando a @ref{29a0,,getinfo()} para obtener un nombre que no figura actualmente en el archivo lanzará un @ref{438,,KeyError}.
@end deffn

@geindex infolist() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile infolist}@anchor{29a1}
@deffn {Método} ZipFile.infolist ()

Retorna una lista que contiene un objeto @ref{d91,,ZipInfo} para cada miembro del archivo. Los objetos están en el mismo orden que sus entradas en el archivo ZIP real en el disco si se abrió un archivo existente.
@end deffn

@geindex namelist() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile namelist}@anchor{29a9}
@deffn {Método} ZipFile.namelist ()

Retorna una lista de miembros del archivo por nombre.
@end deffn

@geindex open() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile open}@anchor{4d9}
@deffn {Método} ZipFile.open (name, mode='r', pwd=None, *, force_zip64=False)

Acceda a un miembro del archivo comprimido como un objeto binario similar a un archivo. `name' puede ser el nombre de un archivo dentro del archivo comprimido o un objeto @ref{d91,,ZipInfo}. El parámetro `mode', si está incluido, debe ser @code{'r'} (el valor predeterminado) o @code{'w'}. `pwd' es la contraseña utilizada para descifrar archivos ZIP encriptados como un objeto @ref{325,,bytes}.

@ref{4d9,,open()} también es un administrador de contexto y por lo tanto, soporta @ref{673,,with} @code{statement}:

@example
with ZipFile('spam.zip') as myzip:
    with myzip.open('eggs.txt') as myfile:
        print(myfile.read())
@end example

Con `mode' @code{'r'}, el objeto tipo archivo (@code{ZipExtFile}) es de solo lectura y proporciona los siguientes métodos: @ref{1390,,read()}, @ref{1391,,readline()}, @ref{2336,,readlines()}, @ref{12f9,,seek()}, @ref{29aa,,tell()}, @ref{1cc8,,__iter__()}, @code{__ next__()}. Estos objetos pueden funcionar independientemente del archivo Zip.

Con @code{mode = 'w'}, se retorna un controlador de archivo escribible, que admite el método @ref{d62,,write()}. Mientras está abierto un identificador de archivo escribible, intentar leer o escribir otros archivos en el archivo ZIP lanzará un @ref{360,,ValueError}.

In both cases the file-like object has also attributes @code{name},
which is equivalent to the name of a file within the archive, and
@code{mode}, which is @code{'rb'} or @code{'wb'} depending on the input mode.

Al escribir un archivo, si el tamaño del archivo no se conoce de antemano pero puede exceder los 2 GB, pase @code{force_zip64 = True} para asegurarse de que el formato del encabezado sea capaz de admitir archivos grandes. Si el tamaño del archivo se conoce de antemano, construya un objeto @ref{d91,,ZipInfo} con @ref{29ab,,file_size} establecido, y úselo como parámetro `name'.

@cartouche
@quotation Nota 
Los métodos @ref{4d9,,open()}, @ref{29ac,,read()} y @ref{29ad,,extract()} pueden tomar un nombre de archivo o un objeto @ref{d91,,ZipInfo}. Apreciará esto cuando intente leer un archivo ZIP que contiene miembros con nombres duplicados.
@end quotation
@end cartouche


Distinto en la versión 3.6: Se eliminó el soporte de @code{mode='U'}. Use @ref{854,,io.TextIOWrapper} para leer archivos de texto comprimido en modo @ref{dc1,,universal newlines}.



Distinto en la versión 3.6: @ref{4d9,,ZipFile.open()} ahora se puede usar para escribir archivos en el archivo comprimido con la opción @code{mode='w'}.



Distinto en la versión 3.6: Llamar a @ref{4d9,,open()} en un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.



Distinto en la versión 3.13: Added attributes @code{name} and @code{mode} for the writeable
file-like object.
The value of the @code{mode} attribute for the readable file-like
object was changed from @code{'r'} to @code{'rb'}.

@end deffn

@geindex extract() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile extract}@anchor{29ad}
@deffn {Método} ZipFile.extract (member, path=None, pwd=None)

Extraer un miembro del archivo comprimido al directorio de trabajo actual; `member' debe ser su nombre completo o un objeto @ref{d91,,ZipInfo}. La información de su archivo se extrae con la mayor precisión posible. `path' especifica un directorio diferente para extraer. `member' puede ser un nombre de archivo o un objeto @ref{d91,,ZipInfo}. `pwd' es la contraseña utilizada para archivos encriptados como un objeto @ref{325,,bytes}.

Retorna la ruta normalizada creada (un directorio o archivo nuevo).

@cartouche
@quotation Nota 
Si el nombre de archivo de un miembro es una ruta absoluta, se eliminarán un punto compartido de @code{drive/UNC} y las barras diagonales (hacia atrás), ej: @code{///foo/bar} se convierte en @code{foo/bar} en Unix y @code{C:\foo\bar} se convierte en @code{foo\bar} en Windows. Y todos los componentes @code{".."} en un nombre de archivo miembro se eliminarán, ej: @code{../../foo../../ba..r} se convierte en @code{foo../ba..r}. En Windows, los caracteres ilegales (@code{:}, @code{<}, @code{>}, @code{|}, @code{"}, @code{?} Y @code{*}) se reemplazan por guion bajo (@code{_}).
@end quotation
@end cartouche


Distinto en la versión 3.6: Llamando @ref{29ad,,extract()} en un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.



Distinto en la versión 3.6.2: El parámetro `path' acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex extractall() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile extractall}@anchor{29ae}
@deffn {Método} ZipFile.extractall (path=None, members=None, pwd=None)

Extrae todos los miembros del archivo comprimido al directorio de trabajo actual. `path' especifica un directorio diferente para extraer. `members' es opcional y debe ser un subconjunto de la lista devuelta por @ref{29a9,,namelist()}. `pwd' es la contraseña utilizada para archivos encriptados como un objeto @ref{325,,bytes}.

@cartouche
@quotation Advertencia 
Nunca extraiga archivos de fuentes no confiables sin inspección previa. Es posible que los archivos se creen fuera de `path', ej. miembros que tienen nombres de archivo absolutos que comienzan con @code{"/"} o nombres de archivo con dos puntos @code{".."}. Este módulo intenta evitar eso. Ver @ref{29ad,,extract()} nota.
@end quotation
@end cartouche


Distinto en la versión 3.6: Llamar a @ref{29ae,,extractall()} en un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.



Distinto en la versión 3.6.2: El parámetro `path' acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex printdir() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile printdir}@anchor{29af}
@deffn {Método} ZipFile.printdir ()

Imprime una tabla de contenido para el archivo en @code{sys.stdout}.
@end deffn

@geindex setpassword() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile setpassword}@anchor{29b0}
@deffn {Método} ZipFile.setpassword (pwd)

Establece `pwd' (un objeto @ref{325,,bytes}) como contraseña predeterminada para  extraer archivos encriptados.
@end deffn

@geindex read() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile read}@anchor{29ac}
@deffn {Método} ZipFile.read (name, pwd=None)

Retorna los bytes del archivo `name' en el archivo comprimido. `name' es el nombre del archivo en el archivo comprimido, o un objeto @ref{d91,,ZipInfo}. El archivo comprimido debe estar abierto para lectura o añadidura. `pwd' es la contraseña utilizada para los archivos encriptados como un objeto @ref{325,,bytes} y, si se especifica, anula la contraseña predeterminada establecida con @ref{29b0,,setpassword()}. Llamar a @ref{29ac,,read()} en un ZipFile que utiliza un método de compresión que no sea @ref{29a3,,ZIP_STORED}, @ref{29a4,,ZIP_DEFLATED}, @ref{29a5,,ZIP_BZIP2} o @ref{29a6,,ZIP_LZMA} lanzará un @ref{384,,NotImplementedError}. También se lanzará un error si el módulo de compresión correspondiente no está disponible.


Distinto en la versión 3.6: Llamando @ref{29ac,,read()} en un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.

@end deffn

@geindex testzip() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile testzip}@anchor{29b1}
@deffn {Método} ZipFile.testzip ()

Lee todos los archivos en el archivo y verifica sus CRC y encabezados de archivo. Retorna el nombre del primer archivo incorrecto o retorna @code{None}.


Distinto en la versión 3.6: Llamar a @ref{29b1,,testzip()} en un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.

@end deffn

@geindex write() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile write}@anchor{dd3}
@deffn {Método} ZipFile.write (filename, arcname=None, compress_type=None, compresslevel=None)

Escribe el archivo llamado `filename' en el archivo, dándole el nombre de archivo `arcname' (por defecto, será el mismo que `filename', pero sin una letra de unidad y con los separadores de ruta principales eliminados). Si se proporciona, `compress_type' anula el valor dado para el parámetro `compression' al constructor para la nueva entrada. Del mismo modo, `compresslevel' anulará el constructor si se proporciona. El archivo debe estar abierto con el modo @code{'w'}, @code{'x'} o @code{'a'}.

@cartouche
@quotation Nota 
Históricamente, el estándar del archivo ZIP no especificaba una codificación para la metadata, pero si era fuertemente recomendado usar CP437(la codificación original de IBM PC) con fines de interoperabilidad. Versiones recientes permiten el uso de UTF-8 (exclusivamente). En éste modulo, UTF-8 será usada automáticamente para escribir los nombres de los miembros si es que estos contienen algún caracter no-ASCII. No es posible escribir nombres de miembros en otra codificación que no sea ASCII o UTF-8.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Los nombres de archivo deben ser relativos a la raíz del archivo, es decir, no deben comenzar con un separador de ruta.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Si @code{arcname} (o @code{filename}, si @code{arcname} no se proporciona) contiene un byte nulo, el nombre del archivo en el archivo se truncará en el byte nulo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Un barra al frente en el nombre del archivo puede hacer que el archivo sea imposible de abrir en algunos programas zip en sistemas Windows.
@end quotation
@end cartouche


Distinto en la versión 3.6: Llamando @ref{dd3,,write()} en un ZipFile creado con el modo @code{'r'} o un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.

@end deffn

@geindex writestr() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile writestr}@anchor{29b2}
@deffn {Método} ZipFile.writestr (zinfo_or_arcname, data, compress_type=None, compresslevel=None)

Escribe un registro en el archivo. El contenido es `data', que puede ser una instancia de @ref{237,,str} o a @ref{325,,bytes}; si es una @ref{237,,str}, primero se codifica como UTF-8. `zinfo_or_arcname' es el nombre del archivo que se le dará en el archivo o una instancia de @ref{d91,,ZipInfo}. Si se trata de una instancia, se debe proporcionar al menos el nombre de archivo, la fecha y la hora. Si es un nombre, la fecha y la hora se configuran en la fecha y hora actuales. El archivo debe abrirse con el modo @code{'w'}, @code{'x'} o @code{'a'}.

Si se proporciona, `compress_type' anula el valor dado para el parámetro `compression' al constructor para la nueva entrada, o en `zinfo_or_arcname' (si es una instancia de @ref{d91,,ZipInfo}). Del mismo modo, `compresslevel' anulará el constructor si se proporciona.

@cartouche
@quotation Nota 
Al pasar una instancia de @ref{d91,,ZipInfo} como el parámetro `zinfo_or_arcname', el método de compresión utilizado será el especificado en el miembro `compress_type' de la instancia dada @ref{d91,,ZipInfo}. Por defecto, el constructor @ref{d91,,ZipInfo} establece este miembro en @ref{29a3,,ZIP_STORED}.
@end quotation
@end cartouche


Distinto en la versión 3.2: El argumento `compress_type'.



Distinto en la versión 3.6: Llamando @ref{29b2,,writestr()} en un ZipFile creado con el modo @code{'r'} o un ZipFile cerrado lanzará un @ref{360,,ValueError}. Anteriormente, se planteó a @ref{1e5,,RuntimeError}.

@end deffn

@geindex mkdir() (método de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile mkdir}@anchor{766}
@deffn {Método} ZipFile.mkdir (zinfo_or_directory, mode=511)

Crea un directorio dentro del archivo. Si `zinfo_or_directory' es un string, el directorio es creado dentro del archivo con el modo especificado en el argumento `mode'. Si del contrario, `zinfo_or_directory' es una instancia de @ref{d91,,ZipInfo} entonces el argumento `mode' es ignorado.

El archivo debe estar abierto en modo @code{'w'}, @code{'x'} o @code{'a'}.


Added in version 3.11.

@end deffn

Los siguientes atributos de datos también están disponibles:

@geindex filename (atributo de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile filename}@anchor{29b3}
@deffn {Atributo} ZipFile.filename

Nombre del archivo ZIP.
@end deffn

@geindex debug (atributo de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile debug}@anchor{29b4}
@deffn {Atributo} ZipFile.debug

El nivel de salida de depuración a usar. Esto se puede configurar de @code{0} (el valor predeterminado, sin salida) a @code{3} (la mayor cantidad de salida). La información de depuración se escribe en @code{sys.stdout}.
@end deffn

@geindex comment (atributo de zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile comment}@anchor{29b5}
@deffn {Atributo} ZipFile.comment

El comentario asociado con el archivo ZIP como un objeto @ref{325,,bytes}. Si se asigna un comentario a una instancia de @ref{765,,ZipFile} creada con el modo @code{'w'}, @code{'x'} o @code{'a'}, no debe tener más de 65535 bytes. Los comentarios más largos que esto se truncarán.
@end deffn

@node Objetos de ruta,Objetos PyZipFile,Objetos ZipFile,zipfile — Work with ZIP archives
@anchor{library/zipfile id2}@anchor{29b6}@anchor{library/zipfile path-objects}@anchor{29b7}
@subsubsection Objetos de ruta


@geindex Path (clase en zipfile)
@anchor{library/zipfile zipfile Path}@anchor{76a}
@deffn {Clase} zipfile.Path (root, at='@w{'})

Construye un objeto Path a partir de un archivo zip @code{root} (que puede ser una instancia @ref{765,,ZipFile} o @code{file} adecuado para pasar al constructor @ref{765,,ZipFile}).

@code{at} especifica la ubicación de esta ruta dentro del archivo zip, ej. “dir/file.txt”, “dir/” o “”.El valor predeterminado es la cadena vacía, que indica la raíz.
@end deffn

Los objetos de ruta exponen las siguientes características de objetos @ref{19b,,pathlib.Path}:

Los objetos de ruta son transitables utilizando el operador @code{/} o utilizando @code{joinpath}.

@geindex name (atributo de zipfile.Path)
@anchor{library/zipfile zipfile Path name}@anchor{29b8}
@deffn {Atributo} Path.name

El componente final de la ruta.
@end deffn

@geindex open() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path open}@anchor{1598}
@deffn {Método} Path.open (mode='r', *, pwd, **)

Invoca @ref{4d9,,ZipFile.open()} en la ruta actual. Permite la apertura para lectura o escritura, texto o binario a través de los modos admitidos: “r”, “w”, “rb”, “wb”. Los argumentos posicionales y de palabras clave se pasan a través de @ref{854,,io.TextIOWrapper} cuando se abren como texto y se ignoran en caso contrario. @code{pwd} es el parámetro @code{pwd} para @ref{4d9,,ZipFile.open()}.


Distinto en la versión 3.9: Se agregó soporte para modos de texto y binarios para abrir. El modo predeterminado ahora es texto.



Distinto en la versión 3.11.2: El parámetro @code{encoding} puede proporcionarse como un argumento posicional sin causar un @ref{228,,TypeError}. Tal y como podía ocurrir en la versión 3.9. El código que necesite ser compatible con versiones no parcheadas 3.10 y 3.11 debe pasar como palabras clave todos los argumentos de @ref{854,,io.TextIOWrapper}, incluido @code{encoding}.

@end deffn

@geindex iterdir() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path iterdir}@anchor{29b9}
@deffn {Método} Path.iterdir ()

Enumera los hijos del directorio actual.
@end deffn

@geindex is_dir() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path is_dir}@anchor{29ba}
@deffn {Método} Path.is_dir ()

Retorna @code{True} si el contexto actual hace referencia a un directorio.
@end deffn

@geindex is_file() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path is_file}@anchor{29bb}
@deffn {Método} Path.is_file ()

Retorna @code{True} si el contexto actual hace referencia a un archivo.
@end deffn

@geindex is_symlink() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path is_symlink}@anchor{29bc}
@deffn {Método} Path.is_symlink ()

Return @code{True} if the current context references a symbolic link.


Added in version 3.12.



Distinto en la versión 3.13: Previously, @code{is_symlink} would unconditionally return @code{False}.

@end deffn

@geindex exists() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path exists}@anchor{29bd}
@deffn {Método} Path.exists ()

Retorna @code{True} si el contexto actual hace referencia a un archivo o directorio en el archivo zip.
@end deffn

@geindex Path.suffix (en el módulo zipfile)
@anchor{library/zipfile zipfile Path suffix}@anchor{768}
@deffn {Dato} Path.suffix

The last dot-separated portion of the final component, if any.
This is commonly called the file extension.


Added in version 3.11: Propiedad agregada @ref{768,,Path.suffix}.

@end deffn

@geindex Path.stem (en el módulo zipfile)
@anchor{library/zipfile zipfile Path stem}@anchor{767}
@deffn {Dato} Path.stem

El componente final de la ruta, sin su sufijo.


Added in version 3.11: Propiedad agregada @ref{767,,Path.stem}.

@end deffn

@geindex Path.suffixes (en el módulo zipfile)
@anchor{library/zipfile zipfile Path suffixes}@anchor{769}
@deffn {Dato} Path.suffixes

A list of the path’s suffixes, commonly called file extensions.


Added in version 3.11: Propiedad agregada @ref{769,,Path.suffixes}.

@end deffn

@geindex read_text() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path read_text}@anchor{1776}
@deffn {Método} Path.read_text (*, **)

Lee el archivo actual como texto unicode. Los argumentos posicionales y de palabras clave se pasan a @ref{854,,io.TextIOWrapper} (excepto @code{buffer}, que está implícito en el contexto).


Distinto en la versión 3.11.2: El parámetro @code{encoding} puede proporcionarse como un argumento posicional sin causar un @ref{228,,TypeError}. Tal y como podía ocurrir en la versión 3.9. El código que necesite ser compatible con versiones no parcheadas 3.10 y 3.11 debe pasar como palabras clave todos los argumentos de @ref{854,,io.TextIOWrapper}, incluido @code{encoding}.

@end deffn

@geindex read_bytes() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path read_bytes}@anchor{29be}
@deffn {Método} Path.read_bytes ()

Lee el archivo actual como bytes.
@end deffn

@geindex joinpath() (método de zipfile.Path)
@anchor{library/zipfile zipfile Path joinpath}@anchor{29bf}
@deffn {Método} Path.joinpath (*other)

Retorna un nuevo objeto de ruta con cada argumentos `other' unidos. Los siguientes son equivalentes:

@example
>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'
@end example


Distinto en la versión 3.10: Antes de 3.10, @code{joinpath} no estaba documentado y aceptaba exactamente un parámetro.

@end deffn

The zipp@footnote{https://pypi.org/project/zipp/} project provides backports
of the latest path object functionality to older Pythons. Use
@code{zipp.Path} in place of @code{zipfile.Path} for early access to
changes.

@node Objetos PyZipFile,Objetos ZipInfo,Objetos de ruta,zipfile — Work with ZIP archives
@anchor{library/zipfile id3}@anchor{29c0}@anchor{library/zipfile pyzipfile-objects}@anchor{29c1}
@subsubsection Objetos PyZipFile


El constructor @ref{1076,,PyZipFile} toma los mismos parámetros que el constructor @ref{765,,ZipFile}, y un parámetro adicional, `optimize'.

@geindex PyZipFile (clase en zipfile)
@anchor{library/zipfile zipfile PyZipFile}@anchor{1076}
@deffn {Clase} zipfile.PyZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)


Distinto en la versión 3.2: Added the `optimize' parameter.



Distinto en la versión 3.4: Las extensiones ZIP64 están habilitadas por defecto.


Las instancias tienen un método ademas de los objetos @ref{765,,ZipFile}:

@geindex writepy() (método de zipfile.PyZipFile)
@anchor{library/zipfile zipfile PyZipFile writepy}@anchor{1075}
@deffn {Método} writepy (pathname, basename='@w{'}, filterfunc=None)

Busca archivos @code{*.py} y agrega el archivo correspondiente al archivo.

Si no se proporcionó el parámetro `optimize' a @ref{1076,,PyZipFile} o @code{-1}, el archivo correspondiente es un archivo @code{*.pyc}, compilando si es necesario.

Si el parámetro `optimize' a @ref{1076,,PyZipFile} era @code{0}, @code{1} or @code{2}, solo se agregarán a ese archivo los archivos con ese nivel de optimización (ver @ref{2fb,,compile()}) el archivo, compilando si es necesario.

Si `pathname' es un archivo, el nombre del archivo debe terminar con @code{.py}, y solo el archivo (correspondiente @code{*.pyc}) se agrega en el nivel superior (sin información de ruta). Si `pathname' es un archivo que no termina con @code{.py}, se lanzará @ref{1e5,,RuntimeError}. Si es un directorio, y el directorio no es un directorio de paquetes, entonces todos los archivos @code{*.pyc} se agregan en el nivel superior. Si el directorio es un directorio de paquetes, todos @code{*.pyc} se agregan bajo el nombre del paquete como una ruta de archivo, y si alguno de los subdirectorios son directorios de paquetes, todos estos se agregan recursivamente en orden ordenado.

`basename' está destinado solo para uso interno.

`filterfunc', si se proporciona, debe ser una función que tome un único argumento de cadena. Se le pasará cada ruta (incluida cada ruta de archivo completa individual) antes de que se agregue al archivo. Si `filterfunc' retorna un valor falso, la ruta no se agregará y si se trata de un directorio se ignorará su contenido. Por ejemplo, si nuestros archivos de prueba están todos en directorios de @code{test} o comienzan con la cadena @code{test_}, podemos usar un `filterfunc' para excluirlos

@example
>>> zf = PyZipFile('myprog.zip')
>>> def notests(s):
...     fn = os.path.basename(s)
...     return (not (fn == 'test' or fn.startswith('test_')))
...
>>> zf.writepy('myprog', filterfunc=notests)
@end example

El método @ref{1075,,writepy()} crea archivos con nombres de archivo como este

@example
string.pyc                   # Top level name
test/__init__.pyc            # Package directory
test/testall.pyc             # Module test.testall
test/bogus/__init__.pyc      # Subpackage directory
test/bogus/myfile.pyc        # Submodule test.bogus.myfile
@end example


Distinto en la versión 3.4: Added the `filterfunc' parameter.



Distinto en la versión 3.6.2: El parámetro `pathname' acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.7: La recursividad ordena las entradas del directorio.

@end deffn
@end deffn

@node Objetos ZipInfo,Interfaz de línea de comandos,Objetos PyZipFile,zipfile — Work with ZIP archives
@anchor{library/zipfile id4}@anchor{29c2}@anchor{library/zipfile zipinfo-objects}@anchor{29a2}
@subsubsection Objetos ZipInfo


Las instancias de la clase @ref{d91,,ZipInfo} son retornadas por los métodos @ref{29a0,,getinfo()} y @ref{29a1,,infolist()} de @ref{765,,ZipFile}. Cada objeto almacena información sobre un solo miembro del archivo ZIP.

Hay un método de clase para hacer una instancia de @ref{d91,,ZipInfo} para un archivo de sistema de archivos:

@geindex from_file() (método de clase de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo from_file}@anchor{d90}
@deffn {Método} classmethod ZipInfo.from_file (filename, arcname=None, *, strict_timestamps=True)

Construye una instancia de @ref{d91,,ZipInfo} para un archivo en el sistema de archivos, en preparación para agregarlo a un archivo zip.

`filename' debe ser la ruta a un archivo o directorio en el sistema de archivos.

Si se especifica `arcname', este es usado como el nombre dentro del archivo. Si no se especifica `arcname', el nombre será el mismo que `filename', pero con cualquier letra de unidad y separadores de ruta principales eliminados.

El argumento `strictly_timestamps', cuando se establece en @code{False}, permite comprimir archivos anteriores a 1980-01-01 a costa de establecer la marca de tiempo en 1980-01-01. Un comportamiento similar ocurre con archivos más nuevos que 2107-12-31, la marca de tiempo también se establece en el límite.


Added in version 3.6.



Distinto en la versión 3.6.2: El parámetro `filename' acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.8: Added the `strict_timestamps' keyword-only parameter.

@end deffn

Las instancias tienen los siguientes métodos y atributos:

@geindex is_dir() (método de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo is_dir}@anchor{d92}
@deffn {Método} ZipInfo.is_dir ()

Retorna @code{True} si este miembro del archivo es un directorio.

Utiliza el nombre de la entrada: los directorios siempre deben terminar con @code{/}.


Added in version 3.6.

@end deffn

@geindex filename (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo filename}@anchor{29c3}
@deffn {Atributo} ZipInfo.filename

Nombre del archivo en el archivo.
@end deffn

@geindex date_time (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo date_time}@anchor{29c4}
@deffn {Atributo} ZipInfo.date_time

La hora y fecha de la última modificación al miembro del archivo. Esta es una tupla de seis valores:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Valor

@item

@code{0}

@tab

Año (>= 1980)

@item

@code{1}

@tab

Mes (basado en uno)

@item

@code{2}

@tab

Día del mes (basado en uno)

@item

@code{3}

@tab

Horas (basados en cero)

@item

@code{4}

@tab

Minutos (basados en cero)

@item

@code{5}

@tab

Segundos (basado en cero)

@end multitable


@cartouche
@quotation Nota 
El formato de archivo ZIP no admite marcas de tiempo anteriores a 1980.
@end quotation
@end cartouche
@end deffn

@geindex compress_type (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo compress_type}@anchor{29c5}
@deffn {Atributo} ZipInfo.compress_type

Tipo de compresión para la miembro del archivo.
@end deffn

@geindex comment (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo comment}@anchor{29c6}
@deffn {Atributo} ZipInfo.comment

Comenta para el miembro de archivo individual como un objeto @ref{325,,bytes}.
@end deffn

@geindex extra (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo extra}@anchor{29c7}
@deffn {Atributo} ZipInfo.extra

Datos de campo de expansión. La PKZIP Application Note@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT} contiene algunos comentarios sobre la estructura interna de los datos contenidos en este objeto @ref{325,,bytes}.
@end deffn

@geindex create_system (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo create_system}@anchor{29c8}
@deffn {Atributo} ZipInfo.create_system

Sistema que creó el archivo ZIP.
@end deffn

@geindex create_version (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo create_version}@anchor{29c9}
@deffn {Atributo} ZipInfo.create_version

Versión PKZIP que creó el archivo ZIP.
@end deffn

@geindex extract_version (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo extract_version}@anchor{29ca}
@deffn {Atributo} ZipInfo.extract_version

Se necesita la versión PKZIP para extraer el archivo.
@end deffn

@geindex reserved (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo reserved}@anchor{29cb}
@deffn {Atributo} ZipInfo.reserved

Debe ser cero.
@end deffn

@geindex flag_bits (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo flag_bits}@anchor{29cc}
@deffn {Atributo} ZipInfo.flag_bits

Bits de bandera ZIP.
@end deffn

@geindex volume (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo volume}@anchor{29cd}
@deffn {Atributo} ZipInfo.volume

Número de volumen del encabezado del archivo.
@end deffn

@geindex internal_attr (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo internal_attr}@anchor{29ce}
@deffn {Atributo} ZipInfo.internal_attr

Atributos internos.
@end deffn

@geindex external_attr (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo external_attr}@anchor{29cf}
@deffn {Atributo} ZipInfo.external_attr

Atributos de archivo externo.
@end deffn

@geindex header_offset (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo header_offset}@anchor{29d0}
@deffn {Atributo} ZipInfo.header_offset

Byte desplazado al encabezado del archivo.
@end deffn

@geindex CRC (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo CRC}@anchor{29d1}
@deffn {Atributo} ZipInfo.CRC

CRC-32 del archivo sin comprimir.
@end deffn

@geindex compress_size (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo compress_size}@anchor{29d2}
@deffn {Atributo} ZipInfo.compress_size

Tamaño de los datos comprimidos.
@end deffn

@geindex file_size (atributo de zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo file_size}@anchor{29ab}
@deffn {Atributo} ZipInfo.file_size

Tamaño del archivo sin comprimir.
@end deffn

@node Interfaz de línea de comandos,Problemas de descompresión,Objetos ZipInfo,zipfile — Work with ZIP archives
@anchor{library/zipfile command-line-interface}@anchor{29d3}@anchor{library/zipfile zipfile-commandline}@anchor{29d4}
@subsubsection Interfaz de línea de comandos


El módulo @ref{130,,zipfile} proporciona una interfaz de línea de comandos simple para interactuar con archivos ZIP.

Si desea crear un nuevo archivo ZIP, especifique su nombre después de la opción @ref{29d5,,-c} y luego enumere los nombres de archivo que deben incluirse:

@example
$ python -m zipfile -c monty.zip spam.txt eggs.txt
@end example

Pasar un directorio también es aceptable:

@example
$ python -m zipfile -c monty.zip life-of-brian_1979/
@end example

Si desea extraer un archivo ZIP en el directorio especificado, use la opción @ref{29d6,,-e}:

@example
$ python -m zipfile -e monty.zip target-dir/
@end example

Para obtener una lista de los archivos en un archivo ZIP, use la opción @ref{29d7,,-l}:

@example
$ python -m zipfile -l monty.zip
@end example

@menu
* Opciones de línea de comando:: 

@end menu

@node Opciones de línea de comando,,,Interfaz de línea de comandos
@anchor{library/zipfile command-line-options}@anchor{29d8}
@subsubsection Opciones de línea de comando


@geindex opción de línea de comando zipfile; -l
@geindex opción de línea de comando zipfile; --list
@anchor{library/zipfile cmdoption-zipfile-l}@anchor{29d7}
@deffn {Option} @w{-}l <zipfile>
@anchor{library/zipfile cmdoption-zipfile-list}@anchor{29d9}
@deffnx {Option} @w{-}@w{-}list <zipfile>

Lista de archivos en un archivo zip.
@end deffn

@geindex opción de línea de comando zipfile; -c
@geindex opción de línea de comando zipfile; --create
@anchor{library/zipfile cmdoption-zipfile-c}@anchor{29d5}
@deffn {Option} @w{-}c <zipfile> <source1> ... <sourceN>
@anchor{library/zipfile cmdoption-zipfile-create}@anchor{29da}
@deffnx {Option} @w{-}@w{-}create <zipfile> <source1> ... <sourceN>

Crea el archivo zip a partir de archivos fuente.
@end deffn

@geindex opción de línea de comando zipfile; -e
@geindex opción de línea de comando zipfile; --extract
@anchor{library/zipfile cmdoption-zipfile-e}@anchor{29d6}
@deffn {Option} @w{-}e <zipfile> <output_dir>
@anchor{library/zipfile cmdoption-zipfile-extract}@anchor{29db}
@deffnx {Option} @w{-}@w{-}extract <zipfile> <output_dir>

Extrae el archivo zip en el directorio de destino.
@end deffn

@geindex opción de línea de comando zipfile; -t
@geindex opción de línea de comando zipfile; --test
@anchor{library/zipfile cmdoption-zipfile-t}@anchor{29dc}
@deffn {Option} @w{-}t <zipfile>
@anchor{library/zipfile cmdoption-zipfile-test}@anchor{29dd}
@deffnx {Option} @w{-}@w{-}test <zipfile>

Prueba si el archivo zip es válido o no.
@end deffn

@geindex opción de línea de comando zipfile; --metadata-encoding
@anchor{library/zipfile cmdoption-zipfile-metadata-encoding}@anchor{29de}
@deffn {Option} @w{-}@w{-}metadata@w{-}encoding <encoding>

Especifica la codificación de nombre de miembros para @ref{29d7,,-l}, @ref{29d6,,-e} y @ref{29dc,,-t}.


Added in version 3.11.

@end deffn

@node Problemas de descompresión,,Interfaz de línea de comandos,zipfile — Work with ZIP archives
@anchor{library/zipfile decompression-pitfalls}@anchor{29df}
@subsubsection Problemas de descompresión


La extracción en el módulo zipfile puede fallar debido a algunos problemas que se enumeran a continuación.

@menu
* Del archivo mismo:: 
* Limitaciones del sistema de archivos:: 
* Limitaciones de recursos:: 
* Interrupción:: 
* Comportamientos predeterminados de extracción:: 

@end menu

@node Del archivo mismo,Limitaciones del sistema de archivos,,Problemas de descompresión
@anchor{library/zipfile from-file-itself}@anchor{29e0}
@subsubsection Del archivo mismo


La descompresión puede fallar debido a una contraseña incorrecta / suma de verificación CRC / formato ZIP o método / descifrado de compresión no compatible.

@node Limitaciones del sistema de archivos,Limitaciones de recursos,Del archivo mismo,Problemas de descompresión
@anchor{library/zipfile file-system-limitations}@anchor{29e1}
@subsubsection Limitaciones del sistema de archivos


Exceder las limitaciones en diferentes sistemas de archivos puede causar que la descompresión falle. Como los caracteres permitidos en las entradas del directorio, la longitud del nombre del archivo, la longitud de la ruta, el tamaño de un solo archivo y la cantidad de archivos, etc.

@node Limitaciones de recursos,Interrupción,Limitaciones del sistema de archivos,Problemas de descompresión
@anchor{library/zipfile resources-limitations}@anchor{29e2}@anchor{library/zipfile zipfile-resources-limitations}@anchor{29e3}
@subsubsection Limitaciones de recursos


La falta de memoria o volumen de disco conduciría a la descompresión fallida. Por ejemplo, las bombas de descompresión (también conocido como ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}) se aplican a la biblioteca de archivos zip que pueden causar el agotamiento del volumen del disco.

@node Interrupción,Comportamientos predeterminados de extracción,Limitaciones de recursos,Problemas de descompresión
@anchor{library/zipfile interruption}@anchor{29e4}
@subsubsection Interrupción


La interrupción durante la descompresión, como presionar control-C o matar el proceso de descompresión, puede dar como resultado una descompresión incompleta del archivo.

@node Comportamientos predeterminados de extracción,,Interrupción,Problemas de descompresión
@anchor{library/zipfile default-behaviors-of-extraction}@anchor{29e5}
@subsubsection Comportamientos predeterminados de extracción


No conocer los comportamientos de extracción predeterminados puede causar resultados de descompresión inesperados. Por ejemplo, al extraer el mismo archivo dos veces, sobrescribe los archivos sin preguntar.

@node tarfile — Read and write tar archive files,,zipfile — Work with ZIP archives,Compresión de datos y archivado
@anchor{library/tarfile doc}@anchor{29e6}@anchor{library/tarfile module-tarfile}@anchor{de}@anchor{library/tarfile tarfile-read-and-write-tar-archive-files}@anchor{29e7}
@subsection @code{tarfile} — Read and write tar archive files


@geindex module; tarfile

`Código fuente:' Lib/tarfile.py@footnote{https://github.com/python/cpython/tree/main/Lib/tarfile.py}


__________________________________________________________________


El módulo @ref{de,,tarfile} hace posible escribir y leer archivos tar, incluyendo aquellos que hacen uso de compresión gzip, bz2 y lzma. Utiliza el módulo @ref{130,,zipfile} para leer o escribir archivos @code{.zip}, o las funciones de nivel superior en @ref{1285,,shutil}.

Algunos hechos y cifras:


@itemize *

@item 
lee y escribe archivos comprimidos @ref{67,,gzip}, @ref{14,,bz2} y @ref{8a,,lzma} si los respectivos módulos están disponibles.

@item 
soporte de lectura/escritura para el formato POSIX.1-1988 (ustar).

@item 
soporte de lectura/escritura para el formato GNU tar incluyendo extensiones `longname' y `longlink', soporte de solo escritura para todas las variantes de extensiones de `sparse' (archivo disperso) incluyendo restablecimiento de archivos dispersos.

@item 
soporte de lectura/escritura para el formato POSIX.1-2001 (pax).

@item 
gestiona directorios, archivos regulares, enlaces duros, enlaces simbólicos, fifos, dispositivos de carácter, dispositivos de bloque y puede adquirir y restaurar información de archivo como marca de tiempo, permisos de acceso y dueño.
@end itemize


Distinto en la versión 3.3: Añadido soporte para compresión @ref{8a,,lzma}.



Distinto en la versión 3.12: Archives are extracted using a @ref{517,,filter},
which makes it possible to either limit surprising/dangerous features,
or to acknowledge that they are expected and the archive is fully trusted.



Distinto en la versión 3.14: Set the default extraction filter to @ref{1615,,data},
which disallows some dangerous features such as links to absolute paths
or paths outside of the destination. Previously, the filter strategy
was equivalent to @ref{29e8,,fully_trusted}.


@geindex open() (en el módulo tarfile)
@anchor{library/tarfile tarfile open}@anchor{ef8}
@deffn {Función} tarfile.open (name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

Retorna un objeto @ref{127d,,TarFile} para el nombre de ruta `name'. Para información detallada en los objetos de la clase @ref{127d,,TarFile} y los argumentos por palabra clave que están permitidos, dirígete a @ref{29e9,,Objetos TarFile}.

`mode' tiene que ser una cadena de texto en el formato @code{'filemode[:compression]'}, adquiere el valor de @code{'r'} de forma predeterminada. Aquí hay una lista completa de combinaciones de modo:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

modo

@tab

acción

@item

@code{'r' o 'r:*'}

@tab

Abrir para leer con compresión transparente (recomendado).

@item

@code{'r:'}

@tab

Abrir para leer exclusivamente sin compresión.

@item

@code{'r:gz'}

@tab

Abrir para leer con compresión gzip.

@item

@code{'r:bz2'}

@tab

Abrir para leer con compresión bzip2.

@item

@code{'r:xz'}

@tab

Abrir para leer con compresión lzma.

@item

@code{'x'} o @code{'x:'}

@tab

Create a tarfile exclusively without
compression.
Raise a @ref{109c,,FileExistsError} exception
if it already exists.

@item

@code{'x:gz'}

@tab

Create a tarfile with gzip compression.
Raise a @ref{109c,,FileExistsError} exception
if it already exists.

@item

@code{'x:bz2'}

@tab

Create a tarfile with bzip2 compression.
Raise a @ref{109c,,FileExistsError} exception
if it already exists.

@item

@code{'x:xz'}

@tab

Create a tarfile with lzma compression.
Raise a @ref{109c,,FileExistsError} exception
if it already exists.

@item

@code{'a' or 'a:'}

@tab

Abrir para anexar sin compresión. El archivo se crea si no existe.

@item

@code{'w' o 'w:'}

@tab

Abrir para escritura con compresión lzma.

@item

@code{'w:gz'}

@tab

Abrir para escritura con compresión gzip.

@item

@code{'w:bz2'}

@tab

Abrir para escritura con compresión bzip2.

@item

@code{'w:xz'}

@tab

Abrir para escritura con compresión lzma.

@end multitable


Ten en cuenta que @code{'a:gz'}, @code{'a:bz2'} or @code{'a:xz'} no son posibles. Si `mode' no es apropiado para abrir ciertos archivos (comprimidos) para lectura, se lanza una excepción de tipo @ref{18a3,,ReadError}. Usa el `modo' @code{'r'} para evitar esto. Si el método de compresión no es admitido, se lanza una excepción @ref{29ea,,CompressionError}.

Si `fileobj' es especificado, se utiliza como alternativa a @ref{1230,,file object} abierto en modo binario para `name'. Debe estar en la posición 0.

For modes @code{'w:gz'}, @code{'x:gz'}, @code{'w|gz'}, @code{'w:bz2'}, @code{'x:bz2'},
@code{'w|bz2'}, @ref{ef8,,tarfile.open()} accepts the keyword argument
`compresslevel' (default @code{9}) to specify the compression level of the file.

Para los modos @code{'w:xz'} y @code{'x:xz'}, @ref{ef8,,tarfile.open()} acepta el argumento de palabra clave `preset' para especificar el nivel de compresión del archivo.

For special purposes, there is a second format for `mode':
@code{'filemode|[compression]'}.  @ref{ef8,,tarfile.open()} will return a @ref{127d,,TarFile}
object that processes its data as a stream of blocks.  No random seeking will
be done on the file. If given, `fileobj' may be any object that has a
@ref{ea1,,read()} or @ref{29eb,,write()} method
(depending on the `mode') that works with bytes.
`bufsize' specifies the blocksize and defaults to @code{20 * 512} bytes.
Use this variant in combination with e.g. @code{sys.stdin.buffer}, a socket
@ref{1230,,file object} or a tape device.
However, such a @ref{127d,,TarFile} object is limited in that it does
not allow random access, see @ref{29ec,,Ejemplos}.  The currently
possible modes:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modo

@tab

Acción

@item

@code{'r|*'}

@tab

Abre un `stream' de bloques tar para leer con compresión transparente.

@item

@code{'r|'}

@tab

Abre un `stream' de bloques tar sin comprimir para lectura.

@item

@code{'r|gz'}

@tab

Abre un `stream' comprimido con gzip para lectura.

@item

@code{'r|bz2'}

@tab

Abre un `stream' bzip2 comprimido para lectura.

@item

@code{'r|xz'}

@tab

Abre un `stream' lzma comprimido para lectura.

@item

@code{'w|'}

@tab

Abre un `stream' sin comprimir para escritura.

@item

@code{'w|gz'}

@tab

Abre un `stream' gzip comprimido para escritura.

@item

@code{'w|bz2'}

@tab

Abre un `stream' bzip2 comprimido para escritura.

@item

@code{'w|xz'}

@tab

Abre un `stream' lzma comprimido para escritura.

@end multitable



Distinto en la versión 3.5: El modo @code{'x'} (creación exclusiva) fue añadido.



Distinto en la versión 3.6: El parámetro `name' acepta un objeto @ref{3f0,,path-like object}.



Distinto en la versión 3.12: The `compresslevel' keyword argument also works for streams.

@end deffn


@deffn {Clase} tarfile.TarFile

Clase para leer y escribir archivos tar. No utilices esta clase directamente; usa @ref{ef8,,tarfile.open()} en su lugar. Consulta @ref{29e9,,Objetos TarFile}.
@end deffn

@geindex is_tarfile() (en el módulo tarfile)
@anchor{library/tarfile tarfile is_tarfile}@anchor{184b}
@deffn {Función} tarfile.is_tarfile (name)

Retorna @ref{c95,,True} si `name' es un archivo tar, que el módulo @ref{de,,tarfile} puede leer. `name' puede ser un @ref{237,,str}, archivo o un objeto similar a un archivo.


Distinto en la versión 3.9: Soporte para archivos y objetos similares a archivos.

@end deffn

El módulo @ref{de,,tarfile} define las siguientes excepciones:

@geindex TarError
@anchor{library/tarfile tarfile TarError}@anchor{29ed}
@deffn {Excepción} tarfile.TarError

Clase base para todas las excepciones del módulo @ref{de,,tarfile}.
@end deffn

@geindex ReadError
@anchor{library/tarfile tarfile ReadError}@anchor{18a3}
@deffn {Excepción} tarfile.ReadError

Se lanza cuando un archivo tar se abre, que no puede ser manejado por el módulo @ref{de,,tarfile} o de alguna manera no es válido.
@end deffn

@geindex CompressionError
@anchor{library/tarfile tarfile CompressionError}@anchor{29ea}
@deffn {Excepción} tarfile.CompressionError

Se lanza cuando un método de compresión no tiene soporte o cuando la información no puede ser decodificada de manera apropiada.
@end deffn

@geindex StreamError
@anchor{library/tarfile tarfile StreamError}@anchor{29ee}
@deffn {Excepción} tarfile.StreamError

Se lanza para limitaciones que son comunes para objetos `stream-like' @ref{127d,,TarFile}.
@end deffn

@geindex ExtractError
@anchor{library/tarfile tarfile ExtractError}@anchor{29ef}
@deffn {Excepción} tarfile.ExtractError

Se lanza para errores no fatales cuando se utiliza @ref{efa,,TarFile.extract()}, pero solo si @ref{29f0,,TarFile.errorlevel}@code{== 2}.
@end deffn

@geindex HeaderError
@anchor{library/tarfile tarfile HeaderError}@anchor{29f1}
@deffn {Excepción} tarfile.HeaderError

Se lanza por @ref{29f2,,TarInfo.frombuf()} si el buffer que obtiene es invalido.
@end deffn

@geindex FilterError
@anchor{library/tarfile tarfile FilterError}@anchor{29f3}
@deffn {Excepción} tarfile.FilterError

Base class for members @ref{29f4,,refused} by
filters.

@geindex tarinfo (atributo de tarfile.FilterError)
@anchor{library/tarfile tarfile FilterError tarinfo}@anchor{29f5}
@deffn {Atributo} tarinfo

Information about the member that the filter refused to extract,
as @ref{29f6,,TarInfo}.
@end deffn
@end deffn

@geindex AbsolutePathError
@anchor{library/tarfile tarfile AbsolutePathError}@anchor{29f7}
@deffn {Excepción} tarfile.AbsolutePathError

Raised to refuse extracting a member with an absolute path.
@end deffn

@geindex OutsideDestinationError
@anchor{library/tarfile tarfile OutsideDestinationError}@anchor{29f8}
@deffn {Excepción} tarfile.OutsideDestinationError

Raised to refuse extracting a member outside the destination directory.
@end deffn

@geindex SpecialFileError
@anchor{library/tarfile tarfile SpecialFileError}@anchor{29f9}
@deffn {Excepción} tarfile.SpecialFileError

Raised to refuse extracting a special file (e.g. a device or pipe).
@end deffn

@geindex AbsoluteLinkError
@anchor{library/tarfile tarfile AbsoluteLinkError}@anchor{29fa}
@deffn {Excepción} tarfile.AbsoluteLinkError

Raised to refuse extracting a symbolic link with an absolute path.
@end deffn

@geindex LinkOutsideDestinationError
@anchor{library/tarfile tarfile LinkOutsideDestinationError}@anchor{29fb}
@deffn {Excepción} tarfile.LinkOutsideDestinationError

Raised to refuse extracting a symbolic link pointing outside the destination
directory.
@end deffn

Las siguientes constantes están disponibles a nivel de módulo:

@geindex ENCODING (en el módulo tarfile)
@anchor{library/tarfile tarfile ENCODING}@anchor{29fc}
@deffn {Dato} tarfile.ENCODING

La codificación para caracteres predeterminada: @code{'utf-8'} en Windows, de otra manera, el valor retornado por @ref{ce1,,sys.getfilesystemencoding()}.
@end deffn

@geindex REGTYPE (en el módulo tarfile)
@geindex AREGTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile REGTYPE}@anchor{29fd}
@deffn {Dato} tarfile.REGTYPE
@anchor{library/tarfile tarfile AREGTYPE}@anchor{29fe}
@deffnx {Dato} tarfile.AREGTYPE

A regular file @ref{29ff,,type}.
@end deffn

@geindex LNKTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile LNKTYPE}@anchor{2a00}
@deffn {Dato} tarfile.LNKTYPE

A link (inside tarfile) @ref{29ff,,type}.
@end deffn

@geindex SYMTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile SYMTYPE}@anchor{2a01}
@deffn {Dato} tarfile.SYMTYPE

A symbolic link @ref{29ff,,type}.
@end deffn

@geindex CHRTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile CHRTYPE}@anchor{2a02}
@deffn {Dato} tarfile.CHRTYPE

A character special device @ref{29ff,,type}.
@end deffn

@geindex BLKTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile BLKTYPE}@anchor{2a03}
@deffn {Dato} tarfile.BLKTYPE

A block special device @ref{29ff,,type}.
@end deffn

@geindex DIRTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile DIRTYPE}@anchor{2a04}
@deffn {Dato} tarfile.DIRTYPE

A directory @ref{29ff,,type}.
@end deffn

@geindex FIFOTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile FIFOTYPE}@anchor{2a05}
@deffn {Dato} tarfile.FIFOTYPE

A FIFO special device @ref{29ff,,type}.
@end deffn

@geindex CONTTYPE (en el módulo tarfile)
@anchor{library/tarfile tarfile CONTTYPE}@anchor{2a06}
@deffn {Dato} tarfile.CONTTYPE

A contiguous file @ref{29ff,,type}.
@end deffn

@geindex GNUTYPE_LONGNAME (en el módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_LONGNAME}@anchor{2a07}
@deffn {Dato} tarfile.GNUTYPE_LONGNAME

A GNU tar longname @ref{29ff,,type}.
@end deffn

@geindex GNUTYPE_LONGLINK (en el módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_LONGLINK}@anchor{2a08}
@deffn {Dato} tarfile.GNUTYPE_LONGLINK

A GNU tar longlink @ref{29ff,,type}.
@end deffn

@geindex GNUTYPE_SPARSE (en el módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_SPARSE}@anchor{2a09}
@deffn {Dato} tarfile.GNUTYPE_SPARSE

A GNU tar sparse file @ref{29ff,,type}.
@end deffn

Cada una de las siguientes constantes define un formato de archivo tar que el módulo @ref{de,,tarfile} puede crear. Ve la sección: @ref{2a0a,,Formatos tar con soporte} para más detalles.

@geindex USTAR_FORMAT (en el módulo tarfile)
@anchor{library/tarfile tarfile USTAR_FORMAT}@anchor{2a0b}
@deffn {Dato} tarfile.USTAR_FORMAT

Formato POSIX.1-1988 (ustar).
@end deffn

@geindex GNU_FORMAT (en el módulo tarfile)
@anchor{library/tarfile tarfile GNU_FORMAT}@anchor{2a0c}
@deffn {Dato} tarfile.GNU_FORMAT

Formato GNU tar.
@end deffn

@geindex PAX_FORMAT (en el módulo tarfile)
@anchor{library/tarfile tarfile PAX_FORMAT}@anchor{2a0d}
@deffn {Dato} tarfile.PAX_FORMAT

Formato POSIX.1-2001 (pax).
@end deffn

@geindex DEFAULT_FORMAT (en el módulo tarfile)
@anchor{library/tarfile tarfile DEFAULT_FORMAT}@anchor{2a0e}
@deffn {Dato} tarfile.DEFAULT_FORMAT

El formato predeterminado para crear archivos. Es actualmente @ref{2a0d,,PAX_FORMAT}.


Distinto en la versión 3.8: El formato predeterminado para nuevos archivos fue cambiado de @ref{2a0c,,GNU_FORMAT} a @ref{2a0d,,PAX_FORMAT}.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{130,,zipfile}

Documentación del módulo estándar @ref{130,,zipfile}.

@item @ref{1285,,Operaciones de archivado}

Documentación para las facilidades de archivos de más alto nivel proporcionadas por el módulo estándar @ref{c5,,shutil}.

@item Manual GNU tar@comma{} formato básico tar@footnote{https://www.gnu.org/software/tar/manual/html_node/Standard.html}

Documentación para archivos de tipo tar, incluyendo extensiones GNU tar.
@end table


@menu
* Objetos TarFile:: 
* Objetos TarInfo:: 
* Extraction filters:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<2>. 
* Ejemplos: Ejemplos<8>. 
* Formatos tar con soporte:: 
* Problemas unicode:: 

@end menu

@node Objetos TarFile,Objetos TarInfo,,tarfile — Read and write tar archive files
@anchor{library/tarfile id1}@anchor{2a0f}@anchor{library/tarfile tarfile-objects}@anchor{29e9}
@subsubsection Objetos `TarFile'


El objeto @ref{127d,,TarFile} provee una interfaz a un archivo tar. Un archivo tar es una secuencia de bloques. Un miembro de archivos (un archivo almacenado) está hecho de un bloque de encabezado seguido de bloques de datos. Es posible almacenar un archivo dentro de un tar múltiples veces. Cada archivo miembro está representado por un objeto @ref{127e,,TarInfo}, consulta @ref{29f6,,Objetos TarInfo} para más detalles.

Un objeto @ref{127d,,TarFile} puede ser usado como un administrador de contexto en una declaración @ref{673,,with}. Será automáticamente cerrado cuando el bloque sea completado. Ten en cuenta que en el evento de una excepción un archivo abierto para escritura no será terminado; solo el objeto de archivo interno será cerrado. Consulta la sección @ref{29ec,,Ejemplos} para un caso de uso.


Added in version 3.2: Añadido soporte para el protocolo de administración de contexto.


@geindex TarFile (clase en tarfile)
@anchor{library/tarfile tarfile TarFile}@anchor{127d}
@deffn {Clase} tarfile.TarFile (name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=1, stream=False)

Los siguientes argumentos son opcionales y también se pueden acceder como atributos de instancia.

`name' is the pathname of the archive. `name' may be a @ref{3f0,,path-like object}.
It can be omitted if `fileobj' is given.
In this case, the file object’s @code{name} attribute is used if it exists.

`mode' puede ser @code{'r'} para leer desde un archivo existente, @code{'a'} para adjuntar datos a un archivo existente,`@w{`}”w”`@w{`} para crear un nuevo archivo sobrescribiendo uno existente, o @code{'x'} para crear un nuevo archivo únicamente si este no existe.

Si `fileobj' es proporcionado, se utiliza para escritura o lectura de datos. Si puede ser determinado, `mode' puede ser anulado por el modo de `fileobj'. `fileobj' será usado desde la posición 0.

@cartouche
@quotation Nota 
`fileobj' no se cierra cuando @ref{127d,,TarFile} se cierra.
@end quotation
@end cartouche

`format' controla el formato de archivo para la escritura. Debe ser una de las constantes @ref{2a0b,,USTAR_FORMAT}, @ref{2a0c,,GNU_FORMAT} o @ref{2a0d,,PAX_FORMAT} que se definen a nivel de módulo. Al leer, el formato se detectará automáticamente, incluso si hay diferentes formatos en un solo archivo.

El argumento `tarinfo' puede ser utilizado para reemplazar la clase predeterminada @ref{127e,,TarInfo} con una diferente.

Si `dereference' tiene el valor de @ref{bbf,,False}, añade enlaces simbólicos y duros al archivo. Si tiene el valor de @ref{c95,,True}, añade el contenido de archivos objetivo al archivo. Esto no tiene ningún efecto en los sistemas que no admiten enlaces simbólicos.

Si `ignore_zeros' tiene el valor de @ref{bbf,,False}, trata un bloque vacío como el final del archivo. Si es @ref{c95,,True}, omite los bloques vacíos (y no válidos) e intenta obtener tantos miembros como sea posible. Esto solo es útil para leer archivos concatenados o dañados.

`debug' puede ser establecido con valores desde @code{0} (sin mensajes de depuración) hasta @code{3} (todos los mensajes de depuración). Los mensajes son escritos en @code{sys.stderr}.

`errorlevel' controls how extraction errors are handled,
see @ref{29f0,,the corresponding attribute}.

Los argumentos `encoding' y `errors' definen la codificación de caracteres que se utilizará para lectura o escritura del archivo y como los errores de conversión van a ser manejados. La configuración predeterminada funcionará para la mayoría de los usuarios. Mira la sección @ref{2a10,,Problemas unicode} para más información a detalle.

El argumento `pax_headers' es un diccionario opcional de cadenas las cuales serán añadidas como un encabezado pax global si el valor de `format' es @ref{2a0d,,PAX_FORMAT}.

If `stream' is set to @ref{c95,,True} then while reading the archive info about files
in the archive are not cached, saving memory.


Distinto en la versión 3.2: Utiliza @code{'surrogateescape'} como valor predeterminado del argumento `errors'.



Distinto en la versión 3.5: El modo @code{'x'} (creación exclusiva) fue añadido.



Distinto en la versión 3.6: El parámetro `name' acepta un objeto @ref{3f0,,path-like object}.



Distinto en la versión 3.13: Add the `stream' parameter.

@end deffn

@geindex open() (método de clase de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile open}@anchor{184c}
@deffn {Método} classmethod TarFile.open (...)

Constructor alternativo. La función @ref{ef8,,tarfile.open()} es un acceso directo a este método de la clase.
@end deffn

@geindex getmember() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getmember}@anchor{185b}
@deffn {Método} TarFile.getmember (name)

Retorna un objeto @ref{127e,,TarInfo} para el miembro `name'. Si `name' no puede ser encontrado, entonces una excepción de tipo @ref{438,,KeyError} será lanzada.

@cartouche
@quotation Nota 
Si un miembro aparece más de una vez en el archivo, se asume que su última aparición es la versión más actualizada.
@end quotation
@end cartouche
@end deffn

@geindex getmembers() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getmembers}@anchor{efc}
@deffn {Método} TarFile.getmembers ()

Retorna los miembros del archivo como una lista de objetos @ref{127e,,TarInfo}. La lista tiene el mismo orden que los miembros del archivo.
@end deffn

@geindex getnames() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getnames}@anchor{2a11}
@deffn {Método} TarFile.getnames ()

Retorna los miembros como una lista de sus nombres. Tiene el mismo orden que la lista retornada por @ref{efc,,getmembers()}.
@end deffn

@geindex list() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile list}@anchor{efb}
@deffn {Método} TarFile.list (verbose=True, *, members=None)

Imprime en @code{sys.stdout} una tabla de contenidos. Si `verbose' es @ref{bbf,,False}, solo los nombres de los miembros son impresos. si es @ref{c95,,True}, se produce una salida de impresión similar a la de @code{ls -l}. Si el parámetro `members' es proporcionado, debe ser un subconjunto de la lista retornada por @ref{efc,,getmembers()}.


Distinto en la versión 3.5: Se agregó el parámetro `members'.

@end deffn

@geindex next() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile next}@anchor{2a12}
@deffn {Método} TarFile.next ()

Retorna el siguiente miembro del archivo como un objeto @ref{127e,,TarInfo} cuando @ref{127d,,TarFile} se abre para lectura. Retorna @ref{716,,None} si no hay más miembros disponibles.
@end deffn

@geindex extractall() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extractall}@anchor{ef9}
@deffn {Método} TarFile.extractall (path='.', members=None, *, numeric_owner=False, filter=None)

Extrae todos los miembros de un archivo al directorio de trabajo actual o al directorio de `path'. Si se proporciona el parámetro opcional `members', debe ser un subconjunto de la lista retornada por el método @ref{efc,,getmembers()}. Información de directorio como dueño, fecha de modificación y permisos son establecidos una vez que todos los miembros han sido extraídos. Esto se realiza para trabajar con dos problemáticas: La fecha de modificación de un directorio es modificada cada vez que un archivo es creado en el. Y si los permisos de un directorio no permiten escritura, extraer archivos en el no será posible.

Si `numeric_owner' tiene el valor de @ref{c95,,True}, los números uid y gid del archivo tar se utilizan para establecer el dueño/grupo de los archivos extraídos. De lo contrario, se utilizan los valores nombrados del archivo tar.

The `filter' argument specifies how @code{members} are modified or rejected
before extraction.
See @ref{517,,Extraction filters} for details.
It is recommended to set this explicitly only if specific `tar' features
are required, or as @code{filter='data'} to support Python versions with a less
secure default (3.13 and lower).

@cartouche
@quotation Advertencia 
Never extract archives from untrusted sources without prior inspection.

Since Python 3.14, the default (@ref{1615,,data}) will prevent
the most dangerous security issues.
However, it will not prevent `all' unintended or insecure behavior.
Read the @ref{517,,Extraction filters} section for details.
@end quotation
@end cartouche


Distinto en la versión 3.5: Se agregó el parámetro `numeric_owner'.



Distinto en la versión 3.6: El parámetro `path' acepta a @ref{3f0,,path-like object}.



Distinto en la versión 3.12: Se agregó el parámetro `filter'.



Distinto en la versión 3.14: The `filter' parameter now defaults to @code{'data'}.

@end deffn

@geindex extract() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extract}@anchor{efa}
@deffn {Método} TarFile.extract (member, path='@w{'}, set_attrs=True, *, numeric_owner=False, filter=None)

Extrae un miembro del archivo al directorio de trabajo actual utilizando su nombre completo. La información de su archivo se extrae con la mayor precisión posible. `member' puede ser un nombre de archivo o un objeto @ref{127e,,TarInfo}. Puedes especificar un directorio diferente utilizando `path'. `path' puede ser un @ref{3f0,,path-like object}. Los atributos de archivo (dueño, fecha de modificación, modo) son establecidos a no ser que `set_attrs' sea falso.

The `numeric_owner' and `filter' arguments are the same as
for @ref{ef9,,extractall()}.

@cartouche
@quotation Nota 
El método @ref{efa,,extract()} no cuida de varios problemas de extracción. En la mayoría de los casos deberías considerar utilizar el método @ref{ef9,,extractall()}.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Never extract archives from untrusted sources without prior inspection.
See the warning for @ref{ef9,,extractall()} for details.
@end quotation
@end cartouche


Distinto en la versión 3.2: Se agregó el parámetro `set_attrs'.



Distinto en la versión 3.5: Se agregó el parámetro `numeric_owner'.



Distinto en la versión 3.6: El parámetro `path' acepta a @ref{3f0,,path-like object}.



Distinto en la versión 3.12: Se agregó el parámetro `filter'.

@end deffn

@geindex extractfile() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extractfile}@anchor{2a13}
@deffn {Método} TarFile.extractfile (member)

Extrae un miembro del archivo como un objeto de archivo. `member' puede ser un nombre de archivo o un objeto @ref{127e,,TarInfo}. Si `member' es un archivo normal o un enlace, se retorna un objeto @ref{127b,,io.BufferedReader}. Para todos los demás miembros existentes, se retorna @ref{716,,None}. Si `member' no aparece en el archivo, se lanza @ref{438,,KeyError}.


Distinto en la versión 3.3: Retorna un objeto @ref{127b,,io.BufferedReader}.



Distinto en la versión 3.13: The returned @ref{127b,,io.BufferedReader} object has the @code{mode}
attribute which is always equal to @code{'rb'}.

@end deffn

@geindex errorlevel (atributo de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile errorlevel}@anchor{29f0}
@deffn {Atributo} TarFile.errorlevel: @ref{1f0,,int}

If `errorlevel' is @code{0}, errors are ignored when using @ref{efa,,TarFile.extract()}
and @ref{ef9,,TarFile.extractall()}.
Nevertheless, they appear as error messages in the debug output when
`debug' is greater than 0.
If @code{1} (the default), all `fatal' errors are raised as @ref{4d5,,OSError} or
@ref{29f3,,FilterError} exceptions. If @code{2}, all `non-fatal' errors are raised
as @ref{29ed,,TarError} exceptions as well.

Some exceptions, e.g. ones caused by wrong argument types or data
corruption, are always raised.

Custom @ref{517,,extraction filters}
should raise @ref{29f3,,FilterError} for `fatal' errors
and @ref{29ef,,ExtractError} for `non-fatal' ones.

Note that when an exception is raised, the archive may be partially
extracted. It is the user’s responsibility to clean up.
@end deffn

@geindex extraction_filter (atributo de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extraction_filter}@anchor{2a14}
@deffn {Atributo} TarFile.extraction_filter


Added in version 3.12.


The @ref{517,,extraction filter} used
as a default for the `filter' argument of @ref{efa,,extract()}
and @ref{ef9,,extractall()}.

The attribute may be @code{None} or a callable.
String names are not allowed for this attribute, unlike the `filter'
argument to @ref{efa,,extract()}.

If @code{extraction_filter} is @code{None} (the default), extraction methods
will use the @ref{1615,,data} filter by default.

The attribute may be set on instances or overridden in subclasses.
It also is possible to set it on the @code{TarFile} class itself to set a
global default, although, since it affects all uses of `tarfile',
it is best practice to only do so in top-level applications or
@ref{c7,,site configuration}.
To set a global default this way, a filter function needs to be wrapped in
@ref{22e,,staticmethod()} to prevent injection of a @code{self} argument.


Distinto en la versión 3.14: The default filter is set to @ref{1615,,data},
which disallows some dangerous features such as links to absolute paths
or paths outside of the destination.
Previously, the default was equivalent to
@ref{29e8,,fully_trusted}.

@end deffn

@geindex add() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile add}@anchor{c7b}
@deffn {Método} TarFile.add (name, arcname=None, recursive=True, *, filter=None)

Añade el archivo `name' al archivo. `name' puede ser cualquier tipo de archivo (directorio, fifo, enlace simbólico, etc.). Si se proporciona, `arcname' especifica un nombre alternativo para el archivo en el archivo. Los directorios se agregan de forma recursiva de forma predeterminada. Esto se puede evitar estableciendo `recursive' con el valor de @ref{bbf,,False}. La recursividad agrega entradas en orden ordenado. Si se proporciona `filter', debería ser una función que tome un argumento de objeto @ref{127e,,TarInfo} y retorna el objeto @ref{127e,,TarInfo} modificado. Si en cambio retorna @ref{716,,None}, el objeto @ref{127e,,TarInfo} será excluido del archivo. Consulta @ref{29ec,,Ejemplos} para ver un ejemplo.


Distinto en la versión 3.2: Se agregó el parámetro `filter'.



Distinto en la versión 3.7: La recursividad agrega entradas en orden ordenado.

@end deffn

@geindex addfile() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile addfile}@anchor{163c}
@deffn {Método} TarFile.addfile (tarinfo, fileobj=None)

Add the @ref{127e,,TarInfo} object `tarinfo' to the archive. If `tarinfo' represents
a non zero-size regular file, the `fileobj' argument should be a @ref{1c8e,,binary file},
and @code{tarinfo.size} bytes are read from it and added to the archive.  You can
create @ref{127e,,TarInfo} objects directly, or by using @ref{2a15,,gettarinfo()}.


Distinto en la versión 3.13: `fileobj' must be given for non-zero-sized regular files.

@end deffn

@geindex gettarinfo() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile gettarinfo}@anchor{2a15}
@deffn {Método} TarFile.gettarinfo (name=None, arcname=None, fileobj=None)

Crea un objeto @ref{127e,,TarInfo} a partir del resultado de @ref{548,,os.stat()} o equivalente en un archivo existente. El archivo es nombrado por `name' o especificado como un objeto @ref{1230,,file object} `fileobj' con un descriptor de archivo. `name' puede ser un objeto @ref{3f0,,path-like object}. Si es proporcionado, `arcname' especifica un nombre alternativo para el archivo en el archivo, de otra forma, el nombre es tomado del atributo `fileobj'’s @ref{297b,,name}, o el argumento `name'. El nombre puede ser una cadena de texto.

Puedes modificar algunos de los atributos de la clase @ref{127e,,TarInfo}’ antes de que lo añadas utilizado el método @ref{163c,,addfile()}. Si el archivo objeto no es un archivo objeto ordinario posicionado al principio del archivo, atributos como @ref{2a16,,size} puede que necesiten modificaciones. Este es el caso para objetos como @ref{4d8,,GzipFile}. El atributo @ref{2a17,,name} también puede ser modificado, en cuyo caso `arcname' podría ser una cadena ficticia.


Distinto en la versión 3.6: El parámetro `name' acepta un objeto @ref{3f0,,path-like object}.

@end deffn

@geindex close() (método de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile close}@anchor{2a18}
@deffn {Método} TarFile.close ()

Cierra @ref{127d,,TarFile}. En el modo de escritura, se añaden dos bloques de cero de finalización al archivo.
@end deffn

@geindex pax_headers (atributo de tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile pax_headers}@anchor{2a19}
@deffn {Atributo} TarFile.pax_headers: @ref{190,,dict}

Un diccionario que contiene pares claves-valor de los encabezados globales pax.
@end deffn

@node Objetos TarInfo,Extraction filters,Objetos TarFile,tarfile — Read and write tar archive files
@anchor{library/tarfile id2}@anchor{2a1a}@anchor{library/tarfile tarinfo-objects}@anchor{29f6}
@subsubsection Objetos TarInfo


Un objeto @ref{127e,,TarInfo} representa un miembro en @ref{127d,,TarFile}. Además de almacenar todos los atributos requeridos de un archivo (como tipo de archivo, tamaño, fecha, permisos, dueño, etc.), provee de algunos métodos útiles para determinar su tipo. No contiene los datos del archivo por si mismo.

@ref{127e,,TarInfo} objects are returned by @ref{127d,,TarFile}’s methods
@ref{185b,,getmember()}, @ref{efc,,getmembers()} and
@ref{2a15,,gettarinfo()}.

Modifying the objects returned by @ref{185b,,getmember()} or
@ref{efc,,getmembers()} will affect all subsequent
operations on the archive.
For cases where this is unwanted, you can use @ref{26,,copy.copy()} or
call the @ref{2a1b,,replace()} method to create a modified copy in one step.

Several attributes can be set to @code{None} to indicate that a piece of metadata
is unused or unknown.
Different @ref{127e,,TarInfo} methods handle @code{None} differently:


@itemize -

@item 
The @ref{efa,,extract()} or @ref{ef9,,extractall()} methods will
ignore the corresponding metadata, leaving it set to a default.

@item 
@ref{163c,,addfile()} will fail.

@item 
@ref{efb,,list()} will print a placeholder string.
@end itemize

@geindex TarInfo (clase en tarfile)
@anchor{library/tarfile tarfile TarInfo}@anchor{127e}
@deffn {Clase} tarfile.TarInfo (name='@w{'})

Crea un objeto @ref{127e,,TarInfo}.
@end deffn

@geindex frombuf() (método de clase de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo frombuf}@anchor{29f2}
@deffn {Método} classmethod TarInfo.frombuf (buf, encoding, errors)

Crea y retorna un objeto @ref{127e,,TarInfo}.

Lanza una excepción @ref{29f1,,HeaderError} si el buffer es invalido.
@end deffn

@geindex fromtarfile() (método de clase de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo fromtarfile}@anchor{2a1c}
@deffn {Método} classmethod TarInfo.fromtarfile (tarfile)

Lee el siguiente miembro del objeto de la clase @ref{127d,,TarFile} `tarfile' y lo retorna como un objeto @ref{127e,,TarInfo}.
@end deffn

@geindex tobuf() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo tobuf}@anchor{2a1d}
@deffn {Método} TarInfo.tobuf (format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')

Crear un `buffer' de cadena a partir de un objeto @ref{127e,,TarInfo}. Para información sobre los argumentos consulta el constructor de la clase @ref{127d,,TarFile}.


Distinto en la versión 3.2: Utiliza @code{'surrogateescape'} como valor predeterminado del argumento `errors'.

@end deffn

Un objeto @code{TarInfo} tiene los siguientes atributos de dato públicos:

@geindex name (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo name}@anchor{2a17}
@deffn {Atributo} TarInfo.name: @ref{237,,str}

Nombre del archivo miembro.
@end deffn

@geindex size (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo size}@anchor{2a16}
@deffn {Atributo} TarInfo.size: @ref{1f0,,int}

Tamaño en bytes.
@end deffn

@geindex mtime (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo mtime}@anchor{2a1e}
@deffn {Atributo} TarInfo.mtime: @ref{1f0,,int} | @ref{153,,float}

Time of last modification in seconds since the @ref{2a1f,,epoch},
as in @ref{2a20,,os.stat_result.st_mtime}.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex mode (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo mode}@anchor{2a21}
@deffn {Atributo} TarInfo.mode: @ref{1f0,,int}

Permission bits, as for @ref{378,,os.chmod()}.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex type (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo type}@anchor{29ff}
@deffn {Atributo} TarInfo.type

Tipo de archivo. `type' es por lo general una de las siguientes constantes: @ref{29fd,,REGTYPE}, @ref{29fe,,AREGTYPE}, @ref{2a00,,LNKTYPE}, @ref{2a01,,SYMTYPE}, @ref{2a04,,DIRTYPE}, @ref{2a05,,FIFOTYPE}, @ref{2a06,,CONTTYPE}, @ref{2a02,,CHRTYPE}, @ref{2a03,,BLKTYPE}, @ref{2a09,,GNUTYPE_SPARSE}. Para determinar el tipo de un objeto @ref{127e,,TarInfo} de forma más conveniente, utiliza los métodos @code{is*()} de abajo.
@end deffn

@geindex linkname (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo linkname}@anchor{2a22}
@deffn {Atributo} TarInfo.linkname: @ref{237,,str}

Nombre del archivo objetivo, el cual solo está presente en los objetos @ref{127e,,TarInfo} de tipo @ref{2a00,,LNKTYPE} y del tipo @ref{2a01,,SYMTYPE}.

For symbolic links (@code{SYMTYPE}), the `linkname' is relative to the directory
that contains the link.
For hard links (@code{LNKTYPE}), the `linkname' is relative to the root of
the archive.
@end deffn

@geindex uid (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo uid}@anchor{2a23}
@deffn {Atributo} TarInfo.uid: @ref{1f0,,int}

ID de usuario que originalmente almacenó este miembro.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex gid (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo gid}@anchor{2a24}
@deffn {Atributo} TarInfo.gid: @ref{1f0,,int}

ID de grupo del usuario que originalmente almacenó este miembro.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex uname (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo uname}@anchor{2a25}
@deffn {Atributo} TarInfo.uname: @ref{237,,str}

Nombre de usuario.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex gname (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo gname}@anchor{2a26}
@deffn {Atributo} TarInfo.gname: @ref{237,,str}

Nombre del grupo.


Distinto en la versión 3.12: Can be set to @code{None} for @ref{efa,,extract()} and
@ref{ef9,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex chksum (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo chksum}@anchor{2a27}
@deffn {Atributo} TarInfo.chksum: @ref{1f0,,int}

Header checksum.
@end deffn

@geindex devmajor (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo devmajor}@anchor{2a28}
@deffn {Atributo} TarInfo.devmajor: @ref{1f0,,int}

Device major number.
@end deffn

@geindex devminor (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo devminor}@anchor{2a29}
@deffn {Atributo} TarInfo.devminor: @ref{1f0,,int}

Device minor number.
@end deffn

@geindex offset (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo offset}@anchor{2a2a}
@deffn {Atributo} TarInfo.offset: @ref{1f0,,int}

The tar header starts here.
@end deffn

@geindex offset_data (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo offset_data}@anchor{2a2b}
@deffn {Atributo} TarInfo.offset_data: @ref{1f0,,int}

The file’s data starts here.
@end deffn

@geindex sparse (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo sparse}@anchor{2a2c}
@deffn {Atributo} TarInfo.sparse

Sparse member information.
@end deffn

@geindex pax_headers (atributo de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo pax_headers}@anchor{2a2d}
@deffn {Atributo} TarInfo.pax_headers: @ref{190,,dict}

Un diccionario que contiene pares `key-value' de un encabezado `pax extended'.
@end deffn

@geindex replace() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo replace}@anchor{2a1b}
@deffn {Método} TarInfo.replace (name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)


Added in version 3.12.


Return a `new' copy of the @code{TarInfo} object with the given attributes
changed. For example, to return a @code{TarInfo} with the group name set to
@code{'staff'}, use:

@example
new_tarinfo = old_tarinfo.replace(gname='staff')
@end example

By default, a deep copy is made.
If `deep' is false, the copy is shallow, i.e. @code{pax_headers}
and any custom attributes are shared with the original @code{TarInfo} object.
@end deffn

Un objeto @ref{127e,,TarInfo} también provee de algunos métodos de consulta convenientes:

@geindex isfile() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isfile}@anchor{2a2e}
@deffn {Método} TarInfo.isfile ()

Return @ref{c95,,True} if the @ref{127e,,TarInfo} object is a regular file.
@end deffn

@geindex isreg() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isreg}@anchor{2a2f}
@deffn {Método} TarInfo.isreg ()

Igual que @ref{2a2e,,isfile()}.
@end deffn

@geindex isdir() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isdir}@anchor{2a30}
@deffn {Método} TarInfo.isdir ()

Retorna @ref{c95,,True} si es un directorio.
@end deffn

@geindex issym() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo issym}@anchor{2a31}
@deffn {Método} TarInfo.issym ()

Retorna @ref{c95,,True} si es un enlace simbólico.
@end deffn

@geindex islnk() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo islnk}@anchor{2a32}
@deffn {Método} TarInfo.islnk ()

Retorna @ref{c95,,True} si es un enlace duro.
@end deffn

@geindex ischr() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo ischr}@anchor{2a33}
@deffn {Método} TarInfo.ischr ()

Retorna @ref{c95,,True} si es un dispositivo de caracter.
@end deffn

@geindex isblk() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isblk}@anchor{2a34}
@deffn {Método} TarInfo.isblk ()

Retorna @ref{c95,,True} si es un dispositivo de bloque.
@end deffn

@geindex isfifo() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isfifo}@anchor{2a35}
@deffn {Método} TarInfo.isfifo ()

Retorna @ref{c95,,True} si es un FIFO.
@end deffn

@geindex isdev() (método de tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isdev}@anchor{2a36}
@deffn {Método} TarInfo.isdev ()

Retorna @ref{c95,,True} si es uno de los caracteres de dispositivo, dispositivo de bloque o FIFO.
@end deffn

@node Extraction filters,Interfaz de línea de comandos<2>,Objetos TarInfo,tarfile — Read and write tar archive files
@anchor{library/tarfile extraction-filters}@anchor{2a37}@anchor{library/tarfile tarfile-extraction-filter}@anchor{517}
@subsubsection Extraction filters



Added in version 3.12.


The `tar' format is designed to capture all details of a UNIX-like filesystem,
which makes it very powerful.
Unfortunately, the features make it easy to create tar files that have
unintended – and possibly malicious – effects when extracted.
For example, extracting a tar file can overwrite arbitrary files in various
ways (e.g.  by using absolute paths, @code{..} path components, or symlinks that
affect later members).

In most cases, the full functionality is not needed.
Therefore, `tarfile' supports extraction filters: a mechanism to limit
functionality, and thus mitigate some of the security issues.

@cartouche
@quotation Advertencia 
None of the available filters blocks `all' dangerous archive features.
Never extract archives from untrusted sources without prior inspection.
See also @ref{286f,,Hints for further verification}.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 706

@item PEP 706@footnote{https://peps.python.org/pep-0706/}

Contains further motivation and rationale behind the design.
@end table


The `filter' argument to @ref{efa,,TarFile.extract()} or @ref{ef9,,extractall()}
can be:


@itemize *

@item 
the string @code{'fully_trusted'}: Honor all metadata as specified in the
archive.
Should be used if the user trusts the archive completely, or implements
their own complex verification.

@item 
the string @code{'tar'}: Honor most `tar'-specific features (i.e. features of
UNIX-like filesystems), but block features that are very likely to be
surprising or malicious. See @ref{2a38,,tar_filter()} for details.

@item 
the string @code{'data'}: Ignore or block most features specific to UNIX-like
filesystems. Intended for extracting cross-platform data archives.
See @ref{1615,,data_filter()} for details.

@item 
@code{None} (default): Use @ref{2a14,,TarFile.extraction_filter}.

If that is also @code{None} (the default), the @code{'data'} filter will be used.

@quotation


Distinto en la versión 3.14: The default filter is set to @ref{1615,,data}.
Previously, the default was equivalent to
@ref{29e8,,fully_trusted}.

@end quotation

@item 
A callable which will be called for each extracted member with a
@ref{29f6,,TarInfo} describing the member and the destination
path to where the archive is extracted (i.e. the same path is used for all
members):

@example
filter(member: TarInfo, path: str, /) -> TarInfo | None
@end example

The callable is called just before each member is extracted, so it can
take the current state of the disk into account.
It can:


@itemize -

@item 
return a @ref{127e,,TarInfo} object which will be used instead of the metadata
in the archive, or

@item 
return @code{None}, in which case the member will be skipped, or

@item 
raise an exception to abort the operation or skip the member,
depending on @ref{29f0,,errorlevel}.
Note that when extraction is aborted, @ref{ef9,,extractall()} may leave
the archive partially extracted. It does not attempt to clean up.
@end itemize
@end itemize

@menu
* Default named filters:: 
* Filter errors:: 
* Hints for further verification:: 
* Supporting older Python versions:: 
* Stateful extraction filter example:: 

@end menu

@node Default named filters,Filter errors,,Extraction filters
@anchor{library/tarfile default-named-filters}@anchor{2a39}
@subsubsection Default named filters


The pre-defined, named filters are available as functions, so they can be
reused in custom filters:

@geindex fully_trusted_filter() (en el módulo tarfile)
@anchor{library/tarfile tarfile fully_trusted_filter}@anchor{29e8}
@deffn {Función} tarfile.fully_trusted_filter (member, path)

Return `member' unchanged.

This implements the @code{'fully_trusted'} filter.
@end deffn

@geindex tar_filter() (en el módulo tarfile)
@anchor{library/tarfile tarfile tar_filter}@anchor{2a38}
@deffn {Función} tarfile.tar_filter (member, path)

Implements the @code{'tar'} filter.


@itemize -

@item 
Strip leading slashes (@code{/} and @ref{70b,,os.sep}) from filenames.

@item 
@ref{29f4,,Refuse} to extract files with absolute
paths (in case the name is absolute
even after stripping slashes, e.g. @code{C:/foo} on Windows).
This raises @ref{29f7,,AbsolutePathError}.

@item 
@ref{29f4,,Refuse} to extract files whose absolute
path (after following symlinks) would end up outside the destination.
This raises @ref{29f8,,OutsideDestinationError}.

@item 
Clear high mode bits (setuid, setgid, sticky) and group/other write bits
(@ref{27fe,,S_IWGRP} | @ref{2801,,S_IWOTH}).
@end itemize

Return the modified @code{TarInfo} member.
@end deffn

@geindex data_filter() (en el módulo tarfile)
@anchor{library/tarfile tarfile data_filter}@anchor{1615}
@deffn {Función} tarfile.data_filter (member, path)

Implements the @code{'data'} filter.
In addition to what @code{tar_filter} does:


@itemize -

@item 
@ref{29f4,,Refuse} to extract links (hard or soft)
that link to absolute paths, or ones that link outside the destination.

This raises @ref{29fa,,AbsoluteLinkError} or
@ref{29fb,,LinkOutsideDestinationError}.

Note that such files are refused even on platforms that do not support
symbolic links.

@item 
@ref{29f4,,Refuse} to extract device files
(including pipes).
This raises @ref{29f9,,SpecialFileError}.

@item 
For regular files, including hard links:


@itemize -

@item 
Set the owner read and write permissions
(@ref{27f9,,S_IRUSR} | @ref{27fa,,S_IWUSR}).

@item 
Remove the group & other executable permission
(@ref{27f5,,S_IXGRP} | @ref{2802,,S_IXOTH})
if the owner doesn’t have it (@ref{27fb,,S_IXUSR}).
@end itemize

@item 
For other files (directories), set @code{mode} to @code{None}, so
that extraction methods skip applying permission bits.

@item 
Set user and group info (@code{uid}, @code{gid}, @code{uname}, @code{gname})
to @code{None}, so that extraction methods skip setting it.
@end itemize

Return the modified @code{TarInfo} member.

Note that this filter does not block `all' dangerous archive features.
See @ref{286f,,Hints for further verification}  for details.
@end deffn

@node Filter errors,Hints for further verification,Default named filters,Extraction filters
@anchor{library/tarfile filter-errors}@anchor{2a3a}@anchor{library/tarfile tarfile-extraction-refuse}@anchor{29f4}
@subsubsection Filter errors


When a filter refuses to extract a file, it will raise an appropriate exception,
a subclass of @ref{29f3,,FilterError}.
This will abort the extraction if @ref{29f0,,TarFile.errorlevel} is 1 or more.
With @code{errorlevel=0} the error will be logged and the member will be skipped,
but extraction will continue.

@node Hints for further verification,Supporting older Python versions,Filter errors,Extraction filters
@anchor{library/tarfile hints-for-further-verification}@anchor{2a3b}@anchor{library/tarfile tarfile-further-verification}@anchor{286f}
@subsubsection Hints for further verification


Even with @code{filter='data'}, `tarfile' is not suited for extracting untrusted
files without prior inspection.
Among other issues, the pre-defined filters do not prevent denial-of-service
attacks. Users should do additional checks.

Here is an incomplete list of things to consider:


@itemize *

@item 
Extract to a @ref{37c,,new temporary directory}
to prevent e.g. exploiting pre-existing links, and to make it easier to
clean up after a failed extraction.

@item 
When working with untrusted data, use external (e.g. OS-level) limits on
disk, memory and CPU usage.

@item 
Check filenames against an allow-list of characters
(to filter out control characters, confusables, foreign path separators,
and so on).

@item 
Check that filenames have expected extensions (discouraging files that
execute when you “click on them”, or extension-less files like Windows
special device names).

@item 
Limit the number of extracted files, total size of extracted data,
filename length (including symlink length), and size of individual files.

@item 
Check for files that would be shadowed on case-insensitive filesystems.
@end itemize

Also note that:


@itemize *

@item 
Tar files may contain multiple versions of the same file.
Later ones are expected to overwrite any earlier ones.
This feature is crucial to allow updating tape archives, but can be abused
maliciously.

@item 
`tarfile' does not protect against issues with “live” data,
e.g. an attacker tinkering with the destination (or source) directory while
extraction (or archiving) is in progress.
@end itemize

@node Supporting older Python versions,Stateful extraction filter example,Hints for further verification,Extraction filters
@anchor{library/tarfile supporting-older-python-versions}@anchor{2a3c}
@subsubsection Supporting older Python versions


Extraction filters were added to Python 3.12, but may be backported to older
versions as security updates.
To check whether the feature is available, use e.g.
@code{hasattr(tarfile, 'data_filter')} rather than checking the Python version.

The following examples show how to support Python versions with and without
the feature.
Note that setting @code{extraction_filter} will affect any subsequent operations.


@itemize *

@item 
Fully trusted archive:

@example
my_tarfile.extraction_filter = (lambda member, path: member)
my_tarfile.extractall()
@end example

@item 
Use the @code{'data'} filter if available, but revert to Python 3.11 behavior
(@code{'fully_trusted'}) if this feature is not available:

@example
my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',
                                       (lambda member, path: member))
my_tarfile.extractall()
@end example

@item 
Use the @code{'data'} filter; `fail' if it is not available:

@example
my_tarfile.extractall(filter=tarfile.data_filter)
@end example

or:

@example
my_tarfile.extraction_filter = tarfile.data_filter
my_tarfile.extractall()
@end example

@item 
Use the @code{'data'} filter; `warn' if it is not available:

@example
if hasattr(tarfile, 'data_filter'):
    my_tarfile.extractall(filter='data')
else:
    # remove this when no longer needed
    warn_the_user('Extracting may be unsafe; consider updating Python')
    my_tarfile.extractall()
@end example
@end itemize

@node Stateful extraction filter example,,Supporting older Python versions,Extraction filters
@anchor{library/tarfile stateful-extraction-filter-example}@anchor{2a3d}
@subsubsection Stateful extraction filter example


While `tarfile'’s extraction methods take a simple `filter' callable,
custom filters may be more complex objects with an internal state.
It may be useful to write these as context managers, to be used like this:

@example
with StatefulFilter() as filter_func:
    tar.extractall(path, filter=filter_func)
@end example

Such a filter can be written as, for example:

@example
class StatefulFilter:
    def __init__(self):
        self.file_count = 0

    def __enter__(self):
        return self

    def __call__(self, member, path):
        self.file_count += 1
        return member

    def __exit__(self, *exc_info):
        print(f'@{self.file_count@} files extracted')
@end example

@node Interfaz de línea de comandos<2>,Ejemplos<8>,Extraction filters,tarfile — Read and write tar archive files
@anchor{library/tarfile command-line-interface}@anchor{2a3e}@anchor{library/tarfile tarfile-commandline}@anchor{104a}
@subsubsection Interfaz de línea de comandos



Added in version 3.4.


El módulo @ref{de,,tarfile} provee una interfaz de línea de comandos sencilla para interactuar con archivos tar.

Si quieres crear un nuevo archivo tar, especifica su nombre después de la opción @ref{2a3f,,-c} y después lista el nombre de archivo(s) que deberían ser incluidos:

@example
$ python -m tarfile -c monty.tar  spam.txt eggs.txt
@end example

Proporcionar un directorio también es aceptable:

@example
$ python -m tarfile -c monty.tar life-of-brian_1979/
@end example

Si deseas extraer un archivo tar en el directorio actual, utiliza la opción @ref{2a40,,-e}:

@example
$ python -m tarfile -e monty.tar
@end example

También puedes extraer un archivo tar en un directorio diferente pasando el nombre del directorio como parámetro:

@example
$ python -m tarfile -e monty.tar  other-dir/
@end example

Para obtener una lista de archivos dentro de un archivo tar, utiliza la opción  @ref{2a41,,-l}:

@example
$ python -m tarfile -l monty.tar
@end example

@menu
* Opciones de línea de comandos: Opciones de línea de comandos<2>. 

@end menu

@node Opciones de línea de comandos<2>,,,Interfaz de línea de comandos<2>
@anchor{library/tarfile command-line-options}@anchor{2a42}
@subsubsection Opciones de línea de comandos


@geindex opción de línea de comando tarfile; -l
@geindex opción de línea de comando tarfile; --list
@anchor{library/tarfile cmdoption-tarfile-l}@anchor{2a41}
@deffn {Option} @w{-}l <tarfile>
@anchor{library/tarfile cmdoption-tarfile-list}@anchor{2a43}
@deffnx {Option} @w{-}@w{-}list <tarfile>

Listar archivos en un tar.
@end deffn

@geindex opción de línea de comando tarfile; -c
@geindex opción de línea de comando tarfile; --create
@anchor{library/tarfile cmdoption-tarfile-c}@anchor{2a3f}
@deffn {Option} @w{-}c <tarfile> <source1> ... <sourceN>
@anchor{library/tarfile cmdoption-tarfile-create}@anchor{2a44}
@deffnx {Option} @w{-}@w{-}create <tarfile> <source1> ... <sourceN>

Crear archivo tar desde archivos fuente.
@end deffn

@geindex opción de línea de comando tarfile; -e
@geindex opción de línea de comando tarfile; --extract
@anchor{library/tarfile cmdoption-tarfile-e}@anchor{2a40}
@deffn {Option} @w{-}e <tarfile> [<output_dir>]
@anchor{library/tarfile cmdoption-tarfile-extract}@anchor{2a45}
@deffnx {Option} @w{-}@w{-}extract <tarfile> [<output_dir>]

Extrae el archivo tar en el directorio actual si `output_dir' no es especificado.
@end deffn

@geindex opción de línea de comando tarfile; -t
@geindex opción de línea de comando tarfile; --test
@anchor{library/tarfile cmdoption-tarfile-t}@anchor{2a46}
@deffn {Option} @w{-}t <tarfile>
@anchor{library/tarfile cmdoption-tarfile-test}@anchor{2a47}
@deffnx {Option} @w{-}@w{-}test <tarfile>

Probar si el archivo tar es valido o no.
@end deffn

@geindex opción de línea de comando tarfile; -v
@geindex opción de línea de comando tarfile; --verbose
@anchor{library/tarfile cmdoption-tarfile-v}@anchor{2a48}@anchor{library/tarfile cmdoption-tarfile-verbose}@anchor{2a49}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

Output `verbose'.
@end deffn

@geindex opción de línea de comando tarfile; --filter
@anchor{library/tarfile cmdoption-tarfile-filter}@anchor{2a4a}
@deffn {Option} @w{-}@w{-}filter <filtername>

Specifies the `filter' for @code{--extract}.
See @ref{517,,Extraction filters} for details.
Only string names are accepted (that is, @code{fully_trusted}, @code{tar},
and @code{data}).
@end deffn

@node Ejemplos<8>,Formatos tar con soporte,Interfaz de línea de comandos<2>,tarfile — Read and write tar archive files
@anchor{library/tarfile examples}@anchor{2a4b}@anchor{library/tarfile tar-examples}@anchor{29ec}
@subsubsection Ejemplos


Cómo extraer un archivo tar entero al directorio de trabajo actual:

@example
import tarfile
tar = tarfile.open("sample.tar.gz")
tar.extractall(filter='data')
tar.close()
@end example

Cómo extraer un subconjunto de un archivo tar con @ref{ef9,,TarFile.extractall()} utilizando una función generadora en lugar de una lista:

@example
import os
import tarfile

def py_files(members):
    for tarinfo in members:
        if os.path.splitext(tarinfo.name)[1] == ".py":
            yield tarinfo

tar = tarfile.open("sample.tar.gz")
tar.extractall(members=py_files(tar))
tar.close()
@end example

Cómo crear un archivo tar sin comprimir desde una lista de nombres de archivo:

@example
import tarfile
tar = tarfile.open("sample.tar", "w")
for name in ["foo", "bar", "quux"]:
    tar.add(name)
tar.close()
@end example

El mismo ejemplo utilizando la declaración @ref{673,,with}:

@example
import tarfile
with tarfile.open("sample.tar", "w") as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)
@end example

Cómo leer un archivo tar comprimido con gzip y desplegar un poco de información del miembro:

@example
import tarfile
tar = tarfile.open("sample.tar.gz", "r:gz")
for tarinfo in tar:
    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")
    if tarinfo.isreg():
        print("a regular file.")
    elif tarinfo.isdir():
        print("a directory.")
    else:
        print("something else.")
tar.close()
@end example

Cómo crear un archivo y reiniciar la información del usuario usando el parámetro `filter' en @ref{c7b,,TarFile.add()}:

@example
import tarfile
def reset(tarinfo):
    tarinfo.uid = tarinfo.gid = 0
    tarinfo.uname = tarinfo.gname = "root"
    return tarinfo
tar = tarfile.open("sample.tar.gz", "w:gz")
tar.add("foo", filter=reset)
tar.close()
@end example

@node Formatos tar con soporte,Problemas unicode,Ejemplos<8>,tarfile — Read and write tar archive files
@anchor{library/tarfile supported-tar-formats}@anchor{2a4c}@anchor{library/tarfile tar-formats}@anchor{2a0a}
@subsubsection Formatos tar con soporte


Hay tres formatos tar que puede ser creados con el módulo @ref{de,,tarfile}:


@itemize *

@item 
El formato (@ref{2a0b,,USTAR_FORMAT}) POSIX.1-1988 ustar. Admite nombres de archivos de hasta una longitud de 256 caracteres y nombres de enlace de hasta 100 caracteres. El tamaño máximo de archivo es de 8 GiB. Este es un formato viejo y limitado pero con amplio soporte.

@item 
El formato GNU tar (@ref{2a0c,,GNU_FORMAT}). Admite nombres de archivo largos y nombres de enlace, archivos más grandes que 8 GiB de tamaño y archivos dispersos. Es el estándar `de facto' en sistemas GNU/Linux. @ref{de,,tarfile} admite de forma completa las extensiones de GNU tar para nombres largos, el soporte para archivos dispersos es de solo lectura.

@item 
The POSIX.1-2001 pax format (@ref{2a0d,,PAX_FORMAT}). It is the most flexible
format with virtually no limits. It supports long filenames and linknames, large
files and stores pathnames in a portable way. Modern tar implementations,
including GNU tar, bsdtar/libarchive and star, fully support extended `pax'
features; some old or unmaintained libraries may not, but should treat
`pax' archives as if they were in the universally supported `ustar' format.
It is the current default format for new archives.

Extiende el formato existente `ustar' con cabeceras adicionales para información que no puede ser almacenada de otra manera. Hay dos variaciones de encabezados pax: Los encabezados extendidos solo afectan al encabezado del archivo posterior, las encabezados globales son validos para el archivo entero y afectan todos los siguientes archivos. Todos los datos en un encabezado pax son codificados en `UTF-8' por razones de portabilidad.
@end itemize

Existen más variantes del formato tar que puede ser leídas, pero no creadas:


@itemize *

@item 
El antiguo formato V7. Este es el primer formato tar de `Unix Seventh Edition', almacena solo archivos y directorios normales. Los nombres no deben tener más de 100 caracteres, no hay información de nombre de usuario/grupo disponible. Algunos archivos tienen sumas de comprobación de encabezado mal calculadas en el caso de campos con caracteres que no son ASCII.

@item 
El formato extendido tar de SunOS. Este formato es una variante del formato POSIX.1-2001 pax, pero no es compatible.
@end itemize

@node Problemas unicode,,Formatos tar con soporte,tarfile — Read and write tar archive files
@anchor{library/tarfile tar-unicode}@anchor{2a10}@anchor{library/tarfile unicode-issues}@anchor{2a4d}
@subsubsection Problemas unicode


El formato tar fue originalmente concebido para realizar respaldos en unidades de cinta con el objetivo principal de preservar la información del sistema de archivos. Hoy en día los archivos tar son comúnmente utilizados para distribución de archivos e intercambio de archivos sobre redes. Un problema del formato original (el cual es la base de todos los demás formatos) es que no hay concepto de soporte para diferentes codificaciones de caracteres. Por ejemplo, un archivo tar ordinario creado en un sistema `UTF-8' no puede ser leído correctamente en un sistema `Latin-1' si este contiene caracteres de tipo no ASCII. Los meta-datos textuales (como nombres de archivos, nombres de enlace, nombres de usuario/grupo) aparecerán dañados. Desafortunadamente, no hay manera de detectar de forma automática la codificación de un archivo. El formato `pax' fue diseñado para resolver este problema. Almacena los metadatos no ASCII usando una codificación de caracteres universal `UTF-8'.

Los detalles de la conversión de caracteres en el módulo @ref{de,,tarfile} son controlados por los argumentos de palabra clave `encoding' y `errors' de la clase @ref{127d,,TarFile}.

`encoding' define la codificación de caracteres a utilizar para los metadatos del archivo. El valor predeterminado es @ref{ce1,,sys.getfilesystemencoding()} o @code{'ascii'} como una alternativa. Dependiendo de si el archivo se lee o escribe, los metadatos deben decodificarse o codificarse. Si el `encoding' no se configura correctamente, esta conversión puede fallar.

El argumento `errors' define como van a ser tratados los caracteres que no pueden ser transformados. Los valores admitidos están listados en la sección @ref{17ed,,Manejadores de errores}. El esquema predeterminado es @code{'surrogateescape'} el cual Python también utiliza para sus llamadas al sistema de archivos. Consulta @ref{2a4e,,Nombres de archivos@comma{} argumentos de la línea de comandos y variables de entorno}.

Para archivos @ref{2a0d,,PAX_FORMAT} (el formato default), el `encoding' generalmente no es necesario porque todos los meta-datos son almacenados utilizando `UTF-8', el `encoding' solo es utilizado en aquellos casos cuando las cabeceras binarias PAX son decodificadas o cuando se almacenan cadenas de texto con caracteres sustitutos.

@node Formatos de archivo,Servicios criptográficos,Compresión de datos y archivado,La biblioteca estándar de Python
@anchor{library/fileformats doc}@anchor{2a4f}@anchor{library/fileformats file-formats}@anchor{2a50}@anchor{library/fileformats fileformats}@anchor{2a51}
@section Formatos de archivo


Los módulos descritos en este capítulo analizan varios formatos de archivo que no son lenguajes de marcado y no están relacionados con el correo electrónico.

@menu
* csv — CSV File Reading and Writing:: 
* configparser — Configuration file parser:: 
* tomllib — Parse TOML files:: 
* netrc — netrc file processing:: 
* plistlib — Generate and parse Apple .plist files: plistlib — Generate and parse Apple plist files. 

@end menu

@node csv — CSV File Reading and Writing,configparser — Configuration file parser,,Formatos de archivo
@anchor{library/csv doc}@anchor{2a52}@anchor{library/csv csv-csv-file-reading-and-writing}@anchor{2a53}@anchor{library/csv module-csv}@anchor{2a}
@subsection @code{csv} — CSV File Reading and Writing


@geindex module; csv

`Código fuente:' Lib/csv.py@footnote{https://github.com/python/cpython/tree/main/Lib/csv.py}

@geindex csv
@geindex data;tabular


__________________________________________________________________


El tan llamado CSV (Valores Separados por Comas) es el formato más común de importación y exportación de hojas de cálculo y bases de datos. El formato CSV se utilizó durante muchos años antes de intentar describir el formato de manera estandarizada en 
@geindex RFC; RFC 4180
RFC 4180@footnote{https://datatracker.ietf.org/doc/html/rfc4180.html}. La falta de un estándar bien definido significa que a veces existen pequeñas diferencias en la información producida y consumida por diferentes aplicaciones. Estas diferencias pueden ser molestas al momento de procesar archivos CSV desde múltiples fuentes. Aún así, aunque los delimitadores y separadores varíen, el formato general es lo suficientemente similar como para que sea posible un sólo módulo que puede manipular tal información eficientemente, escondiendo los detalles de lectura y escritura de datos del programador.

El módulo @ref{2a,,csv} implementa clases para leer y escribir datos tabulares en formato CSV. Permite a los programadores decir, «escribe estos datos en el formato preferido por Excel», o «lee datos de este archivo que fue generado por Excel», sin conocer los detalles precisos del formato CSV usado por Excel. Los programadores también pueden describir los formatos CSV entendidos por otras aplicaciones o definir sus propios formatos CSV para fines particulares.

Los objetos @ref{52f,,reader} y @ref{530,,writer} del módulo @ref{2a,,csv} leen y escriben secuencias. Los programadores también pueden leer y escribir datos en forma de diccionario usando las clases @ref{a77,,DictReader} y @ref{126b,,DictWriter}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - API de archivo CSV

La Propuesta de Mejora de Python (PEP, por sus siglas en inglés) que propone esta adición a Python.
@end table


@menu
* Contenidos del módulo: Contenidos del módulo<2>. 
* Dialectos y parámetros de formato:: 
* Objetos Reader:: 
* Objetos Writer:: 
* Ejemplos: Ejemplos<9>. 

@end menu

@node Contenidos del módulo<2>,Dialectos y parámetros de formato,,csv — CSV File Reading and Writing
@anchor{library/csv csv-contents}@anchor{2a54}@anchor{library/csv module-contents}@anchor{2a55}
@subsubsection Contenidos del módulo


El módulo @ref{2a,,csv} define las siguientes funciones:

@geindex universal newlines;csv.reader function

@geindex reader() (en el módulo csv)
@anchor{library/csv csv reader}@anchor{52f}
@deffn {Función} csv.reader (csvfile, dialect='excel', **fmtparams)

Return a @ref{2a56,,reader object} that will process
lines from the given `csvfile'.  A csvfile must be an iterable of
strings, each in the reader’s defined csv format.
A csvfile is most commonly a file-like object or list.
If `csvfile' is a file object,
it should be opened with @code{newline='@w{'}}. @footnote{
Si @code{newline='@w{'}} no es especificado, las nuevas líneas dentro de los campos citados no serán interpretadas correctamente y, en plataformas que utilicen finales de línea @code{\r\n} en la escritura, se añadirá un @code{\r} extra. Siempre debería ser seguro especificar @code{newline='@w{'}}, ya que el módulo csv realiza su propio manejo de nuevas líneas (@ref{dc1,,universal}).
}  An optional
`dialect' parameter can be given which is used to define a set of parameters
specific to a particular CSV dialect.  It may be an instance of a subclass of
the @ref{1686,,Dialect} class or one of the strings returned by the
@ref{1810,,list_dialects()} function.  The other optional `fmtparams' keyword arguments
can be given to override individual formatting parameters in the current
dialect.  For full details about the dialect and formatting parameters, see
section @ref{2a57,,Dialectos y parámetros de formato}.

Cada fila leída del archivo csv es retornada como una lista de cadenas. No se realiza conversión automática de tipo de datos a menos que la opción de formato @code{QUOTE_NONNUMERIC} esté especificada (en ese caso los campos no citados son transformados en flotantes).

Un pequeño ejemplo de uso:

@example
>>> import csv
>>> with open('eggs.csv', newline='@w{'}) as csvfile:
...     spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|')
...     for row in spamreader:
...         print(', '.join(row))
Spam, Spam, Spam, Spam, Spam, Baked Beans
Spam, Lovely Spam, Wonderful Spam
@end example
@end deffn

@geindex writer() (en el módulo csv)
@anchor{library/csv csv writer}@anchor{530}
@deffn {Función} csv.writer (csvfile, dialect='excel', **fmtparams)

Return a writer object responsible for converting the user’s data into delimited
strings on the given file-like object.  `csvfile' can be any object with a
@ref{1c7a,,write()} method.  If `csvfile' is a file object, it should be opened with
@code{newline='@w{'}} @footnote{
Si @code{newline='@w{'}} no es especificado, las nuevas líneas dentro de los campos citados no serán interpretadas correctamente y, en plataformas que utilicen finales de línea @code{\r\n} en la escritura, se añadirá un @code{\r} extra. Siempre debería ser seguro especificar @code{newline='@w{'}}, ya que el módulo csv realiza su propio manejo de nuevas líneas (@ref{dc1,,universal}).
}.  An optional `dialect'
parameter can be given which is used to define a set of parameters specific to a
particular CSV dialect.  It may be an instance of a subclass of the
@ref{1686,,Dialect} class or one of the strings returned by the
@ref{1810,,list_dialects()} function.  The other optional `fmtparams' keyword arguments
can be given to override individual formatting parameters in the current
dialect.  For full details about dialects and formatting parameters, see
the @ref{2a57,,Dialectos y parámetros de formato} section. To make it
as easy as possible to interface with modules which implement the DB API, the
value @ref{716,,None} is written as the empty string.  While this isn’t a
reversible transformation, it makes it easier to dump SQL NULL data values to
CSV files without preprocessing the data returned from a @code{cursor.fetch*} call.
All other non-string data are stringified with @ref{237,,str()} before being written.

Un pequeño ejemplo de uso:

@example
import csv
with open('eggs.csv', 'w', newline='@w{'}) as csvfile:
    spamwriter = csv.writer(csvfile, delimiter=' ',
                            quotechar='|', quoting=csv.QUOTE_MINIMAL)
    spamwriter.writerow(['Spam'] * 5 + ['Baked Beans'])
    spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])
@end example
@end deffn

@geindex register_dialect() (en el módulo csv)
@anchor{library/csv csv register_dialect}@anchor{15d0}
@deffn {Función} csv.register_dialect (name[, dialect[, **fmtparams]])

Asocie `dialect' con `name'. `name' debe ser una cadena. El dialecto se puede especificar pasando una subclase de @ref{1686,,Dialect}, o mediante argumentos de palabra clave `fmtparams', o ambos, con argumentos de palabra clave que anulan los parámetros del dialecto. Para obtener detalles completos sobre dialectos y parámetros de formato, consulte la sección @ref{2a57,,Dialectos y parámetros de formato}.
@end deffn

@geindex unregister_dialect() (en el módulo csv)
@anchor{library/csv csv unregister_dialect}@anchor{180f}
@deffn {Función} csv.unregister_dialect (name)

Borra el dialecto asociado a `name' del registro de dialectos. Un @ref{2a58,,Error} es lanzado si `name' no está registrado como el nombre de un dialecto.
@end deffn

@geindex get_dialect() (en el módulo csv)
@anchor{library/csv csv get_dialect}@anchor{180e}
@deffn {Función} csv.get_dialect (name)

Retorna el dialecto asociado a `name'.  Un @ref{2a58,,Error} es lanzado si `name' no está registrado como el nombre de un dialecto.  Esta función retorna un objeto @ref{1686,,Dialect} inmutable.
@end deffn

@geindex list_dialects() (en el módulo csv)
@anchor{library/csv csv list_dialects}@anchor{1810}
@deffn {Función} csv.list_dialects ()

Retorna los nombres de todos los dialectos registrados.
@end deffn

@geindex field_size_limit() (en el módulo csv)
@anchor{library/csv csv field_size_limit}@anchor{180d}
@deffn {Función} csv.field_size_limit ([new_limit])

Retorna el tamaño máximo de campo permitido actualmente por el intérprete. Si `new_limit' es dado, este se convierte en el nuevo límite.
@end deffn

El módulo @ref{2a,,csv} define las siguientes clases:

@geindex DictReader (clase en csv)
@anchor{library/csv csv DictReader}@anchor{a77}
@deffn {Clase} csv.DictReader (f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)

Crea un objeto que opera como un `reader' común, pero mapea la información en cada fila a un @ref{190,,dict} cuyas claves son provistas en el parámetro opcional `fieldnames'.

The `fieldnames' parameter is a @ref{597,,sequence}.  If `fieldnames' is
omitted, the values in the first row of file `f' will be used as the
fieldnames and will be omitted from the results. If
`fieldnames' is provided, they will be used and the first row will be
included in the results.  Regardless of how the fieldnames are determined,
the dictionary preserves their original ordering.

Si una fila tiene más campos que nombres de campo, los datos restantes son colocados en una lista y guardados con el nombre de campo especificado por `restkey' (que por defecto es @code{None}). Si una fila que no esta en blanco tiene menos campos que nombres de campo, los valores faltantes son rellenados con el valor de `restval' (que por defecto es @code{None}).

Todos los demás argumentos de palabra clave u opcionales son pasados a la instancia subyacente de @ref{52f,,reader}.

Si el argumento pasado a `fieldnames' es un iterador, sera forzado a una @ref{18e,,list}.


Distinto en la versión 3.6: Las filas retornadas son ahora de tipo @code{OrderedDict}.



Distinto en la versión 3.8: Las filas retornadas son ahora de tipo @ref{190,,dict}.


Un pequeño ejemplo de uso:

@example
>>> import csv
>>> with open('names.csv', newline='@w{'}) as csvfile:
...     reader = csv.DictReader(csvfile)
...     for row in reader:
...         print(row['first_name'], row['last_name'])
...
Eric Idle
John Cleese

>>> print(row)
@{'first_name': 'John', 'last_name': 'Cleese'@}
@end example
@end deffn

@geindex DictWriter (clase en csv)
@anchor{library/csv csv DictWriter}@anchor{126b}
@deffn {Clase} csv.DictWriter (f, fieldnames, restval='@w{'}, extrasaction='raise', dialect='excel', *args, **kwds)

Create an object which operates like a regular writer but maps dictionaries
onto output rows.  The `fieldnames' parameter is a @ref{1f,,sequence} of keys that identify the order in which values in the
dictionary passed to the @ref{e6f,,writerow()} method are written to file
`f'.  The optional `restval' parameter specifies the value to be
written if the dictionary is missing a key in `fieldnames'.  If the
dictionary passed to the @ref{e6f,,writerow()} method contains a key not found in
`fieldnames', the optional `extrasaction' parameter indicates what action to
take.
If it is set to @code{'raise'}, the default value, a @ref{360,,ValueError}
is raised.
If it is set to @code{'ignore'}, extra values in the dictionary are ignored.
Any other optional or keyword arguments are passed to the underlying
@ref{530,,writer} instance.

Nótese que a diferencia de la clase @ref{a77,,DictReader}, el parámetro `fieldnames' de la clase @ref{126b,,DictWriter} no es opcional.

Si el argumento pasado a `fieldnames' es un iterador, sera forzado a una @ref{18e,,list}.

Un pequeño ejemplo de uso:

@example
import csv

with open('names.csv', 'w', newline='@w{'}) as csvfile:
    fieldnames = ['first_name', 'last_name']
    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

    writer.writeheader()
    writer.writerow(@{'first_name': 'Baked', 'last_name': 'Beans'@})
    writer.writerow(@{'first_name': 'Lovely', 'last_name': 'Spam'@})
    writer.writerow(@{'first_name': 'Wonderful', 'last_name': 'Spam'@})
@end example
@end deffn

@geindex Dialect (clase en csv)
@anchor{library/csv csv Dialect}@anchor{1686}
@deffn {Clase} csv.Dialect

La clase @ref{1686,,Dialect} es una clase contenedora cuyos atributos contienen información sobre cómo manejar las comillas dobles, los espacios en blanco, los delimitadores, etc. Debido a la falta de una especificación estricta de CSV, diferentes aplicaciones producen datos CSV sutilmente diferentes. Las instancias de @ref{1686,,Dialect} definen cómo se comportan las instancias de @ref{52f,,reader} y @ref{530,,writer}.

Todos los nombres disponibles de @ref{1686,,Dialect} son retornados por @ref{1810,,list_dialects()}, y pueden ser registrados con clases específicas de @ref{52f,,reader} y @ref{530,,writer} a través de sus funciones que inician (@code{__init__}) así:

@example
import csv

with open('students.csv', 'w', newline='@w{'}) as csvfile:
    writer = csv.writer(csvfile, dialect='unix')
@end example
@end deffn

@geindex excel (clase en csv)
@anchor{library/csv csv excel}@anchor{2a59}
@deffn {Clase} csv.excel

La clase @ref{2a59,,excel} define las propiedades usuales de un archivo CSV generado por Excel. Esta registrada con el nombre de dialecto @code{'excel'}.
@end deffn

@geindex excel_tab (clase en csv)
@anchor{library/csv csv excel_tab}@anchor{2a5a}
@deffn {Clase} csv.excel_tab

La clase @ref{2a5a,,excel_tab} define las propiedades usuales de un archivo delimitado por tabulaciones generado por Excel. Esta registrada con el nombre de dialecto @code{'excel-tab'}.
@end deffn

@geindex unix_dialect (clase en csv)
@anchor{library/csv csv unix_dialect}@anchor{126a}
@deffn {Clase} csv.unix_dialect

La clase @ref{126a,,unix_dialect} define las propiedades usuales de un archivo CSV generado en sistemas UNIX, es decir, usando @code{'\n'} como terminador de línea y citando todos los campos. Esta registrada con el nombre de dialecto @code{'unix'}.


Added in version 3.2.

@end deffn

@geindex Sniffer (clase en csv)
@anchor{library/csv csv Sniffer}@anchor{2a5b}
@deffn {Clase} csv.Sniffer

La clase @ref{2a5b,,Sniffer} es usada para deducir el formato de un archivo CSV.

La clase @ref{2a5b,,Sniffer} provee 2 métodos:

@geindex sniff() (método de csv.Sniffer)
@anchor{library/csv csv Sniffer sniff}@anchor{2a5c}
@deffn {Método} sniff (sample, delimiters=None)

Analiza la muestra dada y retorna una subclase @ref{1686,,Dialect} reflejando los parámetros encontrados. Si el parámetro opcional `delimiters' es dado, este será interpretado como una cadena que contiene posibles caracteres delimitadores válidos.
@end deffn

@geindex has_header() (método de csv.Sniffer)
@anchor{library/csv csv Sniffer has_header}@anchor{18ab}
@deffn {Método} has_header (sample)

Analiza el texto de muestra (se supone que está en formato CSV) y retorna @ref{c95,,True} si la primera fila parece ser una serie de encabezados de columna. Al inspeccionar cada columna, se considerará uno de dos criterios clave para estimar si la muestra contiene un encabezado:


@itemize -

@item 
las filas segunda n-th contienen valores numéricos

@item 
las segundas filas n-th contienen cadenas en las que la longitud de al menos un valor difiere de la de la supuesta cabecera de esa columna.
@end itemize

Se muestran veinte filas después de la primera; si más de la mitad de las columnas + filas cumplen los criterios, se retorna @ref{c95,,True}.
@end deffn

@cartouche
@quotation Nota 
Este método es una heurística aproximada y puede producir tanto falsos positivos como negativos.
@end quotation
@end cartouche
@end deffn

Un ejemplo para el uso de @ref{2a5b,,Sniffer}:

@example
with open('example.csv', newline='@w{'}) as csvfile:
    dialect = csv.Sniffer().sniff(csvfile.read(1024))
    csvfile.seek(0)
    reader = csv.reader(csvfile, dialect)
    # ... process CSV file contents here ...
@end example
@anchor{library/csv csv-constants}@anchor{2a5d}
El módulo @ref{2a,,csv} define las siguientes constantes:

@geindex QUOTE_ALL (en el módulo csv)
@anchor{library/csv csv QUOTE_ALL}@anchor{2a5e}
@deffn {Dato} csv.QUOTE_ALL

Ordena a los objetos @ref{530,,writer} citar todos los campos.
@end deffn

@geindex QUOTE_MINIMAL (en el módulo csv)
@anchor{library/csv csv QUOTE_MINIMAL}@anchor{2a5f}
@deffn {Dato} csv.QUOTE_MINIMAL

Ordena a los objetos @ref{530,,writer} citar solo aquellos campos que contengan caracteres especiales como por ejemplo `delimiter, *quotechar' o cualquiera de los caracteres en `lineterminator'.
@end deffn

@geindex QUOTE_NONNUMERIC (en el módulo csv)
@anchor{library/csv csv QUOTE_NONNUMERIC}@anchor{15e0}
@deffn {Dato} csv.QUOTE_NONNUMERIC

Ordena a los objetos @ref{530,,writer} citar todos los campos no numéricos.

Ordena a los objetos @ref{52f,,reader} convertir todos los campos no entre comillas al tipo `float'.
@end deffn

@geindex QUOTE_NONE (en el módulo csv)
@anchor{library/csv csv QUOTE_NONE}@anchor{2a60}
@deffn {Dato} csv.QUOTE_NONE

Ordena a los objetos @ref{530,,writer} nunca citar campos. Cuando el `delimiter' actual aparece en los datos de salida es precedido por el carácter `escapechar' actual. Si `escapechar' no esta definido, el `writer' lanzará @ref{2a58,,Error} si cualquier carácter que requiere escaparse es encontrado.

Ordena a los objetos @ref{52f,,reader} no ejecutar un procesamiento especial de caracteres comillas.
@end deffn

@geindex QUOTE_NOTNULL (en el módulo csv)
@anchor{library/csv csv QUOTE_NOTNULL}@anchor{52d}
@deffn {Dato} csv.QUOTE_NOTNULL

Ordena a los objetos @ref{530,,writer} poner entre comillas todos los campos que no sean @code{None}. Esto es similar a @ref{2a5e,,QUOTE_ALL}, con la excepción que si un campo es @code{None} se escribe una cadena de caracteres vacía (sin comillas).

Instructs @ref{52f,,reader} objects to interpret an empty (unquoted) field
as @code{None} and to otherwise behave as @ref{2a5e,,QUOTE_ALL}.


Added in version 3.12.

@end deffn

@geindex QUOTE_STRINGS (en el módulo csv)
@anchor{library/csv csv QUOTE_STRINGS}@anchor{52e}
@deffn {Dato} csv.QUOTE_STRINGS

Ordena a los objetos @ref{530,,writer} siempre poner comillas alrededor de campos que sean cadenas de caracteres. Esto es similar a @ref{15e0,,QUOTE_NONNUMERIC}, con la excepción que si el valor de un campo es @code{None} se escribe una cadena de caracteres vacía (sin comillas).

Ordena a los objetos @ref{52f,,reader} interpretar una cadena de caracteres vacía (sin comillas) como @code{None} y en caso contrario comportarse como @ref{15e0,,QUOTE_NONNUMERIC}.


Added in version 3.12.

@end deffn

El módulo @ref{2a,,csv} define la siguiente excepción:

@geindex Error
@anchor{library/csv csv Error}@anchor{2a58}
@deffn {Excepción} csv.Error

Lanzada por cualquiera de las funciones cuando se detecta un error.
@end deffn

@node Dialectos y parámetros de formato,Objetos Reader,Contenidos del módulo<2>,csv — CSV File Reading and Writing
@anchor{library/csv csv-fmt-params}@anchor{2a57}@anchor{library/csv dialects-and-formatting-parameters}@anchor{2a61}
@subsubsection Dialectos y parámetros de formato


To make it easier to specify the format of input and output records, specific
formatting parameters are grouped together into dialects.  A dialect is a
subclass of the @ref{1686,,Dialect} class containing various attributes
describing the format of the CSV file.  When creating @ref{52f,,reader} or
@ref{530,,writer} objects, the programmer can specify a string or a subclass of
the @ref{1686,,Dialect} class as the dialect parameter.  In addition to, or instead
of, the `dialect' parameter, the programmer can also specify individual
formatting parameters, which have the same names as the attributes defined below
for the @ref{1686,,Dialect} class.

Los dialectos soportan los siguientes atributos:

@geindex delimiter (atributo de csv.Dialect)
@anchor{library/csv csv Dialect delimiter}@anchor{2a62}
@deffn {Atributo} Dialect.delimiter

Una cadena de un solo carácter usada para separar campos. Por defecto es @code{','}.
@end deffn

@geindex doublequote (atributo de csv.Dialect)
@anchor{library/csv csv Dialect doublequote}@anchor{2a63}
@deffn {Atributo} Dialect.doublequote

Controla como las instancias de `quotechar' que aparecen dentro de un campo deben estar citadas. Cuando es @ref{c95,,True}, el carácter es duplicado. Cuando es @ref{bbf,,False}, el `escapechar' es usado como un prefijo el `quotechar'. Por defecto es @ref{c95,,True}.

En la salida, si el `doublequote' es @ref{bbf,,False} y el `escapechar' no está configurado, un @ref{2a58,,Error} es lanzado si se encuentra un `quotechar' en algún campo.
@end deffn

@geindex escapechar (atributo de csv.Dialect)
@anchor{library/csv csv Dialect escapechar}@anchor{2a64}
@deffn {Atributo} Dialect.escapechar

Una cadena de un solo carácter usada por el `writer' para escapar al `delimiter' si `quoting' está configurado como @ref{2a60,,QUOTE_NONE} y al `quotechar' si `doublequote' es @ref{bbf,,False}. En la lectura, el `escapechar' elimina cualquier significado especial del siguiente carácter. Por defecto es @ref{716,,None}, lo que deshabilita el escape.


Distinto en la versión 3.11: No se permite un `quotechar' vacío.

@end deffn

@geindex lineterminator (atributo de csv.Dialect)
@anchor{library/csv csv Dialect lineterminator}@anchor{2a65}
@deffn {Atributo} Dialect.lineterminator

La cadena de caracteres usada para terminar las líneas producidas por @ref{530,,writer}. Por defecto es @code{'\r\n'}.

@cartouche
@quotation Nota 
El @ref{52f,,reader} esta codificado para reconocer tanto @code{'\r'} o @code{'\n'} como final de línea, e ignora `lineterminator'. Este comportamiento puede cambiar en el futuro.
@end quotation
@end cartouche
@end deffn

@geindex quotechar (atributo de csv.Dialect)
@anchor{library/csv csv Dialect quotechar}@anchor{2a66}
@deffn {Atributo} Dialect.quotechar

Una cadena de un solo carácter usada para citar campos que contienen caracteres especiales, como lo son `delimiter' o `quotechar', o que contienen caracteres de nueva línea. Por defecto es  @code{'"'}.


Distinto en la versión 3.11: No se permite un `quotechar' vacío.

@end deffn

@geindex quoting (atributo de csv.Dialect)
@anchor{library/csv csv Dialect quoting}@anchor{2a67}
@deffn {Atributo} Dialect.quoting

Controls when quotes should be generated by the writer and recognised by the
reader.  It can take on any of the @ref{2a5d,,QUOTE_* constants}
and defaults to @ref{2a5f,,QUOTE_MINIMAL}.
@end deffn

@geindex skipinitialspace (atributo de csv.Dialect)
@anchor{library/csv csv Dialect skipinitialspace}@anchor{2a68}
@deffn {Atributo} Dialect.skipinitialspace

Cuando es @ref{c95,,True}, el espacio en blanco que sigue después del `delimiter' es ignorado. Por defecto es @ref{bbf,,False}.
@end deffn

@geindex strict (atributo de csv.Dialect)
@anchor{library/csv csv Dialect strict}@anchor{2a69}
@deffn {Atributo} Dialect.strict

Cuando es @code{True}, lanza una excepción @ref{2a58,,Error} sobre una mala entrada CSV. Por defecto es @code{False}.
@end deffn

@node Objetos Reader,Objetos Writer,Dialectos y parámetros de formato,csv — CSV File Reading and Writing
@anchor{library/csv id3}@anchor{2a6a}@anchor{library/csv reader-objects}@anchor{2a56}
@subsubsection Objetos `Reader'


Los objetos `reader' (instancias de @ref{a77,,DictReader} y objetos retornados por la función @ref{52f,,reader()}) contienen los siguientes métodos públicos:

@geindex __next__() (método de csv.csvreader)
@anchor{library/csv csv csvreader __next__}@anchor{2a6b}
@deffn {Método} csvreader.__next__ ()

Retorna la siguiente fila del objeto iterable del lector como una lista (si el objeto retornó desde @ref{52f,,reader()}) o un dict (si es una instancia de @ref{a77,,DictReader}), analizado de acuerdo con el @ref{1686,,Dialect} actual. Por lo general, debería llamar a esto como @code{next(reader)}.
@end deffn

Los objetos `reader' contienen los siguientes atributos públicos:

@geindex dialect (atributo de csv.csvreader)
@anchor{library/csv csv csvreader dialect}@anchor{2a6c}
@deffn {Atributo} csvreader.dialect

Una descripción de sólo lectura del dialecto en uso por el intérprete.
@end deffn

@geindex line_num (atributo de csv.csvreader)
@anchor{library/csv csv csvreader line_num}@anchor{2a6d}
@deffn {Atributo} csvreader.line_num

El número de líneas leídas del iterador fuente. Esto no es lo mismo que el número de registros retornado, ya que los registros pueden abarcar múltiples líneas.
@end deffn

Los objetos `DictReader' tienen los siguientes atributos públicos:

@geindex fieldnames (atributo de csv.DictReader)
@anchor{library/csv csv DictReader fieldnames}@anchor{2a6e}
@deffn {Atributo} DictReader.fieldnames

Si no son pasados como parámetros cuando se crea el objeto, este atributo es inicializado en el primer acceso o cuando es leído el primer registro del archivo.
@end deffn

@node Objetos Writer,Ejemplos<9>,Objetos Reader,csv — CSV File Reading and Writing
@anchor{library/csv writer-objects}@anchor{2a6f}
@subsubsection Objetos `Writer'


@ref{530,,writer} objects (@ref{126b,,DictWriter} instances and objects returned by
the @ref{530,,writer()} function) have the following public methods.  A `row' must be
an iterable of strings or numbers for @ref{530,,writer} objects and a dictionary
mapping fieldnames to strings or numbers (by passing them through @ref{237,,str()}
first) for @ref{126b,,DictWriter} objects.  Note that complex numbers are written
out surrounded by parens. This may cause some problems for other programs which
read CSV files (assuming they support complex numbers at all).

@geindex writerow() (método de csv.csvwriter)
@anchor{library/csv csv csvwriter writerow}@anchor{e6f}
@deffn {Método} csvwriter.writerow (row)

Escriba el parámetro `row' en el objeto de archivo del escritor, formateado de acuerdo con el @ref{1686,,Dialect} actual. Retorna el valor de retorno de la llamada al método `write' del objeto de archivo subyacente.


Distinto en la versión 3.5: Agregado soporte para iterables.

@end deffn

@geindex writerows() (método de csv.csvwriter)
@anchor{library/csv csv csvwriter writerows}@anchor{2a70}
@deffn {Método} csvwriter.writerows (rows)

Escribe todos los elementos en `rows' (un iterable de objetos `row' como se describe anteriormente) al objeto de archivo del `writer', formateados según el dialecto actual.
@end deffn

Los objetos `writer' contienen los siguientes atributos públicos:

@geindex dialect (atributo de csv.csvwriter)
@anchor{library/csv csv csvwriter dialect}@anchor{2a71}
@deffn {Atributo} csvwriter.dialect

Una descripción de solo lectura del dialecto en uso por el `writer'.
@end deffn

Los objetos `DictWriter' contienen los siguientes métodos públicos:

@geindex writeheader() (método de csv.DictWriter)
@anchor{library/csv csv DictWriter writeheader}@anchor{126c}
@deffn {Método} DictWriter.writeheader ()

Escribe una fila con los nombres de los campos (como se especifica en el constructor) al objeto de archivo del `writer', formateada según el dialecto actual. Retorna el valor de retorno de la llamada a @ref{e6f,,csvwriter.writerow()} usada internamente.


Added in version 3.2.



Distinto en la versión 3.8: @ref{126c,,writeheader()} ahora también retorna el valor retornado por el método @ref{e6f,,csvwriter.writerow()} que usa internamente.

@end deffn

@node Ejemplos<9>,,Objetos Writer,csv — CSV File Reading and Writing
@anchor{library/csv csv-examples}@anchor{2a72}@anchor{library/csv examples}@anchor{2a73}
@subsubsection Ejemplos


El ejemplo más simple de lectura de un archivo CSV:

@example
import csv
with open('some.csv', newline='@w{'}) as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)
@end example

Lectura de un archivo con un formato alternativo:

@example
import csv
with open('passwd', newline='@w{'}) as f:
    reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE)
    for row in reader:
        print(row)
@end example

El correspondiente ejemplo de escritura más simple es:

@example
import csv
with open('some.csv', 'w', newline='@w{'}) as f:
    writer = csv.writer(f)
    writer.writerows(someiterable)
@end example

Cuando se usa  @ref{1be,,open()} para abrir un archivo CSV en modo lectura, el archivo será decodificado por defecto en unicode usando la codificación por defecto del sistema (ver @ref{5dc,,locale.getpreferredencoding()}). Para decodificar un archivo usando una codificación diferente, usa el argumento @code{encoding} de open:

@example
import csv
with open('some.csv', newline='@w{'}, encoding='utf-8') as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)
@end example

Lo mismo aplica a escribir en algo diferente a la codificación por defecto del sistema: especifique el argumento de codificación cuando abra el archivo de salida.

Registrando un nuevo dialecto:

@example
import csv
csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE)
with open('passwd', newline='@w{'}) as f:
    reader = csv.reader(f, 'unixpwd')
@end example

Un uso ligeramente más avanzado del `reader' — captura y reporte de errores:

@example
import csv, sys
filename = 'some.csv'
with open(filename, newline='@w{'}) as f:
    reader = csv.reader(f)
    try:
        for row in reader:
            print(row)
    except csv.Error as e:
        sys.exit('file @{@}, line @{@}: @{@}'.format(filename, reader.line_num, e))
@end example

Y a pesar de que el módulo no soporta el análisis de cadenas de caracteres directamente, puede ser realizado fácilmente:

@example
import csv
for row in csv.reader(['one,two,three']):
    print(row)
@end example

@subsubheading Notas al pie


@node configparser — Configuration file parser,tomllib — Parse TOML files,csv — CSV File Reading and Writing,Formatos de archivo
@anchor{library/configparser doc}@anchor{2a74}@anchor{library/configparser configparser-configuration-file-parser}@anchor{2a75}@anchor{library/configparser module-configparser}@anchor{23}
@subsection @code{configparser} — Configuration file parser


@geindex module; configparser

`Código fuente:' Lib/configparser.py@footnote{https://github.com/python/cpython/tree/main/Lib/configparser.py}

@geindex .ini;file
@geindex configuration;file
@geindex ini file
@geindex Windows ini file


__________________________________________________________________


Este módulo provee la clase @ref{32b,,ConfigParser}, la cual implementa un lenguaje básico de configuración que proporciona una estructura similar a la encontrada en los archivos INI de Microsoft Windows. Puedes utilizarla para escribir programas Python que los usuarios finales puedan personalizar con facilidad.

@cartouche
@quotation Nota 
Esta biblioteca `no' interpreta o escribe los prefijos valor-tipo usados en la versión extendida de la sintaxis INI, utilizada en el registro de Windows.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item Módulo @ref{fc,,tomllib}

TOML es un formato bien-especificado para archivos de configuración de aplicaciones. Está específicamente diseñado para ser una versión mejorada de INI.

@item Módulo @ref{c4,,shlex}

Soporta la creación de un mini-lenguaje parecido a shell de Unix, que puede utilizarse para archivos de configuración de aplicaciones.

@item Módulo @ref{82,,json}

El módulo @code{json} implementa un subconjunto de la sintaxis de JavaScript, que también puede utilizarse para configuración, pero no soporta comentarios.
@end table


@c import configparser

@c import os
@c os.remove("example.ini")
@c os.remove("override.ini")

@menu
* Inicio Rápido:: 
* Tipos de Datos Soportados:: 
* Valores de contingencia:: 
* Estructura soportada para el archivo ini:: 
* Unnamed Sections:: 
* Interpolación de valores:: 
* Acceso por protocolo de mapeo:: 
* Personalizando el comportamiento del parser:: 
* Ejemplos de la API heredada:: 
* Objetos ConfigParser:: 
* Objetos RawConfigParser:: 
* Excepciones: Excepciones<7>. 

@end menu

@node Inicio Rápido,Tipos de Datos Soportados,,configparser — Configuration file parser
@anchor{library/configparser quick-start}@anchor{2a76}
@subsubsection Inicio Rápido


Tomemos un archivo de configuración muy básico, el cual luce así:

@example
[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes

[forge.example]
User = hg

[topsecret.server.example]
Port = 50022
ForwardX11 = no
@end example

La estructura de los archivos INI es descrita @ref{2a77,,en la siguiente sección}.  En esencia, el archivo consiste de secciones, cada una de las cuales contiene claves con valores. Las clases @ref{23,,configparser} pueden leer y escribir dichos archivos. Comencemos creando el anterior archivo de configuración de forma programática.

@example
>>> import configparser
>>> config = configparser.ConfigParser()
>>> config['DEFAULT'] = @{'ServerAliveInterval': '45',
...                      'Compression': 'yes',
...                      'CompressionLevel': '9'@}
>>> config['forge.example'] = @{@}
>>> config['forge.example']['User'] = 'hg'
>>> config['topsecret.server.example'] = @{@}
>>> topsecret = config['topsecret.server.example']
>>> topsecret['Port'] = '50022'     # mutates the parser
>>> topsecret['ForwardX11'] = 'no'  # same here
>>> config['DEFAULT']['ForwardX11'] = 'yes'
>>> with open('example.ini', 'w') as configfile:
...   config.write(configfile)
...
@end example

Como puedes ver, podemos tratar al `config parser' como a un diccionario. Existen diferencias,  @ref{2a78,,descritas posteriormente}, pero su comportamiento es muy parecido al que esperarías de un diccionario.

Ahora que hemos creado y guardado el archivo de configuración, vamos a releerlo y analizar los datos que contiene.

@example
>>> config = configparser.ConfigParser()
>>> config.sections()
[]
>>> config.read('example.ini')
['example.ini']
>>> config.sections()
['forge.example', 'topsecret.server.example']
>>> 'forge.example' in config
True
>>> 'python.org' in config
False
>>> config['forge.example']['User']
'hg'
>>> config['DEFAULT']['Compression']
'yes'
>>> topsecret = config['topsecret.server.example']
>>> topsecret['ForwardX11']
'no'
>>> topsecret['Port']
'50022'
>>> for key in config['forge.example']:  
...     print(key)
user
compressionlevel
serveraliveinterval
compression
forwardx11
>>> config['forge.example']['ForwardX11']
'yes'
@end example

Como podemos apreciar, la API es muy clara. La única “porción de magia” está en la sección @code{DEFAULT}, la cual proporciona los valores por defecto para todas las demás secciones @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}. Observe también que las claves de las secciones son insensibles a mayúsculas y minúsculas, pero se almacenan en minúscula @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}.

It is possible to read several configurations into a single
@ref{32b,,ConfigParser}, where the most recently added configuration has the
highest priority. Any conflicting keys are taken from the more recent
configuration while the previously existing keys are retained. The example
below reads in an @code{override.ini} file, which will override any conflicting
keys from the @code{example.ini} file.

@example
[DEFAULT]
ServerAliveInterval = -1
@end example

@example
>>> config_override = configparser.ConfigParser()
>>> config_override['DEFAULT'] = @{'ServerAliveInterval': '-1'@}
>>> with open('override.ini', 'w') as configfile:
...     config_override.write(configfile)
...
>>> config_override = configparser.ConfigParser()
>>> config_override.read(['example.ini', 'override.ini'])
['example.ini', 'override.ini']
>>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
-1
@end example

Este comportamiento es equivalente a una llamada a @ref{14a5,,ConfigParser.read()} pasando varios ficheros en el parámetro `filenames'.

@node Tipos de Datos Soportados,Valores de contingencia,Inicio Rápido,configparser — Configuration file parser
@anchor{library/configparser supported-datatypes}@anchor{2a7a}
@subsubsection Tipos de Datos Soportados


Los `config parsers' no especulan respecto a los tipos de datos de los valores en los archivos de configuración, siempre los almacenan internamente como cadenas de caracteres. Esto significa que si necesitas otros tipos de datos, deberás hacer la conversión por ti mismo:

@example
>>> int(topsecret['Port'])
50022
>>> float(topsecret['CompressionLevel'])
9.0
@end example

Dado que esta tarea es muy común, los `config parsers' proporcionan una amplia variedad de útiles métodos de lectura (`getter') que manejan enteros, números de punto flotante y booleanos. Este último es el más interesante, porque puede no ser correcto pasar simplemente el valor a @code{bool()}, ya que @code{bool('False')} resultará en @code{True}. Por esta razón los `config parsers' proporcionan también el método @ref{2a7b,,getboolean()}. Este método es insensible a mayúsculas y minúsculas, y reconoce como valores booleanos a los valores @code{'yes'}/@code{'no'}, @code{'on'}/@code{'off'}, @code{'true'}/@code{'false'} and @code{'1'}/@code{'0'} @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}.  Por ejemplo:

@example
>>> topsecret.getboolean('ForwardX11')
False
>>> config['forge.example'].getboolean('ForwardX11')
True
>>> config.getboolean('forge.example', 'Compression')
True
@end example

Además de @ref{2a7b,,getboolean()}, los `config parsers' también proporcionan los métodos equivalentes @ref{2a7c,,getint()} y @ref{2a7d,,getfloat()}. Puedes registrar tus propios conversores, y personalizar los que se proporcionan. @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}

@node Valores de contingencia,Estructura soportada para el archivo ini,Tipos de Datos Soportados,configparser — Configuration file parser
@anchor{library/configparser fallback-values}@anchor{2a7e}
@subsubsection Valores de contingencia


As with a dictionary, you can use a section’s @ref{12d9,,get()} method to
provide fallback values:

@example
>>> topsecret.get('Port')
'50022'
>>> topsecret.get('CompressionLevel')
'9'
>>> topsecret.get('Cipher')
>>> topsecret.get('Cipher', '3des-cbc')
'3des-cbc'
@end example

Por favor, fíjate que los valores por defecto tienen prioridad sobre los valores de contingencia (`fallback'). Así, en nuestro ejemplo, la clave @code{'CompressionLevel'} sólo fue especificada en la sección @code{'DEFAULT'}. Si tratamos de obtener su valor de la sección @code{'topsecret.server.example'}, obtendremos siempre el valor por defecto, incluso si especificamos un valor de contingencia:

@example
>>> topsecret.get('CompressionLevel', '3')
'9'
@end example

One more thing to be aware of is that the parser-level @ref{12d9,,get()} method
provides a custom, more complex interface, maintained for backwards
compatibility.  When using this method, a fallback value can be provided via
the @code{fallback} keyword-only argument:

@example
>>> config.get('forge.example', 'monster',
...            fallback='No such things as monsters')
'No such things as monsters'
@end example

El mismo argumento @code{fallback} puede utilizarse con los métodos @ref{2a7c,,getint()}, @ref{2a7d,,getfloat()} y @ref{2a7b,,getboolean()}, por ejemplo:

@example
>>> 'BatchMode' in topsecret
False
>>> topsecret.getboolean('BatchMode', fallback=True)
True
>>> config['DEFAULT']['BatchMode'] = 'no'
>>> topsecret.getboolean('BatchMode', fallback=True)
False
@end example

@node Estructura soportada para el archivo ini,Unnamed Sections,Valores de contingencia,configparser — Configuration file parser
@anchor{library/configparser supported-ini-file-structure}@anchor{2a77}
@subsubsection Estructura soportada para el archivo ini


Un archivo de configuración consta de secciones, cada una iniciada por una cabecera @code{[section]}, seguida por registros clave-valor separados por una cadena de caracteres específica (@code{=} ó @code{:} por defecto @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}). De forma predeterminada, los nombres de sección son sensibles a mayúsculas y minúsculas pero las claves no @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}. Los espacios al inicio y final de las claves y valores son eliminados. Los valores pueden ser omitidos si el `parser' está configurado para permitirlo @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}, en cuyo caso el delimitador del dato clave-valor puede ser omitido también. Los valores pueden ocupar varias líneas, siempre y cuando tengan una indentación mayor que la primera línea del valor. Dependiendo del modo del `parser', las líneas en blanco pueden tratarse como parte de un valor multilínea o ser ignoradas.

By default, a valid section name can be any string that does not contain “\n”.
To change this, see @ref{2a7f,,ConfigParser.SECTCRE}.

The first section name may be omitted if the parser is configured to allow an
unnamed top level section with @code{allow_unnamed_section=True}. In this case,
the keys/values may be retrieved by @ref{15d8,,UNNAMED_SECTION} as in
@code{config[UNNAMED_SECTION]}.

Los archivos de configuración pueden incluir comentarios, con caracteres específicos como prefijos (@code{#} y @code{;} por defecto @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}). Los comentarios pueden ocupar su propia línea, posiblemente indentada. @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}

Por ejemplo:

@example
[Simple Values]
key=value
spaces in keys=allowed
spaces in values=allowed as well
spaces around the delimiter = obviously
you can also use : to delimit keys from values

[All Values Are Strings]
values like this: 1000000
or this: 3.14159265359
are they treated as numbers? : no
integers, floats and booleans are held as: strings
can use the API to get converted values directly: true

[Multiline Values]
chorus: I'm a lumberjack, and I'm okay
    I sleep all night and I work all day

[No Values]
key_without_value
empty string value here =

[You can use comments]
# like this
; or this

# By default only in an empty line.
# Inline comments can be harmful because they prevent users
# from using the delimiting characters as parts of values.
# That being said, this can be customized.

    [Sections Can Be Indented]
        can_values_be_as_well = True
        does_that_mean_anything_special = False
        purpose = formatting for readability
        multiline_values = are
            handled just fine as
            long as they are indented
            deeper than the first line
            of a value
        # Did I mention we can indent comments, too?
@end example

@node Unnamed Sections,Interpolación de valores,Estructura soportada para el archivo ini,configparser — Configuration file parser
@anchor{library/configparser id10}@anchor{2a80}@anchor{library/configparser unnamed-sections}@anchor{2a81}
@subsubsection Unnamed Sections


The name of the first section (or unique) may be omitted and values
retrieved by the @ref{15d8,,UNNAMED_SECTION} attribute.

@example
>>> config = """
... option = value
...
... [  Section 2  ]
... another = val
... """
>>> unnamed = configparser.ConfigParser(allow_unnamed_section=True)
>>> unnamed.read_string(config)
>>> unnamed.get(configparser.UNNAMED_SECTION, 'option')
'value'
@end example

@node Interpolación de valores,Acceso por protocolo de mapeo,Unnamed Sections,configparser — Configuration file parser
@anchor{library/configparser interpolation-of-values}@anchor{2a82}
@subsubsection Interpolación de valores


En el nivel superior de su funcionalidad central, @ref{32b,,ConfigParser} soporta la interpolación. Esto significa que los valores pueden ser preprocesados, antes de ser retornados por los llamados a @code{get()}.

@geindex % (percent);interpolation in configuration files

@geindex BasicInterpolation (clase en configparser)
@anchor{library/configparser configparser BasicInterpolation}@anchor{7be}
@deffn {Clase} configparser.BasicInterpolation

Es la implementación por defecto que utiliza @ref{32b,,ConfigParser}. Permite valores que contengan cadenas de formato, que hacen referencia a otros valores en la misma sección o a valores presentes en la sección especial `default' @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}. Valores por defecto adicionales pueden ser proporcionados en la inicialización.

Por ejemplo:

@example
[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack
my_pictures: %(my_dir)s/Pictures

[Escape]
# use a %% to escape the % sign (% is the only character that needs to be escaped):
gain: 80%%
@end example

En el ejemplo anterior, @ref{32b,,ConfigParser} con la `interpolación' establecida a @code{BasicInterpolation()} puede resolver @code{%(home_dir)s} al valor @code{home_dir} (@code{/Users} en este caso).  En efecto, @code{%(my_dir)s} podría resolverse como @code{/Users/lumberjack}. Todas las interpolaciones son realizadas bajo demanda, de modo que las claves utilizadas en la cadena de referencias no requieren un orden específico en el archivo de configuración.

Con @code{interpolation} establecida al valor @code{None}, el `parser' retornará simplemente @code{%(my_dir)s/Pictures} como el valor de @code{my_pictures} y @code{%(home_dir)s/lumberjack} como el valor de @code{my_dir}.
@end deffn

@geindex $ (dollar);interpolation in configuration files

@geindex ExtendedInterpolation (clase en configparser)
@anchor{library/configparser configparser ExtendedInterpolation}@anchor{7bf}
@deffn {Clase} configparser.ExtendedInterpolation

Es un gestor alternativo para la interpolación, que implementa una sintaxis más avanzada; es utilizado, por ejemplo, en @code{zc.buildout}.  La interpolación es extendida al utilizar @code{$@{section:option@}}, a fin de especificar un valor que proviene de una sección externa. La interpolación puede cubrir múltiples niveles. Por conveniencia, si la parte @code{section:} es omitida, la interpolación utilizará la sección actual (y posiblemente los valores por defecto establecidos en la sección especial).

Por ejemplo, la configuración indicada anteriormente, con interpolación básica, luciría de la siguiente manera utilizando interpolación extendida:

@example
[Paths]
home_dir: /Users
my_dir: $@{home_dir@}/lumberjack
my_pictures: $@{my_dir@}/Pictures

[Escape]
# use a $$ to escape the $ sign ($ is the only character that needs to be escaped):
cost: $$80
@end example

También pueden buscarse valores en otras secciones:

@example
[Common]
home_dir: /Users
library_dir: /Library
system_dir: /System
macports_dir: /opt/local

[Frameworks]
Python: 3.2
path: $@{Common:system_dir@}/Library/Frameworks/

[Arthur]
nickname: Two Sheds
last_name: Jackson
my_dir: $@{Common:home_dir@}/twosheds
my_pictures: $@{my_dir@}/Pictures
python_dir: $@{Frameworks:path@}/Python/Versions/$@{Frameworks:Python@}
@end example
@end deffn

@node Acceso por protocolo de mapeo,Personalizando el comportamiento del parser,Interpolación de valores,configparser — Configuration file parser
@anchor{library/configparser mapping-protocol-access}@anchor{2a78}
@subsubsection Acceso por protocolo de mapeo



Added in version 3.2.


El acceso por protocolo de mapeo es un nombre genérico asignado a la funcionalidad que permite el uso de objetos personalizados como si fuesen diccionarios. En el caso de @ref{23,,configparser}, la implementación de la interfaz de mapeo utiliza la notación @code{parser['section']['option']}.

En particular, @code{parser['section']} retorna un proxy para los datos de la sección en el `parser'. Esto significa que los valores no son copiados, sino que son tomados del `parser' original sobre la marcha.

Los objetos de @ref{23,,configparser} se comportan de forma tan similar a un diccionario como se puede. La interfaz de mapeo es completa y se ciñe a la @ref{1123,,MutableMapping} ABC. Sin embargo, existen unas pequeñas diferencias que deben tomarse en cuenta:


@itemize *

@item 
Por defecto, todas las claves de las secciones se pueden acceder de una forma insensible a mayúsculas y minúsculas @footnote{
Los `config parsers' permiten una gran personalización. Si estás interesado en modificar el comportamiento descrito por la referencia de la nota al pie, consulta la sección @ref{2a79,,Customizing Parser Behaviour}.
}. Ej. @code{for option in parser["section"]} entrega solamente nombres de claves de opción que han pasado por @code{optionxform}. Esto significa, claves en minúscula por defecto. A la vez, para una sección que contiene la clave @code{'a'}, ambas expresiones retornan @code{True}:

@example
"a" in parser["section"]
"A" in parser["section"]
@end example

@item 
Todas las secciones también incluyen valores @code{DEFAULTSECT}, lo que significa que @code{.clear()} en una sección puede no significar que esta quede vacía de forma visible. Ello debido a que los valores por defecto no pueden ser borrados de la sección (ya que técnicamente no están allí). Si fueron redefinidas en la sección, su borrado ocasiona que los valores por defecto sean visibles de nuevo. Cualquier intento de borrar un valor por defecto ocasiona una excepción @ref{438,,KeyError}.

@item 
@code{DEFAULTSECT} no puede ser eliminado del `parser':


@itemize *

@item 
el intento de borrarlo lanza una excepción @ref{360,,ValueError},

@item 
@code{parser.clear()} lo deja intacto,

@item 
@code{parser.popitem()} nunca lo retorna.
@end itemize

@item 
@code{parser.get(section, option, **kwargs)} - el segundo argumento `no' es un valor de contingencia. Observe, sin embargo, que los métodos @code{get()} a nivel de sección son compatibles tanto con el protocolo de mapeo como con la API clásica de `configparser'.

@item 
@code{parser.items()} es compatible con el protocolo de mapeo (retorna una lista de pares `section_name', `section_proxy' que estén incluidos en DEFAULTSECT). Sin embargo, este método también puede ser invocado con los argumentos: @code{parser.items(section, raw, vars)}.  Esta última llamada retorna una lista de pares `option', `value' para una @code{section} específica, con todas las interpolaciones expandidas (a menos que se especifique @code{raw=True}).
@end itemize

El protocolo de mapeo se implementa en el nivel superior de la actual API heredada, de modo que esas subclases que sobre-escriben la interfaz original aún deberían hacer funcionar el mapeo como se esperaría.

@node Personalizando el comportamiento del parser,Ejemplos de la API heredada,Acceso por protocolo de mapeo,configparser — Configuration file parser
@anchor{library/configparser customizing-parser-behaviour}@anchor{2a79}
@subsubsection Personalizando el comportamiento del parser


Existen casi tantas variantes del formato INI como aplicaciones que lo usen. @ref{23,,configparser} llega muy lejos al proporcionar soporte al mayor conjunto sensible de estilos de INI disponibles. La funcionalidad predeterminada es impuesta principalmente por antecedentes históricos y es muy probable que quieras personalizar algunas de las funcionalidades.

The most common way to change the way a specific config parser works is to use
the @code{__init__()} options:


@itemize *

@item 
`defaults', valor por defecto: @code{None}

Esta opción acepta un diccionario de pares clave-valor, que debe ser colocado inicialmente en la sección @code{DEFAULT}. De este modo se obtiene una manera elegante de apoyar los archivos de configuración concisos, que no especifican valores que sean los mismos documentados por defecto.

Hint: if you want to specify default values for a specific section, use
@ref{2a83,,read_dict()} before you read the actual file.

@item 
`dict_type', valor por defecto: @ref{190,,dict}

Esta opción tiene un gran impacto en cómo funcionará el protocolo de mapeo, y cómo lucirán los archivos de configuración a escribir. Con el diccionario estándar, cada sección se almacena en el orden en que se añadieron al `parser'. Lo mismo ocurre con las opciones dentro de las secciones.

Un tipo alternativo de diccionario puede ser utilizado, por ejemplo, para ordenar las secciones y opciones en un modo a posteriori (`write-back').

Por favor, tome en cuenta que: existen formas de agregar un par clave-valor en una sola operación. Cuando se utiliza un diccionario común en tales operaciones, el orden de las claves será el empleado en la creación. Por ejemplo:

@example
>>> parser = configparser.ConfigParser()
>>> parser.read_dict(@{'section1': @{'key1': 'value1',
...                                'key2': 'value2',
...                                'key3': 'value3'@},
...                   'section2': @{'keyA': 'valueA',
...                                'keyB': 'valueB',
...                                'keyC': 'valueC'@},
...                   'section3': @{'foo': 'x',
...                                'bar': 'y',
...                                'baz': 'z'@}
... @})
>>> parser.sections()
['section1', 'section2', 'section3']
>>> [option for option in parser['section3']]
['foo', 'bar', 'baz']
@end example

@item 
`allow_no_value', valor por defecto: @code{False}

Se sabe que algunos archivos de configuración incluyen elementos sin indicar un valor, aunque cumplan con la sintaxis soportada por @ref{23,,configparser} en todo lo demás. El parámetro `allow_no_value' le indica al constructor que tales valores deben ser aceptados:

@example
>>> import configparser

>>> sample_config = """
... [mysqld]
...   user = mysql
...   pid-file = /var/run/mysqld/mysqld.pid
...   skip-external-locking
...   old_passwords = 1
...   skip-bdb
...   # we don't need ACID today
...   skip-innodb
... """
>>> config = configparser.ConfigParser(allow_no_value=True)
>>> config.read_string(sample_config)

>>> # Settings with values are treated as before:
>>> config["mysqld"]["user"]
'mysql'

>>> # Settings without values provide None:
>>> config["mysqld"]["skip-bdb"]

>>> # Settings which aren't specified still raise an error:
>>> config["mysqld"]["does-not-exist"]
Traceback (most recent call last):
  ...
KeyError: 'does-not-exist'
@end example

@item 
`delimiters', valor por defecto: @code{('=', ':')}

Los `delimiters' son cadenas de caracteres que separan las claves de los valores dentro de una sección. La primera ocurrencia de una cadena de separación en una línea se considera como un separador. Esto significa que los valores pueden contener separadores, no así las claves.

Vea también el argumento `space_around_delimiters' de @ref{2a84,,ConfigParser.write()}.

@item 
`comment_prefixes', valor por defecto: @code{('#', ';')}

@item 
`inline_comment_prefixes', valor por defecto: @code{None}

Los prefijos de comentario son cadenas de caracteres que indican el inicio de un comentario válido dentro de un archivo de configuración. Los `comment_prefixes' son utilizados solamente en lo que serían líneas en blanco (opcionalmente indentadas), mientras que `inline_comment_prefixes' pueden ser utilizados después de cada valor válido (ej. nombres de sección, opciones y también líneas en blanco). De forma predeterminada, los comentarios en la misma línea están deshabilitados, y tanto @code{'#'} como @code{';'} se utilizan como prefijos para comentarios que ocupan toda la línea.


Distinto en la versión 3.2: En versiones previas de @ref{23,,configparser} el comportamiento correspondía a @code{comment_prefixes=('#',';')} e @code{inline_comment_prefixes=(';',)}.


Por favor, observe que los `config parsers' no soportan el escapado de los prefijos de comentarios, de modo que la utilización de los `inline_comment_prefixes' puede impedir que los usuarios especifiquen valores de opciones que incluyan caracteres empleados como prefijos de comentarios. Ante la duda, evite especificar los `inline_comment_prefixes'. En cualquier circunstancia, la única forma de almacenar caracteres prefijos de comentario al inicio de una línea, en valores multilínea, es mediante la interpolación del prefijo, por ejemplo:

@example
>>> from configparser import ConfigParser, ExtendedInterpolation
>>> parser = ConfigParser(interpolation=ExtendedInterpolation())
>>> # the default BasicInterpolation could be used as well
>>> parser.read_string("""
... [DEFAULT]
... hash = #
...
... [hashes]
... shebang =
...   $@{hash@}!/usr/bin/env python
...   $@{hash@} -*- coding: utf-8 -*-
...
... extensions =
...   enabled_extension
...   another_extension
...   #disabled_by_comment
...   yet_another_extension
...
... interpolation not necessary = if # is not at line start
... even in multiline values = line #1
...   line #2
...   line #3
... """)
>>> print(parser['hashes']['shebang'])

#!/usr/bin/env python
# -*- coding: utf-8 -*-
>>> print(parser['hashes']['extensions'])

enabled_extension
another_extension
yet_another_extension
>>> print(parser['hashes']['interpolation not necessary'])
if # is not at line start
>>> print(parser['hashes']['even in multiline values'])
line #1
line #2
line #3
@end example

@item 
`strict', valor por defecto: @code{True}

When set to @code{True}, the parser will not allow for any section or option
duplicates while reading from a single source (using @ref{5aa,,read_file()},
@ref{2a85,,read_string()} or @ref{2a83,,read_dict()}).  It is recommended to use strict
parsers in new applications.


Distinto en la versión 3.2: En versiones previas de @ref{23,,configparser} el comportamiento correspondía a @code{strict=False}.


@item 
`empty_lines_in_values', valor por defecto: @code{True}

En los `config parsers', los valores pueden abarcar varias líneas, siempre y cuando estén indentadas a un nivel superior al de la clave que las contiene. De forma predeterminada, los `parsers' permiten que las líneas en blanco formen parte de los valores. Igualmente, las claves pueden estar indentadas a sí mismas de forma arbitraria, a fin de mejorar la legibilidad. Por lo tanto, cuando los archivos de configuración se vuelven grandes y complejos, es fácil para el usuario el perder la pista de la estructura del archivo. Tomemos como ejemplo:

@example
[Section]
key = multiline
  value with a gotcha

 this = is still a part of the multiline value of 'key'
@end example

Esto puede ser especialmente problemático de observar por parte del usuario, en caso que se esté utilizando un tipo de fuente proporcional para editar el archivo. Y es por ello que, cuando tu aplicación no necesite valores con líneas en blanco, debes considerar invalidarlas. Esto ocasionaría que las líneas en blanco sirvan para dividir a las claves, siempre. En el ejemplo anterior, produciría dos claves: @code{key} y @code{this}.

@item 
`default_section', valor por defecto: @code{configparser.DEFAULTSECT} (es decir: @code{"DEFAULT"})

El convenio de permitir una sección especial con valores por defecto para otras secciones, o con propósito de interpolación, es un concepto poderoso de esta librería, el cual permite a los usuarios crear configuraciones declarativas complejas. Esta sección se suele denominar @code{"DEFAULT"}, pero puede personalizarse para corresponder a cualquier otro nombre de sección. Algunas valores comunes son: @code{"general"} ó @code{"common"}. El nombre proporcionado es utilizado para reconocer las secciones por defecto al momento de realizar la lectura desde cualquier fuente, y es utilizado ante cualquier escritura al archivo de configuración. Su valor actual puede obtenerse utilizando el atributo @code{parser_instance.default_section} y puede ser modificado en tiempo de ejecución (es decir, para convertir archivos de un formato a otro).

@item 
`interpolation', valor por defecto: @code{configparser.BasicInterpolation}

El comportamiento de la interpolación puede ser personalizado al proporcionar un gestor personalizado mediante el argumento `interpolation'. El valor @code{None} se utiliza para desactivar la interpolación por completo, mientras que @code{ExtendedInterpolation()} proporciona una variante más avanzada, inspirada por @code{zc.buildout}. Más información al respecto en la @ref{2a82,,sección dedicada de la documentación}. El @ref{fe4,,RawConfigParser} tiene un valor por defecto de @code{None}.

@item 
`converters', valor por defecto: no definido

Config parsers provide option value getters that perform type conversion.  By
default @ref{2a7c,,getint()}, @ref{2a7d,,getfloat()}, and
@ref{2a7b,,getboolean()} are implemented.  Should other getters be
desirable, users may define them in a subclass or pass a dictionary where each
key is a name of the converter and each value is a callable implementing said
conversion.  For instance, passing @code{@{'decimal': decimal.Decimal@}} would add
@code{getdecimal()} on both the parser object and all section proxies.  In
other words, it will be possible to write both
@code{parser_instance.getdecimal('section', 'key', fallback=0)} and
@code{parser_instance['section'].getdecimal('key', 0)}.

Si el conversor necesita acceder al estado del `parser', este puede ser implementado como un método en una subclase del `config parser'. Si el nombre de este método comienza con @code{get}, estará disponible en todas las secciones proxy, en su forma compatible con diccionarios (vea el ejemplo anterior de @code{getdecimal()}).
@end itemize

Una personalización más avanzada puede conseguirse al sustituir los valores por defecto de estos atributos del `parser'. Los valores por defecto son definidos en las clases, de modo que pueden ser sustituidos por las subclases o mediante la asignación de atributos.

@geindex BOOLEAN_STATES (atributo de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser BOOLEAN_STATES}@anchor{2a86}
@deffn {Atributo} ConfigParser.BOOLEAN_STATES

Por defecto, al utilizar el método @ref{2a7b,,getboolean()}, los `config parsers' consideran a los siguientes valores como @code{True}: @code{'1'}, @code{'yes'}, @code{'true'}, @code{'on'} y a los siguientes valores como @code{False}: @code{'0'}, @code{'no'}, @code{'false'}, @code{'off'}.  Puedes cambiar ello proporcionando un diccionario personalizado de cadenas de caracteres, con sus correspondientes valores booleanos. Por ejemplo:

@example
>>> custom = configparser.ConfigParser()
>>> custom['section1'] = @{'funky': 'nope'@}
>>> custom['section1'].getboolean('funky')
Traceback (most recent call last):
...
ValueError: Not a boolean: nope
>>> custom.BOOLEAN_STATES = @{'sure': True, 'nope': False@}
>>> custom['section1'].getboolean('funky')
False
@end example

Otros pares booleanos comunes incluyen @code{accept}/@code{reject} ó @code{enabled}/@code{disabled}.
@end deffn


@deffn {Método} ConfigParser.optionxform (option)

Este método realiza la transformación de los nombres de opciones para cada operación de lectura, obtención o asignación. Por defecto convierte los nombres a minúsculas. Esto significa que, cuando un archivo de configuración es escrito, todas las claves son convertidas a minúsculas. Sobre-escribe este método si tal comportamiento no es adecuado. Por ejemplo:

@example
>>> config = """
... [Section1]
... Key = Value
...
... [Section2]
... AnotherKey = Value
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> list(typical['Section1'].keys())
['key']
>>> list(typical['Section2'].keys())
['anotherkey']
>>> custom = configparser.RawConfigParser()
>>> custom.optionxform = lambda option: option
>>> custom.read_string(config)
>>> list(custom['Section1'].keys())
['Key']
>>> list(custom['Section2'].keys())
['AnotherKey']
@end example

@cartouche
@quotation Nota 
La función `optionxform' transforma los nombres de opción a una forma canónica. Esta debería ser una función idempotente: si el nombre ya está en su forma canónica, debería retornarse sin cambios.
@end quotation
@end cartouche
@end deffn

@geindex SECTCRE (atributo de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser SECTCRE}@anchor{2a7f}
@deffn {Atributo} ConfigParser.SECTCRE

Es una expresión regular compilada que se utiliza para parsear cabeceras de sección. Por defecto hace corresponder @code{[section]} con el nombre @code{"section"}. Los espacios en blanco son considerados parte del nombre de sección, por lo que @code{[  larch  ]} será leído como la sección de nombre @code{"  larch  "}. Sobre-escribe este atributo si tal comportamiento no es adecuado. Por ejemplo:

@example
>>> import re
>>> config = """
... [Section 1]
... option = value
...
... [  Section 2  ]
... another = val
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> typical.sections()
['Section 1', '  Section 2  ']
>>> custom = configparser.ConfigParser()
>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
>>> custom.read_string(config)
>>> custom.sections()
['Section 1', 'Section 2']
@end example

@cartouche
@quotation Nota 
Mientras que los objetos `ConfigParser' también utilizan un atributo @code{OPTCRE} para reconocer las líneas de opciones, no se recomienda su sobre-escritura porque puede interferir con las opciones `allow_no_value' y `delimiters' del constructor.
@end quotation
@end cartouche
@end deffn

@node Ejemplos de la API heredada,Objetos ConfigParser,Personalizando el comportamiento del parser,configparser — Configuration file parser
@anchor{library/configparser legacy-api-examples}@anchor{2a87}
@subsubsection Ejemplos de la API heredada


@ref{23,,configparser} proporciona también una API heredada con métodos @code{get}/@code{set} explícitos; ello, principalmente debido a asuntos de compatibilidad con versiones anteriores. Aunque existen casos de uso válidos para los métodos descritos a continuación, se prefiere el acceso por protocolo de mapeo para los proyectos nuevos. La API heredada es al mismo tiempo más avanzada, de bajo nivel y sumamente contradictoria.

Un ejemplo de escritura a un archivo de configuración:

@example
import configparser

config = configparser.RawConfigParser()

# Please note that using RawConfigParser's set functions, you can assign
# non-string values to keys internally, but will receive an error when
# attempting to write to a file or when you get it in non-raw mode. Setting
# values using the mapping protocol or ConfigParser's set() does not allow
# such assignments to take place.
config.add_section('Section1')
config.set('Section1', 'an_int', '15')
config.set('Section1', 'a_bool', 'true')
config.set('Section1', 'a_float', '3.1415')
config.set('Section1', 'baz', 'fun')
config.set('Section1', 'bar', 'Python')
config.set('Section1', 'foo', '%(bar)s is %(baz)s!')

# Writing our configuration file to 'example.cfg'
with open('example.cfg', 'w') as configfile:
    config.write(configfile)
@end example

Un ejemplo de lectura de un archivo de configuración, nuevamente:

@example
import configparser

config = configparser.RawConfigParser()
config.read('example.cfg')

# getfloat() raises an exception if the value is not a float
# getint() and getboolean() also do this for their respective types
a_float = config.getfloat('Section1', 'a_float')
an_int = config.getint('Section1', 'an_int')
print(a_float + an_int)

# Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.
# This is because we are using a RawConfigParser().
if config.getboolean('Section1', 'a_bool'):
    print(config.get('Section1', 'foo'))
@end example

Para obtener la interpolación, utilice @ref{32b,,ConfigParser}:

@example
import configparser

cfg = configparser.ConfigParser()
cfg.read('example.cfg')

# Set the optional *raw* argument of get() to True if you wish to disable
# interpolation in a single get operation.
print(cfg.get('Section1', 'foo', raw=False))  # -> "Python is fun!"
print(cfg.get('Section1', 'foo', raw=True))   # -> "%(bar)s is %(baz)s!"

# The optional *vars* argument is a dict with members that will take
# precedence in interpolation.
print(cfg.get('Section1', 'foo', vars=@{'bar': 'Documentation',
                                       'baz': 'evil'@}))

# The optional *fallback* argument can be used to provide a fallback value
print(cfg.get('Section1', 'foo'))
      # -> "Python is fun!"

print(cfg.get('Section1', 'foo', fallback='Monty is not.'))
      # -> "Python is fun!"

print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))
      # -> "No such things as monsters."

# A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError
# but we can also use:

print(cfg.get('Section1', 'monster', fallback=None))
      # -> None
@end example

Los valores por defecto están disponibles en ambos tipos de ConfigParsers. Ellos son utilizados en la interpolación cuando una opción utilizada no está definida en otro lugar.

@example
import configparser

# New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
config = configparser.ConfigParser(@{'bar': 'Life', 'baz': 'hard'@})
config.read('example.cfg')

print(config.get('Section1', 'foo'))     # -> "Python is fun!"
config.remove_option('Section1', 'bar')
config.remove_option('Section1', 'baz')
print(config.get('Section1', 'foo'))     # -> "Life is hard!"
@end example

@node Objetos ConfigParser,Objetos RawConfigParser,Ejemplos de la API heredada,configparser — Configuration file parser
@anchor{library/configparser configparser-objects}@anchor{2a88}@anchor{library/configparser id13}@anchor{2a89}
@subsubsection Objetos ConfigParser


@geindex ConfigParser (clase en configparser)
@anchor{library/configparser configparser ConfigParser}@anchor{32b}
@deffn {Clase} configparser.ConfigParser (defaults=None, dict_type=dict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters=@{@}, allow_unnamed_section=False)

La `config parser' principal. Si se proporciona `defaults', su valor es inicializado en el diccionario de valores por defecto intrínsecos. Si se proporciona `dict_type', se utiliza para crear el diccionario de objetos para la lista de secciones, las opciones dentro de una sección, y los valores por defecto.

Si se proporciona `delimiters', se utiliza como un conjunto de cadenas de caracteres que dividen las claves de los valores. Si se proporciona `comment_prefixes', se utiliza como un conjunto de cadenas de caracteres que preceden a los comentarios, en líneas que estarían, de otro modo, vacías.  Los comentarios pueden estar indentados. Si se proporciona `inline_comment_prefixes', se utiliza como un conjunto de cadenas de caracteres que preceden a los comentarios en líneas que no están vacías.

Cuando `strict' es @code{True} (por defecto), el `parser' no permitirá duplicados en ninguna sección u opción, al realizar la lectura de una sola fuente (archivo, cadena de caracteres o diccionario), generando una excepción @ref{12dc,,DuplicateSectionError} ó @ref{12dd,,DuplicateOptionError}.  Cuando `empty_lines_in_values' es @code{False} (valor por defecto: @code{True}), cada línea en blanco indica el fin de una opción.  De otro modo, las líneas en blanco de una opción multilínea son tratadas como parte del valor de esta. Cuando `allow_no_value' es @code{True} (valor por defecto: @code{False}), se aceptan opciones sin valores; el valor que toman esas opciones es @code{None} y serán serializadas sin el delimitador final.

Cuando se proporciona `default_section', se define el nombre de la sección especial que contiene valores por defecto para otras secciones y con propósito de interpolación (habitualmente denominada @code{"DEFAULT"}). Este valor puede obtenerse y modificarse en tiempo de ejecución utilizando el atributo de instancia @code{default_section}. Esto no volverá a evaluar un fichero de configuración previamente analizado sintácticamente (`parsed'), pero se usará al escribir configuraciones de analizado sintáctico (`parsed') en un nuevo fichero de configuración.

La interpolación puede personalizarse al proporcionar un gestor personalizado, mediante el argumento `interpolation'. El valor @code{None} se utiliza para desactivar la interpolación completamente, @code{ExtendedInterpolation()} proporciona una variante avanzada, inspirada en @code{zc.buildout}. Más al respecto puede encontrarse en la @ref{2a82,,correspondiente sección de la documentación}.

Todos los nombres de opción que se utilizan en la interpolación pasarán por el método @ref{2a8a,,optionxform()}, igual que cualquier otra referencia a un nombre de opción. Por lo tanto, si se utiliza la implementación por defecto de @ref{2a8a,,optionxform()} (la cual convierte los nombres de opción a minúsculas), los valores @code{foo %(bar)s} y @code{foo %(BAR)s} son equivalentes.

When `converters' is given, it should be a dictionary where each key
represents the name of a type converter and each value is a callable
implementing the conversion from string to the desired datatype.  Every
converter gets its own corresponding @code{get*()} method on the parser
object and section proxies.

When `allow_unnamed_section' is @code{True} (default: @code{False}),
the first section name can be omitted. See the
@ref{2a81,,"Unnamed Sections" section}.

It is possible to read several configurations into a single
@ref{32b,,ConfigParser}, where the most recently added configuration has the
highest priority. Any conflicting keys are taken from the more recent
configuration while the previously existing keys are retained. The example
below reads in an @code{override.ini} file, which will override any conflicting
keys from the @code{example.ini} file.

@example
[DEFAULT]
ServerAliveInterval = -1
@end example

@example
>>> config_override = configparser.ConfigParser()
>>> config_override['DEFAULT'] = @{'ServerAliveInterval': '-1'@}
>>> with open('override.ini', 'w') as configfile:
...     config_override.write(configfile)
...
>>> config_override = configparser.ConfigParser()
>>> config_override.read(['example.ini', 'override.ini'])
['example.ini', 'override.ini']
>>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
-1
@end example


Distinto en la versión 3.1: El valor por defecto de `dict_type' es @ref{67c,,collections.OrderedDict}.



Distinto en la versión 3.2: se agregaron los argumentos `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' y `interpolation'.



Distinto en la versión 3.5: Se agregó el argumento `converters'.



Distinto en la versión 3.7: The `defaults' argument is read with @ref{2a83,,read_dict()},
providing consistent behavior across the parser: non-string
keys and values are implicitly converted to strings.



Distinto en la versión 3.8: El valor por defecto para `dict_type' es @ref{190,,dict}, dado que este ahora preserva el orden de inserción.



Distinto en la versión 3.13: Raise a @ref{2a8b,,MultilineContinuationError} when `allow_no_value' is
@code{True}, and a key without a value is continued with an indented line.



Distinto en la versión 3.13: The `allow_unnamed_section' argument was added.


@geindex defaults() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser defaults}@anchor{2a8c}
@deffn {Método} defaults ()

Retorna un diccionario que contiene los valores por defecto para toda la instancia.
@end deffn

@geindex sections() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser sections}@anchor{2a8d}
@deffn {Método} sections ()

Retorna una lista de las secciones disponibles; `default section' no se incluye en la lista.
@end deffn

@geindex add_section() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser add_section}@anchor{12db}
@deffn {Método} add_section (section)

Agrega una sección llamada `section' a la instancia. Si ya existe una sección con el nombre proporcionado, se genera la excepción @ref{12dc,,DuplicateSectionError}. Si se suministra el nombre `default section', se genera la excepción @ref{360,,ValueError}. El nombre de la sección debe ser una cadena de caracteres, de lo contrario, se genera la excepción @ref{228,,TypeError}.


Distinto en la versión 3.2: Nombres de sección que no sean del tipo cadena de caracteres generan la excepción @ref{228,,TypeError}.

@end deffn

@geindex has_section() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser has_section}@anchor{2a8e}
@deffn {Método} has_section (section)

Indica si la sección de nombre `section' existe en la configuración. No se permite `default section'.
@end deffn

@geindex options() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser options}@anchor{2a8f}
@deffn {Método} options (section)

Retorna una lista de opciones disponibles en la sección especificada.
@end deffn

@geindex has_option() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser has_option}@anchor{2a90}
@deffn {Método} has_option (section, option)

Si la sección indicada existe, y esta contiene las opción proporcionada, retorna @ref{c95,,True}; de lo contrario, retorna @ref{bbf,,False}. Si la sección especificada es @ref{716,,None} o una cadena de caracteres vacía, se asume DEFAULT.
@end deffn

@geindex read() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read}@anchor{14a5}
@deffn {Método} read (filenames, encoding=None)

Intenta leer y analizar sintácticamente (`parse') un iterable de nombres de archivos, retornando una lista de nombres de archivos que han sido analizados (`parsed') con éxito.

Si `filenames' es una cadena de caracteres, un objeto @ref{325,,bytes} o un @ref{3f0,,path-like object}, es tratado como un simple nombre de archivo. Si un archivo mencionado en `filenames' no puede ser abierto, será ignorado. Está diseñado de forma que puedas especificar un iterable de potenciales ubicaciones para archivos de configuración (por ejemplo, el directorio actual, el directorio `home' del usuario, o algún directorio del sistema), y todos los archivos de configuración existentes serán leídos.

Si no existe ninguno de los archivos mencionados, la instancia de @ref{32b,,ConfigParser} contendrá un conjunto de datos vacío. Una aplicación que requiera valores iniciales, que sean cargados desde un archivo,  deberá cargar el(los) archivo(s) requerido(s) utilizando @ref{5aa,,read_file()} antes de llamar a @ref{14a5,,read()} para cualquier otro archivo opcional:

@example
import configparser, os

config = configparser.ConfigParser()
config.read_file(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
            encoding='cp1250')
@end example


Distinto en la versión 3.2: Added the `encoding' parameter.
Previously, all files were read using the default encoding for @ref{1be,,open()}.



Distinto en la versión 3.6.1: El parámetro `filenames' acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.7: El parámetro `filenames' acepta un objeto @ref{325,,bytes}.

@end deffn

@geindex read_file() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_file}@anchor{5aa}
@deffn {Método} read_file (f, source=None)

Leer y analizar (`parse') los datos de configuración de `f', el cual debe ser un iterable que retorne cadenas de caracteres Unicode (por ejemplo, archivos abiertos en modo texto).

Optional argument `source' specifies the name of the file being read.  If
not given and `f' has a @code{name} attribute, that is used for
`source'; the default is @code{'<???>'}.


Added in version 3.2: Replaces @code{readfp()}.

@end deffn

@geindex read_string() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_string}@anchor{2a85}
@deffn {Método} read_string (string, source='<string>')

Analiza (`parse') los datos de configuración desde una cadena de caracteres.

El argumento opcional `source' especifica un nombre para la cadena de caracteres proporcionada, relativo al contexto. Si no se proporciona, se utiliza @code{'<string>'}. Esto, por lo general, debería ser una ruta de archivo o una URL.


Added in version 3.2.

@end deffn

@geindex read_dict() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_dict}@anchor{2a83}
@deffn {Método} read_dict (dictionary, source='<dict>')

Carga la configuración a partir de cualquier objeto que proporcione un método @code{items()}, similar a un diccionario. Las claves son nombres de secciones, los valores son diccionarios con claves y valores que deben estar presentes en la sección. Si el tipo de diccionario utilizado preserva el orden, las secciones y sus claves serán agregados en orden. Los valores son convertidos a cadenas de caracteres de forma automática.

El argumento opcional `source' especifica un nombre para el diccionario proporcionado, relativo al contexto. Si no se proporciona, se utiliza @code{<dict>}.

Este método puede utilizarse para copiar el estado entre `parsers'.


Added in version 3.2.

@end deffn

@geindex get() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser get}@anchor{12d9}
@deffn {Método} get (section, option, *, raw=False, vars=None[, fallback])

Obtiene el valor de una `option' para la sección indicada. Si se proporciona `vars', tiene que ser un diccionario. El valor de `option' será buscado en `vars' (si se proporciona), en `section' y en `DEFAULTSECT', en ese orden. Si la clave no se encuentra, y se ha proporcionado `fallback', este es utilizado como un valor de contingencia. Se puede utilizar @code{None} como valor de contingencia (`fallback').

Todas las interpolaciones @code{'%'} son expandidas en el valor retornado, a menos que el argumento `raw' sea `true'. Los valores para la interpolación de las claves son buscados de la misma forma que para la opción.


Distinto en la versión 3.2: Los argumentos `raw', `vars' y `fallback' son argumentos nombrados solamente, a fin de proteger a los usuarios de los intentos de emplear el tercer argumento como el valor de contingencia de `fallback' (especialmente cuando se utiliza el protocolo de mapeo).

@end deffn

@geindex getint() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getint}@anchor{2a7c}
@deffn {Método} getint (section, option, *, raw=False, vars=None[, fallback])

Un cómodo método para forzar a entero el valor de la opción de la sección indicada. Revise @ref{12d9,,get()} para una explicación acerca de `raw', `vars' y `fallback'.
@end deffn

@geindex getfloat() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getfloat}@anchor{2a7d}
@deffn {Método} getfloat (section, option, *, raw=False, vars=None[, fallback])

A convenience method which coerces the `option' in the specified `section'
to a floating-point number.  See @ref{12d9,,get()} for explanation of `raw',
`vars' and `fallback'.
@end deffn

@geindex getboolean() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getboolean}@anchor{2a7b}
@deffn {Método} getboolean (section, option, *, raw=False, vars=None[, fallback])

Un cómodo método para forzar a booleano el valor de la opción de la sección indicada. Tome nota que los valores aceptados para la opción son @code{'1'}, @code{'yes'}, @code{'true'}, and @code{'on'}, para que el método retorne @code{True}, y @code{'0'}, @code{'no'}, @code{'false'}, y @code{'off'} para que el método retorne @code{False}. Esos valores de cadenas de caracteres son revisados sin diferenciar mayúsculas de minúsculas. Cualquier otro valor ocasionará que se genere la excepción @ref{360,,ValueError}. Revise @ref{12d9,,get()} para una explicación acerca de `raw', `vars' y `fallback'.
@end deffn

@geindex items() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser items}@anchor{2a91}
@deffn {Método} items (raw=False, vars=None)

@deffnx {Método} items (section, raw=False, vars=None)

Cuando no se proporciona el argumento `section', retorna una lista de pares `section_name', `section_proxy', incluyendo DEFAULTSECT.

De lo contrario, retorna una lista de pares `name', `value' para las opciones de la sección especificada. Los argumentos opcionales tienen el mismo significado que en el método @ref{12d9,,get()}.


Distinto en la versión 3.8: Los elementos que estén en `vars' no aparecen en el resultado. El comportamiento previo mezcla las opciones actuales del `parser' con las variables proporcionadas para la interpolación.

@end deffn

@geindex set() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser set}@anchor{12da}
@deffn {Método} set (section, option, value)

Si la sección indicada existe, asigna el valor especificado a la opción indicada; en caso contrario, genera la excepción @ref{2a92,,NoSectionError}. `option' y `value' deben ser cadenas de caracteres; de lo contrario, se genera la excepción @ref{228,,TypeError}.
@end deffn

@geindex write() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser write}@anchor{2a84}
@deffn {Método} write (fileobject, space_around_delimiters=True)

Escribe una representación de la configuración al @ref{1230,,file object} especificado, el cual debe ser abierto en modo texto (aceptando cadenas de caracteres). Esta representación puede ser analizada (`parsed') por una posterior llamada a @ref{14a5,,read()}. Si `space_around_delimiters' es `true', los delimitadores entre claves y valores son rodeados por espacios.
@end deffn

@cartouche
@quotation Nota 
Los comentarios presentes en el fichero original no se mantienen cuando se vuelve a escribir la configuración. Qué es considerado un comentario depende de los valores asignados a `comment_prefix' e `inline_comment_prefix'.
@end quotation
@end cartouche

@geindex remove_option() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser remove_option}@anchor{2a93}
@deffn {Método} remove_option (section, option)

Elimina la opción especificada de la sección indicada. Si la sección no existe, se genera una excepción @ref{2a92,,NoSectionError}. Si la opción existía antes de la eliminación, retorna @ref{c95,,True}; de lo contrario retorna @ref{bbf,,False}.
@end deffn

@geindex remove_section() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser remove_section}@anchor{2a94}
@deffn {Método} remove_section (section)

Elimina la sección especificada de la configuración. Si la sección existía, retorna @code{True}. De lo contrario, retorna @code{False}.
@end deffn

@geindex optionxform() (método de configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser optionxform}@anchor{2a8a}
@deffn {Método} optionxform (option)

Transforma el nombre de opción `option' de la forma en que se encontraba en el archivo de entrada o como fue pasada por el código del cliente, a la forma en que debe ser utilizada en las estructuras internas. La implementación por defecto retorna una versión en minúsculas de `option'; las subclases pueden sobre-escribirla o el código del cliente puede asignar un atributo de su nombre en las instancias, para afectar su comportamiento.

No necesitas crear una subclase del `parser' para utilizar este método, ya que también puedes asignarlo en una instancia a una función, la cual reciba una cadena de caracteres como argumento y retorne otra. Por ejemplo, estableciéndola a @code{str}, se hará que los nombres de opciones sean sensibles a mayúsculas y minúsculas:

@example
cfgparser = ConfigParser()
cfgparser.optionxform = str
@end example

Tome en cuenta que cuando se leen archivos de configuración, los espacios en blanco alrededor de los nombres de opción son eliminados antes de llamar a @ref{2a8a,,optionxform()}.
@end deffn
@end deffn

@geindex UNNAMED_SECTION (en el módulo configparser)
@anchor{library/configparser configparser UNNAMED_SECTION}@anchor{15d8}
@deffn {Dato} configparser.UNNAMED_SECTION

A special object representing a section name used to reference the unnamed section (see @ref{2a81,,Unnamed Sections}).
@end deffn

@geindex MAX_INTERPOLATION_DEPTH (en el módulo configparser)
@anchor{library/configparser configparser MAX_INTERPOLATION_DEPTH}@anchor{2a95}
@deffn {Dato} configparser.MAX_INTERPOLATION_DEPTH

The maximum depth for recursive interpolation for @ref{12d9,,get()} when the `raw'
parameter is false.  This is relevant only when the default `interpolation'
is used.
@end deffn

@node Objetos RawConfigParser,Excepciones<7>,Objetos ConfigParser,configparser — Configuration file parser
@anchor{library/configparser id15}@anchor{2a96}@anchor{library/configparser rawconfigparser-objects}@anchor{2a97}
@subsubsection Objetos RawConfigParser


@geindex RawConfigParser (clase en configparser)
@anchor{library/configparser configparser RawConfigParser}@anchor{fe4}
@deffn {Clase} configparser.RawConfigParser (defaults=None, dict_type=dict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters=@{@}, allow_unnamed_section=False)

Variante heredada de @ref{32b,,ConfigParser}. Tiene la interpolación deshabilitada por defecto y permite nombres de sección que no sean cadenas de caracteres, nombres de opciones, y valores a través de sus métodos inseguros @code{add_section} y @code{set}, así como el manejo heredado del argumento nombrado @code{defaults=}.


Distinto en la versión 3.2: se agregaron los argumentos `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' y `interpolation'.



Distinto en la versión 3.5: Se agregó el argumento `converters'.



Distinto en la versión 3.8: El valor por defecto para `dict_type' es @ref{190,,dict}, dado que este ahora preserva el orden de inserción.



Distinto en la versión 3.13: The `allow_unnamed_section' argument was added.


@cartouche
@quotation Nota 
Considere el uso de @ref{32b,,ConfigParser} en su lugar, el cual verifica los tipos de datos de los valores que se almacenarán internamente. Si no quieres la interpolación, puedes utilizar @code{ConfigParser(interpolation=None)}.
@end quotation
@end cartouche

@geindex add_section() (método de configparser.RawConfigParser)
@anchor{library/configparser configparser RawConfigParser add_section}@anchor{2a98}
@deffn {Método} add_section (section)

Add a section named `section' or @ref{15d8,,UNNAMED_SECTION} to the instance.

If the given section already exists, @ref{12dc,,DuplicateSectionError} is
raised. If the `default section' name is passed, @ref{360,,ValueError} is
raised. If @ref{15d8,,UNNAMED_SECTION} is passed and support is disabled,
@ref{2a99,,UnnamedSectionDisabledError} is raised.

No se comprueba el tipo de datos de `section', con lo cual se permite que los usuarios creen secciones con nombres que no sean cadenas de caracteres. Este comportamiento no está soportado y puede ocasionar errores internos.
@end deffn


Distinto en la versión 3.14: Added support for @ref{15d8,,UNNAMED_SECTION}.


@geindex set() (método de configparser.RawConfigParser)
@anchor{library/configparser configparser RawConfigParser set}@anchor{2a9a}
@deffn {Método} set (section, option, value)

Si existe la sección indicada, asigna el valor especificado a la sección indicada; de lo contrario, genera la excepción @ref{2a92,,NoSectionError}. Aunque es posible utilizar @ref{fe4,,RawConfigParser} (ó @ref{32b,,ConfigParser} con parámetros `raw' con valor `true') como almacenamiento interno para valores que no sean cadenas de caracteres, el funcionamiento completo (incluyendo la interpolación y escritura en archivos) sólo puede lograrse utilizando valores del tipo cadena de caracteres.

Este método permite que los usuarios asignen valores que no sean cadenas de caracteres a las claves, internamente. Este comportamiento no está soportado y causará errores cuando se intente escribir en un archivo o cuando se intente obtenerlo en un modo no `raw'. `Utilice la API del protocolo de mapeo', la cual no permite ese tipo de asignaciones.
@end deffn
@end deffn

@node Excepciones<7>,,Objetos RawConfigParser,configparser — Configuration file parser
@anchor{library/configparser exceptions}@anchor{2a9b}
@subsubsection Excepciones


@geindex Error
@anchor{library/configparser configparser Error}@anchor{2a9c}
@deffn {Excepción} configparser.Error

Clase base para todas las otras excepciones @ref{23,,configparser}.
@end deffn

@geindex NoSectionError
@anchor{library/configparser configparser NoSectionError}@anchor{2a92}
@deffn {Excepción} configparser.NoSectionError

Excepción generada cuando no se encuentra una sección especificada.
@end deffn

@geindex DuplicateSectionError
@anchor{library/configparser configparser DuplicateSectionError}@anchor{12dc}
@deffn {Excepción} configparser.DuplicateSectionError

Exception raised if @ref{12db,,add_section()} is called with the name of a section
that is already present or in strict parsers when a section if found more
than once in a single input file, string or dictionary.


Distinto en la versión 3.2: Added the optional `source' and `lineno' attributes and parameters to
@code{__init__()}.

@end deffn

@geindex DuplicateOptionError
@anchor{library/configparser configparser DuplicateOptionError}@anchor{12dd}
@deffn {Excepción} configparser.DuplicateOptionError

Excepción generada por `parsers' estrictos si una sola opción aparece dos veces durante la lectura de un solo archivo, cadena de caracteres o diccionario. Captura errores de escritura o relacionados con el uso de mayúsculas y minúsculas, ej. un diccionario podría tener dos claves que representan la misma clave de configuración bajo un esquema insensible a mayúsculas y minúsculas.
@end deffn

@geindex NoOptionError
@anchor{library/configparser configparser NoOptionError}@anchor{2a9d}
@deffn {Excepción} configparser.NoOptionError

Excepción generada cuando una opción especificada no se encuentra en una sección indicada.
@end deffn

@geindex InterpolationError
@anchor{library/configparser configparser InterpolationError}@anchor{2a9e}
@deffn {Excepción} configparser.InterpolationError

Clase base para excepciones generadas por problemas que ocurren al realizar la interpolación de cadenas de caracteres.
@end deffn

@geindex InterpolationDepthError
@anchor{library/configparser configparser InterpolationDepthError}@anchor{2a9f}
@deffn {Excepción} configparser.InterpolationDepthError

Excepción generada cuando la interpolación de cadenas de caracteres no puede completarse, debido a que el número de iteraciones excede a @ref{2a95,,MAX_INTERPOLATION_DEPTH}. Subclase de @ref{2a9e,,InterpolationError}.
@end deffn

@geindex InterpolationMissingOptionError
@anchor{library/configparser configparser InterpolationMissingOptionError}@anchor{2aa0}
@deffn {Excepción} configparser.InterpolationMissingOptionError

Excepción generada cuando no existe una opción referida por un valor. Subclase de @ref{2a9e,,InterpolationError}.
@end deffn

@geindex InterpolationSyntaxError
@anchor{library/configparser configparser InterpolationSyntaxError}@anchor{2aa1}
@deffn {Excepción} configparser.InterpolationSyntaxError

Excepción generada cuando el texto fuente, donde se realizan las sustituciones, no se ajusta a la sintaxis requerida. Subclase de @ref{2a9e,,InterpolationError}.
@end deffn

@geindex MissingSectionHeaderError
@anchor{library/configparser configparser MissingSectionHeaderError}@anchor{2aa2}
@deffn {Excepción} configparser.MissingSectionHeaderError

Excepción generada cuando se intenta analizar (`parse') un archivo que no tiene encabezados de sección.
@end deffn

@geindex ParsingError
@anchor{library/configparser configparser ParsingError}@anchor{5a9}
@deffn {Excepción} configparser.ParsingError

Excepción generada cuando ocurren errores intentando analizar (`parse') un archivo.


Distinto en la versión 3.12: The @code{filename} attribute and @code{__init__()} constructor argument were
removed.  They have been available using the name @code{source} since 3.2.

@end deffn

@geindex MultilineContinuationError
@anchor{library/configparser configparser MultilineContinuationError}@anchor{2a8b}
@deffn {Excepción} configparser.MultilineContinuationError

Exception raised when a key without a corresponding value is continued with
an indented line.


Added in version 3.13.

@end deffn

@geindex UnnamedSectionDisabledError
@anchor{library/configparser configparser UnnamedSectionDisabledError}@anchor{2a99}
@deffn {Excepción} configparser.UnnamedSectionDisabledError

Exception raised when attempting to use the
@ref{15d8,,UNNAMED_SECTION} without enabling it.

@quotation


Added in version 3.14.

@end quotation
@end deffn

@subsubheading Notas al pie


@node tomllib — Parse TOML files,netrc — netrc file processing,configparser — Configuration file parser,Formatos de archivo
@anchor{library/tomllib doc}@anchor{2aa3}@anchor{library/tomllib module-tomllib}@anchor{fc}@anchor{library/tomllib tomllib-parse-toml-files}@anchor{2aa4}
@subsection @code{tomllib} — Parse TOML files


@geindex module; tomllib


Added in version 3.11.


`Código fuente:' Lib/tomllib@footnote{https://github.com/python/cpython/tree/main/Lib/tomllib}


__________________________________________________________________


This module provides an interface for parsing TOML 1.0.0 (Tom’s Obvious Minimal
Language, https://toml.io@footnote{https://toml.io/en/}). This module does not
support writing TOML.


@subsubheading Ver también


The Tomli-W package@footnote{https://pypi.org/project/tomli-w/}
is a TOML writer that can be used in conjunction with this module,
providing a write API familiar to users of the standard library
@ref{8d,,marshal} and @ref{a6,,pickle} modules.



@subsubheading Ver también


The TOML Kit package@footnote{https://pypi.org/project/tomlkit/}
is a style-preserving TOML library with both read and write capability.
It is a recommended replacement for this module for editing already
existing TOML files.


Este módulo define las siguientes funciones:

@geindex load() (en el módulo tomllib)
@anchor{library/tomllib tomllib load}@anchor{2aa5}
@deffn {Función} tomllib.load (fp, /, *, parse_float=float)

Lee un archivo TOML. El primer argumento debe ser un objeto de archivo legible y binario. Retorna un @ref{190,,dict}. Convierte los tipos TOML a Python utilizando esta @ref{2aa6,,tabla de conversión}.

`parse_float' will be called with the string of every TOML
float to be decoded.  By default, this is equivalent to @code{float(num_str)}.
This can be used to use another datatype or parser for TOML floats
(e.g. @ref{16a,,decimal.Decimal}). The callable must not return a
@ref{190,,dict} or a @ref{18e,,list}, else a @ref{360,,ValueError} is raised.

Un @ref{15a1,,TOMLDecodeError} se levantará en un documento TOML inválido.
@end deffn

@geindex loads() (en el módulo tomllib)
@anchor{library/tomllib tomllib loads}@anchor{15c1}
@deffn {Función} tomllib.loads (s, /, *, parse_float=float)

Carga TOML de un objeto @ref{237,,str}. Retorna un @ref{190,,dict}. Convierte los tipos TOML a Python utilizando esta @ref{2aa6,,tabla de conversión}. El argumento `parse_float' tiene el mismo significado que en @ref{2aa5,,load()}.

Un @ref{15a1,,TOMLDecodeError} se levantará en un documento TOML inválido.
@end deffn

Las siguientes excepciones están disponibles:

@geindex TOMLDecodeError
@anchor{library/tomllib tomllib TOMLDecodeError}@anchor{15a1}
@deffn {Excepción} tomllib.TOMLDecodeError (msg, doc, pos)

Subclass of @ref{360,,ValueError} with the following additional attributes:

@geindex msg (atributo de tomllib.TOMLDecodeError)
@anchor{library/tomllib tomllib TOMLDecodeError msg}@anchor{2aa7}
@deffn {Atributo} msg

The unformatted error message.
@end deffn

@geindex doc (atributo de tomllib.TOMLDecodeError)
@anchor{library/tomllib tomllib TOMLDecodeError doc}@anchor{2aa8}
@deffn {Atributo} doc

The TOML document being parsed.
@end deffn

@geindex pos (atributo de tomllib.TOMLDecodeError)
@anchor{library/tomllib tomllib TOMLDecodeError pos}@anchor{2aa9}
@deffn {Atributo} pos

The index of `doc' where parsing failed.
@end deffn

@geindex lineno (atributo de tomllib.TOMLDecodeError)
@anchor{library/tomllib tomllib TOMLDecodeError lineno}@anchor{2aaa}
@deffn {Atributo} lineno

The line corresponding to `pos'.
@end deffn

@geindex colno (atributo de tomllib.TOMLDecodeError)
@anchor{library/tomllib tomllib TOMLDecodeError colno}@anchor{2aab}
@deffn {Atributo} colno

The column corresponding to `pos'.
@end deffn


Distinto en la versión 3.14.0a1 (unreleased): Added the `msg', `doc' and `pos' parameters.
Added the @ref{2aa7,,msg}, @ref{2aa8,,doc}, @ref{2aa9,,pos}, @ref{2aaa,,lineno} and @ref{2aab,,colno} attributes.



Obsoleto desde la versión 3.14.0a1 (unreleased): Passing free-form positional arguments is deprecated.

@end deffn

@menu
* Ejemplos: Ejemplos<10>. 
* Tabla de conversión:: 

@end menu

@node Ejemplos<10>,Tabla de conversión,,tomllib — Parse TOML files
@anchor{library/tomllib examples}@anchor{2aac}
@subsubsection Ejemplos


Analiza un TOML file:

@example
import tomllib

with open("pyproject.toml", "rb") as f:
    data = tomllib.load(f)
@end example

Analiza un TOML string:

@example
import tomllib

toml_str = """
python-version = "3.11.0"
python-implementation = "CPython"
"""

data = tomllib.loads(toml_str)
@end example

@node Tabla de conversión,,Ejemplos<10>,tomllib — Parse TOML files
@anchor{library/tomllib conversion-table}@anchor{2aad}
@subsubsection Tabla de conversión

@anchor{library/tomllib toml-to-py-table}@anchor{2aa6}

@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

TOML

@tab

Python

@item

TOML document

@tab

dict

@item

cadena

@tab

str

@item

integer

@tab

int

@item

flotante

@tab

flotante (configurable con `parse_float')

@item

boolean

@tab

bool

@item

offset date-time

@tab

datetime.datetime (atributo @code{tzinfo} establecido en una instancia de @code{datetime.timezone})

@item

local date-time

@tab

datetime.datetime (atributo @code{tzinfo} establecido en @code{None})

@item

local date

@tab

datetime.date

@item

local time

@tab

datetime.time

@item

array

@tab

list

@item

tabla

@tab

dict

@item

inline table

@tab

dict

@item

array of tables

@tab

list of dicts

@end multitable


@node netrc — netrc file processing,plistlib — Generate and parse Apple plist files,tomllib — Parse TOML files,Formatos de archivo
@anchor{library/netrc doc}@anchor{2aae}@anchor{library/netrc module-netrc}@anchor{9b}@anchor{library/netrc netrc-netrc-file-processing}@anchor{2aaf}
@subsection @code{netrc} — netrc file processing


@geindex module; netrc

`Código fuente:' Lib/netrc.py@footnote{https://github.com/python/cpython/tree/main/Lib/netrc.py}


__________________________________________________________________


La clase @ref{18ca,,netrc} analiza y encapsula el formato del fichero netrc, usado por el programa Unix @code{ftp} y otros clientes FTP.

@geindex netrc (clase en netrc)
@anchor{library/netrc netrc netrc}@anchor{18ca}
@deffn {Clase} netrc.netrc ([file])

Una instancia de @ref{18ca,,netrc} o una instancia de una subclase encapsula la información del fichero netrc. El argumento de inicialización, si está presente, especifica el fichero a analizar. Si no se pasan argumentos, se leerá el fichero @code{.netrc} del directorio home del usuario – determinado por @ref{aa6,,os.path.expanduser()}. De lo contrario, se lanzará una excepción @ref{f46,,FileNotFoundError}. Los errores de análisis lanzarán una excepción @ref{2ab0,,NetrcParseError} con información de diagnóstico que incluye nombre del fichero, número de línea y token de finalización. Si no se especifica ningún argumento en un sistema POSIX, la presencia de contraseñas en el fichero @code{.netrc} lanzará una excepción @ref{2ab0,,NetrcParseError} si la propiedad del fichero o los permisos son inseguros (el propietario del fichero es distinto del usuario que ejecuta el proceso, o puede ser leído o escrito por cualquier otro usuario). Esto implementa un nivel de seguridad equivalente al de ftp y otros programas que usan @code{.netrc}.


Distinto en la versión 3.4: Añadida la comprobación de permisos POSIX.



Distinto en la versión 3.7: @ref{aa6,,os.path.expanduser()} se usa para encontrar la localización del fichero @code{.netrc} cuando `file' no se pasa como argumento.



Distinto en la versión 3.10: @ref{9b,,netrc} prueba la codificación UTF-8 antes de usar la codificación específica en la configuración regional. Ya no es necesario que la entrada en el archivo netrc contenga todos los tokens. El valor predeterminado para los tokens faltantes es una cadena de caracteres vacía. Todos los tokens y sus valores ahora pueden contener caracteres arbitrarios, como espacios en blanco y caracteres no ASCII. Si el nombre de login es anónimo, no se disparará el chequeo de seguridad.

@end deffn

@geindex NetrcParseError
@anchor{library/netrc netrc NetrcParseError}@anchor{2ab0}
@deffn {Excepción} netrc.NetrcParseError

Excepción lanzada por la clase @ref{18ca,,netrc} cuando se encuentran errores sintácticos en el texto origen. Las instancias de esta excepción ofrecen tres atributos interesantes:

@geindex msg (atributo de netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError msg}@anchor{2ab1}
@deffn {Atributo} msg

Explicación textual del error.
@end deffn

@geindex filename (atributo de netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError filename}@anchor{2ab2}
@deffn {Atributo} filename

El nombre del archivo fuente.
@end deffn

@geindex lineno (atributo de netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError lineno}@anchor{2ab3}
@deffn {Atributo} lineno

El número de línea donde se encontró el error.
@end deffn
@end deffn

@menu
* Objetos netrc:: 

@end menu

@node Objetos netrc,,,netrc — netrc file processing
@anchor{library/netrc id1}@anchor{2ab4}@anchor{library/netrc netrc-objects}@anchor{2ab5}
@subsubsection Objetos netrc


Una instancia @ref{18ca,,netrc} tiene los siguientes métodos:

@geindex authenticators() (método de netrc.netrc)
@anchor{library/netrc netrc netrc authenticators}@anchor{2ab6}
@deffn {Método} netrc.authenticators (host)

Retorna una 3-tupla @code{(login, account, password)} para autenticarse contra `host'. Si el fichero netrc no contiene una entrada para el host dado, retorna una tupla asociada con la entrada por defecto. Si no están disponibles ni el host correspondiente ni la entrada por defecto, retorna @code{None}.
@end deffn

@geindex __repr__() (método de netrc.netrc)
@anchor{library/netrc netrc netrc __repr__}@anchor{2ab7}
@deffn {Método} netrc.__repr__ ()

Vuelca los datos de la clase como una cadena de caracteres en el formato de un fichero netrc. (Esto descarta comentarios y puede reordenar las entradas.)
@end deffn

Las instancias de @ref{18ca,,netrc} tienen variables de instancia públicas:

@geindex hosts (atributo de netrc.netrc)
@anchor{library/netrc netrc netrc hosts}@anchor{2ab8}
@deffn {Atributo} netrc.hosts

Diccionario que asocia nombres de hosts a tuplas @code{(login, account, password)}. La entrada por defecto, si existe, está representada como un pseudo-host por ese nombre.
@end deffn

@geindex macros (atributo de netrc.netrc)
@anchor{library/netrc netrc netrc macros}@anchor{2ab9}
@deffn {Atributo} netrc.macros

Diccionario que asocia nombres de macros a listas de cadenas de caracteres.
@end deffn

@node plistlib — Generate and parse Apple plist files,,netrc — netrc file processing,Formatos de archivo
@anchor{library/plistlib doc}@anchor{2aba}@anchor{library/plistlib module-plistlib}@anchor{ab}@anchor{library/plistlib plistlib-generate-and-parse-apple-plist-files}@anchor{2abb}
@subsection @code{plistlib} — Generate and parse Apple @code{.plist} files


@geindex module; plistlib

@c (harvested from docstrings in the original file)

`Código fuente:' Lib/plistlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/plistlib.py}

@geindex plist;file
@geindex property list


__________________________________________________________________


Este módulo proporciona una interfaz para leer y escribir los archivos de «lista de propiedades» utilizados por Apple, principalmente en macOS e iOS. Este módulo admite archivos plist binarios y XML.

El formato de lista de propiedades (@code{.plist}) es una serialización simple que soporta tipos de objetos básicos, como diccionarios, listas, números y cadenas. Generalmente el objeto de nivel superior es un diccionario.

Para escribir y analizar un archivo plist usa las funciones @ref{9e4,,dump()} y @ref{9e2,,load()}.

To work with plist data in bytes or string objects, use @ref{9e5,,dumps()}
and @ref{9e3,,loads()}.

Los valores pueden ser cadenas, enteros, flotantes, booleanos, tuplas, listas, diccionarios (pero solo con claves de cadena), @ref{325,,bytes}, @ref{5e0,,bytearray} u objetos @ref{32f,,datetime.datetime}.


Distinto en la versión 3.4: Nueva API, API antigua obsoleta. Añadido soporte para plists en formato binario.



Distinto en la versión 3.8: Añadido soporte para lectura y escritura de tokens @ref{ab3,,UID} en plists binarios como lo usan NSKeyedArchiver y NSKeyedUnarchiver.



Distinto en la versión 3.9: API antigua eliminada.



@subsubheading Ver también



@table @asis

@item PList manual page@footnote{https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/PropertyLists/}

Documentación de Apple del formato de archivo.
@end table


Este módulo define las siguientes funciones:

@geindex load() (en el módulo plistlib)
@anchor{library/plistlib plistlib load}@anchor{9e2}
@deffn {Función} plistlib.load (fp, *, fmt=None, dict_type=dict, aware_datetime=False)

Lee un archivo plist. `fp' debe ser un objeto de archivo binario y legible. Retorna el objeto raíz desempaquetado (el cual generalmente es un diccionario).

El `fmt' es el formato del archivo y los siguientes valores son válidos:


@itemize *

@item 
@ref{716,,None}: Autodetecta el formato de archivo

@item 
@ref{ff8,,FMT_XML}: Formato de archivo XML

@item 
@ref{ff9,,FMT_BINARY}: Formato binario plist
@end itemize

EL `dict_type' es el tipo usado por los diccionarios que son leídos del archivo plist.

When `aware_datetime' is true, fields with type @code{datetime.datetime} will
be created as @ref{2426,,aware object}, with
@code{tzinfo} as @ref{594,,datetime.UTC}.

Los datos XML para el formato @ref{ff8,,FMT_XML} son analizados usando el analizador Expat desde @ref{126,,xml.parsers.expat} – consulte su documentación para conocer las posibles excepciones en XML mal formado. Elementos desconocidos serán simplemente ignorados por el analizador plist.

El analizar para el formato binario lanza @code{InvalidFileException} cuando el archivo no puede ser analizado.


Added in version 3.4.



Distinto en la versión 3.13: The keyword-only parameter `aware_datetime' has been added.

@end deffn

@geindex loads() (en el módulo plistlib)
@anchor{library/plistlib plistlib loads}@anchor{9e3}
@deffn {Función} plistlib.loads (data, *, fmt=None, dict_type=dict, aware_datetime=False)

Load a plist from a bytes or string object. See @ref{9e2,,load()} for an
explanation of the keyword arguments.


Added in version 3.4.



Distinto en la versión 3.13: `data' can be a string when `fmt' equals @ref{ff8,,FMT_XML}.

@end deffn

@geindex dump() (en el módulo plistlib)
@anchor{library/plistlib plistlib dump}@anchor{9e4}
@deffn {Función} plistlib.dump (value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

Escribe `value' a un archivo plist. `Fp' debe ser un objeto de archivo binario escribible.

El argumento `fmt' especifica el formato del archivo plist y puede ser uno de los siguientes valores:


@itemize *

@item 
@ref{ff8,,FMT_XML}: Archivo plist con formato XML

@item 
@ref{ff9,,FMT_BINARY}: Archivo plist con formato binario
@end itemize

Cuando `sort_keys' es verdadero (el valor por defecto) las claves para los diccionarios serán escritas al plist ordenadamente, si no serán escritas en el orden de iteración del diccionario.

Cuando `skipkeys' es falso (el valor por defecto) la función lanza @ref{228,,TypeError} cuando una clave del diccionario no es una cadena de caracteres, si no tales claves serán omitidas.

When `aware_datetime' is true and any field with type @code{datetime.datetime}
is set as an @ref{2426,,aware object}, it will convert to
UTC timezone before writing it.

Una excepción @ref{228,,TypeError} será levantada si el objeto es un tipo no admitido o el contenedor que contiene tipos no admitidos.

Una excepción @ref{919,,OverflowError} será levantada para valores enteros que no pueden ser representados en archivos plist (binarios).


Added in version 3.4.



Distinto en la versión 3.13: The keyword-only parameter `aware_datetime' has been added.

@end deffn

@geindex dumps() (en el módulo plistlib)
@anchor{library/plistlib plistlib dumps}@anchor{9e5}
@deffn {Función} plistlib.dumps (value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

Retorna `value' como un objeto de bytes con formato plist. Consulte la documentación de @ref{9e4,,dump()} para una explicación de los argumentos de palabra clave de esta función.


Added in version 3.4.

@end deffn

Las siguientes clases están disponibles:

@geindex UID (clase en plistlib)
@anchor{library/plistlib plistlib UID}@anchor{ab3}
@deffn {Clase} plistlib.UID (data)

Envuelve un @ref{1f0,,int}. Este es usado leyendo o escribiendo datos codificados NSKeyedArchiver, los cuales contienen UID (ver manual PList).

Tiene un atributo, @code{data}, que se puede utilizar para recuperar el valor int del UID. @code{data} debe estar en el rango @code{0 <= data < 2**64}.


Added in version 3.8.

@end deffn

Las siguientes constantes están disponibles:

@geindex FMT_XML (en el módulo plistlib)
@anchor{library/plistlib plistlib FMT_XML}@anchor{ff8}
@deffn {Dato} plistlib.FMT_XML

El formato XML para archivos plist.


Added in version 3.4.

@end deffn

@geindex FMT_BINARY (en el módulo plistlib)
@anchor{library/plistlib plistlib FMT_BINARY}@anchor{ff9}
@deffn {Dato} plistlib.FMT_BINARY

El formato binario para archivos plist


Added in version 3.4.

@end deffn

@menu
* Ejemplos: Ejemplos<11>. 

@end menu

@node Ejemplos<11>,,,plistlib — Generate and parse Apple plist files
@anchor{library/plistlib examples}@anchor{2abc}
@subsubsection Ejemplos


Generar un plist:

@example
import datetime
import plistlib

pl = dict(
    aString = "Doodah",
    aList = ["A", "B", 12, 32.1, [1, 2, 3]],
    aFloat = 0.1,
    anInt = 728,
    aDict = dict(
        anotherString = "<hello & hi there!>",
        aThirdString = "M\xe4ssig, Ma\xdf",
        aTrueValue = True,
        aFalseValue = False,
    ),
    someData = b"<binary gunk>",
    someMoreData = b"<lots of binary gunk>" * 10,
    aDate = datetime.datetime.now()
)
print(plistlib.dumps(pl).decode())
@end example

Analizar un plist:

@example
import plistlib

plist = b"""<plist version="1.0">
<dict>
    <key>foo</key>
    <string>bar</string>
</dict>
</plist>"""
pl = plistlib.loads(plist)
print(pl["foo"])
@end example

@node Servicios criptográficos,Servicios genéricos del sistema operativo,Formatos de archivo,La biblioteca estándar de Python
@anchor{library/crypto doc}@anchor{2abd}@anchor{library/crypto crypto}@anchor{2abe}@anchor{library/crypto cryptographic-services}@anchor{2abf}
@section Servicios criptográficos


@geindex criptografía

The modules described in this chapter implement various algorithms of a
cryptographic nature.  They are available at the discretion of the installation.
Here’s an overview:

@menu
* hashlib — Secure hashes and message digests:: 
* hmac — Keyed-Hashing for Message Authentication:: 
* secrets — Generate secure random numbers for managing secrets:: 

@end menu

@node hashlib — Secure hashes and message digests,hmac — Keyed-Hashing for Message Authentication,,Servicios criptográficos
@anchor{library/hashlib doc}@anchor{2ac0}@anchor{library/hashlib hashlib-secure-hashes-and-message-digests}@anchor{2ac1}@anchor{library/hashlib module-hashlib}@anchor{68}
@subsection @code{hashlib} — Secure hashes and message digests


@geindex module; hashlib

`Código fuente:' Lib/hashlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/hashlib.py}

@geindex message digest@comma{} MD5
@geindex secure hash algorithm@comma{} SHA1@comma{} SHA2@comma{} SHA224@comma{} SHA256@comma{} SHA384@comma{} SHA512@comma{} SHA3@comma{} Shake@comma{} Blake2

@c import hashlib


__________________________________________________________________


This module implements a common interface to many different secure hash and
message digest algorithms.  Included are the FIPS secure hash algorithms SHA1,
SHA224, SHA256, SHA384, SHA512, (defined in the FIPS 180-4 standard@footnote{https://csrc.nist.gov/pubs/fips/180-4/upd1/final}),
the SHA-3 series (defined in the FIPS 202 standard@footnote{https://csrc.nist.gov/pubs/fips/202/final}) as well as RSA’s MD5
algorithm (defined in internet 
@geindex RFC; RFC 1321
RFC 1321@footnote{https://datatracker.ietf.org/doc/html/rfc1321.html}).  The terms «secure hash» and
«message digest» are interchangeable.  Older algorithms were called message
digests.  The modern term is secure hash.

@cartouche
@quotation Nota 
Si quieres las funciones de hash adler32 o crc32, están disponibles en el módulo @ref{132,,zlib}.
@end quotation
@end cartouche

@menu
* Algoritmos de hash:: 
* Usage:: 
* Constructors:: 
* Attributes:: 
* Hash Objects:: 
* Resúmenes SHAKE de largo variable:: 
* Cifrado de archivos:: 
* Derivación de clave:: 
* BLAKE2:: 

@end menu

@node Algoritmos de hash,Usage,,hashlib — Secure hashes and message digests
@anchor{library/hashlib hash-algorithms}@anchor{2ac2}@anchor{library/hashlib id1}@anchor{2ac3}
@subsubsection Algoritmos de hash


There is one constructor method named for each type of `hash'.  All return
a hash object with the same simple interface. For example: use @ref{2ac4,,sha256()}
to create a SHA-256 hash object. You can now feed this object with
@ref{db4,,bytes-like objects} (normally @ref{325,,bytes}) using
the @ref{2ac5,,update} method.  At any point you can ask it for the
`digest' of the concatenation of the data fed to it so far using the
@ref{2ac6,,digest()} or @ref{2ac7,,hexdigest()} methods.

To allow multithreading, the Python @ref{2c5,,GIL} is released while computing a
hash supplied more than 2047 bytes of data at once in its constructor or
@ref{2ac5,,.update} method.

@geindex OpenSSL;(use in module hashlib)

Constructors for hash algorithms that are always present in this module are
@ref{2ac8,,sha1()}, @ref{2ac9,,sha224()}, @ref{2ac4,,sha256()}, @ref{2aca,,sha384()}, @ref{2acb,,sha512()},
@ref{d2b,,sha3_224()}, @ref{d2c,,sha3_256()}, @ref{d2d,,sha3_384()}, @ref{d2e,,sha3_512()},
@ref{d2f,,shake_128()}, @ref{d30,,shake_256()}, @ref{6e3,,blake2b()}, and @ref{6e4,,blake2s()}.
@ref{2acc,,md5()} is normally available as well, though it may be missing or blocked
if you are using a rare «FIPS compliant» build of Python.
These correspond to @ref{13d3,,algorithms_guaranteed}.

Additional algorithms may also be available if your Python distribution’s
@ref{68,,hashlib} was linked against a build of OpenSSL that provides others.
Others `are not guaranteed available' on all installations and will only be
accessible by name via @ref{1951,,new()}.  See @ref{13d4,,algorithms_available}.

@cartouche
@quotation Advertencia 
Some algorithms have known hash collision weaknesses (including MD5 and
SHA1). Refer to Attacks on cryptographic hash algorithms@footnote{https://en.wikipedia.org/wiki/Cryptographic_hash_function#Attacks_on_cryptographic_hash_algorithms} and the
@ref{2acd,,hashlib-seealso} section at the end of this document.
@end quotation
@end cartouche


Added in version 3.6: SHA3 (Keccak) and SHAKE constructors @ref{d2b,,sha3_224()}, @ref{d2c,,sha3_256()},
@ref{d2d,,sha3_384()}, @ref{d2e,,sha3_512()}, @ref{d2f,,shake_128()}, @ref{d30,,shake_256()}
were added.
@ref{6e3,,blake2b()} and @ref{6e4,,blake2s()} were added.

@anchor{library/hashlib hashlib-usedforsecurity}@anchor{2ace}

Distinto en la versión 3.9: Todos los constructores hashlib toman un argumento de solo palabra clave `usedforsecurity' con el valor predeterminado @code{True}. Un valor falso permite el uso de algoritmos hash inseguros y bloqueados en entornos restringidos. @code{False} indica que el algoritmo hash no se utiliza en un contexto de seguridad, por ejemplo, como una función de compresión unidireccional no criptográfica.



Distinto en la versión 3.9: Hashlib now uses SHA3 and SHAKE from OpenSSL if it provides it.



Distinto en la versión 3.12: For any of the MD5, SHA1, SHA2, or SHA3 algorithms that the linked
OpenSSL does not provide we fall back to a verified implementation from
the HACL* project@footnote{https://github.com/hacl-star/hacl-star}.


@node Usage,Constructors,Algoritmos de hash,hashlib — Secure hashes and message digests
@anchor{library/hashlib usage}@anchor{2acf}
@subsubsection Usage


To obtain the digest of the byte string @code{b"Nobody inspects the spammish
repetition"}:

@example
>>> import hashlib
>>> m = hashlib.sha256()
>>> m.update(b"Nobody inspects")
>>> m.update(b" the spammish repetition")
>>> m.digest()
b'\x03\x1e\xdd@}Ae\x15\x93\xc5\xfe\\\x00o\xa5u+7\xfd\xdf\xf7\xbcN\x84:\xa6\xaf\x0c\x95\x0fK\x94\x06'
>>> m.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

Más resumido:

@example
>>> hashlib.sha256(b"Nobody inspects the spammish repetition").hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@node Constructors,Attributes,Usage,hashlib — Secure hashes and message digests
@anchor{library/hashlib constructors}@anchor{2ad0}
@subsubsection Constructors


@geindex new() (en el módulo hashlib)
@anchor{library/hashlib hashlib new}@anchor{1951}
@deffn {Función} hashlib.new (name[, data], *, usedforsecurity=True)

Is a generic constructor that takes the string `name' of the desired
algorithm as its first parameter.  It also exists to allow access to the
above listed hashes as well as any other algorithms that your OpenSSL
library may offer.
@end deffn

Using @ref{1951,,new()} with an algorithm name:

@example
>>> h = hashlib.new('sha256')
>>> h.update(b"Nobody inspects the spammish repetition")
>>> h.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@geindex md5() (en el módulo hashlib)
@anchor{library/hashlib hashlib md5}@anchor{2acc}
@deffn {Función} hashlib.md5 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha1() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha1}@anchor{2ac8}
@deffn {Función} hashlib.sha1 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha224() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha224}@anchor{2ac9}
@deffn {Función} hashlib.sha224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha256() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha256}@anchor{2ac4}
@deffn {Función} hashlib.sha256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha384() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha384}@anchor{2aca}
@deffn {Función} hashlib.sha384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha512() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha512}@anchor{2acb}
@deffn {Función} hashlib.sha512 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_224() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha3_224}@anchor{d2b}
@deffn {Función} hashlib.sha3_224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_256() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha3_256}@anchor{d2c}
@deffn {Función} hashlib.sha3_256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_384() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha3_384}@anchor{d2d}
@deffn {Función} hashlib.sha3_384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_512() (en el módulo hashlib)
@anchor{library/hashlib hashlib sha3_512}@anchor{d2e}
@deffn {Función} hashlib.sha3_512 ([data], *, usedforsecurity=True)
@end deffn

Named constructors such as these are faster than passing an algorithm name to
@ref{1951,,new()}.

@node Attributes,Hash Objects,Constructors,hashlib — Secure hashes and message digests
@anchor{library/hashlib attributes}@anchor{2ad1}
@subsubsection Attributes


Hashlib provides the following constant module attributes:

@geindex algorithms_guaranteed (en el módulo hashlib)
@anchor{library/hashlib hashlib algorithms_guaranteed}@anchor{13d3}
@deffn {Dato} hashlib.algorithms_guaranteed

Un conjunto que contiene los nombres de los algoritmos garantizados a ser soportados por este módulo en todas las plataformas. Ten en cuenta que “md5” se encuentra en esta lista a pesar de que algunos proveedores ofrecen una extraña construcción Python «compatible con FIPS» que la excluye.


Added in version 3.2.

@end deffn

@geindex algorithms_available (en el módulo hashlib)
@anchor{library/hashlib hashlib algorithms_available}@anchor{13d4}
@deffn {Dato} hashlib.algorithms_available

Un conjunto que contiene los nombres de los algoritmos de hash que están disponibles en el intérprete de Python en ejecución. Estos nombres serán reconocidos cuando sean pasados a @ref{1951,,new()}. @ref{13d3,,algorithms_guaranteed} siempre será un subconjunto. El mismo algoritmo puede aparecer múltiples veces en este conjunto bajo diferentes nombres (gracias a OpenSSL).


Added in version 3.2.

@end deffn

@node Hash Objects,Resúmenes SHAKE de largo variable,Attributes,hashlib — Secure hashes and message digests
@anchor{library/hashlib hash-objects}@anchor{2ad2}
@subsubsection Hash Objects


Los siguientes valores son provistos como atributos constantes de los objetos hash retornados por los constructores:

@geindex hash.digest_size (en el módulo hashlib)
@anchor{library/hashlib hashlib hash digest_size}@anchor{2ad3}
@deffn {Dato} hash.digest_size

El tamaño del hash resultante en bytes.
@end deffn

@geindex hash.block_size (en el módulo hashlib)
@anchor{library/hashlib hashlib hash block_size}@anchor{2ad4}
@deffn {Dato} hash.block_size

El tamaño del bloque interno del algoritmo de hash en bytes.
@end deffn

Un objeto hash tiene los siguientes atributos:

@geindex name (atributo de hashlib.hash)
@anchor{library/hashlib hashlib hash name}@anchor{fc8}
@deffn {Atributo} hash.name

El nombre canónico de este hash, siempre en minúsculas y siempre adecuado como un parámetro a @ref{1951,,new()} para crear otro hash de este tipo.


Distinto en la versión 3.4: El atributo `name' ha estado presente en CPython desde su inicio, pero desde Python 3.4 no fue especificado formalmente, por lo que puede no existir en algunas plataformas.

@end deffn

Un objeto hash tiene los siguientes métodos:

@geindex update() (método de hashlib.hash)
@anchor{library/hashlib hashlib hash update}@anchor{2ac5}
@deffn {Método} hash.update (data)

Actualiza el objeto de hash con el @ref{db4,,bytes-like object}. Invocaciones repetidas son equivalentes a una única invocación con la concatenación de todos los argumentos: @code{m.update(a); m.update(b)} es equivalente a @code{m.update(a+b)}.
@end deffn

@geindex digest() (método de hashlib.hash)
@anchor{library/hashlib hashlib hash digest}@anchor{2ac6}
@deffn {Método} hash.digest ()

Retorna el resumen de los datos pasados al método @ref{2ac5,,update()} hasta el momento. Este es un objeto de bytes de tamaño @ref{2ad3,,digest_size} el cual puede contener bytes en el rango completo desde 0 a 255.
@end deffn

@geindex hexdigest() (método de hashlib.hash)
@anchor{library/hashlib hashlib hash hexdigest}@anchor{2ac7}
@deffn {Método} hash.hexdigest ()

Como @ref{2ac6,,digest()} excepto que el resumen es retornado como un objeto de cadena del doble de largo, conteniendo sólo dígitos hexadecimales. Este puede ser usado para intercambiar el valor de forma segura en correos electrónicos u otros entornos no binarios.
@end deffn

@geindex copy() (método de hashlib.hash)
@anchor{library/hashlib hashlib hash copy}@anchor{2ad5}
@deffn {Método} hash.copy ()

Retorna una copia («clon») del objeto hash. Este puede ser usado para calcular eficientemente los resúmenes de datos compartiendo una subcadena inicial común.
@end deffn

@node Resúmenes SHAKE de largo variable,Cifrado de archivos,Hash Objects,hashlib — Secure hashes and message digests
@anchor{library/hashlib shake-variable-length-digests}@anchor{2ad6}
@subsubsection Resúmenes SHAKE de largo variable


@geindex shake_128() (en el módulo hashlib)
@anchor{library/hashlib hashlib shake_128}@anchor{d2f}
@deffn {Función} hashlib.shake_128 ([data], *, usedforsecurity=True)
@end deffn

@geindex shake_256() (en el módulo hashlib)
@anchor{library/hashlib hashlib shake_256}@anchor{d30}
@deffn {Función} hashlib.shake_256 ([data], *, usedforsecurity=True)
@end deffn

Los algoritmos @ref{d2f,,shake_128()} y @ref{d30,,shake_256()} proveen resúmenes de largo variable con largo_en_bits//2 hasta 128 ó 256 bits de seguridad. Como tales, sus métodos de resumen requieren un largo. El largo máximo no está limitado por el algoritmo SHAKE.

@geindex digest() (método de hashlib.shake)
@anchor{library/hashlib hashlib shake digest}@anchor{1a40}
@deffn {Método} shake.digest (length)

Return the digest of the data passed to the @ref{2ac5,,update()} method so far.
This is a bytes object of size `length' which may contain bytes in
the whole range from 0 to 255.
@end deffn

@geindex hexdigest() (método de hashlib.shake)
@anchor{library/hashlib hashlib shake hexdigest}@anchor{1a41}
@deffn {Método} shake.hexdigest (length)

Like @ref{1a40,,digest()} except the digest is returned as a string object of
double length, containing only hexadecimal digits.  This may be used to
exchange the value in email or other non-binary environments.
@end deffn

Example use:

@example
>>> h = hashlib.shake_256(b'Nobody inspects the spammish repetition')
>>> h.hexdigest(20)
'44709d6fcb83d92a76dcb0b668c98e1b1d3dafe7'
@end example

@node Cifrado de archivos,Derivación de clave,Resúmenes SHAKE de largo variable,hashlib — Secure hashes and message digests
@anchor{library/hashlib file-hashing}@anchor{2ad7}
@subsubsection Cifrado de archivos


El módulo hashlib proporciona una función de ayuda para el cifrado eficiente de un archivo o un objeto similar a un archivo.

@geindex file_digest() (en el módulo hashlib)
@anchor{library/hashlib hashlib file_digest}@anchor{6e5}
@deffn {Función} hashlib.file_digest (fileobj, digest, /)

Retorna un objeto digest que ha sido actualizado con el contenido del objeto de tipo archivo.

`fileobj' debe ser un objeto similar a un archivo abierto para lectura en modo binario. Acepta objetos fichero de instancias @ref{1be,,open()}, @ref{f25,,BytesIO}, objetos SocketIO de @ref{120e,,socket.socket.makefile()}, y similares. La función puede saltarse la E/S de Python y usar directamente el descriptor de fichero de @ref{2848,,fileno()}. Debe asumirse que `fileobj' está en un estado desconocido después de que esta función devuelva o lance. Es responsabilidad del que llama cerrar `fileobj'.

`digest' debe ser un nombre de algoritmo de cifrado como `str', un constructor de cifrado o un invocable que devuelva un objeto cifrado.

Ejemplo:

@example
>>> import io, hashlib, hmac
>>> with open(hashlib.__file__, "rb") as f:
...     digest = hashlib.file_digest(f, "sha256")
...
>>> digest.hexdigest()  
'...'
@end example

@example
>>> buf = io.BytesIO(b"somedata")
>>> mac1 = hmac.HMAC(b"key", digestmod=hashlib.sha512)
>>> digest = hashlib.file_digest(buf, lambda: mac1)
@end example

@example
>>> digest is mac1
True
>>> mac2 = hmac.HMAC(b"key", b"somedata", digestmod=hashlib.sha512)
>>> mac1.digest() == mac2.digest()
True
@end example


Added in version 3.11.

@end deffn

@node Derivación de clave,BLAKE2,Cifrado de archivos,hashlib — Secure hashes and message digests
@anchor{library/hashlib key-derivation}@anchor{2ad8}
@subsubsection Derivación de clave


Los algoritmos de derivación de clave y estiramiento de clave están diseñados para el cifrado seguro de contraseña. Algoritmos ingenuos como @code{sha1(password)} no son resistentes contra ataques de fuerza bruta. Una buena función hash de contraseña debe ser afinable, lenta e incluir una sal@footnote{https://en.wikipedia.org/wiki/Salt_%28cryptography%29}.

@geindex pbkdf2_hmac() (en el módulo hashlib)
@anchor{library/hashlib hashlib pbkdf2_hmac}@anchor{5b3}
@deffn {Función} hashlib.pbkdf2_hmac (hash_name, password, salt, iterations, dklen=None)

La función provee contraseñas PKCS#5 basadas en función de derivación de clave 2. Usa HMAC como función de pseudoaleatoriedad.

La cadena `hash_name' es el nombre deseado del algoritmo de resumen de hash para HMAC, ej. “sha1” o “sha256”. `password' y `salt' son interpretados como búferes de bytes. Aplicaciones y bibliotecas deberían limitar `password' a un largo razonable (ej. 1024). `salt' debería ser sobre 16 o más bytes desde una fuente adecuada, ej. @ref{5c6,,os.urandom()}.

El número de `iterations' debe elegirse en función del algoritmo de cifrado y la potencia de cálculo. A partir de 2022, se sugieren cientos de miles de iteraciones de SHA-256. Para saber por qué y cómo elegir lo mejor para su aplicación, lea el `Apéndice A.2.2' de NIST-SP-800-132@footnote{https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf}. Las respuestas sobre stackexchange pbkdf2 iterations question@footnote{https://security.stackexchange.com/questions/3959/recommended-of-iterations-when-using-pbkdf2-sha256/}  lo explican en detalle.

`dklen' is the length of the derived key in bytes. If `dklen' is @code{None} then the
digest size of the hash algorithm `hash_name' is used, e.g. 64 for SHA-512.

@example
>>> from hashlib import pbkdf2_hmac
>>> our_app_iters = 500_000  # Application specific, read above.
>>> dk = pbkdf2_hmac('sha256', b'password', b'bad salt' * 2, our_app_iters)
>>> dk.hex()
'15530bba69924174860db778f2c6f8104d3aaf9d26241840c8c4a641c8d000a9'
@end example

Function only available when Python is compiled with OpenSSL.


Added in version 3.4.



Distinto en la versión 3.12: Function now only available when Python is built with OpenSSL. The slow
pure Python implementation has been removed.

@end deffn

@geindex scrypt() (en el módulo hashlib)
@anchor{library/hashlib hashlib scrypt}@anchor{cc6}
@deffn {Función} hashlib.scrypt (password, *, salt, n, r, p, maxmem=0, dklen=64)

La función provee una contraseña scrypt basada en una función derivación de clave como es definida en 
@geindex RFC; RFC 7914
RFC 7914@footnote{https://datatracker.ietf.org/doc/html/rfc7914.html}.

`password' y `salt' deben ser @ref{db4,,objetos de bytes}. Aplicaciones y bibliotecas deberían limitar `password' a un largo razonable (ej. 1024). `salt' debería ser aproximadamente 16 o más bytes de una fuente adecuada, ej. @code{os.unrandom()}.

`n' is the CPU/Memory cost factor, `r' the block size, `p' parallelization
factor and `maxmem' limits memory (OpenSSL 1.1.0 defaults to 32 MiB).
`dklen' is the length of the derived key in bytes.


Added in version 3.6.

@end deffn

@node BLAKE2,,Derivación de clave,hashlib — Secure hashes and message digests
@anchor{library/hashlib blake2}@anchor{2ad9}@anchor{library/hashlib hashlib-blake2}@anchor{1d95}
@subsubsection BLAKE2


@geindex blake2b@comma{} blake2s

BLAKE2@footnote{https://www.blake2.net} es una función de hash criptográfico definida en 
@geindex RFC; RFC 7693
RFC 7693@footnote{https://datatracker.ietf.org/doc/html/rfc7693.html} que viene en dos sabores:


@itemize *

@item 
`BLAKE2b', optimizada para plataformas de 64 bits y produce resúmenes de cualquier tamaño entre 1 y 64 bytes,

@item 
`BLAKE2s', optimizada para plataformas de 8 a 32 bits y produce resúmenes de cualquier tamaño entre 1 y 32 bytes.
@end itemize

BLAKE2 proporciona el `modo keyed' (un remplazamiento más simple rápido para HMAC@footnote{https://en.wikipedia.org/wiki/Hash-based_message_authentication_code}), `cifrado salado' (`salted hashing'), `personalización' y `cifrado de árbol'.

Los objetos hash de este módulo siguen los estándares de los objetos de la biblioteca @ref{68,,hashlib}.

@menu
* Creando objetos hash:: 
* Constantes: Constantes<5>. 
* Ejemplos: Ejemplos<12>. 
* Créditos:: 

@end menu

@node Creando objetos hash,Constantes<5>,,BLAKE2
@anchor{library/hashlib creating-hash-objects}@anchor{2ada}
@subsubsection Creando objetos hash


Se crean nuevos objetos hash invocando a las funciones de constructor:

@geindex blake2b() (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2b}@anchor{6e3}
@deffn {Función} hashlib.blake2b (data=b'@w{'}, *, digest_size=64, key=b'@w{'}, salt=b'@w{'}, person=b'@w{'}, fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)
@end deffn

@geindex blake2s() (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2s}@anchor{6e4}
@deffn {Función} hashlib.blake2s (data=b'@w{'}, *, digest_size=32, key=b'@w{'}, salt=b'@w{'}, person=b'@w{'}, fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)
@end deffn

Estas funciones retornan los objetos hash correspondientes para calcular BLAKE2b o BLAKE2s. Ellas toman opcionalmente estos parámetros generales:


@itemize *

@item 
`data': trozo inicial de datos a cifrar, el cual debe ser un @ref{db4,,bytes-like object}. Puede ser pasado sólo como argumento posicional.

@item 
`digest_size': tamaño del resumen de salida en bytes.

@item 
`key': clave para el cifrado de clave (`keyed hashing') (hasta 64 bytes para BLAKE2b, hasta 32 bytes para BLAKE2s).

@item 
`salt': sal para el cifrado aleatorio (hasta 16 bytes para BLAKE2b, hasta 8 bytes para BLAKE2s).

@item 
`person': cadena de personalización (hasta 16 bytes para BLAKE2b, hasta 8 bytes para BLAKE2s).
@end itemize

La siguiente tabla muestra los límites para parámetros generales (en bytes):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Cifrado

@tab

digest_size

@tab

len(key)

@tab

len(salt)

@tab

len(person)

@item

BLAKE2b

@tab

64

@tab

64

@tab

16

@tab

16

@item

BLAKE2s

@tab

32

@tab

32

@tab

8

@tab

8

@end multitable


@cartouche
@quotation Nota 
La especificación BLAKE2 define largos constantes para los parámetros de sal y personalización, sin embargo, por conveniencia, esta implementación acepta cadenas de bytes de cualquier tamaño hasta el largo especificado. Si el largo del parámetro es menor que el especificado, es acolchado con ceros, por lo tanto, por ejemplo, @code{b'salt'} y @code{b'salt\x00'} es el mismo valor. (Este no es el caso para `key'.)
@end quotation
@end cartouche

Estos tamaños están disponibles como @ref{2adb,,constantes} del módulo descritas abajo.

Las funciones constructoras también aceptan los siguientes parámetros de cifrado de árbol:


@itemize *

@item 
`fanout': despliegue en abanico (0 a 255, 0 si ilimitado, 1 en modo secuencial).

@item 
`depth': profundidad máxima del árbol (1 a 255, 255 si ilimitado, 1 en modo secuencial).

@item 
`leaf_size': tamaño máximo en bytes de hoja (0 a @code{2**32-1}, 0 si ilimitado o en modo secuencial).

@item 
`node_offset': desplazamiento del nodo (0 a @code{2**64-1} para BLAKE2b, 0 a @code{2**48-1} para BLAKE2s, 0 para la primera hoja más a la izquierda, o en modo secuencial).

@item 
`node_depth': profundidad de nodo (0 a 255, 0 para hojas o en modo secuencial).

@item 
`inner_size': tamaño interno del resumen (0 a 64 para BLAKE2b, 0 a 32 para BLAKE2s, 0 en modo secuencial).

@item 
`last_node': booleano indicando si el nodo procesado es el último (@code{False} para modo secuencial).
@end itemize


@float Figure

@image{python-figures/hashlib-blake2-tree,,,Explicación de los parámetros del modo árbol.,png}

@end float


See section 2.10 in BLAKE2 specification@footnote{https://www.blake2.net/blake2_20130129.pdf} for comprehensive review of tree
hashing.

@node Constantes<5>,Ejemplos<12>,Creando objetos hash,BLAKE2
@anchor{library/hashlib constants}@anchor{2adb}
@subsubsection Constantes


@geindex blake2b.SALT_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2b SALT_SIZE}@anchor{2adc}
@deffn {Dato} blake2b.SALT_SIZE
@end deffn

@geindex blake2s.SALT_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2s SALT_SIZE}@anchor{2add}
@deffn {Dato} blake2s.SALT_SIZE
@end deffn

Largo de sal (largo máximo aceptado por los constructores).

@geindex blake2b.PERSON_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2b PERSON_SIZE}@anchor{2ade}
@deffn {Dato} blake2b.PERSON_SIZE
@end deffn

@geindex blake2s.PERSON_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2s PERSON_SIZE}@anchor{2adf}
@deffn {Dato} blake2s.PERSON_SIZE
@end deffn

Largo de cadena de personalización (largo máximo aceptado por los constructores).

@geindex blake2b.MAX_KEY_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2b MAX_KEY_SIZE}@anchor{2ae0}
@deffn {Dato} blake2b.MAX_KEY_SIZE
@end deffn

@geindex blake2s.MAX_KEY_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2s MAX_KEY_SIZE}@anchor{2ae1}
@deffn {Dato} blake2s.MAX_KEY_SIZE
@end deffn

Tamaño máximo de clave.

@geindex blake2b.MAX_DIGEST_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2b MAX_DIGEST_SIZE}@anchor{2ae2}
@deffn {Dato} blake2b.MAX_DIGEST_SIZE
@end deffn

@geindex blake2s.MAX_DIGEST_SIZE (en el módulo hashlib)
@anchor{library/hashlib hashlib blake2s MAX_DIGEST_SIZE}@anchor{2ae3}
@deffn {Dato} blake2s.MAX_DIGEST_SIZE
@end deffn

Tamaño máximo de resumen que puede producir la función hash.

@node Ejemplos<12>,Créditos,Constantes<5>,BLAKE2
@anchor{library/hashlib examples}@anchor{2ae4}
@subsubsection Ejemplos


@menu
* Cifrado simple:: 
* Usar diferentes tamaños de resumen:: 
* Cifrado de clave:: 
* Cifrado aleatorio:: 
* Personalización: Personalización<2>. 
* Modo de árbol:: 

@end menu

@node Cifrado simple,Usar diferentes tamaños de resumen,,Ejemplos<12>
@anchor{library/hashlib simple-hashing}@anchor{2ae5}
@subsubsection Cifrado simple


To calculate hash of some data, you should first construct a hash object by
calling the appropriate constructor function (@ref{6e3,,blake2b()} or
@ref{6e4,,blake2s()}), then update it with the data by calling @ref{2ac5,,update()} on the
object, and, finally, get the digest out of the object by calling
@ref{2ac6,,digest()} (or @ref{2ac7,,hexdigest()} for hex-encoded string).

@example
>>> from hashlib import blake2b
>>> h = blake2b()
>>> h.update(b'Hello world')
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

Como atajo, puedes pasar el primer trozo de datos para actualizar directamente el constructor como el argumento posicional:

@example
>>> from hashlib import blake2b
>>> blake2b(b'Hello world').hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

Puedes invocar @ref{2ac5,,hash.update()} tantas veces como necesites para actualizar el hash iterativamente:

@example
>>> from hashlib import blake2b
>>> items = [b'Hello', b' ', b'world']
>>> h = blake2b()
>>> for item in items:
...     h.update(item)
...
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

@node Usar diferentes tamaños de resumen,Cifrado de clave,Cifrado simple,Ejemplos<12>
@anchor{library/hashlib using-different-digest-sizes}@anchor{2ae6}
@subsubsection Usar diferentes tamaños de resumen


BLAKE2 tiene tamaño de resúmenes configurables de hasta 64 bytes para BLAKE2b y 32 bytes para BLAKE2s. Por ejemplo, para remplazar SHA-1 con BLAKE2b sin cambiar el tamaño de la salida, puedes decirle a BLAKE2b que produzca resúmenes de 20 bytes:

@example
>>> from hashlib import blake2b
>>> h = blake2b(digest_size=20)
>>> h.update(b'Replacing SHA1 with the more secure function')
>>> h.hexdigest()
'd24f26cf8de66472d58d4e1b1774b4c9158b1f4c'
>>> h.digest_size
20
>>> len(h.digest())
20
@end example

Objetos hash con diferentes tamaños de resumen tienen salidas completamente diferentes (hashes más cortos `no' son prefijos de hashes más largos); BLAKE2b y BLAKE2s producen salidas diferentes incluso si el largo de salida es el mismo:

@example
>>> from hashlib import blake2b, blake2s
>>> blake2b(digest_size=10).hexdigest()
'6fa1d8fcfd719046d762'
>>> blake2b(digest_size=11).hexdigest()
'eb6ec15daf9546254f0809'
>>> blake2s(digest_size=10).hexdigest()
'1bf21a98c78a1c376ae9'
>>> blake2s(digest_size=11).hexdigest()
'567004bf96e4a25773ebf4'
@end example

@node Cifrado de clave,Cifrado aleatorio,Usar diferentes tamaños de resumen,Ejemplos<12>
@anchor{library/hashlib keyed-hashing}@anchor{2ae7}
@subsubsection Cifrado de clave


El cifrado de clave puede ser usado para autentificación como un remplazo más rápido y simple para Código de autentificación de mensajes en clave-hash@footnote{https://es.wikipedia.org/wiki/HMAC} (HMAC). BLAKE2 puede ser usado de forma segura en modo de prefijo MAC gracias a la propiedad de indiferenciabilidad heredada de BLAKE.

Este ejemplo muestra como obtener un código de autentificación (codificado como hexadecimal) de 128 bits para el mensaje @code{b'message data'} con la clave @code{b'pseudorandom key'}:

@example
>>> from hashlib import blake2b
>>> h = blake2b(key=b'pseudorandom key', digest_size=16)
>>> h.update(b'message data')
>>> h.hexdigest()
'3d363ff7401e02026f4a4687d4863ced'
@end example

Como ejemplo práctico, una aplicación web puede firmar simétricamente cookies enviadas a los usuarios y verificarlas más tarde para asegurar que no fueron manipuladas con:

@example
>>> from hashlib import blake2b
>>> from hmac import compare_digest
>>>
>>> SECRET_KEY = b'pseudorandomly generated server secret key'
>>> AUTH_SIZE = 16
>>>
>>> def sign(cookie):
...     h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY)
...     h.update(cookie)
...     return h.hexdigest().encode('utf-8')
>>>
>>> def verify(cookie, sig):
...     good_sig = sign(cookie)
...     return compare_digest(good_sig, sig)
>>>
>>> cookie = b'user-alice'
>>> sig = sign(cookie)
>>> print("@{0@},@{1@}".format(cookie.decode('utf-8'), sig))
user-alice,b'43b3c982cf697e0c5ab22172d1ca7421'
>>> verify(cookie, sig)
True
>>> verify(b'user-bob', sig)
False
>>> verify(cookie, b'0102030405060708090a0b0c0d0e0f00')
False
@end example

Incluso aunque hay un modo de cifrado de claves nativo, BLAKE2 puede, por supuesto, ser usado en construcción de HMAC con el módulo @ref{6a,,hmac}:

@example
>>> import hmac, hashlib
>>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
>>> m.update(b'message')
>>> m.hexdigest()
'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'
@end example

@node Cifrado aleatorio,Personalización<2>,Cifrado de clave,Ejemplos<12>
@anchor{library/hashlib randomized-hashing}@anchor{2ae8}
@subsubsection Cifrado aleatorio


Definiendo el parámetro `salt' los usuarios pueden introducir aleatoriedad a la función hash. El cifrado aleatorio es útil para proteger contra ataques de colisión en la función hash usada en firmas digitales.

@quotation

El cifrado aleatorio está diseñado para situaciones en las que una parte, el preparador del mensaje, genera todo o parte de un mensaje para ser firmado por una segunda parte, el firmante del mensaje. Si el preparador del mensaje es capaz de encontrar colisiones de funciones hash criptográficas (ej., dos mensajes produciendo el mismo valor de hash), entonces ellos pueden preparar versiones significativas del mensaje que producirían el mismo valor de hash y firma digital, pero con diferentes resultados (ej., transfiriendo 1,000,000 $ a una cuenta, en lugar de 10 $), Las funciones de hash criptográfico han sido diseñadas con resistencia de colisión como objetivo principal, pero la concentración actual en el ataque a las funciones hash criptográficas puede resultar en una función hash criptográfica dada que provea menor resistencia de colisión de la esperada. El cifrado aleatorio ofrece al firmante protección adicional reduciendo la probabilidad de que un preparador puede generar dos o más mensajes que en última instancia producen el mismo valor hash durante el proceso de generación de la firma digital, — incluso si es práctico encontrar colisiones para la función hash. Sin embargo, el uso de cifrado aleatorio puede reducir la cantidad de seguridad provista por una firma digital cuando todas las porciones del mensaje son preparadas por el firmante.

(NIST SP-800-106 "Randomized Hashing for Digital Signatures"@footnote{https://csrc.nist.gov/pubs/sp/800/106/final})
@end quotation

En BLAKE2 la sal es procesada como una entrada de una vez a la función hash durante la inicialización, en lugar de como una entrada para cada función de compresión.

@cartouche
@quotation Advertencia 
`Salted hashing' (or just hashing) with BLAKE2 or any other general-purpose
cryptographic hash function, such as SHA-256, is not suitable for hashing
passwords.  See BLAKE2 FAQ@footnote{https://www.blake2.net/#qa} for more
information.
@end quotation
@end cartouche


@example
>>> import os
>>> from hashlib import blake2b
>>> msg = b'some message'
>>> # Calculate the first hash with a random salt.
>>> salt1 = os.urandom(blake2b.SALT_SIZE)
>>> h1 = blake2b(salt=salt1)
>>> h1.update(msg)
>>> # Calculate the second hash with a different random salt.
>>> salt2 = os.urandom(blake2b.SALT_SIZE)
>>> h2 = blake2b(salt=salt2)
>>> h2.update(msg)
>>> # The digests are different.
>>> h1.digest() != h2.digest()
True
@end example

@node Personalización<2>,Modo de árbol,Cifrado aleatorio,Ejemplos<12>
@anchor{library/hashlib personalization}@anchor{2ae9}
@subsubsection Personalización


A veces es útil forzar a la función hash para producir diferentes resúmenes para la misma entrada para diferentes propósitos. Citando a los autores de la función hash Skein:

@quotation

Recomendamos que todos los diseñadores de aplicaciones consideren seriamente hacer esto; hemos visto muchos protocolos donde un hash que es calculado en una parte del protocolo puede ser usado en una parte completamente diferente porque dos cálculos hash fueron realizados en datos similares o relacionados, y el atacante puede forzar a la aplicación a hacer las entradas hash iguales. Personalizar cada función hash usada en el protocolo resumidamente detiene este tipo de ataque.

(The Skein Hash Function Family@footnote{https://www.schneier.com/wp-content/uploads/2016/02/skein.pdf},
p. 21)
@end quotation

BLAKE2 puede ser personalizado pasando bytes al argumento `person':

@example
>>> from hashlib import blake2b
>>> FILES_HASH_PERSON = b'MyApp Files Hash'
>>> BLOCK_HASH_PERSON = b'MyApp Block Hash'
>>> h = blake2b(digest_size=32, person=FILES_HASH_PERSON)
>>> h.update(b'the same content')
>>> h.hexdigest()
'20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4'
>>> h = blake2b(digest_size=32, person=BLOCK_HASH_PERSON)
>>> h.update(b'the same content')
>>> h.hexdigest()
'cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3'
@end example

Se puede usar también personalización en conjunto con el modo de clave para derivar diferentes claves desde una sola.

@example
>>> from hashlib import blake2s
>>> from base64 import b64decode, b64encode
>>> orig_key = b64decode(b'Rm5EPJai72qcK3RGBpW3vPNfZy5OZothY+kHY6h21KM=')
>>> enc_key = blake2s(key=orig_key, person=b'kEncrypt').digest()
>>> mac_key = blake2s(key=orig_key, person=b'kMAC').digest()
>>> print(b64encode(enc_key).decode('utf-8'))
rbPb15S/Z9t+agffno5wuhB77VbRi6F9Iv2qIxU7WHw=
>>> print(b64encode(mac_key).decode('utf-8'))
G9GtHFE1YluXY1zWPlYk1e/nWfu0WSEb0KRcjhDeP/o=
@end example

@node Modo de árbol,,Personalización<2>,Ejemplos<12>
@anchor{library/hashlib tree-mode}@anchor{2aea}
@subsubsection Modo de árbol


Aquí hay un ejemplo de cifrar un árbol mínimo con dos nodos de hoja:

@example
  10
 /  \
00  01
@end example

Este ejemplo usa resúmenes internos de 64 bytes, y retorna el resumen final de 32 bytes:

@example
>>> from hashlib import blake2b
>>>
>>> FANOUT = 2
>>> DEPTH = 2
>>> LEAF_SIZE = 4096
>>> INNER_SIZE = 64
>>>
>>> buf = bytearray(6000)
>>>
>>> # Left leaf
... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=0, node_depth=0, last_node=False)
>>> # Right leaf
... h01 = blake2b(buf[LEAF_SIZE:], fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=1, node_depth=0, last_node=True)
>>> # Root node
... h10 = blake2b(digest_size=32, fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=0, node_depth=1, last_node=True)
>>> h10.update(h00.digest())
>>> h10.update(h01.digest())
>>> h10.hexdigest()
'3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa'
@end example

@node Créditos,,Ejemplos<12>,BLAKE2
@anchor{library/hashlib credits}@anchor{2aeb}
@subsubsection Créditos


BLAKE2@footnote{https://www.blake2.net} fue diseñado por `Jean-Philippe Aumasson', `Samuel Neves', `Zooko Wilcox-O’Hearn' y `Christian Winnerlein' basado en el SHA-3@footnote{https://en.wikipedia.org/wiki/Secure_Hash_Algorithms} finalista BLAKE@footnote{https://web.archive.org/web/20200918190133/https://131002.net/blake/} creado por `Jean-Philippe Aumasson', `Luca Henzen', `Willi Meier' y `Raphael C.-W. Phan'.

Usa el algoritmo núcleo del cifrado ChaCha@footnote{https://cr.yp.to/chacha.html} diseñado por `Daniel J. Bernstein'.

La implementación stdlib está basada en el módulo pyblake2@footnote{https://pythonhosted.org/pyblake2/}. Fue escrita por `Dmitry Chestnykh' basada en la implementación C escrita por `Samuel Neves'. La documentación fue copiada desde pyblake2@footnote{https://pythonhosted.org/pyblake2/} y escrita por `Dmitry Chestnykh'.

El código C fue parcialmente reescrito para Python por `Christian Heimes'.

La siguiente dedicación de dominio público aplica tanto para la implementación de la función hash C, el código de extensión y su documentación:

@quotation

En la medida en que la ley lo permite, el/los autor/es han dedicado todos los derechos de autor y los derechos relacionados y vecinos de este software al dominio público mundial. Este software se distribuye sin ninguna garantía.

Deberías haber recibido una copia de la Dedicación CC0 de Dominio Público junto a este software. Si no, consulta @indicateurl{https://creativecommons.org/publicdomain/zero/1.0/}.
@end quotation

Las siguientes personas han ayudado con el desarrollo o contribuyeron con sus cambios al proyecto y el dominio público de acuerdo a Creative Commons Public Domain Dedication 1.0 Universal:


@itemize *

@item 
`Alexandr Sokolovskiy'
@end itemize
@anchor{library/hashlib hashlib-seealso}@anchor{2acd}

@subsubheading Ver también



@table @asis

@item Módulo @ref{6a,,hmac}

Un módulo para generar mensajes de códigos de autentificación usando hashes.

@item Módulo @ref{f,,base64}

Otra forma de codificar hashes binarios para entornos no binarios.

@item @indicateurl{https://nvlpubs.nist.gov/nistpubs/fips/nist.fips.180-4.pdf}

The FIPS 180-4 publication on Secure Hash Algorithms.

@item @indicateurl{https://csrc.nist.gov/pubs/fips/202/final}

The FIPS 202 publication on the SHA-3 Standard.

@item @indicateurl{https://www.blake2.net/}

Sitio web oficial de BLAKE2.

@item @indicateurl{https://en.wikipedia.org/wiki/Cryptographic_hash_function}

Artículo de Wikipedia con información sobre cuáles algoritmos tienen errores conocidos y lo que eso significa con respecto a su uso.

@item @indicateurl{https://www.ietf.org/rfc/rfc8018.txt}

PKCS #5: Password-Based Cryptography Specification Version 2.1

@item @indicateurl{https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf}

Recomendación de NIST para la derivación de claves basadas en contraseña.
@end table


@node hmac — Keyed-Hashing for Message Authentication,secrets — Generate secure random numbers for managing secrets,hashlib — Secure hashes and message digests,Servicios criptográficos
@anchor{library/hmac doc}@anchor{2aec}@anchor{library/hmac hmac-keyed-hashing-for-message-authentication}@anchor{2aed}@anchor{library/hmac module-hmac}@anchor{6a}
@subsection @code{hmac} — Keyed-Hashing for Message Authentication


@geindex module; hmac

`Código fuente:' Lib/hmac.py@footnote{https://github.com/python/cpython/tree/main/Lib/hmac.py}


__________________________________________________________________


Este módulo implementa el algoritmo HMAC como se describe en la 
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html}.

@geindex new() (en el módulo hmac)
@anchor{library/hmac hmac new}@anchor{b2a}
@deffn {Función} hmac.new (key, msg=None, digestmod)

Retorna un nuevo objeto hmac. `key' es un objeto `bytes' o `bytearray' que proporciona la clave secreta. Si `msg' está presente, se realiza la llamada al método @code{update(msg)}. `digestmod' es el nombre del resumen, constructor o módulo del resumen para el objeto HMAC que se va a usar. Puede ser cualquier nombre adecuado para @ref{1951,,hashlib.new()}. Se requiere este argumento a pesar de su posición.


Distinto en la versión 3.4: El parámetro `key' puede ser un objeto `bytes' o `bytearray'. El parámetro `msg' puede ser de cualquier tipo soportado por @ref{68,,hashlib}. El parámetro `digestmod' puede ser el nombre del algoritmo de `hash'.



Distinto en la versión 3.8: The `digestmod' argument is now required.  Pass it as a keyword
argument to avoid awkwardness when you do not have an initial `msg'.

@end deffn

@geindex digest() (en el módulo hmac)
@anchor{library/hmac hmac digest}@anchor{bc6}
@deffn {Función} hmac.digest (key, msg, digest)

Retorna el resumen de `msg' para una clave `key' secreta y un resumen `digest' dados. La función es equivalente a @code{HMAC(key, msg, digest).digest()}, pero utiliza una implementación optimizada en C o `inline', que es más rápida para mensajes que caben en memoria. Los parámetros `key', `msg' y `digest' tienen el mismo significado que en @ref{b2a,,new()}.

Un detalle de la implementación de CPython: la implementación optimizada en C solo se usa cuando `digest' es una cadena de caracteres y el nombre de un algoritmo de resumen, que está soportado por OpenSSL.


Added in version 3.7.

@end deffn

Un objeto HMAC tiene los siguientes métodos:

@geindex update() (método de hmac.HMAC)
@anchor{library/hmac hmac HMAC update}@anchor{fca}
@deffn {Método} HMAC.update (msg)

Actualiza el objeto hmac con `msg'. Las llamadas repetidas equivalen a una sola llamada con la concatenación de todos los argumentos: @code{m.update(a); m.update(b)} es equivalente a @code{m.update(a + b)}.


Distinto en la versión 3.4: El parámetro `msg' puede ser de cualquier tipo soportado por @ref{68,,hashlib}.

@end deffn

@geindex digest() (método de hmac.HMAC)
@anchor{library/hmac hmac HMAC digest}@anchor{2aee}
@deffn {Método} HMAC.digest ()

Retorna el resumen de los `bytes' que se pasaron al método @ref{fca,,update()} hasta el momento. Este objeto `bytes' será de la misma longitud que el `digest_size' del resumen que se pasa al constructor. Puede contener `bytes' no ASCII, incluyendo `bytes' NUL.

@cartouche
@quotation Advertencia 
When comparing the output of @ref{bc6,,digest()} to an externally supplied
digest during a verification routine, it is recommended to use the
@ref{113e,,compare_digest()} function instead of the @code{==} operator
to reduce the vulnerability to timing attacks.
@end quotation
@end cartouche
@end deffn

@geindex hexdigest() (método de hmac.HMAC)
@anchor{library/hmac hmac HMAC hexdigest}@anchor{2aef}
@deffn {Método} HMAC.hexdigest ()

Como @ref{bc6,,digest()} excepto que el resumen se retorna como una cadena de caracteres de dos veces la longitud conteniendo solo dígitos hexadecimales. Esto se puede utilizar para intercambiar el valor de forma segura en email u otros entornos no binarios.

@cartouche
@quotation Advertencia 
When comparing the output of @ref{2aef,,hexdigest()} to an externally supplied
digest during a verification routine, it is recommended to use the
@ref{113e,,compare_digest()} function instead of the @code{==} operator
to reduce the vulnerability to timing attacks.
@end quotation
@end cartouche
@end deffn

@geindex copy() (método de hmac.HMAC)
@anchor{library/hmac hmac HMAC copy}@anchor{2af0}
@deffn {Método} HMAC.copy ()

Retorna una copia («clon») del objeto hmac. Esto se puede utilizar para calcular de forma eficiente los resúmenes de las cadenas de caracteres que comparten una subcadena de caracteres inicial común.
@end deffn

Un objeto `hash' tiene los siguientes atributos:

@geindex digest_size (atributo de hmac.HMAC)
@anchor{library/hmac hmac HMAC digest_size}@anchor{fcd}
@deffn {Atributo} HMAC.digest_size

El tamaño del resumen HMAC resultante en `bytes'.
@end deffn

@geindex block_size (atributo de hmac.HMAC)
@anchor{library/hmac hmac HMAC block_size}@anchor{fcb}
@deffn {Atributo} HMAC.block_size

El tamaño de bloque interno del algoritmo de `hash' en `bytes'.


Added in version 3.4.

@end deffn

@geindex name (atributo de hmac.HMAC)
@anchor{library/hmac hmac HMAC name}@anchor{fcc}
@deffn {Atributo} HMAC.name

El nombre canónico de este HMAC, siempre en minúsculas, por ejemplo @code{hmac-md5}.


Added in version 3.4.

@end deffn


Distinto en la versión 3.10: Removed the undocumented attributes @code{HMAC.digest_cons}, @code{HMAC.inner},
and @code{HMAC.outer}.


Este módulo también provee las siguiente funciones auxiliares:

@geindex compare_digest() (en el módulo hmac)
@anchor{library/hmac hmac compare_digest}@anchor{113e}
@deffn {Función} hmac.compare_digest (a, b)

Retorna @code{a == b}. Esta función utiliza un enfoque diseñado para prevenir el análisis de temporización evitando el comportamiento de cortocircuito basado en contenido, haciéndolo adecuado para criptografía. `a' y `b' deben ser del mismo tipo: ya sea @ref{237,,str} (solo ASCII, como por ejemplo retornado por @ref{2aef,,HMAC.hexdigest()}), o un @ref{db4,,objeto tipo binario}.

@cartouche
@quotation Nota 
Si `a' y `b' son de diferente longitud, o si ocurre un error, un ataque de temporización teóricamente podría revelar información sobre los tipos y longitudes de `a' y `b'—pero no sus valores.
@end quotation
@end cartouche


Added in version 3.3.



Distinto en la versión 3.10: La función utiliza @code{CRYPTO_memcmp()} de OpenSSL internamente cuando está disponible.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{68,,hashlib}

El módulo de Python que provee funciones de `hash' seguras.
@end table


@node secrets — Generate secure random numbers for managing secrets,,hmac — Keyed-Hashing for Message Authentication,Servicios criptográficos
@anchor{library/secrets doc}@anchor{2af1}@anchor{library/secrets module-secrets}@anchor{c0}@anchor{library/secrets secrets-generate-secure-random-numbers-for-managing-secrets}@anchor{2af2}
@subsection @code{secrets} — Generate secure random numbers for managing secrets


@geindex module; secrets


Added in version 3.6.


@c from secrets import *
@c __name__ = '<doctest>'

`Código fuente:' Lib/secrets.py@footnote{https://github.com/python/cpython/tree/main/Lib/secrets.py}


__________________________________________________________________


El módulo @ref{c0,,secrets} se usa para generar números aleatorios criptográficamente fuertes, apropiados para trabajar con datos como contraseñas, autenticación de cuentas, tokens de seguridad y secretos relacionados.

En particular, @ref{c0,,secrets} se debe usar en lugar del generador de números pseudoaleatorios del módulo @ref{b8,,random}, que está diseñado para el modelado y la simulación, no para la seguridad o la criptografía.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 506
PEP 506@footnote{https://peps.python.org/pep-0506/}


@menu
* Números aleatorios:: 
* Generando tokens:: 
* Otras funciones:: 
* Recetas y mejores prácticas:: 

@end menu

@node Números aleatorios,Generando tokens,,secrets — Generate secure random numbers for managing secrets
@anchor{library/secrets random-numbers}@anchor{2af3}
@subsubsection Números aleatorios


El módulo @ref{c0,,secrets} provee acceso a la fuente más segura de aleatoriedad que proporciona su sistema operativo.

@geindex SystemRandom (clase en secrets)
@anchor{library/secrets secrets SystemRandom}@anchor{2af4}
@deffn {Clase} secrets.SystemRandom

Una clase para generar números aleatorios utilizando las fuentes de mayor calidad que proporciona el sistema operativo. Ver @ref{26d5,,random.SystemRandom} para más detalles.
@end deffn

@geindex choice() (en el módulo secrets)
@anchor{library/secrets secrets choice}@anchor{2af5}
@deffn {Función} secrets.choice (seq)

Return a randomly chosen element from a non-empty sequence.
@end deffn

@geindex randbelow() (en el módulo secrets)
@anchor{library/secrets secrets randbelow}@anchor{2af6}
@deffn {Función} secrets.randbelow (exclusive_upper_bound)

Return a random int in the range [0, `exclusive_upper_bound').
@end deffn

@geindex randbits() (en el módulo secrets)
@anchor{library/secrets secrets randbits}@anchor{2af7}
@deffn {Función} secrets.randbits (k)

Return a non-negative int with `k' random bits.
@end deffn

@node Generando tokens,Otras funciones,Números aleatorios,secrets — Generate secure random numbers for managing secrets
@anchor{library/secrets generating-tokens}@anchor{2af8}
@subsubsection Generando tokens


El módulo @ref{c0,,secrets} provee funciones para generar tokens seguros, adecuados para aplicaciones como el restablecimiento de contraseñas, URLs difíciles de adivinar, y similares.

@geindex token_bytes() (en el módulo secrets)
@anchor{library/secrets secrets token_bytes}@anchor{26da}
@deffn {Función} secrets.token_bytes ([nbytes=None])

Retorna una cadena de bytes aleatorios que contiene `nbytes' número de bytes. Si `nbytes' es @code{None} o no se suministra, se utiliza un valor por defecto razonable.

@example
>>> token_bytes(16)  
b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'
@end example
@end deffn

@geindex token_hex() (en el módulo secrets)
@anchor{library/secrets secrets token_hex}@anchor{17b3}
@deffn {Función} secrets.token_hex ([nbytes=None])

Retorna una cadena de caracteres aleatoria, en hexadecimal. La cadena de caracteres tiene `nbytes' bytes aleatorios, cada byte convertido a dos dígitos hexadecimales. Si `nbytes' es @code{None} o no se suministra, se utiliza un valor por defecto razonable.

@example
>>> token_hex(16)  
'f9bf78b9a18ce6d46a0cd2b0b86df9da'
@end example
@end deffn

@geindex token_urlsafe() (en el módulo secrets)
@anchor{library/secrets secrets token_urlsafe}@anchor{2af9}
@deffn {Función} secrets.token_urlsafe ([nbytes=None])

Retorna una cadena de caracteres aleatoria para usarse en URLs, que contiene `nbytes' bytes aleatorios. El texto está codificado en Base64, por lo que en promedio cada byte resulta en aproximadamente 1,3 caracteres. Si `nbytes' es @code{None} o no se suministra, se utiliza un valor por defecto razonable.

@example
>>> token_urlsafe(16)  
'Drmhze6EPcv0fN_81Bj-nA'
@end example
@end deffn

@menu
* ¿Cuántos bytes deben tener los tokens?:: 

@end menu

@node ¿Cuántos bytes deben tener los tokens?,,,Generando tokens
@anchor{library/secrets how-many-bytes-should-tokens-use}@anchor{2afa}
@subsubsection ¿Cuántos bytes deben tener los tokens?


Para estar seguros contra los ataques de fuerza bruta@footnote{https://es.wikipedia.org/wiki/Ataque_de_fuerza_bruta}, los tokens deben tener suficiente aleatoriedad. Desafortunadamente, lo que es considerado suficiente necesariamente aumentará a medida que las computadoras se vuelvan más potentes y capaces de hacer más pruebas en un período más corto. Desde 2015 se cree que 32 bytes (256 bits) de aleatoriedad son considerados suficientes para el típico caso de uso del módulo @ref{c0,,secrets}.

Para quienes quieran gestionar la longitud de sus propios tokens, pueden especificar explícitamente cuánta aleatoriedad se utiliza para los tokens  dando un argumento @ref{1f0,,int} a las funciones @code{token_*}. Ese argumento se toma como el número de bytes de aleatoriedad a utilizar.

En caso contrario, si no se proporciona ningún argumento, o si el argumento es @code{None}, las funciones @code{token_*} utilizarán en su lugar un valor por defecto razonable.

@cartouche
@quotation Nota 
El valor por defecto está sujeto a cambios en cualquier momento, incluso en los lanzamientos de mantenimiento.
@end quotation
@end cartouche

@node Otras funciones,Recetas y mejores prácticas,Generando tokens,secrets — Generate secure random numbers for managing secrets
@anchor{library/secrets other-functions}@anchor{2afb}
@subsubsection Otras funciones


@geindex compare_digest() (en el módulo secrets)
@anchor{library/secrets secrets compare_digest}@anchor{2afc}
@deffn {Función} secrets.compare_digest (a, b)

Return @code{True} if strings or
@ref{db4,,bytes-like objects}
`a' and `b' are equal, otherwise @code{False},
using a «constant-time compare» to reduce the risk of
timing attacks@footnote{https://codahale.com/a-lesson-in-timing-attacks/}.
See @ref{113e,,hmac.compare_digest()} for additional details.
@end deffn

@node Recetas y mejores prácticas,,Otras funciones,secrets — Generate secure random numbers for managing secrets
@anchor{library/secrets recipes-and-best-practices}@anchor{2afd}
@subsubsection Recetas y mejores prácticas


Esta sección muestra las recetas y las mejores prácticas para usar @ref{c0,,secrets} para conseguir un nivel mínimo de seguridad.

Generar una contraseña alfanumérica de ocho caracteres:

@example
import string
import secrets
alphabet = string.ascii_letters + string.digits
password = '@w{'}.join(secrets.choice(alphabet) for i in range(8))
@end example

@cartouche
@quotation Nota 
Applications should not
@geindex Common Weakness Enumeration; CWE 257
store passwords in a recoverable format@footnote{https://cwe.mitre.org/data/definitions/257.html},
whether plain text or encrypted.  They should be salted and hashed
using a cryptographically strong one-way (irreversible) hash function.
@end quotation
@end cartouche

Generar una contraseña alfanumérica de diez caracteres con al menos un carácter en minúscula, al menos un carácter en mayúscula y al menos tres dígitos:

@example
import string
import secrets
alphabet = string.ascii_letters + string.digits
while True:
    password = '@w{'}.join(secrets.choice(alphabet) for i in range(10))
    if (any(c.islower() for c in password)
            and any(c.isupper() for c in password)
            and sum(c.isdigit() for c in password) >= 3):
        break
@end example

Generar una contraseña al estilo XKCD@footnote{https://xkcd.com/936/}:

@example
import secrets
# On standard Linux systems, use a convenient dictionary file.
# Other platforms may need to provide their own word-list.
with open('/usr/share/dict/words') as f:
    words = [word.strip() for word in f]
    password = ' '.join(secrets.choice(words) for i in range(4))
@end example

Generar una URL temporal difícil de adivinar que contenga un token de seguridad adecuado para la recuperación de contraseñas:

@example
import secrets
url = 'https://example.com/reset=' + secrets.token_urlsafe()
@end example

@c # This modeline must appear within the last ten lines of the file.
@c kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8;

@node Servicios genéricos del sistema operativo,Ejecución concurrente,Servicios criptográficos,La biblioteca estándar de Python
@anchor{library/allos doc}@anchor{2afe}@anchor{library/allos allos}@anchor{2aff}@anchor{library/allos generic-operating-system-services}@anchor{2b00}
@section Servicios genéricos del sistema operativo


Los módulos descritos en este capítulo proporcionan interfaces a las características del sistema operativo que están disponibles en (casi) todos los sistemas operativos, como archivos y un reloj. Las interfaces se modelan, por norma general, según las interfaces Unix o C, pero también están disponibles en la mayoría de los otros sistemas.  Esta es una visión general:

@menu
* os — Miscellaneous operating system interfaces:: 
* io — Core tools for working with streams:: 
* time — Time access and conversions:: 
* argparse — Parser for command-line options@comma{} arguments and subcommands: argparse — Parser for command-line options arguments and subcommands. 
* logging — Logging facility for Python:: 
* logging.config — Logging configuration: logging config — Logging configuration. 
* logging.handlers — Logging handlers: logging handlers — Logging handlers. 
* getpass — Portable password input:: 
* curses — Terminal handling for character-cell displays:: 
* curses.textpad— Widget de entrada de texto para programas de curses: curses textpad— Widget de entrada de texto para programas de curses. 
* curses.ascii — Utilities for ASCII characters: curses ascii — Utilities for ASCII characters. 
* curses.panel — A panel stack extension for curses: curses panel — A panel stack extension for curses. 
* platform — Access to underlying platform’s identifying data:: 
* errno — Standard errno system symbols:: 
* ctypes — A foreign function library for Python:: 

@end menu

@node os — Miscellaneous operating system interfaces,io — Core tools for working with streams,,Servicios genéricos del sistema operativo
@anchor{library/os doc}@anchor{2b01}@anchor{library/os module-os}@anchor{a1}@anchor{library/os os-miscellaneous-operating-system-interfaces}@anchor{2b02}
@subsection @code{os} — Miscellaneous operating system interfaces


@geindex module; os

`Código fuente:' Lib/os.py@footnote{https://github.com/python/cpython/tree/main/Lib/os.py}


__________________________________________________________________


Este módulo provee una manera versátil de usar funcionalidades dependientes del sistema operativo. Si quieres leer o escribir un archivo mira @ref{1be,,open()}, si quieres manipular rutas, mira el módulo @ref{a2,,os.path}, y si quieres leer todas las líneas en todos los archivos en la línea de comandos mira el módulo @ref{5b,,fileinput}. Para crear archivos temporales y directorios mira el módulo @ref{e0,,tempfile}, y para el manejo de alto nivel de archivos y directorios puedes ver el módulo @ref{c5,,shutil}.

Notas sobre la disponibilidad de estas funciones:


@itemize *

@item 
El diseño de todos los módulos incorporados de Python dependientes del sistema operativo es tal que, mientras funcionalidad esté disponible, usará la misma interfaz; por ejemplo, la función @code{os.stat(path)} retorna estadísticas sobre la ruta (`path') en el mismo formato (lo que sucede originalmente con la interfaz POSIX).

@item 
Las extensiones propias de un sistema operativo en particular también están disponibles a través del módulo @ref{a1,,os}, pero usarlas, por supuesto, es un riesgo a la portabilidad.

@item 
Todas las funciones que aceptan rutas o nombres de archivos aceptan `bytes' o cadenas de texto, y el resultado es un objeto del mismo tipo, siempre que se retorna una ruta o un archivo.

@item 
En VxWorks, os.popen, os.fork, os.execv y os.spawn*p* no son compatibles.

@item 
On WebAssembly platforms, Android and iOS, large parts of the @ref{a1,,os} module are
not available or behave differently. APIs related to processes (e.g.
@ref{2ff,,fork()}, @ref{116b,,execve()}) and resources (e.g. @ref{1173,,nice()})
are not available. Others like @ref{2b03,,getuid()} and @ref{2b04,,getpid()} are
emulated or stubs. WebAssembly platforms also lack support for signals (e.g.
@ref{13c7,,kill()}, @ref{e1e,,wait()}).
@end itemize

@cartouche
@quotation Nota 
Todas las funciones en este módulo lanzan @ref{4d5,,OSError} (o subclases), en el caso de archivos o rutas inaccesibles o inválidas, u otros argumentos que tienen el tipo correcto, pero que no son aceptados por el sistema operativo.
@end quotation
@end cartouche

@geindex error
@anchor{library/os os error}@anchor{2b05}
@deffn {Excepción} os.error

Un alias de la excepción incorporada @ref{4d5,,OSError}.
@end deffn

@geindex name (en el módulo os)
@anchor{library/os os name}@anchor{2b06}
@deffn {Dato} os.name

El nombre del módulo dependiente del sistema operativo importado. Los siguientes nombres están registrados: @code{'posix'}, @code{'nt'}, @code{'java'}.


@subsubheading Ver también


@ref{b19,,sys.platform} has a finer granularity.  @ref{1188,,os.uname()} gives
system-dependent version information.

El módulo @ref{aa,,platform} proporciona verificaciones detalladas de la identidad del sistema.

@end deffn
@anchor{library/os os-filenames}@anchor{2a4e}
@menu
* Nombres de archivos@comma{} argumentos de la línea de comandos y variables de entorno: Nombres de archivos argumentos de la línea de comandos y variables de entorno. 
* Modo Python UTF-8:: 
* Parámetros de proceso:: 
* Creación de objetos de tipo archivo:: 
* Operaciones de descriptores de archivos:: 
* Archivos y directorios:: 
* Gestión de proceso:: 
* Interfaz al planificador:: 
* Información miscelánea del sistema:: 
* Números al azar:: 

@end menu

@node Nombres de archivos argumentos de la línea de comandos y variables de entorno,Modo Python UTF-8,,os — Miscellaneous operating system interfaces
@anchor{library/os file-names-command-line-arguments-and-environment-variables}@anchor{2b07}@anchor{library/os filesystem-encoding}@anchor{27af}
@subsubsection Nombres de archivos, argumentos de la línea de comandos y variables de entorno


En Python, los nombres de archivo, los argumentos de la línea de comandos y las variables de entorno se representan mediante el tipo de cadena de caracteres. En algunos sistemas, es necesario decodificar estas cadenas desde y hacia bytes antes de pasarlas al sistema operativo. Python usa la @ref{5dd,,codificación del sistema de archivos y manejador de errores} para realizar esta conversión (consulte @ref{ce1,,sys.getfilesystemencoding()}).

La @ref{5dd,,codificación del sistema de archivos y manejador de errores} se configuran al inicio de Python mediante la función @ref{829,,PyConfig_Read()}: consulte los miembros @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} de @ref{499,,PyConfig}.


Distinto en la versión 3.1: On some systems, conversion using the file system encoding may fail. In this
case, Python uses the @ref{23e6,,surrogateescape encoding error handler}, which means that undecodable bytes are replaced by a
Unicode character U+DC`xx' on decoding, and these are again
translated to the original byte on encoding.


La @ref{5dd,,codificación del sistema de archivos y manejador de errores} debe garantizar la decodificación exitosa de todos los bytes por debajo de 128. Si la codificación del sistema de archivos no proporciona esta garantía, las funciones de API pueden generar @ref{130f,,UnicodeError}.

Consulte también la @ref{39b,,codificación de la configuración regional}.

@node Modo Python UTF-8,Parámetros de proceso,Nombres de archivos argumentos de la línea de comandos y variables de entorno,os — Miscellaneous operating system interfaces
@anchor{library/os python-utf-8-mode}@anchor{2b08}@anchor{library/os utf8-mode}@anchor{6f7}
@subsubsection Modo Python UTF-8



Added in version 3.7: Consulte 
@geindex Python Enhancement Proposals; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} para obtener más detalles.


El modo Python UTF-8 ignora la @ref{39b,,codificación de la configuración regional} y fuerza el uso de la codificación UTF-8:


@itemize *

@item 
Utilice UTF-8 como @ref{5dd,,codificación del sistema de archivos y manejador de errores}.

@item 
@ref{ce1,,sys.getfilesystemencoding()} returns @code{'utf-8'}.

@item 
@ref{5dc,,locale.getpreferredencoding()} returns @code{'utf-8'} (the `do_setlocale'
argument has no effect).

@item 
@ref{5df,,sys.stdin}, @ref{b61,,sys.stdout} y @ref{9cc,,sys.stderr} usan UTF-8 como su codificación de texto, con @code{surrogateescape} @ref{17ed,,error handler} habilitado para @ref{5df,,sys.stdin} y @ref{b61,,sys.stdout} (@ref{9cc,,sys.stderr} continúa usando @code{backslashreplace} como lo hace en el modo predeterminado de reconocimiento de configuración regional)

@item 
En Unix, @ref{1899,,os.device_encoding()} retorna @code{'utf-8'}. en lugar de la codificación del dispositivo.
@end itemize

Tenga en cuenta que 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING} puede anular la configuración de transmisión estándar en el modo UTF-8 (al igual que en el modo predeterminado con reconocimiento de configuración regional).

Como consecuencia de los cambios en esas API de nivel inferior, otras API de nivel superior también exhiben diferentes comportamientos predeterminados:


@itemize *

@item 
Los argumentos de la línea de comandos, las variables de entorno y los nombres de archivo se decodifican en texto utilizando la codificación UTF-8.

@item 
@ref{cdc,,os.fsdecode()} and @ref{cdd,,os.fsencode()} use the UTF-8 encoding.

@item 
@ref{1be,,open()}, @ref{5c0,,io.open()}, and @ref{7db,,codecs.open()} use the UTF-8
encoding by default. However, they still use the strict error handler by
default so that attempting to open a binary file in text mode is likely
to raise an exception rather than producing nonsense data.
@end itemize

El @ref{6f7,,Modo Python UTF-8} se habilita si la configuración regional LC_CTYPE es @code{C} o @code{POSIX} al iniciar Python (consulte la función @ref{829,,PyConfig_Read()}).

Se puede habilitar o deshabilitar usando la opción de línea de comando @ref{2e2,,-X utf8} y la variable de entorno 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8}.

Si la variable de entorno 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} no está configurada en absoluto, entonces el intérprete utiliza de forma predeterminada la configuración regional actual, `a no ser que' la configuración regional actual se identifica como una configuración regional heredada basada en ASCII (como se describe para 
@geindex PYTHONCOERCECLOCALE
@geindex variables de entorno; PYTHONCOERCECLOCALE
@ref{b60,,PYTHONCOERCECLOCALE}) y la coerción de la configuración regional está deshabilitada o falla . En tales configuraciones regionales heredadas, el intérprete habilitará de forma predeterminada el modo UTF-8 a menos que se le indique explícitamente que no lo haga.

El modo Python UTF-8 solo se puede habilitar al inicio de Python. Su valor se puede leer en @ref{72d,,sys.flags.utf8_mode}.

Consulte también @ref{1e27,,modo UTF-8 en Windows} y @ref{5dd,,codificación del sistema de archivos y manejador de errores}.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 hará que @ref{6f7,,Modo Python UTF-8} sea el predeterminado.
@end table


@node Parámetros de proceso,Creación de objetos de tipo archivo,Modo Python UTF-8,os — Miscellaneous operating system interfaces
@anchor{library/os os-procinfo}@anchor{2b09}@anchor{library/os process-parameters}@anchor{2b0a}
@subsubsection Parámetros de proceso


Estas funciones y elementos de datos proporcionan información y operan en el proceso y con el usuario actuales.

@geindex ctermid() (en el módulo os)
@anchor{library/os os ctermid}@anchor{2b0b}
@deffn {Función} os.ctermid ()

Retorna el nombre del archivo correspondiente al terminal que controla el proceso.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex environ (en el módulo os)
@anchor{library/os os environ}@anchor{196}
@deffn {Dato} os.environ

Un objeto @ref{1229,,mapping} donde las claves y los valores son cadenas que representan el entorno del proceso. Por ejemplo, @code{environ['HOME']} es el nombre de ruta de su directorio de inicio (en algunas plataformas) y es equivalente a @code{getenv("HOME")} en C.

Esta asignación se captura la primera vez que se importa el módulo @ref{a1,,os}, normalmente durante el inicio de Python como parte del procesamiento de @code{site.py}. Los cambios en el entorno realizados después de este tiempo no se reflejan en @ref{196,,os.environ}, excepto los cambios realizados modificando @ref{196,,os.environ} directamente.

Este mapeo puede ser usado para modificar el entorno y también para consultarlo. @ref{198,,putenv()} será llamado automáticamente cuando el mapeo sea modificado.

En Unix, claves y valores usan la función @ref{ce1,,sys.getfilesystemencoding()} y  el controlador de errores @code{'surrogateescape'}. Hay que utilizar @ref{197,,environb} si se quiere usar una codificación diferente.

On Windows, the keys are converted to uppercase. This also applies when
getting, setting, or deleting an item. For example,
@code{environ['monty'] = 'python'} maps the key @code{'MONTY'} to the value
@code{'python'}.

@cartouche
@quotation Nota 
Llamar a @ref{198,,putenv()} directamente no cambia @ref{196,,os.environ}, por lo que es mejor modificar @ref{196,,os.environ}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
On some platforms, including FreeBSD and macOS, setting @code{environ} may
cause memory leaks.  Refer to the system documentation for
@code{putenv()}.
@end quotation
@end cartouche

Puede eliminar elementos en esta asignación para desactivar las variables de entorno. @ref{199,,unsetenv()} se llamará automáticamente cuando se elimine un elemento de @ref{196,,os.environ} y cuando se llame a uno de los métodos @code{pop()} o @code{clear()}.


@subsubheading Ver también


The @ref{195,,os.reload_environ()} function.



Distinto en la versión 3.9: Actualizado para soportar los operadores merge (@code{|}) y update (@code{|=}) de 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}’s.

@end deffn

@geindex environb (en el módulo os)
@anchor{library/os os environb}@anchor{197}
@deffn {Dato} os.environb

Versión de bytes de @ref{196,,environ}: un objeto @ref{1229,,mapping} donde tanto las claves como los valores son objetos @ref{325,,bytes} que representan el entorno del proceso. @ref{196,,environ} y @ref{197,,environb} están sincronizados (modificando @ref{197,,environb} actualiza @ref{196,,environ}, y viceversa).

@ref{197,,environb} is only available if @ref{1282,,supports_bytes_environ} is
@code{True}.


Added in version 3.2.



Distinto en la versión 3.9: Actualizado para soportar los operadores merge (@code{|}) y update (@code{|=}) de 
@geindex Python Enhancement Proposals; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}’s.

@end deffn

@geindex reload_environ() (en el módulo os)
@anchor{library/os os reload_environ}@anchor{195}
@deffn {Función} os.reload_environ ()

The @ref{196,,os.environ} and @ref{197,,os.environb} mappings are a cache of
environment variables at the time that Python started.
As such, changes to the current process environment are not reflected
if made outside Python, or by @ref{198,,os.putenv()} or @ref{199,,os.unsetenv()}.
Use @code{os.reload_environ()} to update @ref{196,,os.environ} and @ref{197,,os.environb}
with any such changes to the current process environment.

@cartouche
@quotation Advertencia 
This function is not thread-safe. Calling it while the environment is
being modified in an other thread is an undefined behavior. Reading from
@ref{196,,os.environ} or @ref{197,,os.environb}, or calling @ref{2b0c,,os.getenv()}
while reloading, may return an empty result.
@end quotation
@end cartouche


Added in version 3.14.0a1 (unreleased).

@end deffn


@deffn {Función} os.chdir (path)

@deffnx {Función} os.fchdir (fd)

@deffnx {Función} os.getcwd ()

Estas funciones están detalladas en @ref{2b0d,,Archivos y directorios}.
@end deffn

@geindex fsencode() (en el módulo os)
@anchor{library/os os fsencode}@anchor{cdd}
@deffn {Función} os.fsencode (filename)

Codifique @ref{3f0,,path-like} `filename' en @ref{5dd,,filesystem encoding and error handler}; retorna @ref{325,,bytes} sin cambios.

@ref{cdc,,fsdecode()} es la función inversa.


Added in version 3.2.



Distinto en la versión 3.6: Soporte agregado para aceptar objetos que implementan una interfaz @ref{cd9,,os.PathLike}.

@end deffn

@geindex fsdecode() (en el módulo os)
@anchor{library/os os fsdecode}@anchor{cdc}
@deffn {Función} os.fsdecode (filename)

Decodifica el @ref{3f0,,path-like} `filename' del @ref{5dd,,filesystem encoding and error handler}; retorna @ref{237,,str} sin cambios.

@ref{cdd,,fsencode()} es la función inversa.


Added in version 3.2.



Distinto en la versión 3.6: Soporte agregado para aceptar objetos que implementan una interfaz @ref{cd9,,os.PathLike}.

@end deffn

@geindex fspath() (en el módulo os)
@anchor{library/os os fspath}@anchor{cdb}
@deffn {Función} os.fspath (path)

Retorna la representación en el sistema de archivos de la ruta.

Si se le pasa @ref{237,,str} o @ref{325,,bytes}, retorna sin alterar. De lo contrario se llama a @ref{cda,,__fspath__()} y se retorna su valor siempre que sea un objeto @ref{237,,str} o @ref{325,,bytes}. En los demás casos se lanza una excepción del tipo @ref{228,,TypeError}.


Added in version 3.6.

@end deffn

@geindex PathLike (clase en os)
@anchor{library/os os PathLike}@anchor{cd9}
@deffn {Clase} os.PathLike

Una @ref{1224,,clase base abstracta} para objetos que representan una ruta del sistema de archivos, i.e. @ref{54e,,pathlib.PurePath}.


Added in version 3.6.


@geindex __fspath__() (método de os.PathLike)
@anchor{library/os os PathLike __fspath__}@anchor{cda}
@deffn {Método} abstractmethod __fspath__ ()

Retorna la representación de la ruta del sistema de archivos del objeto.

Este método sólo retornará objetos @ref{237,,str} or @ref{325,,bytes}, preferentemente @ref{237,,str}.
@end deffn
@end deffn

@geindex getenv() (en el módulo os)
@anchor{library/os os getenv}@anchor{2b0c}
@deffn {Función} os.getenv (key, default=None)

Devuelve el valor de la variable de entorno `key' como una cadena si existe, o `default' si no existe. `key' es una cadena. Tenga en cuenta que dado que @ref{2b0c,,getenv()} usa @ref{196,,os.environ}, la asignación de @ref{2b0c,,getenv()} también se captura de manera similar en la importación, y es posible que la función no refleje futuros cambios en el entorno.

En Unix, claves y valores se decodifican con la función @ref{ce1,,sys.getfilesystemencoding()} y con el controlador de errores @code{'surrogateescape'}. Usar @ref{1283,,os.getenvb()} si se quiere usar una codificación diferente.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex getenvb() (en el módulo os)
@anchor{library/os os getenvb}@anchor{1283}
@deffn {Función} os.getenvb (key, default=None)

Devuelve el valor de la variable de entorno `key' como bytes si existe, o `default' si no existe. `key' debe ser bytes. Tenga en cuenta que dado que @ref{1283,,getenvb()} usa @ref{197,,os.environb}, la asignación de @ref{1283,,getenvb()} también se captura de manera similar en la importación, y es posible que la función no refleje futuros cambios en el entorno.

@ref{1283,,getenvb()} is only available if @ref{1282,,supports_bytes_environ}
is @code{True}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.2.

@end deffn

@geindex get_exec_path() (en el módulo os)
@anchor{library/os os get_exec_path}@anchor{2b0e}
@deffn {Función} os.get_exec_path (env=None)

Retorna una lista de directorios en la que se buscará un ejecutable, similar a una `shell', cuando se ejecuta un proceso. `env', cuando se especifica, tienen que ser un diccionario de variables de entorno donde buscar el `PATH'. Por defecto cuando `env' es @code{None}, se usa @ref{196,,environ}.


Added in version 3.2.

@end deffn

@geindex getegid() (en el módulo os)
@anchor{library/os os getegid}@anchor{2b0f}
@deffn {Función} os.getegid ()

Retorna el `id' del grupo (`gid') efectivo correspondiente al proceso que se está ejecutando. Esto corresponde al bit de `«set id»' en el archivo que se está ejecutando en el proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex geteuid() (en el módulo os)
@anchor{library/os os geteuid}@anchor{17f0}
@deffn {Función} os.geteuid ()

@geindex user;effective id

Retorna el id el usuario correspondiente al proceso que se está ejecutando actualmente.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex getgid() (en el módulo os)
@anchor{library/os os getgid}@anchor{2b10}
@deffn {Función} os.getgid ()

@geindex process;group

Retorna el id del grupo real correspondiente al proceso que se está ejecutando actualmente.

@ref{1d5a,,Availability}: Unix.

The function is a stub on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end deffn

@geindex getgrouplist() (en el módulo os)
@anchor{library/os os getgrouplist}@anchor{1186}
@deffn {Función} os.getgrouplist (user, group, /)

Devuelve la lista de ID de grupo a los que pertenece `user'. Si `group' no está en la lista, se incluye; normalmente, `group' se especifica como el campo de ID de grupo del registro de contraseña para `user', porque de lo contrario, esa ID de grupo podría omitirse.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex getgroups() (en el módulo os)
@anchor{library/os os getgroups}@anchor{2b11}
@deffn {Función} os.getgroups ()

Retorna la lista de `ids' de grupos secundarios asociados con el proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.

@cartouche
@quotation Nota 
On macOS, @ref{2b11,,getgroups()} behavior differs somewhat from
other Unix platforms. If the Python interpreter was built with a
deployment target of @code{10.5} or earlier, @ref{2b11,,getgroups()} returns
the list of effective group ids associated with the current user process;
this list is limited to a system-defined number of entries, typically 16,
and may be modified by calls to @ref{2b12,,setgroups()} if suitably privileged.
If built with a deployment target greater than @code{10.5},
@ref{2b11,,getgroups()} returns the current group access list for the user
associated with the effective user id of the process; the group access
list may change over the lifetime of the process, it is not affected by
calls to @ref{2b12,,setgroups()}, and its length is not limited to 16.  The
deployment target value, @code{MACOSX_DEPLOYMENT_TARGET}, can be
obtained with @ref{10a7,,sysconfig.get_config_var()}.
@end quotation
@end cartouche
@end deffn

@geindex getlogin() (en el módulo os)
@anchor{library/os os getlogin}@anchor{2b13}
@deffn {Función} os.getlogin ()

Retorna el nombre del usuario que inició sesión en el terminal que controla el proceso. Para la mayoría de los casos, es más útil usar @ref{4d6,,getpass.getuser()} ya que este último verifica las variables de entorno 
@geindex LOGNAME
@geindex variables de entorno; LOGNAME
@code{LOGNAME} o 
@geindex USERNAME
@geindex variables de entorno; USERNAME
@code{USERNAME} para averiguar quién es el usuario y recurre a @code{pwd.getpwuid(os.getuid())[0]} para obtener el nombre de inicio de sesión del ID de usuario real actual.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.
@end deffn

@geindex getpgid() (en el módulo os)
@anchor{library/os os getpgid}@anchor{2b14}
@deffn {Función} os.getpgid (pid)

Retorna el id del grupo de procesos del proceso con la identificación del proceso `pid'. Si `pid' es 0, se retorna la identificación del grupo de proceso del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex getpgrp() (en el módulo os)
@anchor{library/os os getpgrp}@anchor{2b15}
@deffn {Función} os.getpgrp ()

@geindex process;group

Retorna el `id' del grupo de proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex getpid() (en el módulo os)
@anchor{library/os os getpid}@anchor{2b04}
@deffn {Función} os.getpid ()

@geindex process;id

Retorna el `id' del proceso actual.

The function is a stub on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end deffn

@geindex getppid() (en el módulo os)
@anchor{library/os os getppid}@anchor{165d}
@deffn {Función} os.getppid ()

@geindex process;id of parent

Retorna el `id' del proceso del padre. Cuando el proceso padre ha terminado, en Unix la identificación que retorna es la del proceso `init' (1), en Windows sigue siendo la misma identificación, que ya puede ser reutilizada por otro proceso.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.


Distinto en la versión 3.2: Se agregó soporte para Windows.

@end deffn

@geindex getpriority() (en el módulo os)
@anchor{library/os os getpriority}@anchor{1171}
@deffn {Función} os.getpriority (which, who)

@geindex process;scheduling priority

Obtenga la prioridad del programa. El valor `which' es uno de @ref{2b16,,PRIO_PROCESS}, @ref{2b17,,PRIO_PGRP}, o @ref{2b18,,PRIO_USER}, y `who' se interpreta en relación a `which' (un identificador de proceso para @ref{2b16,,PRIO_PROCESS}, un identificador de grupo de proceso para @ref{2b17,,PRIO_PGRP}, y un ID de usuario para @ref{2b18,,PRIO_USER}). Un valor cero para `who' denota (respectivamente) el proceso llamado, el grupo de proceso del proceso llamado o el ID de usuario real del proceso llamado.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex PRIO_PROCESS (en el módulo os)
@geindex PRIO_PGRP (en el módulo os)
@geindex PRIO_USER (en el módulo os)
@anchor{library/os os PRIO_PROCESS}@anchor{2b16}
@deffn {Dato} os.PRIO_PROCESS
@anchor{library/os os PRIO_PGRP}@anchor{2b17}
@deffnx {Dato} os.PRIO_PGRP
@anchor{library/os os PRIO_USER}@anchor{2b18}
@deffnx {Dato} os.PRIO_USER

Parámetros para las funciones @ref{1171,,getpriority()} y @ref{1172,,setpriority()}.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex PRIO_DARWIN_THREAD (en el módulo os)
@geindex PRIO_DARWIN_PROCESS (en el módulo os)
@geindex PRIO_DARWIN_BG (en el módulo os)
@geindex PRIO_DARWIN_NONUI (en el módulo os)
@anchor{library/os os PRIO_DARWIN_THREAD}@anchor{2b19}
@deffn {Dato} os.PRIO_DARWIN_THREAD
@anchor{library/os os PRIO_DARWIN_PROCESS}@anchor{2b1a}
@deffnx {Dato} os.PRIO_DARWIN_PROCESS
@anchor{library/os os PRIO_DARWIN_BG}@anchor{2b1b}
@deffnx {Dato} os.PRIO_DARWIN_BG
@anchor{library/os os PRIO_DARWIN_NONUI}@anchor{2b1c}
@deffnx {Dato} os.PRIO_DARWIN_NONUI

Parámetros para las funciones @ref{1171,,getpriority()} y @ref{1172,,setpriority()}.

@ref{1d5a,,Availability}: macOS


Added in version 3.12.

@end deffn

@geindex getresuid() (en el módulo os)
@anchor{library/os os getresuid}@anchor{137e}
@deffn {Función} os.getresuid ()

Retorna una tupla (ruid, euid, suid) que denota los ID de usuario reales, efectivos y guardados del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.2.

@end deffn

@geindex getresgid() (en el módulo os)
@anchor{library/os os getresgid}@anchor{137d}
@deffn {Función} os.getresgid ()

Retorna una tupla (rgid, egid, sgid) que denota los ID de grupo reales, efectivos y guardados del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.2.

@end deffn

@geindex getuid() (en el módulo os)
@anchor{library/os os getuid}@anchor{2b03}
@deffn {Función} os.getuid ()

@geindex user;id

Retorna el `id' del usuario real del proceso actual.

@ref{1d5a,,Availability}: Unix.

The function is a stub on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end deffn

@geindex initgroups() (en el módulo os)
@anchor{library/os os initgroups}@anchor{1381}
@deffn {Función} os.initgroups (username, gid, /)

Llamada al sistema initgroups() para inicializar la lista de acceso de grupo con todos los grupos de los que es miembro el nombre de usuario especificado, más el ID del grupo especificado.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex putenv() (en el módulo os)
@anchor{library/os os putenv}@anchor{198}
@deffn {Función} os.putenv (key, value, /)

@geindex environment variables;setting

Establece la variable de entorno llamada `key' con el valor de la cadena `value'. Dichos cambios en el entorno impactan a los subprocesos iniciados con @ref{149a,,os.system()}, @ref{1c5,,popen()} o @ref{2ff,,fork()} y @ref{2b1d,,execv()}.

Las asignaciones a elementos en @ref{196,,os.environ} se traducen automáticamente en llamadas correspondientes a @ref{198,,putenv()}; sin embargo, las llamadas a @ref{198,,putenv()} no actualizan @ref{196,,os.environ}, por lo que en realidad es preferible asignar elementos de @ref{196,,os.environ}. Esto también se aplica a @ref{2b0c,,getenv()} y @ref{1283,,getenvb()}, que utilizan respectivamente @ref{196,,os.environ} y @ref{197,,os.environb} en sus implementaciones.

See also the @ref{195,,os.reload_environ()} function.

@cartouche
@quotation Nota 
On some platforms, including FreeBSD and macOS, setting @code{environ} may
cause memory leaks. Refer to the system documentation for @code{putenv()}.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{os.putenv} con argumentos @code{key}, @code{value}.


Distinto en la versión 3.9: Esta función actualmente siempre esta disponible.

@end deffn

@geindex setegid() (en el módulo os)
@anchor{library/os os setegid}@anchor{2b1e}
@deffn {Función} os.setegid (egid, /)

Establece el `id' de grupo efectivo del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@geindex seteuid() (en el módulo os)
@anchor{library/os os seteuid}@anchor{2b1f}
@deffn {Función} os.seteuid (euid, /)

Establece el `id' de usuario efectivo del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@geindex setgid() (en el módulo os)
@anchor{library/os os setgid}@anchor{2b20}
@deffn {Función} os.setgid (gid, /)

Establece el `id' de grupo del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@geindex setgroups() (en el módulo os)
@anchor{library/os os setgroups}@anchor{2b12}
@deffn {Función} os.setgroups (groups, /)

Establece la lista de `ids' de grupos secundarios asociados con el proceso actual en `groups'. `groups' debe ser una secuencia y cada elemento debe ser un número entero que identifique un grupo. Esta operación generalmente está disponible sólo para el superusuario.

@ref{1d5a,,Availability}: Unix, not WASI.

@cartouche
@quotation Nota 
En macOS, la longitud de `groups' no puede exceder el número máximo definido por el sistema de ID de grupo efectivos, por lo general 16. Consulte la documentación de @ref{2b11,,getgroups()} para ver los casos en los que puede no retornar la misma lista de grupos establecida llamando a setgroups().
@end quotation
@end cartouche
@end deffn

@geindex setns() (en el módulo os)
@anchor{library/os os setns}@anchor{17c8}
@deffn {Función} os.setns (fd, nstype=0)

Reassociate the current thread with a Linux namespace.
See the @code{setns(2)@footnote{https://manpages.debian.org/setns(2)}} and @code{namespaces(7)@footnote{https://manpages.debian.org/namespaces(7)}} man pages for more
details.

If `fd' refers to a @code{/proc/`pid'/ns/} link, @code{setns()} reassociates the
calling thread with the namespace associated with that link,
and `nstype' may be set to one of the
@ref{2b21,,CLONE_NEW* constants}
to impose constraints on the operation
(@code{0} means no constraints).

Since Linux 5.8, `fd' may refer to a PID file descriptor obtained from
@ref{524,,pidfd_open()}. In this case, @code{setns()} reassociates the calling thread
into one or more of the same namespaces as the thread referred to by `fd'.
This is subject to any constraints imposed by `nstype',
which is a bit mask combining one or more of the
@ref{2b21,,CLONE_NEW* constants},
e.g. @code{setns(fd, os.CLONE_NEWUTS | os.CLONE_NEWPID)}.
The caller’s memberships in unspecified namespaces are left unchanged.

`fd' can be any object with a @ref{2848,,fileno()} method, or a raw file descriptor.

This example reassociates the thread with the @code{init} process’s network namespace:

@example
fd = os.open("/proc/1/ns/net", os.O_RDONLY)
os.setns(fd, os.CLONE_NEWNET)
os.close(fd)
@end example

@ref{1d5a,,Availability}: Linux >= 3.0 with glibc >= 2.14.


Added in version 3.12.



@subsubheading Ver también


The @ref{17c9,,unshare()} function.

@end deffn

@geindex setpgrp() (en el módulo os)
@anchor{library/os os setpgrp}@anchor{2b22}
@deffn {Función} os.setpgrp ()

Call the system call @code{setpgrp()} or @code{setpgrp(0, 0)} depending on
which version is implemented (if any).  See the Unix manual for the semantics.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex setpgid() (en el módulo os)
@anchor{library/os os setpgid}@anchor{2b23}
@deffn {Función} os.setpgid (pid, pgrp, /)

Call the system call @code{setpgid()} to set the process group id of the
process with id `pid' to the process group with id `pgrp'.  See the Unix manual
for the semantics.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex setpriority() (en el módulo os)
@anchor{library/os os setpriority}@anchor{1172}
@deffn {Función} os.setpriority (which, who, priority)

@geindex process;scheduling priority

Establecer la prioridad del programa. El valor `which' es uno de @ref{2b16,,PRIO_PROCESS}, @ref{2b17,,PRIO_PGRP}, o @ref{2b18,,PRIO_USER}, y `who' se interpreta en relación con `which' (un identificador de proceso para @ref{2b16,,PRIO_PROCESS}, un identificador de grupo de proceso para @ref{2b17,,PRIO_PGRP}, y un ID de usuario para @ref{2b18,,PRIO_USER}). Un valor cero para `who' denota (respectivamente) el proceso llamado, el grupo de procesos del proceso llamado o el ID del usuario real del proceso llamado. `priority' es un valor en el rango de -20 a 19. La prioridad predeterminada es 0; las prioridades más bajas causan una programación más favorable.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex setregid() (en el módulo os)
@anchor{library/os os setregid}@anchor{2b24}
@deffn {Función} os.setregid (rgid, egid, /)

Establece los `ids' de grupos reales y efectivos del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@geindex setresgid() (en el módulo os)
@anchor{library/os os setresgid}@anchor{137f}
@deffn {Función} os.setresgid (rgid, egid, sgid, /)

Establece los `ids' de grupo reales, efectivos y guardados del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex setresuid() (en el módulo os)
@anchor{library/os os setresuid}@anchor{1380}
@deffn {Función} os.setresuid (ruid, euid, suid, /)

Establece los `ids' de usuario reales, efectivos y guardados del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex setreuid() (en el módulo os)
@anchor{library/os os setreuid}@anchor{2b25}
@deffn {Función} os.setreuid (ruid, euid, /)

Establece los `ids' de usuario reales y efectivos del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@geindex getsid() (en el módulo os)
@anchor{library/os os getsid}@anchor{2b26}
@deffn {Función} os.getsid (pid, /)

Call the system call @code{getsid()}.  See the Unix manual for the semantics.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex setsid() (en el módulo os)
@anchor{library/os os setsid}@anchor{19de}
@deffn {Función} os.setsid ()

Call the system call @code{setsid()}.  See the Unix manual for the semantics.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex setuid() (en el módulo os)
@anchor{library/os os setuid}@anchor{2b27}
@deffn {Función} os.setuid (uid, /)

@geindex user;id@comma{} setting

Establece `id' del usuario del proceso actual.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.
@end deffn

@c placed in this section since it relates to errno.... a little weak

@geindex strerror() (en el módulo os)
@anchor{library/os os strerror}@anchor{2b28}
@deffn {Función} os.strerror (code, /)

Return the error message corresponding to the error code in `code'.
On platforms where @code{strerror()} returns @code{NULL} when given an unknown
error number, @ref{360,,ValueError} is raised.
@end deffn

@geindex supports_bytes_environ (en el módulo os)
@anchor{library/os os supports_bytes_environ}@anchor{1282}
@deffn {Dato} os.supports_bytes_environ

@code{True} si el tipo de entorno nativo del sistema operativo es bytes (por ejemplo, @code{False} en Windows).


Added in version 3.2.

@end deffn

@geindex umask() (en el módulo os)
@anchor{library/os os umask}@anchor{2b29}
@deffn {Función} os.umask (mask, /)

Establece la `umask' numérica actual y retorna la `umask' anterior.

The function is a stub on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end deffn

@geindex uname() (en el módulo os)
@anchor{library/os os uname}@anchor{1188}
@deffn {Función} os.uname ()

@geindex gethostname() (in module socket)
@geindex gethostbyaddr() (in module socket)

Retorna información que identifica el sistema operativo actual. El valor retornado es un objeto con cinco atributos:


@itemize *

@item 
@code{sysname} - nombre del sistema operativo

@item 
@code{nodename} - nombre de la máquina en la red (definida por la implementación)

@item 
@code{release} - `release' del sistema operativo

@item 
@code{version} - versión del sistema operativo

@item 
@code{machine} - identificador de hardware
@end itemize

Por compatibilidad con versiones anteriores, este objeto también es iterable, se comporta como una tupla que contiene @code{sysname}, @code{nodename}, @code{release}, @code{version}, y @code{machine} en ese orden.

Algunos sistemas se truncan @code{nodename} a 8 caracteres o al componente principal; una mejor manera de obtener el nombre de host es usar @ref{2b2a,,socket.gethostname()} o incluso @code{socket.gethostbyaddr(socket.gethostname())}.

On macOS, iOS and Android, this returns the `kernel' name and version (i.e.,
@code{'Darwin'} on macOS and iOS; @code{'Linux'} on Android). @ref{1a39,,platform.uname()}
can be used to get the user-facing operating system name and version on iOS and
Android.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.3: El tipo de objeto retornado cambió de una tupla a un objeto tipo tupla con atributos con nombre.

@end deffn

@geindex unsetenv() (en el módulo os)
@anchor{library/os os unsetenv}@anchor{199}
@deffn {Función} os.unsetenv (key, /)

@geindex environment variables;deleting

Desestablece (elimine) la variable de entorno llamada `key'. Dichos cambios en el entorno afectan a los subprocesos iniciados con @ref{149a,,os.system()}, @ref{1c5,,popen()} o @ref{2ff,,fork()} y @ref{2b1d,,execv()}.

La eliminación de elementos en @ref{196,,os.environ} se traduce automáticamente en una llamada correspondiente a @ref{199,,unsetenv()}; sin embargo, las llamadas a @ref{199,,unsetenv()} no actualizan @ref{196,,os.environ}, por lo que en realidad es preferible eliminar elementos de @ref{196,,os.environ}.

See also the @ref{195,,os.reload_environ()} function.

Lanza un @ref{18c3,,evento de auditoría} @code{os.unsetenv} con argumento @code{key}.


Distinto en la versión 3.9: Estas funciones se encuentra ahora siempre disponible y también esta disponible en Windows

@end deffn

@geindex unshare() (en el módulo os)
@anchor{library/os os unshare}@anchor{17c9}
@deffn {Función} os.unshare (flags)

Disassociate parts of the process execution context, and move them into a
newly created namespace.
See the @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}}
man page for more details.
The `flags' argument is a bit mask, combining zero or more of the
@ref{2b21,,CLONE_* constants},
that specifies which parts of the execution context should be
unshared from their existing associations and moved to a new namespace.
If the `flags' argument is @code{0}, no changes are made to the calling process’s
execution context.

@ref{1d5a,,Availability}: Linux >= 2.6.16.


Added in version 3.12.



@subsubheading Ver también


The @ref{17c8,,setns()} function.

@end deffn
@anchor{library/os os-unshare-clone-flags}@anchor{2b21}
Flags to the @ref{17c9,,unshare()} function, if the implementation supports them.
See @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}} in the Linux manual
for their exact effect and availability.

@geindex CLONE_FILES (en el módulo os)
@geindex CLONE_FS (en el módulo os)
@geindex CLONE_NEWCGROUP (en el módulo os)
@geindex CLONE_NEWIPC (en el módulo os)
@geindex CLONE_NEWNET (en el módulo os)
@geindex CLONE_NEWNS (en el módulo os)
@geindex CLONE_NEWPID (en el módulo os)
@geindex CLONE_NEWTIME (en el módulo os)
@geindex CLONE_NEWUSER (en el módulo os)
@geindex CLONE_NEWUTS (en el módulo os)
@geindex CLONE_SIGHAND (en el módulo os)
@geindex CLONE_SYSVSEM (en el módulo os)
@geindex CLONE_THREAD (en el módulo os)
@geindex CLONE_VM (en el módulo os)
@anchor{library/os os CLONE_FILES}@anchor{2b2b}
@deffn {Dato} os.CLONE_FILES
@anchor{library/os os CLONE_FS}@anchor{2b2c}
@deffnx {Dato} os.CLONE_FS
@anchor{library/os os CLONE_NEWCGROUP}@anchor{2b2d}
@deffnx {Dato} os.CLONE_NEWCGROUP
@anchor{library/os os CLONE_NEWIPC}@anchor{2b2e}
@deffnx {Dato} os.CLONE_NEWIPC
@anchor{library/os os CLONE_NEWNET}@anchor{2b2f}
@deffnx {Dato} os.CLONE_NEWNET
@anchor{library/os os CLONE_NEWNS}@anchor{2b30}
@deffnx {Dato} os.CLONE_NEWNS
@anchor{library/os os CLONE_NEWPID}@anchor{2b31}
@deffnx {Dato} os.CLONE_NEWPID
@anchor{library/os os CLONE_NEWTIME}@anchor{2b32}
@deffnx {Dato} os.CLONE_NEWTIME
@anchor{library/os os CLONE_NEWUSER}@anchor{2b33}
@deffnx {Dato} os.CLONE_NEWUSER
@anchor{library/os os CLONE_NEWUTS}@anchor{2b34}
@deffnx {Dato} os.CLONE_NEWUTS
@anchor{library/os os CLONE_SIGHAND}@anchor{2b35}
@deffnx {Dato} os.CLONE_SIGHAND
@anchor{library/os os CLONE_SYSVSEM}@anchor{2b36}
@deffnx {Dato} os.CLONE_SYSVSEM
@anchor{library/os os CLONE_THREAD}@anchor{2b37}
@deffnx {Dato} os.CLONE_THREAD
@anchor{library/os os CLONE_VM}@anchor{2b38}
@deffnx {Dato} os.CLONE_VM
@end deffn

@node Creación de objetos de tipo archivo,Operaciones de descriptores de archivos,Parámetros de proceso,os — Miscellaneous operating system interfaces
@anchor{library/os file-object-creation}@anchor{2b39}@anchor{library/os os-newstreams}@anchor{2b3a}
@subsubsection Creación de objetos de tipo archivo


Estas funciones crean nuevos @ref{1230,,objetos de archivo}. (Consulte también @ref{e18,,open()} para abrir los descriptores de archivos).

@geindex fdopen() (en el módulo os)
@anchor{library/os os fdopen}@anchor{1f33}
@deffn {Función} os.fdopen (fd, *args, **kwargs)

Retorna un objeto de archivo abierto conectado al descriptor de archivo `fd'. Este es un alias de la función incorporada @ref{1be,,open()} y acepta los mismos argumentos. La única diferencia es que el primer argumento de @ref{1f33,,fdopen()} siempre debe ser un número entero.
@end deffn

@node Operaciones de descriptores de archivos,Archivos y directorios,Creación de objetos de tipo archivo,os — Miscellaneous operating system interfaces
@anchor{library/os file-descriptor-operations}@anchor{2b3b}@anchor{library/os os-fd-ops}@anchor{2b3c}
@subsubsection Operaciones de descriptores de archivos


Estas funciones operan en flujos de E/S a los que se hace referencia mediante descriptores de archivo.

Los descriptores de archivo son enteros pequeños que corresponden a un archivo que ha sido abierto por el proceso actual. Por ejemplo, la entrada estándar suele ser el descriptor de archivo 0, la salida estándar es el 1 y el error estándar es el 2. A los archivos abiertos por un proceso se les asignará 3, 4, 5, y así sucesivamente. El nombre «descriptor de archivo» es ligeramente engañoso; en las plataformas Unix, los descriptores de archivo también hacen referencia a `sockets' y tuberías.

El método @ref{2848,,fileno()} se puede utilizar para obtener el descriptor de archivo asociado con un @ref{1230,,file object} cuando sea necesario. Tenga en cuenta que el uso del descriptor de archivo directamente omitirá los métodos de objeto de archivo, ignorando aspectos como el almacenamiento interno interno de datos.

@geindex close() (en el módulo os)
@anchor{library/os os close}@anchor{bfc}
@deffn {Función} os.close (fd)

Cierra el descriptor de archivo `fd'.

@cartouche
@quotation Nota 
Esta función está diseñada para E/S de bajo nivel y debe aplicarse a un descriptor de archivo tal como lo retorna @ref{e18,,os.open()} o @ref{17e1,,pipe()}. Para cerrar un «objeto de archivo» retornado por la función incorporada @ref{1be,,open()} o por @ref{1c5,,popen()} o @ref{1f33,,fdopen()}, use el método @ref{354,,close()}.
@end quotation
@end cartouche
@end deffn

@geindex closerange() (en el módulo os)
@anchor{library/os os closerange}@anchor{2b3d}
@deffn {Función} os.closerange (fd_low, fd_high, /)

Cierra todos los descriptores de archivo desde `fd_low' (inclusive) hasta `fd_high' (exclusivo), ignorando los errores. Equivalente a (pero mucho más rápido que):

@example
for fd in range(fd_low, fd_high):
    try:
        os.close(fd)
    except OSError:
        pass
@end example
@end deffn

@geindex copy_file_range() (en el módulo os)
@anchor{library/os os copy_file_range}@anchor{2b3e}
@deffn {Función} os.copy_file_range (src, dst, count, offset_src=None, offset_dst=None)

Copy `count' bytes from file descriptor `src', starting from offset
`offset_src', to file descriptor `dst', starting from offset `offset_dst'.
If `offset_src' is @code{None}, then `src' is read from the current position;
respectively for `offset_dst'.

In Linux kernel older than 5.3, the files pointed to by `src' and `dst'
must reside in the same filesystem, otherwise an @ref{4d5,,OSError} is
raised with @ref{2290,,errno} set to @ref{2b3f,,errno.EXDEV}.

This copy is done without the additional cost of transferring data
from the kernel to user space and then back into the kernel. Additionally,
some filesystems could implement extra optimizations, such as the use of
reflinks (i.e., two or more inodes that share pointers to the same
copy-on-write disk blocks; supported file systems include btrfs and XFS)
and server-side copy (in the case of NFS).

The function copies bytes between two file descriptors. Text options, like
the encoding and the line ending, are ignored.

El valor de retorno es la cantidad de bytes copiados. Esto podría ser menor que la cantidad solicitada.

@cartouche
@quotation Nota 
On Linux, @ref{2b3e,,os.copy_file_range()} should not be used for copying a
range of a pseudo file from a special filesystem like procfs and sysfs.
It will always copy no bytes and return 0 as if the file was empty
because of a known Linux kernel issue.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Linux >= 4.5 with glibc >= 2.27.


Added in version 3.8.

@end deffn

@geindex device_encoding() (en el módulo os)
@anchor{library/os os device_encoding}@anchor{1899}
@deffn {Función} os.device_encoding (fd)

Retorna una cadena que describe la codificación del dispositivo asociado con `fd' si está conectado a una terminal; sino retorna @ref{716,,None}.

En Unix, si el @ref{6f7,,Modo Python UTF-8} está habilitado, retorna @code{'UTF-8'} en lugar de la codificación del dispositivo.


Distinto en la versión 3.10: En Unix, la función ahora implementa el modo Python UTF-8.

@end deffn

@geindex dup() (en el módulo os)
@anchor{library/os os dup}@anchor{19e6}
@deffn {Función} os.dup (fd, /)

Retorna un duplicado del descriptor de archivo `fd'. El nuevo descriptor de archivo es @ref{f7c,,no heredable}.

En Windows, al duplicar un flujo estándar (0: stdin, 1: stdout, 2: stderr), el nuevo descriptor de archivo es @ref{f7c,,heredable}.

@ref{1d5a,,Availability}: not WASI.


Distinto en la versión 3.4: El nuevo descriptor de archivo ahora es no heredable.

@end deffn

@geindex dup2() (en el módulo os)
@anchor{library/os os dup2}@anchor{beb}
@deffn {Función} os.dup2 (fd, fd2, inheritable=True)

Duplicar el descriptor de archivo `fd' a `fd2', cerrando el anterior si es necesario. Retorna `fd2'. El nuevo descriptor de archivo es @ref{f7c,,heredable} por defecto o no heredable si `inheritable' es @code{False}.

@ref{1d5a,,Availability}: not WASI.


Distinto en la versión 3.4: Agrega el parámetro opcional `inheritable'.



Distinto en la versión 3.7: Retorna `fd2' en caso de éxito. Anteriormente se retornaba siempre @code{None}.

@end deffn

@geindex fchmod() (en el módulo os)
@anchor{library/os os fchmod}@anchor{379}
@deffn {Función} os.fchmod (fd, mode)

Cambia el modo del archivo dado por `fd' al modo numérico `mode'. Consulte los documentos para @ref{378,,chmod()} para conocer los posibles valores de `mode'. A partir de Python 3.3, esto es equivalente a @code{os.chmod(fd, mode)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chmod} con argumentos @code{path}, @code{mode}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix, Windows.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.


Distinto en la versión 3.13: Added support on Windows.

@end deffn

@geindex fchown() (en el módulo os)
@anchor{library/os os fchown}@anchor{e10}
@deffn {Función} os.fchown (fd, uid, gid)

Cambia el propietario y el `id' del grupo del archivo proporcionado por `fd' a los numéricos dados por `uid' y `gid'. Para dejar uno de los identificadores sin cambios, configúrelo en -1. Ver @ref{1161,,chown()}. A partir de Python 3.3, esto es equivalente a @code{os.chown(fd, uid, gid)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chown} con argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end deffn

@geindex fdatasync() (en el módulo os)
@anchor{library/os os fdatasync}@anchor{e11}
@deffn {Función} os.fdatasync (fd)

Fuerza la escritura del archivo con el descriptor de archivo `fd' en el disco. No fuerza la actualización de metadatos.

@ref{1d5a,,Availability}: Unix.

@cartouche
@quotation Nota 
Esta función no está disponible en MacOS.
@end quotation
@end cartouche
@end deffn

@geindex fpathconf() (en el módulo os)
@anchor{library/os os fpathconf}@anchor{2b40}
@deffn {Función} os.fpathconf (fd, name, /)

Retorna la información de configuración del sistema relevante para un archivo abierto. `name' especifica el valor de configuración para recuperar; puede ser una cadena que es el nombre de un valor de sistema definido; estos nombres se especifican en varios estándares (POSIX.1, Unix 95, Unix 98 y otros). Algunas plataformas también definen nombres adicionales. Los nombres conocidos por el sistema operativo anfitrión se dan en el diccionario @code{pathconf_names}. Para las variables de configuración no incluidas en esa asignación, también se acepta pasar un número entero para `name'.

Si `name' es una cadena y no se conoce, se lanza un @ref{360,,ValueError}. Si el sistema anfitrión no admite un valor específico para `name', incluso si está incluido en @code{pathconf_names}, se genera un @ref{4d5,,OSError} con @ref{19f8,,errno.EINVAL} para el número de error.

A partir de Python 3.3, esto es equivalente a @code{os.pathconf(fd, name)}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex fstat() (en el módulo os)
@anchor{library/os os fstat}@anchor{e12}
@deffn {Función} os.fstat (fd)

Obtiene el estado del descriptor de archivo `fd'. Retorna un objeto @ref{14fd,,stat_result}.

A partir de Python 3.3, esto es equivalente a @code{os.stat(fd)}.


@subsubheading Ver también


La función @ref{548,,stat()}.

@end deffn

@geindex fstatvfs() (en el módulo os)
@anchor{library/os os fstatvfs}@anchor{e13}
@deffn {Función} os.fstatvfs (fd, /)

Retorna información sobre el sistema de archivos que contiene el archivo asociado con el descriptor de archivo `fd', como @ref{116e,,statvfs()}. A partir de Python 3.3, esto es equivalente a @code{os.statvfs(fd)}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex fsync() (en el módulo os)
@anchor{library/os os fsync}@anchor{e14}
@deffn {Función} os.fsync (fd)

Force write of file with filedescriptor `fd' to disk.  On Unix, this calls the
native @code{fsync()} function; on Windows, the MS @code{_commit()} function.

Si está comenzando con un Python almacenado en búfer @ref{1230,,file object} `f', primero haga @code{f.flush()}, y luego haga @code{os.fsync(f.fileno())}, para garantizar que todas las memorias intermedias internas asociadas con `f' se escriban en disco.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex ftruncate() (en el módulo os)
@anchor{library/os os ftruncate}@anchor{e15}
@deffn {Función} os.ftruncate (fd, length, /)

Trunca el archivo correspondiente al descriptor de archivo `fd', para que tenga como máximo `length' bytes de tamaño. A partir de Python 3.3, esto es equivalente a @code{os.truncate(fd, length)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.truncate} con argumentos @code{fd}, @code{length}.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.5: Se agregó soporte para Windows

@end deffn

@geindex get_blocking() (en el módulo os)
@anchor{library/os os get_blocking}@anchor{ebe}
@deffn {Función} os.get_blocking (fd, /)

Obtiene el modo de bloqueo del descriptor de archivo: @code{False} si se establece el indicador @ref{ec0,,O_NONBLOCK}, @code{True} si el indicador se borra.

Consulte también @ref{ebf,,set_blocking()} y @ref{2b41,,socket.socket.setblocking()}.

@ref{1d5a,,Availability}: Unix, Windows.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.

On Windows, this function is limited to pipes.


Added in version 3.5.



Distinto en la versión 3.12: Added support for pipes on Windows.

@end deffn

@geindex grantpt() (en el módulo os)
@anchor{library/os os grantpt}@anchor{168d}
@deffn {Función} os.grantpt (fd, /)

Grant access to the slave pseudo-terminal device associated with the
master pseudo-terminal device to which the file descriptor `fd' refers.
The file descriptor `fd' is not closed upon failure.

Calls the C standard library function @code{grantpt()}.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex isatty() (en el módulo os)
@anchor{library/os os isatty}@anchor{1898}
@deffn {Función} os.isatty (fd, /)

Retorna @code{True} si el descriptor de archivo `fd' está abierto y conectado a un dispositivo tipo tty, de lo contrario, @code{False}.
@end deffn

@geindex lockf() (en el módulo os)
@anchor{library/os os lockf}@anchor{1185}
@deffn {Función} os.lockf (fd, cmd, len, /)

Aplique, pruebe o elimine un bloqueo POSIX en un descriptor de archivo abierto. `fd' es un descriptor de archivo abierto. `cmd' especifica el comando a usar - uno de @ref{2b42,,F_LOCK}, @ref{2b43,,F_TLOCK}, @ref{2b44,,F_ULOCK} o @ref{2b45,,F_TEST}. `len' especifica la sección del archivo a bloquear.

Lanza un @ref{18c3,,evento de auditoría} @code{os.lockf} con argumentos @code{fd}, @code{cmd}, @code{len}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex F_LOCK (en el módulo os)
@geindex F_TLOCK (en el módulo os)
@geindex F_ULOCK (en el módulo os)
@geindex F_TEST (en el módulo os)
@anchor{library/os os F_LOCK}@anchor{2b42}
@deffn {Dato} os.F_LOCK
@anchor{library/os os F_TLOCK}@anchor{2b43}
@deffnx {Dato} os.F_TLOCK
@anchor{library/os os F_ULOCK}@anchor{2b44}
@deffnx {Dato} os.F_ULOCK
@anchor{library/os os F_TEST}@anchor{2b45}
@deffnx {Dato} os.F_TEST

Indicadores que especifican qué acción tomará @ref{1185,,lockf()}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex login_tty() (en el módulo os)
@anchor{library/os os login_tty}@anchor{1761}
@deffn {Función} os.login_tty (fd, /)

Prepare el tty del cual fd es un descriptor de archivo para una nueva sesión de inicio de sesión. Convierta el proceso de convocatoria en un líder de sesión; hacer que el tty sea el tty controlador, el stdin, el stdout y el stderr del proceso de llamada; cerrar fd.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.11.

@end deffn

@geindex lseek() (en el módulo os)
@anchor{library/os os lseek}@anchor{1189}
@deffn {Función} os.lseek (fd, pos, whence, /)

Set the current position of file descriptor `fd' to position `pos', modified
by `whence', and return the new position in bytes relative to
the start of the file.
Valid values for `whence' are:


@itemize *

@item 
@ref{12fa,,SEEK_SET} or @code{0} – set `pos' relative to the beginning of the file

@item 
@ref{12fb,,SEEK_CUR} or @code{1} – set `pos' relative to the current file position

@item 
@ref{12fc,,SEEK_END} or @code{2} – set `pos' relative to the end of the file

@item 
@ref{2b46,,SEEK_HOLE} – set `pos' to the next data location, relative to `pos'

@item 
@ref{2b47,,SEEK_DATA} – set `pos' to the next data hole, relative to `pos'
@end itemize


Distinto en la versión 3.3: Add support for @code{SEEK_HOLE} and @code{SEEK_DATA}.

@end deffn

@geindex SEEK_SET (en el módulo os)
@geindex SEEK_CUR (en el módulo os)
@geindex SEEK_END (en el módulo os)
@anchor{library/os os SEEK_SET}@anchor{12fa}
@deffn {Dato} os.SEEK_SET
@anchor{library/os os SEEK_CUR}@anchor{12fb}
@deffnx {Dato} os.SEEK_CUR
@anchor{library/os os SEEK_END}@anchor{12fc}
@deffnx {Dato} os.SEEK_END

Parameters to the @ref{1189,,lseek()} function and the @ref{12f9,,seek()}
method on @ref{1230,,file-like objects},
for whence to adjust the file position indicator.


@table @asis

@item @ref{12fa,,SEEK_SET}

Adjust the file position relative to the beginning of the file.

@item @ref{12fb,,SEEK_CUR}

Adjust the file position relative to the current file position.

@item @ref{12fc,,SEEK_END}

Adjust the file position relative to the end of the file.
@end table

Their values are 0, 1, and 2, respectively.
@end deffn

@geindex SEEK_HOLE (en el módulo os)
@geindex SEEK_DATA (en el módulo os)
@anchor{library/os os SEEK_HOLE}@anchor{2b46}
@deffn {Dato} os.SEEK_HOLE
@anchor{library/os os SEEK_DATA}@anchor{2b47}
@deffnx {Dato} os.SEEK_DATA

Parameters to the @ref{1189,,lseek()} function and the @ref{12f9,,seek()}
method on @ref{1230,,file-like objects},
for seeking file data and holes on sparsely allocated files.


@table @asis

@item @code{SEEK_DATA}

Adjust the file offset to the next location containing data,
relative to the seek position.

@item @code{SEEK_HOLE}

Adjust the file offset to the next location containing a hole,
relative to the seek position.
A hole is defined as a sequence of zeros.
@end table

@cartouche
@quotation Nota 
These operations only make sense for filesystems that support them.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Linux >= 3.1, macOS, Unix


Added in version 3.3.

@end deffn

@geindex open() (en el módulo os)
@anchor{library/os os open}@anchor{e18}
@deffn {Función} os.open (path, flags, mode=0o777, *, dir_fd=None)

Abre el archivo `path' y configura varios indicadores según `flags' y su modo según `mode'. Al calcular el modo el valor actual de `umask' se enmascara primero. Retorna el descriptor de archivo para el archivo recién abierto. El nuevo descriptor de archivo es @ref{f7c,,no heredable}.

Para una descripción de los valores de indicadores (`flags') y modo (`mode'), consulte la documentación de tiempo de ejecución de C; los indicadores constantes de flag (como @ref{2b48,,O_RDONLY} y @ref{2b49,,O_WRONLY}) se definen en el módulo @ref{a1,,os}. En particular, en Windows agregar @ref{2b4a,,O_BINARY} es necesario para abrir archivos en modo binario.

Esta función puede admitir @ref{115d,,rutas relativas a descriptores de directorio} con el parámetro `dir_fd'.

Lanza un @ref{18c3,,evento de auditoría} @code{open} con argumentos @code{path}, @code{mode}, @code{flags}.


Distinto en la versión 3.4: El nuevo descriptor de archivo ahora es no heredable.


@cartouche
@quotation Nota 
Esta función está diseñada para E/S de bajo nivel. Para un uso normal, use la función integrada @ref{1be,,open()}, que retorna un @ref{1230,,file object} con métodos @code{read()} y @code{write()} (y mucho mas). Para envolver un descriptor de archivo en un objeto de archivo, use @ref{1f33,,fdopen()}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.5: Si la llamada al sistema se interrumpe y el controlador de señal no genera una excepción, la función vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

Las siguientes constantes son opciones para el parámetro `flags' de la función @ref{e18,,open()}. Se pueden combinar con el operador OR a nivel de bit @code{|}. Algunos de ellas no están disponibles en todas las plataformas. Para obtener descripciones de su disponibilidad y uso, consulte la página de manual @code{open(2)@footnote{https://manpages.debian.org/open(2)}} en Unix o la MSDN@footnote{https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx} en Windows.

@geindex O_RDONLY (en el módulo os)
@geindex O_WRONLY (en el módulo os)
@geindex O_RDWR (en el módulo os)
@geindex O_APPEND (en el módulo os)
@geindex O_CREAT (en el módulo os)
@geindex O_EXCL (en el módulo os)
@geindex O_TRUNC (en el módulo os)
@anchor{library/os os O_RDONLY}@anchor{2b48}
@deffn {Dato} os.O_RDONLY
@anchor{library/os os O_WRONLY}@anchor{2b49}
@deffnx {Dato} os.O_WRONLY
@anchor{library/os os O_RDWR}@anchor{2b4b}
@deffnx {Dato} os.O_RDWR
@anchor{library/os os O_APPEND}@anchor{2b4c}
@deffnx {Dato} os.O_APPEND
@anchor{library/os os O_CREAT}@anchor{2b4d}
@deffnx {Dato} os.O_CREAT
@anchor{library/os os O_EXCL}@anchor{284c}
@deffnx {Dato} os.O_EXCL
@anchor{library/os os O_TRUNC}@anchor{2b4e}
@deffnx {Dato} os.O_TRUNC

Las constantes anteriores están disponibles en Unix y Windows.
@end deffn

@geindex O_DSYNC (en el módulo os)
@geindex O_RSYNC (en el módulo os)
@geindex O_SYNC (en el módulo os)
@geindex O_NDELAY (en el módulo os)
@geindex O_NONBLOCK (en el módulo os)
@geindex O_NOCTTY (en el módulo os)
@geindex O_CLOEXEC (en el módulo os)
@anchor{library/os os O_DSYNC}@anchor{2b4f}
@deffn {Dato} os.O_DSYNC
@anchor{library/os os O_RSYNC}@anchor{2b50}
@deffnx {Dato} os.O_RSYNC
@anchor{library/os os O_SYNC}@anchor{2b51}
@deffnx {Dato} os.O_SYNC
@anchor{library/os os O_NDELAY}@anchor{2b52}
@deffnx {Dato} os.O_NDELAY
@anchor{library/os os O_NONBLOCK}@anchor{ec0}
@deffnx {Dato} os.O_NONBLOCK
@anchor{library/os os O_NOCTTY}@anchor{2b53}
@deffnx {Dato} os.O_NOCTTY
@anchor{library/os os O_CLOEXEC}@anchor{10f8}
@deffnx {Dato} os.O_CLOEXEC

Las constantes anteriores sólo están disponibles en Unix.


Distinto en la versión 3.3: Se agregó la constante @ref{10f8,,O_CLOEXEC}.

@end deffn

@geindex O_BINARY (en el módulo os)
@geindex O_NOINHERIT (en el módulo os)
@geindex O_SHORT_LIVED (en el módulo os)
@geindex O_TEMPORARY (en el módulo os)
@geindex O_RANDOM (en el módulo os)
@geindex O_SEQUENTIAL (en el módulo os)
@geindex O_TEXT (en el módulo os)
@anchor{library/os os O_BINARY}@anchor{2b4a}
@deffn {Dato} os.O_BINARY
@anchor{library/os os O_NOINHERIT}@anchor{2b54}
@deffnx {Dato} os.O_NOINHERIT
@anchor{library/os os O_SHORT_LIVED}@anchor{2b55}
@deffnx {Dato} os.O_SHORT_LIVED
@anchor{library/os os O_TEMPORARY}@anchor{2b56}
@deffnx {Dato} os.O_TEMPORARY
@anchor{library/os os O_RANDOM}@anchor{2b57}
@deffnx {Dato} os.O_RANDOM
@anchor{library/os os O_SEQUENTIAL}@anchor{2b58}
@deffnx {Dato} os.O_SEQUENTIAL
@anchor{library/os os O_TEXT}@anchor{2b59}
@deffnx {Dato} os.O_TEXT

Las constantes anteriores sólo están disponibles en Windows.
@end deffn

@geindex O_EVTONLY (en el módulo os)
@geindex O_FSYNC (en el módulo os)
@geindex O_SYMLINK (en el módulo os)
@geindex O_NOFOLLOW_ANY (en el módulo os)
@anchor{library/os os O_EVTONLY}@anchor{8b1}
@deffn {Dato} os.O_EVTONLY
@anchor{library/os os O_FSYNC}@anchor{8b2}
@deffnx {Dato} os.O_FSYNC
@anchor{library/os os O_SYMLINK}@anchor{8b3}
@deffnx {Dato} os.O_SYMLINK
@anchor{library/os os O_NOFOLLOW_ANY}@anchor{8b4}
@deffnx {Dato} os.O_NOFOLLOW_ANY

Las constantes anteriores solo están disponibles en macOS.


Distinto en la versión 3.10: Agregue las constantes @ref{8b1,,O_EVTONLY}, @ref{8b2,,O_FSYNC}, @ref{8b3,,O_SYMLINK} y @ref{8b4,,O_NOFOLLOW_ANY}.

@end deffn

@geindex O_ASYNC (en el módulo os)
@geindex O_DIRECT (en el módulo os)
@geindex O_DIRECTORY (en el módulo os)
@geindex O_NOFOLLOW (en el módulo os)
@geindex O_NOATIME (en el módulo os)
@geindex O_PATH (en el módulo os)
@geindex O_TMPFILE (en el módulo os)
@geindex O_SHLOCK (en el módulo os)
@geindex O_EXLOCK (en el módulo os)
@anchor{library/os os O_ASYNC}@anchor{2b5a}
@deffn {Dato} os.O_ASYNC
@anchor{library/os os O_DIRECT}@anchor{2b5b}
@deffnx {Dato} os.O_DIRECT
@anchor{library/os os O_DIRECTORY}@anchor{2b5c}
@deffnx {Dato} os.O_DIRECTORY
@anchor{library/os os O_NOFOLLOW}@anchor{2b5d}
@deffnx {Dato} os.O_NOFOLLOW
@anchor{library/os os O_NOATIME}@anchor{2b5e}
@deffnx {Dato} os.O_NOATIME
@anchor{library/os os O_PATH}@anchor{ff1}
@deffnx {Dato} os.O_PATH
@anchor{library/os os O_TMPFILE}@anchor{ff2}
@deffnx {Dato} os.O_TMPFILE
@anchor{library/os os O_SHLOCK}@anchor{146e}
@deffnx {Dato} os.O_SHLOCK
@anchor{library/os os O_EXLOCK}@anchor{146f}
@deffnx {Dato} os.O_EXLOCK

Las constantes anteriores son extensiones y no están presentes si no están definidas por la biblioteca de C.


Distinto en la versión 3.4: Se agrega la constante @ref{ff1,,O_PATH} en los sistemas que lo admiten. Se agrega @ref{ff2,,O_TMPFILE}, sólo disponible en Linux para el Kernel 3.11 o posterior.

@end deffn

@geindex openpty() (en el módulo os)
@anchor{library/os os openpty}@anchor{2b5f}
@deffn {Función} os.openpty ()

@geindex module;pty

Abre un nuevo par de pseudo-terminal. Retorna un par de descriptores de archivo @code{(master, slave)}; para pty y tty, respectivamente. Los nuevos descriptores de archivo son @ref{f7c,,no heredable}. Para un enfoque (ligeramente) más portátil, use el módulo @ref{b1,,pty}.

@ref{1d5a,,Availability}: Unix, not WASI.


Distinto en la versión 3.4: Los nuevos descriptores de archivo ahora son no heredables.

@end deffn

@geindex pipe() (en el módulo os)
@anchor{library/os os pipe}@anchor{17e1}
@deffn {Función} os.pipe ()

Crea una tubería. Retorna un par de descriptores de archivo @code{(r, w)} que se pueden usar para leer y escribir, respectivamente. El nuevo descriptor de archivo es @ref{f7c,,no heredable}.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.4: Los nuevos descriptores de archivo ahora son no heredables.

@end deffn

@geindex pipe2() (en el módulo os)
@anchor{library/os os pipe2}@anchor{115c}
@deffn {Función} os.pipe2 (flags, /)

Crea una tubería con `flags' establecidas atómicamente. `flags' pueden construirse juntando uno o más de estos valores: @ref{ec0,,O_NONBLOCK}, @ref{10f8,,O_CLOEXEC} con el operador OR. Retorna un par de descriptores de archivo @code{(r, w)} que se pueden usar para leer y escribir, respectivamente.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex posix_fallocate() (en el módulo os)
@anchor{library/os os posix_fallocate}@anchor{e1a}
@deffn {Función} os.posix_fallocate (fd, offset, len, /)

Asegura que se asigne suficiente espacio en disco para el archivo especificado por `fd' a partir de `offset' y se extiende por `len' bytes.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex posix_fadvise() (en el módulo os)
@anchor{library/os os posix_fadvise}@anchor{e19}
@deffn {Función} os.posix_fadvise (fd, offset, len, advice, /)

Avisa una intención de acceder a los datos en un patrón específico, permitiendo así que el núcleo haga optimizaciones. El consejo se aplica a la región del archivo especificada por `fd' que comienza en `offset' y se extiende para `len' bytes. `advice' es uno de @ref{2b60,,POSIX_FADV_NORMAL}, @ref{2b61,,POSIX_FADV_SEQUENTIAL}, @ref{2b62,,POSIX_FADV_RANDOM}, @ref{2b63,,POSIX_FADV_NOREUSE}, @ref{2b64,,POSIX_FADV_WILLNEED} o @ref{2b65,,POSIX_FADV_DONTNEED}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex POSIX_FADV_NORMAL (en el módulo os)
@geindex POSIX_FADV_SEQUENTIAL (en el módulo os)
@geindex POSIX_FADV_RANDOM (en el módulo os)
@geindex POSIX_FADV_NOREUSE (en el módulo os)
@geindex POSIX_FADV_WILLNEED (en el módulo os)
@geindex POSIX_FADV_DONTNEED (en el módulo os)
@anchor{library/os os POSIX_FADV_NORMAL}@anchor{2b60}
@deffn {Dato} os.POSIX_FADV_NORMAL
@anchor{library/os os POSIX_FADV_SEQUENTIAL}@anchor{2b61}
@deffnx {Dato} os.POSIX_FADV_SEQUENTIAL
@anchor{library/os os POSIX_FADV_RANDOM}@anchor{2b62}
@deffnx {Dato} os.POSIX_FADV_RANDOM
@anchor{library/os os POSIX_FADV_NOREUSE}@anchor{2b63}
@deffnx {Dato} os.POSIX_FADV_NOREUSE
@anchor{library/os os POSIX_FADV_WILLNEED}@anchor{2b64}
@deffnx {Dato} os.POSIX_FADV_WILLNEED
@anchor{library/os os POSIX_FADV_DONTNEED}@anchor{2b65}
@deffnx {Dato} os.POSIX_FADV_DONTNEED

Indicadores que se pueden usar en `advice' en @ref{e19,,posix_fadvise()} que especifican el patrón de acceso que es probable que se use.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex pread() (en el módulo os)
@anchor{library/os os pread}@anchor{be7}
@deffn {Función} os.pread (fd, n, offset, /)

Lee como máximo `n' bytes del descriptor de archivo `fd' en una posición de `offset', sin modificar el desplazamiento (`offset') del archivo.

Retorna una cadena de bytes que contiene los bytes leídos. Si se alcanza el final del archivo al que hace referencia `fd', se retorna un objeto de bytes vacío.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex posix_openpt() (en el módulo os)
@anchor{library/os os posix_openpt}@anchor{168c}
@deffn {Función} os.posix_openpt (oflag, /)

Open and return a file descriptor for a master pseudo-terminal device.

Calls the C standard library function @code{posix_openpt()}. The `oflag'
argument is used to set file status flags and file access modes as
specified in the manual page of @code{posix_openpt()} of your system.

The returned file descriptor is @ref{f7c,,non-inheritable}.
If the value @ref{10f8,,O_CLOEXEC} is available on the system, it is added to
`oflag'.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex preadv() (en el módulo os)
@anchor{library/os os preadv}@anchor{be5}
@deffn {Función} os.preadv (fd, buffers, offset, flags=0, /)

Lee de un descriptor de archivo `fd' en una posición de `offset' en mutable @ref{db4,,objetos de tipo bytes} `buffers', dejando el desplazamiento del archivo sin cambios. Transfiere datos a cada búfer hasta que esté lleno y luego pase al siguiente búfer en la secuencia para contener el resto de los datos.

El argumento flags contiene un operador de bit a bit OR de cero o más de las siguientes flags:


@itemize -

@item 
@ref{2b66,,RWF_HIPRI}

@item 
@ref{2b67,,RWF_NOWAIT}
@end itemize

Retorna el número total de bytes realmente leídos que puede ser menor que la capacidad total de todos los objetos.

El sistema operativo puede establecer un límite (@ref{2b68,,sysconf()} valor @code{'SC_IOV_MAX'}) en el número de búferes que se pueden usar.

Combina la funcionalidad de @ref{be6,,os.readv()} y @ref{be7,,os.pread()}.

@ref{1d5a,,Availability}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

El uso de banderas requiere Linux >= 4.6.


Added in version 3.7.

@end deffn

@geindex RWF_NOWAIT (en el módulo os)
@anchor{library/os os RWF_NOWAIT}@anchor{2b67}
@deffn {Dato} os.RWF_NOWAIT

No espere datos que no estén disponibles de inmediato. Si se especifica este indicador, la llamada al sistema regresará instantáneamente si tuviera que leer datos del almacenamiento de respaldo o esperar por un bloqueo.

If some data was successfully read, it will return the number of bytes read.
If no bytes were read, it will return @code{-1} and set errno to
@ref{22a1,,errno.EAGAIN}.

@ref{1d5a,,Availability}: Linux >= 4.14.


Added in version 3.7.

@end deffn

@geindex RWF_HIPRI (en el módulo os)
@anchor{library/os os RWF_HIPRI}@anchor{2b66}
@deffn {Dato} os.RWF_HIPRI

Alta prioridad de lectura/escritura. Permite que los sistemas de archivos basados en bloques utilicen el sondeo del dispositivo, lo que proporciona una latencia más baja, pero puede usar recursos adicionales.

Actualmente, en Linux, esta función sólo se puede usar en un descriptor de archivo abierto con el indicador @ref{2b5b,,O_DIRECT}.

@ref{1d5a,,Availability}: Linux >= 4.6.


Added in version 3.7.

@end deffn

@geindex ptsname() (en el módulo os)
@anchor{library/os os ptsname}@anchor{168f}
@deffn {Función} os.ptsname (fd, /)

Return the name of the slave pseudo-terminal device associated with the
master pseudo-terminal device to which the file descriptor `fd' refers.
The file descriptor `fd' is not closed upon failure.

Calls the reentrant C standard library function @code{ptsname_r()} if
it is available; otherwise, the C standard library function
@code{ptsname()}, which is not guaranteed to be thread-safe, is called.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex pwrite() (en el módulo os)
@anchor{library/os os pwrite}@anchor{bea}
@deffn {Función} os.pwrite (fd, str, offset, /)

Escribe la cadena de bytes en `str' en el descriptor de archivo `fd' en la posición `offset', sin modificar el desplazamiento del archivo.

Retorna el número de bytes realmente escritos.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex pwritev() (en el módulo os)
@anchor{library/os os pwritev}@anchor{be8}
@deffn {Función} os.pwritev (fd, buffers, offset, flags=0, /)

Write the `buffers' contents to file descriptor `fd' at an offset `offset',
leaving the file offset unchanged.  `buffers' must be a sequence of
@ref{db4,,bytes-like objects}. Buffers are processed in
array order. Entire contents of the first buffer is written before
proceeding to the second, and so on.

El argumento flags contiene un operador de bit a bit OR de cero o más de las siguientes flags:


@itemize -

@item 
@ref{2b69,,RWF_DSYNC}

@item 
@ref{2b6a,,RWF_SYNC}

@item 
@ref{1950,,RWF_APPEND}
@end itemize

Retorna el número total de bytes realmente escritos.

El sistema operativo puede establecer un límite (@ref{2b68,,sysconf()} valor @code{'SC_IOV_MAX'}) en el número de búferes que se pueden usar.

Combina la funcionalidad de @ref{be9,,os.writev()} y @ref{bea,,os.pwrite()}.

@ref{1d5a,,Availability}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

El uso de banderas requiere Linux >= 4.6.


Added in version 3.7.

@end deffn

@geindex RWF_DSYNC (en el módulo os)
@anchor{library/os os RWF_DSYNC}@anchor{2b69}
@deffn {Dato} os.RWF_DSYNC

Proporcione un equivalente por escritura del indicador @ref{2b4f,,O_DSYNC} @ref{e18,,os.open()}. Este efecto de bandera se aplica solo al rango de datos escrito por la llamada al sistema.

@ref{1d5a,,Availability}: Linux >= 4.7.


Added in version 3.7.

@end deffn

@geindex RWF_SYNC (en el módulo os)
@anchor{library/os os RWF_SYNC}@anchor{2b6a}
@deffn {Dato} os.RWF_SYNC

Proporcione un equivalente por escritura del indicador @ref{2b51,,O_SYNC} @ref{e18,,os.open()}. Este efecto de bandera se aplica solo al rango de datos escrito por la llamada al sistema.

@ref{1d5a,,Availability}: Linux >= 4.7.


Added in version 3.7.

@end deffn

@geindex RWF_APPEND (en el módulo os)
@anchor{library/os os RWF_APPEND}@anchor{1950}
@deffn {Dato} os.RWF_APPEND

Proporcione un equivalente por escritura del indicador @ref{2b4c,,O_APPEND} @ref{e18,,os.open()}. Esta bandera es significativa solo para @ref{be8,,os.pwritev()} y su efecto se aplica solo al rango de datos escrito por la llamada al sistema. El argumento `offset' no afecta la operación de escritura; los datos siempre se añaden al final del archivo. Sin embargo, si el argumento `offset' es @code{-1}, se actualiza el `offset' actual del archivo.

@ref{1d5a,,Availability}: Linux >= 4.16.


Added in version 3.10.

@end deffn

@geindex read() (en el módulo os)
@anchor{library/os os read}@anchor{e1b}
@deffn {Función} os.read (fd, n, /)

Lee como máximo `n' bytes del descriptor de archivo `fd'.

Retorna una cadena de bytes que contiene los bytes leídos. Si se alcanza el final del archivo al que hace referencia `fd', se retorna un objeto de bytes vacío.

@cartouche
@quotation Nota 
Esta función está diseñada para E/S de bajo nivel y debe aplicarse a un descriptor de archivo tal como lo retorna @ref{e18,,os.open()} o @ref{17e1,,pipe()}. Para leer un «objeto archivo» retornado por la función incorporada @ref{1be,,open()} o por @ref{1c5,,popen()} o @ref{1f33,,fdopen()}, o @ref{5df,,sys.stdin}, use los métodos @code{read()} o @code{readline()}.
@end quotation
@end cartouche


Distinto en la versión 3.5: Si la llamada al sistema se interrumpe y el controlador de señal no genera una excepción, la función vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@end deffn

@geindex sendfile() (en el módulo os)
@anchor{library/os os sendfile}@anchor{b9a}
@deffn {Función} os.sendfile (out_fd, in_fd, offset, count)

@deffnx {Función} os.sendfile (out_fd, in_fd, offset, count, headers=(), trailers=(), flags=0)

Copia `count' bytes del descriptor de archivo `in_fd' al descriptor de archivo `out_fd' comenzando en `offset'. Retorna el número de bytes enviados. Cuando se alcanza EOF, retorna @code{0}.

La primera notación de la función es compatible con todas las plataformas que definen @ref{b9a,,sendfile()}.

En Linux, si `offset' se entrega como @code{None}, los bytes se leen desde la posición actual de `in_fd' y la posición de `in_fd' se actualiza.

El segundo caso se puede usar en macOS y FreeBSD donde `headers' y `trailers' son secuencias arbitrarias de búferes que se escriben antes y después de que se escriban los datos de `in_fd'. Retorna lo mismo que el primer caso.

En macOS y FreeBSD, un valor de @code{0} para `count' especifica enviar hasta que se alcanza el final de `in_fd'.

Todas las plataformas admiten sockets como descriptor de archivo `out_fd', y algunas plataformas también permiten otros tipos (por ejemplo, archivo regular, tuberías).

Las aplicaciones multiplataforma no deben usar los argumentos `headers', `trailers' y `flags'.

@ref{1d5a,,Availability}: Unix, not WASI.

@cartouche
@quotation Nota 
Para un contenedor de alto nivel de @ref{b9a,,sendfile()}, vea @ref{edd,,socket.socket.sendfile()}.
@end quotation
@end cartouche


Added in version 3.3.



Distinto en la versión 3.9: Parámetros `out' e `in' han sido renombrados a `out_fd' e `in_fd'.

@end deffn

@geindex SF_NODISKIO (en el módulo os)
@geindex SF_MNOWAIT (en el módulo os)
@geindex SF_SYNC (en el módulo os)
@anchor{library/os os SF_NODISKIO}@anchor{2b6b}
@deffn {Dato} os.SF_NODISKIO
@anchor{library/os os SF_MNOWAIT}@anchor{2b6c}
@deffnx {Dato} os.SF_MNOWAIT
@anchor{library/os os SF_SYNC}@anchor{2b6d}
@deffnx {Dato} os.SF_SYNC

Parámetros para la función @ref{b9a,,sendfile()}, si la implementación los admite.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex SF_NOCACHE (en el módulo os)
@anchor{library/os os SF_NOCACHE}@anchor{2b6e}
@deffn {Dato} os.SF_NOCACHE

Parámetro a la función @ref{b9a,,sendfile()}, si la implementación lo admite. Los datos no se almacenarán en caché en la memoria virtual y se liberarán después.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.11.

@end deffn

@geindex set_blocking() (en el módulo os)
@anchor{library/os os set_blocking}@anchor{ebf}
@deffn {Función} os.set_blocking (fd, blocking, /)

Establece el modo de bloqueo del descriptor de archivo especificado. Establece la flag @ref{ec0,,O_NONBLOCK} si se quiere que el bloqueo sea @code{False}, borre la flag de lo contrario.

Consulte también @ref{ebe,,get_blocking()} y @ref{2b41,,socket.socket.setblocking()}.

@ref{1d5a,,Availability}: Unix, Windows.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.

On Windows, this function is limited to pipes.


Added in version 3.5.



Distinto en la versión 3.12: Added support for pipes on Windows.

@end deffn

@geindex splice() (en el módulo os)
@anchor{library/os os splice}@anchor{8b0}
@deffn {Función} os.splice (src, dst, count, offset_src=None, offset_dst=None, flags=0)

Transfer `count' bytes from file descriptor `src', starting from offset
`offset_src', to file descriptor `dst', starting from offset `offset_dst'.

The splicing behaviour can be modified by specifying a `flags' value.
Any of the following variables may used, combined using bitwise OR
(the @code{|} operator):


@itemize *

@item 
If @ref{2b6f,,SPLICE_F_MOVE} is specified,
the kernel is asked to move pages instead of copying,
but pages may still be copied if the kernel cannot move the pages from the pipe.

@item 
If @ref{2b70,,SPLICE_F_NONBLOCK} is specified,
the kernel is asked to not block on I/O.
This makes the splice pipe operations nonblocking,
but splice may nevertheless block because the spliced file descriptors may block.

@item 
If @ref{2b71,,SPLICE_F_MORE} is specified,
it hints to the kernel that more data will be coming in a subsequent splice.
@end itemize

At least one of the file descriptors must refer to a pipe. If `offset_src'
is @code{None}, then `src' is read from the current position; respectively for
`offset_dst'. The offset associated to the file descriptor that refers to a
pipe must be @code{None}. The files pointed to by `src' and `dst' must reside in
the same filesystem, otherwise an @ref{4d5,,OSError} is raised with
@ref{2290,,errno} set to @ref{2b3f,,errno.EXDEV}.

Esta copia se realiza sin el costo adicional de transferir datos desde el kernel al espacio del usuario y luego nuevamente al kernel. También, algunos sistemas de archivos podrían implementar optimizaciones adicionales. La copia se realiza como si ambos archivos se abrieran como binarios.

Una vez completado con éxito, retorna el número de bytes empalmados hacia o desde la tubería. Un valor de retorno de 0 significa el final de la entrada. Si `src' se refiere a una tubería, esto significa que no hay datos para transferir y no tendría sentido bloquear porque no hay escritores conectados al extremo de escritura de la tubería.


@subsubheading Ver también


The @code{splice(2)@footnote{https://manpages.debian.org/splice(2)}} man page.


@ref{1d5a,,Availability}: Linux >= 2.6.17 with glibc >= 2.5


Added in version 3.10.

@end deffn

@geindex SPLICE_F_MOVE (en el módulo os)
@geindex SPLICE_F_NONBLOCK (en el módulo os)
@geindex SPLICE_F_MORE (en el módulo os)
@anchor{library/os os SPLICE_F_MOVE}@anchor{2b6f}
@deffn {Dato} os.SPLICE_F_MOVE
@anchor{library/os os SPLICE_F_NONBLOCK}@anchor{2b70}
@deffnx {Dato} os.SPLICE_F_NONBLOCK
@anchor{library/os os SPLICE_F_MORE}@anchor{2b71}
@deffnx {Dato} os.SPLICE_F_MORE


Added in version 3.10.

@end deffn

@geindex readv() (en el módulo os)
@anchor{library/os os readv}@anchor{be6}
@deffn {Función} os.readv (fd, buffers, /)

Leer desde un descriptor de archivo `fd' en una cantidad de mutable @ref{db4,,objetos tipo bytes} `buffers'. Transfiere datos a cada búfer hasta que esté lleno y luego pase al siguiente búfer en la secuencia para contener el resto de los datos.

Retorna el número total de bytes realmente leídos que puede ser menor que la capacidad total de todos los objetos.

El sistema operativo puede establecer un límite (@ref{2b68,,sysconf()} valor @code{'SC_IOV_MAX'}) en el número de búferes que se pueden usar.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex tcgetpgrp() (en el módulo os)
@anchor{library/os os tcgetpgrp}@anchor{2b72}
@deffn {Función} os.tcgetpgrp (fd, /)

Retorna el grupo del proceso asociado con la terminal proporcionada por `fd' (un descriptor de archivo abierto como lo retorna @ref{e18,,os.open()}).

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex tcsetpgrp() (en el módulo os)
@anchor{library/os os tcsetpgrp}@anchor{2b73}
@deffn {Función} os.tcsetpgrp (fd, pg, /)

Establece el grupo del proceso asociado con la terminal dada por `fd' (un descriptor de archivo abierto como lo retorna @ref{e18,,os.open()}) a `pg'.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex ttyname() (en el módulo os)
@anchor{library/os os ttyname}@anchor{2b74}
@deffn {Función} os.ttyname (fd, /)

Retorna una cadena que especifica el dispositivo de terminal asociado con el descriptor de archivo `fd'. Si `fd' no está asociado con un dispositivo de terminal, se genera una excepción.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex unlockpt() (en el módulo os)
@anchor{library/os os unlockpt}@anchor{168e}
@deffn {Función} os.unlockpt (fd, /)

Unlock the slave pseudo-terminal device associated with the master
pseudo-terminal device to which the file descriptor `fd' refers.
The file descriptor `fd' is not closed upon failure.

Calls the C standard library function @code{unlockpt()}.

@ref{1d5a,,Availability}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex write() (en el módulo os)
@anchor{library/os os write}@anchor{e21}
@deffn {Función} os.write (fd, str, /)

Escribe la cadena de bytes en `str' en el descriptor de archivo `fd'.

Retorna el número de bytes realmente escritos.

@cartouche
@quotation Nota 
Esta función está diseñada para E/S de bajo nivel y debe aplicarse a un descriptor de archivo tal como lo retorna @ref{e18,,os.open()} o @ref{17e1,,pipe()}. Para escribir un «objeto archivo» retornado por la función incorporada @ref{1be,,open()} o por @ref{1c5,,popen()} o @ref{1f33,,fdopen()}, o @ref{b61,,sys.stdout} o @ref{9cc,,sys.stderr}, use el método @code{write()}.
@end quotation
@end cartouche


Distinto en la versión 3.5: Si la llamada al sistema se interrumpe y el controlador de señal no genera una excepción, la función vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@end deffn

@geindex writev() (en el módulo os)
@anchor{library/os os writev}@anchor{be9}
@deffn {Función} os.writev (fd, buffers, /)

Escribe el contenido de `buffers' en el descriptor de archivo `fd'. `buffers' debe ser una secuencia de @ref{db4,,objetos tipo bytes}. Los búferes se procesan en orden secuencial. Se escribe todo el contenido del primer búfer antes de pasar al segundo, y así sucesivamente.

Retorna el número total de bytes realmente escritos.

El sistema operativo puede establecer un límite (@ref{2b68,,sysconf()} valor @code{'SC_IOV_MAX'}) en el número de búferes que se pueden usar.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@menu
* Consultando las dimensiones de una terminal:: 
* Herencia de los descriptores de archivos:: 

@end menu

@node Consultando las dimensiones de una terminal,Herencia de los descriptores de archivos,,Operaciones de descriptores de archivos
@anchor{library/os querying-the-size-of-a-terminal}@anchor{2b75}@anchor{library/os terminal-size}@anchor{2b76}
@subsubsection Consultando las dimensiones de una terminal



Added in version 3.3.


@geindex get_terminal_size() (en el módulo os)
@anchor{library/os os get_terminal_size}@anchor{1174}
@deffn {Función} os.get_terminal_size (fd=STDOUT_FILENO, /)

Retorna el tamaño de la ventana de la terminal como @code{(columns, lines)}, una tupla del tipo @ref{2877,,terminal_size}.

El argumento opcional @code{fd} (por defecto es @code{STDOUT_FILENO}, o la salida estándar) especifica qué descriptor de archivo debe consultarse.

Si el descriptor de archivo no está conectado a una terminal, se genera un @ref{4d5,,OSError}.

@ref{1175,,shutil.get_terminal_size()} es la función de alto nivel que normalmente debería usarse, @code{os.get_terminal_size} es la implementación de bajo nivel.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex terminal_size (clase en os)
@anchor{library/os os terminal_size}@anchor{2877}
@deffn {Clase} os.terminal_size

Una subclase de tupla, que contiene @code{(columns, lines)} representando el tamaño de la ventana de la terminal.

@geindex columns (atributo de os.terminal_size)
@anchor{library/os os terminal_size columns}@anchor{2b77}
@deffn {Atributo} columns

Ancho de la ventana de la terminal en caracteres.
@end deffn

@geindex lines (atributo de os.terminal_size)
@anchor{library/os os terminal_size lines}@anchor{2b78}
@deffn {Atributo} lines

Alto de la ventana de la terminal en caracteres.
@end deffn
@end deffn

@node Herencia de los descriptores de archivos,,Consultando las dimensiones de una terminal,Operaciones de descriptores de archivos
@anchor{library/os fd-inheritance}@anchor{f7c}@anchor{library/os inheritance-of-file-descriptors}@anchor{2b79}
@subsubsection Herencia de los descriptores de archivos



Added in version 3.4.


Un descriptor de archivo tiene un indicador heredable (`inheritable') que indica si el descriptor de archivo puede ser heredado por procesos secundarios. Desde Python 3.4, los descriptores de archivo creados por Python son no heredables por defecto.

En UNIX, los descriptores de archivo no heredables se cierran en procesos hijos en la ejecución de un nuevo programa, otros descriptores de archivos sí se heredan.

En Windows, los descriptores de archivo y los identificadores no heredables se cierran en los procesos hijos, a excepción de los flujos estándar (descriptores de archivo 0, 1 y 2: stdin, stdout y stderr), que siempre se heredan. Usando las funciones @ref{1c6,,spawn*}, todos los identificadores heredables y todos los descriptores de archivos heredables se heredan. Usando el módulo @ref{d6,,subprocess}, todos los descriptores de archivo, excepto los flujos estándar, están cerrados, y los identificadores heredables sólo se heredan si el parámetro `close_fds' es @code{False}.

On WebAssembly platforms, the file descriptor cannot be modified.

@geindex get_inheritable() (en el módulo os)
@anchor{library/os os get_inheritable}@anchor{f7d}
@deffn {Función} os.get_inheritable (fd, /)

Obtiene el indicador heredable (`inheritable') del descriptor de archivo especificado (un valor booleano).
@end deffn

@geindex set_inheritable() (en el módulo os)
@anchor{library/os os set_inheritable}@anchor{f7e}
@deffn {Función} os.set_inheritable (fd, inheritable, /)

Establece el indicador heredable (`inheritable') del descriptor de archivo especificado.
@end deffn

@geindex get_handle_inheritable() (en el módulo os)
@anchor{library/os os get_handle_inheritable}@anchor{f7f}
@deffn {Función} os.get_handle_inheritable (handle, /)

Obtiene el indicador heredable (`inheritable') del identificador especificado (un valor booleano).

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex set_handle_inheritable() (en el módulo os)
@anchor{library/os os set_handle_inheritable}@anchor{f80}
@deffn {Función} os.set_handle_inheritable (handle, inheritable, /)

Establece el indicador heredable (`inheritable') del identificador especificado.

@ref{1d5a,,Availability}: Windows.
@end deffn

@node Archivos y directorios,Gestión de proceso,Operaciones de descriptores de archivos,os — Miscellaneous operating system interfaces
@anchor{library/os files-and-directories}@anchor{2b7a}@anchor{library/os os-file-dir}@anchor{2b0d}
@subsubsection Archivos y directorios


En algunas plataformas Unix, muchas de estas funciones admiten una o más de estas características:
@anchor{library/os path-fd}@anchor{be4}

@itemize *

@item 
`especificando un descriptor de archivo:' Normalmente el argumento `path' proporcionado a las funciones en el módulo @ref{a1,,os} debe ser una cadena que especifique una ruta de archivo. Sin embargo, algunas funciones ahora aceptan alternativamente un descriptor de archivo abierto para su argumento `path'. La función actuará en el archivo al que hace referencia el descriptor. (Para los sistemas POSIX, Python llamará a la variante de la función con el prefijo @code{f} (por ejemplo, llamará a @code{fchdir} en lugar de @code{chdir})).

Puede verificar si `path' se puede especificar o no como un descriptor de archivo para una función particular en su plataforma usando @ref{116f,,os.supports_fd}. Si esta funcionalidad no está disponible, su uso lanzará un @ref{384,,NotImplementedError}.

Si la función también admite argumentos `dir_fd' o `follow_symlinks', es un error especificar uno de esos al suministrar `path' como descriptor de archivo.
@end itemize
@anchor{library/os dir-fd}@anchor{115d}

@itemize *

@item 
`rutas relativas a los descriptores de directorio:' Si `dir_fd' no es @code{None}, debería ser un descriptor de archivo que se refiera a un directorio, y la ruta a operar debería ser relativa; entonces la ruta será relativa a ese directorio. Si la ruta es absoluta, `dir_fd' se ignora. (Para los sistemas POSIX, Python llamará a la variante de la función con un sufijo @code{at} y posiblemente con el prefijo @code{f} (por ejemplo, llamará a @code{faccessat} en lugar de @code{access}).

Puede verificar si `dir_fd' es compatible o no para una función particular en su plataforma usando @ref{116a,,os.supports_dir_fd}. Si no está disponible, usarlo lanzará un @ref{384,,NotImplementedError}.
@end itemize
@anchor{library/os follow-symlinks}@anchor{115e}

@itemize *

@item 
`no seguir los enlaces simbólicos:' Si `follow_symlinks' es @code{False}, y el último elemento de la ruta para operar es un enlace simbólico, la función operará en el enlace simbólico en lugar del archivo señalado por el enlace. (Para los sistemas POSIX, Python llamará a la variante @code{l...} de la función).

Puede verificar si `follow_symlinks' es compatible o no para una función particular en su plataforma usando @ref{2861,,os.supports_follow_symlinks}. Si no está disponible, usarlo lanzará un @ref{384,,NotImplementedError}.
@end itemize

@geindex access() (en el módulo os)
@anchor{library/os os access}@anchor{115f}
@deffn {Función} os.access (path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

Use el uid/gid real para probar el acceso a `path'. Tenga en cuenta que la mayoría de las operaciones utilizarán el uid/gid efectivo, por lo tanto, esta rutina se puede usar en un entorno suid/sgid para probar si el usuario que invoca tiene el acceso especificado a `path'. `mode' debería ser @ref{2b7b,,F_OK} para probar la existencia de `path', o puede ser el OR inclusivo de uno o más de @ref{2b7c,,R_OK}, @ref{2b7d,,W_OK}, y @ref{2b7e,,X_OK} para probar los permisos. Retorna @ref{c95,,True} si el acceso está permitido, @ref{bbf,,False} si no. Consulte la página de manual de Unix @code{access (2)@footnote{https://manpages.debian.org/access (2)}} para obtener más información.

Esta función puede admitir la especificación @ref{115d,,rutas relativas a descriptores de directorio} y @ref{115e,,no seguir los enlaces simbólicos}.

Si `effective_ids' es @code{True}, @ref{115f,,access()} realizará sus comprobaciones de acceso utilizando el uid/gid efectivo en lugar del uid/gid real. `effective_ids' puede no ser compatible con su plataforma; puede verificar si está disponible o no usando @ref{1170,,os.supports_effective_ids}. Si no está disponible, usarlo lanzará un @ref{384,,NotImplementedError}.

@cartouche
@quotation Nota 
Usando @ref{115f,,access()} para verificar si un usuario está autorizado para, por ejemplo, abrir un archivo antes de hacerlo usando @ref{1be,,open()} crea un agujero de seguridad, porque el usuario podría explotar el breve intervalo de tiempo entre verificar y abrir el archivo para manipularlo es preferible utilizar técnicas @ref{2b7f,,EAFP}. Por ejemplo:

@example
if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()
return "some default data"
@end example

está mejor escrito como:

@example
try:
    fp = open("myfile")
except PermissionError:
    return "some default data"
else:
    with fp:
        return fp.read()
@end example
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Las operaciones de E/S pueden fallar incluso cuando @ref{115f,,access()} indica que tendrán éxito, particularmente para operaciones en sistemas de archivos de red que pueden tener una semántica de permisos más allá del modelo habitual de bits de permiso POSIX.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se agregaron los parámetros `dir_fd', `effective_ids' y `follow_symlinks'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex F_OK (en el módulo os)
@geindex R_OK (en el módulo os)
@geindex W_OK (en el módulo os)
@geindex X_OK (en el módulo os)
@anchor{library/os os F_OK}@anchor{2b7b}
@deffn {Dato} os.F_OK
@anchor{library/os os R_OK}@anchor{2b7c}
@deffnx {Dato} os.R_OK
@anchor{library/os os W_OK}@anchor{2b7d}
@deffnx {Dato} os.W_OK
@anchor{library/os os X_OK}@anchor{2b7e}
@deffnx {Dato} os.X_OK

Valores para pasar como parámetro `mode' de @ref{115f,,access()} para probar la existencia, legibilidad, escritura y ejecutabilidad de `path', respectivamente.
@end deffn

@geindex chdir() (en el módulo os)
@anchor{library/os os chdir}@anchor{6ae}
@deffn {Función} os.chdir (path)

@geindex directory;changing

Cambia el directorio de trabajo actual a `path'.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}. El descriptor debe hacer referencia a un directorio abierto, no a un archivo abierto.

Esta función puede generar @ref{4d5,,OSError} y subclases como @ref{f46,,FileNotFoundError}, @ref{dc9,,PermissionError}, y @ref{10d6,,NotADirectoryError}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chdir} con argumento @code{path}.


Distinto en la versión 3.3: Se agregó soporte para especificar `path' como descriptor de archivo en algunas plataformas.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex chflags() (en el módulo os)
@anchor{library/os os chflags}@anchor{1160}
@deffn {Función} os.chflags (path, flags, *, follow_symlinks=True)

Establece las flags del `path' a las `flags' numéricas. `flags' puede tomar una combinación (OR bit a bit) de los siguientes valores (como se define en el módulo @ref{d1,,stat}):


@itemize *

@item 
@ref{2807,,stat.UF_NODUMP}

@item 
@ref{2808,,stat.UF_IMMUTABLE}

@item 
@ref{2809,,stat.UF_APPEND}

@item 
@ref{280a,,stat.UF_OPAQUE}

@item 
@ref{280b,,stat.UF_NOUNLINK}

@item 
@ref{280c,,stat.UF_COMPRESSED}

@item 
@ref{280f,,stat.UF_HIDDEN}

@item 
@ref{2813,,stat.SF_ARCHIVED}

@item 
@ref{2814,,stat.SF_IMMUTABLE}

@item 
@ref{2815,,stat.SF_APPEND}

@item 
@ref{2817,,stat.SF_NOUNLINK}

@item 
@ref{2818,,stat.SF_SNAPSHOT}
@end itemize

Esta función puede soportar @ref{115e,,no seguir enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chflags} con argumentos @code{path}, @code{flags}.

@ref{1d5a,,Availability}: Unix, not WASI.


Distinto en la versión 3.3: Added the `follow_symlinks' parameter.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex chmod() (en el módulo os)
@anchor{library/os os chmod}@anchor{378}
@deffn {Función} os.chmod (path, mode, *, dir_fd=None, follow_symlinks=True)

Cambia el modo de `path' al modo numérico `mode'. `mode' puede tomar uno de los siguientes valores (como se define en el módulo @ref{d1,,stat}) o combinaciones OR de bit a bit de ellos:


@itemize *

@item 
@ref{27f3,,stat.S_ISUID}

@item 
@ref{27f4,,stat.S_ISGID}

@item 
@ref{27f6,,stat.S_ENFMT}

@item 
@ref{27f7,,stat.S_ISVTX}

@item 
@ref{2803,,stat.S_IREAD}

@item 
@ref{2804,,stat.S_IWRITE}

@item 
@ref{2805,,stat.S_IEXEC}

@item 
@ref{27f8,,stat.S_IRWXU}

@item 
@ref{27f9,,stat.S_IRUSR}

@item 
@ref{27fa,,stat.S_IWUSR}

@item 
@ref{27fb,,stat.S_IXUSR}

@item 
@ref{27fc,,stat.S_IRWXG}

@item 
@ref{27fd,,stat.S_IRGRP}

@item 
@ref{27fe,,stat.S_IWGRP}

@item 
@ref{27f5,,stat.S_IXGRP}

@item 
@ref{27ff,,stat.S_IRWXO}

@item 
@ref{2800,,stat.S_IROTH}

@item 
@ref{2801,,stat.S_IWOTH}

@item 
@ref{2802,,stat.S_IXOTH}
@end itemize

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}, @ref{115d,,rutas relativas a los descriptores de directorio} y @ref{115e,,no seguir enlaces simbólicos}.

@cartouche
@quotation Nota 
Although Windows supports @ref{378,,chmod()}, you can only set the file’s
read-only flag with it (via the @code{stat.S_IWRITE} and @code{stat.S_IREAD}
constants or a corresponding integer value).  All other bits are ignored.
The default value of `follow_symlinks' is @code{False} on Windows.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{os.chmod} con argumentos @code{path}, @code{mode}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto, y los argumentos `dir_fd' y `follow_symlinks'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.13: Added support for a file descriptor and the `follow_symlinks' argument
on Windows.

@end deffn

@geindex chown() (en el módulo os)
@anchor{library/os os chown}@anchor{1161}
@deffn {Función} os.chown (path, uid, gid, *, dir_fd=None, follow_symlinks=True)

Cambia el propietario y el `id' del grupo de `path' a los numéricos `uid' y `gid'. Para dejar uno de los identificadores sin cambios, configúrelo en -1.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}, @ref{115d,,rutas relativas a los descriptores de directorio} y @ref{115e,,no seguir enlaces simbólicos}.

Ver @ref{399,,shutil.chown()} para una función de nivel superior que acepta nombres además de identificadores numéricos.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chown} con argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.


Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto, y los argumentos `dir_fd' y `follow_symlinks'.



Distinto en la versión 3.6: Admite un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex chroot() (en el módulo os)
@anchor{library/os os chroot}@anchor{199c}
@deffn {Función} os.chroot (path)

Cambia el directorio raíz del proceso actual a `path'.

@ref{1d5a,,Availability}: Unix, not WASI, not Android.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex fchdir() (en el módulo os)
@anchor{library/os os fchdir}@anchor{e0f}
@deffn {Función} os.fchdir (fd)

Cambia el directorio de trabajo actual al directorio representado por el descriptor de archivo `fd'. El descriptor debe hacer referencia a un directorio abierto, no a un archivo abierto. A partir de Python 3.3, esto es equivalente a @code{os.chdir(fd)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chdir} con argumento @code{path}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex getcwd() (en el módulo os)
@anchor{library/os os getcwd}@anchor{159a}
@deffn {Función} os.getcwd ()

Retorna una cadena que representa el directorio de trabajo actual.
@end deffn

@geindex getcwdb() (en el módulo os)
@anchor{library/os os getcwdb}@anchor{b1c}
@deffn {Función} os.getcwdb ()

Retorna una cadena de bytes que representa el directorio de trabajo actual.


Distinto en la versión 3.8: La función ahora usa la codificación UTF-8 en Windows, en lugar de los códigos ANSI: consulte 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para ver la justificación. La función ya no está en desuso en Windows.

@end deffn

@geindex lchflags() (en el módulo os)
@anchor{library/os os lchflags}@anchor{2b80}
@deffn {Función} os.lchflags (path, flags)

Establece las flags de `path' a las `flags' numéricas, como @ref{1160,,chflags()}, pero no siga los enlaces simbólicos. A partir de Python 3.3, esto es equivalente a @code{os.chflags(path, flags, follow_symlinks=False)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chflags} con argumentos @code{path}, @code{flags}.

@ref{1d5a,,Availability}: Unix, not WASI.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex lchmod() (en el módulo os)
@anchor{library/os os lchmod}@anchor{377}
@deffn {Función} os.lchmod (path, mode)

Cambia el modo de `path' al `mode' numérico. Si la ruta es un enlace simbólico, esto afecta al enlace simbólico en lugar del objetivo. Consulte los documentos para @ref{378,,chmod()} para conocer los posibles valores de `mode'. A partir de Python 3.3, esto es equivalente a @code{os.chmod(path, mode, follow_symlinks=False)}.

@code{lchmod()} is not part of POSIX, but Unix implementations may have it if
changing the mode of symbolic links is supported.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chmod} con argumentos @code{path}, @code{mode}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix, Windows, not Linux, FreeBSD >= 1.3, NetBSD >= 1.3, not OpenBSD


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.13: Added support on Windows.

@end deffn

@geindex lchown() (en el módulo os)
@anchor{library/os os lchown}@anchor{2b81}
@deffn {Función} os.lchown (path, uid, gid)

Cambia el propietario y la identificación del grupo de `path' a los numéricos `uid' y `gid'. Esta función no seguirá enlaces simbólicos. A partir de Python 3.3, esto es equivalente a @code{os.chown(path, uid, gid, follow_symlinks=False)}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.chown} con argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex link() (en el módulo os)
@anchor{library/os os link}@anchor{1162}
@deffn {Función} os.link (src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)

Cree un enlace rígido que apunte a `src' llamado `dst'.

Esta función puede admitir la especificación de `src_dir_fd' o `dst_dir_fd' para proporcionar @ref{115d,,rutas relativas a los descriptores de directorio}, y @ref{115e,,no sigue enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.link} con argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.2: Se agregó soporte para Windows.



Distinto en la versión 3.3: Added the `src_dir_fd', `dst_dir_fd', and `follow_symlinks' parameters.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `src' y `dst'.

@end deffn

@geindex listdir() (en el módulo os)
@anchor{library/os os listdir}@anchor{116c}
@deffn {Función} os.listdir (path='.')

Retorna una lista que contiene los nombres de las entradas en el directorio dado por `path'. La lista está en un orden arbitrario y no incluye las entradas especiales @code{'.'} Y @code{'..'} incluso si están presentes en el directorio. Si un archivo es removido de o añadido al directorio mientras se llama a esta función, no se especifica si el nombre para el archivo será incluido.

`path' puede ser un @ref{3f0,,path-like object}. Si `path' es de tipo @code{bytes} (directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}), los nombres de archivo retornados también serán de tipo @code{bytes}; en todas las demás circunstancias, serán del tipo @code{str}.

Esta función también puede admitir @ref{be4,,especificando un descriptor de archivo}; el descriptor de archivo debe hacer referencia a un directorio.

Lanza un @ref{18c3,,evento de auditoría} @code{os.listdir} con el argumento @code{ruta}.

@cartouche
@quotation Nota 
Para codificar los nombres de archivo @code{str} en @code{bytes}, use @ref{cdd,,fsencode()}.
@end quotation
@end cartouche


@subsubheading Ver también


La función @ref{1a2,,scandir()} retorna entradas de directorio junto con información de atributos de archivo, lo que proporciona un mejor rendimiento para muchos casos de uso comunes.



Distinto en la versión 3.2: El parámetro `path' se convirtió en opcional.



Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex listdrives() (en el módulo os)
@anchor{library/os os listdrives}@anchor{545}
@deffn {Función} os.listdrives ()

Return a list containing the names of drives on a Windows system.

A drive name typically looks like @code{'C:\\'}. Not every drive name
will be associated with a volume, and some may be inaccessible for
a variety of reasons, including permissions, network connectivity
or missing media. This function does not test for access.

May raise @ref{4d5,,OSError} if an error occurs collecting the drive
names.

Raises an @ref{18c3,,auditing event} @code{os.listdrives} with no arguments.

@ref{1d5a,,Availability}: Windows


Added in version 3.12.

@end deffn

@geindex listmounts() (en el módulo os)
@anchor{library/os os listmounts}@anchor{547}
@deffn {Función} os.listmounts (volume)

Return a list containing the mount points for a volume on a Windows
system.

`volume' must be represented as a GUID path, like those returned by
@ref{546,,os.listvolumes()}. Volumes may be mounted in multiple locations
or not at all. In the latter case, the list will be empty. Mount
points that are not associated with a volume will not be returned by
this function.

The mount points return by this function will be absolute paths, and
may be longer than the drive name.

Raises @ref{4d5,,OSError} if the volume is not recognized or if an error
occurs collecting the paths.

Raises an @ref{18c3,,auditing event} @code{os.listmounts} with argument @code{volume}.

@ref{1d5a,,Availability}: Windows


Added in version 3.12.

@end deffn

@geindex listvolumes() (en el módulo os)
@anchor{library/os os listvolumes}@anchor{546}
@deffn {Función} os.listvolumes ()

Return a list containing the volumes in the system.

Volumes are typically represented as a GUID path that looks like
@code{\\?\Volume@{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx@}\}. Files can
usually be accessed through a GUID path, permissions allowing.
However, users are generally not familiar with them, and so the
recommended use of this function is to retrieve mount points
using @ref{547,,os.listmounts()}.

May raise @ref{4d5,,OSError} if an error occurs collecting the volumes.

Raises an @ref{18c3,,auditing event} @code{os.listvolumes} with no arguments.

@ref{1d5a,,Availability}: Windows


Added in version 3.12.

@end deffn

@geindex lstat() (en el módulo os)
@anchor{library/os os lstat}@anchor{549}
@deffn {Función} os.lstat (path, *, dir_fd=None)

Perform the equivalent of an @code{lstat()} system call on the given path.
Similar to @ref{548,,stat()}, but does not follow symbolic links. Return a
@ref{14fd,,stat_result} object.

En plataformas que no admiten enlaces simbólicos, este es un alias para @code{stat()}.

A partir de Python 3.3, esto es equivalente a @code{os.stat(path, dir_fd=dir_fd, follow_symlinks=False)}.

Esta función también puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.


@subsubheading Ver también


La función @ref{548,,stat()}.



Distinto en la versión 3.2: Se agregó soporte para enlaces simbólicos de Windows 6.0 (Vista).



Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.8: En Windows, ahora abre puntos de análisis que representan otra ruta (nombres sustitutos), incluidos enlaces simbólicos y uniones de directorio. El sistema operativo resuelve otros tipos de puntos de análisis como @ref{548,,stat()}.

@end deffn

@geindex mkdir() (en el módulo os)
@anchor{library/os os mkdir}@anchor{37a}
@deffn {Función} os.mkdir (path, mode=0o777, *, dir_fd=None)

Cree un directorio llamado `path' con modo numérico `mode'.

Si el directorio ya existe, se genera @ref{109c,,FileExistsError}. Si no existe un directorio principal en la ruta, se genera @ref{f46,,FileNotFoundError}.
@anchor{library/os mkdir-modebits}@anchor{2b82}
En algunos sistemas, `mode' se ignora. Donde se usa, el valor actual de umask se enmascara primero. Si se establecen bits distintos de los últimos 9 (es decir, los últimos 3 dígitos de la representación octal del `mode'), su significado depende de la plataforma. En algunas plataformas, se ignoran y debe llamar a @ref{378,,chmod()} explícitamente para configurarlos.

On Windows, a `mode' of @code{0o700} is specifically handled to apply access
control to the new directory such that only the current user and
administrators have access. Other values of `mode' are ignored.

Esta función también puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

También es posible crear directorios temporales; vea la función @ref{e0,,tempfile} del módulo @ref{37c,,tempfile.mkdtemp()}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.mkdir} con argumentos @code{ruta}, @code{modo}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.13: Windows now handles a `mode' of @code{0o700}.

@end deffn

@geindex makedirs() (en el módulo os)
@anchor{library/os os makedirs}@anchor{37b}
@deffn {Función} os.makedirs (name, mode=0o777, exist_ok=False)

@geindex directory;creating
@geindex UNC paths;and os.makedirs()

Función de creación de directorio recursiva. Como @ref{37a,,mkdir()}, pero hace que todos los directorios de nivel intermedio sean necesarios para contener el directorio hoja.

El parámetro `mode' se pasa a @ref{37a,,mkdir()} para crear el directorio hoja; consulte @ref{2b82,,the mkdir() description} para saber cómo se interpreta. Para configurar los bits de permiso de archivo de cualquier directorio principal recién creado, puede configurar umask antes de invocar @ref{37b,,makedirs()}. Los bits de permiso de archivo de los directorios principales existentes no se modifican.

Si `exist_ok' es @code{False} (el valor predeterminado), se genera un @ref{109c,,FileExistsError} si el directorio de destino ya existe.

@cartouche
@quotation Nota 
@ref{37b,,makedirs()} se confundirá si los elementos de ruta a crear incluyen @ref{2b83,,pardir} (por ejemplo, «..» en sistemas UNIX).
@end quotation
@end cartouche

Esta función maneja las rutas UNC correctamente.

Lanza un @ref{18c3,,evento de auditoría} @code{os.mkdir} con argumentos @code{ruta}, @code{modo}, @code{dir_fd}.


Distinto en la versión 3.2: Added the `exist_ok' parameter.



Distinto en la versión 3.4.1: Antes de Python 3.4.1, si `exist_ok' era @code{True} y el directorio existía, @ref{37b,,makedirs()} aún generaría un error si `mode' no coincidía con el modo del directorio existente. Como este comportamiento era imposible de implementar de forma segura, se eliminó en Python 3.4.1. Ver bpo-21082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21082}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.7: El argumento `mode' ya no afecta los bits de permiso de archivo de los directorios de nivel intermedio recién creados.

@end deffn

@geindex mkfifo() (en el módulo os)
@anchor{library/os os mkfifo}@anchor{e16}
@deffn {Función} os.mkfifo (path, mode=0o666, *, dir_fd=None)

Cree una FIFO (una tubería con nombre) llamada `path' con modo numérico `modo'. El valor actual de umask se enmascara primero del modo.

Esta función también puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

Los FIFO son tuberías a las que se puede acceder como archivos normales. Los FIFO existen hasta que se eliminan (por ejemplo con @ref{1168,,os.unlink()}). En general, los FIFO se utilizan como punto de encuentro entre los procesos de tipo «cliente» y «servidor»: el servidor abre el FIFO para leer y el cliente lo abre para escribir. Tenga en cuenta que @ref{e16,,mkfifo()} no abre el FIFO — solo crea el punto de encuentro.

@ref{1d5a,,Availability}: Unix, not WASI.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex mknod() (en el módulo os)
@anchor{library/os os mknod}@anchor{e17}
@deffn {Función} os.mknod (path, mode=0o600, device=0, *, dir_fd=None)

Cree un nodo del sistema de archivos (archivo, archivo especial del dispositivo o canalización con nombre) llamado `path'. `mode' especifica tanto los permisos para usar como el tipo de nodo que se creará, combinándose (OR bit a bit) con uno de @code{stat.S_IFREG}, @code{stat.S_IFCHR}, @code{stat.S_IFBLK} , y @code{stat.S_IFIFO} (esas constantes están disponibles en @ref{d1,,stat}). Para @code{stat.S_IFCHR} y @code{stat.S_IFBLK}, `device' define el archivo especial del dispositivo recién creado (probablemente usando @ref{15fe,,os.makedev()}), de lo contrario se ignora.

Esta función también puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

@ref{1d5a,,Availability}: Unix, not WASI.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex major() (en el módulo os)
@anchor{library/os os major}@anchor{15fc}
@deffn {Función} os.major (device, /)

Extract the device major number from a raw device number (usually the
@code{st_dev} or @code{st_rdev} field from @code{stat}).
@end deffn

@geindex minor() (en el módulo os)
@anchor{library/os os minor}@anchor{15fd}
@deffn {Función} os.minor (device, /)

Extract the device minor number from a raw device number (usually the
@code{st_dev} or @code{st_rdev} field from @code{stat}).
@end deffn

@geindex makedev() (en el módulo os)
@anchor{library/os os makedev}@anchor{15fe}
@deffn {Función} os.makedev (major, minor, /)

Compone un número de dispositivo sin procesar a partir de los números de dispositivo mayor y menor.
@end deffn

@geindex pathconf() (en el módulo os)
@anchor{library/os os pathconf}@anchor{116d}
@deffn {Función} os.pathconf (path, name)

Retorna información de configuración del sistema relevante para un archivo con nombre. `name' especifica el valor de configuración para recuperar; puede ser una cadena que es el nombre de un valor de sistema definido; Estos nombres se especifican en varios estándares (POSIX.1, Unix 95, Unix 98 y otros). Algunas plataformas también definen nombres adicionales. Los nombres conocidos por el sistema operativo host se dan en el diccionario @code{pathconf_names}. Para las variables de configuración no incluidas en esa asignación, también se acepta pasar un número entero para `name'.

Si `name' es una cadena y no se conoce, se lanza un @ref{360,,ValueError}. Si el sistema anfitrión no admite un valor específico para `name', incluso si está incluido en @code{pathconf_names}, se genera un @ref{4d5,,OSError} con @ref{19f8,,errno.EINVAL} para el número de error.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex pathconf_names (en el módulo os)
@anchor{library/os os pathconf_names}@anchor{2b84}
@deffn {Dato} os.pathconf_names

Nombres de mapeo de diccionario aceptados por @ref{116d,,pathconf()} y @ref{2b40,,fpathconf()} a los valores enteros definidos para esos nombres por el sistema operativo host. Esto se puede usar para determinar el conjunto de nombres conocidos por el sistema.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex readlink() (en el módulo os)
@anchor{library/os os readlink}@anchor{9b4}
@deffn {Función} os.readlink (path, *, dir_fd=None)

Retorna una cadena que representa la ruta a la que apunta el enlace simbólico. El resultado puede ser un nombre de ruta absoluto o relativo; si es relativo, se puede convertir a un nombre de ruta absoluto usando @code{os.path.join(os.path.dirname(path), result)}.

Si la `path' es un objeto de cadena (directa o indirectamente a través de una interfaz @ref{cd9,,PathLike}), el resultado también será un objeto de cadena y la llamada puede generar un UnicodeDecodeError. Si la `path' es un objeto de bytes (directa o indirectamente), el resultado será un objeto de bytes.

Esta función también puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

Cuando intente resolver una ruta que puede contener enlaces, use @ref{381,,realpath()} para manejar adecuadamente la recurrencia y las diferencias de plataforma.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.2: Se agregó soporte para enlaces simbólicos de Windows 6.0 (Vista).



Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} en Unix.



Distinto en la versión 3.8: Acepta un @ref{3f0,,path-like object} y un objeto de bytes en Windows.

Se agregó soporte para uniones de directorio y se modificó para retornar la ruta de sustitución (que generalmente incluye el prefijo @code{\\?\}) En lugar del campo opcional «nombre de impresión» que se retornó anteriormente.

@end deffn

@geindex remove() (en el módulo os)
@anchor{library/os os remove}@anchor{1163}
@deffn {Función} os.remove (path, *, dir_fd=None)

Remove (delete) the file `path'.  If `path' is a directory, an
@ref{4d5,,OSError} is raised.  Use @ref{1166,,rmdir()} to remove directories.
If the file does not exist, a @ref{f46,,FileNotFoundError} is raised.

Esta función puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

En Windows, intentar eliminar un archivo que está en uso provoca una excepción; en Unix, la entrada del directorio se elimina pero el almacenamiento asignado al archivo no está disponible hasta que el archivo original ya no esté en uso.

Esta función es semánticamente idéntica a @ref{1168,,unlink()}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.remove} con argumentos @code{ruta}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex removedirs() (en el módulo os)
@anchor{library/os os removedirs}@anchor{2b85}
@deffn {Función} os.removedirs (name)

@geindex directory;deleting

Eliminar directorios de forma recursiva. Funciona como @ref{1166,,rmdir()} excepto que, si el directorio hoja se elimina con éxito, @code{removeirs()} intenta eliminar sucesivamente cada directorio principal mencionado en `path' hasta que se genere un error (que se ignora, porque generalmente significa que un directorio padre no está vacío). Por ejemplo, @code{os.removedirs('foo/bar/baz')} primero eliminará el directorio @code{'foo/bar/baz'}, y luego eliminará @code{'foo/bar'} y @code{'foo'} si están vacíos. Genera @ref{4d5,,OSError} si el directorio hoja no se pudo eliminar con éxito.

Lanza un @ref{18c3,,evento de auditoría} @code{os.remove} con argumentos @code{ruta}, @code{dir_fd}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex rename() (en el módulo os)
@anchor{library/os os rename}@anchor{1164}
@deffn {Función} os.rename (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

Cambia el nombre del archivo o directorio `src' a `dst'. Si `dst' existe, la operación fallará con una subclase @ref{4d5,,OSError} en varios casos:

On Windows, if `dst' exists a @ref{109c,,FileExistsError} is always raised.
The operation may fail if `src' and `dst' are on different filesystems. Use
@ref{aed,,shutil.move()} to support moves to a different filesystem.

En Unix, si `src' es un archivo y `dst' es un directorio o viceversa, se generará un @ref{10d5,,IsADirectoryError} o un @ref{10d6,,NotADirectoryError} respectivamente. Si ambos son directorios y `dst' está vacío, `dst' se reemplazará silenciosamente. Si `dst' no es un directorio vacío, se genera un @ref{4d5,,OSError}. Si ambos son archivos, `dst' se reemplazará silenciosamente si el usuario tiene permiso. La operación puede fallar en algunos tipos de Unix si `src' y `dst' están en sistemas de archivos diferentes. Si tiene éxito, el cambio de nombre será una operación atómica (este es un requisito POSIX).

Esta función puede admitir la especificación de `src_dir_fd' o `dst_dir_fd' para proporcionar @ref{115d,,rutas relativas a los descriptores de directorio}.

Si desea sobrescribir multiplataforma del destino, use @ref{1165,,replace()}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.rename} con argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Distinto en la versión 3.3: Added the `src_dir_fd' and `dst_dir_fd' parameters.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `src' y `dst'.

@end deffn

@geindex renames() (en el módulo os)
@anchor{library/os os renames}@anchor{2b86}
@deffn {Función} os.renames (old, new)

Directorio recursivo o función de cambio de nombre de archivo. Funciona como @ref{1164,,rename()}, excepto que primero se intenta crear cualquier directorio intermedio necesario para que el nuevo nombre de ruta sea bueno. Después del cambio de nombre, los directorios correspondientes a los segmentos de ruta más a la derecha del nombre anterior se eliminarán usando @code{removeirs()}.

@cartouche
@quotation Nota 
Esta función puede fallar con la nueva estructura de directorios realizada si carece de los permisos necesarios para eliminar el directorio o archivo hoja.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{os.rename} con argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `old' y `new'.

@end deffn

@geindex replace() (en el módulo os)
@anchor{library/os os replace}@anchor{1165}
@deffn {Función} os.replace (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

Cambie el nombre del archivo o directorio `src' a `dst'. Si `dst' no es un directorio vacío, se generará @ref{4d5,,OSError}. Si `dst' existe y es un archivo, se reemplazará de forma silenciosa si el usuario tiene permiso. La operación puede fallar si `src' y `dst' están en sistemas de archivos diferentes. Si tiene éxito, el cambio de nombre será una operación atómica (este es un requisito POSIX).

Esta función puede admitir la especificación de `src_dir_fd' o `dst_dir_fd' para proporcionar @ref{115d,,rutas relativas a los descriptores de directorio}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.rename} con argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Added in version 3.3.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `src' y `dst'.

@end deffn

@geindex rmdir() (en el módulo os)
@anchor{library/os os rmdir}@anchor{1166}
@deffn {Función} os.rmdir (path, *, dir_fd=None)

Suprime (elimina) el directorio `path'. Si el directorio no existe o no está vacío, se genera un @ref{f46,,FileNotFoundError} o un @ref{4d5,,OSError} respectivamente. Para eliminar árboles de directorios completos, se puede utilizar @ref{1f9,,shutil.rmtree()}.

Esta función puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.rmdir} con argumentos @code{ruta}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex scandir() (en el módulo os)
@anchor{library/os os scandir}@anchor{1a2}
@deffn {Función} os.scandir (path='.')

Retorna un iterador de objetos @ref{1a1,,os.DirEntry} correspondientes a las entradas en el directorio dado por `path'. Las entradas se entregan en orden arbitrario, y las entradas especiales @code{'.'} Y @code{'..'} no están incluidas. Si un archivo es removido de o añadido al directorio después de crear el iterador, no se especifica si una entrada para el archivo será incluido.

El uso de @ref{1a2,,scandir()} en lugar de @ref{116c,,listdir()} puede aumentar significativamente el rendimiento del código que también necesita información de tipo de archivo o atributo de archivo, porque: los objetos @ref{1a1,,os.DirEntry} exponen esta información si el sistema operativo proporciona cuando escanea un directorio. Todos los métodos @ref{1a1,,os.DirEntry} pueden realizar una llamada al sistema, pero @ref{2b87,,is_dir()} y @ref{e0a,,is_file()} generalmente solo requieren una llamada al sistema para enlaces simbólicos; @ref{1700,,os.DirEntry.stat()} siempre requiere una llamada al sistema en Unix, pero solo requiere una para enlaces simbólicos en Windows.

`path' puede ser un @ref{3f0,,path-like object}. Si `path' es de tipo @code{bytes} (directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}), el tipo de @ref{2b88,,name} y los atributos @ref{1687,,path} de cada @ref{1a1,,os.DirEntry} serán @code{bytes}; en todas las demás circunstancias, serán del tipo @code{str}.

Esta función también puede admitir @ref{be4,,especificando un descriptor de archivo}; el descriptor de archivo debe hacer referencia a un directorio.

Lanza un @ref{18c3,,evento de auditoría} @code{os.scandir} con argumento @code{ruta}.

El iterador @ref{1a2,,scandir()} admite el protocolo @ref{675,,context manager} y tiene el siguiente método:

@geindex close() (método de os.scandir)
@anchor{library/os os scandir close}@anchor{d44}
@deffn {Método} scandir.close ()

Cierre el iterador y libere los recursos adquiridos.

Esto se llama automáticamente cuando el iterador se agota o se recolecta basura, o cuando ocurre un error durante la iteración. Sin embargo, es aconsejable llamarlo explícitamente o utilizar la palabra clave @ref{673,,with}.


Added in version 3.6.

@end deffn

El siguiente ejemplo muestra un uso simple de @ref{1a2,,scandir()} para mostrar todos los archivos (excepto los directorios) en la `path' dada que no comienzan con @code{'.'}. La llamada @code{entry.is_file()} generalmente no realizará una llamada adicional al sistema:

@example
with os.scandir(path) as it:
    for entry in it:
        if not entry.name.startswith('.') and entry.is_file():
            print(entry.name)
@end example

@cartouche
@quotation Nota 
En los sistemas basados ​​en Unix, @ref{1a2,,scandir()} usa las funciones opendir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/opendir.html} y readdir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/readdir_r.html} del sistema. En Windows, utiliza las funciones Win32 FindFirstFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364418(v=vs.85).aspx} y FindNextFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364428(v=vs.85).aspx}.
@end quotation
@end cartouche


Added in version 3.5.



Distinto en la versión 3.6: Added support for the @ref{675,,context manager} protocol and the
@ref{d44,,close()} method.  If a @ref{1a2,,scandir()} iterator is neither
exhausted nor explicitly closed a @ref{39d,,ResourceWarning} will be emitted
in its destructor.

La función acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.7: Soporte agregado para @ref{be4,,descriptores de archivo} en Unix.

@end deffn

@geindex DirEntry (clase en os)
@anchor{library/os os DirEntry}@anchor{1a1}
@deffn {Clase} os.DirEntry

Objeto generado por @ref{1a2,,scandir()} para exponer la ruta del archivo y otros atributos de archivo de una entrada de directorio.

@ref{1a2,,scandir()} proporcionará tanta información como sea posible sin hacer llamadas adicionales al sistema. Cuando se realiza una llamada al sistema @code{stat()} o @code{lstat()}, el objeto @code{os.DirEntry} almacenará en caché el resultado.

Las instancias @code{os.DirEntry} no están destinadas a ser almacenadas en estructuras de datos de larga duración; si sabe que los metadatos del archivo han cambiado o si ha transcurrido mucho tiempo desde la llamada @ref{1a2,,scandir()}, llame a @code{os.stat(entry.path)} para obtener información actualizada.

Debido a que los métodos @code{os.DirEntry} pueden hacer llamadas al sistema operativo, también pueden generar @ref{4d5,,OSError}. Si necesita un control muy preciso sobre los errores, puede detectar @ref{4d5,,OSError} cuando llame a uno de los métodos @code{os.DirEntry} y maneje según corresponda.

Para ser directamente utilizable como @ref{3f0,,path-like object}, @code{os.DirEntry} implementa la interfaz @ref{cd9,,PathLike}.

Los atributos y métodos en una instancia de @code{os.DirEntry} son los siguientes:

@geindex name (atributo de os.DirEntry)
@anchor{library/os os DirEntry name}@anchor{2b88}
@deffn {Atributo} name

El nombre de archivo base de la entrada, relativo al argumento @ref{1a2,,scandir()} `path'.

El atributo @ref{2b06,,name} será @code{bytes} si el argumento @ref{1a2,,scandir()} `path' es de tipo @code{bytes} y @code{str} de lo contrario. Utilice @ref{cdc,,fsdecode()} para decodificar los nombres de archivo de bytes.
@end deffn

@geindex path (atributo de os.DirEntry)
@anchor{library/os os DirEntry path}@anchor{1687}
@deffn {Atributo} path

El nombre completo de la ruta de entrada: equivalente a @code{os.path.join(scandir_path, entry.name)} donde `scandir_path' es el argumento @ref{1a2,,scandir()} `path'. La ruta solo es absoluta si el argumento @ref{1a2,,scandir()} `path' fue absoluto. Si el argumento @ref{1a2,,scandir()} `path' era un @ref{be4,,descriptor de archivo}, el atributo @ref{a2,,path} es el mismo que el atributo @ref{2b06,,name}.

El atributo @ref{a2,,path} será @code{bytes} si el argumento @ref{1a2,,scandir()} `path' es de tipo @code{bytes} y @code{str} de lo contrario. Utilice @ref{cdc,,fsdecode()} para decodificar los nombres de archivo de bytes.
@end deffn

@geindex inode() (método de os.DirEntry)
@anchor{library/os os DirEntry inode}@anchor{16e2}
@deffn {Método} inode ()

Retorna el número de inodo de la entrada.

El resultado se almacena en caché en el objeto @code{os.DirEntry}. Use @code{os.stat(entry.path, follow_symlinks=False).st_ino} para obtener información actualizada.

En la primera llamada no almacenada en caché, se requiere una llamada del sistema en Windows pero no en Unix.
@end deffn

@geindex is_dir() (método de os.DirEntry)
@anchor{library/os os DirEntry is_dir}@anchor{2b87}
@deffn {Método} is_dir (*, follow_symlinks=True)

Retorna @code{True} si esta entrada es un directorio o un enlace simbólico que apunta a un directorio; retorna @code{False} si la entrada es o apunta a cualquier otro tipo de archivo, o si ya no existe.

Si `follow_symlinks' es @code{False}, retorna @code{True} solo si esta entrada es un directorio (sin seguir los enlaces simbólicos); retorna @code{False} si la entrada es cualquier otro tipo de archivo o si ya no existe.

El resultado se almacena en caché en el objeto @code{os.DirEntry}, con un caché separado para `follow_symlinks' @code{True} y @code{False}. Llame a @ref{548,,os.stat()} junto con @ref{27da,,stat.S_ISDIR()} para obtener información actualizada.

En la primera llamada no almacenada en caché, no se requiere ninguna llamada al sistema en la mayoría de los casos. Específicamente, para los enlaces no simbólicos, ni Windows ni Unix requieren una llamada al sistema, excepto en ciertos sistemas de archivos Unix, como los sistemas de archivos de red, que retornan @code{dirent.d_type == DT_UNKNOWN}. Si la entrada es un enlace simbólico, se requerirá una llamada al sistema para seguir el enlace simbólico a menos que `follow_symlinks' sea @code{False}.

Este método puede generar @ref{4d5,,OSError}, como @ref{dc9,,PermissionError}, pero @ref{f46,,FileNotFoundError} se captura y no se genera.
@end deffn

@geindex is_file() (método de os.DirEntry)
@anchor{library/os os DirEntry is_file}@anchor{e0a}
@deffn {Método} is_file (*, follow_symlinks=True)

Retorna @code{True} si esta entrada es un archivo o un enlace simbólico que apunta a un archivo; retorna @code{False} si la entrada es o apunta a un directorio u otra entrada que no sea de archivo, o si ya no existe.

Si `follow_symlinks' es @code{False}, retorna @code{True} solo si esta entrada es un archivo (sin los siguientes enlaces simbólicos); retorna @code{False} si la entrada es un directorio u otra entrada que no sea de archivo, o si ya no existe.

El resultado se almacena en caché en el objeto @code{os.DirEntry}. El almacenamiento en caché, las llamadas realizadas al sistema y las excepciones generadas son las siguientes @ref{2b87,,is_dir()}.
@end deffn

@geindex is_symlink() (método de os.DirEntry)
@anchor{library/os os DirEntry is_symlink}@anchor{2b89}
@deffn {Método} is_symlink ()

Retorna @code{True} si esta entrada es un enlace simbólico (incluso si está roto); retorna @code{False} si la entrada apunta a un directorio o cualquier tipo de archivo, o si ya no existe.

El resultado se almacena en caché en el objeto @code{os.DirEntry}. Llame a @ref{a9e,,os.path.islink()} para obtener información actualizada.

En la primera llamada no almacenada en caché, no se requiere ninguna llamada al sistema en la mayoría de los casos. Específicamente, ni Windows ni Unix requieren una llamada al sistema, excepto en ciertos sistemas de archivos Unix, como los sistemas de archivos de red, que retornan @code{dirent.d_type == DT_UNKNOWN}.

Este método puede generar @ref{4d5,,OSError}, como @ref{dc9,,PermissionError}, pero @ref{f46,,FileNotFoundError} se captura y no se genera.
@end deffn

@geindex is_junction() (método de os.DirEntry)
@anchor{library/os os DirEntry is_junction}@anchor{544}
@deffn {Método} is_junction ()

Return @code{True} if this entry is a junction (even if broken);
return @code{False} if the entry points to a regular directory, any kind
of file, a symlink, or if it doesn’t exist anymore.

The result is cached on the @code{os.DirEntry} object. Call
@ref{54b,,os.path.isjunction()} to fetch up-to-date information.


Added in version 3.12.

@end deffn

@geindex stat() (método de os.DirEntry)
@anchor{library/os os DirEntry stat}@anchor{1700}
@deffn {Método} stat (*, follow_symlinks=True)

Retorna un objeto a @ref{14fd,,stat_result} para esta entrada. Este método sigue enlaces simbólicos por defecto; para crear un enlace simbólico agregue el argumento @code{follow_symlinks=False}.

En Unix, este método siempre requiere una llamada al sistema. En Windows, solo requiere una llamada al sistema si `follow_symlinks' es @code{True} y la entrada es un punto de análisis (por ejemplo, un enlace simbólico o una unión de directorio).

En Windows, los atributos @code{st_ino}, @code{st_dev} y @code{st_nlink} de @ref{14fd,,stat_result} siempre se establecen en cero. Llame a @ref{548,,os.stat()} para obtener estos atributos.

El resultado se almacena en caché en el objeto @code{os.DirEntry}, con un caché separado para `follow_symlinks' @code{True} y @code{False}. Llame a @ref{548,,os.stat()} para obtener información actualizada.
@end deffn

Note that there is a nice correspondence between several attributes
and methods of @code{os.DirEntry} and of @ref{19b,,pathlib.Path}.  In
particular, the @code{name} attribute has the same
meaning, as do the @code{is_dir()}, @code{is_file()}, @code{is_symlink()},
@code{is_junction()}, and @code{stat()} methods.


Added in version 3.5.



Distinto en la versión 3.6: Se agregó soporte para la interfaz @ref{cd9,,PathLike}. Se agregó soporte para rutas de @ref{325,,bytes} en Windows.



Distinto en la versión 3.12: The @code{st_ctime} attribute of a stat result is deprecated on Windows.
The file creation time is properly available as @code{st_birthtime}, and
in the future @code{st_ctime} may be changed to return zero or the
metadata change time, if available.

@end deffn

@geindex stat() (en el módulo os)
@anchor{library/os os stat}@anchor{548}
@deffn {Función} os.stat (path, *, dir_fd=None, follow_symlinks=True)

Obtener el estado de un archivo o un descriptor de archivo. Realice el equivalente de a llamada del sistema @code{stat()} en la ruta dada. `path' puede especificarse como una cadena o bytes, directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}, o como un descriptor de archivo abierto. Retorna un objeto @ref{14fd,,stat_result}.

Esta función normalmente sigue enlaces simbólicos; para crear un enlace simbólico agregue el argumento @code{follow_symlinks=False}, o use @ref{549,,lstat()}.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo} y @ref{115e,,no siguen enlaces simbólicos}.

En Windows, pasar @code{follow_symlinks=False} deshabilitará el seguimiento de todos los puntos de análisis sustitutos de nombre, que incluyen enlaces simbólicos y uniones de directorio. Se abrirán directamente otros tipos de puntos de análisis que no se parecen a los enlaces o que el sistema operativo no puede seguir. Al seguir una cadena de enlaces múltiples, esto puede dar como resultado que se retorna el enlace original en lugar del no enlace que impidió el recorrido completo. Para obtener resultados estadísticos para la ruta final en este caso, use la función @ref{381,,os.path.realpath()} para resolver el nombre de la ruta lo más posible y llame a @ref{549,,lstat()} en el resultado. Esto no se aplica a enlaces simbólicos o puntos de unión colgantes, lo que lanzará las excepciones habituales.

@geindex module;stat

El diseño de todos los módulos incorporados de Python dependientes del sistema operativo es tal que, mientras funcionalidad esté disponible, usará la misma interfaz; por ejemplo, la función @code{os.stat(path)} retorna estadísticas sobre la ruta (`path') en el mismo formato (lo que sucede originalmente con la interfaz POSIX).

@example
>>> import os
>>> statinfo = os.stat('somefile.txt')
>>> statinfo
os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026,
st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295,
st_mtime=1297230027, st_ctime=1297230027)
>>> statinfo.st_size
264
@end example


@subsubheading Ver también


@ref{e12,,fstat()} y funciones @ref{549,,lstat()}.



Distinto en la versión 3.3: Added the `dir_fd' and `follow_symlinks' parameters,
specifying a file descriptor instead of a path.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.8: En Windows, ahora se siguen todos los puntos de análisis que el sistema operativo puede resolver, y pasar @code{follow_symlinks=False} desactiva los siguientes puntos de análisis sustitutos de nombre. Si el sistema operativo alcanza un punto de análisis que no puede seguir, `stat' ahora retorna la información de la ruta original como si se hubiera especificado @code{follow_symlinks=False} en lugar de generar un error.

@end deffn

@geindex stat_result (clase en os)
@anchor{library/os os stat_result}@anchor{14fd}
@deffn {Clase} os.stat_result

Object whose attributes correspond roughly to the members of the
@code{stat} structure. It is used for the result of @ref{548,,os.stat()},
@ref{e12,,os.fstat()} and @ref{549,,os.lstat()}.

Atributos:

@geindex st_mode (atributo de os.stat_result)
@anchor{library/os os stat_result st_mode}@anchor{2b8a}
@deffn {Atributo} st_mode

Modo de archivo: tipo de archivo y bits de modo de archivo (permisos).
@end deffn

@geindex st_ino (atributo de os.stat_result)
@anchor{library/os os stat_result st_ino}@anchor{2b8b}
@deffn {Atributo} st_ino

Dependiendo de la plataforma, pero si no es cero, identifica de forma exclusiva el archivo para un valor dado de @code{st_dev}. Típicamente:


@itemize *

@item 
el número de inodo en Unix,

@item 
el índice del archivo@footnote{https://msdn.microsoft.com/en-us/library/aa363788} en Windows
@end itemize
@end deffn

@geindex st_dev (atributo de os.stat_result)
@anchor{library/os os stat_result st_dev}@anchor{2b8c}
@deffn {Atributo} st_dev

Identificador del dispositivo en el que reside este archivo.
@end deffn

@geindex st_nlink (atributo de os.stat_result)
@anchor{library/os os stat_result st_nlink}@anchor{2b8d}
@deffn {Atributo} st_nlink

Número de enlaces duros.
@end deffn

@geindex st_uid (atributo de os.stat_result)
@anchor{library/os os stat_result st_uid}@anchor{2b8e}
@deffn {Atributo} st_uid

Identificador de usuario del propietario del archivo.
@end deffn

@geindex st_gid (atributo de os.stat_result)
@anchor{library/os os stat_result st_gid}@anchor{2b8f}
@deffn {Atributo} st_gid

Identificador de grupo del propietario del archivo.
@end deffn

@geindex st_size (atributo de os.stat_result)
@anchor{library/os os stat_result st_size}@anchor{2b90}
@deffn {Atributo} st_size

Tamaño del archivo en bytes, si es un archivo normal o un enlace simbólico. El tamaño de un enlace simbólico es la longitud del nombre de ruta que contiene, sin un byte nulo de terminación.
@end deffn

Marcas de tiempo:

@geindex st_atime (atributo de os.stat_result)
@anchor{library/os os stat_result st_atime}@anchor{2b91}
@deffn {Atributo} st_atime

Tiempo de acceso más reciente expresado en segundos.
@end deffn

@geindex st_mtime (atributo de os.stat_result)
@anchor{library/os os stat_result st_mtime}@anchor{2a20}
@deffn {Atributo} st_mtime

Tiempo de modificación de contenido más reciente expresado en segundos.
@end deffn

@geindex st_ctime (atributo de os.stat_result)
@anchor{library/os os stat_result st_ctime}@anchor{2b92}
@deffn {Atributo} st_ctime

Time of most recent metadata change expressed in seconds.


Distinto en la versión 3.12: @code{st_ctime} is deprecated on Windows. Use @code{st_birthtime} for
the file creation time. In the future, @code{st_ctime} will contain
the time of the most recent metadata change, as for other platforms.

@end deffn

@geindex st_atime_ns (atributo de os.stat_result)
@anchor{library/os os stat_result st_atime_ns}@anchor{2b93}
@deffn {Atributo} st_atime_ns

Tiempo de acceso más reciente expresado en nanosegundos como un entero.


Added in version 3.3.

@end deffn

@geindex st_mtime_ns (atributo de os.stat_result)
@anchor{library/os os stat_result st_mtime_ns}@anchor{2b94}
@deffn {Atributo} st_mtime_ns

Hora de la modificación de contenido más reciente expresada en nanosegundos como un entero.


Added in version 3.3.

@end deffn

@geindex st_ctime_ns (atributo de os.stat_result)
@anchor{library/os os stat_result st_ctime_ns}@anchor{2b95}
@deffn {Atributo} st_ctime_ns

Time of most recent metadata change expressed in nanoseconds as an
integer.


Added in version 3.3.



Distinto en la versión 3.12: @code{st_ctime_ns} is deprecated on Windows. Use @code{st_birthtime_ns}
for the file creation time. In the future, @code{st_ctime} will contain
the time of the most recent metadata change, as for other platforms.

@end deffn

@geindex st_birthtime (atributo de os.stat_result)
@anchor{library/os os stat_result st_birthtime}@anchor{2b96}
@deffn {Atributo} st_birthtime

Time of file creation expressed in seconds. This attribute is not
always available, and may raise @ref{441,,AttributeError}.


Distinto en la versión 3.12: @code{st_birthtime} is now available on Windows.

@end deffn

@geindex st_birthtime_ns (atributo de os.stat_result)
@anchor{library/os os stat_result st_birthtime_ns}@anchor{2b97}
@deffn {Atributo} st_birthtime_ns

Time of file creation expressed in nanoseconds as an integer.
This attribute is not always available, and may raise
@ref{441,,AttributeError}.


Added in version 3.12.

@end deffn

@cartouche
@quotation Nota 
The exact meaning and resolution of the @ref{2b91,,st_atime},
@ref{2a20,,st_mtime}, @ref{2b92,,st_ctime} and @ref{2b96,,st_birthtime} attributes
depend on the operating system and the file system. For example, on
Windows systems using the FAT32 file systems, @ref{2a20,,st_mtime} has
2-second resolution, and @ref{2b91,,st_atime} has only 1-day resolution.
See your operating system documentation for details.

Similarly, although @ref{2b93,,st_atime_ns}, @ref{2b94,,st_mtime_ns},
@ref{2b95,,st_ctime_ns} and @ref{2b97,,st_birthtime_ns} are always expressed in
nanoseconds, many systems do not provide nanosecond precision.  On
systems that do provide nanosecond precision, the floating-point object
used to store @ref{2b91,,st_atime}, @ref{2a20,,st_mtime}, @ref{2b92,,st_ctime} and
@ref{2b96,,st_birthtime} cannot preserve all of it, and as such will be
slightly inexact. If you need the exact timestamps you should always use
@ref{2b93,,st_atime_ns}, @ref{2b94,,st_mtime_ns}, @ref{2b95,,st_ctime_ns} and
@ref{2b97,,st_birthtime_ns}.
@end quotation
@end cartouche

En algunos sistemas Unix (como Linux), los siguientes atributos también pueden estar disponibles:

@geindex st_blocks (atributo de os.stat_result)
@anchor{library/os os stat_result st_blocks}@anchor{2b98}
@deffn {Atributo} st_blocks

Número de bloques de 512 bytes asignados para el archivo. Esto puede ser más pequeño que @ref{2b90,,st_size} / 512 cuando el archivo tiene agujeros.
@end deffn

@geindex st_blksize (atributo de os.stat_result)
@anchor{library/os os stat_result st_blksize}@anchor{2b99}
@deffn {Atributo} st_blksize

Tamaño de bloque «preferido» para una eficiente E / S del sistema de archivos. Escribir en un archivo en fragmentos más pequeños puede causar una lectura-modificación-reescritura ineficiente.
@end deffn

@geindex st_rdev (atributo de os.stat_result)
@anchor{library/os os stat_result st_rdev}@anchor{2b9a}
@deffn {Atributo} st_rdev

Tipo de dispositivo si es un dispositivo inodo.
@end deffn

@geindex st_flags (atributo de os.stat_result)
@anchor{library/os os stat_result st_flags}@anchor{2b9b}
@deffn {Atributo} st_flags

Indicadores definidos por el usuario para el archivo.
@end deffn

En otros sistemas Unix (como FreeBSD), los siguientes atributos pueden estar disponibles (pero solo se pueden completar si la raíz intenta usarlos):

@geindex st_gen (atributo de os.stat_result)
@anchor{library/os os stat_result st_gen}@anchor{2b9c}
@deffn {Atributo} st_gen

Número de generación de archivos.
@end deffn

En Solaris y derivados, los siguientes atributos también pueden estar disponibles:

@geindex st_fstype (atributo de os.stat_result)
@anchor{library/os os stat_result st_fstype}@anchor{bec}
@deffn {Atributo} st_fstype

Cadena que identifica de forma exclusiva el tipo de sistema de archivos que contiene el archivo.
@end deffn

En los sistemas macOS, los siguientes atributos también pueden estar disponibles:

@geindex st_rsize (atributo de os.stat_result)
@anchor{library/os os stat_result st_rsize}@anchor{2b9d}
@deffn {Atributo} st_rsize

Tamaño real del archivo.
@end deffn

@geindex st_creator (atributo de os.stat_result)
@anchor{library/os os stat_result st_creator}@anchor{2b9e}
@deffn {Atributo} st_creator

Creador del archivo.
@end deffn

@geindex st_type (atributo de os.stat_result)
@anchor{library/os os stat_result st_type}@anchor{2b9f}
@deffn {Atributo} st_type

Tipo de archivo.
@end deffn

En los sistemas Windows, los siguientes atributos también están disponibles:

@geindex st_file_attributes (atributo de os.stat_result)
@anchor{library/os os stat_result st_file_attributes}@anchor{ebd}
@deffn {Atributo} st_file_attributes

Windows file attributes: @code{dwFileAttributes} member of the
@code{BY_HANDLE_FILE_INFORMATION} structure returned by
@code{GetFileInformationByHandle()}.
See the @code{FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE>}
constants in the @ref{d1,,stat} module.


Added in version 3.5.

@end deffn

@geindex st_reparse_tag (atributo de os.stat_result)
@anchor{library/os os stat_result st_reparse_tag}@anchor{2ba0}
@deffn {Atributo} st_reparse_tag

When @ref{ebd,,st_file_attributes} has the @ref{2827,,FILE_ATTRIBUTE_REPARSE_POINT}
set, this field contains the tag identifying the type of reparse point.
See the @ref{282c,,IO_REPARSE_TAG_*}
constants in the @ref{d1,,stat} module.
@end deffn

The standard module @ref{d1,,stat} defines functions and constants that are
useful for extracting information from a @code{stat} structure. (On
Windows, some items are filled with dummy values.)

For backward compatibility, a @ref{14fd,,stat_result} instance is also
accessible as a tuple of at least 10 integers giving the most important (and
portable) members of the @code{stat} structure, in the order
@ref{2b8a,,st_mode}, @ref{2b8b,,st_ino}, @ref{2b8c,,st_dev}, @ref{2b8d,,st_nlink},
@ref{2b8e,,st_uid}, @ref{2b8f,,st_gid}, @ref{2b90,,st_size}, @ref{2b91,,st_atime},
@ref{2a20,,st_mtime}, @ref{2b92,,st_ctime}. More items may be added at the end by
some implementations. For compatibility with older Python versions,
accessing @ref{14fd,,stat_result} as a tuple always returns integers.


Distinto en la versión 3.5: Windows ahora retorna el índice del archivo como @ref{2b8b,,st_ino} cuando está disponible.



Distinto en la versión 3.7: Se agregó el miembro @ref{bec,,st_fstype} a Solaris/derivados.



Distinto en la versión 3.8: Se agregó el miembro @ref{2ba0,,st_reparse_tag} en Windows.



Distinto en la versión 3.8: En Windows, el miembro @ref{2b8a,,st_mode} ahora identifica archivos especiales como @code{S_IFCHR}, @code{S_IFIFO} o @code{S_IFBLK} según corresponda.



Distinto en la versión 3.12: On Windows, @ref{2b92,,st_ctime} is deprecated. Eventually, it will
contain the last metadata change time, for consistency with other
platforms, but for now still contains creation time.
Use @ref{2b96,,st_birthtime} for the creation time.

On Windows, @ref{2b8b,,st_ino} may now be up to 128 bits, depending
on the file system. Previously it would not be above 64 bits, and
larger file identifiers would be arbitrarily packed.

On Windows, @ref{2b9a,,st_rdev} no longer returns a value. Previously
it would contain the same as @ref{2b8c,,st_dev}, which was incorrect.

Added the @ref{2b96,,st_birthtime} member on Windows.

@end deffn

@geindex statvfs() (en el módulo os)
@anchor{library/os os statvfs}@anchor{116e}
@deffn {Función} os.statvfs (path)

Perform a @code{statvfs()} system call on the given path.  The return value is
an object whose attributes describe the filesystem on the given path, and
correspond to the members of the @code{statvfs} structure, namely:
@code{f_bsize}, @code{f_frsize}, @code{f_blocks}, @code{f_bfree},
@code{f_bavail}, @code{f_files}, @code{f_ffree}, @code{f_favail},
@code{f_flag}, @code{f_namemax}, @code{f_fsid}.

Se definen dos constantes de nivel de módulo para: indicadores de bit del atributo @code{f_flag}: si @code{ST_RDONLY} está configurado, el sistema de archivos está montado de solo lectura, y si @code{ST_NOSUID} está configurado, el la semántica de los bits setuid/setgid está deshabilitada o no es compatible.

Se definen constantes de nivel de módulo adicionales para sistemas basados en GNU / glibc. Estos son @code{ST_NODEV} (no permitir el acceso a archivos especiales del dispositivo), @code{ST_NOEXEC} (no permitir la ejecución del programa), @code{ST_SYNCHRONOUS} (las escrituras se sincronizan a la vez), @code{ST_MANDLOCK} ( permitir bloqueos obligatorios en un FS), @code{ST_WRITE} (escribir en el archivo/directorio/enlace simbólico), @code{ST_APPEND} (archivo de solo agregado), @code{ST_IMMUTABLE} (archivo inmutable), @code{ST_NOATIME} (no actualiza los tiempos de acceso), @code{ST_NODIRATIME} (no actualiza los tiempos de acceso al directorio), @code{ST_RELATIME} (tiempo de actualización relativo a mtime/ctime).

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.2: Se agregaron las constantes @code{ST_RDONLY} y @code{ST_NOSUID}.



Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto.



Distinto en la versión 3.4: El @code{ST_NODEV}, @code{ST_NOEXEC}, @code{ST_SYNCHRONOUS}, @code{ST_MANDLOCK}, @code{ST_WRITE}, @code{ST_APPEND}, @code{ST_IMMUTABLE}, @code{ST_NOATIME}, @code{ST_NODIRATIME}, y @code{ST_RELATIME} se agregaron constantes.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.7: Added the @code{f_fsid} attribute.

@end deffn

@geindex supports_dir_fd (en el módulo os)
@anchor{library/os os supports_dir_fd}@anchor{116a}
@deffn {Dato} os.supports_dir_fd

A objeto @ref{67a,,set} que indica qué funciones en el módulo @ref{a1,,os} aceptan un descriptor de archivo abierto para su parámetro `dir_fd'. Las diferentes plataformas proporcionan características diferentes, y la funcionalidad subyacente que Python usa para implementar el parámetro `dir_fd' no está disponible en todas las plataformas que admite Python. En aras de la coherencia, las funciones que pueden admitir `dir_fd' siempre permiten especificar el parámetro, pero lanzarán una excepción si la funcionalidad se utiliza cuando no está disponible localmente. (Especificar @code{None} para `dir_fd' siempre es compatible con todas las plataformas).

Para verificar si una función particular acepta un descriptor de archivo abierto para su parámetro `dir_fd', use el operador @code{in} en @code{supports_dir_fd}. Como ejemplo, esta expresión se evalúa como @code{True} si @ref{548,,os.stat()} acepta descriptores de archivos abiertos para `dir_fd' en la plataforma local:

@example
os.stat in os.supports_dir_fd
@end example

Actualmente, los parámetros `dir_fd' solo funcionan en plataformas Unix; ninguno de ellos funciona en Windows.


Added in version 3.3.

@end deffn

@geindex supports_effective_ids (en el módulo os)
@anchor{library/os os supports_effective_ids}@anchor{1170}
@deffn {Dato} os.supports_effective_ids

Un objeto @ref{67a,,set} que indica si @ref{115f,,os.access()} permite especificar @code{True} para su parámetro `fective_ids' en la plataforma local. (Especificar @code{False} para `effective_id' siempre es compatible con todas las plataformas). Si la plataforma local lo admite, la colección contendrá @ref{115f,,os.access()}; de lo contrario estará vacío.

Esta expresión se evalúa como @code{True} si @ref{115f,,os.access()} admite @code{effective_id=True} en la plataforma local:

@example
os.access in os.supports_effective_ids
@end example

Actualmente, `effective_ids' solo es compatible con plataformas Unix; No funciona en Windows.


Added in version 3.3.

@end deffn

@geindex supports_fd (en el módulo os)
@anchor{library/os os supports_fd}@anchor{116f}
@deffn {Dato} os.supports_fd

A objeto @ref{67a,,set} que indica qué funciones en el módulo @ref{a1,,os} permiten especificar su parámetro `path' como un descriptor de archivo abierto en la plataforma local. Las diferentes plataformas proporcionan características diferentes, y la funcionalidad subyacente que Python utiliza para aceptar descriptores de archivos abiertos como argumentos `path' no está disponible en todas las plataformas que admite Python.

Para determinar si una función en particular permite especificar un descriptor de archivo abierto para su parámetro `path', use el operador @code{in} en @code{supports_fd}. Como ejemplo, esta expresión se evalúa como @code{True} si @ref{6ae,,os.chdir()} acepta descriptores de archivo abiertos para `path' en su plataforma local:

@example
os.chdir in os.supports_fd
@end example


Added in version 3.3.

@end deffn

@geindex supports_follow_symlinks (en el módulo os)
@anchor{library/os os supports_follow_symlinks}@anchor{2861}
@deffn {Dato} os.supports_follow_symlinks

Un objeto @ref{67a,,set} que indica qué funciones en el módulo @ref{a1,,os} aceptan @code{False} para su parámetro `follow_symlinks' en la plataforma local. Las diferentes plataformas proporcionan características diferentes, y la funcionalidad subyacente que Python usa para implementar `follow_symlinks' no está disponible en todas las plataformas que admite Python. En aras de la coherencia, las funciones que pueden admitir `follow_symlinks' siempre permiten especificar el parámetro, pero arrojarán una excepción si la funcionalidad se utiliza cuando no está disponible localmente. (Especificar @code{True} para `follow_symlinks' siempre se admite en todas las plataformas).

Para verificar si una función particular acepta @code{False} para su parámetro `follow_symlinks', use el operador @code{in} en @code{supports_follow_symlinks}. Como ejemplo, esta expresión se evalúa como @code{True} si puede especificar @code{follow_symlinks=False} al llamar a @ref{548,,os.stat()} en la plataforma local:

@example
os.stat in os.supports_follow_symlinks
@end example


Added in version 3.3.

@end deffn

@geindex symlink() (en el módulo os)
@anchor{library/os os symlink}@anchor{1167}
@deffn {Función} os.symlink (src, dst, target_is_directory=False, *, dir_fd=None)

Cree un enlace simbólico que apunte a `src' llamado `dst'.

En Windows, un enlace simbólico representa un archivo o un directorio, y no se transforma dinámicamente en el destino. Si el objetivo está presente, el tipo de enlace simbólico se creará para que coincida. De lo contrario, el enlace simbólico se creará como un directorio si `target_is_directory' es @code{True} o un enlace simbólico de archivo (el valor predeterminado) de lo contrario. En plataformas que no son de Windows, `target_is_directory' se ignora.

Esta función puede admitir @ref{115d,,rutas relativas a descriptores de directorio}.

@cartouche
@quotation Nota 
En las versiones más recientes de Windows 10, las cuentas sin privilegios pueden crear enlaces simbólicos si el Modo desarrollador está habilitado. Cuando el Modo desarrollador no está disponible / habilitado, se requiere el privilegio `SeCreateSymbolicLinkPrivilege', o el proceso debe ejecutarse como administrador.

@ref{4d5,,OSError} se lanza cuando un usuario sin privilegios llama a la función.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{os.symlink} con argumentos @code{src}, @code{dst}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix, Windows.

The function is limited on WASI, see @ref{17e8,,Plataformas WebAssembly} for more
information.


Distinto en la versión 3.2: Se agregó soporte para enlaces simbólicos de Windows 6.0 (Vista).



Distinto en la versión 3.3: Added the `dir_fd' parameter, and now allow `target_is_directory'
on non-Windows platforms.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `src' y `dst'.



Distinto en la versión 3.8: Se agregó soporte para enlaces simbólicos sin elevar en Windows con el modo de desarrollador.

@end deffn

@geindex sync() (en el módulo os)
@anchor{library/os os sync}@anchor{1184}
@deffn {Función} os.sync ()

Forzar la escritura de todo en el disco.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex truncate() (en el módulo os)
@anchor{library/os os truncate}@anchor{ec1}
@deffn {Función} os.truncate (path, length)

Trunca el archivo correspondiente a `path', para que tenga como máximo `length' bytes de tamaño.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.truncate} con argumentos @code{path}, @code{length}.

@ref{1d5a,,Availability}: Unix, Windows.


Added in version 3.3.



Distinto en la versión 3.5: Se agregó soporte para Windows



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex unlink() (en el módulo os)
@anchor{library/os os unlink}@anchor{1168}
@deffn {Función} os.unlink (path, *, dir_fd=None)

Elimina (elimine) el archivo `path'. Esta función es semánticamente idéntica a @ref{1163,,remove()}; El nombre @code{unlink} es su nombre tradicional de Unix. Consulte la documentación de @ref{1163,,remove()} para obtener más información.

Lanza un @ref{18c3,,evento de auditoría} @code{os.remove} con argumentos @code{ruta}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó el parámetro `dir_fd'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex utime() (en el módulo os)
@anchor{library/os os utime}@anchor{1169}
@deffn {Función} os.utime (path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)

Establece el acceso y los tiempos modificados del archivo especificado por `path'.

@ref{1169,,utime()} toma dos parámetros opcionales, `times' y `ns'. Estos especifican los tiempos establecidos en `path' y se utilizan de la siguiente manera:


@itemize -

@item 
Si se especifica `ns', debe ser una tupla de 2 de la forma @code{(atime_ns, mtime_ns)} donde cada miembro es un int que expresa nanosegundos.

@item 
Si `times' no es @code{None}, debe ser una 2-tupla de la forma @code{(atime, mtime)} donde cada miembro es un int o flotante que expresa segundos.

@item 
Si `times' es @code{None} y `ns' no está especificado, esto es equivalente a especificar @code{ns=(atime_ns, mtime_ns)} donde ambas horas son la hora actual.
@end itemize

Es un error especificar tuplas para `times' y `ns'.

Tenga en cuenta que es posible que las horas exactas que establezca aquí no se devuelvan en una llamada @ref{548,,stat()} posterior, dependiendo de la resolución con la que su sistema operativo registre las horas de acceso y modificación; ver @ref{548,,stat()}. La mejor manera de conservar las horas exactas es usar los campos `st_atime_ns' y `st_mtime_ns' del objeto de resultado @ref{548,,os.stat()} con el parámetro `ns' a @ref{1169,,utime()}.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo}, @ref{115d,,rutas relativas a los descriptores de directorio} y @ref{115e,,no seguir enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.utime} con argumentos @code{path}, @code{times}, @code{ns}, @code{dir_fd}.


Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto, y los parámetros `dir_fd', `follow_symlinks' y `ns'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex walk() (en el módulo os)
@anchor{library/os os walk}@anchor{551}
@deffn {Función} os.walk (top, topdown=True, onerror=None, followlinks=False)

@geindex directory;walking
@geindex directory;traversal

Genere los nombres de archivo en un árbol de directorios recorriendo el árbol de arriba hacia abajo o de abajo hacia arriba. Para cada directorio en el árbol enraizado en el directorio `top' (incluido `top'), produce una tupla de 3 tuplas @code{(dirpath, dirnames, filenames)}.

`dirpath' es una cadena, la ruta al directorio. `dirnames' es una lista de los nombres de los subdirectorios en `dirpath' (incluidos los enlaces simbólicos a los directorios y excluyendo @code{'.'} y @code{'..'}). `filenames' es una lista de los nombres de los archivos que no son de directorio en `dirpath'. Tenga en cuenta que los nombres de las listas no contienen componentes de ruta. Para obtener una ruta completa (que comienza con `top') a un archivo o directorio en `dirpath', ejecute @code{os.path.join(dirpath, name)}. Que las listas estén ordenadas o no depende del sistema de archivos. Si un archivo se elimina o se agrega al directorio `dirpath' durante la generación de las listas, no se especifica si se incluirá un nombre para ese archivo.

Si el argumento opcional `topdown' es @code{True} o no se especifica, el triple para un directorio se genera antes de triplicarse para cualquiera de sus subdirectorios (los directorios se generan de arriba hacia abajo). Si `topdown' es @code{False}, el triple para un directorio se genera después de los triples para todos sus subdirectorios (los directorios se generan de abajo hacia arriba). No importa el valor de `topdown', la lista de subdirectorios se recupera antes de que se generen las tuplas para el directorio y sus subdirectorios.

Cuando `topdown' es @code{True}, la persona que llama puede modificar la lista `dirnames' en su lugar (quizás usando @ref{17ae,,del} o asignación de corte) y @ref{551,,walk()} solo se repetirá en los subdirectorios cuyos nombres permanecen en `dirnames'; Esto se puede utilizar para podar la búsqueda, imponer un orden específico de visitas o incluso para informar @ref{551,,walk()} sobre los directorios que la persona que llama crea o renombra antes de que se reanude @ref{551,,walk()} nuevamente. La modificación de `dirnames' cuando `topdown' es @code{False} no tiene ningún efecto en el comportamiento de la caminata, porque en el modo ascendente los directorios en `dirnames' se generan antes de que se genere `dirpath'.

Por defecto, los errores de la llamada @ref{1a2,,scandir()} se ignoran. Si se especifica el argumento opcional `onerror', debería ser una función; se llamará con un argumento, una instancia @ref{4d5,,OSError}. Puede informar el error para continuar con la caminata, o generar la excepción para abortar la caminata. Tenga en cuenta que el nombre de archivo está disponible como el atributo @code{filename} del objeto de excepción.

Por defecto, @ref{551,,walk()} no entrará en enlaces simbólicos que se resuelven en directorios. Establece `followlinks' en @code{True} para visitar los directorios señalados por los enlaces simbólicos, en los sistemas que los admiten.

@cartouche
@quotation Nota 
Tenga en cuenta que establecer `followlinks' en @code{True} puede conducir a una recursión infinita si un enlace apunta a un directorio padre de sí mismo. @ref{551,,walk()} no realiza un seguimiento de los directorios que ya visitó.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Si pasa un nombre de ruta relativo, no cambie el directorio de trabajo actual entre las reanudaciones de @ref{551,,walk()}. @ref{551,,walk()} nunca cambia el directorio actual, y supone que la persona que llama tampoco.
@end quotation
@end cartouche

Este ejemplo muestra el número de bytes que toman los archivos que no son de directorio en cada directorio bajo el directorio inicial, excepto que no se ve en ningún subdirectorio CVS:

@example
import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/email'):
    print(root, "consumes", end=" ")
    print(sum(getsize(join(root, name)) for name in files), end=" ")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories
@end example

En el siguiente ejemplo (implementación simple de @ref{1f9,,shutil.rmtree()}), recorrer el árbol de abajo hacia arriba es esencial, @ref{1166,,rmdir()} no permite eliminar un directorio antes de que el directorio esté vacío:

@example
# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
import os
for root, dirs, files in os.walk(top, topdown=False):
    for name in files:
        os.remove(os.path.join(root, name))
    for name in dirs:
        os.rmdir(os.path.join(root, name))
os.rmdir(top)
@end example

Lanza un @ref{18c3,,evento de auditoría} @code{os.spawn} con argumentos @code{top}, @code{topdown}, @code{onerror}, @code{followlinks}.


Distinto en la versión 3.5: Esta función ahora llama @ref{1a2,,os.scandir()} en lugar de @ref{116c,,os.listdir()}, lo que lo hace más rápido al reducir el número de llamadas a @ref{548,,os.stat()}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex fwalk() (en el módulo os)
@anchor{library/os os fwalk}@anchor{be3}
@deffn {Función} os.fwalk (top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

@geindex directory;walking
@geindex directory;traversal

Esto se comporta exactamente como @ref{551,,walk()}, excepto que produce 4 tuplas @code{(dirpath, dirnames, filenames, dirfd)}, y admite @code{dir_fd}.

`dirpath', `dirnames' y `filenames' son idénticos a @ref{551,,walk()} output, y `dirfd' es un descriptor de archivo que se refiere al directorio `dirpath'.

Esta función siempre admite @ref{115d,,rutas relativas a descriptores de directorio} y @ref{115e,,no siguen enlaces simbólicos}. Sin embargo, tenga en cuenta que, a diferencia de otras funciones, el valor predeterminado @ref{be3,,fwalk()} para `follow_symlinks' es @code{False}.

@cartouche
@quotation Nota 
Dado que @ref{be3,,fwalk()} produce descriptores de archivo, estos solo son válidos hasta el siguiente paso de iteración, por lo que debe duplicarlos (por ejemplo, con @ref{19e6,,dup()}) si desea mantenerlos más tiempo.
@end quotation
@end cartouche

Este ejemplo muestra el número de bytes que toman los archivos que no son de directorio en cada directorio bajo el directorio inicial, excepto que no se ve en ningún subdirectorio CVS:

@example
import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
    print(root, "consumes", end="")
    print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
          end="")
    print("bytes in", len(files), "non-directory files")
    if 'CVS' in dirs:
        dirs.remove('CVS')  # don't visit CVS directories
@end example

En el siguiente ejemplo, recorrer el árbol de abajo hacia arriba es esencial: @ref{1166,,rmdir()} no permite eliminar un directorio antes de que el directorio esté vacío:

@example
# Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION:  This is dangerous!  For example, if top == '/', it
# could delete all your disk files.
import os
for root, dirs, files, rootfd in os.fwalk(top, topdown=False):
    for name in files:
        os.unlink(name, dir_fd=rootfd)
    for name in dirs:
        os.rmdir(name, dir_fd=rootfd)
@end example

Lanza un @ref{18c3,,evento de auditoría} @code{os.chown} con argumentos @code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks}, @code{dir_fd}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Distinto en la versión 3.7: Se agregó soporte para rutas de acceso @ref{325,,bytes}.

@end deffn

@geindex memfd_create() (en el módulo os)
@anchor{library/os os memfd_create}@anchor{a9d}
@deffn {Función} os.memfd_create (name[, flags=os.MFD_CLOEXEC])

Cree un archivo anónimo y retorna un descriptor de archivo que se refiera a él. `flags' debe ser una de las constantes @code{os.MFD_*} disponibles en el sistema (o una combinación ORed bit a bit de ellas). Por defecto, el nuevo descriptor de archivo es @ref{f7c,,no heredable}.

El nombre proporcionado en `name' se utiliza como nombre de archivo y se mostrará como el destino del enlace simbólico correspondiente en el directorio @code{/proc/self/fd/}. El nombre que se muestra siempre tiene el prefijo @code{memfd:} y solo sirve para fines de depuración. Los nombres no afectan el comportamiento del descriptor de archivo y, como tal, varios archivos pueden tener el mismo nombre sin efectos secundarios.

@ref{1d5a,,Availability}: Linux >= 3.17 with glibc >= 2.27.


Added in version 3.8.

@end deffn

@geindex MFD_CLOEXEC (en el módulo os)
@geindex MFD_ALLOW_SEALING (en el módulo os)
@geindex MFD_HUGETLB (en el módulo os)
@geindex MFD_HUGE_SHIFT (en el módulo os)
@geindex MFD_HUGE_MASK (en el módulo os)
@geindex MFD_HUGE_64KB (en el módulo os)
@geindex MFD_HUGE_512KB (en el módulo os)
@geindex MFD_HUGE_1MB (en el módulo os)
@geindex MFD_HUGE_2MB (en el módulo os)
@geindex MFD_HUGE_8MB (en el módulo os)
@geindex MFD_HUGE_16MB (en el módulo os)
@geindex MFD_HUGE_32MB (en el módulo os)
@geindex MFD_HUGE_256MB (en el módulo os)
@geindex MFD_HUGE_512MB (en el módulo os)
@geindex MFD_HUGE_1GB (en el módulo os)
@geindex MFD_HUGE_2GB (en el módulo os)
@geindex MFD_HUGE_16GB (en el módulo os)
@anchor{library/os os MFD_CLOEXEC}@anchor{2ba1}
@deffn {Dato} os.MFD_CLOEXEC
@anchor{library/os os MFD_ALLOW_SEALING}@anchor{2ba2}
@deffnx {Dato} os.MFD_ALLOW_SEALING
@anchor{library/os os MFD_HUGETLB}@anchor{2ba3}
@deffnx {Dato} os.MFD_HUGETLB
@anchor{library/os os MFD_HUGE_SHIFT}@anchor{2ba4}
@deffnx {Dato} os.MFD_HUGE_SHIFT
@anchor{library/os os MFD_HUGE_MASK}@anchor{2ba5}
@deffnx {Dato} os.MFD_HUGE_MASK
@anchor{library/os os MFD_HUGE_64KB}@anchor{2ba6}
@deffnx {Dato} os.MFD_HUGE_64KB
@anchor{library/os os MFD_HUGE_512KB}@anchor{2ba7}
@deffnx {Dato} os.MFD_HUGE_512KB
@anchor{library/os os MFD_HUGE_1MB}@anchor{2ba8}
@deffnx {Dato} os.MFD_HUGE_1MB
@anchor{library/os os MFD_HUGE_2MB}@anchor{2ba9}
@deffnx {Dato} os.MFD_HUGE_2MB
@anchor{library/os os MFD_HUGE_8MB}@anchor{2baa}
@deffnx {Dato} os.MFD_HUGE_8MB
@anchor{library/os os MFD_HUGE_16MB}@anchor{2bab}
@deffnx {Dato} os.MFD_HUGE_16MB
@anchor{library/os os MFD_HUGE_32MB}@anchor{2bac}
@deffnx {Dato} os.MFD_HUGE_32MB
@anchor{library/os os MFD_HUGE_256MB}@anchor{2bad}
@deffnx {Dato} os.MFD_HUGE_256MB
@anchor{library/os os MFD_HUGE_512MB}@anchor{2bae}
@deffnx {Dato} os.MFD_HUGE_512MB
@anchor{library/os os MFD_HUGE_1GB}@anchor{2baf}
@deffnx {Dato} os.MFD_HUGE_1GB
@anchor{library/os os MFD_HUGE_2GB}@anchor{2bb0}
@deffnx {Dato} os.MFD_HUGE_2GB
@anchor{library/os os MFD_HUGE_16GB}@anchor{2bb1}
@deffnx {Dato} os.MFD_HUGE_16GB

Estas flags se pueden pasar a @ref{a9d,,memfd_create()}.

@ref{1d5a,,Availability}: Linux >= 3.17 with glibc >= 2.27

Las banderas @code{MFD_HUGE*} solo están disponibles desde Linux 4.14.


Added in version 3.8.

@end deffn

@geindex eventfd() (en el módulo os)
@anchor{library/os os eventfd}@anchor{8af}
@deffn {Función} os.eventfd (initval[, flags=os.EFD_CLOEXEC])

Crea y retorna un descriptor de archivo de eventos. Los descriptores de archivo admiten @ref{e1b,,read()} y @ref{e21,,write()} sin procesar con un tamaño de búfer de 8, @ref{e26,,select()}, @ref{2bb2,,poll()} y similares. Consulte la página de manual @code{eventfd(2)@footnote{https://manpages.debian.org/eventfd(2)}} para obtener más información. De forma predeterminada, el nuevo descriptor de archivo @ref{f7c,,no es heredable}.

`initval' is the initial value of the event counter. The initial value
must be a 32 bit unsigned integer. Please note that the initial value is
limited to a 32 bit unsigned int although the event counter is an unsigned
64 bit integer with a maximum value of 2@w{^64}-2.

`flags' se puede construir a partir de @ref{17d5,,EFD_CLOEXEC}, @ref{17d6,,EFD_NONBLOCK} y @ref{17d7,,EFD_SEMAPHORE}.

Si se especifica @ref{17d7,,EFD_SEMAPHORE} y el contador de eventos no es cero, @ref{2bb3,,eventfd_read()} retorna 1 y reduce el contador en uno.

Si no se especifica @ref{17d7,,EFD_SEMAPHORE} y el contador de eventos no es cero, @ref{2bb3,,eventfd_read()} retorna el valor actual del contador de eventos y restablece el contador a cero.

Si el contador de eventos es cero y no se especifica @ref{17d6,,EFD_NONBLOCK}, @ref{2bb3,,eventfd_read()} se bloquea.

@ref{2bb4,,eventfd_write()} incrementa el contador de eventos. Escribe bloques si la operación de escritura incrementaría el contador a un valor mayor que @w{^64}-2.

El diseño de todos los módulos incorporados de Python dependientes del sistema operativo es tal que, mientras funcionalidad esté disponible, usará la misma interfaz; por ejemplo, la función @code{os.stat(path)} retorna estadísticas sobre la ruta (`path') en el mismo formato (lo que sucede originalmente con la interfaz POSIX).

@example
import os

# semaphore with start value '1'
fd = os.eventfd(1, os.EFD_SEMAPHORE | os.EFC_CLOEXEC)
try:
    # acquire semaphore
    v = os.eventfd_read(fd)
    try:
        do_work()
    finally:
        # release semaphore
        os.eventfd_write(fd, v)
finally:
    os.close(fd)
@end example

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.10.

@end deffn

@geindex eventfd_read() (en el módulo os)
@anchor{library/os os eventfd_read}@anchor{2bb3}
@deffn {Función} os.eventfd_read (fd)

Lee el valor de un descriptor de archivo @ref{8af,,eventfd()} y retorna un int sin signo de 64 bits. La función no verifica que `fd' sea un @ref{8af,,eventfd()}.

@ref{1d5a,,Availability}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex eventfd_write() (en el módulo os)
@anchor{library/os os eventfd_write}@anchor{2bb4}
@deffn {Función} os.eventfd_write (fd, value)

Agregue valor a un descriptor de archivo @ref{8af,,eventfd()}. `value' debe ser un int sin signo de 64 bits. La función no verifica que `fd' sea un @ref{8af,,eventfd()}.

@ref{1d5a,,Availability}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_CLOEXEC (en el módulo os)
@anchor{library/os os EFD_CLOEXEC}@anchor{17d5}
@deffn {Dato} os.EFD_CLOEXEC

Establezca el indicador close-on-exec para el nuevo descriptor de archivo @ref{8af,,eventfd()}.

@ref{1d5a,,Availability}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_NONBLOCK (en el módulo os)
@anchor{library/os os EFD_NONBLOCK}@anchor{17d6}
@deffn {Dato} os.EFD_NONBLOCK

Establezca el indicador de estado @ref{ec0,,O_NONBLOCK} para el nuevo descriptor de archivo @ref{8af,,eventfd()}.

@ref{1d5a,,Availability}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_SEMAPHORE (en el módulo os)
@anchor{library/os os EFD_SEMAPHORE}@anchor{17d7}
@deffn {Dato} os.EFD_SEMAPHORE

Provide semaphore-like semantics for reads from an @ref{8af,,eventfd()} file
descriptor. On read the internal counter is decremented by one.

@ref{1d5a,,Availability}: Linux >= 2.6.30


Added in version 3.10.

@end deffn

@menu
* Timer File Descriptors:: 
* Atributos extendidos de Linux:: 

@end menu

@node Timer File Descriptors,Atributos extendidos de Linux,,Archivos y directorios
@anchor{library/os os-timerfd}@anchor{2bf}@anchor{library/os timer-file-descriptors}@anchor{2bb5}
@subsubsection Timer File Descriptors



Added in version 3.13.


These functions provide support for Linux’s `timer file descriptor' API.
Naturally, they are all only available on Linux.

@geindex timerfd_create() (en el módulo os)
@anchor{library/os os timerfd_create}@anchor{36e}
@deffn {Función} os.timerfd_create (clockid, /, *, flags=0)

Create and return a timer file descriptor (`timerfd').

The file descriptor returned by @ref{36e,,timerfd_create()} supports:


@itemize -

@item 
@ref{e1b,,read()}

@item 
@ref{e26,,select()}

@item 
@ref{2bb2,,poll()}
@end itemize

The file descriptor’s @ref{e1b,,read()} method can be called with a buffer size
of 8. If the timer has already expired one or more times, @ref{e1b,,read()}
returns the number of expirations with the host’s endianness, which may be
converted to an @ref{1f0,,int} by @code{int.from_bytes(x, byteorder=sys.byteorder)}.

@ref{e26,,select()} and @ref{2bb2,,poll()} can be used to wait until
timer expires and the file descriptor is readable.

`clockid' must be a valid @ref{2bb6,,clock ID},
as defined in the @ref{ee,,time} module:


@itemize -

@item 
@ref{73b,,time.CLOCK_REALTIME}

@item 
@ref{73a,,time.CLOCK_MONOTONIC}

@item 
@ref{c16,,time.CLOCK_BOOTTIME} (Since Linux 3.15 for timerfd_create)
@end itemize

If `clockid' is @ref{73b,,time.CLOCK_REALTIME}, a settable system-wide
real-time clock is used. If system clock is changed, timer setting need
to be updated. To cancel timer when system clock is changed, see
@ref{376,,TFD_TIMER_CANCEL_ON_SET}.

If `clockid' is @ref{73a,,time.CLOCK_MONOTONIC}, a non-settable monotonically
increasing clock is used. Even if the system clock is changed, the timer
setting will not be affected.

If `clockid' is @ref{c16,,time.CLOCK_BOOTTIME}, same as @ref{73a,,time.CLOCK_MONOTONIC}
except it includes any time that the system is suspended.

The file descriptor’s behaviour can be modified by specifying a `flags' value.
Any of the following variables may used, combined using bitwise OR
(the @code{|} operator):


@itemize -

@item 
@ref{373,,TFD_NONBLOCK}

@item 
@ref{374,,TFD_CLOEXEC}
@end itemize

If @ref{373,,TFD_NONBLOCK} is not set as a flag, @ref{e1b,,read()} blocks until
the timer expires. If it is set as a flag, @ref{e1b,,read()} doesn’t block, but
If there hasn’t been an expiration since the last call to read,
@ref{e1b,,read()} raises @ref{4d5,,OSError} with @code{errno} is set to
@ref{22a1,,errno.EAGAIN}.

@ref{374,,TFD_CLOEXEC} is always set by Python automatically.

The file descriptor must be closed with @ref{bfc,,os.close()} when it is no
longer needed, or else the file descriptor will be leaked.


@subsubheading Ver también


The @code{timerfd_create(2)@footnote{https://manpages.debian.org/timerfd_create(2)}} man page.


@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_settime() (en el módulo os)
@anchor{library/os os timerfd_settime}@anchor{36f}
@deffn {Función} os.timerfd_settime (fd, /, *, flags=flags, initial=0.0, interval=0.0)

Alter a timer file descriptor’s internal timer.
This function operates the same interval timer as @ref{370,,timerfd_settime_ns()}.

`fd' must be a valid timer file descriptor.

The timer’s behaviour can be modified by specifying a `flags' value.
Any of the following variables may used, combined using bitwise OR
(the @code{|} operator):


@itemize -

@item 
@ref{375,,TFD_TIMER_ABSTIME}

@item 
@ref{376,,TFD_TIMER_CANCEL_ON_SET}
@end itemize

The timer is disabled by setting `initial' to zero (@code{0}).
If `initial' is equal to or greater than zero, the timer is enabled.
If `initial' is less than zero, it raises an @ref{4d5,,OSError} exception
with @code{errno} set to @ref{19f8,,errno.EINVAL}

By default the timer will fire when `initial' seconds have elapsed.
(If `initial' is zero, timer will fire immediately.)

However, if the @ref{375,,TFD_TIMER_ABSTIME} flag is set,
the timer will fire when the timer’s clock
(set by `clockid' in @ref{36e,,timerfd_create()}) reaches `initial' seconds.

The timer’s interval is set by the `interval' @ref{153,,float}.
If `interval' is zero, the timer only fires once, on the initial expiration.
If `interval' is greater than zero, the timer fires every time `interval'
seconds have elapsed since the previous expiration.
If `interval' is less than zero, it raises @ref{4d5,,OSError} with @code{errno}
set to @ref{19f8,,errno.EINVAL}

If the @ref{376,,TFD_TIMER_CANCEL_ON_SET} flag is set along with
@ref{375,,TFD_TIMER_ABSTIME} and the clock for this timer is
@ref{73b,,time.CLOCK_REALTIME}, the timer is marked as cancelable if the
real-time clock is changed discontinuously. Reading the descriptor is
aborted with the error ECANCELED.

Linux manages system clock as UTC. A daylight-savings time transition is
done by changing time offset only and doesn’t cause discontinuous system
clock change.

Discontinuous system clock change will be caused by the following events:


@itemize -

@item 
@code{settimeofday}

@item 
@code{clock_settime}

@item 
set the system date and time by @code{date} command
@end itemize

Return a two-item tuple of (@code{next_expiration}, @code{interval}) from
the previous timer state, before this function executed.


@subsubheading Ver también


@code{timerfd_create(2)@footnote{https://manpages.debian.org/timerfd_create(2)}}, @code{timerfd_settime(2)@footnote{https://manpages.debian.org/timerfd_settime(2)}},
@code{settimeofday(2)@footnote{https://manpages.debian.org/settimeofday(2)}}, @code{clock_settime(2)@footnote{https://manpages.debian.org/clock_settime(2)}},
and @code{date(1)@footnote{https://manpages.debian.org/date(1)}}.


@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_settime_ns() (en el módulo os)
@anchor{library/os os timerfd_settime_ns}@anchor{370}
@deffn {Función} os.timerfd_settime_ns (fd, /, *, flags=0, initial=0, interval=0)

Similar to @ref{36f,,timerfd_settime()}, but use time as nanoseconds.
This function operates the same interval timer as @ref{36f,,timerfd_settime()}.

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_gettime() (en el módulo os)
@anchor{library/os os timerfd_gettime}@anchor{371}
@deffn {Función} os.timerfd_gettime (fd, /)

Return a two-item tuple of floats (@code{next_expiration}, @code{interval}).

@code{next_expiration} denotes the relative time until next the timer next fires,
regardless of if the @ref{375,,TFD_TIMER_ABSTIME} flag is set.

@code{interval} denotes the timer’s interval.
If zero, the timer will only fire once, after @code{next_expiration} seconds
have elapsed.


@subsubheading Ver también


@code{timerfd_gettime(2)@footnote{https://manpages.debian.org/timerfd_gettime(2)}}


@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_gettime_ns() (en el módulo os)
@anchor{library/os os timerfd_gettime_ns}@anchor{372}
@deffn {Función} os.timerfd_gettime_ns (fd, /)

Similar to @ref{371,,timerfd_gettime()}, but return time as nanoseconds.

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_NONBLOCK (en el módulo os)
@anchor{library/os os TFD_NONBLOCK}@anchor{373}
@deffn {Dato} os.TFD_NONBLOCK

A flag for the @ref{36e,,timerfd_create()} function,
which sets the @ref{ec0,,O_NONBLOCK} status flag for the new timer file
descriptor. If @ref{373,,TFD_NONBLOCK} is not set as a flag, @ref{e1b,,read()} blocks.

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_CLOEXEC (en el módulo os)
@anchor{library/os os TFD_CLOEXEC}@anchor{374}
@deffn {Dato} os.TFD_CLOEXEC

A flag for the @ref{36e,,timerfd_create()} function,
If @ref{374,,TFD_CLOEXEC} is set as a flag, set close-on-exec flag for new file
descriptor.

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_TIMER_ABSTIME (en el módulo os)
@anchor{library/os os TFD_TIMER_ABSTIME}@anchor{375}
@deffn {Dato} os.TFD_TIMER_ABSTIME

A flag for the @ref{36f,,timerfd_settime()} and @ref{370,,timerfd_settime_ns()} functions.
If this flag is set, `initial' is interpreted as an absolute value on the
timer’s clock (in UTC seconds or nanoseconds since the Unix Epoch).

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_TIMER_CANCEL_ON_SET (en el módulo os)
@anchor{library/os os TFD_TIMER_CANCEL_ON_SET}@anchor{376}
@deffn {Dato} os.TFD_TIMER_CANCEL_ON_SET

A flag for the @ref{36f,,timerfd_settime()} and @ref{370,,timerfd_settime_ns()}
functions along with @ref{375,,TFD_TIMER_ABSTIME}.
The timer is cancelled when the time of the underlying clock changes
discontinuously.

@ref{1d5a,,Availability}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@node Atributos extendidos de Linux,,Timer File Descriptors,Archivos y directorios
@anchor{library/os linux-extended-attributes}@anchor{2bb7}
@subsubsection Atributos extendidos de Linux



Added in version 3.3.


Estas funciones están disponibles solo en Linux.

@geindex getxattr() (en el módulo os)
@anchor{library/os os getxattr}@anchor{1176}
@deffn {Función} os.getxattr (path, attribute, *, follow_symlinks=True)

Retorna el valor del atributo del sistema de archivos extendido `atrribute' para `path'. `attribute' puede ser bytes o str (directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}). Si es str, se codifica con la codificación del sistema de archivos.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo} y @ref{115e,,no siguen enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.getxattr} con argumentos @code{path}, @code{atributo}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `path*y *attribute'.

@end deffn

@geindex listxattr() (en el módulo os)
@anchor{library/os os listxattr}@anchor{1177}
@deffn {Función} os.listxattr (path=None, *, follow_symlinks=True)

Retorna una lista de los atributos del sistema de archivos extendido en `path'. Los atributos en la lista se representan como cadenas decodificadas con la codificación del sistema de archivos. Si `path' es @code{None}, @ref{1177,,listxattr()} examinará el directorio actual.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo} y @ref{115e,,no siguen enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.listxattr} con el argumento @code{path}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex removexattr() (en el módulo os)
@anchor{library/os os removexattr}@anchor{1178}
@deffn {Función} os.removexattr (path, attribute, *, follow_symlinks=True)

Elimina el atributo extendido del sistema de archivos `attribute' de `path'. `attribute' debe ser bytes o str (directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}). Si es una cadena, está codificada con @ref{5dd,,filesystem encoding and error handler}.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo} y @ref{115e,,no siguen enlaces simbólicos}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.removexattr} con argumentos @code{path}, @code{attribute}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `path*y *attribute'.

@end deffn

@geindex setxattr() (en el módulo os)
@anchor{library/os os setxattr}@anchor{1179}
@deffn {Función} os.setxattr (path, attribute, value, flags=0, *, follow_symlinks=True)

Establece el atributo del sistema de archivos extendido `attribute' en `path' en `value'. `attribute' debe ser un bytes o una cadena sin NUL incrustados (directa o indirectamente a través de la interfaz @ref{cd9,,PathLike}). Si es una cadena, está codificado con @ref{5dd,,filesystem encoding and error handler}. `flags' puede ser @ref{2bb8,,XATTR_REPLACE} o @ref{2bb9,,XATTR_CREATE}. Si se proporciona @ref{2bb8,,XATTR_REPLACE} y el atributo no existe, se lanzará @code{ENODATA}. Si se proporciona @ref{2bb9,,XATTR_CREATE} y el atributo ya existe, no se creará el atributo y se lanza @code{EEXISTS}.

Esta función puede soportar @ref{be4,,especificando un descriptor de archivo} y @ref{115e,,no siguen enlaces simbólicos}.

@cartouche
@quotation Nota 
Un error en las versiones de kernel de Linux anteriores a 2.6.39 hizo que el argumento de las flags se ignorara en algunos sistemas de archivos.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{os.setxattr} con argumentos @code{path}, @code{attribute}, @code{value}, @code{flags}.


Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object} para `path*y *attribute'.

@end deffn

@geindex XATTR_SIZE_MAX (en el módulo os)
@anchor{library/os os XATTR_SIZE_MAX}@anchor{2bba}
@deffn {Dato} os.XATTR_SIZE_MAX

El tamaño máximo que puede tener el valor de un atributo extendido. Actualmente, esto es 64 KiB en Linux.
@end deffn

@geindex XATTR_CREATE (en el módulo os)
@anchor{library/os os XATTR_CREATE}@anchor{2bb9}
@deffn {Dato} os.XATTR_CREATE

Este es un valor posible para el argumento flags en @ref{1179,,setxattr()}. Indica que la operación debe crear un atributo.
@end deffn

@geindex XATTR_REPLACE (en el módulo os)
@anchor{library/os os XATTR_REPLACE}@anchor{2bb8}
@deffn {Dato} os.XATTR_REPLACE

Este es un valor posible para el argumento flags en @ref{1179,,setxattr()}. Indica que la operación debe reemplazar un atributo existente.
@end deffn

@node Gestión de proceso,Interfaz al planificador,Archivos y directorios,os — Miscellaneous operating system interfaces
@anchor{library/os os-process}@anchor{2bbb}@anchor{library/os process-management}@anchor{2bbc}
@subsubsection Gestión de proceso


Estas funciones pueden usarse para crear y administrar procesos.

Las varias funciones @ref{2bbd,,exec *} toman una lista de argumentos para el nuevo programa cargado en el proceso. En cada caso, el primero de estos argumentos se pasa al nuevo programa como su propio nombre en lugar de como un argumento que un usuario puede haber escrito en una línea de comando. Para el programador C, este es el @code{argv[0]} pasado a un programa @code{main()}. Por ejemplo, @code{os.execv('/bin/echo', ['foo', 'bar'])} solo imprimirá @code{bar} en la salida estándar; @code{foo} parecerá ignorado.

@geindex abort() (en el módulo os)
@anchor{library/os os abort}@anchor{2bbe}
@deffn {Función} os.abort ()

Genere una señal @code{SIGABRT} para el proceso actual. En Unix, el comportamiento predeterminado es producir un volcado de núcleo; en Windows, el proceso retorna inmediatamente un código de salida de @code{3}. Tenga en cuenta que llamar a esta función no llamará al controlador de señal Python registrado para @code{SIGABRT} con @ref{11a6,,signal.signal()}.
@end deffn

@geindex add_dll_directory() (en el módulo os)
@anchor{library/os os add_dll_directory}@anchor{a7c}
@deffn {Función} os.add_dll_directory (path)

Agregue una ruta a la ruta de búsqueda de DLL.

Esta ruta de búsqueda se utiliza al resolver dependencias para módulos de extensión importados (el propio módulo se resuelve mediante @ref{27e,,sys.path}) y también mediante @ref{2b,,ctypes}.

Elimina el directorio llamando a `close()' en el objeto retornado o utilizándolo en una @ref{673,,with} instrucción.

Consulte la documentación de Microsoft@footnote{https://msdn.microsoft.com/44228cf2-6306-466c-8f16-f513cd3ba8b5} para obtener más información sobre cómo se cargan las DLL.

Lanza un @ref{18c3,,evento de auditoría} @code{os.add_dll_directory} con el argumento @code{path}.

@ref{1d5a,,Availability}: Windows.


Added in version 3.8: Las versiones anteriores de CPython resolverían las DLL utilizando el comportamiento predeterminado para el proceso actual. Esto condujo a inconsistencias, como solo a veces buscar 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} o el directorio de trabajo actual, y las funciones del sistema operativo como @code{AddDllDirectory} no tienen ningún efecto.

En 3.8, las dos formas principales en que se cargan las DLL ahora anulan explícitamente el comportamiento de todo el proceso para garantizar la coherencia. Ver el @ref{b29,,notas de portabilidad} para obtener información sobre la actualización de bibliotecas.

@end deffn

@geindex execl() (en el módulo os)
@geindex execle() (en el módulo os)
@geindex execlp() (en el módulo os)
@geindex execlpe() (en el módulo os)
@geindex execv() (en el módulo os)
@geindex execve() (en el módulo os)
@geindex execvp() (en el módulo os)
@geindex execvpe() (en el módulo os)
@anchor{library/os os execl}@anchor{2bbd}
@deffn {Función} os.execl (path, arg0, arg1, ...)
@anchor{library/os os execle}@anchor{2bbf}
@deffnx {Función} os.execle (path, arg0, arg1, ..., env)
@anchor{library/os os execlp}@anchor{2bc0}
@deffnx {Función} os.execlp (file, arg0, arg1, ...)
@anchor{library/os os execlpe}@anchor{2bc1}
@deffnx {Función} os.execlpe (file, arg0, arg1, ..., env)
@anchor{library/os os execv}@anchor{2b1d}
@deffnx {Función} os.execv (path, args)
@anchor{library/os os execve}@anchor{116b}
@deffnx {Función} os.execve (path, args, env)
@anchor{library/os os execvp}@anchor{2bc2}
@deffnx {Función} os.execvp (file, args)
@anchor{library/os os execvpe}@anchor{2bc3}
@deffnx {Función} os.execvpe (file, args, env)

Todas estas funciones ejecutan un nuevo programa, reemplazando el proceso actual; No vuelven. En Unix, el nuevo ejecutable se carga en el proceso actual y tendrá la misma identificación de proceso que la persona que llama. Los errores se informarán como excepciones @ref{4d5,,OSError}.

El proceso actual se reemplaza inmediatamente. Los objetos de archivo abierto y los descriptores no se vacían, por lo que si puede haber datos almacenados en estos archivos abiertos, debe limpiarlos usando @code{sys.stdout.flush()} o @ref{e14,,os.fsync()} antes de llamar a @ref{2bbd,,exec*} función.

The «l» and «v» variants of the @ref{2bbd,,exec*} functions differ in how
command-line arguments are passed.  The «l» variants are perhaps the easiest
to work with if the number of parameters is fixed when the code is written; the
individual parameters simply become additional parameters to the @code{execl*()}
functions.  The «v» variants are good when the number of parameters is
variable, with the arguments being passed in a list or tuple as the `args'
parameter.  In either case, the arguments to the child process should start with
the name of the command being run, but this is not enforced.

The variants which include a «p» near the end (@ref{2bc0,,execlp()},
@ref{2bc1,,execlpe()}, @ref{2bc2,,execvp()}, and @ref{2bc3,,execvpe()}) will use the
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} environment variable to locate the program `file'.  When the
environment is being replaced (using one of the @ref{2bbd,,exec*e} variants,
discussed in the next paragraph), the new environment is used as the source of
the 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} variable. The other variants, @ref{2bbd,,execl()}, @ref{2bbf,,execle()},
@ref{2b1d,,execv()}, and @ref{116b,,execve()}, will not use the 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} variable to
locate the executable; `path' must contain an appropriate absolute or relative
path. Relative paths must include at least one slash, even on Windows, as
plain names will not be resolved.

Para @ref{2bbf,,execle()}, @ref{2bc1,,execlpe()}, @ref{116b,,execve()} y @ref{2bc3,,execvpe()} (tenga en cuenta que todo esto termina en «e»), el parámetro `env' debe ser un mapeo que se utiliza para definir las variables de entorno para el nuevo proceso (se utilizan en lugar del entorno del proceso actual); las funciones @ref{2bbd,,execl()}, @ref{2bc0,,execlp()}, @ref{2b1d,,execv()} y @ref{2bc2,,execvp()} hacen que el nuevo proceso herede el entorno del proceso actual.

Para @ref{116b,,execve()} en algunas plataformas, `path' también puede especificarse como un descriptor de archivo abierto. Es posible que esta funcionalidad no sea compatible con su plataforma; puede verificar si está disponible o no usando @ref{116f,,os.supports_fd}. Si no está disponible, su uso lanzará un @ref{384,,NotImplementedError}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.exec} con argumentos @code{ruta}, @code{args}, @code{env}.

@ref{1d5a,,Availability}: Unix, Windows, not WASI, not Android, not iOS.


Distinto en la versión 3.3: Se agregó soporte para especificar `path' como un descriptor de archivo abierto para @ref{116b,,execve()}.



Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.

@end deffn

@geindex _exit() (en el módulo os)
@anchor{library/os os _exit}@anchor{229b}
@deffn {Función} os._exit (n)

Salga del proceso con el estado `n', sin llamar a los controladores de limpieza, vaciar los buffers stdio, etc.

@cartouche
@quotation Nota 
The standard way to exit is @ref{13b0,,sys.exit(n)}.  @code{_exit()} should
normally only be used in the child process after a @ref{2ff,,fork()}.
@end quotation
@end cartouche
@end deffn

Los siguientes códigos de salida están definidos y se pueden usar con @ref{229b,,_exit()}, aunque no son obligatorios. Por lo general, se usan para programas del sistema escritos en Python, como el programa de entrega de comandos externos de un servidor de correo.

@cartouche
@quotation Nota 
Es posible que algunos de estos no estén disponibles en todas las plataformas Unix, ya que hay alguna variación. Estas constantes se definen donde están definidas por la plataforma subyacente.
@end quotation
@end cartouche

@geindex EX_OK (en el módulo os)
@anchor{library/os os EX_OK}@anchor{2bc4}
@deffn {Dato} os.EX_OK

Código de salida que significa que no ocurrió ningún error. Puede tomarse del valor definido de @code{EXIT_SUCCESS} en algunas plataformas. Generalmente tiene un valor de cero.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex EX_USAGE (en el módulo os)
@anchor{library/os os EX_USAGE}@anchor{2bc5}
@deffn {Dato} os.EX_USAGE

Código de salida que significa que el comando se usó incorrectamente, como cuando se da un número incorrecto de argumentos.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_DATAERR (en el módulo os)
@anchor{library/os os EX_DATAERR}@anchor{2bc6}
@deffn {Dato} os.EX_DATAERR

Código de salida que significa que los datos de entrada eran incorrectos.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_NOINPUT (en el módulo os)
@anchor{library/os os EX_NOINPUT}@anchor{2bc7}
@deffn {Dato} os.EX_NOINPUT

Código de salida que significa que no existía un archivo de entrada o que no era legible.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_NOUSER (en el módulo os)
@anchor{library/os os EX_NOUSER}@anchor{2bc8}
@deffn {Dato} os.EX_NOUSER

Código de salida que significa que un usuario especificado no existía.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_NOHOST (en el módulo os)
@anchor{library/os os EX_NOHOST}@anchor{2bc9}
@deffn {Dato} os.EX_NOHOST

Código de salida que significa que no existía un host especificado.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_UNAVAILABLE (en el módulo os)
@anchor{library/os os EX_UNAVAILABLE}@anchor{2bca}
@deffn {Dato} os.EX_UNAVAILABLE

Código de salida que significa que un servicio requerido no está disponible.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_SOFTWARE (en el módulo os)
@anchor{library/os os EX_SOFTWARE}@anchor{2bcb}
@deffn {Dato} os.EX_SOFTWARE

Código de salida que significa que se detectó un error interno de software.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_OSERR (en el módulo os)
@anchor{library/os os EX_OSERR}@anchor{2bcc}
@deffn {Dato} os.EX_OSERR

Código de salida que significa que se detectó un error del sistema operativo, como la imposibilidad de bifurcar o crear una tubería.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_OSFILE (en el módulo os)
@anchor{library/os os EX_OSFILE}@anchor{2bcd}
@deffn {Dato} os.EX_OSFILE

Código de salida que significa que algunos archivos del sistema no existían, no podían abrirse o tenían algún otro tipo de error.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_CANTCREAT (en el módulo os)
@anchor{library/os os EX_CANTCREAT}@anchor{2bce}
@deffn {Dato} os.EX_CANTCREAT

Código de salida que significa que no se pudo crear un archivo de salida especificado por el usuario.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_IOERR (en el módulo os)
@anchor{library/os os EX_IOERR}@anchor{2bcf}
@deffn {Dato} os.EX_IOERR

Código de salida que significa que se produjo un error al realizar E / S en algún archivo.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_TEMPFAIL (en el módulo os)
@anchor{library/os os EX_TEMPFAIL}@anchor{2bd0}
@deffn {Dato} os.EX_TEMPFAIL

Código de salida que significa que ocurrió una falla temporal. Esto indica algo que puede no ser realmente un error, como una conexión de red que no se pudo realizar durante una operación recuperable.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_PROTOCOL (en el módulo os)
@anchor{library/os os EX_PROTOCOL}@anchor{2bd1}
@deffn {Dato} os.EX_PROTOCOL

Código de salida que significa que un intercambio de protocolo fue ilegal, inválido o no se entendió.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_NOPERM (en el módulo os)
@anchor{library/os os EX_NOPERM}@anchor{2bd2}
@deffn {Dato} os.EX_NOPERM

Código de salida que significa que no había permisos suficientes para realizar la operación (pero no para problemas del sistema de archivos).

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_CONFIG (en el módulo os)
@anchor{library/os os EX_CONFIG}@anchor{2bd3}
@deffn {Dato} os.EX_CONFIG

Código de salida que significa que se produjo algún tipo de error de configuración.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex EX_NOTFOUND (en el módulo os)
@anchor{library/os os EX_NOTFOUND}@anchor{2bd4}
@deffn {Dato} os.EX_NOTFOUND

Código de salida que significa algo así como «no se encontró una entrada».

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex fork() (en el módulo os)
@anchor{library/os os fork}@anchor{2ff}
@deffn {Función} os.fork ()

Bifurcar un proceso hijo. Retorna @code{0} en el niño y la identificación del proceso del niño en el padre. Si se produce un error se genera @ref{4d5,,OSError}.

Tenga en cuenta que algunas plataformas que incluyen FreeBSD &lt;= 6.3 y Cygwin tienen problemas conocidos al usar @code{fork()} desde un hilo.

Lanza un @ref{18c3,,evento de auditoría} @code{os.fork} sin argumentos.

@cartouche
@quotation Advertencia 
If you use TLS sockets in an application calling @code{fork()}, see
the warning in the @ref{d0,,ssl} documentation.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using @ref{10b,,urllib.request}.
@end quotation
@end cartouche


Distinto en la versión 3.8: Llamar a @code{fork()} en un subinterpretador ya no es compatible (@ref{1e5,,RuntimeError} está activado).



Distinto en la versión 3.12: If Python is able to detect that your process has multiple
threads, @ref{2ff,,os.fork()} now raises a @ref{1da,,DeprecationWarning}.

We chose to surface this as a warning, when detectable, to better
inform developers of a design problem that the POSIX platform
specifically notes as not supported. Even in code that
`appears' to work, it has never been safe to mix threading with
@ref{2ff,,os.fork()} on POSIX platforms. The CPython runtime itself has
always made API calls that are not safe for use in the child
process when threads existed in the parent (such as @code{malloc} and
@code{free}).

Users of macOS or users of libc or malloc implementations other
than those typically found in glibc to date are among those
already more likely to experience deadlocks running such code.

See this discussion on fork being incompatible with threads@footnote{https://discuss.python.org/t/33555}
for technical details of why we’re surfacing this longstanding
platform compatibility problem to developers.


@ref{1d5a,,Availability}: POSIX, not WASI, not Android, not iOS.
@end deffn

@geindex forkpty() (en el módulo os)
@anchor{library/os os forkpty}@anchor{300}
@deffn {Función} os.forkpty ()

Bifurca un proceso hijo, usando un nuevo pseudo-terminal como terminal de control del niño. Retorna un par de @code{(pid, fd)}, donde `pid' es @code{0} en el elemento secundario, la identificación del proceso del elemento secundario nuevo en el elemento primario y `fd' es el descriptor de archivo del final maestro de El pseudo-terminal. Para un enfoque más portátil, use el módulo @ref{b1,,pty}. Si se produce un error se genera @ref{4d5,,OSError}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.forkpty} sin argumentos.

@cartouche
@quotation Advertencia 
On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using @ref{10b,,urllib.request}.
@end quotation
@end cartouche


Distinto en la versión 3.8: Llamar a @code{forkpty()} en un subinterpretador ya no es compatible (@ref{1e5,,RuntimeError} está activado).



Distinto en la versión 3.12: If Python is able to detect that your process has multiple
threads, this now raises a @ref{1da,,DeprecationWarning}. See the
longer explanation on @ref{2ff,,os.fork()}.


@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex kill() (en el módulo os)
@anchor{library/os os kill}@anchor{13c7}
@deffn {Función} os.kill (pid, sig, /)

@geindex process;killing
@geindex process;signalling

Enviar señal `sig' al proceso `pid'. Las constantes para las señales específicas disponibles en la plataforma host se definen en el módulo @ref{c6,,signal}.

Windows: The @ref{13c8,,signal.CTRL_C_EVENT} and
@ref{13c9,,signal.CTRL_BREAK_EVENT} signals are special signals which can
only be sent to console processes which share a common console window,
e.g., some subprocesses. Any other value for `sig' will cause the process
to be unconditionally killed by the TerminateProcess API, and the exit code
will be set to `sig'.

Ver también @ref{11a3,,signal.pthread_kill()}.

Lanza un @ref{18c3,,evento de auditoría} @code{os.kill} con argumentos @code{pid}, @code{sig}.

@ref{1d5a,,Availability}: Unix, Windows, not WASI, not iOS.


Distinto en la versión 3.2: Se agregó soporte para Windows.

@end deffn

@geindex killpg() (en el módulo os)
@anchor{library/os os killpg}@anchor{19df}
@deffn {Función} os.killpg (pgid, sig, /)

@geindex process;killing
@geindex process;signalling

Envíe la señal `sig' al grupo de procesos `pgid'.

Lanza un @ref{18c3,,evento de auditoría} @code{os.killpg} con argumentos @code{pgid}, @code{sig}.

@ref{1d5a,,Availability}: Unix, not WASI, not iOS.
@end deffn

@geindex nice() (en el módulo os)
@anchor{library/os os nice}@anchor{1173}
@deffn {Función} os.nice (increment, /)

Agregue `increment' a la «simpatía» del proceso. Retorna la nueva amabilidad.

@ref{1d5a,,Availability}: Unix, not WASI.
@end deffn

@geindex pidfd_open() (en el módulo os)
@anchor{library/os os pidfd_open}@anchor{524}
@deffn {Función} os.pidfd_open (pid, flags=0)

Return a file descriptor referring to the process `pid' with `flags' set.
This descriptor can be used to perform process management without races
and signals.

Ver la página manual de @code{pidfd_open(2)@footnote{https://manpages.debian.org/pidfd_open(2)}} para mas detalles.

@ref{1d5a,,Availability}: Linux >= 5.3, Android >= @ref{c12,,build-time} API level 31


Added in version 3.9.


@geindex PIDFD_NONBLOCK (en el módulo os)
@anchor{library/os os PIDFD_NONBLOCK}@anchor{543}
@deffn {Dato} os.PIDFD_NONBLOCK

This flag indicates that the file descriptor will be non-blocking.
If the process referred to by the file descriptor has not yet terminated,
then an attempt to wait on the file descriptor using @code{waitid(2)@footnote{https://manpages.debian.org/waitid(2)}}
will immediately return the error @ref{22a1,,EAGAIN} rather than blocking.
@end deffn

@ref{1d5a,,Availability}: Linux >= 5.10


Added in version 3.12.

@end deffn

@geindex plock() (en el módulo os)
@anchor{library/os os plock}@anchor{2bd5}
@deffn {Función} os.plock (op, /)

Bloquee segmentos del programa en la memoria. El valor de `op' (definido en @code{<sys/lock.h>}) determina qué segmentos están bloqueados.

@ref{1d5a,,Availability}: Unix, not WASI, not iOS.
@end deffn

@geindex popen() (en el módulo os)
@anchor{library/os os popen}@anchor{1c5}
@deffn {Función} os.popen (cmd, mode='r', buffering=-1)

Abre una tubería hacia o desde el comando `cmd'. El valor retornado es un objeto de archivo abierto conectado a la canalización, que se puede leer o escribir dependiendo de si `mode' es @code{'r'} (predeterminado) o @code{'w'}. El argumento `buffering' tiene el mismo significado que el argumento correspondiente a la función integrada @ref{1be,,open()}. El objeto de archivo retornado lee o escribe cadenas de texto en lugar de bytes.

El método @code{close} retorna @ref{716,,None} si el subproceso salió correctamente, o el código de retorno del subproceso si hubo un error. En los sistemas POSIX, si el código de retorno es positivo, representa el valor de retorno del proceso desplazado a la izquierda en un byte. Si el código de retorno es negativo, el proceso fue terminado por la señal dada por el valor negado del código de retorno. (Por ejemplo, el valor de retorno podría ser @code{- signal.SIGKILL} si se eliminó el subproceso). En los sistemas Windows, el valor de retorno contiene el código de retorno entero firmado del proceso secundario.

En Unix, @ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el resultado del método @code{close} (estado de salida) en un código de salida si es que no es @code{None}. En Windows, el resultado del método @code{close} es directamente el código de salida (o @code{None}).

Esto se implementa usando @ref{301,,subprocess.Popen}; consulte la documentación de esa clase para obtener formas más potentes de administrar y comunicarse con subprocesos.

@ref{1d5a,,Availability}: not WASI, not Android, not iOS.

@cartouche
@quotation Nota 
El @ref{6f7,,Python UTF-8 Mode} afecta las codificaciones utilizadas para `cmd' y el contenido de la canalización.

@ref{1c5,,popen()} es un contenedor simple alrededor de @ref{301,,subprocess.Popen}. Use @ref{301,,subprocess.Popen} o @ref{c0e,,subprocess.run()} para controlar opciones como codificaciones.
@end quotation
@end cartouche


Obsoleto desde la versión 3.14: The function is @ref{1c4,,soft deprecated} and should no longer be used to
write new code. The @ref{d6,,subprocess} module is recommended instead.

@end deffn

@geindex posix_spawn() (en el módulo os)
@anchor{library/os os posix_spawn}@anchor{37d}
@deffn {Función} os.posix_spawn (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

Wraps the @code{posix_spawn()} C library API for use from Python.

La mayoría de los usuarios deberían usar @ref{c0e,,subprocess.run()} en lugar de @ref{37d,,posix_spawn()}.

The positional-only arguments `path', `args', and `env' are similar to
@ref{116b,,execve()}. `env' is allowed to be @code{None}, in which case current
process” environment is used.

El parámetro `path' es la ruta al archivo ejecutable. La `path' debe contener un directorio. Utilice @ref{1a36,,posix_spawnp()} para pasar un archivo ejecutable sin directorio.

El argumento `file_actions' puede ser una secuencia de tuplas que describen acciones para tomar descriptores de archivo específicos en el proceso secundario entre los pasos de implementación de la biblioteca C @code{fork()} y @code{exec()}. El primer elemento de cada tupla debe ser uno de los tres indicadores de tipo que se enumeran a continuación y que describen los elementos de tupla restantes:

@geindex POSIX_SPAWN_OPEN (en el módulo os)
@anchor{library/os os POSIX_SPAWN_OPEN}@anchor{2bd6}
@deffn {Dato} os.POSIX_SPAWN_OPEN

(@code{os.POSIX_SPAWN_OPEN}, `fd', `path', `flags', `mode')

Realiza @code{os.dup2(os.open(path, flags, mode), fd)}.
@end deffn

@geindex POSIX_SPAWN_CLOSE (en el módulo os)
@anchor{library/os os POSIX_SPAWN_CLOSE}@anchor{2bd7}
@deffn {Dato} os.POSIX_SPAWN_CLOSE

(@code{os.POSIX_SPAWN_CLOSE}, `fd')

Realiza @code{os.close(fd)}.
@end deffn

@geindex POSIX_SPAWN_DUP2 (en el módulo os)
@anchor{library/os os POSIX_SPAWN_DUP2}@anchor{2bd8}
@deffn {Dato} os.POSIX_SPAWN_DUP2

(@code{os.POSIX_SPAWN_DUP2}, `fd', `new_fd')

Realiza @code{os.dup2(fd, new_fd)}.
@end deffn

@geindex POSIX_SPAWN_CLOSEFROM (en el módulo os)
@anchor{library/os os POSIX_SPAWN_CLOSEFROM}@anchor{37e}
@deffn {Dato} os.POSIX_SPAWN_CLOSEFROM

(@code{os.POSIX_SPAWN_CLOSEFROM}, `fd')

Performs @code{os.closerange(fd, INF)}.
@end deffn

These tuples correspond to the C library
@code{posix_spawn_file_actions_addopen()},
@code{posix_spawn_file_actions_addclose()},
@code{posix_spawn_file_actions_adddup2()}, and
@code{posix_spawn_file_actions_addclosefrom_np()} API calls used to prepare
for the @code{posix_spawn()} call itself.

The `setpgroup' argument will set the process group of the child to the value
specified. If the value specified is 0, the child’s process group ID will be
made the same as its process ID. If the value of `setpgroup' is not set, the
child will inherit the parent’s process group ID. This argument corresponds
to the C library @code{POSIX_SPAWN_SETPGROUP} flag.

If the `resetids' argument is @code{True} it will reset the effective UID and
GID of the child to the real UID and GID of the parent process. If the
argument is @code{False}, then the child retains the effective UID and GID of
the parent. In either case, if the set-user-ID and set-group-ID permission
bits are enabled on the executable file, their effect will override the
setting of the effective UID and GID. This argument corresponds to the C
library @code{POSIX_SPAWN_RESETIDS} flag.

If the `setsid' argument is @code{True}, it will create a new session ID
for @code{posix_spawn}. `setsid' requires @code{POSIX_SPAWN_SETSID}
or @code{POSIX_SPAWN_SETSID_NP} flag. Otherwise, @ref{384,,NotImplementedError}
is raised.

The `setsigmask' argument will set the signal mask to the signal set
specified. If the parameter is not used, then the child inherits the
parent’s signal mask. This argument corresponds to the C library
@code{POSIX_SPAWN_SETSIGMASK} flag.

The `sigdef' argument will reset the disposition of all signals in the set
specified. This argument corresponds to the C library
@code{POSIX_SPAWN_SETSIGDEF} flag.

The `scheduler' argument must be a tuple containing the (optional) scheduler
policy and an instance of @ref{15a4,,sched_param} with the scheduler parameters.
A value of @code{None} in the place of the scheduler policy indicates that is
not being provided. This argument is a combination of the C library
@code{POSIX_SPAWN_SETSCHEDPARAM} and @code{POSIX_SPAWN_SETSCHEDULER}
flags.

Lanza un @ref{18c3,,evento de auditoría} @code{os.posix_spawn} con argumentos @code{ruta}, @code{argv}, @code{env}.


Added in version 3.8.



Distinto en la versión 3.13: `env' parameter accepts @code{None}.
@code{os.POSIX_SPAWN_CLOSEFROM} is available on platforms where
@code{posix_spawn_file_actions_addclosefrom_np()} exists.


@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex posix_spawnp() (en el módulo os)
@anchor{library/os os posix_spawnp}@anchor{1a36}
@deffn {Función} os.posix_spawnp (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

Wraps the @code{posix_spawnp()} C library API for use from Python.

Similar a @ref{37d,,posix_spawn()} excepto que el sistema busca el archivo `executable' en la lista de directorios especificada por la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} (de la misma manera que para @code{execvp(3)} )

Lanza un @ref{18c3,,evento de auditoría} @code{os.posix_spawn} con argumentos @code{ruta}, @code{argv}, @code{env}.


Added in version 3.8.


@ref{1d5a,,Availability}: POSIX, not WASI, not Android, not iOS.

Consulte la documentación de @ref{37d,,posix_spawn()}.
@end deffn

@geindex register_at_fork() (en el módulo os)
@anchor{library/os os register_at_fork}@anchor{1f8}
@deffn {Función} os.register_at_fork (*, before=None, after_in_parent=None, after_in_child=None)

Registra los invocables que se ejecutarán cuando se bifurca un nuevo proceso secundario utilizando @ref{2ff,,os.fork()} o API de clonación de procesos similares. Los parámetros son opcionales y solo de palabras clave. Cada uno especifica un punto de llamada diferente.


@itemize *

@item 
`before' es una función llamada antes de bifurcar un proceso hijo.

@item 
`after_in_parent' es una función llamada desde el proceso padre después de bifurcar un proceso hijo.

@item 
`after_in_child' es una función llamada desde el proceso hijo.
@end itemize

Estas llamadas solo se realizan si se espera que el control regrese al intérprete de Python. Un lanzamiento típico @ref{d6,,subprocess} no los activará ya que el niño no va a volver a ingresar al intérprete.

Las funciones registradas para su ejecución antes de la bifurcación se invocan en orden de registro inverso. Las funciones registradas para la ejecución después de la bifurcación (ya sea en el padre o en el hijo) se invocan en orden de registro.

Tenga en cuenta que las llamadas @code{fork()} realizadas por código C de terceros no pueden llamar a esas funciones, a menos que explícitamente llame a @ref{c47,,PyOS_BeforeFork()}, @ref{c48,,PyOS_AfterFork_Parent()} y @ref{292,,PyOS_AfterFork_Child()}.

No hay forma de cancelar el registro de una función.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


Added in version 3.7.

@end deffn

@geindex spawnl() (en el módulo os)
@geindex spawnle() (en el módulo os)
@geindex spawnlp() (en el módulo os)
@geindex spawnlpe() (en el módulo os)
@geindex spawnv() (en el módulo os)
@geindex spawnve() (en el módulo os)
@geindex spawnvp() (en el módulo os)
@geindex spawnvpe() (en el módulo os)
@anchor{library/os os spawnl}@anchor{1c6}
@deffn {Función} os.spawnl (mode, path, ...)
@anchor{library/os os spawnle}@anchor{2bd9}
@deffnx {Función} os.spawnle (mode, path, ..., env)
@anchor{library/os os spawnlp}@anchor{2bda}
@deffnx {Función} os.spawnlp (mode, file, ...)
@anchor{library/os os spawnlpe}@anchor{2bdb}
@deffnx {Función} os.spawnlpe (mode, file, ..., env)
@anchor{library/os os spawnv}@anchor{2bdc}
@deffnx {Función} os.spawnv (mode, path, args)
@anchor{library/os os spawnve}@anchor{2bdd}
@deffnx {Función} os.spawnve (mode, path, args, env)
@anchor{library/os os spawnvp}@anchor{2bde}
@deffnx {Función} os.spawnvp (mode, file, args)
@anchor{library/os os spawnvpe}@anchor{2bdf}
@deffnx {Función} os.spawnvpe (mode, file, args, env)

Ejecute el programa `path' en un nuevo proceso.

(Tenga en cuenta que el módulo @ref{d6,,subprocess} proporciona funciones más potentes para generar nuevos procesos y recuperar sus resultados; es preferible usar ese módulo que usar estas funciones. Compruebe especialmente la sección @ref{11f9,,Cómo reemplazar anteriores funciones con el módulo subprocess}.)

Si `mode' es @ref{2be0,,P_NOWAIT}, esta función retorna la identificación del proceso del nuevo proceso; if `mode' is @ref{2be1,,P_WAIT}, retorna el código de salida del proceso si sale normalmente, o @code{-signal}, donde `signal' es la señal que mató el proceso. En Windows, la identificación del proceso en realidad será el identificador del proceso, por lo que se puede usar con la función @ref{e20,,waitpid()}.

Nota sobre VxWorks, esta función no retorna @code{-signal} cuando se cierra el nuevo proceso. En su lugar, genera una excepción OSError.

The «l» and «v» variants of the @ref{1c6,,spawn*} functions differ in how
command-line arguments are passed.  The «l» variants are perhaps the easiest
to work with if the number of parameters is fixed when the code is written; the
individual parameters simply become additional parameters to the
@code{spawnl*()} functions.  The «v» variants are good when the number of
parameters is variable, with the arguments being passed in a list or tuple as
the `args' parameter.  In either case, the arguments to the child process must
start with the name of the command being run.

Las variantes que incluyen una segunda «p» cerca del final (@ref{2bda,,spawnlp()}, @ref{2bdb,,spawnlpe()}, @ref{2bde,,spawnvp()}, y @ref{2bdf,,spawnvpe()}) usarán 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} variable de entorno para ubicar el programa `file'. Cuando se reemplaza el entorno (usando uno de los siguientes @ref{1c6,,spawn*e} variantes, discutidas en el siguiente párrafo), el nuevo entorno se utiliza como fuente de la variable 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. Las otras variantes, @ref{1c6,,spawnl()}, @ref{2bd9,,spawnle()}, @ref{2bdc,,spawnv()}, y @ref{2bdd,,spawnve()}, no utilizarán la variable 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} para localizar el ejecutable; `path' debe contener una ruta absoluta o relativa apropiada.

Para @ref{2bd9,,spawnle()}, @ref{2bdb,,spawnlpe()}, @ref{2bdd,,spawnve()}, y @ref{2bdf,,spawnvpe()} (tenga en cuenta que todo esto termina en «e»), el parámetro `env' debe ser un mapeo que se utiliza para definir las variables de entorno para el nuevo proceso (se utilizan en lugar del entorno del proceso actual); las funciones @ref{1c6,,spawnl()}, @ref{2bda,,spawnlp()}, @ref{2bdc,,spawnv()} y @ref{2bde,,spawnvp()} hacen que el nuevo proceso herede el entorno del proceso actual. Tenga en cuenta que las claves y los valores en el diccionario `env' deben ser cadenas; Las teclas o valores no válidos harán que la función falle, con un valor de retorno de @code{127}.

Como ejemplo, las siguientes llamadas a @ref{2bda,,spawnlp()} y @ref{2bdf,,spawnvpe()} son equivalentes:

@example
import os
os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')

L = ['cp', 'index.html', '/dev/null']
os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)
@end example

Lanza un @ref{18c3,,evento de auditoría} @code{os.spawn} con argumentos @code{mode}, @code{path}, @code{args}, @code{env}.

@ref{1d5a,,Availability}: Unix, Windows, not WASI, not Android, not iOS.

@ref{2bda,,spawnlp()}, @ref{2bdb,,spawnlpe()}, @ref{2bde,,spawnvp()} y @ref{2bdf,,spawnvpe()} no están disponibles en Windows. @ref{2bd9,,spawnle()} y @ref{2bdd,,spawnve()} no son seguros para subprocesos en Windows; le recomendamos que utilice el módulo @ref{d6,,subprocess} en su lugar.


Distinto en la versión 3.6: Acepta un @ref{3f0,,objeto tipo ruta}.



Obsoleto desde la versión 3.14: These functions are @ref{1c4,,soft deprecated} and should no longer be used
to write new code. The @ref{d6,,subprocess} module is recommended instead.

@end deffn

@geindex P_NOWAIT (en el módulo os)
@geindex P_NOWAITO (en el módulo os)
@anchor{library/os os P_NOWAIT}@anchor{2be0}
@deffn {Dato} os.P_NOWAIT
@anchor{library/os os P_NOWAITO}@anchor{2be2}
@deffnx {Dato} os.P_NOWAITO

Possible values for the `mode' parameter to the @ref{1c6,,spawn*} family of
functions.  If either of these values is given, the @ref{1c6,,spawn*} functions
will return as soon as the new process has been created, with the process id as
the return value.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex P_WAIT (en el módulo os)
@anchor{library/os os P_WAIT}@anchor{2be1}
@deffn {Dato} os.P_WAIT

Possible value for the `mode' parameter to the @ref{1c6,,spawn*} family of
functions.  If this is given as `mode', the @ref{1c6,,spawn*} functions will not
return until the new process has run to completion and will return the exit code
of the process the run is successful, or @code{-signal} if a signal kills the
process.

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex P_DETACH (en el módulo os)
@geindex P_OVERLAY (en el módulo os)
@anchor{library/os os P_DETACH}@anchor{2be3}
@deffn {Dato} os.P_DETACH
@anchor{library/os os P_OVERLAY}@anchor{2be4}
@deffnx {Dato} os.P_OVERLAY

Valores posibles para el parámetro `mode' para @ref{1c6,,spawn*} familia de funciones. Estos son menos portátiles que los enumerados anteriormente. @ref{2be3,,P_DETACH} es similar a @ref{2be0,,P_NOWAIT}, pero el nuevo proceso se desconecta de la consola del proceso de llamada. Si se usa @ref{2be4,,P_OVERLAY}, el proceso actual será reemplazado; la función @ref{1c6,,spawn*} no volverá.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex startfile() (en el módulo os)
@anchor{library/os os startfile}@anchor{18d4}
@deffn {Función} os.startfile (path[, operation][, arguments][, cwd][, show_cmd])

Inicie un archivo con su aplicación asociada.

When `operation' is not specified, this acts like double-clicking
the file in Windows Explorer, or giving the file name as an argument to the
@code{start} command from the interactive command shell: the file is opened
with whatever application (if any) its extension is associated.

When another `operation' is given, it must be a «command verb» that specifies
what should be done with the file. Common verbs documented by Microsoft are @code{'open'},
@code{'print'} and  @code{'edit'} (to be used on files) as well as @code{'explore'} and
@code{'find'} (to be used on directories).

Al iniciar una aplicación, especifique `arguments' para que se pase como una sola cadena. Es posible que este argumento no tenga ningún efecto cuando se utiliza esta función para iniciar un documento.

El directorio de trabajo predeterminado se hereda, pero el argumento `cwd' puede anularlo. Este debería ser un camino absoluto. Un `path' relativo se resolverá contra este argumento.

Use `show_cmd' to override the default window style. Whether this has any
effect will depend on the application being launched. Values are integers as
supported by the Win32 @code{ShellExecute()} function.

@ref{18d4,,startfile()} retorna tan pronto como se inicia la aplicación asociada. No hay opción para esperar a que se cierre la aplicación y no hay forma de recuperar el estado de salida de la aplicación. El parámetro `path' es relativo al directorio actual o `cwd'. Si desea utilizar una ruta absoluta, asegúrese de que el primer carácter no sea una barra (@code{'/'}) Utilice @ref{a4,,pathlib} o la función @ref{1382,,os.path.normpath()} para asegurarse de que las rutas estén codificadas correctamente para Win32.

To reduce interpreter startup overhead, the Win32 @code{ShellExecute()}
function is not resolved until this function is first called.  If the function
cannot be resolved, @ref{384,,NotImplementedError} will be raised.

Lanza un @ref{18c3,,evento de auditoría} @code{os.startfile} con argumentos @code{path}, @code{operation}.

Lanza un @ref{18c3,,evento de auditoria} @code{os.startfile/2} con argumentos @code{path}, @code{operation}, @code{arguments}, @code{cwd}, @code{show_cmd}.

@ref{1d5a,,Availability}: Windows.


Distinto en la versión 3.10: Se agregaron los argumentos `arguments', `cwd' y `show_cmd', y el evento de auditoría @code{os.startfile/2}.

@end deffn

@geindex system() (en el módulo os)
@anchor{library/os os system}@anchor{149a}
@deffn {Función} os.system (command)

Ejecute el comando (una cadena) en una subcapa. Esto se implementa llamando a la función C estándar @code{system()} y tiene las mismas limitaciones. Los cambios en @ref{5df,,sys.stdin}, etc. no se reflejan en el entorno del comando ejecutado. Si `command' genera alguna salida, se enviará al flujo de salida estándar del intérprete. El estándar C no especifica el significado del valor de retorno de la función C, por lo que el valor de retorno de la función de Python depende del sistema.

En Unix, el valor de retorno es el estado de salida del proceso codificado en el formato especificado para @ref{e1e,,wait()}.

En Windows, el valor de retorno es el que retorna el shell del sistema después de ejecutar `command'. El shell viene dado por la variable de entorno de Windows 
@geindex COMSPEC
@geindex variables de entorno; COMSPEC
@code{COMSPEC}: generalmente es @code{cmd.exe}, que retorna el estado de salida de la ejecución del comando; En sistemas que utilizan un shell no nativo, consulte la documentación del shell.

The @ref{d6,,subprocess} module provides more powerful facilities for spawning
new processes and retrieving their results; using that module is recommended
to using this function.  See the @ref{11f9,,Cómo reemplazar anteriores funciones con el módulo subprocess} section in
the @ref{d6,,subprocess} documentation for some helpful recipes.

En Unix, @ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el resultado (estado de salida) en un código de salida. En Windows, el resultado es directamente el código de salida.

Lanza un @ref{18c3,,evento de auditoría} @code{os.system} con argumento @code{command}.

@ref{1d5a,,Availability}: Unix, Windows, not WASI, not Android, not iOS.
@end deffn

@geindex times() (en el módulo os)
@anchor{library/os os times}@anchor{1187}
@deffn {Función} os.times ()

Retorna los tiempos de proceso globales actuales. El valor de retorno es un objeto con cinco atributos:


@itemize *

@item 
@code{user} - tiempo de usuario

@item 
@code{system} - tiempo de sistema

@item 
@code{children_user} - tiempo de usuario de todos los procesos secundarios

@item 
@code{children_system} - hora del sistema de todos los procesos secundarios

@item 
@code{elapsed}: tiempo real transcurrido desde un punto fijo en el pasado
@end itemize

Por compatibilidad con versiones anteriores, este objeto también se comporta como una tupla de cinco que contiene @code{user}, @code{system}, @code{children_user}, @code{children_system} y @code{elapsed} en ese orden.

See the Unix manual page
@code{times(2)@footnote{https://manpages.debian.org/times(2)}} and times(3)@footnote{https://man.freebsd.org/cgi/man.cgi?time(3)} manual page on Unix or the GetProcessTimes MSDN@footnote{https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes}
on Windows. On Windows, only @code{user} and @code{system} are known; the other attributes are zero.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.3: El tipo de objeto retornado cambió de una tupla a un objeto tipo tupla con atributos con nombre.

@end deffn

@geindex wait() (en el módulo os)
@anchor{library/os os wait}@anchor{e1e}
@deffn {Función} os.wait ()

Espere a que se complete un proceso secundario y retorna una tupla que contenga su indicación de estado pid y de salida: un número de 16 bits, cuyo byte bajo es el número de señal que mató el proceso y cuyo byte alto es el estado de salida (si la señal el número es cero); el bit alto del byte bajo se establece si se produjo un archivo central.

If there are no children that could be waited for, @ref{10d4,,ChildProcessError}
is raised.

@ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el estado de salida en el código de salida.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


@subsubheading Ver también


The other @code{wait*()} functions documented below can be used to wait for the
completion of a specific child process and have more options.
@ref{e20,,waitpid()} is the only one also available on Windows.

@end deffn

@geindex waitid() (en el módulo os)
@anchor{library/os os waitid}@anchor{e1f}
@deffn {Función} os.waitid (idtype, id, options, /)

Wait for the completion of a child process.

`idtype' can be @ref{2be5,,P_PID}, @ref{2be6,,P_PGID}, @ref{2be7,,P_ALL}, or (on Linux) @ref{9b0,,P_PIDFD}.
The interpretation of `id' depends on it; see their individual descriptions.

`options' is an OR combination of flags.  At least one of @ref{2be8,,WEXITED},
@ref{2be9,,WSTOPPED} or @ref{2bea,,WCONTINUED} is required;
@ref{2beb,,WNOHANG} and @ref{2bec,,WNOWAIT} are additional optional flags.

The return value is an object representing the data contained in the
@code{siginfo_t} structure with the following attributes:


@itemize *

@item 
@code{si_pid} (process ID)

@item 
@code{si_uid} (real user ID of the child)

@item 
@code{si_signo} (always @ref{2bed,,SIGCHLD})

@item 
@code{si_status} (the exit status or signal number, depending on @code{si_code})

@item 
@code{si_code} (see @ref{2bee,,CLD_EXITED} for possible values)
@end itemize

If @ref{2beb,,WNOHANG} is specified and there are no matching children in the
requested state, @code{None} is returned.
Otherwise, if there are no matching children
that could be waited for, @ref{10d4,,ChildProcessError} is raised.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.



Distinto en la versión 3.13: This function is now available on macOS as well.

@end deffn

@geindex waitpid() (en el módulo os)
@anchor{library/os os waitpid}@anchor{e20}
@deffn {Función} os.waitpid (pid, options, /)

Los detalles de esta función difieren en Unix y Windows.

En Unix: espere a que se complete un proceso secundario dado por la identificación del proceso `pid', y retorna una tupla que contenga su identificación del proceso y la indicación del estado de salida (codificado como para @ref{e1e,,wait()}). La semántica de la llamada se ve afectada por el valor del número entero `options', que debe ser @code{0} para el funcionamiento normal.

Si `pid' es mayor que @code{0}, @ref{e20,,waitpid()} solicita información de estado para ese proceso específico. Si `pid' es @code{0}, la solicitud es para el estado de cualquier hijo en el grupo de procesos del proceso actual. Si `pid' es @code{-1}, la solicitud corresponde a cualquier elemento secundario del proceso actual. Si `pid' es menor que @code{-1}, se solicita el estado de cualquier proceso en el grupo de procesos @code{-pid} (el valor absoluto de `pid').

`options' is an OR combination of flags.  If it contains @ref{2beb,,WNOHANG} and
there are no matching children in the requested state, @code{(0, 0)} is
returned.  Otherwise, if there are no matching children that could be waited
for, @ref{10d4,,ChildProcessError} is raised.  Other options that can be used are
@ref{2bef,,WUNTRACED} and @ref{2bea,,WCONTINUED}.

En Windows: espere a que se complete un proceso dado por el identificador de proceso `pid', y retorna una tupla que contiene `pid', y su estado de salida se desplazó a la izquierda en 8 bits (el desplazamiento facilita el uso de la función en la plataforma). A `pid' menor o igual que @code{0} no tiene un significado especial en Windows y genera una excepción. El valor de entero `options' no tiene ningún efecto. `pid' puede referirse a cualquier proceso cuya identificación sea conocida, no necesariamente un proceso hijo. Las funciones @ref{1c6,,spawn*} llamadas con @ref{2be0,,P_NOWAIT} retornan manejadores de proceso adecuados.

@ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el estado de salida en el código de salida.

@ref{1d5a,,Availability}: Unix, Windows, not WASI, not Android, not iOS.


Distinto en la versión 3.5: Si la llamada al sistema se interrumpe y el controlador de señal no genera una excepción, la función vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@end deffn

@geindex wait3() (en el módulo os)
@anchor{library/os os wait3}@anchor{e1c}
@deffn {Función} os.wait3 (options)

Similar to @ref{e20,,waitpid()}, except no process id argument is given and a
3-element tuple containing the child’s process id, exit status indication,
and resource usage information is returned.  Refer to
@ref{1470,,resource.getrusage()} for details on resource usage information.  The
`options' argument is the same as that provided to @ref{e20,,waitpid()} and
@ref{e1d,,wait4()}.

@ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el estado de salida al código de salida.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex wait4() (en el módulo os)
@anchor{library/os os wait4}@anchor{e1d}
@deffn {Función} os.wait4 (pid, options)

Similar to @ref{e20,,waitpid()}, except a 3-element tuple, containing the child’s
process id, exit status indication, and resource usage information is
returned.  Refer to @ref{1470,,resource.getrusage()} for details on resource usage
information.  The arguments to @ref{e1d,,wait4()} are the same as those provided
to @ref{e20,,waitpid()}.

@ref{9b1,,waitstatus_to_exitcode()} puede ser usado para convertir el estado de salida al código de salida.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex P_PID (en el módulo os)
@geindex P_PGID (en el módulo os)
@geindex P_ALL (en el módulo os)
@geindex P_PIDFD (en el módulo os)
@anchor{library/os os P_PID}@anchor{2be5}
@deffn {Dato} os.P_PID
@anchor{library/os os P_PGID}@anchor{2be6}
@deffnx {Dato} os.P_PGID
@anchor{library/os os P_ALL}@anchor{2be7}
@deffnx {Dato} os.P_ALL
@anchor{library/os os P_PIDFD}@anchor{9b0}
@deffnx {Dato} os.P_PIDFD

These are the possible values for `idtype' in @ref{e1f,,waitid()}. They affect
how `id' is interpreted:


@itemize *

@item 
@code{P_PID} - wait for the child whose PID is `id'.

@item 
@code{P_PGID} - wait for any child whose progress group ID is `id'.

@item 
@code{P_ALL} - wait for any child; `id' is ignored.

@item 
@code{P_PIDFD} - wait for the child identified by the file descriptor
`id' (a process file descriptor created with @ref{524,,pidfd_open()}).
@end itemize

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.

@cartouche
@quotation Nota 
@code{P_PIDFD} is only available on Linux >= 5.4.
@end quotation
@end cartouche


Added in version 3.3.



Added in version 3.9: The @code{P_PIDFD} constant.

@end deffn

@geindex WCONTINUED (en el módulo os)
@anchor{library/os os WCONTINUED}@anchor{2bea}
@deffn {Dato} os.WCONTINUED

This `options' flag for @ref{e20,,waitpid()}, @ref{e1c,,wait3()}, @ref{e1d,,wait4()}, and
@ref{e1f,,waitid()} causes child processes to be reported if they have been
continued from a job control stop since they were last reported.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITED (en el módulo os)
@anchor{library/os os WEXITED}@anchor{2be8}
@deffn {Dato} os.WEXITED

This `options' flag for @ref{e1f,,waitid()} causes child processes that have terminated to
be reported.

The other @code{wait*} functions always report children that have terminated,
so this option is not available for them.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex WSTOPPED (en el módulo os)
@anchor{library/os os WSTOPPED}@anchor{2be9}
@deffn {Dato} os.WSTOPPED

This `options' flag for @ref{e1f,,waitid()} causes child processes that have been stopped
by the delivery of a signal to be reported.

This option is not available for the other @code{wait*} functions.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex WUNTRACED (en el módulo os)
@anchor{library/os os WUNTRACED}@anchor{2bef}
@deffn {Dato} os.WUNTRACED

This `options' flag for @ref{e20,,waitpid()}, @ref{e1c,,wait3()}, and @ref{e1d,,wait4()} causes
child processes to also be reported if they have been stopped but their
current state has not been reported since they were stopped.

This option is not available for @ref{e1f,,waitid()}.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOHANG (en el módulo os)
@anchor{library/os os WNOHANG}@anchor{2beb}
@deffn {Dato} os.WNOHANG

This `options' flag causes @ref{e20,,waitpid()}, @ref{e1c,,wait3()}, @ref{e1d,,wait4()}, and
@ref{e1f,,waitid()} to return right away if no child process status is available
immediately.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOWAIT (en el módulo os)
@anchor{library/os os WNOWAIT}@anchor{2bec}
@deffn {Dato} os.WNOWAIT

This `options' flag causes @ref{e1f,,waitid()} to leave the child in a waitable state, so that
a later @code{wait*()} call can be used to retrieve the child status information again.

This option is not available for the other @code{wait*} functions.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex CLD_EXITED (en el módulo os)
@geindex CLD_KILLED (en el módulo os)
@geindex CLD_DUMPED (en el módulo os)
@geindex CLD_TRAPPED (en el módulo os)
@geindex CLD_STOPPED (en el módulo os)
@geindex CLD_CONTINUED (en el módulo os)
@anchor{library/os os CLD_EXITED}@anchor{2bee}
@deffn {Dato} os.CLD_EXITED
@anchor{library/os os CLD_KILLED}@anchor{9ae}
@deffnx {Dato} os.CLD_KILLED
@anchor{library/os os CLD_DUMPED}@anchor{2bf0}
@deffnx {Dato} os.CLD_DUMPED
@anchor{library/os os CLD_TRAPPED}@anchor{2bf1}
@deffnx {Dato} os.CLD_TRAPPED
@anchor{library/os os CLD_STOPPED}@anchor{9af}
@deffnx {Dato} os.CLD_STOPPED
@anchor{library/os os CLD_CONTINUED}@anchor{2bf2}
@deffnx {Dato} os.CLD_CONTINUED

These are the possible values for @code{si_code} in the result returned by
@ref{e1f,,waitid()}.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.



Distinto en la versión 3.9: Agregado los valores @ref{9ae,,CLD_KILLED} y @ref{9af,,CLD_STOPPED}.

@end deffn

@geindex waitstatus_to_exitcode() (en el módulo os)
@anchor{library/os os waitstatus_to_exitcode}@anchor{9b1}
@deffn {Función} os.waitstatus_to_exitcode (status)

Convertir un estado de espera a un código de salida.

En Unix:


@itemize *

@item 
Si el proceso termino con normalidad (if @code{WIFEXITED(status)} is true, se retornan el estado de salida del proceso (return @code{WEXITSTATUS(status)}): resultado mayor o igual a 0.

@item 
Si el proceso fue terminado por una señal (if @code{WIFSIGNALED(status)} is true), retorna @code{-signum} donde `signum' es el numero de la señal que cause que el proceso termine (return @code{-WTERMSIG(status)}): resultado menor que 0.

@item 
En el caso contrario, se lanza un @ref{360,,ValueError}.
@end itemize

En Windows, retorna `status' desplazado a la derecha en 8 bits.

En Unix, si el proceso esta siendo rastreado o si @ref{e20,,waitpid()} fue llamado con la opción @ref{2bef,,WUNTRACED}, el que llama debe revisar primero si @code{WIFSTOPPED(status)} es verdadero. La función no debe de ser llamada si @code{WIFSTOPPED(status)} es verdadero.


@subsubheading Ver también


Funciones @ref{2bf3,,WIFEXITED()}, @ref{2bf4,,WEXITSTATUS()}, @ref{2bf5,,WIFSIGNALED()}, @ref{2bf6,,WTERMSIG()}, @ref{2bf7,,WIFSTOPPED()}, @ref{2bf8,,WSTOPSIG()}.


@ref{1d5a,,Availability}: Unix, Windows, not WASI, not Android, not iOS.


Added in version 3.9.

@end deffn

Las siguientes funciones toman un código de estado del proceso retornado por @ref{149a,,system()}, @ref{e1e,,wait()}, o @ref{e20,,waitpid()} como parámetro. Pueden usarse para determinar la disposición de un proceso.

@geindex WCOREDUMP() (en el módulo os)
@anchor{library/os os WCOREDUMP}@anchor{2bf9}
@deffn {Función} os.WCOREDUMP (status, /)

Retorna @code{True} si se generó un volcado de núcleo para el proceso; de lo contrario, retorna @code{False}.

Esta función debe emplearse solo si @ref{2bf5,,WIFSIGNALED()} es verdadero.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFCONTINUED() (en el módulo os)
@anchor{library/os os WIFCONTINUED}@anchor{2bfa}
@deffn {Función} os.WIFCONTINUED (status)

Return @code{True} if a stopped child has been resumed by delivery of
@ref{2bfb,,SIGCONT} (if the process has been continued from a job
control stop), otherwise return @code{False}.

Ver opción @ref{2bea,,WCONTINUED}.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSTOPPED() (en el módulo os)
@anchor{library/os os WIFSTOPPED}@anchor{2bf7}
@deffn {Función} os.WIFSTOPPED (status)

Retorna @code{True} si el proceso se detuvo mediante la entrega de una señal; de lo contrario, retorna @code{False}.

@ref{2bf7,,WIFSTOPPED()} solo retorna @code{True} si la llamada @ref{e20,,waitpid()} se realizó utilizando la opción @ref{2bef,,WUNTRACED} o cuando se rastrea el proceso (consulte @code{ptrace(2)@footnote{https://manpages.debian.org/ptrace(2)}})

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSIGNALED() (en el módulo os)
@anchor{library/os os WIFSIGNALED}@anchor{2bf5}
@deffn {Función} os.WIFSIGNALED (status)

Retorna @code{True} si el proceso finalizó con una señal; de lo contrario, retorna @code{False}.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFEXITED() (en el módulo os)
@anchor{library/os os WIFEXITED}@anchor{2bf3}
@deffn {Función} os.WIFEXITED (status)

Retorna @code{True} si el proceso finalizó normalmente, es decir, llamando a @code{exit()} o @code{_exit()}, o volviendo de @code{main()}; de lo contrario, retorna @code{False}.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITSTATUS() (en el módulo os)
@anchor{library/os os WEXITSTATUS}@anchor{2bf4}
@deffn {Función} os.WEXITSTATUS (status)

Retorna el estado de salida del proceso.

Esta función debe emplearse solo si @ref{2bf3,,WIFEXITED()} es verdadero.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WSTOPSIG() (en el módulo os)
@anchor{library/os os WSTOPSIG}@anchor{2bf8}
@deffn {Función} os.WSTOPSIG (status)

Retorna la señal que hizo que el proceso se detuviera.

Esta función debe emplearse solo si @ref{2bf7,,WIFSTOPPED()} es verdadero.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WTERMSIG() (en el módulo os)
@anchor{library/os os WTERMSIG}@anchor{2bf6}
@deffn {Función} os.WTERMSIG (status)

Retorna el número de la señal que provocó la finalización del proceso.

Esta función debe emplearse solo si @ref{2bf5,,WIFSIGNALED()} es verdadero.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.
@end deffn

@node Interfaz al planificador,Información miscelánea del sistema,Gestión de proceso,os — Miscellaneous operating system interfaces
@anchor{library/os interface-to-the-scheduler}@anchor{2bfc}
@subsubsection Interfaz al planificador


Estas funciones controlan cómo el sistema operativo asigna el tiempo de CPU a un proceso. Solo están disponibles en algunas plataformas Unix. Para obtener información más detallada, consulte las páginas de manual de Unix.


Added in version 3.3.


Las siguientes políticas de programación están expuestas si son compatibles con el sistema operativo.

@geindex SCHED_OTHER (en el módulo os)
@anchor{library/os os SCHED_OTHER}@anchor{2bfd}
@deffn {Dato} os.SCHED_OTHER

La política de programación predeterminada.
@end deffn

@geindex SCHED_BATCH (en el módulo os)
@anchor{library/os os SCHED_BATCH}@anchor{2bfe}
@deffn {Dato} os.SCHED_BATCH

Política de programación para procesos intensivos en CPU que intenta preservar la interactividad en el resto de la computadora.
@end deffn

@geindex SCHED_IDLE (en el módulo os)
@anchor{library/os os SCHED_IDLE}@anchor{2bff}
@deffn {Dato} os.SCHED_IDLE

Política de programación para tareas en segundo plano de prioridad extremadamente baja.
@end deffn

@geindex SCHED_SPORADIC (en el módulo os)
@anchor{library/os os SCHED_SPORADIC}@anchor{2c00}
@deffn {Dato} os.SCHED_SPORADIC

Política de programación para programas de servidor esporádicos.
@end deffn

@geindex SCHED_FIFO (en el módulo os)
@anchor{library/os os SCHED_FIFO}@anchor{2c01}
@deffn {Dato} os.SCHED_FIFO

Una política de programación `First In First Out'.
@end deffn

@geindex SCHED_RR (en el módulo os)
@anchor{library/os os SCHED_RR}@anchor{2c02}
@deffn {Dato} os.SCHED_RR

Una política de programación round-robin.
@end deffn

@geindex SCHED_RESET_ON_FORK (en el módulo os)
@anchor{library/os os SCHED_RESET_ON_FORK}@anchor{2c03}
@deffn {Dato} os.SCHED_RESET_ON_FORK

Esta flag se puede OR con cualquier otra política de programación. Cuando un proceso con este indicador establece bifurcaciones, la política de programación y la prioridad de su hijo se restablecen a los valores predeterminados.
@end deffn

@geindex sched_param (clase en os)
@anchor{library/os os sched_param}@anchor{15a4}
@deffn {Clase} os.sched_param (sched_priority)

Esta clase representa los parámetros de programación ajustables utilizados en @ref{1181,,sched_setparam()}, @ref{1182,,sched_setscheduler()} y @ref{117d,,sched_getparam()}. Es inmutable.

Por el momento, solo hay un parámetro posible:

@geindex sched_priority (atributo de os.sched_param)
@anchor{library/os os sched_param sched_priority}@anchor{2c04}
@deffn {Atributo} sched_priority

La prioridad de programación para una política de programación.
@end deffn
@end deffn

@geindex sched_get_priority_min() (en el módulo os)
@anchor{library/os os sched_get_priority_min}@anchor{117b}
@deffn {Función} os.sched_get_priority_min (policy)

Obtiene el valor de prioridad mínimo para `policy'. `policy' es una de las constantes de política de programación anteriores.
@end deffn

@geindex sched_get_priority_max() (en el módulo os)
@anchor{library/os os sched_get_priority_max}@anchor{117a}
@deffn {Función} os.sched_get_priority_max (policy)

Obtiene el valor de prioridad máxima para `policy'. `policy' es una de las constantes de política de programación anteriores.
@end deffn

@geindex sched_setscheduler() (en el módulo os)
@anchor{library/os os sched_setscheduler}@anchor{1182}
@deffn {Función} os.sched_setscheduler (pid, policy, param, /)

Establece la política de programación para el proceso con PID `pid'. Un `pid' de 0 significa el proceso de llamada. `policy' es una de las constantes de política de programación anteriores. `param' es una instancia de @ref{15a4,,sched_param}.
@end deffn

@geindex sched_getscheduler() (en el módulo os)
@anchor{library/os os sched_getscheduler}@anchor{117e}
@deffn {Función} os.sched_getscheduler (pid, /)

Retorna la política de programación para el proceso con PID `pid'. Un `pid' de 0 significa el proceso de llamada. El resultado es una de las constantes de política de programación anteriores.
@end deffn

@geindex sched_setparam() (en el módulo os)
@anchor{library/os os sched_setparam}@anchor{1181}
@deffn {Función} os.sched_setparam (pid, param, /)

Establece los parámetros de programación para el proceso con PID `pid'. Un `pid' de 0 significa el proceso de llamada. `param' es una instancia de @ref{15a4,,sched_param}.
@end deffn

@geindex sched_getparam() (en el módulo os)
@anchor{library/os os sched_getparam}@anchor{117d}
@deffn {Función} os.sched_getparam (pid, /)

Retorna los parámetros de programación como una instancia de @ref{15a4,,sched_param} para el proceso con PID `pid'. Un `pid' de 0 significa el proceso de llamada.
@end deffn

@geindex sched_rr_get_interval() (en el módulo os)
@anchor{library/os os sched_rr_get_interval}@anchor{117f}
@deffn {Función} os.sched_rr_get_interval (pid, /)

Retorna el round-robin quantum en segundos para el proceso con PID `pid'. Un `pid' de 0 significa el proceso de llamada.
@end deffn

@geindex sched_yield() (en el módulo os)
@anchor{library/os os sched_yield}@anchor{1183}
@deffn {Función} os.sched_yield ()

Renunciar voluntariamente a la CPU.
@end deffn

@geindex sched_setaffinity() (en el módulo os)
@anchor{library/os os sched_setaffinity}@anchor{1180}
@deffn {Función} os.sched_setaffinity (pid, mask, /)

Restringe el proceso con PID `pid' (o el proceso actual si es cero) a un conjunto de CPU. `mask' es un entero iterable que representa el conjunto de CPU a las que se debe restringir el proceso.
@end deffn

@geindex sched_getaffinity() (en el módulo os)
@anchor{library/os os sched_getaffinity}@anchor{117c}
@deffn {Función} os.sched_getaffinity (pid, /)

Return the set of CPUs the process with PID `pid' is restricted to.

If `pid' is zero, return the set of CPUs the calling thread of the current
process is restricted to.

See also the @ref{327,,process_cpu_count()} function.
@end deffn

@node Información miscelánea del sistema,Números al azar,Interfaz al planificador,os — Miscellaneous operating system interfaces
@anchor{library/os miscellaneous-system-information}@anchor{2c05}@anchor{library/os os-path}@anchor{2c06}
@subsubsection Información miscelánea del sistema


@geindex confstr() (en el módulo os)
@anchor{library/os os confstr}@anchor{2c07}
@deffn {Función} os.confstr (name, /)

Retorna valores de configuración del sistema con valores de cadena. `name' especifica el valor de configuración para recuperar; puede ser una cadena que es el nombre de un valor de sistema definido; estos nombres se especifican en varios estándares (POSIX, Unix 95, Unix 98 y otros). Algunas plataformas también definen nombres adicionales. Los nombres conocidos por el sistema operativo host se dan como las claves del diccionario @code{confstr_names}. Para las variables de configuración no incluidas en esa asignación, también se acepta pasar un número entero para `name'.

Si el valor de configuración especificado por `name' no está definido, se retorna @code{None}.

Si `name' es una cadena y no se conoce, se excita @ref{360,,ValueError}. Si el sistema host no admite un valor específico para `name', incluso si está incluido en @code{confstr_names}, se lanza un @ref{4d5,,OSError} con @ref{19f8,,errno.EINVAL} para el número de error .

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex confstr_names (en el módulo os)
@anchor{library/os os confstr_names}@anchor{2c08}
@deffn {Dato} os.confstr_names

Nombres de mapeo de diccionario aceptados por @ref{2c07,,confstr()} a los valores enteros definidos para esos nombres por el sistema operativo host. Esto se puede usar para determinar el conjunto de nombres conocidos por el sistema.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex cpu_count() (en el módulo os)
@anchor{library/os os cpu_count}@anchor{328}
@deffn {Función} os.cpu_count ()

Return the number of logical CPUs in the `system'. Returns @code{None} if
undetermined.

The @ref{327,,process_cpu_count()} function can be used to get the number of
logical CPUs usable by the calling thread of the `current process'.


Added in version 3.4.



Distinto en la versión 3.13: If @ref{2e2,,-X cpu_count} is given or 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT} is set,
@ref{328,,cpu_count()} returns the overridden value `n'.

@end deffn

@geindex getloadavg() (en el módulo os)
@anchor{library/os os getloadavg}@anchor{15ba}
@deffn {Función} os.getloadavg ()

Retorna el número de procesos en la cola de ejecución del sistema promediada durante los últimos 1, 5 y 15 minutos o aumentos @ref{4d5,,OSError} si el promedio de carga no se pudo obtener.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex process_cpu_count() (en el módulo os)
@anchor{library/os os process_cpu_count}@anchor{327}
@deffn {Función} os.process_cpu_count ()

Get the number of logical CPUs usable by the calling thread of the `current
process'. Returns @code{None} if undetermined. It can be less than
@ref{328,,cpu_count()} depending on the CPU affinity.

The @ref{328,,cpu_count()} function can be used to get the number of logical CPUs
in the `system'.

If @ref{2e2,,-X cpu_count} is given or 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT} is set,
@ref{327,,process_cpu_count()} returns the overridden value `n'.

See also the @ref{117c,,sched_getaffinity()} function.


Added in version 3.13.

@end deffn

@geindex sysconf() (en el módulo os)
@anchor{library/os os sysconf}@anchor{2b68}
@deffn {Función} os.sysconf (name, /)

Retorna valores de configuración del sistema con valores enteros. Si el valor de configuración especificado por `name' no está definido, se retorna @code{-1}. Los comentarios sobre el parámetro `name' para @ref{2c07,,confstr()} se aplican aquí también; El diccionario que proporciona información sobre los nombres conocidos viene dado por @code{sysconf_names}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex sysconf_names (en el módulo os)
@anchor{library/os os sysconf_names}@anchor{2c09}
@deffn {Dato} os.sysconf_names

Nombres de asignación de diccionario aceptados por @ref{2b68,,sysconf()} a los valores enteros definidos para esos nombres por el sistema operativo host. Esto se puede usar para determinar el conjunto de nombres conocidos por el sistema.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.11: Agregue el nombre @code{'SC_MINSIGSTKSZ'}.

@end deffn

Los siguientes valores de datos se utilizan para admitir operaciones de manipulación de rutas. Estos están definidos para todas las plataformas.

Las operaciones de nivel superior en los nombres de ruta se definen en el módulo @ref{a2,,os.path}.

@geindex . (dot);in pathnames

@geindex curdir (en el módulo os)
@anchor{library/os os curdir}@anchor{27cd}
@deffn {Dato} os.curdir

La cadena constante utilizada por el sistema operativo para referirse al directorio actual. Esto es @code{'.'} Para Windows y POSIX. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex ..;in pathnames

@geindex pardir (en el módulo os)
@anchor{library/os os pardir}@anchor{2b83}
@deffn {Dato} os.pardir

La cadena constante utilizada por el sistema operativo para hacer referencia al directorio principal. Esto es @code{'...'} para Windows y POSIX. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex / (slash);in pathnames

@geindex \ (backslash);in pathnames (Windows)

@geindex sep (en el módulo os)
@anchor{library/os os sep}@anchor{70b}
@deffn {Dato} os.sep

El carácter utilizado por el sistema operativo para separar los componentes del nombre de ruta. Esto es @code{'/'} para POSIX y @code{'\\'} para Windows. Tenga en cuenta que saber esto no es suficiente para poder analizar o concatenar nombres de ruta — use @ref{27c7,,os.path.split()} y @ref{163f,,os.path.join()} — pero en ocasiones es útil. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex / (slash);in pathnames

@geindex altsep (en el módulo os)
@anchor{library/os os altsep}@anchor{70c}
@deffn {Dato} os.altsep

Un carácter alternativo utilizado por el sistema operativo para separar los componentes del nombre de ruta, o @code{None} si solo existe un carácter separador. Esto se establece en @code{'/'} en los sistemas Windows donde @code{sep} es una barra invertida. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex . (dot);in pathnames

@geindex extsep (en el módulo os)
@anchor{library/os os extsep}@anchor{2c0a}
@deffn {Dato} os.extsep

El carácter que separa el nombre de archivo base de la extensión; por ejemplo, el @code{'.'} en @code{os.py}. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex ; (colon);path separator (POSIX)
@geindex ; (semicolon)

@geindex pathsep (en el módulo os)
@anchor{library/os os pathsep}@anchor{1d4a}
@deffn {Dato} os.pathsep

El carácter utilizado convencionalmente por el sistema operativo para separar los componentes de la ruta de búsqueda (como en 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}), como @code{':'} para POSIX o @code{';'} para Windows. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex defpath (en el módulo os)
@anchor{library/os os defpath}@anchor{1a0a}
@deffn {Dato} os.defpath

La ruta de búsqueda predeterminada utilizada por @ref{2bbd,,exec*p*} y @ref{1c6,,spawn*p*} si el entorno no tiene una tecla @code{'RUTA'}. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex linesep (en el módulo os)
@anchor{library/os os linesep}@anchor{2181}
@deffn {Dato} os.linesep

La cadena utilizada para separar (o, más bien, terminar) líneas en la plataforma actual. Este puede ser un solo carácter, como @code{'\n'} para POSIX, o varios caracteres, por ejemplo, @code{'\r\n'} para Windows. No utilice `os.linesep' como terminador de línea cuando escriba archivos abiertos en modo texto (el valor predeterminado); use un solo @code{'\n'} en su lugar, en todas las plataformas.
@end deffn

@geindex devnull (en el módulo os)
@anchor{library/os os devnull}@anchor{1a3a}
@deffn {Dato} os.devnull

La ruta del archivo del dispositivo nulo. Por ejemplo: @code{'/dev/null'} para POSIX, @code{'nul'} para Windows. También disponible a través de @ref{a2,,os.path}.
@end deffn

@geindex RTLD_LAZY (en el módulo os)
@geindex RTLD_NOW (en el módulo os)
@geindex RTLD_GLOBAL (en el módulo os)
@geindex RTLD_LOCAL (en el módulo os)
@geindex RTLD_NODELETE (en el módulo os)
@geindex RTLD_NOLOAD (en el módulo os)
@geindex RTLD_DEEPBIND (en el módulo os)
@anchor{library/os os RTLD_LAZY}@anchor{118a}
@deffn {Dato} os.RTLD_LAZY
@anchor{library/os os RTLD_NOW}@anchor{118b}
@deffnx {Dato} os.RTLD_NOW
@anchor{library/os os RTLD_GLOBAL}@anchor{118c}
@deffnx {Dato} os.RTLD_GLOBAL
@anchor{library/os os RTLD_LOCAL}@anchor{118d}
@deffnx {Dato} os.RTLD_LOCAL
@anchor{library/os os RTLD_NODELETE}@anchor{118e}
@deffnx {Dato} os.RTLD_NODELETE
@anchor{library/os os RTLD_NOLOAD}@anchor{118f}
@deffnx {Dato} os.RTLD_NOLOAD
@anchor{library/os os RTLD_DEEPBIND}@anchor{1190}
@deffnx {Dato} os.RTLD_DEEPBIND

Flags para usar con las funciones @ref{1191,,setdlopenflags()} y @ref{1550,,getdlopenflags()}. Consulte la página del manual de Unix @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} para saber qué significan las diferentes flags.


Added in version 3.3.

@end deffn

@node Números al azar,,Información miscelánea del sistema,os — Miscellaneous operating system interfaces
@anchor{library/os random-numbers}@anchor{2c0b}
@subsubsection Números al azar


@geindex getrandom() (en el módulo os)
@anchor{library/os os getrandom}@anchor{d45}
@deffn {Función} os.getrandom (size, flags=0)

Obtiene hasta `size' bytes aleatorios. La función puede retornar menos bytes que los solicitados.

Estos bytes se pueden usar para generar generadores de números aleatorios en el espacio del usuario o para fines criptográficos.

@code{getrandom()} se basa en la entropía obtenida de los controladores de dispositivos y otras fuentes de ruido ambiental. La lectura innecesaria de grandes cantidades de datos tendrá un impacto negativo en otros usuarios de los dispositivos @code{/dev/random} y @code{/dev/urandom}.

The flags argument is a bit mask that can contain zero or more of the
following values ORed together: @ref{2c0c,,os.GRND_RANDOM} and
@ref{2c0d,,GRND_NONBLOCK}.

Véase también el Linux getrandom() manual page@footnote{https://man7.org/linux/man-pages/man2/getrandom.2.html}.

@ref{1d5a,,Availability}: Linux >= 3.17.


Added in version 3.6.

@end deffn

@geindex urandom() (en el módulo os)
@anchor{library/os os urandom}@anchor{5c6}
@deffn {Función} os.urandom (size, /)

Retorna una cadena de bytes de bytes aleatorios `size' adecuados para uso criptográfico.

Esta función retorna bytes aleatorios de una fuente de aleatoriedad específica del sistema operativo. Los datos retornados deben ser lo suficientemente impredecibles para las aplicaciones criptográficas, aunque su calidad exacta depende de la implementación del sistema operativo.

En Linux, si la llamada al sistema @code{getrandom()} está disponible, se usa en modo de bloqueo: bloquee hasta que el grupo de entropía urandom del sistema se inicialice (el núcleo recopila 128 bits de entropía). Ver el 
@geindex Python Enhancement Proposals; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} para la justificación. En Linux, la función @ref{d45,,getrandom()} puede usarse para obtener bytes aleatorios en modo sin bloqueo (usando el indicador @ref{2c0d,,GRND_NONBLOCK}) o para sondear hasta que el grupo de entropía urandom del sistema se inicialice.

En un sistema tipo Unix, los bytes aleatorios se leen desde el dispositivo @code{/dev/urandom}. Si el dispositivo @code{/dev/urandom} no está disponible o no es legible, se genera la excepción @ref{384,,NotImplementedError}.

En Windows, usará @code{BCryptGenRandom()}.


@subsubheading Ver también


El módulo @ref{c0,,secrets} proporciona funciones de nivel superior. Para obtener una interfaz fácil de usar con el generador de números aleatorios proporcionado por su plataforma, consulte @ref{26d5,,random.SystemRandom}.



Distinto en la versión 3.5: En Linux 3.17 y versiones posteriores, la llamada al sistema @code{getrandom()} ahora se usa cuando está disponible. En OpenBSD 5.6 y posterior, ahora se usa la función C @code{getentropy()}. Estas funciones evitan el uso de un descriptor de archivo interno.



Distinto en la versión 3.5.2: En Linux, si el syscall @code{getrandom()} bloquea (el grupo de entropía urandom aún no está inicializado), recurra a la lectura @code{/dev/urandom}.



Distinto en la versión 3.6: En Linux, @code{getrandom()} ahora se usa en modo de bloqueo para aumentar la seguridad.



Distinto en la versión 3.11: En Windows, se utiliza @code{BCryptGenRandom()} en lugar de @code{CryptGenRandom()}, que está en desuso.

@end deffn

@geindex GRND_NONBLOCK (en el módulo os)
@anchor{library/os os GRND_NONBLOCK}@anchor{2c0d}
@deffn {Dato} os.GRND_NONBLOCK

Por defecto, cuando lee desde @code{/dev/random}, @ref{d45,,getrandom()} bloquea si no hay bytes aleatorios disponibles, y cuando lee desde @code{/dev/urandom}, bloquea si el grupo de entropía no tiene, sin embargo, se ha inicializado.

Si se establece el indicador @ref{2c0d,,GRND_NONBLOCK}, entonces @ref{d45,,getrandom()} no se bloquea en estos casos, sino que inmediatamente genera @ref{10d3,,BlockingIOError}.


Added in version 3.6.

@end deffn

@geindex GRND_RANDOM (en el módulo os)
@anchor{library/os os GRND_RANDOM}@anchor{2c0c}
@deffn {Dato} os.GRND_RANDOM

Si se establece este bit, los bytes aleatorios se extraen del grupo @code{/dev/random} en lugar del grupo @code{/dev/urandom}.


Added in version 3.6.

@end deffn

@node io — Core tools for working with streams,time — Time access and conversions,os — Miscellaneous operating system interfaces,Servicios genéricos del sistema operativo
@anchor{library/io doc}@anchor{2c0e}@anchor{library/io io-core-tools-for-working-with-streams}@anchor{2c0f}@anchor{library/io module-io}@anchor{7f}
@subsection @code{io} — Core tools for working with streams


@geindex module; io

`Código fuente:' Lib/io.py@footnote{https://github.com/python/cpython/tree/main/Lib/io.py}


__________________________________________________________________


@menu
* Resumen: Resumen<3>. 
* Codificación de texto:: 
* Interfaz de módulo de alto nivel:: 
* Jerarquía de clases:: 
* Rendimiento: Rendimiento<2>. 

@end menu

@node Resumen<3>,Codificación de texto,,io — Core tools for working with streams
@anchor{library/io io-overview}@anchor{217f}@anchor{library/io overview}@anchor{2c10}
@subsubsection Resumen


@geindex file object;io module

El módulo @ref{7f,,io} provee las facilidades principales de Python para manejar diferentes tipos de E/S. Hay tres diferentes tipos de E/S: `texto E/S', `binario E/S' e `E/S sin formato'. Estas son categorías generales y varios respaldos de almacenamiento se pueden usar para cada una de ellas. Un objeto concreto perteneciendo a cualquiera de estas categorías se llama un @ref{1230,,file object}. Otros términos comunes son `stream' y `file-like object'.

Independiente de su categoría, cada objeto `stream' también tendrá varias capacidades: puede ser solamente para lectura, solo escritura, or lectura y escritura. También permite arbitrariamente acceso aleatorio (buscando adelante o hacia atrás en cualquier lugar) o solamente acceso secuencial (por ejemplo en el caso de un `socket' o `pipe').

All streams are careful about the type of data you give to them.  For example
giving a @ref{237,,str} object to the @code{write()} method of a binary stream
will raise a @ref{228,,TypeError}.  So will giving a @ref{325,,bytes} object to the
@code{write()} method of a text stream.


Distinto en la versión 3.3: Operaciones que lanzarán un @ref{10ce,,IOError} ahora lanzan @ref{4d5,,OSError}, ya que @ref{10ce,,IOError} es un alias de @ref{4d5,,OSError}.


@menu
* E/S Texto:: 
* E/S Binaria:: 
* E/S sin formato:: 

@end menu

@node E/S Texto,E/S Binaria,,Resumen<3>
@anchor{library/io text-i-o}@anchor{2c11}
@subsubsection E/S Texto


E/S de tipo texto espera y produce objetos de clase @ref{237,,str}. Esto significa que cuando el respaldo de almacenamiento está compuesto de forma nativa de `bytes' (como en el caso de un archivo), la codificación y descodificación de datos está hecho de forma transparente tanto como traducción opcional de caracteres de nueva línea específicos de la plataforma.

The easiest way to create a text stream is with @ref{1be,,open()}, optionally
specifying an encoding:

@example
f = open("myfile.txt", "r", encoding="utf-8")
@end example

`Streams' de texto en memoria también están disponibles como objetos de tipo @ref{fa9,,StringIO}:

@example
f = io.StringIO("some initial text data")
@end example

El `API' (interfaz de programación de aplicaciones) de `streams' tipo texto está descrito con detalle en la documentación de @ref{736,,TextIOBase}.

@node E/S Binaria,E/S sin formato,E/S Texto,Resumen<3>
@anchor{library/io binary-i-o}@anchor{2c12}
@subsubsection E/S Binaria


E/S binaria (también conocido como `buffered E/S') espera @ref{db4,,objetos tipo bytes} y produce objetos tipo @ref{325,,bytes}. No se hace codificación, descodificación, o traducciones de nueva línea. Esta categoría de `streams' puede ser usada para todos tipos de datos sin texto, y también cuando se desea control manual sobre el manejo de dato textual.

The easiest way to create a binary stream is with @ref{1be,,open()} with @code{'b'} in
the mode string:

@example
f = open("myfile.jpg", "rb")
@end example

Los `streams' binarios en memoria también están disponibles como objetos tipo @ref{f25,,BytesIO}:

@example
f = io.BytesIO(b"some initial binary data: \x00\x01")
@end example

El `API' de `stream' binario está descrito con detalle en la documentación de @ref{735,,BufferedIOBase}.

Otros módulos bibliotecarios pueden proveer maneras alternativas para crear `streams' de tipo texto o binario. Ver @ref{120e,,socket.socket.makefile()} como ejemplo.

@node E/S sin formato,,E/S Binaria,Resumen<3>
@anchor{library/io raw-i-o}@anchor{2c13}
@subsubsection E/S sin formato


E/S sin formato (también conocido como `unbuffered E/S') es generalmente usado como un fundamento de nivel bajo para `streams' binario y tipo texto; es raramente útil para manipular directamente `streams' sin formatos del código de usuario. Sin embargo puedes crear un `stream' sin formato abriendo un archivo en modo binario con el búfer apagado:

@example
f = open("myfile.jpg", "rb", buffering=0)
@end example

El `API' de `streams' sin formato está descrito con detalle en la documentación de @ref{1144,,RawIOBase}.

@node Codificación de texto,Interfaz de módulo de alto nivel,Resumen<3>,io — Core tools for working with streams
@anchor{library/io io-text-encoding}@anchor{856}@anchor{library/io text-encoding}@anchor{2c14}
@subsubsection Codificación de texto


The default encoding of @ref{854,,TextIOWrapper} and @ref{1be,,open()} is
locale-specific (@ref{1d3,,locale.getencoding()}).

Sin embargo, muchos desarrolladores olvidan especificar la codificación al abrir archivos de texto codificados en UTF-8 (por ejemplo, JSON, TOML, Markdown, etc.) ya que la mayoría de las plataformas Unix usan la configuración regional UTF-8 de forma predeterminada. Esto causa errores porque la codificación local no es UTF-8 para la mayoría de los usuarios de Windows. Por ejemplo:

@example
# May not work on Windows when non-ASCII characters in the file.
with open("README.md") as f:
    long_description = f.read()
@end example

Accordingly, it is highly recommended that you specify the encoding
explicitly when opening text files. If you want to use UTF-8, pass
@code{encoding="utf-8"}. To use the current locale encoding,
@code{encoding="locale"} is supported since Python 3.10.


@subsubheading Ver también



@table @asis

@item @ref{6f7,,Modo Python UTF-8}

El modo UTF-8 de Python se puede utilizar para cambiar la codificación predeterminada a UTF-8 desde la codificación específica de la configuración regional.

@geindex Python Enhancement Proposals; PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 hará que @ref{6f7,,Modo Python UTF-8} sea el valor predeterminado.
@end table


@menu
* EncodingWarning opcional:: 

@end menu

@node EncodingWarning opcional,,,Codificación de texto
@anchor{library/io io-encoding-warning}@anchor{1d5b}@anchor{library/io opt-in-encodingwarning}@anchor{2c15}
@subsubsection EncodingWarning opcional



Added in version 3.10: Consulte 
@geindex Python Enhancement Proposals; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/} para más detalles.


To find where the default locale encoding is used, you can enable
the @ref{2e2,,-X warn_default_encoding} command line option or set the
@geindex PYTHONWARNDEFAULTENCODING
@geindex variables de entorno; PYTHONWARNDEFAULTENCODING
@ref{855,,PYTHONWARNDEFAULTENCODING} environment variable, which will
emit an @ref{1d43,,EncodingWarning} when the default encoding is used.

Si está proporcionando una API que usa @ref{1be,,open()} o @ref{854,,TextIOWrapper} y pasa @code{encoding=None} como parámetro, puede usar @ref{16d0,,text_encoding()} para que las personas que llaman a la API emitan un @ref{1d43,,EncodingWarning} si no pasan un @code{encoding}. Sin embargo, considere usar UTF-8 de forma predeterminada (es decir, @code{encoding="utf-8"}) para las nuevas API.

@node Interfaz de módulo de alto nivel,Jerarquía de clases,Codificación de texto,io — Core tools for working with streams
@anchor{library/io high-level-module-interface}@anchor{2c16}
@subsubsection Interfaz de módulo de alto nivel


@geindex DEFAULT_BUFFER_SIZE (en el módulo io)
@anchor{library/io io DEFAULT_BUFFER_SIZE}@anchor{16d1}
@deffn {Dato} io.DEFAULT_BUFFER_SIZE

Un `int' que contiene el búfer de tamaño predeterminado usado por las clases de tipo E/S. @ref{1be,,open()} utiliza el `blksize' del archivo (obtenido por @ref{548,,os.stat()}) si es posible.
@end deffn

@geindex open() (en el módulo io)
@anchor{library/io io open}@anchor{5c0}
@deffn {Función} io.open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Esto es un alias para la función incorporada @ref{1be,,open()}.


This function raises an @ref{18c3,,auditing event} @code{open} with
arguments `path', `mode' and `flags'. The `mode' and `flags'
arguments may have been modified or inferred from the original call.

@end deffn

@geindex open_code() (en el módulo io)
@anchor{library/io io open_code}@anchor{172e}
@deffn {Función} io.open_code (path)

Abre el archivo dado con el modo @code{'rb'}. Esta función debe ser usado cuando la intención es tratar el contenido como código ejecutable.

`path' should be a @ref{237,,str} and an absolute path.

The behavior of this function may be overridden by an earlier call to the
@ref{1730,,PyFile_SetOpenCodeHook()}. However, assuming that `path' is a
@ref{237,,str} and an absolute path, @code{open_code(path)} should always behave
the same as @code{open(path, 'rb')}. Overriding the behavior is intended for
additional validation or preprocessing of the file.


Added in version 3.8.

@end deffn

@geindex text_encoding() (en el módulo io)
@anchor{library/io io text_encoding}@anchor{16d0}
@deffn {Función} io.text_encoding (encoding, stacklevel=2, /)

Esta es una función auxiliar para personas que llaman que usan @ref{1be,,open()} o @ref{854,,TextIOWrapper} y tienen un parámetro @code{encoding=None}.

This function returns `encoding' if it is not @code{None}.
Otherwise, it returns @code{"locale"} or @code{"utf-8"} depending on
@ref{6f7,,UTF-8 Mode}.

This function emits an @ref{1d43,,EncodingWarning} if
@ref{72d,,sys.flags.warn_default_encoding} is true and `encoding'
is @code{None}. `stacklevel' specifies where the warning is emitted.
For example:

@example
def read_text(path, encoding=None):
    encoding = io.text_encoding(encoding)  # stacklevel=2
    with open(path, encoding) as f:
        return f.read()
@end example

En este ejemplo, se emite un @ref{1d43,,EncodingWarning} para el llamador de @code{read_text()}.

Consulte @ref{856,,Codificación de texto} para obtener más información.


Added in version 3.10.



Distinto en la versión 3.11: @ref{16d0,,text_encoding()} retornará «utf-8» cuando esté habilitado el modo UTF-8 y el `encoding' es @code{None}.

@end deffn

@geindex BlockingIOError
@anchor{library/io io BlockingIOError}@anchor{2c17}
@deffn {Excepción} io.BlockingIOError

Esto es un alias de compatibilidad para la incorporada excepción @ref{10d3,,BlockingIOError}.
@end deffn

@geindex UnsupportedOperation
@anchor{library/io io UnsupportedOperation}@anchor{199f}
@deffn {Excepción} io.UnsupportedOperation

Una excepción heredando @ref{4d5,,OSError} y @ref{360,,ValueError} que es generado cuando se llama a una operación no admitida en un `stream'.
@end deffn


@subsubheading Ver también



@table @asis

@item @ref{d9,,sys}

contiene los `streams' estándar de IO @ref{5df,,sys.stdin}, @ref{b61,,sys.stdout}, y @ref{9cc,,sys.stderr}.
@end table


@node Jerarquía de clases,Rendimiento<2>,Interfaz de módulo de alto nivel,io — Core tools for working with streams
@anchor{library/io class-hierarchy}@anchor{2c18}
@subsubsection Jerarquía de clases


La implementación de `streams' E/S está organizada como una jerarquía de clases. Primero @ref{1224,,abstract base classes} (ABC), que son usados para especificar las varias categorías de `streams', luego las clases concretas proveen un `stream' estándar de implementaciones.

@cartouche
@quotation Nota 
The abstract base classes also provide default implementations of some
methods in order to help implementation of concrete stream classes.  For
example, @ref{735,,BufferedIOBase} provides unoptimized implementations of
@code{readinto()} and @code{readline()}.
@end quotation
@end cartouche

En la parte superior de la jerarquía E/S está la clase abstracta base @ref{353,,IOBase}. Define la interfaz básica del `stream'. Tenga en cuenta que no hay separación entre `streams' de lectura y escritura; implementaciones están permitidos lanzar @ref{199f,,UnsupportedOperation} si no apoyan la operación.

La clase @ref{1144,,RawIOBase} extiende @ref{353,,IOBase}. Maneja la lectura y escritura de bytes a un `stream'. @ref{1378,,FileIO} subclasifica @ref{1144,,RawIOBase} para proveer una interfaz a los archivos en el sistema de archivos de la máquina.

The @ref{735,,BufferedIOBase} ABC extends @ref{353,,IOBase}.  It deals with
buffering on a raw binary stream (@ref{1144,,RawIOBase}).  Its subclasses,
@ref{2182,,BufferedWriter}, @ref{127b,,BufferedReader}, and @ref{2c19,,BufferedRWPair}
buffer raw binary streams that are writable, readable, and both readable and writable,
respectively. @ref{2183,,BufferedRandom} provides a buffered interface to seekable streams.
Another @ref{735,,BufferedIOBase} subclass, @ref{f25,,BytesIO}, is a stream of
in-memory bytes.

El @ref{736,,TextIOBase} ABC, otra subclasificación de @ref{353,,IOBase}, trata con los streams cuyos bytes representan texto, y maneja la codificación y decodificación para cadenas de caracteres y de estos mismos. @ref{854,,TextIOWrapper}, que extiende @ref{736,,TextIOBase}, es un interfaz textual almacenado un `stream' sin formato amortiguado (@ref{735,,BufferedIOBase}). Finalmente, @ref{fa9,,StringIO}  es una stream en memoria para texto.

Los nombres de los argumentos no son parte de la especificación, y solo los argumentos de @ref{1be,,open()} están destinados a ser utilizados como argumentos de palabras clave.

La siguiente tabla resume los ABC proporcionado por el módulo @ref{7f,,io} module:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ABC

@tab

Hereda

@tab

Métodos de trozos (`Stub')

@tab

Métodos mixin y propiedades

@item

@ref{353,,IOBase}

@tab

@tab

@code{fileno}, @code{seek},
and @code{truncate}

@tab

@code{close}, @code{closed}, @code{__enter__},
@code{__exit__}, @code{flush}, @code{isatty}, @code{__iter__},
@code{__next__}, @code{readable}, @code{readline},
@code{readlines}, @code{seekable}, @code{tell},
@code{writable}, and @code{writelines}

@item

@ref{1144,,RawIOBase}

@tab

@ref{353,,IOBase}

@tab

@code{readinto} and
@code{write}

@tab

Métodos @ref{353,,IOBase} heredados, @code{read}, and @code{readall}

@item

@ref{735,,BufferedIOBase}

@tab

@ref{353,,IOBase}

@tab

@code{detach}, @code{read},
@code{read1}, and @code{write}

@tab

Métodos @ref{353,,IOBase} heredados, @code{readinto}, and @code{readinto1}

@item

@ref{736,,TextIOBase}

@tab

@ref{353,,IOBase}

@tab

@code{detach}, @code{read},
@code{readline}, and
@code{write}

@tab

Métodos @ref{353,,IOBase} heredados, @code{encoding}, @code{errors}, and @code{newlines}

@end multitable


@menu
* Clases base E/S:: 
* Archivo sin formato E/S:: 
* Streams almacenados (búfer): Streams almacenados búfer. 
* E/S Texto: E/S Texto<2>. 

@end menu

@node Clases base E/S,Archivo sin formato E/S,,Jerarquía de clases
@anchor{library/io i-o-base-classes}@anchor{2c1a}
@subsubsection Clases base E/S


@geindex IOBase (clase en io)
@anchor{library/io io IOBase}@anchor{353}
@deffn {Clase} io.IOBase

La clase base abstracta para todas las clases de E/S.

Esta clase provee implementaciones abstractas vacías para muchos métodos que clases que derivadas pueden anular selectivamente; la implementación predeterminada representa un archivo que no se puede leer, grabar o ser buscado.

Even though @ref{353,,IOBase} does not declare @code{read()}
or @code{write()} because their signatures will vary, implementations and
clients should consider those methods part of the interface.  Also,
implementations may raise a @ref{360,,ValueError} (or @ref{199f,,UnsupportedOperation})
when operations they do not support are called.

El tipo básico usado para leer datos binarios o grabar un archivo es @ref{325,,bytes}. Otros @ref{db4,,bytes-like objects} son aceptados como argumentos para métodos también. Clases de tipo E/S funcionan usando datos de tipo @ref{237,,str}.

Tenga en cuenta que llamando cualquier método (incluso indagaciones) en un `stream' cerrada es indefinido. En este caso implementaciones podrían lanzar un error @ref{360,,ValueError}.

@ref{353,,IOBase} (y sus subclasificaciones) apoyan el protocolo iterador, significando que un objeto de clase @ref{353,,IOBase} puede ser iterado sobre el rendimiento de las líneas en un `stream' de datos. Líneas son definidas un poco diferente dependiendo si el `stream' es de tipo binario (produciendo `bytes'), o un `stream' de texto (produciendo cadenas de caracteres). Ver @ref{1391,,readline()} abajo.

@ref{353,,IOBase} es también un gestor de contexto y por ende apoya la declaración @ref{673,,with}. En este ejemplo, `file' es cerrado después de que la declaración @code{with} termina–incluso si alguna excepción ocurre:

@example
with open('spam.txt', 'w') as file:
    file.write('Spam and eggs!')
@end example

@ref{353,,IOBase} provee los siguientes atributos y métodos:

@geindex close() (método de io.IOBase)
@anchor{library/io io IOBase close}@anchor{354}
@deffn {Método} close ()

Cierra el `stream'. Este método no tiene efecto si el archivo ya está cerrado. Cuándo está cerrado, cualquier operación que se le haga al archivo (ej. leer or grabar) lanzará el error @ref{360,,ValueError}.

Como conveniencia, se permite llamar este método más que una vez. Sin embargo, solamente el primer llamado tenderá efecto.
@end deffn

@geindex closed (atributo de io.IOBase)
@anchor{library/io io IOBase closed}@anchor{1a33}
@deffn {Atributo} closed

@code{True} si está cerrada el `stream'.
@end deffn

@geindex fileno() (método de io.IOBase)
@anchor{library/io io IOBase fileno}@anchor{2848}
@deffn {Método} fileno ()

Retorna el descriptor de archivo subyacente (un número de tipo entero) de el `stream' si existe. Un @ref{4d5,,OSError} se lanza si el objeto IO no tiene un archivo descriptor.
@end deffn

@geindex flush() (método de io.IOBase)
@anchor{library/io io IOBase flush}@anchor{2c1b}
@deffn {Método} flush ()

Vacía los buffers de grabación del `stream' si corresponde. Esto no hace nada para `streams' que son solamente de lectura o `streams' sin bloqueo.
@end deffn

@geindex isatty() (método de io.IOBase)
@anchor{library/io io IOBase isatty}@anchor{1c89}
@deffn {Método} isatty ()

Retorna @code{True}  si el `stream' es interactiva (ej., si está conectado a un terminal o dispositivo tty).
@end deffn

@geindex readable() (método de io.IOBase)
@anchor{library/io io IOBase readable}@anchor{2c1c}
@deffn {Método} readable ()

Return @code{True} if the stream can be read from.
If @code{False}, @code{read()} will raise @ref{4d5,,OSError}.
@end deffn

@geindex readline() (método de io.IOBase)
@anchor{library/io io IOBase readline}@anchor{1391}
@deffn {Método} readline (size=-1, /)

Lee y retorna una línea del `stream'. Si `size' (tamaño) es especificado, se capturará un máximo de ése mismo tamaño especificado en `bytes'.

El terminador de la línea siempre es @code{b'\n'} para archivos de tipo binario; para archivos de tipo texto el argumento `newline' para la función @ref{1be,,open()} pueden ser usados para seleccionar las líneas terminadoras reconocidas.
@end deffn

@geindex readlines() (método de io.IOBase)
@anchor{library/io io IOBase readlines}@anchor{2336}
@deffn {Método} readlines (hint=-1, /)

Lee y retorna una lista de líneas del `stream'. `hint' puede ser especificado para controlar el número de líneas que se lee: no se leerán más líneas si el tamaño total (en `bytes' / caracteres) de todas las líneas excede `hint'.

Los valores `hint' de @code{0} o menos, así como @code{None}, se tratan como sin pista.

Note that it’s already possible to iterate on file objects using @code{for
line in file: ...} without calling @code{file.readlines()}.
@end deffn

@geindex seek() (método de io.IOBase)
@anchor{library/io io IOBase seek}@anchor{12f9}
@deffn {Método} seek (offset, whence=os.SEEK_SET, /)

Change the stream position to the given byte `offset',
interpreted relative to the position indicated by `whence',
and return the new absolute position.
Values for `whence' are:


@itemize *

@item 
@ref{12fa,,os.SEEK_SET} or @code{0} – start of the stream (the default);
`offset' should be zero or positive

@item 
@ref{12fb,,os.SEEK_CUR} or @code{1} – current stream position;
`offset' may be negative

@item 
@ref{12fc,,os.SEEK_END} or @code{2} – end of the stream;
`offset' is usually negative
@end itemize


Added in version 3.1: The @code{SEEK_*} constants.



Added in version 3.3: Some operating systems could support additional values, like
@ref{2b46,,os.SEEK_HOLE} or @ref{2b47,,os.SEEK_DATA}. The valid values
for a file could depend on it being open in text or binary mode.

@end deffn

@geindex seekable() (método de io.IOBase)
@anchor{library/io io IOBase seekable}@anchor{2c1d}
@deffn {Método} seekable ()

Retorna @code{True} si el `stream' apoya acceso aleatorio. Si retorna @code{False}, @ref{12f9,,seek()}, @ref{29aa,,tell()} y @ref{1379,,truncate()}  lanzarán @ref{4d5,,OSError}.
@end deffn

@geindex tell() (método de io.IOBase)
@anchor{library/io io IOBase tell}@anchor{29aa}
@deffn {Método} tell ()

Retorna la posición actual del `stream'.
@end deffn

@geindex truncate() (método de io.IOBase)
@anchor{library/io io IOBase truncate}@anchor{1379}
@deffn {Método} truncate (size=None, /)

Cambia el tamaño del `stream' al `size' dado en `bytes' (o la posición actual si no se especifica `size'). La posición actual del `stream' no se cambia. Este cambio de tamaño puede incrementar o reducir el tamaño actual del archivo. En caso de extensión, los contenidos del área del nuevo archivo depende de la plataforma (en la mayoría de los sistemas `bytes' adicionales son llenos de cero). Se retorna el nuevo tamaño del archivo.


Distinto en la versión 3.5: `Windows' llenará los archivos con cero cuando extienda.

@end deffn

@geindex writable() (método de io.IOBase)
@anchor{library/io io IOBase writable}@anchor{2c1e}
@deffn {Método} writable ()

Return @code{True} if the stream supports writing.  If @code{False},
@code{write()} and @ref{1379,,truncate()} will raise @ref{4d5,,OSError}.
@end deffn

@geindex writelines() (método de io.IOBase)
@anchor{library/io io IOBase writelines}@anchor{2337}
@deffn {Método} writelines (lines, /)

Escribir una lista de líneas al `stream'. No se agrega separadores de líneas, así que es usual que las líneas tengan separador al final.
@end deffn

@geindex __del__() (método de io.IOBase)
@anchor{library/io io IOBase __del__}@anchor{2c1f}
@deffn {Método} __del__ ()

Prepara para la destrucción de un objeto. @ref{353,,IOBase} proporciona una implementación dada de este método que ejecuta las instancias del método @ref{354,,close()}.
@end deffn
@end deffn

@geindex RawIOBase (clase en io)
@anchor{library/io io RawIOBase}@anchor{1144}
@deffn {Clase} io.RawIOBase

Base class for raw binary streams.  It inherits from @ref{353,,IOBase}.

Los flujos binarios sin procesar generalmente brindan acceso de bajo nivel a un dispositivo OS subyacente o API, y no intentan encapsularlos en primitivas de alto nivel (esta funcionalidad se realiza en un nivel superior en flujos binarios almacenados en búfer y flujos de texto, que se describen más adelante en esta página).

@ref{1144,,RawIOBase} proporciona estos métodos además de los de @ref{353,,IOBase}:

@geindex read() (método de io.RawIOBase)
@anchor{library/io io RawIOBase read}@anchor{ea1}
@deffn {Método} read (size=-1, /)

Lee hasta el `size' de los `bytes' del objeto y los retorna. Como conveniencia si no se especifica `size' o es -1, se retornan todos los `bytes' hasta que se retorne el fin del archivo. Sino, se hace solo un llamado al sistema. Se pueden retornar menos de `size' `bytes' si la llamada del sistema operativo retorna menos de `size' `bytes'.

Si se retorna 0 `bytes' y el `size' no era 0, esto indica que es el fin del archivo. Si el objeto está en modo sin bloqueo y no hay `bytes' disponibles, se retorna @code{None}.

La implementación dada difiera al método @ref{2c20,,readall()} y @ref{ea2,,readinto()}.
@end deffn

@geindex readall() (método de io.RawIOBase)
@anchor{library/io io RawIOBase readall}@anchor{2c20}
@deffn {Método} readall ()

Lee y retorna todos los `bytes' del `stream' hasta llegar al fin del archivo, usando, si es necesario, varias llamadas al `stream'.
@end deffn

@geindex readinto() (método de io.RawIOBase)
@anchor{library/io io RawIOBase readinto}@anchor{ea2}
@deffn {Método} readinto (b, /)

Lee `bytes' en objeto pre-asignado y grabable @ref{db4,,bytes-like object} `b', y retorna el número de `bytes' leído. Por ejemplo, `b' puede ser una clase de tipo @ref{5e0,,bytearray}. Si el objeto está en modo sin bloquear y no hay `bytes' disponibles, se retorna @code{None}.
@end deffn

@geindex write() (método de io.RawIOBase)
@anchor{library/io io RawIOBase write}@anchor{29eb}
@deffn {Método} write (b, /)

Escribe @ref{db4,,bytes-like object} dado, `b', al `stream' subyacente y retorna la cantidad de `bytes' grabadas. Esto puede ser menos que la longitud de `b' en `bytes', dependiendo de la especificaciones del `stream' subyacente, especialmente si no está en modo no-bloqueo. @code{None} se retorna si el `stream' sin formato está configurado para no bloquear y ningún `byte' puede ser rápidamente grabada. El llamador puede deshacer o mutar `b' después que retorne este método, así que la implementación solo debería acceder `b' durante la ejecución al método.
@end deffn
@end deffn

@geindex BufferedIOBase (clase en io)
@anchor{library/io io BufferedIOBase}@anchor{735}
@deffn {Clase} io.BufferedIOBase

Base class for binary streams that support some kind of buffering.
It inherits from @ref{353,,IOBase}.

La diferencia principal de @ref{1144,,RawIOBase} es que los métodos @ref{1390,,read()}, @ref{2c21,,readinto()} y @ref{d62,,write()} intentarán (respectivamente) leer la cantidad de información solicitada o consumir toda la salida dada, a expensas de hacer más de una llamada al sistema.

Adicionalmente, esos métodos pueden lanzar un @ref{10d3,,BlockingIOError} si el `stream' sin formato subyacente está en modo no bloqueo y no puede obtener or dar más datos; a diferencia de sus contrapartes @ref{1144,,RawIOBase}, estos nunca retornarán @code{None}.

Además, el método @ref{1390,,read()} no tiene una implementación dada que difiere al método @ref{2c21,,readinto()}.

Una implementación típica de @ref{735,,BufferedIOBase} no debería heredar una implementación de @ref{1144,,RawIOBase}, es más, debería envolver como uno, así como hacen las clases @ref{2182,,BufferedWriter} y @ref{127b,,BufferedReader}.

@ref{735,,BufferedIOBase} proporciona o anula estos atributos y métodos de datos además de los de @ref{353,,IOBase}:

@geindex raw (atributo de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase raw}@anchor{2c22}
@deffn {Atributo} raw

El `stream' sin formato subyacente ( una instancia @ref{1144,,RawIOBase}) que @ref{735,,BufferedIOBase} maneja. Esto no es parte de la API @ref{735,,BufferedIOBase} y posiblemente no exista en algunas implementaciones.
@end deffn

@geindex detach() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase detach}@anchor{2971}
@deffn {Método} detach ()

Separa el `stream' subyacente del búfer y lo retorna.

Luego que el `stream' sin formato ha sido separado, el búfer está en un estado inutilizable.

Algunos búfer, como @ref{f25,,BytesIO}, no tienen el concepto de un `stream' sin formato singular para retornar de este método. Lanza un @ref{199f,,UnsupportedOperation}.


Added in version 3.1.

@end deffn

@geindex read() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase read}@anchor{1390}
@deffn {Método} read (size=-1, /)

Lee y retorna hasta `size' en `bytes'. Si el argumento está omitido, @code{None}, o es negativo, los datos son leídos y retornados hasta que se alcance el fin del archivo. Un objeto @ref{325,,bytes} vacío se retorna si el `stream' está al final del archivo.

Si el argumento es positivo, y el `stream' subyacente no es interactiva, varias lecturas sin formato pueden ser otorgadas para satisfacer la cantidad de `byte' (al menos que primero se llegue al fin del archivo). Pero para los `streams' sin formato interactivas, a lo sumo una lectura sin formato será  emitida y un resultado corto no implica que se haya llegado al fin del archivo.

Un @ref{10d3,,BlockingIOError} se lanza si el `stream' subyacente está en modo no bloqueo y no tiene datos al momento.
@end deffn

@geindex read1() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase read1}@anchor{2961}
@deffn {Método} read1 (size=-1, /)

Lee y retorna hasta `size' en `bytes' con al menos una llamada al método @ref{ea1,,read()} (o @ref{ea2,,readinto()}) del `stream' subyacente. Esto puede ser útil si estás implementando tu propio búfer por encima de un objeto @ref{735,,BufferedIOBase}.

Si `size' es @code{-1} (el valor dado) se retorna un monto arbitrario de `bytes' (más que cero al menos que se haya llegado al fin del archivo).
@end deffn

@geindex readinto() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase readinto}@anchor{2c21}
@deffn {Método} readinto (b, /)

Lee `bytes' a un objeto predeterminado y grabable @ref{db4,,bytes-like object} `b' y retorna el número de `bytes' leídos. Por ejemplo, `b' puede ser un @ref{5e0,,bytearray}.

Como @ref{1390,,read()}, varias lecturas pueden ser otorgadas al `stream' sin formato subyacente al menos que esto último sea interactivo.

Un @ref{10d3,,BlockingIOError} se lanza si el `stream' subyacente está en modo no bloqueo y no tiene datos al momento.
@end deffn

@geindex readinto1() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase readinto1}@anchor{ea0}
@deffn {Método} readinto1 (b, /)

Leer `bytes' a un objeto predeterminado y grabable @ref{db4,,bytes-like object} `b' usando por lo menos una llamada al método @ref{ea1,,read()} (o @ref{ea2,,readinto()}) del `stream' subyacente. Retorna la cantidad de `bytes' leídas.

Un @ref{10d3,,BlockingIOError} se lanza si el `stream' subyacente está en modo no bloqueo y no tiene datos al momento.


Added in version 3.5.

@end deffn

@geindex write() (método de io.BufferedIOBase)
@anchor{library/io io BufferedIOBase write}@anchor{d62}
@deffn {Método} write (b, /)

Escribe el @ref{db4,,bytes-like object} dado, `b', y retorna el número de bytes grabados (siempre el equivalente en longitud de `b' en bytes, ya que si falla la grabación se lanza un @ref{4d5,,OSError}). Dependiendo en la implementación actual estos bytes pueden ser grabados rápidamente al `stream' subyacente o mantenido en un búfer por razones de rendimiento y latencia.

Cuando estás en modo no bloqueo, se lanza un @ref{10d3,,BlockingIOError} si los datos tenían que ser grabadas al `stream' sin formato pero no pudo aceptar todos los datos sin bloquear.

El llamador puede otorgar o mutar `b' después que este método retorne algo, entonces la implementación debería acceder solamente a `b' durante la llamada al método.
@end deffn
@end deffn

@node Archivo sin formato E/S,Streams almacenados búfer,Clases base E/S,Jerarquía de clases
@anchor{library/io raw-file-i-o}@anchor{2c23}
@subsubsection Archivo sin formato E/S


@geindex FileIO (clase en io)
@anchor{library/io io FileIO}@anchor{1378}
@deffn {Clase} io.FileIO (name, mode='r', closefd=True, opener=None)

A raw binary stream representing an OS-level file containing bytes data.  It
inherits from @ref{1144,,RawIOBase}.

El `name' puede ser una de dos cosas:


@itemize *

@item 
una cadena de caracteres u objeto de tipo @ref{325,,bytes} representando la ruta del archivo en la que fue abierto. En este caso `closefd' es @code{True} (el valor dado) de otra manera un error será dada.

@item 
un `integer' representando el número de descriptores de archivos de nivel OS que resultan dando acceso a través del objeto @ref{1378,,FileIO}. Cuando el objeto `FileIO' está cerrado este fd cerrará también a no ser que `closefd' esté configurado a @code{False}.
@end itemize

El `mode' puede ser @code{'r'}, @code{'w'}, @code{'x'} o @code{'a'} para lectura (el valor dado), grabación, creación exclusiva o anexando. Si no existe el archivo se creará cuando se abra para grabar o anexar; se truncará cuando se abra para grabar. Se lanzará un error @ref{109c,,FileExistsError}   si ya existe cuando se abra para crear. Abriendo un archivo para crear implica grabar entonces este modo se comporta similarmente a @code{'w'}. Agrega un @code{'+'}  al modo para permitir lectura y grabación simultáneas.

The @ref{ea1,,read()} (when called with a positive argument),
@ref{ea2,,readinto()} and @ref{29eb,,write()} methods on this
class will only make one system call.

Un abridor personalizado puede ser usado pasando un llamador como `opener'. El descriptor de archivo subyacente es obtenido llamando `opener' con (`name', `flags'). `opener' debe retornar un descriptor de archivo abierto (pasando @ref{e18,,os.open} como `opener' resulta con funcionamiento similar a pasando @code{None}).

El archivo recién creado es @ref{f7c,,non-inheritable}.

Ver la función incorporada @ref{1be,,open()} para ejemplos usando el parámetro `opener'.


Distinto en la versión 3.3: El parámetro `opener' fue agregado. El modo @code{'x'} fue agregado.



Distinto en la versión 3.4: El archivo ahora no es heredable.


@ref{1378,,FileIO} proporciona estos atributos de datos además de los de @ref{1144,,RawIOBase} y @ref{353,,IOBase}:

@geindex mode (atributo de io.FileIO)
@anchor{library/io io FileIO mode}@anchor{2c24}
@deffn {Atributo} mode

El modo dado en el constructor.
@end deffn

@geindex name (atributo de io.FileIO)
@anchor{library/io io FileIO name}@anchor{297b}
@deffn {Atributo} name

El nombre del archivo. Este es el descriptor del archivo cuando no se proporciona ningún nombre en el constructor.
@end deffn
@end deffn

@node Streams almacenados búfer,E/S Texto<2>,Archivo sin formato E/S,Jerarquía de clases
@anchor{library/io buffered-streams}@anchor{2c25}
@subsubsection `Streams' almacenados (búfer)


`Streams' E/S almacenadas (búfer) proveen una interfaz de más alto nivel a un dispositivo E/S que a un E/S sin formato.

@geindex BytesIO (clase en io)
@anchor{library/io io BytesIO}@anchor{f25}
@deffn {Clase} io.BytesIO (initial_bytes=b'@w{'})

A binary stream using an in-memory bytes buffer.  It inherits from
@ref{735,,BufferedIOBase}.  The buffer is discarded when the
@ref{354,,close()} method is called.

El argumento opcional `initial_bytes' es un @ref{db4,,bytes-like object} que contiene datos iniciales.

@ref{f25,,BytesIO} provee o anula estos métodos además de los de @ref{735,,BufferedIOBase} y @ref{353,,IOBase}:

@geindex getbuffer() (método de io.BytesIO)
@anchor{library/io io BytesIO getbuffer}@anchor{125e}
@deffn {Método} getbuffer ()

Retorna una vista legible y grabable acerca de los contenidos del búfer sin copiarlos. Además mutando la vista actualizará de forma transparente los contenidos del búfer:

@example
>>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'
@end example

@cartouche
@quotation Nota 
Mientras exista la vista el objeto @ref{f25,,BytesIO} no se le puede cambiar el tamaño o cerrado.
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex getvalue() (método de io.BytesIO)
@anchor{library/io io BytesIO getvalue}@anchor{295f}
@deffn {Método} getvalue ()

Retorna @ref{325,,bytes} que contiene los contenidos enteros del búfer.
@end deffn

@geindex read1() (método de io.BytesIO)
@anchor{library/io io BytesIO read1}@anchor{2c26}
@deffn {Método} read1 (size=-1, /)

En la clase @ref{f25,,BytesIO} esto es lo mismo que @ref{1390,,read()}.


Distinto en la versión 3.7: Ahora es opcional el argumento `size'.

@end deffn

@geindex readinto1() (método de io.BytesIO)
@anchor{library/io io BytesIO readinto1}@anchor{2c27}
@deffn {Método} readinto1 (b, /)

En la clase @ref{f25,,BytesIO} esto es lo mismo que @ref{2c21,,readinto()}.


Added in version 3.5.

@end deffn
@end deffn

@geindex BufferedReader (clase en io)
@anchor{library/io io BufferedReader}@anchor{127b}
@deffn {Clase} io.BufferedReader (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a readable, non
seekable @ref{1144,,RawIOBase} raw binary stream.  It inherits from
@ref{735,,BufferedIOBase}.

Al leer datos de este objeto, es posible que se solicite una mayor cantidad de datos del flujo sin procesar subyacente y se mantenga en un búfer interno. Los datos almacenados en búfer se pueden retornar directamente en lecturas posteriores.

El constructor crea un @ref{127b,,BufferedReader} para el `stream' legible sin formato `raw' y `buffer_size'. Si se omite `buffer_size' se usa @ref{16d1,,DEFAULT_BUFFER_SIZE}.

@ref{127b,,BufferedReader} provee o anula los métodos en adición a los de @ref{735,,BufferedIOBase} y @ref{353,,IOBase}:

@geindex peek() (método de io.BufferedReader)
@anchor{library/io io BufferedReader peek}@anchor{2c28}
@deffn {Método} peek (size=0, /)

Retorna `bytes' del `stream' sin avanzar la posición. Al menos una lectura se hace al `stream' sin formato para satisfacer el llamado. El número de bytes retornados puede ser menor o mayor al solicitado.
@end deffn

@geindex read() (método de io.BufferedReader)
@anchor{library/io io BufferedReader read}@anchor{2c29}
@deffn {Método} read (size=-1, /)

Lee y retorna `size' `bytes' o si no se da `size', o es negativo, hasta el fin del archivo o si la llamada leída podría bloquear in modo no bloquear.
@end deffn

@geindex read1() (método de io.BufferedReader)
@anchor{library/io io BufferedReader read1}@anchor{2c2a}
@deffn {Método} read1 (size=-1, /)

Lee y retorna hasta el tamaño `size' en `bytes' con solo un llamado al `stream'. Si al menos un `byte' pasa por el proceso de búfer, solo se retornan `buffered bytes'. De lo contrario se realiza un llamado de lectura de un `stream' sin formato.


Distinto en la versión 3.7: Ahora es opcional el argumento `size'.

@end deffn
@end deffn

@geindex BufferedWriter (clase en io)
@anchor{library/io io BufferedWriter}@anchor{2182}
@deffn {Clase} io.BufferedWriter (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a writeable, non
seekable @ref{1144,,RawIOBase} raw binary stream.  It inherits from
@ref{735,,BufferedIOBase}.

Al escribir en este objeto, los datos normalmente se colocan en un búfer interno. El búfer se escribirá en el objeto @ref{1144,,RawIOBase} subyacente en varias condiciones, que incluyen:


@itemize *

@item 
cuando el búfer se vuelve demasiado pequeño para todos los datos pendientes;

@item 
when @ref{2c2b,,flush()} is called;

@item 
when a @ref{12f9,,seek()} is requested (for @ref{2183,,BufferedRandom} objects);

@item 
cuando el objeto @ref{2182,,BufferedWriter} is cerrado o anulado.
@end itemize

El constructor crea un @ref{2182,,BufferedWriter} para el `stream' grabable `raw'. Si no es dado el `buffer_size', recurre el valor @ref{16d1,,DEFAULT_BUFFER_SIZE}.

@ref{2182,,BufferedWriter} provee o anula estos métodos además de los de @ref{735,,BufferedIOBase} y @ref{353,,IOBase}:

@geindex flush() (método de io.BufferedWriter)
@anchor{library/io io BufferedWriter flush}@anchor{2c2b}
@deffn {Método} flush ()

Forzar bytes retenidos en el búfer al `stream' sin formato. Un @ref{10d3,,BlockingIOError} debería ser lanzado si el `stream' sin formato bloquea.
@end deffn

@geindex write() (método de io.BufferedWriter)
@anchor{library/io io BufferedWriter write}@anchor{2c2c}
@deffn {Método} write (b, /)

Escribe el @ref{db4,,bytes-like object}, `b', y retorna el número de bytes grabados. Cuando estás en modo no-bloqueo, se lanza un @ref{10d3,,BlockingIOError} si el búfer tiene que ser escrito pero el `stream' sin formato bloquea.
@end deffn
@end deffn

@geindex BufferedRandom (clase en io)
@anchor{library/io io BufferedRandom}@anchor{2183}
@deffn {Clase} io.BufferedRandom (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a seekable
@ref{1144,,RawIOBase} raw binary stream.  It inherits from @ref{127b,,BufferedReader}
and @ref{2182,,BufferedWriter}.

El constructor crea un lector y una grabación para un `stream' sin formato buscable, dado en el primer argumento. Si se omite el `buffer_size' este recae sobre el valor predeterminado @ref{16d1,,DEFAULT_BUFFER_SIZE}.

@ref{2183,,BufferedRandom} is capable of anything @ref{127b,,BufferedReader} or
@ref{2182,,BufferedWriter} can do.  In addition, @ref{12f9,,seek()} and
@ref{29aa,,tell()} are guaranteed to be implemented.
@end deffn

@geindex BufferedRWPair (clase en io)
@anchor{library/io io BufferedRWPair}@anchor{2c19}
@deffn {Clase} io.BufferedRWPair (reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)

A buffered binary stream providing higher-level access to two non seekable
@ref{1144,,RawIOBase} raw binary streams—one readable, the other writeable.
It inherits from @ref{735,,BufferedIOBase}.

`reader' y `writer' son objetos @ref{1144,,RawIOBase} que son respectivamente legibles y escribibles. Si se omite `buffer_size' este se recae sobre el valor predeterminado @ref{16d1,,DEFAULT_BUFFER_SIZE}.

@ref{2c19,,BufferedRWPair} implementa todos los métodos de @ref{735,,BufferedIOBase} excepto por @ref{2971,,detach()}, que lanza un @ref{199f,,UnsupportedOperation}.

@cartouche
@quotation Advertencia 
@ref{2c19,,BufferedRWPair} no intenta sincronizar accesos al `stream' sin formato subyacente. No debes pasar el mismo objeto como legible y escribible; usa @ref{2183,,BufferedRandom} en su lugar.
@end quotation
@end cartouche
@end deffn

@node E/S Texto<2>,,Streams almacenados búfer,Jerarquía de clases
@anchor{library/io id1}@anchor{2c2d}
@subsubsection E/S Texto


@geindex TextIOBase (clase en io)
@anchor{library/io io TextIOBase}@anchor{736}
@deffn {Clase} io.TextIOBase

Base class for text streams.  This class provides a character and line based
interface to stream I/O.  It inherits from @ref{353,,IOBase}.

@ref{736,,TextIOBase} provee o anula estos atributos y métodos de datos además de los de @ref{353,,IOBase}:

@geindex encoding (atributo de io.TextIOBase)
@anchor{library/io io TextIOBase encoding}@anchor{2c2e}
@deffn {Atributo} encoding

El nombre de la codificación utilizada para decodificar los `bytes' del `stream' a cadenas de caracteres y para codificar cadenas de caracteres en bytes.
@end deffn

@geindex errors (atributo de io.TextIOBase)
@anchor{library/io io TextIOBase errors}@anchor{1377}
@deffn {Atributo} errors

La configuración de error del decodificador o codificador.
@end deffn

@geindex newlines (atributo de io.TextIOBase)
@anchor{library/io io TextIOBase newlines}@anchor{2c2f}
@deffn {Atributo} newlines

Una cadena de caracteres, una tupla de cadena de caracteres, o @code{None}, indicando las nuevas líneas traducidas hasta ese momento. Dependiendo de la implementación y los indicadores iniciales del constructor, esto puede no estar disponible.
@end deffn

@geindex buffer (atributo de io.TextIOBase)
@anchor{library/io io TextIOBase buffer}@anchor{130e}
@deffn {Atributo} buffer

El búfer binario subyacente (una instancia @ref{735,,BufferedIOBase}) que maneja @ref{736,,TextIOBase}. Esto no es parte del API de @ref{736,,TextIOBase} y puede no existir en algunas implementaciones.
@end deffn

@geindex detach() (método de io.TextIOBase)
@anchor{library/io io TextIOBase detach}@anchor{2c30}
@deffn {Método} detach ()

Separa el búfer binario subyacente de @ref{736,,TextIOBase} y lo retorna.

Una vez que se ha separado el búfer subyacente, la @ref{736,,TextIOBase} está en un estado inutilizable.

Algunas implementaciones de @ref{736,,TextIOBase}, como @ref{fa9,,StringIO}, puede no tener el concepto de un búfer subyacente y llamar a este método se lanzará @ref{199f,,UnsupportedOperation}.


Added in version 3.1.

@end deffn

@geindex read() (método de io.TextIOBase)
@anchor{library/io io TextIOBase read}@anchor{1c8c}
@deffn {Método} read (size=-1, /)

Lee y retorna como máximo `size' caracteres del `stream' como un @ref{237,,str} singular. Si `size' es negativo o @code{None}, lee hasta llegar al fin del archivo.
@end deffn

@geindex readline() (método de io.TextIOBase)
@anchor{library/io io TextIOBase readline}@anchor{1cc4}
@deffn {Método} readline (size=-1, /)

Read until newline or EOF and return a single @ref{237,,str}.  If the stream is
already at EOF, an empty string is returned.

Si se especifica `size' como máximo `size' de caracteres será leído.
@end deffn

@geindex seek() (método de io.TextIOBase)
@anchor{library/io io TextIOBase seek}@anchor{2c31}
@deffn {Método} seek (offset, whence=SEEK_SET, /)

Change the stream position to the given `offset'.  Behaviour depends on
the `whence' parameter.  The default value for `whence' is
@code{SEEK_SET}.


@itemize *

@item 
@code{SEEK_SET} or @code{0}: seek from the start of the stream
(the default); `offset' must either be a number returned by
@ref{2c32,,TextIOBase.tell()}, or zero.  Any other `offset' value
produces undefined behaviour.

@item 
@code{SEEK_CUR} or @code{1}: «seek» to the current position;
`offset' must be zero, which is a no-operation (all other values
are unsupported).

@item 
@code{SEEK_END} or @code{2}: seek to the end of the stream;
`offset' must be zero (all other values are unsupported).
@end itemize

Retorna la nueva posición absoluta como un número opaco.


Added in version 3.1: The @code{SEEK_*} constants.

@end deffn

@geindex tell() (método de io.TextIOBase)
@anchor{library/io io TextIOBase tell}@anchor{2c32}
@deffn {Método} tell ()

Retorna la posición actual de la secuencia como un número opaco. El número no suele representar una cantidad de bytes en el almacenamiento binario subyacente.
@end deffn

@geindex write() (método de io.TextIOBase)
@anchor{library/io io TextIOBase write}@anchor{1c7a}
@deffn {Método} write (s, /)

Escribe la cadena de caracteres `s' al `stream' y retorna el número de caracteres grabadas.
@end deffn
@end deffn

@geindex TextIOWrapper (clase en io)
@anchor{library/io io TextIOWrapper}@anchor{854}
@deffn {Clase} io.TextIOWrapper (buffer, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)

A buffered text stream providing higher-level access to a
@ref{735,,BufferedIOBase} buffered binary stream.  It inherits from
@ref{736,,TextIOBase}.

`encoding' gives the name of the encoding that the stream will be decoded or
encoded with.  It defaults to @ref{1d3,,locale.getencoding()}.
@code{encoding="locale"} can be used to specify the current locale’s encoding
explicitly. See @ref{856,,Codificación de texto} for more information.

`errors' es una cadena de caracteres opcional que especifica cómo se manejan los errores codificados y descodificados. Pasa @code{'strict'} para lanzar una excepción @ref{360,,ValueError} si hay un error codificado (el valor predeterminado @code{None} tiene el mismo efecto), o pasa @code{'ignore'} para ignorar errores. (Tenga en cuenta que ignorar errores puede llevar a perder datos). @code{'replace'} causa un marcador de reemplazo (como @code{'?'}) para ser insertado donde haya datos mal formados. @code{'backslashreplace'} reemplaza datos mal formados con una secuencia de escape de tipo barra invertida. Cuando se escribe, @code{'xmlcharrefreplace'}  (reemplazar con la referencia apropiada de XML) o @code{'namereplace'} (reemplazar con secuencias de caracteres @code{\N@{…@}}) pueden ser usadas. Cualquier otro nombre de manejador de errores que hayan sido registrados con @ref{14d5,,codecs.register_error()} también son validas.

@geindex universal newlines;io.TextIOWrapper class

`newline' controla cómo finalizar las terminaciones de líneas. Pueden ser @code{None}, @code{'@w{'}}, @code{'\n'}, @code{'\r'}, and @code{'\r\n'}. Funciona de la siguiente manera:


@itemize *

@item 
Al leer la entrada de la secuencia, si `newline' es @code{None}, el modo @ref{dc1,,universal newlines} está habilitado. Las líneas de la entrada pueden terminar en @code{'\n'}, @code{'\r'} o @code{'\r\n'}, y se traducen a @code{'\n'} antes de retornarse al llamador. Si `newline' es @code{'@w{'}}, el modo de salto de línea universal está habilitado, pero los finales de línea se retornan a la persona que llama sin traducir. Si `newline' tiene alguno de los otros valores legales, las líneas de entrada solo terminan con la cadena dada y la línea final se retorna al llamador sin traducir.

@item 
Al escribir la salida al `stream', si `newline' es @code{None}, cualquier carácter @code{'\n'} escrito son traducidos a la línea separador `default' del sistema, @ref{2181,,os.linesep}. Si `newline' es @code{'@w{'}} o @code{'\n'}, la traducción no ocurre. Si `newline' es de cualquier de los otros valores legales, cualquier carácter @code{'\n'} escrito es traducido a la cadena de caracteres dada.
@end itemize

If `line_buffering' is @code{True}, @ref{2c1b,,flush()} is implied when a call to
write contains a newline character or a carriage return.

If `write_through' is @code{True}, calls to @ref{d62,,write()} are guaranteed
not to be buffered: any data written on the @ref{854,,TextIOWrapper}
object is immediately handled to its underlying binary `buffer'.


Distinto en la versión 3.3: Se ha agregado el argumento `write_through'.



Distinto en la versión 3.3: La codificación (`encoding') por defecto es ahora @code{locale.getpreferredencoding(False)} en vez de @code{locale.getpreferredencoding()}. No cambie temporalmente la codificación local usando @ref{1d2,,locale.setlocale()}, use la codificación local actual en vez del preferido del usuario.



Distinto en la versión 3.10: El argumento `encoding' ahora admite el nombre de codificación ficticia @code{"locale"}.


@ref{854,,TextIOWrapper} proporciona estos atributos y métodos de datos además de los de @ref{736,,TextIOBase} y @ref{353,,IOBase}:

@geindex line_buffering (atributo de io.TextIOWrapper)
@anchor{library/io io TextIOWrapper line_buffering}@anchor{2c33}
@deffn {Atributo} line_buffering

Si el almacenamiento en línea está habilitado.
@end deffn

@geindex write_through (atributo de io.TextIOWrapper)
@anchor{library/io io TextIOWrapper write_through}@anchor{2c34}
@deffn {Atributo} write_through

Si grabaciones son pasadas inmediatamente al búfer binario subyacente.


Added in version 3.7.

@end deffn

@geindex reconfigure() (método de io.TextIOWrapper)
@anchor{library/io io TextIOWrapper reconfigure}@anchor{bd1}
@deffn {Método} reconfigure (*, encoding=None, errors=None, newline=None, line_buffering=None, write_through=None)

Reconfigura este `stream' textual usando las nuevas configuraciones de `encoding', `errors', `newline', `line_buffering' y `write_through'.

Los parámetros que no son especificados mantienen las configuraciones actuales, excepto por @code{errors='strict'} cuando `encoding' se especifica pero `errors' no está especificado.

No es posible cambiar la codificación o nueva línea si algunos datos han sido captados por el `stream'. Sin embargo, cambiando la codificación después de grabar es posible.

Este método hace una nivelación implícita del `stream' antes de configurar los nuevos parámetros.


Added in version 3.7.



Distinto en la versión 3.11: El método admite la opción @code{encoding="locale"}.

@end deffn

@geindex seek() (método de io.TextIOWrapper)
@anchor{library/io io TextIOWrapper seek}@anchor{2c35}
@deffn {Método} seek (cookie, whence=os.SEEK_SET, /)

Set the stream position.
Return the new stream position as an @ref{1f0,,int}.

Four operations are supported,
given by the following argument combinations:


@itemize *

@item 
@code{seek(0, SEEK_SET)}: Rewind to the start of the stream.

@item 
@code{seek(cookie, SEEK_SET)}: Restore a previous position;
`cookie' `must be' a number returned by @ref{2c36,,tell()}.

@item 
@code{seek(0, SEEK_END)}: Fast-forward to the end of the stream.

@item 
@code{seek(0, SEEK_CUR)}: Leave the current stream position unchanged.
@end itemize

Any other argument combinations are invalid,
and may raise exceptions.


@subsubheading Ver también


@ref{12fa,,os.SEEK_SET}, @ref{12fb,,os.SEEK_CUR}, and @ref{12fc,,os.SEEK_END}.

@end deffn

@geindex tell() (método de io.TextIOWrapper)
@anchor{library/io io TextIOWrapper tell}@anchor{2c36}
@deffn {Método} tell ()

Return the stream position as an opaque number.
The return value of @code{tell()} can be given as input to @ref{2c35,,seek()},
to restore a previous stream position.
@end deffn
@end deffn

@geindex StringIO (clase en io)
@anchor{library/io io StringIO}@anchor{fa9}
@deffn {Clase} io.StringIO (initial_value='@w{'}, newline='\n')

A text stream using an in-memory text buffer.  It inherits from
@ref{736,,TextIOBase}.

El búfer de texto se descarta cuando se llama al método @ref{354,,close()}.

El valor inicial del búfer se puede establecer proporcionando `initial_value'. Si la traducción de nuevas líneas está habilitada, las nuevas líneas se codificarán como si fueran @ref{1c7a,,write()}. La secuencia se coloca al comienzo del búfer que emula la apertura de un archivo existente en un modo @code{w+} , preparándolo para una escritura inmediata desde el principio o para una escritura que sobrescribiría el valor inicial. Para emular la apertura de un archivo en un modo @code{a+} listo para anexar, use @code{f.seek(0, io.SEEK_END)} para reponer la secuencia al final del búfer.

El argumento `newline' funciona como el de la clase @ref{854,,TextIOWrapper}, excepto que cuando escribe al flujo de salida, si `newline' es @code{None}, se escriben líneas nuevas como @code{\n} en todas las plataformas

@ref{fa9,,StringIO} proporciona este método además de los de @ref{736,,TextIOBase} y @ref{353,,IOBase}:

@geindex getvalue() (método de io.StringIO)
@anchor{library/io io StringIO getvalue}@anchor{2c37}
@deffn {Método} getvalue ()

Return a @ref{237,,str} containing the entire contents of the buffer.
Newlines are decoded as if by @ref{1c8c,,read()}, although
the stream position is not changed.
@end deffn

Ejemplos de uso:

@example
import io

output = io.StringIO()
output.write('First line.\n')
print('Second line.', file=output)

# Retrieve file contents -- this will be
# 'First line.\nSecond line.\n'
contents = output.getvalue()

# Close object and discard memory buffer --
# .getvalue() will now raise an exception.
output.close()
@end example
@end deffn

@geindex universal newlines;io.IncrementalNewlineDecoder class

@geindex IncrementalNewlineDecoder (clase en io)
@anchor{library/io io IncrementalNewlineDecoder}@anchor{16d2}
@deffn {Clase} io.IncrementalNewlineDecoder

A helper codec that decodes newlines for @ref{dc1,,universal newlines} mode.
It inherits from @ref{23cb,,codecs.IncrementalDecoder}.
@end deffn

@node Rendimiento<2>,,Jerarquía de clases,io — Core tools for working with streams
@anchor{library/io performance}@anchor{2c38}
@subsubsection Rendimiento


Esta sección discute el rendimiento de las implementaciones concretas de E/S proporcionadas.

@menu
* E/S Binaria: E/S Binaria<2>. 
* E/S Texto: E/S Texto<3>. 
* Multihilo:: 
* Reentrada:: 

@end menu

@node E/S Binaria<2>,E/S Texto<3>,,Rendimiento<2>
@anchor{library/io id2}@anchor{2c39}
@subsubsection E/S Binaria


Leyendo y grabando solamente grandes porciones de datos incluso cuando el usuario pide para solo un byte, E/S de tipo búfer esconde toda ineficiencia llamando y ejecutando las rutinas E/S del sistema operativo que no ha pasado por el proceso de búfer. La ganancia depende en el OS y el tipo de E/S que se ejecuta. Por ejemplo, en algunos sistemas operativos modernos como Linux, un disco E/S sin búfer puede ser rápido como un E/S búfer. Al final, sin embargo, es que el E/S búfer ofrece rendimiento predecible independientemente de la plataforma y el dispositivo de respaldo. Entonces es siempre preferible user E/S búfer que E/S sin búfer para datos binarios.

@node E/S Texto<3>,Multihilo,E/S Binaria<2>,Rendimiento<2>
@anchor{library/io id3}@anchor{2c3a}
@subsubsection E/S Texto


Text I/O over a binary storage (such as a file) is significantly slower than
binary I/O over the same storage, because it requires conversions between
unicode and binary data using a character codec.  This can become noticeable
handling huge amounts of text data like large log files.  Also,
@ref{2c32,,tell()} and @ref{2c31,,seek()} are both quite slow
due to the reconstruction algorithm used.

@ref{fa9,,StringIO}, sin embargo, es un contenedor unicode nativo en memoria y exhibirá una velocidad similar a @ref{f25,,BytesIO}.

@node Multihilo,Reentrada,E/S Texto<3>,Rendimiento<2>
@anchor{library/io multi-threading}@anchor{2c3b}
@subsubsection Multihilo


@ref{1378,,FileIO} objects are thread-safe to the extent that the operating system
calls (such as @code{read(2)@footnote{https://manpages.debian.org/read(2)}} under Unix) they wrap are thread-safe too.

Objetos binarios búfer (instancias de @ref{127b,,BufferedReader}, @ref{2182,,BufferedWriter}, @ref{2183,,BufferedRandom} y @ref{2c19,,BufferedRWPair}) protegen sus estructuras internas usando un bloqueo; es seguro, entonces, llamarlos de varios hilos a la vez.

objetos @ref{854,,TextIOWrapper} no son seguros para subprocesos.

@node Reentrada,,Multihilo,Rendimiento<2>
@anchor{library/io reentrancy}@anchor{2c3c}
@subsubsection Reentrada


Objetos binarios búfer (instancias de @ref{127b,,BufferedReader}, @ref{2182,,BufferedWriter}, @ref{2183,,BufferedRandom} y @ref{2c19,,BufferedRWPair}) no son reentrante. Mientras llamadas reentrantes no ocurren en situaciones normales pueden surgir haciendo E/S en un manejador @ref{c6,,signal}. Si un hilo trata de entrar de nuevo a un objeto búfer que se está accediendo actualmente, se lanza un @ref{1e5,,RuntimeError}. Tenga en cuenta que esto no prohíbe un hilo diferente entrando un objeto búfer.

The above implicitly extends to text files, since the @ref{1be,,open()} function
will wrap a buffered object inside a @ref{854,,TextIOWrapper}.  This includes
standard streams and therefore affects the built-in @ref{ff4,,print()} function as
well.

@node time — Time access and conversions,argparse — Parser for command-line options arguments and subcommands,io — Core tools for working with streams,Servicios genéricos del sistema operativo
@anchor{library/time doc}@anchor{2c3d}@anchor{library/time module-time}@anchor{ee}@anchor{library/time time-time-access-and-conversions}@anchor{2c3e}
@subsection @code{time} — Time access and conversions


@geindex module; time


__________________________________________________________________


Este módulo proporciona varias funciones relacionadas con el tiempo. Para la funcionalidad relacionada, consulte también los módulos @ref{31,,datetime} y @ref{15,,calendar}.

Aunque este módulo siempre está disponible, no todas las funciones están disponibles en todas las plataformas.  La mayoría de las funciones definidas en este módulo llaman a funciones C de la biblioteca de la plataforma con el mismo nombre.  A veces puede ser útil consultar la documentación de la plataforma, ya que la semántica de estas funciones varía entre plataformas.

Una explicación de algunas terminologías y convenciones está en orden.

@geindex epoch
@anchor{library/time epoch}@anchor{2a1f}

@itemize *

@item 
Una `epoch' es el punto en el cual el tiempo empieza, el valor retorno de la función @code{time.gmtime(0)}. El cual es Enero, 1, 1970, 00:00:00(UTC) en todas las plataformas.
@end itemize

@geindex segundos desde la época


@itemize *

@item 
El término `seconds since the epoch' se refiere al número total de segundos transcurridos desde la época, excluyendo típicamente leap seconds@footnote{https://en.wikipedia.org/wiki/Leap_second} . Los segundos intercalares se excluyen de este total en todas las plataformas compatibles con POSIX.
@end itemize

@geindex Year 2038


@itemize *

@item 
The functions in this module may not handle dates and times before the @ref{2a1f,,epoch} or
far in the future.  The cut-off point in the future is determined by the C
library; for 32-bit systems, it is typically in 2038.
@end itemize

@geindex 2-digit years


@itemize *

@item 
La función @ref{146c,,strptime()} puede analizar años de 2 dígitos cuando se le da el código de formato @code{%y}. Cuando se analizan los años de 2 dígitos, se convierten de acuerdo con los estándares POSIX e ISO C: los valores 69–99 se asignan a 1969–1999, y los valores 0–68 se asignan a 2000–2068.
@end itemize

@geindex UTC
@geindex Coordinated Universal Time
@geindex Greenwich Mean Time


@itemize *

@item 
UTC es la hora universal coordinada (anteriormente conocida como hora media de Greenwich, o GMT). El acrónimo UTC no es un error, sino un compromiso entre inglés y francés.
@end itemize

@geindex Daylight Saving Time


@itemize *

@item 
El horario de verano es el horario de verano, un ajuste de la zona horaria por (generalmente) una hora durante parte del año. Las reglas DST son mágicas (determinadas por la ley local) y pueden cambiar de un año a otro. La biblioteca C tiene una tabla que contiene las reglas locales (a menudo se lee desde un archivo del sistema para flexibilidad) y es la única fuente de verdadera sabiduría en este sentido.

@item 
La precisión de las diversas funciones en tiempo real puede ser inferior a la sugerida por las unidades en las que se expresa su valor o argumento. P.ej. En la mayoría de los sistemas Unix, el reloj «funciona» solo 50 o 100 veces por segundo.

@item 
On the other hand, the precision of @ref{3ad,,time()} and @ref{73e,,sleep()} is better
than their Unix equivalents: times are expressed as floating-point numbers,
@ref{3ad,,time()} returns the most accurate time available (using Unix
@code{gettimeofday()} where available), and @ref{73e,,sleep()} will accept a time
with a nonzero fraction (Unix @code{select()} is used to implement this, where
available).

@item 
El valor de tiempo retornado por @ref{122d,,gmtime()}, @ref{1539,,localtime()}, y @ref{146c,,strptime()}, y aceptado por @ref{1254,,asctime()}, @ref{1255,,mktime()} y @ref{1256,,strftime()}, es una secuencia de 9 enteros. Los valores de retorno de @ref{122d,,gmtime()}, @ref{1539,,localtime()}, y @ref{146c,,strptime()} también ofrecen nombres de atributos para campos individuales.

Ver @ref{d71,,struct_time} para una descripción de estos objetos.


Distinto en la versión 3.3: The @ref{d71,,struct_time} type was extended to provide
the @ref{2c3f,,tm_gmtoff} and @ref{2c40,,tm_zone}
attributes when platform supports corresponding
@code{struct tm} members.



Distinto en la versión 3.6: The @ref{d71,,struct_time} attributes
@ref{2c3f,,tm_gmtoff} and @ref{2c40,,tm_zone}
are now available on all platforms.


@item 
Use las siguientes funciones para convertir entre representaciones de tiempo:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Desde

@tab

A

@tab

Usar

@item

segundos desde la época

@tab

@ref{d71,,struct_time} en UTC

@tab

@ref{122d,,gmtime()}

@item

segundos desde la época

@tab

@ref{d71,,struct_time} en hora local

@tab

@ref{1539,,localtime()}

@item

@ref{d71,,struct_time} en UTC

@tab

segundos desde la época

@tab

@ref{24d2,,calendar.timegm()}

@item

@ref{d71,,struct_time} en hora local

@tab

segundos desde la época

@tab

@ref{1255,,mktime()}

@end multitable

@end itemize

@menu
* Las Funciones:: 
* Constantes de ID de reloj:: 
* Constantes de zona horaria:: 

@end menu

@node Las Funciones,Constantes de ID de reloj,,time — Time access and conversions
@anchor{library/time functions}@anchor{2c41}@anchor{library/time time-functions}@anchor{2c42}
@subsubsection Las Funciones


@geindex asctime() (en el módulo time)
@anchor{library/time time asctime}@anchor{1254}
@deffn {Función} time.asctime ([t])

Convierta una tupla o @ref{d71,,struct_time} que represente una hora retornada por @ref{122d,,gmtime()} o @ref{1539,,localtime()} en una cadena de la siguiente forma: @code{'Dom 20 de junio 23:21:05 1993'}. El campo del día tiene dos caracteres de largo y se rellena con espacio si el día es un solo dígito, por ejemplo: @code{'Miercoles  9 de Julio 04:26:40 1993'}.

Si no se proporciona `t', se utiliza la hora actual retornada por @ref{1539,,localtime()}. La información regional no es utilizada por @ref{1254,,asctime()}.

@cartouche
@quotation Nota 
A diferencia de la función C del mismo nombre, @ref{1254,,asctime()} no agrega una nueva línea final.
@end quotation
@end cartouche
@end deffn

@geindex pthread_getcpuclockid() (en el módulo time)
@anchor{library/time time pthread_getcpuclockid}@anchor{c1a}
@deffn {Función} time.pthread_getcpuclockid (thread_id)

Retorna el `clk_id' del reloj de tiempo de CPU específico del subproceso para el `thread_id' especificado.

Utilice @ref{11cb,,threading.get_ident()} o el atributo @ref{2c43,,ident} de objetos @ref{9df,,threading.Thread} para obtener un valor adecuado para * thread_id*.

@cartouche
@quotation Advertencia 
Pasar un * thread_id * no válido o caducado puede provocar un comportamiento indefinido, como un error de segmentación.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Unix

See the man page for @code{pthread_getcpuclockid(3)@footnote{https://manpages.debian.org/pthread_getcpuclockid(3)}} for
further information.


Added in version 3.7.

@end deffn

@geindex clock_getres() (en el módulo time)
@anchor{library/time time clock_getres}@anchor{11ce}
@deffn {Función} time.clock_getres (clk_id)

Retorna la resolución (precisión) del reloj especificado `clk_id'. Consulte @ref{2bb6,,Constantes de ID de reloj} para obtener una lista de los valores aceptados para `clk_id'.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex clock_gettime() (en el módulo time)
@anchor{library/time time clock_gettime}@anchor{11cf}
@deffn {Función} time.clock_gettime (clk_id) -> float

Retorna la hora del reloj especificado `clk_id'. Consulte @ref{2bb6,,Constantes de ID de reloj} para obtener una lista de los valores aceptados para `clk_id'.

Utilice @ref{b6d,,clock_gettime_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex clock_gettime_ns() (en el módulo time)
@anchor{library/time time clock_gettime_ns}@anchor{b6d}
@deffn {Función} time.clock_gettime_ns (clk_id) -> int

Similar a @ref{11cf,,clock_gettime()} pero retorna el tiempo en nanosegundos.

@ref{1d5a,,Availability}: Unix.


Added in version 3.7.

@end deffn

@geindex clock_settime() (en el módulo time)
@anchor{library/time time clock_settime}@anchor{11d0}
@deffn {Función} time.clock_settime (clk_id, time: float)

Establece la hora del reloj especificado `clk_id'. Actualmente, @ref{73b,,CLOCK_REALTIME} es el único valor aceptado para `clk_id'.

Utilice @ref{b6e,,clock_settime_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.

@ref{1d5a,,Availability}: Unix, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex clock_settime_ns() (en el módulo time)
@anchor{library/time time clock_settime_ns}@anchor{b6e}
@deffn {Función} time.clock_settime_ns (clk_id, time: int)

Similar a @ref{11d0,,clock_settime()} pero establece el tiempo con nanosegundos.

@ref{1d5a,,Availability}: Unix, not Android, not iOS.


Added in version 3.7.

@end deffn

@geindex ctime() (en el módulo time)
@anchor{library/time time ctime}@anchor{2453}
@deffn {Función} time.ctime ([secs])

Convert a time expressed in seconds since the @ref{2a1f,,epoch} to a string of a form:
@code{'Sun Jun 20 23:21:05 1993'} representing local time. The day field
is two characters long and is space padded if the day is a single digit,
e.g.: @code{'Wed Jun  9 04:26:40 1993'}.

Si no se proporciona `secs' o @ref{716,,None}, se utiliza la hora actual retornada por @ref{3ad,,time()}. @code{ctime(secs)} es equivalente a @code{asctime(localtime(secs))}. La información de configuración regional no la utiliza @ref{2453,,ctime()}.
@end deffn

@geindex get_clock_info() (en el módulo time)
@anchor{library/time time get_clock_info}@anchor{11cd}
@deffn {Función} time.get_clock_info (name)

Obtenga información sobre el reloj especificado como un objeto de espacio de nombres. Los nombres de reloj admitidos y las funciones correspondientes para leer su valor son:


@itemize *

@item 
@code{'monotonic'}: @ref{3ac,,time.monotonic()}

@item 
@code{'perf_counter'}: @ref{b14,,time.perf_counter()}

@item 
@code{'process_time'}: @ref{b15,,time.process_time()}

@item 
@code{'thread_time'}: @ref{9c9,,time.thread_time()}

@item 
@code{'time'}: @ref{3ad,,time.time()}
@end itemize

El resultado tiene los siguientes atributos:


@itemize -

@item 
`afjustable': @code{True} si el reloj se puede cambiar automáticamente (por ejemplo, por un demonio NTP) o manualmente por el administrador del sistema, @code{False} de lo contrario

@item 
`implementation': el nombre de la función C subyacente utilizada para obtener el valor del reloj. Consulte @ref{2bb6,,Constantes de ID de reloj} para conocer los posibles valores.

@item 
`monotonic': @code{True} si el reloj no puede retroceder, @code{False} de lo contrario

@item 
`resolution': La resolución del reloj en segundos (@ref{153,,float})
@end itemize


Added in version 3.3.

@end deffn

@geindex gmtime() (en el módulo time)
@anchor{library/time time gmtime}@anchor{122d}
@deffn {Función} time.gmtime ([secs])

Convert a time expressed in seconds since the @ref{2a1f,,epoch} to a @ref{d71,,struct_time} in
UTC in which the dst flag is always zero.  If `secs' is not provided or
@ref{716,,None}, the current time as returned by @ref{3ad,,time()} is used.  Fractions
of a second are ignored.  See above for a description of the
@ref{d71,,struct_time} object. See @ref{24d2,,calendar.timegm()} for the inverse of this
function.
@end deffn

@geindex localtime() (en el módulo time)
@anchor{library/time time localtime}@anchor{1539}
@deffn {Función} time.localtime ([secs])

Como @ref{122d,,gmtime()} pero se convierte a la hora local. Si no se proporciona `secs' o @ref{716,,None}, se utiliza la hora actual retornada por @ref{3ad,,time()}. El indicador `dst' se establece en @code{1} cuando DST se aplica al tiempo dado.

@ref{1539,,localtime()} podría lanzar un @ref{919,,OverflowError}, si los valores de la marca de tiempo están fuera del rango soportado por las funciones @code{localtime()} o @code{gmtime()} de la plataforma C, y el @ref{4d5,,OSError} en las funciones @code{localtime()} o @code{gmtime()}. Es común que este esté restringido para los años entre 1970 y 2038.
@end deffn

@geindex mktime() (en el módulo time)
@anchor{library/time time mktime}@anchor{1255}
@deffn {Función} time.mktime (t)

This is the inverse function of @ref{1539,,localtime()}.  Its argument is the
@ref{d71,,struct_time} or full 9-tuple (since the dst flag is needed; use @code{-1}
as the dst flag if it is unknown) which expresses the time in `local' time, not
UTC.  It returns a floating-point number, for compatibility with @ref{3ad,,time()}.
If the input value cannot be represented as a valid time, either
@ref{919,,OverflowError} or @ref{360,,ValueError} will be raised (which depends on
whether the invalid value is caught by Python or the underlying C libraries).
The earliest date for which it can generate a time is platform-dependent.
@end deffn

@geindex monotonic() (en el módulo time)
@anchor{library/time time monotonic}@anchor{3ac}
@deffn {Función} time.monotonic () -> float

Retorna el valor (en segundos fraccionarios) de un reloj monótono, es decir, un reloj que no puede retroceder. El reloj no se ve afectado por las actualizaciones del reloj del sistema. El punto de referencia del valor retornado no está definido, de modo que sólo la diferencia entre los resultados de dos llamadas es válida.

Clock:


@itemize *

@item 
On Windows, call @code{QueryPerformanceCounter()} and
@code{QueryPerformanceFrequency()}.

@item 
On macOS, call @code{mach_absolute_time()} and @code{mach_timebase_info()}.

@item 
On HP-UX, call @code{gethrtime()}.

@item 
Call @code{clock_gettime(CLOCK_HIGHRES)} if available.

@item 
Otherwise, call @code{clock_gettime(CLOCK_MONOTONIC)}.
@end itemize

Utilice @ref{b6f,,monotonic_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.


Added in version 3.3.



Distinto en la versión 3.5: La función ahora está siempre disponible y siempre en todo el sistema.



Distinto en la versión 3.10: En macOS, la función ahora es para todo el sistema.

@end deffn

@geindex monotonic_ns() (en el módulo time)
@anchor{library/time time monotonic_ns}@anchor{b6f}
@deffn {Función} time.monotonic_ns () -> int

Similar a @ref{3ac,,monotonic()}, pero el tiempo de retorno es en nanosegundos.


Added in version 3.7.

@end deffn

@geindex perf_counter() (en el módulo time)
@anchor{library/time time perf_counter}@anchor{b14}
@deffn {Función} time.perf_counter () -> float

@geindex benchmarking

Retorna el valor (en fracciones de segundo) de un contador de rendimiento, es decir, un reloj con la resolución más alta disponible para medir una corta duración. Incluye el tiempo transcurrido durante el sleep y abarca todo el sistema. El punto de referencia del valor retornado no está definido, de modo que sólo la diferencia entre los resultados de dos llamadas es válida.

`Detalles de implementación de CPython:' On CPython, use the same clock as @ref{3ac,,time.monotonic()} and is a
monotonic clock, i.e. a clock that cannot go backwards.

Utilice la función @ref{b70,,perf_counter_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.


Added in version 3.3.



Distinto en la versión 3.10: En Windows, la función ahora es para todo el sistema.



Distinto en la versión 3.13: Use the same clock as @ref{3ac,,time.monotonic()}.

@end deffn

@geindex perf_counter_ns() (en el módulo time)
@anchor{library/time time perf_counter_ns}@anchor{b70}
@deffn {Función} time.perf_counter_ns () -> int

Similar a @ref{b14,,perf_counter()}, pero el tiempo de retorno es en nanosegundos.


Added in version 3.7.

@end deffn

@geindex process_time() (en el módulo time)
@anchor{library/time time process_time}@anchor{b15}
@deffn {Función} time.process_time () -> float

@geindex CPU time
@geindex processor time
@geindex benchmarking

Retorna el valor (en fracciones de segundo) de la suma del sistema y el tiempo de CPU del usuario del proceso actual. No incluye el tiempo transcurrido durante el sleep. Es todo el proceso por definición. El punto de referencia del valor retornado no está definido, de modo que sólo la diferencia entre los resultados de dos llamadas es válida.

Utilice @ref{b71,,process_time_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.


Added in version 3.3.

@end deffn

@geindex process_time_ns() (en el módulo time)
@anchor{library/time time process_time_ns}@anchor{b71}
@deffn {Función} time.process_time_ns () -> int

Similar a @ref{b15,,process_time()} pero retorna el tiempo en nanosegundos.


Added in version 3.7.

@end deffn

@geindex sleep() (en el módulo time)
@anchor{library/time time sleep}@anchor{73e}
@deffn {Función} time.sleep (secs)

Suspend execution of the calling thread for the given number of seconds.
The argument may be a floating-point number to indicate a more precise sleep
time.

Si el sleep es interrumpido por una señal y ninguna excepción fue lanzada por el gestor de señales, este sleep es reiniciado con un tiempo límite recalculado.

El tiempo de suspensión podría ser mayor al requerido por un monto arbitrario, a raíz de la programación de otra actividad del sistema.

On Windows, if `secs' is zero, the thread relinquishes the remainder of its
time slice to any other thread that is ready to run. If there are no other
threads ready to run, the function returns immediately, and the thread
continues execution.  On Windows 8.1 and newer the implementation uses
a high-resolution timer@footnote{https://learn.microsoft.com/windows-hardware/drivers/kernel/high-resolution-timers}
which provides resolution of 100 nanoseconds. If `secs' is zero, @code{Sleep(0)} is used.

Implementación en Unix:


@itemize *

@item 
Si está disponible, use @code{clock_nanosleep()} (resolución: 1 nanosegundo);

@item 
O use @code{nanosleep()} si está disponible (resolución: 1 nanosegundo);

@item 
O use @code{select()} (resolución: 1 microsegundo).
@end itemize

Raises an @ref{18c3,,auditing event} @code{time.sleep} with argument @code{secs}.


Distinto en la versión 3.5: La función ahora duerme al menos * segundos * incluso si el sleep es interrumpido por una señal, excepto si el manejador de la señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).



Distinto en la versión 3.11: On Unix, the @code{clock_nanosleep()} and @code{nanosleep()} functions are now
used if available. On Windows, a waitable timer is now used.



Distinto en la versión 3.13: Raises an auditing event.

@end deffn

@geindex % (percent);datetime format

@geindex strftime() (en el módulo time)
@anchor{library/time time strftime}@anchor{1256}
@deffn {Función} time.strftime (format[, t])

Convierta una tupla o @ref{d71,,struct_time} que represente un tiempo retornado por @ref{122d,,gmtime()} o @ref{1539,,localtime()} en una cadena como se especifica mediante el argumento `format'. Si no se proporciona `t', se utiliza la hora actual retornada por @ref{1539,,localtime()}. `format' debe ser una cadena. Se lanza un @ref{360,,ValueError} si algún campo en `t' está fuera del rango permitido.

0 es un argumento legal para cualquier posición en la tupla de tiempo; si normalmente es ilegal, el valor se fuerza a uno correcto.

Las siguientes directivas se pueden incrustar en la cadena `format'. Se muestran sin el ancho de campo opcional y la especificación de precisión, y se reemplazan por los caracteres indicados en el resultado @ref{1256,,strftime()}:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Directiva

@tab

Significado

@tab

Notas

@item

@code{%a}

@tab

Nombre abreviado del día local de la localidad.

@tab

@item

@code{%A}

@tab

Nombre completo del día laborable de Localidad.

@tab

@item

@code{%b}

@tab

Nombre abreviado del mes de la localidad.

@tab

@item

@code{%B}

@tab

Nombre completo del mes de la localidad.

@tab

@item

@code{%c}

@tab

Representación apropiada de fecha y hora de la localidad.

@tab

@item

@code{%d}

@tab

Día del mes como número decimal [01,31].

@tab

@item

@code{%f}

@tab


@table @asis

@item Microseconds as a decimal number

[000000,999999].
@end table

@tab

(1)

@item

@code{%H}

@tab

Hora (reloj de 24 horas) como un número decimal [00,23].

@tab

@item

@code{%I}

@tab

Hora (reloj de 12 horas) como un número decimal [01,12].

@tab

@item

@code{%j}

@tab

Día del año como número decimal [001,366].

@tab

@item

@code{%m}

@tab

Mes como un número decimal [01,12].

@tab

@item

@code{%M}

@tab

Minuto como un número decimal [00,59].

@tab

@item

@code{%p}

@tab

El equivalente de la configuración regional de AM o PM.

@tab

(2)

@item

@code{%S}

@tab

Segunda como un número decimal [00,61].

@tab

(3)

@item

@code{%U}

@tab

Número de semana del año (domingo como primer día de la semana) como número decimal [00,53]. Todos los días en un nuevo año anterior al primer domingo se consideran en la semana 0.

@tab

(4)

@item

@code{%u}

@tab

Day of the week (Monday is 1; Sunday is 7)
as a decimal number [1, 7].

@tab

@item

@code{%w}

@tab

Día de la semana como un número decimal [0 (domingo), 6].

@tab

@item

@code{%W}

@tab

Número de semana del año (lunes como primer día de la semana) como número decimal [00,53]. Todos los días en un nuevo año anterior al primer lunes se consideran en la semana 0.

@tab

(4)

@item

@code{%x}

@tab

Representación de fecha apropiada de la localidad.

@tab

@item

@code{%X}

@tab

Representación del tiempo apropiado de la localidad.

@tab

@item

@code{%y}

@tab

Año sin siglo como número decimal [00,99].

@tab

@item

@code{%Y}

@tab

Año con siglo como número decimal.

@tab

@item

@code{%z}

@tab

Time zone offset indicating a positive or
negative time difference from UTC/GMT of the
form +HHMM or -HHMM, where H represents decimal
hour digits and M represents decimal minute
digits [-23:59, +23:59]. @footnote{
The use of @code{%Z} is now deprecated, but the @code{%z} escape that expands to the
preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
strict reading of the original 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} standard calls for a two-digit
year (@code{%y} rather than @code{%Y}), but practice moved to 4-digit years long before the
year 2000.  After that, 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} became obsolete and the 4-digit year has
been first recommended by 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} and then mandated by 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}.
}

@tab

@item

@code{%Z}

@tab

Time zone name (no characters if no time zone
exists). Deprecated. @footnote{
The use of @code{%Z} is now deprecated, but the @code{%z} escape that expands to the
preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
strict reading of the original 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} standard calls for a two-digit
year (@code{%y} rather than @code{%Y}), but practice moved to 4-digit years long before the
year 2000.  After that, 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} became obsolete and the 4-digit year has
been first recommended by 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} and then mandated by 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}.
}

@tab

@item

@code{%G}

@tab

ISO 8601 year (similar to @code{%Y} but follows
the rules for the ISO 8601 calendar year).
The year starts with the week that contains
the first Thursday of the calendar year.

@tab

@item

@code{%V}

@tab

ISO 8601 week number (as a decimal number
[01,53]). The first week of the year is the
one that contains the first Thursday of the
year. Weeks start on Monday.

@tab

@item

@code{%%}

@tab

Un carácter literal @code{'%'}.

@tab

@end multitable


Notas:


@enumerate 

@item 
The @code{%f} format directive only applies to @ref{146c,,strptime()},
not to @ref{1256,,strftime()}. However, see also @ref{15ec,,datetime.datetime.strptime()} and
@ref{d19,,datetime.datetime.strftime()} where the @code{%f} format directive
@ref{2424,,applies to microseconds}.

@item 
Cuando se usa con la función @ref{146c,,strptime()}, la directiva @code{%p} solo afecta el campo de hora de salida si se usa la directiva @code{%I} para analizar la hora.
@end enumerate
@anchor{library/time leap-second}@anchor{2c44}

@enumerate 3

@item 
El rango realmente es @code{0} a @code{61}; el valor @code{60} es válido en las marcas de tiempo que representan segundos intercalares@footnote{https://en.wikipedia.org/wiki/Leap_second} y el valor @code{61} es compatible por razones históricas.

@item 
Cuando se usa con la función @ref{146c,,strptime()}, @code{%U} y @code{%W} solo se usan en los cálculos cuando se especifica el día de la semana y el año.
@end enumerate

Here is an example, a format for dates compatible with that specified  in the
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} Internet email standard.  @footnote{
The use of @code{%Z} is now deprecated, but the @code{%z} escape that expands to the
preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
strict reading of the original 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} standard calls for a two-digit
year (@code{%y} rather than @code{%Y}), but practice moved to 4-digit years long before the
year 2000.  After that, 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} became obsolete and the 4-digit year has
been first recommended by 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} and then mandated by 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}.
}

@example
>>> from time import gmtime, strftime
>>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
'Thu, 28 Jun 2001 14:17:15 +0000'
@end example

Es posible que se admitan directivas adicionales en ciertas plataformas, pero solo las que se enumeran aquí tienen un significado estandarizado por ANSI C. Para ver el conjunto completo de códigos de formato admitidos en su plataforma, consulte la documentación de @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}}.

En algunas plataformas, una especificación de precisión y ancho de campo opcional puede seguir inmediatamente el @code{'%'} inicial de una directiva en el siguiente orden; Esto tampoco es portátil. El ancho del campo es normalmente 2 excepto @code{%j} donde es 3.
@end deffn

@geindex % (percent);datetime format

@geindex strptime() (en el módulo time)
@anchor{library/time time strptime}@anchor{146c}
@deffn {Función} time.strptime (string[, format])

Analiza una cadena que representa un tiempo de acuerdo con un formato. El valor de retorno es a @ref{d71,,struct_time} como lo retorna @ref{122d,,gmtime()} o @ref{1539,,localtime()}.

El parámetro `format' utiliza las mismas directivas que las utilizadas por @ref{1256,,strftime()}; el valor predeterminado es @code{"%a %b %d %H:%M:%S %Y"} que coincide con el formato retornado por @ref{2453,,ctime()}. Si `string' no se puede analizar de acuerdo con `format', o si tiene un exceso de datos después del análisis, se lanza un @ref{360,,ValueError}. Los valores predeterminados utilizados para completar los datos faltantes cuando no se pueden inferir valores más precisos son @code{(1900, 1, 1, 0, 0, 0, 0, 1, -1)}. Tanto `string' como `format' deben ser strings.

Por ejemplo:

@example
>>> import time
>>> time.strptime("30 Nov 00", "%d %b %y")   
time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0,
                 tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1)
@end example

La compatibilidad con la directiva @code{%Z} se basa en los valores contenidos en @code{tzname} y en si @code{daylight} es verdadero. Debido a esto, es específico de la plataforma, excepto para reconocer UTC y GMT que siempre se conocen (y se consideran zonas horarias que no son de horario de verano).

Solo se admiten las directivas especificadas en la documentación. Debido a que @code{strftime()} se implementa por plataforma, a veces puede ofrecer más directivas que las enumeradas. Pero @code{strptime()} es independiente de cualquier plataforma y, por lo tanto, no necesariamente admite todas las directivas disponibles que no están documentadas como compatibles.
@end deffn

@geindex struct_time (clase en time)
@anchor{library/time time struct_time}@anchor{d71}
@deffn {Clase} time.struct_time

El tipo de secuencia de valores de tiempo retornado por @ref{122d,,gmtime()}, @ref{1539,,localtime()}, y @ref{146c,,strptime()}. Es un objeto con una interfaz @ref{6ef,,named tuple}: se puede acceder a los valores por índice y por nombre de atributo. Los siguientes valores están presentes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

Índice

@tab

Atributo

@tab

Valores

@item

0

@tab

@geindex tm_year (atributo de time.struct_time)
@anchor{library/time time struct_time tm_year}@anchor{1538}
@deffn {Atributo} tm_year
@end deffn

@tab

(por ejemplo, 1993)

@item

1

@tab

@geindex tm_mon (atributo de time.struct_time)
@anchor{library/time time struct_time tm_mon}@anchor{2c45}
@deffn {Atributo} tm_mon
@end deffn

@tab

rango [1, 12]

@item

2

@tab

@geindex tm_mday (atributo de time.struct_time)
@anchor{library/time time struct_time tm_mday}@anchor{2c46}
@deffn {Atributo} tm_mday
@end deffn

@tab

rango [1, 31]

@item

3

@tab

@geindex tm_hour (atributo de time.struct_time)
@anchor{library/time time struct_time tm_hour}@anchor{2c47}
@deffn {Atributo} tm_hour
@end deffn

@tab

rango [0, 23]

@item

4

@tab

@geindex tm_min (atributo de time.struct_time)
@anchor{library/time time struct_time tm_min}@anchor{2c48}
@deffn {Atributo} tm_min
@end deffn

@tab

rango [0, 59]

@item

5

@tab

@geindex tm_sec (atributo de time.struct_time)
@anchor{library/time time struct_time tm_sec}@anchor{2c49}
@deffn {Atributo} tm_sec
@end deffn

@tab

range [0, 61]; see @ref{2c44,,Note (2)} in @ref{1256,,strftime()}

@item

6

@tab

@geindex tm_wday (atributo de time.struct_time)
@anchor{library/time time struct_time tm_wday}@anchor{2c4a}
@deffn {Atributo} tm_wday
@end deffn

@tab

range [0, 6]; Monday is 0

@item

7

@tab

@geindex tm_yday (atributo de time.struct_time)
@anchor{library/time time struct_time tm_yday}@anchor{2c4b}
@deffn {Atributo} tm_yday
@end deffn

@tab

rango [1, 366]

@item

8

@tab

@geindex tm_isdst (atributo de time.struct_time)
@anchor{library/time time struct_time tm_isdst}@anchor{2464}
@deffn {Atributo} tm_isdst
@end deffn

@tab

0, 1 ó -1; ver abajo

@item

N/A

@tab

@geindex tm_zone (atributo de time.struct_time)
@anchor{library/time time struct_time tm_zone}@anchor{2c40}
@deffn {Atributo} tm_zone
@end deffn

@tab

abreviatura del nombre de la zona horaria

@item

N/A

@tab

@geindex tm_gmtoff (atributo de time.struct_time)
@anchor{library/time time struct_time tm_gmtoff}@anchor{2c3f}
@deffn {Atributo} tm_gmtoff
@end deffn

@tab

desplazamiento al este de UTC en segundos

@end multitable


Tenga en cuenta que, a diferencia de la estructura C, el valor del mes es un rango de [1, 12], no [0, 11].

En llamadas a @ref{1255,,mktime()}, @ref{2464,,tm_isdst} puede establecerse en 1 cuando el horario de verano está vigente y 0 cuando no lo está. Un valor de -1 indica que esto no se conoce y, por lo general, se completará el estado correcto.

Cuando una tupla con una longitud incorrecta se pasa a una función que espera a @ref{d71,,struct_time}, o que tiene elementos del tipo incorrecto, se lanza un @ref{228,,TypeError}.
@end deffn

@geindex time() (en el módulo time)
@anchor{library/time time time}@anchor{3ad}
@deffn {Función} time.time () -> float

Return the time in seconds since the @ref{2a1f,,epoch} as a floating-point
number. The handling of leap seconds@footnote{https://en.wikipedia.org/wiki/Leap_second} is platform dependent.
On Windows and most Unix systems, the leap seconds are not counted towards
the time in seconds since the @ref{2a1f,,epoch}. This is commonly referred to as Unix time@footnote{https://en.wikipedia.org/wiki/Unix_time}.

Note that even though the time is always returned as a floating-point
number, not all systems provide time with a better precision than 1 second.
While this function normally returns non-decreasing values, it can return a
lower value than a previous call if the system clock has been set back
between the two calls.

El número retornado por @ref{3ad,,time()} se puede convertir a un formato de hora más común (es decir, año, mes, día, hora, etc.) en UTC pasándolo a función @ref{122d,,gmtime()} o en hora local pasándola a la función @ref{1539,,localtime()}. En ambos casos se retorna un objeto @ref{d71,,struct_time}, desde el cual se puede acceder a los componentes de la fecha del calendario como atributos.

Clock:


@itemize *

@item 
On Windows, call @code{GetSystemTimeAsFileTime()}.

@item 
Call @code{clock_gettime(CLOCK_REALTIME)} if available.

@item 
Otherwise, call @code{gettimeofday()}.
@end itemize

Utilice @ref{b72,,time_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.
@end deffn

@geindex time_ns() (en el módulo time)
@anchor{library/time time time_ns}@anchor{b72}
@deffn {Función} time.time_ns () -> int

Similar a @code{time()} pero retorna el tiempo como un número entero de nanosegundos desde la @ref{2a1f,,época}.


Added in version 3.7.

@end deffn

@geindex thread_time() (en el módulo time)
@anchor{library/time time thread_time}@anchor{9c9}
@deffn {Función} time.thread_time () -> float

@geindex CPU time
@geindex processor time
@geindex benchmarking

Retorna el valor (en fracciones de segundo) de la suma del sistema y el tiempo de CPU del usuario del subproceso actual. No incluye el tiempo transcurrido durante el sleep. Es específico del hilo por definición. El punto de referencia del valor retornado no está definido, de modo que sólo la diferencia entre los resultados de dos llamadas en el mismo hilo es válida.

Utilice @ref{c19,,thread_time_ns()} para evitar la pérdida de precisión que causa el tipo @ref{153,,float}.

@ref{1d5a,,Availability}: Linux, Unix, Windows.

Sistemas Unix que soporten @code{CLOCK_THREAD_CPUTIME_ID}.


Added in version 3.7.

@end deffn

@geindex thread_time_ns() (en el módulo time)
@anchor{library/time time thread_time_ns}@anchor{c19}
@deffn {Función} time.thread_time_ns () -> int

Similar a @ref{9c9,,thread_time()} pero retorna el tiempo en nanosegundos.


Added in version 3.7.

@end deffn

@geindex tzset() (en el módulo time)
@anchor{library/time time tzset}@anchor{2c4c}
@deffn {Función} time.tzset ()

Restablezca las reglas de conversión de tiempo utilizadas por las rutinas de la biblioteca. La variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ} especifica cómo se hace esto. También establecerá las variables @code{tzname} (de variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ}), @code{timezone} (segundos que no son DST al oeste de UTC), @code{altzone} (segundos DST al oeste de UTC ) y @code{daylight} (a 0 si esta zona horaria no tiene ninguna regla de horario de verano, o a cero si hay un horario pasado, presente o futuro cuando se aplica el horario de verano).

@ref{1d5a,,Availability}: Unix.

@cartouche
@quotation Nota 
Aunque en muchos casos, cambiar la variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ} puede afectar la salida de funciones como @ref{1539,,localtime()} sin llamar a @ref{2c4c,,tzset()}, no se debe confiar en este comportamiento.

La variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ} no debe contener espacios en blanco.
@end quotation
@end cartouche

El formato estándar de la variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ} es (espacio en blanco agregado para mayor claridad):

@example
std offset [dst [offset [,start[/time], end[/time]]]]
@end example

Donde están los componentes:


@table @asis

@item @code{std} y  @code{dst}

Tres o más caracteres alfanuméricos que dan las abreviaturas de zona horaria. Estos se propagarán en time.tzname

@item @code{offset}

El desplazamiento tiene la forma: @code{± hh[:mm[:ss]]}. Esto indica el valor agregado de la hora local para llegar a UTC. Si está precedido por un “-”, la zona horaria está al este del primer meridiano; de lo contrario, es oeste. Si no hay desplazamiento después de dst, se supone que el horario de verano es una hora antes del horario estándar.

@item @code{start[/time], end[/time]}

Indica cuándo cambiar hacia y desde DST. El formato de las fechas de inicio y finalización es uno de los siguientes:


@table @asis

@item @code{J@var{n}}

El día juliano * n * (1 <= * n * <= 365). Los días bisiestos no se cuentan, por lo que en todos los años el 28 de febrero es el día 59 y el 1 de marzo es el día 60.

@item @code{@var{n}}

El día juliano basado en cero (0 <= * n * <= 365). Los días bisiestos se cuentan y es posible referirse al 29 de febrero.

@item @code{M@var{m}.@var{n}.@var{d}}

El  día d (0 <= `d' <= 6) de la semana `n' del mes `m' del año (1 <= `n' <= 5, 1 <= `m' <= 12, donde la semana 5 significa «el último `d' día del mes `m'», que puede ocurrir en la cuarta o quinta semana). La semana 1 es la primera semana en la que ocurre el día `d'. El día cero es un domingo.
@end table

@code{time} tiene el mismo formato que @code{offset}, excepto que no se permite ningún signo inicial (“-” o “+”). El valor predeterminado, si no se da el tiempo, es 02:00:00.
@end table

@example
>>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0'
>>> time.tzset()
>>> time.strftime('%X %x %Z')
'02:07:36 05/08/03 EDT'
>>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0'
>>> time.tzset()
>>> time.strftime('%X %x %Z')
'16:08:12 05/08/03 AEST'
@end example

En muchos sistemas Unix (incluidos *BSD, Linux, Solaris y Darwin), es más conveniente utilizar la base de datos `zoneinfo' (@code{tzfile(5)@footnote{https://manpages.debian.org/tzfile(5)}}) del sistema para especificar las reglas de zona horaria. Para hacer esto, configure la variable de entorno 
@geindex TZ
@geindex variables de entorno; TZ
@code{TZ} en la ruta del archivo de datos de zona horaria requerida, en relación con la raíz de la base de datos de zona horaria “zoneinfo” de los sistemas, generalmente ubicada en @code{/usr/share/zoneinfo} . Por ejemplo, @code{'US/Eastern'}, @code{'Australia/Melbourne'}, @code{'Egypt'} o @code{'Europe/Amsterdam'}.

@example
>>> os.environ['TZ'] = 'US/Eastern'
>>> time.tzset()
>>> time.tzname
('EST', 'EDT')
>>> os.environ['TZ'] = 'Egypt'
>>> time.tzset()
>>> time.tzname
('EET', 'EEST')
@end example
@end deffn

@node Constantes de ID de reloj,Constantes de zona horaria,Las Funciones,time — Time access and conversions
@anchor{library/time clock-id-constants}@anchor{2c4d}@anchor{library/time time-clock-id-constants}@anchor{2bb6}
@subsubsection Constantes de ID de reloj


Estas constantes se utilizan como parámetros para @ref{11ce,,clock_getres()} y @ref{11cf,,clock_gettime()}.

@geindex CLOCK_BOOTTIME (en el módulo time)
@anchor{library/time time CLOCK_BOOTTIME}@anchor{c16}
@deffn {Dato} time.CLOCK_BOOTTIME

Idéntico a @ref{73a,,CLOCK_MONOTONIC}, excepto que también incluye cualquier momento en que el sistema esté suspendido.

Esto permite que las aplicaciones obtengan un reloj monótono con suspensión sin tener que lidiar con las complicaciones de @ref{73b,,CLOCK_REALTIME}, que puede tener discontinuidades si se cambia la hora usando @code{settimeofday()} o similar.

@ref{1d5a,,Availability}: Linux >= 2.6.39.


Added in version 3.7.

@end deffn

@geindex CLOCK_HIGHRES (en el módulo time)
@anchor{library/time time CLOCK_HIGHRES}@anchor{2c4e}
@deffn {Dato} time.CLOCK_HIGHRES

El sistema operativo Solaris tiene un temporizador @code{CLOCK_HIGHRES} que intenta utilizar una fuente de hardware óptima y puede brindar una resolución cercana a los nanosegundos. @code{CLOCK_HIGHRES} es el reloj de alta resolución no ajustable.

@ref{1d5a,,Availability}: Solaris.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC (en el módulo time)
@anchor{library/time time CLOCK_MONOTONIC}@anchor{73a}
@deffn {Dato} time.CLOCK_MONOTONIC

Reloj que no se puede configurar y representa el tiempo monótono desde algún punto de partida no especificado.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW (en el módulo time)
@anchor{library/time time CLOCK_MONOTONIC_RAW}@anchor{2c4f}
@deffn {Dato} time.CLOCK_MONOTONIC_RAW

Similar a @ref{73a,,CLOCK_MONOTONIC}, pero proporciona acceso a un tiempo sin procesar basado en hardware que no está sujeto a ajustes NTP.

@ref{1d5a,,Availability}: Linux >= 2.6.28, macOS >= 10.12.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW_APPROX (en el módulo time)
@anchor{library/time time CLOCK_MONOTONIC_RAW_APPROX}@anchor{2c50}
@deffn {Dato} time.CLOCK_MONOTONIC_RAW_APPROX

Similar to @ref{2c4f,,CLOCK_MONOTONIC_RAW}, but reads a value cached by
the system at context switch and hence has less accuracy.

@ref{1d5a,,Availability}: macOS >= 10.12.


Added in version 3.13.

@end deffn

@geindex CLOCK_PROCESS_CPUTIME_ID (en el módulo time)
@anchor{library/time time CLOCK_PROCESS_CPUTIME_ID}@anchor{2c51}
@deffn {Dato} time.CLOCK_PROCESS_CPUTIME_ID

Temporizador por proceso de alta resolución desde la CPU.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_PROF (en el módulo time)
@anchor{library/time time CLOCK_PROF}@anchor{c17}
@deffn {Dato} time.CLOCK_PROF

Temporizador por proceso de alta resolución desde la CPU.

@ref{1d5a,,Availability}: FreeBSD, NetBSD >= 7, OpenBSD.


Added in version 3.7.

@end deffn

@geindex CLOCK_TAI (en el módulo time)
@anchor{library/time time CLOCK_TAI}@anchor{1977}
@deffn {Dato} time.CLOCK_TAI

Tiempo Atómico Internacional@footnote{https://www.nist.gov/pml/time-and-frequency-division/nist-time-frequently-asked-questions-faq#tai}

El sistema debe contar con una tabla de segundos intercalares para que éste dé la respuesta correcta. Software PTP o NTP puede mantener una tabla de segundos intercalares.

@ref{1d5a,,Availability}: Linux.


Added in version 3.9.

@end deffn

@geindex CLOCK_THREAD_CPUTIME_ID (en el módulo time)
@anchor{library/time time CLOCK_THREAD_CPUTIME_ID}@anchor{2c52}
@deffn {Dato} time.CLOCK_THREAD_CPUTIME_ID

Reloj de tiempo de CPU específico de subproceso.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_UPTIME (en el módulo time)
@anchor{library/time time CLOCK_UPTIME}@anchor{c18}
@deffn {Dato} time.CLOCK_UPTIME

Tiempo cuyo valor absoluto es el tiempo que el sistema ha estado funcionando y no suspendido, proporcionando una medición precisa del tiempo de actividad, tanto absoluta como de intervalo.

@ref{1d5a,,Availability}: FreeBSD, OpenBSD >= 5.5.


Added in version 3.7.

@end deffn

@geindex CLOCK_UPTIME_RAW (en el módulo time)
@anchor{library/time time CLOCK_UPTIME_RAW}@anchor{ad5}
@deffn {Dato} time.CLOCK_UPTIME_RAW

Reloj que se incrementa monótonamente, rastreando el tiempo desde un punto arbitrario, no afectado por los ajustes de frecuencia o tiempo y no incrementado mientras el sistema está dormido.

@ref{1d5a,,Availability}: macOS >= 10.12.


Added in version 3.8.

@end deffn

@geindex CLOCK_UPTIME_RAW_APPROX (en el módulo time)
@anchor{library/time time CLOCK_UPTIME_RAW_APPROX}@anchor{2c53}
@deffn {Dato} time.CLOCK_UPTIME_RAW_APPROX

Like @ref{ad5,,CLOCK_UPTIME_RAW}, but the value is cached by the system
at context switches and therefore has less accuracy.

@ref{1d5a,,Availability}: macOS >= 10.12.


Added in version 3.13.

@end deffn

La siguiente constante es el único parámetro que se puede enviar a @ref{11d0,,clock_settime()}.

@geindex CLOCK_REALTIME (en el módulo time)
@anchor{library/time time CLOCK_REALTIME}@anchor{73b}
@deffn {Dato} time.CLOCK_REALTIME

Reloj en tiempo real de todo el sistema. Configurar este reloj requiere los privilegios apropiados.

@ref{1d5a,,Availability}: Unix.


Added in version 3.3.

@end deffn

@node Constantes de zona horaria,,Constantes de ID de reloj,time — Time access and conversions
@anchor{library/time time-timezone-constants}@anchor{2c54}@anchor{library/time timezone-constants}@anchor{2c55}
@subsubsection Constantes de zona horaria


@geindex altzone (en el módulo time)
@anchor{library/time time altzone}@anchor{2c56}
@deffn {Dato} time.altzone

El desplazamiento de la zona horaria de horario de verano local, en segundos al oeste de UTC, si se define uno. Esto es negativo si la zona horaria local del horario de verano está al este de UTC (como en Europa occidental, incluido el Reino Unido). Solo use esto si la @code{daylight} no es cero. Vea la nota abajo.
@end deffn

@geindex daylight (en el módulo time)
@anchor{library/time time daylight}@anchor{2c57}
@deffn {Dato} time.daylight

No es cero si se define una zona horaria DST. Vea la nota abajo.
@end deffn

@geindex timezone (en el módulo time)
@anchor{library/time time timezone}@anchor{2c58}
@deffn {Dato} time.timezone

El desplazamiento de la zona horaria local (no DST), en segundos al oeste de UTC (negativo en la mayoría de Europa occidental, positivo en los EE. UU., Cero en el Reino Unido). Vea la nota abajo.
@end deffn

@geindex tzname (en el módulo time)
@anchor{library/time time tzname}@anchor{2c59}
@deffn {Dato} time.tzname

Una tupla de dos cadenas: la primera es el nombre de la zona horaria local no DST, la segunda es el nombre de la zona horaria local DST. Si no se define la zona horaria DST, la segunda cadena no debe usarse. Vea la nota abajo.
@end deffn

@cartouche
@quotation Nota 
For the above Timezone constants (@ref{2c56,,altzone}, @ref{2c57,,daylight}, @ref{2c58,,timezone},
and @ref{2c59,,tzname}), the value is determined by the timezone rules in effect
at module load time or the last time @ref{2c4c,,tzset()} is called and may be incorrect
for times in the past.  It is recommended to use the @ref{2c3f,,tm_gmtoff} and
@ref{2c40,,tm_zone} results from @ref{1539,,localtime()} to obtain timezone information.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item Modulo @ref{31,,datetime}

Más interfaz orientada a objetos para fechas y horas.

@item Modulo @ref{86,,locale}

Servicios de internacionalización. La configuración regional afecta la interpretación de muchos especificadores de formato en @ref{1256,,strftime()} y @ref{146c,,strptime()}.

@item Modulo @ref{15,,calendar}

Funciones generales relacionadas con el calendario. @ref{24d2,,timegm()} es el inverso de @ref{122d,,gmtime()} de este módulo.
@end table


@subsubheading Notas al pie


@node argparse — Parser for command-line options arguments and subcommands,logging — Logging facility for Python,time — Time access and conversions,Servicios genéricos del sistema operativo
@anchor{library/argparse doc}@anchor{2c5a}@anchor{library/argparse argparse-parser-for-command-line-options-arguments-and-subcommands}@anchor{2c5b}@anchor{library/argparse module-argparse}@anchor{7}
@subsection @code{argparse} — Parser for command-line options, arguments and subcommands


@geindex module; argparse


Added in version 3.2.


`Código fuente:' Lib/argparse.py@footnote{https://github.com/python/cpython/tree/main/Lib/argparse.py}


__________________________________________________________________


@subsubheading Tutorial



Esta página contiene la información de referencia de la API. Para una introducción más amigable al análisis de la línea de comandos de Python, echa un vistazo al @ref{2c5c,,argparse tutorial}.

The @code{argparse} module makes it easy to write user-friendly command-line
interfaces. The program defines what arguments it requires, and @code{argparse}
will figure out how to parse those out of @ref{12d2,,sys.argv}.  The @code{argparse}
module also automatically generates help and usage messages.  The module
will also issue errors when users give the program invalid arguments.

The @code{argparse} module’s support for command-line interfaces is built
around an instance of @ref{15c,,argparse.ArgumentParser}.  It is a container for
argument specifications and has options that apply to the parser as whole:

@example
parser = argparse.ArgumentParser(
                    prog='ProgramName',
                    description='What the program does',
                    epilog='Text at the bottom of help')
@end example

El método @ref{306,,ArgumentParser.add_argument()} adjunta especificaciones de argumentos individuales al analizador. Soporta argumentos posicionales, opciones que aceptan valores, y banderas de activación y desactivación:

@example
parser.add_argument('filename')           # positional argument
parser.add_argument('-c', '--count')      # option that takes a value
parser.add_argument('-v', '--verbose',
                    action='store_true')  # on/off flag
@end example

El método @ref{2c5d,,ArgumentParser.parse_args()} corre el analizador y coloca los datos extraídos en un objeto @ref{2c5e,,argparse.Namespace}:

@example
args = parser.parse_args()
print(args.filename, args.count, args.verbose)
@end example

@cartouche
@quotation Nota 
If you’re looking for a guide about how to upgrade @ref{a0,,optparse} code
to @code{argparse}, see @ref{121c,,Upgrading Optparse Code}.
@end quotation
@end cartouche

@menu
* Objetos ArgumentParser:: 
* El método add_argument(): El método add_argument. 
* El método parse_args(): El método parse_args. 
* Otras utilidades:: 
* Excepciones: Excepciones<8>. 

@end menu

@node Objetos ArgumentParser,El método add_argument,,argparse — Parser for command-line options arguments and subcommands
@anchor{library/argparse argumentparser-objects}@anchor{2c5f}
@subsubsection Objetos `ArgumentParser'


@geindex ArgumentParser (clase en argparse)
@anchor{library/argparse argparse ArgumentParser}@anchor{15c}
@deffn {Clase} argparse.ArgumentParser (prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True, suggest_on_error=False)

Crea un nuevo objeto @ref{15c,,ArgumentParser}. Todos los parámetros deben pasarse como argumentos de palabra clave. Cada parámetro tiene su propia descripción más detallada a continuación, pero en resumen son:


@itemize *

@item 
@ref{15b,,prog} - The name of the program (default: generated from the @code{__main__}
module attributes and @code{sys.argv[0]})

@item 
@ref{2c60,,usage} - La cadena de caracteres que describe el uso del programa (por defecto: generado a partir de los argumentos añadidos al analizador)

@item 
@ref{2c61,,description} - Texto a mostrar antes del argumento ayuda (por defecto, ninguno)

@item 
@ref{2c62,,epilog} - Texto a mostrar después del argumento ayuda (por defecto, ninguno)

@item 
@ref{2c63,,parents} - Una lista de objetos @ref{15c,,ArgumentParser} cuyos argumentos también deberían ser incluidos

@item 
@ref{2c64,,formatter_class} - Una clase para personalizar la salida de la ayuda

@item 
@ref{2c65,,prefix_chars} - El conjunto de caracteres que preceden a los argumentos opcionales (por defecto: ‘-‘)

@item 
@ref{2c66,,fromfile_prefix_chars} - El conjunto de caracteres que preceden a los archivos de los cuales se deberían leer los argumentos adicionales (por defecto: @code{None})

@item 
@ref{2c67,,argument_default} - El valor global por defecto de los argumentos (por defecto: @code{None})

@item 
@ref{2c68,,conflict_handler} - La estrategia para resolver los opcionales conflictivos (normalmente es innecesaria)

@item 
@ref{2c69,,add_help} - Añade una opción @code{-h/--help} al analizador (por defecto: @code{True})

@item 
@ref{e45,,allow_abbrev} - Permite abreviar las opciones largas si la abreviatura es inequívoca. (por defecto: @code{True})

@item 
@ref{2c6a,,exit_on_error} - Determines whether or not @code{ArgumentParser} exits with
error info when an error occurs. (default: @code{True})

@item 
@ref{2c6b,,suggest_on_error} - Enables suggestions for mistyped argument choices
and subparser names (default: @code{False})
@end itemize


Distinto en la versión 3.5: se añadió el parámetro `allow_abbrev'.



Distinto en la versión 3.8: En versiones anteriores, `allow_abbrev' también deshabilitaba la agrupación de banderas (`flags') cortas como @code{-vv} para que sea @code{-v -v}.



Distinto en la versión 3.9: Se agregó el parámetro `exit_on_error'.

@end deffn

En las siguientes secciones se describe cómo se utiliza cada una de ellas.

@menu
* prog:: 
* uso:: 
* description:: 
* epilog:: 
* parents:: 
* formatter_class:: 
* prefix_chars:: 
* fromfile_prefix_chars:: 
* argument_default:: 
* allow_abbrev:: 
* conflict_handler:: 
* add_help:: 
* exit_on_error:: 
* suggest_on_error:: 

@end menu

@node prog,uso,,Objetos ArgumentParser
@anchor{library/argparse id1}@anchor{2c6c}@anchor{library/argparse prog}@anchor{15b}
@subsubsection `prog'


By default, @ref{15c,,ArgumentParser} calculates the name of the program
to display in help messages depending on the way the Python interpreter was run:


@itemize *

@item 
The @ref{27c4,,base name} of @code{sys.argv[0]} if a file was
passed as argument.

@item 
The Python interpreter name followed by @code{sys.argv[0]} if a directory or
a zipfile was passed as argument.

@item 
The Python interpreter name followed by @code{-m} followed by the
module or package name if the @ref{187,,-m} option was used.
@end itemize

This default is almost always desirable because it will make the help messages
match the string that was used to invoke the program on the command line.
However, to change this default behavior, another value can be supplied using
the @code{prog=} argument to @ref{15c,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.print_help()
usage: myprogram [-h]

options:
 -h, --help  show this help message and exit
@end example

Note that the program name, whether determined from @code{sys.argv[0]},
from the @code{__main__} module attributes or from the
@code{prog=} argument, is available to help messages using the @code{%(prog)s} format
specifier.

@example
>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.add_argument('--foo', help='foo of the %(prog)s program')
>>> parser.print_help()
usage: myprogram [-h] [--foo FOO]

options:
 -h, --help  show this help message and exit
 --foo FOO   foo of the myprogram program
@end example


Distinto en la versión 3.14: The default @code{prog} value now reflects how @code{__main__} was actually executed,
rather than always being @code{os.path.basename(sys.argv[0])}.


@node uso,description,prog,Objetos ArgumentParser
@anchor{library/argparse usage}@anchor{2c60}
@subsubsection uso


By default, @ref{15c,,ArgumentParser} calculates the usage message from the
arguments it contains. The default message can be overridden with the
@code{usage=} keyword argument:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
>>> parser.add_argument('--foo', nargs='?', help='foo help')
>>> parser.add_argument('bar', nargs='+', help='bar help')
>>> parser.print_help()
usage: PROG [options]

positional arguments:
 bar          bar help

options:
 -h, --help   show this help message and exit
 --foo [FOO]  foo help
@end example

El especificador de formato @code{%(prog)s} está preparado para introducir el nombre del programa en los mensajes de ayuda.

@node description,epilog,uso,Objetos ArgumentParser
@anchor{library/argparse description}@anchor{2c61}@anchor{library/argparse id2}@anchor{2c6d}
@subsubsection `description'


Most calls to the @ref{15c,,ArgumentParser} constructor will use the
@code{description=} keyword argument.  This argument gives a brief description of
what the program does and how it works.  In help messages, the description is
displayed between the command-line usage string and the help messages for the
various arguments.

Por defecto, la descripción será ajustada a una línea para que encaje en el espacio dado. Para cambiar este comportamiento, revisa el argumento @ref{2c64,,formatter_class}.

@node epilog,parents,description,Objetos ArgumentParser
@anchor{library/argparse epilog}@anchor{2c62}
@subsubsection `epilog'


A algunos programas les gusta mostrar una descripción adicional del programa después de la descripción de los argumentos. Dicho texto puede ser especificado usando el argumento @code{epilog=} para @ref{15c,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(
...     description='A foo that bars',
...     epilog="And that's how you'd foo a bar")
>>> parser.print_help()
usage: argparse.py [-h]

A foo that bars

options:
 -h, --help  show this help message and exit

And that's how you'd foo a bar
@end example

Al igual que con el argumento @ref{2c61,,description}, el texto @code{epilog=} está por defecto ajustado a una línea, pero este comportamiento puede ser modificado con el argumento @ref{2c64,,formatter_class} para @ref{15c,,ArgumentParser}.

@node parents,formatter_class,epilog,Objetos ArgumentParser
@anchor{library/argparse parents}@anchor{2c63}
@subsubsection `parents'


A veces, varios analizadores comparten un conjunto de argumentos comunes. En lugar de repetir las definiciones de estos argumentos, se puede usar un único analizador con todos los argumentos compartidos y pasarlo en el argumento @code{parents=} a @ref{15c,,ArgumentParser}. El argumento @code{parents=} toma una lista de objetos @ref{15c,,ArgumentParser}, recoge todas las acciones de posición y de opción de éstos, y añade estas acciones al objeto @ref{15c,,ArgumentParser} que se está construyendo:

@example
>>> parent_parser = argparse.ArgumentParser(add_help=False)
>>> parent_parser.add_argument('--parent', type=int)

>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])
>>> foo_parser.add_argument('foo')
>>> foo_parser.parse_args(['--parent', '2', 'XXX'])
Namespace(foo='XXX', parent=2)

>>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])
>>> bar_parser.add_argument('--bar')
>>> bar_parser.parse_args(['--bar', 'YYY'])
Namespace(bar='YYY', parent=None)
@end example

Ten en cuenta que la mayoría de los analizadores padre especificarán @code{add_help=False}. De lo contrario, el @ref{15c,,ArgumentParser} verá dos opciones @code{-h/—help} (una para el padre y otra para el hijo) y generará un error.

@cartouche
@quotation Nota 
Debes inicializar completamente los analizadores antes de pasarlos a través de @code{parents=}. Si cambias los analizadores padre después del analizador hijo, esos cambios no se reflejarán en el hijo.
@end quotation
@end cartouche

@node formatter_class,prefix_chars,parents,Objetos ArgumentParser
@anchor{library/argparse formatter-class}@anchor{2c64}@anchor{library/argparse id3}@anchor{2c6e}
@subsubsection `formatter_class'


Los objetos @ref{15c,,ArgumentParser} permiten personalizar el formato de la ayuda especificando una clase de formato alternativa. Actualmente, hay cuatro clases de este tipo:

@geindex RawDescriptionHelpFormatter (clase en argparse)
@geindex RawTextHelpFormatter (clase en argparse)
@geindex ArgumentDefaultsHelpFormatter (clase en argparse)
@geindex MetavarTypeHelpFormatter (clase en argparse)
@anchor{library/argparse argparse RawDescriptionHelpFormatter}@anchor{2c6f}
@deffn {Clase} argparse.RawDescriptionHelpFormatter
@anchor{library/argparse argparse RawTextHelpFormatter}@anchor{2c70}
@deffnx {Clase} argparse.RawTextHelpFormatter
@anchor{library/argparse argparse ArgumentDefaultsHelpFormatter}@anchor{18a4}
@deffnx {Clase} argparse.ArgumentDefaultsHelpFormatter
@anchor{library/argparse argparse MetavarTypeHelpFormatter}@anchor{2c71}
@deffnx {Clase} argparse.MetavarTypeHelpFormatter
@end deffn

@ref{2c6f,,RawDescriptionHelpFormatter} y @ref{2c70,,RawTextHelpFormatter} dan más control sobre cómo se muestran las descripciones de texto. Por defecto, los objetos @ref{15c,,ArgumentParser} ajustan a la línea los textos de @ref{2c61,,description} y @ref{2c62,,epilog} en los mensajes de ayuda de la línea de comandos:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     description='@w{'}'this description
...         was indented weird
...             but that is okay'@w{'}',
...     epilog='@w{'}'
...             likewise for this epilog whose whitespace will
...         be cleaned up and whose words will be wrapped
...         across a couple lines'@w{'}')
>>> parser.print_help()
usage: PROG [-h]

this description was indented weird but that is okay

options:
 -h, --help  show this help message and exit

likewise for this epilog whose whitespace will be cleaned up and whose words
will be wrapped across a couple lines
@end example

Pasar @ref{2c6f,,RawDescriptionHelpFormatter} como @code{formatter_class=} indica que @ref{2c61,,description} y @ref{2c62,,epilog} ya tienen el formato correcto y no deben ser ajustados a la línea:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.RawDescriptionHelpFormatter,
...     description=textwrap.dedent('@w{'}'\
...         Please do not mess up this text!
...         --------------------------------
...             I have indented it
...             exactly the way
...             I want it
...         '@w{'}'))
>>> parser.print_help()
usage: PROG [-h]

Please do not mess up this text!
--------------------------------
   I have indented it
   exactly the way
   I want it

options:
 -h, --help  show this help message and exit
@end example

@ref{2c70,,RawTextHelpFormatter} maintains whitespace for all sorts of help text,
including argument descriptions. However, multiple newlines are replaced with
one. If you wish to preserve multiple blank lines, add spaces between the
newlines.

@ref{18a4,,ArgumentDefaultsHelpFormatter} añade automáticamente información sobre los valores por defecto a cada uno de los mensajes de ayuda de los argumentos:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
>>> parser.add_argument('--foo', type=int, default=42, help='FOO!')
>>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!')
>>> parser.print_help()
usage: PROG [-h] [--foo FOO] [bar ...]

positional arguments:
 bar         BAR! (default: [1, 2, 3])

options:
 -h, --help  show this help message and exit
 --foo FOO   FOO! (default: 42)
@end example

@ref{2c71,,MetavarTypeHelpFormatter} utiliza el nombre del parámetro @ref{2c72,,type} para cada argumento como el nombre a mostrar para sus valores (en lugar de utilizar @ref{2c73,,dest} como lo hace el formato habitual):

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.MetavarTypeHelpFormatter)
>>> parser.add_argument('--foo', type=int)
>>> parser.add_argument('bar', type=float)
>>> parser.print_help()
usage: PROG [-h] [--foo int] float

positional arguments:
  float

options:
  -h, --help  show this help message and exit
  --foo int
@end example

@node prefix_chars,fromfile_prefix_chars,formatter_class,Objetos ArgumentParser
@anchor{library/argparse prefix-chars}@anchor{2c65}
@subsubsection `prefix_chars'


Most command-line options will use @code{-} as the prefix, e.g. @code{-f/--foo}.
Parsers that need to support different or additional prefix
characters, e.g. for options
like @code{+f} or @code{/foo}, may specify them using the @code{prefix_chars=} argument
to the @ref{15c,,ArgumentParser} constructor:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')
>>> parser.add_argument('+f')
>>> parser.add_argument('++bar')
>>> parser.parse_args('+f X ++bar Y'.split())
Namespace(bar='Y', f='X')
@end example

El argumento @code{prefix_chars=} tiene un valor por defecto de @code{'-'}. Proporcionar un conjunto de caracteres que no incluya @code{-} causará que las opciones @code{-f/--foo} no sean inhabilitadas.

@node fromfile_prefix_chars,argument_default,prefix_chars,Objetos ArgumentParser
@anchor{library/argparse fromfile-prefix-chars}@anchor{2c66}
@subsubsection `fromfile_prefix_chars'


Algunas veces, cuando se trata de una lista de argumentos particularmente larga, puede tener sentido mantener la lista de argumentos en un archivo en lugar de escribirla en la línea de comandos. Si el argumento @code{fromfile_prefix_chars=} se da al constructor @ref{15c,,ArgumentParser}, entonces los argumentos que empiezan con cualquiera de los caracteres especificados se tratarán como archivos, y serán reemplazados por los argumentos que contienen. Por ejemplo:

@example
>>> with open('args.txt', 'w', encoding=sys.getfilesystemencoding()) as fp:
...     fp.write('-f\nbar')
...
>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@@')
>>> parser.add_argument('-f')
>>> parser.parse_args(['-f', 'foo', '@@args.txt'])
Namespace(f='bar')
@end example

Los argumentos leídos de un archivo deben ser por defecto uno por línea (pero vea también @ref{2c74,,convert_arg_line_to_args()}) y se tratan como si estuvieran en el mismo lugar que el argumento de referencia del archivo original en la línea de comandos. Así, en el ejemplo anterior, la expresión @code{[‘-f’, ‘foo’, ‘@@args.txt’]} se considera equivalente a la expresión @code{[‘-f’, ‘foo’, ‘-f’, ‘bar’]}.

@ref{15c,,ArgumentParser} utiliza @ref{5dd,,codificación del sistema de archivos y manejador de errores} para leer el archivo que contiene argumentos.

El argumento @code{fromfile_prefix_chars=} por defecto es @code{None}, lo que significa que los argumentos nunca serán tratados como referencias de archivos.


Distinto en la versión 3.12: @ref{15c,,ArgumentParser} changed encoding and errors to read arguments files
from default (e.g. @ref{5dc,,locale.getpreferredencoding(False)}
and @code{"strict"}) to the @ref{5dd,,filesystem encoding and error handler}.
Arguments file should be encoded in UTF-8 instead of ANSI Codepage on Windows.


@node argument_default,allow_abbrev,fromfile_prefix_chars,Objetos ArgumentParser
@anchor{library/argparse argument-default}@anchor{2c67}
@subsubsection `argument_default'


Generalmente, los valores por defecto de los argumentos se especifican ya sea pasando un valor por defecto a @ref{306,,add_argument()} o llamando a los métodos @ref{2c75,,set_defaults()} con un conjunto específico de pares nombre-valor. A veces, sin embargo, puede ser útil especificar un único valor por defecto para todos los argumentos del analizador. Esto se puede lograr pasando el argumento de palabra clave @code{argument_default=} a @ref{15c,,ArgumentParser}. Por ejemplo, para suprimir globalmente la creación de atributos en las llamadas a @ref{2c5d,,parse_args()} , proporcionamos el argumento @code{argument_default=SUPPRESS}:

@example
>>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
>>> parser.add_argument('--foo')
>>> parser.add_argument('bar', nargs='?')
>>> parser.parse_args(['--foo', '1', 'BAR'])
Namespace(bar='BAR', foo='1')
>>> parser.parse_args([])
Namespace()
@end example

@node allow_abbrev,conflict_handler,argument_default,Objetos ArgumentParser
@anchor{library/argparse allow-abbrev}@anchor{e45}@anchor{library/argparse id4}@anchor{2c76}
@subsubsection `allow_abbrev'


Normalmente, cuando pasas una lista de argumentos al método @ref{2c5d,,parse_args()} de un @ref{15c,,ArgumentParser}, @ref{e44,,reconoce las abreviaturas} de las opciones largas.

Esta característica puede ser desactivada poniendo @code{allow_abbrev} a @code{False}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False)
>>> parser.add_argument('--foobar', action='store_true')
>>> parser.add_argument('--foonley', action='store_false')
>>> parser.parse_args(['--foon'])
usage: PROG [-h] [--foobar] [--foonley]
PROG: error: unrecognized arguments: --foon
@end example


Added in version 3.5.


@node conflict_handler,add_help,allow_abbrev,Objetos ArgumentParser
@anchor{library/argparse conflict-handler}@anchor{2c68}
@subsubsection `conflict_handler'


Los objetos @ref{15c,,ArgumentParser} no permiten dos acciones con la misma cadena de caracteres de opción. Por defecto, los objetos @ref{15c,,ArgumentParser} lanzan una excepción si se intenta crear un argumento con una cadena de caracteres de opción que ya está en uso:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo', help='old foo help')
>>> parser.add_argument('--foo', help='new foo help')
Traceback (most recent call last):
 ..
ArgumentError: argument --foo: conflicting option string(s): --foo
@end example

A veces (por ejemplo, cuando se utiliza @ref{2c63,,parents}) puede ser útil anular simplemente cualquier argumento antiguo con la misma cadena de caracteres de opción. Para lograr este comportamiento, se puede suministrar el valor @code{'resolve'} al argumento @code{conflict_handler=} de @ref{15c,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')
>>> parser.add_argument('-f', '--foo', help='old foo help')
>>> parser.add_argument('--foo', help='new foo help')
>>> parser.print_help()
usage: PROG [-h] [-f FOO] [--foo FOO]

options:
 -h, --help  show this help message and exit
 -f FOO      old foo help
 --foo FOO   new foo help
@end example

Ten en cuenta que los objetos @ref{15c,,ArgumentParser} sólo eliminan una acción si todas sus cadenas de caracteres de opción están anuladas. Así, en el ejemplo anterior, la antigua acción @code{-f/--foo} se mantiene como la acción @code{-f}, porque sólo la cadena de caracteres de opción @code{--foo} fue anulada.

@node add_help,exit_on_error,conflict_handler,Objetos ArgumentParser
@anchor{library/argparse add-help}@anchor{2c69}
@subsubsection `add_help'


By default, @ref{15c,,ArgumentParser} objects add an option which simply displays
the parser’s help message. If @code{-h} or @code{--help} is supplied at the command
line, the @code{ArgumentParser} help will be printed.

Ocasionalmente, puede ser útil desactivar la inclusión de esta opción de ayuda. Esto se puede lograr pasando @code{False} como argumento de @code{add_help=} a @ref{15c,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> parser.add_argument('--foo', help='foo help')
>>> parser.print_help()
usage: PROG [--foo FOO]

options:
 --foo FOO  foo help
@end example

La opción de ayuda es típicamente @code{-h/--help}. La excepción a esto es si @code{prefix_chars=} se especifica y no incluye @code{-}, en cuyo caso @code{-h} y @code{--help} no son opciones válidas. En este caso, el primer carácter en @code{prefix_chars} se utiliza para preceder a las opciones de ayuda:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
>>> parser.print_help()
usage: PROG [+h]

options:
  +h, ++help  show this help message and exit
@end example

@node exit_on_error,suggest_on_error,add_help,Objetos ArgumentParser
@anchor{library/argparse exit-on-error}@anchor{2c6a}
@subsubsection exit_on_error


Normally, when you pass an invalid argument list to the @ref{2c5d,,parse_args()}
method of an @ref{15c,,ArgumentParser}, it will print a `message' to @ref{9cc,,sys.stderr} and exit with a status
code of 2.

Si el usuario desea detectar errores manualmente, la función se puede habilitar configurando @code{exit_on_error} en @code{False}

@example
>>> parser = argparse.ArgumentParser(exit_on_error=False)
>>> parser.add_argument('--integers', type=int)
_StoreAction(option_strings=['--integers'], dest='integers', nargs=None, const=None, default=None, type=<class 'int'>, choices=None, help=None, metavar=None)
>>> try:
...     parser.parse_args('--integers a'.split())
... except argparse.ArgumentError:
...     print('Catching an argumentError')
...
Catching an argumentError
@end example


Added in version 3.9.


@node suggest_on_error,,exit_on_error,Objetos ArgumentParser
@anchor{library/argparse suggest-on-error}@anchor{2c6b}
@subsubsection suggest_on_error


By default, when a user passes an invalid argument choice or subparser name,
@ref{15c,,ArgumentParser} will exit with error info and list the permissible
argument choices (if specified) or subparser names as part of the error message.

If the user would like to enable suggestions for mistyped argument choices and
subparser names, the feature can be enabled by setting @code{suggest_on_error} to
@code{True}. Note that this only applies for arguments when the choices specified
are strings:

@example
>>> parser = argparse.ArgumentParser(description='Process some integers.', suggest_on_error=True)
>>> parser.add_argument('--action', choices=['sum', 'max'])
>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
...                     help='an integer for the accumulator')
>>> parser.parse_args(['--action', 'sumn', 1, 2, 3])
tester.py: error: argument --action: invalid choice: 'sumn', maybe you meant 'sum'? (choose from 'sum', 'max')
@end example


Added in version 3.14.


@node El método add_argument,El método parse_args,Objetos ArgumentParser,argparse — Parser for command-line options arguments and subcommands
@anchor{library/argparse the-add-argument-method}@anchor{2c77}
@subsubsection El método `add_argument()'


@geindex add_argument() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_argument}@anchor{306}
@deffn {Método} ArgumentParser.add_argument (name or flags..., *[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest][, deprecated])

Define cómo se debe interpretar un determinado argumento de línea de comandos. Cada parámetro tiene su propia descripción más detallada a continuación, pero en resumen son:


@itemize *

@item 
@ref{2c78,,name or flags} - Either a name or a list of option strings, e.g. @code{'foo'}
or @code{'-f', '--foo'}.

@item 
@ref{15c0,,action} - El tipo básico de acción a tomar cuando este argumento se encuentra en la línea de comandos.

@item 
@ref{15c6,,nargs} - El número de argumentos de la línea de comandos que deben ser consumidos.

@item 
@ref{15c8,,const} - Un valor fijo requerido por algunas selecciones de @ref{15c0,,action} y @ref{15c6,,nargs}.

@item 
@ref{15c7,,default} - El valor producido si el argumento está ausente en la línea de comando y si está ausente en el objeto de espacio de nombres.

@item 
@ref{2c72,,type} - El tipo al que debe convertirse el argumento de la línea de comandos.

@item 
@ref{15c2,,choices} - Una secuencia de valores permitidos para el argumento.

@item 
@ref{2c79,,required} - Si se puede omitir o no la opción de la línea de comandos (sólo opcionales).

@item 
@ref{2c7a,,help} - Una breve descripción de lo que hace el argumento.

@item 
@ref{2c7b,,metavar} - Un nombre para el argumento en los mensajes de uso.

@item 
@ref{2c73,,dest} - El nombre del atributo que será añadido al objeto retornado por @ref{2c5d,,parse_args()}.

@item 
@ref{2c7c,,deprecated} - Whether or not use of the argument is deprecated.
@end itemize
@end deffn

En las siguientes secciones se describe cómo se utiliza cada una de ellas.

@menu
* name or flags:: 
* action:: 
* nargs:: 
* const:: 
* default:: 
* type:: 
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Las clases Action:: 

@end menu

@node name or flags,action,,El método add_argument
@anchor{library/argparse id5}@anchor{2c7d}@anchor{library/argparse name-or-flags}@anchor{2c78}
@subsubsection `name or flags'


El método @ref{306,,add_argument()} debe saber si espera un argumento opcional, como @code{-f} o @code{--foo}, o un argumento posicional, como una lista de nombres de archivos. Los primeros argumentos que se pasan a @ref{306,,add_argument()} deben ser o bien una serie de banderas (`flags'), o un simple nombre de un argumento (`name').

Por ejemplo, se puede crear un argumento opcional como:

@example
>>> parser.add_argument('-f', '--foo')
@end example

mientras que un argumento posicional podría ser creado como:

@example
>>> parser.add_argument('bar')
@end example

Cuando se llama a @ref{2c5d,,parse_args()} , los argumentos opcionales serán identificados por el prefijo @code{-}, y el resto de los argumentos serán asumidos como posicionales:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args(['BAR'])
Namespace(bar='BAR', foo=None)
>>> parser.parse_args(['BAR', '--foo', 'FOO'])
Namespace(bar='BAR', foo='FOO')
>>> parser.parse_args(['--foo', 'FOO'])
usage: PROG [-h] [-f FOO] bar
PROG: error: the following arguments are required: bar
@end example

By default, @code{argparse} automatically handles the internal naming and
display names of arguments, simplifying the process without requiring
additional configuration.
As such, you do not need to specify the @ref{2c73,,dest} and @ref{2c7b,,metavar} parameters.
The @ref{2c73,,dest} parameter defaults to the argument name with underscores @code{_}
replacing hyphens @code{-} . The @ref{2c7b,,metavar} parameter defaults to the
upper-cased name. For example:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo-bar')
>>> parser.parse_args(['--foo-bar', 'FOO-BAR']
Namespace(foo_bar='FOO-BAR')
>>> parser.print_help()
usage:  [-h] [--foo-bar FOO-BAR]

optional arguments:
 -h, --help  show this help message and exit
 --foo-bar FOO-BAR
@end example

@node action,nargs,name or flags,El método add_argument
@anchor{library/argparse action}@anchor{15c0}@anchor{library/argparse id6}@anchor{2c7e}
@subsubsection `action'


Los objetos @ref{15c,,ArgumentParser} asocian los argumentos de la línea de comandos con las acciones. Esta acciones pueden hacer casi cualquier cosa con los argumentos de línea de comandos asociados a ellas, aunque la mayoría de las acciones simplemente añaden un atributo al objeto retornado por @ref{2c5d,,parse_args()}. El argumento de palabra clave @code{action} especifica cómo deben ser manejados los argumentos de la línea de comandos. Las acciones proporcionadas son:


@itemize *

@item 
@code{'store'} - This just stores the argument’s value.  This is the default
action.

@item 
@code{'store_const'} - Esto almacena el valor especificado por el argumento de palabra clave @ref{15c8,,const}; nótese que el argumento de palabra clave @ref{15c8,,const} por defecto es @code{None}. La acción @code{'store_const'} se usa comúnmente con argumentos opcionales que especifican algún tipo de indicador (`flag'). Por ejemplo:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_const', const=42)
>>> parser.parse_args(['--foo'])
Namespace(foo=42)
@end example

@item 
@code{'store_true'} and @code{'store_false'} - These are special cases of
@code{'store_const'} used for storing the values @code{True} and @code{False}
respectively.  In addition, they create default values of @code{False} and
@code{True} respectively:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)
@end example

@item 
@code{'append'} - Esto almacena una lista, y añade cada valor del argumento a la lista. Es útil para permitir que una opción sea especificada varias veces. Si el valor por defecto es no vacío, los elementos por defecto estarán presentes en el valor analizado para la opción, con los valores de la línea de comandos añadidos después de los valores por defecto. Ejemplo de uso:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='append')
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['1', '2'])
@end example

@item 
@code{'append_const'} - Esto almacena una lista, y añade los valores especificados por el argumento de palabra clave @ref{15c8,,const}; nótese que el argumento de palabra clave @ref{15c8,,const} por defecto es @code{None}. La acción @code{'append_const'} es comúnmente útil cuando múltiples argumentos necesitan almacenar constantes en la misma lista. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--str', dest='types', action='append_const', const=str)
>>> parser.add_argument('--int', dest='types', action='append_const', const=int)
>>> parser.parse_args('--str --int'.split())
Namespace(types=[<class 'str'>, <class 'int'>])
@end example

@item 
@code{'extend'} - This stores a list and appends each item from the multi-value
argument list to it.
The @code{'extend'} action is typically used with the @ref{15c6,,nargs} keyword argument
value @code{'+'} or @code{'*'}.
Note that when @ref{15c6,,nargs} is @code{None} (the default) or @code{'?'}, each
character of the argument string will be appended to the list.
Example usage:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--foo", action="extend", nargs="+", type=str)
>>> parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"])
Namespace(foo=['f1', 'f2', 'f3', 'f4'])
@end example


Added in version 3.8.


@item 
@code{'count'} - Esta cuenta el número de veces que un argumento de palabra clave aparece. Por ejemplo, esto es útil para incrementar los niveles de detalle:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--verbose', '-v', action='count', default=0)
>>> parser.parse_args(['-vvv'])
Namespace(verbose=3)
@end example

Observa, `default' (el valor por defecto) será @code{None} a menos que explícitamente se establezca como `0'.

@item 
@code{'help'} - Esta imprime un mensaje de ayuda completo para todas las opciones del analizador actual y luego termina. Por defecto, se añade una acción de ayuda automáticamente al analizador. Ver @ref{15c,,ArgumentParser} para detalles de cómo se genera la salida.

@item 
@code{’version’} - Esta espera un argumento de palabra clave @code{version=} en la llamada @ref{306,,add_argument()}, e imprime la información de la versión y finaliza cuando es invocada:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')
>>> parser.parse_args(['--version'])
PROG 2.0
@end example
@end itemize

Only actions that consume command-line arguments (e.g. @code{'store'},
@code{'append'} or @code{'extend'}) can be used with positional arguments.

@geindex BooleanOptionalAction (clase en argparse)
@anchor{library/argparse argparse BooleanOptionalAction}@anchor{185d}
@deffn {Clase} argparse.BooleanOptionalAction

You may also specify an arbitrary action by passing an @ref{1806,,Action} subclass or
other object that implements the same interface. The @code{BooleanOptionalAction}
is available in @code{argparse} and adds support for boolean actions such as
@code{--foo} and @code{--no-foo}:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
>>> parser.parse_args(['--no-foo'])
Namespace(foo=False)
@end example


Added in version 3.9.

@end deffn

The recommended way to create a custom action is to extend @ref{1806,,Action},
overriding the @code{__call__()} method and optionally the @code{__init__()} and
@code{format_usage()} methods.

Un ejemplo de una acción personalizada:

@example
>>> class FooAction(argparse.Action):
...     def __init__(self, option_strings, dest, nargs=None, **kwargs):
...         if nargs is not None:
...             raise ValueError("nargs not allowed")
...         super().__init__(option_strings, dest, **kwargs)
...     def __call__(self, parser, namespace, values, option_string=None):
...         print('%r %r %r' % (namespace, values, option_string))
...         setattr(namespace, self.dest, values)
...
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=FooAction)
>>> parser.add_argument('bar', action=FooAction)
>>> args = parser.parse_args('1 --foo 2'.split())
Namespace(bar=None, foo=None) '1' None
Namespace(bar='1', foo=None) '2' '--foo'
>>> args
Namespace(bar='1', foo='2')
@end example

Para más detalles, ver @ref{1806,,Action}.

@node nargs,const,action,El método add_argument
@anchor{library/argparse id7}@anchor{2c7f}@anchor{library/argparse nargs}@anchor{15c6}
@subsubsection `nargs'


@ref{15c,,ArgumentParser} objects usually associate a single command-line argument with a
single action to be taken.  The @code{nargs} keyword argument associates a
different number of command-line arguments with a single action.
See also @ref{2c80,,Especificando argumentos ambiguos}. The supported values are:


@itemize *

@item 
@code{N} (un entero). @code{N} argumentos de la línea de comandos se agruparán en una lista. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs=2)
>>> parser.add_argument('bar', nargs=1)
>>> parser.parse_args('c --foo a b'.split())
Namespace(bar=['c'], foo=['a', 'b'])
@end example

Ten en cuenta que @code{nargs=1} produce una lista de un elemento. Esto es diferente del valor por defecto, en el que el elemento se produce por sí mismo.
@end itemize

@geindex ? (signo de interrogación);en el módulo argparse


@itemize *

@item 
@code{’?’}. Un argumento se consumirá desde la línea de comandos si es posible, y se generará como un sólo elemento. Si no hay ningún argumento de línea de comandos, se obtendrá el valor de @ref{15c7,,default}. Ten en cuenta que para los argumentos opcionales, hay un caso adicional - la cadena de caracteres de opción está presente pero no va seguida de un argumento de línea de comandos. En este caso se obtendrá el valor de @ref{15c8,,const}. Algunos ejemplos para ilustrar esto:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs='?', const='c', default='d')
>>> parser.add_argument('bar', nargs='?', default='d')
>>> parser.parse_args(['XX', '--foo', 'YY'])
Namespace(bar='XX', foo='YY')
>>> parser.parse_args(['XX', '--foo'])
Namespace(bar='XX', foo='c')
>>> parser.parse_args([])
Namespace(bar='d', foo='d')
@end example

Uno de los usos más comunes de @code{nargs='?'} es permitir archivos de entrada y salida opcionales:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', nargs='?')
>>> parser.add_argument('outfile', nargs='?')
>>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile='input.txt', outfile='output.txt')
>>> parser.parse_args(['input.txt'])
Namespace(infile='input.txt', outfile=None)
>>> parser.parse_args([])
Namespace(infile=None, outfile=None)
@end example
@end itemize

@geindex * (asterisco);en el módulo argparse


@itemize *

@item 
@code{’*’}. Todos los argumentos presentes en la línea de comandos se recogen en una lista. Ten en cuenta que generalmente no tiene mucho sentido tener más de un argumento posicional con @code{nargs=‘*’}, pero es posible tener múltiples argumentos opcionales con @code{nargs=‘*’}. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs='*')
>>> parser.add_argument('--bar', nargs='*')
>>> parser.add_argument('baz', nargs='*')
>>> parser.parse_args('a b --foo x y --bar 1 2'.split())
Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y'])
@end example
@end itemize

@geindex + (más);en el módulo argparse


@itemize *

@item 
@code{'+'}. Al igual que @code{'*'}, todos los argumentos de la línea de comandos se recogen en una lista. Además, se generará un mensaje de error si no había al menos un argumento presente en la línea de comandos. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('foo', nargs='+')
>>> parser.parse_args(['a', 'b'])
Namespace(foo=['a', 'b'])
>>> parser.parse_args([])
usage: PROG [-h] foo [foo ...]
PROG: error: the following arguments are required: foo
@end example
@end itemize

If the @code{nargs} keyword argument is not provided, the number of arguments consumed
is determined by the @ref{15c0,,action}.  Generally this means a single command-line argument
will be consumed and a single item (not a list) will be produced.
Actions that do not consume command-line arguments (e.g.
@code{'store_const'}) set @code{nargs=0}.

@node const,default,nargs,El método add_argument
@anchor{library/argparse const}@anchor{15c8}@anchor{library/argparse id8}@anchor{2c81}
@subsubsection `const'


El argumento @code{const} de @ref{306,,add_argument()} se usa para mantener valores constantes que no se leen desde la línea de comandos pero que son necesarios para las diversas acciones de @ref{15c,,ArgumentParser}. Los dos usos más comunes son:


@itemize *

@item 
Cuando @ref{306,,add_argument()} es llamado con @code{action='store_const'} o @code{action='append_const'}. Estas acciones añaden el valor @code{const} a uno de los atributos del objeto retornado por @ref{2c5d,,parse_args()}. Mira la descripción @ref{15c0,,action} para ver ejemplos. Si @code{const} no es proporcionado a @ref{306,,add_argument()}, este recibirá el valor por defecto @code{None}.

@item 
Cuando @ref{306,,add_argument()} es llamado con las cadenas de opción (como @code{-f} o @code{—foo}) y @code{nargs=‘?’}. Esto crea un argumento opcional que puede ir seguido de cero o un argumento de línea de comandos. Al analizar la línea de comandos, si la cadena de opciones se encuentra sin ningún argumento de línea de comandos que la siga, asumirá en su lugar el valor de @code{const}. Mira la descripción @ref{15c6,,nargs} para ejemplos.
@end itemize


Distinto en la versión 3.11: Por defecto @code{const=None}, incluyendo cuando @code{action='append_const'} o @code{action='store_const'}.


@node default,type,const,El método add_argument
@anchor{library/argparse default}@anchor{15c7}@anchor{library/argparse id9}@anchor{2c82}
@subsubsection `default'


Todos los argumentos opcionales y algunos argumentos posicionales pueden ser omitidos en la línea de comandos. El argumento de palabra clave @code{default} de @ref{306,,add_argument()}, cuyo valor por defecto es @code{None}, especifica qué valor debe usarse si el argumento de línea de comandos no está presente. Para los argumentos opcionales, se usa el valor @code{default} cuando la cadena de caracteres de opción no está presente en la línea de comandos:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args(['--foo', '2'])
Namespace(foo='2')
>>> parser.parse_args([])
Namespace(foo=42)
@end example

If the target namespace already has an attribute set, the action `default'
will not overwrite it:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
Namespace(foo=101)
@end example

Si el valor @code{default} es una cadena de caracteres, el analizador procesa el valor como si fuera un argumento de la línea de comandos. En particular, el analizador aplica cualquier argumento de conversión @ref{2c72,,type} , si se proporciona, antes de establecer el atributo en el valor de retorno @ref{2c5e,,Namespace}. En caso contrario, el analizador utiliza el valor tal y como es:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--length', default='10', type=int)
>>> parser.add_argument('--width', default=10.5, type=int)
>>> parser.parse_args()
Namespace(length=10, width=10.5)
@end example

Para argumentos posiciones con @ref{15c6,,nargs} igual a @code{?} o @code{*}, el valor @code{default} se utiliza cuando no hay ningún argumento de línea de comandos presente:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', nargs='?', default=42)
>>> parser.parse_args(['a'])
Namespace(foo='a')
>>> parser.parse_args([])
Namespace(foo=42)
@end example

For @ref{2c79,,required} arguments, the @code{default} value is ignored. For example, this
applies to positional arguments with @ref{15c6,,nargs} values other than @code{?} or @code{*},
or optional arguments marked as @code{required=True}.

Proporcionar @code{default=argparse.SUPPRESS} causa que no se agregue ningún atributo si el argumento de la línea de comandos no está presente:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=argparse.SUPPRESS)
>>> parser.parse_args([])
Namespace()
>>> parser.parse_args(['--foo', '1'])
Namespace(foo='1')
@end example

@node type,choices,default,El método add_argument
@anchor{library/argparse argparse-type}@anchor{2c83}@anchor{library/argparse type}@anchor{2c72}
@subsubsection `type'


De forma predeterminada, el analizador lee los argumentos de la línea de comandos como cadenas simples. Sin embargo, a menudo, la cadena de la línea de comandos debe interpretarse como otro tipo, como @ref{153,,float} o @ref{1f0,,int}. La palabra clave @code{type} para @ref{306,,add_argument()} permite realizar cualquier verificación de tipo y conversión de tipo necesaria.

Si la palabra clave @ref{2c72,,type} se usa con la palabra clave @ref{15c7,,default}, el convertidor de tipos solo se aplica si el valor predeterminado es una cadena de caracteres.

El argumento para @code{type} puede ser cualquier invocable que acepte una sola cadena de caracteres. Si la función lanza @ref{2c84,,ArgumentTypeError}, @ref{228,,TypeError}, o @ref{360,,ValueError}, se detecta la excepción y se muestra un mensaje de error con un formato agradable. No se manejan otros tipos de excepciones.

Los tipos y funciones incorporados comunes se pueden utilizar como convertidores de tipos:

@example
import argparse
import pathlib

parser = argparse.ArgumentParser()
parser.add_argument('count', type=int)
parser.add_argument('distance', type=float)
parser.add_argument('street', type=ascii)
parser.add_argument('code_point', type=ord)
parser.add_argument('datapath', type=pathlib.Path)
@end example

Las funciones definidas por el usuario también se pueden utilizar:

@example
>>> def hyphenated(string):
...     return '-'.join([word[:4] for word in string.casefold().split()])
...
>>> parser = argparse.ArgumentParser()
>>> _ = parser.add_argument('short_title', type=hyphenated)
>>> parser.parse_args(['"The Tale of Two Cities"'])
Namespace(short_title='"the-tale-of-two-citi')
@end example

La función @ref{513,,bool()} no se recomienda como convertidor de tipos. Todo lo que hace es convertir cadenas de caracteres vacías en @code{False} y cadenas de caracteres no vacías en @code{True}. Por lo general, esto no es lo que se desea.

En general, la palabra clave @code{type} es una conveniencia que solo debe usarse para conversiones simples que solo pueden generar una de las tres excepciones admitidas. Cualquier cosa con un manejo de errores o de recursos más interesante debe hacerse en sentido descendente después de analizar los argumentos.

Por ejemplo, las conversiones JSON o YAML tienen casos de error complejos que requieren mejores informes que los que puede proporcionar la palabra clave @code{type}. Un @ref{ea5,,JSONDecodeError} no estaría bien formateado y un @ref{f46,,FileNotFoundError} no se manejaría en absoluto.

Even @ref{1c2,,FileType} has its limitations for use with the @code{type}
keyword.  If one argument uses @ref{1c2,,FileType} and then a
subsequent argument fails, an error is reported but the file is not
automatically closed.  In this case, it would be better to wait until after
the parser has run and then use the @ref{673,,with}-statement to manage the
files.

Para los verificadores de tipo que simplemente verifican un conjunto fijo de valores, considere usar la palabra clave @ref{15c2,,choices} en su lugar.

@node choices,required,type,El método add_argument
@anchor{library/argparse choices}@anchor{15c2}@anchor{library/argparse id10}@anchor{2c85}
@subsubsection `choices'


Algunos argumentos de la línea de comandos deberían seleccionarse de un conjunto restringido de valores. Estos pueden ser manejados pasando un objeto de secuencia como el argumento de palabra clave `choices' a @ref{306,,add_argument()}. Cuando se analiza la línea de comandos, se comprueban los valores de los argumentos y se muestra un mensaje de error si el argumento no era uno de los valores aceptables:

@example
>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args(['rock'])
Namespace(move='rock')
>>> parser.parse_args(['fire'])
usage: game.py [-h] @{rock,paper,scissors@}
game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')
@end example

Note that inclusion in the `choices' sequence is checked after any @ref{2c72,,type}
conversions have been performed, so the type of the objects in the `choices'
sequence should match the @ref{2c72,,type} specified.

Se puede pasar cualquier secuencia como el valor para `choices', así que los objetos @ref{18e,,list}, @ref{464,,tuple} , y las secuencias personalizadas están soportados.

No se recomienda el uso de @ref{6d1,,enum.Enum} porque es difícil controlar su apariencia en el uso, la ayuda y los mensajes de error.

Las opciones formateadas anulan el `metavar' predeterminado que normalmente se deriva de `dest'. Esto suele ser lo que se quiere porque el usuario nunca ve el parámetro `dest'. Si esta visualización no es deseable (quizás porque hay muchas opciones), simplemente especifique un @ref{2c7b,,metavar} explícito.

@node required,help,choices,El método add_argument
@anchor{library/argparse id11}@anchor{2c86}@anchor{library/argparse required}@anchor{2c79}
@subsubsection `required'


In general, the @code{argparse} module assumes that flags like @code{-f} and @code{--bar}
indicate `optional' arguments, which can always be omitted at the command line.
To make an option `required', @code{True} can be specified for the @code{required=}
keyword argument to @ref{306,,add_argument()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', required=True)
>>> parser.parse_args(['--foo', 'BAR'])
Namespace(foo='BAR')
>>> parser.parse_args([])
usage: [-h] --foo FOO
: error: the following arguments are required: --foo
@end example

Como muestra el ejemplo, si una opción está marcada como @code{required}, @ref{2c5d,,parse_args()} informará de un error si esa opción no está presente en la línea de comandos.

@cartouche
@quotation Nota 
Las opciones requeridas están consideradas generalmente mala práctica porque los usuarios esperan que las `opciones' sean `opcionales', y por lo tanto deberían ser evitadas cuando sea posible.
@end quotation
@end cartouche

@node help,metavar,required,El método add_argument
@anchor{library/argparse help}@anchor{2c7a}@anchor{library/argparse id12}@anchor{2c87}
@subsubsection `help'


The @code{help} value is a string containing a brief description of the argument.
When a user requests help (usually by using @code{-h} or @code{--help} at the
command line), these @code{help} descriptions will be displayed with each
argument.

Las cadenas de texto @code{help} pueden incluir varios descriptores de formato para evitar la repetición de cosas como el nombre del programa o el argumento @ref{15c7,,default}. Los descriptores disponibles incluyen el nombre del programa, @code{%(prog)s} y la mayoría de los argumentos de palabra clave de @ref{306,,add_argument()}, por ejemplo @code{%(default)s}, @code{%(type)s}, etc.:

@example
>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('bar', nargs='?', type=int, default=42,
...                     help='the bar to %(prog)s (default: %(default)s)')
>>> parser.print_help()
usage: frobble [-h] [bar]

positional arguments:
 bar     the bar to frobble (default: 42)

options:
 -h, --help  show this help message and exit
@end example

Como la cadena de caracteres de ayuda soporta el formato-%, si se quiere que aparezca un @code{%} literal en la cadena de caracteres de ayuda, se debe escribir como @code{%%}.

@code{argparse} supports silencing the help entry for certain options, by
setting the @code{help} value to @code{argparse.SUPPRESS}:

@example
>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('--foo', help=argparse.SUPPRESS)
>>> parser.print_help()
usage: frobble [-h]

options:
  -h, --help  show this help message and exit
@end example

@node metavar,dest,help,El método add_argument
@anchor{library/argparse id13}@anchor{2c88}@anchor{library/argparse metavar}@anchor{2c7b}
@subsubsection `metavar'


When @ref{15c,,ArgumentParser} generates help messages, it needs some way to refer
to each expected argument.  By default, @code{ArgumentParser} objects use the @ref{2c73,,dest}
value as the «name» of each object.  By default, for positional argument
actions, the @ref{2c73,,dest} value is used directly, and for optional argument actions,
the @ref{2c73,,dest} value is uppercased.  So, a single positional argument with
@code{dest='bar'} will be referred to as @code{bar}. A single
optional argument @code{--foo} that should be followed by a single command-line argument
will be referred to as @code{FOO}.  An example:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args('X --foo Y'.split())
Namespace(bar='X', foo='Y')
>>> parser.print_help()
usage:  [-h] [--foo FOO] bar

positional arguments:
 bar

options:
 -h, --help  show this help message and exit
 --foo FOO
@end example

Un nombre alternativo se puede especificar con @code{metavar}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', metavar='YYY')
>>> parser.add_argument('bar', metavar='XXX')
>>> parser.parse_args('X --foo Y'.split())
Namespace(bar='X', foo='Y')
>>> parser.print_help()
usage:  [-h] [--foo YYY] XXX

positional arguments:
 XXX

options:
 -h, --help  show this help message and exit
 --foo YYY
@end example

Ten en cuenta que @code{metavar} sólo cambia el nombre `mostrado' - el nombre del atributo en el objeto @ref{2c5d,,parse_args()} sigue estando determinado por el valor @ref{2c73,,dest}.

Diferentes valores de @code{nargs} pueden causar que `metavar' sea usado múltiples veces. Proporcionar una tupla a @code{metavar} especifica una visualización diferente para cada uno de los argumentos:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x', nargs=2)
>>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz'))
>>> parser.print_help()
usage: PROG [-h] [-x X X] [--foo bar baz]

options:
 -h, --help     show this help message and exit
 -x X X
 --foo bar baz
@end example

@node dest,deprecated,metavar,El método add_argument
@anchor{library/argparse dest}@anchor{2c73}@anchor{library/argparse id14}@anchor{2c89}
@subsubsection `dest'


La mayoría de las acciones @ref{15c,,ArgumentParser} añaden algún valor como atributo del objeto retornado por @ref{2c5d,,parse_args()}. El nombre de este atributo está determinado por el argumento de palabra clave @code{dest} de @ref{306,,add_argument()}. Para acciones de argumento posicional, se proporciona @code{dest} normalmente como primer argumento de @ref{306,,add_argument()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar')
>>> parser.parse_args(['XXX'])
Namespace(bar='XXX')
@end example

Para las acciones de argumentos opcionales, el valor de @code{dest} se infiere normalmente de las cadenas de caracteres de opción.  @ref{15c,,ArgumentParser} genera el valor de @code{dest} tomando la primera cadena de caracteres de opción larga y quitando la cadena inicial @code{--}. Si no se proporcionaron cadenas de caracteres de opción largas, @code{dest} se derivará de la primera cadena de caracteres de opción corta quitando el carácter @code{-}. Cualquier carácter @code{-} interno se convertirá a caracteres @code{_} para asegurarse de que la cadena de caracteres es un nombre de atributo válido. Los ejemplos siguientes ilustran este comportamiento:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-f', '--foo-bar', '--foo')
>>> parser.add_argument('-x', '-y')
>>> parser.parse_args('-f 1 -x 2'.split())
Namespace(foo_bar='1', x='2')
>>> parser.parse_args('--foo 1 -y 2'.split())
Namespace(foo_bar='1', x='2')
@end example

@code{dest} permite que se proporcione un nombre de atributo personalizado:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')
@end example

@node deprecated,Las clases Action,dest,El método add_argument
@anchor{library/argparse deprecated}@anchor{2c7c}@anchor{library/argparse id15}@anchor{2c8a}
@subsubsection deprecated


During a project’s lifetime, some arguments may need to be removed from the
command line. Before removing them, you should inform
your users that the arguments are deprecated and will be removed.
The @code{deprecated} keyword argument of
@ref{306,,add_argument()}, which defaults to @code{False},
specifies if the argument is deprecated and will be removed
in the future.
For arguments, if @code{deprecated} is @code{True}, then a warning will be
printed to @ref{9cc,,sys.stderr} when the argument is used:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='snake.py')
>>> parser.add_argument('--legs', default=0, type=int, deprecated=True)
>>> parser.parse_args([])
Namespace(legs=0)
>>> parser.parse_args(['--legs', '4'])  
snake.py: warning: option '--legs' is deprecated
Namespace(legs=4)
@end example


Added in version 3.13.


@node Las clases Action,,deprecated,El método add_argument
@anchor{library/argparse action-classes}@anchor{2c8b}
@subsubsection Las clases `Action'


@code{Action} classes implement the Action API, a callable which returns a callable
which processes arguments from the command-line. Any object which follows
this API may be passed as the @code{action} parameter to
@ref{306,,add_argument()}.

@geindex Action (clase en argparse)
@anchor{library/argparse argparse Action}@anchor{1806}
@deffn {Clase} argparse.Action (option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

@code{Action} objects are used by an @ref{15c,,ArgumentParser} to represent the information
needed to parse a single argument from one or more strings from the
command line. The @code{Action} class must accept the two positional arguments
plus any keyword arguments passed to @ref{306,,ArgumentParser.add_argument()}
except for the @code{action} itself.

Instances of @code{Action} (or return value of any callable to the
@code{action} parameter) should have attributes @code{dest},
@code{option_strings}, @code{default}, @code{type}, @code{required},
@code{help}, etc. defined. The easiest way to ensure these attributes
are defined is to call @code{Action.__init__()}.

@geindex __call__() (método de argparse.Action)
@anchor{library/argparse argparse Action __call__}@anchor{2c8c}
@deffn {Método} __call__ (parser, namespace, values, option_string=None)

@code{Action} instances should be callable, so subclasses must override the
@code{__call__()} method, which should accept four parameters:


@itemize *

@item 
`parser' - The @ref{15c,,ArgumentParser} object which contains this action.

@item 
`namespace' - The @ref{2c5e,,Namespace} object that will be returned by
@ref{2c5d,,parse_args()}.  Most actions add an attribute to this
object using @ref{215f,,setattr()}.

@item 
`values' - The associated command-line arguments, with any type conversions
applied.  Type conversions are specified with the @ref{2c72,,type} keyword argument to
@ref{306,,add_argument()}.

@item 
`option_string' - The option string that was used to invoke this action.
The @code{option_string} argument is optional, and will be absent if the action
is associated with a positional argument.
@end itemize

The @code{__call__()} method may perform arbitrary actions, but will typically set
attributes on the @code{namespace} based on @code{dest} and @code{values}.
@end deffn

@geindex format_usage() (método de argparse.Action)
@anchor{library/argparse argparse Action format_usage}@anchor{2c8d}
@deffn {Método} format_usage ()

@code{Action} subclasses can define a @code{format_usage()} method that takes no argument
and return a string which will be used when printing the usage of the program.
If such method is not provided, a sensible default will be used.
@end deffn
@end deffn

@node El método parse_args,Otras utilidades,El método add_argument,argparse — Parser for command-line options arguments and subcommands
@anchor{library/argparse the-parse-args-method}@anchor{2c8e}
@subsubsection El método `parse_args()'


@geindex parse_args() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_args}@anchor{2c5d}
@deffn {Método} ArgumentParser.parse_args (args=None, namespace=None)

Convierte las cadenas de caracteres de argumentos en objetos y los asigna como atributos del espacio de nombres (`namespace'). Retorna el espacio de nombres (`namespace') ocupado.

Previous calls to @ref{306,,add_argument()} determine exactly what objects are
created and how they are assigned. See the documentation for
@code{add_argument()} for details.


@itemize *

@item 
@ref{2c8f,,args} - Lista de cadenas de caracteres para analizar. El valor por defecto se toma de @ref{12d2,,sys.argv}.

@item 
@ref{2c90,,namespace} - Un objeto para obtener los atributos. Por defecto es un nuevo objeto vacío @ref{2c5e,,Namespace}.
@end itemize
@end deffn

@menu
* Sintaxis del valor de la opción:: 
* Argumentos no válidos:: 
* Argumentos conteniendo -:: 
* Abreviaturas de los argumentos (coincidencia de prefijos): Abreviaturas de los argumentos coincidencia de prefijos. 
* Más allá de sys.argv: Más allá de sys argv. 
* El objeto Namespace:: 

@end menu

@node Sintaxis del valor de la opción,Argumentos no válidos,,El método parse_args
@anchor{library/argparse option-value-syntax}@anchor{2c91}
@subsubsection Sintaxis del valor de la opción


El método @ref{2c5d,,parse_args()} soporta diversas formas de especificar el valor de una opción (si requiere uno). En el caso más simple, la opción y su valor se pasan como dos argumentos separados:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')
>>> parser.parse_args(['--foo', 'FOO'])
Namespace(foo='FOO', x=None)
@end example

En el caso de opciones largas (opciones con nombres más largos que un sólo carácter), la opción y el valor también se pueden pasar como un sólo argumento de línea de comandos, utilizando @code{=} para separarlos:

@example
>>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)
@end example

Para las opciones cortas (opciones de un sólo carácter de largo), la opción y su valor pueden ser concatenados:

@example
>>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')
@end example

Se pueden unir varias opciones cortas, usando un sólo prefijo @code{-}, siempre y cuando sólo la última opción (o ninguna de ellas) requiera un valor:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x', action='store_true')
>>> parser.add_argument('-y', action='store_true')
>>> parser.add_argument('-z')
>>> parser.parse_args(['-xyzZ'])
Namespace(x=True, y=True, z='Z')
@end example

@node Argumentos no válidos,Argumentos conteniendo -,Sintaxis del valor de la opción,El método parse_args
@anchor{library/argparse invalid-arguments}@anchor{2c92}
@subsubsection Argumentos no válidos


Mientras analiza la línea de comandos, @ref{2c5d,,parse_args()} comprueba una variedad de errores, incluyendo opciones ambiguas, tipos no válidos, opciones no válidas, número incorrecto de argumentos de posición, etc. Cuando encuentra un error de este tipo, termina y muestra el error junto con un mensaje de uso:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', type=int)
>>> parser.add_argument('bar', nargs='?')

>>> # invalid type
>>> parser.parse_args(['--foo', 'spam'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: argument --foo: invalid int value: 'spam'

>>> # invalid option
>>> parser.parse_args(['--bar'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: no such option: --bar

>>> # wrong number of arguments
>>> parser.parse_args(['spam', 'badger'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: extra arguments found: badger
@end example

@node Argumentos conteniendo -,Abreviaturas de los argumentos coincidencia de prefijos,Argumentos no válidos,El método parse_args
@anchor{library/argparse arguments-containing}@anchor{2c93}
@subsubsection Argumentos conteniendo @code{-}


El método @ref{2c5d,,parse_args()} busca generar errores cuando el usuario ha cometido claramente una equivocación, pero algunas situaciones son inherentemente ambiguas. Por ejemplo, el argumento de línea de comandos @code{-1} podría ser un intento de especificar una opción o un intento de proporcionar un argumento de posición. El método @ref{2c5d,,parse_args()} es cauteloso aquí: los argumentos de posición sólo pueden comenzar con @code{-} si se ven como números negativos y no hay opciones en el analizador que se puedan ver como números negativos

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('foo', nargs='?')

>>> # no negative number options, so -1 is a positional argument
>>> parser.parse_args(['-x', '-1'])
Namespace(foo=None, x='-1')

>>> # no negative number options, so -1 and -5 are positional arguments
>>> parser.parse_args(['-x', '-1', '-5'])
Namespace(foo='-5', x='-1')

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-1', dest='one')
>>> parser.add_argument('foo', nargs='?')

>>> # negative number options present, so -1 is an option
>>> parser.parse_args(['-1', 'X'])
Namespace(foo=None, one='X')

>>> # negative number options present, so -2 is an option
>>> parser.parse_args(['-2'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: no such option: -2

>>> # negative number options present, so both -1s are options
>>> parser.parse_args(['-1', '-1'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: argument -1: expected one argument
@end example

Si tienes argumentos de posición que deben comenzar con @code{-} y no parecen números negativos, puedes insertar el pseudo-argumento @code{'--'} que indica a @ref{2c5d,,parse_args()} que todo lo que sigue es un argumento de posición:

@example
>>> parser.parse_args(['--', '-f'])
Namespace(foo='-f', one=None)
@end example

También ver @ref{2c80,,la guía de argparse sobre cómo manejar argumentos ambiguos} para más detalles.

@node Abreviaturas de los argumentos coincidencia de prefijos,Más allá de sys argv,Argumentos conteniendo -,El método parse_args
@anchor{library/argparse argument-abbreviations-prefix-matching}@anchor{2c94}@anchor{library/argparse prefix-matching}@anchor{e44}
@subsubsection Abreviaturas de los argumentos (coincidencia de prefijos)


El método @ref{2c5d,,parse_args()} @ref{e45,,por defecto} permite abreviar las opciones largas a un prefijo, si la abreviatura es inequívoca (el prefijo coincide con una opción única):

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-bacon')
>>> parser.add_argument('-badger')
>>> parser.parse_args('-bac MMM'.split())
Namespace(bacon='MMM', badger=None)
>>> parser.parse_args('-bad WOOD'.split())
Namespace(bacon=None, badger='WOOD')
>>> parser.parse_args('-ba BA'.split())
usage: PROG [-h] [-bacon BACON] [-badger BADGER]
PROG: error: ambiguous option: -ba could match -badger, -bacon
@end example

Se incurre en un error por argumentos que podrían derivar en más de una opción. Esta característica puede ser desactivada poniendo @ref{e45,,allow_abbrev} a @code{False}.

@node Más allá de sys argv,El objeto Namespace,Abreviaturas de los argumentos coincidencia de prefijos,El método parse_args
@anchor{library/argparse args}@anchor{2c8f}@anchor{library/argparse beyond-sys-argv}@anchor{2c95}
@subsubsection Más allá de @code{sys.argv}


Sometimes it may be useful to have an @ref{15c,,ArgumentParser} parse arguments other than those
of @ref{12d2,,sys.argv}.  This can be accomplished by passing a list of strings to
@ref{2c5d,,parse_args()}.  This is useful for testing at the
interactive prompt:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument(
...     'integers', metavar='int', type=int, choices=range(10),
...     nargs='+', help='an integer in the range 0..9')
>>> parser.add_argument(
...     '--sum', dest='accumulate', action='store_const', const=sum,
...     default=max, help='sum the integers (default: find the max)')
>>> parser.parse_args(['1', '2', '3', '4'])
Namespace(accumulate=<built-in function max>, integers=[1, 2, 3, 4])
>>> parser.parse_args(['1', '2', '3', '4', '--sum'])
Namespace(accumulate=<built-in function sum>, integers=[1, 2, 3, 4])
@end example

@node El objeto Namespace,,Más allá de sys argv,El método parse_args
@anchor{library/argparse namespace}@anchor{2c90}@anchor{library/argparse the-namespace-object}@anchor{2c96}
@subsubsection El objeto `Namespace'


@geindex Namespace (clase en argparse)
@anchor{library/argparse argparse Namespace}@anchor{2c5e}
@deffn {Clase} argparse.Namespace

Clase simple utilizada por defecto por @ref{2c5d,,parse_args()} para crear un objeto que contenga atributos y retornarlo.

Esta clase es deliberadamente simple, sólo una subclase @ref{b18,,object} con una representación de cadena de texto legible. Si prefieres tener una vista en forma de diccionario de los atributos, puedes usar el lenguaje estándar de Python, @ref{1a49,,vars()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
@{'foo': 'BAR'@}
@end example

También puede ser útil tener un @ref{15c,,ArgumentParser} que asigne atributos a un objeto ya existente, en lugar de un nuevo objeto @ref{2c5e,,Namespace}. Esto se puede lograr especificando el argumento de palabra clave @code{namespace=}:

@example
>>> class C:
...     pass
...
>>> c = C()
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)
>>> c.foo
'BAR'
@end example
@end deffn

@node Otras utilidades,Excepciones<8>,El método parse_args,argparse — Parser for command-line options arguments and subcommands
@anchor{library/argparse other-utilities}@anchor{2c97}
@subsubsection Otras utilidades


@menu
* Sub-comandos:: 
* Objetos FileType:: 
* Grupos de argumentos:: 
* Exclusión mutua:: 
* Valores por defecto del analizador:: 
* Mostrando la ayuda:: 
* Análisis parcial:: 
* Personalizando el análisis de archivos:: 
* Métodos de salida:: 
* Análisis entremezclado:: 

@end menu

@node Sub-comandos,Objetos FileType,,Otras utilidades
@anchor{library/argparse sub-commands}@anchor{2c98}
@subsubsection Sub-comandos


@geindex add_subparsers() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_subparsers}@anchor{c9f}
@deffn {Método} ArgumentParser.add_subparsers (*[, title][, description][, prog][, parser_class][, action][, dest][, required][, help][, metavar])

Many programs split up their functionality into a number of subcommands,
for example, the @code{svn} program can invoke subcommands like @code{svn
checkout}, @code{svn update}, and @code{svn commit}.  Splitting up functionality
this way can be a particularly good idea when a program performs several
different functions which require different kinds of command-line arguments.
@ref{15c,,ArgumentParser} supports the creation of such subcommands with the
@code{add_subparsers()} method.  The @code{add_subparsers()} method is normally
called with no arguments and returns a special action object.  This object
has a single method, @code{add_parser()}, which takes a
command name and any @code{ArgumentParser} constructor arguments, and
returns an @code{ArgumentParser} object that can be modified as usual.

Descripción de los parámetros:


@itemize *

@item 
`title' - title for the sub-parser group in help output; by default
«subcommands» if description is provided, otherwise uses title for
positional arguments

@item 
`description' - description for the sub-parser group in help output, by
default @code{None}

@item 
`prog' - usage information that will be displayed with sub-command help,
by default the name of the program and any positional arguments before the
subparser argument

@item 
`parser_class' - class which will be used to create sub-parser instances, by
default the class of the current parser (e.g. @ref{15c,,ArgumentParser})

@item 
@ref{15c0,,action} - el tipo básico de acción a tomar cuando este argumento se encuentre en la línea de comandos

@item 
@ref{2c73,,dest} - nombre del atributo en el que se almacenará el nombre del sub-comando; por defecto @code{None} y no se almacena ningún valor

@item 
@ref{2c79,,required} - Si se debe proporcionar o no un sub-comando, por defecto @code{False} (añadido en 3.7)

@item 
@ref{2c7a,,help} - ayuda para el grupo de análisis secundario en la salida de la ayuda, por defecto @code{None}

@item 
@ref{2c7b,,metavar} - string presenting available subcommands in help; by default it
is @code{None} and presents subcommands in form @{cmd1, cmd2, ..@}
@end itemize

Algún ejemplo de uso:

@example
>>> # create the top-level parser
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', action='store_true', help='foo help')
>>> subparsers = parser.add_subparsers(help='subcommand help')
>>>
>>> # create the parser for the "a" command
>>> parser_a = subparsers.add_parser('a', help='a help')
>>> parser_a.add_argument('bar', type=int, help='bar help')
>>>
>>> # create the parser for the "b" command
>>> parser_b = subparsers.add_parser('b', help='b help')
>>> parser_b.add_argument('--baz', choices=('X', 'Y', 'Z'), help='baz help')
>>>
>>> # parse some argument lists
>>> parser.parse_args(['a', '12'])
Namespace(bar=12, foo=False)
>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
Namespace(baz='Z', foo=True)
@end example

Ten en cuenta que el objeto retornado por @ref{2c5d,,parse_args()} sólo contendrá atributos para el analizador principal y el analizador secundario que fue seleccionado por la línea de comandos (y no cualquier otro analizador secundario). Así que en el ejemplo anterior, cuando se especifica el comando @code{a}, sólo están presentes los atributos @code{foo} y @code{bar}, y cuando se especifica el comando @code{b}, sólo están presentes los atributos @code{foo} y @code{baz}.

Del mismo modo, cuando se solicita un mensaje de ayuda de un analizador secundario, sólo se imprimirá la ayuda para ese analizador en particular. El mensaje de ayuda no incluirá mensajes del analizador principal o de analizadores relacionados. (Sin embargo, se puede dar un mensaje de ayuda para cada comando del analizador secundario suministrando el argumento @code{help=} a @code{add_parser()} como se ha indicado anteriormente).

@example
>>> parser.parse_args(['--help'])
usage: PROG [-h] [--foo] @{a,b@} ...

positional arguments:
  @{a,b@}   subcommand help
    a     a help
    b     b help

options:
  -h, --help  show this help message and exit
  --foo   foo help

>>> parser.parse_args(['a', '--help'])
usage: PROG a [-h] bar

positional arguments:
  bar     bar help

options:
  -h, --help  show this help message and exit

>>> parser.parse_args(['b', '--help'])
usage: PROG b [-h] [--baz @{X,Y,Z@}]

options:
  -h, --help     show this help message and exit
  --baz @{X,Y,Z@}  baz help
@end example

El método @ref{c9f,,add_subparsers()} también soporta los argumentos de palabra clave @code{title} y @code{description}. Cuando cualquiera de los dos esté presente, los comandos del analizador secundario aparecerán en su propio grupo en la salida de la ayuda. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(title='subcommands',
...                                    description='valid subcommands',
...                                    help='additional help')
>>> subparsers.add_parser('foo')
>>> subparsers.add_parser('bar')
>>> parser.parse_args(['-h'])
usage:  [-h] @{foo,bar@} ...

options:
  -h, --help  show this help message and exit

subcommands:
  valid subcommands

  @{foo,bar@}   additional help
@end example

Furthermore, @code{add_parser()} supports an additional
`aliases' argument,
which allows multiple strings to refer to the same subparser. This example,
like @code{svn}, aliases @code{co} as a shorthand for @code{checkout}:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers()
>>> checkout = subparsers.add_parser('checkout', aliases=['co'])
>>> checkout.add_argument('foo')
>>> parser.parse_args(['co', 'bar'])
Namespace(foo='bar')
@end example

@code{add_parser()} supports also an additional
`deprecated' argument, which allows to deprecate the subparser.

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='chicken.py')
>>> subparsers = parser.add_subparsers()
>>> run = subparsers.add_parser('run')
>>> fly = subparsers.add_parser('fly', deprecated=True)
>>> parser.parse_args(['fly'])  
chicken.py: warning: command 'fly' is deprecated
Namespace()
@end example


Added in version 3.13.


One particularly effective way of handling subcommands is to combine the use
of the @ref{c9f,,add_subparsers()} method with calls to @ref{2c75,,set_defaults()} so
that each subparser knows which Python function it should execute.  For
example:

@example
>>> # subcommand functions
>>> def foo(args):
...     print(args.x * args.y)
...
>>> def bar(args):
...     print('((%s))' % args.z)
...
>>> # create the top-level parser
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(required=True)
>>>
>>> # create the parser for the "foo" command
>>> parser_foo = subparsers.add_parser('foo')
>>> parser_foo.add_argument('-x', type=int, default=1)
>>> parser_foo.add_argument('y', type=float)
>>> parser_foo.set_defaults(func=foo)
>>>
>>> # create the parser for the "bar" command
>>> parser_bar = subparsers.add_parser('bar')
>>> parser_bar.add_argument('z')
>>> parser_bar.set_defaults(func=bar)
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('foo 1 -x 2'.split())
>>> args.func(args)
2.0
>>>
>>> # parse the args and call whatever function was selected
>>> args = parser.parse_args('bar XYZYX'.split())
>>> args.func(args)
((XYZYX))
@end example

De esta manera, puedes dejar que @ref{2c5d,,parse_args()} haga el trabajo de llamar a la función apropiada después de que el análisis de los argumentos se haya completado. Asociar funciones con acciones como esta es típicamente la forma más fácil de manejar las diferentes acciones para cada uno de tus analizadores secundarios. Sin embargo, si es necesario comprobar el nombre del analizador secundario que se ha invocado, el argumento de palabra clave @code{dest} a la llamada @ref{c9f,,add_subparsers()} hará el trabajo:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(dest='subparser_name')
>>> subparser1 = subparsers.add_parser('1')
>>> subparser1.add_argument('-x')
>>> subparser2 = subparsers.add_parser('2')
>>> subparser2.add_argument('y')
>>> parser.parse_args(['2', 'frobble'])
Namespace(subparser_name='2', y='frobble')
@end example


Distinto en la versión 3.7: New `required' keyword-only parameter.

@end deffn

@node Objetos FileType,Grupos de argumentos,Sub-comandos,Otras utilidades
@anchor{library/argparse filetype-objects}@anchor{2c99}
@subsubsection Objetos `FileType'


@geindex FileType (clase en argparse)
@anchor{library/argparse argparse FileType}@anchor{1c2}
@deffn {Clase} argparse.FileType (mode='r', bufsize=-1, encoding=None, errors=None)

El generador @ref{1c2,,FileType} crea objetos que pueden ser transferidos al argumento tipo de @ref{306,,ArgumentParser.add_argument()}. Los argumentos que tienen objetos @ref{1c2,,FileType} como su tipo abrirán los argumentos de líneas de comandos como archivos con los modos, tamaños de búfer, codificaciones y manejo de errores solicitados (véase la función @ref{1be,,open()} para más detalles):

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--raw', type=argparse.FileType('wb', 0))
>>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8'))
>>> parser.parse_args(['--raw', 'raw.dat', 'file.txt'])
Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)
@end example

Los objetos `FileType' entienden el pseudo-argumento @code{'-'} y lo convierten automáticamente en @ref{5df,,sys.stdin} para objetos de lectura @ref{1c2,,FileType} y @ref{b61,,sys.stdout} para objetos de escritura @ref{1c2,,FileType}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', type=argparse.FileType('r'))
>>> parser.parse_args(['-'])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)
@end example

@cartouche
@quotation Nota 
If one argument uses `FileType' and then a subsequent argument fails,
an error is reported but the file is not automatically closed.
This can also clobber the output files.
In this case, it would be better to wait until after the parser has
run and then use the @ref{673,,with}-statement to manage the files.
@end quotation
@end cartouche


Distinto en la versión 3.4: Added the `encodings' and `errors' parameters.



Obsoleto desde la versión 3.14.

@end deffn

@node Grupos de argumentos,Exclusión mutua,Objetos FileType,Otras utilidades
@anchor{library/argparse argument-groups}@anchor{2c9a}
@subsubsection Grupos de argumentos


@geindex add_argument_group() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_argument_group}@anchor{1c1}
@deffn {Método} ArgumentParser.add_argument_group (title=None, description=None, *[, argument_default][, conflict_handler])

By default, @ref{15c,,ArgumentParser} groups command-line arguments into
«positional arguments» and «options» when displaying help
messages. When there is a better conceptual grouping of arguments than this
default one, appropriate groups can be created using the
@code{add_argument_group()} method:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group = parser.add_argument_group('group')
>>> group.add_argument('--foo', help='foo help')
>>> group.add_argument('bar', help='bar help')
>>> parser.print_help()
usage: PROG [--foo FOO] bar

group:
  bar    bar help
  --foo FOO  foo help
@end example

The @ref{1c1,,add_argument_group()} method returns an argument group object which
has an @ref{306,,add_argument()} method just like a regular
@ref{15c,,ArgumentParser}.  When an argument is added to the group, the parser
treats it just like a normal argument, but displays the argument in a
separate group for help messages.  The @code{add_argument_group()} method
accepts `title' and `description' arguments which can be used to
customize this display:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group1 = parser.add_argument_group('group1', 'group1 description')
>>> group1.add_argument('foo', help='foo help')
>>> group2 = parser.add_argument_group('group2', 'group2 description')
>>> group2.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [--bar BAR] foo

group1:
  group1 description

  foo    foo help

group2:
  group2 description

  --bar BAR  bar help
@end example

The optional, keyword-only parameters @ref{2c67,,argument_default} and @ref{2c68,,conflict_handler}
allow for finer-grained control of the behavior of the argument group. These
parameters have the same meaning as in the @ref{15c,,ArgumentParser} constructor,
but apply specifically to the argument group rather than the entire parser.

Ten en cuenta que cualquier argumento que no esté en los grupos definidos por el usuario terminará en las secciones habituales de «argumentos de posición» y «argumentos opcionales».


Distinto en la versión 3.11: Llamando @ref{1c1,,add_argument_group()} en grupos de argumentos está obsoleto. Esta característica nunca fue soportada y no siempre funciona correctamente. La función existe en la API por accidente a través de la herencia y será eliminada en el futuro.



Obsoleto desde la versión 3.14: Passing @ref{2c65,,prefix_chars} to @ref{1c1,,add_argument_group()}
is now deprecated.

@end deffn

@node Exclusión mutua,Valores por defecto del analizador,Grupos de argumentos,Otras utilidades
@anchor{library/argparse mutual-exclusion}@anchor{2c9b}
@subsubsection Exclusión mutua


@geindex add_mutually_exclusive_group() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_mutually_exclusive_group}@anchor{2c9c}
@deffn {Método} ArgumentParser.add_mutually_exclusive_group (required=False)

Create a mutually exclusive group. @code{argparse} will make sure that only
one of the arguments in the mutually exclusive group was present on the
command line:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_exclusive_group()
>>> group.add_argument('--foo', action='store_true')
>>> group.add_argument('--bar', action='store_false')
>>> parser.parse_args(['--foo'])
Namespace(bar=True, foo=True)
>>> parser.parse_args(['--bar'])
Namespace(bar=False, foo=False)
>>> parser.parse_args(['--foo', '--bar'])
usage: PROG [-h] [--foo | --bar]
PROG: error: argument --bar: not allowed with argument --foo
@end example

El método @ref{2c9c,,add_mutually_exclusive_group()} también acepta un argumento `required', para indicar que se requiere al menos uno de los argumentos mutuamente exclusivos:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_exclusive_group(required=True)
>>> group.add_argument('--foo', action='store_true')
>>> group.add_argument('--bar', action='store_false')
>>> parser.parse_args([])
usage: PROG [-h] (--foo | --bar)
PROG: error: one of the arguments --foo --bar is required
@end example

Tomar en cuenta que actualmente los grupos de argumentos mutuamente exclusivos no admiten los argumentos `title' y `description' de @ref{1c1,,add_argument_group()}. Sin embargo, se puede agregar un grupo mutuamente exclusivo a un grupo de argumentos que tenga un título y una descripción. Por ejemplo:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_argument_group('Group title', 'Group description')
>>> exclusive_group = group.add_mutually_exclusive_group(required=True)
>>> exclusive_group.add_argument('--foo', help='foo help')
>>> exclusive_group.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [-h] (--foo FOO | --bar BAR)

options:
  -h, --help  show this help message and exit

Group title:
  Group description

  --foo FOO   foo help
  --bar BAR   bar help
@end example


Distinto en la versión 3.11: Llamando @ref{1c1,,add_argument_group()} o @ref{2c9c,,add_mutually_exclusive_group()} en un grupo mutuamente exclusivo está obsoleto. Estás características nunca fueron soportadas y no siempre funcionan correctamente. La función existe en la API por accidente a través de la herencia y será eliminada en el futuro.

@end deffn

@node Valores por defecto del analizador,Mostrando la ayuda,Exclusión mutua,Otras utilidades
@anchor{library/argparse parser-defaults}@anchor{2c9d}
@subsubsection Valores por defecto del analizador


@geindex set_defaults() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser set_defaults}@anchor{2c75}
@deffn {Método} ArgumentParser.set_defaults (**kwargs)

La mayoría de las veces, los atributos del objeto retornado por @ref{2c5d,,parse_args()} se determinarán completamente inspeccionando los argumentos de la línea de comandos y las acciones de los argumentos. @ref{2c75,,set_defaults()} permite que se añadan algunos atributos adicionales que se determinan sin ninguna inspección de la línea de comandos:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', type=int)
>>> parser.set_defaults(bar=42, baz='badger')
>>> parser.parse_args(['736'])
Namespace(bar=42, baz='badger', foo=736)
@end example

Ten en cuenta que los valores por defecto a nivel analizador siempre prevalecen sobre los valores por defecto a nivel argumento:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='bar')
>>> parser.set_defaults(foo='spam')
>>> parser.parse_args([])
Namespace(foo='spam')
@end example

Los valores por defecto a nivel analizador pueden ser muy útiles cuando se trabaja con varios analizadores. Consulta el método @ref{c9f,,add_subparsers()} para ver un ejemplo de este tipo.
@end deffn

@geindex get_default() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser get_default}@anchor{2c9e}
@deffn {Método} ArgumentParser.get_default (dest)

Obtiene el valor por defecto para un atributo del espacio de nombres (`namespace'), establecido ya sea por @ref{306,,add_argument()} o por @ref{2c75,,set_defaults()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='badger')
>>> parser.get_default('foo')
'badger'
@end example
@end deffn

@node Mostrando la ayuda,Análisis parcial,Valores por defecto del analizador,Otras utilidades
@anchor{library/argparse printing-help}@anchor{2c9f}
@subsubsection Mostrando la ayuda


En la mayoría de las aplicaciones típicas, @ref{2c5d,,parse_args()} se encargará de dar formato y mostrar cualquier mensaje de uso o de error. Sin embargo, hay varios métodos para dar formato disponibles:

@geindex print_usage() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser print_usage}@anchor{2ca0}
@deffn {Método} ArgumentParser.print_usage (file=None)

Muestra una breve descripción de cómo se debe invocar el @ref{15c,,ArgumentParser} en la línea de comandos. Si `file' es @code{None}, se asume @ref{b61,,sys.stdout}.
@end deffn

@geindex print_help() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser print_help}@anchor{2ca1}
@deffn {Método} ArgumentParser.print_help (file=None)

Muestra un mensaje de ayuda, incluyendo el uso del programa e información sobre los argumentos registrados en el @ref{15c,,ArgumentParser}. Si `file' es @code{None}, se asume @ref{b61,,sys.stdout}.
@end deffn

También hay variantes de estos métodos que simplemente retornan una cadena de caracteres en lugar de mostrarla:

@geindex format_usage() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser format_usage}@anchor{19d4}
@deffn {Método} ArgumentParser.format_usage ()

Retorna una cadena de caracteres que contiene una breve descripción de cómo se debe invocar el @ref{15c,,ArgumentParser} en la línea de comandos.
@end deffn

@geindex format_help() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser format_help}@anchor{2ca2}
@deffn {Método} ArgumentParser.format_help ()

Retorna una cadena de caracteres que contiene un mensaje de ayuda, incluyendo el uso del programa e información sobre los argumentos registrados en el @ref{15c,,ArgumentParser}.
@end deffn

@node Análisis parcial,Personalizando el análisis de archivos,Mostrando la ayuda,Otras utilidades
@anchor{library/argparse partial-parsing}@anchor{2ca3}
@subsubsection Análisis parcial


@geindex parse_known_args() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_known_args}@anchor{2ca4}
@deffn {Método} ArgumentParser.parse_known_args (args=None, namespace=None)

A veces una secuencia de comandos (`script') sólo puede analizar algunos de los argumentos de la línea de comandos, pasando el resto de los argumentos a otra secuencia o programa. En estos casos, el método @ref{2ca4,,parse_known_args()} puede ser útil. Funciona de forma muy parecida a @ref{2c5d,,parse_args()} excepto que no produce un error cuando hay argumentos extra presentes. En lugar de ello, retorna una tupla de dos elementos que contiene el espacio de nombres ocupado y la lista de argumentos de cadena de caracteres restantes.

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('bar')
>>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam'])
(Namespace(bar='BAR', foo=True), ['--badger', 'spam'])
@end example
@end deffn

@cartouche
@quotation Advertencia 
@ref{e44,,Coincidencia de prefijos} las reglas se aplican a @ref{2ca4,,parse_known_args()}. El analizador puede consumir una opción aunque sea sólo un prefijo de una de sus opciones conocidas, en lugar de dejarla en la lista de argumentos restantes.
@end quotation
@end cartouche

@node Personalizando el análisis de archivos,Métodos de salida,Análisis parcial,Otras utilidades
@anchor{library/argparse customizing-file-parsing}@anchor{2ca5}
@subsubsection Personalizando el análisis de archivos


@geindex convert_arg_line_to_args() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser convert_arg_line_to_args}@anchor{2c74}
@deffn {Método} ArgumentParser.convert_arg_line_to_args (arg_line)

Los argumentos que se leen de un archivo (mira el argumento de palabra clave `fromfile_prefix_chars' para el constructor @ref{15c,,ArgumentParser}) se leen uno por línea. @ref{2c74,,convert_arg_line_to_args()} puede ser invalidado para una lectura más elegante.

Este método utiliza un sólo argumento `arg_line' que es una cadena de caracteres leída desde el archivo de argumentos. Retorna una lista de argumentos analizados a partir de esta cadena de caracteres. El método se llama una vez por línea leída del fichero de argumentos, en orden.

Una alternativa útil de este método es la que trata cada palabra separada por un espacio como un argumento. El siguiente ejemplo demuestra cómo hacerlo:

@example
class MyArgumentParser(argparse.ArgumentParser):
    def convert_arg_line_to_args(self, arg_line):
        return arg_line.split()
@end example
@end deffn

@node Métodos de salida,Análisis entremezclado,Personalizando el análisis de archivos,Otras utilidades
@anchor{library/argparse exiting-methods}@anchor{2ca6}
@subsubsection Métodos de salida


@geindex exit() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser exit}@anchor{2ca7}
@deffn {Método} ArgumentParser.exit (status=0, message=None)

This method terminates the program, exiting with the specified `status'
and, if given, it prints a `message' to @ref{9cc,,sys.stderr} before that.
The user can override this method to handle these steps differently:

@example
class ErrorCatchingArgumentParser(argparse.ArgumentParser):
    def exit(self, status=0, message=None):
        if status:
            raise Exception(f'Exiting because of an error: @{message@}')
        exit(status)
@end example
@end deffn

@geindex error() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser error}@anchor{2ca8}
@deffn {Método} ArgumentParser.error (message)

This method prints a usage message, including the `message', to
@ref{9cc,,sys.stderr} and terminates the program with a status code of 2.
@end deffn

@node Análisis entremezclado,,Métodos de salida,Otras utilidades
@anchor{library/argparse intermixed-parsing}@anchor{2ca9}
@subsubsection Análisis entremezclado


@geindex parse_intermixed_args() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_intermixed_args}@anchor{b8b}
@deffn {Método} ArgumentParser.parse_intermixed_args (args=None, namespace=None)
@end deffn

@geindex parse_known_intermixed_args() (método de argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_known_intermixed_args}@anchor{2caa}
@deffn {Método} ArgumentParser.parse_known_intermixed_args (args=None, namespace=None)

Una serie de comandos `Unix' permiten al usuario mezclar argumentos opcionales con argumentos de posición. Los métodos @ref{b8b,,parse_intermixed_args()} y @ref{2caa,,parse_known_intermixed_args()} soportan este modo de análisis.

These parsers do not support all the @code{argparse} features, and will raise
exceptions if unsupported features are used.  In particular, subparsers,
and mutually exclusive groups that include both
optionals and positionals are not supported.

El siguiente ejemplo muestra la diferencia entre @ref{2ca4,,parse_known_args()} y @ref{b8b,,parse_intermixed_args()}: el primero retorna @code{['2', '3']} como argumentos sin procesar, mientras que el segundo recoge todos los de posición en @code{rest}.

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.add_argument('cmd')
>>> parser.add_argument('rest', nargs='*', type=int)
>>> parser.parse_known_args('doit 1 --foo bar 2 3'.split())
(Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3'])
>>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split())
Namespace(cmd='doit', foo='bar', rest=[1, 2, 3])
@end example

@ref{2caa,,parse_known_intermixed_args()} retorna una tupla de dos elementos que contiene el espacio de nombres poblado y la lista de los restantes argumentos de cadenas de caracteres. @ref{b8b,,parse_intermixed_args()} arroja un error si quedan argumentos de cadenas de caracteres sin procesar.


Added in version 3.7.

@end deffn

@node Excepciones<8>,,Otras utilidades,argparse — Parser for command-line options arguments and subcommands
@anchor{library/argparse exceptions}@anchor{2cab}
@subsubsection Excepciones


@geindex ArgumentError
@anchor{library/argparse argparse ArgumentError}@anchor{2cac}
@deffn {Excepción} argparse.ArgumentError

Un error al crear o usar un argumento (opcional o posicional).

El valor de la cadena de caracteres de esta excepción es el mensaje, ampliado con información sobre el argumento que lo causó.
@end deffn

@geindex ArgumentTypeError
@anchor{library/argparse argparse ArgumentTypeError}@anchor{2c84}
@deffn {Excepción} argparse.ArgumentTypeError

Se lanza cuando algo sale mal al convertir una cadena de caracteres de la línea de comandos a un tipo.
@end deffn

@subsubheading Guides and Tutorials


@menu
* Tutorial de argparse:: 
* Upgrading optparse code:: 

@end menu

@node Tutorial de argparse,Upgrading optparse code,,Excepciones<8>
@anchor{howto/argparse doc}@anchor{2cad}@anchor{howto/argparse argparse-tutorial}@anchor{2c5c}@anchor{howto/argparse id1}@anchor{2cae}
@subsubsection Tutorial de `argparse'


@*autor: 
Tshepang Mbambo


Este tutorial pretende ser una leve introducción a @ref{7,,argparse}, el módulo de análisis (`parsing') de línea de comandos recomendado en la biblioteca estándar de Python.

@cartouche
@quotation Nota 
Hay otros dos módulos que cumplen la misma tarea, llamados @ref{61,,getopt} (un equivalente a @code{getopt()} del lenguaje C) y el deprecado @ref{a0,,optparse}. Tenga en cuenta también que @ref{7,,argparse} está basado en @ref{a0,,optparse}, y por lo tanto muy similar en el uso.
@end quotation
@end cartouche

@menu
* Conceptos:: 
* Las bases:: 
* Introducción a los argumentos posicionales:: 
* Introducción a los argumentos opcionales:: 
* Combinar argumentos opcionales y posicionales:: 
* Un poco mas avanzado:: 
* Cómo traducir la salida de argparse:: 
* Custom type converters:: 
* Conclusión:: 

@end menu

@node Conceptos,Las bases,,Tutorial de argparse
@anchor{howto/argparse concepts}@anchor{2caf}
@subsubsection Conceptos


Vamos a mostrar el tipo de funcionalidad que vamos a explorar en este tutorial introductorio haciendo uso del comando @code{ls}:

@example
$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
...
@end example

Algunos conceptos que podemos aprender de los cuatro comandos:


@itemize *

@item 
El comando @code{ls} es útil cuando se ejecuta sin ninguna opción en absoluto. Por defecto muestra el contenido del directorio actual.

@item 
Si queremos hacer algo, mas allá de lo que provee por defecto, le contamos un poco mas. En este caso, queremos mostrar un directorio diferente, @code{pypy}. Lo que hicimos fue especificar lo que se conoce como argumento posicional. Se llama así porque el programa debe saber que hacer con ese valor, basado únicamente en función de donde aparece en la línea de comandos. Este concepto es mas relevante para un comando como @code{cp}, cuyo uso mas básico es @code{cp SRC DEST}. La primer posición es `lo que quieres copiar', y la segunda posición es `a donde lo quieres copiar'.

@item 
Ahora, digamos que queremos cambiar el comportamiento del programa. En nuestro ejemplo, mostramos mas información para cada archivo en lugar de solo mostrar los nombres de los archivos. El argumento @code{-l} en ese caso se conoce como argumento opcional.

@item 
Este es un fragmento del texto de ayuda. Es muy útil porque puedes encontrar un programa que nunca has usado antes, y puedes darte cuenta de como funciona simplemente leyendo el texto de ayuda.
@end itemize

@node Las bases,Introducción a los argumentos posicionales,Conceptos,Tutorial de argparse
@anchor{howto/argparse the-basics}@anchor{2cb0}
@subsubsection Las bases


Comencemos con un simple ejemplo, el cual no hace (casi) nada:

@example
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
@end example

Lo siguiente es el resultado de ejecutar el código:

@example
$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

options:
  -h, --help  show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
@end example

Esto es lo que está pasando:


@itemize *

@item 
Ejecutar el script sin ninguna opción da como resultado que no se muestra nada en `stdout'. No es tan útil.

@item 
El segundo comienza a mostrar la utilidad del módulo @ref{7,,argparse}. No hemos hecho casi nada, pero ya recibimos un buen mensaje de ayuda.

@item 
La opción @code{--help}, que también puede ser abreviada como @code{-h}, es la única opción que tenemos gratis (es decir, no necesitamos especificarla). Especificar cualquier otra cosa da como resultado un error. Pero aún así, recibimos un mensaje útil, también gratis.
@end itemize

@node Introducción a los argumentos posicionales,Introducción a los argumentos opcionales,Las bases,Tutorial de argparse
@anchor{howto/argparse introducing-positional-arguments}@anchor{2cb1}
@subsubsection Introducción a los argumentos posicionales


Un ejemplo:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)
@end example

Y ejecutando el código:

@example
$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

options:
  -h, --help  show this help message and exit
$ python prog.py foo
foo
@end example

Aquí está lo que está sucediendo:


@itemize *

@item 
Hemos agregado el método @ref{306,,add_argument()}, el cual es el que usamos para especificar cuales opciones de la línea de comandos el programa está dispuesto a aceptar. En este caso, lo he llamado @code{echo} para que concuerde con su función.

@item 
Llamar nuestro programa ahora requiere que especifiquemos una opción.

@item 
El método @ref{2c5d,,parse_args()} retorna de hecho algunos datos de las opciones especificadas, en este caso, @code{echo}.

@item 
La variable es una forma de “magia” que @ref{7,,argparse} se realiza de forma gratuita (es decir, no es necesario especificar en qué variable se almacena ese valor). También notará que su nombre coincide con el argumento de cadena dado al método, @code{echo}.
@end itemize

Sin embargo, tenga en cuenta que, aunque la pantalla de ayuda luce bien y todo, en realidad no es tan útil como podría ser. Por ejemplo, vemos que tenemos @code{echo} como un argumento posicional, pero no sabemos lo que hace, de otra manera que no sea adivinar o leer el código fuente. Entonces, vamos a hacerlo un poco mas útil:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)
@end example

Y la salida:

@example
$ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

options:
  -h, --help  show this help message and exit
@end example

Ahora, que tal si hacemos algo más útil:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
@end example

Lo siguiente es el resultado de ejecutar el código:

@example
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 5, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
@end example

Eso no fue tan bien. Esto es porque @ref{7,,argparse} trata las opciones que le damos como cadenas, a menos que le digamos otra cosa. Entonces, vamos a llamar a @ref{7,,argparse} para tratar esa entrada como un entero:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                    type=int)
args = parser.parse_args()
print(args.square**2)
@end example

Lo siguiente es el resultado de ejecutar el código:

@example
$ python prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'
@end example

Eso fue bien. El programa ahora aún se cierra útilmente en caso de una entrada ilegal incorrecta antes de proceder.

@node Introducción a los argumentos opcionales,Combinar argumentos opcionales y posicionales,Introducción a los argumentos posicionales,Tutorial de argparse
@anchor{howto/argparse introducing-optional-arguments}@anchor{2cb2}
@subsubsection Introducción a los argumentos opcionales


Hasta ahora hemos estado jugando con argumentos posicionales. Vamos a darle una mirada a como agregar los opcionales:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")
@end example

Y la salida:

@example
$ python prog.py --verbosity 1
verbosity turned on
$ python prog.py
$ python prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

options:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument
@end example

Esto es lo que está pasando:


@itemize *

@item 
El programa está escrito para mostrar algo cuando @code{--verbosity} sea especificado y no mostrar nada cuando no.

@item 
Para mostrar que la opción es de hecho opcional, no hay ningún error al ejecutar el programa sin ella. Tenga en cuenta que por defecto, si un argumento opcional no es usado, la variable relevante, en este caso @code{args.verbosity}, se le da @code{None} como valor, razón por la cual falla la prueba de verdad del @ref{1ec,,if}.

@item 
El mensaje de ayuda es un poco diferente.

@item 
Cuando usamos la opción @code{--verbosity}, también se debe especificar un valor, cualquier valor.
@end itemize

El ejemplo anterior acepta arbitrariamente valores enteros para @code{--verbosity}, pero para nuestro simple programa, solo dos valores son realmente útiles, @code{True} o @code{False}. Modifiquemos el código de acuerdo a esto:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")
@end example

Y la salida:

@example
$ python prog.py --verbose
verbosity turned on
$ python prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python prog.py --help
usage: prog.py [-h] [--verbose]

options:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity
@end example

Esto es lo que está pasando:


@itemize *

@item 
La opción ahora es más una bandera que algo que requiere un valor. Incluso cambiamos el nombre de la opción para que coincida con esa idea. Tenga en cuenta que ahora especificamos una nueva palabra clave, @code{action}, y le dimos el valor @code{"store_true"}. Esto significa que, si la opción es especificada, se asigna el valor @code{True} a @code{args.verbose}. No especificarlo implica @code{False}.

@item 
Se queja cuando se especifica un valor, en verdadero espíritu de lo que realmente son los flags.

@item 
Observe los diferentes textos de ayuda.
@end itemize

@menu
* Opciones cortas:: 

@end menu

@node Opciones cortas,,,Introducción a los argumentos opcionales
@anchor{howto/argparse short-options}@anchor{2cb3}
@subsubsection Opciones cortas


Si estas familiarizado con el uso de la línea de comandos, podrás observar que aún no he tocado el tema de las versiones cortas de las opciones. Es bastante simple:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")
@end example

Y aquí va:

@example
$ python prog.py -v
verbosity turned on
$ python prog.py --help
usage: prog.py [-h] [-v]

options:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity
@end example

Tenga en cuenta que la nueva habilidad es también reflejada en el texto de ayuda.

@node Combinar argumentos opcionales y posicionales,Un poco mas avanzado,Introducción a los argumentos opcionales,Tutorial de argparse
@anchor{howto/argparse combining-positional-and-optional-arguments}@anchor{2cb4}
@subsubsection Combinar argumentos opcionales y posicionales


Nuestro programa sigue creciendo en complejidad:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print(f"the square of @{args.square@} equals @{answer@}")
else:
    print(answer)
@end example

Y ahora la salida:

@example
$ python prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python prog.py 4
16
$ python prog.py 4 --verbose
the square of 4 equals 16
$ python prog.py --verbose 4
the square of 4 equals 16
@end example


@itemize *

@item 
Hemos traído de vuelta un argumento posicional, de ahí la queja.

@item 
Tenga en cuenta que el orden no importa.
@end itemize

Que tal si le retornamos a nuestro programa la capacidad de tener múltiples valores de verbosidad, y realmente usarlos:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

Y la salida:

@example
$ python prog.py 4
16
$ python prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python prog.py 4 -v 1
4^2 == 16
$ python prog.py 4 -v 2
the square of 4 equals 16
$ python prog.py 4 -v 3
16
@end example

Todos estos se ven bien, excepto el último, que expone un error en nuestro programa. Corrijamos esto restringiendo los valores que la opción @code{--verbosity} puede aceptar:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

Y la salida:

@example
$ python prog.py 4 -v 3
usage: prog.py [-h] [-v @{0,1,2@}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python prog.py 4 -h
usage: prog.py [-h] [-v @{0,1,2@}] square

positional arguments:
  square                display a square of a given number

options:
  -h, --help            show this help message and exit
  -v, --verbosity @{0,1,2@}
                        increase output verbosity
@end example

Tenga en cuenta que el cambio se refleja tanto en el mensaje de error como en la cadena de ayuda.

Ahora, usemos un enfoque diferente para jugar con la verbosidad, lo cual es bastante común. También coincide con la forma en que el ejecutable de CPython maneja su propio argumento de verbosidad (verifique el resultado de @code{python --help}):

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

Hemos introducido otra acción, «count», para contar el número de apariciones de opciones específicas.

@example
$ python prog.py 4
16
$ python prog.py 4 -v
4^2 == 16
$ python prog.py 4 -vv
the square of 4 equals 16
$ python prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python prog.py 4 -h
usage: prog.py [-h] [-v] square

positional arguments:
  square           display a square of a given number

options:
  -h, --help       show this help message and exit
  -v, --verbosity  increase output verbosity
$ python prog.py 4 -vvv
16
@end example


@itemize *

@item 
Si, ahora es mas una bandera (similar a @code{action="store_true"}) en la versión anterior de nuestro script. Esto debería explicar la queja.

@item 
También se comporta de manera similar a la acción @code{"store_true"}.

@item 
Ahora aquí una demostración de lo que la acción @code{"count"} da. Probablemente haya visto esta clase de uso antes.

@item 
Y si no especificas la bandera @code{-v}, se considera que esa bandera tiene el valor @code{None}.

@item 
Como debería esperarse, especificando la forma larga de la bandera, obtendríamos el mismo resultado.

@item 
Lamentablemente, nuestra salida de ayuda no es muy informativa sobre la nueva capacidad que ha adquirido nuestro script, pero eso siempre se puede solucionar mejorando la documentación de nuestro script (por ejemplo, a través del argumento de la palabra clave @code{help}).

@item 
La última salida expone un error en nuestro programa.
@end itemize

Vamos a arreglarlo:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2

# bugfix: replace == with >=
if args.verbosity >= 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

Y esto es lo que da:

@example
$ python prog.py 4 -vvv
the square of 4 equals 16
$ python prog.py 4 -vvvv
the square of 4 equals 16
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'
@end example


@itemize *

@item 
La primer salida fue correcta, y corrigió el error que teníamos antes. Es decir, queremos que cualquier valor >= 2 sea lo más detallado posible.

@item 
Tercer salida no tan buena.
@end itemize

Vamos a arreglar ese error:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity >= 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

Acabamos de introducir otra palabra clave, @code{default}. Lo hemos configurado en @code{0} para que sea comparable con otros valores int. Recuerde que por defecto, si un argumento opcional no es especificado, obtiene el valor @code{None}, y eso no puede ser comparado con un valor int (de ahí la excepción @ref{228,,TypeError}).

Y:

@example
$ python prog.py 4
16
@end example

Tu puedes llegar bastante lejos con lo que hemos aprendido hasta ahora, y solo arañado la superficie. El módulo @ref{7,,argparse} es muy poderoso, y exploraremos un poco mas antes de finalizar este tutorial.

@node Un poco mas avanzado,Cómo traducir la salida de argparse,Combinar argumentos opcionales y posicionales,Tutorial de argparse
@anchor{howto/argparse getting-a-little-more-advanced}@anchor{2cb5}
@subsubsection Un poco mas avanzado


Qué pasaría si quisiéramos expandir nuestro pequeño programa para que tenga otros poderes, no solo cuadrados:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
else:
    print(answer)
@end example

Salida:

@example
$ python prog.py
usage: prog.py [-h] [-v] x y
prog.py: error: the following arguments are required: x, y
$ python prog.py -h
usage: prog.py [-h] [-v] x y

positional arguments:
  x                the base
  y                the exponent

options:
  -h, --help       show this help message and exit
  -v, --verbosity
$ python prog.py 4 2 -v
4^2 == 16
@end example

Tenga en cuenta que hasta ahora hemos estado usando el nivel de verbosidad para `cambiar' el texto que se muestra. El siguiente ejemplo en lugar de usar nivel de verbosidad para mostrar `mas' texto en su lugar:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print(f"Running '@{__file__@}'")
if args.verbosity >= 1:
    print(f"@{args.x@}^@{args.y@} == ", end="")
print(answer)
@end example

Salida:

@example
$ python prog.py 4 2
16
$ python prog.py 4 2 -v
4^2 == 16
$ python prog.py 4 2 -vv
Running 'prog.py'
4^2 == 16
@end example

@menu
* Especificando argumentos ambiguos:: 
* Opciones conflictivas:: 

@end menu

@node Especificando argumentos ambiguos,Opciones conflictivas,,Un poco mas avanzado
@anchor{howto/argparse id2}@anchor{2cb6}@anchor{howto/argparse specifying-ambiguous-arguments}@anchor{2c80}
@subsubsection Especificando argumentos ambiguos


Cuando hay ambigüedad al decidir si un argumento es posicional o para un argumento, @code{--} se puede usar para indicar @ref{2c5d,,parse_args()} que todo lo que sigue a eso es un argumento posicional:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-n', nargs='+')
>>> parser.add_argument('args', nargs='*')

>>> # ambiguous, so parse_args assumes it's an option
>>> parser.parse_args(['-f'])
usage: PROG [-h] [-n N [N ...]] [args ...]
PROG: error: unrecognized arguments: -f

>>> parser.parse_args(['--', '-f'])
Namespace(args=['-f'], n=None)

>>> # ambiguous, so the -n option greedily accepts arguments
>>> parser.parse_args(['-n', '1', '2', '3'])
Namespace(args=[], n=['1', '2', '3'])

>>> parser.parse_args(['-n', '1', '--', '2', '3'])
Namespace(args=['2', '3'], n=['1'])
@end example

@node Opciones conflictivas,,Especificando argumentos ambiguos,Un poco mas avanzado
@anchor{howto/argparse conflicting-options}@anchor{2cb7}
@subsubsection Opciones conflictivas


Hasta ahora, hemos estado trabajando con dos métodos de una instancia de @ref{15c,,argparse.ArgumentParser}. Vamos a introducir un tercer método, @ref{2c9c,,add_mutually_exclusive_group()}. Nos permite especificar opciones que entran en conflicto entre sí. Cambiemos también el resto del programa para que la nueva funcionalidad tenga mas sentido: presentamos la opción @code{--quiet}, la cual es lo opuesto a la opción @code{--verbose}:

@example
import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
else:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
@end example

Nuestro programa ahora es mas simple, y perdimos algunas funcionalidades en aras de la demostración. De todos modos, aquí esta el resultado:

@example
$ python prog.py 4 2
4^2 == 16
$ python prog.py 4 2 -q
16
$ python prog.py 4 2 -v
4 to the power 2 equals 16
$ python prog.py 4 2 -vq
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
$ python prog.py 4 2 -v --quiet
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
@end example

Esto debería ser sencillo de seguir. He agregado esa última salida para que se pueda ver el tipo de flexibilidad que obtiene, es decir, mezclar opciones de forma larga con opciones de forma corta.

Antes de concluir, probablemente quiera contarle a sus usuarios el propósito principal de su programa, solo en caso de que no lo supieran:

@example
import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
else:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
@end example

Tenga en cuenta la ligera diferencia en el uso del texto. Tenga en cuenta @code{[-v | -q]}, lo cual nos indica que podemos usar @code{-v} o @code{-q}, pero no ambos al mismo tiempo:

@example
$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

options:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet
@end example

@node Cómo traducir la salida de argparse,Custom type converters,Un poco mas avanzado,Tutorial de argparse
@anchor{howto/argparse how-to-translate-the-argparse-output}@anchor{2cb8}
@subsubsection Cómo traducir la salida de argparse


La salida del módulo @ref{7,,argparse}, como su texto de ayuda y mensajes de error, se pueden traducir usando el módulo @ref{63,,gettext}. Esto permite que las aplicaciones localicen fácilmente los mensajes producidos por @ref{7,,argparse}. Consulte @ref{2cb9,,Internacionalizando sus programas y módulos} para más información.

Por ejemplo, en esta salida @ref{7,,argparse}:

@example
$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

options:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet
@end example

Las cadenas de caracteres @code{usage:}, @code{positional arguments:}, @code{options:} y @code{show this help message and exit`} son todas traducibles.

Para traducir estas cadenas de caracteres, primero se deben extraer en un archivo @code{.po}. Por ejemplo, usando Babel@footnote{https://babel.pocoo.org/}, ejecute este comando:

@example
$ pybabel extract -o messages.po /usr/lib/python3.12/argparse.py
@end example

Este comando extraerá todas las cadenas de caracteres traducibles del módulo @ref{7,,argparse} y las generará en un archivo llamado @code{messages.po}. Este comando asume que su instalación de Python está en @code{/usr/lib}.

Puede encontrar la ubicación del módulo @ref{7,,argparse} en su sistema usando este script:

@example
import argparse
print(argparse.__file__)
@end example

Una vez que los mensajes en el archivo @code{.po} estén traducidos y las traducciones estén instaladas usando @ref{63,,gettext}, @ref{7,,argparse} podrá mostrar los mensajes traducidos.

Para traducir sus propias cadenas de caracteres en la salida @ref{7,,argparse}, use @ref{63,,gettext}.

@node Custom type converters,Conclusión,Cómo traducir la salida de argparse,Tutorial de argparse
@anchor{howto/argparse custom-type-converters}@anchor{2cba}
@subsubsection Custom type converters


The @ref{7,,argparse} module allows you to specify custom type converters for
your command-line arguments. This allows you to modify user input before it’s
stored in the @ref{2c5e,,argparse.Namespace}. This can be useful when you need to
pre-process the input before it is used in your program.

When using a custom type converter, you can use any callable that takes a
single string argument (the argument value) and returns the converted value.
However, if you need to handle more complex scenarios, you can use a custom
action class with the `action' parameter instead.

For example, let’s say you want to handle arguments with different prefixes and
process them accordingly:

@example
import argparse

parser = argparse.ArgumentParser(prefix_chars='-+')

parser.add_argument('-a', metavar='<value>', action='append',
                    type=lambda x: ('-', x))
parser.add_argument('+a', metavar='<value>', action='append',
                    type=lambda x: ('+', x))

args = parser.parse_args()
print(args)
@end example

Salida:

@example
$ python prog.py -a value1 +a value2
Namespace(a=[('-', 'value1'), ('+', 'value2')])
@end example

In this example, we:


@itemize *

@item 
Created a parser with custom prefix characters using the @code{prefix_chars}
parameter.

@item 
Defined two arguments, @code{-a} and @code{+a}, which used the @code{type} parameter to
create custom type converters to store the value in a tuple with the prefix.
@end itemize

Without the custom type converters, the arguments would have treated the @code{-a}
and @code{+a} as the same argument, which would have been undesirable. By using custom
type converters, we were able to differentiate between the two arguments.

@node Conclusión,,Custom type converters,Tutorial de argparse
@anchor{howto/argparse conclusion}@anchor{2cbb}
@subsubsection Conclusión


El módulo @ref{7,,argparse} ofrece mucho más que solo lo mostrado aquí. Su documentación es bastante detallada y completa, y está llena de ejemplos. Habiendo seguido este tutorial, debe digerirlos fácilmente sin sentirse abrumado.

@node Upgrading optparse code,,Tutorial de argparse,Excepciones<8>
@anchor{howto/argparse-optparse doc}@anchor{2cbc}@anchor{howto/argparse-optparse id1}@anchor{2cbd}@anchor{howto/argparse-optparse upgrading-optparse-code}@anchor{121c}
@subsubsection Upgrading optparse code


Originally, the @ref{7,,argparse} module had attempted to maintain compatibility
with @ref{a0,,optparse}.  However, @ref{a0,,optparse} was difficult to extend
transparently, particularly with the changes required to support
@code{nargs=} specifiers and better usage messages.  When most everything in
@ref{a0,,optparse} had either been copy-pasted over or monkey-patched, it no
longer seemed practical to try to maintain the backwards compatibility.

The @ref{7,,argparse} module improves on the @ref{a0,,optparse}
module in a number of ways including:


@itemize *

@item 
Handling positional arguments.

@item 
Supporting subcommands.

@item 
Allowing alternative option prefixes like @code{+} and @code{/}.

@item 
Handling zero-or-more and one-or-more style arguments.

@item 
Producing more informative usage messages.

@item 
Providing a much simpler interface for custom @code{type} and @code{action}.
@end itemize

A partial upgrade path from @ref{a0,,optparse} to @ref{7,,argparse}:


@itemize *

@item 
Replace all @ref{2cbe,,optparse.OptionParser.add_option()} calls with
@ref{306,,ArgumentParser.add_argument()} calls.

@item 
Replace @code{(options, args) = parser.parse_args()} with @code{args =
parser.parse_args()} and add additional @ref{306,,ArgumentParser.add_argument()}
calls for the positional arguments. Keep in mind that what was previously
called @code{options}, now in the @ref{7,,argparse} context is called @code{args}.

@item 
Replace @ref{2cbf,,optparse.OptionParser.disable_interspersed_args()}
by using @ref{b8b,,parse_intermixed_args()} instead of
@ref{2c5d,,parse_args()}.

@item 
Replace callback actions and the @code{callback_*} keyword arguments with
@code{type} or @code{action} arguments.

@item 
Replace string names for @code{type} keyword arguments with the corresponding
type objects (e.g. int, float, complex, etc).

@item 
Replace @ref{2cc0,,optparse.Values} with @ref{2c5e,,Namespace} and
@ref{2cc1,,optparse.OptionError} and @ref{2cc2,,optparse.OptionValueError} with
@ref{2cac,,ArgumentError}.

@item 
Replace strings with implicit arguments such as @code{%default} or @code{%prog} with
the standard Python syntax to use dictionaries to format strings, that is,
@code{%(default)s} and @code{%(prog)s}.

@item 
Replace the OptionParser constructor @code{version} argument with a call to
@code{parser.add_argument('--version', action='version', version='<the version>')}.
@end itemize

@node logging — Logging facility for Python,logging config — Logging configuration,argparse — Parser for command-line options arguments and subcommands,Servicios genéricos del sistema operativo
@anchor{library/logging doc}@anchor{2cc3}@anchor{library/logging logging-logging-facility-for-python}@anchor{2cc4}@anchor{library/logging module-logging}@anchor{87}
@subsection @code{logging} — Logging facility for Python


@geindex module; logging

`Source code:' Lib/logging/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/logging/__init__.py}

@geindex Errors;logging

@subsubheading Important



Esta página contiene la información de referencia de la API. Para información sobre tutorial y discusión de temas más avanzados, ver


@itemize *

@item 
@ref{1262,,Tutorial básico}

@item 
@ref{1263,,Tutorial avanzado}

@item 
@ref{1264,,Libro de recetas de Logging}
@end itemize


__________________________________________________________________


Este módulo define funciones y clases que implementan un sistema flexible de logging de eventos para aplicaciones y bibliotecas.

El beneficio clave de tener la API de logging proporcionada por un módulo de la biblioteca estándar es que todos los módulos de Python pueden participar en el logging, por lo que el registro de su aplicación puede incluir sus propios mensajes integrados con mensajes de módulos de terceros.

Here’s a simple example of idiomatic usage:

@example
# myapp.py
import logging
import mylib
logger = logging.getLogger(__name__)

def main():
    logging.basicConfig(filename='myapp.log', level=logging.INFO)
    logger.info('Started')
    mylib.do_something()
    logger.info('Finished')

if __name__ == '__main__':
    main()
@end example

@example
# mylib.py
import logging
logger = logging.getLogger(__name__)

def do_something():
    logger.info('Doing something')
@end example

If you run `myapp.py', you should see this in `myapp.log':

@example
INFO:__main__:Started
INFO:mylib:Doing something
INFO:__main__:Finished
@end example

The key feature of this idiomatic usage is that the majority of code is simply
creating a module level logger with @code{getLogger(__name__)}, and using that
logger to do any needed logging. This is concise, while allowing downstream
code fine-grained control if needed. Logged messages to the module-level logger
get forwarded to handlers of loggers in higher-level modules, all the way up to
the highest-level logger known as the root logger; this approach is known as
hierarchical logging.

For logging to be useful, it needs to be configured: setting the levels and
destinations for each logger, potentially changing how specific modules log,
often based on command-line arguments or application configuration. In most
cases, like the one above, only the root logger needs to be so configured, since
all the lower level loggers at module level eventually forward their messages to
its handlers.  @ref{a92,,basicConfig()} provides a quick way to configure
the root logger that handles many use cases.

El módulo proporciona mucha funcionalidad y flexibilidad. Si no está familiarizado con logging, la mejor manera de familiarizarse con él es ver los tutoriales (`vea los enlaces arriba a la derecha').

The basic classes defined by the module, together with their attributes and
methods, are listed in the sections below.


@itemize *

@item 
Los loggers exponen la interfaz que el código de la aplicación usa directamente.

@item 
Los gestores envían los registros (creados por los loggers) al destino apropiado.

@item 
Los filtros proporcionan una facilidad de ajuste preciso para determinar que registros generar.

@item 
Los formateadores especifican el diseño de los registros en el resultado final.
@end itemize

@menu
* Objetos logger:: 
* Niveles de logging:: 
* Gestor de objetos:: 
* Objetos formateadores:: 
* Filtro de Objetos:: 
* Objetos LogRecord:: 
* Atributos LogRecord:: 
* Objetos LoggerAdapter:: 
* Seguridad del hilo:: 
* Funciones a nivel de módulo:: 
* Atributos a nivel de módulo:: 
* Integración con el módulo de advertencias:: 

@end menu

@node Objetos logger,Niveles de logging,,logging — Logging facility for Python
@anchor{library/logging logger}@anchor{2cc5}@anchor{library/logging logger-objects}@anchor{2cc6}
@subsubsection Objetos logger


Los loggers tienen los siguientes atributos y métodos. Tenga en cuenta que los loggers `NUNCA' deben ser instanciados directamente, siempre a través de la función de nivel de módulo @code{logging.getLogger(name)}. Múltiples llamadas a @ref{9f3,,getLogger()} con el mismo nombre siempre retornarán una referencia al mismo objeto Logger.

The @code{name} is potentially a period-separated hierarchical value, like
@code{foo.bar.baz} (though it could also be just plain @code{foo}, for example).
Loggers that are further down in the hierarchical list are children of loggers
higher up in the list.  For example, given a logger with a name of @code{foo},
loggers with names of @code{foo.bar}, @code{foo.bar.baz}, and @code{foo.bam} are all
descendants of @code{foo}.  In addition, all loggers are descendants of the root
logger. The logger name hierarchy is analogous to the Python package hierarchy,
and identical to it if you organise your loggers on a per-module basis using
the recommended construction @code{logging.getLogger(__name__)}.  That’s because
in a module, @code{__name__} is the module’s name in the Python package namespace.

@geindex Logger (clase en logging)
@anchor{library/logging logging Logger}@anchor{bd7}
@deffn {Clase} logging.Logger

@geindex name (atributo de logging.Logger)
@anchor{library/logging logging Logger name}@anchor{2cc7}
@deffn {Atributo} name

This is the logger’s name, and is the value that was passed to @ref{9f3,,getLogger()}
to obtain the logger.

@cartouche
@quotation Nota 
This attribute should be treated as read-only.
@end quotation
@end cartouche
@end deffn

@geindex level (atributo de logging.Logger)
@anchor{library/logging logging Logger level}@anchor{2cc8}
@deffn {Atributo} level

The threshold of this logger, as set by the @ref{14cd,,setLevel()} method.

@cartouche
@quotation Nota 
Do not set this attribute directly - always use @ref{14cd,,setLevel()},
which has checks for the level passed to it.
@end quotation
@end cartouche
@end deffn

@geindex parent (atributo de logging.Logger)
@anchor{library/logging logging Logger parent}@anchor{2cc9}
@deffn {Atributo} parent

The parent logger of this logger. It may change based on later instantiation
of loggers which are higher up in the namespace hierarchy.

@cartouche
@quotation Nota 
This value should be treated as read-only.
@end quotation
@end cartouche
@end deffn

@geindex propagate (atributo de logging.Logger)
@anchor{library/logging logging Logger propagate}@anchor{14cf}
@deffn {Atributo} propagate

Si este atributo se evalúa como verdadero, los eventos registrados en este logger se pasarán a los gestores de los loggers de nivel superior (ancestro), además de los gestores asociados a este logger. Los mensajes se pasan directamente a los gestores de los loggers ancestrales; no se consideran ni el nivel ni los filtros de los loggers ancestrales en cuestión.

Si esto se evalúa como falso, los mensajes de registro no se pasan a los gestores de los logger ancestrales.

Explicándolo con un ejemplo: Si el atributo propagado del logger llamado @code{A.B.C} se evalúa a true, cualquier evento registrado en @code{A.B.C} a través de una llamada a un método como @code{logging.getLogger('A.B.C').error(...)} será [sujeto a pasar el nivel de ese logger y la configuración del filtro] pasado a su vez a cualquier manejador adjunto a los loggers llamados @code{A.B}, @code{A} y al logger raíz, después de ser pasado primero a cualquier manejador adjunto a @code{A.B.C}. Si cualquier logger en la cadena @code{A.B.C}, @code{A.B}, @code{A} tiene su atributo @code{propagate} a false, entonces ese es el último logger a cuyos manejadores se les ofrece el evento a manejar, y la propagación se detiene en ese punto.

El constructor establece este atributo en @code{True}.

@cartouche
@quotation Nota 
Si adjunta un gestor a un logger `y' uno o más de sus ancestros, puede emitir el mismo registro varias veces. En general, no debería necesitar adjuntar un gestor a más de un logger; si solo lo adjunta al logger apropiado que está más arriba en la jerarquía del logger, verá todos los eventos registrados por todos los logger descendientes, siempre que la configuración de propagación sea @code{True}. Un escenario común es adjuntar gestores solo al logger raíz y dejar que la propagación se encargue del resto.
@end quotation
@end cartouche
@end deffn

@geindex handlers (atributo de logging.Logger)
@anchor{library/logging logging Logger handlers}@anchor{2cca}
@deffn {Atributo} handlers

The list of handlers directly attached to this logger instance.

@cartouche
@quotation Nota 
This attribute should be treated as read-only; it is normally changed via
the @ref{2ccb,,addHandler()} and @ref{2ccc,,removeHandler()} methods, which use locks to ensure
thread-safe operation.
@end quotation
@end cartouche
@end deffn

@geindex disabled (atributo de logging.Logger)
@anchor{library/logging logging Logger disabled}@anchor{2ccd}
@deffn {Atributo} disabled

This attribute disables handling of any events. It is set to @code{False} in the
initializer, and only changed by logging configuration code.

@cartouche
@quotation Nota 
This attribute should be treated as read-only.
@end quotation
@end cartouche
@end deffn

@geindex setLevel() (método de logging.Logger)
@anchor{library/logging logging Logger setLevel}@anchor{14cd}
@deffn {Método} setLevel (level)

Establece el umbral para este logger en `level'. Los mensajes de logging que son menos severos que `level' serán ignorados; los mensajes de logging que tengan un nivel de severidad `level' o superior serán emitidos por cualquier gestor o gestores que atiendan este logger, a menos que el nivel de un gestor haya sido configurado en un nivel de severidad más alto que `level'.

Cuando se crea un logger, el nivel se establece en @ref{2cce,,NOTSET} (que hace que todos los mensajes se procesen cuando el logger es el logger raíz, o la delegación al padre cuando el logger no es un logger raíz). Tenga en cuenta que el logger raíz se crea con el nivel @ref{1cfb,,WARNING}.

El término “delegación al padre” significa que si un logger tiene un nivel de NOTSET, su cadena de logger ancestrales se atraviesa hasta que se encuentra un ancestro con un nivel diferente a NOTSET o se alcanza la raíz.

Si se encuentra un antepasado con un nivel distinto de NOTSET, entonces el nivel de ese antepasado se trata como el nivel efectivo del logger donde comenzó la búsqueda de antepasados, y se utiliza para determinar cómo se maneja un evento de registro.

Si se alcanza la raíz y tiene un nivel de NOTSET, se procesarán todos los mensajes. De lo contrario, el nivel de la raíz se utilizará como el nivel efectivo.

Ver @ref{6fb,,Niveles de logging} para obtener una lista de niveles.


Distinto en la versión 3.2: El parámetro `level' ahora acepta una representación de cadena del nivel como “INFO” como alternativa a las constantes de enteros como @ref{1cfa,,INFO}. Sin embargo, tenga en cuenta que los niveles se almacenan internamente como e.j. @ref{2ccf,,getEffectiveLevel()} y @ref{135d,,isEnabledFor()} retornará/esperará que se pasen enteros.

@end deffn

@geindex isEnabledFor() (método de logging.Logger)
@anchor{library/logging logging Logger isEnabledFor}@anchor{135d}
@deffn {Método} isEnabledFor (level)

Indica si este logger procesará un mensaje de gravedad `level'. Este método verifica primero el nivel de nivel de módulo establecido por @code{logging.disable(level)} y luego el nivel efectivo del logger según lo determinado por @ref{2ccf,,getEffectiveLevel()}.
@end deffn

@geindex getEffectiveLevel() (método de logging.Logger)
@anchor{library/logging logging Logger getEffectiveLevel}@anchor{2ccf}
@deffn {Método} getEffectiveLevel ()

Indica el nivel efectivo para este logger. Si se ha establecido un valor distinto de @ref{2cce,,NOTSET} utilizando @ref{14cd,,setLevel()}, se retorna. De lo contrario, la jerarquía se atraviesa hacia la raíz hasta que se encuentre un valor que no sea @ref{2cce,,NOTSET} y se retorna ese valor. El valor retornado es un entero, típicamente uno de @ref{1cf9,,logging.DEBUG}, @ref{1cfa,,logging.INFO} etc.
@end deffn

@geindex getChild() (método de logging.Logger)
@anchor{library/logging logging Logger getChild}@anchor{135b}
@deffn {Método} getChild (suffix)

Retorna un logger que es descendiente de este logger, según lo determinado por el sufijo. Por lo tanto, @code{logging.getLogger('abc').getChild('def.ghi')} retornaría el mismo logger que retornaría @code{logging.getLogger('abc.def.ghi')}. Este es un método convenientemente útil cuando el logger principal se nombra usando e.j. @code{__name__} en lugar de una cadena literal.


Added in version 3.2.

@end deffn

@geindex getChildren() (método de logging.Logger)
@anchor{library/logging logging Logger getChildren}@anchor{17cf}
@deffn {Método} getChildren ()

Retorna un conjunto de loggers que son hijos inmediatos de este logger. Así, por ejemplo, @code{logging.getLogger().getChildren()} podría retornar un conjunto que contenga loggers llamados @code{foo} y @code{bar}, pero un logger llamado @code{foo.bar} no estaría incluido en el conjunto. Del mismo modo, @code{logging.getLogger('foo').getChildren()} podría retornar un conjunto que incluyera un logger llamado @code{foo.bar}, pero no incluiría uno llamado @code{foo.bar.baz}.


Added in version 3.12.

@end deffn

@geindex debug() (método de logging.Logger)
@anchor{library/logging logging Logger debug}@anchor{eaf}
@deffn {Método} debug (msg, *args, **kwargs)

Registra un mensaje con el nivel @ref{1cf9,,DEBUG} en este logger. El `msg' es la cadena de formato del mensaje, y los `args' son los argumentos que se fusionan en `msg' utilizando el operador de formato de cadena. (Tenga en cuenta que esto significa que puede usar palabras clave en la cadena de formato, junto con un solo argumento de diccionario). No se realiza ninguna operación de formateo mediante % en `msg' cuando no se proporcionan `args'.

Hay cuatro argumentos de palabras clave `kwargs' que se inspeccionan: `exc_info', `stack_info', `stacklevel' y `extra'.

Si `exc_info' no se evalúa como falso, hace que se agregue información de excepción al mensaje de registro. Si se proporciona una tupla de excepción (en el formato retornado por @ref{72b,,sys.exc_info()}) o se proporciona una instancia de excepción, se utiliza; de lo contrario, se llama a @ref{72b,,sys.exc_info()} para obtener la información de excepción.

El segundo argumento opcional con la palabra clave `stack_info', que por defecto es @code{False}. Si es verdadero, la información de la pila agregara el mensaje de registro, incluida la actual llamada del registro. Tenga en cuenta que esta no es la misma información de la pila que se muestra al especificar `exc_info': la primera son los cuadros de la pila desde la parte inferior de la pila hasta la llamada de registro en el hilo actual, mientras que la segunda es la información sobre los cuadros de la pila que se han desenrollado, siguiendo una excepción, mientras busca gestores de excepción.

Puede especificar `stack_info' independientemente de `exc_info', por ejemplo solo para mostrar cómo llegaste a cierto punto en tu código, incluso cuando no se lanzaron excepciones. Los marcos de la pila se imprimen siguiendo una línea de encabezado que dice:

@example
Stack (most recent call last):
@end example

Esto imita el @code{Traceback (most recent call last):} que se usa cuando se muestran marcos de excepción.

El tercer argumento opcional con la palabra clave `stacklevel', que por defecto es @code{1}. Si es mayor que 1, se omite el número correspondiente de cuadros de pila al calcular el número de línea y el nombre de la función establecidos en @ref{1065,,LogRecord} creado para el evento de registro. Esto se puede utilizar en el registro de ayudantes para que el nombre de la función, el nombre de archivo y el número de línea registrados no sean la información para la función/método auxiliar, sino más bien su llamador. El nombre de este parámetro refleja el equivalente en el modulo @ref{112,,warnings}.

The fourth keyword argument is `extra' which can be used to pass a
dictionary which is used to populate the @ref{5fe,,__dict__} of the
@ref{1065,,LogRecord}
created for the logging event with user-defined attributes. These custom
attributes can then be used as you like. For example, they could be
incorporated into logged messages. For example:

@example
FORMAT = '%(asctime)s %(clientip)-15s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = @{'clientip': '192.168.0.1', 'user': 'fbloggs'@}
logger = logging.getLogger('tcpserver')
logger.warning('Protocol problem: %s', 'connection reset', extra=d)
@end example

imprimiría algo como

@example
2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset
@end example

Las claves en el diccionario pasado `extra' no deben entrar en conflicto con las claves utilizadas por el sistema de registro. (Ver la documentación de @ref{2cd0,,Atributos LogRecord} para obtener más información sobre qué claves utiliza el sistema de registro).

Si elige usar estos atributos en los mensajes registrados, debe tener cuidado. En el ejemplo anterior, se ha configurado @ref{14d1,,Formatter} con una cadena de formato que espera `clientip' y “usuario” en el diccionario de atributos de @ref{1065,,LogRecord}. Si faltan, el mensaje no se registrará porque se producirá una excepción de formato de cadena. En este caso, siempre debe pasar el diccionario `extra' con estas teclas.

Si bien esto puede ser molesto, esta función está diseñada para su uso en circunstancias especializadas, como servidores de subprocesos múltiples donde el mismo código se ejecuta en muchos contextos, y las condiciones interesantes que surgen dependen de este contexto (como la dirección IP del cliente remoto y autenticado nombre de usuario, en el ejemplo anterior). En tales circunstancias, es probable que se especialice @ref{14d1,,Formatter}s con particular @ref{14d0,,Handler}s.

Si no hay ningún gestor asociado a este registrador (o cualquiera de sus antepasados, teniendo en cuenta los atributos relevantes @ref{14cf,,Logger.propagate}), el mensaje se enviará al gestor establecido en @ref{1267,,lastResort}.


Distinto en la versión 3.2: Se agregó el parámetro `stack_info'.



Distinto en la versión 3.5: El parámetro `exc_info' ahora puede aceptar instancias de excepción.



Distinto en la versión 3.8: Se agregó el parámetro `stacklevel'.

@end deffn

@geindex info() (método de logging.Logger)
@anchor{library/logging logging Logger info}@anchor{2cd1}
@deffn {Método} info (msg, *args, **kwargs)

Registra un mensaje con el nivel @ref{1cfa,,INFO} en este logger. Los argumentos se interpretan como @ref{2cd2,,debug()}.
@end deffn

@geindex warning() (método de logging.Logger)
@anchor{library/logging logging Logger warning}@anchor{1709}
@deffn {Método} warning (msg, *args, **kwargs)

Registra un mensaje con el nivel @ref{1cfb,,WARNING} en este logger. Los argumentos se interpretan como @ref{2cd2,,debug()}.

@cartouche
@quotation Nota 
Hay un método obsoleto @code{warn} que es funcionalmente idéntico a @code{warning}. Como @code{warn} está en desuso, no lo use, use @code{warning} en su lugar.
@end quotation
@end cartouche
@end deffn

@geindex error() (método de logging.Logger)
@anchor{library/logging logging Logger error}@anchor{2cd3}
@deffn {Método} error (msg, *args, **kwargs)

Registra un mensaje con nivel @ref{1cfc,,ERROR} en este logger. Los argumentos se interpretan como @ref{2cd2,,debug()}.
@end deffn

@geindex critical() (método de logging.Logger)
@anchor{library/logging logging Logger critical}@anchor{eae}
@deffn {Método} critical (msg, *args, **kwargs)

Registra un mensaje con el nivel @ref{1cfd,,CRITICAL} en este logger. Los argumentos se interpretan como @ref{2cd2,,debug()}.
@end deffn

@geindex log() (método de logging.Logger)
@anchor{library/logging logging Logger log}@anchor{eac}
@deffn {Método} log (level, msg, *args, **kwargs)

Registra un mensaje con nivel entero `level' en este logger. Los otros argumentos se interpretan como @ref{2cd2,,debug()}.
@end deffn

@geindex exception() (método de logging.Logger)
@anchor{library/logging logging Logger exception}@anchor{ead}
@deffn {Método} exception (msg, *args, **kwargs)

Registra un mensaje con nivel @ref{1cfc,,ERROR} en este logger. Los argumentos se interpretan como @ref{2cd2,,debug()}. La información de excepción se agrega al mensaje de registro. Este método solo debe llamarse desde un gestor de excepciones.
@end deffn

@geindex addFilter() (método de logging.Logger)
@anchor{library/logging logging Logger addFilter}@anchor{2cd4}
@deffn {Método} addFilter (filter)

Agrega el filtro `filter' especificado a este logger.
@end deffn

@geindex removeFilter() (método de logging.Logger)
@anchor{library/logging logging Logger removeFilter}@anchor{2cd5}
@deffn {Método} removeFilter (filter)

Elimina el filtro `filter' especificado de este logger.
@end deffn

@geindex filter() (método de logging.Logger)
@anchor{library/logging logging Logger filter}@anchor{2cd6}
@deffn {Método} filter (record)

Aplique los filtros de este logger al registro y retorna @code{True} si se va a procesar el registro. Los filtros se consultan a su vez, hasta que uno de ellos retorna un valor falso. Si ninguno de ellos retorna un valor falso, el registro será procesado (pasado a los gestores). Si se retorna un valor falso, no se produce más procesamiento del registro.
@end deffn

@geindex addHandler() (método de logging.Logger)
@anchor{library/logging logging Logger addHandler}@anchor{2ccb}
@deffn {Método} addHandler (hdlr)

Agrega el gestor especificado `hdlr' a este logger.
@end deffn

@geindex removeHandler() (método de logging.Logger)
@anchor{library/logging logging Logger removeHandler}@anchor{2ccc}
@deffn {Método} removeHandler (hdlr)

Elimina el gestor especificado `hdlr' de este logger.
@end deffn

@geindex findCaller() (método de logging.Logger)
@anchor{library/logging logging Logger findCaller}@anchor{2cd7}
@deffn {Método} findCaller (stack_info=False, stacklevel=1)

Encuentra el nombre de archivo de origen de la invoca y el número de línea. Retorna el nombre del archivo, el número de línea, el nombre de la función y la información de la pila como una tupla de 4 elementos. La información de la pila se retorna como @code{None} a menos que `stack_info' sea @code{True}.

El parámetro `stacklevel' se pasa del código que llama a @ref{2cd2,,debug()} y otras API. Si es mayor que 1, el exceso se utiliza para omitir los cuadros de la pila antes de determinar los valores que se retornarán. Esto generalmente será útil al llamar a las API de registro desde un `helper/wrapper', de modo que la información en el registro de eventos no se refiera al `helper/wrapper', sino al código que lo llama.
@end deffn

@geindex handle() (método de logging.Logger)
@anchor{library/logging logging Logger handle}@anchor{2cd8}
@deffn {Método} handle (record)

Gestiona un registro pasándolo a todos los gestores asociados con este logger y sus antepasados (hasta que se encuentre un valor falso de `propagar'). Este método se utiliza para registros no empaquetados recibidos de un socket, así como para aquellos creados localmente. El filtrado a nivel de logger se aplica usando @ref{2cd6,,filter()}.
@end deffn

@geindex makeRecord() (método de logging.Logger)
@anchor{library/logging logging Logger makeRecord}@anchor{2cd9}
@deffn {Método} makeRecord (name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

Este es un método `factory' que se puede sobreescribir en subclases para crear instancias especializadas @ref{1065,,LogRecord}.
@end deffn

@geindex hasHandlers() (método de logging.Logger)
@anchor{library/logging logging Logger hasHandlers}@anchor{2cda}
@deffn {Método} hasHandlers ()

Comprueba si este logger tiene algún gestor configurado. Esto se hace buscando gestores en este logger y sus padres en la jerarquía del logger. Retorna @code{True} si se encontró un gestor, de lo contrario, @code{False} . El método deja de buscar en la jerarquía cada vez que se encuentra un logger con el atributo `propagate' establecido en falso: ese será el último logger que verificará la existencia de gestores.


Added in version 3.2.

@end deffn


Distinto en la versión 3.7: Los logger ahora se pueden serializar y deserializar (`pickled and unpickled').

@end deffn

@node Niveles de logging,Gestor de objetos,Objetos logger,logging — Logging facility for Python
@anchor{library/logging levels}@anchor{6fb}@anchor{library/logging logging-levels}@anchor{2cdb}
@subsubsection Niveles de logging


Los valores numéricos de los niveles de logging se dan en la siguiente tabla. Estos son principalmente de interés si desea definir sus propios niveles y necesita que tengan valores específicos en relación con los niveles predefinidos. Si define un nivel con el mismo valor numérico, sobrescribe el valor predefinido; se pierde el nombre predefinido.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nivel

@tab

Valor numérico

@tab

Qué significa / Cuándo utilizarlo

@item

@geindex NOTSET (en el módulo logging)
@anchor{library/logging logging NOTSET}@anchor{2cce}
@deffn {Dato} logging.NOTSET
@end deffn

@tab

0

@tab

Cuando se establece en un logger, indica que los loggers antecesores deben ser consultados para determinar el nivel efectivo. Si el resultado sigue siendo @code{NOTSET}, se registrarán todos los eventos. Cuando se establece en un gestor, todos los eventos son gestionados.

@item

@geindex DEBUG (en el módulo logging)
@anchor{library/logging logging DEBUG}@anchor{1cf9}
@deffn {Dato} logging.DEBUG
@end deffn

@tab

10

@tab

Información detallada, normalmente sólo de interés para un desarrollador que intenta diagnosticar un problema.

@item

@geindex INFO (en el módulo logging)
@anchor{library/logging logging INFO}@anchor{1cfa}
@deffn {Dato} logging.INFO
@end deffn

@tab

20

@tab

Confirmación de que todo funciona según lo previsto.

@item

@geindex WARNING (en el módulo logging)
@anchor{library/logging logging WARNING}@anchor{1cfb}
@deffn {Dato} logging.WARNING
@end deffn

@tab

30

@tab

Una indicación de que ha ocurrido algo inesperado o de que podría producirse un problema en un futuro próximo (por ejemplo, «espacio en disco bajo»). El software sigue funcionando como se esperaba.

@item

@geindex ERROR (en el módulo logging)
@anchor{library/logging logging ERROR}@anchor{1cfc}
@deffn {Dato} logging.ERROR
@end deffn

@tab

40

@tab

Debido a un problema más grave, el software no ha podido realizar alguna función.

@item

@geindex CRITICAL (en el módulo logging)
@anchor{library/logging logging CRITICAL}@anchor{1cfd}
@deffn {Dato} logging.CRITICAL
@end deffn

@tab

50

@tab

Un error grave, que indica que es posible que el propio programa no pueda seguir ejecutándose.

@end multitable


@node Gestor de objetos,Objetos formateadores,Niveles de logging,logging — Logging facility for Python
@anchor{library/logging handler}@anchor{2cdc}@anchor{library/logging handler-objects}@anchor{2cdd}
@subsubsection Gestor de objetos


Los gestores tienen los siguientes atributos y métodos. Tenga en cuenta que @ref{14d0,,Handler} nunca se instancia directamente; esta clase actúa como base para subclases más útiles. Sin embargo, el método @code{__init__()} en las subclases debe llamar a @ref{2cde,,Handler.__init__()}.

@geindex Handler (clase en logging)
@anchor{library/logging logging Handler}@anchor{14d0}
@deffn {Clase} logging.Handler

@geindex __init__() (método de logging.Handler)
@anchor{library/logging logging Handler __init__}@anchor{2cde}
@deffn {Método} __init__ (level=NOTSET)

Inicializa la instancia @ref{14d0,,Handler} estableciendo su nivel, configurando la lista de filtros en la lista vacía y creando un bloqueo (usando @ref{2cdf,,createLock()}) para serializar el acceso a un mecanismo de E/S.
@end deffn

@geindex createLock() (método de logging.Handler)
@anchor{library/logging logging Handler createLock}@anchor{2cdf}
@deffn {Método} createLock ()

Inicializa un bloqueo de subprocesos que se puede utilizar para serializar el acceso a la funcionalidad de E/S subyacente que puede no ser segura para subprocesos.
@end deffn

@geindex acquire() (método de logging.Handler)
@anchor{library/logging logging Handler acquire}@anchor{2ce0}
@deffn {Método} acquire ()

Adquiere el bloqueo de hilo creado con @ref{2cdf,,createLock()}.
@end deffn

@geindex release() (método de logging.Handler)
@anchor{library/logging logging Handler release}@anchor{2ce1}
@deffn {Método} release ()

Libera el bloqueo de hilo adquirido con @ref{2ce0,,acquire()}.
@end deffn

@geindex setLevel() (método de logging.Handler)
@anchor{library/logging logging Handler setLevel}@anchor{2ce2}
@deffn {Método} setLevel (level)

Establece el umbral para este gestor en `level'. Los mensajes de registro que son menos severos que `level' serán ignorados. Cuando se crea un gestor, el nivel se establece en @ref{2cce,,NOTSET} (lo que hace que se procesen todos los mensajes).

Ver @ref{6fb,,Niveles de logging} para obtener una lista de niveles.


Distinto en la versión 3.2: El parámetro `level' ahora acepta una representación de cadena del nivel como “INFO” como alternativa a las constantes de enteros como @ref{1cfa,,INFO}.

@end deffn

@geindex setFormatter() (método de logging.Handler)
@anchor{library/logging logging Handler setFormatter}@anchor{2ce3}
@deffn {Método} setFormatter (fmt)

Establece @ref{14d1,,Formatter} para este gestor en `fmt'.
@end deffn

@geindex addFilter() (método de logging.Handler)
@anchor{library/logging logging Handler addFilter}@anchor{2ce4}
@deffn {Método} addFilter (filter)

Agrega el filtro `filter' especificado a este gestor.
@end deffn

@geindex removeFilter() (método de logging.Handler)
@anchor{library/logging logging Handler removeFilter}@anchor{2ce5}
@deffn {Método} removeFilter (filter)

Elimina el filtro especificado `filter' de este gestor.
@end deffn

@geindex filter() (método de logging.Handler)
@anchor{library/logging logging Handler filter}@anchor{2ce6}
@deffn {Método} filter (record)

Aplique los filtros de este gestor al registro y retorna @code{True} si se va a procesar el registro. Los filtros se consultan a su vez, hasta que uno de ellos retorna un valor falso. Si ninguno de ellos retorna un valor falso, se emitirá el registro. Si uno retorna un valor falso, el gestor no emitirá el registro.
@end deffn

@geindex flush() (método de logging.Handler)
@anchor{library/logging logging Handler flush}@anchor{2ce7}
@deffn {Método} flush ()

Asegúrese de que toda la salida de logging se haya vaciado. Esta versión no hace nada y está destinada a ser implementada por subclases.
@end deffn

@geindex close() (método de logging.Handler)
@anchor{library/logging logging Handler close}@anchor{2ce8}
@deffn {Método} close ()

Poner en orden los recursos utilizados por el gestor. Esta versión no genera salida, pero elimina el gestor de una lista interna de gestores que se cierra cuando se llama a @ref{2ce9,,shutdown()}. Las subclases deben garantizar que esto se llame desde métodos @ref{2ce8,,close()} sobreescritos.
@end deffn

@geindex handle() (método de logging.Handler)
@anchor{library/logging logging Handler handle}@anchor{2cea}
@deffn {Método} handle (record)

Emite condicionalmente el registro especifico, según los filtros que se hayan agregado al gestor. Envuelve la actual emisión del registro con `acquisition/release' del hilo de bloqueo E/S.
@end deffn

@geindex handleError() (método de logging.Handler)
@anchor{library/logging logging Handler handleError}@anchor{2ceb}
@deffn {Método} handleError (record)

This method should be called from handlers when an exception is encountered
during an @ref{2cec,,emit()} call. If the module-level attribute
@ref{1266,,raiseExceptions} is @code{False}, exceptions get silently ignored. This is
what is mostly wanted for a logging system - most users will not care about
errors in the logging system, they are more interested in application
errors. You could, however, replace this with a custom handler if you wish.
The specified record is the one which was being processed when the exception
occurred. (The default value of @ref{1266,,raiseExceptions} is @code{True}, as that is
more useful during development).
@end deffn

@geindex format() (método de logging.Handler)
@anchor{library/logging logging Handler format}@anchor{2ced}
@deffn {Método} format (record)

Formato para un registro - si se configura un formateador, úselo. De lo contrario, use el formateador predeterminado para el módulo.
@end deffn

@geindex emit() (método de logging.Handler)
@anchor{library/logging logging Handler emit}@anchor{2cec}
@deffn {Método} emit (record)

Haga lo que sea necesario para registrar de forma especifica el registro. Esta versión está destinada a ser implementada por subclases y, por lo tanto, lanza un @ref{384,,NotImplementedError}.

@cartouche
@quotation Advertencia 
Este método es llamado después de que un bloqueo a nivel de gestor es adquirido, el cual es liberado después de que este método retorna. Cuando sobrescriba este método, tenga en cuenta que debe tener cuidado al llamar a cualquier cosa que invoque a otras partes de la API de registro que puedan realizar bloqueos, ya que esto podría provocar un bloqueo. Específicamente:


@itemize *

@item 
Las API de configuración del registro adquieren el bloqueo a nivel de módulo y, a continuación, los bloqueos a nivel de gestor individual a medida que se configuran dichos gestores.

@item 
Muchas APIs de registro bloquean el bloqueo a nivel de módulo. Si se llama a una API de este tipo desde este método, podría causar un bloqueo si se realiza una llamada de configuración en otro hilo, porque ese hilo intentará adquirir el bloqueo a nivel de módulo `antes' del bloqueo a nivel de gestor, mientras que este hilo intenta adquirir el bloqueo a nivel de módulo `después' del bloqueo a nivel de gestor (porque en este método, el bloqueo a nivel de gestor ya se ha adquirido).
@end itemize
@end quotation
@end cartouche
@end deffn
@end deffn

Para obtener una lista de gestores incluidos como estándar, consulte @ref{89,,logging.handlers}.

@node Objetos formateadores,Filtro de Objetos,Gestor de objetos,logging — Logging facility for Python
@anchor{library/logging formatter-objects}@anchor{2cee}@anchor{library/logging id1}@anchor{2cef}
@subsubsection Objetos formateadores


@geindex Formatter (clase en logging)
@anchor{library/logging logging Formatter}@anchor{14d1}
@deffn {Clase} logging.Formatter (fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Responsable de convertir un @ref{1065,,LogRecord} en una cadena de salida para ser interpretada por un humano o un sistema externo.

@*Parámetros: 

@itemize *

@item 
@code{fmt} (@ref{237,,str}) – Una cadena de formato en el `estilo' dado para la salida registrada en su conjunto. Las posibles claves de mapeo se extraen de @ref{2cd0,,Atributos LogRecord} del objeto @ref{1065,,LogRecord}. Si no se especifica, se utiliza @code{'%(message)s'}, que es sólo el mensaje registrado.

@item 
@code{datefmt} (@ref{237,,str}) – Una cadena de formato en el `estilo' dado para la parte de fecha/hora de la salida registrada. Si no se especifica, se utiliza el valor predeterminado descrito en @ref{2cf0,,formatTime()}.

@item 
@code{style} (@ref{237,,str}) – El parámetro `style' puede ser @code{'%'}, @code{'@{'} o @code{'$'} y determina cómo se fusionará la cadena de formato con sus datos: usando @ref{76d,,Formateo de cadenas al estilo *printf*} (@code{%}), @ref{6c2,,str.format()} (@code{@{}) o @ref{728,,string.Template} (@code{$}). Esto solo aplica al formato de cadenas de caracteres `fmt' y `datefmt' (e.j. @code{'%(message)s'} o @code{'@{message@}'}), no al mensaje de registro real pasado a los métodos de logging. Sin embargo, hay @ref{2cf1,,other ways} para usar @code{@{} y @code{$} en el formateo de mensajes de registro.

@item 
@code{validate} (@ref{513,,bool}) – Si el parámetro `validate' es @code{True} (lo es por defecto), es incorrecto o no coincidente, `fmt' y `style' lanzarán un @ref{360,,ValueError}; Por ejemplo, @code{logging.Formatter('%(asctime)s - %(message)s', style='@{')}.

@item 
@code{defaults} (@ref{190,,dict}@code{[}@ref{237,,str}@code{, }@code{Any}@code{]}) – El parámetro `defaults' puede ser un diccionario con valores por defecto para usar en campos personalizados. Por ejemplo: @code{logging.Formatter('%(ip)s %(message)s', defaults=@{"ip": None@})}
@end itemize



Distinto en la versión 3.2: Added the `style' parameter.



Distinto en la versión 3.8: Added the `validate' parameter.



Distinto en la versión 3.10: Added the `defaults' parameter.


@geindex format() (método de logging.Formatter)
@anchor{library/logging logging Formatter format}@anchor{2cf2}
@deffn {Método} format (record)

El diccionario de atributos del registro se usa como el operando de una operación para formateo de cadenas. Retorna la cadena resultante. Antes de formatear el diccionario, se lleva a cabo un par de pasos preparatorios. El atributo `message' del registro se calcula usando `msg' % `args'. Si el formato de la cadena contiene @code{'(asctime)'}, @ref{2cf0,,formatTime()} se llama para dar formato al tiempo del evento. Si hay información sobre la excepción, se formatea usando @ref{2cf3,,formatException()} y se adjunta al mensaje. Tenga en cuenta que la información de excepción formateada se almacena en caché en el atributo `exc_text'. Esto es útil porque la información de excepción se puede serializar con pickle (`pickled') y propagarse por el cable, pero debe tener cuidado si tiene más de una subclase de @ref{14d1,,Formatter} que personaliza el formato de la información de la excepción. En este caso, tendrá que borrar el valor almacenado en caché (estableciendo el atributo `exc_text' a @code{None}) después de que un formateador haya terminado su formateo, para que el siguiente formateador que maneje el evento no use el valor almacenado en caché, sino que lo recalcule de nuevo.

Si la información de la pila está disponible, se agrega después de la información de la excepción, usando @ref{2cf4,,formatStack()} para transformarla si es necesario.
@end deffn

@geindex formatTime() (método de logging.Formatter)
@anchor{library/logging logging Formatter formatTime}@anchor{2cf0}
@deffn {Método} formatTime (record, datefmt=None)

Este método debe ser llamado desde @ref{6c0,,format()} por un formateador que espera un tiempo formateado . Este método se puede reemplazar en formateadores para proporcionar cualquier requisito específico, pero el comportamiento básico es el siguiente: if `datefmt' (una cadena), se usa con @ref{1256,,time.strftime()} para formatear el tiempo de creación del registro De lo contrario, se utiliza el formato “%Y-%m-%d %H:%M:%S,uuu”, donde la parte `uuu' es un valor de milisegundos y las otras letras son @ref{1256,,time.strftime()} . Un ejemplo de tiempo en este formato es @code{2003-01-23 00:29:50,411}. Se retorna la cadena resultante.

Esta función utiliza una función configurable por el usuario para convertir el tiempo de creación en una tupla. Por defecto, se utiliza @ref{1539,,time.localtime()}; Para cambiar esto para una instancia de formateador particular, se agrega el atributo @code{converter} en una función con igual firma como @ref{1539,,time.localtime()} o @ref{122d,,time.gmtime()}. Para cambiarlo en todos los formateadores, por ejemplo, si desea que todos los tiempos de registro se muestren en GMT, agregue el atributo @code{converter} en la clase @code{Formatter}.


Distinto en la versión 3.3: Anteriormente, el formato predeterminado estaba codificado como en este ejemplo: @code{2010-09-06 22:38:15,292} donde la parte anterior a la coma es manejada por una cadena de formato strptime (@code{'%Y-%m-%d %H:%M:%S'}), y la parte después de la coma es un valor de milisegundos. Debido a que strptime no tiene una posición de formato para milisegundos, el valor de milisegundos se agrega usando otra cadena de formato, @code{'%s,%03d'}— ambas cadenas de formato se han codificado en este método. Con el cambio, estas cadenas se definen como atributos de nivel de clase que pueden `overridden' a nivel de instancia cuando se desee. Los nombres de los atributos son @code{default_time_format} (para una cadena de formato strptime) y @code{default_msec_format} (para agregar el valor de milisegundos).



Distinto en la versión 3.9: El formato @code{default_msec_format} puede ser @code{None}.

@end deffn

@geindex formatException() (método de logging.Formatter)
@anchor{library/logging logging Formatter formatException}@anchor{2cf3}
@deffn {Método} formatException (exc_info)

Formatea la información de una excepción especificada (una excepción como una tupla estándar es retornada por @ref{72b,,sys.exc_info()}) como una cadena. Esta implementación predeterminada solo usa @ref{8e6,,traceback.print_exception()}. La cadena resultantes retornada.
@end deffn

@geindex formatStack() (método de logging.Formatter)
@anchor{library/logging logging Formatter formatStack}@anchor{2cf4}
@deffn {Método} formatStack (stack_info)

Formatea la información de una pila especificada (una cadena es retornada por @ref{f09,,traceback.print_stack()}, pero con la ultima línea removida) como una cadena. Esta implementación predeterminada solo retorna el valor de entrada.
@end deffn
@end deffn

@geindex BufferingFormatter (clase en logging)
@anchor{library/logging logging BufferingFormatter}@anchor{2cf5}
@deffn {Clase} logging.BufferingFormatter (linefmt=None)

Una clase base de formateador adecuada para subclasificar cuando se desea formatear un número de registros. Puede pasar una instancia @ref{14d1,,Formatter} que desee utilizar para formatear cada línea (que corresponde a un único registro). Si no se especifica, el formateador por defecto (que sólo muestra el mensaje del evento) se utiliza como formateador de línea.

@geindex formatHeader() (método de logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter formatHeader}@anchor{2cf6}
@deffn {Método} formatHeader (records)

Retorna una cabecera para una lista de `registros'. La implementación base sólo retorna la cadena vacía. Tendrá que anular este método si desea un comportamiento específico, por ejemplo, mostrar el recuento de registros, un título o una línea separadora.
@end deffn

@geindex formatFooter() (método de logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter formatFooter}@anchor{2cf7}
@deffn {Método} formatFooter (records)

Retorna un pie de página para una lista de `registros'. La implementación base sólo retorna la cadena vacía. Tendrá que anular este método si desea un comportamiento específico, por ejemplo, para mostrar el recuento de registros o una línea separadora.
@end deffn

@geindex format() (método de logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter format}@anchor{2cf8}
@deffn {Método} format (records)

Retorna el texto formateado de una lista de `registros'. La implementación base sólo retorna la cadena vacía si no hay registros; en caso contrario, retorna la concatenación de la cabecera, cada registro formateado con el formateador de líneas y el pie de página.
@end deffn
@end deffn

@node Filtro de Objetos,Objetos LogRecord,Objetos formateadores,logging — Logging facility for Python
@anchor{library/logging filter}@anchor{2cf9}@anchor{library/logging filter-objects}@anchor{2cfa}
@subsubsection Filtro de Objetos


Los @code{Manejadores} y los @code{Registradores} pueden usar los @code{Filtros} para un filtrado más sofisticado que el proporcionado por los niveles. La clase de filtro base solo permite eventos que están por debajo de cierto punto en la jerarquía del logger. Por ejemplo, un filtro inicializado con “A.B” permitirá los eventos registrados por los logger “A.B”, “A.B.C”, “A.B.C.D”, “A.B.D” etc., pero no “A.BB”, “B.A.B”, etc. Si se inicializa con una cadena vacía, se pasan todos los eventos.

@geindex Filter (clase en logging)
@anchor{library/logging logging Filter}@anchor{1268}
@deffn {Clase} logging.Filter (name='@w{'})

Retorna una instancia de la clase @ref{1268,,Filter}. Si se especifica `name', nombra un logger que, junto con sus hijos, tendrá sus eventos permitidos a través del filtro. Si `name' es una cadena vacía, permite todos los eventos.

@geindex filter() (método de logging.Filter)
@anchor{library/logging logging Filter filter}@anchor{2cfb}
@deffn {Método} filter (record)

¿Debe registrarse el registro especificado? Retorna “false” para no, “true” para sí. Los filtros pueden modificar los registros en el lugar o retornar una instancia de registro completamente diferente que sustituirá al registro original en cualquier procesamiento futuro del evento.
@end deffn
@end deffn

Tenga en cuenta que los filtros adjuntos a los gestores se consultan antes de que el gestor emita un evento, mientras que los filtros adjuntos a los loggers se consultan cada vez que se registra un evento (usando @ref{2cd2,,debug()}, @ref{2cfc,,info()}, etc.), antes de enviar un evento a los gestores. Esto significa que los eventos que han sido generados por loggers descendientes no serán filtrados por la configuración del filtro del logger, a menos que el filtro también se haya aplicado a esos loggers descendientes.

En realidad, no se necesita la subclase @code{Filtro}: se puede pasar cualquier instancia que tenga un método de @code{filter} con la misma semántica.


Distinto en la versión 3.2: No es necesario crear clases especializadas de @code{Filter} ni usar otras clases con un método @code{filter}: puede usar una función (u otra invocable) como filtro. La lógica de filtrado verificará si el objeto de filtro tiene un atributo @code{filter}: si lo tiene, se asume que es un @code{Filter} y se llama a su método @ref{2cfb,,filter()}. De lo contrario, se supone que es invocable y se llama con el registro como único parámetro. El valor retornado debe ajustarse al retornado por @ref{2cfb,,filter()}.



Distinto en la versión 3.12: Ahora puedes retornar una instancia de @ref{1065,,LogRecord} desde los filtros para reemplazar el registro en lugar de modificarlo. Esto permite a los filtros adjuntos a un @ref{14d0,,Handler} modificar el registro de log antes de que se emita, sin tener efectos secundarios en otros gestores.


Aunque los filtros se utilizan principalmente para filtrar registros basados en criterios más sofisticados que los niveles, son capaces de ver cada registro que es procesado por el gestor o logger al que están adjuntos: esto puede ser útil si desea hacer cosas como contar cuántos registros fueron procesados por un logger o gestor en particular, o agregando, cambiando o quitando atributos en @ref{1065,,LogRecord} que se está procesando. Obviamente, el cambio de LogRecord debe hacerse con cierto cuidado, pero permite la inyección de información contextual en los registros (ver @ref{2cfd,,Usar filtros para impartir información contextual}).

@node Objetos LogRecord,Atributos LogRecord,Filtro de Objetos,logging — Logging facility for Python
@anchor{library/logging log-record}@anchor{2cfe}@anchor{library/logging logrecord-objects}@anchor{2cff}
@subsubsection Objetos LogRecord


Las instancias @ref{1065,,LogRecord} son creadas automáticamente por @ref{bd7,,Logger} cada vez que se registra algo, y se pueden crear manualmente a través de @ref{2d00,,makeLogRecord()} (por ejemplo, a partir de un evento serializado (`pickled') recibido en la transmisión).

@geindex LogRecord (clase en logging)
@anchor{library/logging logging LogRecord}@anchor{1065}
@deffn {Clase} logging.LogRecord (name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)

Contiene toda la información pertinente al evento que se registra.

La información principal se pasa en `msg' y `args', que se combinan usando @code{msg % args} para crear el atributo @code{message} del registro.

@*Parámetros: 

@itemize *

@item 
@code{name} (@ref{237,,str}) – El nombre del logger utilizado para registrar el evento representado por este @code{LogRecord}. Tenga en cuenta que el nombre del logger en el @code{LogRecord} siempre tendrá este valor, aunque puede ser emitido por un gestor adjunto a un logger diferente (ancestro).

@item 
@code{level} (@ref{1f0,,int}) – El @ref{6fb,,numeric level} del evento de registro (como @code{10} para @code{DEBUG}, @code{20} para @code{INFO}, etc). Tenga en cuenta que esto se convierte en `dos' atributos del LogRecord: @code{levelno} para el valor numérico y @code{levelname} para el nombre del nivel correspondiente.

@item 
@code{pathname} (@ref{237,,str}) – El nombre de ruta completo del archivo de origen donde se realizó la llamada logging.

@item 
@code{lineno} (@ref{1f0,,int}) – El número de línea en el archivo de origen donde se realizó la llamada logging.

@item 
@code{msg} (@ref{74d,,Any}) – El mensaje de descripción del evento, que puede ser una cadena de formato %, con marcadores de posición para datos variables o un objeto arbitrario (para más información vea @ref{2d01,,Usando objetos arbitrarios como mensajes}).

@item 
@code{args} (@ref{464,,tuple}@code{ | }@ref{190,,dict}@code{[}@ref{237,,str}@code{, }@ref{74d,,Any}@code{]}) – Datos variables para fusionar en el argumento `msg' para obtener la descripción del evento.

@item 
@code{exc_info} (@ref{464,,tuple}@code{[}@ref{dcf,,type}@code{[}@ref{65c,,BaseException}@code{]}@code{, }@ref{65c,,BaseException}@code{, }@ref{b7d,,types.TracebackType}@code{] }@code{| }@code{None}) – Una tupla de excepción con la información de excepción actual, tal como se retorna por @ref{72b,,sys.exc_info()} o @code{None} si no hay información de excepción disponible.

@item 
@code{func} (@ref{237,,str}@code{ | }@code{None}) – El nombre de la función o método desde el que se invocó la llamada de logging.

@item 
@code{sinfo} (@ref{237,,str}@code{ | }@code{None}) – Una cadena de texto que representa la información de la pila desde la base de la pila en el hilo actual, hasta la llamada de logging.
@end itemize


@geindex getMessage() (método de logging.LogRecord)
@anchor{library/logging logging LogRecord getMessage}@anchor{2d02}
@deffn {Método} getMessage ()

Retorna el mensaje para la instancia @ref{1065,,LogRecord} después de fusionar cualquier argumento proporcionado por el usuario con el mensaje. Si el argumento del mensaje proporcionado por el usuario para la llamada de logging no es una cadena de caracteres, se invoca @ref{237,,str()} para convertirlo en una cadena. Esto permite el uso de clases definidas por el usuario como mensajes, cuyo método @code{__str__} puede retornar la cadena de formato real que se utilizará.
@end deffn


Distinto en la versión 3.2: La creación de @ref{1065,,LogRecord} se ha hecho más configurable al proporcionar una fábrica que se utiliza para crear el registro. La fábrica se puede configurar usando @ref{2d03,,getLogRecordFactory()} y @ref{2d04,,setLogRecordFactory()} (ver esto para la firma de la fábrica).


Esta funcionalidad se puede utilizar para inyectar sus propios valores en @ref{1065,,LogRecord} en el momento de la creación. Puede utilizar el siguiente patrón:

@example
old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)
@end example

Con este patrón, se podrían encadenar varias fábricas y, siempre que no sobrescriban los atributos de las demás o se sobrescriban involuntariamente los atributos estándar enumerados anteriormente, no debería haber sorpresas.
@end deffn

@node Atributos LogRecord,Objetos LoggerAdapter,Objetos LogRecord,logging — Logging facility for Python
@anchor{library/logging id2}@anchor{2d05}@anchor{library/logging logrecord-attributes}@anchor{2cd0}
@subsubsection Atributos LogRecord


El LogRecord tiene una serie de atributos, la mayoría de los cuales se derivan de los parámetros del constructor. (Tenga en cuenta que los nombres no siempre se corresponden exactamente entre los parámetros del constructor de LogRecord y los atributos de LogRecord). Estos atributos pueden utilizarse para combinar los datos del registro en la cadena de formato. La siguiente tabla enumera (en orden alfabético) los nombres de los atributos, sus significados y el correspondiente marcador de posición en una cadena de formato %-style.

Si utilizas formato-@{@} (@ref{6c2,,str.format()}), puedes usar @code{@{attrname@}} como marcador de posición en la cadena de caracteres de formato. Si está utilizando formato-$ (@ref{728,,string.Template}), use la forma @code{$@{attrname@}}. En ambos casos, por supuesto, reemplace @code{attrname} con el nombre de atributo real que desea utilizar.

En el caso del formato con @{@}, puede especificar `flags' de formato colocándolos después del nombre del atributo, separados con dos puntos. Por ejemplo: un marcador de posición de @code{@{msecs:03.0f@}} formateará un valor de milisegundos de @code{4} como @code{004}. Consulte la documentación @ref{6c2,,str.format()} para obtener detalles completos sobre las opciones disponibles.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre del atributo

@tab

Formato

@tab

Descripción

@item

args

@tab

No debería necesitar formatear esto usted mismo.

@tab

La tupla de argumentos se fusionó en @code{msg} para producir un @code{messsage}, o un dict cuyos valores se utilizan para la fusión (cuando solo hay un argumento y es un diccionario).

@item

asctime

@tab

@code{%(asctime)s}

@tab

Fecha y Hora en formato legible por humanos cuando se creó @ref{1065,,LogRecord}. De forma predeterminada, tiene el formato “2003-07-08 16: 49: 45,896” (los números después de la coma son milisegundos).

@item

created

@tab

@code{%(created)f}

@tab

Time when the @ref{1065,,LogRecord} was created
(as returned by @ref{b72,,time.time_ns()} / 1e9).

@item

exc_info

@tab

No debería necesitar formatear esto usted mismo.

@tab

Tupla de excepción (al modo @code{sys.exc_info}) o, si no se ha producido ninguna excepción, @code{None}.

@item

filename

@tab

@code{%(filename)s}

@tab

Parte del nombre de archivo de @code{pathname}.

@item

funcName

@tab

@code{%(funcName)s}

@tab

Nombre de la función que contiene la llamada de logging.

@item

levelname

@tab

@code{%(levelname)s}

@tab

Texto de nivel de logging para el mensaje (@code{'DEBUG'}, @code{'INFO'}, @code{'WARNING'}, @code{'ERROR'}, @code{'CRITICAL'}).

@item

levelno

@tab

@code{%(levelno)s}

@tab

Número de nivel de logging para el mensaje (@ref{1cf9,,DEBUG}, @ref{1cfa,,INFO}, @ref{1cfb,,WARNING}, @ref{1cfc,,ERROR}, @ref{1cfd,,CRITICAL}).

@item

lineno

@tab

@code{%(lineno)d}

@tab

Número de línea original donde se emitió la llamada de logging (si está disponible).

@item

message

@tab

@code{%(message)s}

@tab

El mensaje registrado, computado como @code{msg % args}. Esto se establece cuando se invoca @ref{2cf2,,Formatter.format()}.

@item

module

@tab

@code{%(module)s}

@tab

Módulo (parte del nombre de @code{filename}).

@item

msecs

@tab

@code{%(msecs)d}

@tab

Porción de milisegundos del tiempo en que se creó @ref{1065,,LogRecord}.

@item

msg

@tab

No debería necesitar formatear esto usted mismo.

@tab

La cadena de caracteres de formato pasada en la llamada logging original. Se fusionó con @code{args} para producir un @code{message}, o un objeto arbitrario (ver @ref{2d01,,Usando objetos arbitrarios como mensajes}).

@item

name

@tab

@code{%(name)s}

@tab

Nombre del logger usado para registrar la llamada.

@item

pathname

@tab

@code{%(pathname)s}

@tab

Nombre de ruta completo del archivo de origen donde se emitió la llamada de logging (si está disponible).

@item

process

@tab

@code{%(process)d}

@tab

ID de proceso (si está disponible).

@item

processName

@tab

@code{%(processName)s}

@tab

Nombre del proceso (si está disponible).

@item

relativeCreated

@tab

@code{%(relativeCreated)d}

@tab

Tiempo en milisegundos cuando se creó el LogRecord, en relación con el tiempo en que se cargó el módulo logging.

@item

stack_info

@tab

No debería necesitar formatear esto usted mismo.

@tab

Apila la información del marco (si está disponible) desde la parte inferior de la pila en el hilo actual hasta la llamada de registro que dio como resultado la generación de este registro.

@item

thread

@tab

@code{%(thread)d}

@tab

ID de hilo (si está disponible).

@item

threadName

@tab

@code{%(threadName)s}

@tab

Nombre del hilo (si está disponible).

@item

taskName

@tab

@code{%(taskName)s}

@tab

nombre de @ref{580,,asyncio.Task} (si está disponible).

@end multitable



Distinto en la versión 3.1: `processName' fue agregado.



Distinto en la versión 3.12: `taskName' fue agregado.


@node Objetos LoggerAdapter,Seguridad del hilo,Atributos LogRecord,logging — Logging facility for Python
@anchor{library/logging logger-adapter}@anchor{2d06}@anchor{library/logging loggeradapter-objects}@anchor{2d07}
@subsubsection Objetos LoggerAdapter


Las instancias @ref{135c,,LoggerAdapter} se utilizan para pasar convenientemente información contextual en las llamadas de logging. Para ver un ejemplo de uso, consulte la sección sobre @ref{2d08,,agregar información contextual a su salida de logging}.

@geindex LoggerAdapter (clase en logging)
@anchor{library/logging logging LoggerAdapter}@anchor{135c}
@deffn {Clase} logging.LoggerAdapter (logger, extra, merge_extra=False)

Returns an instance of @ref{135c,,LoggerAdapter} initialized with an
underlying @ref{bd7,,Logger} instance, a dict-like object (`extra'), and a
boolean (`merge_extra') indicating whether or not the `extra' argument of
individual log calls should be merged with the @ref{135c,,LoggerAdapter} extra.
The default behavior is to ignore the `extra' argument of individual log
calls and only use the one of the @ref{135c,,LoggerAdapter} instance

@geindex process() (método de logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter process}@anchor{2d09}
@deffn {Método} process (msg, kwargs)

Modifica el mensaje y/o los argumentos de palabra clave pasados a una llamada de logging para insertar información contextual. Esta implementación toma el objeto pasado como `extra' al constructor y lo agrega a `kwargs' usando la clave “extra”. El valor de retorno es una tupla (`msg', `kwargs') que tiene las versiones (posiblemente modificadas) de los argumentos pasados.
@end deffn

@geindex manager (atributo de logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter manager}@anchor{2d0a}
@deffn {Atributo} manager

Delegates to the underlying @code{manager} on `logger'.
@end deffn

@geindex _log (atributo de logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter _log}@anchor{2d0b}
@deffn {Atributo} _log

Delegates to the underlying @code{_log()} method on `logger'.
@end deffn

Además de lo anterior, @ref{135c,,LoggerAdapter} admite los siguientes métodos de @ref{bd7,,Logger}: @ref{eaf,,debug()}, @ref{2cd1,,info()}, @ref{1709,,warning()}, @ref{2cd3,,error()}, @ref{ead,,exception()}, @ref{eae,,critical()}, @ref{eac,,log()}, @ref{135d,,isEnabledFor()}, @ref{2ccf,,getEffectiveLevel()}, @ref{14cd,,setLevel()} y @ref{2cda,,hasHandlers()}. Estos métodos tienen las mismas firmas que sus contrapartes en @ref{bd7,,Logger}, por lo que puede usar los dos tipos de instancias indistintamente.


Distinto en la versión 3.2: Los métodos @ref{135d,,isEnabledFor()}, @ref{2ccf,,getEffectiveLevel()}, @ref{14cd,,setLevel()} y @ref{2cda,,hasHandlers()} se agregaron a @ref{135c,,LoggerAdapter} . Estos métodos se delegan al logger subyacente.



Distinto en la versión 3.6: Se añadió el atributo @code{manager} y el método @code{_log()}, que delegan al logger subyacente y permiten que los adaptadores se aniden.



Distinto en la versión 3.13: The `merge_extra' argument was added.

@end deffn

@node Seguridad del hilo,Funciones a nivel de módulo,Objetos LoggerAdapter,logging — Logging facility for Python
@anchor{library/logging thread-safety}@anchor{2d0c}
@subsubsection Seguridad del hilo


El módulo logging está diseñado para ser seguro para subprocesos sin que sus clientes tengan que realizar ningún trabajo especial. Lo logra mediante el uso de bloqueos de hilos; hay un bloqueo para serializar el acceso a los datos compartidos del módulo, y cada gestor también crea un bloqueo para serializar el acceso a su E/S subyacente.

Si está implementando gestores de señales asíncronos usando el módulo @ref{c6,,signal}, es posible que no pueda usar logging desde dichos gestores. Esto se debe a que las implementaciones de bloqueo en el módulo @ref{ed,,threading} no siempre son reentrantes y, por lo tanto, no se pueden invocar desde dichos gestores de señales.

@node Funciones a nivel de módulo,Atributos a nivel de módulo,Seguridad del hilo,logging — Logging facility for Python
@anchor{library/logging module-level-functions}@anchor{2d0d}
@subsubsection Funciones a nivel de módulo


Además de las clases descritas anteriormente, hay una serie de funciones a nivel de módulo.

@geindex getLogger() (en el módulo logging)
@anchor{library/logging logging getLogger}@anchor{9f3}
@deffn {Función} logging.getLogger (name=None)

Return a logger with the specified name or, if name is @code{None}, return the
root logger of the hierarchy. If specified, the name is typically a
dot-separated hierarchical name like `“a”', `“a.b”' or `“a.b.c.d”'. Choice
of these names is entirely up to the developer who is using logging, though
it is recommended that @code{__name__} be used unless you have a specific
reason for not doing that, as mentioned in @ref{2cc5,,Objetos logger}.

Todas las llamadas a esta función con un nombre dado retornan la misma instancia de logger. Esto significa que las instancias del logger nunca necesitan pasar entre diferentes partes de una aplicación.
@end deffn

@geindex getLoggerClass() (en el módulo logging)
@anchor{library/logging logging getLoggerClass}@anchor{2d0e}
@deffn {Función} logging.getLoggerClass ()

Retorna ya sea la clase estándar @ref{bd7,,Logger}, o la última clase pasada a @ref{2d0f,,setLoggerClass()}. Esta función se puede llamar desde una nueva definición de clase, para garantizar que la instalación de una clase personalizada @ref{bd7,,Logger} no deshaga las `customizaciones' ya aplicadas por otro código. Por ejemplo:

@example
class MyLogger(logging.getLoggerClass()):
    # ... override behaviour here
@end example
@end deffn

@geindex getLogRecordFactory() (en el módulo logging)
@anchor{library/logging logging getLogRecordFactory}@anchor{2d03}
@deffn {Función} logging.getLogRecordFactory ()

Retorna un invocable que se usa para crear una @ref{1065,,LogRecord}.


Added in version 3.2: Esta función se ha proporcionado, junto con @ref{2d04,,setLogRecordFactory()}, para permitir a los desarrolladores un mayor control sobre cómo @ref{1065,,LogRecord} representa un evento logging construido.


Consulte @ref{2d04,,setLogRecordFactory()} para obtener más información sobre cómo se llama a la fábrica.
@end deffn

@geindex debug() (en el módulo logging)
@anchor{library/logging logging debug}@anchor{2cd2}
@deffn {Función} logging.debug (msg, *args, **kwargs)

This is a convenience function that calls @ref{eaf,,Logger.debug()}, on the root
logger. The handling of the arguments is in every way identical
to what is described in that method.

The only difference is that if the root logger has no handlers, then
@ref{a92,,basicConfig()} is called, prior to calling @code{debug} on the root logger.

For very short scripts or quick demonstrations of @code{logging} facilities,
@code{debug} and the other module-level functions may be convenient. However,
most programs will want to carefully and explicitly control the logging
configuration, and should therefore prefer creating a module-level logger and
calling @ref{eaf,,Logger.debug()} (or other level-specific methods) on it, as
described at the beginning of this documentation.
@end deffn

@geindex info() (en el módulo logging)
@anchor{library/logging logging info}@anchor{2cfc}
@deffn {Función} logging.info (msg, *args, **kwargs)

Logs a message with level @ref{1cfa,,INFO} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}.
@end deffn

@geindex warning() (en el módulo logging)
@anchor{library/logging logging warning}@anchor{1f7}
@deffn {Función} logging.warning (msg, *args, **kwargs)

Logs a message with level @ref{1cfb,,WARNING} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}.

@cartouche
@quotation Nota 
Hay una función obsoleta @code{warn} que es funcionalmente idéntica a @code{warning}. Como @code{warn} está deprecado, por favor no lo use, use @code{warning} en su lugar.
@end quotation
@end cartouche
@end deffn

@geindex error() (en el módulo logging)
@anchor{library/logging logging error}@anchor{2d10}
@deffn {Función} logging.error (msg, *args, **kwargs)

Logs a message with level @ref{1cfc,,ERROR} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}.
@end deffn

@geindex critical() (en el módulo logging)
@anchor{library/logging logging critical}@anchor{2d11}
@deffn {Función} logging.critical (msg, *args, **kwargs)

Logs a message with level @ref{1cfd,,CRITICAL} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}.
@end deffn

@geindex exception() (en el módulo logging)
@anchor{library/logging logging exception}@anchor{14ce}
@deffn {Función} logging.exception (msg, *args, **kwargs)

Logs a message with level @ref{1cfc,,ERROR} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}. Exception info is added to the logging
message. This function should only be called from an exception handler.
@end deffn

@geindex log() (en el módulo logging)
@anchor{library/logging logging log}@anchor{2d12}
@deffn {Función} logging.log (level, msg, *args, **kwargs)

Logs a message with level `level' on the root logger. The arguments and behavior
are otherwise the same as for @ref{2cd2,,debug()}.
@end deffn

@geindex disable() (en el módulo logging)
@anchor{library/logging logging disable}@anchor{2d13}
@deffn {Función} logging.disable (level=CRITICAL)

Proporciona un nivel superior de `level' para todos los loggers que tienen prioridad sobre el propio nivel del logger. Cuando surge la necesidad de reducir temporalmente la salida de logging en toda la aplicación, esta función puede resultar útil. Su efecto es deshabilitar todas las llamadas de gravedad `level' e inferior, de modo que si lo llaman con un valor de INFO, todos los eventos INFO y DEBUG se descartarán, mientras que los de gravedad WARNING y superiores se procesarán de acuerdo con el nivel efectivo del logger. Si se llama a @code{logging.disable(logging.NOTSET)} , elimina efectivamente este nivel primordial, de modo que la salida del registro depende nuevamente de los niveles efectivos de los loggers individuales.

Tenga en cuenta que si ha definido un nivel de logging personalizado superior a @code{CRITICAL} (esto no es recomendado), no podrá confiar en el valor predeterminado para el parámetro `level', pero tendrá que proporcionar explícitamente un valor adecuado.


Distinto en la versión 3.7: El parámetro `level' se estableció por defecto en el nivel @code{CRITICAL}. Consulte el Issue #28524 para obtener más información sobre este cambio.

@end deffn

@geindex addLevelName() (en el módulo logging)
@anchor{library/logging logging addLevelName}@anchor{2d14}
@deffn {Función} logging.addLevelName (level, levelName)

Asocia nivel `level' con el texto `levelName' en un diccionario interno, que se utiliza para asignar niveles numéricos a una representación textual, por ejemplo, cuando @ref{14d1,,Formatter} formatea un mensaje. Esta función también se puede utilizar para definir sus propios niveles. Las únicas restricciones son que todos los niveles utilizados deben registrarse utilizando esta función, los niveles deben ser números enteros positivos y deben aumentar en orden creciente de severidad.

@cartouche
@quotation Nota 
Si está pensando en definir sus propios niveles, consulte la sección sobre @ref{2d15,,Niveles personalizados}.
@end quotation
@end cartouche
@end deffn

@geindex getLevelNamesMapping() (en el módulo logging)
@anchor{library/logging logging getLevelNamesMapping}@anchor{6fa}
@deffn {Función} logging.getLevelNamesMapping ()

Retorna una correspondencia entre los nombres de nivel y sus correspondientes niveles de registro. Por ejemplo, la cadena «CRITICAL» corresponde a @ref{1cfd,,CRITICAL}. La correspondencia retornada se copia de una correspondencia interna en cada llamada a esta función.


Added in version 3.11.

@end deffn

@geindex getLevelName() (en el módulo logging)
@anchor{library/logging logging getLevelName}@anchor{2d16}
@deffn {Función} logging.getLevelName (level)

Retorna la representación textual o numérica del nivel de registro `level'.

Si `level' es uno de los niveles predefinidos @ref{1cfd,,CRITICAL}, @ref{1cfc,,ERROR}, @ref{1cfb,,WARNING}, @ref{1cfa,,INFO} o @ref{1cf9,,DEBUG} entonces se obtiene la cadena correspondiente. Si has asociado niveles con nombres usando @ref{2d14,,addLevelName()} entonces se retorna el nombre que has asociado con `level'. Si se pasa un valor numérico correspondiente a uno de los niveles definidos, se retorna la representación de cadena correspondiente.

El parámetro `level' también acepta una representación de cadena del nivel como, por ejemplo, «INFO». En estos casos, esta función retorna el correspondiente valor numérico del nivel.

Si no se pasa un valor numérico o de cadena que coincida, se retorna el valor de nivel de la cadena “Level %s”.

@cartouche
@quotation Nota 
Los niveles internamente son números enteros (ya que deben compararse en la lógica de logging). Esta función se utiliza para convertir entre un nivel entero y el nombre del nivel que se muestra en la salida de logging formateado mediante el especificador de formato @code{%(levelname)s} (ver @ref{2cd0,,Atributos LogRecord}).
@end quotation
@end cartouche


Distinto en la versión 3.4: En las versiones de Python anteriores a la 3.4, esta función también podría pasar un nivel de texto y retornaría el valor numérico correspondiente del nivel. Este comportamiento indocumentado se consideró un error y se eliminó en Python 3.4, pero se restableció en 3.4.2 debido a que conserva la compatibilidad con versiones anteriores.

@end deffn

@geindex getHandlerByName() (en el módulo logging)
@anchor{library/logging logging getHandlerByName}@anchor{17df}
@deffn {Función} logging.getHandlerByName (name)

Retorna un gestor con el `name' especificado o @code{None} si no hay un gestor con ese nombre.


Added in version 3.12.

@end deffn

@geindex getHandlerNames() (en el módulo logging)
@anchor{library/logging logging getHandlerNames}@anchor{1703}
@deffn {Función} logging.getHandlerNames ()

Retorna un conjunto inmutable del nombre de todos los gestor conocidos.


Added in version 3.12.

@end deffn

@geindex makeLogRecord() (en el módulo logging)
@anchor{library/logging logging makeLogRecord}@anchor{2d00}
@deffn {Función} logging.makeLogRecord (attrdict)

Crea y retorna una nueva instancia @ref{1065,,LogRecord} cuyos atributos están definidos por `attrdict'. Esta función es útil para tomar un diccionario de atributos serializado (`pickled') @ref{1065,,LogRecord}, enviado a través de un socket, y reconstituido como una instancia @ref{1065,,LogRecord} en el extremo receptor.
@end deffn

@geindex basicConfig() (en el módulo logging)
@anchor{library/logging logging basicConfig}@anchor{a92}
@deffn {Función} logging.basicConfig (**kwargs)

Realiza una configuración básica para el sistema de logging creando una @ref{1265,,StreamHandler} con un @ref{14d1,,Formatter} predeterminado y agregándolo al logger raíz. Las funciones @ref{2cd2,,debug()}, @ref{2cfc,,info()}, @ref{1f7,,warning()}, @ref{2d10,,error()} y @ref{2d11,,critical()} llamarán @ref{a92,,basicConfig()} automáticamente si no se definen gestores para el logger raíz.

Esta función no hace nada si el logger raíz ya tiene gestores configurados, a menos que el argumento de palabra clave `force' esté establecido como @code{True}.

@cartouche
@quotation Nota 
Esta función debe llamarse desde el hilo principal antes de que se inicien otros hilos. En las versiones de Python anteriores a 2.7.1 y 3.2, si se llama a esta función desde varios subprocesos, es posible (en raras circunstancias) que se agregue un gestor al logger raíz más de una vez, lo que genera resultados inesperados como mensajes duplicados en el registro.
@end quotation
@end cartouche

Se admiten los siguientes argumentos de palabras clave.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Formato

@tab

Descripción

@item

`filename'

@tab

Especifica que se cree un @ref{18a7,,FileHandler}, utilizando el nombre de archivo especificado, en lugar de @ref{1265,,StreamHandler}.

@item

`filemode'

@tab

Si se especifica `filename', abre el archivo en @ref{217e,,mode}. Por defecto es @code{'a'}.

@item

`format'

@tab

Utiliza la cadena de caracteres de formato especificada para el gestor.Los atributos por defecto son @code{levelname}, @code{name} y @code{message} separado por dos puntos.

@item

`datefmt'

@tab

Utiliza el formato de fecha/hora especificado, aceptado por @ref{1256,,time.strftime()}.

@item

`style'

@tab

Si `format' es especificado, utilice este estilo para la cadena de caracteres de formato. Uno de @code{'%'}, @code{'@{'} o @code{'$'} para @ref{76d,,printf-style}, @ref{6c2,,str.format()} o @ref{728,,string.Template} respectivamente. El valor predeterminado es @code{'%'}.

@item

`level'

@tab

Establece el nivel del logger raíz en el @ref{6fb,,level} especificado.

@item

`stream'

@tab

Utiliza la secuencia especificada para inicializar @ref{1265,,StreamHandler}. Tenga en cuenta que este argumento es incompatible con `filename' - si ambos están presentes, se lanza un @code{ValueError}.

@item

`handlers'

@tab

Si se especifica, debe ser una iteración de los gestores ya creados para agregar al logger raíz. A cualquier gestor que aún no tenga un formateador configurado se le asignará el formateador predeterminado creado en esta función. Tenga en cuenta que este argumento es incompatible con `filename' o `stream'; si ambos están presentes, se lanza un @code{ValueError}.

@item

`force'

@tab

Si este argumento de palabra clave se especifica como verdadero, los gestores existentes adjuntos al logger raíz se eliminan y cierran antes de llevar a cabo la configuración tal como se especifica en los otros argumentos.

@item

`encoding'

@tab

Si este argumento de palabra clave se especifica junto con `filename', su valor se utiliza cuando se crea el @ref{18a7,,FileHandler}, y por lo tanto se utiliza al abrir el archivo de salida.

@item

`errors'

@tab

Si este argumento de palabra clave se especifica junto con `filename', su valor se utiliza cuando se crea el @ref{18a7,,FileHandler}, y por lo tanto cuando se abre el archivo de salida. Si no se especifica, se utiliza el valor “backslashreplace”. Tenga en cuenta que si se especifica @code{None}, se pasará como tal a @ref{1be,,open()}, lo que significa que se tratará igual que pasar “errors”.

@end multitable



Distinto en la versión 3.2: Se agregó el argumento `style'.



Distinto en la versión 3.3: Se agregó el argumento `handlers'. Se agregaron verificaciones adicionales para detectar situaciones en las que se especifican argumentos incompatibles (por ejemplo, `handlers' junto con `stream' o `filename', o `stream' junto con `filename').



Distinto en la versión 3.8: Se agregó el argumento `force'.



Distinto en la versión 3.9: Se han añadido los argumentos `encoding' y `errors'.

@end deffn

@geindex shutdown() (en el módulo logging)
@anchor{library/logging logging shutdown}@anchor{2ce9}
@deffn {Función} logging.shutdown ()

Informa al sistema de logging para realizar un apagado ordenado descargando y cerrando todos los gestores. Esto se debe llamar al salir de la aplicación y no se debe hacer ningún uso posterior del sistema de logging después de esta llamada.

Cuando se importa el módulo de logging, registra esta función como un gestor de salida (ver @ref{d,,atexit}), por lo que normalmente no es necesario hacerlo manualmente.
@end deffn

@geindex setLoggerClass() (en el módulo logging)
@anchor{library/logging logging setLoggerClass}@anchor{2d0f}
@deffn {Función} logging.setLoggerClass (klass)

Le dice al sistema de logging que use la clase `klass' al crear una instancia de un logger. La clase debe definir @code{__init__()} tal que solo se requiera un argumento de nombre, y @code{__init__()} debe llamar @code{Logger.__init__()}. Por lo general, esta función se llama antes de que cualquier logger sea instanciado por las aplicaciones que necesitan utilizar un comportamiento de logger personalizado. Después de esta llamada, como en cualquier otro momento, no cree instancias de loggers directamente usando la subclase: continúe usando la API @ref{9f3,,logging.getLogger()} para obtener sus loggers.
@end deffn

@geindex setLogRecordFactory() (en el módulo logging)
@anchor{library/logging logging setLogRecordFactory}@anchor{2d04}
@deffn {Función} logging.setLogRecordFactory (factory)

Establece un invocable que se utiliza para crear @ref{1065,,LogRecord}.

@*Parámetros: 
@code{factory} – La fábrica invocable que se utilizará para crear una instancia de un registro.



Added in version 3.2: Esta función se ha proporcionado, junto con @ref{2d03,,getLogRecordFactory()}, para permitir a los desarrolladores un mayor control sobre cómo se construye @ref{1065,,LogRecord} que representa un evento de logging.


La fábrica tiene la siguiente firma:

@code{factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)}

@quotation

@*name: 
El nombre del logger.


@*level: 
El nivel de logging (numérico).


@*fn: 
El nombre de ruta completo del archivo donde se realizó la llamada de logging.


@*lno: 
El número de línea en el archivo donde se realizó la llamada de logging.


@*msg: 
El mensaje de logging.


@*args: 
Los argumentos para el mensaje de logging.


@*exc_info: 
Una tupla de excepción o @code{None}.


@*func: 
El nombre de la función o método que invocó la llamada de logging.


@*sinfo: 
Un seguimiento de pila como el que proporciona @ref{f09,,traceback.print_stack()}, que muestra la jerarquía de llamadas.


@*kwargs: 
Argumentos de palabras clave adicionales.

@end quotation
@end deffn

@node Atributos a nivel de módulo,Integración con el módulo de advertencias,Funciones a nivel de módulo,logging — Logging facility for Python
@anchor{library/logging module-level-attributes}@anchor{2d17}
@subsubsection Atributos a nivel de módulo


@geindex lastResort (en el módulo logging)
@anchor{library/logging logging lastResort}@anchor{1267}
@deffn {Atributo} logging.lastResort

Un «gestor de último recurso» está disponible a través de este atributo. Esta es una @ref{1265,,StreamHandler} que escribe en @code{sys.stderr} con un nivel @code{WARNING}, y se usa para gestionar eventos de logging en ausencia de cualquier configuración de logging. El resultado final es simplemente imprimir el mensaje en @code{sys.stderr}. Esto reemplaza el mensaje de error anterior que decía que «no se pudieron encontrar gestores para el logger XYZ». Si necesita el comportamiento anterior por alguna razón, @code{lastResort} se puede configurar en @code{None}.


Added in version 3.2.

@end deffn

@geindex raiseExceptions (en el módulo logging)
@anchor{library/logging logging raiseExceptions}@anchor{1266}
@deffn {Atributo} logging.raiseExceptions

Used to see if exceptions during handling should be propagated.

Default: @code{True}.

If @ref{1266,,raiseExceptions} is @code{False},
exceptions get silently ignored. This is what is mostly wanted
for a logging system - most users will not care about errors in
the logging system, they are more interested in application errors.
@end deffn

@node Integración con el módulo de advertencias,,Atributos a nivel de módulo,logging — Logging facility for Python
@anchor{library/logging integration-with-the-warnings-module}@anchor{2d18}
@subsubsection Integración con el módulo de advertencias


La función @ref{2d19,,captureWarnings()} se puede utilizar para integrar @ref{87,,logging} con el módulo @ref{112,,warnings}.

@geindex captureWarnings() (en el módulo logging)
@anchor{library/logging logging captureWarnings}@anchor{2d19}
@deffn {Función} logging.captureWarnings (capture)

Esta función se utiliza para activar y desactivar la captura de advertencias (`warnings').

Si `capture' es @code{True}, las advertencias emitidas por el módulo @ref{112,,warnings} serán redirigidas al sistema de logging. Específicamente, una advertencia se formateará usando @ref{1a1d,,warnings.formatwarning()} y la cadena de caracteres resultante se registrará en un logger  llamado @code{'py.warnings'} con severidad @ref{1cfb,,WARNING}.

Si `capture' es @code{False}, la redirección de advertencias al sistema de logging se detendrá y las advertencias serán redirigidas a sus destinos originales (es decir, aquellos en vigor antes de que se llamara a @code{captureWarnings(True)}).
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{88,,logging.config}

API de configuración para el módulo logging.

@item Módulo @ref{89,,logging.handlers}

Gestores útiles incluidos con el módulo logging.

@geindex Python Enhancement Proposals; PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - A Logging System

La propuesta que describió esta característica para su inclusión en la biblioteca estándar de Python.

@item Paquete logging original de Python@footnote{https://old.red-dove.com/python_logging.html}

Esta es la fuente original del paquete @ref{87,,logging}. La versión del paquete disponible en este sitio es adecuada para usar con Python 1.5.2, 2.1.xy 2.2.x, que no incluyen el paquete @ref{87,,logging} en la biblioteca estándar.
@end table


@node logging config — Logging configuration,logging handlers — Logging handlers,logging — Logging facility for Python,Servicios genéricos del sistema operativo
@anchor{library/logging config doc}@anchor{2d1a}@anchor{library/logging config logging-config-logging-configuration}@anchor{2d1b}@anchor{library/logging config module-logging config}@anchor{88}
@subsection @code{logging.config} — Logging configuration


@geindex module; logging.config

`Código fuente:' Lib/logging/config.py@footnote{https://github.com/python/cpython/tree/main/Lib/logging/config.py}

@subsubheading Important



Esta página solo contiene información de referencia. Para tutoriales, por favor consulte


@itemize *

@item 
@ref{1262,,Tutorial Básico}

@item 
@ref{1263,,Tutorial Avanzado}

@item 
@ref{1264,,Guía de registro *Logging*}
@end itemize


__________________________________________________________________


Esta sección describe la API para configurar el módulo de registro.

@menu
* Funciones de configuración:: 
* Consideraciones de seguridad:: 
* Esquema del diccionario de configuración:: 
* Formato de archivo de configuración:: 

@end menu

@node Funciones de configuración,Consideraciones de seguridad,,logging config — Logging configuration
@anchor{library/logging config configuration-functions}@anchor{2d1c}@anchor{library/logging config logging-config-api}@anchor{1358}
@subsubsection Funciones de configuración


Las siguientes funciones configuran el módulo de registro. Se encuentran en el módulo @ref{88,,logging.config}.  Su uso es opcional — puede configurar el módulo de registro utilizando estas funciones o realizando llamadas a la API principal (definida en @ref{87,,logging}) y definiendo los gestores que se declaran en @ref{87,,logging} o @ref{89,,logging.handlers}.

@geindex dictConfig() (en el módulo logging.config)
@anchor{library/logging config logging config dictConfig}@anchor{121e}
@deffn {Función} logging.config.dictConfig (config)

Toma la configuración de registro de un diccionario.  Los contenidos de este diccionario se describen en @ref{2d1d,,Esquema del diccionario de configuración} a continuación.

Si se encuentra un error durante la configuración, esta función lanzará un @ref{360,,ValueError}, @ref{228,,TypeError}, @ref{441,,AttributeError} o @ref{4d7,,ImportError} con un mensaje descriptivo adecuado.  La siguiente es una lista (posiblemente incompleta) de condiciones que lanzarán un error:


@itemize *

@item 
Un @code{level} que no es una cadena o que es una cadena que no corresponde a un nivel de registro real.

@item 
Un valor de @code{propagate} que no es booleano.

@item 
Una identificación que no tiene un destino correspondiente.

@item 
Una identificación de gestor inexistente encontrada durante una llamada incremental.

@item 
Un nombre de registrador no válido.

@item 
Incapacidad para resolver un objeto interno o externo.
@end itemize

El análisis se realiza mediante la clase @code{DictConfigurator}, a cuyo constructor se le pasa el diccionario utilizado para la configuración, y tiene un método @code{configure()}.  El módulo @ref{88,,logging.config} tiene un atributo invocable @code{dictConfigClass} que se establece inicialmente en @code{DictConfigurator}. Puede reemplazar el valor de @code{dictConfigClass} con una implementación adecuada propia.

@ref{121e,,dictConfig()} llama @code{dictConfigClass} pasando el diccionario especificado, y luego llama al método @code{configure()} en el objeto retornado para que la configuración surta efecto:

@example
def dictConfig(config):
    dictConfigClass(config).configure()
@end example

For example, a subclass of @code{DictConfigurator} could call
@code{DictConfigurator.__init__()} in its own @code{__init__()}, then
set up custom prefixes which would be usable in the subsequent
@code{configure()} call. @code{dictConfigClass} would be bound to
this new subclass, and then @ref{121e,,dictConfig()} could be called exactly as
in the default, uncustomized state.


Added in version 3.2.

@end deffn

@geindex fileConfig() (en el módulo logging.config)
@anchor{library/logging config logging config fileConfig}@anchor{bd9}
@deffn {Función} logging.config.fileConfig (fname, defaults=None, disable_existing_loggers=True, encoding=None)

Lee la configuración de registro desde un archivo de formato de @ref{23,,configparser}. El formato del archivo debe ser como se describe en @ref{2d1e,,Formato de archivo de configuración}. Esta función se puede invocar varias veces desde una aplicación, lo que permite al usuario final seleccionar entre varias configuraciones predeterminadas (si el desarrollador proporciona un mecanismo para presentar las opciones y cargar la configuración elegida).

It will raise @ref{f46,,FileNotFoundError} if the file
doesn’t exist and @ref{1e5,,RuntimeError} if the file is invalid or
empty.

@*Parámetros: 

@itemize *

@item 
@code{fname} – A filename, or a file-like object, or an instance derived
from @ref{fe4,,RawConfigParser}. If a
@code{RawConfigParser}-derived instance is passed, it is used as
is. Otherwise, a @ref{32b,,ConfigParser} is
instantiated, and the configuration read by it from the
object passed in @code{fname}. If that has a @ref{ba,,readline()}
method, it is assumed to be a file-like object and read using
@ref{5aa,,read_file()}; otherwise,
it is assumed to be a filename and passed to
@ref{14a5,,read()}.

@item 
@code{defaults} – Defaults to be passed to the @code{ConfigParser} can be specified
in this argument.

@item 
@code{disable_existing_loggers} – If specified as @code{False}, loggers which
exist when this call is made are left
enabled. The default is @code{True} because this
enables old behaviour in a
backward-compatible way. This behaviour is to
disable any existing non-root loggers unless
they or their ancestors are explicitly named
in the logging configuration.

@item 
@code{encoding} – La codificación que se usa para abrir archivos cuando `fname' es nombre del archivo.
@end itemize



Distinto en la versión 3.4: Una instancia de una subclase de @ref{fe4,,RawConfigParser}  ahora se acepta como un valor para @code{fname}. Esto facilita:

@quotation


@itemize *

@item 
Uso de un archivo de configuración donde la configuración de registro es solo parte de la configuración general de la aplicación.

@item 
Uso de una configuración leída de un archivo, y luego modificada por la aplicación que lo usa (por ejemplo, basada en parámetros de línea de comandos u otros aspectos del entorno de ejecución) antes de pasar a @code{fileConfig}.
@end itemize
@end quotation


Distinto en la versión 3.10: Added the `encoding' parameter.



Distinto en la versión 3.12: An exception will be thrown if the provided file
doesn’t exist or is invalid or empty.


@end deffn

@geindex listen() (en el módulo logging.config)
@anchor{library/logging config logging config listen}@anchor{fe5}
@deffn {Función} logging.config.listen (port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)

Inicia un servidor de socket en el puerto especificado y escucha nuevas configuraciones. Si no se especifica ningún puerto, se usa el valor predeterminado del módulo @code{DEFAULT_LOGGING_CONFIG_PORT}. Las configuraciones de registro se enviarán como un archivo adecuado para su procesamiento por @ref{121e,,dictConfig()} o @ref{bd9,,fileConfig()}. Retorna una instancia de @ref{9df,,Thread} en la que puede llamar @ref{2d1f,,start()} para iniciar el servidor, y que puede @ref{1251,,join()} cuando corresponda . Para detener el servidor, llame a @ref{2d20,,stopListening()}.

El argumento @code{verify}, si se especifica, debe ser invocable, lo que debería verificar si los bytes recibidos en el socket son válidos y deben procesarse. Esto podría hacerse encriptando y / o firmando lo que se envía a través del socket, de modo que el @code{verify} invocable pueda realizar la verificación o descifrado de la firma. El llamado invocable @code{verify} se llama con un solo argumento (los bytes recibidos a través del socket) y debe retornar los bytes a procesar, o @code{None} para indicar que los bytes deben descartarse. Los bytes retornados podrían ser los mismos que los pasados en bytes (por ejemplo, cuando solo se realiza la verificación), o podrían ser completamente diferentes (tal vez si se realizó el descifrado).

Para enviar una configuración al socket, lea el archivo de configuración y envíelo al socket como una secuencia de bytes precedida por una cadena de longitud de cuatro bytes empaquetada en binario usando @code{struct.pack('>L', n)}.
@anchor{library/logging config logging-eval-security}@anchor{2d21}
@cartouche
@quotation Nota 
Debido a que partes de la configuración se pasan a través de @ref{2eb,,eval()}, el uso de esta función puede abrir a sus usuarios a un riesgo de seguridad. Si bien la función solo se une a un socket en @code{localhost} y, por lo tanto, no acepta conexiones de máquinas remotas, hay escenarios en los que se puede ejecutar código no confiable bajo la cuenta del proceso que llama @ref{fe5,,listen()}. Específicamente, si el proceso que llama @ref{fe5,,listen()} se ejecuta en una máquina multiusuario donde los usuarios no pueden confiar el uno en el otro, entonces un usuario malintencionado podría hacer arreglos para ejecutar código esencialmente arbitrario en el proceso del usuario víctima, simplemente conectándose al socket @ref{fe5,,listen()} de la víctima y enviando una configuración que ejecuta cualquier código que el atacante quiera ejecutar en el proceso de la víctima. Esto es especialmente fácil de hacer si se usa el puerto predeterminado, pero no es difícil incluso si se usa un puerto diferente. Para evitar el riesgo de que esto suceda, use el argumento @code{verify} para @ref{fe5,,listen()} para escuchar y evitar que se apliquen configuraciones no reconocidas.
@end quotation
@end cartouche


Distinto en la versión 3.4: Se agregó el argumento @code{verify}.


@cartouche
@quotation Nota 
Si desea enviar configuraciones al oyente que no deshabiliten los registradores existentes, deberá usar un formato JSON para la configuración, que utilizará @ref{121e,,dictConfig()} para la configuración. Este método le permite especificar @code{disable_existing_loggers} como @code{False} en la configuración que envía.
@end quotation
@end cartouche
@end deffn

@geindex stopListening() (en el módulo logging.config)
@anchor{library/logging config logging config stopListening}@anchor{2d20}
@deffn {Función} logging.config.stopListening ()

Detiene el servidor de escucha que se creó con una llamada a @ref{fe5,,listen()}. Esto normalmente se llama antes de llamar @code{join()} en el valor de retorno de @ref{fe5,,listen()}.
@end deffn

@node Consideraciones de seguridad,Esquema del diccionario de configuración,Funciones de configuración,logging config — Logging configuration
@anchor{library/logging config security-considerations}@anchor{2d22}
@subsubsection Consideraciones de seguridad


The logging configuration functionality tries to offer convenience, and in part this
is done by offering the ability to convert text in configuration files into Python
objects used in logging configuration - for example, as described in
@ref{2d23,,Objetos definidos por el usuario}. However, these same mechanisms (importing
callables from user-defined modules and calling them with parameters from the
configuration) could be used to invoke any code you like, and for this reason you
should treat configuration files from untrusted sources with `extreme caution' and
satisfy yourself that nothing bad can happen if you load them, before actually loading
them.

@node Esquema del diccionario de configuración,Formato de archivo de configuración,Consideraciones de seguridad,logging config — Logging configuration
@anchor{library/logging config configuration-dictionary-schema}@anchor{2d24}@anchor{library/logging config logging-config-dictschema}@anchor{2d1d}
@subsubsection Esquema del diccionario de configuración


La descripción de una configuración de registro requiere una lista de los diversos objetos para crear y las conexiones entre ellos; por ejemplo, puede crear un gestor llamado “consola” y luego decir que el registrador llamado “inicio” enviará sus mensajes al gestor “consola”. Estos objetos no se limitan a los proporcionados por el módulo @ref{87,,logging} porque podría escribir su propia clase de formateador o gestor. Los parámetros de estas clases también pueden necesitar incluir objetos externos como @code{sys.stderr}. La sintaxis para describir estos objetos y conexiones se define en @ref{2d25,,Conexiones de objeto} a continuación.

@menu
* Detalles del esquema del diccionario:: 
* Configuración incremental:: 
* Conexiones de objeto:: 
* Objetos definidos por el usuario:: 
* Handler configuration order:: 
* Acceso a objetos externos:: 
* Acceso a objetos internos:: 
* Resolución de importación e importadores personalizados:: 
* Configuring QueueHandler and QueueListener:: 

@end menu

@node Detalles del esquema del diccionario,Configuración incremental,,Esquema del diccionario de configuración
@anchor{library/logging config dictionary-schema-details}@anchor{2d26}
@subsubsection Detalles del esquema del diccionario


El diccionario pasado a @ref{121e,,dictConfig()} debe contener las siguientes claves:


@itemize *

@item 
`version' - se establece en un valor entero que representa la versión del esquema. El único valor válido en este momento es 1, pero tener esta clave permite que el esquema evolucione sin perder la compatibilidad con versiones anteriores.
@end itemize

Todas las demás claves son opcionales, pero si están presentes se interpretarán como se describe a continuación. En todos los casos a continuación, donde se menciona un “dict de configuración”, se verificará la clave especial @code{'()'} para ver si se requiere una instanciación personalizada. Si es así, el mecanismo descrito en @ref{2d23,,Objetos definidos por el usuario} a continuación se usa para crear una instancia; de lo contrario, el contexto se usa para determinar qué instanciar.
@anchor{library/logging config logging-config-dictschema-formatters}@anchor{2d27}

@itemize *

@item 
`formatters' - el valor correspondiente será un diccionario en el que cada clave es una identificación de formateador y cada valor es un diccionario que describe cómo configurar la instancia correspondiente @ref{14d1,,Formatter}.

Se busca el diccionario de configuración por las siguientes claves opcionales que corresponden a los argumentos pasados para crear un objeto @ref{14d1,,Formatter}:


@itemize *

@item 
@code{format}

@item 
@code{datefmt}

@item 
@code{style}

@item 
@code{validate} (desde la versión >=3.8)

@item 
@code{defaults} (since version >=3.12)
@end itemize

Una clave opcional @code{class} indica el nombre de la de clase del formateador (como un módulo punteado y nombre de clase).  Por su parte los argumentos de instanciación son @ref{14d1,,Formatter}, de este modo esta clave es más útil para instanciar una subclase personalizada de @ref{14d1,,Formatter}.  Por ejemplo, la clase alternativa presentaría excepciones rastreadas en un formato amplio o resumido.  Si tu formateador necesita claves de configuración diferentes o extra debes usar @ref{2d23,,Objetos definidos por el usuario}.

@item 
`filters' - el valor correspondiente será un diccionario en el que cada clave es una identificación de filtro y cada valor es un diccionario que describe cómo configurar la instancia de filtro correspondiente.

El diccionario de configuración busca la clave @code{name} (por defecto en la cadena vacía) y esto se utiliza para construir una instancia de @ref{1268,,logging.Filter}.

@item 
`handlers' - el valor correspondiente será un diccionario en el que cada clave es una identificación de gestor y cada valor es un diccionario que describe cómo configurar la instancia del gestor correspondiente.

El diccionario de configuración busca las siguientes claves:


@itemize *

@item 
@code{clase} (obligatorio).  Este es el nombre completo de la clase de gestor.

@item 
@code{level} (opcional).  El nivel del gestor.

@item 
@code{formatter} (opcional).  La identificación del formateador para este gestor.

@item 
@code{filters} (opcional).  Una lista de identificadores de los filtros para este gestor.


Distinto en la versión 3.11: @code{filters} can take filter instances in addition to ids.

@end itemize

Todas las claves `other' se pasan como argumentos de palabras clave al constructor del gestor. Por ejemplo, dado el fragmento:

@example
handlers:
  console:
    class : logging.StreamHandler
    formatter: brief
    level   : INFO
    filters: [allow_foo]
    stream  : ext://sys.stdout
  file:
    class : logging.handlers.RotatingFileHandler
    formatter: precise
    filename: logconfig.log
    maxBytes: 1024
    backupCount: 3
@end example

el gestor con id @code{console} se instancia como @ref{1265,,logging.StreamHandler}, usando @code{sys.stdout} como la secuencia subyacente.  El gestor con la identificación @code{file} se instancia como @ref{15d9,,logging.handlers.RotatingFileHandler} con los argumentos de la palabra clave @code{filename='logconfig.log', maxBytes=1024, backupCount=3}.

@item 
`loggers' - el valor correspondiente será un diccionario en el que cada clave es un nombre de `logger' y cada valor es un diccionario que describe cómo configurar la instancia de `Logger' correspondiente.

El diccionario de configuración busca las siguientes claves:


@itemize *

@item 
@code{level} (opcional). El nivel del registrador.

@item 
@code{propagate} (opcional).  La configuración de propagación del registrador.

@item 
@code{filters} (opcional). Una lista de identificadores de los filtros para este registrador.


Distinto en la versión 3.11: @code{filters} can take filter instances in addition to ids.


@item 
@code{handlers} (opcional).  Una lista de identificadores de los gestores para este registrador.
@end itemize

Los registradores especificados se configurarán de acuerdo con el nivel, la propagación, los filtros y los gestores especificados.

@item 
`root' - Esta será la configuración para el registrador raíz. El procesamiento de la configuración será como para cualquier registrador, excepto que la configuración de @code{propagate} no será aplicable.

@item 
`incremental' - si la configuración debe interpretarse como incremental a la configuración existente. Este valor predeterminado es @code{False}, lo que significa que la configuración especificada reemplaza la configuración existente con la misma semántica que la utilizada por la API existente @ref{bd9,,fileConfig()}.

Si el valor especificado es @code{True}, la configuración se procesa como se describe en la sección sobre @ref{2d28,,Configuración incremental}.

@item 
`disable_existing_loggers' - si se debe deshabilitar cualquier registrador que no sea raíz existente. Esta configuración refleja el parámetro del mismo nombre en @ref{bd9,,fileConfig()}. Si está ausente, este parámetro tiene el valor predeterminado @code{True}. Este valor se ignora si `incremental' es @code{True}.
@end itemize

@node Configuración incremental,Conexiones de objeto,Detalles del esquema del diccionario,Esquema del diccionario de configuración
@anchor{library/logging config incremental-configuration}@anchor{2d29}@anchor{library/logging config logging-config-dict-incremental}@anchor{2d28}
@subsubsection Configuración incremental


Es difícil proporcionar flexibilidad completa para la configuración incremental. Por ejemplo, debido a que los objetos como los filtros y formateadores son anónimos, una vez que se configura una configuración, no es posible hacer referencia a dichos objetos anónimos al aumentar una configuración.

Además, no hay un caso convincente para alterar arbitrariamente el gráfico de objetos de registradores, gestores, filtros, formateadores en tiempo de ejecución, una vez que se configura una configuración; la verbosidad de los registradores y gestores se puede controlar simplemente estableciendo niveles (y, en el caso de los registradores, flags de propagación). Cambiar el gráfico de objetos de manera arbitraria y segura es problemático en un entorno de subprocesos múltiples; Si bien no es imposible, los beneficios no valen la complejidad que agrega a la implementación.

Por lo tanto, cuando la tecla @code{incremental} de un diccionario de configuración está presente y es @code{True}, el sistema ignorará por completo cualquier entrada de @code{formatters} y @code{filters}, y procesará solo el @code{level} configuraciones en las entradas de @code{handlers}, y las configuraciones de @code{level} y @code{propagate} en las entradas de @code{loggers} y @code{root}.

El uso de un valor en la configuración diccionario permite que las configuraciones se envíen a través del cable como dictados en vinagre a un escucha de socket. Por lo tanto, la verbosidad de registro de una aplicación de larga ejecución puede modificarse con el tiempo sin necesidad de detener y reiniciar la aplicación.

@node Conexiones de objeto,Objetos definidos por el usuario,Configuración incremental,Esquema del diccionario de configuración
@anchor{library/logging config logging-config-dict-connections}@anchor{2d25}@anchor{library/logging config object-connections}@anchor{2d2a}
@subsubsection Conexiones de objeto


El esquema describe un conjunto de objetos de registro (registradores, gestores, formateadores, filtros) que están conectados entre sí en un gráfico de objetos. Por lo tanto, el esquema necesita representar conexiones entre los objetos. Por ejemplo, supongamos que, una vez configurado, un registrador particular le ha adjuntado un gestor particular. A los fines de esta discusión, podemos decir que el registrador representa la fuente y el gestor el destino de una conexión entre los dos. Por supuesto, en los objetos configurados esto está representado por el registrador que tiene una referencia al gestor. En la configuración dict, esto se hace dando a cada objeto de destino una identificación que lo identifica inequívocamente, y luego utilizando la identificación en la configuración del objeto de origen para indicar que existe una conexión entre el origen y el objeto de destino con esa identificación.

Entonces, por ejemplo, considere el siguiente fragmento de YAML:

@example
formatters:
  brief:
    # configuration for formatter with id 'brief' goes here
  precise:
    # configuration for formatter with id 'precise' goes here
handlers:
  h1: #This is an id
   # configuration of handler with id 'h1' goes here
   formatter: brief
  h2: #This is another id
   # configuration of handler with id 'h2' goes here
   formatter: precise
loggers:
  foo.bar.baz:
    # other configuration for logger 'foo.bar.baz'
    handlers: [h1, h2]
@end example

(Nota: YAML se usa aquí porque es un poco más legible que el formulario fuente Python equivalente para el diccionario.)

Los identificadores para los registradores son los nombres de los registradores que se utilizarían mediante programación para obtener una referencia a esos registradores, por ejemplo @code{foo.bar.baz}.  Los identificadores para Formateadores y Filtros pueden ser cualquier valor de cadena (como @code{breve}, @code{preciso} arriba) y son transitorios, ya que solo son significativos para procesar el diccionario de configuración y se utilizan para determinar conexiones entre objetos , y no persisten en ninguna parte cuando se completa la llamada de configuración.

El fragmento anterior indica que el registrador llamado @code{foo.bar.baz} debe tener dos gestores adjuntos, que se describen mediante los identificadores de gestor @code{h1} y @code{h2}. El formateador para @code{h1} es el descrito por identificador @code{brief}, y el formateador para @code{h2} es el descrito por identificador @code{precise}.

@node Objetos definidos por el usuario,Handler configuration order,Conexiones de objeto,Esquema del diccionario de configuración
@anchor{library/logging config logging-config-dict-userdef}@anchor{2d23}@anchor{library/logging config user-defined-objects}@anchor{2d2b}
@subsubsection Objetos definidos por el usuario


El esquema admite objetos definidos por el usuario para gestores, filtros y formateadores.  (Los registradores no necesitan tener diferentes tipos para diferentes instancias, por lo que no hay soporte en este esquema de configuración para las clases de registrador definidas por el usuario).

Los objetos a configurar son descritos por diccionarios que detallan su configuración. En algunos lugares, el sistema de registro podrá inferir del contexto cómo se va a instanciar un objeto, pero cuando se va a instanciar un objeto definido por el usuario, el sistema no sabrá cómo hacerlo. Con el fin de proporcionar una flexibilidad completa para la creación de instancias de objetos definidos por el usuario, el usuario debe proporcionar una “fábrica”, una llamada que se llama con un diccionario de configuración y que retorna el objeto instanciado. Esto se indica mediante una ruta de importación absoluta a la fábrica disponible bajo la tecla especial @code{'()'}. Aquí hay un ejemplo concreto:

@example
formatters:
  brief:
    format: '%(message)s'
  default:
    format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
  custom:
      (): my.package.customFormatterFactory
      bar: baz
      spam: 99.9
      answer: 42
@end example

El fragmento de YAML anterior define tres formateadores. El primero, con identificador @code{breve}, es una instancia estándar @ref{14d1,,logging.Formatter} con la cadena de formato especificada. El segundo, con identificador @code{predeterminado}, tiene un formato más largo y también define el formato de hora explícitamente, y dará como resultado @ref{14d1,,logging.Formatter} inicializado con esas dos cadenas de formato. En forma de fuente Python, los formateadores @code{breve} y @code{predeterminado} tienen sub-diccionarios de configuración:

@example
@{
  'format' : '%(message)s'
@}
@end example

y:

@example
@{
  'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',
  'datefmt' : '%Y-%m-%d %H:%M:%S'
@}
@end example

respectivamente, y como estos diccionarios no contienen la clave especial @code{'()'}, la instanciación se infiere del contexto: como resultado, se crean las instancias estándar @ref{14d1,,logging.Formatter}.  El sub-diccionario de configuración para el tercer formateador, con identificador @code{custom}, es:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42
@}
@end example

y esto contiene la clave especial @code{'()'}, lo que significa que se desea la creación de instancias definida por el usuario.  En este caso, se utilizará la llamada especificada de fábrica especificada. Si es una llamada real, se usará directamente; de lo contrario, si especifica una cadena (como en el ejemplo), la llamada real se ubicará utilizando mecanismos de importación normales. Se llamará al invocable con los elementos `restantes' en el sub-diccionario de configuración como argumentos de palabras clave.  En el ejemplo anterior, se supondrá que el formateador con identificador @code{custom} será retornado por la llamada:

@example
my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
@end example

@cartouche
@quotation Advertencia 
The values for keys such as @code{bar}, @code{spam} and @code{answer} in
the above example should not be configuration dictionaries or references such
as @code{cfg://foo} or @code{ext://bar}, because they will not be processed by the
configuration machinery, but passed to the callable as-is.
@end quotation
@end cartouche

La clave @code{'()'} se ha utilizado como clave especial porque no es un nombre de parámetro de palabra clave válido, por lo que no entrará en conflicto con los nombres de los argumentos de palabras clave utilizados en la llamada. El @code{'()'} también sirve como mnemónico de que el valor correspondiente es invocable.


Distinto en la versión 3.11: Los miembros @code{filter} de @code{handlers} y @code{loggers} pueden tomar instancias de filtro en adición a identificadores.


Puedes especificar también una clave especial @code{'.'} cuyo valor es un diccionario, con un mapeo de los nombres de atributo y sus valores. Si se encuentran, los atributos especificados serán configurados en el objeto definido por el usuario antes de ser retornado. En consecuencia, con la configuración siguiente:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42,
  '.' @{
    'foo': 'bar',
    'baz': 'bozz'
  @}
@}
@end example

el formateador retornado tendrá el atributo @code{foo} establecido en @code{'bar'} y el atributo @code{baz} establecido en @code{'bozz'}.

@cartouche
@quotation Advertencia 
The values for attributes such as @code{foo} and @code{baz} in
the above example should not be configuration dictionaries or references such
as @code{cfg://foo} or @code{ext://bar}, because they will not be processed by the
configuration machinery, but set as attribute values as-is.
@end quotation
@end cartouche

@node Handler configuration order,Acceso a objetos externos,Objetos definidos por el usuario,Esquema del diccionario de configuración
@anchor{library/logging config handler-config-dict-order}@anchor{2d2c}@anchor{library/logging config handler-configuration-order}@anchor{2d2d}
@subsubsection Handler configuration order


Handlers are configured in alphabetical order of their keys, and a configured
handler replaces the configuration dictionary in (a working copy of) the
@code{handlers} dictionary in the schema. If you use a construct such as
@code{cfg://handlers.foo}, then initially @code{handlers['foo']} points to the
configuration dictionary for the handler named @code{foo}, and later (once that
handler has been configured) it points to the configured handler instance.
Thus, @code{cfg://handlers.foo} could resolve to either a dictionary or a handler
instance. In general, it is wise to name handlers in a way such that dependent
handlers are configured _after_ any handlers they depend on; that allows
something like @code{cfg://handlers.foo} to be used in configuring a handler that
depends on handler @code{foo}. If that dependent handler were named @code{bar},
problems would result, because the configuration of @code{bar} would be attempted
before that of @code{foo}, and @code{foo} would not yet have been configured.
However, if the dependent handler were named @code{foobar}, it would be configured
after @code{foo}, with the result that @code{cfg://handlers.foo} would resolve to
configured handler @code{foo}, and not its configuration dictionary.

@node Acceso a objetos externos,Acceso a objetos internos,Handler configuration order,Esquema del diccionario de configuración
@anchor{library/logging config access-to-external-objects}@anchor{2d2e}@anchor{library/logging config logging-config-dict-externalobj}@anchor{2d2f}
@subsubsection Acceso a objetos externos


Hay momentos en que una configuración debe referirse a objetos externos a la configuración, por ejemplo, @code{sys.stderr}. Si el diccionario de configuración se construye utilizando el código Python, esto es sencillo, pero surge un problema cuando la configuración se proporciona a través de un archivo de texto (por ejemplo, JSON, YAML). En un archivo de texto, no hay una forma estándar de distinguir @code{sys.stderr} de la cadena literal @code{'sys.stderr'}. Para facilitar esta distinción, el sistema de configuración busca ciertos prefijos especiales en valores de cadena y los trata especialmente. Por ejemplo, si la cadena literal @code{'ext://sys.stderr'} se proporciona como un valor en la configuración, entonces la @code{ext://} se eliminará y se procesará el resto del valor utilizando mecanismos normales de importación.

El manejo de dichos prefijos se realiza de manera análoga al manejo del protocolo: existe un mecanismo genérico para buscar prefijos que coincidan con la expresión regular @code{^(?P<prefix>[a-z]+)://(?P<suffix>.*)$} por el cual, si se reconoce el @code{prefix}, el @code{suffix} se procesa de manera dependiente del prefijo y el resultado del procesamiento reemplaza el valor de la cadena. Si no se reconoce el prefijo, el valor de la cadena se dejará tal cual.

@node Acceso a objetos internos,Resolución de importación e importadores personalizados,Acceso a objetos externos,Esquema del diccionario de configuración
@anchor{library/logging config access-to-internal-objects}@anchor{2d30}@anchor{library/logging config logging-config-dict-internalobj}@anchor{2d31}
@subsubsection Acceso a objetos internos


Además de los objetos externos, a veces también es necesario hacer referencia a los objetos en la configuración. El sistema de configuración hará esto implícitamente para las cosas que conoce. Por ejemplo, el valor de cadena @code{'DEBUG'} para un @code{level} en un registrador o gestor se convertirá automáticamente al valor @code{logging.DEBUG}, y las entradas @code{handlers}, @code{filters} y @code{formatter} tomarán una identificación de objeto y se resuelven en el objeto de destino apropiado.

Sin embargo, se necesita un mecanismo más genérico para los objetos definidos por el usuario que no conoce el módulo @ref{87,,logging}.  Por ejemplo, considere @ref{2d32,,logging.handlers.MemoryHandler}, que toma un argumento @code{target} que es otro gestor para delegar. Dado que el sistema ya conoce esta clase, entonces en la configuración, el @code{target} dado solo necesita ser la identificación del objeto del gestor de destino relevante, y el sistema resolverá el gestor desde la identificación.  Sin embargo, si un usuario define un @code{my.package.MyHandler} que tiene un gestor @code{alternate}, el sistema de configuración no sabría que el @code{alternate} se refería a un gestor.  Para atender esto, un sistema de resolución genérico permite al usuario especificar:

@example
handlers:
  file:
    # configuration of file handler goes here

  custom:
    (): my.package.MyHandler
    alternate: cfg://handlers.file
@end example

La cadena literal @code{'cfg://handlers.file'} se resolverá de manera análoga a las cadenas con el prefijo @code{ext://}, pero buscando en la configuración misma en lugar del espacio de nombres de importación. El mecanismo permite el acceso por punto o por índice, de manera similar a la proporcionada por @code{str.format}. Por lo tanto, dado el siguiente fragmento:

@example
handlers:
  email:
    class: logging.handlers.SMTPHandler
    mailhost: localhost
    fromaddr: my_app@@domain.tld
    toaddrs:
      - support_team@@domain.tld
      - dev_team@@domain.tld
    subject: Houston, we have a problem.
@end example

in the configuration, the string @code{'cfg://handlers'} would resolve to
the dict with key @code{handlers}, the string @code{'cfg://handlers.email}
would resolve to the dict with key @code{email} in the @code{handlers} dict,
and so on.  The string @code{'cfg://handlers.email.toaddrs[1]} would
resolve to @code{'dev_team@@domain.tld'} and the string
@code{'cfg://handlers.email.toaddrs[0]'} would resolve to the value
@code{'support_team@@domain.tld'}. The @code{subject} value could be accessed
using either @code{'cfg://handlers.email.subject'} or, equivalently,
@code{'cfg://handlers.email[subject]'}.  The latter form only needs to be
used if the key contains spaces or non-alphanumeric characters. Please note
that the characters @code{[} and @code{]} are not allowed in the keys. If an
index value consists only of decimal digits, access will be attempted
using the corresponding integer value, falling back to the string
value if needed.

Dada una cadena @code{cfg://handlers.myhandler.mykey.123}, esto se resolverá en @code{config_dict['handlers']['myhandler']['mykey']['123']}. Si la cadena se especifica como @code{cfg: //handlers.myhandler.mykey[123]}, el sistema intentará recuperar el valor de @code{config_dict['handlers']['myhandler']['mykey'][123]}, y vuelva a @code{config_dict['handlers']['myhandler']['mykey']['123']} si eso falla.

@node Resolución de importación e importadores personalizados,Configuring QueueHandler and QueueListener,Acceso a objetos internos,Esquema del diccionario de configuración
@anchor{library/logging config import-resolution-and-custom-importers}@anchor{2d33}@anchor{library/logging config logging-import-resolution}@anchor{2d34}
@subsubsection Resolución de importación e importadores personalizados


La resolución de importación, por defecto, utiliza la función incorporada @ref{96b,,__import__()} para importar. Es posible que desee reemplazar esto con su propio mecanismo de importación: si es así, puede reemplazar el atributo @code{importer} de @code{DictConfigurator} o su superclase, la clase @code{BaseConfigurator}. Sin embargo, debe tener cuidado debido a la forma en que se accede a las funciones desde las clases a través de descriptores. Si está utilizando un Python invocable para realizar sus importaciones, y lo desea definir a nivel de clase en lugar de a nivel de instancia, debe envolverlo con @ref{22e,,staticmethod()}. Por ejemplo:

@example
from importlib import import_module
from logging.config import BaseConfigurator

BaseConfigurator.importer = staticmethod(import_module)
@end example

No necesita envolver con @ref{22e,,staticmethod()} si está configurando la importación invocable en un configurador `instance'.

@node Configuring QueueHandler and QueueListener,,Resolución de importación e importadores personalizados,Esquema del diccionario de configuración
@anchor{library/logging config configure-queue}@anchor{15df}@anchor{library/logging config configuring-queuehandler-and-queuelistener}@anchor{2d35}
@subsubsection Configuring QueueHandler and QueueListener


If you want to configure a @ref{17de,,QueueHandler}, noting that this
is normally used in conjunction with a @ref{eb1,,QueueListener}, you
can configure both together. After the configuration, the @code{QueueListener} instance
will be available as the @ref{2d36,,listener} attribute of
the created handler, and that in turn will be available to you using
@ref{17df,,getHandlerByName()} and passing the name you have used for the
@code{QueueHandler} in your configuration. The dictionary schema for configuring the pair
is shown in the example YAML snippet below.

@example
handlers:
  qhand:
    class: logging.handlers.QueueHandler
    queue: my.module.queue_factory
    listener: my.package.CustomListener
    handlers:
      - hand_name_1
      - hand_name_2
      ...
@end example

The @code{queue} and @code{listener} keys are optional.

If the @code{queue} key is present, the corresponding value can be one of the following:


@itemize *

@item 
An object implementing the @ref{2d37,,Queue.put_nowait}
and @ref{2d38,,Queue.get} public API. For instance, this may be
an actual instance of @ref{13ee,,queue.Queue} or a subclass thereof, or a proxy
obtained by @ref{2d39,,multiprocessing.managers.SyncManager.Queue()}.

This is of course only possible if you are constructing or modifying
the configuration dictionary in code.

@item 
A string that resolves to a callable which, when called with no arguments, returns
the queue instance to use. That callable could be a @ref{13ee,,queue.Queue} subclass
or a function which returns a suitable queue instance,
such as @code{my.module.queue_factory()}.

@item 
A dict with a @code{'()'} key which is constructed in the usual way as discussed in
@ref{2d23,,Objetos definidos por el usuario}. The result of this construction should be a
@ref{13ee,,queue.Queue} instance.
@end itemize

If the  @code{queue} key is absent, a standard unbounded @ref{13ee,,queue.Queue} instance is
created and used.

If the @code{listener} key is present, the corresponding value can be one of the following:


@itemize *

@item 
A subclass of @ref{eb1,,logging.handlers.QueueListener}. This is of course only
possible if you are constructing or modifying the configuration dictionary in
code.

@item 
A string which resolves to a class which is a subclass of @code{QueueListener}, such as
@code{'my.package.CustomListener'}.

@item 
A dict with a @code{'()'} key which is constructed in the usual way as discussed in
@ref{2d23,,Objetos definidos por el usuario}. The result of this construction should be a
callable with the same signature as the @code{QueueListener} initializer.
@end itemize

If the @code{listener} key is absent, @ref{eb1,,logging.handlers.QueueListener} is used.

The values under the @code{handlers} key are the names of other handlers in the
configuration (not shown in the above snippet) which will be passed to the queue
listener.

Any custom queue handler and listener classes will need to be defined with the same
initialization signatures as @ref{17de,,QueueHandler} and
@ref{eb1,,QueueListener}.


Added in version 3.12.


@node Formato de archivo de configuración,,Esquema del diccionario de configuración,logging config — Logging configuration
@anchor{library/logging config configuration-file-format}@anchor{2d3a}@anchor{library/logging config logging-config-fileformat}@anchor{2d1e}
@subsubsection Formato de archivo de configuración


El formato del archivo de configuración que entiende @ref{bd9,,fileConfig()} se basa en la funcionalidad @ref{23,,configparser}. El archivo debe contener secciones llamadas @code{[loggers]}, @code{[handlers]} y @code{[formatters]} que identifican por nombre las entidades de cada tipo que se definen en el archivo. Para cada una de esas entidades, hay una sección separada que identifica cómo se configura esa entidad. Por lo tanto, para un registrador llamado @code{log01} en la sección @code{[loggers]}, los detalles de configuración relevantes se encuentran en una sección @code{[logger_log01]}. Del mismo modo, un gestor llamado @code{hand01} en la sección @code{[handlers]} tendrá su configuración en una sección llamada @code{[handler_hand01]}, mientras que un formateador llamado @code{form01} en el @code{[formatters]} sección tendrá su configuración especificada en una sección llamada @code{[formatter_form01]}. La configuración del registrador raíz debe especificarse en una sección llamada @code{[logger_root]}.

@cartouche
@quotation Nota 
La API @ref{bd9,,fileConfig()} es más antigua que la API @ref{121e,,dictConfig()} y no proporciona funcionalidad para cubrir ciertos aspectos del registro. Por ejemplo, no puede configurar objetos @ref{1268,,Filter}, que permiten el filtrado de mensajes más allá de niveles enteros simples, usando @ref{bd9,,fileConfig()}. Si necesita tener instancias de @ref{1268,,Filter} en su configuración de registro, deberá usar @ref{121e,,dictConfig()}. Tenga en cuenta que las mejoras futuras a la funcionalidad de configuración se agregarán a @ref{121e,,dictConfig()}, por lo que vale la pena considerar la transición a esta API más nueva cuando sea conveniente hacerlo.
@end quotation
@end cartouche

A continuación se dan ejemplos de estas secciones en el archivo.

@example
[loggers]
keys=root,log02,log03,log04,log05,log06,log07

[handlers]
keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09

[formatters]
keys=form01,form02,form03,form04,form05,form06,form07,form08,form09
@end example

El registrador raíz debe especificar un nivel y una lista de gestores. A continuación se muestra un ejemplo de una sección de registrador raíz.

@example
[logger_root]
level=NOTSET
handlers=hand01
@end example

La entrada @code{level} puede ser una de @code{DEBUG, INFO, WARNING, ERROR, CRITICAL} o @code{NOTSET}. Solo para el registrador raíz, @code{NOTSET} significa que todos los mensajes se registrarán. Los valores de nivel son @code{evaluados} en el contexto del espacio de nombres del paquete @code{logging}.

La entrada @code{handlers} es una lista separada por comas de nombres de gestores, que debe aparecer en la sección @code{[handlers]}. Estos nombres deben aparecer en la sección @code{[handlers]} y tener las secciones correspondientes en el archivo de configuración.

Para los registradores que no sean el registrador raíz, se requiere información adicional. Esto se ilustra en el siguiente ejemplo.

@example
[logger_parser]
level=DEBUG
handlers=hand01
propagate=1
qualname=compiler.parser
@end example

Las entradas @code{level} y @code{handlers} se interpretan como para el registrador raíz, excepto que si el nivel de un registrador que no sea raíz se especifica como @code{NOTSET}, el sistema consulta a los registradores más arriba en la jerarquía para determinar el nivel efectivo del registrador. La entrada @code{propagate} se establece en 1 para indicar que los mensajes deben propagarse a los gestores que están más arriba en la jerarquía del registrador, o 0 para indicar que los mensajes `no' se propagan a los gestores en la jerarquía superior. La entrada @code{qualname} es el nombre jerárquico del canal del registrador, es decir, el nombre utilizado por la aplicación para obtener el registrador.

Las secciones que especifican la configuración del gestor se ejemplifican a continuación.

@example
[handler_hand01]
class=StreamHandler
level=NOTSET
formatter=form01
args=(sys.stdout,)
@end example

La entrada @code{class} indica la clase del gestor (según lo determinado por @ref{2eb,,eval()} en el espacio de nombres del paquete @code{logging}). El @code{level} se interpreta como para los registradores, y @code{NOTSET} se entiende como “registrar todo”.

La entrada @code{formatter} indica el nombre clave del formateador para este gestor. Si está en blanco, se utiliza un formateador predeterminado (@code{logging._defaultFormatter}). Si se especifica un nombre, debe aparecer en la sección @code{[formatters]} y tener una sección correspondiente en el archivo de configuración.

La entrada @code{args}, cuando es @code{evaluada} en el contexto del espacio de nombres del paquete @code{logging}, es la lista de argumentos para el constructor de la clase gestor. Consulte los constructores de los gestores relevantes, o los ejemplos a continuación, para ver cómo se construyen las entradas típicas. Si no se proporciona, el valor predeterminado es @code{()}.

La entrada opcional @code{kwargs}, cuando es @code{evaluada} en el contexto del espacio de nombres del paquete @code{logging}, es el diccionario generado a partir de los argumentos de palabra clave  para el constructor de la clase gestor. Si no se proporciona, el valor predeterminado es @code{@{@}}.

@example
[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form02
args=('python.log', 'w')

[handler_hand03]
class=handlers.SocketHandler
level=INFO
formatter=form03
args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT)

[handler_hand04]
class=handlers.DatagramHandler
level=WARN
formatter=form04
args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT)

[handler_hand05]
class=handlers.SysLogHandler
level=ERROR
formatter=form05
args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER)

[handler_hand06]
class=handlers.NTEventLogHandler
level=CRITICAL
formatter=form06
args=('Python Application', '@w{'}, 'Application')

[handler_hand07]
class=handlers.SMTPHandler
level=WARN
formatter=form07
args=('localhost', 'from@@abc', ['user1@@abc', 'user2@@xyz'], 'Logger Subject')
kwargs=@{'timeout': 10.0@}

[handler_hand08]
class=handlers.MemoryHandler
level=NOTSET
formatter=form08
target=
args=(10, ERROR)

[handler_hand09]
class=handlers.HTTPHandler
level=NOTSET
formatter=form09
args=('localhost:9022', '/log', 'GET')
kwargs=@{'secure': True@}
@end example

Las secciones que especifican la configuración del formateador se caracterizan por lo siguiente.

@example
[formatter_form01]
format=F1 %(asctime)s %(levelname)s %(message)s %(customfield)s
datefmt=
style=%
validate=True
defaults=@{'customfield': 'defaultvalue'@}
class=logging.Formatter
@end example

Los argumentos para la configuración del formateador son los mismos que las claves en el esquema del diccionario @ref{2d27,,formatters section}.

The @code{defaults} entry, when @ref{216d,,evaluated} in the context of
the @code{logging} package’s namespace, is a dictionary of default values for
custom formatting fields. If not provided, it defaults to @code{None}.

@cartouche
@quotation Nota 
Debido al uso de @ref{2eb,,eval()} como se describió anteriormente, existen riesgos potenciales de seguridad que resultan del uso de @ref{fe5,,listen()} para enviar y recibir configuraciones a través de sockets. Los riesgos se limitan a donde múltiples usuarios sin confianza mutua ejecutan código en la misma máquina; consulte la documentación de @ref{fe5,,listen()} para obtener más información.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item Módulo @ref{87,,logging}

Referencia de API para el módulo de registro.

@item Módulo @ref{89,,logging.handlers}

Gestores útiles incluidos con el módulo de registro.
@end table


@node logging handlers — Logging handlers,getpass — Portable password input,logging config — Logging configuration,Servicios genéricos del sistema operativo
@anchor{library/logging handlers doc}@anchor{2d3b}@anchor{library/logging handlers logging-handlers-logging-handlers}@anchor{2d3c}@anchor{library/logging handlers module-logging handlers}@anchor{89}
@subsection @code{logging.handlers} — Logging handlers


@geindex module; logging.handlers

`Código fuente' Lib/logging/handlers.py@footnote{https://github.com/python/cpython/tree/main/Lib/logging/handlers.py}

@subsubheading Important



Esta página contiene solo información de referencia. Para tutoriales por favor véase


@itemize *

@item 
@ref{1262,,Tutorial Básico}

@item 
@ref{1263,,Tutorial avanzado}

@item 
@ref{1264,,Libro de cocina de *Logging*}
@end itemize


__________________________________________________________________


Estos gestores son muy útiles y están provistos en este paquete. Nota que tres de los gestores de las clases (@ref{1265,,StreamHandler}, @ref{18a7,,FileHandler} and @ref{12f1,,NullHandler}) están definidos en propio módulo @ref{87,,logging} pero fueron documentados aquí junto con los otros gestores.

@menu
* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* Gestor SysLog (SysLogHandler): Gestor SysLog SysLogHandler. 
* Gestor de eventos NTELog (NTEventLogHandler): Gestor de eventos NTELog NTEventLogHandler. 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

@end menu

@node StreamHandler,FileHandler,,logging handlers — Logging handlers
@anchor{library/logging handlers stream-handler}@anchor{2d3d}@anchor{library/logging handlers streamhandler}@anchor{2d3e}
@subsubsection StreamHandler


La clase @ref{1265,,StreamHandler} ubicada en el paquete núcleo @ref{87,,logging} envía la salida del `logging' a un `stream' como `sys.stdout', `sys.stderr' o cualquier objeto tipo archivo (o mas precisamente cualquier objeto que soporte los métodos @code{write()} y @code{flush()}).

@geindex StreamHandler (clase en logging)
@anchor{library/logging handlers logging StreamHandler}@anchor{1265}
@deffn {Clase} logging.StreamHandler (stream=None)

Retorna una nueva instancia de la clase @ref{1265,,StreamHandler}. Si `stream' esta especificado, la instancia lo usará para la salida del registro, sino se usará `sys.stderr'.

@geindex emit() (método de logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler emit}@anchor{2d3f}
@deffn {Método} emit (record)

Si se especifica un formateador, se utiliza para formatear el registro. Luego, el registro se escribe en el flujo seguido de @ref{2d40,,terminator}. Si hay información de excepción, se formatea con @ref{8e6,,traceback.print_exception()} y se agrega al flujo.
@end deffn

@geindex flush() (método de logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler flush}@anchor{2d41}
@deffn {Método} flush ()

Descarga el `stream' llamando a su método @ref{2d41,,flush()}. Nota que el método @code{close()} es heredado de la clase @ref{14d0,,Handler} y por lo tanto no produce ninguna salida. Por eso muchas veces será necesario invocar al método explícito @ref{2d41,,flush()}.
@end deffn

@geindex setStream() (método de logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler setStream}@anchor{bd8}
@deffn {Método} setStream (stream)

Establece el `stream' de la instancia a un valor especifico, si este es diferente. El anterior `stream' es vaciado antes de que el nuevo `stream' sea establecido.

@*Parámetros: 
@code{stream} – El `stream' que el gestor debe usar.


@*Devuelve: 
the old stream, if the stream was changed, or @code{None} if it wasn’t.



Added in version 3.7.

@end deffn

@geindex terminator (atributo de logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler terminator}@anchor{2d40}
@deffn {Atributo} terminator

Cadena utilizada como terminador al escribir un registro formateado en un flujo. El valor por defecto es @code{'\n'}.

Si no quieres una terminación de nueva línea, puedes establecer el atributo @code{terminator} de la instancia del manejador a la cadena vacía.

En versiones anteriores, el terminador estaba codificado como @code{'\n'}.


Added in version 3.2.

@end deffn
@end deffn

@node FileHandler,NullHandler,StreamHandler,logging handlers — Logging handlers
@anchor{library/logging handlers file-handler}@anchor{2d42}@anchor{library/logging handlers filehandler}@anchor{2d43}
@subsubsection FileHandler


La clase @ref{18a7,,FileHandler} está localizada en el paquete núcleo @ref{87,,logging}, envía la salida del `logging' a un archivo de disco. Hereda la funcionalidad de salida de la clase @ref{1265,,StreamHandler}.

@geindex FileHandler (clase en logging)
@anchor{library/logging handlers logging FileHandler}@anchor{18a7}
@deffn {Clase} logging.FileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

Retorna una nueva instancia de la clase @ref{18a7,,FileHandler}. El archivo especificado se abre y se utiliza como flujo para el registro. Si no se especifica `mode', se utiliza @code{'a'}. Si `encoding' no es @code{None}, se utiliza para abrir el archivo con esa codificación. Si `delay' es verdadero, la apertura del archivo se pospone hasta la primera llamada a @ref{2d44,,emit()}. Por defecto, el archivo crece de manera indefinida. Si se especifica `errors', se usa para determinar cómo se manejan los errores de codificación.


Distinto en la versión 3.6: Así como valores de cadena de caracteres, también se aceptan objetos de la clase @ref{19b,,Path} para el argumento «`filename'».



Distinto en la versión 3.9: Se agregó el parámetro `errors'.


@geindex close() (método de logging.FileHandler)
@anchor{library/logging handlers logging FileHandler close}@anchor{2d45}
@deffn {Método} close ()

Cierra el archivo.
@end deffn

@geindex emit() (método de logging.FileHandler)
@anchor{library/logging handlers logging FileHandler emit}@anchor{2d44}
@deffn {Método} emit (record)

Da la salida del registro al archivo.

Ten en cuenta que si el archivo se cerró debido al apagado del registro al salir y el modo de archivo es “w”, el registro no se emitirá (consulta bpo-42378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42378}).
@end deffn
@end deffn

@node NullHandler,WatchedFileHandler,FileHandler,logging handlers — Logging handlers
@anchor{library/logging handlers null-handler}@anchor{2d46}@anchor{library/logging handlers nullhandler}@anchor{2d47}
@subsubsection NullHandler



Added in version 3.1.


La clase @ref{12f1,,NullHandler} está ubicada en el núcleo biblioteca @ref{87,,logging} . No realiza ningún formateo o salida. Es en esencia un gestor “no-op” para uso de desarrolladores de bibliotecas.

@geindex NullHandler (clase en logging)
@anchor{library/logging handlers logging NullHandler}@anchor{12f1}
@deffn {Clase} logging.NullHandler

Retorna una nueva instancia de la clase @ref{12f1,,NullHandler}.

@geindex emit() (método de logging.NullHandler)
@anchor{library/logging handlers logging NullHandler emit}@anchor{2d48}
@deffn {Método} emit (record)

Este método no realiza ninguna acción.
@end deffn

@geindex handle() (método de logging.NullHandler)
@anchor{library/logging handlers logging NullHandler handle}@anchor{2d49}
@deffn {Método} handle (record)

Este método no realiza ninguna acción.
@end deffn

@geindex createLock() (método de logging.NullHandler)
@anchor{library/logging handlers logging NullHandler createLock}@anchor{2d4a}
@deffn {Método} createLock ()

Este método retorna @code{None} para el bloqueo , dado que no hay una E/S subyacente cuyo acceso se necesite serializar.
@end deffn
@end deffn

Véase @ref{2d4b,,Configurando Logging para una biblioteca} para mas información en como usar la clase @ref{12f1,,NullHandler}.

@node WatchedFileHandler,BaseRotatingHandler,NullHandler,logging handlers — Logging handlers
@anchor{library/logging handlers watched-file-handler}@anchor{2d4c}@anchor{library/logging handlers watchedfilehandler}@anchor{2d4d}
@subsubsection WatchedFileHandler


La clase @ref{2d4e,,WatchedFileHandler} está ubicada en el módulo @ref{89,,logging.handlers}, es una clase @code{FileHandler} que vigila a que archivo se está enviando el `logging'. Si el archivo cambia , este se cerrará y se volverá a abrir usando el nombre de archivo.

Puede suceder que haya un cambio de archivo por uso de programas como `newsyslog' y `logrotate' que realizan una rotación del archivo log. Este gestor destinado para uso bajo Unix/Linux controla el archivo para ver si hubo cambios desde la última emisión. (Un archivo se considera que cambió si su dispositivo o nodo índice cambió). Si el archivo cambió entonces el anterior `stream' de archivo se cerrará, y se abrirá el nuevo para obtener un nuevo `stream'.

Este gestor no es apropiado para uso bajo Windows porque bajo Windows los archivos log abiertos no se pueden mover o renombrar. `Logging' abre los archivos con bloqueos exclusivos y entonces no hay necesidad de usar el gestor. Por otra parte `ST_INO' no es soportado bajo Windows. La función @ref{548,,stat()} siempre retorna cero para este valor.

@geindex WatchedFileHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers WatchedFileHandler}@anchor{2d4e}
@deffn {Clase} logging.handlers.WatchedFileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

Retorna una nueva instancia de la clase @ref{2d4e,,WatchedFileHandler}. El archivo especificado se abre y se utiliza como flujo para el registro. Si no se especifica `mode', se utiliza @code{'a'}. Si `encoding' no es @code{None}, se utiliza para abrir el archivo con esa codificación. Si `delay' es verdadero, la apertura del archivo se pospone hasta la primera llamada a @ref{2d4f,,emit()}. Por defecto, el archivo crece de manera indefinida. Si se proporciona `errors', determina cómo se manejan los errores de codificación.


Distinto en la versión 3.6: Así como valores de cadena de caracteres, también se aceptan objetos de la clase @ref{19b,,Path} para el argumento «`filename'».



Distinto en la versión 3.9: Se agregó el parámetro `errors'.


@geindex reopenIfNeeded() (método de logging.handlers.WatchedFileHandler)
@anchor{library/logging handlers logging handlers WatchedFileHandler reopenIfNeeded}@anchor{d3f}
@deffn {Método} reopenIfNeeded ()

Revisa si el archivo cambió. Si hubo cambio, el `stream' existente se vacía y cierra y el archivo se abre nuevamente. Típicamente es un precursor para dar salida del registro a un archivo.


Added in version 3.6.

@end deffn

@geindex emit() (método de logging.handlers.WatchedFileHandler)
@anchor{library/logging handlers logging handlers WatchedFileHandler emit}@anchor{2d4f}
@deffn {Método} emit (record)

Da salida al registro a un archivo, pero primero invoca al método @ref{d3f,,reopenIfNeeded()} para reabrir el archivo si es que cambió.
@end deffn
@end deffn

@node BaseRotatingHandler,RotatingFileHandler,WatchedFileHandler,logging handlers — Logging handlers
@anchor{library/logging handlers base-rotating-handler}@anchor{2d50}@anchor{library/logging handlers baserotatinghandler}@anchor{2d51}
@subsubsection BaseRotatingHandler


La clase @ref{2d52,,BaseRotatingHandler} ubicada en el módulo @ref{89,,logging.handlers} es la clase base para rotar los gestores de archivos de clases @ref{15d9,,RotatingFileHandler} y @ref{fe1,,TimedRotatingFileHandler}. No debería ser necesario instanciar esta clase, pero tiene métodos y atributos que quizá se necesiten sobrescribir (`override').

@geindex BaseRotatingHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers BaseRotatingHandler}@anchor{2d52}
@deffn {Clase} logging.handlers.BaseRotatingHandler (filename, mode, encoding=None, delay=False, errors=None)

Los parámetros son como los de la clase @code{FileHandler}. Los atributos son:

@geindex namer (atributo de logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler namer}@anchor{2d53}
@deffn {Atributo} namer

Si este atributo se establece como invocable, el método @ref{2d54,,rotation_filename()} delega a este invocable. Los parámetros pasados al invocable son aquellos pasados al método @ref{2d54,,rotation_filename()}.

@cartouche
@quotation Nota 
La función de nombrado es invocada unas cuantas veces durante el volcado (`rollover') , entonces debe ser tan simple y rápida como sea posible. Debe también retornar siempre la misma salida para una misma entrada, de otra manera el volcado puede no funcionar como se espera.

También vale la pena señalar que se debe tener cuidado al usar un nombrador para conservar ciertos atributos en el nombre de archivo que se usan durante la rotación. Por ejemplo, @ref{15d9,,RotatingFileHandler} espera tener un conjunto de archivos de registro cuyos nombres contengan números enteros sucesivos, para que la rotación funcione como se espera, y @ref{fe1,,TimedRotatingFileHandler} elimina los archivos de registro antiguos (según el parámetro @code{backupCount} pasado al inicializador del controlador), determinando los archivos más antiguos para eliminar. Para que esto suceda, los nombres de los archivos deben poder ordenarse utilizando la parte de fecha/hora del nombre del archivo, y un nombrador debe respetar esto. (Si se desea un nombrador que no respete este esquema, deberá usarse en una subclase de @ref{fe1,,TimedRotatingFileHandler} que anula el método @ref{2d55,,getFilesToDelete()} para encajar con el esquema de denominación personalizada.)
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex rotator (atributo de logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotator}@anchor{2d56}
@deffn {Atributo} rotator

Si este atributo se estableció como invocable, el método @ref{2d57,,rotate()} delega a este invocable. Los parámetros pasados al invocable son aquellos pasados al método @ref{2d57,,rotate()}.


Added in version 3.3.

@end deffn

@geindex rotation_filename() (método de logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotation_filename}@anchor{2d54}
@deffn {Método} rotation_filename (default_name)

Modifica el nombre de un archivo log cuando esta rotando.

Esto esta previsto para que pueda usarse un nombre de archivo personalizado.

La implementación por defecto llama al atributo “namer” del gestor, si este es invocable, pasando el nombre por defecto a él. Si el atributo no es invocable (por defecto es @code{None}) el nombre se retorna sin cambios.

@*Parámetros: 
@code{default_name} – El nombre por defecto para el archivo de log.



Added in version 3.3.

@end deffn

@geindex rotate() (método de logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotate}@anchor{2d57}
@deffn {Método} rotate (source, dest)

Cuando está rotando, rotar el actual log.

La implementación por defecto llama al atributo “rotator” del gestor, si es invocable, pasando los argumentos de origen y destino a él. Si no se puede invocar (porque el atributo por defecto es “None”) el origen es simplemente renombrado al destino.

@*Parámetros: 

@itemize *

@item 
@code{source} – El nombre de archivo origen . Normalmente el nombre de archivo base, por ejemplo “test.log”.

@item 
@code{dest} – El nombre de archivo de destino. Normalmente es el nombre al que se rota el archivo origen por ejemplo “test.log.1”.
@end itemize



Added in version 3.3.

@end deffn
@end deffn

La razón de que existen los atributos es para evitar tener que usar una subclase - puedes usar los mismos invocadores para instancias de clase @ref{15d9,,RotatingFileHandler} y @ref{fe1,,TimedRotatingFileHandler}. Si el rotador invocable o la función de nombrado plantean una excepción esta se manejará de la misma manera que cualquier otra excepción durante una llamada al método @code{emit()} por ejemplo a través del método @code{handleError()} del gestor.

Si necesitas hacer cambios mas significativos al proceso de rotación puedes obviar los métodos.

Para un ejemplo véase @ref{2d58,,Usar un rotador y un nombre para personalizar el procesamiento de rotación de log}.

@node RotatingFileHandler,TimedRotatingFileHandler,BaseRotatingHandler,logging handlers — Logging handlers
@anchor{library/logging handlers rotating-file-handler}@anchor{2d59}@anchor{library/logging handlers rotatingfilehandler}@anchor{2d5a}
@subsubsection RotatingFileHandler


La clase @ref{15d9,,RotatingFileHandler}, localizada en el módulo @ref{89,,logging.handlers} soporta la rotación de archivos log de disco.

@geindex RotatingFileHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers RotatingFileHandler}@anchor{15d9}
@deffn {Clase} logging.handlers.RotatingFileHandler (filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False, errors=None)

Retorna una nueva instancia de la clase @ref{15d9,,RotatingFileHandler}. El archivo especificado se abre y se utiliza como flujo para el registro. Si no se especifica `mode', se utiliza @code{'a'}. Si `encoding' no es @code{None}, se utiliza para abrir el archivo con esa codificación. Si `delay' es verdadero, la apertura del archivo se aplaza hasta la primera llamada a @ref{2d5b,,emit()}. De forma predeterminada, el archivo crece indefinidamente. Si se proporciona `errors', determina cómo se manejan los errores de codificación.

Se pueden usar los valores `maxBytes' y `backupCount' para permitir que el archivo `rollover' tenga un tamaño predeterminado. Cuando el tamaño del archivo está a punto de excederse, se cerrará y un nuevo archivo se abrirá silenciosamente para salida. El volcado (`rollover') ocurre cada vez que el actual archivo log esta cerca de `maxBytes' en tamaño , pero si cualquiera `maxBytes' o `backupCount' es cero, el volcado (`rollover') no ocurre. Por eso generalmente necesitas establecer `backupCount' por lo menos en 1 y no tener cero en `maxBytes'. Cuando `backupCount' no es cero, el sistema guardará los anteriores archivos log agregando las extensiones “.1”, “.2” etc. al nombre del archivo. Por ejemplo con un `backupCount' de 5 y un nombre de archivo base de @code{app.log}, tendrás como nombre de archivo t @code{app.log}, @code{app.log.1}, @code{app.log.2}, hasta @code{app.log.5}. El archivo que esta siendo escrito es siempre @code{app.log}. Cuando este se completa , se cierra y se renombra a @code{app.log.1} y si ya existen @code{app.log.1}, @code{app.log.2}, etc. Entonces se renombrará como @code{app.log.2}, @code{app.log.3} etc. respectivamente.


Distinto en la versión 3.6: Así como valores de cadena de caracteres, también se aceptan objetos de la clase @ref{19b,,Path} para el argumento «`filename'».



Distinto en la versión 3.9: Se agregó el parámetro `errors'.


@geindex doRollover() (método de logging.handlers.RotatingFileHandler)
@anchor{library/logging handlers logging handlers RotatingFileHandler doRollover}@anchor{2d5c}
@deffn {Método} doRollover ()

Realiza un volcado (`rollover') como se describe arriba.
@end deffn

@geindex emit() (método de logging.handlers.RotatingFileHandler)
@anchor{library/logging handlers logging handlers RotatingFileHandler emit}@anchor{2d5b}
@deffn {Método} emit (record)

Da la salida del registro al archivo , dando suministro para el volcado (`rollover') como está descripto anteriormente.
@end deffn
@end deffn

@node TimedRotatingFileHandler,SocketHandler,RotatingFileHandler,logging handlers — Logging handlers
@anchor{library/logging handlers timed-rotating-file-handler}@anchor{2d5d}@anchor{library/logging handlers timedrotatingfilehandler}@anchor{2d5e}
@subsubsection TimedRotatingFileHandler


La clase @ref{fe1,,TimedRotatingFileHandler} está ubicada en el módulo @ref{89,,logging.handlers}. Soporta la rotación de archivos de log a ciertos intervalos de tiempo.

@geindex TimedRotatingFileHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler}@anchor{fe1}
@deffn {Clase} logging.handlers.TimedRotatingFileHandler (filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None, errors=None)

Retorna una nueva instancia de la clase @ref{fe1,,TimedRotatingFileHandler} . El archivo especificado es abierto y usado como `stream' para el historial de log. En la rotación también establece el sufijo del nombre de archivo. La rotación ocurre basada en el producto de `when' y `interval'.

Puedes usar el `when' para especificar el tipo de intervalo `interval'. La lista de posibles valores esta debajo. Nota que no distingue mayúsculas y minúsculas.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Tipo de intervalo

@tab

Si/como `atTime' es usado

@item

@code{'S'}

@tab

Segundos

@tab

Ignorado

@item

@code{'M'}

@tab

Minutos

@tab

Ignorado

@item

@code{'H'}

@tab

Horas

@tab

Ignorado

@item

@code{'D'}

@tab

Días

@tab

Ignorado

@item

@code{'W0'-'W6'}

@tab

Día de la semana (0=Lunes)

@tab

Usado para calcular la hora inicial del volcado `rollover'

@item

@code{'midnight'}

@tab

Volcado (`rollover') a medianoche , si `atTime' no está especificado, sino el volcado se hará `atTime'

@tab

Usado para calcular la hora inicial del volcado `rollover'

@end multitable


Cuando se usa rotación basada en día de la semana, especifica “W0” para Lunes, “W1” para Martes y así, hasta “W6” para Domingo. en este caso el valor pasado para `Interval' no se usa.

El sistema guardará los archivos de log anteriores agregándoles extensiones al nombre de archivo. Las extensiones están basadas en día-hora usando el formato @code{%Y-%m-%d_%H-%M-%S} o un prefijo respecto el intervalo del volcado (`rollover').

Cuando se calcula la hora del siguiente volcado (`rollover') por primera vez (cuando el gestor es creado), la última hora de modificación de un archivo log existente o sino la hora actual, se usa para calcular cuando será la próxima rotación.

Si el argumento `utc' es `true' se usará la hora en UTC, sino se usará la hora local.

Si `backupCount' no es cero, se conservará como máximo una cantidad de archivos especificada en `backupCount',y si son creados más, cuando ocurre el volcado (`rollover') se borrará el último. La lógica de borrado usa el intervalo para determinar que archivos borrar, pues entonces cambiando el intervalo puede dejar viejos archivos abandonados.

Si `delay' es `true' entonces la apertura del archivo se demorará hasta la primer llamada a @ref{2d5f,,emit()}.

Si `atTime' no es «None», debe haber una instancia @code{datetime.time} que especifica la hora que ocurre el volcado (`rollover') , para los casos en que el volcado esta establecido para ocurrir «a medianoche» o «un día en particular». Nótese que en estos casos el valor `atTime' se usa para calcular el valor `initial' del volcado (`rollover') y los subsecuentes volcados serán calculados a través del calculo normal de intervalos.

Si se especifica `errors', se utiliza para determinar cómo se manejan los errores de codificación.

@cartouche
@quotation Nota 
El cálculo de la hora en que se realizara el volcado (`rollover') inicial cuando se inicializa el gestor. El cálculo de la hora de los siguientes volcados (`rollovers') se realiza solo cuando este ocurre, y el volcado ocurre solo cuando se emite una salida. Si esto no se tiene en cuenta puede generar cierta confusión. Por ejemplo si se establece un intervalo de «cada minuto» eso no significa que siempre se verán archivos log con hora (en el nombre del archivo) separados por un minuto. Si durante la ejecución de la aplicación el `logging' se genera con mayor frecuencia que un minuto entonces se pueden esperar archivos log separados por un minuto. Si por otro lado los mensajes `logging' son establecidos cada digamos cinco minutos, entonces habrá brechas de tiempo en los archivos correspondientes a los minutos que no hubo salida (y no ocurrió por tanto volcado alguno).
@end quotation
@end cartouche


Distinto en la versión 3.4: Se agregó el parámetro `atTime'.



Distinto en la versión 3.6: Así como valores de cadena de caracteres, también se aceptan objetos de la clase @ref{19b,,Path} para el argumento «`filename'».



Distinto en la versión 3.9: Se agregó el parámetro `errors'.


@geindex doRollover() (método de logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler doRollover}@anchor{2d60}
@deffn {Método} doRollover ()

Realiza un volcado (`rollover') como se describe arriba.
@end deffn

@geindex emit() (método de logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler emit}@anchor{2d5f}
@deffn {Método} emit (record)

Da la salida del registro a un archivo , proveyendo la información para el volcado (`rollover') como esta descripto anteriormente.
@end deffn

@geindex getFilesToDelete() (método de logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler getFilesToDelete}@anchor{2d55}
@deffn {Método} getFilesToDelete ()

Retorna una lista de nombres de archivos que deben eliminarse como parte del volcado (`rollover'). Estas son las rutas absolutas de los archivos de registro de copia de seguridad más antiguos escritos por el controlador.
@end deffn
@end deffn

@node SocketHandler,DatagramHandler,TimedRotatingFileHandler,logging handlers — Logging handlers
@anchor{library/logging handlers socket-handler}@anchor{2d61}@anchor{library/logging handlers sockethandler}@anchor{2d62}
@subsubsection SocketHandler


La clase @ref{fe2,,SocketHandler} esta localizada en el módulo @ref{89,,logging.handlers}, envía el `logging' a un socket de la red. La clase base usa `sockets' TCP.

@geindex SocketHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers SocketHandler}@anchor{fe2}
@deffn {Clase} logging.handlers.SocketHandler (host, port)

Retorna una nueva instancia de la clase @ref{fe2,,SocketHandler} destinada para comunicarse con una terminal remota cuya dirección esta dada por `host' y `port'.


Distinto en la versión 3.4: Si «port» se especifica como @code{None} se crea un socket de dominio Unix, usando el valor en @code{host} - de otra manera se creará un socket TCP.


@geindex close() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler close}@anchor{2d63}
@deffn {Método} close ()

Cierra el socket.
@end deffn

@geindex emit() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler emit}@anchor{2d64}
@deffn {Método} emit ()

Serializa (`Pickles') el registro del diccionario de atributos y lo escribe en el socket en formato binario. Si hay un error con el socket, silenciosamente descarta el paquete. Si la conexión se perdió previamente, la restablece. Para deserializar (`unpickle') un registro en el extremo receptor a una clase @ref{1065,,LogRecord}, usa la función @ref{2d00,,makeLogRecord()}.
@end deffn

@geindex handleError() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler handleError}@anchor{2d65}
@deffn {Método} handleError ()

Maneja un error que ocurrió durante el método @ref{2d64,,emit()}. La causa mas común es una perdida de conexión. Cierra el socket para que podamos reintentar en el próximo evento.
@end deffn

@geindex makeSocket() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler makeSocket}@anchor{2d66}
@deffn {Método} makeSocket ()

Este es un método patrón que permite subclases para definir el tipo preciso de socket que se necesita. La implementación por defecto crea un socket TCP(@ref{135a,,socket.SOCK_STREAM}).
@end deffn

@geindex makePickle() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler makePickle}@anchor{2d67}
@deffn {Método} makePickle (record)

Serializa (`pickles') el registro del diccionario de atributos en formato binario con un prefijo de tamaño, y lo retorna listo para transmitir a través del socket. Los detalles de esta operación son equivalentes a:

@example
data = pickle.dumps(record_attr_dict, 1)
datalen = struct.pack('>L', len(data))
return datalen + data
@end example

Nota que los serializados (`pickles') no son totalmente seguros. Si te preocupa la seguridad desearás evitar este método para implementar un mecanismo mas seguro. Por ejemplo puedes firmar `pickles' usando HMAC y verificarlos después en el extremo receptor. O alternativamente puedes deshabilitar la deserialización (`unpickling') de objetos globales en el extremo receptor.
@end deffn

@geindex send() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler send}@anchor{2d68}
@deffn {Método} send (packet)

Envía un paquete serializado (`pickled') de cadena de caracteres al socket. El formato de la cadena de bytes enviada es tal como se describe en la documentación de @ref{2d67,,makePickle()}.

Esta función permite envíos parciales, que pueden ocurrir cuando la red esta ocupada.
@end deffn

@geindex createSocket() (método de logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler createSocket}@anchor{6fe}
@deffn {Método} createSocket ()

Intenta crear un socket, si hay una falla usa un algoritmo de marcha atrás exponencial. En el fallo inicial el gestor desechará el mensaje que intentaba enviar. Cuando los siguientes mensajes sean gestionados por la misma instancia no intentará conectarse hasta que haya transcurrido cierto tiempo. Los parámetros por defecto son tales que el retardo inicial es un segundo y si después del retardo la conexión todavía no se puede realizar, el gestor doblará el retardo cada vez hasta un máximo de 30 segundos.

Este comportamiento es controlado por los siguientes atributos del gestor:


@itemize *

@item 
@code{retryStart} (retardo inicial por defecto 1.0 segundos)

@item 
@code{retryFactor} (multiplicador por defecto 2.0)

@item 
@code{retryMax} (máximo retardo por defecto 30.0 segundos)
@end itemize

Esto significa que si el oyente remoto (`listener') comienza después de que se usó el gestor , pueden perderse mensajes (dado que el gestor no puede siquiera intentar una conexión hasta que se haya cumplido el retardo, y silenciosamente desechará los mensajes mientras se cumpla el retardo).
@end deffn
@end deffn

@node DatagramHandler,Gestor SysLog SysLogHandler,SocketHandler,logging handlers — Logging handlers
@anchor{library/logging handlers datagram-handler}@anchor{2d69}@anchor{library/logging handlers datagramhandler}@anchor{2d6a}
@subsubsection DatagramHandler


La clase @ref{fe3,,DatagramHandler} está ubicada en el módulo @ref{89,,logging.handlers}, hereda de la clase @ref{fe2,,SocketHandler} para realizar el soporte de mensajes `logging' por los `sockets' UDP.

@geindex DatagramHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers DatagramHandler}@anchor{fe3}
@deffn {Clase} logging.handlers.DatagramHandler (host, port)

Retorna una nueva instancia de la clase @ref{fe3,,DatagramHandler} destinada para comunicarse con la terminal remota cuya dirección es dada por `host' y `port'.

@cartouche
@quotation Nota 
Como UDP no es un protocolo de transmisión, no existe una conexión persistente entre una instancia de este controlador y `host'. Por esta razón, cuando se usa un socket de red, es posible que se deba realizar una búsqueda de DNS cada vez que se registra un evento, lo que puede generar cierta latencia en el sistema. Si esto te afecta, puedes realizar una búsqueda tu mismo e inicializar este controlador utilizando la dirección IP buscada en lugar del nombre de host.
@end quotation
@end cartouche


Distinto en la versión 3.4: Si “port” se especifica como «None», se crea un socket de dominio Unix, usando el valor en «host» - de otra manera se crea un socket UDP.


@geindex emit() (método de logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler emit}@anchor{2d6b}
@deffn {Método} emit ()

Serializa (`pickles') el registro del diccionario de atributos y lo escribe en el socket en formato binario. Si hay un error con el socket, silenciosamente desecha el paquete. Para deserializar (`unpickle') el registro en el extremo de recepción a una clase @ref{1065,,LogRecord}, usa la función @ref{2d00,,makeLogRecord()}.
@end deffn

@geindex makeSocket() (método de logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler makeSocket}@anchor{2d6c}
@deffn {Método} makeSocket ()

El método original de la clase @ref{fe2,,SocketHandler} se omite para crear un socket UDP (@ref{1359,,socket.SOCK_DGRAM}).
@end deffn

@geindex send() (método de logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler send}@anchor{2d6d}
@deffn {Método} send (s)

Enviar una cadena de caracteres serializada (`pickled') a un socket de red. El formato de la cadena de `bytes' enviado es tal como se describe en la documentación para @ref{2d67,,SocketHandler.makePickle()}.
@end deffn
@end deffn

@node Gestor SysLog SysLogHandler,Gestor de eventos NTELog NTEventLogHandler,DatagramHandler,logging handlers — Logging handlers
@anchor{library/logging handlers syslog-handler}@anchor{2d6e}@anchor{library/logging handlers sysloghandler}@anchor{2d6f}
@subsubsection Gestor `SysLog' (`SysLogHandler')


La clase @ref{6fd,,SysLogHandler} está ubicada en el módulo @ref{89,,logging.handlers}. Realiza el soporte de los mensajes de `logging' a un `syslog' Unix local o remoto.

@geindex SysLogHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers SysLogHandler}@anchor{6fd}
@deffn {Clase} logging.handlers.SysLogHandler (address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)

Retorna una nueva instancia de la clase @ref{6fd,,SysLogHandler} concebida para comunicarse con una terminal remota Unix cuya dirección esta dada por `address' en la forma de una tupla @code{(host, port)} . Si `address' no se especifica se usará @code{('localhost', 514)}. La dirección se usa para abrir el socket. Una alternativa a consignar una tupla @code{(host, port)} es proveer una dirección como cadena de caracteres, por ejemplo “/dev/log”. En este caso se usa un socket de dominio Unix para enviar el mensaje al syslog. Si `facility' no se especifica se usara @code{LOG_USER} . El tipo de socket abierto usado depende del argumento `socktype' , que por defecto es @ref{1359,,socket.SOCK_DGRAM} y por lo tanto abre un socket UDP . Para abrir un socket TCP (para usar con los nuevos `daemons syslog' como rsyslog) se debe especificar un valor de @ref{135a,,socket.SOCK_STREAM}.

Nótese que si el servidor no esta escuchando el puerto UDP 514, la clase @ref{6fd,,SysLogHandler} puede parecer no funcionar. En ese caso chequea que dirección deberías usar para un socket de dominio . Es sistema-dependiente. Por ejemplo en Linux generalmente es “/dev/log” pero en OS/X es “/var/run/syslog”. Será necesario chequear tu plataforma y usar la dirección adecuada (quizá sea necesario realizar este chequeo mientras corre la aplicación si necesita correr en diferentes plataformas). En Windows seguramente tengas que usar la opción UDP.

@cartouche
@quotation Nota 
En macOS 12.x (Monterey), Apple cambió el comportamiento de su syslog daemon: ya no escucha en un socket de dominio. Por lo tanto, no puedes esperar que @ref{6fd,,SysLogHandler} funcione en este sistema.

Ver gh-91070@footnote{https://github.com/python/cpython/issues/91070} para más información.
@end quotation
@end cartouche


Distinto en la versión 3.2: Se agregó `socktype'.


@geindex close() (método de logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler close}@anchor{2d70}
@deffn {Método} close ()

Cierra el socket del host remoto.
@end deffn

@geindex createSocket() (método de logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler createSocket}@anchor{6fc}
@deffn {Método} createSocket ()

Tries to create a socket and, if it’s not a datagram socket, connect it
to the other end. This method is called during handler initialization,
but it’s not regarded as an error if the other end isn’t listening at
this point - the method will be called again when emitting an event, if
there is no socket at that point.


Added in version 3.11.

@end deffn

@geindex emit() (método de logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler emit}@anchor{2d71}
@deffn {Método} emit (record)

El registro es formateado, y luego enviado al servidor `syslog'. Si hay información de excepción presente entonces no se enviará al servidor.


Distinto en la versión 3.2.1: (Véase el bpo-12168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12168}.) En versiones anteriores , los mensajes enviados a los `daemons syslog' siempre terminaban con un byte NUL ya que versiones anteriores de estos `daemons' esperaban un mensaje NUL de terminación. Incluso a pesar que no es relevante la especificación (
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html}). Versiones mas recientes de estos `daemons' no esperan el byte NUL pero lo quitan si esta ahí. Versiones aún mas recientes que están mas cercanas a la especificación RFC 5424 pasan el byte NUL como parte del mensaje.

Para habilitar una gestión mas sencilla de los mensajes `syslog' respecto de todos esos `daemons' de diferentes comportamientos el agregado del byte NUL es configurable a través del uso del atributo de nivel de clase @code{append_nul}. Este es por defecto “@code{True} (preservando el comportamiento ya existente) pero se puede establecer a “False” en una instancia @code{SysLogHandler} como para que esa instancia no añada el terminador NUL.



Distinto en la versión 3.3: (Véase: issue “12419”) en versiones anteriores, no había posibilidades para un prefijo “ident” o “tag” para identificar el origen del mensaje. Esto ahora se puede especificar usando un atributo de nivel de clase, que por defecto será «””» para preservar el comportamiento existente , pero puede ser sorteado en una instancia @code{SysLogHandler} para que esta instancia anteponga el `ident' a todos los mensajes gestionados. Nótese que el `ident' provisto debe ser texto, no bytes y se antepone al mensaje tal como es.

@end deffn

@geindex encodePriority() (método de logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler encodePriority}@anchor{2d72}
@deffn {Método} encodePriority (facility, priority)

Codifica la funcionalidad y prioridad en un entero. Puedes pasar cadenas de caracteres o enteros, si pasas cadenas de caracteres se usarán los diccionarios de mapeo interno para convertirlos en enteros.

Los valores simbólicos @code{LOG_} están definidos en @ref{6fd,,SysLogHandler} e invierten los valores definidos en el archivo de encabezado @code{sys/syslog.h}.

`Prioridades'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nombre (cadena de caracteres)

@tab

Valor simbólico

@item

@code{alert}

@tab

LOG_ALERT

@item

@code{crit} or @code{critical}

@tab

LOG_CRIT

@item

@code{debug}

@tab

LOG_DEBUG

@item

@code{emerg} or @code{panic}

@tab

LOG_EMERG

@item

@code{err} or @code{error}

@tab

LOG_ERR

@item

@code{info}

@tab

LOG_INFO

@item

@code{notice}

@tab

LOG_NOTICE

@item

@code{warn} o @code{warning}

@tab

LOG_WARNING

@end multitable


`Facilities'


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nombre (cadena de caracteres)

@tab

Valor simbólico

@item

@code{auth}

@tab

LOG_AUTH

@item

@code{authpriv}

@tab

LOG_AUTHPRIV

@item

@code{cron}

@tab

LOG_CRON

@item

@code{daemon}

@tab

LOG_DAEMON

@item

@code{ftp}

@tab

LOG_FTP

@item

@code{kern}

@tab

LOG_KERN

@item

@code{lpr}

@tab

LOG_LPR

@item

@code{mail}

@tab

LOG_MAIL

@item

@code{news}

@tab

LOG_NEWS

@item

@code{syslog}

@tab

LOG_SYSLOG

@item

@code{user}

@tab

LOG_USER

@item

@code{uucp}

@tab

LOG_UUCP

@item

@code{local0}

@tab

LOG_LOCAL0

@item

@code{local1}

@tab

LOG_LOCAL1

@item

@code{local2}

@tab

LOG_LOCAL2

@item

@code{local3}

@tab

LOG_LOCAL3

@item

@code{local4}

@tab

LOG_LOCAL4

@item

@code{local5}

@tab

LOG_LOCAL5

@item

@code{local6}

@tab

LOG_LOCAL6

@item

@code{local7}

@tab

LOG_LOCAL7

@end multitable

@end deffn

@geindex mapPriority() (método de logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler mapPriority}@anchor{2d73}
@deffn {Método} mapPriority (levelname)

Mapea un nombre de nivel `logging' a un nombre de prioridad `syslog'. Puedes necesitar omitir esto si estas usando niveles personalizados, o si el algoritmo por defecto no es aplicable a tus necesidades. El algoritmo por defecto mapea @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} y @code{CRITICAL} a sus nombres equivalentes `syslog', y todos los demás nombres de nivel a “warning”.
@end deffn
@end deffn

@node Gestor de eventos NTELog NTEventLogHandler,SMTPHandler,Gestor SysLog SysLogHandler,logging handlers — Logging handlers
@anchor{library/logging handlers nt-eventlog-handler}@anchor{2d74}@anchor{library/logging handlers nteventloghandler}@anchor{2d75}
@subsubsection Gestor de eventos `NTELog' (NTEventLogHandler)


La clase @ref{2d76,,NTEventLogHandler} esta localizada en el módulo @ref{89,,logging.handlers}, soporta el envío de mensajes de `logging' a un log de eventos local Windows NT, Windows 2000 o Windows XP. Antes de que puedas usarlo, necesitarás tener instaladas las extensiones de Win32 de Mark Hammond para Python.

@geindex NTEventLogHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers NTEventLogHandler}@anchor{2d76}
@deffn {Clase} logging.handlers.NTEventLogHandler (appname, dllname=None, logtype='Application')

Retorna una nueva instancia de la clase @ref{2d76,,NTEventLogHandler} la `appname' se usa para definir el nombre de la aplicación tal como aparece en el log de eventos. Se crea una entrada de registro apropiada usando este nombre. El `dllname' debe dar la ruta completa calificada de un .dll o .exe que contiene definiciones de mensaje para conservar en el log. (si no esta especificada, se usara @code{'win32service.pyd'} esto es instalado con las extensiones de Win32 y contiene algunas definiciones básicas de mensajes de conservación de lugar. Nótese que el uso de estos conservadores de lugar harán tu log de eventos extenso, dado que el origen completo del mensaje es guardado en el log. Si quieres `logs' menos extensos deberás pasar el nombre de tu propio .dll o .exe que contiene la definición de mensajes que quieres usar en el log. El `logtype' puede ser de @code{'Application'}, @code{'System'} or @code{'Security'} y sino por defecto será de @code{'Application'}.

@geindex close() (método de logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler close}@anchor{2d77}
@deffn {Método} close ()

Llegado a este punto puedes remover el nombre de aplicación del registro como origen de entrada de log de eventos. Sin embargo si haces esto no te será posible ver los eventos tal como has propuesto en el visor del log de eventos - necesita ser capaz de acceder al registro para tomar el nombre .dll. Esto no lo hace la versión actual.
@end deffn

@geindex emit() (método de logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler emit}@anchor{2d78}
@deffn {Método} emit (record)

Determina el ID del mensaje, categoría y tipo de evento y luego registra el mensaje en el log de eventos NT.
@end deffn

@geindex getEventCategory() (método de logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventCategory}@anchor{2d79}
@deffn {Método} getEventCategory (record)

Retorna la categoría de evento del registro. Evita esto si quieres especificar tus propias categorías. Esta versión retorna 0.
@end deffn

@geindex getEventType() (método de logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventType}@anchor{2d7a}
@deffn {Método} getEventType (record)

Retorna el tipo de evento del registro. Haz caso omiso de esto si quieres especificar tus propios tipos. Esta versión realiza un mapeo usando el atributo `typemap' del gestor, que se establece en @code{__init__()} a un diccionario que contiene mapeo para @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} y @code{CRITICAL}. Si estas usando tus propios niveles, necesitarás omitir este método o colocar un diccionario a medida en el atributo `typemap' del gestor.
@end deffn

@geindex getMessageID() (método de logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getMessageID}@anchor{2d7b}
@deffn {Método} getMessageID (record)

Retorna el ID de mensaje para el registro. Si estas usando tus propios mensajes, podrás hacerlo pasando el `msg' al `logger' siendo un ID mas que un formato de cadena de caracteres. Luego aquí puedes usar una búsqueda de diccionario para obtener el ID de mensaje. Esta versión retorna 1, que es el ID de mensaje base en @code{win32service.pyd}.
@end deffn
@end deffn

@node SMTPHandler,MemoryHandler,Gestor de eventos NTELog NTEventLogHandler,logging handlers — Logging handlers
@anchor{library/logging handlers smtp-handler}@anchor{2d7c}@anchor{library/logging handlers smtphandler}@anchor{2d7d}
@subsubsection SMTPHandler


La clase @ref{2d7e,,SMTPHandler} esta ubicada en el módulo @ref{89,,logging.handlers} y soporta el envío de mensajes de `logging' a un a dirección de correo electrónico a través de SMTP.

@geindex SMTPHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers SMTPHandler}@anchor{2d7e}
@deffn {Clase} logging.handlers.SMTPHandler (mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)

Retorna una nueva instancia de la clase @ref{2d7e,,SMTPHandler} . Esta instancia se inicializa con la dirección de: y para: y asunto: del correo electrónico. El `toaddrs' debe ser una lista de cadena de caracteres. Para especificar un puerto SMTP no estandarizado usa el formato de tupla (host, puerto) para el argumento `mailhost'. Si usas una cadena de caracteres, se utiliza el puerto estándar SMTP. Si tu servidor SMTP necesita autenticación, puedes especificar una tupla (usuario, contraseña) para el argumento de `credentials'.

Para especificar el uso de un protocolo de seguridad (TLS), pasa una tupla al argumento `secure'. Esto solo se utilizará cuando sean provistas las credenciales de autenticación. La tupla deberá ser una tupla vacía o una tupla con único valor con el nombre de un archivo-clave `keyfile', o una tupla de 2 valores con el nombre del archivo-clave `keyfile' y archivo certificado. (Esta tupla se pasa al método @ref{11aa,,smtplib.SMTP.starttls()} method.).

Se puede especificar un tiempo de espera para comunicación con el servidor SMTP usando el argumento `timeout'.


Distinto en la versión 3.3: Added the `timeout' parameter.


@geindex emit() (método de logging.handlers.SMTPHandler)
@anchor{library/logging handlers logging handlers SMTPHandler emit}@anchor{2d7f}
@deffn {Método} emit (record)

Formatea el registro y lo envía a las direcciones especificadas.
@end deffn

@geindex getSubject() (método de logging.handlers.SMTPHandler)
@anchor{library/logging handlers logging handlers SMTPHandler getSubject}@anchor{2d80}
@deffn {Método} getSubject (record)

Si quieres especificar una línea de argumento que es registro-dependiente, sobrescribe (`override') este método.
@end deffn
@end deffn

@node MemoryHandler,HTTPHandler,SMTPHandler,logging handlers — Logging handlers
@anchor{library/logging handlers memory-handler}@anchor{2d81}@anchor{library/logging handlers memoryhandler}@anchor{2d82}
@subsubsection MemoryHandler


La clase @ref{2d32,,MemoryHandler} esta ubicada en el módulo @ref{89,,logging.handlers} .Soporta el almacenamiento temporal de registros `logging' en memoria. Periódicamente los descarga al gestor `target'. Esto ocurre cuando el búfer está lleno o cuando ocurre un evento de cierta importancia.

@ref{2d32,,MemoryHandler} es una subclase de la clase mas general @ref{2d83,,BufferingHandler}, que es una clase abstracta. Este almacena temporalmente registros `logging' en la memoria. Cada vez que un registro es agregado al búfer, se realiza una comprobación llamando al método @code{shouldFlush()} para ver si dicho búfer debe ser descargado. Si debiera, entonces el método @code{flush()} se espera que realice la descarga.

@geindex BufferingHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers BufferingHandler}@anchor{2d83}
@deffn {Clase} logging.handlers.BufferingHandler (capacity)

Inicializa el gestor con un búfer de una capacidad especifica. Aquí capacidad significa el número de registros `logging' en el almacenamiento temporal.

@geindex emit() (método de logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler emit}@anchor{2d84}
@deffn {Método} emit (record)

Añade un registro al búfer. Si el método @ref{2d85,,shouldFlush()} retorna `true' , entonces llama al método @ref{2d86,,flush()} para procesar el búfer.
@end deffn

@geindex flush() (método de logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler flush}@anchor{2d86}
@deffn {Método} flush ()

Para una instancia de @ref{2d83,,BufferingHandler}, vaciar significa que establece el búfer a una lista vacía. Este método puede ser sobrescrito para implementar un comportamiento de vaciado más útil.
@end deffn

@geindex shouldFlush() (método de logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler shouldFlush}@anchor{2d85}
@deffn {Método} shouldFlush (record)

Retorna @code{True} si el búfer tiene aún capacidad. Este método puede ser omitido para implementar estrategias a medida de vaciado.
@end deffn
@end deffn

@geindex MemoryHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers MemoryHandler}@anchor{2d32}
@deffn {Clase} logging.handlers.MemoryHandler (capacity, flushLevel=ERROR, target=None, flushOnClose=True)

Retorna una nueva instancia de la clase @ref{2d32,,MemoryHandler} . La instancia se inicializa con un búfer del tamaño `capacity'. Si el `flushLevel' no se especifica, se usará @code{ERROR} . Si no se especifica `target' el objetivo deberá especificarse usando el método @ref{2d87,,setTarget()} -Antes de esto el gestor no realizará nada útil. Si se especifica `flushOnClose' como @code{False}, entonces el búfer no se vaciará cuando el gestor se cierra. Si no se especifica o se especifica como @code{True}, el comportamiento previo de vaciado del búfer sucederá cuando se cierre el gestor.


Distinto en la versión 3.6: Se añadió el parámetro `flushOnClose'.


@geindex close() (método de logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler close}@anchor{2d88}
@deffn {Método} close ()

Invoca al método @ref{2d89,,flush()} y establece el objetivo a “None” y vacía el búfer.
@end deffn

@geindex flush() (método de logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler flush}@anchor{2d89}
@deffn {Método} flush ()

Para una instancia de @ref{2d32,,MemoryHandler}, el vaciado implica simplemente enviar los registros almacenados en el búfer al objetivo, si es que existe uno. El búfer también se limpia cuando se envían los registros almacenados al objetivo. Sobrescribe si deseas un comportamiento diferente.
@end deffn

@geindex setTarget() (método de logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler setTarget}@anchor{2d87}
@deffn {Método} setTarget (target)

Establece el gestor de objetivo para este gestor.
@end deffn

@geindex shouldFlush() (método de logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler shouldFlush}@anchor{2d8a}
@deffn {Método} shouldFlush (record)

Comprueba si el búfer esta lleno o un registro igual o mas alto que `flushLevel'.
@end deffn
@end deffn

@node HTTPHandler,QueueHandler,MemoryHandler,logging handlers — Logging handlers
@anchor{library/logging handlers http-handler}@anchor{2d8b}@anchor{library/logging handlers httphandler}@anchor{2d8c}
@subsubsection HTTPHandler


La clase @ref{eb0,,HTTPHandler}, ubicada en el módulo @ref{89,,logging.handlers}, admite el envío de mensajes de registro a un servidor web, utilizando la semántica @code{GET} o @code{POST}.

@geindex HTTPHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers HTTPHandler}@anchor{eb0}
@deffn {Clase} logging.handlers.HTTPHandler (host, url, method='GET', secure=False, credentials=None, context=None)

Retorna una nueva instancia de la clase @ref{eb0,,HTTPHandler}. el `host' puede ser de la forma «host:puerto», y necesitarás usar un numero de puerto especifico. Si no se especifica `method' se usará @code{GET} . Si `secure' es true se usará una conexión HTTPS. El parámetro `context' puede establecerse a una instancia @ref{1fa,,ssl.SSLContext} para establecer la configuración de SSL usado en la conexión HTTPS. Si se especifica `credentials' debe ser una tupla doble, consistente en usuario y contraseña, que se colocará en un encabezado de autorización HTTP usando autenticación básica. Si especificas credenciales también deberás especificar `secure=True' así tu usuario y contraseña no son pasados como texto en blanco por la conexión.


Distinto en la versión 3.5: Se agregó el parámetro `context'.


@geindex mapLogRecord() (método de logging.handlers.HTTPHandler)
@anchor{library/logging handlers logging handlers HTTPHandler mapLogRecord}@anchor{2d8d}
@deffn {Método} mapLogRecord (record)

Provee un diccionario, basado en @code{record} para ser codificado en forma URL y enviado al servidor web. La implementación por defecto retorna @code{record.__dict__}. Este método puede omitirse si por ejemplo solo se enviará al servidor web un subconjunto de la clase @ref{1065,,LogRecord} o si se requiere enviar al servidor algo mas específico.
@end deffn

@geindex emit() (método de logging.handlers.HTTPHandler)
@anchor{library/logging handlers logging handlers HTTPHandler emit}@anchor{2d8e}
@deffn {Método} emit (record)

Envía el registro al servidor web como un diccionario codificado en URL. El método @ref{2d8d,,mapLogRecord()} se utiliza para convertir el registro al diccionario que se enviará.
@end deffn

@cartouche
@quotation Nota 
Dado que preparar un registro para enviarlo a un servidor web no es lo mismo que una operación de formateo genérico, el uso de @ref{2ce3,,setFormatter()} para especificar un @ref{14d1,,Formatter} para un @ref{eb0,,HTTPHandler} no tiene ningún efecto. En lugar de llamar a @ref{2ced,,format()}, este controlador llama a @ref{2d8d,,mapLogRecord()} y luego a @ref{f16,,urllib.parse.urlencode()} para codificar el diccionario en una forma adecuada para enviar a un servidor web.
@end quotation
@end cartouche
@end deffn

@node QueueHandler,QueueListener,HTTPHandler,logging handlers — Logging handlers
@anchor{library/logging handlers queue-handler}@anchor{2d8f}@anchor{library/logging handlers queuehandler}@anchor{2d90}
@subsubsection QueueHandler



Added in version 3.2.


La clase @ref{17de,,QueueHandler} localizada en el módulo @ref{89,,logging.handlers} soporta el envío de mensajes de `logging' a una cola, tal como los implementados en los módulos @ref{b6,,queue} o @ref{94,,multiprocessing} .

Junto con la clase @ref{eb1,,QueueListener}, @ref{17de,,QueueHandler} se puede usar para permitir que los controladores hagan su trabajo en un hilo separado del que realiza el registro. Esto es importante en aplicaciones web y también en otras aplicaciones de servicio donde los subprocesos que atienden a los clientes deben responder lo más rápido posible, mientras que cualquier operación potencialmente lenta (como enviar un correo electrónico a través de @ref{2d7e,,SMTPHandler}) se realiza en un subproceso separado.

@geindex QueueHandler (clase en logging.handlers)
@anchor{library/logging handlers logging handlers QueueHandler}@anchor{17de}
@deffn {Clase} logging.handlers.QueueHandler (queue)

Retorna una nueva instancia de la clase @ref{17de,,QueueHandler}. La instancia se inicializa con la cola a la que se enviarán los mensajes. La cola puede ser cualquier objeto tipo-cola; es usado tal como por el método @ref{2d91,,enqueue()} que necesita saber como enviar los mensajes a ella. La cola no es `requerida' para tener una API de rastreo de tareas, lo que significa que puedes usar instancias de @ref{bf2,,SimpleQueue} como `queue'.

@cartouche
@quotation Nota 
Si estás usando @ref{94,,multiprocessing}, debes evitar usar @ref{bf2,,SimpleQueue} y en su lugar usar @ref{1803,,multiprocessing.Queue}.
@end quotation
@end cartouche

@geindex emit() (método de logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler emit}@anchor{2d92}
@deffn {Método} emit (record)

Pone en cola el resultado de preparar el LogRecord. Si ocurre una excepción (por ejemplo, porque una cola limitada se ha llenado), se invoca el método @ref{2ceb,,handleError()} para manejar el error. Esto puede resultar en que el registro se descarte de manera silenciosa (si @ref{1266,,logging.raiseExceptions} es @code{False}) o en que se imprima un mensaje en @code{sys.stderr} (si @ref{1266,,logging.raiseExceptions} es @code{True}).
@end deffn

@geindex prepare() (método de logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler prepare}@anchor{2d93}
@deffn {Método} prepare (record)

Prepara un registro para poner en la cola. El objeto que retorna este método se colocará en cola.

La implementación base le da formato al registro para fusionar el mensaje, los argumentos, la excepción y la información de la pila, si está presente. También elimina elementos que no se pueden serializar (`pickle') del registro en el lugar. Específicamente, sobrescribe los atributos @code{msg} y @code{message} del registro con el mensaje fusionado (obtenido llamando al método @ref{6c0,,format()} del controlador) y establece los atributos @code{args}, @code{exc_info} y @code{exc_text} a @code{None}.

Puedes querer hacer caso omiso de este método si quieres convertir el registro en un diccionario o cadena de caracteres JSON, o enviar una copia modificada del registro mientras dejas el original intacto.

@cartouche
@quotation Nota 
La implementación base formatea el mensaje con argumentos, establece los atributos @code{message} y @code{msg} en el mensaje formateado y establece los atributos @code{args} y @code{exc_text} en @code{None} para permitir serializado (`pickle') y para evitar nuevos intentos de formateo. Esto significa que un controlador en el lado @ref{eb1,,QueueListener} no tendrá la información para hacer un formato personalizado, por ej. de excepciones. Es posible que desees crear una subclase de @code{QueueHandler} y anular este método para, por ej. evitar establecer @code{exc_text} en @code{None}. Ten en cuenta que los cambios de @code{message} / @code{msg} / @code{args} están relacionados con garantizar que el registro se pueda seleccionar, y es posible que puedas o no evitar hacerlo dependiendo de si sus @code{args} son serializables. (Ten en cuenta que es posible que debas considerar no solo tu propio código, sino también el código en cualquier biblioteca que uses).
@end quotation
@end cartouche
@end deffn

@geindex enqueue() (método de logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler enqueue}@anchor{2d91}
@deffn {Método} enqueue (record)

Coloca en la cola al registro usando @code{put_nowait()}; puede que quieras sobrescribe (`override') esto si quieres usar una acción de bloqueo, o un tiempo de espera, o una implementación de cola a medida.
@end deffn

@geindex listener (atributo de logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler listener}@anchor{2d36}
@deffn {Atributo} listener

Cuando se crea a través de la configuración usando @ref{121e,,dictConfig()}, este atributo contendrá una instancia de @ref{eb1,,QueueListener} para usar con este manejador. De lo contrario, será @code{None}.


Added in version 3.12.

@end deffn
@end deffn

@node QueueListener,,QueueHandler,logging handlers — Logging handlers
@anchor{library/logging handlers queue-listener}@anchor{2d94}@anchor{library/logging handlers queuelistener}@anchor{2d95}
@subsubsection QueueListener



Added in version 3.2.


La clase @ref{eb1,,QueueListener} esta localizada en el módulo @ref{89,,logging.handlers}. Soporta la recepción de mensajes `logging' de una cola, tal como los implementados en los módulos @ref{b6,,queue} or @ref{94,,multiprocessing} . Los mensajes son recibidos de una cola en un hilo interno y se pasan en el mismo hilo, a uno o mas gestores para procesarlos. Mientras la clase @ref{eb1,,QueueListener} no es en si misma un gestor, esta documentada aquí porque trabaja mano a mano con la clase @ref{17de,,QueueHandler}.

Junto con la clase @ref{17de,,QueueHandler}, @ref{eb1,,QueueListener} se puede usar para permitir que los controladores hagan su trabajo en un hilo separado del que realiza el registro. Esto es importante en aplicaciones web y también en otras aplicaciones de servicio donde los subprocesos que atienden a los clientes deben responder lo más rápido posible, mientras que cualquier operación potencialmente lenta (como enviar un correo electrónico a través de @ref{2d7e,,SMTPHandler}) se realiza en un subproceso separado.

@geindex QueueListener (clase en logging.handlers)
@anchor{library/logging handlers logging handlers QueueListener}@anchor{eb1}
@deffn {Clase} logging.handlers.QueueListener (queue, *handlers, respect_handler_level=False)

Retorna una nueva instancia de la clase @ref{eb1,,QueueListener}. La instancia se inicializa con la cola para enviar mensajes a una lista de gestores que manejarán entradas colocadas en la cola. La cola puede ser cualquier objeto de tipo-cola, es usado tal como está por el método @ref{2d96,,dequeue()} que necesita saber como tomar los mensajes de esta. La cola no es `obligatoria' para tener la API de seguimiento de tareas (aunque se usa si está disponible), lo que significa que puede usar instancias @ref{bf2,,SimpleQueue} para `queue'.

@cartouche
@quotation Nota 
Si estás usando @ref{94,,multiprocessing}, debes evitar usar @ref{bf2,,SimpleQueue} y en su lugar usar @ref{1803,,multiprocessing.Queue}.
@end quotation
@end cartouche

Si @code{respect_handler_level} es @code{True}, se respeta un nivel de gestor (comparado con el nivel del mensaje) cuando decide si pasar el mensajes al gestor; de otra manera, el comportamiento es como en versiones anteriores de Python - de pasar cada mensaje a cada gestor.


Distinto en la versión 3.5: Se agregó el argumento @code{respect_handler_levels}.


@geindex dequeue() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener dequeue}@anchor{2d96}
@deffn {Método} dequeue (block)

Extrae de la cola un registro y lo retorna, con opción a bloquearlo.

La implementación base usa @code{get()}. Puedes sobrescribir (`override') este método si quieres usar tiempos de espera o trabajar con colas implementadas a medida.
@end deffn

@geindex prepare() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener prepare}@anchor{2d97}
@deffn {Método} prepare (record)

Prepara un registro para ser gestionado.

Esta implementación solo retorna el registro que fue pasado. Puedes sobrescribir (`override') este método para hacer una serialización a medida o una manipulación del registro antes de pasarlo a los gestores.
@end deffn

@geindex handle() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener handle}@anchor{2d98}
@deffn {Método} handle (record)

Manejar un registro.

Esto solo realiza un bucle a través de los gestores ofreciéndoles el registro para ser gestionado. El objeto actual pasado a los gestores es aquel que es retornado por el método @ref{2d97,,prepare()}.
@end deffn

@geindex start() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener start}@anchor{2d99}
@deffn {Método} start ()

Da comienzo al oyente (`listener').

Esto da comienzo a un hilo en segundo plano para supervisar la cola de registros log a procesar.
@end deffn

@geindex stop() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener stop}@anchor{2d9a}
@deffn {Método} stop ()

Detiene el oyente (`listener').

Esto solicita terminar al hilo, y luego espera hasta que termine. Nota que si no llamas a esto antes de que tu aplicación salga, puede haber algunos registros que aun están en la cola, que no serán procesados.
@end deffn

@geindex enqueue_sentinel() (método de logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener enqueue_sentinel}@anchor{2d9b}
@deffn {Método} enqueue_sentinel ()

Escribe un centinela (`sentinel') en la cola para decir al oyente (`listener') de salir. Esta implementación usa @code{put_nowait()}. Puedes sobrescribir (`override') este método si quieres usar tiempos de espera o trabajar con implementaciones de cola a tu medida.


Added in version 3.3.

@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{87,,logging}

Referencia API para el módulo de `logging'.

@item Módulo @ref{88,,logging.config}

Configuración API para el módulo de `logging'.
@end table


@node getpass — Portable password input,curses — Terminal handling for character-cell displays,logging handlers — Logging handlers,Servicios genéricos del sistema operativo
@anchor{library/getpass doc}@anchor{2d9c}@anchor{library/getpass getpass-portable-password-input}@anchor{2d9d}@anchor{library/getpass module-getpass}@anchor{62}
@subsection @code{getpass} — Portable password input


@geindex module; getpass

@c Windows (& Mac?) support by Guido van Rossum.

`Código fuente:' Lib/getpass.py@footnote{https://github.com/python/cpython/tree/main/Lib/getpass.py}


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo @ref{62,,getpass} proporciona dos funciones:

@geindex getpass() (en el módulo getpass)
@anchor{library/getpass getpass getpass}@anchor{2d9e}
@deffn {Función} getpass.getpass (prompt='Password: ', stream=None)

Solicita al usuario una contraseña sin hacer eco. Se solicita al usuario mediante la cadena `prompt', que por defecto es @code{'Password: '}. En Unix, el indicador se escribe en el objeto similar a un archivo `stream' usando el controlador de errores de reemplazo si es necesario. `stream' toma por defecto el terminal de control (@code{/dev/tty}) o si no está disponible para @code{sys.stderr} (este argumento se ignora en Windows).

Si la entrada sin `echo' no está disponible, getpass() recurre a imprimir un mensaje de advertencia en `stream' y leer de @code{sys.stdin} y lanza un @ref{2d9f,,GetPassWarning}.

@cartouche
@quotation Nota 
Si llama a getpass desde IDLE, la entrada puede realizarse en la terminal desde la que inició IDLE en lugar de en la ventana inactiva en sí.
@end quotation
@end cartouche
@end deffn

@geindex GetPassWarning
@anchor{library/getpass getpass GetPassWarning}@anchor{2d9f}
@deffn {Excepción} getpass.GetPassWarning

Una subclase @ref{22b7,,UserWarning} lanzada cuando la entrada de la contraseña puede repetirse.
@end deffn

@geindex getuser() (en el módulo getpass)
@anchor{library/getpass getpass getuser}@anchor{4d6}
@deffn {Función} getpass.getuser ()

Retorna el «nombre de inicio de sesión» del usuario.

This function checks the environment variables 
@geindex LOGNAME
@geindex variables de entorno; LOGNAME
@code{LOGNAME},
@geindex USER
@geindex variables de entorno; USER
@code{USER}, @code{LNAME} and 
@geindex USERNAME
@geindex variables de entorno; USERNAME
@code{USERNAME}, in order, and
returns the value of the first one which is set to a non-empty string.  If
none are set, the login name from the password database is returned on
systems which support the @ref{b2,,pwd} module, otherwise, an @ref{4d5,,OSError}
is raised.

In general, this function should be preferred over @ref{2b13,,os.getlogin()}.


Distinto en la versión 3.13: Previously, various exceptions beyond just @ref{4d5,,OSError} were raised.

@end deffn

@node curses — Terminal handling for character-cell displays,curses textpad— Widget de entrada de texto para programas de curses,getpass — Portable password input,Servicios genéricos del sistema operativo
@anchor{library/curses doc}@anchor{2da0}@anchor{library/curses curses-terminal-handling-for-character-cell-displays}@anchor{2da1}@anchor{library/curses module-curses}@anchor{2c}
@subsection @code{curses} — Terminal handling for character-cell displays


@geindex module; curses

`Source code:' Lib/curses@footnote{https://github.com/python/cpython/tree/main/Lib/curses}


__________________________________________________________________


El módulo @ref{2c,,curses} provee una interfaz para la librería `curses', el estándar para el manejo avanzado de terminales portátiles.

Mientras que curses es más ampliamente usado en los ambientes Unix, las versiones están disponibles para Windows, DOS, y posiblemente para otros sistemas también. Esta extensión del módulo es diseñada para coincidir con el API de ncurses, una librería de código abierto almacenada en Linux y las variantes BSD de Unix.

@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@cartouche
@quotation Nota 
Cuando la documentación menciona un `carácter', esto puede ser especificado como un entero, una cadena Unicode de un carácter o una cadena de bytes de un byte.

Cuando la documentación menciona una `cadena de caracteres', esto puede ser especificado como una cadena Unicode o una cadena de bytes.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item Módulo @ref{2d,,curses.ascii}

Utilidades para trabajar con caracteres ASCII, independientemente de tu configuración local.

@item Módulo @ref{2e,,curses.panel}

Una extensión de la pila de paneles que añade profundidad a las ventanas de curses.

@item Módulo @ref{2f,,curses.textpad}

Widget de texto editable para apoyar curses  @code{Emacs}- como enlaces.

@item @ref{2da2,,Programación de curses con Python}

Material del tutorial usando curses con Python, por `Andrew Kuchling' y `Eric Raymond'.
@end table


@menu
* Funciones: Funciones<4>. 
* Objetos de ventana:: 
* Constantes: Constantes<6>. 

@end menu

@node Funciones<4>,Objetos de ventana,,curses — Terminal handling for character-cell displays
@anchor{library/curses curses-functions}@anchor{2da3}@anchor{library/curses functions}@anchor{2da4}
@subsubsection Funciones


El módulo @ref{2c,,curses} define la siguiente excepción:

@geindex error
@anchor{library/curses curses error}@anchor{2da5}
@deffn {Excepción} curses.error

Una excepción se lanza cuando una función de la librería curses retorna un error.
@end deffn

@cartouche
@quotation Nota 
Cuando los argumentos `x' o `y' para una función o un método son opcionales, se predetermina la ubicación actual del cursor.  Cuando `attr' es opcional, por defecto es @ref{2da6,,A_NORMAL}.
@end quotation
@end cartouche

El módulo @ref{2c,,curses} define las siguientes funciones:

@geindex baudrate() (en el módulo curses)
@anchor{library/curses curses baudrate}@anchor{2da7}
@deffn {Función} curses.baudrate ()

Retorna la velocidad de salida de la terminal en bits por segundo.  En emuladores de terminal de software esto tendrá un alto valor fijado. Incluido por razones históricas; en tiempos pasados, esto fue usado para escribir los ciclos de salida por retrasos de tiempo y ocasionalmente para cambiar interfaces dependiendo de la velocidad en la línea.
@end deffn

@geindex beep() (en el módulo curses)
@anchor{library/curses curses beep}@anchor{2da8}
@deffn {Función} curses.beep ()

Emite un corto sonido de atención.
@end deffn

@geindex can_change_color() (en el módulo curses)
@anchor{library/curses curses can_change_color}@anchor{2da9}
@deffn {Función} curses.can_change_color ()

Retorna @code{True} o @code{False}, dependiendo ya sea que el programador puede cambiar los colores presentados por la terminal.
@end deffn

@geindex cbreak() (en el módulo curses)
@anchor{library/curses curses cbreak}@anchor{2daa}
@deffn {Función} curses.cbreak ()

Entra al modo `cbreak'.  En el modo `cbreak' (a veces llamado modo «raro») del buffer de línea `tty' normal es apagado y los caracteres están disponibles para ser leídos uno por uno.  Sin embargo, a diferencia del modo raw, los caracteres especiales (interrumpir, salir, suspender y control de flujo) retiene sus efectos en el manejador `tty' y el programa de llamada.  Llamando primero @ref{2dab,,raw()} luego @ref{2daa,,cbreak()} dejando la terminal en modo `cbreak'.
@end deffn

@geindex color_content() (en el módulo curses)
@anchor{library/curses curses color_content}@anchor{888}
@deffn {Función} curses.color_content (color_number)

Retorna la intensidad de los componentes rojo, verde y azul (RGB) en el color `color_number', que debe estar entre @code{0} y @code{COLORS-1}. Retorna una tupla de 3, que contiene los valores R,G,B para el color dado, que estará entre @code{0} (sin componente) y @code{1000} (cantidad máxima de componente).
@end deffn

@geindex color_pair() (en el módulo curses)
@anchor{library/curses curses color_pair}@anchor{2dac}
@deffn {Función} curses.color_pair (pair_number)

Return the attribute value for displaying text in the specified color pair.
Only the first 256 color pairs are supported. This
attribute value can be combined with @ref{2dad,,A_STANDOUT}, @ref{2dae,,A_REVERSE},
and the other @code{A_*} attributes.  @ref{2daf,,pair_number()} is the counterpart
to this function.
@end deffn

@geindex curs_set() (en el módulo curses)
@anchor{library/curses curses curs_set}@anchor{2db0}
@deffn {Función} curses.curs_set (visibility)

Configura el estado del cursor. `visibilidad' puede estar configurado para «0», «1» o «2», para invisible, normal o muy visible.  Si la terminal soporta la visibilidad requerida, retorna el estado del cursor previo; de otra manera ejecuta una excepción.  En muchos terminales, el modo «visible» es un cursor subrayado y el modo «muy visible» es un cursor de bloque.
@end deffn

@geindex def_prog_mode() (en el módulo curses)
@anchor{library/curses curses def_prog_mode}@anchor{2db1}
@deffn {Función} curses.def_prog_mode ()

Guardar el modo del terminal actual como el modo «program», el modo cuando el programa corriendo está usando curses. (Su contraparte es el modo «shell», para cuando el programa no está en curses.)  Seguido de la llamada a @ref{2db2,,reset_prog_mode()} restaurará este modo.
@end deffn

@geindex def_shell_mode() (en el módulo curses)
@anchor{library/curses curses def_shell_mode}@anchor{2db3}
@deffn {Función} curses.def_shell_mode ()

Guarde el modo de terminal actual como el modo «shell», el modo en el que el programa en ejecución no utiliza curses. (Su contraparte es el modo «program», cuando el programa está usando las capacidades de curses.)  Las llamadas subsecuentes a @ref{2db4,,reset_shell_mode()} restaurarán este modo.
@end deffn

@geindex delay_output() (en el módulo curses)
@anchor{library/curses curses delay_output}@anchor{2db5}
@deffn {Función} curses.delay_output (ms)

Inserte una pausa en milisegundo `ms' en la salida.
@end deffn

@geindex doupdate() (en el módulo curses)
@anchor{library/curses curses doupdate}@anchor{2db6}
@deffn {Función} curses.doupdate ()

Actualiza la pantalla física. La librería curses mantiene dos estructuras de datos, uno representa el contenido de la pantalla física actual y una pantalla virtual representa el próximo estado deseado.  La base @ref{2db6,,doupdate()} actualiza la pantalla física para comparar la pantalla virtual.

La pantalla virtual puede ser actualizada por una llamada @ref{2db7,,noutrefresh()} después de escribir las operaciones tales como @ref{2db8,,addstr()} ha sido ejecutada en una ventana. La llamada normal @ref{2db9,,refresh()} es simplemente @code{noutrefresh()} seguido por @code{doupdate()}; si tienes para actualizar múltiples ventanas, puedes aumentar el rendimiento y quizás reducir los parpadeos de la pantalla usando la llamada @code{noutrefresh()} en todas las ventanas, seguido por un simple @code{doupdate()}.
@end deffn

@geindex echo() (en el módulo curses)
@anchor{library/curses curses echo}@anchor{2dba}
@deffn {Función} curses.echo ()

Entrar en modo echo.  En modo echo, cada caracter de entrada es repercutido a la pantalla como este es introducido.
@end deffn

@geindex endwin() (en el módulo curses)
@anchor{library/curses curses endwin}@anchor{2dbb}
@deffn {Función} curses.endwin ()

Desinicializa la librería y retorne el terminal al estado normal.
@end deffn

@geindex erasechar() (en el módulo curses)
@anchor{library/curses curses erasechar}@anchor{2dbc}
@deffn {Función} curses.erasechar ()

Retorne el carácter borrado del usuario actual como un objeto de bytes de un byte. Bajo el sistema de operaciones Unix esta es una propiedad de el controlador tty de el programa curses, y no es configurado por la librería curses en sí misma.
@end deffn

@geindex filter() (en el módulo curses)
@anchor{library/curses curses filter}@anchor{2dbd}
@deffn {Función} curses.filter ()

La rutina @ref{2dbd,,filter()}, si es usada, debe ser llamada antes que @ref{15a3,,initscr()} sea llamada.  El efecto es que durante estas llamadas, 
@geindex LINES
@geindex variables de entorno; LINES
@code{LINES} es configurada para @code{1}; las capacidades @code{clear}, @code{cup}, @code{cud}, @code{cud1}, @code{cuu1}, @code{cuu}, @code{vpa} son desactivadas; y la cadena @code{home} es configurada para el valor de @code{cr}.  El efecto es que el cursor es confinado para la línea actual, y también las pantallas son actualizadas.  Este puede ser usado para habilitar la línea editando el carácter en un tiempo sin tocar el resto de las pantallas.
@end deffn

@geindex flash() (en el módulo curses)
@anchor{library/curses curses flash}@anchor{2dbe}
@deffn {Función} curses.flash ()

La pantalla Flash. Eso es, cambiar lo a video inverso y luego cambie lo de nuevo en un corto intervalo.  Algunas personas prefieren como “campana visible” para la señal de atención audible producida por @ref{2da8,,beep()}.
@end deffn

@geindex flushinp() (en el módulo curses)
@anchor{library/curses curses flushinp}@anchor{2dbf}
@deffn {Función} curses.flushinp ()

Vacíe todos los búferes de entrada.  Esto desecha cualquier mecanografiado que ha sido escrito por el usuario y no ha sido aún procesado por el programa.
@end deffn

@geindex getmouse() (en el módulo curses)
@anchor{library/curses curses getmouse}@anchor{2dc0}
@deffn {Función} curses.getmouse ()

Después de @ref{2dc1,,getch()} retorna @ref{2dc2,,KEY_MOUSE} para señalar un evento de mouse, se debe llamar a este método para recuperar el evento de mouse en cola, representado como una tupla de 5 @code{(id, x, y, z, bstate)}. `id' es un valor de ID que se utiliza para distinguir varios dispositivos, y `x', `y', `z' son las coordenadas del evento. (`z' no se usa actualmente.) `bstate' es un valor entero cuyos bits se establecerán para indicar el tipo de evento, y será el OR bit a bit de una o más de las siguientes constantes, donde `n' es el botón número de 1 a 5: @ref{2dc3,,BUTTONn_PRESSED}, @ref{2dc4,,BUTTONn_RELEASED}, @ref{2dc5,,BUTTONn_CLICKED}, @ref{2dc6,,BUTTONn_DOUBLE_CLICKED}, @ref{2dc7,,BUTTONn_TRIPLE_CLICKED}, @ref{2dc8,,BUTTON_SHIFT}, @ref{2dc9,,BUTTON_CTRL}, @ref{2dca,,BUTTON_ALT}.


Distinto en la versión 3.10: Las constantes @code{BUTTON5_*} ahora están expuestas si son proporcionadas por la biblioteca curses subyacente.

@end deffn

@geindex getsyx() (en el módulo curses)
@anchor{library/curses curses getsyx}@anchor{2dcb}
@deffn {Función} curses.getsyx ()

Retorna las coordenadas actuales del cursor en la pantalla virtual como una tupla @code{(y, x)}.  Si @ref{2dcc,,leaveok} es actualmente @code{True} entonces retorna @code{(-1,-1)}.
@end deffn

@geindex getwin() (en el módulo curses)
@anchor{library/curses curses getwin}@anchor{2dcd}
@deffn {Función} curses.getwin (file)

Read window related data stored in the file by an earlier @ref{2dce,,window.putwin()} call.
The routine then creates and initializes a new window using that data, returning
the new window object.
@end deffn

@geindex has_colors() (en el módulo curses)
@anchor{library/curses curses has_colors}@anchor{2dcf}
@deffn {Función} curses.has_colors ()

Retorna @code{True} si el terminal puede desplegar colores, en caso contrario, retorna @code{False}.
@end deffn

@geindex has_extended_color_support() (en el módulo curses)
@anchor{library/curses curses has_extended_color_support}@anchor{88c}
@deffn {Función} curses.has_extended_color_support ()

Retorna @code{True} si el módulo admite soporte de color extendido; de lo contrario retorna @code{False}. El soporte de color extendido permite más de 256 pares de colores para terminales que admiten más de 16 colores (por ejemplo, xterm-256color).

El soporte de color extendido requiere ncurses versión 6.1 o posterior.


Added in version 3.10.

@end deffn

@geindex has_ic() (en el módulo curses)
@anchor{library/curses curses has_ic}@anchor{2dd0}
@deffn {Función} curses.has_ic ()

Retorna @code{True} si el terminal tiene la capacidad de insertar y eliminar caracteres.  Esta función es incluida por razones históricas solamente, ya que todos los emuladores de la terminal de software modernos tienen tales capacidades.
@end deffn

@geindex has_il() (en el módulo curses)
@anchor{library/curses curses has_il}@anchor{2dd1}
@deffn {Función} curses.has_il ()

Retorna @code{True} si la terminal tiene la capacidad de insertar y eliminar caracteres o pueden simularlos usando las regiones de desplazamiento.  Esta función es incluida por razones históricas solamente, como todos los emuladores de terminales de software modernos tienen tales capacidades.
@end deffn

@geindex has_key() (en el módulo curses)
@anchor{library/curses curses has_key}@anchor{2dd2}
@deffn {Función} curses.has_key (ch)

Toma una clave valor `ch', y retorna @code{True} si el tipo de terminal actual reconoce una clave con ese valor.
@end deffn

@geindex halfdelay() (en el módulo curses)
@anchor{library/curses curses halfdelay}@anchor{2dd3}
@deffn {Función} curses.halfdelay (tenths)

Usado por el modo de medio retardo, el cual es similar al modo `cbreak' en que los caracteres escritos por el usuario están disponibles inmediatamente para el programa.  Sin embargo, después de bloquearlos por `tenths' décimas de segundos, se lanza una excepción si nada ha sido escrito. El valor de `tenths' debe ser un número entre @code{1} y @code{255}.  Use @ref{2dd4,,nocbreak()} para salir del modo de medio retardo.
@end deffn

@geindex init_color() (en el módulo curses)
@anchor{library/curses curses init_color}@anchor{889}
@deffn {Función} curses.init_color (color_number, r, g, b)

Change the definition of a color, taking the number of the color to be changed
followed by three RGB values (for the amounts of red, green, and blue
components).  The value of `color_number' must be between @code{0} and
@code{COLORS - 1}.  Each of `r', `g', `b', must be a value between @code{0} and
@code{1000}.  When @ref{889,,init_color()} is used, all occurrences of that color on the
screen immediately change to the new definition.  This function is a no-op on
most terminals; it is active only if @ref{2da9,,can_change_color()} returns @code{True}.
@end deffn

@geindex init_pair() (en el módulo curses)
@anchor{library/curses curses init_pair}@anchor{88a}
@deffn {Función} curses.init_pair (pair_number, fg, bg)

Cambia la definición de un par de colores. Se necesitan tres argumentos: el número del par de colores que se va a cambiar, el número de color de primer plano y el número de color de fondo. El valor de `par_number' debe estar entre @code{1} y @code{COLOR_PAIRS-1} (el par de colores @code{0} está conectado a blanco sobre negro y no se puede cambiar). El valor de los argumentos `fg' y `bg' debe estar entre @code{0} y @code{COLORS-1} o, después de llamar a @ref{2dd5,,use_default_colors()}, @code{-1}. Si el par de colores se inicializó previamente, la pantalla se actualiza y todas las apariciones de ese par de colores se cambian a la nueva definición.
@end deffn

@geindex initscr() (en el módulo curses)
@anchor{library/curses curses initscr}@anchor{15a3}
@deffn {Función} curses.initscr ()

Inicializa la librería. Retorna un objeto @ref{161f,,window} el cual representa a toda la pantalla.

@cartouche
@quotation Nota 
Si hay un error al abrir el terminal, la librería curses subyacente puede causar que el interprete salga.
@end quotation
@end cartouche
@end deffn

@geindex is_term_resized() (en el módulo curses)
@anchor{library/curses curses is_term_resized}@anchor{2dd6}
@deffn {Función} curses.is_term_resized (nlines, ncols)

Retorna @code{True} si @ref{15c5,,resize_term()} modificaría la estructura de la ventana, @code{False} en caso contrario.
@end deffn

@geindex isendwin() (en el módulo curses)
@anchor{library/curses curses isendwin}@anchor{2dd7}
@deffn {Función} curses.isendwin ()

Retorna @code{True} si @ref{2dbb,,endwin()} ha sido llamado (eso es que la librería curses ha sido desinicializada).
@end deffn

@geindex keyname() (en el módulo curses)
@anchor{library/curses curses keyname}@anchor{2dd8}
@deffn {Función} curses.keyname (k)

Retorna el nombre de la tecla enumerada `k' como un objeto de bytes.  El nombre de una tecla que genera un carácter ASCII imprimible es el carácter de la tecla.  El nombre de una combinación de teclas de control es un consistente objeto de bytes de dos bytes de un signo de intercalación (@code{b'^'}) seguido por el correspondiente carácter ASCII imprimible. El nombre de una combinación de tecla `alt' (128-255) es un objeto de bytes consistente del prefijo @code{b'M-'} seguido por el nombre del correspondiente carácter ASCII.
@end deffn

@geindex killchar() (en el módulo curses)
@anchor{library/curses curses killchar}@anchor{2dd9}
@deffn {Función} curses.killchar ()

Retorna el carácter de eliminación de la línea actual del usuario como un objeto de bytes de un byte.  Bajo el sistema operativo Unix esta es una propiedad del controlador `tty' del programa `curses', y no está configurado por la librería `curses' por sí mismo.
@end deffn

@geindex longname() (en el módulo curses)
@anchor{library/curses curses longname}@anchor{2dda}
@deffn {Función} curses.longname ()

Retorna un objeto de bytes que contiene el campo de nombre largo `terminfo' que describe el terminal actual.  La longitud máxima de una descripción verbosa es 128 caracteres.  Esto es definido solamente después de la llamada a @ref{15a3,,initscr()}.
@end deffn

@geindex meta() (en el módulo curses)
@anchor{library/curses curses meta}@anchor{2ddb}
@deffn {Función} curses.meta (flag)

Si `flag' es @code{True}, permite caracteres de 8 bits para ser introducidos.  Si `flag' es @code{False}, permite solamente caracteres de 7 bits.
@end deffn

@geindex mouseinterval() (en el módulo curses)
@anchor{library/curses curses mouseinterval}@anchor{2ddc}
@deffn {Función} curses.mouseinterval (interval)

Set the maximum time in milliseconds that can elapse between press and release
events in order for them to be recognized as a click, and return the previous
interval value.  The default value is 200 milliseconds, or one fifth of a second.
@end deffn

@geindex mousemask() (en el módulo curses)
@anchor{library/curses curses mousemask}@anchor{2ddd}
@deffn {Función} curses.mousemask (mousemask)

Configure los eventos del mouse para ser reportados, y retorna una tupla @code{(availmask, oldmask)}. `availmask' indica cual de los eventos del ratón especificados pueden ser reportados; en caso de falla completa retorna @code{0}.  `oldmask' es el valor previo de la máscara de evento del mouse de la ventana dada.  Si esta función nunca es llamada, los eventos del mouse nunca son reportados.
@end deffn

@geindex napms() (en el módulo curses)
@anchor{library/curses curses napms}@anchor{15a2}
@deffn {Función} curses.napms (ms)

Duerme durante `ms' milisegundos.
@end deffn

@geindex newpad() (en el módulo curses)
@anchor{library/curses curses newpad}@anchor{2dde}
@deffn {Función} curses.newpad (nlines, ncols)

Crea y retorna un apuntador para una nueva estructura de datos de `pad' con el número dado de líneas y columnas.  Retorna un `pad' como un objeto de ventana.

Una almohadilla es como una ventana, excepto que no es restringida por el tamaño de la pantalla, y no está necesariamente asociada con una parte particular de la pantalla.  Las almohadillas pueden ser usadas cuando un ventana grande es necesitada, y solamente una parte de la ventana estará en la pantalla de una sola vez.  Actualizaciones automáticas de almohadillas (tales desde el desplazamiento o haciendo eco de la entrada) no ocurre.  Los métodos @ref{2db9,,refresh()} y @ref{2db7,,noutrefresh()} de una almohadilla requiere 6 argumentos para especificar la parte de la almohadilla a ser mostrada y la locación en la ventana que se utilizará para la visualización.  Los argumentos son `pminrow', `pmincol', `sminrow', `smincol', `smaxrow', `smaxcol'; el argumento `p' se refiere a la esquina superior izquierda de la región de la almohadilla a ser mostrada y el argumento `s' define una caja de recorte en la pantalla con la cual la región de la almohadilla será mostrada.
@end deffn

@geindex newwin() (en el módulo curses)
@anchor{library/curses curses newwin}@anchor{2ddf}
@deffn {Función} curses.newwin (nlines, ncols)

@deffnx {Función} curses.newwin (nlines, ncols, begin_y, begin_x)

Retorna una nueva @ref{161f,,window}, cuya esquina superior izquierda esta en @code{(begin_y, begin_x)}, y cuyo alto/ancho es `nlines'/`ncols'.

Por defecto, la ventana extenderá desde la posición especificada para la esquina inferior derecha de la pantalla.
@end deffn

@geindex nl() (en el módulo curses)
@anchor{library/curses curses nl}@anchor{2de0}
@deffn {Función} curses.nl ()

Ingrese al modo de línea nueva.  Este modo pone la tecla de retorno en una nueva línea en la entrada, y traduce la nueva línea en retorno y avance de línea en la salida. El modo de nueva línea está inicialmente encendida.
@end deffn

@geindex nocbreak() (en el módulo curses)
@anchor{library/curses curses nocbreak}@anchor{2dd4}
@deffn {Función} curses.nocbreak ()

Salir del modo `cbreak'.  Retorne al modo normal «cooked» con la línea del búfer.
@end deffn

@geindex noecho() (en el módulo curses)
@anchor{library/curses curses noecho}@anchor{2de1}
@deffn {Función} curses.noecho ()

Salir del modo echo. El eco de los caracteres de entrada está desactivado.
@end deffn

@geindex nonl() (en el módulo curses)
@anchor{library/curses curses nonl}@anchor{2de2}
@deffn {Función} curses.nonl ()

Dejar el modo de nueva línea. Desactiva la traducción de retorno en una nueva línea en la entrada, y desactiva la traducción a bajo nivel de una nueva línea en nueva línea/retorno en la salida (pero esto no cambia el comportamiento de @code{addch('\n')}, el cual siempre es el equivalente de retornar y avanzar la línea en la pantalla virtual). Con las traducciones apagadas, `curses' puede aumentar algunas veces la velocidad del movimiento vertical un poco; también, estará disponible para detectar la tecla de retorno en la entrada.
@end deffn

@geindex noqiflush() (en el módulo curses)
@anchor{library/curses curses noqiflush}@anchor{2de3}
@deffn {Función} curses.noqiflush ()

Cuando la rutina @code{noqiflush()} es usada, descarga normal de colas de entrada y salida asociadas con el @code{INTR}, los caracteres @code{QUIT} and @code{SUSP} no serán hechos.  Puedes querer llamar @code{noqiflush()} en un manejador de señales si quieres que la salida continúe como si la interrupción no hubiera ocurrido después de que el manejador exista.
@end deffn

@geindex noraw() (en el módulo curses)
@anchor{library/curses curses noraw}@anchor{2de4}
@deffn {Función} curses.noraw ()

Salir del modo raw. Retorna al modo normal «cooked» con la línea del búfer.
@end deffn

@geindex pair_content() (en el módulo curses)
@anchor{library/curses curses pair_content}@anchor{88b}
@deffn {Función} curses.pair_content (pair_number)

Retorna una tupla @code{(fg, bg)} conteniendo los colores del par de color solicitado. El valor de `pair_number' debe ser entre @code{0} y @code{COLOR_PAIRS-1}.
@end deffn

@geindex pair_number() (en el módulo curses)
@anchor{library/curses curses pair_number}@anchor{2daf}
@deffn {Función} curses.pair_number (attr)

Retorna el numero del conjunto de pares de colores para el valor del atributo `attr'. @ref{2dac,,color_pair()} es la contraparte de esta función.
@end deffn

@geindex putp() (en el módulo curses)
@anchor{library/curses curses putp}@anchor{2de5}
@deffn {Función} curses.putp (str)

Equivalente a @code{tputs(str, 1, putchar)}; emite el valor de una capacidad especificada `terminfo' para el terminal actual. Nota que la salida de @ref{2de5,,putp()} siempre va a la salida estándar.
@end deffn

@geindex qiflush() (en el módulo curses)
@anchor{library/curses curses qiflush}@anchor{2de6}
@deffn {Función} curses.qiflush ([flag])

Si `flag' es @code{False}, el efecto es el mismo como llamar @ref{2de3,,noqiflush()}.  Si `flag' es @code{True},  o el argumento no es proveído, la cola será nivelada cuando estos caracteres de control son leídos.
@end deffn

@geindex raw() (en el módulo curses)
@anchor{library/curses curses raw}@anchor{2dab}
@deffn {Función} curses.raw ()

Entrar al modo crudo.  En el modo crudo, el almacenamiento en búfer de la línea normal y procesamiento de las teclas de interrupción, salida, suspensión y control de flujo son apagadas; los caracteres son presentados a la función de entrada de `curses' una por una.
@end deffn

@geindex reset_prog_mode() (en el módulo curses)
@anchor{library/curses curses reset_prog_mode}@anchor{2db2}
@deffn {Función} curses.reset_prog_mode ()

Restaura la terminal para el modo «program», anteriormente guardado por @ref{2db1,,def_prog_mode()}.
@end deffn

@geindex reset_shell_mode() (en el módulo curses)
@anchor{library/curses curses reset_shell_mode}@anchor{2db4}
@deffn {Función} curses.reset_shell_mode ()

Restablece el terminal al modo «shell» como lo guardó previamente @ref{2db3,,def_shell_mode()}.
@end deffn

@geindex resetty() (en el módulo curses)
@anchor{library/curses curses resetty}@anchor{2de7}
@deffn {Función} curses.resetty ()

Restablece el estado del modo del terminal para lo que esto fue en el último llamado a @ref{2de8,,savetty()}.
@end deffn

@geindex resize_term() (en el módulo curses)
@anchor{library/curses curses resize_term}@anchor{15c5}
@deffn {Función} curses.resize_term (nlines, ncols)

La función `backend' usada por @ref{15c4,,resizeterm()}, caracteriza más de el trabajo; cuando se redimensiona la ventana, @ref{15c5,,resize_term()} los rellenos blancos de las áreas que son extendidas.  La aplicación de llamada llenaría en estas áreas con datos apropiados.  La función @code{resize_term()} intenta redimensionar todas las ventanas.  Sin embargo, debido a la convención de llamadas del las almohadillas, esto no es posible para redimensionar estos sin interacciones adicionales con la aplicación.
@end deffn

@geindex resizeterm() (en el módulo curses)
@anchor{library/curses curses resizeterm}@anchor{15c4}
@deffn {Función} curses.resizeterm (nlines, ncols)

Ajusta el tamaño al estándar y la ventana actual para las dimensiones especificadas, y ajusta otros datos contables usados por la librería `curses' que registra las dimensiones de la ventana (en particular el manejador SIGWINCH ).
@end deffn

@geindex savetty() (en el módulo curses)
@anchor{library/curses curses savetty}@anchor{2de8}
@deffn {Función} curses.savetty ()

Guarda el estado actual del modo del terminal en un búfer, usable por @ref{2de7,,resetty()}.
@end deffn

@geindex get_escdelay() (en el módulo curses)
@anchor{library/curses curses get_escdelay}@anchor{986}
@deffn {Función} curses.get_escdelay ()

Recupera el valor establecido por @ref{987,,set_escdelay()}.


Added in version 3.9.

@end deffn

@geindex set_escdelay() (en el módulo curses)
@anchor{library/curses curses set_escdelay}@anchor{987}
@deffn {Función} curses.set_escdelay (ms)

Establece el número de milisegundos de espera después de leer un carácter de escape, para distinguir entre un carácter de escape individual ingresado en el teclado de las secuencias de escape enviadas por el cursor y las teclas de función.


Added in version 3.9.

@end deffn

@geindex get_tabsize() (en el módulo curses)
@anchor{library/curses curses get_tabsize}@anchor{988}
@deffn {Función} curses.get_tabsize ()

Recupera el valor establecido por @ref{989,,set_tabsize()}.


Added in version 3.9.

@end deffn

@geindex set_tabsize() (en el módulo curses)
@anchor{library/curses curses set_tabsize}@anchor{989}
@deffn {Función} curses.set_tabsize (size)

Establece el número de columnas utilizadas por la biblioteca de curses al convertir un carácter de tabulación en espacios, ya que agrega la tabulación a una ventana.


Added in version 3.9.

@end deffn

@geindex setsyx() (en el módulo curses)
@anchor{library/curses curses setsyx}@anchor{2de9}
@deffn {Función} curses.setsyx (y, x)

Fija el cursor de la pantalla virtual para `y', `x'.  Si `y' y `x' son ambos «-1», entonces @ref{2dcc,,leaveok} es configurado @code{True}.
@end deffn

@geindex setupterm() (en el módulo curses)
@anchor{library/curses curses setupterm}@anchor{2dea}
@deffn {Función} curses.setupterm (term=None, fd=-1)

Inicializa la terminal.  `term' es una cadena de caracteres dando el nombre de la terminal, o @code{None}; si es omitido o @code{None}, el valor de la variable de entorno 
@geindex TERM
@geindex variables de entorno; TERM
@code{TERM} será usada.  `fd' es el archivo descriptor al cual alguna secuencia de inicialización será enviada; si no es suministrada o @code{-1}, el archivo descriptor para @code{sys.stdout} será usado.
@end deffn

@geindex start_color() (en el módulo curses)
@anchor{library/curses curses start_color}@anchor{2deb}
@deffn {Función} curses.start_color ()

Debe ser llamado si el programador quiere usar colores, y antes de que cualquier otra rutina de manipulación de colores sea llamada. Esta es una buena práctica para llamar esta rutina inmediatamente después de @ref{15a3,,initscr()}.

@ref{2deb,,start_color()} inicializa ocho colores básicos (negro, rojo, verde, amarillo, azul, magenta, cian, y blanco), y dos variables globales en el módulo @ref{2c,,curses}, @ref{2dec,,COLORS} y @ref{2ded,,COLOR_PAIRS}, contiene el número máximo de colores y los pares de colores que la terminal puede soportar.  Esto también restaura los colores en la terminal para los valores que ellos tienen cuando la terminal fue solo activada.
@end deffn

@geindex termattrs() (en el módulo curses)
@anchor{library/curses curses termattrs}@anchor{2dee}
@deffn {Función} curses.termattrs ()

Retorna un `OR' lógico de todos los atributos del video soportados por el terminal.  Esta información es útil cuando un programa `curses' necesita completar el control sobre la apariencia de la pantalla.
@end deffn

@geindex termname() (en el módulo curses)
@anchor{library/curses curses termname}@anchor{2def}
@deffn {Función} curses.termname ()

Retorna el valor de la variable de entorno 
@geindex TERM
@geindex variables de entorno; TERM
@code{TERM}, como un objeto de bytes, trucado para 14 caracteres.
@end deffn

@geindex tigetflag() (en el módulo curses)
@anchor{library/curses curses tigetflag}@anchor{2df0}
@deffn {Función} curses.tigetflag (capname)

Retorna el valor de la capacidad booleana correspondiente al nombre de la capacidad `terminfo' `capname' como un número entero.  Retorna el valor @code{-1} si `capname' no es una capacidad booleana, o @code{0} si es cancelada o ausente desde la descripción de la terminal.
@end deffn

@geindex tigetnum() (en el módulo curses)
@anchor{library/curses curses tigetnum}@anchor{2df1}
@deffn {Función} curses.tigetnum (capname)

Retorna el valor de la capacidad numérica correspondiente al nombre de la capacidad `terminfo' `capname' como un entero.  Regresa el valor @code{-2} si `capname' no es una capacidad numérica, o @code{-1} si esta es cancelada o ausente desde la descripción del terminal.
@end deffn

@geindex tigetstr() (en el módulo curses)
@anchor{library/curses curses tigetstr}@anchor{2df2}
@deffn {Función} curses.tigetstr (capname)

Retorna el valor de la capacidad de la cadena de caracteres correspondiente al nombre de la capacidad `terminfo' `capname' como un objeto de bytes.  Retorna @code{None} si `capname' no es una «capacidad de cadena de caracteres» de `terminfo', o es cancelada o ausente desde la descripción de la terminal.
@end deffn

@geindex tparm() (en el módulo curses)
@anchor{library/curses curses tparm}@anchor{2df3}
@deffn {Función} curses.tparm (str[, ...])

Instancia del objeto de bytes `str' con los parámetros suministrados, dónde `str' sería un cadena de caracteres parametrizada obtenida desde la base de datos de `terminfo'.  E.g. @code{tparm(tigetstr("cup"), 5, 3)} podría resultar en @code{b'\033[6;4H'}, el resultado exacto depende del tipo de terminal.
@end deffn

@geindex typeahead() (en el módulo curses)
@anchor{library/curses curses typeahead}@anchor{2df4}
@deffn {Función} curses.typeahead (fd)

Especifica que el descriptor de archivo `fd' es usado para la verificación anticipada. Si `fd' es «-1», entonces no se realiza ninguna verificación anticipada.

La librería `curses' hace «la optimización del rompimiento de línea» por la búsqueda para mecanografiar periódicamente mientras se actualiza la pantalla.  Si la entrada es encontrada, y viene desde un `tty', la actualización actual es pospuesta hasta que se vuelva a llamar la actualización, permitiendo la respuesta más rápida para comandos escritos en avance.  Esta función permite especificar un archivo diferente al descriptor para la verificación anticipada.
@end deffn

@geindex unctrl() (en el módulo curses)
@anchor{library/curses curses unctrl}@anchor{2df5}
@deffn {Función} curses.unctrl (ch)

Regresa un objeto de bytes el cual es una representación imprimible del carácter `ch'.  Los caracteres de control son representados como un símbolo de intercalación seguido del carácter, por ejemplo como @code{b'^C'}.  La impresión de caracteres son dejados como están.
@end deffn

@geindex ungetch() (en el módulo curses)
@anchor{library/curses curses ungetch}@anchor{2df6}
@deffn {Función} curses.ungetch (ch)

Presiona `ch' para que el siguiente @ref{2dc1,,getch()} lo retorne.

@cartouche
@quotation Nota 
Solamente un `ch' puede ser colocado antes @code{getch()} es llamada.
@end quotation
@end cartouche
@end deffn

@geindex update_lines_cols() (en el módulo curses)
@anchor{library/curses curses update_lines_cols}@anchor{e71}
@deffn {Función} curses.update_lines_cols ()

Update the @ref{1711,,LINES} and @ref{1712,,COLS} module variables.
Useful for detecting manual screen resize.


Added in version 3.5.

@end deffn

@geindex unget_wch() (en el módulo curses)
@anchor{library/curses curses unget_wch}@anchor{1114}
@deffn {Función} curses.unget_wch (ch)

Presiona `ch' para que el siguiente @ref{1113,,get_wch()} lo retorne.

@cartouche
@quotation Nota 
Solamente un `ch' puede ser presionado antes @code{get_wch()} es llamada.
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex ungetmouse() (en el módulo curses)
@anchor{library/curses curses ungetmouse}@anchor{2df7}
@deffn {Función} curses.ungetmouse (id, x, y, z, bstate)

Coloca un evento @ref{2dc2,,KEY_MOUSE} en la cola de entrada, asociando el estado de los datos dados con esto.
@end deffn

@geindex use_env() (en el módulo curses)
@anchor{library/curses curses use_env}@anchor{2df8}
@deffn {Función} curses.use_env (flag)

Si es usado, esta función sería llamada antes de @ref{15a3,,initscr()} o `newterm' son llamados.  Cuando `flag' es @code{False}, los valores de líneas y columnas especificadas en la base de datos `terminfo' será usado, incluso si las variables de entorno 
@geindex LINES
@geindex variables de entorno; LINES
@code{LINES} y 
@geindex COLUMNS
@geindex variables de entorno; COLUMNS
@code{COLUMNS} (usadas por defecto) son configuradas, o si `curses' está corriendo en una ventana (en cuyo caso el comportamiento por defecto sería usar el tamaño de ventana si 
@geindex LINES
@geindex variables de entorno; LINES
@code{LINES} y 
@geindex COLUMNS
@geindex variables de entorno; COLUMNS
@code{COLUMNS} no están configuradas).
@end deffn

@geindex use_default_colors() (en el módulo curses)
@anchor{library/curses curses use_default_colors}@anchor{2dd5}
@deffn {Función} curses.use_default_colors ()

Permite usar valores por defecto para los colores en terminales apoyando esta característica.  Use esto para apoyar la transparencia en tu aplicación.  El color por defecto es asignada para el número de color @code{-1}.  Después de llamar esta función, inicializa @code{init_pair(x, curses.COLOR_RED, -1)}, por ejemplo, los pares de color `x' a un primer plano de color rojo en el fondo por defecto.
@end deffn

@geindex wrapper() (en el módulo curses)
@anchor{library/curses curses wrapper}@anchor{b0d}
@deffn {Función} curses.wrapper (func, /, *args, **kwargs)

Inicializa `curses' y llama a otro objeto invocable, `func', el cual debería ser el resto de tu aplicación que usa `curses'.  Si la aplicación lanza una excepción, esta función restaurará la terminal para un estado sano antes de re-lanzar la excepción y generar un una pista.  El objeto invocable `func' es entonces pasado a la ventana principal “stdscr” como su primer argumento, seguido por algún otro argumento pasado a @code{wrapper()}.  Antes de llamar a `func', @code{wrapper()} habilita el modo `cbreak', desactiva echo, permite el teclado del terminal, e inicializa los colores si la terminal tiene soporte de color.  En salida (ya sea normal o por excepción) esto restaura el modo `cooked', habilita el echo, y desactiva el teclado del terminal.
@end deffn

@node Objetos de ventana,Constantes<6>,Funciones<4>,curses — Terminal handling for character-cell displays
@anchor{library/curses curses-window-objects}@anchor{161f}@anchor{library/curses window-objects}@anchor{2df9}
@subsubsection Objetos de ventana


Los objetos ventana, retornados por @ref{15a3,,initscr()} y @ref{2ddf,,newwin()} anteriores, tienen los siguientes métodos y atributos:

@geindex addch() (método de curses.window)
@anchor{library/curses curses window addch}@anchor{2dfa}
@deffn {Método} window.addch (ch[, attr])

@deffnx {Método} window.addch (y, x, ch[, attr])

Pinta el carácter `ch' en @code{(y, x)} con atributos `attr', sobrescribiendo cualquier carácter pintado previamente en esa ubicación. De forma predeterminada, la posición y los atributos del carácter son la configuración actual del objeto ventana.

@cartouche
@quotation Nota 
Escribiendo afuera de la ventana, sub-ventana, o `pad' genera un @ref{2da5,,curses.error}.  Intentando escribir en la esquina inferior derecha de una ventana, sub-ventana, o `pad' causará una excepción a ser generada después de que el carácter es pintado.
@end quotation
@end cartouche
@end deffn

@geindex addnstr() (método de curses.window)
@anchor{library/curses curses window addnstr}@anchor{2dfb}
@deffn {Método} window.addnstr (str, n[, attr])

@deffnx {Método} window.addnstr (y, x, str, n[, attr])

Pintar como máximo `n' caracteres de la cadena de texto `str' en «(y,x)» con atributos `attr', sobrescribiendo algo previamente en la pantalla.
@end deffn

@geindex addstr() (método de curses.window)
@anchor{library/curses curses window addstr}@anchor{2db8}
@deffn {Método} window.addstr (str[, attr])

@deffnx {Método} window.addstr (y, x, str[, attr])

Dibuja la cadena de caracteres `str' en «(y,x)» con atributos `attr', sobrescribiendo cualquier cosa previamente en la pantalla.

@cartouche
@quotation Nota 

@itemize *

@item 
Escribiendo afuera de la ventana, sub-ventana, o `pad' genera un @ref{2da5,,curses.error}.  Intentando escribir en la esquina inferior derecha de una ventana, sub-ventana, o `pad' causará una excepción a ser generada después de que la cadena de caracteres es pintada.

@item 
Un bug en *ncurses*@footnote{https://bugs.python.org/issue35924}, el `backend' para este módulo de Python, puede causar `SegFaults' cuando re-dimensionan las ventanas.  Esto es reparado en ncurses-6.1-20190511.  Si tu estás atascado con un `ncurses' anterior, puedes evitar desencadenar este si no llamas @ref{2db8,,addstr()}  con un `str' que tiene embebido nuevas líneas.  En su lugar, llama @ref{2db8,,addstr()} separadamente por cada línea.
@end itemize
@end quotation
@end cartouche
@end deffn

@geindex attroff() (método de curses.window)
@anchor{library/curses curses window attroff}@anchor{2dfc}
@deffn {Método} window.attroff (attr)

Remueve el atributo `attr' desde el conjunto «background» aplicado a todos los escritos para la ventana actual.
@end deffn

@geindex attron() (método de curses.window)
@anchor{library/curses curses window attron}@anchor{2dfd}
@deffn {Método} window.attron (attr)

Añade el atributo `attr' del conjunto del «background» aplicado para todas las escrituras de la ventana actual.
@end deffn

@geindex attrset() (método de curses.window)
@anchor{library/curses curses window attrset}@anchor{2dfe}
@deffn {Método} window.attrset (attr)

Establezca el conjunto de atributos «background para `attr'.  Este conjunto es inicialmente «0» (sin atributos).
@end deffn

@geindex bkgd() (método de curses.window)
@anchor{library/curses curses window bkgd}@anchor{2dff}
@deffn {Método} window.bkgd (ch[, attr])

Configura la propiedad de fondo de la ventana para el carácter `ch', con atributos `atte'.  El cambio es entonces aplicado para la posición de cada carácter en esa ventana:


@itemize *

@item 
El atributo de cada carácter en la ventana es cambiado por el nuevo atributo de fondo.

@item 
Dónde quiera que el carácter del fondo anterior aparezca, es cambiado al nuevo carácter de fondo.
@end itemize
@end deffn

@geindex bkgdset() (método de curses.window)
@anchor{library/curses curses window bkgdset}@anchor{2e00}
@deffn {Método} window.bkgdset (ch[, attr])

Configura el fondo de la ventana.  Un fondo de ventana consiste de un carácter y cualquier combinación de atributos.  La parte del atributo del fondo es combinado (OR” ed) con todos los caracteres que no son blancos escritos en la ventana.  Tanto las partes del carácter y del atributo del fondo son combinados con los caracteres en blanco.  El fondo se convierte en una propiedad del carácter y se mueve con el carácter a través de cualquier operación de desplazamiento e inserción/eliminación de línea/carácter.
@end deffn

@geindex border() (método de curses.window)
@anchor{library/curses curses window border}@anchor{2e01}
@deffn {Método} window.border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

Dibuja un borde alrededor de las orillas de la ventana.  Cada parámetro especifica el carácter a usar para una parte específica del borde; ve la tabla abajo para más detalles.

@cartouche
@quotation Nota 
Un valor @code{0} para cualquier parámetro causará el carácter por defecto a ser usado para ese parámetro. parámetros de palabras clave pueden `no' ser usados. Los valores predeterminados son listados en esta tabla:
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Parámetro

@tab

Descripción

@tab

Valor por defecto

@item

`ls'

@tab

Lado izquierdo

@tab

@ref{2e02,,ACS_VLINE}

@item

`rs'

@tab

Lado derecho

@tab

@ref{2e02,,ACS_VLINE}

@item

`ts'

@tab

Arriba

@tab

@ref{2e03,,ACS_HLINE}

@item

`bs'

@tab

Abajo

@tab

@ref{2e03,,ACS_HLINE}

@item

`tl'

@tab

Esquina superior izquierda

@tab

@ref{2e04,,ACS_ULCORNER}

@item

`tr'

@tab

Esquina superior derecha

@tab

@ref{2e05,,ACS_URCORNER}

@item

`bl'

@tab

Esquina inferior izquierda

@tab

@ref{2e06,,ACS_LLCORNER}

@item

`br'

@tab

Esquina inferior derecha

@tab

@ref{2e07,,ACS_LRCORNER}

@end multitable

@end deffn

@geindex box() (método de curses.window)
@anchor{library/curses curses window box}@anchor{2e08}
@deffn {Método} window.box ([vertch, horch])

Similar a @ref{2e01,,border()}, pero ambos `ls y *rs' son `vertch' y ambos `ts' y `bs' son `horch'.  Los caracteres de esquina predeterminados son siempre usados por esta función.
@end deffn

@geindex chgat() (método de curses.window)
@anchor{library/curses curses window chgat}@anchor{2e09}
@deffn {Método} window.chgat (attr)

@deffnx {Método} window.chgat (num, attr)

@deffnx {Método} window.chgat (y, x, attr)

@deffnx {Método} window.chgat (y, x, num, attr)

Configura los atributos de `num' de caracteres en la posición del cursor, o una posición @code{(y, x)} si es suministrado.  Si `num' no es dado o es @code{-1}, el atributo será configurado en todos los caracteres para el final de la línea.  Esta función mueve el cursor a la posición @code{(y, x)} si es suministrado.  La línea cambiada será tocada usando el método @ref{2e0a,,touchline()} tal que el contenido será vuelto a mostrar por la actualización de la siguiente ventana.
@end deffn

@geindex clear() (método de curses.window)
@anchor{library/curses curses window clear}@anchor{2e0b}
@deffn {Método} window.clear ()

Semejante a @ref{2e0c,,erase()}, pero también causa que toda la ventana sea repintada sobre la siguiente llamada para @ref{2db9,,refresh()}.
@end deffn

@geindex clearok() (método de curses.window)
@anchor{library/curses curses window clearok}@anchor{2e0d}
@deffn {Método} window.clearok (flag)

Si `flag' es @code{True}, la siguiente llamada para @ref{2db9,,refresh()} limpiará la ventana completamente.
@end deffn

@geindex clrtobot() (método de curses.window)
@anchor{library/curses curses window clrtobot}@anchor{2e0e}
@deffn {Método} window.clrtobot ()

Borrar desde el cursor hasta el final de la ventana: todas las líneas bajo el cursor son eliminadas, y entonces el equivalente de @ref{2e0f,,clrtoeol()} es realizado.
@end deffn

@geindex clrtoeol() (método de curses.window)
@anchor{library/curses curses window clrtoeol}@anchor{2e0f}
@deffn {Método} window.clrtoeol ()

Borrar desde el cursor hasta el final de la línea.
@end deffn

@geindex cursyncup() (método de curses.window)
@anchor{library/curses curses window cursyncup}@anchor{2e10}
@deffn {Método} window.cursyncup ()

Actualice la posición actual del cursor de todos los ancestros de la ventana para reflejar la posición actual del cursor de la ventana.
@end deffn

@geindex delch() (método de curses.window)
@anchor{library/curses curses window delch}@anchor{2e11}
@deffn {Método} window.delch ([y, x])

Borrar cualquier carácter en «(y,x)».
@end deffn

@geindex deleteln() (método de curses.window)
@anchor{library/curses curses window deleteln}@anchor{2e12}
@deffn {Método} window.deleteln ()

Borra la línea bajo el cursor.  Todas las líneas siguientes son movidas una línea hacía arriba.
@end deffn

@geindex derwin() (método de curses.window)
@anchor{library/curses curses window derwin}@anchor{2e13}
@deffn {Método} window.derwin (begin_y, begin_x)

@deffnx {Método} window.derwin (nlines, ncols, begin_y, begin_x)

Una abreviación para «ventana derivada», @ref{2e13,,derwin()} es el mismo cómo llamar @ref{2e14,,subwin()}, excepto que `begin_y' y `begin_x' son relativos al origen de la ventana, más bien relativo a la pantalla completa.  Retorna un objeto ventana para la ventana derivada.
@end deffn

@geindex echochar() (método de curses.window)
@anchor{library/curses curses window echochar}@anchor{2e15}
@deffn {Método} window.echochar (ch[, attr])

Añada el carácter `ch' con atributo `attr', e inmediatamente llame a @ref{2db9,,refresh()} en la ventana.
@end deffn

@geindex enclose() (método de curses.window)
@anchor{library/curses curses window enclose}@anchor{18e0}
@deffn {Método} window.enclose (y, x)

Pruebe si el par dado de las coordenadas de celda del carácter relativas de la ventana son encerrados por la ventana dada, retornando @code{True} o @code{False}. Esto es útil para determinar que subconjunto de las ventanas de pantalla encierran la locación de un evento del mouse.


Distinto en la versión 3.10: Anteriormente retornaba @code{1} o @code{0} en lugar de @code{True} o @code{False}.

@end deffn

@geindex encoding (atributo de curses.window)
@anchor{library/curses curses window encoding}@anchor{1112}
@deffn {Atributo} window.encoding

Encoding used to encode method arguments (Unicode strings and characters).
The encoding attribute is inherited from the parent window when a subwindow
is created, for example with @ref{2e14,,window.subwin()}.
By default, current locale encoding is used (see @ref{1d3,,locale.getencoding()}).


Added in version 3.3.

@end deffn

@geindex erase() (método de curses.window)
@anchor{library/curses curses window erase}@anchor{2e0c}
@deffn {Método} window.erase ()

Limpiar la ventana.
@end deffn

@geindex getbegyx() (método de curses.window)
@anchor{library/curses curses window getbegyx}@anchor{2e16}
@deffn {Método} window.getbegyx ()

Return a tuple @code{(y, x)} of coordinates of upper-left corner.
@end deffn

@geindex getbkgd() (método de curses.window)
@anchor{library/curses curses window getbkgd}@anchor{2e17}
@deffn {Método} window.getbkgd ()

Retorna el par carácter/atributo dada la ventana actual.
@end deffn

@geindex getch() (método de curses.window)
@anchor{library/curses curses window getch}@anchor{2dc1}
@deffn {Método} window.getch ([y, x])

Obtener un carácter.  Nota que el entero retornado `no' tiene que estar en el rango ASCII: teclas de función, claves de teclado y los demás son representados por números mayores que 255.  En el modo sin demora, retorna @code{-1} si no hay entrada, en caso contrario espere hasta que una tecla es presionada.
@end deffn

@geindex get_wch() (método de curses.window)
@anchor{library/curses curses window get_wch}@anchor{1113}
@deffn {Método} window.get_wch ([y, x])

Obtener un carácter amplio.  Retorna un carácter para la mayoría de las teclas, o un entero para las teclas de función, teclas del teclado, y otras teclas especiales.  En modo de no retorna, genera una excepción si no hay entrada.


Added in version 3.3.

@end deffn

@geindex getkey() (método de curses.window)
@anchor{library/curses curses window getkey}@anchor{2e18}
@deffn {Método} window.getkey ([y, x])

Obtener un carácter, retornando una cadena de caracteres en lugar de un entero, como @ref{2dc1,,getch()} lo hace.  Las teclas de función, teclas del teclado y otras teclas especiales retornan una cadena `multibyte' conteniendo el nombre de la tecla.  En modo de no retardo, genera una excepción si no hay entrada.
@end deffn

@geindex getmaxyx() (método de curses.window)
@anchor{library/curses curses window getmaxyx}@anchor{2e19}
@deffn {Método} window.getmaxyx ()

Retorna una tupla «(y,x)» de el alto y ancho de la ventana.
@end deffn

@geindex getparyx() (método de curses.window)
@anchor{library/curses curses window getparyx}@anchor{2e1a}
@deffn {Método} window.getparyx ()

Retorne las coordenadas iniciales de esta ventana relativa para su ventana padre como una tupla @code{(y, x)}.  Retorna @code{(-1, -1)} si esta ventana no tiene padre.
@end deffn

@geindex getstr() (método de curses.window)
@anchor{library/curses curses window getstr}@anchor{2e1b}
@deffn {Método} window.getstr ()

@deffnx {Método} window.getstr (n)

@deffnx {Método} window.getstr (y, x)

@deffnx {Método} window.getstr (y, x, n)

Lee un objeto de bytes desde el usuario, con capacidad de edición de línea primitiva.
@end deffn

@geindex getyx() (método de curses.window)
@anchor{library/curses curses window getyx}@anchor{2e1c}
@deffn {Método} window.getyx ()

Retorna una tupla @code{(y, x)} de la posición actual del cursor relativa para la esquina superior izquierda de la ventana.
@end deffn

@geindex hline() (método de curses.window)
@anchor{library/curses curses window hline}@anchor{2e1d}
@deffn {Método} window.hline (ch, n)

@deffnx {Método} window.hline (y, x, ch, n)

Muestra una línea horizontal iniciando en @code{(y, x)} con longitud `n' consistente de el carácter `ch'.
@end deffn

@geindex idcok() (método de curses.window)
@anchor{library/curses curses window idcok}@anchor{2e1e}
@deffn {Método} window.idcok (flag)

Si `flag' es @code{False}, `curses' ya no considera el uso de la función de insertar/eliminar caracteres de hardware del terminal; si `flag' @code{True}, el uso de inserción y borrado  de caracteres está habilitado.  Cuando `curses' es inicializado primero, el uso de caracteres de inserción / borrado está habilitado por defecto.
@end deffn

@geindex idlok() (método de curses.window)
@anchor{library/curses curses window idlok}@anchor{2e1f}
@deffn {Método} window.idlok (flag)

Si `flag' es @code{True}, @ref{2c,,curses} tratará y usará las funciones de la línea de edición de hardware.  En caso contrario, la línea inserción/borrado están deshabilitadas.
@end deffn

@geindex immedok() (método de curses.window)
@anchor{library/curses curses window immedok}@anchor{2e20}
@deffn {Método} window.immedok (flag)

Si `flag' es @code{True}, cualquier cambio en la imagen de la ventana automáticamente causará que la ventana sea refrescada; ya no tienes que llamar a @ref{2db9,,refresh()} por ti mismo.  Sin embargo, esto puede degradar el rendimiento considerablemente, debido a las repeticiones de llamada a `wrefresh'.  Esta opción está deshabilitada por defecto.
@end deffn

@geindex inch() (método de curses.window)
@anchor{library/curses curses window inch}@anchor{2e21}
@deffn {Método} window.inch ([y, x])

Retorna el carácter en la posición dada en la ventana.  Los 8bits inferiores son los caracteres propiamente dichos, y los bits superiores son los atributos.
@end deffn

@geindex insch() (método de curses.window)
@anchor{library/curses curses window insch}@anchor{2e22}
@deffn {Método} window.insch (ch[, attr])

@deffnx {Método} window.insch (y, x, ch[, attr])

Pinta el carácter `ch' en @code{(y, x)} con atributos `attr', moviendo la línea desde la posición `x' a la derecha un carácter.
@end deffn

@geindex insdelln() (método de curses.window)
@anchor{library/curses curses window insdelln}@anchor{2e23}
@deffn {Método} window.insdelln (nlines)

Inserta `nlines' líneas en la ventana especificada arriba de la línea actual.  Las `nlines' líneas de fondo se pierden.  Para `nlines' negativos, elimine `nlines' líneas comenzando con la que está debajo del cursor, y mueve las restantes hacia arriba. Se borran las `nlines' líneas inferiores.  La posición del cursor actual se mantiene igual.
@end deffn

@geindex insertln() (método de curses.window)
@anchor{library/curses curses window insertln}@anchor{2e24}
@deffn {Método} window.insertln ()

Inserte una línea en blanco bajo el cursos.  Las líneas siguientes se moverán una línea hacía abajo.
@end deffn

@geindex insnstr() (método de curses.window)
@anchor{library/curses curses window insnstr}@anchor{2e25}
@deffn {Método} window.insnstr (str, n[, attr])

@deffnx {Método} window.insnstr (y, x, str, n[, attr])

Inserte una cadena de caracteres (tantos caracteres quepan en la línea) antes los caracteres bajo el cursor, sobre los `n' caracteres.  Si `n' es cero o negativo, la cadena entera es insertada.  Todos los caracteres a la derecha de el cursor son desplazados a la derecha, perdiéndose los caracteres de la derecha en la línea.  La posición del cursor no cambia (después de mover a `y', `x', si es especificado).
@end deffn

@geindex insstr() (método de curses.window)
@anchor{library/curses curses window insstr}@anchor{2e26}
@deffn {Método} window.insstr (str[, attr])

@deffnx {Método} window.insstr (y, x, str[, attr])

Inserte una cadena de caracteres ( tantos caracteres encajen en la línea) antes los caracteres bajo el cursor.  Todos los caracteres a la derecha de el cursor son desplazados a la derecha, perdiéndose los caracteres de la derecha en línea.
@end deffn

@geindex instr() (método de curses.window)
@anchor{library/curses curses window instr}@anchor{2e27}
@deffn {Método} window.instr ([n])

@deffnx {Método} window.instr (y, x[, n])

Regresa un objeto de bytes de caracteres, extraídos desde la ventana comenzando en la posición actual del cursor, o en `y', `x' si es especificado.  Los atributos son despojados desde los caracteres.  Si `n' es especificado, @ref{2e27,,instr()} retorna una cadena de caracteres como máximo de `n' caracteres (exclusivo de la NULL final).
@end deffn

@geindex is_linetouched() (método de curses.window)
@anchor{library/curses curses window is_linetouched}@anchor{2e28}
@deffn {Método} window.is_linetouched (line)

Retorna @code{True} si la línea especificada fue modificada desde la última llamada a @ref{2db9,,refresh()}; de otra manera retorna @code{False}.  Genera una excepción @ref{2da5,,curses.error} si `line' no es válida para la ventana dada.
@end deffn

@geindex is_wintouched() (método de curses.window)
@anchor{library/curses curses window is_wintouched}@anchor{2e29}
@deffn {Método} window.is_wintouched ()

Retorna @code{True} si la ventana especificada fue modificada desde la última llamada para @ref{2db9,,refresh()}; en caso contrario, retorna @code{False}.
@end deffn

@geindex keypad() (método de curses.window)
@anchor{library/curses curses window keypad}@anchor{2e2a}
@deffn {Método} window.keypad (flag)

Si `flag' es @code{True}, evita las secuencias generadas por algunas teclas (teclado, teclas de función) será interpretadas por @ref{2c,,curses}.  Si `flag' es @code{False}, evita las secuencias que serán dejadas como está en la corriente de entrada.
@end deffn

@geindex leaveok() (método de curses.window)
@anchor{library/curses curses window leaveok}@anchor{2dcc}
@deffn {Método} window.leaveok (flag)

Si `flag' es @code{True}, el cursor es dejado donde está en la actualización, por ejemplo estando en «cursor position.» Esto reduce el movimiento del cursor siempre que sea posible.  Si es posible, el cursor se hará invisible.

Si `flag' es @code{False}, el cursor siempre estará en «cursor position» después de una actualización.
@end deffn

@geindex move() (método de curses.window)
@anchor{library/curses curses window move}@anchor{2e2b}
@deffn {Método} window.move (new_y, new_x)

Mueve el cursor a @code{(new_y, new_x)}.
@end deffn

@geindex mvderwin() (método de curses.window)
@anchor{library/curses curses window mvderwin}@anchor{2e2c}
@deffn {Método} window.mvderwin (y, x)

Mueve la ventana adentro de su ventana padre.  Los parámetros relativos a la pantalla de la ventana no son cambiados.  Esta rutina es usada para mostrar diferentes partes de la ventana padre en la misma posición física en la pantalla.
@end deffn

@geindex mvwin() (método de curses.window)
@anchor{library/curses curses window mvwin}@anchor{2e2d}
@deffn {Método} window.mvwin (new_y, new_x)

Mueve la ventana a su esquina superior izquierda que está en @code{(new_y,new_x)}.
@end deffn

@geindex nodelay() (método de curses.window)
@anchor{library/curses curses window nodelay}@anchor{2e2e}
@deffn {Método} window.nodelay (flag)

Si `flag' es @code{True}, @ref{2dc1,,getch()} no será bloqueada.
@end deffn

@geindex notimeout() (método de curses.window)
@anchor{library/curses curses window notimeout}@anchor{2e2f}
@deffn {Método} window.notimeout (flag)

Si `flag' es @code{True}, las secuencias de escape no serán agotadas.

Si `flag' es @code{False}, después de pocos milisegundos, una secuencia de escape no será interpretada, y será dejada en el flujo de entrada como está.
@end deffn

@geindex noutrefresh() (método de curses.window)
@anchor{library/curses curses window noutrefresh}@anchor{2db7}
@deffn {Método} window.noutrefresh ()

Marque para actualizar pero espere.  Esta función actualiza la estructura de datos representando el estado deseado de la ventana, pero no fuerza una actualización en la pantalla física.  Para realizar eso, llame @ref{2db6,,doupdate()}.
@end deffn

@geindex overlay() (método de curses.window)
@anchor{library/curses curses window overlay}@anchor{2e30}
@deffn {Método} window.overlay (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Cubre la ventana en la parte superior de `destwin'.  La ventana no necesita ser del mismo tamaño, solamente se solapa la región copiada.  Esta copia no es destructiva, lo que significa que el carácter de fondo actual no sobre-escribe el contenido viejo de `destwin'.

Para obtener el control de grano fino sobre la región copiada, la segunda forma de @ref{2e30,,overlay()} puede ser usada.  `sminrow' y `smincol' son las coordenadas superior izquierda de la ventana de origen, y las otras variables marcan un rectángulo en la ventana destino.
@end deffn

@geindex overwrite() (método de curses.window)
@anchor{library/curses curses window overwrite}@anchor{2e31}
@deffn {Método} window.overwrite (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Sobre-escribe la ventana en la parte superior de `destwin'.  La ventana no necesita ser del mismo tamaño, en cuyo caso solamente se sobrepone la región que es copiada.  Esta copia es destructiva, lo cual significa que el carácter de fondo actual sobre-escribe el contenido viejo de `destwin'.

Para obtener el control de grano fino sobre la región copiada, la segunda forma de @ref{2e31,,overwrite()} puede ser usada.  `sminrow' y `smincol' son las coordenadas superior izquierda de la ventana origen, las otras variables marcan un rectángulo en la ventana de destino.
@end deffn

@geindex putwin() (método de curses.window)
@anchor{library/curses curses window putwin}@anchor{2dce}
@deffn {Método} window.putwin (file)

Escribe todos los datos asociados con la ventana en el objeto de archivo proveído.  Esta información puede estar después recuperada usando la función @ref{2dcd,,getwin()}.
@end deffn

@geindex redrawln() (método de curses.window)
@anchor{library/curses curses window redrawln}@anchor{2e32}
@deffn {Método} window.redrawln (beg, num)

Indica que el `num' de líneas de la pantalla, empiezan en la línea `beg', son corruptos y deberían ser completamente redibujado en la siguiente llamada @ref{2db9,,refresh()}.
@end deffn

@geindex redrawwin() (método de curses.window)
@anchor{library/curses curses window redrawwin}@anchor{2e33}
@deffn {Método} window.redrawwin ()

Toca la ventana completa, causando que se vuelva a dibujar completamente en la siguiente llamada @ref{2db9,,refresh()} .
@end deffn

@geindex refresh() (método de curses.window)
@anchor{library/curses curses window refresh}@anchor{2db9}
@deffn {Método} window.refresh ([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

Actualiza la pantalla inmediatamente (sincronice la pantalla actual con los métodos previos de dibujar/borrar).

Los 6 argumentos opcionales pueden ser solamente especificados cuando la ventana es una almohadilla creada con @ref{2dde,,newpad()}.  Los parámetros adicionales son necesarios para indicar que parte de la almohadilla y pantalla son envueltos.  `pminrow' y `pmincol' especifica la esquina superior de la mano izquierda del rectángulo a ser mostrado en el `pad'.  `sminrow', `smincol', `smaxrow', y `smaxcol' especifica los bordes del rectángulo a ser mostrados en la pantalla.  La esquina inferior de la mano derecha del rectángulo a ser mostrado en el `pad' es calculado desde las coordenadas de la pantalla, desde que el rectángulo debe ser del mismo tamaño.  Ambos rectángulos deben ser completamente contenidos con su estructura respectiva.  Valores negativos de `pminrow', `pmincol', `sminrow', o `smincol' son tratados como si fueran cero.
@end deffn

@geindex resize() (método de curses.window)
@anchor{library/curses curses window resize}@anchor{2e34}
@deffn {Método} window.resize (nlines, ncols)

Redistribuir el almacenamiento para una ventana `curses' para ajustar su dimensión para los valores especificados.  Si la dimensión también es mayor que los valores actuales, los datos de la ventana serán llenados con espacios en blanco que tiene la ejecución del fondo actual (como ajustado por @ref{2e00,,bkgdset()}) uniéndolos.
@end deffn

@geindex scroll() (método de curses.window)
@anchor{library/curses curses window scroll}@anchor{2e35}
@deffn {Método} window.scroll ([lines=1])

Desplace la pantalla o la región de desplazamiento hacia arriba por `lines' líneas.
@end deffn

@geindex scrollok() (método de curses.window)
@anchor{library/curses curses window scrollok}@anchor{2e36}
@deffn {Método} window.scrollok (flag)

Control que sucede cuando el cursor de una ventana es movida fuera del borde de la ventana o región de desplazamiento, también como un resultado de una acción de nueva línea en la línea inferior, o escribiendo el último carácter de la última línea.  Si `flag' es @code{False}, el cursor está a la izquierda sobre la línea inferior.  Si `flag' es @code{True}, la ventana será desplazada hacía arriba por una línea.  Note que en orden para obtener el efecto del desplazamiento físico en el terminal, también será necesario llamar @ref{2e1f,,idlok()}.
@end deffn

@geindex setscrreg() (método de curses.window)
@anchor{library/curses curses window setscrreg}@anchor{2e37}
@deffn {Método} window.setscrreg (top, bottom)

Configura la región de desplazamiento desde la línea `top' hasta la línea `bottom'. Todas las acciones de desplazamiento tomarán lugar en esta región.
@end deffn

@geindex standend() (método de curses.window)
@anchor{library/curses curses window standend}@anchor{2e38}
@deffn {Método} window.standend ()

Desactive el atributo destacado.  En algunos terminales esto tiene el efecto secundario de desactivar todos los atributos.
@end deffn

@geindex standout() (método de curses.window)
@anchor{library/curses curses window standout}@anchor{2e39}
@deffn {Método} window.standout ()

Active el atributo `A_STANDOUT'.
@end deffn

@geindex subpad() (método de curses.window)
@anchor{library/curses curses window subpad}@anchor{2e3a}
@deffn {Método} window.subpad (begin_y, begin_x)

@deffnx {Método} window.subpad (nlines, ncols, begin_y, begin_x)

Retorna la sub-ventana, cuya esquina superior izquierda esta en @code{(begin_y, begin_x)}, y cuyo ancho/alto es `ncols'/`nlines'.
@end deffn

@geindex subwin() (método de curses.window)
@anchor{library/curses curses window subwin}@anchor{2e14}
@deffn {Método} window.subwin (begin_y, begin_x)

@deffnx {Método} window.subwin (nlines, ncols, begin_y, begin_x)

Retorna la sub-ventana, cuya esquina superior izquierda esta en @code{(begin_y, begin_x)}, y cuyo ancho/alto es `ncols'/`nlines'.

Por defecto, la sub-ventana extenderá desde la posición especificada para la esquina inferior derecha de la ventana.
@end deffn

@geindex syncdown() (método de curses.window)
@anchor{library/curses curses window syncdown}@anchor{2e3b}
@deffn {Método} window.syncdown ()

Toca cada ubicación en la ventana que ha sido tocado por alguna de sus ventanas padres.  Esta rutina es llamada por @ref{2db9,,refresh()}, esto casi nunca debería ser necesario para llamarlo manualmente.
@end deffn

@geindex syncok() (método de curses.window)
@anchor{library/curses curses window syncok}@anchor{2e3c}
@deffn {Método} window.syncok (flag)

Si `flag' es @code{True}, entonces @ref{2e3d,,syncup()} es llamada automáticamente cuando hay un cambio en la ventana.
@end deffn

@geindex syncup() (método de curses.window)
@anchor{library/curses curses window syncup}@anchor{2e3d}
@deffn {Método} window.syncup ()

Toque todas las locaciones de los ancestros de la ventana que han sido cambiados en la ventana.
@end deffn

@geindex timeout() (método de curses.window)
@anchor{library/curses curses window timeout}@anchor{2e3e}
@deffn {Método} window.timeout (delay)

Configura el bloqueo o no bloqueo del comportamiento para la ventana.  Si el `delay' es negativo, bloqueando la lectura usada (el cual esperará indefinidamente para la entrada).  Si `delay' es cero, entonces no se bloqueará la lectura usada, y @ref{2dc1,,getch()} retornará @code{-1} si la entrada no está esperando.  Si `delay' es positivo, entonces @ref{2dc1,,getch()} se bloqueará por `delay' milisegundos, y retorna @code{-1} si aún no entra en el final de ese tiempo.
@end deffn

@geindex touchline() (método de curses.window)
@anchor{library/curses curses window touchline}@anchor{2e0a}
@deffn {Método} window.touchline (start, count[, changed])

Supone `count' líneas han sido cambiadas, iniciando con la línea `start'.  Si `changed' es suministrado, específica que las líneas afectadas son marcadas como hayan sido cambiadas (`changed'@code{=True}) o no cambiadas (`changed'@code{=False}).
@end deffn

@geindex touchwin() (método de curses.window)
@anchor{library/curses curses window touchwin}@anchor{2e3f}
@deffn {Método} window.touchwin ()

Suponga que toda la ventana ha sido cambiada, con el fin de optimizar el dibujo.
@end deffn

@geindex untouchwin() (método de curses.window)
@anchor{library/curses curses window untouchwin}@anchor{2e40}
@deffn {Método} window.untouchwin ()

Marque todas las líneas en la ventana como no cambiadas desde la última llamada para @ref{2db9,,refresh()}.
@end deffn

@geindex vline() (método de curses.window)
@anchor{library/curses curses window vline}@anchor{1791}
@deffn {Método} window.vline (ch, n[, attr])

@deffnx {Método} window.vline (y, x, ch, n[, attr])

Display a vertical line starting at @code{(y, x)} with length `n' consisting of the
character `ch' with attributes `attr'.
@end deffn

@node Constantes<6>,,Objetos de ventana,curses — Terminal handling for character-cell displays
@anchor{library/curses constants}@anchor{2e41}
@subsubsection Constantes


El módulo @ref{2c,,curses} define los siguientes miembros de datos:

@geindex ERR (en el módulo curses)
@anchor{library/curses curses ERR}@anchor{2e42}
@deffn {Dato} curses.ERR

Algunas rutinas de `curses' que retornan un entero, tales como @ref{2dc1,,getch()}, retorna @ref{2e42,,ERR} sobre el fallo.
@end deffn

@geindex OK (en el módulo curses)
@anchor{library/curses curses OK}@anchor{2e43}
@deffn {Dato} curses.OK

Algunas rutinas de `curses' que retornan un entero, tales como @ref{15a2,,napms()}, retorna @ref{2e43,,OK} tras el éxito.
@end deffn

@geindex version (en el módulo curses)
@anchor{library/curses curses version}@anchor{2e44}
@deffn {Dato} curses.version
@end deffn

@geindex __version__ (en el módulo curses)
@anchor{library/curses curses __version__}@anchor{2e45}
@deffn {Dato} curses.__version__

A bytes object representing the current version of the module.
@end deffn

@geindex ncurses_version (en el módulo curses)
@anchor{library/curses curses ncurses_version}@anchor{a79}
@deffn {Dato} curses.ncurses_version

Una tupla nombrada contiene los 3 componentes de la versión de la librería `ncurses' `major', `minor', y `patch'.  Todos los valores son enteros.  Los componentes pueden también ser accedidos por nombre, así @code{curses.ncurses_version[0]} es equivalente a @code{curses.ncurses_version.major} y así.

Disponibilidad: si la librería ncurses es usada.


Added in version 3.8.

@end deffn

@geindex COLORS (en el módulo curses)
@anchor{library/curses curses COLORS}@anchor{2dec}
@deffn {Dato} curses.COLORS

The maximum number of colors the terminal can support.
It is defined only after the call to @ref{2deb,,start_color()}.
@end deffn

@geindex COLOR_PAIRS (en el módulo curses)
@anchor{library/curses curses COLOR_PAIRS}@anchor{2ded}
@deffn {Dato} curses.COLOR_PAIRS

The maximum number of color pairs the terminal can support.
It is defined only after the call to @ref{2deb,,start_color()}.
@end deffn

@geindex COLS (en el módulo curses)
@anchor{library/curses curses COLS}@anchor{1712}
@deffn {Dato} curses.COLS

The width of the screen, i.e., the number of columns.
It is defined only after the call to @ref{15a3,,initscr()}.
Updated by @ref{e71,,update_lines_cols()}, @ref{15c4,,resizeterm()} and
@ref{15c5,,resize_term()}.
@end deffn

@geindex LINES (en el módulo curses)
@anchor{library/curses curses LINES}@anchor{1711}
@deffn {Dato} curses.LINES

The height of the screen, i.e., the number of lines.
It is defined only after the call to @ref{15a3,,initscr()}.
Updated by @ref{e71,,update_lines_cols()}, @ref{15c4,,resizeterm()} and
@ref{15c5,,resize_term()}.
@end deffn

Algunas constantes están disponibles para especificar los atributos del celdas de caracteres.  Las constantes exactas disponible dependen del sistema.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex A_ALTCHARSET (en el módulo curses)
@anchor{library/curses curses A_ALTCHARSET}@anchor{2e46}
@deffn {Dato} curses.A_ALTCHARSET
@end deffn

@tab

Modo de conjunto de caracteres alternativo

@item

@geindex A_BLINK (en el módulo curses)
@anchor{library/curses curses A_BLINK}@anchor{2e47}
@deffn {Dato} curses.A_BLINK
@end deffn

@tab

Modo parpadeo

@item

@geindex A_BOLD (en el módulo curses)
@anchor{library/curses curses A_BOLD}@anchor{2e48}
@deffn {Dato} curses.A_BOLD
@end deffn

@tab

Modo negrita

@item

@geindex A_DIM (en el módulo curses)
@anchor{library/curses curses A_DIM}@anchor{2e49}
@deffn {Dato} curses.A_DIM
@end deffn

@tab

Modo tenue

@item

@geindex A_INVIS (en el módulo curses)
@anchor{library/curses curses A_INVIS}@anchor{2e4a}
@deffn {Dato} curses.A_INVIS
@end deffn

@tab

Modo invisible o en blanco

@item

@geindex A_ITALIC (en el módulo curses)
@anchor{library/curses curses A_ITALIC}@anchor{2e4b}
@deffn {Dato} curses.A_ITALIC
@end deffn

@tab

Modo cursiva

@item

@geindex A_NORMAL (en el módulo curses)
@anchor{library/curses curses A_NORMAL}@anchor{2da6}
@deffn {Dato} curses.A_NORMAL
@end deffn

@tab

Atributo normal

@item

@geindex A_PROTECT (en el módulo curses)
@anchor{library/curses curses A_PROTECT}@anchor{2e4c}
@deffn {Dato} curses.A_PROTECT
@end deffn

@tab

Modo protegido

@item

@geindex A_REVERSE (en el módulo curses)
@anchor{library/curses curses A_REVERSE}@anchor{2dae}
@deffn {Dato} curses.A_REVERSE
@end deffn

@tab

Fondo inverso y colores de primer plano

@item

@geindex A_STANDOUT (en el módulo curses)
@anchor{library/curses curses A_STANDOUT}@anchor{2dad}
@deffn {Dato} curses.A_STANDOUT
@end deffn

@tab

Modo destacado

@item

@geindex A_UNDERLINE (en el módulo curses)
@anchor{library/curses curses A_UNDERLINE}@anchor{2e4d}
@deffn {Dato} curses.A_UNDERLINE
@end deffn

@tab

Modo subrayado

@item

@geindex A_HORIZONTAL (en el módulo curses)
@anchor{library/curses curses A_HORIZONTAL}@anchor{2e4e}
@deffn {Dato} curses.A_HORIZONTAL
@end deffn

@tab

Resaltado horizontal

@item

@geindex A_LEFT (en el módulo curses)
@anchor{library/curses curses A_LEFT}@anchor{2e4f}
@deffn {Dato} curses.A_LEFT
@end deffn

@tab

Resaltado a la izquierda

@item

@geindex A_LOW (en el módulo curses)
@anchor{library/curses curses A_LOW}@anchor{2e50}
@deffn {Dato} curses.A_LOW
@end deffn

@tab

Resaltado bajo

@item

@geindex A_RIGHT (en el módulo curses)
@anchor{library/curses curses A_RIGHT}@anchor{2e51}
@deffn {Dato} curses.A_RIGHT
@end deffn

@tab

Resaltado a la derecha

@item

@geindex A_TOP (en el módulo curses)
@anchor{library/curses curses A_TOP}@anchor{2e52}
@deffn {Dato} curses.A_TOP
@end deffn

@tab

Resaltado arriba

@item

@geindex A_VERTICAL (en el módulo curses)
@anchor{library/curses curses A_VERTICAL}@anchor{2e53}
@deffn {Dato} curses.A_VERTICAL
@end deffn

@tab

Resaltado vertical

@end multitable



Added in version 3.7: @code{A_ITALIC} fue añadido.


Varias constantes están disponibles para extraer los atributos correspondientes retornados por algunos métodos.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Mascara de bits

@tab

Significado

@item

@geindex A_ATTRIBUTES (en el módulo curses)
@anchor{library/curses curses A_ATTRIBUTES}@anchor{2e54}
@deffn {Dato} curses.A_ATTRIBUTES
@end deffn

@tab

Mascara de bits para extraer atributos

@item

@geindex A_CHARTEXT (en el módulo curses)
@anchor{library/curses curses A_CHARTEXT}@anchor{2e55}
@deffn {Dato} curses.A_CHARTEXT
@end deffn

@tab

Mascara de bits para extraer un caracter

@item

@geindex A_COLOR (en el módulo curses)
@anchor{library/curses curses A_COLOR}@anchor{2e56}
@deffn {Dato} curses.A_COLOR
@end deffn

@tab

Mascara de bits para extraer información de campo de pares de colores

@end multitable


Las teclas se denominan constantes enteras con nombres que comienzan con @code{KEY_}. Las teclas exactas disponibles son dependientes del sistema.

@c XXX this table is far too large! should it be alphabetized?


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Clave constante

@tab

Clave

@item

@geindex KEY_MIN (en el módulo curses)
@anchor{library/curses curses KEY_MIN}@anchor{2e57}
@deffn {Dato} curses.KEY_MIN
@end deffn

@tab

Valor mínimo de la clave

@item

@geindex KEY_BREAK (en el módulo curses)
@anchor{library/curses curses KEY_BREAK}@anchor{2e58}
@deffn {Dato} curses.KEY_BREAK
@end deffn

@tab

Clave rota (no confiable)

@item

@geindex KEY_DOWN (en el módulo curses)
@anchor{library/curses curses KEY_DOWN}@anchor{2e59}
@deffn {Dato} curses.KEY_DOWN
@end deffn

@tab

Flecha hacia abajo

@item

@geindex KEY_UP (en el módulo curses)
@anchor{library/curses curses KEY_UP}@anchor{2e5a}
@deffn {Dato} curses.KEY_UP
@end deffn

@tab

Flecha hacia arriba

@item

@geindex KEY_LEFT (en el módulo curses)
@anchor{library/curses curses KEY_LEFT}@anchor{2e5b}
@deffn {Dato} curses.KEY_LEFT
@end deffn

@tab

Flecha hacia la izquierda

@item

@geindex KEY_RIGHT (en el módulo curses)
@anchor{library/curses curses KEY_RIGHT}@anchor{2e5c}
@deffn {Dato} curses.KEY_RIGHT
@end deffn

@tab

Flecha hacia la derecha

@item

@geindex KEY_HOME (en el módulo curses)
@anchor{library/curses curses KEY_HOME}@anchor{2e5d}
@deffn {Dato} curses.KEY_HOME
@end deffn

@tab

Tecla de inicio (flecha hacia arriba + flecha hacia la izquierda)

@item

@geindex KEY_BACKSPACE (en el módulo curses)
@anchor{library/curses curses KEY_BACKSPACE}@anchor{2e5e}
@deffn {Dato} curses.KEY_BACKSPACE
@end deffn

@tab

Retroceso (no confiable)

@item

@geindex KEY_F0 (en el módulo curses)
@anchor{library/curses curses KEY_F0}@anchor{2e5f}
@deffn {Dato} curses.KEY_F0
@end deffn

@tab

Teclas de función. Más de 64 teclas de función son soportadas.

@item

@geindex KEY_Fn (en el módulo curses)
@anchor{library/curses curses KEY_Fn}@anchor{2e60}
@deffn {Dato} curses.KEY_Fn
@end deffn

@tab

Valor de tecla de función `n'

@item

@geindex KEY_DL (en el módulo curses)
@anchor{library/curses curses KEY_DL}@anchor{2e61}
@deffn {Dato} curses.KEY_DL
@end deffn

@tab

Borrar línea

@item

@geindex KEY_IL (en el módulo curses)
@anchor{library/curses curses KEY_IL}@anchor{2e62}
@deffn {Dato} curses.KEY_IL
@end deffn

@tab

Inserte línea

@item

@geindex KEY_DC (en el módulo curses)
@anchor{library/curses curses KEY_DC}@anchor{2e63}
@deffn {Dato} curses.KEY_DC
@end deffn

@tab

Borrar caracter

@item

@geindex KEY_IC (en el módulo curses)
@anchor{library/curses curses KEY_IC}@anchor{2e64}
@deffn {Dato} curses.KEY_IC
@end deffn

@tab

Insertar carácter o ingresara al modo de inserción

@item

@geindex KEY_EIC (en el módulo curses)
@anchor{library/curses curses KEY_EIC}@anchor{2e65}
@deffn {Dato} curses.KEY_EIC
@end deffn

@tab

Salir del modo de inserción de caracteres

@item

@geindex KEY_CLEAR (en el módulo curses)
@anchor{library/curses curses KEY_CLEAR}@anchor{2e66}
@deffn {Dato} curses.KEY_CLEAR
@end deffn

@tab

Limpiar pantalla

@item

@geindex KEY_EOS (en el módulo curses)
@anchor{library/curses curses KEY_EOS}@anchor{2e67}
@deffn {Dato} curses.KEY_EOS
@end deffn

@tab

Limpiar al final de pantalla

@item

@geindex KEY_EOL (en el módulo curses)
@anchor{library/curses curses KEY_EOL}@anchor{2e68}
@deffn {Dato} curses.KEY_EOL
@end deffn

@tab

Limpiar al final de la línea

@item

@geindex KEY_SF (en el módulo curses)
@anchor{library/curses curses KEY_SF}@anchor{2e69}
@deffn {Dato} curses.KEY_SF
@end deffn

@tab

Desplazar una línea hacia adelante

@item

@geindex KEY_SR (en el módulo curses)
@anchor{library/curses curses KEY_SR}@anchor{2e6a}
@deffn {Dato} curses.KEY_SR
@end deffn

@tab

Desplazar una línea hacia atrás (reversa)

@item

@geindex KEY_NPAGE (en el módulo curses)
@anchor{library/curses curses KEY_NPAGE}@anchor{2e6b}
@deffn {Dato} curses.KEY_NPAGE
@end deffn

@tab

Página siguiente

@item

@geindex KEY_PPAGE (en el módulo curses)
@anchor{library/curses curses KEY_PPAGE}@anchor{2e6c}
@deffn {Dato} curses.KEY_PPAGE
@end deffn

@tab

Página anterior

@item

@geindex KEY_STAB (en el módulo curses)
@anchor{library/curses curses KEY_STAB}@anchor{2e6d}
@deffn {Dato} curses.KEY_STAB
@end deffn

@tab

Establecer pestaña

@item

@geindex KEY_CTAB (en el módulo curses)
@anchor{library/curses curses KEY_CTAB}@anchor{2e6e}
@deffn {Dato} curses.KEY_CTAB
@end deffn

@tab

Limpiar pestaña

@item

@geindex KEY_CATAB (en el módulo curses)
@anchor{library/curses curses KEY_CATAB}@anchor{2e6f}
@deffn {Dato} curses.KEY_CATAB
@end deffn

@tab

Limpiar todas las pestañas

@item

@geindex KEY_ENTER (en el módulo curses)
@anchor{library/curses curses KEY_ENTER}@anchor{2e70}
@deffn {Dato} curses.KEY_ENTER
@end deffn

@tab

Ingresar o enviar (no confiable)

@item

@geindex KEY_SRESET (en el módulo curses)
@anchor{library/curses curses KEY_SRESET}@anchor{2e71}
@deffn {Dato} curses.KEY_SRESET
@end deffn

@tab

Reinicio suave (parcial) (no confiable)

@item

@geindex KEY_RESET (en el módulo curses)
@anchor{library/curses curses KEY_RESET}@anchor{2e72}
@deffn {Dato} curses.KEY_RESET
@end deffn

@tab

Reinicio o reinicio fuerte (no confiable)

@item

@geindex KEY_PRINT (en el módulo curses)
@anchor{library/curses curses KEY_PRINT}@anchor{2e73}
@deffn {Dato} curses.KEY_PRINT
@end deffn

@tab

Imprimir

@item

@geindex KEY_LL (en el módulo curses)
@anchor{library/curses curses KEY_LL}@anchor{2e74}
@deffn {Dato} curses.KEY_LL
@end deffn

@tab

Inicio abajo o abajo (abajo a la izquierda)

@item

@geindex KEY_A1 (en el módulo curses)
@anchor{library/curses curses KEY_A1}@anchor{2e75}
@deffn {Dato} curses.KEY_A1
@end deffn

@tab

Superior izquierda del teclado

@item

@geindex KEY_A3 (en el módulo curses)
@anchor{library/curses curses KEY_A3}@anchor{2e76}
@deffn {Dato} curses.KEY_A3
@end deffn

@tab

Superior derecha de el teclado

@item

@geindex KEY_B2 (en el módulo curses)
@anchor{library/curses curses KEY_B2}@anchor{2e77}
@deffn {Dato} curses.KEY_B2
@end deffn

@tab

Centro del teclado

@item

@geindex KEY_C1 (en el módulo curses)
@anchor{library/curses curses KEY_C1}@anchor{2e78}
@deffn {Dato} curses.KEY_C1
@end deffn

@tab

Inferior izquierdo del teclado

@item

@geindex KEY_C3 (en el módulo curses)
@anchor{library/curses curses KEY_C3}@anchor{2e79}
@deffn {Dato} curses.KEY_C3
@end deffn

@tab

Inferior derecho del teclado

@item

@geindex KEY_BTAB (en el módulo curses)
@anchor{library/curses curses KEY_BTAB}@anchor{2e7a}
@deffn {Dato} curses.KEY_BTAB
@end deffn

@tab

Pestaña trasera

@item

@geindex KEY_BEG (en el módulo curses)
@anchor{library/curses curses KEY_BEG}@anchor{2e7b}
@deffn {Dato} curses.KEY_BEG
@end deffn

@tab

Mendigar (Comienzo)

@item

@geindex KEY_CANCEL (en el módulo curses)
@anchor{library/curses curses KEY_CANCEL}@anchor{2e7c}
@deffn {Dato} curses.KEY_CANCEL
@end deffn

@tab

Cancelar

@item

@geindex KEY_CLOSE (en el módulo curses)
@anchor{library/curses curses KEY_CLOSE}@anchor{2e7d}
@deffn {Dato} curses.KEY_CLOSE
@end deffn

@tab

Cerrar

@item

@geindex KEY_COMMAND (en el módulo curses)
@anchor{library/curses curses KEY_COMMAND}@anchor{2e7e}
@deffn {Dato} curses.KEY_COMMAND
@end deffn

@tab

Cmd (Comando)

@item

@geindex KEY_COPY (en el módulo curses)
@anchor{library/curses curses KEY_COPY}@anchor{2e7f}
@deffn {Dato} curses.KEY_COPY
@end deffn

@tab

Copiar

@item

@geindex KEY_CREATE (en el módulo curses)
@anchor{library/curses curses KEY_CREATE}@anchor{2e80}
@deffn {Dato} curses.KEY_CREATE
@end deffn

@tab

Crear

@item

@geindex KEY_END (en el módulo curses)
@anchor{library/curses curses KEY_END}@anchor{2e81}
@deffn {Dato} curses.KEY_END
@end deffn

@tab

Final

@item

@geindex KEY_EXIT (en el módulo curses)
@anchor{library/curses curses KEY_EXIT}@anchor{2e82}
@deffn {Dato} curses.KEY_EXIT
@end deffn

@tab

Salir

@item

@geindex KEY_FIND (en el módulo curses)
@anchor{library/curses curses KEY_FIND}@anchor{2e83}
@deffn {Dato} curses.KEY_FIND
@end deffn

@tab

Encontrar

@item

@geindex KEY_HELP (en el módulo curses)
@anchor{library/curses curses KEY_HELP}@anchor{2e84}
@deffn {Dato} curses.KEY_HELP
@end deffn

@tab

Ayudar

@item

@geindex KEY_MARK (en el módulo curses)
@anchor{library/curses curses KEY_MARK}@anchor{2e85}
@deffn {Dato} curses.KEY_MARK
@end deffn

@tab

Marca

@item

@geindex KEY_MESSAGE (en el módulo curses)
@anchor{library/curses curses KEY_MESSAGE}@anchor{2e86}
@deffn {Dato} curses.KEY_MESSAGE
@end deffn

@tab

Mensaje

@item

@geindex KEY_MOVE (en el módulo curses)
@anchor{library/curses curses KEY_MOVE}@anchor{2e87}
@deffn {Dato} curses.KEY_MOVE
@end deffn

@tab

Mover

@item

@geindex KEY_NEXT (en el módulo curses)
@anchor{library/curses curses KEY_NEXT}@anchor{2e88}
@deffn {Dato} curses.KEY_NEXT
@end deffn

@tab

Siguiente

@item

@geindex KEY_OPEN (en el módulo curses)
@anchor{library/curses curses KEY_OPEN}@anchor{2e89}
@deffn {Dato} curses.KEY_OPEN
@end deffn

@tab

Abrir

@item

@geindex KEY_OPTIONS (en el módulo curses)
@anchor{library/curses curses KEY_OPTIONS}@anchor{2e8a}
@deffn {Dato} curses.KEY_OPTIONS
@end deffn

@tab

Opciones

@item

@geindex KEY_PREVIOUS (en el módulo curses)
@anchor{library/curses curses KEY_PREVIOUS}@anchor{2e8b}
@deffn {Dato} curses.KEY_PREVIOUS
@end deffn

@tab

Anterior

@item

@geindex KEY_REDO (en el módulo curses)
@anchor{library/curses curses KEY_REDO}@anchor{2e8c}
@deffn {Dato} curses.KEY_REDO
@end deffn

@tab

Rehacer

@item

@geindex KEY_REFERENCE (en el módulo curses)
@anchor{library/curses curses KEY_REFERENCE}@anchor{2e8d}
@deffn {Dato} curses.KEY_REFERENCE
@end deffn

@tab

Referencia

@item

@geindex KEY_REFRESH (en el módulo curses)
@anchor{library/curses curses KEY_REFRESH}@anchor{2e8e}
@deffn {Dato} curses.KEY_REFRESH
@end deffn

@tab

Refrescar

@item

@geindex KEY_REPLACE (en el módulo curses)
@anchor{library/curses curses KEY_REPLACE}@anchor{2e8f}
@deffn {Dato} curses.KEY_REPLACE
@end deffn

@tab

Re-emplazar

@item

@geindex KEY_RESTART (en el módulo curses)
@anchor{library/curses curses KEY_RESTART}@anchor{2e90}
@deffn {Dato} curses.KEY_RESTART
@end deffn

@tab

Re-iniciar

@item

@geindex KEY_RESUME (en el módulo curses)
@anchor{library/curses curses KEY_RESUME}@anchor{2e91}
@deffn {Dato} curses.KEY_RESUME
@end deffn

@tab

Resumir

@item

@geindex KEY_SAVE (en el módulo curses)
@anchor{library/curses curses KEY_SAVE}@anchor{2e92}
@deffn {Dato} curses.KEY_SAVE
@end deffn

@tab

Guardar

@item

@geindex KEY_SBEG (en el módulo curses)
@anchor{library/curses curses KEY_SBEG}@anchor{2e93}
@deffn {Dato} curses.KEY_SBEG
@end deffn

@tab

Mendicidad desplazada (comienzo)

@item

@geindex KEY_SCANCEL (en el módulo curses)
@anchor{library/curses curses KEY_SCANCEL}@anchor{2e94}
@deffn {Dato} curses.KEY_SCANCEL
@end deffn

@tab

Cancelar cambiado

@item

@geindex KEY_SCOMMAND (en el módulo curses)
@anchor{library/curses curses KEY_SCOMMAND}@anchor{2e95}
@deffn {Dato} curses.KEY_SCOMMAND
@end deffn

@tab

Comando cambiado

@item

@geindex KEY_SCOPY (en el módulo curses)
@anchor{library/curses curses KEY_SCOPY}@anchor{2e96}
@deffn {Dato} curses.KEY_SCOPY
@end deffn

@tab

Copiado cambiado

@item

@geindex KEY_SCREATE (en el módulo curses)
@anchor{library/curses curses KEY_SCREATE}@anchor{2e97}
@deffn {Dato} curses.KEY_SCREATE
@end deffn

@tab

Crear con desplazamiento

@item

@geindex KEY_SDC (en el módulo curses)
@anchor{library/curses curses KEY_SDC}@anchor{2e98}
@deffn {Dato} curses.KEY_SDC
@end deffn

@tab

Borrar carácter desplazado

@item

@geindex KEY_SDL (en el módulo curses)
@anchor{library/curses curses KEY_SDL}@anchor{2e99}
@deffn {Dato} curses.KEY_SDL
@end deffn

@tab

Borrar línea desplazada

@item

@geindex KEY_SELECT (en el módulo curses)
@anchor{library/curses curses KEY_SELECT}@anchor{2e9a}
@deffn {Dato} curses.KEY_SELECT
@end deffn

@tab

Seleccionar

@item

@geindex KEY_SEND (en el módulo curses)
@anchor{library/curses curses KEY_SEND}@anchor{2e9b}
@deffn {Dato} curses.KEY_SEND
@end deffn

@tab

Final desplazado

@item

@geindex KEY_SEOL (en el módulo curses)
@anchor{library/curses curses KEY_SEOL}@anchor{2e9c}
@deffn {Dato} curses.KEY_SEOL
@end deffn

@tab

Limpiar línea desplazada

@item

@geindex KEY_SEXIT (en el módulo curses)
@anchor{library/curses curses KEY_SEXIT}@anchor{2e9d}
@deffn {Dato} curses.KEY_SEXIT
@end deffn

@tab

Salida desplazada

@item

@geindex KEY_SFIND (en el módulo curses)
@anchor{library/curses curses KEY_SFIND}@anchor{2e9e}
@deffn {Dato} curses.KEY_SFIND
@end deffn

@tab

Búsqueda desplazada

@item

@geindex KEY_SHELP (en el módulo curses)
@anchor{library/curses curses KEY_SHELP}@anchor{2e9f}
@deffn {Dato} curses.KEY_SHELP
@end deffn

@tab

Ayuda desplazada

@item

@geindex KEY_SHOME (en el módulo curses)
@anchor{library/curses curses KEY_SHOME}@anchor{2ea0}
@deffn {Dato} curses.KEY_SHOME
@end deffn

@tab

Inicio cambiado

@item

@geindex KEY_SIC (en el módulo curses)
@anchor{library/curses curses KEY_SIC}@anchor{2ea1}
@deffn {Dato} curses.KEY_SIC
@end deffn

@tab

Entrada cambiada

@item

@geindex KEY_SLEFT (en el módulo curses)
@anchor{library/curses curses KEY_SLEFT}@anchor{2ea2}
@deffn {Dato} curses.KEY_SLEFT
@end deffn

@tab

Flecha hacia la izquierda desplazada

@item

@geindex KEY_SMESSAGE (en el módulo curses)
@anchor{library/curses curses KEY_SMESSAGE}@anchor{2ea3}
@deffn {Dato} curses.KEY_SMESSAGE
@end deffn

@tab

Mensaje cambiado

@item

@geindex KEY_SMOVE (en el módulo curses)
@anchor{library/curses curses KEY_SMOVE}@anchor{2ea4}
@deffn {Dato} curses.KEY_SMOVE
@end deffn

@tab

Movimiento desplazado

@item

@geindex KEY_SNEXT (en el módulo curses)
@anchor{library/curses curses KEY_SNEXT}@anchor{2ea5}
@deffn {Dato} curses.KEY_SNEXT
@end deffn

@tab

Siguiente desplazado

@item

@geindex KEY_SOPTIONS (en el módulo curses)
@anchor{library/curses curses KEY_SOPTIONS}@anchor{2ea6}
@deffn {Dato} curses.KEY_SOPTIONS
@end deffn

@tab

Opciones cambiadas

@item

@geindex KEY_SPREVIOUS (en el módulo curses)
@anchor{library/curses curses KEY_SPREVIOUS}@anchor{2ea7}
@deffn {Dato} curses.KEY_SPREVIOUS
@end deffn

@tab

Anterior cambiado

@item

@geindex KEY_SPRINT (en el módulo curses)
@anchor{library/curses curses KEY_SPRINT}@anchor{2ea8}
@deffn {Dato} curses.KEY_SPRINT
@end deffn

@tab

Imprimir desplazado

@item

@geindex KEY_SREDO (en el módulo curses)
@anchor{library/curses curses KEY_SREDO}@anchor{2ea9}
@deffn {Dato} curses.KEY_SREDO
@end deffn

@tab

Rehacer cambiado

@item

@geindex KEY_SREPLACE (en el módulo curses)
@anchor{library/curses curses KEY_SREPLACE}@anchor{2eaa}
@deffn {Dato} curses.KEY_SREPLACE
@end deffn

@tab

Re-emplazo cambiado

@item

@geindex KEY_SRIGHT (en el módulo curses)
@anchor{library/curses curses KEY_SRIGHT}@anchor{2eab}
@deffn {Dato} curses.KEY_SRIGHT
@end deffn

@tab

Flecha hacia la derecha cambiada

@item

@geindex KEY_SRSUME (en el módulo curses)
@anchor{library/curses curses KEY_SRSUME}@anchor{2eac}
@deffn {Dato} curses.KEY_SRSUME
@end deffn

@tab

Resumen cambiado

@item

@geindex KEY_SSAVE (en el módulo curses)
@anchor{library/curses curses KEY_SSAVE}@anchor{2ead}
@deffn {Dato} curses.KEY_SSAVE
@end deffn

@tab

Guardar desplazado

@item

@geindex KEY_SSUSPEND (en el módulo curses)
@anchor{library/curses curses KEY_SSUSPEND}@anchor{2eae}
@deffn {Dato} curses.KEY_SSUSPEND
@end deffn

@tab

Suspender cambiado

@item

@geindex KEY_SUNDO (en el módulo curses)
@anchor{library/curses curses KEY_SUNDO}@anchor{2eaf}
@deffn {Dato} curses.KEY_SUNDO
@end deffn

@tab

Deshacer desplazado

@item

@geindex KEY_SUSPEND (en el módulo curses)
@anchor{library/curses curses KEY_SUSPEND}@anchor{2eb0}
@deffn {Dato} curses.KEY_SUSPEND
@end deffn

@tab

Suspender

@item

@geindex KEY_UNDO (en el módulo curses)
@anchor{library/curses curses KEY_UNDO}@anchor{2eb1}
@deffn {Dato} curses.KEY_UNDO
@end deffn

@tab

Deshacer

@item

@geindex KEY_MOUSE (en el módulo curses)
@anchor{library/curses curses KEY_MOUSE}@anchor{2dc2}
@deffn {Dato} curses.KEY_MOUSE
@end deffn

@tab

Evento del ratón ha ocurrido

@item

@geindex KEY_RESIZE (en el módulo curses)
@anchor{library/curses curses KEY_RESIZE}@anchor{2eb2}
@deffn {Dato} curses.KEY_RESIZE
@end deffn

@tab

Evento de cambio de tamaño del terminal

@item

@geindex KEY_MAX (en el módulo curses)
@anchor{library/curses curses KEY_MAX}@anchor{2eb3}
@deffn {Dato} curses.KEY_MAX
@end deffn

@tab

Valor máximo de clave

@end multitable


On VT100s and their software emulations, such as X terminal emulators, there are
normally at least four function keys (@ref{2e60,,KEY_F1}, @ref{2e60,,KEY_F2},
@ref{2e60,,KEY_F3}, @ref{2e60,,KEY_F4}) available, and the arrow keys mapped to
@ref{2e5a,,KEY_UP}, @ref{2e59,,KEY_DOWN}, @ref{2e5b,,KEY_LEFT} and @ref{2e5c,,KEY_RIGHT} in
the obvious way.  If your machine has a PC keyboard, it is safe to expect arrow
keys and twelve function keys (older PC keyboards may have only ten function
keys); also, the following keypad mappings are standard:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Tecla

@tab

Constante

@item

@code{Insert}

@tab

KEY_IC

@item

@code{Delete}

@tab

KEY_DC

@item

@code{Home}

@tab

KEY_HOME

@item

@code{End}

@tab

KEY_END

@item

@code{Page Up}

@tab

KEY_PPAGE

@item

@code{Page Down}

@tab

KEY_NPAGE

@end multitable

@anchor{library/curses curses-acs-codes}@anchor{2eb4}
La siguiente tabla lista los caracteres desde el conjunto alterno de caracteres.  Estos son heredados desde el terminal VT100, y generalmente estará disponible en emuladores de software tales como terminales X.  Cuando no hay gráficos disponibles, `curses' cae en una aproximación cruda de ASCII imprimibles.

@cartouche
@quotation Nota 
Estos están disponibles solamente después de que @ref{15a3,,initscr()} ha sido llamada.
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código ACS

@tab

Significado

@item

@geindex ACS_BBSS (en el módulo curses)
@anchor{library/curses curses ACS_BBSS}@anchor{2eb5}
@deffn {Dato} curses.ACS_BBSS
@end deffn

@tab

nombre alternativo para la esquina superior derecha

@item

@geindex ACS_BLOCK (en el módulo curses)
@anchor{library/curses curses ACS_BLOCK}@anchor{2eb6}
@deffn {Dato} curses.ACS_BLOCK
@end deffn

@tab

bloque cuadrado sólido

@item

@geindex ACS_BOARD (en el módulo curses)
@anchor{library/curses curses ACS_BOARD}@anchor{2eb7}
@deffn {Dato} curses.ACS_BOARD
@end deffn

@tab

tablero de cuadrados

@item

@geindex ACS_BSBS (en el módulo curses)
@anchor{library/curses curses ACS_BSBS}@anchor{2eb8}
@deffn {Dato} curses.ACS_BSBS
@end deffn

@tab

nombre alternativo para línea horizontal

@item

@geindex ACS_BSSB (en el módulo curses)
@anchor{library/curses curses ACS_BSSB}@anchor{2eb9}
@deffn {Dato} curses.ACS_BSSB
@end deffn

@tab

nombre alternativo para esquina superior izquierda

@item

@geindex ACS_BSSS (en el módulo curses)
@anchor{library/curses curses ACS_BSSS}@anchor{2eba}
@deffn {Dato} curses.ACS_BSSS
@end deffn

@tab

nombre alternativo para el soporte superior

@item

@geindex ACS_BTEE (en el módulo curses)
@anchor{library/curses curses ACS_BTEE}@anchor{2ebb}
@deffn {Dato} curses.ACS_BTEE
@end deffn

@tab

soporte inferior

@item

@geindex ACS_BULLET (en el módulo curses)
@anchor{library/curses curses ACS_BULLET}@anchor{2ebc}
@deffn {Dato} curses.ACS_BULLET
@end deffn

@tab

bala

@item

@geindex ACS_CKBOARD (en el módulo curses)
@anchor{library/curses curses ACS_CKBOARD}@anchor{2ebd}
@deffn {Dato} curses.ACS_CKBOARD
@end deffn

@tab

tablero inspector (punteado)

@item

@geindex ACS_DARROW (en el módulo curses)
@anchor{library/curses curses ACS_DARROW}@anchor{2ebe}
@deffn {Dato} curses.ACS_DARROW
@end deffn

@tab

flecha punteada hacia abajo

@item

@geindex ACS_DEGREE (en el módulo curses)
@anchor{library/curses curses ACS_DEGREE}@anchor{2ebf}
@deffn {Dato} curses.ACS_DEGREE
@end deffn

@tab

símbolo de grado

@item

@geindex ACS_DIAMOND (en el módulo curses)
@anchor{library/curses curses ACS_DIAMOND}@anchor{2ec0}
@deffn {Dato} curses.ACS_DIAMOND
@end deffn

@tab

diamante

@item

@geindex ACS_GEQUAL (en el módulo curses)
@anchor{library/curses curses ACS_GEQUAL}@anchor{2ec1}
@deffn {Dato} curses.ACS_GEQUAL
@end deffn

@tab

mayor que o igual a

@item

@geindex ACS_HLINE (en el módulo curses)
@anchor{library/curses curses ACS_HLINE}@anchor{2e03}
@deffn {Dato} curses.ACS_HLINE
@end deffn

@tab

línea horizontal

@item

@geindex ACS_LANTERN (en el módulo curses)
@anchor{library/curses curses ACS_LANTERN}@anchor{2ec2}
@deffn {Dato} curses.ACS_LANTERN
@end deffn

@tab

símbolo de la linterna

@item

@geindex ACS_LARROW (en el módulo curses)
@anchor{library/curses curses ACS_LARROW}@anchor{2ec3}
@deffn {Dato} curses.ACS_LARROW
@end deffn

@tab

flecha izquierda

@item

@geindex ACS_LEQUAL (en el módulo curses)
@anchor{library/curses curses ACS_LEQUAL}@anchor{2ec4}
@deffn {Dato} curses.ACS_LEQUAL
@end deffn

@tab

menor que o igual a

@item

@geindex ACS_LLCORNER (en el módulo curses)
@anchor{library/curses curses ACS_LLCORNER}@anchor{2e06}
@deffn {Dato} curses.ACS_LLCORNER
@end deffn

@tab

esquina inferior izquierda

@item

@geindex ACS_LRCORNER (en el módulo curses)
@anchor{library/curses curses ACS_LRCORNER}@anchor{2e07}
@deffn {Dato} curses.ACS_LRCORNER
@end deffn

@tab

esquina inferior derecha

@item

@geindex ACS_LTEE (en el módulo curses)
@anchor{library/curses curses ACS_LTEE}@anchor{2ec5}
@deffn {Dato} curses.ACS_LTEE
@end deffn

@tab

soporte izquierdo

@item

@geindex ACS_NEQUAL (en el módulo curses)
@anchor{library/curses curses ACS_NEQUAL}@anchor{2ec6}
@deffn {Dato} curses.ACS_NEQUAL
@end deffn

@tab

signo no igual

@item

@geindex ACS_PI (en el módulo curses)
@anchor{library/curses curses ACS_PI}@anchor{2ec7}
@deffn {Dato} curses.ACS_PI
@end deffn

@tab

letra pi

@item

@geindex ACS_PLMINUS (en el módulo curses)
@anchor{library/curses curses ACS_PLMINUS}@anchor{2ec8}
@deffn {Dato} curses.ACS_PLMINUS
@end deffn

@tab

signo más o menos

@item

@geindex ACS_PLUS (en el módulo curses)
@anchor{library/curses curses ACS_PLUS}@anchor{2ec9}
@deffn {Dato} curses.ACS_PLUS
@end deffn

@tab

gran signo más

@item

@geindex ACS_RARROW (en el módulo curses)
@anchor{library/curses curses ACS_RARROW}@anchor{2eca}
@deffn {Dato} curses.ACS_RARROW
@end deffn

@tab

flecha hacia la derecha

@item

@geindex ACS_RTEE (en el módulo curses)
@anchor{library/curses curses ACS_RTEE}@anchor{2ecb}
@deffn {Dato} curses.ACS_RTEE
@end deffn

@tab

soporte derecho

@item

@geindex ACS_S1 (en el módulo curses)
@anchor{library/curses curses ACS_S1}@anchor{2ecc}
@deffn {Dato} curses.ACS_S1
@end deffn

@tab

escanear línea 1

@item

@geindex ACS_S3 (en el módulo curses)
@anchor{library/curses curses ACS_S3}@anchor{2ecd}
@deffn {Dato} curses.ACS_S3
@end deffn

@tab

escanear línea 3

@item

@geindex ACS_S7 (en el módulo curses)
@anchor{library/curses curses ACS_S7}@anchor{2ece}
@deffn {Dato} curses.ACS_S7
@end deffn

@tab

escanear línea 7

@item

@geindex ACS_S9 (en el módulo curses)
@anchor{library/curses curses ACS_S9}@anchor{2ecf}
@deffn {Dato} curses.ACS_S9
@end deffn

@tab

escanear línea 9

@item

@geindex ACS_SBBS (en el módulo curses)
@anchor{library/curses curses ACS_SBBS}@anchor{2ed0}
@deffn {Dato} curses.ACS_SBBS
@end deffn

@tab

nombre alterno para la esquina inferior derecha

@item

@geindex ACS_SBSB (en el módulo curses)
@anchor{library/curses curses ACS_SBSB}@anchor{2ed1}
@deffn {Dato} curses.ACS_SBSB
@end deffn

@tab

nombre alterno para la línea vertical

@item

@geindex ACS_SBSS (en el módulo curses)
@anchor{library/curses curses ACS_SBSS}@anchor{2ed2}
@deffn {Dato} curses.ACS_SBSS
@end deffn

@tab

nombre alterno para el soporte derecho

@item

@geindex ACS_SSBB (en el módulo curses)
@anchor{library/curses curses ACS_SSBB}@anchor{2ed3}
@deffn {Dato} curses.ACS_SSBB
@end deffn

@tab

nombre alterno para la esquina inferior izquierda

@item

@geindex ACS_SSBS (en el módulo curses)
@anchor{library/curses curses ACS_SSBS}@anchor{2ed4}
@deffn {Dato} curses.ACS_SSBS
@end deffn

@tab

nombre alterno para el soporte inferior

@item

@geindex ACS_SSSB (en el módulo curses)
@anchor{library/curses curses ACS_SSSB}@anchor{2ed5}
@deffn {Dato} curses.ACS_SSSB
@end deffn

@tab

nombre alterno para el soporte izquierdo

@item

@geindex ACS_SSSS (en el módulo curses)
@anchor{library/curses curses ACS_SSSS}@anchor{2ed6}
@deffn {Dato} curses.ACS_SSSS
@end deffn

@tab

nombre alterno para `crossover' o un gran más

@item

@geindex ACS_STERLING (en el módulo curses)
@anchor{library/curses curses ACS_STERLING}@anchor{2ed7}
@deffn {Dato} curses.ACS_STERLING
@end deffn

@tab

libra esterlina

@item

@geindex ACS_TTEE (en el módulo curses)
@anchor{library/curses curses ACS_TTEE}@anchor{2ed8}
@deffn {Dato} curses.ACS_TTEE
@end deffn

@tab

soporte superior

@item

@geindex ACS_UARROW (en el módulo curses)
@anchor{library/curses curses ACS_UARROW}@anchor{2ed9}
@deffn {Dato} curses.ACS_UARROW
@end deffn

@tab

flecha hacia arriba

@item

@geindex ACS_ULCORNER (en el módulo curses)
@anchor{library/curses curses ACS_ULCORNER}@anchor{2e04}
@deffn {Dato} curses.ACS_ULCORNER
@end deffn

@tab

esquina superior izquierda

@item

@geindex ACS_URCORNER (en el módulo curses)
@anchor{library/curses curses ACS_URCORNER}@anchor{2e05}
@deffn {Dato} curses.ACS_URCORNER
@end deffn

@tab

esquina superior derecha

@item

@geindex ACS_VLINE (en el módulo curses)
@anchor{library/curses curses ACS_VLINE}@anchor{2e02}
@deffn {Dato} curses.ACS_VLINE
@end deffn

@tab

línea vertical

@end multitable


The following table lists mouse button constants used by @ref{2dc0,,getmouse()}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Mouse button constant

@tab

Significado

@item

@geindex BUTTONn_PRESSED (en el módulo curses)
@anchor{library/curses curses BUTTONn_PRESSED}@anchor{2dc3}
@deffn {Dato} curses.BUTTONn_PRESSED
@end deffn

@tab

Mouse button `n' pressed

@item

@geindex BUTTONn_RELEASED (en el módulo curses)
@anchor{library/curses curses BUTTONn_RELEASED}@anchor{2dc4}
@deffn {Dato} curses.BUTTONn_RELEASED
@end deffn

@tab

Mouse button `n' released

@item

@geindex BUTTONn_CLICKED (en el módulo curses)
@anchor{library/curses curses BUTTONn_CLICKED}@anchor{2dc5}
@deffn {Dato} curses.BUTTONn_CLICKED
@end deffn

@tab

Mouse button `n' clicked

@item

@geindex BUTTONn_DOUBLE_CLICKED (en el módulo curses)
@anchor{library/curses curses BUTTONn_DOUBLE_CLICKED}@anchor{2dc6}
@deffn {Dato} curses.BUTTONn_DOUBLE_CLICKED
@end deffn

@tab

Mouse button `n' double clicked

@item

@geindex BUTTONn_TRIPLE_CLICKED (en el módulo curses)
@anchor{library/curses curses BUTTONn_TRIPLE_CLICKED}@anchor{2dc7}
@deffn {Dato} curses.BUTTONn_TRIPLE_CLICKED
@end deffn

@tab

Mouse button `n' triple clicked

@item

@geindex BUTTON_SHIFT (en el módulo curses)
@anchor{library/curses curses BUTTON_SHIFT}@anchor{2dc8}
@deffn {Dato} curses.BUTTON_SHIFT
@end deffn

@tab

Shift was down during button state change

@item

@geindex BUTTON_CTRL (en el módulo curses)
@anchor{library/curses curses BUTTON_CTRL}@anchor{2dc9}
@deffn {Dato} curses.BUTTON_CTRL
@end deffn

@tab

Control was down during button state change

@item

@geindex BUTTON_ALT (en el módulo curses)
@anchor{library/curses curses BUTTON_ALT}@anchor{2dca}
@deffn {Dato} curses.BUTTON_ALT
@end deffn

@tab

Control was down during button state change

@end multitable



Distinto en la versión 3.10: Las constantes @code{BUTTON5_*} ahora están expuestas si son proporcionadas por la biblioteca curses subyacente.


La siguiente tabla lista los colores pre-definidos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Color

@item

@geindex COLOR_BLACK (en el módulo curses)
@anchor{library/curses curses COLOR_BLACK}@anchor{2eda}
@deffn {Dato} curses.COLOR_BLACK
@end deffn

@tab

Negro

@item

@geindex COLOR_BLUE (en el módulo curses)
@anchor{library/curses curses COLOR_BLUE}@anchor{2edb}
@deffn {Dato} curses.COLOR_BLUE
@end deffn

@tab

Azul

@item

@geindex COLOR_CYAN (en el módulo curses)
@anchor{library/curses curses COLOR_CYAN}@anchor{2edc}
@deffn {Dato} curses.COLOR_CYAN
@end deffn

@tab

Cian (azul verdoso claro)

@item

@geindex COLOR_GREEN (en el módulo curses)
@anchor{library/curses curses COLOR_GREEN}@anchor{2edd}
@deffn {Dato} curses.COLOR_GREEN
@end deffn

@tab

Verde

@item

@geindex COLOR_MAGENTA (en el módulo curses)
@anchor{library/curses curses COLOR_MAGENTA}@anchor{2ede}
@deffn {Dato} curses.COLOR_MAGENTA
@end deffn

@tab

Magenta (rojo violáceo)

@item

@geindex COLOR_RED (en el módulo curses)
@anchor{library/curses curses COLOR_RED}@anchor{2edf}
@deffn {Dato} curses.COLOR_RED
@end deffn

@tab

Rojo

@item

@geindex COLOR_WHITE (en el módulo curses)
@anchor{library/curses curses COLOR_WHITE}@anchor{2ee0}
@deffn {Dato} curses.COLOR_WHITE
@end deffn

@tab

Blanco

@item

@geindex COLOR_YELLOW (en el módulo curses)
@anchor{library/curses curses COLOR_YELLOW}@anchor{2ee1}
@deffn {Dato} curses.COLOR_YELLOW
@end deffn

@tab

Amarillo

@end multitable


@node curses textpad— Widget de entrada de texto para programas de curses,curses ascii — Utilities for ASCII characters,curses — Terminal handling for character-cell displays,Servicios genéricos del sistema operativo
@anchor{library/curses curses-textpad-text-input-widget-for-curses-programs}@anchor{2ee2}@anchor{library/curses module-curses textpad}@anchor{2f}
@subsection @code{curses.textpad}— Widget de entrada de texto para programas de curses


@geindex module; curses.textpad

El módulo @ref{2f,,curses.textpad} provee una clase @ref{2ee3,,Textbox} que maneja edición de texto primario en una ventana `curses', apoyando un conjunto de atajos de teclado re-ensamblando estos de Emacs (esto, también de `Netscape Navigator', BBedit 6.x, FrameMaker, y muchos otros programas).  Los módulos también proveen una función de dibujo de rectángulo útil para enmarcar las cajas de texto o para otros propósitos.

El módulo @ref{2f,,curses.textpad} define la siguiente función:

@geindex rectangle() (en el módulo curses.textpad)
@anchor{library/curses curses textpad rectangle}@anchor{2ee4}
@deffn {Función} curses.textpad.rectangle (win, uly, ulx, lry, lrx)

Dibuja un rectángulo.  El primer argumento debe ser un objeto de ventana, los argumentos restantes son coordenadas relativas para esa ventana.  El segundo y tercer argumento son las coordenadas “x” y “y” de la esquina superior de la mano izquierda del rectángulo a ser dibujado, el cuarto y quinto argumento son las coordenadas “x” y “y” de la esquina inferior de la mano derecha.  El rectángulo será dibujado usando formularios de caracteres VT100/IBM PC en terminales que hace esto posible (incluyendo `xterm' y mas otro emulador de terminal de software).  Por otra parte será dibujado con guiones, barras verticales, y signos de más de ASCII.
@end deffn

@menu
* Objeto de caja de texto:: 

@end menu

@node Objeto de caja de texto,,,curses textpad— Widget de entrada de texto para programas de curses
@anchor{library/curses curses-textpad-objects}@anchor{2ee5}@anchor{library/curses textbox-objects}@anchor{2ee6}
@subsubsection Objeto de caja de texto


Tú puedes instanciar un objeto @ref{2ee3,,Textbox} como sigue:

@geindex Textbox (clase en curses.textpad)
@anchor{library/curses curses textpad Textbox}@anchor{2ee3}
@deffn {Clase} curses.textpad.Textbox (win)

Retorna un objeto `widget' de caja de texto.  El argumento `win' debería ser un objeto `curses' @ref{161f,,window} en el cual la caja de texto es para ser contenido.  El cursor de la caja de texto está inicialmente localizado en la esquina superior de la mano izquierda de la ventana que lo contiene, con coordenadas @code{(0, 0)}.  La bandera instanciada @ref{2ee7,,stripspaces} está inicialmente encendida.

Objeto @ref{2ee3,,Textbox} tiene los siguientes métodos:

@geindex edit() (método de curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox edit}@anchor{2ee8}
@deffn {Método} edit ([validator])

Este es el punto de entrada que normalmente usarás.  Esto acepta la edición de las pulsaciones de tecla hasta que uno de las pulsaciones de finalización es introducida.  Si `validator' es suministrado, esto debe ser una función.  Será llamado para cada pulsación de tecla introducida con la pulsación de tecla como un parámetro; el comando ejecutado está hecho en el resultado.  Este método retorna el contenido de la ventana como una cadena de caracteres; si se incluyen espacios en blanco en la ventana se ve afectado por el atributo @ref{2ee7,,stripspaces}.
@end deffn

@geindex do_command() (método de curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox do_command}@anchor{2ee9}
@deffn {Método} do_command (ch)

Procesa un simple comando al pulsar una tecla.  Aquí está las funciones de tecla especiales admitidas:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Pulsación de tecla

@tab

Acción

@item

@code{Control-A}

@tab

Ve al borde izquierdo de la ventana.

@item

@code{Control-B}

@tab

Cursor hacia la izquierda, pasando a la línea anterior si corresponde.

@item

@code{Control-D}

@tab

Borra el carácter bajo el cursor.

@item

@code{Control-E}

@tab

Ve al borde derecho (quita los espacios) o al final de línea (eliminar los espacios).

@item

@code{Control-F}

@tab

Cursor hacia la derecha, pasando a la línea siguiente cuando corresponda.

@item

@code{Control-G}

@tab

Terminar, retornando el contenido de la ventana.

@item

@code{Control-H}

@tab

Eliminar carácter al revés.

@item

@code{Control-J}

@tab

Terminar si la ventana es de 1 línea, en caso contrario, inserte una nueva línea.

@item

@code{Control-K}

@tab

Si la línea es blanca bórrela, en caso contrario, limpie hasta el final de línea.

@item

@code{Control-L}

@tab

Refrescar la pantalla.

@item

@code{Control-N}

@tab

Cursor hacia abajo; mueve hacia abajo una línea.

@item

@code{Control-O}

@tab

Inserte una línea en blanco en la posición del cursor.

@item

@code{Control-P}

@tab

Cursor hacia arriba; mueve hacia arriba una línea.

@end multitable


Las operaciones de movimiento no hacen nada si el cursor está en un borde donde el movimiento no es posible. Los siguientes sinónimos están apoyados siempre que sea posible:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Pulsación de tecla

@item

@ref{2e5b,,KEY_LEFT}

@tab

@code{Control-B}

@item

@ref{2e5c,,KEY_RIGHT}

@tab

@code{Control-F}

@item

@ref{2e5a,,KEY_UP}

@tab

@code{Control-P}

@item

@ref{2e59,,KEY_DOWN}

@tab

@code{Control-N}

@item

@ref{2e5e,,KEY_BACKSPACE}

@tab

@code{Control-h}

@end multitable


Todas las otras pulsaciones de teclas están tratadas como un comando para insertar el carácter dado y muévase a la derecha (con ajuste en la línea).
@end deffn

@geindex gather() (método de curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox gather}@anchor{2eea}
@deffn {Método} gather ()

Retorne el contenido de la ventana como una cadena de texto; si se incluyen espacios en blanco en la ventana se ve afectado por el miembro @ref{2ee7,,stripspaces}.
@end deffn

@geindex stripspaces (atributo de curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox stripspaces}@anchor{2ee7}
@deffn {Atributo} stripspaces

Este atributo es una bandera que controla la interpretación de los espacios en blanco en la ventana.  Cuando está encendido, los espacios en blanco al final en cada línea son ignorados; cualquier movimiento del cursor que lo coloque en un espacio en blanco final va hasta el final de esa línea, y los espacios en blanco finales son despejados cuando se recopila el contenido de la ventana.
@end deffn
@end deffn

@node curses ascii — Utilities for ASCII characters,curses panel — A panel stack extension for curses,curses textpad— Widget de entrada de texto para programas de curses,Servicios genéricos del sistema operativo
@anchor{library/curses ascii doc}@anchor{2eeb}@anchor{library/curses ascii curses-ascii-utilities-for-ascii-characters}@anchor{2eec}@anchor{library/curses ascii module-curses ascii}@anchor{2d}
@subsection @code{curses.ascii} — Utilities for ASCII characters


@geindex module; curses.ascii

`Source code:' Lib/curses/ascii.py@footnote{https://github.com/python/cpython/tree/main/Lib/curses/ascii.py}


__________________________________________________________________


El módulo @ref{2d,,curses.ascii} proporciona constantes de nombre para caracteres ASCII y funciones para probar la pertenencia a varias clases de los caracteres ASCII.  Las constantes proporcionadas son nombres para caracteres de control de la siguiente manera:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Significado

@item

@geindex NUL (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii NUL}@anchor{2eed}
@deffn {Dato} curses.ascii.NUL
@end deffn

@tab

@item

@geindex SOH (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SOH}@anchor{2eee}
@deffn {Dato} curses.ascii.SOH
@end deffn

@tab

Inicio del encabezado, interrupción de la consola

@item

@geindex STX (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii STX}@anchor{2eef}
@deffn {Dato} curses.ascii.STX
@end deffn

@tab

Inicio del texto

@item

@geindex ETX (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ETX}@anchor{2ef0}
@deffn {Dato} curses.ascii.ETX
@end deffn

@tab

Final del texto

@item

@geindex EOT (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii EOT}@anchor{2ef1}
@deffn {Dato} curses.ascii.EOT
@end deffn

@tab

Fin de la transmisión

@item

@geindex ENQ (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ENQ}@anchor{2ef2}
@deffn {Dato} curses.ascii.ENQ
@end deffn

@tab

Consulta, va con el control de flujo @ref{2ef3,,ACK}

@item

@geindex ACK (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ACK}@anchor{2ef3}
@deffn {Dato} curses.ascii.ACK
@end deffn

@tab

Reconocimiento

@item

@geindex BEL (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii BEL}@anchor{2ef4}
@deffn {Dato} curses.ascii.BEL
@end deffn

@tab

Campana

@item

@geindex BS (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii BS}@anchor{2ef5}
@deffn {Dato} curses.ascii.BS
@end deffn

@tab

Retroceso

@item

@geindex TAB (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii TAB}@anchor{2ef6}
@deffn {Dato} curses.ascii.TAB
@end deffn

@tab

Tabulación

@item

@geindex HT (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii HT}@anchor{2ef7}
@deffn {Dato} curses.ascii.HT
@end deffn

@tab

Alias para @ref{2ef6,,TAB}: «Tabulación horizontal»

@item

@geindex LF (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii LF}@anchor{2ef8}
@deffn {Dato} curses.ascii.LF
@end deffn

@tab

Línea de alimentación

@item

@geindex NL (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii NL}@anchor{2ef9}
@deffn {Dato} curses.ascii.NL
@end deffn

@tab

Alias para @ref{2ef8,,LF}: «Nueva línea»

@item

@geindex VT (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii VT}@anchor{2efa}
@deffn {Dato} curses.ascii.VT
@end deffn

@tab

Tabulación vertical

@item

@geindex FF (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii FF}@anchor{2efb}
@deffn {Dato} curses.ascii.FF
@end deffn

@tab

Alimentación de formulario

@item

@geindex CR (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii CR}@anchor{2efc}
@deffn {Dato} curses.ascii.CR
@end deffn

@tab

Retorno de carro (`Carriage return' en inglés)

@item

@geindex SO (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SO}@anchor{2efd}
@deffn {Dato} curses.ascii.SO
@end deffn

@tab

`Shift-out', comenzar un conjunto de caracteres alternativo

@item

@geindex SI (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SI}@anchor{2efe}
@deffn {Dato} curses.ascii.SI
@end deffn

@tab

`Shift-in', reanudar el conjunto de caracteres predeterminado

@item

@geindex DLE (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DLE}@anchor{2eff}
@deffn {Dato} curses.ascii.DLE
@end deffn

@tab

Escape de enlace de datos

@item

@geindex DC1 (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC1}@anchor{2f00}
@deffn {Dato} curses.ascii.DC1
@end deffn

@tab

XON, para control de flujo

@item

@geindex DC2 (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC2}@anchor{2f01}
@deffn {Dato} curses.ascii.DC2
@end deffn

@tab

Control de dispositivo 2, control de flujo en modo bloque

@item

@geindex DC3 (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC3}@anchor{2f02}
@deffn {Dato} curses.ascii.DC3
@end deffn

@tab

XOFF, para control de flujo

@item

@geindex DC4 (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC4}@anchor{2f03}
@deffn {Dato} curses.ascii.DC4
@end deffn

@tab

Control de dispositivo 4

@item

@geindex NAK (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii NAK}@anchor{2f04}
@deffn {Dato} curses.ascii.NAK
@end deffn

@tab

Reconocimiento negativo

@item

@geindex SYN (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SYN}@anchor{2f05}
@deffn {Dato} curses.ascii.SYN
@end deffn

@tab

Inactivo sincrónico

@item

@geindex ETB (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ETB}@anchor{2f06}
@deffn {Dato} curses.ascii.ETB
@end deffn

@tab

Bloque de transmisión final

@item

@geindex CAN (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii CAN}@anchor{2f07}
@deffn {Dato} curses.ascii.CAN
@end deffn

@tab

Cancelar

@item

@geindex EM (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii EM}@anchor{2f08}
@deffn {Dato} curses.ascii.EM
@end deffn

@tab

Fin del medio

@item

@geindex SUB (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SUB}@anchor{2f09}
@deffn {Dato} curses.ascii.SUB
@end deffn

@tab

Sustituir

@item

@geindex ESC (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ESC}@anchor{2f0a}
@deffn {Dato} curses.ascii.ESC
@end deffn

@tab

Escapar

@item

@geindex FS (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii FS}@anchor{2f0b}
@deffn {Dato} curses.ascii.FS
@end deffn

@tab

Separador de archivos

@item

@geindex GS (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii GS}@anchor{2f0c}
@deffn {Dato} curses.ascii.GS
@end deffn

@tab

Separador de grupos

@item

@geindex RS (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii RS}@anchor{2f0d}
@deffn {Dato} curses.ascii.RS
@end deffn

@tab

Separador de registros, finalizador en modo bloque

@item

@geindex US (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii US}@anchor{2f0e}
@deffn {Dato} curses.ascii.US
@end deffn

@tab

Separador de unidades

@item

@geindex SP (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii SP}@anchor{2f0f}
@deffn {Dato} curses.ascii.SP
@end deffn

@tab

Espacio

@item

@geindex DEL (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii DEL}@anchor{2f10}
@deffn {Dato} curses.ascii.DEL
@end deffn

@tab

Eliminar

@end multitable


Tenga en cuenta que muchos de estos tienen poca importancia práctica en el uso moderno. Los mnemónicos se derivan de las convenciones de la teleimpresora que son anteriores a las computadoras digitales.

El módulo proporciona las siguientes funciones, siguiendo el patrón de las de la biblioteca C estándar:

@geindex isalnum() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isalnum}@anchor{2f11}
@deffn {Función} curses.ascii.isalnum (c)

Comprueba un carácter alfanumérico ASCII; esto es equivalente a @code{isalpha(c) or isdigit(c)}.
@end deffn

@geindex isalpha() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isalpha}@anchor{2f12}
@deffn {Función} curses.ascii.isalpha (c)

Comprueba si hay un carácter alfabético ASCII; es equivalente a @code{isupper(c) or islower(c)}.
@end deffn

@geindex isascii() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isascii}@anchor{2f13}
@deffn {Función} curses.ascii.isascii (c)

Comprueba un valor de carácter que se ajuste al conjunto ASCII de 7 bits.
@end deffn

@geindex isblank() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isblank}@anchor{2f14}
@deffn {Función} curses.ascii.isblank (c)

Comprueba si hay un carácter de espacio en blanco ASCII; espacio o tabulación horizontal.
@end deffn

@geindex iscntrl() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii iscntrl}@anchor{2f15}
@deffn {Función} curses.ascii.iscntrl (c)

Comprueba un carácter de control ASCII (en el rango de 0x00 a 0x1f o 0x7f).
@end deffn

@geindex isdigit() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isdigit}@anchor{2f16}
@deffn {Función} curses.ascii.isdigit (c)

Comprueba si hay un dígito decimal ASCII, desde @code{'0'} hasta @code{'9'}. Esto es equivalente a @code{c in string.digits}.
@end deffn

@geindex isgraph() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isgraph}@anchor{2f17}
@deffn {Función} curses.ascii.isgraph (c)

Comprueba en ASCII cualquier carácter imprimible excepto el espacio.
@end deffn

@geindex islower() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii islower}@anchor{2f18}
@deffn {Función} curses.ascii.islower (c)

Comprueba un carácter ASCII en minúscula.
@end deffn

@geindex isprint() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isprint}@anchor{2f19}
@deffn {Función} curses.ascii.isprint (c)

Comprueba cualquier carácter imprimible ASCII, incluido el espacio.
@end deffn

@geindex ispunct() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ispunct}@anchor{2f1a}
@deffn {Función} curses.ascii.ispunct (c)

Comprueba si hay algún carácter ASCII imprimible que no sea un espacio o un carácter alfanumérico.
@end deffn

@geindex isspace() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isspace}@anchor{2f1b}
@deffn {Función} curses.ascii.isspace (c)

Comprueba los caracteres de espacio en blanco ASCII; espacio, línea de alimentación, retorno de carro, formulario de alimentación, tabulación horizontal, tabulación vertical.
@end deffn

@geindex isupper() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isupper}@anchor{2f1c}
@deffn {Función} curses.ascii.isupper (c)

Comprueba una letra mayúscula ASCII.
@end deffn

@geindex isxdigit() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isxdigit}@anchor{2f1d}
@deffn {Función} curses.ascii.isxdigit (c)

Comprueba si hay un dígito hexadecimal ASCII. Esto es equivalente a @code{c in string.hexdigits}.
@end deffn

@geindex isctrl() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii isctrl}@anchor{2f1e}
@deffn {Función} curses.ascii.isctrl (c)

Comprueba un carácter de control ASCII (valores ordinales de 0 a 31)
@end deffn

@geindex ismeta() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ismeta}@anchor{2f1f}
@deffn {Función} curses.ascii.ismeta (c)

Comprueba si hay un carácter no ASCII (valores ordinales 0x80 y superiores).
@end deffn

Estas funciones aceptan enteros o cadenas de un solo carácter; cuando el argumento es una cadena de caracteres, primero se convierte utilizando la función `built-in' @ref{1eef,,ord()}.

Tenga en cuenta que todas estas funciones verifican los valores de bits ordinales derivados del carácter de la cadena que ingresa; en realidad, no saben nada sobre la codificación de caracteres de la máquina host.

Las siguientes dos funciones toman una cadena de un solo carácter o un valor de byte entero; devuelven un valor del mismo tipo.

@geindex ascii() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ascii}@anchor{2f20}
@deffn {Función} curses.ascii.ascii (c)

Retorna el valor ASCII correspondiente a los 7 bits bajos de `c'.
@end deffn

@geindex ctrl() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii ctrl}@anchor{2f21}
@deffn {Función} curses.ascii.ctrl (c)

Retorna el carácter de control correspondiente al carácter dado (el valor del bit del carácter es bit a bit (`bitwise-anded') con 0x1f).
@end deffn

@geindex alt() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii alt}@anchor{2f22}
@deffn {Función} curses.ascii.alt (c)

Retorna el carácter de 8 bits correspondiente al carácter ASCII dado (el valor del bit de carácter se escribe bit a bit (`bitwise-ored') con 0x80).
@end deffn

La siguiente función toma una cadena de un solo carácter o un valor entero; devuelve una cadena.

@geindex ^ (caret);in curses module
@geindex ! (exclamation);in curses module

@geindex unctrl() (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii unctrl}@anchor{2f23}
@deffn {Función} curses.ascii.unctrl (c)

Retorna una representación de cadena del carácter ASCII `c'. Si `c' es imprimible, esta cadena es el propio carácter. Si el carácter es un carácter de control (0x00–0x1f) la cadena consta de un signo de intercalación (@code{'^'}) seguido de la letra mayúscula correspondiente. Si el carácter es una eliminación ASCII (0x7f), la cadena es @code{'^?'}. Si el carácter tiene su meta bit establecido (0x80), el meta bit se elimina, se aplican las reglas anteriores y se antepone @code{'!'} al resultado.
@end deffn

@geindex controlnames (en el módulo curses.ascii)
@anchor{library/curses ascii curses ascii controlnames}@anchor{2f24}
@deffn {Dato} curses.ascii.controlnames

Una matriz de cadena de caracteres de 33 elementos que contiene los mnemónicos ASCII para los treinta y dos caracteres de control ASCII desde 0 (NUL) a 0x1f (US), en orden, más el mnemónico @code{SP} para el carácter de espacio.
@end deffn

@node curses panel — A panel stack extension for curses,platform — Access to underlying platform’s identifying data,curses ascii — Utilities for ASCII characters,Servicios genéricos del sistema operativo
@anchor{library/curses panel doc}@anchor{2f25}@anchor{library/curses panel curses-panel-a-panel-stack-extension-for-curses}@anchor{2f26}@anchor{library/curses panel module-curses panel}@anchor{2e}
@subsection @code{curses.panel} — A panel stack extension for curses


@geindex module; curses.panel


__________________________________________________________________


Los paneles son ventanas con la característica de profundidad añadida, por lo que se pueden apilar una encima de la otra, y solo se mostrarán las partes visibles de cada ventana. Los paneles se pueden agregar, mover hacia arriba o hacia abajo en la pila y eliminarse.

@menu
* Funciones: Funciones<5>. 
* Objetos de panel:: 

@end menu

@node Funciones<5>,Objetos de panel,,curses panel — A panel stack extension for curses
@anchor{library/curses panel cursespanel-functions}@anchor{2f27}@anchor{library/curses panel functions}@anchor{2f28}
@subsubsection Funciones


El módulo @ref{2e,,curses.panel} define las siguientes funciones:

@geindex bottom_panel() (en el módulo curses.panel)
@anchor{library/curses panel curses panel bottom_panel}@anchor{2f29}
@deffn {Función} curses.panel.bottom_panel ()

Retorna el panel inferior en la pila del panel.
@end deffn

@geindex new_panel() (en el módulo curses.panel)
@anchor{library/curses panel curses panel new_panel}@anchor{2f2a}
@deffn {Función} curses.panel.new_panel (win)

Retorna un objeto de panel, asociándolo con la ventana dada `win'. Tenga en cuenta que debe mantener explícitamente el objeto de panel retornado al que se hace referencia. Si no lo hace, el objeto de panel se recoge como basura y elimina de la pila del panel.
@end deffn

@geindex top_panel() (en el módulo curses.panel)
@anchor{library/curses panel curses panel top_panel}@anchor{2f2b}
@deffn {Función} curses.panel.top_panel ()

Retorna el panel superior de la pila de paneles.
@end deffn

@geindex update_panels() (en el módulo curses.panel)
@anchor{library/curses panel curses panel update_panels}@anchor{2f2c}
@deffn {Función} curses.panel.update_panels ()

Actualiza la pantalla virtual después de los cambios en la pila del panel. Esto no llama a @ref{2db6,,curses.doupdate()}, por lo que tendrás que hacerlo tú mismo.
@end deffn

@node Objetos de panel,,Funciones<5>,curses panel — A panel stack extension for curses
@anchor{library/curses panel curses-panel-objects}@anchor{2f2d}@anchor{library/curses panel panel-objects}@anchor{2f2e}
@subsubsection Objetos de panel


Los objetos panel, retornados por @ref{2f2a,,new_panel()} arriba, son ventanas con un orden de apilamiento. Siempre hay una ventana asociada a un panel que determina el contenido, mientras que los métodos del panel son responsables de la profundidad de la ventana en la pila del panel.

Los objetos de panel tienen los siguientes métodos:

@geindex above() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel above}@anchor{2f2f}
@deffn {Método} Panel.above ()

Retorna el panel situado encima del panel actual.
@end deffn

@geindex below() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel below}@anchor{2f30}
@deffn {Método} Panel.below ()

Retorna el panel debajo del panel actual.
@end deffn

@geindex bottom() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel bottom}@anchor{2f31}
@deffn {Método} Panel.bottom ()

Empuja el panel hasta la parte inferior de la pila.
@end deffn

@geindex hidden() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel hidden}@anchor{2f32}
@deffn {Método} Panel.hidden ()

Retorna @code{True} si el panel está oculto (no visible), @code{False} en caso contrario.
@end deffn

@geindex hide() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel hide}@anchor{2f33}
@deffn {Método} Panel.hide ()

Ocultar el panel. Esto no elimina el objeto, solo hace que la ventana en la pantalla sea invisible.
@end deffn

@geindex move() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel move}@anchor{2f34}
@deffn {Método} Panel.move (y, x)

Mueve el panel a las coordenadas de pantalla @code{(y, x)}.
@end deffn

@geindex replace() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel replace}@anchor{2f35}
@deffn {Método} Panel.replace (win)

Cambia la ventana asociada con el panel a la ventana `win'.
@end deffn

@geindex set_userptr() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel set_userptr}@anchor{2f36}
@deffn {Método} Panel.set_userptr (obj)

Establece el puntero de usuario del panel en `obj'. Esto se usa para asociar un dato arbitrario con el panel y puede ser cualquier objeto de Python.
@end deffn

@geindex show() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel show}@anchor{2f37}
@deffn {Método} Panel.show ()

Muestra el panel (que podría haber estado oculto).
@end deffn

@geindex top() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel top}@anchor{2f38}
@deffn {Método} Panel.top ()

Empuja el panel hacia la parte superior de la pila.
@end deffn

@geindex userptr() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel userptr}@anchor{2f39}
@deffn {Método} Panel.userptr ()

Retorna el puntero del usuario para el panel. Puede ser cualquier objeto de Python.
@end deffn

@geindex window() (método de curses.panel.Panel)
@anchor{library/curses panel curses panel Panel window}@anchor{2f3a}
@deffn {Método} Panel.window ()

Retorna el objeto de ventana asociado con el panel.
@end deffn

@node platform — Access to underlying platform’s identifying data,errno — Standard errno system symbols,curses panel — A panel stack extension for curses,Servicios genéricos del sistema operativo
@anchor{library/platform doc}@anchor{2f3b}@anchor{library/platform module-platform}@anchor{aa}@anchor{library/platform platform-access-to-underlying-platform-s-identifying-data}@anchor{2f3c}
@subsection @code{platform} —  Access to underlying platform’s identifying data


@geindex module; platform

`código fuente:' Lib/platform.py@footnote{https://github.com/python/cpython/tree/main/Lib/platform.py}


__________________________________________________________________


@cartouche
@quotation Nota 
Plataformas específicas listadas alfabéticamente, con Linux incluido en la sección de Unix.
@end quotation
@end cartouche

@menu
* Plataforma cruzada:: 
* Plataforma Java:: 
* Plataforma windows:: 
* Plataforma macOS:: 
* iOS Platform:: 
* Plataformas Unix:: 
* Plataformas Linux:: 
* Android Platform:: 
* Miscellaneous:: 

@end menu

@node Plataforma cruzada,Plataforma Java,,platform — Access to underlying platform’s identifying data
@anchor{library/platform cross-platform}@anchor{2f3d}
@subsubsection Plataforma cruzada


@geindex architecture() (en el módulo platform)
@anchor{library/platform platform architecture}@anchor{1695}
@deffn {Función} platform.architecture (executable=sys.executable, bits='@w{'}, linkage='@w{'})

Consulta el ejecutable provisto (por defecto el archivo binario del intérprete de Python) para obtener información de diversas arquitecturas.

Retorna una tupla @code{(bits, linkage)}, siendo `bits' la información sobre la arquitectura del procesador y `linkage' el formato de conexión usado por el ejecutable. Ambos valores se retornan como cadenas.

Los valores que no se pueden determinar se retornan según lo indicado por los ajustes por defecto de los parámetros. Si bits se da como @code{'@w{'}}, el @code{sizeof(pointer)} (o @code{sizeof(long)} en la versión de Python < 1.5.2) se utiliza como indicador para el tamaño del puntero admitido.

La función se basa en el comando @code{file} del sistema para realizar la tarea. Está disponible en la mayoría de las plataformas Unix, si no en todas, y en algunas plataformas que no son de Unix y solo si el ejecutable apunta al intérprete de Python. Unos valores por defecto se utilizan cuando no se satisfacen las necesidades anteriores.

@cartouche
@quotation Nota 
En macOS (y quizás en otras plataformas), los archivos ejecutables pueden ser archivos universales que contienen múltiples arquitecturas.

Para saber si el intérprete actual es de 64-bits, es más fiable consultar el atributo @ref{1232,,sys.maxsize}:

@example
is_64bits = sys.maxsize > 2**32
@end example
@end quotation
@end cartouche
@end deffn

@geindex machine() (en el módulo platform)
@anchor{library/platform platform machine}@anchor{2f3e}
@deffn {Función} platform.machine ()

Retorna el tipo de máquina, por ejemplo @code{'i386'}. Si no se puede determinar el valor, retorna una cadena vacía.
@end deffn

@geindex node() (en el módulo platform)
@anchor{library/platform platform node}@anchor{2f3f}
@deffn {Función} platform.node ()

Retorna el nombre de la red del ordenador (¡tal vez no sea el nombre completo!). Si no se puede determinar el valor, se retorna una cadena vacía.
@end deffn

@geindex platform() (en el módulo platform)
@anchor{library/platform platform platform}@anchor{175d}
@deffn {Función} platform.platform (aliased=False, terse=False)

Retorna una sola cadena identificando la plataforma subyacente con la mayor información útil posible.

La salida se intenta que sea `humanamente legible' más que tratable por una máquina. Tal vez la salida sea diferente en diversas plataformas y eso mismo es lo que se pretende.

Si `aliased' es verdadero, la función usará aliases para varias plataformas que informen de nombres de sistema que sean diferentes a sus nombres comunes. Por ejemplo, SunOS se reportará como Solaris. La función @ref{2f40,,system_alias()} ha sido usada para implementar esto.

Estableciendo `terse' a verdadero provoca que la función retorne el mínimo de información necesaria para identificar la plataforma.


Distinto en la versión 3.8: En macOS, la función ahora usa @ref{1a3b,,mac_ver()}, si retorna una cadena no vacía para obtener la versión de macOS más que la versión de darwin.

@end deffn

@geindex processor() (en el módulo platform)
@anchor{library/platform platform processor}@anchor{2f41}
@deffn {Función} platform.processor ()

Retorna el nombre (real) del procesador. E.j. @code{'amdk6'}.

Una cadena vacía se retorna si el valor no se puede determinar. Destacar que muchas plataformas no proveen esta información o simplemente retorna los mismos valores que para @ref{2f3e,,machine()}, como hace NetBSD.
@end deffn

@geindex python_build() (en el módulo platform)
@anchor{library/platform platform python_build}@anchor{2f42}
@deffn {Función} platform.python_build ()

Retorna una tupla @code{(buildno, builddate)} con `buildno' indicando el número de la build de Python y `builddate' su fecha de publicación como cadenas.
@end deffn

@geindex python_compiler() (en el módulo platform)
@anchor{library/platform platform python_compiler}@anchor{2f43}
@deffn {Función} platform.python_compiler ()

Retorna la string con la identificación del compilador usado para compilar Python.
@end deffn

@geindex python_branch() (en el módulo platform)
@anchor{library/platform platform python_branch}@anchor{2f44}
@deffn {Función} platform.python_branch ()

Retorna la string identificando la implementación de la rama SCM de Python.
@end deffn

@geindex python_implementation() (en el módulo platform)
@anchor{library/platform platform python_implementation}@anchor{2f45}
@deffn {Función} platform.python_implementation ()

Retorna la string identificando la implementación de Python. Algunos valores posibles son: “CPython”, “IronPython”, “Jython”, “PyPy”.
@end deffn

@geindex python_revision() (en el módulo platform)
@anchor{library/platform platform python_revision}@anchor{2f46}
@deffn {Función} platform.python_revision ()

Retorna la string identificando la implementación de la revisión SCM de Python.
@end deffn

@geindex python_version() (en el módulo platform)
@anchor{library/platform platform python_version}@anchor{2f47}
@deffn {Función} platform.python_version ()

Retorna la versión de Python en formato de cadena de caracteres con la forma @code{'major.minor.patchlevel'} siendo `major' la versión principal, `minor' la versión menor y `patchlevel' el último parche aplicado.

Destacar que a diferencia del @code{sys.version} de Python, el valor retornado siempre incluirá el último parche aplicado (siendo 0 por defecto).
@end deffn

@geindex python_version_tuple() (en el módulo platform)
@anchor{library/platform platform python_version_tuple}@anchor{2f48}
@deffn {Función} platform.python_version_tuple ()

Retorna la versión de Python como una tupla @code{(major, minor, patchlevel)} de cadena, siendo `major' la versión principal, `minor' la versión menor y `patchlevel' último parche aplicado.

Destacar que a diferencia del @code{sys.version} de Python, el valor retornado siempre incluirá el último parche aplicado (siendo @code{'0'} por defecto).
@end deffn

@geindex release() (en el módulo platform)
@anchor{library/platform platform release}@anchor{2f49}
@deffn {Función} platform.release ()

Retorna la versión de publicación del sistema. Por ejemplo @code{'2.2.0'} o @code{'NT'}. Si no se puede determinar el valor, retorna una cadena vacía.
@end deffn

@geindex system() (en el módulo platform)
@anchor{library/platform platform system}@anchor{1e64}
@deffn {Función} platform.system ()

Retorna el nombre del sistema/SO, como @code{'Linux'}, @code{'Darwin'}, @code{'Java'}, @code{'Windows'}. Si no se puede determinar el valor, retorna una cadena vacía.

On iOS and Android, this returns the user-facing OS name (i.e, @code{'iOS},
@code{'iPadOS'} or @code{'Android'}). To obtain the kernel name (@code{'Darwin'} or
@code{'Linux'}), use @ref{1188,,os.uname()}.
@end deffn

@geindex system_alias() (en el módulo platform)
@anchor{library/platform platform system_alias}@anchor{2f40}
@deffn {Función} platform.system_alias (system, release, version)

Retorna la tupla @code{(system, release, version)} con los alias de los nombres comerciales usados por algunos sistemas siendo `system' el nombre comercial del sistema, `release' como la versión principal de publicación y `version' como el número de la versión del sistema. También hace cierta reordenación de la información en algunos casos donde se produjera algún tipo de confusión.
@end deffn

@geindex version() (en el módulo platform)
@anchor{library/platform platform version}@anchor{2f4a}
@deffn {Función} platform.version ()

Retorna la versión de la publicación del sistema. Por ejemplo: @code{'#3 on degas'}. Una cadena vacía se retorna en el caso de que el valor no pueda ser determinado.

On iOS and Android, this is the user-facing OS version. To obtain the
Darwin or Linux kernel version, use @ref{1188,,os.uname()}.
@end deffn

@geindex uname() (en el módulo platform)
@anchor{library/platform platform uname}@anchor{1a39}
@deffn {Función} platform.uname ()

Interfaz uname relativamente portable. Retorna una @ref{32d,,namedtuple()} con seis atributos: @ref{1e64,,system}, @ref{2f3f,,node}, @ref{2f49,,release}, @ref{2f4a,,version}, @ref{2f3e,,machine}, and @ref{2f41,,processor}.

@ref{2f41,,processor} es resuelto de forma tardía, bajo demanda.

Nota: los nombres de los dos primeros atributos difieren de los nombres presentados por @ref{1188,,os.uname()}, donde son llamados @code{sysname} y @code{nodename}.

Cualquier entrada que no pueda ser determinada se establece como @code{'@w{'}}.


Distinto en la versión 3.3: El resultado ha cambiado de tupla @ref{32d,,namedtuple()}..



Distinto en la versión 3.9: @ref{2f41,,processor} es resuelto de forma tardía en lugar de inmediatamente.

@end deffn

@node Plataforma Java,Plataforma windows,Plataforma cruzada,platform — Access to underlying platform’s identifying data
@anchor{library/platform java-platform}@anchor{2f4b}
@subsubsection Plataforma Java


@geindex java_ver() (en el módulo platform)
@anchor{library/platform platform java_ver}@anchor{1d6}
@deffn {Función} platform.java_ver (release='@w{'}, vendor='@w{'}, vminfo=('@w{'}, '@w{'}, '@w{'}), osinfo=('@w{'}, '@w{'}, '@w{'}))

Versión de la interfaz de Jython.

Retorna una tupla @code{(release, vendor, vminfo, osinfo)} con `vminfo' siendo una tupla @code{(vm_name, vm_release, vm_vendor)} y `osinfo' siendo una tupla @code{(os_name, os_version, os_arch)}. Los valores que no se pueden determinar son establecidos por defecto por los parámetros (todos los valores predeterminados son @code{'@w{'}}).


Deprecated since version 3.13, will be removed in version 3.15: It was largely untested, had a confusing API,
and was only useful for Jython support.

@end deffn

@node Plataforma windows,Plataforma macOS,Plataforma Java,platform — Access to underlying platform’s identifying data
@anchor{library/platform windows-platform}@anchor{2f4c}
@subsubsection Plataforma windows


@geindex win32_ver() (en el módulo platform)
@anchor{library/platform platform win32_ver}@anchor{1968}
@deffn {Función} platform.win32_ver (release='@w{'}, version='@w{'}, csd='@w{'}, ptype='@w{'})

Obtiene información adicional de la versión de registro de windows y retorna una tupla @code{(release, version, csd, ptype)} la cual se refiere a la versión del sistema operativo, número de su versión , nivel CSD (service pack) y el tipo de sistema operativo (multi/único procesador). Los valores que no se pueden determinar son establecidos por defecto por los parámetros (todos los valores predeterminados son una cadena vacía).

As a hint: `ptype' is @code{'Uniprocessor Free'} on single processor NT machines
and @code{'Multiprocessor Free'} on multi processor machines. The @code{'Free'} refers
to the OS version being free of debugging code. It could also state @code{'Checked'}
which means the OS version uses debugging code, i.e. code that checks arguments,
ranges, etc.
@end deffn

@geindex win32_edition() (en el módulo platform)
@anchor{library/platform platform win32_edition}@anchor{2f4d}
@deffn {Función} platform.win32_edition ()

Retorna una cadena que representa la edición actual de Windows o @code{None} si el valor no puede ser determinado. Los valores posibles incluyen, entre otros, @code{'Enterprise'}, @code{'IoTUAP'}, @code{'ServerStandard'}  y @code{'nanoserver'}.


Added in version 3.8.

@end deffn

@geindex win32_is_iot() (en el módulo platform)
@anchor{library/platform platform win32_is_iot}@anchor{2f4e}
@deffn {Función} platform.win32_is_iot ()

Retorna @code{True} si la edición de Windows retornada por @ref{2f4d,,win32_edition()} se reconoce como una edición IoT.


Added in version 3.8.

@end deffn

@node Plataforma macOS,iOS Platform,Plataforma windows,platform — Access to underlying platform’s identifying data
@anchor{library/platform macos-platform}@anchor{2f4f}
@subsubsection Plataforma macOS


@geindex mac_ver() (en el módulo platform)
@anchor{library/platform platform mac_ver}@anchor{1a3b}
@deffn {Función} platform.mac_ver (release='@w{'}, versioninfo=('@w{'}, '@w{'}, '@w{'}), machine='@w{'})

Obtenga información de la versión de macOS y devuélvala como tupla @code{(release, versioninfo, machine)} con `versioninfo' como tupla @code{(version, dev_stage, non_release_version)}.

Cualquier registro que no puede ser determinado se establece como @code{'@w{'}}. Todas los registros de la tupla son cadenas.
@end deffn

@node iOS Platform,Plataformas Unix,Plataforma macOS,platform — Access to underlying platform’s identifying data
@anchor{library/platform ios-platform}@anchor{2f50}
@subsubsection iOS Platform


@geindex ios_ver() (en el módulo platform)
@anchor{library/platform platform ios_ver}@anchor{1e63}
@deffn {Función} platform.ios_ver (system='@w{'}, release='@w{'}, model='@w{'}, is_simulator=False)

Get iOS version information and return it as a
@ref{32d,,namedtuple()} with the following attributes:


@itemize *

@item 
@code{system} is the OS name; either @code{'iOS'} or @code{'iPadOS'}.

@item 
@code{release} is the iOS version number as a string (e.g., @code{'17.2'}).

@item 
@code{model} is the device model identifier; this will be a string like
@code{'iPhone13,2'} for a physical device, or @code{'iPhone'} on a simulator.

@item 
@code{is_simulator} is a boolean describing if the app is running on a
simulator or a physical device.
@end itemize

Entries which cannot be determined are set to the defaults given as
parameters.
@end deffn

@node Plataformas Unix,Plataformas Linux,iOS Platform,platform — Access to underlying platform’s identifying data
@anchor{library/platform unix-platforms}@anchor{2f51}
@subsubsection Plataformas Unix


@geindex libc_ver() (en el módulo platform)
@anchor{library/platform platform libc_ver}@anchor{1a38}
@deffn {Función} platform.libc_ver (executable=sys.executable, lib='@w{'}, version='@w{'}, chunksize=16384)

Intenta determinar la versión libc al que está enlazado el fichero ejecutable (por defecto el intérprete de Python). Retorna una tupla de cadenas @code{(lib, version)} que tiene por defecto los parámetros que han sido introducidos en caso de que la búsqueda fallase.

Destacar que esta función tiene un conocimiento íntimo de cómo las diferentes versiones de libc agregan símbolos al ejecutable. Probablemente sólo se puede utilizar para los ejecutables compilados mediante @code{gcc}.

El archivo se lee y se analiza en fragmentos de bytes `chunksize'.
@end deffn

@node Plataformas Linux,Android Platform,Plataformas Unix,platform — Access to underlying platform’s identifying data
@anchor{library/platform linux-platforms}@anchor{2f52}
@subsubsection Plataformas Linux


@geindex freedesktop_os_release() (en el módulo platform)
@anchor{library/platform platform freedesktop_os_release}@anchor{8bd}
@deffn {Función} platform.freedesktop_os_release ()

Obtiene la identificación del sistema operativo del archivo @code{os-release} y la retorna como dict. El archivo @code{os-release} es un freedesktop.org standard@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html} y está disponible en la mayoría de las distribuciones de Linux. Una excepción notable son las distribuciones de Android y basadas en Android.

Lanza @ref{4d5,,OSError} o subclase cuando no se pueden leer ni @code{/etc/os-release} ni @code{/usr/lib/os-release}.

En caso de éxito, la función retorna un diccionario donde las claves y los valores son cadenas de caracteres. Los valores tienen sus caracteres especiales como @code{"} y @code{$} sin comillas. Los campos @code{NAME}, @code{ID} y @code{PRETTY_NAME} siempre se definen de acuerdo con el estándar. Todos los demás campos son opcionales. Los proveedores pueden incluir campos adicionales.

Tenga en cuenta que campos como @code{NAME}, @code{VERSION} y @code{VARIANT} son cadenas de caracteres adecuadas para la presentación a los usuarios. Los programas deben usar campos como @code{ID}, @code{ID_LIKE}, @code{VERSION_ID} o @code{VARIANT_ID} para identificar distribuciones de Linux.

Ejemplo:

@example
def get_like_distro():
    info = platform.freedesktop_os_release()
    ids = [info["ID"]]
    if "ID_LIKE" in info:
        # ids are space separated and ordered by precedence
        ids.extend(info["ID_LIKE"].split())
    return ids
@end example


Added in version 3.10.

@end deffn

@node Android Platform,Miscellaneous,Plataformas Linux,platform — Access to underlying platform’s identifying data
@anchor{library/platform android-platform}@anchor{2f53}
@subsubsection Android Platform


@geindex android_ver() (en el módulo platform)
@anchor{library/platform platform android_ver}@anchor{1657}
@deffn {Función} platform.android_ver (release='@w{'}, api_level=0, manufacturer='@w{'}, model='@w{'}, device='@w{'}, is_emulator=False)

Get Android device information. Returns a @ref{32d,,namedtuple()}
with the following attributes. Values which cannot be determined are set to
the defaults given as parameters.


@itemize *

@item 
@code{release} - Android version, as a string (e.g. @code{"14"}).

@item 
@code{api_level} - API level of the running device, as an integer (e.g. @code{34}
for Android 14). To get the API level which Python was built against, see
@ref{c12,,sys.getandroidapilevel()}.

@item 
@code{manufacturer} - Manufacturer name@footnote{https://developer.android.com/reference/android/os/Build#MANUFACTURER}.

@item 
@code{model} - Model name@footnote{https://developer.android.com/reference/android/os/Build#MODEL} –
typically the marketing name or model number.

@item 
@code{device} - Device name@footnote{https://developer.android.com/reference/android/os/Build#DEVICE} –
typically the model number or a codename.

@item 
@code{is_emulator} - @code{True} if the device is an emulator; @code{False} if it’s
a physical device.
@end itemize

Google maintains a list of known model and device names@footnote{https://storage.googleapis.com/play_public/supported_devices.html}.


Added in version 3.13.

@end deffn

@node Miscellaneous,,Android Platform,platform — Access to underlying platform’s identifying data
@anchor{library/platform miscellaneous}@anchor{2f54}
@subsubsection Miscellaneous


@geindex invalidate_caches() (en el módulo platform)
@anchor{library/platform platform invalidate_caches}@anchor{1a4}
@deffn {Función} platform.invalidate_caches ()

Clear out the internal cache of information, such as the @ref{1a39,,uname()}.
This is typically useful when the platform’s @ref{2f3f,,node()} is changed
by an external process and one needs to retrieve the updated value.


Added in version 3.14.

@end deffn

@node errno — Standard errno system symbols,ctypes — A foreign function library for Python,platform — Access to underlying platform’s identifying data,Servicios genéricos del sistema operativo
@anchor{library/errno doc}@anchor{2f55}@anchor{library/errno errno-standard-errno-system-symbols}@anchor{2f56}@anchor{library/errno module-errno}@anchor{57}
@subsection @code{errno} — Standard errno system symbols


@geindex module; errno


__________________________________________________________________


Este módulo pone a disposición los símbolos del sistema @code{errno} estándar. El valor de cada símbolo es el valor entero correspondiente. Los nombres y las descripciones se toman prestados de @code{linux/include/errno.h}, que debería incluir todo.

@geindex errorcode (en el módulo errno)
@anchor{library/errno errno errorcode}@anchor{2f57}
@deffn {Dato} errno.errorcode

Diccionario que proporciona un mapeo del valor de errno al nombre de la cadena en el sistema subyacente. Por ejemplo, @code{errno.errorcode[errno.EPERM]} se asigna a @code{'EPERM'}.
@end deffn

Para traducir un código de error numérico en un mensaje de error, use @ref{2b28,,os.strerror()}.

De la siguiente lista, los símbolos que no se utilizan en la plataforma actual no están definidos por el módulo. La lista específica de símbolos definidos está disponible como @code{errno.errorcode.keys()}. Los símbolos disponibles pueden incluir:

@geindex EPERM (en el módulo errno)
@anchor{library/errno errno EPERM}@anchor{17d3}
@deffn {Dato} errno.EPERM

Operación no permitida. Este error se asigna a la excepción @ref{dc9,,PermissionError}.
@end deffn

@geindex ENOENT (en el módulo errno)
@anchor{library/errno errno ENOENT}@anchor{22ad}
@deffn {Dato} errno.ENOENT

El archivo o directorio no existe. Este error se asigna a la excepción @ref{f46,,FileNotFoundError}.
@end deffn

@geindex ESRCH (en el módulo errno)
@anchor{library/errno errno ESRCH}@anchor{22b1}
@deffn {Dato} errno.ESRCH

No hay tal proceso. Este error se asigna a la excepción @ref{10d7,,ProcessLookupError}.
@end deffn

@geindex EINTR (en el módulo errno)
@anchor{library/errno errno EINTR}@anchor{e0d}
@deffn {Dato} errno.EINTR

Llamada al sistema interrumpida. Este error se asigna a la excepción @ref{e0e,,InterruptedError}.
@end deffn

@geindex EIO (en el módulo errno)
@anchor{library/errno errno EIO}@anchor{2f58}
@deffn {Dato} errno.EIO

Error de E/S
@end deffn

@geindex ENXIO (en el módulo errno)
@anchor{library/errno errno ENXIO}@anchor{2f59}
@deffn {Dato} errno.ENXIO

No existe tal dispositivo o dirección
@end deffn

@geindex E2BIG (en el módulo errno)
@anchor{library/errno errno E2BIG}@anchor{2f5a}
@deffn {Dato} errno.E2BIG

Lista de argumentos demasiado larga
@end deffn

@geindex ENOEXEC (en el módulo errno)
@anchor{library/errno errno ENOEXEC}@anchor{2f5b}
@deffn {Dato} errno.ENOEXEC

Error de formato de ejecución
@end deffn

@geindex EBADF (en el módulo errno)
@anchor{library/errno errno EBADF}@anchor{9ee}
@deffn {Dato} errno.EBADF

Número de archivo incorrecto
@end deffn

@geindex ECHILD (en el módulo errno)
@anchor{library/errno errno ECHILD}@anchor{22a6}
@deffn {Dato} errno.ECHILD

No hay procesos secundarios. Este error se asigna a la excepción @ref{10d4,,ChildProcessError}.
@end deffn

@geindex EAGAIN (en el módulo errno)
@anchor{library/errno errno EAGAIN}@anchor{22a1}
@deffn {Dato} errno.EAGAIN

Intentar otra vez. Este error se asigna a la excepción @ref{10d3,,BlockingIOError}.
@end deffn

@geindex ENOMEM (en el módulo errno)
@anchor{library/errno errno ENOMEM}@anchor{2f5c}
@deffn {Dato} errno.ENOMEM

Sin memoria
@end deffn

@geindex EACCES (en el módulo errno)
@anchor{library/errno errno EACCES}@anchor{22b0}
@deffn {Dato} errno.EACCES

Permiso denegado. Este error se asigna a la excepción @ref{dc9,,PermissionError}.
@end deffn

@geindex EFAULT (en el módulo errno)
@anchor{library/errno errno EFAULT}@anchor{2f5d}
@deffn {Dato} errno.EFAULT

Dirección incorrecta
@end deffn

@geindex ENOTBLK (en el módulo errno)
@anchor{library/errno errno ENOTBLK}@anchor{2f5e}
@deffn {Dato} errno.ENOTBLK

Bloquear dispositivo requerido
@end deffn

@geindex EBUSY (en el módulo errno)
@anchor{library/errno errno EBUSY}@anchor{2f5f}
@deffn {Dato} errno.EBUSY

Dispositivo o recurso ocupado
@end deffn

@geindex EEXIST (en el módulo errno)
@anchor{library/errno errno EEXIST}@anchor{22ac}
@deffn {Dato} errno.EEXIST

El archivo existe. Este error se asigna a la excepción @ref{109c,,FileExistsError}.
@end deffn

@geindex EXDEV (en el módulo errno)
@anchor{library/errno errno EXDEV}@anchor{2b3f}
@deffn {Dato} errno.EXDEV

Enlace entre dispositivos
@end deffn

@geindex ENODEV (en el módulo errno)
@anchor{library/errno errno ENODEV}@anchor{2f60}
@deffn {Dato} errno.ENODEV

Hay tal dispositivo
@end deffn

@geindex ENOTDIR (en el módulo errno)
@anchor{library/errno errno ENOTDIR}@anchor{22af}
@deffn {Dato} errno.ENOTDIR

No es un directorio. Este error se asigna a la excepción @ref{10d6,,NotADirectoryError}.
@end deffn

@geindex EISDIR (en el módulo errno)
@anchor{library/errno errno EISDIR}@anchor{22ae}
@deffn {Dato} errno.EISDIR

Es un directorio. Este error se asigna a la excepción @ref{10d5,,IsADirectoryError}.
@end deffn

@geindex EINVAL (en el módulo errno)
@anchor{library/errno errno EINVAL}@anchor{19f8}
@deffn {Dato} errno.EINVAL

Argumento inválido
@end deffn

@geindex ENFILE (en el módulo errno)
@anchor{library/errno errno ENFILE}@anchor{2f61}
@deffn {Dato} errno.ENFILE

Desbordamiento de la tabla de archivos
@end deffn

@geindex EMFILE (en el módulo errno)
@anchor{library/errno errno EMFILE}@anchor{2f62}
@deffn {Dato} errno.EMFILE

Demasiados archivos abiertos
@end deffn

@geindex ENOTTY (en el módulo errno)
@anchor{library/errno errno ENOTTY}@anchor{2f63}
@deffn {Dato} errno.ENOTTY

No es un typewriter
@end deffn

@geindex ETXTBSY (en el módulo errno)
@anchor{library/errno errno ETXTBSY}@anchor{2f64}
@deffn {Dato} errno.ETXTBSY

Archivo de texto ocupado
@end deffn

@geindex EFBIG (en el módulo errno)
@anchor{library/errno errno EFBIG}@anchor{2f65}
@deffn {Dato} errno.EFBIG

Archivo demasiado grande
@end deffn

@geindex ENOSPC (en el módulo errno)
@anchor{library/errno errno ENOSPC}@anchor{2f66}
@deffn {Dato} errno.ENOSPC

No queda espacio en el dispositivo
@end deffn

@geindex ESPIPE (en el módulo errno)
@anchor{library/errno errno ESPIPE}@anchor{2f67}
@deffn {Dato} errno.ESPIPE

Búsqueda ilegal
@end deffn

@geindex EROFS (en el módulo errno)
@anchor{library/errno errno EROFS}@anchor{2f68}
@deffn {Dato} errno.EROFS

Sistema de archivos de sólo lectura
@end deffn

@geindex EMLINK (en el módulo errno)
@anchor{library/errno errno EMLINK}@anchor{2f69}
@deffn {Dato} errno.EMLINK

Demasiados enlaces
@end deffn

@geindex EPIPE (en el módulo errno)
@anchor{library/errno errno EPIPE}@anchor{22a7}
@deffn {Dato} errno.EPIPE

Tubería rota. Este error se asigna a la excepción @ref{10d8,,BrokenPipeError}.
@end deffn

@geindex EDOM (en el módulo errno)
@anchor{library/errno errno EDOM}@anchor{2f6a}
@deffn {Dato} errno.EDOM

Argumento matemático fuera del dominio de función
@end deffn

@geindex ERANGE (en el módulo errno)
@anchor{library/errno errno ERANGE}@anchor{2f6b}
@deffn {Dato} errno.ERANGE

Resultado matemático no representable
@end deffn

@geindex EDEADLK (en el módulo errno)
@anchor{library/errno errno EDEADLK}@anchor{2f6c}
@deffn {Dato} errno.EDEADLK

Podría ocurrir un bloqueo de recursos
@end deffn

@geindex ENAMETOOLONG (en el módulo errno)
@anchor{library/errno errno ENAMETOOLONG}@anchor{2f6d}
@deffn {Dato} errno.ENAMETOOLONG

Nombre de archivo demasiado largo
@end deffn

@geindex ENOLCK (en el módulo errno)
@anchor{library/errno errno ENOLCK}@anchor{2f6e}
@deffn {Dato} errno.ENOLCK

No hay bloqueos de registro disponibles
@end deffn

@geindex ENOSYS (en el módulo errno)
@anchor{library/errno errno ENOSYS}@anchor{17d4}
@deffn {Dato} errno.ENOSYS

Función no implementada
@end deffn

@geindex ENOTEMPTY (en el módulo errno)
@anchor{library/errno errno ENOTEMPTY}@anchor{2f6f}
@deffn {Dato} errno.ENOTEMPTY

Directorio no vacío
@end deffn

@geindex ELOOP (en el módulo errno)
@anchor{library/errno errno ELOOP}@anchor{2f70}
@deffn {Dato} errno.ELOOP

Se han encontrado demasiados enlaces simbólicos
@end deffn

@geindex EWOULDBLOCK (en el módulo errno)
@anchor{library/errno errno EWOULDBLOCK}@anchor{22a3}
@deffn {Dato} errno.EWOULDBLOCK

La operación se bloquearía. Este error se asigna a la excepción @ref{10d3,,BlockingIOError}.
@end deffn

@geindex ENOMSG (en el módulo errno)
@anchor{library/errno errno ENOMSG}@anchor{2f71}
@deffn {Dato} errno.ENOMSG

Ningún mensaje del tipo deseado
@end deffn

@geindex EIDRM (en el módulo errno)
@anchor{library/errno errno EIDRM}@anchor{2f72}
@deffn {Dato} errno.EIDRM

Identificador eliminado
@end deffn

@geindex ECHRNG (en el módulo errno)
@anchor{library/errno errno ECHRNG}@anchor{2f73}
@deffn {Dato} errno.ECHRNG

Número de canal fuera de rango
@end deffn

@geindex EL2NSYNC (en el módulo errno)
@anchor{library/errno errno EL2NSYNC}@anchor{2f74}
@deffn {Dato} errno.EL2NSYNC

Nivel 2 no sincronizado
@end deffn

@geindex EL3HLT (en el módulo errno)
@anchor{library/errno errno EL3HLT}@anchor{2f75}
@deffn {Dato} errno.EL3HLT

Nivel 3 detenido
@end deffn

@geindex EL3RST (en el módulo errno)
@anchor{library/errno errno EL3RST}@anchor{2f76}
@deffn {Dato} errno.EL3RST

Nivel 3 restablecido
@end deffn

@geindex ELNRNG (en el módulo errno)
@anchor{library/errno errno ELNRNG}@anchor{2f77}
@deffn {Dato} errno.ELNRNG

Número de enlace fuera de rango
@end deffn

@geindex EUNATCH (en el módulo errno)
@anchor{library/errno errno EUNATCH}@anchor{2f78}
@deffn {Dato} errno.EUNATCH

Controlador de protocolo no adjunto
@end deffn

@geindex ENOCSI (en el módulo errno)
@anchor{library/errno errno ENOCSI}@anchor{2f79}
@deffn {Dato} errno.ENOCSI

No hay estructura CSI disponible
@end deffn

@geindex EL2HLT (en el módulo errno)
@anchor{library/errno errno EL2HLT}@anchor{2f7a}
@deffn {Dato} errno.EL2HLT

Nivel 2 detenido
@end deffn

@geindex EBADE (en el módulo errno)
@anchor{library/errno errno EBADE}@anchor{2f7b}
@deffn {Dato} errno.EBADE

Intercambio inválido
@end deffn

@geindex EBADR (en el módulo errno)
@anchor{library/errno errno EBADR}@anchor{2f7c}
@deffn {Dato} errno.EBADR

Descriptor de solicitud inválido
@end deffn

@geindex EXFULL (en el módulo errno)
@anchor{library/errno errno EXFULL}@anchor{2f7d}
@deffn {Dato} errno.EXFULL

Intercambio completo
@end deffn

@geindex ENOANO (en el módulo errno)
@anchor{library/errno errno ENOANO}@anchor{2f7e}
@deffn {Dato} errno.ENOANO

Sin ánodo
@end deffn

@geindex EBADRQC (en el módulo errno)
@anchor{library/errno errno EBADRQC}@anchor{2f7f}
@deffn {Dato} errno.EBADRQC

Código de solicitud inválido
@end deffn

@geindex EBADSLT (en el módulo errno)
@anchor{library/errno errno EBADSLT}@anchor{2f80}
@deffn {Dato} errno.EBADSLT

Ranura inválida
@end deffn

@geindex EDEADLOCK (en el módulo errno)
@anchor{library/errno errno EDEADLOCK}@anchor{2f81}
@deffn {Dato} errno.EDEADLOCK

Error de interbloqueo de bloqueo de archivos
@end deffn

@geindex EBFONT (en el módulo errno)
@anchor{library/errno errno EBFONT}@anchor{2f82}
@deffn {Dato} errno.EBFONT

Formato de archivo de fuente incorrecto
@end deffn

@geindex ENOSTR (en el módulo errno)
@anchor{library/errno errno ENOSTR}@anchor{2f83}
@deffn {Dato} errno.ENOSTR

El dispositivo no es una secuencia
@end deffn

@geindex ENODATA (en el módulo errno)
@anchor{library/errno errno ENODATA}@anchor{2f84}
@deffn {Dato} errno.ENODATA

Datos no disponibles
@end deffn

@geindex ETIME (en el módulo errno)
@anchor{library/errno errno ETIME}@anchor{2f85}
@deffn {Dato} errno.ETIME

Temporizador expirado
@end deffn

@geindex ENOSR (en el módulo errno)
@anchor{library/errno errno ENOSR}@anchor{2f86}
@deffn {Dato} errno.ENOSR

Recursos fuera de flujos
@end deffn

@geindex ENONET (en el módulo errno)
@anchor{library/errno errno ENONET}@anchor{2f87}
@deffn {Dato} errno.ENONET

La computadora no está en la red
@end deffn

@geindex ENOPKG (en el módulo errno)
@anchor{library/errno errno ENOPKG}@anchor{2f88}
@deffn {Dato} errno.ENOPKG

Paquete no instalado
@end deffn

@geindex EREMOTE (en el módulo errno)
@anchor{library/errno errno EREMOTE}@anchor{2f89}
@deffn {Dato} errno.EREMOTE

El objeto es remoto
@end deffn

@geindex ENOLINK (en el módulo errno)
@anchor{library/errno errno ENOLINK}@anchor{2f8a}
@deffn {Dato} errno.ENOLINK

El enlace ha sido cortado
@end deffn

@geindex EADV (en el módulo errno)
@anchor{library/errno errno EADV}@anchor{2f8b}
@deffn {Dato} errno.EADV

Error de publicidad
@end deffn

@geindex ESRMNT (en el módulo errno)
@anchor{library/errno errno ESRMNT}@anchor{2f8c}
@deffn {Dato} errno.ESRMNT

Error de Srmount
@end deffn

@geindex ECOMM (en el módulo errno)
@anchor{library/errno errno ECOMM}@anchor{2f8d}
@deffn {Dato} errno.ECOMM

Error de comunicación al enviar
@end deffn

@geindex EPROTO (en el módulo errno)
@anchor{library/errno errno EPROTO}@anchor{2f8e}
@deffn {Dato} errno.EPROTO

Error de protocolo
@end deffn

@geindex EMULTIHOP (en el módulo errno)
@anchor{library/errno errno EMULTIHOP}@anchor{2f8f}
@deffn {Dato} errno.EMULTIHOP

Intento de salto múltiple
@end deffn

@geindex EDOTDOT (en el módulo errno)
@anchor{library/errno errno EDOTDOT}@anchor{2f90}
@deffn {Dato} errno.EDOTDOT

Error específico de RFS (por su significado en inglés `Remote File System')
@end deffn

@geindex EBADMSG (en el módulo errno)
@anchor{library/errno errno EBADMSG}@anchor{2f91}
@deffn {Dato} errno.EBADMSG

No es un mensaje de datos
@end deffn

@geindex EOVERFLOW (en el módulo errno)
@anchor{library/errno errno EOVERFLOW}@anchor{2f92}
@deffn {Dato} errno.EOVERFLOW

Valor demasiado grande para el tipo de datos definido
@end deffn

@geindex ENOTUNIQ (en el módulo errno)
@anchor{library/errno errno ENOTUNIQ}@anchor{2f93}
@deffn {Dato} errno.ENOTUNIQ

Nombre no único en la red
@end deffn

@geindex EBADFD (en el módulo errno)
@anchor{library/errno errno EBADFD}@anchor{2f94}
@deffn {Dato} errno.EBADFD

Descriptor de archivo en mal estado
@end deffn

@geindex EREMCHG (en el módulo errno)
@anchor{library/errno errno EREMCHG}@anchor{2f95}
@deffn {Dato} errno.EREMCHG

La dirección remota cambió
@end deffn

@geindex ELIBACC (en el módulo errno)
@anchor{library/errno errno ELIBACC}@anchor{2f96}
@deffn {Dato} errno.ELIBACC

No se puede acceder a una biblioteca compartida necesaria
@end deffn

@geindex ELIBBAD (en el módulo errno)
@anchor{library/errno errno ELIBBAD}@anchor{2f97}
@deffn {Dato} errno.ELIBBAD

Accediendo a una biblioteca compartida dañada
@end deffn

@geindex ELIBSCN (en el módulo errno)
@anchor{library/errno errno ELIBSCN}@anchor{2f98}
@deffn {Dato} errno.ELIBSCN

Sección .lib en a.out corrupta
@end deffn

@geindex ELIBMAX (en el módulo errno)
@anchor{library/errno errno ELIBMAX}@anchor{2f99}
@deffn {Dato} errno.ELIBMAX

Intentando vincular demasiadas bibliotecas compartidas
@end deffn

@geindex ELIBEXEC (en el módulo errno)
@anchor{library/errno errno ELIBEXEC}@anchor{2f9a}
@deffn {Dato} errno.ELIBEXEC

No se puede ejecutar una biblioteca compartida directamente
@end deffn

@geindex EILSEQ (en el módulo errno)
@anchor{library/errno errno EILSEQ}@anchor{2f9b}
@deffn {Dato} errno.EILSEQ

Secuencia de byte ilegal
@end deffn

@geindex ERESTART (en el módulo errno)
@anchor{library/errno errno ERESTART}@anchor{2f9c}
@deffn {Dato} errno.ERESTART

Llamada al sistema interrumpida debe reiniciarse
@end deffn

@geindex ESTRPIPE (en el módulo errno)
@anchor{library/errno errno ESTRPIPE}@anchor{2f9d}
@deffn {Dato} errno.ESTRPIPE

Error de tubería de flujos
@end deffn

@geindex EUSERS (en el módulo errno)
@anchor{library/errno errno EUSERS}@anchor{2f9e}
@deffn {Dato} errno.EUSERS

Demasiados usuarios
@end deffn

@geindex ENOTSOCK (en el módulo errno)
@anchor{library/errno errno ENOTSOCK}@anchor{2f9f}
@deffn {Dato} errno.ENOTSOCK

Operación de socket en no-socket
@end deffn

@geindex EDESTADDRREQ (en el módulo errno)
@anchor{library/errno errno EDESTADDRREQ}@anchor{2fa0}
@deffn {Dato} errno.EDESTADDRREQ

Dirección de destino requerida
@end deffn

@geindex EMSGSIZE (en el módulo errno)
@anchor{library/errno errno EMSGSIZE}@anchor{2fa1}
@deffn {Dato} errno.EMSGSIZE

Mensaje demasiado largo
@end deffn

@geindex EPROTOTYPE (en el módulo errno)
@anchor{library/errno errno EPROTOTYPE}@anchor{2fa2}
@deffn {Dato} errno.EPROTOTYPE

Protocolo de tipo incorrecto para socket
@end deffn

@geindex ENOPROTOOPT (en el módulo errno)
@anchor{library/errno errno ENOPROTOOPT}@anchor{2fa3}
@deffn {Dato} errno.ENOPROTOOPT

Protocolo no disponible
@end deffn

@geindex EPROTONOSUPPORT (en el módulo errno)
@anchor{library/errno errno EPROTONOSUPPORT}@anchor{2fa4}
@deffn {Dato} errno.EPROTONOSUPPORT

Protocolo no soportado
@end deffn

@geindex ESOCKTNOSUPPORT (en el módulo errno)
@anchor{library/errno errno ESOCKTNOSUPPORT}@anchor{2fa5}
@deffn {Dato} errno.ESOCKTNOSUPPORT

Tipo de socket no soportado
@end deffn

@geindex EOPNOTSUPP (en el módulo errno)
@anchor{library/errno errno EOPNOTSUPP}@anchor{2fa6}
@deffn {Dato} errno.EOPNOTSUPP

Operación no soportada en el endpoint de transporte
@end deffn

@geindex ENOTSUP (en el módulo errno)
@anchor{library/errno errno ENOTSUP}@anchor{2fa7}
@deffn {Dato} errno.ENOTSUP

Operación no soportada


Added in version 3.2.

@end deffn

@geindex EPFNOSUPPORT (en el módulo errno)
@anchor{library/errno errno EPFNOSUPPORT}@anchor{2fa8}
@deffn {Dato} errno.EPFNOSUPPORT

Familia de protocolo no soportada
@end deffn

@geindex EAFNOSUPPORT (en el módulo errno)
@anchor{library/errno errno EAFNOSUPPORT}@anchor{2fa9}
@deffn {Dato} errno.EAFNOSUPPORT

Familia de direcciones no soportada por protocolo
@end deffn

@geindex EADDRINUSE (en el módulo errno)
@anchor{library/errno errno EADDRINUSE}@anchor{2faa}
@deffn {Dato} errno.EADDRINUSE

Dirección ya en uso
@end deffn

@geindex EADDRNOTAVAIL (en el módulo errno)
@anchor{library/errno errno EADDRNOTAVAIL}@anchor{2fab}
@deffn {Dato} errno.EADDRNOTAVAIL

No se puede asignar la dirección solicitada
@end deffn

@geindex ENETDOWN (en el módulo errno)
@anchor{library/errno errno ENETDOWN}@anchor{2fac}
@deffn {Dato} errno.ENETDOWN

Red caída
@end deffn

@geindex ENETUNREACH (en el módulo errno)
@anchor{library/errno errno ENETUNREACH}@anchor{1a0f}
@deffn {Dato} errno.ENETUNREACH

Red es inalcanzable
@end deffn

@geindex ENETRESET (en el módulo errno)
@anchor{library/errno errno ENETRESET}@anchor{2fad}
@deffn {Dato} errno.ENETRESET

Conexión de red interrumpida debido al reinicio
@end deffn

@geindex ECONNABORTED (en el módulo errno)
@anchor{library/errno errno ECONNABORTED}@anchor{22a9}
@deffn {Dato} errno.ECONNABORTED

El software causó falla de conexión. Este error se asigna a la excepción @ref{10d9,,ConnectionAbortedError}.
@end deffn

@geindex ECONNRESET (en el módulo errno)
@anchor{library/errno errno ECONNRESET}@anchor{22ab}
@deffn {Dato} errno.ECONNRESET

Restablecimiento de la conexión por par. Este error se asigna a la excepción @ref{10db,,ConnectionResetError}.
@end deffn

@geindex ENOBUFS (en el módulo errno)
@anchor{library/errno errno ENOBUFS}@anchor{17ef}
@deffn {Dato} errno.ENOBUFS

No hay espacio de búfer disponible
@end deffn

@geindex EISCONN (en el módulo errno)
@anchor{library/errno errno EISCONN}@anchor{2fae}
@deffn {Dato} errno.EISCONN

El endpoint de transporte ya está conectado
@end deffn

@geindex ENOTCONN (en el módulo errno)
@anchor{library/errno errno ENOTCONN}@anchor{2faf}
@deffn {Dato} errno.ENOTCONN

El endpoint final de transporte no está conectado
@end deffn

@geindex ESHUTDOWN (en el módulo errno)
@anchor{library/errno errno ESHUTDOWN}@anchor{22a8}
@deffn {Dato} errno.ESHUTDOWN

No se puede enviar después del apagado del endpoint de transporte. Este error se asigna a la excepción @ref{10d8,,BrokenPipeError}.
@end deffn

@geindex ETOOMANYREFS (en el módulo errno)
@anchor{library/errno errno ETOOMANYREFS}@anchor{2fb0}
@deffn {Dato} errno.ETOOMANYREFS

Demasiadas referencias: no se puede empalmar
@end deffn

@geindex ETIMEDOUT (en el módulo errno)
@anchor{library/errno errno ETIMEDOUT}@anchor{22b2}
@deffn {Dato} errno.ETIMEDOUT

Tiempo de conexión agotado. Este error se asigna a la excepción @ref{8cc,,TimeoutError}.
@end deffn

@geindex ECONNREFUSED (en el módulo errno)
@anchor{library/errno errno ECONNREFUSED}@anchor{22aa}
@deffn {Dato} errno.ECONNREFUSED

Conexión denegada. Este error se asigna a la excepción @ref{10da,,ConnectionRefusedError}.
@end deffn

@geindex EHOSTDOWN (en el módulo errno)
@anchor{library/errno errno EHOSTDOWN}@anchor{2fb1}
@deffn {Dato} errno.EHOSTDOWN

Anfitrión caído
@end deffn

@geindex EHOSTUNREACH (en el módulo errno)
@anchor{library/errno errno EHOSTUNREACH}@anchor{2fb2}
@deffn {Dato} errno.EHOSTUNREACH

Sin ruta al anfitrión
@end deffn

@geindex EALREADY (en el módulo errno)
@anchor{library/errno errno EALREADY}@anchor{22a2}
@deffn {Dato} errno.EALREADY

Operación ya en curso. Este error se asigna a la excepción @ref{10d3,,BlockingIOError}.
@end deffn

@geindex EINPROGRESS (en el módulo errno)
@anchor{library/errno errno EINPROGRESS}@anchor{22a4}
@deffn {Dato} errno.EINPROGRESS

Operación ahora en curso. Este error se asigna a la excepción @ref{10d3,,BlockingIOError}.
@end deffn

@geindex ESTALE (en el módulo errno)
@anchor{library/errno errno ESTALE}@anchor{2fb3}
@deffn {Dato} errno.ESTALE

Manejador de archivos NFS (por su significado en inglés `Network File System') obsoleto
@end deffn

@geindex EUCLEAN (en el módulo errno)
@anchor{library/errno errno EUCLEAN}@anchor{2fb4}
@deffn {Dato} errno.EUCLEAN

La estructura necesita limpieza
@end deffn

@geindex ENOTNAM (en el módulo errno)
@anchor{library/errno errno ENOTNAM}@anchor{2fb5}
@deffn {Dato} errno.ENOTNAM

No es un archivo de tipo con nombre XENIX
@end deffn

@geindex ENAVAIL (en el módulo errno)
@anchor{library/errno errno ENAVAIL}@anchor{2fb6}
@deffn {Dato} errno.ENAVAIL

No hay semáforos XENIX disponibles
@end deffn

@geindex EISNAM (en el módulo errno)
@anchor{library/errno errno EISNAM}@anchor{2fb7}
@deffn {Dato} errno.EISNAM

Es un archivo de tipo con nombre
@end deffn

@geindex EREMOTEIO (en el módulo errno)
@anchor{library/errno errno EREMOTEIO}@anchor{2fb8}
@deffn {Dato} errno.EREMOTEIO

Error de E/S remota
@end deffn

@geindex EDQUOT (en el módulo errno)
@anchor{library/errno errno EDQUOT}@anchor{2fb9}
@deffn {Dato} errno.EDQUOT

Cuota excedida
@end deffn

@geindex EQFULL (en el módulo errno)
@anchor{library/errno errno EQFULL}@anchor{2fba}
@deffn {Dato} errno.EQFULL

La cola de salida de la interfaz está llena


Added in version 3.11.

@end deffn

@geindex ENOTCAPABLE (en el módulo errno)
@anchor{library/errno errno ENOTCAPABLE}@anchor{17c7}
@deffn {Dato} errno.ENOTCAPABLE

Capacidades insuficientes. Este error se asigna a la excepción @ref{dc9,,PermissionError}.

@ref{1d5a,,Availability}: WASI, FreeBSD


Added in version 3.11.1.

@end deffn

@geindex ECANCELED (en el módulo errno)
@anchor{library/errno errno ECANCELED}@anchor{2fbb}
@deffn {Dato} errno.ECANCELED

Operación cancelada


Added in version 3.2.

@end deffn

@geindex EOWNERDEAD (en el módulo errno)
@anchor{library/errno errno EOWNERDEAD}@anchor{2fbc}
@deffn {Dato} errno.EOWNERDEAD

El propietario murió


Added in version 3.2.

@end deffn

@geindex ENOTRECOVERABLE (en el módulo errno)
@anchor{library/errno errno ENOTRECOVERABLE}@anchor{2fbd}
@deffn {Dato} errno.ENOTRECOVERABLE

Estado no recuperable


Added in version 3.2.

@end deffn

@node ctypes — A foreign function library for Python,,errno — Standard errno system symbols,Servicios genéricos del sistema operativo
@anchor{library/ctypes doc}@anchor{2fbe}@anchor{library/ctypes ctypes-a-foreign-function-library-for-python}@anchor{2fbf}@anchor{library/ctypes module-ctypes}@anchor{2b}
@subsection @code{ctypes} — A foreign function library for Python


@geindex module; ctypes

`Source code:' Lib/ctypes@footnote{https://github.com/python/cpython/tree/main/Lib/ctypes}


__________________________________________________________________


@ref{2b,,ctypes} es una biblioteca de funciones foráneas para Python. Proporciona tipos de datos compatibles con C y permite llamar a funciones en archivos DLL o bibliotecas compartidas. Se puede utilizar para envolver estas bibliotecas en Python puro.

@menu
* tutorial de ctypes:: 
* referencia ctypes:: 

@end menu

@node tutorial de ctypes,referencia ctypes,,ctypes — A foreign function library for Python
@anchor{library/ctypes ctypes-ctypes-tutorial}@anchor{2fc0}@anchor{library/ctypes ctypes-tutorial}@anchor{2fc1}
@subsubsection tutorial de ctypes


Nota: Los ejemplos de código en este tutorial usan @ref{3b,,doctest} para asegurarse de que realmente funcionen. Dado que algunos ejemplos de código se comportan de manera diferente en Linux, Windows o macOS, contienen directivas doctest en los comentarios.

Nota: Algunos ejemplos de código hacen referencia al tipo ctypes @ref{2fc2,,c_int}. En las plataformas donde @code{sizeof(long) == sizeof(int)} es un alias de @ref{2fc3,,c_long}. Por lo tanto, no debe confundirse si @ref{2fc3,,c_long} se imprime si espera @ref{2fc2,,c_int} — son en realidad del mismo tipo.

@menu
* Carga de bibliotecas de enlaces dinámicos:: 
* Acceder a las funciones de los dll cargados:: 
* Funciones de llamada:: 
* Tipos de datos fundamentales:: 
* Funciones de llamada@comma{} continuación: Funciones de llamada continuación. 
* Calling variadic functions:: 
* Funciones de llamada con sus propios tipos de datos personalizados:: 
* Especificar los tipos de argumentos requeridos (prototipos de funciones): Especificar los tipos de argumentos requeridos prototipos de funciones. 
* Tipos de retorno:: 
* Pasar los punteros (o; pasar los parámetros por referencia): Pasar los punteros o pasar los parámetros por referencia. 
* Estructuras y uniones:: 
* Structure/union layout@comma{} alignment and byte order: Structure/union layout alignment and byte order. 
* Campos de bits en estructuras y uniones:: 
* Arreglos:: 
* Punteros:: 
* Conversiones de tipos:: 
* Tipos incompletos:: 
* Funciones de retrollamadas (callback): Funciones de retrollamadas callback. 
* Acceder a los valores exportados de los dlls:: 
* Sorpresas:: 
* Tipos de datos de tamaño variable:: 

@end menu

@node Carga de bibliotecas de enlaces dinámicos,Acceder a las funciones de los dll cargados,,tutorial de ctypes
@anchor{library/ctypes ctypes-loading-dynamic-link-libraries}@anchor{2fc4}@anchor{library/ctypes loading-dynamic-link-libraries}@anchor{2fc5}
@subsubsection Carga de bibliotecas de enlaces dinámicos


@ref{2b,,ctypes} exporta los objetos `cdll' y en Windows `windll' y `oledll', para cargar bibliotecas de enlaces dinámicos.

You load libraries by accessing them as attributes of these objects. `cdll'
loads libraries which export functions using the standard @code{cdecl} calling
convention, while `windll' libraries call functions using the @code{stdcall}
calling convention. `oledll' also uses the @code{stdcall} calling convention, and
assumes the functions return a Windows @code{HRESULT} error code. The error
code is used to automatically raise an @ref{4d5,,OSError} exception when the
function call fails.


Distinto en la versión 3.3: Los errores de Windows solían generar @ref{10d0,,WindowsError}, que ahora es un alias de @ref{4d5,,OSError}.


Here are some examples for Windows. Note that @code{msvcrt} is the MS standard C
library containing most standard C functions, and uses the @code{cdecl} calling
convention:

@example
>>> from ctypes import *
>>> print(windll.kernel32)  
<WinDLL 'kernel32', handle ... at ...>
>>> print(cdll.msvcrt)      
<CDLL 'msvcrt', handle ... at ...>
>>> libc = cdll.msvcrt      
>>>
@end example

Windows agrega automáticamente la extensión común @code{.dll}.

@cartouche
@quotation Nota 
Acceder a la biblioteca estándar de C a través de @code{cdll.msvcrt} utilizará una versión obsoleta de la biblioteca que puede ser incompatible con la utilizada por Python. Cuando sea posible, use la funcionalidad nativa de Python, o bien importe y use el módulo @code{msvcrt}.
@end quotation
@end cartouche

On Linux, it is required to specify the filename `including' the extension to
load a library, so attribute access can not be used to load libraries. Either the
@ref{2fc6,,LoadLibrary()} method of the dll loaders should be used,
or you should load the library by creating an instance of CDLL by calling
the constructor:

@example
>>> cdll.LoadLibrary("libc.so.6")  
<CDLL 'libc.so.6', handle ... at ...>
>>> libc = CDLL("libc.so.6")       
>>> libc                           
<CDLL 'libc.so.6', handle ... at ...>
>>>
@end example

@c XXX Add section for macOS.

@node Acceder a las funciones de los dll cargados,Funciones de llamada,Carga de bibliotecas de enlaces dinámicos,tutorial de ctypes
@anchor{library/ctypes accessing-functions-from-loaded-dlls}@anchor{2fc7}@anchor{library/ctypes ctypes-accessing-functions-from-loaded-dlls}@anchor{2fc8}
@subsubsection Acceder a las funciones de los dll cargados


Las funciones se acceden como atributos de los objetos dll:

@example
>>> libc.printf
<_FuncPtr object at 0x...>
>>> print(windll.kernel32.GetModuleHandleA)  
<_FuncPtr object at 0x...>
>>> print(windll.kernel32.MyOwnFunction)     
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ctypes.py", line 239, in __getattr__
    func = _StdcallFuncPtr(name, self)
AttributeError: function 'MyOwnFunction' not found
>>>
@end example

Note that win32 system dlls like @code{kernel32} and @code{user32} often export ANSI
as well as UNICODE versions of a function. The UNICODE version is exported with
a @code{W} appended to the name, while the ANSI version is exported with an @code{A}
appended to the name. The win32 @code{GetModuleHandle} function, which returns a
`module handle' for a given module name, has the following C prototype, and a
macro is used to expose one of them as @code{GetModuleHandle} depending on whether
UNICODE is defined or not:

@example
/* ANSI version */
HMODULE GetModuleHandleA(LPCSTR lpModuleName);
/* UNICODE version */
HMODULE GetModuleHandleW(LPCWSTR lpModuleName);
@end example

`windll' no intenta seleccionar una de ellas por arte de magia, se debe acceder a la versión que se necesita especificando @code{GetModuleHandleA} o @code{GetModuleHandleW} explícitamente, y luego llamarlo con bytes u objetos de cadena respectivamente.

A veces, las dlls exportan funciones con nombres que no son identificadores válidos de Python, como @code{"??2@@YAPAXI@@Z"}. En este caso tienes que usar @ref{c59,,getattr()} para recuperar la función:

@example
>>> getattr(cdll.msvcrt, "??2@@YAPAXI@@Z")  
<_FuncPtr object at 0x...>
>>>
@end example

En Windows, algunas dlls exportan funciones no por nombre sino por ordinal. Se pueden acceder a estas funciones indexando el objeto dll con el número ordinal:

@example
>>> cdll.kernel32[1]  
<_FuncPtr object at 0x...>
>>> cdll.kernel32[0]  
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ctypes.py", line 310, in __getitem__
    func = _StdcallFuncPtr(name, self)
AttributeError: function ordinal 0 not found
>>>
@end example

@node Funciones de llamada,Tipos de datos fundamentales,Acceder a las funciones de los dll cargados,tutorial de ctypes
@anchor{library/ctypes calling-functions}@anchor{2fc9}@anchor{library/ctypes ctypes-calling-functions}@anchor{2fca}
@subsubsection Funciones de llamada


You can call these functions like any other Python callable. This example uses
the @code{rand()} function, which takes no arguments and returns a pseudo-random integer:

@example
>>> print(libc.rand())  
1804289383
@end example

On Windows, you can call the @code{GetModuleHandleA()} function, which returns a win32 module
handle (passing @code{None} as single argument to call it with a @code{NULL} pointer):

@example
>>> print(hex(windll.kernel32.GetModuleHandleA(None)))  
0x1d000000
>>>
@end example

@ref{360,,ValueError} es lanzado cuando se llama a una función @code{stdcall} con la convención de llamada @code{cdecl}, o viceversa:

@example
>>> cdll.kernel32.GetModuleHandleA(None)  
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Procedure probably called with not enough arguments (4 bytes missing)
>>>

>>> windll.msvcrt.printf(b"spam")  
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Procedure probably called with too many arguments (4 bytes in excess)
>>>
@end example

Para saber la convención de llamada correcta, hay que mirar en el archivo de encabezado C o en la documentación de la función que se quiere llamar.

En Windows, @ref{2b,,ctypes} utiliza la gestión de excepciones estructurada de win32 para evitar que se produzcan fallos de protección general cuando se llaman funciones con valores de argumento inválidos:

@example
>>> windll.kernel32.GetModuleHandleA(32)  
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
OSError: exception: access violation reading 0x00000020
>>>
@end example

Sin embargo, hay suficientes maneras de bloquear Python con @ref{2b,,ctypes}, así que debes tener cuidado de todos modos. El módulo @ref{58,,faulthandler} puede ser útil para depurar bloqueos (por ejemplo, provenientes de fallos de segmentación producidos por llamadas erróneas a la biblioteca C).

@code{None}, integers, bytes objects and (unicode) strings are the only native
Python objects that can directly be used as parameters in these function calls.
@code{None} is passed as a C @code{NULL} pointer, bytes objects and strings are passed
as pointer to the memory block that contains their data (char* or
wchar_t*).  Python integers are passed as the platform’s default C
int type, their value is masked to fit into the C type.

Antes de pasar a llamar funciones con otros tipos de parámetros, tenemos que aprender más sobre los tipos de datos @ref{2b,,ctypes}.

@node Tipos de datos fundamentales,Funciones de llamada continuación,Funciones de llamada,tutorial de ctypes
@anchor{library/ctypes ctypes-fundamental-data-types}@anchor{2fcb}@anchor{library/ctypes fundamental-data-types}@anchor{2fcc}
@subsubsection Tipos de datos fundamentales


@ref{2b,,ctypes} define un número de tipos de datos primitivos compatibles con C:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

tipo ctypes

@tab

Tipo C

@tab

Tipo Python

@item

@ref{2fcd,,c_bool}

@tab

_Bool

@tab

bool (1)

@item

@ref{2fce,,c_char}

@tab

char

@tab

Un objeto bytes de 1-caracter

@item

@ref{2fcf,,c_wchar}

@tab

@code{wchar_t}

@tab

Una cadena de 1-caracter

@item

@ref{1778,,c_byte}

@tab

char

@tab

entero

@item

@ref{1779,,c_ubyte}

@tab

unsigned char

@tab

entero

@item

@ref{2fd0,,c_short}

@tab

short

@tab

entero

@item

@ref{2fd1,,c_ushort}

@tab

unsigned short

@tab

entero

@item

@ref{2fc2,,c_int}

@tab

int

@tab

entero

@item

@ref{2fd2,,c_uint}

@tab

unsigned int

@tab

entero

@item

@ref{2fc3,,c_long}

@tab

long

@tab

entero

@item

@ref{2fd3,,c_ulong}

@tab

unsigned long

@tab

entero

@item

@ref{2fd4,,c_longlong}

@tab

__int64 o long long

@tab

entero

@item

@ref{2fd5,,c_ulonglong}

@tab

unsigned __int64 o unsigned long long

@tab

entero

@item

@ref{2fd6,,c_size_t}

@tab

@code{size_t}

@tab

entero

@item

@ref{12a9,,c_ssize_t}

@tab

@code{ssize_t} or
@ref{af0,,Py_ssize_t}

@tab

entero

@item

@ref{17e0,,c_time_t}

@tab

@code{time_t}

@tab

entero

@item

@ref{2fd7,,c_float}

@tab

float

@tab

flotante

@item

@ref{1903,,c_double}

@tab

double

@tab

flotante

@item

@ref{1904,,c_longdouble}

@tab

long double

@tab

flotante

@item

@ref{16ed,,c_char_p}

@tab

char* (terminado en NUL)

@tab

objeto de bytes o @code{None}

@item

@ref{16ee,,c_wchar_p}

@tab

wchar_t* (terminado en NUL)

@tab

cadena o @code{None}

@item

@ref{16ef,,c_void_p}

@tab

void*

@tab

entero o @code{None}

@end multitable



@enumerate 

@item 
El constructor acepta cualquier objeto con valor verdadero.
@end enumerate

Additionally, if IEC 60559 compatible complex arithmetic (Annex G) is supported, the following
complex types are available:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} 
@headitem

tipo ctypes

@tab

Tipo C

@tab

Tipo Python

@item

@ref{15e5,,c_float_complex}

@tab

float complex

@tab

complex

@item

@ref{15e6,,c_double_complex}

@tab

double complex

@tab

complex

@item

@ref{15e7,,c_longdouble_complex}

@tab

long double complex

@tab

complex

@end multitable


Todos estos tipos pueden ser creados llamándolos con un inicializador opcional del tipo y valor correctos:

@example
>>> c_int()
c_long(0)
>>> c_wchar_p("Hello, World")
c_wchar_p(140018365411392)
>>> c_ushort(-3)
c_ushort(65533)
>>>
@end example

Dado que estos tipos son mutables, su valor también puede ser cambiado después:

@example
>>> i = c_int(42)
>>> print(i)
c_long(42)
>>> print(i.value)
42
>>> i.value = -99
>>> print(i.value)
-99
>>>
@end example

Asignando un nuevo valor a las instancias de los tipos de punteros @ref{16ed,,c_char_p}, @ref{16ee,,c_wchar_p}, y @ref{16ef,,c_void_p} cambia el `lugar de memoria' al que apuntan, `no el contenido' del bloque de memoria (por supuesto que no, porque los objetos de bytes de Python son inmutables):

@example
>>> s = "Hello, World"
>>> c_s = c_wchar_p(s)
>>> print(c_s)
c_wchar_p(139966785747344)
>>> print(c_s.value)
Hello World
>>> c_s.value = "Hi, there"
>>> print(c_s)              # the memory location has changed
c_wchar_p(139966783348904)
>>> print(c_s.value)
Hi, there
>>> print(s)                # first object is unchanged
Hello, World
>>>
@end example

Sin embargo, debe tener cuidado de no pasarlos a funciones que esperan punteros a la memoria mutable. Si necesitas bloques de memoria mutables, ctypes tiene una función @ref{2fd8,,create_string_buffer()} que los crea de varias maneras. El contenido actual del bloque de memoria puede ser accedido (o cambiado) con la propiedad @code{raw}; si quieres acceder a él como cadena terminada NUL, usa la propiedad @code{value}:

@example
>>> from ctypes import *
>>> p = create_string_buffer(3)            # create a 3 byte buffer, initialized to NUL bytes
>>> print(sizeof(p), repr(p.raw))
3 b'\x00\x00\x00'
>>> p = create_string_buffer(b"Hello")     # create a buffer containing a NUL terminated string
>>> print(sizeof(p), repr(p.raw))
6 b'Hello\x00'
>>> print(repr(p.value))
b'Hello'
>>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer
>>> print(sizeof(p), repr(p.raw))
10 b'Hello\x00\x00\x00\x00\x00'
>>> p.value = b"Hi"
>>> print(sizeof(p), repr(p.raw))
10 b'Hi\x00lo\x00\x00\x00\x00\x00'
>>>
@end example

The @ref{2fd8,,create_string_buffer()} function replaces the old @code{c_buffer()}
function (which is still available as an alias).  To create a mutable memory
block containing unicode characters of the C type @code{wchar_t}, use the
@ref{19d8,,create_unicode_buffer()} function.

@node Funciones de llamada continuación,Calling variadic functions,Tipos de datos fundamentales,tutorial de ctypes
@anchor{library/ctypes calling-functions-continued}@anchor{2fd9}@anchor{library/ctypes ctypes-calling-functions-continued}@anchor{2fda}
@subsubsection Funciones de llamada, continuación


Note que printf imprime al canal de salida estándar real, `no' a @ref{b61,,sys.stdout}, por lo que estos ejemplos sólo funcionarán en el prompt de la consola, no desde dentro de `IDLE' o `PythonWin':

@example
>>> printf = libc.printf
>>> printf(b"Hello, %s\n", b"World!")
Hello, World!
14
>>> printf(b"Hello, %S\n", "World!")
Hello, World!
14
>>> printf(b"%d bottles of beer\n", 42)
42 bottles of beer
19
>>> printf(b"%f bottles of beer\n", 42.5)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ctypes.ArgumentError: argument 2: TypeError: Don't know how to convert parameter 2
>>>
@end example

Como se ha mencionado antes, todos los tipos de Python, excepto los enteros, cadenas y objetos bytes, tienen que ser envueltos en su correspondiente tipo @ref{2b,,ctypes}, para que puedan ser convertidos al tipo de datos C requerido:

@example
>>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))
An int 1234, a double 3.140000
31
>>>
@end example

@node Calling variadic functions,Funciones de llamada con sus propios tipos de datos personalizados,Funciones de llamada continuación,tutorial de ctypes
@anchor{library/ctypes calling-variadic-functions}@anchor{2fdb}@anchor{library/ctypes ctypes-calling-variadic-functions}@anchor{2fdc}
@subsubsection Calling variadic functions


On a lot of platforms calling variadic functions through ctypes is exactly the same
as calling functions with a fixed number of parameters. On some platforms, and in
particular ARM64 for Apple Platforms, the calling convention for variadic functions
is different than that for regular functions.

On those platforms it is required to specify the @ref{2fdd,,argtypes}
attribute for the regular, non-variadic, function arguments:

@example
libc.printf.argtypes = [ctypes.c_char_p]
@end example

Because specifying the attribute does not inhibit portability it is advised to always
specify @ref{2fdd,,argtypes} for all variadic functions.

@node Funciones de llamada con sus propios tipos de datos personalizados,Especificar los tipos de argumentos requeridos prototipos de funciones,Calling variadic functions,tutorial de ctypes
@anchor{library/ctypes calling-functions-with-your-own-custom-data-types}@anchor{2fde}@anchor{library/ctypes ctypes-calling-functions-with-own-custom-data-types}@anchor{2fdf}
@subsubsection Funciones de llamada con sus propios tipos de datos personalizados


You can also customize @ref{2b,,ctypes} argument conversion to allow instances of
your own classes be used as function arguments. @ref{2b,,ctypes} looks for an
@code{_as_parameter_} attribute and uses this as the function argument. The
attribute must be an integer, string, bytes, a @ref{2b,,ctypes} instance, or an
object with an @code{_as_parameter_} attribute:

@example
>>> class Bottles:
...     def __init__(self, number):
...         self._as_parameter_ = number
...
>>> bottles = Bottles(42)
>>> printf(b"%d bottles of beer\n", bottles)
42 bottles of beer
19
>>>
@end example

If you don’t want to store the instance’s data in the @code{_as_parameter_}
instance variable, you could define a @ref{2fd,,property} which makes the
attribute available on request.

@node Especificar los tipos de argumentos requeridos prototipos de funciones,Tipos de retorno,Funciones de llamada con sus propios tipos de datos personalizados,tutorial de ctypes
@anchor{library/ctypes ctypes-specifying-required-argument-types}@anchor{2fe0}@anchor{library/ctypes specifying-the-required-argument-types-function-prototypes}@anchor{2fe1}
@subsubsection Especificar los tipos de argumentos requeridos (prototipos de funciones)


It is possible to specify the required argument types of functions exported from
DLLs by setting the @ref{2fdd,,argtypes} attribute.

@ref{2fdd,,argtypes} must be a sequence of C data types (the @code{printf()} function is
probably not a good example here, because it takes a variable number and
different types of parameters depending on the format string, on the other hand
this is quite handy to experiment with this feature):

@example
>>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]
>>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)
String 'Hi', Int 10, Double 2.200000
37
>>>
@end example

La especificación de un formato protege contra los tipos de argumentos incompatibles (al igual que un prototipo para una función C), e intenta convertir los argumentos en tipos válidos:

@example
>>> printf(b"%d %d %d", 1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ctypes.ArgumentError: argument 2: TypeError: 'int' object cannot be interpreted as ctypes.c_char_p
>>> printf(b"%s %d %f\n", b"X", 2, 3)
X 2 3.000000
13
>>>
@end example

If you have defined your own classes which you pass to function calls, you have
to implement a @ref{2fe2,,from_param()} class method for them to be able to use them
in the @ref{2fdd,,argtypes} sequence. The @ref{2fe2,,from_param()} class method receives
the Python object passed to the function call, it should do a typecheck or
whatever is needed to make sure this object is acceptable, and then return the
object itself, its @code{_as_parameter_} attribute, or whatever you want to
pass as the C function argument in this case. Again, the result should be an
integer, string, bytes, a @ref{2b,,ctypes} instance, or an object with an
@code{_as_parameter_} attribute.

@node Tipos de retorno,Pasar los punteros o pasar los parámetros por referencia,Especificar los tipos de argumentos requeridos prototipos de funciones,tutorial de ctypes
@anchor{library/ctypes ctypes-return-types}@anchor{2fe3}@anchor{library/ctypes return-types}@anchor{2fe4}
@subsubsection Tipos de retorno


@c from ctypes import CDLL, c_char, c_char_p
@c from ctypes.util import find_library
@c libc = CDLL(find_library('c'))
@c strchr = libc.strchr

By default functions are assumed to return the C int type.  Other
return types can be specified by setting the @ref{2fe5,,restype} attribute of the
function object.

The C prototype of @code{time()} is @code{time_t time(time_t *)}. Because @code{time_t}
might be of a different type than the default return type int, you should
specify the @code{restype} attribute:

@example
>>> libc.time.restype = c_time_t
@end example

The argument types can be specified using @ref{2fdd,,argtypes}:

@example
>>> libc.time.argtypes = (POINTER(c_time_t),)
@end example

To call the function with a @code{NULL} pointer as first argument, use @code{None}:

@example
>>> print(libc.time(None))  
1150640792
@end example

Here is a more advanced example, it uses the @code{strchr()} function, which expects
a string pointer and a char, and returns a pointer to a string:

@example
>>> strchr = libc.strchr
>>> strchr(b"abcdef", ord("d"))  
8059983
>>> strchr.restype = c_char_p    # c_char_p is a pointer to a string
>>> strchr(b"abcdef", ord("d"))
b'def'
>>> print(strchr(b"abcdef", ord("x")))
None
>>>
@end example

If you want to avoid the @ref{1eef,,ord("x")} calls above, you can set the
@ref{2fdd,,argtypes} attribute, and the second argument will be converted from a
single character Python bytes object into a C char:

@example
>>> strchr.restype = c_char_p
>>> strchr.argtypes = [c_char_p, c_char]
>>> strchr(b"abcdef", b"d")
b'def'
>>> strchr(b"abcdef", b"def")
Traceback (most recent call last):
ctypes.ArgumentError: argument 2: TypeError: one character bytes, bytearray or integer expected
>>> print(strchr(b"abcdef", b"x"))
None
>>> strchr(b"abcdef", b"d")
b'def'
>>>
@end example

You can also use a callable Python object (a function or a class for example) as
the @ref{2fe5,,restype} attribute, if the foreign function returns an integer.  The
callable will be called with the `integer' the C function returns, and the
result of this call will be used as the result of your function call. This is
useful to check for error return values and automatically raise an exception:

@example
>>> GetModuleHandle = windll.kernel32.GetModuleHandleA  
>>> def ValidHandle(value):
...     if value == 0:
...         raise WinError()
...     return value
...
>>>
>>> GetModuleHandle.restype = ValidHandle  
>>> GetModuleHandle(None)  
486539264
>>> GetModuleHandle("something silly")  
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in ValidHandle
OSError: [Errno 126] The specified module could not be found.
>>>
@end example

@code{WinError} es una función que llamará a la api Windows @code{FormatMessage} para obtener la representación de la cadena de un código de error, y retornará una excepción. @code{WinError} toma un parámetro de código de error opcional, si no se usa ninguno, llama a @code{GetLastError`()} para recuperarlo.

Please note that a much more powerful error checking mechanism is available
through the @ref{2fe6,,errcheck} attribute;
see the reference manual for details.

@node Pasar los punteros o pasar los parámetros por referencia,Estructuras y uniones,Tipos de retorno,tutorial de ctypes
@anchor{library/ctypes ctypes-passing-pointers}@anchor{2fe7}@anchor{library/ctypes passing-pointers-or-passing-parameters-by-reference}@anchor{2fe8}
@subsubsection Pasar los punteros (o: pasar los parámetros por referencia)


A veces una función api C espera un `puntero' a un tipo de datos como parámetro, probablemente para escribir en el lugar correspondiente, o si los datos son demasiado grandes para ser pasados por valor. Esto también se conoce cómo `pasar parámetros por referencia'.

@ref{2b,,ctypes} exporta la función @ref{2fe9,,byref()} que se utiliza para pasar parámetros por referencia. El mismo efecto se puede conseguir con la función @ref{16eb,,pointer()}, aunque @ref{16eb,,pointer()} hace mucho más trabajo ya que construye un objeto puntero real, por lo que es más rápido usar @ref{2fe9,,byref()} si no se necesita el objeto puntero en el propio Python:

@example
>>> i = c_int()
>>> f = c_float()
>>> s = create_string_buffer(b'\000' * 32)
>>> print(i.value, f.value, repr(s.value))
0 0.0 b'@w{'}
>>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",
...             byref(i), byref(f), s)
3
>>> print(i.value, f.value, repr(s.value))
1 3.1400001049 b'Hello'
>>>
@end example

@node Estructuras y uniones,Structure/union layout alignment and byte order,Pasar los punteros o pasar los parámetros por referencia,tutorial de ctypes
@anchor{library/ctypes ctypes-structures-unions}@anchor{2fea}@anchor{library/ctypes structures-and-unions}@anchor{2feb}
@subsubsection Estructuras y uniones


Structures and unions must derive from the @ref{166,,Structure} and @ref{167,,Union}
base classes which are defined in the @ref{2b,,ctypes} module. Each subclass must
define a @ref{15cb,,_fields_} attribute.  @code{_fields_} must be a list of
`2-tuples', containing a `field name' and a `field type'.

El tipo de campo debe ser un tipo @ref{2b,,ctypes} como @ref{2fc2,,c_int}, o cualquier otro tipo @ref{2b,,ctypes} derivado: estructura, unión, matriz, puntero.

Aquí hay un ejemplo simple de una estructura POINT, que contiene dos enteros llamados `x' y `y', y también muestra cómo inicializar una estructura en el constructor:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = [("x", c_int),
...                 ("y", c_int)]
...
>>> point = POINT(10, 20)
>>> print(point.x, point.y)
10 20
>>> point = POINT(y=5)
>>> print(point.x, point.y)
0 5
>>> POINT(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: too many initializers
>>>
@end example

Sin embargo, se pueden construir estructuras mucho más complicadas. Una estructura puede contener por sí misma otras estructuras usando una estructura como tipo de campo.

Aquí hay una estructura RECT que contiene dos POINTs llamados `upperleft' (superior izquierda)y `lowerright' (abajo a la derecha):

@example
>>> class RECT(Structure):
...     _fields_ = [("upperleft", POINT),
...                 ("lowerright", POINT)]
...
>>> rc = RECT(point)
>>> print(rc.upperleft.x, rc.upperleft.y)
0 5
>>> print(rc.lowerright.x, rc.lowerright.y)
0 0
>>>
@end example

Las estructuras anidadas también pueden ser inicializadas en el constructor de varias maneras:

@example
>>> r = RECT(POINT(1, 2), POINT(3, 4))
>>> r = RECT((1, 2), (3, 4))
@end example

El campo @ref{1f70,,descriptor} puede ser recuperado de la `class', son útiles para la depuración porque pueden proporcionar información útil:

@example
>>> print(POINT.x)
<Field type=c_long, ofs=0, size=4>
>>> print(POINT.y)
<Field type=c_long, ofs=4, size=4>
>>>
@end example
@anchor{library/ctypes ctypes-structureunion-alignment-byte-order}@anchor{2fec}
@cartouche
@quotation Advertencia 
@ref{2b,,ctypes} no soporta el paso de uniones o estructuras con campos de bits a funciones por valor. Aunque esto puede funcionar en 32-bit x86, la biblioteca no garantiza que funcione en el caso general. Las uniones y estructuras con campos de bits siempre deben pasarse a las funciones por puntero.
@end quotation
@end cartouche

@node Structure/union layout alignment and byte order,Campos de bits en estructuras y uniones,Estructuras y uniones,tutorial de ctypes
@anchor{library/ctypes structure-union-layout-alignment-and-byte-order}@anchor{2fed}
@subsubsection Structure/union layout, alignment and byte order


By default, Structure and Union fields are laid out in the same way the C
compiler does it.  It is possible to override this behavior entirely by specifying a
@ref{168,,_layout_} class attribute in the subclass definition; see
the attribute documentation for details.

It is possible to specify the maximum alignment for the fields by setting
the @ref{2fee,,_pack_} class attribute to a positive integer.
This matches what @code{#pragma pack(n)} does in MSVC.

It is also possible to set a minimum alignment for how the subclass itself is packed in the
same way @code{#pragma align(n)} works in MSVC.
This can be achieved by specifying a :@ref{337,,_align_} class attribute
in the subclass definition.

@ref{2b,,ctypes} utiliza el orden de bytes nativos para las Estructuras y Uniones. Para construir estructuras con un orden de bytes no nativo, puedes usar una de las clases base @ref{2fef,,BigEndianStructure}, @ref{2ff0,,LittleEndianStructure}, @ref{182d,,BigEndianUnion}, y @ref{182e,,LittleEndianUnion}. Estas clases no pueden contener campos puntero.

@node Campos de bits en estructuras y uniones,Arreglos,Structure/union layout alignment and byte order,tutorial de ctypes
@anchor{library/ctypes bit-fields-in-structures-and-unions}@anchor{2ff1}@anchor{library/ctypes ctypes-bit-fields-in-structures-unions}@anchor{165}
@subsubsection Campos de bits en estructuras y uniones


It is possible to create structures and unions containing bit fields. Bit fields
are only possible for integer fields, the bit width is specified as the third
item in the @ref{15cb,,_fields_} tuples:

@example
>>> class Int(Structure):
...     _fields_ = [("first_16", c_int, 16),
...                 ("second_16", c_int, 16)]
...
>>> print(Int.first_16)
<Field type=c_long, ofs=0:0, bits=16>
>>> print(Int.second_16)
<Field type=c_long, ofs=0:16, bits=16>
>>>
@end example

@node Arreglos,Punteros,Campos de bits en estructuras y uniones,tutorial de ctypes
@anchor{library/ctypes arrays}@anchor{2ff2}@anchor{library/ctypes ctypes-arrays}@anchor{2ff3}
@subsubsection Arreglos


Los arreglos son secuencias, que contienen un número fijo de instancias del mismo tipo.

La forma recomendada de crear tipos de arreglos es multiplicando un tipo de dato por un entero positivo:

@example
TenPointsArrayType = POINT * 10
@end example

Aquí hay un ejemplo de un tipo de datos algo artificial, una estructura que contiene 4 POINTs entre otras cosas:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = ("x", c_int), ("y", c_int)
...
>>> class MyStruct(Structure):
...     _fields_ = [("a", c_int),
...                 ("b", c_float),
...                 ("point_array", POINT * 4)]
>>>
>>> print(len(MyStruct().point_array))
4
>>>
@end example

Las instancias se crean de la manera habitual, llamando a la clase:

@example
arr = TenPointsArrayType()
for pt in arr:
    print(pt.x, pt.y)
@end example

El código anterior imprime una serie de líneas @code{0 0}, porque el contenido del arreglos se inicializa con ceros.

También se pueden especificar inicializadores del tipo correcto:

@example
>>> from ctypes import *
>>> TenIntegers = c_int * 10
>>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
>>> print(ii)
<c_long_Array_10 object at 0x...>
>>> for i in ii: print(i, end=" ")
...
1 2 3 4 5 6 7 8 9 10
>>>
@end example

@node Punteros,Conversiones de tipos,Arreglos,tutorial de ctypes
@anchor{library/ctypes ctypes-pointers}@anchor{2ff4}@anchor{library/ctypes pointers}@anchor{2ff5}
@subsubsection Punteros


Las instancias de puntero se crean llamando a la función @ref{16eb,,pointer()} en un tipo @ref{2b,,ctypes}:

@example
>>> from ctypes import *
>>> i = c_int(42)
>>> pi = pointer(i)
>>>
@end example

Las instancias del puntero tienen un atributo @ref{2ff6,,contents} que retorna el objeto al que apunta el puntero, el objeto @code{i} arriba:

@example
>>> pi.contents
c_long(42)
>>>
@end example

Ten en cuenta que @ref{2b,,ctypes} no tiene OOR (original object return), construye un nuevo objeto equivalente cada vez que recuperas un atributo:

@example
>>> pi.contents is i
False
>>> pi.contents is pi.contents
False
>>>
@end example

Asignar otra instancia @ref{2fc2,,c_int} al atributo de contenido del puntero causaría que el puntero apunte al lugar de memoria donde se almacena:

@example
>>> i = c_int(99)
>>> pi.contents = i
>>> pi.contents
c_long(99)
>>>
@end example

@c XXX Document dereferencing pointers, and that it is preferred over the
@c .contents attribute.

Las instancias de puntero también pueden ser indexadas con números enteros:

@example
>>> pi[0]
99
>>>
@end example

Asignando a un índice entero cambia el valor señalado:

@example
>>> print(i)
c_long(99)
>>> pi[0] = 22
>>> print(i)
c_long(22)
>>>
@end example

También es posible usar índices diferentes de 0, pero debes saber lo que estás haciendo, al igual que en C: Puedes acceder o cambiar arbitrariamente las ubicaciones de memoria. Generalmente sólo usas esta característica si recibes un puntero de una función C, y `sabes' que el puntero en realidad apunta a un arreglo en lugar de a un solo elemento.

Entre bastidores, la función @ref{16eb,,pointer()} hace más que simplemente crear instancias de puntero, tiene que crear primero punteros `tipos'. Esto se hace con la función @ref{16ec,,POINTER()}, que acepta cualquier tipo de @ref{2b,,ctypes}, y retorna un nuevo tipo:

@example
>>> PI = POINTER(c_int)
>>> PI
<class 'ctypes.LP_c_long'>
>>> PI(42)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: expected c_long instead of int
>>> PI(c_int(42))
<ctypes.LP_c_long object at 0x...>
>>>
@end example

Llamar al tipo de puntero sin un argumento crea un puntero @code{NULL}. Los punteros @code{NULL} tienen un valor booleano falso..:

@example
>>> null_ptr = POINTER(c_int)()
>>> print(bool(null_ptr))
False
>>>
@end example

@ref{2b,,ctypes} comprueba si hay @code{NULL} cuando los punteros de referencia (pero los punteros no válidos de referencia no-@code{NULL} se romperán en Python):

@example
>>> null_ptr[0]
Traceback (most recent call last):
    ....
ValueError: NULL pointer access
>>>

>>> null_ptr[0] = 1234
Traceback (most recent call last):
    ....
ValueError: NULL pointer access
>>>
@end example

@node Conversiones de tipos,Tipos incompletos,Punteros,tutorial de ctypes
@anchor{library/ctypes ctypes-type-conversions}@anchor{2ff7}@anchor{library/ctypes type-conversions}@anchor{2ff8}
@subsubsection Conversiones de tipos


Usually, ctypes does strict type checking.  This means, if you have
@code{POINTER(c_int)} in the @ref{2fdd,,argtypes} list of a function or as the type of
a member field in a structure definition, only instances of exactly the same
type are accepted.  There are some exceptions to this rule, where ctypes accepts
other objects.  For example, you can pass compatible array instances instead of
pointer types.  So, for @code{POINTER(c_int)}, ctypes accepts an array of c_int:

@example
>>> class Bar(Structure):
...     _fields_ = [("count", c_int), ("values", POINTER(c_int))]
...
>>> bar = Bar()
>>> bar.values = (c_int * 3)(1, 2, 3)
>>> bar.count = 3
>>> for i in range(bar.count):
...     print(bar.values[i])
...
1
2
3
>>>
@end example

In addition, if a function argument is explicitly declared to be a pointer type
(such as @code{POINTER(c_int)}) in @ref{2fdd,,argtypes}, an object of the pointed
type (@code{c_int} in this case) can be passed to the function.  ctypes will apply
the required @ref{2fe9,,byref()} conversion in this case automatically.

Para poner un campo de tipo POINTER a @code{NULL}, puedes asignar @code{None}:

@example
>>> bar.values = None
>>>
@end example

@c XXX list other conversions...

A veces se tienen instancias de tipos incompatibles. En C, puedes cambiar un tipo por otro tipo. @ref{2b,,ctypes} proporciona una función @ref{2ff9,,cast()} qué puede ser usada de la misma manera. La estructura @code{Bar} definida arriba acepta punteros @code{POINTER(c_int)} o arreglos @code{c_int`} para su campo @code{values}, pero no instancias de otros tipos:

@example
>>> bar.values = (c_byte * 4)()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance
>>>
@end example

Para estos casos, la función @ref{2ff9,,cast()} es muy útil.

La función @ref{2ff9,,cast()} puede ser usada para lanzar una instancia ctypes en un puntero a un tipo de datos ctypes diferente. @ref{2ff9,,cast()} toma dos parámetros, un objeto ctypes que es o puede ser convertido en un puntero de algún tipo, y un tipo de puntero ctypes. retorna una instancia del segundo argumento, que hace referencia al mismo bloque de memoria que el primer argumento:

@example
>>> a = (c_byte * 4)()
>>> cast(a, POINTER(c_int))
<ctypes.LP_c_long object at ...>
>>>
@end example

Así, @ref{2ff9,,cast()} puede ser usado para asignar al campo @code{values} de @code{Bar} la estructura:

@example
>>> bar = Bar()
>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
>>> print(bar.values[0])
0
>>>
@end example

@node Tipos incompletos,Funciones de retrollamadas callback,Conversiones de tipos,tutorial de ctypes
@anchor{library/ctypes ctypes-incomplete-types}@anchor{2ffa}@anchor{library/ctypes incomplete-types}@anchor{2ffb}
@subsubsection Tipos incompletos


`Los Tipos Incompletos' son estructuras, uniones o matrices cuyos miembros aún no están especificados. En C, se especifican mediante declaraciones a futuro, que se definen más adelante:

@example
struct cell; /* forward declaration */

struct cell @{
    char *name;
    struct cell *next;
@};
@end example

La traducción directa al código de ctypes sería esta, pero no funciona:

@example
>>> class cell(Structure):
...     _fields_ = [("name", c_char_p),
...                 ("next", POINTER(cell))]
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in cell
NameError: name 'cell' is not defined
>>>
@end example

because the new @code{class cell} is not available in the class statement itself.
In @ref{2b,,ctypes}, we can define the @code{cell} class and set the
@ref{15cb,,_fields_} attribute later, after the class statement:

@example
>>> from ctypes import *
>>> class cell(Structure):
...     pass
...
>>> cell._fields_ = [("name", c_char_p),
...                  ("next", POINTER(cell))]
>>>
@end example

Vamos a intentarlo. Creamos dos instancias de @code{cell}, y dejamos que se apunten una a la otra, y finalmente seguimos la cadena de punteros unas cuantas veces:

@example
>>> c1 = cell()
>>> c1.name = b"foo"
>>> c2 = cell()
>>> c2.name = b"bar"
>>> c1.next = pointer(c2)
>>> c2.next = pointer(c1)
>>> p = c1
>>> for i in range(8):
...     print(p.name, end=" ")
...     p = p.next[0]
...
foo bar foo bar foo bar foo bar
>>>
@end example

@node Funciones de retrollamadas callback,Acceder a los valores exportados de los dlls,Tipos incompletos,tutorial de ctypes
@anchor{library/ctypes callback-functions}@anchor{2ffc}@anchor{library/ctypes ctypes-callback-functions}@anchor{2ffd}
@subsubsection Funciones de retrollamadas (`callback')


@ref{2b,,ctypes} permite crear punteros de función invocables C a partir de los invocables de Python. A veces se llaman `funciones de retrollamada'.

Primero, debes crear una clase para la función de retrollamada. La clase conoce la convención de llamada, el tipo de retorno, y el número y tipos de argumentos que esta función recibirá.

La función de fábrica @code{CFUNCTYPE`()} crea tipos para las funciones de retrollamada usando la convención de llamada @code{cdecl}. En Windows, la función de fábrica @ref{2ffe,,WINFUNCTYPE()} crea tipos para funciones de retrollamadas usando la convención de llamadas @code{stdcall}.

Ambas funciones de fábrica se llaman con el tipo de resultado como primer argumento, y las funciones de llamada de retorno con los tipos de argumentos esperados como los argumentos restantes.

I will present an example here which uses the standard C library’s
@code{qsort()} function, that is used to sort items with the help of a callback
function.  @code{qsort()} will be used to sort an array of integers:

@example
>>> IntArray5 = c_int * 5
>>> ia = IntArray5(5, 1, 7, 33, 99)
>>> qsort = libc.qsort
>>> qsort.restype = None
>>>
@end example

@code{qsort()} must be called with a pointer to the data to sort, the number of
items in the data array, the size of one item, and a pointer to the comparison
function, the callback. The callback will then be called with two pointers to
items, and it must return a negative integer if the first item is smaller than
the second, a zero if they are equal, and a positive integer otherwise.

Así que nuestra función de retrollamada recibe punteros a números enteros, y debe retornar un número entero. Primero creamos el @code{tipo} para la función de retrollamada:

@example
>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
>>>
@end example

Para empezar, aquí hay una simple llamada que muestra los valores que se pasan:

@example
>>> def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return 0
...
>>> cmp_func = CMPFUNC(py_cmp_func)
>>>
@end example

El resultado:

@example
>>> qsort(ia, len(ia), sizeof(c_int), cmp_func)  
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 5 7
py_cmp_func 1 7
>>>
@end example

Ahora podemos comparar los dos artículos y obtener un resultado útil:

@example
>>> def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return a[0] - b[0]
...
>>>
>>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func)) 
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 1 7
py_cmp_func 5 7
>>>
@end example

Como podemos comprobar fácilmente, nuestro arreglo está ordenado ahora:

@example
>>> for i in ia: print(i, end=" ")
...
1 5 7 33 99
>>>
@end example

Las funciones de fabrica pueden ser usadas como decoradores de fabrica, así que podemos escribir:

@example
>>> @@CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
... def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return a[0] - b[0]
...
>>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func)
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 1 7
py_cmp_func 5 7
>>>
@end example

@cartouche
@quotation Nota 
Asegúrate de mantener las referencias a los objetos @ref{2fff,,CFUNCTYPE()} mientras se usen desde el código C. @ref{2b,,ctypes} no lo hace, y si no lo haces, pueden ser basura recolectada, colapsando tu programa cuando se hace una llamada.

Además, nótese que sí se llama a la función de retrollamada en un hilo creado fuera del control de Python (por ejemplo, por el código foráneo que llama a la retrollamada), ctypes crea un nuevo hilo Python tonto en cada invocación. Este comportamiento es correcto para la mayoría de los propósitos, pero significa que los valores almacenados con @ref{1773,,threading.local} `no' sobreviven a través de diferentes llamadas de retorno, incluso cuando esas llamadas se hacen desde el mismo hilo C.
@end quotation
@end cartouche

@node Acceder a los valores exportados de los dlls,Sorpresas,Funciones de retrollamadas callback,tutorial de ctypes
@anchor{library/ctypes accessing-values-exported-from-dlls}@anchor{3000}@anchor{library/ctypes ctypes-accessing-values-exported-from-dlls}@anchor{3001}
@subsubsection Acceder a los valores exportados de los dlls


Some shared libraries not only export functions, they also export variables. An
example in the Python library itself is the @ref{7f0,,Py_Version}, Python
runtime version number encoded in a single constant integer.

@ref{2b,,ctypes} can access values like this with the @ref{3002,,in_dll()} class methods of
the type.  `pythonapi' is a predefined symbol giving access to the Python C
api:

@example
>>> version = ctypes.c_int.in_dll(ctypes.pythonapi, "Py_Version")
>>> print(hex(version.value))
0x30c00a0
@end example

Un ejemplo extendido que también demuestra el uso de punteros accediendo al puntero @ref{3003,,PyImport_FrozenModules} exportado por Python.

Citando los documentos para ese valor:

@quotation

Este puntero se inicializa para apuntar a un arreglo de registros @ref{80f,,_frozen}, terminados por uno cuyos miembros son todos @code{NULL} o cero. Cuando se importa un módulo congelado, se busca en esta tabla. El código de terceros podría jugar trucos con esto para proporcionar una colección de módulos congelados creada dinámicamente.
@end quotation

Así que manipular este puntero podría incluso resultar útil. Para restringir el tamaño del ejemplo, sólo mostramos cómo esta tabla puede ser leída con @ref{2b,,ctypes}:

@example
>>> from ctypes import *
>>>
>>> class struct_frozen(Structure):
...     _fields_ = [("name", c_char_p),
...                 ("code", POINTER(c_ubyte)),
...                 ("size", c_int),
...                 ("get_code", POINTER(c_ubyte)),  # Function pointer
...                ]
...
>>>
@end example

Hemos definido el tipo de datos @ref{80f,,_frozen}, por lo que podemos obtener el puntero a la tabla:

@example
>>> FrozenTable = POINTER(struct_frozen)
>>> table = FrozenTable.in_dll(pythonapi, "_PyImport_FrozenBootstrap")
>>>
@end example

Como @code{tabla} es un @code{puntero} al arreglo de registros @code{struct_frozen}, podemos iterar sobre ella, pero sólo tenemos que asegurarnos de que nuestro bucle termine, porque los punteros no tienen tamaño. Tarde o temprano, probablemente se caerá con una violación de acceso o lo que sea, así que es mejor salir del bucle cuando le demos a la entrada @code{NULL}:

@example
>>> for item in table:
...     if item.name is None:
...         break
...     print(item.name.decode("ascii"), item.size)
...
_frozen_importlib 31764
_frozen_importlib_external 41499
zipimport 12345
>>>
@end example

El hecho de que la Python estándar tenga un módulo congelado y un paquete congelado (indicado por el miembro @code{tamaño} negativo) no se conoce bien, sólo se usa para hacer pruebas. Pruébalo con @code{import __hello__} por ejemplo.

@node Sorpresas,Tipos de datos de tamaño variable,Acceder a los valores exportados de los dlls,tutorial de ctypes
@anchor{library/ctypes ctypes-surprises}@anchor{3004}@anchor{library/ctypes surprises}@anchor{3005}
@subsubsection Sorpresas


Hay algunas aristas en @ref{2b,,ctypes} en las que podrías esperar algo distinto de lo que realmente sucede.

Considere el siguiente ejemplo:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = ("x", c_int), ("y", c_int)
...
>>> class RECT(Structure):
...     _fields_ = ("a", POINT), ("b", POINT)
...
>>> p1 = POINT(1, 2)
>>> p2 = POINT(3, 4)
>>> rc = RECT(p1, p2)
>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
1 2 3 4
>>> # now swap the two points
>>> rc.a, rc.b = rc.b, rc.a
>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
3 4 3 4
>>>
@end example

Hm. Ciertamente esperábamos que la última declaración imprimiera @code{3 4 1 2}. ¿Qué ha pasado? Aquí están los pasos de la línea @code{rc.a, rc.b = rc.b, rc.a} arriba:

@example
>>> temp0, temp1 = rc.b, rc.a
>>> rc.a = temp0
>>> rc.b = temp1
>>>
@end example

Note que @code{temp0} y @code{temp1} son objetos que todavía usan el buffer interno del objeto @code{rc} de arriba. Así que ejecutando @code{rc.a = temp0} copia el contenido del buffer de @code{temp0} en el buffer de @code{rc}. Esto, a su vez, cambia el contenido de @code{temp1}. Por lo tanto, la última asignación @code{rc.b = temp1}, no tiene el efecto esperado.

Tengan en cuenta que la recuperación de subobjetos de Estructuras, Uniones y Arreglos no `copia' el subobjeto, sino que recupera un objeto contenido que accede al búfer subyacente del objeto raíz.

Otro ejemplo que puede comportarse de manera diferente a lo que uno esperaría es este:

@example
>>> s = c_char_p()
>>> s.value = b"abc def ghi"
>>> s.value
b'abc def ghi'
>>> s.value is s.value
False
>>>
@end example

@cartouche
@quotation Nota 
Los objetos instanciados desde @ref{16ed,,c_char_p} sólo pueden tener su valor fijado en bytes o enteros.
@end quotation
@end cartouche

¿Por qué está imprimiendo @code{False}? Las instancias ctypes son objetos que contienen un bloque de memoria más algunos @ref{1f70,,descriptor}s que acceden al contenido de la memoria. Almacenar un objeto Python en el bloque de memoria no almacena el objeto en sí mismo, en su lugar se almacenan los @code{contenidos} del objeto. ¡Acceder a los contenidos de nuevo construye un nuevo objeto Python cada vez!

@node Tipos de datos de tamaño variable,,Sorpresas,tutorial de ctypes
@anchor{library/ctypes ctypes-variable-sized-data-types}@anchor{3006}@anchor{library/ctypes variable-sized-data-types}@anchor{3007}
@subsubsection Tipos de datos de tamaño variable


@ref{2b,,ctypes} proporciona algo de soporte para matrices y estructuras de tamaño variable.

La función @ref{3008,,resize()} puede ser usada para redimensionar el buffer de memoria de un objeto ctypes existente. La función toma el objeto como primer argumento, y el tamaño solicitado en bytes como segundo argumento. El bloque de memoria no puede hacerse más pequeño que el bloque de memoria natural especificado por el tipo de objeto, se lanza un @ref{360,,ValueError} si se intenta:

@example
>>> short_array = (c_short * 4)()
>>> print(sizeof(short_array))
8
>>> resize(short_array, 4)
Traceback (most recent call last):
    ...
ValueError: minimum size is 8
>>> resize(short_array, 32)
>>> sizeof(short_array)
32
>>> sizeof(type(short_array))
8
>>>
@end example

Esto está bien, pero ¿cómo se puede acceder a los elementos adicionales contenidos en este arreglo?  Dado que el tipo todavía sabe sólo 4 elementos, obtenemos errores al acceder a otros elementos:

@example
>>> short_array[:]
[0, 0, 0, 0]
>>> short_array[7]
Traceback (most recent call last):
    ...
IndexError: invalid index
>>>
@end example

Otra forma de utilizar tipos de datos de tamaño variable con @ref{2b,,ctypes} es utilizar la naturaleza dinámica de Python, y (re)definir el tipo de datos después de que se conozca el tamaño requerido, caso por caso.

@node referencia ctypes,,tutorial de ctypes,ctypes — A foreign function library for Python
@anchor{library/ctypes ctypes-ctypes-reference}@anchor{3009}@anchor{library/ctypes ctypes-reference}@anchor{300a}
@subsubsection referencia ctypes


@menu
* Encontrar bibliotecas compartidas:: 
* Cargando bibliotecas compartidas:: 
* Funciones foráneas:: 
* Prototipos de funciones:: 
* Funciones de utilidad:: 
* Tipos de datos: Tipos de datos<3>. 
* Tipos de datos fundamentales: Tipos de datos fundamentales<2>. 
* Tipos de datos estructurados:: 
* Arreglos y punteros:: 

@end menu

@node Encontrar bibliotecas compartidas,Cargando bibliotecas compartidas,,referencia ctypes
@anchor{library/ctypes ctypes-finding-shared-libraries}@anchor{300b}@anchor{library/ctypes finding-shared-libraries}@anchor{300c}
@subsubsection Encontrar bibliotecas compartidas


Cuando se programa en un lenguaje compilado, se accede a las bibliotecas compartidas cuando se compila/enlaza un programa, y cuándo se ejecuta el programa.

The purpose of the @ref{dd0,,find_library()} function is to locate a library in a way
similar to what the compiler or runtime loader does (on platforms with several
versions of a shared library the most recent should be loaded), while the ctypes
library loaders act like when a program is run, and call the runtime loader
directly.

The @code{ctypes.util} module provides a function which can help to determine
the library to load.


@deffn {Dato} ctypes.util.find_library (name)

Intenta encontrar una biblioteca y retornar un nombre. `name' es el nombre de la biblioteca sin ningún prefijo como `lib', sufijo como @code{.so}, @code{.dylib} o número de versión (esta es la forma usada para la opción del enlazador posix @code{-l}). Si no se puede encontrar ninguna biblioteca, retorna @code{None}.
@end deffn

La funcionalidad exacta depende del sistema.

On Linux, @ref{dd0,,find_library()} tries to run external programs
(@code{/sbin/ldconfig}, @code{gcc}, @code{objdump} and @code{ld}) to find the library file.
It returns the filename of the library file.


Distinto en la versión 3.6: En Linux, el valor de la variable de entorno @code{LD_LIBRARY_PATH} se utiliza cuando se buscan bibliotecas, si una biblioteca no puede ser encontrada por ningún otro medio.


Aquí hay algunos ejemplos:

@example
>>> from ctypes.util import find_library
>>> find_library("m")
'libm.so.6'
>>> find_library("c")
'libc.so.6'
>>> find_library("bz2")
'libbz2.so.1.0'
>>>
@end example

On macOS and Android, @ref{dd0,,find_library()} uses the system’s
standard naming schemes and paths to locate the library, and returns a full
pathname if successful:

@example
>>> from ctypes.util import find_library
>>> find_library("c")
'/usr/lib/libc.dylib'
>>> find_library("m")
'/usr/lib/libm.dylib'
>>> find_library("bz2")
'/usr/lib/libbz2.dylib'
>>> find_library("AGL")
'/System/Library/Frameworks/AGL.framework/AGL'
>>>
@end example

On Windows, @ref{dd0,,find_library()} searches along the system search path, and
returns the full pathname, but since there is no predefined naming scheme a call
like @code{find_library("c")} will fail and return @code{None}.

If wrapping a shared library with @ref{2b,,ctypes}, it `may' be better to determine
the shared library name at development time, and hardcode that into the wrapper
module instead of using @ref{dd0,,find_library()} to locate the library at runtime.

@node Cargando bibliotecas compartidas,Funciones foráneas,Encontrar bibliotecas compartidas,referencia ctypes
@anchor{library/ctypes ctypes-loading-shared-libraries}@anchor{300d}@anchor{library/ctypes loading-shared-libraries}@anchor{300e}
@subsubsection Cargando bibliotecas compartidas


Hay varias maneras de cargar las bibliotecas compartidas en el proceso Python. Una forma es instanciar una de las siguientes clases:

@geindex CDLL (clase en ctypes)
@anchor{library/ctypes ctypes CDLL}@anchor{a7b}
@deffn {Clase} ctypes.CDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Las instancias de esta clase representan bibliotecas compartidas cargadas. Las funciones en estas bibliotecas utilizan la convención de llamada estándar de C y se supone que retornan int.

En Windows, la creación de una instancia @ref{a7b,,CDLL} puede fallar incluso si existe el nombre de la DLL. Cuando no se encuentra una DLL dependiente de la DLL cargada, se lanza un error @ref{4d5,,OSError} con el mensaje `«[WinError 126] No se pudo encontrar el módulo especificado».' Este mensaje de error no contiene el nombre de DLL que falta porque la API de Windows no retorna esta información, lo que dificulta el diagnóstico de este error. Para resolver este error y determinar qué DLL no se encuentra, debe buscar la lista de DLL dependientes y determinar cuál no se encuentra utilizando las herramientas de depuración y seguimiento de Windows.


Distinto en la versión 3.12: The `name' parameter can now be a @ref{3f0,,path-like object}.

@end deffn


@subsubheading Ver también


Herramienta Microsoft DUMPBIN@footnote{https://docs.microsoft.com/cpp/build/reference/dependents} – Una herramienta para encontrar dependientes de DLL.


@geindex OleDLL (clase en ctypes)
@anchor{library/ctypes ctypes OleDLL}@anchor{177a}
@deffn {Clase} ctypes.OleDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Sólo Windows: Las instancias de esta clase representan bibliotecas compartidas cargadas, las funciones en estas bibliotecas usan la convención de llamada @code{stdcall}, y se asume que retornan el código específico de windows @code{HRESULT`}. Los valores @code{HRESULT`} contienen información que especifica si la llamada a la función falló o tuvo éxito, junto con un código de error adicional. Si el valor de retorno señala un fracaso, se lanza automáticamente un @code{OSError`}.


Distinto en la versión 3.3: @ref{10d0,,WindowsError} used to be raised,
which is now an alias of @ref{4d5,,OSError}.



Distinto en la versión 3.12: The `name' parameter can now be a @ref{3f0,,path-like object}.

@end deffn

@geindex WinDLL (clase en ctypes)
@anchor{library/ctypes ctypes WinDLL}@anchor{177b}
@deffn {Clase} ctypes.WinDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Solo Windows: las instancias de esta clase representan bibliotecas compartidas cargadas, las funciones en estas bibliotecas utilizan la convención de llamadas @code{stdcall} y se supone que retornan int de forma predeterminada.


Distinto en la versión 3.12: The `name' parameter can now be a @ref{3f0,,path-like object}.

@end deffn

El termino Python @ref{2b5,,global interpreter lock} es lanzado antes de llamar a cualquier función exportada por estas librerías, y se requiere después.

@geindex PyDLL (clase en ctypes)
@anchor{library/ctypes ctypes PyDLL}@anchor{177c}
@deffn {Clase} ctypes.PyDLL (name, mode=DEFAULT_MODE, handle=None)

Las instancias de esta clase se comportan como instancias @ref{a7b,,CDLL} , excepto que el GIL de Python es `no' liberado durante la llamada a la función, y después de la ejecución de la función se comprueba si esta activo el flag de error de Python. Si el flag de error esta activado, se lanza una excepción Python.

Por lo tanto, esto sólo es útil para llamar directamente a las funciones api C de Python.


Distinto en la versión 3.12: The `name' parameter can now be a @ref{3f0,,path-like object}.

@end deffn

All these classes can be instantiated by calling them with at least one
argument, the pathname of the shared library.  If you have an existing handle to
an already loaded shared library, it can be passed as the @code{handle} named
parameter, otherwise the underlying platform’s @code{dlopen()} or
@code{LoadLibrary()} function is used to load the library into
the process, and to get a handle to it.

El parámetro `mode' puede utilizarse para especificar cómo se carga la biblioteca. Para más detalles, consulte la página @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} del manual. En Windows, `mode' es ignorado. En los sistemas posix, RTLD_NOW siempre se agrega, y no es configurable.

The `use_errno' parameter, when set to true, enables a ctypes mechanism that
allows accessing the system @ref{57,,errno} error number in a safe way.
@ref{2b,,ctypes} maintains a thread-local copy of the system’s @ref{57,,errno}
variable; if you call foreign functions created with @code{use_errno=True} then the
@ref{57,,errno} value before the function call is swapped with the ctypes private
copy, the same happens immediately after the function call.

La función @ref{300f,,ctypes.get_errno()} retorna el valor de la copia privada de ctypes, y la función @ref{3010,,ctypes.set_errno()} cambia la copia privada de ctypes a un nuevo valor y retorna el valor anterior.

The `use_last_error' parameter, when set to true, enables the same mechanism for
the Windows error code which is managed by the @ref{3011,,GetLastError()} and
@code{SetLastError()} Windows API functions; @ref{3012,,ctypes.get_last_error()} and
@ref{3013,,ctypes.set_last_error()} are used to request and change the ctypes private
copy of the windows error code.

The `winmode' parameter is used on Windows to specify how the library is loaded
(since `mode' is ignored). It takes any value that is valid for the Win32 API
@code{LoadLibraryEx} flags parameter. When omitted, the default is to use the
flags that result in the most secure DLL load, which avoids issues such as DLL
hijacking. Passing the full path to the DLL is the safest way to ensure the
correct library and dependencies are loaded.


Distinto en la versión 3.8: Añadido el parámetro `winmode'.



@deffn {Dato} ctypes.RTLD_GLOBAL

Flag para usar como parámetro `modo'. En las plataformas en las que esta bandera no está disponible, se define como el cero entero.
@end deffn


@deffn {Dato} ctypes.RTLD_LOCAL

Flag para usar como parámetro `modo'. En las plataformas en las que esto no está disponible, es lo mismo que `RTLD_GLOBAL'.
@end deffn


@deffn {Dato} ctypes.DEFAULT_MODE

El modo por defecto que se utiliza para cargar las bibliotecas compartidas. En OSX 10.3, esto es `RTLD_GLOBAL', de lo contrario es lo mismo que `RTLD_LOCAL'.
@end deffn

Las instancias de estas clases no tienen métodos públicos. Se puede acceder a las funciones exportadas por la biblioteca compartida como atributos o por índice. Tenga en cuenta que al acceder a la función a través de un atributo se almacena en caché el resultado y, por lo tanto, al acceder a él repetidamente se retorna el mismo objeto cada vez. Por otro lado, acceder a ella a través de un índice retorna un nuevo objeto cada vez:

@example
>>> from ctypes import CDLL
>>> libc = CDLL("libc.so.6")  # On Linux
>>> libc.time == libc.time
True
>>> libc['time'] == libc['time']
False
@end example

Los siguientes atributos públicos están disponibles, su nombre comienza con un guión bajo para no chocar con los nombres de las funciones exportadas:

@geindex _handle (atributo de ctypes.PyDLL)
@anchor{library/ctypes ctypes PyDLL _handle}@anchor{3014}
@deffn {Atributo} PyDLL._handle

El manejador del sistema usado para acceder a la biblioteca.
@end deffn

@geindex _name (atributo de ctypes.PyDLL)
@anchor{library/ctypes ctypes PyDLL _name}@anchor{3015}
@deffn {Atributo} PyDLL._name

El nombre de la biblioteca pasado en el constructor.
@end deffn

Shared libraries can also be loaded by using one of the prefabricated objects,
which are instances of the @ref{3016,,LibraryLoader} class, either by calling the
@ref{2fc6,,LoadLibrary()} method, or by retrieving the library as
attribute of the loader instance.

@geindex LibraryLoader (clase en ctypes)
@anchor{library/ctypes ctypes LibraryLoader}@anchor{3016}
@deffn {Clase} ctypes.LibraryLoader (dlltype)

Clase que carga bibliotecas compartidas. `dlltype' debe ser uno de los tipos @ref{a7b,,CDLL}, @ref{177c,,PyDLL}, @ref{177b,,WinDLL}, o @ref{177a,,OleDLL}.

@code{__getattr__()} has special behavior: It allows loading a shared library by
accessing it as attribute of a library loader instance.  The result is cached,
so repeated attribute accesses return the same library each time.

@geindex LoadLibrary() (método de ctypes.LibraryLoader)
@anchor{library/ctypes ctypes LibraryLoader LoadLibrary}@anchor{2fc6}
@deffn {Método} LoadLibrary (name)

Carga una biblioteca compartida en el proceso y la retorna. Este método siempre retorna una nueva instancia de la biblioteca.
@end deffn
@end deffn

Estos cargadores prefabricados de bibliotecas están disponibles:


@deffn {Dato} ctypes.cdll

Crea instancias de @ref{a7b,,CDLL}.
@end deffn


@deffn {Dato} ctypes.windll

Sólo Windows: Crea instancias de @ref{177b,,WinDLL}.
@end deffn


@deffn {Dato} ctypes.oledll

Sólo Windows: Crea instancias de @ref{177a,,OleDLL}.
@end deffn


@deffn {Dato} ctypes.pydll

Crea instancias de @ref{177c,,PyDLL}.
@end deffn

Para acceder directamente a la API C de Python, se dispone de un objeto de biblioteca compartida de Python listo-para-usar:


@deffn {Dato} ctypes.pythonapi

An instance of @ref{177c,,PyDLL} that exposes Python C API functions as
attributes.  Note that all these functions are assumed to return C
int, which is of course not always the truth, so you have to assign
the correct @code{restype} attribute to use these functions.
@end deffn


Loading a library through any of these objects raises an
@ref{18c3,,auditing event} @code{ctypes.dlopen} with string argument
@code{name}, the name used to load the library.



Accessing a function on a loaded library raises an auditing event
@code{ctypes.dlsym} with arguments @code{library} (the library object) and @code{name}
(the symbol’s name as a string or integer).


En los casos en los que sólo está disponible el manejador de la biblioteca en lugar del objeto, al acceder a una función se produce un evento de auditoría @code{ctypes.dlsym/handle} con los argumentos @code{handle} (el manejador de la biblioteca en bruto) y @code{name}.

@node Funciones foráneas,Prototipos de funciones,Cargando bibliotecas compartidas,referencia ctypes
@anchor{library/ctypes ctypes-foreign-functions}@anchor{3017}@anchor{library/ctypes foreign-functions}@anchor{3018}
@subsubsection Funciones foráneas


As explained in the previous section, foreign functions can be accessed as
attributes of loaded shared libraries.  The function objects created in this way
by default accept any number of arguments, accept any ctypes data instances as
arguments, and return the default result type specified by the library loader.

They are instances of a private local class @code{_FuncPtr} (not exposed
in @code{ctypes}) which inherits from the private @ref{3019,,_CFuncPtr} class:

@example
>>> import ctypes
>>> lib = ctypes.CDLL(None)
>>> issubclass(lib._FuncPtr, ctypes._CFuncPtr)
True
>>> lib._FuncPtr is ctypes._CFuncPtr
False
@end example

@geindex _CFuncPtr (clase en ctypes)
@anchor{library/ctypes ctypes _CFuncPtr}@anchor{3019}
@deffn {Clase} ctypes._CFuncPtr

Clase base para funciones foráneas C invocables.

Las instancias de funciones foráneas también son tipos de datos compatibles con C; representan punteros de funciones C.

Este comportamiento puede personalizarse asignando a los atributos especiales del objeto de la función foránea.

@geindex restype (atributo de ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr restype}@anchor{2fe5}
@deffn {Atributo} restype

Asigne un tipo ctypes para especificar el tipo de resultado de la función externa. Use @code{None} para void, una función que no retorna nada.

It is possible to assign a callable Python object that is not a ctypes
type, in this case the function is assumed to return a C int, and
the callable will be called with this integer, allowing further
processing or error checking.  Using this is deprecated, for more flexible
post processing or error checking use a ctypes data type as
@code{restype} and assign a callable to the @ref{2fe6,,errcheck} attribute.
@end deffn

@geindex argtypes (atributo de ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr argtypes}@anchor{2fdd}
@deffn {Atributo} argtypes

Asigne una tupla de tipos ctypes para especificar los tipos de argumentos que acepta la función. Las funciones que utilizan la convención de llamada @code{stdcall} sólo pueden ser llamadas con el mismo número de argumentos que la longitud de esta tupla; las funciones que utilizan la convención de llamada C aceptan también argumentos adicionales no especificados.

When a foreign function is called, each actual argument is passed to the
@ref{2fe2,,from_param()} class method of the items in the @ref{2fdd,,argtypes}
tuple, this method allows adapting the actual argument to an object that
the foreign function accepts.  For example, a @ref{16ed,,c_char_p} item in
the @ref{2fdd,,argtypes} tuple will convert a string passed as argument into
a bytes object using ctypes conversion rules.

New: It is now possible to put items in argtypes which are not ctypes
types, but each item must have a @ref{2fe2,,from_param()} method which returns a
value usable as argument (integer, string, ctypes instance).  This allows
defining adapters that can adapt custom objects as function parameters.
@end deffn

@geindex errcheck (atributo de ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr errcheck}@anchor{2fe6}
@deffn {Atributo} errcheck

Asigne una función Python u otra llamada a este atributo. El invocable será llamado con tres o más argumentos:


@deffn {Función} callable (result, func, arguments)

`result' is what the foreign function returns, as specified by the
@code{restype} attribute.

`func' es el propio objeto de la función foránea, lo que permite reutilizar el mismo objeto invocable para comprobar o postprocesar los resultados de varias funciones.

`arguments' es una tupla que contiene los parámetros originalmente pasados a la llamada de la función, esto permite especializar el comportamiento en los argumentos utilizados.
@end deffn

El objeto que retorna esta función será retornado por la llamada de la función foránea, pero también puede comprobar el valor del resultado y hacer una excepción si la llamada de la función foránea ha fallado.
@end deffn
@end deffn

@geindex ArgumentError
@anchor{library/ctypes ctypes ArgumentError}@anchor{301a}
@deffn {Excepción} ctypes.ArgumentError

Esta excepción se lanza cuando una llamada a una función foránea no puede convertir uno de los argumentos pasados.
@end deffn

En Windows, cuando una llamada a una función foránea plantea una excepción de sistema (por ejemplo, debido a una violación de acceso), será capturada y sustituida por una excepción Python adecuada. Además, un evento de auditoría @code{ctypes.set_exception} con el argumento @code{code} será levantado, permitiendo que un gancho de auditoría reemplace la excepción con la suya propia.

Algunas formas de invocar llamadas a funciones foráneas pueden lanzar un evento de auditoría @code{ctypes.call_function} con los argumentos @code{function pointer} y @code{arguments}.

@node Prototipos de funciones,Funciones de utilidad,Funciones foráneas,referencia ctypes
@anchor{library/ctypes ctypes-function-prototypes}@anchor{301b}@anchor{library/ctypes function-prototypes}@anchor{301c}
@subsubsection Prototipos de funciones


Las funciones foráneas también pueden crearse mediante la instanciación de prototipos de funciones. Los prototipos de funciones son similares a los prototipos de funciones en C; describen una función (tipo de retorno, tipos de argumentos, convención de llamada) sin definir una implementación. Las funciones de fábrica deben ser llamadas con el tipo de resultado deseado y los tipos de argumento de la función, y pueden ser usadas como fábricas de decoradores, y como tales, ser aplicadas a las funciones a través de la sintaxis @code{@@wrapper}. Ver @ref{2ffd,,Funciones de retrollamadas (callback)} para ejemplos.

@geindex CFUNCTYPE() (en el módulo ctypes)
@anchor{library/ctypes ctypes CFUNCTYPE}@anchor{2fff}
@deffn {Función} ctypes.CFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

El prototipo de función retornado crea funciones que usan la convención de llamada C estándar. La función liberará el GIL durante la llamada. Si `use_errno' se configura a true, la copia privada de ctypes de la variable del sistema @ref{57,,errno} se intercambia con el valor real @ref{57,,errno} antes y después de la llamada; `use_last_error' hace lo mismo con el código de error de Windows.
@end deffn

@geindex WINFUNCTYPE() (en el módulo ctypes)
@anchor{library/ctypes ctypes WINFUNCTYPE}@anchor{2ffe}
@deffn {Función} ctypes.WINFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

Solo Windows: el prototipo de función retornada crea funciones que utilizan la convención de llamada @code{stdcall}. La función liberará el GIL durante la llamada. `use_errno' y `use_last_error' tienen el mismo significado que el anterior.
@end deffn

@geindex PYFUNCTYPE() (en el módulo ctypes)
@anchor{library/ctypes ctypes PYFUNCTYPE}@anchor{301d}
@deffn {Función} ctypes.PYFUNCTYPE (restype, *argtypes)

El prototipo de función retornado crea funciones que usan la convención de llamadas de Python. La función `no' liberará el GIL durante la llamada.
@end deffn

Los prototipos de funciones creados por estas funciones de fábrica pueden ser instanciados de diferentes maneras, dependiendo del tipo y el número de los parámetros en la llamada:


@deffn {Función} prototype (address)

Retorna una función foránea en la dirección especificada que debe ser un número entero.
@end deffn


@deffn {Función} prototype (callable)

Crear una función de llamada C (una función de retrollamada) a partir de un `callable' Python.
@end deffn


@deffn {Función} prototype (func_spec[, paramflags])

Retorna una función foránea exportada por una biblioteca compartida. `func_spec' debe ser un 2-tupla @code{(name_or_ordinal, library)}. El primer elemento es el nombre de la función exportada como cadena, o el ordinal de la función exportada como entero pequeño. El segundo elemento es la instancia de la biblioteca compartida.
@end deffn


@deffn {Función} prototype (vtbl_index, name[, paramflags[, iid]])

Retorna una función foránea que llamará a un método COM. `vtbl_index' es el índice de la tabla de funciones virtuales, un pequeño entero no negativo. `name' es el nombre del método COM. `iid' es un puntero opcional para el identificador de la interfaz que se utiliza en el informe de errores extendido.

COM methods use a special calling convention: They require a pointer to
the COM interface as first argument, in addition to those parameters that
are specified in the @code{argtypes} tuple.
@end deffn

El parámetro opcional `paramflags' crea envoltorios de funciones foráneas con mucha más funcionalidad que las características descritas anteriormente.

`paramflags' must be a tuple of the same length as @ref{2fdd,,argtypes}.

Cada elemento de esta tupla contiene más información sobre un parámetro, debe ser una tupla que contenga uno, dos o tres elementos.

El primer elemento es un entero que contiene una combinación de flags de dirección para el parámetro:

@quotation


@table @asis

@item 1

Especifica un parámetro de entrada a la función.

@item 2

Parámetro de salida. La función foránea rellena un valor.

@item 4

Parámetro de entrada que por defecto es el cero entero.
@end table
@end quotation

El segundo elemento opcional es el nombre del parámetro como cadena. Si se especifica esto, se puede llamar a la función foránea con parámetros con nombre.

El tercer elemento opcional es el valor por defecto de este parámetro.

The following example demonstrates how to wrap the Windows @code{MessageBoxW} function so
that it supports default parameters and named arguments. The C declaration from
the windows header file is this:

@example
WINUSERAPI int WINAPI
MessageBoxW(
    HWND hWnd,
    LPCWSTR lpText,
    LPCWSTR lpCaption,
    UINT uType);
@end example

Aquí está el envoltorio con @ref{2b,,ctypes}:

@example
>>> from ctypes import c_int, WINFUNCTYPE, windll
>>> from ctypes.wintypes import HWND, LPCWSTR, UINT
>>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT)
>>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0)
>>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)
@end example

La función foránea de @code{MessageBox} puede ser llamada de esta manera:

@example
>>> MessageBox()
>>> MessageBox(text="Spam, spam, spam")
>>> MessageBox(flags=2, text="foo bar")
@end example

Un segundo ejemplo demuestra los parámetros de salida. La función @code{GetWindowRect} de win32 retorna las dimensiones de una ventana especificada copiándolas en la estructura @code{RECT} que la persona que llama tiene que suministrar. Aquí está la declaración C:

@example
WINUSERAPI BOOL WINAPI
GetWindowRect(
     HWND hWnd,
     LPRECT lpRect);
@end example

Aquí está el envoltorio con @ref{2b,,ctypes}:

@example
>>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError
>>> from ctypes.wintypes import BOOL, HWND, RECT
>>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))
>>> paramflags = (1, "hwnd"), (2, "lprect")
>>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)
>>>
@end example

Las funciones con parámetros de salida retornarán automáticamente el valor del parámetro de salida si hay uno solo, o una tupla que contiene los valores del parámetro de salida cuando hay más de uno, por lo que la función GetWindowRect retorna ahora una instancia RECT, cuando se llama.

Output parameters can be combined with the @ref{2fe6,,errcheck} protocol to do
further output processing and error checking.  The win32 @code{GetWindowRect} api
function returns a @code{BOOL} to signal success or failure, so this function could
do the error checking, and raises an exception when the api call failed:

@example
>>> def errcheck(result, func, args):
...     if not result:
...         raise WinError()
...     return args
...
>>> GetWindowRect.errcheck = errcheck
>>>
@end example

If the @ref{2fe6,,errcheck} function returns the argument tuple it receives
unchanged, @ref{2b,,ctypes} continues the normal processing it does on the output
parameters.  If you want to return a tuple of window coordinates instead of a
@code{RECT} instance, you can retrieve the fields in the function and return them
instead, the normal processing will no longer take place:

@example
>>> def errcheck(result, func, args):
...     if not result:
...         raise WinError()
...     rc = args[1]
...     return rc.left, rc.top, rc.bottom, rc.right
...
>>> GetWindowRect.errcheck = errcheck
>>>
@end example

@node Funciones de utilidad,Tipos de datos<3>,Prototipos de funciones,referencia ctypes
@anchor{library/ctypes ctypes-utility-functions}@anchor{301e}@anchor{library/ctypes utility-functions}@anchor{301f}
@subsubsection Funciones de utilidad


@geindex addressof() (en el módulo ctypes)
@anchor{library/ctypes ctypes addressof}@anchor{3020}
@deffn {Función} ctypes.addressof (obj)

Retorna la dirección del buffer de memoria como un entero. `obj' debe ser una instancia de tipo ctypes.

Lanza un @ref{18c3,,auditing event} @code{ctypes.addressof} con el argumento @code{obj}.
@end deffn

@geindex alignment() (en el módulo ctypes)
@anchor{library/ctypes ctypes alignment}@anchor{3021}
@deffn {Función} ctypes.alignment (obj_or_type)

Retorna los requerimientos de alineación de un tipo de ctypes. `obj_or_type' debe ser un tipo o instancia ctypes.
@end deffn

@geindex byref() (en el módulo ctypes)
@anchor{library/ctypes ctypes byref}@anchor{2fe9}
@deffn {Función} ctypes.byref (obj[, offset])

Retorna un puntero ligero a `obj', que debe ser un ejemplo de un tipo de ctypes. `offset' es por defecto cero, y debe ser un entero que se añadirá al valor del puntero interno.

@code{byref(obj, offset)} corresponde a este código C:

@example
(((char *)&obj) + offset)
@end example

El objeto retornado sólo puede ser utilizado como un parámetro de llamada de función foránea. Se comporta de manera similar a @code{pointer(obj)}, pero la construcción es mucho más rápida.
@end deffn

@geindex cast() (en el módulo ctypes)
@anchor{library/ctypes ctypes cast}@anchor{2ff9}
@deffn {Función} ctypes.cast (obj, type)

Esta función es similar a la del operador de reparto en C. retorna una nueva instancia de `type' que apunta al mismo bloque de memoria que `obj'. `type' debe ser un tipo de puntero, y `obj' debe ser un objeto que pueda ser interpretado como un puntero.
@end deffn

@geindex create_string_buffer() (en el módulo ctypes)
@anchor{library/ctypes ctypes create_string_buffer}@anchor{2fd8}
@deffn {Función} ctypes.create_string_buffer (init_or_size, size=None)

Esta función crea un búfer de caracteres mutables. El objeto retornado es un arreglo de ctypes de @ref{2fce,,c_char}.

`init_or_size' debe ser un número entero que especifique el tamaño del arreglo, o un objeto de bytes que se utilizará para inicializar los elementos del arreglo.

Si se especifica un objeto bytes como primer argumento, el buffer se hace un elemento más grande que su longitud, de modo que el último elemento del arreglo es un carácter de terminación NUL. Se puede pasar un entero como segundo argumento que permite especificar el tamaño del arreglo si no se debe utilizar la longitud de los bytes.

Lanza un @ref{18c3,,auditing event} @code{ctypes.create_string_buffer} con argumentos @code{init}, @code{size}.
@end deffn

@geindex create_unicode_buffer() (en el módulo ctypes)
@anchor{library/ctypes ctypes create_unicode_buffer}@anchor{19d8}
@deffn {Función} ctypes.create_unicode_buffer (init_or_size, size=None)

Esta función crea un búfer de caracteres unicode mutable. El objeto retornado es un arreglo de ctypes de @ref{2fcf,,c_wchar}.

`init_or_size' debe ser un entero que especifique el tamaño del arreglo, o una cadena que se utilizará para inicializar los elementos del arreglo.

Si se especifica una cadena como primer argumento, el búfer se hace un elemento más grande que la longitud de la cadena, de modo que el último elemento del arreglo es un carácter de terminación NUL. Se puede pasar un entero como segundo argumento que permite especificar el tamaño del arreglo si no se debe utilizar la longitud de la cadena.

Lanza un @ref{18c3,,auditing event} @code{ctypes.create_unicode_buffer} con argumentos @code{init}, @code{size}.
@end deffn

@geindex DllCanUnloadNow() (en el módulo ctypes)
@anchor{library/ctypes ctypes DllCanUnloadNow}@anchor{3022}
@deffn {Función} ctypes.DllCanUnloadNow ()

Sólo Windows: Esta función es un gancho que permite implementar servidores COM en proceso con ctypes. Se llama desde la función DllCanUnloadNow que la extensión _ctypes dll exporta.
@end deffn

@geindex DllGetClassObject() (en el módulo ctypes)
@anchor{library/ctypes ctypes DllGetClassObject}@anchor{3023}
@deffn {Función} ctypes.DllGetClassObject ()

Sólo Windows: Esta función es un gancho que permite implementar servidores COM en proceso con ctypes. Se llama desde la función DllGetClassObject que la extensión @code{_ctypes} exporta.
@end deffn

@geindex find_library() (en el módulo ctypes.util)
@anchor{library/ctypes ctypes util find_library}@anchor{dd0}
@deffn {Función} ctypes.util.find_library (name)

Intenta encontrar una biblioteca y retornar un nombre de ruta. `name' es el nombre de la biblioteca sin ningún prefijo como @code{lib}, sufijo como @code{.so}, @code{.dylib} o número de versión (esta es la forma usada para la opción del enlazador posix @code{-l}). Si no se puede encontrar ninguna biblioteca, retorna @code{None}.

La funcionalidad exacta depende del sistema.
@end deffn

@geindex find_msvcrt() (en el módulo ctypes.util)
@anchor{library/ctypes ctypes util find_msvcrt}@anchor{3024}
@deffn {Función} ctypes.util.find_msvcrt ()

Sólo Windows: retorna el nombre de archivo de la biblioteca de tiempo de ejecución de VC usada por Python, y por los módulos de extensión. Si no se puede determinar el nombre de la biblioteca, se retorna @code{None}.

Si necesita liberar memoria, por ejemplo, asignada por un módulo de extensión con una llamada al @code{free(void *)}, es importante que utilice la función en la misma biblioteca que asignó la memoria.
@end deffn

@geindex FormatError() (en el módulo ctypes)
@anchor{library/ctypes ctypes FormatError}@anchor{3025}
@deffn {Función} ctypes.FormatError ([code])

Sólo Windows: retorna una descripción textual del código de error `code'. Si no se especifica ningún código de error, se utiliza el último código de error llamando a la función de api de Windows GetLastError.
@end deffn

@geindex GetLastError() (en el módulo ctypes)
@anchor{library/ctypes ctypes GetLastError}@anchor{3011}
@deffn {Función} ctypes.GetLastError ()

Solo Windows: retorna el último código de error establecido por Windows en el hilo de llamada. Esta función llama directamente a la función @code{GetLastError()} de Windows, no retorna la copia privada ctypes del código de error.
@end deffn

@geindex get_errno() (en el módulo ctypes)
@anchor{library/ctypes ctypes get_errno}@anchor{300f}
@deffn {Función} ctypes.get_errno ()

Retorna el valor actual de la copia ctypes-private de la variable de sistema @ref{57,,errno} en el hilo de llamada.

Lanza un @ref{18c3,,auditing event} @code{ctypes.get_errno} sin argumentos.
@end deffn

@geindex get_last_error() (en el módulo ctypes)
@anchor{library/ctypes ctypes get_last_error}@anchor{3012}
@deffn {Función} ctypes.get_last_error ()

Windows only: returns the current value of the ctypes-private copy of the system
@code{LastError} variable in the calling thread.

Lanza un @ref{18c3,,auditing event} @code{ctypes.get_last_error} sin argumentos.
@end deffn

@geindex memmove() (en el módulo ctypes)
@anchor{library/ctypes ctypes memmove}@anchor{3026}
@deffn {Función} ctypes.memmove (dst, src, count)

Igual que la función de la biblioteca estándar  de C `memmove': copia `count' bytes de `src' a `dst'. `dst' y `src' deben ser enteros o instancias ctypes que pueden ser convertidos en punteros.
@end deffn

@geindex memset() (en el módulo ctypes)
@anchor{library/ctypes ctypes memset}@anchor{3027}
@deffn {Función} ctypes.memset (dst, c, count)

Igual que la función de la biblioteca estándar de C `memset' C: llena el bloque de memoria en la dirección `dst' con `count' bytes de valor `c'. `dst' debe ser un número entero que especifique una dirección, o una instancia ctypes.
@end deffn

@geindex POINTER() (en el módulo ctypes)
@anchor{library/ctypes ctypes POINTER}@anchor{16ec}
@deffn {Función} ctypes.POINTER (type, /)

Create and return a new ctypes pointer type. Pointer types are cached and
reused internally, so calling this function repeatedly is cheap.
`type' must be a ctypes type.
@end deffn

@geindex pointer() (en el módulo ctypes)
@anchor{library/ctypes ctypes pointer}@anchor{16eb}
@deffn {Función} ctypes.pointer (obj, /)

Create a new pointer instance, pointing to `obj'.
The returned object is of the type @code{POINTER(type(obj))}.

Nota: Si sólo quieres pasar un puntero a un objeto a una llamada de función foránea, deberías usar @code{byref(obj)} que es mucho más rápido.
@end deffn

@geindex resize() (en el módulo ctypes)
@anchor{library/ctypes ctypes resize}@anchor{3008}
@deffn {Función} ctypes.resize (obj, size)

Esta función redimensiona el búfer de memoria interna de `obj', que debe ser una instancia de tipo ctypes. No es posible hacer el buffer más pequeño que el tamaño nativo del tipo de objetos, como lo indica @code{size of (type(obj))}, pero es posible agrandar el buffer.
@end deffn

@geindex set_errno() (en el módulo ctypes)
@anchor{library/ctypes ctypes set_errno}@anchor{3010}
@deffn {Función} ctypes.set_errno (value)

Poner el valor actual de la copia ctypes-private de la variable del sistema @ref{57,,errno} en el hilo de llamada a `valor' y retornar el valor anterior.

Lanza un @ref{18c3,,auditing event} @code{ctypes.set_errno} con argumento @code{errno}.
@end deffn

@geindex set_last_error() (en el módulo ctypes)
@anchor{library/ctypes ctypes set_last_error}@anchor{3013}
@deffn {Función} ctypes.set_last_error (value)

Windows only: set the current value of the ctypes-private copy of the system
@code{LastError} variable in the calling thread to `value' and return the
previous value.

Lanza un @ref{18c3,,auditing event} @code{ctypes.set_last_error} con argumento @code{error}.
@end deffn

@geindex sizeof() (en el módulo ctypes)
@anchor{library/ctypes ctypes sizeof}@anchor{3028}
@deffn {Función} ctypes.sizeof (obj_or_type)

Retorna el tamaño en bytes de un buffer de memoria tipo ctypes o instancia. Hace lo mismo que el operador C @code{sizeof}.
@end deffn

@geindex string_at() (en el módulo ctypes)
@anchor{library/ctypes ctypes string_at}@anchor{3029}
@deffn {Función} ctypes.string_at (ptr, size=-1)

Return the byte string at `void *ptr'.
If `size' is specified, it is used as size, otherwise the string is assumed
to be zero-terminated.

Raises an @ref{18c3,,auditing event} @code{ctypes.string_at} with arguments @code{ptr}, @code{size}.
@end deffn

@geindex WinError() (en el módulo ctypes)
@anchor{library/ctypes ctypes WinError}@anchor{302a}
@deffn {Función} ctypes.WinError (code=None, descr=None)

Windows only: this function is probably the worst-named thing in ctypes. It
creates an instance of @ref{4d5,,OSError}.  If `code' is not specified,
@code{GetLastError} is called to determine the error code. If `descr' is not
specified, @ref{3025,,FormatError()} is called to get a textual description of the
error.


Distinto en la versión 3.3: An instance of @ref{10d0,,WindowsError} used to be created, which is now an
alias of @ref{4d5,,OSError}.

@end deffn

@geindex wstring_at() (en el módulo ctypes)
@anchor{library/ctypes ctypes wstring_at}@anchor{302b}
@deffn {Función} ctypes.wstring_at (ptr, size=-1)

Return the wide-character string at `void *ptr'.
If `size' is specified, it is used as the number of
characters of the string, otherwise the string is assumed to be
zero-terminated.

Raises an @ref{18c3,,auditing event} @code{ctypes.wstring_at} with arguments @code{ptr}, @code{size}.
@end deffn

@node Tipos de datos<3>,Tipos de datos fundamentales<2>,Funciones de utilidad,referencia ctypes
@anchor{library/ctypes ctypes-data-types}@anchor{302c}@anchor{library/ctypes data-types}@anchor{302d}
@subsubsection Tipos de datos


@geindex _CData (clase en ctypes)
@anchor{library/ctypes ctypes _CData}@anchor{302e}
@deffn {Clase} ctypes._CData

Esta clase no pública es la clase de base común de todos los tipos de datos de los ctypes. Entre otras cosas, todas las instancias de tipo ctypes contienen un bloque de memoria que contiene datos compatibles con C; la dirección del bloque de memoria es retornada por la función de ayuda @ref{3020,,addressof()}. Otra variable de instancia se expone como @code{_objetos}; ésta contiene otros objetos de Python que deben mantenerse vivos en caso de que el bloque de memoria contenga punteros.

Métodos comunes de tipos de datos ctypes, estos son todos métodos de clase (para ser exactos, son métodos del @ref{1f86,,metaclass}):

@geindex from_buffer() (método de ctypes._CData)
@anchor{library/ctypes ctypes _CData from_buffer}@anchor{302f}
@deffn {Método} from_buffer (source[, offset])

Este método retorna una instancia ctypes que comparte el buffer del objeto `source'. El objeto `source' debe soportar la interfaz del buffer de escritura. El parámetro opcional `offset' especifica un offset en el buffer de la fuente en bytes; el valor por defecto es cero. Si el buffer de la fuente no es lo suficientemente grande se lanza un @ref{360,,ValueError}.

Lanza un @ref{18c3,,auditing event} @code{ctypes.cdata/buffer} con argumentos @code{pointer}, @code{size}, @code{offset}.
@end deffn

@geindex from_buffer_copy() (método de ctypes._CData)
@anchor{library/ctypes ctypes _CData from_buffer_copy}@anchor{3030}
@deffn {Método} from_buffer_copy (source[, offset])

Este método crea una instancia ctypes, copiando el buffer del buffer de objetos `source' que debe ser legible. El parámetro opcional `offset' especifica un offset en el buffer de origen en bytes; el valor por defecto es cero. Si el buffer de fuente no es lo suficientemente grande se lanza un @ref{360,,ValueError}.

Lanza un @ref{18c3,,auditing event} @code{ctypes.cdata/buffer} con argumentos @code{pointer}, @code{size}, @code{offset}.
@end deffn

@geindex from_address() (método de ctypes._CData)
@anchor{library/ctypes ctypes _CData from_address}@anchor{3031}
@deffn {Método} from_address (address)

Este método retorna una instancia de tipo ctypes utilizando la memoria especificada por `address' que debe ser un entero.

Este método, y otros que indirectamente llaman a este método, lanzan un @ref{18c3,,auditing event} @code{ctypes.cdata} con argumento @code{address}.
@end deffn

@geindex from_param() (método de ctypes._CData)
@anchor{library/ctypes ctypes _CData from_param}@anchor{2fe2}
@deffn {Método} from_param (obj)

This method adapts `obj' to a ctypes type.  It is called with the actual
object used in a foreign function call when the type is present in the
foreign function’s @ref{2fdd,,argtypes} tuple;
it must return an object that can be used as a function call parameter.

Todos los tipos de datos ctypes tienen una implementación por defecto de este método de clase que normalmente retorna `obj' si es una instancia del tipo. Algunos tipos aceptan también otros objetos.
@end deffn

@geindex in_dll() (método de ctypes._CData)
@anchor{library/ctypes ctypes _CData in_dll}@anchor{3002}
@deffn {Método} in_dll (library, name)

Este método retorna una instancia de tipo ctypes exportada por una biblioteca compartida. `name' es el nombre del símbolo que exporta los datos, `library' es la biblioteca compartida cargada.
@end deffn

Variables de instancia común de los tipos de datos de ctypes:

@geindex _b_base_ (atributo de ctypes._CData)
@anchor{library/ctypes ctypes _CData _b_base_}@anchor{3032}
@deffn {Atributo} _b_base_

A veces, las instancias de datos ctypes no poseen el bloque de memoria que contienen, sino que comparten parte del bloque de memoria de un objeto base. El miembro de sólo lectura @ref{3032,,_b_base_} es el objeto raíz ctypes que posee el bloque de memoria.
@end deffn

@geindex _b_needsfree_ (atributo de ctypes._CData)
@anchor{library/ctypes ctypes _CData _b_needsfree_}@anchor{3033}
@deffn {Atributo} _b_needsfree_

Esta variable de sólo lectura es verdadera cuando la instancia de datos ctypes ha sido asignada a el propio bloque de memoria, falsa en caso contrario.
@end deffn

@geindex _objects (atributo de ctypes._CData)
@anchor{library/ctypes ctypes _CData _objects}@anchor{3034}
@deffn {Atributo} _objects

Este miembro es @code{None} o un diccionario que contiene objetos de Python que deben mantenerse vivos para que el contenido del bloque de memoria sea válido. Este objeto sólo se expone para su depuración; nunca modifique el contenido de este diccionario.
@end deffn
@end deffn

@node Tipos de datos fundamentales<2>,Tipos de datos estructurados,Tipos de datos<3>,referencia ctypes
@anchor{library/ctypes ctypes-fundamental-data-types-2}@anchor{3035}@anchor{library/ctypes id1}@anchor{3036}
@subsubsection Tipos de datos fundamentales


@geindex _SimpleCData (clase en ctypes)
@anchor{library/ctypes ctypes _SimpleCData}@anchor{3037}
@deffn {Clase} ctypes._SimpleCData

Esta clase no pública es la clase base de todos los tipos de datos de ctypes fundamentales. Se menciona aquí porque contiene los atributos comunes de los tipos de datos de ctypes fundamentales. @ref{3037,,_SimpleCData} es una subclase de @ref{302e,,_CData}, por lo que hereda sus métodos y atributos. Los tipos de datos ctypes que no son y no contienen punteros ahora pueden ser archivados.

Los instancias tienen un solo atributo:

@geindex value (atributo de ctypes._SimpleCData)
@anchor{library/ctypes ctypes _SimpleCData value}@anchor{3038}
@deffn {Atributo} value

Este atributo contiene el valor real de la instancia. Para los tipos enteros y punteros, es un entero, para los tipos de caracteres, es un objeto o cadena de bytes de un solo carácter, para los tipos de punteros de caracteres es un objeto o cadena de bytes de Python.

Cuando el atributo @code{value} se recupera de una instancia ctypes, normalmente se retorna un nuevo objeto cada vez. @ref{2b,,ctypes} `no' implementa el retorno del objeto original, siempre se construye un nuevo objeto. Lo mismo ocurre con todas las demás instancias de objetos ctypes.
@end deffn
@end deffn

Fundamental data types, when returned as foreign function call results, or, for
example, by retrieving structure field members or array items, are transparently
converted to native Python types.  In other words, if a foreign function has a
@ref{2fe5,,restype} of @ref{16ed,,c_char_p}, you will always receive a Python bytes
object, `not' a @ref{16ed,,c_char_p} instance.

@c XXX above is false, it actually returns a Unicode string

Subclasses of fundamental data types do `not' inherit this behavior. So, if a
foreign functions @code{restype} is a subclass of @ref{16ef,,c_void_p}, you will
receive an instance of this subclass from the function call. Of course, you can
get the value of the pointer by accessing the @code{value} attribute.

Estos son los tipos de datos fundamentales de ctypes:

@geindex c_byte (clase en ctypes)
@anchor{library/ctypes ctypes c_byte}@anchor{1778}
@deffn {Clase} ctypes.c_byte

Representa el tipo de datos C signed char e interpreta el valor como un entero pequeño. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_char (clase en ctypes)
@anchor{library/ctypes ctypes c_char}@anchor{2fce}
@deffn {Clase} ctypes.c_char

Representa el tipo de datos C char e interpreta el valor como un solo carácter. El constructor acepta un inicializador de cadena opcional, la longitud de la cadena debe ser exactamente un carácter.
@end deffn

@geindex c_char_p (clase en ctypes)
@anchor{library/ctypes ctypes c_char_p}@anchor{16ed}
@deffn {Clase} ctypes.c_char_p

Representa el tipo de datos C char* cuando apunta a una cadena terminada en cero. Para un puntero de carácter general que también puede apuntar a datos binarios, se debe usar @code{POINTER(c_char)}. El constructor acepta una dirección entera o un objeto de bytes.
@end deffn

@geindex c_double (clase en ctypes)
@anchor{library/ctypes ctypes c_double}@anchor{1903}
@deffn {Clase} ctypes.c_double

Representa el tipo de datos C double. El constructor acepta un inicializador flotante opcional.
@end deffn

@geindex c_longdouble (clase en ctypes)
@anchor{library/ctypes ctypes c_longdouble}@anchor{1904}
@deffn {Clase} ctypes.c_longdouble

Representa el tipo de datos C long double. El constructor acepta un inicializador flotante opcional. En plataformas donde @code{sizeof(long double) == sizeof(double)} es un alias de @ref{1903,,c_double}.
@end deffn

@geindex c_float (clase en ctypes)
@anchor{library/ctypes ctypes c_float}@anchor{2fd7}
@deffn {Clase} ctypes.c_float

Representa el tipo de datos C float. El constructor acepta un inicializador flotante opcional.
@end deffn

@geindex c_double_complex (clase en ctypes)
@anchor{library/ctypes ctypes c_double_complex}@anchor{15e6}
@deffn {Clase} ctypes.c_double_complex

Represents the C double complex datatype, if available.  The
constructor accepts an optional @ref{154,,complex} initializer.


Added in version 3.14.

@end deffn

@geindex c_float_complex (clase en ctypes)
@anchor{library/ctypes ctypes c_float_complex}@anchor{15e5}
@deffn {Clase} ctypes.c_float_complex

Represents the C float complex datatype, if available.  The
constructor accepts an optional @ref{154,,complex} initializer.


Added in version 3.14.

@end deffn

@geindex c_longdouble_complex (clase en ctypes)
@anchor{library/ctypes ctypes c_longdouble_complex}@anchor{15e7}
@deffn {Clase} ctypes.c_longdouble_complex

Represents the C long double complex datatype, if available.  The
constructor accepts an optional @ref{154,,complex} initializer.


Added in version 3.14.

@end deffn

@geindex c_int (clase en ctypes)
@anchor{library/ctypes ctypes c_int}@anchor{2fc2}
@deffn {Clase} ctypes.c_int

Representa el tipo de datos C signed int. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento. En plataformas donde @code{sizeof(int) == sizeof(long)} es un alias de @ref{2fc3,,c_long}.
@end deffn

@geindex c_int8 (clase en ctypes)
@anchor{library/ctypes ctypes c_int8}@anchor{3039}
@deffn {Clase} ctypes.c_int8

Representa el tipo de datos signed int de C de 8 bits. Por lo general, un alias para @ref{1778,,c_byte}.
@end deffn

@geindex c_int16 (clase en ctypes)
@anchor{library/ctypes ctypes c_int16}@anchor{303a}
@deffn {Clase} ctypes.c_int16

Representa el tipo de datos signed int de C de 16 bits. Por lo general, un alias para @ref{2fd0,,c_short}.
@end deffn

@geindex c_int32 (clase en ctypes)
@anchor{library/ctypes ctypes c_int32}@anchor{303b}
@deffn {Clase} ctypes.c_int32

Representa el tipo de datos signed int de C de 32 bits. Por lo general, un alias para @ref{2fc2,,c_int}.
@end deffn

@geindex c_int64 (clase en ctypes)
@anchor{library/ctypes ctypes c_int64}@anchor{303c}
@deffn {Clase} ctypes.c_int64

Representa el tipo de datos signed int de C de 64 bits. Por lo general, un alias para @ref{2fd4,,c_longlong}.
@end deffn

@geindex c_long (clase en ctypes)
@anchor{library/ctypes ctypes c_long}@anchor{2fc3}
@deffn {Clase} ctypes.c_long

Representa el tipo de datos C signed long. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_longlong (clase en ctypes)
@anchor{library/ctypes ctypes c_longlong}@anchor{2fd4}
@deffn {Clase} ctypes.c_longlong

Representa el tipo de datos C signed long long. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_short (clase en ctypes)
@anchor{library/ctypes ctypes c_short}@anchor{2fd0}
@deffn {Clase} ctypes.c_short

Representa el tipo de datos C signed short. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_size_t (clase en ctypes)
@anchor{library/ctypes ctypes c_size_t}@anchor{2fd6}
@deffn {Clase} ctypes.c_size_t

Representa el tipo de datos C @code{size_t}.
@end deffn

@geindex c_ssize_t (clase en ctypes)
@anchor{library/ctypes ctypes c_ssize_t}@anchor{12a9}
@deffn {Clase} ctypes.c_ssize_t

Representa el tipo de datos C @code{ssize_t}.


Added in version 3.2.

@end deffn

@geindex c_time_t (clase en ctypes)
@anchor{library/ctypes ctypes c_time_t}@anchor{17e0}
@deffn {Clase} ctypes.c_time_t

Represents the C @code{time_t} datatype.


Added in version 3.12.

@end deffn

@geindex c_ubyte (clase en ctypes)
@anchor{library/ctypes ctypes c_ubyte}@anchor{1779}
@deffn {Clase} ctypes.c_ubyte

Representa el tipo de datos C unsigned char, interpreta el valor como un entero pequeño. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_uint (clase en ctypes)
@anchor{library/ctypes ctypes c_uint}@anchor{2fd2}
@deffn {Clase} ctypes.c_uint

Representa el tipo de datos C unsigned int. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento. En plataformas donde @code{sizeof(int) == sizeof(long)} es un alias para @ref{2fd3,,c_ulong}.
@end deffn

@geindex c_uint8 (clase en ctypes)
@anchor{library/ctypes ctypes c_uint8}@anchor{303d}
@deffn {Clase} ctypes.c_uint8

Representa el tipo de datos unsigned int de C de 8 bits. Por lo general, un alias para @ref{1779,,c_ubyte}.
@end deffn

@geindex c_uint16 (clase en ctypes)
@anchor{library/ctypes ctypes c_uint16}@anchor{303e}
@deffn {Clase} ctypes.c_uint16

Representa el tipo de datos unsigned int de C de 16 bits. Por lo general, un alias para @ref{2fd1,,c_ushort}.
@end deffn

@geindex c_uint32 (clase en ctypes)
@anchor{library/ctypes ctypes c_uint32}@anchor{303f}
@deffn {Clase} ctypes.c_uint32

Representa el tipo de datos unsigned int de C de 32 bits. Por lo general, un alias para @ref{2fd2,,c_uint}.
@end deffn

@geindex c_uint64 (clase en ctypes)
@anchor{library/ctypes ctypes c_uint64}@anchor{3040}
@deffn {Clase} ctypes.c_uint64

Representa el tipo de datos unsigned int de C de 64 bits. Por lo general, un alias para @ref{2fd5,,c_ulonglong}.
@end deffn

@geindex c_ulong (clase en ctypes)
@anchor{library/ctypes ctypes c_ulong}@anchor{2fd3}
@deffn {Clase} ctypes.c_ulong

Representa el tipo de datos C unsigned long. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_ulonglong (clase en ctypes)
@anchor{library/ctypes ctypes c_ulonglong}@anchor{2fd5}
@deffn {Clase} ctypes.c_ulonglong

Representa el tipo de datos C unsigned long long. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_ushort (clase en ctypes)
@anchor{library/ctypes ctypes c_ushort}@anchor{2fd1}
@deffn {Clase} ctypes.c_ushort

Representa el tipo de datos C unsigned short. El constructor acepta un inicializador entero opcional; no se realiza ninguna comprobación de desbordamiento.
@end deffn

@geindex c_void_p (clase en ctypes)
@anchor{library/ctypes ctypes c_void_p}@anchor{16ef}
@deffn {Clase} ctypes.c_void_p

Representa el tipo C void*. El valor se representa como un número entero. El constructor acepta un inicializador entero opcional.
@end deffn

@geindex c_wchar (clase en ctypes)
@anchor{library/ctypes ctypes c_wchar}@anchor{2fcf}
@deffn {Clase} ctypes.c_wchar

Represents the C @code{wchar_t} datatype, and interprets the value as a
single character unicode string.  The constructor accepts an optional string
initializer, the length of the string must be exactly one character.
@end deffn

@geindex c_wchar_p (clase en ctypes)
@anchor{library/ctypes ctypes c_wchar_p}@anchor{16ee}
@deffn {Clase} ctypes.c_wchar_p

Representa el tipo de datos C wchar_t*, que debe ser un puntero a una cadena de caracteres anchos terminada en cero. El constructor acepta una dirección entera o una cadena.
@end deffn

@geindex c_bool (clase en ctypes)
@anchor{library/ctypes ctypes c_bool}@anchor{2fcd}
@deffn {Clase} ctypes.c_bool

Representa el tipo de dato C bool (más precisamente, _Bool de C99). Su valor puede ser @code{True} o @code{False}, y el constructor acepta cualquier objeto que tenga un valor de verdad.
@end deffn

@geindex HRESULT (clase en ctypes)
@anchor{library/ctypes ctypes HRESULT}@anchor{3041}
@deffn {Clase} ctypes.HRESULT

Windows only: Represents a @code{HRESULT} value, which contains success or
error information for a function or method call.
@end deffn

@geindex py_object (clase en ctypes)
@anchor{library/ctypes ctypes py_object}@anchor{1477}
@deffn {Clase} ctypes.py_object

Representa el tipo de dato de C @ref{42d,,PyObject}*.  Llamar esto sin un argumento crea un puntero @ref{42d,,PyObject}* @code{NULL}.
@end deffn

The @code{ctypes.wintypes} module provides quite some other Windows specific
data types, for example @code{HWND}, @code{WPARAM}, or @code{DWORD}.
Some useful structures like @code{MSG} or @code{RECT} are also defined.

@node Tipos de datos estructurados,Arreglos y punteros,Tipos de datos fundamentales<2>,referencia ctypes
@anchor{library/ctypes ctypes-structured-data-types}@anchor{3042}@anchor{library/ctypes structured-data-types}@anchor{3043}
@subsubsection Tipos de datos estructurados


@geindex Union (clase en ctypes)
@anchor{library/ctypes ctypes Union}@anchor{167}
@deffn {Clase} ctypes.Union (*args, **kw)

Clase base abstracta para uniones en orden de bytes nativos.

Unions share common attributes and behavior with structures;
see @ref{166,,Structure} documentation for details.
@end deffn

@geindex BigEndianUnion (clase en ctypes)
@anchor{library/ctypes ctypes BigEndianUnion}@anchor{182d}
@deffn {Clase} ctypes.BigEndianUnion (*args, **kw)

Clase base abstracta para uniones en orden de bytes `big endian'.


Added in version 3.11.

@end deffn

@geindex LittleEndianUnion (clase en ctypes)
@anchor{library/ctypes ctypes LittleEndianUnion}@anchor{182e}
@deffn {Clase} ctypes.LittleEndianUnion (*args, **kw)

Clase base abstracta para uniones en orden de bytes `little endian'.


Added in version 3.11.

@end deffn

@geindex BigEndianStructure (clase en ctypes)
@anchor{library/ctypes ctypes BigEndianStructure}@anchor{2fef}
@deffn {Clase} ctypes.BigEndianStructure (*args, **kw)

Clase base abstracta para estructuras en orden de bytes `big endian'.
@end deffn

@geindex LittleEndianStructure (clase en ctypes)
@anchor{library/ctypes ctypes LittleEndianStructure}@anchor{2ff0}
@deffn {Clase} ctypes.LittleEndianStructure (*args, **kw)

Clase base abstracta para estructuras en orden de bytes `little endian'.
@end deffn

Las estructuras y uniones con un orden de bytes no nativo no pueden contener campos de tipo puntero ni ningún otro tipo de datos que contenga campos de tipo puntero.

@geindex Structure (clase en ctypes)
@anchor{library/ctypes ctypes Structure}@anchor{166}
@deffn {Clase} ctypes.Structure (*args, **kw)

Clase base abstracta para estructuras en orden de bytes `native'.

La estructura concreta y los tipos de unión deben crearse subclasificando uno de estos tipos, y al menos definir una variable de clase @ref{15cb,,_fields_}. @ref{2b,,ctypes} creará @ref{1f70,,descriptor}s que permitan leer y escribir los campos por accesos directos de atributos. Estos son los

@geindex _fields_ (atributo de ctypes.Structure)
@anchor{library/ctypes ctypes Structure _fields_}@anchor{15cb}
@deffn {Atributo} _fields_

Una secuencia que define los campos de estructura. Los elementos deben ser de 2 o 3 tuplas. El primer ítem es el nombre del campo, el segundo ítem especifica el tipo de campo; puede ser cualquier tipo de datos ctypes.

Para los campos de tipo entero como @ref{2fc2,,c_int}, se puede dar un tercer elemento opcional. Debe ser un pequeño entero positivo que defina el ancho de bit del campo.

Los nombres de los campos deben ser únicos dentro de una estructura o unión. Esto no se comprueba, sólo se puede acceder a un campo cuando los nombres se repiten.

Es posible definir la variable de clase @ref{15cb,,_fields_} `después' de la sentencia de clase que define la subclase Estructura, esto permite crear tipos de datos que se refieren directa o indirectamente a sí mismos:

@example
class List(Structure):
    pass
List._fields_ = [("pnext", POINTER(List)),
                 ...
                ]
@end example

The @code{_fields_} class variable can only be set once.
Later assignments will raise an @ref{441,,AttributeError}.

Additionally, the @code{_fields_} class variable must be defined before
the structure or union type is first used: an instance or subclass is
created, @ref{3028,,sizeof()} is called on it, and so on.
Later assignments to @code{_fields_} will raise an @ref{441,,AttributeError}.
If @code{_fields_} has not been set before such use,
the structure or union will have no own fields, as if @code{_fields_}
was empty.

Sub-subclasses of structure types inherit the fields of the base class
plus the @ref{15cb,,_fields_} defined in the sub-subclass, if any.
@end deffn

@geindex _pack_ (atributo de ctypes.Structure)
@anchor{library/ctypes ctypes Structure _pack_}@anchor{2fee}
@deffn {Atributo} _pack_

An optional small integer that allows overriding the alignment of
structure fields in the instance.  @ref{2fee,,_pack_} must already be defined
when @ref{15cb,,_fields_} is assigned, otherwise it will have no effect.
Setting this attribute to 0 is the same as not setting it at all.
@end deffn

@geindex _align_ (atributo de ctypes.Structure)
@anchor{library/ctypes ctypes Structure _align_}@anchor{337}
@deffn {Atributo} _align_

An optional small integer that allows overriding the alignment of
the structure when being packed or unpacked to/from memory.
Setting this attribute to 0 is the same as not setting it at all.


Added in version 3.13.

@end deffn

@geindex _layout_ (atributo de ctypes.Structure)
@anchor{library/ctypes ctypes Structure _layout_}@anchor{168}
@deffn {Atributo} _layout_

An optional string naming the struct/union layout. It can currently
be set to:


@itemize -

@item 
@code{"ms"}: the layout used by the Microsoft compiler (MSVC).
On GCC and Clang, this layout can be selected with
@code{__attribute__((ms_struct))}.

@item 
@code{"gcc-sysv"}: the layout used by GCC with the System V or “SysV-like”
data model, as used on Linux and macOS.
With this layout, @ref{2fee,,_pack_} must be unset or zero.
@end itemize

If not set explicitly, @code{ctypes} will use a default that
matches the platform conventions. This default may change in future
Python releases (for example, when a new platform gains official support,
or when a difference between similar platforms is found).
Currently the default will be:


@itemize -

@item 
On Windows: @code{"ms"}

@item 
When @ref{2fee,,_pack_} is specified: @code{"ms"}

@item 
Otherwise: @code{"gcc-sysv"}
@end itemize

@code{_layout_} must already be defined when
@ref{15cb,,_fields_} is assigned, otherwise it will have no effect.
@end deffn

@geindex _anonymous_ (atributo de ctypes.Structure)
@anchor{library/ctypes ctypes Structure _anonymous_}@anchor{3044}
@deffn {Atributo} _anonymous_

Una secuencia opcional que enumera los nombres de los campos sin nombre (anónimos). @ref{3044,,_anonymous_} debe estar ya definida cuando se asigna @ref{15cb,,_fields_}, de lo contrario no tendrá ningún efecto.

Los campos listados en esta variable deben ser campos de tipo estructura o unión. @ref{2b,,ctypes} creará descriptores en el tipo de estructura que permitan acceder a los campos anidados directamente, sin necesidad de crear el campo de estructura o unión.

Aquí hay un tipo de ejemplo (Windows):

@example
class _U(Union):
    _fields_ = [("lptdesc", POINTER(TYPEDESC)),
                ("lpadesc", POINTER(ARRAYDESC)),
                ("hreftype", HREFTYPE)]

class TYPEDESC(Structure):
    _anonymous_ = ("u",)
    _fields_ = [("u", _U),
                ("vt", VARTYPE)]
@end example

La estructura @code{TYPEDESC} describe un tipo de datos COM, el campo @code{vt} especifica cuál de los campos de unión es válido. Como el campo @code{u} está definido como campo anónimo, ahora es posible acceder a los miembros directamente desde la instancia TYPEDESC. @code{td.lptdesc} y @code{td.u.lptdesc} son equivalentes, pero el primero es más rápido ya que no necesita crear una instancia de unión temporal:

@example
td = TYPEDESC()
td.vt = VT_PTR
td.lptdesc = POINTER(some_type)
td.u.lptdesc = POINTER(some_type)
@end example
@end deffn

Es posible definir subclases de estructuras, que heredan los campos de la clase base. Si la definición de la subclase tiene una variable @ref{15cb,,_fields_} separada, los campos especificados en ella se añaden a los campos de la clase base.

Los constructores de estructuras y uniones aceptan tanto argumentos posicionales como de palabras clave. Los argumentos posicionales se usan para inicializar los campos de los miembros en el mismo orden en que aparecen en @ref{15cb,,_fields_}. Los argumentos de palabras clave en el constructor se interpretan como asignaciones de atributos, por lo que inicializarán @ref{15cb,,_fields_} con el mismo nombre, o crearán nuevos atributos para nombres no presentes en @ref{15cb,,_fields_}.
@end deffn

@node Arreglos y punteros,,Tipos de datos estructurados,referencia ctypes
@anchor{library/ctypes arrays-and-pointers}@anchor{3045}@anchor{library/ctypes ctypes-arrays-pointers}@anchor{3046}
@subsubsection Arreglos y punteros


@geindex Array (clase en ctypes)
@anchor{library/ctypes ctypes Array}@anchor{1a31}
@deffn {Clase} ctypes.Array (*args)

Clase base abstracta para arreglos.

La forma recomendada de crear tipos de arreglos concretos es multiplicando cualquier tipo de datos @ref{2b,,ctypes} con un número entero no negativo. Como alternativa, puede subclasificar este tipo y definir variables de clase @ref{3047,,_length_} y @ref{3048,,_type_}. Los elementos del arreglo se pueden leer y escribir utilizando subíndices estándar y accesos de segmento; para lecturas de segmentos, el objeto resultante `no es' en sí mismo, un @ref{1a31,,Array}.

@geindex _length_ (atributo de ctypes.Array)
@anchor{library/ctypes ctypes Array _length_}@anchor{3047}
@deffn {Atributo} _length_

Un número entero positivo que especifica el número de elementos del conjunto. Los subíndices fuera de rango dan como resultado un @ref{1575,,IndexError}. Será retornado por @ref{6cf,,len()}.
@end deffn

@geindex _type_ (atributo de ctypes.Array)
@anchor{library/ctypes ctypes Array _type_}@anchor{3048}
@deffn {Atributo} _type_

Especifica el tipo de cada elemento del arreglo.
@end deffn

Los constructores de subclases de arreglos aceptan argumentos posicionales, usados para inicializar los elementos en orden.
@end deffn

@geindex ARRAY() (en el módulo ctypes)
@anchor{library/ctypes ctypes ARRAY}@anchor{3ed}
@deffn {Función} ctypes.ARRAY (type, length)

Create an array.
Equivalent to @code{type * length}, where `type' is a
@ref{2b,,ctypes} data type and `length' an integer.

This function is @ref{1c4,,soft deprecated} in favor of multiplication.
There are no plans to remove it.
@end deffn

@geindex _Pointer (clase en ctypes)
@anchor{library/ctypes ctypes _Pointer}@anchor{3049}
@deffn {Clase} ctypes._Pointer

Clase base, privada y abstracta para punteros.

Los tipos de punteros concretos se crean llamando a @ref{16ec,,POINTER()} con el tipo que será apuntado; esto se hace automáticamente por @ref{16eb,,pointer()}.

Si un puntero apunta a un arreglo, sus elementos pueden ser leídos y escritos usando accesos de subíndices y cortes estándar. Los objetos punteros no tienen tamaño, así que @ref{6cf,,len()} lanzará un @ref{228,,TypeError}. Los subíndices negativos se leerán de la memoria `antes' que el puntero (como en C), y los subíndices fuera de rango probablemente se bloqueen con una violación de acceso (si tienes suerte).

@geindex _type_ (atributo de ctypes._Pointer)
@anchor{library/ctypes ctypes _Pointer _type_}@anchor{304a}
@deffn {Atributo} _type_

Especifica el tipo apuntado.
@end deffn

@geindex contents (atributo de ctypes._Pointer)
@anchor{library/ctypes ctypes _Pointer contents}@anchor{2ff6}
@deffn {Atributo} contents

Retorna el objeto al que el puntero apunta. Asignando a este atributo cambia el puntero para que apunte al objeto asignado.
@end deffn
@end deffn

@node Ejecución concurrente,Comunicación en redes y entre procesos,Servicios genéricos del sistema operativo,La biblioteca estándar de Python
@anchor{library/concurrency doc}@anchor{304b}@anchor{library/concurrency concurrency}@anchor{304c}@anchor{library/concurrency concurrent-execution}@anchor{304d}
@section Ejecución concurrente


Los módulos descritos en este capítulo proveen soporte para la ejecución concurrente de código. La elección de qué herramienta utilizar depende de la tarea a ejecutar (vinculada a CPU o vinculada a E/S) y del estilo preferido de desarrollo (multi-tarea cooperativa o multi-tarea apropiativa). A continuación se muestra un resumen:

@menu
* threading — Thread-based parallelism:: 
* multiprocessing — Process-based parallelism:: 
* multiprocessing.shared_memory — Shared memory for direct access across processes: multiprocessing shared_memory — Shared memory for direct access across processes. 
* El paquete concurrent:: 
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks. 
* subprocess — Subprocess management:: 
* sched — Event scheduler:: 
* queue — A synchronized queue class:: 
* contextvars — Context Variables:: 
* _thread — Low-level threading API:: 

@end menu

@node threading — Thread-based parallelism,multiprocessing — Process-based parallelism,,Ejecución concurrente
@anchor{library/threading doc}@anchor{304e}@anchor{library/threading module-threading}@anchor{ed}@anchor{library/threading threading-thread-based-parallelism}@anchor{304f}
@subsection @code{threading} — Thread-based parallelism


@geindex module; threading

`Código fuente:' Lib/threading.py@footnote{https://github.com/python/cpython/tree/main/Lib/threading.py}


__________________________________________________________________


Este módulo construye interfaces de hilado de alto nivel sobre el módulo de más bajo nivel @ref{2,,_thread}.


Distinto en la versión 3.7: Este módulo solía ser opcional, ahora está siempre disponible.



@subsubheading Ver también


@ref{7dd,,concurrent.futures.ThreadPoolExecutor} ofrece una interfaz a mas alto nivel para enviar tareas a un hilo en segundo plano sin bloquear la ejecución del hilo de llamada, pero manteniendo la capacidad de recuperar sus resultados cuando sea necesario.

@ref{b6,,queue} proporciona una interfaz segura a nivel de hilos intercambiar datos entre hilos en ejecución.

@ref{b,,asyncio} ofrece un enfoque alternativo para lograr la concurrencia a nivel de tarea sin requerir el uso de múltiples subprocesos del sistema operativo.


@cartouche
@quotation Nota 
En la serie Python 2.x, este módulo contenía nombres @code{camelCase} para algunos métodos y funciones. Estos están obsoletos a partir de Python 3.10, pero aún son compatibles por compatibilidad con Python 2.5 y versiones anteriores.
@end quotation
@end cartouche

`Detalles de implementación de CPython:' En CPython, debido al @ref{2b5,,Candado de intérprete global}, solo un hilo puede ejecutar código Python a la vez (aunque ciertas bibliotecas orientadas al rendimiento pueden superar esta limitación). Si desea que su aplicación haga un mejor uso de los recursos computacionales de las máquinas multinúcleo, se recomienda utilizar @ref{94,,multiprocessing} o @ref{163,,concurrent.futures.ProcessPoolExecutor}. Sin embargo, el subproceso sigue siendo un modelo apropiado si desea ejecutar varias tareas vinculadas a E/S simultáneamente.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Este módulo define las siguientes funciones:

@geindex active_count() (en el módulo threading)
@anchor{library/threading threading active_count}@anchor{204}
@deffn {Función} threading.active_count ()

Retorna el número de objetos @ref{9df,,Thread} actualmente con vida. La cuenta retornada es igual al largo de la lista retornada por @ref{18ae,,enumerate()}.

La función @code{activeCount} es un alias obsoleto para esta función.
@end deffn

@geindex current_thread() (en el módulo threading)
@anchor{library/threading threading current_thread}@anchor{203}
@deffn {Función} threading.current_thread ()

Retorna el objeto @ref{9df,,Thread} actual, correspondiente al hilo de control del invocador. Si el hilo de control del invocador no fue creado a través del módulo @ref{ed,,threading}, se retorna un objeto hilo `dummy' con funcionalidad limitada.

La función @code{currentThread} es un alias obsoleto para esta función.
@end deffn

@geindex excepthook() (en el módulo threading)
@anchor{library/threading threading excepthook}@anchor{8e2}
@deffn {Función} threading.excepthook (args, /)

Gestiona una excepción lanzada por @ref{acf,,Thread.run()}.

El argumento `args' posee los siguientes atributos:


@itemize *

@item 
`exc_type': Tipo de excepción.

@item 
`exc_value': Valor de la excepción, puede ser @code{None}.

@item 
`exc_traceback': Rastreo de la excepción, puede ser @code{None}.

@item 
`thread': El hilo que ha lanzado la excepción, puede ser @code{None}.
@end itemize

Si `exc_type' es @ref{dc7,,SystemExit}, la excepción es silenciosamente ignorada. De otro modo, la excepción se imprime en @ref{9cc,,sys.stderr}.

Si esta función lanza una excepción, se llama a @ref{8a2,,sys.excepthook()} para manejarla.

@ref{8e2,,threading.excepthook()} se puede sobrescribir para controlar cómo se gestionan las excepciones levantadas por @ref{acf,,Thread.run()}.

Guarda `exc_value' usando un `hook' personalizado puede crear un ciclo de referencias. Debe ser aclarado explícitamente que se rompa el ciclo de referencias cuando la excepción ya no se necesite.

Guardando `thread' usando un `hook' personalizado puede resucitarlo si se asigna a un objeto que esté siendo finalizado. Evítese que `thread' sea almacenado después de que el `hook' personalizado se complete para evitar resucitar objetos.


@subsubheading Ver también


@ref{8a2,,sys.excepthook()} gestiona excepciones no capturadas.



Added in version 3.8.

@end deffn

@geindex __excepthook__ (en el módulo threading)
@anchor{library/threading threading __excepthook__}@anchor{8e1}
@deffn {Dato} threading.__excepthook__

Mantiene el valor original de @ref{8e2,,threading.excepthook()}. Se guarda para que se pueda restaurar el valor original en caso de que se reemplacen con objetos rotos o alternativos.


Added in version 3.10.

@end deffn

@geindex get_ident() (en el módulo threading)
@anchor{library/threading threading get_ident}@anchor{11cb}
@deffn {Función} threading.get_ident ()

Retorna el “identificador de hilo” del hilo actual. Éste es un entero distinto de cero. Su valor no tiene un significado directo; ha sido pensado como una `cookie' mágica para usarse, por ejemplo, en indexar un diccionario con datos específicos del hilo. Los identificadores de hilo pueden ser reciclados cuando se abandona un hilo y se crea otro hilo.


Added in version 3.3.

@end deffn

@geindex get_native_id() (en el módulo threading)
@anchor{library/threading threading get_native_id}@anchor{ad0}
@deffn {Función} threading.get_native_id ()

Retorna la ID de Hilo (`Thread ID') nativo integral del hilo actual asignado por el kernel. Este es un entero distinto de cero. Su valor puede utilizarse para identificar de forma única a este hilo en particular a través de todo el sistema (hasta que el hilo termine, luego de lo cual el valor puede ser reciclado por el SO).

@ref{1d5a,,Availability}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Added in version 3.8.



Distinto en la versión 3.13: Added support for GNU/kFreeBSD.

@end deffn

@geindex enumerate() (en el módulo threading)
@anchor{library/threading threading enumerate}@anchor{18ae}
@deffn {Función} threading.enumerate ()

Retorna una lista de todos los objetos @ref{9df,,Thread} actualmente activos. La lista incluye subprocesos demoníacos y objetos de subprocesos ficticios creados por @ref{203,,current_thread()}. Excluye los subprocesos terminados y los subprocesos que aún no se han iniciado. Sin embargo, el hilo principal siempre es parte del resultado, incluso cuando se termina.
@end deffn

@geindex main_thread() (en el módulo threading)
@anchor{library/threading threading main_thread}@anchor{1051}
@deffn {Función} threading.main_thread ()

Retorna el objeto @ref{9df,,Thread} principal. En condiciones normales, el hilo principal es el hilo desde el que fue inicializado el intérprete de Python.


Added in version 3.4.

@end deffn

@geindex settrace() (en el módulo threading)
@anchor{library/threading threading settrace}@anchor{8df}
@deffn {Función} threading.settrace (func)

@geindex trace function

Establece una función de seguimiento para todos los hilos iniciados desde el módulo @ref{ed,,threading} . La `func' se pasará a @ref{1540,,sys.settrace()} por cada hilo, antes de que su método @ref{acf,,run()} sea invocado.
@end deffn

@geindex settrace_all_threads() (en el módulo threading)
@anchor{library/threading threading settrace_all_threads}@anchor{56f}
@deffn {Función} threading.settrace_all_threads (func)

Establece una función de seguimiento para todos los hilos iniciados desde el módulo @ref{ed,,threading} y todos los hilos de Python que se estén ejecutando en ese momento.

La `func' será pasada a @ref{1540,,sys.settrace()} para cada hilo, antes de que su método @ref{acf,,run()} sea invocado.


Added in version 3.12.

@end deffn

@geindex gettrace() (en el módulo threading)
@anchor{library/threading threading gettrace}@anchor{8dd}
@deffn {Función} threading.gettrace ()

@geindex trace function
@geindex debugger

Obtiene la función de rastreo según lo establecido por @ref{8df,,settrace()}.


Added in version 3.10.

@end deffn

@geindex setprofile() (en el módulo threading)
@anchor{library/threading threading setprofile}@anchor{8e0}
@deffn {Función} threading.setprofile (func)

@geindex profile function

Establece una función de perfil para todos los hilos iniciados desde el módulo @ref{ed,,threading}. La `func' se pasará a @ref{153f,,sys.setprofile()} por cada hilo, antes de que se llame a su método @ref{acf,,run()}.
@end deffn

@geindex setprofile_all_threads() (en el módulo threading)
@anchor{library/threading threading setprofile_all_threads}@anchor{570}
@deffn {Función} threading.setprofile_all_threads (func)

Establece una función de perfil para todos los hilos iniciados desde el módulo @ref{ed,,threading} y todos los hilos de Python que se estén ejecutando en ese momento.

La `func' se pasará a @ref{153f,,sys.setprofile()} para cada hilo, antes de que se llame a su método @ref{acf,,run()}.


Added in version 3.12.

@end deffn

@geindex getprofile() (en el módulo threading)
@anchor{library/threading threading getprofile}@anchor{8de}
@deffn {Función} threading.getprofile ()

@geindex profile function

Obtiene la función de generador de perfiles establecida por @ref{8e0,,setprofile()}.


Added in version 3.10.

@end deffn

@geindex stack_size() (en el módulo threading)
@anchor{library/threading threading stack_size}@anchor{3050}
@deffn {Función} threading.stack_size ([size])

Retorna el tamaño de pila usado para crear nuevos hilos. El argumento opcional `size' (tamaño) especifica el tamaño de pila a ser utilizado para hilos creados posteriormente, y debe ser 0 (usar el valor por defecto de la plataforma o el configurado) o un valor entero positivo de al menos 32.768 (32KiB). Si no se especifica `size', se usará 0. Si no existe soporte para cambiar el tamaño de pila, se lanzará un @ref{1e5,,RuntimeError}. Si el tamaño de pila especificado es inválido, se lanzará un @ref{360,,ValueError} y el tamaño de pila no será modificado. El tamaño mínimo de pila actualmente soportado es de 32KiB para garantizar suficiente espacio de pila para el intérprete mismo. Nótese que algunas plataformas pueden tener restricciones particulares de valores para tamaños de pila, como requerir un tamaño de pila > 32KiB, o requerir una asignación en múltiplos del tamaño de página de la memoria del sistema. Debe consultarse la documentación de cada plataforma para mayor información (páginas de 4KiB son comunes; se recomienda el uso de múltiplos de 4096 para el tamaño de pila en ausencia de información más específica)

@ref{1d5a,,Availability}: Windows, pthreads.

Plataformas Unix con soporte para subprocesos POSIX.
@end deffn

Este módulo también define la siguiente constante:

@geindex TIMEOUT_MAX (en el módulo threading)
@anchor{library/threading threading TIMEOUT_MAX}@anchor{3051}
@deffn {Dato} threading.TIMEOUT_MAX

El máximo valor permitido para el parámetro `timeout' de las funciones bloqueantes (@ref{739,,Lock.acquire()}, @ref{efe,,RLock.acquire()}, @ref{18ba,,Condition.wait()}, etc.). La especificación de un tiempo de espera mayor a este valor lanzará un @ref{919,,OverflowError}.


Added in version 3.2.

@end deffn

Este módulo define un número de clases, las cuales son detalladas en las siguientes secciones.

El diseño de este módulo está vagamente basado en el modelo de hilos de Java. Sin embargo, donde Java hace que los bloqueos y las variables de condición sean comportamientos básicos de cada objeto, en Python son objetos separados.  La clase @ref{9df,,Thread} de Python soporta un subconjunto del comportamiento de la clase Thread de Java; actualmente, no hay prioridades, no hay grupos de hilos, y los hilos no pueden ser destruidos, detenidos, suspendidos, reanudados o interrumpidos.  Los métodos estáticos de la clase Thread de Java, cuando se implementan, se asignan a funciones de nivel de módulo.

Todos los métodos descritos abajo son ejecutados de manera atómica.

@menu
* Datos locales del hilo:: 
* Objetos tipo hilo:: 
* Objetos tipo lock:: 
* Objetos Rlock:: 
* Objetos condicionales:: 
* Objetos semáforo:: 
* Objetos de eventos:: 
* Objetos temporizadores:: 
* Objetos de barrera:: 
* Uso de locks@comma{} condiciones y semáforos en la declaración with: Uso de locks condiciones y semáforos en la declaración with. 

@end menu

@node Datos locales del hilo,Objetos tipo hilo,,threading — Thread-based parallelism
@anchor{library/threading thread-local-data}@anchor{3052}
@subsubsection Datos locales del hilo


Los datos locales de hilo son datos cuyos valores son específicos a cada hilo. Para manejar los datos locales de hilos, simplemente crear una instancia de @ref{1773,,local} (o una subclase) y almacenar los atributos en ella:

@example
mydata = threading.local()
mydata.x = 1
@end example

Los valores de instancia serán diferentes para hilos distintos.

@geindex local (clase en threading)
@anchor{library/threading threading local}@anchor{1773}
@deffn {Clase} threading.local

Una clase que representa datos locales de hilo.

Para más detalles y ejemplos extensivos, véase la documentación del módulo @code{_threading_local} module: Lib/_threading_local.py@footnote{https://github.com/python/cpython/tree/main/Lib/_threading_local.py}.
@end deffn

@node Objetos tipo hilo,Objetos tipo lock,Datos locales del hilo,threading — Thread-based parallelism
@anchor{library/threading id1}@anchor{3053}@anchor{library/threading thread-objects}@anchor{3054}
@subsubsection Objetos tipo hilo


La clase @ref{9df,,Thread} representa una actividad que corre en un hilo de control separado. Hay dos manera de especificar la actividad: pasando un objeto invocable al constructor, o sobrescribiendo el método @ref{acf,,run()} en una subclase. Ningún otro método (a excepción del constructor) deberá ser sobrescrito en una subclase. En otras palabras, `solo' sobrescribir los métodos  @code{__init__()} y @ref{acf,,run()}  de esta clase.

Una vez que un objeto `thread' es creado, su actividad debe ser iniciada llamando al método @ref{2d1f,,start()} del hilo. Ésto invoca el método @ref{acf,,run()} en un hilo de control separado.

Una vez que la actividad del hilo ha sido iniciada, el hilo se considerará “vivo”. Deja de estar vivo cuando su método @ref{acf,,run()} termina – ya sea normalmente, o por lanzar una excepción no manejada. El método  @ref{9e0,,is_alive()} verifica si acaso el hilo está vivo.

Otras hilos pueden llamar al método @ref{1251,,join()}. Esto bloquea el hilo que llama hasta que el hilo cuyo método @code{join()} es llamado termina.

Un hilo tiene un nombre. El nombre puede ser pasado al constructor y leído o cambiado a través del atributo @ref{202,,name}.

Si el método @ref{acf,,run()} lanza una excepción, se llama a @ref{8e2,,threading.excepthook()} para gestionarla. Por defecto, @ref{8e2,,threading.excepthook()} ignora silenciosamente a @ref{dc7,,SystemExit}.

Un hilo puede ser marcado como un «hilo demonio». El significado de esta marca es que la totalidad del programa de Python finalizará cuando solo queden hilos demonio. El valor inicial es heredado del hilo creador. La marca puede ser establecida a través de la propiedad @ref{200,,daemon} o del argumento `daemon' en el constructor.

@cartouche
@quotation Nota 
Los hilos demonio son detenidos abruptamente al momento del cierre. Sus recursos (tales como archivos abiertos, transacciones con bases de datos, etc.) pueden no ser liberados adecuadamente. Si se requiere que los hilos se detengan con gracia, háganse no-demoníacos y úsese un mecanismo de señalización adecuado tal como un @ref{11c9,,Event}.
@end quotation
@end cartouche

Existe un objeto «hilo principal»; éste corresponde al hilo de control inicial del programa de Python. No es un hilo demonio.

Existe la posibilidad de crear «objetos de hilos `dummy'». Estos son objetos hilo correspondientes a «hilos extranjeros», que son hilos de control iniciados afuera del modulo `threading', por ejemplo directamente de código en C. Los objetos de hilos `dummy' tienen funcionalidad limitada; siempre se consideran vivos y demoníacos, y no pueden se les puede aplicar el método @ref{3055,,joined}. Nunca son eliminados, ya que es imposible detectar la terminación de hilos extranjeros.

@geindex Thread (clase en threading)
@anchor{library/threading threading Thread}@anchor{9df}
@deffn {Clase} threading.Thread (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None)

Este constructor siempre debe ser llamado con argumentos de palabra clave. Los argumentos son:

`group' debe ser @cite{None}; reservado para una futura extensión cuando se implemente una clase @code{ThreadGroup}.

`target' es el objeto invocable a ser invocado por el método @ref{acf,,run()}. Por defecto es @code{None}, lo que significa que nada es llamado.

`name' es el nombre del hilo. De forma predeterminada, se construye un nombre único con el formato «Hilo-`N'», donde `N' es un número decimal pequeño, o «Hilo-`N' (target)» donde «target» es @code{target.__name__} si se especifica el argumento `target'.

`args' es una lista o tupla de argumentos para la invocación de destino. Por defecto es @code{()}.

`kwargs' es un diccionario de argumentos de palabra clave para la invocación objetivo. Por defecto es @code{@{@}}.

Si no es @code{None}, `daemon' establece explícitamente si el hilo es demoníaco. Si es @code{None} (el valor por defecto), la propiedad demoníaca es heredada del hilo actual.

Si la subclase sobrescribe el constructor, debe asegurarse de invocar al constructor de la clase base (@code{Thread.__init__()}) antes de hacer cualquier otra cosa al hilo.


Distinto en la versión 3.3: Added the `daemon' parameter.



Distinto en la versión 3.10: Utilice el nombre `target' si se omite el argumento `name'.


@geindex start() (método de threading.Thread)
@anchor{library/threading threading Thread start}@anchor{2d1f}
@deffn {Método} start ()

Inicia la actividad del hilo.

Debe ser llamada máximo una vez por objeto hilo. Se encarga de que el método @ref{acf,,run()} del objeto sea invocado en un hilo de control separado.

Este método lanzará un @ref{1e5,,RuntimeError} si se llama más de una vez en el mismo objeto hilo.
@end deffn

@geindex run() (método de threading.Thread)
@anchor{library/threading threading Thread run}@anchor{acf}
@deffn {Método} run ()

Método que representa la actividad del hilo.

Se puede sobrescribir este método en una subclase. El método estándar @ref{acf,,run()} invoca el objeto invocable pasado al constructor del objeto como argumento `target', si lo hay, con argumentos posicionales y de palabra clave tomados de los argumentos `args' y `kwargs', respectivamente.

Usar una lista o tupla como el argumento `args' que se pasa a @ref{9df,,Thread} podría lograr el mismo efecto.

Ejemplo:

@example
>>> from threading import Thread
>>> t = Thread(target=print, args=[1])
>>> t.run()
1
>>> t = Thread(target=print, args=(1,))
>>> t.run()
1
@end example
@end deffn

@geindex join() (método de threading.Thread)
@anchor{library/threading meth-thread-join}@anchor{3055}@anchor{library/threading threading Thread join}@anchor{1251}
@deffn {Método} join (timeout=None)

Espera a que el hilo termine. Esto bloquea el hilo llamador hasta que el hilo cuyo método @ref{1251,,join()} es llamado finalice – ya sea normalmente o a través de una excepción no gestionada – o hasta que el tiempo de espera opcional caduque.

When the `timeout' argument is present and not @code{None}, it should be a
floating-point number specifying a timeout for the operation in seconds
(or fractions thereof). As @ref{1251,,join()} always returns @code{None},
you must call @ref{9e0,,is_alive()} after @ref{1251,,join()} to
decide whether a timeout happened – if the thread is still alive, the
@ref{1251,,join()} call timed out.

Cuando el argumento `timeout' no se presenta o es @code{None}, la operación bloqueará hasta que el hilo termine.

Un hilo puede unirse varias veces.

@ref{1251,,join()} lanza un @ref{1e5,,RuntimeError} si se intenta unir el hilo actual ya que ello generaría un punto muerto. También es un error aplicar @ref{1251,,join()} a un hilo antes de que haya sido iniciado y los intentos de hacerlo lanzaran la misma excepción.
@end deffn

@geindex name (atributo de threading.Thread)
@anchor{library/threading threading Thread name}@anchor{202}
@deffn {Atributo} name

Un `string' utilizado con propósitos de identificación. No posee semántica. Se puede dar el mismo nombre a múltiples hilos. El nombre inicial es establecido por el constructor.
@end deffn

@geindex getName() (método de threading.Thread)
@geindex setName() (método de threading.Thread)
@anchor{library/threading threading Thread getName}@anchor{3056}
@deffn {Método} getName ()
@anchor{library/threading threading Thread setName}@anchor{201}
@deffnx {Método} setName ()

API getter/setter obsoleta para @ref{202,,name}; utilícelo directamente como una propiedad en su lugar.


Obsoleto desde la versión 3.10.

@end deffn

@geindex ident (atributo de threading.Thread)
@anchor{library/threading threading Thread ident}@anchor{2c43}
@deffn {Atributo} ident

El “identificador de hilo” de este hilo o @code{None} si el hilo no ha sido iniciado. Es un entero distinto de cero. Ver la función @ref{11cb,,get_ident()}. Los identificadores de hilos pueden ser reciclados cuando un hilo finaliza y otro hilo es creado. El identificador está disponible incuso después de que el hilo ha abandonado.
@end deffn

@geindex native_id (atributo de threading.Thread)
@anchor{library/threading threading Thread native_id}@anchor{ad1}
@deffn {Atributo} native_id

El ID de subproceso (@code{TID}) de este subproceso, según lo asignado por el sistema operativo (kernel). Este es un número entero no negativo, o @code{None} si el hilo no se ha iniciado. Consulte la función @ref{ad0,,get_native_id()}. Este valor se puede usar para identificar de forma única este hilo en particular en todo el sistema (hasta que el hilo termine, después de lo cual el sistema operativo puede reciclar el valor).

@cartouche
@quotation Nota 
Similar a las `Process IDs', las `Thread IDs' sólo son válidas (garantizadas como únicas a través de todo el sistema) desde el momento en que se crea el hilo hasta que el hilo es finalizado.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD.


Added in version 3.8.

@end deffn

@geindex is_alive() (método de threading.Thread)
@anchor{library/threading threading Thread is_alive}@anchor{9e0}
@deffn {Método} is_alive ()

Retornar si acaso el hilo está vivo.

Este método retorna @code{True} desde justo antes de que el método @ref{acf,,run()} inicie hasta junto antes de que el método @ref{acf,,run()} termine. La función @ref{18ae,,enumerate()} del módulo retorna una lista de todos los hilos vivos.
@end deffn

@geindex daemon (atributo de threading.Thread)
@anchor{library/threading threading Thread daemon}@anchor{200}
@deffn {Atributo} daemon

Un valor booleano que indica si este hilo es un hilo demonio (`True') o no (`False'). Debe ser establecido antes de que se llame a @ref{2d1f,,start()}, de lo contrario se lanzará un @ref{1e5,,RuntimeError}. Su valor inicial se hereda del hilo creador; el hilo principal no es un hilo demonio y por lo tanto todos los hilos creados en el hilo principal tienen por defecto un valor @ref{200,,daemon} = @code{False}.

El programa de Python en su totalidad finaliza cuando no queda ningún hilo no-demonio vivo.
@end deffn

@geindex isDaemon() (método de threading.Thread)
@geindex setDaemon() (método de threading.Thread)
@anchor{library/threading threading Thread isDaemon}@anchor{3057}
@deffn {Método} isDaemon ()
@anchor{library/threading threading Thread setDaemon}@anchor{1ff}
@deffnx {Método} setDaemon ()

API getter/setter obsoleta para @ref{200,,daemon}; utilícelo directamente como una propiedad en su lugar.


Obsoleto desde la versión 3.10.

@end deffn
@end deffn

@node Objetos tipo lock,Objetos Rlock,Objetos tipo hilo,threading — Thread-based parallelism
@anchor{library/threading id2}@anchor{3058}@anchor{library/threading lock-objects}@anchor{3059}
@subsubsection Objetos tipo `lock'


Una primitiva `lock', es una primitiva de sincronización que no pertenece a ningún hilo en particular cuando está cerrado. En Python, es la primitiva de sincronización de más bajo nivel actualmente disponible, implementado directamente por el módulo de extensión @ref{2,,_thread}.

Una primitiva `lock' está en uno de dos estados, «cerrado» o «abierto» (`locked'/`unlocked'). Se crea en estado abierto. Tiene dos métodos básicos, @ref{739,,acquire()} (adquirir) y @ref{132c,,release()} (liberar). Cuando el estado es `abierto', @ref{739,,acquire()} cambia el estado a cerrado y retorna inmediatamente. Cuando el estado es `cerrado', @ref{739,,acquire()} bloquea hasta que una llamada a @ref{132c,,release()} en otro hilo lo cambie a abierto, luego la llamada a @ref{739,,acquire()} lo restablece a cerrado y retorna. El método @ref{132c,,release()} sólo debe ser llamado en el estado cerrado; cambia el estado a abierto y retorna inmediatamente. Si se realiza un intento de liberar un `lock' abierto, se lanzará un @ref{1e5,,RuntimeError}.

Los `locks' también soportan el @ref{305a,,protocolo de gestión de contexto}.

Cuando más de un hilo está bloqueado en @ref{739,,acquire()} esperando que el estado sea abierto, sólo un hilo procederá cuando una llamada a @ref{132c,,release()} restablezca el estado a abierto; cuál de los hilos en espera procederá no está definido, y puede variar a través de las implementaciones.

Todos los métodos se ejecutan de manera atómica.

@geindex Lock (clase en threading)
@anchor{library/threading threading Lock}@anchor{1682}
@deffn {Clase} threading.Lock

La clase que implemente los objetos de la primitiva `lock'. Una vez que un hilo ha adquirido un `lock', intentos subsecuentes por adquirirlo bloquearán, hasta que sea liberado; cualquier hilo puede liberarlo.


Distinto en la versión 3.13: @code{Lock} is now a class. In earlier Pythons, @code{Lock} was a factory
function which returned an instance of the underlying private lock
type.


@geindex acquire() (método de threading.Lock)
@anchor{library/threading threading Lock acquire}@anchor{739}
@deffn {Método} acquire (blocking=True, timeout=-1)

Adquirir un `lock', bloqueante o no bloqueante.

Cuando se invoca con el argumento `blocking' establecido como @code{True} (el valor por defecto), bloquea hasta que el `lock' se abra, luego lo establece como cerrado y retorna @code{True}.

Cuando es invocado con el argumento `blocking' como @code{False}, no bloquea. Si una llamada con `blocking' establecido como @code{True} bloqueara, retorna @code{Falso} inmediatamente; de otro modo, cierra el `lock' y retorna @code{True}.

Cuando se invoca con el argumento de punto flotante `timeout' fijado a un valor positivo, bloquea por a lo más el número de segundos especificado en `timeout' y mientras el `lock' no pueda ser adquirido. Un argumento `timeout' de «-1» especifica una espera ilimitada. No está admitido especificar un `timeout' cuando `blocking' es @code{False}.

El valor de retorno es @code{True} si el `lock' es adquirido con éxito, @code{Falso} si no (por ejemplo si `timeout' expiró).


Distinto en la versión 3.2: El parámetro `timeout' es nuevo.



Distinto en la versión 3.2: La adquisición de un `lock' ahora puede ser interrumpida por señales en POSIX si la implementación de hilado subyacente lo soporta.



Distinto en la versión 3.14: Lock acquisition can now be interrupted by signals on Windows.

@end deffn

@geindex release() (método de threading.Lock)
@anchor{library/threading threading Lock release}@anchor{132c}
@deffn {Método} release ()

Libera un `lock'. Puede ser llamado desde cualquier hilo, no solo el hilo que ha adquirido el `lock'.

Cuando el `lock' está cerrado, lo restablece a abierto, y retorna. Si cualquier otro hilo está bloqueado esperando que el `lock' se abra, permite que exactamente uno de ellos proceda.

Cuando se invoca en un `lock' abierto, se lanza un @ref{1e5,,RuntimeError}.

No hay valor de retorno.
@end deffn

@geindex locked() (método de threading.Lock)
@anchor{library/threading threading Lock locked}@anchor{305b}
@deffn {Método} locked ()

Retorna @code{True} si se adquiere el bloqueo.
@end deffn
@end deffn

@node Objetos Rlock,Objetos condicionales,Objetos tipo lock,threading — Thread-based parallelism
@anchor{library/threading id3}@anchor{305c}@anchor{library/threading rlock-objects}@anchor{305d}
@subsubsection Objetos `Rlock'


Un `lock' reentrante es una primitiva de sincronización que puede ser adquirido múltiples veces por el mismo hilo. Internamente, utiliza el concepto de «hilo dueño» y «nivel de recursividad» además del estado abierto/cerrado utilizado por las primitivas `locks'. Si está en estado cerrado, algún hilo es dueño del `lock'; si está en estado abierto, ningún hilo es dueño.

Threads call a lock’s @ref{efe,,acquire()} method to lock it,
and its @ref{132c,,release()} method to unlock it.

@cartouche
@quotation Nota 
Reentrant locks support the @ref{305a,,context management protocol},
so it is recommended to use @ref{673,,with} instead of manually calling
@ref{efe,,acquire()} and @ref{305e,,release()}
to handle acquiring and releasing the lock for a block of code.
@end quotation
@end cartouche

RLock’s @ref{efe,,acquire()}/@ref{305e,,release()} call pairs may be nested,
unlike Lock’s @ref{739,,acquire()}/@ref{132c,,release()}. Only the final
@ref{305e,,release()} (the @ref{132c,,release()} of the outermost pair) resets
the lock to an unlocked state and allows another thread blocked in
@ref{efe,,acquire()} to proceed.

@ref{efe,,acquire()}/@ref{305e,,release()} must be used in pairs: each acquire
must have a release in the thread that has acquired the lock. Failing to
call release as many times the lock has been acquired can lead to deadlock.

@geindex RLock (clase en threading)
@anchor{library/threading threading RLock}@anchor{1d7}
@deffn {Clase} threading.RLock

Esta clase implementa objetos tipo `lock' reentrantes. Un `lock' reentrante debe ser liberado por el hilo que lo adquirió. Una vez que un hilo ha adquirido un `lock' reentrante, el mismo hilo puede adquirirlo otra vez sin bloquearse; el hilo debe liberarlo una vez por vez que lo adquiere.

Nótese que @code{RLock} en realidad es una función fábrica que retorna una instancia de la versión más eficiente de la clase RLock concreta que sea soportada por la plataforma.

@geindex acquire() (método de threading.RLock)
@anchor{library/threading threading RLock acquire}@anchor{efe}
@deffn {Método} acquire (blocking=True, timeout=-1)

Adquirir un `lock', bloqueante o no bloqueante.


@subsubheading Ver también



@table @asis

@item @ref{305a,,Using RLock as a context manager}

Recommended over manual @code{acquire()} and @ref{305e,,release()} calls
whenever practical.
@end table


When invoked with the `blocking' argument set to @code{True} (the default):

@quotation


@itemize *

@item 
If no thread owns the lock, acquire the lock and return immediately.

@item 
If another thread owns the lock, block until we are able to acquire
lock, or `timeout', if set to a positive float value.

@item 
If the same thread owns the lock, acquire the lock again, and
return immediately. This is the difference between @ref{1682,,Lock} and
@code{RLock}; @ref{1682,,Lock} handles this case the same as the previous,
blocking until the lock can be acquired.
@end itemize
@end quotation

When invoked with the `blocking' argument set to @code{False}:

@quotation


@itemize *

@item 
If no thread owns the lock, acquire the lock and return immediately.

@item 
If another thread owns the lock, return immediately.

@item 
If the same thread owns the lock, acquire the lock again and return
immediately.
@end itemize
@end quotation

In all cases, if the thread was able to acquire the lock, return @code{True}.
If the thread was unable to acquire the lock (i.e. if not blocking or
the timeout was reached) return @code{False}.

If called multiple times, failing to call @ref{305e,,release()} as many times
may lead to deadlock. Consider using @code{RLock} as a context manager rather than
calling acquire/release directly.


Distinto en la versión 3.2: El parámetro `timeout' es nuevo.

@end deffn

@geindex release() (método de threading.RLock)
@anchor{library/threading threading RLock release}@anchor{305e}
@deffn {Método} release ()

Libera un `lock', disminuyendo el nivel de recursividad. Si después de la disminución es cero, restablece el `lock' a abierto (no perteneciente a ningún hilo), y si cualquier otro hilo está bloqueado esperando que se abra el `lock', permite que exactamente uno de ellos proceda. Si luego de la disminución el nivel de recursividad todavía no es cero, el `lock' permanece cerrado y perteneciente al hilo llamador.

Only call this method when the calling thread owns the lock. A
@ref{1e5,,RuntimeError} is raised if this method is called when the lock is
not acquired.

No hay valor de retorno.
@end deffn
@end deffn

@node Objetos condicionales,Objetos semáforo,Objetos Rlock,threading — Thread-based parallelism
@anchor{library/threading condition-objects}@anchor{305f}@anchor{library/threading id4}@anchor{3060}
@subsubsection Objetos condicionales


Una condición variable siempre va asociada a algún tipo de `lock'. éste puede ser provisto o se creará uno por defecto. Proveer uno es útil cuando varias variables de condición deben compartir el mismo `lock'. El `lock' es parte del objeto condicional: no es necesario rastrearlo por separado.

Una condición variable obedece el @ref{305a,,protocolo de gestión de contexto}: al usar la declaración @code{with} se adquiere el `lock' asociado por la duración del bloque contenido. Los métodos @ref{3061,,acquire()} y @ref{3062,,release()} también llaman los métodos correspondientes del `lock' asociado.

Otros métodos deben llamarse con el `lock' asociado conservado. El método @ref{18ba,,wait()} libera el `lock', y luego bloquea hasta que otro hilo lo despierte llamando @ref{17e3,,notify()} o @ref{1fd,,notify_all()}. Una vez que ha sido despertado, @ref{18ba,,wait()} re-adquiere el `lock' y retorna. También es posible especificar un tiempo de espera.

El método @ref{17e3,,notify()} despierta a uno de los hilos que esperan a la condición variable, si es que alguno espera. El método @ref{1fd,,notify_all()} despierta a todos los hilos que estén esperando a la condición variable.

Nota: Los métodos @ref{17e3,,notify()} y @ref{1fd,,notify_all()} no liberan el `lock'; esto significa que el hilo o los hilos que han sido despertados no retornaran de su llamada de @ref{18ba,,wait()} inmediatamente, sino solo una vez que el hilo que haya llamado a @ref{17e3,,notify()} o @ref{1fd,,notify_all()} renuncie finalmente a la propiedad del `lock'.

El estilo típico de programación con variables condicionales utiliza el `lock' para sincronizar el acceso a algún estado compartido; hilos que estén interesados en un cambio de estado en particular llamarán a @ref{18ba,,wait()} reiteradamente hasta que vean el estado deseado, mientras que los hilos que modifiquen el estado llamarán a @ref{17e3,,notify()} o a @ref{1fd,,notify_all()} cuando cambien el estado de modo que pudiera ser que el el estado sea el deseado por alguno de los hilos en espera. Por ejemplo, el siguiente código es una situación genérica de productor-consumidor con capacidad de búfer ilimitada:

@example
# Consume one item
with cv:
    while not an_item_is_available():
        cv.wait()
    get_an_available_item()

# Produce one item
with cv:
    make_an_item_available()
    cv.notify()
@end example

El bucle @code{while} que verifica la condición de la aplicación es necesario porque @ref{18ba,,wait()} puede retornar después de una cantidad arbitraria de tiempo, y la condición que dio pie a la llamada de @ref{17e3,,notify()} puede ya no ser verdadera. Esto es inherente a la programación multi-hilo. El método @ref{3063,,wait_for()} puede usarse para automatizar la revisión de condiciones, y facilita la computación de tiempos de espera:

@example
# Consume an item
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()
@end example

Para elegir entre @ref{17e3,,notify()} y @ref{1fd,,notify_all()}, considérese si un cambio de estado puede ser interesante para uno o varios hilos en espera. Por ejemplo en una típica situación productor-consumidor, agregar un elemento al búfer sólo necesita despertar un hilo consumidor.

@geindex Condition (clase en threading)
@anchor{library/threading threading Condition}@anchor{11c6}
@deffn {Clase} threading.Condition (lock=None)

Esta clase implementa objetos de condición variable. Una condición variable permite que uno o más hilos esperen hasta que sean notificados por otro hilo.

Si se provee un argumento `lock' distinto de @code{None}, debe ser un objeto @ref{1682,,Lock} o @ref{1d7,,RLock}, y se utiliza como el `lock' subyacente. De otro modo, se crea un nuevo objeto @ref{1d7,,RLock} y se utiliza como el `lock' subyacente.


Distinto en la versión 3.3: cambiado de función de fábrica a una clase.


@geindex acquire() (método de threading.Condition)
@anchor{library/threading threading Condition acquire}@anchor{3061}
@deffn {Método} acquire (*args)

Adquiere el `lock' subyacente. Este método llama al método correspondiente sobre el `lock' subyacente; el valor de retorno es lo que retorne aquel método.
@end deffn

@geindex release() (método de threading.Condition)
@anchor{library/threading threading Condition release}@anchor{3062}
@deffn {Método} release ()

Libera el `lock' subyacente. Este método llama al método correspondiente en el `lock' subyacente; no tiene valor de retorno.
@end deffn

@geindex wait() (método de threading.Condition)
@anchor{library/threading threading Condition wait}@anchor{18ba}
@deffn {Método} wait (timeout=None)

Espera hasta ser notificado o hasta que el tiempo de espera caduque. Si el hilo invocador no ha adquirido el `lock' cuando este método es llamado, se lanza un @ref{1e5,,RuntimeError}.

Este método libera el `lock' subyacente, y luego bloquea hasta ser despertado por una llamada a @ref{17e3,,notify()} o @ref{1fd,,notify_all()} para la misma condición variable en otro hilo, o hasta que el tiempo de espera opcional se cumpla. Una vez que ha sido despertado o el tiempo de espera ha pasado, re-adquiere el `lock' y retorna.

When the `timeout' argument is present and not @code{None}, it should be a
floating-point number specifying a timeout for the operation in seconds
(or fractions thereof).

Cuando el `lock' subyacente es un  @ref{1d7,,RLock}, no se libera utilizando su método @ref{3062,,release()}, ya que esto podría no abrir realmente el `lock' cuando haya sido adquirido múltiples veces recursivamente. En cambio, se usa una interfaz interna de la clase @ref{1d7,,RLock}, que lo abre realmente incluso cuando haya sido adquirido múltiples veces recursivamente. Otra interfaz interna se usa luego para restablecer el nivel de recursividad cuando el `lock' es readquirido.

El valor de retorno es @code{True} a menos que un `timeout' dado haya expirado, en cuyo caso será @code{False}.


Distinto en la versión 3.2: Previamente, el método siempre retornaba @code{None}.

@end deffn

@geindex wait_for() (método de threading.Condition)
@anchor{library/threading threading Condition wait_for}@anchor{3063}
@deffn {Método} wait_for (predicate, timeout=None)

Espera a que una condición se evalúe como verdadera. `predicate' debe ser un invocable cuyo resultado se interpretará como un valor booleano. Se puede proveer un `timeout' que especifique el máximo tiempo de espera.

Este método utilitario puede llamar a @ref{18ba,,wait()} reiteradas veces hasta que se satisfaga el predicado, o hasta que la espera caduque. El valor de retorno es el último valor de retorno del predicado y se evaluará a @code{False} si el método ha caducado.

Al ignorar la propiedad `feature', llamar a este método equivale vagamente a escribir:

@example
while not predicate():
    cv.wait()
@end example

Por ende, aplican las mismas reglas que con @ref{18ba,,wait()}: El `lock' debe ser conservado cuando se llame y es re-adquirido al momento del retorno. El predicado se evalúa con el `lock' conservado.


Added in version 3.2.

@end deffn

@geindex notify() (método de threading.Condition)
@anchor{library/threading threading Condition notify}@anchor{17e3}
@deffn {Método} notify (n=1)

Por defecto, despierta a un hilo que esté esperando por esta condición, si lo existe. Si el hilo llamador no ha adquirido el `lock' cuando se llama este método, se lanza un @ref{1e5,,RuntimeError}.

Este método despierta como máximo `n' de los hilos que estén esperando por la condición variable; no es una opción si no hay hilos esperando.

La implementación actual despierta exactamente `n' hilos, si hay por lo menos `n' hilos esperando. Sin embargo, no es seguro apoyarse en este comportamiento. A futuro, una implementación optimizada podría ocasionalmente despertar a más de `n' hilos.

Nota: un hilo que ha sido despertado no retorna realmente de su llamada a @ref{18ba,,wait()} hasta que pueda readquirir el `lock'. Ya que @ref{17e3,,notify()} no libera el `lock', su llamador debiera hacerlo.
@end deffn

@geindex notify_all() (método de threading.Condition)
@anchor{library/threading threading Condition notify_all}@anchor{1fd}
@deffn {Método} notify_all ()

Despierta a todos los hilos que esperen por esta condición. Este método actúa como @ref{17e3,,notify()}, pero despierta a todos los hilos en espera en vez de a uno. Si el hilo llamador no ha adquirido el `lock' cuando se llama a este método, se lanza un @ref{1e5,,RuntimeError}.

El método @code{notifyAll} es un alias obsoleto para este método.
@end deffn
@end deffn

@node Objetos semáforo,Objetos de eventos,Objetos condicionales,threading — Thread-based parallelism
@anchor{library/threading id5}@anchor{3064}@anchor{library/threading semaphore-objects}@anchor{3065}
@subsubsection Objetos semáforo


Éste es uno de las primitivas de sincronización más antiguos en la historia de las ciencias de la computación, inventado por el pionero en ciencias de la computación holandés Edsger W. Dijkstra (él utilizó los nombres @code{P()} y @code{V()} en lugar de @ref{12c1,,acquire()} y @ref{3066,,release()})

Un semáforo administra un contador interno que se disminuye por cada llamada a @ref{12c1,,acquire()} y se incrementa por cada llamada a @ref{3066,,release()}. El contador no puede bajar de cero; cuando @ref{12c1,,acquire()} lo encuentra en cero, bloquea, esperando hasta que otro hilo llame @ref{3066,,release()}.

Los semáforos también tienen soporte para el @ref{305a,,protocolo de gestión de contexto}.

@geindex Semaphore (clase en threading)
@anchor{library/threading threading Semaphore}@anchor{11c7}
@deffn {Clase} threading.Semaphore (value=1)

Esta clase implementa los objetos semáforo. Un semáforo gestiona un contador atómico que representa el número de llamadas a @ref{3066,,release()} menos el número de llamadas a @ref{12c1,,acquire()}, más un valor inicial. El método @ref{12c1,,acquire()} bloquea si es necesario, hasta que pueda retornar sin volver el contador negativo. Si no es provisto, el valor por defecto de `value' será 1.

El argumento opcional da el `value' inicial al contador interno; por defecto es @code{1}. Si el `value' provisto es menor a 0; se lanza un @ref{360,,ValueError}.


Distinto en la versión 3.3: cambiado de función de fábrica a una clase.


@geindex acquire() (método de threading.Semaphore)
@anchor{library/threading threading Semaphore acquire}@anchor{12c1}
@deffn {Método} acquire (blocking=True, timeout=None)

Adquirir un semáforo.

Cuando se invoca sin argumentos:


@itemize *

@item 
Si el contador interno es mayor a cero de entrada, lo disminuye en uno y retorna @code{True} inmediatamente.

@item 
Si el contador interno es cero de entrada, bloquea hasta ser despertado por una llamada a @ref{3066,,release()}. Una vez despierto (y el contador sea mayor a 0), disminuye el contador en 1 y retorna @code{True}. Se despertará exactamente un hilo por cada llamada a @ref{3066,,release()}. No debiese confiarse en el orden en que los hilos sean despertados.
@end itemize

Cuando se invoca con `blocking' fijado en @code{False}, no bloquea. Si una llamada sin un argumento bloquease, retorna @code{False} inmediatamente; de otro modo, hace lo mismo que cuando se llama sin argumentos, y retorna @code{True}.

Cuando se invoca con `timeout' distinto de @code{None}, bloqueará por un tiempo máximo en segundos fijados en `timeout'. Si `acquire' no se completa exitosamente en ese intervalo, retorna @code{False}. De otro modo retorna @code{True}.


Distinto en la versión 3.2: El parámetro `timeout' es nuevo.

@end deffn

@geindex release() (método de threading.Semaphore)
@anchor{library/threading threading Semaphore release}@anchor{3066}
@deffn {Método} release (n=1)

Suelta un semáforo, incrementando el contador interno por `n'. Cuando era cero en la entrada y otros subprocesos están esperando que vuelva a ser mayor que cero, active `n' de esos subprocesos.


Distinto en la versión 3.9: Se agregó el parámetro `n' para liberar varios subprocesos en espera a la vez.

@end deffn
@end deffn

@geindex BoundedSemaphore (clase en threading)
@anchor{library/threading threading BoundedSemaphore}@anchor{11c8}
@deffn {Clase} threading.BoundedSemaphore (value=1)

Clase que implementa objetos de semáforo delimitados. Un semáforo delimitado verifica que su valor actual no exceda su valor inicial. Si lo hace, se lanza un @ref{360,,ValueError}. En la mayoría de las situaciones se utilizan los semáforos para cuidar recursos con capacidad limitada. Si se libera el semáforo demasiadas veces es signo de un `bug'. Si no se provee, el valor por defecto de `value' será 1.


Distinto en la versión 3.3: cambiado de función de fábrica a una clase.

@end deffn

@menu
* Ejemplo de Semaphore:: 

@end menu

@node Ejemplo de Semaphore,,,Objetos semáforo
@anchor{library/threading semaphore-example}@anchor{3067}@anchor{library/threading semaphore-examples}@anchor{3068}
@subsubsection Ejemplo de @code{Semaphore}


Los semáforos suelen utilizarse para cuidar recursos con capacidad limitada, por ejemplo, un servidor de base de datos. En cualquier situación en que el tamaño de los recursos sea fijo, se debe usar un semáforo delimitado. Antes de generar cualquier hilo de trabajo, tu hilo principal debe inicializar el semáforo:

@example
maxconnections = 5
# ...
pool_sema = BoundedSemaphore(value=maxconnections)
@end example

Una vez que han sido generados, los hilos de trabajo llaman a los métodos `acquire' y `release' cuando necesitan conectarse al servidor:

@example
with pool_sema:
    conn = connectdb()
    try:
        # ... use connection ...
    finally:
        conn.close()
@end example

El uso de semáforos delimitados reduce la posibilidad de que pase inadvertido un error de programación que cause que el semáforo sea liberado más veces de las que sea adquirido.

@node Objetos de eventos,Objetos temporizadores,Objetos semáforo,threading — Thread-based parallelism
@anchor{library/threading event-objects}@anchor{3069}@anchor{library/threading id6}@anchor{306a}
@subsubsection Objetos de eventos


Éste es uno de los mecanismos más simples de comunicación entre hilos: un hilo señala un evento y otro hilo lo espera.

Un objeto de evento maneja una marca interna que puede ser establecida como verdadera mediante el método @ref{306b,,set()} y restablecida a falsa mediante el método @code{clear()}. El método @code{wait()} bloquea hasta que la marca sea `true'.

@geindex Event (clase en threading)
@anchor{library/threading threading Event}@anchor{11c9}
@deffn {Clase} threading.Event

Clase que implementa los objetos de evento. Un evento gestiona un indicador que puede ser establecido a verdadero mediante el método @ref{306b,,set()} y restablecido a falso con el método @ref{306c,,clear()}. El método @ref{138e,,wait()} bloquea hasta que el indicador sea verdadero. El indicador es inicialmente falso.


Distinto en la versión 3.3: cambiado de función de fábrica a una clase.


@geindex is_set() (método de threading.Event)
@anchor{library/threading threading Event is_set}@anchor{1fe}
@deffn {Método} is_set ()

Retorna @code{True} exclusivamente si el indicador interno es verdadero.

El método @code{isSet} es un alias obsoleto para este método.
@end deffn

@geindex set() (método de threading.Event)
@anchor{library/threading threading Event set}@anchor{306b}
@deffn {Método} set ()

Establece el indicador interno a verdadero. Todos los hilos que estén esperando que se vuelva verdadero serán despertados. Los hilos que llaman a @ref{138e,,wait()} una vez que el indicador marca verdadero no bloquearán.
@end deffn

@geindex clear() (método de threading.Event)
@anchor{library/threading threading Event clear}@anchor{306c}
@deffn {Método} clear ()

Restablece el indicador a falso. Posteriormente, los hilos que llamen a @ref{138e,,wait()} bloquearán hasta que se llame a @ref{306b,,set()} para establecer el indicador interno a verdadero nuevamente.
@end deffn

@geindex wait() (método de threading.Event)
@anchor{library/threading threading Event wait}@anchor{138e}
@deffn {Método} wait (timeout=None)

Block as long as the internal flag is false and the timeout, if given,
has not expired. The return value represents the
reason that this blocking method returned; @code{True} if returning because
the internal flag is set to true, or @code{False} if a timeout is given and
the internal flag did not become true within the given wait time.

When the timeout argument is present and not @code{None}, it should be a
floating-point number specifying a timeout for the operation in seconds,
or fractions thereof.


Distinto en la versión 3.1: Previamente, el método siempre retornaba @code{None}.

@end deffn
@end deffn

@node Objetos temporizadores,Objetos de barrera,Objetos de eventos,threading — Thread-based parallelism
@anchor{library/threading id7}@anchor{306d}@anchor{library/threading timer-objects}@anchor{306e}
@subsubsection Objetos temporizadores


Esta clase representa una acción que sólo debe ejecutarse luego de que una cierta cantidad de tiempo transcurra — un temporizador. @ref{11ca,,Timer} es una subclase de @ref{9df,,Thread} y en tanto tal también funciona como un ejemplo de creación de hilos personalizados.

Los temporizadores son iniciados, tal como los hilos, al llamarse su método @ref{2d1f,,Timer.start}. El temporizador puede ser detenido (antes de que su acción haya comenzado) al llamar al método @ref{306f,,cancel()}. El intervalo que el temporizador esperará antes de ejecutar su acción puede no ser exactamente el mismo que el intervalo especificado por el usuario.

Por ejemplo:

@example
def hello():
    print("hello, world")

t = Timer(30.0, hello)
t.start()  # after 30 seconds, "hello, world" will be printed
@end example

@geindex Timer (clase en threading)
@anchor{library/threading threading Timer}@anchor{11ca}
@deffn {Clase} threading.Timer (interval, function, args=None, kwargs=None)

Crear un temporizador que ejecutará `function' con los argumentos `args' y los argumentos de palabra clave `kwargs', luego de que una cantidad `interval' de segundos hayan transcurrido. Si `args' es @code{None} (por defecto) se utilizará una lista vacía. Si `kwargs' es @code{None} (por defecto) se utilizará un `dict' vacío.


Distinto en la versión 3.3: cambiado de función de fábrica a una clase.


@geindex cancel() (método de threading.Timer)
@anchor{library/threading threading Timer cancel}@anchor{306f}
@deffn {Método} cancel ()

Detiene el temporizador, y cancela la ejecución de la acción del temporizador. Esto sólo funcionará si el temporizador está en etapa de espera.
@end deffn
@end deffn

@node Objetos de barrera,Uso de locks condiciones y semáforos en la declaración with,Objetos temporizadores,threading — Thread-based parallelism
@anchor{library/threading barrier-objects}@anchor{3070}
@subsubsection Objetos de barrera



Added in version 3.2.


Esta clase provee una primitiva de sincronización simple para ser usado por un número fijo de hilos que necesitan esperarse entre ellos. Cada uno de los hilos intenta pasar la barrera llamando al método @ref{3071,,wait()} y bloqueará hasta que todos los hilos hayan hecho sus respectivas llamadas a @ref{3071,,wait()}. En este punto, los hilos son liberados simultáneamente.

La barrera puede ser reutilizada cualquier número de veces para el mismo número de hilos.

Como ejemplo, aquí hay una manera simple de sincronizar un hilo cliente con uno servidor:

@example
b = Barrier(2, timeout=5)

def server():
    start_server()
    b.wait()
    while True:
        connection = accept_connection()
        process_server_connection(connection)

def client():
    b.wait()
    while True:
        connection = make_connection()
        process_client_connection(connection)
@end example

@geindex Barrier (clase en threading)
@anchor{library/threading threading Barrier}@anchor{1250}
@deffn {Clase} threading.Barrier (parties, action=None, timeout=None)

Crear un objeto de barrera para un número `parties' de hilos. Una `action', si es provista, es un invocable a ser llamado por uno de los hilos cuando sean liberados. `timeout' es el valor de tiempo de espera máximo por defecto si no se especifica uno en el método @ref{3071,,wait()}.

@geindex wait() (método de threading.Barrier)
@anchor{library/threading threading Barrier wait}@anchor{3071}
@deffn {Método} wait (timeout=None)

Pasa la barrera. Cuando todos los hilos involucrados en el objeto barrera han llamado esta función, se liberan todos simultáneamente. Si se provee un valor `timeout', se utilizará con preferencia sobre cualquiera que haya sido suministrado al constructor de la clase.

El valor de retorno es un entero en el rango desde 0 hasta `parties' – 1, diferente para cada hilo. Puede ser utilizado para seleccionar a un hilo para que haga alguna limpieza especial, por ejemplo:

@example
i = barrier.wait()
if i == 0:
    # Only one thread needs to print this
    print("passed the barrier")
@end example

Se se provee una `action' al constructor, uno de los hilos la habrá llamado antes de ser liberado. Si acaso esta llamada lanzara un error, la barrera entra en estado `broken' (roto).

Si se agota el tiempo de llamada, la barrera pasa al estado roto.

Este método podría lanzar una excepción @ref{1252,,BrokenBarrierError} si la barrera está rota o si se reinicia mientras el hilo está esperando.
@end deffn

@geindex reset() (método de threading.Barrier)
@anchor{library/threading threading Barrier reset}@anchor{3072}
@deffn {Método} reset ()

Retorna la barrera al estado por defecto, vacío. Cualquier hilo que esté a su espera recibirá la excepción @ref{1252,,BrokenBarrierError}.

Nótese que utilizar esta función podría requerir alguna sincronización externa si existen otros hilos cuyos estados sean desconocidos. Si una barrera se rompe puede ser mejor abandonarla y crear una nueva.
@end deffn

@geindex abort() (método de threading.Barrier)
@anchor{library/threading threading Barrier abort}@anchor{3073}
@deffn {Método} abort ()

Coloca la barrera en estado roto. Esto causa que cualquier llamada activa o futura a @ref{3071,,wait()} falle con el error @ref{1252,,BrokenBarrierError}. Úsese por ejemplo si uno de los hilos necesita abortar, para evitar que la aplicación quede en punto muerto.

Puede ser preferible simplemente crear la barrera con un valor `timeout' sensato para cuidarse automáticamente de que uno de los hilos falle.
@end deffn

@geindex parties (atributo de threading.Barrier)
@anchor{library/threading threading Barrier parties}@anchor{3074}
@deffn {Atributo} parties

El número de hilos requeridos para pasar la barrera.
@end deffn

@geindex n_waiting (atributo de threading.Barrier)
@anchor{library/threading threading Barrier n_waiting}@anchor{3075}
@deffn {Atributo} n_waiting

El número de hilos actualmente esperando en la barrera.
@end deffn

@geindex broken (atributo de threading.Barrier)
@anchor{library/threading threading Barrier broken}@anchor{3076}
@deffn {Atributo} broken

Un valor booleano que será @code{True} si la barrera está en el estado roto.
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/threading threading BrokenBarrierError}@anchor{1252}
@deffn {Excepción} threading.BrokenBarrierError

Esta excepción, una subclase de @ref{1e5,,RuntimeError}, se lanza cuando el objeto @ref{1250,,Barrier} se restablece o se rompe.
@end deffn

@node Uso de locks condiciones y semáforos en la declaración with,,Objetos de barrera,threading — Thread-based parallelism
@anchor{library/threading using-locks-conditions-and-semaphores-in-the-with-statement}@anchor{3077}@anchor{library/threading with-locks}@anchor{305a}
@subsubsection Uso de `locks', condiciones y semáforos en la declaración @code{with}


Todos los objetos provistos por este módulo que tienen métodos @code{acquire} y @code{release} pueden ser utilizados como administradores de contexto para una declaración @ref{673,,with}. El método @code{acquire} será llamado cuando se ingresa al bloque y el método @code{release} será llamado cuando se abandona el bloque. De ahí que, el siguiente fragmento:

@example
with some_lock:
    # do something...
@end example

sea equivalente a:

@example
some_lock.acquire()
try:
    # do something...
finally:
    some_lock.release()
@end example

Actualmente, los objetos @ref{1682,,Lock}, @ref{1d7,,RLock}, @ref{11c6,,Condition}, @ref{11c7,,Semaphore}, y @ref{11c8,,BoundedSemaphore} pueden ser utilizados como gestores de contexto con declaraciones @ref{673,,with}.

@node multiprocessing — Process-based parallelism,multiprocessing shared_memory — Shared memory for direct access across processes,threading — Thread-based parallelism,Ejecución concurrente
@anchor{library/multiprocessing doc}@anchor{3078}@anchor{library/multiprocessing module-multiprocessing}@anchor{94}@anchor{library/multiprocessing multiprocessing-process-based-parallelism}@anchor{3079}
@subsection @code{multiprocessing} — Process-based parallelism


@geindex module; multiprocessing

`Código fuente:' Lib/multiprocessing/@footnote{https://github.com/python/cpython/tree/main/Lib/multiprocessing/}


__________________________________________________________________


@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@menu
* Introducción: Introducción<7>. 
* Referencia: Referencia<2>. 
* Pautas de programación:: 
* Ejemplos: Ejemplos<13>. 

@end menu

@node Introducción<7>,Referencia<2>,,multiprocessing — Process-based parallelism
@anchor{library/multiprocessing introduction}@anchor{307a}
@subsubsection Introducción


@ref{94,,multiprocessing} is a package that supports spawning processes using an
API similar to the @ref{ed,,threading} module.  The @ref{94,,multiprocessing} package
offers both local and remote concurrency, effectively side-stepping the
@ref{2b5,,Global Interpreter Lock} by using
subprocesses instead of threads.  Due
to this, the @ref{94,,multiprocessing} module allows the programmer to fully
leverage multiple processors on a given machine.  It runs on both POSIX and
Windows.

El módulo @ref{94,,multiprocessing} también introduce API que no tienen análogos en el módulo @ref{ed,,threading}. Un buen ejemplo de esto es el objeto @ref{137c,,Pool} que ofrece un medio conveniente de paralelizar la ejecución de una función a través de múltiples valores de entrada, distribuyendo los datos de entrada a través de procesos (paralelismo de datos). El siguiente ejemplo demuestra la práctica común de definir tales funciones en un módulo para que los procesos secundarios puedan importar con éxito ese módulo. Este ejemplo básico de paralelismo de datos usando @ref{137c,,Pool},

@example
from multiprocessing import Pool

def f(x):
    return x*x

if __name__ == '__main__':
    with Pool(5) as p:
        print(p.map(f, [1, 2, 3]))
@end example

imprimirá la salida estándar

@example
[1, 4, 9]
@end example


@subsubheading Ver también


@ref{163,,concurrent.futures.ProcessPoolExecutor} ofrece una interfaz de nivel superior para enviar tareas a un proceso en segundo plano sin bloquear la ejecución del proceso de llamada. En comparación con el uso directo de la interfaz @ref{137c,,Pool}, la API @ref{22,,concurrent.futures} permite separar el envío de trabajo al grupo de procesos subyacente de la espera de los resultados.


@menu
* La clase Process:: 
* Contextos y métodos de inicio:: 
* Intercambiando objetos entre procesos:: 
* Sincronización entre procesos:: 
* Compartiendo estado entre procesos:: 
* Usando una piscina de trabajadores (pool of workers): Usando una piscina de trabajadores pool of workers. 

@end menu

@node La clase Process,Contextos y métodos de inicio,,Introducción<7>
@anchor{library/multiprocessing the-process-class}@anchor{307b}
@subsubsection La clase @code{Process}


En @ref{94,,multiprocessing}, los procesos se generan creando un objeto @ref{be1,,Process} y luego llamando a su método @ref{307c,,start()} .  @ref{be1,,Process} sigue la API de @ref{9df,,threading.Thread}. Un ejemplo trivial de un programa multiproceso es

@example
from multiprocessing import Process

def f(name):
    print('hello', name)

if __name__ == '__main__':
    p = Process(target=f, args=('bob',))
    p.start()
    p.join()
@end example

Para mostrar las IDs individuales involucradas en el proceso, aquí hay un ejemplo ampliado:

@example
from multiprocessing import Process
import os

def info(title):
    print(title)
    print('module name:', __name__)
    print('parent process:', os.getppid())
    print('process id:', os.getpid())

def f(name):
    info('function f')
    print('hello', name)

if __name__ == '__main__':
    info('main line')
    p = Process(target=f, args=('bob',))
    p.start()
    p.join()
@end example

Para obtener una explicación de por qué es necesaria la parte @code{if __name__ == '__main__'} , consulte @ref{307d,,Pautas de programación}.

@node Contextos y métodos de inicio,Intercambiando objetos entre procesos,La clase Process,Introducción<7>
@anchor{library/multiprocessing contexts-and-start-methods}@anchor{307e}@anchor{library/multiprocessing multiprocessing-start-methods}@anchor{162}
@subsubsection Contextos y métodos de inicio


Dependiendo de la plataforma, @ref{94,,multiprocessing} admite tres formas de iniciar un proceso. Estos métodos de inicio `start methods' son

@quotation


@table @asis

@item Generación (`spawn')

El proceso principal inicia un nuevo proceso de interpretación de Python. El proceso secundario solo heredará los recursos necesarios para ejecutar el método @ref{307f,,run()} del objeto de proceso. En particular, los identificadores y descriptores de archivo innecesarios del proceso principal no se heredarán. Iniciar un proceso con este método es bastante lento en comparación con `fork' o `forkserver'.

Available on POSIX and Windows platforms.  The default on Windows and macOS.

@item `fork'

El proceso parental usa @ref{2ff,,os.fork()} para bifurcar el intérprete de Python. El proceso hijo, cuando comienza, es efectivamente idéntico al proceso parental. Todos los recursos del proceso parental son heredados por el proceso hijo. Tenga en cuenta que bifurcar (`forking') de forma segura un proceso multihilo es problemático.

Available on POSIX systems.


Distinto en la versión 3.14: This is no longer the default start method on any platform.
Code that requires `fork' must explicitly specify that via
@ref{18b,,get_context()} or @ref{18c,,set_start_method()}.



Distinto en la versión 3.12: If Python is able to detect that your process has multiple threads, the
@ref{2ff,,os.fork()} function that this start method calls internally will
raise a @ref{1da,,DeprecationWarning}. Use a different start method.
See the @ref{2ff,,os.fork()} documentation for further explanation.


@item `forkserver'

When the program starts and selects the `forkserver' start method,
a server process is spawned.  From then on, whenever a new process
is needed, the parent process connects to the server and requests
that it fork a new process.  The fork server process is single threaded
unless system libraries or preloaded imports spawn threads as a
side-effect so it is generally safe for it to use @ref{2ff,,os.fork()}.
No unnecessary resources are inherited.

Available on POSIX platforms which support passing file descriptors over
Unix pipes such as Linux.  The default on those.


Distinto en la versión 3.14: This became the default start method on POSIX platforms.

@end table
@end quotation


Distinto en la versión 3.4: `spawn' added on all POSIX platforms, and `forkserver' added for
some POSIX platforms.
Child processes no longer inherit all of the parents inheritable
handles on Windows.



Distinto en la versión 3.8: On macOS, the `spawn' start method is now the default.  The `fork' start
method should be considered unsafe as it can lead to crashes of the
subprocess as macOS system libraries may start threads. See bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.



Distinto en la versión 3.14: On POSIX platforms the default start method was changed from `fork' to
`forkserver' to retain the performance but avoid common multithreaded
process incompatibilities. See gh-84559@footnote{https://github.com/python/cpython/issues/84559}.


On POSIX using the `spawn' or `forkserver' start methods will also
start a `resource tracker' process which tracks the unlinked named
system resources (such as named semaphores or
@ref{1664,,SharedMemory} objects) created
by processes of the program.  When all processes
have exited the resource tracker unlinks any remaining tracked object.
Usually there should be none, but if a process was killed by a signal
there may be some «leaked» resources.  (Neither leaked semaphores nor shared
memory segments will be automatically unlinked until the next reboot. This is
problematic for both objects because the system allows only a limited number of
named semaphores, and shared memory segments occupy some space in the main
memory.)

Para seleccionar un método de inicio, utilice la función @ref{18c,,set_start_method()} en la cláusula @code{if __name__ == '__main__'} del módulo principal. Por ejemplo:

@example
import multiprocessing as mp

def foo(q):
    q.put('hello')

if __name__ == '__main__':
    mp.set_start_method('spawn')
    q = mp.Queue()
    p = mp.Process(target=foo, args=(q,))
    p.start()
    print(q.get())
    p.join()
@end example

@ref{18c,,set_start_method()} no debería ser usada más de una vez en el programa.

Alternativamente, se puede usar @ref{18b,,get_context()} para obtener un objeto de contexto. Los objetos de contexto tienen la misma API que el módulo de multiprocesamiento, y permiten utilizar múltiples métodos de inicio en el mismo programa.

@example
import multiprocessing as mp

def foo(q):
    q.put('hello')

if __name__ == '__main__':
    ctx = mp.get_context('spawn')
    q = ctx.Queue()
    p = ctx.Process(target=foo, args=(q,))
    p.start()
    print(q.get())
    p.join()
@end example

Tenga en cuenta que los objetos relacionados con un contexto pueden no ser compatibles con procesos para un contexto diferente. En particular, los `locks' creados con el contexto `fork' no se pueden pasar a los procesos iniciados con los métodos de inicio `spawn' o `forkserver' .

Una biblioteca que quiera usar un método de inicio particular probablemente debería usar @ref{18b,,get_context()} para evitar interferir con la elección del usuario de la biblioteca.

@cartouche
@quotation Advertencia 
The @code{'spawn'} and @code{'forkserver'} start methods generally cannot
be used with «frozen» executables (i.e., binaries produced by
packages like `PyInstaller' and `cx_Freeze') on POSIX systems.
The @code{'fork'} start method may work if code does not use threads.
@end quotation
@end cartouche

@node Intercambiando objetos entre procesos,Sincronización entre procesos,Contextos y métodos de inicio,Introducción<7>
@anchor{library/multiprocessing exchanging-objects-between-processes}@anchor{3080}
@subsubsection Intercambiando objetos entre procesos


@ref{94,,multiprocessing} admite dos tipos de canales de comunicación entre procesos:

`Colas (*queues*)'

@quotation

La clase @ref{1803,,Queue} es prácticamente un clon de @ref{13ee,,queue.Queue}. Por ejemplo:

@example
from multiprocessing import Process, Queue

def f(q):
    q.put([42, None, 'hello'])

if __name__ == '__main__':
    q = Queue()
    p = Process(target=f, args=(q,))
    p.start()
    print(q.get())    # prints "[42, None, 'hello']"
    p.join()
@end example

Queues are thread and process safe.
Any object put into a @ref{94,,multiprocessing} queue will be serialized.
@end quotation

`Tuberías (*Pipes*)'

@quotation

La función @ref{3081,,Pipe()} retorna un par de objetos de conexión conectados por una tubería (`pipe') que, por defecto, es un dúplex (bidireccional). Por ejemplo:

@example
from multiprocessing import Process, Pipe

def f(conn):
    conn.send([42, None, 'hello'])
    conn.close()

if __name__ == '__main__':
    parent_conn, child_conn = Pipe()
    p = Process(target=f, args=(child_conn,))
    p.start()
    print(parent_conn.recv())   # prints "[42, None, 'hello']"
    p.join()
@end example

Los dos objetos de conexión retornados por @ref{3081,,Pipe()} representan los dos extremos de la tubería (`pipe'). Cada objeto de conexión tiene los métodos @code{send()} y @code{recv()} (entre otros). Tenga en cuenta que los datos en una tubería pueden corromperse si dos procesos (o hilos) intentan leer o escribir en el `mismo' (`same') extremo de la tubería al mismo tiempo. Por supuesto, no hay riesgo de corrupción por procesos que utilizan diferentes extremos de la tubería (`pipe') al mismo tiempo.

The @code{send()} method serializes the the object and
@code{recv()} re-creates the object.
@end quotation

@node Sincronización entre procesos,Compartiendo estado entre procesos,Intercambiando objetos entre procesos,Introducción<7>
@anchor{library/multiprocessing synchronization-between-processes}@anchor{3082}
@subsubsection Sincronización entre procesos


@ref{94,,multiprocessing} contiene equivalentes de todas las sincronizaciones primitivas de @ref{ed,,threading}.  Por ejemplo, se puede usar un candado (`lock') para garantizar que solo un proceso se imprima a la salida estándar a la vez:

@example
from multiprocessing import Process, Lock

def f(l, i):
    l.acquire()
    try:
        print('hello world', i)
    finally:
        l.release()

if __name__ == '__main__':
    lock = Lock()

    for num in range(10):
        Process(target=f, args=(lock, num)).start()
@end example

Sin usar el candado (`lock') de salida de los diferentes procesos, es probable que todo se mezcle.

@node Compartiendo estado entre procesos,Usando una piscina de trabajadores pool of workers,Sincronización entre procesos,Introducción<7>
@anchor{library/multiprocessing sharing-state-between-processes}@anchor{3083}
@subsubsection Compartiendo estado entre procesos


Como se mencionó anteriormente, cuando se realiza una programación concurrente, generalmente es mejor evitar el uso del estado compartido en la medida de lo posible. Esto es particularmente cierto cuando se utilizan múltiples procesos.

Sin embargo, si usted realmente necesita usar algunos datos compartidos el @ref{94,,multiprocessing} proporciona un par de maneras de hacerlo.

`Memoria compartida'

@quotation

Los datos se pueden almacenar en un mapa de memoria compartida usando @ref{3084,,Value} o @ref{3085,,Array}. Por ejemplo, el siguiente código

@example
from multiprocessing import Process, Value, Array

def f(n, a):
    n.value = 3.1415927
    for i in range(len(a)):
        a[i] = -a[i]

if __name__ == '__main__':
    num = Value('d', 0.0)
    arr = Array('i', range(10))

    p = Process(target=f, args=(num, arr))
    p.start()
    p.join()

    print(num.value)
    print(arr[:])
@end example

imprimirá

@example
3.1415927
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
@end example

Los argumentos @code{'d'} y @code{'i'} utilizados al crear @code{num} y @code{arr} son códigos de tipo del tipo utilizado por @ref{8,,array} module: @code{'d'} indica un flotador de doble precisión y @code{'i'} indica un entero con signo. Estos objetos compartidos serán seguros para procesos y subprocesos.

Para una mayor flexibilidad en el uso de la memoria compartida, se puede usar el módulo @ref{9a,,multiprocessing.sharedctypes} que admite la creación arbitraria de objetos `ctypes' asignados desde la memoria compartida.
@end quotation

`Proceso servidor (*Server process*)'

@quotation

Un objeto de administrador retornado por @ref{d42,,Manager()} controla un proceso de servidor que contiene objetos de Python y permite que otros procesos los manipulen usando proxies.

Un administrador retornado por @ref{d42,,Manager()} soportará tipos de clases  como @ref{18e,,list}, @ref{190,,dict}, @ref{3086,,Namespace}, @ref{159b,,Lock}, @ref{159c,,RLock}, @ref{3087,,Semaphore}, @ref{3088,,BoundedSemaphore}, @ref{3089,,Condition}, @ref{186b,,Event}, @ref{308a,,Barrier}, @ref{1803,,Queue}, @ref{3084,,Value} y @ref{3085,,Array}.  Por ejemplo,

@example
from multiprocessing import Process, Manager

def f(d, l):
    d[1] = '1'
    d['2'] = 2
    d[0.25] = None
    l.reverse()

if __name__ == '__main__':
    with Manager() as manager:
        d = manager.dict()
        l = manager.list(range(10))

        p = Process(target=f, args=(d, l))
        p.start()
        p.join()

        print(d)
        print(l)
@end example

imprimirá

@example
@{0.25: None, 1: '1', '2': 2@}
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@end example

Los administradores de procesos del servidor son más flexibles que el uso de objetos de memoria compartida porque pueden hacerse para admitir tipos de objetos arbitrarios. Por lo tanto, un solo administrador puede ser compartido por procesos en diferentes ordenadores a través de una red. Sin embargo, son más lentos que usar memoria compartida.
@end quotation

@node Usando una piscina de trabajadores pool of workers,,Compartiendo estado entre procesos,Introducción<7>
@anchor{library/multiprocessing using-a-pool-of-workers}@anchor{308b}
@subsubsection Usando una piscina de trabajadores (`pool of workers')


La clase @ref{137c,,Pool} representa procesos de piscina de trabajadores (`pool of workers'). Tiene métodos que permiten que las tareas se descarguen a los procesos de trabajo de diferentes maneras.

Por ejemplo:

@example
from multiprocessing import Pool, TimeoutError
import time
import os

def f(x):
    return x*x

if __name__ == '__main__':
    # start 4 worker processes
    with Pool(processes=4) as pool:

        # print "[0, 1, 4,..., 81]"
        print(pool.map(f, range(10)))

        # print same numbers in arbitrary order
        for i in pool.imap_unordered(f, range(10)):
            print(i)

        # evaluate "f(20)" asynchronously
        res = pool.apply_async(f, (20,))      # runs in *only* one process
        print(res.get(timeout=1))             # prints "400"

        # evaluate "os.getpid()" asynchronously
        res = pool.apply_async(os.getpid, ()) # runs in *only* one process
        print(res.get(timeout=1))             # prints the PID of that process

        # launching multiple evaluations asynchronously *may* use more processes
        multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
        print([res.get(timeout=1) for res in multiple_results])

        # make a single worker sleep for 10 seconds
        res = pool.apply_async(time.sleep, (10,))
        try:
            print(res.get(timeout=1))
        except TimeoutError:
            print("We lacked patience and got a multiprocessing.TimeoutError")

        print("For the moment, the pool remains available for more work")

    # exiting the 'with'-block has stopped the pool
    print("Now the pool is closed and no longer available")
@end example

Tenga en cuenta que los métodos de una piscina (`pool') solo deben ser utilizados por el proceso que lo creó.

@cartouche
@quotation Nota 
La funcionalidad en este paquete requiere que los procesos hijos (`children') puedan importar el módulo @code{__main__}. Esto está cubierto en @ref{307d,,Pautas de programación} sin embargo, vale la pena señalarlo aquí. Esto significa que algunos ejemplos, como @ref{137c,,multiprocessing.pool.Pool} no funcionarán en el intérprete interactivo. Por ejemplo:

@example
>>> from multiprocessing import Pool
>>> p = Pool(5)
>>> def f(x):
...     return x*x
...
>>> with p:
...     p.map(f, [1,2,3])
Process PoolWorker-1:
Process PoolWorker-2:
Process PoolWorker-3:
Traceback (most recent call last):
Traceback (most recent call last):
Traceback (most recent call last):
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
@end example

(Si intenta esto, en realidad generará tres trazas completas intercaladas de forma semialeatoria, y luego tendrá que detener el proceso principal de alguna manera)
@end quotation
@end cartouche

@node Referencia<2>,Pautas de programación,Introducción<7>,multiprocessing — Process-based parallelism
@anchor{library/multiprocessing reference}@anchor{308c}
@subsubsection Referencia


El paquete @ref{94,,multiprocessing} mayoritariamente replica la API del módulo @ref{ed,,threading}.

@menu
* Process y excepciones:: 
* Tuberías (Pipes) y Colas (Queues): Tuberías Pipes y Colas Queues. 
* Miscelánea: Miscelánea<2>. 
* Objetos de conexión Connection Objects:: 
* Primitivas de sincronización (Synchronization primitives): Primitivas de sincronización Synchronization primitives. 
* Objetos compartidos ctypes:: 
* Administradores (Managers): Administradores Managers. 
* Objetos Proxy (Proxy Objects): Objetos Proxy Proxy Objects. 
* Piscinas de procesos (Process Pools): Piscinas de procesos Process Pools. 
* Oyentes y clientes (Listeners and Clients): Oyentes y clientes Listeners and Clients. 
* Llaves de autentificación:: 
* Logging:: 
* El módulo multiprocessing.dummy: El módulo multiprocessing dummy. 

@end menu

@node Process y excepciones,Tuberías Pipes y Colas Queues,,Referencia<2>
@anchor{library/multiprocessing process-and-exceptions}@anchor{308d}
@subsubsection @code{Process} y excepciones


@geindex Process (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Process}@anchor{be1}
@deffn {Clase} multiprocessing.Process (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None)

Los objetos de proceso representan la actividad que se ejecuta en un proceso separado. La clase @ref{be1,,Process} tiene equivalentes para todos los métodos @ref{9df,,threading.Thread}.

The constructor should always be called with keyword arguments. `group'
should always be @code{None}; it exists solely for compatibility with
@ref{9df,,threading.Thread}.  `target' is the callable object to be invoked by
the @ref{307f,,run()} method.  It defaults to @code{None}, meaning nothing is
called. `name' is the process name (see @ref{308e,,name} for more details).
`args' is the argument tuple for the target invocation.  `kwargs' is a
dictionary of keyword arguments for the target invocation.  If provided,
the keyword-only `daemon' argument sets the process @ref{308f,,daemon} flag
to @code{True} or @code{False}.  If @code{None} (the default), this flag will be
inherited from the creating process.

De forma predeterminada, no se pasan argumentos a `target'. El argumento `args', que por defecto es @code{()}, se puede usar para especificar una lista o tupla de los argumentos para pasar a `target'.

Si una subclase anula al constructor, debe asegurarse de que invoca al constructor de la clase base (@code{Process.__init__()}) antes de hacer cualquier otra cosa al proceso.


Distinto en la versión 3.3: Added the `daemon' parameter.


@geindex run() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process run}@anchor{307f}
@deffn {Método} run ()

Método que representa la actividad del proceso.

Puede anular este método en una subclase. El método estándar @ref{307f,,run()} invoca el objeto invocable pasado al constructor del objeto como argumento objetivo, si lo hay, con argumentos posicionares y de palabras clave tomados de los argumentos `args' y `kwargs', respectivamente.

El uso de una lista o tupla como argumento `args' pasado a @ref{be1,,Process} logra el mismo efecto.

Ejemplo:

@example
>>> from multiprocessing import Process
>>> p = Process(target=print, args=[1])
>>> p.run()
1
>>> p = Process(target=print, args=(1,))
>>> p.run()
1
@end example
@end deffn

@geindex start() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process start}@anchor{307c}
@deffn {Método} start ()

Comienza la actividad del proceso.

Esto debe llamarse como máximo una vez por objeto de proceso. Organiza la invocación del método @ref{307f,,run()} del objeto en un proceso separado.
@end deffn

@geindex join() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process join}@anchor{3090}
@deffn {Método} join ([timeout])

Si el argumento opcional `timeout' es @code{None} (el valor predeterminado), el método se bloquea hasta que el proceso cuyo método @ref{3090,,join()} se llama termina. Si `timeout' es un número positivo, bloquea como máximo `timeout' segundos. Tenga en cuenta que el método retorna @code{None} si su proceso finaliza o si el método agota el tiempo de espera. Verifique el proceso @ref{3091,,exitcode} para determinar si terminó.

Un proceso puede unirse muchas veces.

Un proceso no puede unirse a sí mismo porque esto provocaría un punto muerto. Es un error intentar unirse a un proceso antes de que se haya iniciado.
@end deffn

@geindex name (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process name}@anchor{308e}
@deffn {Atributo} name

El nombre del proceso. El nombre es una cadena utilizada solo con fines de identificación. No tiene semántica. Múltiples procesos pueden tener el mismo nombre.

El nombre inicial es establecido por el constructor. Si no se proporciona un nombre explícito al constructor, se forma un nombre usando `“Process-N:sub:`1`:N:sub:`2`:…:N:sub:`k`”' se construye, donde cada `N:sub:`k`' es el `N-enésimo' hijo del parental.
@end deffn

@geindex is_alive() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process is_alive}@anchor{3092}
@deffn {Método} is_alive ()

Retorna si el proceso está vivo.

Aproximadamente, un objeto de proceso está vivo desde el momento en que el método @ref{307c,,start()} retorna hasta que finaliza el proceso hijo.
@end deffn

@geindex daemon (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process daemon}@anchor{308f}
@deffn {Atributo} daemon

La bandera del proceso `daemon' , es un valor booleano. Esto debe establecerse antes de que @ref{307c,,start()} sea llamado.

El valor inicial se hereda del proceso de creación.

Cuando un proceso sale, intenta terminar todos sus procesos demoníacos (`daemonic') hijos.

Tenga en cuenta que un proceso demoníaco (`daemonic') no puede crear procesos hijos. De lo contrario, un proceso demoníaco (`daemonic') dejaría a sus hijos huérfanos si se termina cuando finaliza su proceso parental. Además, estos `no' son `daemons' o servicios de Unix, son procesos normales qué finalizarán (y no se unirán) si los procesos no demoníacos han salido.
@end deffn

Además de API @ref{9df,,threading.Thread}, los objetos @ref{be1,,Process} también admiten los siguientes atributos y métodos:

@geindex pid (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process pid}@anchor{3093}
@deffn {Atributo} pid

Retorna el ID del proceso. Antes de que se genere el proceso, esto será @code{None}.
@end deffn

@geindex exitcode (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process exitcode}@anchor{3091}
@deffn {Atributo} exitcode

El código de salida del proceso secundario. Será @code{None} si el proceso aún no ha finalizado.

Si el método @ref{307f,,run()} del proceso secundario se retornó normalmente, el código de salida será 0. Si terminó a través de @ref{13b0,,sys.exit()} con un argumento entero `N', el código de salida será `N'.

Si el proceso secundario finalizó debido a una excepción no capturada dentro de @ref{307f,,run()}, el código de salida será 1. Si fue terminado por la señal `N', el código de salida será el valor negativo `-N'.
@end deffn

@geindex authkey (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process authkey}@anchor{3094}
@deffn {Atributo} authkey

La clave de autenticación del proceso (una cadena de bytes).

Cuando el @ref{94,,multiprocessing} se inicializa el proceso principal se le asigna una cadena aleatoria usando @ref{5c6,,os.urandom()}.

Cuando se crea un objeto @ref{be1,,Process}, este heredará la clave de autenticación de su proceso parental, aunque esto puede cambiarse configurando @ref{3094,,authkey} a otra cadena de bytes.

Consulte @ref{3095,,Llaves de autentificación}.
@end deffn

@geindex sentinel (atributo de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process sentinel}@anchor{1154}
@deffn {Atributo} sentinel

Un identificador numérico de un objeto del sistema que estará «listo» cuando finalice el proceso.

You can use this value if you want to wait on several events at
once using @ref{1153,,multiprocessing.connection.wait()}.  Otherwise
calling @ref{3090,,join()} is simpler.

On Windows, this is an OS handle usable with the @code{WaitForSingleObject}
and @code{WaitForMultipleObjects} family of API calls.  On POSIX, this is
a file descriptor usable with primitives from the @ref{c1,,select} module.


Added in version 3.3.

@end deffn

@geindex terminate() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process terminate}@anchor{3096}
@deffn {Método} terminate ()

Terminate the process.  On POSIX this is done using the @ref{141f,,SIGTERM} signal;
on Windows @code{TerminateProcess()} is used.  Note that exit handlers and
finally clauses, etc., will not be executed.

Tenga en cuenta que los procesos descendientes del proceso `no' finalizarán – simplemente quedarán huérfanos.

@cartouche
@quotation Advertencia 
Si este método se usa cuando el proceso asociado está usando una tubería (`pipe') o una cola(`queue'), entonces la tubería o la cola pueden corromperse y pueden quedar inutilizables por otro proceso. Del mismo modo, si el proceso ha adquirido un `lock' o un semáforo, etc., su finalización puede provocar el bloqueo de otros procesos.
@end quotation
@end cartouche
@end deffn

@geindex kill() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process kill}@anchor{be0}
@deffn {Método} kill ()

Same as @ref{3096,,terminate()} but using the @code{SIGKILL} signal on POSIX.


Added in version 3.7.

@end deffn

@geindex close() (método de multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process close}@anchor{bdf}
@deffn {Método} close ()

El cierre del objeto @ref{be1,,Process}, libera todos los recursos asociados a él.  @ref{360,,ValueError} se lanza si el proceso subyacente aún se está ejecutando. Una vez @ref{bdf,,close()} se retorna con éxito, la mayoría de los otros métodos y atributos del objeto @ref{be1,,Process} lanzará @ref{360,,ValueError}.


Added in version 3.7.

@end deffn

Tenga en cuenta que los métodos @ref{307c,,start()}, @ref{3090,,join()}, @ref{3092,,is_alive()}, @ref{3096,,terminate()} y @ref{3091,,exitcode} deberían solo ser llamados por el proceso que creó el objeto del proceso.

Ejemplo de uso de algunos métodos de la @ref{be1,,Process}:

@example
>>> import multiprocessing, time, signal
>>> mp_context = multiprocessing.get_context('spawn')
>>> p = mp_context.Process(target=time.sleep, args=(1000,))
>>> print(p, p.is_alive())
<...Process ... initial> False
>>> p.start()
>>> print(p, p.is_alive())
<...Process ... started> True
>>> p.terminate()
>>> time.sleep(0.1)
>>> print(p, p.is_alive())
<...Process ... stopped exitcode=-SIGTERM> False
>>> p.exitcode == -signal.SIGTERM
True
@end example
@end deffn

@geindex ProcessError
@anchor{library/multiprocessing multiprocessing ProcessError}@anchor{3097}
@deffn {Excepción} multiprocessing.ProcessError

La clase base de todas las excepciones @ref{94,,multiprocessing}.
@end deffn

@geindex BufferTooShort
@anchor{library/multiprocessing multiprocessing BufferTooShort}@anchor{3098}
@deffn {Excepción} multiprocessing.BufferTooShort

Exception raised by @code{Connection.recv_bytes_into()} when the supplied
buffer object is too small for the message read.

Si @code{e} es una instancia de @ref{3098,,BufferTooShort} entonces @code{e.args[0]} dará el mensaje como una cadena de `bytes'.
@end deffn

@geindex AuthenticationError
@anchor{library/multiprocessing multiprocessing AuthenticationError}@anchor{3099}
@deffn {Excepción} multiprocessing.AuthenticationError

Lanzada cuando hay un error de autenticación.
@end deffn

@geindex TimeoutError
@anchor{library/multiprocessing multiprocessing TimeoutError}@anchor{309a}
@deffn {Excepción} multiprocessing.TimeoutError

Lanzada por métodos con un tiempo de espera (`timeout') cuando este expira.
@end deffn

@node Tuberías Pipes y Colas Queues,Miscelánea<2>,Process y excepciones,Referencia<2>
@anchor{library/multiprocessing pipes-and-queues}@anchor{309b}
@subsubsection Tuberías (`Pipes') y Colas (`Queues')


Cuando se usan múltiples procesos, uno generalmente usa el paso de mensajes para la comunicación entre procesos y evita tener que usar primitivas de sincronización como `locks'.

Para pasar mensajes se puede usar @ref{3081,,Pipe()} (para una conexión entre dos procesos) o una cola (`queue')(que permite múltiples productores y consumidores).

Los tipos @ref{1803,,Queue}, @ref{9aa,,SimpleQueue} y @ref{309c,,JoinableQueue} son colas multi-productor, multi-consumidor @abbr{FIFO} (primero en entrar, primero en salir) modeladas en @ref{13ee,,queue.Queue} en la biblioteca estándar. Se diferencian en que @ref{1803,,Queue} carece de @ref{309d,,task_done()} y @ref{309e,,join()} métodos introducidos en Python 2.5 @ref{13ee,,queue.Queue} class.

Si usa @ref{309c,,JoinableQueue}, entonces `debe' llamar a @ref{309f,,JoinableQueue.task_done()} para cada tarea eliminada de la cola (`queue') o de lo contrario el semáforo utilizado para contar el número de tareas sin terminar puede eventualmente desbordarse, lanzando un excepción.

One difference from other Python queue implementations, is that @ref{94,,multiprocessing}
queues serializes all objects that are put into them using @ref{a6,,pickle}.
The object return by the get method is a re-created object that does not share memory
with the original object.

Tenga en cuenta que también se puede crear una cola compartida mediante el uso de un objeto de administrador – consulte @ref{30a0,,Administradores (Managers)}.

@cartouche
@quotation Nota 
@ref{94,,multiprocessing} utiliza las excepciones habituales @ref{30a1,,queue.Empty} y @ref{30a2,,queue.Full} para indicar un tiempo de espera. No están disponibles en el espacio de nombres @ref{94,,multiprocessing}, por lo que debe importarlos desde @ref{b6,,queue}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Cuando un objeto se coloca en una cola (`queue'), el objeto se serializa (`pickled') y luego un subproceso de fondo vacía los datos serializados a una tubería (`pipe') subyacente. Esto tiene algunas consecuencias que son un poco sorprendentes, pero no deberían causar dificultades prácticas: si realmente causan molestias, se puede usar una cola creada con un @ref{30a0,,manager}.


@enumerate 

@item 
Después de poner un objeto en una cola vacía, puede haber un retraso infinitesimal antes de que el método de la cola @ref{1606,,empty()} retorne @ref{bbf,,False} y @ref{30a3,,get_nowait()} puede retornar sin lanzar @ref{30a1,,queue.Empty}.

@item 
Si varios procesos están poniendo en cola objetos, es posible que los objetos se reciban en el otro extremo fuera de orden. Sin embargo, los objetos en cola por el mismo proceso siempre estarán en el orden esperado entre sí.
@end enumerate
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Si se termina un proceso usando @ref{3096,,Process.terminate()} o @ref{13c7,,os.kill()} mientras intenta usar una clase @ref{1803,,Queue}, es probable que los datos de la cola(`queue') se corrompan. Esto puede hacer que cualquier otro proceso obtenga una excepción cuando intente usar la cola más adelante.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Como se mencionó anteriormente, si un proceso hijo ha puesto elementos en una cola (`queue') (y no ha utilizado @ref{30a4,,JoinableQueue.cancel_join_thread}), entonces ese proceso no terminará hasta que todos los elementos almacenados en búfer hayan sido vaciados a la tubería (`pipe').

Esto significa que si intenta unirse a ese proceso, puede obtener un punto muerto a menos que esté seguro de que todos los elementos que se han puesto en la cola (`queue') se han consumido. Del mismo modo, si el proceso hijo no es `daemonic', el proceso parental puede bloquearse en la salida cuando intenta unir todos sus elementos hijos no `daemonic'.

Tenga en cuenta que una cola (`queue') creada con un administrador no tiene este problema. Consulte @ref{307d,,Pautas de programación}.
@end quotation
@end cartouche

Para ver un ejemplo del uso de colas para la comunicación entre procesos, consulte @ref{30a5,,Ejemplos}.

@geindex Pipe() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Pipe}@anchor{3081}
@deffn {Función} multiprocessing.Pipe ([duplex])

Retorna un par de objetos ``@w{`}(conn1, conn2)`@w{`}' de la @ref{15e3,,Connection} que representan los extremos de una tubería (`pipe').

Si `duplex' es @code{True} (el valor predeterminado), entonces la tubería (`pipe') es bidireccional. Si `duplex' es @code{False}, entonces la tubería es unidireccional: @code{conn1} solo se puede usar para recibir mensajes y @code{conn2} solo se puede usar para enviar mensajes.

The @code{send()} method serializes the the object using
@ref{a6,,pickle} and the @code{recv()} re-creates the object.
@end deffn

@geindex Queue (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Queue}@anchor{1803}
@deffn {Clase} multiprocessing.Queue ([maxsize])

Retorna un proceso de cola (`queue') compartida implementado utilizando una tubería (`pipe') y algunos candados/semáforos (`locks/semaphores'). Cuando un proceso pone por primera vez un elemento en la cola, se inicia un hilo alimentador que transfiere objetos desde un búfer a la tubería.

Las excepciones habituales @ref{30a1,,queue.Empty} y @ref{30a2,,queue.Full} del módulo de la biblioteca estándar @ref{b6,,queue} se generan para indicar tiempos de espera.

La @ref{1803,,Queue} implementa todos los métodos de la @ref{13ee,,queue.Queue} excepto por @ref{309d,,task_done()} y @ref{309e,,join()}.

@geindex qsize() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue qsize}@anchor{30a6}
@deffn {Método} qsize ()

Retorna el tamaño aproximado de la cola (`queue'). Debido a la semántica multiproceso/multiprocesamiento, este número no es confiable.

Note that this may raise @ref{384,,NotImplementedError} on platforms like
macOS where @code{sem_getvalue()} is not implemented.
@end deffn

@geindex empty() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue empty}@anchor{1606}
@deffn {Método} empty ()

Retorna @code{True} si la cola (`queue') está vacía, de lo contrario retorna @code{False} . Debido a la semántica multiproceso/multiprocesamiento, esto no es confiable.

May raise an @ref{4d5,,OSError} on closed queues. (not guaranteed)
@end deffn

@geindex full() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue full}@anchor{30a7}
@deffn {Método} full ()

Retorna @code{True} si la cola (`queue') está llena, de lo contrario retorna @code{False} . Debido a la semántica multiproceso/multiprocesamiento, esto no es confiable.
@end deffn

@geindex put() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue put}@anchor{1a43}
@deffn {Método} put (obj[, block[, timeout]])

Pone `obj' en la cola. Si el argumento opcional `block' es @code{True} (el valor predeterminado) y `timeout' es @code{None} (el valor predeterminado), se bloquea si es necesario hasta que haya un espacio disponible. Si `timeout' es un número positivo, bloquea a lo sumo `timeout' segundos y genera la excepción @ref{30a2,,queue.Full} si no hay espacio libre disponible en ese tiempo. De lo contrario (`block' es @code{False}), y coloca un elemento en la cola si hay un espacio libre disponible de inmediato, de lo contrario, genera la excepción @ref{30a2,,queue.Full} (`timeout' se ignora en ese caso).


Distinto en la versión 3.8: Si la cola (`queue') está cerrada, @ref{360,,ValueError} se lanza en lugar de @ref{74a,,AssertionError}.

@end deffn

@geindex put_nowait() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue put_nowait}@anchor{30a8}
@deffn {Método} put_nowait (obj)

Equivalente a @code{put(obj, False)}.
@end deffn

@geindex get() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue get}@anchor{1a44}
@deffn {Método} get ([block[, timeout]])

Elimina y retorna un artículo de la cola (`queue'). Si un argumento opcional `block' es @code{True} (el valor predeterminado) y el `timeout' es @code{None} (el valor predeterminado), es bloqueado si es necesario hasta que un elemento esté disponible. Si el `timeout' es un número positivo, bloquea a lo sumo segundos y genera la excepción @ref{30a1,,queue.Empty} si no había ningún elemento disponible dentro de ese tiempo. De lo contrario (el bloque es @code{False}), retorna un elemento si hay uno disponible de inmediato, de lo contrario, levante la excepción @ref{30a1,,queue.Empty} (`timeout' se ignora en ese caso).


Distinto en la versión 3.8: Si la cola está cerrada, se lanza @ref{360,,ValueError} en lugar de @ref{4d5,,OSError}.

@end deffn

@geindex get_nowait() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue get_nowait}@anchor{30a3}
@deffn {Método} get_nowait ()

Equivalente a @code{get(False)}.
@end deffn

La @ref{1803,,multiprocessing.Queue} tiene algunos métodos adicionales que no se encuentran en @ref{13ee,,queue.Queue}. Estos métodos suelen ser innecesarios para la mayoría de los códigos:

@geindex close() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue close}@anchor{1804}
@deffn {Método} close ()

Indica que el proceso actual no colocará más datos en esta cola (`queue'). El subproceso en segundo plano se cerrará una vez que haya vaciado todos los datos almacenados en la tubería (`pipe'). Esto se llama automáticamente cuando la cola es recolectada por el recolector de basura.
@end deffn

@geindex join_thread() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue join_thread}@anchor{30a9}
@deffn {Método} join_thread ()

Unifica al hilo de fondo. Esto solo se puede usar después de que se ha llamado a @ref{1804,,close()}. Esto se bloquea hasta que salga el hilo de fondo, asegurando que todos los datos en el búfer se hayan vaciado a la tubería (`pipe').

Por defecto, si un proceso no es el creador de la cola (`queue'), al salir intentará unirse al hilo de fondo de la cola. El proceso puede llamar a @ref{30a4,,cancel_join_thread()} para hacer que el @ref{30a9,,join_thread()} no haga nada.
@end deffn

@geindex cancel_join_thread() (método de multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue cancel_join_thread}@anchor{30a4}
@deffn {Método} cancel_join_thread ()

Evita que @ref{30a9,,join_thread()} bloquee. En particular, esto evita que el subproceso en segundo plano se una automáticamente cuando finaliza el proceso; consulte @ref{30a9,,join_thread()}.

Un mejor nombre para este método podría ser @code{allow_exit_without_flush()}.  Es probable que provoque la pérdida de datos encolados, y es casi seguro que no necesitará usarlo. Realmente solo está allí si necesita que el proceso actual salga inmediatamente sin esperar a vaciar los datos en en la tubería (`pipe') subyacente, y no le importan los datos perdidos.
@end deffn

@cartouche
@quotation Nota 
La funcionalidad de esta clase requiere una implementación de semáforo compartido en funcionamiento en el sistema operativo que es huésped (`host'). Sin uno, la funcionalidad en esta clase se deshabilitará, y los intentos de instanciar a @ref{1803,,Queue} resultarán en @ref{4d7,,ImportError}. Consulte bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} para información adicional. Lo mismo es válido para cualquiera de los tipos de cola especializados que se enumeran a continuación.
@end quotation
@end cartouche
@end deffn

@geindex SimpleQueue (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing SimpleQueue}@anchor{9aa}
@deffn {Clase} multiprocessing.SimpleQueue

Es un tipo simplificado @ref{1803,,Queue}, muy similar a un `lock' de @ref{3081,,Pipe}.

@geindex close() (método de multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue close}@anchor{9ab}
@deffn {Método} close ()

Cierra la cola: libera recursos internos.

Una cola no se debe usar más después de ser cerrada. Por ejemplo los métodos @ref{30aa,,get()}, @ref{30ab,,put()} y @ref{1607,,empty()} no deben ser llamados.


Added in version 3.9.

@end deffn

@geindex empty() (método de multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue empty}@anchor{1607}
@deffn {Método} empty ()

Retorna @code{True} si la cola (`queue') está vacía, de otra manera retorna @code{False}.

Always raises an @ref{4d5,,OSError} if the SimpleQueue is closed.
@end deffn

@geindex get() (método de multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue get}@anchor{30aa}
@deffn {Método} get ()

Eliminar y retornar un artículo de la cola (`queue').
@end deffn

@geindex put() (método de multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue put}@anchor{30ab}
@deffn {Método} put (item)

Pone `item' en la cola.
@end deffn
@end deffn

@geindex JoinableQueue (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing JoinableQueue}@anchor{309c}
@deffn {Clase} multiprocessing.JoinableQueue ([maxsize])

@ref{309c,,JoinableQueue}, una subclase @ref{1803,,Queue} , es una cola (`queue') que además tiene los métodos @ref{309f,,task_done()} y @ref{30ac,,join()}.

@geindex task_done() (método de multiprocessing.JoinableQueue)
@anchor{library/multiprocessing multiprocessing JoinableQueue task_done}@anchor{309f}
@deffn {Método} task_done ()

Indica que una tarea anteriormente en cola (`queue') está completa. Usado por los consumidores de la cola. Por cada @ref{1a44,,get()} utilizado para recuperar una tarea, una llamada posterior a @ref{309f,,task_done()} le dice a la cola que el procesamiento de la tarea se ha completado.

Si un @ref{309e,,join()} se está bloqueando actualmente, se reanudará cuando se hayan procesado todos los elementos (lo que significa que @ref{309f,,task_done()} es llamado para cada elemento que había sido puesto en cola (`queue') por @ref{1a43,,put()}).

Lanza un @ref{360,,ValueError} si es llamado más veces que elementos hay en una cola.
@end deffn

@geindex join() (método de multiprocessing.JoinableQueue)
@anchor{library/multiprocessing multiprocessing JoinableQueue join}@anchor{30ac}
@deffn {Método} join ()

Se bloquea hasta que todos los elementos en una cola han sido recibidos y procesados.

El recuento de tareas no finalizadas aumenta cada vez que se agrega un elemento a la cola. El recuento disminuye cada vez que un consumidor llama a @ref{309f,,task_done()} para indicar que el artículo se recuperó y todo el trabajo en él está completo. Cuando el recuento de tareas inacabadas cae a cero, @ref{309e,,join()} se desbloquea.
@end deffn
@end deffn

@node Miscelánea<2>,Objetos de conexión Connection Objects,Tuberías Pipes y Colas Queues,Referencia<2>
@anchor{library/multiprocessing miscellaneous}@anchor{30ad}
@subsubsection Miscelánea


@geindex active_children() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing active_children}@anchor{30ae}
@deffn {Función} multiprocessing.active_children ()

Retorna una lista con todos los hijos del proceso actual.

Llamar a esto tiene el efecto secundario de «unir» (`joining') cualquier proceso que ya haya finalizado.
@end deffn

@geindex cpu_count() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing cpu_count}@anchor{fee}
@deffn {Función} multiprocessing.cpu_count ()

Retorna el número de CPU en el sistema.

This number is not equivalent to the number of CPUs the current process can
use.  The number of usable CPUs can be obtained with
@ref{327,,os.process_cpu_count()} (or @code{len(os.sched_getaffinity(0))}).

Cuando no se puede determinar el número de CPUs, se lanza un @ref{384,,NotImplementedError}.


@subsubheading Ver también


@ref{328,,os.cpu_count()}
@ref{327,,os.process_cpu_count()}



Distinto en la versión 3.13: The return value can also be overridden using the
@ref{2e2,,-X cpu_count} flag or 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT} as this is
merely a wrapper around the @ref{a1,,os} cpu count APIs.

@end deffn

@geindex current_process() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing current_process}@anchor{30af}
@deffn {Función} multiprocessing.current_process ()

Retorna el objeto de la @ref{be1,,Process} correspondiente al proceso actual.

Un análogo de la @ref{203,,threading.current_thread()}.
@end deffn

@geindex parent_process() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing parent_process}@anchor{30b0}
@deffn {Función} multiprocessing.parent_process ()

Retorna el objeto de la @ref{be1,,Process} correspondiente al proceso parental de @ref{30af,,current_process()}. Para el proceso principal, @code{parent_process} será @code{None}.


Added in version 3.8.

@end deffn

@geindex freeze_support() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing freeze_support}@anchor{30b1}
@deffn {Función} multiprocessing.freeze_support ()

Agrega soporte para cuando un programa que utiliza @ref{94,,multiprocessing} se haya congelado para producir un ejecutable de Windows. (Ha sido probado con `py2exe', `PyInstaller' y `cx_Freeze'.)

Es necesario llamar a esta función inmediatamente después de la línea principal del módulo @code{if __name__ == '__main__'} . Por ejemplo:

@example
from multiprocessing import Process, freeze_support

def f():
    print('hello world!')

if __name__ == '__main__':
    freeze_support()
    Process(target=f).start()
@end example

Si se omite la línea @code{freeze_support()} entonces se intenta comenzar el ejecutable congelado que lanzará @ref{1e5,,RuntimeError}.

La llamada de @code{freeze_support()} no tiene efecto cuando es invocada por cualquier sistema operativo que no sea Windows. Además, si el módulo ha sido ejecutado en un intérprete de Python en Windows (y el programa no se ha congelado) entonces @code{freeze_support()} no tiene efecto.
@end deffn

@geindex get_all_start_methods() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_all_start_methods}@anchor{fe9}
@deffn {Función} multiprocessing.get_all_start_methods ()

Returns a list of the supported start methods, the first of which
is the default.  The possible start methods are @code{'fork'},
@code{'spawn'} and @code{'forkserver'}.  Not all platforms support all
methods.  See @ref{162,,Contextos y métodos de inicio}.


Added in version 3.4.

@end deffn

@geindex get_context() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_context}@anchor{18b}
@deffn {Función} multiprocessing.get_context (method=None)

Retorna un objeto de contexto que tiene los mismos atributos que el módulo @ref{94,,multiprocessing}.

If `method' is @code{None} then the default context is returned.
Otherwise `method' should be @code{'fork'}, @code{'spawn'},
@code{'forkserver'}.  @ref{360,,ValueError} is raised if the specified
start method is not available.  See @ref{162,,Contextos y métodos de inicio}.


Added in version 3.4.

@end deffn

@geindex get_start_method() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_start_method}@anchor{fea}
@deffn {Función} multiprocessing.get_start_method (allow_none=False)

Retorna el nombre del método de inicio que es utilizado para iniciar procesos.

Si el método de inicio no se ha solucionado y `allow_none' es falso, entonces el método de inicio se fija al predeterminado y se retorna el nombre. Si el método de inicio no se ha solucionado y `allow_none' es verdadero, se retorna @code{None}.

The return value can be @code{'fork'}, @code{'spawn'}, @code{'forkserver'}
or @code{None}.  See @ref{162,,Contextos y métodos de inicio}.


Added in version 3.4.



Distinto en la versión 3.8: En macOS, el método de inicio `spawn' ahora es el predeterminado. El método de inicio `fork' debe considerarse inseguro ya que puede provocar bloqueos del subproceso. Consulte bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.

@end deffn

@geindex set_executable() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_executable}@anchor{180c}
@deffn {Función} multiprocessing.set_executable (executable)

Establezca la ruta del intérprete de Python para usar al iniciar un proceso secundario. (Por defecto se usa @ref{283,,sys.executable}). Los integradores probablemente necesitarán hacer algo como

@example
set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))
@end example

antes ellos pueden crear procesos hijos.


Distinto en la versión 3.4: Now supported on POSIX when the @code{'spawn'} start method is used.



Distinto en la versión 3.11: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex set_forkserver_preload() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_forkserver_preload}@anchor{1599}
@deffn {Función} multiprocessing.set_forkserver_preload (module_names)

Set a list of module names for the forkserver main process to attempt to
import so that their already imported state is inherited by forked
processes. Any @ref{4d7,,ImportError} when doing so is silently ignored.
This can be used as a performance enhancement to avoid repeated work
in every process.

For this to work, it must be called before the forkserver process has been
launched (before creating a @code{Pool} or starting a @ref{be1,,Process}).

Only meaningful when using the @code{'forkserver'} start method.
See @ref{162,,Contextos y métodos de inicio}.


Added in version 3.4.

@end deffn

@geindex set_start_method() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_start_method}@anchor{18c}
@deffn {Función} multiprocessing.set_start_method (method, force=False)

Set the method which should be used to start child processes.
The `method' argument can be @code{'fork'}, @code{'spawn'} or @code{'forkserver'}.
Raises @ref{1e5,,RuntimeError} if the start method has already been set and `force'
is not @code{True}.  If `method' is @code{None} and `force' is @code{True} then the start
method is set to @code{None}.  If `method' is @code{None} and `force' is @code{False}
then the context is set to the default context.

Tenga en cuenta que esto debería llamarse como máximo una vez, y debería protegerse dentro de la cláusula @code{if __name__ == '__main__'} del módulo principal.

See @ref{162,,Contextos y métodos de inicio}.


Added in version 3.4.

@end deffn

@cartouche
@quotation Nota 
@ref{94,,multiprocessing} no contiene análogos de @ref{204,,threading.active_count()}, @ref{18ae,,threading.enumerate()}, @ref{8df,,threading.settrace()}, @ref{8e0,,threading.setprofile()}, @ref{11ca,,threading.Timer}, o @ref{1773,,threading.local}.
@end quotation
@end cartouche

@node Objetos de conexión Connection Objects,Primitivas de sincronización Synchronization primitives,Miscelánea<2>,Referencia<2>
@anchor{library/multiprocessing connection-objects}@anchor{30b2}
@subsubsection Objetos de conexión `Connection Objects'


Los objetos de conexión permiten el envío y la recepción de objetos serializables (`pickable') o cadenas de caracteres seleccionables. Pueden considerarse como sockets conectados orientados a mensajes.

Los objetos de conexión usualmente son creados usando @ref{3081,,Pipe} – ver también @ref{30b3,,Oyentes y clientes (Listeners and Clients)}.

@geindex Connection (clase en multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Connection}@anchor{15e3}
@deffn {Clase} multiprocessing.connection.Connection

@geindex send() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection send}@anchor{30b4}
@deffn {Método} send (obj)

Envía un objeto al otro extremo de la conexión que debe leerse usando @ref{30b5,,recv()}.

El objeto debe ser serializable (`pickable'). Los serializados (`pickable') muy grandes (aproximadamente 32 `MiB+' , aunque depende del sistema operativo) pueden generar una excepción @ref{360,,ValueError}.
@end deffn

@geindex recv() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv}@anchor{30b5}
@deffn {Método} recv ()

Retorna un objeto enviado desde el otro extremo de la conexión usando @ref{30b4,,send()}. Se bloquea hasta que haya algo para recibir. Se lanza @ref{1341,,EOFError} si no queda nada por recibir y el otro extremo está cerrado.
@end deffn

@geindex fileno() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection fileno}@anchor{30b6}
@deffn {Método} fileno ()

Retorna el descriptor de archivo o identificador utilizado por la conexión.
@end deffn

@geindex close() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection close}@anchor{30b7}
@deffn {Método} close ()

Cierra la conexión.

Esto se llama automáticamente cuando la conexión es basura recolectada.
@end deffn

@geindex poll() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection poll}@anchor{30b8}
@deffn {Método} poll ([timeout])

Retorna si hay datos disponibles para leer.

Si no se especifica `timeout', se retornará de inmediato. Si `timeout' es un número, esto especifica el tiempo máximo en segundos para bloquear. Si `timeout' es @code{None}, se usa un tiempo de espera infinito.

Tenga en cuenta que se pueden sondear varios objetos de conexión a la vez utilizando @ref{1153,,multiprocessing.connection.wait()}.
@end deffn

@geindex send_bytes() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection send_bytes}@anchor{30b9}
@deffn {Método} send_bytes (buffer[, offset[, size]])

Envía datos de `bytes' desde a @ref{db4,,bytes-like object} como un mensaje completo.

Si se da `offset', los datos se leen desde esa posición en `buffer'. Si se da `size' entonces se leerán muchos `bytes' del búfer. Los `buffers' muy grandes (aproximadamente `32 MiB+', aunque depende del sistema operativo) pueden generar una excepción @ref{360,,ValueError}
@end deffn

@geindex recv_bytes() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes}@anchor{30ba}
@deffn {Método} recv_bytes ([maxlength])

Retorna un mensaje completo de datos de `bytes' enviados desde el otro extremo de la conexión como una cadena de caracteres. Se bloquea hasta que haya algo para recibir. Aumenta @ref{1341,,EOFError} si no queda nada por recibir y el otro extremo se ha cerrado.

Si se especifica `maxlength' y el mensaje es más largo que `maxlength', entonces se lanza un @ref{4d5,,OSError} y la conexión ya no será legible.


Distinto en la versión 3.3: Esta función solía lanzar un @ref{10ce,,IOError}, que ahora es un alias de @ref{4d5,,OSError}.

@end deffn

@geindex recv_bytes_into() (método de multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes_into}@anchor{30bb}
@deffn {Método} recv_bytes_into (buffer[, offset])

Lee en `buffer' un mensaje completo de datos de `bytes' enviados desde el otro extremo de la conexión y retorne el número de `bytes' en el mensaje. Se bloquea hasta que haya algo para recibir. Si no queda nada por recibir y el otro extremo está cerrándose se lanza @ref{1341,,EOFError}.

`buffer' debe ser un escribible @ref{db4,,bytes-like object}. Si se proporciona `offset' el mensaje se escribirá en el búfer desde esa posición. La compensación debe ser un número entero no negativo menor que la longitud de `buffer' (en `bytes').

Si el búfer es demasiado corto, se genera una excepción @code{BufferTooShort} y el mensaje completo está disponible como @code{e.args[0]} donde @code{e} es la instancia de excepción.
@end deffn


Distinto en la versión 3.3: Los objetos de conexión ahora pueden transferirse entre procesos usando @ref{30b4,,Connection.send()} y @ref{30b5,,Connection.recv()}.

Connection objects also now support the context management protocol – see
@ref{1fbf,,Tipos gestores de contexto}.  @ref{224d,,__enter__()} returns the
connection object, and @ref{224e,,__exit__()} calls @ref{30b7,,close()}.

@end deffn

Por ejemplo:

@example
>>> from multiprocessing import Pipe
>>> a, b = Pipe()
>>> a.send([1, 'hello', None])
>>> b.recv()
[1, 'hello', None]
>>> b.send_bytes(b'thank you')
>>> a.recv_bytes()
b'thank you'
>>> import array
>>> arr1 = array.array('i', range(5))
>>> arr2 = array.array('i', [0] * 10)
>>> a.send_bytes(arr1)
>>> count = b.recv_bytes_into(arr2)
>>> assert count == len(arr1) * arr1.itemsize
>>> arr2
array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0])
@end example
@anchor{library/multiprocessing multiprocessing-recv-pickle-security}@anchor{30bc}
@cartouche
@quotation Advertencia 
El método @ref{30b5,,Connection.recv()} desempaqueta automáticamente los datos que recibe, lo que puede ser un riesgo de seguridad a menos que pueda confiar en el proceso que envió el mensaje.

Por lo tanto, a menos que el objeto de conexión se haya producido usando @code{Pipe()} solo debe usar los métodos @ref{30b5,,recv()} y @ref{30b4,,send()} después de realizar algún tipo de autenticación. Consulte @ref{3095,,Llaves de autentificación}.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Si se mata un proceso mientras intenta leer o escribir en una tubería (`pipe'), entonces es probable que los datos en la tubería se corrompan, porque puede ser imposible estar seguro de dónde se encuentran los límites del mensaje.
@end quotation
@end cartouche

@node Primitivas de sincronización Synchronization primitives,Objetos compartidos ctypes,Objetos de conexión Connection Objects,Referencia<2>
@anchor{library/multiprocessing synchronization-primitives}@anchor{30bd}
@subsubsection Primitivas de sincronización (`Synchronization primitives')


En general, las primitivas de sincronización no son tan necesarias en un programa multiproceso como en un programa `multihilos' (`multithreaded'). Consulte la documentación para @ref{ed,,threading} .

Tenga en cuenta que también se pueden crear primitivas de sincronización utilizando un objeto administrador – consulte @ref{30a0,,Administradores (Managers)}.

@geindex Barrier (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Barrier}@anchor{308a}
@deffn {Clase} multiprocessing.Barrier (parties[, action[, timeout]])

Un objeto de barrera: un clon de @ref{1250,,threading.Barrier}.


Added in version 3.3.

@end deffn

@geindex BoundedSemaphore (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing BoundedSemaphore}@anchor{3088}
@deffn {Clase} multiprocessing.BoundedSemaphore ([value])

Un objeto semáforo (`semaphore object') acotado: un análogo cercano de la @ref{11c8,,threading.BoundedSemaphore}.

Existe una diferencia solitaria de su análogo cercano: el primer argumento de su método @code{acquire} es nombrado `block', es consistente con @ref{30be,,Lock.acquire()}.

@cartouche
@quotation Nota 
En macOS, esto no se puede distinguir de @ref{3087,,Semaphore} porque @code{sem_getvalue()} no está implementado en esa plataforma.
@end quotation
@end cartouche
@end deffn

@geindex Condition (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Condition}@anchor{3089}
@deffn {Clase} multiprocessing.Condition ([lock])

Una variable de condición: un alias para la @ref{11c6,,threading.Condition}.

Si se especifica `lock', entonces debería ser una @ref{159b,,Lock} o @ref{159c,,RLock} objeto de @ref{94,,multiprocessing}.


Distinto en la versión 3.3: El método @ref{3063,,wait_for()} fue a añadido.

@end deffn

@geindex Event (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Event}@anchor{186b}
@deffn {Clase} multiprocessing.Event

Un clon de @ref{11c9,,threading.Event}.
@end deffn

@geindex Lock (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Lock}@anchor{159b}
@deffn {Clase} multiprocessing.Lock

Un objeto candado no recursivo: un análogo cercano de @ref{1682,,threading.Lock} . Una vez que un proceso o subproceso ha adquirido un bloqueo, los intentos posteriores de adquirirlo de cualquier proceso o subproceso se bloquearán hasta que se libere; cualquier proceso o hilo puede liberarlo. Los conceptos y comportamientos de @ref{1682,,threading.Lock} como se aplica a los subprocesos se replican aquí en @ref{159b,,multiprocessing.Lock} como se aplica a los procesos o subprocesos, excepto como se indica.

Tenga en cuenta que @ref{159b,,Lock} es en realidad una función de fábrica que retorna una instancia de @code{multiprocessing.synchronize.Lock} inicializada con un contexto predeterminado.

La @ref{159b,,Lock} soporta el protocolo @ref{675,,context manager} y, por lo tanto, se puede usar en la declaración @ref{673,,with}.

@geindex acquire() (método de multiprocessing.Lock)
@anchor{library/multiprocessing multiprocessing Lock acquire}@anchor{30be}
@deffn {Método} acquire (block=True, timeout=None)

Adquiriendo un candado (`lock'), bloqueante o no bloqueante.

Con el argumento `block' establecido en @code{True} (el valor predeterminado), la llamada al método se bloqueará hasta que el bloqueo esté en un estado desbloqueado, luego configúrelo como bloqueado y retorne @code{True}. Tenga en cuenta que el nombre de este primer argumento difiere del que aparece en @ref{739,,threading.Lock.acquire()}.

Con el argumento `block' establecido en @code{False}, la llamada al método no se bloquea. Si el bloqueo está actualmente en un estado bloqueado, retorna @code{False}; de lo contrario, configure el bloqueo en un estado bloqueado y retorne @code{True}.

Cuando se invoca con un valor positivo de punto flotante para `timeout', bloquea como máximo el número de segundos especificado por `timeout' siempre que no se pueda obtener el bloqueo. Las invocaciones con un valor negativo para `timeout' de cero. Las invocaciones con un valor `timeout' de @code{None} (el valor predeterminado) establecen el período de tiempo de espera en infinito. Tenga en cuenta que el tratamiento de valores negativos o @code{None} para `timeout' difiere del comportamiento implementado en @ref{739,,threading.Lock.acquire()}. El argumento `timeout' no tiene implicaciones prácticas si el argumento `block' se establece en @code{False} y, por lo tanto, se ignora. Retorna @code{True} si se ha adquirido el candado o @code{False} si ha transcurrido el tiempo de espera.
@end deffn

@geindex release() (método de multiprocessing.Lock)
@anchor{library/multiprocessing multiprocessing Lock release}@anchor{30bf}
@deffn {Método} release ()

Suelta un candado. Esto se puede llamar desde cualquier proceso o subproceso, no solo desde el proceso o subproceso que originalmente adquirió el candado.

El comportamiento es el mismo que en @ref{132c,,threading.Lock.release()} excepto que cuando se invoca en un bloqueo desbloqueado, se genera a @ref{360,,ValueError}.
@end deffn
@end deffn

@geindex RLock (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing RLock}@anchor{159c}
@deffn {Clase} multiprocessing.RLock

Un objeto de candado recursivo: un análogo cercano a @ref{1d7,,threading.RLock}. El proceso o el hilo que lo adquirió debe liberar un candado recursivo. Una vez que un proceso o subproceso ha adquirido un candado recursivo, el mismo proceso o subproceso puede volver a adquirirlo sin bloquearlo; ese proceso o hilo debe liberarlo una vez por cada vez que se haya adquirido.

Tenga en cuenta que @ref{159c,,RLock} es en realidad una función de fábrica que retorna una instancia de @code{multiprocessing.synchronize.RLock} inicializada con un contexto predeterminado.

La @ref{159c,,RLock} admite el protocolo @ref{675,,context manager} y, por lo tanto, puede usarse en @ref{673,,with}.

@geindex acquire() (método de multiprocessing.RLock)
@anchor{library/multiprocessing multiprocessing RLock acquire}@anchor{30c0}
@deffn {Método} acquire (block=True, timeout=None)

Adquiriendo un candado (`lock'), bloqueante o no bloqueante.

Cuando se invoca con el argumento `block' establecido en @code{True} , bloquea hasta que el candado esté en un estado desbloqueado (que no sea propiedad de ningún proceso o subproceso) a menos que el candado o el subproceso actual ya sea de su propiedad. El proceso o subproceso actual se apropia del candado (si aún no lo tiene) y el nivel de recursión dentro de este  aumenta en uno, lo que da como resultado un valor de retorno de @code{True}. Tenga en cuenta que hay varias diferencias en el comportamiento de este primer argumento en comparación con la implementación de @ref{efe,,threading.RLock.acquire()}, comenzando con el nombre del argumento en sí.

Cuando se invoca con el argumento `block' establecido en @code{False}, no bloquea. Si el candado ya ha sido adquirido (y por lo tanto es propiedad) de otro proceso o subproceso, el proceso o subproceso actual no se apropia y el nivel de recursión dentro del candado no cambia, lo que resulta en un valor de retorno de @code{False}. Si el candado está en un estado desbloqueado, el proceso o subproceso actual toma posesión y el nivel de recurrencia se incrementa, lo que resulta en un valor de retorno de @code{True}.

El uso y los comportamientos del argumento `timeout' son los mismos que en @ref{30be,,Lock.acquire()}. Tenga en cuenta que algunos de estos comportamientos de `timeout' difieren de los comportamientos implementados en @ref{efe,,threading.RLock.acquire()}.
@end deffn

@geindex release() (método de multiprocessing.RLock)
@anchor{library/multiprocessing multiprocessing RLock release}@anchor{30c1}
@deffn {Método} release ()

Libera un candado, disminuyendo el nivel de recursión. Si después del decremento el nivel de recursión es cero, restablece el candado a desbloqueado (que no sea propiedad de ningún proceso o subproceso) y si se bloquean otros procesos o subprocesos esperando que el candado se desbloquee, permite que continúe exactamente uno de ellos. Si después del decremento el nivel de recursión sigue siendo distinto de cero, el candado permanece bloqueado y pertenece al proceso de llamada o subproceso.

Solo llame a este método cuando el proceso o subproceso de llamada sea el propietario del candado. Se lanza un @ref{74a,,AssertionError} si se llama a este método mediante un proceso o subproceso que no sea el propietario o si el candado está en un estado desbloqueado (sin propietario). Tenga en cuenta que el tipo de excepción planteada en esta situación difiere del comportamiento implementado en @ref{305e,,threading.RLock.release()}.
@end deffn
@end deffn

@geindex Semaphore (clase en multiprocessing)
@anchor{library/multiprocessing multiprocessing Semaphore}@anchor{3087}
@deffn {Clase} multiprocessing.Semaphore ([value])

Un objeto semáforo: un análogo cercano de @ref{11c7,,threading.Semaphore}.

Existe una diferencia solitaria de su análogo cercano: el primer argumento de su método @code{acquire} es nombrado `block', es consistente con @ref{30be,,Lock.acquire()}.
@end deffn

@cartouche
@quotation Nota 
En macOS, @code{sem_timedwait} no es compatible, por lo que llamar a @code{acquire()} con un tiempo de espera emulará el comportamiento de esa función utilizando un bucle inactivo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Parte de la funcionalidad de este paquete requiere una implementación de semáforo compartido que funcione en el sistema operativo. Sin uno, el módulo @code{multiprocessing.synchronize} se desactivará, y los intentos de importarlo darán como resultado @ref{4d7,,ImportError}. Consulte bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} para información adicional.
@end quotation
@end cartouche

@node Objetos compartidos ctypes,Administradores Managers,Primitivas de sincronización Synchronization primitives,Referencia<2>
@anchor{library/multiprocessing shared-ctypes-objects}@anchor{30c2}
@subsubsection Objetos compartidos @code{ctypes}


Es posible crear objetos compartidos utilizando memoria compartida que puede ser heredada por procesos secundarios.

@geindex Value() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Value}@anchor{3084}
@deffn {Función} multiprocessing.Value (typecode_or_type, *args, lock=True)

Retorna un objeto @ref{2b,,ctypes} asignado desde la memoria compartida. Por defecto, el valor de retorno es en realidad un contenedor sincronizado para el objeto. Se puede acceder al objeto en sí a través del atributo `value' de la @ref{3084,,Value}.

`typecode_or_type' determina el tipo del objeto retornado: es un tipo `ctypes' o un código de tipo de un carácter del tipo utilizado por el módulo @ref{8,,array}. `*args' se pasa al constructor para el tipo.

Si `lock' es @code{True} (el valor predeterminado), se crea un nuevo objeto de candado recursivo para sincronizar el acceso al valor. Si `lock' es un objeto @ref{159b,,Lock} o @ref{159c,,RLock}, se usará para sincronizar el acceso al valor. Si `lock' es @code{False}, entonces el acceso al objeto retornado no estará protegido automáticamente por un candado, por lo que no será necesariamente «proceso-seguro».

Operaciones como @code{+=} que implican una lectura y escritura no son atómicas. Entonces, si, por ejemplo, desea incrementar atómicamente un valor compartido, es insuficiente simplemente hacer:

@example
counter.value += 1
@end example

Suponiendo que el candado asociado es recursivo (que es por defecto), puede hacer

@example
with counter.get_lock():
    counter.value += 1
@end example

Véase que `lock' es un argumento de solo una palabra clave.
@end deffn

@geindex Array() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Array}@anchor{3085}
@deffn {Función} multiprocessing.Array (typecode_or_type, size_or_initializer, *, lock=True)

Retorna una matriz `ctypes' asignada desde la memoria compartida. Por defecto, el valor de retorno es en realidad un contenedor sincronizado para el arreglo.

`typecode_or_type' determina el tipo de los elementos de la matriz retornada: es un tipo de tipo `ctypes' o un código de tipo de un carácter del tipo utilizado por el módulo @ref{8,,array}. Si `size_or_initializer' es un número entero, entonces determina la longitud de la matriz, y la matriz se pondrá a cero inicialmente. De lo contrario, `size_or_initializer' es una secuencia que se utiliza para inicializar la matriz y cuya longitud determina la longitud de la matriz.

Si `lock' es @code{True} (el valor predeterminado), se crea un nuevo objeto de bloqueo para sincronizar el acceso al valor. Si `lock' es un objeto @ref{159b,,Lock} o @ref{159c,,RLock}, se usará para sincronizar el acceso al valor. Si `lock' es @code{False}, entonces el acceso al objeto retornado no estará protegido automáticamente por un candado, por lo que no será necesariamente «proceso seguro».

Véase que `lock' es un argumento de solo una palabra clave.

Tenga en cuenta que una matriz de @ref{2fce,,ctypes.c_char} tiene atributos `value' y `raw' que le permiten a uno usarlo para almacenar y recuperar cadenas de caracteres.
@end deffn

@menu
* El módulo multiprocessing.sharedctypes: El módulo multiprocessing sharedctypes. 

@end menu

@node El módulo multiprocessing sharedctypes,,,Objetos compartidos ctypes
@anchor{library/multiprocessing module-multiprocessing sharedctypes}@anchor{9a}@anchor{library/multiprocessing the-multiprocessing-sharedctypes-module}@anchor{30c3}
@subsubsection El módulo @code{multiprocessing.sharedctypes}


@geindex module; multiprocessing.sharedctypes

El módulo @ref{9a,,multiprocessing.sharedctypes} proporciona funciones para asignar objetos @ref{2b,,ctypes} de la memoria compartida que pueden ser heredados por procesos secundarios.

@cartouche
@quotation Nota 
Aunque es posible almacenar un puntero en la memoria compartida, recuerde que esto se referirá a una ubicación en el espacio de direcciones de un proceso específico. Sin embargo, es muy probable que el puntero sea inválido en el contexto de un segundo proceso y tratar de desreferenciar el puntero del segundo proceso puede causar un bloqueo.
@end quotation
@end cartouche

@geindex RawArray() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes RawArray}@anchor{30c4}
@deffn {Función} multiprocessing.sharedctypes.RawArray (typecode_or_type, size_or_initializer)

Retorna una matriz `ctypes' asignada desde la memoria compartida.

`typecode_or_type' determina el tipo de los elementos de la matriz retornada: es un tipo de tipo `ctypes' o un código de tipo de un carácter del tipo utilizado por el módulo @ref{8,,array}. Si `size_or_initializer' es un entero, entonces determina la longitud de la matriz, y la matriz se pondrá a cero inicialmente. De lo contrario, `size_or_initializer' es una secuencia que se usa para inicializar la matriz y cuya longitud determina la longitud del arreglo.

Tenga en cuenta que configurar y obtener un elemento es potencialmente no atómico – utiliza @ref{30c5,,Array()} en su lugar para asegurarse de que el acceso se sincronice automáticamente mediante un candado.
@end deffn

@geindex RawValue() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes RawValue}@anchor{30c6}
@deffn {Función} multiprocessing.sharedctypes.RawValue (typecode_or_type, *args)

Retorna un objeto `ctypes' asignado desde la memoria compartida.

`typecode_or_type' determina el tipo del objeto retornado: es un tipo `ctypes' o un código de tipo de un carácter del tipo utilizado por el módulo @ref{8,,array}. `*args' se pasa al constructor para el tipo.

Tenga en cuenta que configurar y obtener el valor es potencialmente no atómico – use @ref{30c7,,Value()} en su lugar para asegurarse de que el acceso se sincronice automáticamente mediante un candado.

Tenga en cuenta que una matriz de @ref{2fce,,ctypes.c_char} tiene atributos @code{value} y @code{raw} que le permiten a uno usarlo para almacenar y recuperar cadenas de caracteres – consulte la documentación para @ref{2b,,ctypes}.
@end deffn

@geindex Array() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes Array}@anchor{30c5}
@deffn {Función} multiprocessing.sharedctypes.Array (typecode_or_type, size_or_initializer, *, lock=True)

Lo mismo que @ref{30c4,,RawArray()}, excepto que, dependiendo del valor de `lock', se puede retornar un contenedor de sincronización seguro para el proceso en lugar de un arreglo de tipos crudos.

Si `lock' es @code{True} (el valor predeterminado), se crea un nuevo objeto candado para sincronizar el acceso al valor. Si `lock' es un objeto @ref{159b,,Lock} o @ref{159c,,RLock}, se utilizará para sincronizar el acceso al valor. Si `lock' es @code{False}, entonces el acceso al objeto retornado no estará protegido automáticamente por un candado, por lo que no será necesariamente «seguro para el proceso».

Véase que `lock' es un argumento de solo una palabra clave.
@end deffn

@geindex Value() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes Value}@anchor{30c7}
@deffn {Función} multiprocessing.sharedctypes.Value (typecode_or_type, *args, lock=True)

Lo mismo que @ref{30c6,,RawValue()} excepto que, dependiendo del valor de `lock', se puede retornar una envoltura de sincronización segura para el proceso en lugar de un objeto `ctypes' sin procesar.

Si `lock' es @code{True} (el valor predeterminado), se crea un nuevo objeto candado para sincronizar el acceso al valor. Si `lock' es un objeto @ref{159b,,Lock} o @ref{159c,,RLock}, se utilizará para sincronizar el acceso al valor. Si `lock' es @code{False}, entonces el acceso al objeto retornado no estará protegido automáticamente por un candado, por lo que no será necesariamente «seguro para el proceso».

Véase que `lock' es un argumento de solo una palabra clave.
@end deffn

@geindex copy() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes copy}@anchor{30c8}
@deffn {Función} multiprocessing.sharedctypes.copy (obj)

Retorna un objeto `ctypes' asignado de la memoria compartida, que es una copia del objeto `ctypes' `obj'.
@end deffn

@geindex synchronized() (en el módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes synchronized}@anchor{eb6}
@deffn {Función} multiprocessing.sharedctypes.synchronized (obj[, lock])

Retorna un objeto contenedor seguro para un objeto `ctypes' que usa `lock' para sincronizar el acceso. Si `lock' es @code{None} (el valor predeterminado), se crea automáticamente un objeto @ref{159c,,multiprocessing.RLock}.

Un contenedor sincronizado tendrá dos métodos además de los del objeto que envuelve: @code{get_obj()} retorna el objeto envuelto y @code{get_lock()} retorna el objeto de bloqueo utilizado para la sincronización.

Tenga en cuenta que acceder al objeto `ctypes' a través del contenedor puede ser mucho más lento que acceder al objeto `ctypes' sin formato.


Distinto en la versión 3.5: Los objetos sincronizados admiten el protocolo: @ref{675,,context manager}.

@end deffn

La siguiente tabla compara la sintaxis para crear objetos `ctypes' compartidos desde la memoria compartida con la sintaxis `ctypes' normal. (En la tabla @code{MyStruct} hay alguna subclase de @ref{166,,ctypes.Structure}.)


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`ctypes'

@tab

`sharedctypes' usando `type'

@tab

`sharedctypes' usando `typecode'

@item

`c_double(2.4)'

@tab

`RawValue(c_double, 2.4)'

@tab

`RawValue(“d”, 2.4)'

@item

`MyStruct(4, 6)'

@tab

`RawValue(MyStruct, 4, 6)'

@tab

@item

`(c_short * 7)()'

@tab

`RawArray(c_short, 7)'

@tab

`RawArray(‘h’, 7)'

@item

`(c_int * 3)(9, 2, 8)'

@tab

`RawArray(c_int, (9, 2, 8))'

@tab

`RawArray(“i”, (9, 2, 8))'

@end multitable


A continuación se muestra un ejemplo donde un número de objetos `ctypes' son modificados por un proceso hijo:

@example
from multiprocessing import Process, Lock
from multiprocessing.sharedctypes import Value, Array
from ctypes import Structure, c_double

class Point(Structure):
    _fields_ = [('x', c_double), ('y', c_double)]

def modify(n, x, s, A):
    n.value **= 2
    x.value **= 2
    s.value = s.value.upper()
    for a in A:
        a.x **= 2
        a.y **= 2

if __name__ == '__main__':
    lock = Lock()

    n = Value('i', 7)
    x = Value(c_double, 1.0/3.0, lock=False)
    s = Array('c', b'hello world', lock=lock)
    A = Array(Point, [(1.875,-6.25), (-5.75,2.0), (2.375,9.5)], lock=lock)

    p = Process(target=modify, args=(n, x, s, A))
    p.start()
    p.join()

    print(n.value)
    print(x.value)
    print(s.value)
    print([(a.x, a.y) for a in A])
@end example

Los resultados impresos son

@example
49
0.1111111111111111
HELLO WORLD
[(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]
@end example

@node Administradores Managers,Objetos Proxy Proxy Objects,Objetos compartidos ctypes,Referencia<2>
@anchor{library/multiprocessing managers}@anchor{30c9}@anchor{library/multiprocessing multiprocessing-managers}@anchor{30a0}
@subsubsection Administradores (`Managers')


Los administradores (`managers') proporcionan una forma de crear datos que se pueden compartir entre diferentes procesos, incluido el intercambio en una red entre procesos que se ejecutan en diferentes máquinas. Un objeto administrador controla un proceso de servidor que gestiona `shared objects' (`objetos compartidos'). Otros procesos pueden acceder a los objetos compartidos mediante el uso de servidores proxy.

@geindex built-in function; multiprocessing.Manager()
@anchor{library/multiprocessing multiprocessing Manager}@anchor{d42}
@deffn {Función} multiprocessing.Manager ()

Retorna un objeto iniciado @ref{30ca,,SyncManager} que se puede usar para compartir objetos entre procesos. El objeto administrador retornado corresponde a un proceso hijo generado y tiene métodos que crearán objetos compartidos y retornarán los proxies correspondientes.
@end deffn

@geindex module; multiprocessing.managers
@anchor{library/multiprocessing module-multiprocessing managers}@anchor{97}
Los procesos del administrador se cerrarán tan pronto como se recolecte la basura o salga su proceso padre. Las clases de administrador se definen en el módulo @ref{97,,multiprocessing.managers}:

@geindex BaseManager (clase en multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers BaseManager}@anchor{30cb}
@deffn {Clase} multiprocessing.managers.BaseManager (address=None, authkey=None, serializer='pickle', ctx=None, *, shutdown_timeout=1.0)

Crear un objeto `BaseManager'.

Una vez creado, debe llamar a @ref{30cc,,start()} o @code{get_server().serve_forever()} para asegurarse de que el objeto de administrador se refiera a un proceso de administrador iniciado.

`address' es la dirección en la que el proceso del administrador escucha las nuevas conexiones. Si `address' es @code{None}, se elige una arbitrariamente.

`authkey' es la clave de autenticación que se utilizará para verificar la validez de las conexiones entrantes al proceso del servidor. Si `authkey' es @code{None}, entonces se usa @code{current_process().authkey}. De lo contrario, se usa `authkey' y debe ser una cadena de `bytes'.

`serializer' debe ser @code{'pickle'} (usar serialización @ref{a6,,pickle}) o @code{'xmlrpclib'} (usar serialización @ref{12d,,xmlrpc.client}).

`ctx' es un objeto de contexto, o @code{None} (utilice el contexto actual). Consulte la función @code{get_context()}.

`shutdown_timeout' es un tiempo de espera en segundos que se utiliza para esperar hasta que el proceso utilizado por el administrador se complete en el método @ref{30cd,,shutdown()}. Si se agota el tiempo de apagado, el proceso finaliza. Si la finalización del proceso también supera el tiempo de espera, el proceso se cancela.


Distinto en la versión 3.11: Se agregó el parámetro `shutdown_timeout'.


@geindex start() (método de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager start}@anchor{30cc}
@deffn {Método} start ([initializer[, initargs]])

Se inicia un subproceso para iniciar el administrador. Si `initializer' no es @code{None}, entonces el subproceso llamará @code{initializer(*initargs)} cuando se inicie.
@end deffn

@geindex get_server() (método de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager get_server}@anchor{30ce}
@deffn {Método} get_server ()

Retorna un objeto @code{Server} que representa el servidor real bajo el control del Administrador. El objeto @code{Server} admite el método @code{serve_forever()}:

@example
>>> from multiprocessing.managers import BaseManager
>>> manager = BaseManager(address=('@w{'}, 50000), authkey=b'abc')
>>> server = manager.get_server()
>>> server.serve_forever()
@end example

@code{Server} tiene un atributo adicional @ref{30cf,,address}.
@end deffn

@geindex connect() (método de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager connect}@anchor{30d0}
@deffn {Método} connect ()

Conecta un objeto de administrador (`manager') local a un proceso de administrador remoto:

@example
>>> from multiprocessing.managers import BaseManager
>>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc')
>>> m.connect()
@end example
@end deffn

@geindex shutdown() (método de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager shutdown}@anchor{30cd}
@deffn {Método} shutdown ()

Detiene el proceso utilizado por el gerente (`manager'). Esto solo está disponible si @ref{30cc,,start()} se ha utilizado para iniciar el proceso del servidor.

Esto se puede llamar múltiples veces.
@end deffn

@geindex register() (método de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager register}@anchor{30d1}
@deffn {Método} register (typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])

Un método de clase que puede usarse para registrar un tipo o invocarse con la clase de administrador (`manager').

`typeid' es un «identificador de tipo» que se utiliza para identificar un tipo particular de objeto compartido. Esto debe ser una cadena de caracteres.

`callable' es un invocable utilizado para crear objetos para este identificador de tipo. Si una instancia de administrador se conectará al servidor utilizando el método @ref{30d0,,connect()}, o si el argumento `create_method' es @code{False}, esto se puede dejar como @code{None}.

`proxytype' es una subclase de @ref{30d2,,BaseProxy} que se usa para crear `proxies' para objetos compartidos con este `typeid'. Si @code{None}, se crea automáticamente una clase proxy.

Se utiliza `exposed' para especificar una secuencia de nombres de métodos a los que se debe permitir el acceso de los servidores proxy para este tipo de identificación utilizando @ref{30d3,,BaseProxy._callmethod()}. (Si `exposed' es @code{None}, entonces @code{proxytype._exposed_} se usa en su lugar si existe). En el caso de que no se especifique una lista expuesta, todos los «métodos públicos» del objeto compartido serán accesibles . (Aquí un «método público» significa cualquier atributo que tenga un método @ref{5fb,,__call__()} y cuyo nombre no comience con @code{'_'}.)

El `method_to_typeid' es una asignación utilizada para especificar el tipo de retorno de los métodos expuestos que deberían retornar un proxy. Asigna nombres de métodos a cadenas `typeid'. (Si `method_to_typeid' es @code{None} entonces @code{proxytype._method_to_typeid} se usa en su lugar si existe). Si el nombre de un método no es una clave de esta asignación o si la asignación es @code{None} entonces el objeto retornado por el método se copiará por valor.

`create_method' determina si un método debe crearse con el nombre `typeid' que se puede usar para indicarle al proceso del servidor que cree un nuevo objeto compartido y retornando un proxy para él. Por defecto es @code{True}.
@end deffn

@ref{30cb,,BaseManager} las instancias también tienen una propiedad de solo lectura:

@geindex address (atributo de multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager address}@anchor{30cf}
@deffn {Atributo} address

La dirección utilizada por el administrador.
@end deffn


Distinto en la versión 3.3: Los objetos de administrador admiten el protocolo de gestión de contexto; consulte @ref{1fbf,,Tipos gestores de contexto}. @ref{224d,,__enter__()} inicia el proceso del servidor (si aún no se ha iniciado) y luego retorna el objeto de administrador. @code{__exit__()} llama @ref{30cd,,shutdown()}.

En versiones anteriores @ref{224d,,__enter__()} no iniciaba el proceso del servidor del administrador si aún no se había iniciado.

@end deffn

@geindex SyncManager (clase en multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers SyncManager}@anchor{30ca}
@deffn {Clase} multiprocessing.managers.SyncManager

Una subclase de @ref{30cb,,BaseManager} que se puede utilizar para la sincronización de procesos. Los objetos de este tipo son retornados por @ref{d42,,multiprocessing.Manager()}.

Sus métodos crean y retornan @ref{18d,,Objetos Proxy (Proxy Objects)} para varios tipos de datos de uso común que se sincronizarán entre procesos. Esto incluye notablemente listas compartidas y diccionarios.

@geindex Barrier() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Barrier}@anchor{30d4}
@deffn {Método} Barrier (parties[, action[, timeout]])

@ref{1250,,threading.Barrier} crea un objeto compartido y retorna un proxy para él.


Added in version 3.3.

@end deffn

@geindex BoundedSemaphore() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager BoundedSemaphore}@anchor{30d5}
@deffn {Método} BoundedSemaphore ([value])

Crea un objeto compartido @ref{11c8,,threading.BoundedSemaphore} y retorna un proxy para él.
@end deffn

@geindex Condition() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Condition}@anchor{30d6}
@deffn {Método} Condition ([lock])

Crea un objeto compartido @ref{11c6,,threading.Condition} y retorna un proxy para él.

Si se proporciona `lock', debería ser un proxy para un objeto @ref{1682,,threading.Lock} o @ref{1d7,,threading.RLock}.


Distinto en la versión 3.3: El método @ref{3063,,wait_for()} fue a añadido.

@end deffn

@geindex Event() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Event}@anchor{30d7}
@deffn {Método} Event ()

Crea un objeto compartido @ref{11c9,,threading.Event} y retorna un proxy para él.
@end deffn

@geindex Lock() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Lock}@anchor{30d8}
@deffn {Método} Lock ()

Crea un objeto compartido @ref{1682,,threading.Lock} y retorna un proxy para él.
@end deffn

@geindex Namespace() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Namespace}@anchor{30d9}
@deffn {Método} Namespace ()

Crea un objeto compartido @ref{3086,,Namespace} y retorna un proxy para él.
@end deffn

@geindex Queue() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Queue}@anchor{2d39}
@deffn {Método} Queue ([maxsize])

Crea un objeto compartido @ref{13ee,,queue.Queue} y retorna un proxy para él.
@end deffn

@geindex RLock() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager RLock}@anchor{30da}
@deffn {Método} RLock ()

Crea un objeto compartido @ref{1d7,,threading.RLock} y retorna un proxy para él.
@end deffn

@geindex Semaphore() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Semaphore}@anchor{30db}
@deffn {Método} Semaphore ([value])

Crea un objeto compartido @ref{11c7,,threading.Semaphore} y retorna un proxy para él.
@end deffn

@geindex Array() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Array}@anchor{30dc}
@deffn {Método} Array (typecode, sequence)

Crea un arreglo y retorna un proxy para ello.
@end deffn

@geindex Value() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Value}@anchor{30dd}
@deffn {Método} Value (typecode, value)

Crea un objeto con un atributo de escritura @code{value} y retorna un proxy para él.
@end deffn

@geindex dict() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager dict}@anchor{30de}
@deffn {Método} dict ()

@deffnx {Método} dict (mapping)

@deffnx {Método} dict (sequence)

Crea un objeto compartido @ref{190,,dict} y retorna un proxy para él.
@end deffn

@geindex list() (método de multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager list}@anchor{30df}
@deffn {Método} list ()

@deffnx {Método} list (sequence)

Crea un objeto compartido @ref{18e,,list} y retorna un proxy para él.
@end deffn


Distinto en la versión 3.6: Los objetos compartidos pueden anidarse. Por ejemplo, un objeto contenedor compartido, como una lista compartida, puede contener otros objetos compartidos que serán administrados y sincronizados por @ref{30ca,,SyncManager}.

@end deffn

@geindex Namespace (clase en multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers Namespace}@anchor{3086}
@deffn {Clase} multiprocessing.managers.Namespace

Un tipo que puede registrarse con @ref{30ca,,SyncManager}.

Un objeto de espacio de nombres no tiene métodos públicos, pero tiene atributos de escritura. Su representación muestra los valores de sus atributos.

Sin embargo, cuando se usa un proxy para un objeto de espacio de nombres, un atributo que comience con @code{'_'} será un atributo del proxy y no un atributo del referente:

@example
>>> mp_context = multiprocessing.get_context('spawn')
>>> manager = mp_context.Manager()
>>> Global = manager.Namespace()
>>> Global.x = 10
>>> Global.y = 'hello'
>>> Global._z = 12.3    # this is an attribute of the proxy
>>> print(Global)
Namespace(x=10, y='hello')
@end example
@end deffn

@menu
* Administradores customizables (Customized managers): Administradores customizables Customized managers. 
* Utilizando un administrador remoto:: 

@end menu

@node Administradores customizables Customized managers,Utilizando un administrador remoto,,Administradores Managers
@anchor{library/multiprocessing customized-managers}@anchor{30e0}
@subsubsection Administradores customizables (`Customized managers')


Para crear su propio administrador, uno crea una subclase de @ref{30cb,,BaseManager} y utiliza el método de clase @ref{30d1,,register()} para registrar nuevos tipos o llamadas con la clase de administrador. Por ejemplo:

@example
from multiprocessing.managers import BaseManager

class MathsClass:
    def add(self, x, y):
        return x + y
    def mul(self, x, y):
        return x * y

class MyManager(BaseManager):
    pass

MyManager.register('Maths', MathsClass)

if __name__ == '__main__':
    with MyManager() as manager:
        maths = manager.Maths()
        print(maths.add(4, 3))         # prints 7
        print(maths.mul(7, 8))         # prints 56
@end example

@node Utilizando un administrador remoto,,Administradores customizables Customized managers,Administradores Managers
@anchor{library/multiprocessing using-a-remote-manager}@anchor{30e1}
@subsubsection Utilizando un administrador remoto


Es posible ejecutar un servidor administrador en una máquina y hacer que los clientes lo usen desde otras máquinas (suponiendo que los cortafuegos involucrados lo permitan).

La ejecución de los siguientes comandos crea un servidor para una única cola compartida a la que los clientes remotos pueden acceder:

@example
>>> from multiprocessing.managers import BaseManager
>>> from queue import Queue
>>> queue = Queue()
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue', callable=lambda:queue)
>>> m = QueueManager(address=('@w{'}, 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
@end example

Un cliente puede tener accesos al servidor de la siguiente manera:

@example
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.put('hello')
@end example

Otro cliente puede también usarlo:

@example
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.get()
'hello'
@end example

Los procesos locales también pueden acceder a esa cola (`queue'), utilizando el código de arriba en el cliente para acceder de forma remota:

@example
>>> from multiprocessing import Process, Queue
>>> from multiprocessing.managers import BaseManager
>>> class Worker(Process):
...     def __init__(self, q):
...         self.q = q
...         super().__init__()
...     def run(self):
...         self.q.put('local hello')
...
>>> queue = Queue()
>>> w = Worker(queue)
>>> w.start()
>>> class QueueManager(BaseManager): pass
...
>>> QueueManager.register('get_queue', callable=lambda: queue)
>>> m = QueueManager(address=('@w{'}, 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
@end example

@node Objetos Proxy Proxy Objects,Piscinas de procesos Process Pools,Administradores Managers,Referencia<2>
@anchor{library/multiprocessing multiprocessing-proxy-objects}@anchor{18d}@anchor{library/multiprocessing proxy-objects}@anchor{30e2}
@subsubsection Objetos Proxy (`Proxy Objects')


Un proxy es un objeto que `se refiere' a un objeto compartido que vive (presumiblemente) en un proceso diferente. Se dice que el objeto compartido es el `referente' del proxy. Varios objetos proxy pueden tener el mismo referente.

Un objeto proxy tiene métodos que invocan los métodos correspondientes de su referente (aunque no todos los métodos del referente estarán necesariamente disponibles a través del proxy). De esta manera, un proxy se puede usar al igual que su referente:

@example
>>> mp_context = multiprocessing.get_context('spawn')
>>> manager = mp_context.Manager()
>>> l = manager.list([i*i for i in range(10)])
>>> print(l)
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> print(repr(l))
<ListProxy object, typeid 'list' at 0x...>
>>> l[4]
16
>>> l[2:5]
[4, 9, 16]
@end example

Tenga en cuenta que la aplicación @ref{237,,str()} a un proxy retornará la representación del referente, mientras que la aplicación @ref{894,,repr()} retornará la representación del proxy.

Una característica importante de los objetos proxy es que son seleccionables para que puedan pasarse entre procesos. Como tal, un referente puede contener @ref{18d,,Objetos Proxy (Proxy Objects)}. Esto permite anidar estas listas administradas, dictados y otros @ref{18d,,Objetos Proxy (Proxy Objects)}:

@example
>>> a = manager.list()
>>> b = manager.list()
>>> a.append(b)         # referent of a now contains referent of b
>>> print(a, b)
[<ListProxy object, typeid 'list' at ...>] []
>>> b.append('hello')
>>> print(a[0], b)
['hello'] ['hello']
@end example

Del mismo modo, los proxies `dict' y `list' pueden estar anidados uno dentro del otro:

@example
>>> l_outer = manager.list([ manager.dict() for i in range(2) ])
>>> d_first_inner = l_outer[0]
>>> d_first_inner['a'] = 1
>>> d_first_inner['b'] = 2
>>> l_outer[1]['c'] = 3
>>> l_outer[1]['z'] = 26
>>> print(l_outer[0])
@{'a': 1, 'b': 2@}
>>> print(l_outer[1])
@{'c': 3, 'z': 26@}
@end example

Si los objetos estándar (no proxy) @ref{18e,,list} or @ref{190,,dict} están contenidos en un referente, las modificaciones a esos valores mutables no se propagarán a través del administrador porque el proxy no tiene forma de saber cuándo los valores contenidos dentro son modificados. Sin embargo, almacenar un valor en un proxy de contenedor (que desencadena un @code{__setitem__} en el objeto proxy) se propaga a través del administrador y, por lo tanto, para modificar efectivamente dicho elemento, uno podría reasignar el valor modificado al proxy de contenedor:

@example
# create a list proxy and append a mutable object (a dictionary)
lproxy = manager.list()
lproxy.append(@{@})
# now mutate the dictionary
d = lproxy[0]
d['a'] = 1
d['b'] = 2
# at this point, the changes to d are not yet synced, but by
# updating the dictionary, the proxy is notified of the change
lproxy[0] = d
@end example

Este enfoque es quizás menos conveniente que emplear anidado @ref{18d,,Objetos Proxy (Proxy Objects)} para la mayoría de los casos de uso, pero también demuestra un nivel de control sobre la sincronización.

@cartouche
@quotation Nota 
Los tipos de proxy en @ref{94,,multiprocessing} no hacen nada para admitir comparaciones por valor. Entonces, por ejemplo, tenemos:

@example
>>> manager.list([1,2,3]) == [1,2,3]
False
@end example

En su lugar, se debe usar una copia del referente al hacer comparaciones.
@end quotation
@end cartouche

@geindex BaseProxy (clase en multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers BaseProxy}@anchor{30d2}
@deffn {Clase} multiprocessing.managers.BaseProxy

Los objetos proxy son instancias de subclases de @ref{30d2,,BaseProxy}.

@geindex _callmethod() (método de multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy _callmethod}@anchor{30d3}
@deffn {Método} _callmethod (methodname[, args[, kwds]])

Llama y retorna el resultado de un método del referente del proxy.

Si @code{proxy} es un proxy cuyo referente es @code{obj} entonces la expresión

@example
proxy._callmethod(methodname, args, kwds)
@end example

evaluará la expresión

@example
getattr(obj, methodname)(*args, **kwds)
@end example

en el proceso del administrador.

El valor retornado será una copia del resultado de la llamada o un proxy a un nuevo objeto compartido; consulte la documentación del argumento `method_to_typeid' de @ref{30d1,,BaseManager.register()}.

Si la llamada genera una excepción, entonces se vuelve a generar @ref{30d3,,_callmethod()}. Si se genera alguna otra excepción en el proceso del administrador, esto se convierte en una excepción @code{RemoteError} y se genera mediante  @ref{30d3,,_callmethod()}.

Tenga en cuenta en particular que se lanzará una excepción si `methodname' no ha sido `exposed'.

Un ejemplo de uso de @ref{30d3,,_callmethod()}:

@example
>>> l = manager.list(range(10))
>>> l._callmethod('__len__')
10
>>> l._callmethod('__getitem__', (slice(2, 7),)) # equivalent to l[2:7]
[2, 3, 4, 5, 6]
>>> l._callmethod('__getitem__', (20,))          # equivalent to l[20]
Traceback (most recent call last):
...
IndexError: list index out of range
@end example
@end deffn

@geindex _getvalue() (método de multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy _getvalue}@anchor{30e3}
@deffn {Método} _getvalue ()

Retorna una copia del referente.

Si el referente no se puede deserializar (`unpicklable'), esto lanzará una excepción.
@end deffn

@geindex __repr__() (método de multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy __repr__}@anchor{30e4}
@deffn {Método} __repr__ ()

Retorna una representación de un objeto proxy.
@end deffn

@geindex __str__() (método de multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy __str__}@anchor{30e5}
@deffn {Método} __str__ ()

Retorna una representación del referente.
@end deffn
@end deffn

@menu
* Limpieza (Cleanup): Limpieza Cleanup. 

@end menu

@node Limpieza Cleanup,,,Objetos Proxy Proxy Objects
@anchor{library/multiprocessing cleanup}@anchor{30e6}
@subsubsection Limpieza (`Cleanup')


Un objeto proxy utiliza una devolución de llamada (`callback') de referencia débil (`weakref') para que cuando sea recolectado por el recolector de basura se da de baja del administrador que posee su referente.

Un objeto compartido se elimina del proceso del administrador cuando ya no hay ningún proxy que se refiera a él.

@node Piscinas de procesos Process Pools,Oyentes y clientes Listeners and Clients,Objetos Proxy Proxy Objects,Referencia<2>
@anchor{library/multiprocessing module-multiprocessing pool}@anchor{98}@anchor{library/multiprocessing process-pools}@anchor{30e7}
@subsubsection Piscinas de procesos (`Process Pools')


@geindex module; multiprocessing.pool

Se puede crear un grupo de procesos que llevarán a cabo las tareas que se le presenten con la  @ref{137c,,Pool} class.

@geindex Pool (clase en multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool Pool}@anchor{137c}
@deffn {Clase} multiprocessing.pool.Pool ([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])

Un objeto de grupo de procesos que controla un grupo de procesos de trabajo a los que se pueden enviar trabajos. Admite resultados asincrónicos con tiempos de espera y devoluciones de llamada y tiene una implementación de mapa paralelo.

`processes' is the number of worker processes to use.  If `processes' is
@code{None} then the number returned by @ref{327,,os.process_cpu_count()} is used.

Si `initializer' no es @code{None}, cada proceso de trabajo llamará @code{initializer(*initargs)} cuando se inicie.

`maxtasksperchild' es el número de tareas que un proceso de trabajo puede completar antes de salir y ser reemplazado por un proceso de trabajo nuevo, para permitir que se liberen los recursos no utilizados. El valor predeterminado `maxtasksperchild' es @code{None}, lo que significa que los procesos de trabajo vivirán tanto tiempo como el grupo.

`context' se puede utilizar para especificar el contexto utilizado para iniciar los procesos de trabajo. Por lo general, un grupo se crea utilizando la función @code{multiprocessing.Pool()} o el método de un objeto de contexto @ref{137c,,Pool()}. En ambos casos, `context' se establece de manera adecuada.

Tenga en cuenta que los métodos del objeto de grupo solo deben ser invocados por el proceso que creó el grupo.

@cartouche
@quotation Advertencia 
Los objetos @ref{98,,multiprocessing.pool} tienen recursos internos que necesitan ser administrados adecuadamente (como cualquier otro recurso) utilizando el grupo como administrador de contexto o llamando a @ref{30e8,,close()} y @ref{30e9,,terminate()} manualmente. De lo contrario, el proceso puede demorarse en la finalización.

Tenga en cuenta que `no es correcto' confiar en el recolector de basura para destruir el grupo ya que `CPython' no asegura que se llamará al finalizador del grupo (consulte @ref{1f60,,object.__del__()} para obtener más información).
@end quotation
@end cartouche


Distinto en la versión 3.2: Added the `maxtasksperchild' parameter.



Distinto en la versión 3.4: Added the `context' parameter.



Distinto en la versión 3.13: `processes' uses @ref{327,,os.process_cpu_count()} by default, instead of
@ref{328,,os.cpu_count()}.


@cartouche
@quotation Nota 
Los procesos de los trabajadores dentro de una @ref{137c,,Pool} normalmente viven durante la duración completa de la cola de trabajo de la piscina. Un patrón frecuente que se encuentra en otros sistemas (como `Apache, mod_wsgi,' etc.) para liberar recursos en poder de los trabajadores es permitir que un trabajador dentro de un grupo complete solo una cantidad determinada de trabajo antes de salir, limpiarse y generar un nuevo proceso para reemplazar el viejo. El argumento `maxtasksperchild' para @ref{137c,,Pool} expone esta capacidad al usuario final.
@end quotation
@end cartouche

@geindex apply() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool apply}@anchor{30ea}
@deffn {Método} apply (func[, args[, kwds]])

Llama a `func' con argumentos `args' y argumentos de palabras clave `kwds'. Se bloquea hasta que el resultado esté listo. Dados estos bloques, @ref{30eb,,apply_async()} es más adecuado para realizar trabajos en paralelo. Además, `func' solo se ejecuta en uno de los trabajadores de piscina.
@end deffn

@geindex apply_async() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool apply_async}@anchor{30eb}
@deffn {Método} apply_async (func[, args[, kwds[, callback[, error_callback]]]])

Una variante del método @ref{30ea,,apply()} que retorna un objeto @ref{30ec,,AsyncResult}.

Si se especifica `callback', debería ser un invocable que acepte un único argumento. Cuando el resultado está listo, se le aplica `callback', a menos que la llamada falle, en cuyo caso se aplica `error_callback'.

Si se especifica `error_callback', debería ser un invocable que acepte un único argumento. Si la función de destino falla, se llama a `error_callback' con la instancia de excepción.

Las devoluciones de llamada deben completarse inmediatamente ya que de lo contrario el hilo que maneja los resultados se bloqueará.
@end deffn

@geindex map() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool map}@anchor{1158}
@deffn {Método} map (func, iterable[, chunksize])

Un equivalente paralelo de la función incorporada @ref{14c,,map()} (aunque solo admite un argumento `iterable', para varios iterables consulte @ref{1155,,starmap()}). Bloquea hasta que el resultado esté listo.

Este método corta el iterable en varios trozos que envía al grupo de procesos como tareas separadas. El tamaño (aproximado) de estos fragmentos se puede especificar estableciendo `chunksize' en un entero positivo.

Tenga en cuenta que puede causar un alto uso de memoria para iterables muy largos. Considere usar @ref{30ed,,imap()} o @ref{30ee,,imap_unordered()} con la opción explícita `chunksize' para una mejor eficiencia.
@end deffn

@geindex map_async() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool map_async}@anchor{1159}
@deffn {Método} map_async (func, iterable[, chunksize[, callback[, error_callback]]])

Una variante del método @ref{1158,,map()} que retorna un objeto @ref{30ec,,AsyncResult}.

Si se especifica `callback', debería ser un invocable que acepte un único argumento. Cuando el resultado está listo, se le aplica `callback', a menos que la llamada falle, en cuyo caso se aplica `error_callback'.

Si se especifica `error_callback', debería ser un invocable que acepte un único argumento. Si la función de destino falla, se llama a `error_callback' con la instancia de excepción.

Las devoluciones de llamada deben completarse inmediatamente ya que de lo contrario el hilo que maneja los resultados se bloqueará.
@end deffn

@geindex imap() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool imap}@anchor{30ed}
@deffn {Método} imap (func, iterable[, chunksize])

Una versión más perezosa (`lazier') de @ref{1158,,map()}.

El argumento `chunksize' es el mismo que el utilizado por el método @ref{1158,,map()}. Para iterables muy largos, usar un valor grande para `chunksize' puede hacer que el trabajo se complete `much' (`mucho') más rápido que usar el valor predeterminado de @code{1}.

Además, si `chunksize' es @code{1}, el método @code{next()} del iterador retornado por el método @ref{30ed,,imap()} tiene un parámetro opcional `timeout' :@code{next (timeout)} lanzará  @ref{309a,,multiprocessing.TimeoutError} si el resultado no puede retornarse dentro de `timeout' segundos.
@end deffn

@geindex imap_unordered() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool imap_unordered}@anchor{30ee}
@deffn {Método} imap_unordered (func, iterable[, chunksize])

Lo mismo que @ref{30ed,,imap()}, excepto que el orden de los resultados del iterador retornado debe considerarse arbitrario. (Solo cuando hay un solo proceso de trabajo se garantiza que el orden sea «correcto»).
@end deffn

@geindex starmap() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool starmap}@anchor{1155}
@deffn {Método} starmap (func, iterable[, chunksize])

Como @ref{1158,,map()}, excepto que se espera que los elementos de `iterable' sean iterables que se desempaquetan como argumentos.

Por lo tanto, un `iterable' de @code{[(1,2), (3, 4)]} da como resultado @code{[func(1,2), func(3,4)]}.


Added in version 3.3.

@end deffn

@geindex starmap_async() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool starmap_async}@anchor{1156}
@deffn {Método} starmap_async (func, iterable[, chunksize[, callback[, error_callback]]])

Una combinación de @ref{1155,,starmap()} y @ref{1159,,map_async()} que itera sobre `iterable' de iterables y llama a `func' con los iterables desempaquetados. Como resultado se retorna un objeto.


Added in version 3.3.

@end deffn

@geindex close() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool close}@anchor{30e8}
@deffn {Método} close ()

Impide que se envíen más tareas a la piscina (`pool'). Una vez que se hayan completado todas las tareas, se cerrarán los procesos de trabajo.
@end deffn

@geindex terminate() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool terminate}@anchor{30e9}
@deffn {Método} terminate ()

Detiene los procesos de trabajo inmediatamente sin completar el trabajo pendiente. Cuando el objeto del grupo es basura recolectada @ref{30e9,,terminate()} se llamará inmediatamente.
@end deffn

@geindex join() (método de multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool join}@anchor{30ef}
@deffn {Método} join ()

Espera a que salgan los procesos de trabajo. Se debe llamar @ref{30e8,,close()} o @ref{30e9,,terminate()} antes de usar @ref{30ef,,join()}.
@end deffn


Distinto en la versión 3.3: Los objetos de piscina (`pool') ahora admiten el protocolo de administración de contexto; consulte @ref{1fbf,,Tipos gestores de contexto}. @code{__ enter__()} retorna el objeto de grupo, y @code{__ exit__()} llama @ref{30e9,,terminate()}.

@end deffn

@geindex AsyncResult (clase en multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool AsyncResult}@anchor{30ec}
@deffn {Clase} multiprocessing.pool.AsyncResult

La clase del resultado retornado por @ref{30eb,,Pool.apply_async()} y @ref{1159,,Pool.map_async()}.

@geindex get() (método de multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult get}@anchor{30f0}
@deffn {Método} get ([timeout])

Retorna el resultado cuando llegue. Si `timeout' no es @code{None} y el resultado no llega dentro de `timeout' segundos, entonces se lanza @ref{309a,,multiprocessing.TimeoutError}. Si la llamada remota generó una excepción, esa excepción se volverá a plantear mediante @ref{30f0,,get()}.
@end deffn

@geindex wait() (método de multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult wait}@anchor{30f1}
@deffn {Método} wait ([timeout])

Espera hasta que el resultado esté disponible o hasta que pase `timeout' segundos.
@end deffn

@geindex ready() (método de multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult ready}@anchor{30f2}
@deffn {Método} ready ()

Retorna si la llamada se ha completado.
@end deffn

@geindex successful() (método de multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult successful}@anchor{30f3}
@deffn {Método} successful ()

Retorna si la llamada se completó sin generar una excepción. Lanzará @ref{360,,ValueError} si el resultado no está listo.


Distinto en la versión 3.7: Si el resultado no está listo @ref{360,,ValueError} aparece en lugar de @ref{74a,,AssertionError}.

@end deffn
@end deffn

El siguiente ejemplo demuestra el uso de una piscina(`pool'):

@example
from multiprocessing import Pool
import time

def f(x):
    return x*x

if __name__ == '__main__':
    with Pool(processes=4) as pool:         # start 4 worker processes
        result = pool.apply_async(f, (10,)) # evaluate "f(10)" asynchronously in a single process
        print(result.get(timeout=1))        # prints "100" unless your computer is *very* slow

        print(pool.map(f, range(10)))       # prints "[0, 1, 4,..., 81]"

        it = pool.imap(f, range(10))
        print(next(it))                     # prints "0"
        print(next(it))                     # prints "1"
        print(it.next(timeout=1))           # prints "4" unless your computer is *very* slow

        result = pool.apply_async(time.sleep, (10,))
        print(result.get(timeout=1))        # raises multiprocessing.TimeoutError
@end example

@node Oyentes y clientes Listeners and Clients,Llaves de autentificación,Piscinas de procesos Process Pools,Referencia<2>
@anchor{library/multiprocessing listeners-and-clients}@anchor{30f4}@anchor{library/multiprocessing module-multiprocessing connection}@anchor{95}@anchor{library/multiprocessing multiprocessing-listeners-clients}@anchor{30b3}
@subsubsection Oyentes y clientes (`Listeners and Clients')


@geindex module; multiprocessing.connection

Por lo general, el paso de mensajes entre procesos se realiza mediante colas o mediante objetos @ref{15e3,,Connection} retornados por @ref{3081,,Pipe()}.

Sin embargo, el módulo @ref{95,,multiprocessing.connection} permite cierta flexibilidad adicional. Básicamente proporciona una API orientada a mensajes de alto nivel para tratar con sockets o canalizaciones con nombre de Windows. También tiene soporte para `digest authentication' usando el módulo @ref{6a,,hmac}, y para sondear múltiples conexiones al mismo tiempo.

@geindex deliver_challenge() (en el módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection deliver_challenge}@anchor{30f5}
@deffn {Función} multiprocessing.connection.deliver_challenge (connection, authkey)

Envía un mensaje generado aleatoriamente al otro extremo de la conexión y espera una respuesta.

Si la respuesta coincide con el resumen del mensaje utilizando `authkey' como clave, se envía un mensaje de bienvenida al otro extremo de la conexión. De lo contrario se lanza @ref{3099,,AuthenticationError}.
@end deffn

@geindex answer_challenge() (en el módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection answer_challenge}@anchor{30f6}
@deffn {Función} multiprocessing.connection.answer_challenge (connection, authkey)

Recibe un mensaje, calcula el resumen del mensaje usando `authkey' como la clave y luego envía el resumen de vuelta.

Si no se recibe un mensaje de bienvenida, se lanza @ref{3099,,AuthenticationError}.
@end deffn

@geindex Client() (en el módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Client}@anchor{30f7}
@deffn {Función} multiprocessing.connection.Client (address[, family[, authkey]])

Se intenta configurar una conexión con el oyente que utiliza la dirección `address', retornando @ref{15e3,,Connection}.

El tipo de conexión está determinado por el argumento `family', pero esto generalmente se puede omitir ya que generalmente se puede inferir del formato de `address'. (Consulte @ref{30f8,,Formatos de dirección (Address formats)})

If `authkey' is given and not @code{None}, it should be a byte string and will be
used as the secret key for an HMAC-based authentication challenge. No
authentication is done if `authkey' is @code{None}.
@ref{3099,,AuthenticationError} is raised if authentication fails.
See @ref{3095,,Llaves de autentificación}.
@end deffn

@geindex Listener (clase en multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Listener}@anchor{16b3}
@deffn {Clase} multiprocessing.connection.Listener ([address[, family[, backlog[, authkey]]]])

Un contenedor para un `socket' vinculado o una tubería (`pipe') con nombre de Windows que está “escuchando” las conexiones.

`address' es la dirección que utilizará el `socket' vinculado o la conocida tubería (`pipe') con nombre del objeto de escucha.

@cartouche
@quotation Nota 
Si se usa una dirección de “0.0.0.0” , la dirección no será un punto final conectable en Windows. Si necesita un punto final conectable, debe usar “127.0.0.1”.
@end quotation
@end cartouche

`family' es el tipo de socket (o tubería con nombre) a utilizar. Esta puede ser una de las cadenas de caracteres @code{'AF_INET'} (para un socket TCP), @code{' AF_UNIX'} (para un socket de dominio Unix) o @code{'AF_PIPE'} (para una tubería con nombre de Windows) . De estos, solo el primero está garantizado para estar disponible. Si `family' es @code{None} , `family' se deduce del formato de `address'. Si `address' también es @code{None} , se elige un valor predeterminado. Este valor predeterminado es `family' con la opción más rápida disponible. Consulte @ref{30f8,,Formatos de dirección (Address formats)}. Tenga en cuenta que si `family' es @code{'AF_UNIX'} y la dirección es @code{None}, el `socket' se creará en un directorio temporal privado usando @ref{2846,,tempfile.mkstemp()}.

Si el objeto de escucha utiliza un `socket', entonces `backlog' (1 por defecto) se pasa al método @ref{ede,,listen()} del `socket' una vez que se ha vinculado.

If `authkey' is given and not @code{None}, it should be a byte string and will be
used as the secret key for an HMAC-based authentication challenge. No
authentication is done if `authkey' is @code{None}.
@ref{3099,,AuthenticationError} is raised if authentication fails.
See @ref{3095,,Llaves de autentificación}.

@geindex accept() (método de multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener accept}@anchor{166b}
@deffn {Método} accept ()

Acepta una conexión en el `socket' vinculado o canalización con nombre del objeto de escucha y retorne un objeto @ref{15e3,,Connection}. Si se intenta la autenticación y falla, entonces se lanza una @ref{3099,,AuthenticationError}.
@end deffn

@geindex close() (método de multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener close}@anchor{30f9}
@deffn {Método} close ()

Cierra el socket vinculado o la tubería con nombre del objeto de escucha. Esto se llama automáticamente cuando el oyente es recolectado por el recolector de basura. Sin embargo, es aconsejable llamarlo explícitamente.
@end deffn

Los objetos de escucha tienen las siguientes propiedades de solo lectura:

@geindex address (atributo de multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener address}@anchor{30fa}
@deffn {Atributo} address

La dirección que está utilizando el objeto `Listener'.
@end deffn

@geindex last_accepted (atributo de multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener last_accepted}@anchor{30fb}
@deffn {Atributo} last_accepted

La dirección de donde vino la última conexión aceptada. Si esto no está disponible, entonces es @code{None}.
@end deffn


Distinto en la versión 3.3: Los objetos de escucha ahora admiten el protocolo de gestión de contexto – consulte @ref{1fbf,,Tipos gestores de contexto}. El objeto `lISTENER' retorna @ref{224d,,__enter__()}, y @ref{224e,,__exit__()} llama a @ref{30f9,,close()}.

@end deffn

@geindex wait() (en el módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection wait}@anchor{1153}
@deffn {Función} multiprocessing.connection.wait (object_list, timeout=None)

Espera hasta que un objeto en `object_list' esté listo. Retorna la lista de esos objetos en `object_list' que están listos. Si `timeout' es flotante, la llamada se bloquea durante como máximo tantos segundos. Si `timeout' es @code{`None}, se bloqueará por un período ilimitado. Un tiempo de espera negativo es equivalente a un tiempo de espera cero.

For both POSIX and Windows, an object can appear in `object_list' if
it is


@itemize *

@item 
un objeto legible de @ref{15e3,,Connection};

@item 
un objeto conectado y legible de @ref{e27,,socket.socket}; o

@item 
el atributo @ref{1154,,sentinel} de un objeto @ref{be1,,Process}.
@end itemize

Un objeto de conexión o `socket' está listo cuando hay datos disponibles para leer, o el otro extremo se ha cerrado.

`POSIX': @code{wait(object_list, timeout)} almost equivalent
@code{select.select(object_list, [], [], timeout)}.  The difference is
that, if @ref{e26,,select.select()} is interrupted by a signal, it can
raise @ref{4d5,,OSError} with an error number of @code{EINTR}, whereas
@ref{1153,,wait()} will not.

`Windows': An item in `object_list' must either be an integer
handle which is waitable (according to the definition used by the
documentation of the Win32 function @code{WaitForMultipleObjects()})
or it can be an object with a @ref{2848,,fileno()} method which returns a
socket handle or pipe handle.  (Note that pipe handles and socket
handles are `not' waitable handles.)


Added in version 3.3.

@end deffn

`Ejemplos'

El siguiente código de servidor crea un escucha que utiliza @code{'secret password'} como clave de autenticación. Luego espera una conexión y envía algunos datos al cliente:

@example
from multiprocessing.connection import Listener
from array import array

address = ('localhost', 6000)     # family is deduced to be 'AF_INET'

with Listener(address, authkey=b'secret password') as listener:
    with listener.accept() as conn:
        print('connection accepted from', listener.last_accepted)

        conn.send([2.25, None, 'junk', float])

        conn.send_bytes(b'hello')

        conn.send_bytes(array('i', [42, 1729]))
@end example

El siguiente código se conecta al servidor y recibe algunos datos del servidor:

@example
from multiprocessing.connection import Client
from array import array

address = ('localhost', 6000)

with Client(address, authkey=b'secret password') as conn:
    print(conn.recv())                  # => [2.25, None, 'junk', float]

    print(conn.recv_bytes())            # => 'hello'

    arr = array('i', [0, 0, 0, 0, 0])
    print(conn.recv_bytes_into(arr))    # => 8
    print(arr)                          # => array('i', [42, 1729, 0, 0, 0])
@end example

El siguiente código utiliza @ref{1153,,wait()} para esperar mensajes de múltiples procesos a la vez:

@example
from multiprocessing import Process, Pipe, current_process
from multiprocessing.connection import wait

def foo(w):
    for i in range(10):
        w.send((i, current_process().name))
    w.close()

if __name__ == '__main__':
    readers = []

    for i in range(4):
        r, w = Pipe(duplex=False)
        readers.append(r)
        p = Process(target=foo, args=(w,))
        p.start()
        # We close the writable end of the pipe now to be sure that
        # p is the only process which owns a handle for it.  This
        # ensures that when p closes its handle for the writable end,
        # wait() will promptly report the readable end as being ready.
        w.close()

    while readers:
        for r in wait(readers):
            try:
                msg = r.recv()
            except EOFError:
                readers.remove(r)
            else:
                print(msg)
@end example

@menu
* Formatos de dirección (Address formats): Formatos de dirección Address formats. 

@end menu

@node Formatos de dirección Address formats,,,Oyentes y clientes Listeners and Clients
@anchor{library/multiprocessing address-formats}@anchor{30fc}@anchor{library/multiprocessing multiprocessing-address-formats}@anchor{30f8}
@subsubsection Formatos de dirección (`Address formats')



@itemize *

@item 
Una dirección @code{'AF_INET'} es una tupla de la forma @code{(hostname, port)} donde `hostname' es una cadena de caracteres y `port' es un número entero.

@item 
Una dirección @code{'AF_UNIX'} es una cadena que representa un nombre de archivo en el sistema de archivos.

@item 
Una dirección @code{'AF_PIPE'} es una cadena con el formato @code{r'\\.\pipe\@var{PipeName}'}. Para usar @ref{30f7,,Client()} para conectarse a una tubería con nombre en una computadora remota llamada `ServerName', se debe usar una dirección de la forma @code{r'\\@var{ServerName}\pipe\@var{PipeName}'} en cambio.
@end itemize

Tenga en cuenta que cualquier cadena que comience con dos barras inclinadas invertidas se asume por defecto como una dirección @code{'AF_PIPE'} en lugar de una dirección @code{'AF_UNIX'}.

@node Llaves de autentificación,Logging,Oyentes y clientes Listeners and Clients,Referencia<2>
@anchor{library/multiprocessing authentication-keys}@anchor{30fd}@anchor{library/multiprocessing multiprocessing-auth-keys}@anchor{3095}
@subsubsection Llaves de autentificación


Cuando uno usa @ref{30b5,,Connection.recv}, los datos recibidos se desbloquean automáticamente. Desafortunadamente, la eliminación de datos de una fuente no confiable es un riesgo de seguridad. Por lo tanto @ref{16b3,,Listener} y @ref{30f7,,Client()} usan el módulo @ref{6a,,hmac} para proporcionar autenticación de resumen.

Una clave de autenticación es una cadena de bytes que se puede considerar como una contraseña: una vez que se establece una conexión, ambos extremos exigirán pruebas de que el otro conoce la clave de autenticación. (Demostrar que ambos extremos están usando la misma clave `no' implica enviar la clave a través de la conexión).

Si se solicita la autenticación pero no se especifica una clave de autenticación, se utiliza el valor de retorno de @code{current_process().authkey} (consulte @ref{be1,,Process} ). Este valor será heredado automáticamente por cualquier objeto @code{Process} que crea el proceso actual. Esto significa que (por defecto) todos los procesos de un programa multiproceso compartirán una única clave de autenticación que se puede usar al configurar conexiones entre ellos.

Las claves de autenticación adecuadas también se pueden generar utilizando @ref{5c6,,os.urandom()}.

@node Logging,El módulo multiprocessing dummy,Llaves de autentificación,Referencia<2>
@anchor{library/multiprocessing logging}@anchor{30fe}
@subsubsection `Logging'


Existe cierto soporte para el registro. Sin embargo, tenga en cuenta que el paquete @ref{87,,logging} no utiliza candados compartidos de proceso, por lo que es posible (dependiendo del tipo de controlador) que los mensajes de diferentes procesos se mezclen.

@geindex get_logger() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_logger}@anchor{30ff}
@deffn {Función} multiprocessing.get_logger ()

Retorna el registrador utilizado por @ref{94,,multiprocessing}. Si es necesario, se creará uno nuevo.

When first created the logger has level @ref{2cce,,logging.NOTSET} and no
default handler. Messages sent to this logger will not by default propagate
to the root logger.

Tenga en cuenta que en Windows los procesos hijos solo heredarán el nivel del registrador del proceso parental – no se heredará ninguna otra personalización del registrador.
@end deffn

@geindex log_to_stderr() (en el módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing log_to_stderr}@anchor{3100}
@deffn {Función} multiprocessing.log_to_stderr (level=None)

Esta función realiza una llamada a @ref{30ff,,get_logger()} pero además de retornar el registrador creado por get_logger, agrega un controlador que envía la salida a @ref{9cc,,sys.stderr} usando el formato @code{'[%(levelname)s/%(processName)s] %(message)s'}. Puede modificar @code{levelname} del registrador pasando un argumento @code{level}.
@end deffn

A continuación se muestra una sesión de ejemplo con el registro activado:

@example
>>> import multiprocessing, logging
>>> logger = multiprocessing.log_to_stderr()
>>> logger.setLevel(logging.INFO)
>>> logger.warning('doomed')
[WARNING/MainProcess] doomed
>>> m = multiprocessing.Manager()
[INFO/SyncManager-...] child process calling self.run()
[INFO/SyncManager-...] created temp directory /.../pymp-...
[INFO/SyncManager-...] manager serving at '/.../listener-...'
>>> del m
[INFO/MainProcess] sending shutdown message to manager
[INFO/SyncManager-...] manager exiting with exitcode 0
@end example

Para obtener una tabla completa de niveles de registro, consulte el módulo @ref{87,,logging}.

@node El módulo multiprocessing dummy,,Logging,Referencia<2>
@anchor{library/multiprocessing module-multiprocessing dummy}@anchor{96}@anchor{library/multiprocessing the-multiprocessing-dummy-module}@anchor{3101}
@subsubsection El módulo @code{multiprocessing.dummy}


@geindex module; multiprocessing.dummy

El @ref{96,,multiprocessing.dummy} replica la API de @ref{94,,multiprocessing} pero no es más que un contenedor alrededor del módulo @ref{ed,,threading}.

En particular, la función @code{Pool} ofrecida por @ref{96,,multiprocessing.dummy} retorna un instancia de @ref{1919,,ThreadPool}, la cual es un subclase de @ref{137c,,Pool} que soporta todas las mismas llamadas, pero usa un `pool' de hebras trabajadoras en vez de procesos trabajadores.

@geindex ThreadPool (clase en multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool ThreadPool}@anchor{1919}
@deffn {Clase} multiprocessing.pool.ThreadPool ([processes[, initializer[, initargs]]])

Un objeto de `pool' de hebras que controla un `pool' de hebras trabajadoras a las cuales se pueden enviar trabajos. La interfaz de las instancias de @ref{1919,,ThreadPool} son totalmente compatibles con las instancias de @ref{137c,,Pool}, y sus recursos también deben ser debidamente administrador, ya sea usando el `pool' como un gestor de contexto, o llamando a @ref{30e8,,close()} y @ref{30e9,,terminate()} manualmente.

`processes' is the number of worker threads to use.  If `processes' is
@code{None} then the number returned by @ref{327,,os.process_cpu_count()} is used.

Si `initializer' no es @code{None}, cada proceso de trabajo llamará @code{initializer(*initargs)} cuando se inicie.

A diferencia de @ref{137c,,Pool}, `maxtasksperchild' and `context' no se pueden entregar.

@cartouche
@quotation Nota 
Un @ref{1919,,ThreadPool} comparte la misma interfaz que @ref{137c,,Pool}, la cual está diseñada alrededor de un `pool' de procesos, y precede la introducción del módulo @ref{22,,concurrent.futures}. Como tal, hereda algunas operaciones que no tienen sentido para un `pool' basado en hebras, y tiene su propio tipo para representar el estado de trabajos asíncronos, @ref{30ec,,AsyncResult}, el cual no es entendido por otras librerías.

Los usuarios deberían por lo general preferir usar @ref{7dd,,concurrent.futures.ThreadPoolExecutor}, el cual tiene una interfaz más simple que fue diseñada alrededor de hebras desde un principio, y que retorna instancias de @ref{1220,,concurrent.futures.Future}, las que son compatibles con muchas más librerías, incluyendo @ref{b,,asyncio}.
@end quotation
@end cartouche
@end deffn

@node Pautas de programación,Ejemplos<13>,Referencia<2>,multiprocessing — Process-based parallelism
@anchor{library/multiprocessing multiprocessing-programming}@anchor{307d}@anchor{library/multiprocessing programming-guidelines}@anchor{3102}
@subsubsection Pautas de programación


Hay ciertas pautas y expresiones idiomáticas que deben tenerse en cuenta al usar @ref{94,,multiprocessing} .

@menu
* Todos los métodos de inicio:: 
* Los métodos de inicio spawn y forkserver:: 

@end menu

@node Todos los métodos de inicio,Los métodos de inicio spawn y forkserver,,Pautas de programación
@anchor{library/multiprocessing all-start-methods}@anchor{3103}
@subsubsection Todos los métodos de inicio


Lo siguiente se aplica a todos los métodos de inicio.

Evita estado compartido

@quotation

En la medida de lo posible, se debe tratar de evitar el desplazamiento de grandes cantidades de datos entre procesos.

Probablemente sea mejor seguir usando colas (`queues') o tuberías (`pipes') para la comunicación entre procesos en lugar de usar las primitivas de sincronización de nivel inferior.
@end quotation

Serialización (`picklability')

@quotation

Asegúrese que todos los argumentos de los métodos de `proxies' son serializables (`pickable')
@end quotation

Seguridad de hilos de `proxies'

@quotation

No usa un objeto proxy de más de un hilo a menos que lo proteja con un candado (`lock').

(Nunca hay un problema con diferentes procesos que usan el `mismo' proxy.)
@end quotation

Uniéndose a procesos zombies

@quotation

On POSIX when a process finishes but has not been joined it becomes a zombie.
There should never be very many because each time a new process starts (or
@ref{30ae,,active_children()} is called) all completed processes
which have not yet been joined will be joined.  Also calling a finished
process’s @ref{3092,,Process.is_alive} will
join the process.  Even so it is probably good
practice to explicitly join all the processes that you start.
@end quotation

Mejor heredar que serializar/deserializar (`pickle/unpickle')

@quotation

Cuando se usan los métodos de inicio `spawn' o `forkserver', muchos tipos de @code{multiprocesamiento} deben ser seleccionables para que los procesos secundarios puedan usarlos. Sin embargo, generalmente se debe evitar enviar objetos compartidos a otros procesos mediante tuberías o colas. En su lugar, debe organizar el programa para que un proceso que necesita acceso a un recurso compartido creado en otro lugar pueda heredarlo de un proceso ancestro.
@end quotation

Evita procesos de finalización

@quotation

El uso del método @ref{3096,,Process.terminate} para detener un proceso puede causar que los recursos compartidos (como candados, semáforos, tuberías  y colas) que el proceso utiliza actualmente se rompan o no disponible para otros procesos.

Por lo tanto, probablemente sea mejor considerar usar @ref{3096,,Process.terminate} en procesos que nunca usan recursos compartidos.
@end quotation

Unirse a procesos que usan colas

@quotation

Tenga en cuenta que un proceso que ha puesto elementos en una cola esperará antes de finalizar hasta que todos los elementos almacenados en búfer sean alimentados por el hilo «alimentador» a la tubería subyacente. (El proceso secundario puede llamar al método @ref{30a4,,Queue.cancel_join_thread} de la cola para evitar este comportamiento).

Esto significa que siempre que use una cola debe asegurarse de que todos los elementos que se hayan puesto en la cola se eliminarán antes de unirse al proceso. De lo contrario, no puede estar seguro de que los procesos que han puesto elementos en la cola finalizarán. Recuerde también que los procesos no demoníacos se unirán automáticamente.

Un ejemplo que de bloqueo mutuo (`deadlock') es el siguiente

@example
from multiprocessing import Process, Queue

def f(q):
    q.put('X' * 1000000)

if __name__ == '__main__':
    queue = Queue()
    p = Process(target=f, args=(queue,))
    p.start()
    p.join()                    # this deadlocks
    obj = queue.get()
@end example

Una solución aquí sería intercambiar las dos últimas líneas (o simplemente eliminar la línea @code{p.join()}).
@end quotation

Se pasan recursos explícitamente a procesos hijos

@quotation

On POSIX using the `fork' start method, a child process can make
use of a shared resource created in a parent process using a
global resource.  However, it is better to pass the object as an
argument to the constructor for the child process.

Además de hacer que el código (potencialmente) sea compatible con Windows y los otros métodos de inicio, esto también garantiza que mientras el proceso secundario siga vivo, el objeto no se recolectará en el proceso primario. Esto podría ser importante si se libera algún recurso cuando el objeto es basura recolectada en el proceso padre.

Entonces por ejemplo

@example
from multiprocessing import Process, Lock

def f():
    ... do something using "lock" ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f).start()
@end example

debería ser reescrito como

@example
from multiprocessing import Process, Lock

def f(l):
    ... do something using "l" ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f, args=(lock,)).start()
@end example
@end quotation

Tenga cuidado de reemplazar @ref{5df,,sys.stdin} con un `«file like object»'

@quotation

@ref{94,,multiprocessing} original e incondicionalmente llamado:

@example
os.close(sys.stdin.fileno())
@end example

en el método @code{multiprocessing.Process._bootstrap()} — Esto dio lugar a problemas con los procesos en proceso. Esto ha sido cambiado a:

@example
sys.stdin.close()
sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)
@end example

Which solves the fundamental issue of processes colliding with each other
resulting in a bad file descriptor error, but introduces a potential danger
to applications which replace @ref{5df,,sys.stdin()} with a «file-like object»
with output buffering.  This danger is that if multiple processes call
@ref{354,,close()} on this file-like object, it could result in the same
data being flushed to the object multiple times, resulting in corruption.

Si escribe un objeto similar a un archivo e implementa su propio almacenamiento en caché, puede hacer que sea seguro para la bifurcación (`fork-safe') almacenando el pid cada vez que se agrega al caché y descartando el caché cuando cambia el pid. Por ejemplo:

@example
@@property
def cache(self):
    pid = os.getpid()
    if pid != self._pid:
        self._pid = pid
        self._cache = []
    return self._cache
@end example

Para más información, consulte bpo-5155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5155}, bpo-5313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5313} y bpo-5331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5331}
@end quotation

@node Los métodos de inicio spawn y forkserver,,Todos los métodos de inicio,Pautas de programación
@anchor{library/multiprocessing the-spawn-and-forkserver-start-methods}@anchor{3104}
@subsubsection Los métodos de inicio `spawn' y `forkserver'


There are a few extra restrictions which don’t apply to the `fork'
start method.

Más serialización (`pickability')

@quotation

Asegúrese de que todos los argumentos para @code{Process.__init__()} sean serializables (`picklable'). Además, si la subclase es @ref{be1,,Process} asegúrese de que las instancias serán serializables cuando se llame al método @ref{307c,,Process.start}.
@end quotation

Variables globales

@quotation

Tenga en cuenta que si el código que se ejecuta en un proceso secundario intenta acceder a una variable global, entonces el valor que ve (si lo hay) puede no ser el mismo que el valor en el proceso primario en el momento en que fue llamado @ref{307c,,Process.start}.

Sin embargo, las variables globales que son solo constantes de nivel de módulo no causan problemas.
@end quotation
@anchor{library/multiprocessing multiprocessing-safe-main-import}@anchor{3105}
Importando de manera segura el módulo principal

@quotation

Make sure that the main module can be safely imported by a new Python
interpreter without causing unintended side effects (such as starting a new
process).

Por ejemplo, usando el método de inicio `spawn' o `forkserver' ejecutando este módulo fallaría produciendo @ref{1e5,,RuntimeError}:

@example
from multiprocessing import Process

def foo():
    print('hello')

p = Process(target=foo)
p.start()
@end example

En su lugar, se debe proteger el «punto de entrada» (`«entry point»') del programa utilizando como sigue @code{if __name__ == '__main__':}

@example
from multiprocessing import Process, freeze_support, set_start_method

def foo():
    print('hello')

if __name__ == '__main__':
    freeze_support()
    set_start_method('spawn')
    p = Process(target=foo)
    p.start()
@end example

(La línea @code{freeze_support()} puede omitirse si el programa se ejecuta normalmente en lugar de congelarse).

Esto permite que el intérprete de Python recién generado importe de forma segura el módulo y luego ejecute la función del módulo @code{foo()}.

Se aplican restricciones similares si se crea un grupo o administrador en el módulo principal.
@end quotation

@node Ejemplos<13>,,Pautas de programación,multiprocessing — Process-based parallelism
@anchor{library/multiprocessing examples}@anchor{3106}@anchor{library/multiprocessing multiprocessing-examples}@anchor{30a5}
@subsubsection Ejemplos


Demostración de cómo crear y usar gerentes y proxies personalizados:

@example
from multiprocessing import freeze_support
from multiprocessing.managers import BaseManager, BaseProxy
import operator

##

class Foo:
    def f(self):
        print('you called Foo.f()')
    def g(self):
        print('you called Foo.g()')
    def _h(self):
        print('you called Foo._h()')

# A simple generator function
def baz():
    for i in range(10):
        yield i*i

# Proxy type for generator objects
class GeneratorProxy(BaseProxy):
    _exposed_ = ['__next__']
    def __iter__(self):
        return self
    def __next__(self):
        return self._callmethod('__next__')

# Function to return the operator module
def get_operator_module():
    return operator

##

class MyManager(BaseManager):
    pass

# register the Foo class; make `f()` and `g()` accessible via proxy
MyManager.register('Foo1', Foo)

# register the Foo class; make `g()` and `_h()` accessible via proxy
MyManager.register('Foo2', Foo, exposed=('g', '_h'))

# register the generator function baz; use `GeneratorProxy` to make proxies
MyManager.register('baz', baz, proxytype=GeneratorProxy)

# register get_operator_module(); make public functions accessible via proxy
MyManager.register('operator', get_operator_module)

##

def test():
    manager = MyManager()
    manager.start()

    print('-' * 20)

    f1 = manager.Foo1()
    f1.f()
    f1.g()
    assert not hasattr(f1, '_h')
    assert sorted(f1._exposed_) == sorted(['f', 'g'])

    print('-' * 20)

    f2 = manager.Foo2()
    f2.g()
    f2._h()
    assert not hasattr(f2, 'f')
    assert sorted(f2._exposed_) == sorted(['g', '_h'])

    print('-' * 20)

    it = manager.baz()
    for i in it:
        print('<%d>' % i, end=' ')
    print()

    print('-' * 20)

    op = manager.operator()
    print('op.add(23, 45) =', op.add(23, 45))
    print('op.pow(2, 94) =', op.pow(2, 94))
    print('op._exposed_ =', op._exposed_)

##

if __name__ == '__main__':
    freeze_support()
    test()
@end example

Usando @ref{137c,,Pool}:

@example
import multiprocessing
import time
import random
import sys

#
# Functions used by test code
#

def calculate(func, args):
    result = func(*args)
    return '%s says that %s%s = %s' % (
        multiprocessing.current_process().name,
        func.__name__, args, result
        )

def calculatestar(args):
    return calculate(*args)

def mul(a, b):
    time.sleep(0.5 * random.random())
    return a * b

def plus(a, b):
    time.sleep(0.5 * random.random())
    return a + b

def f(x):
    return 1.0 / (x - 5.0)

def pow3(x):
    return x ** 3

def noop(x):
    pass

#
# Test code
#

def test():
    PROCESSES = 4
    print('Creating pool with %d processes\n' % PROCESSES)

    with multiprocessing.Pool(PROCESSES) as pool:
        #
        # Tests
        #

        TASKS = [(mul, (i, 7)) for i in range(10)] + \
                [(plus, (i, 8)) for i in range(10)]

        results = [pool.apply_async(calculate, t) for t in TASKS]
        imap_it = pool.imap(calculatestar, TASKS)
        imap_unordered_it = pool.imap_unordered(calculatestar, TASKS)

        print('Ordered results using pool.apply_async():')
        for r in results:
            print('\t', r.get())
        print()

        print('Ordered results using pool.imap():')
        for x in imap_it:
            print('\t', x)
        print()

        print('Unordered results using pool.imap_unordered():')
        for x in imap_unordered_it:
            print('\t', x)
        print()

        print('Ordered results using pool.map() --- will block till complete:')
        for x in pool.map(calculatestar, TASKS):
            print('\t', x)
        print()

        #
        # Test error handling
        #

        print('Testing error handling:')

        try:
            print(pool.apply(f, (5,)))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from pool.apply()')
        else:
            raise AssertionError('expected ZeroDivisionError')

        try:
            print(pool.map(f, list(range(10))))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from pool.map()')
        else:
            raise AssertionError('expected ZeroDivisionError')

        try:
            print(list(pool.imap(f, list(range(10)))))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from list(pool.imap())')
        else:
            raise AssertionError('expected ZeroDivisionError')

        it = pool.imap(f, list(range(10)))
        for i in range(10):
            try:
                x = next(it)
            except ZeroDivisionError:
                if i == 5:
                    pass
            except StopIteration:
                break
            else:
                if i == 5:
                    raise AssertionError('expected ZeroDivisionError')

        assert i == 9
        print('\tGot ZeroDivisionError as expected from IMapIterator.next()')
        print()

        #
        # Testing timeouts
        #

        print('Testing ApplyResult.get() with timeout:', end=' ')
        res = pool.apply_async(calculate, TASKS[0])
        while 1:
            sys.stdout.flush()
            try:
                sys.stdout.write('\n\t%s' % res.get(0.02))
                break
            except multiprocessing.TimeoutError:
                sys.stdout.write('.')
        print()
        print()

        print('Testing IMapIterator.next() with timeout:', end=' ')
        it = pool.imap(calculatestar, TASKS)
        while 1:
            sys.stdout.flush()
            try:
                sys.stdout.write('\n\t%s' % it.next(0.02))
            except StopIteration:
                break
            except multiprocessing.TimeoutError:
                sys.stdout.write('.')
        print()
        print()


if __name__ == '__main__':
    multiprocessing.freeze_support()
    test()
@end example

Un ejemplo que muestra cómo usar las colas para alimentar tareas a una colección de procesos de trabajo y recopilar los resultados:

@example
import time
import random

from multiprocessing import Process, Queue, current_process, freeze_support

#
# Function run by worker processes
#

def worker(input, output):
    for func, args in iter(input.get, 'STOP'):
        result = calculate(func, args)
        output.put(result)

#
# Function used to calculate result
#

def calculate(func, args):
    result = func(*args)
    return '%s says that %s%s = %s' % \
        (current_process().name, func.__name__, args, result)

#
# Functions referenced by tasks
#

def mul(a, b):
    time.sleep(0.5*random.random())
    return a * b

def plus(a, b):
    time.sleep(0.5*random.random())
    return a + b

#
#
#

def test():
    NUMBER_OF_PROCESSES = 4
    TASKS1 = [(mul, (i, 7)) for i in range(20)]
    TASKS2 = [(plus, (i, 8)) for i in range(10)]

    # Create queues
    task_queue = Queue()
    done_queue = Queue()

    # Submit tasks
    for task in TASKS1:
        task_queue.put(task)

    # Start worker processes
    for i in range(NUMBER_OF_PROCESSES):
        Process(target=worker, args=(task_queue, done_queue)).start()

    # Get and print results
    print('Unordered results:')
    for i in range(len(TASKS1)):
        print('\t', done_queue.get())

    # Add more tasks using `put()`
    for task in TASKS2:
        task_queue.put(task)

    # Get and print some more results
    for i in range(len(TASKS2)):
        print('\t', done_queue.get())

    # Tell child processes to stop
    for i in range(NUMBER_OF_PROCESSES):
        task_queue.put('STOP')


if __name__ == '__main__':
    freeze_support()
    test()
@end example

@node multiprocessing shared_memory — Shared memory for direct access across processes,El paquete concurrent,multiprocessing — Process-based parallelism,Ejecución concurrente
@anchor{library/multiprocessing shared_memory doc}@anchor{3107}@anchor{library/multiprocessing shared_memory module-multiprocessing shared_memory}@anchor{99}@anchor{library/multiprocessing shared_memory multiprocessing-shared-memory-shared-memory-for-direct-access-across-processes}@anchor{3108}
@subsection @code{multiprocessing.shared_memory} — Shared memory for direct access across processes


@geindex module; multiprocessing.shared_memory

`Código fuente:' Lib/multiprocessing/shared_memory.py@footnote{https://github.com/python/cpython/tree/main/Lib/multiprocessing/shared_memory.py}


Added in version 3.8.


@geindex Memoria Compartida
@geindex Memoria Compartida POSIX
@geindex Memoria Compartida Nombrada


__________________________________________________________________


This module provides a class, @ref{1664,,SharedMemory}, for the allocation
and management of shared memory to be accessed by one or more processes
on a multicore or symmetric multiprocessor (SMP) machine.  To assist with
the life-cycle management of shared memory especially across distinct
processes, a @ref{30cb,,BaseManager} subclass,
@ref{3109,,SharedMemoryManager}, is also provided in the
@ref{97,,multiprocessing.managers} module.

In this module, shared memory refers to «POSIX style» shared memory blocks
(though is not necessarily implemented explicitly as such) and does not refer
to «distributed shared memory».  This style of shared memory permits distinct
processes to potentially read and write to a common (or shared) region of
volatile memory.  Processes are conventionally limited to only have access to
their own process memory space but shared memory permits the sharing
of data between processes, avoiding the need to instead send messages between
processes containing that data.  Sharing data directly via memory can provide
significant performance benefits compared to sharing data via disk or socket
or other communications requiring the serialization/deserialization and
copying of data.

@geindex SharedMemory (clase en multiprocessing.shared_memory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory}@anchor{1664}
@deffn {Clase} multiprocessing.shared_memory.SharedMemory (name=None, create=False, size=0, *, track=True)

Create an instance of the @code{SharedMemory} class for either
creating a new shared memory block or attaching to an existing shared
memory block.  Each shared memory block is assigned a unique name.
In this way, one process can create a shared memory block with a
particular name and a different process can attach to that same shared
memory block using that same name.

As a resource for sharing data across processes, shared memory blocks
may outlive the original process that created them.  When one process
no longer needs access to a shared memory block that might still be
needed by other processes, the @ref{310a,,close()} method should be called.
When a shared memory block is no longer needed by any process, the
@ref{310b,,unlink()} method should be called to ensure proper cleanup.

@*Parámetros: 

@itemize *

@item 
@code{name} (@ref{237,,str}@code{ | }@code{None}) – The unique name for the requested shared memory, specified as a string.
When creating a new shared memory block, if @code{None} (the default)
is supplied for the name, a novel name will be generated.

@item 
@code{create} (@ref{513,,bool}) – Control whether a new shared memory block is created (@code{True})
or an existing shared memory block is attached (@code{False}).

@item 
@code{size} (@ref{1f0,,int}) – The requested number of bytes when creating a new shared memory block.
Because some platforms choose to allocate chunks of memory
based upon that platform’s memory page size, the exact size of the shared
memory block may be larger or equal to the size requested.
When attaching to an existing shared memory block,
the `size' parameter is ignored.

@item 
@code{track} (@ref{513,,bool}) – When @code{True}, register the shared memory block with a resource
tracker process on platforms where the OS does not do this automatically.
The resource tracker ensures proper cleanup of the shared memory even
if all other processes with access to the memory exit without doing so.
Python processes created from a common ancestor using @ref{94,,multiprocessing}
facilities share a single resource tracker process, and the lifetime of
shared memory segments is handled automatically among these processes.
Python processes created in any other way will receive their own
resource tracker when accessing shared memory with `track' enabled.
This will cause the shared memory to be deleted by the resource tracker
of the first process that terminates.
To avoid this issue, users of @ref{d6,,subprocess} or standalone Python
processes should set `track' to @code{False} when there is already another
process in place that does the bookkeeping.
`track' is ignored on Windows, which has its own tracking and
automatically deletes shared memory when all handles to it have been closed.
@end itemize



Distinto en la versión 3.13: Added the `track' parameter.


@geindex close() (método de multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory close}@anchor{310a}
@deffn {Método} close ()

Close the file descriptor/handle to the shared memory from this
instance.  @ref{310a,,close()} should be called once access to the shared
memory block from this instance is no longer needed.  Depending
on operating system, the underlying memory may or may not be freed
even if all handles to it have been closed.  To ensure proper cleanup,
use the @ref{310b,,unlink()} method.
@end deffn

@geindex unlink() (método de multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory unlink}@anchor{310b}
@deffn {Método} unlink ()

Delete the underlying shared memory block.  This should be called only
once per shared memory block regardless of the number of handles to it,
even in other processes.
@ref{310b,,unlink()} and @ref{310a,,close()} can be called in any order, but
trying to access data inside a shared memory block after @ref{310b,,unlink()}
may result in memory access errors, depending on platform.

This method has no effect on Windows, where the only way to delete a
shared memory block is to close all handles.
@end deffn

@geindex buf (atributo de multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory buf}@anchor{310c}
@deffn {Atributo} buf

Un `memoryview' del contenido del bloque de memoria compartida.
@end deffn

@geindex name (atributo de multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory name}@anchor{310d}
@deffn {Atributo} name

Acceso de solo lectura al nombre único del bloque de memoria compartida.
@end deffn

@geindex size (atributo de multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory size}@anchor{310e}
@deffn {Atributo} size

Acceso de solo lectura al tamaño en bytes del bloque de memoria compartida.
@end deffn
@end deffn

El siguiente ejemplo muestra el uso de bajo nivel de instancias de @ref{1664,,SharedMemory}:

@example
>>> from multiprocessing import shared_memory
>>> shm_a = shared_memory.SharedMemory(create=True, size=10)
>>> type(shm_a.buf)
<class 'memoryview'>
>>> buffer = shm_a.buf
>>> len(buffer)
10
>>> buffer[:4] = bytearray([22, 33, 44, 55])  # Modify multiple at once
>>> buffer[4] = 100                           # Modify single byte at a time
>>> # Attach to an existing shared memory block
>>> shm_b = shared_memory.SharedMemory(shm_a.name)
>>> import array
>>> array.array('b', shm_b.buf[:5])  # Copy the data into a new array.array
array('b', [22, 33, 44, 55, 100])
>>> shm_b.buf[:5] = b'howdy'  # Modify via shm_b using bytes
>>> bytes(shm_a.buf[:5])      # Access via shm_a
b'howdy'
>>> shm_b.close()   # Close each SharedMemory instance
>>> shm_a.close()
>>> shm_a.unlink()  # Call unlink only once to release the shared memory
@end example

The following example demonstrates a practical use of the @ref{1664,,SharedMemory}
class with NumPy arrays@footnote{https://numpy.org/}, accessing the
same @code{numpy.ndarray} from two distinct Python shells:

@example
>>> # In the first Python interactive shell
>>> import numpy as np
>>> a = np.array([1, 1, 2, 3, 5, 8])  # Start with an existing NumPy array
>>> from multiprocessing import shared_memory
>>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes)
>>> # Now create a NumPy array backed by shared memory
>>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf)
>>> b[:] = a[:]  # Copy the original data into shared memory
>>> b
array([1, 1, 2, 3, 5, 8])
>>> type(b)
<class 'numpy.ndarray'>
>>> type(a)
<class 'numpy.ndarray'>
>>> shm.name  # We did not specify a name so one was chosen for us
'psm_21467_46075'

>>> # In either the same shell or a new Python shell on the same machine
>>> import numpy as np
>>> from multiprocessing import shared_memory
>>> # Attach to the existing shared memory block
>>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075')
>>> # Note that a.shape is (6,) and a.dtype is np.int64 in this example
>>> c = np.ndarray((6,), dtype=np.int64, buffer=existing_shm.buf)
>>> c
array([1, 1, 2, 3, 5, 8])
>>> c[-1] = 888
>>> c
array([  1,   1,   2,   3,   5, 888])

>>> # Back in the first Python interactive shell, b reflects this change
>>> b
array([  1,   1,   2,   3,   5, 888])

>>> # Clean up from within the second Python shell
>>> del c  # Unnecessary; merely emphasizing the array is no longer used
>>> existing_shm.close()

>>> # Clean up from within the first Python shell
>>> del b  # Unnecessary; merely emphasizing the array is no longer used
>>> shm.close()
>>> shm.unlink()  # Free and release the shared memory block at the very end
@end example

@geindex SharedMemoryManager (clase en multiprocessing.managers)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager}@anchor{3109}
@deffn {Clase} multiprocessing.managers.SharedMemoryManager ([address[, authkey]])

A subclass of @ref{30cb,,multiprocessing.managers.BaseManager} which can be
used for the management of shared memory blocks across processes.

A call to @ref{30cc,,start()} on a
@code{SharedMemoryManager} instance causes a new process to be started.
This new process’s sole purpose is to manage the life cycle
of all shared memory blocks created through it.  To trigger the release
of all shared memory blocks managed by that process, call
@ref{30cd,,shutdown()} on the instance.
This triggers a @ref{310b,,unlink()} call
on all of the @ref{310f,,SharedMemory} objects managed by that process and then
stops the process itself.  By creating @code{SharedMemory} instances
through a @code{SharedMemoryManager}, we avoid the need to manually track
and trigger the freeing of shared memory resources.

Esta clase proporciona métodos para crear y retornar instancias @ref{310f,,SharedMemory} y para crear un objeto de tipo lista (@ref{3110,,ShareableList}) basados en memoria compartida.

Refer to @ref{30cb,,BaseManager} for a description
of the inherited `address' and `authkey' optional input arguments and how
they may be used to connect to an existing @code{SharedMemoryManager} service
from other processes.

@geindex SharedMemory() (método de multiprocessing.managers.SharedMemoryManager)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager SharedMemory}@anchor{310f}
@deffn {Método} SharedMemory (size)

Create and return a new @ref{310f,,SharedMemory} object with the
specified `size' in bytes.
@end deffn

@geindex ShareableList() (método de multiprocessing.managers.SharedMemoryManager)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager ShareableList}@anchor{3110}
@deffn {Método} ShareableList (sequence)

Create and return a new @ref{3110,,ShareableList} object, initialized
by the values from the input `sequence'.
@end deffn
@end deffn

The following example demonstrates the basic mechanisms of a
@ref{3109,,SharedMemoryManager}:

@example
>>> from multiprocessing.managers import SharedMemoryManager
>>> smm = SharedMemoryManager()
>>> smm.start()  # Start the process that manages the shared memory blocks
>>> sl = smm.ShareableList(range(4))
>>> sl
ShareableList([0, 1, 2, 3], name='psm_6572_7512')
>>> raw_shm = smm.SharedMemory(size=128)
>>> another_sl = smm.ShareableList('alpha')
>>> another_sl
ShareableList(['a', 'l', 'p', 'h', 'a'], name='psm_6572_12221')
>>> smm.shutdown()  # Calls unlink() on sl, raw_shm, and another_sl
@end example

The following example depicts a potentially more convenient pattern for using
@ref{3109,,SharedMemoryManager} objects via the
@ref{673,,with} statement to ensure that all shared memory blocks are released
after they are no longer needed:

@example
>>> with SharedMemoryManager() as smm:
...     sl = smm.ShareableList(range(2000))
...     # Divide the work among two processes, storing partial results in sl
...     p1 = Process(target=do_work, args=(sl, 0, 1000))
...     p2 = Process(target=do_work, args=(sl, 1000, 2000))
...     p1.start()
...     p2.start()  # A multiprocessing.Pool might be more efficient
...     p1.join()
...     p2.join()   # Wait for all work to complete in both processes
...     total_result = sum(sl)  # Consolidate the partial results now in sl
@end example

When using a @ref{3109,,SharedMemoryManager}
in a @ref{673,,with} statement, the shared memory blocks created using that
manager are all released when the @code{with} statement’s code block
finishes execution.

@geindex ShareableList (clase en multiprocessing.shared_memory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList}@anchor{1978}
@deffn {Clase} multiprocessing.shared_memory.ShareableList (sequence=None, *, name=None)

Provide a mutable list-like object where all values stored within are
stored in a shared memory block.
This constrains storable values to the following built-in data types:


@itemize *

@item 
@ref{1f0,,int} (signed 64-bit)

@item 
@ref{153,,float}

@item 
@ref{513,,bool}

@item 
@ref{237,,str} (less than 10M bytes each when encoded as UTF-8)

@item 
@ref{325,,bytes} (less than 10M bytes each)

@item 
@code{None}
@end itemize

It also notably differs from the built-in @ref{18e,,list} type
in that these lists can not change their overall length
(i.e. no @code{append()}, @code{insert()}, etc.) and do not
support the dynamic creation of new @code{ShareableList} instances
via slicing.

`sequence' is used in populating a new @code{ShareableList} full of values.
Set to @code{None} to instead attach to an already existing
@code{ShareableList} by its unique shared memory name.

`name' is the unique name for the requested shared memory, as described
in the definition for @ref{1664,,SharedMemory}.  When attaching to an
existing @code{ShareableList}, specify its shared memory block’s unique
name while leaving `sequence' set to @code{None}.

@cartouche
@quotation Nota 
A known issue exists for @ref{325,,bytes} and @ref{237,,str} values.
If they end with @code{\x00} nul bytes or characters, those may be
`silently stripped' when fetching them by index from the
@code{ShareableList}. This @code{.rstrip(b'\x00')} behavior is
considered a bug and may go away in the future. See gh-106939@footnote{https://github.com/python/cpython/issues/106939}.
@end quotation
@end cartouche

Para aplicaciones donde eliminar espacios nulos finales es un problema, solucionarlo añadiendo siempre incondicionalmente un byte extra que no sea 0 al final de dichos valores al almacenar y eliminándolo incondicionalmente al recuperarlos.

@example
>>> from multiprocessing import shared_memory
>>> nul_bug_demo = shared_memory.ShareableList(['?\x00', b'\x03\x02\x01\x00\x00\x00'])
>>> nul_bug_demo[0]
'?'
>>> nul_bug_demo[1]
b'\x03\x02\x01'
>>> nul_bug_demo.shm.unlink()
>>> padded = shared_memory.ShareableList(['?\x00\x07', b'\x03\x02\x01\x00\x00\x00\x07'])
>>> padded[0][:-1]
'?\x00'
>>> padded[1][:-1]
b'\x03\x02\x01\x00\x00\x00'
>>> padded.shm.unlink()
@end example

@geindex count() (método de multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList count}@anchor{3111}
@deffn {Método} count (value)

Return the number of occurrences of `value'.
@end deffn

@geindex index() (método de multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList index}@anchor{3112}
@deffn {Método} index (value)

Return first index position of `value'.
Raise @ref{360,,ValueError} if `value' is not present.
@end deffn

@geindex format (atributo de multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList format}@anchor{3113}
@deffn {Atributo} format

Atributo de solo lectura que contiene el formato de empaquetado @ref{d5,,struct} utilizado por todos los valores almacenados actualmente.
@end deffn

@geindex shm (atributo de multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList shm}@anchor{3114}
@deffn {Atributo} shm

La instancia de @ref{1664,,SharedMemory} donde se almacenan los valores.
@end deffn
@end deffn

El siguiente ejemplo muestra el uso básico de una instancia @ref{1978,,ShareableList}:

@example
>>> from multiprocessing import shared_memory
>>> a = shared_memory.ShareableList(['howdy', b'HoWdY', -273.154, 100, None, True, 42])
>>> [ type(entry) for entry in a ]
[<class 'str'>, <class 'bytes'>, <class 'float'>, <class 'int'>, <class 'NoneType'>, <class 'bool'>, <class 'int'>]
>>> a[2]
-273.154
>>> a[2] = -78.5
>>> a[2]
-78.5
>>> a[2] = 'dry ice'  # Changing data types is supported as well
>>> a[2]
'dry ice'
>>> a[2] = 'larger than previously allocated storage space'
Traceback (most recent call last):
  ...
ValueError: exceeds available storage for existing str
>>> a[2]
'dry ice'
>>> len(a)
7
>>> a.index(42)
6
>>> a.count(b'howdy')
0
>>> a.count(b'HoWdY')
1
>>> a.shm.close()
>>> a.shm.unlink()
>>> del a  # Use of a ShareableList after call to unlink() is unsupported
@end example

El siguiente ejemplo muestra cómo uno, dos o muchos procesos pueden acceder al mismo @ref{1978,,ShareableList} al proporcionar el nombre del bloque de memoria compartida detrás de él:

@example
>>> b = shared_memory.ShareableList(range(5))         # In a first process
>>> c = shared_memory.ShareableList(name=b.shm.name)  # In a second process
>>> c
ShareableList([0, 1, 2, 3, 4], name='...')
>>> c[-1] = -999
>>> b[-1]
-999
>>> b.shm.close()
>>> c.shm.close()
>>> c.shm.unlink()
@end example

The following examples demonstrates that @ref{1978,,ShareableList}
(and underlying @ref{1664,,SharedMemory}) objects
can be pickled and unpickled if needed.
Note, that it will still be the same shared object.
This happens, because the deserialized object has
the same unique name and is just attached to an existing
object with the same name (if the object is still alive):

@example
>>> import pickle
>>> from multiprocessing import shared_memory
>>> sl = shared_memory.ShareableList(range(10))
>>> list(sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> deserialized_sl = pickle.loads(pickle.dumps(sl))
>>> list(deserialized_sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> sl[0] = -1
>>> deserialized_sl[1] = -2
>>> list(sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]
>>> list(deserialized_sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> sl.shm.close()
>>> sl.shm.unlink()
@end example

@node El paquete concurrent,concurrent futures — Launching parallel tasks,multiprocessing shared_memory — Shared memory for direct access across processes,Ejecución concurrente
@anchor{library/concurrent doc}@anchor{3115}@anchor{library/concurrent the-concurrent-package}@anchor{3116}
@subsection El paquete @code{concurrent}


Actualmente solo existe un módulo en este paquete:


@itemize *

@item 
@ref{22,,concurrent.futures} – Lanzamiento de tareas paralelas
@end itemize

@node concurrent futures — Launching parallel tasks,subprocess — Subprocess management,El paquete concurrent,Ejecución concurrente
@anchor{library/concurrent futures doc}@anchor{3117}@anchor{library/concurrent futures concurrent-futures-launching-parallel-tasks}@anchor{3118}@anchor{library/concurrent futures module-concurrent futures}@anchor{22}
@subsection @code{concurrent.futures} — Launching parallel tasks


@geindex module; concurrent.futures


Added in version 3.2.


`Código fuente:' Lib/concurrent/futures/thread.py@footnote{https://github.com/python/cpython/tree/main/Lib/concurrent/futures/thread.py} y Lib/concurrent/futures/process.py@footnote{https://github.com/python/cpython/tree/main/Lib/concurrent/futures/process.py}


__________________________________________________________________


El módulo @ref{22,,concurrent.futures} provee una interfaz de alto nivel para ejecutar invocables de forma asincrónica.

The asynchronous execution can be performed with threads, using
@ref{7dd,,ThreadPoolExecutor} or @ref{161,,InterpreterPoolExecutor},
or separate processes, using @ref{163,,ProcessPoolExecutor}.
Each implements the same interface, which is defined
by the abstract @ref{3119,,Executor} class.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@menu
* Objetos ejecutores:: 
* ThreadPoolExecutor:: 
* InterpreterPoolExecutor:: 
* ProcessPoolExecutor:: 
* Objetos futuro:: 
* Funciones del módulo: Funciones del módulo<2>. 
* Clases de Excepciones:: 

@end menu

@node Objetos ejecutores,ThreadPoolExecutor,,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures executor-objects}@anchor{311a}
@subsubsection Objetos ejecutores


@geindex Executor (clase en concurrent.futures)
@anchor{library/concurrent futures concurrent futures Executor}@anchor{3119}
@deffn {Clase} concurrent.futures.Executor

Una clase abstracta que proporciona métodos para ejecutar llamadas de forma asincrónica. No debe ser utilizada directamente, sino a través de sus subclases.

@geindex submit() (método de concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor submit}@anchor{b0f}
@deffn {Método} submit (fn, /, *args, **kwargs)

Programa la invocación de `fn', que será ejecutada como @code{fn(*args, **kwargs)} y retorna un objeto @ref{1220,,Future} que representa la ejecución del invocable.

@example
with ThreadPoolExecutor(max_workers=1) as executor:
    future = executor.submit(pow, 323, 1235)
    print(future.result())
@end example
@end deffn

@geindex map() (método de concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor map}@anchor{e69}
@deffn {Método} map (fn, *iterables, timeout=None, chunksize=1)

Similar to @ref{14c,,map(fn@comma{} *iterables)} except:


@itemize *

@item 
los `iterables' son recolectados inmediatamente, en lugar de perezosamente;

@item 
`fn' is executed asynchronously and several calls to
`fn' may be made concurrently.
@end itemize

El iterador retornado lanza @ref{8cc,,TimeoutError} si @ref{1335,,__next__()} es llamado y el resultado no está disponible luego de `timeout' segundos luego de la llamada original a @ref{e69,,Executor.map()}. `timeout' puede ser un int o un float. Si no se provee un `timeout' o es @code{None}, no hay limite de espera.

If a `fn' call raises an exception, then that exception will be
raised when its value is retrieved from the iterator.

When using @ref{163,,ProcessPoolExecutor}, this method chops `iterables'
into a number of chunks which it submits to the pool as separate
tasks.  The (approximate) size of these chunks can be specified by
setting `chunksize' to a positive integer.  For very long iterables,
using a large value for `chunksize' can significantly improve
performance compared to the default size of 1.  With
@ref{7dd,,ThreadPoolExecutor} and @ref{161,,InterpreterPoolExecutor},
`chunksize' has no effect.


Distinto en la versión 3.5: Se agregó el argumento `chunksize'.

@end deffn

@geindex shutdown() (método de concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor shutdown}@anchor{984}
@deffn {Método} shutdown (wait=True, *, cancel_futures=False)

Indica al ejecutor que debe liberar todos los recursos que está utilizando cuando los futuros actualmente pendientes de ejecución finalicen. Las llamadas a @ref{b0f,,Executor.submit()} y @ref{e69,,Executor.map()} realizadas después del apagado lanzarán @ref{1e5,,RuntimeError}.

Si `wait' es @code{True} este método no retornará hasta que todos los futuros pendientes hayan terminado su ejecución y los recursos asociados al ejecutor hayan sido liberados.  Si `wait' es @code{False}, este método retornará de inmediato y los recursos asociados al ejecutor se liberarán cuando todos los futuros asociados hayan finalizado su ejecución. Independientemente del valor de `wait', el programa Python entero no finalizará hasta que todos los futuros pendientes hayan finalizado su ejecución.

Si `cancel_futures' es @code{True}, este método cancelará todos los futuros pendientes que el ejecutor no ha comenzado a ejecutar. Los futuros que se completen o estén en ejecución no se cancelarán, independientemente del valor de `cancel_futures'.

Si tanto `cancel_futures' como `wait' son @code{True}, todos los futuros que el ejecutor ha comenzado a ejecutar se completarán antes de que regrese este método. Los futuros restantes se cancelan.

Se puede evitar tener que llamar este método explícitamente si se usa la sentencia @ref{673,,with}, la cual apagará el @ref{3119,,Executor} (esperando como si @ref{984,,Executor.shutdown()} hubiera sido llamado con `wait' en @code{True}):

@example
import shutil
with ThreadPoolExecutor(max_workers=4) as e:
    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    e.submit(shutil.copy, 'src4.txt', 'dest4.txt')
@end example


Distinto en la versión 3.9: Agregado `cancel_futures'.

@end deffn
@end deffn

@node ThreadPoolExecutor,InterpreterPoolExecutor,Objetos ejecutores,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures threadpoolexecutor}@anchor{311b}
@subsubsection ThreadPoolExecutor


@ref{7dd,,ThreadPoolExecutor} es una subclase de @ref{3119,,Executor} que usa un grupo de hilos para ejecutar llamadas de forma asincrónica.

Pueden ocurrir bloqueos mutuos cuando la llamada asociada a un @ref{1220,,Future} espera el resultado de otro @ref{1220,,Future}. Por ejemplo:

@example
import time
def wait_on_b():
    time.sleep(5)
    print(b.result())  # b will never complete because it is waiting on a.
    return 5

def wait_on_a():
    time.sleep(5)
    print(a.result())  # a will never complete because it is waiting on b.
    return 6


executor = ThreadPoolExecutor(max_workers=2)
a = executor.submit(wait_on_b)
b = executor.submit(wait_on_a)
@end example

Y:

@example
def wait_on_future():
    f = executor.submit(pow, 5, 2)
    # This will never complete because there is only one worker thread and
    # it is executing this function.
    print(f.result())

executor = ThreadPoolExecutor(max_workers=1)
executor.submit(wait_on_future)
@end example

@geindex ThreadPoolExecutor (clase en concurrent.futures)
@anchor{library/concurrent futures concurrent futures ThreadPoolExecutor}@anchor{7dd}
@deffn {Clase} concurrent.futures.ThreadPoolExecutor (max_workers=None, thread_name_prefix='@w{'}, initializer=None, initargs=())

Subclase de @ref{3119,,Executor} que utiliza un grupo de hilos de `max_workers' como máximo para ejecutar llamadas de forma asincrónica.

Todos los hilos que se hayan puesto en cola en @code{ThreadPoolExecutor} se unirán antes de que el intérprete pueda salir. Tenga en cuenta que el controlador de salida que hace esto se ejecuta `antes' de cualquier controlador de salida añadido mediante @code{atexit}. Esto significa que las excepciones en el hilo principal deben ser capturadas y manejadas para indicar a los hilos que salgan correctamente. Por esta razón, se recomienda no utilizar @code{ThreadPoolExecutor} para tareas de larga duración.

`initializer' es un invocable opcional que es llamado al comienzo de cada hilo de trabajo; `initargs' es una tupla de argumentos pasados al inicializador.  Si el `initializer' lanza una excepción, todos los trabajos actualmente pendientes lanzarán @ref{311c,,BrokenThreadPool}, así como cualquier intento de enviar más trabajos al grupo.


Distinto en la versión 3.5: Si `max_workers' es @code{None} o no es especificado, se tomará por defecto el número de procesadores de la máquina, multiplicado por @code{5}, asumiendo que @ref{7dd,,ThreadPoolExecutor} a menudo se utiliza para paralelizar E/S en lugar de trabajo de CPU y que el numero de trabajadores debe ser mayor que el número de trabajadores para @ref{163,,ProcessPoolExecutor}.



Distinto en la versión 3.6: Added the `thread_name_prefix' parameter to allow users to
control the @ref{9df,,threading.Thread} names for worker threads created by
the pool for easier debugging.



Distinto en la versión 3.7: Se agregaron los argumentos `initializer' y `initargs'.



Distinto en la versión 3.8: El valor predeterminado de `max_workers' fue reemplazado por @code{min(32, os.cpu_count() + 4)}. Este valor predeterminado conserva al menos 5 trabajadores para las tareas vinculadas de E/S. Utiliza como máximo 32 núcleos de CPU para tareas vinculadas a la CPU que liberan el GIL. Y evita utilizar recursos muy grandes implícitamente en máquinas de muchos núcleos.

ThreadPoolExecutor ahora también reutiliza hilos inactivos antes de crear `max_workers' hilos de trabajo.



Distinto en la versión 3.13: Default value of `max_workers' is changed to
@code{min(32, (os.process_cpu_count() or 1) + 4)}.

@end deffn

@menu
* Ejemplo de ThreadPoolExecutor:: 

@end menu

@node Ejemplo de ThreadPoolExecutor,,,ThreadPoolExecutor
@anchor{library/concurrent futures id1}@anchor{311d}@anchor{library/concurrent futures threadpoolexecutor-example}@anchor{1221}
@subsubsection Ejemplo de ThreadPoolExecutor


@example
import concurrent.futures
import urllib.request

URLS = ['http://www.foxnews.com/',
        'http://www.cnn.com/',
        'http://europe.wsj.com/',
        'http://www.bbc.co.uk/',
        'http://nonexistent-subdomain.python.org/']

# Retrieve a single page and report the URL and contents
def load_url(url, timeout):
    with urllib.request.urlopen(url, timeout=timeout) as conn:
        return conn.read()

# We can use a with statement to ensure threads are cleaned up promptly
with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:
    # Start the load operations and mark each future with its URL
    future_to_url = @{executor.submit(load_url, url, 60): url for url in URLS@}
    for future in concurrent.futures.as_completed(future_to_url):
        url = future_to_url[future]
        try:
            data = future.result()
        except Exception as exc:
            print('%r generated an exception: %s' % (url, exc))
        else:
            print('%r page is %d bytes' % (url, len(data)))
@end example

@node InterpreterPoolExecutor,ProcessPoolExecutor,ThreadPoolExecutor,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures interpreterpoolexecutor}@anchor{311e}
@subsubsection InterpreterPoolExecutor


The @ref{161,,InterpreterPoolExecutor} class uses a pool of interpreters
to execute calls asynchronously.  It is a @ref{7dd,,ThreadPoolExecutor}
subclass, which means each worker is running in its own thread.
The difference here is that each worker has its own interpreter,
and runs each task using that interpreter.

The biggest benefit to using interpreters instead of only threads
is true multi-core parallelism.  Each interpreter has its own
@ref{2b5,,Global Interpreter Lock}, so code
running in one interpreter can run on one CPU core, while code in
another interpreter runs unblocked on a different core.

The tradeoff is that writing concurrent code for use with multiple
interpreters can take extra effort.  However, this is because it
forces you to be deliberate about how and when interpreters interact,
and to be explicit about what data is shared between interpreters.
This results in several benefits that help balance the extra effort,
including true multi-core parallelism,  For example, code written
this way can make it easier to reason about concurrency.  Another
major benefit is that you don’t have to deal with several of the
big pain points of using threads, like nrace conditions.

Each worker’s interpreter is isolated from all the other interpreters.
«Isolated» means each interpreter has its own runtime state and
operates completely independently.  For example, if you redirect
@ref{b61,,sys.stdout} in one interpreter, it will not be automatically
redirected any other interpreter.  If you import a module in one
interpreter, it is not automatically imported in any other.  You
would need to import the module separately in interpreter where
you need it.  In fact, each module imported in an interpreter is
a completely separate object from the same module in a different
interpreter, including @ref{d9,,sys}, @ref{13,,builtins},
and even @code{__main__}.

Isolation means a mutable object, or other data, cannot be used
by more than one interpreter at the same time.  That effectively means
interpreters cannot actually share such objects or data.  Instead,
each interpreter must have its own copy, and you will have to
synchronize any changes between the copies manually.  Immutable
objects and data, like the builtin singletons, strings, and tuples
of immutable objects, don’t have these limitations.

Communicating and synchronizing between interpreters is most effectively
done using dedicated tools, like those proposed in 
@geindex Python Enhancement Proposals; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}.  One less
efficient alternative is to serialize with @ref{a6,,pickle} and then send
the bytes over a shared @ref{cc,,socket} or
@ref{17e1,,pipe}.

@geindex InterpreterPoolExecutor (clase en concurrent.futures)
@anchor{library/concurrent futures concurrent futures InterpreterPoolExecutor}@anchor{161}
@deffn {Clase} concurrent.futures.InterpreterPoolExecutor (max_workers=None, thread_name_prefix='@w{'}, initializer=None, initargs=(), shared=None)

A @ref{7dd,,ThreadPoolExecutor} subclass that executes calls asynchronously
using a pool of at most `max_workers' threads.  Each thread runs
tasks in its own interpreter.  The worker interpreters are isolated
from each other, which means each has its own runtime state and that
they can’t share any mutable objects or other data.  Each interpreter
has its own @ref{2b5,,Global Interpreter Lock},
which means code run with this executor has true multi-core parallelism.

The optional `initializer' and `initargs' arguments have the same
meaning as for @code{ThreadPoolExecutor}: the initializer is run
when each worker is created, though in this case it is run.in
the worker’s interpreter.  The executor serializes the `initializer'
and `initargs' using @ref{a6,,pickle} when sending them to the worker’s
interpreter.

@cartouche
@quotation Nota 
Functions defined in the @code{__main__} module cannot be pickled
and thus cannot be used.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
The executor may replace uncaught exceptions from `initializer'
with @ref{311f,,ExecutionFailed}.
@end quotation
@end cartouche

The optional `shared' argument is a @ref{190,,dict} of objects that all
interpreters in the pool share.  The `shared' items are added to each
interpreter’s @code{__main__} module.  Not all objects are shareable.
Shareable objects include the builtin singletons, @ref{237,,str}
and @ref{325,,bytes}, and @ref{156,,memoryview}.  See 
@geindex Python Enhancement Proposals; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}
for more info.

Other caveats from parent @ref{7dd,,ThreadPoolExecutor} apply here.
@end deffn

@ref{b0f,,submit()} and @ref{e69,,map()} work like normal,
except the worker serializes the callable and arguments using
@ref{a6,,pickle} when sending them to its interpreter.  The worker
likewise serializes the return value when sending it back.

@cartouche
@quotation Nota 
Functions defined in the @code{__main__} module cannot be pickled
and thus cannot be used.
@end quotation
@end cartouche

When a worker’s current task raises an uncaught exception, the worker
always tries to preserve the exception as-is.  If that is successful
then it also sets the @code{__cause__} to a corresponding
@ref{311f,,ExecutionFailed}
instance, which contains a summary of the original exception.
In the uncommon case that the worker is not able to preserve the
original as-is then it directly preserves the corresponding
@ref{311f,,ExecutionFailed}
instance instead.

@node ProcessPoolExecutor,Objetos futuro,InterpreterPoolExecutor,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures processpoolexecutor}@anchor{3120}
@subsubsection ProcessPoolExecutor


La clase @ref{163,,ProcessPoolExecutor} es una subclase @ref{3119,,Executor} que usa un grupo de procesos para ejecutar llamadas de forma asíncrona. @ref{163,,ProcessPoolExecutor} usa el módulo @ref{94,,multiprocessing}, que le permite eludir el @ref{2b5,,Global Interpreter Lock} pero también significa que solo los objetos seleccionables pueden ser ejecutados y retornados.

El módulo @code{__main__} debe ser importable por los subprocesos trabajadores. Esto significa que @ref{163,,ProcessPoolExecutor} no funcionará en el intérprete interactivo.

Llamar a métodos de @ref{3119,,Executor} o @ref{1220,,Future} desde el invocable enviado a @ref{163,,ProcessPoolExecutor} resultará en bloqueos mutuos.

@geindex ProcessPoolExecutor (clase en concurrent.futures)
@anchor{library/concurrent futures concurrent futures ProcessPoolExecutor}@anchor{163}
@deffn {Clase} concurrent.futures.ProcessPoolExecutor (max_workers=None, mp_context=None, initializer=None, initargs=(), max_tasks_per_child=None)

An @ref{3119,,Executor} subclass that executes calls asynchronously using a pool
of at most `max_workers' processes.  If `max_workers' is @code{None} or not
given, it will default to @ref{327,,os.process_cpu_count()}.
If `max_workers' is less than or equal to @code{0}, then a @ref{360,,ValueError}
will be raised.
On Windows, `max_workers' must be less than or equal to @code{61}. If it is not
then @ref{360,,ValueError} will be raised. If `max_workers' is @code{None}, then
the default chosen will be at most @code{61}, even if more processors are
available.
`mp_context' can be a @ref{94,,multiprocessing} context or @code{None}. It will be
used to launch the workers. If `mp_context' is @code{None} or not given, the
default @ref{94,,multiprocessing} context is used.
See @ref{162,,Contextos y métodos de inicio}.

`initializer' es un invocable opcional que es llamado al comienzo de cada proceso trabajador; `initargs' es una tupla de argumentos pasados al inicializador. Si el `initializer' lanza una excepción, todos los trabajos actualmente pendientes lanzarán @code{BrokenProcessPool}, así como cualquier intento de enviar más trabajos al grupo.

`max_tasks_per_child' es un argumento opcional que especifica el número máximo de tareas que un único proceso puede ejecutar antes de salir y ser reemplazado por un nuevo proceso de trabajo. Por defecto, `max_tasks_per_child' es @code{None}, lo que significa que los procesos de trabajo vivirán tanto como el pool. Cuando se especifica un máximo, el método de inicio de multiprocesamiento «spawn» se utilizará por defecto en ausencia de un parámetro `mp_context'. Esta característica es incompatible con el método de inicio «fork».


Distinto en la versión 3.3: When one of the worker processes terminates abruptly, a
@ref{3121,,BrokenProcessPool} error is now raised.
Previously, behaviour
was undefined but operations on the executor or its futures would often
freeze or deadlock.



Distinto en la versión 3.7: El argumento `mp_context' se agregó para permitir a los usuarios controlar el método de iniciación para procesos de trabajo creados en el grupo.

Se agregaron los argumentos `initializer' y `initargs'.



Distinto en la versión 3.11: El argumento `max_tasks_per_child' se agregó para permitir a los usuarios controlar el tiempo de vida para procesos de trabajo creados en el grupo.



Distinto en la versión 3.12: En sistemas POSIX, si su aplicación tiene múltiples hilos y el contexto @ref{94,,multiprocessing} utiliza el método de inicio @code{"fork"}: La función @ref{2ff,,os.fork()} llamada internamente para generar trabajadores puede lanzar un mensaje @ref{1da,,DeprecationWarning}. Pase un `mp_context' configurado para utilizar un método de inicio diferente. Consulte la documentación de @ref{2ff,,os.fork()} para más información.



Distinto en la versión 3.13: `max_workers' uses @ref{327,,os.process_cpu_count()} by default, instead of
@ref{328,,os.cpu_count()}.



Distinto en la versión 3.14: The default process start method (see
@ref{162,,Contextos y métodos de inicio}) changed away from `fork'. If you
require the `fork' start method for @ref{163,,ProcessPoolExecutor} you must
explicitly pass @code{mp_context=multiprocessing.get_context("fork")}.

@end deffn

@menu
* Ejemplo de ProcessPoolExecutor:: 

@end menu

@node Ejemplo de ProcessPoolExecutor,,,ProcessPoolExecutor
@anchor{library/concurrent futures id2}@anchor{3122}@anchor{library/concurrent futures processpoolexecutor-example}@anchor{1222}
@subsubsection Ejemplo de `ProcessPoolExecutor'


@example
import concurrent.futures
import math

PRIMES = [
    112272535095293,
    112582705942171,
    112272535095293,
    115280095190773,
    115797848077099,
    1099726899285419]

def is_prime(n):
    if n < 2:
        return False
    if n == 2:
        return True
    if n % 2 == 0:
        return False

    sqrt_n = int(math.floor(math.sqrt(n)))
    for i in range(3, sqrt_n + 1, 2):
        if n % i == 0:
            return False
    return True

def main():
    with concurrent.futures.ProcessPoolExecutor() as executor:
        for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):
            print('%d is prime: %s' % (number, prime))

if __name__ == '__main__':
    main()
@end example

@node Objetos futuro,Funciones del módulo<2>,ProcessPoolExecutor,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures future-objects}@anchor{3123}
@subsubsection Objetos futuro


La clase @ref{1220,,Future} encapsula la ejecución asincrónica del invocable. Las instancias de @ref{1220,,Future} son creadas por @ref{b0f,,Executor.submit()}.

@geindex Future (clase en concurrent.futures)
@anchor{library/concurrent futures concurrent futures Future}@anchor{1220}
@deffn {Clase} concurrent.futures.Future

Encapsula la ejecución asincrónica del invocable. Las instancias de @ref{1220,,Future} son creadas por @ref{b0f,,Executor.submit()} y no deberían ser creadas directamente, excepto para pruebas.

@geindex cancel() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future cancel}@anchor{3124}
@deffn {Método} cancel ()

Intenta cancelar la llamada.  Si el invocable está siendo ejecutado o ha finalizado su ejecución y no puede ser cancelado el método retornará @code{False}, de lo contrario la llamada será cancelada y el método retornará @code{True}.
@end deffn

@geindex cancelled() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future cancelled}@anchor{3125}
@deffn {Método} cancelled ()

Retorna @code{True} si la llamada fue cancelada exitosamente.
@end deffn

@geindex running() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future running}@anchor{3126}
@deffn {Método} running ()

Retorna @code{True} si la llamada está siendo ejecutada y no puede ser cancelada.
@end deffn

@geindex done() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future done}@anchor{3127}
@deffn {Método} done ()

Retorna @code{True} si la llamada fue cancelada exitosamente o terminó su ejecución.
@end deffn

@geindex result() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future result}@anchor{3128}
@deffn {Método} result (timeout=None)

Retorna el valor retornado por la llamada. Si la llamada aún no se ha completado, este método esperará hasta `timeout' segundos. Si la llamada no se ha completado en `timeout' segundos, entonces se lanzará un @ref{8cc,,TimeoutError}. `timeout' puede ser un int o un float. Si `timeout' no se especifica o es @code{None}, no hay límite para el tiempo de espera.

Si el futuro es cancelado antes de finalizar su ejecución, @ref{a6c,,CancelledError} será lanzada.

Si la llamada lanzó una excepción, este método lanzará la misma excepción.
@end deffn

@geindex exception() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future exception}@anchor{3129}
@deffn {Método} exception (timeout=None)

Retorna la excepción lanzada por la llamada. Si la llamada aún no se ha completado, este método esperará hasta `timeout' segundos. Si la llamada no se ha completado en `timeout' segundos, entonces se lanzará un @ref{8cc,,TimeoutError}. `timeout' puede ser un int o un float. Si `timeout' no se especifica o es @code{None}, no hay límite para el tiempo de espera.

Si el futuro es cancelado antes de finalizar su ejecución, @ref{a6c,,CancelledError} será lanzada.

Si la llamada es completada sin excepciones, se retornará @code{`None}.
@end deffn

@geindex add_done_callback() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future add_done_callback}@anchor{312a}
@deffn {Método} add_done_callback (fn)

Asocia el invocable `fn' al futuro. `fn' va a ser llamada, con el futuro como su único argumento, cuando el futuro sea cancelado o finalice su ejecución.

Los invocables agregados se llaman en el orden en que se agregaron y siempre se llaman en un hilo que pertenece al proceso que los agregó. Si el invocable genera una subclase @ref{a6b,,Exception}, se registrará y se ignorará. Si el invocable genera una subclase @ref{65c,,BaseException}, el comportamiento no está definido.

Si el futuro ya ha finalizado su ejecución o fue cancelado, `fn' retornará inmediatamente.
@end deffn

Los siguientes métodos de @ref{1220,,Future} están pensados para ser usados en pruebas unitarias e implementaciones de @ref{3119,,Executor}.

@geindex set_running_or_notify_cancel() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_running_or_notify_cancel}@anchor{312b}
@deffn {Método} set_running_or_notify_cancel ()

Este método sólo debe ser llamado en implementaciones de @ref{3119,,Executor} antes de ejecutar el trabajo asociado al @ref{1220,,Future} y por las pruebas unitarias.

Si el método retorna @code{False} entonces el @ref{1220,,Future} fue cancelado, es decir, @ref{3124,,Future.cancel()} fue llamado y retornó @code{True}. Cualquier hilo que esté esperando a que el @ref{1220,,Future} se complete (es decir, a través de @ref{1658,,as_completed()} o @ref{186a,,wait()}) será despertado.

Si el método retorna @code{True} entonces el @ref{1220,,Future} no se ha cancelado y se ha puesto en estado de ejecución, es decir, las llamadas a @code{Future.running`()} retornarán @code{True}.

Este método solo puede ser llamado una sola vez y no puede ser llamado luego de haber llamado a @ref{312c,,Future.set_result()} o a @ref{312d,,Future.set_exception()}.
@end deffn

@geindex set_result() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_result}@anchor{312c}
@deffn {Método} set_result (result)

Establece `result' como el resultado del trabajo asociado al @ref{1220,,Future}.

Este método solo debe ser usado por implementaciones de @ref{3119,,Executor} y pruebas unitarias.


Distinto en la versión 3.8: Este método lanza @ref{15ed,,concurrent.futures.InvalidStateError} si @ref{1220,,Future} ya ha finalizado su ejecución.

@end deffn

@geindex set_exception() (método de concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_exception}@anchor{312d}
@deffn {Método} set_exception (exception)

Establece `exception', subclase de @ref{a6b,,Exception}, como el resultado del trabajo asociado al @ref{1220,,Future}.

Este método solo debe ser usado por implementaciones de @ref{3119,,Executor} y pruebas unitarias.


Distinto en la versión 3.8: Este método lanza @ref{15ed,,concurrent.futures.InvalidStateError} si @ref{1220,,Future} ya ha finalizado su ejecución.

@end deffn
@end deffn

@node Funciones del módulo<2>,Clases de Excepciones,Objetos futuro,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures module-functions}@anchor{312e}
@subsubsection Funciones del módulo


@geindex wait() (en el módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures wait}@anchor{186a}
@deffn {Función} concurrent.futures.wait (fs, timeout=None, return_when=ALL_COMPLETED)

Espera a que se completen las instancias @ref{1220,,Future} (posiblemente creadas por diferentes instancias @ref{3119,,Executor}) dadas por `fs'. Los futuros duplicados dados a `fs' se eliminan y sólo se devolverán una vez. Retorna una tupla nombrada de 2 conjuntos. El primer conjunto, llamado @code{done}, contiene los futuros que se han completado (futuros finalizados o cancelados) antes de que se complete la espera. El segundo conjunto, llamado @code{not_done}, contiene los futuros que no se completaron (futuros pendientes o en ejecución).

El argumento `timeout' puede ser usado para controlar la espera máxima en segundos antes de retornar.  `timeout' puede ser un int o un float.  Si `timeout' no es especificado o es @code{None}, no hay limite en el tiempo de espera.

`return_when' indica cuando debe retornar esta función.  Debe ser alguna de las siguientes constantes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Descripción

@item

@geindex FIRST_COMPLETED (en el módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures FIRST_COMPLETED}@anchor{312f}
@deffn {Dato} concurrent.futures.FIRST_COMPLETED
@end deffn

@tab

La función retornará cuando cualquier futuro finalice o sea cancelado.

@item

@geindex FIRST_EXCEPTION (en el módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures FIRST_EXCEPTION}@anchor{3130}
@deffn {Dato} concurrent.futures.FIRST_EXCEPTION
@end deffn

@tab

The function will return when any future finishes by raising an
exception. If no future raises an exception
then it is equivalent to @ref{3131,,ALL_COMPLETED}.

@item

@geindex ALL_COMPLETED (en el módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures ALL_COMPLETED}@anchor{3131}
@deffn {Dato} concurrent.futures.ALL_COMPLETED
@end deffn

@tab

La función retornará cuando todos los futuros finalicen o sean cancelados.

@end multitable

@end deffn

@geindex as_completed() (en el módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures as_completed}@anchor{1658}
@deffn {Función} concurrent.futures.as_completed (fs, timeout=None)

Retorna un iterador sobre las instancias de @ref{1220,,Future} (posiblemente creadas por distintas instancias de @ref{3119,,Executor}) dadas por `fs' que produce futuros a medida que van finalizando (normalmente o cancelados). Cualquier futuro dado por `fs' que esté duplicado será retornado una sola vez. Los futuros que hayan finalizado antes de la llamada a @ref{1658,,as_completed()} serán entregados primero. El iterador retornado lanzará @ref{8cc,,TimeoutError} si @ref{1335,,__next__()} es llamado y el resultado no está disponible luego de `timeout' segundos a partir de la llamada original a @ref{1658,,as_completed()}. `timeout' puede ser un int o un float. Si `timeout' no es especificado o es @code{None}, no hay límite en el tiempo de espera.
@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} – futuros - ejecutar cómputos asincrónicamente

La propuesta que describe esta propuesta de inclusión en la biblioteca estándar de Python.
@end table


@node Clases de Excepciones,,Funciones del módulo<2>,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures exception-classes}@anchor{3132}
@subsubsection Clases de Excepciones


@geindex CancelledError
@anchor{library/concurrent futures concurrent futures CancelledError}@anchor{a6c}
@deffn {Excepción} concurrent.futures.CancelledError

Lanzada cuando un futuro es cancelado.
@end deffn

@geindex TimeoutError
@anchor{library/concurrent futures concurrent futures TimeoutError}@anchor{3133}
@deffn {Excepción} concurrent.futures.TimeoutError

Un alias obsoleto de @ref{8cc,,TimeoutError}, lanzado cuando una operación en un futuro excede el tiempo de espera dado.


Distinto en la versión 3.11: Esta clase se convirtió en un alias de @ref{8cc,,TimeoutError}.

@end deffn

@geindex BrokenExecutor
@anchor{library/concurrent futures concurrent futures BrokenExecutor}@anchor{3134}
@deffn {Excepción} concurrent.futures.BrokenExecutor

Derivada de @ref{1e5,,RuntimeError}, esta excepción es lanzada cuando un ejecutor se encuentra corrupto por algún motivo y no puede ser utilizado para enviar o ejecutar nuevas tareas.


Added in version 3.7.

@end deffn

@geindex InvalidStateError
@anchor{library/concurrent futures concurrent futures InvalidStateError}@anchor{15ed}
@deffn {Excepción} concurrent.futures.InvalidStateError

Lanzada cuando una operación es realizada sobre un futuro que no permite dicha operación en el estado actual.


Added in version 3.8.

@end deffn

@geindex BrokenThreadPool
@anchor{library/concurrent futures concurrent futures thread BrokenThreadPool}@anchor{311c}
@deffn {Excepción} concurrent.futures.thread.BrokenThreadPool

Derived from @ref{3134,,BrokenExecutor}, this exception
class is raised when one of the workers
of a @ref{7dd,,ThreadPoolExecutor}
has failed initializing.


Added in version 3.7.

@end deffn

@geindex BrokenInterpreterPool
@anchor{library/concurrent futures concurrent futures interpreter BrokenInterpreterPool}@anchor{3135}
@deffn {Excepción} concurrent.futures.interpreter.BrokenInterpreterPool

Derived from @ref{311c,,BrokenThreadPool},
this exception class is raised when one of the workers
of a @ref{161,,InterpreterPoolExecutor}
has failed initializing.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex ExecutionFailed
@anchor{library/concurrent futures concurrent futures interpreter ExecutionFailed}@anchor{311f}
@deffn {Excepción} concurrent.futures.interpreter.ExecutionFailed

Raised from @ref{161,,InterpreterPoolExecutor} when
the given initializer fails or from
@ref{b0f,,submit()} when there’s an uncaught
exception from the submitted task.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex BrokenProcessPool
@anchor{library/concurrent futures concurrent futures process BrokenProcessPool}@anchor{3121}
@deffn {Excepción} concurrent.futures.process.BrokenProcessPool

Derived from @ref{3134,,BrokenExecutor} (formerly
@ref{1e5,,RuntimeError}), this exception class is raised when one of the
workers of a @ref{163,,ProcessPoolExecutor}
has terminated in a non-clean
fashion (for example, if it was killed from the outside).


Added in version 3.3.

@end deffn

@node subprocess — Subprocess management,sched — Event scheduler,concurrent futures — Launching parallel tasks,Ejecución concurrente
@anchor{library/subprocess doc}@anchor{3136}@anchor{library/subprocess module-subprocess}@anchor{d6}@anchor{library/subprocess subprocess-subprocess-management}@anchor{3137}
@subsection @code{subprocess} — Subprocess management


@geindex module; subprocess

`Código fuente:' Lib/subprocess.py@footnote{https://github.com/python/cpython/tree/main/Lib/subprocess.py}


__________________________________________________________________


El módulo @ref{d6,,subprocess} permite lanzar nuevos procesos, conectarse a sus pipes de entrada/salida/error y obtener sus códigos de resultado. Este módulo está destinado a reemplazar múltiples módulos y funciones previamente existentes:

@example
os.system
os.spawn*
@end example

Se puede obtener información sobre cómo utilizar el módulo @ref{d6,,subprocess} para reemplazar estos módulos y funciones en las siguientes secciones.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 324
PEP 324@footnote{https://peps.python.org/pep-0324/} – PEP de proposición del módulo @cite{subprocess}


@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@menu
* Uso del módulo subprocess:: 
* Consideraciones sobre seguridad:: 
* Objetos Popen:: 
* Elementos auxiliares de Popen en Windows:: 
* Antigua API de alto nivel:: 
* Cómo reemplazar anteriores funciones con el módulo subprocess:: 
* Funciones de llamada a la shell de retrocompatibilidad:: 
* Notas: Notas<2>. 

@end menu

@node Uso del módulo subprocess,Consideraciones sobre seguridad,,subprocess — Subprocess management
@anchor{library/subprocess using-the-subprocess-module}@anchor{3138}
@subsubsection Uso del módulo @code{subprocess}


La opción recomendada para invocar subprocesos es utilizar la función @ref{c0e,,run()} para todos los casos al alcance de ésta. Para usos más avanzados, se puede utilizar la interfaz de más bajo nivel @ref{301,,Popen}.

@geindex run() (en el módulo subprocess)
@anchor{library/subprocess subprocess run}@anchor{c0e}
@deffn {Función} subprocess.run (args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None, **other_popen_kwargs)

Ejecuta la orden descrita por `args'. Espera a que termine y retorna una instancia de @ref{ef3,,CompletedProcess}.

Los argumentos mostrados en la definición superior son sólo los más comunes; que se describen posteriormente en @ref{3139,,Argumentos frecuentemente empleados} (de ahí el uso de la notación por clave en la signatura abreviada). La signatura completa de la función es a grandes rasgos la misma que la del constructor de @ref{301,,Popen}; la mayoría de los argumentos de esta función se pasan a esa interfaz (no es el caso de  `timeout',  `input', `check' ni `capture_output').

If `capture_output' is true, stdout and stderr will be captured.
When used, the internal @ref{301,,Popen} object is automatically created with
`stdout' and `stderr' both set to @ref{c0f,,PIPE}.
The `stdout' and `stderr' arguments may not be supplied at the same time as `capture_output'.
If you wish to capture and combine both streams into one,
set `stdout' to @ref{c0f,,PIPE}
and `stderr' to @ref{313a,,STDOUT},
instead of using `capture_output'.

A `timeout' may be specified in seconds, it is internally passed on to
@ref{313b,,Popen.communicate()}. If the timeout expires, the child process will be
killed and waited for. The @ref{313c,,TimeoutExpired} exception will be
re-raised after the child process has terminated. The initial process
creation itself cannot be interrupted on many platform APIs so you are not
guaranteed to see a timeout exception until at least after however long
process creation takes.

The `input' argument is passed to @ref{313b,,Popen.communicate()} and thus to the
subprocess’s stdin.  If used it must be a byte sequence, or a string if
`encoding' or `errors' is specified or `text' is true.  When
used, the internal @ref{301,,Popen} object is automatically created with
`stdin' set to @ref{c0f,,PIPE},
and the `stdin' argument may not be used as well.

Si `check' es verdadero y el proceso retorna un resultado distinto de cero, se lanzará una excepción @ref{138c,,CalledProcessError}. Los atributos de dicha excepción contendrán los argumentos, el código retornado y tanto stdout como stderr si se capturaron.

Si se especifican `encoding' o `errors' o `text' es verdadero, se abrirán los objetos fichero para stdin, stdout y stderr en modo texto, con los `encoding' y `errors' especificados o los valores predeterminados de @ref{854,,io.TextIOWrapper}. El argumento `universal_newlines' equivale a `text' y se admite por compatibilidad hacia atrás. Los objetos fichero se abren en modo binario por defecto.

If `env' is not @code{None}, it must be a mapping that defines the environment
variables for the new process; these are used instead of the default
behavior of inheriting the current process” environment. It is passed
directly to @ref{301,,Popen}. This mapping can be str to str on any platform
or bytes to bytes on POSIX platforms much like @ref{196,,os.environ} or
@ref{197,,os.environb}.

Ejemplos:

@example
>>> subprocess.run(["ls", "-l"])  # doesn't capture output
CompletedProcess(args=['ls', '-l'], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'@w{'})
@end example


Added in version 3.5.



Distinto en la versión 3.6: Se añadieron los parámetros `encoding' y `errors'



Distinto en la versión 3.7: Se añadió el parámetro `text' como alias más comprensible de `universal_newlines'. Se añadió el parámetro `capture_output'.



Distinto en la versión 3.12: Changed Windows shell search order for @code{shell=True}. The current
directory and @code{%PATH%} are replaced with @code{%COMSPEC%} and
@code{%SystemRoot%\System32\cmd.exe}. As a result, dropping a
malicious program named @code{cmd.exe} into a current directory no
longer works.

@end deffn

@geindex CompletedProcess (clase en subprocess)
@anchor{library/subprocess subprocess CompletedProcess}@anchor{ef3}
@deffn {Clase} subprocess.CompletedProcess

El valor retornado por @ref{c0e,,run()}, que representa un proceso ya terminado.

@geindex args (atributo de subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess args}@anchor{313d}
@deffn {Atributo} args

Los argumentos utilizados para lanzar el proceso. Pueden ser una lista o una cadena.
@end deffn

@geindex returncode (atributo de subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess returncode}@anchor{313e}
@deffn {Atributo} returncode

Estado de salida del proceso hijo. Típicamente, un estado de salida 0 indica que la ejecución tuvo éxito.

Un valor negativo @code{-N} indica que el hijo fue forzado a terminar con la señal @code{N} (solamente POSIX).
@end deffn

@geindex stdout (atributo de subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess stdout}@anchor{313f}
@deffn {Atributo} stdout

La salida estándar capturada del proceso hijo. Una secuencia de bytes, o una cadena si se llamó a @ref{c0e,,run()} con `encoding', `errors', o `text' establecidos a @code{True}. @code{None} si no se capturó el error estándar.

Si se ejecutó el proceso con @code{stderr=subprocess.STDOUT}, stdout y stderr se combinarán en este atributo, y @ref{3140,,stderr} será @code{None}.
@end deffn

@geindex stderr (atributo de subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess stderr}@anchor{3140}
@deffn {Atributo} stderr

El error estándar capturado del proceso hijo. Una secuencia de bytes, o una cadena si se llamó a @ref{c0e,,run()} con `encoding', `errors', o `text' establecidos a @code{True}. @code{None} si no se capturó el error estándar.
@end deffn

@geindex check_returncode() (método de subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess check_returncode}@anchor{3141}
@deffn {Método} check_returncode ()

Si @ref{313e,,returncode} no es cero, lanza un @ref{138c,,CalledProcessError}.
@end deffn


Added in version 3.5.

@end deffn

@geindex DEVNULL (en el módulo subprocess)
@anchor{library/subprocess subprocess DEVNULL}@anchor{11bf}
@deffn {Dato} subprocess.DEVNULL

Valor especial que se puede usar como argumento `stdin', `stdout' o `stderr' de @ref{301,,Popen} y que indica que se usará el fichero especial @ref{1a3a,,os.devnull}.


Added in version 3.3.

@end deffn

@geindex PIPE (en el módulo subprocess)
@anchor{library/subprocess subprocess PIPE}@anchor{c0f}
@deffn {Dato} subprocess.PIPE

Valor especial que se puede usar como argumento `stdin', `stdout' o `stderr' de @ref{301,,Popen} y que indica que se abrirá un pipe al flujo indicado. Es útil para usarlo con @ref{313b,,Popen.communicate()}.
@end deffn

@geindex STDOUT (en el módulo subprocess)
@anchor{library/subprocess subprocess STDOUT}@anchor{313a}
@deffn {Dato} subprocess.STDOUT

Valor especial que se puede usar de argumento `stderr' a @ref{301,,Popen} y que indica que el error estándar debería ir al mismo gestor que la salida estándar.
@end deffn

@geindex SubprocessError
@anchor{library/subprocess subprocess SubprocessError}@anchor{3142}
@deffn {Excepción} subprocess.SubprocessError

Clase base para el resto de excepciones de este módulo.


Added in version 3.3.

@end deffn

@geindex TimeoutExpired
@anchor{library/subprocess subprocess TimeoutExpired}@anchor{313c}
@deffn {Excepción} subprocess.TimeoutExpired

Subclase de @ref{3142,,SubprocessError}, se lanza cuando expira un plazo de ejecución esperando a un proceso hijo.

@geindex cmd (atributo de subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired cmd}@anchor{3143}
@deffn {Atributo} cmd

Orden que se utilizó para lanzar el proceso hijo.
@end deffn

@geindex timeout (atributo de subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired timeout}@anchor{3144}
@deffn {Atributo} timeout

Plazo de ejecución en segundos.
@end deffn

@geindex output (atributo de subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired output}@anchor{3145}
@deffn {Atributo} output

Salida del proceso hijo si fue capturado por @ref{c0e,,run()} o @ref{1040,,check_output()}. De lo contrario, @code{None}. Siempre es @ref{325,,bytes} cuando se capturó cualquier salida, independientemente de la configuración de @code{text=True}. Puede permanecer @code{None} en lugar de @code{b'@w{'}} cuando no se observó ningún resultado.
@end deffn

@geindex stdout (atributo de subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired stdout}@anchor{3146}
@deffn {Atributo} stdout

Alias de `output', por simetría con @ref{3147,,stderr}.
@end deffn

@geindex stderr (atributo de subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired stderr}@anchor{3147}
@deffn {Atributo} stderr

Salida Stderr del proceso hijo si fue capturado por @ref{c0e,,run()}. De lo contrario, @code{None}. Siempre es @ref{325,,bytes} cuando se capturó la salida de stderr independientemente de la configuración de @code{text=True}. Puede permanecer como @code{None} en lugar de @code{b'@w{'}} cuando no se observó ninguna salida de stderr.
@end deffn


Added in version 3.3.



Distinto en la versión 3.5: Se añadieron los atributos `stdout' y `stderr'

@end deffn

@geindex CalledProcessError
@anchor{library/subprocess subprocess CalledProcessError}@anchor{138c}
@deffn {Excepción} subprocess.CalledProcessError

Subclase de @ref{3142,,SubprocessError}, lanzada cuando un proceso ejecutado por @ref{3148,,check_call()}, @ref{1040,,check_output()} o @ref{c0e,,run()} (con @code{check=True}) devuelve un estado de salida distinto de cero.

@geindex returncode (atributo de subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError returncode}@anchor{3149}
@deffn {Atributo} returncode

Estado de salida del proceso hijo. Si el proceso terminó por causa de una señal, el estado será el número de la señal en negativo.
@end deffn

@geindex cmd (atributo de subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError cmd}@anchor{314a}
@deffn {Atributo} cmd

Orden que se utilizó para lanzar el proceso hijo.
@end deffn

@geindex output (atributo de subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError output}@anchor{314b}
@deffn {Atributo} output

Salida del proceso hijo si fue capturada por @ref{c0e,,run()} o @ref{1040,,check_output()}.  De otro modo, @code{None}.
@end deffn

@geindex stdout (atributo de subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError stdout}@anchor{314c}
@deffn {Atributo} stdout

Alias de `output', por simetría con @ref{314d,,stderr}.
@end deffn

@geindex stderr (atributo de subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError stderr}@anchor{314d}
@deffn {Atributo} stderr

Salida de `stderr' del proceso hijo si fue capturada por @ref{c0e,,run()}. De otro modo, @code{None}.
@end deffn


Distinto en la versión 3.5: Se añadieron los atributos `stdout' y `stderr'

@end deffn

@menu
* Argumentos frecuentemente empleados:: 
* El constructor de Popen:: 
* Excepciones: Excepciones<9>. 

@end menu

@node Argumentos frecuentemente empleados,El constructor de Popen,,Uso del módulo subprocess
@anchor{library/subprocess frequently-used-arguments}@anchor{3139}@anchor{library/subprocess id1}@anchor{314e}
@subsubsection Argumentos frecuentemente empleados


Para permitir una gran variedad de usos, el constructor de @ref{301,,Popen} (y las funciones asociadas) aceptan un gran número de argumentos opcionales. Para los usos más habituales, se pueden dejar de forma segura los valores por defecto. Los argumentos más frecuentemente necesarios son:

@quotation

`args' se requiere en todas las llamadas; debe ser una cadena o una secuencia de argumentos al programa. En general, es mejor proporcionar una secuencia de argumentos porque permite que el módulo se ocupe de las secuencias de escape y los entrecomillados de los argumentos (por ejemplo, para permitir espacios en los nombres de fichero). Si se pasa una cadena simple, se ha de especificar `shell' como @ref{c95,,True} (ver más adelante) o la cadena debe ser el nombre del programa a ejecutar sin especificar ningún argumento.

`stdin', `stdout' and `stderr' specify the executed program’s standard input,
standard output and standard error file handles, respectively.  Valid values
are @code{None}, @ref{c0f,,PIPE}, @ref{11bf,,DEVNULL}, an existing file descriptor (a
positive integer), and an existing @ref{1230,,file object} with a valid file
descriptor.  With the default settings of @code{None}, no redirection will
occur.  @ref{c0f,,PIPE} indicates that a new pipe to the child should be
created.  @ref{11bf,,DEVNULL} indicates that the special file @ref{1a3a,,os.devnull}
will be used.  Additionally, `stderr' can be @ref{313a,,STDOUT}, which indicates
that the stderr data from the child process should be captured into the same
file handle as for `stdout'.

@geindex universal newlines;subprocess module

Si se especifican `encoding' o `errors', o `text' (o su alias `universal_newlines') es verdadero, se abrirán en modo texto los objetos fichero `stdin', `stdout' y `stderr' usando los `encoding' y `errors' especificados en la llamada o los valores predeterminados de @ref{854,,io.TextIOWrapper}.

Para `stdin', los saltos del línea @code{'\n'} de la entrada serán convertidos al separador de línea predeterminado @ref{2181,,os.linesep}. Para `stdout' y `stderr', todos los saltos de línea de la salida serán convertidos a @code{'\n'}. Hay más información en la documentación de la clase @ref{854,,io.TextIOWrapper} para el caso en que el argumento  `newline' de su constructor es @code{None}.

Si no se usa el modo texto, `stdin', `stdout' y `stderr' se abrirán como flujos binarios. No se realizará ninguna codificación ni conversión de salto de línea.


Distinto en la versión 3.6: Added the `encoding' and `errors' parameters.



Distinto en la versión 3.7: Se añadió el parámetro `text' como alias de `universal_newlines'.


@cartouche
@quotation Nota 
El atributo @cite{newlines} de los objetos fichero @ref{314f,,Popen.stdin}, @ref{3150,,Popen.stdout} y @ref{3151,,Popen.stderr} no es actualizado por el método  @ref{313b,,Popen.communicate()}.
@end quotation
@end cartouche

Si `shell' es @code{True}, la orden especificada se ejecutará pasando por la shell. Esto tiene utilidad si se usa Python principalmente por el flujo de control mejorado sobre la mayoría de las shell de sistema, pero se desea también un acceso práctico a otras características de la shell, como pipes, nombres de fichero con comodines, expansión de variables de entorno o expansión de @code{~} al directorio `home' del usuario. Sin embargo, no se debe olvidar que el propio Python tiene implementaciones de muchas características tipo shell (en particular, @ref{64,,glob}, @ref{5c,,fnmatch}, @ref{551,,os.walk()}, @ref{1419,,os.path.expandvars()}, @ref{aa6,,os.path.expanduser()}, y @ref{c5,,shutil}).


Distinto en la versión 3.3: Cuando `universal_newlines' es @code{True}, la clase usa la codificación @ref{5dc,,locale.getpreferredencoding(False)} en lugar de @code{locale.getpreferredencoding()}.  Ver la clase @ref{854,,io.TextIOWrapper} para obtener más información sobre este cambio.


@cartouche
@quotation Nota 
Leer la sección @ref{3152,,Consideraciones sobre la seguridad} antes de usar @code{shell=True}.
@end quotation
@end cartouche
@end quotation

Estas opciones y el resto se describen con más detalle en la documentación del constructor de @ref{301,,Popen}.

@node El constructor de Popen,Excepciones<9>,Argumentos frecuentemente empleados,Uso del módulo subprocess
@anchor{library/subprocess popen-constructor}@anchor{3153}
@subsubsection El constructor de Popen


El proceso interno de creación y gestión de este módulo lo gestiona la clase @ref{301,,Popen}. Proporciona una gran flexibilidad para que los desarrolladores sean capaces de gestionar los casos menos comunes que quedan sin cubrir por las funciones auxiliares.

@geindex Popen (clase en subprocess)
@anchor{library/subprocess subprocess Popen}@anchor{301}
@deffn {Clase} subprocess.Popen (args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, group=None, extra_groups=None, user=None, umask=-1, encoding=None, errors=None, text=None, pipesize=-1, process_group=None)

Ejecuta un programa hijo en un proceso nuevo. En POSIX, la clase usa  @ref{2bc2,,os.execvp()} como comportamiento para lanzar el proceso hijo. En Windows, la clase usa la función @code{CreateProcess()} de Windows. Los argumentos de @ref{301,,Popen} son los siguientes.

`args' debe ser o una secuencia de argumentos de programa o una cadena simple o un @ref{3f0,,objeto tipo ruta}. Por omisión, el programa a ejecutar es el primer elemento de `args' si `args' es una secuencia.  Si `args' es una cadena, la interpretación es dependiente de la plataforma, según se describe más abajo. Véase los argumentos `shell' y `executable' para más información sobre el comportamiento por defecto. Salvo que se indique, se recomienda pasar los `args' como una secuencia.

@cartouche
@quotation Advertencia 
Para obtener la máxima confiabilidad, use una ruta completa para el ejecutable. Para buscar un nombre no calificado en 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}, use @ref{55b,,shutil.which()}. En todas las plataformas, pasar @ref{283,,sys.executable} es la forma recomendada de iniciar de nuevo el intérprete de Python actual y usar el formato de línea de comandos @code{-m} para iniciar un módulo instalado.

La resolución de la ruta de `executable' (o el primer elemento de `args') depende de la plataforma. Para POSIX, consulte @ref{2bc3,,os.execvpe()}, y tenga en cuenta que al resolver o buscar la ruta ejecutable, `cwd' anula el directorio de trabajo actual y `env' puede anular la variable de entorno @code{PATH}. Para Windows, consulte la documentación de los parámetros @code{lpApplicationName} e @code{lpCommandLine} de WinAPI @code{CreateProcess}, y tenga en cuenta que al resolver o buscar la ruta ejecutable con @code{shell = False}, `cwd' no anula el directorio de trabajo actual y `env' no puede anular la variable de entorno @code{PATH}. El uso de una ruta completa evita todas estas variaciones.
@end quotation
@end cartouche

Un ejemplo del paso de argumentos a un programa externo mediante una secuencia:

@example
Popen(["/usr/bin/git", "commit", "-m", "Fixes a bug."])
@end example

En POSIX, si `args' es una cadena se interpreta como el nombre o la ruta del programa que ejecutar. Sin embargo, esto solamente funciona si no hay que pasar argumentos al programa.

@cartouche
@quotation Nota 
Puede que no resulte evidente cómo descomponer una orden de la shell en una secuencia de argumentos, especialmente en casos complejos. @ref{5de,,shlex.split()} puede aclarar cómo determinar la descomposición en tokens de `args':

@example
>>> import shlex, subprocess
>>> command_line = input()
/bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'"
>>> args = shlex.split(command_line)
>>> print(args)
['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"]
>>> p = subprocess.Popen(args) # Success!
@end example

Hay que destacar en particular que las opciones (como `-input') y los argumentos (como `eggs.txt') que van separados por espacio en blanco en la shell van en elementos de lista separados, mientras los argumentos que necesitan entrecomillado o escapado de espacios cuando se usan en la shell (como los nombres de ficheros con espacios o la orden `echo' anteriormente mostrada) son elementos simples de la lista.
@end quotation
@end cartouche

En Windows, si `args' es una secuencia, se convertirá a cadena del modo descrito en @ref{3154,,Cómo convertir una secuencia de argumentos a una cadena en Windows}. Esto es así porque la función de bajo nivel @code{CreateProcess()} funciona sobre cadenas.


Distinto en la versión 3.6: El parámetro `args' toma un @ref{3f0,,objeto tipo ruta} si `shell' es @code{False} y una secuencia de objetos tipo fichero en POSIX.



Distinto en la versión 3.8: El parámetro `args' toma un @ref{3f0,,objeto tipo ruta} si `shell' es @code{False} y una secuencia de bytes y objetos tipo fichero en Windows.


El argumento `shell' (@code{False} por defecto) especifica si usar la shell como programa a ejecutar. Si `shell' es @code{True}, se recomienda pasar `args' como cadena mejor que como secuencia.

En POSIX con @code{shell=True}, la shell predeterminada es @code{/bin/sh}.  Si `args' es una cadena, ésta especifica la orden a ejecutar por la shell. Esto significa que la cadena tiene que tener el formato que tendría si se tecleara en la línea de órdenes. Esto incluye, por ejemplo, el entrecomillado y las secuencias de escape necesarias para los nombres de fichero que contengan espacios. Si `args' es una secuencia, el primer elemento especifica la cadena de la orden y cualquier otro elemento será tratado como argumentos adicionales a la propia shell. De este modo, @ref{301,,Popen} hace el equivalente de:

@example
Popen(['/bin/sh', '-c', args[0], args[1], ...])
@end example

En Windows con @code{shell=True}, la variable de entorno 
@geindex COMSPEC
@geindex variables de entorno; COMSPEC
@code{COMSPEC} especifica la shell predeterminada. Solamente hace falta especificar @code{shell=True} en Windows cuando la orden que se desea ejecutar es interna a la shell (como. @code{dir} o @code{copy}).  No hace falta especificar @code{shell=True} para ejecutar un fichero por lotes o un ejecutable de consola.

@cartouche
@quotation Nota 
Leer la sección @ref{3152,,Consideraciones sobre la seguridad} antes de usar @code{shell=True}.
@end quotation
@end cartouche

Se proporcionará `bufsize' como el argumento correspondiente a la función @ref{1be,,open()} cuando se creen los objetos fichero de los flujos stdin/stdout/stderr:


@itemize -

@item 
@code{0} means unbuffered (read and write are one
system call and can return short)

@item 
@code{1} means line buffered
(only usable if @code{text=True} or @code{universal_newlines=True})

@item 
cualquier otro valor positivo indica que hay que usar un búfer de aproximadamente dicho tamaño

@item 
`bufsize' negativo (el valor por defecto) indica que se use el valor predeterminado del sistema, @cite{io.DEFAULT_BUFFER_SIZE}.
@end itemize


Distinto en la versión 3.3.1: `bufsize' now defaults to -1 to enable buffering by default to match the
behavior that most code expects.  In versions prior to Python 3.2.4 and
3.3.1 it incorrectly defaulted to @code{0} which was unbuffered
and allowed short reads.  This was unintentional and did not match the
behavior of Python 2 as most code expected.


El argumento `executable' especifica un programa de reemplazo que ejecutar. Esto es muy poco frecuente. Cuando @code{shell=False}, `executable' reemplaza al programa especificado por `args'. Sin embargo, se pasan los `args' originales al programa. La mayoría de los programas tratan el programa especificado en los `args' como el nombre del programa, que puede ser diferente del programa realmente ejecutado. En POSIX, el nombre en `args' funciona como nombre visible en utilidades como  @code{ps}.  Si @code{shell=True}, en POSIX el argumento `executable' especifica una shell de reemplazo de la predeterminada @code{/bin/sh}.


Distinto en la versión 3.6: El parámetro `executable' acepta un @ref{3f0,,objeto tipo ruta} en POSIX.



Distinto en la versión 3.8: El parámetro `executable' acepta bytes y un @ref{3f0,,objeto tipo ruta} en POSIX.



Distinto en la versión 3.12: Changed Windows shell search order for @code{shell=True}. The current
directory and @code{%PATH%} are replaced with @code{%COMSPEC%} and
@code{%SystemRoot%\System32\cmd.exe}. As a result, dropping a
malicious program named @code{cmd.exe} into a current directory no
longer works.


`stdin', `stdout' and `stderr' specify the executed program’s standard input,
standard output and standard error file handles, respectively.  Valid values
are @code{None}, @ref{c0f,,PIPE}, @ref{11bf,,DEVNULL}, an existing file descriptor (a
positive integer), and an existing @ref{1230,,file object} with a valid file
descriptor.  With the default settings of @code{None}, no redirection will
occur.  @ref{c0f,,PIPE} indicates that a new pipe to the child should be
created.  @ref{11bf,,DEVNULL} indicates that the special file @ref{1a3a,,os.devnull}
will be used.  Additionally, `stderr' can be @ref{313a,,STDOUT}, which indicates
that the stderr data from the applications should be captured into the same
file handle as for `stdout'.

Si se establece `preexec_fn' a un objeto invocable, se llamará a dicho objeto en el proceso hijo justo antes de que se ejecute el hijo. (solamente POSIX)

@cartouche
@quotation Advertencia 
El parámetro `preexec_fn' NO ES SEGURO para usar en presencia de hilos en su aplicación. El subproceso podría bloquearse antes de que se llame a exec.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Si necesita modificar el entorno para el subproceso, use el parámetro `env' en lugar de hacerlo en un `preexec_fn'. Los parámetros `start_new_session' y `process_group' deben ocupar el lugar del código que usa `preexec_fn' para llamar a @ref{19de,,os.setsid()} o @ref{2b23,,os.setpgid()} en el subproceso
@end quotation
@end cartouche


Distinto en la versión 3.8: Se ha abandonado el soporte de `preexec_fn' en subintérpretes. El uso de dicho parámetro en un subintérprete lanza @ref{1e5,,RuntimeError}. La nueva restricción puede afectar a aplicaciones desplegadas en `mod_wsgi', `uWSGI' y otros entornos incrustados.


If `close_fds' is true, all file descriptors except @code{0}, @code{1} and
@code{2} will be closed before the child process is executed.  Otherwise
when `close_fds' is false, file descriptors obey their inheritable flag
as described in @ref{f7c,,Herencia de los descriptores de archivos}.

En Windows, si `close_fds' es verdadero el proceso hijo no heredará ningún gestor de fichero salvo que se le pasen explícitamente en el elemento @code{handle_list} de @ref{c96,,STARTUPINFO.lpAttributeList}, o mediante redirección estándar.


Distinto en la versión 3.2: El valor predeterminado de `close_fds' se cambió de @ref{bbf,,False} a lo antes descrito.



Distinto en la versión 3.7: En Windows, el valor predeterminado de `close_fds' se cambió de @ref{bbf,,False} a @ref{c95,,True} al redirigir los gestores estándar. Ahora es posible establecer `close_fds' a @ref{c95,,True} cuando se redirigen los gestores estándar.


`pass_fds' es una secuencia de descriptor de ficheros opcional que han de mantenerse abiertos entre el proceso padre e hijo. Si se proporciona un valor a `pass_fds' se fuerza `close_fds' a @ref{c95,,True}.  (solamente POSIX)


Distinto en la versión 3.2: Se añadió el parámetro `pass_fds'.


Si `cwd' no es @code{None}, la función cambia el directorio de trabajo a `cwd' antes de ejecutar el proceso hijo.  `cwd' puede ser una cadena, o un objeto bytes o @ref{3f0,,tipo ruta}. En POSIX, la función busca `executable' (o el primer elemento de `args') relativo a `cwd' si la ruta del ejecutable es relativa.


Distinto en la versión 3.6: El parámetro `cwd' acepta un @ref{3f0,,objeto tipo ruta} en POSIX.



Distinto en la versión 3.7: El parámetro `cwd' acepta un @ref{3f0,,objeto tipo ruta} en Windows.



Distinto en la versión 3.8: El parámetro `cwd' acepta un objeto bytes en Windows.


Si `restore_signals' es verdadero (el valor por defecto) todas las señales que Python ha establecido a  SIG_IGN se restauran a SIG_DFL en el proceso hijo antes del `exec'. En la actualidad, esto incluye las señales SIGPIPE, SIGXFZ y SIGXFSZ (solamente POSIX).


Distinto en la versión 3.2: Se añadió `restore_signals'.


Si `start_new_session' es verdadero, la llamada al sistema @code{setsid()} se realizará en el proceso secundario antes de la ejecución del subproceso.

@ref{1d5a,,Availability}: POSIX


Distinto en la versión 3.2: Se añadió `start_new_session'.


Si `process_group' es un entero no negativo, la llamada al sistema @code{setpgid(0, value)} se realizará en el proceso secundario antes de la ejecución del subproceso.

@ref{1d5a,,Availability}: POSIX


Distinto en la versión 3.11: Se agregó `process_group'.


If `group' is not @code{None}, the setregid() system call will be made in the
child process prior to the execution of the subprocess. If the provided
value is a string, it will be looked up via @ref{3155,,grp.getgrnam()} and
the value in @code{gr_gid} will be used. If the value is an integer, it
will be passed verbatim. (POSIX only)

@ref{1d5a,,Availability}: POSIX


Added in version 3.9.


If `extra_groups' is not @code{None}, the setgroups() system call will be
made in the child process prior to the execution of the subprocess.
Strings provided in `extra_groups' will be looked up via
@ref{3155,,grp.getgrnam()} and the values in @code{gr_gid} will be used.
Integer values will be passed verbatim. (POSIX only)

@ref{1d5a,,Availability}: POSIX


Added in version 3.9.


If `user' is not @code{None}, the setreuid() system call will be made in the
child process prior to the execution of the subprocess. If the provided
value is a string, it will be looked up via @ref{3156,,pwd.getpwnam()} and
the value in @code{pw_uid} will be used. If the value is an integer, it will
be passed verbatim. (POSIX only)

@ref{1d5a,,Availability}: POSIX


Added in version 3.9.


Si `umask' no es negativo, la llamada a sistema umask() se hará en el proceso hijo antes de la ejecución del subproceso.

@ref{1d5a,,Availability}: POSIX


Added in version 3.9.


If `env' is not @code{None}, it must be a mapping that defines the environment
variables for the new process; these are used instead of the default
behavior of inheriting the current process” environment. This mapping can be
str to str on any platform or bytes to bytes on POSIX platforms much like
@ref{196,,os.environ} or @ref{197,,os.environb}.

@cartouche
@quotation Nota 
Si se especifica, `env' debe proporcionar las variables necesarias para que el programa se ejecute. En Windows, para ejecutar una side-by-side assembly@footnote{https://en.wikipedia.org/wiki/Side-by-Side_Assembly} el `env' especificado `debe' incluir un 
@geindex SystemRoot
@geindex variables de entorno; SystemRoot
@code{SystemRoot} válido.
@end quotation
@end cartouche

Si se especifican `encoding' o `errors', o `text' es verdadero, los objetos de archivo `stdin', `stdout' y `stderr' se abren en modo de texto con los `encoding' y `errors' especificados, como se describe anteriormente en @ref{3139,,Argumentos frecuentemente empleados}. El argumento `universal_newlines' es equivalente a `text' y se proporciona para compatibilidad con versiones anteriores. De forma predeterminada, los objetos de archivo se abren en modo binario.


Added in version 3.6: Se añadieron `encoding' y `errors'.



Added in version 3.7: Se añadió `text' como alias más legible de `universal_newlines'.


If given, `startupinfo' will be a @ref{3157,,STARTUPINFO} object, which is
passed to the underlying @code{CreateProcess} function.

If given, `creationflags', can be one or more of the following flags:


@itemize *

@item 
@ref{3158,,CREATE_NEW_CONSOLE}

@item 
@ref{3159,,CREATE_NEW_PROCESS_GROUP}

@item 
@ref{315a,,ABOVE_NORMAL_PRIORITY_CLASS}

@item 
@ref{315b,,BELOW_NORMAL_PRIORITY_CLASS}

@item 
@ref{315c,,HIGH_PRIORITY_CLASS}

@item 
@ref{315d,,IDLE_PRIORITY_CLASS}

@item 
@ref{315e,,NORMAL_PRIORITY_CLASS}

@item 
@ref{315f,,REALTIME_PRIORITY_CLASS}

@item 
@ref{3160,,CREATE_NO_WINDOW}

@item 
@ref{3161,,DETACHED_PROCESS}

@item 
@ref{3162,,CREATE_DEFAULT_ERROR_MODE}

@item 
@ref{3163,,CREATE_BREAKAWAY_FROM_JOB}
@end itemize

`pipeize' se puede usar para cambiar el tamaño de la tubería cuando @ref{c0f,,PIPE} se usa para `stdin', `stdout' o `stderr'. El tamaño de la tubería solo se cambia en plataformas que lo admiten (solo Linux en este momento de redacción). Otras plataformas ignorarán este parámetro.


Distinto en la versión 3.10: Added the `pipesize' parameter.


Se puede usar los objetos Popen como gestores de contexto mediante sentencia @ref{673,,with}: a la salida, los descriptores de flujo se cierran y se espera a que acabe el proceso.

@example
with Popen(["ifconfig"], stdout=PIPE) as proc:
    log.write(proc.stdout.read())
@end example

Popen y el resto de las funciones de este módulo que la usan lanzan un @ref{18c3,,evento de auditoría} @code{subprocess.Popen} con argumentos @code{executable}, @code{args}, @code{cwd} y @code{env}. El valor de @code{args} puede ser una cadena simple o un alista de cadenas, dependiendo de la plataforma.


Distinto en la versión 3.2: Se añadió la funcionalidad de gestor de contexto.



Distinto en la versión 3.6: El destructor de Popen ahora emite una advertencia @ref{39d,,ResourceWarning} si el proceso hijo todavía se está ejecutando.



Distinto en la versión 3.8: Popen puede usar @ref{37d,,os.posix_spawn()} en algunos casos para obtener mejor rendimiento. En el Subsistema de Windows para Linux (WSL) y en la emulación del modo usuario de QEMU, el constructor de Popen que use @ref{37d,,os.posix_spawn()} ya no lanzará una excepción cuando se den errores tales como que un programa no esté, sino que el proceso hijo fracasará con un @ref{19b1,,returncode} distinto de cero.

@end deffn

@node Excepciones<9>,,El constructor de Popen,Uso del módulo subprocess
@anchor{library/subprocess exceptions}@anchor{3164}
@subsubsection Excepciones


Las excepciones lanzadas en el proceso hijo, antes de que el nuevo programa haya empezado a ejecutarse, se relanzarán en el padre.

La excepción más común que se lanza es @ref{4d5,,OSError}. Esto ocurre, por ejemplo, al intentar ejecutar un archivo inexistente. Las aplicaciones deben prepararse para excepciones @ref{4d5,,OSError}. Tenga en cuenta que, cuando @code{shell = True}, @ref{4d5,,OSError} será lanzado por el hijo solo si no se encontró el shell seleccionado. Para determinar si el shell no pudo encontrar la aplicación solicitada, es necesario verificar el código de retorno o la salida del subproceso.

Se lanzará un @ref{360,,ValueError} si se llama a @ref{301,,Popen} con argumentos no válidos.

@ref{3148,,check_call()} y @ref{1040,,check_output()} lanzarán un @ref{138c,,CalledProcessError} si el proceso invocado retorna un código de retorno distinto de cero.

All of the functions and methods that accept a `timeout' parameter, such as
@ref{c0e,,run()} and @ref{313b,,Popen.communicate()} will raise @ref{313c,,TimeoutExpired} if
the timeout expires before the process exits.

Todas las excepciones definidas en este módulo heredan de @ref{3142,,SubprocessError}.


Added in version 3.3: Se añadió la clase base @ref{3142,,SubprocessError}.


@node Consideraciones sobre seguridad,Objetos Popen,Uso del módulo subprocess,subprocess — Subprocess management
@anchor{library/subprocess security-considerations}@anchor{3152}@anchor{library/subprocess subprocess-security}@anchor{3165}
@subsubsection Consideraciones sobre seguridad


Unlike some other popen functions, this library will not
implicitly choose to call a system shell.  This means that all characters,
including shell metacharacters, can safely be passed to child processes.
If the shell is invoked explicitly, via @code{shell=True}, it is the application’s
responsibility to ensure that all whitespace and metacharacters are
quoted appropriately to avoid
shell injection@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection}
vulnerabilities. On @ref{3166,,some platforms}, it is possible
to use @ref{3d2,,shlex.quote()} for this escaping.

On Windows, batch files (@code{*.bat} or @code{*.cmd}) may be launched by the
operating system in a system shell regardless of the arguments passed to this
library. This could result in arguments being parsed according to shell rules,
but without any escaping added by Python. If you are intentionally launching a
batch file with arguments from untrusted sources, consider passing
@code{shell=True} to allow Python to escape special characters. See gh-114539@footnote{https://github.com/python/cpython/issues/114539}
for additional discussion.

@node Objetos Popen,Elementos auxiliares de Popen en Windows,Consideraciones sobre seguridad,subprocess — Subprocess management
@anchor{library/subprocess popen-objects}@anchor{3167}
@subsubsection Objetos Popen


Las instancias de la clase @ref{301,,Popen} cuentan con los siguientes métodos:

@geindex poll() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen poll}@anchor{3168}
@deffn {Método} Popen.poll ()

Comprueba si el proceso hijo ha finalizado. Establece y retorna el atributo @ref{19b1,,returncode}. De lo contrario, retorna @code{None}.
@end deffn

@geindex wait() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen wait}@anchor{d6b}
@deffn {Método} Popen.wait (timeout=None)

Espera a que termine el proceso hijo. Establece y retorna el atributo @ref{19b1,,returncode}.

Si el proceso no finaliza tras `timeout' segundos, lanza una excepción @ref{313c,,TimeoutExpired}. Se puede capturar esta excepción para reintentar la espera.

@cartouche
@quotation Nota 
Esto causará un bloqueo cuando se use @code{stdout=PIPE} o @code{stderr=PIPE} y el proceso hijo genere suficiente salida hacia un pipe como para bloquear esperando que el búfer del pipe del SO acepte más datos. Se debe usar @ref{313b,,Popen.communicate()} cuando se usen pipes para evitar esto.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
When the @code{timeout} parameter is not @code{None}, then (on POSIX) the
function is implemented using a busy loop (non-blocking call and short
sleeps). Use the @ref{b,,asyncio} module for an asynchronous wait: see
@ref{b06,,asyncio.create_subprocess_exec}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se añadió `timeout'.

@end deffn

@geindex communicate() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen communicate}@anchor{313b}
@deffn {Método} Popen.communicate (input=None, timeout=None)

Interactúa con el proceso: Envía datos a stdin. Lee datos de stdout y stderr hasta encontrar un fin-de-fichero. Espera a que termine el proceso y escribe el atributo @ref{19b1,,returncode}. El argumento opcional `input' debe contener los datos que hay que enviar al proceso hijo o @code{None} si no hay que enviar datos al proceso hijo. Si se abrieron los flujos en modo texto, `input' ha de ser una cadena de caracteres. En caso contrario, debe contener bytes.

@ref{313b,,communicate()} retorna una tupla @code{(stdout_data, stderr_data)}. Los datos serán cadenas si se abrieron los flujos en modo texto, en caso contrario serán bytes.

Adviértase que si se desea enviar datos al stdin del proceso, se ha de crear el objeto Popen con @code{stdin=PIPE}. Análogamente, para obtener algo diferente de @code{None} en la tupla del resultado, hay que suministrar @code{stdout=PIPE} o @code{stderr=PIPE} también.

Si el proceso no termina tras `timeout' segundos, se lanza una excepción @ref{313c,,TimeoutExpired}. Si se captura dicha excepción y se reintenta la comunicación, no se perderán datos de salida.

No se matará el proceso si vence el plazo de ejecución, así que para hacer limpieza, una aplicación correcta debería matar el proceso y terminar la comunicación:

@example
proc = subprocess.Popen(...)
try:
    outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
    proc.kill()
    outs, errs = proc.communicate()
@end example

@cartouche
@quotation Nota 
Los datos leídos pasan por un búfer en memoria, así que no se ha de usar este método para un tamaño de datos grande o ilimitado.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se añadió `timeout'.

@end deffn

@geindex send_signal() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen send_signal}@anchor{141e}
@deffn {Método} Popen.send_signal (signal)

Envía la señal `signal' al proceso hijo.

No hace nada si el proceso ya ha terminado.

@cartouche
@quotation Nota 
En Windows, SIGTERM es un alias de @ref{141c,,terminate()}. CTRL_C_EVENT y CTRL_BREAK_EVENT se pueden enviar a procesos iniciados con un parámetro `creationflags' que incluye @code{CREATE_NEW_PROCESS_GROUP}.
@end quotation
@end cartouche
@end deffn

@geindex terminate() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen terminate}@anchor{141c}
@deffn {Método} Popen.terminate ()

Stop the child. On POSIX OSs the method sends @ref{141f,,SIGTERM} to the
child. On Windows the Win32 API function @code{TerminateProcess()} is called
to stop the child.
@end deffn

@geindex kill() (método de subprocess.Popen)
@anchor{library/subprocess subprocess Popen kill}@anchor{141d}
@deffn {Método} Popen.kill ()

Mata el proceso hijo. En sistemas operativos POSIX la función envía SIGKILL al proceso hijo. En Windows @ref{141d,,kill()} es un alias de @ref{141c,,terminate()}.
@end deffn

The following attributes are also set by the class for you to access.
Reassigning them to new values is unsupported:

@geindex args (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen args}@anchor{3169}
@deffn {Atributo} Popen.args

El argumento `args' según se pasó a @ref{301,,Popen}: o una secuencia de argumentos del programa o una cadena sencilla.


Added in version 3.3.

@end deffn

@geindex stdin (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen stdin}@anchor{314f}
@deffn {Atributo} Popen.stdin

If the `stdin' argument was @ref{c0f,,PIPE}, this attribute is a writeable
stream object as returned by @ref{1be,,open()}. If the `encoding' or `errors'
arguments were specified or the `text' or `universal_newlines' argument
was @code{True}, the stream is a text stream, otherwise it is a byte stream.
If the `stdin' argument was not @ref{c0f,,PIPE}, this attribute is @code{None}.
@end deffn

@geindex stdout (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen stdout}@anchor{3150}
@deffn {Atributo} Popen.stdout

If the `stdout' argument was @ref{c0f,,PIPE}, this attribute is a readable
stream object as returned by @ref{1be,,open()}. Reading from the stream provides
output from the child process. If the `encoding' or `errors' arguments were
specified or the `text' or `universal_newlines' argument was @code{True}, the
stream is a text stream, otherwise it is a byte stream. If the `stdout'
argument was not @ref{c0f,,PIPE}, this attribute is @code{None}.
@end deffn

@geindex stderr (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen stderr}@anchor{3151}
@deffn {Atributo} Popen.stderr

If the `stderr' argument was @ref{c0f,,PIPE}, this attribute is a readable
stream object as returned by @ref{1be,,open()}. Reading from the stream provides
error output from the child process. If the `encoding' or `errors' arguments
were specified or the `text' or `universal_newlines' argument was @code{True}, the
stream is a text stream, otherwise it is a byte stream. If the `stderr' argument
was not @ref{c0f,,PIPE}, this attribute is @code{None}.
@end deffn

@cartouche
@quotation Advertencia 
Se ha de usar @ref{313b,,communicate()} en lugar de @ref{314f,,.stdin.write}, @ref{3150,,.stdout.read} o @ref{3151,,.stderr.read} para evitar bloqueos por búfer de pipes del SO llenos que puedan bloquear el proceso hijo.
@end quotation
@end cartouche

@geindex pid (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen pid}@anchor{316a}
@deffn {Atributo} Popen.pid

El ID de proceso del hijo.

Adviértase que si se establece el argumento `shell' a @code{True}, éste es el ID de proceso del la shell generada.
@end deffn

@geindex returncode (atributo de subprocess.Popen)
@anchor{library/subprocess subprocess Popen returncode}@anchor{19b1}
@deffn {Atributo} Popen.returncode

The child return code. Initially @code{None}, @ref{19b1,,returncode} is set by
a call to the @ref{3168,,poll()}, @ref{d6b,,wait()}, or @ref{313b,,communicate()} methods
if they detect that the process has terminated.

A @code{None} value indicates that the process hadn’t yet terminated at the
time of the last method call.

Un valor negativo @code{-N} indica que el hijo fue forzado a terminar con la señal @code{N} (solamente POSIX).
@end deffn

@node Elementos auxiliares de Popen en Windows,Antigua API de alto nivel,Objetos Popen,subprocess — Subprocess management
@anchor{library/subprocess windows-popen-helpers}@anchor{316b}
@subsubsection Elementos auxiliares de Popen en Windows


La clase @ref{3157,,STARTUPINFO} y las siguientes constantes sólo están disponibles en Windows.

@geindex STARTUPINFO (clase en subprocess)
@anchor{library/subprocess subprocess STARTUPINFO}@anchor{3157}
@deffn {Clase} subprocess.STARTUPINFO (*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)

Se utiliza un soporte parcial de la estructura STARTUPINFO@footnote{https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx} de Windows para la creación de @ref{301,,Popen}. Se pueden establecer los siguientes atributos pasándolos como argumentos sólo por clave.


Distinto en la versión 3.7: Se añadió el soporte de argumentos sólo por clave.


@geindex dwFlags (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO dwFlags}@anchor{316c}
@deffn {Atributo} dwFlags

Un campo bit que determina si se usan ciertos atributos de @ref{3157,,STARTUPINFO} cuando el proceso crea una ventana.

@example
si = subprocess.STARTUPINFO()
si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW
@end example
@end deffn

@geindex hStdInput (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdInput}@anchor{316d}
@deffn {Atributo} hStdInput

Si @ref{316c,,dwFlags} especifica @ref{316e,,STARTF_USESTDHANDLES}, este atributo es el gestor de entrada estándar del proceso. Si no se especifica @ref{316e,,STARTF_USESTDHANDLES}, el valor predeterminado de entrada estándar es el búfer de teclado.
@end deffn

@geindex hStdOutput (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdOutput}@anchor{316f}
@deffn {Atributo} hStdOutput

Si @ref{316c,,dwFlags} especifica @ref{316e,,STARTF_USESTDHANDLES}, este atributo es el gestor de salida estándar del proceso. En caso contrario, se hace caso omiso del atributo y el valor predeterminado de salida estándar es el búfer de ventana.
@end deffn

@geindex hStdError (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdError}@anchor{3170}
@deffn {Atributo} hStdError

Si @ref{316c,,dwFlags} especifica @ref{316e,,STARTF_USESTDHANDLES}, este atributo es el gestor de error estándar del proceso. En caso contrario, se hace caso omiso del atributo y el valor predeterminado de error estándar es el búfer de ventana.
@end deffn

@geindex wShowWindow (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO wShowWindow}@anchor{3171}
@deffn {Atributo} wShowWindow

Si @ref{316c,,dwFlags} especifica @ref{3172,,STARTF_USESHOWWINDOW}, este atributo puede ser cualquiera de los valores que pueden especificarse en el parámetro @code{nCmdShow} para la función ShowWindow@footnote{https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx}, salvo @code{SW_SHOWDEFAULT}. De otro modo, se hace caso omiso del atributo.

Se proporciona @ref{3173,,SW_HIDE} para este atributo. Se usa cuando se llama a @ref{301,,Popen} con @code{shell=True}.
@end deffn

@geindex lpAttributeList (atributo de subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO lpAttributeList}@anchor{c96}
@deffn {Atributo} lpAttributeList

Un diccionario de atributos adicionales para la creación del proceso, según @code{STARTUPINFOEX}, véase UpdateProcThreadAttribute@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx}.

Atributos admitidos:


@table @asis

@item `handle_list'

Una secuencia de gestores que se heredará. `close_fds' debe ser verdadero si no viene vacío.

Los gestores deben hacerse temporalmente heredables por @ref{f80,,os.set_handle_inheritable()} cuando se pasan al constructor de @ref{301,,Popen} o de lo contrario, se lanzará @ref{4d5,,OSError} con el error de Windows @code{ERROR_INVALID_PARAMETER} (87).

@cartouche
@quotation Advertencia 
En un proceso multihilo, hay que evitar filtrar gestores no heredables cuando se combina esta característica con llamadas concurrentes a otras funciones de creación de procesos que heredan todos los gestores, como @ref{149a,,os.system()}. Esto también rige para la redirección de gestores estándar, que crea temporalmente gestores heredables.
@end quotation
@end cartouche
@end table


Added in version 3.7.

@end deffn
@end deffn

@menu
* Constantes de Windows:: 

@end menu

@node Constantes de Windows,,,Elementos auxiliares de Popen en Windows
@anchor{library/subprocess windows-constants}@anchor{3174}
@subsubsection Constantes de Windows


El módulo @ref{d6,,subprocess} expone las siguientes constantes.

@geindex STD_INPUT_HANDLE (en el módulo subprocess)
@anchor{library/subprocess subprocess STD_INPUT_HANDLE}@anchor{3175}
@deffn {Dato} subprocess.STD_INPUT_HANDLE

El dispositivo de entrada estándar. Inicialmente, es el búfer de entrada de la consola, @code{CONIN$}.
@end deffn

@geindex STD_OUTPUT_HANDLE (en el módulo subprocess)
@anchor{library/subprocess subprocess STD_OUTPUT_HANDLE}@anchor{3176}
@deffn {Dato} subprocess.STD_OUTPUT_HANDLE

El dispositivo de salida estándar. Inicialmente, es el búfer de pantalla de la consola activa, @code{CONOUT$}.
@end deffn

@geindex STD_ERROR_HANDLE (en el módulo subprocess)
@anchor{library/subprocess subprocess STD_ERROR_HANDLE}@anchor{3177}
@deffn {Dato} subprocess.STD_ERROR_HANDLE

El dispositivo de error estándar. Inicialmente, es el búfer de pantalla de la consola activa, @code{CONOUT$}.
@end deffn

@geindex SW_HIDE (en el módulo subprocess)
@anchor{library/subprocess subprocess SW_HIDE}@anchor{3173}
@deffn {Dato} subprocess.SW_HIDE

Oculta la ventana. Se activará otra ventana.
@end deffn

@geindex STARTF_USESTDHANDLES (en el módulo subprocess)
@anchor{library/subprocess subprocess STARTF_USESTDHANDLES}@anchor{316e}
@deffn {Dato} subprocess.STARTF_USESTDHANDLES

Especifica que los atributos @ref{316d,,STARTUPINFO.hStdInput}, @ref{316f,,STARTUPINFO.hStdOutput}, y @ref{3170,,STARTUPINFO.hStdError} contienen información adicional.
@end deffn

@geindex STARTF_USESHOWWINDOW (en el módulo subprocess)
@anchor{library/subprocess subprocess STARTF_USESHOWWINDOW}@anchor{3172}
@deffn {Dato} subprocess.STARTF_USESHOWWINDOW

Especifica que el atributo @ref{3171,,STARTUPINFO.wShowWindow} contiene información adicional.
@end deffn

@geindex STARTF_FORCEONFEEDBACK (en el módulo subprocess)
@anchor{library/subprocess subprocess STARTF_FORCEONFEEDBACK}@anchor{3178}
@deffn {Dato} subprocess.STARTF_FORCEONFEEDBACK

A @ref{316c,,STARTUPINFO.dwFlags} parameter to specify that the
`Working in Background' mouse cursor will be displayed while a
process is launching. This is the default behavior for GUI
processes.


Added in version 3.13.

@end deffn

@geindex STARTF_FORCEOFFFEEDBACK (en el módulo subprocess)
@anchor{library/subprocess subprocess STARTF_FORCEOFFFEEDBACK}@anchor{3179}
@deffn {Dato} subprocess.STARTF_FORCEOFFFEEDBACK

A @ref{316c,,STARTUPINFO.dwFlags} parameter to specify that the mouse
cursor will not be changed when launching a process.


Added in version 3.13.

@end deffn

@geindex CREATE_NEW_CONSOLE (en el módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NEW_CONSOLE}@anchor{3158}
@deffn {Dato} subprocess.CREATE_NEW_CONSOLE

El nuevo proceso obtiene una nueva consola, en lugar de heredar la consola del padre (que es el comportamiento predeterminado).
@end deffn

@geindex CREATE_NEW_PROCESS_GROUP (en el módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NEW_PROCESS_GROUP}@anchor{3159}
@deffn {Dato} subprocess.CREATE_NEW_PROCESS_GROUP

Un parámetro @ref{301,,Popen} @code{creationflags} para especificar que se cree un nuevo grupo de procesos. Este indicador es necesario para usar @ref{13c7,,os.kill()} sobre el subproceso.

Este indicador no se tiene en cuenta si se especifica @ref{3158,,CREATE_NEW_CONSOLE}.
@end deffn

@geindex ABOVE_NORMAL_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess ABOVE_NORMAL_PRIORITY_CLASS}@anchor{315a}
@deffn {Dato} subprocess.ABOVE_NORMAL_PRIORITY_CLASS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso tendrá una prioridad superior a la media.


Added in version 3.7.

@end deffn

@geindex BELOW_NORMAL_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess BELOW_NORMAL_PRIORITY_CLASS}@anchor{315b}
@deffn {Dato} subprocess.BELOW_NORMAL_PRIORITY_CLASS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso tendrá una prioridad inferior a la media.


Added in version 3.7.

@end deffn

@geindex HIGH_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess HIGH_PRIORITY_CLASS}@anchor{315c}
@deffn {Dato} subprocess.HIGH_PRIORITY_CLASS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso tendrá una prioridad elevada.


Added in version 3.7.

@end deffn

@geindex IDLE_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess IDLE_PRIORITY_CLASS}@anchor{315d}
@deffn {Dato} subprocess.IDLE_PRIORITY_CLASS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso tendrá una la mínima prioridad.


Added in version 3.7.

@end deffn

@geindex NORMAL_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess NORMAL_PRIORITY_CLASS}@anchor{315e}
@deffn {Dato} subprocess.NORMAL_PRIORITY_CLASS

A @ref{301,,Popen} @code{creationflags} parameter to specify that a new process
will have a normal priority. (default)


Added in version 3.7.

@end deffn

@geindex REALTIME_PRIORITY_CLASS (en el módulo subprocess)
@anchor{library/subprocess subprocess REALTIME_PRIORITY_CLASS}@anchor{315f}
@deffn {Dato} subprocess.REALTIME_PRIORITY_CLASS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso tendrá una prioridad de tiempo real. Raramente se debería usar REALTIME_PRIORITY_CLASS, porque esto interrumpe los hilos que gestionan la entrada del ratón y del teclado, así como la gestión del volcado de búfer del disco. Esta clase es apropiada para aplicaciones que se comunican directamente con el hardware o que llevan a cabo tareas breves que no admitan interrupciones.


Added in version 3.7.

@end deffn

@geindex CREATE_NO_WINDOW (en el módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NO_WINDOW}@anchor{3160}
@deffn {Dato} subprocess.CREATE_NO_WINDOW

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso no creará una ventana.


Added in version 3.7.

@end deffn

@geindex DETACHED_PROCESS (en el módulo subprocess)
@anchor{library/subprocess subprocess DETACHED_PROCESS}@anchor{3161}
@deffn {Dato} subprocess.DETACHED_PROCESS

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso no heredará la consola del padre. Este valor es incompatible con CREATE_NEW_CONSOLE.


Added in version 3.7.

@end deffn

@geindex CREATE_DEFAULT_ERROR_MODE (en el módulo subprocess)
@anchor{library/subprocess subprocess CREATE_DEFAULT_ERROR_MODE}@anchor{3162}
@deffn {Dato} subprocess.CREATE_DEFAULT_ERROR_MODE

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso no hereda el modo de error del proceso padre. En su lugar, el proceso parte del modo de error predeterminado. Esta característica es particularmente útil para aplicaciones de shell multihilo que se ejecutan con los errores “duros” desactivados.


Added in version 3.7.

@end deffn

@geindex CREATE_BREAKAWAY_FROM_JOB (en el módulo subprocess)
@anchor{library/subprocess subprocess CREATE_BREAKAWAY_FROM_JOB}@anchor{3163}
@deffn {Dato} subprocess.CREATE_BREAKAWAY_FROM_JOB

Parámetro @ref{301,,Popen} @code{creationflags} para especificar que el nuevo proceso no está asociado a la tarea.


Added in version 3.7.

@end deffn

@node Antigua API de alto nivel,Cómo reemplazar anteriores funciones con el módulo subprocess,Elementos auxiliares de Popen en Windows,subprocess — Subprocess management
@anchor{library/subprocess call-function-trio}@anchor{317a}@anchor{library/subprocess older-high-level-api}@anchor{317b}
@subsubsection Antigua API de alto nivel


Antes de Python 3.5, estas tres funciones conformaban la API de alto nivel para subprocesos. Ahora se puede usar @ref{c0e,,run()} en muchos casos, pero hay mucho código escrito con estas funciones.

@geindex call() (en el módulo subprocess)
@anchor{library/subprocess subprocess call}@anchor{c10}
@deffn {Función} subprocess.call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

Ejecutar la orden descrita por `args'. Esperar que la orden se complete y retornar al atributo @ref{19b1,,returncode}.

El código que requiera capturar stdout o stderr debería usar @ref{c0e,,run()} en su lugar:

@example
run(...).returncode
@end example

Para suprimir stdout o stderr se ha de proporcionar un valor de @ref{11bf,,DEVNULL}.

Se muestran algunos argumentos comunes. La signatura completa de la función es la misma que la del constructor de @ref{301,,Popen}; esta función pasa todos los argumentos proporcionados (salvo `timeout') directamente a esa interfaz.

@cartouche
@quotation Nota 
No usar @code{stdout=PIPE} ni @code{stderr=PIPE} con esta función. El proceso hijo se bloqueará si genera suficiente salida a un pipe como para saturar el búfer del pipe del sistema operativo mientras no se lee de los pipes.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se añadió `timeout'.



Distinto en la versión 3.12: Changed Windows shell search order for @code{shell=True}. The current
directory and @code{%PATH%} are replaced with @code{%COMSPEC%} and
@code{%SystemRoot%\System32\cmd.exe}. As a result, dropping a
malicious program named @code{cmd.exe} into a current directory no
longer works.

@end deffn

@geindex check_call() (en el módulo subprocess)
@anchor{library/subprocess subprocess check_call}@anchor{3148}
@deffn {Función} subprocess.check_call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

Ejecuta la instrucción con argumentos. Espera a que la instrucción se complete. Si el código de retorno es cero retorna; en caso contrario, lanza @ref{138c,,CalledProcessError}. El objeto @ref{138c,,CalledProcessError} tendrá el código de retorno en el atributo @ref{3149,,returncode}.Si @ref{3148,,check_call()} no pudo iniciar el proceso, propagará la excepción que fue lanzada.

El código que requiera capturar stdout o stderr debería usar @ref{c0e,,run()} en su lugar:

@example
run(..., check=True)
@end example

Para suprimir stdout o stderr se ha de proporcionar un valor de @ref{11bf,,DEVNULL}.

Se muestran algunos argumentos comunes. La signatura completa de la función es la misma que la del constructor de @ref{301,,Popen}; esta función pasa todos los argumentos proporcionados (salvo `timeout') directamente a esa interfaz.

@cartouche
@quotation Nota 
No usar @code{stdout=PIPE} ni @code{stderr=PIPE} con esta función. El proceso hijo se bloqueará si genera suficiente salida a un pipe como para saturar el búfer del pipe del sistema operativo mientras no se lee de los pipes.
@end quotation
@end cartouche


Distinto en la versión 3.3: Se añadió `timeout'.



Distinto en la versión 3.12: Changed Windows shell search order for @code{shell=True}. The current
directory and @code{%PATH%} are replaced with @code{%COMSPEC%} and
@code{%SystemRoot%\System32\cmd.exe}. As a result, dropping a
malicious program named @code{cmd.exe} into a current directory no
longer works.

@end deffn

@geindex check_output() (en el módulo subprocess)
@anchor{library/subprocess subprocess check_output}@anchor{1040}
@deffn {Función} subprocess.check_output (args, *, stdin=None, stderr=None, shell=False, cwd=None, encoding=None, errors=None, universal_newlines=None, timeout=None, text=None, **other_popen_kwargs)

Ejecuta orden con argumentos y retorna su salida.

Si el código de retorno fue diferente de cero lanza un @ref{138c,,CalledProcessError}. El objeto @ref{138c,,CalledProcessError} tendrá el código de retorno en el atributo @ref{3149,,returncode} y los datos de salida en el atributo @ref{314b,,output}.

Esto equivale a:

@example
run(..., check=True, stdout=PIPE).stdout
@end example

Los argumentos mostrados arriba son meramente algunos de los comunes. La signatura completa de la función es casi la misma que la de @ref{c0e,,run()} - la mayoría de los argumentos se pasa directamente a esa interfaz. Existe una diferencia con la interfaz de @ref{c0e,,run()} respecto al comportamiento: pasar @code{input=None} genera el mismo comportamiento que @code{input=b'@w{'}} (o @code{input='@w{'}}, dependiendo de otros argumentos) en vez de usar el flujo entrada estándar del padre.

Por omisión, esta función retornará los datos como bytes codificados. La codificación real de los datos podría depender de la orden invocada, por lo que la decodificación a texto se deberá hacer al nivel de la aplicación.

Este comportamiento se puede modificar estableciendo `text', `encoding', `errors', o `universal_newlines' a @code{True}, como se describe en @ref{3139,,Argumentos frecuentemente empleados} y @ref{c0e,,run()}.

Para capturar también el error estándar del resultado se debe usar @code{stderr=subprocess.STDOUT}:

@example
>>> subprocess.check_output(
...     "ls non_existent_file; exit 0",
...     stderr=subprocess.STDOUT,
...     shell=True)
'ls: non_existent_file: No such file or directory\n'
@end example


Added in version 3.1.



Distinto en la versión 3.3: Se añadió `timeout'.



Distinto en la versión 3.4: Se añadió soporte para el argumento por clave `input'.



Distinto en la versión 3.6: Se añadieron `encoding' y `errors'.  Ver @ref{c0e,,run()} para más detalles.



Added in version 3.7: Se añadió `text' como alias más legible de `universal_newlines'.



Distinto en la versión 3.12: Changed Windows shell search order for @code{shell=True}. The current
directory and @code{%PATH%} are replaced with @code{%COMSPEC%} and
@code{%SystemRoot%\System32\cmd.exe}. As a result, dropping a
malicious program named @code{cmd.exe} into a current directory no
longer works.

@end deffn

@node Cómo reemplazar anteriores funciones con el módulo subprocess,Funciones de llamada a la shell de retrocompatibilidad,Antigua API de alto nivel,subprocess — Subprocess management
@anchor{library/subprocess replacing-older-functions-with-the-subprocess-module}@anchor{317c}@anchor{library/subprocess subprocess-replacements}@anchor{11f9}
@subsubsection Cómo reemplazar anteriores funciones con el módulo @code{subprocess}


En esta sección, «a se convierte en b» significa que b se puede usar en lugar de.

@cartouche
@quotation Nota 
Todas las funciones «a» de esta sección fracasan silenciosamente (o casi) si no se halla el programa ejecutado; las funciones de reemplazo «b» lanzan @ref{4d5,,OSError} en lugar de esto.

Además, las funciones de reemplazo que usan @ref{1040,,check_output()} fracasarán con un error @ref{138c,,CalledProcessError} si la operación solicitada produce un código de retorno diferente de cero. La salida queda disponible en el atributo @ref{314b,,output} de la excepción lanzada.
@end quotation
@end cartouche

En los siguientes ejemplos, se asume que las funciones relevantes ya han sido importadas del módulo @ref{d6,,subprocess}.

@menu
* Cómo reemplazar la sustitución de órdenes de /bin/sh:: 
* Cómo remplazar los flujos de la shell:: 
* Cómo reemplazar os.system(): Cómo reemplazar os system. 
* Cómo reemplazar la familia os.spawn: Cómo reemplazar la familia os spawn. 
* Replacing os.popen(): Replacing os popen. 

@end menu

@node Cómo reemplazar la sustitución de órdenes de /bin/sh,Cómo remplazar los flujos de la shell,,Cómo reemplazar anteriores funciones con el módulo subprocess
@anchor{library/subprocess replacing-bin-sh-shell-command-substitution}@anchor{317d}
@subsubsection Cómo reemplazar la sustitución de órdenes de @code{/bin/sh}


@example
output=$(mycmd myarg)
@end example

se convierte en:

@example
output = check_output(["mycmd", "myarg"])
@end example

@node Cómo remplazar los flujos de la shell,Cómo reemplazar os system,Cómo reemplazar la sustitución de órdenes de /bin/sh,Cómo reemplazar anteriores funciones con el módulo subprocess
@anchor{library/subprocess replacing-shell-pipeline}@anchor{317e}
@subsubsection Cómo remplazar los flujos de la shell


@example
output=$(dmesg | grep hda)
@end example

se convierte en:

@example
p1 = Popen(["dmesg"], stdout=PIPE)
p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
p1.stdout.close()  # Allow p1 to receive a SIGPIPE if p2 exits.
output = p2.communicate()[0]
@end example

La llamada a @code{p1.stdout.close()} tras lanzar `p2' es importante para que `p1' reciba un SIGPIPE si `p2' retorna antes que `p1'.

Alternativamente, para entrada de confianza, se puede usar el propio soporte de pipeline de la shell directamente:

@example
output=$(dmesg | grep hda)
@end example

se convierte en:

@example
output = check_output("dmesg | grep hda", shell=True)
@end example

@node Cómo reemplazar os system,Cómo reemplazar la familia os spawn,Cómo remplazar los flujos de la shell,Cómo reemplazar anteriores funciones con el módulo subprocess
@anchor{library/subprocess replacing-os-system}@anchor{317f}
@subsubsection Cómo reemplazar @code{os.system()}


@example
sts = os.system("mycmd" + " myarg")
# becomes
retcode = call("mycmd" + " myarg", shell=True)
@end example

Notas:


@itemize *

@item 
No suele hacer falta llamar al programa a través de la shell.

@item 
El valor de retorno de @ref{c10,,call()} se codifica de forma diferente al de @ref{149a,,os.system()}.

@item 
La función @ref{149a,,os.system()} ignora las señales SIGINT y SIGQUIT mientras se ejecuta el comando, pero el llamador debe hacerlo por separado cuando usa el módulo @ref{d6,,subprocess}.
@end itemize

Un ejemplo más creíble:

@example
try:
    retcode = call("mycmd" + " myarg", shell=True)
    if retcode < 0:
        print("Child was terminated by signal", -retcode, file=sys.stderr)
    else:
        print("Child returned", retcode, file=sys.stderr)
except OSError as e:
    print("Execution failed:", e, file=sys.stderr)
@end example

@node Cómo reemplazar la familia os spawn,Replacing os popen,Cómo reemplazar os system,Cómo reemplazar anteriores funciones con el módulo subprocess
@anchor{library/subprocess replacing-the-os-spawn-family}@anchor{3180}
@subsubsection Cómo reemplazar la familia @code{os.spawn}


Ejemplo de P_NOWAIT:

@example
pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
==>
pid = Popen(["/bin/mycmd", "myarg"]).pid
@end example

Ejemplo de P_WAIT:

@example
retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
==>
retcode = call(["/bin/mycmd", "myarg"])
@end example

Ejemplo de vector:

@example
os.spawnvp(os.P_NOWAIT, path, args)
==>
Popen([path] + args[1:])
@end example

Ejemplo de entorno:

@example
os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
==>
Popen(["/bin/mycmd", "myarg"], env=@{"PATH": "/usr/bin"@})
@end example

@node Replacing os popen,,Cómo reemplazar la familia os spawn,Cómo reemplazar anteriores funciones con el módulo subprocess
@anchor{library/subprocess replacing-os-popen}@anchor{3181}
@subsubsection Replacing @code{os.popen()}


La gestión del código de retorno se traduce así:

@example
pipe = os.popen(cmd, 'w')
...
rc = pipe.close()
if rc is not None and rc >> 8:
    print("There were some errors")
==>
process = Popen(cmd, stdin=PIPE)
...
process.stdin.close()
if process.wait() != 0:
    print("There were some errors")
@end example

@node Funciones de llamada a la shell de retrocompatibilidad,Notas<2>,Cómo reemplazar anteriores funciones con el módulo subprocess,subprocess — Subprocess management
@anchor{library/subprocess legacy-shell-invocation-functions}@anchor{3182}
@subsubsection Funciones de llamada a la shell de retrocompatibilidad


Este módulo también proporciona las siguientes funciones de compatibilidad del módulo @code{commands} de las versiones 2.X. Estas operaciones invocan implícitamente a la shell del sistema y no se les aplican ninguna de las garantías descritas anteriormente respecto a seguridad o consistencia en la gestión de excepciones.

@geindex getstatusoutput() (en el módulo subprocess)
@anchor{library/subprocess subprocess getstatusoutput}@anchor{1041}
@deffn {Función} subprocess.getstatusoutput (cmd, *, encoding=None, errors=None)

Retorna @code{(exitcode, output)} de ejecutar `cmd' en una shell.

Ejecuta la cadena `cmd' en un shell con @code{Popen.check_output()} y retorna una tupla @code{(exitcode, output)} de 2. `encoding' y `errors' se utilizan para decodificar la salida; consulte las notas sobre @ref{3139,,Argumentos frecuentemente empleados} para obtener más detalles.

Se elimina un salto de línea final de la salida. El código de salida de la orden se puede interpretar como el código de retorno del subproceso. Por ejemplo:

@example
>>> subprocess.getstatusoutput('ls /bin/ls')
(0, '/bin/ls')
>>> subprocess.getstatusoutput('cat /bin/junk')
(1, 'cat: /bin/junk: No such file or directory')
>>> subprocess.getstatusoutput('/bin/junk')
(127, 'sh: /bin/junk: not found')
>>> subprocess.getstatusoutput('/bin/kill $$')
(-15, '@w{'})
@end example

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.3.4: Se añadió soporte de Windows.

La función ahora retorna @code{(exitcode, output)} en lugar de @code{(status, output)} como en Python 3.3.3 y anteriores.  `exitcode' tiene el mismo valor que @ref{19b1,,returncode}.



Distinto en la versión 3.11: Added the `encoding' and `errors' parameters.

@end deffn

@geindex getoutput() (en el módulo subprocess)
@anchor{library/subprocess subprocess getoutput}@anchor{1802}
@deffn {Función} subprocess.getoutput (cmd, *, encoding=None, errors=None)

Retorna la salida (stdout y stderr) de ejecutar `cmd' en una shell.

Como @ref{1041,,getstatusoutput()}, salvo que se ignora el código de salida y el valor retornado es una cadena que contiene la salida del comando. Por ejemplo:

@example
>>> subprocess.getoutput('ls /bin/ls')
'/bin/ls'
@end example

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.3.4: Se añadió soporte de Windows



Distinto en la versión 3.11: Added the `encoding' and `errors' parameters.

@end deffn

@node Notas<2>,,Funciones de llamada a la shell de retrocompatibilidad,subprocess — Subprocess management
@anchor{library/subprocess notes}@anchor{3183}
@subsubsection Notas


@menu
* Cómo convertir una secuencia de argumentos a una cadena en Windows:: 
* Disable use of posix_spawn(): Disable use of posix_spawn. 

@end menu

@node Cómo convertir una secuencia de argumentos a una cadena en Windows,Disable use of posix_spawn,,Notas<2>
@anchor{library/subprocess converting-an-argument-sequence-to-a-string-on-windows}@anchor{3184}@anchor{library/subprocess converting-argument-sequence}@anchor{3154}
@subsubsection Cómo convertir una secuencia de argumentos a una cadena en Windows


En Windows, para convertir una secuencia `args' en una cadena que puede ser analizada con las siguientes reglas (correspondientes a las reglas que usa la biblioteca de ejecución de MS C):


@enumerate 

@item 
Los argumentos se separan por espacio en blanco, que debe ser un espacio o un tabulador.

@item 
Una cadena entre comillas dobles se interpreta como un argumento simple, sin importar los espacios en blanco que contenga. Se puede incrustar una cadena entre comillas en un argumento.

@item 
Una comilla doble precedida de una barra invertida se interpreta literalmente como una comilla doble.

@item 
Las barras invertidas se interpretan literalmente, salvo que precedan a una comilla doble.

@item 
Si las barras invertidas preceden inmediatamente a una doble comilla, cada par de barras invertidas se interpreta como una barra invertida literal. Si el número de barras invertidas es impar, la última barra invertida escapa la siguiente comilla doble según se describe en la regla 3.
@end enumerate


@subsubheading Ver también



@table @asis

@item @ref{c4,,shlex}

Módulo que proporciona una función para analizar y escapar líneas de órdenes.
@end table


@node Disable use of posix_spawn,,Cómo convertir una secuencia de argumentos a una cadena en Windows,Notas<2>
@anchor{library/subprocess disable-posix-spawn}@anchor{3185}@anchor{library/subprocess disable-use-of-posix-spawn}@anchor{3186}
@subsubsection Disable use of @code{posix_spawn()}


En Linux, @ref{d6,,subprocess} usa de forma predeterminada la llamada al sistema @code{vfork()} internamente cuando es seguro hacerlo en lugar de @code{fork()}. Esto mejora mucho el rendimiento.

@example
subprocess._USE_POSIX_SPAWN = False  # See CPython issue gh-NNNNNN.
@end example

It is safe to set this to false on any Python version. It will have no
effect on older or newer versions where unsupported. Do not assume the attribute
is available to read. Despite the name, a true value does not indicate the
corresponding function will be used, only that it may be.

Presente los problemas cada vez que tenga que usar estas perillas privadas con una forma de reproducir el problema que estaba viendo. Enlace a ese problema desde un comentario en su código.


Added in version 3.8: @code{_USE_POSIX_SPAWN}


@node sched — Event scheduler,queue — A synchronized queue class,subprocess — Subprocess management,Ejecución concurrente
@anchor{library/sched doc}@anchor{3187}@anchor{library/sched module-sched}@anchor{bf}@anchor{library/sched sched-event-scheduler}@anchor{3188}
@subsection @code{sched} — Event scheduler


@geindex module; sched

`Código fuente:' Lib/sched.py@footnote{https://github.com/python/cpython/tree/main/Lib/sched.py}

@geindex event scheduling


__________________________________________________________________


El módulo @ref{bf,,sched} define una clase que implementa un planificador de eventos de propósito general:

@geindex scheduler (clase en sched)
@anchor{library/sched sched scheduler}@anchor{1199}
@deffn {Clase} sched.scheduler (timefunc=time.monotonic, delayfunc=time.sleep)

La clase @ref{1199,,scheduler} define una interfaz genérica para planificar eventos. Necesita dos funciones para tratar con el «mundo exterior» — `timefunc' debe poder llamarse sin argumentos y retornar un número (el «time», en cualquier unidad). La función `delayfunc' debería ser invocable con un argumento, compatible con la salida de `timefunc', y debería retrasar tantas unidades de tiempo. `delayfunc' también se llamará con el argumento @code{0} después de que se ejecute cada evento para permitir que otros hilos tengan la oportunidad de ejecutarse en aplicaciones multihilo.


Distinto en la versión 3.3: Los argumentos `timefunc' and `delayfunc' son opcionales.



Distinto en la versión 3.3: @ref{1199,,scheduler} La clase se puede usar de forma segura en entornos multihilo.

@end deffn

Ejemplo:

@example
>>> import sched, time
>>> s = sched.scheduler(time.time, time.sleep)
>>> def print_time(a='default'):
...     print("From print_time", time.time(), a)
...
>>> def print_some_times():
...     print(time.time())
...     s.enter(10, 1, print_time)
...     s.enter(5, 2, print_time, argument=('positional',))
...     # despite having higher priority, 'keyword' runs after 'positional' as enter() is relative
...     s.enter(5, 1, print_time, kwargs=@{'a': 'keyword'@})
...     s.enterabs(1_650_000_000, 10, print_time, argument=("first enterabs",))
...     s.enterabs(1_650_000_000, 5, print_time, argument=("second enterabs",))
...     s.run()
...     print(time.time())
...
>>> print_some_times()
1652342830.3640375
From print_time 1652342830.3642538 second enterabs
From print_time 1652342830.3643398 first enterabs
From print_time 1652342835.3694863 positional
From print_time 1652342835.3696074 keyword
From print_time 1652342840.369612 default
1652342840.3697174
@end example

@menu
* Objetos de Scheduler:: 

@end menu

@node Objetos de Scheduler,,,sched — Event scheduler
@anchor{library/sched id1}@anchor{3189}@anchor{library/sched scheduler-objects}@anchor{318a}
@subsubsection Objetos de @code{Scheduler}


@ref{1199,,scheduler} Las sentencias tienen los siguientes métodos y atributos:

@geindex enterabs() (método de sched.scheduler)
@anchor{library/sched sched scheduler enterabs}@anchor{119b}
@deffn {Método} scheduler.enterabs (time, priority, action, argument=(), kwargs=@{@})

Planifica un nuevo evento. El argumento `time' debe ser un tipo numérico compatible con el valor de retorno de la función `timefunc' que se pasa al constructor. Los eventos planificados para la misma `time' se ejecutarán en el orden de su `priority'. Un número más bajo representa una prioridad más alta.

Ejecutar el evento significa ejecutar @code{action(*argument, **kwargs)}. `argument' es una secuencia que contiene los argumentos posicionales para `action'. `kwargs' es un diccionario que contiene los argumentos de palabras clave para `action'.

El valor de retorno es un evento que puede usarse para una cancelación posterior del evento (ver @ref{1939,,cancel()}).


Distinto en la versión 3.3: El argumento `argument' es opcional.



Distinto en la versión 3.3: Se agregó el argumento `kwargs'.

@end deffn

@geindex enter() (método de sched.scheduler)
@anchor{library/sched sched scheduler enter}@anchor{119a}
@deffn {Método} scheduler.enter (delay, priority, action, argument=(), kwargs=@{@})

Planifica un evento `delay' para más unidades de tiempo. Aparte del tiempo relativo, los otros argumentos, el efecto y el valor de retorno son los mismos que para @ref{119b,,enterabs()}.


Distinto en la versión 3.3: El argumento `argument' es opcional.



Distinto en la versión 3.3: Se agregó el argumento `kwargs'.

@end deffn

@geindex cancel() (método de sched.scheduler)
@anchor{library/sched sched scheduler cancel}@anchor{1939}
@deffn {Método} scheduler.cancel (event)

Elimina el evento de la cola. Si `event' no es un evento actualmente en la cola, este método lanzará un @ref{360,,ValueError}.
@end deffn

@geindex empty() (método de sched.scheduler)
@anchor{library/sched sched scheduler empty}@anchor{318b}
@deffn {Método} scheduler.empty ()

Retorna @code{True} si la cola de eventos está vacía.
@end deffn

@geindex run() (método de sched.scheduler)
@anchor{library/sched sched scheduler run}@anchor{1198}
@deffn {Método} scheduler.run (blocking=True)

Ejecuta todos los eventos planificados. Este método esperará (usando la función `delayfunc' enviada al constructor) al próximo evento, luego lo ejecutará y así sucesivamente hasta que no haya más eventos planificados.

Si `blocking' es falso, se ejecutan los eventos planificados que expiran mas pronto (si corresponde) y luego retorna la fecha límite de la próxima llamada programada en el planificador (si corresponde).

`action' o `delayfunc' pueden generar una excepción. En cualquier caso, el planificador mantendrá un estado consistente y propagará la excepción. Si `action' genera una excepción, el evento no se intentará en futuras llamadas a @ref{1198,,run()}.

Si una secuencia de eventos tarda más en ejecutarse que el tiempo disponible antes del próximo evento, el planificador simplemente se retrasará. No se descartarán eventos; el código de llamada es responsable de cancelar eventos que ya no son oportunos.


Distinto en la versión 3.3: Se agregó el argumento `blocking'.

@end deffn

@geindex queue (atributo de sched.scheduler)
@anchor{library/sched sched scheduler queue}@anchor{318c}
@deffn {Atributo} scheduler.queue

Atributo de solo lectura que retorna una lista de los próximos eventos en el orden en que se ejecutarán. Cada evento se muestra como un @ref{6ef,,named tuple} con los siguientes campos : `time, priority, action, argument, kwargs'.
@end deffn

@node queue — A synchronized queue class,contextvars — Context Variables,sched — Event scheduler,Ejecución concurrente
@anchor{library/queue doc}@anchor{318d}@anchor{library/queue module-queue}@anchor{b6}@anchor{library/queue queue-a-synchronized-queue-class}@anchor{318e}
@subsection @code{queue} — A synchronized queue class


@geindex module; queue

`Código fuente:' Lib/queue.py@footnote{https://github.com/python/cpython/tree/main/Lib/queue.py}


__________________________________________________________________


El módulo @ref{b6,,queue} implementa colas multi-productor y multi-consumidor. Es especialmente útil en la programación en hilo cuando la información debe intercambiarse de forma segura entre varios subprocesos.  La clase @ref{13ee,,Queue} de este módulo implementa toda la semántica de bloqueo necesaria.

The module implements three types of queue, which differ only in the order in
which the entries are retrieved.  In a @abbr{FIFO}
queue, the first tasks added are the first retrieved.  In a
@abbr{LIFO} queue, the most recently added entry is
the first retrieved (operating like a stack).  With a priority queue,
the entries are kept sorted (using the @ref{69,,heapq} module) and the
lowest valued entry is retrieved first.

Internamente, estos tres tipos de colas utilizan bloqueos para bloquear temporalmente los hilos que compiten entre sí; sin embargo, no están diseñadas para manejar la reposición dentro de un hilo.

Además, el módulo implementa un tipo de cola «simple» @abbr{FIFO}, @ref{bf2,,SimpleQueue}, cuya implementación específica proporciona garantías adicionales a cambio de una funcionalidad menor.

El módulo @ref{b6,,queue} define las siguientes clases y excepciones:

@geindex Queue (clase en queue)
@anchor{library/queue queue Queue}@anchor{13ee}
@deffn {Clase} queue.Queue (maxsize=0)

Constructor para una cola @abbr{FIFO}.  `maxsize' es un número entero que establece el límite superior del número de elementos que pueden ser colocados en la cola.  La inserción se bloqueará una vez que se haya alcanzado este tamaño, hasta que se consuman los elementos de la cola.  Si `maxsize' es menor o igual a cero, el tamaño de la cola es infinito.
@end deffn

@geindex LifoQueue (clase en queue)
@anchor{library/queue queue LifoQueue}@anchor{225b}
@deffn {Clase} queue.LifoQueue (maxsize=0)

Constructor para una cola @abbr{LIFO}.  `maxsize' es un número entero que establece el límite superior del número de elementos que pueden ser colocados en la cola.  La inserción se bloqueará una vez que se haya alcanzado este tamaño, hasta que se consuman los elementos de la cola.  Si `maxsize' es menor o igual a cero, el tamaño de la cola es infinito.
@end deffn

@geindex PriorityQueue (clase en queue)
@anchor{library/queue queue PriorityQueue}@anchor{225c}
@deffn {Clase} queue.PriorityQueue (maxsize=0)

Constructor para una cola de prioridad.  `maxsize' es un número entero que establece el límite superior del número de elementos que pueden ser colocados en la cola.  La inserción se bloqueará una vez que se haya alcanzado este tamaño, hasta que se consuman los elementos de la cola.  Si `maxsize' es menor o igual a cero, el tamaño de la cola es infinito.

The lowest valued entries are retrieved first (the lowest valued entry is the
one that would be returned by @code{min(entries)}).  A typical pattern for
entries is a tuple in the form: @code{(priority_number, data)}.

Si los elementos de `datos' no son comparables, los datos pueden envolverse en una clase que ignore el elemento de datos y sólo compare el número de prioridad:

@example
from dataclasses import dataclass, field
from typing import Any

@@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)
@end example
@end deffn

@geindex SimpleQueue (clase en queue)
@anchor{library/queue queue SimpleQueue}@anchor{bf2}
@deffn {Clase} queue.SimpleQueue

Constructor de una cola sin límites @abbr{FIFO}. Las colas simples carecen de funcionalidad avanzada como el seguimiento de tareas.


Added in version 3.7.

@end deffn

@geindex Empty
@anchor{library/queue queue Empty}@anchor{30a1}
@deffn {Excepción} queue.Empty

Excepción lanzada cuando el objeto @ref{2d38,,get()} (o @ref{318f,,get_nowait()}) que no se bloquea es llamado en un objeto @ref{13ee,,Queue} que está vacío.
@end deffn

@geindex Full
@anchor{library/queue queue Full}@anchor{30a2}
@deffn {Excepción} queue.Full

Excepción lanzada cuando el objeto @ref{3190,,put()} (o @ref{2d37,,put_nowait()}) que no se bloquea es llamado en un objeto @ref{13ee,,Queue} que está lleno.
@end deffn

@geindex ShutDown
@anchor{library/queue queue ShutDown}@anchor{394}
@deffn {Excepción} queue.ShutDown

Exception raised when @ref{3190,,put()} or @ref{2d38,,get()} is called on
a @ref{13ee,,Queue} object which has been shut down.


Added in version 3.13.

@end deffn

@menu
* Objetos de la cola:: 
* Objetos de cola simple:: 

@end menu

@node Objetos de la cola,Objetos de cola simple,,queue — A synchronized queue class
@anchor{library/queue queue-objects}@anchor{3191}@anchor{library/queue queueobjects}@anchor{3192}
@subsubsection Objetos de la cola


Los objetos de la cola (@ref{13ee,,Queue}, @ref{225b,,LifoQueue}, o @ref{225c,,PriorityQueue}) proporcionan los métodos públicos descritos a continuación.

@geindex qsize() (método de queue.Queue)
@anchor{library/queue queue Queue qsize}@anchor{3193}
@deffn {Método} Queue.qsize ()

Retorna el tamaño aproximado de la cola.  Nota, qsize() > 0 no garantiza que un get() posterior no se bloquee, ni `qsize() < maxsize' garantiza que put() no se bloquee.
@end deffn

@geindex empty() (método de queue.Queue)
@anchor{library/queue queue Queue empty}@anchor{3194}
@deffn {Método} Queue.empty ()

Retorna @code{True} si la cola está vacía, @code{False} si no.  Si empty() retorna @code{True} no garantiza que una llamada posterior a put() no se bloquee.  Del mismo modo, si empty() retorna @code{False} no garantiza que una llamada posterior a get() no se bloquee.
@end deffn

@geindex full() (método de queue.Queue)
@anchor{library/queue queue Queue full}@anchor{3195}
@deffn {Método} Queue.full ()

Retorna @code{True} si la cola está llena, @code{False} si no.  Si full() retorna @code{True} no garantiza que una llamada posterior a get() no se bloquee.  Del mismo modo, si full() retorna @code{False} no garantiza que una llamada posterior a put() no se bloquee.
@end deffn

@geindex put() (método de queue.Queue)
@anchor{library/queue queue Queue put}@anchor{3190}
@deffn {Método} Queue.put (item, block=True, timeout=None)

Put `item' into the queue.  If optional args `block' is true and `timeout' is
@code{None} (the default), block if necessary until a free slot is available.  If
`timeout' is a positive number, it blocks at most `timeout' seconds and raises
the @ref{30a2,,Full} exception if no free slot was available within that time.
Otherwise (`block' is false), put an item on the queue if a free slot is
immediately available, else raise the @ref{30a2,,Full} exception (`timeout' is
ignored in that case).

Raises @ref{394,,ShutDown} if the queue has been shut down.
@end deffn

@geindex put_nowait() (método de queue.Queue)
@anchor{library/queue queue Queue put_nowait}@anchor{2d37}
@deffn {Método} Queue.put_nowait (item)

Equivalente a @code{put(item, block=False)}.
@end deffn

@geindex get() (método de queue.Queue)
@anchor{library/queue queue Queue get}@anchor{2d38}
@deffn {Método} Queue.get (block=True, timeout=None)

Retira y retorna un elemento de la cola.  Si los argumentos opcionales `block' son true y `timeout' es @code{None} (el predeterminado), bloquea si es necesario hasta que un elemento esté disponible. Si `timeout' es un número positivo, bloquea como máximo `timeout' segundos y lanza la excepción @ref{30a1,,Empty} si no había ningún elemento disponible en ese tiempo. De lo contrario (`block' es falso), retorna un elemento si uno está disponible inmediatamente, o bien lanza la excepción @ref{30a1,,Empty} (`timeout' es ignorado en ese caso).

Prior to 3.0 on POSIX systems, and for all versions on Windows, if
`block' is true and `timeout' is @code{None}, this operation goes into
an uninterruptible wait on an underlying lock.  This means that no exceptions
can occur, and in particular a SIGINT will not trigger a @ref{a63,,KeyboardInterrupt}.

Raises @ref{394,,ShutDown} if the queue has been shut down and is empty, or if
the queue has been shut down immediately.
@end deffn

@geindex get_nowait() (método de queue.Queue)
@anchor{library/queue queue Queue get_nowait}@anchor{318f}
@deffn {Método} Queue.get_nowait ()

Equivalente a @code{get(False)}.
@end deffn

Se ofrecen dos métodos para apoyar el seguimiento si las tareas en cola han sido completamente procesadas por hilos `daemon' de consumo.

@geindex task_done() (método de queue.Queue)
@anchor{library/queue queue Queue task_done}@anchor{309d}
@deffn {Método} Queue.task_done ()

Indica que una tarea anteriormente en cola está completa.  Utilizado por los hilos de la cola de consumo.  Por cada @ref{2d38,,get()} usado para recuperar una tarea, una llamada posterior a @ref{309d,,task_done()} le dice a la cola que el procesamiento de la tarea está completo.

Si un @ref{309e,,join()} se está bloqueando actualmente, se reanudará cuando todos los ítems hayan sido procesados (lo que significa que se recibió una llamada @ref{309d,,task_done()} por cada ítem que había sido @ref{3190,,put()} en la cola).

@code{shutdown(immediate=True)} calls @ref{309d,,task_done()} for each remaining item
in the queue.

Lanza un @ref{360,,ValueError} si se llama más veces de las que hay elementos colocados en la cola.
@end deffn

@geindex join() (método de queue.Queue)
@anchor{library/queue queue Queue join}@anchor{309e}
@deffn {Método} Queue.join ()

Bloquea hasta que todos los artículos de la cola se hayan obtenido y procesado.

The count of unfinished tasks goes up whenever an item is added to the queue.
The count goes down whenever a consumer thread calls @ref{309d,,task_done()} to
indicate that the item was retrieved and all work on it is complete.  When the
count of unfinished tasks drops to zero, @ref{309e,,join()} unblocks.
@end deffn

Ejemplo de cómo esperar a que se completen las tareas en cola:

@example
import threading
import queue

q = queue.Queue()

def worker():
    while True:
        item = q.get()
        print(f'Working on @{item@}')
        print(f'Finished @{item@}')
        q.task_done()

# Turn-on the worker thread.
threading.Thread(target=worker, daemon=True).start()

# Send thirty task requests to the worker.
for item in range(30):
    q.put(item)

# Block until all tasks are done.
q.join()
print('All work completed')
@end example

@menu
* Terminating queues:: 

@end menu

@node Terminating queues,,,Objetos de la cola
@anchor{library/queue terminating-queues}@anchor{3196}
@subsubsection Terminating queues


@ref{13ee,,Queue} objects can be made to prevent further interaction by shutting
them down.

@geindex shutdown() (método de queue.Queue)
@anchor{library/queue queue Queue shutdown}@anchor{393}
@deffn {Método} Queue.shutdown (immediate=False)

Shut down the queue, making @ref{2d38,,get()} and @ref{3190,,put()} raise
@ref{394,,ShutDown}.

By default, @ref{2d38,,get()} on a shut down queue will only raise once the
queue is empty. Set `immediate' to true to make @ref{2d38,,get()} raise
immediately instead.

All blocked callers of @ref{3190,,put()} and @ref{2d38,,get()} will be
unblocked. If `immediate' is true, a task will be marked as done for each
remaining item in the queue, which may unblock callers of
@ref{309e,,join()}.


Added in version 3.13.

@end deffn

@node Objetos de cola simple,,Objetos de la cola,queue — A synchronized queue class
@anchor{library/queue simplequeue-objects}@anchor{3197}
@subsubsection Objetos de cola simple


Los objetos @ref{bf2,,SimpleQueue} proporcionan los métodos públicos descritos a continuación.

@geindex qsize() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue qsize}@anchor{3198}
@deffn {Método} SimpleQueue.qsize ()

Retorna el tamaño aproximado de la cola.  Nota, qsize() > 0 no garantiza que un get() posterior no se bloquee.
@end deffn

@geindex empty() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue empty}@anchor{3199}
@deffn {Método} SimpleQueue.empty ()

Return @code{True} if the queue is empty, @code{False} otherwise.  If empty()
returns @code{False} it doesn’t guarantee that a subsequent call to get()
will not block.
@end deffn

@geindex put() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue put}@anchor{319a}
@deffn {Método} SimpleQueue.put (item, block=True, timeout=None)

Pone el elemento en la cola.  El método nunca se bloquea y siempre tiene éxito (excepto por posibles errores de bajo nivel como la falta de asignación de memoria). Los argumentos opcionales `block' y `timeout' son ignorados y sólo se proporcionan por compatibilidad con @ref{3190,,Queue.put()}.

`Detalles de implementación de CPython:' Este método tiene una implementación en C la cual ha sido usada anteriormente. Los llamados @code{put()} o @code{get()} pueden ser interrumpidos por otro llamado @code{put()} en el mismo hilo sin bloquear o corromper el estado interno dentro de la fila. Esto lo hace apropiado para su uso en destructores como los métodos @code{__del__} o las retrollamadas @ref{114,,weakref}.
@end deffn

@geindex put_nowait() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue put_nowait}@anchor{319b}
@deffn {Método} SimpleQueue.put_nowait (item)

Equivalente a @code{put(item, block=False)}, siempre y cuando sea compatible con @code{Queue.put_nowait`()}.
@end deffn

@geindex get() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue get}@anchor{319c}
@deffn {Método} SimpleQueue.get (block=True, timeout=None)

Retira y retorna un elemento de la cola.  Si los argumentos opcionales `block' son true y `timeout' es @code{None} (el predeterminado), bloquea si es necesario hasta que un elemento esté disponible. Si `timeout' es un número positivo, bloquea como máximo `timeout' segundos y lanza la excepción @ref{30a1,,Empty} si no había ningún elemento disponible en ese tiempo. De lo contrario (`block' es falso), retorna un elemento si uno está disponible inmediatamente, o bien lanza la excepción @ref{30a1,,Empty} (`timeout' es ignorado en ese caso).
@end deffn

@geindex get_nowait() (método de queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue get_nowait}@anchor{319d}
@deffn {Método} SimpleQueue.get_nowait ()

Equivalente a @code{get(False)}.
@end deffn


@subsubheading Ver también



@table @asis

@item Clase @ref{1803,,multiprocessing.Queue}

Una clase de cola para su uso en un contexto de multiprocesamiento (en lugar de multihilo).
@end table

@ref{67d,,collections.deque} es una implementación alternativa de colas sin límites con operaciones atómicas rápidas @ref{2507,,append()} y @ref{250d,,popleft()} que no requieren bloqueo y también soportan indexación.


@node contextvars — Context Variables,_thread — Low-level threading API,queue — A synchronized queue class,Ejecución concurrente
@anchor{library/contextvars doc}@anchor{319e}@anchor{library/contextvars contextvars-context-variables}@anchor{319f}@anchor{library/contextvars module-contextvars}@anchor{25}
@subsection @code{contextvars} — Context Variables


@geindex module; contextvars


__________________________________________________________________


Este módulo proporciona APIs para gestionar, almacenar y acceder a estados en el contexto local. La clase @ref{31a0,,ContextVar} se utiliza para declarar y trabajar con Variables de Contexto (`Context Variables'). La función @ref{31a1,,copy_context()} y la clase @ref{15a0,,Context} deberían ser utilizadas para gestionar el contexto actual en frameworks asíncronos.

Context managers that have state should use Context Variables
instead of @ref{1773,,threading.local()} to prevent their state from
bleeding to other code unexpectedly, when used in concurrent code.

Ver 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para más detalles.


Added in version 3.7.


@menu
* variables de contexto:: 
* Gestión de contexto manual:: 
* Soporte asyncio:: 

@end menu

@node variables de contexto,Gestión de contexto manual,,contextvars — Context Variables
@anchor{library/contextvars context-variables}@anchor{31a2}
@subsubsection variables de contexto


@geindex ContextVar (clase en contextvars)
@anchor{library/contextvars contextvars ContextVar}@anchor{31a0}
@deffn {Clase} contextvars.ContextVar (name[, *, default])

Esta clase se utiliza para declarar una nueva Variable de Contexto, por ejemplo:

@example
var: ContextVar[int] = ContextVar('var', default=42)
@end example

El parámetro obligatorio `name' se utiliza para introspección y depuración.

El parámetro opcional de sólo palabra clave `default' es utilizado por @ref{31a3,,ContextVar.get()}, cuando en el contexto actual no se encuentra ningún valor para la variable.

`Importante:' las Variables de Contexto deberían ser creadas en lo más alto a nivel de módulo y nunca en clausura. Los objetos @ref{15a0,,Context} mantienen referencias a variables de contexto, lo cual no permitiría que estas variables de contexto sean limpiadas por el recolector de basura.

@geindex name (atributo de contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar name}@anchor{31a4}
@deffn {Atributo} name

El nombre de la variable. Propiedad de sólo lectura.


Added in version 3.7.1.

@end deffn

@geindex get() (método de contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar get}@anchor{31a3}
@deffn {Método} get ([default])

Retorna un valor para la variable de contexto en el contexto actual.

Si la variable no tiene ningún valor en el contexto actual, el método:


@itemize *

@item 
retornará el valor del argumento `default' del método, si alguno fue dado; o

@item 
retornará el valor por defecto de la variable de contexto, si ésta fue creada con alguno; o

@item 
lanzará @ref{21d5,,LookupError}.
@end itemize
@end deffn

@geindex set() (método de contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar set}@anchor{31a5}
@deffn {Método} set (value)

Establece un nuevo valor para la variable de contexto en el contexto actual.

El argumento obligatorio `value' es el nuevo valor de la variable de contexto.

Retorna un objeto @ref{31a6,,Token} que puede utilizarse para restaurar la variable a su valor anterior, utilizando el método @ref{31a7,,ContextVar.reset()}.
@end deffn

@geindex reset() (método de contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar reset}@anchor{31a7}
@deffn {Método} reset (token)

Restablece la variable de contexto al valor que tenía antes de llamar al método @ref{31a5,,ContextVar.set()}, que creó el `token' utilizado.

Por ejemplo:

@example
var = ContextVar('var')

token = var.set('new value')
# code that uses 'var'; var.get() returns 'new value'.
var.reset(token)

# After the reset call the var has no value again, so
# var.get() would raise a LookupError.
@end example
@end deffn
@end deffn

@geindex Token (clase en contextvars)
@anchor{library/contextvars contextvars Token}@anchor{31a6}
@deffn {Clase} contextvars.Token

Los objetos `token' son retornados por el método @ref{31a5,,ContextVar.set()}. Se le pueden dar al método @ref{31a7,,ContextVar.reset()} para restablecer el valor de la variable al que estuviese dado antes del `set' correspondiente.

@geindex var (atributo de contextvars.Token)
@anchor{library/contextvars contextvars Token var}@anchor{31a8}
@deffn {Atributo} var

Propiedad de sólo lectura. Apunta al objeto @ref{31a0,,ContextVar} que creó el `token'.
@end deffn

@geindex old_value (atributo de contextvars.Token)
@anchor{library/contextvars contextvars Token old_value}@anchor{31a9}
@deffn {Atributo} old_value

Propiedad de sólo lectura. Es el valor que la variable tenía antes de llamar al método @ref{31a5,,ContextVar.set()} que creó el `token'. Apunta a @ref{31aa,,Token.MISSING} si la variable no estaba establecida antes de la llamada.
@end deffn

@geindex MISSING (atributo de contextvars.Token)
@anchor{library/contextvars contextvars Token MISSING}@anchor{31aa}
@deffn {Atributo} MISSING

Marcador utilizado por @ref{31a9,,Token.old_value}.
@end deffn
@end deffn

@node Gestión de contexto manual,Soporte asyncio,variables de contexto,contextvars — Context Variables
@anchor{library/contextvars manual-context-management}@anchor{31ab}
@subsubsection Gestión de contexto manual


@geindex copy_context() (en el módulo contextvars)
@anchor{library/contextvars contextvars copy_context}@anchor{31a1}
@deffn {Función} contextvars.copy_context ()

Retorna una copia del objeto @ref{15a0,,Context} actual.

El siguiente código obtiene una copia del contexto actual e imprime todas las variables y sus valores establecidos en el contexto:

@example
ctx: Context = copy_context()
print(list(ctx.items()))
@end example

The function has an `O'(1) complexity, i.e. works equally fast for
contexts with a few context variables and for contexts that have
a lot of them.
@end deffn

@geindex Context (clase en contextvars)
@anchor{library/contextvars contextvars Context}@anchor{15a0}
@deffn {Clase} contextvars.Context

Mapeo de @ref{31a0,,ContextVars} con sus valores.

@code{Context()} crea un contexto vacío sin valores. Para obtener una copia del contexto actual, se puede utilizar la función @ref{31a1,,copy_context()}.

Each thread has its own effective stack of @code{Context} objects.  The
@ref{1602,,current context} is the @code{Context} object at the top of the
current thread’s stack.  All @code{Context} objects in the stacks are
considered to be `entered'.

`Entering' a context, which can be done by calling its @ref{15e8,,run()}
method, makes the context the current context by pushing it onto the top of
the current thread’s context stack.

`Exiting' from the current context, which can be done by returning from the
callback passed to the @ref{15e8,,run()} method, restores the current
context to what it was before the context was entered by popping the context
off the top of the context stack.

Since each thread has its own context stack, @ref{31a0,,ContextVar} objects
behave in a similar fashion to @ref{1773,,threading.local()} when values are
assigned in different threads.

Attempting to enter an already entered context, including contexts entered in
other threads, raises a @ref{1e5,,RuntimeError}.

After exiting a context, it can later be re-entered (from any thread).

Any changes to @ref{31a0,,ContextVar} values via the @ref{31a5,,ContextVar.set()}
method are recorded in the current context.  The @ref{31a3,,ContextVar.get()}
method returns the value associated with the current context.  Exiting a
context effectively reverts any changes made to context variables while the
context was entered (if needed, the values can be restored by re-entering the
context).

`Context' implementa la interfaz @ref{961,,collections.abc.Mapping}.

@geindex run() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context run}@anchor{15e8}
@deffn {Método} run (callable, *args, **kwargs)

Enters the Context, executes @code{callable(*args, **kwargs)}, then exits the
Context.  Returns `callable'’s return value, or propagates an exception if
one occurred.

Example:

@example
import contextvars

var = contextvars.ContextVar('var')
var.set('spam')
print(var.get())  # 'spam'

ctx = contextvars.copy_context()

def main():
    # 'var' was set to 'spam' before
    # calling 'copy_context()' and 'ctx.run(main)', so:
    print(var.get())  # 'spam'
    print(ctx[var])  # 'spam'

    var.set('ham')

    # Now, after setting 'var' to 'ham':
    print(var.get())  # 'ham'
    print(ctx[var])  # 'ham'

# Any changes that the 'main' function makes to 'var'
# will be contained in 'ctx'.
ctx.run(main)

# The 'main()' function was run in the 'ctx' context,
# so changes to 'var' are contained in it:
print(ctx[var])  # 'ham'

# However, outside of 'ctx', 'var' is still set to 'spam':
print(var.get())  # 'spam'
@end example

@c spam
@c spam
@c spam
@c ham
@c ham
@c ham
@c spam
@end deffn

@geindex copy() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context copy}@anchor{31ac}
@deffn {Método} copy ()

Retorna una copia superficial (`shallow copy') del objeto de contexto.
@end deffn


@deffn {Describe} var in context

Retorna @code{True} si `context' tiene un valor establecido para `var'; de lo contrario, retorna @code{False}.
@end deffn


@deffn {Describe} context[var]

Retorna el valor de la variable @ref{31a0,,ContextVar} `var'. Si la variable no está establecida en el contexto actual, se lanzará @ref{438,,KeyError}.
@end deffn

@geindex get() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context get}@anchor{31ad}
@deffn {Método} get (var[, default])

Retorna el valor de `var', si `var' tiene el valor en el objeto de contexto; de lo contrario, retorna `default'. Si `default' no es dado, retorna @code{None}.
@end deffn


@deffn {Describe} iter(context)

Retorna un iterador de las variables almacenadas en el objeto de contexto.
@end deffn


@deffn {Describe} len(proxy)

Retorna el número de variables establecidas en el objeto de contexto.
@end deffn

@geindex keys() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context keys}@anchor{31ae}
@deffn {Método} keys ()

Retorna un listado de todas las variables en el objeto de contexto.
@end deffn

@geindex values() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context values}@anchor{31af}
@deffn {Método} values ()

Retorna un listado de los valores de todas las variables en el objeto de contexto.
@end deffn

@geindex items() (método de contextvars.Context)
@anchor{library/contextvars contextvars Context items}@anchor{31b0}
@deffn {Método} items ()

Retorna un listado de dos tuplas que contienen todas las variables y sus variables en el contexto actual.
@end deffn
@end deffn

@node Soporte asyncio,,Gestión de contexto manual,contextvars — Context Variables
@anchor{library/contextvars asyncio-support}@anchor{31b1}
@subsubsection Soporte asyncio


Las variables de contexto están soportadas de forma nativa en @ref{b,,asyncio} y se pueden utilizar sin ninguna configuración adicional. Por ejemplo, el siguiente código crea un servidor simple de respuesta, que utiliza una variable de contexto que hace que la dirección del cliente remoto esté disponible en la `Task' que gestiona al cliente:

@example
import asyncio
import contextvars

client_addr_var = contextvars.ContextVar('client_addr')

def render_goodbye():
    # The address of the currently handled client can be accessed
    # without passing it explicitly to this function.

    client_addr = client_addr_var.get()
    return f'Good bye, client @@ @{client_addr@}\r\n'.encode()

async def handle_request(reader, writer):
    addr = writer.transport.get_extra_info('socket').getpeername()
    client_addr_var.set(addr)

    # In any code that we call is now possible to get
    # client's address by calling 'client_addr_var.get()'.

    while True:
        line = await reader.readline()
        print(line)
        if not line.strip():
            break

    writer.write(b'HTTP/1.1 200 OK\r\n')  # status line
    writer.write(b'\r\n')  # headers
    writer.write(render_goodbye())  # body
    writer.close()

async def main():
    srv = await asyncio.start_server(
        handle_request, '127.0.0.1', 8081)

    async with srv:
        await srv.serve_forever()

asyncio.run(main())

# To test it you can use telnet or curl:
#     telnet 127.0.0.1 8081
#     curl 127.0.0.1:8081
@end example

He aquí módulos de apoyo para algunos de los servicios mencionados:

@node _thread — Low-level threading API,,contextvars — Context Variables,Ejecución concurrente
@anchor{library/_thread doc}@anchor{31b2}@anchor{library/_thread module-_thread}@anchor{2}@anchor{library/_thread thread-low-level-threading-api}@anchor{31b3}
@subsection @code{_thread} — Low-level threading API


@geindex module; _thread

@geindex light-weight processes
@geindex processes@comma{} light-weight
@geindex binary semaphores
@geindex semaphores@comma{} binary


__________________________________________________________________


Este módulo ofrece primitivas de bajo nivel para trabajar con múltiples `threads' o hilos (también llamados `light-weight processes' o `tasks') – múltiples hilos de control compartiendo su espacio de datos global. Para sincronizar, provee «candados» simples (también llamados  `mutexes' o `binary semaphores'). El módulo @ref{ed,,threading} provee una API de manejo de hilos más fácil de usar y de más alto nivel, construida sobre este módulo.

@geindex pthreads
@geindex threads;POSIX


Distinto en la versión 3.7: Este módulo solía ser opcional, pero ahora está siempre disponible.


Este módulo define las siguientes constantes y funciones:

@geindex error
@anchor{library/_thread thread error}@anchor{31b4}
@deffn {Excepción} _thread.error

Lanzado ante errores específicos de un hilo.


Distinto en la versión 3.3: Ahora es un sinónimo de la excepción incorporada @ref{1e5,,RuntimeError}.

@end deffn

@geindex LockType (en el módulo _thread)
@anchor{library/_thread thread LockType}@anchor{31b5}
@deffn {Dato} _thread.LockType

Este es el tipo de los objetos candado (`lock objects').
@end deffn

@geindex start_new_thread() (en el módulo _thread)
@anchor{library/_thread thread start_new_thread}@anchor{2fe}
@deffn {Función} _thread.start_new_thread (function, args[, kwargs])

Inicia un nuevo hilo y retorna su identificador. El hilo ejecuta la función `function' con la lista de argumentos `args' (que debe ser una tupla). El argumento opcional `kwargs' especifica un diccionario de argumentos por palabras clave.

Cuando la función retorna, el hilo finaliza silenciosamente.

Cuando la función termina con una excepción no gestionada, se invoca a @ref{355,,sys.unraisablehook()} para que gestione la excepción. El atributo `object' del argumento gancho (`hook'), es `function'. Por defecto, se muestra un seguimiento de pila y luego el hilo sale (pero los otros hilos continúan funcionando).

Cuando la función lanza una excepción @ref{dc7,,SystemExit}, se ignora silenciosamente.

Lanza un @ref{18c3,,evento de auditoría} @code{_thread.start_new_thread} con los argumentos @code{function}, @code{args}, @code{kwargs}.


Distinto en la versión 3.8: Ahora se utiliza @ref{355,,sys.unraisablehook()} para gestionar las excepciones no gestionadas.

@end deffn

@geindex interrupt_main() (en el módulo _thread)
@anchor{library/_thread thread interrupt_main}@anchor{8da}
@deffn {Función} _thread.interrupt_main (signum=signal.SIGINT, /)

Simular el efecto de una señal que llega al hilo principal. Un hilo puede usar esta función para interrumpir el hilo principal, aunque no hay garantías de que la interrupción ocurrirá inmediatamente.

Si es dada, `signum' es el número de la señal a simular. Si `signum' no es dada, @ref{8db,,signal.SIGINT} es simulado.

Si la señal dada no es manejada por Python (se estableció en @ref{1828,,signal.SIG_DFL} o @ref{1827,,signal.SIG_IGN}), esta función no hace nada.


Distinto en la versión 3.10: Se agrega el argumento `signum' para personalizar el número de señal.


@cartouche
@quotation Nota 
Esto no emite la señal correspondiente, sino que programa una llamada al controlador asociado (si existe). Si realmente se quiere emitir la señal, se utiliza @ref{1809,,signal.raise_signal()}.
@end quotation
@end cartouche
@end deffn

@geindex exit() (en el módulo _thread)
@anchor{library/_thread thread exit}@anchor{31b6}
@deffn {Función} _thread.exit ()

Lanza la excepción @ref{dc7,,SystemExit}. Cuando no es gestionada, causa que el hilo salga silenciosamente.
@end deffn

@c function:: exit_prog(status)
@c 
@c    Exit all threads and report the value of the integer argument
@c    *status* as the exit status of the entire program.
@c    **Caveat:** code in pending :keyword:`finally` clauses, in this thread
@c    or in other threads, is not executed.

@geindex allocate_lock() (en el módulo _thread)
@anchor{library/_thread thread allocate_lock}@anchor{31b7}
@deffn {Función} _thread.allocate_lock ()

Retorna un nuevo objeto candado (`lock object'). Los métodos de los candados se describen más abajo. El candado está abierto al inicio.
@end deffn

@geindex get_ident() (en el módulo _thread)
@anchor{library/_thread thread get_ident}@anchor{31b8}
@deffn {Función} _thread.get_ident ()

Retorna el “identificador de hilo” (`thread identifier') del hilo actual. Es un entero distinto de cero. Su valor no tiene un significado directo, tiene la intención de ser utilizada como una `cookie' mágica para, por ejemplo, indexar un diccionario con datos específicos del hilo. Los identificadores de hilo pueden reciclarse cuando un hilo sale y otro se crea.
@end deffn

@geindex get_native_id() (en el módulo _thread)
@anchor{library/_thread thread get_native_id}@anchor{31b9}
@deffn {Función} _thread.get_native_id ()

Retorna el ID de hilo nativo integral del hilo asignado por el kernel. Es un entero no-negativo. Su valor puede utilizarse para identificar inequívocamente este hilo en particular en todo el sistema (hasta que el hilo termine, luego de lo cual el valor puede ser reciclado por el Sistema Operativo).

@ref{1d5a,,Availability}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Added in version 3.8.



Distinto en la versión 3.13: Added support for GNU/kFreeBSD.

@end deffn

@geindex stack_size() (en el módulo _thread)
@anchor{library/_thread thread stack_size}@anchor{31ba}
@deffn {Función} _thread.stack_size ([size])

Retorna el tamaño de la pila del hilo (`thread stack') utilizada al crear nuevos hilos. El argumento opcional `size' especifica el tamaño de la pila a utilizar en los hilos que se creen a continuación, y debe ser 0 (utiliza el valor por defecto de la plataforma o el configurado) o un entero positivo de al menos 32768 (32KiB). Si `size' no se especifica, se utiliza 0. Si no está soportado el cambio del tamaño de pila del hilo, se lanza una excepción @ref{1e5,,RuntimeError}. Si la pila especificada es inválida se lanza un @ref{360,,ValueError} y el tamaño de la pila no se modifica. 32KiB es actualmente el menor valor soportado para el tamaño de la pila, para garantizar suficiente espacio en la misma para que quepa el propio intérprete. Tenga en cuenta que alguna plataformas pueden tener restricciones particulares en los valores para el tamaño de la pila, como requerir un mínimo que supere los 32KiB, o requerir una asignación en múltiplos del tamaño de página de memoria del sistema. Es necesario consultar la documentación de la plataforma para mayor información (son habituales las páginas de 4KiB; usar múltiplos de 4096 para el tamaño de pila es la estrategia sugerida si no se cuenta con información más específica).

@ref{1d5a,,Availability}: Windows, pthreads.

Plataformas Unix con soporte para hilos POSIX.
@end deffn

@geindex TIMEOUT_MAX (en el módulo _thread)
@anchor{library/_thread thread TIMEOUT_MAX}@anchor{31bb}
@deffn {Dato} _thread.TIMEOUT_MAX

El máximo valor permitido para el parámetro `timeout' de @ref{739,,Lock.acquire}. Especificar un tiempo de espera (`timeout') mayor que este valor lanzará una excepción @ref{919,,OverflowError}.


Added in version 3.2.

@end deffn

Los objetos candado (`lock objects') tienen los siguientes métodos:

@geindex acquire() (método de _thread.lock)
@anchor{library/_thread thread lock acquire}@anchor{31bc}
@deffn {Método} lock.acquire (blocking=True, timeout=-1)

Sin ningún argumento opcional, este método adquiere el candado incondicionalmente, si es necesario esperando que éste sea liberado por otro hilo (solamente un hilo por vez puede adquirir un candado; para eso existen).

If the `blocking' argument is present, the action depends on its
value: if it is false, the lock is only acquired if it can be acquired
immediately without waiting, while if it is true, the lock is acquired
unconditionally as above.

If the floating-point `timeout' argument is present and positive, it
specifies the maximum wait time in seconds before returning.  A negative
`timeout' argument specifies an unbounded wait.  You cannot specify
a `timeout' if `blocking' is false.

El valor de retorno es @code{True} si el candado (`lock') se adquirió exitosamente, @code{False} de lo contrario.


Distinto en la versión 3.2: El parámetro `timeout' es nuevo.



Distinto en la versión 3.2: La adquisición de candados ahora puede ser interrumpida por señales en POSIX.



Distinto en la versión 3.14: Lock acquires can now be interrupted by signals on Windows.

@end deffn

@geindex release() (método de _thread.lock)
@anchor{library/_thread thread lock release}@anchor{31bd}
@deffn {Método} lock.release ()

Libera el candado. El candado debe haber sido adquirido previamente, pero no necesariamente por el mismo hilo.
@end deffn

@geindex locked() (método de _thread.lock)
@anchor{library/_thread thread lock locked}@anchor{31be}
@deffn {Método} lock.locked ()

Retorna el estado del candado: @code{True} si ha sido adquirido por algún hilo, @code{False} de lo contrario.
@end deffn

Además de estos métodos, los objetos candado pueden ser utilizados mediante la declaración @ref{673,,with}, por ejemplo:

@example
import _thread

a_lock = _thread.allocate_lock()

with a_lock:
    print("a_lock is locked while this executes")
@end example

`Salvedades:'

@geindex module;signal


@itemize *

@item 
Interrupts always go to the main thread (the @ref{a63,,KeyboardInterrupt}
exception will be received by that thread.)

@item 
Invocar a @ref{13b0,,sys.exit()} o lanzar la excepción @ref{dc7,,SystemExit} equivale a invocar @ref{31b6,,_thread.exit()}.

@item 
Cuando el hilo principal sale, ¿sobreviven los otros hilos? Depende de cómo esté definido por el sistema. En la mayoría de los sistemas, los hilos se cierran inmediatamente (`killed'), sin ejecutar las cláusulas @ref{789,,try} … @ref{a5c,,finally} o los destructores del objeto.
@end itemize

@node Comunicación en redes y entre procesos,Manejo de datos de internet,Ejecución concurrente,La biblioteca estándar de Python
@anchor{library/ipc doc}@anchor{31bf}@anchor{library/ipc ipc}@anchor{31c0}@anchor{library/ipc networking-and-interprocess-communication}@anchor{31c1}
@section Comunicación en redes y entre procesos


Los módulos descritos en este capítulo proveen los mecanismos para la comunicación en red y entre procesos.

Algunos módulos solo funcionan para dos procesos que están en una misma máquina, e.g. @ref{c6,,signal} y @ref{90,,mmap}. Otros módulos soportan protocolos de red que dos o mas procesos pueden utilizar para comunicarse entre máquinas.

La lista de módulos descritos en este capítulo es:

@menu
* asyncio — Asynchronous I/O:: 
* socket — Low-level networking interface:: 
* ssl — TLS/SSL wrapper for socket objects:: 
* select — Waiting for I/O completion:: 
* selectors — High-level I/O multiplexing:: 
* signal — Set handlers for asynchronous events:: 
* mmap — Memory-mapped file support:: 

@end menu

@node asyncio — Asynchronous I/O,socket — Low-level networking interface,,Comunicación en redes y entre procesos
@anchor{library/asyncio doc}@anchor{31c2}@anchor{library/asyncio asyncio-asynchronous-i-o}@anchor{31c3}@anchor{library/asyncio module-asyncio}@anchor{b}
@subsection @code{asyncio} — Asynchronous I/O


@geindex module; asyncio


__________________________________________________________________


@subsubheading ¡Hola Mundo!



@example
import asyncio

async def main():
    print('Hello ...')
    await asyncio.sleep(1)
    print('... World!')

asyncio.run(main())
@end example

asyncio es una biblioteca para escribir código `concurrente' utilizando la sintaxis `async/await'.

asyncio es utilizado como base en múltiples `frameworks' asíncronos de Python y provee un alto rendimiento en redes y servidores web, bibliotecas de conexión de base de datos, colas de tareas distribuidas, etc.

asyncio suele encajar perfectamente para operaciones con límite de E/S y código de red `estructurado' de alto nivel.

asyncio provee un conjunto de `APIs' de `alto nivel' para:


@itemize *

@item 
@ref{31c4,,ejecutar corutinas de Python} de manera concurrente y tener control total sobre su ejecución;

@item 
realizar @ref{31c5,,redes E/S y comunicación entre procesos(IPC)};

@item 
controlar @ref{31c6,,subprocesos};

@item 
distribuir tareas a través de @ref{31c7,,colas};

@item 
@ref{31c8,,sincronizar} código concurrente;
@end itemize

Adicionalmente, existen `APIs' de `bajo nivel' para `desarrolladores de bibliotecas y frameworks' para:


@itemize *

@item 
create and manage @ref{dfe,,event loops}, which
provide asynchronous APIs for @ref{31c9,,networking},
running @ref{31ca,,subprocesses},
handling @ref{31cb,,OS signals}, etc;

@item 
implementar protocolos eficientes utilizando @ref{31cc,,transportes};

@item 
Bibliotecas @ref{31cd,,puente} basadas en retrollamadas y código con sintaxis `async/wait'.
@end itemize

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.
@anchor{library/asyncio asyncio-cli}@anchor{31ce}
@subsubheading asyncio REPL


You can experiment with an @code{asyncio} concurrent context in the @ref{2d6,,REPL}:

@example
$ python -m asyncio
asyncio REPL ...
Use "await" directly instead of "asyncio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import asyncio
>>> await asyncio.sleep(10, result='hello')
'hello'
@end example

Raises an @ref{18c3,,auditing event} @code{cpython.run_stdin} with no arguments.


Distinto en la versión 3.12.5: (also 3.11.10, 3.10.15, 3.9.20, and 3.8.20)
Emits audit events.



Distinto en la versión 3.13: Uses PyREPL if possible, in which case 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP} is
also executed. Emits audit events.


@c We use the "rubric" directive here to avoid creating
@c the "Reference" subsection in the TOC.

@subsubheading Referencias


@menu
* Runners:: 
* Corrutinas y tareas:: 
* Streams:: 
* Primitivas de sincronización:: 
* Sub-procesos:: 
* Colas:: 
* Excepciones: Excepciones<11>. 
* Bucle de eventos:: 
* Futures:: 
* Transportes y protocolos:: 
* Políticas:: 
* Soporte de plataforma:: 
* Extensión:: 
* Índice de API de alto nivel:: 
* Índice de API de bajo nivel:: 
* Desarrollando con asyncio:: 

@end menu

@node Runners,Corrutinas y tareas,,asyncio — Asynchronous I/O
@anchor{library/asyncio-runner doc}@anchor{31cf}@anchor{library/asyncio-runner runners}@anchor{31d0}
@subsubsection Runners


`Código fuente:' Lib/asyncio/runners.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/runners.py}

Esta sección describe las primitivas asyncio de alto nivel para ejecutar código asyncio.

Están construidos sobre un @ref{dfe,,event loop} con el objetivo de simplificar el uso de código async para escenarios comunes de alta difusión.

@menu
* Ejecutando un programa asyncio:: 
* Gestor de contexto del runner:: 
* Manejando interrupciones de teclado:: 

@end menu

@node Ejecutando un programa asyncio,Gestor de contexto del runner,,Runners
@anchor{library/asyncio-runner running-an-asyncio-program}@anchor{31d1}
@subsubsection Ejecutando un programa asyncio


@geindex run() (en el módulo asyncio)
@anchor{library/asyncio-runner asyncio run}@anchor{525}
@deffn {Función} asyncio.run (coro, *, debug=None, loop_factory=None)

Execute `coro' in an asyncio event loop and return the result.

The argument can be any awaitable object.

This function runs the awaitable, taking care of managing the
asyncio event loop, `finalizing asynchronous generators', and
closing the executor.

Esta función no puede ser llamada cuando otro bucle de eventos asyncio está corriendo en el mismo hilo.

Si `debug' es @code{True}, el bucle de eventos se ejecutará en modo depuración. @code{False} deshabilita el modo depuración de manera explícita. @code{None} se usa para respetar la configuración global @ref{1d55,,Modo depuración}.

If `loop_factory' is not @code{None}, it is used to create a new event loop;
otherwise @ref{31d2,,asyncio.new_event_loop()} is used. The loop is closed at the end.
This function should be used as a main entry point for asyncio programs,
and should ideally only be called once. It is recommended to use
`loop_factory' to configure the event loop instead of policies.
Passing @ref{16fc,,asyncio.EventLoop} allows running asyncio without the
policy system.

Al ejecutor se le da un tiempo de espera de 5 minutos para apagarse. Si el ejecutor no ha finalizado en ese tiempo, se emite una advertencia y se cierra el ejecutor.

Ejemplo:

@example
async def main():
    await asyncio.sleep(1)
    print('hello')

asyncio.run(main())
@end example


Added in version 3.7.



Distinto en la versión 3.9: Actualizado para usar @ref{97e,,loop.shutdown_default_executor()}.



Distinto en la versión 3.10: `debug' es @code{None} por defecto para respetar la configuración global del modo depuración.



Distinto en la versión 3.12: Añadido el parámetro `loop_factory'.



Distinto en la versión 3.14: `coro' can be any awaitable object.

@end deffn

@node Gestor de contexto del runner,Manejando interrupciones de teclado,Ejecutando un programa asyncio,Runners
@anchor{library/asyncio-runner runner-context-manager}@anchor{31d3}
@subsubsection Gestor de contexto del runner


@geindex Runner (clase en asyncio)
@anchor{library/asyncio-runner asyncio Runner}@anchor{6a1}
@deffn {Clase} asyncio.Runner (*, debug=None, loop_factory=None)

Un gestor de contexto que simplifica `múltiples' llamadas a funciones asíncronas en el mismo contexto.

A veces varias funciones asíncronas de alto nivel deben ser llamadas en el mismo @ref{dfe,,event loop} y @ref{15a0,,contextvars.Context}.

Si `debug' es @code{True}, el bucle de eventos se ejecutará en modo depuración. @code{False} deshabilita el modo depuración de manera explícita. @code{None} se usa para respetar la configuración global @ref{1d55,,Modo depuración}.

`loop_factory' puede ser usado para redefinir la creación de bucles. Es responsabilidad del `loop_factory' establecer el bucle creado como el actual. Por defecto @ref{31d2,,asyncio.new_event_loop()} es usado y configura el nuevo bucle de eventos como el actual con @ref{17d2,,asyncio.set_event_loop()} si `loop_factory' es @code{None}.

Basically, @ref{525,,asyncio.run()} example can be rewritten with the runner usage:

@example
async def main():
    await asyncio.sleep(1)
    print('hello')

with asyncio.Runner() as runner:
    runner.run(main())
@end example


Added in version 3.11.


@geindex run() (método de asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner run}@anchor{15e9}
@deffn {Método} run (coro, *, context=None)

Execute `coro' in the embedded event loop.

The argument can be any awaitable object.

If the argument is a coroutine, it is wrapped in a Task.

An optional keyword-only `context' argument allows specifying a
custom @ref{15a0,,contextvars.Context} for the code to run in.
The runner’s default context is used if context is @code{None}.

Returns the awaitable’s result or raises an exception.

Esta función no puede ser llamada cuando otro bucle de eventos asyncio está corriendo en el mismo hilo.


Distinto en la versión 3.14: `coro' can be any awaitable object.

@end deffn

@geindex close() (método de asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner close}@anchor{31d4}
@deffn {Método} close ()

Cierra el runner.

Termina los generadores asíncronos, apaga el ejecutor por defecto, cierra el bucle de eventos y libera el @ref{15a0,,contextvars.Context} embebido.
@end deffn

@geindex get_loop() (método de asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner get_loop}@anchor{31d5}
@deffn {Método} get_loop ()

Retorna el bucle de eventos asociado a la instancia del runner.
@end deffn

@cartouche
@quotation Nota 
@ref{6a1,,Runner} usa una estrategia de inicialización perezosa, su constructor no inicializa las estructuras de bajo nivel subyacentes.

El `loop' y el `context' embebidos son creados al entrar al cuerpo @ref{673,,with} o en la primera llamada a @ref{525,,run()} o a @ref{31d5,,get_loop()}.
@end quotation
@end cartouche
@end deffn

@node Manejando interrupciones de teclado,,Gestor de contexto del runner,Runners
@anchor{library/asyncio-runner handling-keyboard-interruption}@anchor{31d6}
@subsubsection Manejando interrupciones de teclado



Added in version 3.11.


Cuando @ref{8db,,signal.SIGINT} es lanzada por @code{Ctrl-C}, la excepción @ref{a63,,KeyboardInterrupt} es lanzada en el hilo principal por defecto. Sin embargo, esto no funciona con @ref{b,,asyncio} porque puede interrumpir las funciones internas a asyncio e impedir la salida del programa.

Para mitigar este problema, @ref{b,,asyncio} maneja @ref{8db,,signal.SIGINT} de la siguiente forma:


@enumerate 

@item 
@ref{15e9,,asyncio.Runner.run()} instala un administrador @ref{8db,,signal.SIGINT} personalizado antes que cualquier código de usuario sea ejecutado y lo remueve a la salida de la función.

@item 
La @ref{6a1,,Runner} crea la tarea principal que será pasada a la co-rutina para su ejecución.

@item 
Cuando @ref{8db,,signal.SIGINT} es lanzada por @code{Ctrl-C}, el administrador de señales personalizado cancela la tarea principal llamando a @ref{31e,,asyncio.Task.cancel()} que lanza @ref{31f,,asyncio.CancelledError} dentro de la tarea principal.  Esto hace que la pila de Python se desenrolle, los bloques @code{try/except} y @code{try/finally} se pueden utilizar para la limpieza de recursos.  Luego que la tarea principal es cancelada, @ref{15e9,,asyncio.Runner.run()} lanza @ref{a63,,KeyboardInterrupt}.

@item 
Un usuario podría escribir un bucle cerrado que no puede ser interrumpido por @ref{31e,,asyncio.Task.cancel()}, en cuyo caso la segunda llamada a @code{Ctrl-C} lanza inmediatamente @ref{a63,,KeyboardInterrupt} sin cancelar la tarea principal.
@end enumerate

@node Corrutinas y tareas,Streams,Runners,asyncio — Asynchronous I/O
@anchor{library/asyncio-task doc}@anchor{31d7}@anchor{library/asyncio-task coroutines-and-tasks}@anchor{31d8}
@subsubsection Corrutinas y tareas


Esta sección describe las API de asyncio de alto nivel para trabajar con corrutinas y tareas.

@menu
* Corrutinas: Corrutinas<3>. 
* Esperables:: 
* Creando Tareas:: 
* Cancelación de tareas:: 
* Grupos de tareas:: 
* Durmiendo:: 
* Ejecutando tareas concurrentemente:: 
* Fábrica de tareas ansiosas:: 
* Protección contra cancelación:: 
* Tiempo agotado:: 
* Esperando primitivas:: 
* Ejecutando en hilos:: 
* Planificación desde otros hilos:: 
* Introspección:: 
* Objeto Task:: 

@end menu

@node Corrutinas<3>,Esperables,,Corrutinas y tareas
@anchor{library/asyncio-task coroutine}@anchor{31c4}@anchor{library/asyncio-task coroutines}@anchor{31d9}
@subsubsection Corrutinas


`Source code:' Lib/asyncio/coroutines.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/coroutines.py}


__________________________________________________________________


@ref{53a,,Coroutines} declarado con la sintaxis async/await es la forma preferida de escribir aplicaciones asyncio. Por ejemplo, el siguiente fragmento de código imprime «hola», espera 1 segundo y luego imprime «mundo»:

@example
>>> import asyncio

>>> async def main():
...     print('hello')
...     await asyncio.sleep(1)
...     print('world')

>>> asyncio.run(main())
hello
world
@end example

Tenga en cuenta que simplemente llamando a una corrutina no programará para que se ejecute:

@example
>>> main()
<coroutine object main at 0x1053bb7c8>
@end example

Para ejecutar realmente una corutina, asyncio proporciona los siguientes mecanismos:


@itemize *

@item 
La función @ref{525,,asyncio.run()} para ejecutar la función de punto de entrada de nivel superior «main()» (consulte el ejemplo anterior.)

@item 
Esperando en una corrutina. El siguiente fragmento de código imprimirá «hola» después de esperar 1 segundo y luego imprimirá «mundo» después de esperar `otros' 2 segundos:

@example
import asyncio
import time

async def say_after(delay, what):
    await asyncio.sleep(delay)
    print(what)

async def main():
    print(f"started at @{time.strftime('%X')@}")

    await say_after(1, 'hello')
    await say_after(2, 'world')

    print(f"finished at @{time.strftime('%X')@}")

asyncio.run(main())
@end example

Salida esperada:

@example
started at 17:13:52
hello
world
finished at 17:13:55
@end example

@item 
La función @ref{69d,,asyncio.create_task()} para ejecutar corrutinas concurrentemente como asyncio @ref{580,,Tasks}.

Modifiquemos el ejemplo anterior y ejecutemos dos corrutinas @code{say_after} `concurrentemente':

@example
async def main():
    task1 = asyncio.create_task(
        say_after(1, 'hello'))

    task2 = asyncio.create_task(
        say_after(2, 'world'))

    print(f"started at @{time.strftime('%X')@}")

    # Wait until both tasks are completed (should take
    # around 2 seconds.)
    await task1
    await task2

    print(f"finished at @{time.strftime('%X')@}")
@end example

Tenga en cuenta que la salida esperada ahora muestra que el fragmento de código se ejecuta 1 segundo más rápido que antes:

@example
started at 17:14:32
hello
world
finished at 17:14:34
@end example

@item 
La clase @ref{31c,,asyncio.TaskGroup} proporciona una alternativa más moderna a @ref{69d,,create_task()}. Usando esta API, el último ejemplo se convierte en:

@example
async def main():
    async with asyncio.TaskGroup() as tg:
        task1 = tg.create_task(
            say_after(1, 'hello'))

        task2 = tg.create_task(
            say_after(2, 'world'))

        print(f"started at @{time.strftime('%X')@}")

    # The await is implicit when the context manager exits.

    print(f"finished at @{time.strftime('%X')@}")
@end example

El tiempo y la salida deben ser los mismos que para la versión anterior.


Added in version 3.11: @ref{31c,,asyncio.TaskGroup}.

@end itemize

@node Esperables,Creando Tareas,Corrutinas<3>,Corrutinas y tareas
@anchor{library/asyncio-task asyncio-awaitables}@anchor{31da}@anchor{library/asyncio-task awaitables}@anchor{31db}
@subsubsection Esperables


Decimos que un objeto es un objeto `esperable' si se puede utilizar en una expresión @ref{14e,,await}. Muchas API de asyncio están diseñadas para aceptar los valores esperables.

Hay tres tipos principales de objetos `esperables': `corrutinas', `Tareas' y `Futures'.

@subsubheading Corrutinas


Las corrutinas de Python son `esperables' y por lo tanto se pueden esperar de otras corrutinas:

@example
import asyncio

async def nested():
    return 42

async def main():
    # Nothing happens if we just call "nested()".
    # A coroutine object is created but not awaited,
    # so it *won't run at all*.
    nested()  # will raise a "RuntimeWarning".

    # Let's do it differently now and await it:
    print(await nested())  # will print "42".

asyncio.run(main())
@end example

@cartouche
@quotation Importante 
En esta documentación se puede utilizar el término «corrutina» para dos conceptos estrechamente relacionados:


@itemize *

@item 
una `función corrutina': una función @ref{672,,async def};

@item 
un `objeto corrutina': un objeto retornado llamando a una `función corrutina'.
@end itemize
@end quotation
@end cartouche

@subsubheading Tareas


`Las tareas' se utilizan para programar corrutinas `concurrentemente'.

Cuando una corrutina se envuelve en una `Tarea' con funciones como @ref{69d,,asyncio.create_task()} la corrutina se programa automáticamente para ejecutarse pronto:

@example
import asyncio

async def nested():
    return 42

async def main():
    # Schedule nested() to run soon concurrently
    # with "main()".
    task = asyncio.create_task(nested())

    # "task" can now be used to cancel "nested()", or
    # can simply be awaited to wait until it is complete:
    await task

asyncio.run(main())
@end example

@subsubheading Futures


Un @ref{c55,,Future} es un objeto esperable especial de `bajo-nivel' que representa un `resultado eventual' de una operación asíncrona.

Cuando un objeto Future es `esperado' significa que la corrutina esperará hasta que el Future se resuelva en algún otro lugar.

Los objetos Future de asyncio son necesarios para permitir que el código basado en retro llamada se use con async/await.

Normalmente , `no es necesario' crear objetos Future en el código de nivel de aplicación.

Los objetos Future, a veces expuestos por bibliotecas y algunas API de asyncio, pueden ser esperados:

@example
async def main():
    await function_that_returns_a_future_object()

    # this is also valid:
    await asyncio.gather(
        function_that_returns_a_future_object(),
        some_python_coroutine()
    )
@end example

Un buen ejemplo de una función de bajo nivel que retorna un objeto Future es @ref{980,,loop.run_in_executor()}.

@node Creando Tareas,Cancelación de tareas,Esperables,Corrutinas y tareas
@anchor{library/asyncio-task creating-tasks}@anchor{31dc}
@subsubsection Creando Tareas


`Source code:' Lib/asyncio/tasks.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/tasks.py}


__________________________________________________________________


@geindex create_task() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio create_task}@anchor{69d}
@deffn {Función} asyncio.create_task (coro, *, name=None, context=None)

Envuelve una @ref{31c4,,coroutine} `coro' en una @ref{580,,Task} y programa su ejecución. Retorna el objeto Tarea.

Si `name' no es @code{None}, se establece como el nombre de la tarea mediante @ref{a6f,,Task.set_name()}.

Un argumento `context' opcional de solo palabra clave permite especificar un @ref{15a0,,contextvars.Context} personalizado para que se ejecute el `coro'. La copia de contexto actual se crea cuando no se proporciona `context'.

La tarea se ejecuta en el bucle retornado por @ref{b96,,get_running_loop()}, @ref{1e5,,RuntimeError} se genera si no hay ningún bucle en ejecución en el subproceso actual.

@cartouche
@quotation Nota 
@ref{322,,asyncio.TaskGroup.create_task()} es una alternativa más nueva que permite una espera conveniente para un grupo de tareas relacionadas.
@end quotation
@end cartouche

@cartouche
@quotation Importante 
Guarde una referencia al resultado de esta función, para evitar que una tarea desaparezca en medio de la ejecución. El bucle de eventos solo mantiene referencias débiles a las tareas. Una tarea a la que no se hace referencia en ningún otro lugar puede ser recolectada por el recolector de basura  en cualquier momento, incluso antes de que se complete. Para tareas confiables en segundo plano,  de tipo «lanzar y olvidar», reúnalas en una colección:

@example
background_tasks = set()

for i in range(10):
    task = asyncio.create_task(some_coro(param=i))

    # Add task to the set. This creates a strong reference.
    background_tasks.add(task)

    # To prevent keeping references to finished tasks forever,
    # make each task remove its own reference from the set after
    # completion:
    task.add_done_callback(background_tasks.discard)
@end example
@end quotation
@end cartouche


Added in version 3.7.



Distinto en la versión 3.8: Se ha añadido el parámetro `name'.



Distinto en la versión 3.11: Se ha añadido el parámetro `context'.

@end deffn

@node Cancelación de tareas,Grupos de tareas,Creando Tareas,Corrutinas y tareas
@anchor{library/asyncio-task task-cancellation}@anchor{31dd}
@subsubsection Cancelación de tareas


Las tareas se pueden cancelar de forma fácil y segura. Cuando se cancela una tarea, se generará @ref{31f,,asyncio.CancelledError} en la tarea en la próxima oportunidad.

Se recomienda que las corrutinas utilicen bloques @code{try/finally} para realizar de forma sólida la lógica de limpieza. En caso de que @ref{31f,,asyncio.CancelledError} se detecte explícitamente, generalmente debería propagarse cuando se complete la limpieza. @ref{31f,,asyncio.CancelledError} subclasifica directamente a @ref{65c,,BaseException}, por lo que la mayor parte del código no necesitará tenerlo en cuenta.

Los componentes asyncio que permiten la simultaneidad estructurada, como @ref{31c,,asyncio.TaskGroup} y @ref{69f,,asyncio.timeout()}, se implementan mediante cancelación internamente y podrían comportarse mal si una rutina traga @ref{31f,,asyncio.CancelledError}. De manera similar, el código de usuario generalmente no debería llamar a @ref{321,,uncancel}. Sin embargo, en los casos en los que realmente se desea suprimir @ref{31f,,asyncio.CancelledError}, es necesario llamar también a @code{uncancel()} para eliminar completamente el estado de cancelación.

@node Grupos de tareas,Durmiendo,Cancelación de tareas,Corrutinas y tareas
@anchor{library/asyncio-task task-groups}@anchor{31de}@anchor{library/asyncio-task taskgroups}@anchor{31df}
@subsubsection Grupos de tareas


Los grupos de tareas combinan una API de creación de tareas con una forma conveniente y confiable de esperar a que finalicen todas las tareas del grupo.

@geindex TaskGroup (clase en asyncio)
@anchor{library/asyncio-task asyncio TaskGroup}@anchor{31c}
@deffn {Clase} asyncio.TaskGroup

Un @ref{69c,,asynchronous context manager} que contiene un grupo de tareas. Las tareas se pueden agregar al grupo usando @ref{69d,,create_task()}. Se esperan todas las tareas cuando sale el administrador de contexto.


Added in version 3.11.


@geindex create_task() (método de asyncio.TaskGroup)
@anchor{library/asyncio-task asyncio TaskGroup create_task}@anchor{322}
@deffn {Método} create_task (coro, *, name=None, context=None)

Create a task in this task group.
The signature matches that of @ref{69d,,asyncio.create_task()}.
If the task group is inactive (e.g. not yet entered,
already finished, or in the process of shutting down),
we will close the given @code{coro}.


Distinto en la versión 3.13: Close the given coroutine if the task group is not active.

@end deffn
@end deffn

Ejemplo:

@example
async def main():
    async with asyncio.TaskGroup() as tg:
        task1 = tg.create_task(some_coro(...))
        task2 = tg.create_task(another_coro(...))
    print(f"Both tasks have completed now: @{task1.result()@}, @{task2.result()@}")
@end example

La instrucción @code{async with} esperará a que finalicen todas las tareas del grupo. Mientras espera, aún se pueden agregar nuevas tareas al grupo (por ejemplo, pasando @code{tg} a una de las corrutinas y llamando a @code{tg.create_task()} en esa corrutina). Una vez finalizada la última tarea y salido del bloque @code{async with}, no se podrán añadir nuevas tareas al grupo.

La primera vez que alguna de las tareas pertenecientes al grupo falla con una excepción que no sea @ref{31f,,asyncio.CancelledError}, las tareas restantes del grupo se cancelan. No se pueden añadir más tareas al grupo. En este punto, si el cuerpo de la instrucción @code{async with} aún está activo (es decir, aún no se ha llamado a @ref{1636,,__aexit__()}), la tarea que contiene directamente la instrucción @code{async with} también se cancela. El @ref{31f,,asyncio.CancelledError} resultante interrumpirá un @code{await}, pero no saldrá de la instrucción @code{async with} que lo contiene.

Una vez que todas las tareas han finalizado, si alguna tarea ha fallado con una excepción que no sea @ref{31f,,asyncio.CancelledError}, esas excepciones se combinan en un @ref{31d,,ExceptionGroup} o @ref{3b6,,BaseExceptionGroup} (según corresponda; consulte su documentación) que luego se genera.

Dos excepciones básicas se tratan de manera especial: si alguna tarea falla con @ref{a63,,KeyboardInterrupt} o @ref{dc7,,SystemExit}, el grupo de tareas aún cancela las tareas restantes y las espera, pero luego se vuelve a generar el @ref{a63,,KeyboardInterrupt} o @ref{dc7,,SystemExit} inicial en lugar de @ref{31d,,ExceptionGroup} o @ref{3b6,,BaseExceptionGroup}.

Si el cuerpo de la instrucción @code{async with} finaliza con una excepción (por lo que se llama a @ref{1636,,__aexit__()} con un conjunto de excepciones), esto se trata igual que si una de las tareas fallara: las tareas restantes se cancelan y luego se esperan, y las excepciones de no cancelación se agrupan en un grupo de excepción y se generan. La excepción pasada a @ref{1636,,__aexit__()}, a menos que sea @ref{31f,,asyncio.CancelledError}, también se incluye en el grupo de excepciones. Se hace el mismo caso especial para @ref{a63,,KeyboardInterrupt} y @ref{dc7,,SystemExit} que en el párrafo anterior.

Task groups are careful not to mix up the internal cancellation used to
«wake up» their @ref{1636,,__aexit__()} with cancellation requests
for the task in which they are running made by other parties.
In particular, when one task group is syntactically nested in another,
and both experience an exception in one of their child tasks simultaneously,
the inner task group will process its exceptions, and then the outer task group
will receive another cancellation and process its own exceptions.

In the case where a task group is cancelled externally and also must
raise an @ref{31d,,ExceptionGroup}, it will call the parent task’s
@ref{31e,,cancel()} method. This ensures that a
@ref{31f,,asyncio.CancelledError} will be raised at the next
@ref{14e,,await}, so the cancellation is not lost.

Task groups preserve the cancellation count
reported by @ref{320,,asyncio.Task.cancelling()}.


Distinto en la versión 3.13: Improved handling of simultaneous internal and external cancellations
and correct preservation of cancellation counts.


@menu
* Terminating a Task Group:: 

@end menu

@node Terminating a Task Group,,,Grupos de tareas
@anchor{library/asyncio-task terminating-a-task-group}@anchor{31e0}
@subsubsection Terminating a Task Group


While terminating a task group is not natively supported by the standard
library, termination can be achieved by adding an exception-raising task
to the task group and ignoring the raised exception:

@example
import asyncio
from asyncio import TaskGroup

class TerminateTaskGroup(Exception):
    """Exception raised to terminate a task group."""

async def force_terminate_task_group():
    """Used to force termination of a task group."""
    raise TerminateTaskGroup()

async def job(task_id, sleep_time):
    print(f'Task @{task_id@}: start')
    await asyncio.sleep(sleep_time)
    print(f'Task @{task_id@}: done')

async def main():
    try:
        async with TaskGroup() as group:
            # spawn some tasks
            group.create_task(job(1, 0.5))
            group.create_task(job(2, 1.5))
            # sleep for 1 second
            await asyncio.sleep(1)
            # add an exception-raising task to force the group to terminate
            group.create_task(force_terminate_task_group())
    except* TerminateTaskGroup:
        pass

asyncio.run(main())
@end example

Expected output:

@example
Task 1: start
Task 2: start
Task 1: done
@end example

@node Durmiendo,Ejecutando tareas concurrentemente,Grupos de tareas,Corrutinas y tareas
@anchor{library/asyncio-task sleeping}@anchor{31e1}
@subsubsection Durmiendo


@geindex sleep() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio sleep}@anchor{afe}
@deffn {Función} coroutine asyncio.sleep (delay, result=None)

Bloquea por `delay' segundos.

Si se proporciona `result', se retorna al autor de la llamada cuando se completa la corrutina.

@code{sleep()} siempre suspende la tarea actual, permitiendo que se ejecuten otras tareas.

Establecer el retraso en 0 proporciona una ruta optimizada para permitir que se ejecuten otras tareas. Esto puede ser utilizado por funciones de ejecución prolongada para evitar bloquear el bucle de eventos durante toda la duración de la llamada a la función.
@anchor{library/asyncio-task asyncio-example-sleep}@anchor{31e2}
Ejemplo de una rutina que muestra la fecha actual cada segundo durante 5 segundos:

@example
import asyncio
import datetime

async def display_date():
    loop = asyncio.get_running_loop()
    end_time = loop.time() + 5.0
    while True:
        print(datetime.datetime.now())
        if (loop.time() + 1.0) >= end_time:
            break
        await asyncio.sleep(1)

asyncio.run(display_date())
@end example


Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Distinto en la versión 3.13: Raises @ref{360,,ValueError} if `delay' is @ref{704,,nan}.

@end deffn

@node Ejecutando tareas concurrentemente,Fábrica de tareas ansiosas,Durmiendo,Corrutinas y tareas
@anchor{library/asyncio-task running-tasks-concurrently}@anchor{31e3}
@subsubsection Ejecutando tareas concurrentemente


@geindex gather() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio gather}@anchor{69e}
@deffn {Función} awaitable asyncio.gather (*aws, return_exceptions=False)

Ejecute @ref{31da,,objetos esperables} en la secuencia `aws' de forma `concurrently'.

Si cualquier esperable en `aws' es una corrutina, se programa automáticamente como una Tarea.

Si todos los esperables se completan correctamente, el resultado es una lista agregada de valores retornados. El orden de los valores de resultado corresponde al orden de esperables en `aws'.

Si `return_exceptions' es @code{False} (valor predeterminado), la primera excepción provocada se propaga inmediatamente a la tarea que espera en @code{gather()}. Otros esperables en la secuencia `aws' `no se cancelarán' y continuarán ejecutándose.

Si `return_exceptions' es @code{True}, las excepciones se tratan igual que los resultados correctos y se agregan en la lista de resultados.

Si @code{gather()} es `cancelado', todos los esperables enviados (que aún no se han completado) también se `cancelan'.

Si alguna Tarea o Future de la secuencia `aws' se `cancela', se trata como si se lanzara @ref{31f,,CancelledError} – la llamada @code{gather()} `no' se cancela en este caso. Esto es para evitar la cancelación de una Tarea/Future enviada para hacer que otras Tareas/Futures sean canceladas.

@cartouche
@quotation Nota 
Una forma más moderna de crear y ejecutar tareas simultáneamente y esperar a que se completen es @ref{31c,,asyncio.TaskGroup}.
@end quotation
@end cartouche
@anchor{library/asyncio-task asyncio-example-gather}@anchor{31e4}
Ejemplo:

@example
import asyncio

async def factorial(name, number):
    f = 1
    for i in range(2, number + 1):
        print(f"Task @{name@}: Compute factorial(@{number@}), currently i=@{i@}...")
        await asyncio.sleep(1)
        f *= i
    print(f"Task @{name@}: factorial(@{number@}) = @{f@}")
    return f

async def main():
    # Schedule three calls *concurrently*:
    L = await asyncio.gather(
        factorial("A", 2),
        factorial("B", 3),
        factorial("C", 4),
    )
    print(L)

asyncio.run(main())

# Expected output:
#
#     Task A: Compute factorial(2), currently i=2...
#     Task B: Compute factorial(3), currently i=2...
#     Task C: Compute factorial(4), currently i=2...
#     Task A: factorial(2) = 2
#     Task B: Compute factorial(3), currently i=3...
#     Task C: Compute factorial(4), currently i=3...
#     Task B: factorial(3) = 6
#     Task C: Compute factorial(4), currently i=4...
#     Task C: factorial(4) = 24
#     [2, 6, 24]
@end example

@cartouche
@quotation Nota 
If `return_exceptions' is false, cancelling gather() after it
has been marked done won’t cancel any submitted awaitables.
For instance, gather can be marked done after propagating an
exception to the caller, therefore, calling @code{gather.cancel()}
after catching an exception (raised by one of the awaitables) from
gather won’t cancel any other awaitables.
@end quotation
@end cartouche


Distinto en la versión 3.7: Si se cancela el propio `gather', la cancelación se propaga independientemente de `return_exceptions'.



Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Obsoleto desde la versión 3.10: Se emite una advertencia de obsolescencia si no se proporcionan argumentos posicionales o no todos los argumentos posicionales son objetos de tipo Future y no hay un bucle de eventos en ejecución.

@end deffn

@node Fábrica de tareas ansiosas,Protección contra cancelación,Ejecutando tareas concurrentemente,Corrutinas y tareas
@anchor{library/asyncio-task eager-task-factory}@anchor{31e5}@anchor{library/asyncio-task id1}@anchor{31e6}
@subsubsection Fábrica de tareas ansiosas


@geindex eager_task_factory() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio eager_task_factory}@anchor{522}
@deffn {Función} asyncio.eager_task_factory (loop, coro, *, name=None, context=None)

Una fábrica de tareas para una ejecución entusiasta de tareas.

Cuando se utiliza esta fábrica (a través de @ref{e4b,,loop.set_task_factory(asyncio.eager_task_factory)}), las corrutinas comienzan a ejecutarse sincrónicamente durante la construcción de @ref{580,,Task}. Las tareas sólo se programan en el bucle de eventos si se bloquean. Esto puede suponer una mejora del rendimiento, ya que se evita la sobrecarga de la programación del bucle para las corrutinas que se completan sincrónicamente.

Un ejemplo común en el que esto resulta beneficioso son las rutinas que emplean almacenamiento en caché o memorización para evitar E/S reales cuando sea posible.

@cartouche
@quotation Nota 
La ejecución inmediata de la corrutina es un cambio semántico. Si la rutina regresa o se activa, la tarea nunca se programa en el bucle de eventos. Si la ejecución de la rutina se bloquea, la tarea se programa en el bucle de eventos. Este cambio puede introducir cambios de comportamiento en las aplicaciones existentes. Por ejemplo, es probable que cambie el orden de ejecución de las tareas de la aplicación.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex create_eager_task_factory() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio create_eager_task_factory}@anchor{523}
@deffn {Función} asyncio.create_eager_task_factory (custom_task_constructor)

Cree una fábrica de tareas entusiastas, similar a @ref{522,,eager_task_factory()}, utilizando el `custom_task_constructor' proporcionado al crear una nueva tarea en lugar del @ref{580,,Task} predeterminado.

`custom_task_constructor' debe ser un `callable' con la firma que coincida con la firma de @ref{580,,Task.__init__}. El invocable debe devolver un objeto compatible con @ref{580,,asyncio.Task}.

Esta función devuelve un `callable' destinado a ser utilizado como fábrica de tareas de un bucle de eventos a través de @ref{e4b,,loop.set_task_factory(factory)}).


Added in version 3.12.

@end deffn

@node Protección contra cancelación,Tiempo agotado,Fábrica de tareas ansiosas,Corrutinas y tareas
@anchor{library/asyncio-task shielding-from-cancellation}@anchor{31e7}
@subsubsection Protección contra cancelación


@geindex shield() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio shield}@anchor{aff}
@deffn {Función} awaitable asyncio.shield (aw)

Protege un @ref{31da,,objeto esperable} de ser @ref{31e,,cancelado}.

Si `aw' es una corrutina, se programa automáticamente como una Tarea.

La declaración:

@example
task = asyncio.create_task(something())
res = await shield(task)
@end example

es equivalente a:

@example
res = await something()
@end example

`excepto' que si la corrutina que lo contiene se cancela, la tarea que se ejecuta en @code{something()} no se cancela. Desde el punto de vista de @code{something()}, la cancelación no ocurrió. Aunque su invocador siga cancelado, por lo que la expresión «await» sigue generando un @ref{31f,,CancelledError}.

Si @code{something()} se cancela por otros medios (es decir, desde dentro de sí mismo) eso también cancelaría @code{shield()}.

Si se desea ignorar por completo la cancelación (no se recomienda) la función @code{shield()} debe combinarse con una cláusula try/except, como se indica a continuación:

@example
task = asyncio.create_task(something())
try:
    res = await shield(task)
except CancelledError:
    res = None
@end example

@cartouche
@quotation Importante 
Guarde una referencia a las tareas pasadas a esta función, para evitar que una tarea desaparezca a mitad de la ejecución. El bucle de eventos solo mantiene referencias débiles a las tareas. Una tarea a la que no se hace referencia en ningún otro lugar puede  ser recolectada por el recolector de basura en cualquier momento, incluso antes de que se complete.
@end quotation
@end cartouche


Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Obsoleto desde la versión 3.10: Se emite una advertencia de obsolescencia si `aw' no es un objeto similares a Futures y no hay un bucle de eventos en ejecución.

@end deffn

@node Tiempo agotado,Esperando primitivas,Protección contra cancelación,Corrutinas y tareas
@anchor{library/asyncio-task timeouts}@anchor{31e8}
@subsubsection Tiempo agotado


@geindex timeout() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio timeout}@anchor{69f}
@deffn {Función} asyncio.timeout (delay)

Un @ref{69c,,asynchronous context manager} que se puede usar para limitar la cantidad de tiempo que se pasa esperando algo.

`delay' puede ser @code{None} o un número flotante/int de segundos de espera. Si `delay' es @code{None}, no se aplicará ningún límite de tiempo; esto puede ser útil si se desconoce el retraso cuando se crea el administrador de contexto.

En cualquier caso, el administrador de contexto se puede reprogramar después de la creación mediante @ref{31e9,,Timeout.reschedule()}.

Ejemplo:

@example
async def main():
    async with asyncio.timeout(10):
        await long_running_task()
@end example

Si @code{long_running_task} tarda más de 10 segundos en completarse, el administrador de contexto cancelará la tarea actual y manejará internamente el @ref{31f,,asyncio.CancelledError} resultante, transformándolo en un @ref{1749,,asyncio.TimeoutError} que se puede capturar y manejar.

@cartouche
@quotation Nota 
El administrador de contexto @ref{69f,,asyncio.timeout()} es lo que transforma el @ref{31f,,asyncio.CancelledError} en un @ref{1749,,asyncio.TimeoutError}, lo que significa que el @ref{1749,,asyncio.TimeoutError} solo puede capturarse `outside' del administrador de contexto.
@end quotation
@end cartouche

Ejemplo de captura de @ref{8cc,,TimeoutError}:

@example
async def main():
    try:
        async with asyncio.timeout(10):
            await long_running_task()
    except TimeoutError:
        print("The long operation timed out, but we've handled it.")

    print("This statement will run regardless.")
@end example

El administrador de contexto producido por @ref{69f,,asyncio.timeout()} puede reprogramarse para una fecha límite diferente e inspeccionarse.

@geindex Timeout (clase en asyncio)
@anchor{library/asyncio-task asyncio Timeout}@anchor{16d4}
@deffn {Clase} asyncio.Timeout (when)

Un @ref{69c,,asynchronous context manager} para cancelar corrutinas vencidas.

@code{when} debe ser un tiempo absoluto en el que el contexto debe expirar, según lo medido por el reloj del bucle de eventos:


@itemize -

@item 
Si @code{when} es @code{None}, el tiempo de espera nunca se activará.

@item 
Si @code{when < loop.time()}, el tiempo de espera se activará en la próxima iteración del bucle de eventos
@end itemize

@quotation

@geindex when() (método de asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout when}@anchor{31ea}
@deffn {Método} when () -> float | None

Retorna la fecha límite actual, o @code{None} si la fecha límite actual no está establecida.
@end deffn

@geindex reschedule() (método de asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout reschedule}@anchor{31e9}
@deffn {Método} reschedule (when: float | None)

Reprogramar el tiempo de espera.
@end deffn

@geindex expired() (método de asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout expired}@anchor{31eb}
@deffn {Método} expired () -> bool

Retorna si el administrador de contexto ha excedido su fecha límite (caducada).
@end deffn
@end quotation
@end deffn

Ejemplo:

@example
async def main():
    try:
        # We do not know the timeout when starting, so we pass `@w{`}None`@w{`}.
        async with asyncio.timeout(None) as cm:
            # We know the timeout now, so we reschedule it.
            new_deadline = get_running_loop().time() + 10
            cm.reschedule(new_deadline)

            await long_running_task()
    except TimeoutError:
        pass

    if cm.expired():
        print("Looks like we haven't finished on time.")
@end example

Los administradores de contexto de tiempo de espera se pueden anidar de forma segura.


Added in version 3.11.

@end deffn

@geindex timeout_at() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio timeout_at}@anchor{1829}
@deffn {Función} asyncio.timeout_at (when)

Similar a @ref{69f,,asyncio.timeout()}, excepto que `when' es el tiempo absoluto para dejar de esperar, o @code{None}.

Ejemplo:

@example
async def main():
    loop = get_running_loop()
    deadline = loop.time() + 20
    try:
        async with asyncio.timeout_at(deadline):
            await long_running_task()
    except TimeoutError:
        print("The long operation timed out, but we've handled it.")

    print("This statement will run regardless.")
@end example


Added in version 3.11.

@end deffn

@geindex wait_for() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio wait_for}@anchor{6a0}
@deffn {Función} coroutine asyncio.wait_for (aw, timeout)

Espere a que el `aw' @ref{31da,,esperable} se complete con un tiempo agotado.

Si `aw' es una corrutina, se programa automáticamente como una Tarea.

`timeout' puede ser @code{None} o punto flotante o un número entero de segundos a esperar. Si `timeout' es @code{None}, se bloquea hasta que Future se completa.

Si se agota el tiempo de espera, cancela la tarea y lanza @ref{8cc,,TimeoutError}.

Para evitar la @ref{31e,,cancelación} de la tarea , envuélvala en @ref{aff,,shield()}.

La función esperará hasta que se cancele el Future, por lo que el tiempo de espera total puede exceder el `timeout'. Si ocurre una excepción durante la cancelación, se propaga.

Si se cancela la espera, el Future `aw' también se cancela.
@anchor{library/asyncio-task asyncio-example-waitfor}@anchor{31ec}
Ejemplo:

@example
async def eternity():
    # Sleep for one hour
    await asyncio.sleep(3600)
    print('yay!')

async def main():
    # Wait for at most 1 second
    try:
        await asyncio.wait_for(eternity(), timeout=1.0)
    except TimeoutError:
        print('timeout!')

asyncio.run(main())

# Expected output:
#
#     timeout!
@end example


Distinto en la versión 3.7: Cuando se cancela `aw' debido a un tiempo de espera, @code{wait_for} espera a que se cancele `aw'. Anteriormente, lanzaba @ref{8cc,,TimeoutError} inmediatamente.



Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Distinto en la versión 3.11: Raises @ref{8cc,,TimeoutError} instead of @ref{1749,,asyncio.TimeoutError}.

@end deffn

@node Esperando primitivas,Ejecutando en hilos,Tiempo agotado,Corrutinas y tareas
@anchor{library/asyncio-task waiting-primitives}@anchor{31ed}
@subsubsection Esperando primitivas


@geindex wait() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio wait}@anchor{528}
@deffn {Función} coroutine asyncio.wait (aws, *, timeout=None, return_when=ALL_COMPLETED)

Ejecuta instancias @ref{c55,,Future} y @ref{580,,Task} en el iterable `aws' simultáneamente y bloquea hasta la condición especificada por `return_when'.

El iterable `aws' no debe estar vacío.

Retorna dos conjuntos de Tareas/Futures: @code{(done, pending)}.

Uso:

@example
done, pending = await asyncio.wait(aws)
@end example

`timeout' (un punto flotante o int), si se especifica, se puede utilizar para controlar el número máximo de segundos que hay que esperar antes de retornar.

Tenga en cuenta que esta función no lanza @ref{8cc,,TimeoutError}. Los futuros o las tareas que no se realizan cuando se agota el tiempo de espera simplemente se retornan en el segundo conjunto.

`return_when' indica cuándo debe retornar esta función. Debe ser una de las siguientes constantes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Descripción

@item

@geindex FIRST_COMPLETED (en el módulo asyncio)
@anchor{library/asyncio-task asyncio FIRST_COMPLETED}@anchor{31ee}
@deffn {Dato} asyncio.FIRST_COMPLETED
@end deffn

@tab

La función retornará cuando cualquier Future termine o se cancele.

@item

@geindex FIRST_EXCEPTION (en el módulo asyncio)
@anchor{library/asyncio-task asyncio FIRST_EXCEPTION}@anchor{31ef}
@deffn {Dato} asyncio.FIRST_EXCEPTION
@end deffn

@tab

The function will return when any future finishes by raising an
exception. If no future raises an exception
then it is equivalent to @ref{31f0,,ALL_COMPLETED}.

@item

@geindex ALL_COMPLETED (en el módulo asyncio)
@anchor{library/asyncio-task asyncio ALL_COMPLETED}@anchor{31f0}
@deffn {Dato} asyncio.ALL_COMPLETED
@end deffn

@tab

La función retornará cuando todos los Futures terminen o se cancelen.

@end multitable


A diferencia de @ref{6a0,,wait_for()}, @code{wait()} no cancela los Futures cuando se produce un agotamiento de tiempo.


Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Distinto en la versión 3.11: Está prohibido pasar objetos de rutina a @code{wait()} directamente.



Distinto en la versión 3.12: Se agregó soporte para generadores que generan tareas.

@end deffn

@geindex as_completed() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio as_completed}@anchor{311}
@deffn {Función} asyncio.as_completed (aws, *, timeout=None)

Run @ref{31da,,awaitable objects} in the `aws' iterable
concurrently. The returned object can be iterated to obtain the results
of the awaitables as they finish.

The object returned by @code{as_completed()} can be iterated as an
@ref{312,,asynchronous iterator} or a plain @ref{313,,iterator}. When asynchronous
iteration is used, the originally-supplied awaitables are yielded if they
are tasks or futures. This makes it easy to correlate previously-scheduled
tasks with their results. Example:

@example
ipv4_connect = create_task(open_connection("127.0.0.1", 80))
ipv6_connect = create_task(open_connection("::1", 80))
tasks = [ipv4_connect, ipv6_connect]

async for earliest_connect in as_completed(tasks):
    # earliest_connect is done. The result can be obtained by
    # awaiting it or calling earliest_connect.result()
    reader, writer = await earliest_connect

    if earliest_connect is ipv6_connect:
        print("IPv6 connection established.")
    else:
        print("IPv4 connection established.")
@end example

During asynchronous iteration, implicitly-created tasks will be yielded for
supplied awaitables that aren’t tasks or futures.

When used as a plain iterator, each iteration yields a new coroutine that
returns the result or raises the exception of the next completed awaitable.
This pattern is compatible with Python versions older than 3.13:

@example
ipv4_connect = create_task(open_connection("127.0.0.1", 80))
ipv6_connect = create_task(open_connection("::1", 80))
tasks = [ipv4_connect, ipv6_connect]

for next_connect in as_completed(tasks):
    # next_connect is not one of the original task objects. It must be
    # awaited to obtain the result value or raise the exception of the
    # awaitable that finishes next.
    reader, writer = await next_connect
@end example

A @ref{8cc,,TimeoutError} is raised if the timeout occurs before all awaitables
are done. This is raised by the @code{async for} loop during asynchronous
iteration or by the coroutines yielded during plain iteration.


Distinto en la versión 3.10: Se quitó el parámetro `loop'.



Obsoleto desde la versión 3.10: Se emite una advertencia de obsolescencia si no todos los objetos en espera en el iterable `aws' son objetos de tipo Future y no hay un bucle de eventos en ejecución.



Distinto en la versión 3.12: Se agregó soporte para generadores que generan tareas.



Distinto en la versión 3.13: The result can now be used as either an @ref{312,,asynchronous iterator}
or as a plain @ref{313,,iterator} (previously it was only a plain iterator).

@end deffn

@node Ejecutando en hilos,Planificación desde otros hilos,Esperando primitivas,Corrutinas y tareas
@anchor{library/asyncio-task running-in-threads}@anchor{31f1}
@subsubsection Ejecutando en hilos


@geindex to_thread() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio to_thread}@anchor{97f}
@deffn {Función} coroutine asyncio.to_thread (func, /, *args, **kwargs)

Ejecutar asincrónicamente la función `func' en un hilo separado.

Cualquier *args y **kwargs suministrados para esta función se pasan directamente a `func'. Además, el current @ref{15a0,,contextvars.Context} se propaga, lo que permite acceder a las variables de contexto del subproceso del bucle de eventos en el subproceso separado.

Retorna una corrutina que se puede esperar para obtener el resultado final de `func'.

Esta función de rutina está diseñada principalmente para ejecutar funciones/métodos vinculados a IO que, de otro modo, bloquearían el bucle de eventos si se ejecutaran en el subproceso principal. Por ejemplo:

@example
def blocking_io():
    print(f"start blocking_io at @{time.strftime('%X')@}")
    # Note that time.sleep() can be replaced with any blocking
    # IO-bound operation, such as file operations.
    time.sleep(1)
    print(f"blocking_io complete at @{time.strftime('%X')@}")

async def main():
    print(f"started main at @{time.strftime('%X')@}")

    await asyncio.gather(
        asyncio.to_thread(blocking_io),
        asyncio.sleep(1))

    print(f"finished main at @{time.strftime('%X')@}")


asyncio.run(main())

# Expected output:
#
# started main at 19:50:53
# start blocking_io at 19:50:53
# blocking_io complete at 19:50:54
# finished main at 19:50:54
@end example

Llamar directamente a @code{blocking_io()} en cualquier rutina bloquearía el bucle de eventos durante su duración, lo que daría como resultado 1 segundo adicional de tiempo de ejecución. En cambio, al usar @code{asyncio.to_thread()}, podemos ejecutarlo en un subproceso separado sin bloquear el ciclo de eventos.

@cartouche
@quotation Nota 
Debido a @ref{2c5,,GIL}, @code{asyncio.to_thread()} generalmente solo se puede usar para hacer que las funciones vinculadas a IO no bloqueen. Sin embargo, para los módulos de extensión que lanzan GIL o implementaciones alternativas de Python que no tienen uno, @code{asyncio.to_thread()} también se puede usar para funciones vinculadas a la CPU.
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@node Planificación desde otros hilos,Introspección,Ejecutando en hilos,Corrutinas y tareas
@anchor{library/asyncio-task scheduling-from-other-threads}@anchor{31f2}
@subsubsection Planificación desde otros hilos


@geindex run_coroutine_threadsafe() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio run_coroutine_threadsafe}@anchor{91a}
@deffn {Función} asyncio.run_coroutine_threadsafe (coro, loop)

Envía una corrutina al bucle de eventos especificado. Seguro para Hilos.

Retorna @ref{1220,,concurrent.futures.Future} para esperar el resultado de otro hilo del SO (Sistema Operativo).

Esta función está pensada para llamarse desde un hilo del SO diferente al que se ejecuta el bucle de eventos. Ejemplo:

@example
# Create a coroutine
coro = asyncio.sleep(1, result=3)

# Submit the coroutine to a given loop
future = asyncio.run_coroutine_threadsafe(coro, loop)

# Wait for the result with an optional timeout argument
assert future.result(timeout) == 3
@end example

Si se lanza una excepción en la corrutina, el Future retornado será notificado. También se puede utilizar para cancelar la tarea en el bucle de eventos:

@example
try:
    result = future.result(timeout)
except TimeoutError:
    print('The coroutine took too long, cancelling the task...')
    future.cancel()
except Exception as exc:
    print(f'The coroutine raised an exception: @{exc!r@}')
else:
    print(f'The coroutine returned: @{result!r@}')
@end example

Consulte la sección de la documentación @ref{31f3,,Concurrencia y multi hilos}.

A diferencia de otras funciones asyncio, esta función requiere que el argumento `loop' se pase explícitamente.


Added in version 3.5.1.

@end deffn

@node Introspección,Objeto Task,Planificación desde otros hilos,Corrutinas y tareas
@anchor{library/asyncio-task introspection}@anchor{31f4}
@subsubsection Introspección


@geindex current_task() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio current_task}@anchor{526}
@deffn {Función} asyncio.current_task (loop=None)

Retorna la instancia @ref{580,,Task} actualmente en ejecución o @code{None} si no se está ejecutando ninguna tarea.

Si `loop' es @code{None} @ref{b96,,get_running_loop()} se utiliza para obtener el bucle actual.


Added in version 3.7.

@end deffn

@geindex all_tasks() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio all_tasks}@anchor{9e9}
@deffn {Función} asyncio.all_tasks (loop=None)

Retorna un conjunto de objetos @ref{580,,Task} que se ejecutan por el bucle.

Si `loop' es @code{None}, @ref{b96,,get_running_loop()} se utiliza para obtener el bucle actual.


Added in version 3.7.

@end deffn

@geindex iscoroutine() (en el módulo asyncio)
@anchor{library/asyncio-task asyncio iscoroutine}@anchor{527}
@deffn {Función} asyncio.iscoroutine (obj)

Retorna @code{True} si `obj' es un objeto corutina.


Added in version 3.4.

@end deffn

@node Objeto Task,,Introspección,Corrutinas y tareas
@anchor{library/asyncio-task task-object}@anchor{31f5}
@subsubsection Objeto Task


@geindex Task (clase en asyncio)
@anchor{library/asyncio-task asyncio Task}@anchor{580}
@deffn {Clase} asyncio.Task (coro, *, loop=None, name=None, context=None, eager_start=False)

Un objeto @ref{c55,,similar a Future} que ejecuta Python @ref{31c4,,coroutine}. No es seguro hilos.

Las tareas se utilizan para ejecutar corrutinas en bucles de eventos. Si una corrutina aguarda en un Future, la Tarea suspende la ejecución de la corrutina y espera la finalización del Future. Cuando el Future `termina', se reanuda la ejecución de la corrutina envuelta.

Los bucles de eventos usan la programación cooperativa: un bucle de eventos ejecuta una tarea a la vez. Mientras una Tarea espera para la finalización de un Future, el bucle de eventos ejecuta otras tareas, retorno de llamada o realiza operaciones de E/S.

Utilice la función de alto nivel @ref{69d,,asyncio.create_task()} para crear Tareas, o las funciones de bajo nivel @ref{a6e,,loop.create_task()} o @ref{cfe,,ensure_future()}. Se desaconseja la creación de instancias manuales de Tareas.

Para cancelar una Tarea en ejecución, utilice el método @ref{31e,,cancel()}. Llamarlo hará que la tarea lance una excepción @ref{31f,,CancelledError} en la corrutina contenida. Si una corrutina está esperando en un objeto Future durante la cancelación, se cancelará el objeto Future.

@ref{31f6,,cancelled()} se puede utilizar para comprobar si la Tarea fue cancelada. El método retorna @code{True} si la corrutina contenida no suprimió la excepción @ref{31f,,CancelledError} y se canceló realmente.

@ref{580,,asyncio.Task} hereda de @ref{c55,,Future} todas sus API excepto @ref{31f7,,Future.set_result()} y @ref{31f8,,Future.set_exception()}.

Un argumento `context' opcional de solo palabra clave permite especificar un @ref{15a0,,contextvars.Context} personalizado para que se ejecute `coro'. Si no se proporciona ningún `context', la tarea copia el contexto actual y luego ejecuta su rutina en el contexto copiado.

Un argumento `eager_start' opcional de solo palabra clave permite iniciar con entusiasmo la ejecución de @ref{580,,asyncio.Task} en el momento de la creación de la tarea. Si se establece en @code{True} y el bucle de eventos se está ejecutando, la tarea comenzará a ejecutar la corrutina inmediatamente, hasta la primera vez que la corrutina se bloquee. Si la rutina regresa o se activa sin bloquearse, la tarea finalizará con entusiasmo y saltará la programación al bucle de eventos.


Distinto en la versión 3.7: Agregado soporte para el módulo @ref{25,,contextvars}.



Distinto en la versión 3.8: Se ha añadido el parámetro `name'.



Obsoleto desde la versión 3.10: Se emite una advertencia de obsolescencia si no se especifica `loop' y no hay un bucle de eventos en ejecución.



Distinto en la versión 3.11: Se ha añadido el parámetro `context'.



Distinto en la versión 3.12: Se ha añadido el parámetro `eager_start'.


@geindex done() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task done}@anchor{31f9}
@deffn {Método} done ()

Retorna @code{True} si la Tarea está `finalizada'.

Una tarea está `finalizada' cuando la corrutina contenida retornó un valor, lanzó una excepción, o se canceló la Tarea.
@end deffn

@geindex result() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task result}@anchor{31fa}
@deffn {Método} result ()

Retorna el resultado de la Tarea.

Si la tarea está `terminada', se retorna el resultado de la corrutina contenida (o si la corrutina lanzó una excepción, esa excepción se vuelve a relanzar.)

Si la Tarea ha sido `cancelada', este método lanza una excepción @ref{31f,,CancelledError}.

If the Task’s result isn’t yet available, this method raises
an @ref{31fb,,InvalidStateError} exception.
@end deffn

@geindex exception() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task exception}@anchor{31fc}
@deffn {Método} exception ()

Retorna la excepción de la Tarea.

Si la corrutina contenida lanzó una excepción, esa excepción es retornada. Si la corrutina contenida retorna normalmente, este método retorna @code{None}.

Si la Tarea ha sido `cancelada', este método lanza una excepción @ref{31f,,CancelledError}.

Si la Tarea aún no está `terminada', este método lanza una excepción @ref{31fb,,InvalidStateError}.
@end deffn

@geindex add_done_callback() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task add_done_callback}@anchor{31fd}
@deffn {Método} add_done_callback (callback, *, context=None)

Agrega una retro llamada que se ejecutará cuando la Tarea esté `terminada'.

Este método solo se debe usar en código basado en retrollamada de bajo nivel.

Consulte la documentación de @ref{b93,,Future.add_done_callback()} para obtener más detalles.
@end deffn

@geindex remove_done_callback() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task remove_done_callback}@anchor{31fe}
@deffn {Método} remove_done_callback (callback)

Remueve la `retrollamada' de la lista de retrollamadas.

Este método solo se debe usar en código basado en retrollamada de bajo nivel.

Consulte la documentación de @ref{15a6,,Future.remove_done_callback()} para obtener más detalles.
@end deffn

@geindex get_stack() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_stack}@anchor{31ff}
@deffn {Método} get_stack (*, limit=None)

Retorna la lista de marcos de pila para esta tarea.

Si la corrutina contenida no se termina, esto retorna la pila donde se suspende. Si la corrutina se ha completado correctamente o se ha cancelado, retorna una lista vacía. Si la corrutina terminó por una excepción, esto retorna la lista de marcos de seguimiento.

Los marcos siempre se ordenan de más antiguo a más nuevo.

Solo se retorna un marco de pila para una corrutina suspendida.

El argumento opcional `limit' establece el número máximo de marcos que se retornarán; de forma predeterminada se retornan todos los marcos disponibles. El orden de la lista retornada varía en función de si se retorna una pila o un `traceback': se retornan los marcos más recientes de una pila, pero se retornan los marcos más antiguos de un `traceback'. (Esto coincide con el comportamiento del módulo traceback.)ss
@end deffn

@geindex print_stack() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task print_stack}@anchor{1767}
@deffn {Método} print_stack (*, limit=None, file=None)

Imprime la pila o el seguimiento de esta tarea.

Esto produce una salida similar a la del módulo traceback para los marcos recuperados por @ref{31ff,,get_stack()}.

El argumento `limit' se pasa directamente a @ref{31ff,,get_stack()}.

El argumento `file' es un flujo de E/S en el que se escribe la salida; por defecto, la salida se escribe en @ref{b61,,sys.stdout}.
@end deffn

@geindex get_coro() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_coro}@anchor{a6d}
@deffn {Método} get_coro ()

Retorna el objeto corrutina contenido por @ref{580,,Task}.

@cartouche
@quotation Nota 
Esto devolverá @code{None} para las tareas que ya se han completado con entusiasmo. Consulte el @ref{31e5,,Eager Task Factory}.
@end quotation
@end cartouche


Added in version 3.8.



Distinto en la versión 3.12: La ejecución ansiosa de la tarea recientemente agregada significa que el resultado puede ser @code{None}.

@end deffn

@geindex get_context() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_context}@anchor{3200}
@deffn {Método} get_context ()

Devuelve el objeto @ref{15a0,,contextvars.Context} asociado con la tarea.


Added in version 3.12.

@end deffn

@geindex get_name() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_name}@anchor{a70}
@deffn {Método} get_name ()

Retorna el nombre de la Tarea.

Si no se ha asignado explícitamente ningún nombre a la Tarea, la implementación de Tarea asyncio predeterminada genera un nombre predeterminado durante la creación de instancias.


Added in version 3.8.

@end deffn

@geindex set_name() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task set_name}@anchor{a6f}
@deffn {Método} set_name (value)

Establece el nombre de la Tarea.

El argumento `value' puede ser cualquier objeto, que luego se convierte en una cadena.

En la implementación de Task predeterminada, el nombre será visible en la salida @ref{894,,repr()} de un objeto de tarea.


Added in version 3.8.

@end deffn

@geindex cancel() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancel}@anchor{31e}
@deffn {Método} cancel (msg=None)

Solicita que se cancele la Tarea.

Esto hace que una excepción @ref{31f,,CancelledError} sea lanzada a la corrutina contenida en el próximo ciclo del bucle de eventos.

Luego, la corrutina tiene la oportunidad de limpiar o incluso denegar la solicitud suprimiendo la excepción con un bloque @ref{789,,try}… … @code{except CancelledError}… @ref{a5c,,finally}. Por lo tanto, a diferencia de @ref{1821,,Future.cancel()}, @ref{31e,,Task.cancel()} no garantiza que la tarea se cancelará, aunque suprimir la cancelación por completo no es común y se desaconseja activamente. Sin embargo, si la rutina decide suprimir la cancelación, debe llamar a @ref{321,,Task.uncancel()} además de detectar la excepción.


Distinto en la versión 3.9: Se agregó el parámetro `msg'.



Distinto en la versión 3.11: El parámetro @code{msg} se propaga desde la tarea cancelada a su espera.

@anchor{library/asyncio-task asyncio-example-task-cancel}@anchor{3201}
En el ejemplo siguiente se muestra cómo las corrutinas pueden interceptar la solicitud de cancelación:

@example
async def cancel_me():
    print('cancel_me(): before sleep')

    try:
        # Wait for 1 hour
        await asyncio.sleep(3600)
    except asyncio.CancelledError:
        print('cancel_me(): cancel sleep')
        raise
    finally:
        print('cancel_me(): after sleep')

async def main():
    # Create a "cancel_me" Task
    task = asyncio.create_task(cancel_me())

    # Wait for 1 second
    await asyncio.sleep(1)

    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("main(): cancel_me is cancelled now")

asyncio.run(main())

# Expected output:
#
#     cancel_me(): before sleep
#     cancel_me(): cancel sleep
#     cancel_me(): after sleep
#     main(): cancel_me is cancelled now
@end example
@end deffn

@geindex cancelled() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancelled}@anchor{31f6}
@deffn {Método} cancelled ()

Retorna @code{True} si la Tarea se `cancela'.

La tarea se `cancela' cuando se solicitó la cancelación con @ref{31e,,cancel()} y la corrutina contenida propagó la excepción @ref{31f,,CancelledError} que se le ha lanzado.
@end deffn

@geindex uncancel() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task uncancel}@anchor{321}
@deffn {Método} uncancel ()

Disminuye el recuento de solicitudes de cancelación a esta tarea.

Retorna el número restante de solicitudes de cancelación.

Tenga en cuenta que una vez que se completa la ejecución de una tarea cancelada, las llamadas posteriores a @ref{321,,uncancel()} no son efectivas.


Added in version 3.11.


Este método lo usan los componentes internos de asyncio y no se espera que lo use el código del usuario final. En particular, si una Tarea se cancela con éxito, esto permite que elementos de concurrencia estructurada como @ref{31df,,Grupos de tareas} y @ref{69f,,asyncio.timeout()} continúen ejecutándose, aislando la cancelación al bloque estructurado respectivo. Por ejemplo:

@example
async def make_request_with_timeout():
    try:
        async with asyncio.timeout(1):
            # Structured block affected by the timeout:
            await make_request()
            await make_another_request()
    except TimeoutError:
        log("There was a timeout")
    # Outer code not affected by the timeout:
    await unrelated_code()
@end example

Si bien el bloque con @code{make_request()} y @code{make_another_request()} podría cancelarse debido al tiempo de espera, @code{unrelated_code()} debería continuar ejecutándose incluso en caso de que se agote el tiempo de espera. Esto se implementa con @ref{321,,uncancel()}. Los administradores de contexto @ref{31c,,TaskGroup} usan @ref{321,,uncancel()} de manera similar.

If end-user code is, for some reason, suppressing cancellation by
catching @ref{31f,,CancelledError}, it needs to call this method to remove
the cancellation state.

When this method decrements the cancellation count to zero,
the method checks if a previous @ref{31e,,cancel()} call had arranged
for @ref{31f,,CancelledError} to be thrown into the task.
If it hasn’t been thrown yet, that arrangement will be
rescinded (by resetting the internal @code{_must_cancel} flag).
@end deffn


Distinto en la versión 3.13: Changed to rescind pending cancellation requests upon reaching zero.


@geindex cancelling() (método de asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancelling}@anchor{320}
@deffn {Método} cancelling ()

Retorna el número de solicitudes de cancelación pendientes a esta Tarea, es decir, el número de llamadas a @ref{31e,,cancel()} menos el número de llamadas a @ref{321,,uncancel()}.

Tenga en cuenta que si este número es mayor que cero pero la tarea aún se está ejecutando, @ref{31f6,,cancelled()} aún retornará @code{False}. Esto se debe a que este número se puede reducir llamando a @ref{321,,uncancel()}, lo que puede provocar que la tarea no se cancele después de todo si las solicitudes de cancelación se reducen a cero.

Este método lo utilizan las partes internas de asyncio y no se espera que lo utilice el código del usuario final. Consulte @ref{321,,uncancel()} para obtener más detalles.


Added in version 3.11.

@end deffn
@end deffn

@node Streams,Primitivas de sincronización,Corrutinas y tareas,asyncio — Asynchronous I/O
@anchor{library/asyncio-stream doc}@anchor{3202}@anchor{library/asyncio-stream asyncio-streams}@anchor{31c5}@anchor{library/asyncio-stream streams}@anchor{3203}
@subsubsection Streams


`Código fuente:' Lib/asyncio/streams.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/streams.py}


__________________________________________________________________


Los `streams' son async/await primitivos de alto nivel para trabajar con conexiones de red. Los `streams' permiten enviar y recibir datos sin utilizar `callbacks' o protocolos y transportes de bajo nivel.
@anchor{library/asyncio-stream asyncio-example-stream}@anchor{3204}
Aquí hay un ejemplo de un cliente eco TCP escrito utilizando `streams' asyncio:

@example
import asyncio

async def tcp_echo_client(message):
    reader, writer = await asyncio.open_connection(
        '127.0.0.1', 8888)

    print(f'Send: @{message!r@}')
    writer.write(message.encode())
    await writer.drain()

    data = await reader.read(100)
    print(f'Received: @{data.decode()!r@}')

    print('Close the connection')
    writer.close()
    await writer.wait_closed()

asyncio.run(tcp_echo_client('Hello World!'))
@end example

Consulte también la sección de @ref{3205,,Examples} a continuación.

@subsubheading Funciones `stream'


Las siguientes funciones asyncio de nivel superior se pueden utilizar para crear y trabajar con `streams':

@geindex open_connection() (en el módulo asyncio)
@anchor{library/asyncio-stream asyncio open_connection}@anchor{ba3}
@deffn {Función} coroutine asyncio.open_connection (host=None, port=None, *, limit=None, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, happy_eyeballs_delay=None, interleave=None)

Establece una conexión de red y retorna un par de objetos @code{(reader, writer)}.

Los objetos `reader' y `writer' retornados son instancias de las clases @ref{18ce,,StreamReader} y @ref{1705,,StreamWriter}.

`limit' determina el límite de tamaño del búfer utilizado por la instancia de @ref{18ce,,StreamReader} retornada. De forma predeterminada, `limit' está establecido en 64 KiB.

El resto de los argumentos se pasan directamente a @ref{6a4,,loop.create_connection()}.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al @ref{1705,,StreamWriter} creado. Para cerrar el socket, llame a su método @ref{3206,,close()}.
@end quotation
@end cartouche


Distinto en la versión 3.7: Se agregó el parámetro `ssl_handshake_timeout'.



Distinto en la versión 3.8: Added the `happy_eyeballs_delay' and `interleave' parameters.



Distinto en la versión 3.10: Se eliminó el parámetro `loop'.



Distinto en la versión 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex start_server() (en el módulo asyncio)
@anchor{library/asyncio-stream asyncio start_server}@anchor{ba4}
@deffn {Función} coroutine asyncio.start_server (client_connected_cb, host=None, port=None, *, limit=None, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

Inicia un servidor socket.

La retrollamada `client_connected_cb' se llama siempre que se establece una nueva conexión de cliente. Recibe un par @code{(reader, writer)} como dos argumentos, instancias de las clases @ref{18ce,,StreamReader} y @ref{1705,,StreamWriter}.

`client_connected_cb' puede ser una función simple invocable o de @ref{31c4,,corrutina}; si es una función de corrutina, se programará automáticamente como un @ref{580,,Task}.

`limit' determina el límite de tamaño del búfer utilizado por la instancia de @ref{18ce,,StreamReader} retornada. De forma predeterminada, `limit' está establecido en 64 KiB.

El resto de los argumentos se pasan directamente a @ref{b9e,,loop.create_server()}.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al servidor creado. Para cerrar el socket, llame al método @ref{3207,,close()} del servidor.
@end quotation
@end cartouche


Distinto en la versión 3.7: Se agregaron los parámetros `ssl_handshake_timeout' y `start_serving'.



Distinto en la versión 3.10: Se eliminó el parámetro `loop'.



Distinto en la versión 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@subsubheading Sockets Unix


@geindex open_unix_connection() (en el módulo asyncio)
@anchor{library/asyncio-stream asyncio open_unix_connection}@anchor{3208}
@deffn {Función} coroutine asyncio.open_unix_connection (path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Establece una conexión de socket Unix y retorna un par de @code{(reader, writer)}.

Similar a @ref{ba3,,open_connection()} pero opera en sockets Unix.

Consulte también la documentación de @ref{3209,,loop.create_unix_connection()}.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al @ref{1705,,StreamWriter} creado. Para cerrar el socket, llame a su método @ref{3206,,close()}.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.7: Se agregó el parámetro `ssl_handshake_timeout'. El parámetro `path' ahora puede ser un @ref{3f0,,path-like object}



Distinto en la versión 3.10: Se eliminó el parámetro `loop'.



Distinto en la versión 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex start_unix_server() (en el módulo asyncio)
@anchor{library/asyncio-stream asyncio start_unix_server}@anchor{320a}
@deffn {Función} coroutine asyncio.start_unix_server (client_connected_cb, path=None, *, limit=None, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

Inicia un servidor socket Unix.

Similar a @ref{ba4,,start_server()} pero funciona con sockets Unix.

Consulte también la documentación de @ref{315,,loop.create_unix_server()}.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al servidor creado. Para cerrar el socket, llame al método @ref{3207,,close()} del servidor.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.7: Se agregaron los parámetros `ssl_handshake_timeout' y `start_serving'. El parámetro `path' ahora puede ser un @ref{3f0,,path-like object}.



Distinto en la versión 3.10: Se eliminó el parámetro `loop'.



Distinto en la versión 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@menu
* StreamReader:: 
* StreamWriter:: 
* Ejemplos: Ejemplos<14>. 

@end menu

@node StreamReader,StreamWriter,,Streams
@anchor{library/asyncio-stream streamreader}@anchor{320b}
@subsubsection StreamReader


@geindex StreamReader (clase en asyncio)
@anchor{library/asyncio-stream asyncio StreamReader}@anchor{18ce}
@deffn {Clase} asyncio.StreamReader

Represents a reader object that provides APIs to read data
from the IO stream. As an @ref{dfd,,asynchronous iterable}, the
object supports the @ref{b36,,async for} statement.

No se recomienda crear instancias de objetos `StreamReader' directamente; utilice @ref{ba3,,open_connection()} y @ref{ba4,,start_server()} en su lugar.

@geindex feed_eof() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader feed_eof}@anchor{320c}
@deffn {Método} feed_eof ()

Acknowledge the EOF.
@end deffn

@geindex read() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader read}@anchor{320d}
@deffn {Método} coroutine read (n=-1)

Read up to `n' bytes from the stream.

If `n' is not provided or set to @code{-1},
read until EOF, then return all read @ref{325,,bytes}.
If EOF was received and the internal buffer is empty,
return an empty @code{bytes} object.

If `n' is @code{0}, return an empty @code{bytes} object immediately.

If `n' is positive, return at most `n' available @code{bytes}
as soon as at least 1 byte is available in the internal buffer.
If EOF is received before any byte is read, return an empty
@code{bytes} object.
@end deffn

@geindex readline() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readline}@anchor{320e}
@deffn {Método} coroutine readline ()

Lea una línea, donde «línea» es una secuencia de bytes que termina en @code{\n}.

Si se recibe EOF (final del archivo) y no se encontró @code{\n}, el método retorna datos leídos parcialmente.

Si se recibe EOF (final de archivo) y el búfer interno está vacío, retorna un objeto @code{bytes} vacío.
@end deffn

@geindex readexactly() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readexactly}@anchor{d03}
@deffn {Método} coroutine readexactly (n)

Lee exactamente `n' bytes.

Genera un @ref{1929,,IncompleteReadError} si se alcanza EOF (final del archivo) antes de que se pueda leer `n'. Utilice el atributo @ref{320f,,IncompleteReadError.partial} para obtener los datos leídos parcialmente.
@end deffn

@geindex readuntil() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readuntil}@anchor{31b}
@deffn {Método} coroutine readuntil (separator=b'\n')

Lee datos de la secuencia hasta que se encuentre el separador (`separator').

En caso de éxito, los datos y el separador se eliminarán del búfer interno (consumido). Los datos retornados incluirán el separador al final.

Si la cantidad de datos leídos excede el límite de flujo configurado, se genera una excepción @ref{3210,,LimitOverrunError} y los datos se dejan en el búfer interno y se pueden leer nuevamente.

Si se alcanza EOF (final del archivo) antes de que se encuentre el separador completo, se genera una excepción @ref{1929,,IncompleteReadError} y se restablece el búfer interno. El atributo @ref{320f,,IncompleteReadError.partial} puede contener una parte del separador.

The `separator' may also be a tuple of separators. In this
case the return value will be the shortest possible that has any
separator as the suffix. For the purposes of @ref{3210,,LimitOverrunError},
the shortest possible separator is considered to be the one that
matched.


Added in version 3.5.2.



Distinto en la versión 3.13: The `separator' parameter may now be a @ref{464,,tuple} of
separators.

@end deffn

@geindex at_eof() (método de asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader at_eof}@anchor{3211}
@deffn {Método} at_eof ()

Retorna @code{True} si el buffer está vacío y @ref{320c,,feed_eof()} fue llamado.
@end deffn
@end deffn

@node StreamWriter,Ejemplos<14>,StreamReader,Streams
@anchor{library/asyncio-stream streamwriter}@anchor{3212}
@subsubsection StreamWriter


@geindex StreamWriter (clase en asyncio)
@anchor{library/asyncio-stream asyncio StreamWriter}@anchor{1705}
@deffn {Clase} asyncio.StreamWriter

Representa un objeto de escritura que proporciona APIs para escribir datos en el flujo de E/S.

No se recomienda crear instancias de objetos `StreamWriter' directamente; use @ref{ba3,,open_connection()} y @ref{ba4,,start_server()} en su lugar.

@geindex write() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter write}@anchor{3213}
@deffn {Método} write (data)

El método intenta escribir los datos (`data') en el socket subyacente inmediatamente. Si eso falla, los datos se ponen en cola en un búfer de escritura interno hasta que se puedan enviar.

El método debe usarse junto con el método @code{drain()}:

@example
stream.write(data)
await stream.drain()
@end example
@end deffn

@geindex writelines() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter writelines}@anchor{3214}
@deffn {Método} writelines (data)

El método escribe una lista (o cualquier iterable) de bytes en el socket subyacente inmediatamente. Si eso falla, los datos se ponen en cola en un búfer de escritura interno hasta que se puedan enviar.

El método debe usarse junto con el método @code{drain()}:

@example
stream.writelines(lines)
await stream.drain()
@end example
@end deffn

@geindex close() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter close}@anchor{3206}
@deffn {Método} close ()

El método cierra la secuencia y el socket subyacente.

The method should be used, though not mandatory,
along with the @code{wait_closed()} method:

@example
stream.close()
await stream.wait_closed()
@end example
@end deffn

@geindex can_write_eof() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter can_write_eof}@anchor{3215}
@deffn {Método} can_write_eof ()

Retorna @code{True} si el transporte subyacente admite el método @ref{3216,,write_eof()}, @code{False} en caso contrario.
@end deffn

@geindex write_eof() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter write_eof}@anchor{3216}
@deffn {Método} write_eof ()

Cierra la escritura de la secuencia después de que se vacíen los datos de escritura almacenados en búfer.
@end deffn

@geindex transport (atributo de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter transport}@anchor{3217}
@deffn {Atributo} transport

Retorna el transporte asyncio subyacente.
@end deffn

@geindex get_extra_info() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter get_extra_info}@anchor{3218}
@deffn {Método} get_extra_info (name, default=None)

Accede a información de transporte opcional; consulte @ref{b27,,BaseTransport.get_extra_info()} para obtener más detalles.
@end deffn

@geindex drain() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter drain}@anchor{17b6}
@deffn {Método} coroutine drain ()

Espera hasta que sea apropiado reanudar la escritura en la transmisión. Ejemplo:

@example
writer.write(data)
await writer.drain()
@end example

Este es un método de control de flujo que interactúa con el búfer de escritura de E/S subyacente. Cuando el tamaño del búfer alcanza la marca de agua alta, `drain()' bloquea hasta que el tamaño del búfer se agota hasta la marca de agua baja y se pueda reanudar la escritura. Cuando no hay nada que esperar, @ref{17b6,,drain()} regresa inmediatamente.
@end deffn

@geindex start_tls() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter start_tls}@anchor{6a5}
@deffn {Método} coroutine start_tls (sslcontext, *, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Actualiza una conexión existente basada en flujo a TLS.

Parámetros:


@itemize *

@item 
`sslcontext': una instancia configurada de @ref{1fa,,SSLContext}.

@item 
`server_hostname': establece o sustituye el nombre de host con el que se comparará el certificado del servidor de destino.

@item 
`ssl_handshake_timeout' es el tiempo en segundos que se espera a que se complete el protocolo TLS antes de abortar la conexión.  @code{60.0} segundos si @code{None} (por defecto).

@item 
`ssl_shutdown_timeout' is the time in seconds to wait for the SSL shutdown
to complete before aborting the connection. @code{30.0} seconds if @code{None}
(default).
@end itemize


Added in version 3.11.



Distinto en la versión 3.12: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex is_closing() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter is_closing}@anchor{b98}
@deffn {Método} is_closing ()

Retorna @code{True} si la secuencia está cerrada o en proceso de cerrarse.


Added in version 3.7.

@end deffn

@geindex wait_closed() (método de asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter wait_closed}@anchor{b97}
@deffn {Método} coroutine wait_closed ()

Espera hasta que se cierre la secuencia.

Should be called after @ref{3206,,close()} to wait until the underlying
connection is closed, ensuring that all data has been flushed
before e.g. exiting the program.


Added in version 3.7.

@end deffn
@end deffn

@node Ejemplos<14>,,StreamWriter,Streams
@anchor{library/asyncio-stream examples}@anchor{3205}
@subsubsection Ejemplos


@menu
* Cliente eco TCP usando streams:: 
* Servidor eco TCP usando streams:: 
* Obtener encabezados HTTP:: 
* Registrar un socket abierto para esperar datos usando streams:: 

@end menu

@node Cliente eco TCP usando streams,Servidor eco TCP usando streams,,Ejemplos<14>
@anchor{library/asyncio-stream asyncio-tcp-echo-client-streams}@anchor{3219}@anchor{library/asyncio-stream tcp-echo-client-using-streams}@anchor{321a}
@subsubsection Cliente eco TCP usando `streams'


Cliente eco TCP usando la función @ref{ba3,,asyncio.open_connection()}:

@example
import asyncio

async def tcp_echo_client(message):
    reader, writer = await asyncio.open_connection(
        '127.0.0.1', 8888)

    print(f'Send: @{message!r@}')
    writer.write(message.encode())
    await writer.drain()

    data = await reader.read(100)
    print(f'Received: @{data.decode()!r@}')

    print('Close the connection')
    writer.close()
    await writer.wait_closed()

asyncio.run(tcp_echo_client('Hello World!'))
@end example


@subsubheading Ver también


El ejemplo del @ref{321b,,protocolo de cliente eco TCP} utiliza el método @ref{6a4,,loop.create_connection()} de bajo nivel.


@node Servidor eco TCP usando streams,Obtener encabezados HTTP,Cliente eco TCP usando streams,Ejemplos<14>
@anchor{library/asyncio-stream asyncio-tcp-echo-server-streams}@anchor{321c}@anchor{library/asyncio-stream tcp-echo-server-using-streams}@anchor{321d}
@subsubsection Servidor eco TCP usando `streams'


Servidor eco TCP usando la función @ref{ba4,,asyncio.start_server()}:

@example
import asyncio

async def handle_echo(reader, writer):
    data = await reader.read(100)
    message = data.decode()
    addr = writer.get_extra_info('peername')

    print(f"Received @{message!r@} from @{addr!r@}")

    print(f"Send: @{message!r@}")
    writer.write(data)
    await writer.drain()

    print("Close the connection")
    writer.close()
    await writer.wait_closed()

async def main():
    server = await asyncio.start_server(
        handle_echo, '127.0.0.1', 8888)

    addrs = ', '.join(str(sock.getsockname()) for sock in server.sockets)
    print(f'Serving on @{addrs@}')

    async with server:
        await server.serve_forever()

asyncio.run(main())
@end example


@subsubheading Ver también


El ejemplo del @ref{321e,,protocolo de servidor eco TCP} utiliza el método @ref{b9e,,loop.create_server()}.


@node Obtener encabezados HTTP,Registrar un socket abierto para esperar datos usando streams,Servidor eco TCP usando streams,Ejemplos<14>
@anchor{library/asyncio-stream get-http-headers}@anchor{321f}
@subsubsection Obtener encabezados HTTP


Ejemplo simple de consulta de encabezados HTTP de la URL pasada en la línea de comando:

@example
import asyncio
import urllib.parse
import sys

async def print_http_headers(url):
    url = urllib.parse.urlsplit(url)
    if url.scheme == 'https':
        reader, writer = await asyncio.open_connection(
            url.hostname, 443, ssl=True)
    else:
        reader, writer = await asyncio.open_connection(
            url.hostname, 80)

    query = (
        f"HEAD @{url.path or '/'@} HTTP/1.0\r\n"
        f"Host: @{url.hostname@}\r\n"
        f"\r\n"
    )

    writer.write(query.encode('latin-1'))
    while True:
        line = await reader.readline()
        if not line:
            break

        line = line.decode('latin1').rstrip()
        if line:
            print(f'HTTP header> @{line@}')

    # Ignore the body, close the socket
    writer.close()
    await writer.wait_closed()

url = sys.argv[1]
asyncio.run(print_http_headers(url))
@end example

Uso:

@example
python example.py http://example.com/path/page.html
@end example

o con HTTPS:

@example
python example.py https://example.com/path/page.html
@end example

@node Registrar un socket abierto para esperar datos usando streams,,Obtener encabezados HTTP,Ejemplos<14>
@anchor{library/asyncio-stream asyncio-example-create-connection-streams}@anchor{3220}@anchor{library/asyncio-stream register-an-open-socket-to-wait-for-data-using-streams}@anchor{3221}
@subsubsection Registrar un socket abierto para esperar datos usando `streams'


Corutina esperando hasta que un socket reciba datos usando la función @ref{ba3,,open_connection()} function:

@example
import asyncio
import socket

async def wait_for_data():
    # Get a reference to the current event loop because
    # we want to access low-level APIs.
    loop = asyncio.get_running_loop()

    # Create a pair of connected sockets.
    rsock, wsock = socket.socketpair()

    # Register the open socket to wait for data.
    reader, writer = await asyncio.open_connection(sock=rsock)

    # Simulate the reception of data from the network
    loop.call_soon(wsock.send, 'abc'.encode())

    # Wait for data
    data = await reader.read(100)

    # Got data, we are done: close the socket
    print("Received:", data.decode())
    writer.close()
    await writer.wait_closed()

    # Close the second socket
    wsock.close()

asyncio.run(wait_for_data())
@end example


@subsubheading Ver también


El ejemplo de @ref{3222,,registro de un socket abierto para esperar datos usando un protocolo} utiliza un protocolo de bajo nivel y el método @ref{6a4,,loop.create_connection()}.

El ejemplo de @ref{3223,,observar un descriptor de archivo para leer eventos} utiliza el método @ref{3224,,loop.add_reader()} de bajo nivel para ver un descriptor de archivo.


@node Primitivas de sincronización,Sub-procesos,Streams,asyncio — Asynchronous I/O
@anchor{library/asyncio-sync doc}@anchor{3225}@anchor{library/asyncio-sync asyncio-sync}@anchor{31c8}@anchor{library/asyncio-sync synchronization-primitives}@anchor{3226}
@subsubsection Primitivas de sincronización


`Código fuente:' Lib/asyncio/locks.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/locks.py}


__________________________________________________________________


las primitivas de sincronización de asyncio están diseñadas para ser similares a las del módulo @ref{ed,,threading}, con dos importantes advertencias:


@itemize *

@item 
las primitivas de asyncio no son seguras en hilos, por lo tanto, no deben ser usadas para la sincronización de hilos del sistema operativo (usa @ref{ed,,threading} para esto);

@item 
los métodos de estas primitivas de sincronización no aceptan el argumento `timeout'. Usa la función @ref{6a0,,asyncio.wait_for()} para realizar operaciones que involucren tiempos de espera.
@end itemize

asyncio tiene las siguientes primitivas de sincronización básicas:


@itemize *

@item 
@ref{b00,,Lock}

@item 
@ref{b01,,Event}

@item 
@ref{b02,,Condition}

@item 
@ref{b03,,Semaphore}

@item 
@ref{b04,,BoundedSemaphore}

@item 
@ref{6a2,,Barrier}
@end itemize


__________________________________________________________________


@menu
* Lock:: 
* Event:: 
* Condition:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrera:: 

@end menu

@node Lock,Event,,Primitivas de sincronización
@anchor{library/asyncio-sync lock}@anchor{3227}
@subsubsection Lock


@geindex Lock (clase en asyncio)
@anchor{library/asyncio-sync asyncio Lock}@anchor{b00}
@deffn {Clase} asyncio.Lock

Implementa un cierre de exclusión mutua para tareas asyncio. No es seguro en hilos.

Un cierre asyncio puede usarse para garantizar el acceso en exclusiva a un recurso compartido.

La forma preferida de usar un Lock es mediante una declaración @ref{676,,async with}:

@example
lock = asyncio.Lock()

# ... later
async with lock:
    # access shared state
@end example

lo que es equivalente a:

@example
lock = asyncio.Lock()

# ... later
await lock.acquire()
try:
    # access shared state
finally:
    lock.release()
@end example


Distinto en la versión 3.10: Eliminado el parámetro `loop'.


@geindex acquire() (método de asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock acquire}@anchor{3228}
@deffn {Método} coroutine acquire ()

Adquiere el cierre.

Este método espera hasta que el cierre está `abierto', lo establece como `cerrado' y retorna @code{True}.

Cuando más de una corrutina está bloqueada en @ref{3228,,acquire()}, esperando a que el cierre se abra, solo una de las corrutinas proseguirá finalmente.

Adquirir un cierre es `justo': la corrutina que prosigue será la primera corrutina que comenzó a esperarlo.
@end deffn

@geindex release() (método de asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock release}@anchor{3229}
@deffn {Método} release ()

Libera el cierre.

Cuando el cierre está `cerrado', lo restablece al estado `abierto' y retorna.

Si el cierre está `abierto', se lanza una excepción @ref{1e5,,RuntimeError}.
@end deffn

@geindex locked() (método de asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock locked}@anchor{322a}
@deffn {Método} locked ()

Retorna @code{True} si el cierre está `cerrado'.
@end deffn
@end deffn

@node Event,Condition,Lock,Primitivas de sincronización
@anchor{library/asyncio-sync event}@anchor{322b}
@subsubsection Event


@geindex Event (clase en asyncio)
@anchor{library/asyncio-sync asyncio Event}@anchor{b01}
@deffn {Clase} asyncio.Event

Un objeto de eventos. No es seguro en hilos.

Un evento asyncio puede usarse para notificar a múltiples tareas asyncio que ha ocurrido algún evento.

Un objeto Event administra una bandera interna que se puede establecer en `true' con el método @ref{322c,,set()} y se restablece en `false' con el método @ref{322d,,clear()}. El método @ref{322e,,wait()} se bloquea hasta que la bandera se establece en `true'. El flag se establece en `false' inicialmente.


Distinto en la versión 3.10: Eliminado el parámetro `loop'.

@anchor{library/asyncio-sync asyncio-example-sync-event}@anchor{322f}
Ejemplo:

@example
async def waiter(event):
    print('waiting for it ...')
    await event.wait()
    print('... got it!')

async def main():
    # Create an Event object.
    event = asyncio.Event()

    # Spawn a Task to wait until 'event' is set.
    waiter_task = asyncio.create_task(waiter(event))

    # Sleep for 1 second and set the event.
    await asyncio.sleep(1)
    event.set()

    # Wait until the waiter task is finished.
    await waiter_task

asyncio.run(main())
@end example

@geindex wait() (método de asyncio.Event)
@anchor{library/asyncio-sync asyncio Event wait}@anchor{322e}
@deffn {Método} coroutine wait ()

Espera hasta que se establezca el evento.

Si el evento está configurado, retorna @code{True} inmediatamente. De lo contrario, bloquea hasta que otra tarea llame a @ref{322c,,set()}.
@end deffn

@geindex set() (método de asyncio.Event)
@anchor{library/asyncio-sync asyncio Event set}@anchor{322c}
@deffn {Método} set ()

Establece el evento.

Todas las tareas esperando a que el evento se establezca serán activadas inmediatamente.
@end deffn

@geindex clear() (método de asyncio.Event)
@anchor{library/asyncio-sync asyncio Event clear}@anchor{322d}
@deffn {Método} clear ()

Borra (restablece) el evento.

Las tareas que esperan en @ref{322e,,wait()} ahora se bloquearán hasta que se vuelva a llamar al método @ref{322c,,set()}.
@end deffn

@geindex is_set() (método de asyncio.Event)
@anchor{library/asyncio-sync asyncio Event is_set}@anchor{3230}
@deffn {Método} is_set ()

Retorna @code{True} si el evento está establecido.
@end deffn
@end deffn

@node Condition,Semaphore,Event,Primitivas de sincronización
@anchor{library/asyncio-sync condition}@anchor{3231}
@subsubsection Condition


@geindex Condition (clase en asyncio)
@anchor{library/asyncio-sync asyncio Condition}@anchor{b02}
@deffn {Clase} asyncio.Condition (lock=None)

Un objeto Condition. No seguro en hilos.

Una tarea puede usar una condición primitiva de asyncio para esperar a que suceda algún evento y luego obtener acceso exclusivo a un recurso compartido.

En esencia, un objeto Condition combina la funcionalidad de un objeto @ref{b01,,Event} y un objeto @ref{b00,,Lock}. Es posible tener múltiples objetos Condition que compartan un mismo Lock, lo que permite coordinar el acceso exclusivo a un recurso compartido entre diferentes tareas interesadas en estados particulares de ese recurso compartido.

El argumento opcional `lock' debe ser un objeto @ref{b00,,Lock} o @code{None}. En este último caso, se crea automáticamente un nuevo objeto Lock.


Distinto en la versión 3.10: Eliminado el parámetro `loop'.


La forma preferida de usar una condición es mediante una declaración @ref{676,,async with}:

@example
cond = asyncio.Condition()

# ... later
async with cond:
    await cond.wait()
@end example

lo que es equivalente a:

@example
cond = asyncio.Condition()

# ... later
await cond.acquire()
try:
    await cond.wait()
finally:
    cond.release()
@end example

@geindex acquire() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition acquire}@anchor{3232}
@deffn {Método} coroutine acquire ()

Adquiere el cierre (lock) subyacente.

Este método espera hasta que el cierre subyacente esté `abierto', lo establece en `cerrado' y retorna @code{True}.
@end deffn

@geindex notify() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition notify}@anchor{1685}
@deffn {Método} notify (n=1)

Wake up `n' tasks (1 by default) waiting on this
condition.  If fewer than `n' tasks are waiting they are all awakened.

El cierre debe adquirirse antes de llamar a este método y liberarse poco después. Si se llama con un cierre `abierto', se lanza una excepción @ref{1e5,,RuntimeError}.
@end deffn

@geindex locked() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition locked}@anchor{3233}
@deffn {Método} locked ()

Retorna @code{True} si el cierre subyacente está adquirido.
@end deffn

@geindex notify_all() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition notify_all}@anchor{3234}
@deffn {Método} notify_all ()

Despierta todas las tareas que esperan a esta condición.

Este método actúa como @ref{1685,,notify()}, pero despierta todas las tareas en espera.

El cierre debe adquirirse antes de llamar a este método y liberarse poco después. Si se llama con un cierre `abierto', se lanza una excepción @ref{1e5,,RuntimeError}.
@end deffn

@geindex release() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition release}@anchor{3235}
@deffn {Método} release ()

Libera el cierre subyacente.

Cuando se invoca en un cierre abierto, se lanza una excepción @ref{1e5,,RuntimeError}.
@end deffn

@geindex wait() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition wait}@anchor{16af}
@deffn {Método} coroutine wait ()

Espera hasta que se le notifique.

Si la tarea que llama no ha adquirido el cierre cuando se llama a este método, se lanza una excepción @ref{1e5,,RuntimeError}.

Este método libera el cierre subyacente y luego se bloquea hasta que lo despierte una llamada @ref{1685,,notify()} o @ref{3234,,notify_all()}. Una vez despertado, la condición vuelve a adquirir su cierre y este método retorna @code{True}.

Note that a task `may' return from this call spuriously,
which is why the caller should always re-check the state
and be prepared to @ref{528,,wait()} again. For this reason, you may
prefer to use @ref{6a0,,wait_for()} instead.
@end deffn

@geindex wait_for() (método de asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition wait_for}@anchor{3236}
@deffn {Método} coroutine wait_for (predicate)

Espera hasta que un predicado se vuelva `verdadero'.

The predicate must be a callable which result will be
interpreted as a boolean value.  The method will repeatedly
@ref{528,,wait()} until the predicate evaluates to `true'. The final value is the
return value.
@end deffn
@end deffn

@node Semaphore,BoundedSemaphore,Condition,Primitivas de sincronización
@anchor{library/asyncio-sync semaphore}@anchor{3237}
@subsubsection Semaphore


@geindex Semaphore (clase en asyncio)
@anchor{library/asyncio-sync asyncio Semaphore}@anchor{b03}
@deffn {Clase} asyncio.Semaphore (value=1)

Un objeto Semaphore. No es seguro en hilos.

Un semáforo gestiona un contador interno que se reduce en cada llamada al método @ref{16b0,,acquire()} y se incrementa en cada llamada al método @ref{3238,,release()}. El contador nunca puede bajar de cero, cuando @ref{16b0,,acquire()} encuentra que es cero, se bloquea, esperando hasta que alguna tarea llame a @ref{3238,,release()}.

El argumento opcional `value' proporciona el valor inicial para el contador interno (@code{1} por defecto). Si el valor dado es menor que @code{0} se lanza una excepción @ref{360,,ValueError}.


Distinto en la versión 3.10: Eliminado el parámetro `loop'.


La forma preferida de utilizar un semáforo es mediante una declaración @ref{676,,async with}:

@example
sem = asyncio.Semaphore(10)

# ... later
async with sem:
    # work with shared resource
@end example

lo que es equivalente a:

@example
sem = asyncio.Semaphore(10)

# ... later
await sem.acquire()
try:
    # work with shared resource
finally:
    sem.release()
@end example

@geindex acquire() (método de asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore acquire}@anchor{16b0}
@deffn {Método} coroutine acquire ()

Adquiere un semáforo.

Si el contador interno es mayor que cero, lo reduce en uno y retorna @code{True} inmediatamente. Si es cero, espera hasta que se llame al método @ref{3238,,release()} y retorna @code{True}.
@end deffn

@geindex locked() (método de asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore locked}@anchor{3239}
@deffn {Método} locked ()

Retorna @code{True} si el semáforo no se puede adquirir de inmediato.
@end deffn

@geindex release() (método de asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore release}@anchor{3238}
@deffn {Método} release ()

Libera un semáforo, incrementando el contador interno en uno. Puede despertar una tarea que esté a la espera para adquirir el semáforo.

A diferencia de @ref{b04,,BoundedSemaphore}, @ref{b03,,Semaphore} permite hacer más llamadas @code{release()} que llamadas @code{acquire()}.
@end deffn
@end deffn

@node BoundedSemaphore,Barrera,Semaphore,Primitivas de sincronización
@anchor{library/asyncio-sync boundedsemaphore}@anchor{323a}
@subsubsection BoundedSemaphore


@geindex BoundedSemaphore (clase en asyncio)
@anchor{library/asyncio-sync asyncio BoundedSemaphore}@anchor{b04}
@deffn {Clase} asyncio.BoundedSemaphore (value=1)

Un objeto semáforo delimitado. No es seguro en hilos.

BoundedSemaphore es una versión de la clase @ref{b03,,Semaphore} que lanza una excepción @ref{360,,ValueError} en @ref{3238,,release()} si aumenta el contador interno por encima del `valor' inicial.


Distinto en la versión 3.10: Eliminado el parámetro `loop'.

@end deffn

@node Barrera,,BoundedSemaphore,Primitivas de sincronización
@anchor{library/asyncio-sync barrier}@anchor{323b}
@subsubsection Barrera


@geindex Barrier (clase en asyncio)
@anchor{library/asyncio-sync asyncio Barrier}@anchor{6a2}
@deffn {Clase} asyncio.Barrier (parties)

Un objeto barrera. No es seguro en hilos.

Una barrera es una primitiva de sincronización simple que permite bloquear hasta que un número `parties' de tareas estén esperando en ella. Las tareas pueden esperar en el método @ref{323c,,wait()} y se bloquearán hasta que el número especificado de tareas termine esperando en @ref{323c,,wait()}. En ese momento, todas las tareas en espera se desbloquearán simultáneamente.

@ref{676,,async with} puede utilizarse como alternativa a esperar en @ref{323c,,wait()}.

La barrera puede reutilizarse tantas veces como se desee.
@anchor{library/asyncio-sync asyncio-example-barrier}@anchor{323d}
Ejemplo:

@example
async def example_barrier():
   # barrier with 3 parties
   b = asyncio.Barrier(3)

   # create 2 new waiting tasks
   asyncio.create_task(b.wait())
   asyncio.create_task(b.wait())

   await asyncio.sleep(0)
   print(b)

   # The third .wait() call passes the barrier
   await b.wait()
   print(b)
   print("barrier passed")

   await asyncio.sleep(0)
   print(b)

asyncio.run(example_barrier())
@end example

El resultado de este ejemplo es:

@example
<asyncio.locks.Barrier object at 0x... [filling, waiters:2/3]>
<asyncio.locks.Barrier object at 0x... [draining, waiters:0/3]>
barrier passed
<asyncio.locks.Barrier object at 0x... [filling, waiters:0/3]>
@end example


Added in version 3.11.


@geindex wait() (método de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier wait}@anchor{323c}
@deffn {Método} coroutine wait ()

Pasa la barrera. Cuando todas las tareas que forman parte de la barrera han llamado a esta función, todas se desbloquean simultáneamente.

Cuando se cancela una tarea en espera o bloqueada en la barrera, esta tarea sale de la barrera que permanece en el mismo estado. Si el estado de la barrera es «filling», el número de tareas en espera disminuye en 1.

El valor de retorno es un entero en el rango de 0 a @code{parties-1}, diferente para cada tarea. Esto se puede utilizar para seleccionar una tarea para hacer algún mantenimiento especial, por ejemplo:

@example
...
async with barrier as position:
   if position == 0:
      # Only one task prints this
      print('End of *draining phase*')
@end example

Este método puede lanzar una excepción @ref{6a3,,BrokenBarrierError} si la barrera se rompe o se restablece mientras una tarea está en espera. Podría lanzar una excepción @ref{31f,,CancelledError} si se cancela una tarea.
@end deffn

@geindex reset() (método de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier reset}@anchor{323e}
@deffn {Método} coroutine reset ()

Devuelve la barrera al estado vacío por defecto.  Cualquier tarea que espere en ella recibirá la excepción @ref{6a3,,BrokenBarrierError}.

Si se rompe una barrera, puede ser mejor dejarla y crear una nueva.
@end deffn

@geindex abort() (método de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier abort}@anchor{323f}
@deffn {Método} coroutine abort ()

Pone la barrera en estado roto.  Esto hace que cualquier llamada activa o futura a @ref{528,,wait()} falle con el @ref{6a3,,BrokenBarrierError}. Use esto por ejemplo si una de las tareas necesita abortar, para evitar tareas en espera infinita.
@end deffn

@geindex parties (atributo de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier parties}@anchor{3240}
@deffn {Atributo} parties

El número de tareas necesarias para pasar la barrera.
@end deffn

@geindex n_waiting (atributo de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier n_waiting}@anchor{3241}
@deffn {Atributo} n_waiting

El número de tareas que esperan actualmente en la barrera mientras se llena.
@end deffn

@geindex broken (atributo de asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier broken}@anchor{3242}
@deffn {Atributo} broken

Un booleano que es @code{True} si la barrera está en estado roto.
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/asyncio-sync asyncio BrokenBarrierError}@anchor{6a3}
@deffn {Excepción} asyncio.BrokenBarrierError

Esta excepción, una subclase de @ref{1e5,,RuntimeError}, se lanza cuando el objeto @ref{6a2,,Barrier} se reinicia o se rompe.
@end deffn


__________________________________________________________________



Distinto en la versión 3.9: Adquirir un bloqueo usando @code{await lock} o @code{yield from lock} o una declaración @ref{673,,with} (@code{with await lock}, @code{with (yield from lock)}) se eliminó . En su lugar, use @code{async with lock}.


@node Sub-procesos,Colas,Primitivas de sincronización,asyncio — Asynchronous I/O
@anchor{library/asyncio-subprocess doc}@anchor{3243}@anchor{library/asyncio-subprocess asyncio-subprocess}@anchor{31c6}@anchor{library/asyncio-subprocess subprocesses}@anchor{3244}
@subsubsection Sub-procesos


`Código fuente:' Lib/asyncio/subprocess.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/subprocess.py}, Lib/asyncio/base_subprocess.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/base_subprocess.py}


__________________________________________________________________


Esta sección describe APIs de alto nivel de `async/await' de asyncio para crear y gestionar sub-procesos.
@anchor{library/asyncio-subprocess asyncio-example-subprocess-shell}@anchor{3245}
Aquí podemos encontrar un ejemplo de cómo asyncio puede ejecutar un comando de `shell' y obtener su resultado:

@example
import asyncio

async def run(cmd):
    proc = await asyncio.create_subprocess_shell(
        cmd,
        stdout=asyncio.subprocess.PIPE,
        stderr=asyncio.subprocess.PIPE)

    stdout, stderr = await proc.communicate()

    print(f'[@{cmd!r@} exited with @{proc.returncode@}]')
    if stdout:
        print(f'[stdout]\n@{stdout.decode()@}')
    if stderr:
        print(f'[stderr]\n@{stderr.decode()@}')

asyncio.run(run('ls /zzz'))
@end example

mostrará en pantalla:

@example
['ls /zzz' exited with 1]
[stderr]
ls: /zzz: No such file or directory
@end example

Ya que todos las funciones de sub-procesos de asyncio son asíncronas y asyncio proporciona herramientas para trabajar con tales funciones, es fácil ejecutar y monitorear múltiples subprocesos en paralelo.  De hecho es trivial modificar los ejemplos de arriba para ejecutar varios comandos simultáneamente:

@example
async def main():
    await asyncio.gather(
        run('ls /zzz'),
        run('sleep 1; echo "hello"'))

asyncio.run(main())
@end example

Véase también la subsección @ref{3246,,Examples}.

@menu
* Creando sub-procesos:: 
* Constantes: Constantes<7>. 
* Interactuando con Subprocesos:: 

@end menu

@node Creando sub-procesos,Constantes<7>,,Sub-procesos
@anchor{library/asyncio-subprocess creating-subprocesses}@anchor{3247}
@subsubsection Creando sub-procesos


@geindex create_subprocess_exec() (en el módulo asyncio)
@anchor{library/asyncio-subprocess asyncio create_subprocess_exec}@anchor{b06}
@deffn {Función} coroutine asyncio.create_subprocess_exec (program, *args, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

Crea un sub-proceso.

El argumento `limit' establece el límite del buffer para los envoltorios @ref{18ce,,StreamReader} para @code{Process.stdout} y @code{Process.stderr} (si se pasa @ref{c0f,,subprocess.PIPE} a los argumentos `stdout' y `stderr').

Retorna una instancia de @ref{3248,,Process}.

Véase la documentación de @ref{3249,,loop.subprocess_exec()} para los otros parámetros.


Distinto en la versión 3.10: Se eliminó el parámetro `loop'.

@end deffn

@geindex create_subprocess_shell() (en el módulo asyncio)
@anchor{library/asyncio-subprocess asyncio create_subprocess_shell}@anchor{b07}
@deffn {Función} coroutine asyncio.create_subprocess_shell (cmd, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

Ejecuta el comando de shell `cmd'.

El argumento `limit' establece el límite del buffer para los envoltorios @ref{18ce,,StreamReader} para @code{Process.stdout} y @code{Process.stderr} (si se pasa @ref{c0f,,subprocess.PIPE} a los argumentos `stdout' y `stderr').

Retorna una instancia de @ref{3248,,Process}.

Véase la documentación de @ref{324a,,loop.subprocess_shell()} para los otros parámetros.

@cartouche
@quotation Importante 
Es la responsabilidad de la aplicación asegurarse que todos los espacios en blanco y caracteres especiales estén citados apropiadamente para evitar vulnerabilidades de inyección de instrucciones@footnote{https://es.wikipedia.org/wiki/Inyecci%C3%B3n_de_c%C3%B3digo#Inyecci%C3%B3n_de_instrucciones}. La función @ref{3d2,,shlex.quote()} puede ser usada para escapar caracteres en blanco y caracteres especiales de `shell' en cadenas de caracteres a ser usadas para construir comandos de `shell'.
@end quotation
@end cartouche


Distinto en la versión 3.10: Se eliminó el parámetro `loop'.

@end deffn

@cartouche
@quotation Nota 
Los subprocesos están disponibles para Windows si se utiliza un @ref{6aa,,ProactorEventLoop}. Consulte @ref{324b,,Soporte de subprocesos en Windows} para obtener más detalles.
@end quotation
@end cartouche


@subsubheading Ver también


asyncio también tiene las siguientes APIs de `bajo nivel' para trabajar con sub-procesos: @ref{3249,,loop.subprocess_exec()}, @ref{324a,,loop.subprocess_shell()}, @ref{324c,,loop.connect_read_pipe()}, @ref{324d,,loop.connect_write_pipe()}, así como también los @ref{324e,,Sub-procesos de Transportes} y los @ref{324f,,Sub-procesos de Protocolos}.


@node Constantes<7>,Interactuando con Subprocesos,Creando sub-procesos,Sub-procesos
@anchor{library/asyncio-subprocess constants}@anchor{3250}
@subsubsection Constantes


@geindex asyncio.subprocess.PIPE (variable incorporada)
@anchor{library/asyncio-subprocess asyncio subprocess PIPE}@anchor{3251}
@deffn {Dato} asyncio.subprocess.PIPE

Se le puede pasar a los parámetros `stding', `stdout' o `stderr'.

Si se le pasa `PIPE' al argumento `stdin', el atributo @ref{3252,,Process.stdin} apuntará a la instancia @code{StreamWriter}.

Si se pasa `PIPE' a los argumentos `stdout' o `stderr', los atributos @ref{3253,,Process.stdout} y @ref{3254,,Process.stderr} apuntarán a las instancias @code{StreamReader}.
@end deffn

@geindex asyncio.subprocess.STDOUT (variable incorporada)
@anchor{library/asyncio-subprocess asyncio subprocess STDOUT}@anchor{3255}
@deffn {Dato} asyncio.subprocess.STDOUT

Un valor especial que puede ser usado como el argumento de `stderr' e indica que los errores estándar deben ser redireccionados en la salida estándar.
@end deffn

@geindex asyncio.subprocess.DEVNULL (variable incorporada)
@anchor{library/asyncio-subprocess asyncio subprocess DEVNULL}@anchor{3256}
@deffn {Dato} asyncio.subprocess.DEVNULL

Un valor especial que puede ser usado como el argumento de `stdin', `stdout', `stderr' para procesar funciones de creación.  Indica que el archivo especial @ref{1a3a,,os.devnull} será usado para la correspondiente transmisión del sub-proceso.
@end deffn

@node Interactuando con Subprocesos,,Constantes<7>,Sub-procesos
@anchor{library/asyncio-subprocess interacting-with-subprocesses}@anchor{3257}
@subsubsection Interactuando con Subprocesos


Las dos funciones @ref{b06,,create_subprocess_exec()} y @ref{b07,,create_subprocess_shell()} retornan instancias de la clase `Process'. `Process' es un envoltorio de alto nivel que permite comunicarse con los subprocesos y estar atento a sus términos.

@geindex asyncio.subprocess.Process (clase incorporada)
@anchor{library/asyncio-subprocess asyncio subprocess Process}@anchor{3248}
@deffn {Clase} asyncio.subprocess.Process

Un objeto que envuelve procesos del SO creados por las funciones @code{create_subprocess_exec()} y @code{create_subprocess_shell()}.

Esta clase está diseñada para tener un API similar a la clase @ref{301,,subprocess.Popen}, pero hay algunas diferencias notables:


@itemize *

@item 
a diferencia de Popen, las instancias de Process no tiene un equivalente del método @ref{3168,,poll()};

@item 
los métodos @ref{1736,,communicate()} y @ref{3258,,wait()} no tienen un parámetro `timeout': use la función @ref{6a0,,wait_for()};

@item 
el método @ref{3258,,Process.wait()} es asíncrono, mientras que el método @ref{d6b,,subprocess.Popen.wait()} es implementado como un bucle de espera activa;

@item 
el parámetro `universal_newlines' no es compatible.
@end itemize

Esta clase no es segura para subprocesos (@ref{31f3,,not thread safe}).

Véase también la sección @ref{3259,,Subprocesos e Hilos}.

@geindex wait() (método de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process wait}@anchor{3258}
@deffn {Método} coroutine wait ()

Espera a que el proceso hijo termine.

Define y retorna el atributo @ref{325a,,returncode}.

@cartouche
@quotation Nota 
Este método puede bloquearse cuando usa @code{stdout=PIPE} o @code{stderr=PIPE} y el proceso hijo genera tanta salida que se bloquea esperando a que la tubería de búfer del SO acepte más datos. Use el método @ref{1736,,communicate()} cuando use tuberías para evitar esta condición.
@end quotation
@end cartouche
@end deffn

@geindex communicate() (método de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process communicate}@anchor{1736}
@deffn {Método} coroutine communicate (input=None)

Interactuar con el proceso:


@enumerate 

@item 
envía datos a `stdin' (si `input' no es @code{None});

@item 
cierra `stdin';

@item 
lee datos desde `stdout' y `stderr', hasta que el llegue al EOF;

@item 
espera a que el proceso termine.
@end enumerate

El argumento opcional `input' son los datos (objetos @ref{325,,bytes}) que serán enviados a los procesos hijos.

Retorna una tupla @code{(stdout_data, stderr_data)}.

Si se lanza la excepción @ref{10d8,,BrokenPipeError} o @ref{10db,,ConnectionResetError} cuando se escribe `input' en `stdin', la excepción es ignorada. Esta condición ocurre cuando el proceso finaliza antes de que todos los datos sean escritos en `stdin'.

Si se desea enviar datos al `stdin' del proceso, el proceso necesita ser creado con @code{stdin=PIPE}. De manera similar, para obtener cualquier cosa excepto @code{None} en la tupla del resultado, el proceso tiene que ser creado con los argumentos @code{stdout=PIPE} y/o @code{stderr=PIPE}.

Tenga en cuenta que los datos leídos son almacenados en memoria, por lo que no utilice este método si el tamaño de los datos es más grande o ilimitado.


Distinto en la versión 3.12: `stdin' se cierra cuando @cite{input=None} también.

@end deffn

@geindex send_signal() (método de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process send_signal}@anchor{15e4}
@deffn {Método} send_signal (signal)

Envíe la señal `signal' al proceso hijo.

@cartouche
@quotation Nota 
On Windows, @ref{141f,,SIGTERM} is an alias for @ref{325b,,terminate()}.
@code{CTRL_C_EVENT} and @code{CTRL_BREAK_EVENT} can be sent to processes
started with a `creationflags' parameter which includes
@code{CREATE_NEW_PROCESS_GROUP}.
@end quotation
@end cartouche
@end deffn

@geindex terminate() (método de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process terminate}@anchor{325b}
@deffn {Método} terminate ()

Para al proceso hijo.

On POSIX systems this method sends @ref{141f,,SIGTERM} to the
child process.

On Windows the Win32 API function @code{TerminateProcess()} is
called to stop the child process.
@end deffn

@geindex kill() (método de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process kill}@anchor{325c}
@deffn {Método} kill ()

Mata el proceso hijo.

En sistemas POSIX, este método envía @code{SIGKILL} al proceso hijo.

En Windows este método es un alias para @ref{325b,,terminate()}.
@end deffn

@geindex stdin (atributo de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stdin}@anchor{3252}
@deffn {Atributo} stdin

Flujo de entrada estándar (@code{StreamWriter}) o @code{None} si el proceso fue creado con @code{stdin=None}.
@end deffn

@geindex stdout (atributo de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stdout}@anchor{3253}
@deffn {Atributo} stdout

Flujo de salida estándar (@code{SreamReader}) o @code{None} si el proceso fue creado con @code{stdout=None}.
@end deffn

@geindex stderr (atributo de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stderr}@anchor{3254}
@deffn {Atributo} stderr

Flujo de salida estándar (@code{StreamReader}) o @code{None} si el proceso fue creado con @code{stderr=None}.
@end deffn

@cartouche
@quotation Advertencia 
Utilice el método @ref{1736,,communicate()} en vez de @ref{3252,,process.stdin.write()}, @ref{3253,,await process.stdout.read()} o @ref{3254,,await process.stderr.read}. Esto evita bloqueos debido a que los flujos pausan la lectura o escritura y bloqueando al proceso hijo.
@end quotation
@end cartouche

@geindex pid (atributo de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process pid}@anchor{325d}
@deffn {Atributo} pid

Número de identificación del Proceso (PID por sus siglas en inglés).

Tenga en cuenta que para procesos creados por la función @code{create­_subprocess_shell()}, este atributo es el PID del shell generado.
@end deffn

@geindex returncode (atributo de asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process returncode}@anchor{325a}
@deffn {Atributo} returncode

Código de retorno del proceso cuando finaliza.

Un valor @code{None} indica que el proceso todavía no ha finalizado.

Un valor negativo @code{-N} indica que el hijo ha finalizado por la señal @code{N} (sólo para POSIX).
@end deffn
@end deffn

@menu
* Subprocesos y Hilos:: 
* Ejemplos: Ejemplos<15>. 

@end menu

@node Subprocesos y Hilos,Ejemplos<15>,,Interactuando con Subprocesos
@anchor{library/asyncio-subprocess asyncio-subprocess-threads}@anchor{3259}@anchor{library/asyncio-subprocess subprocess-and-threads}@anchor{325e}
@subsubsection Subprocesos y Hilos


Por defecto el bucle de eventos de asyncio estándar permite correr subprocesos desde hilos diferentes.

En Windows, sólo @ref{6aa,,ProactorEventLoop} proporciona subprocesos (por defecto), @ref{6a9,,SelectorEventLoop} no es compatible con subprocesos.

Tenga en cuenta que implementaciones alternativas del bucle de eventos pueden tener limitaciones propias; por favor consulte su documentación.


@subsubheading Ver también


La sección @ref{31f3,,Concurrencia y multihilos en asyncio}.


@node Ejemplos<15>,,Subprocesos y Hilos,Interactuando con Subprocesos
@anchor{library/asyncio-subprocess examples}@anchor{3246}
@subsubsection Ejemplos


Un ejemplo usando la clase @ref{3248,,Process} para controlar un subproceso y la clase @ref{18ce,,StreamReader} para leer de su salida estándar.
@anchor{library/asyncio-subprocess asyncio-example-create-subprocess-exec}@anchor{325f}
El subproceso es creado por la función @ref{b06,,create_subprocess_exec()}:

@example
import asyncio
import sys

async def get_date():
    code = 'import datetime; print(datetime.datetime.now())'

    # Create the subprocess; redirect the standard output
    # into a pipe.
    proc = await asyncio.create_subprocess_exec(
        sys.executable, '-c', code,
        stdout=asyncio.subprocess.PIPE)

    # Read one line of output.
    data = await proc.stdout.readline()
    line = data.decode('ascii').rstrip()

    # Wait for the subprocess exit.
    await proc.wait()
    return line

date = asyncio.run(get_date())
print(f"Current date: @{date@}")
@end example

Véase también los @ref{3260,,ejemplos de prueba} escritos usando APIs de bajo nivel.

@node Colas,Excepciones<11>,Sub-procesos,asyncio — Asynchronous I/O
@anchor{library/asyncio-queue doc}@anchor{3261}@anchor{library/asyncio-queue asyncio-queues}@anchor{31c7}@anchor{library/asyncio-queue queues}@anchor{3262}
@subsubsection Colas


`Código fuente:' Lib/asyncio/queue.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/queue.py}


__________________________________________________________________


Las colas asyncio son diseñadas para ser similares a clases del módulo @ref{b6,,queue}.  Sin embargo las colas asyncio no son seguras para hilos, son diseñadas para usar específicamente en código async/await.

Nota que los métodos de colas de asyncio no tienen un parámetro `timeout'; usa la función @ref{6a0,,asyncio.wait_for()} para hacer operaciones de cola con un tiempo de espera.

Ver también la sección @ref{3263,,Examples} a continuación.

@menu
* Cola:: 
* Cola de prioridad:: 
* Cola UEPA (o LIFO en inglés): Cola UEPA o LIFO en inglés. 
* Excepciones: Excepciones<10>. 
* Ejemplos: Ejemplos<16>. 

@end menu

@node Cola,Cola de prioridad,,Colas
@anchor{library/asyncio-queue queue}@anchor{3264}
@subsubsection Cola


@geindex Queue (clase en asyncio)
@anchor{library/asyncio-queue asyncio Queue}@anchor{b05}
@deffn {Clase} asyncio.Queue (maxsize=0)

Una cola primero en entrar, primero en salir (PEPS, o `FIFO' en inglés).

Si `maxsize' es menor que o igual a cero, el tamaño de la cola es infinito.  Si es un entero mayor a @code{0}, entonces @code{await put()} se bloquea cuando una cola alcanza su `maxsize' hasta que un elemento es removido por @ref{3265,,get()}.

Diferente de los subprocesos de la biblioteca estándar @ref{b6,,queue}, el tamaño de la cola siempre es conocido y puede ser retornado llamando el método @ref{3266,,qsize()}.


Distinto en la versión 3.10: Excluido el parámetro `loop'.


Esta clase es @ref{31f3,,no segura para hilos}.

@geindex maxsize (atributo de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue maxsize}@anchor{3267}
@deffn {Atributo} maxsize

Número de ítems permitidos en la cola.
@end deffn

@geindex empty() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue empty}@anchor{3268}
@deffn {Método} empty ()

Retorna @code{True} si la cola es vacía, o @code{False} en caso contrario.
@end deffn

@geindex full() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue full}@anchor{3269}
@deffn {Método} full ()

Retorna @code{True} si hay @ref{3267,,maxsize} ítems en la cola.

If the queue was initialized with @code{maxsize=0} (the default),
then @ref{3269,,full()} never returns @code{True}.
@end deffn

@geindex get() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue get}@anchor{3265}
@deffn {Método} coroutine get ()

Remueve y retorna un ítem de la cola. Si la cola es vacía, espera hasta que un ítem esté disponible.

Raises @ref{318,,QueueShutDown} if the queue has been shut down and
is empty, or if the queue has been shut down immediately.
@end deffn

@geindex get_nowait() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue get_nowait}@anchor{326a}
@deffn {Método} get_nowait ()

Retorna un ítem si uno está inmediatamente disponible, de otra manera levanta @ref{326b,,QueueEmpty}.
@end deffn

@geindex join() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue join}@anchor{e4d}
@deffn {Método} coroutine join ()

Se bloquea hasta que todos los ítems en la cola han sido recibidos y procesados.

El conteo de tareas no terminadas sube siempre que un ítem es agregado a la cola. El conteo baja siempre que la ejecución de una corrutina @ref{e4e,,task_done()} para indicar que el ítem fue recuperado y todo el trabajo en él está completo.  Cuando el conteo de tareas inacabadas llega a cero, @ref{e4d,,join()} se desbloquea.
@end deffn

@geindex put() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue put}@anchor{326c}
@deffn {Método} coroutine put (item)

Pone un ítem en la cola. Si la cola está completa, espera hasta que una entrada vacía esté disponible antes de agregar el ítem.

Raises @ref{318,,QueueShutDown} if the queue has been shut down.
@end deffn

@geindex put_nowait() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue put_nowait}@anchor{326d}
@deffn {Método} put_nowait (item)

Pone un ítem en la cola sin bloquearse.

Si no hay inmediatamente disponibles entradas vacías, lanza @ref{326e,,QueueFull}.
@end deffn

@geindex qsize() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue qsize}@anchor{3266}
@deffn {Método} qsize ()

Retorna el número de ítems en la cola.
@end deffn

@geindex shutdown() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue shutdown}@anchor{317}
@deffn {Método} shutdown (immediate=False)

Shut down the queue, making @ref{3265,,get()} and @ref{326c,,put()}
raise @ref{318,,QueueShutDown}.

By default, @ref{3265,,get()} on a shut down queue will only
raise once the queue is empty. Set `immediate' to true to make
@ref{3265,,get()} raise immediately instead.

All blocked callers of @ref{326c,,put()} and @ref{3265,,get()}
will be unblocked. If `immediate' is true, a task will be marked
as done for each remaining item in the queue, which may unblock
callers of @ref{e4d,,join()}.


Added in version 3.13.

@end deffn

@geindex task_done() (método de asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue task_done}@anchor{e4e}
@deffn {Método} task_done ()

Indica que una tarea formalmente en cola está completa.

Usada por consumidores de la cola. Para cada @ref{3265,,get()} usado para buscar una tarea, una ejecución subsecuente a @ref{e4e,,task_done()} dice a la cola que el procesamiento de la tarea está completo.

Si un @ref{e4d,,join()} está actualmente bloqueando, éste se resumirá cuando todos los ítems han sido procesados (implicado que un método @ref{e4e,,task_done()} fue recibido por cada ítem que ha sido @ref{326c,,put()} en la cola.

@code{shutdown(immediate=True)} calls @ref{e4e,,task_done()} for each
remaining item in the queue.

Lanza @ref{360,,ValueError} si fue llamado más veces que los ítems en la cola.
@end deffn
@end deffn

@node Cola de prioridad,Cola UEPA o LIFO en inglés,Cola,Colas
@anchor{library/asyncio-queue priority-queue}@anchor{326f}
@subsubsection Cola de prioridad


@geindex PriorityQueue (clase en asyncio)
@anchor{library/asyncio-queue asyncio PriorityQueue}@anchor{3270}
@deffn {Clase} asyncio.PriorityQueue

Una variante de @ref{b05,,Queue}; recupera entradas en su orden de prioridad (el más bajo primero).

Las entradas son típicamente tuplas de la forma @code{(priority_number, data)}.
@end deffn

@node Cola UEPA o LIFO en inglés,Excepciones<10>,Cola de prioridad,Colas
@anchor{library/asyncio-queue lifo-queue}@anchor{3271}
@subsubsection Cola UEPA (o `LIFO' en inglés)


@geindex LifoQueue (clase en asyncio)
@anchor{library/asyncio-queue asyncio LifoQueue}@anchor{3272}
@deffn {Clase} asyncio.LifoQueue

Una variante de una @ref{b05,,Queue} que recupera primero el elemento agregado más reciente (último en entrar, primero en salir).
@end deffn

@node Excepciones<10>,Ejemplos<16>,Cola UEPA o LIFO en inglés,Colas
@anchor{library/asyncio-queue exceptions}@anchor{3273}
@subsubsection Excepciones


@geindex QueueEmpty
@anchor{library/asyncio-queue asyncio QueueEmpty}@anchor{326b}
@deffn {Excepción} asyncio.QueueEmpty

Esta excepción es lanzada cuando el método @ref{326a,,get_nowait()} es ejecutado en una cola vacía.
@end deffn

@geindex QueueFull
@anchor{library/asyncio-queue asyncio QueueFull}@anchor{326e}
@deffn {Excepción} asyncio.QueueFull

Las excepciones son lanzadas cuando el método @ref{326d,,put_nowait()} es lanzado en una cola que ha alcanzado su `maxsize'.
@end deffn

@geindex QueueShutDown
@anchor{library/asyncio-queue asyncio QueueShutDown}@anchor{318}
@deffn {Excepción} asyncio.QueueShutDown

Exception raised when @ref{326c,,put()} or @ref{3265,,get()} is
called on a queue which has been shut down.


Added in version 3.13.

@end deffn

@node Ejemplos<16>,,Excepciones<10>,Colas
@anchor{library/asyncio-queue examples}@anchor{3263}
@subsubsection Ejemplos

@anchor{library/asyncio-queue asyncio-example-queue-dist}@anchor{3274}
Las colas pueden ser usadas para distribuir cargas de trabajo entre múltiples tareas concurrentes:

@example
import asyncio
import random
import time


async def worker(name, queue):
    while True:
        # Get a "work item" out of the queue.
        sleep_for = await queue.get()

        # Sleep for the "sleep_for" seconds.
        await asyncio.sleep(sleep_for)

        # Notify the queue that the "work item" has been processed.
        queue.task_done()

        print(f'@{name@} has slept for @{sleep_for:.2f@} seconds')


async def main():
    # Create a queue that we will use to store our "workload".
    queue = asyncio.Queue()

    # Generate random timings and put them into the queue.
    total_sleep_time = 0
    for _ in range(20):
        sleep_for = random.uniform(0.05, 1.0)
        total_sleep_time += sleep_for
        queue.put_nowait(sleep_for)

    # Create three worker tasks to process the queue concurrently.
    tasks = []
    for i in range(3):
        task = asyncio.create_task(worker(f'worker-@{i@}', queue))
        tasks.append(task)

    # Wait until the queue is fully processed.
    started_at = time.monotonic()
    await queue.join()
    total_slept_for = time.monotonic() - started_at

    # Cancel our worker tasks.
    for task in tasks:
        task.cancel()
    # Wait until all worker tasks are cancelled.
    await asyncio.gather(*tasks, return_exceptions=True)

    print('====')
    print(f'3 workers slept in parallel for @{total_slept_for:.2f@} seconds')
    print(f'total expected sleep time: @{total_sleep_time:.2f@} seconds')


asyncio.run(main())
@end example

@node Excepciones<11>,Bucle de eventos,Colas,asyncio — Asynchronous I/O
@anchor{library/asyncio-exceptions doc}@anchor{3275}@anchor{library/asyncio-exceptions asyncio-exceptions}@anchor{3276}@anchor{library/asyncio-exceptions exceptions}@anchor{3277}
@subsubsection Excepciones


`Código Fuente' Lib/asyncio/exceptions.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/exceptions.py}


__________________________________________________________________


@geindex TimeoutError
@anchor{library/asyncio-exceptions asyncio TimeoutError}@anchor{1749}
@deffn {Excepción} asyncio.TimeoutError

Un alias obsoleto de @ref{8cc,,TimeoutError}, lanzado cuando la operación ha superado el plazo establecido.


Distinto en la versión 3.11: Esta clase es un alias de @ref{8cc,,TimeoutError}.

@end deffn

@geindex CancelledError
@anchor{library/asyncio-exceptions asyncio CancelledError}@anchor{31f}
@deffn {Excepción} asyncio.CancelledError

La operación ha sido cancelada.

Esta excepción se puede capturar para realizar operaciones personalizadas cuando se cancelan las tareas de asyncio. En casi todas las situaciones, la excepción debe volver a lanzarse.


Distinto en la versión 3.8: @ref{31f,,CancelledError} es ahora una subclase de @ref{65c,,BaseException} en lugar de @ref{a6b,,Exception}.

@end deffn

@geindex InvalidStateError
@anchor{library/asyncio-exceptions asyncio InvalidStateError}@anchor{31fb}
@deffn {Excepción} asyncio.InvalidStateError

Estado Interno no válido de @ref{580,,Task} o @ref{c55,,Future}.

Se puede lanzar en situaciones como establecer un valor de resultado para un objeto `Future' que ya tiene un valor de resultado establecido.
@end deffn

@geindex SendfileNotAvailableError
@anchor{library/asyncio-exceptions asyncio SendfileNotAvailableError}@anchor{3278}
@deffn {Excepción} asyncio.SendfileNotAvailableError

La llamada al sistema «sendfile» no esta disponible desde el `socket' o tipo de archivo dado.

Una subclase de @ref{1e5,,RuntimeError}.
@end deffn

@geindex IncompleteReadError
@anchor{library/asyncio-exceptions asyncio IncompleteReadError}@anchor{1929}
@deffn {Excepción} asyncio.IncompleteReadError

La operación de lectura solicitada no se completó completamente.

Lanzado por la @ref{31c5,,asyncio stream APIs}.

La excepción es una subclase de @ref{1341,,EOFError}.

@geindex expected (atributo de asyncio.IncompleteReadError)
@anchor{library/asyncio-exceptions asyncio IncompleteReadError expected}@anchor{3279}
@deffn {Atributo} expected

El número total (@ref{1f0,,int}) de bytes esperados.
@end deffn

@geindex partial (atributo de asyncio.IncompleteReadError)
@anchor{library/asyncio-exceptions asyncio IncompleteReadError partial}@anchor{320f}
@deffn {Atributo} partial

Un cadena de @ref{325,,bytes} leída antes de que alcance al final del flujo.
@end deffn
@end deffn

@geindex LimitOverrunError
@anchor{library/asyncio-exceptions asyncio LimitOverrunError}@anchor{3210}
@deffn {Excepción} asyncio.LimitOverrunError

Alcanzó el límite de tamaño del búfer mientras buscaba un separador.

Lanzado por @ref{31c5,,asyncio stream APIs}.

@geindex consumed (atributo de asyncio.LimitOverrunError)
@anchor{library/asyncio-exceptions asyncio LimitOverrunError consumed}@anchor{327a}
@deffn {Atributo} consumed

El número total de bytes que se consumirán.
@end deffn
@end deffn

@node Bucle de eventos,Futures,Excepciones<11>,asyncio — Asynchronous I/O
@anchor{library/asyncio-eventloop doc}@anchor{327b}@anchor{library/asyncio-eventloop asyncio-event-loop}@anchor{dfe}@anchor{library/asyncio-eventloop event-loop}@anchor{327c}
@subsubsection Bucle de eventos


`Código fuente:' Lib/asyncio/events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/events.py}, Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/base_events.py}


__________________________________________________________________


@subsubheading Prólogo


El bucle de eventos es el núcleo de cada aplicación asyncio. Los bucles de eventos ejecutan tareas asíncronas y llamadas de retorno, realizan operaciones de E/S de red y ejecutan subprocesos.

Los desarrolladores de aplicaciones normalmente deberían usar las funciones asyncio de alto nivel, como: @ref{525,,asyncio.run()}, y rara vez deberían necesitar hacer referencia al objeto de bucle o llamar a sus métodos. Esta sección esta dirigida principalmente a autores de código de nivel inferior, bibliotecas y frameworks, quienes necesitan un control mas preciso sobre el comportamiento del bucle de eventos.

@subsubheading Obtención del bucle de eventos


Las siguientes funciones de bajo nivel se pueden utilizar para obtener, establecer o crear un bucle de eventos:

@geindex get_running_loop() (en el módulo asyncio)
@anchor{library/asyncio-eventloop asyncio get_running_loop}@anchor{b96}
@deffn {Función} asyncio.get_running_loop ()

Retorna el bucle de eventos en ejecución en el hilo del sistema operativo actual.

Raise a @ref{1e5,,RuntimeError} if there is no running event loop.

This function can only be called from a coroutine or a callback.


Added in version 3.7.

@end deffn

@geindex get_event_loop() (en el módulo asyncio)
@anchor{library/asyncio-eventloop asyncio get_event_loop}@anchor{214}
@deffn {Función} asyncio.get_event_loop ()

Obtiene bucle de eventos actual.

When called from a coroutine or a callback (e.g. scheduled with
call_soon or similar API), this function will always return the
running event loop.

If there is no running event loop set, the function will return
the result of the @code{get_event_loop_policy().get_event_loop()} call.

Dado que esta función tiene un comportamiento bastante complejo (especialmente cuando están en uso las políticas de bucle de eventos personalizadas), usar la función @ref{b96,,get_running_loop()} es preferible antes que @ref{214,,get_event_loop()} en corrutinas y llamadas de retorno.

As noted above, consider using the higher-level @ref{525,,asyncio.run()} function,
instead of using these lower level functions to manually create and close an
event loop.


Distinto en la versión 3.14: Raises a @ref{1e5,,RuntimeError} if there is no current event loop.

@end deffn

@geindex set_event_loop() (en el módulo asyncio)
@anchor{library/asyncio-eventloop asyncio set_event_loop}@anchor{17d2}
@deffn {Función} asyncio.set_event_loop (loop)

Set `loop' as the current event loop for the current OS thread.
@end deffn

@geindex new_event_loop() (en el módulo asyncio)
@anchor{library/asyncio-eventloop asyncio new_event_loop}@anchor{31d2}
@deffn {Función} asyncio.new_event_loop ()

Crea y retorna un nuevo objeto de bucle de eventos.
@end deffn

Tenga en cuenta que el comportamiento de las funciones @ref{214,,get_event_loop()}, @ref{17d2,,set_event_loop()}, y @ref{31d2,,new_event_loop()} puede ser modificado mediante @ref{327d,,estableciendo una política de bucle de eventos personalizada}.

@subsubheading Contenidos


Esta página de documentación contiene las siguientes secciones:


@itemize *

@item 
La sección @ref{327e,,Métodos del bucle de eventos} es la documentación de referencia de las APIs del bucle de eventos;

@item 
La sección @ref{327f,,Callback Handles} documenta las instancias @ref{1aaa,,Handle} y @ref{1775,,TimerHandle} las cuales son retornadas por métodos planificados como @ref{b8f,,loop.call_soon()} y @ref{b91,,loop.call_later()};

@item 
La sección @ref{3280,,Objetos del servidor} documenta tipos retornados por los métodos del bucle de eventos como @ref{b9e,,loop.create_server()};

@item 
La sección @ref{3281,,Implementaciones de bucle de eventos} documenta las clases @ref{6a9,,SelectorEventLoop} y @ref{6aa,,ProactorEventLoop};

@item 
La sección @ref{3282,,Ejemplos} muestra como trabajar con algunas APIs de bucle de eventos.
@end itemize

@menu
* Métodos del bucle de eventos:: 
* Gestores de llamadas:: 
* Objetos Servidor:: 
* Implementaciones del bucle de eventos:: 
* Examples: Examples<2>. 

@end menu

@node Métodos del bucle de eventos,Gestores de llamadas,,Bucle de eventos
@anchor{library/asyncio-eventloop asyncio-event-loop-methods}@anchor{3283}@anchor{library/asyncio-eventloop event-loop-methods}@anchor{327e}
@subsubsection Métodos del bucle de eventos


Los bucles de eventos tienen APIs de `bajo nivel' para lo siguiente:

@menu
* Iniciar y para el bucle:: 
* Programación de llamadas de retorno:: 
* Planificando llamadas retardadas:: 
* Creando futuros y tareas:: 
* Abriendo conexiones de red:: 
* Creando servidores de red:: 
* Transfiriendo archivos:: 
* Actualización de TLS:: 
* Viendo descriptores de archivos:: 
* Trabajar con objetos sockets directamente:: 
* DNS:: 
* Trabajando con tuberías:: 
* Señales Unix:: 
* Ejecutando código en un hilos o grupos de procesos:: 
* API para manejo de errores:: 
* Habilitando el modo depuración:: 
* Ejecutando subprocesos:: 

@end menu

@node Iniciar y para el bucle,Programación de llamadas de retorno,,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop running-and-stopping-the-loop}@anchor{3284}
@subsubsection Iniciar y para el bucle


@geindex run_until_complete() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_until_complete}@anchor{cff}
@deffn {Método} loop.run_until_complete (future)

Se ejecuta hasta que `future' (una instancia de @ref{c55,,Future}) se haya completado.

Si el argumento es un @ref{31c4,,objeto corrutina} está implícitamente planificado para ejecutarse como una @ref{580,,asyncio.Task}.

Retorna el resultado del Futuro o genera una excepción.
@end deffn

@geindex run_forever() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_forever}@anchor{3285}
@deffn {Método} loop.run_forever ()

Ejecuta el bucle de eventos hasta que @ref{d04,,stop()} es llamado.

If @ref{d04,,stop()} is called before @ref{3285,,run_forever()} is called,
the loop will poll the I/O selector once with a timeout of zero,
run all callbacks scheduled in response to I/O events (and
those that were already scheduled), and then exit.

Si @ref{d04,,stop()} es llamado mientras @ref{3285,,run_forever()} se está ejecutando, el loop ejecutará el lote actual de llamadas y después finalizará. Tenga en cuenta que llamadas planificadas por otras llamadas no se ejecutarán en este caso; en su lugar, ellas correrán la próxima vez que @ref{3285,,run_forever()} o @ref{cff,,run_until_complete()} sean llamados.
@end deffn

@geindex stop() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop stop}@anchor{d04}
@deffn {Método} loop.stop ()

Detener el bucle de eventos.
@end deffn

@geindex is_running() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop is_running}@anchor{3286}
@deffn {Método} loop.is_running ()

Retorna @code{True} si el bucle de eventos esta en ejecución actualmente.
@end deffn

@geindex is_closed() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop is_closed}@anchor{e49}
@deffn {Método} loop.is_closed ()

Retorna @code{True} si el bucle de eventos se cerró.
@end deffn

@geindex close() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop close}@anchor{3287}
@deffn {Método} loop.close ()

Cierra el bucle de eventos.

El bucle no debe estar en ejecución cuando se llama a esta función. Cualquier llamada de retorno pendiente será descartada.

Este método limpia todas las colas y apaga el ejecutor, pero no espera a que el ejecutor termine.

Este método es idempotente e irreversible. No se debe llamar ningún otro método después que el bucle de eventos es cerrado.
@end deffn

@geindex shutdown_asyncgens() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop shutdown_asyncgens}@anchor{d06}
@deffn {Método} coroutine loop.shutdown_asyncgens ()

Schedule all currently open @ref{2039,,asynchronous generator} objects to
close with an @ref{96f,,aclose()} call.  After calling this method,
the event loop will issue a warning if a new asynchronous generator
is iterated. This should be used to reliably finalize all scheduled
asynchronous generators.

Tenga en cuenta que no hay necesidad de llamar esta función cuando @ref{525,,asyncio.run()} es utilizado.

Ejemplo:

@example
try:
    loop.run_forever()
finally:
    loop.run_until_complete(loop.shutdown_asyncgens())
    loop.close()
@end example


Added in version 3.6.

@end deffn

@geindex shutdown_default_executor() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop shutdown_default_executor}@anchor{97e}
@deffn {Método} coroutine loop.shutdown_default_executor (timeout=None)

Schedule the closure of the default executor and wait for it to join all of
the threads in the @ref{7dd,,ThreadPoolExecutor}.
Once this method has been called,
using the default executor with @ref{980,,loop.run_in_executor()}
will raise a @ref{1e5,,RuntimeError}.

The `timeout' parameter specifies the amount of time
(in @ref{153,,float} seconds) the executor will be given to finish joining.
With the default, @code{None},
the executor is allowed an unlimited amount of time.

If the `timeout' is reached, a @ref{323,,RuntimeWarning} is emitted
and the default executor is terminated
without waiting for its threads to finish joining.

@cartouche
@quotation Nota 
Do not call this method when using @ref{525,,asyncio.run()},
as the latter handles default executor shutdown automatically.
@end quotation
@end cartouche


Added in version 3.9.



Distinto en la versión 3.12: Added the `timeout' parameter.

@end deffn

@node Programación de llamadas de retorno,Planificando llamadas retardadas,Iniciar y para el bucle,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop scheduling-callbacks}@anchor{3288}
@subsubsection Programación de llamadas de retorno


@geindex call_soon() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_soon}@anchor{b8f}
@deffn {Método} loop.call_soon (callback, *args, context=None)

Programa el `callback' (retrollamada) @ref{290d,,callback} para que se llame con argumentos `args' en la próxima iteración del ciclo de eventos.

Return an instance of @ref{1aaa,,asyncio.Handle},
which can be used later to cancel the callback.

Llamadas que son ejecutadas en el orden en el que fueron registradas. Cada llamada será ejecutada exactamente una sola vez.

The optional keyword-only `context' argument specifies a
custom @ref{15a0,,contextvars.Context} for the `callback' to run in.
Callbacks use the current context when no `context' is provided.

Unlike @ref{b90,,call_soon_threadsafe()}, this method is not thread-safe.
@end deffn

@geindex call_soon_threadsafe() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_soon_threadsafe}@anchor{b90}
@deffn {Método} loop.call_soon_threadsafe (callback, *args, context=None)

A thread-safe variant of @ref{b8f,,call_soon()}. When scheduling callbacks from
another thread, this function `must' be used, since @ref{b8f,,call_soon()} is not
thread-safe.

Lanza @ref{1e5,,RuntimeError} si se llama en un bucle que ha sido cerrado. Esto puede suceder en un hilo secundario cuando la aplicación principal se está apagando.

Vea sección @ref{31f3,,concurrencia y multiproceso} de la documentación.


Distinto en la versión 3.7: Fue agregado el parámetro solo de palabra clave `context'. Vea 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mas detalles.

@end deffn
@anchor{library/asyncio-eventloop asyncio-pass-keywords}@anchor{3289}
@cartouche
@quotation Nota 
La mayoría de las funciones planificadas de @ref{b,,asyncio} no permiten pasar argumentos de palabra clave. Para hacer eso utilice @ref{17a,,functools.partial()}:

@example
# will schedule "print("Hello", flush=True)"
loop.call_soon(
    functools.partial(print, "Hello", flush=True))
@end example

El uso de objetos parciales es usualmente mas conveniente que utilizar lambdas, ya que asyncio puede renderizar mejor objetos parciales en mensajes de depuración y error.
@end quotation
@end cartouche

@node Planificando llamadas retardadas,Creando futuros y tareas,Programación de llamadas de retorno,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop asyncio-delayed-calls}@anchor{328a}@anchor{library/asyncio-eventloop scheduling-delayed-callbacks}@anchor{328b}
@subsubsection Planificando llamadas retardadas


El bucle de eventos provee mecanismos para planificar funciones de llamadas que serán ejecutadas en algún punto en el futuro. El bucle de eventos usa relojes monotónicos para seguir el tiempo.

@geindex call_later() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_later}@anchor{b91}
@deffn {Método} loop.call_later (delay, callback, *args, context=None)

Planifica `callback' para ser ejecutada luego de `delay' número de segundos (puede ser tanto un entero como un flotante).

Una instancia de @ref{1775,,asyncio.TimerHandle} es retornada, la que puede ser utilizada para cancelar la ejecución.

`callback' será ejecutada exactamente una sola vez. Si dos llamadas son planificadas para el mismo momento exacto, el orden en el que son ejecutadas es indefinido.

El argumento posicional opcional `args' será pasado a la llamada cuando esta sea ejecutada. Si quieres que la llamada sea ejecutada con argumentos de palabra clave usa @ref{17a,,functools.partial()}.

Un argumento `context' opcional y solo de palabra clave que permite especificar una clase @ref{15a0,,contextvars.Context} personalizada en la cual `callback' será ejecutada. Cuando no se provee `context' el contexto actual es utilizado.


Distinto en la versión 3.7: Fue agregado el parámetro solo de palabra clave `context'. Vea 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mas detalles.



Distinto en la versión 3.8: En Python 3.7 y versiones anteriores con la implementación del bucle de eventos predeterminada, el `delay' no puede exceder un día. Esto fue arreglado en Python 3.8.

@end deffn

@geindex call_at() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_at}@anchor{b92}
@deffn {Método} loop.call_at (when, callback, *args, context=None)

Planifica `callback' para ser ejecutada en una marca de tiempo absoluta `when' (un entero o un flotante), usando la misma referencia de tiempo que @ref{328c,,loop.time()}.

El comportamiento de este método es el mismo que @ref{b91,,call_later()}.

Una instancia de @ref{1775,,asyncio.TimerHandle} es retornada, la que puede ser utilizada para cancelar la ejecución.


Distinto en la versión 3.7: Fue agregado el parámetro solo de palabra clave `context'. Vea 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mas detalles.



Distinto en la versión 3.8: En Python 3.7 y versiones anteriores con la implementación del bucle de eventos predeterminada, la diferencia entre `when' y el tiempo actual no puede exceder un día. Esto fue arreglado en Python 3.8.

@end deffn

@geindex time() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop time}@anchor{328c}
@deffn {Método} loop.time ()

Retorna el tiempo actual, como un @ref{153,,float}, de acuerdo al reloj monotónico interno del bucle de evento.
@end deffn

@cartouche
@quotation Nota 

Distinto en la versión 3.8: En Python 3.7 y versiones anteriores los tiempos de espera (`delay' relativo o `when' absoluto) no deben exceder un día. Esto fue arreglado en Python 3.8.

@end quotation
@end cartouche


@subsubheading Ver también


La función @ref{afe,,asyncio.sleep()}.


@node Creando futuros y tareas,Abriendo conexiones de red,Planificando llamadas retardadas,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop creating-futures-and-tasks}@anchor{328d}
@subsubsection Creando futuros y tareas


@geindex create_future() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_future}@anchor{d01}
@deffn {Método} loop.create_future ()

Crea un objeto @ref{c55,,asyncio.Future} adjunto al bucle de eventos.

Esta es la manera preferida de crear Futures en asyncio. Esto permite que bucles de eventos de terceros provean implementaciones alternativas del objeto Future (con mejor rendimiento o instrumentación).


Added in version 3.5.2.

@end deffn

@geindex create_task() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_task}@anchor{a6e}
@deffn {Método} loop.create_task (coro, *, name=None, context=None)

Planifica la ejecución de la @ref{31c4,,corrutina} `coro'. Retorna un objeto @ref{580,,Task}.

Bucles de eventos de terceros pueden usar sus propias subclases de @ref{580,,Task} por interoperabilidad. En este caso, el tipo de resultado es una subclase de @ref{580,,Task}.

Si el argumento `name' es provisto y no @code{None}, se establece como el nombre de la tarea usando @ref{a6f,,Task.set_name()}.

Un argumento opcional y solo de palabra clave `context' que permite especificar una clase @ref{15a0,,contextvars.Context} personalizada en la cual `coro' será ejecutada. Cuando no se provee `context' el contexto actual es utilizado.


Distinto en la versión 3.8: Agregado el parámetro `name'.



Distinto en la versión 3.11: Agregado el parámetro `context'.

@end deffn

@geindex set_task_factory() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_task_factory}@anchor{e4b}
@deffn {Método} loop.set_task_factory (factory)

Establece una fábrica de tareas que será utilizada por @ref{a6e,,loop.create_task()}.

Si `factory' es @code{None} se establecerá la fábrica de tareas por defecto. En cualquier otro caso, `factory' debe ser un `callable' con la misma firma @code{(loop, coro, context=None)}, donde `loop' es una referencia al bucle de eventos activo y `coro' es un objeto de corrutina.  El ejecutable debe retornar un objeto @ref{c55,,asyncio.Future} compatible.
@end deffn

@geindex get_task_factory() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_task_factory}@anchor{e4c}
@deffn {Método} loop.get_task_factory ()

Retorna una fábrica de tareas o @code{None} si la predefinida está en uso.
@end deffn

@node Abriendo conexiones de red,Creando servidores de red,Creando futuros y tareas,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop opening-network-connections}@anchor{328e}
@subsubsection Abriendo conexiones de red


@geindex create_connection() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_connection}@anchor{6a4}
@deffn {Método} coroutine loop.create_connection (protocol_factory, host=None, port=None, *, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, happy_eyeballs_delay=None, interleave=None, all_errors=False)

Abre una conexión de transmisión de transporte a una dirección especificada por `host' y `port'.

The socket family can be either @ref{1824,,AF_INET} or
@ref{1825,,AF_INET6} depending on `host' (or the `family'
argument, if provided).

The socket type will be @ref{135a,,SOCK_STREAM}.

`protocol_factory' debe ser un ejecutable que retorna una implementación del @ref{328f,,asyncio protocol}.

Este método tratará de establecer la conexión en un segundo plano. Cuando es exitosa, retorna un par @code{(transport, protocol)}.

La sinopsis cronológica de las operaciones subyacentes es como sigue:


@enumerate 

@item 
La conexión es establecida y un @ref{3290,,transporte} es creado para ello.

@item 
`protocol_factory' es llamado sin argumentos y se espera que retorne una instancia de @ref{328f,,protocol}.

@item 
La instancia del protocolo se acopla con el transporte mediante el llamado de su método @ref{3291,,connection_made()}.

@item 
Una tupla @code{(transport, protocol)} es retornada cuando se tiene éxito.
@end enumerate

El transporte creado es una transmisión (`stream') bidireccional que depende de la implementación.

Otros argumentos:


@itemize *

@item 
`ssl': si se provee y no es falso, un transporte SSL/TLS es creado (de manera predeterminada se crea un transporte TCP plano).  Si `ssl' es un objeto @ref{1fa,,ssl.SSLContext}, este contexto es utilizado para crear el transporte; si `ssl' es @ref{c95,,True}, se utiliza un contexto predeterminado retornado por @ref{2c1,,ssl.create_default_context()}.


@subsubheading Ver también


@ref{3292,,Consideraciones de seguridad SSL/TLS}


@item 
`server_hostname' establece o reemplaza el nombre de servidor (`hostname') contra el cual el certificado del servidor de destino será comparado. Sólo debería ser pasado si `ssl' no es @code{None}. De manera predeterminada es usado el valor del argumento `host'.  Si `host' está vacío, no hay valor predeterminado y debes pasar un valor para `server_hostname'. Si `server_hostname' es una cadena vacía, la comparación de nombres de servidores es deshabilitada (lo que es un riesgo de seguridad serio, permitiendo potenciales ataques de hombre-en-el-medio, `man-in-the-middle attacks').

@item 
`family', `proto', `flags' son dirección de familia, protocolo y banderas opcionales que serán pasadas a través de @cite{getaddrinfo()} para la resolución de `host'. Si están dados, todos ellos deberían ser enteros de las constantes del módulo @ref{cc,,socket} correspondiente.

@item 
`happy_eyeballs_delay', si se proporciona, habilita Happy Eyeballs para esta conexión. Debe ser un número de punto flotante que represente la cantidad de tiempo en segundos para esperar a que se complete un intento de conexión, antes de comenzar el siguiente intento en paralelo. Este es el «Retraso de intento de conexión» como se define en 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html}. Un valor predeterminado sensato recomendado por el RFC es @code{0.25} (250 milisegundos).

@item 
`interleave' controla reordenamientos de dirección cuando un nombre de servidor resuelve a múltiples direcciones IP. Si es @code{0} o no es especificado, no se hace ningún reordenamiento, y las direcciones son intentadas en el orden retornado por @ref{c9c,,getaddrinfo()}. Si un entero positivo es especificado, las direcciones son intercaladas por dirección de familia, y el entero dado es interpretado como «Número de familias de la primera dirección» (`First Address Family Count') como es definida en 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html}. El valor predefinido es @code{0} si `happy_eyeballs_delay' no es especificado, y @code{1} si lo es.

@item 
`sock', si está dado, debe ser un objeto @ref{e27,,socket.socket} existente y ya conectado, que será utilizado por el transporte. Si `sock' es dado, ningún `host', `port', `family', `proto', `flags', `happy_eyeballs_delay', `interleave' o `local_addr' deben ser especificados.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al transporte creado. Para cerrar el socket, llame al método @ref{3293,,close()} del transporte.
@end quotation
@end cartouche

@item 
`local_addr', si está dado, es una tupla @code{(local_host, local_port)} usada para enlazar el socket localmente.  Los `local_host' y `local_port' son buscados usando @code{getaddrinfo()}, de manera similar que con `host' y `port'.

@item 
`ssl_handshake_timeout' es (para una conexión TLS) el tiempo en segundos a esperar que se complete el `handshake' TLS antes de abortar la conexión. @code{60.0} segundos si es @code{None} (predefinido).

@item 
`ssl_shutdown_timeout' es el tiempo en segundos a esperar a que se complete el apagado SSL antes de abortar la conexión. @code{30.0} segundos si es @code{None} (predefinido).

@item 
`all_errors' determines what exceptions are raised when a connection cannot
be created. By default, only a single @code{Exception} is raised: the first
exception if there is only one or all errors have same message, or a single
@code{OSError} with the error messages combined. When @code{all_errors} is @code{True},
an @code{ExceptionGroup} will be raised containing all exceptions (even if there
is only one).
@end itemize


Distinto en la versión 3.5: Agregado el soporte para SSL/TLS en @ref{6aa,,ProactorEventLoop}.



Distinto en la versión 3.6: The socket option @ref{3294,,socket.TCP_NODELAY} is set by default
for all TCP connections.



Distinto en la versión 3.7: Agregado el parámetro `ssl_handshake_timeout'.



Distinto en la versión 3.8: Agregados los parámetros `happy_eyeballs_delay' y `interleave'.

Happy Eyeballs Algorithm: Success with Dual-Stack Hosts.
When a server’s IPv4 path and protocol are working, but the server’s
IPv6 path and protocol are not working, a dual-stack client
application experiences significant connection delay compared to an
IPv4-only client.  This is undesirable because it causes the
dual-stack client to have a worse user experience.  This document
specifies requirements for algorithms that reduce this user-visible
delay and provides an algorithm.

For more information: @indicateurl{https://datatracker.ietf.org/doc/html/rfc6555}



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.



Distinto en la versión 3.12: `all_errors' was added.



@subsubheading Ver también


La función @ref{ba3,,open_connection()} es una API alternativa de alto nivel. Retorna un par de (@ref{18ce,,StreamReader}, @ref{1705,,StreamWriter}) que puede ser usado directamente en código async/await.

@end deffn

@geindex create_datagram_endpoint() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_datagram_endpoint}@anchor{7cf}
@deffn {Método} coroutine loop.create_datagram_endpoint (protocol_factory, local_addr=None, remote_addr=None, *, family=0, proto=0, flags=0, reuse_port=None, allow_broadcast=None, sock=None)

Crea un datagrama de conexión.

The socket family can be either @ref{1824,,AF_INET},
@ref{1825,,AF_INET6}, or @ref{1826,,AF_UNIX},
depending on `host' (or the `family' argument, if provided).

The socket type will be @ref{1359,,SOCK_DGRAM}.

`protocol_factory' debe ser un ejecutable que retorne una implementación de @ref{328f,,protocol}.

Una tupla de @code{(transport, protocol)} es retornada cuando se tiene éxito.

Otros argumentos:


@itemize *

@item 
`local_addr', si está dado, es una tupla @code{(local_host, local_port)} usada para enlazar el socket localmente.  Los `local_host' y `local_port' son buscados utilizando @ref{c9c,,getaddrinfo()}.

@item 
`remote_addr', si está dado, es una tupla @code{(remote_host, remote_port)} utilizada para conectar el socket a una dirección remota. Los `remote_host' y `remote_port' son buscados utilizando @ref{c9c,,getaddrinfo()}.

@item 
`family', `proto', `flags' son direcciones de familia, protocolo y banderas opcionales que serán pasadas a través de @ref{c9c,,getaddrinfo()} para la resolución de `host'. Si está dado, estos deben ser todos enteros de las constantes del módulo @ref{cc,,socket} correspondiente.

@item 
`reuse_port' tells the kernel to allow this endpoint to be bound to the
same port as other existing endpoints are bound to, so long as they all
set this flag when being created. This option is not supported on Windows
and some Unixes. If the @ref{3294,,socket.SO_REUSEPORT} constant is not
defined then this capability is unsupported.

@item 
`allow_broadcast' dice al kernel que habilite este punto de conexión para enviar mensajes a la dirección de transmisión (`broadcast').

@item 
`sock' puede opcionalmente ser especificado para usar un objeto @ref{e27,,socket.socket} preexistente y ya conectado que será utilizado por el transporte. Si están especificados, `local_addr' y `remote_addr' deben ser omitidos (tienen que ser @ref{716,,None}).

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al transporte creado. Para cerrar el socket, llame al método @ref{3293,,close()} del transporte.
@end quotation
@end cartouche
@end itemize

Refiérase a los ejemplos @ref{3295,,UDP echo client protocol} y @ref{3296,,UDP echo server protocol}.


Distinto en la versión 3.4.4: Los parámetros `family', `proto', `flags', `reuse_address', `reuse_port', `allow_broadcast' y `sock' fueron agregados.



Distinto en la versión 3.8: Se agregó soporte para Windows.



Distinto en la versión 3.8.1: The `reuse_address' parameter is no longer supported, as using
@ref{3294,,socket.SO_REUSEADDR}
poses a significant security concern for
UDP. Explicitly passing @code{reuse_address=True} will raise an exception.

Cuando múltiples procesos con UIDs diferentes asignan sockets a una misma dirección socket UDP con @code{SO_REUSEADDR}, los paquetes entrantes pueden distribuirse aleatoriamente entre los sockets.

For supported platforms, `reuse_port' can be used as a replacement for
similar functionality. With `reuse_port',
@ref{3294,,socket.SO_REUSEPORT}
is used instead, which specifically
prevents processes with differing UIDs from assigning sockets to the same
socket address.



Distinto en la versión 3.11: The `reuse_address' parameter, disabled since Python 3.8.1,
3.7.6 and 3.6.10, has been entirely removed.

@end deffn

@geindex create_unix_connection() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_unix_connection}@anchor{3209}
@deffn {Método} coroutine loop.create_unix_connection (protocol_factory, path=None, *, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Crear una conexión Unix.

The socket family will be @ref{1826,,AF_UNIX}; socket
type will be @ref{135a,,SOCK_STREAM}.

Una tupla de @code{(transport, protocol)} es retornada cuando se tiene éxito.

`path' es el nombre de un dominio de un socket Unix y es requerido, a menos que un parámetro `sock' sea especificado. Los socket Unix abstractos, @ref{237,,str}, @ref{325,,bytes}, y @ref{19b,,Path} son soportados.

Vea la documentación del método @ref{6a4,,loop.create_connection()} para información acerca de los argumentos de este método.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.7: Agregado el parámetro `ssl_handshake_timeout'. El parámetro `path' ahora puede ser un @ref{3f0,,path-like object}.



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.

@end deffn

@node Creando servidores de red,Transfiriendo archivos,Abriendo conexiones de red,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop creating-network-servers}@anchor{3297}
@subsubsection Creando servidores de red


@geindex create_server() (método de asyncio.loop)
@anchor{library/asyncio-eventloop loop-create-server}@anchor{31c9}@anchor{library/asyncio-eventloop asyncio loop create_server}@anchor{b9e}
@deffn {Método} coroutine loop.create_server (protocol_factory, host=None, port=None, *, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, keep_alive=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

Create a TCP server (socket type @ref{135a,,SOCK_STREAM}) listening
on `port' of the `host' address.

Retorna un objeto @ref{b9d,,Server}.

Argumentos:


@itemize *

@item 
`protocol_factory' debe ser un ejecutable que retorne una implementación de @ref{328f,,protocol}.

@item 
El parámetro `host' puede ser establecido a distintos tipos que determinan donde el servidor estaría escuchando:


@itemize -

@item 
Si `host' es una cadena, el servidor TCP está enlazado a una sola interfaz de red especificada por `host'.

@item 
Si `host' es una secuencia de cadenas, el servidor TCP está enlazado a todas las interfaces de red especificadas por la secuencia.

@item 
Si `host' es una cadena vacía o @code{None}, se asumen todas las interfaces y una lista con múltiples sockets será retornada (mas probablemente uno para IPv4 y otro para IPv6).
@end itemize

@item 
El parámetro `port' puede establecerse para especificar en qué puerto debe escuchar el servidor. Si es @code{0} o @code{None} (por defecto), se seleccionará un puerto aleatorio no utilizado (tenga en cuenta que si `host' resuelve a múltiples interfaces de red, se seleccionará un puerto aleatorio diferente para cada interfaz).

@item 
`family' can be set to either @ref{1824,,socket.AF_INET} or
@ref{1825,,AF_INET6} to force the socket to use IPv4 or IPv6.
If not set, the `family' will be determined from host name
(defaults to @ref{3298,,AF_UNSPEC}).

@item 
`flags' es una máscara de bits para @ref{c9c,,getaddrinfo()}.

@item 
`sock' puede ser especificado opcionalmente para usar objetos socket preexistentes. Si se utiliza, entonces `host' y `port' no deben ser especificados.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al servidor creado. Para cerrar el socket, llame al método @ref{3207,,close()} del servidor.
@end quotation
@end cartouche

@item 
`backlog' es el número máximo de conexiones encoladas pasadas a @ref{ede,,listen()} (el valor predeterminado es 100).

@item 
`ssl' puede ser establecido como una instancia de @ref{1fa,,SSLContext} para habilitar TLS sobre las conexiones aceptadas.

@item 
`reuse_address' indica al kernel que reutilice un socket local en estado @code{TIME_WAIT}, sin esperar que su plazo de ejecución expire. Si no es especificado será establecido automáticamente como @code{True} en Unix.

@item 
`reuse_port' dice al kernel que habilite este punto de conexión para ser unido al mismo puerto de la misma forma que otros puntos de conexión existentes también están unidos, siempre y cuando todos ellos establezcan esta bandera al ser creados.

@item 
`keep_alive' set to @code{True} keeps connections active by enabling the
periodic transmission of messages.
@end itemize


Distinto en la versión 3.13: Added the `keep_alive' parameter.



@itemize *

@item 
`ssl_handshake_timeout' es (para un servidor TLS) el tiempo en segundos a esperar por el apretón de manos (`handshake') TLS a ser completado antes de abortar la conexión. @code{60.0} si es @code{None} (su valor predeterminado).

@item 
`ssl_shutdown_timeout' es el tiempo en segundos a esperar a que se complete el apagado SSL antes de abortar la conexión. @code{30.0} segundos si es @code{None} (predefinido).

@item 
`start_serving' establecido como @code{True} (de manera predeterminada) produce que los servidores creados comiencen a aceptar conexiones inmediatamente. Si es establecido como @code{False}, el usuario debe esperar por @ref{b9f,,Server.start_serving()} o @ref{ba0,,Server.serve_forever()} para que el servidor comience a aceptar conexiones.
@end itemize


Distinto en la versión 3.5: Agregado el soporte para SSL/TLS en @ref{6aa,,ProactorEventLoop}.



Distinto en la versión 3.5.1: El parámetro `host' puede ser una secuencia de cadenas.



Distinto en la versión 3.6: Added `ssl_handshake_timeout' and `start_serving' parameters.
The socket option @ref{3294,,socket.TCP_NODELAY} is set by default
for all TCP connections.



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.



@subsubheading Ver también


La función @ref{ba4,,start_server()} es una API alternativa de alto nivel que retorna un par de @ref{18ce,,StreamReader} y @ref{1705,,StreamWriter} que pueden ser usados en código async/await.

@end deffn

@geindex create_unix_server() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_unix_server}@anchor{315}
@deffn {Método} coroutine loop.create_unix_server (protocol_factory, path=None, *, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True, cleanup_socket=True)

Similar to @ref{b9e,,loop.create_server()} but works with the
@ref{1826,,AF_UNIX} socket family.

`path' es el nombre de un dominio de socket Unix, y es requerido a menos que el argumento `sock' sea provisto. Son soportados sockets unix abstractos, @ref{237,,str}, @ref{325,,bytes}, y rutas @ref{19b,,Path}.

If `cleanup_socket' is true then the Unix socket will automatically
be removed from the filesystem when the server is closed, unless the
socket has been replaced after the server has been created.

Vea la documentación de el método @ref{b9e,,loop.create_server()} para mas información acerca de los argumentos de este método.

@ref{1d5a,,Availability}: Unix.


Distinto en la versión 3.7: Agregados los parámetros `ssl_handshake_timeout' y `start_serving'. El parámetro `path' ahora puede ser un objeto @ref{19b,,Path}.



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.



Distinto en la versión 3.13: Added the `cleanup_socket' parameter.

@end deffn

@geindex connect_accepted_socket() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_accepted_socket}@anchor{d05}
@deffn {Método} coroutine loop.connect_accepted_socket (protocol_factory, sock, *, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Envuelve una conexión ya aceptada en un par de transporte/protocolo.

Este método puede ser usado por servidores que acepten conexiones por fuera de asyncio, pero que usen asyncio para manejarlas.

Parámetros:


@itemize *

@item 
`protocol_factory' debe ser un ejecutable que retorne una implementación de @ref{328f,,protocol}.

@item 
`sock' es un objeto socket preexistente retornado por @ref{e28,,socket.accept}.

@cartouche
@quotation Nota 
El argumento `sock' transfiere la propiedad del socket al transporte creado. Para cerrar el socket, llame al método @ref{3293,,close()} del transporte.
@end quotation
@end cartouche

@item 
`ssl' puede ser establecido como un @ref{1fa,,SSLContext} para habilitar SSL sobre las conexiones aceptadas.

@item 
`ssl_handshake_timeout' es (para una conexión SSL) el tiempo en segundos que se esperará para que se complete el apretón de manos (`handshake') SSL antes de abortar la conexión. @code{60.0} si es @code{None} (su valor predeterminado).

@item 
`ssl_shutdown_timeout' es el tiempo en segundos a esperar a que se complete el apagado SSL antes de abortar la conexión. @code{30.0} segundos si es @code{None} (predefinido).
@end itemize

Retorna un par @code{(transport, protocol)}.


Added in version 3.5.3.



Distinto en la versión 3.7: Agregado el parámetro `ssl_handshake_timeout'.



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.

@end deffn

@node Transfiriendo archivos,Actualización de TLS,Creando servidores de red,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop transferring-files}@anchor{3299}
@subsubsection Transfiriendo archivos


@geindex sendfile() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sendfile}@anchor{329a}
@deffn {Método} coroutine loop.sendfile (transport, file, offset=0, count=None, *, fallback=True)

Envía un `file' a través de un `transport'. Retorna el numero total de bytes enviados.

El método usa @ref{b9a,,os.sendfile()} de alto rendimiento si está disponible.

`file' debe ser un objeto de archivo regular abierto en modo binario.

`offset' indica desde donde se empezará a leer el archivo. Si es especificado, `count' es el número total de bytes a transmitir en contraposición con enviar el archivo hasta que se alcance EOF. La posición del archivo es actualizada siempre, incluso cuando este método genere un error, y @ref{29aa,,file.tell()} puede ser usado para obtener el número de bytes enviados hasta el momento.

`fallback' establecido como @code{True} hace que asyncio lea y envíe el archivo manualmente cuando la plataforma no soporta la llamada de envío de archivos del sistema (por ejemplo, Windows o sockets SSL en Unix).

Lanza @ref{3278,,SendfileNotAvailableError} si el sistema no soporta la llamada de envío de archivos del sistema y `fallback' es @code{True}.


Added in version 3.7.

@end deffn

@node Actualización de TLS,Viendo descriptores de archivos,Transfiriendo archivos,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop tls-upgrade}@anchor{329b}
@subsubsection Actualización de TLS


@geindex start_tls() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop start_tls}@anchor{b94}
@deffn {Método} coroutine loop.start_tls (transport, protocol, sslcontext, *, server_side=False, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Actualiza una conexión basada en transporte ya existente a TLS.

Create a TLS coder/decoder instance and insert it between the `transport'
and the `protocol'. The coder/decoder implements both `transport'-facing
protocol and `protocol'-facing transport.

Return the created two-interface instance. After `await', the `protocol'
must stop using the original `transport' and communicate with the returned
object only because the coder caches `protocol'-side data and sporadically
exchanges extra TLS session packets with `transport'.

In some situations (e.g. when the passed transport is already closing) this
may return @code{None}.

Parámetros:


@itemize *

@item 
Las instancias `transport' y `protocol' que retornan los métodos como @ref{b9e,,create_server()} y @ref{6a4,,create_connection()}.

@item 
`sslcontext': una instancia configurada de @ref{1fa,,SSLContext}.

@item 
`server_side' pasa @cite{True} cuando se actualiza una conexión del lado del servidor (como en el caso de una creada por @ref{b9e,,create_server()}).

@item 
`server_hostname': establece o reemplaza el nombre del host contra el cual se compara el certificado del servidor de destino.

@item 
`ssl_handshake_timeout' es (para una conexión TLS) el tiempo en segundos a esperar que se complete el `handshake' TLS antes de abortar la conexión. @code{60.0} segundos si es @code{None} (predefinido).

@item 
`ssl_shutdown_timeout' es el tiempo en segundos a esperar a que se complete el apagado SSL antes de abortar la conexión. @code{30.0} segundos si es @code{None} (predefinido).
@end itemize


Added in version 3.7.



Distinto en la versión 3.11: Agregado el parámetro `ssl_shutdown_timeout'.

@end deffn

@node Viendo descriptores de archivos,Trabajar con objetos sockets directamente,Actualización de TLS,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop watching-file-descriptors}@anchor{329c}
@subsubsection Viendo descriptores de archivos


@geindex add_reader() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop add_reader}@anchor{3224}
@deffn {Método} loop.add_reader (fd, callback, *args)

Empieza a monitorear el descriptor de archivos `fd' para disponibilidad de lectura e invoca `callback' con los argumentos especificados una vez que `fd' está habilitado para ser leído.
@end deffn

@geindex remove_reader() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_reader}@anchor{329d}
@deffn {Método} loop.remove_reader (fd)

Stop monitoring the `fd' file descriptor for read availability. Returns
@code{True} if `fd' was previously being monitored for reads.
@end deffn

@geindex add_writer() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop add_writer}@anchor{329e}
@deffn {Método} loop.add_writer (fd, callback, *args)

Empieza a monitorear el descriptor de archivos `fd' para disponibilidad de escritura e invoca `callback' con los argumentos especificados una vez que `fd' está habilitado para ser escrito.

Use @ref{17a,,functools.partial()} @ref{3289,,para pasar argumentos de palabra clave} a `callback'.
@end deffn

@geindex remove_writer() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_writer}@anchor{329f}
@deffn {Método} loop.remove_writer (fd)

Stop monitoring the `fd' file descriptor for write availability. Returns
@code{True} if `fd' was previously being monitored for writes.
@end deffn

Vea también la sección @ref{32a0,,Soporte de plataforma} para algunas limitaciones de estos métodos.

@node Trabajar con objetos sockets directamente,DNS,Viendo descriptores de archivos,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop working-with-socket-objects-directly}@anchor{32a1}
@subsubsection Trabajar con objetos sockets directamente


En general, implementaciones de protocolo que usen APIs basadas en transporte como @ref{6a4,,loop.create_connection()} y @ref{b9e,,loop.create_server()} son mas rápidas que aquellas implementaciones que trabajan con directamente con sockets. De cualquier forma, hay algunos casos de uso en los cuales el rendimiento no es crítico, y trabajar directamente con objetos @ref{e27,,socket} es mas conveniente.

@geindex sock_recv() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recv}@anchor{c99}
@deffn {Método} coroutine loop.sock_recv (sock, nbytes)

Recibe hasta `nbytes' de `sock'. Versión asíncrona de @ref{e2a,,socket.recv()}.

Retorna los datos recibidos como un objeto bytes.

`sock' debe ser un socket no bloqueante.


Distinto en la versión 3.7: A pesar de que este método siempre fue documentado como un método de corrutina, los lanzamientos previos a Python 3.7 retornaban un @ref{c55,,Future}. Desde Python 3.7 este es un método @code{async def}.

@end deffn

@geindex sock_recv_into() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recv_into}@anchor{b95}
@deffn {Método} coroutine loop.sock_recv_into (sock, buf)

Recibe datos desde `sock' en el búfer `buf'. Modelado después del método bloqueante @ref{1385,,socket.recv_into()}.

Retorna el número de bytes escritos en el búfer.

`sock' debe ser un socket no bloqueante.


Added in version 3.7.

@end deffn

@geindex sock_recvfrom() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom}@anchor{6a7}
@deffn {Método} coroutine loop.sock_recvfrom (sock, bufsize)

Recibe un datagrama de hasta `bufsize' de `sock'.  Versión asíncrona de @ref{e2b,,socket.recvfrom()}.

Retorna una tupla de (datos recibidos, dirección remota).

`sock' debe ser un socket no bloqueante.


Added in version 3.11.

@end deffn

@geindex sock_recvfrom_into() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom_into}@anchor{6a8}
@deffn {Método} coroutine loop.sock_recvfrom_into (sock, buf, nbytes=0)

Recibe un datagrama de hasta `nbytes' de `sock' en `buf'. Versión asíncrona de @ref{1386,,socket.recvfrom_into()}.

Retorna una dupla de (número de bytes recibidos, dirección remota).

`sock' debe ser un socket no bloqueante.


Added in version 3.11.

@end deffn

@geindex sock_sendall() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendall}@anchor{c9a}
@deffn {Método} coroutine loop.sock_sendall (sock, data)

Envía `data' al socket `sock'. Versión asíncrona de @ref{e2e,,socket.sendall()}.

Este método continua enviando al socket hasta que se hayan enviado todos los datos en `data' u ocurra un error. @code{None} es retornado cuando se tiene éxito. Cuando ocurre un error, se lanza una excepción. Adicionalmente, no hay manera de determinar cuantos datos, si es que se hubo alguno, se procesaron correctamente por el extremo receptor de la conexión.

`sock' debe ser un socket no bloqueante.


Distinto en la versión 3.7: A pesar de que este método siempre fue documentado como un método de corrutina, antes de Python 3.7 retorna un @ref{c55,,Future}. Desde Python 3.7, este es un método @code{async def}.

@end deffn

@geindex sock_sendto() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendto}@anchor{6a6}
@deffn {Método} coroutine loop.sock_sendto (sock, data, address)

Envía un datagrama desde `sock' a `address'. Versión asíncrona de @ref{e2f,,socket.sendto()}.

Retorna el número de bytes enviados.

`sock' debe ser un socket no bloqueante.


Added in version 3.11.

@end deffn

@geindex sock_connect() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_connect}@anchor{e4f}
@deffn {Método} coroutine loop.sock_connect (sock, address)

Conecta `sock' a un socket remoto en `address'.

Versión asíncrona de @ref{e29,,socket.connect()}.

`sock' debe ser un socket no bloqueante.


Distinto en la versión 3.5.2: @code{address} ya no necesita ser resuelto. @code{sock_connect} va a intentar verificar si `address' ya fue resuelto a partir del llamado de @ref{9f5,,socket.inet_pton()}. Si no lo fue, se utilizará @ref{c9c,,loop.getaddrinfo()} ara resolver `address'.



@subsubheading Ver también


@ref{6a4,,loop.create_connection()} y @ref{ba3,,asyncio.open_connection()}.

@end deffn

@geindex sock_accept() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_accept}@anchor{c9b}
@deffn {Método} coroutine loop.sock_accept (sock)

Acepta una conexión. Modelado después del método bloqueante @ref{e28,,socket.accept()}.

The socket must be bound to an address and listening
for connections. The return value is a pair @code{(conn, address)} where `conn'
is a `new' socket object usable to send and receive data on the connection,
and `address' is the address bound to the socket on the other end of the
connection.

`sock' debe ser un socket no bloqueante.


Distinto en la versión 3.7: A pesar de que este método siempre fue documentado como un método de corrutina, antes de Python 3.7 retorna un @ref{c55,,Future}. Desde Python 3.7, este es un método @code{async def}.



@subsubheading Ver también


@ref{b9e,,loop.create_server()} y @ref{ba4,,start_server()}.

@end deffn

@geindex sock_sendfile() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendfile}@anchor{b99}
@deffn {Método} coroutine loop.sock_sendfile (sock, file, offset=0, count=None, *, fallback=True)

Envía un archivo usando @ref{b9a,,os.sendfile} de alto rendimiento si es posible. Retorna el número total de bytes enviados.

Versión asíncrona de @ref{edd,,socket.sendfile()}.

`sock' debe ser un @ref{135a,,socket.SOCK_STREAM} @ref{e27,,socket} no bloqueante.

`file' debe ser un objeto de archivo regular abierto en modo binario.

`offset' indica desde donde se empezará a leer el archivo. Si es especificado, `count' es el número total de bytes a transmitir en contraposición con enviar el archivo hasta que se alcance EOF. La posición del archivo es actualizada siempre, incluso cuando este método genere un error, y @ref{29aa,,file.tell()} puede ser usado para obtener el número de bytes enviados hasta el momento.

`fallback', cuando es establecida como @code{True}, hace que asyncio lea y escriba el archivo manualmente cuando el sistema no soporta la llamada de envío de archivos del sistema (por ejemplo, Windows o sockets SSL en Unix).

Lanza @ref{3278,,SendfileNotAvailableError} si el sistema no soporta la llamada de envío de archivos del sistema `sendfile' y `fallback' es @code{False}.

`sock' debe ser un socket no bloqueante.


Added in version 3.7.

@end deffn

@node DNS,Trabajando con tuberías,Trabajar con objetos sockets directamente,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop dns}@anchor{32a2}
@subsubsection DNS


@geindex getaddrinfo() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop getaddrinfo}@anchor{c9c}
@deffn {Método} coroutine loop.getaddrinfo (host, port, *, family=0, type=0, proto=0, flags=0)

Versión asíncrona de @ref{175a,,socket.getaddrinfo()}.
@end deffn

@geindex getnameinfo() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop getnameinfo}@anchor{c9d}
@deffn {Método} coroutine loop.getnameinfo (sockaddr, flags=0)

Asynchronous version of @ref{16cd,,socket.getnameinfo()}.
@end deffn

@cartouche
@quotation Nota 
Both `getaddrinfo' and `getnameinfo' internally utilize their synchronous
versions through the loop’s default thread pool executor.
When this executor is saturated, these methods may experience delays,
which higher-level networking libraries may report as increased timeouts.
To mitigate this, consider using a custom executor for other user tasks,
or setting a default executor with a larger number of workers.
@end quotation
@end cartouche


Distinto en la versión 3.7: Ambos métodos `getaddrinfo' y `getnameinfo' siempre fueron documentados para retornar una corrutina, pero antes de Python 3.7 retornaban, de hecho, objetos @ref{c55,,Future}. A partir de Python 3.7, ambos métodos son corrutinas.


@node Trabajando con tuberías,Señales Unix,DNS,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop working-with-pipes}@anchor{32a3}
@subsubsection Trabajando con tuberías


@geindex connect_read_pipe() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_read_pipe}@anchor{324c}
@deffn {Método} coroutine loop.connect_read_pipe (protocol_factory, pipe)

Registra el fin de lectura de `pipe' en el bucle de eventos.

`protocol_factory' debe ser un ejecutable que retorna una implementación del @ref{328f,,asyncio protocol}.

`pipe' es un @ref{1230,,objeto de tipo archivo}.

Retorna un par @code{(transport, protocol)}, donde `transport'  soporta la interface @ref{32a4,,ReadTransport} y `protocol' es un objeto instanciado por `protocol_factory'.

Con el bucle de eventos @ref{6a9,,SelectorEventLoop}, el `pipe' es establecido en modo no bloqueante.
@end deffn

@geindex connect_write_pipe() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_write_pipe}@anchor{324d}
@deffn {Método} coroutine loop.connect_write_pipe (protocol_factory, pipe)

Registra el fin de escritura de `pipe' en el bucle de eventos.

`protocol_factory' debe ser un ejecutable que retorna una implementación del @ref{328f,,asyncio protocol}.

`pipe' es un @ref{1230,,objeto de tipo archivo}.

Retorna un par @code{(transport, protocol)}, donde `transport' soporta la interface @ref{32a5,,WriteTransport} y `protocol' es un objeto inicializado por `protocol_factory'.

Con el bucle de eventos @ref{6a9,,SelectorEventLoop}, el `pipe' es establecido en modo no bloqueante.
@end deffn

@cartouche
@quotation Nota 
@ref{6a9,,SelectorEventLoop} no soporta los métodos anteriores en windows. En su lugar, use @ref{6aa,,ProactorEventLoop} para Windows.
@end quotation
@end cartouche


@subsubheading Ver también


Los métodos @ref{3249,,loop.subprocess_exec()} y @ref{324a,,loop.subprocess_shell()}.


@node Señales Unix,Ejecutando código en un hilos o grupos de procesos,Trabajando con tuberías,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop unix-signals}@anchor{32a6}
@subsubsection Señales Unix


@geindex add_signal_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop loop-add-signal-handler}@anchor{31cb}@anchor{library/asyncio-eventloop asyncio loop add_signal_handler}@anchor{32a7}
@deffn {Método} loop.add_signal_handler (signum, callback, *args)

Establece `callback' como el gestor para la señal `signum'.

La llamada será invocada por `loop', junto con otras llamadas encoladas y corrutinas ejecutables de ese bucle de eventos. A menos que los gestores de señal la registren usando @ref{11a6,,signal.signal()}, una llamada registrada con esta función tiene permitido interactuar con el bucle de eventos.

Lanza @ref{360,,ValueError} si el número de señal es invalido o inalcanzable. Lanza @ref{1e5,,RuntimeError} si hay algún problema preparando el gestor.

Use @ref{17a,,functools.partial()} @ref{3289,,para pasar argumentos de palabra clave} a `callback'.

Como @ref{11a6,,signal.signal()}, esta función debe ser invocada en el hilo principal.
@end deffn

@geindex remove_signal_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_signal_handler}@anchor{32a8}
@deffn {Método} loop.remove_signal_handler (sig)

Elimina el gestor para la señal `sig'.

Retorna @code{True} si el gestor de señal fue eliminado, o @code{False} si no se estableció gestor para la señal dada.

@ref{1d5a,,Availability}: Unix.
@end deffn


@subsubheading Ver también


El módulo @ref{c6,,signal}.


@node Ejecutando código en un hilos o grupos de procesos,API para manejo de errores,Señales Unix,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop executing-code-in-thread-or-process-pools}@anchor{32a9}
@subsubsection Ejecutando código en un hilos o grupos de procesos


@geindex run_in_executor() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_in_executor}@anchor{980}
@deffn {Método} awaitable loop.run_in_executor (executor, func, *args)

Hace arreglos para que `func' sea llamado en el ejecutor especificado.

The `executor' argument should be an @ref{3119,,concurrent.futures.Executor}
instance. The default executor is used if `executor' is @code{None}.
The default executor can be set by @ref{7de,,loop.set_default_executor()},
otherwise, a @ref{7dd,,concurrent.futures.ThreadPoolExecutor} will be
lazy-initialized and used by @ref{980,,run_in_executor()} if needed.

Ejemplo:

@example
import asyncio
import concurrent.futures

def blocking_io():
    # File operations (such as logging) can block the
    # event loop: run them in a thread pool.
    with open('/dev/urandom', 'rb') as f:
        return f.read(100)

def cpu_bound():
    # CPU-bound operations will block the event loop:
    # in general it is preferable to run them in a
    # process pool.
    return sum(i * i for i in range(10 ** 7))

async def main():
    loop = asyncio.get_running_loop()

    ## Options:

    # 1. Run in the default loop's executor:
    result = await loop.run_in_executor(
        None, blocking_io)
    print('default thread pool', result)

    # 2. Run in a custom thread pool:
    with concurrent.futures.ThreadPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, blocking_io)
        print('custom thread pool', result)

    # 3. Run in a custom process pool:
    with concurrent.futures.ProcessPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, cpu_bound)
        print('custom process pool', result)

    # 4. Run in a custom interpreter pool:
    with concurrent.futures.InterpreterPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, cpu_bound)
        print('custom interpreter pool', result)

if __name__ == '__main__':
    asyncio.run(main())
@end example

Tenga en cuenta que la protección del punto de entrada (@code{if __name__ == '__main__'}) es requerida para la opción 3 debido a las peculiaridades de @ref{94,,multiprocessing}, que es utilizado por @ref{163,,ProcessPoolExecutor}. Vea @ref{3105,,Importación segura del módulo principal}.

Este método retorna un objeto @ref{c55,,asyncio.Future}.

Use @ref{17a,,functools.partial()} @ref{3289,,para pasar argumentos de palabra clave} a `func'.


Distinto en la versión 3.5.3: @ref{980,,loop.run_in_executor()} ya no configura el @code{max_workers} del ejecutor del grupo de subprocesos que crea, sino que lo deja en manos del ejecutor del grupo de subprocesos (@ref{7dd,,ThreadPoolExecutor}) para establecer el valor por defecto.

@end deffn

@geindex set_default_executor() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_default_executor}@anchor{7de}
@deffn {Método} loop.set_default_executor (executor)

Set `executor' as the default executor used by @ref{980,,run_in_executor()}.
`executor' must be an instance of
@ref{7dd,,ThreadPoolExecutor}, which includes
@ref{161,,InterpreterPoolExecutor}.


Distinto en la versión 3.11: `executor' debe ser una instancia de @ref{7dd,,ThreadPoolExecutor}.

@end deffn

@node API para manejo de errores,Habilitando el modo depuración,Ejecutando código en un hilos o grupos de procesos,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop error-handling-api}@anchor{32aa}
@subsubsection API para manejo de errores


Permite personalizar como son manejadas las excepciones en el bucle de eventos.

@geindex set_exception_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_exception_handler}@anchor{32ab}
@deffn {Método} loop.set_exception_handler (handler)

Establece `handler' como el nuevo gestor de excepciones del bucle de eventos.

Si `handler' es @code{None}, se establecerá el gestor de excepciones predeterminado. De otro modo, `handler' debe ser un invocable con la misma firma @code{(loop, context)}, donde @code{loop} es una referencia al bucle de eventos activo, y @code{context} es un objeto @code{dict} que contiene los detalles de la excepción (vea la documentación de @ref{32ac,,call_exception_handler()} para detalles acerca del contexto).

If the handler is called on behalf of a @ref{580,,Task} or
@ref{1aaa,,Handle}, it is run in the
@ref{15a0,,contextvars.Context} of that task or callback handle.


Distinto en la versión 3.12: The handler may be called in the @ref{15a0,,Context}
of the task or handle where the exception originated.

@end deffn

@geindex get_exception_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_exception_handler}@anchor{d02}
@deffn {Método} loop.get_exception_handler ()

Retorna el gesto de excepciones actual, o @code{None} si no fue establecido ningún gestor de excepciones personalizado.


Added in version 3.5.2.

@end deffn

@geindex default_exception_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop default_exception_handler}@anchor{32ad}
@deffn {Método} loop.default_exception_handler (context)

Gestor de excepciones por defecto.

Esto es llamado cuando ocurre una excepción y no se estableció ningún gestor de excepciones. Esto puede ser llamado por un gestor de excepciones personalizado que quiera cambiar el comportamiento del gestor predeterminado.

El parámetro `context' tiene el mismo significado que en @ref{32ac,,call_exception_handler()}.
@end deffn

@geindex call_exception_handler() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_exception_handler}@anchor{32ac}
@deffn {Método} loop.call_exception_handler (context)

Llama al gestor de excepciones del bucle de eventos actual.

`context' es un objeto @code{dict} conteniendo las siguientes claves (en futuras versiones de Python podrían introducirse nuevas claves):


@itemize *

@item 
“message”: Mensaje de error;

@item 
“exception” (opcional): Objeto de excepción;

@item 
“future” (opcional): instancia de @ref{c55,,asyncio.Future};

@item 
“task” (opcional): instancia de @ref{580,,asyncio.Task};

@item 
“handle” (opcional): instancia de @ref{1aaa,,asyncio.Handle};

@item 
“protocol” (opcional): instancia de @ref{328f,,Protocol};

@item 
“transport” (opcional): instancia de @ref{3290,,Transport};

@item 
“socket” (opcional): instancia de @ref{e27,,socket.socket};

@item 

@table @asis

@item “asyncgen” (opcional): Generador asíncrono que causó

la excepción.
@end table
@end itemize

@cartouche
@quotation Nota 
This method should not be overloaded in subclassed
event loops.  For custom exception handling, use
the @ref{32ab,,set_exception_handler()} method.
@end quotation
@end cartouche
@end deffn

@node Habilitando el modo depuración,Ejecutando subprocesos,API para manejo de errores,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop enabling-debug-mode}@anchor{32ae}
@subsubsection Habilitando el modo depuración


@geindex get_debug() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_debug}@anchor{e48}
@deffn {Método} loop.get_debug ()

Obtiene el modo depuración (@ref{513,,bool}) del bucle de eventos.

El valor predeterminado es @code{True} si la variable de entorno 
@geindex PYTHONASYNCIODEBUG
@geindex variables de entorno; PYTHONASYNCIODEBUG
@ref{1d54,,PYTHONASYNCIODEBUG} es establecida a una cadena no vacía, de otro modo será @code{False}.
@end deffn

@geindex set_debug() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_debug}@anchor{e47}
@deffn {Método} loop.set_debug (enabled: bool)

Establece el modo de depuración del bucle de eventos.


Distinto en la versión 3.7: El nuevo @ref{356,,Python Modo de Desarrollo} ahora también se puede usar para habilitar el modo de depuración.

@end deffn

@geindex slow_callback_duration (atributo de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop slow_callback_duration}@anchor{32af}
@deffn {Atributo} loop.slow_callback_duration

This attribute can be used to set the
minimum execution duration in seconds that is considered «slow».
When debug mode is enabled, «slow» callbacks are logged.

Default value is 100 milliseconds.
@end deffn


@subsubheading Ver también


El @ref{1d55,,modo depuración de asyncio}.


@node Ejecutando subprocesos,,Habilitando el modo depuración,Métodos del bucle de eventos
@anchor{library/asyncio-eventloop running-subprocesses}@anchor{32b0}
@subsubsection Ejecutando subprocesos


Los métodos descritos en esta subsección son de bajo nivel. En código async/await regular considere usar las convenientes funciones de alto nivel @ref{b07,,asyncio.create_subprocess_shell()} y @ref{b06,,asyncio.create_subprocess_exec()}.

@cartouche
@quotation Nota 
En Windows, el bucle de eventos por defecto @ref{6aa,,ProactorEventLoop} soporta subprocesos, mientras que @ref{6a9,,SelectorEventLoop} no. Vea @ref{324b,,Soporte de subprocesos en Windows} para más detalles.
@end quotation
@end cartouche

@geindex subprocess_exec() (método de asyncio.loop)
@anchor{library/asyncio-eventloop loop-subprocess-exec}@anchor{31ca}@anchor{library/asyncio-eventloop asyncio loop subprocess_exec}@anchor{3249}
@deffn {Método} coroutine loop.subprocess_exec (protocol_factory, *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

Crea un subproceso de uno o mas argumentos de cadena especificados por `args'.

`args' debe ser una lista de cadenas representadas por:


@itemize *

@item 
@ref{237,,str};

@item 
o @ref{325,,bytes}, codificados a la @ref{27af,,codificación del sistema de archivos}.
@end itemize

La primer cadena especifica el programa ejecutable, y las cadenas restantes especifican los argumentos. En conjunto, los argumentos de cadena forman el @code{argv} del programa.

Esto es similar a la clase de la librería estándar @ref{301,,subprocess.Popen} llamada con @code{shell=False} y la lista de cadenas pasadas como el primer argumento; de cualquier forma, cuando @ref{301,,Popen} toma un sólo argumento que es una lista de cadenas, `subprocess_exec' toma múltiples cadenas como argumentos.

El `protocol_factory' debe ser un ejecutable que retorne una subclase de la clase @ref{32b1,,asyncio.SubprocessProtocol}.

Otros parámetros:


@itemize *

@item 
`stdin' puede ser cualquier de estos:


@itemize *

@item 
a file-like object

@item 
an existing file descriptor (a positive integer), for example those created with @ref{17e1,,os.pipe()}

@item 
la constante @ref{c0f,,subprocess.PIPE} (predeterminado) que creará una tubería nueva y la conectará,

@item 
el valor @code{None} que hará que el subproceso herede el descriptor de archivo de este proceso

@item 
la constante @ref{11bf,,subprocess.DEVNULL} que indica que el archivo especial @ref{1a3a,,os.devnull} será utilizado
@end itemize

@item 
`stdout' puede ser cualquier de estos:


@itemize *

@item 
a file-like object

@item 
la constante @ref{c0f,,subprocess.PIPE} (predeterminado) que creará una tubería nueva y la conectará,

@item 
el valor @code{None} que hará que el subproceso herede el descriptor de archivo de este proceso

@item 
la constante @ref{11bf,,subprocess.DEVNULL} que indica que el archivo especial @ref{1a3a,,os.devnull} será utilizado
@end itemize

@item 
`stderr' puede ser cualquier de estos:


@itemize *

@item 
a file-like object

@item 
la constante @ref{c0f,,subprocess.PIPE} (predeterminado) que creará una tubería nueva y la conectará,

@item 
el valor @code{None} que hará que el subproceso herede el descriptor de archivo de este proceso

@item 
la constante @ref{11bf,,subprocess.DEVNULL} que indica que el archivo especial @ref{1a3a,,os.devnull} será utilizado

@item 
la constante @ref{313a,,subprocess.STDOUT} que conectará el flujo de errores predeterminado al flujo de salida predeterminado del proceso
@end itemize

@item 
El resto de argumentos de palabra clave son pasados a @ref{301,,subprocess.Popen} sin interpretación, excepto por `bufsize', `universal_newlines', `shell', `text', `encoding' y `errors', que no deben ser especificados en lo absoluto.

La API subproceso @code{asyncio} no soporta decodificar los flujos como texto. @ref{96d,,bytes.decode()} puede ser usado para convertir a texto los bytes retornados por el flujo.
@end itemize

If a file-like object passed as `stdin', `stdout' or `stderr' represents a
pipe, then the other side of this pipe should be registered with
@ref{324d,,connect_write_pipe()} or @ref{324c,,connect_read_pipe()} for use
with the event loop.

Vea el constructor de la clase @ref{301,,subprocess.Popen} para documentación acerca de otros argumentos.

Retorna un par de @code{(transport, protocol)}, donde `transport' se ajusta a la clase base @ref{32b2,,asyncio.SubprocessTransport} y `protocol' es un objeto instanciado por `protocol_factory'.
@end deffn

@geindex subprocess_shell() (método de asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop subprocess_shell}@anchor{324a}
@deffn {Método} coroutine loop.subprocess_shell (protocol_factory, cmd, *, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

Crea un subproceso desde `cmd', que puede ser una cadena @ref{237,,str} o @ref{325,,bytes} codificado a la @ref{27af,,codificación del sistema de archivos}, usando la sintaxis «shell» de la plataforma.

Esto es similar a la clase de la librería estándar @ref{301,,subprocess.Popen} llamada con @code{shell=True}.

El `protocol_factory' debe ser un ejecutable que retorne una subclase de la clase @ref{32b1,,asyncio.SubprocessProtocol}.

Vea @ref{3249,,subprocess_exec()} para mas detalles acerca de los argumentos restantes.

Retorna un par de @code{(transport, protocol)}, donde `transport' se ajusta a la clase base @ref{32b2,,SubprocessTransport} y `protocol' es un objeto instanciado por `protocol_factory'.
@end deffn

@cartouche
@quotation Nota 
Es responsabilidad de la aplicación asegurar que todos los espacios en blanco y caracteres especiales estén escapados correctamente para evitar vulnerabilidades de inyección de código@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection}. La función @ref{3d2,,shlex.quote()} puede ser usada para escapar apropiadamente espacios en blanco y caracteres especiales en cadenas que van a ser usadas para construir comandos de consola.
@end quotation
@end cartouche

@node Gestores de llamadas,Objetos Servidor,Métodos del bucle de eventos,Bucle de eventos
@anchor{library/asyncio-eventloop callback-handles}@anchor{327f}
@subsubsection Gestores de llamadas


@geindex Handle (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio Handle}@anchor{1aaa}
@deffn {Clase} asyncio.Handle

Un objeto de contenedor de llamada retornado por @ref{b8f,,loop.call_soon()}, @ref{b90,,loop.call_soon_threadsafe()}.

@geindex get_context() (método de asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle get_context}@anchor{32b3}
@deffn {Método} get_context ()

Return the @ref{15a0,,contextvars.Context} object
associated with the handle.


Added in version 3.12.

@end deffn

@geindex cancel() (método de asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle cancel}@anchor{32b4}
@deffn {Método} cancel ()

Cancela la llamada. Si la llamada ya fue cancelada o ejecutada, este método no tiene efecto.
@end deffn

@geindex cancelled() (método de asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle cancelled}@anchor{ba5}
@deffn {Método} cancelled ()

Retorna @code{True} si la llamada fue cancelada.


Added in version 3.7.

@end deffn
@end deffn

@geindex TimerHandle (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio TimerHandle}@anchor{1775}
@deffn {Clase} asyncio.TimerHandle

Un objeto de contenedor de llamada retornado por @ref{b91,,loop.call_later()}, and @ref{b92,,loop.call_at()}.

Esta clase es una subclase de @ref{1aaa,,Handle}.

@geindex when() (método de asyncio.TimerHandle)
@anchor{library/asyncio-eventloop asyncio TimerHandle when}@anchor{ba2}
@deffn {Método} when ()

Retorna el tiempo de una llamada planificada como @ref{153,,float} segundos.

El tiempo es una marca de tiempo absoluta, usando la misma referencia de tiempo que @ref{328c,,loop.time()}.


Added in version 3.7.

@end deffn
@end deffn

@node Objetos Servidor,Implementaciones del bucle de eventos,Gestores de llamadas,Bucle de eventos
@anchor{library/asyncio-eventloop server-objects}@anchor{3280}
@subsubsection Objetos Servidor


Los objetos de servidor son creados por las funciones @ref{b9e,,loop.create_server()}, @ref{315,,loop.create_unix_server()}, @ref{ba4,,start_server()}, y @ref{320a,,start_unix_server()}.

Do not instantiate the @ref{b9d,,Server} class directly.

@geindex Server (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio Server}@anchor{b9d}
@deffn {Clase} asyncio.Server

Los objetos `Server' son gestores de asíncronos de contexto. Cuando son usados en una declaración @code{async with}, está garantizado que el objeto Servidor está cerrado y no está aceptando nuevas conexiones cuando la declaración @code{async with} es completada:

@example
srv = await loop.create_server(...)

async with srv:
    # some code

# At this point, srv is closed and no longer accepts new connections.
@end example


Distinto en la versión 3.7: El objeto Servidor es un gestor asíncrono de contexto desde Python 3.7.



Distinto en la versión 3.11: This class was exposed publicly as @code{asyncio.Server} in Python 3.9.11, 3.10.3 and 3.11.


@geindex close() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server close}@anchor{3207}
@deffn {Método} close ()

Deja de servir: deja de escuchar sockets y establece el atributo @ref{c9e,,sockets} a @code{None}.

Los sockets que representan conexiones entrantes existentes de clientes se dejan abiertas.

The server is closed asynchronously; use the @ref{16d3,,wait_closed()}
coroutine to wait until the server is closed (and no more
connections are active).
@end deffn

@geindex close_clients() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server close_clients}@anchor{319}
@deffn {Método} close_clients ()

Close all existing incoming client connections.

Calls @ref{3293,,close()} on all associated
transports.

@ref{3207,,close()} should be called before @ref{319,,close_clients()} when
closing the server to avoid races with new clients connecting.


Added in version 3.13.

@end deffn

@geindex abort_clients() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server abort_clients}@anchor{31a}
@deffn {Método} abort_clients ()

Close all existing incoming client connections immediately,
without waiting for pending operations to complete.

Calls @ref{32b5,,abort()} on all associated
transports.

@ref{3207,,close()} should be called before @ref{31a,,abort_clients()} when
closing the server to avoid races with new clients connecting.


Added in version 3.13.

@end deffn

@geindex get_loop() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server get_loop}@anchor{b9c}
@deffn {Método} get_loop ()

Retorna el bucle de eventos asociado con el objeto Servidor.


Added in version 3.7.

@end deffn

@geindex start_serving() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server start_serving}@anchor{b9f}
@deffn {Método} coroutine start_serving ()

Comienza a aceptar conexiones.

Este método es idempotente, así que puede ser llamado cuando el servidor ya está sirviendo.

El parámetro sólo de palabra clave `start_serving' de @ref{b9e,,loop.create_server()} y @ref{ba4,,asyncio.start_server()} permite crear un objeto Servidor que no está aceptando conexiones inicialmente. En este caso @code{Server.start_serving()}, o @ref{ba0,,Server.serve_forever()} pueden ser usados para hacer que el servidor empiece a aceptar conexiones.


Added in version 3.7.

@end deffn

@geindex serve_forever() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server serve_forever}@anchor{ba0}
@deffn {Método} coroutine serve_forever ()

Comienza a aceptar conexiones hasta que la corrutina sea cancelada. La cancelación de la tarea @code{serve_forever} hace que el servidor sea cerrado.

Este método puede ser llamado si el servidor ya está aceptando conexiones. Solamente una tarea @code{serve_forever} puede existir para un objeto `Server'.

Ejemplo:

@example
async def client_connected(reader, writer):
    # Communicate with the client with
    # reader/writer streams.  For example:
    await reader.readline()

async def main(host, port):
    srv = await asyncio.start_server(
        client_connected, host, port)
    await srv.serve_forever()

asyncio.run(main('127.0.0.1', 0))
@end example


Added in version 3.7.

@end deffn

@geindex is_serving() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server is_serving}@anchor{ba1}
@deffn {Método} is_serving ()

Retorna @code{True} si el servidor está aceptando nuevas conexiones.


Added in version 3.7.

@end deffn

@geindex wait_closed() (método de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server wait_closed}@anchor{16d3}
@deffn {Método} coroutine wait_closed ()

Wait until the @ref{3207,,close()} method completes and all active
connections have finished.
@end deffn

@geindex sockets (atributo de asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server sockets}@anchor{c9e}
@deffn {Atributo} sockets

List of socket-like objects, @code{asyncio.trsock.TransportSocket}, which
the server is listening on.


Distinto en la versión 3.7: Antes de Python 3.7 @code{Server.sockets} solía retornar directamente una lista interna de servidores socket. En 3.7 se retorna una copia de esa lista.

@end deffn
@end deffn
@anchor{library/asyncio-eventloop asyncio-event-loops}@anchor{32b6}
@node Implementaciones del bucle de eventos,Examples<2>,Objetos Servidor,Bucle de eventos
@anchor{library/asyncio-eventloop asyncio-event-loop-implementations}@anchor{32b7}@anchor{library/asyncio-eventloop event-loop-implementations}@anchor{3281}
@subsubsection Implementaciones del bucle de eventos


asyncio viene con dos implementaciones diferentes del bucle de eventos: @ref{6a9,,SelectorEventLoop} y @ref{6aa,,ProactorEventLoop}.

By default asyncio is configured to use @ref{16fc,,EventLoop}.

@geindex SelectorEventLoop (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio SelectorEventLoop}@anchor{6a9}
@deffn {Clase} asyncio.SelectorEventLoop

A subclass of @ref{9f2,,AbstractEventLoop} based on the
@ref{c2,,selectors} module.

Usa el `selector' disponible mas eficiente para la plataforma dada. También es posible configurar manualmente la implementación exacta del selector a utilizar:

@example
import asyncio
import selectors

class MyPolicy(asyncio.DefaultEventLoopPolicy):
   def new_event_loop(self):
      selector = selectors.SelectSelector()
      return asyncio.SelectorEventLoop(selector)

asyncio.set_event_loop_policy(MyPolicy())
@end example

@ref{1d5a,,Availability}: Unix, Windows.
@end deffn

@geindex ProactorEventLoop (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio ProactorEventLoop}@anchor{6aa}
@deffn {Clase} asyncio.ProactorEventLoop

A subclass of @ref{9f2,,AbstractEventLoop} for Windows that uses «I/O Completion Ports» (IOCP).

@ref{1d5a,,Availability}: Windows.


@subsubheading Ver también


MSDN documentation on I/O Completion Ports@footnote{https://learn.microsoft.com/windows/win32/fileio/i-o-completion-ports}.

@end deffn

@geindex EventLoop (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio EventLoop}@anchor{16fc}
@deffn {Clase} asyncio.EventLoop

@quotation

An alias to the most efficient available subclass of @ref{9f2,,AbstractEventLoop} for the given
platform.

It is an alias to @ref{6a9,,SelectorEventLoop} on Unix and @ref{6aa,,ProactorEventLoop} on Windows.
@end quotation


Added in version 3.13.

@end deffn

@geindex AbstractEventLoop (clase en asyncio)
@anchor{library/asyncio-eventloop asyncio AbstractEventLoop}@anchor{9f2}
@deffn {Clase} asyncio.AbstractEventLoop

Clase base abstracta para bucles de evento compatibles con asyncio.

La sección @ref{3283,,Métodos del bucle de eventos} lista todos los métodos que una implementación alternativa de @code{AbstractEventLoop} debería tener definidos.
@end deffn

@node Examples<2>,,Implementaciones del bucle de eventos,Bucle de eventos
@anchor{library/asyncio-eventloop examples}@anchor{3282}
@subsubsection Examples


Nótese que todos los ejemplos en esta sección muestran `a propósito' como usar las APIs de bucle de eventos de bajo nivel, como ser @ref{3285,,loop.run_forever()} y @ref{b8f,,loop.call_soon()}. Aplicaciones asyncio modernas raramente necesitan ser escritas de esta manera; considere utilizar funciones de alto nivel como @ref{525,,asyncio.run()}.

@menu
* Hola Mundo con call_soon(): Hola Mundo con call_soon. 
* Muestra la fecha actual con call_later(): Muestra la fecha actual con call_later. 
* Mirar un descriptor de archivo para leer eventos:: 
* Establece los gestores de señal para SIGINT y SIGTERM:: 

@end menu

@node Hola Mundo con call_soon,Muestra la fecha actual con call_later,,Examples<2>
@anchor{library/asyncio-eventloop asyncio-example-lowlevel-helloworld}@anchor{32b8}@anchor{library/asyncio-eventloop hello-world-with-call-soon}@anchor{32b9}
@subsubsection Hola Mundo con call_soon()


Un ejemplo usando el método @ref{b8f,,loop.call_soon()} para planificar una llamada. La llamada muestra @code{"Hello World"} y luego para el bucle de eventos:

@example
import asyncio

def hello_world(loop):
    """A callback to print 'Hello World' and stop the event loop"""
    print('Hello World')
    loop.stop()

loop = asyncio.new_event_loop()

# Schedule a call to hello_world()
loop.call_soon(hello_world, loop)

# Blocking call interrupted by loop.stop()
try:
    loop.run_forever()
finally:
    loop.close()
@end example


@subsubheading Ver también


Un ejemplo similar de @ref{31c4,,Hola Mundo} creado con una corrutina y la función @ref{525,,run()}.


@node Muestra la fecha actual con call_later,Mirar un descriptor de archivo para leer eventos,Hola Mundo con call_soon,Examples<2>
@anchor{library/asyncio-eventloop asyncio-example-call-later}@anchor{32ba}@anchor{library/asyncio-eventloop display-the-current-date-with-call-later}@anchor{32bb}
@subsubsection Muestra la fecha actual con call_later()


Un ejemplo de llamada mostrando la fecha actual cada un segundo. La llamada usa el método @ref{b91,,loop.call_later()} para volver a planificarse después de 5 segundos, y después para el bucle de eventos:

@example
import asyncio
import datetime

def display_date(end_time, loop):
    print(datetime.datetime.now())
    if (loop.time() + 1.0) < end_time:
        loop.call_later(1, display_date, end_time, loop)
    else:
        loop.stop()

loop = asyncio.new_event_loop()

# Schedule the first call to display_date()
end_time = loop.time() + 5.0
loop.call_soon(display_date, end_time, loop)

# Blocking call interrupted by loop.stop()
try:
    loop.run_forever()
finally:
    loop.close()
@end example


@subsubheading Ver también


Un ejemplo similar a @ref{31e2,,fecha actual} creado con una corrutina y la función @ref{525,,run()}.


@node Mirar un descriptor de archivo para leer eventos,Establece los gestores de señal para SIGINT y SIGTERM,Muestra la fecha actual con call_later,Examples<2>
@anchor{library/asyncio-eventloop asyncio-example-watch-fd}@anchor{3223}@anchor{library/asyncio-eventloop watch-a-file-descriptor-for-read-events}@anchor{32bc}
@subsubsection Mirar un descriptor de archivo para leer eventos


Espera hasta que el descriptor de archivo reciba algún dato usando el método @ref{3224,,loop.add_reader()} y entonces cierra el bucle de eventos:

@example
import asyncio
from socket import socketpair

# Create a pair of connected file descriptors
rsock, wsock = socketpair()

loop = asyncio.new_event_loop()

def reader():
    data = rsock.recv(100)
    print("Received:", data.decode())

    # We are done: unregister the file descriptor
    loop.remove_reader(rsock)

    # Stop the event loop
    loop.stop()

# Register the file descriptor for read event
loop.add_reader(rsock, reader)

# Simulate the reception of data from the network
loop.call_soon(wsock.send, 'abc'.encode())

try:
    # Run the event loop
    loop.run_forever()
finally:
    # We are done. Close sockets and the event loop.
    rsock.close()
    wsock.close()
    loop.close()
@end example


@subsubheading Ver también



@itemize *

@item 
Un @ref{3222,,ejemplo} similar usando transportes, protocolos y el método @ref{6a4,,loop.create_connection()}.

@item 
Otro @ref{3220,,ejemplo} similar usando la función de alto nivel @ref{ba3,,asyncio.open_connection()} y transmisiones.
@end itemize


@node Establece los gestores de señal para SIGINT y SIGTERM,,Mirar un descriptor de archivo para leer eventos,Examples<2>
@anchor{library/asyncio-eventloop asyncio-example-unix-signals}@anchor{32bd}@anchor{library/asyncio-eventloop set-signal-handlers-for-sigint-and-sigterm}@anchor{32be}
@subsubsection Establece los gestores de señal para SIGINT y SIGTERM


(Este ejemplo de @code{signals} solamente funcionan en Unix.)

Register handlers for signals @ref{8db,,SIGINT} and @ref{141f,,SIGTERM}
using the @ref{32a7,,loop.add_signal_handler()} method:

@example
import asyncio
import functools
import os
import signal

def ask_exit(signame, loop):
    print("got signal %s: exit" % signame)
    loop.stop()

async def main():
    loop = asyncio.get_running_loop()

    for signame in @{'SIGINT', 'SIGTERM'@}:
        loop.add_signal_handler(
            getattr(signal, signame),
            functools.partial(ask_exit, signame, loop))

    await asyncio.sleep(3600)

print("Event loop running for 1 hour, press Ctrl+C to interrupt.")
print(f"pid @{os.getpid()@}: send SIGINT or SIGTERM to exit.")

asyncio.run(main())
@end example

@node Futures,Transportes y protocolos,Bucle de eventos,asyncio — Asynchronous I/O
@anchor{library/asyncio-future doc}@anchor{32bf}@anchor{library/asyncio-future asyncio-futures}@anchor{31cd}@anchor{library/asyncio-future futures}@anchor{32c0}
@subsubsection Futures


`Código fuente:' Lib/asyncio/futures.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/futures.py}, Lib/asyncio/base_futures.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/base_futures.py}


__________________________________________________________________


Los objetos `Future' se utilizan para conectar `código basado en retrollamadas de bajo nivel' (`low-level callback-based code') con código `async/await' de alto nivel.

@menu
* Funciones Future:: 
* Objeto Future:: 

@end menu

@node Funciones Future,Objeto Future,,Futures
@anchor{library/asyncio-future future-functions}@anchor{32c1}
@subsubsection Funciones Future


@geindex isfuture() (en el módulo asyncio)
@anchor{library/asyncio-future asyncio isfuture}@anchor{32c2}
@deffn {Función} asyncio.isfuture (obj)

Retorna @code{True} si `obj' es uno de los siguientes:


@itemize *

@item 
una instancia de @ref{c55,,asyncio.Future},

@item 
una instancia de @ref{580,,asyncio.Task},

@item 
un objeto tipo Future con un atributo @code{_asyncio_future_blocking}.
@end itemize


Added in version 3.5.

@end deffn

@geindex ensure_future() (en el módulo asyncio)
@anchor{library/asyncio-future asyncio ensure_future}@anchor{cfe}
@deffn {Función} asyncio.ensure_future (obj, *, loop=None)

Retorna:


@itemize *

@item 
el argumento `obj' inalterado, si `obj' es una @ref{c55,,Future}, @ref{580,,Task}, o un objeto tipo Future (esto se puede verificar con @ref{32c2,,isfuture()}.)

@item 
un objeto @ref{580,,Task} envolviendo `obj', si `obj' es una corrutina (esto se puede verificar con @ref{527,,iscoroutine()}); en este caso, la corrutina será programada por @code{ensure_future()}.

@item 
un objeto @ref{580,,Task} que aguardará a `obj', si `obj' es aguardable (esto se puede verificar con @ref{e9c,,inspect.isawaitable()}.)
@end itemize

Si `obj' no es ninguno de los superiores, se lanzará @ref{228,,TypeError}.

@cartouche
@quotation Importante 
Ver también la función @ref{69d,,create_task()}, que es la forma preferida de crear nuevas `Tasks'.

Guarda una referencia al resultado de esta función, evita que una tarea desaparezca a mitad de su ejecución.
@end quotation
@end cartouche


Distinto en la versión 3.5.1: La función acepta cualquier objeto @ref{314,,awaitable}.



Obsoleto desde la versión 3.10: Se emite una advertencia de desaprobación si `obj' no es un objeto tipo Future y no se especifica `loop' y no hay un bucle de eventos en ejecución.

@end deffn

@geindex wrap_future() (en el módulo asyncio)
@anchor{library/asyncio-future asyncio wrap_future}@anchor{18cd}
@deffn {Función} asyncio.wrap_future (future, *, loop=None)

Envuelve un objeto @ref{1220,,concurrent.futures.Future} en un objeto @ref{c55,,asyncio.Future}.


Obsoleto desde la versión 3.10: Se emite una advertencia de desaprobación si `future' no es un objeto tipo Future y `loop' no se especifica y no hay un bucle de eventos en ejecución.

@end deffn

@node Objeto Future,,Funciones Future,Futures
@anchor{library/asyncio-future future-object}@anchor{32c3}
@subsubsection Objeto Future


@geindex Future (clase en asyncio)
@anchor{library/asyncio-future asyncio Future}@anchor{c55}
@deffn {Clase} asyncio.Future (*, loop=None)

Un Future representa un resultado eventual de una operación asíncrona. No es seguro en hilos (`thread-safe').

Future es un objeto @ref{314,,awaitable}. Las corrutinas pueden esperar a objetos Future hasta que obtengan un resultado o excepción, o hasta que se cancelen. Un Future puede esperarse varias veces y el resultado es el mismo.

Normalmente, los Futures se utilizan para permitir que código basado en retrollamadas de bajo nivel (`low-level callback-based code') (por ejemplo, en protocolos implementados utilizando `asyncio' @ref{31cc,,transports}) interactúe con código `async/await' de alto nivel.

Es recomendable no exponer nunca objetos Future en APIs expuestas al usuario, y la forma recomendada de crear un objeto Future es llamando a @ref{d01,,loop.create_future()}. De esta forma, implementaciones alternativas de bucles de eventos (`event loop') pueden inyectar sus propias implementaciones optimizadas de un objeto Future.


Distinto en la versión 3.7: Añadido soporte para el módulo @ref{25,,contextvars}.



Obsoleto desde la versión 3.10: Se emite una advertencia de desaprobación si no se especifica `loop' y no hay un bucle de eventos en ejecución.


@geindex result() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future result}@anchor{32c4}
@deffn {Método} result ()

Retorna el resultado del Future.

Si el Future es `done' y tiene un resultado establecido por el método @ref{31f7,,set_result()}, el valor resultante es retornado.

Si el Future es `done' y tiene una excepción establecida por el método @ref{31f8,,set_exception()}, este método lanzará esta excepción.

Si un evento es `cancelled', este método lanzará una excepción @ref{31f,,CancelledError}.

If the Future’s result isn’t yet available, this method raises
an @ref{31fb,,InvalidStateError} exception.
@end deffn

@geindex set_result() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future set_result}@anchor{31f7}
@deffn {Método} set_result (result)

Marca el Future como `done' y establece su resultado.

Raises an @ref{31fb,,InvalidStateError} error if the Future is
already `done'.
@end deffn

@geindex set_exception() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future set_exception}@anchor{31f8}
@deffn {Método} set_exception (exception)

Marca el Future como `done' y establece una excepción.

Raises an @ref{31fb,,InvalidStateError} error if the Future is
already `done'.
@end deffn

@geindex done() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future done}@anchor{32c5}
@deffn {Método} done ()

Retorna @code{True} si el Future está `done'.

Un Future está `done' si estaba `cancelled' o si tiene un resultado o excepción establecidos mediante llamadas a @ref{31f7,,set_result()} o @ref{31f8,,set_exception()}.
@end deffn

@geindex cancelled() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future cancelled}@anchor{32c6}
@deffn {Método} cancelled ()

Retorna @code{True} si el Future fue `cancelled'.

El método suele utilizarse para comprobar que un Future no es `cancelled' antes de establecer un resultado o excepción al mismo:

@example
if not fut.cancelled():
    fut.set_result(42)
@end example
@end deffn

@geindex add_done_callback() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future add_done_callback}@anchor{b93}
@deffn {Método} add_done_callback (callback, *, context=None)

Añade una retrollamada (`callback') a ser ejecutada cuando el Future es `done'.

La retrollamada (`callback') es llamada con el objeto Future como su único argumento.

Si el Future ya es `done' cuando se llama a este método, la retrollamada (`callback') es programada con @ref{b8f,,loop.call_soon()}.

Un argumento opcional de contexto, por palabra clave, permite especificar un @ref{15a0,,contextvars.Context} personalizado para ser ejecutado en la retrollamada (`callback'). El contexto actual se utiliza cuando no se provee un contexto (`context').

@ref{17a,,functools.partial()} se puede utilizar para dar parámetros a la retrollamada (`callback'), por ejemplo:

@example
# Call 'print("Future:", fut)' when "fut" is done.
fut.add_done_callback(
    functools.partial(print, "Future:"))
@end example


Distinto en la versión 3.7: El parámetro de contexto (`context') por palabra clave fue añadido. Ver 
@geindex Python Enhancement Proposals; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para más detalles.

@end deffn

@geindex remove_done_callback() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future remove_done_callback}@anchor{15a6}
@deffn {Método} remove_done_callback (callback)

Elimina la retrollamada (`callback') de la lista de retrollamadas.

Retorna el número de retrollamadas (`callbacks') eliminadas, que normalmente es 1, excepto si una retrollamada fue añadida más de una vez.
@end deffn

@geindex cancel() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future cancel}@anchor{1821}
@deffn {Método} cancel (msg=None)

Cancela el Future y programa retrollamadas (`callbacks').

Si el Future ya está `done' o `cancelled', retorna @code{False}. De lo contrario, cambia el estado del Future a `cancelled', programa las retrollamadas, y retorna @code{True}.


Distinto en la versión 3.9: Se agregó el parámetro `msg'.

@end deffn

@geindex exception() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future exception}@anchor{32c7}
@deffn {Método} exception ()

Retorna la excepción definida en este Future.

La excepción (o @code{None} si no se había establecido ninguna excepción) es retornada sólo si Future es `done'.

Si un evento es `cancelled', este método lanzará una excepción @ref{31f,,CancelledError}.

Si el Future todavía no es `done', este método lanza una excepción @ref{31fb,,InvalidStateError}.
@end deffn

@geindex get_loop() (método de asyncio.Future)
@anchor{library/asyncio-future asyncio Future get_loop}@anchor{b9b}
@deffn {Método} get_loop ()

Retorna el bucle de eventos (`event loop') al cual el objeto Future está asociado.


Added in version 3.7.

@end deffn
@end deffn
@anchor{library/asyncio-future asyncio-example-future}@anchor{32c8}
Este ejemplo crea un objeto Future, crea y programa una Task asíncrona para establecer el resultado para el Future, y espera hasta que el Future tenga un resultado:

@example
async def set_after(fut, delay, value):
    # Sleep for *delay* seconds.
    await asyncio.sleep(delay)

    # Set *value* as a result of *fut* Future.
    fut.set_result(value)

async def main():
    # Get the current event loop.
    loop = asyncio.get_running_loop()

    # Create a new Future object.
    fut = loop.create_future()

    # Run "set_after()" coroutine in a parallel Task.
    # We are using the low-level "loop.create_task()" API here because
    # we already have a reference to the event loop at hand.
    # Otherwise we could have just used "asyncio.create_task()".
    loop.create_task(
        set_after(fut, 1, '... world'))

    print('hello ...')

    # Wait until *fut* has a result (1 second) and print it.
    print(await fut)

asyncio.run(main())
@end example

@cartouche
@quotation Importante 
El objeto Future fue diseñado para imitar a @ref{1220,,concurrent.futures.Future}. Entre las principales diferencias están:


@itemize -

@item 
al contrario que Futures de `asyncio', las instancias de @ref{1220,,concurrent.futures.Future} no son aguardables (`await').

@item 
@ref{32c4,,asyncio.Future.result()} y @ref{32c7,,asyncio.Future.exception()} no aceptan el argumento `timeout'.

@item 
@ref{32c4,,asyncio.Future.result()} y @ref{32c7,,asyncio.Future.exception()} lanzan una excepción @ref{31fb,,InvalidStateError} cuando el Future no es `done'.

@item 
Las retrollamadas (`callbacks') registradas con @ref{b93,,asyncio.Future.add_done_callback()} no son llamadas inmediatamente, sino que son programadas con @ref{b8f,,loop.call_soon()}.

@item 
`asyncio' Future no es compatible con las funciones @ref{186a,,concurrent.futures.wait()} ni @ref{1658,,concurrent.futures.as_completed()}.

@item 
@ref{1821,,asyncio.Future.cancel()} acepta un argumento opcional @code{msg}, pero @ref{3124,,concurrent.futures.Future.cancel()} no.
@end itemize
@end quotation
@end cartouche

@node Transportes y protocolos,Políticas,Futures,asyncio — Asynchronous I/O
@anchor{library/asyncio-protocol doc}@anchor{32c9}@anchor{library/asyncio-protocol asyncio-transports-protocols}@anchor{31cc}@anchor{library/asyncio-protocol transports-and-protocols}@anchor{32ca}
@subsubsection Transportes y protocolos


@subsubheading Prefacio


Los transportes y protocolos son utilizados por las APIs de `bajo nivel' de los bucles de eventos, como @ref{6a4,,loop.create_connection()}. Utilizan un estilo de programación basado en retrollamadas y permiten implementaciones de alto rendimiento de protocolos de red o IPC (p. ej. HTTP).

Esencialmente, los transportes y protocolos solo deben usarse en bibliotecas y frameworks, nunca en aplicaciones asyncio de alto nivel.

Esta página de la documentación cubre tanto @ref{32cb,,Transports} como @ref{32cc,,Protocols}.

@subsubheading Introducción


En el nivel más alto, el transporte se ocupa de `cómo' se transmiten los bytes, mientras que el protocolo determina `qué' bytes transmitir (y hasta cierto punto cuándo).

Una forma diferente de decir lo mismo: Un transporte es una abstracción para un socket (o un punto final de E/S similar) mientras que un protocolo es una abstracción para una aplicación, desde el punto de vista del transporte.

Otro punto de vista más es que las interfaces de transporte y protocolo definen juntas una interfaz abstracta para usar E/S de red y E/S entre procesos.

Siempre existe una relación 1:1 entre el transporte y los objetos protocolo: el protocolo llama a los métodos del transporte para enviar datos, mientras que el transporte llama a los métodos del protocolo para enviarle los datos que se han recibido.

La mayoría de los métodos del bucle de eventos orientados a la conexión (como @ref{6a4,,loop.create_connection()}) aceptan generalmente un argumento `protocol_factory' que es usado para crear un objeto `Protocol' para una conexión aceptada, representada por un objeto `Transport'. Estos métodos suelen retornar una tupla de la forma @code{(transporte, protocolo)}.

@subsubheading Contenidos


Esta página de la documentación contiene las siguientes secciones:


@itemize *

@item 
La sección @ref{32cb,,Transports} documenta las clases asyncio @ref{32cd,,BaseTransport}, @ref{32a4,,ReadTransport}, @ref{32a5,,WriteTransport}, @ref{32ce,,Transport}, @ref{17b4,,DatagramTransport} y @ref{32b2,,SubprocessTransport}.

@item 
La sección @ref{32cc,,Protocols} documenta las clases asyncio @ref{32cf,,BaseProtocol}, @ref{32d0,,Protocol}, @ref{b28,,BufferedProtocol}, @ref{76f,,DatagramProtocol} y @ref{32b1,,SubprocessProtocol}.

@item 
La sección @ref{32d1,,Examples} muestra cómo trabajar con transportes, protocolos y las APIs de bajo nivel del bucle de eventos.
@end itemize

@menu
* Transportes:: 
* Protocolos:: 
* Ejemplos: Ejemplos<17>. 

@end menu

@node Transportes,Protocolos,,Transportes y protocolos
@anchor{library/asyncio-protocol asyncio-transport}@anchor{3290}@anchor{library/asyncio-protocol transports}@anchor{32cb}
@subsubsection Transportes


`Código fuente:' Lib/asyncio/transports.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/transports.py}


__________________________________________________________________


Los transportes son clases proporcionadas por @ref{b,,asyncio} para abstraer varios tipos de canales de comunicación.

Los objetos transporte siempre son instanciados por un @ref{dfe,,bucle de eventos asyncio}.

asyncio implementa transportes para TCP, UDP, SSL y pipes de subprocesos. Los métodos disponibles en un transporte dependen del tipo de transporte.

Las clases transporte @ref{31f3,,no son seguras en hilos}.

@menu
* Jerarquía de transportes:: 
* Transporte base:: 
* Transportes de solo lectura:: 
* Transportes de solo escritura:: 
* Transportes de datagramas:: 
* Transportes de subprocesos:: 

@end menu

@node Jerarquía de transportes,Transporte base,,Transportes
@anchor{library/asyncio-protocol transports-hierarchy}@anchor{32d2}
@subsubsection Jerarquía de transportes


@geindex BaseTransport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio BaseTransport}@anchor{32cd}
@deffn {Clase} asyncio.BaseTransport

Clase base para todos los transportes. Contiene métodos que todos los transportes asyncio comparten.
@end deffn

@geindex WriteTransport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio WriteTransport}@anchor{32a5}
@deffn {Clase} asyncio.WriteTransport (BaseTransport)

Un transporte base para conexiones de solo escritura.

Las instancias de la clase `WriteTransport' se retornan desde el método del bucle de eventos @ref{324d,,loop.connect_write_pipe()} y también se utilizan en métodos relacionados con subprocesos como @ref{3249,,loop.subprocess_exec()}.
@end deffn

@geindex ReadTransport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio ReadTransport}@anchor{32a4}
@deffn {Clase} asyncio.ReadTransport (BaseTransport)

Un transporte base para conexiones de solo lectura.

Las instancias de la clase `ReadTransport' se retornan desde el método del bucle de eventos @ref{324c,,loop.connect_read_pipe()} y también se utilizan en métodos relacionados con subprocesos como @ref{3249,,loop.subprocess_exec()}.
@end deffn

@geindex Transport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio Transport}@anchor{32ce}
@deffn {Clase} asyncio.Transport (WriteTransport, ReadTransport)

Interfaz que representa un transporte bidireccional, como una conexión TCP.

El usuario no crea una instancia de transporte directamente; en su lugar se llama a una función de utilidad, pasándole una fábrica de protocolos junto a otra información necesaria para crear el transporte y el protocolo.

Las instancias de la clase `Transport' son retornadas o utilizadas por métodos del bucle de eventos como @ref{6a4,,loop.create_connection()}, @ref{3209,,loop.create_unix_connection()}, @ref{b9e,,loop.create_server()}, @ref{329a,,loop.sendfile()}, etc.
@end deffn

@geindex DatagramTransport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio DatagramTransport}@anchor{17b4}
@deffn {Clase} asyncio.DatagramTransport (BaseTransport)

Un transporte para conexiones de datagramas (UDP).

Las instancias de la clase `DatagramTransport' se retornan desde el método @ref{7cf,,loop.create_datagram_endpoint()} del bucle de eventos.
@end deffn

@geindex SubprocessTransport (clase en asyncio)
@anchor{library/asyncio-protocol asyncio SubprocessTransport}@anchor{32b2}
@deffn {Clase} asyncio.SubprocessTransport (BaseTransport)

Una abstracción para representar una conexión entre un proceso padre y su proceso OS hijo.

Las instancias de la clase `SubprocessTransport' se retornan desde los métodos del bucle de eventos @ref{324a,,loop.subprocess_shell()} y @ref{3249,,loop.subprocess_exec()}.
@end deffn

@node Transporte base,Transportes de solo lectura,Jerarquía de transportes,Transportes
@anchor{library/asyncio-protocol base-transport}@anchor{32d3}
@subsubsection Transporte base


@geindex close() (método de asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport close}@anchor{3293}
@deffn {Método} BaseTransport.close ()

Cierra el transporte.

Si el transporte tiene un búfer para datos de salida, los datos almacenados en el búfer se eliminarán de forma asincrónica. No se recibirán más datos. Después de que se vacíen todos los datos almacenados en el búfer, el método @ref{32d4,,protocol.connection_lost()} del protocolo se llamará con @ref{716,,None} como argumento. El transporte no debería ser usado luego de haber sido cerrado.
@end deffn

@geindex is_closing() (método de asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport is_closing}@anchor{d00}
@deffn {Método} BaseTransport.is_closing ()

Retorna @code{True} si el transporte se está cerrando o está ya cerrado.
@end deffn

@geindex get_extra_info() (método de asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport get_extra_info}@anchor{b27}
@deffn {Método} BaseTransport.get_extra_info (name, default=None)

Retorna información sobre el transporte o los recursos subyacentes que utiliza.

`name' es una cadena de caracteres que representa la información específica del transporte que se va a obtener.

`default' es el valor que se retornará si la información no está disponible o si el transporte no admite la consulta con la implementación del bucle de eventos de terceros dada o en la plataforma actual.

Por ejemplo, el siguiente código intenta obtener el objeto socket subyacente del transporte:

@example
sock = transport.get_extra_info('socket')
if sock is not None:
    print(sock.getsockopt(...))
@end example

Categorías de información que se pueden consultar sobre algunos transportes:


@itemize *

@item 
socket:


@itemize -

@item 
@code{'peername'}: la dirección remota a la que está conectado el socket, resultado de @ref{32d5,,socket.socket.getpeername()} (@code{None} en caso de error)

@item 
@code{'socket'}: instancia de @ref{e27,,socket.socket}

@item 
@code{'sockname'}: la dirección propia del socket, resultado de @ref{32d6,,socket.socket.getsockname()}
@end itemize

@item 
socket SSL:


@itemize -

@item 
@code{'compression'}: el algoritmo de compresión que se está usando como una cadena de caracteres o @code{None} si la conexión no está comprimida; resultado de @ref{11b6,,ssl.SSLSocket.compression()}

@item 
@code{'cipher'}: una tupla de tres valores que contiene el nombre del cifrado que se está utilizando, la versión del protocolo SSL que define su uso y la cantidad de bits de la clave secreta que se utilizan; resultado de @ref{32d7,,ssl.SSLSocket.cipher()}

@item 
@code{'peercert'}: certificado de pares; resultado de @ref{1036,,ssl.SSLSocket.getpeercert()}

@item 
@code{'sslcontext'}: instancia de @ref{1fa,,ssl.SSLContext}

@item 
@code{'ssl_object'}: instancia de @ref{c09,,ssl.SSLObject} o @ref{981,,ssl.SSLSocket}
@end itemize

@item 
pipe:


@itemize -

@item 
@code{'pipe'}: objeto pipe
@end itemize

@item 
subproceso:


@itemize -

@item 
@code{'subprocess'}: instancia de @ref{301,,subprocess.Popen}
@end itemize
@end itemize
@end deffn

@geindex set_protocol() (método de asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport set_protocol}@anchor{32d8}
@deffn {Método} BaseTransport.set_protocol (protocol)

Establece un nuevo protocolo.

El cambio de protocolo solo debe realizarse cuando esté documentado que ambos protocolos admiten el cambio.
@end deffn

@geindex get_protocol() (método de asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport get_protocol}@anchor{32d9}
@deffn {Método} BaseTransport.get_protocol ()

Retorna el protocolo actual.
@end deffn

@node Transportes de solo lectura,Transportes de solo escritura,Transporte base,Transportes
@anchor{library/asyncio-protocol read-only-transports}@anchor{32da}
@subsubsection Transportes de solo lectura


@geindex is_reading() (método de asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport is_reading}@anchor{ba6}
@deffn {Método} ReadTransport.is_reading ()

Retorna @code{True} si el transporte está recibiendo nuevos datos.


Added in version 3.7.

@end deffn

@geindex pause_reading() (método de asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport pause_reading}@anchor{ba8}
@deffn {Método} ReadTransport.pause_reading ()

Pausa el extremo receptor del transporte. No se pasarán datos al método @ref{1795,,protocol.data_received()} del protocolo hasta que se llame a @ref{ba7,,resume_reading()}.


Distinto en la versión 3.7: El método es idempotente, es decir, se puede llamar cuando el transporte ya está en pausa o cerrado.

@end deffn

@geindex resume_reading() (método de asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport resume_reading}@anchor{ba7}
@deffn {Método} ReadTransport.resume_reading ()

Reanuda el extremo receptor. El método @ref{1795,,protocol.data_received()} del protocolo se llamará una vez más si hay algunos datos disponibles para su lectura.


Distinto en la versión 3.7: El método es idempotente, es decir, se puede llamar cuando el transporte está leyendo.

@end deffn

@node Transportes de solo escritura,Transportes de datagramas,Transportes de solo lectura,Transportes
@anchor{library/asyncio-protocol write-only-transports}@anchor{32db}
@subsubsection Transportes de solo escritura


@geindex abort() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport abort}@anchor{32b5}
@deffn {Método} WriteTransport.abort ()

Cierra el transporte inmediatamente, sin esperar a que finalicen las operaciones pendientes. Se perderán los datos almacenados en el búfer. No se recibirán más datos. El método @ref{32d4,,protocol.connection_lost()} del protocolo será llamado eventualmente con @ref{716,,None} como argumento.
@end deffn

@geindex can_write_eof() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport can_write_eof}@anchor{32dc}
@deffn {Método} WriteTransport.can_write_eof ()

Retorna @ref{c95,,True} si el transporte admite @ref{32dd,,write_eof()}, en caso contrario @ref{bbf,,False}.
@end deffn

@geindex get_write_buffer_size() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_size}@anchor{32de}
@deffn {Método} WriteTransport.get_write_buffer_size ()

Retorna el tamaño actual del búfer de salida utilizado por el transporte.
@end deffn

@geindex get_write_buffer_limits() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_limits}@anchor{e4a}
@deffn {Método} WriteTransport.get_write_buffer_limits ()

Obtiene los límites superior e inferior para el control del flujo de escritura. Retorna una tupla @code{(low, high)} donde `low' (“inferior”) y `high' (“superior”) son un número de bytes positivo.

Usa @ref{32df,,set_write_buffer_limits()} para establecer los límites.


Added in version 3.4.2.

@end deffn

@geindex set_write_buffer_limits() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport set_write_buffer_limits}@anchor{32df}
@deffn {Método} WriteTransport.set_write_buffer_limits (high=None, low=None)

Establece los límites `high' (“superior”) y `low' (“inferior”) para el control del flujo de escritura.

Estos dos valores (medidos en número de bytes) controlan cuándo se llaman los métodos @ref{32e0,,protocol.pause_writing()} y @ref{32e1,,protocol.resume_writing()} del protocolo . Si se especifica, el límite inferior debe ser menor o igual que el límite superior. Ni `high' ni `low' pueden ser negativos.

@ref{32e0,,pause_writing()} se llama cuando el tamaño del búfer es mayor o igual que el valor `high' (“superior”). Si se ha pausado la escritura, se llama a @ref{32e1,,resume_writing()} cuando el tamaño del búfer es menor o igual que el valor `low' (“inferior”).

Los valores por defecto son específicos de la implementación. Si solo se proporciona el límite superior, el inferior toma de forma predeterminada un valor específico, dependiente de la implementación, menor o igual que el límite superior. Establecer `high' (“superior”) en cero fuerza `low' (“inferior”) a cero también y hace que @ref{32e0,,pause_writing()} sea llamado siempre que el búfer no esté vacío. Establecer `low' (“inferior”) en cero hace que @ref{32e1,,resume_writing()} sea llamado únicamente cuando el búfer esté vacío. El uso de cero para cualquiera de los límites es generalmente subóptimo, ya que reduce las oportunidades para realizar E/S y cálculos simultáneamente.

Usa @ref{e4a,,get_write_buffer_limits()} para obtener los límites.
@end deffn

@geindex write() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport write}@anchor{32e2}
@deffn {Método} WriteTransport.write (data)

Escribe los bytes de `data' en el transporte.

Este método no bloquea; almacena los datos en el búfer y organiza que se envíen de forma asincrónica.
@end deffn

@geindex writelines() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport writelines}@anchor{1733}
@deffn {Método} WriteTransport.writelines (list_of_data)

Escribe una lista (o cualquier iterable) de bytes de datos en el transporte. Esto es funcionalmente equivalente a llamar a @ref{32e2,,write()} en cada elemento generado por el iterable, pero puede ser implementado de manera más eficiente.
@end deffn

@geindex write_eof() (método de asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport write_eof}@anchor{32dd}
@deffn {Método} WriteTransport.write_eof ()

Cierra el extremo de escritura del transporte después de vaciar todos los datos almacenados en el búfer. Aún es posible recibir datos.

Este método puede lanzar una excepción @ref{384,,NotImplementedError} si el transporte (p. ej. SSL) no soporta conexiones semicerradas (`half-closed').
@end deffn

@node Transportes de datagramas,Transportes de subprocesos,Transportes de solo escritura,Transportes
@anchor{library/asyncio-protocol datagram-transports}@anchor{32e3}
@subsubsection Transportes de datagramas


@geindex sendto() (método de asyncio.DatagramTransport)
@anchor{library/asyncio-protocol asyncio DatagramTransport sendto}@anchor{316}
@deffn {Método} DatagramTransport.sendto (data, addr=None)

Envía los bytes `data' al par remoto proporcionado por `addr' (una dirección de destino dependiente del transporte). Si `addr' es @ref{716,,None}, los datos se envían a la dirección de destino proporcionada en la creación del transporte.

Este método no bloquea; almacena los datos en el búfer y organiza que se envíen de forma asincrónica.


Distinto en la versión 3.13: This method can be called with an empty bytes object to send a
zero-length datagram. The buffer size calculation used for flow
control is also updated to account for the datagram header.

@end deffn

@geindex abort() (método de asyncio.DatagramTransport)
@anchor{library/asyncio-protocol asyncio DatagramTransport abort}@anchor{32e4}
@deffn {Método} DatagramTransport.abort ()

Cierra el transporte inmediatamente, sin esperar a que finalicen las operaciones pendientes. Se perderán los datos almacenados en el búfer. No se recibirán más datos. El método @ref{32d4,,protocol.connection_lost()} del protocolo será llamado eventualmente con @ref{716,,None} como argumento.
@end deffn

@node Transportes de subprocesos,,Transportes de datagramas,Transportes
@anchor{library/asyncio-protocol asyncio-subprocess-transports}@anchor{324e}@anchor{library/asyncio-protocol subprocess-transports}@anchor{32e5}
@subsubsection Transportes de subprocesos


@geindex get_pid() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pid}@anchor{32e6}
@deffn {Método} SubprocessTransport.get_pid ()

Retorna la id del subproceso como un número entero.
@end deffn

@geindex get_pipe_transport() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pipe_transport}@anchor{32e7}
@deffn {Método} SubprocessTransport.get_pipe_transport (fd)

Retorna el transporte para la pipe de comunicación correspondiente al descriptor de archivo entero `fd':


@itemize *

@item 
@code{0}: transporte de `streaming' para lectura de la entrada estándar (`stdin') o @ref{716,,None} si el subproceso no se creó con @code{stdin = PIPE}

@item 
@code{1}: transporte de `streaming' para escritura de la salida estándar (`stdout') o @ref{716,,None} si el subproceso no se creó con @code{stdout = PIPE}

@item 
@code{2}: transporte de `streaming' para escritura del error estándar (`stderr') o @ref{716,,None} si el subproceso no se creó con @code{stderr = PIPE}

@item 
otro `fd': @ref{716,,None}
@end itemize
@end deffn

@geindex get_returncode() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_returncode}@anchor{32e8}
@deffn {Método} SubprocessTransport.get_returncode ()

Retorna el código de retorno del subproceso como un entero o @ref{716,,None} si no ha retornado aún, lo que es similar al atributo @ref{19b1,,subprocess.Popen.returncode}.
@end deffn

@geindex kill() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport kill}@anchor{32e9}
@deffn {Método} SubprocessTransport.kill ()

Mata al subproceso.

En los sistemas POSIX, la función envía SIGKILL al subproceso. En Windows, este método es un alias para @ref{32ea,,terminate()}.

Ver también @ref{141d,,subprocess.Popen.kill()}.
@end deffn

@geindex send_signal() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport send_signal}@anchor{32eb}
@deffn {Método} SubprocessTransport.send_signal (signal)

Envía el número de `señal' al subproceso, como en @ref{141e,,subprocess.Popen.send_signal()}.
@end deffn

@geindex terminate() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport terminate}@anchor{32ea}
@deffn {Método} SubprocessTransport.terminate ()

Detiene el subproceso.

On POSIX systems, this method sends @ref{141f,,SIGTERM} to the subprocess.
On Windows, the Windows API function @code{TerminateProcess()} is called to
stop the subprocess.

Ver también @ref{141c,,subprocess.Popen.terminate()}.
@end deffn

@geindex close() (método de asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport close}@anchor{32ec}
@deffn {Método} SubprocessTransport.close ()

Mata al subproceso llamando al método @ref{32e9,,kill()}.

Si el subproceso aún no ha retornado, cierra los transportes de las pipes `stdin', `stdout' y `stderr'.
@end deffn

@node Protocolos,Ejemplos<17>,Transportes,Transportes y protocolos
@anchor{library/asyncio-protocol asyncio-protocol}@anchor{328f}@anchor{library/asyncio-protocol protocols}@anchor{32cc}
@subsubsection Protocolos


`Código fuente:' Lib/asyncio/protocols.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/protocols.py}


__________________________________________________________________


asyncio proporciona un conjunto de clases base abstractas que pueden usarse para implementar protocolos de red. Estas clases están destinadas a ser utilizadas junto con los @ref{3290,,transportes}.

Las subclases de las clases abstractas de protocolos base pueden implementar algunos o todos los métodos. Todos estos métodos son retrollamadas: son llamados por los transportes en ciertos eventos, por ejemplo, cuando se reciben algunos datos. Un método del protocolo base debe ser llamado por el transporte correspondiente.

@menu
* Protocolos base:: 
* Protocolo base:: 
* Protocolos de streaming:: 
* Protocolos de streaming mediante búfer:: 
* Protocolos de datagramas:: 
* Protocolos de subprocesos:: 

@end menu

@node Protocolos base,Protocolo base,,Protocolos
@anchor{library/asyncio-protocol base-protocols}@anchor{32ed}
@subsubsection Protocolos base


@geindex BaseProtocol (clase en asyncio)
@anchor{library/asyncio-protocol asyncio BaseProtocol}@anchor{32cf}
@deffn {Clase} asyncio.BaseProtocol

Protocolo base con métodos que comparten todos los demás protocolos.
@end deffn

@geindex Protocol (clase en asyncio)
@anchor{library/asyncio-protocol asyncio Protocol}@anchor{32d0}
@deffn {Clase} asyncio.Protocol (BaseProtocol)

La clase base para implementar protocolos de `streaming' (TCP, sockets Unix, etc).
@end deffn

@geindex BufferedProtocol (clase en asyncio)
@anchor{library/asyncio-protocol asyncio BufferedProtocol}@anchor{b28}
@deffn {Clase} asyncio.BufferedProtocol (BaseProtocol)

Una clase base para implementar protocolos de `streaming' con control manual del búfer de recepción.
@end deffn

@geindex DatagramProtocol (clase en asyncio)
@anchor{library/asyncio-protocol asyncio DatagramProtocol}@anchor{76f}
@deffn {Clase} asyncio.DatagramProtocol (BaseProtocol)

La clase base para implementar protocolos de datagramas (UDP).
@end deffn

@geindex SubprocessProtocol (clase en asyncio)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol}@anchor{32b1}
@deffn {Clase} asyncio.SubprocessProtocol (BaseProtocol)

La clase base para implementar protocolos que se comunican con procesos secundarios (pipes unidireccionales).
@end deffn

@node Protocolo base,Protocolos de streaming,Protocolos base,Protocolos
@anchor{library/asyncio-protocol base-protocol}@anchor{32ee}
@subsubsection Protocolo base


Todos los protocolos asyncio pueden implementar las retrollamadas del protocolo base.

@subsubheading Retrollamadas de conexión


Las retrollamadas de conexión son llamadas exactamente una vez por conexión establecida en todos los protocolos. Todas las demás retrollamadas del protocolo solo pueden ser llamadas entre estos dos métodos.

@geindex connection_made() (método de asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_made}@anchor{3291}
@deffn {Método} BaseProtocol.connection_made (transport)

Se llama cuando se establece una conexión.

El argumento `transport' es el transporte que representa la conexión. El protocolo se encarga de almacenar la referencia a su propio transporte.
@end deffn

@geindex connection_lost() (método de asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_lost}@anchor{32d4}
@deffn {Método} BaseProtocol.connection_lost (exc)

Se llama cuando la conexión se pierde o se cierra.

El argumento es un objeto excepción o @ref{716,,None}. Esto último significa que se recibió un EOF regular o que la conexión fue cancelada o cerrada por este lado de la conexión.
@end deffn

@subsubheading Retrollamadas de control de flujo


Los transportes pueden llamar a las retrollamadas de control de flujo para pausar o reanudar la escritura llevada a cabo por el protocolo.

Consulta la documentación del método @ref{32df,,set_write_buffer_limits()} para obtener más detalles.

@geindex pause_writing() (método de asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol pause_writing}@anchor{32e0}
@deffn {Método} BaseProtocol.pause_writing ()

Se llama cuando el búfer del transporte supera el límite superior.
@end deffn

@geindex resume_writing() (método de asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol resume_writing}@anchor{32e1}
@deffn {Método} BaseProtocol.resume_writing ()

Se llama cuando el búfer del transporte se vacía por debajo del límite inferior.
@end deffn

Si el tamaño del búfer es igual al límite superior, @ref{32e0,,pause_writing()} no será llamado: el tamaño del búfer debe superarse estrictamente.

Por el contrario, se llama a @ref{32e1,,resume_writing()} cuando el tamaño del búfer es igual o menor que el límite inferior. Estas condiciones finales son importantes para garantizar que todo salga como se espera cuando cualquiera de los dos límites sea cero.

@node Protocolos de streaming,Protocolos de streaming mediante búfer,Protocolo base,Protocolos
@anchor{library/asyncio-protocol streaming-protocols}@anchor{32ef}
@subsubsection Protocolos de `streaming'


Los métodos de eventos, como @ref{b9e,,loop.create_server()}, @ref{315,,loop.create_unix_server()}, @ref{6a4,,loop.create_connection()}, @ref{3209,,loop.create_unix_connection()}, @ref{d05,,loop.connect_accepted_socket()}, @ref{324c,,loop.connect_read_pipe()}, y @ref{324d,,loop.connect_write_pipe()} aceptan fábricas que retornan protocolos de `streaming'.

@geindex data_received() (método de asyncio.Protocol)
@anchor{library/asyncio-protocol asyncio Protocol data_received}@anchor{1795}
@deffn {Método} Protocol.data_received (data)

Se llama cuando se reciben algunos datos. `data' es un objeto bytes no vacío que contiene los datos entrantes.

Que los datos se almacenen en un búfer, que se fragmenten o se vuelvan a ensamblar depende del transporte. En general, no debe confiar en semánticas específicas y, en cambio, hacer que su análisis sea genérico y flexible. Sin embargo, los datos siempre se reciben en el orden correcto.

El método se puede llamar un número arbitrario de veces mientras una conexión esté abierta.

Sin embargo, @ref{32f0,,protocol.eof_received()} se llama como máximo una vez. Luego de llamar a @code{eof_received()}, ya no se llama más a @code{data_received()}.
@end deffn

@geindex eof_received() (método de asyncio.Protocol)
@anchor{library/asyncio-protocol asyncio Protocol eof_received}@anchor{32f0}
@deffn {Método} Protocol.eof_received ()

Se llama cuando el otro extremo indica que no enviará más datos (por ejemplo, llamando a @ref{32dd,,transport.write_eof()} si el otro extremo también usa asyncio).

Este método puede retornar un valor falso (incluido @code{None}), en cuyo caso el transporte se cerrará solo. Por el contrario, si este método retorna un valor verdadero, el protocolo utilizado determina si se debe cerrar el transporte. Dado que la implementación por defecto retorna @code{None}, en éste caso, se cierra implícitamente la conexión.

Algunos transportes, incluido SSL, no admiten conexiones semicerradas (`half-closed'), en cuyo caso retornar verdadero desde este método resultará en el cierre de la conexión.
@end deffn

Máquina de estado:

@example
start -> connection_made
    [-> data_received]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node Protocolos de streaming mediante búfer,Protocolos de datagramas,Protocolos de streaming,Protocolos
@anchor{library/asyncio-protocol buffered-streaming-protocols}@anchor{32f1}
@subsubsection Protocolos de `streaming' mediante búfer



Added in version 3.7.


Los protocolos que hacen uso de un búfer se pueden utilizar con cualquier método del bucle de eventos que admita @ref{32ef,,Streaming Protocols}.

Las implementaciones de @code{BufferedProtocol} permiten la asignación manual explícita y el control del búfer de recepción. Los bucles de eventos pueden utilizar el búfer proporcionado por el protocolo para evitar copias de datos innecesarias. Esto puede resultar en una mejora notable del rendimiento de los protocolos que reciben grandes cantidades de datos. Las implementaciones de protocolos sofisticados pueden reducir significativamente la cantidad de asignaciones de búfer.

Las siguientes retrollamadas son llamadas en instancias @ref{b28,,BufferedProtocol}:

@geindex get_buffer() (método de asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol get_buffer}@anchor{32f2}
@deffn {Método} BufferedProtocol.get_buffer (sizehint)

Se llama para asignar un nuevo búfer de recepción.

`sizehint' es el tamaño mínimo recomendado para el búfer retornado. Es aceptable retornar búferes más pequeños o más grandes de lo que sugiere `sizehint'. Cuando se establece en -1, el tamaño del búfer puede ser arbitrario. Es un error retornar un búfer con tamaño cero.

@code{get_buffer()} debe retornar un objeto que implemente el @ref{48a,,protocolo de búfer}.
@end deffn

@geindex buffer_updated() (método de asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol buffer_updated}@anchor{32f3}
@deffn {Método} BufferedProtocol.buffer_updated (nbytes)

Se llama cuando el búfer se ha actualizado con los datos recibidos.

`nbytes' es el número total de bytes que se escribieron en el búfer.
@end deffn

@geindex eof_received() (método de asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol eof_received}@anchor{32f4}
@deffn {Método} BufferedProtocol.eof_received ()

Consulte la documentación del método @ref{32f0,,protocol.eof_received()}.
@end deffn

@ref{32f2,,get_buffer()} se puede llamar un número arbitrario de veces durante una conexión. Sin embargo, @ref{32f0,,protocol.eof_received ()} se llama como máximo una vez y, si se llama, @ref{32f2,,get_buffer()} y @ref{32f3,,buffer_updated()} no serán llamados después de eso.

Máquina de estado:

@example
start -> connection_made
    [-> get_buffer
        [-> buffer_updated]?
    ]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node Protocolos de datagramas,Protocolos de subprocesos,Protocolos de streaming mediante búfer,Protocolos
@anchor{library/asyncio-protocol datagram-protocols}@anchor{32f5}
@subsubsection Protocolos de datagramas


Las instancias del protocolo de datagramas deben ser construidas por fábricas de protocolos pasadas al método @ref{7cf,,loop.create_datagram_endpoint()}.

@geindex datagram_received() (método de asyncio.DatagramProtocol)
@anchor{library/asyncio-protocol asyncio DatagramProtocol datagram_received}@anchor{32f6}
@deffn {Método} DatagramProtocol.datagram_received (data, addr)

Se llama cuando se recibe un datagrama. `data' es un objeto bytes que contiene los datos entrantes. `addr' es la dirección del par que envía los datos; el formato exacto depende del transporte.
@end deffn

@geindex error_received() (método de asyncio.DatagramProtocol)
@anchor{library/asyncio-protocol asyncio DatagramProtocol error_received}@anchor{32f7}
@deffn {Método} DatagramProtocol.error_received (exc)

Se llama cuando una operación de envío o recepción anterior genera una @ref{4d5,,OSError}. `exc' es la instancia @ref{4d5,,OSError}.

Este método se llama en condiciones excepcionales, cuando el transporte (por ejemplo, UDP) detecta que un datagrama no se pudo entregar a su destinatario. Sin embargo, en la mayoría de casos, los datagramas que no se puedan entregar se eliminarán silenciosamente.
@end deffn

@cartouche
@quotation Nota 
En los sistemas BSD (macOS, FreeBSD, etc.) el control de flujo no es compatible con los protocolos de datagramas, esto se debe a que no hay una forma confiable de detectar fallos de envío causados por escribir demasiados paquetes.

El socket siempre aparece como disponible (“ready”) y se eliminan los paquetes sobrantes. Un error @ref{4d5,,OSError} con @code{errno} establecido en @ref{17ef,,errno.ENOBUFS} puede o no ser generado; si se genera, se informará a @ref{32f7,,DatagramProtocol.error_received()} pero en caso contrario se ignorará.
@end quotation
@end cartouche

@node Protocolos de subprocesos,,Protocolos de datagramas,Protocolos
@anchor{library/asyncio-protocol asyncio-subprocess-protocols}@anchor{324f}@anchor{library/asyncio-protocol subprocess-protocols}@anchor{32f8}
@subsubsection Protocolos de subprocesos


Las instancias de protocolo de subproceso deben ser construidas por fábricas de protocolos pasadas a los métodos @ref{3249,,loop.subprocess_exec()} y @ref{324a,,loop.subprocess_shell()}.

@geindex pipe_data_received() (método de asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_data_received}@anchor{17cc}
@deffn {Método} SubprocessProtocol.pipe_data_received (fd, data)

Se llama cuando el proceso hijo escribe datos en su pipe stdout o stderr.

`fd' es el descriptor de archivo entero de la pipe.

`data' es un objeto bytes no vacío que contiene los datos recibidos.
@end deffn

@geindex pipe_connection_lost() (método de asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_connection_lost}@anchor{32f9}
@deffn {Método} SubprocessProtocol.pipe_connection_lost (fd, exc)

Se llama cuando se cierra una de las pipes que se comunican con el proceso hijo.

`fd' es el descriptor de archivo entero que se cerró.
@end deffn

@geindex process_exited() (método de asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol process_exited}@anchor{17cb}
@deffn {Método} SubprocessProtocol.process_exited ()

Se llama cuando el proceso hijo ha finalizado.

It can be called before @ref{17cc,,pipe_data_received()} and
@ref{32f9,,pipe_connection_lost()} methods.
@end deffn

@node Ejemplos<17>,,Protocolos,Transportes y protocolos
@anchor{library/asyncio-protocol examples}@anchor{32d1}
@subsubsection Ejemplos


@menu
* Servidor de eco TCP:: 
* Cliente de eco TCP:: 
* Servidor de eco UDP:: 
* Cliente de eco UDP:: 
* Conectando sockets existentes:: 
* loop.subprocess_exec() y SubprocessProtocol: loop subprocess_exec y SubprocessProtocol. 

@end menu

@node Servidor de eco TCP,Cliente de eco TCP,,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-server-protocol}@anchor{321e}@anchor{library/asyncio-protocol tcp-echo-server}@anchor{32fa}
@subsubsection Servidor de eco TCP


Crear un servidor de eco TCP usando el método @ref{b9e,,loop.create_server()}, enviar de vuelta los datos recibidos y cerrar la conexión:

@example
import asyncio


class EchoServerProtocol(asyncio.Protocol):
    def connection_made(self, transport):
        peername = transport.get_extra_info('peername')
        print('Connection from @{@}'.format(peername))
        self.transport = transport

    def data_received(self, data):
        message = data.decode()
        print('Data received: @{!r@}'.format(message))

        print('Send: @{!r@}'.format(message))
        self.transport.write(data)

        print('Close the client socket')
        self.transport.close()


async def main():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    server = await loop.create_server(
        EchoServerProtocol,
        '127.0.0.1', 8888)

    async with server:
        await server.serve_forever()


asyncio.run(main())
@end example


@subsubheading Ver también


El ejemplo @ref{321c,,Servidor de eco TCP usando streams} usa la función de alto nivel @ref{ba4,,asyncio.start_server()}.


@node Cliente de eco TCP,Servidor de eco UDP,Servidor de eco TCP,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-client-protocol}@anchor{321b}@anchor{library/asyncio-protocol tcp-echo-client}@anchor{32fb}
@subsubsection Cliente de eco TCP


Un cliente de eco TCP usando el método @ref{6a4,,loop.create_connection()}, envía datos y espera hasta que la conexión se cierre:

@example
import asyncio


class EchoClientProtocol(asyncio.Protocol):
    def __init__(self, message, on_con_lost):
        self.message = message
        self.on_con_lost = on_con_lost

    def connection_made(self, transport):
        transport.write(self.message.encode())
        print('Data sent: @{!r@}'.format(self.message))

    def data_received(self, data):
        print('Data received: @{!r@}'.format(data.decode()))

    def connection_lost(self, exc):
        print('The server closed the connection')
        self.on_con_lost.set_result(True)


async def main():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    on_con_lost = loop.create_future()
    message = 'Hello World!'

    transport, protocol = await loop.create_connection(
        lambda: EchoClientProtocol(message, on_con_lost),
        '127.0.0.1', 8888)

    # Wait until the protocol signals that the connection
    # is lost and close the transport.
    try:
        await on_con_lost
    finally:
        transport.close()


asyncio.run(main())
@end example


@subsubheading Ver también


El ejemplo @ref{3219,,Cliente de eco TCP usando streams} usa la función de alto nivel @ref{ba3,,asyncio.open_connection()}.


@node Servidor de eco UDP,Cliente de eco UDP,Cliente de eco TCP,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-udp-echo-server-protocol}@anchor{3296}@anchor{library/asyncio-protocol udp-echo-server}@anchor{32fc}
@subsubsection Servidor de eco UDP


Un servidor de eco UDP, usando el método @ref{7cf,,loop.create_datagram_endpoint()}, envía de vuelta los datos recibidos:

@example
import asyncio


class EchoServerProtocol:
    def connection_made(self, transport):
        self.transport = transport

    def datagram_received(self, data, addr):
        message = data.decode()
        print('Received %r from %s' % (message, addr))
        print('Send %r to %s' % (message, addr))
        self.transport.sendto(data, addr)


async def main():
    print("Starting UDP server")

    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    # One protocol instance will be created to serve all
    # client requests.
    transport, protocol = await loop.create_datagram_endpoint(
        EchoServerProtocol,
        local_addr=('127.0.0.1', 9999))

    try:
        await asyncio.sleep(3600)  # Serve for 1 hour.
    finally:
        transport.close()


asyncio.run(main())
@end example

@node Cliente de eco UDP,Conectando sockets existentes,Servidor de eco UDP,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-udp-echo-client-protocol}@anchor{3295}@anchor{library/asyncio-protocol udp-echo-client}@anchor{32fd}
@subsubsection Cliente de eco UDP


Un cliente de eco UDP, usando el método @ref{7cf,,loop.create_datagram_endpoint()}, envía datos y cierra el transporte cuando recibe la respuesta:

@example
import asyncio


class EchoClientProtocol:
    def __init__(self, message, on_con_lost):
        self.message = message
        self.on_con_lost = on_con_lost
        self.transport = None

    def connection_made(self, transport):
        self.transport = transport
        print('Send:', self.message)
        self.transport.sendto(self.message.encode())

    def datagram_received(self, data, addr):
        print("Received:", data.decode())

        print("Close the socket")
        self.transport.close()

    def error_received(self, exc):
        print('Error received:', exc)

    def connection_lost(self, exc):
        print("Connection closed")
        self.on_con_lost.set_result(True)


async def main():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    on_con_lost = loop.create_future()
    message = "Hello World!"

    transport, protocol = await loop.create_datagram_endpoint(
        lambda: EchoClientProtocol(message, on_con_lost),
        remote_addr=('127.0.0.1', 9999))

    try:
        await on_con_lost
    finally:
        transport.close()


asyncio.run(main())
@end example

@node Conectando sockets existentes,loop subprocess_exec y SubprocessProtocol,Cliente de eco UDP,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-example-create-connection}@anchor{3222}@anchor{library/asyncio-protocol connecting-existing-sockets}@anchor{32fe}
@subsubsection Conectando sockets existentes


Espera hasta que un socket reciba datos usando el método @ref{6a4,,loop.create_connection()} mediante un protocolo:

@example
import asyncio
import socket


class MyProtocol(asyncio.Protocol):

    def __init__(self, on_con_lost):
        self.transport = None
        self.on_con_lost = on_con_lost

    def connection_made(self, transport):
        self.transport = transport

    def data_received(self, data):
        print("Received:", data.decode())

        # We are done: close the transport;
        # connection_lost() will be called automatically.
        self.transport.close()

    def connection_lost(self, exc):
        # The socket has been closed
        self.on_con_lost.set_result(True)


async def main():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()
    on_con_lost = loop.create_future()

    # Create a pair of connected sockets
    rsock, wsock = socket.socketpair()

    # Register the socket to wait for data.
    transport, protocol = await loop.create_connection(
        lambda: MyProtocol(on_con_lost), sock=rsock)

    # Simulate the reception of data from the network.
    loop.call_soon(wsock.send, 'abc'.encode())

    try:
        await protocol.on_con_lost
    finally:
        transport.close()
        wsock.close()

asyncio.run(main())
@end example


@subsubheading Ver también


El ejemplo @ref{3223,,monitorizar eventos de lectura en un descriptor de archivo} utiliza el método de bajo nivel @ref{3224,,loop.add_reader()} para registrar un descriptor de archivo.

El ejemplo @ref{3220,,registrar un socket abierto a la espera de datos usando streams} usa `streams' de alto nivel creados por la función @ref{ba3,,open_connection()} en una corrutina.


@node loop subprocess_exec y SubprocessProtocol,,Conectando sockets existentes,Ejemplos<17>
@anchor{library/asyncio-protocol asyncio-example-subprocess-proto}@anchor{3260}@anchor{library/asyncio-protocol loop-subprocess-exec-and-subprocessprotocol}@anchor{32ff}
@subsubsection `loop.subprocess_exec()' y `SubprocessProtocol'


Un ejemplo de un protocolo de subproceso que se utiliza para obtener la salida de un subproceso y esperar su terminación.

El subproceso es creado por el método @ref{3249,,loop.subprocess_exec()}

@example
import asyncio
import sys

class DateProtocol(asyncio.SubprocessProtocol):
    def __init__(self, exit_future):
        self.exit_future = exit_future
        self.output = bytearray()
        self.pipe_closed = False
        self.exited = False

    def pipe_connection_lost(self, fd, exc):
        self.pipe_closed = True
        self.check_for_exit()

    def pipe_data_received(self, fd, data):
        self.output.extend(data)

    def process_exited(self):
        self.exited = True
        # process_exited() method can be called before
        # pipe_connection_lost() method: wait until both methods are
        # called.
        self.check_for_exit()

    def check_for_exit(self):
        if self.pipe_closed and self.exited:
            self.exit_future.set_result(True)

async def get_date():
    # Get a reference to the event loop as we plan to use
    # low-level APIs.
    loop = asyncio.get_running_loop()

    code = 'import datetime; print(datetime.datetime.now())'
    exit_future = asyncio.Future(loop=loop)

    # Create the subprocess controlled by DateProtocol;
    # redirect the standard output into a pipe.
    transport, protocol = await loop.subprocess_exec(
        lambda: DateProtocol(exit_future),
        sys.executable, '-c', code,
        stdin=None, stderr=None)

    # Wait for the subprocess exit using the process_exited()
    # method of the protocol.
    await exit_future

    # Close the stdout pipe.
    transport.close()

    # Read the output which was collected by the
    # pipe_data_received() method of the protocol.
    data = bytes(protocol.output)
    return data.decode('ascii').rstrip()

date = asyncio.run(get_date())
print(f"Current date: @{date@}")
@end example

Consulte también el @ref{325f,,mismo ejemplo} escrito utilizando la API de alto nivel.

@node Políticas,Soporte de plataforma,Transportes y protocolos,asyncio — Asynchronous I/O
@anchor{library/asyncio-policy doc}@anchor{3300}@anchor{library/asyncio-policy asyncio-policies}@anchor{327d}@anchor{library/asyncio-policy policies}@anchor{3301}
@subsubsection Políticas


Una política de bucle de eventos es un objeto global que se utiliza para obtener y establecer el @ref{dfe,,bucle de eventos} actual o para crear nuevos bucles de eventos. La política preestablecida puede ser @ref{3302,,reemplazada} con @ref{3303,,alternativas built-in} para usar diferentes implementaciones de bucles de eventos, o sustituida por una @ref{3304,,política personalizada} la cual puede anular estos comportamientos.

El @ref{3305,,objeto de política} obtiene y establece un bucle de eventos separado por `contexto'. Por defecto, esto se realiza por hilo, aunque las políticas personalizadas pueden definir el `contexto' de una forma diferente.

Las políticas de bucle de eventos personalizadas pueden controlar el comportamiento de @ref{214,,get_event_loop()}, @ref{17d2,,set_event_loop()}, y @ref{31d2,,new_event_loop()}.

Los objetos de política deberían implementar las APIs definidas en la clase abstracta base @ref{3306,,AbstractEventLoopPolicy}.

@menu
* Obteniendo y configurando la política:: 
* Objetos de política:: 
* Personalizar Políticas:: 

@end menu

@node Obteniendo y configurando la política,Objetos de política,,Políticas
@anchor{library/asyncio-policy asyncio-policy-get-set}@anchor{3302}@anchor{library/asyncio-policy getting-and-setting-the-policy}@anchor{3307}
@subsubsection Obteniendo y configurando la política


Las siguientes funciones pueden ser usadas para obtener y configurar la política de los procesos actuales:

@geindex get_event_loop_policy() (en el módulo asyncio)
@anchor{library/asyncio-policy asyncio get_event_loop_policy}@anchor{3308}
@deffn {Función} asyncio.get_event_loop_policy ()

Retorna la política actual en todo el proceso.
@end deffn

@geindex set_event_loop_policy() (en el módulo asyncio)
@anchor{library/asyncio-policy asyncio set_event_loop_policy}@anchor{3309}
@deffn {Función} asyncio.set_event_loop_policy (policy)

Establece la política actual en todo el proceso a `policy'.

Si `policy' está configurado a @code{None}, la política por defecto se reestablece.
@end deffn

@node Objetos de política,Personalizar Políticas,Obteniendo y configurando la política,Políticas
@anchor{library/asyncio-policy asyncio-policy-objects}@anchor{3305}@anchor{library/asyncio-policy policy-objects}@anchor{330a}
@subsubsection Objetos de política


La clase base de política de bucle de eventos abstractos se define de la siguiente manera:

@geindex AbstractEventLoopPolicy (clase en asyncio)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy}@anchor{3306}
@deffn {Clase} asyncio.AbstractEventLoopPolicy

Una clase base abstracta para políticas asyncio.

@geindex get_event_loop() (método de asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy get_event_loop}@anchor{330b}
@deffn {Método} get_event_loop ()

Retorna el bucle de eventos para el contexto actual.

Retorna un objeto bucle de eventos implementando la interfaz @ref{9f2,,AbstractEventLoop}.

Este método nunca debería retornar @code{None}.


Distinto en la versión 3.6.

@end deffn

@geindex set_event_loop() (método de asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy set_event_loop}@anchor{330c}
@deffn {Método} set_event_loop (loop)

Establece el bucle de eventos para el contexto a `loop'.
@end deffn

@geindex new_event_loop() (método de asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy new_event_loop}@anchor{330d}
@deffn {Método} new_event_loop ()

Crea y retorna un nuevo objeto de bucle de eventos.

Este método nunca debería retornar @code{None}.
@end deffn
@end deffn
@anchor{library/asyncio-policy asyncio-policy-builtin}@anchor{3303}
asyncio se envía con las siguientes políticas integradas:

@geindex DefaultEventLoopPolicy (clase en asyncio)
@anchor{library/asyncio-policy asyncio DefaultEventLoopPolicy}@anchor{330e}
@deffn {Clase} asyncio.DefaultEventLoopPolicy

La política por defecto asyncio.  Usa @ref{6a9,,SelectorEventLoop} en Unix y @ref{6aa,,ProactorEventLoop} en Windows.

No hay necesidad de instalar la política por defecto manualmente. asyncio está configurado para usar la política por defecto automáticamente.


Distinto en la versión 3.8: En Windows, @ref{6aa,,ProactorEventLoop} ahora se usa por defecto.



Distinto en la versión 3.14: The @ref{214,,get_event_loop()} method of the default asyncio policy now
raises a @ref{1e5,,RuntimeError} if there is no set event loop.

@end deffn

@geindex WindowsSelectorEventLoopPolicy (clase en asyncio)
@anchor{library/asyncio-policy asyncio WindowsSelectorEventLoopPolicy}@anchor{330f}
@deffn {Clase} asyncio.WindowsSelectorEventLoopPolicy

Una política de bucle de eventos alternativa que usa la implementación de bucle de eventos @ref{6a9,,SelectorEventLoop}.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex WindowsProactorEventLoopPolicy (clase en asyncio)
@anchor{library/asyncio-policy asyncio WindowsProactorEventLoopPolicy}@anchor{3310}
@deffn {Clase} asyncio.WindowsProactorEventLoopPolicy

Una política de bucle de eventos alternativa que usa la implementación de bucle de eventos @ref{6aa,,ProactorEventLoop}.

@ref{1d5a,,Availability}: Windows.
@end deffn

@node Personalizar Políticas,,Objetos de política,Políticas
@anchor{library/asyncio-policy asyncio-custom-policies}@anchor{3304}@anchor{library/asyncio-policy custom-policies}@anchor{3311}
@subsubsection Personalizar Políticas


Para implementar una nueva política de bucle de eventos, se recomienda heredar @ref{330e,,DefaultEventLoopPolicy} y sobreescribir los métodos para los cuales se desea una conducta personalizada, por ejemplo:

@example
class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):

    def get_event_loop(self):
        """Get the event loop.

        This may be None or an instance of EventLoop.
        """
        loop = super().get_event_loop()
        # Do something with loop ...
        return loop

asyncio.set_event_loop_policy(MyEventLoopPolicy())
@end example

@node Soporte de plataforma,Extensión,Políticas,asyncio — Asynchronous I/O
@anchor{library/asyncio-platforms doc}@anchor{3312}@anchor{library/asyncio-platforms asyncio-platform-support}@anchor{32a0}@anchor{library/asyncio-platforms platform-support}@anchor{3313}
@subsubsection Soporte de plataforma


El módulo @ref{b,,asyncio} está diseñado para ser portátil, pero algunas plataformas tienen diferencias y limitaciones sutiles debido a la arquitectura y las capacidades subyacentes de las plataformas.

@menu
* Todas las plataformas:: 
* Windows: Windows<72>. 
* macOS: macOS<45>. 

@end menu

@node Todas las plataformas,Windows<72>,,Soporte de plataforma
@anchor{library/asyncio-platforms all-platforms}@anchor{3314}
@subsubsection Todas las plataformas



@itemize *

@item 
@ref{3224,,loop.add_reader()} y @ref{329e,,loop.add_writer()} no se pueden utilizar para supervisar la E/S del archivo.
@end itemize

@node Windows<72>,macOS<45>,Todas las plataformas,Soporte de plataforma
@anchor{library/asyncio-platforms windows}@anchor{3315}
@subsubsection Windows


`Código fuente:' Lib/asyncio/proactor_events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/proactor_events.py}, Lib/asyncio/windows_events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/windows_events.py}, Lib/asyncio/windows_utils.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/windows_utils.py}


__________________________________________________________________



Distinto en la versión 3.8: En Windows, @ref{6aa,,ProactorEventLoop} es ahora el bucle de eventos predeterminado.


Todos los bucles de eventos en Windows no admiten los métodos siguientes:


@itemize *

@item 
@ref{3209,,loop.create_unix_connection()} y @ref{315,,loop.create_unix_server()} no son compatibles. La familia de sockets @ref{1826,,socket.AF_UNIX} es específica de Unix.

@item 
@ref{32a7,,loop.add_signal_handler()} y @ref{32a8,,loop.remove_signal_handler()} no son compatibles.
@end itemize

@ref{6a9,,SelectorEventLoop} tiene las siguientes limitaciones:


@itemize *

@item 
@ref{3316,,SelectSelector} se utiliza para esperar los eventos de los sockets: soporta los sockets y está limitado a 512 sockets.

@item 
@ref{3224,,loop.add_reader()} y @ref{329e,,loop.add_writer()} sólo aceptan manejadores de sockets (por ejemplo, los descriptores de archivos de tuberías no están soportados).

@item 
Las tuberías no están soportadas, por lo que los métodos @ref{324c,,loop.connect_read_pipe()} y @ref{324d,,loop.connect_write_pipe()} no están implementados.

@item 
@ref{31c6,,Subprocesos} no están soportados, es decir, los métodos @ref{3249,,loop.subprocess_exec()} y @ref{324a,,loop.subprocess_shell()} no están implementados.
@end itemize

@ref{6aa,,ProactorEventLoop} tiene las siguientes limitaciones:


@itemize *

@item 
Los métodos @ref{3224,,loop.add_reader()} y @ref{329e,,loop.add_writer()} no están soportados.
@end itemize

La resolución del reloj monótono de Windows suele ser de unos 15,6 milisegundos. La mejor resolución es de 0,5 milisegundos. La resolución depende del hardware (disponibilidad de HPET@footnote{https://es.wikipedia.org/wiki/High_Precision_Event_Timer}) y de la configuración de Windows.

@menu
* Soporte de sub-procesos en Windows:: 

@end menu

@node Soporte de sub-procesos en Windows,,,Windows<72>
@anchor{library/asyncio-platforms asyncio-windows-subprocess}@anchor{324b}@anchor{library/asyncio-platforms subprocess-support-on-windows}@anchor{3317}
@subsubsection Soporte de sub-procesos en Windows


En Windows, el bucle de eventos por defecto @ref{6aa,,ProactorEventLoop} soporta subprocesos, mientras que @ref{6a9,,SelectorEventLoop} no lo hace.

@node macOS<45>,,Windows<72>,Soporte de plataforma
@anchor{library/asyncio-platforms macos}@anchor{3318}
@subsubsection macOS


Las versiones modernas de MacOS son totalmente compatibles.

@subsubheading macOS <= 10.8


En macOS 10.6, 10.7 y 10.8, el bucle de eventos por defecto utiliza @ref{3319,,selectors.KqueueSelector}, que no soporta dispositivos de caracteres en estas versiones. El @ref{6a9,,SelectorEventLoop} puede ser configurado manualmente para usar @ref{3316,,SelectSelector} o @ref{c5e,,PollSelector} para soportar dispositivos de caracteres en estas versiones antiguas de macOS. Ejemplo:

@example
import asyncio
import selectors

selector = selectors.SelectSelector()
loop = asyncio.SelectorEventLoop(selector)
asyncio.set_event_loop(loop)
@end example

@node Extensión,Índice de API de alto nivel,Soporte de plataforma,asyncio — Asynchronous I/O
@anchor{library/asyncio-extending doc}@anchor{331a}@anchor{library/asyncio-extending extending}@anchor{331b}
@subsubsection Extensión


La dirección principal para extender @ref{b,,asyncio} es escribir clases `event loop' personalizadas. Asyncio tiene ayudantes que podrían usarse para simplificar esta tarea.

@cartouche
@quotation Nota 
Los terceros deben reutilizar el código asyncio existente con precaución, una nueva versión de Python es gratuita para romper la compatibilidad con versiones anteriores en la parte `internal' de la API.
@end quotation
@end cartouche

@menu
* Escribir un bucle de eventos personalizado:: 
* Constructores privados Future y Task:: 
* Soporte de por vida de tareas:: 

@end menu

@node Escribir un bucle de eventos personalizado,Constructores privados Future y Task,,Extensión
@anchor{library/asyncio-extending writing-a-custom-event-loop}@anchor{331c}
@subsubsection Escribir un bucle de eventos personalizado


@ref{9f2,,asyncio.AbstractEventLoop} declara muchos métodos. Implementarlos todos desde cero es un trabajo tedioso.

Un bucle puede obtener la implementación de muchos métodos comunes de forma gratuita al heredar de @code{asyncio.BaseEventLoop}.

A su vez, el sucesor debería implementar un montón de métodos `privados' declarados pero no implementados en @code{asyncio.BaseEventLoop}.

Por ejemplo, @code{loop.create_connection()} comprueba los argumentos, resuelve las direcciones DNS y llama a @code{loop._make_socket_transport()} que debería implementar la clase heredada. El método @code{_make_socket_transport()} no está documentado y se considera como una API `internal'.

@node Constructores privados Future y Task,Soporte de por vida de tareas,Escribir un bucle de eventos personalizado,Extensión
@anchor{library/asyncio-extending future-and-task-private-constructors}@anchor{331d}
@subsubsection Constructores privados Future y Task


@ref{c55,,asyncio.Future} y @ref{580,,asyncio.Task} nunca deben crearse directamente; en su lugar, utilice las fábricas @ref{d01,,loop.create_future()} y @ref{a6e,,loop.create_task()} o @ref{69d,,asyncio.create_task()} correspondientes.

Sin embargo, `event loops' de terceros puede `reuse' incorporar futuras implementaciones y tareas con el fin de obtener un código complejo y altamente optimizado de forma gratuita.

Para ello se listan los siguientes constructores `private':

@geindex __init__() (método de asyncio.Future)
@anchor{library/asyncio-extending asyncio Future __init__}@anchor{331e}
@deffn {Método} Future.__init__ (*, loop=None)

Cree una instancia futura integrada.

`loop' es una instancia de bucle de eventos opcional.
@end deffn

@geindex __init__() (método de asyncio.Task)
@anchor{library/asyncio-extending asyncio Task __init__}@anchor{331f}
@deffn {Método} Task.__init__ (coro, *, loop=None, name=None, context=None)

Cree una instancia de tarea integrada.

`loop' es una instancia de bucle de eventos opcional. El resto de argumentos se describen en la descripción de @ref{a6e,,loop.create_task()}.


Distinto en la versión 3.11: Se agrega el argumento `context'.

@end deffn

@node Soporte de por vida de tareas,,Constructores privados Future y Task,Extensión
@anchor{library/asyncio-extending task-lifetime-support}@anchor{3320}
@subsubsection Soporte de por vida de tareas


La implementación de una tarea de terceros debe llamar a las siguientes funciones para mantener una tarea visible para @ref{9e9,,asyncio.all_tasks()} y @ref{526,,asyncio.current_task()}:

@geindex _register_task() (en el módulo asyncio)
@anchor{library/asyncio-extending asyncio _register_task}@anchor{3321}
@deffn {Función} asyncio._register_task (task)

Registre un nuevo `task' como administrado por `asyncio'.

Llame a la función desde un constructor de tareas.
@end deffn

@geindex _unregister_task() (en el módulo asyncio)
@anchor{library/asyncio-extending asyncio _unregister_task}@anchor{3322}
@deffn {Función} asyncio._unregister_task (task)

Anule el registro de un `task' de las estructuras internas de `asyncio'.

La función debe llamarse cuando una tarea está a punto de finalizar.
@end deffn

@geindex _enter_task() (en el módulo asyncio)
@anchor{library/asyncio-extending asyncio _enter_task}@anchor{3323}
@deffn {Función} asyncio._enter_task (loop, task)

Cambie la tarea actual al argumento `task'.

Llame a la función justo antes de ejecutar una parte del `coroutine' incrustado (@ref{1fcc,,coroutine.send()} o @ref{59c,,coroutine.throw()}).
@end deffn

@geindex _leave_task() (en el módulo asyncio)
@anchor{library/asyncio-extending asyncio _leave_task}@anchor{3324}
@deffn {Función} asyncio._leave_task (loop, task)

Vuelva a cambiar la tarea actual de `task' a @code{None}.

Llame a la función justo después de la ejecución de @ref{1fcc,,coroutine.send()} o @ref{59c,,coroutine.throw()}.
@end deffn

@node Índice de API de alto nivel,Índice de API de bajo nivel,Extensión,asyncio — Asynchronous I/O
@anchor{library/asyncio-api-index doc}@anchor{910}@anchor{library/asyncio-api-index high-level-api-index}@anchor{3325}
@subsubsection Índice de API de alto nivel


Esta página lista todas las APIs async/await habilitadas de alto nivel.

@menu
* Tareas:: 
* Colas: Colas<2>. 
* Subprocesos:: 
* Flujos:: 
* Sincronización:: 
* Excepciones: Excepciones<12>. 

@end menu

@node Tareas,Colas<2>,,Índice de API de alto nivel
@anchor{library/asyncio-api-index tasks}@anchor{3326}
@subsubsection Tareas


Utilidades para ejecutar programas asyncio, crear Tareas, y esperar en múltiples cosas con tiempos de espera.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{525,,run()}

@tab

Crea un loop de eventos, ejecuta una corrutina, cierra el loop.

@item

@ref{6a1,,Runner}

@tab

Un administrador de contexto que simplifica múltiples llamadas a funciones asíncronas.

@item

@ref{580,,Task}

@tab

Objeto tarea.

@item

@ref{31c,,TaskGroup}

@tab

Un administrador de contexto que contiene un grupo de tareas. Proporciona una forma conveniente y confiable de esperar a que finalicen todas las tareas del grupo.

@item

@ref{69d,,create_task()}

@tab

Inicia una tarea asyncio, luego la retorna.

@item

@ref{526,,current_task()}

@tab

Retorna la tarea actual.

@item

@ref{9e9,,all_tasks()}

@tab

Retorna todas las tareas que aún no han terminado para un bucle de eventos.

@item

@code{await} @ref{afe,,sleep()}

@tab

Duerme por un número de segundos.

@item

@code{await} @ref{69e,,gather()}

@tab

Programa y espera por cosas concurrentemente.

@item

@code{await} @ref{6a0,,wait_for()}

@tab

Ejecuta con un tiempo de espera.

@item

@code{await} @ref{aff,,shield()}

@tab

Protege de la cancelación.

@item

@code{await} @ref{528,,wait()}

@tab

Monitorea la completitud.

@item

@ref{69f,,timeout()}

@tab

Ejecuta con un tiempo de espera. Útil en los casos en que @code{wait_for} no es adecuado.

@item

@ref{97f,,to_thread()}

@tab

Ejecute de forma asincrónica una función en un subproceso del sistema operativo independiente.

@item

@ref{91a,,run_coroutine_threadsafe()}

@tab

Programa una corrutina de desde otro hilo del sistema operativo.

@item

@code{for in} @ref{311,,as_completed()}

@tab

Monitorea por completitud con un loop @code{for}.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{31e4,,Usando asyncio.gather() para ejecutar cosas en paralelo}.

@item 
@ref{31ec,,Usando asyncio.wait_for() para forzar un tiempo de expiración}.

@item 
@ref{3201,,Cancelación}.

@item 
@ref{31e2,,Usando asyncio.sleep()}.

@item 
Ver también la @ref{31c4,,página principal de documentación de Tareas}.
@end itemize

@node Colas<2>,Subprocesos,Tareas,Índice de API de alto nivel
@anchor{library/asyncio-api-index queues}@anchor{3327}
@subsubsection Colas


Las colas deberían ser usadas para distribuir trabajo entre múltiples Tareas asyncio, implementar pools de conexiones y patrones pub/sub.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b05,,Queue}

@tab

Una cola FIFO.

@item

@ref{3270,,PriorityQueue}

@tab

Una cola de prioridad.

@item

@ref{3272,,LifoQueue}

@tab

Una cola LIFO.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{3274,,Usando asyncio.Queue para distribuir carga de trabajo entre varias Tareas}.

@item 
Ver también la @ref{31c7,,página de documentación de Colas}.
@end itemize

@node Subprocesos,Flujos,Colas<2>,Índice de API de alto nivel
@anchor{library/asyncio-api-index subprocesses}@anchor{3328}
@subsubsection Subprocesos


Utilidades para generar subprocesos y ejecutar comandos de consola.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{b06,,create_subprocess_exec()}

@tab

Crea un subproceso.

@item

@code{await} @ref{b07,,create_subprocess_shell()}

@tab

Ejecuta un comando de consola.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{3245,,Ejecutando un comando de consola}.

@item 
Ver también la documentación de las @ref{31c6,,APIs de subprocesos}.
@end itemize

@node Flujos,Sincronización,Subprocesos,Índice de API de alto nivel
@anchor{library/asyncio-api-index streams}@anchor{3329}
@subsubsection Flujos


APIs de alto nivel para trabajar con IO de red.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{ba3,,open_connection()}

@tab

Establece una conexión TCP.

@item

@code{await} @ref{3208,,open_unix_connection()}

@tab

Establece una conexión de un socket Unix.

@item

@code{await} @ref{ba4,,start_server()}

@tab

Lanza un servidor TCP.

@item

@code{await} @ref{320a,,start_unix_server()}

@tab

Lanza un servidor de sockets Unix.

@item

@ref{18ce,,StreamReader}

@tab

Objeto de alto nivel async/await para recibir datos de red.

@item

@ref{1705,,StreamWriter}

@tab

Objeto de alto nivel async/await para enviar datos de red.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{3204,,Cliente TCP de ejemplo}.

@item 
Ver también la documentación de @ref{31c5,,APIs de flujos}.
@end itemize

@node Sincronización,Excepciones<12>,Flujos,Índice de API de alto nivel
@anchor{library/asyncio-api-index synchronization}@anchor{332a}
@subsubsection Sincronización


Primitivas de sincronización al estilo hilos que pueden ser usadas en Tareas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b00,,Lock}

@tab

Un bloqueo mutex.

@item

@ref{b01,,Event}

@tab

Un objeto de evento.

@item

@ref{b02,,Condition}

@tab

Un objeto de condición.

@item

@ref{b03,,Semaphore}

@tab

Un semáforo.

@item

@ref{b04,,BoundedSemaphore}

@tab

Un semáforo acotado.

@item

@ref{6a2,,Barrier}

@tab

Un objeto barrera.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{322f,,Usando asyncio.Event}.

@item 
@ref{323d,,Usando asyncio.Barrier}.

@item 
Ver también la documentación de las @ref{31c8,,primitivas de sincronización} de asyncio.
@end itemize

@node Excepciones<12>,,Sincronización,Índice de API de alto nivel
@anchor{library/asyncio-api-index exceptions}@anchor{332b}
@subsubsection Excepciones



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{31f,,asyncio.CancelledError}

@tab

Lanzada cuando una Tarea es cancelada. Ver también @ref{31e,,Task.cancel()}.

@item

@ref{6a3,,asyncio.BrokenBarrierError}

@tab

Lanzada cuando se rompe una barrera. Véase también @ref{323c,,Barrier.wait()}.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{3201,,Gestionando CancelledError para ejecutar código en petición de cancelación}.

@item 
Ver también la lista completa de @ref{3276,,excepciones específicas de asyncio}.
@end itemize

@node Índice de API de bajo nivel,Desarrollando con asyncio,Índice de API de alto nivel,asyncio — Asynchronous I/O
@anchor{library/asyncio-llapi-index doc}@anchor{332c}@anchor{library/asyncio-llapi-index low-level-api-index}@anchor{332d}
@subsubsection Índice de API de bajo nivel


Esta página enumera todas las APIs de asyncio de bajo nivel.

@menu
* Obtención del bucle de eventos:: 
* Métodos del bucle de eventos: Métodos del bucle de eventos<2>. 
* Transportes: Transportes<2>. 
* Protocolos: Protocolos<2>. 
* Políticas de bucle de eventos:: 

@end menu

@node Obtención del bucle de eventos,Métodos del bucle de eventos<2>,,Índice de API de bajo nivel
@anchor{library/asyncio-llapi-index obtaining-the-event-loop}@anchor{332e}
@subsubsection Obtención del bucle de eventos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b96,,asyncio.get_running_loop()}

@tab

La función `preferida' para obtener el bucle de eventos en ejecución.

@item

@ref{214,,asyncio.get_event_loop()}

@tab

Obtiene una instancia del bucle de eventos (en ejecución o actual mediante la política actual).

@item

@ref{17d2,,asyncio.set_event_loop()}

@tab

Establece el bucle de eventos como actual a través de la política del bucle.

@item

@ref{31d2,,asyncio.new_event_loop()}

@tab

Crea un nuevo bucle de eventos.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{32c8,,Usando asyncio.get_running_loop()}.
@end itemize

@node Métodos del bucle de eventos<2>,Transportes<2>,Obtención del bucle de eventos,Índice de API de bajo nivel
@anchor{library/asyncio-llapi-index event-loop-methods}@anchor{332f}
@subsubsection Métodos del bucle de eventos


Consulte también la sección de documentación principal sobre @ref{3283,,Métodos del bucle de eventos}.

@subsubheading Ciclo de vida



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{cff,,loop.run_until_complete()}

@tab

Ejecuta un Future/Tarea/aguardable (`awaitable') hasta que se complete.

@item

@ref{3285,,loop.run_forever()}

@tab

Ejecuta el bucle de eventos para siempre.

@item

@ref{d04,,loop.stop()}

@tab

Detiene el bucle de eventos.

@item

@ref{3287,,loop.close()}

@tab

Cierra el bucle de eventos.

@item

@ref{3286,,loop.is_running()}

@tab

Retorna @code{True} si el bucle de eventos se está ejecutando.

@item

@ref{e49,,loop.is_closed()}

@tab

Retorna @code{True} si el bucle de eventos está cerrado.

@item

@code{await} @ref{d06,,loop.shutdown_asyncgens()}

@tab

Cierra generadores asincrónicos.

@end multitable


@subsubheading Depuración



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{e47,,loop.set_debug()}

@tab

Habilita o deshabilita el modo de depuración.

@item

@ref{e48,,loop.get_debug()}

@tab

Obtiene el modo de depuración actual.

@end multitable


@subsubheading Programación de devoluciones de llamada



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b8f,,loop.call_soon()}

@tab

Invoca una devolución de llamada `soon'.

@item

@ref{b90,,loop.call_soon_threadsafe()}

@tab

Una variante segura para subprocesos de @ref{b8f,,loop.call_soon()}.

@item

@ref{b91,,loop.call_later()}

@tab

Invoca una devolución de llamada `después' del tiempo especificado.

@item

@ref{b92,,loop.call_at()}

@tab

Invoca una devolución de llamada `en' el tiempo especificado.

@end multitable


@subsubheading Thread/Interpreter/Process Pool



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{980,,loop.run_in_executor()}

@tab

Ejecuta una función de bloqueo vinculada a la CPU o de otro tipo en un ejecutor @ref{22,,concurrent.futures}.

@item

@ref{7de,,loop.set_default_executor()}

@tab

Establece el ejecutor predeterminado para @ref{980,,loop.run_in_executor()}.

@end multitable


@subsubheading Tareas y Futures



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{d01,,loop.create_future()}

@tab

Crea un objeto @ref{c55,,Future}.

@item

@ref{a6e,,loop.create_task()}

@tab

Programa una corrutina como @ref{580,,Task}.

@item

@ref{e4b,,loop.set_task_factory()}

@tab

Establece una fábrica utilizada por @ref{a6e,,loop.create_task()} para crear @ref{580,,Tareas}.

@item

@ref{e4c,,loop.get_task_factory()}

@tab

Obtiene la fábrica @ref{a6e,,loop.create_task()} que se usa para crear @ref{580,,Tareas}.

@end multitable


@subsubheading DNS



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{c9c,,loop.getaddrinfo()}

@tab

Versión asincrónica de @ref{175a,,socket.getaddrinfo()}.

@item

@code{await} @ref{c9d,,loop.getnameinfo()}

@tab

Versión asincrónica de @ref{16cd,,socket.getnameinfo()}.

@end multitable


@subsubheading Redes e IPC



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{6a4,,loop.create_connection()}

@tab

Abre una conexión TCP.

@item

@code{await} @ref{b9e,,loop.create_server()}

@tab

Crea un servidor TCP.

@item

@code{await} @ref{3209,,loop.create_unix_connection()}

@tab

Abre una conexión de socket Unix.

@item

@code{await} @ref{315,,loop.create_unix_server()}

@tab

Crea un servidor socket de Unix.

@item

@code{await} @ref{d05,,loop.connect_accepted_socket()}

@tab

Envuelve un @ref{e27,,socket} en un par @code{(transport, protocol)}.

@item

@code{await} @ref{7cf,,loop.create_datagram_endpoint()}

@tab

Abre una conexión de datagramas (UDP).

@item

@code{await} @ref{329a,,loop.sendfile()}

@tab

Envía un archivo a través del transporte.

@item

@code{await} @ref{b94,,loop.start_tls()}

@tab

Actualiza una conexión existente a TLS.

@item

@code{await} @ref{324c,,loop.connect_read_pipe()}

@tab

Envuelve el fin de lectura de `pipe' en un par @code{(transport, protocol)}.

@item

@code{await} @ref{324d,,loop.connect_write_pipe()}

@tab

Envuelve el fin de escritura de `pipe' en un par @code{(transport, protocol)}.

@end multitable


@subsubheading Sockets



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{c99,,loop.sock_recv()}

@tab

Recibe datos de @ref{e27,,socket}.

@item

@code{await} @ref{b95,,loop.sock_recv_into()}

@tab

Recibe datos de @ref{e27,,socket} en un buffer.

@item

@code{await} @ref{6a7,,loop.sock_recvfrom()}

@tab

Recibe un datagrama desde @ref{e27,,socket}.

@item

@code{await} @ref{6a8,,loop.sock_recvfrom_into()}

@tab

Recibe un datagrama desde @ref{e27,,socket} en un buffer.

@item

@code{await} @ref{c9a,,loop.sock_sendall()}

@tab

Envía datos a @ref{e27,,socket}.

@item

@code{await} @ref{6a6,,loop.sock_sendto()}

@tab

Envía un datagrama a través de @ref{e27,,socket} a la dirección indicada.

@item

@code{await} @ref{e4f,,loop.sock_connect()}

@tab

Conecta con @ref{e27,,socket}.

@item

@code{await} @ref{c9b,,loop.sock_accept()}

@tab

Acepta una conexión @ref{e27,,socket}.

@item

@code{await} @ref{b99,,loop.sock_sendfile()}

@tab

Envía un archivo a través de @ref{e27,,socket}.

@item

@ref{3224,,loop.add_reader()}

@tab

Comienza a monitorear un descriptor de archivo para ver la disponibilidad de lectura.

@item

@ref{329d,,loop.remove_reader()}

@tab

Detiene el monitoreo del descriptor de archivo para ver la disponibilidad de lectura.

@item

@ref{329e,,loop.add_writer()}

@tab

Comienza a monitorear un descriptor de archivo para ver la disponibilidad de escritura.

@item

@ref{329f,,loop.remove_writer()}

@tab

Detiene el monitoreo del descriptor de archivo para ver la disponibilidad de escritura.

@end multitable


@subsubheading Señales Unix



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{32a7,,loop.add_signal_handler()}

@tab

Añade un gestor para @ref{c6,,signal}.

@item

@ref{32a8,,loop.remove_signal_handler()}

@tab

Elimina un gestor para @ref{c6,,signal}.

@end multitable


@subsubheading Subprocesos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3249,,loop.subprocess_exec()}

@tab

Genera un subproceso.

@item

@ref{324a,,loop.subprocess_shell()}

@tab

Genera un subproceso desde un comando de shell.

@end multitable


@subsubheading Gestor de errores



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{32ac,,loop.call_exception_handler()}

@tab

Invoca al gestor de excepciones.

@item

@ref{32ab,,loop.set_exception_handler()}

@tab

Establece un nuevo gestor de excepciones.

@item

@ref{d02,,loop.get_exception_handler()}

@tab

Obtiene el gestor de excepciones actual.

@item

@ref{32ad,,loop.default_exception_handler()}

@tab

La implementación predetermina del gestor de excepciones.

@end multitable


@subsubheading Ejemplos



@itemize *

@item 
@ref{32b8,,Usando asyncio.new_event_loop() y loop.run_forever()}.

@item 
@ref{32ba,,Usando loop.call_later()}.

@item 
Usando @code{loop.create_connection()} para implementar @ref{321b,,un cliente de eco}.

@item 
Usando @code{loop.create_connection()} para @ref{3222,,conectar a un socket}.

@item 
@ref{3223,,Usando add_reader() para mirar un FD y leer eventos}.

@item 
@ref{32bd,,Usando loop.add_signal_handler()}.

@item 
@ref{3260,,Usando loop.subprocess_exec()}.
@end itemize

@node Transportes<2>,Protocolos<2>,Métodos del bucle de eventos<2>,Índice de API de bajo nivel
@anchor{library/asyncio-llapi-index transports}@anchor{3330}
@subsubsection Transportes


Todos los transportes implementan los siguientes métodos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3293,,transport.close()}

@tab

Cierra el transporte.

@item

@ref{d00,,transport.is_closing()}

@tab

Retorna @code{True} si el transporte está cerrado o se está cerrando.

@item

@ref{b27,,transport.get_extra_info()}

@tab

Solicita información sobre el transporte.

@item

@ref{32d8,,transport.set_protocol()}

@tab

Establece un nuevo protocolo.

@item

@ref{32d9,,transport.get_protocol()}

@tab

Retorna el protocolo actual.

@end multitable


Transportes que pueden recibir datos (conexiones TCP y Unix, `pipes', etc). Retornan de métodos como @ref{6a4,,loop.create_connection()}, @ref{3209,,loop.create_unix_connection()}, @code{loop.connect_read()}, etc:

@subsubheading Leer transportes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{ba6,,transport.is_reading()}

@tab

Retorna @code{True} si el transporte está recibiendo.

@item

@ref{ba8,,transport.pause_reading()}

@tab

Pausa la recepción.

@item

@ref{ba7,,transport.resume_reading()}

@tab

Reanuda la recepción.

@end multitable


Transportes que pueden enviar datos (conexiones TCP y Unix, `pipes', etc). Retornan de métodos como @ref{6a4,,loop.create_connection()}, @ref{3209,,loop.create_unix_connection()}, @ref{324d,,loop.connect_write_pipe()}, etc:

@subsubheading Escribir transportes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{32e2,,transport.write()}

@tab

Escribe datos en el transporte.

@item

@ref{1733,,transport.writelines()}

@tab

Escribe búferes en el transporte.

@item

@ref{32dc,,transport.can_write_eof()}

@tab

Retorna @ref{c95,,True} si el transporte admite el envío de EOF.

@item

@ref{32dd,,transport.write_eof()}

@tab

Cierra y envía EOF después de vaciar los datos almacenados en búfer.

@item

@ref{32b5,,transport.abort()}

@tab

Cierra el transporte inmediatamente.

@item

@ref{32de,,transport.get_write_buffer_size()}

@tab

Retorna el tamaño actual del búfer de salida.

@item

@ref{e4a,,transport.get_write_buffer_limits()}

@tab

Retorna los límites superior e inferior para controlar el flujo de escritura.

@item

@ref{32df,,transport.set_write_buffer_limits()}

@tab

Establece nuevos límites superior e inferior para el control del flujo de escritura.

@end multitable


Transportes retornados por @ref{7cf,,loop.create_datagram_endpoint()}:

@subsubheading Transportes de datagramas



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{316,,transport.sendto()}

@tab

Envía datos al par remoto.

@item

@ref{32e4,,transport.abort()}

@tab

Cierra el transporte inmediatamente.

@end multitable


Abstracción de transporte de bajo nivel sobre subprocesos. Retornado por @ref{3249,,loop.subprocess_exec()} y @ref{324a,,loop.subprocess_shell()}:

@subsubheading Transportes de subprocesos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{32e6,,transport.get_pid()}

@tab

Retorna el id de proceso del subproceso.

@item

@ref{32e7,,transport.get_pipe_transport()}

@tab

Retorna el transporte para la `pipe' de comunicación solicitada (`stdin', `stdout' o `stderr').

@item

@ref{32e8,,transport.get_returncode()}

@tab

Retorna el código de retorno del subproceso.

@item

@ref{32e9,,transport.kill()}

@tab

Mata el subproceso.

@item

@ref{32eb,,transport.send_signal()}

@tab

Envía una señal al subproceso.

@item

@ref{32ea,,transport.terminate()}

@tab

Detiene el subproceso.

@item

@ref{32ec,,transport.close()}

@tab

Mata el subproceso y cierra todas las `pipes'.

@end multitable


@node Protocolos<2>,Políticas de bucle de eventos,Transportes<2>,Índice de API de bajo nivel
@anchor{library/asyncio-llapi-index protocols}@anchor{3331}
@subsubsection Protocolos


Las clases de protocolo pueden implementar los siguientes `métodos de devolución de llamada':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{3291,,connection_made()}

@tab

Se llama cuando se establece una conexión.

@item

@code{callback} @ref{32d4,,connection_lost()}

@tab

Se llama cuando la conexión se pierde o cierra.

@item

@code{callback} @ref{32e0,,pause_writing()}

@tab

Se llama cuando el búfer del transporte excede el límite superior.

@item

@code{callback} @ref{32e1,,resume_writing()}

@tab

Se llama cuando el búfer del transporte se vacía por debajo del límite inferior.

@end multitable


@subsubheading Protocolos de streaming (TCP, Unix Sockets, Pipes)



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{1795,,data_received()}

@tab

Se llama cuando se reciben algunos datos.

@item

@code{callback} @ref{32f0,,eof_received()}

@tab

Se llama cuando se recibe un EOF.

@end multitable


@subsubheading Protocolos de streaming en búfer



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{32f2,,get_buffer()}

@tab

Se llama para asignar un nuevo búfer de recepción.

@item

@code{callback} @ref{32f3,,buffer_updated()}

@tab

Se llama cuando el búfer se actualizó con los datos recibidos.

@item

@code{callback} @ref{32f4,,eof_received()}

@tab

Se llama cuando se recibe un EOF.

@end multitable


@subsubheading Protocolos de datagramas



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{32f6,,datagram_received()}

@tab

Se llama cuando se recibe un datagrama.

@item

@code{callback} @ref{32f7,,error_received()}

@tab

Se llama cuando una operación de envío o recepción anterior genera un @ref{4d5,,OSError}.

@end multitable


@subsubheading Protocolos de subprocesos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{17cc,,pipe_data_received()}

@tab

Se llama cuando el proceso hijo escribe datos en su `pipe' `stdout' o `stderr'.

@item

@code{callback} @ref{32f9,,pipe_connection_lost()}

@tab

Se llama cuando se cierra un `pipe' que se comunica con el proceso hijo.

@item

@code{callback} @ref{17cb,,process_exited()}

@tab

Called when the child process has exited. It can be called before
@ref{17cc,,pipe_data_received()} and
@ref{32f9,,pipe_connection_lost()} methods.

@end multitable


@node Políticas de bucle de eventos,,Protocolos<2>,Índice de API de bajo nivel
@anchor{library/asyncio-llapi-index event-loop-policies}@anchor{3332}
@subsubsection Políticas de bucle de eventos


Las políticas son un mecanismo de bajo nivel para alterar el comportamiento de funciones como @ref{214,,asyncio.get_event_loop()}. Vea también la sección principal @ref{327d,,políticas} para más detalles.

@subsubheading Acceso a políticas



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3308,,asyncio.get_event_loop_policy()}

@tab

Retorna la política actual en todo el proceso.

@item

@ref{3309,,asyncio.set_event_loop_policy()}

@tab

Establece una nueva política para todo el proceso.

@item

@ref{3306,,AbstractEventLoopPolicy}

@tab

Clase base para objetos de política.

@end multitable


@node Desarrollando con asyncio,,Índice de API de bajo nivel,asyncio — Asynchronous I/O
@anchor{library/asyncio-dev doc}@anchor{3333}@anchor{library/asyncio-dev asyncio-dev}@anchor{3334}@anchor{library/asyncio-dev developing-with-asyncio}@anchor{3335}
@subsubsection Desarrollando con asyncio


La programación asincrónica es diferente a la programación «secuencial» clásica.

Esta página enumera errores y trampas comunes y explica cómo evitarlos.

@menu
* Modo depuración:: 
* Concurrencia y multihilo:: 
* Ejecutando código bloqueante:: 
* Logueando:: 
* Detectar corrutinas no esperadas:: 
* Detectar excepciones nunca recuperadas:: 

@end menu

@node Modo depuración,Concurrencia y multihilo,,Desarrollando con asyncio
@anchor{library/asyncio-dev asyncio-debug-mode}@anchor{1d55}@anchor{library/asyncio-dev debug-mode}@anchor{3336}
@subsubsection Modo depuración


Por defecto asyncio se ejecuta en modo producción. Para facilitar el desarrollo asyncio tiene un `modo depuración'.

Hay varias maneras de habilitar el modo depuración de asyncio:


@itemize *

@item 
Definiendo la variable de entorno 
@geindex PYTHONASYNCIODEBUG
@geindex variables de entorno; PYTHONASYNCIODEBUG
@ref{1d54,,PYTHONASYNCIODEBUG} a @code{1}.

@item 
Usando @ref{356,,Modo de Desarrollo de Python}.

@item 
Pasando @code{debug=True} a @ref{525,,asyncio.run()}.

@item 
Invocando @ref{e47,,loop.set_debug()}.
@end itemize

Además de habilitar el modo depuración, considere también:


@itemize *

@item 
definir el nivel de log del @ref{3337,,asyncio logger} a @ref{1cf9,,logging.DEBUG}, por ejemplo el siguiente fragmento de código puede ser ejecutado al inicio de la aplicación:

@example
logging.basicConfig(level=logging.DEBUG)
@end example

@item 
configurando el módulo @ref{112,,warnings} para mostrar advertencias @ref{39d,,ResourceWarning}. Una forma de hacerlo es usando la opción @ref{95e,,-W} @code{default} de la línea de comandos.
@end itemize

Cuando el modo depuración está habilitado:


@itemize *

@item 
asyncio comprueba las @ref{3338,,corrutinas que no son esperadas} y las registra; esto mitiga la dificultad de las «esperas olvidadas».

@item 
Muchas APIs asyncio que no son seguras para hilos (como los métodos @ref{b8f,,loop.call_soon()} y @ref{b92,,loop.call_at()}) generan una excepción si son llamados desde un hilo equivocado.

@item 
El tiempo de ejecución del selector E/S es registrado si tarda demasiado tiempo en realizar una operación E/S.

@item 
Los callbacks que tardan más de 100ms son registrados. El atributo @ref{32af,,loop.slow_callback_duration} puede ser usado para definir la duración mínima de ejecución en segundos que se considere como «lenta».
@end itemize

@node Concurrencia y multihilo,Ejecutando código bloqueante,Modo depuración,Desarrollando con asyncio
@anchor{library/asyncio-dev asyncio-multithreading}@anchor{31f3}@anchor{library/asyncio-dev concurrency-and-multithreading}@anchor{3339}
@subsubsection Concurrencia y multihilo


Un bucle de eventos se ejecuta en un hilo (generalmente el hilo principal) y ejecuta todos los callbacks y las Tareas en su hilo. Mientras una Tarea está ejecutándose en el bucle de eventos, ninguna otra Tarea puede ejecutarse en el mismo hilo. Cuando una Tarea ejecuta una expresión @code{await}, la Tarea en ejecución se suspende y el bucle de eventos ejecuta la siguiente Tarea.

Para programar un @ref{290d,,callback} desde otro hilo del SO, se debe usar el método @ref{b90,,loop.call_soon_threadsafe()}. Ejemplo:

@example
loop.call_soon_threadsafe(callback, *args)
@end example

Casi ningún objeto asyncio es seguro entre hilos (`thread safe'), lo cual generalmente no es un problema a no ser que haya código que trabaje con ellos desde fuera de una Tarea o un callback. Si tal código necesita llamar a la API de asyncio de bajo nivel, se debe usar el método @ref{b90,,loop.call_soon_threadsafe()}, por ejemplo:

@example
loop.call_soon_threadsafe(fut.cancel)
@end example

Para programar un objeto de corrutina desde una hilo diferente del sistema operativo se debe usar la función @ref{91a,,run_coroutine_threadsafe()}. Esta retorna un @ref{1220,,concurrent.futures.Future} para acceder al resultado:

@example
async def coro_func():
     return await asyncio.sleep(1, 42)

# Later in another OS thread:

future = asyncio.run_coroutine_threadsafe(coro_func(), loop)
# Wait for the result:
result = future.result()
@end example

Para manejar señales el bucle de eventos debe ser ejecutado en el hilo principal.

The @ref{980,,loop.run_in_executor()} method can be used with a
@ref{7dd,,concurrent.futures.ThreadPoolExecutor} or
@ref{161,,InterpreterPoolExecutor} to execute
blocking code in a different OS thread without blocking the OS thread
that the event loop runs in.

Actualmente no hay forma de programar corrutinas o retrollamadas directamente desde un proceso diferente (como uno que haya comenzado con @ref{94,,multiprocessing}). La sección @ref{3283,,Métodos del bucle de eventos} enumera las API que pueden leer desde tuberías y descriptores de archivos sin bloquear el bucle de eventos. Además, las API @ref{31c6,,Subprocess} de asyncio proporcionan una forma de iniciar un proceso y comunicarse con él desde el bucle de eventos. Por último, el método @ref{980,,loop.run_in_executor()} mencionado anteriormente también se puede usar con un @ref{163,,concurrent.futures.ProcessPoolExecutor} para ejecutar código en un proceso diferente.

@node Ejecutando código bloqueante,Logueando,Concurrencia y multihilo,Desarrollando con asyncio
@anchor{library/asyncio-dev asyncio-handle-blocking}@anchor{333a}@anchor{library/asyncio-dev running-blocking-code}@anchor{333b}
@subsubsection Ejecutando código bloqueante


Código bloqueante (dependiente de la CPU) no debe ser ejecutado directamente. Por ejemplo, si una función realiza un cálculo intensivo de CPU durante 1 segundo, todas las Tareas y operaciones de Entrada/Salida (IO) concurrentes se retrasarían 1 segundo.

An executor can be used to run a task in a different thread,
including in a different interpreter, or even in
a different process to avoid blocking the OS thread with the
event loop.  See the @ref{980,,loop.run_in_executor()} method for more
details.

@node Logueando,Detectar corrutinas no esperadas,Ejecutando código bloqueante,Desarrollando con asyncio
@anchor{library/asyncio-dev asyncio-logger}@anchor{3337}@anchor{library/asyncio-dev logging}@anchor{333c}
@subsubsection Logueando


asyncio usa el módulo @ref{87,,logging} y todo el logueo es realizado mediante el logger @code{"asyncio"}.

El nivel de log por defecto es @ref{1cfa,,logging.INFO}, el cual puede ser fácilmente ajustado:

@example
logging.getLogger("asyncio").setLevel(logging.WARNING)
@end example

Loguear por la red puede bloquear el bucle de eventos. Se recomienda usar un subproceso separado para manejar registros o usar sin bloqueo IO. Por ejemplo, consulte @ref{333d,,Tratar con gestores que bloquean}.

@node Detectar corrutinas no esperadas,Detectar excepciones nunca recuperadas,Logueando,Desarrollando con asyncio
@anchor{library/asyncio-dev asyncio-coroutine-not-scheduled}@anchor{3338}@anchor{library/asyncio-dev detect-never-awaited-coroutines}@anchor{333e}
@subsubsection Detectar corrutinas no esperadas


Cuando una función de corrutina es invocada, pero no esperada (por ejemplo @code{coro()} en lugar de @code{await coro()}) o la corrutina no es programada con @ref{69d,,asyncio.create_task()}, asyncio emitirá una @ref{323,,RuntimeWarning}:

@example
import asyncio

async def test():
    print("never scheduled")

async def main():
    test()

asyncio.run(main())
@end example

Salida:

@example
test.py:7: RuntimeWarning: coroutine 'test' was never awaited
  test()
@end example

Salida en modo depuración:

@example
test.py:7: RuntimeWarning: coroutine 'test' was never awaited
Coroutine created at (most recent call last)
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

  < .. >

  File "../t.py", line 7, in main
    test()
  test()
@end example

La solución habitual es esperar la corrutina o llamar a la función @ref{69d,,asyncio.create_task()}:

@example
async def main():
    await test()
@end example

@node Detectar excepciones nunca recuperadas,,Detectar corrutinas no esperadas,Desarrollando con asyncio
@anchor{library/asyncio-dev detect-never-retrieved-exceptions}@anchor{333f}
@subsubsection Detectar excepciones nunca recuperadas


Si un @ref{31f8,,Future.set_exception()} es invocado pero el objeto Futuro nunca es esperado, la excepción nunca será propagada al código del usuario. En este caso, asyncio emitiría un mensaje de registro cuando el objeto Futuro fuera recolectado como basura.

Ejemplo de una excepción no manejada:

@example
import asyncio

async def bug():
    raise Exception("not consumed")

async def main():
    asyncio.create_task(bug())

asyncio.run(main())
@end example

Salida:

@example
Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
  exception=Exception('not consumed')>

Traceback (most recent call last):
  File "test.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed
@end example

@ref{1d55,,Habilita el modo depuración} para obtener el seguimiento de pila (`traceback') donde la tarea fue creada:

@example
asyncio.run(main(), debug=True)
@end example

Salida en modo depuración:

@example
Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
    exception=Exception('not consumed') created at asyncio/tasks.py:321>

source_traceback: Object created at (most recent call last):
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

< .. >

Traceback (most recent call last):
  File "../t.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed
@end example

@cartouche
@quotation Nota 
El código fuente para asyncio puede encontrarse en Lib/asyncio/@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/}.
@end quotation
@end cartouche

@node socket — Low-level networking interface,ssl — TLS/SSL wrapper for socket objects,asyncio — Asynchronous I/O,Comunicación en redes y entre procesos
@anchor{library/socket doc}@anchor{3340}@anchor{library/socket module-socket}@anchor{cc}@anchor{library/socket socket-low-level-networking-interface}@anchor{3341}
@subsection @code{socket} — Low-level networking interface


@geindex module; socket

`Código fuente:' Lib/socket.py@footnote{https://github.com/python/cpython/tree/main/Lib/socket.py}


__________________________________________________________________


Este módulo proporciona acceso a la interfaz BSD `socket'. Está disponible en todos los sistemas Unix modernos, Windows, MacOS y probablemente plataformas adicionales.

@cartouche
@quotation Nota 
Algunos comportamientos pueden depender de la plataforma, ya que las llamadas se realizan a las API de socket del sistema operativo.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@geindex objetos Socket;objetos Socket

The Python interface is a straightforward transliteration of the Unix system
call and library interface for sockets to Python’s object-oriented style: the
@ref{e27,,socket()} function returns a `socket object' whose methods implement
the various socket system calls.  Parameter types are somewhat higher-level than
in the C interface: as with @code{read()} and @code{write()} operations on Python
files, buffer allocation on receive operations is automatic, and buffer length
is implicit on send operations.


@subsubheading Ver también



@table @asis

@item Módulo @ref{cd,,socketserver}

Clases que simplifican la escritura de servidores de red.

@item Módulo @ref{d0,,ssl}

Un contenedor TLS/SSL para objetos de socket.
@end table


@menu
* Familias Socket:: 
* Contenido del módulo:: 
* Objetos Socket:: 
* Notas sobre los tiempos de espera del socket:: 
* Ejemplo: Ejemplo<7>. 

@end menu

@node Familias Socket,Contenido del módulo,,socket — Low-level networking interface
@anchor{library/socket socket-families}@anchor{3342}
@subsubsection Familias Socket


Dependiendo del sistema y de las opciones de compilación, este módulo admite varias familias de sockets.

El formato de dirección requerido por un objeto de socket determinado se selecciona automáticamente en función de la familia de direcciones especificada cuando se creó el objeto de socket.  Las direcciones de socket se representan de la siguiente manera:


@itemize -

@item 
La dirección de un socket @ref{1826,,AF_UNIX} enlazado a un nodo del sistema de archivos es representado como una cadena de caracteres, utilizando la codificación del sistema de archivos y el controlador de errores @code{'surrogateescape'} (Observar 
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). Una dirección en el espacio de nombre abstracto de Linux es devuelvo como un @ref{db4,,bytes-like object} con un byte inicial nulo; tenga en cuenta que los sockets en este nombre de espacio puede comunicarse con sockets normales del sistema de archivos, así que los programas destinados a correr en Linux podrían necesitar tratar con ambos tipos de direcciones. Se puede pasar un objeto similar a una cadena de caracteres o bytes para cualquier tipo de dirección al pasarlo como argumento.


Distinto en la versión 3.3: Anteriormente, se suponía que las rutas de socket @ref{1826,,AF_UNIX} utilizaban codificación UTF-8.



Distinto en la versión 3.5: Ahora se acepta la grabación @ref{db4,,bytes-like object}.

@end itemize
@anchor{library/socket host-port}@anchor{3343}

@itemize -

@item 
Se utiliza un par @code{(host, port)} para la familia de direcciones @ref{1824,,AF_INET}, donde `host' es una cadena que representa un nombre de host en notación de dominio de Internet como @code{'daring.cwi.nl'} o una dirección IPv4 como @code{'100.50.200.5'}, y `port' es un número entero.


@itemize -

@item 
Para direcciones IPv4, se aceptan dos formas especiales en lugar de una dirección de host: @code{’’} representa @code{INADDR_ANY}, que se utiliza para enlazar a todas las interfaces, y la cadena de caracteres @code{'<broadcast>'} representa @code{INADDR_BROADCAST}. Este comportamiento no es compatible con IPv6, por lo tanto, es posible que desee evitarlos sí tiene la intención de admitir IPv6 con sus programas Python.
@end itemize

@item 
Para la familia de direcciones @ref{1825,,AF_INET6}, se utiliza una @code{(host, port, flowinfo, scope_id)} de cuatro tuplas, donde `flowinfo' y `scope_id' representan los miembros @code{sin6_flowinfo} y @code{sin6_scope_id} en @code{struct sockaddr_in6} en C. Para los métodos de los módulos @ref{cc,,socket}, `flowinfo' y `scope_id' pueden ser omitidos solo por compatibilidad con versiones anteriores. Sin embargo la omisión de `scope_id' puede causar problemas en la manipulación de direcciones IPv6 con ámbito.


Distinto en la versión 3.7: Para direcciones de multidifusión (con `scopeid' significativo) `address' puede no contener la parte @code{%scope} (o @code{zone id}). Esta información es superflua y puede omitirse de forma segura (recomendado).


@item 
@code{AF_NETLINK} sockets se representan como pares @code{(pid, groups)}.

@item 
La compatibilidad con LINUX solo para TIPC está disponible mediante la familia de direcciones @code{AF_TIPC}.  TIPC es un protocolo en red abierto y no basado en IP diseñado para su uso en entornos informáticos agrupados.  Las direcciones se representan mediante una tupla y los campos dependen del tipo de dirección. El formulario de tupla general es @code{(addr_type, v1, v2, v3 [, scope])}, donde:


@itemize -

@item 
`addr_type' es uno de @code{TIPC_ADDR_NAMESEQ}, @code{TIPC_ADDR_NAME}, o @code{TIPC_ADDR_ID}.

@item 
`scope' es una de @code{TIPC_ZONE_SCOPE}, @code{TIPC_CLUSTER_SCOPE}, y @code{TIPC_NODE_SCOPE}.

@item 
Si `addr_type' es @code{TIPC_ADDR_NAME}, entonces `v1' es el tipo de servidor, `v2' es el identificador de puerto, y `v3' debe ser 0.

Si `addr_type' es @code{TIPC_ADDR_NAMESEQ}, entonces  `v1' es el tipo de servidor, `v2' es el numero de puerto inferior, y `v3' es el numero de puerto superior.

Si `addr_type' es @code{TIPC_ADDR_ID}, `v1' es el nodo, `v2' es la referencia y `v3' debe establecerse en 0.
@end itemize

@item 
Una tupla @code{(interface, )} es usada para la dirección de familia @ref{3344,,AF_CAN}, donde `interface' es una cadena de caracteres representando a un nombre de interfaz de red como @code{’can0’}. La interfaz de red llamada @code{'@w{'}} puede ser usada para recibir paquetes de todas las interfaces de red de esta familia.


@itemize -

@item 
Protocolo @ref{3345,,CAN_ISOTP} requiere una tupla @code{(interface, rx_addr, tx_addr)} donde ambos tiene parámetros adicionales son enteres largos sin símbolos que representan una identificador CAN (estándar o extendido).

@item 
Protocolo @ref{9c5,,CAN_J1939} requiere una tupla @code{(interface, name, pgn, addr)} donde los parámetros adicionales son números enteros sin signo de 64 bits representando el nombre ECU, los enteros sin signo de 32-bits representan el numero de grupo de parámetros(PGN), y los enteros de 8-bit representan la dirección.
@end itemize

@item 
Se utiliza una cadena o una tupla @code{(id, unit)} para el protocolo @code{SYSPROTO_CONTROL} de la familia @code{PF_SYSTEM}. La cadena es el nombre de un control de kernel mediante un ID asignado dinámicamente. La tupla se puede utilizar si se conoce el ID y el número de unidad del control del kernel o si se utiliza un ID registrado.


Added in version 3.3.


@item 
@code{AF_BLUETOOTH} admite los siguientes protocolos y formatos de dirección:


@itemize -

@item 
@code{BTPROTO_L2CAP} acepta @code{(bdaddr, psm)} donde @code{bdaddr} es la dirección Bluetooth como una cadena de caracteres y @code{psm} es un entero.

@item 
@code{BTPROTO_RFCOMM} acepta @code{(bdaddr, channel)} donde @code{bdaddr} es la dirección Bluetooth como una cadena de caracteres y @code{channel} es un entero.

@item 
@code{BTPROTO_HCI} acepta @code{(device_id,)} donde @code{device_id} es un numero entero o una cadena de caracteres con la dirección Bluetooth de la interfaz. (Esto depende de tu OS; NetBSD y DragonFlyBSD supone una dirección Bluetooth mientras todo lo demás espera un entero.)


Distinto en la versión 3.2: Se ha añadido compatibilidad con NetBSD y DragonFlyBSD.


@item 
@code{BTPROTO_SCO} acepta @code{bdaddr} donde @code{bdaddr} es un objeto @ref{325,,bytes} que contiene la dirección Bluetooth en un formato cadena. (ex. @code{b’12:23:34:45:56:67’}) este protocolo no es admitido bajo FreeBSD.
@end itemize

@item 
@ref{d5e,,AF_ALG} es una interfaz basada en socket solo Linux para la criptografía del núcleo. Un socket de algoritmo se configura con una tupla de dos a cuatro elementos @code{(type, name [, feat [, mask]])}, donde:


@itemize -

@item 
`type' es el tipo de algoritmos como cadenas de caracteres, e.g. @code{aead}, @code{hash}, @code{skcipher} o @code{rng}.

@item 
`name' es el nombre del algoritmo y el modo de operación como cadena de caracteres, e.g. @code{sha256}, @code{hmac(sha256)}, @code{cbc(aes)} o @code{drbg_nopr_ctr_aes256}.

@item 
`feat' y `mask' son enteros de 32 bits sin signo.
@end itemize

@ref{1d5a,,Availability}: Linux >= 2.6.38.

Algunos tipos de algoritmos requieren Kernels mas recientes.


Added in version 3.6.


@item 
@ref{bfd,,AF_VSOCK} permite comunicación entre maquinas virtuales y sus hosts. Los sockets están representando como una tupla @code{(CID, port)} donde el contexto del ID o CID y el puerto son enteros.

@ref{1d5a,,Availability}: Linux >= 3.9

Véase @code{vsock(7)@footnote{https://manpages.debian.org/vsock(7)}}


Added in version 3.7.


@item 
@ref{3346,,AF_PACKET} is a low-level interface directly to network devices.
The addresses are represented by the tuple
@code{(ifname, proto[, pkttype[, hatype[, addr]]])} where:


@itemize -

@item 
`ifname' - Cadena que especifica el nombre del dispositivo.

@item 
`proto' - The Ethernet protocol number.
May be @ref{17b0,,ETH_P_ALL} to capture all protocols,
one of the @ref{17b1,,ETHERTYPE_* constants}
or any other Ethernet protocol number.

@item 
`pkttype' - Entero opcional especificando el tipo de paquete:


@itemize -

@item 
@code{PACKET_HOST} (por defecto) - Paquetes diseccionado al local host.

@item 
@code{PACKET_BROADCAST} - Paquete de transmisión de la capa física.

@item 
@code{PACKET_MULTICAST} - Paquete enviado a una dirección de multidifusión de capa física.

@item 
@code{PACKET_OTHERHOST} - Paquete a otro host que haya sido capturado por un controlador de dispositivo en modo promiscuo.

@item 
@code{PACKET_OUTGOING} - Paquete originalmente desde el local host que se enlaza de nuevo a un conector de paquetes.
@end itemize

@item 
`hatype' - Entero opcional que especifica el tipo de dirección de hardware ARP.

@item 
`addr' - Objeto opcional en forma de bytes que especifica la dirección física del hardware, cuya interpretación depende del dispositivo.
@end itemize

@ref{1d5a,,Availability}: Linux >= 2.2.

@item 
@ref{3347,,AF_QIPCRTR} es una interfaz basada en sockets solo para Linux para comunicarse con servicios que se ejecutan en co-procesadores en plataformas Qualcomm. La familia de direcciones se representa como una tupla @code{(node, port)} donde el `node' y `port' son enteros no negativos.

@ref{1d5a,,Availability}: Linux >= 4.7.


Added in version 3.8.


@item 
@code{IPPROTO_UDPLITE} es una variante de UDO que te permite especificar que porción del paquete es cubierta con la suma de comprobación. Esto agrega dos opciones al socket que pueden cambiar. @code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length)} cambiara que parte de los paquetes salientes están cubierta por la suma de comprobación y @code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length)} filtrara los paquetes que permitirá cubrir una pequeña parte de tu datos. En ambos casos @code{length} deben estar en @code{range(8, 2**16, 8)}.

Tal socket debe construirse como @code{socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE)} para IPV4 o @code{socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE)} para IPV6.

@ref{1d5a,,Availability}: Linux >= 2.6.20, FreeBSD >= 10.1


Added in version 3.9.


@item 
@ref{3348,,AF_HYPERV} es una interfaz basada en sockets exclusiva de Windows para comunicarse con hosts e invitados de Hyper-V. La familia de direcciones se representa como una tupla @code{(vm_id, service_id)} donde @code{vm_id} y @code{service_id} son cadenas UUID.

El @code{vm_id} es el identificador de la máquina virtual o un conjunto de VMID conocidos valores si el objetivo no es una máquina virtual específica. Constantes VMID conocidas definidos en @code{socket} son:


@itemize -

@item 
@code{HV_GUID_ZERO}

@item 
@code{HV_GUID_BROADCAST}

@item 
@code{HV_GUID_WILDCARD} - Se utiliza para vincularse a sí mismo y aceptar conexiones de todas las particiones.

@item 
@code{HV_GUID_CHILDREN} - Se utiliza para vincularse a sí mismo y aceptar conexiones desde particiones secundarias.

@item 
@code{HV_GUID_LOOPBACK} - Se utiliza como objetivo para sí mismo.

@item 
@code{HV_GUID_PARENT} - Cuando se usa como enlace, acepta la conexión del padre partición. Cuando se utiliza como dirección de destino, se conectará al padre dividir.
@end itemize

El @code{service_id} es el identificador del servicio registrado.


Added in version 3.12.

@end itemize

Si utiliza un nombre de host en la parte `host' de la dirección de socket IPv4/v6, el programa puede mostrar un comportamiento no determinista, ya que Python utiliza la primera dirección devuelta por la resolución DNS.  La dirección del socket se resolverá de manera diferente en una dirección IPv4/v6 real, dependiendo de los resultados de la resolución DNS y/o la configuración del host.  Para un comportamiento determinista, utilice una dirección numérica en la parte `host'.

Todos los errores generan excepciones. Las excepciones normales para tipos de argumentos inválidos y condiciones de falta de memoria pueden ser lanzadas. Los errores relacionados con la semántica de los sockets o de las direcciones lanzan @ref{4d5,,OSError} o una de sus subclases.

El modo de no bloqueo es compatible a través de @ref{2b41,,setblocking()}.  Se admite una generalización de esto basada en los tiempos de espera a través de @ref{3349,,settimeout()}.

@node Contenido del módulo,Objetos Socket,Familias Socket,socket — Low-level networking interface
@anchor{library/socket module-contents}@anchor{334a}
@subsubsection Contenido del módulo


El módulo @ref{cc,,socket} exporta los siguientes elementos.

@menu
* Excepciones: Excepciones<13>. 
* Constantes: Constantes<8>. 
* Funciones: Funciones<6>. 

@end menu

@node Excepciones<13>,Constantes<8>,,Contenido del módulo
@anchor{library/socket exceptions}@anchor{334b}
@subsubsection Excepciones


@geindex error
@anchor{library/socket socket error}@anchor{10d1}
@deffn {Excepción} socket.error

Un alias en desuso de @ref{4d5,,OSError}.


Distinto en la versión 3.3: Siguiendo 
@geindex Python Enhancement Proposals; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}, es clase fue creada como un alias de @ref{4d5,,OSError}.

@end deffn

@geindex herror
@anchor{library/socket socket herror}@anchor{334c}
@deffn {Excepción} socket.herror

Una subclase de @ref{4d5,,OSError}, esta excepción se produce para los errores relacionados con la dirección, es decir, para las funciones que utilizan `h_errno' en la API de POSIX C, incluidas @ref{18d6,,gethostbyname_ex()} y @ref{18d5,,gethostbyaddr()}. El valor adjunto es un par @code{(h_errno, string)} que representa un error devuelto por una llamada a la biblioteca.  `h_errno' es un valor numérico, mientras que `string' representa la descripción de `h_errno', devuelta por la función @code{hstrerror()} C.


Distinto en la versión 3.3: Esta clase fue creada como una subclase de @ref{4d5,,OSError}.

@end deffn

@geindex gaierror
@anchor{library/socket socket gaierror}@anchor{175b}
@deffn {Excepción} socket.gaierror

A subclass of @ref{4d5,,OSError}, this exception is raised for
address-related errors by @ref{175a,,getaddrinfo()} and @ref{16cd,,getnameinfo()}.
The accompanying value is a pair @code{(error, string)} representing an error
returned by a library call.  `string' represents the description of
`error', as returned by the @code{gai_strerror()} C function.  The
numeric `error' value will match one of the @code{EAI_*} constants
defined in this module.


Distinto en la versión 3.3: Esta clase fue creada como una subclase de @ref{4d5,,OSError}.

@end deffn

@geindex timeout
@anchor{library/socket socket timeout}@anchor{8cb}
@deffn {Excepción} socket.timeout

Un alias obsoleto de @ref{8cc,,TimeoutError}.

Una subclase de @ref{4d5,,OSError}, esta excepción se genera cuando ocurre un `timeout' en un socket que ha tenido tiempos de espera habilitados a través de una llamada previa a @ref{3349,,settimeout()} ( o implícitamente mediante @ref{334d,,setdefaulttimeout()}). El valor del acompañamiento es una cadena de caracteres cuyo valor es actualmente siempre “tiempo de espera”.


Distinto en la versión 3.3: Esta clase fue creada como una subclase de @ref{4d5,,OSError}.



Distinto en la versión 3.10: Esta clase se convirtió en un alias de @ref{8cc,,TimeoutError}.

@end deffn

@node Constantes<8>,Funciones<6>,Excepciones<13>,Contenido del módulo
@anchor{library/socket constants}@anchor{334e}
@subsubsection Constantes


@quotation

Las constantes AF_* y SOCK_* ahora son colecciones: @code{AddressFamily} y @code{SocketKind} @ref{d66,,IntEnum}.


Added in version 3.4.

@end quotation

@geindex AF_UNIX (en el módulo socket)
@geindex AF_INET (en el módulo socket)
@geindex AF_INET6 (en el módulo socket)
@anchor{library/socket socket AF_UNIX}@anchor{1826}
@deffn {Dato} socket.AF_UNIX
@anchor{library/socket socket AF_INET}@anchor{1824}
@deffnx {Dato} socket.AF_INET
@anchor{library/socket socket AF_INET6}@anchor{1825}
@deffnx {Dato} socket.AF_INET6

These constants represent the address (and protocol) families, used for the
first argument to @ref{e27,,socket()}.  If the @ref{1826,,AF_UNIX} constant is not
defined then this protocol is unsupported.  More constants may be available
depending on the system.
@end deffn

@geindex AF_UNSPEC (en el módulo socket)
@anchor{library/socket socket AF_UNSPEC}@anchor{3298}
@deffn {Dato} socket.AF_UNSPEC

@ref{3298,,AF_UNSPEC} means that
@ref{175a,,getaddrinfo()} should return socket addresses for any
address family (either IPv4, IPv6, or any other) that can be used.
@end deffn

@geindex SOCK_STREAM (en el módulo socket)
@geindex SOCK_DGRAM (en el módulo socket)
@geindex SOCK_RAW (en el módulo socket)
@geindex SOCK_RDM (en el módulo socket)
@geindex SOCK_SEQPACKET (en el módulo socket)
@anchor{library/socket socket SOCK_STREAM}@anchor{135a}
@deffn {Dato} socket.SOCK_STREAM
@anchor{library/socket socket SOCK_DGRAM}@anchor{1359}
@deffnx {Dato} socket.SOCK_DGRAM
@anchor{library/socket socket SOCK_RAW}@anchor{334f}
@deffnx {Dato} socket.SOCK_RAW
@anchor{library/socket socket SOCK_RDM}@anchor{3350}
@deffnx {Dato} socket.SOCK_RDM
@anchor{library/socket socket SOCK_SEQPACKET}@anchor{3351}
@deffnx {Dato} socket.SOCK_SEQPACKET

These constants represent the socket types, used for the second argument to
@ref{e27,,socket()}.  More constants may be available depending on the system.
(Only @ref{135a,,SOCK_STREAM} and @ref{1359,,SOCK_DGRAM} appear to be generally
useful.)
@end deffn

@geindex SOCK_CLOEXEC (en el módulo socket)
@geindex SOCK_NONBLOCK (en el módulo socket)
@anchor{library/socket socket SOCK_CLOEXEC}@anchor{c93}
@deffn {Dato} socket.SOCK_CLOEXEC
@anchor{library/socket socket SOCK_NONBLOCK}@anchor{c92}
@deffnx {Dato} socket.SOCK_NONBLOCK

Estas dos constantes, si se definen, se pueden combinar con los tipos de socket y le permiten establecer algunas banderas atómicamente (evitando así posibles condiciones de carrera y la necesidad de llamadas separadas).


@subsubheading Ver también


Secure File Descriptor Handling@footnote{http://udrepper.livejournal.com/20407.html} para una explicación más completa.


@ref{1d5a,,Availability}: Linux >= 2.6.27.


Added in version 3.2.

@end deffn

@geindex SOMAXCONN (en el módulo socket)
@anchor{library/socket socket-unix-constants}@anchor{3294}
@deffn {Dato} SO_*
@anchor{library/socket socket SOMAXCONN}@anchor{edf}
@deffnx {Dato} socket.SOMAXCONN

@deffnx {Dato} MSG_*

@deffnx {Dato} SOL_*

@deffnx {Dato} SCM_*

@deffnx {Dato} IPPROTO_*

@deffnx {Dato} IPPORT_*

@deffnx {Dato} INADDR_*

@deffnx {Dato} IP_*

@deffnx {Dato} IPV6_*

@deffnx {Dato} EAI_*

@deffnx {Dato} AI_*

@deffnx {Dato} NI_*

@deffnx {Dato} TCP_*

Many constants of these forms, documented in the Unix documentation on sockets
and/or the IP protocol, are also defined in the socket module. They are
generally used in arguments to the @ref{d5d,,setsockopt()} and @ref{d5c,,getsockopt()}
methods of socket objects.  In most cases, only those symbols that are defined
in the Unix header files are defined; for a few symbols, default values are
provided.


Distinto en la versión 3.6: @code{SO_DOMAIN}, @code{SO_PROTOCOL}, @code{SO_PEERSEC}, @code{SO_PASSSEC}, @code{TCP_USER_TIMEOUT}, @code{TCP_CONGESTION} han sido agregados.



Distinto en la versión 3.6.5: Added support for @code{TCP_FASTOPEN}, @code{TCP_KEEPCNT} on Windows platforms
when available.



Distinto en la versión 3.7: @code{TCP_NOTSENT_LOWAT} ha sido agregada.

Added support for @code{TCP_KEEPIDLE}, @code{TCP_KEEPINTVL} on Windows platforms
when available.



Distinto en la versión 3.10: Se agregó @code{IP_RECVTOS}. Se agregó @code{TCP_KEEPALIVE}. En MacOS, esta constante se puede utilizar de la misma forma que @code{TCP_KEEPIDLE} en Linux.



Distinto en la versión 3.11: Se agregó @code{TCP_CONNECTION_INFO}. En MacOS esta constante se puede utilizar de la misma manera que @code{TCP_INFO} se utiliza en Linux y BSD.



Distinto en la versión 3.12: Se agregaron @code{SO_RTABLE} y @code{SO_USER_COOKIE}. En OpenBSD y FreeBSD respectivamente, esas constantes se pueden usar de la misma manera que @code{SO_MARK} es usado en Linux. También se agregaron opciones de socket TCP faltantes de Linux: @code{TCP_MD5SIG}, @code{TCP_THIN_LINEAR_TIMEOUTS}, @code{TCP_THIN_DUPACK}, @code{TCP_REPAIR}, @code{TCP_REPAIR_QUEUE}, @code{TCP_QUEUE_SEQ}, @code{TCP_REPAIR_OPTIONS}, @code{TCP_TIMESTAMP}, @code{TCP_CC_INFO}, @code{TCP_SAVE_SYN}, @code{TCP_SAVED_SYN}, @code{TCP_REPAIR_WINDOW}, @code{TCP_FASTOPEN_CONNECT}, @code{TCP_ULP}, @code{TCP_MD5SIG_EXT}, @code{TCP_FASTOPEN_KEY}, @code{TCP_FASTOPEN_NO_COOKIE}, @code{TCP_ZEROCOPY_RECEIVE}, @code{TCP_INQ}, @code{TCP_TX_DELAY}. Se agregó @code{IP_PKTINFO}, @code{IP_UNBLOCK_SOURCE}, @code{IP_BLOCK_SOURCE}, @code{IP_ADD_SOURCE_MEMBERSHIP}, @code{IP_DROP_SOURCE_MEMBERSHIP}.



Distinto en la versión 3.13: Added @code{SO_BINDTOIFINDEX}. On Linux this constant can be used in the
same way that @code{SO_BINDTODEVICE} is used, but with the index of a
network interface instead of its name.



Distinto en la versión 3.14: Added missing @code{IP_RECVERR}, @code{IPV6_RECVERR}, @code{IP_RECVTTL}, and
@code{IP_RECVORIGDSTADDR} on Linux.



Distinto en la versión 3.14: Added support for @code{TCP_QUICKACK} on Windows platforms when available.

@end deffn

@geindex AF_CAN (en el módulo socket)
@geindex PF_CAN (en el módulo socket)
@anchor{library/socket socket AF_CAN}@anchor{3344}
@deffn {Dato} socket.AF_CAN
@anchor{library/socket socket PF_CAN}@anchor{3352}
@deffnx {Dato} socket.PF_CAN

@deffnx {Dato} SOL_CAN_*

@deffnx {Dato} CAN_*

Muchas constantes de estos formularios, documentadas en la documentación de Linux, también se definen en el módulo de socket.

@ref{1d5a,,Availability}: Linux >= 2.6.25, NetBSD >= 8.


Added in version 3.3.



Distinto en la versión 3.11: Se ha agregado compatibilidad con NetBSD.

@end deffn

@geindex CAN_BCM (en el módulo socket)
@anchor{library/socket socket CAN_BCM}@anchor{1021}
@deffn {Dato} socket.CAN_BCM

@deffnx {Dato} CAN_BCM_*

CAN_BCM, en la familia de protocolo CAN, es el protocolo del administrador de difusión (BCM. Las constantes del administrador de difusión, documentada en la documentación de Linux, también esta definidos en el modulo socket.

@ref{1d5a,,Availability}: Linux >= 2.6.25.

@cartouche
@quotation Nota 
El indicador @code{CAN_BCM_CAN_FD_FRAME} esta solamente disponible en Linux >= 4.8.
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex CAN_RAW_FD_FRAMES (en el módulo socket)
@anchor{library/socket socket CAN_RAW_FD_FRAMES}@anchor{f4b}
@deffn {Dato} socket.CAN_RAW_FD_FRAMES

Habilita la compatibilidad con CAN FD en un socket CAN_RAW. Esta opción está deshabilitada de forma predeterminada. Esto permite que la aplicación envíe tramas CAN y CAN FD; sin embargo, debe aceptar las tramas CAN y CAN FD al leer desde el socket.

Esta constante se documenta en la documentación de Linux.

@ref{1d5a,,Availability}: Linux >= 3.6.


Added in version 3.5.

@end deffn

@geindex CAN_RAW_JOIN_FILTERS (en el módulo socket)
@anchor{library/socket socket CAN_RAW_JOIN_FILTERS}@anchor{9c4}
@deffn {Dato} socket.CAN_RAW_JOIN_FILTERS

Se une a los filtros CAN aplicados de modo que solo las tramas CAN que coinciden con todos los filtros CAN dados se pasan al espacio del usuario.

Esta constante se documenta en la documentación de Linux.

@ref{1d5a,,Availability}: Linux >= 4.1.


Added in version 3.9.

@end deffn

@geindex CAN_ISOTP (en el módulo socket)
@anchor{library/socket socket CAN_ISOTP}@anchor{3345}
@deffn {Dato} socket.CAN_ISOTP

CAN_ISOTP, en el protocolo de familia CAN, es el protocolo  ISO-TP (ISO 15765-2). Constantes ISO-TP, documentadas en la documentación Linux.

@ref{1d5a,,Availability}: Linux >= 2.6.25.


Added in version 3.7.

@end deffn

@geindex CAN_J1939 (en el módulo socket)
@anchor{library/socket socket CAN_J1939}@anchor{9c5}
@deffn {Dato} socket.CAN_J1939

CAN_J1939, en el protocolo de familias CAN, es el protocolo SAE J1939. Constantes J1939, documentadas en el documentación Linux.

@ref{1d5a,,Availability}: Linux >= 5.4.


Added in version 3.9.

@end deffn

@geindex AF_DIVERT (en el módulo socket)
@geindex PF_DIVERT (en el módulo socket)
@anchor{library/socket socket AF_DIVERT}@anchor{3353}
@deffn {Dato} socket.AF_DIVERT
@anchor{library/socket socket PF_DIVERT}@anchor{3354}
@deffnx {Dato} socket.PF_DIVERT

Estas dos constantes, documentadas en la página del manual de FreeBSD divert(4), también están definidas en el módulo de socket.

@ref{1d5a,,Availability}: FreeBSD >= 14.0.


Added in version 3.12.

@end deffn

@geindex AF_PACKET (en el módulo socket)
@geindex PF_PACKET (en el módulo socket)
@anchor{library/socket socket AF_PACKET}@anchor{3346}
@deffn {Dato} socket.AF_PACKET
@anchor{library/socket socket PF_PACKET}@anchor{3355}
@deffnx {Dato} socket.PF_PACKET

@deffnx {Dato} PACKET_*

Muchas constantes de estos formularios, documentadas en la documentación de Linux, también se definen en el módulo de socket.

@ref{1d5a,,Availability}: Linux >= 2.2.
@end deffn

@geindex ETH_P_ALL (en el módulo socket)
@anchor{library/socket socket ETH_P_ALL}@anchor{17b0}
@deffn {Dato} socket.ETH_P_ALL

El @code{service_id} es el identificador del servicio registrado.:data:@cite{!ETH_P_ALL} se puede utilizar en el constructor @ref{e27,,socket} como `proto' para la familia @ref{3346,,AF_PACKET} para capturar cada paquete, independientemente del protocolo.

Para obtener más información, consulte la página de manual @code{packet(7)@footnote{https://manpages.debian.org/packet(7)}}.

@ref{1d5a,,Availability}: Linux.


Added in version 3.12.

@end deffn

@geindex AF_RDS (en el módulo socket)
@geindex PF_RDS (en el módulo socket)
@geindex SOL_RDS (en el módulo socket)
@anchor{library/socket socket AF_RDS}@anchor{3356}
@deffn {Dato} socket.AF_RDS
@anchor{library/socket socket PF_RDS}@anchor{3357}
@deffnx {Dato} socket.PF_RDS
@anchor{library/socket socket SOL_RDS}@anchor{3358}
@deffnx {Dato} socket.SOL_RDS

@deffnx {Dato} RDS_*

Muchas constantes de estos formularios, documentadas en la documentación de Linux, también se definen en el módulo de socket.

@ref{1d5a,,Availability}: Linux >= 2.6.30.


Added in version 3.3.

@end deffn

@geindex SIO_RCVALL (en el módulo socket)
@geindex SIO_KEEPALIVE_VALS (en el módulo socket)
@geindex SIO_LOOPBACK_FAST_PATH (en el módulo socket)
@anchor{library/socket socket SIO_RCVALL}@anchor{3359}
@deffn {Dato} socket.SIO_RCVALL
@anchor{library/socket socket SIO_KEEPALIVE_VALS}@anchor{335a}
@deffnx {Dato} socket.SIO_KEEPALIVE_VALS
@anchor{library/socket socket SIO_LOOPBACK_FAST_PATH}@anchor{d5b}
@deffnx {Dato} socket.SIO_LOOPBACK_FAST_PATH

@deffnx {Dato} RCVALL_*

Constantes para Windows’ WSAIoctl(). Las constantes se utiliza como argumentos al método @ref{d5a,,ioctl()} de objetos de sockets.


Distinto en la versión 3.6: @code{SIO_LOOPBACK_FAST_PATH} ha sido agregado.

@end deffn


@deffn {Dato} TIPC_*

LAS constantes relacionadas con TIPC, que coinciden con las exportadas por la API de socket de C. Consulte la documentación de TIPC para obtener más información.
@end deffn

@geindex AF_ALG (en el módulo socket)
@geindex SOL_ALG (en el módulo socket)
@anchor{library/socket socket AF_ALG}@anchor{d5e}
@deffn {Dato} socket.AF_ALG
@anchor{library/socket socket SOL_ALG}@anchor{335b}
@deffnx {Dato} socket.SOL_ALG

@deffnx {Dato} ALG_*

Constantes para la criptográfica del Kernel de Linux.

@ref{1d5a,,Availability}: Linux >= 2.6.38.


Added in version 3.6.

@end deffn

@geindex AF_VSOCK (en el módulo socket)
@geindex IOCTL_VM_SOCKETS_GET_LOCAL_CID (en el módulo socket)
@anchor{library/socket socket AF_VSOCK}@anchor{bfd}
@deffn {Dato} socket.AF_VSOCK
@anchor{library/socket socket IOCTL_VM_SOCKETS_GET_LOCAL_CID}@anchor{335c}
@deffnx {Dato} socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID

@deffnx {Dato} VMADDR*

@deffnx {Dato} SO_VM*

Constantes para la comunicación host/invitado de Linux.

@ref{1d5a,,Availability}: Linux >= 4.8.


Added in version 3.7.

@end deffn

@geindex AF_LINK (en el módulo socket)
@anchor{library/socket socket AF_LINK}@anchor{1022}
@deffn {Dato} socket.AF_LINK

@ref{1d5a,,Availability}: BSD, macOS.


Added in version 3.4.

@end deffn

@geindex has_ipv6 (en el módulo socket)
@anchor{library/socket socket has_ipv6}@anchor{335d}
@deffn {Dato} socket.has_ipv6

Esta constante contiene un valor booleano que indica si IPv6 se admite en esta plataforma.
@end deffn

@geindex BDADDR_ANY (en el módulo socket)
@geindex BDADDR_LOCAL (en el módulo socket)
@anchor{library/socket socket BDADDR_ANY}@anchor{335e}
@deffn {Dato} socket.BDADDR_ANY
@anchor{library/socket socket BDADDR_LOCAL}@anchor{335f}
@deffnx {Dato} socket.BDADDR_LOCAL

Estas son constantes de cadenas que contienen direcciones Bluetooth con significados especiales. Por ejemplo @ref{335e,,BDADDR_ANY} son usados para indicar cualquier dirección al especificar el socket vinculante con @code{BTPROTO_RFCOMM}.
@end deffn

@geindex HCI_FILTER (en el módulo socket)
@geindex HCI_TIME_STAMP (en el módulo socket)
@geindex HCI_DATA_DIR (en el módulo socket)
@anchor{library/socket socket HCI_FILTER}@anchor{3360}
@deffn {Dato} socket.HCI_FILTER
@anchor{library/socket socket HCI_TIME_STAMP}@anchor{3361}
@deffnx {Dato} socket.HCI_TIME_STAMP
@anchor{library/socket socket HCI_DATA_DIR}@anchor{3362}
@deffnx {Dato} socket.HCI_DATA_DIR

Para usar con @code{BTPROTO_HCI}. @ref{3360,,HCI_FILTER} no esta disponible para NetBSD o DragonFlyBSD. @ref{3361,,HCI_TIME_STAMP} y @ref{3362,,HCI_DATA_DIR} no esta disponible para FreeBSD, NetBSD, o DragonFlyBSD.
@end deffn

@geindex AF_QIPCRTR (en el módulo socket)
@anchor{library/socket socket AF_QIPCRTR}@anchor{3347}
@deffn {Dato} socket.AF_QIPCRTR

Constante para el protocolo de router IPC de Qualcomm, que se utiliza para comunicarse con procesadores remotos que brindan servicios.

@ref{1d5a,,Availability}: Linux >= 4.7.
@end deffn

@geindex SCM_CREDS2 (en el módulo socket)
@geindex LOCAL_CREDS (en el módulo socket)
@geindex LOCAL_CREDS_PERSISTENT (en el módulo socket)
@anchor{library/socket socket SCM_CREDS2}@anchor{3363}
@deffn {Dato} socket.SCM_CREDS2
@anchor{library/socket socket LOCAL_CREDS}@anchor{3364}
@deffnx {Dato} socket.LOCAL_CREDS
@anchor{library/socket socket LOCAL_CREDS_PERSISTENT}@anchor{3365}
@deffnx {Dato} socket.LOCAL_CREDS_PERSISTENT

LOCAL_CREDS y LOCAL_CREDS_PERSISTENT pueden usarse con sockets SOCK_DGRAM, SOCK_STREAM, equivalente a Linux/DragonFlyBSD SO_PASSCRED, mientras que LOCAL_CREDS envía las credenciales en la primera lectura, LOCAL_CREDS_PERSISTENT envía para cada lectura, SCM_CREDS2 debe entonces ser usado para este último para el tipo de mensaje.


Added in version 3.11.


@ref{1d5a,,Availability}: FreeBSD.
@end deffn

@geindex SO_INCOMING_CPU (en el módulo socket)
@anchor{library/socket socket SO_INCOMING_CPU}@anchor{3366}
@deffn {Dato} socket.SO_INCOMING_CPU

@quotation

Constante para optimizar la localidad CPU, a ser usada en conjunto con @code{SO_REUSEPORT}.
@end quotation


Added in version 3.11.


@ref{1d5a,,Availability}: Linux >= 3.9
@end deffn

@geindex AF_HYPERV (en el módulo socket)
@geindex HV_PROTOCOL_RAW (en el módulo socket)
@geindex HVSOCKET_CONNECT_TIMEOUT (en el módulo socket)
@geindex HVSOCKET_CONNECT_TIMEOUT_MAX (en el módulo socket)
@geindex HVSOCKET_CONNECTED_SUSPEND (en el módulo socket)
@geindex HVSOCKET_ADDRESS_FLAG_PASSTHRU (en el módulo socket)
@geindex HV_GUID_ZERO (en el módulo socket)
@geindex HV_GUID_WILDCARD (en el módulo socket)
@geindex HV_GUID_BROADCAST (en el módulo socket)
@geindex HV_GUID_CHILDREN (en el módulo socket)
@geindex HV_GUID_LOOPBACK (en el módulo socket)
@geindex HV_GUID_PARENT (en el módulo socket)
@anchor{library/socket socket AF_HYPERV}@anchor{3348}
@deffn {Dato} socket.AF_HYPERV
@anchor{library/socket socket HV_PROTOCOL_RAW}@anchor{3367}
@deffnx {Dato} socket.HV_PROTOCOL_RAW
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT}@anchor{3368}
@deffnx {Dato} socket.HVSOCKET_CONNECT_TIMEOUT
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT_MAX}@anchor{3369}
@deffnx {Dato} socket.HVSOCKET_CONNECT_TIMEOUT_MAX
@anchor{library/socket socket HVSOCKET_CONNECTED_SUSPEND}@anchor{336a}
@deffnx {Dato} socket.HVSOCKET_CONNECTED_SUSPEND
@anchor{library/socket socket HVSOCKET_ADDRESS_FLAG_PASSTHRU}@anchor{336b}
@deffnx {Dato} socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU
@anchor{library/socket socket HV_GUID_ZERO}@anchor{336c}
@deffnx {Dato} socket.HV_GUID_ZERO
@anchor{library/socket socket HV_GUID_WILDCARD}@anchor{336d}
@deffnx {Dato} socket.HV_GUID_WILDCARD
@anchor{library/socket socket HV_GUID_BROADCAST}@anchor{336e}
@deffnx {Dato} socket.HV_GUID_BROADCAST
@anchor{library/socket socket HV_GUID_CHILDREN}@anchor{336f}
@deffnx {Dato} socket.HV_GUID_CHILDREN
@anchor{library/socket socket HV_GUID_LOOPBACK}@anchor{3370}
@deffnx {Dato} socket.HV_GUID_LOOPBACK
@anchor{library/socket socket HV_GUID_PARENT}@anchor{3371}
@deffnx {Dato} socket.HV_GUID_PARENT

Constantes para sockets Windows Hyper-V para comunicaciones host/invitado.

@ref{1d5a,,Availability}: Windows.


Added in version 3.12.

@end deffn

@geindex ETHERTYPE_ARP (en el módulo socket)
@geindex ETHERTYPE_IP (en el módulo socket)
@geindex ETHERTYPE_IPV6 (en el módulo socket)
@geindex ETHERTYPE_VLAN (en el módulo socket)
@anchor{library/socket socket-ethernet-types}@anchor{17b1}@anchor{library/socket socket ETHERTYPE_ARP}@anchor{3372}
@deffn {Dato} socket.ETHERTYPE_ARP
@anchor{library/socket socket ETHERTYPE_IP}@anchor{3373}
@deffnx {Dato} socket.ETHERTYPE_IP
@anchor{library/socket socket ETHERTYPE_IPV6}@anchor{3374}
@deffnx {Dato} socket.ETHERTYPE_IPV6
@anchor{library/socket socket ETHERTYPE_VLAN}@anchor{3375}
@deffnx {Dato} socket.ETHERTYPE_VLAN

Número de protocolo IEEE 802.3@footnote{https://www.iana.org/assignments/ieee-802-números/ieee-802-numbers.txt}. constantes.

@ref{1d5a,,Availability}: Linux, FreeBSD, macOS.


Added in version 3.12.

@end deffn

@geindex SHUT_RD (en el módulo socket)
@geindex SHUT_WR (en el módulo socket)
@geindex SHUT_RDWR (en el módulo socket)
@anchor{library/socket socket SHUT_RD}@anchor{3376}
@deffn {Dato} socket.SHUT_RD
@anchor{library/socket socket SHUT_WR}@anchor{3377}
@deffnx {Dato} socket.SHUT_WR
@anchor{library/socket socket SHUT_RDWR}@anchor{3378}
@deffnx {Dato} socket.SHUT_RDWR

These constants are used by the @ref{3379,,shutdown()} method of socket objects.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@node Funciones<6>,,Constantes<8>,Contenido del módulo
@anchor{library/socket functions}@anchor{337a}
@subsubsection Funciones


@menu
* Creación de sockets:: 
* Otras funciones: Otras funciones<2>. 

@end menu

@node Creación de sockets,Otras funciones<2>,,Funciones<6>
@anchor{library/socket creating-sockets}@anchor{337b}
@subsubsection Creación de sockets


Todas las siguientes funciones crean @ref{337c,,socket objects}.

@geindex socket (clase en socket)
@anchor{library/socket socket socket}@anchor{e27}
@deffn {Clase} socket.socket (family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)

Crear un nuevo socket usando la dirección de familia dada, tipo de socket y el numero de protocolo. La dirección de familia debería ser @ref{1824,,AF_INET} (por defecto), @ref{1825,,AF_INET6}, @ref{1826,,AF_UNIX}, @ref{3344,,AF_CAN}, @ref{3346,,AF_PACKET}, o @ref{3356,,AF_RDS}. El tipo de socket debería ser @ref{135a,,SOCK_STREAM} (por defecto), @ref{1359,,SOCK_DGRAM}, @ref{334f,,SOCK_RAW} o quizás una de las otras constantes @code{SOCK_}. El numero de protocolo es usualmente cero u omitirse o en el caso donde la familia de dirección es @ref{3344,,AF_CAN} el protocolo debería ser uno de @code{CAN_RAW}, @ref{1021,,CAN_BCM}, @ref{3345,,CAN_ISOTP} o @ref{9c5,,CAN_J1939}.

If `fileno' is specified, the values for `family', `type', and `proto' are
auto-detected from the specified file descriptor.  Auto-detection can be
overruled by calling the function with explicit `family', `type', or `proto'
arguments.  This only affects how Python represents e.g. the return value
of @ref{32d5,,socket.getpeername()} but not the actual OS resource.  Unlike
@ref{337d,,socket.fromfd()}, `fileno' will return the same socket and not a
duplicate. This may help close a detached socket using
@ref{bfb,,socket.close()}.

El socket recién creado es @ref{f7c,,non-inheritable}.

Genera un @ref{18c3,,auditing event} @code{socket.__new__} con los argumentos @code{self}, @code{family}, @code{type}, @code{protocol}.


Distinto en la versión 3.3: Se añadió la familia AF_CAN. Se añadió la familia AF_RDS.



Distinto en la versión 3.4: El protocolo CAN_BCM ha sido agregado.



Distinto en la versión 3.4: Los sockets devueltos ahora no son heredables.



Distinto en la versión 3.7: El protocolo CAN_ISOTP ha sido agregado.



Distinto en la versión 3.7: Cuando las banderas bit @ref{c92,,SOCK_NONBLOCK} or @ref{c93,,SOCK_CLOEXEC} están aplicadas a `type', se borran, y @ref{c94,,socket.type} no las reflejará. Igual se pasan a la llamada @cite{socket ()} del sistema subyacente. Por lo tanto,

@example
sock = socket.socket(
    socket.AF_INET,
    socket.SOCK_STREAM | socket.SOCK_NONBLOCK)
@end example

seguirá creando un socket sin bloqueo en los sistemas operativos que admiten @code{SOCK_NONBLOCK}, pero @code{sock.type} se establecerá en @code{socket.SOCK_STREAM}.



Distinto en la versión 3.9: El protocolo CAN_J1939 ha sido agregado.



Distinto en la versión 3.10: Se agregó el protocolo IPPROTO_MPTCP.

@end deffn

@geindex socketpair() (en el módulo socket)
@anchor{library/socket socket socketpair}@anchor{c7d}
@deffn {Función} socket.socketpair ([family[, type[, proto]]])

Build a pair of connected socket objects using the given address family, socket
type, and protocol number.  Address family, socket type, and protocol number are
as for the @ref{e27,,socket()} function above. The default family is @ref{1826,,AF_UNIX}
if defined on the platform; otherwise, the default is @ref{1824,,AF_INET}.

Los sockets creados recientemente son @ref{f7c,,non-inheritable}.


Distinto en la versión 3.2: Los objetos de socket devueltos ahora admiten toda la API de socket, en lugar de un subconjunto.



Distinto en la versión 3.4: Los sockets devueltos ahora no son heredables.



Distinto en la versión 3.5: Se ha agregado compatibilidad con Windows.

@end deffn

@geindex create_connection() (en el módulo socket)
@anchor{library/socket socket create_connection}@anchor{713}
@deffn {Función} socket.create_connection (address, timeout=GLOBAL_DEFAULT, source_address=None, *, all_errors=False)

Se conecta a un servicio TCP que esté escuchando en Internet `address' (un @code{(host, port)} de 2 tuplas) y retorna el objeto de socket. Esta es una función de nivel superior que @ref{e29,,socket.connect()}: si `host' es un nombre de host no numérico, intentará resolverlo para @ref{1824,,AF_INET} y @ref{1825,,AF_INET6}, y luego intentará conectarse a todas las direcciones posibles sucesivamente hasta que la conexión se realice correctamente. Esto facilita la escritura de clientes que sean compatibles con IPv4 e IPv6.

Pasando el parámetro opcional `timeout' establece el tiempo de espera dentro de la instancia del socket. Si no es proporcionado `timeout', la configuración global de tiempo de espera predeterminada retornada por @ref{337e,,getdefaulttimeout()} es usada.

Si se suministra, `source_address' debe ser una “”(host, puerto)”” de 2 tuplas para que el socket se enlace como su dirección de origen antes de conectarse.  Si el host o el puerto son “” o 0 respectivamente, se utilizará el comportamiento predeterminado del sistema operativo.

Cuando una conexión no puede ser creada, se lanza una exception. Por defecto, es la excepción de la última dirección en la lista. Si `all_errors' es @code{True}, es un @ref{31d,,ExceptionGroup} conteniendo los errores de todos los intentos.


Distinto en la versión 3.2: `source_address' ha sido agregado.



Distinto en la versión 3.11: `all_errors' ha sido agregado.

@end deffn

@geindex create_server() (en el módulo socket)
@anchor{library/socket socket create_server}@anchor{abd}
@deffn {Función} socket.create_server (address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)

Función conveniente que crea un socket TCP vinculado a `dirección' (un @code{(host, puerto)} de 2 tuplas) y devuelve el objeto del socket.

`familia' debe ser @ref{1824,,AF_INET} o @ref{1825,,AF_INET6}. `backlog' es el tamaño de la cola pasado a @ref{ede,,socket.listen()}; cuando @code{0} se elige un valor predeterminado razonable. `reuse_port' dicta si se debe establecer la opción de socket @code{SO_REUSEPORT}.

Si `dualstack_ipv6' es true y la plataforma lo admite el socket podrá aceptar conexiones IPv4 e IPv6, de lo contrario lanzará @ref{360,,ValueError}. Se supone que la mayoría de las plataformas POSIX y Windows admiten esta funcionalidad. Cuando esta funcionalidad está habilitada, la dirección devuelta por @ref{32d5,,socket.getpeername()} cuando se produce una conexión IPv4 será una dirección IPv6 representada como una dirección IPv4 asignada6. Si `dualstack_ipv6' es false, deshabilitará explícitamente esta funcionalidad en las plataformas que la habilitan de forma predeterminada (por ejemplo, Linux). Este parámetro se puede utilizar junto con @ref{abe,,has_dualstack_ipv6()}:

@example
import socket

addr = ("", 8080)  # all interfaces, port 8080
if socket.has_dualstack_ipv6():
    s = socket.create_server(addr, family=socket.AF_INET6, dualstack_ipv6=True)
else:
    s = socket.create_server(addr)
@end example

@cartouche
@quotation Nota 
En plataformas POSIX la opción del socket @code{SO_REUSEADDR} está configurado para inmediatamente rehusar los sockets previos que estaban vinculados la misma `address' y permanecer en estado TIME_WAIT.
@end quotation
@end cartouche


Added in version 3.8.

@end deffn

@geindex has_dualstack_ipv6() (en el módulo socket)
@anchor{library/socket socket has_dualstack_ipv6}@anchor{abe}
@deffn {Función} socket.has_dualstack_ipv6 ()

Retorna @code{True} si la plataforma admite la creación de un socket TCP que pueda manejar conexiones IPv4 e IPv6.


Added in version 3.8.

@end deffn

@geindex fromfd() (en el módulo socket)
@anchor{library/socket socket fromfd}@anchor{337d}
@deffn {Función} socket.fromfd (fd, family, type, proto=0)

Duplicate the file descriptor `fd' (an integer as returned by a file object’s
@ref{2848,,fileno()} method) and build a socket object from the result.  Address
family, socket type and protocol number are as for the @ref{e27,,socket()} function
above. The file descriptor should refer to a socket, but this is not checked —
subsequent operations on the object may fail if the file descriptor is invalid.
This function is rarely needed, but can be used to get or set socket options on
a socket passed to a program as standard input or output (such as a server
started by the Unix inet daemon).  The socket is assumed to be in blocking mode.

El socket recién creado es @ref{f7c,,non-inheritable}.


Distinto en la versión 3.4: Los sockets devueltos ahora no son heredables.

@end deffn

@geindex fromshare() (en el módulo socket)
@anchor{library/socket socket fromshare}@anchor{c8f}
@deffn {Función} socket.fromshare (data)

Cree una instancia de un socket a partir de los datos obtenidos del método @ref{c90,,socket.share()}.  Se supone que el socket está en modo de bloqueo.

@ref{1d5a,,Availability}: Windows.


Added in version 3.3.

@end deffn

@geindex SocketType (en el módulo socket)
@anchor{library/socket socket SocketType}@anchor{337f}
@deffn {Dato} socket.SocketType

Este es un tipo de objeto Python que representa el tipo de objeto del socket. Es lo mismo que decir @code{type(socket(…))}.
@end deffn

@node Otras funciones<2>,,Creación de sockets,Funciones<6>
@anchor{library/socket other-functions}@anchor{3380}
@subsubsection Otras funciones


El modulo @ref{cc,,socket} también ofrece varios servicios de red relacionados:

@geindex close() (en el módulo socket)
@anchor{library/socket socket close}@anchor{bfb}
@deffn {Función} socket.close (fd)

Cierre un descriptor de archivo de socket. Esto es como @ref{bfc,,os.close()}, pero para sockets. En algunas plataformas (la mayoría notable de Windows) @ref{bfc,,os.close()} no funciona para descriptores de archivos de socket.


Added in version 3.7.

@end deffn

@geindex getaddrinfo() (en el módulo socket)
@anchor{library/socket socket getaddrinfo}@anchor{175a}
@deffn {Función} socket.getaddrinfo (host, port, family=AF_UNSPEC, type=0, proto=0, flags=0)

This function wraps the C function @code{getaddrinfo} of the underlying system.

Traduce el argumento `host'/`port' dentro de una secuencia de 5 tuplas que contiene todo los argumentos necesarios para crear un socket conectado a ese servicio. `host' es un nombre de dominio, una cadena en representación de una dirección IPV4/IPV6 o @code{None}. `port' es una nombre de una cadena de servicio como @code{'http'}, un numero de puerto numérico o @code{None}. Pasando @code{None} como el valor del  `host' y `port', pasando @code{NULL} a la API C subyacente.

The `family', `type' and `proto' arguments can be optionally specified
in order to provide options and limit the list of addresses returned.
Pass their default values (@ref{3298,,AF_UNSPEC}, 0, and 0, respectively)
to not limit the results. See the note below for details.

The `flags' argument can be one or several of the @code{AI_*} constants,
and will influence how results are computed and returned.
For example, @code{AI_NUMERICHOST} will disable domain name resolution
and will raise an error if `host' is a domain name.

La función devuelve una lista de 5 tuplas con la siguiente estructura:

@code{(family, type, proto, canonname, sockaddr)}

In these tuples, `family', `type', `proto' are all integers and are
meant to be passed to the @ref{e27,,socket()} function.  `canonname' will be
a string representing the canonical name of the `host' if
@code{AI_CANONNAME} is part of the `flags' argument; else `canonname'
will be empty.  `sockaddr' is a tuple describing a socket address, whose
format depends on the returned `family' (a @code{(address, port)} 2-tuple for
@ref{1824,,AF_INET}, a @code{(address, port, flowinfo, scope_id)} 4-tuple for
@ref{1825,,AF_INET6}), and is meant to be passed to the @ref{e29,,socket.connect()}
method.

@cartouche
@quotation Nota 
If you intend to use results from @code{getaddrinfo()} to create a socket
(rather than, for example, retrieve `canonname'),
consider limiting the results by `type' (e.g. @ref{135a,,SOCK_STREAM} or
@ref{1359,,SOCK_DGRAM}) and/or `proto' (e.g. @code{IPPROTO_TCP} or
@code{IPPROTO_UDP}) that your application can handle.

The behavior with default values of `family', `type', `proto'
and `flags' is system-specific.

Many systems (for example, most Linux configurations) will return a sorted
list of all matching addresses.
These addresses should generally be tried in order until a connection succeeds
(possibly tried in parallel, for example, using a Happy Eyeballs@footnote{https://en.wikipedia.org/wiki/Happy_Eyeballs} algorithm).
In these cases, limiting the `type' and/or `proto' can help eliminate
unsuccessful or unusable connecton attempts.

Some systems will, however, only return a single address.
(For example, this was reported on Solaris and AIX configurations.)
On these systems, limiting the `type' and/or `proto' helps ensure that
this address is usable.
@end quotation
@end cartouche

Genera un @ref{18c3,,auditing event} @code{socket.getaddrinfo} con los argumentos @code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}.

En el ejemplo siguiente se obtiene información de dirección para una conexión TCP hipotética a @code{example.org} en el puerto 80 (los resultados pueden diferir en el sistema si IPv6 no está habilitado):

@example
>>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP)
[(socket.AF_INET6, socket.SOCK_STREAM,
 6, '@w{'}, ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)),
 (socket.AF_INET, socket.SOCK_STREAM,
 6, '@w{'}, ('93.184.216.34', 80))]
@end example


Distinto en la versión 3.2: los parámetros ahora se pueden pasar mediante argumentos de palabra clave.



Distinto en la versión 3.7: para direcciones de multidifusión IPv6, la cadena que representa una dirección no contendrá partes @code{%scope_id}.

@end deffn

@geindex getfqdn() (en el módulo socket)
@anchor{library/socket socket getfqdn}@anchor{1784}
@deffn {Función} socket.getfqdn ([name])

Retorna un nombre de dominio completo para `name'. Si `name' se omite o está vacío, se interpreta como el host local. Para encontrar el nombre completo, se comprueba el nombre de host retornado por @ref{18d5,,gethostbyaddr()}, seguido de los alias del host, si están disponibles. Se selecciona el primer nombre que incluye un punto. En caso de que no haya disponible un nombre de dominio completo y se haya proporcionado `name', se retorna sin cambios. Si `name' estaba vacío o era igual a @code{'0.0.0.0'}, se retorna el nombre de host de @ref{2b2a,,gethostname()}.
@end deffn

@geindex gethostbyname() (en el módulo socket)
@anchor{library/socket socket gethostbyname}@anchor{3381}
@deffn {Función} socket.gethostbyname (hostname)

Traduce un nombre de host a un formato de dirección IPV4. La dirección IPV4 es retornada como una cadena, como @code{’100.50.200.5’}. Si el nombre de host es una dirección IPV4 en sí, se devuelve sin cambios. Observa @ref{18d6,,gethostbyname_ex()} para una interfaz mas completa. @ref{3381,,gethostbyname()} no soporta la resolución de nombres IPV6, y @ref{175a,,getaddrinfo()} debe utilizarse en su lugar para compatibilidad con doble pila IPv4/v6.

Genera un evento @ref{18c3,,auditing} @code{socket.gethostbyname} con el argumento @code{hostname}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex gethostbyname_ex() (en el módulo socket)
@anchor{library/socket socket gethostbyname_ex}@anchor{18d6}
@deffn {Función} socket.gethostbyname_ex (hostname)

Traducir un nombre de host a IPv4, formato de dirección de interfaz extendida. Devuelve una tupla de 3 elementos @code{(hostname, aliaslist, ipaddrlist)} donde `hostname' es el nombre de host principal del host, `aliaslist' es una lista (posiblemente vacía) de nombres de host alternativos para la misma dirección y `ipaddrlist' es una lista de direcciones IPv4 para la misma interfaz en el mismo host (a menudo, pero no siempre, una única dirección). @ref{18d6,,gethostbyname_ex()} no admite la resolución de nombres IPv6 y @ref{175a,,getaddrinfo()} debe usarse en su lugar para la compatibilidad con doble pila IPv4/v6.

Genera un evento @ref{18c3,,auditing} @code{socket.gethostbyname} con el argumento @code{hostname}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex gethostname() (en el módulo socket)
@anchor{library/socket socket gethostname}@anchor{2b2a}
@deffn {Función} socket.gethostname ()

Retorna una cadena que contenga el nombre de host de la máquina donde se está ejecutando actualmente el intérprete de Python.

Genera un @ref{18c3,,auditing event} @code{socket.gethostname} sin argumentos.

Nota: @ref{2b2a,,gethostname()} no siempre retorna el nombre de dominio completo, usa @ref{1784,,getfqdn()} para eso.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex gethostbyaddr() (en el módulo socket)
@anchor{library/socket socket gethostbyaddr}@anchor{18d5}
@deffn {Función} socket.gethostbyaddr (ip_address)

Devuelve una tupla de 3 elementos @code{(nombre de host, lista de alias, lista de ipaddr)} donde `nombre de host' es el nombre de host principal que responde a la `dirección_ip' dada, `lista de alias' es una lista (posiblemente vacía) de nombres de host alternativos para el mismo dirección, y `ipaddrlist' es una lista de direcciones IPv4/v6 para la misma interfaz en el mismo host (lo más probable es que contenga solo una dirección). Para encontrar el nombre de dominio completo, utilice la función @ref{1784,,getfqdn()}. @ref{18d5,,gethostbyaddr()} admite tanto IPv4 como IPv6.

Generar un @ref{18c3,,auditing event} @code{socket.gethostbyaddr} con los argumentos @code{ip_address}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex getnameinfo() (en el módulo socket)
@anchor{library/socket socket getnameinfo}@anchor{16cd}
@deffn {Función} socket.getnameinfo (sockaddr, flags)

Traduce una dirección de socket  `sockaddr' en una 2-tupla @code{(host, port)}. Dependiendo de la configuraciones de `flags', el resultado puede contener un nombre de dominio completo o una representación numérica de la dirección en `host'. De igual manera, `port' puede contener un nombre de puerto de cadena de caracteres o un numero de puerto numérico.

Para las direcciones IPv6, @code{%scope} se anexa a la parte del host si `sockaddr' contiene `scopeid' significativo. Generalmente esto sucede para las direcciones de multidifusión.

Para mas información sobre `flags' pueden consultar @code{getnameinfo(3)@footnote{https://manpages.debian.org/getnameinfo(3)}}.

Plantea un @ref{18c3,,auditing event} @code{socket.getnameinfo} con el argumento @code{sockaddr}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex getprotobyname() (en el módulo socket)
@anchor{library/socket socket getprotobyname}@anchor{3382}
@deffn {Función} socket.getprotobyname (protocolname)

Translate an internet protocol name (for example, @code{'icmp'}) to a constant
suitable for passing as the (optional) third argument to the @ref{e27,,socket()}
function.  This is usually only needed for sockets opened in «raw» mode
(@ref{334f,,SOCK_RAW}); for the normal socket modes, the correct protocol is chosen
automatically if the protocol is omitted or zero.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex getservbyname() (en el módulo socket)
@anchor{library/socket socket getservbyname}@anchor{3383}
@deffn {Función} socket.getservbyname (servicename[, protocolname])

Traduzca un nombre de servicio de Internet y un nombre de protocolo a un número de puerto para ese servicio. El nombre de protocolo opcional, si se proporciona, debe ser @code{'tcp'} o @code{'udp'}; de lo contrario, cualquier protocolo coincidirá.

Genera un @ref{18c3,,auditing event} @code{socket.getservbyname} con los argumentos @code{servicename}, @code{protocolname}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex getservbyport() (en el módulo socket)
@anchor{library/socket socket getservbyport}@anchor{3384}
@deffn {Función} socket.getservbyport (port[, protocolname])

Traduzca un número de puerto de Internet y un nombre de protocolo a un nombre de servicio para ese servicio. El nombre de protocolo opcional, si se proporciona, debe ser @code{'tcp'} o @code{'udp'}; de lo contrario, cualquier protocolo coincidirá.

Genera un @ref{18c3,,auditing event} @code{socket.getservbyport} con los argumentos @code{port}, @code{protocolname}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex ntohl() (en el módulo socket)
@anchor{library/socket socket ntohl}@anchor{3385}
@deffn {Función} socket.ntohl (x)

Convierta enteros positivos de 32 bits de red a orden de bytes de host.  En equipos donde el orden de bytes de host es el mismo que el orden de bytes de red, se trata de un no-op; de lo contrario, realiza una operación de intercambio de 4 bytes.
@end deffn

@geindex ntohs() (en el módulo socket)
@anchor{library/socket socket ntohs}@anchor{918}
@deffn {Función} socket.ntohs (x)

Convierta enteros positivos de 16 bits de red a orden de bytes de host.  En equipos donde el orden de bytes de host es el mismo que el orden de bytes de red, se trata de un no-op; de lo contrario, realiza una operación de intercambio de 2 bytes.


Distinto en la versión 3.10: Lanza @ref{919,,OverflowError} si `x' no cabe en un entero sin signo de 16 bits.

@end deffn

@geindex htonl() (en el módulo socket)
@anchor{library/socket socket htonl}@anchor{3386}
@deffn {Función} socket.htonl (x)

Convierta enteros positivos de 32 bits del host al orden de bytes de red.  En equipos donde el orden de bytes de host es el mismo que el orden de bytes de red, se trata de un no-op; de lo contrario, realiza una operación de intercambio de 4 bytes.
@end deffn

@geindex htons() (en el módulo socket)
@anchor{library/socket socket htons}@anchor{917}
@deffn {Función} socket.htons (x)

Convierta enteros positivos de 16 bits del host al orden de bytes de red.  En equipos donde el orden de bytes de host es el mismo que el orden de bytes de red, se trata de un no-op; de lo contrario, realiza una operación de intercambio de 2 bytes.


Distinto en la versión 3.10: Lanza @ref{919,,OverflowError} si `x' no cabe en un entero sin signo de 16 bits.

@end deffn

@geindex inet_aton() (en el módulo socket)
@anchor{library/socket socket inet_aton}@anchor{9f4}
@deffn {Función} socket.inet_aton (ip_string)

Convierte una dirección IPv4 desde el formato de cadena de cuatro puntos (por ejemplo, ‘123.45.67.89’) a formato binario empaquetado de 32 bits, como un objeto de bytes de cuatro caracteres de longitud. Esto es útil cuando se convierte con un programa que usa la librería estándar C y necesita objetos de tipo @code{in_addr}, que es el tipo C para el binario empaquetado de 32 bits que devuelve esta función.

Ademas @code{inet_aton`acepta cadena de caracteres con menos de tres puntos, observar la pagina del manual Unix :manpage:`inet(3)()} para mas detalles.

Si la cadena de dirección IPv4 es pasada a esta función es invalido, @ref{4d5,,OSError} se lanzará. Tenga en cuenta que exactamente lo que es valido depende de la implementación C de @code{inet_aton()}.

@ref{9f4,,inet_aton()} no admite IPV6, y @ref{9f5,,inet_pton()} deberían utilizarse en su lugar para compatibilidad con doble pilas IPV4/v6.
@end deffn

@geindex inet_ntoa() (en el módulo socket)
@anchor{library/socket socket inet_ntoa}@anchor{3387}
@deffn {Función} socket.inet_ntoa (packed_ip)

Convierte una dirección IPv4 empaquetada de 32 bits (un @ref{db4,,bytes-like object} cuatro bytes de longitud) a su representación estándar de cadena de cuatro puntos (por ejemplo ‘123.45.67.89’). Esto es útil cuando convertimos con un programa que usa la librería estándar C y necesita objetos de tipo @code{in_addr}, que es el tipo C para los datos binarios empaquetados de 32 bits que esta función toma como argumento.

Si la secuencia de byte pasada a esta función no es exactamente 4 bytes de longitud  @ref{4d5,,OSError} podría generarse @ref{3387,,inet_ntoa()} no soporta IPV6, y @ref{1023,,inet_ntop()} debe utilizarse en su lugar para compatibilidad con doble pila IPv4 / v6.


Distinto en la versión 3.5: Ahora se acepta la grabación @ref{db4,,bytes-like object}.

@end deffn

@geindex inet_pton() (en el módulo socket)
@anchor{library/socket socket inet_pton}@anchor{9f5}
@deffn {Función} socket.inet_pton (address_family, ip_string)

Convierte una dirección IP desde su formato de cadena específico de la familia a un formato binario empaquetado. @ref{9f5,,inet_pton()} es útil cuando una librería o protocolo de red llama desde un objeto de tipo @code{in_addr} (similar a @ref{9f4,,inet_aton()}) o @code{in6_addr}.

Los Valores soportados para `address_family' son actualmente @ref{1824,,AF_INET} y @ref{1825,,AF_INET6}. Si la cadena de dirección IP `ip_string' no es válida, @ref{4d5,,OSError} se genera. Tenga en cuenta que exactamente lo que es válido depende tanto del valor de `address_family' como de la implementación subyacente de @code{inet_pton()}.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.4: Se ha añadido compatibilidad con Windows

@end deffn

@geindex inet_ntop() (en el módulo socket)
@anchor{library/socket socket inet_ntop}@anchor{1023}
@deffn {Función} socket.inet_ntop (address_family, packed_ip)

Convierte una dirección IP empaquetada (un @ref{db4,,bytes-like object} de algún numero de bytes) a su representación estándar de cadena específica de la familia (por ejemplo @code{’7.10.0.5’} o @code{’5aef:2b::8’}). @ref{1023,,inet_ntop()} es útil cuando una librería o protocolo de red retorna un objeto de tipo @code{in_addr} (similar para @ref{3387,,inet_ntoa()}) o @code{in6_addr}.

Los valores soportados para `address_family' actualmente son @ref{1824,,AF_INET} y @ref{1825,,AF_INET6}. Si los objetos de bytes `packed_ip' no tienen la longitud correcta para la familia de direcciones especificas, @ref{360,,ValueError} podría generarse. @ref{4d5,,OSError} se genera para errores desde la llamada a @ref{1023,,inet_ntop()}.

@ref{1d5a,,Availability}: Unix, Windows.


Distinto en la versión 3.4: Se ha añadido compatibilidad con Windows



Distinto en la versión 3.5: Ahora se acepta la grabación @ref{db4,,bytes-like object}.

@end deffn

@c XXX: Are sendmsg(), recvmsg() and CMSG_*() available on any
@c non-Unix platforms?  The old (obsolete?) 4.2BSD form of the
@c interface, in which struct msghdr has no msg_control or
@c msg_controllen members, is not currently supported.

@geindex CMSG_LEN() (en el módulo socket)
@anchor{library/socket socket CMSG_LEN}@anchor{1a3e}
@deffn {Función} socket.CMSG_LEN (length)

Retorna la longitud total, sin relleno de arrastre, de un elemento de datos auxiliares con datos asociados del `length'. Este valor se puede utilizar a menudo como tamaño de búfer para @ref{e2c,,recvmsg()} para recibir un solo valor de datos auxiliares, pero 
@geindex RFC; RFC 3542
RFC 3542@footnote{https://datatracker.ietf.org/doc/html/rfc3542.html} requiere aplicaciones portables para usar @ref{1a3d,,CMSG_SPACE()} y así incluir espacio para el relleno, incluso cuando el elemento será el último en el búfer. Genera  @ref{919,,OverflowError} si `length' está fuera del rango de valores permitido.

@ref{1d5a,,Availability}: Unix, not WASI.

La mayoría de las plataformas Unix.


Added in version 3.3.

@end deffn

@geindex CMSG_SPACE() (en el módulo socket)
@anchor{library/socket socket CMSG_SPACE}@anchor{1a3d}
@deffn {Función} socket.CMSG_SPACE (length)

Retorna el tamaño del buffer necesario por @ref{e2c,,recvmsg()} para recibir un elemento de datos auxiliares con datos asociados del `length' dado, junto con cualquier relleno final. El espacio de buffer necesario para recibir múltiples elementos es la suma de los valores de @ref{1a3d,,CMSG_SPACE()} para los datos asociados con la longitudes. Genera @ref{919,,OverflowError} si `length' está fuera del rango de valores permitido.

Tenga en cuenta que algunos sistemas pueden admitir datos auxiliares sin proporcionar esta función.  Tenga en cuenta también que establecer el tamaño del búfer utilizando los resultados de esta función puede no limitar con precisión la cantidad de datos auxiliares que se pueden recibir, ya que los datos adicionales pueden caber en el área de relleno.

@ref{1d5a,,Availability}: Unix, not WASI.

la mayoría de las plataformas Unix.


Added in version 3.3.

@end deffn

@geindex getdefaulttimeout() (en el módulo socket)
@anchor{library/socket socket getdefaulttimeout}@anchor{337e}
@deffn {Función} socket.getdefaulttimeout ()

Retorna el tiempo de espera por defecto en segundos (flotante) para los objetos de un nuevo socket. Un valor de @code{None} indicada que los objetos del nuevo socket no tiene un tiempo de espera. Cuando el modulo socket es importado primero, por defecto es @code{None}.
@end deffn

@geindex setdefaulttimeout() (en el módulo socket)
@anchor{library/socket socket setdefaulttimeout}@anchor{334d}
@deffn {Función} socket.setdefaulttimeout (timeout)

Selecciona el tiempo de espera por defecto en segundos (flotante ) para los objetos nuevos del socket. Cuando el modulo socket es importado primero, el valor por defecto es @code{None}. Observar @ref{3349,,settimeout()} para posible valores y sus respectivos significados.
@end deffn

@geindex sethostname() (en el módulo socket)
@anchor{library/socket socket sethostname}@anchor{11ad}
@deffn {Función} socket.sethostname (name)

Establece el nombre de host de la maquina en `name'. Esto genera un  @ref{4d5,,OSError} si no tiene suficientes derechos.

Plantea un @ref{18c3,,auditing event} @code{socket.sethostname} con el argumento @code{name}.

@ref{1d5a,,Availability}: Unix, not Android.


Added in version 3.3.

@end deffn

@geindex if_nameindex() (en el módulo socket)
@anchor{library/socket socket if_nameindex}@anchor{abf}
@deffn {Función} socket.if_nameindex ()

Retorna una lista de tuplas de información de interfaz de red (índice int, cadena de nombre). @ref{4d5,,OSError} si se produce un error en la llamada del sistema.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.


Added in version 3.3.



Distinto en la versión 3.8: Se ha agregado compatibilidad con Windows.


@cartouche
@quotation Nota 
En Windows las interfaces de redes tienen diferentes nombres en diferentes contextos (todos los nombres son ejemplos):


@itemize *

@item 
UUID: @code{@{FB605B73-AAC2-49A6-9A2F-25416AEA0573@}}

@item 
nombre: @code{ethernet_32770}

@item 
nombre amigable: @code{vEthernet (nat)}

@item 
descripción: @code{Hyper-V Virtual Ethernet Adapter}
@end itemize

Esta función retorna los nombres del segundo formulario de la lista, en este caso de ejemplo @code{ethernet_32770}.
@end quotation
@end cartouche
@end deffn

@geindex if_nametoindex() (en el módulo socket)
@anchor{library/socket socket if_nametoindex}@anchor{ac0}
@deffn {Función} socket.if_nametoindex (if_name)

Retorna un número de índice de interfaz de red correspondiente a un nombre de interfaz. @ref{4d5,,OSError} si no existe ninguna interfaz con el nombre especificado.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.


Added in version 3.3.



Distinto en la versión 3.8: Se ha agregado compatibilidad con Windows.



@subsubheading Ver también


“”Interface name” es un nombre como se documenta en @ref{abf,,if_nameindex()}.

@end deffn

@geindex if_indextoname() (en el módulo socket)
@anchor{library/socket socket if_indextoname}@anchor{ac1}
@deffn {Función} socket.if_indextoname (if_index)

Retorna un nombre de interfaz de red correspondiente a un número de índice de interfaz. @ref{4d5,,OSError} si no existe ninguna interfaz con el índice dado.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.


Added in version 3.3.



Distinto en la versión 3.8: Se ha agregado compatibilidad con Windows.



@subsubheading Ver también


“”Interface name” es un nombre como se documenta en @ref{abf,,if_nameindex()}.

@end deffn

@geindex send_fds() (en el módulo socket)
@anchor{library/socket socket send_fds}@anchor{9c6}
@deffn {Función} socket.send_fds (sock, buffers, fds[, flags[, address]])

Send the list of file descriptors `fds' over an @ref{1826,,AF_UNIX} socket `sock'.
The `fds' parameter is a sequence of file descriptors.
Consult @ref{521,,sendmsg()} for the documentation of these parameters.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.

Plataformas Unix que soporten @ref{521,,sendmsg()} y el mecanismo @code{SCM_RIGHTS}.


Added in version 3.9.

@end deffn

@geindex recv_fds() (en el módulo socket)
@anchor{library/socket socket recv_fds}@anchor{9c7}
@deffn {Función} socket.recv_fds (sock, bufsize, maxfds[, flags])

Receive up to `maxfds' file descriptors from an @ref{1826,,AF_UNIX} socket `sock'.
Return @code{(msg, list(fds), flags, addr)}.
Consult @ref{e2c,,recvmsg()} for the documentation of these parameters.

@ref{1d5a,,Availability}: Unix, Windows, not WASI.

Plataformas Unix que soporten @ref{521,,sendmsg()} y el mecanismo @code{SCM_RIGHTS}.


Added in version 3.9.


@cartouche
@quotation Nota 
Cualquier número entero truncado al final de la lista de descriptores de archivo.
@end quotation
@end cartouche
@end deffn

@node Objetos Socket,Notas sobre los tiempos de espera del socket,Contenido del módulo,socket — Low-level networking interface
@anchor{library/socket id1}@anchor{3388}@anchor{library/socket socket-objects}@anchor{337c}
@subsubsection Objetos Socket


Los objetos socket tienen los siguientes métodos. Excepto para @ref{120e,,makefile()}, esto corresponde al sistema de llamadas Unix para sockets.


Distinto en la versión 3.2: El soporte para el protocolo @ref{675,,context manager} ha sido agregado. Salir del gestor de contexto es equivalente para el llamado @ref{bfb,,close()}.


@geindex accept() (método de socket.socket)
@anchor{library/socket socket socket accept}@anchor{e28}
@deffn {Método} socket.accept ()

Acepta una conexión. El socket debe estar vinculado a una dirección y estar escuchando las conexiones. El valor de retorno es el par @code{(conn, address)} cuando `conn' es un `new' objeto socket usado para enviar y recibir información en la conexión, y `address' es la dirección vinculada al socket en el extremo de la conexión.

El socket recién creado es @ref{f7c,,non-inheritable}.


Distinto en la versión 3.4: El socket ahora no es heredable.



Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex bind() (método de socket.socket)
@anchor{library/socket socket socket bind}@anchor{157a}
@deffn {Método} socket.bind (address)

Enlaza el socket a `address'. El socket no debe estar ya unido. (El formato de `address' depende de la familia de direcciones, consulte más arriba).

Genera un @ref{18c3,,auditing event} @code{socket.getaddrinfo} con los argumentos @code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex close() (método de socket.socket)
@anchor{library/socket socket socket close}@anchor{dca}
@deffn {Método} socket.close ()

Mark the socket closed.  The underlying system resource (e.g. a file
descriptor) is also closed when all file objects from @ref{120e,,makefile()}
are closed.  Once that happens, all future operations on the socket
object will fail. The remote end will receive no more data (after
queued data is flushed).

Los sockets se cierran automáticamente cuando se recogen basura, pero se recomienda @code{cerrarlos()} explícitamente, o usar una instrucción @ref{673,,with} alrededor de ellos.


Distinto en la versión 3.6: @ref{4d5,,OSError} ahora se lanza si se produce un error cuando se realiza la llamada @code{close()} subyacente.


@cartouche
@quotation Nota 
@ref{bfb,,close()} releases the resource associated with a connection but
does not necessarily close the connection immediately.  If you want
to close the connection in a timely fashion, call @ref{3379,,shutdown()}
before @ref{bfb,,close()}.
@end quotation
@end cartouche
@end deffn

@geindex connect() (método de socket.socket)
@anchor{library/socket socket socket connect}@anchor{e29}
@deffn {Método} socket.connect (address)

Conectar a un socket remoto en `address'. (El formato de `address' depende de la familia de direcciones — ver arriba.)

Si la conexión es interrumpida por una señal, el método espera hasta que se complete la conexión, o lanza un @ref{8cc,,TimeoutError} en el tiempo de espera, si el manejador de señales no lanza una excepción y el socket se bloquea o tiene un tiempo de espera. Para sockets sin bloqueo, el método lanza una excepción @ref{e0e,,InterruptedError} si la conexión es interrumpida por una señal (o la excepción lanzada por el manejador de señales).

Genera un @ref{18c3,,auditing event} @code{socket.connect} con los argumentos @code{self}, @code{address}.


Distinto en la versión 3.5: El método ahora espera hasta que se completa la conexión en lugar de generar una excepción @ref{e0e,,InterruptedError} si la conexión se interrumpe por una señal, el controlador de señal no genera una excepción y el socket está bloqueando o tiene un tiempo de espera (consulte el 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la razón de ser).


@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex connect_ex() (método de socket.socket)
@anchor{library/socket socket socket connect_ex}@anchor{1579}
@deffn {Método} socket.connect_ex (address)

Similar a @code{connect(address)}, pero retorna un indicador de error en lugar de generar una excepción para los errores retornados por la llamada de nivel C @code{connect()} (otros problemas, como “host no encontrado”, aún pueden generar excepciones). El indicador de error es @code{0} si la operación tuvo éxito, caso contrario es el valor de la variable @code{errno}. Esto es útil para admitir, por ejemplo, conexiones asincrónicas.

Genera un @ref{18c3,,auditing event} @code{socket.connect} con los argumentos @code{self}, @code{address}.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex detach() (método de socket.socket)
@anchor{library/socket socket socket detach}@anchor{1289}
@deffn {Método} socket.detach ()

Coloque el objeto de socket en estado cerrado sin cerrar realmente el descriptor de archivo subyacente.  Se devuelve el descriptor de archivo y se puede reutilizar para otros fines.


Added in version 3.2.

@end deffn

@geindex dup() (método de socket.socket)
@anchor{library/socket socket socket dup}@anchor{3389}
@deffn {Método} socket.dup ()

Duplica el socket.

El socket recién creado es @ref{f7c,,non-inheritable}.


Distinto en la versión 3.4: El socket ahora no es heredable.


@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex fileno() (método de socket.socket)
@anchor{library/socket socket socket fileno}@anchor{338a}
@deffn {Método} socket.fileno ()

Retorna un archivo descriptor del socket (un entero pequeño), o -1 si falla. Esto es útil con @ref{e26,,select.select()}.

En Windows el pequeño entero retornado por este método no puede ser usado donde un descriptor de un archivo pueda ser usado (como una @ref{1f33,,os.fdopen()}). Unix no tiene esta limitación.
@end deffn

@geindex get_inheritable() (método de socket.socket)
@anchor{library/socket socket socket get_inheritable}@anchor{f81}
@deffn {Método} socket.get_inheritable ()

Obtiene el @ref{f7c,,inheritable flag} del descriptor del archivo del socket o el controlador del socket: @code{True} si el socket puede ser heredada en procesos secundarios, @code{False} si falla.


Added in version 3.4.

@end deffn

@geindex getpeername() (método de socket.socket)
@anchor{library/socket socket socket getpeername}@anchor{32d5}
@deffn {Método} socket.getpeername ()

Retorna la dirección remota a la que esta conectado el socket. Esto es útil para averiguar el número de puerto de un socket IPv4/v6 remoto, por ejemplo. (El formato de la dirección devuelta depende de la familia de direcciones, consulte más arriba). En algunos sistemas, esta función no es compatible.
@end deffn

@geindex getsockname() (método de socket.socket)
@anchor{library/socket socket socket getsockname}@anchor{32d6}
@deffn {Método} socket.getsockname ()

Retorna la dirección del propio socket. Esto es útil para descubrir el numero de puerto de un socket IPv4/IPv6, por ejemplo. (El formato de la dirección devuelta depende de la familia de direcciones, consulte más arriba).
@end deffn

@geindex getsockopt() (método de socket.socket)
@anchor{library/socket socket socket getsockopt}@anchor{d5c}
@deffn {Método} socket.getsockopt (level, optname[, buflen])

Return the value of the given socket option (see the Unix man page
@code{getsockopt(2)@footnote{https://manpages.debian.org/getsockopt(2)}}).  The needed symbolic constants (@ref{3294,,SO_* etc.})
are defined in this module.  If `buflen' is absent, an integer option is assumed
and its integer value is returned by the function.  If `buflen' is present, it
specifies the maximum length of the buffer used to receive the option in, and
this buffer is returned as a bytes object.  It is up to the caller to decode the
contents of the buffer (see the optional built-in module @ref{d5,,struct} for a way
to decode C structures encoded as byte strings).

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex getblocking() (método de socket.socket)
@anchor{library/socket socket socket getblocking}@anchor{bfa}
@deffn {Método} socket.getblocking ()

Retorna @code{True} si el socket está en modo de bloqueo, @code{False} si está en sin bloqueo.

Esto es equivalente a comprobar @code{socket.gettimeout() != 0}.


Added in version 3.7.

@end deffn

@geindex gettimeout() (método de socket.socket)
@anchor{library/socket socket socket gettimeout}@anchor{338b}
@deffn {Método} socket.gettimeout ()

Retorna el tiempo de espera en segundos (flotante) asociado con las operaciones del socket, o @code{None} si el tiempo de espera no es seleccionado. Esto refleja la ultima llamada al @ref{2b41,,setblocking()} o @ref{3349,,settimeout()}.
@end deffn

@geindex ioctl() (método de socket.socket)
@anchor{library/socket socket socket ioctl}@anchor{d5a}
@deffn {Método} socket.ioctl (control, option)

@*plataforma: 
Windows


El método @ref{d5a,,ioctl()} es una interfaz limitada para el sistema de interfaces WSAIoctl. Por favor refiérase a Win32 documentation@footnote{https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx} para mas información.

En otras plataformas, las funciones genéricas @ref{338c,,fcntl.fcntl()} y @ref{14b6,,fcntl.ioctl()} podrían ser usadas; ellas aceptan un objeto socket como su primer argumento.

Actualmente solo el siguiente control de códigos está soportados: @code{SIO_RCVALL}, @code{SIO_KEEPALIVE_VALS}, y @code{SIO_LOOPBACK_FAST_PATH}.


Distinto en la versión 3.6: @code{SIO_LOOPBACK_FAST_PATH} ha sido agregado.

@end deffn

@geindex listen() (método de socket.socket)
@anchor{library/socket socket socket listen}@anchor{ede}
@deffn {Método} socket.listen ([backlog])

Habilita un servidor para aceptar conexiones. Si `backlog' es especifico, debe ser al menos 0 (si es menor, se establece en 0); especifica el número de conexiones no aceptadas que permitirá el sistema antes de rechazar nuevas conexiones. Si no se especifica, se elige un valor razonable predeterminado.

@ref{1d5a,,Availability}: not WASI.


Distinto en la versión 3.5: El parámetro `backlog' ahora es opcional.

@end deffn

@geindex makefile() (método de socket.socket)
@anchor{library/socket socket socket makefile}@anchor{120e}
@deffn {Método} socket.makefile (mode='r', buffering=None, *, encoding=None, errors=None, newline=None)

@geindex I/O control de salida y entrada;almacenamiento en búfer

Return a @ref{1230,,file object} associated with the socket.  The exact returned
type depends on the arguments given to @ref{120e,,makefile()}.  These arguments are
interpreted the same way as by the built-in @ref{1be,,open()} function, except
the only supported `mode' values are @code{'r'} (default), @code{'w'}, @code{'b'}, or
a combination of those.

El socket debe estar en modo de bloqueo; puede tener un tiempo de espera, pero el búfer interno del objeto de archivo puede terminar en un estado incoherente si se produce un tiempo de espera.

Cerrar el objeto de archivo devuelto por @ref{120e,,makefile()} no cerrará el socket original a menos que se hayan cerrado todos los demás objetos de archivo y @ref{bfb,,socket.close()} se haya llamado al objeto socket.

@cartouche
@quotation Nota 
En Windows, el objeto similar a un archivo creado por @ref{120e,,makefile()} no se puede utilizar cuando se espera un objeto de archivo con un descriptor de archivo, como los argumentos de secuencia de @ref{301,,subprocess.Popen()}.
@end quotation
@end cartouche
@end deffn

@geindex recv() (método de socket.socket)
@anchor{library/socket socket socket recv}@anchor{e2a}
@deffn {Método} socket.recv (bufsize[, flags])

Receive data from the socket.  The return value is a bytes object representing the
data received.  The maximum amount of data to be received at once is specified
by `bufsize'. A returned empty bytes object indicates that the client has disconnected.
See the Unix manual page @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} for the meaning of the optional argument
`flags'; it defaults to zero.

@cartouche
@quotation Nota 
Para una mejor coincidencia con las realidades de hardware y red, el valor de `bufsize' debe ser una potencia relativamente pequeña de 2, por ejemplo, 4096.
@end quotation
@end cartouche


Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex recvfrom() (método de socket.socket)
@anchor{library/socket socket socket recvfrom}@anchor{e2b}
@deffn {Método} socket.recvfrom (bufsize[, flags])

Recibe datos desde el socket. El valor de retorno es un par @code{(bytes, address)} donde `bytes' es un objeto de bytes que representa los datos recibidos y `address' es la dirección de el socket enviando los datos. Observar la pagina del manual Unix @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} para el significado del argumento opcional `flags'; por defecto es cero. (El formato de `address' depende de la familia de direcciones, consulte más arriba).


Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).



Distinto en la versión 3.7: Para direcciones IPv6 de multidifusión, el primer elemento de `address' ya no contiene la parte @code{%scope_id}. Para obtener la dirección IPV6 completa, use @ref{16cd,,getnameinfo()}.

@end deffn

@geindex recvmsg() (método de socket.socket)
@anchor{library/socket socket socket recvmsg}@anchor{e2c}
@deffn {Método} socket.recvmsg (bufsize[, ancbufsize[, flags]])

Reciba datos normales (hasta `bufsize' bytes) y datos auxiliares del socket.  El argumento `ancbufsize' establece el tamaño en bytes del búfer interno utilizado para recibir los datos auxiliares; el valor predeterminado es 0, lo que significa que no se recibirán datos auxiliares.  Los tamaños de búfer adecuados para los datos auxiliares se pueden calcular mediante @ref{1a3d,,CMSG_SPACE()} o @ref{1a3e,,CMSG_LEN()}, y los elementos que no caben en el búfer pueden truncarse o descartarse.  El valor predeterminado del argumento `flags' es 0 y tiene el mismo significado que para @ref{e2a,,recv()}.

El valor de retorno es una tupla de 4: @code{(data, ancdata, msg_flags, address)}. El valor `data' es un objeto @ref{325,,bytes} que contiene los datos no auxiliares recibidos. El valor `ancdata' es una lista de cero o mas tuplas @code{(cmsg_level, cmsg_type, cmsg_data)} representado los datos auxiliares (control de mensajes) recibidos: `cmsg_level' y `cmsg_type' son enteros especificando el nivel de protocolo y tipo específico de protocolo respectivamente, y `cmsg_data' es un objeto @ref{325,,bytes} sosteniendo los datos asociados. El valor `msg_flags' es el OR bit a bit de varios indicadores que indican condiciones en el mensaje recibido; consulte la documentación de su sistema para obtener más detalles. Si la toma de recepción no está conectada, `address' es la dirección de el socket enviado, si está disponible; de lo contrario, su valor no se especifica.

En algunos sistemas, @ref{521,,sendmsg()} y @ref{e2c,,recvmsg()} pueden utilizarse para pasar descriptores de fichero entre procesos a través de un socket @ref{1826,,AF_UNIX}.  Cuando se utiliza esta funcionalidad (a menudo está restringida a los sockets @ref{135a,,SOCK_STREAM}), @ref{e2c,,recvmsg()} devolverá, en sus datos auxiliares, elementos del formulario @code{(socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)}, donde `fds' es un objeto @ref{325,,bytes} que representa los nuevos descriptores de archivo como una arreglo binario del tipo nativo C int.  Si @ref{e2c,,recvmsg()} lanza una excepción después del retorno de la llamada al sistema, primero intentará cerrar cualquier descriptor de fichero recibido a través de este mecanismo.

Algunos sistemas no indican la longitud truncada de los elementos de datos auxiliares que solo se han recibido parcialmente.  Si un elemento parece extenderse más allá del final del búfer, @ref{e2c,,recvmsg()} emitirá un @ref{323,,RuntimeWarning}, y devolverá la parte de él que está dentro del búfer siempre que no se haya truncado antes del inicio de sus datos asociados.

En sistemas donde soporta el mecanismo @code{SCM_RIGHTS}, la siguiente función recibirá un descriptor de archivos `maxfds', devolviendo el mensaje de datos y un lista que contiene los descriptores (mientras se ignoran las condiciones inesperadas, como la recepción de mensajes de control no relacionados). Ver también @ref{521,,sendmsg()}.

@example
import socket, array

def recv_fds(sock, msglen, maxfds):
    fds = array.array("i")   # Array of ints
    msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))
    for cmsg_level, cmsg_type, cmsg_data in ancdata:
        if cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS:
            # Append data, ignoring any truncated integers at the end.
            fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
    return msg, list(fds)
@end example

@ref{1d5a,,Availability}: Unix.

La mayoría de las plataformas Unix.


Added in version 3.3.



Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex recvmsg_into() (método de socket.socket)
@anchor{library/socket socket socket recvmsg_into}@anchor{11ac}
@deffn {Método} socket.recvmsg_into (buffers[, ancbufsize[, flags]])

Recibir datos normales y datos auxiliares desde el socket, comportándose como @ref{e2c,,recvmsg()} lo haría, pero dispersar los datos no auxiliares en una serie de buffers en lugar de devolver un nuevo objeto bytes.  El argumento `buffers' debe ser un iterable de objetos que exportan buffers de escritura (por ejemplo, objetos @ref{5e0,,bytearray}); estos se llenarán con fragmentos sucesivos de los datos no auxiliares hasta que se hayan escrito todos o no haya más buffers.  El sistema operativo puede establecer un límite (@ref{2b68,,sysconf()} valor @code{SC_IOV_MAX}) en el número de buffers que se pueden utilizar.  Los argumentos `ancbufsize' y `flags' tienen el mismo significado que para @ref{e2c,,recvmsg()}.

El valor de retorno es tupla de 4: @code{(nbytes, ancdata, msg_flags, address)}, donde `nbytes' es el numero total de bytes de datos no auxiliares escrito dentro de los bufetes, y `ancdata', `msg_flags' y `address' son lo mismo que para @ref{e2c,,recvmsg()}.

Ejemplo:

@example
>>> import socket
>>> s1, s2 = socket.socketpair()
>>> b1 = bytearray(b'----')
>>> b2 = bytearray(b'0123456789')
>>> b3 = bytearray(b'--------------')
>>> s1.send(b'Mary had a little lamb')
22
>>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3])
(22, [], 0, None)
>>> [b1, b2, b3]
[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]
@end example

@ref{1d5a,,Availability}: Unix.

La mayoría de las plataformas Unix.


Added in version 3.3.

@end deffn

@geindex recvfrom_into() (método de socket.socket)
@anchor{library/socket socket socket recvfrom_into}@anchor{1386}
@deffn {Método} socket.recvfrom_into (buffer[, nbytes[, flags]])

Reciba datos del socket, escribiéndolo en `buffer' en lugar de crear una nueva cadena de bytes.  El valor devuelto es un par @code{(nbytes, address)} donde `nbytes' es el número de bytes recibidos y `address' es la dirección del socket que envía los datos.  Consulte la página del manual de Unix @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} para conocer el significado del argumento opcional `flags'; por defecto es cero.  (El formato de `address' depende de la familia de direcciones — ver arriba.)
@end deffn

@geindex recv_into() (método de socket.socket)
@anchor{library/socket socket socket recv_into}@anchor{1385}
@deffn {Método} socket.recv_into (buffer[, nbytes[, flags]])

Recibe hasta `nbytes' bytes desde el socket, almacenado los datos en un búfer en lugar de crear una nueva cadena de bytes. Si `nbytes' no esta especificado (o 0), recibir hasta el tamaño disponible en el búfer dado. Retorna  el número de bytes recibidos. Ver la página del manual de Unix @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} para el significado del argumento opcional `flags'; por defecto es cero.
@end deffn

@geindex send() (método de socket.socket)
@anchor{library/socket socket socket send}@anchor{e2d}
@deffn {Método} socket.send (bytes[, flags])

Enviar datos al socket.  El socket debe estar conectado a un socket remoto.  El argumento opcional `flags' tiene el mismo significado que para @ref{e2a,,recv()} arriba. Retorna el número de bytes enviados. Las aplicaciones son responsables de comprobar que se han enviado todos los datos; si solo se transmitieron algunos de los datos, la aplicación debe intentar la entrega de los datos restantes. Para obtener más información sobre este tema, consulte @ref{338d,,HOW TO - Programación con sockets}.


Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex sendall() (método de socket.socket)
@anchor{library/socket socket socket sendall}@anchor{e2e}
@deffn {Método} socket.sendall (bytes[, flags])

Enviar datos al socket.  El socket debe estar conectado a un socket remoto.  El argumento opcional `flags' tiene el mismo significado que para @ref{e2a,,recv()} arriba. A diferencia de @ref{e2d,,send()}, este método continúa enviando datos desde `bytes' hasta que se han enviado todos los datos o se produce un error.  @code{Ninguno} se devuelve en caso de éxito.  Por error, se genera una excepción y no hay forma de determinar cuántos datos, si los hay, se enviaron correctamente.


Distinto en la versión 3.5: El tiempo de espera del socket ya no se restablece cada vez que los datos se envían correctamente. El tiempo de espera del socket es ahora la duración total máxima para enviar todos los datos.



Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex sendto() (método de socket.socket)
@anchor{library/socket socket socket sendto}@anchor{e2f}
@deffn {Método} socket.sendto (bytes, address)

@deffnx {Método} socket.sendto (bytes, flags, address)

Enviar datos al socket.  El socket no debe estar conectado a un socket remoto, ya que el socket de destino se especifica mediante `address'.  El argumento opcional `flags' tiene el mismo significado que para @ref{e2a,,recv()} arriba.  Devolver el número de bytes enviados. (El formato de `address' depende de la familia de direcciones — ver arriba.)

Genera un @ref{18c3,,auditing event} @code{socket.sendto} con los argumentos @code{self}, @code{address}.


Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex sendmsg() (método de socket.socket)
@anchor{library/socket socket socket sendmsg}@anchor{521}
@deffn {Método} socket.sendmsg (buffers[, ancdata[, flags[, address]]])

Enviar datos normales y auxiliares al socket, recopilar los datos no auxiliares de una serie de buffers y concatenando en un único mensaje.  El argumento `buffers' especifica los datos no auxiliares como un iterable de @ref{db4,,bytes-como objetos} (por ejemplo: objetos @ref{325,,bytes}); el sistema operativo puede establecer un límite (@ref{2b68,,os.sysconf()} valor @code{SC_IOV_MAX}) en el número de buffers que se pueden utilizar.  El argumento `ancdata' especifica los datos auxiliares (mensajes de control) como un iterable de cero o más tuplas @code{(cmsg_level, cmsg_type, cmsg_data)}, donde `cmsg_level' y `cmsg_type' son enteros que especifican el nivel de protocolo y el tipo específico del protocolo respectivamente, y `cmsg_data' es un objeto similar a bytes que contiene los datos asociados.  Tenga en cuenta que algunos sistemas (en particular, sistemas sin @ref{1a3d,,CMSG_SPACE()}) pueden admitir el envío de solo un mensaje de control por llamada.  El valor predeterminado del argumento `flags' es 0 y tiene el mismo significado que para @ref{e2d,,send()}.  Si se proporciona `address' y no @code{None}, establece una dirección de destino para el mensaje.  El valor devuelto es el número de bytes de datos no auxiliares enviados.

La siguiente función envía la lista de descriptores de archivos `fds' sobre un socket @ref{1826,,AF_UNIX}, estos sistemas pueden soportar la mecánica @code{SCM_RIGHTS}. Observar también @ref{e2c,,recvmsg()}.

@example
import socket, array

def send_fds(sock, msg, fds):
    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])
@end example

@ref{1d5a,,Availability}: Unix, not WASI.

La mayoría de las plataformas Unix.

Genera un @ref{18c3,,auditing event} @code{socket.sendmsg} con los argumentos @code{self}, @code{address}.


Added in version 3.3.



Distinto en la versión 3.5: Si se interrumpe la llamada del sistema y el controlador de señal no genera una excepción, el método ahora vuelve a intentar la llamada del sistema en lugar de generar una excepción @ref{e0e,,InterruptedError} (consulte 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la lógica).

@end deffn

@geindex sendmsg_afalg() (método de socket.socket)
@anchor{library/socket socket socket sendmsg_afalg}@anchor{d5f}
@deffn {Método} socket.sendmsg_afalg ([msg], *, op[, iv[, assoclen[, flags]]])

Versión especializada de @ref{521,,sendmsg()} para el socket @ref{d5e,,AF_ALG}. Modo de ajuste, IV, longitud de datos asociados a AEAD y banderas para el socket @ref{d5e,,AF_ALG}.

@ref{1d5a,,Availability}: Linux >= 2.6.38.


Added in version 3.6.

@end deffn

@geindex sendfile() (método de socket.socket)
@anchor{library/socket socket socket sendfile}@anchor{edd}
@deffn {Método} socket.sendfile (file, offset=0, count=None)

Enviar un archivo hasta que se alcance EOF mediante el uso de alto rendimiento @ref{b9a,,os.sendfile} y devolver el número total de bytes que se enviaron. `file' debe ser un objeto de archivo normal abierto en modo binario. Si @ref{b9a,,os.sendfile} no está disponible (por ejemplo, Windows) o `file' no es un archivo normal @ref{e2d,,send()} se utilizará en su lugar. `offset' indica desde dónde empezar a leer el archivo. Si se especifica, `count' es el número total de bytes para transmitir en lugar de enviar el archivo hasta que se alcance EOF. La posición del archivo se actualiza a la vuelta o también en caso de error en cuyo caso @ref{29aa,,file.tell()} se puede utilizar para averiguar el número de bytes que se enviaron. El socket debe ser de tipo @ref{135a,,SOCK_STREAM} No se admiten sockets sin bloqueo.


Added in version 3.5.

@end deffn

@geindex set_inheritable() (método de socket.socket)
@anchor{library/socket socket socket set_inheritable}@anchor{f82}
@deffn {Método} socket.set_inheritable (inheritable)

Selecciona el @ref{f7c,,inheritable flag} descriptor del archivo del socket o el controlador del socket.


Added in version 3.4.

@end deffn

@geindex setblocking() (método de socket.socket)
@anchor{library/socket socket socket setblocking}@anchor{2b41}
@deffn {Método} socket.setblocking (flag)

Establecer el modo de bloqueo o no bloqueo del socket: si `flag' es false, el socket se establece en modo sin bloqueo, de lo contrario en modo de bloqueo.

El método es una abreviatura para ciertas llamadas @ref{3349,,settimeout()}:


@itemize *

@item 
@code{sock.setblocking(True)} es equivalente a @code{sock.settimeout(None)}

@item 
@code{sock.setblocking(False)} es equivalente a @code{sock.settimeout(0.0)}
@end itemize


Distinto en la versión 3.7: El método ya no aplica la bandera @ref{c92,,SOCK_NONBLOCK} en @ref{c94,,socket.type}.

@end deffn

@geindex settimeout() (método de socket.socket)
@anchor{library/socket socket socket settimeout}@anchor{3349}
@deffn {Método} socket.settimeout (value)

Set a timeout on blocking socket operations.  The `value' argument can be a
nonnegative floating-point number expressing seconds, or @code{None}.
If a non-zero value is given, subsequent socket operations will raise a
@ref{8cb,,timeout} exception if the timeout period `value' has elapsed before
the operation has completed.  If zero is given, the socket is put in
non-blocking mode. If @code{None} is given, the socket is put in blocking mode.

Para obtener más información, consulte las notas @ref{338e,,notas sobre los tiempos de espera del socket}.


Distinto en la versión 3.7: El método ya no cambia la bandera @ref{c92,,SOCK_NONBLOCK} en  @ref{c94,,socket.type}.

@end deffn

@geindex setsockopt() (método de socket.socket)
@anchor{library/socket socket socket setsockopt}@anchor{d5d}
@deffn {Método} socket.setsockopt (level, optname, value: int)
@end deffn


@deffn {Método} socket.setsockopt (level, optname, value: buffer)
@end deffn


@deffn {Método} socket.setsockopt (level, optname, None, optlen: int)

@geindex modulo;estructura

Set the value of the given socket option (see the Unix manual page
@code{setsockopt(2)@footnote{https://manpages.debian.org/setsockopt(2)}}).  The needed symbolic constants are defined in this
module (SO_* etc. <socket-unix-constants>).  The value can be an integer,
@code{None} or a @ref{db4,,bytes-like object} representing a buffer. In the later
case it is up to the caller to ensure that the bytestring contains the
proper bits (see the optional built-in module @ref{d5,,struct} for a way to
encode C structures as bytestrings). When `value' is set to @code{None},
`optlen' argument is required. It’s equivalent to call @code{setsockopt()} C
function with @code{optval=NULL} and @code{optlen=optlen}.


Distinto en la versión 3.5: Ahora se acepta la grabación @ref{db4,,bytes-like object}.



Distinto en la versión 3.6: setsockopt(level, optname, None, optlen: int) form added.


@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex shutdown() (método de socket.socket)
@anchor{library/socket socket socket shutdown}@anchor{3379}
@deffn {Método} socket.shutdown (how)

Apague una o ambas mitades de la conexión. Si `how' es @ref{3376,,SHUT_RD}, más recibe no se permiten. Si `how' es  @ref{3377,,SHUT_WR}, mas recibe no se permiten. Si `how' es @ref{3378,,SHUT_RDWR}, más recibe no se permiten.

@ref{1d5a,,Availability}: not WASI.
@end deffn

@geindex share() (método de socket.socket)
@anchor{library/socket socket socket share}@anchor{c90}
@deffn {Método} socket.share (process_id)

Duplica un socket y lo prepara para compartirlo con el proceso de destino. El proceso de destino debe estar provisto de `process_id'. el objeto de bytes resultante luego se puede pasar al proceso de destino usando alguna forma de comunicación entre procesos y el socket se puede recrear allí usando  @ref{c8f,,fromshare()}. Una vez que se ha llamado a este método, es seguro cerrar el socket ya que el sistema operativo ya lo ha duplicado para el proceso de destino.

@ref{1d5a,,Availability}: Windows.


Added in version 3.3.

@end deffn

Tenga en cuenta que no hay métodos @code{read()} o @code{write()}; use @ref{e2a,,recv()} y @ref{e2d,,send()} sin el argumento `flags' en su lugar.

Los objetos de socket también tienen estos atributos (de solo lectura) que corresponden a los valores dados al constructor @ref{e27,,socket}.

@geindex family (atributo de socket.socket)
@anchor{library/socket socket socket family}@anchor{338f}
@deffn {Atributo} socket.family

La familia socket.
@end deffn

@geindex type (atributo de socket.socket)
@anchor{library/socket socket socket type}@anchor{c94}
@deffn {Atributo} socket.type

El tipo de socket.
@end deffn

@geindex proto (atributo de socket.socket)
@anchor{library/socket socket socket proto}@anchor{3390}
@deffn {Atributo} socket.proto

The socket protocol.
@end deffn

@node Notas sobre los tiempos de espera del socket,Ejemplo<7>,Objetos Socket,socket — Low-level networking interface
@anchor{library/socket notes-on-socket-timeouts}@anchor{3391}@anchor{library/socket socket-timeouts}@anchor{338e}
@subsubsection Notas sobre los tiempos de espera del socket


Un objeto de socket puede estar en uno de los tres modos: bloqueo, no bloqueo o tiempo de espera.  Los sockets se crean de forma predeterminada siempre en modo de bloqueo, pero esto se puede cambiar llamando a @ref{334d,,setdefaulttimeout()}.


@itemize *

@item 
En el modo `bloqueo', las operaciones se bloquean hasta que se completan o el sistema devuelve un error (como tiempo de espera de conexión agotado).

@item 
En `modo sin bloqueo', las operaciones fallan (con un error que desafortunadamente depende del sistema) si no se pueden completar inmediatamente: las funciones del módulo @ref{c1,,select} se pueden usar para saber cuándo y si un socket está disponible para leer o escribir.

@item 
En `timeout mode', las operaciones fallan si no se puede completan el tiempo de espera especifico para el socket (ellos lanzan una excepción @ref{8cb,,timeout}) o si el sistema devuelve un error.
@end itemize

@cartouche
@quotation Nota 
At the operating system level, sockets in `timeout mode' are internally set
in non-blocking mode.  Also, the blocking and timeout modes are shared between
file descriptors and socket objects that refer to the same network endpoint.
This implementation detail can have visible consequences if e.g. you decide
to use the @ref{338a,,fileno()} of a socket.
@end quotation
@end cartouche

@menu
* Tiempos de espera y el método connect:: 
* Tiempos de espera y el método accept:: 

@end menu

@node Tiempos de espera y el método connect,Tiempos de espera y el método accept,,Notas sobre los tiempos de espera del socket
@anchor{library/socket timeouts-and-the-connect-method}@anchor{3392}
@subsubsection Tiempos de espera y el método @code{connect}


La operación @ref{e29,,connect()} también está sujeta a la configuración de tiempo de espera, y en general se recomienda llamar a @ref{3349,,settimeout()} antes de llamar a @ref{e29,,connect()} o pasar un parámetro de tiempo de espera a @ref{713,,create_connection()}.  Sin embargo, la pila de red del sistema también puede devolver un error de tiempo de espera de conexión propio independientemente de cualquier configuración de tiempo de espera del socket de Python.

@node Tiempos de espera y el método accept,,Tiempos de espera y el método connect,Notas sobre los tiempos de espera del socket
@anchor{library/socket timeouts-and-the-accept-method}@anchor{3393}
@subsubsection Tiempos de espera y el método @code{accept}


Si @ref{337e,,getdefaulttimeout()} no es una @ref{716,,None}, los sockets devuelto por el método @ref{e28,,accept()} heredan ese tiempo de espera. De lo contrario, el comportamiento depende de la configuración de la toma de escucha:


@itemize *

@item 
si los sockets están escuchando en `blocking mode' o en el `timeout mode', el socket devuelve el @ref{e28,,accept()} en un `blocking mode';

@item 
si los sockets están escuchando en `non-blocking mode', ya sea el socket devuelto por @ref{e28,,accept()} es un modo de bloqueo o no bloque depende del sistema operativo. Si desea garantizar un comportamiento multiplataforma, se recomienda que se anule manualmente esta configuración.
@end itemize

@node Ejemplo<7>,,Notas sobre los tiempos de espera del socket,socket — Low-level networking interface
@anchor{library/socket example}@anchor{3394}@anchor{library/socket socket-example}@anchor{3395}
@subsubsection Ejemplo


Here are four minimal example programs using the TCP/IP protocol: a server that
echoes all data that it receives back (servicing only one client), and a client
using it.  Note that a server must perform the sequence @ref{e27,,socket()},
@ref{157a,,bind()}, @ref{ede,,listen()}, @ref{e28,,accept()} (possibly
repeating the @ref{e28,,accept()} to service more than one client), while a
client only needs the sequence @ref{e27,,socket()}, @ref{e29,,connect()}.  Also
note that the server does not @ref{e2e,,sendall()}/@ref{e2a,,recv()} on
the socket it is listening on but on the new socket returned by
@ref{e28,,accept()}.

Los dos primeros ejemplos solo admiten IPv4.

@example
# Echo server program
import socket

HOST = '@w{'}                 # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.bind((HOST, PORT))
    s.listen(1)
    conn, addr = s.accept()
    with conn:
        print('Connected by', addr)
        while True:
            data = conn.recv(1024)
            if not data: break
            conn.sendall(data)
@end example

@example
# Echo client program
import socket

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.connect((HOST, PORT))
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))
@end example

The next two examples are identical to the above two, but support both IPv4 and
IPv6. The server side will listen to the first address family available (it
should listen to both instead). On most of IPv6-ready systems, IPv6 will take
precedence and the server may not accept IPv4 traffic. The client side will try
to connect to all the addresses returned as a result of the name resolution, and
sends traffic to the first one connected successfully.

@example
# Echo server program
import socket
import sys

HOST = None               # Symbolic name meaning all available interfaces
PORT = 50007              # Arbitrary non-privileged port
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,
                              socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.bind(sa)
        s.listen(1)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
conn, addr = s.accept()
with conn:
    print('Connected by', addr)
    while True:
        data = conn.recv(1024)
        if not data: break
        conn.send(data)
@end example

@example
# Echo client program
import socket
import sys

HOST = 'daring.cwi.nl'    # The remote host
PORT = 50007              # The same port as used by the server
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.connect(sa)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
with s:
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))
@end example

El siguiente ejemplo muestra cómo escribir un rastreador de red muy simple con sockets sin procesar en Windows. El ejemplo requiere privilegios de administrador para modificar la interfaz:

@example
import socket

# the public network interface
HOST = socket.gethostbyname(socket.gethostname())

# create a raw socket and bind it to the public interface
s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
s.bind((HOST, 0))

# Include IP headers
s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)

# receive all packets
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)

# receive a packet
print(s.recvfrom(65565))

# disabled promiscuous mode
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
@end example

En el ejemplo siguiente se muestra cómo utilizar la interfaz de socket para comunicarse con una red CAN mediante el protocolo de socket sin procesar. Para utilizar CAN con el protocolo de gestor de difusión en su lugar, abra un socket con:

@example
socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
@end example

Después de vincular (@code{CAN_RAW}) o conectar (@ref{1021,,CAN_BCM}) el socket, puede usar las operaciones @ref{e2d,,socket.send()} y @ref{e2a,,socket.recv()} (y sus contrapartes) en el objeto socket como de costumbre.

Este último ejemplo puede requerir privilegios especiales:

@example
import socket
import struct


# CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>)

can_frame_fmt = "=IB3x8s"
can_frame_size = struct.calcsize(can_frame_fmt)

def build_can_frame(can_id, data):
    can_dlc = len(data)
    data = data.ljust(8, b'\x00')
    return struct.pack(can_frame_fmt, can_id, can_dlc, data)

def dissect_can_frame(frame):
    can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)
    return (can_id, can_dlc, data[:can_dlc])


# create a raw socket and bind it to the 'vcan0' interface
s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
s.bind(('vcan0',))

while True:
    cf, addr = s.recvfrom(can_frame_size)

    print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))

    try:
        s.send(cf)
    except OSError:
        print('Error sending CAN frame')

    try:
        s.send(build_can_frame(0x01, b'\x01\x02\x03'))
    except OSError:
        print('Error sending CAN frame')
@end example

Ejecutar un ejemplo varias veces con un retraso demasiado pequeño entre ejecuciones, podría dar lugar a este error:

@example
OSError: [Errno 98] Address already in use
@end example

Esto se debe a que la ejecución anterior ha dejado el socket en un estado @code{TIME_WAIT} y no se puede reutilizar inmediatamente.

Hay un indicador @ref{cc,,socket} para configurar, para evitar esto, @code{socket.SO_REUSEADDR}:

@example
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((HOST, PORT))
@end example

el indicador @code{SO_REUSEADDR} indica al kernel que reutilice un socket local en estado @code{TIME_WAIT}, sin esperar a que expire su tiempo de espera natural.


@subsubheading Ver también


Para obtener una introducción a la programación de sockets (en C), consulte los siguientes documentos:


@itemize -

@item 
`An Introductory 4.3BSD Interprocess Communication Tutorial', por Stuart Sechrest

@item 
`An Advanced 4.3BSD Interprocess Communication Tutorial', por Samuel J.  Leffler et al,
@end itemize

ambos en el manual del programador de Unix, documentos suplementarios 1 ( secciones  PS1:7 y PS1:8). La plataforma especifica material de referencia para las diversas llamadas al sistema también son una valiosa fuente de información en los detalles de la semántica del socket. Para Unix, referencia a las paginas del manual, para Windows, observa la especificación WinSock (o WinSock 2). Para APIS listas IPV6, los lectores pueden querer referirse al titulado Extensiones básicas de interfaz de socket para IPv6 
@geindex RFC; RFC 3493
RFC 3493@footnote{https://datatracker.ietf.org/doc/html/rfc3493.html} .


@node ssl — TLS/SSL wrapper for socket objects,select — Waiting for I/O completion,socket — Low-level networking interface,Comunicación en redes y entre procesos
@anchor{library/ssl doc}@anchor{3396}@anchor{library/ssl module-ssl}@anchor{d0}@anchor{library/ssl ssl-tls-ssl-wrapper-for-socket-objects}@anchor{3397}
@subsection @code{ssl} — TLS/SSL wrapper for socket objects


@geindex module; ssl

`Código fuente:'Lib/ssl.py@footnote{https://github.com/python/cpython/tree/main/Lib/ssl.py}

@geindex OpenSSL;(use in module ssl)

@geindex TLS
@geindex SSL
@geindex Transport Layer Security
@geindex Secure Sockets Layer


__________________________________________________________________


Este módulo proporciona acceso a las funciones de cifrado de Seguridad de la capa de transporte (a menudo conocida como «Capa de sockets seguros») y de autenticación de pares para sockets de red, tanto del lado del cliente como del lado del servidor. Este módulo utiliza la biblioteca OpenSSL. Está disponible en todos los sistemas Unix modernos, Windows, Mac OS X y probablemente en plataformas adicionales, siempre que OpenSSL esté instalado en esa plataforma.

@cartouche
@quotation Nota 
Some behavior may be platform dependent, since calls are made to the
operating system socket APIs.  The installed version of OpenSSL may also
cause variations in behavior. For example, TLSv1.3 comes with OpenSSL version
1.1.1.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
No use este módulo sin leer @ref{3292,,Consideraciones de seguridad}. Hacerlo puede generar una falsa sensación de seguridad, ya que la configuración predeterminada del módulo ssl no es necesariamente la adecuada para su aplicación.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Esta sección documenta los objetos y funciones en el módulo @code{ssl}; para más información general sobre TLS,SSL, y certificados, se recomienda que el lector acuda a la sección «Ver también» al final de la página.

This module provides a class, @ref{981,,ssl.SSLSocket}, which is derived from the
@ref{e27,,socket.socket} type, and provides a socket-like wrapper that also
encrypts and decrypts the data going over the socket with SSL.  It supports
additional methods such as @code{getpeercert()}, which retrieves the
certificate of the other side of the connection, @code{cipher()}, which
retrieves the cipher being used for the secure connection or
@code{get_verified_chain()}, @code{get_unverified_chain()} which retrieves
certificate chain.

Para aplicaciones más sofisticadas, la clase @ref{1fa,,ssl.SSLContext} ayuda a administrar la configuración y los certificados, que luego pueden ser heredados por sockets SSL creados a través del método @ref{5c8,,SSLContext.wrap_socket()}.


Distinto en la versión 3.5.3: Actualizado para admitir la vinculación con OpenSSL 1.1.0



Distinto en la versión 3.6: OpenSSL 0.9.8, 1.0.0 y 1.0.1 son obsoletos y no son compatibles. En el futuro, el módulo ssl requerirá al menos OpenSSL 1.0.2 o 1.1.0.



Distinto en la versión 3.10: Se ha implementado 
@geindex Python Enhancement Proposals; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}. El módulo ssl requiere OpenSSL 1.1.1 o versiones más recientes.

El uso de constantes y funciones obsoletas genera advertencias de obsolescencia.


@menu
* Funciones@comma{} constantes y excepciones: Funciones constantes y excepciones. 
* Sockets SSL:: 
* Contextos SSL:: 
* Certificados:: 
* Ejemplos: Ejemplos<18>. 
* Notas sobre los sockets no bloqueantes:: 
* Soporte de memoria BIO: Soporte de memoria BIO<2>. 
* Sesión SSL:: 
* Consideraciones de seguridad: Consideraciones de seguridad<2>. 
* TLS 1.3: TLS 1 3. 

@end menu

@node Funciones constantes y excepciones,Sockets SSL,,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl functions-constants-and-exceptions}@anchor{3398}
@subsubsection Funciones, constantes y excepciones


@menu
* Creación de sockets: Creación de sockets<2>. 
* Creación de contexto:: 
* Excepciones: Excepciones<14>. 
* Generación aleatoria:: 
* Gestión de certificados:: 
* Constantes: Constantes<9>. 

@end menu

@node Creación de sockets<2>,Creación de contexto,,Funciones constantes y excepciones
@anchor{library/ssl socket-creation}@anchor{3399}
@subsubsection Creación de sockets


Instances of @ref{981,,SSLSocket} must be created using the
@ref{5c8,,SSLContext.wrap_socket()} method. The helper function
@ref{2c1,,create_default_context()} returns a new context with secure default
settings.

Ejemplo de socket cliente con contexto por defecto y doble pila IPv4/IPv6:

@example
import socket
import ssl

hostname = 'www.python.org'
context = ssl.create_default_context()

with socket.create_connection((hostname, 443)) as sock:
    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
        print(ssock.version())
@end example

Ejemplo de socket cliente con contexto personalizado y IPv4:

@example
hostname = 'www.python.org'
# PROTOCOL_TLS_CLIENT requires valid cert chain and hostname
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.load_verify_locations('path/to/cabundle.pem')

with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
        print(ssock.version())
@end example

Ejemplo de socket servidor escuchando en localhost IPv4:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key')

with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    sock.bind(('127.0.0.1', 8443))
    sock.listen(5)
    with context.wrap_socket(sock, server_side=True) as ssock:
        conn, addr = ssock.accept()
        ...
@end example

@node Creación de contexto,Excepciones<14>,Creación de sockets<2>,Funciones constantes y excepciones
@anchor{library/ssl context-creation}@anchor{339a}
@subsubsection Creación de contexto


Una función conveniente ayuda a crear objetos @ref{1fa,,SSLContext} para propósitos comunes.

@geindex create_default_context() (en el módulo ssl)
@anchor{library/ssl ssl create_default_context}@anchor{2c1}
@deffn {Función} ssl.create_default_context (purpose=Purpose.SERVER_AUTH, cafile=None, capath=None, cadata=None)

Retorna un nuevo objeto @ref{1fa,,SSLContext} con ajustes por defecto para el `purpose' dado. Los ajustes son elegidos por el módulo @ref{d0,,ssl} y generalmente representan un nivel de seguridad mas alto que invocando directamente el constructor de @ref{1fa,,SSLContext}.

`cafile', `capath', `cadata' representan certificados CA opcionales para confiar en la verificación de certificados, como en @ref{f6e,,SSLContext.load_verify_locations()}. Si los tres son @ref{716,,None} al mismo tiempo, esta función puede optar por confiar en su lugar en los certificados CA por defecto del sistema.

The settings are: @ref{909,,PROTOCOL_TLS_CLIENT} or
@ref{90a,,PROTOCOL_TLS_SERVER}, @ref{8d0,,OP_NO_SSLv2}, and @ref{8d1,,OP_NO_SSLv3}
with high encryption cipher suites without RC4 and
without unauthenticated cipher suites. Passing @ref{1031,,SERVER_AUTH}
as `purpose' sets @ref{339b,,verify_mode} to @ref{339c,,CERT_REQUIRED}
and either loads CA certificates (when at least one of `cafile', `capath' or
`cadata' is given) or uses @ref{1030,,SSLContext.load_default_certs()} to load
default CA certificates.

Cuando @ref{339d,,keylog_filename} es soportado y la variable de entorno 
@geindex SSLKEYLOGFILE
@geindex variables de entorno; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} está establecida, @ref{2c1,,create_default_context()} activa el registro de claves.

The default settings for this context include
@ref{2c2,,VERIFY_X509_PARTIAL_CHAIN} and @ref{2c3,,VERIFY_X509_STRICT}.
These make the underlying OpenSSL implementation behave more like
a conforming implementation of 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}, in exchange for a small
amount of incompatibility with older X.509 certificates.

@cartouche
@quotation Nota 
El protocolo, las opciones, el cifrado y otros ajustes pueden cambiar a valores mas restrictivos en cualquier momento sin previa obsolescencia. Los valores representan un equilibrio justo entre compatibilidad y seguridad.

Si su aplicación necesita ajustes específicos, debe crear un @ref{1fa,,SSLContext} y aplicar los ajustes usted mismo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Si encuentra que cuando ciertos clientes o servidores antiguos intentan conectarse con un @ref{1fa,,SSLContext} creado con esta función obtienen un error indicando `Protocol or cipher suite mismatch', puede ser que estos sólo soportan SSL3.0 el cual esta función excluye utilizando @ref{8d1,,OP_NO_SSLv3}. SSL3.0 está ampliamente considerado como completamente roto@footnote{https://en.wikipedia.org/wiki/POODLE}. Si todavía desea seguir utilizando esta función pero permitir conexiones SSL 3.0, puede volver a activarlas mediante:

@example
ctx = ssl.create_default_context(Purpose.CLIENT_AUTH)
ctx.options &= ~ssl.OP_NO_SSLv3
@end example
@end quotation
@end cartouche

@cartouche
@quotation Nota 
This context enables @ref{2c3,,VERIFY_X509_STRICT} by default, which
may reject pre-
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html} or malformed certificates that the
underlying OpenSSL implementation otherwise would accept. While disabling
this is not recommended, you can do so using:

@example
ctx = ssl.create_default_context()
ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
@end example
@end quotation
@end cartouche


Added in version 3.4.



Distinto en la versión 3.4.4: RC4 ha sido abandonado de la cadena de cifrado por defecto.



Distinto en la versión 3.6: ChaCha20/Poly1305 ha sido agregado a la cadena de caracteres de cifrado por defecto.

3DES ha sido abandonado de la cadena de caracteres de cifrado por defecto.



Distinto en la versión 3.8: Soporte del registro de claves en 
@geindex SSLKEYLOGFILE
@geindex variables de entorno; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} ha sido agregado.



Distinto en la versión 3.10: El contexto ahora usa el protocolo @ref{909,,PROTOCOL_TLS_CLIENT} o @ref{90a,,PROTOCOL_TLS_SERVER} en lugar del @ref{339e,,PROTOCOL_TLS} genérico.



Distinto en la versión 3.13: The context now uses @ref{2c2,,VERIFY_X509_PARTIAL_CHAIN} and
@ref{2c3,,VERIFY_X509_STRICT} in its default verify flags.

@end deffn

@node Excepciones<14>,Generación aleatoria,Creación de contexto,Funciones constantes y excepciones
@anchor{library/ssl exceptions}@anchor{339f}
@subsubsection Excepciones


@geindex SSLError
@anchor{library/ssl ssl SSLError}@anchor{12e7}
@deffn {Excepción} ssl.SSLError

Se lanza para señalar un error de la implementación de SSL subyacente (actualmente proporcionada por la biblioteca OpenSSL). Esto indica algún problema en la capa de cifrado y autenticación de alto nivel que se superpone a la conexión de red subyacente. Este error es un subtipo de @ref{4d5,,OSError}. El código de error y el mensaje de las instancias de @ref{12e7,,SSLError} son proporcionados por la biblioteca OpenSSL.


Distinto en la versión 3.3: @ref{12e7,,SSLError} era un subtipo de @ref{10d1,,socket.error}.


@geindex library (atributo de ssl.SSLError)
@anchor{library/ssl ssl SSLError library}@anchor{11b8}
@deffn {Atributo} library

Una cadena de caracteres mnemotécnica que designa el submódulo de OpenSSL en el que se ha producido el error, como @code{SSL}, @code{PEM} o @code{X509}. El rango de valores posibles depende de la versión de OpenSSL.


Added in version 3.3.

@end deffn

@geindex reason (atributo de ssl.SSLError)
@anchor{library/ssl ssl SSLError reason}@anchor{11b9}
@deffn {Atributo} reason

Una cadena de caracteres mnemotécnica que designa la razón por la que se produjo el error, por ejemplo @code{CERTIFICATE_VERIFY_FAILED}. El rango de valores posibles depende de la versión de OpenSSL.


Added in version 3.3.

@end deffn
@end deffn

@geindex SSLZeroReturnError
@anchor{library/ssl ssl SSLZeroReturnError}@anchor{33a0}
@deffn {Excepción} ssl.SSLZeroReturnError

Una subclase de @ref{12e7,,SSLError} lanzada cuando se intenta leer o escribir y la conexión SSL ha sido cerrada limpiamente. Tenga en cuenta que esto no significa que el transporte subyacente (lectura TCP) haya sido cerrado.


Added in version 3.3.

@end deffn

@geindex SSLWantReadError
@anchor{library/ssl ssl SSLWantReadError}@anchor{ee9}
@deffn {Excepción} ssl.SSLWantReadError

Una subclase de @ref{12e7,,SSLError} lanzada por un @ref{33a1,,socket SSL no bloqueante} cuando se intenta leer o escribir datos, pero mas datos necesitan ser recibidos en el transporte TCP subyacente antes de que la solicitud pueda ser completada.


Added in version 3.3.

@end deffn

@geindex SSLWantWriteError
@anchor{library/ssl ssl SSLWantWriteError}@anchor{eea}
@deffn {Excepción} ssl.SSLWantWriteError

Una subclase de @ref{12e7,,SSLError} lanzada por un @ref{33a1,,socket SSL no bloqueante} cuando se intenta leer o escribir datos, pero mas datos necesitan ser enviados en el transporte TCP subyacente antes de que la solicitud pueda ser completada.


Added in version 3.3.

@end deffn

@geindex SSLSyscallError
@anchor{library/ssl ssl SSLSyscallError}@anchor{33a2}
@deffn {Excepción} ssl.SSLSyscallError

Una subclase de @ref{12e7,,SSLError} lanzada cuando se encuentra un error del sistema mientras se intenta completar una operación en un socket SSL. Por desgracia, no hay una manera fácil de inspeccionar el número errno original.


Added in version 3.3.

@end deffn

@geindex SSLEOFError
@anchor{library/ssl ssl SSLEOFError}@anchor{174c}
@deffn {Excepción} ssl.SSLEOFError

Una subclase de @ref{12e7,,SSLError} lanzada cuando la conexión SSL ha sido cancelada abruptamente. Generalmente, no debería intentar reutilizar el transporte subyacente cuando este error se produce.


Added in version 3.3.

@end deffn

@geindex SSLCertVerificationError
@anchor{library/ssl ssl SSLCertVerificationError}@anchor{c04}
@deffn {Excepción} ssl.SSLCertVerificationError

Una subclase de @ref{12e7,,SSLError} lanzada cuando la validación del certificado ha fallado.


Added in version 3.7.


@geindex verify_code (atributo de ssl.SSLCertVerificationError)
@anchor{library/ssl ssl SSLCertVerificationError verify_code}@anchor{33a3}
@deffn {Atributo} verify_code

Un número de error numérico que indica el error de verificación.
@end deffn

@geindex verify_message (atributo de ssl.SSLCertVerificationError)
@anchor{library/ssl ssl SSLCertVerificationError verify_message}@anchor{33a4}
@deffn {Atributo} verify_message

Una cadena de caracteres legible del error de verificación.
@end deffn
@end deffn

@geindex CertificateError
@anchor{library/ssl ssl CertificateError}@anchor{33a5}
@deffn {Excepción} ssl.CertificateError

Un alias para @ref{c04,,SSLCertVerificationError}.


Distinto en la versión 3.7: La excepción es ahora un alias para @ref{c04,,SSLCertVerificationError}.

@end deffn

@node Generación aleatoria,Gestión de certificados,Excepciones<14>,Funciones constantes y excepciones
@anchor{library/ssl random-generation}@anchor{33a6}
@subsubsection Generación aleatoria


@geindex RAND_bytes() (en el módulo ssl)
@anchor{library/ssl ssl RAND_bytes}@anchor{5c7}
@deffn {Función} ssl.RAND_bytes (num)

Retorna `num' bytes pseudoaleatorios criptográficamente fuertes. Lanza un @ref{12e7,,SSLError} si el PRNG no a sido sembrado con suficiente datos o si la operación no es soportada por el método RAND actual. @ref{18cf,,RAND_status()} puede ser usada para verificar el estado de PRNG y @ref{33a7,,RAND_add()} puede ser usada para sembrar el PRNG.

Para casi todas las aplicaciones @ref{5c6,,os.urandom()} es preferible.

Léase el artículo Wikipedia, Generador de números pseudoaleatorios criptográficamente seguro (CSPRNG)@footnote{https://es.wikipedia.org/wiki/Generador_de_n%C3%BAmeros_pseudoaleatorios_criptogr%C3%A1ficamente_seguro}, para obtener los requisitos para un generador criptográficamente seguro.


Added in version 3.3.

@end deffn

@geindex RAND_status() (en el módulo ssl)
@anchor{library/ssl ssl RAND_status}@anchor{18cf}
@deffn {Función} ssl.RAND_status ()

Retorna @code{True} si el generador de números pseudoaleatorios SSL a sido sembrado con “suficiente” aleatoriedad, y @code{False} de lo contrario. Puede utilizarse @code{ssl.RAND_egd()} y @ref{33a7,,ssl.RAND_add()} para aumentar la aleatoriedad del generador de números pseudoaleatorios.
@end deffn

@geindex RAND_add() (en el módulo ssl)
@anchor{library/ssl ssl RAND_add}@anchor{33a7}
@deffn {Función} ssl.RAND_add (bytes, entropy)

Mix the given `bytes' into the SSL pseudo-random number generator.  The
parameter `entropy' (a float) is a lower bound on the entropy contained in
string (so you can always use @code{0.0}).  See 
@geindex RFC; RFC 1750
RFC 1750@footnote{https://datatracker.ietf.org/doc/html/rfc1750.html} for more
information on sources of entropy.


Distinto en la versión 3.5: Ahora se acepta @ref{db4,,bytes-like object} modificable.

@end deffn

@node Gestión de certificados,Constantes<9>,Generación aleatoria,Funciones constantes y excepciones
@anchor{library/ssl certificate-handling}@anchor{33a8}
@subsubsection Gestión de certificados


@c import ssl

@geindex cert_time_to_seconds() (en el módulo ssl)
@anchor{library/ssl ssl cert_time_to_seconds}@anchor{eeb}
@deffn {Función} ssl.cert_time_to_seconds (cert_time)

Retorna el tiempo en segundos desde la Época, dada la cadena de caracteres @code{cert_time} que representa la fecha `notBefore' o `notAfter' de un certificado en formato strptime @code{"%b %d %H:%M:%S %Y %Z"} (C locale).

He aquí un ejemplo:

@example
>>> import ssl
>>> timestamp = ssl.cert_time_to_seconds("Jan  5 09:34:43 2018 GMT")
>>> timestamp  
1515144883
>>> from datetime import datetime
>>> print(datetime.utcfromtimestamp(timestamp))  
2018-01-05 09:34:43
@end example

Las fechas `notBefore' o `notAfter' deben utilizar GMT (
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}).


Distinto en la versión 3.5: Interpreta la hora de entrada como una hora en UTC según lo especificado por la zona horaria “GMT” en la cadena de caracteres de entrada. Anteriormente se utilizaba la zona horaria local. Retorna un número entero (sin fracciones de segundo en el formato de entrada)

@end deffn

@geindex get_server_certificate() (en el módulo ssl)
@anchor{library/ssl ssl get_server_certificate}@anchor{8d3}
@deffn {Función} ssl.get_server_certificate (addr, ssl_version=PROTOCOL_TLS_CLIENT, ca_certs=None[, timeout])

Given the address @code{addr} of an SSL-protected server, as a (`hostname',
`port-number') pair, fetches the server’s certificate, and returns it as a
PEM-encoded string.  If @code{ssl_version} is specified, uses that version of
the SSL protocol to attempt to connect to the server.  If `ca_certs' is
specified, it should be a file containing a list of root certificates, the
same format as used for the `cafile' parameter in
@ref{f6e,,SSLContext.load_verify_locations()}.  The call will attempt to validate the
server certificate against that set of root certificates, and will fail
if the validation attempt fails.  A timeout can be specified with the
@code{timeout} parameter.


Distinto en la versión 3.3: Esta función es ahora compatible IPv6.



Distinto en la versión 3.5: La `ssl_version' por defecto se cambia de @ref{33a9,,PROTOCOL_SSLv3} a @ref{339e,,PROTOCOL_TLS} para una máxima compatibilidad con los servidores modernos.



Distinto en la versión 3.10: Se agregó el argumento `session'.

@end deffn

@geindex DER_cert_to_PEM_cert() (en el módulo ssl)
@anchor{library/ssl ssl DER_cert_to_PEM_cert}@anchor{33aa}
@deffn {Función} ssl.DER_cert_to_PEM_cert (DER_cert_bytes)

Dado un certificado como blob de bytes codificado en DER, retorna una versión de cadena de caracteres codificada en PEM del mismo certificado.
@end deffn

@geindex PEM_cert_to_DER_cert() (en el módulo ssl)
@anchor{library/ssl ssl PEM_cert_to_DER_cert}@anchor{33ab}
@deffn {Función} ssl.PEM_cert_to_DER_cert (PEM_cert_string)

Dado un certificado como cadena de caracteres ASCII PEM, retorna una secuencia de bytes codificada con DER para ese mismo certificado.
@end deffn

@geindex get_default_verify_paths() (en el módulo ssl)
@anchor{library/ssl ssl get_default_verify_paths}@anchor{1028}
@deffn {Función} ssl.get_default_verify_paths ()

Retorna una tupla con nombre con las rutas por defecto de cafile y capath de OpenSSL. Las rutas son las mismas que las usadas por @ref{1029,,SSLContext.set_default_verify_paths()}. El valor de retorno es una @ref{6ef,,named tuple} @code{DefaultVerifyPaths}:


@itemize *

@item 
@code{cafile} - ruta resuelta a cafile o @code{None} si el archivo no existe,

@item 
@code{capath} - ruta resuelta a capath o @code{None} si el directorio no existe,

@item 
@code{openssl_cafile_env} - clave de entorno de OpenSSL que apunta a un cafile,

@item 
@code{openssl_cafile} - camino codificado de forma rígida a un cafile,

@item 
@code{openssl_capath_env} - clave de entorno de OpenSSL que apunta a un capath,

@item 
@code{openssl_capath} - camino codificado de forma rígida a un directorio capath
@end itemize


Added in version 3.4.

@end deffn

@geindex enum_certificates() (en el módulo ssl)
@anchor{library/ssl ssl enum_certificates}@anchor{1033}
@deffn {Función} ssl.enum_certificates (store_name)

Recupera los certificados del almacén de certificados del sistema de Windows. `store_name' puede ser uno de los siguientes: @code{CA}, @code{ROOT} o @code{MY}. Windows también puede proporcionar almacenes de certificados adicionales.

La función retorna una lista de tuplas (cert_bytes, encoding_type, trust). El encoding_type especifica la codificación de cert_bytes. Es @code{x509_asn} para datos X.509 ASN.1 o @code{pkcs_7_asn} para datos PKCS#7 ASN.1. Trust especifica el propósito del certificado como un conjunto de OIDS o exactamente @code{True} si el certificado es de confianza para todos los propósitos.

Ejemplo:

@example
>>> ssl.enum_certificates("CA")
[(b'data...', 'x509_asn', @{'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'@}),
 (b'data...', 'x509_asn', True)]
@end example

@ref{1d5a,,Availability}: Windows.


Added in version 3.4.

@end deffn

@geindex enum_crls() (en el módulo ssl)
@anchor{library/ssl ssl enum_crls}@anchor{1034}
@deffn {Función} ssl.enum_crls (store_name)

Obtiene CRLs del almacén de certificados del sistema de Windows. `store_name' puede ser uno de los siguientes: @code{CA}, @code{ROOT} o @code{MY}. Windows también puede proporcionar almacenes de certificados adicionales.

La función retorna una lista de tuplas (cert_bytes, encoding_type, trust). El encoding_type especifica la codificación de cert_bytes. Es @code{x509_asn} para datos X.509 ASN.1 o @code{pkcs_7_asn} para datos PKCS#7 ASN.1.

@ref{1d5a,,Availability}: Windows.


Added in version 3.4.

@end deffn

@node Constantes<9>,,Gestión de certificados,Funciones constantes y excepciones
@anchor{library/ssl constants}@anchor{33ac}
@subsubsection Constantes


@quotation

Todas las constantes son ahora colecciones @ref{d66,,enum.IntEnum} o @ref{22fd,,enum.IntFlag}.


Added in version 3.6.

@end quotation

@geindex CERT_NONE (en el módulo ssl)
@anchor{library/ssl ssl CERT_NONE}@anchor{33ad}
@deffn {Dato} ssl.CERT_NONE

Possible value for @ref{339b,,SSLContext.verify_mode}.
Except for @ref{909,,PROTOCOL_TLS_CLIENT},
it is the default mode.  With client-side sockets, just about any
cert is accepted.  Validation errors, such as untrusted or expired cert,
are ignored and do not abort the TLS/SSL handshake.

En modo servidor, no se solicita ningún certificado al cliente, por lo que el cliente no envía ninguno para la autenticación del certificado del cliente.

Vea la discusión sobre @ref{3292,,Consideraciones de seguridad} más abajo.
@end deffn

@geindex CERT_OPTIONAL (en el módulo ssl)
@anchor{library/ssl ssl CERT_OPTIONAL}@anchor{33ae}
@deffn {Dato} ssl.CERT_OPTIONAL

Possible value for @ref{339b,,SSLContext.verify_mode}.
In client mode, @ref{33ae,,CERT_OPTIONAL}
has the same meaning as @ref{339c,,CERT_REQUIRED}. It is recommended to
use @ref{339c,,CERT_REQUIRED} for client-side sockets instead.

En el modo servidor, se envía una solicitud de certificado de cliente al cliente. El cliente puede ignorar la solicitud o enviar un certificado para realizar la autenticación de certificado de cliente TLS. Si el cliente opta por enviar un certificado, éste se verifica. Cualquier error de verificación aborta inmediatamente el handshake TLS.

Use of this setting requires a valid set of CA certificates to
be passed to @ref{f6e,,SSLContext.load_verify_locations()}.
@end deffn

@geindex CERT_REQUIRED (en el módulo ssl)
@anchor{library/ssl ssl CERT_REQUIRED}@anchor{339c}
@deffn {Dato} ssl.CERT_REQUIRED

Possible value for @ref{339b,,SSLContext.verify_mode}.
In this mode, certificates are
required from the other side of the socket connection; an @ref{12e7,,SSLError}
will be raised if no certificate is provided, or if its validation fails.
This mode is `not' sufficient to verify a certificate in client mode as
it does not match hostnames.  @ref{33af,,check_hostname} must be
enabled as well to verify the authenticity of a cert.
@ref{909,,PROTOCOL_TLS_CLIENT} uses @ref{339c,,CERT_REQUIRED} and
enables @ref{33af,,check_hostname} by default.

Con socket servidor, este modo proporciona una autenticación obligatoria de certificado de cliente TLS. Se envía una solicitud de certificado de cliente al cliente y el cliente debe proporcionar un certificado válido y de confianza.

Use of this setting requires a valid set of CA certificates to
be passed to @ref{f6e,,SSLContext.load_verify_locations()}.
@end deffn

@geindex VerifyMode (clase en ssl)
@anchor{library/ssl ssl VerifyMode}@anchor{33b0}
@deffn {Clase} ssl.VerifyMode

Colección @ref{d66,,enum.IntEnum} de constantes CERT_*.


Added in version 3.6.

@end deffn

@geindex VERIFY_DEFAULT (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_DEFAULT}@anchor{102d}
@deffn {Dato} ssl.VERIFY_DEFAULT

Valor posible para @ref{102c,,SSLContext.verify_flags}. En este modo, las listas de revocación de certificado (CRLs) no son verificadas. Por defecto OpenSSL no requiere ni verifica CRLs.


Added in version 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_LEAF (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_CRL_CHECK_LEAF}@anchor{102e}
@deffn {Dato} ssl.VERIFY_CRL_CHECK_LEAF

Valor posible para @ref{102c,,SSLContext.verify_flags}. En este modo, sólo el certificado de pares es verificado pero ninguno de los certificados CA intermedios. El modo requiere una CRL válida que esté firmada por el emisor del certificado de pares (su CA antecesora directa). Si no se ha cargado una CRL adecuada con @ref{f6e,,SSLContext.load_verify_locations}, la validación fallará.


Added in version 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_CHAIN (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_CRL_CHECK_CHAIN}@anchor{102f}
@deffn {Dato} ssl.VERIFY_CRL_CHECK_CHAIN

Valor posible para @ref{102c,,SSLContext.verify_flags}. En este modo, las CRLs de todos los certificados en la cadena de certificado de pares son verificadas.


Added in version 3.4.

@end deffn

@geindex VERIFY_X509_STRICT (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_STRICT}@anchor{2c3}
@deffn {Dato} ssl.VERIFY_X509_STRICT

Valor posible para @ref{102c,,SSLContext.verify_flags} para desactivar soluciones alternativas para certificados X.509 rotos.


Added in version 3.4.

@end deffn

@geindex VERIFY_ALLOW_PROXY_CERTS (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_ALLOW_PROXY_CERTS}@anchor{18e4}
@deffn {Dato} ssl.VERIFY_ALLOW_PROXY_CERTS

Valor posible para @ref{102c,,SSLContext.verify_flags} para desactivar soluciones alternativas para certificados X.509 rotos.


Added in version 3.10.

@end deffn

@geindex VERIFY_X509_TRUSTED_FIRST (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_TRUSTED_FIRST}@anchor{33b1}
@deffn {Dato} ssl.VERIFY_X509_TRUSTED_FIRST

Valor posible para @ref{102c,,SSLContext.verify_flags}. Indica a OpenSSL de preferir certificados de confianza al construir la cadena de confianza para validar un certificado. Esta opción está activada por defecto.


Added in version 3.4.4.

@end deffn

@geindex VERIFY_X509_PARTIAL_CHAIN (en el módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_PARTIAL_CHAIN}@anchor{2c2}
@deffn {Dato} ssl.VERIFY_X509_PARTIAL_CHAIN

Valor posible para @ref{102c,,SSLContext.verify_flags}. Indica a OpenSSL que acepte CA intermedias en el almacén de confianza para que se traten como anclajes de confianza, de la misma manera que los certificados de CA raíz autofirmados. Esto hace posible confiar en los certificados emitidos por una CA intermedia sin tener que confiar en su CA raíz antecesora.


Added in version 3.10.

@end deffn

@geindex VerifyFlags (clase en ssl)
@anchor{library/ssl ssl VerifyFlags}@anchor{33b2}
@deffn {Clase} ssl.VerifyFlags

Colección @ref{22fd,,enum.IntFlag} de constantes VERIFY_*.


Added in version 3.6.

@end deffn

@geindex PROTOCOL_TLS (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS}@anchor{339e}
@deffn {Dato} ssl.PROTOCOL_TLS

Selecciona la versión mas alta del protocolo soportada tanto por el cliente como por el servidor. A pesar de su nombre, esta opción puede seleccionar ambos protocolos «SSL» y «TLS».


Added in version 3.6.



Obsoleto desde la versión 3.10: Los clientes y servidores TLS requieren diferentes configuraciones predeterminadas para una comunicación segura. La constante del protocolo TLS genérico está en desuso en favor de @ref{909,,PROTOCOL_TLS_CLIENT} y @ref{90a,,PROTOCOL_TLS_SERVER}.

@end deffn

@geindex PROTOCOL_TLS_CLIENT (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS_CLIENT}@anchor{909}
@deffn {Dato} ssl.PROTOCOL_TLS_CLIENT

Negocie automáticamente la versión de protocolo más alta que admiten tanto el cliente como el servidor, y configure las conexiones del lado del cliente de contexto. El protocolo habilita @ref{339c,,CERT_REQUIRED} y @ref{33af,,check_hostname} de forma predeterminada.


Added in version 3.6.

@end deffn

@geindex PROTOCOL_TLS_SERVER (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS_SERVER}@anchor{90a}
@deffn {Dato} ssl.PROTOCOL_TLS_SERVER

Selecciona la versión mas alta del protocolo soportada tanto por el cliente como por el servidor. A pesar de su nombre, esta opción puede seleccionar ambos protocolos «SSL» y «TLS».


Added in version 3.6.

@end deffn

@geindex PROTOCOL_SSLv23 (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_SSLv23}@anchor{33b3}
@deffn {Dato} ssl.PROTOCOL_SSLv23

Alias para @ref{339e,,PROTOCOL_TLS}.


Obsoleto desde la versión 3.6: Utilice en su lugar @ref{339e,,PROTOCOL_TLS}.

@end deffn

@geindex PROTOCOL_SSLv3 (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_SSLv3}@anchor{33a9}
@deffn {Dato} ssl.PROTOCOL_SSLv3

Selecciona la versión 3 de SSL como protocolo de cifrado del canal.

Este protocolo no está disponible si se compila OpenSSL con la opción @code{no-ssl3}.

@cartouche
@quotation Advertencia 
La versión 3 de SSL es insegura. Su uso es muy desaconsejado.
@end quotation
@end cartouche


Obsoleto desde la versión 3.6: OpenSSL ha descontinuado todos los protocolos específicos de la versión. Utilice el protocolo predeterminado @ref{90a,,PROTOCOL_TLS_SERVER} o @ref{909,,PROTOCOL_TLS_CLIENT} con @ref{907,,SSLContext.minimum_version} y @ref{908,,SSLContext.maximum_version} en su lugar.

@end deffn

@geindex PROTOCOL_TLSv1 (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1}@anchor{33b4}
@deffn {Dato} ssl.PROTOCOL_TLSv1

Selecciona la versión 1.0 de TLS como protocolo de cifrado del canal.


Obsoleto desde la versión 3.6: OpenSSL ha descontinuado todos los protocolos específicos de la versión.

@end deffn

@geindex PROTOCOL_TLSv1_1 (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1_1}@anchor{1026}
@deffn {Dato} ssl.PROTOCOL_TLSv1_1

Selecciona la versión 1.1 de TLS como protocolo de cifrado del canal. Disponible sólo con openssl en versión 1.0.1+.


Added in version 3.4.



Obsoleto desde la versión 3.6: OpenSSL ha descontinuado todos los protocolos específicos de la versión.

@end deffn

@geindex PROTOCOL_TLSv1_2 (en el módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1_2}@anchor{1027}
@deffn {Dato} ssl.PROTOCOL_TLSv1_2

Selecciona la versión 1.1 de TLS como protocolo de cifrado del canal. Disponible sólo con openssl en versión 1.0.1+.


Added in version 3.4.



Obsoleto desde la versión 3.6: OpenSSL ha descontinuado todos los protocolos específicos de la versión.

@end deffn

@geindex OP_ALL (en el módulo ssl)
@anchor{library/ssl ssl OP_ALL}@anchor{33b5}
@deffn {Dato} ssl.OP_ALL

Activa soluciones alternativas para varios errores presentes en otras implementaciones SSL. Esta opción esta activada por defecto. No necesariamente activa las mismas opciones como la constante @code{SSL_OP_ALL} de OpenSSL.


Added in version 3.2.

@end deffn

@geindex OP_NO_SSLv2 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_SSLv2}@anchor{8d0}
@deffn {Dato} ssl.OP_NO_SSLv2

Evita una conexión SSLv2. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan SSLv2 como versión del protocolo.


Added in version 3.2.



Obsoleto desde la versión 3.6: SSLv2 es obsoleto

@end deffn

@geindex OP_NO_SSLv3 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_SSLv3}@anchor{8d1}
@deffn {Dato} ssl.OP_NO_SSLv3

Evita una conexión SSLv3. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan SSLv3 como versión del protocolo.


Added in version 3.2.



Obsoleto desde la versión 3.6: SSLv3 es obsoleto

@end deffn

@geindex OP_NO_TLSv1 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1}@anchor{33b6}
@deffn {Dato} ssl.OP_NO_TLSv1

Evita una conexión TLSv1. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan TLSv1 como versión del protocolo.


Added in version 3.2.



Obsoleto desde la versión 3.7: Esta opción es obsoleta desde OpenSSL 1.1.0, utilice en su lugar los nuevos @ref{907,,SSLContext.minimum_version} y @ref{908,,SSLContext.maximum_version}.

@end deffn

@geindex OP_NO_TLSv1_1 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_1}@anchor{33b7}
@deffn {Dato} ssl.OP_NO_TLSv1_1

Evita una conexión TLSv1.1. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan TLSv1.1 como versión del protocolo. Disponible sólo con openssl en versión 1.0.1+.


Added in version 3.4.



Obsoleto desde la versión 3.7: Esta opción es obsoleta desde OpenSSL 1.1.0.

@end deffn

@geindex OP_NO_TLSv1_2 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_2}@anchor{33b8}
@deffn {Dato} ssl.OP_NO_TLSv1_2

Evita una conexión TLSv1.2. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan TLSv1.2 como versión del protocolo. Disponible sólo con openssl en versión 1.0.1+.


Added in version 3.4.



Obsoleto desde la versión 3.7: Esta opción es obsoleta desde OpenSSL 1.1.0.

@end deffn

@geindex OP_NO_TLSv1_3 (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_3}@anchor{18af}
@deffn {Dato} ssl.OP_NO_TLSv1_3

Evita una conexión TLSv1.3. Esta opción sólo es aplicable junto con @ref{339e,,PROTOCOL_TLS}. Evita que los pares elijan TLSv1.3 como versión del protocolo. TLS 1.3 está disponible con OpenSSL 1.1.1 o superior. Cuando Python es compilado contra una versión mas antigua de OpenSSL, la opción vale `0' por defecto.


Added in version 3.6.3.



Obsoleto desde la versión 3.7: The option is deprecated since OpenSSL 1.1.0. It was added to 2.7.15 and
3.6.3 for backwards compatibility with OpenSSL 1.0.2.

@end deffn

@geindex OP_NO_RENEGOTIATION (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_RENEGOTIATION}@anchor{33b9}
@deffn {Dato} ssl.OP_NO_RENEGOTIATION

Desactiva toda re-negociación en TLSv1.2 y anteriores. No envía mensajes HelloRequest e ignora solicitudes de re-negociación vía ClientHello.

Esta opción sólo está disponible con OpenSSL 1.1.0h y posteriores.


Added in version 3.7.

@end deffn

@geindex OP_CIPHER_SERVER_PREFERENCE (en el módulo ssl)
@anchor{library/ssl ssl OP_CIPHER_SERVER_PREFERENCE}@anchor{11ba}
@deffn {Dato} ssl.OP_CIPHER_SERVER_PREFERENCE

Utiliza la preferencia de ordenación de cifrado del servidor, en lugar de la del cliente. Esta opción no tiene efecto en los sockets del cliente ni en los sockets del servidor SSLv2.


Added in version 3.3.

@end deffn

@geindex OP_SINGLE_DH_USE (en el módulo ssl)
@anchor{library/ssl ssl OP_SINGLE_DH_USE}@anchor{33ba}
@deffn {Dato} ssl.OP_SINGLE_DH_USE

Prevents reuse of the same DH key for distinct SSL sessions.  This
improves forward secrecy but requires more computational resources.
This option only applies to server sockets.


Added in version 3.3.

@end deffn

@geindex OP_SINGLE_ECDH_USE (en el módulo ssl)
@anchor{library/ssl ssl OP_SINGLE_ECDH_USE}@anchor{33bb}
@deffn {Dato} ssl.OP_SINGLE_ECDH_USE

Prevents reuse of the same ECDH key for distinct SSL sessions.  This
improves forward secrecy but requires more computational resources.
This option only applies to server sockets.


Added in version 3.3.

@end deffn

@geindex OP_ENABLE_MIDDLEBOX_COMPAT (en el módulo ssl)
@anchor{library/ssl ssl OP_ENABLE_MIDDLEBOX_COMPAT}@anchor{33bc}
@deffn {Dato} ssl.OP_ENABLE_MIDDLEBOX_COMPAT

Enviar mensajes Change Cipher Spec (CCS) ficticios en el handshake de TLS 1.3 para que una conexión TLS 1.3 se parezca más a una conexión TLS 1.2.

Esta opción sólo está disponible con OpenSSL 1.1.1 y posteriores.


Added in version 3.8.

@end deffn

@geindex OP_NO_COMPRESSION (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_COMPRESSION}@anchor{11b7}
@deffn {Dato} ssl.OP_NO_COMPRESSION

Desactivar la compresión en el canal SSL. Esto es útil si el protocolo de la aplicación soporta su propio esquema de compresión.


Added in version 3.3.

@end deffn

@geindex Options (clase en ssl)
@anchor{library/ssl ssl Options}@anchor{33bd}
@deffn {Clase} ssl.Options

Colección @ref{22fd,,enum.IntFlag} de constantes OP_*.
@end deffn

@geindex OP_NO_TICKET (en el módulo ssl)
@anchor{library/ssl ssl OP_NO_TICKET}@anchor{33be}
@deffn {Dato} ssl.OP_NO_TICKET

Evita que el lado del cliente solicite un ticket de sesión.


Added in version 3.6.

@end deffn

@geindex OP_IGNORE_UNEXPECTED_EOF (en el módulo ssl)
@anchor{library/ssl ssl OP_IGNORE_UNEXPECTED_EOF}@anchor{8ce}
@deffn {Dato} ssl.OP_IGNORE_UNEXPECTED_EOF

Ignore el cierre inesperado de las conexiones TLS.

Esta opción sólo está disponible con OpenSSL 1.0.0 y posteriores.


Added in version 3.10.

@end deffn

@geindex OP_ENABLE_KTLS (en el módulo ssl)
@anchor{library/ssl ssl OP_ENABLE_KTLS}@anchor{179f}
@deffn {Dato} ssl.OP_ENABLE_KTLS

Enable the use of the kernel TLS. To benefit from the feature, OpenSSL must
have been compiled with support for it, and the negotiated cipher suites and
extensions must be supported by it (a list of supported ones may vary by
platform and kernel version).

Note that with enabled kernel TLS some cryptographic operations are
performed by the kernel directly and not via any available OpenSSL
Providers. This might be undesirable if, for example, the application
requires all cryptographic operations to be performed by the FIPS provider.

Esta opción sólo está disponible con OpenSSL 1.0.0 y posteriores.


Added in version 3.12.

@end deffn

@geindex OP_LEGACY_SERVER_CONNECT (en el módulo ssl)
@anchor{library/ssl ssl OP_LEGACY_SERVER_CONNECT}@anchor{1785}
@deffn {Dato} ssl.OP_LEGACY_SERVER_CONNECT

Allow legacy insecure renegotiation between OpenSSL and unpatched servers
only.


Added in version 3.12.

@end deffn

@geindex HAS_ALPN (en el módulo ssl)
@anchor{library/ssl ssl HAS_ALPN}@anchor{ee6}
@deffn {Dato} ssl.HAS_ALPN

Si la biblioteca OpenSSL tiene soporte incorporado para la extensión TLS `Application-Layer Protocol Negotiation' como se describe en 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}.


Added in version 3.5.

@end deffn

@geindex HAS_NEVER_CHECK_COMMON_NAME (en el módulo ssl)
@anchor{library/ssl ssl HAS_NEVER_CHECK_COMMON_NAME}@anchor{33bf}
@deffn {Dato} ssl.HAS_NEVER_CHECK_COMMON_NAME

Si la biblioteca OpenSSL tiene soporte incorporado para no comprobar el nombre común del sujeto y @ref{c05,,SSLContext.hostname_checks_common_name} es modificable.


Added in version 3.7.

@end deffn

@geindex HAS_ECDH (en el módulo ssl)
@anchor{library/ssl ssl HAS_ECDH}@anchor{33c0}
@deffn {Dato} ssl.HAS_ECDH

Si la biblioteca OpenSSL tiene soporte incorporado para el intercambio de claves Diffie-Hellman basado en Elliptic Curve. Esto debería ser cierto a menos que la función haya sido desactivada explícitamente por el distribuidor.


Added in version 3.3.

@end deffn

@geindex HAS_SNI (en el módulo ssl)
@anchor{library/ssl ssl HAS_SNI}@anchor{33c1}
@deffn {Dato} ssl.HAS_SNI

Si la biblioteca OpenSSL tiene soporte incorporado para la extensión `Server Name Indication' (como se define en 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html}).


Added in version 3.2.

@end deffn

@geindex HAS_NPN (en el módulo ssl)
@anchor{library/ssl ssl HAS_NPN}@anchor{33c2}
@deffn {Dato} ssl.HAS_NPN

Si la biblioteca OpenSSL tiene soporte incorporado para `Next Protocol Negotiation' como se describe en Application Layer Protocol Negotiation@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation}. Cuando es verdadero, puede utilizar el método @ref{1fb,,SSLContext.set_npn_protocols()} para anunciar los protocolos que desea soportar.


Added in version 3.3.

@end deffn

@geindex HAS_SSLv2 (en el módulo ssl)
@anchor{library/ssl ssl HAS_SSLv2}@anchor{33c3}
@deffn {Dato} ssl.HAS_SSLv2

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo SSL 2.0.


Added in version 3.7.

@end deffn

@geindex HAS_SSLv3 (en el módulo ssl)
@anchor{library/ssl ssl HAS_SSLv3}@anchor{33c4}
@deffn {Dato} ssl.HAS_SSLv3

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo SSL 3.0.


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1 (en el módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1}@anchor{33c5}
@deffn {Dato} ssl.HAS_TLSv1

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo TLS 1.0.


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_1 (en el módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_1}@anchor{c0b}
@deffn {Dato} ssl.HAS_TLSv1_1

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo TLS 1.1.


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_2 (en el módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_2}@anchor{33c6}
@deffn {Dato} ssl.HAS_TLSv1_2

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo TLS 1.2.


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_3 (en el módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_3}@anchor{33c7}
@deffn {Dato} ssl.HAS_TLSv1_3

Si la biblioteca OpenSSL tiene soporte incorporado para el protocolo TLS 1.3.


Added in version 3.7.

@end deffn

@geindex HAS_PSK (en el módulo ssl)
@anchor{library/ssl ssl HAS_PSK}@anchor{33c8}
@deffn {Dato} ssl.HAS_PSK

Whether the OpenSSL library has built-in support for TLS-PSK.


Added in version 3.13.

@end deffn

@geindex CHANNEL_BINDING_TYPES (en el módulo ssl)
@anchor{library/ssl ssl CHANNEL_BINDING_TYPES}@anchor{33c9}
@deffn {Dato} ssl.CHANNEL_BINDING_TYPES

Lista de tipos de enlace de canales TLS admitidos. Las cadenas de caracteres en esta lista pueden ser usadas como argumentos para @ref{11b5,,SSLSocket.get_channel_binding()}.


Added in version 3.3.

@end deffn

@geindex OPENSSL_VERSION (en el módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION}@anchor{128b}
@deffn {Dato} ssl.OPENSSL_VERSION

La cadena de versión de la biblioteca OpenSSL cargada por el intérprete:

@example
>>> ssl.OPENSSL_VERSION
'OpenSSL 1.0.2k  26 Jan 2017'
@end example


Added in version 3.2.

@end deffn

@geindex OPENSSL_VERSION_INFO (en el módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION_INFO}@anchor{128c}
@deffn {Dato} ssl.OPENSSL_VERSION_INFO

Una tupla de cinco números enteros representando la información de versión de la biblioteca OpenSSL:

@example
>>> ssl.OPENSSL_VERSION_INFO
(1, 0, 2, 11, 15)
@end example


Added in version 3.2.

@end deffn

@geindex OPENSSL_VERSION_NUMBER (en el módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION_NUMBER}@anchor{128d}
@deffn {Dato} ssl.OPENSSL_VERSION_NUMBER

El número de versión en bruto de la biblioteca OpenSSL, como un único número entero:

@example
>>> ssl.OPENSSL_VERSION_NUMBER
268443839
>>> hex(ssl.OPENSSL_VERSION_NUMBER)
'0x100020bf'
@end example


Added in version 3.2.

@end deffn

@geindex ALERT_DESCRIPTION_HANDSHAKE_FAILURE (en el módulo ssl)
@geindex ALERT_DESCRIPTION_INTERNAL_ERROR (en el módulo ssl)
@anchor{library/ssl ssl ALERT_DESCRIPTION_HANDSHAKE_FAILURE}@anchor{33ca}
@deffn {Dato} ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE
@anchor{library/ssl ssl ALERT_DESCRIPTION_INTERNAL_ERROR}@anchor{33cb}
@deffnx {Dato} ssl.ALERT_DESCRIPTION_INTERNAL_ERROR

@deffnx {Dato} ALERT_DESCRIPTION_*

Descripciones de alertas de 
@geindex RFC; RFC 5246
RFC 5246@footnote{https://datatracker.ietf.org/doc/html/rfc5246.html} y otras. El IANA TLS Alert Registry@footnote{https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6} contiene esta lista y las referencias a las RFC donde se define su significado.

Se utiliza como valor de retorno de la función callback en @ref{1035,,SSLContext.set_servername_callback()}.


Added in version 3.4.

@end deffn

@geindex AlertDescription (clase en ssl)
@anchor{library/ssl ssl AlertDescription}@anchor{33cc}
@deffn {Clase} ssl.AlertDescription

Colección @ref{d66,,enum.IntEnum} de constantes ALERT_DESCRIPTION_*.


Added in version 3.6.

@end deffn

@geindex Purpose.SERVER_AUTH (en el módulo ssl)
@anchor{library/ssl ssl Purpose SERVER_AUTH}@anchor{1031}
@deffn {Dato} Purpose.SERVER_AUTH

Opción para @ref{2c1,,create_default_context()} y @ref{1030,,SSLContext.load_default_certs()}. Este valor indica que el contexto puede utilizarse para autenticar servidores web (por lo tanto, se utilizará para crear sockets del lado del cliente).


Added in version 3.4.

@end deffn

@geindex Purpose.CLIENT_AUTH (en el módulo ssl)
@anchor{library/ssl ssl Purpose CLIENT_AUTH}@anchor{1032}
@deffn {Dato} Purpose.CLIENT_AUTH

Opción para @ref{2c1,,create_default_context()} y @ref{1030,,SSLContext.load_default_certs()}. Este valor indica que el contexto puede utilizarse para autenticar clientes web (por lo tanto, se utilizará para crear sockets del lado del servidor).


Added in version 3.4.

@end deffn

@geindex SSLErrorNumber (clase en ssl)
@anchor{library/ssl ssl SSLErrorNumber}@anchor{33cd}
@deffn {Clase} ssl.SSLErrorNumber

Colección @ref{d66,,enum.IntEnum} de constantes SSL_ERROR_*.


Added in version 3.6.

@end deffn

@geindex TLSVersion (clase en ssl)
@anchor{library/ssl ssl TLSVersion}@anchor{33ce}
@deffn {Clase} ssl.TLSVersion

Colección @ref{d66,,enum.IntEnum} de versiones SSL y TLS para @ref{908,,SSLContext.maximum_version} y @ref{907,,SSLContext.minimum_version}.


Added in version 3.7.

@end deffn

@geindex MINIMUM_SUPPORTED (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion MINIMUM_SUPPORTED}@anchor{33cf}
@deffn {Atributo} TLSVersion.MINIMUM_SUPPORTED
@end deffn

@geindex MAXIMUM_SUPPORTED (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion MAXIMUM_SUPPORTED}@anchor{33d0}
@deffn {Atributo} TLSVersion.MAXIMUM_SUPPORTED

La mínima o máxima versión soportada de SSL o TLS. Estas son constantes mágicas. Sus valores no reflejan la mas baja o mas alta versión TLS/SSL disponible.
@end deffn

@geindex SSLv3 (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion SSLv3}@anchor{33d1}
@deffn {Atributo} TLSVersion.SSLv3
@end deffn

@geindex TLSv1 (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1}@anchor{33d2}
@deffn {Atributo} TLSVersion.TLSv1
@end deffn

@geindex TLSv1_1 (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_1}@anchor{33d3}
@deffn {Atributo} TLSVersion.TLSv1_1
@end deffn

@geindex TLSv1_2 (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_2}@anchor{33d4}
@deffn {Atributo} TLSVersion.TLSv1_2
@end deffn

@geindex TLSv1_3 (atributo de ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_3}@anchor{33d5}
@deffn {Atributo} TLSVersion.TLSv1_3

SSL 3.0 a TLS 1.3.


Obsoleto desde la versión 3.10: Todos los miembros de @ref{33ce,,TLSVersion}, excepto @ref{33d4,,TLSVersion.TLSv1_2} y @ref{33d5,,TLSVersion.TLSv1_3}, están en desuso.

@end deffn

@node Sockets SSL,Contextos SSL,Funciones constantes y excepciones,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl ssl-sockets}@anchor{33d6}
@subsubsection Sockets SSL


@geindex SSLSocket (clase en ssl)
@anchor{library/ssl ssl SSLSocket}@anchor{981}
@deffn {Clase} ssl.SSLSocket (socket.socket)

Los sockets SSL proporcionan los siguientes métodos de @ref{337c,,Objetos Socket}:


@itemize -

@item 
@ref{e28,,accept()}

@item 
@ref{157a,,bind()}

@item 
@ref{dca,,close()}

@item 
@ref{e29,,connect()}

@item 
@ref{1289,,detach()}

@item 
@ref{338a,,fileno()}

@item 
@ref{32d5,,getpeername()}, @ref{32d6,,getsockname()}

@item 
@ref{d5c,,getsockopt()}, @ref{d5d,,setsockopt()}

@item 
@ref{338b,,gettimeout()}, @ref{3349,,settimeout()},
@ref{2b41,,setblocking()}

@item 
@ref{ede,,listen()}

@item 
@ref{120e,,makefile()}

@item 
@ref{e2a,,recv()}, @ref{1385,,recv_into()}
(but passing a non-zero @code{flags} argument is not allowed)

@item 
@ref{e2d,,send()}, @ref{e2e,,sendall()} (with
the same limitation)

@item 
@ref{edd,,sendfile()} (but @ref{b9a,,os.sendfile} will be used
for plain-text sockets only, else @ref{e2d,,send()} will be used)

@item 
@ref{3379,,shutdown()}
@end itemize

Sin embargo, dado que el protocolo SSL (y TLS) tiene su propia estructura encima de TCP, la abstracción de los sockets SSL puede, en ciertos aspectos, divergir de la especificación de los sockets normales a nivel de SO. Ver especialmente las @ref{33a1,,notas sobre sockets no bloqueantes}.

Instancias de @ref{981,,SSLSocket} deben ser creadas usando el método @ref{5c8,,SSLContext.wrap_socket()}.


Distinto en la versión 3.5: El método @code{sendfile()} ha sido agregado.



Distinto en la versión 3.5: The @code{shutdown()} does not reset the socket timeout each time bytes
are received or sent. The socket timeout is now the maximum total duration
of the shutdown.



Obsoleto desde la versión 3.6: Crear una instancia de @ref{981,,SSLSocket} directamente es obsoleto, utilice @ref{5c8,,SSLContext.wrap_socket()} para envolver un socket.



Distinto en la versión 3.7: Las instancias de @ref{981,,SSLSocket} deben crearse con @ref{5c8,,wrap_socket()}. En versiones anteriores, era posible crear instancias directamente. Esto nunca fue documentado ni soportado oficialmente.



Distinto en la versión 3.10: Python ahora usa @code{SSL_read_ex} y @code{SSL_write_ex} internamente. Las funciones admiten la lectura y escritura de datos de más de 2 GB. La escritura de datos de longitud cero ya no falla con un error de violación de protocolo.

@end deffn

Los sockets SSL tienen también los siguientes métodos y atributos adicionales:

@geindex read() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket read}@anchor{eee}
@deffn {Método} SSLSocket.read (len=1024, buffer=None)

Lee hasta `len' bytes de datos del socket SSL y retorna el resultado como una instancia @code{bytes}. Si `buffer' es especificado, entonces se lee hacia el búfer en su lugar, y retorna el número de bytes leídos.

Lanza @ref{ee9,,SSLWantReadError} o @ref{eea,,SSLWantWriteError} si el socket es @ref{33a1,,no-bloqueante} y la lectura se bloquearía.

Como en cualquier momento es posible una re-negociación, una llamada a @ref{eee,,read()} también puede provocar operaciones de escritura.


Distinto en la versión 3.5: The socket timeout is no longer reset each time bytes are received or sent.
The socket timeout is now the maximum total duration to read up to `len'
bytes.



Obsoleto desde la versión 3.6: Utilice @code{recv()} en lugar de @ref{eee,,read()}.

@end deffn

@geindex write() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket write}@anchor{eef}
@deffn {Método} SSLSocket.write (buf)

Escribe `buf' en el socket SSL y retorna el número de bytes escritos. El argumento `buf' debe ser un objeto que soporte la interfaz búfer.

Lanza @ref{ee9,,SSLWantReadError} o @ref{eea,,SSLWantWriteError} si el socket es @ref{33a1,,no-bloqueante} y la escritura se bloquearía.

Como en cualquier momento es posible una re-negociación, una llamada a @ref{eef,,write()} también puede provocar operaciones de lectura.


Distinto en la versión 3.5: The socket timeout is no longer reset each time bytes are received or sent.
The socket timeout is now the maximum total duration to write `buf'.



Obsoleto desde la versión 3.6: Utilice @code{send()} en lugar de @ref{eef,,write()}.

@end deffn

@cartouche
@quotation Nota 
Los métodos @ref{eee,,read()} y @ref{eef,,write()} son los métodos de bajo nivel que leen y escriben datos no cifrados a nivel de aplicación y los descifran/cifran a datos cifrados a nivel de cable. Estos métodos requieren una conexión SSL activa, es decir, que se haya completado el handshake y no se haya llamado a @ref{33d7,,SSLSocket.unwrap()}.

Normalmente se deberían utilizar los métodos de la API de sockets como @ref{e2a,,recv()} y @ref{e2d,,send()} en lugar de estos métodos.
@end quotation
@end cartouche

@geindex do_handshake() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket do_handshake}@anchor{eed}
@deffn {Método} SSLSocket.do_handshake ()

Realiza el handshake de configuración SSL.


Distinto en la versión 3.4: El método handshake también realiza @code{match_hostname()} cuando el atributo @ref{33af,,check_hostname} del @ref{33d8,,context} del socket es verdadero.



Distinto en la versión 3.5: The socket timeout is no longer reset each time bytes are received or sent.
The socket timeout is now the maximum total duration of the handshake.



Distinto en la versión 3.7: Hostname or IP address is matched by OpenSSL during handshake. The
function @code{match_hostname()} is no longer used. In case OpenSSL
refuses a hostname or IP address, the handshake is aborted early and
a TLS alert message is sent to the peer.

@end deffn

@geindex getpeercert() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket getpeercert}@anchor{1036}
@deffn {Método} SSLSocket.getpeercert (binary_form=False)

Si no hay un certificado para el peer en el otro extremo de la conexión, retorna @code{None}. Si el handshake SSL no se ha realizado todavía, lanza @ref{360,,ValueError}.

Si el parámetro @code{binary_form} es @ref{bbf,,False}, y se ha recibido un certificado del peer, este método retorna una instancia @ref{190,,dict}. Si el certificado no fue validado, el dict está vacío. Si el certificado fue validado, retorna un dict con varias claves, entre ellas @code{subject} (la entidad para la que se emitió el certificado) y @code{issuer} (la entidad que emite el certificado). Si un certificado contiene una instancia de la extensión `Subject Alternative Name' (véase 
@geindex RFC; RFC 3280
RFC 3280@footnote{https://datatracker.ietf.org/doc/html/rfc3280.html}), también habrá una clave @code{subjectAltName} en el diccionario.

Los campos @code{subject} y @code{issuer} son tuplas que contienen la secuencia de nombres distinguidos relativos (RDNs) indicados en la estructura de datos del certificado para los campos respectivos, y cada RDN es una secuencia de pares nombre-valor. Este es un ejemplo del mundo real:

@example
@{'issuer': ((('countryName', 'IL'),),
            (('organizationName', 'StartCom Ltd.'),),
            (('organizationalUnitName',
              'Secure Digital Certificate Signing'),),
            (('commonName',
              'StartCom Class 2 Primary Intermediate Server CA'),)),
 'notAfter': 'Nov 22 08:15:19 2013 GMT',
 'notBefore': 'Nov 21 03:09:52 2011 GMT',
 'serialNumber': '95F0',
 'subject': ((('description', '571208-SLe257oHY9fVQ07Z'),),
             (('countryName', 'US'),),
             (('stateOrProvinceName', 'California'),),
             (('localityName', 'San Francisco'),),
             (('organizationName', 'Electronic Frontier Foundation, Inc.'),),
             (('commonName', '*.eff.org'),),
             (('emailAddress', 'hostmaster@@eff.org'),)),
 'subjectAltName': (('DNS', '*.eff.org'), ('DNS', 'eff.org')),
 'version': 3@}
@end example

Si el parámetro @code{binary_form} es @ref{c95,,True}, y se proporcionó un certificado, este método retorna la forma codificada en DER del certificado completo como una secuencia de bytes, o @ref{716,,None} si el par no proporcionó un certificado. El hecho de que el par proporcione un certificado depende del rol del socket SSL:


@itemize *

@item 
para un socket SSL cliente, el servidor siempre proporcionará un certificado, independientemente de si se requirió la validación;

@item 
para un socket SSL servidor, el cliente sólo proporcionará un certificado cuando lo solicite el servidor; por lo tanto @ref{1036,,getpeercert()} devolverá @ref{716,,None} si ha utilizado @ref{33ad,,CERT_NONE} (en lugar de @ref{33ae,,CERT_OPTIONAL} o @code{CERT REQUIRED}).
@end itemize

See also @ref{33af,,SSLContext.check_hostname}.


Distinto en la versión 3.2: El diccionario retornado incluye elementos adicionales tales como @code{issuer} y @code{notBefore}.



Distinto en la versión 3.4: @ref{360,,ValueError} se lanza cuando no se realiza el handshake. El diccionario retornado incluye elementos de extensión X509v3 adicionales como @code{crlDistributionPoints}, @code{caIssuers} y @code{OCSP} URIs.



Distinto en la versión 3.9: Las cadenas de direcciones IPv6 ya no tienen una nueva línea al final.

@end deffn

@geindex get_verified_chain() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_verified_chain}@anchor{15f9}
@deffn {Método} SSLSocket.get_verified_chain ()

Returns verified certificate chain provided by the other
end of the SSL channel as a list of DER-encoded bytes.
If certificate verification was disabled method acts the same as
@ref{15fa,,get_unverified_chain()}.


Added in version 3.13.

@end deffn

@geindex get_unverified_chain() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_unverified_chain}@anchor{15fa}
@deffn {Método} SSLSocket.get_unverified_chain ()

Returns raw certificate chain provided by the other
end of the SSL channel as a list of DER-encoded bytes.


Added in version 3.13.

@end deffn

@geindex cipher() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket cipher}@anchor{32d7}
@deffn {Método} SSLSocket.cipher ()

Retorna una tupla de tres valores que contiene el nombre del cifrado que se está utilizando, la versión del protocolo SSL que define su uso y el número de bits secretos que se están utilizando. Si no se ha establecido ninguna conexión, retorna @code{None}.
@end deffn

@geindex shared_ciphers() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket shared_ciphers}@anchor{eec}
@deffn {Método} SSLSocket.shared_ciphers ()

Return the list of ciphers available in both the client and server.  Each
entry of the returned list is a three-value tuple containing the name of the
cipher, the version of the SSL protocol that defines its use, and the number
of secret bits the cipher uses.  @ref{eec,,shared_ciphers()} returns
@code{None} if no connection has been established or the socket is a client
socket.


Added in version 3.5.

@end deffn

@geindex compression() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket compression}@anchor{11b6}
@deffn {Método} SSLSocket.compression ()

Retorna el algoritmo de compresión utilizado como una cadena de caracteres, o @code{None} si la conexión no está comprimida.

Si el protocolo de nivel superior soporta su propio mecanismo de compresión, puede utilizar @ref{11b7,,OP_NO_COMPRESSION} para desactivar la compresión a nivel de SSL.


Added in version 3.3.

@end deffn

@geindex get_channel_binding() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_channel_binding}@anchor{11b5}
@deffn {Método} SSLSocket.get_channel_binding (cb_type='tls-unique')

Obtiene los datos de enlace del canal para la conexión actual, como un objeto bytes. Retorna @code{None} si no está conectado o no se ha completado el handshake.

El parámetro `cb_type' permite seleccionar el tipo de enlace de canal deseado. Los tipos de enlace de canal válidos se enumeran en la lista @ref{33c9,,CHANNEL_BINDING_TYPES}. Actualmente, sólo se admite la vinculación de canal “tls-unique”, definida por 
@geindex RFC; RFC 5929
RFC 5929@footnote{https://datatracker.ietf.org/doc/html/rfc5929.html}. @ref{360,,ValueError} se lanzará si se solicita un tipo de vinculación de canal no admitido.


Added in version 3.3.

@end deffn

@geindex selected_alpn_protocol() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket selected_alpn_protocol}@anchor{ee5}
@deffn {Método} SSLSocket.selected_alpn_protocol ()

Retorna el protocolo que fue seleccionado durante el handshake TLS. Si no se ha llamado a @ref{ee4,,SSLContext.set_alpn_protocols()}, si la otra parte no soporta ALPN, si este socket no soporta ninguno de los protocolos propuestos por el cliente, o si el handshake no ha ocurrido todavía, se retorna @code{None}.


Added in version 3.5.

@end deffn

@geindex selected_npn_protocol() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket selected_npn_protocol}@anchor{90b}
@deffn {Método} SSLSocket.selected_npn_protocol ()

Retorna el protocolo de nivel superior que se seleccionó durante el handshake TLS/SSL. Si no se llamó a @ref{1fb,,SSLContext.set_npn_protocols()}, o si la otra parte no soporta NPN, o si el handshake aún no ha ocurrido, esto devolverá @code{None}.


Added in version 3.3.



Obsoleto desde la versión 3.10: NPN ha sido reemplazada por ALPN

@end deffn

@geindex unwrap() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket unwrap}@anchor{33d7}
@deffn {Método} SSLSocket.unwrap ()

Realiza el handshake de cierre de SSL, que elimina la capa TLS del socket subyacente, y retorna el objeto socket subyacente. Esto puede utilizarse para pasar de una operación encriptada sobre una conexión a una sin encriptar. El socket retornado debe utilizarse siempre para la comunicación posterior con el otro lado de la conexión, en lugar del socket original.
@end deffn

@geindex verify_client_post_handshake() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket verify_client_post_handshake}@anchor{ac4}
@deffn {Método} SSLSocket.verify_client_post_handshake ()

Solicita la autenticación post-handshake (PHA) de un cliente TLS 1.3. PHA sólo puede iniciarse para una conexión TLS 1.3 desde un socket del lado del servidor, después del handshake TLS inicial y con PHA habilitado en ambos lados, ver @ref{ac3,,SSLContext.post_handshake_auth}.

El método no realiza un intercambio de certificados inmediatamente. El lado del servidor envía una CertificateRequest durante el siguiente evento de escritura y espera que el cliente responda con un certificado en el siguiente evento de lectura.

Si alguna precondición no se cumple (por ejemplo, no es TLS 1.3, PHA no está habilitado), se genera un @ref{12e7,,SSLError}.

@cartouche
@quotation Nota 
Sólo está disponible con OpenSSL 1.1.1 y TLS 1.3 habilitados. Sin el soporte de TLS 1.3, el método lanza @ref{384,,NotImplementedError}.
@end quotation
@end cartouche


Added in version 3.8.

@end deffn

@geindex version() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket version}@anchor{ee8}
@deffn {Método} SSLSocket.version ()

Retorna la versión real del protocolo SSL negociada por la conexión como una cadena, o @code{None} si no se establece una conexión segura. Al momento de escribir, los posibles valores de retorno incluyen @code{"SSLv2"}, @code{"SSLv3"}, @code{"TLSv1"}, @code{"TLSv1.1"} y @code{"TLSv1.2"}. Las versiones recientes de OpenSSL pueden definir más valores de retorno.


Added in version 3.5.

@end deffn

@geindex pending() (método de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket pending}@anchor{33d9}
@deffn {Método} SSLSocket.pending ()

Retorna el número de bytes ya descifrados disponibles para leer, pendientes de la conexión.
@end deffn

@geindex context (atributo de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket context}@anchor{33d8}
@deffn {Atributo} SSLSocket.context

The @ref{1fa,,SSLContext} object this SSL socket is tied to.


Added in version 3.2.

@end deffn

@geindex server_side (atributo de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket server_side}@anchor{33da}
@deffn {Atributo} SSLSocket.server_side

Un booleano que es @code{True} para los sockets del lado del servidor y @code{False} para los sockets del lado del cliente.


Added in version 3.2.

@end deffn

@geindex server_hostname (atributo de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket server_hostname}@anchor{c07}
@deffn {Atributo} SSLSocket.server_hostname

Hostname del servidor: tipo @ref{237,,str}, o @code{None} para el socket del lado del servidor o si el hostname no fue especificado en el constructor.


Added in version 3.2.



Distinto en la versión 3.7: El atributo es ahora siempre texto ASCII. Cuando @code{server_hostname} es un nombre de dominio internacionalizado (IDN), este atributo almacena ahora la forma de etiqueta A (@code{"xn--pythn-mua.org"}), en lugar de la forma de etiqueta U (@code{"pythön.org"}).

@end deffn

@geindex session (atributo de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket session}@anchor{15d4}
@deffn {Atributo} SSLSocket.session

La @ref{d64,,SSLSession} para esta conexión SSL. La sesión está disponible para los sockets del lado del cliente y del servidor después de que se haya realizado el handshake TLS. Para los sockets del cliente la sesión puede ser establecida antes de que @ref{eed,,do_handshake()} haya sido llamado para reutilizar una sesión.


Added in version 3.6.

@end deffn

@geindex session_reused (atributo de ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket session_reused}@anchor{33db}
@deffn {Atributo} SSLSocket.session_reused


Added in version 3.6.

@end deffn

@node Contextos SSL,Certificados,Sockets SSL,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl ssl-contexts}@anchor{33dc}
@subsubsection Contextos SSL



Added in version 3.2.


Un contexto SSL contiene varios datos más duraderos que las conexiones SSL individuales, como opciones de configuración SSL, certificado(s) y clave(s) privada(s). También gestiona un cache de sesiones SSL para sockets del lado del servidor, para acelerar conexiones repetidas de los mismos clientes.

@geindex SSLContext (clase en ssl)
@anchor{library/ssl ssl SSLContext}@anchor{1fa}
@deffn {Clase} ssl.SSLContext (protocol=None)

Crea un nuevo contexto SSL. Puede pasar `protocolo' que debe ser una de las constantes @code{PROTOCOL_*} definidas en este módulo. El parámetro especifica la versión del protocolo SSL a utilizar. Típicamente, el servidor elige una versión particular del protocolo, y el cliente debe adaptarse a la elección del servidor. La mayoría de las versiones no son interoperables con las demás. Si no se especifica, el valor por defecto es @ref{339e,,PROTOCOL_TLS}; proporciona la mayor compatibilidad con otras versiones.

Esta es una tabla que muestra qué versiones de un cliente (en la parte inferior) pueden conectarse a qué versiones de un servidor (en la parte superior):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@item

`cliente' / `servidor'

@tab

`SSLv2'

@tab

`SSLv3'

@tab

`TLS' @footnote{
El protocolo TLS 1.3 estará disponible con @ref{339e,,PROTOCOL_TLS} en OpenSSL >= 1.1.1. No existe una constante PROTOCOL dedicada sólo a TLS 1.3.
}

@tab

`TLSv1'

@tab

`TLSv1.1'

@tab

`TLSv1.2'

@item

`SSLv2'

@tab

si

@tab

no

@tab

no @footnote{
@ref{1fa,,SSLContext} desactiva SSLv2 con @ref{8d0,,OP_NO_SSLv2} por defecto.
}

@tab

no

@tab

no

@tab

no

@item

`SSLv3'

@tab

no

@tab

si

@tab

no @footnote{
@ref{1fa,,SSLContext} desactiva SSLv3 con @ref{8d1,,OP_NO_SSLv3} por defecto.
}

@tab

no

@tab

no

@tab

no

@item

`TLS' (`SSLv23') @footnote{
El protocolo TLS 1.3 estará disponible con @ref{339e,,PROTOCOL_TLS} en OpenSSL >= 1.1.1. No existe una constante PROTOCOL dedicada sólo a TLS 1.3.
}

@tab

no @footnote{
@ref{1fa,,SSLContext} desactiva SSLv2 con @ref{8d0,,OP_NO_SSLv2} por defecto.
}

@tab

no @footnote{
@ref{1fa,,SSLContext} desactiva SSLv3 con @ref{8d1,,OP_NO_SSLv3} por defecto.
}

@tab

si

@tab

si

@tab

si

@tab

si

@item

`TLSv1'

@tab

no

@tab

no

@tab

si

@tab

si

@tab

no

@tab

no

@item

`TLSv1.1'

@tab

no

@tab

no

@tab

si

@tab

no

@tab

si

@tab

no

@item

`TLSv1.2'

@tab

no

@tab

no

@tab

si

@tab

no

@tab

no

@tab

si

@end multitable



@subsubheading Ver también


@ref{2c1,,create_default_context()} permite al módulo @ref{d0,,ssl} elegir la configuración de seguridad para un propósito determinado.



Distinto en la versión 3.6: The context is created with secure default values. The options
@ref{11b7,,OP_NO_COMPRESSION}, @ref{11ba,,OP_CIPHER_SERVER_PREFERENCE},
@ref{33ba,,OP_SINGLE_DH_USE}, @ref{33bb,,OP_SINGLE_ECDH_USE},
@ref{8d0,,OP_NO_SSLv2},
and @ref{8d1,,OP_NO_SSLv3} (except for @ref{33a9,,PROTOCOL_SSLv3}) are
set by default. The initial cipher suite list contains only @code{HIGH}
ciphers, no @code{NULL} ciphers and no @code{MD5} ciphers.



Obsoleto desde la versión 3.10: @ref{1fa,,SSLContext} sin argumento de protocolo está en desuso. La clase de contexto requerirá el protocolo @ref{909,,PROTOCOL_TLS_CLIENT} o @ref{90a,,PROTOCOL_TLS_SERVER} en el futuro.



Distinto en la versión 3.10: Los conjuntos de cifrado predeterminados ahora incluyen solo cifrados AES y ChaCha20 seguros con secreto directo y nivel de seguridad 2. Están prohibidas las claves RSA y DH con menos de 2048 bits y las claves ECC con menos de 224 bits. @ref{339e,,PROTOCOL_TLS}, @ref{909,,PROTOCOL_TLS_CLIENT} y @ref{90a,,PROTOCOL_TLS_SERVER} usan TLS 1.2 como versión mínima de TLS.


@cartouche
@quotation Nota 
@ref{1fa,,SSLContext} only supports limited mutation once it has been used
by a connection. Adding new certificates to the internal trust store is
allowed, but changing ciphers, verification settings, or mTLS
certificates may result in surprising behavior.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@ref{1fa,,SSLContext} is designed to be shared and used by multiple
connections.
Thus, it is thread-safe as long as it is not reconfigured after being
used by a connection.
@end quotation
@end cartouche
@end deffn

Los objetos @ref{1fa,,SSLContext} tienen los siguientes métodos y atributos:

@geindex cert_store_stats() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext cert_store_stats}@anchor{102a}
@deffn {Método} SSLContext.cert_store_stats ()

Obtiene estadísticas sobre las cantidades de certificados X.509 cargados, la cantidad de certificados X.509 marcados como certificados CA y las listas de revocación de certificados como diccionario.

Ejemplo para un contexto con un certificado CA y otro certificado:

@example
>>> context.cert_store_stats()
@{'crl': 0, 'x509_ca': 1, 'x509': 2@}
@end example


Added in version 3.4.

@end deffn

@geindex load_cert_chain() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_cert_chain}@anchor{3e7}
@deffn {Método} SSLContext.load_cert_chain (certfile, keyfile=None, password=None)

Carga una clave privada y el certificado correspondiente. La cadena `certfile' debe ser la ruta a un solo archivo en formato PEM que contenga el certificado, así como cualquier número de certificados de CA necesarios para establecer la autenticidad del certificado. La cadena `keyfile', si está presente, debe apuntar a un archivo que contenga la clave privada. De lo contrario, la clave privada también se tomará de `certfile'. Consulte la discusión de @ref{33dd,,Certificados} para obtener más información sobre cómo se almacena el certificado en `certfile'.

El argumento `password' puede ser una función a la que llamar para obtener la contraseña para descifrar la clave privada. Sólo se llamará si la clave privada está encriptada y se necesita una contraseña. Se llamará sin argumentos, y deberá devolver una cadena de caracteres, bytes o bytearray. Si el valor retornado es una cadena de caracteres, se codificará como UTF-8 antes de utilizarlo para descifrar la clave. Alternativamente, se puede suministrar un valor de cadena de caracteres, bytes o bytearray directamente como argumento `password'. Se ignorará si la clave privada no está cifrada y no se necesita una contraseña.

Si el argumento `password' no es especificado y una contraseña es requerida, el mecanismo de solicitud de contraseña incorporado de OpenSSL se usará para solicitarle una contraseña al usuario de forma interactiva.

Un @ref{12e7,,SSLError} es lanzado si la clave privada no coincide con el certificado.


Distinto en la versión 3.3: Nuevo argumento opcional `password'.

@end deffn

@geindex load_default_certs() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_default_certs}@anchor{1030}
@deffn {Método} SSLContext.load_default_certs (purpose=Purpose.SERVER_AUTH)

Carga un conjunto de certificados predeterminados de «autoridad de certificación» (CA) desde ubicaciones predeterminadas. En Windows, carga certificados de CA de los almacenes del sistema @code{CA} y @code{ROOT}. En todos los sistemas llama a @ref{1029,,SSLContext.set_default_verify_paths()}. En el futuro, el método también puede cargar certificados de CA desde otras ubicaciones.

The `purpose' flag specifies what kind of CA certificates are loaded. The
default settings @ref{1031,,Purpose.SERVER_AUTH} loads certificates, that are
flagged and trusted for TLS web server authentication (client side
sockets). @ref{1032,,Purpose.CLIENT_AUTH} loads CA certificates for client
certificate verification on the server side.


Added in version 3.4.

@end deffn

@geindex load_verify_locations() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_verify_locations}@anchor{f6e}
@deffn {Método} SSLContext.load_verify_locations (cafile=None, capath=None, cadata=None)

Carga un conjunto de certificados de «autoridad de certificación» (CA) usados para validar certificados de otros pares cuando @ref{339b,,verify_mode} es distinto de @ref{33ad,,CERT_NONE}. Debe especificarse al menos uno de `cafile' o `capath'.

Este método puede cargar también listas de revocación de certificados (CRLs) en formato PEM o DER. Para poder usar CRLs, @ref{102c,,SSLContext.verify_flags} debe ser configurado correctamente.

La cadena de caracteres `cafile', si está presente, es la ruta a un archivo de certificados CA concatenados en formato PEM. Vea la discusión de @ref{33dd,,Certificados} para más información acerca de como organizar los certificados en este archivo.

The `capath' string, if present, is
the path to a directory containing several CA certificates in PEM format,
following an OpenSSL specific layout@footnote{https://docs.openssl.org/master/man3/SSL_CTX_load_verify_locations/}.

El objeto `cadata', si está presente, es una cadena de caracteres ASCII de uno o más certificados codificados en PEM o un @ref{db4,,bytes-like object} de certificados codificados en DER. Al igual que con `capath', las líneas adicionales alrededor de los certificados codificados en PEM se ignoran, pero debe haber al menos un certificado.


Distinto en la versión 3.4: Nuevo argumento opcional `cadata'

@end deffn

@geindex get_ca_certs() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext get_ca_certs}@anchor{102b}
@deffn {Método} SSLContext.get_ca_certs (binary_form=False)

Obtiene una lista de certificados de «autoridad de certificación» (CA) cargados. Si el parámetro @code{binary_form} es @ref{bbf,,False} cada entrada de la lista es un diccionario como la salida de @ref{1036,,SSLSocket.getpeercert()}. En caso contrario, el método retorna una lista de certificados codificados con DER. La lista retornada no contiene certificados de `capath' a menos que un certificado haya sido solicitado y cargado por una conexión SSL.

@cartouche
@quotation Nota 
Los certificados de un directorio capath no se cargan a menos que se hayan utilizado al menos una vez.
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex get_ciphers() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext get_ciphers}@anchor{d65}
@deffn {Método} SSLContext.get_ciphers ()

Obtiene una lista de cifrados habilitados. La lista está en orden de prioridad de cifrado. Véase @ref{33de,,SSLContext.set_ciphers()}.

Ejemplo:

@example
>>> ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
>>> ctx.set_ciphers('ECDHE+AESGCM:!ECDSA')
>>> ctx.get_ciphers()
[@{'aead': True,
  'alg_bits': 256,
  'auth': 'auth-rsa',
  'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '
                 'Enc=AESGCM(256) Mac=AEAD',
  'digest': None,
  'id': 50380848,
  'kea': 'kx-ecdhe',
  'name': 'ECDHE-RSA-AES256-GCM-SHA384',
  'protocol': 'TLSv1.2',
  'strength_bits': 256,
  'symmetric': 'aes-256-gcm'@},
 @{'aead': True,
  'alg_bits': 128,
  'auth': 'auth-rsa',
  'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '
                 'Enc=AESGCM(128) Mac=AEAD',
  'digest': None,
  'id': 50380847,
  'kea': 'kx-ecdhe',
  'name': 'ECDHE-RSA-AES128-GCM-SHA256',
  'protocol': 'TLSv1.2',
  'strength_bits': 128,
  'symmetric': 'aes-128-gcm'@}]
@end example


Added in version 3.6.

@end deffn

@geindex set_default_verify_paths() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_default_verify_paths}@anchor{1029}
@deffn {Método} SSLContext.set_default_verify_paths ()

Carga un conjunto de certificados de «autoridad de certificación» (CA) por defecto desde una ruta del sistema de archivos definida al construir la biblioteca OpenSSL. Desafortunadamente, no hay una manera fácil de saber si este método tiene éxito: no se retorna ningún error si no se encuentran certificados. Sin embargo, cuando la biblioteca OpenSSL se proporciona como parte del sistema operativo, es probable que esté configurada correctamente.
@end deffn

@geindex set_ciphers() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_ciphers}@anchor{33de}
@deffn {Método} SSLContext.set_ciphers (ciphers)

Set the available ciphers for sockets created with this context.
It should be a string in the OpenSSL cipher list format@footnote{https://docs.openssl.org/master/man1/ciphers/}.
If no cipher can be selected (because compile-time options or other
configuration forbids use of all the specified ciphers), an
@ref{12e7,,SSLError} will be raised.

@cartouche
@quotation Nota 
cuando se conecta, el método @ref{32d7,,SSLSocket.cipher()} de los sockets SSL dará el cifrado actualmente seleccionado.

OpenSSL 1.1.1 tiene suites de cifrado TLS 1.3 habilitadas por defecto. Las suites no se pueden desactivar con @ref{33de,,set_ciphers()}.
@end quotation
@end cartouche
@end deffn

@geindex set_alpn_protocols() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_alpn_protocols}@anchor{ee4}
@deffn {Método} SSLContext.set_alpn_protocols (protocols)

Especifica qué protocolos debe anunciar el socket durante el handshake SSL/TLS. Debe ser una lista de cadenas de caracteres ASCII, como @code{['http/1.1', 'spdy/2']}, ordenadas por preferencia. La selección de un protocolo ocurrirá durante el handshake, y se desarrollará de acuerdo con 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}. Después de un handshake exitoso, el método @ref{ee5,,SSLSocket.selected_alpn_protocol()} devolverá el protocolo acordado.

Este método lanzará @ref{384,,NotImplementedError} si @ref{ee6,,HAS_ALPN} es @code{False}.


Added in version 3.5.

@end deffn

@geindex set_npn_protocols() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_npn_protocols}@anchor{1fb}
@deffn {Método} SSLContext.set_npn_protocols (protocols)

Especifica qué protocolos debe anunciar el socket durante el handshake SSL/TLS. Debe ser una lista de cadenas, como @code{['http/1.1', 'spdy/2']}, ordenadas por preferencia. La selección de un protocolo ocurrirá durante el handshake, y se desarrollará de acuerdo a la Negociación del Protocolo de la Capa de Aplicación@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation}. Después de un handshake exitoso, el método @ref{90b,,SSLSocket.selected_npn_protocol()} devolverá el protocolo acordado.

Este método lanzará @ref{384,,NotImplementedError} si @ref{33c2,,HAS_NPN} es @code{False}.


Added in version 3.3.



Obsoleto desde la versión 3.10: NPN ha sido reemplazada por ALPN

@end deffn

@geindex sni_callback (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sni_callback}@anchor{18de}
@deffn {Atributo} SSLContext.sni_callback

Registra una función callback que se llamará después de que el servidor SSL/TLS haya recibido el mensaje de diálogo TLS Client Hello cuando el cliente TLS especifique una indicación de nombre de servidor. El mecanismo de indicación de nombre de servidor se especifica en 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html} sección 3 - Server Name Indication.

Sólo se puede establecer una función callback por @code{SSLContext}. Si `sni_callback' se establece como @code{None}, la función callback se desactiva. Si se llama a esta función una vez más, se desactivará la función callback registrada anteriormente.

La función callback será llamada con tres argumentos; el primero es el @ref{981,,ssl.SSLSocket}, el segundo es una cadena que representa el nombre del servidor con el que el cliente pretende comunicarse (o @ref{716,,None} si el TLS Client Hello no contiene un nombre de servidor) y el tercer argumento es el @ref{1fa,,SSLContext} original. El argumento del nombre del servidor es un texto. En el caso de los nombres de dominio internacionalizados, el nombre del servidor es un IDN etiqueta A (@code{"xn--pythn-mua.org"}).

Un uso típico de esta función callback es cambiar el atributo @ref{33d8,,SSLSocket.context} de @ref{981,,ssl.SSLSocket} por un nuevo objeto de tipo @ref{1fa,,SSLContext} que representa una cadena de certificados que coincide con el nombre del servidor.

Due to the early negotiation phase of the TLS connection, only limited
methods and attributes are usable like
@ref{ee5,,SSLSocket.selected_alpn_protocol()} and @ref{33d8,,SSLSocket.context}.
The @ref{1036,,SSLSocket.getpeercert()}, @ref{15f9,,SSLSocket.get_verified_chain()},
@ref{15fa,,SSLSocket.get_unverified_chain()} @ref{32d7,,SSLSocket.cipher()}
and @ref{11b6,,SSLSocket.compression()} methods require that
the TLS connection has progressed beyond the TLS Client Hello and therefore
will not return meaningful values nor can they be called safely.

La función `sni_callback' debe devolver @code{None} para permitir que la negociación TLS continúe. Si se requiere un fallo TLS, se puede devolver una constante @ref{33cb,,ALERT_DESCRIPTION_*}. Otros valores de retorno resultarán en un error fatal TLS con @ref{33cb,,ALERT_DESCRIPTION_INTERNAL_ERROR}.

Si se lanza una excepción desde la función `sni_callback' la conexión TLS terminará con un mensaje de alerta TLS fatal @ref{33ca,,ALERT_DESCRIPTION_HANDSHAKE_FAILURE}.

Este método lanzará @ref{384,,NotImplementedError} si la biblioteca OpenSSL tenía definido OPENSSL_NO_TLSEXT cuando se construyó.


Added in version 3.7.

@end deffn

@geindex set_servername_callback (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_servername_callback}@anchor{1035}
@deffn {Atributo} SSLContext.set_servername_callback (server_name_callback)

Se trata de una API heredada que se mantiene por compatibilidad con versiones anteriores. Cuando sea posible, debería utilizar @ref{18de,,sni_callback} en su lugar. El `server_name_callback' dado es similar a `sni_callback', excepto que cuando el nombre del servidor es un nombre de dominio internacionalizado codificado con IDN, el `server_name_callback' recibe una etiqueta U decodificada (@code{"pythön.org"}).

If there is a decoding error on the server name, the TLS connection will
terminate with an @ref{33cb,,ALERT_DESCRIPTION_INTERNAL_ERROR} fatal TLS
alert message to the client.


Added in version 3.4.

@end deffn

@geindex load_dh_params() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_dh_params}@anchor{194c}
@deffn {Método} SSLContext.load_dh_params (dhfile)

Carga los parámetros de generación de claves para el intercambio de claves Diffie-Hellman (DH). El uso del intercambio de claves DH mejora el secreto hacia adelante a expensas de recursos computacionales (tanto en el servidor como en el cliente). El parámetro `dhfile' debe ser la ruta de un archivo que contenga los parámetros DH en formato PEM.

Esta configuración no se aplica a los sockets de los clientes. También puede utilizar la opción @ref{33ba,,OP_SINGLE_DH_USE} para mejorar aún más la seguridad.


Added in version 3.3.

@end deffn

@geindex set_ecdh_curve() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_ecdh_curve}@anchor{11b4}
@deffn {Método} SSLContext.set_ecdh_curve (curve_name)

Establece el nombre de la curva para el intercambio de claves Diffie-Hellman basado en la curva elíptica (ECDH). ECDH es significativamente más rápido que el DH normal, aunque podría decirse que es igual de seguro. El parámetro `curve_name' debe ser una cadena que describa una curva elíptica conocida, por ejemplo @code{prime256v1} para una curva ampliamente soportada.

Esta configuración no se aplica a los sockets de los clientes. También puede utilizar la opción @ref{33bb,,OP_SINGLE_ECDH_USE} para mejorar aún más la seguridad.

Este método no está disponible si @ref{33c0,,HAS_ECDH} es @code{False}.


Added in version 3.3.



@subsubheading Ver también



@table @asis

@item SSL/TLS & Perfect Forward Secrecy@footnote{https://vincent.bernat.ch/en/blog/2011-ssl-perfect-forward-secrecy}

Vincent Bernat.
@end table

@end deffn

@geindex wrap_socket() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext wrap_socket}@anchor{5c8}
@deffn {Método} SSLContext.wrap_socket (sock, server_side=False, do_handshake_on_connect=True, suppress_ragged_eofs=True, server_hostname=None, session=None)

Wrap an existing Python socket `sock' and return an instance of
@ref{33df,,SSLContext.sslsocket_class} (default @ref{981,,SSLSocket}). The
returned SSL socket is tied to the context, its settings and certificates.
`sock' must be a @ref{135a,,SOCK_STREAM} socket; other
socket types are unsupported.

El parámetro @code{server_side} es un booleano que identifica si se desea un comportamiento del lado del servidor o del lado del cliente en este socket.

Para los sockets del lado del cliente, la construcción del contexto es perezosa; si el socket subyacente no está conectado todavía, la construcción del contexto se realizará después de llamar a @code{connect()} en el socket. Para los sockets del lado del servidor, si el socket no tiene un par remoto, se asume que es un socket a la escucha, y la envoltura SSL del lado del servidor se realiza automáticamente en las conexiones del cliente aceptadas a través del método @code{accept()}. El método puede lanzar @ref{12e7,,SSLError}.

En las conexiones de cliente, el parámetro opcional `server_hostname' especifica el nombre del servicio al que nos estamos conectando. Esto permite que un único servidor aloje varios servicios basados en SSL con certificados distintos, de forma similar a los hosts virtuales HTTP. Al especificar `server_hostname' se producirá un @ref{360,,ValueError} si `server_side' es verdadero.

El parámetro @code{do_handshake_on_connect} especifica si se hace el handshake SSL automáticamente después de hacer un @code{socket.connect()}, o si el programa de aplicación lo llamará explícitamente, invocando el método @ref{eed,,SSLSocket.do_handshake()}. Llamar explícitamente a @ref{eed,,SSLSocket.do_handshake()} da al programa el control sobre el comportamiento de bloqueo de la E/S del socket involucrada en el handshake.

El parámetro @code{suppress_ragged_eofs} especifica cómo el método @code{SSLSocket.recv()} debe señalar los EOF inesperados desde el otro extremo de la conexión. Si se especifica como @ref{c95,,True} (el valor por defecto), retorna un EOF normal (un objeto bytes vacío) en respuesta a los errores EOF inesperados que se produzcan desde el socket subyacente; si @ref{bbf,,False}, lanzará las excepciones al llamador.

`session', véase @ref{15d4,,session}.

To wrap an @ref{981,,SSLSocket} in another @ref{981,,SSLSocket}, use
@ref{c0a,,SSLContext.wrap_bio()}.


Distinto en la versión 3.5: Siempre permite pasar un server_hostname, incluso si OpenSSL no tiene SNI.



Distinto en la versión 3.6: Se agregó el argumento `session'.



Distinto en la versión 3.7: El método retorna una instancia de @ref{33df,,SSLContext.sslsocket_class} en lugar de @ref{981,,SSLSocket} codificado de forma rígida.

@end deffn

@geindex sslsocket_class (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sslsocket_class}@anchor{33df}
@deffn {Atributo} SSLContext.sslsocket_class

El tipo de retorno de @ref{5c8,,SSLContext.wrap_socket()}, por defecto es @ref{981,,SSLSocket}. El atributo puede anularse en la instancia de la clase para devolver una subclase personalizada de @ref{981,,SSLSocket}.


Added in version 3.7.

@end deffn

@geindex wrap_bio() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext wrap_bio}@anchor{c0a}
@deffn {Método} SSLContext.wrap_bio (incoming, outgoing, server_side=False, server_hostname=None, session=None)

Envuelve los objetos BIO `incoming' y `outgoing' y retorna una instancia de @ref{33e0,,SSLContext.sslobject_class} (por defecto @ref{c09,,SSLObject}). Las rutinas SSL leerán los datos de entrada de la BIO entrante y escribirán los datos en la BIO saliente.

Los parámetros `server_side', `server_hostname' y `session' tienen el mismo significado que en @ref{5c8,,SSLContext.wrap_socket()}.


Distinto en la versión 3.6: Se agregó el argumento `session'.



Distinto en la versión 3.7: El método retorna una instancia de @ref{33e0,,SSLContext.sslobject_class} en lugar de @ref{c09,,SSLObject} codificado de forma rígida.

@end deffn

@geindex sslobject_class (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sslobject_class}@anchor{33e0}
@deffn {Atributo} SSLContext.sslobject_class

El tipo de retorno de @ref{c0a,,SSLContext.wrap_bio()}, por defecto es @ref{c09,,SSLObject}. El atributo puede anularse en la instancia de la clase para devolver una subclase personalizada de @ref{c09,,SSLObject}.


Added in version 3.7.

@end deffn

@geindex session_stats() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext session_stats}@anchor{33e1}
@deffn {Método} SSLContext.session_stats ()

Get statistics about the SSL sessions created or managed by this context.
A dictionary is returned which maps the names of each piece of information@footnote{https://docs.openssl.org/1.1.1/man3/SSL_CTX_sess_number/} to their
numeric values.  For example, here is the total number of hits and misses
in the session cache since the context was created:

@example
>>> stats = context.session_stats()
>>> stats['hits'], stats['misses']
(0, 0)
@end example
@end deffn

@geindex check_hostname (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext check_hostname}@anchor{33af}
@deffn {Atributo} SSLContext.check_hostname

Si debe coincidir con el nombre de host del certificado de pares en @ref{eed,,SSLSocket.do_handshake()}. El @ref{339b,,verify_mode} del contexto debe establecerse en @ref{33ae,,CERT_OPTIONAL} o @ref{339c,,CERT_REQUIRED}, y debe pasar `server_hostname' a @ref{5c8,,wrap_socket()} para que coincida con el nombre de host. La activación de la comprobación del nombre de host configura automáticamente @ref{339b,,verify_mode} de @ref{33ad,,CERT_NONE} a @ref{339c,,CERT_REQUIRED}. No se puede volver a establecer en @ref{33ad,,CERT_NONE} siempre que la comprobación del nombre de host esté habilitada. El protocolo @ref{909,,PROTOCOL_TLS_CLIENT} habilita la verificación del nombre de host de forma predeterminada. Con otros protocolos, la verificación del nombre de host debe habilitarse explícitamente.

Ejemplo:

@example
import socket, ssl

context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
context.verify_mode = ssl.CERT_REQUIRED
context.check_hostname = True
context.load_default_certs()

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
ssl_sock = context.wrap_socket(s, server_hostname='www.verisign.com')
ssl_sock.connect(('www.verisign.com', 443))
@end example


Added in version 3.4.



Distinto en la versión 3.7: @ref{339b,,verify_mode} ahora se cambia automáticamente a @ref{339c,,CERT_REQUIRED} cuando la comprobación del hostname está activada y @ref{339b,,verify_mode} es @ref{33ad,,CERT_NONE}. Anteriormente la misma operación habría fallado con un @ref{360,,ValueError}.

@end deffn

@geindex keylog_filename (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext keylog_filename}@anchor{339d}
@deffn {Atributo} SSLContext.keylog_filename

Escribe las claves TLS en un archivo keylog, siempre que se genere o reciba material de claves. El archivo keylog está diseñado únicamente para fines de depuración. El formato del archivo está especificado por NSS y es utilizado por muchos analizadores de tráfico como Wireshark. El archivo de registro se abre en modo sólo añadir. Las escrituras se sincronizan entre hilos, pero no entre procesos.


Added in version 3.8.

@end deffn

@geindex maximum_version (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext maximum_version}@anchor{908}
@deffn {Atributo} SSLContext.maximum_version

Un miembro enumeración de @ref{33ce,,TLSVersion} que representa la versión más alta de TLS soportada. El valor por defecto es @ref{33d0,,TLSVersion.MAXIMUM_SUPPORTED}. El atributo es de sólo lectura para protocolos distintos de @ref{339e,,PROTOCOL_TLS}, @ref{909,,PROTOCOL_TLS_CLIENT} y @ref{90a,,PROTOCOL_TLS_SERVER}.

Los atributos @ref{908,,maximum_version}, @ref{907,,minimum_version} y @ref{8cf,,SSLContext.options} afectan a las versiones SSL y TLS soportadas del contexto. La implementación no evita la combinación inválida. Por ejemplo, un contexto con @ref{33b8,,OP_NO_TLSv1_2} en @ref{8cf,,options} y @ref{908,,maximum_version} establecido en @ref{33d4,,TLSVersion.TLSv1_2} no podrá establecer una conexión TLS 1.2.


Added in version 3.7.

@end deffn

@geindex minimum_version (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext minimum_version}@anchor{907}
@deffn {Atributo} SSLContext.minimum_version

Igual que @ref{908,,SSLContext.maximum_version} excepto que es la versión más baja soportada o @ref{33cf,,TLSVersion.MINIMUM_SUPPORTED}.


Added in version 3.7.

@end deffn

@geindex num_tickets (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext num_tickets}@anchor{33e2}
@deffn {Atributo} SSLContext.num_tickets

Controla el número de tickets de sesión TLS 1.3 de un contexto @code{TLS_PROTOCOL_SERVER}. El ajuste no tiene impacto en las conexiones TLS 1.0 a 1.2.


Added in version 3.8.

@end deffn

@geindex options (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext options}@anchor{8cf}
@deffn {Atributo} SSLContext.options

Un número entero que representa el conjunto de opciones SSL habilitadas en este contexto. El valor por defecto es @ref{33b5,,OP_ALL}, pero se pueden especificar otras opciones como @ref{8d0,,OP_NO_SSLv2} mediante la combinación OR.


Distinto en la versión 3.6: @ref{8cf,,SSLContext.options} retorna opciones @ref{33bd,,Options}:

@example
>>> ssl.create_default_context().options  
<Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>
@end example



Obsoleto desde la versión 3.7: Esta opción es obsoleta desde OpenSSL 1.1.0, utilice en su lugar los nuevos @ref{907,,SSLContext.minimum_version} y @ref{908,,SSLContext.maximum_version}.

@end deffn

@geindex post_handshake_auth (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext post_handshake_auth}@anchor{ac3}
@deffn {Atributo} SSLContext.post_handshake_auth

Habilita la autenticación del cliente TLS 1.3 post-handshake. La autenticación post-handshake está deshabilitada por defecto y un servidor sólo puede solicitar un certificado de cliente TLS durante el handshake inicial. Cuando se habilita, un servidor puede solicitar un certificado de cliente TLS en cualquier momento después del handshake.

Cuando se activa en los sockets del lado del cliente, el cliente indica al servidor que soporta la autenticación post-handshake.

Cuando se activa en los sockets del lado del servidor, @ref{339b,,SSLContext.verify_mode} debe establecerse también como @ref{33ae,,CERT_OPTIONAL} o @ref{339c,,CERT_REQUIRED}. El intercambio real de certificados del cliente se retrasa hasta que se llama a @ref{ac4,,SSLSocket.verify_client_post_handshake()} y se realiza alguna E/S.


Added in version 3.8.

@end deffn

@geindex protocol (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext protocol}@anchor{33e3}
@deffn {Atributo} SSLContext.protocol

La versión del protocolo elegida cuando se construyó el contexto. Este atributo es de sólo lectura.
@end deffn

@geindex hostname_checks_common_name (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext hostname_checks_common_name}@anchor{c05}
@deffn {Atributo} SSLContext.hostname_checks_common_name

Si @ref{33af,,check_hostname} vuelve a verificar el nombre común del sujeto del certificado en ausencia de una extensión de nombre alternativo del sujeto (por defecto: true).


Added in version 3.7.



Distinto en la versión 3.10: The flag had no effect with OpenSSL before version 1.1.1l. Python 3.8.9,
3.9.3, and 3.10 include workarounds for previous versions.

@end deffn

@geindex security_level (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext security_level}@anchor{33e4}
@deffn {Atributo} SSLContext.security_level

An integer representing the security level@footnote{https://docs.openssl.org/master/man3/SSL_CTX_get_security_level/}
for the context. This attribute is read-only.


Added in version 3.10.

@end deffn

@geindex verify_flags (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext verify_flags}@anchor{102c}
@deffn {Atributo} SSLContext.verify_flags

Los indicadores para las operaciones de verificación de certificados. Se pueden establecer indicadores como @ref{102e,,VERIFY_CRL_CHECK_LEAF} mediante la combinación OR. Por defecto, OpenSSL no requiere ni verifica las listas de revocación de certificados (CRL). Disponible sólo con la versión 0.9.8+ de openssl.


Added in version 3.4.



Distinto en la versión 3.6: @ref{102c,,SSLContext.verify_flags} retorna opciones @ref{33b2,,VerifyFlags}:

@example
>>> ssl.create_default_context().verify_flags  
<VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>
@end example

@end deffn

@geindex verify_mode (atributo de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext verify_mode}@anchor{339b}
@deffn {Atributo} SSLContext.verify_mode

Si se intenta verificar los certificados de otros pares y cómo comportarse si la verificación falla. Este atributo debe ser uno de los siguientes: @ref{33ad,,CERT_NONE}, @ref{33ae,,CERT_OPTIONAL} o @ref{339c,,CERT_REQUIRED}.


Distinto en la versión 3.6: @ref{339b,,SSLContext.verify_mode} retorna @ref{33b0,,VerifyMode} enum:

@example
>>> ssl.create_default_context().verify_mode  
<VerifyMode.CERT_REQUIRED: 2>
@end example

@end deffn

@geindex set_psk_client_callback() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_psk_client_callback}@anchor{33e5}
@deffn {Método} SSLContext.set_psk_client_callback (callback)

Enables TLS-PSK (pre-shared key) authentication on a client-side connection.

In general, certificate based authentication should be preferred over this method.

The parameter @code{callback} is a callable object with the signature:
@code{def callback(hint: str | None) -> tuple[str | None, bytes]}.
The @code{hint} parameter is an optional identity hint sent by the server.
The return value is a tuple in the form (client-identity, psk).
Client-identity is an optional string which may be used by the server to
select a corresponding PSK for the client. The string must be less than or
equal to @code{256} octets when UTF-8 encoded. PSK is a
@ref{db4,,bytes-like object} representing the pre-shared key. Return a zero
length PSK to reject the connection.

Setting @code{callback} to @ref{716,,None} removes any existing callback.

@cartouche
@quotation Nota 
When using TLS 1.3:


@itemize -

@item 
the @code{hint} parameter is always @ref{716,,None}.

@item 
client-identity must be a non-empty string.
@end itemize
@end quotation
@end cartouche

Example usage:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
context.maximum_version = ssl.TLSVersion.TLSv1_2
context.set_ciphers('PSK')

# A simple lambda:
psk = bytes.fromhex('c0ffee')
context.set_psk_client_callback(lambda hint: (None, psk))

# A table using the hint from the server:
psk_table = @{ 'ServerId_1': bytes.fromhex('c0ffee'),
              'ServerId_2': bytes.fromhex('facade')
@}
def callback(hint):
    return 'ClientId_1', psk_table.get(hint, b'@w{'})
context.set_psk_client_callback(callback)
@end example

This method will raise @ref{384,,NotImplementedError} if @ref{33c8,,HAS_PSK} is
@code{False}.


Added in version 3.13.

@end deffn

@geindex set_psk_server_callback() (método de ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_psk_server_callback}@anchor{33e6}
@deffn {Método} SSLContext.set_psk_server_callback (callback, identity_hint=None)

Enables TLS-PSK (pre-shared key) authentication on a server-side connection.

In general, certificate based authentication should be preferred over this method.

The parameter @code{callback} is a callable object with the signature:
@code{def callback(identity: str | None) -> bytes}.
The @code{identity} parameter is an optional identity sent by the client which can
be used to select a corresponding PSK.
The return value is a @ref{db4,,bytes-like object} representing the pre-shared key.
Return a zero length PSK to reject the connection.

Setting @code{callback} to @ref{716,,None} removes any existing callback.

The parameter @code{identity_hint} is an optional identity hint string sent to
the client. The string must be less than or equal to @code{256} octets when
UTF-8 encoded.

@cartouche
@quotation Nota 
When using TLS 1.3 the @code{identity_hint} parameter is not sent to the client.
@end quotation
@end cartouche

Example usage:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.maximum_version = ssl.TLSVersion.TLSv1_2
context.set_ciphers('PSK')

# A simple lambda:
psk = bytes.fromhex('c0ffee')
context.set_psk_server_callback(lambda identity: psk)

# A table using the identity of the client:
psk_table = @{ 'ClientId_1': bytes.fromhex('c0ffee'),
              'ClientId_2': bytes.fromhex('facade')
@}
def callback(identity):
    return psk_table.get(identity, b'@w{'})
context.set_psk_server_callback(callback, 'ServerId_1')
@end example

This method will raise @ref{384,,NotImplementedError} if @ref{33c8,,HAS_PSK} is
@code{False}.


Added in version 3.13.

@end deffn

@geindex certificates

@geindex X509 certificate

@node Certificados,Ejemplos<18>,Contextos SSL,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl certificates}@anchor{33e7}@anchor{library/ssl ssl-certificates}@anchor{33dd}
@subsubsection Certificados


En general, los certificados forman parte de un sistema de clave pública/clave privada. En este sistema, a cada `principal' (que puede ser una máquina, una persona o una organización) se le asigna una clave de cifrado única de dos partes. Una parte de la clave es pública y se llama `clave pública'; la otra parte se mantiene en secreto y se llama `clave privada'. Las dos partes están relacionadas, en el sentido de que si se cifra un mensaje con una de las partes, se puede descifrar con la otra parte, y `sólo' con la otra parte.

Un certificado contiene información sobre dos sujetos. Contiene el nombre de un `sujeto', y la clave pública del sujeto. También contiene una declaración de un segundo titular, el `emisor', de que el sujeto es quien dice ser, y de que ésta es efectivamente la clave pública del sujeto. La declaración del emisor está firmada con su clave privada, que sólo el emisor conoce. Sin embargo, cualquiera puede verificar la declaración del emisor encontrando la clave pública del emisor, descifrando la declaración con ella y comparándola con el resto de la información del certificado. El certificado también contiene información sobre el periodo de tiempo en el que es válido. Esto se expresa en dos campos, llamados `notBefore' y `notAfter'.

En el uso de certificados en Python, un cliente o servidor puede utilizar un certificado para demostrar quién es. El otro lado de una conexión de red también puede ser requerido para producir un certificado, y ese certificado puede ser validado a la satisfacción del cliente o servidor que requiere dicha validación. El intento de conexión puede configurarse para que lance una excepción si la validación falla. La validación se realiza automáticamente, por el subyacente framework OpenSSL; la aplicación no necesita preocuparse de su mecánica. Sin embargo, la aplicación normalmente necesita proporcionar conjuntos de certificados para permitir que este proceso tenga lugar.

Python utiliza archivos para contener certificados. Deben ser formateados como «PEM» (ver 
@geindex RFC; RFC 1422
RFC 1422@footnote{https://datatracker.ietf.org/doc/html/rfc1422.html}), que es una forma codificada en base-64 envuelta con una línea de cabecera y una línea de pie de página:

@example
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
@end example

@menu
* Cadenas de certificados:: 
* Certificados CA:: 
* Clave y certificado combinados:: 
* Certificados auto-firmados:: 

@end menu

@node Cadenas de certificados,Certificados CA,,Certificados
@anchor{library/ssl certificate-chains}@anchor{33e8}
@subsubsection Cadenas de certificados


Los archivos de Python que contienen certificados pueden contener una secuencia de certificados, a veces llamada `cadena de certificados'. Esta cadena debería empezar con el certificado específico para el principal que «es» el cliente o servidor, y luego el certificado para el emisor de ese certificado, y luego el certificado para el emisor de `ese' certificado, y así sucesivamente hasta llegar a un certificado que es `auto-firmado', es decir, un certificado que tiene el mismo sujeto y emisor, a veces llamado `certificado raíz'. Los certificados sólo deben concatenarse en el archivo de certificados. Por ejemplo, supongamos que tenemos una cadena de tres certificados, desde el certificado de nuestro servidor al certificado de la autoridad de certificación que firmó nuestro certificado del servidor, hasta el certificado raíz de la agencia que emitió el certificado de la autoridad de certificación:

@example
-----BEGIN CERTIFICATE-----
... (certificate for your server)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (the certificate for the CA)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (the root certificate for the CA's issuer)...
-----END CERTIFICATE-----
@end example

@node Certificados CA,Clave y certificado combinados,Cadenas de certificados,Certificados
@anchor{library/ssl ca-certificates}@anchor{33e9}
@subsubsection Certificados CA


Si se requiere la validación del certificado del otro lado de la conexión, se necesita proporcionar un archivo «CA certs», con las cadenas de certificados para cada emisor en el que se está dispuesto a confiar. De nuevo, este archivo sólo contiene estas cadenas concatenadas. Para la validación, Python utilizará la primera cadena que encuentre en el archivo que coincida. El archivo de certificados de la plataforma se puede utilizar llamando a @ref{1030,,SSLContext.load_default_certs()}, esto se hace automáticamente con @ref{2c1,,create_default_context()}.

@node Clave y certificado combinados,Certificados auto-firmados,Certificados CA,Certificados
@anchor{library/ssl combined-key-and-certificate}@anchor{33ea}
@subsubsection Clave y certificado combinados


Often the private key is stored in the same file as the certificate; in this
case, only the @code{certfile} parameter to @ref{3e7,,SSLContext.load_cert_chain()}
needs to be passed.  If the private key is stored
with the certificate, it should come before the first certificate in
the certificate chain:

@example
-----BEGIN RSA PRIVATE KEY-----
... (private key in base64 encoding) ...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
@end example

@node Certificados auto-firmados,,Clave y certificado combinados,Certificados
@anchor{library/ssl self-signed-certificates}@anchor{33eb}
@subsubsection Certificados auto-firmados


Si va a crear un servidor que proporcione servicios de conexión encriptada SSL, necesitará adquirir un certificado para ese servicio. Hay muchas formas de adquirir los certificados adecuados, como comprar uno a una autoridad de certificación. Otra práctica común es generar un certificado auto-firmado. La forma más sencilla de hacerlo es con el paquete OpenSSL, utilizando algo como lo siguiente:

@example
% openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem
Generating a 1024 bit RSA private key
.......++++++
.............................++++++
writing new private key to 'cert.pem'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:MyState
Locality Name (eg, city) []:Some City
Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc.
Organizational Unit Name (eg, section) []:My Group
Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com
Email Address []:ops@@myserver.mygroup.myorganization.com
%
@end example

La desventaja de un certificado auto-firmado es que es su propio certificado raíz, y nadie más lo tendrá en su caché de certificados raíz conocidos (y de confianza).

@node Ejemplos<18>,Notas sobre los sockets no bloqueantes,Certificados,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl examples}@anchor{33ec}
@subsubsection Ejemplos


@menu
* Pruebas de compatibilidad con SSL:: 
* Operación del lado del cliente:: 
* Operación del lado del servidor:: 

@end menu

@node Pruebas de compatibilidad con SSL,Operación del lado del cliente,,Ejemplos<18>
@anchor{library/ssl testing-for-ssl-support}@anchor{33ed}
@subsubsection Pruebas de compatibilidad con SSL


Para comprobar la presencia de soporte SSL en una instalación de Python, el código del usuario debe utilizar el siguiente modismo:

@example
try:
    import ssl
except ImportError:
    pass
else:
    ...  # do something that requires SSL support
@end example

@node Operación del lado del cliente,Operación del lado del servidor,Pruebas de compatibilidad con SSL,Ejemplos<18>
@anchor{library/ssl client-side-operation}@anchor{33ee}
@subsubsection Operación del lado del cliente


Este ejemplo crea un contexto SSL con la configuración de seguridad recomendada para los sockets del cliente, incluyendo la verificación automática de certificados:

@example
>>> context = ssl.create_default_context()
@end example

Si prefieres ajustar la configuración de seguridad tú mismo, puedes crear un contexto desde cero (pero ten en cuenta que podrías no acertar con la configuración):

@example
>>> context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")
@end example

(este fragmento asume que tu sistema operativo coloca un paquete de todos los certificados CA en @code{/etc/ssl/certs/ca-bundle.crt}; si no es así, obtendrá un error y tendrá que ajustar la ubicación)

El protocolo @ref{909,,PROTOCOL_TLS_CLIENT} configura el contexto para la validación de certificados y la verificación del hostname. @ref{339b,,verify_mode} se establece en @ref{339c,,CERT_REQUIRED} y @ref{33af,,check_hostname} se establece en @code{True}. Todos los demás protocolos crean contextos SSL con valores predeterminados inseguros.

Cuando se utiliza el contexto para conectarse a un servidor, @ref{339c,,CERT_REQUIRED} y @ref{33af,,check_hostname} validan el certificado del servidor: se asegura de que el certificado del servidor se ha firmado con uno de los certificados de la CA, se comprueba que la firma es correcta y se verifican otras propiedades como la validez y la identidad del hostname:

@example
>>> conn = context.wrap_socket(socket.socket(socket.AF_INET),
...                            server_hostname="www.python.org")
>>> conn.connect(("www.python.org", 443))
@end example

A continuación, puede obtener el certificado:

@example
>>> cert = conn.getpeercert()
@end example

La inspección visual muestra que el certificado sí identifica el servicio deseado (es decir, el host HTTPS @code{www.python.org}):

@example
>>> pprint.pprint(cert)
@{'OCSP': ('http://ocsp.digicert.com',),
 'caIssuers': ('http://cacerts.digicert.com/DigiCertSHA2ExtendedValidationServerCA.crt',),
 'crlDistributionPoints': ('http://crl3.digicert.com/sha2-ev-server-g1.crl',
                           'http://crl4.digicert.com/sha2-ev-server-g1.crl'),
 'issuer': ((('countryName', 'US'),),
            (('organizationName', 'DigiCert Inc'),),
            (('organizationalUnitName', 'www.digicert.com'),),
            (('commonName', 'DigiCert SHA2 Extended Validation Server CA'),)),
 'notAfter': 'Sep  9 12:00:00 2016 GMT',
 'notBefore': 'Sep  5 00:00:00 2014 GMT',
 'serialNumber': '01BB6F00122B177F36CAB49CEA8B6B26',
 'subject': ((('businessCategory', 'Private Organization'),),
             (('1.3.6.1.4.1.311.60.2.1.3', 'US'),),
             (('1.3.6.1.4.1.311.60.2.1.2', 'Delaware'),),
             (('serialNumber', '3359300'),),
             (('streetAddress', '16 Allen Rd'),),
             (('postalCode', '03894-4801'),),
             (('countryName', 'US'),),
             (('stateOrProvinceName', 'NH'),),
             (('localityName', 'Wolfeboro'),),
             (('organizationName', 'Python Software Foundation'),),
             (('commonName', 'www.python.org'),)),
 'subjectAltName': (('DNS', 'www.python.org'),
                    ('DNS', 'python.org'),
                    ('DNS', 'pypi.org'),
                    ('DNS', 'docs.python.org'),
                    ('DNS', 'testpypi.org'),
                    ('DNS', 'bugs.python.org'),
                    ('DNS', 'wiki.python.org'),
                    ('DNS', 'hg.python.org'),
                    ('DNS', 'mail.python.org'),
                    ('DNS', 'packaging.python.org'),
                    ('DNS', 'pythonhosted.org'),
                    ('DNS', 'www.pythonhosted.org'),
                    ('DNS', 'test.pythonhosted.org'),
                    ('DNS', 'us.pycon.org'),
                    ('DNS', 'id.python.org')),
 'version': 3@}
@end example

Ahora que se ha establecido el canal SSL y se ha verificado el certificado, se puede proceder a hablar con el servidor:

@example
>>> conn.sendall(b"HEAD / HTTP/1.0\r\nHost: linuxfr.org\r\n\r\n")
>>> pprint.pprint(conn.recv(1024).split(b"\r\n"))
[b'HTTP/1.1 200 OK',
 b'Date: Sat, 18 Oct 2014 18:27:20 GMT',
 b'Server: nginx',
 b'Content-Type: text/html; charset=utf-8',
 b'X-Frame-Options: SAMEORIGIN',
 b'Content-Length: 45679',
 b'Accept-Ranges: bytes',
 b'Via: 1.1 varnish',
 b'Age: 2188',
 b'X-Served-By: cache-lcy1134-LCY',
 b'X-Cache: HIT',
 b'X-Cache-Hits: 11',
 b'Vary: Cookie',
 b'Strict-Transport-Security: max-age=63072000; includeSubDomains',
 b'Connection: close',
 b'@w{'},
 b'@w{'}]
@end example

Vea la discusión sobre @ref{3292,,Consideraciones de seguridad} más abajo.

@node Operación del lado del servidor,,Operación del lado del cliente,Ejemplos<18>
@anchor{library/ssl server-side-operation}@anchor{33ef}
@subsubsection Operación del lado del servidor


Para el funcionamiento del servidor, normalmente necesitarás tener un certificado de servidor y una clave privada, cada uno en un archivo. Primero crearás un contexto que contenga la clave y el certificado, para que los clientes puedan comprobar tu autenticidad. Entonces abrirás un socket, lo enlazarás a un puerto, llamarás a @code{listen()} en él, y empezarás a esperar a que los clientes se conecten:

@example
import socket, ssl

context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile")

bindsocket = socket.socket()
bindsocket.bind(('myaddr.example.com', 10023))
bindsocket.listen(5)
@end example

Cuando un cliente se conecta, llamarás a @code{accept()} en el socket para obtener el nuevo socket del otro extremo, y utilizarás el método @ref{5c8,,SSLContext.wrap_socket()} del contexto para crear un socket SSL del lado del servidor para la conexión:

@example
while True:
    newsocket, fromaddr = bindsocket.accept()
    connstream = context.wrap_socket(newsocket, server_side=True)
    try:
        deal_with_client(connstream)
    finally:
        connstream.shutdown(socket.SHUT_RDWR)
        connstream.close()
@end example

Entonces leerás los datos del @code{connstream} y harás algo con ellos hasta que hayas terminado con el cliente (o el cliente haya terminado contigo):

@example
def deal_with_client(connstream):
    data = connstream.recv(1024)
    # empty data means the client is finished with us
    while data:
        if not do_something(connstream, data):
            # we'll assume do_something returns False
            # when we're finished with client
            break
        data = connstream.recv(1024)
    # finished with client
@end example

Y volver a escuchar nuevas conexiones de clientes (por supuesto, un servidor real probablemente manejaría cada conexión de cliente en un hilo separado, o pondría los sockets en modo @ref{33a1,,no-bloqueo} y usaría un bucle de eventos).

@node Notas sobre los sockets no bloqueantes,Soporte de memoria BIO<2>,Ejemplos<18>,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl notes-on-non-blocking-sockets}@anchor{33f0}@anchor{library/ssl ssl-nonblocking}@anchor{33a1}
@subsubsection Notas sobre los sockets no bloqueantes


Los sockets SSL se comportan de forma ligeramente diferente a los sockets normales en modo no bloqueante. Cuando se trabaja con sockets no bloqueantes, hay varias cosas que hay que tener en cuenta:


@itemize -

@item 
La mayoría de los métodos de @ref{981,,SSLSocket} lanzarán @ref{eea,,SSLWantWriteError} o @ref{ee9,,SSLWantReadError} en lugar de @ref{10d3,,BlockingIOError} si una operación de E/S se bloquea. @ref{ee9,,SSLWantReadError} se lanzará si es necesaria una operación de lectura en el socket subyacente, y @ref{eea,,SSLWantWriteError} para una operación de escritura en el socket subyacente. Tenga en cuenta que los intentos de `escribir' en un socket SSL pueden requerir `leer' del socket subyacente primero, y los intentos de `leer' del socket SSL pueden requerir una `escritura' previa en el socket subyacente.


Distinto en la versión 3.5: En versiones anteriores de Python, el método @code{SSLSocket.send()} devolvía cero en lugar de lanzar @ref{eea,,SSLWantWriteError} o @ref{ee9,,SSLWantReadError}.


@item 
Llamar a @ref{e26,,select()} le indica que se puede leer (o escribir) en el socket a nivel del SO, pero no implica que haya suficientes datos en la capa superior SSL. Por ejemplo, puede que sólo haya llegado una parte de una trama SSL. Por lo tanto, debe estar preparado para manejar los fallos de @code{SSLSocket.recv()} y @code{SSLSocket.send()}, y re-intentar después de otra llamada a @ref{e26,,select()}.

@item 
Por el contrario, dado que la capa SSL tiene su propia estructura, un socket SSL puede tener datos disponibles para leer sin que @ref{e26,,select()} lo sepa. Por lo tanto, debería llamar primero a @code{SSLSocket.recv()} para drenar cualquier dato potencialmente disponible, y luego sólo bloquear en una llamada a @ref{e26,,select()} si todavía es necesario.

(por supuesto, se aplican disposiciones similares cuando se utilizan otras primitivas como @ref{2bb2,,poll()}, o las del módulo @ref{c2,,selectors})

@item 
El handshake SSL en sí mismo será no bloqueante: el método @ref{eed,,SSLSocket.do_handshake()} tiene que ser re-intentado hasta que regrese con éxito. Aquí hay una sinopsis usando @ref{e26,,select()} para esperar la disponibilidad del socket:

@example
while True:
    try:
        sock.do_handshake()
        break
    except ssl.SSLWantReadError:
        select.select([sock], [], [])
    except ssl.SSLWantWriteError:
        select.select([], [sock], [])
@end example
@end itemize


@subsubheading Ver también


El módulo @ref{b,,asyncio} soporta @ref{33a1,,sockets SSL no bloqueantes} y proporciona una API de alto nivel. Busca eventos usando el módulo @ref{c2,,selectors} y maneja las excepciones @ref{eea,,SSLWantWriteError}, @ref{ee9,,SSLWantReadError} y @ref{10d3,,BlockingIOError}. También ejecuta el handshake SSL de forma asíncrona.


@node Soporte de memoria BIO<2>,Sesión SSL,Notas sobre los sockets no bloqueantes,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl memory-bio-support}@anchor{33f1}
@subsubsection Soporte de memoria BIO



Added in version 3.5.


Desde que se introdujo el módulo SSL en Python 2.6, la clase @ref{981,,SSLSocket} ha proporcionado dos áreas de funcionalidad relacionadas pero distintas:


@itemize -

@item 
Manejo del protocolo SSL

@item 
E/S de red
@end itemize

La API de E/S de red es idéntica a la proporcionada por @ref{e27,,socket.socket}, de la que también hereda @ref{981,,SSLSocket}. Esto permite que un socket SSL sea utilizado como un reemplazo de un socket normal, haciendo que sea muy fácil añadir soporte SSL a una aplicación existente.

La combinación del manejo del protocolo SSL y la E/S de red suele funcionar bien, pero hay algunos casos en los que no es así. Un ejemplo son los frameworks de E/S asíncronos que quieren utilizar un modelo de multiplexación de E/S diferente al modelo «selección/consulta de un descriptor de archivo» (basado en la preparación) que es asumido por @ref{e27,,socket.socket} y por las rutinas internas de E/S de socket de OpenSSL. Esto es principalmente relevante para plataformas como Windows donde este modelo no es eficiente. Para este propósito, se proporciona una variante de ámbito reducido de @ref{981,,SSLSocket} llamada @ref{c09,,SSLObject}.

@geindex SSLObject (clase en ssl)
@anchor{library/ssl ssl SSLObject}@anchor{c09}
@deffn {Clase} ssl.SSLObject

Una variante de alcance reducido de @ref{981,,SSLSocket} que representa una instancia del protocolo SSL que no contiene ningún método de E/S de red. Esta clase suele ser utilizada por los autores de frameworks que quieren implementar E/S asíncrona para SSL a través de búfers de memoria.

Esta clase implementa una interfaz sobre un objeto SSL de bajo nivel como el implementado por OpenSSL. Este objeto captura el estado de una conexión SSL pero no proporciona ninguna E/S de red en sí misma. La E/S debe realizarse a través de objetos «BIO» separados que son la capa de abstracción de E/S de OpenSSL.

Esta clase no tiene un constructor público. Se debe crear una instancia @ref{c09,,SSLObject} utilizando el método @ref{c0a,,wrap_bio()}. Este método creará la instancia @ref{c09,,SSLObject} y la vinculará a un par de BIOs. El BIO `de entrada' se utiliza para pasar los datos de Python a la instancia del protocolo SSL, mientras que el BIO `de salida' se utiliza para pasar los datos a la inversa.

Los siguientes métodos son disponibles:


@itemize -

@item 
@ref{33d8,,context}

@item 
@ref{33da,,server_side}

@item 
@ref{c07,,server_hostname}

@item 
@ref{15d4,,session}

@item 
@ref{33db,,session_reused}

@item 
@ref{eee,,read()}

@item 
@ref{eef,,write()}

@item 
@ref{1036,,getpeercert()}

@item 
@ref{15f9,,get_verified_chain()}

@item 
@ref{15fa,,get_unverified_chain()}

@item 
@ref{ee5,,selected_alpn_protocol()}

@item 
@ref{90b,,selected_npn_protocol()}

@item 
@ref{32d7,,cipher()}

@item 
@ref{eec,,shared_ciphers()}

@item 
@ref{11b6,,compression()}

@item 
@ref{33d9,,pending()}

@item 
@ref{eed,,do_handshake()}

@item 
@ref{ac4,,verify_client_post_handshake()}

@item 
@ref{33d7,,unwrap()}

@item 
@ref{11b5,,get_channel_binding()}

@item 
@ref{ee8,,version()}
@end itemize

En comparación con @ref{981,,SSLSocket}, este objeto carece de las siguientes características:


@itemize -

@item 
Cualquier forma de E/S de red; @code{recv()} y @code{send()} leen y escriben sólo en los búfers subyacentes de @ref{ee2,,MemoryBIO}.

@item 
No existe la maquinaria `do_handshake_on_connect'. Siempre hay que llamar manualmente a @ref{eed,,do_handshake()} para iniciar el handshake.

@item 
No hay manejo de `suppress_ragged_eofs'. Todas las condiciones de fin de archivo que violan el protocolo se reportan a través de la excepción @ref{174c,,SSLEOFError}.

@item 
La llamada al método @ref{33d7,,unwrap()} no retorna nada, a diferencia de lo que ocurre con un socket SSL, que retorna el socket subyacente.

@item 
La función callback `server_name_callback' pasada a @ref{1035,,SSLContext.set_servername_callback()} obtendrá una instancia de @ref{c09,,SSLObject} en lugar de una instancia de @ref{981,,SSLSocket} como primer parámetro.
@end itemize

Algunas notas relacionadas con el uso de @ref{c09,,SSLObject}:


@itemize -

@item 
Toda la E/S en un @ref{c09,,SSLObject} es @ref{33a1,,non-blocking}. Esto significa que, por ejemplo, @ref{eee,,read()} lanzará un @ref{ee9,,SSLWantReadError} si necesita más datos de los que la BIO entrante tiene disponibles.
@end itemize


Distinto en la versión 3.7: @ref{c09,,SSLObject} instances must be created with
@ref{c0a,,wrap_bio()}. In earlier versions, it was possible to
create instances directly. This was never documented or officially
supported.

@end deffn

Un SSLObject se comunica con el mundo exterior utilizando búfers de memoria. La clase @ref{ee2,,MemoryBIO} proporciona un búfer de memoria que puede ser utilizado para este propósito. Envuelve un objeto BIO (Basic IO) de memoria de OpenSSL:

@geindex MemoryBIO (clase en ssl)
@anchor{library/ssl ssl MemoryBIO}@anchor{ee2}
@deffn {Clase} ssl.MemoryBIO

Un búfer de memoria que se puede utilizar para pasar datos entre Python y una instancia del protocolo SSL.

@geindex pending (atributo de ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO pending}@anchor{33f2}
@deffn {Atributo} pending

Retorna el número de bytes que se encuentran actualmente en la memoria búfer.
@end deffn

@geindex eof (atributo de ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO eof}@anchor{33f3}
@deffn {Atributo} eof

Un booleano que indica si la memoria BIO es actual en la posición de fin de archivo.
@end deffn

@geindex read() (método de ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO read}@anchor{33f4}
@deffn {Método} read (n=-1)

Lee hasta `n' bytes del búfer de memoria. Si `n' no se especifica o es negativo, se retornan todos los bytes.
@end deffn

@geindex write() (método de ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO write}@anchor{33f5}
@deffn {Método} write (buf)

Escribe los bytes de `buf' en la memoria BIO. El argumento `buf' debe ser un objeto que soporte el protocolo de búfer.

El valor de retorno es el número de bytes escritos, que siempre es igual a la longitud de `buf'.
@end deffn

@geindex write_eof() (método de ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO write_eof}@anchor{33f6}
@deffn {Método} write_eof ()

Escribe un marcador EOF en la memoria BIO. Después de llamar a este método, es ilegal llamar a @ref{33f5,,write()}. El atributo @ref{33f3,,eof} se convertirá en verdadero después de que se hayan leído todos los datos que hay actualmente en el búfer.
@end deffn
@end deffn

@node Sesión SSL,Consideraciones de seguridad<2>,Soporte de memoria BIO<2>,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl ssl-session}@anchor{33f7}
@subsubsection Sesión SSL



Added in version 3.6.


@geindex SSLSession (clase en ssl)
@anchor{library/ssl ssl SSLSession}@anchor{d64}
@deffn {Clase} ssl.SSLSession

Objeto sesión usado por @ref{15d4,,session}.

@geindex id (atributo de ssl.SSLSession)
@anchor{library/ssl ssl SSLSession id}@anchor{33f8}
@deffn {Atributo} id
@end deffn

@geindex time (atributo de ssl.SSLSession)
@anchor{library/ssl ssl SSLSession time}@anchor{33f9}
@deffn {Atributo} time
@end deffn

@geindex timeout (atributo de ssl.SSLSession)
@anchor{library/ssl ssl SSLSession timeout}@anchor{33fa}
@deffn {Atributo} timeout
@end deffn

@geindex ticket_lifetime_hint (atributo de ssl.SSLSession)
@anchor{library/ssl ssl SSLSession ticket_lifetime_hint}@anchor{33fb}
@deffn {Atributo} ticket_lifetime_hint
@end deffn

@geindex has_ticket (atributo de ssl.SSLSession)
@anchor{library/ssl ssl SSLSession has_ticket}@anchor{33fc}
@deffn {Atributo} has_ticket
@end deffn
@end deffn

@node Consideraciones de seguridad<2>,TLS 1 3,Sesión SSL,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl security-considerations}@anchor{33fd}@anchor{library/ssl ssl-security}@anchor{3292}
@subsubsection Consideraciones de seguridad


@menu
* Los mejores valores por defecto:: 
* Ajustes manuales:: 
* Multiprocesamiento:: 

@end menu

@node Los mejores valores por defecto,Ajustes manuales,,Consideraciones de seguridad<2>
@anchor{library/ssl best-defaults}@anchor{33fe}
@subsubsection Los mejores valores por defecto


Para el `uso en el cliente', si no tiene ningún requisito especial para su política de seguridad, es muy recomendable que utilice la función @ref{2c1,,create_default_context()} para crear su contexto SSL. Cargará los certificados CA de confianza del sistema, habilitará la validación de certificados y la comprobación del hostname, e intentará elegir una configuración de protocolo y cifrado razonablemente segura.

Por ejemplo, así es como se utiliza la clase @ref{9c0,,smtplib.SMTP} para crear una conexión segura y de confianza con un servidor SMTP:

@example
>>> import ssl, smtplib
>>> smtp = smtplib.SMTP("mail.python.org", port=587)
>>> context = ssl.create_default_context()
>>> smtp.starttls(context=context)
(220, b'2.0.0 Ready to start TLS')
@end example

Si se necesita un certificado de cliente para la conexión, se puede añadir con @ref{3e7,,SSLContext.load_cert_chain()}.

Por el contrario, si crea el contexto SSL llamando usted mismo al constructor @ref{1fa,,SSLContext}, no tendrá activada por defecto la validación de certificados ni la comprobación de hostname. Si lo hace, lea los párrafos siguientes para conseguir un buen nivel de seguridad.

@node Ajustes manuales,Multiprocesamiento,Los mejores valores por defecto,Consideraciones de seguridad<2>
@anchor{library/ssl manual-settings}@anchor{33ff}
@subsubsection Ajustes manuales


@menu
* Verificación de certificados:: 
* Versiones del protocolo:: 
* Selección de cifrado:: 

@end menu

@node Verificación de certificados,Versiones del protocolo,,Ajustes manuales
@anchor{library/ssl verifying-certificates}@anchor{3400}
@subsubsection Verificación de certificados


When calling the @ref{1fa,,SSLContext} constructor directly,
@ref{33ad,,CERT_NONE} is the default.  Since it does not authenticate the other
peer, it can be insecure, especially in client mode where most of the time you
would like to ensure the authenticity of the server you’re talking to.
Therefore, when in client mode, it is highly recommended to use
@ref{339c,,CERT_REQUIRED}.  However, it is in itself not sufficient; you also
have to check that the server certificate, which can be obtained by calling
@ref{1036,,SSLSocket.getpeercert()}, matches the desired service.  For many
protocols and applications, the service can be identified by the hostname.
This common check is automatically performed when
@ref{33af,,SSLContext.check_hostname} is enabled.


Distinto en la versión 3.7: Las hostname matchings son ahora realizadas por OpenSSL. Python ya no utiliza @code{match_hostname()}.


En el modo servidor, si quiere autenticar a sus clientes utilizando la capa SSL (en lugar de utilizar un mecanismo de autenticación de nivel superior), también tendrá que especificar @ref{339c,,CERT_REQUIRED} y comprobar de forma similar el certificado del cliente.

@node Versiones del protocolo,Selección de cifrado,Verificación de certificados,Ajustes manuales
@anchor{library/ssl protocol-versions}@anchor{3401}
@subsubsection Versiones del protocolo


Las versiones 2 y 3 de SSL se consideran inseguras y, por lo tanto, su uso es peligroso. Si desea la máxima compatibilidad entre clientes y servidores, se recomienda utilizar @ref{909,,PROTOCOL_TLS_CLIENT} o @ref{90a,,PROTOCOL_TLS_SERVER} como versión del protocolo. SSLv2 y SSLv3 están desactivados por defecto.

@example
>>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> client_context.minimum_version = ssl.TLSVersion.TLSv1_3
>>> client_context.maximum_version = ssl.TLSVersion.TLSv1_3
@end example

The SSL context created above will only allow TLSv1.3 and later (if
supported by your system) connections to a server. @ref{909,,PROTOCOL_TLS_CLIENT}
implies certificate validation and hostname checks by default. You have to
load certificates into the context.

@node Selección de cifrado,,Versiones del protocolo,Ajustes manuales
@anchor{library/ssl cipher-selection}@anchor{3402}
@subsubsection Selección de cifrado


If you have advanced security requirements, fine-tuning of the ciphers
enabled when negotiating a SSL session is possible through the
@ref{33de,,SSLContext.set_ciphers()} method.  Starting from Python 3.2.3, the
ssl module disables certain weak ciphers by default, but you may want
to further restrict the cipher choice. Be sure to read OpenSSL’s documentation
about the cipher list format@footnote{https://docs.openssl.org/1.1.1/man1/ciphers/#cipher-list-format}.
If you want to check which ciphers are enabled by a given cipher list, use
@ref{d65,,SSLContext.get_ciphers()} or the @code{openssl ciphers} command on your
system.

@node Multiprocesamiento,,Ajustes manuales,Consideraciones de seguridad<2>
@anchor{library/ssl multi-processing}@anchor{3403}
@subsubsection Multiprocesamiento


If using this module as part of a multi-processed application (using,
for example the @ref{94,,multiprocessing} or @ref{22,,concurrent.futures} modules),
be aware that OpenSSL’s internal random number generator does not properly
handle forked processes.  Applications must change the PRNG state of the
parent process if they use any SSL feature with @ref{2ff,,os.fork()}.  Any
successful call of @ref{33a7,,RAND_add()} or @ref{5c7,,RAND_bytes()} is
sufficient.

@node TLS 1 3,,Consideraciones de seguridad<2>,ssl — TLS/SSL wrapper for socket objects
@anchor{library/ssl ssl-tlsv1-3}@anchor{c08}@anchor{library/ssl tls-1-3}@anchor{3404}
@subsubsection TLS 1.3



Added in version 3.7.


Python tiene soporte provisional y experimental para TLS 1.3 con OpenSSL 1.1.1. El nuevo protocolo se comporta de forma ligeramente diferente a la versión anterior de TLS/SSL. Algunas de las nuevas características de TLS 1.3 aún no están disponibles.


@itemize -

@item 
TLS 1.3 utiliza un conjunto disjunto de suites de cifrado. Todas las suites de cifrado AES-GCM y ChaCha20 están habilitadas por defecto.  El método @ref{33de,,SSLContext.set_ciphers()} aún no puede habilitar o deshabilitar ningún cifrado de TLS 1.3, pero @ref{d65,,SSLContext.get_ciphers()} los retorna.

@item 
Los tickets de sesión ya no se envían como parte del handshake inicial y se manejan de forma diferente. @ref{15d4,,SSLSocket.session} y @ref{d64,,SSLSession} no son compatibles con TLS 1.3.

@item 
Los certificados del lado del cliente ya no se verifican durante el handshake inicial. Un servidor puede solicitar un certificado en cualquier momento. Los clientes procesan las solicitudes de certificados mientras envían o reciben datos de la aplicación desde el servidor.

@item 
Las funciones de TLS 1.3, como los datos anticipados, la solicitud de certificado de cliente TLS diferida, la configuración del algoritmo de firma y la repetición de claves, aún no son compatibles.
@end itemize


@subsubheading Ver también



@table @asis

@item Clase @ref{e27,,socket.socket}

Documentación de la clase @ref{cc,,socket} subyacente

@item SSL/TLS Strong Encryption: An Introduction@footnote{https://httpd.apache.org/docs/trunk/en/ssl/ssl_intro.html}

Introducción de la documentación del servidor HTTP Apache

@geindex RFC; RFC 1422

@item RFC 1422: Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management@footnote{https://datatracker.ietf.org/doc/html/rfc1422.html}

Steve Kent

@geindex RFC; RFC 4086

@item RFC 4086: Randomness Requirements for Security@footnote{https://datatracker.ietf.org/doc/html/rfc4086.html}

Donald E., Jeffrey I. Schiller

@geindex RFC; RFC 5280

@item RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}

D. Cooper

@geindex RFC; RFC 5246

@item RFC 5246: The Transport Layer Security (TLS) Protocol Version 1.2@footnote{https://datatracker.ietf.org/doc/html/rfc5246.html}

T. Dierks et. al.

@geindex RFC; RFC 6066

@item RFC 6066: Transport Layer Security (TLS) Extensions@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html}

D. Eastlake

@item IANA TLS: Transport Layer Security (TLS) Parameters@footnote{https://www.iana.org/assignments/tls-parameters/tls-parameters.xml}

IANA

@geindex RFC; RFC 7525

@item RFC 7525: Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)@footnote{https://datatracker.ietf.org/doc/html/rfc7525.html}

IETF

@item Mozilla's Server Side TLS recommendations@footnote{https://wiki.mozilla.org/Security/Server_Side_TLS}

Mozilla
@end table


@node select — Waiting for I/O completion,selectors — High-level I/O multiplexing,ssl — TLS/SSL wrapper for socket objects,Comunicación en redes y entre procesos
@anchor{library/select doc}@anchor{3405}@anchor{library/select module-select}@anchor{c1}@anchor{library/select select-waiting-for-i-o-completion}@anchor{3406}
@subsection @code{select} — Waiting for I/O completion


@geindex module; select


__________________________________________________________________


This module provides access to the @code{select()} and @code{poll()} functions
available in most operating systems, @code{devpoll()} available on
Solaris and derivatives, @code{epoll()} available on Linux 2.5+ and
@code{kqueue()} available on most BSD.
Note that on Windows, it only works for sockets; on other operating systems,
it also works for other file types (in particular, on Unix, it works on pipes).
It cannot be used on regular files to determine whether a file has grown since
it was last read.

@cartouche
@quotation Nota 
El módulo @ref{c2,,selectors} permite la multiplexación de E/S de alto nivel y eficiente, construida sobre las primitivas del módulo @ref{c1,,select}. Se alienta a los usuarios a utilizar el módulo @ref{c2,,selectors} en su lugar, a menos que quieran un control preciso sobre las primitivas utilizadas de nivel OS.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo define lo siguiente:

@geindex error
@anchor{library/select select error}@anchor{10d2}
@deffn {Excepción} select.error

Un alias en desuso de @ref{4d5,,OSError}.


Distinto en la versión 3.3: Siguiente 
@geindex Python Enhancement Proposals; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}, esta clase se convirtió en un alias de @ref{4d5,,OSError}.

@end deffn

@geindex devpoll() (en el módulo select)
@anchor{library/select select devpoll}@anchor{1014}
@deffn {Función} select.devpoll ()

(Solo se admite en Solaris y derivados). Retorna un objeto de sondeo @code{/dev/poll}; vea la sección @ref{3407,,Objetos de sondeo /dev/poll} a continuación para conocer los métodos admitidos por los objetos `devpoll'.

@code{devpoll()} objects are linked to the number of file
descriptors allowed at the time of instantiation. If your program
reduces this value, @code{devpoll()} will fail. If your program
increases this value, @code{devpoll()} may return an
incomplete list of active file descriptors.

El nuevo descriptor del archivo es @ref{f7c,,non-inheritable}.


Added in version 3.3.



Distinto en la versión 3.4: El nuevo descriptor de archivo ahora no es heredable.

@end deffn

@geindex epoll() (en el módulo select)
@anchor{library/select select epoll}@anchor{1012}
@deffn {Función} select.epoll (sizehint=-1, flags=0)

(Solo se admite en Linux 2.5.44 y versiones posteriores). Retorna un objeto de sondeo de borde, que se puede usar como interfaz de disparo de nivel o de borde para eventos de E/S.

`sizehint' informs epoll about the expected number of events to be
registered.  It must be positive, or @code{-1} to use the default. It is only
used on older systems where @code{epoll_create1()} is not available;
otherwise it has no effect (though its value is still checked).

`flags' está en desuso y se ignora por completo. Sin embargo, cuando se proporciona, su valor debe ser @code{0} o @code{select.EPOLL_CLOEXEC}, de lo contrario, se lanzará @code{OSError}.

Consulte la sección @ref{3408,,Objetos de sondeo de Edge y Level Trigger (epoll)} a continuación para conocer los métodos admitidos por los objetos epolling.

Los objetos @code{epoll} admiten el protocolo `context management': cuando se usa en una declaración @ref{673,,with}, el nuevo descriptor de archivo se cierra automáticamente al final del bloque.

El nuevo descriptor del archivo es @ref{f7c,,non-inheritable}.


Distinto en la versión 3.3: Se agregó el parámetro `flags'.



Distinto en la versión 3.4: Se agregó soporte para la declaración @ref{673,,with}. El nuevo descriptor de archivo ahora no es heredable.



Obsoleto desde la versión 3.4: El parámetro `flags'. @code{select.EPOLL_CLOEXEC} se usa por defecto ahora. Use @ref{f7e,,os.set_inheritable()} para hacer que el descriptor de archivo sea heredable.

@end deffn

@geindex poll() (en el módulo select)
@anchor{library/select select poll}@anchor{2bb2}
@deffn {Función} select.poll ()

(No es compatible con todos los sistemas operativos). Retorna un objeto de sondeo, que admite registrar y anular el registro de descriptores de archivo, y luego sondearlos para eventos de I/O; vea la sección @ref{3409,,Sondeo de objetos} a continuación para conocer los métodos admitidos por los objetos de sondeo.
@end deffn

@geindex kqueue() (en el módulo select)
@anchor{library/select select kqueue}@anchor{16d7}
@deffn {Función} select.kqueue ()

(Solo se admite en BSD). Retorna un objeto de cola del kernel; vea la sección @ref{340a,,Objetos Kqueue} a continuación para conocer los métodos admitidos por los objetos kqueue.

El nuevo descriptor del archivo es @ref{f7c,,non-inheritable}.


Distinto en la versión 3.4: El nuevo descriptor de archivo ahora no es heredable.

@end deffn

@geindex kevent() (en el módulo select)
@anchor{library/select select kevent}@anchor{340b}
@deffn {Función} select.kevent (ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

(Solo se admite en BSD). Retorna un objeto de evento del kernel; vea la sección @ref{340c,,Objetos Kevent} a continuación para conocer los métodos admitidos por los objetos kevent.
@end deffn

@geindex select() (en el módulo select)
@anchor{library/select select select}@anchor{e26}
@deffn {Función} select.select (rlist, wlist, xlist[, timeout])

This is a straightforward interface to the Unix @code{select()} system call.
The first three arguments are iterables of “waitable objects”: either
integers representing file descriptors or objects with a parameterless method
named @ref{2848,,fileno()} returning such an integer:


@itemize *

@item 
`rlist': espera hasta que esté listo para leer

@item 
`wlist': espera hasta que esté listo para escribir

@item 
`xlist': espera una «condición excepcional» (consulte la página del manual para ver lo que su sistema considera tal condición)
@end itemize

Empty iterables are allowed, but acceptance of three empty iterables is
platform-dependent. (It is known to work on Unix but not on Windows.)  The
optional `timeout' argument specifies a time-out as a floating-point number
in seconds.  When the `timeout' argument is omitted the function blocks until
at least one file descriptor is ready.  A time-out value of zero specifies a
poll and never blocks.

El valor de retorno es un triple de listas de objetos que están listos: subconjuntos de los primeros tres argumentos. Cuando se alcanza el tiempo de espera sin que esté listo un descriptor de archivo, se retornan tres listas vacías.

@geindex socket() (in module socket)
@geindex popen() (in module os)

Entre los tipos de objetos aceptables en los iterables se encuentran Python @ref{1230,,objetos de archivo} (por ejemplo, @code{sys.stdin}, u objetos retornados por @ref{1be,,open()} o @ref{1c5,,os.popen()} ), objetos de socket retornados por @ref{e27,,socket.socket()}. También puede definir una clase `wrapper' usted mismo, siempre que tenga un método @ref{2848,,fileno()} apropiado (que realmente retorne un descriptor de archivo, no solo un entero aleatorio).

@cartouche
@quotation Nota 
@geindex WinSock

File objects on Windows are not acceptable, but sockets are.  On Windows,
the underlying @code{select()} function is provided by the WinSock
library, and does not handle file descriptors that don’t originate from
WinSock.
@end quotation
@end cartouche


Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (`timeout') recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de generar @ref{e0e,,InterruptedError}.

@end deffn

@geindex PIPE_BUF (en el módulo select)
@anchor{library/select select PIPE_BUF}@anchor{1277}
@deffn {Atributo} select.PIPE_BUF

The minimum number of bytes which can be written without blocking to a pipe
when the pipe has been reported as ready for writing by @ref{e26,,select()},
@code{poll()} or another interface in this module.  This doesn’t apply
to other kind of file-like objects such as sockets.

Este valor es garantizado por POSIX para ser menor a 512.

@ref{1d5a,,Availability}: Unix


Added in version 3.2.

@end deffn

@menu
* Objetos de sondeo /dev/poll:: 
* Objetos de sondeo de Edge y Level Trigger (epoll): Objetos de sondeo de Edge y Level Trigger epoll. 
* Sondeo de objetos:: 
* Objetos Kqueue:: 
* Objetos Kevent:: 

@end menu

@node Objetos de sondeo /dev/poll,Objetos de sondeo de Edge y Level Trigger epoll,,select — Waiting for I/O completion
@anchor{library/select dev-poll-polling-objects}@anchor{340d}@anchor{library/select devpoll-objects}@anchor{3407}
@subsubsection Objetos de sondeo @code{/dev/poll}


Solaris and derivatives have @code{/dev/poll}. While @code{select()} is
`O'(`highest file descriptor') and @code{poll()} is `O'(`number of file
descriptors'), @code{/dev/poll} is `O'(`active file descriptors').

@code{/dev/poll} behaviour is very close to the standard @code{poll()}
object.

@geindex close() (método de select.devpoll)
@anchor{library/select select devpoll close}@anchor{1016}
@deffn {Método} devpoll.close ()

Cierra el descriptor de archivo del objeto de sondeo.


Added in version 3.4.

@end deffn

@geindex closed (atributo de select.devpoll)
@anchor{library/select select devpoll closed}@anchor{1017}
@deffn {Atributo} devpoll.closed

@code{True} si el objeto de sondeo está cerrado.


Added in version 3.4.

@end deffn

@geindex fileno() (método de select.devpoll)
@anchor{library/select select devpoll fileno}@anchor{1015}
@deffn {Método} devpoll.fileno ()

Retorna el número de descriptor de archivo del objeto de sondeo.


Added in version 3.4.

@end deffn

@geindex register() (método de select.devpoll)
@anchor{library/select select devpoll register}@anchor{340e}
@deffn {Método} devpoll.register (fd[, eventmask])

Registra un descriptor de archivo con el objeto de sondeo. Las futuras llamadas al método @ref{2bb2,,poll()} comprobarán si el descriptor del archivo tiene algún evento I/O pendiente. `fd' puede ser un entero o un objeto con un método @ref{2848,,fileno()} que retorna un entero. Los objetos de archivo implementan @code{Fileno()}, por lo que también pueden usarse como argumento.

`eventmask' is an optional bitmask describing the type of events you want to
check for. The constants are the same that with @code{poll()}
object. The default value is a combination of the constants @code{POLLIN},
@code{POLLPRI}, and @code{POLLOUT}.

@cartouche
@quotation Advertencia 
Registering a file descriptor that’s already registered is not an
error, but the result is undefined. The appropriate action is to
unregister or modify it first. This is an important difference
compared with @code{poll()}.
@end quotation
@end cartouche
@end deffn

@geindex modify() (método de select.devpoll)
@anchor{library/select select devpoll modify}@anchor{340f}
@deffn {Método} devpoll.modify (fd[, eventmask])

Este método hace un @ref{3410,,unregister()} seguido de a @ref{340e,,register()}. Es (un poco) más eficiente que hacer lo mismo explícitamente.
@end deffn

@geindex unregister() (método de select.devpoll)
@anchor{library/select select devpoll unregister}@anchor{3410}
@deffn {Método} devpoll.unregister (fd)

Elimina un descriptor de archivo que está siendo rastreado por un objeto de sondeo. Al igual que el método @ref{340e,,register()}, `fd' puede ser un entero o un objeto con un método @ref{2848,,fileno()} que retorna un entero.

Al intentar eliminar un descriptor de archivo que nunca se registró se ignora de forma segura.
@end deffn

@geindex poll() (método de select.devpoll)
@anchor{library/select select devpoll poll}@anchor{e22}
@deffn {Método} devpoll.poll ([timeout])

Sondea el conjunto de descriptores de archivos registrados y retorna una lista posiblemente vacía que contiene tuplas de dos elementos @code{(fd, event)} para los descriptores que tienen eventos o errores para informar. `fd' es el descriptor de archivo, y `event' es una máscara de bits con bits configurados para los eventos informados para ese descriptor — @code{POLLIN} para entrada en espera, @code{POLLOUT} para indicar que se puede escribir en el descriptor, y así sucesivamente. Una lista vacía indica que se agotó el tiempo de espera de la llamada y que ningún descriptor de archivo tuvo eventos para informar. Si se proporciona `timeout', especifica el período de tiempo en milisegundos que el sistema esperará por los eventos antes de regresar. Si se omite `timeout', -1 o @ref{716,,None}, la llamada se bloqueará hasta que haya un evento para este objeto de sondeo.


Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (`timeout') recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de generar @ref{e0e,,InterruptedError}.

@end deffn

@node Objetos de sondeo de Edge y Level Trigger epoll,Sondeo de objetos,Objetos de sondeo /dev/poll,select — Waiting for I/O completion
@anchor{library/select edge-and-level-trigger-polling-epoll-objects}@anchor{3411}@anchor{library/select epoll-objects}@anchor{3408}
@subsubsection Objetos de sondeo de `Edge' y `Level Trigger' (`epoll')


@quotation

@indicateurl{https://linux.die.net/man/4/epoll}

`eventmask'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{EPOLLIN}

@tab

Disponible para lectura

@item

@code{EPOLLOUT}

@tab

Disponible para escritura

@item

@code{EPOLLPRI}

@tab

Urgente para lectura

@item

@code{EPOLLERR}

@tab

La condición de error ocurrió en la asociación. fd

@item

@code{EPOLLHUP}

@tab

Se colgó en la asociación. fd

@item

@code{EPOLLET}

@tab

Establece el comportamiento en `Edge Trigger', el valor predeterminado es `Level Trigger'

@item

@code{EPOLLONESHOT}

@tab

Establece el comportamiento en `one-shot'. Después de que se retira un evento, el fd se deshabilita internamente

@item

@code{EPOLLEXCLUSIVE}

@tab

Despierta solo un objeto epoll cuando el fd asociado tiene un evento. El valor predeterminado (si este flag no está configurado) es activar todos los objetos epoll que sondean en un fd.

@item

@code{EPOLLRDHUP}

@tab

Socket de flujo de conexión cerrada por pares o apagado escribiendo la mitad de la conexión.

@item

@code{EPOLLRDNORM}

@tab

Equivalente a @code{EPOLLIN}

@item

@code{EPOLLRDBAND}

@tab

La banda de datos de prioridad se puede leer.

@item

@code{EPOLLWRNORM}

@tab

Equivalente a @code{EPOLLOUT}

@item

@code{EPOLLWRBAND}

@tab

Se pueden escribir datos de prioridad.

@item

@code{EPOLLMSG}

@tab

Ignorado.

@end multitable



Added in version 3.6: @code{EPOLLEXCLUSIVE} fue agregado. Solo es compatible con Linux Kernel 4.5 o posterior.

@end quotation

@geindex close() (método de select.epoll)
@anchor{library/select select epoll close}@anchor{1013}
@deffn {Método} epoll.close ()

Cierra el descriptor del archivo de control del objeto epoll.
@end deffn

@geindex closed (atributo de select.epoll)
@anchor{library/select select epoll closed}@anchor{3412}
@deffn {Atributo} epoll.closed

@code{True} si el objeto epoll está cerrado.
@end deffn

@geindex fileno() (método de select.epoll)
@anchor{library/select select epoll fileno}@anchor{3413}
@deffn {Método} epoll.fileno ()

Retorna el número de descriptor de archivo del control fd.
@end deffn

@geindex fromfd() (método de select.epoll)
@anchor{library/select select epoll fromfd}@anchor{3414}
@deffn {Método} epoll.fromfd (fd)

Crea un objeto epoll a partir de un descriptor de archivo dado.
@end deffn

@geindex register() (método de select.epoll)
@anchor{library/select select epoll register}@anchor{3415}
@deffn {Método} epoll.register (fd[, eventmask])

Registra un descriptor fd con el objeto epoll.
@end deffn

@geindex modify() (método de select.epoll)
@anchor{library/select select epoll modify}@anchor{3416}
@deffn {Método} epoll.modify (fd, eventmask)

Modifica un descriptor de archivo registrado.
@end deffn

@geindex unregister() (método de select.epoll)
@anchor{library/select select epoll unregister}@anchor{9ed}
@deffn {Método} epoll.unregister (fd)

Elimina un descriptor de archivo registrado del objeto epoll.


Distinto en la versión 3.9: El método ya no ignora el error @ref{9ee,,EBADF}.

@end deffn

@geindex poll() (método de select.epoll)
@anchor{library/select select epoll poll}@anchor{e23}
@deffn {Método} epoll.poll (timeout=None, maxevents=-1)

Espera los eventos. tiempo de espera (`timeout') en segundos (float)


Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (`timeout') recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de generar @ref{e0e,,InterruptedError}.

@end deffn

@node Sondeo de objetos,Objetos Kqueue,Objetos de sondeo de Edge y Level Trigger epoll,select — Waiting for I/O completion
@anchor{library/select poll-objects}@anchor{3409}@anchor{library/select polling-objects}@anchor{3417}
@subsubsection Sondeo de objetos


The @code{poll()} system call, supported on most Unix systems, provides better
scalability for network servers that service many, many clients at the same
time. @code{poll()} scales better because the system call only requires listing
the file descriptors of interest, while @code{select()} builds a bitmap, turns
on bits for the fds of interest, and then afterward the whole bitmap has to be
linearly scanned again. @code{select()} is `O'(`highest file descriptor'), while
@code{poll()} is `O'(`number of file descriptors').

@geindex register() (método de select.poll)
@anchor{library/select select poll register}@anchor{3418}
@deffn {Método} poll.register (fd[, eventmask])

Registra un descriptor de archivo con el objeto de sondeo. Las futuras llamadas al método @ref{2bb2,,poll()} comprobarán si el descriptor del archivo tiene algún evento I/O pendiente. `fd' puede ser un entero o un objeto con un método @ref{2848,,fileno()} que retorna un entero. Los objetos de archivo implementan @code{Fileno()}, por lo que también pueden usarse como argumento.

`eventmask' es una máscara de bits opcional que describe el tipo de eventos que se desea verificar y puede ser una combinación de las constantes @code{POLLIN}, @code{POLLPRI}, y @code{POLLOUT}, descrito en la mesa de abajo. Si no se especifica, el valor predeterminado utilizado verificará los 3 tipos de eventos.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{POLLIN}

@tab

Hay datos para leer

@item

@code{POLLPRI}

@tab

Hay datos urgentes para leer

@item

@code{POLLOUT}

@tab

Lista para la salida: la escritura no bloqueará

@item

@code{POLLERR}

@tab

Condición de error de algún tipo

@item

@code{POLLHUP}

@tab

Colgado

@item

@code{POLLRDHUP}

@tab

Socket de flujo de conexión cerrada por pares, o apagado escribiendo la mitad de la conexión

@item

@code{POLLNVAL}

@tab

Solicitud no válida: descriptor no abierto

@end multitable


Al registrar un descriptor de archivo que ya está registrado no es un error y tiene el mismo efecto que registrar el descriptor exactamente una vez.
@end deffn

@geindex modify() (método de select.poll)
@anchor{library/select select poll modify}@anchor{3419}
@deffn {Método} poll.modify (fd, eventmask)

Modifica un fd ya registrado. Esto tiene el mismo efecto que @code{register(fd, eventmask)}. Si se intenta modificar un descriptor de archivo que nunca se registró, se genera una excepción @ref{4d5,,OSError} con `errno' @code{ENOENT}.
@end deffn

@geindex unregister() (método de select.poll)
@anchor{library/select select poll unregister}@anchor{341a}
@deffn {Método} poll.unregister (fd)

Elimina un descriptor de archivo que está siendo rastreado por un objeto de sondeo. Al igual que el método @ref{3418,,register()}, `fd' puede ser un entero o un objeto con un método @ref{2848,,fileno()} que retorna un entero.

Intenta eliminar un descriptor de archivo que nunca se registró provoca una excepción @ref{438,,KeyError}.
@end deffn

@geindex poll() (método de select.poll)
@anchor{library/select select poll poll}@anchor{e25}
@deffn {Método} poll.poll ([timeout])

Sondea el conjunto de descriptores de archivos registrados y retorna una lista posiblemente vacía que contiene tuplas de 2 elementos @code{(fd, event)} para los descriptores que tienen eventos o errores para informar. `fd' es el descriptor de archivo, y `event' es una máscara de bits con bits configurados para los eventos informados para ese descriptor — @code{POLLIN} para entrada en espera, @code{POLLOUT} para indicar que se puede escribir en el descriptor, y así sucesivamente. Una lista vacía indica que se agotó el tiempo de espera de la llamada y que ningún descriptor de archivo tuvo eventos para informar. Si se proporciona `timeout', especifica el período de tiempo en milisegundos que el sistema esperará por los eventos antes de regresar. Si se omite `timeout', es negativo o @ref{716,,None}, la llamada se bloqueará hasta que haya un evento para este objeto de sondeo.


Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (`timeout') recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de generar @ref{e0e,,InterruptedError}.

@end deffn

@node Objetos Kqueue,Objetos Kevent,Sondeo de objetos,select — Waiting for I/O completion
@anchor{library/select id1}@anchor{341b}@anchor{library/select kqueue-objects}@anchor{340a}
@subsubsection Objetos Kqueue


@geindex close() (método de select.kqueue)
@anchor{library/select select kqueue close}@anchor{341c}
@deffn {Método} kqueue.close ()

Cierra el descriptor del archivo de control del objeto kqueue.
@end deffn

@geindex closed (atributo de select.kqueue)
@anchor{library/select select kqueue closed}@anchor{341d}
@deffn {Atributo} kqueue.closed

@code{True} si el objeto `kqueue' está cerrado.
@end deffn

@geindex fileno() (método de select.kqueue)
@anchor{library/select select kqueue fileno}@anchor{341e}
@deffn {Método} kqueue.fileno ()

Retorna el número de descriptor de archivo del control fd.
@end deffn

@geindex fromfd() (método de select.kqueue)
@anchor{library/select select kqueue fromfd}@anchor{341f}
@deffn {Método} kqueue.fromfd (fd)

Crea un objeto `kqueue' a partir de un descriptor de archivo dado.
@end deffn

@geindex control() (método de select.kqueue)
@anchor{library/select select kqueue control}@anchor{e24}
@deffn {Método} kqueue.control (changelist, max_events[, timeout]) -> eventlist

Interfaz de bajo nivel para kevent


@itemize -

@item 
la lista de cambios (`changelist') debe ser iterable de objetos kevent o @code{None}

@item 
max_events debe ser 0 o un entero positivo

@item 
tiempo de espera (`timeout') en segundos (posible con `floats'); el valor predeterminado es @code{None}, para esperar para siempre
@end itemize


Distinto en la versión 3.5: La función ahora se vuelve a intentar con un tiempo de espera (`timeout') recalculado cuando se interrumpe por una señal, excepto si el controlador de señal genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de generar @ref{e0e,,InterruptedError}.

@end deffn

@node Objetos Kevent,,Objetos Kqueue,select — Waiting for I/O completion
@anchor{library/select id2}@anchor{3420}@anchor{library/select kevent-objects}@anchor{340c}
@subsubsection Objetos Kevent


@indicateurl{https://man.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2}

@geindex ident (atributo de select.kevent)
@anchor{library/select select kevent ident}@anchor{3421}
@deffn {Atributo} kevent.ident

Valor utilizado para identificar el evento. La interpretación depende del filtro, pero generalmente es el descriptor de archivo. En el constructor, ident puede ser un int o un objeto con un método @ref{2848,,fileno()}. kevent almacena el entero internamente.
@end deffn

@geindex filter (atributo de select.kevent)
@anchor{library/select select kevent filter}@anchor{3422}
@deffn {Atributo} kevent.filter

Nombre del filtro del kernel.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_FILTER_READ}

@tab

Toma un descriptor y retorna cada vez que hay datos disponibles para leer

@item

@code{KQ_FILTER_WRITE}

@tab

Toma un descriptor y retorna cada vez que hay datos disponibles para escribir

@item

@code{KQ_FILTER_AIO}

@tab

Solicitudes de AIO

@item

@code{KQ_FILTER_VNODE}

@tab

Retorna cuando ocurre uno o más de los eventos solicitados observados en `fflag'

@item

@code{KQ_FILTER_PROC}

@tab

Vigila los eventos en un id de proceso

@item

@code{KQ_FILTER_NETDEV}

@tab

Vigila los eventos en un dispositivo de red [no disponible en macOS]

@item

@code{KQ_FILTER_SIGNAL}

@tab

Retorna cada vez que la señal observada se entrega al proceso

@item

@code{KQ_FILTER_TIMER}

@tab

Establece un temporizador arbitrario

@end multitable

@end deffn

@geindex flags (atributo de select.kevent)
@anchor{library/select select kevent flags}@anchor{3423}
@deffn {Atributo} kevent.flags

Acción de filtro.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_EV_ADD}

@tab

Agrega o modifica un evento

@item

@code{KQ_EV_DELETE}

@tab

Elimina un evento de la cola

@item

@code{KQ_EV_ENABLE}

@tab

Permitscontrol() para retornar el evento

@item

@code{KQ_EV_DISABLE}

@tab

Disablesevent

@item

@code{KQ_EV_ONESHOT}

@tab

Elimina evento después de la primera aparición

@item

@code{KQ_EV_CLEAR}

@tab

Restablece el estado después de recuperar un evento

@item

@code{KQ_EV_SYSFLAGS}

@tab

evento interno

@item

@code{KQ_EV_FLAG1}

@tab

evento interno

@item

@code{KQ_EV_EOF}

@tab

Filtrar la condición específica de EOF

@item

@code{KQ_EV_ERROR}

@tab

Ver valores de retorno

@end multitable

@end deffn

@geindex fflags (atributo de select.kevent)
@anchor{library/select select kevent fflags}@anchor{3424}
@deffn {Atributo} kevent.fflags

Filtrar flags específicas.

@code{KQ_FILTER_READ} y @code{KQ_FILTER_WRITE} bandera de filtro:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_LOWAT}

@tab

marca de agua baja de un `socket buffer'

@end multitable


@code{KQ_FILTER_VNODE} bandera de filtro:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_DELETE}

@tab

`unlink()' fue llamado

@item

@code{KQ_NOTE_WRITE}

@tab

una escritura ha ocurrido

@item

@code{KQ_NOTE_EXTEND}

@tab

el archivo fue extendido

@item

@code{KQ_NOTE_ATTRIB}

@tab

un atributo fue cambiado

@item

@code{KQ_NOTE_LINK}

@tab

el recuento de enlaces ha cambiado

@item

@code{KQ_NOTE_RENAME}

@tab

el archivo fue renombrado

@item

@code{KQ_NOTE_REVOKE}

@tab

se revocó el acceso al archivo

@end multitable


@code{KQ_FILTER_PROC} bandera de filtro:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_EXIT}

@tab

el proceso ha terminado (`exited')

@item

@code{KQ_NOTE_FORK}

@tab

el proceso ha llamado a `fork()'

@item

@code{KQ_NOTE_EXEC}

@tab

el proceso ha ejecutado un nuevo proceso

@item

@code{KQ_NOTE_PCTRLMASK}

@tab

flag de filtro interno

@item

@code{KQ_NOTE_PDATAMASK}

@tab

flag de filtro interno

@item

@code{KQ_NOTE_TRACK}

@tab

sigue un proceso a través de `fork()'

@item

@code{KQ_NOTE_CHILD}

@tab

retornado en el proceso hijo para `NOTE_TRACK'

@item

@code{KQ_NOTE_TRACKERR}

@tab

incapaz de adjuntar a un proceso hijo

@end multitable


Indicadores de filtro @code{KQ_FILTER_NETDEV} (no disponible en macOS):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_LINKUP}

@tab

el enlace está funcionando

@item

@code{KQ_NOTE_LINKDOWN}

@tab

el enlace está caído

@item

@code{KQ_NOTE_LINKINV}

@tab

el estado del enlace es invalido

@end multitable

@end deffn

@geindex data (atributo de select.kevent)
@anchor{library/select select kevent data}@anchor{3425}
@deffn {Atributo} kevent.data

Filtrar datos específicos.
@end deffn

@geindex udata (atributo de select.kevent)
@anchor{library/select select kevent udata}@anchor{3426}
@deffn {Atributo} kevent.udata

Valor definido por el usuario.
@end deffn

@node selectors — High-level I/O multiplexing,signal — Set handlers for asynchronous events,select — Waiting for I/O completion,Comunicación en redes y entre procesos
@anchor{library/selectors doc}@anchor{3427}@anchor{library/selectors module-selectors}@anchor{c2}@anchor{library/selectors selectors-high-level-i-o-multiplexing}@anchor{3428}
@subsection @code{selectors} — High-level I/O multiplexing


@geindex module; selectors


Added in version 3.4.


`Código fuente:' Lib/selectors.py@footnote{https://github.com/python/cpython/tree/main/Lib/selectors.py}


__________________________________________________________________


@menu
* Introducción: Introducción<8>. 
* Clases: Clases<4>. 
* Ejemplos: Ejemplos<19>. 

@end menu

@node Introducción<8>,Clases<4>,,selectors — High-level I/O multiplexing
@anchor{library/selectors introduction}@anchor{3429}
@subsubsection Introducción


Este módulo permite multiplexación de E/S eficiente y de alto nivel, basada en los primitivos del módulo @ref{c1,,select}. Se recomienda a los usuarios utilizar este módulo en su lugar, a menos que deseen un control preciso sobre los primitivos a nivel de sistema operativo utilizados.

It defines a @ref{342a,,BaseSelector} abstract base class, along with several
concrete implementations (@ref{3319,,KqueueSelector}, @ref{c5d,,EpollSelector}…),
that can be used to wait for I/O readiness notification on multiple file
objects. In the following, «file object» refers to any object with a
@ref{2848,,fileno()} method, or a raw file descriptor. See @ref{1230,,file object}.

@ref{342b,,DefaultSelector} es un alias de la implementación más eficiente disponible en la plataforma actual: esta debería ser la opción predeterminada para la mayoría de los usuarios.

@cartouche
@quotation Nota 
El tipo de objetos de archivo admitidos depende de la plataforma: en Windows, se admiten sockets, pero no `pipes', mientras que en Unix, ambos son compatibles (también se pueden admitir algunos otros tipos, como FIFOs o dispositivos de archivo especiales).
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item @ref{c1,,select}

Módulo de multiplexación de E/S de bajo nivel.
@end table


@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@node Clases<4>,Ejemplos<19>,Introducción<8>,selectors — High-level I/O multiplexing
@anchor{library/selectors classes}@anchor{342c}
@subsubsection Clases


Jerarquía de clases:

@example
BaseSelector
+-- SelectSelector
+-- PollSelector
+-- EpollSelector
+-- DevpollSelector
+-- KqueueSelector
@end example

De aquí en adelante, `events' es una máscara bit a bit que indica qué eventos de E/S se deben esperar en un objeto de archivo determinado. Puede ser cualquier combinación de las siguientes constantes de módulo:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@geindex EVENT_READ (en el módulo selectors)
@anchor{library/selectors selectors EVENT_READ}@anchor{342d}
@deffn {Dato} selectors.EVENT_READ
@end deffn

@tab

Disponible para lectura

@item

@geindex EVENT_WRITE (en el módulo selectors)
@anchor{library/selectors selectors EVENT_WRITE}@anchor{342e}
@deffn {Dato} selectors.EVENT_WRITE
@end deffn

@tab

Disponible para escritura

@end multitable

@end quotation

@geindex SelectorKey (clase en selectors)
@anchor{library/selectors selectors SelectorKey}@anchor{342f}
@deffn {Clase} selectors.SelectorKey

La clase @ref{342f,,SelectorKey} es una @ref{32d,,namedtuple} que se utiliza para asociar un objeto de archivo a su descriptor de archivo subyacente, máscara de evento seleccionada y datos adjuntos. Es retornada por varios métodos @ref{342a,,BaseSelector}.

@geindex fileobj (atributo de selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey fileobj}@anchor{3430}
@deffn {Atributo} fileobj

Objeto de archivo registrado.
@end deffn

@geindex fd (atributo de selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey fd}@anchor{3431}
@deffn {Atributo} fd

Descriptor de archivo subyacente.
@end deffn

@geindex events (atributo de selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey events}@anchor{3432}
@deffn {Atributo} events

Eventos que se deben esperar en este objeto de archivo.
@end deffn

@geindex data (atributo de selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey data}@anchor{3433}
@deffn {Atributo} data

Datos opacos opcionales asociados a este objeto de archivo: por ejemplo, podría usarse para almacenar un ID de sesión por cliente.
@end deffn
@end deffn

@geindex BaseSelector (clase en selectors)
@anchor{library/selectors selectors BaseSelector}@anchor{342a}
@deffn {Clase} selectors.BaseSelector

Un @ref{342a,,BaseSelector} se usa para esperar a que el evento de E/S esté listo en varios objetos de archivo. Admite el registro y la cancelación del registro de secuencias de archivos y un método para esperar eventos de E/S en esas secuencias, con un tiempo de espera opcional. Es una clase base abstracta, por lo que no se puede crear una instancia. Use @ref{342b,,DefaultSelector} en su lugar, o un @ref{3316,,SelectSelector}, @ref{3319,,KqueueSelector}, etc. si deseas usar específicamente una implementación y su plataforma la admite. @ref{342a,,BaseSelector} y sus implementaciones concretas soportan el protocolo @ref{675,,context manager}.

@geindex register() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector register}@anchor{3434}
@deffn {Método} abstractmethod register (fileobj, events, data=None)

Registra un objeto de archivo para su selección y lo monitoriza en busca de eventos de E/S.

`fileobj' es el objeto de archivo a monitorear.  Puede ser un descriptor de archivo de tipo entero o un objeto con un método @code{fileno()}. `events' es una máscara bit a bit de eventos para monitorear. `data' es un objeto opaco.

Esto retorna una nueva instancia @ref{342f,,SelectorKey}, o lanza un @ref{360,,ValueError} en caso de una máscara de evento o un descriptor de archivo no válidos, o @ref{438,,KeyError} si el objeto de archivo ya está registrado.
@end deffn

@geindex unregister() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector unregister}@anchor{3435}
@deffn {Método} abstractmethod unregister (fileobj)

Anula el registro de un objeto de archivo de la selección y lo elimina del monitoreo. Se anulará el registro de un objeto de archivo antes de cerrarlo.

`fileobj' debe ser un objeto de archivo previamente registrado.

Esto retorna la instancia @ref{342f,,SelectorKey} asociada, o lanza un @ref{438,,KeyError} si `fileobj' no está registrado. Se lanzará un @ref{360,,ValueError} si `fileobj' no es válido (por ejemplo, no tiene el método @code{fileno ()} o su método @code{fileno ()} tiene un valor de retorno no válido).
@end deffn

@geindex modify() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector modify}@anchor{c5c}
@deffn {Método} modify (fileobj, events, data=None)

Cambia los eventos monitorizados de un objeto de archivo registrado o los datos adjuntos.

This is equivalent to @code{BaseSelector.unregister(fileobj)} followed
by @code{BaseSelector.register(fileobj, events, data)}, except that it
can be implemented more efficiently.

Esto retorna una nueva instancia de @ref{342f,,SelectorKey}, o lanza un @ref{360,,ValueError} en caso de una máscara de evento o un descriptor de archivo no válidos, o @ref{438,,KeyError} si el objeto de archivo no está registrado.
@end deffn

@geindex select() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector select}@anchor{3436}
@deffn {Método} abstractmethod select (timeout=None)

Espera hasta que algunos objetos de archivo registrados estén listos o el tiempo de espera expire.

Si @code{timeout > 0}, esto especifica el tiempo máximo de espera, en segundos. Si @code{timeout <= 0}, la llamada no se bloqueará y reportará los objetos de archivo actualmente listos. Si `timeout' es @code{None}, la llamada se bloqueará hasta que un objeto de archivo monitorizado esté listo.

Retorna una lista de tuplas @code{(key, events)}, una por cada objeto de archivo listo.

`key' es la instancia @ref{342f,,SelectorKey} correspondiente a un objeto de archivo listo. `events' es una máscara de bits de eventos listos en este objeto de archivo.

@cartouche
@quotation Nota 
Este método puede regresar antes de que cualquier objeto de archivo esté listo o haya transcurrido el tiempo de espera si el proceso actual recibe una señal: en este caso, se retornará una lista vacía.
@end quotation
@end cartouche


Distinto en la versión 3.5: El selector ahora se reintenta con un tiempo de espera recalculado cuando es interrumpido por una señal si el gestor de señales no lanzó una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación), en lugar de retornar una lista vacía de eventos antes del tiempo de espera.

@end deffn

@geindex close() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector close}@anchor{3437}
@deffn {Método} close ()

Cierra el selector.

Se debe llamar para asegurarse de que se libera cualquier recurso subyacente. El selector no se utilizará una vez cerrado.
@end deffn

@geindex get_key() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector get_key}@anchor{3438}
@deffn {Método} get_key (fileobj)

Retorna la clave asociada con un objeto de archivo registrado.

Esto retorna la instancia @ref{342f,,SelectorKey} asociada a este objeto de archivo, o lanza un @ref{438,,KeyError} si el objeto de archivo no está registrado.
@end deffn

@geindex get_map() (método de selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector get_map}@anchor{3439}
@deffn {Método} abstractmethod get_map ()

Retorna un mapeo asociando objetos de archivo a las llaves del selector.

Retorna una instancia de @ref{961,,Mapping} mapeando objetos de archivo registrados a su instancia @ref{342f,,SelectorKey} asociada.
@end deffn
@end deffn

@geindex DefaultSelector (clase en selectors)
@anchor{library/selectors selectors DefaultSelector}@anchor{342b}
@deffn {Clase} selectors.DefaultSelector

La clase de selector predeterminada, utiliza la implementación más eficiente disponible en la plataforma actual. Esta debería ser la opción predeterminada para la mayoría de los usuarios.
@end deffn

@geindex SelectSelector (clase en selectors)
@anchor{library/selectors selectors SelectSelector}@anchor{3316}
@deffn {Clase} selectors.SelectSelector

Selector basado en @ref{e26,,select.select()}.
@end deffn

@geindex PollSelector (clase en selectors)
@anchor{library/selectors selectors PollSelector}@anchor{c5e}
@deffn {Clase} selectors.PollSelector

Selector basado en @ref{2bb2,,select.poll()}.
@end deffn

@geindex EpollSelector (clase en selectors)
@anchor{library/selectors selectors EpollSelector}@anchor{c5d}
@deffn {Clase} selectors.EpollSelector

Selector basado en @ref{1012,,select.epoll()}.

@geindex fileno() (método de selectors.EpollSelector)
@anchor{library/selectors selectors EpollSelector fileno}@anchor{343a}
@deffn {Método} fileno ()

Esto retorna el descriptor de archivo utilizado por el objeto @ref{1012,,select.epoll()} subyacente.
@end deffn
@end deffn

@geindex DevpollSelector (clase en selectors)
@anchor{library/selectors selectors DevpollSelector}@anchor{c5f}
@deffn {Clase} selectors.DevpollSelector

Selector basado en @ref{1014,,select.devpoll()}.

@geindex fileno() (método de selectors.DevpollSelector)
@anchor{library/selectors selectors DevpollSelector fileno}@anchor{343b}
@deffn {Método} fileno ()

Esto retorna el descriptor de archivo utilizado por el objeto @ref{1014,,select.devpoll()} subyacente.
@end deffn


Added in version 3.5.

@end deffn

@geindex KqueueSelector (clase en selectors)
@anchor{library/selectors selectors KqueueSelector}@anchor{3319}
@deffn {Clase} selectors.KqueueSelector

Selector basado en @ref{16d7,,select.kqueue()}.

@geindex fileno() (método de selectors.KqueueSelector)
@anchor{library/selectors selectors KqueueSelector fileno}@anchor{343c}
@deffn {Método} fileno ()

Esto retorna el descriptor de archivo utilizado por el objeto @ref{16d7,,select.kqueue()} subyacente.
@end deffn
@end deffn

@node Ejemplos<19>,,Clases<4>,selectors — High-level I/O multiplexing
@anchor{library/selectors examples}@anchor{343d}
@subsubsection Ejemplos


Aquí hay una implementación simple de un servidor de eco:

@example
import selectors
import socket

sel = selectors.DefaultSelector()

def accept(sock, mask):
    conn, addr = sock.accept()  # Should be ready
    print('accepted', conn, 'from', addr)
    conn.setblocking(False)
    sel.register(conn, selectors.EVENT_READ, read)

def read(conn, mask):
    data = conn.recv(1000)  # Should be ready
    if data:
        print('echoing', repr(data), 'to', conn)
        conn.send(data)  # Hope it won't block
    else:
        print('closing', conn)
        sel.unregister(conn)
        conn.close()

sock = socket.socket()
sock.bind(('localhost', 1234))
sock.listen(100)
sock.setblocking(False)
sel.register(sock, selectors.EVENT_READ, accept)

while True:
    events = sel.select()
    for key, mask in events:
        callback = key.data
        callback(key.fileobj, mask)
@end example

@node signal — Set handlers for asynchronous events,mmap — Memory-mapped file support,selectors — High-level I/O multiplexing,Comunicación en redes y entre procesos
@anchor{library/signal doc}@anchor{343e}@anchor{library/signal module-signal}@anchor{c6}@anchor{library/signal signal-set-handlers-for-asynchronous-events}@anchor{343f}
@subsection @code{signal} — Set handlers for asynchronous events


@geindex module; signal

`Código fuente:' Lib/signal.py@footnote{https://github.com/python/cpython/tree/main/Lib/signal.py}


__________________________________________________________________


Este módulo proporciona mecanismos para usar gestores de señales en Python.

@menu
* Reglas generales:: 
* Contenidos del módulo: Contenidos del módulo<3>. 
* Ejemplos: Ejemplos<20>. 
* Nota sobre SIGPIPE:: 
* Nota sobre Manejadores de Señales y Excepciones:: 

@end menu

@node Reglas generales,Contenidos del módulo<3>,,signal — Set handlers for asynchronous events
@anchor{library/signal general-rules}@anchor{3440}
@subsubsection Reglas generales


La función @ref{11a6,,signal.signal()} permite definir gestores personalizados que serán ejecutados cuando una señal es recibida. Un pequeño número de gestores por defecto son instalados: @ref{3441,,SIGPIPE} es ignorada (por lo que los errores de escritura en tuberías y sockets se pueden informar como excepciones ordinarias de Python) y @ref{8db,,SIGINT} es trasladada en una excepción @ref{a63,,KeyboardInterrupt} si el proceso padre no lo ha cambiado.

El gestor para una señal en particular, una vez establecido, continua instalado hasta que se resetea explícitamente (Python emula el estilo de interfaz BSD independientemente de la implementación subyacente), con la excepción del gestor para @ref{2bed,,SIGCHLD}, que sigue la implementación subyacente.

On WebAssembly platforms, signals are emulated and therefore behave
differently. Several functions and signals are not available on these
platforms.

@menu
* Ejecución de los gestores de señales de Python:: 
* Señales e hilos:: 

@end menu

@node Ejecución de los gestores de señales de Python,Señales e hilos,,Reglas generales
@anchor{library/signal execution-of-python-signal-handlers}@anchor{3442}
@subsubsection Ejecución de los gestores de señales de Python


Un gestor de señales de Python no se ejecuta dentro del gestor de señales de bajo nivel (C). En vez de eso, el gestor de señales de bajo nivel establece una señal que le dice al @ref{3443,,virtual machine} que ejecute la correspondiente señal del gestor de Python en una posición posterior (por ejemplo en la próxima instrucción @ref{2f2,,bytecode}). Esto tiene consecuencias:


@itemize *

@item 
Tiene poco sentido detectar errores sincrónicos como @ref{1d50,,SIGFPE} o @ref{1d4f,,SIGSEGV} que son causados por una operación no válida en código C. Python retornará desde el gestor de señales a código C, que es probable que extienda la misma señal otra vez, ocasionando que Python se cuelgue aparentemente. Desde Python 3.3 en adelante, puedes usar el módulo @ref{58,,faulthandler} para reportar errores síncronos.

@item 
Un cálculo de larga duración implementado exclusivamente en C (como una coincidencia de expresiones regulares en un gran cuerpo de texto) puede funcionar interrumpidamente durante una cantidad arbitraria de tiempo, independientemente de las señales recibidas. Los gestores de señales de Python serán llamados cuando el cálculo finalice.

@item 
Si el gestor genera alguna excepción, será lanzada inesperadamente. Vea la @ref{228e,,nota abajo} para discusión.
@end itemize

@node Señales e hilos,,Ejecución de los gestores de señales de Python,Reglas generales
@anchor{library/signal id1}@anchor{3444}@anchor{library/signal signals-and-threads}@anchor{3445}
@subsubsection Señales e hilos


Los gestores de señales de Python se ejecutan siempre en el hilo principal de Python, incluso si la señal fue recibida desde otro hilo. Esto significa que las señales no pueden ser usadas como un medio de comunicación entre hilos. Puedes usar las primitivas de sincronización desde el módulo @ref{ed,,threading} en su lugar.

Además, solo el hilo principal puede configurar un nuevo gestor de señal.

@node Contenidos del módulo<3>,Ejemplos<20>,Reglas generales,signal — Set handlers for asynchronous events
@anchor{library/signal module-contents}@anchor{3446}
@subsubsection Contenidos del módulo



Distinto en la versión 3.5: Las constantes relacionadas con señal (SIG*), gestor (@ref{1828,,SIG_DFL}, @ref{1827,,SIG_IGN}) y sigmask (@ref{3447,,SIG_BLOCK}, @ref{3448,,SIG_UNBLOCK}, @ref{3449,,SIG_SETMASK}) enumeradas a continuación fueron convertidas en @ref{d66,,enums} (@ref{344a,,Signals}, @ref{344b,,Handlers} y @ref{344c,,Sigmasks}, respectivamente). Las funciones @ref{16b5,,getsignal()}, @ref{11a2,,pthread_sigmask()}, @ref{11a4,,sigpending()} y @ref{11a5,,sigwait()} devuelven @ref{d66,,enums} legibles por humanos como objetos @ref{344a,,Signals}.


El módulo signal define tres enums:

@geindex Signals (clase en signal)
@anchor{library/signal signal Signals}@anchor{344a}
@deffn {Clase} signal.Signals

@ref{d66,,enum.IntEnum} colección de constantes SIG* y colección de constantes CTRL_*.


Added in version 3.5.

@end deffn

@geindex Handlers (clase en signal)
@anchor{library/signal signal Handlers}@anchor{344b}
@deffn {Clase} signal.Handlers

@ref{d66,,enum.IntEnum} colección de constantes @ref{1828,,SIG_DFL} y @ref{1827,,SIG_IGN}.


Added in version 3.5.

@end deffn

@geindex Sigmasks (clase en signal)
@anchor{library/signal signal Sigmasks}@anchor{344c}
@deffn {Clase} signal.Sigmasks

@ref{d66,,enum.IntEnum} colección de constantes @ref{3447,,SIG_BLOCK}, @ref{3448,,SIG_UNBLOCK} y @ref{3449,,SIG_SETMASK}.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} y @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} para obtener más información.


Added in version 3.5.

@end deffn

Las variables definidas en el módulo @ref{c6,,signal} son:

@geindex SIG_DFL (en el módulo signal)
@anchor{library/signal signal SIG_DFL}@anchor{1828}
@deffn {Dato} signal.SIG_DFL

Ésta es una de las dos opciones estándar de manejo de señales; simplemente realizará la función predeterminada para la señal. Por ejemplo, en la mayoría de los sistemas, la acción predeterminada para @code{SIGQUIT} es volcar el núcleo y salir, mientras que la acción predeterminada para @ref{2bed,,SIGCHLD} es simplemente ignorarlo.
@end deffn

@geindex SIG_IGN (en el módulo signal)
@anchor{library/signal signal SIG_IGN}@anchor{1827}
@deffn {Dato} signal.SIG_IGN

Este es otro manejador de señales estándar, que simplemente ignorará la señal dada.
@end deffn

@geindex SIGABRT (en el módulo signal)
@anchor{library/signal signal SIGABRT}@anchor{1d51}
@deffn {Dato} signal.SIGABRT

Abortar señal de @code{abort(3)@footnote{https://manpages.debian.org/abort(3)}}.
@end deffn

@geindex SIGALRM (en el módulo signal)
@anchor{library/signal signal SIGALRM}@anchor{344d}
@deffn {Dato} signal.SIGALRM

Señal de temporizador de @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGBREAK (en el módulo signal)
@anchor{library/signal signal SIGBREAK}@anchor{344e}
@deffn {Dato} signal.SIGBREAK

Interrumpir desde el teclado (CTRL + BREAK).

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex SIGBUS (en el módulo signal)
@anchor{library/signal signal SIGBUS}@anchor{1d52}
@deffn {Dato} signal.SIGBUS

Error de bus (mal acceso a la memoria).

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGCHLD (en el módulo signal)
@anchor{library/signal signal SIGCHLD}@anchor{2bed}
@deffn {Dato} signal.SIGCHLD

El proceso hijo se detuvo o terminó.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGCLD (en el módulo signal)
@anchor{library/signal signal SIGCLD}@anchor{344f}
@deffn {Dato} signal.SIGCLD

Alias para @ref{2bed,,SIGCHLD}.

@ref{1d5a,,Availability}: not macOS.
@end deffn

@geindex SIGCONT (en el módulo signal)
@anchor{library/signal signal SIGCONT}@anchor{2bfb}
@deffn {Dato} signal.SIGCONT

Continuar el proceso si está detenido actualmente

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGFPE (en el módulo signal)
@anchor{library/signal signal SIGFPE}@anchor{1d50}
@deffn {Dato} signal.SIGFPE

Excepción de coma flotante. Por ejemplo, división por cero.


@subsubheading Ver también


@ref{9d8,,ZeroDivisionError} se genera cuando el segundo argumento de una operación de división o módulo es cero.

@end deffn

@geindex SIGHUP (en el módulo signal)
@anchor{library/signal signal SIGHUP}@anchor{3450}
@deffn {Dato} signal.SIGHUP

Se detectó un bloqueo en el terminal de control o muerte del proceso de control.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGILL (en el módulo signal)
@anchor{library/signal signal SIGILL}@anchor{1d53}
@deffn {Dato} signal.SIGILL

Instrucción ilegal.
@end deffn

@geindex SIGINT (en el módulo signal)
@anchor{library/signal signal SIGINT}@anchor{8db}
@deffn {Dato} signal.SIGINT

Interrumpir desde el teclado (CTRL + C).

La acción predeterminada es generar @ref{a63,,KeyboardInterrupt}.
@end deffn

@geindex SIGKILL (en el módulo signal)
@anchor{library/signal signal SIGKILL}@anchor{3451}
@deffn {Dato} signal.SIGKILL

Señal de muerte.

No se puede detectar, bloquear ni ignorar.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGPIPE (en el módulo signal)
@anchor{library/signal signal SIGPIPE}@anchor{3441}
@deffn {Dato} signal.SIGPIPE

Tubería rota: escriba en la tubería sin lectores.

La acción predeterminada es ignorar la señal.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGSEGV (en el módulo signal)
@anchor{library/signal signal SIGSEGV}@anchor{1d4f}
@deffn {Dato} signal.SIGSEGV

Fallo de segmentación: referencia de memoria no válida.
@end deffn

@geindex SIGSTKFLT (en el módulo signal)
@anchor{library/signal signal SIGSTKFLT}@anchor{186c}
@deffn {Dato} signal.SIGSTKFLT

@quotation

Fallo en el coprocesador del stack. El kernel de Linux no lanza esta señal,esta sólo puede ser lanzada en el espacio de usuario.
@end quotation

@ref{1d5a,,Availability}: Linux.

En arquitecturas donde la señal está disponible. Consulta la página del manual @code{signal(7)@footnote{https://manpages.debian.org/signal(7)}} para obtener más información.


Added in version 3.11.

@end deffn

@geindex SIGTERM (en el módulo signal)
@anchor{library/signal signal SIGTERM}@anchor{141f}
@deffn {Dato} signal.SIGTERM

Señal de terminación.
@end deffn

@geindex SIGUSR1 (en el módulo signal)
@anchor{library/signal signal SIGUSR1}@anchor{3452}
@deffn {Dato} signal.SIGUSR1

Señal definida por el usuario 1.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGUSR2 (en el módulo signal)
@anchor{library/signal signal SIGUSR2}@anchor{3453}
@deffn {Dato} signal.SIGUSR2

Señal definida por el usuario 2.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex SIGWINCH (en el módulo signal)
@anchor{library/signal signal SIGWINCH}@anchor{3454}
@deffn {Dato} signal.SIGWINCH

Señal de cambio de tamaño de ventana.

@ref{1d5a,,Availability}: Unix.
@end deffn


@deffn {Dato} SIG*

Todos los números de señal se definen simbólicamente. Por ejemplo, la señal de colgar se define como @ref{3450,,signal.SIGHUP}; los nombres de las variables son idénticos a los nombres utilizados en los programas C, como se encuentran en @code{<signal.h>}. La página de manual de Unix para “@code{signal()}” enumera las señales existentes (en algunos sistemas esto es @code{signal(2) `@comma{} en otros la lista está en :manpage:`signal(7)@footnote{https://manpages.debian.org/signal(2) `@comma{} en otros la lista está en :manpage:`signal(7)}} ). Tenga en cuenta que no todos los sistemas definen el mismo conjunto de nombres de señales; Este módulo solo define los nombres definidos por el sistema.
@end deffn

@geindex CTRL_C_EVENT (en el módulo signal)
@anchor{library/signal signal CTRL_C_EVENT}@anchor{13c8}
@deffn {Dato} signal.CTRL_C_EVENT

La señal correspondiente al evento de pulsación de tecla @code{Ctrl + C}. Esta señal solo se puede utilizar con @ref{13c7,,os.kill()}.

@ref{1d5a,,Availability}: Windows.


Added in version 3.2.

@end deffn

@geindex CTRL_BREAK_EVENT (en el módulo signal)
@anchor{library/signal signal CTRL_BREAK_EVENT}@anchor{13c9}
@deffn {Dato} signal.CTRL_BREAK_EVENT

La señal correspondiente al evento de pulsación de tecla @code{Ctrl + Break}. Esta señal solo se puede utilizar con @ref{13c7,,os.kill()}.

@ref{1d5a,,Availability}: Windows.


Added in version 3.2.

@end deffn

@geindex NSIG (en el módulo signal)
@anchor{library/signal signal NSIG}@anchor{1805}
@deffn {Dato} signal.NSIG

Un número más alto que el número más alto de señal. Use @ref{3455,,valid_signals()} para obtener números válidos de señales.
@end deffn

@geindex ITIMER_REAL (en el módulo signal)
@anchor{library/signal signal ITIMER_REAL}@anchor{3456}
@deffn {Dato} signal.ITIMER_REAL

Reduce el temporizador de intervalo en tiempo real y entrega @ref{344d,,SIGALRM} al vencimiento.
@end deffn

@geindex ITIMER_VIRTUAL (en el módulo signal)
@anchor{library/signal signal ITIMER_VIRTUAL}@anchor{3457}
@deffn {Dato} signal.ITIMER_VIRTUAL

Disminuye el temporizador de intervalo solo cuando el proceso se está ejecutando y entrega SIGVTALRM al vencimiento.
@end deffn

@geindex ITIMER_PROF (en el módulo signal)
@anchor{library/signal signal ITIMER_PROF}@anchor{3458}
@deffn {Dato} signal.ITIMER_PROF

Disminuye el temporizador de intervalo tanto cuando se ejecuta el proceso como cuando el sistema se está ejecutando en nombre del proceso. Junto con ITIMER_VIRTUAL, este temporizador generalmente se usa para perfilar el tiempo que pasa la aplicación en el espacio del usuario y del kernel. SIGPROF se entrega al vencimiento.
@end deffn

@geindex SIG_BLOCK (en el módulo signal)
@anchor{library/signal signal SIG_BLOCK}@anchor{3447}
@deffn {Dato} signal.SIG_BLOCK

Un valor posible para el parámetro `how' para @ref{11a2,,pthread_sigmask()} que indica que las señales deben bloquearse.


Added in version 3.3.

@end deffn

@geindex SIG_UNBLOCK (en el módulo signal)
@anchor{library/signal signal SIG_UNBLOCK}@anchor{3448}
@deffn {Dato} signal.SIG_UNBLOCK

Un valor posible para el parámetro `how' para @ref{11a2,,pthread_sigmask()} que indica que las señales deben desbloquearse.


Added in version 3.3.

@end deffn

@geindex SIG_SETMASK (en el módulo signal)
@anchor{library/signal signal SIG_SETMASK}@anchor{3449}
@deffn {Dato} signal.SIG_SETMASK

Un valor posible para el parámetro `how' para @ref{11a2,,pthread_sigmask()} que indica que la máscara de señal debe ser reemplazada.


Added in version 3.3.

@end deffn

El módulo @ref{c6,,signal} define una excepción:

@geindex ItimerError
@anchor{library/signal signal ItimerError}@anchor{3459}
@deffn {Excepción} signal.ItimerError

Se genera para señalar un error de la implementación subyacente @ref{345a,,setitimer()} o @ref{345b,,getitimer()}. Espere este error si se pasa un temporizador de intervalo no válido o un tiempo negativo a @ref{345a,,setitimer()}. Este error es un subtipo de @ref{4d5,,OSError}.


Added in version 3.3: Este error solía ser un subtipo de @ref{10ce,,IOError}, que ahora es un alias de @ref{4d5,,OSError}.

@end deffn

El módulo @ref{c6,,signal} define las siguientes funciones:

@geindex alarm() (en el módulo signal)
@anchor{library/signal signal alarm}@anchor{345c}
@deffn {Función} signal.alarm (time)

Si `time' es distinto de cero, esta función solicita que se envíe una señal @ref{344d,,SIGALRM} al proceso en `time' segundos. Se cancela cualquier alarma programada previamente (solo se puede programar una alarma en cualquier momento). El valor retornado es entonces el número de segundos antes de que se entregara cualquier alarma previamente configurada. Si `time' es cero, no se programa ninguna alarma y se cancela cualquier alarma programada. Si el valor de retorno es cero, no hay ninguna alarma programada actualmente.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}} para obtener más información.
@end deffn

@geindex getsignal() (en el módulo signal)
@anchor{library/signal signal getsignal}@anchor{16b5}
@deffn {Función} signal.getsignal (signalnum)

Retorna el manejador de señales actual para la señal `signalnum'. El valor retornado puede ser un objeto de Python invocable o uno de los valores especiales @ref{1827,,signal.SIG_IGN}, @ref{1828,,signal.SIG_DFL} o @ref{716,,None}. Aquí, @ref{1827,,signal.SIG_IGN} significa que la señal fue previamente ignorada, @ref{1828,,signal.SIG_DFL} significa que la forma predeterminada de manejar la señal estaba en uso anteriormente, y el gestor de señales no se instaló desde Python.
@end deffn

@geindex strsignal() (en el módulo signal)
@anchor{library/signal signal strsignal}@anchor{1a45}
@deffn {Función} signal.strsignal (signalnum)

Retorna la descripción de la señal `signalnum', como «Interrupt» para @ref{8db,,SIGINT}. Retorna @ref{716,,None} si `signalnum' no tiene descripción. Lanza @ref{360,,ValueError} si `signalnum' no es válido.


Added in version 3.8.

@end deffn

@geindex valid_signals() (en el módulo signal)
@anchor{library/signal signal valid_signals}@anchor{3455}
@deffn {Función} signal.valid_signals ()

Retorna el conjunto de números de señal válidos en esta plataforma. Esto puede ser menor que @code{rango(1, NSIG)} si el sistema reserva algunas señales para uso interno.


Added in version 3.8.

@end deffn

@geindex pause() (en el módulo signal)
@anchor{library/signal signal pause}@anchor{345d}
@deffn {Función} signal.pause ()

Hacer que el proceso duerma hasta que se reciba una señal; entonces se llamará al manejador apropiado. No retorna nada.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}} para obtener más información.

Vea también @ref{11a5,,sigwait()}, @ref{e31,,sigwaitinfo()}, @ref{e30,,sigtimedwait()} y @ref{11a4,,sigpending()}.
@end deffn

@geindex raise_signal() (en el módulo signal)
@anchor{library/signal signal raise_signal}@anchor{1809}
@deffn {Función} signal.raise_signal (signum)

Envía una señal al proceso de llamada. No retorna nada.


Added in version 3.8.

@end deffn

@geindex pidfd_send_signal() (en el módulo signal)
@anchor{library/signal signal pidfd_send_signal}@anchor{9be}
@deffn {Función} signal.pidfd_send_signal (pidfd, sig, siginfo=None, flags=0)

Envía la señal `sig' al proceso referido por el descriptor de archivo `pidfd'. Python actualmente no soporta el parámetro `siginfo'; éste debe ser @code{None}. El argumento `flags' está proveído para extensiones futuras; no hay valores actualmente definidos para `flags'.

Para más información vea la página de manual @code{pidfd_send_signal(2)@footnote{https://manpages.debian.org/pidfd_send_signal(2)}}.

@ref{1d5a,,Availability}: Linux >= 5.1, Android >= @ref{c12,,build-time} API level 31


Added in version 3.9.

@end deffn

@geindex pthread_kill() (en el módulo signal)
@anchor{library/signal signal pthread_kill}@anchor{11a3}
@deffn {Función} signal.pthread_kill (thread_id, signalnum)

Envíe la señal `signalnum' al hilo `thread_id', otro hilo en el mismo proceso que el llamador. El hilo de destino puede ejecutar cualquier código (Python o no). Sin embargo, si el hilo de destino está ejecutando el intérprete de Python, los manejadores de señales de Python serán @ref{3445,,ejecutados por el hilo principal}. Por lo tanto, el único punto de enviar una señal a un hilo de Python en particular sería forzar que una llamada al sistema en ejecución falle con @ref{e0e,,InterruptedError}.

Use @ref{11cb,,threading.get_ident()} or the @ref{2c43,,ident}
attribute of @ref{9df,,threading.Thread} objects to get a suitable value
for `thread_id'.

Si `signalnum' es 0, no se envía ninguna señal, pero se sigue realizando la comprobación de errores; esto se puede usar para verificar si el hilo de destino aún se está ejecutando.

Genera un @ref{18c3,,evento de auditoría} @code{signal.pthread_kill} con argumentos @code{thread_id}, @code{signalnum}.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{pthread_kill(3)@footnote{https://manpages.debian.org/pthread_kill(3)}} para obtener más información.

Vea también @ref{13c7,,os.kill()}.


Added in version 3.3.

@end deffn

@geindex pthread_sigmask() (en el módulo signal)
@anchor{library/signal signal pthread_sigmask}@anchor{11a2}
@deffn {Función} signal.pthread_sigmask (how, mask)

Busca o cambia la máscara de señal del hilo de llamada. La máscara de señal es el conjunto de señales cuya entrega está actualmente bloqueada para la persona que llama. Retorna la máscara de señal anterior como un conjunto de señales.

El comportamiento de la llamada depende del valor de `how', como sigue.


@itemize *

@item 
@ref{3447,,SIG_BLOCK}: El conjunto de señales bloqueadas es la unión del conjunto actual y el argumento `mask'.

@item 
@ref{3448,,SIG_UNBLOCK}: Las señales en `mask' se eliminan del conjunto actual de señales bloqueadas. Está permitido intentar desbloquear una señal que no esté bloqueada.

@item 
@ref{3449,,SIG_SETMASK}: El conjunto de señales bloqueadas se establece en el argumento `mask'.
@end itemize

`mask' es un conjunto de números de señales (por ejemplo, @{@ref{8db,,signal.SIGINT}, @ref{141f,,signal.SIGTERM}@}). Utilice @ref{3455,,valid_signals()} para una máscara completa que incluya todas las señales.

Por ejemplo, @code{signal.pthread_sigmask(signal.SIG_BLOCK, [])} lee la máscara de señal del hilo de llamada.

@ref{3451,,SIGKILL} y @code{SIGSTOP} no se pueden bloquear.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} y @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} para obtener más información.

Vea también @ref{345d,,pause()}, @ref{11a4,,sigpending()} y @ref{11a5,,sigwait()}.


Added in version 3.3.

@end deffn

@geindex setitimer() (en el módulo signal)
@anchor{library/signal signal setitimer}@anchor{345a}
@deffn {Función} signal.setitimer (which, seconds, interval=0.0)

Establece el temporizador de intervalo dado (uno de @ref{3456,,signal.ITIMER_REAL}, @ref{3457,,signal.ITIMER_VIRTUAL} o @ref{3458,,signal.ITIMER_PROF}) especificado por `which' disparar después de `seconds' (se acepta el números de punto flotante, diferente de @ref{345c,,alarm()}) y luego cada `interval' segundos (si `interval' es distinto de cero). El temporizador de intervalo especificado por `which' se puede borrar estableciendo `seconds' en cero.

Cuando se dispara un temporizador de intervalos, se envía una señal al proceso. La señal enviada depende del temporizador que se utilice; @ref{3456,,signal.ITIMER_REAL} entregará @ref{344d,,SIGALRM}, @ref{3457,,signal.ITIMER_VIRTUAL} envía @code{SIGVTALRM}, y @ref{3458,,signal.ITIMER_PROF} entregará @code{SIGPROF}.

Los valores antiguos se retornan como una tupla: (retraso, intervalo).

Si intenta pasar un temporizador de intervalo no válido, se producirá un @ref{3459,,ItimerError}.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex getitimer() (en el módulo signal)
@anchor{library/signal signal getitimer}@anchor{345b}
@deffn {Función} signal.getitimer (which)

Retorna el valor actual de un temporizador de intervalo dado especificado por `which'.

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex set_wakeup_fd() (en el módulo signal)
@anchor{library/signal signal set_wakeup_fd}@anchor{bf8}
@deffn {Función} signal.set_wakeup_fd (fd, *, warn_on_full_buffer=True)

Establezca el descriptor del archivo de activación en `fd'. Cuando se recibe una señal, el número de la señal se escribe como un solo byte en el fd. Esto puede ser utilizado por una biblioteca para despertar una encuesta o seleccionar una llamada, permitiendo que la señal se procese por completo.

Se retorna el antiguo fd de activación (o -1 si la activación del descriptor de archivo no estaba habilitada). Si `fd' es -1, la activación del descriptor de archivo está deshabilitada. Si no es -1, `fd' debe ser sin bloqueo. Depende de la biblioteca eliminar los bytes de `fd' antes de llamar a poll o seleccionar nuevamente.

Cuando los hilos están habilitados, esta función solo se puede llamar desde @ref{3445,,el subproceso principal del intérprete principal}; intentar llamarlo desde otros hilos hará que se lance una excepción @ref{360,,ValueError}.

Hay dos formas habituales de utilizar esta función. En ambos enfoques, usa el fd para despertarse cuando llega una señal, pero luego difieren en cómo determinan `which' señal o señales han llegado.

En el primer enfoque, leemos los datos del búfer de fd, y los valores de bytes le dan los números de señal. Esto es simple, pero en casos raros puede surgir un problema: generalmente el fd tendrá una cantidad limitada de espacio en el búfer, y si llegan demasiadas señales demasiado rápido, entonces el búfer puede llenarse y algunas señales pueden perderse. Si usa este enfoque, entonces debe configurar @code{warn_on_full_buffer = True}, que al menos causará que se imprima una advertencia en stderr cuando se pierdan las señales.

En el segundo enfoque, usamos el wakeup fd `solo' para wakeups e ignoramos los valores de bytes reales. En este caso, lo único que nos importa es si el búfer de fd está vacío o no; un búfer lleno no indica ningún problema. Si utiliza este enfoque, debe configurar @code{warn_on_full_buffer = False}, para que sus usuarios no se confundan con mensajes de advertencia falsos.


Distinto en la versión 3.5: En Windows, la función ahora también admite identificadores de socket.



Distinto en la versión 3.7: Se agregó el parámetro @code{warn_on_full_buffer}.

@end deffn

@geindex siginterrupt() (en el módulo signal)
@anchor{library/signal signal siginterrupt}@anchor{11a7}
@deffn {Función} signal.siginterrupt (signalnum, flag)

Cambiar el comportamiento de reinicio de la llamada al sistema: si `flag' es @ref{bbf,,False}, las llamadas al sistema se reiniciarán cuando las interrumpa la señal `signalnum', de lo contrario, las llamadas al sistema se interrumpirán. No retorna nada.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{siginterrupt(3)@footnote{https://manpages.debian.org/siginterrupt(3)}} para obtener más información.

Tenga en cuenta que la instalación de un gestor de señales con @ref{c6,,signal()} restablecerá el comportamiento de reinicio a interrumpible llamando implícitamente a @code{siginterrupt()} con un valor de `flag' verdadero para la señal dada.
@end deffn

@geindex signal() (en el módulo signal)
@anchor{library/signal signal signal}@anchor{11a6}
@deffn {Función} signal.signal (signalnum, handler)

Establece el gestor de la señal `signalnum' en la función `handler' (manejador). `handler' puede ser un objeto de Python invocable que toma dos argumentos (ver más abajo), o uno de los valores especiales @ref{1827,,signal.SIG_IGN} o @ref{1828,,signal.SIG_DFL}. Se retornará el manejador de señales anterior (vea la descripción de @ref{16b5,,getsignal()} arriba). (Consulte la página del manual de Unix @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}} para obtener más información).

Cuando los hilos están habilitados, esta función solo se puede llamar desde @ref{3445,,el subproceso principal del intérprete principal}; intentar llamarlo desde otros hilos hará que se lance una excepción @ref{360,,ValueError}.

El `handler' se llama con dos argumentos: el número de señal y el marco de pila actual (@code{None} o un objeto marco; para obtener una descripción de los objetos marco, consulte la descripción @ref{780,,en la jerarquía de tipos} o vea las descripciones de los atributos en el módulo @ref{7e,,inspect}).

En Windows, @ref{c6,,signal()} solo se puede llamar con @ref{1d51,,SIGABRT}, @ref{1d50,,SIGFPE}, @ref{1d53,,SIGILL}, @ref{8db,,SIGINT}, @ref{1d4f,,SIGSEGV}, @ref{141f,,SIGTERM}, o @ref{344e,,SIGBREAK}. Un @ref{360,,ValueError} se lanzará en cualquier otro caso. Tenga en cuenta que no todos los sistemas definen el mismo conjunto de nombres de señales; un @ref{441,,AttributeError} se lanzará si un nombre de señal no está definido como constante de nivel de módulo @code{SIG*}.
@end deffn

@geindex sigpending() (en el módulo signal)
@anchor{library/signal signal sigpending}@anchor{11a4}
@deffn {Función} signal.sigpending ()

Examine el conjunto de señales que están pendientes de entrega al hilo de llamada (es decir, las señales que se han generado mientras estaban bloqueadas). Retorna el conjunto de señales pendientes.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigpending(2)@footnote{https://manpages.debian.org/sigpending(2)}} para obtener más información.

Vea también @ref{345d,,pause()}, @ref{11a2,,pthread_sigmask()} y @ref{11a5,,sigwait()}.


Added in version 3.3.

@end deffn

@geindex sigwait() (en el módulo signal)
@anchor{library/signal signal sigwait}@anchor{11a5}
@deffn {Función} signal.sigwait (sigset)

Suspende la ejecución del hilo de llamada hasta la entrega de una de las señales especificadas en el conjunto de señales `sigset'. La función acepta la señal (la elimina de la lista pendiente de señales) y retorna el número de señal.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigwait(3)@footnote{https://manpages.debian.org/sigwait(3)}} para obtener más información.

Vea también @ref{345d,,pause()}, @ref{11a2,,pthread_sigmask()}, @ref{11a4,,sigpending()}, @ref{e31,,sigwaitinfo()} y @ref{e30,,sigtimedwait()}.


Added in version 3.3.

@end deffn

@geindex sigwaitinfo() (en el módulo signal)
@anchor{library/signal signal sigwaitinfo}@anchor{e31}
@deffn {Función} signal.sigwaitinfo (sigset)

Suspende la ejecución del hilo de llamada hasta la entrega de una de las señales especificadas en el conjunto de señales `sigset'. La función acepta la señal y la elimina de la lista de señales pendientes. Si una de las señales en `sigset' ya está pendiente para el hilo de llamada, la función regresará inmediatamente con información sobre esa señal. No se llama al gestor de señales para la señal enviada. La función genera un @ref{e0e,,InterruptedError} si es interrumpida por una señal que no está en `sigset'.

El valor de retorno es un objeto que representa los datos contenidos en la estructura @code{siginfo_t}, a saber: @code{si_signo}, @code{si_code}, @code{si_errno}, @code{si_pid}, @code{si_uid}, @code{si_status}, @code{si_band}.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigwaitinfo(2)@footnote{https://manpages.debian.org/sigwaitinfo(2)}} para obtener más información.

Vea también @ref{345d,,pause()}, @ref{11a5,,sigwait()} y @ref{e30,,sigtimedwait()}.


Added in version 3.3.



Distinto en la versión 3.5: La función ahora se vuelve a intentar si es interrumpida por una señal que no está en `sigset' y el manejador de señales no genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@end deffn

@geindex sigtimedwait() (en el módulo signal)
@anchor{library/signal signal sigtimedwait}@anchor{e30}
@deffn {Función} signal.sigtimedwait (sigset, timeout)

Similar a @ref{e31,,sigwaitinfo()}, pero toma un argumento `timeout' adicional que especifica un tiempo de espera. Si `timeout' se especifica como @code{0}, se realiza una encuesta. Retorna @ref{716,,None} si se agota el tiempo de espera.

@ref{1d5a,,Availability}: Unix.

Consulta la página del manual @code{sigtimedwait(2)@footnote{https://manpages.debian.org/sigtimedwait(2)}} para obtener más información.

Vea también @ref{345d,,pause()}, @ref{11a5,,sigwait()} y @ref{e31,,sigwaitinfo()}.


Added in version 3.3.



Distinto en la versión 3.5: La función ahora se reintenta con el `timeout' recalculado si se interrumpe por una señal que no está en `sigset' y el manejador de señales no genera una excepción (ver 
@geindex Python Enhancement Proposals; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para la justificación).

@end deffn

@node Ejemplos<20>,Nota sobre SIGPIPE,Contenidos del módulo<3>,signal — Set handlers for asynchronous events
@anchor{library/signal examples}@anchor{345e}@anchor{library/signal signal-example}@anchor{345f}
@subsubsection Ejemplos


Aquí hay un programa de ejemplo mínimo. Utiliza la función @ref{345c,,alarm()} para limitar el tiempo de espera para abrir un archivo; esto es útil si el archivo es para un dispositivo serial que puede no estar encendido, lo que normalmente haría que @ref{e18,,os.open()} se cuelgue indefinidamente. La solución es configurar una alarma de 5 segundos antes de abrir el archivo; si la operación lleva demasiado tiempo, se enviará la señal de alarma y el gestor genera una excepción.

@example
import signal, os

def handler(signum, frame):
    signame = signal.Signals(signum).name
    print(f'Signal handler called with signal @{signame@} (@{signum@})')
    raise OSError("Couldn't open device!")

# Set the signal handler and a 5-second alarm
signal.signal(signal.SIGALRM, handler)
signal.alarm(5)

# This open() may hang indefinitely
fd = os.open('/dev/ttyS0', os.O_RDWR)

signal.alarm(0)          # Disable the alarm
@end example

@node Nota sobre SIGPIPE,Nota sobre Manejadores de Señales y Excepciones,Ejemplos<20>,signal — Set handlers for asynchronous events
@anchor{library/signal note-on-sigpipe}@anchor{3460}
@subsubsection Nota sobre SIGPIPE


Canalizar la salida de su programa a herramientas como @code{head(1)@footnote{https://manpages.debian.org/head(1)}} hará que se envíe una señal @ref{3441,,SIGPIPE} a su proceso cuando el receptor de su salida estándar se cierre antes. Esto da como resultado una excepción como @code{BrokenPipeError: [Errno 32] Broken pipe}. Para manejar este caso, envuelva su punto de entrada para detectar esta excepción de la siguiente manera:

@example
import os
import sys

def main():
    try:
        # simulate large output (your code replaces this loop)
        for x in range(10000):
            print("y")
        # flush output here to force SIGPIPE to be triggered
        # while inside this try block.
        sys.stdout.flush()
    except BrokenPipeError:
        # Python flushes standard streams on exit; redirect remaining output
        # to devnull to avoid another BrokenPipeError at shutdown
        devnull = os.open(os.devnull, os.O_WRONLY)
        os.dup2(devnull, sys.stdout.fileno())
        sys.exit(1)  # Python exits with error code 1 on EPIPE

if __name__ == '__main__':
    main()
@end example

No establezcas la disposición de @ref{3441,,SIGPIPE} en @ref{1828,,SIG_DFL} para evitar @ref{10d8,,BrokenPipeError}. Hacerlo causaría que tu programa se cierre inesperadamente siempre que se interrumpa cualquier conexión de socket mientras su programa aún esté escribiendo en él.

@node Nota sobre Manejadores de Señales y Excepciones,,Nota sobre SIGPIPE,signal — Set handlers for asynchronous events
@anchor{library/signal handlers-and-exceptions}@anchor{228e}@anchor{library/signal note-on-signal-handlers-and-exceptions}@anchor{3461}
@subsubsection Nota sobre Manejadores de Señales y Excepciones


Si un gestor de señal lanza una excepción, ésta excepción será propagada al hilo principal de ejecución y podría ser lanzado luego de cualquier instrucción de @ref{2f2,,bytecode}. Más notablemente, @ref{a63,,KeyboardInterrupt} podría aparecer en cualquier momento de la ejecución. La mayoría del código python, incluida la librería estándar, no puede robustecerse en contra esto, y por esto @ref{a63,,KeyboardInterrupt} (o cualquier otra excepción resultante de un gestor de señal) podría poner el programa en un estado inesperado en raras ocasiones.

Para ilustrar esto, considere el siguiente código:

@example
class SpamContext:
    def __init__(self):
        self.lock = threading.Lock()

    def __enter__(self):
        # If KeyboardInterrupt occurs here, everything is fine
        self.lock.acquire()
        # If KeyboardInterrupt occurs here, __exit__ will not be called
        ...
        # KeyboardInterrupt could occur just before the function returns

    def __exit__(self, exc_type, exc_val, exc_tb):
        ...
        self.lock.release()
@end example

Para muchos programas, especialmente para los que sólo quieren interrumpir la ejecución ante un @ref{a63,,KeyboardInterrupt}, esto no es un problema, pero las aplicaciones que son complejas o requieren alta confiabilidad deben evitar lanzar excepciones desde los gestores de señales. También deben evitar atrapar @ref{a63,,KeyboardInterrupt} como medio de una terminación de ejecución airosa. En su lugar, deben instalar su propio gestor @ref{8db,,SIGINT}. A continuación, un ejemplo de un servidor HTTP que evita el @ref{a63,,KeyboardInterrupt}:

@example
import signal
import socket
from selectors import DefaultSelector, EVENT_READ
from http.server import HTTPServer, SimpleHTTPRequestHandler

interrupt_read, interrupt_write = socket.socketpair()

def handler(signum, frame):
    print('Signal handler called with signal', signum)
    interrupt_write.send(b'\0')
signal.signal(signal.SIGINT, handler)

def serve_forever(httpd):
    sel = DefaultSelector()
    sel.register(interrupt_read, EVENT_READ)
    sel.register(httpd, EVENT_READ)

    while True:
        for key, _ in sel.select():
            if key.fileobj == interrupt_read:
                interrupt_read.recv(1)
                return
            if key.fileobj == httpd:
                httpd.handle_request()

print("Serving on port 8000")
httpd = HTTPServer(('@w{'}, 8000), SimpleHTTPRequestHandler)
serve_forever(httpd)
print("Shutdown...")
@end example

@node mmap — Memory-mapped file support,,signal — Set handlers for asynchronous events,Comunicación en redes y entre procesos
@anchor{library/mmap doc}@anchor{3462}@anchor{library/mmap mmap-memory-mapped-file-support}@anchor{3463}@anchor{library/mmap module-mmap}@anchor{90}
@subsection @code{mmap} — Memory-mapped file support


@geindex module; mmap


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Los objetos de archivos mapeados en memoria se comportan como objetos de tipo @ref{5e0,,bytearray} y @ref{1230,,objetos archivo}.  Puedes usar objetos mmap en la mayoría de lugares donde se esperen objetos de tipo @ref{5e0,,bytearray}; por ejemplo, puedes usar el módulo @ref{b9,,re} para buscar entre un archivo mapeado en memoria.  También puedes cambiar un solo byte al hacer @code{obj[index]==97}, o cambiar una subsecuencia al asignarle una rebanada: @code{obj[i1:i2] = b'...'}.  También puedes leer y escribir datos que empiezan en la posición del archivo actual, y utilizar el método @code{seek()} a través del archivo para cambiar la posición actual.

A memory-mapped file is created by the @ref{368,,mmap} constructor, which is
different on Unix and on Windows.  In either case you must provide a file
descriptor for a file opened for update. If you wish to map an existing Python
file object, use its @ref{2848,,fileno()} method to obtain the correct value for the
`fileno' parameter.  Otherwise, you can open the file using the
@ref{e18,,os.open()} function, which returns a file descriptor directly (the file
still needs to be closed when done).

@cartouche
@quotation Nota 
Si quieres crear un mapeado en memoria para un archivo con permisos de escritura y en el búfer, debes ejecutar la función @ref{2c1b,,flush()}. Es necesario para asegurar que las modificaciones locales a los búfer estén realmente disponible para el mapeado.
@end quotation
@end cartouche

Para las versiones del constructor de tanto Unix como de Windows, `access' puede ser especificado como un parámetro nombrado opcional. `access' acepta uno de cuatro valores: @code{ACCESS_READ}, @code{ACCESS_WRITE}, o @code{ACCESS_COPY} para especificar una memoria de solo lectura, `write- through', o `copy-on-write' respectivamente, o @code{ACCES_DEFAULT} para deferir a `prot'. El parámetro `access' se puede usar tanto en Unix como en Windows.  Si `access' no es especificado, el mmap de Windows retorna un mapeado `write-through'.  Los valores de la memoria inicial para los tres tipos de acceso son tomados del archivo especificado.  La asignación a una mapa de memoria @code{ACCESS_READ} lanza una excepción @ref{228,,TypeError}.  La asignación a un mapa de memoria @code{ACCESS_WRITE} afecta tanto a la memoria como al archivo subyacente.  La asignación a un mapa de memoria @code{ACCES_COPY} afecta a la memoria pero no actualiza el archivo subyacente.


Distinto en la versión 3.7: Se añadió la constante @code{ACCESS_DEFAULT}.


Para mapear memoria anónima, se debe pasar -1 como el `fileno' junto con la longitud.

@geindex mmap (clase en mmap)
@anchor{library/mmap mmap mmap}@anchor{368}
@deffn {Clase} mmap.mmap (fileno, length, tagname=None, access=ACCESS_DEFAULT, offset=0)

`(En la versión de Windows)' Mapea `length' bytes desde el archivo especificado por el gestor de archivo `fileno', y crea un objeto mmap. Si `length' es más largo que el tamaño actual del archivo, el archivo es extendido para contener `length' bytes. Si `length' es @code{0}, la longitud máxima del map es la tamaño actual del archivo, salvo que si el archivo está vacío Windows lanza una excepción (no puedes crear un mapeado vacío en Windows)

`tagname', if specified and not @code{None}, is a string giving a tag name for
the mapping.  Windows allows you to have many different mappings against
the same file.  If you specify the name of an existing tag, that tag is
opened, otherwise a new tag of this name is created.  If this parameter is
omitted or @code{None}, the mapping is created without a name.  Avoiding the
use of the `tagname' parameter will assist in keeping your code portable
between Unix and Windows.

`offset' puede ser especificado como un `offset' entero no negativo. las referencias de mmap serán relativas al `offset' desde el comienzo del archivo. `offset' es por defecto 0. `offset' debe ser un múltiplo de @code{ALLOCATIONGRANULARITY}.

Lanza un @ref{18c3,,evento de inspección} @code{mmap.__new__} con los argumentos @code{fileno}, @code{length}, @code{access}, @code{offset}.
@end deffn


@deffn {Clase} mmap.mmap (fileno, length, flags=MAP_SHARED, prot=PROT_WRITE | PROT_READ, access=ACCESS_DEFAULT, offset=0, *, trackfd=True)

`(En la versión de Unix)' Mapea `length' bytes desde el archivo especificado por el descriptor de archivo `fileno', y retorna un objeto mmap.  Si `length' es @code{0}, la longitud máxima del map será el tamaño actual del archivo cuando @ref{368,,mmap} sea llamado.

`flags' especifica la naturaleza del mapeado. @ref{3464,,MAP_PRIVATE} crea un mapeado `copy-on-write' privado, por lo que los cambios al contenido del objeto mmap serán privados para este proceso, y @ref{3465,,MAP_SHARED} crea un mapeado que es compartido con todos los demás procesos que mapean las mismas áreas del archivo.  El valor por defecto es @ref{3465,,MAP_SHARED}. Algunos tipos tienen posibles banderas adicionales con la lista completa en @ref{3466,,MAP_* constants}.

`prot', si se especifica, proporciona la protección de memoria deseado; los dos valores más útiles son @code{PROT_READ} y @code{PROT_WRITE}, para especificar que las páginas puedan ser escritas o leídas.  `prot' es por defecto @code{PROT_READ|PROT_WRITE}.

`access' puede ser especificado en lugar de `flags' y `prot' como un parámetro nombrado opcional.  Es un error especificar tanto `flags', `prot' como `access'. Véase la descripción de `access' arriba por información de cómo usar este parámetro.

`offset' puede ser especificado como un `offset' entero no negativo. Las referencias serán relativas al `offset' desde el comienzo del archivo. `offset' por defecto es 0. `offset' debe ser un múltiplo de @code{ALLOCATIONGRANULARITY} que es igual a @code{PAGESIZE} en los sistemas Unix.

If `trackfd' is @code{False}, the file descriptor specified by `fileno' will
not be duplicated, and the resulting @code{mmap} object will not
be associated with the map’s underlying file.
This means that the @ref{3467,,size()} and @ref{3468,,resize()}
methods will fail.
This mode is useful to limit the number of open file descriptors.

To ensure validity of the created memory mapping the file specified
by the descriptor `fileno' is internally automatically synchronized
with the physical backing store on macOS.


Distinto en la versión 3.13: The `trackfd' parameter was added.


Este ejemplo muestra un forma simple de usar @ref{368,,mmap}:

@example
import mmap

# write a simple example file
with open("hello.txt", "wb") as f:
    f.write(b"Hello Python!\n")

with open("hello.txt", "r+b") as f:
    # memory-map the file, size 0 means whole file
    mm = mmap.mmap(f.fileno(), 0)
    # read content via standard file methods
    print(mm.readline())  # prints b"Hello Python!\n"
    # read content via slice notation
    print(mm[:5])  # prints b"Hello"
    # update content using slice notation;
    # note that new content must have same size
    mm[6:] = b" world!\n"
    # ... and read again using standard file methods
    mm.seek(0)
    print(mm.readline())  # prints b"Hello  world!\n"
    # close the map
    mm.close()
@end example

@ref{368,,mmap} también puede ser usado como un gestor de contexto en una sentencia @ref{673,,with}

@example
import mmap

with mmap.mmap(-1, 13) as mm:
    mm.write(b"Hello world!")
@end example


Added in version 3.2: Soporte del gestor de contexto.


El siguiente ejemplo demuestra como crear un mapa anónimo y cambiar los datos entre los procesos padre e hijo:

@example
import mmap
import os

mm = mmap.mmap(-1, 13)
mm.write(b"Hello world!")

pid = os.fork()

if pid == 0:  # In a child process
    mm.seek(0)
    print(mm.readline())

    mm.close()
@end example

Lanza un @ref{18c3,,evento de inspección} @code{mmap.__new__} con los argumentos @code{fileno}, @code{length}, @code{access}, @code{offset}.

Los objetos de archivos mapeados en memoria soportan los siguiente métodos:

@geindex close() (método de mmap.mmap)
@anchor{library/mmap mmap mmap close}@anchor{3469}
@deffn {Método} close ()

Cierra el mmap. Las llamadas posteriores a otros métodos del objeto resultarán en que se lance una excepción `ValueError'. Esto no cerrará el archivo abierto.
@end deffn

@geindex closed (atributo de mmap.mmap)
@anchor{library/mmap mmap mmap closed}@anchor{346a}
@deffn {Atributo} closed

@code{True} si el archivo está cerrado.


Added in version 3.2.

@end deffn

@geindex find() (método de mmap.mmap)
@anchor{library/mmap mmap mmap find}@anchor{346b}
@deffn {Método} find (sub[, start[, end]])

Retorna el índice mínimo en el objeto donde la subsecuencia `sub' es hallada, tal que `sub' este contenido en el rango [`start', `end']. Los argumentos opcionales `start' y `end' son interpretados como en una notación de rebanada. Retorna @code{-1} si falla.


Distinto en la versión 3.5: Ahora el objeto @ref{db4,,bytes-like object} con permisos de escritura se acepta.

@end deffn

@geindex flush() (método de mmap.mmap)
@anchor{library/mmap mmap mmap flush}@anchor{b23}
@deffn {Método} flush ([offset[, size]])

Transmite los cambios hechos a la copia en memoria de una archivo de vuelta al archivo. Sin el uso de esta llamada no hay garantía que los cambios sean escritos de vuelta antes de que los objetos sean destruidos.  Si `offset' y `size' son especificados, solo los cambios al rango de bytes dado serán transmitidos al disco; de otra forma, la extensión completa al mapeado se transmite.  `offset' debe ser un múltiplo de la constante @code{PAGESIZE} o @code{ALLOCATIONGRANULARITY}.

Se retorna @code{None} para indicar éxito.  Una excepción es lanzada cuando la llamada falla.


Distinto en la versión 3.8: Anteriormente, se retornaba un valor diferente de cero cuando era exitoso; se retornaba cero cuando pasaba un error en Windows.  Se retornaba un valor de cero cuando era exitoso; se lanzaba una excepción cuando pasaba un error en Unix.

@end deffn

@geindex madvise() (método de mmap.mmap)
@anchor{library/mmap mmap mmap madvise}@anchor{a9a}
@deffn {Método} madvise (option[, start[, length]])

Envía un aviso `option' al kernel sobre la región de la memoria que comienza con `start' y se extiende `length' bytes.  `option' debe ser una de las @ref{346c,,constantes MADV_*} disponibles en el sistema.  Si `start' y `end' se omiten, se abarca al mapeo entero.  En algunos sistemas (incluyendo Linux), `start' debe ser un múltiplo de @code{PAGESIZE}.

Disponibilidad: Sistemas con la llamada al sistema @code{madvise()}.


Added in version 3.8.

@end deffn

@geindex move() (método de mmap.mmap)
@anchor{library/mmap mmap mmap move}@anchor{346d}
@deffn {Método} move (dest, src, count)

Copia los `count' bytes empezando en el `offset' `src' al índice de destino `dest'.  Si el mmap fue creado con @code{ACCESS_READ}, entonces las llamadas lanzaran una excepción @ref{228,,TypeError}.
@end deffn

@geindex read() (método de mmap.mmap)
@anchor{library/mmap mmap mmap read}@anchor{1151}
@deffn {Método} read ([n])

Retorna una clase @ref{325,,bytes} que contiene hasta `n' bytes empezando desde la posición del archivo actual. Si se omite el argumento, es @code{None} o negativo, retorna todos los bytes desde la posición actual del archivo hasta el final del mapeado. Se actualiza la posición del archivo para apuntar después de los bytes que se retornaron.


Distinto en la versión 3.3: El argumento puede ser omitido o ser @code{None}.

@end deffn

@geindex read_byte() (método de mmap.mmap)
@anchor{library/mmap mmap mmap read_byte}@anchor{346e}
@deffn {Método} read_byte ()

Retorna un byte en la posición actual del archivo como un entero, y avanza la posición del archivo por 1.
@end deffn

@geindex readline() (método de mmap.mmap)
@anchor{library/mmap mmap mmap readline}@anchor{346f}
@deffn {Método} readline ()

Retorna una sola línea, comenzando en la posición actual del archivo y hasta la siguiente nueva línea. La posición del archivo se actualiza para apuntar después de los bytes que se retornaron.
@end deffn

@geindex resize() (método de mmap.mmap)
@anchor{library/mmap mmap mmap resize}@anchor{3468}
@deffn {Método} resize (newsize)

Resizes the map and the underlying file, if any.

Resizing a map created with `access' of @code{ACCESS_READ} or
@code{ACCESS_COPY}, will raise a @ref{228,,TypeError} exception.
Resizing a map created with with `trackfd' set to @code{False},
will raise a @ref{360,,ValueError} exception.

`En Windows': cambiar el tamaño del mapa generará un @ref{4d5,,OSError} si hay otros mapas contra el archivo con el mismo nombre. Cambiar el tamaño de un mapa anónimo (es decir, contra el archivo de paginación) creará silenciosamente un nuevo mapa con los datos originales copiado hasta la longitud del nuevo tamaño.


Distinto en la versión 3.11: Falla correctamente si se intenta cambiar el tamaño cuando se sostiene otro mapa. Permite cambiar el tamaño contra un mapa anónimo en Windows

@end deffn

@geindex rfind() (método de mmap.mmap)
@anchor{library/mmap mmap mmap rfind}@anchor{3470}
@deffn {Método} rfind (sub[, start[, end]])

Retorna el índice más alto en el objeto donde la subsecuencia `sub' se encuentre, tal que `sub' sea contenido en el rango [`start', `end']. Los argumentos opcionales `start' y `end' son interpretados como un notación de rebanada. Retorna @code{-1} si falla.


Distinto en la versión 3.5: Ahora el objeto @ref{db4,,bytes-like object} con permisos de escritura se acepta.

@end deffn

@geindex seek() (método de mmap.mmap)
@anchor{library/mmap mmap mmap seek}@anchor{36a}
@deffn {Método} seek (pos[, whence])

Establece la posición actual del archivo.  El argumento `whence' es opcional y es por defecto @code{os.SEEK_SET} o @code{0} (posicionamiento del archivo absoluto); otros valores son @code{os.SEEK_CUR} o @code{1} (búsqueda relativa a la posición actual) y @code{os.SEEK_END} o @code{2} (búsqueda relativa al final del archivo).


Distinto en la versión 3.13: Return the new absolute position instead of @code{None}.

@end deffn

@geindex seekable() (método de mmap.mmap)
@anchor{library/mmap mmap mmap seekable}@anchor{369}
@deffn {Método} seekable ()

Return whether the file supports seeking, and the return value is always @code{True}.


Added in version 3.13.

@end deffn

@geindex size() (método de mmap.mmap)
@anchor{library/mmap mmap mmap size}@anchor{3467}
@deffn {Método} size ()

Retorna el tamaño del archivo, que puede ser más grande que el tamaño del área mapeado en memoria.
@end deffn

@geindex tell() (método de mmap.mmap)
@anchor{library/mmap mmap mmap tell}@anchor{3471}
@deffn {Método} tell ()

Retorna la posición actual del puntero del archivo.
@end deffn

@geindex write() (método de mmap.mmap)
@anchor{library/mmap mmap mmap write}@anchor{3472}
@deffn {Método} write (bytes)

Escribe los bytes en `bytes' en memoria en la posición actual del puntero del archivo y retorna el números de bytes escritos (nunca menos que @code{len(bytes)}, ya que si la escritura falla, una excepción @ref{360,,ValueError} será lanzada).  La posición del archivo es actualizada para apuntar después de los bytes escritos.  Si el mmap fue creado con @code{ACCESS_READ}, entonces escribirlo lanzará una excepción @ref{228,,TypeError}.


Distinto en la versión 3.5: Ahora el objeto @ref{db4,,bytes-like object} con permisos de escritura se acepta.



Distinto en la versión 3.6: Ahora se retorna el número de bytes escritos.

@end deffn

@geindex write_byte() (método de mmap.mmap)
@anchor{library/mmap mmap mmap write_byte}@anchor{3473}
@deffn {Método} write_byte (byte)

Escribe el entero `byte' en la memoria en la posición actual del puntero del archivo; se avanza la posición del archivo por @code{1}. Si el mmap es creado con @code{ACCES_READ}, entonces escribirlo hará que se lance la excepción @ref{228,,TypeError}.
@end deffn
@end deffn

@menu
* Constantes MADV_*:: 
* Constantes MAP_*:: 

@end menu

@node Constantes MADV_*,Constantes MAP_*,,mmap — Memory-mapped file support
@anchor{library/mmap madv-constants}@anchor{3474}@anchor{library/mmap madvise-constants}@anchor{346c}
@subsubsection Constantes MADV_*


@geindex MADV_NORMAL (en el módulo mmap)
@geindex MADV_RANDOM (en el módulo mmap)
@geindex MADV_SEQUENTIAL (en el módulo mmap)
@geindex MADV_WILLNEED (en el módulo mmap)
@geindex MADV_DONTNEED (en el módulo mmap)
@geindex MADV_REMOVE (en el módulo mmap)
@geindex MADV_DONTFORK (en el módulo mmap)
@geindex MADV_DOFORK (en el módulo mmap)
@geindex MADV_HWPOISON (en el módulo mmap)
@geindex MADV_MERGEABLE (en el módulo mmap)
@geindex MADV_UNMERGEABLE (en el módulo mmap)
@geindex MADV_SOFT_OFFLINE (en el módulo mmap)
@geindex MADV_HUGEPAGE (en el módulo mmap)
@geindex MADV_NOHUGEPAGE (en el módulo mmap)
@geindex MADV_DONTDUMP (en el módulo mmap)
@geindex MADV_DODUMP (en el módulo mmap)
@geindex MADV_FREE (en el módulo mmap)
@geindex MADV_NOSYNC (en el módulo mmap)
@geindex MADV_AUTOSYNC (en el módulo mmap)
@geindex MADV_NOCORE (en el módulo mmap)
@geindex MADV_CORE (en el módulo mmap)
@geindex MADV_PROTECT (en el módulo mmap)
@geindex MADV_FREE_REUSABLE (en el módulo mmap)
@geindex MADV_FREE_REUSE (en el módulo mmap)
@anchor{library/mmap mmap MADV_NORMAL}@anchor{3475}
@deffn {Dato} mmap.MADV_NORMAL
@anchor{library/mmap mmap MADV_RANDOM}@anchor{3476}
@deffnx {Dato} mmap.MADV_RANDOM
@anchor{library/mmap mmap MADV_SEQUENTIAL}@anchor{3477}
@deffnx {Dato} mmap.MADV_SEQUENTIAL
@anchor{library/mmap mmap MADV_WILLNEED}@anchor{3478}
@deffnx {Dato} mmap.MADV_WILLNEED
@anchor{library/mmap mmap MADV_DONTNEED}@anchor{3479}
@deffnx {Dato} mmap.MADV_DONTNEED
@anchor{library/mmap mmap MADV_REMOVE}@anchor{347a}
@deffnx {Dato} mmap.MADV_REMOVE
@anchor{library/mmap mmap MADV_DONTFORK}@anchor{347b}
@deffnx {Dato} mmap.MADV_DONTFORK
@anchor{library/mmap mmap MADV_DOFORK}@anchor{347c}
@deffnx {Dato} mmap.MADV_DOFORK
@anchor{library/mmap mmap MADV_HWPOISON}@anchor{347d}
@deffnx {Dato} mmap.MADV_HWPOISON
@anchor{library/mmap mmap MADV_MERGEABLE}@anchor{347e}
@deffnx {Dato} mmap.MADV_MERGEABLE
@anchor{library/mmap mmap MADV_UNMERGEABLE}@anchor{347f}
@deffnx {Dato} mmap.MADV_UNMERGEABLE
@anchor{library/mmap mmap MADV_SOFT_OFFLINE}@anchor{3480}
@deffnx {Dato} mmap.MADV_SOFT_OFFLINE
@anchor{library/mmap mmap MADV_HUGEPAGE}@anchor{3481}
@deffnx {Dato} mmap.MADV_HUGEPAGE
@anchor{library/mmap mmap MADV_NOHUGEPAGE}@anchor{3482}
@deffnx {Dato} mmap.MADV_NOHUGEPAGE
@anchor{library/mmap mmap MADV_DONTDUMP}@anchor{3483}
@deffnx {Dato} mmap.MADV_DONTDUMP
@anchor{library/mmap mmap MADV_DODUMP}@anchor{3484}
@deffnx {Dato} mmap.MADV_DODUMP
@anchor{library/mmap mmap MADV_FREE}@anchor{3485}
@deffnx {Dato} mmap.MADV_FREE
@anchor{library/mmap mmap MADV_NOSYNC}@anchor{3486}
@deffnx {Dato} mmap.MADV_NOSYNC
@anchor{library/mmap mmap MADV_AUTOSYNC}@anchor{3487}
@deffnx {Dato} mmap.MADV_AUTOSYNC
@anchor{library/mmap mmap MADV_NOCORE}@anchor{3488}
@deffnx {Dato} mmap.MADV_NOCORE
@anchor{library/mmap mmap MADV_CORE}@anchor{3489}
@deffnx {Dato} mmap.MADV_CORE
@anchor{library/mmap mmap MADV_PROTECT}@anchor{348a}
@deffnx {Dato} mmap.MADV_PROTECT
@anchor{library/mmap mmap MADV_FREE_REUSABLE}@anchor{348b}
@deffnx {Dato} mmap.MADV_FREE_REUSABLE
@anchor{library/mmap mmap MADV_FREE_REUSE}@anchor{348c}
@deffnx {Dato} mmap.MADV_FREE_REUSE

Se pueden pasar estas opciones al método @ref{a9a,,mmap.madvise()}.  No todas las opciones estarán presentes en todos los sistemas.

Disponibilidad: Sistemas con la llamada al sistema `madvise()'.


Added in version 3.8.

@end deffn

@node Constantes MAP_*,,Constantes MADV_*,mmap — Memory-mapped file support
@anchor{library/mmap id1}@anchor{348d}@anchor{library/mmap map-constants}@anchor{3466}
@subsubsection Constantes MAP_*


@geindex MAP_SHARED (en el módulo mmap)
@geindex MAP_PRIVATE (en el módulo mmap)
@geindex MAP_32BIT (en el módulo mmap)
@geindex MAP_ALIGNED_SUPER (en el módulo mmap)
@geindex MAP_ANON (en el módulo mmap)
@geindex MAP_ANONYMOUS (en el módulo mmap)
@geindex MAP_CONCEAL (en el módulo mmap)
@geindex MAP_DENYWRITE (en el módulo mmap)
@geindex MAP_EXECUTABLE (en el módulo mmap)
@geindex MAP_HASSEMAPHORE (en el módulo mmap)
@geindex MAP_JIT (en el módulo mmap)
@geindex MAP_NOCACHE (en el módulo mmap)
@geindex MAP_NOEXTEND (en el módulo mmap)
@geindex MAP_NORESERVE (en el módulo mmap)
@geindex MAP_POPULATE (en el módulo mmap)
@geindex MAP_RESILIENT_CODESIGN (en el módulo mmap)
@geindex MAP_RESILIENT_MEDIA (en el módulo mmap)
@geindex MAP_STACK (en el módulo mmap)
@geindex MAP_TPRO (en el módulo mmap)
@geindex MAP_TRANSLATED_ALLOW_EXECUTE (en el módulo mmap)
@geindex MAP_UNIX03 (en el módulo mmap)
@anchor{library/mmap mmap MAP_SHARED}@anchor{3465}
@deffn {Dato} mmap.MAP_SHARED
@anchor{library/mmap mmap MAP_PRIVATE}@anchor{3464}
@deffnx {Dato} mmap.MAP_PRIVATE
@anchor{library/mmap mmap MAP_32BIT}@anchor{16ab}
@deffnx {Dato} mmap.MAP_32BIT
@anchor{library/mmap mmap MAP_ALIGNED_SUPER}@anchor{175e}
@deffnx {Dato} mmap.MAP_ALIGNED_SUPER
@anchor{library/mmap mmap MAP_ANON}@anchor{348e}
@deffnx {Dato} mmap.MAP_ANON
@anchor{library/mmap mmap MAP_ANONYMOUS}@anchor{348f}
@deffnx {Dato} mmap.MAP_ANONYMOUS
@anchor{library/mmap mmap MAP_CONCEAL}@anchor{175f}
@deffnx {Dato} mmap.MAP_CONCEAL
@anchor{library/mmap mmap MAP_DENYWRITE}@anchor{3490}
@deffnx {Dato} mmap.MAP_DENYWRITE
@anchor{library/mmap mmap MAP_EXECUTABLE}@anchor{3491}
@deffnx {Dato} mmap.MAP_EXECUTABLE
@anchor{library/mmap mmap MAP_HASSEMAPHORE}@anchor{16a6}
@deffnx {Dato} mmap.MAP_HASSEMAPHORE
@anchor{library/mmap mmap MAP_JIT}@anchor{16a8}
@deffnx {Dato} mmap.MAP_JIT
@anchor{library/mmap mmap MAP_NOCACHE}@anchor{16a7}
@deffnx {Dato} mmap.MAP_NOCACHE
@anchor{library/mmap mmap MAP_NOEXTEND}@anchor{16a5}
@deffnx {Dato} mmap.MAP_NOEXTEND
@anchor{library/mmap mmap MAP_NORESERVE}@anchor{16a4}
@deffnx {Dato} mmap.MAP_NORESERVE
@anchor{library/mmap mmap MAP_POPULATE}@anchor{1952}
@deffnx {Dato} mmap.MAP_POPULATE
@anchor{library/mmap mmap MAP_RESILIENT_CODESIGN}@anchor{16a9}
@deffnx {Dato} mmap.MAP_RESILIENT_CODESIGN
@anchor{library/mmap mmap MAP_RESILIENT_MEDIA}@anchor{16aa}
@deffnx {Dato} mmap.MAP_RESILIENT_MEDIA
@anchor{library/mmap mmap MAP_STACK}@anchor{3492}
@deffnx {Dato} mmap.MAP_STACK
@anchor{library/mmap mmap MAP_TPRO}@anchor{16ae}
@deffnx {Dato} mmap.MAP_TPRO
@anchor{library/mmap mmap MAP_TRANSLATED_ALLOW_EXECUTE}@anchor{16ac}
@deffnx {Dato} mmap.MAP_TRANSLATED_ALLOW_EXECUTE
@anchor{library/mmap mmap MAP_UNIX03}@anchor{16ad}
@deffnx {Dato} mmap.MAP_UNIX03

These are the various flags that can be passed to @ref{368,,mmap.mmap()}.  @ref{175e,,MAP_ALIGNED_SUPER}
is only available at FreeBSD and @ref{175f,,MAP_CONCEAL} is only available at OpenBSD.  Note
that some options might not be present on some systems.


Distinto en la versión 3.10: Added @ref{1952,,MAP_POPULATE} constant.



Added in version 3.11: Added @ref{3492,,MAP_STACK} constant.



Added in version 3.12: Added @ref{175e,,MAP_ALIGNED_SUPER} and @ref{175f,,MAP_CONCEAL} constants.



Added in version 3.13: Added @ref{16ab,,MAP_32BIT}, @ref{16a6,,MAP_HASSEMAPHORE}, @ref{16a8,,MAP_JIT},
@ref{16a7,,MAP_NOCACHE}, @ref{16a5,,MAP_NOEXTEND}, @ref{16a4,,MAP_NORESERVE},
@ref{16a9,,MAP_RESILIENT_CODESIGN}, @ref{16aa,,MAP_RESILIENT_MEDIA},
@ref{16ae,,MAP_TPRO}, @ref{16ac,,MAP_TRANSLATED_ALLOW_EXECUTE}, and
@ref{16ad,,MAP_UNIX03} constants.

@end deffn

@node Manejo de datos de internet,Herramientas Para Procesar Formatos de Marcado Estructurado,Comunicación en redes y entre procesos,La biblioteca estándar de Python
@anchor{library/netdata doc}@anchor{3493}@anchor{library/netdata internet-data-handling}@anchor{3494}@anchor{library/netdata netdata}@anchor{3495}
@section Manejo de datos de internet


Este capítulo describe los módulos que admiten el manejo de formatos de datos comúnmente usados en Internet.

@menu
* email — An email and MIME handling package:: 
* json — JSON encoder and decoder:: 
* mailbox — Manipulate mailboxes in various formats:: 
* mimetypes — Map filenames to MIME types:: 
* base64 — Base16@comma{} Base32@comma{} Base64@comma{} Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings. 
* binascii — Convert between binary and ASCII:: 
* quopri — Encode and decode MIME quoted-printable data:: 

@end menu

@node email — An email and MIME handling package,json — JSON encoder and decoder,,Manejo de datos de internet
@anchor{library/email doc}@anchor{3496}@anchor{library/email email-an-email-and-mime-handling-package}@anchor{3497}@anchor{library/email module-email}@anchor{3c}
@subsection @code{email} — An email and MIME handling package


@geindex module; email

`Código fuente' Lib/email/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/__init__.py}


__________________________________________________________________


The @ref{3c,,email} package is a library for managing email messages.  It is
specifically `not' designed to do any sending of email messages to SMTP
(
@geindex RFC; RFC 2821
RFC 2821@footnote{https://datatracker.ietf.org/doc/html/rfc2821.html}), NNTP, or other servers; those are functions of modules such as
@ref{ca,,smtplib}.  The @ref{3c,,email} package attempts to be as
RFC-compliant as possible, supporting 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} and 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html}, as well as
such MIME-related RFCs as 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}, 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html},
and 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.

La estructura general del paquete de correo electrónico se puede dividir en tres componentes principales, más un cuarto componente que controla el comportamiento de los otros componentes.

El componente central del paquete es un «modelo de objetos» que representa los mensajes de correo electrónico. Una aplicación interactúa con el paquete principalmente a través de la interfaz del modelo de objetos definida en el submódulo @ref{45,,message}. La aplicación puede usar esta API para hacer preguntas sobre un correo electrónico existente, para construir un nuevo correo electrónico o para agregar o eliminar subcomponentes de correo electrónico que utilizan la misma interfaz de modelo de objetos. Es decir, siguiendo la naturaleza de los mensajes de correo electrónico y sus subcomponentes MIME, el modelo de objetos de correo electrónico es una estructura de árbol de objetos que proporcionan la API @ref{3d0,,EmailMessage}.

Los otros dos componentes principales del paquete son @ref{4f,,parser} y @ref{41,,generator}. El parser toma la versión serializada de un mensaje de correo electrónico (una secuencia de bytes) Y la convierte en un árbol de objetos @ref{3d0,,EmailMessage}. El generador toma un @ref{3d0,,EmailMessage} y lo convierte de nuevo en un flujo de bytes serializado. (El analizador y el generador también manejan flujos de caracteres de texto, pero se desaconseja este uso ya que es demasiado fácil terminar con mensajes que no son válidos de una forma u otra).

El componente de control es el módulo de @ref{50,,policy}. Cada @ref{3d0,,EmailMessage} cada @ref{41,,generator}, y cada @ref{4f,,parser} tiene un objeto de @ref{50,,policy} asociado que controla su comportamiento. Por lo general, una aplicación solo necesita especificar la política cuando se crea un @ref{3d0,,EmailMessage} , ya sea instanciando directamente un @ref{3d0,,EmailMessage} para crear un nuevo correo electrónico o analizando un flujo de entrada con un @ref{4f,,parser}. Pero la política se puede cambiar cuando el mensaje se serializa mediante un @ref{41,,generator}. Esto permite, por ejemplo, analizar un mensaje de correo electrónico genérico desde el disco, pero serializarlo utilizando la configuración estándar de SMTP al enviarlo a un servidor de correo electrónico.

El paquete de correo electrónico hace todo lo posible para ocultar los detalles de las diversas RFC que rigen de la aplicación. Conceptualmente, la aplicación debería poder tratar el mensaje de correo electrónico como un árbol estructurado de texto Unicode y archivos adjuntos binarios, sin tener que preocuparse por cómo se representan estos cuando se serializan. En la práctica, sin embargo, a menudo es necesario conocer al menos algunas de las reglas que rigen los mensajes MIME y su estructura, específicamente los nombres y la naturaleza de los «tipos de contenido» MIME y cómo identifican los documentos de varias partes. En su mayor parte, este conocimiento solo debería ser necesario para aplicaciones más complejas, e incluso entonces debería ser solo la estructura de alto nivel en cuestión, y no los detalles de cómo se representan esas estructuras. Dado que los tipos de contenido MIME se utilizan ampliamente en el software moderno de Internet (no solo en el correo electrónico), este será un concepto familiar para muchos programadores.

Las siguientes secciones describen la funcionalidad del paquete @ref{3c,,email}. Comenzamos con el modelo de objetos @ref{45,,message}, que es la interfaz principal que usará una aplicación, y lo seguimos con los componentes del @ref{4f,,parser} y @ref{41,,generator} . Luego cubrimos los controles de la @ref{50,,policy}, lo que completa el tratamiento de los principales componentes de la biblioteca.

Las siguientes tres secciones cubren las excepciones que puede generar el paquete y los defectos (incumplimiento de las RFC) que el @ref{4f,,parser} puede detectar. Luego cubrimos los subcomponentes @ref{43,,headerregistry} y @ref{3e,,contentmanager}, que proporcionan herramientas para realizar una manipulación más detallada de los encabezados y cargas útiles, respectivamente. Ambos componentes contienen características relevantes para consumir y producir mensajes no triviales, pero también documentan sus API de extensibilidad, que serán de interés para aplicaciones avanzadas.

A continuación, se muestra un conjunto de ejemplos del uso de las partes fundamentales de las API cubiertas en las secciones anteriores.

Lo anterior representa la API moderna (compatible con Unicode) del paquete de correo electrónico. Las secciones restantes, comenzando con la clase @ref{3d1,,Message}, cubren la API @ref{d22,,compat32} heredada que trata mucho más directamente con los detalles de cómo se representan los mensajes de correo electrónico. La API @ref{d22,,compat32} no oculta los detalles de las RFC de la aplicación, pero para las aplicaciones que necesitan operar a ese nivel, pueden ser herramientas útiles. Esta documentación también es relevante para las aplicaciones que todavía usan la API @ref{d22,,compat32} por razones de compatibilidad con versiones anteriores.


Distinto en la versión 3.6: Documentos reorganizados y reescritos para promover la nueva API @ref{3d0,,EmailMessage}/@ref{112c,,EmailPolicy}.


Contenido de la documentación del paquete @ref{3c,,email}:

@menu
* email.message; Representing an email message: email message Representing an email message. 
* email.parser; Parsing email messages: email parser Parsing email messages. 
* email.generator; Generating MIME documents: email generator Generating MIME documents. 
* email.policy; Policy Objects: email policy Policy Objects. 
* email.errors; Exception and Defect classes: email errors Exception and Defect classes. 
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects. 
* email.contentmanager; Managing MIME Content: email contentmanager Managing MIME Content. 
* email; Ejemplos: email Ejemplos. 
* email.message.Message; Representar un mensaje de correo electrónico usando la API compat32: email message Message Representar un mensaje de correo electrónico usando la API compat32. 
* email.mime; Creating email and MIME objects from scratch: email mime Creating email and MIME objects from scratch. 
* email.header; Internationalized headers: email header Internationalized headers. 
* email.charset; Representing character sets: email charset Representing character sets. 
* email.encoders; Encoders: email encoders Encoders. 
* email.utils; Miscellaneous utilities: email utils Miscellaneous utilities. 
* email.iterators; Iterators: email iterators Iterators. 

@end menu

@node email message Representing an email message,email parser Parsing email messages,,email — An email and MIME handling package
@anchor{library/email message doc}@anchor{3498}@anchor{library/email message email-message-representing-an-email-message}@anchor{3499}@anchor{library/email message module-email message}@anchor{45}
@subsubsection @code{email.message}: Representing an email message


@geindex module; email.message

`Código fuente:' Lib/email/message.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/message.py}


__________________________________________________________________



Added in version 3.6: @footnote{
Añadido originalmente en la versión 3.4 como un @ref{10bd,,módulo provisional}. La documentación para la clase heredada `message' se movió a  @ref{349a,,email.message.Message; Representar un mensaje de correo electrónico usando la API compat32}.
}


La clase central en el paquete de @ref{3c,,email} es la clase @ref{3d0,,EmailMessage}, importada desde el módulo @ref{45,,email.message}. Esta es la clase base para el modelo de objeto @ref{3c,,email}. @ref{3d0,,EmailMessage} provee la funcionalidad clave para configurar y consultar las cabeceras, para acceder al cuerpo del mensaje, y para crear o modificar la estructura del mensaje.

Un mensaje de correo electrónico consiste en `headers' y un `payload' (al que también nos referimos como `content'). `Headers' como 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} o 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} son nombres de campos de estilo y valores, donde el nombre y valor están separados por un “:”. Los dos puntos no son parte ni del nombre ni del valor. El `payload' puede ser un simple mensaje, un objeto binario, o una secuencia estructurada de sub-mensajes, cada uno con su propio conjunto de `headers' y su propio `payload'. El último tipo de `payload' es indicado por el mensaje con un MIME como @code{multipart/*} o @code{message/rfc822} .

El modelo conceptual provisto por un objeto @ref{3d0,,EmailMessage} es el de un diccionario ordenado de cabeceras emparejadas con una carga útil que representa al cuerpo del mensaje 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, que podría ser una lista de objetos sub-@code{EmailMessage}. Además de los métodos normales de diccionario para acceder a las cabeceras y valores, tiene métodos para acceder a información especializada desde las cabeceras (por ejemplo, el tipo de contenido MIME), para operar en la carga útil, generar una versión serializada del mensaje, y recorrer recursivamente el árbol de objetos.

The @ref{3d0,,EmailMessage} dictionary-like interface is indexed by the header
names, which must be ASCII values.  The values of the dictionary are strings
with some extra methods.  Headers are stored and returned in case-preserving
form, but field names are matched case-insensitively.  The keys are ordered,
but unlike a real dict, there can be duplicates.  Additional methods are
provided for working with headers that have duplicate keys.

La carga útil es un objeto de cadena de caracteres o bytes, en el caso de objetos de mensaje simples, o una lista de objetos @ref{3d0,,EmailMessage}, para documentos de contenedor MIME como @code{multipart/*} y objetos de mensaje @code{message/rfc822}.

@geindex EmailMessage (clase en email.message)
@anchor{library/email message email message EmailMessage}@anchor{3d0}
@deffn {Clase} email.message.EmailMessage (policy=default)

Si se especifica `policy', use las reglas especificadas para actualizar y serializar la representación del mensaje. Si la política no es establecida, use @ref{349b,,default}, que sigue las reglas RFC de email excepto para el fin de línea(en lugar del RFC @code{\r\n}, usa los finales estándar de Python @code{\n} como final de línea). Para más información ve a la documentación del @ref{50,,policy}.

@geindex as_string() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage as_string}@anchor{349c}
@deffn {Método} as_string (unixfrom=False, maxheaderlen=None, policy=None)

Return the entire message flattened as a string.  When optional
`unixfrom' is true, the envelope header is included in the returned
string.  `unixfrom' defaults to @code{False}.  For backward compatibility
with the base @ref{3d1,,Message} class `maxheaderlen' is
accepted, but defaults to @code{None}, which means that by default the line
length is controlled by the
@ref{349d,,max_line_length} of the policy.  The
`policy' argument may be used to override the default policy obtained
from the message instance.  This can be used to control some of the
formatting produced by the method, since the specified `policy' will be
passed to the @ref{123b,,Generator}.

Aplanar el mensaje puede acarrear cambios en @ref{3d0,,EmailMessage} si es necesario rellenar los valores predeterminados para completar la transformación a una cadena de caracteres (por ejemplo, se pueden generar o modificar límites MIME).

Tenga en cuenta que este método se proporciona como una comodidad y quizás no sea la forma más eficiente de serializar mensajes en su aplicación, especialmente si estás tratando con múltiples mensajes. Consulte @ref{123b,,Generator} por una API más flexible para serializar mensajes. No olvide también que este método está restringido a producir mensajes serializados como «7 bit clean» cuando @code{utf8} es @code{False}, que es el valor predeterminado.


Distinto en la versión 3.6: el comportamiento predeterminado cuando `maxheaderlen' no está especificado cambió de 0 al valor de `max_line_length' de la política .

@end deffn

@geindex __str__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __str__}@anchor{349e}
@deffn {Método} __str__ ()

Equivalente a @code{as_string(policy=self.policy.clone(utf8=True))}. Permite @code{str(msg)} para producir una cadena que contenga un mensaje serializado en un formato legible.


Distinto en la versión 3.4: el método se cambió para usar @code{utf8=True}, produciendo así un 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} como representación del mensaje, en vez de ser un alias de @ref{349c,,as_string()}.

@end deffn

@geindex as_bytes() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage as_bytes}@anchor{349f}
@deffn {Método} as_bytes (unixfrom=False, policy=None)

Retorna el mensaje plano como un objeto de bytes. Cuando `unixform' es verdadero, la cabecera es incluida en la cadena de caracteres retornada. El valor predeterminado de `unixform' es @code{False}. El argumento `policy' puede ser usado para sobreescribir el valor predeterminado obtenido de la instancia del mensaje. Esto puede ser usado para controlar parte del formato producido por el método, ya que la política especificada pasará a @ref{123b,,Generator}.

Aplanar el mensaje puede acarrear cambios en @ref{3d0,,EmailMessage} si es necesario rellenar los valores predeterminados para completar la transformación a una cadena de caracteres (por ejemplo, se pueden generar o modificar límites MIME).

Tenga en cuenta que este método se proporciona como una comodidad y quizás no sea la forma más eficiente de serializar mensajes en su aplicación, especialmente si estas tratando con múltiples mensajes. Consulte @ref{123b,,Generator} por una API más flexible para serializar mensajes.
@end deffn

@geindex __bytes__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __bytes__}@anchor{34a0}
@deffn {Método} __bytes__ ()

Equivalent to @ref{349f,,as_bytes()}.  Allows @code{bytes(msg)} to produce a
bytes object containing the serialized message.
@end deffn

@geindex is_multipart() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage is_multipart}@anchor{34a1}
@deffn {Método} is_multipart ()

Retorna @code{True} si la carga útil del mensaje es una lista de objetos de sub-@ref{3d0,,EmailMessage}, de otra manera retorna @code{False}. Cuando @ref{34a1,,is_multipart()} retorna @code{False}, la carga útil deberá ser un objeto cadena de caracteres (que podría ser una carga útil binaria codificada con CTE). Note que si @ref{34a1,,is_multipart()} retorna @code{True} no necesariamente significa que «msg.get_content_maintype() == “multipart”» retornará @code{True}. Por ejemplo, @code{is_multipart} retornará @code{True} cuando la @ref{3d0,,EmailMessage} sea del tipo @code{message/rfc822}.
@end deffn

@geindex set_unixfrom() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_unixfrom}@anchor{34a2}
@deffn {Método} set_unixfrom (unixfrom)

Configura la cabecera del mensaje a `unixform', que debería ser una cadena de caracteres. (Consulte @ref{34a3,,mboxMessage} para una descripción de esta cabecera)
@end deffn

@geindex get_unixfrom() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_unixfrom}@anchor{34a4}
@deffn {Método} get_unixfrom ()

Retorna la cabecera del mensaje. Predeterminado @code{None} si la cabecera no ha sido configurada.
@end deffn

Los siguientes métodos implementan el mapeo como una interfaz para acceder a la cabecera del mensaje. Tenga en cuenta que hay algunas diferencias semánticas entre esos métodos y una interfaz de mapeo normal(es decir, diccionario). Por ejemplo, en un diccionario no hay claves duplicadas, pero pueden haber cabeceras duplicadas. Además, en los diccionarios no hay un orden garantizado para las claves retornadas por @ref{34a5,,keys()}, pero en un objeto @ref{3d0,,EmailMessage}, las cabeceras siempre regresan en orden de aparición en el mensaje original, o en el que fueron agregadas luego. Cualquier cabecera borrada y vuelta a añadir siempre se agrega al final de la lista.

Estas diferencias semánticas son intencionales y están sesgadas hacia la conveniencia en los casos de uso más comunes.

Note que en todos los casos, cualquier cabecera presente en el mensaje no se incluye en la interfaz de mapeo.

@geindex __len__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __len__}@anchor{34a6}
@deffn {Método} __len__ ()

Retorna el número total de cabeceras, incluidas las duplicadas.
@end deffn

@geindex __contains__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __contains__}@anchor{34a7}
@deffn {Método} __contains__ (name)

Retorna @code{True} si el objeto del mensaje tiene un campo llamado “nombre”. La comparación se realiza sin tener en cuenta mayúsculas o minúsculas y “nombre” no incluye “:”.  Se utiliza para el operador @code{in} Por ejemplo:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __getitem__}@anchor{34a8}
@deffn {Método} __getitem__ (name)

Retorna el valor de la cabecera nombrada. `name' no incluye el separador de dos puntos, “:”. Si la cabecera se pierde, regresa @code{None}, un @ref{438,,KeyError} no se genera nunca.

Tenga en cuenta que si el campo nombrado aparece más de una vez en la cabecera del mensaje, esa cantidad de veces el valor regresado será indefinido. Use el método @ref{34a9,,get_all()} para obtener los valores de todas las cabeceras existentes llamadas `name'.

Usando el `standard non-“compat32”', el valor regresado es una instancia de una subclase de @ref{34aa,,email.headerregistry.BaseHeader}.
@end deffn

@geindex __setitem__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __setitem__}@anchor{34ab}
@deffn {Método} __setitem__ (name, val)

Agrega una cabecera al mensaje con un campo “nombre” y un valor “val”. El campo se agrega al final de las cabeceras existentes en el mensaje.

Tenga en cuenta que esto no sobrescribe ni borra ninguna cabecera con el mismo nombre. Si quiere asegurarse de que la nueva cabecera es la única en el mensaje con el campo “nombre”, borre el campo primero, por ejemplo:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example

If the @ref{50,,policy} defines certain headers to be unique (as the standard
policies do), this method may raise a @ref{360,,ValueError} when an attempt
is made to assign a value to such a header when one already exists.  This
behavior is intentional for consistency’s sake, but do not depend on it
as we may choose to make such assignments do an automatic deletion of the
existing header in the future.
@end deffn

@geindex __delitem__() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __delitem__}@anchor{34ac}
@deffn {Método} __delitem__ (name)

Elimine todas las apariciones del campo “nombre” de las cabeceras del mensaje. No se genera ninguna excepción si el campo nombrado no está presente en las cabeceras.
@end deffn

@geindex keys() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage keys}@anchor{34a5}
@deffn {Método} keys ()

Retorna una lista de los nombres de todos los campos de la cabecera del mensaje.
@end deffn

@geindex values() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage values}@anchor{34ad}
@deffn {Método} values ()

Retorna una lista de todos los valores de los campos del mensaje.
@end deffn

@geindex items() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage items}@anchor{34ae}
@deffn {Método} items ()

Retorna una lista de tuplas de dos elementos que contienen todos los campos cabeceras y valores del mensaje.
@end deffn

@geindex get() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get}@anchor{34af}
@deffn {Método} get (name, failobj=None)

Return the value of the named header field.  This is identical to
@ref{3d8,,__getitem__()} except that optional `failobj' is returned if the
named header is missing (`failobj' defaults to @code{None}).
@end deffn

Aquí hay algunos métodos adicionales útiles relacionados con la cabecera:

@geindex get_all() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_all}@anchor{34a9}
@deffn {Método} get_all (name, failobj=None)

Retorna una lista de todos los valores para el campo `nombre'. Si no se nombran tales cabeceras en el mensaje, regresa `failobj' (por defecto @code{None})
@end deffn

@geindex add_header() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_header}@anchor{34b0}
@deffn {Método} add_header (_name, _value, **_params)

Configuración extendida de cabeceras. Este método es similar a @ref{34ab,,__setitem__()}, excepto que se pueden proporcionar parámetros de cabecera adicionales como argumentos de palabras clave.

Por cada ítem en los parámetros del diccionario `_params', la clave se toma como el nombre del parámetro, con barra baja (“_”) convertidos a guiones (“-”) (ya que en Python no se permiten “-” como identificadores). Normalmente, el parámetro debe ser añadido como @code{key='value'} a menos que el valor sea @code{None}, en ese caso solo la clave debe ser añadida.

Si el valor contiene caracteres no-ASCII, el `charset' y el lenguaje deben ser controlados especificando el valor como una triple tupla en formato @code{(CHARSET, LANGUAJE, VALUE)}, donde @code{CHARSET} es una `string' llamando al `charset' usado para codificar el valor, @code{LANGUAJE} generalmente se establece en @code{None} o en una cadena de caracteres vacía (consulte 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} para más opciones), y @code{VALUE} es el valor de la cadena de caracteres que contiene puntos de código no-ASCII. Si la triple tupla no pasa y el valor contiene caracteres no-ASCII, es automáticamente codificada en formato 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, usando @code{CHARSET} de @code{utf-8} y @code{LANGUAJE} @code{None}.

Aquí hay un ejemplo:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

Esto agregará una cabecera que se ve como:

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

Un ejemplo de la interfaz extendida con caracteres no-ASCII:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example
@end deffn

@geindex replace_header() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage replace_header}@anchor{34b1}
@deffn {Método} replace_header (_name, _value)

Reemplaza una cabecera. Reemplaza la primer cabecera encontrada en el mensaje que coincida con `_name', conservando el orden de cabeceras y uso de minúsculas (y mayúsculas) del nombre de campo de la cabecera original. Si no hay coincidencia, se lanzará un @ref{438,,KeyError}.
@end deffn

@geindex get_content_type() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_type}@anchor{34b2}
@deffn {Método} get_content_type ()

Retorna el tipo de contenido del mensaje, pasado a minúsculas de la forma @code{maintype/subtype}. Si no hay cabecera llamada @code{Content-Type} en el mensaje, regresa el valor de @ref{34b3,,get_default_type()}. Si @code{Content-Type} no es válido, retorna @code{text/plain}.

(De acuerdo con 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, los mensajes siempre tienen un tipo predeterminado, @code{get_content_type`siempre retornará un valor. :rfc:`2045`define el tipo predeterminado de un mensaje como :mimetype:`text/plain()} a menos que aparezca dentro de un contenedor @code{multipart/digest}, en cuyo caso sería @code{message/rfc822}. Si la cabecera @code{Content-Type} tiene una especificación de tipo que sea inválida, 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} exige que el tipo predeterminado sea @code{text/plain}.)
@end deffn

@geindex get_content_maintype() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_maintype}@anchor{34b4}
@deffn {Método} get_content_maintype ()

Retorna el tipo de contenido principal del mensaje. Esta es la parte  @code{maintype} de la cadena retornada por @ref{34b2,,get_content_type()}.
@end deffn

@geindex get_content_subtype() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_subtype}@anchor{34b5}
@deffn {Método} get_content_subtype ()

Retorna el tipo del sub-contenido del mensaje. Esta es la parte @code{subtype} de la cadena retornada por @ref{34b2,,get_content_type()}.
@end deffn

@geindex get_default_type() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_default_type}@anchor{34b3}
@deffn {Método} get_default_type ()

Retorna el tipo de contenido predeterminado. La mayoría de los mensajes tienen como tipo de contenido predeterminado a @code{text/plain}, a excepción de los mensajes que son sub-partes de contenedores @code{multipart/digest}. Estas sub-partes tienen como tipo de contenido predeterminado a @code{message/rfc822}.
@end deffn

@geindex set_default_type() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_default_type}@anchor{34b6}
@deffn {Método} set_default_type (ctype)

Establece el tipo de contenido predeterminado. `ctype' debería ser @code{text/plain} o @code{message/rfc822}, aunque esto no está impuesto. El tipo de contenido predeterminado no se almacena en la cabecera @code{Content-Type}, así que sólo afecta al valor de retorno de los métodos @code{get_content_type} cuando ninguna cabecera @code{Content-Type} está presente en el mensaje.
@end deffn

@geindex set_param() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_param}@anchor{34b7}
@deffn {Método} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

Establece un parámetro en el encabezado @code{Content-Type}. Si el parámetro ya existe en el encabezado, reemplace su valor con `value'. Cuando `header' es @code{Content-Type} (el predeterminado) y el encabezado aún no existe en el mensaje, agréguelo, establece su valor en @code{text/plain} y agregue el nuevo valor del parámetro. `header' opcional especifica un encabezado alternativo a @code{Content-Type}.

Si el valor contiene caracteres `non-ASCII', el `charset' y el lenguaje pueden ser especificados explícitamente con los parámetros `charset' y `language'. Opcionalmente `language' especifica el lenguaje 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, por defecto una cadena vacía. Ambos `charset' y `language' deberán ser cadenas. los valores predeterminados son @code{utf8} para `charset' y @code{None} para `language'.

Si `replace' es @code{False} (predeterminado) la cabecera se mueve al final de la lista de cabeceras. Si `replace' es @code{True}, la cabecera se actualizará en su lugar.

El uso del parámetro `requote' con objetos @ref{3d0,,EmailMessage} está obsoleto.

Note that existing parameter values of headers may be accessed through
the @ref{34b8,,params} attribute of the
header value (for example, @code{msg['Content-Type'].params['charset']}).


Distinto en la versión 3.4: Se agregó la palabra clave @code{replace}.

@end deffn

@geindex del_param() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage del_param}@anchor{34b9}
@deffn {Método} del_param (param, header='content-type', requote=True)

Elimina completamente el parámetro dado de la cabecera @code{Content-Type}. La cabecera será reescrita en su lugar, sin el parámetro o su valor. Opcionalmente `header' especifica una alternativa a @code{Content-Type}.

El uso del parámetro `requote' con objetos @ref{3d0,,EmailMessage} está obsoleto.
@end deffn

@geindex get_filename() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_filename}@anchor{34ba}
@deffn {Método} get_filename (failobj=None)

Retorna el valor del parámetro @code{filename} de la cabecera @code{Content-Disposition} del mensaje. Si la cabecera no tiene un parámetro @code{filename}, este método recae a buscar el parámetro @code{name} en la cabecera @code{Content-Type}. Si ninguno se encuentra o falta la cabecera, se retorna `failobj'. La cadena retornada siempre estará sin comillas según @ref{34bb,,email.utils.unquote()}.
@end deffn

@geindex get_boundary() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_boundary}@anchor{34bc}
@deffn {Método} get_boundary (failobj=None)

Retorna el parámetro @code{boundary} de la cabecera @code{Content-Type} del mensaje, o `failobj' si la cabecera no se encuentra o si no tiene un parámetro @code{boundary}. La cadena retornada siempre estará sin comillas según @ref{34bb,,email.utils.unquote()}.
@end deffn

@geindex set_boundary() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_boundary}@anchor{34bd}
@deffn {Método} set_boundary (boundary)

Establece el parámetro @code{boundary} de la cabecera @code{Content-Type} como `boundary'.  @ref{34bd,,set_boundary()} siempre que sea necesario pondrá comillas a `boundary'. Si el objeto mensaje no tiene cabecera @code{Content-Type} se lanza @ref{34be,,HeaderParseError}.

Note que usar este método es sutilmente diferente a borrar la cabecera @code{Content-Type} antigua y agregar una nueva con el nuevo límite utilizando @ref{34b0,,add_header()}, porque @ref{34bd,,set_boundary()} preserva el orden de la cabecera @code{Content-Type} en la lista de cabeceras.
@end deffn

@geindex get_content_charset() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_charset}@anchor{34bf}
@deffn {Método} get_content_charset (failobj=None)

Retorna el parámetro @code{charset} de la cabecera @code{Content-Type`forzado a minúsculas. Si no hay una cabecera :mailheader:`Content-Type}, o si esa cabecera no tiene el parámetro @code{charset}, se retorna `failobj'.
@end deffn

@geindex get_charsets() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_charsets}@anchor{34c0}
@deffn {Método} get_charsets (failobj=None)

Retorna una lista que contiene los nombres de los `charset' en el mensaje. Si el mensaje es @code{multipart}, la lista contendrá un elemento por cada subparte en la carga útil, de lo contrario será una lista de longitud 1.

Cada elemento de la lista será una cadena que tendrá el valor del parámetro @code{charset} en la cabecera @code{Content-Type} para la subparte representada. Si la subparte no tiene cabecera @code{Content-Type}, no tiene parámetro @code{charset}, o no es del tipo MIME principal @code{text}, entonces ese elemento en la lista retornada será `failobj'.
@end deffn

@geindex is_attachment() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage is_attachment}@anchor{34c1}
@deffn {Método} is_attachment ()

Retorna @code{True} si hay una cabecera @code{Content-Disposition} y su valor (sensible a mayúsculas) es @code{attachment}, de lo contrario retorna @code{False}.


Distinto en la versión 3.4.2: `is_attachment' ahora es un método en lugar de una propiedad, por consistencia con @ref{34c2,,is_multipart()}.

@end deffn

@geindex get_content_disposition() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_disposition}@anchor{34c3}
@deffn {Método} get_content_disposition ()

Retorna el valor en minúsculas (sin parámetros) de la cabecera @code{Content-Disposition} si el mensaje la tiene, de lo contrario retorna @code{None}. Los valores posibles para este método son `inline', `attachment' o @code{None} si el mensaje sigue 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html}.


Added in version 3.5.

@end deffn

Los siguientes métodos se refieren a interrogar y manipular el contenido (`payload') del mensaje.

@geindex walk() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage walk}@anchor{34c4}
@deffn {Método} walk ()

El método @ref{34c4,,walk()} es un generador multipropósito que puede usarse para iterar sobre todas las partes y subpartes del árbol de un objeto mensaje, ordenando el recorrido en profundidad primero. Típicamente se usaría @ref{34c4,,walk()} como el iterador en un ciclo @code{for}; cada iteración retornará la siguiente subparte.

Aquí hay un ejemplo que imprime el tipo MIME de cada parte de una estructura de mensaje de varias partes:

@c from email import message_from_binary_file
@c with open('../Lib/test/test_email/data/msg_16.txt', 'rb') as f:
@c     msg = message_from_binary_file(f)

@example
>>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain
@end example

@code{walk} itera sobre las subpartes de cualquier parte donde @ref{34a1,,is_multipart()} retorna @code{True}, aun si @code{msg.get_content_maintype() == 'multipart'} pueda retornar @code{False}. Podemos ver esto en nuestro ejemplo al hacer uso de la función auxiliar de depuración @code{_structure}:

@example
>>> from email.iterators import _structure
>>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain
@end example

Aquí las partes @code{message} no son @code{multiparts}, pero sí contienen subpartes. @code{is_multipart()} retorna @code{True} y @code{walk} desciende a las subpartes.
@end deffn

@geindex get_body() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_body}@anchor{34c5}
@deffn {Método} get_body (preferencelist=('related', 'html', 'plain'))

Retorna la parte MIME que es la mejor candidata para ser el «cuerpo» del mensaje.

`preferencelist' debe ser una secuencia de cadenas del conjunto @code{related}, @code{html}, y @code{plain}, e Indica el orden de preferencia para el tipo de contenido de la parte retornada.

Empieza a buscar coincidencias candidatas con el objeto en el que se llama al método @code{get_body}”.

Si @code{related} no está incluido en la `preferencelist', considere la parte raíz (o subparte de la parte raíz) de cualquier relacionado encontrado como candidato si la (sub-)parte coincide con una preferencia.

Cuando se encuentra una @code{multipart/related}, verifica el parámetro @code{start} y si se encuentra una parte con un @code{Content-ID} que coincida, considera solamente a ésta cuando se busca coincidencias candidatas. De otra forma considera sólo la primera parte (predeterminado `root') de la @code{multipart/related}.

Si una parte tiene una cabecera @code{Content-Disposition} , sólo se considera a ésta parte como coincidencia candidata si el valor de la cabecera es @code{inline}.

Si ninguno de los candidatos coincide con ninguna de las preferencias en `preferencelist', retorna @code{None}.

Notas: (1) Para la mayoría de las aplicaciones las únicas combinaciones de `preferencelist' que realmente tienen sentido son @code{('plain',)}, @code{('html', 'plain')}, y la predeterminada @code{('related', 'html', 'plain')}. (2) Debido a que la coincidencia comienza con el objeto en el que se llama a @code{get_body}, llamar a @code{get_body} en un @code{multipart/related} devolverá el objeto en sí a menos que la `preferencelist' tenga un valor no predeterminado. (3) Los mensajes (o partes de mensajes) que no especifican un @code{Content-Type} o cuya cabecera @code{Content-Type} sea inválida se tratarán como si fueran del tipo @code{text/plain}, que ocasionalmente puede ocasionar que @code{get_body} retorne resultados inesperados.
@end deffn

@geindex iter_attachments() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage iter_attachments}@anchor{34c6}
@deffn {Método} iter_attachments ()

Devuelve un iterador sobre todas las subpartes inmediatas del mensaje que no son partes candidatas del «body». Es decir, omitir la primer ocurrencia de cada @code{text/plain}, @code{text/html}, @code{multipart/related}, o @code{multipart/alternative} (a menos que estén marcados explícitamente como adjuntos a través de @code{Content-Disposition: attachment}) y retornar todas las partes restantes. Cuando se aplica directamente a un @code{multipart/related}, retorna un iterador sobre todas las partes relacionadas excepto la parte raíz (es decir, la parte apuntada por el parámetro @code{start}, o la primera parte si no hay un parámetro @code{start} o el parámetro @code{start} no coincide con el @code{Content-ID} de ninguna de las partes). Cuando se aplica directamente a un @code{multipart/alternative} o a un no-@code{multipart}, retorna un iterador vacío.
@end deffn

@geindex iter_parts() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage iter_parts}@anchor{34c7}
@deffn {Método} iter_parts ()

Retorna un iterador sobre todas las partes inmediatas del mensaje, que estará vacío para una no-@code{multipart}. (vea también @ref{34c4,,walk()}.)
@end deffn

@geindex get_content() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content}@anchor{34c8}
@deffn {Método} get_content (*args, content_manager=None, **kw)

Llama al método @ref{34c9,,get_content()} del `content_manager', pasando `self' como el objeto del mensaje y pasando cualquier otro argumento o palabra clave como argumentos adicionales. Si no se especifica `content_manager' se usa el @code{content_manager} especificado por la @ref{50,,policy} actual.
@end deffn

@geindex set_content() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_content}@anchor{18b1}
@deffn {Método} set_content (*args, content_manager=None, **kw)

Llama al método @ref{34ca,,set_content()} del `content_manager', pasando `self' como el objeto `message' y pasando cualquier otro argumento o palabra clave como argumentos adicionales. Si no se especifica `content_manager' se usa el @code{content_manager} especificado por la @ref{50,,policy} actual.
@end deffn

@geindex make_related() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_related}@anchor{34cb}
@deffn {Método} make_related (boundary=None)

Convierte un mensaje no-@code{multipart} a un mensaje @code{multipart/related}, moviendo cualquier cabecera @code{Content-} y la carga útil a una (nueva) primera parte del @code{multipart}. Si `boundary' se especifica, se utiliza como la cadena límite en el `multipart', de otra forma deja que el límite se cree automáticamente cuando se necesite (por ejemplo, cuando se serializa el mensaje).
@end deffn

@geindex make_alternative() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_alternative}@anchor{34cc}
@deffn {Método} make_alternative (boundary=None)

Convierte un mensaje no-@code{multipart} o un mensaje @code{multipart/related} a uno @code{multipart/alternative} moviendo cualquier cabecera @code{Content-} y la carga útil existentes a una (nueva) primera parte del @code{multipart}. Si `boundary' se especifica, se utiliza como la cadena límite en el `multipart', de otra forma deja que el límite se cree automáticamente cuando se necesite (por ejemplo, cuando se serializa el mensaje).
@end deffn

@geindex make_mixed() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_mixed}@anchor{34cd}
@deffn {Método} make_mixed (boundary=None)

Convierte un mensaje no-@code{multipart}, @code{multipart/related} o @code{multipart-alternative} a uno @code{multipart/mixed} moviendo cualquier cabecera @code{Content-} y la carga útil existentes a una (nueva) primera parte del @code{multipart}. Si `boundary' se especifica, se utiliza como la cadena límite en el `multipart', de otra forma deja que el límite se cree automáticamente cuando se necesite (por ejemplo, cuando se serializa el mensaje).
@end deffn

@geindex add_related() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_related}@anchor{34ce}
@deffn {Método} add_related (*args, content_manager=None, **kw)

Si el mensaje es un @code{multipart/related}, crea un nuevo objeto mensaje, pasa todos los argumentos a su método @ref{18b1,,set_content()} y lo une al @code{multipart} con @ref{34cf,,attach()}. Si el mensaje es un no-@code{multipart}, llama a @ref{34cb,,make_related()} y procede como arriba. Si el mensaje es cualquier otro tipo de @code{multipart}, lanza @ref{228,,TypeError}. Si `content_manager' no es especificado, usa el @code{content_manager} especificado por la @ref{50,,policy} actual. Si la parte agregada no tiene un encabezado @code{Content-Disposition}, se agrega uno con el valor @code{inline}.
@end deffn

@geindex add_alternative() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_alternative}@anchor{34d0}
@deffn {Método} add_alternative (*args, content_manager=None, **kw)

Si el mensaje es un @code{multipart/alternative}, crea un nuevo objeto mensaje, pasa todos los argumentos a su método @ref{18b1,,set_content()} y lo une al @code{multipart} con @ref{34cf,,attach()}. Si el mensaje es un no-@code{multipart} o @code{multipart/related}, llama a @ref{34cc,,make_alternative()} y procede como arriba. Si el mensaje es cualquier otro tipo de @code{multipart}, lanza @ref{228,,TypeError}. Si `content_manager' no es especificado, usa el @code{content_manager} especificado por la @ref{50,,policy} actual.
@end deffn

@geindex add_attachment() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_attachment}@anchor{34d1}
@deffn {Método} add_attachment (*args, content_manager=None, **kw)

Si el mensaje es un @code{multipart/mixed}, cree un nuevo objeto de mensaje, pase todos los argumentos a su método @ref{18b1,,set_content()} y @ref{34cf,,attach()} al @code{multipart}. Si el mensaje no es @code{multipart}, @code{multipart/related} o @code{multipart/alternative}, llame @ref{34cd,,make_mixed()} y luego proceda como se indicó anteriormente. Si no se especifica `content_manager', use el @code{content_manager} especificado por el actual @ref{50,,policy}. Si la parte agregada no tiene encabezado @code{Content-Disposition}, agregue uno con el valor @code{attachment}. Este método se puede utilizar tanto para adjuntos explícitos (@code{Content-Disposition: attachment}) como para adjuntos @code{inline} (@code{Content-Disposition: inline}), pasando las opciones apropiadas al @code{content_manager}.
@end deffn

@geindex clear() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage clear}@anchor{34d2}
@deffn {Método} clear ()

Elimina la carga útil y todas las cabeceras.
@end deffn

@geindex clear_content() (método de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage clear_content}@anchor{34d3}
@deffn {Método} clear_content ()

Remove the payload and all of the @code{!Content-} headers, leaving
all other headers intact and in their original order.
@end deffn

Los objetos @ref{3d0,,EmailMessage} tienen los siguientes atributos de instancia:

@geindex preamble (atributo de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage preamble}@anchor{34d4}
@deffn {Atributo} preamble

El formato de un documento MIME permite algo de texto entre la linea en blanco después de las cabeceras y la primera cadena límite de multiparte. Normalmente, este texto nunca es visible en un lector de correo compatible con MIME porque queda fuera de la armadura MIME estándar. Sin embargo, al ver el texto sin formato del mensaje, o al ver el mensaje en un lector no compatible con MIME, este texto puede volverse visible.

El atributo `preamble' contiene este texto extra para documentos MIME. Cuando el @ref{120d,,Parser} descubre texto después de las cabeceras pero antes de la primer cadena límite, asigna este texto al atributo `preamble' del mensaje. Cuando el @ref{123b,,Generator} escribe la representación de texto sin formato de un mensaje MIME y encuentra que el mensaje tiene un atributo `preamble' escribirá este texto en el área entre las cabeceras y el primer límite. Véase @ref{4f,,email.parser} y @ref{41,,email.generator} para conocer detalles.

Cabe señalar que si el objeto `message' no tiene preámbulo, el atributo `preamble' será igual a @code{None}.
@end deffn

@geindex epilogue (atributo de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage epilogue}@anchor{34d5}
@deffn {Atributo} epilogue

El atributo `epilogue' actúa de igual forma al atributo `preamble' con la excepción de que contiene texto que aparece entre el último límite y el fin del mensaje. Como con el @ref{34d4,,preamble}, si no hay texto de epílogo este atributo será @code{None}.
@end deffn

@geindex defects (atributo de email.message.EmailMessage)
@anchor{library/email message email message EmailMessage defects}@anchor{34d6}
@deffn {Atributo} defects

El atributo `defects' contiene una lista de todos los errores encontrados al hacer el análisis sintáctico del mensaje. Vea @ref{40,,email.errors} para una descripción detallada de los posibles efectos del análisis sintáctico.
@end deffn
@end deffn

@geindex MIMEPart (clase en email.message)
@anchor{library/email message email message MIMEPart}@anchor{fba}
@deffn {Clase} email.message.MIMEPart (policy=default)

Esta clase representa una subparte de un mensaje MIME. Es idéntica a @ref{3d0,,EmailMessage}, excepto que las cabeceras @code{MIME-Version} son añadidas cuando se llama a @ref{18b1,,set_content()}, ya que las subpartes no necesitan su propia cabecera @code{MIME-Version}.
@end deffn

@subsubheading Notas al pie


@node email parser Parsing email messages,email generator Generating MIME documents,email message Representing an email message,email — An email and MIME handling package
@anchor{library/email parser doc}@anchor{34d7}@anchor{library/email parser email-parser-parsing-email-messages}@anchor{34d8}@anchor{library/email parser module-email parser}@anchor{4f}
@subsubsection @code{email.parser}: Parsing email messages


@geindex module; email.parser

`Código fuente:' Lib/email/parser.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/parser.py}


__________________________________________________________________


Se pueden construir estructuras de objetos de mensaje de dos formas: pueden ser creados de puro invento al crear un objeto @ref{3d0,,EmailMessage}, añadir encabezados usando la interfaz de diccionario, y añadir carga(s) usando el método @ref{18b1,,set_content()} y otros relacionados, o pueden ser creados al analizar una representación serializada de un mensaje de correo electrónico.

El paquete @ref{3c,,email} proporciona un analizador estándar que entiende la mayoría de estructuras de documentos de correo electrónico, incluyendo documentos MIME.  Le puedes pasar al analizador bytes, una cadena de caracteres o una archivo de objeto, y el analizador te retornará la instancia @ref{3d0,,EmailMessage} raíz de la estructura del objeto. Para mensajes simples que no sean MIME, la carga de su objeto raíz probablemente será una cadena de caracteres conteniendo el texto o el mensaje. Para mensajes MIME, el objeto raíz retornará @code{True} de su método @ref{34a1,,is_multipart()}, y las subpartes pueden ser accedidas a través de los métodos de manipulación de carga, tales como @ref{34c5,,get_body()}, @ref{34c7,,iter_parts()}, y @ref{34c4,,walk()}.

De hecho hay dos interfaces de analizadores disponibles para usar, la API @ref{120d,,Parser} y la API progresiva @ref{34d9,,FeedParser}.  La API @ref{120d,,Parser} es más útil si tú tienes el texto del mensaje entero en memoria, o si el mensaje entero reside en un archivo en el sistema. @ref{34d9,,FeedParser} es más apropiado cuando estás leyendo el mensaje de un `stream' que puede ser bloqueado esperando más entrada (tal como leer un mensaje de correo electrónico de un socket).  El @ref{34d9,,FeedParser} puede consumir y analizar el mensaje de forma progresiva, y sólo retorna el objeto raíz cuando cierras el analizador.

Tenga en cuenta que el analizador puede ser extendido en formas limitadas, y por supuesto puedes implementar tu propio analizador completamente desde cero.  Toda la lógica que conecta el analizador empaquetado del paquete @ref{3c,,email} y la clase @ref{3d0,,EmailMessage} está encarnada en la clase @ref{1128,,Policy}, por lo que un analizador personalizado puede crear árboles de objetos mensaje en cualquier forma que encuentre necesario al implementar versiones personalizadas de los métodos apropiados de @code{Policy}.

@menu
* API FeedParser:: 
* API Parser:: 
* Notas adicionales:: 

@end menu

@node API FeedParser,API Parser,,email parser Parsing email messages
@anchor{library/email parser feedparser-api}@anchor{34da}
@subsubsection API `FeedParser'


La clase @ref{1238,,BytesFeedParser}, importado del módulo @code{email.feedparser}, proporciona una API que es propicia para el análisis progresivo de mensajes de correo electrónico, tal como sería necesario cuando se esté leyendo el texto de un mensaje de correo electrónico de una fuente que puede bloquear (tal como un socket).  Desde luego se puede usar la clase @ref{1238,,BytesFeedParser} para analizar un mensaje de correo electrónico completamente contenido en un @ref{db4,,bytes-like object}, cadena de caracteres, o archivo, pero la API @ref{1239,,BytesParser} puede ser más conveniente para tales casos de uso.  Las semánticas y resultados de las dos API de los analizadores son idénticas.

La API de @ref{1238,,BytesFeedParser} es simple; puedes crear una instancia, le proporcionas un montón de bytes hasta que no haya más necesidad de hacerlo, entonces cierras el analizador para recuperar el objeto del mensaje raíz. El @ref{1238,,BytesFeedParser} es extremadamente preciso cuando está analizando mensajes conformes al estándar, y hace un buen trabajo al analizar mensajes no conformes, proporcionando información acerca de cómo un mensaje fue considerado inservible.  Ingresará una lista de cualquier problema que encontró en el atributo @ref{34d6,,defects} del objeto mensaje.  Véase el módulo @ref{40,,email.errors} para la lista de defectos que puede encontrar.

Aquí está el API para @ref{1238,,BytesFeedParser}:

@geindex BytesFeedParser (clase en email.parser)
@anchor{library/email parser email parser BytesFeedParser}@anchor{1238}
@deffn {Clase} email.parser.BytesFeedParser (_factory=None, *, policy=policy.compat32)

Crea una instancia de @ref{1238,,BytesFeedParser}. El argumento opcional `_factory' es un invocable sin argumentos; si no se especifica, usa el @ref{d21,,message_factory} de `policy'.  Llama a `_factory' cuando sea necesario un nuevo objeto mensaje.

Si se especifica `policy', usa las reglas que especifica para actualizar la representación del mensaje.  Si `policy' no está puesta, usa la política (`policy') @ref{1129,,compat32}, que mantiene compatibilidad con la versión 3.2 de Python del paquete de correo electrónico y proporciona a @ref{3d1,,Message} como la fábrica por defecto. Todas las otras políticas proveen a @ref{3d0,,EmailMessage} como el `_factory' por defecto. Para más información en lo demás que `policy' controla, véase la documentación @ref{50,,policy}.

Nota: `La palabra clave *policy* siempre debe estar especificada'; El valor por defecto cambiará a @ref{349b,,email.policy.default} en una versión futura de Python.


Added in version 3.2.



Distinto en la versión 3.3: Se añadió la palabra clave `policy'.



Distinto en la versión 3.6: `_factory' es por defecto la `policy' @code{message_factory}.


@geindex feed() (método de email.parser.BytesFeedParser)
@anchor{library/email parser email parser BytesFeedParser feed}@anchor{34db}
@deffn {Método} feed (data)

Le proporciona al analizador algunos datos más.  `data' debe ser un @ref{db4,,bytes-like object} conteniendo una o más líneas.  Las líneas pueden ser parciales y el analizador va a juntar tales líneas parciales apropiadamente.  las líneas pueden tener cualquiera de las tres terminaciones de línea comunes: retorno de cargo (`retorno de cargo'), nueva línea (`newline'), o retorno de cargo y nueva línea (pueden ser mezclados).
@end deffn

@geindex close() (método de email.parser.BytesFeedParser)
@anchor{library/email parser email parser BytesFeedParser close}@anchor{34dc}
@deffn {Método} close ()

Completa el análisis de todos los datos previamente proporcionados y retorna la raíz del objeto mensaje. No está definido lo que pasa si se llama a @ref{34db,,feed()} después de que este método haya sido llamado.
@end deffn
@end deffn

@geindex FeedParser (clase en email.parser)
@anchor{library/email parser email parser FeedParser}@anchor{34d9}
@deffn {Clase} email.parser.FeedParser (_factory=None, *, policy=policy.compat32)

Funciona como @ref{1238,,BytesFeedParser} excepto que la entrada al método @ref{34db,,feed()} no debe ser una cadena de caracteres.  Esto es utilidad limitada, ya que la única manera de que tal mensaje sea válido es que sólo contenga texto ASCII o, si @code{utf8} es @code{True}, sin binarios adjuntos.


Distinto en la versión 3.3: Se añadió la palabra clave `policy'.

@end deffn

@node API Parser,Notas adicionales,API FeedParser,email parser Parsing email messages
@anchor{library/email parser parser-api}@anchor{34dd}
@subsubsection API `Parser'


La clase @ref{1239,,BytesParser}, importado del módulo @ref{4f,,email.parser}, proporciona una API que puede ser usada para analizar un mensaje cuando el contenido completo del mensaje esté disponible en un @ref{db4,,bytes-like object} o archivo. El módulo @ref{4f,,email.parser} también proporciona a @ref{120d,,Parser} para analizar cadenas de caracteres, y analizadores de sólo cabeceras, @ref{1130,,BytesHeaderParser} y @ref{1131,,HeaderParser} que pueden ser usados si sólo estás interesado en las cabeceras del mensaje. @ref{1130,,BytesHeaderParser} y @ref{1131,,HeaderParser} puede ser más rápidos en estas situaciones, ya que no intentan analizar el cuerpo del mensaje, en vez de eso configuran la carga al cuerpo puro.

@geindex BytesParser (clase en email.parser)
@anchor{library/email parser email parser BytesParser}@anchor{1239}
@deffn {Clase} email.parser.BytesParser (_class=None, *, policy=policy.compat32)

Crea una instancia de @ref{1239,,BytesParser}. Los argumentos `_class' y `policy' tiene el mismo significado y semántica que los argumentos `_factory' y `policy' de @ref{1238,,BytesFeedParser}.

Nota: `La palabra clave *policy* siempre debe estar especificada'; El valor por defecto cambiará a @ref{349b,,email.policy.default} en una versión futura de Python.


Distinto en la versión 3.3: Se eliminó el argumento `strict' que fue deprecado en 2.4.  Se añadió la palabra clave `policy'.



Distinto en la versión 3.6: `_class' es por defecto la política @code{message_factory}.


@geindex parse() (método de email.parser.BytesParser)
@anchor{library/email parser email parser BytesParser parse}@anchor{34de}
@deffn {Método} parse (fp, headersonly=False)

Lee todos los datos del objeto binario parecido a archivo `fp', analiza los bytes resultantes, y retorna el objeto mensaje.  `fp' debe soportar tanto el método @ref{1391,,readline()} como el método @code{read()}.

Los bytes contenidos en `fp' deben ser formateados como un bloque de cabeceras de estilo y líneas de continuación de cabecera de 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} (o, si @code{utf8} es @code{True}, 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html}).  El bloque cabecera se termina o al final de los datos o por una línea blanca.  Después del bloque de cabecera esta él cuerpo del mensaje (que puede contener subpartes codificadas como MIME, incluyendo subpartes con un @code{Content-Transfer-Encoding} de @code{8bit}).

El argumento opcional `headersonly' es un flag que especifica si se debe analizar después de leer las cabeceras o no.  El valor por defecto es @code{False}, significando que analiza el contenido entero del archivo.
@end deffn

@geindex parsebytes() (método de email.parser.BytesParser)
@anchor{library/email parser email parser BytesParser parsebytes}@anchor{34df}
@deffn {Método} parsebytes (bytes, headersonly=False)

Similar al método @ref{34de,,parse()}, excepto que toma un @ref{db4,,bytes-like object} en vez de un objeto similar a un archivo.  Llamar a este método en un @ref{db4,,bytes-like object} es equivalente a envolver a `bytes' en una instancia de @ref{f25,,BytesIO} primero y llamar a @ref{34de,,parse()}.

El argumento opcional `headersonly' es como el método @ref{34de,,parse()}.
@end deffn


Added in version 3.2.

@end deffn

@geindex BytesHeaderParser (clase en email.parser)
@anchor{library/email parser email parser BytesHeaderParser}@anchor{1130}
@deffn {Clase} email.parser.BytesHeaderParser (_class=None, *, policy=policy.compat32)

Exactamente como @ref{1239,,BytesParser}, excepto que `headersonly' es por defecto @code{True}.


Added in version 3.3.

@end deffn

@geindex Parser (clase en email.parser)
@anchor{library/email parser email parser Parser}@anchor{120d}
@deffn {Clase} email.parser.Parser (_class=None, *, policy=policy.compat32)

Esta clase es paralela a @ref{1239,,BytesParser}, pero trata entradas de cadenas de caracteres.


Distinto en la versión 3.3: Se eliminó el argumento `strict'.  Se añadió la palabra clave `policy'.



Distinto en la versión 3.6: `_class' es por defecto la política @code{message_factory}.


@geindex parse() (método de email.parser.Parser)
@anchor{library/email parser email parser Parser parse}@anchor{34e0}
@deffn {Método} parse (fp, headersonly=False)

Lee todos los datos del modo texto del objeto parecido a archivo `fp', analiza el texto resultante, y retorna el objeto mensaje raíz.  `fp' debe soportar tanto el método @ref{1cc4,,readline()} y el método @ref{1c8c,,read()} en objetos parecidos a archivos.

Además de el requisito del modo texto, este método opera como @ref{34de,,BytesParser.parse()}.
@end deffn

@geindex parsestr() (método de email.parser.Parser)
@anchor{library/email parser email parser Parser parsestr}@anchor{34e1}
@deffn {Método} parsestr (text, headersonly=False)

Similar al método @ref{34e0,,parse()}, excepto que toma un objeto de cadena de caracteres de un objeto similar a un archivo.  Llamar a este método en una cadena de caracteres es equivalente a envolver a `text' en una instancia de @ref{fa9,,StringIO} primero y llamar a @ref{34e0,,parse()}.

El argumento opcional `headersonly' es como el método @ref{34e0,,parse()}.
@end deffn
@end deffn

@geindex HeaderParser (clase en email.parser)
@anchor{library/email parser email parser HeaderParser}@anchor{1131}
@deffn {Clase} email.parser.HeaderParser (_class=None, *, policy=policy.compat32)

Exactamente como @ref{120d,,Parser}, excepto que `headersonly' es por defecto @code{True}.
@end deffn

Ya que crear una estructura de un objeto mensaje de una cadena de caracteres o un objeto archivo es una tarea tan común, Se proporcionaron 4 funciones como una conveniencia.  Están disponibles en paquete de espacio de nombres de alto nivel @ref{3c,,email}.

@geindex message_from_bytes() (en el módulo email)
@anchor{library/email parser email message_from_bytes}@anchor{1236}
@deffn {Función} email.message_from_bytes (s, _class=None, *, policy=policy.compat32)

Retorna una estructura del objeto mensaje de un @ref{db4,,bytes-like object}. Esto es equivalente a @code{BytesParser().parsebytes(s)}. El argumento opcional `_class' y `policy' son interpretados como sucede con el constructor de clase @ref{1239,,BytesParser}.


Added in version 3.2.



Distinto en la versión 3.3: Se eliminó el argumento `strict'.  Se añadió la palabra clave `policy'.

@end deffn

@geindex message_from_binary_file() (en el módulo email)
@anchor{library/email parser email message_from_binary_file}@anchor{1237}
@deffn {Función} email.message_from_binary_file (fp, _class=None, *, policy=policy.compat32)

Retorna una estructura árbol del objeto mensaje de un @ref{1230,,file object} binario abierto.  Esto es equivalente a @code{BytesParser().parse(fp)}.  `_class' y `policy' son interpretados como sucede con el constructor de clase @ref{1239,,BytesParser}.


Added in version 3.2.



Distinto en la versión 3.3: Se eliminó el argumento `strict'.  Se añadió la palabra clave `policy'.

@end deffn

@geindex message_from_string() (en el módulo email)
@anchor{library/email parser email message_from_string}@anchor{34e2}
@deffn {Función} email.message_from_string (s, _class=None, *, policy=policy.compat32)

Retorna una estructura del objeto mensaje de una cadena de caracteres.  Esto es equivalente a @code{Parser().parsestr(s)}. `_class' y `policy' son interpretados como sucede con el constructor de clase @ref{120d,,Parser}.


Distinto en la versión 3.3: Se eliminó el argumento `strict'.  Se añadió la palabra clave `policy'.

@end deffn

@geindex message_from_file() (en el módulo email)
@anchor{library/email parser email message_from_file}@anchor{34e3}
@deffn {Función} email.message_from_file (fp, _class=None, *, policy=policy.compat32)

Retorna una estructura árbol del objeto mensaje de un @ref{1230,,file object} abierto. Esto es equivalente a @code{Parser().parse(fp)}.  `_class' y `policy' son interpretados como sucede con el constructor de clase @ref{120d,,Parser}.


Distinto en la versión 3.3: Se eliminó el argumento `strict'.  Se añadió la palabra clave `policy'.



Distinto en la versión 3.6: `_class' es por defecto la política @code{message_factory}.

@end deffn

Aquí está un ejemplo de cómo puedes usar @ref{1236,,message_from_bytes()} en una entrada interactiva de Python:

@example
>>> import email
>>> msg = email.message_from_bytes(myBytes)  
@end example

@node Notas adicionales,,API Parser,email parser Parsing email messages
@anchor{library/email parser additional-notes}@anchor{34e4}
@subsubsection Notas adicionales


Aquí están algunas notas sobre la semántica del análisis:


@itemize *

@item 
La mayoría de los mensajes de tipo que no son @code{multipart} son actualizados como un solo objeto mensaje con una carga de cadena de caracteres.  Estos objetos retornarán @code{False} para @ref{34a1,,is_multipart()}, y @ref{34c7,,iter_parts()} cederá (`yield') una lista vacía.

@item 
Todos los mensajes de tipo @code{multipart} serán analizados como un objeto mensaje contenedor con una lista de objetos sub-mensajes para sus cargas.  El mensaje del contenedor externo retornará @code{True} para @ref{34a1,,is_multipart()}, y @ref{34c7,,iter_parts()} cederá (`yield') una lista de subpartes.

@item 
La mayoría de mensajes con una tipo de contenido de @code{message/*} (tal como @code{message/delivery-status} y @code{message/rfc822}) también serán analizados como objetos contenedores que contienen una lista de cargas de longitud 1. Su método @ref{34a1,,is_multipart()} retornará @code{True}. El único elemento cedido (`yielded') por @ref{34c7,,iter_parts()} será un objeto sub-mensaje.

@item 
Algunos mensajes de conformidad no estándar pueden no ser internamente consistentes acerca de su @code{multipart}-idad. Tales mensajes pueden tener una cabecera @code{Content-Type} de tipo @code{multipart}, pero su método @ref{34a1,,is_multipart()} puede retornar @code{False}. Si tales mensajes son analizados con @ref{34d9,,FeedParser}, tendrán una instancia de la clase @code{MultipartInvariantViolationDefect} en su lista de atributos `defects'.  Véase @ref{40,,email.errors} para más detalles.
@end itemize

@node email generator Generating MIME documents,email policy Policy Objects,email parser Parsing email messages,email — An email and MIME handling package
@anchor{library/email generator doc}@anchor{34e5}@anchor{library/email generator email-generator-generating-mime-documents}@anchor{34e6}@anchor{library/email generator module-email generator}@anchor{41}
@subsubsection @code{email.generator}: Generating MIME documents


@geindex module; email.generator

`Código fuente:' Lib/email/generator.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/generator.py}


__________________________________________________________________


One of the most common tasks is to generate the flat (serialized) version of
the email message represented by a message object structure.  You will need to
do this if you want to send your message via @ref{ed9,,smtplib.SMTP.sendmail()},
or print the message on the console.  Taking a
message object structure and producing a serialized representation is the job
of the generator classes.

Al igual que con el módulo @ref{4f,,email.parser}, no se limita a la funcionalidad del generador incluido; se podría escribir uno desde cero. Sin embargo, el generador incluido sabe cómo generar la mayoría del correo electrónico de una manera compatible con los estándares, debería controlar los mensajes de correo electrónico MIME y no MIME bien. Está diseñado para que las operaciones de análisis y generación orientadas a bytes sean inversas, asumiendo que se utilice la misma @ref{50,,policy} de no transformación para ambos. Es decir, analizar la secuencia de bytes serializada a través de la clase @ref{1239,,BytesParser} y, a continuación, regenerar la secuencia de bytes serializada mediante @ref{123c,,BytesGenerator} debe producir una salida idéntica a la entrada @footnote{
This statement assumes that you use the appropriate setting for
@code{unixfrom}, and that there are no @ref{50,,email.policy} settings calling for
automatic adjustments (for example,
@ref{34e7,,refold_source} must be @code{none}, which is
`not' the default).  It is also not 100% true, since if the message
does not conform to the RFC standards occasionally information about the
exact original text is lost during parsing error recovery.  It is a goal
to fix these latter edge cases when possible.
}. (Por otro lado, el uso del generador en un @ref{3d0,,EmailMessage} construido por el programa puede dar lugar a cambios en el objeto @ref{3d0,,EmailMessage} a medida que se rellenan los valores predeterminados.)

La clase @ref{123b,,Generator} se puede utilizar para acoplar un mensaje en una representación serializada de texto (a diferencia de la binaria). Sin embargo, como Unicode no puede representar datos binarios directamente, el mensaje es necesariamente transformado en algo que contiene sólo caracteres ASCII. Se utiliza las técnicas de codificación de transferencia de contenido RFC de correo electrónico estándar para codificar mensajes de correo electrónico para el transporte a través de canales que no son «8 bits limpios».

Para adaptar procesamiento reproducible de mensajes firmados por SMIME,  @ref{123b,,Generator} deshabilita el encabezamiento para las partes del mensaje de tipo @code{multipart/signed} y todas sus subpartes.

@geindex BytesGenerator (clase en email.generator)
@anchor{library/email generator email generator BytesGenerator}@anchor{123c}
@deffn {Clase} email.generator.BytesGenerator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

Retorna un objeto @ref{123c,,BytesGenerator} que escribirá cualquier mensaje provisto por el método @ref{34e8,,flatten()}, o cualquier texto de escape sustituto cifrado con el método @ref{34e9,,write()}, al @ref{2586,,file-like object} `outfp'. `outfp' debe soportar un método @code{write} que acepte datos binarios.

If optional `mangle_from_' is @code{True}, put a @code{>} character in front of
any line in the body that starts with the exact string @code{"From "}, that is
@code{From} followed by a space at the beginning of a line.  `mangle_from_'
defaults to the value of the @ref{e7b,,mangle_from_}
setting of the `policy' (which is @code{True} for the
@ref{d22,,compat32} policy and @code{False} for all others).
`mangle_from_' is intended for use when messages are stored in Unix mbox
format (see @ref{8b,,mailbox} and WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

Si `maxheaderlen' no es @code{None}, se repliega las líneas de encabezado que son mayores que `maxheaderlen', o si es @code{0}, no se reenvuelve ningún encabezado. Si `manheaderlen' es @code{None} (predeterminado), se envuelven los encabezados y otras líneas de mensajes de acuerdo a los ajustes de `policy'.

Si la `norma' es especificada, se usa esa norma para controlar la generación de mensajes. Si la `norma' es @code{None} (predeterminado), se usa la norma asociada con el @ref{3d1,,Message} o el objeto @ref{3d0,,EmailMessage} pasado para @code{flatten} para controlar la generación del mensaje. Se puede ver @ref{50,,email.policy} para detalles de que controla la `norma'.


Added in version 3.2.



Distinto en la versión 3.3: Agregada la palabra clave `norma'.



Distinto en la versión 3.6: El comportamiento predeterminado de los parámetros `mangle_from_' y `maxheaderlen' es para seguir la norma.


@geindex flatten() (método de email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator flatten}@anchor{34e8}
@deffn {Método} flatten (msg, unixfrom=False, linesep=None)

Imprime la representación textual de la estructura del objeto de mensaje originada en `msg' al archivo de salida especificado cuando se creó la instancia @ref{123c,,BytesGenerator}.

Si el tipo @ref{34ea,,cte_type} de la opción @ref{50,,policy} es @code{8bit} (valor predeterminado), se copia los encabezados en el mensaje analizado original que no se hayan modificado con ningún bytes a la salida con el conjunto de bits altos, reproducido como en el original, y se conserva el @code{Content-Transfer-Encoding} no ASCII de cualquier parte del cuerpo que los tenga. Si @code{cte_type} es @code{7bit}, se convierte los bytes con el conjunto de bits altos según sea necesario utilizando un @code{Content-Transfer-Encoding} compatible con ASCII . Es decir, se transforma partes con @code{Content-Transfer-Encoding} no ASCII (@code{Content-Transfer-Encoding: 8bit}) en un conjunto de caracteres compatible con ASCII @code{Content-Transfer-Encoding}, y se codifica bytes inválidos RFC no ASCII en encabezados mediante el conjunto de caracteres MIME @code{unknown-8bit}, lo que los convierte en compatibles con RFC.

@c XXX: There should be an option that just does the RFC
@c compliance transformation on headers but leaves CTE 8bit parts alone.

Si `unixfrom' es @code{True}, se imprime el delimitador de encabezado de sobre utilizado por el formato de buzón de correo Unix (consulta @ref{8b,,mailbox}) antes del primero de los encabezados 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} del objeto de mensaje raíz. Si el objeto raíz no tiene encabezado de sobre, se crea uno estándar. El valor predeterminado es @code{False}. Tener en cuenta que para las subpartes, nunca se imprime ningún encabezado de sobre.

Si `linesep' no es @code{None}, se usa como caracter separador entre todas las líneas del mensaje acoplado. Si `linesep' es @code{None} (predeterminado), se usa el valor especificado en la `norma'.

@c XXX: flatten should take a *policy* keyword.
@end deffn

@geindex clone() (método de email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator clone}@anchor{34eb}
@deffn {Método} clone (fp)

Retorna un clon independiente de esta instancia de  @ref{123c,,BytesGenerator} con las mismas configuraciones exactas, y `fp' como el nuevo `outfp'.
@end deffn

@geindex write() (método de email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator write}@anchor{34e9}
@deffn {Método} write (s)

Codifica `s' usando el códec @code{ASCII} u el manipulador de error @code{escape sustituto}, y lo pasa al método `write' del `outfp' pasado al constructor de la clase @ref{123c,,BytesGenerator}.
@end deffn
@end deffn

Como conveniencia, @ref{3d0,,EmailMessage} provee los métodos @ref{349f,,as_bytes()} y @code{bytes(aMessage)} (también conocido como @ref{34a0,,__bytes__()}) que simplifican la generación de la representación serializada binaria de un objeto mensaje. Para más detalle, ver @ref{45,,email.message}.

Dado que las cadenas de caracteres no pueden representar datos binarios, la clase @ref{123b,,Generator} debe convertir los datos binarios en cualquier mensaje que aplane a un formato compatible con ASCII, convirtiéndolos en un @code{Content-Transfer_Encoding} compatible con ASCII. Usando la terminología de RFC de correo electrónico, se puede pensar en esto como @ref{123b,,Generator} serializando a una secuencia de E/S que no es `«8 bit clean»'. En otras palabras, la mayoría de las aplicaciones querrán usar @ref{123c,,BytesGenerator}, y no @ref{123b,,Generator}.

@geindex Generator (clase en email.generator)
@anchor{library/email generator email generator Generator}@anchor{123b}
@deffn {Clase} email.generator.Generator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

Retorna un objeto @ref{123b,,Generator} que escribirá cualquier mensaje provisto al método @ref{34ec,,flatten()}, o cualquier texto provisto al método @ref{34ed,,write()}, al @ref{2586,,file-like object} `outfp'. `outfp' debe soportar un método @code{write} que acepte datos de cadena de caracteres.

If optional `mangle_from_' is @code{True}, put a @code{>} character in front of
any line in the body that starts with the exact string @code{"From "}, that is
@code{From} followed by a space at the beginning of a line.  `mangle_from_'
defaults to the value of the @ref{e7b,,mangle_from_}
setting of the `policy' (which is @code{True} for the
@ref{d22,,compat32} policy and @code{False} for all others).
`mangle_from_' is intended for use when messages are stored in Unix mbox
format (see @ref{8b,,mailbox} and WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

Si `maxheaderlen' no es @code{None}, se repliega las líneas de encabezado que son mayores que `maxheaderlen', o si es @code{0}, no se reenvuelve ningún encabezado. Si `manheaderlen' es @code{None} (predeterminado), se envuelven los encabezados y otras líneas de mensajes de acuerdo a los ajustes de `policy'.

Si la `norma' es especificada, se usa esa norma para controlar la generación de mensajes. Si la `norma' es @code{None} (predeterminado), se usa la norma asociada con el @ref{3d1,,Message} o el objeto @ref{3d0,,EmailMessage} pasado para @code{flatten} para controlar la generación del mensaje. Se puede ver @ref{50,,email.policy} para detalles de que controla la `norma'.


Distinto en la versión 3.3: Agregada la palabra clave `norma'.



Distinto en la versión 3.6: El comportamiento predeterminado de los parámetros `mangle_from_' y `maxheaderlen' es para seguir la norma.


@geindex flatten() (método de email.generator.Generator)
@anchor{library/email generator email generator Generator flatten}@anchor{34ec}
@deffn {Método} flatten (msg, unixfrom=False, linesep=None)

Imprime la representación textual de la estructura del objeto de mensaje originado en el `msg' al archivo especificado de salida cuando la instancia de @ref{123b,,Generator} fue creada.

Si la opción @ref{50,,policy} @ref{34ea,,cte_type} es @code{8bit}, se genera el mensaje como si la opción estuviera establecida en @code{7bit}. (Esto es necesario porque las cadenas de caracteres no pueden representar bytes que no sean ASCII). Convierte cualesquiera bytes con el conjunto de bits alto según sea necesario utilizando un @code{Content-Transfer-Encoding} compatible con ASCII. Es decir, transforma partes con @code{Content-Transfer-Encoding} (@code{Content-Transfer-Encoding: 8bit}) no ASCII en un conjunto de caracteres @code{Content-Transfer-Encoding} compatible con ASCII. Y codifica bytes no ASCII RFC inválidos ASCII en encabezados mediante el conjunto de caracteres MIME @code{unknown-8bit}, lo que los convierte en compatibles con RFC.

Si `unixfrom' es @code{True}, se imprime el delimitador de encabezado de sobre utilizado por el formato de buzón de correo Unix (consulta @ref{8b,,mailbox}) antes del primero de los encabezados 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} del objeto de mensaje raíz. Si el objeto raíz no tiene encabezado de sobre, se crea uno estándar. El valor predeterminado es @code{False}. Tener en cuenta que para las subpartes, nunca se imprime ningún encabezado de sobre.

Si `linesep' no es @code{None}, se usa como caracter separador entre todas las líneas del mensaje acoplado. Si `linesep' es @code{None} (predeterminado), se usa el valor especificado en la `norma'.

@c XXX: flatten should take a *policy* keyword.


Distinto en la versión 3.2: Agrega soporte para el recodificado de cuerpos de mensajes @code{8bit}, y el argumento `linesep'.

@end deffn

@geindex clone() (método de email.generator.Generator)
@anchor{library/email generator email generator Generator clone}@anchor{34ee}
@deffn {Método} clone (fp)

Retorna un clon independiente de esta instancia de  @ref{123b,,Generator} con las mismas opciones exactas y `fp' como la nueva `outfp'.
@end deffn

@geindex write() (método de email.generator.Generator)
@anchor{library/email generator email generator Generator write}@anchor{34ed}
@deffn {Método} write (s)

Escribe `s' al método `write' del `outfp' pasado al constructor de la @ref{123b,,Generator}. Esto provee justo la suficiente API de tipo archivo para instancias de @ref{123b,,Generator} para ser usadas en la función @ref{ff4,,print()}.
@end deffn
@end deffn

Para conveniencia, @ref{3d0,,EmailMessage}  provee los métodos  @ref{349c,,as_string()} y @code{str(aMessage)} (también conocido como @ref{349e,,__str__()}), que simplifican la generación de una representación de una cadena de caracteres formateada de un objeto mensaje. Para más detalles, ver @ref{45,,email.message}.

El módulo @ref{41,,email.generator} también provee una clase derivada, @ref{d20,,DecodedGenerator}, la cual es como la clase base @ref{123b,,Generator}, excepto que las partes no @code{text} no están serializadas, sino que en su lugar, están representadas en el flujo de salida por una cadena de caracteres derivada de una plantilla llenada con información sobre la parte.

@geindex DecodedGenerator (clase en email.generator)
@anchor{library/email generator email generator DecodedGenerator}@anchor{d20}
@deffn {Clase} email.generator.DecodedGenerator (outfp, mangle_from_=None, maxheaderlen=None, fmt=None, *, policy=None)

Se actúa como @ref{123b,,Generator}, excepto para cualquier subparte del mensaje pasado a @ref{34ec,,Generator.flatten()}, si la subparte es de tipo principal @code{text}, se imprime la carga útil decodificada de la subparte, y si el tipo principal no es @code{text}, en lugar de imprimirlo se rellena la cadena de caracteres `fmt' utilizando la información de la parte y se imprime la cadena de caracteres rellenada resultante.

Para llenar `fmt', se ejecuta @code{fmt % part_info}, donde @code{part_info} es un diccionario compuesto por las siguientes claves y valores:


@itemize *

@item 
@code{type} – Todo el tipo MIME de la parte no@code{text}

@item 
@code{maintype} – Principal tipo MIME de la parte no@code{text}

@item 
@code{subtype} – Tipo sub-MIME de la parte no-@code{text}

@item 
@code{filename} – Nombre de archivo de la parte no@code{text}

@item 
@code{description} – Descripción asociada con la parte no@code{text}

@item 
@code{encoding} – Codificado de la transferencia del contenido de la parte no-@code{text}
@end itemize

Si `fmt' es @code{None}, se usa el siguiente `fmt' predeterminado:

@quotation

«[Non-text (%(type)s) part of message omitted, filename %(filename)s]»
@end quotation

Los opcionales `_mangle_from_' y `maxheaderlen' son como en la clase base @ref{123b,,Generator}.
@end deffn

@subsubheading Notas al pie


@node email policy Policy Objects,email errors Exception and Defect classes,email generator Generating MIME documents,email — An email and MIME handling package
@anchor{library/email policy doc}@anchor{34ef}@anchor{library/email policy email-policy-policy-objects}@anchor{34f0}@anchor{library/email policy module-email policy}@anchor{50}
@subsubsection @code{email.policy}: Policy Objects


@geindex module; email.policy


Added in version 3.3.


`Código fuente:' Lib/email/policy.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/policy.py}


__________________________________________________________________


El enfoque principal del paquete @ref{3c,,email} es la gestión de mensajes de correo electrónico como se describe por los varios RFC de correos electrónicos y MIME. Sin embargo, el formato general de los mensajes de correo electrónico (un bloque de campos de cabecera cada uno consistiendo en un nombre seguido de dos puntos seguido de un valor, el bloque entero seguido por una línea blanca y un “cuerpo” arbitrario), es un formato que ha encontrado utilidad fuera del campo de correos electrónicos. Algunos de estos usos cumplen bastante cerca los RFC de correos electrónicos principales, alguno no.  Incluso cuando se trabajo con correos electrónicos, hay veces cuando es deseable romper la estricta conformidad con los RFC, tal como generar correos electrónicos que se integran con servidores de correos electrónicos que no siguen los estándares, o que implementan extensiones que quieres usar en formas que violan los estándares.

Los objetos `policy' dan al paquete de correos electrónicos la flexibilidad de manejar todos estos casos de uso diversos.

Un objeto @ref{1128,,Policy} encapsula un conjunto de atributos y métodos que controlan el comportamiento de varios componentes del paquete de correos electrónicos durante el uso. Las instancias @ref{1128,,Policy} pueden ser pasadas a varias clases y métodos en el paquete de correos electrónicos para alterar el comportamiento por defecto.  Los valores que se pueden configurar y sus valores por defecto se describen abajo.

Hay una `policy' por defecto usada por todas las clases en el paquete de correos electrónicos.  Para todos las clases @code{Parser} y las funciones de conveniencia relacionadas, y para la clase @ref{3d1,,Message}, esta es una `policy' @ref{1129,,Compat32}, a través de sus correspondientes instancias @ref{d22,,compat32} pre-definidas.  Esta política mantiene una compatibilidad (en algunos casos, compatibilidad con los bugs) con el paquete de correos electrónicos de las versiones anteriores de Python3.3.

El valor por defecto para la palabra clave `policy' de @ref{3d0,,EmailMessage} es la `policy' @ref{112c,,EmailPolicy}, a través de su instancia pre-definida @ref{349b,,default}.

Cuando un objeto @ref{3d1,,Message} o @ref{3d0,,EmailMessage} es creado, adquiere un `policy'.  Si el mensaje es creado por un @ref{4f,,parser}, un `policy' pasado al analizador será el `policy' usado por el mensaje que cree.  Si el mensaje es creado por el programa, entonces el `policy' puede ser especificado cuando sea creado.  Cuando un mensaje es pasado a un @ref{41,,generator}, el generador usa el `policy' del mensaje por defecto, pero también puedes pasar un `policy' específico al generador que anulará el que está guardado en el objeto mensaje.

El valor por defecto del argumento por palabra clave `policy' para las clases @ref{4f,,email.parser} y las funciones de conveniencia del analizador `se cambiarán' en una futura versión de Python.  Por consiguiente, `siempre debes especificar explícitamente qué policy quieres usar' cuando se llama a cualquiera de las clases y funciones descritas en el módulo @ref{4f,,parser}.

La primera parte de esta documentación cubre las características de @ref{1128,,Policy}, un @ref{1224,,abstract base class} que define las características que son comunes a todos los objetos `policy', incluyendo @ref{d22,,compat32}.  Esto incluye ciertos métodos gancho (`hook') que son llamados internamente por el paquete de correos electrónicos, que un `policy' personalizado puede invalidar para obtener un comportamiento diferente. La segunda parte describe las clases concretas @ref{112c,,EmailPolicy} y @ref{1129,,Compat32}, que implementan los ganchos (`hooks') que proporcionan el comportamiento estándar y el comportamiento y características compatibles hacia atrás, respectivamente.

Las instancias @ref{1128,,Policy} son inmutables, pero pueden ser clonadas, aceptando los mismos argumentos de palabra clave que el constructor de clase y retorna una nueva instancia @ref{1128,,Policy} que es una copia del original pero con los valores de atributos específicos cambiados.

Como un ejemplo, el siguiente código puede ser usado para leer un mensaje de correo electrónico de un archivo en disco y pasarlo al programa de sistema @code{sendmail} en un sistema Unix:

@c from unittest import mock
@c mocker = mock.patch('subprocess.Popen')
@c m = mocker.start()
@c proc = mock.MagicMock()
@c m.return_value = proc
@c proc.stdin.close.return_value = None
@c mymsg = open('mymsg.txt', 'w')
@c mymsg.write('To: abc@xyz.com\n\n')
@c mymsg.flush()

@example
>>> from email import message_from_binary_file
>>> from email.generator import BytesGenerator
>>> from email import policy
>>> from subprocess import Popen, PIPE
>>> with open('mymsg.txt', 'rb') as f:
...     msg = message_from_binary_file(f, policy=policy.default)
...
>>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE)
>>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n'))
>>> g.flatten(msg)
>>> p.stdin.close()
>>> rc = p.wait()
@end example

@c mymsg.close()
@c mocker.stop()
@c import os
@c os.remove('mymsg.txt')

Aquí le estamos diciendo a @ref{123c,,BytesGenerator} que use los caracteres de separación de línea correctos de RFC cuando crea la cadena binaria para alimentar a @code{stding} de @code{sendmail} (@code{sendmails's} @code{stdin}), donde el `policy' por defecto usaría separadores de línea @code{\n}.

Algunos métodos del paquete de correos electrónicos aceptan un argumento de palabra clave `policy', permitiendo que el `policy' pueda ser anulado para ese método.  Por ejemplo, el siguiente código usa el método @ref{fb7,,as_bytes()} del objeto `msg' del ejemplo anterior y escribe el mensaje en un archivo usando los separadores de línea nativos para la plataforma en el que esté corriendo:

@example
>>> import os
>>> with open('converted.txt', 'wb') as f:
...     f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep)))
17
@end example

Los objetos `policy' puede ser combinados usando el operador de adición, produciendo un objeto `policy' cuya configuración es una combinación de los valores que de los objetos sumados:

@example
>>> compat_SMTP = policy.compat32.clone(linesep='\r\n')
>>> compat_strict = policy.compat32.clone(raise_on_defect=True)
>>> compat_strict_SMTP = compat_SMTP + compat_strict
@end example

Esta operación no es conmutativa; es decir, el orden en el que los objetos son añadidos importa.  Para ilustrar:

@example
>>> policy100 = policy.compat32.clone(max_line_length=100)
>>> policy80 = policy.compat32.clone(max_line_length=80)
>>> apolicy = policy100 + policy80
>>> apolicy.max_line_length
80
>>> apolicy = policy80 + policy100
>>> apolicy.max_line_length
100
@end example

@geindex Policy (clase en email.policy)
@anchor{library/email policy email policy Policy}@anchor{1128}
@deffn {Clase} email.policy.Policy (**kw)

Este es el @ref{1224,,abstract base class} para todas las clases `policy'.  Proporciona las implementaciones por defecto para un par de métodos triviales, también como la implementación de las propiedades de inmutabilidad, el método @ref{112a,,clone()}, y las semánticas del constructor.

Se pueden pasar varios argumentos de palabra clave al constructor de una clase `policy'.  Los argumentos que pueden ser especificados son cualquier propiedad que no sea método en esta clase, además de cualquier otra propiedad adicional que no sea método en la clase concreta.  Un valor especificado en el constructor anulará el valor por defecto para los atributos correspondientes.

Esta clase define las siguientes propiedades, y por consiguiente los valores a continuación pueden ser pasados al constructor de cualquier clase `policy':

@geindex max_line_length (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy max_line_length}@anchor{349d}
@deffn {Atributo} max_line_length

El tamaño máximo de cualquier línea en la salida serializada, sin contar el fin de la línea de carácter(res).  Por defecto es 78, por el 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}. Un valor de @code{0} o @ref{716,,None} indica que ningún envolvimiento de líneas puede ser hecha en lo más mínimo.
@end deffn

@geindex linesep (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy linesep}@anchor{34f1}
@deffn {Atributo} linesep

La cadena de caracteres a ser usada para terminar las líneas en una salida serializada.  El valor por defecto es @code{\n} porque esa es la disciplina del fin de línea interna usada por Python, aunque @code{\r\n} es requerida por los RFCs.
@end deffn

@geindex cte_type (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy cte_type}@anchor{34ea}
@deffn {Atributo} cte_type

Controla el tipo de Codificaciones de Transferencia de Contenido que pueden ser o son necesarios para ser usados.  Los valores posibles son:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{7bit}

@tab

todos los datos deben ser «compatibles con 7 bit (`7 bit clean')» (ASCII-only).  Esto significa que donde sea necesario, los datos serán codificados usando o codificación imprimible entre comillas o base64.

@item

@code{8bit}

@tab

los datos no son limitados a ser compatibles con 7 bits (`7 bit clean').  Se requiere que los datos en las cabeceras todavía sean sólo ASCII y por lo tanto estarán codificadas (véase @ref{34f2,,fold_binary()} y @ref{e7d,,utf8} abajo por las excepciones), pero las partes del cuerpo pueden usar @code{8bit} CTE.

@end multitable


Un valor @code{cte_type} de @code{`8bit} sólo trabaja con @code{BytesGenerator}, no @code{Generator}, porque las cadenas no pueden contener datos binarios.  Si un @code{Generator} está operando bajo un `policy' que especifica @code{cte_type=8bit}, actuará como si @code{cte_type} fuese @code{7bit}.
@end deffn

@geindex raise_on_defect (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy raise_on_defect}@anchor{34f3}
@deffn {Atributo} raise_on_defect

Si es @ref{c95,,True}, cualquier defecto encontrado será lanzado como error.  Si es @ref{bbf,,False} (el valor por defecto), los defectos serán pasados al método @ref{34f4,,register_defect()}.
@end deffn

@geindex mangle_from_ (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy mangle_from_}@anchor{e7b}
@deffn {Atributo} mangle_from_

Si es @ref{c95,,True}, las líneas empezando con `«From «' en el cuerpo son saltados al poner un @code{>} en frente de ellos. Este parámetro es usado cuando el mensaje está siendo serializado por un generador. El valor por defecto es: @ref{bbf,,False}.


Added in version 3.5.

@end deffn

@geindex message_factory (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy message_factory}@anchor{d21}
@deffn {Atributo} message_factory

Una función de fábrica para construir un nuevo objeto mensaje vacío.  Usado por el analizador cuando construye mensajes.  Por defecto es @code{None}, en cuyo caso @ref{3d1,,Message} es usado.


Added in version 3.6.

@end deffn

@geindex verify_generated_headers (atributo de email.policy.Policy)
@anchor{library/email policy email policy Policy verify_generated_headers}@anchor{343}
@deffn {Atributo} verify_generated_headers

If @code{True} (the default), the generator will raise
@ref{34f5,,HeaderWriteError} instead of writing a header
that is improperly folded or delimited, such that it would
be parsed as multiple headers or joined with adjacent data.
Such headers can be generated by custom header classes or bugs
in the @code{email} module.

As it’s a security feature, this defaults to @code{True} even in the
@ref{1129,,Compat32} policy.
For backwards compatible, but unsafe, behavior, it must be set to
@code{False} explicitly.


Added in version 3.13.

@end deffn

El siguiente método de @ref{1128,,Policy} está destinado a ser llamado por código usando la librería de correos electrónicos para crear instancias de `policy' con configuraciones personalizadas:

@geindex clone() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy clone}@anchor{112a}
@deffn {Método} clone (**kw)

Retorna una nueva instancia de @ref{1128,,Policy} cuyos atributos tienen los mismos valores que la instancia actual, excepto donde se le dan, a esos atributos, nuevos valores por los argumentos de palabra clave.
@end deffn

Los métodos de @ref{1128,,Policy} restantes son llamados por el código de paquete de correos electrónicos, y no están destinados a ser llamados por una aplicación usando el paquete de correos electrónicos. Un `policy' personalizado debe implementar todos estos métodos.

@geindex handle_defect() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy handle_defect}@anchor{34f6}
@deffn {Método} handle_defect (obj, defect)

Trata un `defect' encontrado en `obj'.  Cuando el paquete de correos electrónicos llama a este método, `defect' siempre será una subclase de @code{Defect}.

La implementación por defecto verifica la bandera @ref{34f3,,raise_on_defect}.  Si es @code{True}, `defect' es lanzado como una excepción. Si es @code{False} (el valor por defecto), `obj' y `defect' son pasados a @ref{34f4,,register_defect()}.
@end deffn

@geindex register_defect() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy register_defect}@anchor{34f4}
@deffn {Método} register_defect (obj, defect)

Registra un `defect' en `obj'.  En el paquete de correos electrónicos, `defect' será siempre una subclase de @code{Defect}.

La implementación por defecto llama al método @code{append} del atributo @code{defects} de `obj'.  Cuando un paquete de correos electrónicos llama a @ref{34f6,,handle_defect}, `obj' normalmente tendrá un atributo @code{defects} que tiene un método @code{append}.  Los tipos de objetos personalizados usados con el paquete de correos electrónicos (por ejemplo, objetos @code{Message} personalizados) también deben proporcionar tal atributo, de otro modo, los defectos en los mensajes analizados levantarán errores no esperados.
@end deffn

@geindex header_max_count() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy header_max_count}@anchor{34f7}
@deffn {Método} header_max_count (name)

Retorna el máximo número permitido de cabeceras llamadas `name'.

Llamado cuando una cabecera es añadida a un objeto @ref{3d0,,EmailMessage} o @ref{3d1,,Message}.  Si el valor retornado no es @code{0} o @code{None}, y ya hay un número de cabeceras con el nombre `name' mayor o igual que el valor retornado, un @ref{360,,ValueError} es lanzado.

Porque el comportamiento por defecto de @code{Message.__setitem__} es agregar el valor a la lista de cabeceras, es fácil crear cabeceras duplicadas sin darse cuenta.  Este método permite que ciertas cabeceras sean limitadas en el número de instancias de esa cabecera que puede ser agregada a @code{Message} programáticamente.  (El límite no es observado por el analizador, que fielmente producirá tantas cabeceras como existen en el mensaje siendo analizado.)

La implementación por defecto retorna @code{None} para todos los nombres de cabeceras.
@end deffn

@geindex header_source_parse() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy header_source_parse}@anchor{34f8}
@deffn {Método} header_source_parse (sourcelines)

El paquete de correos electrónicos llama a este método con una lista de cadenas de caracteres, cada terminación de cadena con los caracteres de separación de línea encontrada en la fuente siendo analizada.   La primera línea incluye el campo del nombre de cabecera y el separador.  Todos los espacios en blanco en la fuente son preservados.  El método debe retornar la tupla @code{(name,value)} que va a ser guardada en el @code{Message} para representar la cabecera analizada.

Si una implementación desea mantener compatibilidad con los `policy' del paquete de correos electrónicos existentes, `name' debe ser el nombre con las letras preservadas (todos los caracteres hasta el separador “@code{:}”), mientras que `value' debe ser el valor desdoblado (todos los caracteres de separación de líneas eliminados, pero los espacios en blanco intactos), privado de espacios en blanco al comienzo.

`sourcelines' puede contener datos binarios `surrogateescaped'.

No hay implementación por defecto
@end deffn

@geindex header_store_parse() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy header_store_parse}@anchor{34f9}
@deffn {Método} header_store_parse (name, value)

El paquete de correos electrónicos llama a este método con el nombre y valor proporcionados por el programa de aplicación cuando la aplicación está modificando un @code{Message} programáticamente (en lugar de un @code{Message} creado por un analizador). El método debe retornar la tupla @code{(name,value)} que va a ser almacenada en el @code{Message} para representar la cabecera.

Si una implementación desea retener compatibilidad con los `policy' del paquete de correos electrónicos existentes, el `name' y `value' deben ser cadenas de caracteres o subclases de cadenas que no cambien el contenido de los pasados en los argumentos.

No hay implementación por defecto
@end deffn

@geindex header_fetch_parse() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy header_fetch_parse}@anchor{34fa}
@deffn {Método} header_fetch_parse (name, value)

El paquete de correos electrónicos llama a este método con el `name' y `valor' actualmente guardados en @code{Message} (el mensaje) cuando la cabecera es solicitada por el programa de aplicación, y lo que sea que el método retorne es lo que es pasado de vuelta a la aplicación como el valor de la cabecera siendo recuperado. Note que puede haber más de una cabecera con el mismo nombre guardado en @code{Message}; el método es pasado al nombre específico y valor de la cabecera destinado a ser retornado a la aplicación.

`value' puede contener datos binarios `surrogateescaped'.  No debe haber datos binarios `surrogateescaped' en el valor retornado por el método.

No hay implementación por defecto
@end deffn

@geindex fold() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy fold}@anchor{34fb}
@deffn {Método} fold (name, value)

El paquete de correos electrónicos llama a este método con los `name' y `value' actualmente guardados en @code{Message} para una cabecera dada.  El método debe retornar una cadena de caracteres que represente esa cabecera «doblada» correctamente (de acuerdo a los ajustes del `policy') al componer `name' con `value' e insertar caracteres @ref{34f1,,linesep} en los lugares apropiados.  Véase 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} para una discusión de las reglas para doblar cabeceras de correos electrónicos.

`value' puede contener datos binarios `surrogateescaped'.  No debe haber datos binarios `surrogateescaped' en la cadena de caracteres retornada por el método.
@end deffn

@geindex fold_binary() (método de email.policy.Policy)
@anchor{library/email policy email policy Policy fold_binary}@anchor{34f2}
@deffn {Método} fold_binary (name, value)

Igual que @ref{34fb,,fold()}, excepto que el valor retornado debe ser un objeto bytes en vez de una cadena de caracteres.

`value' puede contener datos binarios `surrogateescaped'.  Estos pueden ser convertidos de vuelta a datos binarios en el objeto de bytes retornado.
@end deffn
@end deffn

@geindex EmailPolicy (clase en email.policy)
@anchor{library/email policy email policy EmailPolicy}@anchor{112c}
@deffn {Clase} email.policy.EmailPolicy (**kw)

Este @ref{1128,,Policy} concreto proporciona el comportamiento que sirve para cumplir con los RFCs actuales para correos electrónicos.  Estos incluyen (pero no están limitados a) 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, y los actuales RFCs MIME.

Esta `policy' incorpora nuevos analizadores de cabeceras y algoritmos de doblado.  En vez de cadenas de caracteres simples, las cabeceras son subclases de @code{str} con atributos que dependen del tipo del campo.  El analizado y algoritmo de doblado implementan los 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} y 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} por completo.

El valor por defecto para el atributo @ref{d21,,message_factory} es @ref{3d0,,EmailMessage}.

Además de los atributos que se pueden configurar listados arriba que aplican a todas los `policies', este `policy' añade los siguientes atributos adicionales:


Added in version 3.6: @footnote{
Se añadió originalmente en 3.3 como un @ref{10bd,,característica provisional}.
}


@geindex utf8 (atributo de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy utf8}@anchor{e7d}
@deffn {Atributo} utf8

Si es @code{False}, se sigue el 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, siendo compatible con caracteres non-ASCII en las cabeceras al codificarlas como «palabras codificadas».  Si es @code{True}, sigue el 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} y usa el formato de codificación @code{utf-8} para las cabeceras. Los mensajes formateados de esta manera puede ser pasados a servidores SMTP que admitan la extensión @code{SMTPUTF8} (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}).
@end deffn

@geindex refold_source (atributo de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy refold_source}@anchor{34e7}
@deffn {Atributo} refold_source

Si el valor para una cabecera en el objeto @code{Message} se originó de un @ref{4f,,parser} (en lugar de ser establecido por el programa), este atributo indica tanto si un generador debe redoblar ese valor cuando se transforma al mensaje de vuelta a la forma serializada o no.  Los valores posibles son:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{none}

@tab

todos los valores de la fuente usan el doblamiento original

@item

@code{long}

@tab

los valores de la fuente que tengan una línea que sea más grande que @code{max_line_length} serán redoblados

@item

@code{all}

@tab

todos los valores son redoblados.

@end multitable


El valor por defecto es @code{long}.
@end deffn

@geindex header_factory (atributo de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_factory}@anchor{34fc}
@deffn {Atributo} header_factory

Un invocable que toma dos argumentos, @code{name} y @code{value}, donde @code{name} es un nombre de campo de cabecera y @code{value} es un valor del campo de la cabecera no doblado, y retorna una subclase de cadenas de caracteres que representan la cabecera.  Un valor por defecto @code{header_factory} (véase @ref{43,,headerregistry}) es proporcionado que admite el análisis personalizado para los varios tipos de cabecera 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} de direcciones y fechas, y los tipos del cabeceras MIME principales.  La compatibilidad de analizadores personalizados adicionales será agregada en el futuro.
@end deffn

@geindex content_manager (atributo de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy content_manager}@anchor{fbb}
@deffn {Atributo} content_manager

Un objeto con al menos dos métodos: get_content and set_content.  Cuando los métodos @ref{34c8,,get_content()} o @ref{18b1,,set_content()} del objeto @code{messageEmailMessage} son llamados, llama al método correspondiente de este objeto, pasándole el mensaje objeto como su primer argumento, y cualquier argumento o palabra clave que fuese pasado como un argumento adicional.  Por defecto @code{content_manager} se pone a @ref{34fd,,raw_data_manager}.


Added in version 3.4.

@end deffn

La clase proporciona las siguientes implementaciones concretas de los métodos abstractos de @ref{1128,,Policy}:

@geindex header_max_count() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_max_count}@anchor{34fe}
@deffn {Método} header_max_count (name)

Retorna el valor del atributo @ref{34ff,,max_count} de la clase especializada usada para representar la cabecera con el nombre dado.
@end deffn

@geindex header_source_parse() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_source_parse}@anchor{15a7}
@deffn {Método} header_source_parse (sourcelines)

El nombre es analizado como todo hasta el “@code{:}” y retornado inalterado.  El valor es determinado al remover los espacios en blanco al principio del resto de la primera línea, juntando todas las subsecuentes líneas, y removiendo cualquier carácter CR o LF.
@end deffn

@geindex header_store_parse() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_store_parse}@anchor{3500}
@deffn {Método} header_store_parse (name, value)

El nombre es retornado inalterado.  Si el valor de la entrada tiene un atributo @code{name} y coincide con `name' ignorando mayúsculas y minúsculas, el valor es retornado inalterado.  Si no, el `name' y `value' son pasados a @code{header_factory} , y el objeto cabecera resultante es retornado como el valor.  En este caso un @code{ValueError} es lanzado si el valor de la entrada contiene caracteres CR o LF.
@end deffn

@geindex header_fetch_parse() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_fetch_parse}@anchor{3501}
@deffn {Método} header_fetch_parse (name, value)

Si el valor tiene un atributo @code{name}, es retornado inalterado. De otra manera el `name', y el `value' con cualquier carácter CR o LF eliminado, son pasados a la @code{header_factory}, y el objeto cabecera resultante es retornado.  Cualquier byte `surrogateescaped' es convertido al glifo de carácter desconocido de unicode.
@end deffn

@geindex fold() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy fold}@anchor{1680}
@deffn {Método} fold (name, value)

El doblamiento de la cabecera es controlado por la configuración de `policy' @ref{34e7,,refold_source}. Se considera que un valor es @cite{source value} (valor fuente) si y sólo si no tiene un atributo @code{name} (tener un atributo @code{name} significa que es un objeto cabecera de algún tipo). Si un valor fuente necesita ser redoblado de acuerdo a la política, es convertido en un objeto cabecera al pasarle el `name' y `value' con cualquier carácter CR y LF eliminado al @code{header_factory}.  El doblamiento de un objeto cabecera es hecho al llamar a su método @code{fold} con el `policy' actual.

Los valores fuente son separadas en líneas usando el método @ref{12c4,,splitlines()}. Si el valor no va a ser redoblado, las líneas son unidas de nuevo usando el @code{linesep} del `policy' y retornadas.  La excepción son las líneas que contienen datos binarios non-ascii.  En ese caso el valor es redoblado a pesar de la configuración de @code{refold_source}, que causa que los datos binarios sean codificados CTE usando el juego de caracteres (charset) @code{unknown-8bit}.
@end deffn

@geindex fold_binary() (método de email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy fold_binary}@anchor{3502}
@deffn {Método} fold_binary (name, value)

Igual que @ref{1680,,fold()} si @ref{34ea,,cte_type} fuese @code{7bit}, excepto que el valor retornado son bytes.

Si @ref{34ea,,cte_type} es @code{8bit}, los datos binarios non-ASCII son convertidos de vuelta a bytes.  Las cabeceras con datos binarios son redoblados, sin considerar la configuración de @code{refold_header}, ya que no hay forma de saber si los datos binarios consisten en caracteres de un sólo byte o caracteres con múltiples bytes.
@end deffn
@end deffn

Las siguientes instancias de @ref{112c,,EmailPolicy} proporcionan valores por defecto apropiados para dominios de aplicaciones específicas.  Note que en el futuro el comportamiento de estas instancias (en particular la instancia @code{HTTP}) puede ser ajustado para cumplir incluso más de cerca a los RFC relevantes a sus dominios.

@geindex default (en el módulo email.policy)
@anchor{library/email policy email policy default}@anchor{349b}
@deffn {Dato} email.policy.default

Una instancia de @code{EmailPolicy} con todos los valores por defecto sin cambiar.  Este `policy' usa la terminación de línea @code{\n} estándar de Python en vez de correcto por el RFC @code{\r\n}.
@end deffn

@geindex SMTP (en el módulo email.policy)
@anchor{library/email policy email policy SMTP}@anchor{3503}
@deffn {Dato} email.policy.SMTP

Apropiado para la serialización de mensajes en cumplimiento con los RFC de correos electrónicos.  Como @code{default}, pero con @code{linesep} puesto en @code{\r\n}, que es conforme con el RFC.
@end deffn

@geindex SMTPUTF8 (en el módulo email.policy)
@anchor{library/email policy email policy SMTPUTF8}@anchor{3504}
@deffn {Dato} email.policy.SMTPUTF8

Igual que @code{SMTP} excepto que @ref{e7d,,utf8} es @code{True}. Útil para serializar mensajes a un almacén de mensajes sin usar palabras codificadas en las cabeceras.  Sólo debe ser utilizada para transmisiones por SMTP si las direcciones del remitente o recipiente tienen caracteres non-ASCII (el método @ref{eda,,smtplib.SMTP.send_message()} gestiona esto automáticamente).
@end deffn

@geindex HTTP (en el módulo email.policy)
@anchor{library/email policy email policy HTTP}@anchor{3505}
@deffn {Dato} email.policy.HTTP

Apropiado para serializar cabeceras con uso en tráfico de HTTP.  Como @code{SMTP} excepto que @code{max_line_length} es puesto en @code{None} (ilimitado).
@end deffn

@geindex strict (en el módulo email.policy)
@anchor{library/email policy email policy strict}@anchor{3506}
@deffn {Dato} email.policy.strict

Instancias de conveniencia. Igual que @code{default} excepto que @code{raise_of_defect} es puesto en @code{True}.  Esto permite que cualquier `policy' sea hecho estricto al escribir:

@example
somepolicy + policy.strict
@end example
@end deffn

Con todos estos @ref{112c,,EmailPolicies}, el API efectivo del paquete de correos electrónicos es cambiado del API de Python 3.2 en las siguientes maneras:


@itemize *

@item 
Estableciendo una cabecera en una @ref{3d1,,Message} resulta en que la cabecera sea analizada y un objeto cabecera sea creado.

@item 
Buscar una valor de cabecera de un @ref{3d1,,Message} resulta en que la cabecera sea analizada y un objeto cabecera sea creado y retornado.

@item 
Cualquier objeto cabecera, o cualquier cabecera que sea redoblada debido a las configuraciones del `policy', es doblado usando un algoritmo que implementa el algoritmo de doblado del RFC por completo, incluyendo saber dónde las palabras codificadas son requeridas y permitidas.
@end itemize

Desde la vista de la aplicación, significa que cualquier cabecera obtenida a través de @ref{3d0,,EmailMessage} es un objeto cabecera con atributos extra, cuyo valor de cadena es el valor Unicode de la cabecera completamente decodificada. Asimismo, se le puede asignar un nuevo valor a una cabecera, o a una nueva cabecera creada, usando una cadena de caracteres Unicode, y el `policy' se ocupará de convertir la cadena Unicode en la forma decodificada correcta según el RFC.

Los objetos cabecera y sus atributos son descritos en @code{headerrregistry}.

@geindex Compat32 (clase en email.policy)
@anchor{library/email policy email policy Compat32}@anchor{1129}
@deffn {Clase} email.policy.Compat32 (**kw)

Este @ref{1128,,Policy} concreto es el `policy' compatible hacia atrás. Replica el comportamiento del paquete de correos electrónicos en Python 3.2.  El módulo @ref{50,,policy} también define una instancia de esta clase, @ref{d22,,compat32}, que es usado como el `policy' por defecto.  Por consiguiente, el comportamiento por defecto del paquete de correos electrónicos es mantener compatibilidad con Python 3.2.

Los siguientes atributos tienen valores que son diferentes del @ref{1128,,Policy} por defecto:

@geindex mangle_from_ (atributo de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 mangle_from_}@anchor{3507}
@deffn {Atributo} mangle_from_

El valor por defecto es @code{True}.
@end deffn

La clase proporciona las siguientes implementaciones concretas de los métodos abstractos de @ref{1128,,Policy}:

@geindex header_source_parse() (método de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_source_parse}@anchor{15a8}
@deffn {Método} header_source_parse (sourcelines)

El nombre es analizado como todo hasta el “@code{:}” y retornado inalterado.  El valor es determinado al remover los espacios en blanco al principio del resto de la primera línea, juntando todas las subsecuentes líneas, y removiendo cualquier carácter CR o LF.
@end deffn

@geindex header_store_parse() (método de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_store_parse}@anchor{3508}
@deffn {Método} header_store_parse (name, value)

El nombre y valor son retornados inalterados.
@end deffn

@geindex header_fetch_parse() (método de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_fetch_parse}@anchor{3509}
@deffn {Método} header_fetch_parse (name, value)

Si el valor contiene datos binarios, es convertido a un objeto @ref{18b2,,Header} usando el juego de caracteres (`charset') @code{unknown-8bit}. De otro modo, es retornado sin modificar.
@end deffn

@geindex fold() (método de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 fold}@anchor{350a}
@deffn {Método} fold (name, value)

Las cabeceras son dobladas usando el algoritmo de doblado de @ref{18b2,,Header}, lo que preserva los saltos de líneas existentes en el valor, y envuelve cada línea resultante hasta el @code{max_line_length}. Los datos binarios Non-ASCII son codificados por `CTE' usando el juego de caracteres (`charset') @code{unknown-8bit}.
@end deffn

@geindex fold_binary() (método de email.policy.Compat32)
@anchor{library/email policy email policy Compat32 fold_binary}@anchor{350b}
@deffn {Método} fold_binary (name, value)

Las cabeceras son dobladas usando el algoritmo de doblado @ref{18b2,,Header}, lo que preserva los saltos de línea existentes en el valor, y envuelve cada línea resultante hasta @code{max_line_length}.  Si @code{cte_type} es @code{7bit}, los datos binarios non-ascii son codificados por `CTE' usando el juego de caracteres @code{unknown-8bit}.  De otro modo, la cabecera fuente original es usada, con sus saltos de línea existentes y cualquier (inválido según el RFC) dato binario que puede contener.
@end deffn
@end deffn

@geindex compat32 (en el módulo email.policy)
@anchor{library/email policy email policy compat32}@anchor{d22}
@deffn {Dato} email.policy.compat32

Una instancia de @ref{1129,,Compat32}, proporcionando compatibilidad hacia atrás con el comportamiento del paquete de correos electrónicos en Python 3.2.
@end deffn

@subsubheading Notas al pie de página


@node email errors Exception and Defect classes,email headerregistry Custom Header Objects,email policy Policy Objects,email — An email and MIME handling package
@anchor{library/email errors doc}@anchor{350c}@anchor{library/email errors email-errors-exception-and-defect-classes}@anchor{350d}@anchor{library/email errors module-email errors}@anchor{40}
@subsubsection @code{email.errors}: Exception and Defect classes


@geindex module; email.errors

`Código fuente:' Lib/email/errors.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/errors.py}


__________________________________________________________________


Las siguientes clases de excepción se definen en el módulo @ref{40,,email.errors}:

@geindex MessageError
@anchor{library/email errors email errors MessageError}@anchor{350e}
@deffn {Excepción} email.errors.MessageError

Esta es la clase base para todas las excepciones que el paquete @ref{3c,,email}  puede lanzar. Se deriva de la clase estándar @ref{a6b,,Exception}  y no define métodos adicionales.
@end deffn

@geindex MessageParseError
@anchor{library/email errors email errors MessageParseError}@anchor{350f}
@deffn {Excepción} email.errors.MessageParseError

Esta es la clase base para las excepciones generadas por la clase @ref{120d,,Parser}. Se deriva de @ref{350e,,MessageError}. Esta clase también es utilizada internamente por el analizador sintáctico utilizado por @ref{43,,headerregistry}.
@end deffn

@geindex HeaderParseError
@anchor{library/email errors email errors HeaderParseError}@anchor{34be}
@deffn {Excepción} email.errors.HeaderParseError

Lanzada en algunas condiciones de error al analizar los encabezados 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} de un mensaje, esta clase se deriva de @ref{350f,,MessageParseError}. El método @ref{34bd,,set_boundary()} lanzará este error si el tipo de contenido es desconocido cuando se llama al método. @ref{18b2,,Header} puede lanzar este error para ciertos errores de decodificación de base64, y cuando se intenta crear un encabezado que parece contener un encabezado incrustado (es decir, hay lo que se supone que es un línea de continuación que no tiene espacios en blanco iniciales y parece un encabezado).
@end deffn

@geindex BoundaryError
@anchor{library/email errors email errors BoundaryError}@anchor{3510}
@deffn {Excepción} email.errors.BoundaryError

Deprecada y no utilizada actualmente.
@end deffn

@geindex MultipartConversionError
@anchor{library/email errors email errors MultipartConversionError}@anchor{3511}
@deffn {Excepción} email.errors.MultipartConversionError

Se lanza cuando se agrega una carga útil (`payload') a un objeto @ref{3d1,,Message} usando @code{add_payload()}, pero la carga útil ya es un número escalar y el tipo principal del mensaje @code{Content-Type} no es @code{multipart} ni perdido (`missing'). @ref{3511,,MultipartConversionError} hereda al mismo tiempo de @ref{350e,,MessageError} y el incorporado @ref{228,,TypeError}.

Dado que @code{Message.add_payload()} está en desuso, esta excepción rara vez se presenta en la práctica. Sin embargo, la excepción también se puede lanzar si se llama al método @ref{34cf,,attach()} en una instancia de una clase derivada de @ref{3512,,MIMENonMultipart} (por ejemplo @ref{3513,,MIMEImage}).
@end deffn

@geindex HeaderWriteError
@anchor{library/email errors email errors HeaderWriteError}@anchor{34f5}
@deffn {Excepción} email.errors.HeaderWriteError

Raised when an error occurs when the @ref{41,,generator} outputs
headers.
@end deffn

@geindex MessageDefect
@anchor{library/email errors email errors MessageDefect}@anchor{3514}
@deffn {Excepción} email.errors.MessageDefect

This is the base class for all defects found when parsing email messages.
It is derived from @ref{360,,ValueError}.
@end deffn

@geindex HeaderDefect
@anchor{library/email errors email errors HeaderDefect}@anchor{3515}
@deffn {Excepción} email.errors.HeaderDefect

This is the base class for all defects found when parsing email headers.
It is derived from @ref{3514,,MessageDefect}.
@end deffn

Aquí está la lista de defectos que @ref{34d9,,FeedParser} puede encontrar mientras analiza mensajes. Tenga en cuenta que los defectos se agregan al mensaje donde se encontró el problema, por ejemplo, si un mensaje anidado dentro de un @code{multipart/alternative} tenía un encabezado mal formado, ese objeto de mensaje anidado tendría un defecto, pero el contenido los mensajes no lo harían.

Todas las clases de defectos se derivan de @ref{3514,,email.errors.MessageDefect}.


@itemize *

@item 
@code{NoBoundaryInMultipartDefect} – Un mensaje que se dice que es multiparte, pero que no tiene el parámetro @code{boundary}.

@item 
@code{StartBoundaryNotFoundDefect} – El límite de inicio reclamado en el encabezado @code{Content-Type} nunca se encontró.

@item 
@code{CloseBoundaryNotFoundDefect} – Se encontró un límite de inicio, pero nunca se encontró un límite cercano correspondiente.


Added in version 3.3.


@item 
@code{FirstHeaderLineIsContinuationDefect} – El mensaje tenía una línea de continuación como primera línea de encabezado.

@item 
@code{MisplacedEnvelopeHeaderDefect} – Se encontró un encabezado «`Unix From'» en medio de un bloque de encabezado.

@item 
@code{MissingHeaderBodySeparatorDefect} - Se encontró una línea al analizar sintácticamente los encabezados que no tenían espacios en blanco iniciales pero que no contenían “:”. El análisis continúa asumiendo que la línea representa la primera línea del cuerpo.


Added in version 3.3.


@item 
@code{MalformedHeaderDefect} – Se encontró un encabezado al que le faltaban dos puntos o tenía un formato incorrecto.


Obsoleto desde la versión 3.3: Este defecto no se ha utilizado por varias versiones de Python.


@item 
@code{MultipartInvariantViolationDefect}– Un mensaje que se afirma ser @code{multipart}, pero no se encontraron subpartes. Tenga en cuenta que cuando un mensaje tiene este defecto, su método @ref{34c2,,is_multipart()} puede retornar @code{False} aunque su tipo de contenido afirma ser @code{multipart}.

@item 
@code{InvalidBase64PaddingDefect} – Al decodificar un bloque de bytes codificados en base64, el relleno no era correcto. Se agrega suficiente relleno (`padding') para realizar la decodificación, pero los bytes decodificados resultantes pueden no ser válidos.

@item 
@code{InvalidBase64CharactersDefect} – Al decodificar un bloque de bytes codificados en @cite{base64}, se encontraron caracteres fuera del alfabeto @cite{base64}. Los caracteres se ignoran, pero los bytes decodificados resultantes pueden no ser válidos.

@item 
@code{InvalidBase64LengthDefect} – Al decodificar un bloque de bytes codificados en @cite{base64}, el número de caracteres @cite{base64} sin relleno no era válido (1 más que un múltiplo de 4). El bloque codificado se mantuvo tal cual.

@item 
@code{InvalidDateDefect} – Al decodificar una fecha no válida o un campo no parseable. El valor original se mantiene tal cual.
@end itemize

@node email headerregistry Custom Header Objects,email contentmanager Managing MIME Content,email errors Exception and Defect classes,email — An email and MIME handling package
@anchor{library/email headerregistry doc}@anchor{3516}@anchor{library/email headerregistry email-headerregistry-custom-header-objects}@anchor{3517}@anchor{library/email headerregistry module-email headerregistry}@anchor{43}
@subsubsection @code{email.headerregistry}: Custom Header Objects


@geindex module; email.headerregistry

`Código fuente:' Lib/email/headerregistry.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/headerregistry.py}


__________________________________________________________________



Added in version 3.6: @footnote{
Originalmente añadido en 3.3 como módulo provisional @ref{10bd,,provisional module}
}


Los encabezados están representados por subclases personalizadas de @ref{237,,str}. La clase particular utilizada para representar un encabezado dado está determinada por @ref{34fc,,header_factory} del @ref{50,,policy} vigente cuando se crean los encabezados. Esta sección documenta el @code{header_factory} particular implementado por el paquete de correo electrónico para el manejo mensajes de correo electrónico compatibles con 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, que no solo proporciona objetos de encabezado personalizados para varios tipos de encabezados, sino que también proporciona un mecanismo de extensión para que las aplicaciones agreguen sus propios tipos de encabezados personalizados.

Cuando se utiliza cualquiera de los objetos de política derivados de @ref{112c,,EmailPolicy}, todos los encabezados son producidos por @ref{3518,,HeaderRegistry} y tienen @ref{34aa,,BaseHeader} como su última clase base. Cada clase de encabezado tiene una clase base adicional que está determinada por el tipo de encabezado. Por ejemplo, muchos encabezados tienen la clase @ref{3519,,UnstructuredHeader} como su otra clase base. La segunda clase especializada para un encabezado está determinada por el nombre del encabezado, utilizando una tabla de búsqueda almacenada en @ref{3518,,HeaderRegistry}. Todo esto se gestiona de forma transparente para el programa de aplicación típico, pero se proporcionan interfaces para modificar el comportamiento predeterminado para su uso por aplicaciones más complejas.

Las secciones a continuación primero documentan las clases base de encabezados y sus atributos, seguidas por la API para modificar el comportamiento de @ref{3518,,HeaderRegistry}, y finalmente las clases de soporte utilizadas para representar los datos analizados a partir de encabezados estructurados.

@geindex BaseHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry BaseHeader}@anchor{34aa}
@deffn {Clase} email.headerregistry.BaseHeader (name, value)

`name' y `value' se pasan a @code{BaseHeader} desde la llamada @ref{34fc,,header_factory}. El valor de cadena de caracteres de cualquier objeto de encabezado es el `value' completamente descodificado en unicode.

Esta clase base define las siguientes propiedades de solo lectura:

@geindex name (atributo de email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader name}@anchor{351a}
@deffn {Atributo} name

El nombre del encabezado (la parte del campo antes del “:”). Este es exactamente el valor pasado en @ref{34fc,,header_factory} llamada para `name'; es decir, se conserva el caso.
@end deffn

@geindex defects (atributo de email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader defects}@anchor{351b}
@deffn {Atributo} defects

Una tupla de instancias @ref{3515,,HeaderDefect} que informan sobre cualquier problema de cumplimiento de RFC que se encuentre durante el análisis. El paquete de correo electrónico intenta estar completo para detectar problemas de cumplimiento. Vea el módulo @ref{40,,errors} para una discusión de los tipos de defectos que pueden ser reportados.
@end deffn

@geindex max_count (atributo de email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader max_count}@anchor{34ff}
@deffn {Atributo} max_count

El número máximo de encabezados de este tipo que pueden tener el mismo @code{name}. Un valor de @code{None} significa ilimitado. El valor de @code{BaseHeader} para este atributo es @code{None}; se espera que las clases de encabezado especializadas anulen este valor según sea necesario.
@end deffn

@code{BaseHeader} también proporciona el siguiente método, que es llamado por el código de la biblioteca de correo electrónico y, en general, no debe ser llamado por programas de aplicación:

@geindex fold() (método de email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader fold}@anchor{351c}
@deffn {Método} fold (*, policy)

Retorna una cadena que contenga @ref{34f1,,linesep} caracteres según sea necesario para doblar correctamente el encabezado de acuerdo con `policy'. Un atributo @ref{34ea,,cte_type} de @code{8bit} se tratará como si fuera @code{7bit}, ya que los encabezados no pueden contener datos binarios arbitrarios. Si @ref{e7d,,utf8} es @code{False}, los datos no ASCII estarán codificados 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}.
@end deffn

@code{BaseHeader} por sí solo no se puede utilizar para crear un objeto de encabezado. Define un protocolo con el que coopera cada encabezado especializado para producir el objeto de encabezado. Específicamente, @code{BaseHeader} requiere que la clase especializada proporcione un @ref{2d2,,classmethod()} llamado @code{parse}. Este método se llama de la siguiente manera:

@example
parse(string, kwds)
@end example

@code{kwds} es un diccionario que contiene una clave preinicializada, @code{defects}. @code{defects} es una lista vacía. El método de análisis debe agregar cualquier defecto detectado a esta lista. A la devolución, el diccionario @code{kwds} `debe' (`must') contener valores para al menos las claves @code{decoded} y @code{defects}. @code{decoded} debe ser el valor de cadena para el encabezado (es decir, el valor del encabezado completamente decodificado a Unicode). El método de análisis debe asumir que `string' puede contener partes codificadas por transferencia de contenido, pero también debe manejar correctamente todos los caracteres Unicode válidos para que pueda analizar valores de encabezado no codificados.

Entonces, el @code{__new__} de @code{BaseHeader} crea la instancia del encabezado y llama a su método @code{init}. La clase especializada solo necesita proporcionar un método @code{init} si desea establecer atributos adicionales más allá de los proporcionados por  @code{BaseHeader}. Tal método @code{init} debería verse así:

@example
def init(self, /, *args, **kw):
    self._myattr = kw.pop('myattr')
    super().init(*args, **kw)
@end example

Es decir, cualquier cosa adicional que la clase especializada ponga en el diccionario @code{kwds} debe eliminarse y manejarse, y el contenido restante de @code{kw} (y @code{args}) debe pasar @code{BaseHeader} al método @code{init}.
@end deffn

@geindex UnstructuredHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry UnstructuredHeader}@anchor{3519}
@deffn {Clase} email.headerregistry.UnstructuredHeader

Un encabezado «sin estructura» es el tipo predeterminado de encabezado en 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}. Cualquier encabezado que no tenga una sintaxis especificada se trata como no estructurado. El ejemplo clásico de un encabezado no estructurado es el encabezado @code{Subject}.

En 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, un encabezado no estructurado es una ejecución de texto arbitrario en el conjunto de caracteres ASCII. 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, sin embargo, tiene un mecanismo compatible 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} para codificar texto no ASCII como caracteres ASCII dentro de un valor de encabezado. Cuando un `value' que contiene palabras codificadas se pasa al constructor, el analizador @code{UnstructuredHeader} convierte dichas palabras codificadas en unicode, siguiendo las reglas 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} para texto no estructurado. El analizador utiliza heurística para intentar decodificar ciertas palabras codificadas no compatibles. Los defectos se registran en tales casos, así como defectos por problemas como caracteres no válidos dentro de las palabras codificadas o el texto no codificado.

Este tipo de encabezado no proporciona atributos adicionales.
@end deffn

@geindex DateHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry DateHeader}@anchor{351d}
@deffn {Clase} email.headerregistry.DateHeader

@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} especifica un formato muy específico para las fechas dentro de los encabezados de correo electrónico. El analizador @code{DateHeader} reconoce ese formato de fecha, además de reconocer una serie de formas variantes que a veces se encuentran «en la naturaleza» (`«in the wild»').

Este tipo de encabezado proporciona los siguientes atributos adicionales:

@geindex datetime (atributo de email.headerregistry.DateHeader)
@anchor{library/email headerregistry email headerregistry DateHeader datetime}@anchor{351e}
@deffn {Atributo} datetime

If the header value can be recognized as a valid date of one form or
another, this attribute will contain a @ref{32f,,datetime}
instance representing that date.  If the timezone of the input date is
specified as @code{-0000} (indicating it is in UTC but contains no
information about the source timezone), then @ref{351e,,datetime} will be a
naive @ref{32f,,datetime}.  If a specific timezone offset is
found (including @code{+0000}), then @ref{351e,,datetime} will contain an aware
@code{datetime} that uses @ref{1134,,datetime.timezone} to record the timezone
offset.
@end deffn

El valor @code{decoded} del encabezado se determina formateando la @code{datetime} de acuerdo con las reglas 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}; es decir, esto se establece en:

@example
email.utils.format_datetime(self.datetime)
@end example

Al crear un @code{DateHeader}, `value' puede ser @ref{32f,,datetime} instancia. Esto significa, por ejemplo, que el siguiente código es válido y hace lo que cabría esperar:

@example
msg['Date'] = datetime(2011, 7, 15, 21)
@end example

Debido a que se trata de una @code{datetime} naif, se interpretará como una marca de tiempo UTC, y el valor resultante tendrá una zona horaria de @code{-0000}. Mucho más útil es usar la función @ref{217,,localtime()} del módulo @ref{51,,utils}:

@example
msg['Date'] = utils.localtime()
@end example

Este ejemplo establece el encabezado de la fecha en la hora y fecha actuales utilizando el desplazamiento de zona horaria actual.
@end deffn

@geindex AddressHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry AddressHeader}@anchor{351f}
@deffn {Clase} email.headerregistry.AddressHeader

Los encabezados de dirección son uno de los tipos de encabezados estructurados más complejos. La clase @code{AddressHeader} proporciona una interfaz genérica para cualquier encabezado de dirección.

Este tipo de encabezado proporciona los siguientes atributos adicionales:

@geindex groups (atributo de email.headerregistry.AddressHeader)
@anchor{library/email headerregistry email headerregistry AddressHeader groups}@anchor{3520}
@deffn {Atributo} groups

Una tupla de objetos @ref{3521,,Group} que codifican las direcciones y los grupos que se encuentran en el valor del encabezado. Las direcciones que no forman parte de un grupo se representan en esta lista como @code{Groups} de una sola dirección cuyo @ref{3522,,display_name} es @code{None}.
@end deffn

@geindex addresses (atributo de email.headerregistry.AddressHeader)
@anchor{library/email headerregistry email headerregistry AddressHeader addresses}@anchor{3523}
@deffn {Atributo} addresses

Una tupla de objetos @ref{3524,,Address} que codifican todas las direcciones individuales del valor del encabezado. Si el valor del encabezado contiene algún grupo, las direcciones individuales del grupo se incluyen en la lista en el punto donde el grupo aparece en el valor (es decir, la lista de direcciones se «aplana» (`«flattened»') en una lista unidimensional).
@end deffn

The @code{decoded} value of the header will have all encoded words decoded to
unicode.  @ref{52,,idna} encoded domain names are also decoded to
unicode.  The @code{decoded} value is set by @ref{21d0,,joining} the
@ref{237,,str} value of the elements of the @code{groups} attribute with @code{',
'}.

Se puede utilizar una lista de objetos @ref{3524,,Address} y @ref{3521,,Group} en cualquier combinación para establecer el valor de un encabezado de dirección. Los objetos @code{Group} cuyo @code{display_name} sea @code{None} se interpretarán como direcciones únicas, lo que permite copiar una lista de direcciones con los grupos intactos utilizando la lista obtenida del atributo @code{groups} de el encabezado de origen.
@end deffn

@geindex SingleAddressHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry SingleAddressHeader}@anchor{3525}
@deffn {Clase} email.headerregistry.SingleAddressHeader

Una subclase de @ref{351f,,AddressHeader} que agrega un atributo adicional:

@geindex address (atributo de email.headerregistry.SingleAddressHeader)
@anchor{library/email headerregistry email headerregistry SingleAddressHeader address}@anchor{3526}
@deffn {Atributo} address

La única dirección codificada por el valor del encabezado. Si el valor del encabezado en realidad contiene más de una dirección (lo que sería una violación del RFC bajo el valor predeterminado @ref{50,,policy}), acceder a este atributo resultará en un @ref{360,,ValueError}.
@end deffn
@end deffn

Muchas de las clases anteriores también tienen una variante @code{Unique} (por ejemplo,`@w{`}UniqueUnstructuredHeader`@w{`}). La única diferencia es que en la variante @code{Unique}, @ref{34ff,,max_count} se establece en 1.

@geindex MIMEVersionHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader}@anchor{3527}
@deffn {Clase} email.headerregistry.MIMEVersionHeader

En realidad, solo hay un valor válido para el encabezado @code{MIME-Version}, y ese es @code{1.0}. Para pruebas futuras, esta clase de encabezado admite otros números de versión válidos. Si un número de versión tiene un valor válido por 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, entonces el objeto de encabezado tendrá valores distintos de @code{None} para los siguientes atributos:

@geindex version (atributo de email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader version}@anchor{3528}
@deffn {Atributo} version

El número de versión como una cadena de caracteres, con cualquier espacio en blanco y/o comentarios eliminados.
@end deffn

@geindex major (atributo de email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader major}@anchor{3529}
@deffn {Atributo} major

El número de versión mayor como un entero
@end deffn

@geindex minor (atributo de email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader minor}@anchor{352a}
@deffn {Atributo} minor

El número de versión menor como un entero
@end deffn
@end deffn

@geindex ParameterizedMIMEHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader}@anchor{352b}
@deffn {Clase} email.headerregistry.ParameterizedMIMEHeader

Todos los encabezados `MIME' comienzan con el prefijo `“Content-”'. Cada encabezado específico tiene un valor determinado, que se describe en la clase de ese encabezado. Algunos también pueden tomar una lista de parámetros complementarios, que tienen un formato común. Esta clase sirve como base para todos los encabezados `MIME' que toman parámetros.

@geindex params (atributo de email.headerregistry.ParameterizedMIMEHeader)
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader params}@anchor{34b8}
@deffn {Atributo} params

Un diccionario que asigna nombres de parámetros a valores de parámetros.
@end deffn
@end deffn

@geindex ContentTypeHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader}@anchor{352c}
@deffn {Clase} email.headerregistry.ContentTypeHeader

Una clase @ref{352b,,ParameterizedMIMEHeader} que maneja el encabezado @code{Content-Type}.

@geindex content_type (atributo de email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader content_type}@anchor{352d}
@deffn {Atributo} content_type

La cadena de caracteres de tipo de contenido, en la forma @code{maintype/subtype}.
@end deffn

@geindex maintype (atributo de email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader maintype}@anchor{352e}
@deffn {Atributo} maintype
@end deffn

@geindex subtype (atributo de email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader subtype}@anchor{352f}
@deffn {Atributo} subtype
@end deffn
@end deffn

@geindex ContentDispositionHeader (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader}@anchor{3530}
@deffn {Clase} email.headerregistry.ContentDispositionHeader

Una clase @ref{352b,,ParameterizedMIMEHeader} que maneja el encabezado @code{Content-Disposition}.

@geindex content_disposition (atributo de email.headerregistry.ContentDispositionHeader)
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader content_disposition}@anchor{3531}
@deffn {Atributo} content_disposition

@code{inline} y @code{attachment} son los únicos valores válidos de uso común.
@end deffn
@end deffn

@geindex ContentTransferEncoding (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentTransferEncoding}@anchor{3532}
@deffn {Clase} email.headerregistry.ContentTransferEncoding

Maneja el encabezado de @code{Content-Transfer-Encoding}.

@geindex cte (atributo de email.headerregistry.ContentTransferEncoding)
@anchor{library/email headerregistry email headerregistry ContentTransferEncoding cte}@anchor{3533}
@deffn {Atributo} cte

Los valores válidos son @code{7bit}, @code{8bit}, @code{base64}, y @code{quoted-printable}. Consulte 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} para obtener más información.
@end deffn
@end deffn

@geindex HeaderRegistry (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry}@anchor{3518}
@deffn {Clase} email.headerregistry.HeaderRegistry (base_class=BaseHeader, default_class=UnstructuredHeader, use_default_map=True)

This is the factory used by @ref{112c,,EmailPolicy} by default.
@code{HeaderRegistry} builds the class used to create a header instance
dynamically, using `base_class' and a specialized class retrieved from a
registry that it holds.  When a given header name does not appear in the
registry, the class specified by `default_class' is used as the specialized
class.  When `use_default_map' is @code{True} (the default), the standard
mapping of header names to classes is copied in to the registry during
initialization.  `base_class' is always the last class in the generated
class’s @ref{14e8,,__bases__} list.

Las asignaciones predeterminadas son:

@quotation

@*subject: 
UniqueUnstructuredHeader


@*date: 
UniqueDateHeader


@*resent-date: 
DateHeader


@*orig-date: 
UniqueDateHeader


@*sender: 
UniqueSingleAddressHeader


@*resent-sender: 
SingleAddressHeader


@*to: 
UniqueAddressHeader


@*resent-to: 
AddressHeader


@*cc: 
UniqueAddressHeader


@*resent-cc: 
AddressHeader


@*bcc: 
UniqueAddressHeader


@*resent-bcc: 
AddressHeader


@*from: 
UniqueAddressHeader


@*resent-from: 
AddressHeader


@*reply-to: 
UniqueAddressHeader


@*mime-version: 
MIMEVersionHeader


@*content-type: 
ContentTypeHeader


@*content-disposition: 
ContentDispositionHeader


@*content-transfer-encoding: 
ContentTransferEncodingHeader


@*message-id: 
MessageIDHeader

@end quotation

@code{HeaderRegistry} tiene los siguientes métodos:

@geindex map_to_type() (método de email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry map_to_type}@anchor{3534}
@deffn {Método} map_to_type (self, name, cls)

`name' es el nombre del encabezado que se asignará. Se convertirá a minúsculas en el registro. `cls' es la clase especializada que se utilizará, junto con `base_class', para crear la clase utilizada para instanciar encabezados que coincidan con `name'.
@end deffn

@geindex __getitem__() (método de email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry __getitem__}@anchor{3535}
@deffn {Método} __getitem__ (name)

Construye y retorna una clase para manejar la creación de un encabezado `nombre'.
@end deffn

@geindex __call__() (método de email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry __call__}@anchor{3536}
@deffn {Método} __call__ (name, value)

Recupera el encabezado especializado asociado con `name' del registro (usando `default_class' si `name' no aparece en el registro) y lo compone con `base_class' para producir una clase, llama al constructor de la clase construida, pasándole el mismo lista de argumentos y, finalmente, retorna la instancia de clase creada de ese modo.
@end deffn
@end deffn

Las siguientes clases son las clases que se utilizan para representar datos analizados a partir de encabezados estructurados y, en general, pueden ser utilizadas por un programa de aplicación para construir valores estructurados para asignar a encabezados específicos.

@geindex Address (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry Address}@anchor{3524}
@deffn {Clase} email.headerregistry.Address (display_name='@w{'}, username='@w{'}, domain='@w{'}, addr_spec=None)

La clase utilizada para representar una dirección de correo electrónico. La forma general de una dirección es:

@example
[display_name] <username@@domain>
@end example

or:

@example
username@@domain
@end example

donde cada parte debe ajustarse a reglas de sintaxis específicas explicadas en 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.

Para su comodidad, se puede especificar `addr_spec' en lugar de `username' y `domain', en cuyo caso `username' y `domain' se analizarán a partir de `addr_spec'. Un `addr_spec' debe ser una cadena de caracteres entre comillas RFC adecuada; si no es @code{Address}, se lanzará un error. Se permiten caracteres Unicode y se codificarán como propiedad cuando se serialicen. Sin embargo, según las RFC, `no' se permite unicode en la parte del nombre de usuario de la dirección.

@geindex display_name (atributo de email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address display_name}@anchor{3537}
@deffn {Atributo} display_name

La parte del nombre para mostrar de la dirección, si la hubiera, con todas las citas eliminadas. Si la dirección no tiene un nombre para mostrar, este atributo será una cadena vacía.
@end deffn

@geindex username (atributo de email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address username}@anchor{3538}
@deffn {Atributo} username

La parte del @code{username} de la dirección, con todas las citas eliminadas.
@end deffn

@geindex domain (atributo de email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address domain}@anchor{3539}
@deffn {Atributo} domain

La parte de @code{domain} de la dirección.
@end deffn

@geindex addr_spec (atributo de email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address addr_spec}@anchor{353a}
@deffn {Atributo} addr_spec

La parte de la dirección @code{username@@domain}, citada correctamente para usarla como dirección simple (el segundo formulario que se muestra arriba). Este atributo no es mutable.
@end deffn

@geindex __str__() (método de email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address __str__}@anchor{353b}
@deffn {Método} __str__ ()

El valor @code{str} del objeto es la dirección citada de acuerdo con las reglas 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, pero sin codificación de transferencia de contenido de ningún carácter que no sea ASCII.
@end deffn

Para admitir SMTP (
@geindex RFC; RFC 5321
RFC 5321@footnote{https://datatracker.ietf.org/doc/html/rfc5321.html}), @code{Address} maneja un caso especial: si @code{username} y @code{domain} son ambos la cadena de caracteres vacía (o @code{None}), entonces el valor de cadena de caracteres @code{Address} es @code{<>}.
@end deffn

@geindex Group (clase en email.headerregistry)
@anchor{library/email headerregistry email headerregistry Group}@anchor{3521}
@deffn {Clase} email.headerregistry.Group (display_name=None, addresses=None)

La clase utilizada para representar un grupo de direcciones. La forma general de un grupo de direcciones es:

@example
display_name: [address-list];
@end example

Para facilitar el procesamiento de listas de direcciones que constan de una mezcla de grupos y direcciones únicas, también se puede utilizar un @code{Group} para representar direcciones únicas que no forman parte de un grupo al establecer `display_name' en @code{None} y proporcionando una lista de direcciones únicas como `addresses'.

@geindex display_name (atributo de email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group display_name}@anchor{3522}
@deffn {Atributo} display_name

El @code{display_name} del grupo. Si es @code{None} y hay exactamente una @code{Address} en @code{addresses}, entonces el @code{Group} representa una única dirección que no está en un grupo.
@end deffn

@geindex addresses (atributo de email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group addresses}@anchor{353c}
@deffn {Atributo} addresses

Posiblemente una tupla vacía de @ref{3524,,Address} que representan las direcciones en el grupo.
@end deffn

@geindex __str__() (método de email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group __str__}@anchor{353d}
@deffn {Método} __str__ ()

El valor @code{str} de un @code{Group} se formatea de acuerdo con 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, pero sin codificación de transferencia de contenido de ningún carácter que no sea ASCII. Si @code{display_name} no es ninguno y hay una sola @code{Address} en la lista de @code{addresses}, el valor de @code{str} será el mismo que el @code{str} de ese single @code{Address}.
@end deffn
@end deffn

@subsubheading Pie de notas


@node email contentmanager Managing MIME Content,email Ejemplos,email headerregistry Custom Header Objects,email — An email and MIME handling package
@anchor{library/email contentmanager doc}@anchor{353e}@anchor{library/email contentmanager email-contentmanager-managing-mime-content}@anchor{353f}@anchor{library/email contentmanager module-email contentmanager}@anchor{3e}
@subsubsection @code{email.contentmanager}: Managing MIME Content


@geindex module; email.contentmanager

`Código fuente:' Lib/email/contentmanager.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/contentmanager.py}


__________________________________________________________________



Added in version 3.6: @footnote{
Originalmente añadido en la versión 3.4 como un @ref{10bd,,módulo provisional}
}


@geindex ContentManager (clase en email.contentmanager)
@anchor{library/email contentmanager email contentmanager ContentManager}@anchor{3540}
@deffn {Clase} email.contentmanager.ContentManager

Clase base para gestores de contenido.  Proporciona los mecanismos de registro estándar para registrar convertidores entre contenido MIME y otras representaciones, así como los métodos de envío @code{get_content} y @code{set_content}.

@geindex get_content() (método de email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager get_content}@anchor{34c9}
@deffn {Método} get_content (msg, *args, **kw)

Busca una función de controlador basada en el @code{mimetype} de `msg' (ver el siguiente párrafo), la llama, le pasa todos los argumentos y retorna el resultado de la llamada.  La expectativa es que el controlador extraiga la carga útil de `msg' y retorne un objeto que codifica información sobre los datos extraídos.

Para encontrar el controlador, busca las siguientes llaves en el registro, deteniéndose con la primera que encuentre:


@itemize *

@item 
la cadena que representa el tipo MIME completo (@code{maintype/subtype})

@item 
la cadena de caracteres que representa el @code{maintype}

@item 
la cadena de caracteres vacía
@end itemize

Si ninguna de estas llaves produce un controlador, se lanza una excepción @ref{438,,KeyError} para el tipo MIME completo.
@end deffn

@geindex set_content() (método de email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager set_content}@anchor{34ca}
@deffn {Método} set_content (msg, obj, *args, **kw)

Si el @code{maintype} es @code{multipart}, se lanza un @ref{228,,TypeError}; de lo contrario, busca una función de controlador basada en el tipo de `obj' (ver el siguiente párrafo), llama a @ref{34d3,,clear_content()} en el `msg' y llama a la función de controlador, pasando todos los argumentos.  La expectativa es que el controlador transforme y almacene `obj' en `msg', posiblemente realizando otros cambios a `msg' también, como agregar varios encabezados MIME para codificar la información necesaria para interpretar los datos almacenados.

Para encontrar el controlador, obtiene el tipo de `obj' (@code{typ = type(obj)}), y busca las siguientes llaves en el registro, deteniéndose con la primera encontrada:


@itemize *

@item 
el tipo en sí (@code{typ})

@item 
el nombre completo de calificación del tipo (@code{typ.__module__ + '.' + typ.__qualname__}).

@item 
the type’s @ref{1f25,,qualname} (@code{typ.__qualname__})

@item 
the type’s @ref{14e7,,name} (@code{typ.__name__}).
@end itemize

If none of the above match, repeat all of the checks above for each of
the types in the @ref{3541,,MRO} (@ref{1f2a,,typ.__mro__}).
Finally, if no other key
yields a handler, check for a handler for the key @code{None}.  If there is
no handler for @code{None}, raise a @ref{438,,KeyError} for the fully
qualified name of the type.

También agrega un encabezado @code{MIME-Version} si no hay uno presente (vea también @ref{fba,,MIMEPart}).
@end deffn

@geindex add_get_handler() (método de email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager add_get_handler}@anchor{3542}
@deffn {Método} add_get_handler (key, handler)

Registra el `handler' de funciones como el manejador de `key'.  Para los posibles valores de `key', consulte @ref{3543,,get_content()}.
@end deffn

@geindex add_set_handler() (método de email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager add_set_handler}@anchor{3544}
@deffn {Método} add_set_handler (typekey, handler)

Registra el `handler' como la función a llamar cuando un objeto de un tipo coincidente `typekey' se pasa a @ref{3545,,set_content()}.  Para los posibles valores de `typekey', consulte @ref{3545,,set_content()}.
@end deffn
@end deffn

@menu
* Instancias gestoras de contenido:: 

@end menu

@node Instancias gestoras de contenido,,,email contentmanager Managing MIME Content
@anchor{library/email contentmanager content-manager-instances}@anchor{3546}
@subsubsection Instancias gestoras de contenido


Actualmente, el paquete de correo electrónico solo proporciona un administrador de contenido concreto, @ref{34fd,,raw_data_manager}, aunque en el futuro se pueden agregar más. @ref{34fd,,raw_data_manager} es el @ref{fbb,,content_manager} proporcionado por @ref{112c,,EmailPolicy} y sus derivados.

@geindex raw_data_manager (en el módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager raw_data_manager}@anchor{34fd}
@deffn {Dato} email.contentmanager.raw_data_manager

Este administrador de contenido proporciona sólo una interfaz mínima más allá de la proporcionada por @ref{3d1,,Message} en sí:  trata solo con texto, cadenas de bytes sin procesar, y objetos @ref{3d1,,Message}.  Sin embargo, proporciona ventajas significativas en comparación con la API base: @code{get_content} en una parte de texto retornará una cadena de caracteres unicode sin que la aplicación tenga que decodificarla manualmente, @code{set_content} proporciona un amplio conjunto de opciones para controlar los encabezados añadidos a una parte y controlar la codificación de transferencia de contenido, y permite el uso de los diversos métodos @code{add_}, simplificando así la creación de mensajes multiparte.

@geindex get_content() (en el módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager get_content}@anchor{3543}
@deffn {Método} email.contentmanager.get_content (msg, errors='replace')

Retorna la carga útil de la parte como una cadena de caracteres (para partes de @code{text}), un objeto @ref{3d0,,EmailMessage} (para partes de @code{message/rfc822}), o un objeto de @code{bytes} (para todos los demás tipos que no son multiparte).  Lanza un @ref{438,,KeyError} si se llama en un @code{multipart}.  Si la parte es una parte de @code{text} y se especifica `errors', se usa como el controlador de errores al decodificar la carga útil a unicode.  El controlador de errores predeterminado es @code{replace}.
@end deffn

@geindex set_content() (en el módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager set_content}@anchor{3545}
@deffn {Método} email.contentmanager.set_content (msg, <'str'>, subtype="plain", charset='utf-8', cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

@deffnx {Método} email.contentmanager.set_content (msg, <'bytes'>, maintype, subtype, cte="base64", disposition=None, filename=None, cid=None, params=None, headers=None)

@deffnx {Método} email.contentmanager.set_content (msg, <'EmailMessage'>, cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

Añade cabeceras y carga útil al `msg':

Añade un encabezado @code{Content-Type} con un valor @code{maintype/subtype}.


@itemize *

@item 
Para @code{str}, establece el @code{maintype} de MIME en @code{text}, y establece el subtipo en `subtype' si se especifica, o @code{plain} si no está presente.

@item 
Para @code{bytes}, usa el `maintype' y `subtype' especificados, o lanza un @ref{228,,TypeError} si no se especifican.

@item 
Para objetos @ref{3d0,,EmailMessage}, establece el `maintype' en @code{message}, y establece el `subtype' en `subtype' si se especifica o @code{rfc822} si no se especifica. Si `subtype' es @code{partial}, se lanza un error (los objetos de @code{bytes} deben usarse para construir partes @code{message/partial}).
@end itemize

Si se proporciona `charset' (lo cual solo es válido para @code{str}), codifica la cadena de caracteres en bytes utilizando el conjunto de caracteres especificado.  El valor por defecto es @code{utf-8}.  Si el `charset' especificado es un alias conocido del nombre de un conjunto de caracteres del estándar MIME, utiliza el conjunto de caracteres estándar en su lugar.

Si se establece `cte', codifica la carga útil mediante la codificación de transferencia de contenido especificada y establece el encabezado @code{Content-Transfer-Encoding} en ese valor.  Los valores posibles para `cte' son @code{quoted-printable}, @code{base64}, @code{7bit}, @code{8bit}, y @code{binary}.  Si la entrada no se puede codificar en la codificación especificada (por ejemplo, especificando un `cte' de @code{7bit} para una entrada que contiene valores no ASCII), se lanza un @ref{360,,ValueError}.


@itemize *

@item 
Para objetos @code{str}, si `cte' no está configurado, se usa la heurística para determinar la codificación más compacta.

@item 
Para @ref{3d0,,EmailMessage}, según 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}, se lanza un error si se solicita un `cte' de @code{quoted-printable} o @code{base64} para el `subtype' @code{rfc822}, y para cualquier `cte' que no sea @code{7bit} para el `subtype' @code{external-body}.  Para @code{message/rfc822}, se usa @code{8bit} si no se especifica `cte'.  Para todos los demás valores de `subtype', se usa @code{7bit}.
@end itemize

@cartouche
@quotation Nota 
Un `cte' de @code{binary} todavía no funciona correctamente. El objeto @code{EmailMessage} modificado por @code{set_content} es correcto, pero @ref{123c,,BytesGenerator} no lo serializa correctamente.
@end quotation
@end cartouche

Si se establece `disposición', se usa como valor del encabezado @code{Content-Disposition}.  Si no se especifica y se especifica `filename', agrega el encabezado con el valor @code{attachment}. Si no se especifica `disposition' y tampoco se especifica `filename', no agrega el encabezado.  Los únicos valores válidos para `disposition' son @code{attachment} e @code{inline}.

Si se especifica el `filename', se usa como el valor del parámetro @code{filename} del encabezado @code{Content-Disposition}.

Si se especifica `cid', agrega un encabezado @code{Content-ID} con valor `cid'.

Si se especifica `params', itera su método @code{items} y use los pares resultantes @code{(key, value)} para establecer parámetros adicionales en el encabezado @code{Content-Type}.

Si se especifica `headers' y es una lista de cadenas de caracteres de la forma @code{headername: headervalue} o una lista de objetos @code{header} (que se distinguen de las cadenas de caracteres por tener un atributo @code{name}), agrega los encabezados a `msg'.
@end deffn
@end deffn

@subsubheading Notas al pie de página


@node email Ejemplos,email message Message Representar un mensaje de correo electrónico usando la API compat32,email contentmanager Managing MIME Content,email — An email and MIME handling package
@anchor{library/email examples doc}@anchor{3547}@anchor{library/email examples email-examples}@anchor{fbc}@anchor{library/email examples id1}@anchor{3548}
@subsubsection @code{email}: Ejemplos


Aquí hay algunos ejemplos de cómo usar el paquete @ref{3c,,email} para leer, escribir y enviar mensajes de correo electrónico simples, así como mensajes MIME más complejos.

Primero, veamos cómo crear y enviar un mensaje de texto simple (tanto el contenido de texto como las direcciones pueden contener caracteres unicode):

@example
# Import smtplib for the actual sending function
import smtplib

# Import the email modules we'll need
from email.message import EmailMessage

# Open the plain text file whose name is in textfile for reading.
with open(textfile) as fp:
    # Create a text/plain message
    msg = EmailMessage()
    msg.set_content(fp.read())

# me == the sender's email address
# you == the recipient's email address
msg['Subject'] = f'The contents of @{textfile@}'
msg['From'] = me
msg['To'] = you

# Send the message via our own SMTP server.
s = smtplib.SMTP('localhost')
s.send_message(msg)
s.quit()
@end example

El análisis de los encabezados 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} se pueden hacer fácilmente usando las clases del módulo @ref{4f,,parser}:

@example
# Import the email modules we'll need
#from email.parser import BytesParser
from email.parser import Parser
from email.policy import default

# If the e-mail headers are in a file, uncomment these two lines:
# with open(messagefile, 'rb') as fp:
#     headers = BytesParser(policy=default).parse(fp)

#  Or for parsing headers in a string (this is an uncommon operation), use:
headers = Parser(policy=default).parsestr(
        'From: Foo Bar <user@@example.com>\n'
        'To: <someone_else@@example.com>\n'
        'Subject: Test message\n'
        '\n'
        'Body would go here\n')

#  Now the header items can be accessed as a dictionary:
print('To: @{@}'.format(headers['to']))
print('From: @{@}'.format(headers['from']))
print('Subject: @{@}'.format(headers['subject']))

# You can also access the parts of the addresses:
print('Recipient username: @{@}'.format(headers['to'].addresses[0].username))
print('Sender name: @{@}'.format(headers['from'].addresses[0].display_name))
@end example

Aquí hay un ejemplo de cómo enviar un mensaje MIME que contiene un grupo de fotos familiares que pueden residir en un directorio:

@example
# Import smtplib for the actual sending function.
import smtplib

# Here are the email package modules we'll need.
from email.message import EmailMessage

# Create the container email message.
msg = EmailMessage()
msg['Subject'] = 'Our family reunion'
# me == the sender's email address
# family = the list of all recipients' email addresses
msg['From'] = me
msg['To'] = ', '.join(family)
msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

# Open the files in binary mode.  You can also omit the subtype
# if you want MIMEImage to guess it.
for file in pngfiles:
    with open(file, 'rb') as fp:
        img_data = fp.read()
    msg.add_attachment(img_data, maintype='image',
                                 subtype='png')

# Send the email via our own SMTP server.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

Aquí hay un ejemplo de cómo enviar todo el contenido de un directorio como un mensaje de correo electrónico: @footnote{
Gracias a `Matthew Dixon Cowles' por la inspiración y ejemplos originales.
}

@example
#!/usr/bin/env python3

"""Send the contents of a directory as a MIME message."""

import os
import smtplib
# For guessing MIME type based on file name extension
import mimetypes

from argparse import ArgumentParser

from email.message import EmailMessage
from email.policy import SMTP


def main():
    parser = ArgumentParser(description="""\
Send the contents of a directory as a MIME message.
Unless the -o option is given, the email is sent by forwarding to your local
SMTP server, which then does the normal delivery process.  Your local machine
must be running an SMTP server.
""")
    parser.add_argument('-d', '--directory',
                        help="""Mail the contents of the specified directory,
                        otherwise use the current directory.  Only the regular
                        files in the directory are sent, and we don't recurse to
                        subdirectories.""")
    parser.add_argument('-o', '--output',
                        metavar='FILE',
                        help="""Print the composed message to FILE instead of
                        sending the message to the SMTP server.""")
    parser.add_argument('-s', '--sender', required=True,
                        help='The value of the From: header (required)')
    parser.add_argument('-r', '--recipient', required=True,
                        action='append', metavar='RECIPIENT',
                        default=[], dest='recipients',
                        help='A To: header value (at least one required)')
    args = parser.parse_args()
    directory = args.directory
    if not directory:
        directory = '.'
    # Create the message
    msg = EmailMessage()
    msg['Subject'] = f'Contents of directory @{os.path.abspath(directory)@}'
    msg['To'] = ', '.join(args.recipients)
    msg['From'] = args.sender
    msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

    for filename in os.listdir(directory):
        path = os.path.join(directory, filename)
        if not os.path.isfile(path):
            continue
        # Guess the content type based on the file's extension.  Encoding
        # will be ignored, although we should check for simple things like
        # gzip'd or compressed files.
        ctype, encoding = mimetypes.guess_file_type(path)
        if ctype is None or encoding is not None:
            # No guess could be made, or the file is encoded (compressed), so
            # use a generic bag-of-bits type.
            ctype = 'application/octet-stream'
        maintype, subtype = ctype.split('/', 1)
        with open(path, 'rb') as fp:
            msg.add_attachment(fp.read(),
                               maintype=maintype,
                               subtype=subtype,
                               filename=filename)
    # Now send or store the message
    if args.output:
        with open(args.output, 'wb') as fp:
            fp.write(msg.as_bytes(policy=SMTP))
    else:
        with smtplib.SMTP('localhost') as s:
            s.send_message(msg)


if __name__ == '__main__':
    main()
@end example

Aquí hay un ejemplo de cómo descomprimir un mensaje MIME como el anterior, en un directorio de archivos:

@example
#!/usr/bin/env python3

"""Unpack a MIME message into a directory of files."""

import os
import email
import mimetypes

from email.policy import default

from argparse import ArgumentParser


def main():
    parser = ArgumentParser(description="""\
Unpack a MIME message into a directory of files.
""")
    parser.add_argument('-d', '--directory', required=True,
                        help="""Unpack the MIME message into the named
                        directory, which will be created if it doesn't already
                        exist.""")
    parser.add_argument('msgfile')
    args = parser.parse_args()

    with open(args.msgfile, 'rb') as fp:
        msg = email.message_from_binary_file(fp, policy=default)

    try:
        os.mkdir(args.directory)
    except FileExistsError:
        pass

    counter = 1
    for part in msg.walk():
        # multipart/* are just containers
        if part.get_content_maintype() == 'multipart':
            continue
        # Applications should really sanitize the given filename so that an
        # email message can't be used to overwrite important files
        filename = part.get_filename()
        if not filename:
            ext = mimetypes.guess_extension(part.get_content_type())
            if not ext:
                # Use a generic bag-of-bits extension
                ext = '.bin'
            filename = f'part-@{counter:03d@}@{ext@}'
        counter += 1
        with open(os.path.join(args.directory, filename), 'wb') as fp:
            fp.write(part.get_payload(decode=True))


if __name__ == '__main__':
    main()
@end example

Aquí hay un ejemplo de cómo crear un mensaje HTML con una versión alternativa de texto sin formato. Para hacer las cosas un poco más interesantes, incluimos una imagen relacionada en la parte html, y guardamos una copia de lo que vamos a enviar en el disco, además de enviarlo.

@example
#!/usr/bin/env python3

import smtplib

from email.message import EmailMessage
from email.headerregistry import Address
from email.utils import make_msgid

# Create the base text message.
msg = EmailMessage()
msg['Subject'] = "Pourquoi pas des asperges pour ce midi ?"
msg['From'] = Address("Pepé Le Pew", "pepe", "example.com")
msg['To'] = (Address("Penelope Pussycat", "penelope", "example.com"),
             Address("Fabrette Pussycat", "fabrette", "example.com"))
msg.set_content("""\
Salut!

Cette recette [1] sera sûrement un très bon repas.

[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718

--Pepé
""")

# Add the html version.  This converts the message into a multipart/alternative
# container, with the original text message as the first part and the new html
# message as the second part.
asparagus_cid = make_msgid()
msg.add_alternative("""\
<html>
  <head></head>
  <body>
    <p>Salut!</p>
    <p>Cette
        <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">
            recette
        </a> sera sûrement un très bon repas.
    </p>
    <img src="cid:@{asparagus_cid@}" />
  </body>
</html>
""".format(asparagus_cid=asparagus_cid[1:-1]), subtype='html')
# note that we needed to peel the <> off the msgid for use in the html.

# Now add the related image to the html part.
with open("roasted-asparagus.jpg", 'rb') as img:
    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
                                     cid=asparagus_cid)

# Make a local copy of what we are going to send.
with open('outgoing.msg', 'wb') as f:
    f.write(bytes(msg))

# Send the message via local SMTP server.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

Si nos enviaron el mensaje del último ejemplo, aquí hay una forma en que podríamos procesarlo:

@example
import os
import sys
import tempfile
import mimetypes
import webbrowser

# Import the email modules we'll need
from email import policy
from email.parser import BytesParser


def magic_html_parser(html_text, partfiles):
    """Return safety-sanitized html linked to partfiles.

    Rewrite the href="cid:...." attributes to point to the filenames in partfiles.
    Though not trivial, this should be possible using html.parser.
    """
    raise NotImplementedError("Add the magic needed")


# In a real program you'd get the filename from the arguments.
with open('outgoing.msg', 'rb') as fp:
    msg = BytesParser(policy=policy.default).parse(fp)

# Now the header items can be accessed as a dictionary, and any non-ASCII will
# be converted to unicode:
print('To:', msg['to'])
print('From:', msg['from'])
print('Subject:', msg['subject'])

# If we want to print a preview of the message content, we can extract whatever
# the least formatted payload is and print the first three lines.  Of course,
# if the message has no plain text part printing the first three lines of html
# is probably useless, but this is just a conceptual example.
simplest = msg.get_body(preferencelist=('plain', 'html'))
print()
print('@w{'}.join(simplest.get_content().splitlines(keepends=True)[:3]))

ans = input("View full message?")
if ans.lower()[0] == 'n':
    sys.exit()

# We can extract the richest alternative in order to display it:
richest = msg.get_body()
partfiles = @{@}
if richest['content-type'].maintype == 'text':
    if richest['content-type'].subtype == 'plain':
        for line in richest.get_content().splitlines():
            print(line)
        sys.exit()
    elif richest['content-type'].subtype == 'html':
        body = richest
    else:
        print("Don't know how to display @{@}".format(richest.get_content_type()))
        sys.exit()
elif richest['content-type'].content_type == 'multipart/related':
    body = richest.get_body(preferencelist=('html'))
    for part in richest.iter_attachments():
        fn = part.get_filename()
        if fn:
            extension = os.path.splitext(part.get_filename())[1]
        else:
            extension = mimetypes.guess_extension(part.get_content_type())
        with tempfile.NamedTemporaryFile(suffix=extension, delete=False) as f:
            f.write(part.get_content())
            # again strip the <> to go from email form of cid to html form.
            partfiles[part['content-id'][1:-1]] = f.name
else:
    print("Don't know how to display @{@}".format(richest.get_content_type()))
    sys.exit()
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
    f.write(magic_html_parser(body.get_content(), partfiles))
webbrowser.open(f.name)
os.remove(f.name)
for fn in partfiles.values():
    os.remove(fn)

# Of course, there are lots of email messages that could break this simple
# minded program, but it will handle the most common ones.
@end example

Hasta el aviso, el resultado de lo anterior es:

@example
To: Penelope Pussycat <penelope@@example.com>, Fabrette Pussycat <fabrette@@example.com>
From: Pepé Le Pew <pepe@@example.com>
Subject: Pourquoi pas des asperges pour ce midi ?

Salut!

Cette recette [1] sera sûrement un très bon repas.
@end example

@subsubheading Notas al pie


API heredada:

@node email message Message Representar un mensaje de correo electrónico usando la API compat32,email mime Creating email and MIME objects from scratch,email Ejemplos,email — An email and MIME handling package
@anchor{library/email compat32-message doc}@anchor{3549}@anchor{library/email compat32-message compat32-message}@anchor{349a}@anchor{library/email compat32-message email-message-message-representing-an-email-message-using-the-compat32-api}@anchor{354a}
@subsubsection @code{email.message.Message}: Representar un mensaje de correo electrónico usando la API @code{compat32}


La clase @ref{3d1,,Message} es muy similar a la clase @ref{3d0,,EmailMessage}, sin los métodos añadidos por esa clase y con el comportamiento predeterminado de algunos otros métodos siendo ligeramente diferente. También documentamos aquí algunos métodos que, aun siendo soportados por @ref{3d0,,EmailMessage}, no están recomendados a no ser que estés lidiando con código heredado.

Por lo demás, la filosofía y estructura de las dos clases es la misma.

Este documento describe el comportamiento bajo la política por defecto (para @ref{3d1,,Message}) @ref{1129,,Compat32}. Si vas a usar otra política, deberías estar usando la clase @ref{3d0,,EmailMessage} en su lugar.

Un mensaje de correo electrónico consta de `headers' y `payload'. Los encabezados deben ser nombres y valores de estilo 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, donde el nombre del campo y el valor están separados por dos puntos. Los dos puntos no forman parte del nombre del campo ni del valor del campo. La carga útil puede ser un mensaje de texto simple, un objeto binario o una secuencia estructurada de submensajes, cada uno con su propio conjunto de encabezados y su propia carga útil. El último tipo de carga útil se indica mediante el mensaje que tiene un tipo MIME como @code{multipart/*} o @code{message/rfc822}.

El modelo conceptual proporcionado por un objeto @ref{3d1,,Message} es el de un diccionario ordenado de encabezados con métodos adicionales para acceder a información especializada de los encabezados, para acceder a la carga, para generar una versión serializada del mensaje y para recorrer recursivamente el árbol del objeto. Ten en cuenta que son soportados encabezados duplicados pero deben ser usados métodos especiales para acceder a ellos.

El pseudodiccionario @ref{3d1,,Message} es indexado por los nombres de encabezados, los cuales deben ser valores ASCII. Los valores del diccionario son cadenas que se supone que contienen sólo caracteres ASCII; hay algún manejo especial para la entrada no ASCII, pero esta no siempre produce los resultados correctos. Los encabezados son almacenados y retornados preservando mayúsculas y minúsculas, pero los nombres de campos son emparejados sin distinción entre mayúsculas y minúsculas. También puede haber sólo un encabezado de envoltura, también conocido como el encabezado `Unix-From' o el encabezado @code{From_}. La carga (`payload') es una cadena o bytes, en el caso de objetos de mensajes simples, o una lista de objetos @ref{3d1,,Message}, para contenedores de documentos MIME (ej. @code{multipart/*} y @code{message/rfc822}).

Aquí están los métodos de la clase @ref{3d1,,Message}:

@geindex Message (clase en email.message)
@anchor{library/email compat32-message email message Message}@anchor{3d1}
@deffn {Clase} email.message.Message (policy=compat32)

Si se especifica `policy' (debe ser una instancia de una clase @ref{50,,policy}) utiliza las reglas que especifica para actualizar y serializar la representación del mensaje. Si no se define `policy', utiliza la política @ref{1129,,compat32}, la cual mantiene compatibilidad con la versión de Python 3.2 del paquete email. Para más información consulta la documentación de @ref{50,,policy}.


Distinto en la versión 3.3: El argumento de palabra clave `policy' fue añadido.


@geindex as_string() (método de email.message.Message)
@anchor{library/email compat32-message email message Message as_string}@anchor{fb6}
@deffn {Método} as_string (unixfrom=False, maxheaderlen=0, policy=None)

Retorna el mensaje completo aplanado como una cadena. Cuando el parámetro opcional `unixfrom' es verdadero, el encabezado de envoltura se incluye en la cadena retornada. `unixfrom' es por defecto @code{False}. Por razones de compatibilidad con versiones anteriores, `maxheaderlen' es @code{0} por defecto, por lo que si quieres un valor diferente debes debes sobreescribirlo explícitamente (el valor especificado por `max_line_length' en la política será ignorado por este método). El argumento `policy' puede ser usado para sobrescribir la política por defecto obtenida de la instancia del mensaje. Esto puede ser usado para controlar algo del formato producido por el método, ya que la `policy' especificada puede ser pasada al @code{Generator}.

Aplanar el mensaje puede desencadenar cambios en @ref{3d1,,Message} si por defecto necesita ser rellenado para completar la transformación a una cadena (por ejemplo, límites MIME pueden ser generados o modificados).

Note that this method is provided as a convenience and may not always
format the message the way you want.  For example, by default it does
not do the mangling of lines that begin with @code{From} that is
required by the Unix mbox format.  For more flexibility, instantiate a
@ref{123b,,Generator} instance and use its
@ref{34ec,,flatten()} method directly.  For example:

@example
from io import StringIO
from email.generator import Generator
fp = StringIO()
g = Generator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()
@end example

Si el objeto de mensaje contiene datos binarios que no están codificados de acuerdo a los estándares RFC, los datos no compatibles serán reemplazados por puntos de código Unicode de «carácter desconocido». (Consulta también @ref{fb7,,as_bytes()} y @ref{123c,,BytesGenerator}.)


Distinto en la versión 3.4: el argumento de palabra clave `policy' fue añadido.

@end deffn

@geindex __str__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __str__}@anchor{354b}
@deffn {Método} __str__ ()

Equivalent to @ref{fb6,,as_string()}.  Allows @code{str(msg)} to produce a
string containing the formatted message.
@end deffn

@geindex as_bytes() (método de email.message.Message)
@anchor{library/email compat32-message email message Message as_bytes}@anchor{fb7}
@deffn {Método} as_bytes (unixfrom=False, policy=None)

Retorna el mensaje completo aplanado como un objeto de bytes. Cuando el argumento opcional `unixfrom' es verdadero, el encabezado de envoltura se incluye en la cadena retornada. `unixfrom' es por defecto @code{False}. El argumento `policy' puede ser usado para sobrescribir la política por defecto obtenida desde la instancia del mensaje. Esto puede ser usado para controlar algo del formato producido por el método, ya que el `policy' especificado será pasado al @code{BytesGenerator}.

Aplanar el mensaje puede desencadenar cambios en @ref{3d1,,Message} si por defecto necesita ser rellenado para completar la transformación a una cadena (por ejemplo, límites MIME pueden ser generados o modificados).

Note that this method is provided as a convenience and may not always
format the message the way you want.  For example, by default it does
not do the mangling of lines that begin with @code{From} that is
required by the Unix mbox format.  For more flexibility, instantiate a
@ref{123c,,BytesGenerator} instance and use its
@ref{34e8,,flatten()} method directly.
For example:

@example
from io import BytesIO
from email.generator import BytesGenerator
fp = BytesIO()
g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()
@end example


Added in version 3.4.

@end deffn

@geindex __bytes__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __bytes__}@anchor{fb8}
@deffn {Método} __bytes__ ()

Equivalent to @ref{fb7,,as_bytes()}.  Allows @code{bytes(msg)} to produce a
bytes object containing the formatted message.


Added in version 3.4.

@end deffn

@geindex is_multipart() (método de email.message.Message)
@anchor{library/email compat32-message email message Message is_multipart}@anchor{34c2}
@deffn {Método} is_multipart ()

Retorna @code{True} si la carga del mensaje es una lista de objetos heredados de @ref{3d1,,Message}, si no retorna @code{False}. Cuando @ref{34c2,,is_multipart()} retorna @code{False}, la carga debe ser un objeto de cadena (el cual puede ser una carga CTE codificada en binario). (Ten en cuenta que @ref{34c2,,is_multipart()} retornando @code{True} no significa necesariamente que «msg.get_content_maintype() == “multipart”» retornará @code{True}. Por ejemplo, @code{is_multipart} retornará @code{True} cuando el @ref{3d1,,Message} es de tipo @code{message/rfc822}.)
@end deffn

@geindex set_unixfrom() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_unixfrom}@anchor{354c}
@deffn {Método} set_unixfrom (unixfrom)

Establece el mensaje del encabezado de envoltura a `unixfrom', el cual debe ser una cadena.
@end deffn

@geindex get_unixfrom() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_unixfrom}@anchor{354d}
@deffn {Método} get_unixfrom ()

Retorna el mensaje del encabezado de envoltura. Por defecto a @code{None} si el encabezado de envoltura nunca fue definido.
@end deffn

@geindex attach() (método de email.message.Message)
@anchor{library/email compat32-message email message Message attach}@anchor{34cf}
@deffn {Método} attach (payload)

Añade el `payload' dado a la carga actual, la cual debe ser @code{None} o una lista de objetos @ref{3d1,,Message} antes de la invocación. Después de la invocación, la carga siempre será una lista de objetos @ref{3d1,,Message}. Si quieres definir la carga a un objeto escalar (ej. una cadena), usa @ref{354e,,set_payload()} en su lugar.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por @ref{18b1,,set_content()} y los métodos relacionados @code{make} y @code{add}.
@end deffn

@geindex get_payload() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_payload}@anchor{123a}
@deffn {Método} get_payload (i=None, decode=False)

Retorna la carga (`payload') actual, la cual será una lista de objetos @ref{3d1,,Message} cuando @ref{34c2,,is_multipart()} es @code{True}, o una cadena cuando @ref{34c2,,is_multipart()} es @code{False}. Si la carga es una lista y mutas el objeto de lista, modificarás la carga del mensaje.

Con el argumento opcional `i', @ref{123a,,get_payload()} retornará el elemento número `i' de la carga (`payload'), contando desde cero, si @ref{34c2,,is_multipart()} es @code{True}. Un @ref{1575,,IndexError} será generado si `i' es menor que 0 ó mayor o igual que el número de elementos en la carga. Si la carga es una cadena (ej. @ref{34c2,,is_multipart()} es @code{False}) y se define `i', se genera un @ref{228,,TypeError}.

El argumento opcional `decode' es un indicador que determina si una carga debería ser decodificada o no, de acuerdo al encabezado @code{Content-Transfer-Encoding}. Cuando es @code{True} y el mensaje no es multiparte, la carga será decodificada si el valor de su encabezado es @code{quoted-printable} o @code{base64}. Si se usa alguna otra codificación o falta el encabezado @code{Content-Transfer-Encoding}, la carga es retornada tal cual (sin decodificar). En todos los casos el valor retornado son datos binarios. Si el mensaje es multiparte y el indicador `decode' es @code{True}, entonces se retorna @code{None}. Si la carga es base64 y no fue perfectamente formada (falta relleno, tiene caracteres fuera del alfabeto base64), entonces un defecto apropiado será añadido a la propiedad defect del mensaje (@code{InvalidBase64PaddingDefect} o @code{InvalidBase64CharactersDefect}, respectivamente).

Cuando `decode' es @code{False} (por defecto) el cuerpo es retornado como una cadena sin decodificar el @code{Content-Transfer-Encoding}. Sin embargo, para un @code{Content-Transfer-Encoding} de 8bit, se realiza un intento para decodificar los bytes originales usando el @code{charset} especificado por el encabezado @code{Content-Type}, usando el manejador de error @code{replace}. Si ningún @code{charset} es especificado o si el @code{charset} dado no es reconocido por el paquete email, el cuerpo es decodificado usando el conjunto de caracteres ASCII por defecto.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por @ref{34c8,,get_content()} y @ref{34c7,,iter_parts()}.
@end deffn

@geindex set_payload() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_payload}@anchor{354e}
@deffn {Método} set_payload (payload, charset=None)

Define la carga completa del objeto mensaje a `payload'. Es responsabilidad del cliente asegurar invariantes de carga. El argumento opcional `charset' define el conjunto de caracteres por defecto del mensaje; consulta @ref{354f,,set_charset()} para más detalles.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por @ref{18b1,,set_content()}.
@end deffn

@geindex set_charset() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_charset}@anchor{354f}
@deffn {Método} set_charset (charset)

Define el junto de caracteres de la carga a `charset', el cual puede ser tanto una instancia @ref{e7f,,Charset} (ver @ref{3d,,email.charset}), una cadena denominando un conjunto de caracteres, o @code{None}. Si es una cadena, será convertida a una instancia @ref{e7f,,Charset}. Si `charset' es @code{None}, el parámetro @code{charset} será eliminado del encabezado @code{Content-Type} (el mensaje no será modificado de otra manera). Cualquier otro valor lanzará un @ref{228,,TypeError}.

Si no hay un encabezado existente @code{MIME-Version}, será añadido uno. Si no hay un encabezado existente @code{Content-Type}, será añadido uno con valor @code{text/plain}. Tanto como si el encabezado @code{Content-Type} existe actualmente como si no, su parámetro @code{charset} será establecido a `charset.output_charset'. Si `charset.input_charset' y `charset.output_charset' difieren, la carga será recodificada al `output_charset'. Si no hay un encabezado existente @code{Content-Transfer-Encoding}, entonces la carga será codificada por transferencia, si es necesario, usando el @ref{e7f,,Charset} especificado y un encabezado con el valor apropiado será añadido. Si ya existe un encabezado @code{Content-Transfer-Encoding}, la carga se asume que ya está correctamente codificada usando ese @code{Content-Transfer-Encoding} y no es modificada.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por el parámetro `charset' del método @code{email.emailmessage.EmailMessage.set_content()}.
@end deffn

@geindex get_charset() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_charset}@anchor{3550}
@deffn {Método} get_charset ()

Retorna la instancia @ref{e7f,,Charset} asociada con la carga del mensaje.

Este es un método heredado. En la clase @code{EmailMessage} siempre retorna @code{None}.
@end deffn

Los siguientes métodos implementan una interfaz parecida a un mapeo para acceder a los encabezados 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} del mensaje. Ten en cuenta que hay algunas diferencias semánticas entre esos métodos y una interfaz de mapeo normal (ej. diccionario). Por ejemplo, en un diccionario no hay claves duplicadas, pero aquí pueden haber encabezados de mensaje duplicados. También, en diccionarios no hay un orden garantizado de las claves retornadas por @ref{3551,,keys()}, pero en un objeto @ref{3d1,,Message}, los encabezados siempre son retornados en el orden que aparecieron en el mensaje original, o en el que fueron añadidos al mensaje más tarde. Cualquier encabezado eliminado y vuelto a adicionar siempre es añadido al final de la lista de encabezados.

Esas diferencias semánticas son intencionales y están sesgadas hacia la máxima comodidad.

Ten en cuenta que en todos los casos, cualquier encabezado de envoltura presente en el mensaje no está incluido en la interfaz de mapeo.

In a model generated from bytes, any header values that (in contravention of
the RFCs) contain non-ASCII bytes will, when retrieved through this
interface, be represented as @ref{18b2,,Header} objects with
a charset of @code{unknown-8bit}.

@geindex __len__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __len__}@anchor{3552}
@deffn {Método} __len__ ()

Retorna el número total de encabezados, incluyendo duplicados.
@end deffn

@geindex __contains__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __contains__}@anchor{1787}
@deffn {Método} __contains__ (name)

Retorna @code{True} si el objeto mensaje tiene un campo llamado `name'. La concordancia se realiza sin distinguir mayúsculas de minúsculas y `name' no debería incluir el caracter de doble punto final. Usado para el operador @code{in}, ej:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __getitem__}@anchor{3553}
@deffn {Método} __getitem__ (name)

Retorna el valor del campo del encabezado nombrado. `name' no debe incluir el separador de campo de doble punto. Si falta un encabezado, se retorna @code{None}; nunca se genera un error @ref{438,,KeyError}.

Ten en cuenta que si el campo nombrado aparece más de una vez en los encabezados del mensaje, no se define cuales serán exactamente aquellos valores de campos retornados. Usa el método @ref{3554,,get_all()} para obtener los valores de todos los encabezados nombrados existentes.
@end deffn

@geindex __setitem__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __setitem__}@anchor{3555}
@deffn {Método} __setitem__ (name, val)

Añade un encabezado al mensaje con el nombre de campo `name' y el valor `val'. El campo es añadido al final de los campos existentes del mensaje.

Ten en cuenta que esto no sobreescribe ni elimina ningún encabezado existente con el mismo nombre. Si quieres asegurar que el nuevo encabezado es el único presente en el mensaje con el nombre de campo `name', elimina el campo primero, ej:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example
@end deffn

@geindex __delitem__() (método de email.message.Message)
@anchor{library/email compat32-message email message Message __delitem__}@anchor{3556}
@deffn {Método} __delitem__ (name)

Elimina todas las ocurrencias de un campo con el nombre `name' de los encabezados del mensaje. No se genera ninguna excepción si el encabezado nombrado no está presente en los encabezados.
@end deffn

@geindex keys() (método de email.message.Message)
@anchor{library/email compat32-message email message Message keys}@anchor{3551}
@deffn {Método} keys ()

Retorna una lista de todos los nombres de campos de encabezados del mensaje.
@end deffn

@geindex values() (método de email.message.Message)
@anchor{library/email compat32-message email message Message values}@anchor{3557}
@deffn {Método} values ()

Retorna una lista de todos los valores de campos del mensaje.
@end deffn

@geindex items() (método de email.message.Message)
@anchor{library/email compat32-message email message Message items}@anchor{3558}
@deffn {Método} items ()

Retorna una lista de tuplas de dos elementos conteniendo todos los campos y valores de encabezados del mensaje.
@end deffn

@geindex get() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get}@anchor{3559}
@deffn {Método} get (name, failobj=None)

Return the value of the named header field.  This is identical to
@ref{3d8,,__getitem__()} except that optional `failobj' is returned if the
named header is missing (defaults to @code{None}).
@end deffn

Aquí hay algunos métodos útiles adicionales:

@geindex get_all() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_all}@anchor{3554}
@deffn {Método} get_all (name, failobj=None)

Retorna una lista de todos los valores para el campo denominado `name'. Si no hay tales encabezados nombrados en el mensaje, retorna `failobj' (por defecto @code{None}).
@end deffn

@geindex add_header() (método de email.message.Message)
@anchor{library/email compat32-message email message Message add_header}@anchor{355a}
@deffn {Método} add_header (_name, _value, **_params)

Configuración de encabezado extendida. Este método es similar a @ref{3555,,__setitem__()} excepto que pueden ser provistos parámetros adicionales de encabezado como argumentos de palabra clave. `_name' es el campo de encabezado a añadir y `_value' es el valor `primario' para el encabezado.

Para cada elemento en el diccionario de argumentos de palabra clave `_params', la clave se toma como el nombre del parámetro con guiones bajos convertidos a guiones medios (ya que los guiones medios son ilegales como identificadores en Python). Normalmente, el parámetro será añadido como  @code{key="value"} a no ser que el valor sea @code{None}, en cuyo caso sólo la clave será añadida. Si el valor contiene caracteres no ASCII, puede ser especificado como una tupla de tres elementos en el formato @code{(CHARSET, LANGUAGE, VALUE)}, donde @code{CHARSET} es una cadena que nombra el conjunto de caracteres a ser usado al codificar el valor, @code{LANGUAGE} puede normalmente ser definido a @code{None} o una cadena vacía (ver 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} para otras posibilidades) y @code{VALUE} es la cadena del valor conteniendo puntos de caracteres no ASCII. Si no se pasa una tupla de tres elementos y el valor contiene caracteres no ASCII, se codifica automáticamente en formato 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} usando @code{CHARSET} como @code{utf-8} y @code{LANGUAGE} como @code{None}.

Aquí hay un ejemplo:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

Esto añadirá un encabezado que se verá como

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

Un ejemplo con caracteres no ASCII:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example

Lo que produce

@example
Content-Disposition: attachment; filename*="iso-8859-1'@w{'}Fu%DFballer.ppt"
@end example
@end deffn

@geindex replace_header() (método de email.message.Message)
@anchor{library/email compat32-message email message Message replace_header}@anchor{355b}
@deffn {Método} replace_header (_name, _value)

Reemplaza un encabezado. Reemplaza el primer encabezado encontrado en el mensaje que concuerda con `_name', conservando el orden del encabezado y el nombre del campo. Si no se encuentra ningún encabezado que concuerde, se genera un error @ref{438,,KeyError}.
@end deffn

@geindex get_content_type() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_content_type}@anchor{355c}
@deffn {Método} get_content_type ()

Retorna el tipo de contenido del mensaje. La cadena retornada se fuerza a letras minúsculas de la forma @code{maintype/subtype}. Si no hay ningún encabezado @code{Content-Type} en el mensaje será retornado el tipo por defecto como es dado por @ref{355d,,get_default_type()}. Dado que según 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, los mensajes tienen siempre un tipo predeterminado, @ref{355c,,get_content_type()} siempre retornará un valor.

@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} define el tipo predeterminado del mensaje a @code{text/plain} a no ser que aparezca dentro de un contenedor @code{multipart/digest}, en cuyo caso sería @code{message/rfc822}. Si el encabezado @code{Content-Type} tiene una especificación de tipo inválido, 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} ordena que el tipo por defecto sea @code{text/plain}.
@end deffn

@geindex get_content_maintype() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_content_maintype}@anchor{355e}
@deffn {Método} get_content_maintype ()

Retorna el tipo de contenido principal del mensaje. Esta es la parte @code{maintype} de la cadena retornada por @ref{355c,,get_content_type()}.
@end deffn

@geindex get_content_subtype() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_content_subtype}@anchor{355f}
@deffn {Método} get_content_subtype ()

Retorna el tipo del subcontenido del mensaje. Esta es la parte @code{subtype} de la cadena retornada por @ref{355c,,get_content_type()}.
@end deffn

@geindex get_default_type() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_default_type}@anchor{355d}
@deffn {Método} get_default_type ()

Retorna el tipo del contenido por defecto. La mayoría de mensajes tienen un tipo de contenido por defecto de @code{text/plain}, excepto para mensajes que son subpartes de contenedores @code{multipart/digest}. Tales subpartes tienen como tipo de contenido predeterminado @code{message/rfc822}.
@end deffn

@geindex set_default_type() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_default_type}@anchor{3560}
@deffn {Método} set_default_type (ctype)

Establece el tipo de contenido por defecto. `ctype' debería ser @code{text/plain} o @code{message/rfc822}, aunque esto no es obligatorio. El tipo de contenido predeterminado no se almacena en el encabezado @code{Content-Type}.
@end deffn

@geindex get_params() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_params}@anchor{3561}
@deffn {Método} get_params (failobj=None, header='content-type', unquote=True)

Retorna los parámetros del @code{Content-Type} del mensaje como una lista. Los elementos de la lista retornada son tuplas de dos elementos de pares clave/valor, tal y como son partidas por el signo @code{'='}. El lado izquierdo del @code{'='} es la clave, mientras el lado derecho es el valor. Si no hay signo @code{'='} en el parámetro, el valor es la cadena vacía, en caso contrario el valor es como se describe en @ref{3562,,get_param()} y no está citado si el parámetro opcional `unquote' es @code{True} (por defecto).

El parámetro opcional `failobj' es el objeto a retornar si no hay encabezado @code{Content-Type}. El parámetro opcional `header' es el encabezado a buscar en lugar de @code{Content-Type}.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por la propiedad `params' de los objetos individuales de encabezado retornados por los métodos de acceso del encabezado.
@end deffn

@geindex get_param() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_param}@anchor{3562}
@deffn {Método} get_param (param, failobj=None, header='content-type', unquote=True)

Retorna el valor del parámetro `param' del encabezado @code{Content-Type} como una cadena. Si el mensaje no tiene encabezado @code{Content-Type} o si no existe tal parámetro, entonces se retorna `failobj' (por defecto es @code{None}).

El parámetro opcional `header', si es definido, especifica el encabezado del mensaje a usar en lugar de @code{Content-Type}.

Las claves de parámetros siempre son comparadas distinguiendo entre mayúsculas y minúsculas. El valor de retorno puede ser una cadena, una tupla de 3 elementos si el parámetro fue codificado según 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. Cuando es una tupla de 3 elementos, los elementos del valor tienen la forma @code{(CHARSET, LANGUAGE, VALUE)}. Ten en cuenta que @code{CHARSET} y @code{LANGUAGE} pueden ser @code{None}, en cuyo caso debes considerar @code{VALUE} como codificado en el conjunto de caracteres @code{us-ascii}. Generalmente puedes ignorar @code{LANGUAGE}.

Si a tu aplicación no le importa si el parámetro fue codificado según 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, puedes contraer el valor del parámetro invocando @ref{3563,,email.utils.collapse_rfc2231_value()}, pasando el valor de retorno desde @ref{3562,,get_param()}. Esto retornará una cadena Unicode convenientemente decodificada cuando el valor es una tupla o la cadena original sin entrecomillar si no lo es. Por ejemplo:

@example
rawparam = msg.get_param('foo')
param = email.utils.collapse_rfc2231_value(rawparam)
@end example

En cualquier caso, el valor del parámetro (tanto la cadena retornada o el elemento @code{VALUE} en la tupla de 3 elementos) siempre está sin entrecomillar, a no ser que `unquote' está establecido a @code{False}.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por la propiedad `params' de los objetos individuales de encabezado retornados por los métodos de acceso del encabezado.
@end deffn

@geindex set_param() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_param}@anchor{fb9}
@deffn {Método} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

Establece un parámetro en el encabezado @code{Content-Type}. Si el parámetro ya existe en el encabezado, su valor será remplazado con `value'. Si el encabezado @code{Content-Type} no ha sido definido todavía para este mensaje, será establecido a @code{text/plain} y el nuevo valor del parámetro será añadido según 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}.

El parámetro opcional `header' especifica una alternativa a @code{Content-Type} y todos los parámetros serán entrecomillados si es necesario a no ser que el parámetro opcional `requote' sea @code{False} (por defecto es @code{True}).

Si se especifica el parámetro opcional `charset', el parámetro será codificado de acuerdo a 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. El parámetro opcional `language' especifica el lenguaje RFC 2231, por defecto una cadena vacía. Tanto `charset' como `language' deberían ser cadenas.

Si `replace' es @code{False} (por defecto) el encabezado será movido al final de la lista de encabezados. Si `replace' es @code{True}, el encabezado será actualizado.


Distinto en la versión 3.4: el parámetro de palabra clave @code{replace} fue añadido.

@end deffn

@geindex del_param() (método de email.message.Message)
@anchor{library/email compat32-message email message Message del_param}@anchor{3564}
@deffn {Método} del_param (param, header='content-type', requote=True)

Elimina el parámetro dado completamente del encabezado @code{Content-Type}. El encabezado será reescrito en sí mismo sin el parámetro o su valor. Todos los valores serán entrecomillados si es necesario a no ser que `requote' sea @code{False} (por defecto es @code{True}). El parámetro opcional `header' especifica una alternativa a @code{Content-Type}.
@end deffn

@geindex set_type() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_type}@anchor{3565}
@deffn {Método} set_type (type, header='Content-Type', requote=True)

Establece el tipo y subtipo principal para el encabezado @code{Content-Type}. `type' debe ser una cadena de la forma @code{maintype/subtype}, si no será generado un @ref{360,,ValueError}.

Este método remplaza el encabezado @code{Content-Type}, manteniendo todos los parámetros en su lugar. Si `requote' es @code{False}, este dejará el encabezado existente tal como está, en caso contrario los parámetros serán entrecomillados (por defecto).

Un encabezado alternativo puede ser especificado en el argumento `header'. Cuando el encabezado @code{Content-Type} es definido, un encabezado @code{MIME-Version} también es añadido.

Este es un método heredado. En la clase @code{EmailMessage} su funcionalidad es remplazada por los métodos @code{make_} y @code{add_}.
@end deffn

@geindex get_filename() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_filename}@anchor{3566}
@deffn {Método} get_filename (failobj=None)

Retorna el valor del parámetro @code{filename} del encabezado @code{Content-Disposition} del mensaje. Si el encabezado no tiene un parámetro @code{filename}, este método recurre a buscar el parámetro @code{name} en el encabezado @code{Content-Type}. Si tampoco se encuentra o falta el encabezado, entonces retorna `failobj'. La cadena retornada siempre será sin entrecomillar según @ref{34bb,,email.utils.unquote()}.
@end deffn

@geindex get_boundary() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_boundary}@anchor{3567}
@deffn {Método} get_boundary (failobj=None)

Retorna el valor del parámetro @code{boundary} del encabezado @code{Content-Type} del mensaje o `failobj' tanto si falta el encabezado como si no tiene parámetro @code{boundary}. La cadena retornada siempre será sin entrecomillar según @ref{34bb,,email.utils.unquote()}.
@end deffn

@geindex set_boundary() (método de email.message.Message)
@anchor{library/email compat32-message email message Message set_boundary}@anchor{3568}
@deffn {Método} set_boundary (boundary)

Establece el parámetro @code{boundary} del encabezado @code{Content-Type} a `boundary'. @ref{3568,,set_boundary()} siempre entrecomillará `boundary' si es necesario. Se genera @ref{34be,,HeaderParseError} si el objeto de mensaje no tiene encabezado @code{Content-Type}.

Ten en cuenta que usar este método es sutilmente diferente a borrar el antiguo encabezado @code{Content-Type} y añadir uno nuevo con el nuevo límite mediante @ref{355a,,add_header()} porque @ref{3568,,set_boundary()} preserva el orden del encabezado @code{Content-Type} en la lista de encabezados. Sin embargo, no conserva ninguna línea de continuación que pueden haber estado presentes en el encabezado original @code{Content-Type}.
@end deffn

@geindex get_content_charset() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_content_charset}@anchor{3569}
@deffn {Método} get_content_charset (failobj=None)

Retorna el parámetro @code{charset} del encabezado @code{Content-Type}, forzado a letras minúsculas. Si no hay un encabezado @code{Content-Type} o si ese encabezado no tiene parámetro @code{charset}, se retorna `failobj'.

Ten en cuenta que este método difiere de @ref{3550,,get_charset()}, el cual retorna la instancia @ref{e7f,,Charset} para la codificación por defecto del cuerpo del mensaje.
@end deffn

@geindex get_charsets() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_charsets}@anchor{356a}
@deffn {Método} get_charsets (failobj=None)

Retorna una lista conteniendo los nombres de los conjuntos de caracteres en el mensaje. Si el mensaje es @code{multipart}, entonces la lista contendrá un elemento para cada subparte en la carga (`payload'), en caso contrario será una lista de un elemento.

Cada elemento en la lista será una cadena la cual es el valor del parámetro @code{charset} en el encabezado @code{Content-Type} para la subparte representada. Sin embargo, si la subparte no tiene encabezado @code{Content-Type}, no tiene parámetro @code{charset} o no es del tipo MIME @code{text} principal, entonces ese elemento en la lista retornada será `failobj'.
@end deffn

@geindex get_content_disposition() (método de email.message.Message)
@anchor{library/email compat32-message email message Message get_content_disposition}@anchor{e7c}
@deffn {Método} get_content_disposition ()

Retorna el valor en minúsculas (sin parámetros) del encabezado del mensaje @code{Content-Disposition} si tiene uno o @code{None}. Los valores posibles para este método son `inline', `attachment' o @code{None} si el mensaje sigue el 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html}.


Added in version 3.5.

@end deffn

@geindex walk() (método de email.message.Message)
@anchor{library/email compat32-message email message Message walk}@anchor{356b}
@deffn {Método} walk ()

El método @ref{356b,,walk()} es un generador de todo propósito el cual puede ser usado para iterar sobre todas las partes y subpartes de árbol de objeto de mensaje, en orden de recorrido de profundidad primero. Siempre usarás típicamente @ref{356b,,walk()} como iterador en un bucle @code{for}; cada iteración retorna la siguiente subparte.

Aquí hay un ejemplo que imprime el tipo MIME de cada parte de una estructura de mensaje multiparte:

@c import email
@c from email import message_from_binary_file
@c from os.path import join, dirname
@c lib_dir = dirname(dirname(email.__file__))
@c file_path = join(lib_dir, 'test/test_email/data/msg_16.txt')
@c with open(file_path, 'rb') as f:
@c     msg = message_from_binary_file(f)
@c from email.iterators import _structure

@example
>>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain
@end example

@code{walk} itera sobre las subpartes de cualquier parte donde @ref{34c2,,is_multipart()} retorna @code{True}, aunque @code{msg.get_content_maintype() == 'multipart'} puede retornar @code{False}. Vemos esto en nuestro ejemplo haciendo uso de la función de ayuda de depuración @code{_structure}:

@example
>>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain
@end example

Aquí las partes de @code{message} no son @code{multiparts}, pero contienen subpartes. @code{is_multipart()} retorna @code{True} y @code{walk} desciende a las subpartes.
@end deffn

Los objetos @ref{3d1,,Message} pueden contener opcionalmente dos atributos de instancia, los cuales pueden ser usados al generar el texto plano de un mensaje MIME.

@geindex preamble (atributo de email.message.Message)
@anchor{library/email compat32-message email message Message preamble}@anchor{356c}
@deffn {Atributo} preamble

El formato de un documento MIME permite algo de texto entre la línea en blanco que sigue a los encabezados y la primera cadena límite multiparte. Normalmente, este texto nunca es visible en un lector de correo compatible con MIME porque queda fuera de la armadura MIME estándar. Sin embargo, viendo el texto del mensaje en crudo o viendo el mensaje en un lector no compatible con MIME, este texto puede volverse visible.

El atributo `preamble' contiene este texto de refuerzo adicional para documentos MIME. Cuando el @ref{120d,,Parser} descubre algo de texto después de los encabezados pero antes de la primera cadena límite, asigna este texto al atributo `preamble' del mensaje. Cuando el @ref{123b,,Generator} está escribiendo la representación de texto sin formato de un mensaje MIME y puede encontrar el mensaje como un atributo `preamble', escribirá este texto en el área entre los encabezados y el primer límite. Consulta @ref{4f,,email.parser} y @ref{41,,email.generator} para más detalles.

Ten en cuenta que si el objeto de mensaje no tiene preámbulo, el atributo `preamble' será @code{None}.
@end deffn

@geindex epilogue (atributo de email.message.Message)
@anchor{library/email compat32-message email message Message epilogue}@anchor{356d}
@deffn {Atributo} epilogue

El atributo `epilogue' actúa de la misma manera que el atributo `preamble', excepto que contiene texto que aparece entre el último límite y el fin del mensaje.

No necesitas establecer el epílogo de la cadena vacía en orden para el @ref{123b,,Generator} para imprimir una nueva línea al final del archivo.
@end deffn

@geindex defects (atributo de email.message.Message)
@anchor{library/email compat32-message email message Message defects}@anchor{356e}
@deffn {Atributo} defects

El atributo `defects' contiene una lista de todos los problemas encontrados al analizar este mensaje. Consulta @ref{40,,email.errors} para una descripción detallada de los posibles defectos de análisis.
@end deffn
@end deffn

@node email mime Creating email and MIME objects from scratch,email header Internationalized headers,email message Message Representar un mensaje de correo electrónico usando la API compat32,email — An email and MIME handling package
@anchor{library/email mime doc}@anchor{356f}@anchor{library/email mime email-mime-creating-email-and-mime-objects-from-scratch}@anchor{3570}@anchor{library/email mime module-email mime}@anchor{46}
@subsubsection @code{email.mime}: Creating email and MIME objects from scratch


@geindex module; email.mime

`Código fuente:' Lib/email/mime/@footnote{https://github.com/python/cpython/tree/main/Lib/email/mime/}


__________________________________________________________________


Este módulo forma parte de la API heredada de correo electrónico (@code{Compat32}). Su funcionalidad se sustituye parcialmente por el @ref{3e,,contentmanager} en la nueva API, pero en ciertas aplicaciones estas clases pueden seguir siendo útiles, incluso en código no heredado.

Normalmente, se obtiene una estructura de objeto de mensaje pasando un archivo o algún texto a un analizador, que analiza el texto y retorna el objeto de mensaje principal. Sin embargo, también puede crear una estructura de mensajes completa desde cero, o incluso objetos individuales @ref{3d1,,Message} a mano. De hecho, también puede tomar una estructura existente y agregar nuevos objetos @ref{3d1,,Message}, moverlos, etc. Esto compone una interfaz muy conveniente para cortar y gestionar mensajes MIME.

Puede crear una nueva estructura de objeto mediante la creación de una instancia de @ref{3d1,,Message}, añadiendo accesorios y todos los encabezados necesarios manualmente. Para mensajes MIME sin embargo, el paquete @ref{3c,,email} proporciona subclases convenientes para facilitar las cosas.

Descripción de las clases:

@geindex module; email.mime.base

@geindex MIMEBase (clase en email.mime.base)
@anchor{library/email mime module-email mime base}@anchor{49}@anchor{library/email mime email mime base MIMEBase}@anchor{3571}
@deffn {Clase} email.mime.base.MIMEBase (_maintype, _subtype, *, policy=compat32, **_params)

Módulo: @ref{49,,email.mime.base}

Esta es la clase básica para todas las subclases específicas @ref{3d1,,Message} para MIME. Normalmente no creará instancias específicas de la @ref{3571,,MIMEBase}, aunque es posible. La @ref{3571,,MIMEBase} se proporciona principalmente como una clase básica conveniente para subclases más específicas, apropiadas para MIME.

`_maintype' es el tipo principal @code{Content-Type} (por ejemplo @code{text} o @code{image}), y `_subtype' es el tipo menor @code{Content-Type} (por ejemplo @code{plain} o @code{gif}). `_params' es un diccionario de parámetro clave/valor y se pasa directamente a @ref{355a,,Message.add_header}.

Si se especifica `policy', (por defecto, la directiva @ref{1129,,compat32}) se pasará a @ref{3d1,,Message}.

La clase @ref{3571,,MIMEBase} siempre agrega un encabezado @code{Content-Type} (basado en `_maintype', `_subtype' y `_params'), y un encabezado @code{MIME-Versión} (siempre establecido en @code{1.0}).


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.nonmultipart

@geindex MIMENonMultipart (clase en email.mime.nonmultipart)
@anchor{library/email mime module-email mime nonmultipart}@anchor{4d}@anchor{library/email mime email mime nonmultipart MIMENonMultipart}@anchor{3512}
@deffn {Clase} email.mime.nonmultipart.MIMENonMultipart

Módulo: @ref{4d,,email.mime.nonmultipart}

Una subclase de @ref{3571,,MIMEBase}, es una clase base intermedia para los mensajes MIME que no son @code{multipart}. El propósito principal de esta clase es evitar el uso del método @ref{34cf,,attach()}, que solo tiene sentido para los mensajes @code{multipart}. Si se llama a @code{attach()}, se lanza una excepción @ref{3511,,MultipartConversionError}.
@end deffn

@geindex module; email.mime.multipart

@geindex MIMEMultipart (clase en email.mime.multipart)
@anchor{library/email mime module-email mime multipart}@anchor{4c}@anchor{library/email mime email mime multipart MIMEMultipart}@anchor{3572}
@deffn {Clase} email.mime.multipart.MIMEMultipart (_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)

Módulo: @ref{4c,,email.mime.multipart}

Una subclase de @ref{3571,,MIMEBase}, se trata de una clase base intermedia para los mensajes MIME que son @code{multipart}. El valor predeterminado opcional de `_subtype' es @code{mixed}, pero se puede utilizar para especificar el subtipo del mensaje. Se agregará un encabezado @code{Content-Type} de @code{multipart/_subtype} al objeto del mensaje. También se agregará un encabezado @code{MIME-Version}.

El `boundary' opcional es la cadena de límite multiparte. Cuando @code{None} (valor predeterminado), el límite se calcula cuando es necesario (por ejemplo, cuando se serializa el mensaje).

`_subparts' es una secuencia de subpartes iniciales para la carga útil. Debe ser posible convertir esta secuencia en una lista. Siempre puede adjuntar nuevas subpartes al mensaje mediante el método @ref{34cf,,Message.attach}.

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.

Los parámetros adicionales para el encabezado @code{Content-Type} se toman de los argumentos de palabra clave, o se pasan al argumento `_params', que es un diccionario de palabras clave.


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.application

@geindex MIMEApplication (clase en email.mime.application)
@anchor{library/email mime module-email mime application}@anchor{47}@anchor{library/email mime email mime application MIMEApplication}@anchor{3573}
@deffn {Clase} email.mime.application.MIMEApplication (_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{47,,email.mime.application}

A subclass of @ref{3512,,MIMENonMultipart}, the
@ref{3573,,MIMEApplication} class is used to represent MIME message objects of
major type @code{application}.  `_data' contains the bytes for the raw
application data.  Optional `_subtype' specifies the MIME subtype and defaults
to @code{octet-stream}.

`_encoder' opcional es una recurso invocable (es decir, una función) que realizará la codificación real de los datos para el transporte. Este invocable toma un argumento, que es la instancia @ref{3573,,MIMEApplication}. Debe utilizar @ref{123a,,get_payload()} y @ref{354e,,set_payload()} para cambiar la carga útil a la forma codificada. También debe agregar cualquier @code{Content-Transfer-Encoding} u otros encabezados al objeto del mensaje según sea necesario. La codificación predeterminada es base64. Consulte el módulo @ref{3f,,email.encoders} para obtener una lista de los codificadores integrados.

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.

`_params' se pasan directamente al constructor de la clase base.


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.audio

@geindex MIMEAudio (clase en email.mime.audio)
@anchor{library/email mime module-email mime audio}@anchor{48}@anchor{library/email mime email mime audio MIMEAudio}@anchor{3574}
@deffn {Clase} email.mime.audio.MIMEAudio (_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{48,,email.mime.audio}

A subclass of @ref{3512,,MIMENonMultipart}, the
@ref{3574,,MIMEAudio} class is used to create MIME message objects of major type
@code{audio}. `_audiodata' contains the bytes for the raw audio data.  If
this data can be decoded as au, wav, aiff, or aifc, then the
subtype will be automatically included in the @code{Content-Type} header.
Otherwise you can explicitly specify the audio subtype via the `_subtype'
argument.  If the minor type could not be guessed and `_subtype' was not given,
then @ref{228,,TypeError} is raised.

`_encoder' opcional es un recurso invocable (es decir, una función) que realizará la codificación real de los datos de audio para el transporte. Este invocable toma un argumento, que es la instancia @ref{3574,,MIMEAudio}. Debe utilizar @ref{123a,,get_payload()} y @ref{354e,,set_payload()} para cambiar la carga útil a la forma codificada. También debe agregar cualquier @code{Content-Transfer-Encoding} u otros encabezados al objeto del mensaje según sea necesario. La codificación predeterminada es base64. Consulte el módulo @ref{3f,,email.encoders} para obtener una lista de los codificadores integrados.

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.

`_params' se pasan directamente al constructor de la clase base.


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.image

@geindex MIMEImage (clase en email.mime.image)
@anchor{library/email mime module-email mime image}@anchor{4a}@anchor{library/email mime email mime image MIMEImage}@anchor{3513}
@deffn {Clase} email.mime.image.MIMEImage (_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{4a,,email.mime.image}

A subclass of @ref{3512,,MIMENonMultipart}, the
@ref{3513,,MIMEImage} class is used to create MIME message objects of major type
@code{image}. `_imagedata' contains the bytes for the raw image data.  If
this data type can be detected (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm,
rast, xbm, bmp, webp, and exr attempted), then the subtype will be
automatically included in the @code{Content-Type} header. Otherwise
you can explicitly specify the image subtype via the `_subtype' argument.
If the minor type could not be guessed and `_subtype' was not given, then
@ref{228,,TypeError} is raised.

`_encoder' opcional es un recurso invocable (es decir, una función) que realizará la codificación real de los datos de imagen para el transporte. Este invocable toma un argumento, que es la instancia @ref{3513,,MIMEImage}. Debe utilizar @ref{123a,,get_payload()} y @ref{354e,,set_payload()} para cambiar la carga útil a la forma codificada. También debe agregar cualquier @code{Content-Transfer-Encoding} u otros encabezados al objeto del mensaje según sea necesario. La codificación predeterminada es base64. Consulte el módulo @ref{3f,,email.encoders} para obtener una lista de los codificadores integrados.

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.

`_params' se pasan directamente al constructor @ref{3571,,MIMEBase}.


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.message

@geindex MIMEMessage (clase en email.mime.message)
@anchor{library/email mime module-email mime message}@anchor{4b}@anchor{library/email mime email mime message MIMEMessage}@anchor{3575}
@deffn {Clase} email.mime.message.MIMEMessage (_msg, _subtype='rfc822', *, policy=compat32)

Módulo: @ref{4b,,email.mime.message}

Una subclase de @ref{3512,,MIMENonMultipart}, la clase @ref{3575,,MIMEMessage} se utiliza para crear objetos MIME de tipo principal @code{message}. `_msg' se utiliza como la carga y debe ser una instancia de la clase @ref{3d1,,Message} (o una subclase de la misma), de lo contrario se lanza un @ref{228,,TypeError}.

`_subtype' opcional establece el subtipo del mensaje; por defecto es @code{rfc822}.

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.


Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@geindex module; email.mime.text

@geindex MIMEText (clase en email.mime.text)
@anchor{library/email mime module-email mime text}@anchor{4e}@anchor{library/email mime email mime text MIMEText}@anchor{e7e}
@deffn {Clase} email.mime.text.MIMEText (_text, _subtype='plain', _charset=None, *, policy=compat32)

Módulo: @ref{4e,,email.mime.text}

Una subclase de @ref{3512,,MIMENonMultipart}, la clase @ref{e7e,,MIMEText} se utiliza para crear objetos MIME de tipo principal @code{text}. `_text' es la cadena de caracteres de la carga útil. `_subtype' es el tipo menor y el valor predeterminado es @code{plain}. `_charset' es el paquete de caracteres del texto y se pasa como argumento al constructor @ref{3512,,MIMENonMultipart}; el valor predeterminado es @code{us-ascii} si la cadena contiene sólo puntos de código @code{ascii}, y @code{utf-8} en caso contrario. El parámetro `_charset' acepta una cadena o una instancia @ref{e7f,,Charset}.

A menos que el argumento `_charset' se establezca explícitamente como @code{None}, el objeto MIMEText creado tendrá a la vez un encabezado @code{Content-Type} con un parámetro @code{charset}, y un encabezado @code{Content-Transfer-Encoding}. Esto significa que una llamada posterior a @code{set_payload} no dará lugar a una carga codificada, incluso si se pasa un conjunto de caracteres en el comando @code{set_payload}. Puede «restablecer» este comportamiento eliminando el encabezado @code{Content-Transfer-Encoding}, después de lo cual una llamada a @code{set_payload} codificará automáticamente la nueva carga útil (y agregará un nuevo encabezado @code{Content-Transfer-Encoding}).

El valor predeterminado del argumento `policy' opcional es @ref{1129,,compat32}.


Distinto en la versión 3.5: `_charset' también acepta instancias @ref{e7f,,Charset}.



Distinto en la versión 3.6: Se ha añadido el parámetro `policy' de solo palabra clave.

@end deffn

@node email header Internationalized headers,email charset Representing character sets,email mime Creating email and MIME objects from scratch,email — An email and MIME handling package
@anchor{library/email header doc}@anchor{3576}@anchor{library/email header email-header-internationalized-headers}@anchor{3577}@anchor{library/email header module-email header}@anchor{42}
@subsubsection @code{email.header}: Internationalized headers


@geindex module; email.header

`Código fuente:' Lib/email/header.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/header.py}


__________________________________________________________________


Este módulo es parte de la API de email heredada (@code{Compat32}). En la API actual, la codificación y decodificación de las cabeceras se gestiona de forma transparente por la API de tipo diccionario de la clase @ref{3d0,,EmailMessage}. Además de los usos del código heredado, este módulo puede ser útil en aplicaciones que necesiten controlar completamente el conjunto de caracteres usado cuando se codifican las cabeceras.

El resto del texto de esta sección es la documentación original del módulo.

@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} es el estándar base que describe el formato de los mensajes de correo electrónico. Deriva del estándar anterior 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html}, cuyo uso se generalizó durante una época en la que la mayoría del correo electrónico se componía únicamente de caracteres ASCII. 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} es una especificación que se escribió asumiendo que el correo electrónico contiene solo caracteres ASCII 7-bit.

Por supuesto, al haberse extendido el correo electrónico por todo el mundo, se ha internacionalizado, de forma que ahora pueden usarse los conjuntos de caracteres específicos de un idioma en los mensajes de correo electrónico. El estándar base todavía requiere que los mensajes de correo electrónico sean transferidos usando solo caracteres ASCII 7-bit, así que se han escrito multitud de RFCs describiendo cómo codificar correos electrónicos que contengan caracteres no ASCII en formatos conforme a la 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. Entre estas RFCs se incluyen 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}, 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} y 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. El paquete @ref{3c,,email} soporta estos estándares en sus módulos @ref{42,,email.header} y @ref{3d,,email.charset}.

Si quieres incluir caracteres no ASCII en tus cabeceras de correo electrónico, por ejemplo en los campos @code{Subject} o @code{To}, deberías usar la clase @ref{18b2,,Header} y asignar el campo del objeto @ref{3d1,,Message} a una instancia de @ref{18b2,,Header} en vez de usar una cadena de caracteres para el valor de la cabecera. Importa la clase @ref{18b2,,Header} del módulo @ref{42,,email.header}. Por ejemplo:

@example
>>> from email.message import Message
>>> from email.header import Header
>>> msg = Message()
>>> h = Header('p\xf6stal', 'iso-8859-1')
>>> msg['Subject'] = h
>>> msg.as_string()
'Subject: =?iso-8859-1?q?p=F6stal?=\n\n'
@end example

¿Has visto cómo hemos hecho que el campo @code{Subject} contuviera un caracter no ASCII? Lo hemos hecho creando una instancia de @ref{18b2,,Header} y pasándole el conjunto de caracteres en los que estaba codificado la cadena de bytes. Cuando la instancia de @ref{3d1,,Message} subsecuente se ha aplanado, el campo @code{Subject} se ha codificado en 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} adecuadamente. Los lectores de correo que soportan MIME deberían mostrar esta cabecera usando el caracter ISO-8859-1 incrustado.

Aquí está la descripción de la clase @ref{18b2,,Header}:

@geindex Header (clase en email.header)
@anchor{library/email header email header Header}@anchor{18b2}
@deffn {Clase} email.header.Header (s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict')

Crea una cabecera conforme a las especificaciones MIME que contiene cadenas de caracteres en diferentes conjuntos de caracteres.

El argumento opcional `s' es el valor inicial de la cabecera. Si es @code{None} (el valor por defecto), el valor inicial de la cabecera quedará sin asignar. Puedes añadirlo luego a la cabecera con llamadas al método @ref{3578,,append()}. `s' debe ser una instancia de @ref{325,,bytes} o @ref{237,,str}, pero lee la documentación de @ref{3578,,append()} para conocer los detalles semánticos.

El argumento opcional `charset' sirve para dos propósitos: tiene el mismo significado que el argumento `charset' en el método @ref{3578,,append()}. También asigna el conjunto de caracteres por defecto para todas las llamadas subsecuentes a @ref{3578,,append()} que omitan el argumento `charset'. Si no se proporciona `charset' en el constructor (por defecto), el conjunto de caracteres @code{us-ascii} se usa tanto para el conjunto de caracteres inicial de `s' como por defecto para las llamadas subsecuentes a @ref{3578,,append()}.

The maximum line length can be specified explicitly via `maxlinelen'.  For
splitting the first line to a shorter value (to account for the field header
which isn’t included in `s', e.g. @code{Subject}) pass in the name of the
field in `header_name'.  The default `maxlinelen' is 78, and the default value
for `header_name' is @code{None}, meaning it is not taken into account for the
first line of a long, split header.

El argumento opcional `continuation_ws' debe ser conforme a las normas de espacios en blanco plegables de la 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}, y normalmente es o un espacio o un caracter tabulador. Este caracter se antepondrá delante de las líneas continuadas. El valor por defecto de `continuation_ws' es un solo espacio.

El argumento opcional `errors' se pasa directamente a través del método @ref{3578,,append()}.

@geindex append() (método de email.header.Header)
@anchor{library/email header email header Header append}@anchor{3578}
@deffn {Método} append (s, charset=None, errors='strict')

Añade la cadena de caracteres `s' a la cabecera MIME.

El argumento opcional `charset', si se proporciona, debe ser una instancia de @ref{e7f,,Charset} (ver @ref{3d,,email.charset}) o el nombre de un conjunto de datos, que deberá ser convertido a una instancia de @ref{e7f,,Charset}. Un valor de @code{None} (el valor por defecto) significa que se usará el `charset' dado en el constructor.

`s' puede ser una instancia de @ref{325,,bytes} o de @ref{237,,str}. Si es una instancia de @ref{325,,bytes}, entonces `charset' es la codificación de esa cadena de bytes, y se lanzará un @ref{130f,,UnicodeError} si la cadena de caracteres no puede decodificarse con ese conjunto de caracteres.

Si `s' es una instancia de @ref{237,,str}, entonces `charset' es una sugerencia que especifica el conjunto de caracteres usando en la cadena de caracteres.

En cualquier caso, cuando se produce una cabecera conforme a la 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} usando las reglas de la 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, la cadena de caracteres se codificará usando el códec de salida del conjunto de caracteres. Si la cadena de caracteres no puede codificarse usando el códec de salida, se lanzará un UnicodeError.

El argumento opcional `errors' se pasa como el argumento de errores para la llamada de decodificación si `s' es una cadena de bits.
@end deffn

@geindex encode() (método de email.header.Header)
@anchor{library/email header email header Header encode}@anchor{3579}
@deffn {Método} encode (splitchars=';, \t', maxlinelen=None, linesep='\n')

Codifica un mensaje de la cabecera en un formato conforme a RFC, posiblemente envolviendo las líneas largas y encapsulando las partes no ASCII en base64 o en codificaciones imprimibles entrecomilladas.

El argumento opcional `splitchars' es una cadena de caracteres que contiene caracteres a los que el algoritmo de separación debería asignar espacio extra durante la encapsulación de la cabecera normal. Esto da un basto soporte a los saltos sintácticos de alto nivel de la 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}: los puntos de separación precedidos por un caracter separador tienen preferencia durante la separación de la línea, con preferencia de caracteres en el orden en el que aparecen en la cadena de caracteres. El espacio y el tabulador pueden incluirse en la cadena de caracteres para indicar si se debería dar preferencia a uno sobre el otro como punto de separación cuando no aparezcan otros caracteres separadores en la línea que se está dividiendo. Los caracteres separadores no afectan a las líneas codificadas de la 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}.

`maxlinelen', si se proporciona, sobrescribe el valor de longitud de línea máxima para la instancia.

`linesep' especifica los caracteres usados para separar las líneas de la cabecera plegada. Su valor por defecto es el valor más útil para el código de una aplicación Python (@code{\n}), pero se puede especificar @code{\r\n} para producir cabeceras con separadores de línea conforme a RFCs.


Distinto en la versión 3.2: Argumento `linesep' añadido.

@end deffn

La clase @ref{18b2,,Header} también proporciona una serie de métodos para soportar operaciones estándar y funciones incorporadas.

@geindex __str__() (método de email.header.Header)
@anchor{library/email header email header Header __str__}@anchor{357a}
@deffn {Método} __str__ ()

Retorna una aproximación de @ref{18b2,,Header} como una cadena de caracteres, usando una longitud de línea ilimitada. Todas las piezas se convierten a unicode utilizando la codificación especificada y unidas adecuadamente. Todas las piezas con un conjunto de caracteres @code{'unknown-8bit'} se decodifican como ASCII usando el gestor de errores de @code{'replace'}.


Distinto en la versión 3.2: Añadida gestión del conjunto de caracteres @code{'unknown-8bit'}.

@end deffn

@geindex __eq__() (método de email.header.Header)
@anchor{library/email header email header Header __eq__}@anchor{357b}
@deffn {Método} __eq__ (other)

Este método permite comparar si dos instancias de @ref{18b2,,Header} son iguales.
@end deffn

@geindex __ne__() (método de email.header.Header)
@anchor{library/email header email header Header __ne__}@anchor{357c}
@deffn {Método} __ne__ (other)

Este método permite comparar si dos instancias de @ref{18b2,,Header} no son iguales.
@end deffn
@end deffn

El módulo @ref{42,,email.header} También proporciona las prácticas funciones que se indican a continuación.

@geindex decode_header() (en el módulo email.header)
@anchor{library/email header email header decode_header}@anchor{112d}
@deffn {Función} email.header.decode_header (header)

Decodifica el valor de un mensaje de la cabecera sin convertir el conjunto de caracteres. El valor de la cabecera está en `header'.

Esta función retorna una lista de duplas @code{(decoded_string, charset)} que contiene cada una de las partes decodificadas de la cabecera. `charset' será @code{None} para las partes no codificadas de la cabecera, de lo contrario será una cadena de caracteres en minúscula con el nombre del conjunto de caracteres especificado en la cadena de caracteres codificada.

Aquí va un ejemplo:

@example
>>> from email.header import decode_header
>>> decode_header('=?iso-8859-1?q?p=F6stal?=')
[(b'p\xf6stal', 'iso-8859-1')]
@end example
@end deffn

@geindex make_header() (en el módulo email.header)
@anchor{library/email header email header make_header}@anchor{112e}
@deffn {Función} email.header.make_header (decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ')

Crea una instancia de @ref{18b2,,Header} a partir de una secuencia de duplas como las retornadas por @ref{112d,,decode_header()}.

@ref{112d,,decode_header()} toma el valor de una cadena de caracteres de la cabecera y retorna una secuencia de duplas con el formato @code{(decoded_string, charset)}, donde `charset' es el nombre del conjunto de caracteres.

Esta función toma una de esas secuencias de duplas y retorna una instancia de @ref{18b2,,Header}. Los argumentos opcionales `maxlinelen', `header_name' y `continuation_ws' son como los del constructor @ref{18b2,,Header}.
@end deffn

@node email charset Representing character sets,email encoders Encoders,email header Internationalized headers,email — An email and MIME handling package
@anchor{library/email charset doc}@anchor{357d}@anchor{library/email charset email-charset-representing-character-sets}@anchor{357e}@anchor{library/email charset module-email charset}@anchor{3d}
@subsubsection @code{email.charset}: Representing character sets


@geindex module; email.charset

`Código fuente:' Lib/email/charset.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/charset.py}


__________________________________________________________________


Este módulo es parte de la API de email heredada (@code{Compat32}). En la nueva API solo se usa la tabla de alias.

El texto restante de esta sección corresponde a la documentación original del módulo.

Este módulo proporciona una clase @ref{e7f,,Charset} para representar conjuntos de caracteres y conversiones de conjuntos de caracteres en mensajes de correo electrónico, así como un registro de conjuntos de caracteres y varios métodos de conveniencia para manipular este registro. Las instancias de @ref{e7f,,Charset} se utilizan en varios otros módulos dentro del paquete @ref{3c,,email}.

Importe esta clase desde el módulo @ref{3d,,email.charset}.

@geindex Charset (clase en email.charset)
@anchor{library/email charset email charset Charset}@anchor{e7f}
@deffn {Clase} email.charset.Charset (input_charset=DEFAULT_CHARSET)

Asigna conjuntos de caracteres a sus propiedades de correo electrónico.

Esta clase proporciona información sobre los requisitos impuestos al correo electrónico para un conjunto de caracteres específico. También proporciona rutinas de conveniencia para convertir entre juegos de caracteres, dada la disponibilidad de los códecs aplicables. Dado un conjunto de caracteres, hará todo lo posible para proporcionar información sobre cómo utilizar ese conjunto de caracteres en un mensaje de correo electrónico de forma compatible con RFC.

Ciertos conjuntos de caracteres deben codificarse con quoted-printable o base64 cuando se usan en encabezados o cuerpos de correo electrónico. Ciertos conjuntos de caracteres deben convertirse directamente y no están permitidos en el correo electrónico.

Opcional `input_charset' es como se describe a continuación; siempre se convierte a minúsculas.  Después de que el alias sea normalizado también se utiliza como una búsqueda en el registro de conjuntos de caracteres para averiguar la codificación del encabezado, codificación de cuerpo, y códec de conversión de salida que se usarán para el conjunto de caracteres.  Por ejemplo, si `input_charset' es @code{iso-8859-1}, los encabezados y cuerpos se codificarán mediante quoted-printable y no es necesario ningún códec de conversión de salida.  Si `input_charset' es @code{euc-jp}, los encabezados se codificarán con base64, los cuerpos no se codificarán, pero el texto de salida se convertirá del conjunto de caracteres @code{euc-jp} al conjunto de caracteres @code{iso-2022-jp}.

Las instancias @ref{e7f,,Charset} tienen los siguientes atributos de datos:

@geindex input_charset (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset input_charset}@anchor{357f}
@deffn {Atributo} input_charset

El conjunto de caracteres inicial especificado. Los alias comunes se convierten a sus nombres de correo electrónico `Official' (por ejemplo, @code{latin_1} se convierte a @code{iso-8859-1}). El valor predeterminado es @code{us-ascii} de 7 bits.
@end deffn

@geindex header_encoding (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset header_encoding}@anchor{3580}
@deffn {Atributo} header_encoding

If the character set must be encoded before it can be used in an email
header, this attribute will be set to @code{charset.QP} (for
quoted-printable), @code{charset.BASE64} (for base64 encoding), or
@code{charset.SHORTEST} for the shortest of QP or BASE64 encoding. Otherwise,
it will be @code{None}.
@end deffn

@geindex body_encoding (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset body_encoding}@anchor{3581}
@deffn {Atributo} body_encoding

Same as `header_encoding', but describes the encoding for the mail
message’s body, which indeed may be different than the header encoding.
@code{charset.SHORTEST} is not allowed for `body_encoding'.
@end deffn

@geindex output_charset (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset output_charset}@anchor{3582}
@deffn {Atributo} output_charset

Algunos conjuntos de caracteres deben ser convertidos antes de poder ser usados en cabeceras o cuerpos de correos. Si el `input_charset' es uno de ellos, este atributo contendrá el nombre del conjunto de caracteres al que será convertido. De lo contrario, será @code{None}.
@end deffn

@geindex input_codec (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset input_codec}@anchor{3583}
@deffn {Atributo} input_codec

El nombre del códec de Python usado para convertir el `input_charset' a Unicode. Si no es necesario un códec de conversión, este atributo será @code{None}.
@end deffn

@geindex output_codec (atributo de email.charset.Charset)
@anchor{library/email charset email charset Charset output_codec}@anchor{3584}
@deffn {Atributo} output_codec

El nombre del códec de Python usado para convertir Unicode a `output_charset'. Si no es necesario un códec de conversión, este atributo tendrá el mismo valor que `input_codec'.
@end deffn

Las instancias @ref{e7f,,Charset} además tienen los siguientes métodos:

@geindex get_body_encoding() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset get_body_encoding}@anchor{3585}
@deffn {Método} get_body_encoding ()

Retorna la codificación de transferencia de contenido usada para la codificación del cuerpo.

Esta es la cadena de caracteres @code{quoted-printable} o @code{base64} dependiendo de la codificación usada, o es una función, en cuyo caso se deberá llamar a la función con un solo argumento, el objeto Mensaje a ser codificado. La función deberá luego establecer el encabezado @code{Content-Transfer-Encoding}  en lo que sea apropiado.

Retorna la cadena @code{quoted-printable} si `body_encoding' es @code{QP}, retorna la cadena @code{base64} si `body_encoding' es @code{BASE64}, y retorna la cadena @code{7bit} en caso contrario.
@end deffn

@geindex get_output_charset() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset get_output_charset}@anchor{3586}
@deffn {Método} get_output_charset ()

Return the output character set.

Este es el atributo `output_charset' si no es @code{None}, en caso contrario es `input_charset'.
@end deffn

@geindex header_encode() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset header_encode}@anchor{3587}
@deffn {Método} header_encode (string)

Codifica como encabezado la cadena de caracteres `string'.

El tipo de codificación (base64 o quoted-printable) se basará en el atributo `header_encoding'.
@end deffn

@geindex header_encode_lines() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset header_encode_lines}@anchor{3588}
@deffn {Método} header_encode_lines (string, maxlengths)

Codifica como encabezado `string' convirtiéndolo primero a bytes.

Es similar a  @ref{3587,,header_encode()} excepto que la cadena se ajusta a las longitudes máximas indicadas en el argumento `maxlengths', el cual debe ser un iterador: cada elemento retornado por este iterador proporcionará la siguiente longitud máxima de línea.
@end deffn

@geindex body_encode() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset body_encode}@anchor{3589}
@deffn {Método} body_encode (string)

Codifica como cuerpo la cadena `string'.

El tipo de codificación  (base64 o quoted-printable) se basará en el atributo `body_encoding'.
@end deffn

La clase @ref{e7f,,Charset} también proporciona una serie de métodos para soportar operaciones estándar y funciones integradas.

@geindex __str__() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset __str__}@anchor{358a}
@deffn {Método} __str__ ()

Returns `input_charset' as a string coerced to lower
case. @code{__repr__()} is an alias for @code{__str__()}.
@end deffn

@geindex __eq__() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset __eq__}@anchor{358b}
@deffn {Método} __eq__ (other)

Este método le permite comparar dos instancias @ref{e7f,,Charset} por igualdad.
@end deffn

@geindex __ne__() (método de email.charset.Charset)
@anchor{library/email charset email charset Charset __ne__}@anchor{358c}
@deffn {Método} __ne__ (other)

Este método le permite comparar dos instancias @ref{e7f,,Charset} por desigualdad.
@end deffn
@end deffn

El módulo @ref{3d,,email.charset} provee además las siguientes funciones para agregar nuevas entradas al conjunto global de caracteres, alias y registros de códecs:

@geindex add_charset() (en el módulo email.charset)
@anchor{library/email charset email charset add_charset}@anchor{358d}
@deffn {Función} email.charset.add_charset (charset, header_enc=None, body_enc=None, output_charset=None)

Añade propiedades de carácter al registro global.

`charset' es el conjunto de caracteres de entrada, y debe ser el nombre canónico del conjunto de caracteres.

Optional `header_enc' and `body_enc' is either @code{charset.QP} for
quoted-printable, @code{charset.BASE64} for base64 encoding,
@code{charset.SHORTEST} for the shortest of quoted-printable or base64 encoding,
or @code{None} for no encoding.  @code{SHORTEST} is only valid for
`header_enc'. The default is @code{None} for no encoding.

Opcional `output_charset' es es el conjunto de caracteres en el que debe estar la salida. Las conversiones proceden del conjunto de caracteres de entrada, a Unicode, al conjunto de caracteres de salida cuando se llama al método @code{Charset.convert()}. El valor predeterminado es la salida en el mismo conjunto de caracteres que la entrada.

Tanto `input_charset' y `output_charset' deben tener entradas de códec Unicode en el conjunto de caracteres del módulo para la asignación del códec; use @ref{358e,,add_codec()} para agregar códecs que el módulo no conozca. Consulte la documentación del módulo @ref{1c,,codecs} para más información.

El registro global de conjuntos de caracteres se mantiene en el módulo global diccionario @code{CHARSETS}.
@end deffn

@geindex add_alias() (en el módulo email.charset)
@anchor{library/email charset email charset add_alias}@anchor{358f}
@deffn {Función} email.charset.add_alias (alias, canonical)

Añade un alias al conjunto de caracteres. `alias' es el nombre del alias, p. ej. @code{latin-1}. `canonical' es el nombre canónico del conjunto de caracteres, p. ej. @code{iso-8859-1}.

El registro de alias global de conjuntos de caracteres se mantiene en el módulo global diccionario @code{ALIASES}.
@end deffn

@geindex add_codec() (en el módulo email.charset)
@anchor{library/email charset email charset add_codec}@anchor{358e}
@deffn {Función} email.charset.add_codec (charset, codecname)

Añade un códec que asigna caracteres en el conjunto de caracteres dado hacia y desde Unicode.

`charset' es el nombre canónico de un conjunto de caracteres. `codename' es el nombre de un códec de Python, según corresponda para el segundo argumento del método @ref{237,,str} de  @ref{96c,,encode()}.
@end deffn

@node email encoders Encoders,email utils Miscellaneous utilities,email charset Representing character sets,email — An email and MIME handling package
@anchor{library/email encoders doc}@anchor{3590}@anchor{library/email encoders email-encoders-encoders}@anchor{3591}@anchor{library/email encoders module-email encoders}@anchor{3f}
@subsubsection @code{email.encoders}: Encoders


@geindex module; email.encoders

`Código fuente:' Lib/email/encoders.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/encoders.py}


__________________________________________________________________


Este módulo forma parte de la anterior API de correo electrónico (@code{Compat32}). En la nueva API, la funcionalidad la proporciona el parámetro `cte' del método @ref{18b1,,set_content()}.

Este módulo está obsoleto en Python 3. Las funciones que aparecen aquí no deberían ser llamadas explícitamente ya que la clase @ref{e7e,,MIMEText} establece el tipo de contenido y el encabezado CTE utilizando los valores del `_subtype' y del `_charset' que se pasan cuando se instancia esa clase.

El texto que viene a continuación corresponde a la documentación original del módulo.

Cuando se crean objetos @ref{3d1,,Message} desde 0, a menudo se necesita codificar el contenido del mensaje para transportarlo a través de servidores de correo electrónico adecuados. Esto es así especialmente para el tipo de mensajes @code{image/*} y @code{text/*} que contienen datos binarios.

El paquete @ref{3c,,email} proporciona algunos codificadores adecuados en su módulo @ref{3f,,encoders}. Estos codificadores son en realidad utilizados por los constructores de las clases @ref{3574,,MIMEAudio} y @ref{3513,,MIMEImage} para proporcionar codificadores por defecto. Todas las funciones de codificación tienen exactamente un argumento, el mensaje a codificar. Normalmente extraen el contenido, lo codifican y borran el contenido para introducir el nuevo contenido codificado.  También deberían marcar el encabezado @code{Content-Transfer-Encoding} como apropiado.

Ten en cuenta que estas funciones no sirven para un mensaje con múltiples partes. En lugar de aplicarlo al mensaje completo, las funciones deben aplicarse a cada subparte individual. Si se pasa un mensaje de múltiples partes como argumento se activara un mensaje de error @ref{228,,TypeError}.

A continuación, una lista de las funciones de codificación facilitadas:

@geindex encode_quopri() (en el módulo email.encoders)
@anchor{library/email encoders email encoders encode_quopri}@anchor{3592}
@deffn {Función} email.encoders.encode_quopri (msg)

Codifica el contenido en formularios entrecomillados e imprimibles y marca el encabezado @code{Content-Transfer-Encoding} como @code{quoted-printable} @footnote{
El codificado con @ref{3592,,encode_quopri()} también codifica todas las tabulaciones y caracteres de espacios en los datos.
}. Es un buen codificador para usar cuando la mayoría del contenido son datos imprimibles normales pero hay algún dato que no es imprimible.
@end deffn

@geindex encode_base64() (en el módulo email.encoders)
@anchor{library/email encoders email encoders encode_base64}@anchor{3593}
@deffn {Función} email.encoders.encode_base64 (msg)

Codifica el contenido en un formulario base64 y marca el encabezado  @code{Content-Transfer-Encoding} como @code{base64}. Esta codificación es buena cuando la mayoría del contenido son datos no imprimibles ya que es un formulario más compacto que formularios entrecomillados e imprimibles. La desventaja es que incluye el texto que no es leíble por los humanos.
@end deffn

@geindex encode_7or8bit() (en el módulo email.encoders)
@anchor{library/email encoders email encoders encode_7or8bit}@anchor{3594}
@deffn {Función} email.encoders.encode_7or8bit (msg)

Esto, en realidad, no modifica el contenido del mensaje, pero fija el encabezado @code{Content-Transfer-Encoding} a @code{7bit} u @code{8bit}, lo que considere más adecuado en función del contenido del mensaje.
@end deffn

@geindex encode_noop() (en el módulo email.encoders)
@anchor{library/email encoders email encoders encode_noop}@anchor{3595}
@deffn {Función} email.encoders.encode_noop (msg)

Esto no hace nada; ni siquiera fija el encabezado @code{Content-Transfer-Encoding}.
@end deffn

@subsubheading Notas


@node email utils Miscellaneous utilities,email iterators Iterators,email encoders Encoders,email — An email and MIME handling package
@anchor{library/email utils doc}@anchor{3596}@anchor{library/email utils email-utils-miscellaneous-utilities}@anchor{3597}@anchor{library/email utils module-email utils}@anchor{51}
@subsubsection @code{email.utils}: Miscellaneous utilities


@geindex module; email.utils

`Código fuente:' Lib/email/utils.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/utils.py}


__________________________________________________________________


Existen varias funciones útiles proporcionadas en el módulo @ref{51,,email.utils}:

@geindex localtime() (en el módulo email.utils)
@anchor{library/email utils email utils localtime}@anchor{217}
@deffn {Función} email.utils.localtime (dt=None)

Return local time as an aware datetime object.  If called without
arguments, return current time.  Otherwise `dt' argument should be a
@ref{32f,,datetime} instance, and it is converted to the local time
zone according to the system time zone database.  If `dt' is naive (that
is, @code{dt.tzinfo} is @code{None}), it is assumed to be in local time.


Added in version 3.3.



Deprecated since version 3.12, removed in version 3.14: El parámetro `isdst'.

@end deffn

@geindex make_msgid() (en el módulo email.utils)
@anchor{library/email utils email utils make_msgid}@anchor{3598}
@deffn {Función} email.utils.make_msgid (idstring=None, domain=None)

Retorna una cadena de caracteres apropiada para una cabecera @code{Message-ID}  que cumpla con 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. Si se especifica un `idstring' opcional, es una cadena de caracteres utilizada para reforzar la unicidad del identificador del mensaje. Si se especifica un `domain' opcional provee la porción del msgid después de “@@”. El predeterminado es el hostname local. Normalmente no es necesario especificar este valor, pero puede ser útil en algunos casos, como cuando se está construyendo un sistema distribuido que utiliza un nombre de dominio consistente a lo largo de varios ordenadores.


Distinto en la versión 3.2: Se añadió la palabra clave `domain'.

@end deffn

Las funciones que quedan son parte de la API de correo electrónico heredada (@code{Compat32}) . No hay necesidad de utilizarlas directamente con el nuevo API, dado que el análisis sintáctico y formateo que proporcionan es realizado automáticamente por el mecanismo de análisis sintáctico de la nueva API.

@geindex quote() (en el módulo email.utils)
@anchor{library/email utils email utils quote}@anchor{3599}
@deffn {Función} email.utils.quote (str)

Retorna una nueva cadena de caracteres con barras invertidas (@code{\}) en `str' reemplazado por dos barras invertidas, y comillas dobles reemplazadas por barra invertida seguido de comillas dobles.
@end deffn

@geindex unquote() (en el módulo email.utils)
@anchor{library/email utils email utils unquote}@anchor{34bb}
@deffn {Función} email.utils.unquote (str)

Retorna una nueva cadena de caracteres que es una versión `unquoted' de `str'. Si `str' comienza y termina con comillas dobles, éstas son eliminadas. De igual manera si `str' empieza y termina con comillas angulares (@code{<} y @code{>}), éstas son eliminadas.
@end deffn

@geindex parseaddr() (en el módulo email.utils)
@anchor{library/email utils email utils parseaddr}@anchor{345}
@deffn {Función} email.utils.parseaddr (address, *, strict=True)

Interpreta `address' – la cual debe ser el valor de un campo que contenga un campo tal como @code{To} o @code{Cc} – para separarlo en sus componentes `realname' y `email address'. Retorna una tupla de información, a menos que la interpretación falle, en cuyo caso una 2-tupla de @code{('@w{'},'@w{'})} es retornada.

If `strict' is true, use a strict parser which rejects malformed inputs.


Distinto en la versión 3.13: Add `strict' optional parameter and reject malformed inputs by default.

@end deffn

@geindex formataddr() (en el módulo email.utils)
@anchor{library/email utils email utils formataddr}@anchor{120a}
@deffn {Función} email.utils.formataddr (pair, charset='utf-8')

El inverso de @ref{345,,parseaddr()}, este toma una 2-tupla de la forma @code{(realname,real, email_address)} y retorna una cadena de caracteres válido para una cabecera @code{To} o @code{Cc}. Si el primer elemento de `pair' es falso, entonces el segundo elemento es retornado sin modificación.

El `charset' opcional es el conjunto de caracteres que será usado en la codificación 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} del @code{real_name} si el @code{real_name} contiene caracteres que no sean ASCII. Puede ser una instancia de @ref{237,,str} o @ref{e7f,,Charset}. El valor predeterminado es @code{utf-8}.


Distinto en la versión 3.3: Se añadió la opción `charset'.

@end deffn

@geindex getaddresses() (en el módulo email.utils)
@anchor{library/email utils email utils getaddresses}@anchor{344}
@deffn {Función} email.utils.getaddresses (fieldvalues, *, strict=True)

This method returns a list of 2-tuples of the form returned by @code{parseaddr()}.
`fieldvalues' is a sequence of header field values as might be returned by
@ref{3554,,Message.get_all}.

If `strict' is true, use a strict parser which rejects malformed inputs.

Here’s a simple example that gets all the recipients of a message:

@example
from email.utils import getaddresses

tos = msg.get_all('to', [])
ccs = msg.get_all('cc', [])
resent_tos = msg.get_all('resent-to', [])
resent_ccs = msg.get_all('resent-cc', [])
all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)
@end example


Distinto en la versión 3.13: Add `strict' optional parameter and reject malformed inputs by default.

@end deffn

@geindex parsedate() (en el módulo email.utils)
@anchor{library/email utils email utils parsedate}@anchor{359a}
@deffn {Función} email.utils.parsedate (date)

Intenta interpretar una fecha de acuerdo a las reglas en 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. Sin embargo, algunos clientes de correo no siguen ese formato como está especificado, por lo cual @ref{359a,,parsedate()} intenta adivinar correctamente en esos casos. `date' es una secuencia de caracteres que contiene una fecha 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} como @code{"Mon, 20 Nov 1995 19:12:08 -0500"}. Si tiene éxito en interpretar la fecha, @ref{359a,,parsedate()} retorna una 9-tupla que puede ser pasada directamente a @ref{1255,,time.mktime()}; de lo contrario @code{None} es retornado. Observar que los índices 6,7 y 8 de la tupla resultante no son utilizables.
@end deffn

@geindex parsedate_tz() (en el módulo email.utils)
@anchor{library/email utils email utils parsedate_tz}@anchor{1886}
@deffn {Función} email.utils.parsedate_tz (date)

Realiza la misma función que @ref{359a,,parsedate()}, pero retorna @code{None} o una 10-tupla; los primeros 9 elementos forman una tupla que puede ser pasada directamente a @ref{1255,,time.mktime()}, y el décimo es el desfase de la zona horaria de la fecha con respecto a UTC (que es el término oficial para Greenwich Mean Time) @footnote{
Nótese que el signo del desfase de la zona horaria es opuesto al signo de la variable @code{time.timezone} para la misma zona horaria; este último sigue el estándar POSIX mientras que este módulo sigue 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}.
}. Si la cadena de caracteres de entrada no tiene zona horaria, el último elemento de la tupla retornada es @code{0}, el cual representa UTC. Nótese que los índices 6, 7 y 8 de la tupla resultante no son utilizables.
@end deffn

@geindex parsedate_to_datetime() (en el módulo email.utils)
@anchor{library/email utils email utils parsedate_to_datetime}@anchor{1133}
@deffn {Función} email.utils.parsedate_to_datetime (date)

Lo inverso de @ref{1132,,format_datetime()}. Realiza la misma función que @ref{359a,,parsedate()}, pero en caso de éxito retorna un @ref{32f,,datetime}; de lo contrario, @code{ValueError} se lanza si `date' contiene un valor no válido, como una hora superior a 23 o una diferencia de zona horaria no comprendida entre -24 y 24 horas. Si la fecha de entrada tiene una zona horaria de @code{-0000}, el @code{datetime} será un @code{datetime} ingenuo, y si la fecha se ajusta a las RFC, representará una hora en UTC pero sin indicación de la zona horaria de origen real del mensaje de donde proviene la fecha. . Si la fecha de entrada tiene cualquier otra compensación de zona horaria válida, el @code{datetime} será un @code{datetime} consciente con el correspondiente @ref{1134,,timezone} @ref{67f,,tzinfo}.


Added in version 3.3.

@end deffn

@geindex mktime_tz() (en el módulo email.utils)
@anchor{library/email utils email utils mktime_tz}@anchor{359b}
@deffn {Función} email.utils.mktime_tz (tuple)

Cambia una 10-tupla, como la retornada por @ref{1886,,parsedate_tz()} a una marca de tiempo UTC (segundos desde la Época). Si la zona horaria en la tupla es @code{None}, asume el tiempo local.
@end deffn

@geindex formatdate() (en el módulo email.utils)
@anchor{library/email utils email utils formatdate}@anchor{14a7}
@deffn {Función} email.utils.formatdate (timeval=None, localtime=False, usegmt=False)

Retorna una fecha como una cadena de caracteres de acuerdo a 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}, por ejemplo:

@example
Fri, 09 Nov 2001 01:08:47 -0000
@end example

Optional `timeval' if given is a floating-point time value as accepted by
@ref{122d,,time.gmtime()} and @ref{1539,,time.localtime()}, otherwise the current time is
used.

`localtime' opcional, es una bandera que cuando es @code{True}, interpreta `timeval' y retorna una fecha relativa a la zona horaria local en lugar de UTC, tomando apropiadamente en cuenta el horario de verano. El valor predeterminado es @code{False} con lo cual UTC es utilizado.

`usegmt' opcional, es una bandera que cuando es @code{True} retorna una fecha como cadena de caracteres con la zona horaria como una cadena de caracteres ascii @code{GMT}, en lugar de un numérico @code{-0000}. Esto es necesario para algunos protocolos (como HTTP). Sólo aplica cuando `localtime' es @code{False}. El valor predeterminado es @code{False}.
@end deffn

@geindex format_datetime() (en el módulo email.utils)
@anchor{library/email utils email utils format_datetime}@anchor{1132}
@deffn {Función} email.utils.format_datetime (dt, usegmt=False)

Similar a @code{formatdate}, pero la entrada es una instancia @ref{31,,datetime}. Si es un datetime naíf, se asume ser «UTC sin información sobre la zona horaria de origen», y el @code{-0000} convencional es usado para la zona horaria. Si es un @code{datetime} consciente entonces el desfase numérico de la zona horaria es utilizado. Si es una zona horaria consciente con un desfase cero, entonces `usegmt' puede ser @code{True}, en cuyo caso la cadena de caracteres @code{GMT} es utilizada en lugar del desfase numérico de zona horaria. Esto provee una manera de generar cabeceras de fecha HTTP conforme estándares.


Added in version 3.3.

@end deffn

@geindex decode_rfc2231() (en el módulo email.utils)
@anchor{library/email utils email utils decode_rfc2231}@anchor{359c}
@deffn {Función} email.utils.decode_rfc2231 (s)

Decodifica la cadena de caracteres `s' de acuerdo a 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.
@end deffn

@geindex encode_rfc2231() (en el módulo email.utils)
@anchor{library/email utils email utils encode_rfc2231}@anchor{359d}
@deffn {Función} email.utils.encode_rfc2231 (s, charset=None, language=None)

Codifica la cadena de caracteres `s' de acuerdo a 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. `charset' y `language' opcionales, si son dados es el conjunto de caracteres y nombre del lenguaje a utilizar. Si ninguno es dado, `s' es retornado sin modificar. Si `charset' es dado pero `language' no, la cadena de caracteres es codificada usando la cadena de  caracteres vacía para `language'.
@end deffn

@geindex collapse_rfc2231_value() (en el módulo email.utils)
@anchor{library/email utils email utils collapse_rfc2231_value}@anchor{3563}
@deffn {Función} email.utils.collapse_rfc2231_value (value, errors='replace', fallback_charset='us-ascii')

Cuando un parámetro de cabecera está codificado en formato 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, @ref{3562,,Message.get_param} puede retornar una 3-tupla conteniendo el conjunto de caracteres, lenguaje y valor. @ref{3563,,collapse_rfc2231_value()} convierte esto en una cadena de caracteres unicode. El parámetro opcional `errors' es pasado al argumento `errors' del método @ref{96c,,encode()} de @ref{237,,str}; de manera predeterminada recae en @code{'replace'}. `fallback_charset' opcional, especifica el conjunto de caracteres a utilizar si el especificado en la cabecera 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} no es conocido por Python; su valor predeterminado es @code{'us-ascii'}.

Por conveniencia, si el `value' pasado a @ref{3563,,collapse_rfc2231_value()} no es una tupla, debería ser una cadena de caracteres y se retorna sin citar.
@end deffn

@geindex decode_params() (en el módulo email.utils)
@anchor{library/email utils email utils decode_params}@anchor{359e}
@deffn {Función} email.utils.decode_params (params)

Decodifica la lista de parámetros de acuerdo a 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. `params' es una secuencia de 2-tuplas conteniendo elementos de la forma @code{(content-type, string-value)}.
@end deffn

@node email iterators Iterators,,email utils Miscellaneous utilities,email — An email and MIME handling package
@anchor{library/email iterators doc}@anchor{359f}@anchor{library/email iterators email-iterators-iterators}@anchor{35a0}@anchor{library/email iterators module-email iterators}@anchor{44}
@subsubsection @code{email.iterators}: Iterators


@geindex module; email.iterators

`Código fuente:' Lib/email/iterators.py@footnote{https://github.com/python/cpython/tree/main/Lib/email/iterators.py}


__________________________________________________________________


Iterar sobre un árbol de objetos mensaje es bastante fácil con el método @ref{356b,,Message.walk}. El módulo @ref{44,,email.iterators} proporciona algunos iteradores útiles de más alto nivel sobre árboles de objetos mensaje.

@geindex body_line_iterator() (en el módulo email.iterators)
@anchor{library/email iterators email iterators body_line_iterator}@anchor{35a1}
@deffn {Función} email.iterators.body_line_iterator (msg, decode=False)

Itera sobre todas las cargas útiles de todas las subpartes de `msg', retornando las cargas útiles en cadenas de caracteres línea por línea. Descarta todas las cabeceras de las subpartes, y descarta cualquier subparte con una carga útil que no sea una cadena de caracteres de Python. Esto de alguna forma es equivalente a leer la representación en texto plano del mensaje desde un fichero usando @ref{1cc4,,readline()}, descartando todas las cabeceras intermedias.

El argumento opcional `decode' se pasa a través de @ref{123a,,Message.get_payload}.
@end deffn

@geindex typed_subpart_iterator() (en el módulo email.iterators)
@anchor{library/email iterators email iterators typed_subpart_iterator}@anchor{35a2}
@deffn {Función} email.iterators.typed_subpart_iterator (msg, maintype='text', subtype=None)

Itera sobre todas las subpartes de `msg', retornando solo las subpartes que coincidan el tipo MIME especificado por `maintype' y `subtype'.

Note que `subtype' es opcional; si se omite, entonces se comprobará si el tipo MIME de las subpartes coincide con el tipo principal solamente. `maintype' es opcional también; su valor por defecto es @code{text}.

Por tanto, por defecto @ref{35a2,,typed_subpart_iterator()} retorna cada parte que tenga un tipo MIME @code{text/*}.
@end deffn

La siguiente función se ha añadido como una útil herramienta de depuración. `No' debe ser considerada parte de la interfaz pública soportada para este paquete.

@geindex _structure() (en el módulo email.iterators)
@anchor{library/email iterators email iterators _structure}@anchor{35a3}
@deffn {Función} email.iterators._structure (msg, fp=None, level=0, include_default=False)

Imprime una representación con sangrías de los tipos del contenido de la estructura de objetos mensaje. Por ejemplo:

@c import email
@c from email.iterators import _structure
@c somefile = open('../Lib/test/test_email/data/msg_02.txt')

@example
>>> msg = email.message_from_file(somefile)
>>> _structure(msg)
multipart/mixed
    text/plain
    text/plain
    multipart/digest
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
    text/plain
@end example

@c somefile.close()

El argumento opcional `fp' es un objeto similar a un fichero en el que imprimir la salida. Debe ser adecuado para la función de Python @ref{ff4,,print()}. Se usa `level' internamente. `include_default', si tiene su valor a verdadero, imprime el tipo por defecto también.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{ca,,smtplib}

Cliente SMTP (Protocolo simple de transporte de correo)

@item Módulo @ref{ac,,poplib}

Cliente POP (Protocolo de oficina postal)

@item Módulo @ref{74,,imaplib}

Cliente IMAP (Protocolo de acceso a mensajes de Internet)

@item Módulo @ref{8b,,mailbox}

Herramientas para crear, leer y administrar colecciones de mensajes en disco utilizando una variedad de formatos estándar.
@end table


@node json — JSON encoder and decoder,mailbox — Manipulate mailboxes in various formats,email — An email and MIME handling package,Manejo de datos de internet
@anchor{library/json doc}@anchor{35a4}@anchor{library/json json-json-encoder-and-decoder}@anchor{35a5}@anchor{library/json module-json}@anchor{82}
@subsection @code{json} — JSON encoder and decoder


@geindex module; json

`Código fuente:' Lib/json/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/json/__init__.py}


__________________________________________________________________


JSON (JavaScript Object Notation)@footnote{https://json.org}, specified by
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} (which obsoletes 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html}) and by
ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/},
is a lightweight data interchange format inspired by
JavaScript@footnote{https://en.wikipedia.org/wiki/JavaScript} object literal syntax
(although it is not a strict subset of JavaScript @footnote{
Como se indica en @uref{https://www.rfc-editor.org/errata_search.php?rfc-7159,la errata para RFC 7159}, JSON permite caracteres literales U+2028 (SEPARADOR DE LINEA) y U+2029 (SEPARADOR DE PÁRRAFO) en cadenas, mientras que JavaScript (a partir de ECMAScript Edición 5.1) no lo hace.
} ).

@cartouche
@quotation Advertencia 
Se debe tener cuidado al analizar datos JSON de fuentes que no son de confianza. Una cadena JSON maliciosa puede hacer que el decodificador consuma considerables recursos del CPU y la memoria. Se recomienda limitar el tamaño de los datos que se van a analizar.
@end quotation
@end cartouche

@ref{82,,json} expone una API familiar a los usuarios de los módulos de la biblioteca estándar @ref{8d,,marshal} y @ref{a6,,pickle}.

Codificación de jerarquías básicas de objetos de Python:

@example
>>> import json
>>> json.dumps(['foo', @{'bar': ('baz', None, 1.0, 2)@}])
'["foo", @{"bar": ["baz", null, 1.0, 2]@}]'
>>> print(json.dumps("\"foo\bar"))
"\"foo\bar"
>>> print(json.dumps('\u1234'))
"\u1234"
>>> print(json.dumps('\\'))
"\\"
>>> print(json.dumps(@{"c": 0, "b": 0, "a": 0@}, sort_keys=True))
@{"a": 0, "b": 0, "c": 0@}
>>> from io import StringIO
>>> io = StringIO()
>>> json.dump(['streaming API'], io)
>>> io.getvalue()
'["streaming API"]'
@end example

Codificación compacta:

@example
>>> import json
>>> json.dumps([1, 2, 3, @{'4': 5, '6': 7@}], separators=(',', ':'))
'[1,2,3,@{"4":5,"6":7@}]'
@end example

Impresión linda:

@example
>>> import json
>>> print(json.dumps(@{'6': 7, '4': 5@}, sort_keys=True, indent=4))
@{
    "4": 5,
    "6": 7
@}
@end example

Specializing JSON object encoding:

@example
>>> import json
>>> def custom_json(obj):
...     if isinstance(obj, complex):
...         return @{'__complex__': True, 'real': obj.real, 'imag': obj.imag@}
...     raise TypeError(f'Cannot serialize object of @{type(obj)@}')
...
>>> json.dumps(1 + 2j, default=custom_json)
'@{"__complex__": true, "real": 1.0, "imag": 2.0@}'
@end example

Decodificación JSON:

@example
>>> import json
>>> json.loads('["foo", @{"bar":["baz", null, 1.0, 2]@}]')
['foo', @{'bar': ['baz', None, 1.0, 2]@}]
>>> json.loads('"\\"foo\\bar"')
'"foo\x08ar'
>>> from io import StringIO
>>> io = StringIO('["streaming API"]')
>>> json.load(io)
['streaming API']
@end example

Decodificación personalizada de objetos JSON:

@example
>>> import json
>>> def as_complex(dct):
...     if '__complex__' in dct:
...         return complex(dct['real'], dct['imag'])
...     return dct
...
>>> json.loads('@{"__complex__": true, "real": 1, "imag": 2@}',
...     object_hook=as_complex)
(1+2j)
>>> import decimal
>>> json.loads('1.1', parse_float=decimal.Decimal)
Decimal('1.1')
@end example

Extendiendo @ref{dcd,,JSONEncoder}:

@example
>>> import json
>>> class ComplexEncoder(json.JSONEncoder):
...     def default(self, obj):
...         if isinstance(obj, complex):
...             return [obj.real, obj.imag]
...         # Let the base class default method raise the TypeError
...         return super().default(obj)
...
>>> json.dumps(2 + 1j, cls=ComplexEncoder)
'[2.0, 1.0]'
>>> ComplexEncoder().encode(2 + 1j)
'[2.0, 1.0]'
>>> list(ComplexEncoder().iterencode(2 + 1j))
['[2.0', ', 1.0', ']']
@end example

Using @ref{82,,json} from the shell to validate and pretty-print:

@example
$ echo '@{"json":"obj"@}' | python -m json
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example

Consulte @ref{188,,Command-line interface} para obtener documentación detallada.

@cartouche
@quotation Nota 
JSON es un subconjunto de YAML@footnote{http://yaml.org/} 1.2. El JSON producido por la configuración predeterminada de este módulo (en particular, el valor predeterminado `separators') también es un subconjunto de YAML 1.0 y 1.1. Por lo tanto, este módulo también se puede utilizar como un serializador YAML.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Los codificadores y decodificadores de este módulo conservan el orden de entrada y salida de forma predeterminada. El orden solo se pierde si los contenedores subyacentes no están ordenados.
@end quotation
@end cartouche

@menu
* Uso básico: Uso básico<2>. 
* Codificadores y Decodificadores:: 
* Excepciones: Excepciones<15>. 
* Cumplimiento e interoperabilidad estándar:: 
* Command-line interface: Command-line interface<2>. 

@end menu

@node Uso básico<2>,Codificadores y Decodificadores,,json — JSON encoder and decoder
@anchor{library/json basic-usage}@anchor{35a6}
@subsubsection Uso básico


@geindex dump() (en el módulo json)
@anchor{library/json json dump}@anchor{dcb}
@deffn {Función} json.dump (obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

Serializa `obj' como una secuencia con formato JSON a `fp' (una invocación  @code{.write()}- que soporta @ref{2586,,file-like object}) usando esto @ref{35a7,,conversion table}.

Si `skipkeys' es verdadero (predeterminado: @code{False}), entonces las llaves del dict que no son de un tipo básico (@ref{237,,str}, @ref{1f0,,int}, @ref{153,,float}, @ref{513,,bool}, @code{None}) se omitirán en lugar de generar un @ref{228,,TypeError}.

El módulo @ref{82,,json} siempre produce objetos @ref{237,,str}, no objetos @ref{325,,bytes}. Por lo tanto, @code{fp.write()} debe admitir @ref{237,,str} como entrada.

Si `ensure_ascii' es verdadero (el valor predeterminado), se garantiza que la salida tendrá todos los caracteres entrantes no ASCII escapados. Si `ensure_ascii' es falso, estos caracteres se mostrarán tal cual.

Si `check_circular' es falso (predeterminado: @code{True}), se omitirá la verificación de referencia circular para los tipos de contenedor y una referencia circular dará como resultado @ref{df1,,RecursionError} (o algo peor).

Si `allow_nan' es falso (predeterminado: @code{True}), entonces serializar los valores fuera de rango @ref{153,,float} (@code{nan}, @code{inf}, @code{-inf}) provocará un @ref{360,,ValueError} en estricto cumplimiento de la especificación JSON. Si `allow_nan' es verdadero, se utilizarán sus equivalentes de JavaScript (@code{NaN}, @code{Infinity}, @code{-Infinity}).

Si `indent' es un entero no negativo o una cadena, los elementos del arreglo JSON y los miembros del objeto se imprimirán con ese nivel de sangría. Un nivel de sangría de 0, negativo o @code{""} solo insertará nuevas líneas. @code{None} (el valor predeterminado) selecciona la representación más compacta. El uso de una sangría de entero positivo agrega sangrías de muchos espacios por nivel. Si `indent' es una cadena (como @code{"\t"}), esa cadena se usa para agregarle sangría a cada nivel.


Distinto en la versión 3.2: Permite cadenas  de caracteres para `indent' además de enteros.


Si se especifica, `separators' debe ser una tupla @code{(separador_elemento, separador_llave)}. El valor predeterminado es @code{(', ', ': ')} si `indent' es @code{None} y @code{(', ', ': ')} de lo contrario. Para obtener la representación JSON más compacta, debe especificar @code{(', ', ': ')} para eliminar espacios en blanco.


Distinto en la versión 3.4: Usa @code{(',', ': ')} como predeterminado si `indent' no es @code{None}.


Si se especifica, `default' debería ser una función que se llama para objetos que de otro modo no se pueden serializar. Debería retornar una versión codificable JSON del objeto o generar un @ref{228,,TypeError}. Si no se especifica, produce @ref{228,,TypeError}.

Si `sort_keys' es verdadero (predeterminado: @code{False}), la salida de los diccionarios se ordenará por llave.

To use a custom @ref{dcd,,JSONEncoder} subclass (e.g. one that overrides the
@ref{35a8,,default()} method to serialize additional types), specify it with the
`cls' kwarg; otherwise @ref{dcd,,JSONEncoder} is used.


Distinto en la versión 3.6: Todos los parámetros opcionales son ahora @ref{3f4,,palabra-clave-solamente}.


@cartouche
@quotation Nota 
A diferencia de @ref{a6,,pickle} y @ref{8d,,marshal}, JSON no es un protocolo enmarcado, por lo que intentar serializar varios objetos con llamadas repetidas a @ref{dcb,,dump()} utilizando el mismo `fp' dará como resultado un archivo JSON no válido.
@end quotation
@end cartouche
@end deffn

@geindex dumps() (en el módulo json)
@anchor{library/json json dumps}@anchor{dcc}
@deffn {Función} json.dumps (obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

Serializa `obj' en un @ref{237,,str} con formato JSON usando esta @ref{35a7,,conversion table}.  Los argumentos tienen el mismo significado que en @ref{dcb,,dump()}.

@cartouche
@quotation Nota 
Las llaves de los pares llave/valor de JSON siempre son del tipo @ref{237,,str}. Cuando un diccionario se convierte en JSON, todas las llaves del diccionario se convierten en cadenas. Como resultado de esto, si un diccionario se convierte en JSON y, a continuación, se convierte nuevamente en un diccionario, el diccionario puede que no sea igual al original. Es decir, @code{loads(dumps(x)) != x} si x tiene llaves que no son de tipo cadena de caracteres.
@end quotation
@end cartouche
@end deffn

@geindex load() (en el módulo json)
@anchor{library/json json load}@anchor{d3d}
@deffn {Función} json.load (fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

Deserializa `fp' (un @ref{1c8d,,text file} o @ref{1c8e,,binary file} que soporte @code{.read()} y que contiene un documento JSON) a un objeto Python usando esta @ref{35a9,,conversion table}.

`object_hook' es una función opcional a la que se llamará con el resultado de cualquier literal de objeto decodificado (un @ref{190,,dict}).  El valor de retorno de `object_hook' se utilizará en lugar de @ref{190,,dict}. Esta característica se puede utilizar para implementar decodificadores personalizados (por ejemplo, la sugerencia de clase JSON-RPC@footnote{http://www.jsonrpc.org}).

`object_pairs_hook' is an optional function that will be called with the
result of any object literal decoded with an ordered list of pairs.  The
return value of `object_pairs_hook' will be used instead of the
@ref{190,,dict}.  This feature can be used to implement custom decoders.  If
`object_hook' is also defined, the `object_pairs_hook' takes priority.


Distinto en la versión 3.1: Soporte agregado para `object_pairs_hook'.


`parse_float' is an optional function that will be called with the string of
every JSON float to be decoded.  By default, this is equivalent to
@code{float(num_str)}.  This can be used to use another datatype or parser for
JSON floats (e.g. @ref{16a,,decimal.Decimal}).

`parse_int' is an optional function that will be called with the string of
every JSON int to be decoded.  By default, this is equivalent to
@code{int(num_str)}.  This can be used to use another datatype or parser for
JSON integers (e.g. @ref{153,,float}).


Distinto en la versión 3.11: El `parse_int' predeterminado de @ref{1f0,,int()} ahora limita la longitud máxima de la cadena de enteros a través de la @ref{695,,integer string conversion length limitation} del intérprete para ayudar a evitar ataques de denegación de servicio.


`parse_constant' is an optional function that will be called with one of the
following strings: @code{'-Infinity'}, @code{'Infinity'}, @code{'NaN'}.  This can be
used to raise an exception if invalid JSON numbers are encountered.


Distinto en la versión 3.1: `parse_constant' ya no es llamado en “null”, “true”, “false”.


Para utilizar una subclase personalizada de @ref{dce,,JSONDecoder}, especificarlo con el argumento por llave @code{cls}; de lo contrario, se utilizará @ref{dce,,JSONDecoder}.  Se pasarán argumentos adicionales de palabra llave al constructor de la clase.

Si los datos que se deserializan no constituyen un documento JSON válido, se lanzará un @ref{ea5,,JSONDecodeError}.


Distinto en la versión 3.6: Todos los parámetros opcionales son ahora @ref{3f4,,palabra-clave-solamente}.



Distinto en la versión 3.6: `fp' ahora puede ser un @ref{1c8e,,binary file}. La codificación de entrada debe ser UTF-8, UTF-16 o UTF-32.

@end deffn

@geindex loads() (en el módulo json)
@anchor{library/json json loads}@anchor{9e8}
@deffn {Función} json.loads (s, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

Deserializa `s' (una instancia @ref{237,,str}, @ref{325,,bytes} o @ref{5e0,,bytearray} que contiene un documento JSON) en un objeto Python mediante esta @ref{35a9,,conversion table}.

Los otros argumentos tienen el mismo significado que en @ref{d3d,,load()}.

Si los datos que se deserializan no constituyen un documento JSON válido, se lanzará un @ref{ea5,,JSONDecodeError}.


Distinto en la versión 3.6: `s' ahora puede ser de tipo @ref{325,,bytes} o @ref{5e0,,bytearray}. La codificación de entrada debe ser UTF-8, UTF-16 o UTF-32.



Distinto en la versión 3.9: El argumento de palabra llave `encoding' ha sido removido.

@end deffn

@node Codificadores y Decodificadores,Excepciones<15>,Uso básico<2>,json — JSON encoder and decoder
@anchor{library/json encoders-and-decoders}@anchor{35aa}
@subsubsection Codificadores y Decodificadores


@geindex JSONDecoder (clase en json)
@anchor{library/json json JSONDecoder}@anchor{dce}
@deffn {Clase} json.JSONDecoder (*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)

Decodificador JSON simple.

Realiza las siguientes traducciones en la decodificación de forma predeterminada:
@anchor{library/json json-to-py-table}@anchor{35a9}

@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

JSON

@tab

Python

@item

object

@tab

dict

@item

array

@tab

list

@item

string

@tab

str

@item

número (int)

@tab

int

@item

número (real)

@tab

float

@item

true

@tab

True

@item

false

@tab

False

@item

null

@tab

None

@end multitable


También entiende @code{NaN}, @code{Infinity} y @code{-Infinity} como sus correspondientes valores @code{float}, que está fuera de la especificación JSON.

`object_hook' is an optional function that will be called with the result of
every JSON object decoded and its return value will be used in place of the
given @ref{190,,dict}.  This can be used to provide custom deserializations
(e.g. to support JSON-RPC@footnote{https://www.jsonrpc.org} class hinting).

`object_pairs_hook' is an optional function that will be called with the
result of every JSON object decoded with an ordered list of pairs.  The
return value of `object_pairs_hook' will be used instead of the
@ref{190,,dict}.  This feature can be used to implement custom decoders.  If
`object_hook' is also defined, the `object_pairs_hook' takes priority.


Distinto en la versión 3.1: Soporte agregado para `object_pairs_hook'.


`parse_float' is an optional function that will be called with the string of
every JSON float to be decoded.  By default, this is equivalent to
@code{float(num_str)}.  This can be used to use another datatype or parser for
JSON floats (e.g. @ref{16a,,decimal.Decimal}).

`parse_int' is an optional function that will be called with the string of
every JSON int to be decoded.  By default, this is equivalent to
@code{int(num_str)}.  This can be used to use another datatype or parser for
JSON integers (e.g. @ref{153,,float}).

`parse_constant' is an optional function that will be called with one of the
following strings: @code{'-Infinity'}, @code{'Infinity'}, @code{'NaN'}.  This can be
used to raise an exception if invalid JSON numbers are encountered.

Si `strict' es falso (“”True”” es el valor predeterminado), se permitirán caracteres de control dentro de cadenas.  Los caracteres de control en este contexto son aquellos con códigos de caracteres en el rango 0–31, incluyendo @code{'\t'} (tab), @code{'\n'}, @code{'\r'} and @code{'\0'}.

Si los datos que se deserializan no constituyen un documento JSON válido, se lanzará un @ref{ea5,,JSONDecodeError}.


Distinto en la versión 3.6: Todos los parámetros son ahora @ref{3f4,,palabra-clave-solamente}.


@geindex decode() (método de json.JSONDecoder)
@anchor{library/json json JSONDecoder decode}@anchor{35ab}
@deffn {Método} decode (s)

Retorna la representación Python de `s' (una instancia @ref{237,,str} que contiene un documento JSON).

@ref{ea5,,JSONDecodeError} se producirá si el documento JSON entregado es invalido.
@end deffn

@geindex raw_decode() (método de json.JSONDecoder)
@anchor{library/json json JSONDecoder raw_decode}@anchor{35ac}
@deffn {Método} raw_decode (s)

Decodifica un documento JSON de `s' (un @ref{237,,str} comenzando con un documento JSON) y retorna una tupla de 2 de la representación Python y el índice en `s' donde terminó el documento.

Esto se puede usar para decodificar un documento JSON de una cadena de caracteres que puede tener datos extraños al final.
@end deffn
@end deffn

@geindex JSONEncoder (clase en json)
@anchor{library/json json JSONEncoder}@anchor{dcd}
@deffn {Clase} json.JSONEncoder (*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Codificador JSON extensible para estructuras de datos de Python.

Admite los siguientes objetos y tipos de forma predeterminada:
@anchor{library/json py-to-json-table}@anchor{35a7}

@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Python

@tab

JSON

@item

dict

@tab

object

@item

list, tuple

@tab

array

@item

str

@tab

string

@item

int, float, Enums derivadas de int o float

@tab

number

@item

True

@tab

true

@item

False

@tab

false

@item

None

@tab

null

@end multitable



Distinto en la versión 3.4: Compatibilidad añadida con las clases Enum derivadas de int y float.


To extend this to recognize other objects, subclass and implement a
@ref{35a8,,default()} method with another method that returns a serializable object
for @code{o} if possible, otherwise it should call the superclass implementation
(to raise @ref{228,,TypeError}).

Si `skipkeys' es falso (lo es por defecto), un @ref{228,,TypeError} será lanzado cuando se trate de codificar llaves que no sean @ref{237,,str}, @ref{1f0,,int}, @ref{153,,float} o @code{None}.  Si `skipkeys' es verdadero, tales elementos son simplemente pasados por alto.

Si `ensure_ascii' es verdadero (el valor predeterminado), se garantiza que la salida tendrá todos los caracteres entrantes no ASCII escapados. Si `ensure_ascii' es falso, estos caracteres se mostrarán tal cual.

Si `check_circular' es cierto (valor predeterminado), se comprobarán las listas, los diccionarios y los objetos codificados personalizados en busca de referencias circulares durante la codificación para evitar una recursividad infinita (lo que provocaría un @ref{df1,,RecursionError}). De lo contrario, no se realiza ninguna comprobación de este tipo.

Si `allow_nan' es cierto (valor predeterminado), @code{NaN}, @code{Infinity} y @code{-Infinity} se codificarán como tales.  Este comportamiento no es compatible con las especificaciones JSON, pero es coherente con la mayoría de los codificadores y decodificadores basados en JavaScript.  De lo contrario, codificar dichos puntos flotantes provocará un @ref{360,,ValueError}.

Si `sort_keys' es cierto (predeterminado: @code{False}), la salida de los diccionarios se ordenará por clave; esto es útil para las pruebas de regresión para garantizar que las serializaciones JSON se pueden comparar en el día a día.

Si `indent' es un entero no negativo o una cadena, los elementos del arreglo JSON y los miembros del objeto se imprimirán con ese nivel de sangría. Un nivel de sangría de 0, negativo o @code{""} solo insertará nuevas líneas. @code{None} (el valor predeterminado) selecciona la representación más compacta. El uso de una sangría de entero positivo agrega sangrías de muchos espacios por nivel. Si `indent' es una cadena (como @code{"\t"}), esa cadena se usa para agregarle sangría a cada nivel.


Distinto en la versión 3.2: Permite cadenas  de caracteres para `indent' además de enteros.


Si se especifica, `separators' debe ser una tupla @code{(separador_elemento, separador_llave)}. El valor predeterminado es @code{(', ', ': ')} si `indent' es @code{None} y @code{(', ', ': ')} de lo contrario. Para obtener la representación JSON más compacta, debe especificar @code{(', ', ': ')} para eliminar espacios en blanco.


Distinto en la versión 3.4: Usa @code{(',', ': ')} como predeterminado si `indent' no es @code{None}.


Si se especifica, `default' debería ser una función que se llama para objetos que de otro modo no se pueden serializar. Debería retornar una versión codificable JSON del objeto o generar un @ref{228,,TypeError}. Si no se especifica, produce @ref{228,,TypeError}.


Distinto en la versión 3.6: Todos los parámetros son ahora @ref{3f4,,palabra-clave-solamente}.


@geindex default() (método de json.JSONEncoder)
@anchor{library/json json JSONEncoder default}@anchor{35a8}
@deffn {Método} default (o)

Implemente este método en una subclase de modo que retorne un objeto serializable para `o', o llame a la implementación base (para generar un @ref{228,,TypeError}).

For example, to support arbitrary iterators, you could implement
@ref{35a8,,default()} like this:

@example
def default(self, o):
   try:
       iterable = iter(o)
   except TypeError:
       pass
   else:
       return list(iterable)
   # Let the base class default method raise the TypeError
   return super().default(o)
@end example
@end deffn

@geindex encode() (método de json.JSONEncoder)
@anchor{library/json json JSONEncoder encode}@anchor{35ad}
@deffn {Método} encode (o)

Retorna una representación de cadena de caracteres JSON de una estructura de datos de Python, `o'.  Por ejemplo:

@example
>>> json.JSONEncoder().encode(@{"foo": ["bar", "baz"]@})
'@{"foo": ["bar", "baz"]@}'
@end example
@end deffn

@geindex iterencode() (método de json.JSONEncoder)
@anchor{library/json json JSONEncoder iterencode}@anchor{35ae}
@deffn {Método} iterencode (o)

Codifica el objeto dado, `o', y produce cada representación de cadena como disponible.  Por ejemplo:

@example
for chunk in json.JSONEncoder().iterencode(bigobject):
    mysocket.write(chunk)
@end example
@end deffn
@end deffn

@node Excepciones<15>,Cumplimiento e interoperabilidad estándar,Codificadores y Decodificadores,json — JSON encoder and decoder
@anchor{library/json exceptions}@anchor{35af}
@subsubsection Excepciones


@geindex JSONDecodeError
@anchor{library/json json JSONDecodeError}@anchor{ea5}
@deffn {Excepción} json.JSONDecodeError (msg, doc, pos)

Subclase de @ref{360,,ValueError} con los siguientes atributos adicionales:

@geindex msg (atributo de json.JSONDecodeError)
@anchor{library/json json JSONDecodeError msg}@anchor{35b0}
@deffn {Atributo} msg

El mensaje de error sin formato.
@end deffn

@geindex doc (atributo de json.JSONDecodeError)
@anchor{library/json json JSONDecodeError doc}@anchor{35b1}
@deffn {Atributo} doc

El documento JSON que se está analizando.
@end deffn

@geindex pos (atributo de json.JSONDecodeError)
@anchor{library/json json JSONDecodeError pos}@anchor{35b2}
@deffn {Atributo} pos

El índice de inicio de `doc' donde se produjo un error en el análisis.
@end deffn

@geindex lineno (atributo de json.JSONDecodeError)
@anchor{library/json json JSONDecodeError lineno}@anchor{35b3}
@deffn {Atributo} lineno

La línea correspondiente a `pos'.
@end deffn

@geindex colno (atributo de json.JSONDecodeError)
@anchor{library/json json JSONDecodeError colno}@anchor{35b4}
@deffn {Atributo} colno

La columna correspondiente a `pos'.
@end deffn


Added in version 3.5.

@end deffn

@node Cumplimiento e interoperabilidad estándar,Command-line interface<2>,Excepciones<15>,json — JSON encoder and decoder
@anchor{library/json standard-compliance-and-interoperability}@anchor{35b5}
@subsubsection Cumplimiento e interoperabilidad estándar


The JSON format is specified by 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} and by
ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/}.
This section details this module’s level of compliance with the RFC.
For simplicity, @ref{dcd,,JSONEncoder} and @ref{dce,,JSONDecoder} subclasses, and
parameters other than those explicitly mentioned, are not considered.

Este módulo no cumple con la RFC de forma estricta, implementando algunas extensiones que son válidas  en JavaScript pero no son válidas en JSON.  En particular:


@itemize -

@item 
Se aceptan y se envían valores de números Infinitos y NaN;

@item 
Se aceptan nombres repetidos dentro de un objeto y solo se utiliza el valor del último par nombre-valor.
@end itemize

Puesto que el RFC permite a los analizadores compatibles con RFC aceptar textos de entrada que no son compatibles con RFC, el deserializador de este módulo es técnicamente compatible con RFC bajo la configuración predeterminada.

@menu
* Codificaciones de caracteres:: 
* Valores de número infinito y NaN:: 
* Nombres repetidos dentro de un objeto:: 
* Valores de nivel superior No-Objeto @comma{} No-Arreglo: Valores de nivel superior No-Objeto No-Arreglo. 
* Limitaciones de la implementación:: 

@end menu

@node Codificaciones de caracteres,Valores de número infinito y NaN,,Cumplimiento e interoperabilidad estándar
@anchor{library/json character-encodings}@anchor{35b6}
@subsubsection Codificaciones de caracteres


La RFC requiere que JSON se represente mediante UTF-8, UTF-16 o UTF-32, siendo UTF-8 el valor predeterminado recomendado para la máxima interoperabilidad.

Según lo permitido, aunque no es necesario, por la RFC, el serializador de este módulo establece `ensure_ascii=True' de forma predeterminada, escapando así el dato de salida para que las cadenas resultantes solo contengan caracteres ASCII.

Aparte del parámetro `ensure_ascii', este módulo se define estrictamente en términos de conversión entre objetos Python y @ref{237,,Unicode strings}, y por lo tanto no aborda directamente el problema de las codificaciones de caracteres.

La RFC prohíbe agregar una marca de orden byte (BOM, por sus siglas en inglés) al inicio de un texto JSON y el serializador de este módulo no agrega una BOM a su salida. La RFC permite, pero no requiere, deserializadores JSON para omitir una BOM inicial en su entrada.  El deserializador de este módulo genera un @ref{360,,ValueError} cuando hay una lista de materiales inicial.

La RFC no prohíbe explícitamente las cadenas JSON que contienen secuencias de bytes que no corresponden a caracteres Unicode válidos (por ejemplo, sustitutos UTF-16 no espaciados), pero sí tiene en cuenta que pueden causar problemas de interoperabilidad. De forma predeterminada, este módulo acepta y genera puntos de código (cuando está presente en el original @ref{237,,str}) para dichas secuencias.

@node Valores de número infinito y NaN,Nombres repetidos dentro de un objeto,Codificaciones de caracteres,Cumplimiento e interoperabilidad estándar
@anchor{library/json infinite-and-nan-number-values}@anchor{35b7}
@subsubsection Valores de número infinito y NaN


El RFC no permite la representación de los valores de número infinito o NaN. A pesar de eso, de forma predeterminada, este módulo acepta y genera @code{Infinity}, @code{-Infinity} y @code{NaN} como si fueran valores literales de número JSON válidos:

@example
>>> # Neither of these calls raises an exception, but the results are not valid JSON
>>> json.dumps(float('-inf'))
'-Infinity'
>>> json.dumps(float('nan'))
'NaN'
>>> # Same when deserializing
>>> json.loads('-Infinity')
-inf
>>> json.loads('NaN')
nan
@end example

En el serializador, el parámetro `allow_nan' se puede utilizar para modificar este comportamiento.  En el deserializador, se puede utilizar el parámetro `parse_constant' para modificar este comportamiento.

@node Nombres repetidos dentro de un objeto,Valores de nivel superior No-Objeto No-Arreglo,Valores de número infinito y NaN,Cumplimiento e interoperabilidad estándar
@anchor{library/json repeated-names-within-an-object}@anchor{35b8}
@subsubsection Nombres repetidos dentro de un objeto


La RFC especifica que los nombres dentro de un objeto JSON deben ser únicos, pero no exige cómo se deben controlar los nombres repetidos en los objetos JSON.  De forma predeterminada, este módulo no genera una excepción; en su lugar, ignora todo excepto el último par nombre-valor para un nombre dado:

@example
>>> weird_json = '@{"x": 1, "x": 2, "x": 3@}'
>>> json.loads(weird_json)
@{'x': 3@}
@end example

El parámetro `object_pairs_hook' se puede utilizar para alterar este comportamiento.

@node Valores de nivel superior No-Objeto No-Arreglo,Limitaciones de la implementación,Nombres repetidos dentro de un objeto,Cumplimiento e interoperabilidad estándar
@anchor{library/json top-level-non-object-non-array-values}@anchor{35b9}
@subsubsection Valores de nivel superior No-Objeto , No-Arreglo


La versión anterior de JSON especificada por el obsoleto 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html} requería que el valor de nivel superior de un texto JSON fuera un objeto JSON o un arreglo (Python @ref{190,,dict} o @ref{18e,,list}), y no podía ser un valor JSON nulo, booleano, numérico o de cadena.  
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} eliminó esa restricción, y este módulo no ha implementado ni ha implementado nunca esa restricción en su serializador o en su deserializador.

Independientemente, para lograr la máxima interoperabilidad, es posible que usted desee adherirse voluntariamente a la restricción.

@node Limitaciones de la implementación,,Valores de nivel superior No-Objeto No-Arreglo,Cumplimiento e interoperabilidad estándar
@anchor{library/json implementation-limitations}@anchor{35ba}
@subsubsection Limitaciones de la implementación


Algunas implementaciones del deserializador JSON pueden establecer límites en:


@itemize *

@item 
el tamaño de los textos JSON aceptados

@item 
el nivel máximo de anidamiento de objetos y arreglos JSON

@item 
el rango y precisión de los números JSON

@item 
el contenido y la longitud máxima de las cadenas de caracteres JSON
@end itemize

Este módulo no impone tales límites más allá de los propios tipos de datos de Python relevantes o del propio intérprete de Python.

Al serializar en JSON, tenga en cuenta las limitaciones en las aplicaciones que pueden consumir su JSON.  En particular, es común que los números JSON se deserialicen en números de doble precisión IEEE 754 y, por lo tanto, estén sujetos al rango y las limitaciones de precisión de esa representación.  Esto es especialmente relevante cuando se serializan valores de Python @ref{1f0,,int} de magnitud extremadamente grande, o cuando se serializan instancias de tipos numéricos «exóticos» como @code{decimal. Decimal}.

@node Command-line interface<2>,,Cumplimiento e interoperabilidad estándar,json — JSON encoder and decoder
@anchor{library/json command-line-interface}@anchor{35bb}@anchor{library/json json-commandline}@anchor{188}@anchor{library/json module-json tool}@anchor{83}
@subsubsection Command-line interface


@geindex module; json.tool

`Código fuente:' Lib/json/tool.py@footnote{https://github.com/python/cpython/tree/main/Lib/json/tool.py}


__________________________________________________________________


The @ref{82,,json} module can be invoked as a script via @code{python -m json}
to validate and pretty-print JSON objects. The @ref{83,,json.tool} submodule
implements this interface.

If the optional @code{infile} and @code{outfile} arguments are not
specified, @ref{5df,,sys.stdin} and @ref{b61,,sys.stdout} will be used respectively:

@example
$ echo '@{"json": "obj"@}' | python -m json
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example


Distinto en la versión 3.5: La salida está ahora en el mismo orden que la entrada. Utilice la opción @ref{35bc,,--sort-keys} para ordenar la salida de los diccionarios alfabéticamente por llave.



Distinto en la versión 3.14: The @ref{82,,json} module may now be directly executed as
@code{python -m json}. For backwards compatibility, invoking
the CLI as @code{python -m json.tool} remains supported.


@menu
* Command-line options:: 

@end menu

@node Command-line options,,,Command-line interface<2>
@anchor{library/json command-line-options}@anchor{35bd}
@subsubsection Command-line options


@geindex opción de línea de comando json; infile
@anchor{library/json cmdoption-json-arg-infile}@anchor{35be}
@deffn {Option} infile

El archivo JSON que se va a validar o imprimir con impresión linda:

@example
$ python -m json mp_films.json
[
    @{
        "title": "And Now for Something Completely Different",
        "year": 1971
    @},
    @{
        "title": "Monty Python and the Holy Grail",
        "year": 1975
    @}
]
@end example

If `infile' is not specified, read from @ref{5df,,sys.stdin}.
@end deffn

@geindex opción de línea de comando json; outfile
@anchor{library/json cmdoption-json-arg-outfile}@anchor{35bf}
@deffn {Option} outfile

Write the output of the `infile' to the given `outfile'. Otherwise, write it
to @ref{b61,,sys.stdout}.
@end deffn

@geindex opción de línea de comando json; --sort-keys
@anchor{library/json cmdoption-json-sort-keys}@anchor{35bc}
@deffn {Option} @w{-}@w{-}sort@w{-}keys

Ordena la salida de los diccionarios alfabéticamente por llave.


Added in version 3.5.

@end deffn

@geindex opción de línea de comando json; --no-ensure-ascii
@anchor{library/json cmdoption-json-no-ensure-ascii}@anchor{35c0}
@deffn {Option} @w{-}@w{-}no@w{-}ensure@w{-}ascii

Deshabilita el escape de caracteres que no sean ascii, véase @ref{dcc,,json.dumps()} para más información.


Added in version 3.9.

@end deffn

@geindex opción de línea de comando json; --json-lines
@anchor{library/json cmdoption-json-json-lines}@anchor{35c1}
@deffn {Option} @w{-}@w{-}json@w{-}lines

Analiza cada línea de entrada como objeto JSON independiente.


Added in version 3.8.

@end deffn

@geindex opción de línea de comando json; --indent
@geindex opción de línea de comando json; --tab
@geindex opción de línea de comando json; --no-indent
@geindex opción de línea de comando json; --compact
@anchor{library/json cmdoption-json-indent}@anchor{35c2}@anchor{library/json cmdoption-json-tab}@anchor{35c3}@anchor{library/json cmdoption-json-no-indent}@anchor{35c4}@anchor{library/json cmdoption-json-compact}@anchor{35c5}
@deffn {Option} @w{-}@w{-}indent, @w{-}@w{-}tab, @w{-}@w{-}no@w{-}indent, @w{-}@w{-}compact

Opciones mutuamente exclusivas para control de espacios en blanco.


Added in version 3.9.

@end deffn

@geindex opción de línea de comando json; -h
@geindex opción de línea de comando json; --help
@anchor{library/json cmdoption-json-h}@anchor{35c6}@anchor{library/json cmdoption-json-help}@anchor{35c7}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Muestra el mensaje de ayuda.
@end deffn

@subsubheading Notas de pie de página


@node mailbox — Manipulate mailboxes in various formats,mimetypes — Map filenames to MIME types,json — JSON encoder and decoder,Manejo de datos de internet
@anchor{library/mailbox doc}@anchor{35c8}@anchor{library/mailbox mailbox-manipulate-mailboxes-in-various-formats}@anchor{35c9}@anchor{library/mailbox module-mailbox}@anchor{8b}
@subsection @code{mailbox} — Manipulate mailboxes in various formats


@geindex module; mailbox

`Código fuente:' Lib/mailbox.py@footnote{https://github.com/python/cpython/tree/main/Lib/mailbox.py}


__________________________________________________________________


This module defines two classes, @ref{12ba,,Mailbox} and @ref{12be,,Message}, for
accessing and manipulating on-disk mailboxes and the messages they contain.
@code{Mailbox} offers a dictionary-like mapping from keys to messages.
@code{Message} extends the @ref{45,,email.message} module’s
@ref{3d1,,Message} class with format-specific state and behavior.
Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.


@subsubheading Ver también



@table @asis

@item Módulo @ref{3c,,email}

Representar y manipular mensajes.
@end table


@menu
* Mailbox objects:: 
* Message objects:: 
* Excepciones: Excepciones<16>. 
* Ejemplos: Ejemplos<21>. 

@end menu

@node Mailbox objects,Message objects,,mailbox — Manipulate mailboxes in various formats
@anchor{library/mailbox id1}@anchor{35ca}@anchor{library/mailbox mailbox-objects}@anchor{35cb}
@subsubsection @code{Mailbox} objects


@geindex Mailbox (clase en mailbox)
@anchor{library/mailbox mailbox Mailbox}@anchor{12ba}
@deffn {Clase} mailbox.Mailbox

Un buzón de correo, que se puede inspeccionar y modificar.

The @code{Mailbox} class defines an interface and is not intended to be
instantiated.  Instead, format-specific subclasses should inherit from
@code{Mailbox} and your code should instantiate a particular subclass.

The @code{Mailbox} interface is dictionary-like, with small keys
corresponding to messages. Keys are issued by the @code{Mailbox} instance
with which they will be used and are only meaningful to that @code{Mailbox}
instance. A key continues to identify a message even if the corresponding
message is modified, such as by replacing it with another message.

Messages may be added to a @code{Mailbox} instance using the set-like
method @ref{12b9,,add()} and removed using a @code{del} statement or the set-like
methods @ref{35cc,,remove()} and @ref{35cd,,discard()}.

@code{Mailbox} interface semantics differ from dictionary semantics in some
noteworthy ways. Each time a message is requested, a new representation
(typically a @ref{12be,,Message} instance) is generated based upon the current
state of the mailbox. Similarly, when a message is added to a
@code{Mailbox} instance, the provided message representation’s contents are
copied. In neither case is a reference to the message representation kept by
the @code{Mailbox} instance.

The default @code{Mailbox} @ref{313,,iterator} iterates over message
representations, not keys as the default @ref{190,,dictionary}
iterator does. Moreover, modification of a
mailbox during iteration is safe and well-defined. Messages added to the
mailbox after an iterator is created will not be seen by the
iterator. Messages removed from the mailbox before the iterator yields them
will be silently skipped, though using a key from an iterator may result in a
@ref{438,,KeyError} exception if the corresponding message is subsequently
removed.

@cartouche
@quotation Advertencia 
Be very cautious when modifying mailboxes that might be simultaneously
changed by some other process.  The safest mailbox format to use for such
tasks is @ref{4da,,Maildir}; try to avoid using single-file formats such as
@ref{168a,,mbox} for
concurrent writing.  If you’re modifying a mailbox, you `must' lock it by
calling the @ref{35ce,,lock()} and @ref{35cf,,unlock()} methods `before' reading any
messages in the file or making any changes by adding or deleting a
message.  Failing to lock the mailbox runs the risk of losing messages or
corrupting the entire mailbox.
@end quotation
@end cartouche

@code{Mailbox} instances have the following methods:

@geindex add() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox add}@anchor{12b9}
@deffn {Método} add (message)

Añade `message' al buzón de correo y retorna la clave que se le ha asignado.

El parámetro `message' puede ser una instancia @ref{12be,,Message}, una instancia @ref{3d1,,email.message.Message}, una cadena, una cadena de bytes o un objeto tipo archivo (que debe estar abierto en modo binario). Si `message' es una instancia de la subclase @ref{12be,,Message} con el formato apropiado (por ejemplo, si es una instancia @ref{34a3,,mboxMessage} y ésta es una instancia @ref{168a,,mbox}), se utiliza su información de formato específico. En caso contrario, se utilizan valores por defecto razonables para la información específica del formato.


Distinto en la versión 3.2: Se añadió el soporte para la entrada binaria.

@end deffn

@geindex remove() (método de mailbox.Mailbox)
@geindex __delitem__() (método de mailbox.Mailbox)
@geindex discard() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox remove}@anchor{35cc}
@deffn {Método} remove (key)
@anchor{library/mailbox mailbox Mailbox __delitem__}@anchor{35d0}
@deffnx {Método} __delitem__ (key)
@anchor{library/mailbox mailbox Mailbox discard}@anchor{35cd}
@deffnx {Método} discard (key)

Borre el mensaje correspondiente a la `key' del buzón de correo.

Si no existe tal mensaje, se lanza una excepción @ref{438,,KeyError} si el método se llamó @ref{35cc,,remove()} o @ref{35d0,,__delitem__()} pero no se lanza una excepción si el método se llamó @ref{35cd,,discard()}. El comportamiento de @ref{35cd,,discard()} puede ser preferido si el formato de buzón subyacente soporta la modificación concurrente por otros procesos.
@end deffn

@geindex __setitem__() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __setitem__}@anchor{35d1}
@deffn {Método} __setitem__ (key, message)

Reemplaza el mensaje correspondiente a `key' por `message'. Levante una excepción @ref{438,,KeyError} si ningún mensaje ya corresponde a `key'.

Al igual que @ref{12b9,,add()}, el parámetro `message' puede ser una instancia @ref{12be,,Message}, una instancia @ref{3d1,,email.message.Message}, una cadena, una cadena de bytes, o un objeto tipo archivo (que debe estar abierto en modo binario). Si `message' es una instancia de la subclase @ref{12be,,Message} con el formato apropiado (por ejemplo, si es una instancia @ref{34a3,,mboxMessage} y ésta es una instancia @ref{168a,,mbox}), se utiliza su información de formato específico. En caso contrario, la información específica del formato del mensaje que actualmente corresponde a `key' se deja sin cambios.
@end deffn

@geindex iterkeys() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox iterkeys}@anchor{35d2}
@deffn {Método} iterkeys ()

Return an @ref{313,,iterator} over all keys
@end deffn

@geindex keys() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox keys}@anchor{35d3}
@deffn {Método} keys ()

The same as @ref{35d2,,iterkeys()}, except that a @ref{18e,,list} is returned
rather than an @ref{313,,iterator}
@end deffn

@geindex itervalues() (método de mailbox.Mailbox)
@geindex __iter__() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox itervalues}@anchor{35d4}
@deffn {Método} itervalues ()
@anchor{library/mailbox mailbox Mailbox __iter__}@anchor{35d5}
@deffnx {Método} __iter__ ()

Return an @ref{313,,iterator} over representations of all messages.
The messages are represented
as instances of the appropriate format-specific @ref{12be,,Message} subclass
unless a custom message factory was specified when the @code{Mailbox}
instance was initialized.

@cartouche
@quotation Nota 
El comportamiento de @ref{35d5,,__iter__()} es diferente al de los diccionarios, que iteran sobre las claves.
@end quotation
@end cartouche
@end deffn

@geindex values() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox values}@anchor{35d6}
@deffn {Método} values ()

The same as @ref{35d4,,itervalues()}, except that a @ref{18e,,list} is returned
rather than an @ref{313,,iterator}
@end deffn

@geindex iteritems() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox iteritems}@anchor{35d7}
@deffn {Método} iteritems ()

Return an @ref{313,,iterator} over (`key', `message') pairs, where `key' is
a key and `message' is a message representation. The messages are
represented as instances of the appropriate format-specific
@ref{12be,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex items() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox items}@anchor{35d8}
@deffn {Método} items ()

The same as @ref{35d7,,iteritems()}, except that a @ref{18e,,list} of pairs is
returned rather than an @ref{313,,iterator} of pairs.
@end deffn

@geindex get() (método de mailbox.Mailbox)
@geindex __getitem__() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get}@anchor{35d9}
@deffn {Método} get (key, default=None)
@anchor{library/mailbox mailbox Mailbox __getitem__}@anchor{35da}
@deffnx {Método} __getitem__ (key)

Return a representation of the message corresponding to `key'. If no such
message exists, `default' is returned if the method was called as
@ref{35d9,,get()} and a @ref{438,,KeyError} exception is raised if the method was
called as @code{__getitem__()}. The message is represented as an instance
of the appropriate format-specific @ref{12be,,Message} subclass unless a
custom message factory was specified when the @code{Mailbox} instance
was initialized.
@end deffn

@geindex get_message() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_message}@anchor{35db}
@deffn {Método} get_message (key)

Retorna una representación del mensaje correspondiente a `key' como una instancia de la subclase @ref{12be,,Message} específica del formato, o lanza una excepción @ref{438,,KeyError} si no existe tal mensaje.
@end deffn

@geindex get_bytes() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_bytes}@anchor{12bc}
@deffn {Método} get_bytes (key)

Retorna una representación en bytes del mensaje correspondiente a `key', o lanza una excepción @ref{438,,KeyError} si no existe tal mensaje.


Added in version 3.2.

@end deffn

@geindex get_string() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_string}@anchor{12bd}
@deffn {Método} get_string (key)

Retorna una representación en cadena del mensaje correspondiente a `key', o lanza una excepción @ref{438,,KeyError} si no existe tal mensaje.  El mensaje se procesa a través de @ref{3d1,,email.message.Message} para convertirlo en una representación limpia de 7 bits.
@end deffn

@geindex get_file() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_file}@anchor{12bb}
@deffn {Método} get_file (key)

Return a @ref{2586,,file-like} representation of the
message corresponding to `key',
or raise a @ref{438,,KeyError} exception if no such message exists.  The
file-like object behaves as if open in binary mode.  This file should be
closed once it is no longer needed.


Distinto en la versión 3.2: The file object really is a @ref{1c8e,,binary file}; previously it was
incorrectly returned in text mode.  Also, the @ref{2586,,file-like object}
now supports the @ref{675,,context manager} protocol: you can use a
@ref{673,,with} statement to automatically close it.


@cartouche
@quotation Nota 
Unlike other representations of messages,
@ref{2586,,file-like} representations are not
necessarily independent of the @code{Mailbox} instance that
created them or of the underlying mailbox.  More specific documentation
is provided by each subclass.
@end quotation
@end cartouche
@end deffn

@geindex __contains__() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __contains__}@anchor{35dc}
@deffn {Método} __contains__ (key)

Retorna @code{True} si «key» corresponde a un mensaje, si no @code{False}.
@end deffn

@geindex __len__() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __len__}@anchor{35dd}
@deffn {Método} __len__ ()

Retorna un recuento de los mensajes en el buzón de correo.
@end deffn

@geindex clear() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox clear}@anchor{35de}
@deffn {Método} clear ()

Borrar todos los mensajes del buzón.
@end deffn

@geindex pop() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox pop}@anchor{35df}
@deffn {Método} pop (key, default=None)

Return a representation of the message corresponding to `key' and delete
the message. If no such message exists, return `default'. The message is
represented as an instance of the appropriate format-specific
@ref{12be,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex popitem() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox popitem}@anchor{35e0}
@deffn {Método} popitem ()

Return an arbitrary (`key', `message') pair, where `key' is a key and
`message' is a message representation, and delete the corresponding
message. If the mailbox is empty, raise a @ref{438,,KeyError} exception. The
message is represented as an instance of the appropriate format-specific
@ref{12be,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex update() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox update}@anchor{35e1}
@deffn {Método} update (arg)

Parameter `arg' should be a `key'-to-`message' mapping or an iterable of
(`key', `message') pairs. Updates the mailbox so that, for each given
`key' and `message', the message corresponding to `key' is set to
`message' as if by using @ref{35d1,,__setitem__()}. As with @ref{35d1,,__setitem__()},
each `key' must already correspond to a message in the mailbox or else a
@ref{438,,KeyError} exception will be raised, so in general it is incorrect
for `arg' to be a @code{Mailbox} instance.

@cartouche
@quotation Nota 
A diferencia de los diccionarios, los argumentos de las palabras clave no están soportados.
@end quotation
@end cartouche
@end deffn

@geindex flush() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox flush}@anchor{35e2}
@deffn {Método} flush ()

Write any pending changes to the filesystem. For some @ref{12ba,,Mailbox}
subclasses, changes are always written immediately and @code{flush()} does
nothing, but you should still make a habit of calling this method.
@end deffn

@geindex lock() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox lock}@anchor{35ce}
@deffn {Método} lock ()

Adquiera un aviso exclusivo de bloqueo en el buzón de correo para que otros procesos sepan que no deben modificarlo. Un @ref{35e3,,ExternalClashError} se lanza si el bloqueo no está disponible. Los mecanismos de bloqueo particulares utilizados dependen del formato del buzón de correo.  Deberías `siempre' bloquear el buzón antes de hacer cualquier modificación a su contenido.
@end deffn

@geindex unlock() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox unlock}@anchor{35cf}
@deffn {Método} unlock ()

Libera el bloqueo del buzón de correo, si lo hay.
@end deffn

@geindex close() (método de mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox close}@anchor{35e4}
@deffn {Método} close ()

Flush the mailbox, unlock it if necessary, and close any open files. For
some @code{Mailbox} subclasses, this method does nothing.
@end deffn
@end deffn

@menu
* Maildir objects:: 
* mbox objects:: 
* MH objects:: 
* Babyl objects:: 
* MMDF objects:: 

@end menu

@node Maildir objects,mbox objects,,Mailbox objects
@anchor{library/mailbox mailbox-maildir}@anchor{35e5}@anchor{library/mailbox maildir-objects}@anchor{35e6}
@subsubsection @code{Maildir} objects


@geindex Maildir (clase en mailbox)
@anchor{library/mailbox mailbox Maildir}@anchor{4da}
@deffn {Clase} mailbox.Maildir (dirname, factory=None, create=True)

Una subclase de @ref{12ba,,Mailbox}  para los buzones de correo en formato Maildir. El parámetro `factory' es un objeto invocable que acepta una representación de mensaje tipo archivo (que se comporta como si se abriera en modo binario) y retorna una representación personalizada. Si `factory' es @code{None}, @ref{35e7,,MaildirMessage} se utiliza como representación de mensaje por defecto. Si `create' es @code{True}, el buzón se crea si no existe.

Si `create' es @code{True} y la ruta de `dirname' existe, será tratado como un `maildir' existente sin intentar verificar su diseño de directorio.

Es por razones históricas que `dirname' es nombrado como tal en lugar de `path'.

Maildir es un formato de buzón de correo basado en un directorio inventado para el agente de transferencia de correo qmail y ahora ampliamente soportado por otros programas. Los mensajes en un buzón de correo de Maildir se almacenan en archivos separados dentro de una estructura de directorio común. Este diseño permite que los buzones de Maildir sean accedidos y modificados por múltiples programas no relacionados sin corrupción de datos, por lo que el bloqueo de archivos es innecesario.

Los buzones de correo de Maildir contienen tres subdirectorios, a saber: @code{tmp}, @code{new}, y @code{cur}. Los mensajes se crean momentáneamente en el subdirectorio @code{tmp} y luego se mueven al subdirectorio @code{new} para finalizar la entrega. Un agente de usuario de correo puede posteriormente mover el mensaje al subdirectorio @code{cur} y almacenar la información sobre el estado del mensaje en una sección especial «info» adjunta a su nombre de archivo.

Folders of the style introduced by the Courier mail transfer agent are also
supported. Any subdirectory of the main mailbox is considered a folder if
@code{'.'} is the first character in its name. Folder names are represented by
@code{Maildir} without the leading @code{'.'}. Each folder is itself a Maildir
mailbox but should not contain other folders. Instead, a logical nesting is
indicated using @code{'.'} to delimit levels, e.g., «Archived.2005.07».

@geindex colon (atributo de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir colon}@anchor{35e8}
@deffn {Atributo} colon

La especificación Maildir requiere el uso de dos puntos (@code{':'}) en ciertos nombres de archivos de mensajes. Sin embargo, algunos sistemas operativos no permiten este carácter en los nombres de archivo, si desea utilizar un formato similar a Maildir en dicho sistema operativo, debe especificar otro carácter para utilizarlo en su lugar. El signo de exclamación (@code{'!'}) es una elección popular. Por ejemplo:

@example
import mailbox
mailbox.Maildir.colon = '!'
@end example

The @code{colon} attribute may also be set on a per-instance basis.
@end deffn


Distinto en la versión 3.13: @ref{4da,,Maildir} now ignores files with a leading dot.


@code{Maildir} instances have all of the methods of @ref{12ba,,Mailbox} in
addition to the following:

@geindex list_folders() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir list_folders}@anchor{35e9}
@deffn {Método} list_folders ()

Retorna una lista con los nombres de todas las carpetas.
@end deffn

@geindex get_folder() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_folder}@anchor{35ea}
@deffn {Método} get_folder (folder)

Return a @code{Maildir} instance representing the folder whose name is
`folder'. A @ref{35eb,,NoSuchMailboxError} exception is raised if the folder
does not exist.
@end deffn

@geindex add_folder() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add_folder}@anchor{35ec}
@deffn {Método} add_folder (folder)

Create a folder whose name is `folder' and return a @code{Maildir}
instance representing it.
@end deffn

@geindex remove_folder() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir remove_folder}@anchor{35ed}
@deffn {Método} remove_folder (folder)

Elimina la carpeta cuyo nombre es `folder'. Si la carpeta contiene algún mensaje, se lanzará una excepción @ref{35ee,,NotEmptyError} y la carpeta no se borrará.
@end deffn

@geindex clean() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir clean}@anchor{35ef}
@deffn {Método} clean ()

Borra los archivos temporales del buzón de correo que no han sido accedidos en las últimas 36 horas. La especificación Maildir dice que los programas de lectura de correo deben hacer esto ocasionalmente.
@end deffn

@geindex get_flags() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_flags}@anchor{16da}
@deffn {Método} get_flags (key)

Return as a string the flags that are set on the message
corresponding to `key'.
This is the same as @code{get_message(key).get_flags()} but much
faster, because it does not open the message file.
Use this method when iterating over the keys to determine which
messages are interesting to get.

If you do have a @ref{35e7,,MaildirMessage} object, use
its @ref{35f0,,get_flags()} method instead, because
changes made by the message’s @ref{35f1,,set_flags()},
@ref{35f2,,add_flag()} and @ref{35f3,,remove_flag()}
methods are not reflected here until the mailbox’s
@ref{35f4,,__setitem__()} method is called.


Added in version 3.13.

@end deffn

@geindex set_flags() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir set_flags}@anchor{16db}
@deffn {Método} set_flags (key, flags)

On the message corresponding to `key', set the flags specified
by `flags' and unset all others.
Calling @code{some_mailbox.set_flags(key, flags)} is similar to

@example
one_message = some_mailbox.get_message(key)
one_message.set_flags(flags)
some_mailbox[key] = one_message
@end example

but faster, because it does not open the message file.

If you do have a @ref{35e7,,MaildirMessage} object, use
its @ref{35f1,,set_flags()} method instead, because
changes made with this mailbox method will not be visible to the
message object’s method, @ref{35f0,,get_flags()}.


Added in version 3.13.

@end deffn

@geindex add_flag() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add_flag}@anchor{16dc}
@deffn {Método} add_flag (key, flag)

On the message corresponding to `key', set the flags specified
by `flag' without changing other flags. To add more than one
flag at a time, `flag' may be a string of more than one character.

Considerations for using this method versus the message object’s
@ref{35f2,,add_flag()} method are similar to
those for @ref{16db,,set_flags()}; see the discussion there.


Added in version 3.13.

@end deffn

@geindex remove_flag() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir remove_flag}@anchor{16dd}
@deffn {Método} remove_flag (key, flag)

On the message corresponding to `key', unset the flags specified
by `flag' without changing other flags. To remove more than one
flag at a time, `flag' may be a string of more than one character.

Considerations for using this method versus the message object’s
@ref{35f3,,remove_flag()} method are similar to
those for @ref{16db,,set_flags()}; see the discussion there.


Added in version 3.13.

@end deffn

@geindex get_info() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_info}@anchor{16d8}
@deffn {Método} get_info (key)

Return a string containing the info for the message
corresponding to `key'.
This is the same as @code{get_message(key).get_info()} but much
faster, because it does not open the message file.
Use this method when iterating over the keys to determine which
messages are interesting to get.

If you do have a @ref{35e7,,MaildirMessage} object, use
its @ref{35f5,,get_info()} method instead, because
changes made by the message’s @ref{35f6,,set_info()} method
are not reflected here until the mailbox’s @ref{35f4,,__setitem__()} method
is called.


Added in version 3.13.

@end deffn

@geindex set_info() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir set_info}@anchor{16d9}
@deffn {Método} set_info (key, info)

Set the info of the message corresponding to `key' to `info'.
Calling @code{some_mailbox.set_info(key, flags)} is similar to

@example
one_message = some_mailbox.get_message(key)
one_message.set_info(info)
some_mailbox[key] = one_message
@end example

but faster, because it does not open the message file.

If you do have a @ref{35e7,,MaildirMessage} object, use
its @ref{35f6,,set_info()} method instead, because
changes made with this mailbox method will not be visible to the
message object’s method, @ref{35f5,,get_info()}.


Added in version 3.13.

@end deffn

Some @ref{12ba,,Mailbox} methods implemented by @code{Maildir} deserve special
remarks:

@geindex add() (método de mailbox.Maildir)
@geindex __setitem__() (método de mailbox.Maildir)
@geindex update() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add}@anchor{35f7}
@deffn {Método} add (message)
@anchor{library/mailbox mailbox Maildir __setitem__}@anchor{35f4}
@deffnx {Método} __setitem__ (key, message)
@anchor{library/mailbox mailbox Maildir update}@anchor{35f8}
@deffnx {Método} update (arg)

@cartouche
@quotation Advertencia 
Estos métodos generan nombres de archivo únicos basados en el ID del proceso actual. Cuando se utilizan varios hilos, pueden producirse conflictos de nombres no detectados y causar la corrupción del buzón de correo a menos que se coordinen los hilos para evitar que se utilicen estos métodos para manipular el mismo buzón de correo simultáneamente.
@end quotation
@end cartouche
@end deffn

@geindex flush() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir flush}@anchor{35f9}
@deffn {Método} flush ()

Todos los cambios en los buzones de Maildir se aplican inmediatamente, así que este método no hace nada.
@end deffn

@geindex lock() (método de mailbox.Maildir)
@geindex unlock() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir lock}@anchor{35fa}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox Maildir unlock}@anchor{35fb}
@deffnx {Método} unlock ()

Los buzones de Maildir no admiten (o requieren) bloqueo, por lo que estos métodos no hacen nada.
@end deffn

@geindex close() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir close}@anchor{35fc}
@deffn {Método} close ()

@code{Maildir} instances do not keep any open files and the underlying
mailboxes do not support locking, so this method does nothing.
@end deffn

@geindex get_file() (método de mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_file}@anchor{35fd}
@deffn {Método} get_file (key)

Dependiendo de la plataforma del host, puede que no sea posible modificar o eliminar el mensaje subyacente mientras el archivo retornado permanezca abierto.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item maildir man page from Courier@footnote{https://www.courier-mta.org/maildir.html}

Una especificación del formato. Describe una extensión común para admitir carpetas.

@item Utilizando el formato maildir@footnote{https://cr.yp.to/proto/maildir.html}

Notas sobre Maildir por su inventor. Incluye un esquema actualizado de creación de nombres y detalles sobre la «info» de la semántica».
@end table


@node mbox objects,MH objects,Maildir objects,Mailbox objects
@anchor{library/mailbox mailbox-mbox}@anchor{35fe}@anchor{library/mailbox mbox-objects}@anchor{35ff}
@subsubsection @code{mbox} objects


@geindex mbox (clase en mailbox)
@anchor{library/mailbox mailbox mbox}@anchor{168a}
@deffn {Clase} mailbox.mbox (path, factory=None, create=True)

Una subclase de @ref{12ba,,Mailbox} para los buzones de correo en formato mbox. El parámetro `factory' es un objeto invocable que acepta una representación de mensaje tipo archivo (que se comporta como si se abriera en modo binario) y retorna una representación personalizada. Si `factory' es @code{None}, @ref{34a3,,mboxMessage} se utiliza como representación de mensaje por defecto. Si `create' es @code{True}, el buzón de correo se crea si no existe.

El formato mbox es el formato clásico para almacenar correo en sistemas Unix. Todos los mensajes de un buzón de correo mbox se almacenan en un único archivo con el comienzo de cada mensaje indicado por una línea cuyos cinco primeros caracteres son «From».

Several variations of the mbox format exist to address perceived shortcomings in
the original. In the interest of compatibility, @code{mbox} implements the
original format, which is sometimes referred to as `mboxo'. This means that
the @code{Content-Length} header, if present, is ignored and that any
occurrences of «From « at the beginning of a line in a message body are
transformed to «>From « when storing the message, although occurrences of «>From
« are not transformed to «From « when reading the message.

Some @ref{12ba,,Mailbox} methods implemented by @code{mbox} deserve special
remarks:

@geindex get_file() (método de mailbox.mbox)
@anchor{library/mailbox mailbox mbox get_file}@anchor{3600}
@deffn {Método} get_file (key)

Using the file after calling @ref{35e2,,flush()} or
@ref{35e4,,close()} on the @code{mbox} instance may yield
unpredictable results or raise an exception.
@end deffn

@geindex lock() (método de mailbox.mbox)
@geindex unlock() (método de mailbox.mbox)
@anchor{library/mailbox mailbox mbox lock}@anchor{3601}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox mbox unlock}@anchor{3602}
@deffnx {Método} unlock ()

Three locking mechanisms are used—dot locking and, if available, the
@code{flock()} and @code{lockf()} system calls.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item pagina web mbox de tin@footnote{http://www.tin.org/bin/man.cgi?section=5&topic=mbox}

Una especificación del formato, con detalles sobre el bloqueo.

@item Configurando el correo de Netscape en Unix: Por qué el formato de longitud de contenido es malo@footnote{https://www.jwz.org/doc/content-length.html}

Un argumento para usar el formato original mbox en lugar de una variación.

@item "mbox" es una familia de varios formatos de buzón de correo mutuamente incompatibles@footnote{https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml}

Una historia de variaciones de mbox.
@end table


@node MH objects,Babyl objects,mbox objects,Mailbox objects
@anchor{library/mailbox mailbox-mh}@anchor{3603}@anchor{library/mailbox mh-objects}@anchor{3604}
@subsubsection @code{MH} objects


@geindex MH (clase en mailbox)
@anchor{library/mailbox mailbox MH}@anchor{16be}
@deffn {Clase} mailbox.MH (path, factory=None, create=True)

Una subclase de @ref{12ba,,Mailbox} para los buzones de correo en formato MH. El parámetro `factory' es un objeto invocable que acepta una representación de mensaje tipo archivo (que se comporta como si se abriera en modo binario) y retorna una representación personalizada. Si `factory' es @code{None}, @ref{3605,,MHMessage} se utiliza como representación de mensaje por defecto. Si `create' es @code{True}, el buzón de correo se crea si no existe.

MH es un formato de buzón de correo basado en un directorio inventado para el Sistema de Manejo de Mensajes MH, un agente de usuario de correo. Cada mensaje de un buzón de correo MH reside en su propio archivo. Un buzón de correo MH puede contener otros buzones de correos MH (llamados `folders') además de los mensajes. Las carpetas pueden anidarse indefinidamente. Los buzones de correo MH también soportan `sequences', que son listas con nombre usadas para agrupar lógicamente los mensajes sin moverlos a subcarpetas. Las secuencias se definen en un archivo llamado @code{.mh_sequences} en cada carpeta.

The @code{MH} class manipulates MH mailboxes, but it does not attempt to
emulate all of @code{mh}’s behaviors. In particular, it does not modify
and is not affected by the @code{context} or @code{.mh_profile} files that
are used by @code{mh} to store its state and configuration.

@code{MH} instances have all of the methods of @ref{12ba,,Mailbox} in addition
to the following:


Distinto en la versión 3.13: Supported folders that don’t contain a @code{.mh_sequences} file.


@geindex list_folders() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH list_folders}@anchor{3606}
@deffn {Método} list_folders ()

Retorna una lista con los nombres de todas las carpetas.
@end deffn

@geindex get_folder() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH get_folder}@anchor{3607}
@deffn {Método} get_folder (folder)

Return an @code{MH} instance representing the folder whose name is
`folder'. A @ref{35eb,,NoSuchMailboxError} exception is raised if the folder
does not exist.
@end deffn

@geindex add_folder() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH add_folder}@anchor{3608}
@deffn {Método} add_folder (folder)

Create a folder whose name is `folder' and return an @code{MH} instance
representing it.
@end deffn

@geindex remove_folder() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH remove_folder}@anchor{3609}
@deffn {Método} remove_folder (folder)

Elimina la carpeta cuyo nombre es `folder'. Si la carpeta contiene algún mensaje, se lanzará una excepción @ref{35ee,,NotEmptyError} y la carpeta no se borrará.
@end deffn

@geindex get_sequences() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH get_sequences}@anchor{360a}
@deffn {Método} get_sequences ()

Retorna un diccionario de nombres de secuencias mapeadas a listas clave. Si no hay secuencias, se retorna el diccionario vacío.
@end deffn

@geindex set_sequences() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH set_sequences}@anchor{360b}
@deffn {Método} set_sequences (sequences)

Re-define las secuencias que existen en el buzón de correo basado en `sequences', un diccionario de nombres mapeados a listas de claves, como las retornadas por @ref{360a,,get_sequences()}.
@end deffn

@geindex pack() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH pack}@anchor{360c}
@deffn {Método} pack ()

Renombra los mensajes en el buzón de correo según sea necesario para eliminar los huecos en la numeración.  Las entradas en la lista de secuencias se actualizan correspondientemente.

@cartouche
@quotation Nota 
Las llaves ya emitidas quedan invalidadas por esta operación y no deben utilizarse posteriormente.
@end quotation
@end cartouche
@end deffn

Some @ref{12ba,,Mailbox} methods implemented by @code{MH} deserve special
remarks:

@geindex remove() (método de mailbox.MH)
@geindex __delitem__() (método de mailbox.MH)
@geindex discard() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH remove}@anchor{360d}
@deffn {Método} remove (key)
@anchor{library/mailbox mailbox MH __delitem__}@anchor{360e}
@deffnx {Método} __delitem__ (key)
@anchor{library/mailbox mailbox MH discard}@anchor{360f}
@deffnx {Método} discard (key)

Estos métodos borran inmediatamente el mensaje. No se utiliza la convención del MH de marcar un mensaje para borrarlo poniendo una coma en su nombre.
@end deffn

@geindex lock() (método de mailbox.MH)
@geindex unlock() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH lock}@anchor{3610}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox MH unlock}@anchor{3611}
@deffnx {Método} unlock ()

Three locking mechanisms are used—dot locking and, if available, the
@code{flock()} and @code{lockf()} system calls. For MH mailboxes, locking
the mailbox means locking the @code{.mh_sequences} file and, only for the
duration of any operations that affect them, locking individual message
files.
@end deffn

@geindex get_file() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH get_file}@anchor{3612}
@deffn {Método} get_file (key)

Dependiendo de la plataforma anfitriona, puede que no sea posible eliminar el mensaje subyacente mientras el archivo retornado permanezca abierto.
@end deffn

@geindex flush() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH flush}@anchor{3613}
@deffn {Método} flush ()

Todos los cambios en los buzones de correos de Maildir se aplican inmediatamente, así que este método no hace nada.
@end deffn

@geindex close() (método de mailbox.MH)
@anchor{library/mailbox mailbox MH close}@anchor{3614}
@deffn {Método} close ()

@code{MH} instances do not keep any open files, so this method is
equivalent to @ref{3611,,unlock()}.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item nmh - Message Handling System@footnote{https://www.nongnu.org/nmh/}

Página principal de @code{nmh}, una versión actualizada del original @code{mh}.

@item MH & nmh: Correo electrónico para usuarios y programadores@footnote{https://rand-mh.sourceforge.io/book/}

Un libro con licencia GPL sobre @code{mh} y @code{nmh}, con alguna información sobre el formato del buzón.
@end table


@node Babyl objects,MMDF objects,MH objects,Mailbox objects
@anchor{library/mailbox babyl-objects}@anchor{3615}@anchor{library/mailbox mailbox-babyl}@anchor{3616}
@subsubsection @code{Babyl} objects


@geindex Babyl (clase en mailbox)
@anchor{library/mailbox mailbox Babyl}@anchor{3617}
@deffn {Clase} mailbox.Babyl (path, factory=None, create=True)

Una subclase de @ref{12ba,,Mailbox} para los buzones en formato Babyl. El parámetro `factory' es un objeto invocable que acepta una representación de mensaje tipo archivo (que se comporta como si se abriera en modo binario) y retorna una representación personalizada. Si `factory' es @code{None}, @ref{3618,,BabylMessage} se utiliza como representación de mensaje por defecto. Si `create' es @code{True}, el buzón se crea si no existe.

Babyl es un formato de buzón de un solo archivo usado por el agente de usuario de correo de Rmail incluido en Emacs. El comienzo de un mensaje se indica con una línea que contiene los dos caracteres Control-Underscore (@code{'\037'}) y Control-L (@code{'\014'}). El final de un mensaje se indica con el comienzo del siguiente mensaje o, en el caso del último mensaje, una línea que contiene un carácter Control-Underscore (@code{'\037'}).

Los mensajes en un buzón de correo de Babyl tienen dos juegos de encabezados, los encabezados originales y los llamados encabezados visibles. Los encabezados visibles son típicamente un subconjunto de los encabezados originales que han sido reformateados o abreviados para ser más atractivos. Cada mensaje de un buzón de correo de Babyl también tiene una lista de `labels', o cadenas cortas que registran información adicional sobre el mensaje, y una lista de todas las etiquetas definidas por el usuario que se encuentran en el buzón de correo se mantiene en la sección de opciones de Babyl.

@code{Babyl} instances have all of the methods of @ref{12ba,,Mailbox} in
addition to the following:

@geindex get_labels() (método de mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl get_labels}@anchor{3619}
@deffn {Método} get_labels ()

Retorna una lista de los nombres de todas las etiquetas definidas por el usuario utilizadas en el buzón de correo.

@cartouche
@quotation Nota 
Los mensajes actuales se inspeccionan para determinar qué etiquetas existen en el buzón de correo en lugar de consultar la lista de etiquetas en la sección de opciones de Babyl, pero la sección de Babyl se actualiza cada vez que se modifica el buzón de correo.
@end quotation
@end cartouche
@end deffn

Some @ref{12ba,,Mailbox} methods implemented by @code{Babyl} deserve special
remarks:

@geindex get_file() (método de mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl get_file}@anchor{361a}
@deffn {Método} get_file (key)

En los buzones de correos de Babyl, los encabezados de un mensaje no se almacenan contiguamente al cuerpo del mensaje. Para generar una representación tipo archivo, las cabeceras y el cuerpo se copian juntos en una instancia @ref{f25,,io.BytesIO}, que tiene una API idéntica a la de un archivo. Como resultado, el objeto similar a un archivo es verdaderamente independiente del buzón de correo subyacente, pero no ahorra memoria en comparación con una representación en cadena.
@end deffn

@geindex lock() (método de mailbox.Babyl)
@geindex unlock() (método de mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl lock}@anchor{361b}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox Babyl unlock}@anchor{361c}
@deffnx {Método} unlock ()

Three locking mechanisms are used—dot locking and, if available, the
@code{flock()} and @code{lockf()} system calls.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item Formato de la versión 5 de los archivos de Babyl@footnote{https://quimby.gnus.org/notes/BABYL}

Una especificación del formato Babyl.

@item Leyendo el correo con Rmail@footnote{https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html}

El manual de Rmail, con cierta información sobre la semántica Babyl.
@end table


@node MMDF objects,,Babyl objects,Mailbox objects
@anchor{library/mailbox mailbox-mmdf}@anchor{361d}@anchor{library/mailbox mmdf-objects}@anchor{361e}
@subsubsection @code{MMDF} objects


@geindex MMDF (clase en mailbox)
@anchor{library/mailbox mailbox MMDF}@anchor{168b}
@deffn {Clase} mailbox.MMDF (path, factory=None, create=True)

Una subclase de @ref{12ba,,Mailbox} para buzones de correos en formato MMDF. El parámetro `factory' es un objeto al que se puede llamar que acepta una representación de mensaje similar a un archivo (que se comporta como si se abriera en modo binario) y retorna una representación personalizada. Si `factory' es @code{None}, @ref{361f,,MMDFMessage} se utiliza como representación de mensaje predeterminada. Si `create' es @code{True}, el buzón de correo se crea si no existe.

MMDF es un formato de buzón de correo de un solo archivo inventado para el centro de distribución de memorandos multicanal, un agente de transferencia de correo. Cada mensaje está en la misma forma que un mensaje de mbox, pero está entre corchetes antes y después por líneas que contienen cuatro caracteres Control-A (@code{'\001'}). Al igual que con el formato mbox, el principio de cada mensaje se indica mediante una línea cuyos primeros cinco caracteres son «From «, pero las apariciones adicionales de «From» no se transforman en «>From» al almacenar mensajes porque las líneas de separador de mensajes adicionales impiden confundir tales ocurrencias para los inicios de los mensajes posteriores.

Some @ref{12ba,,Mailbox} methods implemented by @code{MMDF} deserve special
remarks:

@geindex get_file() (método de mailbox.MMDF)
@anchor{library/mailbox mailbox MMDF get_file}@anchor{3620}
@deffn {Método} get_file (key)

Using the file after calling @ref{35e2,,flush()} or
@ref{35e4,,close()} on the @code{MMDF} instance may yield
unpredictable results or raise an exception.
@end deffn

@geindex lock() (método de mailbox.MMDF)
@geindex unlock() (método de mailbox.MMDF)
@anchor{library/mailbox mailbox MMDF lock}@anchor{3621}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox MMDF unlock}@anchor{3622}
@deffnx {Método} unlock ()

Three locking mechanisms are used—dot locking and, if available, the
@code{flock()} and @code{lockf()} system calls.
@end deffn
@end deffn


@subsubheading Ver también



@table @asis

@item Página web de mmdf de tin@footnote{http://www.tin.org/bin/man.cgi?section-5&topic-mmdf}

Una especificación del formato MMDF de la documentación de tin, un lector de noticias.

@item MMDF@footnote{https://en.wikipedia.org/wiki/MMDF}

Un artículo de Wikipedia que describe el Centro de Distribución de Memorandos Multicanal.
@end table


@node Message objects,Excepciones<16>,Mailbox objects,mailbox — Manipulate mailboxes in various formats
@anchor{library/mailbox mailbox-message-objects}@anchor{3623}@anchor{library/mailbox message-objects}@anchor{3624}
@subsubsection @code{Message} objects


@geindex Message (clase en mailbox)
@anchor{library/mailbox mailbox Message}@anchor{12be}
@deffn {Clase} mailbox.Message (message=None)

A subclass of the @ref{45,,email.message} module’s
@ref{3d1,,Message}. Subclasses of @code{mailbox.Message} add
mailbox-format-specific state and behavior.

If `message' is omitted, the new instance is created in a default, empty state.
If `message' is an @ref{3d1,,email.message.Message} instance, its contents are
copied; furthermore, any format-specific information is converted insofar as
possible if `message' is a @code{Message} instance. If `message' is a string,
a byte string,
or a file, it should contain an 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}-compliant message, which is read
and parsed.  Files should be open in binary mode, but text mode files
are accepted for backward compatibility.

El estado y los comportamientos específicos del formato que ofrecen las subclases varían, pero en general sólo se admiten las propiedades que no son específicas de un buzón de correo concreto (aunque presumiblemente las propiedades son específicas de un formato de buzón de correo concreto). Por ejemplo, no se conservan las compensaciones de archivos para los formatos de buzón de correo de un solo archivo ni los nombres de archivo para los formatos de buzón de correo basados en directorios, porque sólo son aplicables al buzón de correo original. Pero sí se conservan las declaraciones tales como si un mensaje ha sido leído por el usuario o marcado como importante, porque se aplican al propio mensaje.

There is no requirement that @code{Message} instances be used to represent
messages retrieved using @ref{12ba,,Mailbox} instances. In some situations, the
time and memory required to generate @code{Message} representations might
not be acceptable. For such situations, @code{Mailbox} instances also
offer string and file-like representations, and a custom message factory may
be specified when a @code{Mailbox} instance is initialized.
@end deffn

@menu
* MaildirMessage objects:: 
* mboxMessage objects:: 
* MHMessage objects:: 
* BabylMessage objects:: 
* MMDFMessage objects:: 

@end menu

@node MaildirMessage objects,mboxMessage objects,,Message objects
@anchor{library/mailbox mailbox-maildirmessage}@anchor{3625}@anchor{library/mailbox maildirmessage-objects}@anchor{3626}
@subsubsection @code{MaildirMessage} objects


@geindex MaildirMessage (clase en mailbox)
@anchor{library/mailbox mailbox MaildirMessage}@anchor{35e7}
@deffn {Clase} mailbox.MaildirMessage (message=None)

Un mensaje con comportamientos específicos de Maildir. El parámetro `message' tiene el mismo significado que con el constructor @ref{12be,,Message}.

Típicamente, una aplicación de agente de usuario de correo mueve todos los mensajes del subdirectorio @code{new} al subdirectorio @code{cur} después de la primera vez que el usuario abre y cierra el buzón de coreo, registrando que los mensajes son antiguos, tanto si han sido leídos como si no. Cada mensaje en @code{cur} tiene una sección «info» añadida a su nombre de archivo para almacenar información sobre su estado. (Algunos lectores de correo también pueden añadir una sección «info» a los mensajes en @code{new}.)  La sección «info» puede tomar una de dos formas: puede contener «2», seguido de una lista de flags estandarizados (por ejemplo, «2,FR») o puede contener «1», seguido de la llamada información experimental. Los flags normalizados para los mensajes de Maildir son los siguientes:


@multitable {xxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@tab

Explicación

@item

D

@tab

Borrador

@tab

Bajo composición

@item

F

@tab

Marcada

@tab

Marcado como importante

@item

P

@tab

Aprobado

@tab

Enviado, reenviado o rebotado

@item

R

@tab

Contestado

@tab

Contestado a

@item

S

@tab

Visto

@tab

Leído

@item

T

@tab

Destruido

@tab

Marcado para su posterior eliminación

@end multitable


@code{MaildirMessage} instances offer the following methods:

@geindex get_subdir() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_subdir}@anchor{3627}
@deffn {Método} get_subdir ()

Retorna «new» (si el mensaje debe ser almacenado en el subdirectorio @code{new}) o «cur» (si el mensaje debe ser almacenado en el subdirectorio @code{cur}).

@cartouche
@quotation Nota 
A message is typically moved from @code{new} to @code{cur} after its
mailbox has been accessed, whether or not the message has been
read. A message @code{msg} has been read if @code{"S" in msg.get_flags()} is
@code{True}.
@end quotation
@end cartouche
@end deffn

@geindex set_subdir() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_subdir}@anchor{3628}
@deffn {Método} set_subdir (subdir)

Establece el subdirectorio en el que debe almacenarse el mensaje. El parámetro `subdir' debe ser «new» o «cur».
@end deffn

@geindex get_flags() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_flags}@anchor{35f0}
@deffn {Método} get_flags ()

Retorna una cadena que especifica los flags que están actualmente establecidos. Si el mensaje cumple con el formato estándar de Maildir, el resultado es la concatenación en orden alfabético de cero o una ocurrencia de cada una de los flags @code{'D'}, @code{'F'}, @code{'P'}, @code{'R'}, @code{'S'}, y @code{'T'}. La cadena vacía se retorna si no hay flags o si «info» contiene semántica experimental.
@end deffn

@geindex set_flags() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_flags}@anchor{35f1}
@deffn {Método} set_flags (flags)

Establece los flags especificados por `flags' y desactiva todas las demás.
@end deffn

@geindex add_flag() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage add_flag}@anchor{35f2}
@deffn {Método} add_flag (flag)

Establece lo(s) flag(s) especificado(s) por `flags' sin cambiar otros flags. Para añadir más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter. La «info» actual se sobrescribe si contiene o no información experimental en lugar de flags.
@end deffn

@geindex remove_flag() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage remove_flag}@anchor{35f3}
@deffn {Método} remove_flag (flag)

Deshabilita lo(s) flag(s) especificado(s) por `flag' sin cambiar otros flags. Para quitar más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter.  Si «info» contiene información experimental en lugar de flags, la «info» actual no se modifica.
@end deffn

@geindex get_date() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_date}@anchor{3629}
@deffn {Método} get_date ()

Retorna la fecha de entrega del mensaje como un número de punto flotante que representa los segundos desde la época.
@end deffn

@geindex set_date() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_date}@anchor{362a}
@deffn {Método} set_date (date)

Establece la fecha de entrega del mensaje en `date', un número de punto flotante que representa los segundos desde la época.
@end deffn

@geindex get_info() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_info}@anchor{35f5}
@deffn {Método} get_info ()

Retorna una cadena que contiene la «info» de un mensaje. Esto es útil para acceder y modificar la «info» que es experimental (es decir, no una lista de flags).
@end deffn

@geindex set_info() (método de mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_info}@anchor{35f6}
@deffn {Método} set_info (info)

Establece «info» en `info', que debería ser una cadena.
@end deffn
@end deffn

When a @code{MaildirMessage} instance is created based upon an
@ref{34a3,,mboxMessage} or @ref{361f,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{34a3,,mboxMessage} o @ref{361f,,MMDFMessage}

@item

subdirectorio «cur»

@tab

flag O

@item

flag F

@tab

flag F

@item

flag R

@tab

flag A

@item

flag S

@tab

flag R

@item

flag T

@tab

flag D

@end multitable


When a @code{MaildirMessage} instance is created based upon an
@ref{3605,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3605,,MHMessage}

@item

subdirectorio «cur»

@tab

Secuencia «`unseen'» (no vista)

@item

subdirectorio «cur» e indicador S

@tab

no hay una secuencia «`unseen'» (invisible)

@item

flag F

@tab

secuencia «`flagged'» (marcada)

@item

flag R

@tab

Secuencia «`replied'» (respondida)

@end multitable


When a @code{MaildirMessage} instance is created based upon a
@ref{3618,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3618,,BabylMessage}

@item

subdirectorio «cur»

@tab

etiqueta «`unseen'» (invisible)

@item

subdirectorio «cur» e indicador S

@tab

no hay una etiqueta «`unseen'» (invisible)

@item

flag P

@tab

etiqueta «`forwarded'» o «`resent'» (reenviado)

@item

flag R

@tab

etiqueta de «`answered'» (contestado)

@item

flag T

@tab

etiqueta «deleted» (borrado)

@end multitable


@node mboxMessage objects,MHMessage objects,MaildirMessage objects,Message objects
@anchor{library/mailbox mailbox-mboxmessage}@anchor{362b}@anchor{library/mailbox mboxmessage-objects}@anchor{362c}
@subsubsection @code{mboxMessage} objects


@geindex mboxMessage (clase en mailbox)
@anchor{library/mailbox mailbox mboxMessage}@anchor{34a3}
@deffn {Clase} mailbox.mboxMessage (message=None)

Un mensaje con comportamientos específicos de mbox. El parámetro `message' tiene el mismo significado que con el constructor @ref{12be,,Message}.

Los mensajes en un buzón de correo de mbox se almacenan juntos en un solo archivo. La dirección del sobre del remitente y la hora de entrega se almacenan normalmente en una línea que comienza con «From» que se utiliza para indicar el comienzo de un mensaje, aunque hay una variación considerable en el formato exacto de estos datos entre las implementaciones de mbox. Los flags del estado del mensaje, como por ejemplo si ha sido leído o marcado como importante, se almacenan típicamente en las cabeceras @code{Status} y @code{X-Status}.

Los flags convencionales para los mensajes de mbox son los siguientes:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@tab

Explicación

@item

R

@tab

Leído

@tab

Leído

@item

O

@tab

Antiguo

@tab

Anteriormente detectado por MUA

@item

D

@tab

Borrado

@tab

Marcado para su posterior eliminación

@item

F

@tab

Marcada

@tab

Marcado como importante

@item

A

@tab

Respondido

@tab

Contestado a

@end multitable


Los flags «R» y «O» se almacenan en el encabezado @code{Status} y los flags «D», «F» y «A» se almacenan en el encabezado @code{X-Status}. Los flags y los encabezados aparecen típicamente en el orden mencionado.

@code{mboxMessage} instances offer the following methods:

@geindex get_from() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage get_from}@anchor{362d}
@deffn {Método} get_from ()

Retorna una cadena que representa la línea «From» que marca el inicio del mensaje en un buzón de correo de mbox. El «From» inicial y la nueva línea final están excluidas.
@end deffn

@geindex set_from() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage set_from}@anchor{362e}
@deffn {Método} set_from (from_, time_=None)

Set the «From « line to `from_', which should be specified without a
leading «From « or trailing newline. For convenience, `time_' may be
specified and will be formatted appropriately and appended to `from_'. If
`time_' is specified, it should be a @ref{d71,,time.struct_time} instance, a
tuple suitable for passing to @ref{1256,,time.strftime()}, or @code{True} (to use
@ref{122d,,time.gmtime()}).
@end deffn

@geindex get_flags() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage get_flags}@anchor{362f}
@deffn {Método} get_flags ()

Retorna una cadena que especifica los flags que están actualmente establecidos. Si el mensaje cumple con el formato convencional, el resultado es la concatenación en el siguiente orden de cero o una ocurrencia de cada uno de los flags @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex set_flags() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage set_flags}@anchor{3630}
@deffn {Método} set_flags (flags)

Establece los flags especificadas por `flags' y desactiva todos las demás. El parámetro `flags' debe ser la concatenación en cualquier orden de cero o más ocurrencias de cada uno de los flags @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex add_flag() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage add_flag}@anchor{3631}
@deffn {Método} add_flag (flag)

Establece lo(s) flag(s) especificado(s) por `flag' sin cambiar otros flags. Para añadir más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter.
@end deffn

@geindex remove_flag() (método de mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage remove_flag}@anchor{3632}
@deffn {Método} remove_flag (flag)

Deshabilita lo(s) flag(s) especificado(s) por `flag' sin cambiar otros flags. Para quitar más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter.
@end deffn
@end deffn

When an @code{mboxMessage} instance is created based upon a
@ref{35e7,,MaildirMessage} instance, a «From « line is generated based upon the
@ref{35e7,,MaildirMessage} instance’s delivery date, and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{35e7,,MaildirMessage}

@item

flag R

@tab

flag S

@item

flag O

@tab

subdirectorio «cur»

@item

flag D

@tab

flag T

@item

flag F

@tab

flag F

@item

flag A

@tab

flag R

@end multitable


When an @code{mboxMessage} instance is created based upon an
@ref{3605,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3605,,MHMessage}

@item

flag R y flag O

@tab

no hay una secuencia «`unseen'» (invisible)

@item

flag O

@tab

Secuencia «`unseen'» (no vista)

@item

flag F

@tab

secuencia «`flagged'» (marcada)

@item

flag A

@tab

Secuencia «`replied'» (respondida)

@end multitable


When an @code{mboxMessage} instance is created based upon a
@ref{3618,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3618,,BabylMessage}

@item

flag R y flag O

@tab

no hay una etiqueta «`unseen'» (invisible)

@item

flag O

@tab

etiqueta «`unseen'» (invisible)

@item

flag D

@tab

etiqueta «deleted» (borrado)

@item

flag A

@tab

etiqueta de «`answered'» (contestado)

@end multitable


When a @code{mboxMessage} instance is created based upon an
@ref{361f,,MMDFMessage}
instance, the «From « line is copied and all flags directly correspond:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{361f,,MMDFMessage}

@item

flag R

@tab

flag R

@item

flag O

@tab

flag O

@item

flag D

@tab

flag D

@item

flag F

@tab

flag F

@item

flag A

@tab

flag A

@end multitable


@node MHMessage objects,BabylMessage objects,mboxMessage objects,Message objects
@anchor{library/mailbox mailbox-mhmessage}@anchor{3633}@anchor{library/mailbox mhmessage-objects}@anchor{3634}
@subsubsection @code{MHMessage} objects


@geindex MHMessage (clase en mailbox)
@anchor{library/mailbox mailbox MHMessage}@anchor{3605}
@deffn {Clase} mailbox.MHMessage (message=None)

Un mensaje con comportamientos específicos de la HM. El parámetro `message' tiene el mismo significado que con el constructor @ref{12be,,Message}.

Los mensajes de MH no soportan marcas o flags en el sentido tradicional, pero sí secuencias, que son agrupaciones lógicas de mensajes arbitrarios. Algunos programas de lectura de correo (aunque no los estándares @code{mh} y @code{nmh}) usan secuencias de manera muy similar a los flags que se usan con otros formatos, como sigue:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Secuencia

@tab

Explicación

@item

`unseen' (no visto)

@tab

No leído, pero previamente detectado por la MUA

@item

`replied' (contestado)

@tab

Contestado a

@item

`flagged' (marcado)

@tab

Marcado como importante

@end multitable


@code{MHMessage} instances offer the following methods:

@geindex get_sequences() (método de mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage get_sequences}@anchor{3635}
@deffn {Método} get_sequences ()

Retorna una lista de los nombres de las secuencias que incluyen este mensaje.
@end deffn

@geindex set_sequences() (método de mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage set_sequences}@anchor{3636}
@deffn {Método} set_sequences (sequences)

Establece la lista de secuencias que incluyen este mensaje.
@end deffn

@geindex add_sequence() (método de mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage add_sequence}@anchor{3637}
@deffn {Método} add_sequence (sequence)

Añade `sequence' a la lista de secuencias que incluyen este mensaje.
@end deffn

@geindex remove_sequence() (método de mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage remove_sequence}@anchor{3638}
@deffn {Método} remove_sequence (sequence)

Elimina `sequence' de la lista de secuencias que incluyen este mensaje.
@end deffn
@end deffn

When an @code{MHMessage} instance is created based upon a
@ref{35e7,,MaildirMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{35e7,,MaildirMessage}

@item

Secuencia «`unseen'» (no vista)

@tab

no hay indicador S

@item

Secuencia «`replied'» (respondida)

@tab

flag R

@item

secuencia «`flagged'» (marcada)

@tab

flag F

@end multitable


When an @code{MHMessage} instance is created based upon an
@ref{34a3,,mboxMessage} or @ref{361f,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{34a3,,mboxMessage} o @ref{361f,,MMDFMessage}

@item

Secuencia «`unseen'» (no vista)

@tab

sin indicador R

@item

Secuencia «`replied'» (respondida)

@tab

flag A

@item

secuencia «`flagged'» (marcada)

@tab

flag F

@end multitable


When an @code{MHMessage} instance is created based upon a
@ref{3618,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3618,,BabylMessage}

@item

Secuencia «`unseen'» (no vista)

@tab

etiqueta «`unseen'» (invisible)

@item

Secuencia «`replied'» (respondida)

@tab

etiqueta de «`answered'» (contestado)

@end multitable


@node BabylMessage objects,MMDFMessage objects,MHMessage objects,Message objects
@anchor{library/mailbox babylmessage-objects}@anchor{3639}@anchor{library/mailbox mailbox-babylmessage}@anchor{363a}
@subsubsection @code{BabylMessage} objects


@geindex BabylMessage (clase en mailbox)
@anchor{library/mailbox mailbox BabylMessage}@anchor{3618}
@deffn {Clase} mailbox.BabylMessage (message=None)

Un mensaje con comportamientos específicos de Babyl. El parámetro `message' tiene el mismo significado que con el constructor @ref{12be,,Message}.

Ciertas etiquetas de mensajes, llamadas `attributes', están definidas por convención para tener significados especiales. Los atributos son los siguientes:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Etiqueta

@tab

Explicación

@item

`unseen' (no visto)

@tab

No leído, pero previamente detectado por la MUA

@item

`deleted' (borrado)

@tab

Marcado para su posterior eliminación

@item

`filed' (archivado)

@tab

Copiado a otro archivo o buzón de correo

@item

`answered' (contestado)

@tab

Contestado a

@item

`forwarded' (reenviado)

@tab

Reenviado

@item

`edited' (editado)

@tab

Modificado por el usuario

@item

`resent' (reenviado)

@tab

Reenviado

@end multitable


By default, Rmail displays only visible headers. The @code{BabylMessage}
class, though, uses the original headers because they are more
complete. Visible headers may be accessed explicitly if desired.

@code{BabylMessage} instances offer the following methods:

@geindex get_labels() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage get_labels}@anchor{363b}
@deffn {Método} get_labels ()

Retorna una lista de etiquetas en el mensaje.
@end deffn

@geindex set_labels() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage set_labels}@anchor{363c}
@deffn {Método} set_labels (labels)

Establece la lista de etiquetas del mensaje en `labels'.
@end deffn

@geindex add_label() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage add_label}@anchor{363d}
@deffn {Método} add_label (label)

Añade `label' a la lista de etiquetas del mensaje.
@end deffn

@geindex remove_label() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage remove_label}@anchor{363e}
@deffn {Método} remove_label (label)

Eliminar `label' de la lista de etiquetas del mensaje.
@end deffn

@geindex get_visible() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage get_visible}@anchor{363f}
@deffn {Método} get_visible ()

Return a @ref{12be,,Message} instance whose headers are the message’s
visible headers and whose body is empty.
@end deffn

@geindex set_visible() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage set_visible}@anchor{3640}
@deffn {Método} set_visible (visible)

Establece los encabezados visibles del mensaje para que sean los mismos que los del `message'.  El parámetro `visible' debe ser una instancia @ref{12be,,Message}, una instancia @ref{3d1,,email.message.Message}, una cadena, o un objeto tipo archivo (que debe estar abierto en modo texto).
@end deffn

@geindex update_visible() (método de mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage update_visible}@anchor{3641}
@deffn {Método} update_visible ()

When a @code{BabylMessage} instance’s original headers are modified, the
visible headers are not automatically modified to correspond. This method
updates the visible headers as follows: each visible header with a
corresponding original header is set to the value of the original header,
each visible header without a corresponding original header is removed,
and any of @code{Date}, @code{From}, @code{Reply-To},
@code{To}, @code{CC}, and @code{Subject} that are
present in the original headers but not the visible headers are added to
the visible headers.
@end deffn
@end deffn

When a @code{BabylMessage} instance is created based upon a
@ref{35e7,,MaildirMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{35e7,,MaildirMessage}

@item

etiqueta «`unseen'» (invisible)

@tab

no hay indicador S

@item

etiqueta «deleted» (borrado)

@tab

flag T

@item

etiqueta de «`answered'» (contestado)

@tab

flag R

@item

etiqueta «`forwarded'» (reenviado)

@tab

flag P

@end multitable


When a @code{BabylMessage} instance is created based upon an
@ref{34a3,,mboxMessage} or @ref{361f,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{34a3,,mboxMessage} o @ref{361f,,MMDFMessage}

@item

etiqueta «`unseen'» (invisible)

@tab

sin indicador R

@item

etiqueta «deleted» (borrado)

@tab

flag D

@item

etiqueta de «`answered'» (contestado)

@tab

flag A

@end multitable


When a @code{BabylMessage} instance is created based upon an
@ref{3605,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3605,,MHMessage}

@item

etiqueta «`unseen'» (invisible)

@tab

Secuencia «`unseen'» (no vista)

@item

etiqueta de «`answered'» (contestado)

@tab

Secuencia «`replied'» (respondida)

@end multitable


@node MMDFMessage objects,,BabylMessage objects,Message objects
@anchor{library/mailbox mailbox-mmdfmessage}@anchor{3642}@anchor{library/mailbox mmdfmessage-objects}@anchor{3643}
@subsubsection @code{MMDFMessage} objects


@geindex MMDFMessage (clase en mailbox)
@anchor{library/mailbox mailbox MMDFMessage}@anchor{361f}
@deffn {Clase} mailbox.MMDFMessage (message=None)

Un mensaje con comportamientos específicos de MMDF. El parámetro `message' tiene el mismo significado que con el constructor @ref{12be,,Message}.

Al igual que los mensajes en un buzón de correo de mbox, los mensajes MMDF se almacenan con la dirección del remitente y la fecha de entrega en una línea inicial que comienza con «From».  De la misma manera, los flags que indican el estado del mensaje se almacenan típicamente en las cabeceras @code{Status} y @code{X-Status}.

Los flags convencionales para los mensajes MMDF son idénticos a las de los mensajes de mbox y son los siguientes:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@tab

Explicación

@item

R

@tab

Leído

@tab

Leído

@item

O

@tab

Antiguo

@tab

Anteriormente detectado por MUA

@item

D

@tab

Borrado

@tab

Marcado para su posterior eliminación

@item

F

@tab

Marcada

@tab

Marcado como importante

@item

A

@tab

Respondido

@tab

Contestado a

@end multitable


Los flags «R» y «O» se almacenan en el encabezado @code{Status} y los flags «D», «F» y «A» se almacenan en el encabezado @code{X-Status}. Los flags y los encabezados aparecen típicamente en el orden mencionado.

@code{MMDFMessage} instances offer the following methods, which are
identical to those offered by @ref{34a3,,mboxMessage}:

@geindex get_from() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage get_from}@anchor{3644}
@deffn {Método} get_from ()

Retorna una cadena que representa la línea «From» que marca el inicio del mensaje en un buzón de correo de mbox. El «From» inicial y la nueva línea final están excluidas.
@end deffn

@geindex set_from() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage set_from}@anchor{3645}
@deffn {Método} set_from (from_, time_=None)

Set the «From « line to `from_', which should be specified without a
leading «From « or trailing newline. For convenience, `time_' may be
specified and will be formatted appropriately and appended to `from_'. If
`time_' is specified, it should be a @ref{d71,,time.struct_time} instance, a
tuple suitable for passing to @ref{1256,,time.strftime()}, or @code{True} (to use
@ref{122d,,time.gmtime()}).
@end deffn

@geindex get_flags() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage get_flags}@anchor{3646}
@deffn {Método} get_flags ()

Retorna una cadena que especifica los flags que están actualmente establecidos. Si el mensaje cumple con el formato convencional, el resultado es la concatenación en el siguiente orden de cero o una ocurrencia de cada uno de los flags @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex set_flags() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage set_flags}@anchor{3647}
@deffn {Método} set_flags (flags)

Establece los flags especificadas por `flags' y desactiva todos las demás. El parámetro `flags' debe ser la concatenación en cualquier orden de cero o más ocurrencias de cada uno de los flags @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex add_flag() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage add_flag}@anchor{3648}
@deffn {Método} add_flag (flag)

Establece lo(s) flag(s) especificado(s) por `flag' sin cambiar otros flags. Para añadir más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter.
@end deffn

@geindex remove_flag() (método de mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage remove_flag}@anchor{3649}
@deffn {Método} remove_flag (flag)

Deshabilita lo(s) flag(s) especificado(s) por `flag' sin cambiar otros flags. Para quitar más de un indicador a la vez, `flag' puede ser una cadena de más de un carácter.
@end deffn
@end deffn

When an @code{MMDFMessage} instance is created based upon a
@ref{35e7,,MaildirMessage} instance, a «From « line is generated based upon the
@ref{35e7,,MaildirMessage} instance’s delivery date, and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{35e7,,MaildirMessage}

@item

flag R

@tab

flag S

@item

flag O

@tab

subdirectorio «cur»

@item

flag D

@tab

flag T

@item

flag F

@tab

flag F

@item

flag A

@tab

flag R

@end multitable


When an @code{MMDFMessage} instance is created based upon an
@ref{3605,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3605,,MHMessage}

@item

flag R y flag O

@tab

no hay una secuencia «`unseen'» (invisible)

@item

flag O

@tab

Secuencia «`unseen'» (no vista)

@item

flag F

@tab

secuencia «`flagged'» (marcada)

@item

flag A

@tab

Secuencia «`replied'» (respondida)

@end multitable


When an @code{MMDFMessage} instance is created based upon a
@ref{3618,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado @ref{3618,,BabylMessage}

@item

flag R y flag O

@tab

no hay una etiqueta «`unseen'» (invisible)

@item

flag O

@tab

etiqueta «`unseen'» (invisible)

@item

flag D

@tab

etiqueta «deleted» (borrado)

@item

flag A

@tab

etiqueta de «`answered'» (contestado)

@end multitable


When an @code{MMDFMessage} instance is created based upon an
@ref{34a3,,mboxMessage} instance, the «From « line is copied and all flags directly
correspond:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Estado resultante

@tab

Estado de @ref{34a3,,mboxMessage}

@item

flag R

@tab

flag R

@item

flag O

@tab

flag O

@item

flag D

@tab

flag D

@item

flag F

@tab

flag F

@item

flag A

@tab

flag A

@end multitable


@node Excepciones<16>,Ejemplos<21>,Message objects,mailbox — Manipulate mailboxes in various formats
@anchor{library/mailbox exceptions}@anchor{364a}
@subsubsection Excepciones


The following exception classes are defined in the @code{mailbox} module:

@geindex Error
@anchor{library/mailbox mailbox Error}@anchor{364b}
@deffn {Excepción} mailbox.Error

La clase base para todas las demás excepciones específicas del módulo.
@end deffn

@geindex NoSuchMailboxError
@anchor{library/mailbox mailbox NoSuchMailboxError}@anchor{35eb}
@deffn {Excepción} mailbox.NoSuchMailboxError

Se lanza cuando se espera un buzón de correo pero no se encuentra, como cuando se instancia una subclase @ref{12ba,,Mailbox} con una ruta que no existe (y con el parámetro `create' establecido en @code{False}), o cuando se abre una carpeta que no existe.
@end deffn

@geindex NotEmptyError
@anchor{library/mailbox mailbox NotEmptyError}@anchor{35ee}
@deffn {Excepción} mailbox.NotEmptyError

Se lanza cuando un buzón de correo no está vacío, pero se espera que lo esté, como cuando se elimina una carpeta que contiene mensajes.
@end deffn

@geindex ExternalClashError
@anchor{library/mailbox mailbox ExternalClashError}@anchor{35e3}
@deffn {Excepción} mailbox.ExternalClashError

Raised when some mailbox-related condition beyond the control of the program
causes it to be unable to proceed, such as when failing to acquire a lock that
another program already holds a lock, or when a uniquely generated file name
already exists.
@end deffn

@geindex FormatError
@anchor{library/mailbox mailbox FormatError}@anchor{364c}
@deffn {Excepción} mailbox.FormatError

Se lanza cuando los datos de un archivo no pueden ser analizados, como cuando una instancia @ref{16be,,MH} intenta leer un archivo @code{.mh_sequences} corrupto.
@end deffn

@node Ejemplos<21>,,Excepciones<16>,mailbox — Manipulate mailboxes in various formats
@anchor{library/mailbox examples}@anchor{364d}@anchor{library/mailbox mailbox-examples}@anchor{364e}
@subsubsection Ejemplos


Un simple ejemplo de impresión de los temas de todos los mensajes en un buzón de correo que parecen interesantes:

@example
import mailbox
for message in mailbox.mbox('~/mbox'):
    subject = message['subject']       # Could possibly be None.
    if subject and 'python' in subject.lower():
        print(subject)
@end example

Para copiar todo el correo de un buzón de Babyl a un buzón de MH, convirtiendo toda la información de formato específico que puede ser convertida:

@example
import mailbox
destination = mailbox.MH('~/Mail')
destination.lock()
for message in mailbox.Babyl('~/RMAIL'):
    destination.add(mailbox.MHMessage(message))
destination.flush()
destination.unlock()
@end example

Este ejemplo clasifica el correo de varias listas de correo en diferentes buzones, teniendo cuidado de evitar la corrupción del correo debido a la modificación simultánea por otros programas, la pérdida de correo debido a la interrupción del programa, o la terminación prematura debido a mensajes malformados en el buzón:

@example
import mailbox
import email.errors

list_names = ('python-list', 'python-dev', 'python-bugs')

boxes = @{name: mailbox.mbox('~/email/%s' % name) for name in list_names@}
inbox = mailbox.Maildir('~/Maildir', factory=None)

for key in inbox.iterkeys():
    try:
        message = inbox[key]
    except email.errors.MessageParseError:
        continue                # The message is malformed. Just leave it.

    for name in list_names:
        list_id = message['list-id']
        if list_id and name in list_id:
            # Get mailbox to use
            box = boxes[name]

            # Write copy to disk before removing original.
            # If there's a crash, you might duplicate a message, but
            # that's better than losing a message completely.
            box.lock()
            box.add(message)
            box.flush()
            box.unlock()

            # Remove original message
            inbox.lock()
            inbox.discard(key)
            inbox.flush()
            inbox.unlock()
            break               # Found destination, so stop looking.

for box in boxes.itervalues():
    box.close()
@end example

@node mimetypes — Map filenames to MIME types,base64 — Base16 Base32 Base64 Base85 Data Encodings,mailbox — Manipulate mailboxes in various formats,Manejo de datos de internet
@anchor{library/mimetypes doc}@anchor{364f}@anchor{library/mimetypes mimetypes-map-filenames-to-mime-types}@anchor{3650}@anchor{library/mimetypes module-mimetypes}@anchor{8f}
@subsection @code{mimetypes} — Map filenames to MIME types


@geindex module; mimetypes

`Código fuente:' Lib/mimetypes.py@footnote{https://github.com/python/cpython/tree/main/Lib/mimetypes.py}

@geindex MIME;content type


__________________________________________________________________


El módulo @ref{8f,,mimetypes} convierte entre un nombre de archivo o URL y el tipo MIME asociado a la extensión del nombre de archivo. Se proporcionan conversiones de nombre de archivo a tipo MIME y de tipo MIME a extensión de nombre de archivo; no se admiten codificaciones para esta última conversión.

El módulo proporciona una clase y varias funciones de conveniencia. Las funciones son la interfaz normal de este módulo, pero algunas aplicaciones pueden estar interesadas en la clase también.

Las funciones que se describen a continuación constituyen la interfaz principal de este módulo. Si el módulo no ha sido inicializado, llamarán @ref{3651,,init()} si se basan en la información que @ref{3651,,init()} establece.

@geindex guess_type() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_type}@anchor{366}
@deffn {Función} mimetypes.guess_type (url, strict=True)

@geindex MIME;headers

Adivina el tipo de un archivo basado en su nombre de archivo, ruta o URL, dado por `url'. La URL puede ser una cadena o un objeto @ref{3f0,,path-like object}.

El valor de retorno es una tupla @code{(type, encoding)} donde `type' es @code{None} si el tipo no puede ser adivinado (por sufijo ausente o desconocido) o una cadena de la forma @code{type/subtype'}, utilizable para un encabezado MIME @code{content-type}.

`encoding' es @code{None} para no codificar o el nombre del programa usado para codificar (por ejemplo @code{compress} o @code{gzip}). La codificación es adecuada para ser usada como una cabecera de @code{Content-Encoding}, `no' como una cabecera de @code{Content-Transfer-Encoding}. Los mapeos son conducidos por tablas. Los sufijos de codificación son sensibles a las mayúsculas y minúsculas; los sufijos de tipo se prueban primero distinguiendo entre mayúsculas y minúsculas, y luego sin dicha distinción.

El argumento opcional `strict' es una flag que especifica si la lista de tipos MIME conocidos se limita sólo a los tipos oficiales registrados en IANA@footnote{https://www.iana.org/assignments/media-types/media-types.xhtml}. Cuando `strict' es @code{True} (el valor por defecto), sólo se soportan los tipos de IANA; cuando `strict' es @code{False}, también se reconocen algunos tipos MIME adicionales no estándar pero de uso común.


Distinto en la versión 3.8: Added support for `url' being a @ref{3f0,,path-like object}.



Obsoleto desde la versión 3.13: Passing a file path instead of URL is @ref{1c4,,soft deprecated}.
Use @ref{365,,guess_file_type()} for this.

@end deffn

@geindex guess_file_type() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_file_type}@anchor{365}
@deffn {Función} mimetypes.guess_file_type (path, *, strict=True)

@geindex MIME;headers

Guess the type of a file based on its path, given by `path'.
Similar to the @ref{366,,guess_type()} function, but accepts a path instead of URL.
Path can be a string, a bytes object or a @ref{3f0,,path-like object}.


Added in version 3.13.

@end deffn

@geindex guess_all_extensions() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_all_extensions}@anchor{189e}
@deffn {Función} mimetypes.guess_all_extensions (type, strict=True)

Guess the extensions for a file based on its MIME type, given by `type'. The
return value is a list of strings giving all possible filename extensions,
including the leading dot (@code{'.'}).  The extensions are not guaranteed to have
been associated with any particular data stream, but would be mapped to the MIME
type `type' by @ref{366,,guess_type()} and @ref{365,,guess_file_type()}.

El argumento opcional `strict' tiene el mismo significado que con la función @ref{366,,guess_type()}.
@end deffn

@geindex guess_extension() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_extension}@anchor{3652}
@deffn {Función} mimetypes.guess_extension (type, strict=True)

Guess the extension for a file based on its MIME type, given by `type'. The
return value is a string giving a filename extension, including the leading dot
(@code{'.'}).  The extension is not guaranteed to have been associated with any
particular data stream, but would be mapped to the MIME type `type' by
@ref{366,,guess_type()} and @ref{365,,guess_file_type()}.
If no extension can be guessed for `type', @code{None} is returned.

El argumento opcional `strict' tiene el mismo significado que con la función @ref{366,,guess_type()}.
@end deffn

Algunas funciones adicionales y elementos de datos están disponibles para controlar el comportamiento del módulo.

@geindex init() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes init}@anchor{3651}
@deffn {Función} mimetypes.init (files=None)

Inicializa las estructuras de datos internos. Si se proporciona `files' debe ser una secuencia de nombres de archivos que deben utilizarse para aumentar el mapa de tipo por defecto. Si se omite, los nombres de archivo a utilizar se toman de @ref{3653,,knownfiles}; en Windows, se cargan las configuraciones actuales del registro. Cada archivo nombrado en `files' o @ref{3653,,knownfiles} tiene prioridad sobre los nombrados antes de él. Se permite llamar repetidamente a @ref{3651,,init()}.

Si se especifica una lista vacía para `files' se evitará que se apliquen los valores predeterminados del sistema: sólo estarán presentes los valores conocidos de una lista incorporada.

Si `files' es @code{None} la estructura interna de datos se reconstruye completamente a su valor inicial por defecto. Esta es una operación estable y producirá los mismos resultados cuando se llame varias veces.


Distinto en la versión 3.2: Anteriormente, la configuración del registro de Windows se ignoraba.

@end deffn

@geindex read_mime_types() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes read_mime_types}@anchor{194d}
@deffn {Función} mimetypes.read_mime_types (filename)

Carga el mapa de tipo dado en el archivo `filename', si existe. El mapa de tipos es retornado como un diccionario que mapea las extensiones de los nombres de archivo, incluyendo el punto inicial (@code{'.'}), a las cadenas de la forma @code{'type/subtype'}. Si el archivo `filename' no existe o no puede ser leído, se retorna @code{None}.
@end deffn

@geindex add_type() (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes add_type}@anchor{3654}
@deffn {Función} mimetypes.add_type (type, ext, strict=True)

Añade un mapeo del tipo MIME `type' a la extensión `ext'. Cuando la extensión ya se conoce, el nuevo tipo reemplazará al antiguo. Cuando el tipo ya se conoce la extensión se añadirá a la lista de extensiones conocidas.

Cuando `strict' es @code{True} (el valor por defecto), el mapeo se añadirá a los tipos MIME oficiales, de lo contrario a los no estándar.
@end deffn

@geindex inited (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes inited}@anchor{3655}
@deffn {Dato} mimetypes.inited

Flag que indica si se han inicializado o no las estructuras de datos globales. Esto se establece como «True» por @ref{3651,,init()}.
@end deffn

@geindex knownfiles (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes knownfiles}@anchor{3653}
@deffn {Dato} mimetypes.knownfiles

@geindex file;mime.types

Lista de los nombres de los archivos de mapas de tipo comúnmente instalados.  Estos archivos se llaman típicamente  @code{mime.types} y se instalan en diferentes lugares por diferentes paquetes.
@end deffn

@geindex suffix_map (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes suffix_map}@anchor{3656}
@deffn {Dato} mimetypes.suffix_map

Diccionario que mapea sufijos a sufijos. Se utiliza para permitir el reconocimiento de archivos codificados cuya codificación y tipo se indican con la misma extensión. Por ejemplo, la extensión @code{.tgz} se mapea a @code{.tar.gz} para permitir que la codificación y el tipo se reconozcan por separado.
@end deffn

@geindex encodings_map (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes encodings_map}@anchor{3657}
@deffn {Dato} mimetypes.encodings_map

El diccionario mapea las extensiones de los nombres de archivo a los tipos de codificación.
@end deffn

@geindex types_map (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes types_map}@anchor{3658}
@deffn {Dato} mimetypes.types_map

Diccionario que mapea extensiones de los nombres de archivo a tipos MIME.
@end deffn

@geindex common_types (en el módulo mimetypes)
@anchor{library/mimetypes mimetypes common_types}@anchor{3659}
@deffn {Dato} mimetypes.common_types

Diccionario que mapea extensiones de los nombres de archivo a tipos MIME no estándar, pero comúnmente encontrados.
@end deffn

Un ejemplo de utilización del módulo:

@example
>>> import mimetypes
>>> mimetypes.init()
>>> mimetypes.knownfiles
['/etc/mime.types', '/etc/httpd/mime.types', ... ]
>>> mimetypes.suffix_map['.tgz']
'.tar.gz'
>>> mimetypes.encodings_map['.gz']
'gzip'
>>> mimetypes.types_map['.tgz']
'application/x-tar-gz'
@end example

@menu
* Objetos MimeTypes:: 

@end menu

@node Objetos MimeTypes,,,mimetypes — Map filenames to MIME types
@anchor{library/mimetypes id1}@anchor{365a}@anchor{library/mimetypes mimetypes-objects}@anchor{365b}
@subsubsection Objetos MimeTypes


La clase @ref{153b,,MimeTypes} puede ser útil para aplicaciones que quieran más de una base de datos de tipo MIME; proporciona una interfaz similar a la del módulo @ref{8f,,mimetypes}.

@geindex MimeTypes (clase en mimetypes)
@anchor{library/mimetypes mimetypes MimeTypes}@anchor{153b}
@deffn {Clase} mimetypes.MimeTypes (filenames=(), strict=True)

Esta clase representa una base de datos de tipos MIME. Por defecto, proporciona acceso a la misma base de datos que el resto de este módulo. La base de datos inicial es una copia de la proporcionada por el módulo, y puede ser extendida cargando archivos adicionales de tipo @code{mime.types} en la base de datos usando los métodos @ref{365c,,read()} o @ref{365d,,readfp()}. Los diccionarios de mapeo también pueden ser borrados antes de cargar datos adicionales si no se desean los datos por defecto.

El parámetro opcional `filenames' puede utilizarse para hacer que se carguen archivos adicionales «encima» de la base de datos predeterminada.

@geindex suffix_map (atributo de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes suffix_map}@anchor{365e}
@deffn {Atributo} suffix_map

El diccionario mapea sufijos a sufijos. Se utiliza para permitir el reconocimiento de archivos codificados cuya codificación y tipo se indican con la misma extensión. Por ejemplo, la extensión @code{.tgz} se mapea a @code{.tar.gz} para permitir que la codificación y el tipo se reconozcan por separado. Esto es inicialmente una copia del global @ref{3656,,suffix_map} definido en el módulo.
@end deffn

@geindex encodings_map (atributo de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes encodings_map}@anchor{365f}
@deffn {Atributo} encodings_map

El diccionario mapea las extensiones de los nombres de archivo a los tipos de codificación. Es inicialmente una copia del global @ref{3657,,encodings_map} definido en el módulo.
@end deffn

@geindex types_map (atributo de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes types_map}@anchor{3660}
@deffn {Atributo} types_map

Una tupla que contiene dos diccionarios, mapeando las extensiones de los nombres de archivo a los tipos MIME: el primer diccionario es para los tipos no estándar y el segundo para los tipos estándar. Están inicializados por @ref{3659,,common_types} y @ref{3658,,types_map}.
@end deffn

@geindex types_map_inv (atributo de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes types_map_inv}@anchor{3661}
@deffn {Atributo} types_map_inv

Una tupla que contiene dos diccionarios, mapeando los tipos MIME a una lista de extensiones de nombres de archivos: el primer diccionario es para los tipos no estándar y el segundo para los tipos estándar. Están inicializados por @ref{3659,,common_types} y @ref{3658,,types_map}.
@end deffn

@geindex guess_extension() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_extension}@anchor{3662}
@deffn {Método} guess_extension (type, strict=True)

Similar a la función @ref{3652,,guess_extension()}, usando las tablas almacenadas como parte del objeto.
@end deffn

@geindex guess_type() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_type}@anchor{1a3f}
@deffn {Método} guess_type (url, strict=True)

Similar a la función @ref{366,,guess_type()}, usando las tablas almacenadas como parte del objeto.
@end deffn

@geindex guess_file_type() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_file_type}@anchor{3663}
@deffn {Método} guess_file_type (path, *, strict=True)

Similar to the @ref{365,,guess_file_type()} function, using the tables stored
as part of the object.


Added in version 3.13.

@end deffn

@geindex guess_all_extensions() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_all_extensions}@anchor{3664}
@deffn {Método} guess_all_extensions (type, strict=True)

Similar a la función @ref{189e,,guess_all_extensions()}, usando las tablas almacenadas como parte del objeto.
@end deffn

@geindex read() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes read}@anchor{365c}
@deffn {Método} read (filename, strict=True)

Carga información MIME de un archivo llamado `filename'. Esto usa @ref{365d,,readfp()} para analizar el archivo.

Si `strict' es @code{True}, la información se añadirá a la lista de tipos estándar, si no a la lista de tipos no estándar.
@end deffn

@geindex readfp() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes readfp}@anchor{365d}
@deffn {Método} readfp (fp, strict=True)

Carga información de tipo MIME de un archivo abierto `fp'.  El archivo debe tener el formato de los archivos estándar @code{mime.types}.

Si `strict' es @code{True}, la información se va a añadir a la lista de tipos estándar, de otro modo se añadirá a la lista de tipos no estándar.
@end deffn

@geindex read_windows_registry() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes read_windows_registry}@anchor{3665}
@deffn {Método} read_windows_registry (strict=True)

Carga información desde el registro de Windows del tipo de metadato MIME.

@ref{1d5a,,Availability}: Windows.

Si `strict' es @code{True}, la información se va a añadir a la lista de tipos estándar, de otro modo se añadirá a la lista de tipos no estándar.


Added in version 3.2.

@end deffn

@geindex add_type() (método de mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes add_type}@anchor{3666}
@deffn {Método} add_type (type, ext, strict=True)

Añade un mapeo del tipo MIME `type' a la extensión `ext'. Cuando la extensión ya se conoce, el nuevo tipo reemplazará al antiguo. Cuando el tipo ya se conoce la extensión se añadirá a la lista de extensiones conocidas.

Cuando `strict' es @code{True} (el valor por defecto), el mapeo se añadirá a los tipos MIME oficiales, de lo contrario a los no estándar.
@end deffn
@end deffn

@node base64 — Base16 Base32 Base64 Base85 Data Encodings,binascii — Convert between binary and ASCII,mimetypes — Map filenames to MIME types,Manejo de datos de internet
@anchor{library/base64 doc}@anchor{3667}@anchor{library/base64 base64-base16-base32-base64-base85-data-encodings}@anchor{3668}@anchor{library/base64 module-base64}@anchor{f}
@subsection @code{base64} — Base16, Base32, Base64, Base85 Data Encodings


@geindex module; base64

`Código fuente:' Lib/base64.py@footnote{https://github.com/python/cpython/tree/main/Lib/base64.py}

@geindex base64;encoding
@geindex MIME;base64 encoding


__________________________________________________________________


Este módulo proporciona funciones para codificar datos binarios en caracteres ASCII imprimibles y decodificar dichas codificaciones en datos binarios. Proporciona funciones de codificación y decodificación para las codificaciones especificadas en 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}, que define los algoritmos Base16, Base32 y Base64, y para las codificaciones estándar de facto Ascii85 y Base85.

Las codificaciones 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} son adecuadas para codificar datos binarios para que puedan enviarse de forma segura por correo electrónico, usarse como parte de las URL o incluirse como parte de una solicitud HTTP POST. El algoritmo de codificación no es el mismo que el del programa @code{uuencode}.

Hay dos interfaces proporcionadas por este módulo. La interfaz moderna admite la codificación de @ref{db4,,objetos similares a bytes} a ASCII @ref{325,,bytes} y la decodificación de @ref{db4,,objetos similares a bytes} o cadenas que contienen ASCII a @ref{325,,bytes}. Se admiten los dos alfabetos base 64 definidos en 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} (normal y seguro para URL y sistema de archivos).

La interfaz heredada no admite la decodificación desde cadenas de caracteres, pero sí proporciona funciones para codificar y decodificar desde y hacia @ref{1230,,objetos de archivo}. Solo admite el alfabeto estándar Base64 y agrega nuevas líneas cada 76 caracteres según 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}. Tenga en cuenta que si está buscando soporte de 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, probablemente desee ver el paquete @ref{3c,,email} en su lugar.


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 @ref{db4,,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.


Las interfaces modernas proporcionan:

@geindex b64encode() (en el módulo base64)
@anchor{library/base64 base64 b64encode}@anchor{3669}
@deffn {Función} base64.b64encode (s, altchars=None)

Codifica el @ref{db4,,objeto similar a bytes} `s' utilizando Base64 y retorna los @ref{325,,bytes} codificados.

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

May assert or raise a @ref{360,,ValueError} if the length of `altchars' is not 2.  Raises a
@ref{228,,TypeError} if `altchars' is not a @ref{db4,,bytes-like object}.
@end deffn

@geindex b64decode() (en el módulo base64)
@anchor{library/base64 base64 b64decode}@anchor{19b0}
@deffn {Función} base64.b64decode (s, altchars=None, validate=False)

Decodifica el @ref{db4,,objeto similar a bytes} codificado en Base64 o cadena de caracteres ASCII `s' y retorna los @ref{325,,bytes} decodificados.

Optional `altchars' must be a @ref{db4,,bytes-like object} or ASCII string
of length 2 which specifies the alternative alphabet used instead of the
@code{+} and @code{/} characters.

Una excepción @ref{10a2,,binascii.Error} se lanza si `s' está incorrectamente rellenado (`padded').

Si `validate' es @code{False} (el valor predeterminado), los caracteres que no están en el alfabeto normal de base 64 ni en el alfabeto alternativo se descartan antes de la verificación del relleno. Si `validate' es @code{True}, estos caracteres no alfabéticos en la entrada dan como resultado @ref{10a2,,binascii.Error}.

Para más información sobre la verificación estricta de base64, véase @ref{1639,,binascii.a2b_base64()}

May assert or raise a @ref{360,,ValueError} if the length of `altchars' is not 2.
@end deffn

@geindex standard_b64encode() (en el módulo base64)
@anchor{library/base64 base64 standard_b64encode}@anchor{366a}
@deffn {Función} base64.standard_b64encode (s)

Codifica el @ref{db4,,objeto similar a bytes} `s' usando el alfabeto estándar Base64 y retorna los @ref{325,,bytes} codificados.
@end deffn

@geindex standard_b64decode() (en el módulo base64)
@anchor{library/base64 base64 standard_b64decode}@anchor{366b}
@deffn {Función} base64.standard_b64decode (s)

Decodifica un @ref{db4,,bytes-like object} o cadena de caracteres ASCII `s' utilizando el alfabeto estándar Base64 y retorna los @ref{325,,bytes} decodificados.
@end deffn

@geindex urlsafe_b64encode() (en el módulo base64)
@anchor{library/base64 base64 urlsafe_b64encode}@anchor{366c}
@deffn {Función} base64.urlsafe_b64encode (s)

Codifica el @ref{db4,,objeto similar a bytes} `s' usando el alfabeto seguro para URL y sistemas de archivos, que sustituye a @code{-} en lugar de @code{+} y @code{_} en lugar de @code{/} en el alfabeto estándar de Base64, y retorna los @ref{325,,bytes} codificados. El resultado aún puede contener @code{=}.
@end deffn

@geindex urlsafe_b64decode() (en el módulo base64)
@anchor{library/base64 base64 urlsafe_b64decode}@anchor{366d}
@deffn {Función} base64.urlsafe_b64decode (s)

Decodifica @ref{db4,,objeto similar a bytes} o cadena de caracteres ASCII `s' utilizando el alfabeto seguro para URL y sistema de archivos, que sustituye @code{-} en lugar de @code{+} y @code{_} en lugar de @code{/} en el alfabeto estándar de Base64, y retorna los @ref{325,,bytes} decodificados.
@end deffn

@geindex b32encode() (en el módulo base64)
@anchor{library/base64 base64 b32encode}@anchor{366e}
@deffn {Función} base64.b32encode (s)

Codifica el @ref{db4,,objeto similar a bytes} `s' utilizando Base32 y retorna los @ref{325,,bytes} codificados.
@end deffn

@geindex b32decode() (en el módulo base64)
@anchor{library/base64 base64 b32decode}@anchor{10a1}
@deffn {Función} base64.b32decode (s, casefold=False, map01=None)

Decodifica el @ref{db4,,objeto similar a bytes} codificado en Base32 o cadena de caracteres ASCII `s' y retorna los @ref{325,,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 @code{Falso}.

@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 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 @code{None}, especifica la letra a la cual el dígito 1 debería mapearse(cuando `map01' no es @code{None}, el dígito 0 siempre se asigna a la letra O). Por motivos de seguridad, el valor predeterminado es @code{None}, por lo que 0 y 1 no están permitidos en la entrada.

Una @ref{10a2,,binascii.Error} se lanza si `s' está incorrectamente rellenado (`padded') o si hay caracteres no alfabéticos presentes en la entrada.
@end deffn

@geindex b32hexencode() (en el módulo base64)
@anchor{library/base64 base64 b32hexencode}@anchor{87a}
@deffn {Función} base64.b32hexencode (s)

Similar a @ref{366e,,b32encode()} pero usa el Alfabeto Hexagonal Extendido, como se define en 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}.


Added in version 3.10.

@end deffn

@geindex b32hexdecode() (en el módulo base64)
@anchor{library/base64 base64 b32hexdecode}@anchor{87b}
@deffn {Función} base64.b32hexdecode (s, casefold=False)

Similar a @ref{10a1,,b32decode()} pero usa el Alfabeto Hexagonal Extendido, como se define en 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}.

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.

@end deffn

@geindex b16encode() (en el módulo base64)
@anchor{library/base64 base64 b16encode}@anchor{366f}
@deffn {Función} base64.b16encode (s)

Codifica el @ref{db4,,objeto similar a bytes} `s' utilizando Base16 y retorna los @ref{325,,bytes} codificados.
@end deffn

@geindex b16decode() (en el módulo base64)
@anchor{library/base64 base64 b16decode}@anchor{3670}
@deffn {Función} base64.b16decode (s, casefold=False)

Decodifica el @ref{db4,,objeto similar a bytes} codificado en Base16 o cadena de caracteres ASCII `s' y retorna los @ref{325,,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 @code{Falso}.

Una @ref{10a2,,binascii.Error} se lanza si `s' está incorrectamente rellenado (`padded') o si hay caracteres no alfabéticos presentes en la entrada.
@end deffn

@geindex a85encode() (en el módulo base64)
@anchor{library/base64 base64 a85encode}@anchor{fa0}
@deffn {Función} base64.a85encode (b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

Codifica el @ref{db4,,objeto similar a bytes} `b' utilizando Ascii85 y retorna los @ref{325,,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».

`wrapcol' controls whether the output should have newline (@code{b'\n'})
characters added to it. If this is non-zero, each output line will be
at most this many characters long, excluding the trailing newline.

`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 @code{btoa} siempre es rellenada (`pads').

`adobe' controla si la secuencia de bytes codificada está enmarcada con @code{<~} y @code{~>}, que es utilizada por la implementación de Adobe.


Added in version 3.4.

@end deffn

@geindex a85decode() (en el módulo base64)
@anchor{library/base64 base64 a85decode}@anchor{fa1}
@deffn {Función} base64.a85decode (b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

Decodifica el @ref{db4,,objeto similar a bytes} codificado en Ascii85 o cadena de caracteres ASCII `b' y retorna los @ref{325,,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' debe ser un @ref{db4,,objeto similar a byte} o cadena de caracteres ASCII que contiene caracteres para ignorar desde la entrada. Esto solo debe contener caracteres de espacio en blanco, y por defecto contiene todos los caracteres de espacio en blanco en ASCII.


Added in version 3.4.

@end deffn

@geindex b85encode() (en el módulo base64)
@anchor{library/base64 base64 b85encode}@anchor{fa2}
@deffn {Función} base64.b85encode (b, pad=False)

Codifica el @ref{db4,,objeto similar a bytes} `b' utilizando base85 (como se usa en por ejemplo, diferencias binarias de estilo git) y retorna los @ref{325,,bytes} codificados.

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


Added in version 3.4.

@end deffn

@geindex b85decode() (en el módulo base64)
@anchor{library/base64 base64 b85decode}@anchor{fa3}
@deffn {Función} base64.b85decode (b)

Decodifica el @ref{db4,,objeto similar a bytes} codificado en base85 o cadena de caracteres ASCII `b' y retorna los @ref{325,,bytes} decodificados. El relleno se elimina implícitamente, si es necesario.


Added in version 3.4.

@end deffn

@geindex z85encode() (en el módulo base64)
@anchor{library/base64 base64 z85encode}@anchor{2bc}
@deffn {Función} base64.z85encode (s)

Encode the @ref{db4,,bytes-like object} `s' using Z85 (as used in ZeroMQ)
and return the encoded @ref{325,,bytes}.  See Z85 specification@footnote{https://rfc.zeromq.org/spec/32/} for more information.


Added in version 3.13.

@end deffn

@geindex z85decode() (en el módulo base64)
@anchor{library/base64 base64 z85decode}@anchor{2bd}
@deffn {Función} base64.z85decode (s)

Decode the Z85-encoded @ref{db4,,bytes-like object} or ASCII string `s' and
return the decoded @ref{325,,bytes}.  See Z85 specification@footnote{https://rfc.zeromq.org/spec/32/} for more information.


Added in version 3.13.

@end deffn

La interfaz antigua:

@geindex decode() (en el módulo base64)
@anchor{library/base64 base64 decode}@anchor{3671}
@deffn {Función} 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 @ref{1230,,objetos archivo}. `input' se leerá hasta que @code{input.readline()} retorne un objeto de bytes vacío.
@end deffn

@geindex decodebytes() (en el módulo base64)
@anchor{library/base64 base64 decodebytes}@anchor{9e7}
@deffn {Función} base64.decodebytes (s)

Decodifica el @ref{db4,,objeto similar a bytes} `s', que debe contener una o más líneas de datos codificados en base64, y retornará los @ref{325,,bytes} decodificados.


Added in version 3.1.

@end deffn

@geindex encode() (en el módulo base64)
@anchor{library/base64 base64 encode}@anchor{3672}
@deffn {Función} 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 @ref{1230,,objetos archivos}. `input' se leerá hasta que @code{input.read()} retorna un objeto de bytes vacío. @ref{3672,,encode()} inserta un carácter de nueva línea (@code{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 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME).
@end deffn

@geindex encodebytes() (en el módulo base64)
@anchor{library/base64 base64 encodebytes}@anchor{9e6}
@deffn {Función} base64.encodebytes (s)

Codifica el @ref{db4,,objeto similar a bytes} `s', que puede contener datos binarios arbitrarios, y retorna @ref{325,,bytes} que contienen los datos codificados en base64, con líneas nuevas (@code{b'\n'}) insertado después de cada 76 bytes de salida, y asegurando que haya una nueva línea final, según 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME).


Added in version 3.1.

@end deffn

Un ejemplo de uso del módulo:

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

@menu
* Consideraciones de Seguridad:: 

@end menu

@node Consideraciones de Seguridad,,,base64 — Base16 Base32 Base64 Base85 Data Encodings
@anchor{library/base64 base64-security}@anchor{3673}@anchor{library/base64 security-considerations}@anchor{3674}
@subsubsection Consideraciones de Seguridad


Se agregó una nueva sección de consideraciones de seguridad a 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} (sección 12); se recomienda revisar la sección de seguridad para cualquier código implementado en producción.


@subsubheading Ver también



@table @asis

@item Módulo @ref{11,,binascii}

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

@geindex RFC; RFC 1521

@item RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html} - 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.
@end table


@node binascii — Convert between binary and ASCII,quopri — Encode and decode MIME quoted-printable data,base64 — Base16 Base32 Base64 Base85 Data Encodings,Manejo de datos de internet
@anchor{library/binascii doc}@anchor{3675}@anchor{library/binascii binascii-convert-between-binary-and-ascii}@anchor{3676}@anchor{library/binascii module-binascii}@anchor{11}
@subsection @code{binascii} — Convert between binary and ASCII


@geindex module; binascii

@geindex module;base64


__________________________________________________________________


The @ref{11,,binascii} module contains a number of methods to convert between
binary and various ASCII-encoded binary representations. Normally, you will not
use these functions directly but use wrapper modules like
@ref{f,,base64} instead. The @ref{11,,binascii} module contains
low-level functions written in C for greater speed that are used by the
higher-level modules.

@cartouche
@quotation Nota 
Las funciones @code{a2b_*} aceptan cadenas Unicode que contienen solo caracteres ASCII. Otras funciones solo aceptan @ref{db4,,objetos tipo binarios} (como @ref{325,,bytes}, @ref{5e0,,bytearray} y otros objetos que admiten el protocolo de búfer).


Distinto en la versión 3.3: Las cadenas unicode con sólo caracteres ASCII son ahora aceptadas por las funciones @code{a2b_*}.

@end quotation
@end cartouche

El módulo @ref{11,,binascii} define las siguientes funciones:

@geindex a2b_uu() (en el módulo binascii)
@anchor{library/binascii binascii a2b_uu}@anchor{3677}
@deffn {Función} binascii.a2b_uu (string)

Convierte una sola línea de datos uuencoded de nuevo a binarios y retorna los datos binarios. Las líneas normalmente contienen 45 bytes (binarios), excepto por la última línea. Los datos de línea pueden ir seguidos de espacios en blanco.
@end deffn

@geindex b2a_uu() (en el módulo binascii)
@anchor{library/binascii binascii b2a_uu}@anchor{bab}
@deffn {Función} binascii.b2a_uu (data, *, backtick=False)

Convierte datos binarios a una línea de caracteres ASCII, el valor retornado es la línea convertida, incluido un carácter de nueva línea. La longitud de `data' debe ser como máximo 45. Si `backtick' es verdadero, los ceros se representan mediante @code{'`'} en lugar de espacios.


Distinto en la versión 3.7: Se ha añadido el parámetro `backtick'.

@end deffn

@geindex a2b_base64() (en el módulo binascii)
@anchor{library/binascii binascii a2b_base64}@anchor{1639}
@deffn {Función} binascii.a2b_base64 (string, /, *, strict_mode=False)

Convierte un bloque de datos en base64 de nuevo a binario y retorna los datos binarios. Se puede pasar más de una línea a la vez.

Si `strict_mode' es verdadero, solo se convertirán los datos en base64 válidos. Los datos en base64 no válidos lanzarán @ref{10a2,,binascii.Error}.

base64 válido:


@itemize *

@item 
De acuerdo a 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}.

@item 
Contiene solo caracteres del alfabeto base64.

@item 
No contiene exceso de datos después del relleno (incluye el exceso de relleno, nuevas líneas, etc.).

@item 
No empieza con un relleno.
@end itemize


Distinto en la versión 3.11: Se ha añadido el parámetro `strick_mode'.

@end deffn

@geindex b2a_base64() (en el módulo binascii)
@anchor{library/binascii binascii b2a_base64}@anchor{d08}
@deffn {Función} binascii.b2a_base64 (data, *, newline=True)

Convierte datos binarios en una línea de caracteres ASCII en codificación base64. El valor retornado es la línea convertida, incluido un carácter de nueva línea si `newline' es verdadero.  La salida de esta función se ajusta a 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}.


Distinto en la versión 3.6: Se ha añadido el parámetro `newline'.

@end deffn

@geindex a2b_qp() (en el módulo binascii)
@anchor{library/binascii binascii a2b_qp}@anchor{3678}
@deffn {Función} binascii.a2b_qp (data, header=False)

Convierte un bloque de datos imprimibles entre comillas a binario y retorna los datos binarios. Se puede pasar más de una línea a la vez. Si el argumento opcional `header' está presente y es verdadero, los guiones bajos se decodificarán como espacios.
@end deffn

@geindex b2a_qp() (en el módulo binascii)
@anchor{library/binascii binascii b2a_qp}@anchor{3679}
@deffn {Función} binascii.b2a_qp (data, quotetabs=False, istext=True, header=False)

Convierte datos binarios en una(s) línea(s) de caracteres ASCII en codificación imprimible entre comillas. El valor de retorno son las líneas convertidas. Si el argumento opcional `quotetabs' está presente y es verdadero, se codificarán todas los tabs y espacios. Si el argumento opcional `istext' está presente y es verdadero, las nuevas líneas no se codifican, pero se codificarán los espacios en blanco finales. Si el argumento opcional `header' está presente y es verdadero, los espacios se codificarán como guiones bajos por: rfc: @cite{1522}. Si el argumento opcional `header' está presente y es falso, los caracteres de nueva línea también se codificarán; de lo contrario, la conversión de salto de línea podría dañar el flujo de datos binarios.
@end deffn

@geindex crc_hqx() (en el módulo binascii)
@anchor{library/binascii binascii crc_hqx}@anchor{7d0}
@deffn {Función} binascii.crc_hqx (data, value)

Calcula un valor CRC de 16 bits de `data', comenzando con `value' como el CRC inicial, y retorna el resultado. Utiliza el polinomio CRC-CCITT `x'@w{^16} + `x'@w{^12} + `x'@w{^5} + 1, a menudo representado como 0x1021. Este CRC se utiliza en el formato binhex4.
@end deffn

@geindex crc32() (en el módulo binascii)
@anchor{library/binascii binascii crc32}@anchor{16a0}
@deffn {Función} binascii.crc32 (data[, value])

Calcula CRC-32, la suma de comprobación de 32 bits de `data' que no tiene signo, comenzando con un CRC inicial de `value'. El CRC inicial predeterminado es cero. El algoritmo es consistente con la suma de verificación del archivo ZIP. Dado que el algoritmo está diseñado para usarse como un algoritmo de suma de verificación, no es adecuado para usarlo como algoritmo hash general. Úselo de la siguiente manera:

@example
print(binascii.crc32(b"hello world"))
# Or, in two pieces:
crc = binascii.crc32(b"hello")
crc = binascii.crc32(b" world", crc)
print('crc32 = @{:#010x@}'.format(crc))
@end example


Distinto en la versión 3.0: El resultado siempre es sin signo.

@end deffn

@geindex b2a_hex() (en el módulo binascii)
@geindex hexlify() (en el módulo binascii)
@anchor{library/binascii binascii b2a_hex}@anchor{2414}
@deffn {Función} binascii.b2a_hex (data[, sep[, bytes_per_sep=1]])
@anchor{library/binascii binascii hexlify}@anchor{367a}
@deffnx {Función} binascii.hexlify (data[, sep[, bytes_per_sep=1]])

Retorna la representación hexadecimal del binario `data'. Cada byte de `data' se convierte en la representación hexadecimal de 2 dígitos correspondiente. Por lo tanto, el objeto de bytes retornado es el doble de largo que la longitud de `data'.

Una funcionalidad similar (pero que retorna una cadena de texto) también es convenientemente accesible usando el método @ref{dee,,bytes.hex()}.

Si se especifica `sep', debe ser un solo carácter `str' o un objeto de bytes. Se insertará en la salida después de cada `bytes_per_sep' bytes de entrada . La ubicación del separador se cuenta desde el extremo derecho de la salida de forma predeterminada; si desea contar desde el izquierdo, proporcione un valor negativo `bytes_per_sep'.

@example
>>> import binascii
>>> binascii.b2a_hex(b'\xb9\x01\xef')
b'b901ef'
>>> binascii.hexlify(b'\xb9\x01\xef', '-')
b'b9-01-ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b'_', 2)
b'b9_01ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b' ', -2)
b'b901 ef'
@end example


Distinto en la versión 3.8: Se agregaron los parámetros `sep' y `bytes_per_sep'.

@end deffn

@geindex a2b_hex() (en el módulo binascii)
@geindex unhexlify() (en el módulo binascii)
@anchor{library/binascii binascii a2b_hex}@anchor{2415}
@deffn {Función} binascii.a2b_hex (hexstr)
@anchor{library/binascii binascii unhexlify}@anchor{1a4e}
@deffnx {Función} binascii.unhexlify (hexstr)

Retorna los datos binarios representados por la cadena hexadecimal `hexstr'.  Esta función es la inversa de @ref{2414,,b2a_hex()}. `hexstr' debe contener un número par de dígitos hexadecimales (que pueden ser mayúsculas o minúsculas), de lo contrario se produce una excepción @ref{10a2,,Error}.

Funcionalidad similar (aceptar sólo argumentos de cadena de texto, pero más liberal hacia espacios en blanco) también es accesible mediante el método de clase @ref{b7a,,bytes.fromhex()}.
@end deffn

@geindex Error
@anchor{library/binascii binascii Error}@anchor{10a2}
@deffn {Excepción} binascii.Error

Excepción provocada por errores. Estos suelen ser errores de programación.
@end deffn

@geindex Incomplete
@anchor{library/binascii binascii Incomplete}@anchor{367b}
@deffn {Excepción} binascii.Incomplete

Excepción provocada por datos incompletos. Por lo general, estos no son errores de programación, pero se pueden controlar leyendo un poco más de datos e intentándolo de nuevo.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{f,,base64}

Soporte para compatibilidad con RFC de codificación de estilo base64 en base 16, 32, 64 y 85.

@item Módulo @ref{b7,,quopri}

Soporte para codificación imprimible entre comillas utilizada en mensajes de correo electrónico MIME.
@end table


@node quopri — Encode and decode MIME quoted-printable data,,binascii — Convert between binary and ASCII,Manejo de datos de internet
@anchor{library/quopri doc}@anchor{367c}@anchor{library/quopri module-quopri}@anchor{b7}@anchor{library/quopri quopri-encode-and-decode-mime-quoted-printable-data}@anchor{367d}
@subsection @code{quopri} — Encode and decode MIME quoted-printable data


@geindex module; quopri

`Código fuente:' Lib/quopri.py@footnote{https://github.com/python/cpython/tree/main/Lib/quopri.py}

@geindex quoted-printable;encoding
@geindex MIME;quoted-printable encoding


__________________________________________________________________


Este módulo realiza la codificación y descodificación de transporte imprimible entre comillas, tal como se define en 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}: «MIME (Multipurpose Internet Mail Extensions) Parte Uno: Mecanismos para especificar y describir el formato de los cuerpos de mensajes de Internet». La codificación imprimible entre comillas está diseñada para datos donde hay relativamente pocos caracteres no imprimibles; el esquema de codificación base64 disponible a través del módulo @ref{f,,base64} es más compacto si hay muchos caracteres de este tipo, como cuando se envía un archivo gráfico.

@geindex decode() (en el módulo quopri)
@anchor{library/quopri quopri decode}@anchor{2417}
@deffn {Función} quopri.decode (input, output, header=False)

Descodificar el contenido del archivo `input' y escribir los datos binarios descodificados resultantes en el archivo `output'. `input' y `output' deben ser @ref{1230,,objetos de archivo binario}.  Si el argumento opcional `header' está presente y true, el carácter de subrayado se descodificará como espacio. Esto se utiliza para decodificar encabezados codificados en «Q» como se describe en 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}: «MIME (Multipurpose Internet Mail Extensions) Parte dos: Extensiones de encabezado de mensaje para texto no ASCII».
@end deffn

@geindex encode() (en el módulo quopri)
@anchor{library/quopri quopri encode}@anchor{2416}
@deffn {Función} quopri.encode (input, output, quotetabs, header=False)

Codifique el contenido del archivo `input' y escriba los datos imprimibles entre comillas resultantes en el archivo `output'. `input' y `output' deben ser @ref{1230,,objetos de archivo binario}. `quotetabs', un indicador no opcional que controla si codificar espacios incrustados y pestañas; cuando true codifica dicho espacio en blanco incrustado, y cuando false los deja sin codificar. Tenga en cuenta que los espacios y pestañas que aparecen al final de las líneas siempre están codificados, según 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}.  `header' es un indicador que controla si los espacios están codificados como guiones bajos según 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}.
@end deffn

@geindex decodestring() (en el módulo quopri)
@anchor{library/quopri quopri decodestring}@anchor{367e}
@deffn {Función} quopri.decodestring (s, header=False)

Como @ref{2417,,decode()}, excepto que acepta una fuente @ref{325,,bytes} y retorna el correspondiente @ref{325,,bytes} decodificado.
@end deffn

@geindex encodestring() (en el módulo quopri)
@anchor{library/quopri quopri encodestring}@anchor{367f}
@deffn {Función} quopri.encodestring (s, quotetabs=False, header=False)

Como @ref{2416,,encode()}, excepto que acepta un origen @ref{325,,bytes} y retorna el codificado correspondiente @ref{325,,bytes}. De forma predeterminada, envía un valor @code{False} al parámetro `quotetabs' de la función @ref{2416,,encode()}.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{f,,base64}

Codificar y decodificar datos MIME base64
@end table


@node Herramientas Para Procesar Formatos de Marcado Estructurado,Protocolos y soporte de Internet,Manejo de datos de internet,La biblioteca estándar de Python
@anchor{library/markup doc}@anchor{3680}@anchor{library/markup markup}@anchor{3681}@anchor{library/markup structured-markup-processing-tools}@anchor{3682}
@section Herramientas Para Procesar Formatos de Marcado Estructurado


Python soporta una variedad de módulos para trabajar con varias formas de almacenar datos de forma estructurada. Esto incluye módulos para trabajar con el Lenguaje de Marcado Estructurado General (SGML) y el Lenguaje de de Marcado de Hipertexto (HTML), y varias interfaces para trabajar con el Lenguaje de Marcado Estructurado Extensible (XML).

@menu
* html — HyperText Markup Language support:: 
* html.parser — Simple HTML and XHTML parser: html parser — Simple HTML and XHTML parser. 
* html.entities — Definitions of HTML general entities: html entities — Definitions of HTML general entities. 
* Módulos de procesamiento XML:: 
* xml.etree.ElementTree — The ElementTree XML API: xml etree ElementTree — The ElementTree XML API. 
* xml.dom — The Document Object Model API: xml dom — The Document Object Model API. 
* xml.dom.minidom — Minimal DOM implementation: xml dom minidom — Minimal DOM implementation. 
* xml.dom.pulldom — Support for building partial DOM trees: xml dom pulldom — Support for building partial DOM trees. 
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers. 
* xml.sax.handler — Base classes for SAX handlers: xml sax handler — Base classes for SAX handlers. 
* xml.sax.saxutils — SAX Utilities: xml sax saxutils — SAX Utilities. 
* xml.sax.xmlreader — Interface for XML parsers: xml sax xmlreader — Interface for XML parsers. 
* xml.parsers.expat — Fast XML parsing using Expat: xml parsers expat — Fast XML parsing using Expat. 

@end menu

@node html — HyperText Markup Language support,html parser — Simple HTML and XHTML parser,,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/html doc}@anchor{3683}@anchor{library/html html-hypertext-markup-language-support}@anchor{3684}@anchor{library/html module-html}@anchor{6b}
@subsection @code{html} — HyperText Markup Language support


@geindex module; html

`Código fuente:' Lib/html/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/html/__init__.py}


__________________________________________________________________


Este módulo define utilidades para manipular HTML.

@geindex escape() (en el módulo html)
@anchor{library/html html escape}@anchor{108a}
@deffn {Función} html.escape (s, quote=True)

Convierte los caracteres @code{&}, @code{<} y @code{>} de la cadena de caracteres `s' en secuencias seguras HTML.  Utilízalo si necesitas mostrar texto que pueda contener tales caracteres en HTML.  Si el flag opcional `quote' es true, también se traducen los caracteres (@code{"}) y (@code{'}); esto ayuda a la inserción en el valor de un atributo HTML delimitado por comillas, como en @code{<a href="...">}.


Added in version 3.2.

@end deffn

@geindex unescape() (en el módulo html)
@anchor{library/html html unescape}@anchor{9ea}
@deffn {Función} html.unescape (s)

Convierte todas las referencias de caracteres numéricos y con nombre (por ejemplo @code{&gt;}, @code{&#62;}, @code{&#x3e;}) de la cadena de caracteres `s' a los caracteres Unicode correspondientes.  Esta función utiliza las reglas definidas por el estándar HTML 5 para las referencias de caracteres válidas e inválidas, y la @ref{1146,,lista de referencia de caracteres con nombre de HTML 5}.


Added in version 3.4.

@end deffn


__________________________________________________________________


Los submódulos del paquete @code{html} son:


@itemize *

@item 
@ref{6d,,html.parser} – Analizador sintáctico simple de HTML y XHTML

@item 
@ref{6c,,html.entities} – Definición general de entidades HTML
@end itemize

@node html parser — Simple HTML and XHTML parser,html entities — Definitions of HTML general entities,html — HyperText Markup Language support,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/html parser doc}@anchor{3685}@anchor{library/html parser html-parser-simple-html-and-xhtml-parser}@anchor{3686}@anchor{library/html parser module-html parser}@anchor{6d}
@subsection @code{html.parser} — Simple HTML and XHTML parser


@geindex module; html.parser

`Código fuente:' Lib/html/parser.py@footnote{https://github.com/python/cpython/tree/main/Lib/html/parser.py}

@geindex HTML
@geindex XHTML


__________________________________________________________________


Este módulo define una clase @ref{90e,,HTMLParser} que sirve como base para analizar archivos de texto formateados en HTML (`HyperText Mark-up Language') y XHTML.

@geindex HTMLParser (clase en html.parser)
@anchor{library/html parser html parser HTMLParser}@anchor{90e}
@deffn {Clase} html.parser.HTMLParser (*, convert_charrefs=True)

Cree una instancia de analizador capaz de analizar marcado no válido.

Si `convert_charrefs' es @code{True} (el valor predeterminado), todas las referencias de caracteres (excepto las de los elementos @code{script}/@code{style}) se convierten automáticamente en los caracteres Unicode correspondientes.

Una instancia de @ref{90e,,HTMLParser} se alimenta de datos HTML y llama a métodos de manejo cuando se encuentran etiquetas de inicio, etiquetas finales, texto, comentarios y otros elementos de marcado. El usuario debe subclasificar @ref{90e,,HTMLParser} y anular sus métodos para implementar el comportamiento deseado.

Este analizador no verifica que las etiquetas finales coincidan con las etiquetas iniciales ni llame al manejador de etiquetas finales para los elementos que se cierran implícitamente al cerrar un elemento externo.


Distinto en la versión 3.4: argumento de palabra clave `convert_charrefs' agregado.



Distinto en la versión 3.5: El valor predeterminado para el argumento `convert_charrefs' ahora es @code{True}.

@end deffn

@menu
* Aplicación ejemplo de un analizador sintáctico (parser) de HTML: Aplicación ejemplo de un analizador sintáctico parser de HTML. 
* Métodos HTMLParser:: 
* Ejemplos: Ejemplos<22>. 

@end menu

@node Aplicación ejemplo de un analizador sintáctico parser de HTML,Métodos HTMLParser,,html parser — Simple HTML and XHTML parser
@anchor{library/html parser example-html-parser-application}@anchor{3687}
@subsubsection Aplicación ejemplo de un analizador sintáctico (`parser') de HTML


Como ejemplo básico, a continuación hay un analizador HTML simple que usa la clase @ref{90e,,HTMLParser} para imprimir etiquetas de inicio, etiquetas finales y datos a medida que se encuentran:

@example
from html.parser import HTMLParser

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Encountered a start tag:", tag)

    def handle_endtag(self, tag):
        print("Encountered an end tag :", tag)

    def handle_data(self, data):
        print("Encountered some data  :", data)

parser = MyHTMLParser()
parser.feed('<html><head><title>Test</title></head>'
            '<body><h1>Parse me!</h1></body></html>')
@end example

La salida será entonces:

@example
Encountered a start tag: html
Encountered a start tag: head
Encountered a start tag: title
Encountered some data  : Test
Encountered an end tag : title
Encountered an end tag : head
Encountered a start tag: body
Encountered a start tag: h1
Encountered some data  : Parse me!
Encountered an end tag : h1
Encountered an end tag : body
Encountered an end tag : html
@end example

@node Métodos HTMLParser,Ejemplos<22>,Aplicación ejemplo de un analizador sintáctico parser de HTML,html parser — Simple HTML and XHTML parser
@anchor{library/html parser htmlparser-methods}@anchor{3688}
@subsubsection Métodos @code{HTMLParser}


instancias de @ref{90e,,HTMLParser} tienen los siguientes métodos:

@geindex feed() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser feed}@anchor{3689}
@deffn {Método} HTMLParser.feed (data)

Alimente un poco de texto al analizador. Se procesa en la medida en que consta de elementos completos; los datos incompletos se almacenan en el búfer hasta que se introducen más datos o se llama a @ref{368a,,close()}. `data' debe ser @ref{237,,str}.
@end deffn

@geindex close() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser close}@anchor{368a}
@deffn {Método} HTMLParser.close ()

Fuerce el procesamiento de todos los datos almacenados como si fueran seguidos por una marca de fin de archivo. Este método puede ser redefinido por una clase derivada para definir un procesamiento adicional al final de la entrada, pero la versión redefinida siempre debe llamar a @ref{90e,,HTMLParser} método de clase base @ref{368a,,close()}.
@end deffn

@geindex reset() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser reset}@anchor{368b}
@deffn {Método} HTMLParser.reset ()

Restablecer la instancia. Pierde todos los datos no procesados. Esto se llama implícitamente en el momento de la instanciación.
@end deffn

@geindex getpos() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser getpos}@anchor{368c}
@deffn {Método} HTMLParser.getpos ()

Retorna el número de línea actual y el desplazamiento.
@end deffn

@geindex get_starttag_text() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser get_starttag_text}@anchor{368d}
@deffn {Método} HTMLParser.get_starttag_text ()

Retorna el texto de la etiqueta de inicio abierta más recientemente. Normalmente, esto no debería ser necesario para el procesamiento estructurado, pero puede ser útil para tratar con HTML «como implementado» o para volver a generar entradas con cambios mínimos (se puede preservar el espacio en blanco entre los atributos, etc.).
@end deffn

Los siguientes métodos se invocan cuando se encuentran datos o elementos de marcado y deben anularse en una subclase. Las implementaciones de la clase base no hacen nada (excepto @ref{368e,,handle_startendtag()}):

@geindex handle_starttag() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_starttag}@anchor{368f}
@deffn {Método} HTMLParser.handle_starttag (tag, attrs)

This method is called to handle the start tag of an element (e.g. @code{<div id="main">}).

El argumento `tag' es el nombre de la etiqueta convertida a minúsculas. El argumento `attrs' es una lista de pares @code{(nombre, valor)} que contienen los atributos encontrados dentro de los corchetes @code{<>} de la etiqueta. El `name' se traducirá a minúsculas, se eliminarán las comillas en el `value' y se reemplazarán las referencias de caracteres y entidades.

Por ejemplo, para la etiqueta @code{<A HREF="https://www.cwi.nl/">}, este método se llamaría como @code{handle_starttag('a', [('href', 'https : //www.cwi.nl/ ')])}.

Todas las referencias de entidad de @ref{6c,,html.entities} se reemplazan en los valores de los atributos.
@end deffn

@geindex handle_endtag() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_endtag}@anchor{3690}
@deffn {Método} HTMLParser.handle_endtag (tag)

Este método se llama para manejar la etiqueta final de un elemento (por ejemplo, @code{</div>})

El argumento `tag' es el nombre de la etiqueta convertida a minúsculas.
@end deffn

@geindex handle_startendtag() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_startendtag}@anchor{368e}
@deffn {Método} HTMLParser.handle_startendtag (tag, attrs)

Similar a @ref{368f,,handle_starttag()}, pero llamado cuando el analizador encuentra una etiqueta vacía de estilo XHTML (@code{<img .../>}). Este método puede ser anulado por subclases que requieren esta información léxica particular; la implementación predeterminada simplemente llama @ref{368f,,handle_starttag()} y @ref{3690,,handle_endtag()}.
@end deffn

@geindex handle_data() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_data}@anchor{3691}
@deffn {Método} HTMLParser.handle_data (data)

Este método se llama para procesar datos arbitrarios (por ejemplo, nodos de texto y el contenido de @code{<script>...</script>} y @code{<style>...</style>}).
@end deffn

@geindex handle_entityref() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_entityref}@anchor{3692}
@deffn {Método} HTMLParser.handle_entityref (name)

Este método se llama para procesar una referencia de caracteres con nombre del formulario @code{&name;} (por ejemplo, @code{&gt;}), donde `name' es una referencia de entidad general (por ejemplo, @code{'gt'}). Este método nunca se llama si `convert_charrefs' es @code{True}.
@end deffn

@geindex handle_charref() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_charref}@anchor{3693}
@deffn {Método} HTMLParser.handle_charref (name)

This method is called to process decimal and hexadecimal numeric character
references of the form @code{&#@var{NNN};} and @code{&#x@var{NNN};}.  For example, the decimal
equivalent for @code{&gt;} is @code{&#62;}, whereas the hexadecimal is @code{&#x3E;};
in this case the method will receive @code{'62'} or @code{'x3E'}.  This method
is never called if `convert_charrefs' is @code{True}.
@end deffn

@geindex handle_comment() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_comment}@anchor{3694}
@deffn {Método} HTMLParser.handle_comment (data)

Este método se llama cuando se encuentra un comentario (por ejemplo, @code{<!--comment-->}).

Por ejemplo, el comentario @code{<! - comment ->} hará que se llame a este método con el argumento @code{'comment'}.

El contenido de los comentarios condicionales de Internet Explorer (`condcoms') también se enviará a este método, por lo tanto, para @code{<!--[if IE 9]>IE9-specific content<![endif]-->}, este método recibirá @code{'[if IE 9]>IE9-specific content<![endif]'}.
@end deffn

@geindex handle_decl() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_decl}@anchor{3695}
@deffn {Método} HTMLParser.handle_decl (decl)

Este método se llama para manejar una declaración de tipo de documento HTML (por ejemplo, @code{<!DOCTYPE html>}).

El parámetro `decl' será todo el contenido de la declaración dentro del @code{<!...>} `markup' (por ejemplo, @code{'DOCTYPE html'}).
@end deffn

@geindex handle_pi() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_pi}@anchor{3696}
@deffn {Método} HTMLParser.handle_pi (data)

Método llamado cuando se encuentra una instrucción de procesamiento. El parámetro `data' contendrá toda la instrucción de procesamiento. Por ejemplo, para la instrucción de procesamiento @code{<?proc color='red'>}, este método se llamaría como @code{handle_pi("proc color='red'")}. Está destinado a ser anulado por una clase derivada; La implementación de la clase base no hace nada.

@cartouche
@quotation Nota 
La clase @ref{90e,,HTMLParser} utiliza las reglas sintácticas SGML para procesar instrucciones. Una instrucción de procesamiento XHTML que use el @code{'?'} final hará que se incluya el @code{'?'} en `data'.
@end quotation
@end cartouche
@end deffn

@geindex unknown_decl() (método de html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser unknown_decl}@anchor{3697}
@deffn {Método} HTMLParser.unknown_decl (data)

Se llama a este método cuando el analizador lee una declaración no reconocida.

El parámetro `data' será el contenido completo de la declaración dentro del marcado @code{<! [...]>}. A veces es útil ser reemplazado por una clase derivada. La implementación de la clase base no hace nada.
@end deffn

@node Ejemplos<22>,,Métodos HTMLParser,html parser — Simple HTML and XHTML parser
@anchor{library/html parser examples}@anchor{3698}@anchor{library/html parser htmlparser-examples}@anchor{3699}
@subsubsection Ejemplos


La siguiente clase implementa un analizador que se utilizará para ilustrar más ejemplos:

@example
from html.parser import HTMLParser
from html.entities import name2codepoint

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Start tag:", tag)
        for attr in attrs:
            print("     attr:", attr)

    def handle_endtag(self, tag):
        print("End tag  :", tag)

    def handle_data(self, data):
        print("Data     :", data)

    def handle_comment(self, data):
        print("Comment  :", data)

    def handle_entityref(self, name):
        c = chr(name2codepoint[name])
        print("Named ent:", c)

    def handle_charref(self, name):
        if name.startswith('x'):
            c = chr(int(name[1:], 16))
        else:
            c = chr(int(name))
        print("Num ent  :", c)

    def handle_decl(self, data):
        print("Decl     :", data)

parser = MyHTMLParser()
@end example

Analizando un `doctype':

@example
>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
...             '"http://www.w3.org/TR/html4/strict.dtd">')
Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"
@end example

Analizando un elemento con algunos atributos y un título:

@example
>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
Start tag: img
     attr: ('src', 'python-logo.png')
     attr: ('alt', 'The Python logo')
>>>
>>> parser.feed('<h1>Python</h1>')
Start tag: h1
Data     : Python
End tag  : h1
@end example

El contenido de los elementos @code{script} y @code{style} se retorna tal cual, sin más análisis

@example
>>> parser.feed('<style type="text/css">#python @{ color: green @}</style>')
Start tag: style
     attr: ('type', 'text/css')
Data     : #python @{ color: green @}
End tag  : style

>>> parser.feed('<script type="text/javascript">'
...             'alert("<strong>hello!</strong>");</script>')
Start tag: script
     attr: ('type', 'text/javascript')
Data     : alert("<strong>hello!</strong>");
End tag  : script
@end example

Analizando comentarios:

@example
>>> parser.feed('<!-- a comment -->'
...             '<!--[if IE 9]>IE-specific content<![endif]-->')
Comment  :  a comment
Comment  : [if IE 9]>IE-specific content<![endif]
@end example

Analizar referencias de caracteres con nombre y numéricos y convertirlos al carácter correcto (nota: estas 3 referencias son todas equivalentes a @code{'>'}):

@example
>>> parser.feed('&gt;&#62;&#x3E;')
Named ent: >
Num ent  : >
Num ent  : >
@end example

La alimentación de fragmentos incompletos a @ref{3689,,feed()} funciona, pero @ref{3691,,handle_data()} podría llamarse más de una vez (a menos que `convert_charrefs' esté configurado como @code{True}):

@example
>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:
...     parser.feed(chunk)
...
Start tag: span
Data     : buff
Data     : ered
Data     : text
End tag  : span
@end example

Analizar HTML no válido (por ejemplo, atributos sin comillas) también funciona:

@example
>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
Start tag: p
Start tag: a
     attr: ('class', 'link')
     attr: ('href', '#main')
Data     : tag soup
End tag  : p
End tag  : a
@end example

@node html entities — Definitions of HTML general entities,Módulos de procesamiento XML,html parser — Simple HTML and XHTML parser,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/html entities doc}@anchor{369a}@anchor{library/html entities html-entities-definitions-of-html-general-entities}@anchor{369b}@anchor{library/html entities module-html entities}@anchor{6c}
@subsection @code{html.entities} — Definitions of HTML general entities


@geindex module; html.entities

`Código fuente:' Lib/html/entities.py@footnote{https://github.com/python/cpython/tree/main/Lib/html/entities.py}


__________________________________________________________________


Este módulo define cuatro diccionarios @ref{1146,,html5}, @ref{369c,,name2codepoint}, @ref{369d,,codepoint2name}, y @ref{369e,,entitydefs}

@geindex html5 (en el módulo html.entities)
@anchor{library/html entities html entities html5}@anchor{1146}
@deffn {Dato} html.entities.html5

Un diccionario que asigna referencias de caracteres con nombre HTML5 @footnote{
See @indicateurl{https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references}
} a los caracteres Unicode equivalentes, p. Ej. @code{html5['gt;'] == '>'}. Tenga en cuenta que el punto y coma al final está incluido en el nombre (por ejemplo, @code{'gt;'}), sin embargo, algunos de los nombres son aceptados por el estándar incluso sin el punto y coma: en este caso, el nombre está presente con y sin el @code{';'}. Consulte también @ref{9ea,,html.unescape()}.


Added in version 3.3.

@end deffn

@geindex entitydefs (en el módulo html.entities)
@anchor{library/html entities html entities entitydefs}@anchor{369e}
@deffn {Dato} html.entities.entitydefs

Un diccionario que asigna definiciones de entidad XHTML 1.0 a su texto de reemplazo en ISO Latin-1.
@end deffn

@geindex name2codepoint (en el módulo html.entities)
@anchor{library/html entities html entities name2codepoint}@anchor{369c}
@deffn {Dato} html.entities.name2codepoint

A dictionary that maps HTML4 entity names to the Unicode code points.
@end deffn

@geindex codepoint2name (en el módulo html.entities)
@anchor{library/html entities html entities codepoint2name}@anchor{369d}
@deffn {Dato} html.entities.codepoint2name

A dictionary that maps Unicode code points to HTML4 entity names.
@end deffn

@subsubheading Notas al pie


@node Módulos de procesamiento XML,xml etree ElementTree — The ElementTree XML API,html entities — Definitions of HTML general entities,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml doc}@anchor{369f}@anchor{library/xml module-xml}@anchor{120}@anchor{library/xml xml}@anchor{36a0}@anchor{library/xml xml-processing-modules}@anchor{36a1}
@subsection Módulos de procesamiento XML


@geindex module; xml

`Código fuente:' Lib/xml/@footnote{https://github.com/python/cpython/tree/main/Lib/xml/}


__________________________________________________________________


Las interfaces de Python para procesar XML están agrupadas en el paquete @code{xml}.

@cartouche
@quotation Advertencia 
Los módulos XML no son seguros contra datos construidos errónea o maliciosamente. Si necesita analizar datos que no son de confianza o no autenticados, consulte las secciones @ref{36a2,,Vulnerabilidades XML} y @ref{36a3,,El paquete defusedxml}.
@end quotation
@end cartouche

Es importante tener en cuenta que los módulos del paquete @ref{120,,xml} requieren que haya al menos un analizador XML compatible con SAX disponible. El analizador Expat se incluye con Python, por lo que el módulo @ref{126,,xml.parsers.expat} siempre estará disponible.

La documentación de los paquetes @ref{121,,xml.dom} y @ref{129,,xml.sax} es la definición de los enlaces de Python para las interfaces DOM y SAX.

Los submódulos de manejo de XML son:


@itemize *

@item 
@ref{125,,xml.etree.ElementTree}: la API ElementTree, un procesador de XML simple y ligero
@end itemize



@itemize *

@item 
@ref{121,,xml.dom}: la definición de la API DOM

@item 
@ref{122,,xml.dom.minidom}: una implementación mínima de DOM

@item 
@ref{123,,xml.dom.pulldom}: soporte para la construcción de árboles DOM parciales
@end itemize



@itemize *

@item 
@ref{129,,xml.sax}: clases base SAX2 y funciones de conveniencia

@item 
@ref{126,,xml.parsers.expat}: el enlace del analizador Expat
@end itemize

@menu
* Vulnerabilidades XML:: 
* El paquete defusedxml:: 

@end menu

@node Vulnerabilidades XML,El paquete defusedxml,,Módulos de procesamiento XML
@anchor{library/xml id1}@anchor{36a4}@anchor{library/xml xml-vulnerabilities}@anchor{36a2}
@subsubsection Vulnerabilidades XML


Los módulos de procesamiento XML no son seguros contra datos construidos malintencionadamente. Un atacante puede abusar de las características XML para llevar a cabo ataques de denegación de servicio, acceder a archivos locales, generar conexiones de red a otras máquinas o eludir firewalls.

En la tabla siguiente se ofrece una visión general de los ataques conocidos y si los distintos módulos son vulnerables a ellos.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

tipo

@tab

sax

@tab

etree

@tab

minidom

@tab

pulldom

@tab

xmlrpc

@item

mil millones de risas

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@item

explosión cuadrática

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@tab

`Vulnerable' (1)

@item

expansión de entidad externa

@tab

Seguro (5)

@tab

Seguro (2)

@tab

Seguro (3)

@tab

Seguro (5)

@tab

Seguro (4)

@item

Recuperación de DTD@footnote{https://en.wikipedia.org/wiki/Document_type_definition}

@tab

Seguro (5)

@tab

Seguro

@tab

Seguro

@tab

Seguro (5)

@tab

Seguro

@item

bomba de descompresión

@tab

Seguro

@tab

Seguro

@tab

Seguro

@tab

Seguro

@tab

`Vulnerable'

@item

large tokens

@tab

`Vulnerable' (6)

@tab

`Vulnerable' (6)

@tab

`Vulnerable' (6)

@tab

`Vulnerable' (6)

@tab

`Vulnerable' (6)

@end multitable



@enumerate 

@item 
Expat 2.4.1 and newer is not vulnerable to the «billion laughs» and
«quadratic blowup» vulnerabilities. Items still listed as vulnerable due to
potential reliance on system-provided libraries. Check
@code{pyexpat.EXPAT_VERSION}.

@item 
@ref{125,,xml.etree.ElementTree} no expande entidades externas y lanza un @code{ParserError} cuando se produce una entidad.

@item 
@ref{122,,xml.dom.minidom} no expande entidades externas y simplemente retorna la entidad no expandida literalmente.

@item 
@ref{12d,,xmlrpc.client} no expande entidades externas y las omite.

@item 
Desde Python 3.7.1, las entidades generales externas ya no se procesan de forma predeterminada.

@item 
Expat 2.6.0 and newer is not vulnerable to denial of service
through quadratic runtime caused by parsing large tokens.
Items still listed as vulnerable due to
potential reliance on system-provided libraries. Check
@code{pyexpat.EXPAT_VERSION}.
@end enumerate


@table @asis

@item mil millones de risas / expansión exponencial de entidad

El ataque Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs}, también conocido como expansión exponencial de entidades, utiliza varios niveles de entidades anidadas. Cada entidad hace referencia a otra entidad varias veces y la definición de entidad final contiene una cadena pequeña. La expansión exponencial da como resultado varios gigabytes de texto y consume mucha memoria y tiempo de CPU.

@item expansión de entidad de explosión cuadrática

Un ataque de explosión cuadrática es similar a un ataque de Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs}; también abusa de la expansión de entidad. En lugar de entidades anidadas, repite una entidad grande con un par de miles de caracteres una y otra vez. El ataque no es tan eficaz como el caso exponencial, pero evita desencadenar contramedidas del analizador que prohíben entidades profundamente anidadas.

@item expansión de entidad externa

Las declaraciones de entidad pueden contener algo más que texto para su reemplazo. También pueden apuntar a recursos externos o archivos locales. El analizador XML tiene acceso al recurso e incrusta el contenido en el documento XML.

@item Recuperación de DTD@footnote{https://en.wikipedia.org/wiki/Document_type_definition}

Algunas bibliotecas XML como @ref{123,,xml.dom.pulldom} de Python recuperan definiciones de tipo de documento de ubicaciones remotas o locales. La característica tiene implicaciones similares a las del problema de expansión de entidades externas.

@item bomba de descompresión

Las bombas de descompresión (también conocidas como ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}) se aplican a todas las bibliotecas XML que pueden analizar secuencias XML comprimidas, como secuencias HTTP comprimidas con gzip o archivos comprimidos por LZMA. Para un atacante puede reducir la cantidad de datos transmitidos en magnitudes de tres o más.

@item large tokens

Expat needs to re-parse unfinished tokens; without the protection
introduced in Expat 2.6.0, this can lead to quadratic runtime that can
be used to cause denial of service in the application parsing XML.
The issue is known as 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}.
@end table

The documentation for defusedxml@footnote{https://pypi.org/project/defusedxml/} on PyPI has further information about
all known attack vectors with examples and references.

@node El paquete defusedxml,,Vulnerabilidades XML,Módulos de procesamiento XML
@anchor{library/xml defusedxml-package}@anchor{36a3}@anchor{library/xml the-defusedxml-package}@anchor{36a5}
@subsubsection El paquete @code{defusedxml}


defusedxml@footnote{https://pypi.org/project/defusedxml/} is a pure Python package with modified subclasses of all stdlib
XML parsers that prevent any potentially malicious operation. Use of this
package is recommended for any server code that parses untrusted XML data. The
package also ships with example exploits and extended documentation on more
XML exploits such as XPath injection.

@node xml etree ElementTree — The ElementTree XML API,xml dom — The Document Object Model API,Módulos de procesamiento XML,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml etree elementtree doc}@anchor{36a6}@anchor{library/xml etree elementtree module-xml etree ElementTree}@anchor{125}@anchor{library/xml etree elementtree xml-etree-elementtree-the-elementtree-xml-api}@anchor{36a7}
@subsection @code{xml.etree.ElementTree} — The ElementTree XML API


@geindex module; xml.etree.ElementTree

`Código fuente:' Lib/xml/etree/ElementTree.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/etree/ElementTree.py}


__________________________________________________________________


El módulo @ref{125,,xml.etree.ElementTree} implementa una API simple y eficiente para parsear y crear datos XML.


Distinto en la versión 3.3: Este módulo utilizará una implementación rápida siempre que esté disponible.



Obsoleto desde la versión 3.3: The @code{xml.etree.cElementTree} module is deprecated.


@cartouche
@quotation Advertencia 
El módulo @ref{125,,xml.etree.ElementTree} no es seguro contra datos construidos maliciosamente. Si necesita parsear datos no fiables o no autentificados, vea @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche

@menu
* Tutorial: Tutorial<2>. 
* Soporte de XPath:: 
* Referencia: Referencia<3>. 
* Soporte de XInclude:: 
* Referencia: Referencia<4>. 

@end menu

@node Tutorial<2>,Soporte de XPath,,xml etree ElementTree — The ElementTree XML API
@anchor{library/xml etree elementtree tutorial}@anchor{36a8}
@subsubsection Tutorial


Este es un tutorial corto para usar @ref{125,,xml.etree.ElementTree} (@code{ET} en resumen). El objetivo es demostrar algunos de los componentes y conceptos básicos del módulo.

@menu
* Árbol y elementos XML:: 
* Procesando XML:: 
* API de consulta para un procesamiento no bloqueante:: 
* Encontrando elementos interesantes:: 
* Modificando un archivo XML:: 
* Construyendo documentos XML:: 
* Procesando XML con espacio de nombres:: 

@end menu

@node Árbol y elementos XML,Procesando XML,,Tutorial<2>
@anchor{library/xml etree elementtree xml-tree-and-elements}@anchor{36a9}
@subsubsection Árbol y elementos XML


XML es un formato de datos inherentemente jerárquico, y la forma más natural de representarlo es con un árbol. @code{ET} tiene dos clases para este propósito - @ref{9e1,,ElementTree} representa todo el documento XML como un árbol, y @ref{20b,,Element} representa un solo nodo en este árbol. Las interacciones con todo el documento (leer y escribir en/desde archivos) se realizan normalmente en el nivel de @ref{9e1,,ElementTree}. Las interacciones con un solo elemento XML y sus sub-elementos se realizan en el nivel @ref{20b,,Element}.

@node Procesando XML,API de consulta para un procesamiento no bloqueante,Árbol y elementos XML,Tutorial<2>
@anchor{library/xml etree elementtree elementtree-parsing-xml}@anchor{36aa}@anchor{library/xml etree elementtree parsing-xml}@anchor{36ab}
@subsubsection Procesando XML


We’ll be using the fictive @code{country_data.xml} XML document as the sample data for this section:

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank>1</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank>4</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
    <country name="Panama">
        <rank>68</rank>
        <year>2011</year>
        <gdppc>13600</gdppc>
        <neighbor name="Costa Rica" direction="W"/>
        <neighbor name="Colombia" direction="E"/>
    </country>
</data>
@end example

Podemos importar estos datos leyendo desde un archivo:

@example
import xml.etree.ElementTree as ET
tree = ET.parse('country_data.xml')
root = tree.getroot()
@end example

O directamente desde una cadena de caracteres:

@example
root = ET.fromstring(country_data_as_string)
@end example

@ref{36ac,,fromstring()} analiza el XML de una cadena de caracteres directamente en un @ref{20b,,Element}, que es el elemento raíz del árbol analizado. Otras funciones de análisis pueden crear un @ref{9e1,,ElementTree}. Compruebe la documentación para estar seguro.

Como un @ref{20b,,Element}, @code{root} tiene una etiqueta y un diccionario de atributos:

@example
>>> root.tag
'data'
>>> root.attrib
@{@}
@end example

También tiene nodos hijos sobre los cuales podemos iterar:

@example
>>> for child in root:
...     print(child.tag, child.attrib)
...
country @{'name': 'Liechtenstein'@}
country @{'name': 'Singapore'@}
country @{'name': 'Panama'@}
@end example

Los hijos están anidados, y podemos acceder a nodos hijos específicos por el índice:

@example
>>> root[0][1].text
'2008'
@end example

@cartouche
@quotation Nota 
No todos los elementos de la entrada XML acabarán siendo elementos del árbol analizado. Actualmente, este módulo omite cualquier comentario XML, instrucciones de procesamiento y declaraciones de tipo documento en la entrada. Sin embargo, los árboles construidos utilizando la API de este módulo, en lugar de analizar el texto XML, pueden contener comentarios e instrucciones de procesamiento, que se incluirán al generar la salida XML. Se puede acceder a una declaración de tipo documento pasando una instancia @ref{ae6,,TreeBuilder} personalizada al constructor @ref{ae5,,XMLParser}.
@end quotation
@end cartouche

@node API de consulta para un procesamiento no bloqueante,Encontrando elementos interesantes,Procesando XML,Tutorial<2>
@anchor{library/xml etree elementtree elementtree-pull-parsing}@anchor{1071}@anchor{library/xml etree elementtree pull-api-for-non-blocking-parsing}@anchor{36ad}
@subsubsection API de consulta para un procesamiento no bloqueante


La mayoría de las funciones de análisis proporcionadas por este módulo requieren que se lea todo el documento a la vez antes de retornar cualquier resultado. Es posible utilizar un @ref{ae5,,XMLParser} y alimentar los datos en él de forma incremental, pero se trata de una `push' API que llama a métodos en un objetivo invocable, que es demasiado bajo nivel e inconveniente para la mayoría de las necesidades. A veces, lo que el usuario realmente quiere es ser capaz de analizar XML de forma incremental, sin bloquear las operaciones, mientras disfruta de la comodidad de los objetos @ref{20b,,Element} totalmente construidos.

La herramienta más potente para hacer esto es @ref{1070,,XMLPullParser}. No requiere una lectura de bloqueo para obtener los datos XML, y en su lugar se alimenta de datos de forma incremental con llamadas a @ref{36ae,,XMLPullParser.feed()}. Para obtener los elementos XML analizados, llama a @ref{36af,,XMLPullParser.read_events()}. He aquí un ejemplo:

@example
>>> parser = ET.XMLPullParser(['start', 'end'])
>>> parser.feed('<mytag>sometext')
>>> list(parser.read_events())
[('start', <Element 'mytag' at 0x7fa66db2be58>)]
>>> parser.feed(' more text</mytag>')
>>> for event, elem in parser.read_events():
...     print(event)
...     print(elem.tag, 'text=', elem.text)
...
end
mytag text= sometext more text
@end example

El caso de uso obvio es el de las aplicaciones que operan de forma no bloqueante, donde los datos XML se reciben de un socket o se leen de forma incremental desde algún dispositivo de almacenamiento. En estos casos, las lecturas bloqueantes son inaceptables.

Debido a su flexibilidad, @ref{1070,,XMLPullParser} puede ser un inconveniente para los casos de uso más simples. Si no te importa que tu aplicación se bloquee en la lectura de datos XML pero te gustaría tener capacidades de análisis incremental, echa un vistazo a @ref{3ca,,iterparse()}. Puede ser útil cuando estás leyendo un documento XML grande y no quieres mantenerlo completamente en memoria.

Where `immediate' feedback through events is wanted, calling method
@ref{3c7,,XMLPullParser.flush()} can help reduce delay;
please make sure to study the related security notes.

@node Encontrando elementos interesantes,Modificando un archivo XML,API de consulta para un procesamiento no bloqueante,Tutorial<2>
@anchor{library/xml etree elementtree finding-interesting-elements}@anchor{36b0}
@subsubsection Encontrando elementos interesantes


@ref{20b,,Element} tiene algunos métodos útiles que ayudan a iterar recursivamente sobre todo el sub-árbol por debajo de él (sus hijos, los hijos de sus hijos, y así sucesivamente). Por ejemplo, @ref{13b7,,Element.iter()}:

@example
>>> for neighbor in root.iter('neighbor'):
...     print(neighbor.attrib)
...
@{'name': 'Austria', 'direction': 'E'@}
@{'name': 'Switzerland', 'direction': 'W'@}
@{'name': 'Malaysia', 'direction': 'N'@}
@{'name': 'Costa Rica', 'direction': 'W'@}
@{'name': 'Colombia', 'direction': 'E'@}
@end example

@ref{36b1,,Element.findall()} encuentra sólo los elementos con una etiqueta que son hijos directos del elemento actual. @ref{36b2,,Element.find()} encuentra el `primer' hijo con una etiqueta determinada, y @ref{36b3,,Element.text} accede al contenido de texto del elemento. @ref{36b4,,Element.get()} accede a los atributos del elemento:

@example
>>> for country in root.findall('country'):
...     rank = country.find('rank').text
...     name = country.get('name')
...     print(name, rank)
...
Liechtenstein 1
Singapore 4
Panama 68
@end example

Es posible especificar de forma más sofisticada qué elementos buscar utilizando @ref{c35,,XPath}.

@node Modificando un archivo XML,Construyendo documentos XML,Encontrando elementos interesantes,Tutorial<2>
@anchor{library/xml etree elementtree modifying-an-xml-file}@anchor{36b5}
@subsubsection Modificando un archivo XML


@ref{9e1,,ElementTree} proporciona una forma sencilla de construir documentos XML y escribirlos en archivos. El método @ref{13b5,,ElementTree.write()} sirve para este propósito.

Una vez creado, un objeto @ref{20b,,Element} puede ser manipulado cambiando directamente sus campos (como @ref{36b3,,Element.text}), añadiendo y modificando atributos (método @ref{36b6,,Element.set()}), así como añadiendo nuevos hijos (por ejemplo con @ref{36b7,,Element.append()}).

Digamos que queremos añadir uno al rango de cada país, y añadir un atributo @code{updated} al elemento rango:

@example
>>> for rank in root.iter('rank'):
...     new_rank = int(rank.text) + 1
...     rank.text = str(new_rank)
...     rank.set('updated', 'yes')
...
>>> tree.write('output.xml')
@end example

Nuestro XML tiene ahora este aspecto:

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank updated="yes">2</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank updated="yes">5</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
    <country name="Panama">
        <rank updated="yes">69</rank>
        <year>2011</year>
        <gdppc>13600</gdppc>
        <neighbor name="Costa Rica" direction="W"/>
        <neighbor name="Colombia" direction="E"/>
    </country>
</data>
@end example

Podemos eliminar elementos utilizando @ref{36b8,,Element.remove()}. Digamos que queremos eliminar todos los países con un rango superior a 50:

@example
>>> for country in root.findall('country'):
...     # using root.findall() to avoid removal during traversal
...     rank = int(country.find('rank').text)
...     if rank > 50:
...         root.remove(country)
...
>>> tree.write('output.xml')
@end example

Tenga en cuenta que la modificación concurrente mientras se itera puede conducir a problemas, al igual que cuando se itera y modifica listas o diccionarios de Python. Por lo tanto, el ejemplo recoge primero todos los elementos coincidentes con @code{root.findall()}, y sólo entonces itera sobre la lista de coincidencias.

Nuestro XML tiene ahora este aspecto:

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank updated="yes">2</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank updated="yes">5</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
</data>
@end example

@node Construyendo documentos XML,Procesando XML con espacio de nombres,Modificando un archivo XML,Tutorial<2>
@anchor{library/xml etree elementtree building-xml-documents}@anchor{36b9}
@subsubsection Construyendo documentos XML


La función @ref{36ba,,SubElement()} también proporciona una forma cómoda de crear nuevos sub-elementos para un elemento dado:

@example
>>> a = ET.Element('a')
>>> b = ET.SubElement(a, 'b')
>>> c = ET.SubElement(a, 'c')
>>> d = ET.SubElement(c, 'd')
>>> ET.dump(a)
<a><b /><c><d /></c></a>
@end example

@node Procesando XML con espacio de nombres,,Construyendo documentos XML,Tutorial<2>
@anchor{library/xml etree elementtree parsing-xml-with-namespaces}@anchor{36bb}
@subsubsection Procesando XML con espacio de nombres


Si la entrada XML tiene espacio de nombres@footnote{https://es.wikipedia.org/wiki/Espacio_de_nombres_XML}, las etiquetas y los atributos con prefijos de la forma @code{prefix:sometag} se expanden a @code{@{uri@}sometag} donde el `prefix' se sustituye por el `URI' completo. Además, si hay un espacio de nombre por defecto@footnote{https://www.w3.org/TR/xml-names/#defaulting}, ese URI completo se antepone a todas las etiquetas sin prefijo.

A continuación se muestra un ejemplo de XML que incorpora dos espacios de nombres, uno con el prefijo «fictional» y el otro que sirve como espacio de nombres por defecto:

@example
<?xml version="1.0"?>
<actors xmlns:fictional="http://characters.example.com"
        xmlns="http://people.example.com">
    <actor>
        <name>John Cleese</name>
        <fictional:character>Lancelot</fictional:character>
        <fictional:character>Archie Leach</fictional:character>
    </actor>
    <actor>
        <name>Eric Idle</name>
        <fictional:character>Sir Robin</fictional:character>
        <fictional:character>Gunther</fictional:character>
        <fictional:character>Commander Clement</fictional:character>
    </actor>
</actors>
@end example

Una forma de buscar y explorar este ejemplo XML es añadir manualmente el URI a cada etiqueta o atributo en el XPath de un @ref{36b2,,find()} o @ref{36b1,,findall()}:

@example
root = fromstring(xml_text)
for actor in root.findall('@{http://people.example.com@}actor'):
    name = actor.find('@{http://people.example.com@}name')
    print(name.text)
    for char in actor.findall('@{http://characters.example.com@}character'):
        print(' |-->', char.text)
@end example

Una mejor manera de buscar en el ejemplo de XML con espacio para nombres es crear un diccionario con sus propios prefijos y utilizarlos en las funciones de búsqueda:

@example
ns = @{'real_person': 'http://people.example.com',
      'role': 'http://characters.example.com'@}

for actor in root.findall('real_person:actor', ns):
    name = actor.find('real_person:name', ns)
    print(name.text)
    for char in actor.findall('role:character', ns):
        print(' |-->', char.text)
@end example

Estos dos enfoques dan como resultado:

@example
John Cleese
 |--> Lancelot
 |--> Archie Leach
Eric Idle
 |--> Sir Robin
 |--> Gunther
 |--> Commander Clement
@end example

@node Soporte de XPath,Referencia<3>,Tutorial<2>,xml etree ElementTree — The ElementTree XML API
@anchor{library/xml etree elementtree elementtree-xpath}@anchor{c35}@anchor{library/xml etree elementtree xpath-support}@anchor{36bc}
@subsubsection Soporte de XPath


Este módulo proporciona un soporte limitado para las expresiones XPath@footnote{https://www.w3.org/TR/xpath} para localizar elementos en un árbol. El objetivo es soportar un pequeño subconjunto de la sintaxis abreviada; un motor XPath completo está fuera del alcance del módulo.

@menu
* Ejemplo: Ejemplo<8>. 
* Sintaxis XPath soportada:: 

@end menu

@node Ejemplo<8>,Sintaxis XPath soportada,,Soporte de XPath
@anchor{library/xml etree elementtree example}@anchor{36bd}
@subsubsection Ejemplo


A continuación se muestra un ejemplo que demuestra algunas de las capacidades de XPath del módulo. Utilizaremos el documento XML @code{countrydata} de la sección @ref{36aa,,Parsing XML}:

@example
import xml.etree.ElementTree as ET

root = ET.fromstring(countrydata)

# Top-level elements
root.findall(".")

# All 'neighbor' grand-children of 'country' children of the top-level
# elements
root.findall("./country/neighbor")

# Nodes with name='Singapore' that have a 'year' child
root.findall(".//year/..[@@name='Singapore']")

# 'year' nodes that are children of nodes with name='Singapore'
root.findall(".//*[@@name='Singapore']/year")

# All 'neighbor' nodes that are the second child of their parent
root.findall(".//neighbor[2]")
@end example

Para XML con espacios de nombre, use la notación calificada habitual @code{@{namespace@}tag}:

@example
# All dublin-core "title" tags in the document
root.findall(".//@{http://purl.org/dc/elements/1.1/@}title")
@end example

@node Sintaxis XPath soportada,,Ejemplo<8>,Soporte de XPath
@anchor{library/xml etree elementtree supported-xpath-syntax}@anchor{36be}
@subsubsection Sintaxis XPath soportada



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sintaxis

@tab

Significado

@item

@code{tag}

@tab

Selecciona todos los elementos hijos con la etiqueta dada. Por ejemplo, @code{spam} selecciona todos los elementos hijos llamados @code{spam}, y @code{spam/egg} selecciona todos los nietos llamados @code{egg} en todos los hijos llamados @code{spam}. @code{@{namespace@}*} selecciona todas las etiquetas en el espacio de nombres dado, @code{@{*@}spam} selecciona las etiquetas llamadas @code{spam} en cualquier (o ningún) espacio de nombres, y @code{@{@}*} sólo selecciona las etiquetas que no están en un espacio de nombres.


Distinto en la versión 3.8: Se ha añadido la posibilidad de utilizar comodines asterisco.


@item

@code{*}

@tab

Selecciona todos los elementos hijos, incluidos los comentarios y las instrucciones de procesamiento. Por ejemplo, @code{*/egg} selecciona todos los hijos llamados @code{egg}.

@item

@code{.}

@tab

Selecciona el nodo actual. Esto es útil sobre todo al principio de la ruta, para indicar que es una ruta relativa.

@item

@code{//}

@tab

Selecciona todos los sub-elementos, en todos los niveles por debajo del elemento actual. Por ejemplo, @code{.//egg} selecciona todos los elementos @code{egg} en todo el árbol.

@item

@code{..}

@tab

Selecciona el elemento padre. Retorna @code{None} si la ruta intenta llegar a los ancestros del elemento inicial (el elemento @code{find} fue invocado).

@item

@code{[@@attrib]}

@tab

Selecciona todos los elementos que tengan el atributo dado.

@item

@code{[@@attrib='value']}

@tab

Selecciona todos los elementos para los que el atributo dado tiene el valor dado. El valor no puede contener comillas.

@item

@code{[@@attrib!='value']}

@tab

Selecciona todos los elementos para los que el atributo dado no tiene el valor dado. El valor no puede contener comillas.


Added in version 3.10.


@item

@code{[tag]}

@tab

Selecciona todos los elementos que tienen un hijo llamado @code{tag}. Sólo se admiten los hijos inmediatos.

@item

@code{[.='text']}

@tab

Selecciona todos los elementos cuyo contenido de texto completo, incluyendo los descendientes, es igual al «texto» dado.


Added in version 3.7.


@item

@code{[.!='text']}

@tab

Selecciona todos los elementos cuyo contenido de texto completo, incluidos los descendientes, no es igual al @code{text} proporcionado.


Added in version 3.10.


@item

@code{[tag='text']}

@tab

Selecciona todos los elementos que tienen un hijo llamado @code{tag} cuyo contenido de texto completo, incluyendo los descendientes, es igual al @code{text} dado.

@item

@code{[tag!='text']}

@tab

Selecciona todos los elementos que tienen un hijo llamado @code{tag} cuyo contenido de texto completo, incluidos los descendientes, no es igual al @code{text} dado.


Added in version 3.10.


@item

@code{[position]}

@tab

Selecciona todos los elementos que se encuentran en la posición dada. La posición puede ser un número entero (1 es la primera posición), la expresión @code{last()} (para la última posición), o una posición relativa a la última posición (por ejemplo, @code{last()-1}).

@end multitable


Los predicados (expresiones entre corchetes) deben ir precedidos de un nombre de etiqueta, un asterisco u otro predicado. Los predicados @code{position} deben ir precedidos de un nombre de etiqueta.

@node Referencia<3>,Soporte de XInclude,Soporte de XPath,xml etree ElementTree — The ElementTree XML API
@anchor{library/xml etree elementtree reference}@anchor{36bf}
@subsubsection Referencia


@menu
* Funciones: Funciones<7>. 

@end menu

@node Funciones<7>,,,Referencia<3>
@anchor{library/xml etree elementtree elementtree-functions}@anchor{36c0}@anchor{library/xml etree elementtree functions}@anchor{36c1}
@subsubsection Funciones


@geindex canonicalize() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree canonicalize}@anchor{36c2}
@deffn {Función} xml.etree.ElementTree.canonicalize (xml_data=None, *, out=None, from_file=None, **options)

Función de transformación C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/}.

Canonicalization is a way to normalise XML output in a way that allows
byte-by-byte comparisons and digital signatures.  It reduces the freedom
that XML serializers have and instead generates a more constrained XML
representation.  The main restrictions regard the placement of namespace
declarations, the ordering of attributes, and ignorable whitespace.

Esta función toma una cadena de datos XML (`xml_data') o una ruta de archivo o un objeto tipo archivo (`from_file') como entrada, la convierte a la forma canónica y la escribe utilizando el objeto archivo (o tipo archivo) `out', si se proporciona, o la devuelve como una cadena de texto si no. El archivo de salida recibe texto, no bytes. Por tanto, debe abrirse en modo texto con codificación @code{utf-8}.

Usos típicos:

@example
xml_data = "<root>...</root>"
print(canonicalize(xml_data))

with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
    canonicalize(xml_data, out=out_file)

with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
    canonicalize(from_file="inputfile.xml", out=out_file)
@end example

Las opciones de configuración `options' son las siguientes:


@itemize -

@item 
`with_comments': configurar a @code{True} para incluir los comentarios (por defecto: @code{False})

@item 

@table @asis

@item `strip_text': configurar a @code{True} para eliminar los espacios en blanco antes y después del contenido del texto

(por defecto: @code{False})
@end table

@item 

@table @asis

@item `rewrite_prefixes': configurar a @code{True} para sustituir los prefijos de espacios de nombres por «n@{number@}»

(por defecto: @code{False})
@end table

@item 

@table @asis

@item `qname_aware_tags': un conjunto de nombres de etiquetas conscientes de qname en el que los prefijos

deben ser reemplazados en el contenido del texto (por defecto: vacío)
@end table

@item 

@table @asis

@item `qname_aware_attrs': un conjunto de nombres de atributos conscientes de qname en el que los prefijos

deben ser reemplazados en el contenido del texto (por defecto: vacío)
@end table

@item 
`exclude_attrs': un conjunto de nombres de atributos que no deben serializarse

@item 
`exclude_tags': un conjunto de nombres de etiquetas que no deben serializarse
@end itemize

En la lista de opciones anterior, «un conjunto» se refiere a cualquier colección o iterable de cadenas, no se espera ningún orden.


Added in version 3.8.

@end deffn

@geindex Comment() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree Comment}@anchor{36c3}
@deffn {Función} xml.etree.ElementTree.Comment (text=None)

Fábrica de elementos de comentario. Esta función de fábrica crea un elemento especial que será serializado como un comentario XML por el serializador estándar. La cadena de comentario puede ser una cadena de bytes o una cadena Unicode. `text' es una cadena que contiene la cadena de comentario. Devuelve una instancia de elemento que representa un comentario.

Tenga en cuenta que @ref{ae5,,XMLParser} omite los comentarios en la entrada en lugar de crear objetos de comentario para ellos. Un @ref{9e1,,ElementTree} sólo contendrá nodos de comentario si se han insertado en el árbol utilizando uno de los métodos @ref{20b,,Element}.
@end deffn

@geindex dump() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree dump}@anchor{36c4}
@deffn {Función} xml.etree.ElementTree.dump (elem)

Escribe un árbol de elementos o una estructura de elementos en sys.stdout. Esta función debe utilizarse únicamente para debugging.

El formato de salida exacto depende de la implementación. En esta versión, se escribe como un archivo XML ordinario.

`elem' es un árbol de elementos o un elemento individual.


Distinto en la versión 3.8: La función @ref{36c4,,dump()} ahora preserva el orden de atributos especificado por el usuario.

@end deffn

@geindex fromstring() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree fromstring}@anchor{36ac}
@deffn {Función} xml.etree.ElementTree.fromstring (text, parser=None)

Analiza una sección XML a partir de una constante de cadena. Igual que @ref{36c5,,XML()}. `text' es una cadena que contiene datos XML. `parser' es una instancia de parser opcional. Si no se da, se utiliza el analizador estándar @ref{ae5,,XMLParser}. Devuelve una instancia de @ref{20b,,Element}.
@end deffn

@geindex fromstringlist() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree fromstringlist}@anchor{123e}
@deffn {Función} xml.etree.ElementTree.fromstringlist (sequence, parser=None)

Analiza un documento XML a partir de una secuencia de fragmentos de cadena de caracteres. `sequence' es una lista u otra secuencia que contiene fragmentos de datos XML. `parser' es una instancia de parser opcional. Si no se da, se utiliza el analizador estándar @ref{ae5,,XMLParser}. Retorna una instancia de @ref{20b,,Element}.


Added in version 3.2.

@end deffn

@geindex indent() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree indent}@anchor{36c6}
@deffn {Función} xml.etree.ElementTree.indent (tree, space='  ', level=0)

Añade espacios en blanco al subárbol para indentar el árbol visualmente. Esto puede utilizarse para generar una salida XML con una impresión bonita. `tree' puede ser un Element o ElementTree. `space' es la cadena de espacio en blanco que se insertará para cada nivel de indentación, dos caracteres de espacio por defecto. Para indentar subárboles parciales dentro de un árbol ya indentado, pase el nivel de indentación inicial como `level'.


Added in version 3.9.

@end deffn

@geindex iselement() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree iselement}@anchor{36c7}
@deffn {Función} xml.etree.ElementTree.iselement (element)

Comprueba si un objeto parece ser un objeto elemento válido. `element' es una instancia de elemento. Retorna @code{True} si se trata de un objeto elemento.
@end deffn

@geindex iterparse() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree iterparse}@anchor{3ca}
@deffn {Función} xml.etree.ElementTree.iterparse (source, events=None, parser=None)

Parses an XML section into an element tree incrementally, and reports what’s
going on to the user.  `source' is a filename or @ref{1230,,file object}
containing XML data.  `events' is a sequence of events to report back.  The
supported events are the strings @code{"start"}, @code{"end"}, @code{"comment"},
@code{"pi"}, @code{"start-ns"} and @code{"end-ns"}
(the «ns» events are used to get detailed namespace
information).  If `events' is omitted, only @code{"end"} events are reported.
`parser' is an optional parser instance.  If not given, the standard
@ref{ae5,,XMLParser} parser is used.  `parser' must be a subclass of
@ref{ae5,,XMLParser} and can only use the default @ref{ae6,,TreeBuilder} as a
target. Returns an @ref{313,,iterator} providing @code{(event, elem)} pairs;
it has a @code{root} attribute that references the root element of the
resulting XML tree once `source' is fully read.
The iterator has the @code{close()} method that closes the internal
file object if `source' is a filename.

Tenga en cuenta que mientras @ref{3ca,,iterparse()} construye el árbol de forma incremental, emite lecturas de bloqueo en la `source' (o en el fichero que nombra). Por lo tanto, no es adecuado para aplicaciones en las que no se pueden realizar lecturas de bloqueo. Para un análisis completamente no bloqueante, véase @ref{1070,,XMLPullParser}.

@cartouche
@quotation Nota 
@ref{3ca,,iterparse()} sólo garantiza que ha visto el carácter «>» de una etiqueta de inicio cuando emite un evento «start», por lo que los atributos están definidos, pero el contenido de los atributos text y tail está indefinido en ese momento. Lo mismo ocurre con los hijos del elemento; pueden estar presentes o no.

Si necesita un elemento totalmente poblado, busque los eventos «end» en su lugar.
@end quotation
@end cartouche


Obsoleto desde la versión 3.4: El argumento `parser'.



Distinto en la versión 3.8: Los eventos @code{comment} y @code{pi} han sido añadidos.



Distinto en la versión 3.13: Added the @code{close()} method.

@end deffn

@geindex parse() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree parse}@anchor{36c8}
@deffn {Función} xml.etree.ElementTree.parse (source, parser=None)

Analiza una sección XML en un árbol de elementos. `source' es un nombre de archivo o un objeto de archivo que contiene datos XML. `parser' es una instancia de parser opcional. Si no se da, se utiliza el analizador estándar @ref{ae5,,XMLParser}. Devuelve una instancia de @ref{9e1,,ElementTree}.
@end deffn

@geindex ProcessingInstruction() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ProcessingInstruction}@anchor{36c9}
@deffn {Función} xml.etree.ElementTree.ProcessingInstruction (target, text=None)

Fábrica de elementos PI. Esta función de fábrica crea un elemento especial que será serializado como una instrucción de procesamiento XML. `target' es una cadena que contiene el objetivo de PI. `text' es una cadena que contiene el contenido de PI, si se da. Devuelve una instancia de elemento, representando una instrucción de procesamiento.

Note that @ref{ae5,,XMLParser} skips over processing instructions
in the input instead of creating PI objects for them. An
@ref{9e1,,ElementTree} will only contain processing instruction nodes if
they have been inserted into to the tree using one of the
@ref{20b,,Element} methods.
@end deffn

@geindex register_namespace() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree register_namespace}@anchor{123f}
@deffn {Función} xml.etree.ElementTree.register_namespace (prefix, uri)

Registra un prefijo de espacio de nombres. El registro es global, y cualquier asignación existente para el prefijo dado o el URI del espacio de nombres será eliminado. `prefix' es un prefijo de espacio de nombres. `uri' es una uri del espacio de nombres. Las etiquetas y los atributos de este espacio de nombres se serializarán con el prefijo dado, si es posible.


Added in version 3.2.

@end deffn

@geindex SubElement() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree SubElement}@anchor{36ba}
@deffn {Función} xml.etree.ElementTree.SubElement (parent, tag, attrib=@{@}, **extra)

Fábrica de sub-elementos. Esta función crea una instancia de elemento y la añade a un elemento existente.

El nombre del elemento, los nombres de los atributos y los valores de los atributos pueden ser cadenas de bytes o cadenas de caracteres Unicode. `parent' es el elemento padre. `tag' es el nombre del sub-elemento. `attrib' es un diccionario opcional que contiene los atributos del elemento. `extra' contiene atributos adicionales, dados como argumentos de palabras clave. Devuelve una instancia de elemento.
@end deffn

@geindex tostring() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree tostring}@anchor{1072}
@deffn {Función} xml.etree.ElementTree.tostring (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

Genera una representación de cadena de caracteres de un elemento XML, incluyendo todos los sub-elementos. `element' es una instancia de @ref{20b,,Element}. `encoding' @footnote{
La cadena de caracteres de codificación incluida en la salida XML debe ajustarse a los estándares adecuados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no lo es. Consulte @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} es la codificación de salida (por defecto es US-ASCII). Utilice @code{encoding="unicode"} para generar una cadena de caracteres Unicode (de lo contrario, se genera una cadena de bytes). `method' es @code{"xml"}, @code{"html"} o @code{"text"} (por defecto es @code{"xml"}). `xml_declaration', `default_namespace' y `short_empty_elements' tienen el mismo significado que en @ref{13b5,,ElementTree.write()}. Devuelve una cadena (opcionalmente) codificada que contiene los datos XML.


Distinto en la versión 3.4: Added the `short_empty_elements' parameter.



Distinto en la versión 3.8: Added the `xml_declaration' and `default_namespace' parameters.



Distinto en la versión 3.8: La función @ref{1072,,tostring()} ahora preserva el orden de atributos especificado por el usuario.

@end deffn

@geindex tostringlist() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree tostringlist}@anchor{1073}
@deffn {Función} xml.etree.ElementTree.tostringlist (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

Genera una representación de cadena de caracteres de un elemento XML, incluyendo todos los sub-elementos. `element' es una instancia de @ref{20b,,Element}. `encoding' @footnote{
La cadena de caracteres de codificación incluida en la salida XML debe ajustarse a los estándares adecuados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no lo es. Consulte @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} es la codificación de salida (por defecto es US-ASCII). Utilice @code{encoding="unicode"} para generar una cadena de caracteres Unicode (de lo contrario, se genera una cadena de bytes). `method' es @code{"xml"}, @code{"html"} o @code{"text"} (por defecto es @code{"xml"}). `xml_declaration', `default_namespace' y `short_empty_elements' tienen el mismo significado que en @ref{13b5,,ElementTree.write()}. Devuelve una lista de cadenas (opcionalmente) codificadas que contienen los datos XML. No garantiza ninguna secuencia específica, excepto que @code{b"".join(tostringlist(element)) == tostring(element)}.


Added in version 3.2.



Distinto en la versión 3.4: Added the `short_empty_elements' parameter.



Distinto en la versión 3.8: Added the `xml_declaration' and `default_namespace' parameters.



Distinto en la versión 3.8: La función @ref{1073,,tostringlist()} ahora preserva el orden de atributos especificado por el usuario.

@end deffn

@geindex XML() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XML}@anchor{36c5}
@deffn {Función} xml.etree.ElementTree.XML (text, parser=None)

Analiza una sección XML a partir de una constante de cadena de caracteres. Esta función puede utilizarse para incrustar «literales XML» en el código de Python. `text' es una cadena de caracteres que contiene datos XML. `parser' es una instancia de parser opcional. Si no se da, se utiliza el analizador estándar @ref{ae5,,XMLParser}. Devuelve una instancia de @ref{20b,,Element}.
@end deffn

@geindex XMLID() (en el módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLID}@anchor{36ca}
@deffn {Función} xml.etree.ElementTree.XMLID (text, parser=None)

Analiza una sección XML a partir de una constante de cadena de caracteres, y también devuelve un diccionario que mapea los id:s de elementos a elementos. `text' es una cadena de caracteres que contiene datos XML. `parser' es una instancia de parser opcional. Si no se da, se utiliza el analizador estándar de @ref{ae5,,XMLParser}. Devuelve una tupla que contiene una instancia de @ref{20b,,Element} y un diccionario.
@end deffn

@node Soporte de XInclude,Referencia<4>,Referencia<3>,xml etree ElementTree — The ElementTree XML API
@anchor{library/xml etree elementtree elementtree-xinclude}@anchor{36cb}@anchor{library/xml etree elementtree xinclude-support}@anchor{36cc}
@subsubsection Soporte de XInclude


Este módulo proporciona un soporte limitado para las directivas XInclude@footnote{https://www.w3.org/TR/xinclude/}, a través del módulo de ayuda @ref{124,,xml.etree.ElementInclude}. Este módulo puede utilizarse para insertar subárboles y cadenas de texto en árboles de elementos, basándose en la información del árbol.

@menu
* Ejemplo: Ejemplo<9>. 

@end menu

@node Ejemplo<9>,,,Soporte de XInclude
@anchor{library/xml etree elementtree id3}@anchor{36cd}
@subsubsection Ejemplo


Aquí hay un ejemplo que demuestra el uso del módulo XInclude. Para incluir un documento XML en el documento actual, utilice el elemento @code{@{http://www.w3.org/2001/XInclude@}include} y establezca el atributo `parse' como @code{"xml"}, y utilice el atributo `href' para especificar el documento a incluir.

@example
<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <xi:include href="source.xml" parse="xml" />
</document>
@end example

Por defecto, el atributo `href' se trata como un nombre de archivo. Puede utilizar cargadores personalizados para anular este comportamiento. También tenga en cuenta que el ayudante estándar no soporta la sintaxis XPointer.

Para procesar este archivo, cárguelo como de costumbre y pase el elemento raíz al módulo @ref{125,,xml.etree.ElementTree}:

@example
from xml.etree import ElementTree, ElementInclude

tree = ElementTree.parse("document.xml")
root = tree.getroot()

ElementInclude.include(root)
@end example

El módulo ElementInclude sustituye el elemento @code{@{http://www.w3.org/2001/XInclude@}include} por el elemento raíz del documento `source.xml'. El resultado podría ser algo así:

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <para>This is a paragraph.</para>
</document>
@end example

Si se omite el atributo `parse', el valor por defecto es «xml». El atributo href es obligatorio.

Para incluir un documento de texto, utilice el elemento @code{@{http://www.w3.org/2001/XInclude@}include} y establezca el atributo `parse' como «text»:

@example
<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) <xi:include href="year.txt" parse="text" />.
</document>
@end example

El resultado podría ser algo así:

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) 2003.
</document>
@end example

@node Referencia<4>,,Soporte de XInclude,xml etree ElementTree — The ElementTree XML API
@anchor{library/xml etree elementtree id4}@anchor{36ce}
@subsubsection Referencia


@menu
* Funciones: Funciones<8>. 
* Objetos Element:: 
* Objetos ElementTree:: 
* Objetos QName:: 
* Objetos TreeBuilder:: 
* Objetos XMLParser:: 
* Objetos XMLPullParser:: 
* Excepciones: Excepciones<17>. 

@end menu

@node Funciones<8>,Objetos Element,,Referencia<4>
@anchor{library/xml etree elementtree elementinclude-functions}@anchor{36cf}@anchor{library/xml etree elementtree id5}@anchor{36d0}
@subsubsection Funciones


@geindex module; xml.etree.ElementInclude

@geindex default_loader() (en el módulo xml.etree.ElementInclude)
@anchor{library/xml etree elementtree module-xml etree ElementInclude}@anchor{124}@anchor{library/xml etree elementtree xml etree ElementInclude default_loader}@anchor{36d1}
@deffn {Función} xml.etree.ElementInclude.default_loader (href, parse, encoding=None)

Default loader. This default loader reads an included resource from disk.
`href' is a URL.  `parse' is for parse mode either «xml» or «text».
`encoding' is an optional text encoding.  If not given, encoding is @code{utf-8}.
Returns the expanded resource.
If the parse mode is @code{"xml"}, this is an @ref{20b,,Element} instance.
If the parse mode is @code{"text"}, this is a string.
If the loader fails, it can return @code{None} or raise an exception.
@end deffn

@geindex include() (en el módulo xml.etree.ElementInclude)
@anchor{library/xml etree elementtree xml etree ElementInclude include}@anchor{36d2}
@deffn {Función} xml.etree.ElementInclude.include (elem, loader=None, base_url=None, max_depth=6)

This function expands XInclude directives in-place in tree pointed by `elem'.
`elem' is either the root @ref{20b,,Element} or an
@ref{9e1,,ElementTree} instance to find such element.
`loader' is an optional resource loader.  If omitted, it defaults to @ref{36d1,,default_loader()}.
If given, it should be a callable that implements the same interface as
@ref{36d1,,default_loader()}.  `base_url' is base URL of the original file, to resolve
relative include file references.  `max_depth' is the maximum number of recursive
inclusions.  Limited to reduce the risk of malicious content explosion.
Pass @code{None} to disable the limitation.


Distinto en la versión 3.9: Added the `base_url' and `max_depth' parameters.

@end deffn

@node Objetos Element,Objetos ElementTree,Funciones<8>,Referencia<4>
@anchor{library/xml etree elementtree element-objects}@anchor{36d3}@anchor{library/xml etree elementtree elementtree-element-objects}@anchor{36d4}
@subsubsection Objetos Element


@geindex Element (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree Element}@anchor{20b}
@deffn {Clase} xml.etree.ElementTree.Element (tag, attrib=@{@}, **extra)

Clase Element. Esta clase define la interfaz Element, y provee una implementación de referencia de esta interfaz.

El nombre del elemento, los nombres de los atributos y los valores de los atributos pueden ser cadenas de bytes o cadenas Unicode. `tag' es el nombre del elemento. `attrib' es un diccionario opcional que contiene los atributos del elemento. `extra' contiene atributos adicionales, dados como argumentos de palabras clave.

@geindex tag (atributo de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element tag}@anchor{13b6}
@deffn {Atributo} tag

Una cadena de caracteres que identifica qué tipo de datos representa este elemento (el tipo de elemento, en otras palabras).
@end deffn

@geindex text (atributo de xml.etree.ElementTree.Element)
@geindex tail (atributo de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element text}@anchor{36b3}
@deffn {Atributo} text
@anchor{library/xml etree elementtree xml etree ElementTree Element tail}@anchor{36d5}
@deffnx {Atributo} tail

Estos atributos pueden utilizarse para contener datos adicionales asociados al elemento. Sus valores suelen ser cadenas, pero pueden ser cualquier objeto específico de la aplicación. Si el elemento se crea a partir de un archivo XML, el atributo `text' contiene el texto entre la etiqueta inicial del elemento y su primera etiqueta hija o final, o @code{None}, y el atributo `tail' contiene el texto entre la etiqueta final del elemento y la siguiente etiqueta, o @code{None}. Para los datos XML

@example
<a><b>1<c>2<d/>3</c></b>4</a>
@end example

el elemento `a' tiene @code{None} para los atributos `text' y `tail', el elemento `b' tiene `text' @code{"1"} y `tail' @code{"4"}, el elemento `c' tiene `text' @code{"2"} y `tail' @code{None}, y el elemento `d' tiene `text' @code{None} y `tail' @code{"3"}.

Para recoger el texto interior de un elemento, véase @ref{1242,,itertext()}, por ejemplo @code{"".join(element.itertext())}.

Las aplicaciones pueden almacenar objetos arbitrarios en estos atributos.
@end deffn

@geindex attrib (atributo de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element attrib}@anchor{36d6}
@deffn {Atributo} attrib

Un diccionario que contiene los atributos del elemento. Ten en cuenta que aunque el valor `attrib' es siempre un diccionario mutable real de Python, una implementación de ElementTree puede elegir utilizar otra representación interna, y crear el diccionario sólo si alguien lo pide. Para aprovechar este tipo de implementaciones, utiliza los métodos de diccionario que aparecen a continuación siempre que sea posible.
@end deffn

Los siguientes métodos tipo diccionario funcionan con los atributos de los elementos.

@geindex clear() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element clear}@anchor{36d7}
@deffn {Método} clear ()

Restablece un elemento.  Esta función elimina todos los sub-elementos, borra todos los atributos y establece los atributos de texto y cola como @code{None}.
@end deffn

@geindex get() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element get}@anchor{36b4}
@deffn {Método} get (key, default=None)

Obtiene el atributo del elemento llamado `key'.

Retorna el valor del atributo, o `default' si el atributo no fue encontrado.
@end deffn

@geindex items() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element items}@anchor{36d8}
@deffn {Método} items ()

Retorna los atributos del elemento como una secuencia de pares (nombre, valor). Los atributos se retornan en un orden arbitrario.
@end deffn

@geindex keys() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element keys}@anchor{36d9}
@deffn {Método} keys ()

Retorna los nombres de los atributos de los elementos como una lista. Los nombres se retornan en un orden arbitrario.
@end deffn

@geindex set() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element set}@anchor{36b6}
@deffn {Método} set (key, value)

Establecer el atributo `key' en el elemento a `value'.
@end deffn

Los siguientes métodos actúan sobre los hijos del elemento (sub-elementos).

@geindex append() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element append}@anchor{36b7}
@deffn {Método} append (subelement)

Añade el elemento `subelement' al final de la lista interna de sub-elementos de este elemento. Lanza @ref{228,,TypeError} si `subelement' no es un @ref{20b,,Element}.
@end deffn

@geindex extend() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element extend}@anchor{1240}
@deffn {Método} extend (subelements)

Appends `subelements' from an iterable of elements.
Raises @ref{228,,TypeError} if a subelement is not an @ref{20b,,Element}.


Added in version 3.2.

@end deffn

@geindex find() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element find}@anchor{36b2}
@deffn {Método} find (match, namespaces=None)

Encuentra el primer sub-elemento que coincide con `match'. `match' puede ser un nombre de etiqueta o un @ref{c35,,path}. Retorna una instancia de elemento o @code{None}. `namespaces' es un mapeo opcional del prefijo del espacio de nombres al nombre completo. Pasa @code{'@w{'}} como prefijo para mover todos los nombres de etiquetas sin prefijo en la expresión al espacio de nombres dado.
@end deffn

@geindex findall() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element findall}@anchor{36b1}
@deffn {Método} findall (match, namespaces=None)

Encuentra todos los sub-elementos coincidentes, por nombre de etiqueta o @ref{c35,,path}. Retorna una lista que contiene todos los elementos coincidentes en el orden del documento. `namespaces' es un mapeo opcional del prefijo del espacio de nombres al nombre completo. Pasa @code{'@w{'}} como prefijo para mover todos los nombres de etiquetas sin prefijo en la expresión al espacio de nombres dado.
@end deffn

@geindex findtext() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element findtext}@anchor{36da}
@deffn {Método} findtext (match, default=None, namespaces=None)

Busca el texto del primer sub-elemento que coincida con `match'. `match' puede ser un nombre de etiqueta o un @ref{c35,,path}. Retorna el contenido del texto del primer elemento que coincida, o `default' si no se encuentra ningún elemento. Tenga en cuenta que si el elemento coincidente no tiene contenido de texto se devuelve una cadena vacía. `namespaces' es un mapeo opcional del prefijo del espacio de nombres al nombre completo. Pasa @code{'@w{'}} como prefijo para mover todos los nombres de etiquetas sin prefijo en la expresión al espacio de nombres dado.
@end deffn

@geindex insert() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element insert}@anchor{36db}
@deffn {Método} insert (index, subelement)

Inserta `subelement' en la posición dada en este elemento. Lanza @ref{228,,TypeError} si `subelement' no es un @ref{20b,,Element}.
@end deffn

@geindex iter() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element iter}@anchor{13b7}
@deffn {Método} iter (tag=None)

Crea un árbol @ref{313,,iterator} con el elemento actual como raíz. El iterador itera sobre este elemento y todos los elementos por debajo de él, en el orden del documento (profundidad primero). Si `tag' no es @code{None} o @code{'*'}, sólo los elementos cuya etiqueta es igual a `tag' son retornados por el iterador. Si la estructura del árbol se modifica durante la iteración, el resultado es indefinido.


Added in version 3.2.

@end deffn

@geindex iterfind() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element iterfind}@anchor{1241}
@deffn {Método} iterfind (match, namespaces=None)

Encuentra todos los subelementos que coinciden, por nombre de etiqueta o @ref{c35,,ruta}. Retorna un iterable con todos los elementos coincidentes en el orden del documento. `namespaces' es un mapeo opcional del prefijo del espacio de nombres al nombre completo.


Added in version 3.2.

@end deffn

@geindex itertext() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element itertext}@anchor{1242}
@deffn {Método} itertext ()

Crea un iterador de texto. El iterador hace un bucle sobre este elemento y todos los subelementos, en el orden del documento, y retorna todo el texto interior.


Added in version 3.2.

@end deffn

@geindex makeelement() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element makeelement}@anchor{36dc}
@deffn {Método} makeelement (tag, attrib)

Crea un nuevo objeto elemento del mismo tipo que este elemento. No llame a este método, utilice la función de fábrica @ref{36ba,,SubElement()} en su lugar.
@end deffn

@geindex remove() (método de xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element remove}@anchor{36b8}
@deffn {Método} remove (subelement)

Elimina el `subelement' del elemento. A diferencia de los métodos find*, este método compara los elementos basándose en la identidad de la instancia, no en el valor de la etiqueta o el contenido.
@end deffn

Los objetos @ref{20b,,Element} también soportan los siguientes métodos de tipo secuencia para trabajar con subelementos: @ref{1506,,__delitem__()}, @ref{3d8,,__getitem__()}, @ref{1505,,__setitem__()}, @ref{1f62,,__len__()}.

Caution: Elements with no subelements will test as @code{False}.  In a future
release of Python, all elements will test as @code{True} regardless of whether
subelements exist.  Instead, prefer explicit @code{len(elem)} or
@code{elem is not None} tests.:

@example
element = root.find('foo')

if not element:  # careful!
    print("element not found, or element has no subelements")

if element is None:
    print("element not found")
@end example


Distinto en la versión 3.12: Testing the truth value of an Element emits @ref{1da,,DeprecationWarning}.


Antes de Python 3.8, el orden de serialización de los atributos XML de los elementos se hacía predecible artificialmente ordenando los atributos por su nombre. Basado en el ordenamiento -ahora garantizado- de los diccionarios, este reordenamiento arbitrario fue eliminado en Python 3.8 para preservar el orden en que los atributos fueron originalmente analizados o creados por el código del usuario.

En general, el código del usuario debería intentar no depender de un orden específico de los atributos, dado que el XML Information Set@footnote{https://www.w3.org/TR/xml-infoset/} excluye explícitamente el orden de los atributos para transmitir información. El código debe estar preparado para hacer frente a cualquier orden en la entrada. En los casos en los que se requiere una salida XML determinista, por ejemplo, para la firma criptográfica o los conjuntos de datos de prueba, la serialización canónica está disponible con la función @ref{36c2,,canonicalize()}.

En los casos en los que la salida canónica no es aplicable, pero un orden de atributos específico sigue siendo deseable en la salida, el código debe tratar de crear los atributos directamente en el orden deseado, para evitar desajustes perceptivos para los lectores del código. En los casos en que esto es difícil de lograr, una receta como la siguiente se puede aplicar antes de la serialización para hacer cumplir un orden independientemente de la creación de elementos:

@example
def reorder_attributes(root):
    for el in root.iter():
        attrib = el.attrib
        if len(attrib) > 1:
            # adjust attribute order, e.g. by sorting
            attribs = sorted(attrib.items())
            attrib.clear()
            attrib.update(attribs)
@end example
@end deffn

@node Objetos ElementTree,Objetos QName,Objetos Element,Referencia<4>
@anchor{library/xml etree elementtree elementtree-elementtree-objects}@anchor{36dd}@anchor{library/xml etree elementtree elementtree-objects}@anchor{36de}
@subsubsection Objetos ElementTree


@geindex ElementTree (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree}@anchor{9e1}
@deffn {Clase} xml.etree.ElementTree.ElementTree (element=None, file=None)

Clase envoltorio de un ElementTree. Esta clase representa una jerarquía de elementos completa, y añade algún soporte extra para la serialización hacia y desde XML estándar.

`element' es el elemento raíz. El árbol se inicializa con el contenido del `file' XML si se da.

@geindex _setroot() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree _setroot}@anchor{36df}
@deffn {Método} _setroot (element)

Reemplaza el elemento raíz de este árbol. Esto descarta el contenido actual del árbol, y lo reemplaza con el elemento dado. Utilícelo con cuidado. `element' es una instancia de elemento.
@end deffn

@geindex find() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree find}@anchor{36e0}
@deffn {Método} find (match, namespaces=None)

Igual que @ref{36b2,,Element.find()}, empezando por la raíz del árbol.
@end deffn

@geindex findall() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findall}@anchor{36e1}
@deffn {Método} findall (match, namespaces=None)

Igual que @ref{36b1,,Element.findall()}, empezando por la raíz del árbol.
@end deffn

@geindex findtext() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findtext}@anchor{36e2}
@deffn {Método} findtext (match, default=None, namespaces=None)

Igual que @ref{36da,,Element.findtext()}, empezando por la raíz del árbol.
@end deffn

@geindex getroot() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree getroot}@anchor{36e3}
@deffn {Método} getroot ()

Retorna el elemento raíz de este árbol.
@end deffn

@geindex iter() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iter}@anchor{36e4}
@deffn {Método} iter (tag=None)

Crea y retorna un iterador de árbol para el elemento raíz. El iterador recorre todos los elementos de este árbol, en orden de sección. `tag' es la etiqueta a buscar (por defecto devuelve todos los elementos).
@end deffn

@geindex iterfind() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iterfind}@anchor{36e5}
@deffn {Método} iterfind (match, namespaces=None)

Igual que @ref{1241,,Element.iterfind()}, empezando por la raíz del árbol.


Added in version 3.2.

@end deffn

@geindex parse() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree parse}@anchor{36e6}
@deffn {Método} parse (source, parser=None)

Carga una sección XML externa en este árbol de elementos. `source' es un nombre de archivo o un @ref{1230,,file object}. `parser' es una instancia opcional del analizador. Si no se da, se utiliza el analizador estándar @ref{ae5,,XMLParser}. Retorna el elemento raíz de la sección.
@end deffn

@geindex write() (método de xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree write}@anchor{13b5}
@deffn {Método} write (file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml', *, short_empty_elements=True)

Escribe el árbol de elementos en un archivo, como XML. `file' es un nombre de archivo, o un @ref{1230,,file object} abierto para escritura. `encoding' @footnote{
La cadena de caracteres de codificación incluida en la salida XML debe ajustarse a los estándares adecuados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no lo es. Consulte @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} es la codificación de salida (por defecto es US-ASCII). `xml_declaration' controla si se debe añadir una declaración XML al archivo. Utilice @code{False} para nunca, @code{True} para siempre, @code{None} para sólo si no es US-ASCII o UTF-8 o Unicode (por defecto es @code{None}). `default_namespace' establece el espacio de nombres XML por defecto (para «xmlns»). `method' es @code{"xml"}, @code{"html"} o @code{"text"} (por defecto es @code{"xml"}). El parámetro `short_empty_elements' controla el formato de los elementos sin contenido. Si es @code{True} (por defecto), se emiten como una sola etiqueta autocerrada, de lo contrario se emiten como un par de etiquetas de inicio/fin.

La salida es una cadena de caracteres (@ref{237,,str}) o binaria (@ref{325,,bytes}). Esto es controlado por el argumento `encoding'. Si `encoding' es @code{unicode}, la salida es una cadena de caracteres; en caso contrario, es binaria. Tenga en cuenta que esto puede entrar en conflicto con el tipo de `file' si es un @ref{1230,,file object} abierto; asegúrese de no intentar escribir una cadena en un flujo binario y viceversa.


Distinto en la versión 3.4: Added the `short_empty_elements' parameter.



Distinto en la versión 3.8: El método @ref{13b5,,write()} ahora conserva el orden de los atributos especificado por el usuario.

@end deffn
@end deffn

Este es el archivo XML que será manipulado:

@example
<html>
    <head>
        <title>Example page</title>
    </head>
    <body>
        <p>Moved to <a href="http://example.org/">example.org</a>
        or <a href="http://example.com/">example.com</a>.</p>
    </body>
</html>
@end example

Ejemplo de cambio del atributo «target» de cada enlace en el primer párrafo:

@example
>>> from xml.etree.ElementTree import ElementTree
>>> tree = ElementTree()
>>> tree.parse("index.xhtml")
<Element 'html' at 0xb77e6fac>
>>> p = tree.find("body/p")     # Finds first occurrence of tag p in body
>>> p
<Element 'p' at 0xb77ec26c>
>>> links = list(p.iter("a"))   # Returns list of all links
>>> links
[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
>>> for i in links:             # Iterates through all found links
...     i.attrib["target"] = "blank"
...
>>> tree.write("output.xhtml")
@end example

@node Objetos QName,Objetos TreeBuilder,Objetos ElementTree,Referencia<4>
@anchor{library/xml etree elementtree elementtree-qname-objects}@anchor{36e7}@anchor{library/xml etree elementtree qname-objects}@anchor{36e8}
@subsubsection Objetos QName


@geindex QName (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree QName}@anchor{36e9}
@deffn {Clase} xml.etree.ElementTree.QName (text_or_uri, tag=None)

QName wrapper. Se puede utilizar para envolver un valor de atributo QName, con el fin de obtener un manejo adecuado del espacio de nombres en la salida. `text_or_uri' es una cadena de caracteres que contiene el valor QName, en la forma @{uri@}local, o, si se da el argumento tag, la parte URI de un QName. Si se da `tag', el primer argumento se interpreta como un URI, y este argumento se interpreta como un nombre local. Las instancias de @ref{36e9,,QName} son opacas.
@end deffn

@node Objetos TreeBuilder,Objetos XMLParser,Objetos QName,Referencia<4>
@anchor{library/xml etree elementtree elementtree-treebuilder-objects}@anchor{36ea}@anchor{library/xml etree elementtree treebuilder-objects}@anchor{36eb}
@subsubsection Objetos TreeBuilder


@geindex TreeBuilder (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder}@anchor{ae6}
@deffn {Clase} xml.etree.ElementTree.TreeBuilder (element_factory=None, *, comment_factory=None, pi_factory=None, insert_comments=False, insert_pis=False)

Constructor genérico de estructuras de elementos. Este constructor convierte una secuencia de llamadas a los métodos start, data, end, comment y pi en una estructura de elementos bien formada. Puedes utilizar esta clase para construir una estructura de elementos utilizando un analizador XML personalizado, o un analizador para algún otro formato similar a XML.

`element_factory', cuando se da, debe ser un callable que acepta dos argumentos posicionales: una etiqueta y un diccionario de atributos. Se espera que retorne una nueva instancia de elemento.

Las funciones `comment_factory' y `pi_factory', cuando se dan, deben comportarse como las funciones @ref{36c3,,Comment()} y @ref{36c9,,ProcessingInstruction()} para crear comentarios e instrucciones de procesamiento. Si no se dan, se utilizarán las fábricas por defecto. Cuando `insert_comments' y/o `insert_pis' es verdadero, los comentarios/pis se insertarán en el árbol si aparecen dentro del elemento raíz (pero no fuera de él).

@geindex close() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder close}@anchor{36ec}
@deffn {Método} close ()

Vacía los buffers del constructor y retorna el elemento del documento de nivel superior. Retorna una instancia de @ref{20b,,Element}.
@end deffn

@geindex data() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder data}@anchor{36ed}
@deffn {Método} data (data)

Añade texto al elemento actual. `data' es una cadena. Debe ser una cadena de bytes o una cadena Unicode.
@end deffn

@geindex end() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end}@anchor{1243}
@deffn {Método} end (tag)

Cierra el elemento actual. `tag' es el nombre del elemento. Retorna el elemento cerrado.
@end deffn

@geindex start() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start}@anchor{198c}
@deffn {Método} start (tag, attrs)

Abre un nuevo elemento. `tag' es el nombre del elemento. `attrs' es un diccionario que contiene los atributos del elemento. Retorna el elemento abierto.
@end deffn

@geindex comment() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder comment}@anchor{36ee}
@deffn {Método} comment (text)

Crea un comentario con el `texto' dado. Si @code{insert_comments} es verdadero, esto también lo añadirá al árbol.


Added in version 3.8.

@end deffn

@geindex pi() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder pi}@anchor{36ef}
@deffn {Método} pi (target, text)

Creates a process instruction with the given `target' name and `text'.
If @code{insert_pis} is true, this will also add it to the tree.


Added in version 3.8.

@end deffn

Además, un objeto @ref{ae6,,TreeBuilder} personalizado puede proporcionar los siguientes métodos:

@geindex doctype() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder doctype}@anchor{b22}
@deffn {Método} doctype (name, pubid, system)

Maneja una declaración de doctype. `name' es el nombre del doctype. `pubid' es el identificador público. `system' es el identificador del sistema. Este método no existe en la clase por defecto @ref{ae6,,TreeBuilder}.


Added in version 3.2.

@end deffn

@geindex start_ns() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start_ns}@anchor{36f0}
@deffn {Método} start_ns (prefix, uri)

Se llama cada vez que el analizador encuentra una nueva declaración de espacio de nombres, antes de la llamada de retorno @code{start()} para el elemento de apertura que lo define. `prefix' es @code{'@w{'}} para el espacio de nombres por defecto y el nombre del prefijo del espacio de nombres declarado en caso contrario. `uri' es el URI del espacio de nombres.


Added in version 3.8.

@end deffn

@geindex end_ns() (método de xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end_ns}@anchor{36f1}
@deffn {Método} end_ns (prefix)

Se llama después de la llamada de retorno @code{end()} de un elemento que declaró un mapeo de prefijo de espacio de nombres, con el nombre del `prefijo' que salió del ámbito.


Added in version 3.8.

@end deffn
@end deffn

@geindex C14NWriterTarget (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree C14NWriterTarget}@anchor{36f2}
@deffn {Clase} xml.etree.ElementTree.C14NWriterTarget (write, *, with_comments=False, strip_text=False, rewrite_prefixes=False, qname_aware_tags=None, qname_aware_attrs=None, exclude_attrs=None, exclude_tags=None)

Un escritor C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/}. Los argumentos son los mismos que para la función @ref{36c2,,canonicalize()}. Esta clase no construye un árbol, sino que traduce los eventos de devolución de llamada directamente a una forma serializada utilizando la función `write'.


Added in version 3.8.

@end deffn

@node Objetos XMLParser,Objetos XMLPullParser,Objetos TreeBuilder,Referencia<4>
@anchor{library/xml etree elementtree elementtree-xmlparser-objects}@anchor{36f3}@anchor{library/xml etree elementtree xmlparser-objects}@anchor{36f4}
@subsubsection Objetos XMLParser


@geindex XMLParser (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser}@anchor{ae5}
@deffn {Clase} xml.etree.ElementTree.XMLParser (*, target=None, encoding=None)

Esta clase es el bloque de construcción de bajo nivel del módulo. Utiliza @ref{126,,xml.parsers.expat} para un análisis eficiente de XML basado en eventos. Puede ser alimentada con datos XML de forma incremental con el método @ref{36f5,,feed()}, y los eventos de análisis se traducen en una API push - invocando callbacks en el objeto `target'. Si se omite `target', se utiliza la clase estándar @ref{ae6,,TreeBuilder}. Si se da `encoding' @footnote{
La cadena de caracteres de codificación incluida en la salida XML debe ajustarse a los estándares adecuados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no lo es. Consulte @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
}, el valor anula la codificación especificada en el archivo XML.


Distinto en la versión 3.8: Parameters are now @ref{3f4,,keyword-only}.
The `html' argument is no longer supported.


@geindex close() (método de xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser close}@anchor{36f6}
@deffn {Método} close ()

Finaliza la alimentación de datos al analizador. Retorna el resultado de llamar al método @code{close()} del `target' pasado durante la construcción; por defecto, es el elemento del documento de nivel superior.
@end deffn

@geindex feed() (método de xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser feed}@anchor{36f5}
@deffn {Método} feed (data)

Introduce los datos en el analizador sintáctico. `data' son datos codificados.
@end deffn

@geindex flush() (método de xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser flush}@anchor{3c6}
@deffn {Método} flush ()

Triggers parsing of any previously fed unparsed data, which can be
used to ensure more immediate feedback, in particular with Expat >=2.6.0.
The implementation of @ref{3c6,,flush()} temporarily disables reparse deferral
with Expat (if currently enabled) and triggers a reparse.
Disabling reparse deferral has security consequences; please see
@ref{3c9,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} for details.

Note that @ref{3c6,,flush()} has been backported to some prior releases of
CPython as a security fix.  Check for availability of @ref{3c6,,flush()}
using @ref{579,,hasattr()} if used in code running across a variety of Python
versions.


Added in version 3.13.

@end deffn

@ref{36f5,,XMLParser.feed()} llama al método @code{start(tag, attrs_dict)} de `target' para cada etiqueta de apertura, a su método @code{end(tag)} para cada etiqueta de cierre, y los datos son procesados por el método @code{data(data)}. Para más métodos de callback soportados, véase la clase @ref{ae6,,TreeBuilder}. @ref{36f6,,XMLParser.close()} llama al método @code{close()} de `target'. @ref{ae5,,XMLParser} puede utilizarse no sólo para construir una estructura de árbol. Este es un ejemplo de contar la profundidad máxima de un archivo XML:

@example
>>> from xml.etree.ElementTree import XMLParser
>>> class MaxDepth:                     # The target object of the parser
...     maxDepth = 0
...     depth = 0
...     def start(self, tag, attrib):   # Called for each opening tag.
...         self.depth += 1
...         if self.depth > self.maxDepth:
...             self.maxDepth = self.depth
...     def end(self, tag):             # Called for each closing tag.
...         self.depth -= 1
...     def data(self, data):
...         pass            # We do not need to do anything with data.
...     def close(self):    # Called when all data has been parsed.
...         return self.maxDepth
...
>>> target = MaxDepth()
>>> parser = XMLParser(target=target)
>>> exampleXml = """
... <a>
...   <b>
...   </b>
...   <b>
...     <c>
...       <d>
...       </d>
...     </c>
...   </b>
... </a>"""
>>> parser.feed(exampleXml)
>>> parser.close()
4
@end example
@end deffn

@node Objetos XMLPullParser,Excepciones<17>,Objetos XMLParser,Referencia<4>
@anchor{library/xml etree elementtree elementtree-xmlpullparser-objects}@anchor{36f7}@anchor{library/xml etree elementtree xmlpullparser-objects}@anchor{36f8}
@subsubsection Objetos XMLPullParser


@geindex XMLPullParser (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser}@anchor{1070}
@deffn {Clase} xml.etree.ElementTree.XMLPullParser (events=None)

Un analizador sintáctico pull adecuado para aplicaciones no bloqueantes. Su API de entrada es similar a la de @ref{ae5,,XMLParser}, pero en lugar de enviar llamadas a un objetivo de devolución de llamada, @ref{1070,,XMLPullParser} recoge una lista interna de eventos de análisis y permite al usuario leer de ella. `events' son una secuencia de eventos a reportar. Los eventos soportados son las cadenas @code{"start"}, @code{"end"}, @code{"comment"}, @code{"pi"}, @code{"start-ns"} y @code{"end-ns"} (los eventos «ns» se utilizan para obtener información detallada del espacio de nombres). Si se omite `events', sólo se informará de los eventos @code{"end"}.

@geindex feed() (método de xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser feed}@anchor{36ae}
@deffn {Método} feed (data)

Introduce los datos de los bytes dados en el analizador.
@end deffn

@geindex flush() (método de xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser flush}@anchor{3c7}
@deffn {Método} flush ()

Triggers parsing of any previously fed unparsed data, which can be
used to ensure more immediate feedback, in particular with Expat >=2.6.0.
The implementation of @ref{3c7,,flush()} temporarily disables reparse deferral
with Expat (if currently enabled) and triggers a reparse.
Disabling reparse deferral has security consequences; please see
@ref{3c9,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} for details.

Note that @ref{3c7,,flush()} has been backported to some prior releases of
CPython as a security fix.  Check for availability of @ref{3c7,,flush()}
using @ref{579,,hasattr()} if used in code running across a variety of Python
versions.


Added in version 3.13.

@end deffn

@geindex close() (método de xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser close}@anchor{36f9}
@deffn {Método} close ()

Señala al analizador que el flujo de datos ha terminado. A diferencia de @ref{36f6,,XMLParser.close()}, este método siempre retorna @ref{716,,None}. Cualquier evento que no haya sido recuperado cuando el analizador se cierra puede ser leído con @ref{36af,,read_events()}.
@end deffn

@geindex read_events() (método de xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser read_events}@anchor{36af}
@deffn {Método} read_events ()

Retorna un iterador sobre los eventos que se han encontrado en los datos alimentados al analizador. El iterador retorna pares @code{(event, elem)}, donde `event' es una cadena de caracteres que representa el tipo de evento (por ejemplo, @code{"fin"}) y `elem' es el objeto @ref{20b,,Element} encontrado, u otro valor de contexto como el siguiente.


@itemize *

@item 
@code{start}, @code{end}: el Element actual.

@item 
@code{comment}, @code{pi}: el comentario / la instrucción de procesamiento actual

@item 
@code{start-ns}: una tupla @code{(prefix, uri)} que nombra el mapeo del espacio de nombres declarado.

@item 
@code{end-ns}: @ref{716,,None} (esto puede cambiar en una versión futura)
@end itemize

Los eventos proporcionados en una llamada anterior a @ref{36af,,read_events()} no serán retornados nuevamente. Los eventos se consumen de la cola interna sólo cuando se recuperan del iterador, por lo que múltiples lectores iterando en paralelo sobre iteradores obtenidos de @ref{36af,,read_events()} tendrán resultados impredecibles.
@end deffn

@cartouche
@quotation Nota 
@ref{1070,,XMLPullParser} sólo garantiza que ha visto el carácter «>» de una etiqueta de inicio cuando emite un evento «start», por lo que los atributos están definidos, pero el contenido de los atributos text y tail está indefinido en ese momento. Lo mismo ocurre con los hijos del elemento; pueden estar presentes o no.

Si necesita un elemento totalmente poblado, busque los eventos «end» en su lugar.
@end quotation
@end cartouche


Added in version 3.4.



Distinto en la versión 3.8: Los eventos @code{comment} y @code{pi} han sido añadidos.

@end deffn

@node Excepciones<17>,,Objetos XMLPullParser,Referencia<4>
@anchor{library/xml etree elementtree exceptions}@anchor{36fa}
@subsubsection Excepciones


@geindex ParseError (clase en xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError}@anchor{12e5}
@deffn {Clase} xml.etree.ElementTree.ParseError

Error de análisis de XML, lanzado por los distintos métodos de análisis de este módulo cuando el análisis falla. La representación en cadena de caracteres de una instancia de esta excepción contendrá un mensaje de error fácil de entender. Además, tendrá los siguientes atributos disponibles:

@geindex code (atributo de xml.etree.ElementTree.ParseError)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError code}@anchor{36fb}
@deffn {Atributo} code

Un código de error numérico del analizador sintáctico expat. Consulte la documentación de @ref{126,,xml.parsers.expat} para ver la lista de códigos de error y sus significados.
@end deffn

@geindex position (atributo de xml.etree.ElementTree.ParseError)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError position}@anchor{36fc}
@deffn {Atributo} position

Una tupla de números de `line', `column', que especifica dónde se produjo el error.
@end deffn
@end deffn

@subsubheading Notas al pie de página


@node xml dom — The Document Object Model API,xml dom minidom — Minimal DOM implementation,xml etree ElementTree — The ElementTree XML API,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml dom doc}@anchor{36fd}@anchor{library/xml dom module-xml dom}@anchor{121}@anchor{library/xml dom xml-dom-the-document-object-model-api}@anchor{36fe}
@subsection @code{xml.dom} — The Document Object Model API


@geindex module; xml.dom

`Código Fuente:' Lib/xml/dom/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/dom/__init__.py}


__________________________________________________________________


El Modelo de Objetos del Documento, o «DOM» por sus siglas en inglés, es un lenguaje API del Consorcio `World Wide Web' (W3C) para acceder y modificar documentos XML. Una implementación del DOM presenta los documento XML como un árbol, o permite al código cliente construir dichas estructuras desde cero para luego darles acceso a la estructura a través de un conjunto de objetos que implementaron interfaces conocidas.

El DOM es extremadamente útil para aplicaciones de acceso directo. SAX sólo te permite la vista de una parte del documento a la vez. Si estás mirando un elemento SAX, no tienes acceso a otro. Si estás viendo un nodo de texto, no tienes acceso al elemento contenedor. Cuando desarrollas una aplicación SAX, necesitas registrar la posición de tu programa en el documento en algún lado de tu código. SAX no lo hace por ti. Además, desafortunadamente no podrás mirar hacia adelante (`look ahead') en el documento XML.

Algunas aplicaciones son imposibles en un modelo orientado a eventos sin acceso a un árbol. Por supuesto que puedes construir algún tipo de árbol por tu cuenta en eventos SAX, pero el DOM te evita escribir ese código. El DOM es una representación de árbol estándar para datos XML.

El Modelo de Objetos del Documento es definido por el `W3C' en fases, o «niveles» en su terminología. El mapeado de Python de la API está basado en la recomendación del DOM nivel 2.

@c What if your needs are somewhere between SAX and the DOM?  Perhaps
@c you cannot afford to load the entire tree in memory but you find the
@c SAX model somewhat cumbersome and low-level.  There is also a module
@c called xml.dom.pulldom that allows you to build trees of only the
@c parts of a document that you need structured access to.  It also has
@c features that allow you to find your way around the DOM.
@c See http://www.prescod.net/python/pulldom

Las aplicaciones DOM típicamente empiezan al diseccionar (`parse') el XML en un DOM. Cómo esto funciona no está incluido en el DOM nivel 1, y el nivel 2 provee mejoras limitadas. Existe una clase objeto llamada @code{DOMImplementation} que da acceso a métodos de creación de @code{Document}, pero de ninguna forma da acceso a los constructores (`builders') de `reader'/`parser'/`Document' de una forma independiente a la implementación. No hay una forma clara para acceder a estos método sin un objeto @code{Document} existente. En Python, cada implementación del DOM proporcionará una función @ref{36ff,,getDOMImplementation()}. El DOM de nivel 3 añade una especificación para Cargar(`Load')/Guardar(`Store'), que define una interfaz al lector (`reader'), pero no está disponible aún en la librería estándar de Python.

Una vez que tengas un objeto del documento del DOM, puedes acceder a las partes de tu documento XML a través de sus propiedades y métodos. Estas propiedades están definidas en la especificación del DOM; está porción del manual describe la interpretación de la especificación en Python.

La especificación estipulada por el `W3C' define la `DOM API' para Java, ECMAScript, y OMG IDL. El mapeo de Python definido aquí está basado en gran parte en la versión IDL de la especificación, pero no se requiere el cumplimiento estricto (aunque las implementaciones son libres de soportar el mapeo estricto de IDL). Véase la sección @ref{3700,,Conformidad} para una discusión detallada del mapeo de los requisitos.


@subsubheading Ver también



@table @asis

@item Document Object Model (DOM) Level 2 Specification@footnote{https://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/}

La recomendación del `W3C' con la cual se basa el `DOM API' de Python.

@item Document Object Model (DOM) Level 1 Specification@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

La recomendación del W3C para el DOM soportada por @ref{122,,xml.dom.minidom}.

@item Python Language Mapping Specification@footnote{https://www.omg.org/spec/PYTH/1.2/PDF}

Este documento especifica el mapeo de OMG IDL a Python.
@end table


@menu
* Contenido del módulo: Contenido del módulo<2>. 
* Objetos en el DOM:: 
* Conformidad:: 

@end menu

@node Contenido del módulo<2>,Objetos en el DOM,,xml dom — The Document Object Model API
@anchor{library/xml dom module-contents}@anchor{3701}
@subsubsection Contenido del módulo


El módulo @ref{121,,xml.dom} contiene las siguientes funciones:

@geindex registerDOMImplementation() (en el módulo xml.dom)
@anchor{library/xml dom xml dom registerDOMImplementation}@anchor{3702}
@deffn {Función} xml.dom.registerDOMImplementation (name, factory)

Registra la función `factory' con el nombre `name'. La función fábrica (`factory') debe retornar un objeto que implemente la interfaz @code{DOMImplementation}. La función fábrica puede retornar el mismo objeto cada vez que se llame, o uno nuevo por cada llamada, según sea apropiado para la implementación específica (e.g. si la implementación soporta algunas personalizaciones).
@end deffn

@geindex getDOMImplementation() (en el módulo xml.dom)
@anchor{library/xml dom xml dom getDOMImplementation}@anchor{36ff}
@deffn {Función} xml.dom.getDOMImplementation (name=None, features=())

Retorna una implementación del DOM apropiada. El `name' es o bien conocido, el nombre del módulo de una implementación DOM, o @code{None}. Si no es @code{None} importa el módulo correspondiente y retorna un objeto @code{DomImplementation} si la importación tiene éxito. Si no se le pasa un nombre, y el entorno de variable 
@geindex PYTHON_DOM
@geindex variables de entorno; PYTHON_DOM
@code{PYTHON_DOM} ha sido puesto, dicha variable es usada para encontrar la información de la implementación.

Si no se le pasa un nombre, examina las implementaciones disponibles para encontrar uno con el conjunto de características requeridas. Si no se encuentra ninguna implementación, lanza una excepción @ref{4d7,,ImportError}. La lista de características debe ser una secuencia de pares @code{(feature,version)} que son pasados al método @code{hasFeature()} en objetos disponibles de @code{DOMImplementation}.
@end deffn

Algunas constantes convenientes son proporcionadas:

@geindex EMPTY_NAMESPACE (en el módulo xml.dom)
@anchor{library/xml dom xml dom EMPTY_NAMESPACE}@anchor{3703}
@deffn {Dato} xml.dom.EMPTY_NAMESPACE

El valor usado para indicar que ningún espacio de nombres es asociado con un nodo en el DOM. Se encuentra típicamente con el @code{namespaceURI} de un nodo, o usado como el parámetro  `namespaceURI' para un método específico del `namespace'.
@end deffn

@geindex XML_NAMESPACE (en el módulo xml.dom)
@anchor{library/xml dom xml dom XML_NAMESPACE}@anchor{3704}
@deffn {Dato} xml.dom.XML_NAMESPACE

El espacio de nombres de la URI asociada con el prefijo @code{xml}, como se define por Namespaces in XML@footnote{https://www.w3.org/TR/REC-xml-names/} (sección 4).
@end deffn

@geindex XMLNS_NAMESPACE (en el módulo xml.dom)
@anchor{library/xml dom xml dom XMLNS_NAMESPACE}@anchor{3705}
@deffn {Dato} xml.dom.XMLNS_NAMESPACE

El espacio de nombres del URI para declaraciones del espacio de nombres, como se define en Document Object Model (DOM) Level 2 Core Specification@footnote{https://www.w3.org/TR/DOM-Level-2-Core/core.html} (sección 1.1.8).
@end deffn

@geindex XHTML_NAMESPACE (en el módulo xml.dom)
@anchor{library/xml dom xml dom XHTML_NAMESPACE}@anchor{3706}
@deffn {Dato} xml.dom.XHTML_NAMESPACE

El URI del espacio de nombres del XHTML como se define en XHTML 1.0: The Extensible HyperText Markup Language@footnote{https://www.w3.org/TR/xhtml1/} (sección 3.1.1).
@end deffn

Además, @ref{121,,xml.dom} contiene una clase base @code{Node} y las clases de excepciones del DOM. La clase @code{Node} proporcionada por este módulo no implementa ninguno de los métodos o atributos definidos en la especificación DOM; las implementaciones del DOM concretas deben definirlas. La clase @code{Node} propuesta por este módulo sí proporciona las constantes usadas por el atributo @code{nodeType} en objetos concretos de @code{Node}; estas son localizadas dentro de la clase en vez de estar al nivel del módulo para cumplir las especificaciones del DOM.

@c Should the Node documentation go here?

@node Objetos en el DOM,Conformidad,Contenido del módulo<2>,xml dom — The Document Object Model API
@anchor{library/xml dom dom-objects}@anchor{3707}@anchor{library/xml dom objects-in-the-dom}@anchor{3708}
@subsubsection Objetos en el DOM


La documentación definitiva para el DOM es la especificación del DOM del W3C.

Note que los atributos del DOM también pueden ser manipulados como nodos en vez de simples cadenas de caracteres (`strings'). Sin embargo, es bastante raro que tengas que hacer esto, por lo que su uso aún no está documentado.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Interfaz

@tab

Sección

@tab

Propósito

@item

@code{DOMImplementation}

@tab

@ref{3709,,Objetos DOMImplementation}

@tab

Interfaz para las implementaciones subyacentes.

@item

@code{Node}

@tab

@ref{370a,,Objetos nodo}

@tab

Interfaz base para la mayoría de objetos en un documento.

@item

@code{NodeList}

@tab

@ref{370b,,Objetos NodeList}

@tab

Interfaz para una secuencia de nodos.

@item

@code{DocumentType}

@tab

@ref{370c,,Objetos DocumentType}

@tab

Información acerca de la declaraciones necesarias para procesar un documento.

@item

@code{Document}

@tab

@ref{370d,,Objetos documento}

@tab

Objeto que representa un documento entero.

@item

@code{Element}

@tab

@ref{370e,,Objetos elemento}

@tab

Nodos elemento en la jerarquía del documento.

@item

@code{Attr}

@tab

@ref{370f,,Objetos atributo}

@tab

Nodos de los valores de los atributos en los elementos nodo.

@item

@code{Comment}

@tab

@ref{3710,,Objetos comentario}

@tab

Representación de los comentarios en el documento fuente.

@item

@code{Text}

@tab

@ref{3711,,Objetos Texto y CDATASection}

@tab

Nodos con contenido textual del documento.

@item

@code{ProcessingInstruction}

@tab

@ref{3712,,Objetos ProcessingInstruction}

@tab

Representación de instrucción del procesamiento.

@end multitable


Una sección adicional describe las excepciones definidas para trabajar con el `DOM' en Python.

@menu
* Objetos DOMImplementation:: 
* Objetos nodo:: 
* Objetos NodeList:: 
* Objetos DocumentType:: 
* Objetos documento:: 
* Objetos elemento:: 
* Objetos atributo:: 
* Objetos NamedNodeMap:: 
* Objetos comentario:: 
* Objetos Texto y CDATASection:: 
* Objetos ProcessingInstruction:: 
* Excepciones: Excepciones<18>. 

@end menu

@node Objetos DOMImplementation,Objetos nodo,,Objetos en el DOM
@anchor{library/xml dom dom-implementation-objects}@anchor{3709}@anchor{library/xml dom domimplementation-objects}@anchor{3713}
@subsubsection Objetos `DOMImplementation'


La interfaz @code{DOMImplementation} proporciona una forma para que las aplicaciones determinen la disponibilidad de características particulares en el `DOM' que están usando. El `DOM' nivel 2 añadió la habilidad de crear nuevos objetos @code{Document} y @code{DocumentType} usando @code{DOMImplementation} también.

@geindex hasFeature() (método de xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation hasFeature}@anchor{3714}
@deffn {Método} DOMImplementation.hasFeature (feature, version)

Retorna @code{True} si la característica identificada por el par de cadenas de caracteres `feature' y `version' está implementada.
@end deffn

@geindex createDocument() (método de xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation createDocument}@anchor{3715}
@deffn {Método} DOMImplementation.createDocument (namespaceUri, qualifiedName, doctype)

Retorna un nuevo objeto @code{Document} (la raíz del DOM), con un hijo objeto @code{Element} teniendo el `namespaceUri' y `qualifiedName' dados. El `doctype' debe ser un @code{DocumentType} creado por @ref{3716,,createDocumentType()} o @code{None}. En la `DOM API' de Python, los primeros argumentos pueden ser @code{None} para indicar que ningún hijo @code{Element} va a ser creado.
@end deffn

@geindex createDocumentType() (método de xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation createDocumentType}@anchor{3716}
@deffn {Método} DOMImplementation.createDocumentType (qualifiedName, publicId, systemId)

Retorna un nuevo objeto @code{DocumentType} que encapsula las cadenas de caracteres `qualifiedName', `publicId', y `systemId' dadas, representando la información contenida en un tipo de declaración de documento XML.
@end deffn

@node Objetos nodo,Objetos NodeList,Objetos DOMImplementation,Objetos en el DOM
@anchor{library/xml dom dom-node-objects}@anchor{370a}@anchor{library/xml dom node-objects}@anchor{3717}
@subsubsection Objetos nodo


Todos los componentes de un documento XML son sub-clases de @code{Node}.

@geindex nodeType (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeType}@anchor{3718}
@deffn {Atributo} Node.nodeType

Un entero representando el tipo de nodo.  Las Constantes simbólicas para los tipos están en el objeto @code{Nodo}: @code{ELEMENT_NODE}, @code{ATTRIBUTE_NODE}, @code{TEXT_NODE}, @code{CDATA_SECTION_NODE}, @code{ENTITY_NODE}, @code{PROCESSING_INSTRUCTION_NODE}, @code{COMMENT_NODE}, @code{DOCUMENT_NODE}, @code{DOCUMENT_TYPE_NODE}, @code{NOTATION_NODE}. Este es un atributo sólo de lectura.
@end deffn

@geindex parentNode (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node parentNode}@anchor{3719}
@deffn {Atributo} Node.parentNode

El padre del nodo actual, o @code{None} para el nodo del documento. El valor es siempre un objeto @code{Node} o @code{None}. Para los nodos @code{Element}, este será el elemento padre, excepto para el elemento raíz, en cuyo caso será el objeto @code{Document}. Para los nodos @code{Attr}, este siempre es @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex attributes (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node attributes}@anchor{371a}
@deffn {Atributo} Node.attributes

Un @code{NamedNodeMap} de objetos de atributos. Sólo los elementos tienes un valor real para esto; otros nodos proporcionan @code{None} para este atributo. Este es un atributo de sólo lectura.
@end deffn

@geindex previousSibling (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node previousSibling}@anchor{371b}
@deffn {Atributo} Node.previousSibling

El nodo que precede inmediatamente este nodo con el mismo padre.  Por ejemplo el elemento con una etiqueta final que viene justo antes de la etiqueta del comienzo del elemento `self'.  Por supuesto, los documentos XML está hechos de más que sólo elementos por lo que el hermano anterior puede ser un texto, un comentario, o algo más. Si este nodo es el primer hijo del padre, este atributo será @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex nextSibling (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node nextSibling}@anchor{371c}
@deffn {Atributo} Node.nextSibling

El nodo que sigue inmediatamente este nodo con el mismo padre.  Véase también @ref{371b,,previousSibling}. Si este es el último hijo del padre, este atributo será @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex childNodes (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node childNodes}@anchor{371d}
@deffn {Atributo} Node.childNodes

Una lista de nodos contenidos dentro de este nodo. Este es un atributo de sólo lectura.
@end deffn

@geindex firstChild (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node firstChild}@anchor{371e}
@deffn {Atributo} Node.firstChild

El primer hijo del nodo, si hay alguno, o @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex lastChild (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node lastChild}@anchor{371f}
@deffn {Atributo} Node.lastChild

El último hijo del nodo, si hay alguno, o @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex localName (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node localName}@anchor{3720}
@deffn {Atributo} Node.localName

La parte del @code{tagName} seguido de los dos puntos si hay uno, si no, el @code{tagName} entero.  El valor es una cadena de caracteres.
@end deffn

@geindex prefix (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node prefix}@anchor{3721}
@deffn {Atributo} Node.prefix

La parte del @code{tagName} antes de los dos puntos si hay uno, si no, la cadena de caracteres vacía. El valor es una cadena, o @code{None}.
@end deffn

@geindex namespaceURI (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node namespaceURI}@anchor{3722}
@deffn {Atributo} Node.namespaceURI

El espacio de nombres asociado con el nombre del elemento.  Este será una cadena de caracteres o @code{None}.  Este es una atributo de sólo lectura.
@end deffn

@geindex nodeName (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeName}@anchor{3723}
@deffn {Atributo} Node.nodeName

Este tiene un significado diferente para cada tipo de nodo; véase la especificación del DOM para los detalles.  Siempre puedes obtener la información que obtendrías aquí desde otra propiedad como la propiedad @code{tagName} para elementos o la propiedad @code{name} para atributos. Para todos los tipos de nodo, el valor de este atributo tendrá o una cadena de caracteres o @code{None}. Este es un atributo de sólo lectura.
@end deffn

@geindex nodeValue (atributo de xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeValue}@anchor{3724}
@deffn {Atributo} Node.nodeValue

Este tiene un significado diferente para cada tipo de nodo; véase la especificación del DOM para los detalles.  La situación es similar a ese con @ref{3723,,nodeName}.  El valor es una cadena de caracteres o @code{None}.
@end deffn

@geindex hasAttributes() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node hasAttributes}@anchor{3725}
@deffn {Método} Node.hasAttributes ()

Retorna @code{True} si el nodo tiene algún atributo.
@end deffn

@geindex hasChildNodes() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node hasChildNodes}@anchor{3726}
@deffn {Método} Node.hasChildNodes ()

Retorna @code{True} si el nodo tiene algún nodo hijo.
@end deffn

@geindex isSameNode() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node isSameNode}@anchor{3727}
@deffn {Método} Node.isSameNode (other)

Retorna @code{True} si `other' hace referencia al mismo nodo como este nodo. Esto es especialmente útil para las implementaciones DOM que usan una arquitectura `proxy' de cualquier tipo (porque más de un objeto puede hacer referencia al mismo nodo).

@cartouche
@quotation Nota 
Esto se basa en una `DOM API' de nivel 3 propuesta que está en la etapa de «borrador de trabajo» (`«working draft»'), pero esta interfaz en particular no parece controversial.  Los cambios del `W3C' necesariamente no afectaran este método en la interfaz del `DOM' del Python (aunque cualquier nueva `API' del `W3C' para esto también sería soportado).
@end quotation
@end cartouche
@end deffn

@geindex appendChild() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node appendChild}@anchor{3728}
@deffn {Método} Node.appendChild (newChild)

Añade un nuevo nodo hijo a este nodo al final de la lista de hijos, retornando `newChild'. Si el nodo ya estaba en el árbol, este se remueve primero.
@end deffn

@geindex insertBefore() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node insertBefore}@anchor{3729}
@deffn {Método} Node.insertBefore (newChild, refChild)

Inserta un nuevo nodo hijo antes de un hijo existente.  Debe ser el caso que `refChild' sea un hijo de este nodo; si no, @ref{360,,ValueError} es lanzado. `newChild' es retornado. Si `refChild' es @code{None}, se inserta a `newChild' al final de la lista de hijos.
@end deffn

@geindex removeChild() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node removeChild}@anchor{372a}
@deffn {Método} Node.removeChild (oldChild)

Elimina un nodo hijo.  `oldChild' debe ser un hijo de este nodo; si no, @ref{360,,ValueError} es lanzado.  `oldChild' es retornado si tiene éxito.  Si `oldChild' no será usado más adelante, se debe llamar a su método @code{unlink()}.
@end deffn

@geindex replaceChild() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node replaceChild}@anchor{372b}
@deffn {Método} Node.replaceChild (newChild, oldChild)

Reemplaza un nodo existente con un nuevo nodo. Debe ser el caso que  `oldChild' sea un hijo de este nodo; si no, @ref{360,,ValueError} es lanzado.
@end deffn

@geindex normalize() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node normalize}@anchor{372c}
@deffn {Método} Node.normalize ()

Une nodos de texto adyacentes para que todos los tramos de texto sean guardados como únicas instancias de @code{Text}. Esto simplifica el procesamiento de texto de un árbol del `DOM' para muchas aplicaciones.
@end deffn

@geindex cloneNode() (método de xml.dom.Node)
@anchor{library/xml dom xml dom Node cloneNode}@anchor{372d}
@deffn {Método} Node.cloneNode (deep)

Clona este nodo.  Poner `deep' significa clonar todos los nodos hijo también.  Esto retorna el clon.
@end deffn

@node Objetos NodeList,Objetos DocumentType,Objetos nodo,Objetos en el DOM
@anchor{library/xml dom dom-nodelist-objects}@anchor{370b}@anchor{library/xml dom nodelist-objects}@anchor{372e}
@subsubsection Objetos `NodeList'


Un @code{NodeList} representa una secuencia de nodos.  Estos objetos se usan de dos formas en la recomendación principal del `DOM':  un objeto @code{Element} proporciona uno como su lista de nodos hijo, y los métodos @code{getElementsByTagName()} y @code{getElementsByTagNameNS()} de @code{Node} retornan objetos con esta interfaz para representar resultados de consulta.

La recomendación del `DOM' nivel 2 define un método y un atributo para estos objetos:

@geindex item() (método de xml.dom.NodeList)
@anchor{library/xml dom xml dom NodeList item}@anchor{372f}
@deffn {Método} NodeList.item (i)

Retorna el i-ésimo `item' de la secuencia, si hay uno, o @code{None}. El índice `i' no puede ser menor que cero o mayor o igual que el tamaño de la secuencia.
@end deffn

@geindex length (atributo de xml.dom.NodeList)
@anchor{library/xml dom xml dom NodeList length}@anchor{3730}
@deffn {Atributo} NodeList.length

El número de nodos en la secuencia.
@end deffn

Además, la interfaz `DOM' de Python requiere que un algún soporte adicional sea proporcionado para que los objetos @code{NodeList} puedan ser usados como secuencias de Python.  Todas las implementaciones de @code{NodeList} deben incluir soporte para @ref{1f62,,__len__()} y @ref{3d8,,__getitem__()}; esto permite la iteración de @code{NodeList} en sentencias con @ref{1eb,,for} y un soporte apropiado para la función incorporada @ref{6cf,,len()}.

Si una implementación DOM soporta la modificación del documento, la implementación de @code{NodeList} debe también soportar los métodos @ref{1505,,__setitem__()} y @ref{1506,,__delitem__()}.

@node Objetos DocumentType,Objetos documento,Objetos NodeList,Objetos en el DOM
@anchor{library/xml dom documenttype-objects}@anchor{3731}@anchor{library/xml dom dom-documenttype-objects}@anchor{370c}
@subsubsection Objetos `DocumentType'


La información acerca de las notaciones y entidades declaradas por un documento (incluido el subconjunto externo si el analizador lo usa y puede proporcionar información) está disponible desde un objeto @code{DocumentType}.  El @code{DocumentType} para un documento está disponible desde el atributo @code{doctype} del objeto @code{Document}; si no hay ninguna declaración @code{DOCTYPE} para el documento, el atributo @code{doctype} del documento se pondrá como @code{None} en vez de una instancia de esta interfaz.

@code{DocumentType} es una especialización de @code{Node}, y añade los siguientes atributos:

@geindex publicId (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType publicId}@anchor{3732}
@deffn {Atributo} DocumentType.publicId

El identificador público para el subconjunto externo de la definición del tipo de documento. Esto será una cadena de caracteres o @code{None}.
@end deffn

@geindex systemId (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType systemId}@anchor{3733}
@deffn {Atributo} DocumentType.systemId

El identificador del sistema para el subconjunto externo de la definición del tipo de documento. Esto será una `URI' como una cadena de caracteres, o @code{None}.
@end deffn

@geindex internalSubset (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType internalSubset}@anchor{3734}
@deffn {Atributo} DocumentType.internalSubset

Una cadena de caracteres proporcionando el subconjunto interno completo del documento. Esto no incluye los paréntesis que cierran el subconjunto.  Si el documento no tiene ningún subconjunto interno, debe ser @code{None}.
@end deffn

@geindex name (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType name}@anchor{3735}
@deffn {Atributo} DocumentType.name

El nombre del elemento raíz como se indica en la declaración @code{DOCTYPE}, si está presente.
@end deffn

@geindex entities (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType entities}@anchor{3736}
@deffn {Atributo} DocumentType.entities

Este es un @code{NamedNodeMap} proporcionando las definiciones de las entidades externas. Para nombres de entidades definidas más de una vez, sólo la primera definición es proporcionada (el resto es ignorado como se requiere por la recomendación de `XML').  Puede ser @code{None} si el analizador no proporciona la información, o si ninguna entidad es definida.
@end deffn

@geindex notations (atributo de xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType notations}@anchor{3737}
@deffn {Atributo} DocumentType.notations

Este es un @code{NamedNodeMap} proporcionando las definiciones de las notaciones. Para nombres de notaciones definidas más de una vez, sólo la primera definición es proporcionada (el resto es ignorado como se requiere por la recomendación `XML').  Puede ser @code{None} si el analizador no proporciona la información, o si no hay notaciones definidas.
@end deffn

@node Objetos documento,Objetos elemento,Objetos DocumentType,Objetos en el DOM
@anchor{library/xml dom document-objects}@anchor{3738}@anchor{library/xml dom dom-document-objects}@anchor{370d}
@subsubsection Objetos documento


Un @code{Documento} representa un documento `XML' entero, incluyendo sus elementos constituyentes, atributos, instrucciones de procesamiento, comentarios, etc. Recuerda que este hereda propiedades de @code{Node}.

@geindex documentElement (atributo de xml.dom.Document)
@anchor{library/xml dom xml dom Document documentElement}@anchor{3739}
@deffn {Atributo} Document.documentElement

El único elemento raíz del documento.
@end deffn

@geindex createElement() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createElement}@anchor{373a}
@deffn {Método} Document.createElement (tagName)

Crea y retorna un nuevo elemento nodo.  El elemento no se inserta en el documento cuando es creado.  Necesitas insertarlo explícitamente con uno de los otros métodos como @code{insertBefore()} o @code{appendChild()}.
@end deffn

@geindex createElementNS() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createElementNS}@anchor{373b}
@deffn {Método} Document.createElementNS (namespaceURI, tagName)

Crea y retorna un nuevo elemento con un espacio de nombres.  El `tagName' puede tener un prefijo.  El elemento no se inserta en el documento cuando es creado.  Necesitas insertarlo explícitamente con uno de los otros métodos como @code{insertBefore()} o @code{appendChild()}.
@end deffn

@geindex createTextNode() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createTextNode}@anchor{373c}
@deffn {Método} Document.createTextNode (data)

Crea y retorna un nodo texto conteniendo los datos pasados como parámetros,  Como con los otros métodos de creación, este no inserta el nodo en el árbol.
@end deffn

@geindex createComment() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createComment}@anchor{373d}
@deffn {Método} Document.createComment (data)

Crea y retorna un nodo comentario conteniendo los datos pasados como parámetros.  Como con los otros métodos de creación, este no inserta el nodo en el árbol.
@end deffn

@geindex createProcessingInstruction() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createProcessingInstruction}@anchor{373e}
@deffn {Método} Document.createProcessingInstruction (target, data)

Crea y retorna una instrucción de procesamiento conteniendo el `target' y `data' pasados como parámetros.  Como con los otros métodos de creación, este no inserta en nodo en el árbol.
@end deffn

@geindex createAttribute() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createAttribute}@anchor{373f}
@deffn {Método} Document.createAttribute (name)

Crea y retorna un nodo atributo.  Este método no asocia el nodo atributo con ningún elemento particular.  Debes usar @code{setAttributeNode()} en el objeto @code{Element} apropiado para usar la instancia del atributo recién creada.
@end deffn

@geindex createAttributeNS() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document createAttributeNS}@anchor{3740}
@deffn {Método} Document.createAttributeNS (namespaceURI, qualifiedName)

Crea y retorna un nodo atributo con un espacio de nombres.  El `tagName' puede ser un prefijo.  Este método no asocia el nodo atributo con ningún elemento en particular.  Debes usar @code{setAttributeNode()} en el objeto @code{Element} apropiado para usar la instancia del atributo recién creada.
@end deffn

@geindex getElementsByTagName() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document getElementsByTagName}@anchor{3741}
@deffn {Método} Document.getElementsByTagName (tagName)

Busca todos los descendientes (hijos directos, hijos de los hijos, etc.) con un nombre del tipo de elemento particular.
@end deffn

@geindex getElementsByTagNameNS() (método de xml.dom.Document)
@anchor{library/xml dom xml dom Document getElementsByTagNameNS}@anchor{3742}
@deffn {Método} Document.getElementsByTagNameNS (namespaceURI, localName)

Busca todos los descendientes (hijos directos, hijos de hijos, etc.) con un espacio de nombres URI particular (`namespaceURI') y nombre local (`localname'). El nombre local es parte del espacio de nombres después del prefijo.
@end deffn

@node Objetos elemento,Objetos atributo,Objetos documento,Objetos en el DOM
@anchor{library/xml dom dom-element-objects}@anchor{370e}@anchor{library/xml dom element-objects}@anchor{3743}
@subsubsection Objetos elemento


@code{Element} es una subclase de @code{Node}, por lo que hereda todos los atributos de esa clase.

@geindex tagName (atributo de xml.dom.Element)
@anchor{library/xml dom xml dom Element tagName}@anchor{3744}
@deffn {Atributo} Element.tagName

El nombre del tipo de elemento.  En un documento que usa espacios de nombres este puede tener varios dos puntos en el. El valor es una cadena de caracteres.
@end deffn

@geindex getElementsByTagName() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getElementsByTagName}@anchor{3745}
@deffn {Método} Element.getElementsByTagName (tagName)

Igual al método equivalente en la clase @code{Document}.
@end deffn

@geindex getElementsByTagNameNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getElementsByTagNameNS}@anchor{3746}
@deffn {Método} Element.getElementsByTagNameNS (namespaceURI, localName)

Igual al método equivalente en la clase @code{Document}.
@end deffn

@geindex hasAttribute() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element hasAttribute}@anchor{3747}
@deffn {Método} Element.hasAttribute (name)

Retorna @code{True} si el elemento tiene un atributo nombrado `name'.
@end deffn

@geindex hasAttributeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element hasAttributeNS}@anchor{3748}
@deffn {Método} Element.hasAttributeNS (namespaceURI, localName)

Retorna @code{True} si el elemento tiene un atributo nombrado por `namespaceURI' y `localName'.
@end deffn

@geindex getAttribute() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttribute}@anchor{3749}
@deffn {Método} Element.getAttribute (name)

Retorna el valor del atributo nombrado por `name' como una cadena de caracteres. Si no existe dicho atributo, una cadena vacía es retornada, como si el atributo no tuviera valor.
@end deffn

@geindex getAttributeNode() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNode}@anchor{374a}
@deffn {Método} Element.getAttributeNode (attrname)

Retorna el nodo @code{Attr} para el atributo nombrado por `attrname'.
@end deffn

@geindex getAttributeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNS}@anchor{374b}
@deffn {Método} Element.getAttributeNS (namespaceURI, localName)

Retorna el valor del atributo nombrado por `namespaceURI' y `localName' como una cadena de caracteres. Si no existe dicho atributo, una cadena vacía es retornada, como si el atributo no tuviera valor.
@end deffn

@geindex getAttributeNodeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNodeNS}@anchor{374c}
@deffn {Método} Element.getAttributeNodeNS (namespaceURI, localName)

Retorna un valor de atributo como nodo, dado un `namespaceURI' y `localName'.
@end deffn

@geindex removeAttribute() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttribute}@anchor{374d}
@deffn {Método} Element.removeAttribute (name)

Remueve un atributo por nombre (`name').  Si no hay un atributo correspondiente, un @ref{374e,,NotFoundErr} es lanzado.
@end deffn

@geindex removeAttributeNode() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttributeNode}@anchor{374f}
@deffn {Método} Element.removeAttributeNode (oldAttr)

Remueve y retorna `oldAttr' de la lista de atributos, si está presenta. Si `oldAttr' no está presente, @ref{374e,,NotFoundErr} es lanzado.
@end deffn

@geindex removeAttributeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttributeNS}@anchor{3750}
@deffn {Método} Element.removeAttributeNS (namespaceURI, localName)

Remueve un atributo por nombre (`name').  Note que esto usa un `localName', no un `qname'.  Ninguna excepción es lanzada si no existe el atributo correspondiente.
@end deffn

@geindex setAttribute() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttribute}@anchor{3751}
@deffn {Método} Element.setAttribute (name, value)

Pone un valor de atributo como una cadena de caracteres.
@end deffn

@geindex setAttributeNode() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNode}@anchor{3752}
@deffn {Método} Element.setAttributeNode (newAttr)

Añade un nuevo atributo nodo al elemento, reemplazando un atributo existente si es necesario si el atributo @code{name} coincide. Si un reemplazo ocurre, el viejo atributo será retornado. Si `newAttr' ya está en uso, @ref{3753,,InuseAttributeErr} será lanzado.
@end deffn

@geindex setAttributeNodeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNodeNS}@anchor{3754}
@deffn {Método} Element.setAttributeNodeNS (newAttr)

Añade un nuevo nodo atributo al elemento, reemplazando un atributo existente si es necesario, si el @code{namesapceURI} y @code{localName} coinciden. Si un reemplazo ocurre, el viejo atributo será retornado.  Si `newAttr' está en uso, @ref{3753,,InuseAttributeErr} será lanzado.
@end deffn

@geindex setAttributeNS() (método de xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNS}@anchor{3755}
@deffn {Método} Element.setAttributeNS (namespaceURI, qname, value)

Pone un valor de atributo a partir de una cadena de caracteres, dados un `namespaceURI' y `qname'. Note que un `qname' es el nombre completo del atributo. Esto es diferente al de arriba.
@end deffn

@node Objetos atributo,Objetos NamedNodeMap,Objetos elemento,Objetos en el DOM
@anchor{library/xml dom attr-objects}@anchor{3756}@anchor{library/xml dom dom-attr-objects}@anchor{370f}
@subsubsection Objetos atributo


@code{Attr} hereda de @code{Node}, por lo que hereda todos sus atributos.

@geindex name (atributo de xml.dom.Attr)
@anchor{library/xml dom xml dom Attr name}@anchor{3757}
@deffn {Atributo} Attr.name

El nombre del atributo. En un documento que usa espacio de nombres, puede incluir dos puntos.
@end deffn

@geindex localName (atributo de xml.dom.Attr)
@anchor{library/xml dom xml dom Attr localName}@anchor{3758}
@deffn {Atributo} Attr.localName

La parte del nombre seguido después de los dos puntos si hay uno, si no el nombre entero. Este es un atributo de sólo lectura.
@end deffn

@geindex prefix (atributo de xml.dom.Attr)
@anchor{library/xml dom xml dom Attr prefix}@anchor{3759}
@deffn {Atributo} Attr.prefix

La parte del nombre que precede los dos puntos si hay uno, si no la cadena de caracteres vacía.
@end deffn

@geindex value (atributo de xml.dom.Attr)
@anchor{library/xml dom xml dom Attr value}@anchor{375a}
@deffn {Atributo} Attr.value

El valor textual del atributo.  Este es un sinónimo para el atributo @code{nodeValue}.
@end deffn

@node Objetos NamedNodeMap,Objetos comentario,Objetos atributo,Objetos en el DOM
@anchor{library/xml dom dom-attributelist-objects}@anchor{375b}@anchor{library/xml dom namednodemap-objects}@anchor{375c}
@subsubsection Objetos `NamedNodeMap'


@code{NamedNodeMap} `no' hereda de @code{Node}.

@geindex length (atributo de xml.dom.NamedNodeMap)
@anchor{library/xml dom xml dom NamedNodeMap length}@anchor{375d}
@deffn {Atributo} NamedNodeMap.length

La longitud de la lista de atributos.
@end deffn

@geindex item() (método de xml.dom.NamedNodeMap)
@anchor{library/xml dom xml dom NamedNodeMap item}@anchor{375e}
@deffn {Método} NamedNodeMap.item (index)

Retorna un atributo con un índice particular.  El orden en los que obtienes los atributos es arbitrario pero será consistente en la vida de un `DOM'. Cada `item' es un nodo atributo.  Obtén su valor con el atributo @code{value}.
@end deffn

There are also experimental methods that give this class more mapping behavior.
You can use them or you can use the standardized @code{getAttribute*()} family
of methods on the @code{Element} objects.

@node Objetos comentario,Objetos Texto y CDATASection,Objetos NamedNodeMap,Objetos en el DOM
@anchor{library/xml dom comment-objects}@anchor{375f}@anchor{library/xml dom dom-comment-objects}@anchor{3710}
@subsubsection Objetos comentario


@code{Comment} representa un comentario en el documento `XML'.  Es una subclase de @code{Node}, pero no puede tener hijos nodo.

@geindex data (atributo de xml.dom.Comment)
@anchor{library/xml dom xml dom Comment data}@anchor{3760}
@deffn {Atributo} Comment.data

El contenido del comentario como una cadena de caracteres.  El atributo contiene todos los caracteres entre el @code{<!-}@code{-} que empieza y el @code{-}@code{->} que termina, pero no los incluye.
@end deffn

@node Objetos Texto y CDATASection,Objetos ProcessingInstruction,Objetos comentario,Objetos en el DOM
@anchor{library/xml dom dom-text-objects}@anchor{3711}@anchor{library/xml dom text-and-cdatasection-objects}@anchor{3761}
@subsubsection Objetos Texto y `CDATASection'


La interfaz @code{Text} representa el texto en el documento `XML'.  Si el analizador y la implementación del `DOM' soporta la extensión `XML' del `DOM', las porciones de texto rodeadas secciones marcadas como `CDATA' se guardan en objetos @code{CDATASection}. Estas dos interfaces son idénticas, pero proveen valores diferentes para el atributo @code{nodeType}.

Estas interfaces extienden la interfaz @code{Node}.  No pueden tener nodos hijo.

@geindex data (atributo de xml.dom.Text)
@anchor{library/xml dom xml dom Text data}@anchor{3762}
@deffn {Atributo} Text.data

El contenido del nodo texto como una cadena de caracteres.
@end deffn

@cartouche
@quotation Nota 
El uso de un nodo @code{CDATASection} no indica que el nodo represente una sección completa marcada como `CDATA', sólo que el contenido del nodo fue parte de una sección `CDATA'.  Una sola sección `CDATA' puede ser representada por más de un nodo en el árbol del documento.  No hay manera de determinar si dos nodos adyacentes @code{CDATASection} son representados diferentes a secciones marcadas como `CDATA'.
@end quotation
@end cartouche

@node Objetos ProcessingInstruction,Excepciones<18>,Objetos Texto y CDATASection,Objetos en el DOM
@anchor{library/xml dom dom-pi-objects}@anchor{3712}@anchor{library/xml dom processinginstruction-objects}@anchor{3763}
@subsubsection Objetos `ProcessingInstruction'


Representa una instrucción de procesamiento en el documento `XML'; hereda de la interfaz @code{Node} y no puede tener hijos.

@geindex target (atributo de xml.dom.ProcessingInstruction)
@anchor{library/xml dom xml dom ProcessingInstruction target}@anchor{3764}
@deffn {Atributo} ProcessingInstruction.target

El contenido de la instrucción de procesamiento hasta el carácter en blanco. Este es un atributo de sólo lectura.
@end deffn

@geindex data (atributo de xml.dom.ProcessingInstruction)
@anchor{library/xml dom xml dom ProcessingInstruction data}@anchor{3765}
@deffn {Atributo} ProcessingInstruction.data

El contenido de la instrucción de procesamiento después del primer carácter en blanco.
@end deffn

@node Excepciones<18>,,Objetos ProcessingInstruction,Objetos en el DOM
@anchor{library/xml dom dom-exceptions}@anchor{3766}@anchor{library/xml dom exceptions}@anchor{3767}
@subsubsection Excepciones


La recomendación del `DOM' nivel 2 define una sola excepción, @ref{3768,,DOMException}, y un número de constantes que permite que las aplicaciones determinen qué tipo de error ocurrió. las instancias de @ref{3768,,DOMException} llevan un atributo @ref{1b,,code} que proporciona el valor apropiado para la excepción específica.

La interfaz `DOM' de Python provee las constantes, pero también expande el conjunto de excepciones para que exista una excepción específica para cada uno de los códigos de excepción definidos por el `DOM'. Las implementaciones deben lanzar la excepción específica apropiada, cada uno de los cuales lleva el valor apropiado para el atributo @ref{1b,,code}.

@geindex DOMException
@anchor{library/xml dom xml dom DOMException}@anchor{3768}
@deffn {Excepción} xml.dom.DOMException

Clase base de excepción usada para todas las excepciones del `DOM' específicas. Esta clase de excepción no puede ser instanciada directamente.
@end deffn

@geindex DomstringSizeErr
@anchor{library/xml dom xml dom DomstringSizeErr}@anchor{3769}
@deffn {Excepción} xml.dom.DomstringSizeErr

Lanzado cuando un rango de texto específico no cabe en una cadena de caracteres.  No se sabe si se usa in las implementación `DOM' de Python, pero puede ser recibido de otras implementaciones `DOM' que no hayan sido escritas en Python.
@end deffn

@geindex HierarchyRequestErr
@anchor{library/xml dom xml dom HierarchyRequestErr}@anchor{376a}
@deffn {Excepción} xml.dom.HierarchyRequestErr

Lanzado cuando se intenta insertar un nodo donde el tipo de nodo no es permitido.
@end deffn

@geindex IndexSizeErr
@anchor{library/xml dom xml dom IndexSizeErr}@anchor{376b}
@deffn {Excepción} xml.dom.IndexSizeErr

Lanzado cuando un parámetro del índice o tamaño de un método es negativo o excede los valores permitidos.
@end deffn

@geindex InuseAttributeErr
@anchor{library/xml dom xml dom InuseAttributeErr}@anchor{3753}
@deffn {Excepción} xml.dom.InuseAttributeErr

Lanzado cuando se intenta insertar un nodo @code{Attr} que está presente en algún lado en el documento.
@end deffn

@geindex InvalidAccessErr
@anchor{library/xml dom xml dom InvalidAccessErr}@anchor{376c}
@deffn {Excepción} xml.dom.InvalidAccessErr

Lanzado si un parámetro o una operación no es soportada por el objeto subyacente.
@end deffn

@geindex InvalidCharacterErr
@anchor{library/xml dom xml dom InvalidCharacterErr}@anchor{376d}
@deffn {Excepción} xml.dom.InvalidCharacterErr

Esta excepción es lanzada cuando un parámetro de cadena de caracteres contiene un carácter que no está permitido en el contexto que está siendo usado por la recomendación `XML 1.0'. Por ejemplo, intentar crear un nodo @code{Element} con un espacio en el nombre del tipo de elemento causará que se lance este error.
@end deffn

@geindex InvalidModificationErr
@anchor{library/xml dom xml dom InvalidModificationErr}@anchor{376e}
@deffn {Excepción} xml.dom.InvalidModificationErr

Lanzado cuando se intenta modificar el tipo de un nodo.
@end deffn

@geindex InvalidStateErr
@anchor{library/xml dom xml dom InvalidStateErr}@anchor{376f}
@deffn {Excepción} xml.dom.InvalidStateErr

Lanzado cuando se intenta usar un objeto que no está definido o ya no es usable.
@end deffn

@geindex NamespaceErr
@anchor{library/xml dom xml dom NamespaceErr}@anchor{3770}
@deffn {Excepción} xml.dom.NamespaceErr

Si se intenta cambiar cualquier objeto de forma que no sea permitida con respecto a la recomendación Namespaces in XML@footnote{https://www.w3.org/TR/REC-xml-names/}, esta excepción es lanzada.
@end deffn

@geindex NotFoundErr
@anchor{library/xml dom xml dom NotFoundErr}@anchor{374e}
@deffn {Excepción} xml.dom.NotFoundErr

Excepción cuando un nodo no existe en el contexto referenciado.  Por ejemplo, @code{NamedNodeMap.removeNamedItem()} será lanzado si el nodo pasado no existe en el mapa.
@end deffn

@geindex NotSupportedErr
@anchor{library/xml dom xml dom NotSupportedErr}@anchor{3771}
@deffn {Excepción} xml.dom.NotSupportedErr

Lanzado cuando la implementación no soporta el tipo requerido del objeto u operación.
@end deffn

@geindex NoDataAllowedErr
@anchor{library/xml dom xml dom NoDataAllowedErr}@anchor{3772}
@deffn {Excepción} xml.dom.NoDataAllowedErr

Es lanzado si se especifican datos para un nodo que no soporta datos.

@c XXX  a better explanation is needed!
@end deffn

@geindex NoModificationAllowedErr
@anchor{library/xml dom xml dom NoModificationAllowedErr}@anchor{3773}
@deffn {Excepción} xml.dom.NoModificationAllowedErr

Lanzado cuando se intenta modificar un objeto donde las modificaciones no son permitidas (tal como los nodos de sólo-lectura).
@end deffn

@geindex SyntaxErr
@anchor{library/xml dom xml dom SyntaxErr}@anchor{3774}
@deffn {Excepción} xml.dom.SyntaxErr

Lanzado cuando se especifica una cadena de caracteres inválida o ilegal.

@c XXX  how is this different from InvalidCharacterErr?
@end deffn

@geindex WrongDocumentErr
@anchor{library/xml dom xml dom WrongDocumentErr}@anchor{3775}
@deffn {Excepción} xml.dom.WrongDocumentErr

Lanzado cuando un nodo es insertado en un documento diferente al que este actualmente pertenece, y la implementación no soporta migrar el nodo de un documento a otro.
@end deffn

Los códigos de excepción definidos en la recomendación del `DOM' se mapean a las excepciones descritas arriba de acuerdo a esta tabla:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Excepción

@item

@code{DOMSTRING_SIZE_ERR}

@tab

@ref{3769,,DomstringSizeErr}

@item

@code{HIERARCHY_REQUEST_ERR}

@tab

@ref{376a,,HierarchyRequestErr}

@item

@code{INDEX_SIZE_ERR}

@tab

@ref{376b,,IndexSizeErr}

@item

@code{INUSE_ATTRIBUTE_ERR}

@tab

@ref{3753,,InuseAttributeErr}

@item

@code{INVALID_ACCESS_ERR}

@tab

@ref{376c,,InvalidAccessErr}

@item

@code{INVALID_CHARACTER_ERR}

@tab

@ref{376d,,InvalidCharacterErr}

@item

@code{INVALID_MODIFICATION_ERR}

@tab

@ref{376e,,InvalidModificationErr}

@item

@code{INVALID_STATE_ERR}

@tab

@ref{376f,,InvalidStateErr}

@item

@code{NAMESPACE_ERR}

@tab

@ref{3770,,NamespaceErr}

@item

@code{NOT_FOUND_ERR}

@tab

@ref{374e,,NotFoundErr}

@item

@code{NOT_SUPPORTED_ERR}

@tab

@ref{3771,,NotSupportedErr}

@item

@code{NO_DATA_ALLOWED_ERR}

@tab

@ref{3772,,NoDataAllowedErr}

@item

@code{NO_MODIFICATION_ALLOWED_ERR}

@tab

@ref{3773,,NoModificationAllowedErr}

@item

@code{SYNTAX_ERR}

@tab

@ref{3774,,SyntaxErr}

@item

@code{WRONG_DOCUMENT_ERR}

@tab

@ref{3775,,WrongDocumentErr}

@end multitable


@node Conformidad,,Objetos en el DOM,xml dom — The Document Object Model API
@anchor{library/xml dom conformance}@anchor{3776}@anchor{library/xml dom dom-conformance}@anchor{3700}
@subsubsection Conformidad


Esta sección describe los requisitos de conformidad y las relaciones entre el `DOM API' de Python, las recomendaciones del `DOM' del `W3C', y el mapeo `OMG IDL' para Python.

@menu
* Mapeo de tipos:: 
* Métodos de acceso (accessor): Métodos de acceso accessor. 

@end menu

@node Mapeo de tipos,Métodos de acceso accessor,,Conformidad
@anchor{library/xml dom dom-type-mapping}@anchor{3777}@anchor{library/xml dom type-mapping}@anchor{3778}
@subsubsection Mapeo de tipos


Los tipos IDL usados en la especificación del `DOM' son mapeados a los tipos de tipos de Python de acuerdo a la siguiente tabla.


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo IDL

@tab

Tipo en Python

@item

@code{boolean}

@tab

@code{bool} o @code{int}

@item

@code{int}

@tab

@code{int}

@item

@code{long int}

@tab

@code{int}

@item

@code{unsigned int}

@tab

@code{int}

@item

@code{DOMString}

@tab

@code{str} o @code{bytes}

@item

@code{null}

@tab

@code{None}

@end multitable


@node Métodos de acceso accessor,,Mapeo de tipos,Conformidad
@anchor{library/xml dom accessor-methods}@anchor{3779}@anchor{library/xml dom dom-accessor-methods}@anchor{377a}
@subsubsection Métodos de acceso (`accessor')


El mapeo de `OMG IDL' a python define funciones de acceso para las declaraciones del atributo `IDL' de la que misma forma en que el mapeo de Java lo hace. Mapear las declaraciones IDL:

@example
readonly attribute string someValue;
         attribute string anotherValue;
@end example

produce tres funciones de acceso:  un método «get» para @code{someValue} (@code{_get_someValue()}), y métodos «get» y «set» para @code{anotherValue} (@code{_get_anotherValue()} y @code{_set_anotherValue()}). El mapeado, en particular, no requiere que los atributos `IDL' sean accesibles como los atributos normales de Python:  No es obligatorio que @code{object.someValue} funcione, y puede lanzar un @ref{441,,AttributeError}.

El `DOM API' de Python, sin embargo, `si' requiere que los atributos de acceso normales funcionen. Esto significa que no es probable que los típicos sustitutos generados por compiladores de `IDL' en Python funcionen, y los objetos envoltorio (`wrapper') pueden ser necesarios en el cliente si los objetos del `DOM' son accedidos mediante `CORBA'. Mientras que esto requiere consideraciones adicionales para clientes `DOM' en `CORBA', los implementadores con experiencia que usen `DOM' por encima de `CORBA' desde Python no lo consideran un problema.  Los atributos que se declaran @code{readonly} pueden no restringir el acceso de escritura en todas las implementaciones DOM.

En el `DOM API' de Python, las funciones de acceso no son obligatorias. Si se proveen, deben tomar la forma definida por el mapeo `IDL' de Python, pero estos métodos se consideran innecesarios debido a que los atributos son accesibles directamente desde Python. Nunca se deben proporcionar métodos de acceso (`accessor') «Set» para los atributos @code{readonly}.

Las definiciones de IDL no encarnan los requisitos del `DOM API' del `W3C' por completo, como las nociones de ciertos objetos, como el valor de retorno @code{getElementsByTagName()}, siendo «live». El DOM API de Python no requiere que las implementaciones hagan cumplir tales requisitos.

@node xml dom minidom — Minimal DOM implementation,xml dom pulldom — Support for building partial DOM trees,xml dom — The Document Object Model API,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml dom minidom doc}@anchor{377b}@anchor{library/xml dom minidom module-xml dom minidom}@anchor{122}@anchor{library/xml dom minidom xml-dom-minidom-minimal-dom-implementation}@anchor{377c}
@subsection @code{xml.dom.minidom} — Minimal DOM implementation


@geindex module; xml.dom.minidom

`Código fuente:' Lib/xml/dom/minidom.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/dom/minidom.py}


__________________________________________________________________


@ref{122,,xml.dom.minidom} es una implementación mínima de la interfaz Document Object Model (Modelo de objetos del documento), con una API similar a la de otros lenguajes. Está destinada a ser más simple que una implementación completa del DOM y también significativamente más pequeña. Aquellos usuarios que aún no dominen el DOM deberían considerar usar el módulo @ref{125,,xml.etree.ElementTree} en su lugar para su procesamiento XML.

@cartouche
@quotation Advertencia 
El módulo @ref{122,,xml.dom.minidom} no es seguro contra datos construidos maliciosamente. Si necesitas analizar datos que no son de confianza o no autenticados, consulta @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche

Las aplicaciones DOM suelen comenzar analizando algún XML en un DOM. Con @ref{122,,xml.dom.minidom}, esto se hace a través de las funciones de análisis sintáctico:

@example
from xml.dom.minidom import parse, parseString

dom1 = parse('c:\\temp\\mydata.xml')  # parse an XML file by name

datasource = open('c:\\temp\\mydata.xml')
dom2 = parse(datasource)  # parse an open file

dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>')
@end example

La función @ref{377d,,parse()} puede tomar un nombre de archivo o un objeto de archivo previamente abierto.

@geindex parse() (en el módulo xml.dom.minidom)
@anchor{library/xml dom minidom xml dom minidom parse}@anchor{377d}
@deffn {Función} xml.dom.minidom.parse (filename_or_file, parser=None, bufsize=None)

Retorna un @code{Document} a partir de la entrada dada. `filename_or_file' puede ser un nombre de archivo o un objeto similar a un archivo. `parser', si se proporciona, debe ser un objeto de un analizador sintáctico SAX2. Esta función intercambiará el controlador de documentos del analizador sintáctico y activará el soporte con el espacio de nombres. Otras configuraciones del analizador sintáctico (como configurar un solucionador de entidades) deben haberse realizado de antemano.
@end deffn

Si tienes XML en una cadena de caracteres, puedes usar la función @ref{377e,,parseString()} en su lugar:

@geindex parseString() (en el módulo xml.dom.minidom)
@anchor{library/xml dom minidom xml dom minidom parseString}@anchor{377e}
@deffn {Función} xml.dom.minidom.parseString (string, parser=None)

Retorna un objeto @code{Document} que representa a `string'. Este método crea un objeto @ref{fa9,,io.StringIO} para la cadena de caracteres y lo pasa a @ref{377d,,parse()}.
@end deffn

Ambas funciones retornan un objeto @code{Document} que representa el contenido del documento.

Lo que hacen las funciones @ref{377d,,parse()} y @ref{377e,,parseString()} es conectar un analizador sintáctico de XML con un «constructor DOM» que puede aceptar eventos de análisis de cualquier analizador sintáctico SAX y convertirlos en un árbol DOM. El nombre de las funciones es quizás engañoso, pero es fácil de entender cuando se comprenden las interfaces. El análisis sintáctico del documento se completará antes de que retornen estas funciones, dichas funciones simplemente no proporcionan una implementación del analizador sintáctico por si mismas.

También puedes crear un objeto @code{Document} invocando a un método en un objeto de la «Implementación del DOM». Puedes obtener este objeto llamando a la función @code{getDOMImplementation()} del paquete @ref{121,,xml.dom} o del módulo @ref{122,,xml.dom.minidom}. Una vez que tengas un objeto @code{Document}, puedes agregarle nodos secundarios para llenar el DOM:

@example
from xml.dom.minidom import getDOMImplementation

impl = getDOMImplementation()

newdoc = impl.createDocument(None, "some_tag", None)
top_element = newdoc.documentElement
text = newdoc.createTextNode('Some textual content.')
top_element.appendChild(text)
@end example

Una vez que tengas un objeto del documento DOM, puedes acceder a las partes de tu documento XML a través de sus propiedades y métodos. Estas propiedades se definen en la especificación DOM. La propiedad principal del objeto del documento es @code{documentElement}. Te proporciona el elemento principal en el documento XML: el que contiene a todos los demás. Aquí hay un programa de ejemplo:

@example
dom3 = parseString("<myxml>Some data</myxml>")
assert dom3.documentElement.tagName == "myxml"
@end example

Cuando hayas terminado con un árbol DOM, puedes invocar opcionalmente el método @code{unlink()} para forzar la limpieza temprana de los objetos ahora innecesarios. @code{unlink()} es una extensión de la API del DOM específica del módulo @ref{122,,xml.dom.minidom}, que hace que el nodo y sus descendientes sean esencialmente inútiles. En caso de no hacer uso de esto, eventualmente el recolector de basura de Python se hará cargo de los objetos en el árbol.


@subsubheading Ver también



@table @asis

@item Document Object Model (DOM) Level 1 Specification@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

La recomendación del W3C para el DOM soportada por el módulo @ref{122,,xml.dom.minidom}.
@end table


@menu
* Objetos del DOM:: 
* Ejemplo de DOM:: 
* minidom y el estándar DOM:: 

@end menu

@node Objetos del DOM,Ejemplo de DOM,,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom dom-objects}@anchor{377f}@anchor{library/xml dom minidom minidom-objects}@anchor{3780}
@subsubsection Objetos del DOM


La definición de la API del DOM para Python se proporciona como parte de la documentación del módulo @ref{121,,xml.dom}. Esta sección simplemente enumera las diferencias entre esta API y el módulo @ref{122,,xml.dom.minidom}.

@geindex unlink() (método de xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node unlink}@anchor{3781}
@deffn {Método} Node.unlink ()

Rompe las referencias internas dentro del DOM para recolectarlo como basura en las versiones de Python sin recolector de basura cíclico. Incluso cuando se dispone del mismo, su uso puede hacer que grandes cantidades de memoria estén disponibles antes, por lo que es una buena práctica invocar este método en objetos DOM, tan pronto como ya no se necesiten. Solo necesita ser invocado en el objeto @code{Document}, pero se puede llamar en los nodos hijos para descartar los hijos de ese nodo concreto.

Puedes evitar invocar este método explícitamente utilizando la declaración @ref{673,,with}. El siguiente código desvinculará automáticamente `dom' cuando se salga del bloque @code{with}:

@example
with xml.dom.minidom.parse(datasource) as dom:
    ... # Work with dom.
@end example
@end deffn

@geindex writexml() (método de xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node writexml}@anchor{3782}
@deffn {Método} Node.writexml (writer, indent='@w{'}, addindent='@w{'}, newl='@w{'}, encoding=None, standalone=None)

Escribe XML en el objeto escritor. El escritor recibe texto pero no bytes como entrada, debe tener un método @code{write()} que coincida con el de la interfaz del objeto de archivo. El parámetro `indent' es la sangría del nodo actual. El parámetro `addindent' es la sangría incremental que se utilizará para los subnodos del nodo actual. El parámetro `newl' especifica la cadena que se utilizará como terminación de las nuevas líneas.

Para el nodo @code{Document}, se puede usar el argumento por palabra clave adicional `encoding' para especificar el valor del campo de codificación del encabezado XML.

De manera similar, al indicar explícitamente el argumento `standalone', las declaraciones del documento independiente se agregan al prólogo del documento XML. Si el valor se establece en @code{True}, se agrega @code{standalone="yes"}; de lo contrario, se establece en @code{"no"}. No declarar el argumento omitirá la declaración del documento.


Distinto en la versión 3.8: El método @ref{3782,,writexml()} ahora conserva el orden de los atributos especificado por el usuario.



Distinto en la versión 3.9: Se agregó el parámetro `standalone'.

@end deffn

@geindex toxml() (método de xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node toxml}@anchor{1507}
@deffn {Método} Node.toxml (encoding=None, standalone=None)

Retorna una cadena de caracteres o una cadena de bytes que contiene el XML representado por el nodo DOM.

Si se proporciona de forma explícita un valor para el argumento `encoding' @footnote{
El nombre de codificación incluido en la salida XML debe cumplir con los estándares apropiados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no es válido en la declaración de un documento XML, aunque Python lo acepta como nombre de codificación. Para más detalles, consulta @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
}, el resultado es una cadena de bytes con la codificación especificada. Si no se proporciona el argumento `encoding', el resultado es una cadena Unicode y la declaración XML en la cadena resultante no especifica una codificación. Codificar esta cadena en una codificación que no sea UTF-8 probablemente sea una práctica incorrecta, ya que UTF-8 es la codificación predeterminada para XML.

El argumento `standalone' se comporta exactamente como en @ref{3782,,writexml()}.


Distinto en la versión 3.8: El método @ref{1507,,toxml()} ahora conserva el orden de los atributos especificado por el usuario.



Distinto en la versión 3.9: Se agregó el parámetro `standalone'.

@end deffn

@geindex toprettyxml() (método de xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node toprettyxml}@anchor{1508}
@deffn {Método} Node.toprettyxml (indent='\t', newl='\n', encoding=None, standalone=None)

Retorna una versión impresa elegante del documento. `indent' especifica la cadena de caracteres a usar como sangría y es una tabulación por defecto; `newl' especifica la cadena de caracteres emitida al final de cada línea y es @code{\n} por defecto.

El argumento `encoding' se comporta como el argumento correspondiente del método @ref{1507,,toxml()}.

El argumento `standalone' se comporta exactamente como en @ref{3782,,writexml()}.


Distinto en la versión 3.8: El método @ref{1508,,toprettyxml()} ahora conserva el orden de los atributos especificado por el usuario.



Distinto en la versión 3.9: Se agregó el parámetro `standalone'.

@end deffn

@node Ejemplo de DOM,minidom y el estándar DOM,Objetos del DOM,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom dom-example}@anchor{3783}@anchor{library/xml dom minidom id2}@anchor{3784}
@subsubsection Ejemplo de DOM


Este programa de ejemplo es una demostración bastante realista de un programa simple. En este caso particular, no aprovechamos mucho la flexibilidad del DOM.

@example
import xml.dom.minidom

document = """\
<slideshow>
<title>Demo slideshow</title>
<slide><title>Slide title</title>
<point>This is a demo</point>
<point>Of a program for processing slides</point>
</slide>

<slide><title>Another demo slide</title>
<point>It is important</point>
<point>To have more than</point>
<point>one slide</point>
</slide>
</slideshow>
"""

dom = xml.dom.minidom.parseString(document)

def getText(nodelist):
    rc = []
    for node in nodelist:
        if node.nodeType == node.TEXT_NODE:
            rc.append(node.data)
    return '@w{'}.join(rc)

def handleSlideshow(slideshow):
    print("<html>")
    handleSlideshowTitle(slideshow.getElementsByTagName("title")[0])
    slides = slideshow.getElementsByTagName("slide")
    handleToc(slides)
    handleSlides(slides)
    print("</html>")

def handleSlides(slides):
    for slide in slides:
        handleSlide(slide)

def handleSlide(slide):
    handleSlideTitle(slide.getElementsByTagName("title")[0])
    handlePoints(slide.getElementsByTagName("point"))

def handleSlideshowTitle(title):
    print(f"<title>@{getText(title.childNodes)@}</title>")

def handleSlideTitle(title):
    print(f"<h2>@{getText(title.childNodes)@}</h2>")

def handlePoints(points):
    print("<ul>")
    for point in points:
        handlePoint(point)
    print("</ul>")

def handlePoint(point):
    print(f"<li>@{getText(point.childNodes)@}</li>")

def handleToc(slides):
    for slide in slides:
        title = slide.getElementsByTagName("title")[0]
        print(f"<p>@{getText(title.childNodes)@}</p>")

handleSlideshow(dom)
@end example

@node minidom y el estándar DOM,,Ejemplo de DOM,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom minidom-and-dom}@anchor{3785}@anchor{library/xml dom minidom minidom-and-the-dom-standard}@anchor{3786}
@subsubsection minidom y el estándar DOM


El módulo @ref{122,,xml.dom.minidom} es esencialmente un DOM compatible con DOM 1.0, con algunas características de DOM 2 (principalmente características del espacio de nombres).

El uso de la interfaz DOM en Python es sencillo. Se aplican las siguientes reglas de mapeo:


@itemize *

@item 
Se accede a las interfaces a través de objetos de instancia. Las aplicaciones no deben instanciar las clases en sí mismas; deben usar las funciones de creación disponibles en el objeto @code{Document}. Las interfaces derivadas admiten todas las operaciones (y atributos) de las interfaces base, además de cualquier operación nueva.

@item 
Las operaciones se utilizan como métodos. Dado que el DOM usa solo parámetros @ref{1ed,,in}, los argumentos se pasan en el orden normal (de izquierda a derecha). No hay argumentos opcionales. Las operaciones @code{void} retornan @code{None}.

@item 
Los atributos IDL se asignan a atributos de instancia. Por compatibilidad con el mapeo del lenguaje OMG IDL para Python, también se puede acceder a un atributo @code{foo} a través de los métodos de acceso @code{_get_foo()} y @code{_set_foo()}. Los atributos @code{readonly} no deben modificarse; esto no se aplica en tiempo de ejecución.

@item 
Los tipos @code{short int}, @code{unsigned int}, @code{unsigned long long} y @code{boolean} se asignan todos a objetos enteros de Python.

@item 
El tipo @code{DOMString} se asigna a cadenas de caracteres de Python. El módulo @ref{122,,xml.dom.minidom} admite bytes o cadenas de caracteres, pero normalmente producirá cadenas de caracteres. Los valores de tipo @code{DOMString} también pueden ser @code{None} cuando la especificación DOM del W3C permite tener el valor IDL @code{null}.

@item 
Las declaraciones @code{const} se asignan a variables en su ámbito respectivo (por ejemplo, @code{xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE}); no deben modificarse.

@item 
@code{DOMException} no está actualmente soportado por el módulo @ref{122,,xml.dom.minidom}. En su lugar, @ref{122,,xml.dom.minidom} usa excepciones estándar de Python como @ref{228,,TypeError} y @ref{441,,AttributeError}.

@item 
Los objetos de la clase @code{NodeList} se implementan usando el tipo lista incorporado de Python. Estos objetos proporcionan la interfaz definida en la especificación DOM, pero en versiones anteriores de Python no son compatibles con la API oficial. Sin embargo, son mucho más «pythónicas» que la interfaz definida en las recomendaciones del W3C.
@end itemize

Las siguientes interfaces no están implementadas en el módulo @ref{122,,xml.dom.minidom}:


@itemize *

@item 
@code{DOMTimeStamp}

@item 
@code{EntityReference}
@end itemize

La mayoría de ellas reflejan información en el documento XML que generalmente no es de utilidad para la mayoría de los usuarios de DOM.

@subsubheading Notas al pie


@node xml dom pulldom — Support for building partial DOM trees,xml sax — Support for SAX2 parsers,xml dom minidom — Minimal DOM implementation,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml dom pulldom doc}@anchor{3787}@anchor{library/xml dom pulldom module-xml dom pulldom}@anchor{123}@anchor{library/xml dom pulldom xml-dom-pulldom-support-for-building-partial-dom-trees}@anchor{3788}
@subsection @code{xml.dom.pulldom} — Support for building partial DOM trees


@geindex module; xml.dom.pulldom

`Source code:' Lib/xml/dom/pulldom.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/dom/pulldom.py}


__________________________________________________________________


El módulo @ref{123,,xml.dom.pulldom} proporciona un «pull parser» al que también se le puede pedir que produzca DOM-fragmentos del documento accesibles cuando sea necesario. El concepto básico implica extraer «eventos» desde una secuencia (`stream') de entrada XML y procesarlos. A diferencia de SAX, que también emplea un modelo de procesamiento orientado a eventos junto con callbacks (retrollamada), el usuario de un analizador de extracción (`pull parser') es responsable de extraer explícitamente eventos de la secuencia, recorriendo esos eventos hasta que finalice el procesamiento o se produzca una condición de error.

@cartouche
@quotation Advertencia 
El módulo @ref{123,,xml.dom.pulldom} no es seguro contra datos maliciosamente construidos . Si necesita analizar datos que no son confiables o no autenticados, consulte @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche


Distinto en la versión 3.7.1: El analizador SAX ya no procesa entidades externas generales de forma predeterminada para aumentar la seguridad de forma predeterminada. Para habilitar el procesamiento de entidades externas, pase una instancia de analizador personalizada (`custom parser instance in::')

@example
from xml.dom.pulldom import parse
from xml.sax import make_parser
from xml.sax.handler import feature_external_ges

parser = make_parser()
parser.setFeature(feature_external_ges, True)
parse(filename, parser=parser)
@end example


Ejemplo:

@example
from xml.dom import pulldom

doc = pulldom.parse('sales_items.xml')
for event, node in doc:
    if event == pulldom.START_ELEMENT and node.tagName == 'item':
        if int(node.getAttribute('price')) > 50:
            doc.expandNode(node)
            print(node.toxml())
@end example

@code{event} es una constante y puede ser uno de:


@itemize *

@item 
@code{START_ELEMENT} (Iniciar elemento)

@item 
@code{END_ELEMENT} (Finalizar elemento)

@item 
@code{COMMENT} (comentario)

@item 
@code{START_DOCUMENT} (Iniciar documento)

@item 
@code{END_DOCUMENT} (finalizar documento)

@item 
@code{CHARACTERS} (caracteres)

@item 
@code{PROCESSING_INSTRUCTION} (instrucción de procesamiento)

@item 
@code{IGNORABLE_WHITESPACE} (Espacio en blanco que puede ignorarse)
@end itemize

@code{node} es un objeto del tipo @code{xml.dom.minidom.Document}, @code{xml.dom.minidom.Element} ó @code{xml.dom.minidom.Text}.

Puesto que el documento se trata como una secuencia «flat» (plana) de eventos, el documento «tree» (árbol) se atraviesa implícitamente y los elementos deseados se encuentran independientemente de su profundidad en el árbol. En otras palabras, no es necesario tener en cuenta cuestiones jerárquicas como la búsqueda recursiva de los nodos de documento, aunque si el contexto de los elementos fuera importante, es necesario mantener algún estado relacionado con el contexto (es decir, recordar dónde se encuentra en el documento en un momento dado) o hacer uso del método @ref{3789,,DOMEventStream.expandNode()} y cambiar al procesamiento relacionado con DOM.

@geindex PullDom (clase en xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom PullDom}@anchor{378a}
@deffn {Clase} xml.dom.pulldom.PullDom (documentFactory=None)

Subclase de @ref{378b,,xml.sax.handler.ContentHandler}.
@end deffn

@geindex SAX2DOM (clase en xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom SAX2DOM}@anchor{378c}
@deffn {Clase} xml.dom.pulldom.SAX2DOM (documentFactory=None)

Subclase de @ref{378b,,xml.sax.handler.ContentHandler}.
@end deffn

@geindex parse() (en el módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom parse}@anchor{378d}
@deffn {Función} xml.dom.pulldom.parse (stream_or_string, parser=None, bufsize=None)

Retorna un @ref{7d1,,DOMEventStream} de la entrada dada. `stream_or_string' (secuencia o cadena) puede ser un nombre de archivo o un objeto similar a un archivo, `parser', si se indica, debe ser un objeto @ref{378e,,XMLReader}. Esta función cambiará el controlador de documentos del analizador y activará el soporte de espacios de nombres; otra configuración del analizador (como establecer un solucionador de entidades) debe haberse realizado de antemano.
@end deffn

Si tiene XML en una cadena, puede usar en su lugar la función @ref{378f,,parseString()}:

@geindex parseString() (en el módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom parseString}@anchor{378f}
@deffn {Función} xml.dom.pulldom.parseString (string, parser=None)

Retorna una: clase @ref{7d1,,DOMEventStream} que representa la cadena (Unicode) `strnig' (cadena)
@end deffn

@geindex default_bufsize (en el módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom default_bufsize}@anchor{3790}
@deffn {Dato} xml.dom.pulldom.default_bufsize

Valor predeterminado para el parámetro `bufsize' para @ref{378d,,parse()}.

El valor de las variables puede ser cambiado antes de llamar a @ref{378d,,parse()} y el nuevo valor tendrá efecto.
@end deffn

@menu
* Objetos DOMEventStream:: 

@end menu

@node Objetos DOMEventStream,,,xml dom pulldom — Support for building partial DOM trees
@anchor{library/xml dom pulldom domeventstream-objects}@anchor{3791}@anchor{library/xml dom pulldom id1}@anchor{3792}
@subsubsection Objetos DOMEventStream


@geindex DOMEventStream (clase en xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream}@anchor{7d1}
@deffn {Clase} xml.dom.pulldom.DOMEventStream (stream, parser, bufsize)


Distinto en la versión 3.11: Support for @ref{3d8,,__getitem__()} method has been removed.


@geindex getEvent() (método de xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream getEvent}@anchor{3793}
@deffn {Método} getEvent ()

Retorna el contenido de la tupla `event' y del `node' corriente como @code{xml.dom.minidom.Document} si el evento es igual a @code{START_DOCUMENT}, @code{xml.dom.minidom.Element} si el evento es igual a @code{START_ELEMENT} o @code{END_ELEMENT} o @code{xml.dom.minidom.Text} si el evento es igual a @code{CHARACTERS}. El nodo actual no es contiene información sobre sus hijos a menos que se llame a la función @ref{3789,,expandNode()}.
@end deffn

@geindex expandNode() (método de xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream expandNode}@anchor{3789}
@deffn {Método} expandNode (node)

Expande todos los hijos de `node' en `node' (nodo en nodo). Ejemplo:

@example
from xml.dom import pulldom

xml = '<html><title>Foo</title> <p>Some text <div>and more</div></p> </html>'
doc = pulldom.parseString(xml)
for event, node in doc:
    if event == pulldom.START_ELEMENT and node.tagName == 'p':
        # Following statement only prints '<p/>'
        print(node.toxml())
        doc.expandNode(node)
        # Following statement prints node with all its children '<p>Some text <div>and more</div></p>'
        print(node.toxml())
@end example
@end deffn

@geindex reset() (método de xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream reset}@anchor{3794}
@deffn {Método} reset ()
@end deffn
@end deffn

@node xml sax — Support for SAX2 parsers,xml sax handler — Base classes for SAX handlers,xml dom pulldom — Support for building partial DOM trees,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml sax doc}@anchor{3795}@anchor{library/xml sax module-xml sax}@anchor{129}@anchor{library/xml sax xml-sax-support-for-sax2-parsers}@anchor{3796}
@subsection @code{xml.sax} — Support for SAX2 parsers


@geindex module; xml.sax

`Código fuente:' Lib/xml/sax/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/sax/__init__.py}


__________________________________________________________________


El paquete @ref{129,,xml.sax} provee un número de módulos que implementan la API Simple para la interfaz XML (SAX) para Python.  El paquete mismo provee las excepciones SAX y las funciones de conveniencia que serán las más usadas por los usuarios de la API SAX.

@cartouche
@quotation Advertencia 
El módulo @code{XML.sax} no es seguro contra datos construidos maliciosamente.  Si necesita analizar datos no autenticados o no confiables, mirar @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche


Distinto en la versión 3.7.1: El analizador SAX ya no procesa entidades generales externas por defecto para incrementar seguridad. Antes, el analizador creaba conexiones de red para buscar archivos remotos o archivos locales cargados del sistema de archivos para DTD y entidades. La característica puede ser activadas de nuevo con el método @ref{3797,,setFeature()} en el objeto analizador y el argumento @ref{3798,,feature_external_ges}.


Las funciones de conveniencia son:

@geindex make_parser() (en el módulo xml.sax)
@anchor{library/xml sax xml sax make_parser}@anchor{1a42}
@deffn {Función} xml.sax.make_parser (parser_list=[])

Crea y retorna un objeto SAX @ref{378e,,XMLReader}.  El primer analizador encontrado será el que se use.  Si se provee `parser_list', debe ser un iterable de cadenas de caracteres el cual nombra módulos que tienen una función llamada @code{créate_parser()}.  Los módulos listados en `parser_list' serán usados antes de los módulos en la lista de analizadores por defecto.


Distinto en la versión 3.8: El argumento `parser_list' puede ser cualquier iterable, no sólo una lista.

@end deffn

@geindex parse() (en el módulo xml.sax)
@anchor{library/xml sax xml sax parse}@anchor{1a0c}
@deffn {Función} xml.sax.parse (filename_or_stream, handler, error_handler=handler.ErrorHandler())

Crea un analizador SAD y úsalo para analizar un documento.  El documento, aprobado como `filename_or_steam', puede ser un nombre de archivo o un objeto de archivo.  El parámetro `handler' necesita ser una instancia SAX @ref{378b,,ContentHandler}.  Si se da `error_handler', debe ser una instancia @ref{3799,,ErrorHandler} SAX; si es omitido, se lanzará @ref{379a,,SAXParseException} en todos los errores. No hay valor retornado; toda tarea debe ser realizada por el `handler' aprobado.
@end deffn

@geindex parseString() (en el módulo xml.sax)
@anchor{library/xml sax xml sax parseString}@anchor{f1d}
@deffn {Función} xml.sax.parseString (string, handler, error_handler=handler.ErrorHandler())

Similar a @code{parser()}, pero analiza desde un búfer `string' recibido como un parámetro.  `string' debe ser una instancia @ref{237,,str} o un @ref{db4,,bytes-like object}.


Distinto en la versión 3.5: Agregado soporte de instancias @ref{237,,str}.

@end deffn

Una aplicación SAX típica usa tres tipos de objetos: lectores, gestores y fuentes de entrada.  «Lector» en este contexto es otro término para analizador, por ejemplo, alguna pieza de código que lee los bytes o caracteres de la fuente de entrada, y produce una secuencia de eventos. Los eventos luego se distribuyen a los objetos gestores, por ejemplo el lector invoca un método en el gestor.  Una aplicación SAX debe por tanto obtener un objeto lector, crear o abrir una fuente de entrada, crear los gestores, y conectar esos objetos juntos.  Como paso final de preparación, el lector es llamado para analizar la entrada. Durante el análisis, los métodos en los objetos gestores son llamados basados en eventos estructurales y sintácticos de los datos introducidos.

Para estos objetos, sólo las interfaces son relevantes; éstos normalmente no son instanciados por la aplicación misma.  Ya que Python no tiene una noción explícita de interfaz, éstas son introducidas formalmente como clases, pero las aplicaciones suelen usar implementaciones que no heredan de las clases provistas.  Las interfaces @ref{f1c,,InputSource}, @ref{379b,,Locator}, @code{Attributes}, @code{AttributesNS}, y @ref{378e,,XMLReader} son definidas en el módulo @ref{12c,,xml.sax.xmlreader}.  Las interfaces de gestión son definidas en @ref{12a,,xml.sax.handler}.  Por conveniencia, @ref{f1c,,InputSource} (el cual suele ser instanciado directamente) y el gestor de clases están también disponibles desde @ref{129,,xml.sax}  Estas interfaces son descritas a continuación.

En adición a esas clases, @ref{129,,xml.sax} provee las siguientes clases de excepción.

@geindex SAXException
@anchor{library/xml sax xml sax SAXException}@anchor{379c}
@deffn {Excepción} xml.sax.SAXException (msg, exception=None)

Encapsula un error XML o advertencia.  Esta clase puede contener errores básicos o información de advertencias ya sea para el analizador XML o la aplicación: esto puede ser heredado para proveer funcionalidad adicionar o para agregar localización.  Nota que a pesar de los analizadores definidos en la interfaz @ref{3799,,ErrorHandler} recibe instancias de esta excepción, no es requerido para lanzar la excepción — esto es algo útil como un contenedor para información.

Cuando es instanciado, `msg' debería ser una descripción del error legible para humanos. El parámetro opcional `exception', si es dado, debería ser @code{None} o una excepción que fue atrapada por el código analizador y se transmite como información.

Esta es la clase base para las otras clases excepción SAX.
@end deffn

@geindex SAXParseException
@anchor{library/xml sax xml sax SAXParseException}@anchor{379a}
@deffn {Excepción} xml.sax.SAXParseException (msg, exception, locator)

Subclase de @ref{379c,,SAXException} levantada en errores de análisis. Las instancias de esta clase son pasadas a los métodos de las interfaces SAX @ref{3799,,ErrorHandler} para proveer información sobre el error de análisis.  Esta clase soporta la interfaz SAX @ref{379b,,Locator} así como la interfaz @ref{379c,,SAXException}.
@end deffn

@geindex SAXNotRecognizedException
@anchor{library/xml sax xml sax SAXNotRecognizedException}@anchor{379d}
@deffn {Excepción} xml.sax.SAXNotRecognizedException (msg, exception=None)

Subclase de @ref{379c,,SAXException} lanzada cuando una SAX @ref{378e,,XMLReader} es confrontada con una propiedad o característica no reconocida.  Las aplicaciones SAX y extensiones pueden usar esta clase para propósitos similares.
@end deffn

@geindex SAXNotSupportedException
@anchor{library/xml sax xml sax SAXNotSupportedException}@anchor{379e}
@deffn {Excepción} xml.sax.SAXNotSupportedException (msg, exception=None)

Las subclases de @ref{379c,,SAXException} se lanzan cuando un SAX @ref{129,,sax} se pregunta para habilitar una característica que no tiene soporte, o para establecer una propiedad a un valor que la implementación no da soporte.  Las aplicaciones sAX y las extensiones pueden usar esta clase para propósitos similares.
@end deffn


@subsubheading Ver también



@table @asis

@item SAX: The Simple API for XML@footnote{http://www.saxproject.org/}

Este sitio es el punto focal para la definición de la API SAX.  Provee una implementación Java y documentación en línea.  Los enlaces para implementaciones e información histórica también están disponibles.

@item Módulo @ref{12a,,xml.sax.handler}

Definiciones de las interfaces para objetos proporcionados por aplicaciones.

@item Módulo @ref{12b,,xml.sax.saxutils}

Funciones de conveniencia para usar en aplicaciones SAX.

@item Módulo @ref{12c,,xml.sax.xmlreader}

Definiciones de las interfaces para objetos que proveen analizadores.
@end table


@menu
* Objetos SAXException:: 

@end menu

@node Objetos SAXException,,,xml sax — Support for SAX2 parsers
@anchor{library/xml sax sax-exception-objects}@anchor{379f}@anchor{library/xml sax saxexception-objects}@anchor{37a0}
@subsubsection Objetos SAXException


La clase de excepción @ref{379c,,SAXException} da soporte a los siguientes métodos:

@geindex getMessage() (método de xml.sax.SAXException)
@anchor{library/xml sax xml sax SAXException getMessage}@anchor{37a1}
@deffn {Método} SAXException.getMessage ()

Retorna un mensaje legible para humanos describiendo la condición de error.
@end deffn

@geindex getException() (método de xml.sax.SAXException)
@anchor{library/xml sax xml sax SAXException getException}@anchor{37a2}
@deffn {Método} SAXException.getException ()

Retorna un objeto excepción encapsulado, o @code{None}.
@end deffn

@node xml sax handler — Base classes for SAX handlers,xml sax saxutils — SAX Utilities,xml sax — Support for SAX2 parsers,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml sax handler doc}@anchor{37a3}@anchor{library/xml sax handler module-xml sax handler}@anchor{12a}@anchor{library/xml sax handler xml-sax-handler-base-classes-for-sax-handlers}@anchor{37a4}
@subsection @code{xml.sax.handler} — Base classes for SAX handlers


@geindex module; xml.sax.handler

`Source code' Lib/xml/sax/handler.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/sax/handler.py}


__________________________________________________________________


La API de SAX define cuatro tipos de manejadores: manejadores de contenido, manejadores de DTD, manejadores de errores y resolvedores de entidades. Normalmente, las aplicaciones solo necesitan implementar las interfaces cuyos eventos les interesan; pueden implementar las interfaces en un solo objeto o en múltiples objetos. Las implementaciones de los manejadores deben heredar de las clases base provistas en el módulo @ref{12a,,xml.sax.handler}, de modo que todos los métodos obtengan implementaciones por defecto.

@geindex ContentHandler (clase en xml.sax.handler)
@anchor{library/xml sax handler xml sax handler ContentHandler}@anchor{378b}
@deffn {Clase} xml.sax.handler.ContentHandler

Esta es la principal interfaz de devolución de llamada en el SAX, y la más importante para las aplicaciones. El orden de los eventos en esta interfaz refleja el orden de la información en el documento.
@end deffn

@geindex DTDHandler (clase en xml.sax.handler)
@anchor{library/xml sax handler xml sax handler DTDHandler}@anchor{37a5}
@deffn {Clase} xml.sax.handler.DTDHandler

Manejar eventos de DTD.

Esta interfaz especifica solo los eventos DTD necesarios para el análisis básico (entidades y atributos no analizados).
@end deffn

@geindex EntityResolver (clase en xml.sax.handler)
@anchor{library/xml sax handler xml sax handler EntityResolver}@anchor{37a6}
@deffn {Clase} xml.sax.handler.EntityResolver

Interfaz básica para resolver entidades. Si creas un objeto implementando esta interfaz, y luego registras el objeto con tu Parser, el parser (analizador) invocara al método en tu objeto para resolver todas las entidades externas.
@end deffn

@geindex ErrorHandler (clase en xml.sax.handler)
@anchor{library/xml sax handler xml sax handler ErrorHandler}@anchor{3799}
@deffn {Clase} xml.sax.handler.ErrorHandler

Interfaz utilizada por el parser para presentar mensajes de error y advertencia a la aplicación.  Los métodos de este objeto controlan si los errores se convierten inmediatamente en excepciones o se manejan de alguna otra manera.
@end deffn

@geindex LexicalHandler (clase en xml.sax.handler)
@anchor{library/xml sax handler xml sax handler LexicalHandler}@anchor{8f3}
@deffn {Clase} xml.sax.handler.LexicalHandler

Interface usada por el parser para representar eventos de baja frecuencia que pueden no ser de interés para muchas aplicaciones.
@end deffn

Además de estas clases, @ref{12a,,xml.sax.handler} proporciona constantes simbólicas para los nombres de las características y propiedades.

@geindex feature_namespaces (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_namespaces}@anchor{37a7}
@deffn {Dato} xml.sax.handler.feature_namespaces


@display
value: @code{"http://xml.org/sax/features/namespaces"}@w{ }
true: Realizar el procesamiento del Namespace (espacio de nombres).@w{ }
false: Opcionalmente no realizar el procesamiento del Namespace (espacio de nombres) (implica prefijos de espacio de nombres; por defecto).@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex feature_namespace_prefixes (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_namespace_prefixes}@anchor{37a8}
@deffn {Dato} xml.sax.handler.feature_namespace_prefixes


@display
value: @code{"http://xml.org/sax/features/namespace-prefixes"}@w{ }
true: Reporte de los nombres prefijados originales y los atributos utilizados para las declaraciones del Namespace (espacio de nombres).@w{ }
false: No informar de los atributos utilizados para las declaraciones del Namespace (espacio de nombres), y opcionalmente no informar de los nombres prefijados originales (por defecto).@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex feature_string_interning (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_string_interning}@anchor{37a9}
@deffn {Dato} xml.sax.handler.feature_string_interning


@display
value: @code{"http://xml.org/sax/features/string-interning"}@w{ }
true: Todos los nombres de elementos, prefijos, nombres de atributos, URIs del Namespace (espacio de nombres) y nombres locales son internados usando la función interna incorporada.@w{ }
false: Los nombres no están necesariamente internados, aunque pueden estarlo (por defecto).@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex feature_validation (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_validation}@anchor{37aa}
@deffn {Dato} xml.sax.handler.feature_validation


@display
value: @code{"http://xml.org/sax/features/validation"}@w{ }
true: Reportar de todos los errores de validación (implica entidades generales externas y entidades de parámetros externos).@w{ }
false: No informe de los errores de validación.@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex feature_external_ges (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_external_ges}@anchor{3798}
@deffn {Dato} xml.sax.handler.feature_external_ges


@display
value: @code{"http://xml.org/sax/features/external-parameter-entities"}@w{ }
true: Incluye todas las entidades externas generales de texto (text).@w{ }
false: No incluya entidades generales externas.@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex feature_external_pes (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_external_pes}@anchor{37ab}
@deffn {Dato} xml.sax.handler.feature_external_pes


@display
value: @code{"http://xml.org/sax/features/external-parameter-entities"}@w{ }
true: Incluye todas las entidades paramétricas externas, incluyendo el subconjunto DTD externo.@w{ }
false: No incluya ninguna entidad paramétrica externa, ni siquiera el subconjunto DTD externo.@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex all_features (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler all_features}@anchor{37ac}
@deffn {Dato} xml.sax.handler.all_features

Lista de todas las características.
@end deffn

@geindex property_lexical_handler (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_lexical_handler}@anchor{37ad}
@deffn {Dato} xml.sax.handler.property_lexical_handler


@display
value: @code{"http://xml.org/sax/properties/lexical-handler"}@w{ }
data type: xml.sax.sax2lib.LexicalHandler (no soportado en Python 2)@w{ }
descripción: Un  handler (manipulador) de extensión opcional para eventos léxicos como los comentarios.@w{ }
acceso: read/write (leer/escribir)@w{ }
@end display


@end deffn

@geindex property_declaration_handler (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_declaration_handler}@anchor{37ae}
@deffn {Dato} xml.sax.handler.property_declaration_handler


@display
value: @code{"http://xml.org/sax/properties/declaration-handler"}@w{ }
data type: xml.sax.sax2lib.DeclHandler (no soportado en Python 2)@w{ }
description: Un gestor de extensión opcional para eventos relacionados con la DTD que no sean anotaciones y entidades no preparadas.@w{ }
acceso: read/write (leer/escribir)@w{ }
@end display


@end deffn

@geindex property_dom_node (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_dom_node}@anchor{37af}
@deffn {Dato} xml.sax.handler.property_dom_node


@display
value: @code{"http://xml.org/sax/properties/dom-node"}@w{ }
data type: org.w3c.dom.Node (not supported in Python 2)@w{ }
descripción: Cuando se analiza, el nodo DOM actual que se visita si se trata de un iterador DOM; cuando no se analiza, el nodo DOM raíz para la iteración.@w{ }
acceso: (parsing) solo de lectura; (not parsing) lectura/escritura@w{ }
@end display


@end deffn

@geindex property_xml_string (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_xml_string}@anchor{37b0}
@deffn {Dato} xml.sax.handler.property_xml_string


@display
value: @code{"http://xml.org/sax/properties/xml-string"}@w{ }
tipo de datos: Bytes@w{ }
description: La cadena literal de caracteres que fue la fuente del evento actual.@w{ }
acceso: solo-lectura@w{ }
@end display


@end deffn

@geindex all_properties (en el módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler all_properties}@anchor{37b1}
@deffn {Dato} xml.sax.handler.all_properties

Lista de todos los nombres de propiedades conocidas.
@end deffn

@menu
* Objetos ContentHandler:: 
* Objetos DTDHandler:: 
* Objetos EntityResolver:: 
* Objetos ErrorHandler:: 
* Objetos DTDHandler: Objetos DTDHandler<2>. 

@end menu

@node Objetos ContentHandler,Objetos DTDHandler,,xml sax handler — Base classes for SAX handlers
@anchor{library/xml sax handler content-handler-objects}@anchor{37b2}@anchor{library/xml sax handler contenthandler-objects}@anchor{37b3}
@subsubsection Objetos ContentHandler


Se espera que los usuarios subclasifiquen @ref{378b,,ContentHandler} para apoyar su aplicación.  Los siguientes métodos son llamados por el analizador en los eventos apropiados en el documento de entrada:

@geindex setDocumentLocator() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler setDocumentLocator}@anchor{37b4}
@deffn {Método} ContentHandler.setDocumentLocator (locator)

Invocado por el parser (analizador) para dar a la aplicación un localizador para determinar el origen de los eventos del documento.

Se recomienda encarecidamente a los parsers (analizadores) SAX (aunque no es absolutamente necesario) que proporcionen un localizador: si lo hace, debe proporcionar el localizador a la aplicación invocando este método antes de invocar cualquiera de los otros métodos de la interfaz DocumentHandler.

El localizador permite a la aplicación determinar la posición final de cualquier evento relacionado con el documento, incluso si el analizador no informa de un error. Normalmente, la aplicación utilizará esta información para informar de sus propios errores (como el contenido de los caracteres que no coinciden con las reglas de negocio de la aplicación). Es probable que la información retornada por el localizador no sea suficiente para su uso con un motor de búsqueda.

Tenga en cuenta que el localizador retornará la información correcta solo durante la invocación de los eventos en esta interfaz. La aplicación no debe intentar utilizarlo en ningún otro momento.
@end deffn

@geindex startDocument() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startDocument}@anchor{37b5}
@deffn {Método} ContentHandler.startDocument ()

Recibir la notificación del inicio de un documento.

El parser (analizador) SAX invocará este método solo una vez, antes que cualquier otro método en esta interfaz o en DTDHandler (excepto @ref{37b4,,setDocumentLocator()}).
@end deffn

@geindex endDocument() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endDocument}@anchor{37b6}
@deffn {Método} ContentHandler.endDocument ()

Recibir una notificación del final de un documento.

El analizador (parser) SAX invocará este método solo una vez, y será el último método invocado durante el análisis. El analizador no invocará este método hasta que no haya abandonado el análisis sintáctico (debido a un error irrecuperable) o haya llegado al final de la entrada.
@end deffn

@geindex startPrefixMapping() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startPrefixMapping}@anchor{37b7}
@deffn {Método} ContentHandler.startPrefixMapping (prefix, uri)

Comienza el alcance de un mapeo del prefijo-URI Namespace.

La información de este evento no es necesaria para el procesamiento normal del Namespace (espacio de nombres): el lector de XML SAX sustituirá automáticamente los prefijos de los nombres de elementos y atributos cuando se active la función @code{feature_namespaces} default (el valor por defecto).

Sin embargo, hay casos en que las aplicaciones necesitan utilizar prefijos en los datos de los caracteres o en los valores de los atributos, en los que no se pueden expandir automáticamente de forma segura; los eventos @ref{37b7,,startPrefixMapping()} y @ref{37b8,,endPrefixMapping()} suministran la información a la aplicación para expandir los prefijos en esos contextos por sí mismos, si es necesario.

@c XXX This is not really the default, is it? MvL

Note que los eventos @ref{37b7,,startPrefixMapping()} y @ref{37b8,,endPrefixMapping()} no están garantizados de estar apropiadamente anidados en relación a cada uno: todos los eventos @ref{37b7,,startPrefixMapping()} ocurrirán antes del correspondiente evento @ref{1583,,startElement()}, y todos los eventos @ref{37b8,,endPrefixMapping()} ocurrirán después del correspondiente evento @ref{1584,,endElement()}, pero su orden no está garantizado.
@end deffn

@geindex endPrefixMapping() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endPrefixMapping}@anchor{37b8}
@deffn {Método} ContentHandler.endPrefixMapping (prefix)

Terminar con el alcance de un mapeo de prefijos-URI.

Ver @ref{37b7,,startPrefixMapping()} para más detalles. Este evento siempre ocurrirá después del correspondiente evento @ref{1584,,endElement()}, pero el orden de los eventos @ref{37b8,,endPrefixMapping()} no está garantizado.
@end deffn

@geindex startElement() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startElement}@anchor{1583}
@deffn {Método} ContentHandler.startElement (name, attrs)

Señala el inicio de un elemento en modo no espacial.

El parámetro `name' contiene el nombre XML 1.0 en bruto del tipo de elemento como una cadena y el parámetro `attrs' contiene un objeto de la interfaz @code{Attributes} (véase @ref{37b9,,La Interfaz Attributes}) que contiene los atributos del elemento.  El objeto pasado como `attrs' puede ser reutilizado por el parser (analizador); mantener una referencia a él no es una forma fiable de conservar una copia de los atributos. Para guardar una copia de los atributos, usa el método @ref{26,,copy()} del objeto `attrs'.
@end deffn

@geindex endElement() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endElement}@anchor{1584}
@deffn {Método} ContentHandler.endElement (name)

Señala el final de un elemento en modo no espacial.

El parámetro `name' contiene el nombre del tipo de elemento, al igual que con el evento @ref{1583,,startElement()}.
@end deffn

@geindex startElementNS() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startElementNS}@anchor{37ba}
@deffn {Método} ContentHandler.startElementNS (name, qname, attrs)

Señala el inicio de un elemento en el modo de Namespace (espacio de nombres).

El parámetro `name' contiene el nombre del tipo de elemento como una tupla @code{(uri, localname)}, el parámetro `qname' contiene el nombre XML 1.0 en bruto usado en el documento fuente, y el parámetro `attrs' contiene una instancia de la interfaz @code{AttributesNS} (ver @ref{37bb,,La Interfaz AttributesNS}) que contiene los atributos del elemento.  Si no hay ningún Namespace (espacio de nombres) asociado al elemento, el componente `uri' de `name' será @code{Ninguno}.  El objeto pasado como `attrs' puede ser reutilizado por el analizador; mantener una referencia a él no es una forma fiable de conservar una copia de los atributos.  Para guardar una copia de los atributos, usa el método @code{copy`()} del objeto `attrs'.

Los parsers (analizadores) pueden establecer el parámetro `qname' como @code{None}, a menos que se active la función  @code{feature_namespace_prefixes}.
@end deffn

@geindex endElementNS() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endElementNS}@anchor{37bc}
@deffn {Método} ContentHandler.endElementNS (name, qname)

Señala el final de un elemento en el modo de namespace.

El parámetro `name' contiene el nombre del tipo de elemento, al igual que con el método @ref{37ba,,startElementNS()}, así como el parámetro `qname'.
@end deffn

@geindex characters() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler characters}@anchor{1585}
@deffn {Método} ContentHandler.characters (content)

Recibir la notificación de los datos de los caracteres.

El Parser (analizador) llamará a este método para informar de cada dato de carácter. Los parsers (analizadores) SAX pueden retornar todos los datos de caracteres contiguos en un solo trozo, o pueden dividirlos en varios trozos; sin embargo, todos los caracteres de un mismo evento deben provenir de la misma entidad externa para que el Localizador proporcione información útil.

`content'  puede ser una cadena o una instancia de bytes; el módulo lector de «Expat» siempre produce cadenas.

@cartouche
@quotation Nota 
La anterior interfaz SAX 1 proporcionada por el Grupo de Interés Especial de Python XML utilizaba una interfaz más parecida a Java para este método.  Dado que la mayoría de los parsers (analizadores) utilizados de Python no aprovecharon la interfaz más antigua, se eligió la firma más simple para reemplazarla.  Para convertir el código antiguo en la nueva interfaz, se utilizó `content' en lugar de cortar el contenido con los antiguos parámetros `offset' y `length'.
@end quotation
@end cartouche
@end deffn

@geindex ignorableWhitespace() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler ignorableWhitespace}@anchor{37bd}
@deffn {Método} ContentHandler.ignorableWhitespace (whitespace)

Recibir notificación de espacios en blanco ignorables en el contenido de los elementos.

Los parsers  validadores deben utilizar este método para informar de cada trozo de espacio en blanco desconocido (véase la recomendación W3C XML 1.0, sección 2.10): los analizadores no validadores también pueden utilizar este método si son capaces de analizar y utilizar modelos de contenido.

Los parsers (analizadores) SAX pueden retornar todos los espacios blancos contiguos en un solo trozo, o pueden dividirlo en varios trozos; sin embargo, todos los caracteres de un mismo evento deben provenir de la misma entidad externa, para que el Localizador proporcione información útil.
@end deffn

@geindex processingInstruction() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler processingInstruction}@anchor{37be}
@deffn {Método} ContentHandler.processingInstruction (target, data)

Recibir la notificación de una instrucción de procesamiento.

El Parser (analizador) invocará este método una vez por cada instrucción de procesamiento encontrada: nótese que las instrucciones de procesamiento pueden ocurrir antes o después del elemento principal del documento.

Un parser (analizador) SAX nunca debe informar de una declaración XML (XML 1.0, sección 2.8) o una declaración de texto (XML 1.0, sección 4.3.1) utilizando este método.
@end deffn

@geindex skippedEntity() (método de xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler skippedEntity}@anchor{37bf}
@deffn {Método} ContentHandler.skippedEntity (name)

Recibir la notificación de una entidad salteada.

El Parser invocará este método una vez por cada entidad omitida. Los procesos no validadores pueden omitir entidades si no han visto las declaraciones (porque, por ejemplo, la entidad fue declarada en un subconjunto DTD externo). Todos los procesos pueden omitir entidades externas, dependiendo de los valores de las propiedades @code{feature_external_ges} y @code{feature_external_pes}.
@end deffn

@node Objetos DTDHandler,Objetos EntityResolver,Objetos ContentHandler,xml sax handler — Base classes for SAX handlers
@anchor{library/xml sax handler dtd-handler-objects}@anchor{37c0}@anchor{library/xml sax handler dtdhandler-objects}@anchor{37c1}
@subsubsection Objetos DTDHandler


@ref{37a5,,DTDHandler} la instancia provee los siguientes métodos:

@geindex notationDecl() (método de xml.sax.handler.DTDHandler)
@anchor{library/xml sax handler xml sax handler DTDHandler notationDecl}@anchor{37c2}
@deffn {Método} DTDHandler.notationDecl (name, publicId, systemId)

Manejar un evento de declaración de anotación.
@end deffn

@geindex unparsedEntityDecl() (método de xml.sax.handler.DTDHandler)
@anchor{library/xml sax handler xml sax handler DTDHandler unparsedEntityDecl}@anchor{37c3}
@deffn {Método} DTDHandler.unparsedEntityDecl (name, publicId, systemId, ndata)

Manejar un evento de declaración de entidad no preparada.
@end deffn

@node Objetos EntityResolver,Objetos ErrorHandler,Objetos DTDHandler,xml sax handler — Base classes for SAX handlers
@anchor{library/xml sax handler entity-resolver-objects}@anchor{37c4}@anchor{library/xml sax handler entityresolver-objects}@anchor{37c5}
@subsubsection Objetos EntityResolver


@geindex resolveEntity() (método de xml.sax.handler.EntityResolver)
@anchor{library/xml sax handler xml sax handler EntityResolver resolveEntity}@anchor{37c6}
@deffn {Método} EntityResolver.resolveEntity (publicId, systemId)

Resolver el identificador de sistema de una entidad y retornar ya sea el identificador de sistema para leerlo como una cadena, o una fuente de entrada para leerlo. La implementación por defecto retorna `systemId'.
@end deffn

@node Objetos ErrorHandler,Objetos DTDHandler<2>,Objetos EntityResolver,xml sax handler — Base classes for SAX handlers
@anchor{library/xml sax handler errorhandler-objects}@anchor{37c7}@anchor{library/xml sax handler sax-error-handler}@anchor{37c8}
@subsubsection Objetos ErrorHandler


Los objetos con esta interfaz se usan para recibir información de error y advertencia del @ref{378e,,XMLReader}.  Si creas un objeto que implemente esta interfaz, y luego registras el objeto con tu @ref{378e,,XMLReader}, el parser (analizador) invocará a los métodos de tu objeto para informar de todas las advertencias y errores. Hay tres niveles de errores disponibles: advertencias, errores (posiblemente) recuperables y errores no recuperables.  Todos los métodos toman un @ref{379a,,SAXParseException} como único parámetro.  Los errores y advertencias pueden ser convertidos en una excepción lanzando el objeto de excepción pasado.

@geindex error() (método de xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler error}@anchor{37c9}
@deffn {Método} ErrorHandler.error (exception)

Invocación cuando el parser (analizador) encuentra un error recuperable.  Si este método no lanza una excepción, el análisis sintáctico puede continuar, pero la aplicación no debe esperar más información del documento.  Permitir que el parser (analizador) continúe puede permitir que se descubran errores adicionales en el documento de entrada.
@end deffn

@geindex fatalError() (método de xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler fatalError}@anchor{37ca}
@deffn {Método} ErrorHandler.fatalError (exception)

Invocación cuando el parser (analizador) encuentra un error del que no puede recuperarse; se espera que el análisis sintáctico termine cuando vuelva este método.
@end deffn

@geindex warning() (método de xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler warning}@anchor{37cb}
@deffn {Método} ErrorHandler.warning (exception)

Invocación cuando el parser (analizador) presenta información de advertencia menor a la aplicación. Se espera que el análisis sintáctico continúe cuando vuelva este método, y la información del documento seguirá pasando a la aplicación. Si se lanza una excepción con este método, el análisis sintáctico terminará.
@end deffn

@node Objetos DTDHandler<2>,,Objetos ErrorHandler,xml sax handler — Base classes for SAX handlers
@anchor{library/xml sax handler lexical-handler-objects}@anchor{37cc}@anchor{library/xml sax handler lexicalhandler-objects}@anchor{37cd}
@subsubsection Objetos DTDHandler


Handler (manipulador) de extensión opcional para eventos léxicos SAX2.

Este handler se usa para obtener información léxica de un documento XML. La información léxica incluye información que describe la codificación del documento usado u los comentarios XML embebidos en el documento, como también una sección para el DTD y para cada sección CDTA. Estos manipuladores léxicos son usado de la misma forma que los manipuladores de contenido (content handlers).

Configurar el LexicalHandlerde un XMLReader usando el método setProperty con la propiedad identificadora @code{'http://xml.org/sax/properties/lexical-handler'}.

@geindex comment() (método de xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler comment}@anchor{37ce}
@deffn {Método} LexicalHandler.comment (content)

Reporta un comentario en cualquier lugar en el documento (incluyendo el DTD y elementos por fuera del documento).
@end deffn

@geindex startDTD() (método de xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler startDTD}@anchor{37cf}
@deffn {Método} LexicalHandler.startDTD (name, public_id, system_id)

Reporta el estado de las declaraciones del DTD en caso de tenga asociado un DTD.
@end deffn

@geindex endDTD() (método de xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler endDTD}@anchor{37d0}
@deffn {Método} LexicalHandler.endDTD ()

Reporta el fin de la declaración del DTD.
@end deffn

@geindex startCDATA() (método de xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler startCDATA}@anchor{37d1}
@deffn {Método} LexicalHandler.startCDATA ()

Reporta el inicio de la sección CDATA marcada.

El contenido de la sección marcada del CDATA se reportará a través de manipulador de caracteres.
@end deffn

@geindex endCDATA() (método de xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler endCDATA}@anchor{37d2}
@deffn {Método} LexicalHandler.endCDATA ()

Reporta el final de la sección marcada del CDATA.
@end deffn

@node xml sax saxutils — SAX Utilities,xml sax xmlreader — Interface for XML parsers,xml sax handler — Base classes for SAX handlers,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml sax utils doc}@anchor{37d3}@anchor{library/xml sax utils module-xml sax saxutils}@anchor{12b}@anchor{library/xml sax utils xml-sax-saxutils-sax-utilities}@anchor{37d4}
@subsection @code{xml.sax.saxutils} — SAX Utilities


@geindex module; xml.sax.saxutils

`Código fuente:' Lib/xml/sax/saxutils.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/sax/saxutils.py}


__________________________________________________________________


El módulo @ref{12b,,xml.sax.saxutils} contiene una serie de clases y funciones que son comúnmente útiles al crear aplicaciones SAX, ya sea como uso directo o como clases base.

@geindex escape() (en el módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils escape}@anchor{37d5}
@deffn {Función} xml.sax.saxutils.escape (data, entities=@{@})

Escapar @code{'&'}, @code{'<'} y @code{'>'} en una cadena de datos.

Puede escapar otras cadenas de datos pasando un diccionario como el parámetro opcional `entities'. Las claves y los valores deben ser cadenas; cada clave será reemplazada por su valor correspondiente. Los caracteres @code{'&'}, @code{'<'} y @code{'>'} siempre se escapan, incluso si se proporciona `entities'.

@cartouche
@quotation Nota 
Esta función debería ser usada únicamente para escapar caracteres que no pueden ser usados directamente en XML. No use esta función como una función general de traducción de cadenas de caracteres.
@end quotation
@end cartouche
@end deffn

@geindex unescape() (en el módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils unescape}@anchor{37d6}
@deffn {Función} xml.sax.saxutils.unescape (data, entities=@{@})

Quitar el escape @code{'&amp;'}, @code{'&lt;'}, y @code{'&gt;'} en una cadena de datos.

Puede quitar el escape de otras cadenas de datos pasando un diccionario como el parámetro opcional `entities'. Las claves y los valores deben ser cadenas; cada clave será reemplazada por su valor correspondiente. A @code{'&amp'}, @code{'&lt;'} y @code{'&gt;'} se les quita siempre el escape, incluso si se proporcionan `entidades'.
@end deffn

@geindex quoteattr() (en el módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils quoteattr}@anchor{37d7}
@deffn {Función} xml.sax.saxutils.quoteattr (data, entities=@{@})

Similar a @ref{37d5,,escape()}, pero también prepara `data' para usarse como un valor de atributo. El valor devuelto es una versión entrecomillada de `data' con los reemplazos adicionales necesarios. @ref{37d7,,quoteattr()} seleccionará un carácter de comillas basado en el contenido de `data', intentando evitar codificar los caracteres de comillas en la cadena. Si los caracteres de comillas simples y dobles ya están en `data', los caracteres de comillas dobles se codificarán y `data' se envolverá entre comillas dobles. La cadena resultante se puede utilizar directamente como un valor de atributo:

@example
>>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
<element attr="ab ' cd &quot; ef">
@end example

Esta función es útil al generar valores de atributo para HTML o cualquier SGML utilizando la sintaxis concreta de referencia.
@end deffn

@geindex XMLGenerator (clase en xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils XMLGenerator}@anchor{37d8}
@deffn {Clase} xml.sax.saxutils.XMLGenerator (out=None, encoding='iso-8859-1', short_empty_elements=False)

Esta clase implementa la interfaz @ref{378b,,ContentHandler} escribiendo eventos SAX en un documento XML. En otras palabras, el uso de un @ref{37d8,,XMLGenerator} como controlador de contenido reproducirá el documento original que se está analizando. `out' debe ser un objeto similar a un archivo que por defecto sea `sys.stdout'. `encoding' es la codificación de la secuencia de salida que tiene como valor predeterminado @code{'iso-8859-1'}. `short_empty_elements' controla el formato de los elementos que no contienen contenido: si @code{False} (valor predeterminado) se emiten como un par de etiquetas de inicio/fin, si se establece en @code{True} se emiten como una sola etiqueta autocerrada.


Distinto en la versión 3.2: Added the `short_empty_elements' parameter.

@end deffn

@geindex XMLFilterBase (clase en xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils XMLFilterBase}@anchor{37d9}
@deffn {Clase} xml.sax.saxutils.XMLFilterBase (base)

Esta clase está diseñada para situarse entre un @ref{378e,,XMLReader} y los manejadores de eventos de la aplicación cliente. Por defecto, no hace más que pasar las peticiones al lector y los eventos a los manejadores sin modificar, pero las subclases pueden sobrescribir métodos específicos para modificar el flujo de eventos o las peticiones de configuración a medida que pasan.
@end deffn

@geindex prepare_input_source() (en el módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils prepare_input_source}@anchor{37da}
@deffn {Función} xml.sax.saxutils.prepare_input_source (source, base='@w{'})

Esta función toma una fuente de entrada y, opcionalmente, una URL base y retorna un objeto @ref{f1c,,InputSource} completamente resuelto y listo para ser leído. La fuente de entrada puede ser proporcionada como una cadena de caracteres, un objeto tipo archivo , o un objeto @ref{f1c,,InputSource}; los analizadores usarán esta función para implementar el argumento polimórfico `source' a su método @ref{37db,,parse()}.
@end deffn

@node xml sax xmlreader — Interface for XML parsers,xml parsers expat — Fast XML parsing using Expat,xml sax saxutils — SAX Utilities,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/xml sax reader doc}@anchor{37dc}@anchor{library/xml sax reader module-xml sax xmlreader}@anchor{12c}@anchor{library/xml sax reader xml-sax-xmlreader-interface-for-xml-parsers}@anchor{37dd}
@subsection @code{xml.sax.xmlreader} — Interface for XML parsers


@geindex module; xml.sax.xmlreader

`Código fuente:' Lib/xml/sax/xmlreader.py@footnote{https://github.com/python/cpython/tree/main/Lib/xml/sax/xmlreader.py}


__________________________________________________________________


Los analizadores SAX implementan la interfaz @ref{378e,,XMLReader}. Están implementados en un módulo Python, que debe proveer una función @code{create_parser()}. Esta función es invocada por @ref{1a42,,xml.sax.make_parser()} sin argumentos para crear un nuevo objeto analizador.

@geindex XMLReader (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader}@anchor{378e}
@deffn {Clase} xml.sax.xmlreader.XMLReader

Clase base que puede ser heredada por analizadores SAX.
@end deffn

@geindex IncrementalParser (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser}@anchor{37de}
@deffn {Clase} xml.sax.xmlreader.IncrementalParser

En algunos casos, es deseable no analizar una fuente de entrada a la vez, si no alimentar partes del documento a medida que estén disponibles. Tenga en cuenta que el lector normalmente no leerá el fichero completo, si no que también lo leerá por partes, aún así @code{parse()} no retornará hasta que el documento por completo es procesado. Por lo tanto, estas interfaces deben utilizarse si el comportamiento de bloqueo @code{parse()} no es deseable.

Cuando se crea una instancia del analizador, está listo para comenzar a aceptar información desde el método de alimentación inmediatamente. Después de que el análisis ha finalizado con una llamada para cerrar, se debe llamar al método de reinicio para que el analizador esté listo para aceptar información nueva, ya sea de la fuente o utilizando el método de análisis.

Tenga en cuenta que estos métodos `no' deben ser llamados durante el análisis, es decir, después de que el análisis ha sido llamado y antes de que regrese.

Por defecto, la clase también implementa el método de análisis de la interfaz XMLReader utilizando los métodos de alimentación, cierre y reinicio de la interfaz IncrementalParser en conveniencia a los escritores de controlador SAX 2.0.
@end deffn

@geindex Locator (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader Locator}@anchor{379b}
@deffn {Clase} xml.sax.xmlreader.Locator

La interfaz para asociar un evento SAX con una ubicación del documento. Un objeto localizador retornará resultados válidos sólo durante llamadas a métodos DocumentHandler; en cualquier otro momento, los resultados son impredecibles. Si la información no está disponible, los métodos pueden retornar @code{None}.
@end deffn

@geindex InputSource (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader InputSource}@anchor{f1c}
@deffn {Clase} xml.sax.xmlreader.InputSource (system_id=None)

La encapsulación de la información necesaria por el @ref{378e,,XMLReader} para leer entidades.

Esta clase puede incluir información sobre el identificador público, identificador del sistema, flujo de bytes (posiblemente con la información de codificación de caracteres) y/o el flujo de caracteres de una entidad.

Las aplicaciones crearán objetos de esta clase para uso en el método @ref{37db,,XMLReader.parse()} y para retornar desde EntityResolver.resolveEntity.

Una @ref{f1c,,InputSource} pertenece a la aplicación, el @ref{378e,,XMLReader} no tiene permitido modificar objetos @ref{f1c,,InputSource} pasados desde la aplicación, a pesar de que puede hacer copias y modificarlas.
@end deffn

@geindex AttributesImpl (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader AttributesImpl}@anchor{37df}
@deffn {Clase} xml.sax.xmlreader.AttributesImpl (attrs)

Esta es una implementación de la interfaz @code{Attributes} (vea la sección @ref{37b9,,La Interfaz Attributes}). Este es un objeto de tipo diccionario que representa los atributos de elemento en una llamada @code{startElement()}. En adición a las operaciones de diccionario más útiles, soporta una serie de otros métodos como se describe en la interfaz. Los lectores deben crear una instancia de los objetos de esta clase; `attrs' debe ser un objeto de tipo diccionario que contenga un mapeo de nombres de atributo a valores de atributo.
@end deffn

@geindex AttributesNSImpl (clase en xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader AttributesNSImpl}@anchor{37e0}
@deffn {Clase} xml.sax.xmlreader.AttributesNSImpl (attrs, qnames)

Variante consciente del espacio de nombres de @ref{37df,,AttributesImpl}, que se pasará a @code{startElementNS()}. Es derivada de @ref{37df,,AttributesImpl}, pero entiende nombres de atributo como dos tuplas de `namespaceURI' y `localname'. En adición, provee una serie de métodos esperando nombres calificados como aparecen en el documento original. Esta clase implementa la interfaz @code{AttributesNS} (vea la sección @ref{37bb,,La Interfaz AttributesNS}).
@end deffn

@menu
* Objetos XMLReader:: 
* Objetos IncrementalParser:: 
* Objetos localizadores:: 
* Objetos InputSource:: 
* La Interfaz Attributes:: 
* La Interfaz AttributesNS:: 

@end menu

@node Objetos XMLReader,Objetos IncrementalParser,,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader id1}@anchor{37e1}@anchor{library/xml sax reader xmlreader-objects}@anchor{37e2}
@subsubsection Objetos XMLReader


La interfaz @ref{378e,,XMLReader} soporta los siguientes métodos:

@geindex parse() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader parse}@anchor{37db}
@deffn {Método} XMLReader.parse (source)

Procesa una fuente de entrada, produciendo eventos SAX. El objeto `source' puede ser un identificador de sistema (una cadena identificando la fuente de entrada – típicamente un nombre de fichero o una URL), un @ref{19b,,pathlib.Path} o un objeto @ref{3f0,,path-like}, o un objeto @ref{f1c,,InputSource}. Cuando @ref{37db,,parse()} retorna, la entrada es procesada completamente, y el objeto analizador puede ser descartado o reiniciado.


Distinto en la versión 3.5: Agregado soporte de flujo de caracteres.



Distinto en la versión 3.8: Agregado soporte de objetos path-like.

@end deffn

@geindex getContentHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getContentHandler}@anchor{37e3}
@deffn {Método} XMLReader.getContentHandler ()

Retorna el @ref{378b,,ContentHandler} actual.
@end deffn

@geindex setContentHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setContentHandler}@anchor{37e4}
@deffn {Método} XMLReader.setContentHandler (handler)

Establece el @ref{378b,,ContentHandler} actual. Si ningún @ref{378b,,ContentHandler} es establecido, los eventos de contenido serán descartados.
@end deffn

@geindex getDTDHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getDTDHandler}@anchor{37e5}
@deffn {Método} XMLReader.getDTDHandler ()

Retorna el @ref{37a5,,DTDHandler} actual.
@end deffn

@geindex setDTDHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setDTDHandler}@anchor{37e6}
@deffn {Método} XMLReader.setDTDHandler (handler)

Establece el @ref{37a5,,DTDHandler} actual. Si ningún @ref{37a5,,DTDHandler} es establecido, los eventos DTD serán descartados.
@end deffn

@geindex getEntityResolver() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getEntityResolver}@anchor{37e7}
@deffn {Método} XMLReader.getEntityResolver ()

Retorna el @ref{37a6,,EntityResolver} actual.
@end deffn

@geindex setEntityResolver() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setEntityResolver}@anchor{37e8}
@deffn {Método} XMLReader.setEntityResolver (handler)

Establece el @ref{37a6,,EntityResolver} actual. Si ningún @ref{37a6,,EntityResolver} es establecido, los intentos de resolver una entidad externa resultarán en la apertura del identificador de sistema para la entidad, y un error si no está disponible.
@end deffn

@geindex getErrorHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getErrorHandler}@anchor{37e9}
@deffn {Método} XMLReader.getErrorHandler ()

Retorna el @ref{3799,,ErrorHandler} actual.
@end deffn

@geindex setErrorHandler() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setErrorHandler}@anchor{37ea}
@deffn {Método} XMLReader.setErrorHandler (handler)

Establece el manejador de errores actual. Si ningún @ref{3799,,ErrorHandler} es establecido, se lanzarán errores como excepciones, y se imprimirán alertas.
@end deffn

@geindex setLocale() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setLocale}@anchor{37eb}
@deffn {Método} XMLReader.setLocale (locale)

Permite a una aplicación establecer la configuración local para errores y alertas.

Analizadores SAX no son requeridos para proveer localización para errores y alertas; si no pueden soportar la configuración local solicitada, de cualquier forma, lanzarán una excepción SAX. Las aplicaciones pueden solicitar un cambio local en medio del análisis.
@end deffn

@geindex getFeature() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getFeature}@anchor{37ec}
@deffn {Método} XMLReader.getFeature (featurename)

Retorna la configuración actual para la característica `featurename'. Si la característica no es reconocida, @code{SAXNotRecognizedException} es lanzada. Los bien conocidos featurenames son listados en el módulo @ref{12a,,xml.sax.handler}.
@end deffn

@geindex setFeature() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setFeature}@anchor{3797}
@deffn {Método} XMLReader.setFeature (featurename, value)

Establece el `featurename' a `value'. Si la característica no es reconocida, @code{SAXNotRecognizedException} es lanzada. Si la característica o su configuración no es soportada por el analizador, `SAXNotSupportedException' es lanzada.
@end deffn

@geindex getProperty() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getProperty}@anchor{37ed}
@deffn {Método} XMLReader.getProperty (propertyname)

Retorna la configuración actual para la propiedad `propertyname'. Si la configuración no es reconocida, una @code{SAXNotRecognizedException} es lanzada. Las bien conocidas propertynames son listadas en el módulo  @ref{12a,,xml.sax.handler}.
@end deffn

@geindex setProperty() (método de xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setProperty}@anchor{37ee}
@deffn {Método} XMLReader.setProperty (propertyname, value)

Establece el `propertyname' a `value'. Si la propiedad no es reconocida, @code{SAXNotRecognizedException} es lanzada. Si la propiedad o su configuración no es soportada por el analizador, `SAXNotSupportedException' es lanzada.
@end deffn

@node Objetos IncrementalParser,Objetos localizadores,Objetos XMLReader,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader incremental-parser-objects}@anchor{37ef}@anchor{library/xml sax reader incrementalparser-objects}@anchor{37f0}
@subsubsection Objetos IncrementalParser


Las instancias de @ref{37de,,IncrementalParser} ofrecen los siguientes métodos adicionales:

@geindex feed() (método de xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser feed}@anchor{37f1}
@deffn {Método} IncrementalParser.feed (data)

Procesa una parte de `data'.
@end deffn

@geindex close() (método de xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser close}@anchor{37f2}
@deffn {Método} IncrementalParser.close ()

Asume el fin del documento. Eso verificará las condiciones bien formadas que pueden ser verificadas sólo al final, invocar manejadores, y puede limpiar los recursos asignados durante el análisis.
@end deffn

@geindex reset() (método de xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser reset}@anchor{37f3}
@deffn {Método} IncrementalParser.reset ()

Este método es llamado después de que el cierre ha sido llamado para restablecer el analizador, de forma que esté listo para analizar nuevos documentos. Los resultados de llamar parse o feed después del cierre sin llamar a reset son indefinidos.
@end deffn

@node Objetos localizadores,Objetos InputSource,Objetos IncrementalParser,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader id2}@anchor{37f4}@anchor{library/xml sax reader locator-objects}@anchor{37f5}
@subsubsection Objetos localizadores


Las instancias de @ref{379b,,Locator} proveen estos métodos:

@geindex getColumnNumber() (método de xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getColumnNumber}@anchor{37f6}
@deffn {Método} Locator.getColumnNumber ()

Retorna el número de columna donde el evento actual comienza.
@end deffn

@geindex getLineNumber() (método de xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getLineNumber}@anchor{37f7}
@deffn {Método} Locator.getLineNumber ()

Retorna el número de línea donde el evento actual comienza.
@end deffn

@geindex getPublicId() (método de xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getPublicId}@anchor{37f8}
@deffn {Método} Locator.getPublicId ()

Retorna el identificador público para el evento actual.
@end deffn

@geindex getSystemId() (método de xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getSystemId}@anchor{37f9}
@deffn {Método} Locator.getSystemId ()

Retorna el identificador de sistema para el evento actual.
@end deffn

@node Objetos InputSource,La Interfaz Attributes,Objetos localizadores,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader input-source-objects}@anchor{37fa}@anchor{library/xml sax reader inputsource-objects}@anchor{37fb}
@subsubsection Objetos InputSource


@geindex setPublicId() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setPublicId}@anchor{37fc}
@deffn {Método} InputSource.setPublicId (id)

Establece el identificador público de esta @ref{f1c,,InputSource}.
@end deffn

@geindex getPublicId() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getPublicId}@anchor{37fd}
@deffn {Método} InputSource.getPublicId ()

Retorna el identificador público para esta @ref{f1c,,InputSource}.
@end deffn

@geindex setSystemId() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setSystemId}@anchor{37fe}
@deffn {Método} InputSource.setSystemId (id)

Establece el identificador de sistema de esta @ref{f1c,,InputSource}.
@end deffn

@geindex getSystemId() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getSystemId}@anchor{37ff}
@deffn {Método} InputSource.getSystemId ()

Retorna el identificador de sistema para esta @ref{f1c,,InputSource}.
@end deffn

@geindex setEncoding() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setEncoding}@anchor{3800}
@deffn {Método} InputSource.setEncoding (encoding)

Establece la codificación de caracteres para esta @ref{f1c,,InputSource}.

La codificación debe ser una cadena aceptable para una declaración de codificación XML (vea la sección 4.3.3 de la recomendación XML).

El atributo de codificación de la @ref{f1c,,InputSource} es ignorado si la @ref{f1c,,InputSource} contiene también un flujo de caracteres.
@end deffn

@geindex getEncoding() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getEncoding}@anchor{3801}
@deffn {Método} InputSource.getEncoding ()

Obtiene la codificación de caracteres de esta InputSource.
@end deffn

@geindex setByteStream() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setByteStream}@anchor{3802}
@deffn {Método} InputSource.setByteStream (bytefile)

Establece el flujo de bytes (un @ref{1c8e,,binary file}) para esta fuente de entrada.

El analizador SAX ignorará esto si existe también un flujo de caracteres especificado, pero utilizará un flujo de bytes en preferencia para abrir una conexión URI en sí.

Si la aplicación conoce la codificación de caracteres del flujo de bytes, debería establecerla con el método setEncoding.
@end deffn

@geindex getByteStream() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getByteStream}@anchor{3803}
@deffn {Método} InputSource.getByteStream ()

Obtiene el flujo de bytes para esta fuente de entrada.

El método getEncoding retornará la codificación de caracteres para este flujo de bytes, o @code{None} si se desconoce.
@end deffn

@geindex setCharacterStream() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setCharacterStream}@anchor{3804}
@deffn {Método} InputSource.setCharacterStream (charfile)

Establece el flujo de caracteres (un @ref{1c8d,,text file}) para esta fuente de entrada.

Si existe un flujo de caracteres especificado, el analizador SAX ignorará cualquier flujo de bytes y no intentará abrir una conexión URI al identificador de sistema.
@end deffn

@geindex getCharacterStream() (método de xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getCharacterStream}@anchor{3805}
@deffn {Método} InputSource.getCharacterStream ()

Obtiene el flujo de caracteres para esta fuente de entrada.
@end deffn

@node La Interfaz Attributes,La Interfaz AttributesNS,Objetos InputSource,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader attributes-objects}@anchor{37b9}@anchor{library/xml sax reader the-attributes-interface}@anchor{3806}
@subsubsection La Interfaz @code{Attributes}


Los objetos @code{Attributes} implementa una porción del @ref{1229,,mapping protocol}, incluyendo los métodos @code{copy()}, @code{get()}, @ref{1f5d,,__contains__()}, @code{items()}, @code{keys()}, y @code{values()}.  Los siguientes métodos también son provistos:

@geindex getLength() (método de xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getLength}@anchor{3807}
@deffn {Método} Attributes.getLength ()

Retorna el número de atributos.
@end deffn

@geindex getNames() (método de xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getNames}@anchor{3808}
@deffn {Método} Attributes.getNames ()

Retorna los nombres de los atributos.
@end deffn

@geindex getType() (método de xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getType}@anchor{3809}
@deffn {Método} Attributes.getType (name)

Retorna el tipo del atributo `name', que es normalmente @code{'CDATA'}.
@end deffn

@geindex getValue() (método de xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getValue}@anchor{380a}
@deffn {Método} Attributes.getValue (name)

Retorna el valor del atributo `name'.
@end deffn

@c getValueByQName, getNameByQName, getQNameByName, getQNames available

@c here already, but documented only for derived class.

@node La Interfaz AttributesNS,,La Interfaz Attributes,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader attributes-ns-objects}@anchor{37bb}@anchor{library/xml sax reader the-attributesns-interface}@anchor{380b}
@subsubsection La Interfaz @code{AttributesNS}


Esta interfaz es un subtipo de la interfaz @code{Attributes} (vea la sección @ref{37b9,,La Interfaz Attributes}). Todos los métodos soportados por la interfaz están también disponibles en los objetos @code{AttributesNS}.

Los siguientes métodos están también disponibles:

@geindex getValueByQName() (método de xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getValueByQName}@anchor{380c}
@deffn {Método} AttributesNS.getValueByQName (name)

Retorna el valor para un nombre cualificado.
@end deffn

@geindex getNameByQName() (método de xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getNameByQName}@anchor{380d}
@deffn {Método} AttributesNS.getNameByQName (name)

Retorna el par @code{(namespace, localname)} para un `name' cualificado.
@end deffn

@geindex getQNameByName() (método de xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNameByName}@anchor{380e}
@deffn {Método} AttributesNS.getQNameByName (name)

Retorna el nombre cualificado para un par @code{(namespace, localname)}.
@end deffn

@geindex getQNames() (método de xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNames}@anchor{380f}
@deffn {Método} AttributesNS.getQNames ()

Retorna los nombres cualificados para todos los atributos.
@end deffn

@node xml parsers expat — Fast XML parsing using Expat,,xml sax xmlreader — Interface for XML parsers,Herramientas Para Procesar Formatos de Marcado Estructurado
@anchor{library/pyexpat doc}@anchor{3810}@anchor{library/pyexpat module-xml parsers expat}@anchor{126}@anchor{library/pyexpat xml-parsers-expat-fast-xml-parsing-using-expat}@anchor{3811}
@subsection @code{xml.parsers.expat} — Fast XML parsing using Expat


@geindex module; xml.parsers.expat


__________________________________________________________________


@c Markup notes:
@c 
@c Many of the attributes of the XMLParser objects are callbacks.  Since
@c signature information must be presented, these are described using the method
@c directive.  Since they are attributes which are set by client code, in-text
@c references to these attributes should be marked using the :member: role.

@cartouche
@quotation Advertencia 
El módulo @code{pyexpat} no es seguro contra datos construidos maliciosamente.  Si necesita analizar datos que no son de confianza o no autenticados, consulte @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche

@geindex Expat

El módulo @ref{126,,xml.parsers.expat} es una interfaz de Python para el analizador XML no validado de Expat. El módulo proporciona un único tipo de extensión, @code{xmlparser}, que representa el estado actual de un analizador XML.  Después de que se haya creado un objeto @code{xmlparser}, se pueden establecer varios atributos del objeto en funciones de controlador.  Cuando se envía un documento XML al analizador, se llaman a las funciones del controlador para los datos de caracteres y el marcado en el documento XML.

@geindex module;pyexpat

Este módulo utiliza el módulo @code{pyexpat} para proporcionar acceso al analizador Expat.  El uso directo del módulo @code{pyexpat} está obsoleto.

Este módulo proporciona una excepción y un tipo de objeto:

@geindex ExpatError
@anchor{library/pyexpat xml parsers expat ExpatError}@anchor{12e6}
@deffn {Excepción} xml.parsers.expat.ExpatError

La excepción que se lanza cuando Expat informa un error.  Consulte la sección @ref{3812,,Excepciones de ExpatError} para obtener más información sobre cómo interpretar los errores de Expat.
@end deffn

@geindex error
@anchor{library/pyexpat xml parsers expat error}@anchor{3813}
@deffn {Excepción} xml.parsers.expat.error

Alias para @ref{12e6,,ExpatError}.
@end deffn

@geindex XMLParserType (en el módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat XMLParserType}@anchor{3814}
@deffn {Dato} xml.parsers.expat.XMLParserType

El tipo de los valores de retorno de la función @ref{3815,,ParserCreate()}.
@end deffn

El modulo @ref{126,,xml.parsers.expat} contiene dos funciones:

@geindex ErrorString() (en el módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat ErrorString}@anchor{3816}
@deffn {Función} xml.parsers.expat.ErrorString (errno)

Retorna una cadena explicativa para un número de error dado `errno'.
@end deffn

@geindex ParserCreate() (en el módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat ParserCreate}@anchor{3815}
@deffn {Función} xml.parsers.expat.ParserCreate (encoding=None, namespace_separator=None)

Crea y retorna un nuevo objeto @code{xmlparser}.  `encoding', si se especifica, debe ser una cadena que nombre la codificación utilizada  por los datos XML.  Expat no admite tantas codificaciones como Python, y su repertorio de codificaciones no se puede ampliar; es compatible con UTF-8, UTF-16, ISO-8859-1 (Latin1) y ASCII.  Si se proporciona `encoding' @footnote{
La cadena de codificación incluida en la salida XML debe cumplir con los estándares apropiados. Por ejemplo, «UTF-8» es válido, pero «UTF8» no lo es. Consulte @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} y @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
}, anulará la codificación implícita o explícita del documento.

Expat puede, opcionalmente, realizar el procesamiento del espacio de nombres XML por usted, habilitado al proporcionar un valor para `namespace_separator'.  El valor debe ser una cadena de un carácter; a @ref{360,,ValueError} se lanzará si la cadena tiene una longitud ilegal (@code{None} se considera lo mismo que una omisión).  Cuando el procesamiento de espacios de nombres está habilitado, se expandirán los nombres de tipos de elementos y los nombres de atributos que pertenecen a un espacio de nombres.  El nombre del elemento pasado a los controladores de elementos @code{StartElementHandler} y @code{EndElementHandler} será la concatenación del URI del espacio de nombres, el carácter separador del espacio de nombres y la parte local del nombre.  Si el separador del espacio de nombres es un byte cero (@code{chr(0)}), el URI del espacio de nombres y la parte local se concatenarán sin ningún separador.

Por ejemplo, si `namespace_separator' se establece en un carácter de espacio (@code{' '}) y se analiza el siguiente documento:

@example
<?xml version="1.0"?>
<root xmlns    = "http://default-namespace.org/"
      xmlns:py = "http://www.python.org/ns/">
  <py:elem1 />
  <elem2 xmlns="" />
</root>
@end example

@code{StartElementHandler} recibirá las siguientes cadenas para cada elemento:

@example
http://default-namespace.org/ root
http://www.python.org/ns/ elem1
elem2
@end example

Debido a las limitaciones en la biblioteca @code{Expat} utilizada por @code{pyexpat}, la instancia @code{xmlparser} retorna solo se puede usar para analizar un solo documento XML.  Llame a @code{ParserCreate} para cada documento para proporcionar instancias de analizador únicas.
@end deffn


@subsubheading Ver también



@table @asis

@item El Expat XML Parser@footnote{http://www.libexpat.org/}

Página de inicio del proyecto Expat.
@end table


@menu
* Objetos XMLParser: Objetos XMLParser<2>. 
* Excepciones de ExpatError:: 
* Ejemplo: Ejemplo<10>. 
* Descripciones del modelo de contenido:: 
* Constantes de error de expansión:: 

@end menu

@node Objetos XMLParser<2>,Excepciones de ExpatError,,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat id2}@anchor{3817}@anchor{library/pyexpat xmlparser-objects}@anchor{3818}
@subsubsection Objetos XMLParser


Los objetos @code{xmlparser} tienen los siguientes métodos:

@geindex Parse() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser Parse}@anchor{3819}
@deffn {Método} xmlparser.Parse (data[, isfinal])

Analiza el contenido de la cadena `data', llamando a las funciones del controlador apropiadas para procesar los datos analizados.  `isfinal' debe ser verdadero en la última llamada a este método; permite el análisis de un solo archivo en fragmentos, no el envío de varios archivos. `data' puede ser la cadena vacía en cualquier momento.
@end deffn

@geindex ParseFile() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ParseFile}@anchor{381a}
@deffn {Método} xmlparser.ParseFile (file)

Analizar la lectura de datos XML del objeto `file'.  `file' solo necesita proporcionar el método @code{read(nbytes)}, devolviendo la cadena vacía cuando no hay más datos.
@end deffn

@geindex SetBase() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetBase}@anchor{381b}
@deffn {Método} xmlparser.SetBase (base)

Establece la base que se utilizará para resolver URIs relativos en identificadores de sistema en declaraciones.  La resolución de los identificadores relativos se deja en manos de la aplicación: este valor se pasará como el argumento `base' a las funciones @ref{381c,,ExternalEntityRefHandler()}, @ref{381d,,NotationDeclHandler()}, y @ref{381e,,UnparsedEntityDeclHandler()}.
@end deffn

@geindex GetBase() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetBase}@anchor{381f}
@deffn {Método} xmlparser.GetBase ()

Retorna una cadena que contiene la base establecida por una llamada anterior a @ref{381b,,SetBase()}, o @code{None} si no se ha llamado a  @ref{381b,,SetBase()}.
@end deffn

@geindex GetInputContext() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetInputContext}@anchor{3820}
@deffn {Método} xmlparser.GetInputContext ()

Retorna los datos de entrada que generaron el evento actual como una cadena. Los datos están en la codificación de la entidad que contiene el texto. Cuando se llama mientras un controlador de eventos no está activo, el valor de retorno es @code{None}.
@end deffn

@geindex ExternalEntityParserCreate() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityParserCreate}@anchor{3821}
@deffn {Método} xmlparser.ExternalEntityParserCreate (context[, encoding])

Cree un analizador «child» que se pueda utilizar para analizar una entidad analizada externa a la que hace referencia el contenido analizado por el analizador principal.  El parámetro `context' debe ser la cadena pasada a la función del controlador @ref{381c,,ExternalEntityRefHandler()}, que se describe a continuación. El analizador secundario se crea con @code{order_attributes} y @code{specific_attributes} establecidos en los valores de este analizador.
@end deffn

@geindex SetParamEntityParsing() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetParamEntityParsing}@anchor{3822}
@deffn {Método} xmlparser.SetParamEntityParsing (flag)

Controle el análisis de las entidades de parámetros (incluido el subconjunto DTD externo). Los posibles valores de `flag' son @code{XML_PARAM_ENTITY_PARSING_NEVER}, @code{XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE} y @code{XML_PARAM_ENTITY_PARSING_ALWAYS}.  Retorna verdadero si el establecimiento de la bandera fue exitoso.
@end deffn

@geindex UseForeignDTD() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser UseForeignDTD}@anchor{3823}
@deffn {Método} xmlparser.UseForeignDTD ([flag])

Llamar a esto con un valor verdadero para `flag' (el predeterminado) hará que Expat llame a @ref{381c,,ExternalEntityRefHandler} con @ref{716,,None} para todos los argumentos para permitir que se cargue una DTD alternativa. Si el documento no contiene una declaración de tipo de documento, se seguirá llamando a @ref{381c,,ExternalEntityRefHandler}, pero no se llamará a @ref{3824,,StartDoctypeDeclHandler} y @ref{3825,,EndDoctypeDeclHandler}.

Pasar un valor falso para `flag' cancelará una llamada anterior que pasó un valor verdadero, pero por lo demás no tiene ningún efecto.

Este método sólo se puede llamar antes de que se llamen los métodos @ref{3819,,Parse()} o @ref{381a,,ParseFile()}; llamarlo después de que cualquiera de ellos haya sido llamado causa que @ref{12e6,,ExpatError} se lanza con el atributo @ref{1b,,code} establecido en @code{errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]}.
@end deffn

@geindex SetReparseDeferralEnabled() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetReparseDeferralEnabled}@anchor{3c9}
@deffn {Método} xmlparser.SetReparseDeferralEnabled (enabled)

@cartouche
@quotation Advertencia 
Calling @code{SetReparseDeferralEnabled(False)} has security implications,
as detailed below; please make sure to understand these consequences
prior to using the @code{SetReparseDeferralEnabled} method.
@end quotation
@end cartouche

Expat 2.6.0 introduced a security mechanism called «reparse deferral»
where instead of causing denial of service through quadratic runtime
from reparsing large tokens, reparsing of unfinished tokens is now delayed
by default until a sufficient amount of input is reached.
Due to this delay, registered handlers may — depending of the sizing of
input chunks pushed to Expat — no longer be called right after pushing new
input to the parser.  Where immediate feedback and taking over responsibility
of protecting against denial of service from large tokens are both wanted,
calling @code{SetReparseDeferralEnabled(False)} disables reparse deferral
for the current Expat parser instance, temporarily or altogether.
Calling @code{SetReparseDeferralEnabled(True)} allows re-enabling reparse
deferral.

Note that @ref{3c9,,SetReparseDeferralEnabled()} has been backported to some
prior releases of CPython as a security fix.  Check for availability of
@ref{3c9,,SetReparseDeferralEnabled()} using @ref{579,,hasattr()} if used in code
running across a variety of Python versions.


Added in version 3.13.

@end deffn

@geindex GetReparseDeferralEnabled() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetReparseDeferralEnabled}@anchor{3c8}
@deffn {Método} xmlparser.GetReparseDeferralEnabled ()

Returns whether reparse deferral is currently enabled for the given
Expat parser instance.


Added in version 3.13.

@end deffn

@code{xmlparser} los objetos tienen los siguientes atributos:

@geindex buffer_size (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_size}@anchor{3826}
@deffn {Atributo} xmlparser.buffer_size

El tamaño del búfer usado cuando @ref{14fe,,buffer_text} es verdadero. Se puede establecer un nuevo tamaño de búfer asignando un nuevo valor entero a este atributo. Cuando se cambia el tamaño, el búfer se vaciará.
@end deffn

@geindex buffer_text (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_text}@anchor{14fe}
@deffn {Atributo} xmlparser.buffer_text

Setting this to true causes the @code{xmlparser} object to buffer textual
content returned by Expat to avoid multiple calls to the
@ref{3827,,CharacterDataHandler()} callback whenever possible.  This can improve
performance substantially since Expat normally breaks character data into chunks
at every line ending.  This attribute is false by default, and may be changed at
any time. Note that when it is false, data that does not contain newlines
may be chunked too.
@end deffn

@geindex buffer_used (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_used}@anchor{3828}
@deffn {Atributo} xmlparser.buffer_used

Si @ref{14fe,,buffer_text} está habilitado, el número de bytes almacenados en el búfer. Estos bytes representan texto codificado en UTF-8.  Este atributo no tiene una interpretación significativa cuando @ref{14fe,,buffer_text} es falso.
@end deffn

@geindex ordered_attributes (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ordered_attributes}@anchor{3829}
@deffn {Atributo} xmlparser.ordered_attributes

Establecer este atributo en un número entero distinto de cero hace que los atributos se informen como una lista en lugar de un diccionario.  Los atributos se presentan en el orden que se encuentran en el texto del documento.  Para cada atributo, se presentan dos entradas de lista: el nombre del atributo y el valor del atributo. (Las versiones anteriores de este módulo también usaban este formato). De forma predeterminada, este atributo es falso; se puede cambiar en cualquier momento.
@end deffn

@geindex specified_attributes (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser specified_attributes}@anchor{382a}
@deffn {Atributo} xmlparser.specified_attributes

Si se establece en un número entero distinto de cero, el analizador informará solo los atributos que se especificaron en la instancia del documento y no los que se derivaron de declaraciones de atributos.  Las aplicaciones que establecen esto deben tener especial cuidado al utilizar la información adicional disponible en las declaraciones según sea necesario para cumplir con los estándares para el comportamiento de los procesadores XML.  De forma predeterminada, este atributo es falso; se puede cambiar en cualquier momento.
@end deffn

Los siguientes atributos contienen valores relacionados con el error más reciente encontrado por un objeto @code{xmlparser}, y solo tendrán los valores correctos una vez que una llamada a @code{Parse()} o @code{ParseFile()} haya lanzado una excepción @ref{12e6,,xml.parsers.expat.ExpatError}.

@geindex ErrorByteIndex (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorByteIndex}@anchor{382b}
@deffn {Atributo} xmlparser.ErrorByteIndex

Índice de bytes en el que se produjo un error.
@end deffn

@geindex ErrorCode (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorCode}@anchor{382c}
@deffn {Atributo} xmlparser.ErrorCode

Código numérico que especifica el problema.  Este valor puede pasarse a la función @ref{3816,,ErrorString()}, o compararse con una de las constantes definidas en el objeto @code{errors}.
@end deffn

@geindex ErrorColumnNumber (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorColumnNumber}@anchor{382d}
@deffn {Atributo} xmlparser.ErrorColumnNumber

Número de columna en la que se produjo un error.
@end deffn

@geindex ErrorLineNumber (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorLineNumber}@anchor{382e}
@deffn {Atributo} xmlparser.ErrorLineNumber

Número de línea en la que ocurrió un error.
@end deffn

Los siguientes atributos contienen valores relacionados con la ubicación actual del análisis en un objeto @code{xmlparser}.  Durante una devolución de llamada que informa un evento de análisis, indican la ubicación del primero de la secuencia de caracteres que generó el evento. Cuando se llama fuera de una devolución de llamada, la posición indicada estará justo después del último evento de análisis (independientemente de si hubo una devolución de llamada asociada).

@geindex CurrentByteIndex (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentByteIndex}@anchor{382f}
@deffn {Atributo} xmlparser.CurrentByteIndex

Índice de bytes actual en la entrada del analizador.
@end deffn

@geindex CurrentColumnNumber (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentColumnNumber}@anchor{3830}
@deffn {Atributo} xmlparser.CurrentColumnNumber

Número de columna actual en la entrada del analizador.
@end deffn

@geindex CurrentLineNumber (atributo de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentLineNumber}@anchor{3831}
@deffn {Atributo} xmlparser.CurrentLineNumber

Número de línea actual en la entrada del analizador.
@end deffn

Aquí está la lista de controladores que se pueden configurar.  Para configurar un controlador en un objeto @code{xmlparser} `o', use @code{o.handlername = func}.  `handlername' debe tomarse de la siguiente lista, y `func' debe ser un objeto invocable que acepte el número correcto de argumentos.  Los argumentos son todos cadenas, a menos que se indique lo contrario.

@geindex XmlDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser XmlDeclHandler}@anchor{3832}
@deffn {Método} xmlparser.XmlDeclHandler (version, encoding, standalone)

Se llama cuando se analiza la declaración XML.  La declaración XML es la declaración (opcional) de la versión aplicable de la recomendación XML, la codificación del texto del documento y una declaración «independiente» opcional. `version' y `encoding' serán cadenas, y `standalone' será @code{1} si el documento se declara independiente, @code{0} si se declara no independiente o @code{-1} si se omitió la cláusula independiente. Esto solo está disponible con la versión Expat 1.95.0 o más reciente.
@end deffn

@geindex StartDoctypeDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartDoctypeDeclHandler}@anchor{3824}
@deffn {Método} xmlparser.StartDoctypeDeclHandler (doctypeName, systemId, publicId, has_internal_subset)

Se llama cuando Expat comienza a analizar la declaración del tipo de documento (@code{<! DOCTYPE ...}).  El `doctypeName' se proporciona exactamente como se presenta.  Los parámetros `systemId' y `publicId' dan el sistema y los identificadores públicos si se especifican, o @code{None} si se omite.  `has_internal_subset' será verdadero si el documento contiene un subconjunto de declaración de documento interno. Esto requiere Expat versión 1.2 o más reciente.
@end deffn

@geindex EndDoctypeDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndDoctypeDeclHandler}@anchor{3825}
@deffn {Método} xmlparser.EndDoctypeDeclHandler ()

Se llama cuando Expat termina de analizar la declaración del tipo de documento. Esto requiere Expat versión 1.2 o más reciente.
@end deffn

@geindex ElementDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ElementDeclHandler}@anchor{3833}
@deffn {Método} xmlparser.ElementDeclHandler (name, model)

Se llama una vez para cada declaración de tipo de elemento.  `name' es el nombre del tipo de elemento y `model' es una representación del modelo de contenido.
@end deffn

@geindex AttlistDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser AttlistDeclHandler}@anchor{3834}
@deffn {Método} xmlparser.AttlistDeclHandler (elname, attname, type, default, required)

Se llama para cada atributo declarado para un tipo de elemento.  Si una declaración de lista de atributos declara tres atributos, este controlador se llama tres veces, una para cada atributo.  `elname' es el nombre del elemento al que se aplica la declaración y `attname' es el nombre del atributo declarado.  El tipo de atributo es una cadena pasada como `type'; los valores posibles son @code{'CDATA'}, @code{'ID'}, @code{'IDREF'}, … `default' da el valor predeterminado para el atributo utilizado cuando el atributo no está especificado por el instancia de documento, o @code{None} si no hay un valor predeterminado (valores @code{#IMPLIED}). Si se requiere que el atributo se proporcione en la instancia del documento, `required' será verdadero. Esto requiere la versión Expat 1.95.0 o más reciente.
@end deffn

@geindex StartElementHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartElementHandler}@anchor{3835}
@deffn {Método} xmlparser.StartElementHandler (name, attributes)

Llamado para el inicio de cada elemento.  `name' es una cadena que contiene el nombre del elemento, y `attributes' son los atributos del elemento. Si @code{order_attributes} es verdadero, esta es una lista (ver @code{order_attributes} para una descripción completa). De lo contrario, es un diccionario que asigna nombres a valores.
@end deffn

@geindex EndElementHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndElementHandler}@anchor{3836}
@deffn {Método} xmlparser.EndElementHandler (name)

Llamado al final de cada elemento.
@end deffn

@geindex ProcessingInstructionHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ProcessingInstructionHandler}@anchor{3837}
@deffn {Método} xmlparser.ProcessingInstructionHandler (target, data)

Llamado para cada instrucción de procesamiento.
@end deffn

@geindex CharacterDataHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CharacterDataHandler}@anchor{3827}
@deffn {Método} xmlparser.CharacterDataHandler (data)

Called for character data.  This will be called for normal character data, CDATA
marked content, and ignorable whitespace.  Applications which must distinguish
these cases can use the @ref{3838,,StartCdataSectionHandler},
@ref{3839,,EndCdataSectionHandler}, and @ref{3833,,ElementDeclHandler} callbacks to
collect the required information. Note that the character data may be
chunked even if it is short and so you may receive more than one call to
@ref{3827,,CharacterDataHandler()}. Set the @ref{14fe,,buffer_text} instance attribute
to @code{True} to avoid that.
@end deffn

@geindex UnparsedEntityDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser UnparsedEntityDeclHandler}@anchor{381e}
@deffn {Método} xmlparser.UnparsedEntityDeclHandler (entityName, base, systemId, publicId, notationName)

Se llama para declaraciones de entidad sin analizar (NDATA).  Esto solo está presente para la versión 1.2 de la biblioteca Expat; para versiones más recientes, use @ref{383a,,EntityDeclHandler} en su lugar.  (La función subyacente en la biblioteca Expat se ha declarado obsoleta).
@end deffn

@geindex EntityDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EntityDeclHandler}@anchor{383a}
@deffn {Método} xmlparser.EntityDeclHandler (entityName, is_parameter_entity, value, base, systemId, publicId, notationName)

Llamado para todas las declaraciones de entidad.  Para parámetros y entidades internas, `value' será una cadena que proporciona el contenido declarado de la entidad; esto será @code{None} para entidades externas.  El parámetro `notationName' será @code{None} para las entidades analizadas y el nombre de la notación para las entidades no analizadas. `is_parameter_entity' será verdadero si la entidad es una entidad de parámetro o falso para las entidades generales (la mayoría de las aplicaciones solo deben preocuparse por las entidades generales). Esto solo está disponible a partir de la versión 1.95.0 de la biblioteca Expat.
@end deffn

@geindex NotationDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser NotationDeclHandler}@anchor{381d}
@deffn {Método} xmlparser.NotationDeclHandler (notationName, base, systemId, publicId)

Se llama para declaraciones de notación.  `notationName', `base' y `systemId' y `publicId' son cadenas si se dan.  Si se omite el identificador público, `publicId' será @code{None}.
@end deffn

@geindex StartNamespaceDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartNamespaceDeclHandler}@anchor{383b}
@deffn {Método} xmlparser.StartNamespaceDeclHandler (prefix, uri)

Se llama cuando un elemento contiene una declaración de espacio de nombres.  Las declaraciones de espacio de nombres se procesan antes de que se llame a @ref{3835,,StartElementHandler} para el elemento en el que se colocan las declaraciones.
@end deffn

@geindex EndNamespaceDeclHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndNamespaceDeclHandler}@anchor{383c}
@deffn {Método} xmlparser.EndNamespaceDeclHandler (prefix)

Se llama cuando se alcanza la etiqueta de cierre para un elemento  que contiene una declaración de espacio de nombres.  Esto se llama una vez para cada declaración de espacio de nombres en el elemento en el orden inverso al que se llamó @ref{383b,,StartNamespaceDeclHandler} para indicar el inicio del alcance de cada declaración de espacio de nombres.  Las llamadas a este controlador se realizan después del correspondiente @ref{3836,,EndElementHandler} para el final del elemento.
@end deffn

@geindex CommentHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CommentHandler}@anchor{383d}
@deffn {Método} xmlparser.CommentHandler (data)

Llamado para comentarios.  `data' es el texto del comentario, excluyendo el @code{'<!-}@code{-'} inicial y el final @code{'-}@code{->'}.
@end deffn

@geindex StartCdataSectionHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartCdataSectionHandler}@anchor{3838}
@deffn {Método} xmlparser.StartCdataSectionHandler ()

Llamado al comienzo de una sección CDATA.  Esto y @ref{3839,,EndCdataSectionHandler} son necesarios para poder identificar el inicio sintáctico y el final de las secciones CDATA.
@end deffn

@geindex EndCdataSectionHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndCdataSectionHandler}@anchor{3839}
@deffn {Método} xmlparser.EndCdataSectionHandler ()

Llamado al final de una sección CDATA.
@end deffn

@geindex DefaultHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandler}@anchor{383e}
@deffn {Método} xmlparser.DefaultHandler (data)

Se invoca por cualquier carácter del documento XML para el que no se ha especificado ningún controlador aplicable.  Esto significa caracteres que forman parte de una construcción que se podría informar, pero para los que no se ha proporcionado ningún controlador.
@end deffn

@geindex DefaultHandlerExpand() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandlerExpand}@anchor{383f}
@deffn {Método} xmlparser.DefaultHandlerExpand (data)

Es lo mismo que @ref{383e,,DefaultHandler()}, pero no inhibe la expansión de entidades internas. La referencia de la entidad no se pasará al controlador predeterminado.
@end deffn

@geindex NotStandaloneHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser NotStandaloneHandler}@anchor{3840}
@deffn {Método} xmlparser.NotStandaloneHandler ()

Se llama si el documento XML no se ha declarado como un documento independiente. Esto sucede cuando hay un subconjunto externo o una referencia a una entidad de parámetro, pero la declaración XML no establece independiente en @code{yes} en una declaración XML.  Si este controlador retorna @code{0}, el analizador lanzará un error @code{XML_ERROR_NOT_STANDALONE}.  Si este controlador no está configurado, el analizador no lanza ninguna excepción para esta condición.
@end deffn

@geindex ExternalEntityRefHandler() (método de xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityRefHandler}@anchor{381c}
@deffn {Método} xmlparser.ExternalEntityRefHandler (context, base, systemId, publicId)

Llamado para referencias a entidades externas.  `base' es la base actual, según lo establecido por una llamada anterior a @ref{381b,,SetBase()}.  Los identificadores público y del sistema, `systemId' y `publicId', son cadenas si se dan; si no se proporciona el identificador público, `publicId' será @code{None}.  El valor `context' es opaco y solo debe usarse como se describe a continuación.

Para que se analicen las entidades externas, se debe implementar este controlador. Es responsable de crear el sub-analizador usando @code{ExternalEntityParserCreate(context)}, inicializándolo con las devoluciones de llamada apropiadas y analizando la entidad.  Este controlador debería devolver un número entero; si retorna @code{0}, el analizador lanzará un error @code{XML_ERROR_EXTERNAL_ENTITY_HANDLING}; de lo contrario, el análisis continuará.

Si no se proporciona este controlador, las entidades externas se informan mediante la devolución de llamada @ref{383e,,DefaultHandler}, si se proporciona.
@end deffn

@node Excepciones de ExpatError,Ejemplo<10>,Objetos XMLParser<2>,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat expaterror-exceptions}@anchor{3841}@anchor{library/pyexpat expaterror-objects}@anchor{3812}
@subsubsection Excepciones de ExpatError


Las excepciones @ref{12e6,,ExpatError} tienen una serie de atributos interesantes:

@geindex code (atributo de xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError code}@anchor{3842}
@deffn {Atributo} ExpatError.code

Número de error interno del expatriado para el error específico.  El diccionario @ref{3843,,errors.messages} asigna estos números de error a los mensajes de error de Expat.  Por ejemplo:

@example
from xml.parsers.expat import ParserCreate, ExpatError, errors

p = ParserCreate()
try:
    p.Parse(some_xml_document)
except ExpatError as err:
    print("Error:", errors.messages[err.code])
@end example

El módulo @ref{127,,errors} también proporciona constantes de mensajes de error y un diccionario @ref{3844,,codes} mapeando estos mensajes a los códigos de error, ver más abajo.
@end deffn

@geindex lineno (atributo de xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError lineno}@anchor{3845}
@deffn {Atributo} ExpatError.lineno

Número de línea en la que se detectó el error.  La primera línea está numerada como @code{1}.
@end deffn

@geindex offset (atributo de xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError offset}@anchor{3846}
@deffn {Atributo} ExpatError.offset

Carácter desplazado en la línea donde ocurrió el error.  La primera columna está numerada como @code{0}.
@end deffn

@node Ejemplo<10>,Descripciones del modelo de contenido,Excepciones de ExpatError,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat example}@anchor{3847}@anchor{library/pyexpat expat-example}@anchor{3848}
@subsubsection Ejemplo


El siguiente programa define tres controladores que simplemente imprimen sus argumentos.

@example
import xml.parsers.expat

# 3 handler functions
def start_element(name, attrs):
    print('Start element:', name, attrs)
def end_element(name):
    print('End element:', name)
def char_data(data):
    print('Character data:', repr(data))

p = xml.parsers.expat.ParserCreate()

p.StartElementHandler = start_element
p.EndElementHandler = end_element
p.CharacterDataHandler = char_data

p.Parse("""<?xml version="1.0"?>
<parent id="top"><child1 name="paul">Text goes here</child1>
<child2 name="fred">More text</child2>
</parent>""", 1)
@end example

La salida de este programa es:

@example
Start element: parent @{'id': 'top'@}
Start element: child1 @{'name': 'paul'@}
Character data: 'Text goes here'
End element: child1
Character data: '\n'
Start element: child2 @{'name': 'fred'@}
Character data: 'More text'
End element: child2
Character data: '\n'
End element: parent
@end example

@node Descripciones del modelo de contenido,Constantes de error de expansión,Ejemplo<10>,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat content-model-descriptions}@anchor{3849}@anchor{library/pyexpat expat-content-models}@anchor{384a}@anchor{library/pyexpat module-xml parsers expat model}@anchor{128}
@subsubsection Descripciones del modelo de contenido


@geindex module; xml.parsers.expat.model

Los modelos de contenido se describen mediante tuplas anidadas.  Cada tupla contiene cuatro valores: el tipo, el cuantificador, el nombre y una tupla de niños.  Los niños son simplemente descripciones adicionales del modelo de contenido.

Los valores de los dos primeros campos son constantes definidas en el módulo @ref{128,,xml.parsers.expat.model}.  Estas constantes se pueden recopilar en dos grupos: el grupo de tipo de modelo y el grupo de cuantificador.

Las constantes en el grupo de tipos de modelo son:


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_ANY

Se declaró que el elemento nombrado por el nombre del modelo tiene un modelo de contenido de @code{ANY}.
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_CHOICE

El elemento nombrado permite elegir entre varias opciones; se utiliza para modelos de contenido como @code{(A | B | C)}.
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_EMPTY

Los elementos que se declaran @code{EMPTY} tienen este tipo de modelo.
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_MIXED
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_NAME
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CTYPE_SEQ

Los modelos que representan una serie de modelos que siguen uno tras otro se indican con este tipo de modelo.  Se utiliza para modelos como @code{(A, B, C)}.
@end deffn

Las constantes en el grupo cuantificador son:


@deffn {Dato} xml.parsers.expat.model.XML_CQUANT_NONE

No se proporciona ningún modificador, por lo que puede aparecer exactamente una vez, como para @code{A}.
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CQUANT_OPT

El modelo es opcional: puede aparecer una vez o no aparecer, como para @code{A?}.
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CQUANT_PLUS

El modelo debe aparecer una o más veces (como @code{A+}).
@end deffn


@deffn {Dato} xml.parsers.expat.model.XML_CQUANT_REP

El modelo debe aparecer cero o más veces, como en @code{A*}.
@end deffn

@node Constantes de error de expansión,,Descripciones del modelo de contenido,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat expat-error-constants}@anchor{384b}@anchor{library/pyexpat expat-errors}@anchor{384c}@anchor{library/pyexpat module-xml parsers expat errors}@anchor{127}
@subsubsection Constantes de error de expansión


@geindex module; xml.parsers.expat.errors

Las siguientes constantes se proporcionan en el módulo @ref{127,,xml.parsers.expat.errors}. Estas constantes son útiles para interpretar algunos de los atributos de los objetos de excepción @code{ExpatError} que se lanzaran cuando se produce un error. Dado que, por razones de compatibilidad con versiones anteriores, el valor de las constantes es el `message' de error y no el `code' de error numérico, puede hacer esto comparando su atributo @ref{1b,,code} con @code{errors.codes[errors.XML_ERROR_@var{CONSTANT_NAME}]}.

El módulo @code{errors} tiene los siguientes atributos:

@geindex codes (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors codes}@anchor{3844}
@deffn {Dato} xml.parsers.expat.errors.codes

Un diccionario que asigna descripciones de cadenas a sus códigos de error.


Added in version 3.2.

@end deffn

@geindex messages (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors messages}@anchor{3843}
@deffn {Dato} xml.parsers.expat.errors.messages

Un diccionario que asigna códigos de error numéricos a sus descripciones de cadenas.


Added in version 3.2.

@end deffn

@geindex XML_ERROR_ASYNC_ENTITY (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ASYNC_ENTITY}@anchor{384d}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY
@end deffn

@geindex XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF}@anchor{384e}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

Una referencia de entidad en un valor de atributo se refiere a una entidad externa en lugar de una entidad interna.
@end deffn

@geindex XML_ERROR_BAD_CHAR_REF (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BAD_CHAR_REF}@anchor{384f}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

Una referencia de carácter se refiere a un carácter que es ilegal en XML (por ejemplo, carácter @code{0}, o “@code{&#0;}”).
@end deffn

@geindex XML_ERROR_BINARY_ENTITY_REF (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BINARY_ENTITY_REF}@anchor{3850}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

Una referencia de entidad se refería a una entidad que se declaró con una notación, por lo que no se puede analizar.
@end deffn

@geindex XML_ERROR_DUPLICATE_ATTRIBUTE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_DUPLICATE_ATTRIBUTE}@anchor{3851}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

Un atributo se utilizó más de una vez en una etiqueta de inicio.
@end deffn

@geindex XML_ERROR_INCORRECT_ENCODING (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCORRECT_ENCODING}@anchor{3852}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING
@end deffn

@geindex XML_ERROR_INVALID_TOKEN (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_TOKEN}@anchor{3853}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

Se lanza cuando un byte de entrada no se puede asignar correctamente a un carácter; por ejemplo, un byte NUL (valor @code{0}) en un flujo de entrada UTF-8.
@end deffn

@geindex XML_ERROR_JUNK_AFTER_DOC_ELEMENT (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_JUNK_AFTER_DOC_ELEMENT}@anchor{3854}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

Se produjo algo diferente a los espacios en blanco después del elemento del documento.
@end deffn

@geindex XML_ERROR_MISPLACED_XML_PI (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_MISPLACED_XML_PI}@anchor{3855}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

Se encontró una declaración XML en algún lugar que no sea el comienzo de los datos de entrada.
@end deffn

@geindex XML_ERROR_NO_ELEMENTS (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_ELEMENTS}@anchor{3856}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

El documento no contiene elementos (XML requiere que todos los documentos contengan exactamente un elemento de nivel superior)..
@end deffn

@geindex XML_ERROR_NO_MEMORY (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_MEMORY}@anchor{3857}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

Expat no pudo asignar memoria internamente.
@end deffn

@geindex XML_ERROR_PARAM_ENTITY_REF (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARAM_ENTITY_REF}@anchor{3858}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

Se encontró una referencia de entidad de parámetro donde no estaba permitida.
@end deffn

@geindex XML_ERROR_PARTIAL_CHAR (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARTIAL_CHAR}@anchor{3859}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

Se encontró un carácter incompleto en la entrada.
@end deffn

@geindex XML_ERROR_RECURSIVE_ENTITY_REF (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RECURSIVE_ENTITY_REF}@anchor{385a}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

Una referencia de entidad contenía otra referencia a la misma entidad; posiblemente a través de un nombre diferente, y posiblemente indirectamente.
@end deffn

@geindex XML_ERROR_SYNTAX (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SYNTAX}@anchor{385b}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_SYNTAX

Se encontró algún error de sintaxis no especificado.
@end deffn

@geindex XML_ERROR_TAG_MISMATCH (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TAG_MISMATCH}@anchor{385c}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

Una etiqueta final no coincidía con la etiqueta inicial abierta más interna.
@end deffn

@geindex XML_ERROR_UNCLOSED_TOKEN (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_TOKEN}@anchor{385d}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

Algún token (como una etiqueta de inicio) no se cerró antes del final de la transmisión o se encontró el siguiente token.
@end deffn

@geindex XML_ERROR_UNDEFINED_ENTITY (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDEFINED_ENTITY}@anchor{385e}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

Se hizo referencia a una entidad que no estaba definida.
@end deffn

@geindex XML_ERROR_UNKNOWN_ENCODING (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNKNOWN_ENCODING}@anchor{385f}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

La codificación del documento no es compatible con Expat.
@end deffn

@geindex XML_ERROR_UNCLOSED_CDATA_SECTION (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_CDATA_SECTION}@anchor{3860}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

No se cerró una sección marcada con CDATA.
@end deffn

@geindex XML_ERROR_EXTERNAL_ENTITY_HANDLING (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_EXTERNAL_ENTITY_HANDLING}@anchor{3861}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING
@end deffn

@geindex XML_ERROR_NOT_STANDALONE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_STANDALONE}@anchor{3862}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

El analizador determinó que el documento no era «independiente» aunque se declaró en la declaración XML, y el @code{NotStandaloneHandler} se estableció y devolvió @code{0}.
@end deffn

@geindex XML_ERROR_UNEXPECTED_STATE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNEXPECTED_STATE}@anchor{3863}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE
@end deffn

@geindex XML_ERROR_ENTITY_DECLARED_IN_PE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ENTITY_DECLARED_IN_PE}@anchor{3864}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE
@end deffn

@geindex XML_ERROR_FEATURE_REQUIRES_XML_DTD (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FEATURE_REQUIRES_XML_DTD}@anchor{3865}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

Se solicitó una operación que requiere que se compile el soporte DTD, pero Expat se configuró sin soporte DTD.  Esto nunca debería ser informado por una compilación estándar del módulo @ref{126,,xml.parsers.expat}.
@end deffn

@geindex XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING}@anchor{3866}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

Se solicitó un cambio de comportamiento después de que comenzó el análisis que solo se puede cambiar antes de que haya comenzado el análisis.  Esto (actualmente) solo lanzado por @code{UseForeignDTD()}.
@end deffn

@geindex XML_ERROR_UNBOUND_PREFIX (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNBOUND_PREFIX}@anchor{3867}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

Se encontró un prefijo no declarado cuando se habilitó el procesamiento del espacio de nombres.
@end deffn

@geindex XML_ERROR_UNDECLARING_PREFIX (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDECLARING_PREFIX}@anchor{3868}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

El documento intentó eliminar la declaración de espacio de nombres asociada con un prefijo.
@end deffn

@geindex XML_ERROR_INCOMPLETE_PE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCOMPLETE_PE}@anchor{3869}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

El documento no contenía ningún elemento de documento.
@end deffn

@geindex XML_ERROR_XML_DECL (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_XML_DECL}@anchor{386a}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_XML_DECL

El documento no contenía ningún elemento de documento.
@end deffn

@geindex XML_ERROR_TEXT_DECL (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TEXT_DECL}@anchor{386b}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

Se produjo un error al analizar una declaración de texto en una entidad externa.
@end deffn

@geindex XML_ERROR_PUBLICID (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PUBLICID}@anchor{386c}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_PUBLICID

Se encontraron caracteres en la identificación pública que no están permitidos.
@end deffn

@geindex XML_ERROR_SUSPENDED (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPENDED}@anchor{386d}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_SUSPENDED

La operación solicitada se realizó en un analizador suspendido, pero no está permitida.  Esto incluye intentos de proporcionar información adicional o detener el analizador.
@end deffn

@geindex XML_ERROR_NOT_SUSPENDED (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_SUSPENDED}@anchor{386e}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

Se realizó un intento de reanudar el analizador cuando no se había suspendido.
@end deffn

@geindex XML_ERROR_ABORTED (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ABORTED}@anchor{386f}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_ABORTED

Esto no se debe informar a las aplicaciones Python.
@end deffn

@geindex XML_ERROR_FINISHED (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FINISHED}@anchor{3870}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_FINISHED

La operación solicitada se realizó en un analizador que terminó de analizar la entrada, pero no está permitido.  Esto incluye intentos de proporcionar información adicional o detener el analizador.
@end deffn

@geindex XML_ERROR_SUSPEND_PE (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPEND_PE}@anchor{3871}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XML (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XML}@anchor{3872}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML

Se hizo un intento de declarar o remover el prefijo del namespace reservado @code{xml} o de enlazarlo con otro namespace URI.
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XMLNS (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XMLNS}@anchor{3873}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS

Se hizo un intento por declarar o remover el prefijo del namespace reservado @code{xmlns}.
@end deffn

@geindex XML_ERROR_RESERVED_NAMESPACE_URI (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_NAMESPACE_URI}@anchor{3874}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI

Se hizo un intento de enlace entre la URI y uno de los prefijos del namespace reservado @code{xml} y @code{xmlns} a otro prefijo de namespace.
@end deffn

@geindex XML_ERROR_INVALID_ARGUMENT (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_ARGUMENT}@anchor{3875}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT

Esto no se debe informar a las aplicaciones Python.
@end deffn

@geindex XML_ERROR_NO_BUFFER (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_BUFFER}@anchor{3876}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_NO_BUFFER

Esto no se debe informar a las aplicaciones Python.
@end deffn

@geindex XML_ERROR_AMPLIFICATION_LIMIT_BREACH (en el módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_AMPLIFICATION_LIMIT_BREACH}@anchor{3877}
@deffn {Dato} xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH

El límite en el factor de amplificación de entrada (de DTD y entidades) ha sido sobrepasada.
@end deffn

@subsubheading Notas al pie


@node Protocolos y soporte de Internet,Servicios Multimedia,Herramientas Para Procesar Formatos de Marcado Estructurado,La biblioteca estándar de Python
@anchor{library/internet doc}@anchor{3878}@anchor{library/internet internet}@anchor{3879}@anchor{library/internet internet-protocols-and-support}@anchor{387a}
@section Protocolos y soporte de Internet


@geindex WWW
@geindex Internet
@geindex World Wide Web

@geindex module;socket

Los módulos descritos en este capítulo implementan protocolos de Internet y son compatibles con la tecnología relacionada. Todos están implementados en Python. La mayoría de estos módulos requieren la presencia del módulo dependiente del sistema @ref{cc,,socket}, que actualmente es compatible con las plataformas más populares. Aquí hay una descripción general:

@menu
* webbrowser — Convenient web-browser controller:: 
* wsgiref — WSGI Utilities and Reference Implementation:: 
* urllib — URL handling modules:: 
* urllib.request — Extensible library for opening URLs: urllib request — Extensible library for opening URLs. 
* urllib.response — Clases de respuesta usadas por urllib: urllib response — Clases de respuesta usadas por urllib. 
* urllib.parse — Parse URLs into components: urllib parse — Parse URLs into components. 
* urllib.error — Exception classes raised by urllib.request: urllib error — Exception classes raised by urllib request. 
* urllib.robotparser — Parser for robots.txt: urllib robotparser — Parser for robots txt. 
* http — HTTP modules:: 
* http.client — HTTP protocol client: http client — HTTP protocol client. 
* ftplib — FTP protocol client:: 
* poplib — POP3 protocol client:: 
* imaplib — IMAP4 protocol client:: 
* smtplib — SMTP protocol client:: 
* uuid — UUID objects according to RFC 9562:: 
* socketserver — A framework for network servers:: 
* http.server — HTTP servers: http server — HTTP servers. 
* http.cookies — HTTP state management: http cookies — HTTP state management. 
* http.cookiejar — Cookie handling for HTTP clients: http cookiejar — Cookie handling for HTTP clients. 
* xmlrpc — Módulos XMLRPC para cliente y servidor:: 
* xmlrpc.client — XML-RPC client access: xmlrpc client — XML-RPC client access. 
* xmlrpc.server — Basic XML-RPC servers: xmlrpc server — Basic XML-RPC servers. 
* ipaddress — IPv4/IPv6 manipulation library:: 

@end menu

@node webbrowser — Convenient web-browser controller,wsgiref — WSGI Utilities and Reference Implementation,,Protocolos y soporte de Internet
@anchor{library/webbrowser doc}@anchor{387b}@anchor{library/webbrowser module-webbrowser}@anchor{115}@anchor{library/webbrowser webbrowser-convenient-web-browser-controller}@anchor{387c}
@subsection @code{webbrowser} — Convenient web-browser controller


@geindex module; webbrowser

`Código fuente:' Lib/webbrowser.py@footnote{https://github.com/python/cpython/tree/main/Lib/webbrowser.py}


__________________________________________________________________


El módulo @ref{115,,webbrowser} proporciona una interfaz de alto nivel que permite mostrar documentos basados en web a los usuarios. En la mayoría de circunstancias, simplemente llamar a la función @ref{387d,,open()} desde este módulo hará lo correcto.

En Unix, son privilegiados los navegadores gráficos bajo X11, pero serán usados navegadores en modo texto si los navegadores gráficos no están disponibles o un `display' X11 no está disponible. Si se usan navegadores en modo texto, el proceso invocador será bloqueado hasta que el usuario salga del navegador.

Si existe la variable de entorno 
@geindex BROWSER
@geindex variables de entorno; BROWSER
@code{BROWSER}, esta es interpretada como la lista de navegadores a probar antes de los predeterminados de la plataforma, separados por @ref{1d4a,,os.pathsep}. Cuando el valor de una parte de la lista contiene la cadena @code{%s}, este es interpretado como una línea de comando literal de un navegador a usar con el argumento URL substituido por @code{%s}; si la parte no contiene @code{%s}, esta se interpreta simplemente como el nombre del navegador a lanzar. @footnote{
Los ejecutables nombrados aquí sin una ruta completa serán buscados en los directorios dados en la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.
}

En plataformas no Unix o cuando está disponible un navegador remoto en Unix, el proceso de control no esperará a que el usuario finalice el navegador, sino que permitirá al navegador remoto mantener su propia ventana en la pantalla. Si no están disponibles navegadores remotos en Unix, el proceso de control lanzará un nuevo navegador y esperará.

On iOS, the 
@geindex BROWSER
@geindex variables de entorno; BROWSER
@code{BROWSER} environment variable, as well as any arguments
controlling autoraise, browser preference, and new tab/window creation will be
ignored. Web pages will `always' be opened in the user’s preferred browser, in
a new tab, with the browser being brought to the foreground. The use of the
@ref{115,,webbrowser} module on iOS requires the @ref{2b,,ctypes} module. If
@ref{2b,,ctypes} isn’t available, calls to @ref{387d,,open()} will fail.

The script @code{webbrowser} can be used as a command-line interface for the
module. It accepts a URL as the argument. It accepts the following optional
parameters:


@itemize *

@item 
@code{-n}/@code{--new-window} opens the URL in a new browser window, if possible.

@item 
@code{-t}/@code{--new-tab} opens the URL in a new browser page («tab»).
@end itemize

The options are, naturally, mutually exclusive.  Usage example:

@example
python -m webbrowser -t "https://www.python.org"
@end example

@ref{1d5a,,Availability}: not WASI, not Android.

La siguiente excepción es definida:

@geindex Error
@anchor{library/webbrowser webbrowser Error}@anchor{387e}
@deffn {Excepción} webbrowser.Error

Excepción generada cuando ocurre un error de control de navegador.
@end deffn

Las siguientes funciones son definidas:

@geindex open() (en el módulo webbrowser)
@anchor{library/webbrowser webbrowser open}@anchor{387d}
@deffn {Función} webbrowser.open (url, new=0, autoraise=True)

Muestra `url' usando el navegador por defecto. Si `new' es 0, se abre la `url' en la misma ventana del navegador si es posible. Si `new' es 1, se abre una nueva ventana del navegador si es posible. Si `new' es 2, se abre una nueva página del navegador («pestaña») si es posible. Si `autoraise' es @code{True}, la ventana es lanzada si es posible (ten en cuenta que bajo muchos gestores de ventana esto ocurrirá independientemente de la configuración de esta variable).

Returns @code{True} if a browser was successfully launched, @code{False} otherwise.

Ten en cuenta que en algunas plataformas, tratar de abrir un nombre de archivo usando esta función puede funcionar e iniciar el programa asociado del sistema operativo. Sin embargo, esto no es soportado ni portable.

Lanza un @ref{18c3,,evento de auditoría} @code{webbrowser.open} con el argumento @code{url}.
@end deffn

@geindex open_new() (en el módulo webbrowser)
@anchor{library/webbrowser webbrowser open_new}@anchor{387f}
@deffn {Función} webbrowser.open_new (url)

Abre `url' en una nueva ventana del navegador por defecto, si es posible, si no, abre `url' en la única ventana del navegador.

Returns @code{True} if a browser was successfully launched, @code{False} otherwise.
@end deffn

@geindex open_new_tab() (en el módulo webbrowser)
@anchor{library/webbrowser webbrowser open_new_tab}@anchor{3880}
@deffn {Función} webbrowser.open_new_tab (url)

Abre `url' en una nueva página («pestaña») del navegador por defecto, si es posible, si no equivale a @ref{387f,,open_new()}.

Returns @code{True} if a browser was successfully launched, @code{False} otherwise.
@end deffn

@geindex get() (en el módulo webbrowser)
@anchor{library/webbrowser webbrowser get}@anchor{3881}
@deffn {Función} webbrowser.get (using=None)

Retorna un objeto de controlador para el tipo de navegador `using'. Si `using' es @code{None}, retorna un controlador de un navegador por defecto apropiado para el entorno del invocador.
@end deffn

@geindex register() (en el módulo webbrowser)
@anchor{library/webbrowser webbrowser register}@anchor{3882}
@deffn {Función} webbrowser.register (name, constructor, instance=None, *, preferred=False)

Registra el tipo de navegador `name'. Una vez que el tipo de navegador es registrado, la función @ref{3881,,get()} puede retornar un controlador para ese tipo de navegador. Si no se provee `instance' o es @code{None}, `constructor' será invocado sin parámetros al crear una instancia cuando sea necesario. Si se provee `instance', `constructor' no será nunca invocado y puede ser @code{None}.

Definir `preferred' a @code{True} hace de este navegador un resultado preferido para una invocación @ref{3881,,get()} sin argumento. De otra manera, este punto de entrada sólo es útil si planeas definir la variable 
@geindex BROWSER
@geindex variables de entorno; BROWSER
@code{BROWSER} o invocar @ref{3881,,get()} con un argumento no vacío correspondiendo con el nombre de un manejador que declaras.


Distinto en la versión 3.7: fue añadido el parámetro sólo de palabra clave `preferred'.

@end deffn

Un número de tipos de navegador son predefinidos. Esta tabla muestra los nombres de los tipos que se pueden pasar a la función @ref{3881,,get()} y las instanciaciones correspondientes para las clases de los controladores, todas definidas en este módulo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Nombre de tipo

@tab

Nombre de clase

@tab

Notas

@item

@code{'mozilla'}

@tab

@code{Mozilla('mozilla')}

@tab

@item

@code{'firefox'}

@tab

@code{Mozilla('mozilla')}

@tab

@item

@code{'epiphany'}

@tab

@code{Epiphany('epiphany')}

@tab

@item

@code{'kfmclient'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'konqueror'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'kfm'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'opera'}

@tab

@code{Opera()}

@tab

@item

@code{'links'}

@tab

@code{GenericBrowser('links')}

@tab

@item

@code{'elinks'}

@tab

@code{Elinks('elinks')}

@tab

@item

@code{'lynx'}

@tab

@code{GenericBrowser('lynx')}

@tab

@item

@code{'w3m'}

@tab

@code{GenericBrowser('w3m')}

@tab

@item

@code{'windows-default'}

@tab

@code{WindowsDefault}

@tab

(2)

@item

@code{'macosx'}

@tab

@code{MacOSXOSAScript('default')}

@tab

(3)

@item

@code{'safari'}

@tab

@code{MacOSXOSAScript('safari')}

@tab

(3)

@item

@code{'google-chrome'}

@tab

@code{Chrome('google-chrome')}

@tab

@item

@code{'chrome'}

@tab

@code{Chrome('chrome')}

@tab

@item

@code{'chromium'}

@tab

@code{Chromium('chromium')}

@tab

@item

@code{'chromium-browser'}

@tab

@code{Chromium('chromium-browser')}

@tab

@item

@code{'iosbrowser'}

@tab

@code{IOSBrowser}

@tab

(4)

@end multitable


Notas:


@enumerate 

@item 
«Konqueror» is the file manager for the KDE desktop environment for Unix, and
only makes sense to use if KDE is running.  Some way of reliably detecting KDE
would be nice; the @code{KDEDIR} variable is not sufficient.  Note also that
the name «kfm» is used even when using the @code{konqueror} command with KDE
2 — the implementation selects the best strategy for running Konqueror.

@item 
Sólo en plataformas Windows.

@item 
Only on macOS.

@item 
Only on iOS.
@end enumerate


Added in version 3.2: A new @code{MacOSXOSAScript} class has been added
and is used on Mac instead of the previous @code{MacOSX} class.
This adds support for opening browsers not currently set as the OS default.



Added in version 3.3: Ha sido añadido soporte para Chrome/Chromium.



Distinto en la versión 3.12: Se ha eliminado el soporte para varios navegadores obsoletos. Los navegadores eliminados son Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape y Firefox versión 35 e inferiores.



Distinto en la versión 3.13: Support for iOS has been added.


Aquí están algunos ejemplos simples:

@example
url = 'https://docs.python.org/'

# Open URL in a new tab, if a browser window is already open.
webbrowser.open_new_tab(url)

# Open URL in new window, raising the window if possible.
webbrowser.open_new(url)
@end example

@menu
* Objetos controladores de navegador:: 

@end menu

@node Objetos controladores de navegador,,,webbrowser — Convenient web-browser controller
@anchor{library/webbrowser browser-controller-objects}@anchor{3883}@anchor{library/webbrowser browser-controllers}@anchor{3884}
@subsubsection Objetos controladores de navegador


Los controladores de navegador proveen aquellos métodos que son paralelos a tres de las funciones de conveniencia a nivel del módulo:

@geindex name (atributo de webbrowser.controller)
@anchor{library/webbrowser webbrowser controller name}@anchor{3e9}
@deffn {Atributo} controller.name

Nombre dependiente del sistema para el navegador.
@end deffn

@geindex open() (método de webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open}@anchor{3885}
@deffn {Método} controller.open (url, new=0, autoraise=True)

Despliega `url' usando el navegador manejado por este controlador. Si `new' es 1, se abre una nueva ventana del navegador si es posible. Si `new' es 2, se abre una nueva página del navegador («pestaña») si es posible.
@end deffn

@geindex open_new() (método de webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open_new}@anchor{3886}
@deffn {Método} controller.open_new (url)

Abre `url' en una nueva ventana del navegador manejado por este controlador, si es posible, si no, abre `url' en la única ventana del navegador. Alias @ref{387f,,open_new()}.
@end deffn

@geindex open_new_tab() (método de webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open_new_tab}@anchor{3887}
@deffn {Método} controller.open_new_tab (url)

Abre `url' en una nueva página («pestaña») del navegador manejado por este controlador, si es posible, si no equivale a @ref{387f,,open_new()}.
@end deffn

@subsubheading Notas al pie


@node wsgiref — WSGI Utilities and Reference Implementation,urllib — URL handling modules,webbrowser — Convenient web-browser controller,Protocolos y soporte de Internet
@anchor{library/wsgiref doc}@anchor{3888}@anchor{library/wsgiref module-wsgiref}@anchor{118}@anchor{library/wsgiref wsgiref-wsgi-utilities-and-reference-implementation}@anchor{3889}
@subsection @code{wsgiref} — WSGI Utilities and Reference Implementation


@geindex module; wsgiref

`Código fuente:' Lib/wsgiref@footnote{https://github.com/python/cpython/tree/main/Lib/wsgiref}


__________________________________________________________________


La Interfaz de Pasarela del Servidor Web, o `Web Server Gateway Interface' en inglés (WSGI), es una interfaz estándar entre el servidor web y aplicaciones web escritas en Python. Con una interfaz estándar es más sencillo usar una aplicación que soporte WSGI con diferentes servidores web.

Sólo los autores de servidores y frameworks web necesitan conocer cada detalle y caso límite del diseño WSGI. No es necesario conocer cada detalle de WSGI sólo para instalar o escribir una aplicación web usando un `framework' existente.

@ref{118,,wsgiref} es una implementación de referencia de la especificación WSGI que se puede usar para añadir soporte WSGI a un servidor o `framework' web. Este módulo provee utilidades para manipular las variables de entorno WSGI y las cabeceras de respuesta, clases base para implementar servidores WSGI, un servidor HTTP de demostración que sirve aplicaciones WSGI, tipos para validadores estáticos de tipos, y una herramienta de validación que comprueba la compatibilidad de servidores y aplicaciones WSGI en base a la especificación 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.

Vea wsgi.readthedocs.io@footnote{https://wsgi.readthedocs.io/} para más información sobre WSGI, así como enlaces a tutoriales y otros recursos.

@c XXX If you're just trying to write a web application...

@menu
* wsgiref.util – Utilidades de entorno WSGI: wsgiref util – Utilidades de entorno WSGI. 
* wsgiref.headers – Herramientas para cabeceras de respuesta WSGI: wsgiref headers – Herramientas para cabeceras de respuesta WSGI. 
* wsgiref.simple_server– Un servidor HTTP WSGI simple: wsgiref simple_server– Un servidor HTTP WSGI simple. 
* wsgiref.validate — Verificador de compatibilidad WSGI: wsgiref validate — Verificador de compatibilidad WSGI. 
* wsgiref.handlers – Clases base servidor/gateway: wsgiref handlers – Clases base servidor/gateway. 
* wsgiref.types — Tipos de WSGI para validadores estáticos de tipos: wsgiref types — Tipos de WSGI para validadores estáticos de tipos. 
* Ejemplos: Ejemplos<23>. 

@end menu

@node wsgiref util – Utilidades de entorno WSGI,wsgiref headers – Herramientas para cabeceras de respuesta WSGI,,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref util}@anchor{11d}@anchor{library/wsgiref wsgiref-util-wsgi-environment-utilities}@anchor{388a}
@subsubsection @code{wsgiref.util} – Utilidades de entorno WSGI


@geindex module; wsgiref.util

Este módulo ofrece una variedad de funciones útiles para trabajar con entornos WSGI. Un entorno WSGI es un diccionario que contiene variables de la petición HTTP, descrito en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Todas las funciones que aceptan un parámetro `environ' esperan un diccionario compatible con WSGI. Por favor, consulte la especificación detallada en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}, y los alias de tipos que pueden usarse en las anotaciones de tipo en @ref{388b,,WSGIEnvironment}.

@geindex guess_scheme() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util guess_scheme}@anchor{388c}
@deffn {Función} wsgiref.util.guess_scheme (environ)

Retorna una deducción del valor para @code{wsgi.url_scheme} que debería ser «http» o «https», buscando la variable de entorno @code{HTTPS} en el diccionario `environ'. El valor de retorno es una cadena.

Esta función es útil al crear un `gateway' que envuelve CGI o un protocolo similar como FastCGI. Habitualmente, los servidores que ofrecen estos protocolos incluyen una variable @code{HTTPS} con el valor «1», «yes», o «on» cuando reciben una petición vía SSL. Así, esta función retorna «https» si encuentra ese valor, o «http», en caso contrario.
@end deffn

@geindex request_uri() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util request_uri}@anchor{388d}
@deffn {Función} wsgiref.util.request_uri (environ, include_query=True)

Retorna la URI completa de la petición, opcionalmente la cadena de consulta, usando el algoritmo encontrado en la sección «URL Reconstruction» de 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Si `include_query' es falso, la cadena de consulta no se incluye en la URI resultante.
@end deffn

@geindex application_uri() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util application_uri}@anchor{388e}
@deffn {Función} wsgiref.util.application_uri (environ)

Similar a @ref{388d,,request_uri()} excepto que se ignoran las variables @code{PATH_INFO} y @code{QUERY_STRING}. El resultado es la URI base del objeto de aplicación indicado en la petición.
@end deffn

@geindex shift_path_info() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util shift_path_info}@anchor{388f}
@deffn {Función} wsgiref.util.shift_path_info (environ)

Desplaza un solo nombre de @code{PATH_INFO} a @code{SCRIPT_NAME} y retorna el nombre. Se modifica el diccionario `environ', por lo que se deberá usar una copia si se quiere mantener @code{PATH_INFO} o @code{SCRIPT_NAME} intactos.

Si no quedan segmentos en @code{PATH_INFO}, retornará @code{None}.

Habitualmente, esta rutina se usa para procesar cada porción de la ruta del URI de la petición, por ejemplo, para usar la ruta como una serie de claves en un diccionario. Esta rutina modifica el entorno pasado para permitir invocar otra aplicación WSGI que esté localizada en la URI objetivo. Por ejemplo, si hay una aplicación WSGI en @code{/foo}, y la ruta es @code{/foo/bar/baz}, y la aplicación WSGI en @code{/foo} llama a @ref{388f,,shift_path_info()}, recibirá la cadena «bar», y se actualizará el entorno para pasarlo a una aplicación WSGI en @code{/foo/bar}. Es decir, @code{SCRIPT_NAME} cambiará de @code{/foo} a @code{/foo/bar} y @code{PATH_INFO} cambiará de @code{/bar/baz} a @code{/baz}.

Cuando @code{PATH_INFO} es únicamente «/», esta rutina retornará una cadena vacía y añadirá una barra final a @code{SCRIPT_NAME}, incluso cuando normalmente los segmentos de ruta vacíos se ignoran y @code{SCRIPT_NAME} no acaba con una barra. Este comportamiento es intencional, para asegurar que una aplicación puede diferenciar entre URIs que acaban en @code{/x} de las que acaban en @code{/x/} cuando usan esta rutina para atravesar objetos.
@end deffn

@geindex setup_testing_defaults() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util setup_testing_defaults}@anchor{3890}
@deffn {Función} wsgiref.util.setup_testing_defaults (environ)

Actualiza `environ' con valores por defecto triviales con propósito de prueba.

Esta rutina añade varios parámetros requeridos por WSGI, incluyendo @code{HTTP_POST}, @code{SERVER_NAME}, @code{SERVER_PORT}, @code{REQUEST_METHOD}, @code{SCRIPT_NAME}, @code{PATH_INFO}, y todas las variables @code{wsgi.*} definidas en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Sólo ofrece valores por defecto y no reemplaza ningún valor existente en esas variables.

Esta rutina pretende facilitar la preparación de entornos ficticios para pruebas unitarias de servidores y aplicaciones WSGI. NO debería usarse en servidores y aplicaciones WSGI reales, ya que los valores son ficticios!

Ejemplo de uso:

@example
from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server

# A relatively simple WSGI application. It's going to print out the
# environment dictionary after being updated by setup_testing_defaults
def simple_app(environ, start_response):
    setup_testing_defaults(environ)

    status = '200 OK'
    headers = [('Content-type', 'text/plain; charset=utf-8')]

    start_response(status, headers)

    ret = [("%s: %s\n" % (key, value)).encode("utf-8")
           for key, value in environ.items()]
    return ret

with make_server('@w{'}, 8000, simple_app) as httpd:
    print("Serving on port 8000...")
    httpd.serve_forever()
@end example
@end deffn

Además de las funciones de entorno previas, el módulo @ref{11d,,wsgiref.util} también ofrece las siguientes utilidades varias:

@geindex is_hop_by_hop() (en el módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util is_hop_by_hop}@anchor{16ce}
@deffn {Función} wsgiref.util.is_hop_by_hop (header_name)

Retorna @code{True} si “header_name” es una cabecera «Hop-by-Hop» HTTP/1.1, como se define en 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}.
@end deffn

@geindex FileWrapper (clase en wsgiref.util)
@anchor{library/wsgiref wsgiref util FileWrapper}@anchor{7d2}
@deffn {Clase} wsgiref.util.FileWrapper (filelike, blksize=8192)

Una implementación concreta del protocolo @ref{3891,,wsgiref.types.FileWrapper} usado para convertir objetos de tipo archivo en un @ref{313,,iterator}. Los objetos resultantes son @ref{1294,,iterable}s. A medida que se itera sobre el objeto, el parámetro opcional `blksize' se pasará repetidamente al método @code{read()} del objeto archivo para obtener cadenas de bytes para entregar. Cuando @code{read()} retorna una cadena de bytes vacía, la iteración finalizará y no se podrá reiniciar.

Si `filelike' tiene un método @code{close()}, el objeto retornado también tendrá un método @code{close()} que llamará al método @code{close()} del objeto archivo subyacente.

Ejemplo de uso:

@example
from io import StringIO
from wsgiref.util import FileWrapper

# We're using a StringIO-buffer for as the file-like object
filelike = StringIO("This is an example file-like object"*10)
wrapper = FileWrapper(filelike, blksize=5)

for chunk in wrapper:
    print(chunk)
@end example


Distinto en la versión 3.11: Support for @ref{3d8,,__getitem__()} method has been removed.

@end deffn

@node wsgiref headers – Herramientas para cabeceras de respuesta WSGI,wsgiref simple_server– Un servidor HTTP WSGI simple,wsgiref util – Utilidades de entorno WSGI,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref headers}@anchor{11a}@anchor{library/wsgiref wsgiref-headers-wsgi-response-header-tools}@anchor{3892}
@subsubsection @code{wsgiref.headers} – Herramientas para cabeceras de respuesta WSGI


@geindex module; wsgiref.headers

Este módulo ofrece una sola clase, @ref{f19,,Headers}, para la manipulación de cabeceras de respuesta WSGI usando un interfaz de mapa.

@geindex Headers (clase en wsgiref.headers)
@anchor{library/wsgiref wsgiref headers Headers}@anchor{f19}
@deffn {Clase} wsgiref.headers.Headers ([headers])

Crea un objeto con interfaz de mapa envolviendo `headers', que debe ser una lista de tuplas nombre/valor de las cabeceras, como se describe en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. El valor por defecto de `headers' es una lista vacía.

@ref{f19,,Headers} objects support typical mapping operations including
@ref{3d8,,__getitem__()}, @ref{2248,,get()}, @ref{1505,,__setitem__()},
@ref{10f5,,setdefault()},
@ref{1506,,__delitem__()} and @ref{1f5d,,__contains__()}.  For each of
these methods, the key is the header name (treated case-insensitively), and the
value is the first value associated with that header name.  Setting a header
deletes any existing values for that header, then adds a new value at the end of
the wrapped header list.  Headers” existing order is generally maintained, with
new headers added to the end of the wrapped list.

A diferencia de un diccionario, los objetos @ref{f19,,Headers} no lanzan un error cuando se intenta obtener o eliminar una clave que no está en la lista de cabeceras subyacente. Al intentar obtener una clave inexistente simplemente se retornará @code{None}, mientras que el intento de eliminación de una cabecera inexistente simplemente no tendrá ningún efecto.

Los objetos @ref{f19,,Headers} también soportan los métodos @code{keys()}, @code{values()}, y @code{items()}. Las listas retornadas por @code{keys()} y @code{items()} pueden incluir la misma clave más de una vez si se trata de una cabecera de valor múltiple. La @code{len()} de un objeto @ref{f19,,Headers} es la misma que la longitud de sus @code{items()}, que es la misma que la longitud de la lista de cabeceras envuelta. De hecho, el método @code{items()} simplemente retorna una copia de la lista de cabeceras.

La llamada @code{bytes()} sobre un objeto @ref{f19,,Headers} retorna una cadena de bytes formateada y lista para su transmisión como cabeceras de respuesta HTTP. Cada cabecera se ubica en una línea con su valor separado por dos puntos y un espacio. Cada línea finaliza con un retorno de carro y un salto de línea, y la cadena de bytes finaliza con una línea en blanco.

Además de la interfaz de mapa y las funcionalidades de formateado, los objetos @ref{f19,,Headers} también ofrecen los siguientes métodos para consultar y añadir cabeceras con múltiples valores, y para añadir cabeceras con parámetros MIME:

@geindex get_all() (método de wsgiref.headers.Headers)
@anchor{library/wsgiref wsgiref headers Headers get_all}@anchor{3893}
@deffn {Método} get_all (name)

Retorna una lista de todos los valores para la cabecera indicada.

La lista retornada tendrá los valores ordenados según la lista de cabeceras original o según se hayan añadido a esta instancia, y podrá contener duplicados. Cualquier campo eliminado y añadido de nuevo estará al final de la lista. Si no existen campos con el nombre indicado, retornará una lista vacía.
@end deffn

@geindex add_header() (método de wsgiref.headers.Headers)
@anchor{library/wsgiref wsgiref headers Headers add_header}@anchor{3894}
@deffn {Método} add_header (name, value, **_params)

Añade una cabecera, posiblemente de valor múltiple, con los parámetros MIME opcionales especificados vía argumentos por palabra clave.

`name' es el nombre de la cabecera a añadir. Se pueden usar argumentos por palabra clave para establecer parámetros MIME para la cabecera. Cada parámetro debe ser una cadena o @code{None}. Todos los guiones bajos en los nombres de parámetros se convierten en guiones, dado que los guiones son inválidos en identificadores Python y muchos parámetros MIME incluyen guiones. Si el valor del parámetro es una cadena, se añade a los parámetros del valor de la cabecera con la forma @code{nombre=valor}. Si es @code{None}, sólo se añade el nombre del parámetro, para reflejar parámetros MIME sin valor. Ejemplo de uso:

@example
h.add_header('content-disposition', 'attachment', filename='bud.gif')
@end example

El código anterior añadirá una cabecera como la siguiente:

@example
Content-Disposition: attachment; filename="bud.gif"
@end example
@end deffn


Distinto en la versión 3.5: El parámetro `headers' es opcional.

@end deffn

@node wsgiref simple_server– Un servidor HTTP WSGI simple,wsgiref validate — Verificador de compatibilidad WSGI,wsgiref headers – Herramientas para cabeceras de respuesta WSGI,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref simple_server}@anchor{11b}@anchor{library/wsgiref wsgiref-simple-server-a-simple-wsgi-http-server}@anchor{3895}
@subsubsection @code{wsgiref.simple_server}– Un servidor HTTP WSGI simple


@geindex module; wsgiref.simple_server

Este módulo implementa un servidor HTTP simple, basado en @ref{72,,http.server}, que sirve aplicaciones WSGI. Cada instancia del servidor sirve una aplicación WSGI simple en una máquina y puerto dados. Si se quiere servir múltiples aplicaciones en una misma máquina y puerto, se deberá crear una aplicación WSGI que analiza @code{PATH_INFO} para seleccionar qué aplicación invocar para cada petición. Por ejemplo, usando la función @code{shift_path_info()} de @ref{11d,,wsgiref.util}.

@geindex make_server() (en el módulo wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server make_server}@anchor{3896}
@deffn {Función} wsgiref.simple_server.make_server (host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)

Crea un nuevo servidor WSGI que sirve en `host' y `port', aceptando conexiones para `app'. El valor de retorno es una instancia de `server_class' y procesará peticiones usando `handler_class'. `app' debe ser un objeto aplicación WSGI, como se define en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.

Ejemplo de uso:

@example
from wsgiref.simple_server import make_server, demo_app

with make_server('@w{'}, 8000, demo_app) as httpd:
    print("Serving HTTP on port 8000...")

    # Respond to requests until process is killed
    httpd.serve_forever()

    # Alternative: serve one request, then exit
    httpd.handle_request()
@end example
@end deffn

@geindex demo_app() (en el módulo wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server demo_app}@anchor{3897}
@deffn {Función} wsgiref.simple_server.demo_app (environ, start_response)

Esta función es una pequeña pero completa aplicación WSGI que retorna una página de texto con el mensaje «Hello world!» y una lista de pares clave/valor obtenida del parámetro `environ'. Es útil para verificar que un servidor WSGI, como @ref{11b,,wsgiref.simple_server}, es capaz de ejecutar una aplicación WSGI simple correctamente.
@end deffn

@geindex WSGIServer (clase en wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server WSGIServer}@anchor{3898}
@deffn {Clase} wsgiref.simple_server.WSGIServer (server_address, RequestHandlerClass)

Crea una instancia de @ref{3898,,WSGIServer}. `server_address' debe ser una tupla @code{(máquina,puerto)} y `RequestHandlerClass' debe ser la subclase de @ref{1140,,http.server.BaseHTTPRequestHandler} que se usará para procesar peticiones.

Normalmente, no es necesario invocar este constructor, ya que la función @ref{3896,,make_server()} puede gestionar todos los detalles.

@ref{3898,,WSGIServer} es una subclase de @ref{3899,,http.server.HTTPServer}, por lo que todos sus métodos, como @code{serve_forever()} y @code{handle_request()}, están disponibles. @ref{3898,,WSGIServer} también ofrece los siguientes métodos específicos de WSGI:

@geindex set_app() (método de wsgiref.simple_server.WSGIServer)
@anchor{library/wsgiref wsgiref simple_server WSGIServer set_app}@anchor{389a}
@deffn {Método} set_app (application)

Establece el invocable `application' como la aplicación WSGI que recibirá las peticiones.
@end deffn

@geindex get_app() (método de wsgiref.simple_server.WSGIServer)
@anchor{library/wsgiref wsgiref simple_server WSGIServer get_app}@anchor{389b}
@deffn {Método} get_app ()

Retorna la aplicación invocable actualmente establecida.
@end deffn

Habitualmente, sin embargo, no es necesario usar estos métodos adicionales, ya que @ref{389a,,set_app()} se llama desde @ref{3896,,make_server()} y @ref{389b,,get_app()} existe sobretodo para el beneficio de instancias del gestor de peticiones.
@end deffn

@geindex WSGIRequestHandler (clase en wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler}@anchor{389c}
@deffn {Clase} wsgiref.simple_server.WSGIRequestHandler (request, client_address, server)

Crea un gestor HTTP para la `request' indicada (es decir un socket), `client_address (una tupla `@w{`}(máquina,puerto)`@w{`}), y *server' (una instancia @ref{3898,,WSGIServer}).

No es necesario crear instancias de esta clase directamente. Se crean automáticamente bajo demanda por objetos @ref{3898,,WSGIServer}. Sin embargo, se pueden crear subclases de esta clase y proveerlas como `handler_class' a la función @ref{3896,,make_server()}. Algunos métodos posiblemente relevantes para sobreescribir en estas subclases:

@geindex get_environ() (método de wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_environ}@anchor{389d}
@deffn {Método} get_environ ()

Retorna un diccionario @ref{388b,,WSGIEnvironment} para una petición. La implementación por defecto copia el contenido del diccionario atributo @code{base_environ} del objeto @code{WSGIserver} y añade varias cabeceras derivadas de la petición HTTP. Cada llamada a este método debe retornar un nuevo diccionario con todas las variables de entorno CGI relevantes especificadas en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.
@end deffn

@geindex get_stderr() (método de wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_stderr}@anchor{389e}
@deffn {Método} get_stderr ()

Retorna el objeto que debe usarse como el flujo de @code{wsgi.errors}. La implementación por defecto retorna simplemente @code{sys.stderr}.
@end deffn

@geindex handle() (método de wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler handle}@anchor{389f}
@deffn {Método} handle ()

Procesa la petición HTTP. La implementación por defecto crea una instancia gestora usando una clase @ref{119,,wsgiref.handlers} para implementar la interfaz de aplicación WSGI real.
@end deffn
@end deffn

@node wsgiref validate — Verificador de compatibilidad WSGI,wsgiref handlers – Clases base servidor/gateway,wsgiref simple_server– Un servidor HTTP WSGI simple,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref validate}@anchor{11e}@anchor{library/wsgiref wsgiref-validate-wsgi-conformance-checker}@anchor{38a0}
@subsubsection @code{wsgiref.validate} — Verificador de compatibilidad WSGI


@geindex module; wsgiref.validate

Al crear nuevos objetos aplicación WSGI, `frameworks', servidores, o `middleware', puede ser útil validar la compatibilidad del nuevo código usando @ref{11e,,wsgiref.validate}. Este módulo ofrece una función que crea objetos de aplicación WSGI que validan las comunicaciones entre un servidor o `gateway' WSGI y un objeto de aplicación WSGI, para comprobar la compatibilidad del protocolo en ambos lados.

Hay que observar que esta utilidad no garantiza compatibilidad completa con 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. La ausencia de errores usando este módulo no implica que no existan errores. Sin embargo, si este módulo produce errores, implica que o el servidor o la aplicación no son 100% compatibles.

Este módulo se basa en el módulo @code{paste.lint} de la librería `Python Paste' de `Ian Bicking'.

@geindex validator() (en el módulo wsgiref.validate)
@anchor{library/wsgiref wsgiref validate validator}@anchor{38a1}
@deffn {Función} wsgiref.validate.validator (application)

Envuelve `application' y retorna un nuevo objeto de aplicación WSGI. La aplicación retornada reenviará todas las peticiones a la `application' original y comprobará que tanto la `application' como el servidor que la llama son compatibles con la especificación WSGI y con 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}.

Cualquier incompatibilidad detectada provocará el lanzamiento de un @ref{74a,,AssertionError}. Nótese que, sin embargo, cómo se gestionan estos errores depende del servidor. Por ejemplo, @ref{11b,,wsgiref.simple_server} y otros servidores basados en @ref{119,,wsgiref.handlers}, que no sobreescriben los métodos de gestión de errores para hacer otras cosas, simplemente escribirán un mensaje de que el error ha ocurrido y volcarán la traza de error en @code{sys.stderr} o algún otro flujo de errores.

Este `wrapper' puede también generar salidas usando el módulo @ref{112,,warnings} para señalar comportamientos que son cuestionables pero que no están realmente prohibidos por 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. A no ser que se suprima esta salida usando opciones de línea de comandos de Python o la API de @ref{112,,warnings}, cualquier aviso se escribirá en @code{sys.stderr}, en lugar de en @code{wsgi.errors}, aunque sean el mismo objeto.

Ejemplo de uso:

@example
from wsgiref.validate import validator
from wsgiref.simple_server import make_server

# Our callable object which is intentionally not compliant to the
# standard, so the validator is going to break
def simple_app(environ, start_response):
    status = '200 OK'  # HTTP Status
    headers = [('Content-type', 'text/plain')]  # HTTP Headers
    start_response(status, headers)

    # This is going to break because we need to return a list, and
    # the validator is going to inform us
    return b"Hello World"

# This is the application wrapped in a validator
validator_app = validator(simple_app)

with make_server('@w{'}, 8000, validator_app) as httpd:
    print("Listening on port 8000....")
    httpd.serve_forever()
@end example
@end deffn

@node wsgiref handlers – Clases base servidor/gateway,wsgiref types — Tipos de WSGI para validadores estáticos de tipos,wsgiref validate — Verificador de compatibilidad WSGI,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref handlers}@anchor{119}@anchor{library/wsgiref wsgiref-handlers-server-gateway-base-classes}@anchor{38a2}
@subsubsection @code{wsgiref.handlers} – Clases base servidor/`gateway'


@geindex module; wsgiref.handlers

Este módulo ofrece clases gestoras base para implementar servidores y `gateways' WSGI. Estas clases base gestionan la mayoría del trabajo de comunicarse con una aplicación WSGI, siempre que se les dé un entorno CGI, junto con una entrada, una salida, y un flujo de errores.

@geindex CGIHandler (clase en wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers CGIHandler}@anchor{38a3}
@deffn {Clase} wsgiref.handlers.CGIHandler

Invocación basada en CGI vía @code{sys.stdin}, @code{sys.stdout}, @code{sys.stderr} y @code{os.environ}. Esto es útil cuando se quiere ejecutar una aplicación WSGI como un script CGI. Simplemente es necesario invocar @code{CGIHandler().run(app)}, donde @code{app} es el objeto de aplicación WSGI que se quiere invocar.

Esta clase es una subclase de @ref{38a4,,BaseCGIHandler} que establece @code{wsgi.run_once} a cierto, @code{wsgi.multithread} a falso, y @code{wsgi.multiprocess} a cierto, y siempre usa @ref{d9,,sys} y @ref{a1,,os} para obtener los flujos y entorno CGI necesarios.
@end deffn

@geindex IISCGIHandler (clase en wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers IISCGIHandler}@anchor{38a5}
@deffn {Clase} wsgiref.handlers.IISCGIHandler

Una alternativa especializada a @ref{38a3,,CGIHandler}, para usar al desplegar en servidores web Microsoft IIS, sin establecer la opción de configuración @code{allowPathInfo} (IIS>=7) o la meta-base @code{allowPathInfoForScriptMappings} (IIS<7).

Por defecto, IIS entrega @code{PATH_INFO} que duplica @code{SCRIPT_NAME} al principio, causando problemas con aplicaciones WSGI que implementan enrutamiento. Este gestor elimina las partes duplicadas de la ruta.

IIS se puede configurar para pasar el @code{PATH_INFO} correcto, pero esto causa otro error donde @code{PATH_TRANSLATED} es incorrecto. Afortunadamente, esta variable rara vez se usa y no está garantizada por WSGI. Sin embargo, en IIS<7, la configuración solo se puede realizar en un nivel de vhost, lo que afecta a todas las demás asignaciones de scripts, muchas de las cuales se rompen cuando se exponen al error @code{PATH_TRANSLATED}. Por esta razón, IIS<7 casi nunca se implementa con la solución (incluso IIS7 rara vez lo usa porque todavía no tiene una interfaz de usuario).

No hay forma de que el código CGI detecte cuándo la opción está activada, por lo que se ofrece una clase gestora separada. Se usa de la misma forma que @ref{38a3,,CGIHandler}, p.e. llamando a @code{IISCGIHandler().run(app)}, donde @code{app} es el objeto aplicación WSGI que se desea invocar.


Added in version 3.2.

@end deffn

@geindex BaseCGIHandler (clase en wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers BaseCGIHandler}@anchor{38a4}
@deffn {Clase} wsgiref.handlers.BaseCGIHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

Similar a @ref{38a3,,CGIHandler}, pero en lugar de usar los módulos @ref{d9,,sys} y @ref{a1,,os}, el entorno CGI y los flujos de E/S se especifican explícitamente. Los valores `multithread' y `multiprocess' se pasan a las aplicaciones ejecutadas por la instancia de gestión como @code{wsgi.multithread} y @code{wsgi.multiprocess}.

Esta clase es una subclase de @ref{38a6,,SimpleHandler} para usarse con servidores HTTP que no reciben peticiones directas de Internet, `HTTP origin servers'. Al escribir una implementación de un protocolo de pasarela, como CGI, FastCGI, SCGI, etcétera, que use una cabecera @code{Status:} para enviar un estado HTTP, probablemente sea adecuado heredar de esta clase, en lugar de @ref{38a6,,SimpleHandler}.
@end deffn

@geindex SimpleHandler (clase en wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers SimpleHandler}@anchor{38a6}
@deffn {Clase} wsgiref.handlers.SimpleHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

Similar a @ref{38a4,,BaseCGIHandler} pero diseñada para usarse con servidores que reciban peticiones directamente de Internet, o `HTTP origin servers'. Al escribir una implementación de un servidor HTTP, probablemente prefiera heredar de esta clase en lugar de @ref{38a4,,BaseCGIHandler}.

This class is a subclass of @ref{19f9,,BaseHandler}.  It overrides the
@code{__init__()}, @ref{38a7,,get_stdin()},
@ref{38a8,,get_stderr()}, @ref{38a9,,add_cgi_vars()},
@ref{38aa,,_write()}, and @ref{38ab,,_flush()} methods to
support explicitly setting the
environment and streams via the constructor.  The supplied environment and
streams are stored in the @code{stdin}, @code{stdout}, @code{stderr}, and
@code{environ} attributes.

El método @ref{d62,,write()} de `stdout' podría escribir cada fragmento de información completamente, como @ref{735,,io.BufferedIOBase}.
@end deffn

@geindex BaseHandler (clase en wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers BaseHandler}@anchor{19f9}
@deffn {Clase} wsgiref.handlers.BaseHandler

Esta es una clase base abstracta para ejecutar aplicaciones WSGI. Cada instancia gestionará una sola petición HTTP, aunque en principio se podría crear una subclase reutilizable para múltiples peticiones.

Las instancias de @ref{19f9,,BaseHandler} tiene un sólo método para uso externo:

@geindex run() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler run}@anchor{38ac}
@deffn {Método} run (app)

Ejecuta la aplicación WSGI `app' indicada.
@end deffn

Todos los otros métodos de @ref{19f9,,BaseHandler} se invocan por este método en el proceso de ejecutar la aplicación, es decir, existen principalmente para permitir personalizar el proceso.

Los métodos siguientes DEBEN sobrescribirse en una subclase:

@geindex _write() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler _write}@anchor{38aa}
@deffn {Método} _write (data)

Enviar los bytes `data' para la transmisión al cliente. Es correcto que este método realmente transmita la información. La clase @ref{19f9,,BaseHandler} simplemente separa las operaciones de escritura y liberación para una mayor eficiencia cuando el sistema subyacente realmente hace esa distinción.
@end deffn

@geindex _flush() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler _flush}@anchor{38ab}
@deffn {Método} _flush ()

Forzar la transmisión de los datos en el búfer al cliente. Es correcto si este método no es operativo, p.e., si @ref{38aa,,_write()} realmente envía los datos.
@end deffn

@geindex get_stdin() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stdin}@anchor{38a7}
@deffn {Método} get_stdin ()

Retorna un objeto compatible con @ref{38ad,,InputStream}, apropiado para usar como @code{wsgi.input} de la petición en proceso actualmente.
@end deffn

@geindex get_stderr() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stderr}@anchor{38a8}
@deffn {Método} get_stderr ()

Retorna un objeto compatible con @ref{38ae,,ErrorStream}, apropiado para usar como @code{wsgi.errors} de la petición en proceso actualmente.
@end deffn

@geindex add_cgi_vars() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler add_cgi_vars}@anchor{38a9}
@deffn {Método} add_cgi_vars ()

Inserta las variables CGI para la petición actual en el atributo @code{environ}.
@end deffn

A continuación se describen algunos métodos y atributos más que podría ser interesante sobrescribir. Esta lista es sólo un sumario, sin embargo, y no incluye cada método que puede ser sobrescrito. Conviene consultar las docstrings y el código fuente para obtener información adicional antes de intentar crear una subclase de @ref{19f9,,BaseHandler} personalizada.

Atributos y métodos para personalizar el entorno WSGI:

@geindex wsgi_multithread (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multithread}@anchor{38af}
@deffn {Atributo} wsgi_multithread

El valor a usar en la variable de entorno @code{wsgi.multithread}. Por defecto es cierto en @ref{19f9,,BaseHandler}, pero puede tener un valor por defecto distinto (o establecerse en el constructor) en otras subclases.
@end deffn

@geindex wsgi_multiprocess (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multiprocess}@anchor{38b0}
@deffn {Atributo} wsgi_multiprocess

El valor a usar en la variable de entorno @code{wsgi.multiprocess}. Por defecto es cierto en @ref{19f9,,BaseHandler}, pero puede tener un valor por defecto distinto (o establecerse en el constructor) en otras subclases.
@end deffn

@geindex wsgi_run_once (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_run_once}@anchor{38b1}
@deffn {Atributo} wsgi_run_once

El valor a usar en la variable de entorno @code{wsgi.run_once}. Por defecto es falso en @ref{19f9,,BaseHandler}, pero en @ref{38a3,,CGIHandler} es cierto por defecto.
@end deffn

@geindex os_environ (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler os_environ}@anchor{38b2}
@deffn {Atributo} os_environ

Las variables de entorno por defecto que se incluirán en el entorno WSGI de cada petición. Por defecto, es una copia de @code{os.environ} cuando se importa @ref{119,,wsgiref.handlers}, pero otras subclases pueden crear las suyas propias a nivel de clase o de instancia. Se debe tener en cuenta que el diccionario se debe considerar como de sólo lectura, ya que el valor por defecto se comparte entre múltiples clases e instancias.
@end deffn

@geindex server_software (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler server_software}@anchor{38b3}
@deffn {Atributo} server_software

Si el atributo @ref{38b4,,origin_server} tiene valor, éste se usa para establecer el valor por defecto de la variable de entorno WSGI @code{SERVER_SOFTWARE} y un cabecera @code{Server:} por defecto en las respuestas HTTP. Las clases gestoras que no son `HTTP origin servers', como @ref{38a4,,BaseCGIHandler} y @ref{38a3,,CGIHandler}, ignoran este atributo.


Distinto en la versión 3.3: El término «Python» se reemplaza con el término específico correspondiente a la implementación del intérprete, como «CPython», «Jython», etc.

@end deffn

@geindex get_scheme() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_scheme}@anchor{38b5}
@deffn {Método} get_scheme ()

Retorna el esquema usado en la URL para la petición actual. La implementación por defecto utiliza la función @code{guess_scheme()} de @ref{11d,,wsgiref.util} para adivinar si el esquema debería ser «http» o «https», basándose en las variables de @code{environ} de la petición actual.
@end deffn

@geindex setup_environ() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler setup_environ}@anchor{38b6}
@deffn {Método} setup_environ ()

Establece el atributo @code{environ} a un entorno WSGI completo. La implementación por defecto utiliza todos los métodos y atributos anteriormente mencionados, más los métodos @ref{38a7,,get_stdin()}, @ref{38a8,,get_stderr()} y @ref{38a9,,add_cgi_vars()}, y el atributo @ref{38b7,,wsgi_file_wrapper}. También incluye una clave @code{SERVER_SOFTWARE} si no existe, siempre y cuando el atributo @ref{38b4,,origin_server} tiene un valor válido y el atributo @ref{38b3,,server_software} está establecido.
@end deffn

Métodos y atributos para personalizar el manejo de excepciones:

@geindex log_exception() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler log_exception}@anchor{38b8}
@deffn {Método} log_exception (exc_info)

Envía la tupla `exc_info' al registro del servidor. `exc_info' es un tupla @code{(type, value, traceback)}. La implementación por defecto simplemente escribe el seguimiento de la pila en el flujo @code{wsgi.errors} de la petición y lo vacía. Las subclases pueden sobrescribir éste método para cambiar el formato o redirigir la salida, enviar mensajes de correo con el seguimiento de pila a un administrador o cualquier otra acción que se considere adecuada.
@end deffn

@geindex traceback_limit (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler traceback_limit}@anchor{38b9}
@deffn {Atributo} traceback_limit

El máximo número de marcos a incluir en la salida de seguimientos de pilas por el método por defecto @ref{38b8,,log_exception()}. Si vale @code{None}, se incluyen todos los marcos.
@end deffn

@geindex error_output() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_output}@anchor{38ba}
@deffn {Método} error_output (environ, start_response)

Este método es una aplicación WSGI para generar una página de error para el usuario. Sólo se invoca si un error ocurre antes de enviar las cabeceras al cliente.

Este método puede acceder al error actual usando @code{sys.exception()}, y debería pasar esa información a `start_response' cuando la llame (tal y como se describe en la sección «Error Handling» de 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}).

La implementación por defecto sólo utiliza los atributos @ref{38bb,,error_status}, @ref{38bc,,error_headers} y @ref{38bd,,error_body} para generar una página de salida. Las subclases pueden sobrescribir éste para producir una salida de error dinámica mejor.

Hay que tener en cuenta, sin embargo, que no se recomienda, desde una perspectiva de seguridad, mostrar información de diagnóstico a cualquier usuario antiguo. Idealmente, se debería hacer algo especial para activar la salida de información de diagnóstico, motivo por el que la implementación por defecto no incluye ninguna.
@end deffn

@geindex error_status (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_status}@anchor{38bb}
@deffn {Atributo} error_status

El estado HTTP utilizado para las respuestas de error. Se debería utilizar una de las cadenas de estado definidas en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Por defecto es un código 500 y un mensaje.
@end deffn

@geindex error_headers (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_headers}@anchor{38bc}
@deffn {Atributo} error_headers

Las cabeceras HTTP utilizadas por las respuestas de error. Debería tratarse de una lista de cabeceras de respuesta WSGI (tuplas @code{(name, value)}), tal y como se describe en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. La lista por defecto simplemente establece el tipo de contenido a @code{text/plain}.
@end deffn

@geindex error_body (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_body}@anchor{38bd}
@deffn {Atributo} error_body

El cuerpo de la respuesta de error. Debería ser una cadena de bytes con el cuerpo de la respuesta HTTP. Por defecto contiene el texto plano `A server error occurred. Please contact the administrator.'
@end deffn

Métodos y atributos para la funcionalidad «Optional Platform-Specific File Handling» de 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}:

@geindex wsgi_file_wrapper (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_file_wrapper}@anchor{38b7}
@deffn {Atributo} wsgi_file_wrapper

Una fábrica @code{wsgi.file_wrapper} compatible con @ref{3891,,wsgiref.types.FileWrapper}, o @code{None}. El valor por defecto de este atributo es la clase @ref{7d2,,wsgiref.util.FileWrapper}.
@end deffn

@geindex sendfile() (método de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler sendfile}@anchor{38be}
@deffn {Método} sendfile ()

Sobrescribir para implementar la transmisión de ficheros específica para la plataforma. Este método se llama sólo si el valor de retorno de la aplicación es una instancia de la clase especificada por el atributo @ref{38b7,,wsgi_file_wrapper}. Debería retornar un valor cierto si fue capaz de transmitir correctamente el fichero, de modo que el código por defecto de transmisión no será ejecutado. La implementación por defecto de este método simplemente retorna un valor falso.
@end deffn

Métodos y atributos varios:

@geindex origin_server (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler origin_server}@anchor{38b4}
@deffn {Atributo} origin_server

Este atributo debería establecerse a cierto si los métodos @ref{38aa,,_write()} y @ref{38ab,,_flush()} están siendo usados para comunicar directamente al cliente, en lugar de usar un protocolo de pasarela CGI que requiere el estado HTTP en una cabecera @code{Status:} especial.

El valor por defecto de este atributo es cierto en @ref{19f9,,BaseHandler}, pero en @ref{38a4,,BaseCGIHandler} y @ref{38a3,,CGIHandler} es falso.
@end deffn

@geindex http_version (atributo de wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler http_version}@anchor{38bf}
@deffn {Atributo} http_version

Si @ref{38b4,,origin_server} es cierto, este atributo de tipo cadena se usa para establecer la versión HTTP de la respuesta enviada al cliente. Por defecto es @code{"1.0"}.
@end deffn
@end deffn

@geindex read_environ() (en el módulo wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers read_environ}@anchor{1227}
@deffn {Función} wsgiref.handlers.read_environ ()

Transcodifica las variables CGI de @code{os.environ} a cadenas «bytes in unicode» definidas en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}, retornando un nuevo diccionario. Esta función se usa en @ref{38a3,,CGIHandler} y @ref{38a5,,IISCGIHandler} en lugar de usar directamente @code{os.environ}, lo que no es necesariamente compatible con EWGI en todas las plataformas y servidores web usando Python 3 – específicamente, aquellas en las que el entorno actual del sistema operativo es Unicode, p.e. Windows, o en las que el entorno está en bytes, pero la codificación del sistema usada por Python para descodificar lo es cualquier otro que ISO-8859-1, por ejemplo, sistemas UNIX que usen UTF-8.

Cuando se está implementando un gestor basado en CGI propio, probablemente se requiera usar esta rutina en lugar de sólo copiar directamente los valores de @code{os.environ}.


Added in version 3.2.

@end deffn

@node wsgiref types — Tipos de WSGI para validadores estáticos de tipos,Ejemplos<23>,wsgiref handlers – Clases base servidor/gateway,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref module-wsgiref types}@anchor{11c}@anchor{library/wsgiref wsgiref-types-wsgi-types-for-static-type-checking}@anchor{38c0}
@subsubsection @code{wsgiref.types} — Tipos de WSGI para validadores estáticos de tipos


@geindex module; wsgiref.types

Este módulo provee varios tipos para validadores estáticos de tipos, como se describe en 
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.


Added in version 3.11.


@geindex StartResponse (clase en wsgiref.types)
@anchor{library/wsgiref wsgiref types StartResponse}@anchor{38c1}
@deffn {Clase} wsgiref.types.StartResponse

A @ref{3bb,,typing.Protocol} describing 
@geindex Python Enhancement Proposals; PEP 3333#the-start-response-callable
start_response()@footnote{https://peps.python.org/pep-3333/#the-start-response-callable}
callables (
@geindex Python Enhancement Proposals; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}).
@end deffn

@geindex WSGIEnvironment (en el módulo wsgiref.types)
@anchor{library/wsgiref wsgiref types WSGIEnvironment}@anchor{388b}
@deffn {Dato} wsgiref.types.WSGIEnvironment

Un alias de tipo que describe un diccionario de entorno WSGI.
@end deffn

@geindex WSGIApplication (en el módulo wsgiref.types)
@anchor{library/wsgiref wsgiref types WSGIApplication}@anchor{38c2}
@deffn {Dato} wsgiref.types.WSGIApplication

Un alias de tipo que describe una aplicación WSGI invocable.
@end deffn

@geindex InputStream (clase en wsgiref.types)
@anchor{library/wsgiref wsgiref types InputStream}@anchor{38ad}
@deffn {Clase} wsgiref.types.InputStream

A @ref{3bb,,typing.Protocol} describing a 
@geindex Python Enhancement Proposals; PEP 3333#input-and-error-streams
WSGI Input Stream@footnote{https://peps.python.org/pep-3333/#input-and-error-streams}.
@end deffn

@geindex ErrorStream (clase en wsgiref.types)
@anchor{library/wsgiref wsgiref types ErrorStream}@anchor{38ae}
@deffn {Clase} wsgiref.types.ErrorStream

A @ref{3bb,,typing.Protocol} describing a 
@geindex Python Enhancement Proposals; PEP 3333#input-and-error-streams
WSGI Error Stream@footnote{https://peps.python.org/pep-3333/#input-and-error-streams}.
@end deffn

@geindex FileWrapper (clase en wsgiref.types)
@anchor{library/wsgiref wsgiref types FileWrapper}@anchor{3891}
@deffn {Clase} wsgiref.types.FileWrapper

A @ref{3bb,,typing.Protocol} describing a 
@geindex Python Enhancement Proposals; PEP 3333#optional-platform-specific-file-handling
file wrapper@footnote{https://peps.python.org/pep-3333/#optional-platform-specific-file-handling}.
See @ref{7d2,,wsgiref.util.FileWrapper} for a concrete implementation of this
protocol.
@end deffn

@node Ejemplos<23>,,wsgiref types — Tipos de WSGI para validadores estáticos de tipos,wsgiref — WSGI Utilities and Reference Implementation
@anchor{library/wsgiref examples}@anchor{38c3}
@subsubsection Ejemplos


Ésta es una aplicación WSGI «Hello World» que funciona:

@example
"""
Every WSGI application must have an application object - a callable
object that accepts two arguments. For that purpose, we're going to
use a function (note that you're not limited to a function, you can
use a class for example). The first argument passed to the function
is a dictionary containing CGI-style environment variables and the
second variable is the callable object.
"""
from wsgiref.simple_server import make_server


def hello_world_app(environ, start_response):
    status = "200 OK"  # HTTP Status
    headers = [("Content-type", "text/plain; charset=utf-8")]  # HTTP Headers
    start_response(status, headers)

    # The returned object is going to be printed
    return [b"Hello World"]

with make_server("", 8000, hello_world_app) as httpd:
    print("Serving on port 8000...")

    # Serve until process is killed
    httpd.serve_forever()
@end example

Ejemplo de una aplicación WSGI que sirve el directorio actual, acepta un directorio opcional y un número de puerto (default: 8000) en la línea de comandos:

@example
"""
Small wsgiref based web server. Takes a path to serve from and an
optional port number (defaults to 8000), then tries to serve files.
MIME types are guessed from the file names, 404 errors are raised
if the file is not found.
"""
import mimetypes
import os
import sys
from wsgiref import simple_server, util


def app(environ, respond):
    # Get the file name and MIME type
    fn = os.path.join(path, environ["PATH_INFO"][1:])
    if "." not in fn.split(os.path.sep)[-1]:
        fn = os.path.join(fn, "index.html")
    mime_type = mimetypes.guess_file_type(fn)[0]

    # Return 200 OK if file exists, otherwise 404 Not Found
    if os.path.exists(fn):
        respond("200 OK", [("Content-Type", mime_type)])
        return util.FileWrapper(open(fn, "rb"))
    else:
        respond("404 Not Found", [("Content-Type", "text/plain")])
        return [b"not found"]


if __name__ == "__main__":
    # Get the path and port from command-line arguments
    path = sys.argv[1] if len(sys.argv) > 1 else os.getcwd()
    port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000

    # Make and start the server until control-c
    httpd = simple_server.make_server("", port, app)
    print(f"Serving @{path@} on port @{port@}, control-C to stop")
    try:
        httpd.serve_forever()
    except KeyboardInterrupt:
        print("Shutting down.")
        httpd.server_close()
@end example

@node urllib — URL handling modules,urllib request — Extensible library for opening URLs,wsgiref — WSGI Utilities and Reference Implementation,Protocolos y soporte de Internet
@anchor{library/urllib doc}@anchor{38c4}@anchor{library/urllib module-urllib}@anchor{108}@anchor{library/urllib urllib-url-handling-modules}@anchor{38c5}
@subsection @code{urllib} — URL handling modules


@geindex module; urllib

`Código fuente:' Lib/urllib/@footnote{https://github.com/python/cpython/tree/main/Lib/urllib/}


__________________________________________________________________


@code{urllib} es un paquete que reúne varios módulos para trabajar con URLs:


@itemize *

@item 
@ref{10b,,urllib.request} para abrir y leer URLs

@item 
@ref{109,,urllib.error} contiene las excepciones propuestas por @ref{10b,,urllib.request}

@item 
@ref{10a,,urllib.parse} para parsear URLs

@item 
@ref{10d,,urllib.robotparser} para parsear archivos @code{robots.txt}
@end itemize

@node urllib request — Extensible library for opening URLs,urllib response — Clases de respuesta usadas por urllib,urllib — URL handling modules,Protocolos y soporte de Internet
@anchor{library/urllib request doc}@anchor{38c6}@anchor{library/urllib request module-urllib request}@anchor{10b}@anchor{library/urllib request urllib-request-extensible-library-for-opening-urls}@anchor{38c7}
@subsection @code{urllib.request} — Extensible library for opening URLs


@geindex module; urllib.request

`Código fuente:' Lib/urllib/request.py@footnote{https://github.com/python/cpython/tree/main/Lib/urllib/request.py}


__________________________________________________________________


El módulo @ref{10b,,urllib.request} define funciones y clases que ayudan en la apertura de URLs (la mayoría HTTP) en un mundo complejo — autenticación básica y digest, redirecciones, cookies y más.


@subsubheading Ver también


Se recomienda el paquete Requests@footnote{https://requests.readthedocs.io/en/master/} para una interfaz de cliente HTTP de mayor nivel.


@cartouche
@quotation Advertencia 
On macOS it is unsafe to use this module in programs using
@ref{2ff,,os.fork()} because the @ref{38c8,,getproxies()} implementation for
macOS uses a higher-level system API. Set the environment variable
@code{no_proxy} to @code{*} to avoid this problem
(e.g. @code{os.environ["no_proxy"] = "*"}).
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo @ref{10b,,urllib.request} define las siguientes funciones:

@geindex urlopen() (en el módulo urllib.request)
@anchor{library/urllib request urllib request urlopen}@anchor{20a}
@deffn {Función} urllib.request.urlopen (url, data=None[, timeout], *, context=None)

Abre la `url', la cual puede ser una cadena de texto que contenga una URL válida y correctamente codificada, o un objeto @ref{1057,,Request}.

`data' debe ser un objeto que especifique datos adicionales a ser enviados al servidor o @code{None} si no se necesitan tales datos. Vea @ref{1057,,Request} para más detalles.

El módulo urllib.request usa HTTP/1.1 e incluye el encabezado @code{Connection:close} en sus peticiones HTTP.

El parámetro opcional `timeout' especifica un tiempo de expiración en segundos para operaciones bloqueantes como el intento de conexión (si no se especifica, será usado el tiempo de expiración global predeterminado). Esto actualmente sólo funciona para conexiones HTTP, HTTPS y FTP.

Si se especifica `context', debe ser una instancia @ref{1fa,,ssl.SSLContext} describiendo las diferentes opciones SSL. Vea @ref{bc9,,HTTPSConnection} para más detalles.

Esta función siempre retorna un objeto que puede actuar como un @ref{675,,gestor de contexto}, y tiene las propiedades `url', `headers' y `status'. Véase @ref{38c9,,urllib.response.addinfourl} para más detalles sobre estas propiedades.

Para URLs HTTP y HTTPS, esta función retorna un objeto @ref{1142,,http.client.HTTPResponse} ligeramente modificado. Adicionalmente a los tres nuevos métodos anteriores, el atributo msg contiene la misma información que el atributo @ref{38ca,,reason} — la frase de motivo devuelta por el servidor — en lugar de los encabezados de la respuesta como se especifica en la documentación para @ref{1142,,HTTPResponse}.

Para URLs FTP, de archivo y de datos y para peticiones manejadas explícitamente por las clases heredadas @ref{208,,URLopener} y @ref{209,,FancyURLopener}, esta función retorna un objeto @ref{38c9,,urllib.response.addinfourl}.

Genera @ref{38cb,,URLError} en errores de protocolo.

Tenga en cuenta que @code{None} puede ser retornado si ningún manejador gestiona la petición (aunque el @ref{38cc,,OpenerDirector} global instalado de manera predeterminada usa @ref{38cd,,UnknownHandler} para asegurar que esto nunca suceda).

In addition, if proxy settings are detected (for example, when a @code{*_proxy}
environment variable like @code{http_proxy} is set),
@ref{19d9,,ProxyHandler} is default installed and makes sure the requests are
handled through the proxy.

La función heredada de Python 2.6 y anteriores @code{urllib.urlopen} ha sido descontinuada, @ref{20a,,urllib.request.urlopen()} corresponde a la antigua @code{urllib2.urlopen}. La gestión de proxy, la cual se hacía pasando un parámetro diccionario a @code{urllib.urlopen}, puede ser obtenida usando objetos @ref{19d9,,ProxyHandler}.

El abridor predeterminado genera un @ref{18c3,,evento de auditoría} @code{urllib.Request} con los argumentos @code{fullurl}, @code{data}, @code{headers}, @code{method} tomados del objeto de la petición.


Distinto en la versión 3.2: `cafile' y `capath' fueron añadidos.

Los hosts virtuales HTTPS ahora están soportados si es posible (esto es, si @ref{33c1,,ssl.HAS_SNI} es verdadero).

`data' puede ser un objeto iterable.



Distinto en la versión 3.3: `cadefault' fue añadido.



Distinto en la versión 3.4.3: `context' fue añadido.



Distinto en la versión 3.10: HTTPS connection now send an ALPN extension with protocol indicator
@code{http/1.1} when no `context' is given. Custom `context' should set
ALPN protocols with @ref{ee4,,set_alpn_protocols()}.



Distinto en la versión 3.13: Remove `cafile', `capath' and `cadefault' parameters: use the `context'
parameter instead.

@end deffn

@geindex install_opener() (en el módulo urllib.request)
@anchor{library/urllib request urllib request install_opener}@anchor{38ce}
@deffn {Función} urllib.request.install_opener (opener)

Instala una instancia @ref{38cc,,OpenerDirector} como el abridor global predeterminado. Instalar un abridor sólo es necesario si quieres que urlopen use ese abridor; si no, simplemente invoca @ref{105b,,OpenerDirector.open()} en lugar de @ref{20a,,urlopen()}. El código no comprueba por un @ref{38cc,,OpenerDirector} real y cualquier clase con la interfaz apropiada funcionará.
@end deffn

@geindex build_opener() (en el módulo urllib.request)
@anchor{library/urllib request urllib request build_opener}@anchor{38cf}
@deffn {Función} urllib.request.build_opener ([handler, ...])

Retorna una instancia @ref{38cc,,OpenerDirector}, la cual encadena los manejadores en el orden dado. `handler's pueden ser tanto instancias de @ref{38d0,,BaseHandler} o subclases de @ref{38d0,,BaseHandler} (en cuyo caso debe ser posible invocar el constructor sin ningún parámetro). Instancias de las siguientes clases estarán delante del `handler's, a no ser que el `handler's las contenga, instancias o subclases de ellas: @ref{19d9,,ProxyHandler} (si son detectadas configuraciones de proxy), @ref{38cd,,UnknownHandler}, @ref{38d1,,HTTPHandler}, @ref{38d2,,HTTPDefaultErrorHandler}, @ref{38d3,,HTTPRedirectHandler}, @ref{38d4,,FTPHandler}, @ref{38d5,,FileHandler}, @ref{38d6,,HTTPErrorProcessor}.

Si la instalación de Python tiene soporte SSL (ej. si se puede importar el módulo @ref{d0,,ssl}), también será añadida @ref{1290,,HTTPSHandler}.

Una subclase de @ref{38d0,,BaseHandler} puede cambiar también su atributo @code{handler_order} para modificar su posición en la lista de manejadores.
@end deffn

@geindex pathname2url() (en el módulo urllib.request)
@anchor{library/urllib request urllib request pathname2url}@anchor{1597}
@deffn {Función} urllib.request.pathname2url (path)

Convierte el nombre de ruta `path' desde la sintaxis local para una ruta a la forma usada en el componente ruta de una URL. Esto no produce una URL completa. El valor retornado ya estará entrecomillado usando la función @ref{c2b,,quote()}.
@end deffn

@geindex url2pathname() (en el módulo urllib.request)
@anchor{library/urllib request urllib request url2pathname}@anchor{1595}
@deffn {Función} urllib.request.url2pathname (path)

Convierte el componente ruta `path' desde una URL codificada con porcentajes a la sintaxis local para una ruta. No acepta una URL completa. Esta función usa @ref{178e,,unquote()} para decodificar `path'.
@end deffn

@geindex getproxies() (en el módulo urllib.request)
@anchor{library/urllib request urllib request getproxies}@anchor{38c8}
@deffn {Función} urllib.request.getproxies ()

Esta función auxiliar retorna un diccionario de esquema para las asignaciones de URL del servidor proxy. Escanea el entorno en busca de variables denominadas @code{<scheme>_proxy}, tomando en cuenta diferencia entre mayúsculas y minúsculas, para todos los sistemas operativos primero, y cuando no pueden encontrarla, buscan información proxy desde la Configuración del Sistema de macOS y desde Registros del Sistema para Windows. Si existen variables de entorno tanto en mayúsculas como en minúsculas (y no concuerdan), las minúsculas son preferidas.

@cartouche
@quotation Nota 
Si la variable del entorno @code{REQUEST_METHOD} está definida, lo cual usualmente indica que tu script está ejecutándose en un entorno CGI, la variable de entorno @code{HTTP_PROXY} (mayúsculas @code{_PROXY}) será ignorada. Esto es porque esa variable puede ser inyectada por un cliente usando el encabezado HTTP «Proxy:». Si necesitas usar un proxy HTTP en un entorno CGI, usa @code{ProxyHandler} explícitamente o asegúrate de que el nombre de la variable está en minúsculas (o al menos el sufijo @code{_proxy}).
@end quotation
@end cartouche
@end deffn

Se proveen las siguientes clases:

@geindex Request (clase en urllib.request)
@anchor{library/urllib request urllib request Request}@anchor{1057}
@deffn {Clase} urllib.request.Request (url, data=None, headers=@{@}, origin_req_host=None, unverifiable=False, method=None)

Esta clase es un abstracción de una petición URL.

`url' debe ser una cadena de texto que contenga una URL válida y correctamente codificada.

`data' debe ser un objeto que especifique datos adicionales a enviar al servidor o @code{None} si no se necesitan tales datos. Actualmente las peticiones HTTP son las únicas que usan `data'. Los tipos de objetos soportados incluyen bytes, objetos como archivos e iterables de objetos como bytes. Si no se ha provisto el campo de encabezado @code{Content-Length} ni @code{Transfer-Encoding}, @ref{38d1,,HTTPHandler} establecerá estos encabezados de acuerdo al tipo de `data'. @code{Content-Length} será usado para enviar objetos de bytes, mientras @code{Transfer-Encoding: chunked} como se especifica en 
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html}, Sección 3.3.1 será usado para enviar archivos y otros iterables.

Para un método de una petición HTTP POST, `data' debe ser un buffer en el formato estándar @code{application/x-www-form-urlencoded}. La función @ref{f16,,urllib.parse.urlencode()} toma un mapeo o una secuencia de tuplas de dos valores y retorna una cadena de caracteres ASCII en este formato. Debe ser codificada a bytes antes de ser usada como el parámetro `data'.

`headers' debe ser un diccionario, y será tratado como si @ref{38d7,,add_header()} fuera invocado con cada clave y valor como argumentos. Esto es usado frecuentemente para «parodiar» el valor de encabezado @code{User-Agent}, el cual es usado por un navegador para identificarse a sí mismo – algunos servidores HTTP sólo permiten peticiones que vienen de navegadores comunes a diferencia de los scripts. Por ejemplo, Mozilla Firefox puede identificarse a sí mismo como @code{"Mozilla/5.0 (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"}, mientras el agente de usuario predeterminado de @ref{108,,urllib} es @code{"Python-urllib/2.6"} (en Python 2.6). Todas las claves de los encabezados se envían en camel case.

An appropriate @code{Content-Type} header should be included if the `data'
argument is present.  If this header has not been provided and `data'
is not @code{None}, @code{Content-Type: application/x-www-form-urlencoded} will
be added as a default.

Los siguientes dos argumentos sólo tienen interés para la gestión correcta de cookies HTTP de terceros:

`origin_req_host' debe ser el host de la petición de la transacción origen, como define 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. Por defecto es @code{http.cookiejar.request_host(self)}. Este es el nombre de host o la dirección IP de la petición original que fue iniciada por el usuario. Por ejemplo, si la petición es para una imagen en un documento HTML, debe ser el host de la petición para la página que contiene la imagen.

`unverifiable' debe indicar si la petición no es verificable, como define 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. Por defecto es @code{False}. Una petición no verificable es una cuya URL el usuario no tuvo opción de aprobar. Por ejemplo, si la petición es por una imagen en un documento HTML y el usuario no tuvo opción de aprobar la obtención automática de la imagen, este debe ser verdadero.

`method' should be a string that indicates the HTTP request method that
will be used (e.g. @code{'HEAD'}).  If provided, its value is stored in the
@ref{1058,,method} attribute and is used by @ref{11da,,get_method()}.
The default is @code{'GET'} if `data' is @code{None} or @code{'POST'} otherwise.
Subclasses may indicate a different default method by setting the
@ref{1058,,method} attribute in the class itself.

@cartouche
@quotation Nota 
La petición no funcionará como se espera si el objeto de datos es incapaz de entregar su contenido más de una vez (ej. un archivo o un iterable que puede producir el contenido sólo una vez) y la petición se reintentará para redirecciones HTTP o autenticación. El `data' es enviado al servidor HTTP directamente después de los encabezados. No hay soporte para una expectativa de funcionamiento 100% continuo en la biblioteca.
@end quotation
@end cartouche


Distinto en la versión 3.3: El argumento @ref{1058,,Request.method} es añadido a la clase Request.



Distinto en la versión 3.4: El atributo predeterminado @ref{1058,,Request.method} puede ser indicado a nivel de clase.



Distinto en la versión 3.6: No se genera un error si el @code{Content-Length} no ha sido provisto y `data' no es @code{None} ni un objeto de bytes. En su lugar recurre a la codificación de transferencia fragmentada.

@end deffn

@geindex OpenerDirector (clase en urllib.request)
@anchor{library/urllib request urllib request OpenerDirector}@anchor{38cc}
@deffn {Clase} urllib.request.OpenerDirector

La clase @ref{38cc,,OpenerDirector} abre URLs mediante la encadenación conjunta de @ref{38d0,,BaseHandler}. Este maneja el encadenamiento de manejadores y la recuperación de errores.
@end deffn

@geindex BaseHandler (clase en urllib.request)
@anchor{library/urllib request urllib request BaseHandler}@anchor{38d0}
@deffn {Clase} urllib.request.BaseHandler

Esta es la clase base para todos los manejadores registrados — y manejan sólo las mecánicas simples del registro.
@end deffn

@geindex HTTPDefaultErrorHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPDefaultErrorHandler}@anchor{38d2}
@deffn {Clase} urllib.request.HTTPDefaultErrorHandler

Una clase la cual define un manejador predeterminado para los errores de respuesta HTTP; todas las respuestas son convertidas en excepciones @ref{105d,,HTTPError}.
@end deffn

@geindex HTTPRedirectHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPRedirectHandler}@anchor{38d3}
@deffn {Clase} urllib.request.HTTPRedirectHandler

Una clase para manejar redirecciones.
@end deffn

@geindex HTTPCookieProcessor (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPCookieProcessor}@anchor{38d8}
@deffn {Clase} urllib.request.HTTPCookieProcessor (cookiejar=None)

Una clase para manejar Cookies HTTP.
@end deffn

@geindex ProxyHandler (clase en urllib.request)
@anchor{library/urllib request urllib request ProxyHandler}@anchor{19d9}
@deffn {Clase} urllib.request.ProxyHandler (proxies=None)

Causa que las peticiones vayan a través de un proxy. Si se provee `proxies', debe ser un diccionario mapeando nombres de protocolos a URLs de proxies. Por defecto lee la lista de proxies de las variables de entorno @code{<protocol>_proxy}. Si no se establecen variables de entorno de proxy, entonces se obtienen las configuraciones de proxy en un entorno Windows desde la sección del registro de Configuraciones de Internet y en un entorno macOS se obtiene la información de proxy desde el Framework de Configuración del Sistema.

Para deshabilitar la detección automática de proxy pasa un diccionario vacío.

La variable de entorno 
@geindex no_proxy
@geindex variables de entorno; no_proxy
@code{no_proxy} puede ser usada para especificar hosts los cuales no deben ser alcanzados mediante proxy; si se establece, debe ser una lista separada por comas de sufijos de nombres de host, con @code{:port} añadidos opcionalmente, por ejemplo @code{cern.ch,ncsa.uiuc.edu,some.host:8080}.

@cartouche
@quotation Nota 
@code{HTTP_PROXY} será ignorado si se establece una variable @code{REQUEST_METHOD}; vea la documentación de @ref{38c8,,getproxies()}.
@end quotation
@end cartouche
@end deffn

@geindex HTTPPasswordMgr (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgr}@anchor{38d9}
@deffn {Clase} urllib.request.HTTPPasswordMgr

Mantiene una base de datos de mapeos @code{(realm, uri) -> (user, password)}.
@end deffn

@geindex HTTPPasswordMgrWithDefaultRealm (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithDefaultRealm}@anchor{38da}
@deffn {Clase} urllib.request.HTTPPasswordMgrWithDefaultRealm

Mantiene una base de datos de mapeos @code{(realm, uri) -> (user, password)}. Un reino de @code{None} se considera un reino caza todo, el cual es buscado si ningún otro reino encaja.
@end deffn

@geindex HTTPPasswordMgrWithPriorAuth (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth}@anchor{f15}
@deffn {Clase} urllib.request.HTTPPasswordMgrWithPriorAuth

Una variante de @ref{38da,,HTTPPasswordMgrWithDefaultRealm} que también tiene una base de datos de mapeos @code{uri -> is_authenticated}. Puede ser usada por un manejador BasicAuth para determinar cuando enviar credenciales de autenticación inmediatamente en lugar de esperar primero a una respuesta @code{401}.


Added in version 3.5.

@end deffn

@geindex AbstractBasicAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request AbstractBasicAuthHandler}@anchor{18c4}
@deffn {Clase} urllib.request.AbstractBasicAuthHandler (password_mgr=None)

Esta es una clase mixin que ayuda con la autenticación HTTP, tanto al host remoto y a un proxy. Si se proporciona `password_mgr', debe ser algo compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada. Si `passwd_mgr' proporciona también métodos @code{is_authenticated} y @code{update_authenticated} (vea @ref{38dc,,Objetos HTTPPasswordMgrWithPriorAuth}), entonces el manejador usará el @code{is_authenticated} resultado para una URI dada para determinar el envío o no de credenciales de autenticación con la petición. Si @code{is_authenticated} retorna @code{True} para la URI, las peticiones subsecuentes a la URI o cualquiera de las super URIs incluirán automáticamente los credenciales de autenticación.


Added in version 3.5: Añadido soporte @code{is_authenticated}.

@end deffn

@geindex HTTPBasicAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPBasicAuthHandler}@anchor{38dd}
@deffn {Clase} urllib.request.HTTPBasicAuthHandler (password_mgr=None)

Administra autenticación con el host remoto. Si se proporciona `password_mgr', debe ser compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada. HTTPBasicAuthHandler lanzará un @ref{360,,ValueError} cuando se presente con un esquema de Autenticación incorrecto.
@end deffn

@geindex ProxyBasicAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request ProxyBasicAuthHandler}@anchor{38de}
@deffn {Clase} urllib.request.ProxyBasicAuthHandler (password_mgr=None)

Administra autenticación con el proxy. Si se proporciona `password_mgr' debe ser compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada.
@end deffn

@geindex AbstractDigestAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request AbstractDigestAuthHandler}@anchor{198b}
@deffn {Clase} urllib.request.AbstractDigestAuthHandler (password_mgr=None)

Esto es una clase mixin que ayuda con la autenticación HTTP, tanto al host remoto como a un proxy. Si se proporciona `password_mgr' debe ser compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada.
@end deffn

@geindex HTTPDigestAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPDigestAuthHandler}@anchor{38df}
@deffn {Clase} urllib.request.HTTPDigestAuthHandler (password_mgr=None)

Maneja autenticación con el host remoto. Si se proporciona `password_mgr' debe ser compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada. Cuando se añaden tanto el Manejador de Autenticación Digest (`Digest Authentication Handler') como el Manejador de Autenticación Básico (`Basic Authentication Handler') la Autenticación Digest siempre se intenta primero. Si la Autenticación Digest retorna una respuesta 40x de nuevo, se envía al controlador de Autenticación Básica para Manejar. Este método Handler lanzará un @ref{360,,ValueError} cuando sea presentado con un esquema de autenticación diferente a Digest o Básico.


Distinto en la versión 3.3: Genera @ref{360,,ValueError} en Esquema de Autenticación no soportado.

@end deffn

@geindex ProxyDigestAuthHandler (clase en urllib.request)
@anchor{library/urllib request urllib request ProxyDigestAuthHandler}@anchor{38e0}
@deffn {Clase} urllib.request.ProxyDigestAuthHandler (password_mgr=None)

Administra autenticación con el proxy. Si se proporciona `password_mgr' debe ser compatible con @ref{38d9,,HTTPPasswordMgr}; refiera a la sección @ref{38db,,Objetos HTTPPasswordMgr} para información sobre la interfaz que debe ser soportada.
@end deffn

@geindex HTTPHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPHandler}@anchor{38d1}
@deffn {Clase} urllib.request.HTTPHandler

Una clase para gestionar apertura de URLs HTTP.
@end deffn

@geindex HTTPSHandler (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPSHandler}@anchor{1290}
@deffn {Clase} urllib.request.HTTPSHandler (debuglevel=0, context=None, check_hostname=None)

Una clase para gestionar apertura de URLs HTTPS. `context' y `check_hostname' tienen el mismo significado que en @ref{bc9,,http.client.HTTPSConnection}.


Distinto en la versión 3.2: `context' y `check_hostname' fueron añadidos.

@end deffn

@geindex FileHandler (clase en urllib.request)
@anchor{library/urllib request urllib request FileHandler}@anchor{38d5}
@deffn {Clase} urllib.request.FileHandler

Abre archivos locales.
@end deffn

@geindex DataHandler (clase en urllib.request)
@anchor{library/urllib request urllib request DataHandler}@anchor{1056}
@deffn {Clase} urllib.request.DataHandler

Abre URLs de datos.


Added in version 3.4.

@end deffn

@geindex FTPHandler (clase en urllib.request)
@anchor{library/urllib request urllib request FTPHandler}@anchor{38d4}
@deffn {Clase} urllib.request.FTPHandler

Abre URLs FTP.
@end deffn

@geindex CacheFTPHandler (clase en urllib.request)
@anchor{library/urllib request urllib request CacheFTPHandler}@anchor{172f}
@deffn {Clase} urllib.request.CacheFTPHandler

Abre URLs FTP, manteniendo una caché de conexiones FTP abiertas para minimizar retrasos.
@end deffn

@geindex UnknownHandler (clase en urllib.request)
@anchor{library/urllib request urllib request UnknownHandler}@anchor{38cd}
@deffn {Clase} urllib.request.UnknownHandler

Una clase caza todo para gestionar URLs desconocidas.
@end deffn

@geindex HTTPErrorProcessor (clase en urllib.request)
@anchor{library/urllib request urllib request HTTPErrorProcessor}@anchor{38d6}
@deffn {Clase} urllib.request.HTTPErrorProcessor

Procesa errores de respuestas HTTP.
@end deffn

@menu
* Objetos Request:: 
* Objetos OpenerDirector:: 
* Objetos BaseHandler:: 
* Objetos HTTPRedirectHandler:: 
* Objetos HTTPCookieProcessor:: 
* Objetos ProxyHandler:: 
* Objetos HTTPPasswordMgr:: 
* Objetos HTTPPasswordMgrWithPriorAuth:: 
* Objetos AbstractBasicAuthHandler:: 
* Objetos HTTPBasicAuthHandler:: 
* Objetos ProxyBasicAuthHandler:: 
* Objetos AbstractDigestAuthHandler:: 
* Objetos HTTPDigestAuthHandler:: 
* Objetos ProxyDigestAuthHandler:: 
* Objetos HTTPHandler:: 
* Objetos HTTPSHandler:: 
* Objetos FileHandler:: 
* Objetos DataHandler:: 
* Objetos FTPHandler:: 
* Objetos CacheFTPHandler:: 
* Objetos UnknownHandler:: 
* Objetos HTTPErrorProcessor:: 
* Ejemplos: Ejemplos<24>. 
* Interfaz heredada:: 
* Restricciones urllib.request: Restricciones urllib request. 

@end menu

@node Objetos Request,Objetos OpenerDirector,,urllib request — Extensible library for opening URLs
@anchor{library/urllib request id1}@anchor{38e1}@anchor{library/urllib request request-objects}@anchor{38e2}
@subsubsection Objetos Request


Los siguientes métodos describen la interfaz pública de @ref{1057,,Request} por lo que pueden ser sobrescritos en subclases. También define varios atributos públicos que pueden ser usado por clientes para inspeccionar la respuesta analizada.

@geindex full_url (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request full_url}@anchor{1059}
@deffn {Atributo} Request.full_url

La URL original pasada al constructor.


Distinto en la versión 3.4.


Request.full_url es una propiedad con setter, getter y deleter. Obtener @ref{1059,,full_url} retorna la petición URL original con el fragmento, si este estaba presente.
@end deffn

@geindex type (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request type}@anchor{38e3}
@deffn {Atributo} Request.type

El esquema de URI.
@end deffn

@geindex host (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request host}@anchor{38e4}
@deffn {Atributo} Request.host

La autoridad de URI, típicamente un host, pero también puede contener un puerto separado por un caracter de doble punto.
@end deffn

@geindex origin_req_host (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request origin_req_host}@anchor{38e5}
@deffn {Atributo} Request.origin_req_host

El host original de la petición, sin puerto.
@end deffn

@geindex selector (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request selector}@anchor{38e6}
@deffn {Atributo} Request.selector

La ruta de URI. Si @ref{1057,,Request} usa un proxy, entonces selector será la URL completa que se pasa al proxy.
@end deffn

@geindex data (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request data}@anchor{105a}
@deffn {Atributo} Request.data

El cuerpo de la entidad para la solicitud o @code{None} si no es especificado.


Distinto en la versión 3.4: Cambiar el valor de @ref{105a,,Request.data} elimina ahora el encabezado «Content-Length» si fue establecido o calculado previamente.

@end deffn

@geindex unverifiable (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request unverifiable}@anchor{38e7}
@deffn {Atributo} Request.unverifiable

booleano, indica si la petición no es verificable como se define por 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.
@end deffn

@geindex method (atributo de urllib.request.Request)
@anchor{library/urllib request urllib request Request method}@anchor{1058}
@deffn {Atributo} Request.method

El método de petición HTTP a usar. Por defecto su valor es @ref{716,,None}, lo que significa que @ref{11da,,get_method()} realizará su cálculo normal del método a usar. Su valor puede ser definido (sobrescribiendo así el cálculo predeterminado en @ref{11da,,get_method()}) tanto proporcionando un valor por defecto estableciéndolo a nivel de clase en una subclase de @ref{1057,,Request} o pasando un valor al constructor de @ref{1057,,Request} por medio del argumento `method'.


Added in version 3.3.



Distinto en la versión 3.4: Un valor predeterminado puede ser establecido ahora en subclases; previamente sólo podía ser definido mediante el argumento del constructor.

@end deffn

@geindex get_method() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request get_method}@anchor{11da}
@deffn {Método} Request.get_method ()

Retorna una cadena indicando el método de petición HTTP. Si @ref{1058,,Request.method} no es @code{None}, retorna su valor, de otra forma retorna @code{'GET'} si @ref{105a,,Request.data} es @code{None} o @code{'POST'} si no lo es. Esto sólo es significativo para peticiones HTTP.


Distinto en la versión 3.3: get_method ahora mira el valor de @ref{1058,,Request.method}.

@end deffn

@geindex add_header() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request add_header}@anchor{38d7}
@deffn {Método} Request.add_header (key, val)

Añade otro encabezado a la petición. Los encabezados actualmente son ignorados por todos los manejadores excepto los manejadores HTTP, donde son añadidos a la lista de encabezados enviados al servidor. Tenga en cuenta que no puede haber más de un encabezado con el mismo nombre y las invocaciones posteriores sobrescribirán las invocaciones previas en caso de que `key' colisione. Actualmente, esto no es una pérdida de funcionalidad HTTP, ya que todos los encabezados que tienen sentido cuando son usados más de una vez tienen una manera (específica de encabezado) de ganar la misma funcionalidad usando sólo un encabezado. Tenga en cuenta que los encabezados agregados con este método también se agregan a las solicitudes redirigidas.
@end deffn

@geindex add_unredirected_header() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request add_unredirected_header}@anchor{38e8}
@deffn {Método} Request.add_unredirected_header (key, header)

Añade un encabezado que no será añadido a una petición redireccionada.
@end deffn

@geindex has_header() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request has_header}@anchor{38e9}
@deffn {Método} Request.has_header (header)

Retorna si la instancia tiene el encabezado nombrado (comprueba tanto regular como no redirigido).
@end deffn

@geindex remove_header() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request remove_header}@anchor{105c}
@deffn {Método} Request.remove_header (header)

Elimina el encabezado nombrado de la instancia de la petición (desde encabezados regulares y no redireccionados).


Added in version 3.4.

@end deffn

@geindex get_full_url() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request get_full_url}@anchor{38ea}
@deffn {Método} Request.get_full_url ()

Retorna la URL dada en el constructor.


Distinto en la versión 3.4.


Retorna @ref{1059,,Request.full_url}
@end deffn

@geindex set_proxy() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request set_proxy}@anchor{38eb}
@deffn {Método} Request.set_proxy (host, type)

Prepara la petición conectando a un servidor proxy. Los `host' y `type' reemplazarán aquellos de la instancia y el selector de la instancia será la URL original dada en el constructor.
@end deffn

@geindex get_header() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request get_header}@anchor{38ec}
@deffn {Método} Request.get_header (header_name, default=None)

Retorna el valor del encabezado dado.
@end deffn

@geindex header_items() (método de urllib.request.Request)
@anchor{library/urllib request urllib request Request header_items}@anchor{38ed}
@deffn {Método} Request.header_items ()

Retorna una lista de tuplas (header_name, header_value) de los encabezados de la Petición.
@end deffn


Distinto en la versión 3.4: Los métodos de petición add_data, has_data, get_data, get_type, get_host, get_selector, get_origin_req_host y is_unverifiable que quedaron obsoletos desde 3.3 han sido eliminados.


@node Objetos OpenerDirector,Objetos BaseHandler,Objetos Request,urllib request — Extensible library for opening URLs
@anchor{library/urllib request opener-director-objects}@anchor{38ee}@anchor{library/urllib request openerdirector-objects}@anchor{38ef}
@subsubsection Objetos OpenerDirector


Las instancias de @ref{38cc,,OpenerDirector} tienen los siguientes métodos:

@geindex add_handler() (método de urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector add_handler}@anchor{38f0}
@deffn {Método} OpenerDirector.add_handler (handler)

`handler' debe ser una instancia de @ref{38d0,,BaseHandler}. Los siguientes métodos son buscados y añadidos a las cadenas posibles (tenga en cuenta que los errores HTTP son un caso espacial). Tenga en cuenta que, en los siguientes, `protocol' debe ser remplazado con el protocolo actual a manejar, por ejemplo @code{http_response()} sería el protocolo HTTP del manejador de respuesta. También `type' debe ser remplazado con el código HTTP actual, por ejemplo @code{http_error_404()} manejaría errores HTTP 404.


@itemize *

@item 
@code{<protocol>_open()} — signal that the handler knows how to open `protocol'
URLs.

Vea @ref{38f1,,BaseHandler.<protocol>_open()} para más información.

@item 
@code{http_error_<type>()} — signal that the handler knows how to handle HTTP
errors with HTTP error code `type'.

Vea @ref{38f2,,BaseHandler.http_error_<nnn>()} para más información.

@item 
@code{<protocol>_error()} — signal that the handler knows how to handle errors
from (non-@code{http}) `protocol'.

@item 
@code{<protocol>_request()} — signal that the handler knows how to pre-process
`protocol' requests.

Vea @ref{38f3,,BaseHandler.<protocol>_request()} para más información.

@item 
@code{<protocol>_response()} — signal that the handler knows how to
post-process `protocol' responses.

Vea @ref{38f4,,BaseHandler.<protocol>_response()} para más información.
@end itemize
@end deffn

@geindex open() (método de urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector open}@anchor{105b}
@deffn {Método} OpenerDirector.open (url, data=None[, timeout])

Abre la `url' dada (la cual puede ser un objeto de petición o una cadena de caracteres), pasando opcionalmente el `data' dado. Los argumentos, los valores de retorno y las excepciones generadas son las mismas que aquellas de @ref{20a,,urlopen()} (las cuales simplemente invocan el método @ref{1be,,open()} en el @ref{38cc,,OpenerDirector} instalado global). El parámetro opcional `timeout' especifica un tiempo de expiración en segundos para operaciones bloqueantes como el intento de conexión (si no se especifica, el tiempo de expiración global será usado). La característica de tiempo de expiración actualmente funciona sólo para conexiones HTTP, HTTPS y FTP.
@end deffn

@geindex error() (método de urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector error}@anchor{38f5}
@deffn {Método} OpenerDirector.error (proto, *args)

Handle an error of the given protocol.  This will call the registered error
handlers for the given protocol with the given arguments (which are protocol
specific).  The HTTP protocol is a special case which uses the HTTP response
code to determine the specific error handler; refer to the @code{http_error_<type>()}
methods of the handler classes.

Retorna si los valores y excepciones generadas son las mismas que aquellas de @ref{20a,,urlopen()}.
@end deffn

Los objetos OpenerDirector abren URLs en tres etapas:

El orden en el cual esos métodos son invocados dentro de cada etapa es determinado ordenando las instancias manejadoras.


@enumerate 

@item 
Every handler with a method named like @code{<protocol>_request()} has that
method called to pre-process the request.

@item 
Handlers with a method named like @code{<protocol>_open()} are called to handle
the request. This stage ends when a handler either returns a non-@ref{716,,None}
value (ie. a response), or raises an exception (usually
@ref{38cb,,URLError}).  Exceptions are allowed to propagate.

In fact, the above algorithm is first tried for methods named
@ref{38f6,,default_open()}.  If all such methods return @ref{716,,None}, the algorithm
is repeated for methods named like @code{<protocol>_open()}.  If all such methods
return @ref{716,,None}, the algorithm is repeated for methods named
@ref{38f7,,unknown_open()}.

Tenga en cuenta que la implementación de esos métodos puede involucrar invocaciones de los métodos @ref{105b,,open()} y @ref{38f5,,error()} de la instancia @ref{38cc,,OpenerDirector} padre.

@item 
Every handler with a method named like @code{<protocol>_response()} has that
method called to post-process the response.
@end enumerate

@node Objetos BaseHandler,Objetos HTTPRedirectHandler,Objetos OpenerDirector,urllib request — Extensible library for opening URLs
@anchor{library/urllib request base-handler-objects}@anchor{38f8}@anchor{library/urllib request basehandler-objects}@anchor{38f9}
@subsubsection Objetos BaseHandler


Los objetos @ref{38d0,,BaseHandler} proporcionan un par de métodos que son útiles directamente y otros que están destinados a ser utilizados por clases derivadas. Estos están pensados para uso directo:

@geindex add_parent() (método de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler add_parent}@anchor{38fa}
@deffn {Método} BaseHandler.add_parent (director)

Añade un director como padre.
@end deffn

@geindex close() (método de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler close}@anchor{38fb}
@deffn {Método} BaseHandler.close ()

Elimina cualquier padre.
@end deffn

El siguiente atributo y los siguientes métodos sólo deben ser usados por clases derivadas de @ref{38d0,,BaseHandler}.

@cartouche
@quotation Nota 
The convention has been adopted that subclasses defining
@code{<protocol>_request()} or @code{<protocol>_response()} methods are named
@code{*Processor}; all others are named @code{*Handler}.
@end quotation
@end cartouche

@geindex parent (atributo de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler parent}@anchor{38fc}
@deffn {Atributo} BaseHandler.parent

Un @ref{38cc,,OpenerDirector} válido, el cual puede ser utilizado para abrir usando un protocolo diferente, o para manejar errores.
@end deffn

@geindex default_open() (método de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler default_open}@anchor{38f6}
@deffn {Método} BaseHandler.default_open (req)

Este método no es definido en @ref{38d0,,BaseHandler}, pero las subclases deben definirlo si quieren cazar todas las URLs.

This method, if implemented, will be called by the parent
@ref{38cc,,OpenerDirector}.  It should return a file-like object as described in
the return value of the @ref{105b,,open()} method of @ref{38cc,,OpenerDirector}, or @code{None}.
It should raise @ref{38cb,,URLError}, unless a truly exceptional
thing happens (for example, @ref{16cb,,MemoryError} should not be mapped to
@ref{38cb,,URLError}).

Este método será invocado antes de cualquier método de apertura específico de protocolo.
@end deffn

@anchor{library/urllib request protocol-open}@anchor{38f1}
@deffn {Método} BaseHandler.<protocol>_open(req)

Este método no está definido en @ref{38d0,,BaseHandler}, pero las subclases deben definirlo si quieren manejar URLs con el protocolo dado.

This method, if defined, will be called by the parent @ref{38cc,,OpenerDirector}.
Return values should be the same as for  @ref{38f6,,default_open()}.
@end deffn

@geindex unknown_open() (método de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler unknown_open}@anchor{38f7}
@deffn {Método} BaseHandler.unknown_open (req)

Este método `no' está definido en @ref{38d0,,BaseHandler}, pero las subclases deben definirlo si quieren cazar todas las URLs sin manejador registrado para abrirlo.

Este método, si está implementado, será invocado por el @ref{38fc,,parent} de @ref{38cc,,OpenerDirector}. Los valores retornados deben ser los mismos que para @ref{38f6,,default_open()}.
@end deffn

@geindex http_error_default() (método de urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler http_error_default}@anchor{38fd}
@deffn {Método} BaseHandler.http_error_default (req, fp, code, msg, hdrs)

Este método `no' está definido en @ref{38d0,,BaseHandler}, pero las subclases deben sobreescribirlo si pretenden proporcionar una solución general para los errores HTTP que de otro modo no se manejarían. Sería invocado automáticamente por el @ref{38cc,,OpenerDirector} obteniendo el error y no debe ser invocado normalmente en otras circunstancias.

`req' será un objeto @ref{1057,,Request}, `fp' será un objeto como archivo con el cuerpo de error HTTP, `code' será el código de error de tres dígitos, `msg' será la explicación visible para el usuario del código y `hdrs' será un objeto de mapeo con los encabezados del error.

Los valores de retorno y las excepciones generadas deben ser los mismos que aquellos de @ref{20a,,urlopen()}.
@end deffn

@anchor{library/urllib request http-error-nnn}@anchor{38f2}
@deffn {Método} BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)

`nnn' debe ser un código de error HTTP de tres dígitos. Este método tampoco está definido en @ref{38d0,,BaseHandler}, pero será invocado, si existe, en una instancia de una subclase, cuando ocurra un error HTTP con código `nnn'.

Las subclases deben sobrescribir este método para manejar errores HTTP específicos.

Arguments, return values and exceptions raised should be the same as for
@ref{38fd,,http_error_default()}.
@end deffn

@anchor{library/urllib request protocol-request}@anchor{38f3}
@deffn {Método} BaseHandler.<protocol>_request(req)

Este método `no' está definido en @ref{38d0,,BaseHandler}, pero las subclases deben definirlo si pretenden preprocesar peticiones del protocolo dado.

Este método, si está definido, será invocado por el @ref{38cc,,OpenerDirector} padre. `req' será un objeto @ref{1057,,Request}. El valor retornado debe ser un objeto @ref{1057,,Request}.
@end deffn

@anchor{library/urllib request protocol-response}@anchor{38f4}
@deffn {Método} BaseHandler.<protocol>_response(req, response)

Este método `no' está definido en @ref{38d0,,BaseHandler}, pero las subclases deben definirlo si quieren postprocesar respuestas del protocolo dado.

Este método, si está definido, será invocado por el @ref{38cc,,OpenerDirector} padre. `req' será un objeto @ref{1057,,Request}. `response' será un objeto que implementa la misma interfaz que el valor retornado de @ref{20a,,urlopen()}. El valor retornado debe implementar la misma interfaz que el valor retornado de @ref{20a,,urlopen()}.
@end deffn

@node Objetos HTTPRedirectHandler,Objetos HTTPCookieProcessor,Objetos BaseHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-redirect-handler}@anchor{38fe}@anchor{library/urllib request httpredirecthandler-objects}@anchor{38ff}
@subsubsection Objetos HTTPRedirectHandler


@cartouche
@quotation Nota 
Algunas redirecciones HTTP requieren acción desde el código del módulo del cliente. Si este es el caso, se genera @ref{105d,,HTTPError}. Vea 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} para más detalles de los significados precisos de los diferentes códigos de redirección.

An @ref{105d,,HTTPError} exception raised as a security consideration if the
HTTPRedirectHandler is presented with a redirected URL which is not an HTTP,
HTTPS or FTP URL.
@end quotation
@end cartouche

@geindex redirect_request() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler redirect_request}@anchor{3900}
@deffn {Método} HTTPRedirectHandler.redirect_request (req, fp, code, msg, hdrs, newurl)

Return a @ref{1057,,Request} or @code{None} in response to a redirect. This is called
by the default implementations of the @code{http_error_30*()} methods when a
redirection is received from the server.  If a redirection should take place,
return a new @ref{1057,,Request} to allow @code{http_error_30*()} to perform the
redirect to `newurl'.  Otherwise, raise @ref{105d,,HTTPError} if
no other handler should try to handle this URL, or return @code{None} if you
can’t but another handler might.

@cartouche
@quotation Nota 
La implementación predeterminada de este método no sigue estrictamente 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}, la cual dice que las respuestas 301 y 302 a peticiones POST no deben ser redirigidas automáticamente sin confirmación por el usuario. En realidad, los navegadores permiten redirección automática de esas respuestas, cambiando el POST a un @code{GET} y la implementación predeterminada reproduce este comportamiento.
@end quotation
@end cartouche
@end deffn

@geindex http_error_301() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_301}@anchor{3901}
@deffn {Método} HTTPRedirectHandler.http_error_301 (req, fp, code, msg, hdrs)

Redirecciona a la URL @code{Location:} o @code{URI:}. Este método es invocado por el @ref{38cc,,OpenerDirector} padre al obtener una respuesta HTTP “moved permanently”.
@end deffn

@geindex http_error_302() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_302}@anchor{3902}
@deffn {Método} HTTPRedirectHandler.http_error_302 (req, fp, code, msg, hdrs)

Lo mismo que @ref{3901,,http_error_301()}, pero invocado para la respuesta “found”.
@end deffn

@geindex http_error_303() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_303}@anchor{3903}
@deffn {Método} HTTPRedirectHandler.http_error_303 (req, fp, code, msg, hdrs)

Lo mismo que @ref{3901,,http_error_301()}, pero invocado para la respuesta “see other”.
@end deffn

@geindex http_error_307() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_307}@anchor{3904}
@deffn {Método} HTTPRedirectHandler.http_error_307 (req, fp, code, msg, hdrs)

Lo mismo que @ref{3901,,http_error_301()}, pero invocado para la respuesta “redirección temporal”. No permite cambiar el método de solicitud de @code{POST} a @code{GET}.
@end deffn

@geindex http_error_308() (método de urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_308}@anchor{3905}
@deffn {Método} HTTPRedirectHandler.http_error_308 (req, fp, code, msg, hdrs)

Lo mismo que @ref{3901,,http_error_301()}, pero invocado para la respuesta “redirección permanente”. No permite cambiar el método de solicitud de @code{POST} a @code{GET}.


Added in version 3.11.

@end deffn

@node Objetos HTTPCookieProcessor,Objetos ProxyHandler,Objetos HTTPRedirectHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-cookie-processor}@anchor{3906}@anchor{library/urllib request httpcookieprocessor-objects}@anchor{3907}
@subsubsection Objetos HTTPCookieProcessor


Las instancias @ref{38d8,,HTTPCookieProcessor} tienen un atributo:

@geindex cookiejar (atributo de urllib.request.HTTPCookieProcessor)
@anchor{library/urllib request urllib request HTTPCookieProcessor cookiejar}@anchor{3908}
@deffn {Atributo} HTTPCookieProcessor.cookiejar

El @ref{3909,,http.cookiejar.CookieJar} en el cual las cookies están almacenadas.
@end deffn

@node Objetos ProxyHandler,Objetos HTTPPasswordMgr,Objetos HTTPCookieProcessor,urllib request — Extensible library for opening URLs
@anchor{library/urllib request proxy-handler}@anchor{390a}@anchor{library/urllib request proxyhandler-objects}@anchor{390b}
@subsubsection Objetos ProxyHandler



@deffn {Método} ProxyHandler.<protocol>_open(request)

The @ref{19d9,,ProxyHandler} will have a method @code{<protocol>_open()} for every
`protocol' which has a proxy in the `proxies' dictionary given in the
constructor.  The method will modify requests to go through the proxy, by
calling @code{request.set_proxy()}, and call the next handler in the chain to
actually execute the protocol.
@end deffn

@node Objetos HTTPPasswordMgr,Objetos HTTPPasswordMgrWithPriorAuth,Objetos ProxyHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-password-mgr}@anchor{38db}@anchor{library/urllib request httppasswordmgr-objects}@anchor{390c}
@subsubsection Objetos HTTPPasswordMgr


Estos métodos están disponibles en los objetos @ref{38d9,,HTTPPasswordMgr} y @ref{38da,,HTTPPasswordMgrWithDefaultRealm}.

@geindex add_password() (método de urllib.request.HTTPPasswordMgr)
@anchor{library/urllib request urllib request HTTPPasswordMgr add_password}@anchor{390d}
@deffn {Método} HTTPPasswordMgr.add_password (realm, uri, user, passwd)

`uri' puede ser una única URI o una secuencia de URIs. `realm', `user' y `passwd' deben ser cadenas. Esto causa que @code{(user, passwd)} se utilice como tokens de autenticación cuando la autenticación para `realm' y para una super URI de ninguna de las URIs dadas es provista.
@end deffn

@geindex find_user_password() (método de urllib.request.HTTPPasswordMgr)
@anchor{library/urllib request urllib request HTTPPasswordMgr find_user_password}@anchor{1846}
@deffn {Método} HTTPPasswordMgr.find_user_password (realm, authuri)

Obtener usuario/contraseña para el reino y URI dados, si alguno ha sido dado. Este método retornará @code{(None, None)} si no hay usuario/contraseña concordante.

Para objetos @ref{38da,,HTTPPasswordMgrWithDefaultRealm}, el reino @code{None} será buscado si el `realm' dado no tiene usuario/contraseña concordante.
@end deffn

@node Objetos HTTPPasswordMgrWithPriorAuth,Objetos AbstractBasicAuthHandler,Objetos HTTPPasswordMgr,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-password-mgr-with-prior-auth}@anchor{38dc}@anchor{library/urllib request httppasswordmgrwithpriorauth-objects}@anchor{390e}
@subsubsection Objetos HTTPPasswordMgrWithPriorAuth


Esta manejador de contraseña extiende @ref{38da,,HTTPPasswordMgrWithDefaultRealm} para soportar el seguimiento de URIs para las cuales deben ser enviadas siempre credenciales de autenticación.

@geindex add_password() (método de urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth add_password}@anchor{390f}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.add_password (realm, uri, user, passwd, is_authenticated=False)

`realm', `uri', `user', `passwd' son como para @ref{390d,,HTTPPasswordMgr.add_password()}. `is_authenticated' establece el valor inicial del indicador @code{is_authenticated} para la URI o lista de URIs dadas. Si se especifica `is_authenticated' como @code{True}, `realm' se ignora.
@end deffn

@geindex find_user_password() (método de urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth find_user_password}@anchor{3910}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.find_user_password (realm, authuri)

Lo mismo que para objetos @ref{38da,,HTTPPasswordMgrWithDefaultRealm}
@end deffn

@geindex update_authenticated() (método de urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth update_authenticated}@anchor{3911}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.update_authenticated (self, uri, is_authenticated=False)

Actualiza el indicador @code{is_authenticated} para la `uri' o lista de URIs dadas.
@end deffn

@geindex is_authenticated() (método de urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth is_authenticated}@anchor{1847}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.is_authenticated (self, authuri)

Retorna el estado actual del indicador @code{is_authenticated} para la URI dada.
@end deffn

@node Objetos AbstractBasicAuthHandler,Objetos HTTPBasicAuthHandler,Objetos HTTPPasswordMgrWithPriorAuth,urllib request — Extensible library for opening URLs
@anchor{library/urllib request abstract-basic-auth-handler}@anchor{3912}@anchor{library/urllib request abstractbasicauthhandler-objects}@anchor{3913}
@subsubsection Objetos AbstractBasicAuthHandler


@geindex http_error_auth_reqed() (método de urllib.request.AbstractBasicAuthHandler)
@anchor{library/urllib request urllib request AbstractBasicAuthHandler http_error_auth_reqed}@anchor{3914}
@deffn {Método} AbstractBasicAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

Maneja una autenticación de petición obteniendo un par usuario/contraseña y reintentando la petición. `authreq' debe ser el nombre del encabezado donde la información sobre el reino se incluye en la petición, `host' especifica la URL y ruta para la cual autenticar, `req' debe ser el objeto @ref{1057,,Request} (fallido) y `headers' deben ser los encabezados de error.

`host' es una autoridad (ej. @code{"python.org"}) o una URL conteniendo un componente de autoridad (ej. @code{"http://python.org/"}). En cualquier caso, la autoridad no debe contener un componente userinfo (por lo que @code{"python.org"} y @code{"python.org:80"} están bien, @code{"joe:password@@python.org"} no).
@end deffn

@node Objetos HTTPBasicAuthHandler,Objetos ProxyBasicAuthHandler,Objetos AbstractBasicAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-basic-auth-handler}@anchor{3915}@anchor{library/urllib request httpbasicauthhandler-objects}@anchor{3916}
@subsubsection Objetos HTTPBasicAuthHandler


@geindex http_error_401() (método de urllib.request.HTTPBasicAuthHandler)
@anchor{library/urllib request urllib request HTTPBasicAuthHandler http_error_401}@anchor{3917}
@deffn {Método} HTTPBasicAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

Reintenta la petición con la información de autenticación, si está disponible.
@end deffn

@node Objetos ProxyBasicAuthHandler,Objetos AbstractDigestAuthHandler,Objetos HTTPBasicAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request proxy-basic-auth-handler}@anchor{3918}@anchor{library/urllib request proxybasicauthhandler-objects}@anchor{3919}
@subsubsection Objetos ProxyBasicAuthHandler


@geindex http_error_407() (método de urllib.request.ProxyBasicAuthHandler)
@anchor{library/urllib request urllib request ProxyBasicAuthHandler http_error_407}@anchor{391a}
@deffn {Método} ProxyBasicAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

Reintenta la petición con la información de autenticación, si está disponible.
@end deffn

@node Objetos AbstractDigestAuthHandler,Objetos HTTPDigestAuthHandler,Objetos ProxyBasicAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request abstract-digest-auth-handler}@anchor{391b}@anchor{library/urllib request abstractdigestauthhandler-objects}@anchor{391c}
@subsubsection Objetos AbstractDigestAuthHandler


@geindex http_error_auth_reqed() (método de urllib.request.AbstractDigestAuthHandler)
@anchor{library/urllib request urllib request AbstractDigestAuthHandler http_error_auth_reqed}@anchor{391d}
@deffn {Método} AbstractDigestAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

`authreq' debe ser el nombre del encabezado donde la información sobre el reino está incluida en la petición, `host' debe ser el host al que autenticar, `req' debe ser el objeto @ref{1057,,Request} (fallido) y `headers' deben ser los encabezados de error.
@end deffn

@node Objetos HTTPDigestAuthHandler,Objetos ProxyDigestAuthHandler,Objetos AbstractDigestAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-digest-auth-handler}@anchor{391e}@anchor{library/urllib request httpdigestauthhandler-objects}@anchor{391f}
@subsubsection Objetos HTTPDigestAuthHandler


@geindex http_error_401() (método de urllib.request.HTTPDigestAuthHandler)
@anchor{library/urllib request urllib request HTTPDigestAuthHandler http_error_401}@anchor{3920}
@deffn {Método} HTTPDigestAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

Reintenta la petición con la información de autenticación, si está disponible.
@end deffn

@node Objetos ProxyDigestAuthHandler,Objetos HTTPHandler,Objetos HTTPDigestAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request proxy-digest-auth-handler}@anchor{3921}@anchor{library/urllib request proxydigestauthhandler-objects}@anchor{3922}
@subsubsection Objetos ProxyDigestAuthHandler


@geindex http_error_407() (método de urllib.request.ProxyDigestAuthHandler)
@anchor{library/urllib request urllib request ProxyDigestAuthHandler http_error_407}@anchor{3923}
@deffn {Método} ProxyDigestAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

Reintenta la petición con la información de autenticación, si está disponible.
@end deffn

@node Objetos HTTPHandler,Objetos HTTPSHandler,Objetos ProxyDigestAuthHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-handler-objects}@anchor{3924}@anchor{library/urllib request httphandler-objects}@anchor{3925}
@subsubsection Objetos HTTPHandler


@geindex http_open() (método de urllib.request.HTTPHandler)
@anchor{library/urllib request urllib request HTTPHandler http_open}@anchor{3926}
@deffn {Método} HTTPHandler.http_open (req)

Envía una petición HTTP, que puede ser GET o POST, dependiendo de @code{req.has_data()}.
@end deffn

@node Objetos HTTPSHandler,Objetos FileHandler,Objetos HTTPHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request https-handler-objects}@anchor{3927}@anchor{library/urllib request httpshandler-objects}@anchor{3928}
@subsubsection Objetos HTTPSHandler


@geindex https_open() (método de urllib.request.HTTPSHandler)
@anchor{library/urllib request urllib request HTTPSHandler https_open}@anchor{3929}
@deffn {Método} HTTPSHandler.https_open (req)

Envía una petición HTTPS, que puede ser GET o POST, dependiendo de @code{req.has_data()}.
@end deffn

@node Objetos FileHandler,Objetos DataHandler,Objetos HTTPSHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request file-handler-objects}@anchor{392a}@anchor{library/urllib request filehandler-objects}@anchor{392b}
@subsubsection Objetos FileHandler


@geindex file_open() (método de urllib.request.FileHandler)
@anchor{library/urllib request urllib request FileHandler file_open}@anchor{392c}
@deffn {Método} FileHandler.file_open (req)

Abre el archivo localmente, si no hay nombre de host, o el nombre de host es @code{'localhost'}.


Distinto en la versión 3.2: This method is applicable only for local hostnames.  When a remote
hostname is given, a @ref{38cb,,URLError} is raised.

@end deffn

@node Objetos DataHandler,Objetos FTPHandler,Objetos FileHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request data-handler-objects}@anchor{392d}@anchor{library/urllib request datahandler-objects}@anchor{392e}
@subsubsection Objetos DataHandler


@geindex data_open() (método de urllib.request.DataHandler)
@anchor{library/urllib request urllib request DataHandler data_open}@anchor{392f}
@deffn {Método} DataHandler.data_open (req)

Read a data URL. This kind of URL contains the content encoded in the URL
itself. The data URL syntax is specified in 
@geindex RFC; RFC 2397
RFC 2397@footnote{https://datatracker.ietf.org/doc/html/rfc2397.html}. This implementation
ignores white spaces in base64 encoded data URLs so the URL may be wrapped
in whatever source file it comes from. But even though some browsers don’t
mind about a missing padding at the end of a base64 encoded data URL, this
implementation will raise a @ref{360,,ValueError} in that case.
@end deffn

@node Objetos FTPHandler,Objetos CacheFTPHandler,Objetos DataHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request ftp-handler-objects}@anchor{3930}@anchor{library/urllib request ftphandler-objects}@anchor{3931}
@subsubsection Objetos FTPHandler


@geindex ftp_open() (método de urllib.request.FTPHandler)
@anchor{library/urllib request urllib request FTPHandler ftp_open}@anchor{3932}
@deffn {Método} FTPHandler.ftp_open (req)

Abre el archivo FTP indicado por `req'. El inicio de sesión siempre se realiza con un usuario y contraseña vacíos.
@end deffn

@node Objetos CacheFTPHandler,Objetos UnknownHandler,Objetos FTPHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request cacheftp-handler-objects}@anchor{3933}@anchor{library/urllib request cacheftphandler-objects}@anchor{3934}
@subsubsection Objetos CacheFTPHandler


Los objetos @ref{172f,,CacheFTPHandler} son objetos @ref{38d4,,FTPHandler} con los siguientes métodos adicionales:

@geindex setTimeout() (método de urllib.request.CacheFTPHandler)
@anchor{library/urllib request urllib request CacheFTPHandler setTimeout}@anchor{3935}
@deffn {Método} CacheFTPHandler.setTimeout (t)

Establece el tiempo de expiración de conexiones a `t' segundos.
@end deffn

@geindex setMaxConns() (método de urllib.request.CacheFTPHandler)
@anchor{library/urllib request urllib request CacheFTPHandler setMaxConns}@anchor{3936}
@deffn {Método} CacheFTPHandler.setMaxConns (m)

Establece el número máximo de conexiones cacheadas a `m'.
@end deffn

@node Objetos UnknownHandler,Objetos HTTPErrorProcessor,Objetos CacheFTPHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request unknown-handler-objects}@anchor{3937}@anchor{library/urllib request unknownhandler-objects}@anchor{3938}
@subsubsection Objetos UnknownHandler


@geindex unknown_open() (método de urllib.request.UnknownHandler)
@anchor{library/urllib request urllib request UnknownHandler unknown_open}@anchor{3939}
@deffn {Método} UnknownHandler.unknown_open ()

Genera una excepción @ref{38cb,,URLError}.
@end deffn

@node Objetos HTTPErrorProcessor,Ejemplos<24>,Objetos UnknownHandler,urllib request — Extensible library for opening URLs
@anchor{library/urllib request http-error-processor-objects}@anchor{393a}@anchor{library/urllib request httperrorprocessor-objects}@anchor{393b}
@subsubsection Objetos HTTPErrorProcessor


@geindex http_response() (método de urllib.request.HTTPErrorProcessor)
@anchor{library/urllib request urllib request HTTPErrorProcessor http_response}@anchor{393c}
@deffn {Método} HTTPErrorProcessor.http_response (request, response)

Procesa errores de respuestas HTTP.

Para códigos de error que no están en el rango de los 200, el objeto de respuesta es retornado inmediatamente.

For non-200 error codes, this simply passes the job on to the
@code{http_error_<type>()} handler methods, via @ref{38f5,,OpenerDirector.error()}.
Eventually, @ref{38d2,,HTTPDefaultErrorHandler} will raise an
@ref{105d,,HTTPError} if no other handler handles the error.
@end deffn

@geindex https_response() (método de urllib.request.HTTPErrorProcessor)
@anchor{library/urllib request urllib request HTTPErrorProcessor https_response}@anchor{393d}
@deffn {Método} HTTPErrorProcessor.https_response (request, response)

Procesa los errores HTTPS de las respuestas.

Este comportamiento es el mismo que @ref{393c,,http_response()}.
@end deffn

@node Ejemplos<24>,Interfaz heredada,Objetos HTTPErrorProcessor,urllib request — Extensible library for opening URLs
@anchor{library/urllib request examples}@anchor{393e}@anchor{library/urllib request urllib-request-examples}@anchor{393f}
@subsubsection Ejemplos


Adicionalmente a los ejemplos siguientes, se dan más ejemplos en @ref{3940,,HOWTO - Cómo obtener recursos de Internet con el paquete urllib}.

Este ejemplo obtiene la página principal python.org y despliega los primeros 300 bytes de ella.

@example
>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(300))
...
b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n
<meta http-equiv="content-type" content="text/html; charset=utf-8" />\n
<title>Python Programming '
@end example

Tenga en cuenta que urlopen retorna un objeto de bytes. Esto es porque no hay forma para urlopen de determinar automáticamente la codificación del flujo de bytes que recibe del servidor HTTP. En general, un programa decodificará el objeto de bytes retornado a cadena de caracteres una vez que determine o adivine la codificación apropiada.

El siguiente documento W3C, @indicateurl{https://www.w3.org/International/O-charset}, lista las diferentes formas en la cual un documento (X)HTML o XML podría haber especificado su información de codificación.

Ya que el sitio web python.org usa codificación `utf-8' tal y como se especifica en su etiqueta meta, usaremos la misma para decodificar el objeto de bytes.

@example
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(100).decode('utf-8'))
...
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
@end example

Es posible conseguir el mismo resultado sin usar la aproximación @ref{675,,context manager}.

@example
>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> print(f.read(100).decode('utf-8'))
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtm
@end example

En el siguiente ejemplo, estamos enviando un flujo de datos a la entrada estándar de un CGI y leyendo los datos que nos retorna. Tenga en cuenta que este ejemplo sólo funcionará cuando la instalación de Python soporte SSL.

@example
>>> import urllib.request
>>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi',
...                       data=b'This data is passed to stdin of the CGI')
>>> with urllib.request.urlopen(req) as f:
...     print(f.read().decode('utf-8'))
...
Got Data: "This data is passed to stdin of the CGI"
@end example

El código para el CGI de muestra usado en el ejemplo anterior es:

@example
#!/usr/bin/env python
import sys
data = sys.stdin.read()
print('Content-type: text/plain\n\nGot Data: "%s"' % data)
@end example

Aquí hay un ejemplo de realizar una petición @code{PUT} usando @ref{1057,,Request}:

@example
import urllib.request
DATA = b'some data'
req = urllib.request.Request(url='http://localhost:8080', data=DATA, method='PUT')
with urllib.request.urlopen(req) as f:
    pass
print(f.status)
print(f.reason)
@end example

Uso de Autenticación HTTP Básica:

@example
import urllib.request
# Create an OpenerDirector with support for Basic HTTP Authentication...
auth_handler = urllib.request.HTTPBasicAuthHandler()
auth_handler.add_password(realm='PDQ Application',
                          uri='https://mahler:8092/site-updates.py',
                          user='klem',
                          passwd='kadidd!ehopper')
opener = urllib.request.build_opener(auth_handler)
# ...and install it globally so it can be used with urlopen.
urllib.request.install_opener(opener)
urllib.request.urlopen('http://www.example.com/login.html')
@end example

@ref{38cf,,build_opener()} provides many handlers by default, including a
@ref{19d9,,ProxyHandler}.  By default, @ref{19d9,,ProxyHandler} uses the environment
variables named @code{<scheme>_proxy}, where @code{<scheme>} is the URL scheme
involved.  For example, the @code{http_proxy} environment variable is read to
obtain the HTTP proxy’s URL.

Este ejemplo reemplaza el @ref{19d9,,ProxyHandler} predeterminado por uno que usa URLs de proxy suministradas mediante programación y añade soporte de autorización de proxy con @ref{38de,,ProxyBasicAuthHandler}.

@example
proxy_handler = urllib.request.ProxyHandler(@{'http': 'http://www.example.com:3128/'@})
proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()
proxy_auth_handler.add_password('realm', 'host', 'username', 'password')

opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)
# This time, rather than install the OpenerDirector, we use it directly:
opener.open('http://www.example.com/login.html')
@end example

Añadiendo encabezados HTTP:

Usa el argumento `headers' en el constructor de @ref{1057,,Request}, o:

@example
import urllib.request
req = urllib.request.Request('http://www.example.com/')
req.add_header('Referer', 'http://www.python.org/')
# Customize the default User-Agent header value:
req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)')
r = urllib.request.urlopen(req)
@end example

@ref{38cc,,OpenerDirector} añade automáticamente un encabezado @code{User-Agent} a cada @ref{1057,,Request}. Para cambiar esto:

@example
import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
opener.open('http://www.example.com/')
@end example

También, recuerda que algunos encabezados estándar (@code{Content-Length}, @code{Content-Type} y @code{Host}) son añadidos cuando se pasa @ref{1057,,Request} a @ref{20a,,urlopen()} (o @ref{105b,,OpenerDirector.open()}).
@anchor{library/urllib request urllib-examples}@anchor{3941}
Aquí hay un ejemplo de sesión que usa el método @code{GET} para obtener una URL que contiene los parámetros:

@example
>>> import urllib.request
>>> import urllib.parse
>>> params = urllib.parse.urlencode(@{'spam': 1, 'eggs': 2, 'bacon': 0@})
>>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params
>>> with urllib.request.urlopen(url) as f:
...     print(f.read().decode('utf-8'))
...
@end example

El siguiente ejemplo usa el método POST en su lugar. Tenga en cuenta que la salida de parámetros desde urlencode es codificada a bytes antes de ser enviados a urlopen como datos:

@example
>>> import urllib.request
>>> import urllib.parse
>>> data = urllib.parse.urlencode(@{'spam': 1, 'eggs': 2, 'bacon': 0@})
>>> data = data.encode('ascii')
>>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f:
...     print(f.read().decode('utf-8'))
...
@end example

El siguiente ejemplo usa un proxy HTTP especificado, sobrescribiendo las configuraciones de entorno:

@example
>>> import urllib.request
>>> proxies = @{'http': 'http://proxy.example.com:8080/'@}
>>> opener = urllib.request.FancyURLopener(proxies)
>>> with opener.open("http://www.python.org") as f:
...     f.read().decode('utf-8')
...
@end example

El siguiente ejemplo no usa proxies, sobrescribiendo las variables de entorno:

@example
>>> import urllib.request
>>> opener = urllib.request.FancyURLopener(@{@})
>>> with opener.open("http://www.python.org/") as f:
...     f.read().decode('utf-8')
...
@end example

@node Interfaz heredada,Restricciones urllib request,Ejemplos<24>,urllib request — Extensible library for opening URLs
@anchor{library/urllib request legacy-interface}@anchor{3942}
@subsubsection Interfaz heredada


Las siguientes funciones y clases están portadas desde el módulo @code{urllib} de Python 2 (en oposición a @code{urllib2}). Ellas pueden estar obsoletas en algún punto del futuro.

@geindex urlretrieve() (en el módulo urllib.request)
@anchor{library/urllib request urllib request urlretrieve}@anchor{3943}
@deffn {Función} urllib.request.urlretrieve (url, filename=None, reporthook=None, data=None)

Copy a network object denoted by a URL to a local file. If the URL
points to a local file, the object will not be copied unless filename is supplied.
Return a tuple @code{(filename, headers)} where `filename' is the
local file name under which the object can be found, and `headers' is whatever
the @code{info()} method of the object returned by @ref{20a,,urlopen()} returned (for
a remote object). Exceptions are the same as for @ref{20a,,urlopen()}.

El segundo argumento, si está presente, especifica la localización a la que será copiada el objeto (si está ausente, la localización será un archivo temporal con un nombre generado). El tercer argumento, si está presente, es un objeto invocable que será invocado una vez que se establezca la conexión de red y después de eso una vez después de cada lectura de bloque. Al invocable se le pasarán tres argumentos; una cuenta de los bloques transferidos hasta el momento, un tamaño de bloque en bytes y el tamaño total del archivo. El tercer argumento puede ser @code{-1} en servidores FTP antiguos los cuales no retornan un tamaño de archivo en respuesta a una solicitud de recuperación.

El siguiente ejemplo ilustra el escenario de uso más común:

@example
>>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()
@end example

Si la `url' usa el esquema de identificador @code{http:}, el argumento opcional `data' puede ser dado para especificar una petición @code{POST} (normalmente el tipo de petición es @code{GET}). El argumento `data' debe ser un objeto de bytes en formato @code{application/x-www-form-urlencoded}; vea la función @ref{f16,,urllib.parse.urlencode()}.

@ref{3943,,urlretrieve()} will raise @ref{3944,,ContentTooShortError} when it detects that
the amount of data available  was less than the expected amount (which is the
size reported by a  `Content-Length' header). This can occur, for example, when
the  download is interrupted.

El `Content-Length' es tratado como un límite inferior: si no hay más datos a leer, urlretrieve lee más datos, pero si están disponibles menos datos, se genera la excepción.

You can still retrieve the downloaded data in this case, it is stored in the
@code{content} attribute of the exception instance.

Si no fue proporcionado el encabezado `Content-Length', urlretrieve no puede comprobar el tamaño de los datos que han sido descargados, y sólo los retorna. En este caso sólo tienes que asumir que la descarga fue exitosa.
@end deffn

@geindex urlcleanup() (en el módulo urllib.request)
@anchor{library/urllib request urllib request urlcleanup}@anchor{19e0}
@deffn {Función} urllib.request.urlcleanup ()

Limpia archivos temporales que pueden haber quedado tras llamadas anteriores a @ref{3943,,urlretrieve()}.
@end deffn

@geindex URLopener (clase en urllib.request)
@anchor{library/urllib request urllib request URLopener}@anchor{208}
@deffn {Clase} urllib.request.URLopener (proxies=None, **x509)


Obsoleto desde la versión 3.3.


Clase base para apertura y lectura de URLs. A no ser que necesites soporte de apertura de objetos usando esquemas diferentes a @code{http:}, @code{ftp:} o @code{file:}, probablemente quieras usar @ref{209,,FancyURLopener}.

Por defecto, la clase @ref{208,,URLopener} envía un encabezado @code{User-Agent} de @code{urllib/VVV}, donde `VVV' es el número de versión @ref{108,,urllib}. Las aplicaciones pueden definir su propio encabezado @code{User-Agent} heredando de @ref{208,,URLopener} o @ref{209,,FancyURLopener} y estableciendo el atributo de clase @ref{3945,,version} a un valor de cadena de caracteres apropiado en la definición de la subclase.

El parámetro opcional `proxies' debe ser un diccionario mapeando nombres de esquemas a URLs de proxy, donde un diccionario vacío apaga los proxies completamente. Su valor predeterminado es @code{None}, en cuyo caso las configuraciones de proxy del entorno serán usadas si están presentes, como ha sido discutido en la definición de @ref{20a,,urlopen()}, arriba.

Parámetros adicionales de palabra clave, recogidos en `x509', pueden ser usados por autenticación del cliente cuando usan el esquema @code{https:}. Las palabras claves `key_file' y `cert_file' están soportadas para proveer una clave y certificado SSL; ambos son necesarias para soportar autenticación de cliente.

Los objetos @ref{208,,URLopener} lanzarán una excepción @ref{4d5,,OSError} si el servidor retorna un código de error.

@geindex open() (método de urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener open}@anchor{3946}
@deffn {Método} open (fullurl, data=None)

Abre `fullurl' usando el protocolo apropiado. Este método configura la información de caché e información de proxy, entonces invoca el método apropiado con sus argumentos de entrada. Si el esquema no está reconocido, se invoca @ref{3947,,open_unknown()}. El argumento `data' tiene el mismo significado que el argumento `data' de @ref{20a,,urlopen()}.

Este método siempre entrecomilla `fullurl' usando @ref{c2b,,quote()}.
@end deffn

@geindex open_unknown() (método de urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener open_unknown}@anchor{3947}
@deffn {Método} open_unknown (fullurl, data=None)

Interfaz sobrescribible para abrir tipos de URL desconocidos.
@end deffn

@geindex retrieve() (método de urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener retrieve}@anchor{19f7}
@deffn {Método} retrieve (url, filename=None, reporthook=None, data=None)

Obtiene el contenido de `url' y lo coloca en `filename'. El valor retornado es una tupla que consiste de un nombre de archivo local y un objeto @ref{3d1,,email.message.Message} conteniendo los encabezados de respuesta (para URLs remotas) o @code{None} (para URLs locales). El invocador debe entonces abrir y leer los contenidos de `filename'. Si `filename' no está dado y la URL refiere a un archivo local, se retorna el nombre de archivo de entrada. Si la URL no es local y no se da `filename', el nombre de archivo es la salida de la función @ref{1895,,tempfile.mktemp()} con un sufijo que concuerda con el sufijo del último componente de la ruta de la URL de entrada. Si se da `reporthook', debe ser una función que acepte tres parámetros numéricos: Un número de fragmento, se leen los fragmentos de tamaño máximo y el tamaño total de la descarga (-1 si es desconocida). Será invocada una vez al comienzo y después de que cada fragmento de datos sea leído de la red. `reporthook' es ignorado para URLs locales.

Si la `url' usa el identificador de esquema @code{http:}, el argumento opcional `data' puede ser dado para especificar una petición @code{POST} (normalmente el tipo de petición es @code{GET}). El argumento `data' debe estar en formato estándar @code{application/x-www-form-urlencoded}; vea la función @ref{f16,,urllib.parse.urlencode()}.
@end deffn

@geindex version (atributo de urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener version}@anchor{3945}
@deffn {Atributo} version

Variable que especifica el agente de usuario del objeto abridor. Para obtener @ref{108,,urllib} para decir a los servidores que es un agente de usuario particular, establece esto en una subclase como una variable de clase o en el constructor antes de invocar el constructor base.
@end deffn
@end deffn

@geindex FancyURLopener (clase en urllib.request)
@anchor{library/urllib request urllib request FancyURLopener}@anchor{209}
@deffn {Clase} urllib.request.FancyURLopener (...)


Obsoleto desde la versión 3.3.


@ref{209,,FancyURLopener} hereda de @ref{208,,URLopener} proveyendo manejo predeterminado para los siguientes códigos de respuesta HTTP: 301, 302, 303, 307 y 401. Para los códigos de respuesta 30x listados anteriormente, se usa el encabezado @code{Location} para obtener la URL actual. Para códigos de respuesta 401 (autenticación requerida), se realiza autenticación HTTP. Para los códigos de respuesta 30x, la recursión está limitada por el valor del atributo `maxentries', el cual por defecto es 10.

For all other response codes, the method @ref{38fd,,http_error_default()} is called
which you can override in subclasses to handle the error appropriately.

@cartouche
@quotation Nota 
De acuerdo a la carta de 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}, las respuestas a las peticiones POST 301 y 302 no debe ser redireccionadas automáticamente sin confirmación por el usuario. En realidad, los navegadores permiten redirección automática de esas respuestas, cambiando de POST a GET, y @ref{108,,urllib} reproduce este comportamiento.
@end quotation
@end cartouche

Los parámetros del constructor son el mismo que aquellos para @ref{208,,URLopener}.

@cartouche
@quotation Nota 
Cuando se realiza autenticación básica, una instancia @ref{209,,FancyURLopener} invoca a su método @ref{3948,,prompt_user_passwd()}. La implementación predeterminada pregunta a los usuarios la información requerida en la terminal de control. Una subclase puede sobrescribir este método para soportar un comportamiento más apropiado si se necesita.
@end quotation
@end cartouche

La clase @ref{209,,FancyURLopener} ofrece un método adicional que debe ser sobrecargado para proveer el comportamiento apropiado:

@geindex prompt_user_passwd() (método de urllib.request.FancyURLopener)
@anchor{library/urllib request urllib request FancyURLopener prompt_user_passwd}@anchor{3948}
@deffn {Método} prompt_user_passwd (host, realm)

Retorna la información necesaria para autenticar el usuario en el host dado en el reino de seguridad especificado. El valor retornado debe ser una tupla @code{(user, password)}, la cual puede ser usada para autenticación básica.

La implementación solicita esta información en el terminal; una aplicación debe sobrescribir este método para usar un modelo de interacción apropiado en el entorno local.
@end deffn
@end deffn

@node Restricciones urllib request,,Interfaz heredada,urllib request — Extensible library for opening URLs
@anchor{library/urllib request urllib-request-restrictions}@anchor{3949}
@subsubsection Restricciones @code{urllib.request}


@geindex HTTP;protocol
@geindex FTP;protocol


@itemize *

@item 
Actualmente, sólo uno de los siguientes protocolo están soportados: HTTP (versiones 0.9 y 1.0), FTP, archivos locales y URLs de datos.


Distinto en la versión 3.4: Añadido soporte para URLs de datos.


@item 
La característica de caché de @ref{3943,,urlretrieve()} ha sido deshabilitada hasta que alguien encuentre el tiempo para hackear el procesamiento adecuado de los encabezados de tiempo de Expiración.

@item 
Debería haber una función para consultar si una URL en particular está en la caché.

@item 
Para compatibilidad con versiones anteriores, si una URL parece apuntar a un archivo local pero el archivo no puede ser abierto, la URL es reinterpretada usando el protocolo FTP. Esto a veces puede causar mensajes de error confusos.

@item 
Las funciones @ref{20a,,urlopen()} y @ref{3943,,urlretrieve()} pueden causar retrasos arbitrariamente largos mientras esperan a que se configure una conexión de red. Esto significa que es difícil construir un cliente Web interactivo usando estas funciones sin utilizar hilos.

@geindex HTML
@geindex HTTP;protocol

@item 
Los datos retornados por @ref{20a,,urlopen()} o @ref{3943,,urlretrieve()} son los datos en crudo retornados por el servidor. Estos pueden ser datos binarios (como una imagen), texto plano o (por ejemplo) HTML. El protocolo HTTP provee información de tipo en el encabezado de respuesta, el cual puede ser inspeccionado mirando el encabezado @code{Content-Type}. Si los datos retornados son HTML, puedes usar el módulo @ref{6d,,html.parser} para analizarlos.

@geindex FTP

@item 
El código que maneja el protocolo FTP no puede diferenciar entre un archivo y un directorio. Esto puede llevar a un comportamiento inesperado cuando se intenta leer una URL que apunta a un archivo que no es accesible. Si la URL termina en un @code{/}, se asume que se refiere a un directorio y será manejada acordemente. Pero si un intento de leer un archivo lleva a un error 550 (lo que significa que la URL no puede ser encontrada o no es accesible, a menudo por razones de permisos), entonces se trata la ruta como un directorio para manejar el caso cuando un directorio es especificado por una URL pero el @code{/} trasero ha sido dejado fuera. Esto puede causar resultados erróneos cuando intenta obtener un archivo cuyos permisos de lectura lo hacen inaccesible; el código FTP intentará leerlo, fallará con un error 550 y entonces realizará un listado de directorio para el archivo ilegible. Si se necesita un control más detallado, considere usar el módulo @ref{5e,,ftplib}, heredando @ref{209,,FancyURLopener} o cambiando `_urlopener' para ajustarlo a tus necesidades.
@end itemize

@node urllib response — Clases de respuesta usadas por urllib,urllib parse — Parse URLs into components,urllib request — Extensible library for opening URLs,Protocolos y soporte de Internet
@anchor{library/urllib request module-urllib response}@anchor{10c}@anchor{library/urllib request urllib-response-response-classes-used-by-urllib}@anchor{394a}
@subsection @code{urllib.response} — Clases de respuesta usadas por urllib


@geindex module; urllib.response

El módulo @ref{10c,,urllib.response} define funciones y clases que definen una interfaz mínima `file-like', incluyendo @code{read()} y @code{readline()}. Las funciones definidas en este módulo son usadas internamente por el módulo @ref{10b,,urllib.request}. El objeto de respuesta típico es una instancia de @ref{38c9,,urllib.response.addinfourl}:

@geindex addinfourl (clase en urllib.response)
@anchor{library/urllib request urllib response addinfourl}@anchor{38c9}
@deffn {Clase} urllib.response.addinfourl

@geindex url (atributo de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl url}@anchor{394b}
@deffn {Atributo} url

:URL del recurso obtenido, comúnmente usado para determinar si se ha seguido una redirección.
@end deffn

@geindex headers (atributo de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl headers}@anchor{394c}
@deffn {Atributo} headers

Retorna las cabeceras de la respuesta en la forma de una instancia de @ref{3d0,,EmailMessage}.
@end deffn

@geindex status (atributo de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl status}@anchor{394d}
@deffn {Atributo} status


Added in version 3.9.


Código de estado  retornado por el servidor.
@end deffn

@geindex geturl() (método de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl geturl}@anchor{394e}
@deffn {Método} geturl ()


Obsoleto desde la versión 3.9: Obsoleto en favor de @ref{394b,,url}.

@end deffn

@geindex info() (método de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl info}@anchor{394f}
@deffn {Método} info ()


Obsoleto desde la versión 3.9: Obsoleto en favor de @ref{394c,,headers}.

@end deffn

@geindex code (atributo de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl code}@anchor{3950}
@deffn {Atributo} code


Obsoleto desde la versión 3.9: Obsoleto en favor de @ref{394d,,status}.

@end deffn

@geindex getcode() (método de urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl getcode}@anchor{3951}
@deffn {Método} getcode ()


Obsoleto desde la versión 3.9: Obsoleto en favor de @ref{394d,,status}.

@end deffn
@end deffn

@node urllib parse — Parse URLs into components,urllib error — Exception classes raised by urllib request,urllib response — Clases de respuesta usadas por urllib,Protocolos y soporte de Internet
@anchor{library/urllib parse doc}@anchor{3952}@anchor{library/urllib parse module-urllib parse}@anchor{10a}@anchor{library/urllib parse urllib-parse-parse-urls-into-components}@anchor{3953}
@subsection @code{urllib.parse} — Parse URLs into components


@geindex module; urllib.parse

`Código fuente:' Lib/urllib/parse.py@footnote{https://github.com/python/cpython/tree/main/Lib/urllib/parse.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex URL;parsing
@geindex relative;URL


__________________________________________________________________


Este modulo define una interfaz estándar para separar cadenas de texto del Localizador de recursos uniforme (más conocido por las siglas URL, del inglés `Uniform Resource Locator') en componentes (esquema de dirección, ubicación de red, ruta de acceso, etc.), para poder combinar los componentes  nuevamente en una cadena de texto URL, y convertir una «URL relativa» a una URL absoluta a partir de una «URL base».

The module has been designed to match the internet RFC on Relative Uniform
Resource Locators. It supports the following URL schemes: @code{file}, @code{ftp},
@code{gopher}, @code{hdl}, @code{http}, @code{https}, @code{imap}, @code{itms-services}, @code{mailto}, @code{mms},
@code{news}, @code{nntp}, @code{prospero}, @code{rsync}, @code{rtsp}, @code{rtsps}, @code{rtspu},
@code{sftp}, @code{shttp}, @code{sip}, @code{sips}, @code{snews}, @code{svn}, @code{svn+ssh},
@code{telnet}, @code{wais}, @code{ws}, @code{wss}.

`Detalles de implementación de CPython:' The inclusion of the @code{itms-services} URL scheme can prevent an app from
passing Apple’s App Store review process for the macOS and iOS App Stores.
Handling for the @code{itms-services} scheme is always removed on iOS; on
macOS, it `may' be removed if CPython has been built with the
@ref{162e,,--with-app-store-compliance} option.

El módulo @ref{10a,,urllib.parse} define funciones que se dividen en dos categorías amplias: análisis de URL y cita de URL. Estos se tratan en detalle en las secciones siguientes.

This module’s functions use the deprecated term @code{netloc} (or @code{net_loc}),
which was introduced in 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html}. However, this term has been obsoleted by
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, which introduced the term @code{authority} as its replacement.
The use of @code{netloc} is continued for backward compatibility.

@menu
* Análisis de URL:: 
* Análisis de seguridad de URL:: 
* Análisis de bytes codificados ASCII:: 
* Resultados del análisis estructurado:: 
* Cita de URL:: 

@end menu

@node Análisis de URL,Análisis de seguridad de URL,,urllib parse — Parse URLs into components
@anchor{library/urllib parse url-parsing}@anchor{3954}
@subsubsection Análisis de URL


Las funciones de análisis de url se centran en dividir una cadena de dirección URL en sus componentes o en combinar componentes de dirección URL en una cadena de dirección URL.

@geindex urlparse() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlparse}@anchor{207}
@deffn {Función} urllib.parse.urlparse (urlstring, scheme='@w{'}, allow_fragments=True)

Analiza una URL en seis componentes, retornando una @ref{6ef,,tupla nombrada} de 6 elementos.  Esto corresponde a la estructura general de una URL: @code{scheme://netloc/path;parameters?query#fragment}. Cada elemento de la tupla es una cadena de caracteres, posiblemente vacía. Los componentes no se dividen en piezas más pequeñas (por ejemplo, la ubicación de red es una sola cadena) y los caracteres % de escape no están expandidos. Los delimitadores como se muestra anteriormente no forman parte del resultado, excepto una barra diagonal inicial en el componente `path', el cual es conservado si está presente.  Por ejemplo:

@example
>>> from urllib.parse import urlparse
>>> urlparse("scheme://netloc/path;parameters?query#fragment")
ParseResult(scheme='scheme', netloc='netloc', path='/path;parameters', params='@w{'},
            query='query', fragment='fragment')
>>> o = urlparse("http://docs.python.org:80/3/library/urllib.parse.html?"
...              "highlight=params#url-parsing")
>>> o
ParseResult(scheme='http', netloc='docs.python.org:80',
            path='/3/library/urllib.parse.html', params='@w{'},
            query='highlight=params', fragment='url-parsing')
>>> o.scheme
'http'
>>> o.netloc
'docs.python.org:80'
>>> o.hostname
'docs.python.org'
>>> o.port
80
>>> o._replace(fragment="").geturl()
'http://docs.python.org:80/3/library/urllib.parse.html?highlight=params'
@end example

Siguiendo las especificaciones de sintaxis en 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html}, urlparse reconoce un netloc sólo si es introducido correctamente por “//”.  De lo contrario, se supone que la entrada es una dirección URL relativa y, por lo tanto, comienza con un componente de ruta de acceso.

@example
>>> from urllib.parse import urlparse
>>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
ParseResult(scheme='@w{'}, netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='@w{'}, query='@w{'}, fragment='@w{'})
>>> urlparse('www.cwi.nl/%7Eguido/Python.html')
ParseResult(scheme='@w{'}, netloc='@w{'}, path='www.cwi.nl/%7Eguido/Python.html',
            params='@w{'}, query='@w{'}, fragment='@w{'})
>>> urlparse('help/Python.html')
ParseResult(scheme='@w{'}, netloc='@w{'}, path='help/Python.html', params='@w{'},
            query='@w{'}, fragment='@w{'})
@end example

El argumento `scheme' proporciona el esquema de direccionamiento predeterminado, que solo se utilizará si la dirección URL no especifica uno.  Debe ser del mismo tipo (texto o bytes) que `urlstring', excepto que el valor predeterminado @code{'@w{'}}  siempre está permitido, y se convierte automáticamente a @code{b'@w{'}} si aplica.

Si el argumento `allow_fragments' es falso, los identificadores de fragmento no son reconocidos. Sino que, son analizados como parte de la ruta, parámetros o componentes de la consulta y el @code{fragment} es configurado como una cadena vacía en el valor retornado.

El valor retornado es un @ref{6ef,,named tuple}, lo que significa que se puede tener acceso a sus elementos por índice o como atributos con nombre, que son:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor si no está presente

@item

@code{scheme}

@tab

0

@tab

Especificador de esquema de URL

@tab

parámetro `scheme'

@item

@code{netloc}

@tab

1

@tab

Parte de ubicación de red

@tab

cadena vacía

@item

@code{path}

@tab

2

@tab

Hierarchical path

@tab

cadena vacía

@item

@code{params}

@tab

3

@tab

Parámetros para el último elemento de ruta de acceso

@tab

cadena vacía

@item

@code{query}

@tab

4

@tab

Componente de consulta

@tab

cadena vacía

@item

@code{fragment}

@tab

5

@tab

Identificador de fragmento

@tab

cadena vacía

@item

@code{username}

@tab

@tab

Nombre de usuario

@tab

@ref{716,,None}

@item

@code{password}

@tab

@tab

Contraseña

@tab

@ref{716,,None}

@item

@code{hostname}

@tab

@tab

Nombre de host (minúsculas)

@tab

@ref{716,,None}

@item

@code{port}

@tab

@tab

Número de puerto como entero, si está presente

@tab

@ref{716,,None}

@end multitable


La lectura del atributo @code{port} lanzará un @ref{360,,ValueError} si se especifica un puerto no válido en la dirección URL.  Consulte la sección @ref{3955,,Resultados del análisis estructurado} para obtener más información sobre el objeto de resultado.

Los corchetes no coincidentes en el atributo @code{netloc} lanzarán un @ref{360,,ValueError}.

Los caracteres del atributo @code{netloc} que se descomponen en la normalización de NFKC (según lo utilizado por la codificación IDNA) en cualquiera de @code{/}, @code{?}, @code{#}, @code{@@} o @code{:} lanzará un @ref{360,,ValueError}. Si la dirección URL se descompone antes del análisis, no se producirá ningún error.

Como es el caso con todas las tuplas con nombre, la subclase tiene algunos métodos y atributos adicionales que son particularmente útiles. Uno de estos métodos es @code{_replace()}. El método @code{_replace()} retornará un nuevo objeto ParseResult reemplazando los campos especificados por nuevos valores.

@example
>>> from urllib.parse import urlparse
>>> u = urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
>>> u
ParseResult(scheme='@w{'}, netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='@w{'}, query='@w{'}, fragment='@w{'})
>>> u._replace(scheme='http')
ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            params='@w{'}, query='@w{'}, fragment='@w{'})
@end example

@cartouche
@quotation Advertencia 
@ref{207,,urlparse()} no realiza validaciones. Mire  @ref{3956,,URL parsing security} para más información.
@end quotation
@end cartouche


Distinto en la versión 3.2: Se han añadido capacidades de análisis de URL IPv6.



Distinto en la versión 3.3: The fragment is now parsed for all URL schemes (unless `allow_fragments' is
false), in accordance with 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}.  Previously, an allowlist of
schemes that support fragments existed.



Distinto en la versión 3.6: Los números de puerto fuera de rango ahora generan @ref{360,,ValueError}, en lugar de retornar @ref{716,,None}.



Distinto en la versión 3.8: Los caracteres que afectan al análisis de netloc en la normalización de NFKC ahora lanzarán @ref{360,,ValueError}.

@end deffn

@geindex parse_qs() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse parse_qs}@anchor{1c9}
@deffn {Función} urllib.parse.parse_qs (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

Analizar una cadena de consulta proporcionada como argumento de cadena (datos de tipo @code{application/x-www-form-urlencoded}).  Los datos se retornan como un diccionario.  Las claves de diccionario son los nombres de variable de consulta únicos y los valores son listas de valores para cada nombre.

El argumento opcional `keep_blank_values' es un indicador que indica si los valores en blanco de las consultas codificadas por porcentaje deben tratarse como cadenas en blanco. Un valor verdadero indica que los espacios en blanco deben conservarse como cadenas en blanco.  El valor falso predeterminado indica que los valores en blanco deben omitirse y tratarse como si no se hubieran incluido.

El argumento opcional `strict_parsing' es una marca que indica qué hacer con los errores de análisis.  Si es falso (valor predeterminado), los errores se omiten silenciosamente.  Si es verdadero, los errores generan una excepción @ref{360,,ValueError}.

Los parámetros opcionales `encoding' y `errors' especifican cómo descodificar secuencias codificadas porcentualmente en caracteres Unicode, tal como lo acepta el método @ref{96d,,bytes.decode()}.

El argumento opcional `max_num_fields' es el número máximo de campos que se van a leer. Si se establece, se produce un @ref{360,,ValueError} si hay más de `max_num_fields' campos leídos.

El argumento opcional `separator' es el símbolo que se usa para separar los argumentos de la cadena de consulta. El valor por defecto es @code{&}.

Utilice la función @ref{f16,,urllib.parse.urlencode()} (con el parámetro @code{doseq} establecido en @code{True}) para convertir dichos diccionarios en cadenas de consulta.


Distinto en la versión 3.2: Agregue los parámetros `encoding' y `errors'.



Distinto en la versión 3.8: Añadido parámetro `max_num_fields'.



Distinto en la versión 3.10: Añadido parámetro `separator' con un valor por defecto de @code{&}. Versiones de Python anterior a Python 3.10 permitían el uso de @code{;} y @code{&} como separadores de la cadena de consulta. Esto ha sido cambiado para aceptar sólo una llave separadora, siendo @code{&} el separador por defecto.



Obsoleto desde la versión 3.14: Accepting objects with false values (like @code{0} and @code{[]}) except empty
strings and byte-like objects and @code{None} is now deprecated.

@end deffn

@geindex parse_qsl() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse parse_qsl}@anchor{1c8}
@deffn {Función} urllib.parse.parse_qsl (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

Analizar una cadena de consulta proporcionada como argumento de cadena (datos de tipo @code{application/x-www-form-urlencoded}).  Los datos se retornan como una lista de pares de nombre y valor.

El argumento opcional `keep_blank_values' es un indicador que indica si los valores en blanco de las consultas codificadas por porcentaje deben tratarse como cadenas en blanco. Un valor verdadero indica que los espacios en blanco deben conservarse como cadenas en blanco.  El valor falso predeterminado indica que los valores en blanco deben omitirse y tratarse como si no se hubieran incluido.

El argumento opcional `strict_parsing' es una marca que indica qué hacer con los errores de análisis.  Si es falso (valor predeterminado), los errores se omiten silenciosamente.  Si es verdadero, los errores generan una excepción @ref{360,,ValueError}.

Los parámetros opcionales `encoding' y `errors' especifican cómo descodificar secuencias codificadas porcentualmente en caracteres Unicode, tal como lo acepta el método @ref{96d,,bytes.decode()}.

El argumento opcional `max_num_fields' es el número máximo de campos que se van a leer. Si se establece, se produce un @ref{360,,ValueError} si hay más de `max_num_fields' campos leídos.

El argumento opcional `separator' es el símbolo que se usa para separar los argumentos de la cadena de consulta. El valor por defecto es @code{&}.

Utilice la función @ref{f16,,urllib.parse.urlencode()} para convertir dichas listas de pares en cadenas de consulta.


Distinto en la versión 3.2: Agregue los parámetros `encoding' y `errors'.



Distinto en la versión 3.8: Añadido parámetro `max_num_fields'.



Distinto en la versión 3.10: Añadido parámetro `separator' con un valor por defecto de @code{&}. Versiones de Python anterior a Python 3.10 permitían el uso de @code{;} y @code{&} como separadores de la cadena de consulta. Esto ha sido cambiado para aceptar sólo una llave separadora, siendo @code{&} el separador por defecto.

@end deffn

@geindex urlunparse() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlunparse}@anchor{15d6}
@deffn {Función} urllib.parse.urlunparse (parts)

Construir una URL a partir de una tupla retornada por @code{urlparse()}. El argumento `parts' puede ser iterable de seis elementos. Esto puede dar lugar a una dirección URL ligeramente diferente, pero equivalente, si la dirección URL que se analizó originalmente tenía delimitadores innecesarios (por ejemplo, un @code{?} con una consulta vacía; la RFC indica que son equivalentes).
@end deffn

@geindex urlsplit() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlsplit}@anchor{dc6}
@deffn {Función} urllib.parse.urlsplit (urlstring, scheme='@w{'}, allow_fragments=True)

Esto es similar a @ref{207,,urlparse()}, pero no divide los parámetros de la dirección URL. Esto se debe utilizar generalmente en lugar de @ref{207,,urlparse()} si se desea la sintaxis de URL más reciente que permite aplicar parámetros a cada segmento de la parte `path' de la dirección URL (consulte 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html}).  Se necesita una función independiente para separar los segmentos y parámetros de ruta.  Esta función retorna un 5-item @ref{6ef,,named tuple}:

@example
(addressing scheme, network location, path, query, fragment identifier).
@end example

El valor retornado es un @ref{6ef,,named tuple}, se puede acceder a sus elementos por índice o como atributos con nombre:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor si no está presente

@item

@code{scheme}

@tab

0

@tab

Especificador de esquema de URL

@tab

parámetro `scheme'

@item

@code{netloc}

@tab

1

@tab

Parte de ubicación de red

@tab

cadena vacía

@item

@code{path}

@tab

2

@tab

Hierarchical path

@tab

cadena vacía

@item

@code{query}

@tab

3

@tab

Componente de consulta

@tab

cadena vacía

@item

@code{fragment}

@tab

4

@tab

Identificador de fragmento

@tab

cadena vacía

@item

@code{username}

@tab

@tab

Nombre de usuario

@tab

@ref{716,,None}

@item

@code{password}

@tab

@tab

Contraseña

@tab

@ref{716,,None}

@item

@code{hostname}

@tab

@tab

Nombre de host (minúsculas)

@tab

@ref{716,,None}

@item

@code{port}

@tab

@tab

Número de puerto como entero, si está presente

@tab

@ref{716,,None}

@end multitable


La lectura del atributo @code{port} lanzará un @ref{360,,ValueError} si se especifica un puerto no válido en la dirección URL.  Consulte la sección @ref{3955,,Resultados del análisis estructurado} para obtener más información sobre el objeto de resultado.

Los corchetes no coincidentes en el atributo @code{netloc} lanzarán un @ref{360,,ValueError}.

Los caracteres del atributo @code{netloc} que se descomponen en la normalización de NFKC (según lo utilizado por la codificación IDNA) en cualquiera de @code{/}, @code{?}, @code{#}, @code{@@} o @code{:} lanzará un @ref{360,,ValueError}. Si la dirección URL se descompone antes del análisis, no se producirá ningún error.

Siguiendo algunas de las WHATWG spec@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser} que actualizan el RFC 3986, los caracteres de control C0 y de espacio se eliminan de la URL. Los caracteres @code{\n}, @code{\r} y tab @code{\t} se eliminan de la URL en cualquier posición.

@cartouche
@quotation Advertencia 
@ref{dc6,,urlsplit()} no realiza validaciones. Mire  @ref{3956,,URL parsing security} para más información.
@end quotation
@end cartouche


Distinto en la versión 3.6: Los números de puerto fuera de rango ahora generan @ref{360,,ValueError}, en lugar de retornar @ref{716,,None}.



Distinto en la versión 3.8: Los caracteres que afectan al análisis de netloc en la normalización de NFKC ahora lanzarán @ref{360,,ValueError}.



Distinto en la versión 3.10: Los caracteres ASCII de nueva línea y tab se eliminan de la URL.



Distinto en la versión 3.12: Los caracteres de control WHATWG C0 y de espacio se eliminan de la URL.

@end deffn

@geindex urlunsplit() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlunsplit}@anchor{15d5}
@deffn {Función} urllib.parse.urlunsplit (parts)

Combine los elementos de una tupla retornados por @ref{dc6,,urlsplit()} en una URL completa como una cadena. El argumento `parts' puede ser iterable de cinco elementos. Esto puede dar lugar a una dirección URL ligeramente diferente, pero equivalente, si la dirección URL que se analizó originalmente tenía delimitadores innecesarios (por ejemplo, un ? con una consulta vacía; la RFC indica que son equivalentes).
@end deffn

@geindex urljoin() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urljoin}@anchor{f17}
@deffn {Función} urllib.parse.urljoin (base, url, allow_fragments=True)

Construya una URL completa («absoluta») combinando una «URL base» (`base') con otra URL (`url').  Informalmente, esto utiliza componentes de la dirección URL base, en particular el esquema de direccionamiento, la ubicación de red y (parte de) la ruta de acceso, para proporcionar los componentes que faltan en la dirección URL relativa.  Por ejemplo:

@example
>>> from urllib.parse import urljoin
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html')
'http://www.cwi.nl/%7Eguido/FAQ.html'
@end example

El argumento `allow_fragments' tiene el mismo significado y el valor predeterminado que para @ref{207,,urlparse()}.

@cartouche
@quotation Nota 
Si `url' es una URL absoluta (es decir, comienza con @code{//} o @code{scheme://}), el nombre de host y/o esquema de `url' estará presente en el resultado.  Por ejemplo:

@example
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
...         '//www.python.org/%7Eguido')
'http://www.python.org/%7Eguido'
@end example

Si no desea ese comportamiento, preprocesa las partes `url' con @ref{dc6,,urlsplit()} y @ref{15d5,,urlunsplit()}, eliminando posibles partes `esquema' y `netloc'.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Because an absolute URL may be passed as the @code{url} parameter, it is
generally `not secure' to use @code{urljoin} with an attacker-controlled
@code{url}. For example in,
@code{urljoin("https://website.com/users/", username)}, if @code{username} can
contain an absolute URL, the result of @code{urljoin} will be the absolute
URL.
@end quotation
@end cartouche


Distinto en la versión 3.5: Comportamiento actualizado para coincidir con la semántica definida en 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}.

@end deffn

@geindex urldefrag() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urldefrag}@anchor{12b5}
@deffn {Función} urllib.parse.urldefrag (url)

Si `url' contiene un identificador de fragmento, retorne una versión modificada de `url' sin identificador de fragmento y el identificador de fragmento como una cadena independiente.  Si no hay ningún identificador de fragmento en `url', retorne `url' sin modificar y una cadena vacía.

El valor retornado es un @ref{6ef,,named tuple}, se puede acceder a sus elementos por índice o como atributos con nombre:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor si no está presente

@item

@code{url}

@tab

0

@tab

URL sin fragmento

@tab

cadena vacía

@item

@code{fragment}

@tab

1

@tab

Identificador de fragmento

@tab

cadena vacía

@end multitable


Consulte la sección @ref{3955,,Resultados del análisis estructurado} para obtener más información sobre el objeto de resultado.


Distinto en la versión 3.2: El resultado es un objeto estructurado en lugar de una simple tupla de 2.

@end deffn

@geindex unwrap() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse unwrap}@anchor{3957}
@deffn {Función} urllib.parse.unwrap (url)

Extrae la url de una URL envuelta (es decir, una cadena de caracteres formateada como @code{<URL:scheme://host/path>}, @code{<scheme://host/path>}, @code{URL:scheme://host/path} or @code{scheme://host/path}). Si `url' no es una URL envuelta, se retorna sin cambios.
@end deffn

@node Análisis de seguridad de URL,Análisis de bytes codificados ASCII,Análisis de URL,urllib parse — Parse URLs into components
@anchor{library/urllib parse id1}@anchor{3958}@anchor{library/urllib parse url-parsing-security}@anchor{3956}
@subsubsection Análisis de seguridad de URL


Las APIs @ref{dc6,,urlsplit()} y @ref{207,,urlparse()} no realizan `validación' de las entradas.  Es posible que no produzcan errores en entradas que otras aplicaciones consideren inválidas.  También pueden tener éxito en algunas entradas que podrían no ser consideradas URLs en otros lugares.  Su propósito es más la funcionalidad práctica que la pureza.

En vez de generar una excepción en una entrada inusual, pueden devolver algunas partes componentes como una cadenas vacías. O los componentes pueden contener más de lo que deberían.

Se recomienda que los usuarios de estas APIs, en las que los valores se pueden usar en cualquier lugar con implicaciones de seguridad, codifiquen de forma defensiva. Realicen algunas comprobaciones en su código antes de confiar en un componente devuelto. ¿Tiene sentido ese @code{scheme}? ¿Es ese @code{path} sensible? ¿Hay algo extraño en ese @code{hostname}? etc.

Lo que constituye una URL no está universalmente bien definido. Aplicaciones diferentes tienen diferentes necesidades y restricciones deseadas. Por ejemplo, la WHATWG spec@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser} describe lo que requieren los clientes web orientados al usuario, como un navegador web. Mientras 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} es más general. Estas funciones incorporan algunos aspectos de ambos, pero no se puede afirmar que cumpla con ninguno de los dos. Las API y el código de usuario existente con expectativas sobre comportamientos específicos son anteriores a ambos estándares, lo que nos lleva a ser muy cautelosos realizando cambios en el comportamiento de la API.

@node Análisis de bytes codificados ASCII,Resultados del análisis estructurado,Análisis de seguridad de URL,urllib parse — Parse URLs into components
@anchor{library/urllib parse id2}@anchor{3959}@anchor{library/urllib parse parsing-ascii-encoded-bytes}@anchor{12b7}
@subsubsection Análisis de bytes codificados ASCII


Las funciones de análisis de URL se diseñaron originalmente para funcionar solo en cadenas de caracteres. En la práctica, es útil poder manipular las direcciones URL correctamente citadas y codificadas como secuencias de bytes ASCII. En consecuencia, las funciones de análisis de URL de este módulo funcionan en los objetos @ref{325,,bytes} y @ref{5e0,,bytearray}, además de los objetos @ref{237,,str}.

Si se pasan datos @ref{237,,str}, el resultado también contendrá solo los datos @ref{237,,str}. Si se pasan datos @ref{325,,bytes} o @ref{5e0,,bytearray}, el resultado contendrá solo los datos @ref{325,,bytes}.

Si intenta mezclar datos @ref{237,,str} con @ref{325,,bytes} o @ref{5e0,,bytearray} en una sola llamada de función, se producirá un @ref{228,,TypeError}, mientras que al intentar pasar valores de bytes no ASCII se desencadenará @ref{aa5,,UnicodeDecodeError}.

Para admitir una conversión más sencilla de objetos de resultado entre @ref{237,,str} y @ref{325,,bytes}, todos los valores retornados de las funciones de análisis de URL proporcionan un método @code{encode()} (cuando el resultado contiene @ref{237,,str} data) o un método @code{decode()} (cuando el resultado contiene datos @ref{325,,bytes}). Las firmas de estos métodos coinciden con las de los métodos correspondientes @ref{237,,str} y @ref{325,,bytes} (excepto que la codificación predeterminada es @code{'ascii}” en lugar de @code{'utf-8}”). Cada uno produce un valor de un tipo correspondiente que contiene datos @ref{325,,bytes} (para los métodos @code{encode()}) o @ref{237,,str} (para @code{decode()} métodos).

Las aplicaciones que necesitan operar en direcciones URL potencialmente citadas incorrectamente que pueden contener datos no ASCII tendrán que realizar su propia decodificación de bytes a caracteres antes de invocar los métodos de análisis de URL.

El comportamiento descrito en esta sección solo se aplica a las funciones de análisis de URL. Las funciones de citación de URL utilizan sus propias reglas al producir o consumir secuencias de bytes como se detalla en la documentación de las funciones de citación de URL individuales.


Distinto en la versión 3.2: Las funciones de análisis de URL ahora aceptan secuencias de bytes codificadas en ASCII


@node Resultados del análisis estructurado,Cita de URL,Análisis de bytes codificados ASCII,urllib parse — Parse URLs into components
@anchor{library/urllib parse structured-parse-results}@anchor{395a}@anchor{library/urllib parse urlparse-result-object}@anchor{3955}
@subsubsection Resultados del análisis estructurado


Los objetos resultantes de las funciones @ref{207,,urlparse()}, @ref{dc6,,urlsplit()} y @ref{12b5,,urldefrag()} son subclases del tipo @ref{464,,tuple}. Estas subclases agregan los atributos enumerados en la documentación para esas funciones, el soporte de codificación y decodificación descrito en la sección anterior, así como un método adicional:

@geindex geturl() (método de urllib.parse.urllib.parse.SplitResult)
@anchor{library/urllib parse urllib parse urllib parse SplitResult geturl}@anchor{395b}
@deffn {Método} urllib.parse.SplitResult.geturl ()

Retorna la versión re-combinada de la dirección URL original como una cadena. Esto puede diferir de la dirección URL original en que el esquema se puede normalizar a minúsculas y los componentes vacíos pueden descartarse. En concreto, se quitarán los parámetros vacíos, las consultas y los identificadores de fragmento.

Para los resultados @ref{12b5,,urldefrag()}, solo se eliminarán los identificadores de fragmento vacíos. Para los resultados @ref{dc6,,urlsplit()} y @ref{207,,urlparse()}, todos los cambios observados se realizarán en la URL retornada por este método.

El resultado de este método permanece inalterado si se pasa de nuevo a través de la función de análisis original:

@example
>>> from urllib.parse import urlsplit
>>> url = 'HTTP://www.Python.org/doc/#'
>>> r1 = urlsplit(url)
>>> r1.geturl()
'http://www.Python.org/doc/'
>>> r2 = urlsplit(r1.geturl())
>>> r2.geturl()
'http://www.Python.org/doc/'
@end example
@end deffn

Las clases siguientes proporcionan las implementaciones de los resultados del análisis estructurado cuando se opera en objetos @ref{237,,str}:

@geindex DefragResult (clase en urllib.parse)
@anchor{library/urllib parse urllib parse DefragResult}@anchor{395c}
@deffn {Clase} urllib.parse.DefragResult (url, fragment)

Clase concreta para los resultados de @ref{12b5,,urldefrag()} que contienen datos @ref{237,,str}. El método @code{encode()} retorna una instancia @ref{395d,,DefragResultBytes}.


Added in version 3.2.

@end deffn

@geindex ParseResult (clase en urllib.parse)
@anchor{library/urllib parse urllib parse ParseResult}@anchor{395e}
@deffn {Clase} urllib.parse.ParseResult (scheme, netloc, path, params, query, fragment)

Clase concreta para los resultados de @ref{207,,urlparse()} que contiene @ref{237,,str} data. El método @code{encode()} retorna una instancia @ref{395f,,ParseResultBytes}.
@end deffn

@geindex SplitResult (clase en urllib.parse)
@anchor{library/urllib parse urllib parse SplitResult}@anchor{3960}
@deffn {Clase} urllib.parse.SplitResult (scheme, netloc, path, query, fragment)

Clase concreta para los resultados de @ref{dc6,,urlsplit()} que contiene @ref{237,,str} data. El método @code{encode()} retorna una instancia @ref{3961,,SplitResultBytes}.
@end deffn

Las clases siguientes proporcionan las implementaciones de los resultados del análisis cuando se opera en objetos @ref{325,,bytes} o @ref{5e0,,bytearray}:

@geindex DefragResultBytes (clase en urllib.parse)
@anchor{library/urllib parse urllib parse DefragResultBytes}@anchor{395d}
@deffn {Clase} urllib.parse.DefragResultBytes (url, fragment)

Clase concreta para los resultados de @ref{12b5,,urldefrag()} que contienen datos @ref{325,,bytes}. El método @code{decode()} retorna una instancia @ref{395c,,DefragResult}.


Added in version 3.2.

@end deffn

@geindex ParseResultBytes (clase en urllib.parse)
@anchor{library/urllib parse urllib parse ParseResultBytes}@anchor{395f}
@deffn {Clase} urllib.parse.ParseResultBytes (scheme, netloc, path, params, query, fragment)

Clase concreta para los resultados @ref{207,,urlparse()} que contienen datos @ref{325,,bytes}. El método @code{decode()} retorna una instancia @ref{395e,,ParseResult}.


Added in version 3.2.

@end deffn

@geindex SplitResultBytes (clase en urllib.parse)
@anchor{library/urllib parse urllib parse SplitResultBytes}@anchor{3961}
@deffn {Clase} urllib.parse.SplitResultBytes (scheme, netloc, path, query, fragment)

Clase concreta para los resultados de @ref{dc6,,urlsplit()} que contienen datos @ref{325,,bytes}. El método @code{decode()} retorna una instancia @ref{3960,,SplitResult}.


Added in version 3.2.

@end deffn

@node Cita de URL,,Resultados del análisis estructurado,urllib parse — Parse URLs into components
@anchor{library/urllib parse url-quoting}@anchor{3962}
@subsubsection Cita de URL


Las funciones de citación de URL se centran en tomar datos del programa y hacerlos seguros para su uso como componentes URL citando caracteres especiales y codificando adecuadamente texto no ASCII. También admiten la inversión de estas operaciones para volver a crear los datos originales a partir del contenido de un componente de dirección URL si esa tarea aún no está cubierta por las funciones de análisis de URL anteriores.

@geindex quote() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote}@anchor{c2b}
@deffn {Función} urllib.parse.quote (string, safe='/', encoding=None, errors=None)

Reemplaza caracteres especiales en `string' con la secuencia de escape @code{%@var{xx}}. Las letras, los dígitos y los caracteres @code{'_.-~'} nunca se citan. De forma predeterminada, esta función está pensada para citar la sección de ruta de acceso de la dirección URL. El parámetro opcional `safe' especifica caracteres ASCII adicionales que no se deben citar — su valor predeterminado es @code{'/'}.

`string' puede ser un objeto @ref{237,,str} o @ref{325,,bytes}.


Distinto en la versión 3.7: Se ha movido de 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} a 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} para citar cadenas URL. Ahora se incluye «~» en el conjunto de caracteres reservados.


Los parámetros opcionales `encoding' y `errors' especifican cómo tratar con caracteres no ASCII, tal como lo acepta el método @ref{96c,,str.encode()}. `encoding' por defecto es @code{'utf-8'}. `errors' tiene como valor predeterminado @code{'strict'}, lo que significa que los caracteres no admitidos generan un @ref{718,,UnicodeEncodeError}. `encoding' y `errors' no se deben proporcionar si `string' es @ref{325,,bytes} o se genera @ref{228,,TypeError}.

Tenga en cuenta que @code{quote(string, safe, encoding, errors)} es equivalente a @code{quote_from_bytes(string.encode(encoding, errors), safe)}.

Ejemplo: @code{quote('/El Niño/')} produce @code{'/El%20Ni%C3%B1o/'}.
@end deffn

@geindex quote_plus() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote_plus}@anchor{12b6}
@deffn {Función} urllib.parse.quote_plus (string, safe='@w{'}, encoding=None, errors=None)

Como @ref{c2b,,quote()}, pero también reemplaza espacios con signos más, como se requiere para citar valores de formularios HTML al momento de construir una cadena de consulta que será parte de una URL. Los signos más en la cadena de caracteres original se escapan, a no ser que se incluyan en `safe'. Además el valor de `safe' no es @cite{/} por defecto.

Ejemplo: @code{quote_plus('/El Niño/')} produce @code{'%2FEl+Ni%C3%B1o%2F'}.
@end deffn

@geindex quote_from_bytes() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote_from_bytes}@anchor{17cd}
@deffn {Función} urllib.parse.quote_from_bytes (bytes, safe='/')

Como @ref{c2b,,quote()}, pero acepta un objeto @ref{325,,bytes} en lugar de un @ref{237,,str}, y no realiza la codificación de cadena a bytes.

Ejemplo: @code{quote_from_bytes(b'a&\xef')} produce @code{'a%26%EF'}.
@end deffn

@geindex unquote() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote}@anchor{178e}
@deffn {Función} urllib.parse.unquote (string, encoding='utf-8', errors='replace')

Reemplaza secuencias de escape @code{%@var{xx}} con los caracteres individuales correspondientes. Los parámetros opcionales `encoding' y `errors' especifican cómo descodificar secuencias codificadas porcentualmente a caracteres Unicode, tal como lo acepta el método @ref{96d,,bytes.decode()}.

`string' puede ser un objeto @ref{237,,str} o @ref{325,,bytes}.

`encoding' por defecto es @code{'utf-8}”. `errors' por defecto es @code{'replace}”, lo que significa que las secuencias no válidas se reemplazan por un carácter de marcador de posición.

Ejemplo: @code{unquote('/El%20Ni%C3%B1o/')} produce @code{'/El Niño/'}.


Distinto en la versión 3.9: El parámetro `string' admite bytes y cadenas de caracteres (anteriormente sólo cadenas de caracteres).

@end deffn

@geindex unquote_plus() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote_plus}@anchor{3963}
@deffn {Función} urllib.parse.unquote_plus (string, encoding='utf-8', errors='replace')

Como @ref{178e,,unquote()}, pero también reemplaza los signos más por espacios, como es requerido al decodificar valores de formularios HTML.

`string' debe ser @ref{237,,str}.

Ejemplo: @code{unquote_plus('/El+Ni%C3%B1o/')} produce @code{'/El Niño/'}.
@end deffn

@geindex unquote_to_bytes() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote_to_bytes}@anchor{178f}
@deffn {Función} urllib.parse.unquote_to_bytes (string)

Reemplaza los escapes @code{%@var{xx}} por sus equivalentes de un solo octeto y retorna un objeto @ref{325,,bytes}.

`string' puede ser un objeto @ref{237,,str} o @ref{325,,bytes}.

Si es un @ref{237,,str}, los caracteres no ASCII sin escapar en `string' se codifican en bytes UTF-8.

Ejemplo: @code{unquote_to_bytes('a%26%EF')} produce @code{b'a&\xef'}.
@end deffn

@geindex urlencode() (en el módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlencode}@anchor{f16}
@deffn {Función} urllib.parse.urlencode (query, doseq=False, safe='@w{'}, encoding=None, errors=None, quote_via=quote_plus)

Convierta un objeto de asignación o una secuencia de tuplas de dos elementos, que pueden contener objetos @ref{237,,str} o @ref{325,,bytes}, en una cadena de texto ASCII codificada porcentualmente.  Si la cadena resultante se va a utilizar como una operación `data' para post con la función @code{URLlib.request.urlopen()}, entonces debe codificarse en bytes, de lo contrario resultaría en un @ref{228,,TypeError}.

La cadena resultante es una serie de pares @code{key=value} separados por caracteres @code{'&'}, donde tanto `key' como `value' se citan mediante la función `quote_via'.  De forma predeterminada, @ref{12b6,,quote_plus()} se utiliza para citar los valores, lo que significa que los espacios se citan como un carácter @code{'+'} y “/” los caracteres se codifican como @code{%2F}, que sigue el estándar para las solicitudes GET (@code{application/x-www-form-urlencoded}).  Una función alternativa que se puede pasar como `quote_via' es @ref{c2b,,quote()}, que codificará espacios como @code{%20} y no codificará caracteres “/”.  Para obtener el máximo control de lo que se cita, utilice @code{quote} y especifique un valor para `safe'.

Cuando se utiliza una secuencia de tuplas de dos elementos como argumento `query', el primer elemento de cada tupla es una clave y el segundo es un valor. El valor en sí mismo puede ser una secuencia y, en ese caso, si el parámetro opcional `doseq' se evalúa como @code{True}, se generan pares individuales @code{key=value} separados por @code{'&'} para cada elemento de la secuencia de valores de la clave.  El orden de los parámetros de la cadena codificada coincidirá con el orden de las tuplas de parámetros de la secuencia.

Los parámetros `safe', `encoding' y `errors' se pasan a `quote_via' (los parámetros `encoding' y `errors' solo se pasan cuando un elemento de consulta es @ref{237,,str}).

Para revertir este proceso de codificación, en este módulo se proporcionan @ref{1c9,,parse_qs()} y @ref{1c8,,parse_qsl()} para analizar cadenas de consulta en estructuras de datos de Python.

Consulte @ref{3941,,urllib examples} para averiguar cómo se puede utilizar el método  @ref{f16,,urllib.parse.urlencode()} para generar una cadena de consulta para una dirección URL o datos para POST.


Distinto en la versión 3.2: El parámetro `query' admite bytes y objetos de cadena.



Distinto en la versión 3.5: Added the `quote_via' parameter.



Obsoleto desde la versión 3.14: Accepting objects with false values (like @code{0} and @code{[]}) except empty
strings and byte-like objects and @code{None} is now deprecated.

@end deffn


@subsubheading Ver también



@table @asis

@item WHATWG@footnote{https://url.spec.whatwg.org/} -  URL estándar actual

Grupo de trabajo para el estándar URL que define URLs, dominio, dirección IP, formato `application/x-www-form-urlencoded' y su API.

@geindex RFC; RFC 3986

@item RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} - Identificadores uniformes de recursos

Este es el estándar actual (STD66). Cualquier cambio en el módulo urllib.parse debe ajustarse a esto. Se podrían observar ciertas desviaciones, que son principalmente para fines de compatibilidad con versiones anteriores y para ciertos requisitos de análisis de facto como se observa comúnmente en los principales navegadores.

@geindex RFC; RFC 2732

@item RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} - Formato de direcciones IPv6 literales en URL.

Esto especifica los requisitos de análisis de las direcciones URL IPv6.

@geindex RFC; RFC 2396

@item RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} - Identificadores uniformes de recursos (URI): Sintaxis genérica

Documento que describe los requisitos sintácticos genéricos para los nombres de recursos uniformes (URL) y los localizadores uniformes de recursos (URL).

@geindex RFC; RFC 2368

@item RFC 2368@footnote{https://datatracker.ietf.org/doc/html/rfc2368.html} - El esquema mailto URL.

Análisis de requisitos para esquemas de URL de correo a correo.

@geindex RFC; RFC 1808

@item RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} - Localizadores uniformes de recursos relativos

Esta solicitud de comentarios incluye las reglas para unirse a una URL absoluta y relativa, incluyendo un buen número de «Ejemplos anormales» que rigen el tratamiento de los casos fronterizos.

@geindex RFC; RFC 1738

@item RFC 1738@footnote{https://datatracker.ietf.org/doc/html/rfc1738.html} - Localizadores uniformes de recursos (URL)

Esto especifica la sintaxis formal y la semántica de las direcciones URL absolutas.
@end table


@node urllib error — Exception classes raised by urllib request,urllib robotparser — Parser for robots txt,urllib parse — Parse URLs into components,Protocolos y soporte de Internet
@anchor{library/urllib error doc}@anchor{3964}@anchor{library/urllib error module-urllib error}@anchor{109}@anchor{library/urllib error urllib-error-exception-classes-raised-by-urllib-request}@anchor{3965}
@subsection @code{urllib.error} — Exception classes raised by urllib.request


@geindex module; urllib.error

`Código fuente:' Lib/urllib/error.py@footnote{https://github.com/python/cpython/tree/main/Lib/urllib/error.py}


__________________________________________________________________


El módulo @ref{109,,urllib.error} define las clases de excepción para las excepciones lanzadas por @ref{10b,,urllib.request}. La clase de excepción base es @ref{38cb,,URLError}.

Las siguientes excepciones son lanzadas por @ref{109,,urllib.error} según sea apropiado:

@geindex URLError
@anchor{library/urllib error urllib error URLError}@anchor{38cb}
@deffn {Excepción} urllib.error.URLError

Los gestores lanzan esta excepción (o excepciones derivadas) cuando encuentran un problema. Es una subclase de @ref{4d5,,OSError}.

@geindex reason (atributo de urllib.error.URLError)
@anchor{library/urllib error urllib error URLError reason}@anchor{3966}
@deffn {Atributo} reason

El motivo de este error. Puede ser una cadena de mensaje u otra instancia de una excepción.
@end deffn


Distinto en la versión 3.3: @ref{38cb,,URLError} used to be a subtype of @ref{10ce,,IOError}, which is now an
alias of @ref{4d5,,OSError}.

@end deffn

@geindex HTTPError
@anchor{library/urllib error urllib error HTTPError}@anchor{105d}
@deffn {Excepción} urllib.error.HTTPError (url, code, msg, hdrs, fp)

A pesar de ser una excepción (una subclase de @ref{38cb,,URLError}), un @ref{105d,,HTTPError} también puede funcionar como un valor de retorno no excepcional de tipo archivo (lo mismo que retorna @ref{20a,,urlopen()}). Esto es útil para gestionar errores HTTP exóticos, como peticiones de autentificación.

@geindex url (atributo de urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError url}@anchor{3967}
@deffn {Atributo} url

Contiene la URL de la solicitud. Un alias para el atributo `filename'.
@end deffn

@geindex code (atributo de urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError code}@anchor{3968}
@deffn {Atributo} code

Un código de estado HTTP como los definidos en 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. Este valor numérico se corresponde con un valor de un diccionario de códigos como el que hay en @ref{3969,,http.server.BaseHTTPRequestHandler.responses}.
@end deffn

@geindex reason (atributo de urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError reason}@anchor{396a}
@deffn {Atributo} reason

Normalmente esto es una cadena de caracteres que explica el motivo de este error. Un alias para el atributo `msg'.
@end deffn

@geindex headers (atributo de urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError headers}@anchor{105e}
@deffn {Atributo} headers

Las cabeceras de la respuesta HTTP de la petición HTTP que causó el @ref{105d,,HTTPError}. Un alias para el atributo `hdrs'.


Added in version 3.4.

@end deffn

@geindex fp (atributo de urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError fp}@anchor{396b}
@deffn {Atributo} fp

Un objeto similar a un archivo donde se puede leer el cuerpo del error HTTP.
@end deffn
@end deffn

@geindex ContentTooShortError
@anchor{library/urllib error urllib error ContentTooShortError}@anchor{3944}
@deffn {Excepción} urllib.error.ContentTooShortError (msg, content)

Esta excepción se lanza cuando la función @ref{3943,,urlretrieve()} detecta que la cantidad de datos descargados es menor que la esperada (dada por la cabecera `Content-Length').

@geindex content (atributo de urllib.error.ContentTooShortError)
@anchor{library/urllib error urllib error ContentTooShortError content}@anchor{396c}
@deffn {Atributo} content

Los datos descargados (y supuestamente truncados).
@end deffn
@end deffn

@node urllib robotparser — Parser for robots txt,http — HTTP modules,urllib error — Exception classes raised by urllib request,Protocolos y soporte de Internet
@anchor{library/urllib robotparser doc}@anchor{396d}@anchor{library/urllib robotparser module-urllib robotparser}@anchor{10d}@anchor{library/urllib robotparser urllib-robotparser-parser-for-robots-txt}@anchor{396e}
@subsection @code{urllib.robotparser} —  Parser for robots.txt


@geindex module; urllib.robotparser

`Código fuente:' Lib/urllib/robotparser.py@footnote{https://github.com/python/cpython/tree/main/Lib/urllib/robotparser.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex robots.txt


__________________________________________________________________


Este módulo proporciona una clase única, @ref{d84,,RobotFileParser}, que responde preguntas sobre si un agente de usuario en particular puede obtener una URL en el sitio web que publicó el archivo @code{robots.txt}. Para obtener más detalles sobre la estructura de los archivos @code{robots.txt}, consulte @indicateurl{http://www.robotstxt.org/orig.html}.

@geindex RobotFileParser (clase en urllib.robotparser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser}@anchor{d84}
@deffn {Clase} urllib.robotparser.RobotFileParser (url='@w{'})

Esta clase proporciona métodos para leer, analizar y responder preguntas acerca de @code{robots.txt}

@geindex set_url() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser set_url}@anchor{396f}
@deffn {Método} set_url (url)

Establece la URL que hace referencia a un archivo @code{robots.txt}.
@end deffn

@geindex read() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser read}@anchor{3970}
@deffn {Método} read ()

Lee la URL @code{robots.txt} y la envía al analizador.
@end deffn

@geindex parse() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser parse}@anchor{1aa9}
@deffn {Método} parse (lines)

Analiza el argumento `lines'.
@end deffn

@geindex can_fetch() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser can_fetch}@anchor{3971}
@deffn {Método} can_fetch (useragent, url)

Retorna @code{True} si el `useragent' tiene permiso para buscar la `url' de acuerdo con las reglas contenidas en el archivo @code{robots.txt} analizado.
@end deffn

@geindex mtime() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser mtime}@anchor{3972}
@deffn {Método} mtime ()

Retorna la hora en que se recuperó por última vez el archivo @code{robots.txt}. Esto es útil para arañas web de larga duración que necesitan buscar nuevos archivos @code{robots.txt} periódicamente.
@end deffn

@geindex modified() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser modified}@anchor{3973}
@deffn {Método} modified ()

Establece la hora a la que se recuperó por última vez el archivo @code{robots.txt} hasta la hora actual.
@end deffn

@geindex crawl_delay() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser crawl_delay}@anchor{3974}
@deffn {Método} crawl_delay (useragent)

Retorna el valor del parámetro @code{Crawl-delay} de @code{robots.txt} para el `useragent' en cuestión. Si no existe tal parámetro o no se aplica al `useragent' especificado o la entrada @code{robots.txt} para este parámetro tiene una sintaxis no válida, devuelve @code{None}.


Added in version 3.6.

@end deffn

@geindex request_rate() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser request_rate}@anchor{3975}
@deffn {Método} request_rate (useragent)

Retorna el contenido del parámetro @code{Request-rate} de @code{robots.txt} como una @ref{6ef,,tupla nombrada} @code{RequestRate(requests, seconds)}. Si no existe tal parámetro o no se aplica al `useragent' especificado o la entrada @code{robots.txt} para este parámetro tiene una sintaxis no válida, devuelve @code{None}.


Added in version 3.6.

@end deffn

@geindex site_maps() (método de urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser site_maps}@anchor{1a48}
@deffn {Método} site_maps ()

Retorna el contenido del parámetro @code{Sitemap} de @code{robots.txt} en forma de @ref{18e,,list()}. Si no existe tal parámetro o la entrada @code{robots.txt} para este parámetro tiene una sintaxis no válida, devuelve @code{None}.


Added in version 3.8.

@end deffn
@end deffn

El siguiente ejemplo demuestra el uso básico de la clase @ref{d84,,RobotFileParser}:

@example
>>> import urllib.robotparser
>>> rp = urllib.robotparser.RobotFileParser()
>>> rp.set_url("http://www.musi-cal.com/robots.txt")
>>> rp.read()
>>> rrate = rp.request_rate("*")
>>> rrate.requests
3
>>> rrate.seconds
20
>>> rp.crawl_delay("*")
6
>>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco")
False
>>> rp.can_fetch("*", "http://www.musi-cal.com/")
True
@end example

@node http — HTTP modules,http client — HTTP protocol client,urllib robotparser — Parser for robots txt,Protocolos y soporte de Internet
@anchor{library/http doc}@anchor{3976}@anchor{library/http http-http-modules}@anchor{3977}@anchor{library/http module-http}@anchor{6e}
@subsection @code{http} — HTTP modules


@geindex module; http

`Código fuente:' Lib/http/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/__init__.py}

@geindex HTTP;protocol
@geindex HTTP;http (standard module)


__________________________________________________________________


@ref{6e,,http} es un paquete que recopila varios módulos para trabajar con el Protocolo de transferencia de hipertexto:


@itemize *

@item 
@ref{6f,,http.client} es un cliente del protocolo HTTP de bajo nivel; para la apertura de URL de alto nivel use @ref{10b,,urllib.request}

@item 
@ref{72,,http.server} contiene clases de servidor HTTP básicas basadas en @ref{cd,,socketserver}

@item 
@ref{71,,http.cookies} tiene utilidades para implementar la gestión de estados mediante cookies

@item 
@ref{70,,http.cookiejar} provee persistencia de cookies
@end itemize

El módulo @ref{6e,,http} también define las siguientes enumeraciones que lo ayudan a trabajar con código relacionado con http:

@geindex HTTPStatus (clase en http)
@anchor{library/http http HTTPStatus}@anchor{996}
@deffn {Clase} http.HTTPStatus


Added in version 3.5.


Una subclase de @ref{d66,,enum.IntEnum} que define un conjunto de códigos de estado HTTP, frases de motivo y descripciones largas escritas en inglés.

Uso:

@example
>>> from http import HTTPStatus
>>> HTTPStatus.OK
HTTPStatus.OK
>>> HTTPStatus.OK == 200
True
>>> HTTPStatus.OK.value
200
>>> HTTPStatus.OK.phrase
'OK'
>>> HTTPStatus.OK.description
'Request fulfilled, document follows'
>>> list(HTTPStatus)
[HTTPStatus.CONTINUE, HTTPStatus.SWITCHING_PROTOCOLS, ...]
@end example
@end deffn

@menu
* Códigos de estado HTTP:: 
* Categoría de estado HTTP:: 
* Métodos HTTP:: 

@end menu

@node Códigos de estado HTTP,Categoría de estado HTTP,,http — HTTP modules
@anchor{library/http http-status-codes}@anchor{3978}@anchor{library/http id1}@anchor{3979}
@subsubsection Códigos de estado HTTP


Los códigos de estado registrados por IANA@footnote{https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml} disponibles en @ref{996,,http.HTTPStatus} son:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código

@tab

Nombre de la enumeración

@tab

Detalle

@item

@code{100}

@tab

@code{CONTINUE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.2.1

@item

@code{101}

@tab

@code{SWITCHING_PROTOCOLS}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.2.2

@item

@code{102}

@tab

@code{PROCESSING}

@tab

WebDAV 
@geindex RFC; RFC 2518
RFC 2518@footnote{https://datatracker.ietf.org/doc/html/rfc2518.html}, Sección 10.1

@item

@code{103}

@tab

@code{EARLY_HINTS}

@tab

Un código de estado HTTP para indicar pistas 
@geindex RFC; RFC 8297
RFC 8297@footnote{https://datatracker.ietf.org/doc/html/rfc8297.html}

@item

@code{200}

@tab

@code{OK}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.1

@item

@code{201}

@tab

@code{CREATED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.2

@item

@code{202}

@tab

@code{ACCEPTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.3

@item

@code{203}

@tab

@code{NON_AUTHORITATIVE_INFORMATION}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.4

@item

@code{204}

@tab

@code{NO_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.5

@item

@code{205}

@tab

@code{RESET_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.6

@item

@code{206}

@tab

@code{PARTIAL_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.7

@item

@code{207}

@tab

@code{MULTI_STATUS}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Sección 11.1

@item

@code{208}

@tab

@code{ALREADY_REPORTED}

@tab

Extensiones de enlace a WebDAV 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Sección 7.1 (Experimental)

@item

@code{226}

@tab

@code{IM_USED}

@tab

Codificación delta en HTTP 
@geindex RFC; RFC 3229
RFC 3229@footnote{https://datatracker.ietf.org/doc/html/rfc3229.html}, Sección 10.4.1

@item

@code{300}

@tab

@code{MULTIPLE_CHOICES}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.1

@item

@code{301}

@tab

@code{MOVED_PERMANENTLY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.2

@item

@code{302}

@tab

@code{FOUND}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.3

@item

@code{303}

@tab

@code{SEE_OTHER}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.4

@item

@code{304}

@tab

@code{NOT_MODIFIED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.5

@item

@code{305}

@tab

@code{USE_PROXY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.6

@item

@code{307}

@tab

@code{TEMPORARY_REDIRECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.8

@item

@code{308}

@tab

@code{PERMANENT_REDIRECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.9

@item

@code{400}

@tab

@code{BAD_REQUEST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.1

@item

@code{401}

@tab

@code{UNAUTHORIZED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.2

@item

@code{402}

@tab

@code{PAYMENT_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.3

@item

@code{403}

@tab

@code{FORBIDDEN}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.4

@item

@code{404}

@tab

@code{NOT_FOUND}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.5

@item

@code{405}

@tab

@code{METHOD_NOT_ALLOWED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.6

@item

@code{406}

@tab

@code{NOT_ACCEPTABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.7

@item

@code{407}

@tab

@code{PROXY_AUTHENTICATION_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.8

@item

@code{408}

@tab

@code{REQUEST_TIMEOUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.9

@item

@code{409}

@tab

@code{CONFLICT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.10

@item

@code{410}

@tab

@code{GONE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.11

@item

@code{411}

@tab

@code{LENGTH_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.12

@item

@code{412}

@tab

@code{PRECONDITION_FAILED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.13

@item

@code{413}

@tab

@code{CONTENT_TOO_LARGE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.14

@item

@code{414}

@tab

@code{URI_TOO_LONG}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.15

@item

@code{415}

@tab

@code{UNSUPPORTED_MEDIA_TYPE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.16

@item

@code{416}

@tab

@code{RANGE_NOT_SATISFIABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.17

@item

@code{417}

@tab

@code{EXPECTATION_FAILED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.18

@item

@code{418}

@tab

@code{IM_A_TEAPOT}

@tab

HTCPCP/1.0 
@geindex RFC; RFC 2324
RFC 2324@footnote{https://datatracker.ietf.org/doc/html/rfc2324.html}, Sección 2.3.2

@item

@code{421}

@tab

@code{MISDIRECTED_REQUEST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.20

@item

@code{422}

@tab

@code{UNPROCESSABLE_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.21

@item

@code{423}

@tab

@code{LOCKED}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Sección 11.3

@item

@code{424}

@tab

@code{FAILED_DEPENDENCY}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Sección 11.4

@item

@code{425}

@tab

@code{TOO_EARLY}

@tab

Uso de datos iniciales en HTTP 
@geindex RFC; RFC 8470
RFC 8470@footnote{https://datatracker.ietf.org/doc/html/rfc8470.html}

@item

@code{426}

@tab

@code{UPGRADE_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.22

@item

@code{428}

@tab

@code{PRECONDITION_REQUIRED}

@tab

Códigos de estados HTTP adicionales 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{429}

@tab

@code{TOO_MANY_REQUESTS}

@tab

Códigos de estados HTTP adicionales 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{431}

@tab

@code{REQUEST_HEADER_FIELDS_TOO_LARGE}

@tab

Códigos de estados HTTP adicionales 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{451}

@tab

@code{UNAVAILABLE_FOR_LEGAL_REASONS}

@tab

Un código de estado HTTP para reportar obstáculos legales 
@geindex RFC; RFC 7725
RFC 7725@footnote{https://datatracker.ietf.org/doc/html/rfc7725.html}

@item

@code{500}

@tab

@code{INTERNAL_SERVER_ERROR}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.1

@item

@code{501}

@tab

@code{NOT_IMPLEMENTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.2

@item

@code{502}

@tab

@code{BAD_GATEWAY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.3

@item

@code{503}

@tab

@code{SERVICE_UNAVAILABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.4

@item

@code{504}

@tab

@code{GATEWAY_TIMEOUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.5

@item

@code{505}

@tab

@code{HTTP_VERSION_NOT_SUPPORTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.6

@item

@code{506}

@tab

@code{VARIANT_ALSO_NEGOTIATES}

@tab

Negociación transparente de contenido en HTTP 
@geindex RFC; RFC 2295
RFC 2295@footnote{https://datatracker.ietf.org/doc/html/rfc2295.html}, Sección 8.1 (Experimental)

@item

@code{507}

@tab

@code{INSUFFICIENT_STORAGE}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Sección 11.5

@item

@code{508}

@tab

@code{LOOP_DETECTED}

@tab

Extensiones de unión WebDAV 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Sección 7.2 (Experimental)

@item

@code{510}

@tab

@code{NOT_EXTENDED}

@tab

Un framework de extensión HTTP 
@geindex RFC; RFC 2774
RFC 2774@footnote{https://datatracker.ietf.org/doc/html/rfc2774.html}, Sección 7 (Experimental)

@item

@code{511}

@tab

@code{NETWORK_AUTHENTICATION_REQUIRED}

@tab

Códigos de estados HTTP adicionales 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}, Sección 6

@end multitable


Con el fin de preservar la compatibilidad con versiones anteriores, los valores de la enumeración están también presentes en el módulo @ref{6f,,http.client} en forma de constantes. El nombre de la enumeración es el mismo que el nombre de la constante (ej. @code{http.HTTPStatus.OK} se encuentra también disponible como @code{http.client.OK}).


Distinto en la versión 3.7: Se agregó el código de estado @code{421 MISDIRECTED_REQUEST}.



Added in version 3.8: Se agregó el código de estado @code{451 UNAVAILABLE_FOR_LEGAL_REASONS}.



Added in version 3.9: Agregados códigos de estado @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} y @code{425 TOO_EARLY}.



Distinto en la versión 3.13: Implemented RFC9110 naming for status constants. Old constant names are preserved for
backwards compatibility.


@node Categoría de estado HTTP,Métodos HTTP,Códigos de estado HTTP,http — HTTP modules
@anchor{library/http http-status-category}@anchor{397a}
@subsubsection Categoría de estado HTTP



Added in version 3.12.


Los valores enum tienen varias propiedades para indicar la categoría de estado HTTP:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Propiedad

@tab

Indica que

@tab

Detalle

@item

@code{is_informational}

@tab

@code{100 <= status <= 199}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_success}

@tab

@code{200 <= status <= 299}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_redirection}

@tab

@code{300 <= status <= 399}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_client_error}

@tab

@code{400 <= status <= 499}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_server_error}

@tab

@code{500 <= status <= 599}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@end multitable


@quotation

Uso:

@example
>>> from http import HTTPStatus
>>> HTTPStatus.OK.is_success
True
>>> HTTPStatus.OK.is_client_error
False
@end example
@end quotation

@geindex HTTPMethod (clase en http)
@anchor{library/http http HTTPMethod}@anchor{397b}
@deffn {Clase} http.HTTPMethod


Added in version 3.11.


Una subclase de @ref{6bb,,enum.StrEnum} que define un conjunto de métodos  HTTP y sus descripciones escritas en inglés.

Uso:

@example
>>> from http import HTTPMethod
>>>
>>> HTTPMethod.GET
<HTTPMethod.GET>
>>> HTTPMethod.GET == 'GET'
True
>>> HTTPMethod.GET.value
'GET'
>>> HTTPMethod.GET.description
'Retrieve the target.'
>>> list(HTTPMethod)
[<HTTPMethod.CONNECT>,
 <HTTPMethod.DELETE>,
 <HTTPMethod.GET>,
 <HTTPMethod.HEAD>,
 <HTTPMethod.OPTIONS>,
 <HTTPMethod.PATCH>,
 <HTTPMethod.POST>,
 <HTTPMethod.PUT>,
 <HTTPMethod.TRACE>]
@end example
@end deffn

@node Métodos HTTP,,Categoría de estado HTTP,http — HTTP modules
@anchor{library/http http-methods}@anchor{397c}@anchor{library/http id2}@anchor{397d}
@subsubsection Métodos HTTP


Los  métodos registrados por IANA@footnote{https://www.iana.org/assignments/http-methods/http-methods.xhtml} disponibles en @ref{397b,,http.HTTPMethod} son:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Nombre de la enumeración

@tab

Detalle

@item

@code{GET}

@tab

@code{GET}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.1

@item

@code{HEAD}

@tab

@code{HEAD}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.2

@item

@code{POST}

@tab

@code{POST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.3

@item

@code{PUT}

@tab

@code{PUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.4

@item

@code{DELETE}

@tab

@code{DELETE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.5

@item

@code{CONNECT}

@tab

@code{CONNECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.6

@item

@code{OPTIONS}

@tab

@code{OPTIONS}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.7

@item

@code{TRACE}

@tab

@code{TRACE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.8

@item

@code{PATCH}

@tab

@code{PATCH}

@tab

HTTP/1.1 
@geindex RFC; RFC 5789
RFC 5789@footnote{https://datatracker.ietf.org/doc/html/rfc5789.html}

@end multitable


@node http client — HTTP protocol client,ftplib — FTP protocol client,http — HTTP modules,Protocolos y soporte de Internet
@anchor{library/http client doc}@anchor{397e}@anchor{library/http client http-client-http-protocol-client}@anchor{397f}@anchor{library/http client module-http client}@anchor{6f}
@subsection @code{http.client} — HTTP protocol client


@geindex module; http.client

`Código fuente:' Lib/http/client.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/client.py}

@geindex HTTP;protocol
@geindex HTTP;http.client (standard module)

@geindex module;urllib.request


__________________________________________________________________


Este módulo define clases que implementan el lado del cliente de los protocolos HTTP y HTTPS. Normalmente no se usa directamente — el módulo @ref{10b,,urllib.request} lo usa para gestionar URLs que utilizan HTTP y HTTPS.


@subsubheading Ver también


The Requests package@footnote{https://requests.readthedocs.io/en/latest/}
is recommended for a higher-level HTTP client interface.


@cartouche
@quotation Nota 
El soporte HTTPS solo está disponible si Python se compiló con soporte SSL (a través del módulo @ref{d0,,ssl}).
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo proporciona las siguientes clases:

@geindex HTTPConnection (clase en http.client)
@anchor{library/http client http client HTTPConnection}@anchor{bc8}
@deffn {Clase} http.client.HTTPConnection (host, port=None[, timeout], source_address=None, blocksize=8192)

Una instancia @ref{bc8,,HTTPConnection} representa una transacción con un servidor HTTP. Se debe instanciar pasándole un host y un número de puerto opcional. Si no se pasa ningún número de puerto, el puerto se extrae de la cadena de host si tiene la forma @code{host:port}; de lo contrario, se utiliza el puerto HTTP predeterminado (80). Si se proporciona el parámetro opcional `timeout', las operaciones de bloqueo (como los intentos de conexión) expirarán después de esos segundos (si no se proporciona, se usa la configuración de tiempo de espera global predeterminada). El parámetro opcional `source_address' puede ser una tupla de un (host, puerto) para usar como la dirección de origen desde la que se realiza la conexión HTTP. El parámetro opcional `blocksize' establece el tamaño del búfer en bytes para enviar un cuerpo de mensaje similar a un archivo.

Por ejemplo, las siguientes llamadas crean instancias que se conectan al servidor en el mismo host y puerto:

@example
>>> h1 = http.client.HTTPConnection('www.python.org')
>>> h2 = http.client.HTTPConnection('www.python.org:80')
>>> h3 = http.client.HTTPConnection('www.python.org', 80)
>>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10)
@end example


Distinto en la versión 3.2: `source_address' fue adicionado.



Distinto en la versión 3.4: Se eliminó el argumento `strict'. Las «Respuestas Simples» de estilo HTTP 0.9 ya no son compatibles.



Distinto en la versión 3.7: argumento `blocksize' fue adicionado.

@end deffn

@geindex HTTPSConnection (clase en http.client)
@anchor{library/http client http client HTTPSConnection}@anchor{bc9}
@deffn {Clase} http.client.HTTPSConnection (host, port=None, *[, timeout], source_address=None, context=None, blocksize=8192)

Una subclase de @ref{bc8,,HTTPConnection} que usa SSL para la comunicación con servidores seguros. El puerto predeterminado es @code{443}. Si se especifica `context', debe ser una instancia de @ref{1fa,,ssl.SSLContext} que describa las diversas opciones de SSL.

Por favor lea @ref{3292,,Consideraciones de seguridad} para obtener más información sobre las mejores prácticas.


Distinto en la versión 3.2: `source_address', `context' y `check_hostname' fueron adicionados.



Distinto en la versión 3.2: This class now supports HTTPS virtual hosts if possible (that is,
if @ref{33c1,,ssl.HAS_SNI} is true).



Distinto en la versión 3.4: Se eliminó el argumento `strict'. Las «Respuestas Simples» de estilo HTTP 0.9 ya no son compatibles.



Distinto en la versión 3.4.3: This class now performs all the necessary certificate and hostname checks
by default. To revert to the previous, unverified, behavior
@code{ssl._create_unverified_context()} can be passed to the `context'
parameter.



Distinto en la versión 3.8: Esta clase ahora habilita TLS 1.3 @ref{ac3,,ssl.SSLContext.post_handshake_auth} para el `context' predeterminado o cuando `cert_file' se pasa con un `context' personalizado.



Distinto en la versión 3.10: This class now sends an ALPN extension with protocol indicator
@code{http/1.1} when no `context' is given. Custom `context' should set
ALPN protocols with @ref{ee4,,set_alpn_protocols()}.



Distinto en la versión 3.12: The deprecated `key_file', `cert_file' and `check_hostname' parameters
have been removed.

@end deffn

@geindex HTTPResponse (clase en http.client)
@anchor{library/http client http client HTTPResponse}@anchor{1142}
@deffn {Clase} http.client.HTTPResponse (sock, debuglevel=0, method=None, url=None)

Clase cuyas instancias se retornan tras una conexión exitosa. No son instancias realizadas directamente por el usuario.


Distinto en la versión 3.4: Se eliminó el argumento `strict'. Las «Respuestas Simples» del estilo HTTP 0.9 ya no están soportadas.

@end deffn

Este módulo proporciona la siguiente función:

@geindex parse_headers() (en el módulo http.client)
@anchor{library/http client http client parse_headers}@anchor{1a50}
@deffn {Función} http.client.parse_headers (fp)

Parse the headers from a file pointer `fp' representing a HTTP
request/response. The file has to be a @ref{735,,BufferedIOBase} reader
(i.e. not text) and must provide a valid 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} style header.

Esta función retorna una instancia de @ref{3980,,http.client.HTTPMessage} que contiene los campos de encabezado, pero no un `payload' (lo mismo que @ref{3981,,HTTPResponse.msg} y @ref{3982,,http.server.BaseHTTPRequestHandler.headers} ) Después de regresar, el puntero de archivo `fp' está listo para leer el cuerpo HTTP.

@cartouche
@quotation Nota 
@ref{1a50,,parse_headers()} no analiza la línea de inicio de un mensaje HTTP; solo analiza las líneas @code{Name: value}. El archivo tiene que estar listo para leer estas líneas de campo, por lo que la primera línea ya debe consumirse antes de llamar a la función.
@end quotation
@end cartouche
@end deffn

Las siguientes excepciones son lanzadas según corresponda:

@geindex HTTPException
@anchor{library/http client http client HTTPException}@anchor{3983}
@deffn {Excepción} http.client.HTTPException

La clase base de las otras excepciones en este módulo. Es una subclase de @ref{a6b,,Exception}.
@end deffn

@geindex NotConnected
@anchor{library/http client http client NotConnected}@anchor{3984}
@deffn {Excepción} http.client.NotConnected

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex InvalidURL
@anchor{library/http client http client InvalidURL}@anchor{3985}
@deffn {Excepción} http.client.InvalidURL

Una subclase de @ref{3983,,HTTPException}, es lanzada si se proporciona un puerto y no es numérico o está vacío.
@end deffn

@geindex UnknownProtocol
@anchor{library/http client http client UnknownProtocol}@anchor{3986}
@deffn {Excepción} http.client.UnknownProtocol

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex UnknownTransferEncoding
@anchor{library/http client http client UnknownTransferEncoding}@anchor{3987}
@deffn {Excepción} http.client.UnknownTransferEncoding

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex UnimplementedFileMode
@anchor{library/http client http client UnimplementedFileMode}@anchor{3988}
@deffn {Excepción} http.client.UnimplementedFileMode

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex IncompleteRead
@anchor{library/http client http client IncompleteRead}@anchor{3989}
@deffn {Excepción} http.client.IncompleteRead

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex ImproperConnectionState
@anchor{library/http client http client ImproperConnectionState}@anchor{398a}
@deffn {Excepción} http.client.ImproperConnectionState

Una subclase de @ref{3983,,HTTPException}.
@end deffn

@geindex CannotSendRequest
@anchor{library/http client http client CannotSendRequest}@anchor{398b}
@deffn {Excepción} http.client.CannotSendRequest

Una subclase de @ref{398a,,ImproperConnectionState}.
@end deffn

@geindex CannotSendHeader
@anchor{library/http client http client CannotSendHeader}@anchor{398c}
@deffn {Excepción} http.client.CannotSendHeader

Una subclase de @ref{398a,,ImproperConnectionState}.
@end deffn

@geindex ResponseNotReady
@anchor{library/http client http client ResponseNotReady}@anchor{398d}
@deffn {Excepción} http.client.ResponseNotReady

Una subclase de @ref{398a,,ImproperConnectionState}.
@end deffn

@geindex BadStatusLine
@anchor{library/http client http client BadStatusLine}@anchor{398e}
@deffn {Excepción} http.client.BadStatusLine

Una subclase de @ref{3983,,HTTPException}. Es lanzada si un servidor responde con un código de estado HTTP que no entendemos.
@end deffn

@geindex LineTooLong
@anchor{library/http client http client LineTooLong}@anchor{398f}
@deffn {Excepción} http.client.LineTooLong

Una subclase de @ref{3983,,HTTPException}. Es lanzada si se recibe una línea excesivamente larga en el protocolo HTTP del servidor.
@end deffn

@geindex RemoteDisconnected
@anchor{library/http client http client RemoteDisconnected}@anchor{e8e}
@deffn {Excepción} http.client.RemoteDisconnected

Una subclase de @ref{10db,,ConnectionResetError} y @ref{398e,,BadStatusLine}. Lanzada por @ref{e8d,,HTTPConnection.getresponse()} cuando el intento de leer la respuesta no produce datos leídos de la conexión, indica que el extremo remoto ha cerrado la conexión.


Added in version 3.5: Previamente, @ref{398e,,BadStatusLine}@code{('@w{'})} fue lanzada.

@end deffn

Las constantes definidas en este módulo son:

@geindex HTTP_PORT (en el módulo http.client)
@anchor{library/http client http client HTTP_PORT}@anchor{3990}
@deffn {Dato} http.client.HTTP_PORT

El puerto predeterminado para el protocolo HTTP (siempre @code{80}).
@end deffn

@geindex HTTPS_PORT (en el módulo http.client)
@anchor{library/http client http client HTTPS_PORT}@anchor{3991}
@deffn {Dato} http.client.HTTPS_PORT

El puerto predeterminado para el protocolo HTTPS (siempre @code{443}).
@end deffn

@geindex responses (en el módulo http.client)
@anchor{library/http client http client responses}@anchor{3992}
@deffn {Dato} http.client.responses

Este diccionario asigna los códigos de estado HTTP 1.1 a los nombres W3C.

Ejemplo: @code{http.client.responses[http.client.NOT_FOUND]} es @code{'Not Found'}.
@end deffn

Consulte @ref{3978,,Códigos de estado HTTP} para obtener una lista de los códigos de estado HTTP que están disponibles en este módulo como constantes.

@menu
* Objetos de HTTPConnection:: 
* Objetos de HTTPResponse:: 
* Ejemplos: Ejemplos<25>. 
* Objetos de HTTPMessage:: 

@end menu

@node Objetos de HTTPConnection,Objetos de HTTPResponse,,http client — HTTP protocol client
@anchor{library/http client httpconnection-objects}@anchor{3993}@anchor{library/http client id1}@anchor{3994}
@subsubsection Objetos de @code{HTTPConnection}


Las instancias @ref{bc8,,HTTPConnection} tienen los siguientes métodos:

@geindex request() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection request}@anchor{d32}
@deffn {Método} HTTPConnection.request (method, url, body=None, headers=@{@}, *, encode_chunked=False)

This will send a request to the server using the HTTP request
method `method' and the request URI `url'. The provided `url' must be
an absolute path to conform with 
@geindex RFC; RFC 2616 Section 5.1.2
RFC 2616 §5.1.2@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2}
(unless connecting to an HTTP proxy server or using the @code{OPTIONS} or
@code{CONNECT} methods).

Si se especifica `body', los datos especificados se envían una vez finalizados los encabezados. Puede ser @ref{237,,str}, un objeto @ref{db4,,bytes-like object}, un objeto @ref{1230,,file object} abierto, o un iterable de @ref{325,,bytes}. Si `body' es una cadena, se codifica como ISO-8859-1, el valor predeterminado para HTTP. Si es un objeto de tipo bytes, los bytes se envían tal cual. Si es un objeto @ref{1230,,file object}, se envía el contenido del archivo; Este objeto de archivo debe soportar al menos el método @code{read()}. Si el objeto de archivo es una instancia de @ref{736,,io.TextIOBase}, los datos retornados por el método @code{read()} se codificarán como ISO-8859-1, de lo contrario, los datos retornados por @code{read()} se envía como está. Si `body' es un iterable, los elementos del iterable se envían tal cual hasta que se agota el iterable.

The `headers' argument should be a mapping of extra HTTP headers to send
with the request. A 
@geindex RFC; RFC 2616 Section 14.23
Host header@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-14.23}
must be provided to conform with 
@geindex RFC; RFC 2616 Section 5.1.2
RFC 2616 §5.1.2@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2}
(unless connecting to an HTTP proxy server or using the @code{OPTIONS} or
@code{CONNECT} methods).

Si `headers' no contiene @code{Content-Length} ni Transfer-Encoding, pero hay un cuerpo de solicitud, uno de esos campos de encabezado se agregará automáticamente. Si `body' es @code{None}, el encabezado @code{Content-Length} se establece en @code{0} para los métodos que esperan un cuerpo (@code{PUT}, @code{POST} y @code{PATCH}) . Si `body' es una cadena de caracteres o un objeto similar a bytes que no es también un @ref{1230,,file}, el encabezado @code{Content-Length} se establece en su longitud. Cualquier otro tipo de `body' (archivos e iterables en general) se codificará en fragmentos, y el encabezado @code{Transfer-Encoding} se establecerá automáticamente en lugar de @code{Content-Length}.

El argumento `encode_chunked' solo es relevante si @code{Transfer-Encoding} se especifica en `headers'. Si `encode_chunked' es @code{False}, el objeto @code{HTTPConnection} supone que toda la codificación es manejada por el código de llamada. Si es @code{True}, el cuerpo estará codificado en fragmentos.

For example, to perform a @code{GET} request to @code{https://docs.python.org/3/}:

@example
>>> import http.client
>>> host = "docs.python.org"
>>> conn = http.client.HTTPSConnection(host)
>>> conn.request("GET", "/3/", headers=@{"Host": host@})
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200 OK
@end example

@cartouche
@quotation Nota 
La codificación de transferencia fragmentada se ha agregado al protocolo HTTP versión 1.1. A menos que se sepa que el servidor HTTP maneja HTTP 1.1, el llamador debe especificar la longitud del contenido o debe pasar un @ref{237,,str} o un objeto similar a bytes que no sea también un archivo como la representación del cuerpo.
@end quotation
@end cartouche


Distinto en la versión 3.2: `body' ahora puede ser un iterable.



Distinto en la versión 3.6: Si ni @code{Content-Length} ni @code{Transfer-Encoding} están configurados en `headers', el archivo y los objetos iterables `body' ahora están codificados en fragmentos. Se agregó el argumento `encode_chunked'. No se intenta determinar la longitud del contenido para los objetos de archivo.

@end deffn

@geindex getresponse() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection getresponse}@anchor{e8d}
@deffn {Método} HTTPConnection.getresponse ()

Debe llamarse después de enviar una solicitud para obtener la respuesta del servidor. Retorna una instancia de @ref{1142,,HTTPResponse}.

@cartouche
@quotation Nota 
Tenga en cuenta que debe haber leído la respuesta completa antes de poder enviar una nueva solicitud al servidor.
@end quotation
@end cartouche


Distinto en la versión 3.5: Si una @ref{e8f,,ConnectionError} o una subclase fue lanzada, el objeto @ref{bc8,,HTTPConnection} estará listo para volver a conectarse cuando se envíe una nueva solicitud.

@end deffn

@geindex set_debuglevel() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection set_debuglevel}@anchor{3995}
@deffn {Método} HTTPConnection.set_debuglevel (level)

Establecer el nivel de depuración. El nivel de depuración predeterminado es @code{0}, lo que significa que no se imprime ninguna salida de depuración. Cualquier valor mayor que @code{0} hará que todos los resultados de depuración definidos actualmente se impriman en `stdout'. El @code{debuglevel} se pasa a cualquier objeto nuevo @ref{1142,,HTTPResponse} que se cree.


Added in version 3.1.

@end deffn

@geindex set_tunnel() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection set_tunnel}@anchor{1295}
@deffn {Método} HTTPConnection.set_tunnel (host, port=None, headers=None)

Configure el host y el puerto para el túnel de conexión HTTP. Esto permite ejecutar la conexión a través de un servidor proxy.

The `host' and `port' arguments specify the endpoint of the tunneled connection
(i.e. the address included in the CONNECT request, `not' the address of the
proxy server).

The `headers' argument should be a mapping of extra HTTP headers to send with
the CONNECT request.

As HTTP/1.1 is used for HTTP CONNECT tunnelling request, as per the RFC@footnote{https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.6}, a HTTP @code{Host:}
header must be provided, matching the authority-form of the request target
provided as the destination for the CONNECT request. If a HTTP @code{Host:}
header is not provided via the headers argument, one is generated and
transmitted automatically.

Por ejemplo, para hacer un túnel a través de un servidor proxy HTTPS que se ejecuta localmente en el puerto 8080, pasaríamos la dirección del proxy al constructor @ref{bc9,,HTTPSConnection}, y la dirección del host al que finalmente queremos llegar al método @ref{1295,,set_tunnel()}:

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("localhost", 8080)
>>> conn.set_tunnel("www.python.org")
>>> conn.request("HEAD","/index.html")
@end example


Added in version 3.2.



Distinto en la versión 3.12: HTTP CONNECT tunnelling requests use protocol HTTP/1.1, upgraded from
protocol HTTP/1.0. @code{Host:} HTTP headers are mandatory for HTTP/1.1, so
one will be automatically generated and transmitted if not provided in
the headers argument.

@end deffn

@geindex get_proxy_response_headers() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection get_proxy_response_headers}@anchor{1708}
@deffn {Método} HTTPConnection.get_proxy_response_headers ()

Returns a dictionary with the headers of the response received from
the proxy server to the CONNECT request.

If the CONNECT request was not sent, the method returns @code{None}.


Added in version 3.12.

@end deffn

@geindex connect() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection connect}@anchor{3996}
@deffn {Método} HTTPConnection.connect ()

Se conecta al servidor especificado cuando el objeto fue creado. Por defecto, esto se llama automáticamente cuando se realiza una solicitud si el cliente aún no tiene una conexión.

Lanza un @ref{18c3,,evento de auditoría} @code{http.client.connect} con los argumentos @code{self}, @code{host}, @code{port}.
@end deffn

@geindex close() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection close}@anchor{3997}
@deffn {Método} HTTPConnection.close ()

Cierre la conexión al servidor.
@end deffn

@geindex blocksize (atributo de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection blocksize}@anchor{3998}
@deffn {Atributo} HTTPConnection.blocksize

Tamaño del búfer en bytes para enviar un archivo como cuerpo del mensaje.


Added in version 3.7.

@end deffn

As an alternative to using the @ref{d32,,request()} method described above, you can
also send your request step by step, by using the four functions below.

@geindex putrequest() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection putrequest}@anchor{3999}
@deffn {Método} HTTPConnection.putrequest (method, url, skip_host=False, skip_accept_encoding=False)

Esta debería ser la primera llamada después de que se haya realizado la conexión al servidor. Envía una línea al servidor que consta de la cadena de caracteres `method', la cadena de caracteres `url' y la versión HTTP (@code{HTTP/1.1}). Para deshabilitar el envío automático de encabezados @code{Host:} o @code{Accept-Encoding:} (por ejemplo, para aceptar codificaciones de contenido adicionales), especifique `skip_host' o `skip_accept_encoding' con valores no Falsos.
@end deffn

@geindex putheader() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection putheader}@anchor{399a}
@deffn {Método} HTTPConnection.putheader (header, argument[, ...])

Envía un encabezado de estilo 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html}al servidor. Este envía una línea al servidor que consta del encabezado, dos puntos y un espacio, y el primer argumento. Si se dan más argumentos, se envían líneas de continuación, cada una de las cuales consta de tabulación y un argumento.
@end deffn

@geindex endheaders() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection endheaders}@anchor{d33}
@deffn {Método} HTTPConnection.endheaders (message_body=None, *, encode_chunked=False)

Envía una línea en blanco al servidor, señalando el final de los encabezados. El argumento opcional `message_body' se puede usar para pasar un cuerpo de mensaje asociado a la solicitud.

Si `encode_chunked' es @code{True}, el resultado de cada iteración de `message_body' se codificará en fragmentos como se especifica en 
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html}, Sección 3.3.1. La forma en que se codifican los datos depende del tipo de `message_body'. Si `message_body' implementa @ref{48a,,buffer interface} la codificación dará como resultado un solo fragmento. Si `message_body' es una @ref{2253,,collections.abc.Iterable}, cada iteración de `message_body' dará como resultado un fragmento. Si `message_body' es un objeto @ref{1230,,file object}, cada llamada a @code{.read()} dará como resultado un fragmento. El método señala automáticamente el final de los datos codificados en fragmentos inmediatamente después de `message_body'.

@cartouche
@quotation Nota 
Debido a la especificación de codificación fragmentada, fragmentos vacíos producidos por un cuerpo iterador será ignorado por el codificador de fragmentos. Esto es para evitar la terminación prematura de la lectura de la solicitud por parte del servidor de destino debido a una codificación con formato incorrecto.
@end quotation
@end cartouche


Distinto en la versión 3.6: Added chunked encoding support and the `encode_chunked' parameter.

@end deffn

@geindex send() (método de http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection send}@anchor{399b}
@deffn {Método} HTTPConnection.send (data)

Envía datos al servidor. Esto debe usarse directamente solo después de que se haya llamado al método @ref{d33,,endheaders()} y antes de que se llame al método @ref{e8d,,getresponse()}.

Lanza un @ref{18c3,,evento de auditoría} @code{http.client.send} con los argumentos @code{self}, @code{data}.
@end deffn

@node Objetos de HTTPResponse,Ejemplos<25>,Objetos de HTTPConnection,http client — HTTP protocol client
@anchor{library/http client httpresponse-objects}@anchor{399c}@anchor{library/http client id2}@anchor{399d}
@subsubsection Objetos de @code{HTTPResponse}


Una instancia de @ref{1142,,HTTPResponse} envuelve la respuesta HTTP del servidor. Proporciona acceso a los encabezados de la solicitud y al cuerpo de la entidad. La respuesta es un objeto iterable y puede usarse en una declaración @code{with}.


Distinto en la versión 3.5: La interfaz @ref{735,,io.BufferedIOBase} ahora está implementada y todas sus operaciones de lectura están soportadas.


@geindex read() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse read}@anchor{1750}
@deffn {Método} HTTPResponse.read ([amt])

Lee y retorna el cuerpo de respuesta, o hasta los siguientes bytes `amt'.
@end deffn

@geindex readinto() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse readinto}@anchor{1143}
@deffn {Método} HTTPResponse.readinto (b)

Lee hasta los siguientes bytes @code{len(b)} del cuerpo de respuesta en el búfer `b'. Retorna el número de bytes leídos.


Added in version 3.3.

@end deffn

@geindex getheader() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getheader}@anchor{399e}
@deffn {Método} HTTPResponse.getheader (name, default=None)

Retorna el valor del encabezado `name', o `default' si no hay un encabezado que coincida con `name'. Si hay más de un encabezado con el nombre `name', retorne todos los valores unidos por “, “. Si “default” es cualquier iterable que no sea una sola cadena de caracteres sus elementos se retornan, de manera similar, unidos por comas.
@end deffn

@geindex getheaders() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getheaders}@anchor{399f}
@deffn {Método} HTTPResponse.getheaders ()

Retorna una lista de tuplas (encabezado, valor).
@end deffn

@geindex fileno() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse fileno}@anchor{39a0}
@deffn {Método} HTTPResponse.fileno ()

Retorna el @code{fileno} del socket implícito.
@end deffn

@geindex msg (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse msg}@anchor{3981}
@deffn {Atributo} HTTPResponse.msg

Una instancia @ref{3980,,http.client.HTTPMessage} que contiene los encabezados de respuesta. @ref{3980,,http.client.HTTPMessage} es una subclase de @ref{3d1,,email.message.Message}.
@end deffn

@geindex version (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse version}@anchor{39a1}
@deffn {Atributo} HTTPResponse.version

Versión del protocolo HTTP utilizada por el servidor. 10 para HTTP/1.0, 11 para HTTP/1.1.
@end deffn

@geindex url (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse url}@anchor{39a2}
@deffn {Atributo} HTTPResponse.url

URL del recurso recuperado, comúnmente utilizado para determinar si se siguió una redirección.
@end deffn

@geindex headers (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse headers}@anchor{39a3}
@deffn {Atributo} HTTPResponse.headers

Cabeceras de la respuesta en forma de una instancia @ref{3d0,,email.message.EmailMessage}.
@end deffn

@geindex status (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse status}@anchor{39a4}
@deffn {Atributo} HTTPResponse.status

Código del estado retornado por el servidor.
@end deffn

@geindex reason (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse reason}@anchor{38ca}
@deffn {Atributo} HTTPResponse.reason

Una frase de la razón es retornada por el servidor.
@end deffn

@geindex debuglevel (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse debuglevel}@anchor{39a5}
@deffn {Atributo} HTTPResponse.debuglevel

Un depurador. Si @ref{39a5,,debuglevel} es mayor que cero, los mensajes se imprimirán en @code{stdout} a medida que se lee y analiza la respuesta.
@end deffn

@geindex closed (atributo de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse closed}@anchor{39a6}
@deffn {Atributo} HTTPResponse.closed

Es @code{True} si la transmisión está cerrada.
@end deffn

@geindex geturl() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse geturl}@anchor{39a7}
@deffn {Método} HTTPResponse.geturl ()


Obsoleto desde la versión 3.9: Deprecada a favor de @ref{39a2,,url}.

@end deffn

@geindex info() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse info}@anchor{39a8}
@deffn {Método} HTTPResponse.info ()


Obsoleto desde la versión 3.9: Deprecada a favor de @ref{39a3,,headers}.

@end deffn

@geindex getcode() (método de http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getcode}@anchor{39a9}
@deffn {Método} HTTPResponse.getcode ()


Obsoleto desde la versión 3.9: Deprecada a favor de @ref{39a4,,status}.

@end deffn

@node Ejemplos<25>,Objetos de HTTPMessage,Objetos de HTTPResponse,http client — HTTP protocol client
@anchor{library/http client examples}@anchor{39aa}
@subsubsection Ejemplos


Aquí hay una sesión de ejemplo que usa el método @code{GET} `method':

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("www.python.org")
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> print(r1.status, r1.reason)
200 OK
>>> data1 = r1.read()  # This will return entire content.
>>> # The following example demonstrates reading data in chunks.
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> while chunk := r1.read(200):
...     print(repr(chunk))
b'<!doctype html>\n<!--[if"...
...
>>> # Example of an invalid request
>>> conn = http.client.HTTPSConnection("docs.python.org")
>>> conn.request("GET", "/parrot.spam")
>>> r2 = conn.getresponse()
>>> print(r2.status, r2.reason)
404 Not Found
>>> data2 = r2.read()
>>> conn.close()
@end example

Aquí hay una sesión de ejemplo que usa el método @code{HEAD}. Tenga en cuenta que el método @code{HEAD} nunca retorna ningún dato.

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("www.python.org")
>>> conn.request("HEAD", "/")
>>> res = conn.getresponse()
>>> print(res.status, res.reason)
200 OK
>>> data = res.read()
>>> print(len(data))
0
>>> data == b'@w{'}
True
@end example

Aquí hay una sesión de ejemplo que usa el método @code{POST}:

@example
>>> import http.client, urllib.parse
>>> params = urllib.parse.urlencode(@{'@@number': 12524, '@@type': 'issue', '@@action': 'show'@})
>>> headers = @{"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"@}
>>> conn = http.client.HTTPConnection("bugs.python.org")
>>> conn.request("POST", "", params, headers)
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
302 Found
>>> data = response.read()
>>> data
b'Redirecting to <a href="https://bugs.python.org/issue12524">https://bugs.python.org/issue12524</a>'
>>> conn.close()
@end example

Las solicitudes HTTP @code{PUT} del lado del cliente son muy similares a las solicitudes @code{POST}. La diferencia radica solo en el lado del servidor donde los servidores HTTP permitirán que se creen recursos a través de la solicitud @code{PUT}. Cabe señalar que los métodos HTTP personalizados también se manejan en @ref{1057,,urllib.request.Request} configurando el atributo de método apropiado. Aquí hay una sesión de ejemplo que muestra cómo enviar una solicitud @code{PUT}:

@example
>>> # This creates an HTTP request
>>> # with the content of BODY as the enclosed representation
>>> # for the resource http://localhost:8080/file
...
>>> import http.client
>>> BODY = "***filecontents***"
>>> conn = http.client.HTTPConnection("localhost", 8080)
>>> conn.request("PUT", "/file", BODY)
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200, OK
@end example

@node Objetos de HTTPMessage,,Ejemplos<25>,http client — HTTP protocol client
@anchor{library/http client httpmessage-objects}@anchor{39ab}@anchor{library/http client id3}@anchor{39ac}
@subsubsection Objetos de @code{HTTPMessage}


@geindex HTTPMessage (clase en http.client)
@anchor{library/http client http client HTTPMessage}@anchor{3980}
@deffn {Clase} http.client.HTTPMessage (email.message.Message)
@end deffn

Una instancia de @ref{3980,,http.client.HTTPMessage} contiene los encabezados de una respuesta HTTP. Se implementa utilizando la clase @ref{3d1,,email.message.Message}.

@c XXX Define the methods that clients can depend upon between versions.

@node ftplib — FTP protocol client,poplib — POP3 protocol client,http client — HTTP protocol client,Protocolos y soporte de Internet
@anchor{library/ftplib doc}@anchor{39ad}@anchor{library/ftplib ftplib-ftp-protocol-client}@anchor{39ae}@anchor{library/ftplib module-ftplib}@anchor{5e}
@subsection @code{ftplib} — FTP protocol client


@geindex module; ftplib

`Código fuente' Lib/ftplib.py@footnote{https://github.com/python/cpython/tree/main/Lib/ftplib.py}

@geindex FTP;protocolo
@geindex FTP;ftplib (módulo estándar)


__________________________________________________________________


Este módulo define la clase @ref{990,,FTP} y algunos elementos relacionados. La clase @ref{990,,FTP} implementa el lado cliente del protocolo FTP. Puede usar esto para escribir programas de Python que realicen una variedad de trabajos FTP automatizados, como duplicar otros servidores FTP. También es utilizado por el módulo @ref{10b,,urllib.request} para manejar URL que usan FTP. Para más información sobre FTP (File Transfer Protocol), ver internet 
@geindex RFC; RFC 959
RFC 959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}.

La codificación predeterminada es UTF-8, siguiendo 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Aquí hay una sesión de ejemplo usando el módulo @ref{5e,,ftplib}:

@example
>>> from ftplib import FTP
>>> ftp = FTP('ftp.us.debian.org')  # connect to host, default port
>>> ftp.login()                     # user anonymous, passwd anonymous@@
'230 Login successful.'
>>> ftp.cwd('debian')               # change into "debian" directory
'250 Directory successfully changed.'
>>> ftp.retrlines('LIST')           # list directory contents
-rw-rw-r--    1 1176     1176         1063 Jun 15 10:18 README
...
drwxr-sr-x    5 1176     1176         4096 Dec 19  2000 pool
drwxr-sr-x    4 1176     1176         4096 Nov 17  2008 project
drwxr-xr-x    3 1176     1176         4096 Oct 10  2012 tools
'226 Directory send OK.'
>>> with open('README', 'wb') as fp:
>>>     ftp.retrbinary('RETR README', fp.write)
'226 Transfer complete.'
>>> ftp.quit()
'221 Goodbye.'
@end example

@menu
* Reference:: 

@end menu

@node Reference,,,ftplib — FTP protocol client
@anchor{library/ftplib ftplib-reference}@anchor{39af}@anchor{library/ftplib reference}@anchor{39b0}
@subsubsection Reference


@menu
* FTP objects:: 
* FTP_TLS objects:: 
* Module variables:: 

@end menu

@node FTP objects,FTP_TLS objects,,Reference
@anchor{library/ftplib ftp-objects}@anchor{39b1}@anchor{library/ftplib id1}@anchor{39b2}
@subsubsection FTP objects


@c Use substitutions for some param docs so we don't need to repeat them
@c in multiple places.

@c Ideally, we'd like to use the :rfc: directive, but Sphinx will not allow it.

@geindex FTP (clase en ftplib)
@anchor{library/ftplib ftplib FTP}@anchor{990}
@deffn {Clase} ftplib.FTP (host='@w{'}, user='@w{'}, passwd='@w{'}, acct='@w{'}, timeout=None, source_address=None, *, encoding='utf-8')

Return a new instance of the @ref{990,,FTP} class.

@*Parámetros: 

@itemize *

@item 
@code{host} (@ref{237,,str}) – The hostname to connect to.
If given, @code{connect(host)} is implicitly called by the constructor.

@item 
@code{user} (@ref{237,,str}) – The username to log in with (default: @code{'anonymous'}).
If given, @code{login(host, passwd, acct)} is implicitly called
by the constructor.

@item 
@code{passwd} (@ref{237,,str}) – The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{237,,str}) – Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.

@item 
@code{timeout} (@ref{153,,float}@code{ | }@code{None}) – A timeout in seconds for blocking operations like @ref{39b3,,connect()}
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{464,,tuple}@code{ | }@code{None}) – A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.

@item 
@code{encoding} (@ref{237,,str}) – The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize


La clase @ref{990,,FTP} admite la instrucción @ref{673,,with}, por ejemplo:

@example
>>> from ftplib import FTP
>>> with FTP("ftp1.at.proftpd.org") as ftp:
...     ftp.login()
...     ftp.dir()
... 
'230 Anonymous login ok, restrictions apply.'
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
>>>
@end example


Distinto en la versión 3.2: Se agregó compatibilidad con la instrucción @ref{673,,with}.



Distinto en la versión 3.3: Se agregó el parámetro `source_address'.



Distinto en la versión 3.9: Si el parámetro `timeout' se establece en cero, lanzará un @ref{360,,ValueError} para evitar la creación de un socket sin bloqueo. Se agregó el parámetro `encoding', y el valor predeterminado se cambió de Latin-1 a UTF-8 para seguir 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.


Several @code{FTP} methods are available in two flavors:
one for handling text files and another for binary files.
The methods are named for the command which is used followed by
@code{lines} for the text version or @code{binary} for the binary version.

Las instancias de @ref{990,,FTP} tienen los siguientes métodos:

@geindex set_debuglevel() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP set_debuglevel}@anchor{39b4}
@deffn {Método} set_debuglevel (level)

Set the instance’s debugging level as an @ref{1f0,,int}.
This controls the amount of debugging output printed.
The debug levels are:


@itemize *

@item 
@code{0} (default): No debug output.

@item 
@code{1}: Produce a moderate amount of debug output,
generally a single line per request.

@item 
@code{2} or higher: Produce the maximum amount of debugging output,
logging each line sent and received on the control connection.
@end itemize
@end deffn

@geindex connect() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP connect}@anchor{39b3}
@deffn {Método} connect (host='@w{'}, port=0, timeout=None, source_address=None)

Connect to the given host and port.
This function should be called only once for each instance;
it should not be called if a `host' argument was given
when the @ref{990,,FTP} instance was created.
All other @code{FTP} methods can only be called
after a connection has successfully been made.

@*Parámetros: 

@itemize *

@item 
@code{host} (@ref{237,,str}) – The host to connect to.

@item 
@code{port} (@ref{1f0,,int}) – The TCP port to connect to (default: @code{21},
as specified by the FTP protocol specification).
It is rarely needed to specify a different port number.

@item 
@code{timeout} (@ref{153,,float}@code{ | }@code{None}) – A timeout in seconds for the connection attempt
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{464,,tuple}@code{ | }@code{None}) – A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.
@end itemize


Lanza un @ref{18c3,,evento auditor} @code{ftplib.connect} con los argumentos @code{self}, @code{host}, @code{port}.


Distinto en la versión 3.3: Se agregó el parámetro `source_address'.

@end deffn

@geindex getwelcome() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP getwelcome}@anchor{39b5}
@deffn {Método} getwelcome ()

Retornar el mensaje de bienvenida enviado por el servidor como respuesta a la conexión inicial. (Este mensaje a veces contiene renuncias de responsabilidad o información de ayuda que puede ser relevante para el usuario.)
@end deffn

@geindex login() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP login}@anchor{39b6}
@deffn {Método} login (user='anonymous', passwd='@w{'}, acct='@w{'})

Log on to the connected FTP server.
This function should be called only once for each instance,
after a connection has been established;
it should not be called if the `host' and `user' arguments were given
when the @ref{990,,FTP} instance was created.
Most FTP commands are only allowed after the client has logged in.

@*Parámetros: 

@itemize *

@item 
@code{user} (@ref{237,,str}) – The username to log in with (default: @code{'anonymous'}).

@item 
@code{passwd} (@ref{237,,str}) – The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{237,,str}) – Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.
@end itemize

@end deffn

@geindex abort() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP abort}@anchor{39b7}
@deffn {Método} abort ()

Anula una transferencia de archivo que está en progreso. Usarlo no siempre funciona, pero vale la pena intentarlo.
@end deffn

@geindex sendcmd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP sendcmd}@anchor{39b8}
@deffn {Método} sendcmd (cmd)

Envía una cadena de comando simple al servidor y retorna la cadena de caracteres de respuesta.

Genera un @ref{18c3,,evento auditor} @code{ftplib.sendcmd} con los argumentos @code{self}, @code{cmd}.
@end deffn

@geindex voidcmd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP voidcmd}@anchor{39b9}
@deffn {Método} voidcmd (cmd)

Send a simple command string to the server and handle the response.  Return
the response string if the response code corresponds to success (codes in
the range 200–299).  Raise @ref{39ba,,error_reply} otherwise.

Genera un @ref{18c3,,evento auditor} @code{ftplib.sendcmd} con los argumentos @code{self}, @code{cmd}.
@end deffn

@geindex retrbinary() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP retrbinary}@anchor{39bb}
@deffn {Método} retrbinary (cmd, callback, blocksize=8192, rest=None)

Retrieve a file in binary transfer mode.

@*Parámetros: 

@itemize *

@item 
@code{cmd} (@ref{237,,str}) – An appropriate @code{RETR} command: @code{"RETR @var{filename}"}.

@item 
@code{callback} (@ref{28ea,,callable}) – A single parameter callable that is called
for each block of data received,
with its single argument being the data as @ref{325,,bytes}.

@item 
@code{blocksize} (@ref{1f0,,int}) – The maximum chunk size to read on the low-level
@ref{e27,,socket} object created to do the actual transfer.
This also corresponds to the largest size of data
that will be passed to `callback'.
Defaults to @code{8192}.

@item 
@code{rest} (@ref{1f0,,int}) – A @code{REST} command to be sent to the server.
See the documentation for the `rest' parameter of the @ref{39bc,,transfercmd()} method.
@end itemize

@end deffn

@geindex retrlines() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP retrlines}@anchor{39bd}
@deffn {Método} retrlines (cmd, callback=None)

Retrieve a file or directory listing in the encoding specified by the
`encoding' parameter at initialization.
`cmd' should be an appropriate @code{RETR} command (see @ref{39bb,,retrbinary()}) or
a command such as @code{LIST} or @code{NLST} (usually just the string @code{'LIST'}).
@code{LIST} retrieves a list of files and information about those files.
@code{NLST} retrieves a list of file names.
The `callback' function is called for each line with a string argument
containing the line with the trailing CRLF stripped.  The default `callback'
prints the line to @ref{b61,,sys.stdout}.
@end deffn

@geindex set_pasv() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP set_pasv}@anchor{39be}
@deffn {Método} set_pasv (val)

Habilita el modo pasivo si `val' es verdadero, de lo contrario lo inhabilita. El modo pasivo es el valor predeterminado.
@end deffn

@geindex storbinary() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP storbinary}@anchor{1371}
@deffn {Método} storbinary (cmd, fp, blocksize=8192, callback=None, rest=None)

Store a file in binary transfer mode.

@*Parámetros: 

@itemize *

@item 
@code{cmd} (@ref{237,,str}) – An appropriate @code{STOR} command: @code{"STOR @var{filename}"}.

@item 
@code{fp} (@ref{1230,,file object}) – A file object (opened in binary mode) which is read until EOF,
using its @ref{ea1,,read()} method in blocks of size `blocksize'
to provide the data to be stored.

@item 
@code{blocksize} (@ref{1f0,,int}) – The read block size.
Defaults to @code{8192}.

@item 
@code{callback} (@ref{28ea,,callable}) – A single parameter callable that is called
for each block of data sent,
with its single argument being the data as @ref{325,,bytes}.

@item 
@code{rest} (@ref{1f0,,int}) – A @code{REST} command to be sent to the server.
See the documentation for the `rest' parameter of the @ref{39bc,,transfercmd()} method.
@end itemize



Distinto en la versión 3.2: The `rest' parameter was added.

@end deffn

@geindex storlines() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP storlines}@anchor{39bf}
@deffn {Método} storlines (cmd, fp, callback=None)

Almacena un archivo en modo de línea. `cmd' debe ser un comando @code{STOR} apropiado (ver @ref{1371,,storbinary()}). Las líneas se leen hasta EOF del @ref{1230,,file object} `fp' (abierto en modo binario) usando su método @ref{1391,,readline()} para proporcionar los datos que se almacenarán. `callback' es un parámetro único opcional que se puede llamar en cada línea después de su envío.
@end deffn

@geindex transfercmd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP transfercmd}@anchor{39bc}
@deffn {Método} transfercmd (cmd, rest=None)

Inicia una transferencia sobre la conexión de datos.  Si la transferencia es activa, envía un comando @code{EPRT} o  @code{PORT} y el comando de transferencia especificado por `cmd', y acepta la conexión. Si el servidor es pasivo, envía un comando @code{EPSV} o @code{PASV}, lo conecta, e inicia el comando de transferencia. De cualquier manera, retorna el socket para la conexión.

Si se proporciona `rest' opcional, se envía un comando @code{REST} al servidor, pasando `rest' como argumento. `rest' suele ser un desplazamiento de bytes en el archivo solicitado, que le indica al servidor que reinicie el envío de los bytes del archivo en el desplazamiento solicitado, omitiendo los bytes iniciales. Sin embargo, tenga en cuenta que el método @ref{39bc,,transfercmd()} convierte `rest' en una cadena de caracteres con el parámetro `encoding' especificado en la inicialización, pero no se realiza ninguna comprobación del contenido de la cadena de caracteres. Si el servidor no reconoce el comando @code{REST}, se lanzará una excepción @ref{39ba,,error_reply}. Si esto sucede, simplemente llame a @ref{39bc,,transfercmd()} sin un argumento `rest'.
@end deffn

@geindex ntransfercmd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP ntransfercmd}@anchor{39c0}
@deffn {Método} ntransfercmd (cmd, rest=None)

Como @ref{39bc,,transfercmd()}, pero retorna una tupla de conexión de datos y el tamaño esperado de los datos. Si el tamaño esperado no se pudo computar, retornará @code{None} como tal. `cmd' y `rest' significan lo mismo que en @ref{39bc,,transfercmd()}.
@end deffn

@geindex mlsd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP mlsd}@anchor{1137}
@deffn {Método} mlsd (path='@w{'}, facts=[])

Enumera un directorio en un formato estandarizado usando el comando @code{MLSD} (
@geindex RFC; RFC 3659
RFC 3659@footnote{https://datatracker.ietf.org/doc/html/rfc3659.html}). Si se omite `path', se asume el directorio actual. `facts' es una lista de cadenas de caracteres que representan el tipo de información deseada (por ejemplo, @code{["type", "size", "perm"]}). Retorna un objeto generador que produce una tupla de dos elementos por cada archivo encontrado en la ruta. El primer elemento es el nombre del archivo, el segundo es un diccionario que contiene datos sobre el nombre del archivo. El contenido de este diccionario puede estar limitado por el argumento `facts', pero no se garantiza que el servidor retorne todos los datos solicitados.


Added in version 3.3.

@end deffn

@geindex nlst() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP nlst}@anchor{1138}
@deffn {Método} nlst (argument[, ...])

Retorna una lista de nombres de archivos tal como los retorna el comando @code{NLST}. El `argument' opcional es un directorio para listar (el predeterminado es el directorio del servidor actual). Se pueden usar varios argumentos para pasar opciones no estándar al comando @code{NLST}.

@cartouche
@quotation Nota 
Si tu servidor admite el comando, @ref{1137,,mlsd()} ofrece una API mejor.
@end quotation
@end cartouche
@end deffn

@geindex dir() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP dir}@anchor{1139}
@deffn {Método} dir (argument[, ...])

Produce a directory listing as returned by the @code{LIST} command, printing it to
standard output.  The optional `argument' is a directory to list (default is the
current server directory).  Multiple arguments can be used to pass non-standard
options to the @code{LIST} command.  If the last argument is a function, it is used
as a `callback' function as for @ref{39bd,,retrlines()}; the default prints to
@ref{b61,,sys.stdout}.  This method returns @code{None}.

@cartouche
@quotation Nota 
Si tu servidor admite el comando, @ref{1137,,mlsd()} ofrece una API mejor.
@end quotation
@end cartouche
@end deffn

@geindex rename() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP rename}@anchor{39c1}
@deffn {Método} rename (fromname, toname)

Asigna un nombre nuevo al archivo en el servidor desde `fromname' a `toname'.
@end deffn

@geindex delete() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP delete}@anchor{39c2}
@deffn {Método} delete (filename)

Remueve el archivo nombrado `filename' del servidor.  De ser exitoso, retorna el texto de la respuesta, de lo contrario, lanza @ref{39c3,,error_perm} sobre errores de permiso o @ref{39ba,,error_reply} sobre otros errores.
@end deffn

@geindex cwd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP cwd}@anchor{39c4}
@deffn {Método} cwd (pathname)

Configura el directorio actual en el servidor.
@end deffn

@geindex mkd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP mkd}@anchor{39c5}
@deffn {Método} mkd (pathname)

Crea un nuevo directorio en el servidor.
@end deffn

@geindex pwd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP pwd}@anchor{39c6}
@deffn {Método} pwd ()

Retorna el nombre de ruta del directorio actual en el servidor.
@end deffn

@geindex rmd() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP rmd}@anchor{39c7}
@deffn {Método} rmd (dirname)

Elimina el directorio en el servidor llamado `dirname'.
@end deffn

@geindex size() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP size}@anchor{39c8}
@deffn {Método} size (filename)

Solicita el tamaño del archivo llamado `filename' en el servidor.  De ser exitoso, se retorna el tamaño del archivo como un entero, de lo contrario retorna @code{None}. Nótese que el comando @code{SIZE} no está estandarizado, pero es admitido por muchas implementaciones comunes de servidor.
@end deffn

@geindex quit() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP quit}@anchor{39c9}
@deffn {Método} quit ()

Envía un comando @code{QUIT} al servidor y cierra la conexión. Esta es la forma «políticamente correcta» de cerrar una conexión, pero puede lanzar una excepción si el servidor responde con un error al comando @code{QUIT}. Esto implica una llamada al método @ref{39ca,,close()} que hace inútil la instancia de @ref{990,,FTP} para llamadas posteriores (véase más adelante).
@end deffn

@geindex close() (método de ftplib.FTP)
@anchor{library/ftplib ftplib FTP close}@anchor{39ca}
@deffn {Método} close ()

Cierra la conexión de forma unilateral. Esto no debería aplicarse a una conexión ya cerrada, como luego de una llamada exitosa a @ref{39c9,,quit()}. Después de esta llamada, la instancia @ref{990,,FTP} ya no debería utilizarse (luego de una llamada a @ref{39ca,,close()} o @ref{39c9,,quit()} no puedes abrir nuevamente la conexión emitiendo otro método @ref{39b6,,login()}.
@end deffn
@end deffn

@node FTP_TLS objects,Module variables,FTP objects,Reference
@anchor{library/ftplib ftp-tls-objects}@anchor{39cb}
@subsubsection FTP_TLS objects


@geindex FTP_TLS (clase en ftplib)
@anchor{library/ftplib ftplib FTP_TLS}@anchor{991}
@deffn {Clase} ftplib.FTP_TLS (host='@w{'}, user='@w{'}, passwd='@w{'}, acct='@w{'}, *, context=None, timeout=None, source_address=None, encoding='utf-8')

An @ref{990,,FTP} subclass which adds TLS support to FTP as described in
@geindex RFC; RFC 4217
RFC 4217@footnote{https://datatracker.ietf.org/doc/html/rfc4217.html}.
Connect to port 21 implicitly securing the FTP control connection
before authenticating.

@cartouche
@quotation Nota 
The user must explicitly secure the data connection
by calling the @ref{39cc,,prot_p()} method.
@end quotation
@end cartouche

@*Parámetros: 

@itemize *

@item 
@code{host} (@ref{237,,str}) – The hostname to connect to.
If given, @code{connect(host)} is implicitly called by the constructor.

@item 
@code{user} (@ref{237,,str}) – The username to log in with (default: @code{'anonymous'}).
If given, @code{login(host, passwd, acct)} is implicitly called
by the constructor.

@item 
@code{passwd} (@ref{237,,str}) – The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{237,,str}) – Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.

@item 
@code{context} (@ref{1fa,,ssl.SSLContext}) – An SSL context object which allows bundling SSL configuration options,
certificates and private keys into a single, potentially long-lived,
structure.
Please read @ref{3292,,Consideraciones de seguridad} for best practices.

@item 
@code{timeout} (@ref{153,,float}@code{ | }@code{None}) – A timeout in seconds for blocking operations like @ref{39b3,,connect()}
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{464,,tuple}@code{ | }@code{None}) – A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.

@item 
@code{encoding} (@ref{237,,str}) – The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize



Added in version 3.2.



Distinto en la versión 3.3: Added the `source_address' parameter.



Distinto en la versión 3.4: La clase ahora admite el chequeo del nombre con @ref{33af,,ssl.SSLContext.check_hostname} y `Server Name Indication' (véase @ref{33c1,,ssl.HAS_SNI}).



Distinto en la versión 3.9: Si el parámetro `timeout' se establece en cero, lanzará un @ref{360,,ValueError} para evitar la creación de un socket sin bloqueo. Se agregó el parámetro `encoding', y el valor predeterminado se cambió de Latin-1 a UTF-8 para seguir 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.



Distinto en la versión 3.12: Se han eliminado los parámetros obsoletos `keyfile' y `certfile'.


Aquí hay una sesión de ejemplo que usa la clase @ref{991,,FTP_TLS}:

@example
>>> ftps = FTP_TLS('ftp.pureftpd.org')
>>> ftps.login()
'230 Anonymous user logged in'
>>> ftps.prot_p()
'200 Data protection level set to "private"'
>>> ftps.nlst()
['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp']
@end example

@code{FTP_TLS} class inherits from @ref{990,,FTP},
defining these additional methods and attributes:

@geindex ssl_version (atributo de ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS ssl_version}@anchor{39cd}
@deffn {Atributo} ssl_version

La versión SSL para usar (toma como predeterminado @ref{33b3,,ssl.PROTOCOL_SSLv23}).
@end deffn

@geindex auth() (método de ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS auth}@anchor{39ce}
@deffn {Método} auth ()

Establece una conexión de control segura usando TLS o SSL, dependiendo de qué esté especificado en el atributo @ref{39cd,,ssl_version}.


Distinto en la versión 3.4: El método ahora admite el chequeo del nombre con @ref{33af,,ssl.SSLContext.check_hostname} y `Server Name Indication' (véase @ref{33c1,,ssl.HAS_SNI}).

@end deffn

@geindex ccc() (método de ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS ccc}@anchor{1136}
@deffn {Método} ccc ()

Revierte el canal de control a texto plano. Esto puede ser útil para aprovechar cortafuegos que saben manejar NAT con FTP no-seguro sin abrir puertos fijos.


Added in version 3.3.

@end deffn

@geindex prot_p() (método de ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS prot_p}@anchor{39cc}
@deffn {Método} prot_p ()

Configura conexión de datos segura.
@end deffn

@geindex prot_c() (método de ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS prot_c}@anchor{39cf}
@deffn {Método} prot_c ()

Configura la conexión de datos de tipo texto común.
@end deffn
@end deffn

@node Module variables,,FTP_TLS objects,Reference
@anchor{library/ftplib module-variables}@anchor{39d0}
@subsubsection Module variables


@geindex error_reply
@anchor{library/ftplib ftplib error_reply}@anchor{39ba}
@deffn {Excepción} ftplib.error_reply

Se lanza una excepción cuando una respuesta inesperada se recibe del servidor.
@end deffn

@geindex error_temp
@anchor{library/ftplib ftplib error_temp}@anchor{39d1}
@deffn {Excepción} ftplib.error_temp

Se genera una excepción cuando  se recibe un código de error que refiere a un error temporal (códigos de respuesta en el rango 400-499).
@end deffn

@geindex error_perm
@anchor{library/ftplib ftplib error_perm}@anchor{39c3}
@deffn {Excepción} ftplib.error_perm

Se lanza una excepción cuando se recibe un código de error que refiere a un error permanente (códigos de respuesta en el rango 500–599).
@end deffn

@geindex error_proto
@anchor{library/ftplib ftplib error_proto}@anchor{39d2}
@deffn {Excepción} ftplib.error_proto

Se lanza una excepción cuando se recibe una respuesta del servidor que no coincide con las especificaciones de respuesta del protocolo de transferencia de archivos (FTP), es decir, que comienza con un dígito en el rango 1–5.
@end deffn

@geindex all_errors (en el módulo ftplib)
@anchor{library/ftplib ftplib all_errors}@anchor{39d3}
@deffn {Dato} ftplib.all_errors

El conjunto de todas las excepciones (como una tupla) que los métodos de instancias @ref{990,,FTP} pueden lanzar como resultado de problemas con la conexión FTP (a diferencia de los errores de programación hechos por el autor de la llamada). Este conjunto incluye las cuatro excepciones enumeradas anteriormente, como también @ref{4d5,,OSError} y @ref{1341,,EOFError}.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{9b,,netrc}

Analizador para el formato de archivo @code{.netrc}. El archivo @code{.netrc} suele ser utilizado por clientes FTP para cargar la información de autenticación de usuario antes de solicitarlo al usuario.
@end table


@node poplib — POP3 protocol client,imaplib — IMAP4 protocol client,ftplib — FTP protocol client,Protocolos y soporte de Internet
@anchor{library/poplib doc}@anchor{39d4}@anchor{library/poplib module-poplib}@anchor{ac}@anchor{library/poplib poplib-pop3-protocol-client}@anchor{39d5}
@subsection @code{poplib} — POP3 protocol client


@geindex module; poplib

@c revised by ESR, January 2000

`Código fuente:' Lib/poplib.py@footnote{https://github.com/python/cpython/tree/main/Lib/poplib.py}

@geindex POP3;protocol


__________________________________________________________________


Este módulo define una clase, @ref{9b7,,POP3}, que encapsula una conexión a un servidor POP3 e implementa el protocolo como está definido en 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html}. La clase @ref{9b7,,POP3} soporta los mínimos y opcionales conjuntos de comandos de 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html}. La clase @ref{9b7,,POP3} también soporta el comando @code{STLS} introducido en 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html} para habilitar comunicación encriptada en una conexión ya establecida.

Adicionalmente, este módulo provee una clase @ref{9b8,,POP3_SSL}, que provee soporte para conectar servidores POP3 que usan SSL como una capa de protocolo subyacente.

Note que POP3, aunque ampliamente soportado, es obsoleto. La calidad de implementación de servidores POP3 varía ampliamente, y muchos son bastante pobres. Si su servidor de correo soporta IMAP, sería mejor utilizar la clase @ref{999,,imaplib.IMAP4}, ya que los servidores IMAP tienden a estar mejor implementados.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo @ref{ac,,poplib} provee dos clases:

@geindex POP3 (clase en poplib)
@anchor{library/poplib poplib POP3}@anchor{9b7}
@deffn {Clase} poplib.POP3 (host, port=POP3_PORT[, timeout])

Esta clase implementa el protocolo POP3 actual. La conexión es creada cuando la instancia es inicializada. Si `port' se omite, el puerto POP3 estándar (110) es utilizado. El parámetro opcional `timeout' especifica un tiempo de espera en segundos para el intento de conexión (si no se especifica, la configuración global de tiempo de espera será utilizada).

Genera un @ref{18c3,,evento de auditoría} @code{poplib.connect} con argumentos @code{self}, @code{host}, @code{port}.

Todos los comandos lanzarán un @ref{18c3,,evento de auditoría} @code{poplib.putline} con argumentos @code{self} y @code{line}, donde @code{line} son los bytes a ser enviados al host remoto.


Distinto en la versión 3.9: Si el parámetro `timeout' se establece en cero, lanzará un @ref{360,,ValueError} para evitar la creación de un socket sin bloqueo.

@end deffn

@geindex POP3_SSL (clase en poplib)
@anchor{library/poplib poplib POP3_SSL}@anchor{9b8}
@deffn {Clase} poplib.POP3_SSL (host, port=POP3_SSL_PORT, *, timeout=None, context=None)

Esta es una subclase de @ref{9b7,,POP3} que conecta al servidor sobre un socket SSL encriptado. Si `port' no es especificado, 995, el puerto POP3-over-SSL es utilizado. `timeout' funciona como en el constructor  de la clase @ref{9b7,,POP3}. `context' es un objeto @ref{1fa,,ssl.SSLContext} opcional que permite empaquetar opciones de configuración SSL, certificados y llaves privadas en una única (potencialmente longeva) estructura. Por favor lea @ref{3292,,Consideraciones de seguridad} para buenas prácticas.

Genera un @ref{18c3,,evento de auditoría} @code{poplib.connect} con argumentos @code{self}, @code{host}, @code{port}.

Todos los comandos lanzarán un @ref{18c3,,evento de auditoría} @code{poplib.putline} con argumentos @code{self} y @code{line}, donde @code{line} son los bytes a ser enviados al host remoto.


Distinto en la versión 3.2: Parámetro `context' agregado.



Distinto en la versión 3.4: The class now supports hostname check with
@ref{33af,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{33c1,,ssl.HAS_SNI}).



Distinto en la versión 3.9: Si el parámetro `timeout' se establece en cero, lanzará un @ref{360,,ValueError} para evitar la creación de un socket sin bloqueo.



Distinto en la versión 3.12: The deprecated `keyfile' and `certfile' parameters have been removed.

@end deffn

Una excepción es definida como un atributo del módulo @ref{ac,,poplib}:

@geindex error_proto
@anchor{library/poplib poplib error_proto}@anchor{120c}
@deffn {Excepción} poplib.error_proto

Excepción generada en cualquier error de este módulo (errores del módulo @ref{cc,,socket} no son capturadas). La razón para la excepción es pasada al constructor como una cadena.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{74,,imaplib}

El módulo IMAP de Python.

@item Preguntas Frecuentes Sobre Fetchmail@footnote{http://www.catb.org/~esr/fetchmail/fetchmail-FAQ.html}

Las preguntas frecuentes para el cliente POP/IMAP @code{fetchmail} colecciona información en las variaciones del servidor POP3 e incumplimiento de RFC que puede ser útil si usted necesita escribir una aplicación basada en el protocolo POP.
@end table


@menu
* Objetos POP3:: 
* Ejemplo POP3:: 

@end menu

@node Objetos POP3,Ejemplo POP3,,poplib — POP3 protocol client
@anchor{library/poplib id1}@anchor{39d6}@anchor{library/poplib pop3-objects}@anchor{39d7}
@subsubsection Objetos POP3


Todos los comandos POP3 están representados por métodos del mismo nombre, en minúsculas; la mayoría retorna el texto de respuesta enviado por el servidor.

Una instancia @ref{9b7,,POP3} tiene los siguientes métodos:

@geindex set_debuglevel() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 set_debuglevel}@anchor{39d8}
@deffn {Método} POP3.set_debuglevel (level)

Establece el nivel de depuración de la instancia. Esto controla la cantidad de salida de depuración impresa. Por defecto, @code{0}, no produce salida de depuración. Un valor de @code{1} produce una moderada cantidad de salida de depuración, generalmente una única línea por solicitud. Un valor de @code{2} o mayor produce la máxima cantidad de salida de depuración, registrando cada línea enviada y recibida en la conexión de control.
@end deffn

@geindex getwelcome() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 getwelcome}@anchor{39d9}
@deffn {Método} POP3.getwelcome ()

Retorna la cadena de saludo enviada por el servidor POP3.
@end deffn

@geindex capa() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 capa}@anchor{ffb}
@deffn {Método} POP3.capa ()

Consulta las capacidades del servidor como está especificado en 
@geindex RFC; RFC 2449
RFC 2449@footnote{https://datatracker.ietf.org/doc/html/rfc2449.html}. Retorna un diccionario en la forma @code{@{'nombre': ['param'...]@}}.


Added in version 3.4.

@end deffn

@geindex user() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 user}@anchor{39da}
@deffn {Método} POP3.user (username)

Envía el comando del usuario, la respuesta debería indicar que una contraseña es requerida.
@end deffn

@geindex pass_() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 pass_}@anchor{39db}
@deffn {Método} POP3.pass_ (password)

Send password, response includes message count and mailbox size. Note: the
mailbox on the server is locked until @ref{120b,,quit()} is called.
@end deffn

@geindex apop() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 apop}@anchor{39dc}
@deffn {Método} POP3.apop (user, secret)

Utiliza la autenticación APOP (más segura) para registrar en el servidor POP3.
@end deffn

@geindex rpop() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 rpop}@anchor{39dd}
@deffn {Método} POP3.rpop (user)

Utiliza autenticación RPOP (similar a los comandos r de UNIX) para registrar en el servidor POP3.
@end deffn

@geindex stat() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 stat}@anchor{39de}
@deffn {Método} POP3.stat ()

Obtiene el estado del buzón de correo. El resultado es una tupla de 2 enteros: @code{(conteo de mensaje, tamaño del buzón de correo)}.
@end deffn

@geindex list() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 list}@anchor{39df}
@deffn {Método} POP3.list ([which])

Solicita lista de mensajes, el resultado es en la forma @code{(respuesta, ['mesg_num octets', ...], octets)}. Si `which' está establecido, es el mensaje a listar.
@end deffn

@geindex retr() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 retr}@anchor{39e0}
@deffn {Método} POP3.retr (which)

Recupera el número de mensaje completo `which', y establece marca de visto. El resultado es en la forma @code{(respuesta, ['line', ...], octets)}.
@end deffn

@geindex dele() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 dele}@anchor{39e1}
@deffn {Método} POP3.dele (which)

Marca el número de mensaje `which' para eliminación. En la mayoría de los servidores las eliminaciones no están actualmente presentadas hasta QUIT (la mayor excepción es Eudora QPOP, que deliberadamente viola las RFC haciendo eliminaciones pendientes en cada desconexión).
@end deffn

@geindex rset() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 rset}@anchor{39e2}
@deffn {Método} POP3.rset ()

Remueve las marcas de eliminación para el buzón de correo.
@end deffn

@geindex noop() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 noop}@anchor{39e3}
@deffn {Método} POP3.noop ()

No hace nada. Puede ser utilizado como keep-alive.
@end deffn

@geindex quit() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 quit}@anchor{120b}
@deffn {Método} POP3.quit ()

Cierra sesión: envía los cambios, desbloquea el buzón de correo, desconecta.
@end deffn

@geindex top() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 top}@anchor{39e4}
@deffn {Método} POP3.top (which, howmuch)

Recupera la cabecera del mensaje mas `howmuch' las líneas del mensaje después del cabecera del número de mensajes `which'. El resultado es en la forma @code{(respuesta, ['línea', ...]. octets)}.

El comando TOP POP3 que este método utiliza, a diferencia del comando RETR, no establece la marca de visto del mensaje; desafortunadamente, TOP está pobremente especificado en las RFC y se rompe con frecuencia en servidores off-brand. Pruebe este método a mano contra los servidores POP3 que usted utilizará antes de confiar en él.
@end deffn

@geindex uidl() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 uidl}@anchor{39e5}
@deffn {Método} POP3.uidl (which=None)

Retorna la lista del resumen de mensajes (id único). Si `which' es especificado, el resultado contiene el id único para ese mensaje en la forma @code{'response mesgnum uid}, de otra forma el resultado es una lista @code{(respuesta, ['mengnum uid', ...], octets)}.
@end deffn

@geindex utf8() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 utf8}@anchor{ece}
@deffn {Método} POP3.utf8 ()

Trata de cambiar al modo UTF-8. Retorna la respuesta del servidor si es exitosa, genera @ref{120c,,error_proto} si no. Especificado en 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html}.


Added in version 3.5.

@end deffn

@geindex stls() (método de poplib.POP3)
@anchor{library/poplib poplib POP3 stls}@anchor{ffc}
@deffn {Método} POP3.stls (context=None)

Comienza una sesión TLS en la conexión activa como está especificado en 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html}. Esto es únicamente permitido antes de la autenticación de usuario

El parámetro `context' es un objeto @ref{1fa,,ssl.SSLContext} que permite empaquetar opciones de configuración SSL, certificados y llaves privadas en una única (potencialmente longeva) estructura. Por favor lea @ref{3292,,Consideraciones de seguridad} para buenas prácticas.

This method supports hostname checking via
@ref{33af,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{33c1,,ssl.HAS_SNI}).


Added in version 3.4.

@end deffn

Instancias de @ref{9b8,,POP3_SSL} no tienen métodos adicionales. La interfaz de esta subclase es idéntica a su padre.

@node Ejemplo POP3,,Objetos POP3,poplib — POP3 protocol client
@anchor{library/poplib id2}@anchor{39e6}@anchor{library/poplib pop3-example}@anchor{39e7}
@subsubsection Ejemplo POP3


Este es un ejemplo mínimo (sin chequeo de errores) que abre un buzón de correo y retorna e imprime todos los mensajes:

@example
import getpass, poplib

M = poplib.POP3('localhost')
M.user(getpass.getuser())
M.pass_(getpass.getpass())
numMessages = len(M.list()[1])
for i in range(numMessages):
    for j in M.retr(i+1)[1]:
        print(j)
@end example

Al final del módulo, hay una sección de test que contiene un ejemplo más extensivo de uso.

@node imaplib — IMAP4 protocol client,smtplib — SMTP protocol client,poplib — POP3 protocol client,Protocolos y soporte de Internet
@anchor{library/imaplib doc}@anchor{39e8}@anchor{library/imaplib imaplib-imap4-protocol-client}@anchor{39e9}@anchor{library/imaplib module-imaplib}@anchor{74}
@subsection @code{imaplib} — IMAP4 protocol client


@geindex module; imaplib

@c revised by ESR, January 2000

@c changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002

@c changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
@c November 2002

`Código fuente:' Lib/imaplib.py@footnote{https://github.com/python/cpython/tree/main/Lib/imaplib.py}

@geindex IMAP4;protocol
@geindex IMAP4_SSL;protocol
@geindex IMAP4_stream;protocol


__________________________________________________________________


Este módulo define tres clases @ref{999,,IMAP4}, @ref{99a,,IMAP4_SSL} y @ref{99c,,IMAP4_stream}, que encapsula una conexión a un servidor IMAP4 e implementa un gran subconjunto del protocolo de cliente IMAP4rev1 como se define en :rfc :@cite{2060}. Es compatible con los servidores IMAP4 (
@geindex RFC; RFC 1730
RFC 1730@footnote{https://datatracker.ietf.org/doc/html/rfc1730.html}), pero tenga en cuenta que el comando @code{STATUS} no es compatible con IMAP4.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

El módulo @ref{74,,imaplib} proporciona tres clases, @ref{999,,IMAP4} es la clase base:

@geindex IMAP4 (clase en imaplib)
@anchor{library/imaplib imaplib IMAP4}@anchor{999}
@deffn {Clase} imaplib.IMAP4 (host='@w{'}, port=IMAP4_PORT, timeout=None)

This class implements the actual IMAP4 protocol.  The connection is created and
protocol version (IMAP4 or IMAP4rev1) is determined when the instance is
initialized. If `host' is not specified, @code{'@w{'}} (the local host) is used. If
`port' is omitted, the standard IMAP4 port (143) is used. The optional `timeout'
parameter specifies a timeout in seconds for the connection attempt.
If timeout is not given or is @code{None}, the global default socket timeout is used.

La clase @ref{999,,IMAP4} soporta la sentencia @ref{673,,with}. Cuando se usa de esta manera, el comando IMAP4 @code{LOGOUT} se emite automáticamente cuando se cierra la declaración @code{with}. P.ej.:

@example
>>> from imaplib import IMAP4
>>> with IMAP4("domain.org") as M:
...     M.noop()
...
('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])
@end example


Distinto en la versión 3.5: Se agregó soporte para la sentencia @ref{673,,with}.



Distinto en la versión 3.9: El parámetro opcional `timeout' fue agregado.

@end deffn

Se definen tres excepciones como atributos de la clase @ref{999,,IMAP4}:

@geindex IMAP4.error
@anchor{library/imaplib imaplib IMAP4 error}@anchor{39ea}
@deffn {Excepción} IMAP4.error

Excepción lanzada por cualquier error. El motivo de la excepción se pasa al constructor como una cadena de caracteres.
@end deffn

@geindex IMAP4.abort
@anchor{library/imaplib imaplib IMAP4 abort}@anchor{39eb}
@deffn {Excepción} IMAP4.abort

Los errores del servidor IMAP4 causan que esta excepción sea lanzada. Esta es una subclase de @ref{39ea,,IMAP4.error}. Tenga en cuenta que cerrar la instancia e instanciar una nueva generalmente permitirá la recuperación de esta excepción.
@end deffn

@geindex IMAP4.readonly
@anchor{library/imaplib imaplib IMAP4 readonly}@anchor{39ec}
@deffn {Excepción} IMAP4.readonly

Esta excepción es lanzada cuando el servidor cambia el estado de un buzón de correo de escritura. Esta es una subclase de @ref{39ea,,IMAP4.error}. Algún otro cliente ahora tiene permiso de escritura y será necesario volver a abrir el buzón para volver a obtener el permiso de escritura.
@end deffn

También hay una subclase para conexiones seguras:

@geindex IMAP4_SSL (clase en imaplib)
@anchor{library/imaplib imaplib IMAP4_SSL}@anchor{99a}
@deffn {Clase} imaplib.IMAP4_SSL (host='@w{'}, port=IMAP4_SSL_PORT, *, ssl_context=None, timeout=None)

Esta es una subclase derivada de @ref{999,,IMAP4} que se conecta a través de un socket cifrado SSL (para usar esta clase necesita un módulo de socket que se compiló con soporte SSL). Si no se especifica `host', se usa @code{'@w{'}} (el host local). Si se omite `port', se usa el puerto IMAP4 estándar sobre SSL (993). `ssl_context' es un objeto @ref{1fa,,ssl.SSLContext} que permite agrupar opciones de configuración SSL, certificados y claves privadas en una estructura única (potencialmente de larga duración). Leer @ref{3292,,Consideraciones de seguridad} para conocer las mejores prácticas.

The optional `timeout' parameter specifies a timeout in seconds for the
connection attempt. If timeout is not given or is @code{None}, the global default
socket timeout is used.


Distinto en la versión 3.3: El parámetro `ssl_context' fue agregado.



Distinto en la versión 3.4: La clase ahora admite la verificación del nombre de host con @ref{33af,,ssl.SSLContext.check_hostname} y `Server Name Indication' (ver @ref{33c1,,ssl.HAS_SNI}).



Distinto en la versión 3.9: El parámetro opcional `timeout' fue agregado.



Distinto en la versión 3.12: Se han eliminado los parámetros obsoletos `keyfile' y `certfile'.

@end deffn

La segunda subclase permite conexiones creadas por un proceso hijo:

@geindex IMAP4_stream (clase en imaplib)
@anchor{library/imaplib imaplib IMAP4_stream}@anchor{99c}
@deffn {Clase} imaplib.IMAP4_stream (command)

Esta es una subclase derivada de @ref{999,,IMAP4} que se conecta a los descriptores de archivo @code{stdin/stdout} creados al pasar `command' a @code{subprocess.Popen ()}.
@end deffn

Se definen las siguientes funciones de utilidad:

@geindex Internaldate2tuple() (en el módulo imaplib)
@anchor{library/imaplib imaplib Internaldate2tuple}@anchor{39ed}
@deffn {Función} imaplib.Internaldate2tuple (datestr)

Analiza una cadena de caracteres IMAP4 @code{INTERNALDATE} y retorna la hora local correspondiente. El valor de retorno es una tupla @ref{d71,,time.struct_time} o @code{None} si la cadena de caracteres tiene un formato incorrecto.
@end deffn

@geindex Int2AP() (en el módulo imaplib)
@anchor{library/imaplib imaplib Int2AP}@anchor{39ee}
@deffn {Función} imaplib.Int2AP (num)

Convierte un número entero en una representación de bytes utilizando caracteres del conjunto [@code{A} .. @code{P}].
@end deffn

@geindex ParseFlags() (en el módulo imaplib)
@anchor{library/imaplib imaplib ParseFlags}@anchor{39ef}
@deffn {Función} imaplib.ParseFlags (flagstr)

Convierte una respuesta IMAP4 @code{FLAGS} a una tupla de indicadores individuales.
@end deffn

@geindex Time2Internaldate() (en el módulo imaplib)
@anchor{library/imaplib imaplib Time2Internaldate}@anchor{39f0}
@deffn {Función} imaplib.Time2Internaldate (date_time)

Convierte `date_time' en una representación IMAP4 @code{INTERNALDATE}. El valor de retorno es una cadena de caracteres en la forma: @code{"DD-Mmm-YYYY HH:MM:SS +HHMM"} (incluyendo comillas dobles). El argumento `date_time' puede ser un número (int o float) que representa segundos en un espacio de tiempo (como lo retorna @ref{3ad,,time.time()}), una tupla de 9 que representa la hora local como una instancia de @ref{d71,,time.struct_time} (según lo retornado por @ref{1539,,time.localtime()}), una instancia actualizada de @ref{32f,,datetime.datetime}, o una cadena de caracteres entre comillas dobles. En el último caso, se supone que ya está en el formato correcto.
@end deffn

Tenga en cuenta que los números de mensaje IMAP4 cambian a medida que cambia el buzón de correo; en particular, después de que un comando @code{EXPUNGE} realiza eliminaciones, los mensajes restantes se vuelven a numerar. Por lo tanto, es muy recomendable usar UIDs en su lugar, con el comando UID.

Al final del módulo, hay una sección de prueba que contiene un ejemplo más extenso de uso.


@subsubheading Ver también


Documentos describiendo el protocolo, y fuentes de servidores que lo implementan, del Centro de Información IMAP de la Universidad de Washington, pueden ser encontrados en (`Código Fuente') @indicateurl{https://github.com/uw-imap/imap} (`Fuera de mantención').


@menu
* Objetos de IMAP4:: 
* Ejemplo IMAP4:: 

@end menu

@node Objetos de IMAP4,Ejemplo IMAP4,,imaplib — IMAP4 protocol client
@anchor{library/imaplib id1}@anchor{39f1}@anchor{library/imaplib imap4-objects}@anchor{39f2}
@subsubsection Objetos de IMAP4


Todos los comandos IMAP4rev1 están representados por métodos del mismo nombre, ya sea en mayúsculas o minúsculas.

Todos los argumentos de los comandos se convierten en cadenas de caracteres, excepto @code{AUTENTICATE} y el último argumento de @code{APPEND} que se pasa como un literal IMAP4. Si es necesario (la cadena de caracteres contiene caracteres sensibles al protocolo IMAP4 y no está entre paréntesis ni comillas dobles), se cita cada cadena. Sin embargo, siempre se cita el argumento `password' para el comando @code{LOGIN}. Si desea evitar que se cite una cadena de argumento (por ejemplo: el argumento `flags' para @code{STORE}), encierre la cadena entre paréntesis (por ejemplo: @code{r'(\Deleted)'}).

Cada comando retorna una tupla: @code{(type, [data, ...])} donde `type' suele ser @code{'OK'} o @code{'NO'}, y `data' es el texto de la respuesta del comando o resultados obligatorios del comando. Cada `data' es un objeto @code{bytes} o una tupla. Si es una tupla, la primera parte es el encabezado de la respuesta, y la segunda parte contiene los datos (es decir, el valor “literal”).

Las opciones `message_set' de los siguientes comandos son una cadena de caracteres que especifica uno o más mensajes sobre los que se debe actuar. Puede ser un número de mensaje simple (@code{'1'}), un rango de números de mensaje (@code{'2:4'}) o un grupo de rangos no contiguos separados por comas (@code{'1:3,6:9'}). Un rango puede contener un asterisco para indicar un límite superior infinito (@code{'3:*'}).

Una instancia de @ref{999,,IMAP4} tiene los siguientes métodos:

@geindex append() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 append}@anchor{39f3}
@deffn {Método} IMAP4.append (mailbox, flags, date_time, message)

Agregar `mensaje' al buzón de correo con nombre.
@end deffn

@geindex authenticate() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 authenticate}@anchor{39f4}
@deffn {Método} IMAP4.authenticate (mechanism, authobject)

Autenticar comando — requiere procesamiento de respuesta.

`mechanism' especifica qué mecanismo de autenticación se utilizará; debe aparecer en la variable de instancia @code{capabilities} en la forma @code{AUTH=mechanism}.

`authobject' debe ser un objeto invocable:

@example
data = authobject(response)
@end example

Se llamará para procesar las respuestas de continuación del servidor; el argumento `response' que se pasa será @code{bytes}. Debería retornar @code{bytes} `data' que se codificarán en base64 y se enviarán al servidor. Debería retornar @code{None} si la respuesta de cancelación de cliente @code{*} se debe enviar en su lugar.


Distinto en la versión 3.5: los nombres de usuario y las contraseñas de cadena de caracteres ahora están codificados para @code{utf-8} en lugar de limitarse a ASCII.

@end deffn

@geindex check() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 check}@anchor{39f5}
@deffn {Método} IMAP4.check ()

Control del buzón de correo en el servidor.
@end deffn

@geindex close() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 close}@anchor{99e}
@deffn {Método} IMAP4.close ()

Cerrar el buzón de correo seleccionado actualmente. Los mensajes eliminados se eliminan del buzón de correo de escritura. Este es el comando recomendado antes de @code{LOGOUT}.
@end deffn

@geindex copy() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 copy}@anchor{39f6}
@deffn {Método} IMAP4.copy (message_set, new_mailbox)

Copia mensajes `message_set' al final de `new_mailbox'.
@end deffn

@geindex create() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 create}@anchor{39f7}
@deffn {Método} IMAP4.create (mailbox)

Crea un nuevo buzón de correo llamado `mailbox'.
@end deffn

@geindex delete() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 delete}@anchor{39f8}
@deffn {Método} IMAP4.delete (mailbox)

Elimina el buzón de correo antiguo llamado `mailbox'.
@end deffn

@geindex deleteacl() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 deleteacl}@anchor{39f9}
@deffn {Método} IMAP4.deleteacl (mailbox, who)

Elimina las ACLs (elimina cualquier derecho) establecidas para quién en el buzón de correo.
@end deffn

@geindex enable() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 enable}@anchor{e92}
@deffn {Método} IMAP4.enable (capability)

Habilita `capability' (ver 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html}). La mayoría de las capacidades no necesitan estar habilitadas. Actualmente solo esta soportada la capacidad @code{UTF8=ACCEPT} (consulte 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html}).


Added in version 3.5: El método @ref{e92,,enable()} en sí, y soporte 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html}.

@end deffn

@geindex expunge() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 expunge}@anchor{39fa}
@deffn {Método} IMAP4.expunge ()

Elimina permanentemente los elementos eliminados del buzón de correo seleccionado. Genera una respuesta @code{EXPUNGE} para cada mensaje eliminado. Los datos retornados contienen una lista de números de mensaje @code{EXPUNGE} en el orden recibido.
@end deffn

@geindex fetch() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 fetch}@anchor{39fb}
@deffn {Método} IMAP4.fetch (message_set, message_parts)

Obtiene (partes de) mensajes. `message_parts' debe ser una cadena de nombres de partes de mensajes encerrados entre paréntesis, por ejemplo: @code{"(UID BODY[TEXT])"}. Los datos retornados son una tupla de mensaje parte sobre y datos.
@end deffn

@geindex getacl() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getacl}@anchor{39fc}
@deffn {Método} IMAP4.getacl (mailbox)

Obtiene la @code{ACL}s para `mailbox'. El método no es estándar, pero es compatible con el servidor @code{Cyrus}.
@end deffn

@geindex getannotation() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getannotation}@anchor{39fd}
@deffn {Método} IMAP4.getannotation (mailbox, entry, attribute)

Recupera la @code{ANNOTATION}s especificada para `mailbox'. El método no es estándar, pero es compatible con el servidor @code{Cyrus}.
@end deffn

@geindex getquota() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getquota}@anchor{39fe}
@deffn {Método} IMAP4.getquota (root)

Obtiene el uso y los límites de los recursos de la @code{quota} de `root'. Este método es parte de la extensión IMAP4 QUOTA definida en rfc2087.
@end deffn

@geindex getquotaroot() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getquotaroot}@anchor{39ff}
@deffn {Método} IMAP4.getquotaroot (mailbox)

Obtiene la lista de @code{quota} @code{roots} para el nombrado `mailbox'. Este método es parte de la extensión IMAP4 QUOTA definida en rfc2087.
@end deffn

@geindex list() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 list}@anchor{3a00}
@deffn {Método} IMAP4.list ([directory[, pattern]])

Lista los nombres de buzones de correo en `directory' coincidiendo `pattern'. `directory' por defecto es la carpeta de correo de nivel superior, y `pattern' por defecto coincide con cualquier cosa. Los datos retornados contienen una lista de respuestas @code{LIST}.
@end deffn

@geindex login() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 login}@anchor{3a01}
@deffn {Método} IMAP4.login (user, password)

Identifica al cliente con una contraseña de texto sin formato. El `password' será citado.
@end deffn

@geindex login_cram_md5() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 login_cram_md5}@anchor{3a02}
@deffn {Método} IMAP4.login_cram_md5 (user, password)

Fuerza el uso de la autenticación @code{CRAM-MD5} al identificar al cliente para proteger la contraseña. Solo funcionará si la respuesta @code{CAPABILITY} del servidor incluye la frase @code{AUTH=CRAM-MD5}.
@end deffn

@geindex logout() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 logout}@anchor{3a03}
@deffn {Método} IMAP4.logout ()

Cierra la conexión al servidor. Retorna la respuesta @code{BYE} desde el servidor .


Distinto en la versión 3.8: El método ya no ignora las excepciones silenciosamente arbitrarias.

@end deffn

@geindex lsub() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 lsub}@anchor{3a04}
@deffn {Método} IMAP4.lsub (directory='""', pattern='*')

Lista los nombres de buzones de correos suscritos en el patrón de coincidencia del directorio `directory' por defecto para el directorio de nivel superior y `pattern' por defecto para que coincida con cualquier buzón de correo. Los datos retornados son una tupla de mensaje parte sobre y datos.
@end deffn

@geindex myrights() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 myrights}@anchor{3a05}
@deffn {Método} IMAP4.myrights (mailbox)

Muestra mis ACLs para un buzón de correo (es decir, los derechos que tengo sobre el buzón de correo).
@end deffn

@geindex namespace() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 namespace}@anchor{3a06}
@deffn {Método} IMAP4.namespace ()

Retorna espacios de nombres IMAP como se define en 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html}.
@end deffn

@geindex noop() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 noop}@anchor{3a07}
@deffn {Método} IMAP4.noop ()

Envía @code{NOOP} al servidor.
@end deffn

@geindex open() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 open}@anchor{99b}
@deffn {Método} IMAP4.open (host, port, timeout=None)

Opens socket to `port' at `host'. The optional `timeout' parameter
specifies a timeout in seconds for the connection attempt.
If timeout is not given or is @code{None}, the global default socket timeout
is used. Also note that if the `timeout' parameter is set to be zero,
it will raise a @ref{360,,ValueError} to reject creating a non-blocking socket.
This method is implicitly called by the @ref{999,,IMAP4} constructor.
The connection objects established by this method will be used in
the @ref{3a08,,IMAP4.read()}, @ref{3a09,,IMAP4.readline()}, @ref{3a0a,,IMAP4.send()},
and @ref{3a0b,,IMAP4.shutdown()} methods. You may override this method.

Genera un @ref{18c3,,evento de auditoría} @code{imaplib.open} con argumentos @code{self}, @code{host}, @code{port}.


Distinto en la versión 3.9: El parámetro `timeout' fue agregado.

@end deffn

@geindex partial() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 partial}@anchor{3a0c}
@deffn {Método} IMAP4.partial (message_num, message_part, start, length)

Obtiene partes truncadas de un mensaje. Los datos retornados son una tupla de mensaje parte sobre y datos.
@end deffn

@geindex proxyauth() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 proxyauth}@anchor{3a0d}
@deffn {Método} IMAP4.proxyauth (user)

Asume la autenticación como `user'. Permite a un administrador autorizado hacer un proxy en el buzón de correo de cualquier usuario.
@end deffn

@geindex read() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 read}@anchor{3a08}
@deffn {Método} IMAP4.read (size)

Lee `size' bytes del servidor remoto. Podemos sobrescribir este método.
@end deffn

@geindex readline() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 readline}@anchor{3a09}
@deffn {Método} IMAP4.readline ()

Lee una línea del servidor remoto. Podemos sobrescribir este método.
@end deffn

@geindex recent() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 recent}@anchor{3a0e}
@deffn {Método} IMAP4.recent ()

Solicita al servidor una actualización. Los datos retornados son @code{None} si no hay mensajes nuevos, de lo contrario el valor de respuesta es @code{RECENT}.
@end deffn

@geindex rename() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 rename}@anchor{3a0f}
@deffn {Método} IMAP4.rename (oldmailbox, newmailbox)

Cambia el nombre del buzón de correo llamado `oldmailbox' a `newmailbox'.
@end deffn

@geindex response() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 response}@anchor{3a10}
@deffn {Método} IMAP4.response (code)

Retorna los datos para la respuesta `code' si se recibió, o @code{None}. Retorna el código dado, en lugar del tipo habitual.
@end deffn

@geindex search() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 search}@anchor{3a11}
@deffn {Método} IMAP4.search (charset, criterion[, ...])

Busca en el buzón de correo mensajes coincidentes. El `charset' puede ser @code{None}, en cuyo caso no se especificará @code{CHARSET} en la solicitud al servidor. El protocolo IMAP requiere que se especifique al menos un criterio; se lanzará una excepción cuando el servidor retorne un error. `charset' debe ser @code{None} si la capacidad @code{UTF8=ACCEPT} se habilitó utilizando el comando @ref{e92,,enable()}.

Ejemplo:

@example
# M is a connected IMAP4 instance...
typ, msgnums = M.search(None, 'FROM', '"LDJ"')

# or:
typ, msgnums = M.search(None, '(FROM "LDJ")')
@end example
@end deffn

@geindex select() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 select}@anchor{3a12}
@deffn {Método} IMAP4.select (mailbox='INBOX', readonly=False)

Seleccione un buzón de correo. Los datos retornados son el recuento de mensajes en `mailbox' (respuesta @code{EXISTS}). El `mailbox' predeterminado es @code{'INBOX'}. Si se establece el indicador `readonly', no se permiten modificaciones en el buzón de correo.
@end deffn

@geindex send() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 send}@anchor{3a0a}
@deffn {Método} IMAP4.send (data)

Envía @code{data} al servidor remoto. Podemos sobrescribir este método.

Lanza un @ref{18c3,,evento de auditoría} @code{imaplib.send} con argumentos @code{self}, @code{data}.
@end deffn

@geindex setacl() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setacl}@anchor{3a13}
@deffn {Método} IMAP4.setacl (mailbox, who, what)

Establece una @code{ACL} para `mailbox'. El método no es estándar, pero es compatible con el servidor @code{Cyrus}.
@end deffn

@geindex setannotation() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setannotation}@anchor{3a14}
@deffn {Método} IMAP4.setannotation (mailbox, entry, attribute[, ...])

Establece @code{ANNOTATION}s para `mailbox'. El método no es estándar, pero es compatible con el servidor @code{Cyrus}.
@end deffn

@geindex setquota() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setquota}@anchor{3a15}
@deffn {Método} IMAP4.setquota (root, limits)

Establece los recursos `limits' de la @code{quota} de los `root'. Este método es parte de la extensión IMAP4 QUOTA definida en rfc2087.
@end deffn

@geindex shutdown() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 shutdown}@anchor{3a0b}
@deffn {Método} IMAP4.shutdown ()

Cierra la conexión establecida en @code{open}. Este método es llamado implícitamente por @ref{3a03,,IMAP4.logout()}. Podemos sobrescribir este método.
@end deffn

@geindex socket() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 socket}@anchor{3a16}
@deffn {Método} IMAP4.socket ()

Retorna la instancia de socket utilizada para conectarse al servidor.
@end deffn

@geindex sort() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 sort}@anchor{3a17}
@deffn {Método} IMAP4.sort (sort_criteria, charset, search_criterion[, ...])

El comando @code{sort} es una variante de @code{search} con semántica de clasificación para los resultados. Los datos retornados contienen una lista separada por espacios de números de mensajes coincidentes.

`Sort' tiene dos argumentos antes del argumento (s) `search_criterion'; una lista entre paréntesis de `sort_criteria', y la búsqueda del `charset'. Tenga en cuenta que, a diferencia de @code{search}, el argumento de búsqueda `charset' es obligatorio. También hay un comando @code{uid sort} que corresponde a @code{sort} de la misma manera que @code{uid search} corresponde a @code{search}. El comando @code{sort} primero busca en el buzón de correo mensajes que coincidan con los criterios de búsqueda dados utilizando el argumento `charset' para la interpretación de cadenas de caracteres en los criterios de búsqueda. Luego retorna los números de mensajes coincidentes.

Este es un comando de extensión @code{IMAP4rev1}.
@end deffn

@geindex starttls() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 starttls}@anchor{1292}
@deffn {Método} IMAP4.starttls (ssl_context=None)

Envía un comando @code{STARTTLS}. El argumento `ssl_context' es opcional y debe ser un objeto @ref{1fa,,ssl.SSLContext}. Esto habilitará el cifrado en la conexión IMAP. Leer @ref{3292,,Consideraciones de seguridad} para conocer las mejores prácticas.


Added in version 3.2.



Distinto en la versión 3.4: El método ahora admite la verificación del nombre de host con @ref{33af,,ssl.SSLContext.check_hostname} y `Server Name Indication' (ver @ref{33c1,,ssl.HAS_SNI}).

@end deffn

@geindex status() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 status}@anchor{3a18}
@deffn {Método} IMAP4.status (mailbox, names)

Solicita condiciones de estado con nombre para `mailbox'.
@end deffn

@geindex store() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 store}@anchor{3a19}
@deffn {Método} IMAP4.store (message_set, command, flag_list)

Altera las disposiciones de los indicadores para los mensajes en el buzón de correo. `command' esta especificado en la sección 6.4.6 de 
@geindex RFC; RFC 2060
RFC 2060@footnote{https://datatracker.ietf.org/doc/html/rfc2060.html} siendo como uno de «FLAGS», «+FLAGS» o «-FLAGS», opcionalmente con un sufijo «.SILENT».

Por ejemplo, para establecer el indicador de eliminación en todos los mensajes:

@example
typ, data = M.search(None, 'ALL')
for num in data[0].split():
   M.store(num, '+FLAGS', '\\Deleted')
M.expunge()
@end example

@cartouche
@quotation Nota 
Creating flags containing “]” (for example: «[test]») violates
@geindex RFC; RFC 3501
RFC 3501@footnote{https://datatracker.ietf.org/doc/html/rfc3501.html} (the IMAP protocol).  However, imaplib has historically
allowed creation of such tags, and popular IMAP servers, such as Gmail,
accept and produce such flags.  There are non-Python programs which also
create such tags.  Although it is an RFC violation and IMAP clients and
servers are supposed to be strict, imaplib still continues to allow
such tags to be created for backward compatibility reasons, and as of
Python 3.6, handles them if they are sent from the server, since this
improves real-world compatibility.
@end quotation
@end cartouche
@end deffn

@geindex subscribe() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 subscribe}@anchor{3a1a}
@deffn {Método} IMAP4.subscribe (mailbox)

Suscribe al nuevo buzón de correo.
@end deffn

@geindex thread() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 thread}@anchor{3a1b}
@deffn {Método} IMAP4.thread (threading_algorithm, charset, search_criterion[, ...])

El comando @code{thread} es una variante de @code{search} con semántica de hilos para los resultados. Los datos retornados contienen una lista de miembros de hilos separados por espacios.

Los miembros de del hilo (`thread') consisten en cero o más números de mensajes, delimitados por espacios, que indican sucesivos padres e hijos.

`Thread' tiene dos argumentos antes del argumento(s) `search_criterion'; un `threading_algorithm', y la búsqueda del `charset'. Tenga en cuenta que, a diferencia de @code{search}, el argumento de búsqueda `charset' es obligatorio. También hay un comando @code{uid thread} que corresponde a @code{thread} de la misma manera que @code{uid search} corresponde a @code{search}. El comando @code{thread} primero busca en el buzón de correo mensajes que coincidan con los criterios de búsqueda dados utilizando el argumento `charset' para la interpretación de cadenas de caracteres en los criterios de búsqueda. Luego retorna los mensajes coincidentes enfilados según el algoritmo de subproceso especificado.

Este es un comando de extensión @code{IMAP4rev1}.
@end deffn

@geindex uid() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 uid}@anchor{3a1c}
@deffn {Método} IMAP4.uid (command, arg[, ...])

Ejecuta argumentos de comando con mensajes identificados por UID, en lugar de número de mensaje. Retorna la respuesta apropiada al comando. Se debe proporcionar al menos un argumento; Si no se proporciona ninguno, el servidor retornará un error y se lanzará una excepción.
@end deffn

@geindex unsubscribe() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 unsubscribe}@anchor{3a1d}
@deffn {Método} IMAP4.unsubscribe (mailbox)

Darse de baja del antiguo buzón de correo.
@end deffn

@geindex unselect() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 unselect}@anchor{99d}
@deffn {Método} IMAP4.unselect ()

@ref{99d,,imaplib.IMAP4.unselect()} libera recursos del servidor asociados al buzón de correo seleccionado y devuelve el servidor al estado autenticado. Este comando realiza las mismas acciones que @ref{99e,,imaplib.IMAP4.close()}, con la excepción de que ningún mensaje es permanentemente borrado del buzón de correo actualmente seleccionado.


Added in version 3.9.

@end deffn

@geindex xatom() (método de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 xatom}@anchor{3a1e}
@deffn {Método} IMAP4.xatom (name[, ...])

Permite comandos de extensión simples notificados por el servidor en la respuesta @code{CAPABILITY}.
@end deffn

Los siguientes atributos se definen en instancias de @ref{999,,IMAP4}:

@geindex PROTOCOL_VERSION (atributo de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 PROTOCOL_VERSION}@anchor{3a1f}
@deffn {Atributo} IMAP4.PROTOCOL_VERSION

El protocolo mas recientemente admitido en la respuesta @code{CAPABILITY} desde el servidor.
@end deffn

@geindex debug (atributo de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 debug}@anchor{3a20}
@deffn {Atributo} IMAP4.debug

Valor entero para controlar la salida de depuración. El valor de inicialización se toma de la variable del módulo @code{Debug}. Valores mayores de tres rastrean cada comando.
@end deffn

@geindex utf8_enabled (atributo de imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 utf8_enabled}@anchor{e93}
@deffn {Atributo} IMAP4.utf8_enabled

Valor booleano que normalmente es @code{False}, pero se establece en @code{True} si un comando @ref{e92,,enable()} es exitosamente emitido para la capacidad @code{UTF8=ACCEPT}.


Added in version 3.5.

@end deffn

@node Ejemplo IMAP4,,Objetos de IMAP4,imaplib — IMAP4 protocol client
@anchor{library/imaplib id2}@anchor{3a21}@anchor{library/imaplib imap4-example}@anchor{3a22}
@subsubsection Ejemplo IMAP4


Aquí hay un ejemplo mínimo (sin verificación de errores) que abre un buzón de correo y recupera e imprime todos los mensajes:

@example
import getpass, imaplib

M = imaplib.IMAP4(host='example.org')
M.login(getpass.getuser(), getpass.getpass())
M.select()
typ, data = M.search(None, 'ALL')
for num in data[0].split():
    typ, data = M.fetch(num, '(RFC822)')
    print('Message %s\n%s\n' % (num, data[0][1]))
M.close()
M.logout()
@end example

@node smtplib — SMTP protocol client,uuid — UUID objects according to RFC 9562,imaplib — IMAP4 protocol client,Protocolos y soporte de Internet
@anchor{library/smtplib doc}@anchor{3a23}@anchor{library/smtplib module-smtplib}@anchor{ca}@anchor{library/smtplib smtplib-smtp-protocol-client}@anchor{3a24}
@subsection @code{smtplib} — SMTP protocol client


@geindex module; smtplib

`Código fuente:' Lib/smtplib.py@footnote{https://github.com/python/cpython/tree/main/Lib/smtplib.py}

@geindex SMTP;protocol
@geindex Simple Mail Transfer Protocol


__________________________________________________________________


El módulo @ref{ca,,smtplib} define un objeto de sesión de cliente SMTP que se puede utilizar para enviar correo a cualquier máquina de Internet con un demonio de escucha SMTP o ESMTP. Para obtener detalles sobre el funcionamiento de SMTP y ESMTP, consulte 
@geindex RFC; RFC 821
RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} (Protocolo simple de transferencia de correo) y 
@geindex RFC; RFC 1869
RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} (Extensiones de servicio SMTP).

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@geindex SMTP (clase en smtplib)
@anchor{library/smtplib smtplib SMTP}@anchor{9c0}
@deffn {Clase} smtplib.SMTP (host='@w{'}, port=0, local_hostname=None[, timeout], source_address=None)

An @ref{9c0,,SMTP} instance encapsulates an SMTP connection.  It has methods
that support a full repertoire of SMTP and ESMTP operations. If the optional
`host' and `port' parameters are given, the SMTP @ref{19d3,,connect()} method is
called with those parameters during initialization.  If specified,
`local_hostname' is used as the FQDN of the local host in the HELO/EHLO
command.  Otherwise, the local hostname is found using
@ref{1784,,socket.getfqdn()}.  If the @ref{19d3,,connect()} call returns anything other
than a success code, an @ref{3a25,,SMTPConnectError} is raised. The optional
`timeout' parameter specifies a timeout in seconds for blocking operations
like the connection attempt (if not specified, the global default timeout
setting will be used).  If the timeout expires, @ref{8cc,,TimeoutError} is
raised.  The optional `source_address' parameter allows binding
to some specific source address in a machine with multiple network
interfaces, and/or to some specific source TCP port. It takes a 2-tuple
@code{(host, port)}, for the socket to bind to as its source address before
connecting. If omitted (or if `host' or `port' are @code{'@w{'}} and/or @code{0}
respectively) the OS default behavior will be used.

Para un uso normal, solo debe requerir los métodos initialization/connect, @ref{ed9,,sendmail()} y @ref{3a26,,SMTP.quit()}. A continuación se incluye un ejemplo.

La clase @ref{9c0,,SMTP} admite la instrucción @ref{673,,with}. Cuando se usa así, el comando SMTP @code{QUIT} se emite automáticamente cuando la @code{with} sale de la instrucción. por ejemplo:

@example
>>> from smtplib import SMTP
>>> with SMTP("domain.org") as smtp:
...     smtp.noop()
...
(250, b'Ok')
>>>
@end example

Todos los comandos lanzarán un @ref{18c3,,evento de auditoría} @code{smtplib.SMTP.send} con argumentos @code{self} y @code{data}, donde @code{data} son los bytes que están a punto de ser enviado al host remoto.


Distinto en la versión 3.3: Se agregó soporte para la sentencia @ref{673,,with}.



Distinto en la versión 3.3: `source_address' argument was added.



Added in version 3.5: La extensión SMTPUTF8 (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}) ahora es compatible.



Distinto en la versión 3.9: If the `timeout' parameter is set to be zero, it will raise a
@ref{360,,ValueError} to prevent the creation of a non-blocking socket.

@end deffn

@geindex SMTP_SSL (clase en smtplib)
@anchor{library/smtplib smtplib SMTP_SSL}@anchor{9c1}
@deffn {Clase} smtplib.SMTP_SSL (host='@w{'}, port=0, local_hostname=None, *[, timeout], context=None, source_address=None)

Una instancia de @ref{9c1,,SMTP_SSL} se comporta exactamente igual que las instancias de @ref{9c0,,SMTP}. @ref{9c1,,SMTP_SSL} debe usarse para situaciones donde se requiere SSL desde el comienzo de la conexión y el uso @code{starttls()} no es apropiado. Si no se especifica `host', se utiliza el host local. Si `port' es cero, se utiliza el puerto estándar SMTP sobre SSL (465). Los argumentos opcionales `local_hostname', `timeout' y `source_address' tienen el mismo significado que en la clase @ref{9c0,,SMTP}. `context', también opcional, puede contener una @ref{1fa,,SSLContext} y permite configurar varios aspectos de la conexión segura. Por favor lea @ref{3292,,Consideraciones de seguridad} para conocer las mejores prácticas.


Distinto en la versión 3.3: se agregó `contexto'.



Distinto en la versión 3.3: The `source_address' argument was added.



Distinto en la versión 3.4: The class now supports hostname check with
@ref{33af,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{33c1,,ssl.HAS_SNI}).



Distinto en la versión 3.9: Si el parámetro `timeout' se mantiene en cero, lanzará un @ref{360,,ValueError} para evitar la creación de un socket no bloqueante



Distinto en la versión 3.12: The deprecated `keyfile' and `certfile' parameters have been removed.

@end deffn

@geindex LMTP (clase en smtplib)
@anchor{library/smtplib smtplib LMTP}@anchor{9c2}
@deffn {Clase} smtplib.LMTP (host='@w{'}, port=LMTP_PORT, local_hostname=None, source_address=None[, timeout])

The LMTP protocol, which is very similar to ESMTP, is heavily based on the
standard SMTP client. It’s common to use Unix sockets for LMTP, so our
@code{connect()} method must support that as well as a regular host:port
server. The optional arguments `local_hostname' and `source_address' have the
same meaning as they do in the @ref{9c0,,SMTP} class. To specify a Unix
socket, you must use an absolute path for `host', starting with a “/”.

Se admite la autenticación mediante el mecanismo SMTP habitual. Cuando se usa un socket Unix, LMTP generalmente no admite ni requiere autenticación, pero su millaje puede variar.


Distinto en la versión 3.9: Se ha añadido el parámetro opcional `timeout'.

@end deffn

También se define una buena selección de excepciones:

@geindex SMTPException
@anchor{library/smtplib smtplib SMTPException}@anchor{101f}
@deffn {Excepción} smtplib.SMTPException

Subclase de @ref{4d5,,OSError} que es la clase de excepción base para todas las demás excepciones proporcionadas por este módulo.


Distinto en la versión 3.4: SMTPException se convirtió en subclase de @ref{4d5,,OSError}

@end deffn

@geindex SMTPServerDisconnected
@anchor{library/smtplib smtplib SMTPServerDisconnected}@anchor{3a27}
@deffn {Excepción} smtplib.SMTPServerDisconnected

Esta excepción se genera cuando el servidor se desconecta inesperadamente o cuando se intenta usar la instancia @ref{9c0,,SMTP} antes de conectarlo a un servidor.
@end deffn

@geindex SMTPResponseException
@anchor{library/smtplib smtplib SMTPResponseException}@anchor{3a28}
@deffn {Excepción} smtplib.SMTPResponseException

Clase base para todas las excepciones que incluyen un código de error SMTP. Estas excepciones se generan en algunos casos cuando el servidor SMTP devuelve un código de error. El código de error se almacena en el atributo @code{smtp_code} del error, y el atributo @code{smtp_error} se establece en el mensaje de error.
@end deffn

@geindex SMTPSenderRefused
@anchor{library/smtplib smtplib SMTPSenderRefused}@anchor{3a29}
@deffn {Excepción} smtplib.SMTPSenderRefused

Dirección del remitente rechazada.  Además de los atributos establecidos por todas las excepciones @ref{3a28,,SMTPResponseException}, éste establece “remitente” para la cadena de caracteres que el servidor SMTP rechazó.
@end deffn

@geindex SMTPRecipientsRefused
@anchor{library/smtplib smtplib SMTPRecipientsRefused}@anchor{3a2a}
@deffn {Excepción} smtplib.SMTPRecipientsRefused

Se rechazaron todas las direcciones de destinatarios.  Los errores para cada destinatario son accesibles mediante el atributo @code{recipients}, el cual es un diccionario del mismo tipo que el @ref{ed9,,SMTP.sendmail()} retorna.
@end deffn

@geindex SMTPDataError
@anchor{library/smtplib smtplib SMTPDataError}@anchor{3a2b}
@deffn {Excepción} smtplib.SMTPDataError

El servidor SMTP se negó a aceptar los datos del mensaje.
@end deffn

@geindex SMTPConnectError
@anchor{library/smtplib smtplib SMTPConnectError}@anchor{3a25}
@deffn {Excepción} smtplib.SMTPConnectError

Se produjo un error durante el establecimiento de conexión  con el servidor.
@end deffn

@geindex SMTPHeloError
@anchor{library/smtplib smtplib SMTPHeloError}@anchor{3a2c}
@deffn {Excepción} smtplib.SMTPHeloError

El servidor rechazó nuestro mensaje @code{HELO}.
@end deffn

@geindex SMTPNotSupportedError
@anchor{library/smtplib smtplib SMTPNotSupportedError}@anchor{19d2}
@deffn {Excepción} smtplib.SMTPNotSupportedError

El servidor no admite el comando o la opción que se intentó.


Added in version 3.5.

@end deffn

@geindex SMTPAuthenticationError
@anchor{library/smtplib smtplib SMTPAuthenticationError}@anchor{3a2d}
@deffn {Excepción} smtplib.SMTPAuthenticationError

La autenticación SMTP salió mal.  Lo más probable es que el servidor no aceptó la combinación proporcionada de username/password.
@end deffn


@subsubheading Ver también



@table @asis

@geindex RFC; RFC 821

@item RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} - Simple Mail Transfer Protocol

Definición de protocolo para SMTP. Este documento cubre el modelo, el procedimiento operativo y los detalles del protocolo para SMTP.

@geindex RFC; RFC 1869

@item RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} - Extensiones de Servicio SMTP

Definición de las extensiones ESMTP para SMTP. Esto describe un marco para extender SMTP con nuevos comandos, que admite el descubrimiento dinámico de los comandos proporcionados por el servidor y define algunos comandos adicionales.
@end table


@menu
* Objetos SMTP:: 
* Ejemplo SMTP:: 

@end menu

@node Objetos SMTP,Ejemplo SMTP,,smtplib — SMTP protocol client
@anchor{library/smtplib id1}@anchor{3a2e}@anchor{library/smtplib smtp-objects}@anchor{3a2f}
@subsubsection Objetos SMTP


Una instancia @ref{9c0,,SMTP} tiene los siguientes métodos:

@geindex set_debuglevel() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP set_debuglevel}@anchor{ed8}
@deffn {Método} SMTP.set_debuglevel (level)

Establezca el nivel de salida de depuración. Un valor de 1 o @code{True} para `level' da como resultado mensajes de depuración para la conexión y para todos los mensajes enviados y recibidos desde el servidor. Un valor de 2 para `level' da como resultado que estos mensajes tengan una marca de tiempo.


Distinto en la versión 3.5: Se agregó el nivel de depuración 2.

@end deffn

@geindex docmd() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP docmd}@anchor{3a30}
@deffn {Método} SMTP.docmd (cmd, args='@w{'})

Envíe un comando `cmd' al servidor. El argumento opcional `args' simplemente se concatena al comando, separado por un espacio.

Esto devuelve una tupla de 2 compuestos por un código de respuesta numérico y la línea de respuesta real (las respuestas de varias líneas se unen en una línea larga).

En funcionamiento normal, no debería ser necesario llamar a este método explícitamente. Se utiliza para implementar otros métodos y puede resultar útil para probar extensiones privadas.

Si se pierde la conexión con el servidor mientras se espera la respuesta, se activará @ref{3a27,,SMTPServerDisconnected}.
@end deffn

@geindex connect() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP connect}@anchor{19d3}
@deffn {Método} SMTP.connect (host='localhost', port=0)

Conéctese a un host en un puerto determinado. Los valores predeterminados son para conectarse al host local en el puerto SMTP estándar (25). Si el nombre de host termina con dos puntos (@code{':'}) seguido de un número, ese sufijo se eliminará y el número se interpretará como el número de puerto a utilizar. El constructor invoca automáticamente este método si se especifica un host durante la instanciación. Devuelve una tupla de 2 del código de respuesta y el mensaje enviado por el servidor en su respuesta de conexión.

Genera un @ref{18c3,,evento de auditoría} @code{smtplib.connect} con argumentos @code{self}, @code{host}, @code{port}.
@end deffn

@geindex helo() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP helo}@anchor{3a31}
@deffn {Método} SMTP.helo (name='@w{'})

Identifíquese en el servidor SMTP usando @code{HELO}. El argumento del nombre de host tiene como valor predeterminado el nombre de dominio completo del host local. El mensaje devuelto por el servidor se almacena como el atributo @code{helo_resp} del objeto.

En funcionamiento normal, no debería ser necesario llamar a este método explícitamente. Será llamado implícitamente por @ref{ed9,,sendmail()} cuando sea necesario.
@end deffn

@geindex ehlo() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP ehlo}@anchor{3a32}
@deffn {Método} SMTP.ehlo (name='@w{'})

Identifíquese en un servidor ESMTP mediante @code{EHLO}. El argumento del nombre de host tiene como valor predeterminado el nombre de dominio completo del host local. Examine la respuesta para la opción ESMTP y guárdelos para que los utilice @ref{3a33,,has_extn()}. También establece varios atributos informativos: el mensaje retornado por el servidor se almacena como el atributo @code{ehlo_resp}, @code{does_esmtp} se establece en @code{True} o @code{False} dependiendo de si el servidor admite ESMTP, y @code{esmtp_features} será un diccionario que contiene los nombres de las extensiones de servicio SMTP de este servidor soportes, y sus parámetros (si los hay).

A menos que desee utilizar @ref{3a33,,has_extn()} antes de enviar correo, no debería ser necesario llamar a este método explícitamente. Se llamará implícitamente por @ref{ed9,,sendmail()} cuando sea necesario.
@end deffn

@geindex ehlo_or_helo_if_needed() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP ehlo_or_helo_if_needed}@anchor{3a34}
@deffn {Método} SMTP.ehlo_or_helo_if_needed ()

Este método llama a @ref{3a32,,ehlo()} o @ref{3a31,,helo()} si no ha habido ningún comando @code{EHLO} o @code{HELO} anterior en esta sesión. Primero prueba ESMTP @code{EHLO}.


@table @asis

@item @ref{3a2c,,SMTPHeloError}

El servidor no respondió correctamente al saludo @code{HELO}.
@end table
@end deffn

@geindex has_extn() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP has_extn}@anchor{3a33}
@deffn {Método} SMTP.has_extn (name)

Retorna @ref{c95,,True} si `name' está en el conjunto de extensiones de servicio SMTP devueltas por el servidor, @ref{bbf,,False} en caso contrario. El método es insensible a la presencia de mayúsculas en `name'.
@end deffn

@geindex verify() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP verify}@anchor{3a35}
@deffn {Método} SMTP.verify (address)

Verifique la validez de una dirección en este servidor usando SMTP @code{VRFY}. Retorna una tupla que consta del código 250 y una dirección completa 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} (incluido el nombre humano) si la dirección del usuario es válida. De lo contrario, devuelve un código de error SMTP de 400 o más y una cadena de error.

@cartouche
@quotation Nota 
Muchos sitios desactivan SMTP @code{VRFY} para frustrar a los spammers.
@end quotation
@end cartouche
@end deffn

@geindex login() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP login}@anchor{3a36}
@deffn {Método} SMTP.login (user, password, *, initial_response_ok=True)

Inicie sesión en un servidor SMTP que requiera autenticación. Los argumentos son el nombre de usuario y la contraseña para autenticarse. Si no ha habido ningún comando @code{EHLO} o @code{HELO} anterior en esta sesión, este método prueba primero ESMTP @code{EHLO}. Este método regresará normalmente si la autenticación fue exitosa o puede generar las siguientes excepciones:


@table @asis

@item @ref{3a2c,,SMTPHeloError}

El servidor no respondió correctamente al saludo @code{HELO}.

@item @ref{3a2d,,SMTPAuthenticationError}

El servidor no aceptó la combinación de nombre de username/password.

@item @ref{19d2,,SMTPNotSupportedError}

El servidor no admite el comando @code{AUTH}.

@item @ref{101f,,SMTPException}

No se encontró ningún método de autenticación adecuado.
@end table

Cada uno de los métodos de autenticación admitidos por @ref{ca,,smtplib} se prueban a su vez si se anuncian como admitidos por el servidor. Consulte @ref{ed7,,auth()} para obtener una lista de los métodos de autenticación admitidos. `initial_response_ok' se pasa a @ref{ed7,,auth()}.

El argumento de palabra clave opcional `initial_response_ok' especifica si, para los métodos de autenticación que lo admiten, se puede enviar una «respuesta inicial» como se especifica en 
@geindex RFC; RFC 4954
RFC 4954@footnote{https://datatracker.ietf.org/doc/html/rfc4954.html} junto con el comando @code{AUTH}, en lugar de requerir un desafío/respuesta .


Distinto en la versión 3.5: @ref{19d2,,SMTPNotSupportedError} se puede generar y se agregó el parámetro `initial_response_ok'.

@end deffn

@geindex auth() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP auth}@anchor{ed7}
@deffn {Método} SMTP.auth (mechanism, authobject, *, initial_response_ok=True)

Emita un comando @code{SMTP} @code{AUTH} para el `mechanism' de autenticación especificado y maneje la respuesta de desafío a través de `authobject'.

`mechanism' especifica qué mecanismo de autenticación se utilizará como argumento para el comando @code{AUTH}; los valores válidos son los enumerados en el elemento @code{auth} de @code{esmtp_features}.

`authobject' must be a callable object taking an optional single argument:

@example
data = authobject(challenge=None)
@end example

Si la verificación de respuesta inicial devuelve @code{None}, o si `initial_response_ok' es falso, se llamará a @code{authobject()} para procesar la respuesta de desafío del servidor; el argumento `challenge' que se pasa será un @code{bytes}. Debería devolver `data' ASCII @code{str} que serán codificados en base64 y enviados al servidor.

Si la verificación de respuesta inicial devuelve @code{None}, o si `initial_response_ok' es falso, se llamará a @code{authobject()} para procesar la respuesta de desafío del servidor; el argumento `challenge' que se pasa será un @code{bytes}. Debería devolver `data' ASCII @code{str} que serán codificados en base64 y enviados al servidor.

La clase @code{SMTP} proporciona @code{authobjects} para los mecanismos @code{CRAM-MD5}, @code{PLAIN} y @code{LOGIN}; se denominan @code{SMTP.auth_cram_md5}, @code{SMTP.auth_plain} y @code{SMTP.auth_login} respectivamente. Todos requieren que las propiedades de @code{user} y @code{password} de la instancia @code{SMTP} se establezcan en los valores adecuados.

El código de usuario normalmente no necesita llamar a @code{auth} directamente, sino que puede llamar al método @ref{3a36,,login()}, que probará cada uno de los mecanismos anteriores a su vez, en el orden indicado. @code{auth} está expuesto para facilitar la implementación de métodos de autenticación que no (o aún no) son compatibles directamente con @ref{ca,,smtplib}.


Added in version 3.5.

@end deffn

@geindex starttls() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP starttls}@anchor{11aa}
@deffn {Método} SMTP.starttls (*, context=None)

Ponga la conexión SMTP en modo TLS (Seguridad de la capa de transporte). Todos los comandos SMTP que siguen se cifrarán. Entonces deberías llamar a @ref{3a32,,ehlo()} de nuevo.

Si se proporcionan `keyfile' y `certfile', se utilizan para crear una @ref{1fa,,ssl.SSLContext}.

El parámetro `context' opcional es un objeto @ref{1fa,,ssl.SSLContext}; Esta es una alternativa al uso de un archivo de claves y un archivo de certificado y, si se especifica, tanto `keyfile' como `certfile' deben ser @code{None}.

Si no ha habido ningún comando @code{EHLO} o @code{HELO} anterior en esta sesión, este método intenta ESMTP @code{EHLO} primero.


Distinto en la versión 3.12: The deprecated `keyfile' and `certfile' parameters have been removed.



@table @asis

@item @ref{3a2c,,SMTPHeloError}

El servidor no respondió correctamente al saludo @code{HELO}.

@item @ref{19d2,,SMTPNotSupportedError}

El servidor no admite la extensión STARTTLS.

@item @ref{1e5,,RuntimeError}

La compatibilidad con SSL/TLS no está disponible para su intérprete de Python.
@end table


Distinto en la versión 3.3: se agregó `contexto'.



Distinto en la versión 3.4: The method now supports hostname check with
@code{SSLContext.check_hostname} and `Server Name Indicator' (see
@ref{33c1,,HAS_SNI}).



Distinto en la versión 3.5: El error generado por falta de compatibilidad con STARTTLS ahora es la subclase @ref{19d2,,SMTPNotSupportedError} en lugar de la base @ref{101f,,SMTPException}.

@end deffn

@geindex sendmail() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP sendmail}@anchor{ed9}
@deffn {Método} SMTP.sendmail (from_addr, to_addrs, msg, mail_options=(), rcpt_options=())

Enviar correo. Los argumentos requeridos son 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} cadena de dirección de origen, una lista de 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} cadenas de dirección (una cadena simple se tratará como una lista con 1 dirección) y una cadena de mensaje. La persona que llama puede pasar una lista de opciones de ESMTP (como @code{8bitmime}) para usar en los comandos @code{MAIL FROM} como `mail_options'. Las opciones de ESMTP (como los comandos @code{DSN}) que deben usarse con todos los comandos @code{RCPT} se pueden pasar como `rcpt_options'. (Si necesita usar diferentes opciones de ESMTP para diferentes destinatarios, debe usar los métodos de bajo nivel como @code{mail()}, @code{rcpt()} y @code{data()} para enviar el mensaje).

@cartouche
@quotation Nota 
Los parámetros `from_addr' y `to_addrs' se utilizan para construir el sobre del mensaje utilizado por los agentes de transporte. @code{sendmail} no modifica los encabezados de los mensajes de ninguna manera.
@end quotation
@end cartouche

`msg' puede ser una cadena que contenga caracteres en el rango ASCII o una cadena de bytes. Una cadena se codifica en bytes utilizando el códec ascii, y los caracteres @code{\r} y @code{\n} solitarios se convierten en caracteres @code{\ r\n}. Una cadena de bytes no se modifica.

Si no ha habido ningún comando @code{EHLO} o @code{HELO} anterior en esta sesión, este método prueba primero ESMTP @code{EHLO}. Si el servidor utiliza ESMTP, se le pasará el tamaño del mensaje y cada una de las opciones especificadas (si la opción está en el conjunto de funciones que anuncia el servidor). Si @code{EHLO} falla, se probará @code{HELO} y se eliminarán las opciones de ESMTP.

Este método volverá normalmente si se acepta el correo para al menos un destinatario. De lo contrario, lanzará una excepción. Es decir, si este método no genera una excepción, alguien debería recibir su correo. Si este método no genera una excepción, devuelve un diccionario, con una entrada para cada destinatario rechazado. Cada entrada contiene una tupla del código de error SMTP y el mensaje de error adjunto enviado por el servidor.

Si se incluye @code{SMTPUTF8}” en `mail_options * y el servidor lo admite, *from_addr' y `to_addrs' pueden contener caracteres no ASCII.

Este método puede lanzar las siguientes excepciones:


@table @asis

@item @ref{3a2a,,SMTPRecipientsRefused}

Todos los destinatarios fueron rechazados. Nadie recibió el correo. El atributo @code{recipients} del objeto de excepción es un diccionario con información sobre los destinatarios rechazados (como el que se retorna cuando se aceptó al menos un destinatario).

@item @ref{3a2c,,SMTPHeloError}

El servidor no respondió correctamente al saludo @code{HELO}.

@item @ref{3a29,,SMTPSenderRefused}

El servidor no aceptó el `from_addr'.

@item @ref{3a2b,,SMTPDataError}

El servidor respondió con un código de error inesperado (que no sea el rechazo de un destinatario).

@item @ref{19d2,,SMTPNotSupportedError}

Se proporcionó @code{SMTPUTF8} en `mail_options' pero el servidor no lo admite.
@end table

A menos que se indique lo contrario, la conexión estará abierta incluso después de que se lance una excepción.


Distinto en la versión 3.2: `msg' puede ser una cadena de bytes.



Distinto en la versión 3.5: Se agregó compatibilidad con @code{SMTPUTF8}, así que la @ref{19d2,,SMTPNotSupportedError} puede ser lanzada si se especifica @code{SMTPUTF8} ya que el servidor no lo admite.

@end deffn

@geindex send_message() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP send_message}@anchor{eda}
@deffn {Método} SMTP.send_message (msg, from_addr=None, to_addrs=None, mail_options=(), rcpt_options=())

Este es un método conveniente para llamar a @ref{ed9,,sendmail()} con el mensaje representado por un objeto @ref{3d1,,email.message.Message}. Los argumentos tienen el mismo significado que para @ref{ed9,,sendmail()}, excepto que `msg' es un objeto @code{Mensaje}.

Si `from_addr' es @code{None} o `to_addrs' es @code{None}, @code{send_message} llena esos argumentos con direcciones extraídas de los encabezados de `msg' como se especifica en 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}: `from_addr' se establece en el campo @code{Sender} si está presente, y de lo contrario, en el campo @code{From}. `to_addrs' combina los valores (si los hay) de los campos @code{To}, @code{Cc} y @code{Bcc} de `msg'. Si aparece exactamente un conjunto de encabezados @code{Resent-*} en el mensaje, los encabezados normales se ignoran y en su lugar se utilizan los encabezados @code{Resent- *}. Si el mensaje contiene más de un conjunto de encabezados @code{Resent-*}, se lanza un @ref{360,,ValueError}, ya que no hay forma de detectar sin ambigüedades el conjunto más reciente de encabezados @code{Resent-}.

@code{send_message} serializa `msg' usando @ref{123c,,BytesGenerator} con @code{\r\n} como `linesep', y llama a @ref{ed9,,sendmail()} para transmitir el mensaje resultante.  Independientemente de los valores de `from_addr' y `to_addrs', @code{send_message} no transmite ningún encabezado @code{Bcc} o @code{Resent-Bcc} que puedan aparecer en `msg'.  Si alguna de las direcciones en `from_addr' y `to_addrs' contiene caracteres que no son ASCII y el servidor no anuncia la compatibilidad con @code{SMTPUTF8}, se lanza un error @code{SMTPNotSupported}.  De lo contrario, el @code{Message} se serializa con un clon de su @ref{50,,policy} con el atributo @ref{e7d,,utf8} establecido en @code{True} y @code{SMTPUTF8} y @code{BODY=8BITMIME} se agregan a `mail_options'.


Added in version 3.2.



Added in version 3.5: Soporte para direcciones internacionalizadas (@code{SMTPUTF8}).

@end deffn

@geindex quit() (método de smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP quit}@anchor{3a26}
@deffn {Método} SMTP.quit ()

Termine la sesión SMTP y cierre la conexión.  Retorna el resultado del comando SMTP @code{QUIT}.
@end deffn

Los métodos de bajo nivel correspondientes a los comandos estándar SMTP/ESMTP @code{`HELP}, @code{RSET}, @code{NOOP}, @code{MAIL}, @code{RCPT}, y @code{DATA} también están soportados. Normalmente, no es necesario llamarlos directamente, por lo que no se documentan aquí. Para más detalles, consulte el código del módulo.

@node Ejemplo SMTP,,Objetos SMTP,smtplib — SMTP protocol client
@anchor{library/smtplib id2}@anchor{3a37}@anchor{library/smtplib smtp-example}@anchor{3a38}
@subsubsection Ejemplo SMTP


This example prompts the user for addresses needed in the message envelope (“To”
and “From” addresses), and the message to be delivered.  Note that the headers
to be included with the message must be included in the message as entered; this
example doesn’t do any processing of the 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} headers.  In particular, the
“To” and “From” addresses must be included in the message headers explicitly:

@example
import smtplib

def prompt(title):
    return input(title).strip()

from_addr = prompt("From: ")
to_addrs  = prompt("To: ").split()
print("Enter message, end with ^D (Unix) or ^Z (Windows):")

# Add the From: and To: headers at the start!
lines = [f"From: @{from_addr@}", f"To: @{', '.join(to_addrs)@}", ""]
while True:
    try:
        line = input()
    except EOFError:
        break
    else:
        lines.append(line)

msg = "\r\n".join(lines)
print("Message length is", len(msg))

server = smtplib.SMTP("localhost")
server.set_debuglevel(1)
server.sendmail(from_addr, to_addrs, msg)
server.quit()
@end example

@cartouche
@quotation Nota 
En general, querrá usar las características del paquete @ref{3c,,email} para construir un mensaje de correo electrónico, que luego puede enviar a través de @ref{eda,,send_message()}; ver @ref{fbc,,email; Ejemplos}.
@end quotation
@end cartouche

@node uuid — UUID objects according to RFC 9562,socketserver — A framework for network servers,smtplib — SMTP protocol client,Protocolos y soporte de Internet
@anchor{library/uuid doc}@anchor{3a39}@anchor{library/uuid module-uuid}@anchor{110}@anchor{library/uuid uuid-uuid-objects-according-to-rfc-9562}@anchor{3a3a}
@subsection @code{uuid} — UUID objects according to 
@geindex RFC; RFC 9562
`RFC 9562'


@geindex module; uuid

`Código fuente:' Lib/uuid.py@footnote{https://github.com/python/cpython/tree/main/Lib/uuid.py}


__________________________________________________________________


This module provides immutable @ref{af1,,UUID} objects (the @ref{af1,,UUID} class)
and the functions @ref{c30,,uuid1()}, @ref{174d,,uuid3()}, @ref{3a3b,,uuid4()}, @ref{174e,,uuid5()},
and @ref{1ba,,uuid.uuid8()} for generating version 1, 3, 4, 5, and 8 UUIDs as
specified in 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} (which supersedes 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}).

Si todo lo que quieres es una identificación única, probablemente deberías llamar a @code{uuuid1()} o @ref{3a3b,,uuid4()}.  Ten en cuenta que @ref{c30,,uuid1()} puede comprometer la privacidad ya que crea un UUID que contiene la dirección de red del ordenador. @ref{3a3b,,uuid4()} crea un UUID aleatorio.

Dependiendo del soporte de la plataforma subyacente, @ref{c30,,uuid1()} puede o no retornar un UUID «seguro». Un UUID seguro es aquel que se genera mediante métodos de sincronización que aseguran que ningún proceso pueda obtener el mismo UUID. Todas las instancias de @ref{af1,,UUID} tienen un atributo @ref{c2e,,is_safe} que transmite cualquier información sobre la seguridad del UUID, usando esta enumeración:

@geindex SafeUUID (clase en uuid)
@anchor{library/uuid uuid SafeUUID}@anchor{3a3c}
@deffn {Clase} uuid.SafeUUID


Added in version 3.7.


@geindex safe (atributo de uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID safe}@anchor{3a3d}
@deffn {Atributo} safe

El UUID fue generado por la plataforma de una manera segura para multiprocesamiento.
@end deffn

@geindex unsafe (atributo de uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID unsafe}@anchor{3a3e}
@deffn {Atributo} unsafe

El UUID no fue generado por la plataforma de una manera segura de multiprocesamiento.
@end deffn

@geindex unknown (atributo de uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID unknown}@anchor{3a3f}
@deffn {Atributo} unknown

La plataforma no proporciona información sobre si el UUID se generó de forma segura o no.
@end deffn
@end deffn

@geindex UUID (clase en uuid)
@anchor{library/uuid uuid UUID}@anchor{af1}
@deffn {Clase} uuid.UUID (hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

Crea un UUID a partir de una cadena de 32 dígitos hexadecimales, una cadena de 16 bytes en orden `big-endian' como el argumento `bytes', una cadena de 16 bytes en orden `little-endian' como el argumento `bytes_le', una tupla de seis enteros (32-bit `time_low', 16-bit `time_mid', 16-bit `time_hi_version', 8-bit `clock_seq_hi_variant', 8-bit `clock_seq_low', 48-bit `node') como el argumento `fields', o un solo entero de 128-bit como el argumento `int'. Cuando se da una cadena de dígitos hexadecimales, los corchetes, los guiones y el prefijo URN son todos opcionales.  Por ejemplo, todas estas expresiones producen el mismo UUID:

@example
UUID('@{12345678-1234-5678-1234-567812345678@}')
UUID('12345678123456781234567812345678')
UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
UUID(bytes=b'\x12\x34\x56\x78'*4)
UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' +
              b'\x12\x34\x56\x78\x12\x34\x56\x78')
UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
UUID(int=0x12345678123456781234567812345678)
@end example

Exactly one of `hex', `bytes', `bytes_le', `fields', or `int' must be given.
The `version' argument is optional; if given, the resulting UUID will have its
variant and version number set according to 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}, overriding bits in the
given `hex', `bytes', `bytes_le', `fields', or `int'.

La comparación de los objetos UUID se hace mediante la comparación de sus atributos @code{UID.int}.  La comparación con un objeto no UUID produce un @ref{228,,TypeError}.

@code{str(uuid)} retorna una cadena en la forma @code{12345678-1234-5678-1234-567812345678} donde los 32 dígitos hexadecimales representan el UUID.
@end deffn

Las instancias de @ref{af1,,UUID} tienen estos atributos de sólo lectura:

@geindex bytes (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID bytes}@anchor{3a40}
@deffn {Atributo} UUID.bytes

El UUID como una cadena de 16 bytes (que contiene los seis campos enteros en orden de bytes `big-endian').
@end deffn

@geindex bytes_le (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID bytes_le}@anchor{3a41}
@deffn {Atributo} UUID.bytes_le

El UUID como una cadena de 16 bytes (con `time_low', `time_mid', y `time_hi_version' en el orden de bytes `little-endian').
@end deffn

@geindex fields (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID fields}@anchor{3a42}
@deffn {Atributo} UUID.fields

Una tupla de los seis campos enteros de la UUID, que también están disponibles como seis atributos individuales y dos atributos derivados:
@end deffn


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

Campo

@tab

Significado

@item

@geindex time_low (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID time_low}@anchor{3a43}
@deffn {Atributo} UUID.time_low
@end deffn

@tab

los primeros 32 bits del UUID.

@item

@geindex time_mid (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID time_mid}@anchor{3a44}
@deffn {Atributo} UUID.time_mid
@end deffn

@tab

los siguientes 16 bits del UUID.

@item

@geindex time_hi_version (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID time_hi_version}@anchor{3a45}
@deffn {Atributo} UUID.time_hi_version
@end deffn

@tab

los siguientes 16 bits del UUID.

@item

@geindex clock_seq_hi_variant (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq_hi_variant}@anchor{3a46}
@deffn {Atributo} UUID.clock_seq_hi_variant
@end deffn

@tab

los siguientes 8 bits del UUID.

@item

@geindex clock_seq_low (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq_low}@anchor{3a47}
@deffn {Atributo} UUID.clock_seq_low
@end deffn

@tab

los siguientes 8 bits del UUID.

@item

@geindex node (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID node}@anchor{3a48}
@deffn {Atributo} UUID.node
@end deffn

@tab

los últimos 48 bits del UUID.

@item

@geindex time (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID time}@anchor{3a49}
@deffn {Atributo} UUID.time
@end deffn

@tab

el timestamp de 60-bit.

@item

@geindex clock_seq (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq}@anchor{3a4a}
@deffn {Atributo} UUID.clock_seq
@end deffn

@tab

el número de secuencia de 14-bit.

@end multitable


@geindex hex (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID hex}@anchor{3a4b}
@deffn {Atributo} UUID.hex

El UUID como una cadena hexadecimal en minúsculas de 32 caracteres.
@end deffn

@geindex int (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID int}@anchor{3a4c}
@deffn {Atributo} UUID.int

El UUID como un entero de 128 bits.
@end deffn

@geindex urn (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID urn}@anchor{3a4d}
@deffn {Atributo} UUID.urn

The UUID as a URN as specified in 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}.
@end deffn

@geindex variant (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID variant}@anchor{3a4e}
@deffn {Atributo} UUID.variant

La variante UUID, que determina la disposición interna del UUID. Esta será una de las constantes @ref{3a4f,,RESERVED_NCS}, @ref{3a50,,RFC_4122}, @ref{3a51,,RESERVED_MICROSOFT}, o @ref{3a52,,RESERVED_FUTURE}.
@end deffn

@geindex version (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID version}@anchor{3a53}
@deffn {Atributo} UUID.version

The UUID version number (1 through 8, meaningful only when the variant is
@ref{3a50,,RFC_4122}).


Distinto en la versión 3.14.0a1 (unreleased): Added UUID version 8.

@end deffn

@geindex is_safe (atributo de uuid.UUID)
@anchor{library/uuid uuid UUID is_safe}@anchor{c2e}
@deffn {Atributo} UUID.is_safe

Una enumeración de @ref{3a3c,,SafeUUID} que indica si la plataforma generó el UUID de forma segura para el multiprocesamiento.


Added in version 3.7.

@end deffn

El módulo @ref{110,,uuid} define las siguientes funciones:

@geindex getnode() (en el módulo uuid)
@anchor{library/uuid uuid getnode}@anchor{c2f}
@deffn {Función} uuid.getnode ()

Obtiene la dirección del hardware como un entero positivo de 48 bits.  La primera vez que esto se ejecute, puede lanzar un programa separado, que podría ser bastante lento.  Si todos los intentos de obtener la dirección de hardware fallan, elegimos un número aleatorio de 48 bits con el bit multicast (el bit menos significativo del primer octeto) puesto a 1 como se recomienda en 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.  «Dirección de hardware» significa la dirección MAC de una interfaz de red.  En una máquina con múltiples interfaces de red, las direcciones MAC administradas universalmente (es decir, donde el segundo bit menos significativo del primer octeto es `unset') se preferirán a las direcciones MAC administradas localmente, pero sin otras garantías de orden.


Distinto en la versión 3.7: Se prefieren las direcciones MAC administradas universalmente a las administradas localmente, ya que se garantiza que las primeras son únicas a nivel mundial, mientras que las segundas no lo son.

@end deffn

@geindex getnode

@geindex uuid1() (en el módulo uuid)
@anchor{library/uuid uuid uuid1}@anchor{c30}
@deffn {Función} uuid.uuid1 (node=None, clock_seq=None)

Genera un UUID a partir de un ID de host, número de secuencia y la hora actual. Si no se da `node', se usa @ref{c2f,,getnode()} para obtener la dirección del hardware. Si se da `clock_seq', se utiliza como número de secuencia; de lo contrario se elige un número de secuencia aleatorio de 14 bits.
@end deffn

@geindex uuid1

@geindex uuid3() (en el módulo uuid)
@anchor{library/uuid uuid uuid3}@anchor{174d}
@deffn {Función} uuid.uuid3 (namespace, name)

Genera un UUID basado en el hash MD5 de un identificador de espacio de nombres (que es un UUID) y un nombre (que es un objeto @ref{325,,bytes} o una cadena de caracteres que se codificará usando UTF-8).
@end deffn

@geindex uuid3

@geindex uuid4() (en el módulo uuid)
@anchor{library/uuid uuid uuid4}@anchor{3a3b}
@deffn {Función} uuid.uuid4 ()

Genera un UUID aleatorio.
@end deffn

@geindex uuid4

@geindex uuid5() (en el módulo uuid)
@anchor{library/uuid uuid uuid5}@anchor{174e}
@deffn {Función} uuid.uuid5 (namespace, name)

Genera un UUID basado en el hash SHA-1 de un identificador de espacio de nombres (que es un UUID) y un nombre (que es un objeto @ref{325,,bytes} o una cadena de caracteres que se codificará usando UTF-8).
@end deffn

@geindex uuid5

@geindex uuid8() (en el módulo uuid)
@anchor{library/uuid uuid uuid8}@anchor{1ba}
@deffn {Función} uuid.uuid8 (a=None, b=None, c=None)

Generate a pseudo-random UUID according to
@geindex RFC; RFC 9562 Section 5.8
RFC 9562@comma{} §5.8@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.8}.

When specified, the parameters `a', `b' and `c' are expected to be
positive integers of 48, 12 and 62 bits respectively. If they exceed
their expected bit count, only their least significant bits are kept;
non-specified arguments are substituted for a pseudo-random integer of
appropriate size.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex uuid8

El módulo @code{uuuid} define los siguientes identificadores de espacios de nombres para su uso con @ref{174d,,uuid3()} o @code{uuuid5()}.

@geindex NAMESPACE_DNS (en el módulo uuid)
@anchor{library/uuid uuid NAMESPACE_DNS}@anchor{3a54}
@deffn {Dato} uuid.NAMESPACE_DNS

Cuando se especifica este espacio de nombres, la cadena `name' es un nombre de dominio completamente calificado.
@end deffn

@geindex NAMESPACE_URL (en el módulo uuid)
@anchor{library/uuid uuid NAMESPACE_URL}@anchor{3a55}
@deffn {Dato} uuid.NAMESPACE_URL

Cuando se especifica este espacio de nombres, la cadena `name' es una URL.
@end deffn

@geindex NAMESPACE_OID (en el módulo uuid)
@anchor{library/uuid uuid NAMESPACE_OID}@anchor{3a56}
@deffn {Dato} uuid.NAMESPACE_OID

Cuando se especifica este espacio de nombres, la cadena `name' es un OID ISO.
@end deffn

@geindex NAMESPACE_X500 (en el módulo uuid)
@anchor{library/uuid uuid NAMESPACE_X500}@anchor{3a57}
@deffn {Dato} uuid.NAMESPACE_X500

Cuando se especifica este espacio de nombres, la cadena `name' es un X.500 DN en DER o un formato de salida de texto.
@end deffn

El módulo @ref{110,,uuid} define las siguientes constantes para los posibles valores del atributo @ref{3a4e,,variant}:

@geindex RESERVED_NCS (en el módulo uuid)
@anchor{library/uuid uuid RESERVED_NCS}@anchor{3a4f}
@deffn {Dato} uuid.RESERVED_NCS

Reservado para la compatibilidad con NCS.
@end deffn

@geindex RFC_4122 (en el módulo uuid)
@anchor{library/uuid uuid RFC_4122}@anchor{3a50}
@deffn {Dato} uuid.RFC_4122

Specifies the UUID layout given in 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}. This constant is kept
for backward compatibility even though 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} has been superseded
by 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}.
@end deffn

@geindex RESERVED_MICROSOFT (en el módulo uuid)
@anchor{library/uuid uuid RESERVED_MICROSOFT}@anchor{3a51}
@deffn {Dato} uuid.RESERVED_MICROSOFT

Reservado para la compatibilidad con Microsoft.
@end deffn

@geindex RESERVED_FUTURE (en el módulo uuid)
@anchor{library/uuid uuid RESERVED_FUTURE}@anchor{3a52}
@deffn {Dato} uuid.RESERVED_FUTURE

Reservado para una futura definición.
@end deffn


@subsubheading Ver también



@table @asis

@geindex RFC; RFC 9562

@item RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} - A Universally Unique IDentifier (UUID) URN Namespace

Esta especificación define un espacio de nombres de recursos uniforme para los UUID, el formato interno de los UUID y los métodos de generación de los UUID.
@end table


@menu
* Uso de la línea de comandos: Uso de la línea de comandos<2>. 
* Ejemplo: Ejemplo<11>. 
* Ejemplo de línea de comandos:: 

@end menu

@node Uso de la línea de comandos<2>,Ejemplo<11>,,uuid — UUID objects according to RFC 9562
@anchor{library/uuid command-line-usage}@anchor{3a58}@anchor{library/uuid uuid-cli}@anchor{4f1}
@subsubsection Uso de la línea de comandos



Added in version 3.12.


El módulo @ref{110,,uuid} se puede ejecutar como un script desde la línea de comando.

@example
python -m uuid [-h] [-u @{uuid1,uuid3,uuid4,uuid5,uuid8@}] [-n NAMESPACE] [-N NAME]
@end example

Se aceptan las siguientes opciones:

@geindex opción de línea de comando uuid; -h
@geindex opción de línea de comando uuid; --help
@anchor{library/uuid cmdoption-uuid-h}@anchor{3a59}@anchor{library/uuid cmdoption-uuid-help}@anchor{3a5a}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Muestra el mensaje de ayuda y libera la linea de comando.
@end deffn

@geindex opción de línea de comando uuid; -u
@geindex opción de línea de comando uuid; --uuid
@anchor{library/uuid cmdoption-uuid-u}@anchor{3a5b}
@deffn {Option} @w{-}u <uuid>
@anchor{library/uuid cmdoption-uuid-uuid}@anchor{3a5c}
@deffnx {Option} @w{-}@w{-}uuid <uuid>

Especifica el nombre de la función que se utilizará para generar el uuid. Por defecto se utiliza @ref{3a3b,,uuid4()}.


Added in version 3.14.0a1 (unreleased): Allow generating UUID version 8.

@end deffn

@geindex opción de línea de comando uuid; -n
@geindex opción de línea de comando uuid; --namespace
@anchor{library/uuid cmdoption-uuid-n}@anchor{3a5d}
@deffn {Option} @w{-}n <namespace>
@anchor{library/uuid cmdoption-uuid-namespace}@anchor{3a5e}
@deffnx {Option} @w{-}@w{-}namespace <namespace>

El espacio de nombres es un @code{UUID} o @code{@@ns} donde @code{ns} es un UUID predefinido conocido dirigido por el nombre del espacio de nombres. Como @code{@@dns}, @code{@@url}, @code{@@oid} y @code{@@x500}. Solo se requiere para las funciones @ref{174d,,uuid3()} / @ref{174e,,uuid5()}.
@end deffn

@geindex opción de línea de comando uuid; -N
@geindex opción de línea de comando uuid; --name
@anchor{library/uuid cmdoption-uuid-N}@anchor{3a5f}
@deffn {Option} @w{-}N <name>
@anchor{library/uuid cmdoption-uuid-name}@anchor{3a60}
@deffnx {Option} @w{-}@w{-}name <name>

El nombre utilizado como parte de la generación del uuid. Solo se requiere para las funciones @ref{174d,,uuid3()} / @ref{174e,,uuid5()}.
@end deffn

@node Ejemplo<11>,Ejemplo de línea de comandos,Uso de la línea de comandos<2>,uuid — UUID objects according to RFC 9562
@anchor{library/uuid example}@anchor{3a61}@anchor{library/uuid uuid-example}@anchor{3a62}
@subsubsection Ejemplo


Aquí hay algunos ejemplos del uso típico del modulo @ref{110,,uuid}:

@example
>>> import uuid

>>> # make a UUID based on the host ID and current time
>>> uuid.uuid1()
UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

>>> # make a UUID using an MD5 hash of a namespace UUID and a name
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

>>> # make a random UUID
>>> uuid.uuid4()
UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

>>> # make a UUID from a string of hex digits (braces and hyphens ignored)
>>> x = uuid.UUID('@{00010203-0405-0607-0809-0a0b0c0d0e0f@}')

>>> # convert a UUID to a string of hex digits in standard form
>>> str(x)
'00010203-0405-0607-0809-0a0b0c0d0e0f'

>>> # get the raw 16 bytes of the UUID
>>> x.bytes
b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'

>>> # make a UUID from a 16-byte string
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
@end example

@node Ejemplo de línea de comandos,,Ejemplo<11>,uuid — UUID objects according to RFC 9562
@anchor{library/uuid command-line-example}@anchor{3a63}@anchor{library/uuid uuid-cli-example}@anchor{3a64}
@subsubsection Ejemplo de línea de comandos


Aquí hay algunos ejemplos del uso típico del modulo @ref{110,,uuid}:

@example
# generate a random uuid - by default uuid4() is used
$ python -m uuid

# generate a uuid using uuid1()
$ python -m uuid -u uuid1

# generate a uuid using uuid5
$ python -m uuid -u uuid5 -n @@url -N example.com
@end example

@node socketserver — A framework for network servers,http server — HTTP servers,uuid — UUID objects according to RFC 9562,Protocolos y soporte de Internet
@anchor{library/socketserver doc}@anchor{3a65}@anchor{library/socketserver module-socketserver}@anchor{cd}@anchor{library/socketserver socketserver-a-framework-for-network-servers}@anchor{3a66}
@subsection @code{socketserver} — A framework for network servers


@geindex module; socketserver

`Código fuente:' Lib/socketserver.py@footnote{https://github.com/python/cpython/tree/main/Lib/socketserver.py}


__________________________________________________________________


El módulo @ref{cd,,socketserver} simplifica la tarea de escribir servidores de red.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Hay cuatro clases básicas de servidores concretos:

@geindex TCPServer (clase en socketserver)
@anchor{library/socketserver socketserver TCPServer}@anchor{1387}
@deffn {Clase} socketserver.TCPServer (server_address, RequestHandlerClass, bind_and_activate=True)

Esto utiliza el protocolo TCP de Internet, que proporciona flujos continuos de datos entre el cliente y el servidor. Si `bind_and_activate' es verdadero, el constructor intenta invocar automáticamente @ref{3a67,,server_bind()} y @ref{3a68,,server_activate()}. Los otros parámetros se pasan a la clase base @ref{11af,,BaseServer}.
@end deffn

@geindex UDPServer (clase en socketserver)
@anchor{library/socketserver socketserver UDPServer}@anchor{3a69}
@deffn {Clase} socketserver.UDPServer (server_address, RequestHandlerClass, bind_and_activate=True)

Esto utiliza datagramas, que son paquetes discretos de información que pueden llegar fuera de servicio o perderse durante el tránsito. Los parámetros son los mismos que para @ref{1387,,TCPServer}.
@end deffn

@geindex UnixStreamServer (clase en socketserver)
@geindex UnixDatagramServer (clase en socketserver)
@anchor{library/socketserver socketserver UnixStreamServer}@anchor{3a6a}
@deffn {Clase} socketserver.UnixStreamServer (server_address, RequestHandlerClass, bind_and_activate=True)
@anchor{library/socketserver socketserver UnixDatagramServer}@anchor{3a6b}
@deffnx {Clase} socketserver.UnixDatagramServer (server_address, RequestHandlerClass, bind_and_activate=True)

Estas clases que se usan con menos frecuencia son similares a las clases TCP y UDP, pero usan sockets de dominio Unix; no están disponibles en plataformas que no sean Unix. Los parámetros son los mismos que para @ref{1387,,TCPServer}.
@end deffn

Estas cuatro clases procesan solicitudes `sincrónicamente'; cada solicitud debe completarse antes de que se pueda iniciar la siguiente. Esto no es adecuado si cada solicitud tarda mucho en completarse, porque requiere mucho cálculo o porque retorna muchos datos que el cliente tarda en procesar. La solución es crear un proceso o hilo independiente para manejar cada solicitud; las clases mixtas @ref{bff,,ForkingMixIn} y @ref{c00,,ThreadingMixIn} pueden usarse para soportar el comportamiento asincrónico.

La creación de un servidor requiere varios pasos. Primero, debes crear una clase de controlador de solicitudes subclasificando la clase @ref{3a6c,,BaseRequestHandler} y anulando su método @ref{3a6d,,handle()}; este método procesará las solicitudes entrantes. En segundo lugar, debe crear una instancia de una de las clases de servidor, pasándole la dirección del servidor y la clase del controlador de solicitudes. Se recomienda utilizar el servidor en una declaración @ref{673,,with}. Luego llame al método @ref{138a,,handle_request()} o @ref{11b1,,serve_forever()} del objeto de servidor para procesar una o muchas solicitudes. Finalmente, llame a @ref{3a6e,,server_close()} para cerrar el socket (a menos que haya usado una @code{with} declaración).

Al heredar de @ref{c00,,ThreadingMixIn} para el comportamiento de la conexión con subprocesos, debe declarar explícitamente cómo desea que se comporten sus subprocesos en un cierre abrupto. La clase @ref{c00,,ThreadingMixIn} define un atributo `daemon_threads', que indica si el servidor debe esperar o no la terminación del hilo. Debe establecer la bandera explícitamente si desea que los subprocesos se comporten de forma autónoma; el valor predeterminado es @ref{bbf,,False}, lo que significa que Python no se cerrará hasta que todos los hilos creados por @ref{c00,,ThreadingMixIn} hayan salido.

Las clases de servidor tienen los mismos métodos y atributos externos, independientemente del protocolo de red que utilicen.

@menu
* Notas de creación del servidor:: 
* Objetos de servidor:: 
* Solicitar objetos de controlador:: 
* Ejemplos: Ejemplos<26>. 

@end menu

@node Notas de creación del servidor,Objetos de servidor,,socketserver — A framework for network servers
@anchor{library/socketserver server-creation-notes}@anchor{3a6f}
@subsubsection Notas de creación del servidor


Hay cinco clases en un diagrama de herencia, cuatro de las cuales representan servidores síncronos de cuatro tipos:

@example
+------------+
| BaseServer |
+------------+
      |
      v
+-----------+        +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+        +------------------+
      |
      v
+-----------+        +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+        +--------------------+
@end example

Tenga en cuenta que @ref{3a6b,,UnixDatagramServer} deriva de @ref{3a69,,UDPServer}, no de @ref{3a6a,,UnixStreamServer} — la única diferencia entre un servidor IP y uno Unix es la familia de direcciones.

@geindex ForkingMixIn (clase en socketserver)
@geindex ThreadingMixIn (clase en socketserver)
@anchor{library/socketserver socketserver ForkingMixIn}@anchor{bff}
@deffn {Clase} socketserver.ForkingMixIn
@anchor{library/socketserver socketserver ThreadingMixIn}@anchor{c00}
@deffnx {Clase} socketserver.ThreadingMixIn

Se pueden crear versiones de Forking y threading de cada tipo de servidor utilizando estas clases mixtas. Por ejemplo, @ref{3a70,,ThreadingUDPServer} se crea de la siguiente manera:

@example
class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    pass
@end example

La clase de mezcla es lo primero, ya que anula un método definido en @ref{3a69,,UDPServer}. La configuración de los distintos atributos también cambia el comportamiento del mecanismo del servidor subyacente.

@ref{bff,,ForkingMixIn} y las clases de Forking mencionadas a continuación solo están disponibles en plataformas POSIX que admiten @ref{2ff,,os.fork()}.

@geindex block_on_close (atributo de socketserver.ThreadingMixIn)
@anchor{library/socketserver socketserver ThreadingMixIn block_on_close}@anchor{c85}
@deffn {Atributo} block_on_close

@ref{3a6e,,ForkingMixIn.server_close}
waits until all child processes complete, except if
@ref{c85,,block_on_close} attribute is @code{False}.

@ref{3a6e,,ThreadingMixIn.server_close}
waits until all non-daemon threads complete, except if
@ref{c85,,block_on_close} attribute is @code{False}.
@end deffn

@geindex max_children (atributo de socketserver.ThreadingMixIn)
@anchor{library/socketserver socketserver ThreadingMixIn max_children}@anchor{3a71}
@deffn {Atributo} max_children

Specify how many child processes will exist to handle requests at a time
for @ref{bff,,ForkingMixIn}.  If the limit is reached,
new requests will wait until one child process has finished.
@end deffn

@geindex daemon_threads (atributo de socketserver.ThreadingMixIn)
@anchor{library/socketserver socketserver ThreadingMixIn daemon_threads}@anchor{3a72}
@deffn {Atributo} daemon_threads

For @ref{c00,,ThreadingMixIn} use daemonic threads by setting
@ref{3a72,,ThreadingMixIn.daemon_threads}
to @code{True} to not wait until threads complete.
@end deffn


Distinto en la versión 3.7: @ref{3a6e,,ForkingMixIn.server_close} and
@ref{3a6e,,ThreadingMixIn.server_close} now waits until all
child processes and non-daemonic threads complete.
Add a new @ref{c85,,ForkingMixIn.block_on_close} class
attribute to opt-in for the pre-3.7 behaviour.

@end deffn

@geindex ForkingTCPServer (clase en socketserver)
@geindex ForkingUDPServer (clase en socketserver)
@geindex ThreadingTCPServer (clase en socketserver)
@geindex ThreadingUDPServer (clase en socketserver)
@geindex ForkingUnixStreamServer (clase en socketserver)
@geindex ForkingUnixDatagramServer (clase en socketserver)
@geindex ThreadingUnixStreamServer (clase en socketserver)
@geindex ThreadingUnixDatagramServer (clase en socketserver)
@anchor{library/socketserver socketserver ForkingTCPServer}@anchor{3a73}
@deffn {Clase} socketserver.ForkingTCPServer
@anchor{library/socketserver socketserver ForkingUDPServer}@anchor{3a74}
@deffnx {Clase} socketserver.ForkingUDPServer
@anchor{library/socketserver socketserver ThreadingTCPServer}@anchor{3a75}
@deffnx {Clase} socketserver.ThreadingTCPServer
@anchor{library/socketserver socketserver ThreadingUDPServer}@anchor{3a70}
@deffnx {Clase} socketserver.ThreadingUDPServer
@anchor{library/socketserver socketserver ForkingUnixStreamServer}@anchor{3a76}
@deffnx {Clase} socketserver.ForkingUnixStreamServer
@anchor{library/socketserver socketserver ForkingUnixDatagramServer}@anchor{3a77}
@deffnx {Clase} socketserver.ForkingUnixDatagramServer
@anchor{library/socketserver socketserver ThreadingUnixStreamServer}@anchor{3a78}
@deffnx {Clase} socketserver.ThreadingUnixStreamServer
@anchor{library/socketserver socketserver ThreadingUnixDatagramServer}@anchor{3a79}
@deffnx {Clase} socketserver.ThreadingUnixDatagramServer

Estas clases están predefinidas utilizando las clases mixtas.
@end deffn


Added in version 3.12: Las clases @code{ForkingUnixStreamServer} y @code{ForkingUnixDatagramServer} fueron agregadas.


Para implementar un servicio, debes derivar una clase de @ref{3a6c,,BaseRequestHandler} y redefinir su método @ref{3a6d,,handle()}. Luego, puede ejecutar varias versiones del servicio combinando una de las clases de servidor con su clase de controlador de solicitudes. La clase del controlador de solicitudes debe ser diferente para los servicios de datagramas o flujos. Esto se puede ocultar usando las subclases del controlador @ref{d61,,StreamRequestHandler} o @ref{3a7a,,DatagramRequestHandler}.

Por supuesto, ¡todavía tienes que usar la cabeza! Por ejemplo, no tiene sentido usar un servidor de bifurcación si el servicio contiene un estado en la memoria que puede ser modificado por diferentes solicitudes, ya que las modificaciones en el proceso hijo nunca alcanzarían el estado inicial que se mantiene en el proceso padre y se pasa a cada hijo. En este caso, puede usar un servidor de subprocesos, pero probablemente tendrá que usar bloqueos para proteger la integridad de los datos compartidos.

Por otro lado, si está creando un servidor HTTP donde todos los datos se almacenan externamente (por ejemplo, en el sistema de archivos), una clase síncrona esencialmente hará que el servicio sea «sordo» mientras se maneja una solicitud, que puede ser durante mucho tiempo si un cliente tarda en recibir todos los datos que ha solicitado. Aquí es apropiado un servidor de enhebrado o bifurcación.

En algunos casos, puede ser apropiado procesar parte de una solicitud de forma síncrona, pero para finalizar el procesamiento en un hijo bifurcado según los datos de la solicitud. Esto se puede implementar usando un servidor sincrónico y haciendo un fork explicito en la clase del controlador de solicitudes el método @ref{3a6d,,handle()}.

Otro enfoque para gestionar múltiples solicitudes simultáneas en un entorno que no admite subprocesos ni @ref{2ff,,fork()} (o donde estos son demasiado costosos o inadecuados para el servicio) es mantener una tabla explícita de solicitudes parcialmente terminadas y utilizar @ref{c2,,selectors} para decidir en qué solicitud trabajar a continuación (o si manejar una nueva solicitud entrante). Esto es particularmente importante para los servicios de transmisión en los que cada cliente puede potencialmente estar conectado durante mucho tiempo (si no se pueden utilizar subprocesos o subprocesos).

@c XXX should data and methods be intermingled, or separate?
@c how should the distinction between class and instance variables be drawn?

@node Objetos de servidor,Solicitar objetos de controlador,Notas de creación del servidor,socketserver — A framework for network servers
@anchor{library/socketserver server-objects}@anchor{3a7b}
@subsubsection Objetos de servidor


@geindex BaseServer (clase en socketserver)
@anchor{library/socketserver socketserver BaseServer}@anchor{11af}
@deffn {Clase} socketserver.BaseServer (server_address, RequestHandlerClass)

Esta es la superclase de todos los objetos de servidor en el módulo. Define la interfaz, que se indica a continuación, pero no implementa la mayoría de los métodos, que se realiza en subclases. Los dos parámetros se almacenan en los atributos respectivos @ref{3a7c,,server_address} y @ref{3a7d,,RequestHandlerClass}.

@geindex fileno() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer fileno}@anchor{3a7e}
@deffn {Método} fileno ()

Retorna un descriptor de archivo entero para el socket en el que escucha el servidor. Esta función se pasa comúnmente a @ref{c2,,selectors}, para permitir monitorear múltiples servidores en el mismo proceso.
@end deffn

@geindex handle_request() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_request}@anchor{138a}
@deffn {Método} handle_request ()

Procese una sola solicitud. Esta función llama a los siguientes métodos en orden: @ref{3a7f,,get_request()}, @ref{3a80,,verify_request()}, y @ref{3a81,,process_request()}. Si el método proporcionado por el usuario @ref{3a6d,,handle()} de la clase del controlador lanza una excepción, se llamará al método @ref{dc8,,handle_error()} del servidor. Si no se recibe ninguna solicitud en @ref{1388,,timeout} segundos, se llamará a @ref{1389,,handle_timeout()} y @ref{138a,,handle_request()} regresará.
@end deffn

@geindex serve_forever() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer serve_forever}@anchor{11b1}
@deffn {Método} serve_forever (poll_interval=0.5)

Manejar solicitudes hasta una solicitud explícita @ref{1a3c,,shutdown()}. Sondeo de apagado cada `poll_interval' segundos. Ignora el atributo @ref{1388,,timeout}. También llama @ref{11b0,,service_actions()}, que puede ser utilizado por una subclase o mixin para proporcionar acciones específicas para un servicio dado. Por ejemplo, la clase @ref{bff,,ForkingMixIn} usa @ref{11b0,,service_actions()} para limpiar procesos secundarios zombies.


Distinto en la versión 3.3: Se agregó la llamada @code{service_actions} al método @code{serve_forever}.

@end deffn

@geindex service_actions() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer service_actions}@anchor{11b0}
@deffn {Método} service_actions ()

Esto se llama en el ciclo @ref{11b1,,serve_forever()}. Este método puede ser reemplazado por subclases o clases mixtas para realizar acciones específicas para un servicio dado, como acciones de limpieza.


Added in version 3.3.

@end deffn

@geindex shutdown() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer shutdown}@anchor{1a3c}
@deffn {Método} shutdown ()

Dile al bucle @ref{11b1,,serve_forever()} que se detenga y espere hasta que lo haga. @ref{1a3c,,shutdown()} debe llamarse mientras @ref{11b1,,serve_forever()} se está ejecutando en un hilo diferente, de lo contrario, se bloqueará.
@end deffn

@geindex server_close() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_close}@anchor{3a6e}
@deffn {Método} server_close ()

Limpiar el servidor. Puede ser sobrescrito.
@end deffn

@geindex address_family (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer address_family}@anchor{3a82}
@deffn {Atributo} address_family

La familia de protocolos a la que pertenece el socket del servidor. Algunos ejemplos comunes son @ref{1824,,socket.AF_INET} y @ref{1826,,socket.AF_UNIX}.
@end deffn

@geindex RequestHandlerClass (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer RequestHandlerClass}@anchor{3a7d}
@deffn {Atributo} RequestHandlerClass

La clase de controlador de solicitudes proporcionada por el usuario; se crea una instancia de esta clase para cada solicitud.
@end deffn

@geindex server_address (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_address}@anchor{3a7c}
@deffn {Atributo} server_address

La dirección en la que escucha el servidor. El formato de las direcciones varía según la familia de protocolos; consulte la documentación del módulo @ref{cc,,socket} para obtener más detalles. Para los protocolos de Internet, esta es una tupla que contiene una cadena que da la dirección y un número de puerto entero: @code{('127.0.0.1', 80)}, por ejemplo.
@end deffn

@geindex socket (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer socket}@anchor{3a83}
@deffn {Atributo} socket

El objeto de socket en el que el servidor escuchará las solicitudes entrantes.
@end deffn

Las clases de servidor admiten las siguientes variables de clase:

@c XXX should class variables be covered before instance variables, or vice versa?

@geindex allow_reuse_address (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer allow_reuse_address}@anchor{3a84}
@deffn {Atributo} allow_reuse_address

Si el servidor permitirá la reutilización de una dirección. Este valor predeterminado es @ref{bbf,,False}, y se puede establecer en subclases para cambiar la política.
@end deffn

@geindex request_queue_size (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer request_queue_size}@anchor{3a85}
@deffn {Atributo} request_queue_size

El tamaño de la cola de solicitudes. Si toma mucho tiempo procesar una sola solicitud, cualquier solicitud que llegue mientras el servidor está ocupado se coloca en una cola, hasta @ref{3a85,,request_queue_size}. Una vez que la cola está llena, más solicitudes de clientes obtendrán un error de «Conexión denegada». El valor predeterminado suele ser 5, pero las subclases pueden anularlo.
@end deffn

@geindex socket_type (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer socket_type}@anchor{3a86}
@deffn {Atributo} socket_type

El tipo de socket utilizado por el servidor; @ref{135a,,socket.SOCK_STREAM} y @ref{1359,,socket.SOCK_DGRAM} son dos valores comunes.
@end deffn

@geindex timeout (atributo de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer timeout}@anchor{1388}
@deffn {Atributo} timeout

Duración del tiempo de espera, medida en segundos, o @ref{716,,None} si no se desea un tiempo de espera. Si @ref{138a,,handle_request()} no recibe solicitudes entrantes dentro del período de tiempo de espera, se llama al método @ref{1389,,handle_timeout()}.
@end deffn

Hay varios métodos de servidor que pueden ser anulados por subclases de clases de servidor base como @ref{1387,,TCPServer}; estos métodos no son útiles para los usuarios externos del objeto de servidor.

@c XXX should the default implementations of these be documented, or should
@c it be assumed that the user will look at socketserver.py?

@geindex finish_request() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer finish_request}@anchor{3a87}
@deffn {Método} finish_request (request, client_address)

En realidad, procesa la solicitud creando instancias @ref{3a7d,,RequestHandlerClass} y llamando a su método @ref{3a6d,,handle()}.
@end deffn

@geindex get_request() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer get_request}@anchor{3a7f}
@deffn {Método} get_request ()

Debe aceptar una solicitud del socket y retornar una tupla de 2 que contenga el objeto de socket `nuevo' que se utilizará para comunicarse con el cliente y la dirección del cliente.
@end deffn

@geindex handle_error() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_error}@anchor{dc8}
@deffn {Método} handle_error (request, client_address)

Esta función se llama si el método @ref{3a6d,,handle()} de una instancia @ref{3a7d,,RequestHandlerClass} lanza una excepción. La acción predeterminada es imprimir el rastreo al error estándar y continuar manejando más solicitudes.


Distinto en la versión 3.6: Ahora solo se solicitan excepciones derivadas de la clase @ref{a6b,,Exception}.

@end deffn

@geindex handle_timeout() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_timeout}@anchor{1389}
@deffn {Método} handle_timeout ()

Esta función se llama cuando el atributo @ref{1388,,timeout} se ha establecido en un valor distinto de @ref{716,,None} y el tiempo de espera ha pasado sin que se reciban solicitudes. La acción predeterminada para los servidores de forking es recopilar el estado de cualquier proceso hijo que haya salido, mientras que en los servidores de threading este método no hace nada.
@end deffn

@geindex process_request() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer process_request}@anchor{3a81}
@deffn {Método} process_request (request, client_address)

Llama a @ref{3a87,,finish_request()} para crear una instancia de @ref{3a7d,,RequestHandlerClass}. Si lo desea, esta función puede crear un nuevo proceso o hilo para manejar la solicitud; las clases @ref{bff,,ForkingMixIn} y @ref{c00,,ThreadingMixIn} hacen esto.
@end deffn

@c Is there any point in documenting the following two functions?
@c What would the purpose of overriding them be: initializing server
@c instance variables, adding new network families?

@geindex server_activate() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_activate}@anchor{3a68}
@deffn {Método} server_activate ()

Lo llama el constructor del servidor para activar el servidor. El comportamiento predeterminado para un servidor TCP simplemente invoca @ref{ede,,listen()} en el socket del servidor. Puede anularse.
@end deffn

@geindex server_bind() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_bind}@anchor{3a67}
@deffn {Método} server_bind ()

Lo llama el constructor del servidor para vincular el socket a la dirección deseada. Puede anularse.
@end deffn

@geindex verify_request() (método de socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer verify_request}@anchor{3a80}
@deffn {Método} verify_request (request, client_address)

Debe retornar un valor booleano; si el valor es @ref{c95,,True}, la solicitud se procesará, y si es @ref{bbf,,False}, la solicitud será denegada. Esta función se puede anular para implementar controles de acceso para un servidor. La implementación predeterminada siempre retorna @ref{c95,,True}.
@end deffn


Distinto en la versión 3.6: Se agregó soporte para el protocolo @ref{675,,context manager}. Salir del administrador de contexto es equivalente a llamar a @ref{3a6e,,server_close()}.

@end deffn

@node Solicitar objetos de controlador,Ejemplos<26>,Objetos de servidor,socketserver — A framework for network servers
@anchor{library/socketserver request-handler-objects}@anchor{3a88}
@subsubsection Solicitar objetos de controlador


@geindex BaseRequestHandler (clase en socketserver)
@anchor{library/socketserver socketserver BaseRequestHandler}@anchor{3a6c}
@deffn {Clase} socketserver.BaseRequestHandler

Esta es la superclase de todos los objetos de manejo de solicitudes. Define la interfaz, que se muestra a continuación. Una subclase de controlador de solicitudes concreta debe definir un nuevo método @ref{3a6d,,handle()} y puede anular cualquiera de los otros métodos. Se crea una nueva instancia de la subclase para cada solicitud.

@geindex setup() (método de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler setup}@anchor{3a89}
@deffn {Método} setup ()

Se llama antes del método @ref{3a6d,,handle()} para realizar las acciones de inicialización necesarias. La implementación predeterminada no hace nada.
@end deffn

@geindex handle() (método de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler handle}@anchor{3a6d}
@deffn {Método} handle ()

This function must do all the work required to service a request.  The
default implementation does nothing.  Several instance attributes are
available to it; the request is available as @ref{3a8a,,request}; the client
address as @ref{3a8b,,client_address}; and the server instance as
@ref{3a8c,,server}, in case it needs access to per-server information.

The type of @ref{3a8a,,request} is different for datagram or stream
services.  For stream services, @ref{3a8a,,request} is a socket object; for
datagram services, @ref{3a8a,,request} is a pair of string and socket.
@end deffn

@geindex finish() (método de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler finish}@anchor{3a8d}
@deffn {Método} finish ()

Se llama después del método @ref{3a6d,,handle()} para realizar las acciones de limpieza necesarias. La implementación predeterminada no hace nada. Si @ref{3a89,,setup()} lanza una excepción, no se llamará a esta función.
@end deffn

@geindex request (atributo de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler request}@anchor{3a8a}
@deffn {Atributo} request

The `new' @ref{e27,,socket.socket} object
to be used to communicate with the client.
@end deffn

@geindex client_address (atributo de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler client_address}@anchor{3a8b}
@deffn {Atributo} client_address

Client address returned by @ref{3a7f,,BaseServer.get_request()}.
@end deffn

@geindex server (atributo de socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler server}@anchor{3a8c}
@deffn {Atributo} server

@ref{11af,,BaseServer} object used for handling the request.
@end deffn
@end deffn

@geindex StreamRequestHandler (clase en socketserver)
@geindex DatagramRequestHandler (clase en socketserver)
@anchor{library/socketserver socketserver StreamRequestHandler}@anchor{d61}
@deffn {Clase} socketserver.StreamRequestHandler
@anchor{library/socketserver socketserver DatagramRequestHandler}@anchor{3a7a}
@deffnx {Clase} socketserver.DatagramRequestHandler

These @ref{3a6c,,BaseRequestHandler} subclasses override the
@ref{3a89,,setup()} and @ref{3a8d,,finish()}
methods, and provide @ref{3a8e,,rfile} and @ref{3a8f,,wfile} attributes.

@geindex rfile (atributo de socketserver.DatagramRequestHandler)
@anchor{library/socketserver socketserver DatagramRequestHandler rfile}@anchor{3a8e}
@deffn {Atributo} rfile

A file object from which receives the request is read.
Support the @ref{735,,io.BufferedIOBase} readable interface.
@end deffn

@geindex wfile (atributo de socketserver.DatagramRequestHandler)
@anchor{library/socketserver socketserver DatagramRequestHandler wfile}@anchor{3a8f}
@deffn {Atributo} wfile

A file object to which the reply is written.
Support the @ref{735,,io.BufferedIOBase} writable interface
@end deffn


Distinto en la versión 3.6: @ref{3a8f,,wfile} also supports the
@ref{735,,io.BufferedIOBase} writable interface.

@end deffn

@node Ejemplos<26>,,Solicitar objetos de controlador,socketserver — A framework for network servers
@anchor{library/socketserver examples}@anchor{3a90}
@subsubsection Ejemplos


@menu
* socketserver.TCPServer Ejemplo: socketserver TCPServer Ejemplo. 
* socketserver.UDPServer Ejemplo: socketserver UDPServer Ejemplo. 
* Mixins asincrónicos:: 

@end menu

@node socketserver TCPServer Ejemplo,socketserver UDPServer Ejemplo,,Ejemplos<26>
@anchor{library/socketserver socketserver-tcpserver-example}@anchor{3a91}
@subsubsection @code{socketserver.TCPServer} Ejemplo


Este es el lado del servidor:

@example
import socketserver

class MyTCPHandler(socketserver.BaseRequestHandler):
    """
    The request handler class for our server.

    It is instantiated once per connection to the server, and must
    override the handle() method to implement communication to the
    client.
    """

    def handle(self):
        # self.request is the TCP socket connected to the client
        self.data = self.request.recv(1024).strip()
        print("Received from @{@}:".format(self.client_address[0]))
        print(self.data)
        # just send back the same data, but upper-cased
        self.request.sendall(self.data.upper())

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999

    # Create the server, binding to localhost on port 9999
    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
        # Activate the server; this will keep running until you
        # interrupt the program with Ctrl-C
        server.serve_forever()
@end example

Una clase de controlador de solicitudes alternativa que hace uso de secuencias (objetos similares a archivos que simplifican la comunicación al proporcionar la interfaz de archivo estándar):

@example
class MyTCPHandler(socketserver.StreamRequestHandler):

    def handle(self):
        # self.rfile is a file-like object created by the handler;
        # we can now use e.g. readline() instead of raw recv() calls
        self.data = self.rfile.readline().strip()
        print("@{@} wrote:".format(self.client_address[0]))
        print(self.data)
        # Likewise, self.wfile is a file-like object used to write back
        # to the client
        self.wfile.write(self.data.upper())
@end example

The difference is that the @code{readline()} call in the second handler will call
@code{recv()} multiple times until it encounters a newline character, while the
single @code{recv()} call in the first handler will just return what has been
received so far from the client’s @code{sendall()} call (typically all of it, but
this is not guaranteed by the TCP protocol).

Este es el lado del cliente:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# Create a socket (SOCK_STREAM means a TCP socket)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    # Connect to server and send data
    sock.connect((HOST, PORT))
    sock.sendall(bytes(data + "\n", "utf-8"))

    # Receive data from the server and shut down
    received = str(sock.recv(1024), "utf-8")

print("Sent:     @{@}".format(data))
print("Received: @{@}".format(received))
@end example

La salida del ejemplo debería verse así:

Servidor:

@example
$ python TCPServer.py
127.0.0.1 wrote:
b'hello world with TCP'
127.0.0.1 wrote:
b'python is nice'
@end example

Cliente:

@example
$ python TCPClient.py hello world with TCP
Sent:     hello world with TCP
Received: HELLO WORLD WITH TCP
$ python TCPClient.py python is nice
Sent:     python is nice
Received: PYTHON IS NICE
@end example

@node socketserver UDPServer Ejemplo,Mixins asincrónicos,socketserver TCPServer Ejemplo,Ejemplos<26>
@anchor{library/socketserver socketserver-udpserver-example}@anchor{3a92}
@subsubsection @code{socketserver.UDPServer} Ejemplo


Este es el lado del servidor:

@example
import socketserver

class MyUDPHandler(socketserver.BaseRequestHandler):
    """
    This class works similar to the TCP handler class, except that
    self.request consists of a pair of data and client socket, and since
    there is no connection the client address must be given explicitly
    when sending data back via sendto().
    """

    def handle(self):
        data = self.request[0].strip()
        socket = self.request[1]
        print("@{@} wrote:".format(self.client_address[0]))
        print(data)
        socket.sendto(data.upper(), self.client_address)

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:
        server.serve_forever()
@end example

Este es el lado del cliente:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# SOCK_DGRAM is the socket type to use for UDP sockets
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# As you can see, there is no connect() call; UDP has no connections.
# Instead, data is directly sent to the recipient via sendto().
sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))
received = str(sock.recv(1024), "utf-8")

print("Sent:     @{@}".format(data))
print("Received: @{@}".format(received))
@end example

La salida del ejemplo debería verse exactamente como en el ejemplo del servidor TCP.

@node Mixins asincrónicos,,socketserver UDPServer Ejemplo,Ejemplos<26>
@anchor{library/socketserver asynchronous-mixins}@anchor{3a93}
@subsubsection Mixins asincrónicos


Para construir controladores asincrónicos, use las clases @ref{c00,,ThreadingMixIn} y @ref{bff,,ForkingMixIn}.

Un ejemplo para la clase @ref{c00,,ThreadingMixIn} class

@example
import socket
import threading
import socketserver

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def handle(self):
        data = str(self.request.recv(1024), 'ascii')
        cur_thread = threading.current_thread()
        response = bytes("@{@}: @{@}".format(cur_thread.name, data), 'ascii')
        self.request.sendall(response)

class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
    pass

def client(ip, port, message):
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
        sock.connect((ip, port))
        sock.sendall(bytes(message, 'ascii'))
        response = str(sock.recv(1024), 'ascii')
        print("Received: @{@}".format(response))

if __name__ == "__main__":
    # Port 0 means to select an arbitrary unused port
    HOST, PORT = "localhost", 0

    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    with server:
        ip, port = server.server_address

        # Start a thread with the server -- that thread will then start one
        # more thread for each request
        server_thread = threading.Thread(target=server.serve_forever)
        # Exit the server thread when the main thread terminates
        server_thread.daemon = True
        server_thread.start()
        print("Server loop running in thread:", server_thread.name)

        client(ip, port, "Hello World 1")
        client(ip, port, "Hello World 2")
        client(ip, port, "Hello World 3")

        server.shutdown()
@end example

La salida del ejemplo debería verse así:

@example
$ python ThreadedTCPServer.py
Server loop running in thread: Thread-1
Received: Thread-2: Hello World 1
Received: Thread-3: Hello World 2
Received: Thread-4: Hello World 3
@end example

La clase @ref{bff,,ForkingMixIn} se usa de la misma manera, excepto que el servidor generará un nuevo proceso para cada solicitud. Disponible solo en plataformas POSIX que admitan @ref{2ff,,fork()}.

@node http server — HTTP servers,http cookies — HTTP state management,socketserver — A framework for network servers,Protocolos y soporte de Internet
@anchor{library/http server doc}@anchor{3a94}@anchor{library/http server http-server-http-servers}@anchor{3a95}@anchor{library/http server module-http server}@anchor{72}
@subsection @code{http.server} — HTTP servers


@geindex module; http.server

`Código fuente:' Lib/http/server.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/server.py}

@geindex WWW;server
@geindex HTTP;protocol
@geindex URL
@geindex httpd


__________________________________________________________________


Este módulo define clases para implementar servidores HTTP.

@cartouche
@quotation Advertencia 
@ref{72,,http.server} no se recomienda para producción. Sólo implementa @ref{3a96,,controles de seguridad básicos}.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

Una clase, @ref{3899,,HTTPServer}, es una subclase @ref{1387,,socketserver.TCPServer}. Crea y escucha en el socket HTTP, enviando las peticiones a un handler.  El código para crear y ejecutar el servidor se ve así:

@example
def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
    server_address = ('@w{'}, 8000)
    httpd = server_class(server_address, handler_class)
    httpd.serve_forever()
@end example

@geindex HTTPServer (clase en http.server)
@anchor{library/http server http server HTTPServer}@anchor{3899}
@deffn {Clase} http.server.HTTPServer (server_address, RequestHandlerClass)

Esta clase se basa en la clase @ref{1387,,TCPServer} almacenando la dirección del servidor como variables de instancia llamadas @code{nombre_del_servidor} y @code{puerto_del_servidor}. El servidor es accesible por el handler, típicamente a través de la variable de instancia @code{servidor} del handler.
@end deffn

@geindex ThreadingHTTPServer (clase en http.server)
@anchor{library/http server http server ThreadingHTTPServer}@anchor{bcc}
@deffn {Clase} http.server.ThreadingHTTPServer (server_address, RequestHandlerClass)

Esta clase es idéntica a HTTPServer, pero utiliza subprocesos para controlar las solicitudes mediante el uso de @ref{c00,,ThreadingMixIn}. Esto es útil para controlar los sockets de pre-apertura de los navegadores web, en los que @ref{3899,,HTTPServer} esperaría indefinidamente.


Added in version 3.7.

@end deffn

El @ref{3899,,HTTPServer} y @ref{bcc,,ThreadingHTTPServer} deben recibir un `RequestHandlerClass' en la creación de instancias, de los cuales este módulo proporciona tres variantes diferentes:

@geindex BaseHTTPRequestHandler (clase en http.server)
@anchor{library/http server http server BaseHTTPRequestHandler}@anchor{1140}
@deffn {Clase} http.server.BaseHTTPRequestHandler (request, client_address, server)

Esta clase se utiliza para controlar las solicitudes HTTP que llegan al servidor.  Por sí mismo, no puede responder a ninguna solicitud HTTP real; debe ser subclase para manejar cada método de solicitud (por ejemplo, GET o POST). @ref{1140,,BaseHTTPRequestHandler} proporciona una serie de variables de clase e instancia, y métodos para su uso por subclases.

The handler will parse the request and the headers, then call a method
specific to the request type. The method name is constructed from the
request. For example, for the request method @code{SPAM}, the @code{do_SPAM()}
method will be called with no arguments. All of the relevant information is
stored in instance variables of the handler.  Subclasses should not need to
override or extend the @code{__init__()} method.

@ref{1140,,BaseHTTPRequestHandler} tiene las siguientes variables de instancia:

@geindex client_address (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler client_address}@anchor{3a97}
@deffn {Atributo} client_address

Contiene una tupla con el formato @code{(host, port)} que hace referencia a la dirección del cliente.
@end deffn

@geindex server (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler server}@anchor{3a98}
@deffn {Atributo} server

Contiene la instancia del servidor.
@end deffn

@geindex close_connection (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler close_connection}@anchor{3a99}
@deffn {Atributo} close_connection

Booleano que se debe establecer antes de @ref{3a9a,,handle_one_request()} retorna, que indica si se puede esperar otra solicitud o si la conexión debe cerrarse.
@end deffn

@geindex requestline (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler requestline}@anchor{3a9b}
@deffn {Atributo} requestline

Contiene la representación de cadena de la línea de solicitud HTTP. Se elimina el CRLF de terminación. Este atributo debe establecerse mediante @ref{3a9a,,handle_one_request()}. Si no se ha procesado ninguna línea de solicitud válida, debe establecerse en la cadena vacía.
@end deffn

@geindex command (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler command}@anchor{3a9c}
@deffn {Atributo} command

Contiene el comando (tipo de petición). Por ejemplo, @code{'GET'}.
@end deffn

@geindex path (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler path}@anchor{3a9d}
@deffn {Atributo} path

Contiene la ruta de la solicitud. Si el componente de consulta de la URL está presente, @code{path} incluye la consulta. Usando la terminología de: rfc: @cite{3986}, @code{path} aquí incluye @code{hier-part} y @code{query}.
@end deffn

@geindex request_version (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler request_version}@anchor{3a9e}
@deffn {Atributo} request_version

Contiene la versión de la cadena de caracteres para la petición. Por ejemplo, @code{HTTP/1.0'}.
@end deffn

@geindex headers (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler headers}@anchor{3982}
@deffn {Atributo} headers

Contiene una instancia de la clase especificada por la variable de clase @ref{3a9f,,MessageClass}. Esta instancia analiza y gestiona las cabeceras de la petición HTTP. La función @ref{1a50,,parse_headers()} de @ref{6f,,http.client} se usa para parsear las cabeceras y requiere que la petición HTTP proporcione una cabecera válida de estilo 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}.
@end deffn

@geindex rfile (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler rfile}@anchor{3aa0}
@deffn {Atributo} rfile

Un flujo de entrada @ref{735,,io.BufferedIOBase}, listo para leer desde el inicio de los datos de entrada opcionales.
@end deffn

@geindex wfile (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler wfile}@anchor{3aa1}
@deffn {Atributo} wfile

Contiene el flujo de salida para escribir una respuesta al cliente. Se debe utilizar la adherencia apropiada al protocolo HTTP cuando se escribe en este flujo para lograr una interoperación exitosa con los clientes HTTP.


Distinto en la versión 3.6: Este es un flujo de @ref{735,,io.BufferedIOBase}.

@end deffn

@ref{1140,,BaseHTTPRequestHandler} tiene los siguientes atributos:

@geindex server_version (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler server_version}@anchor{3aa2}
@deffn {Atributo} server_version

Especifica la versión del software del servidor. Es posible que desee anular esto. El formato es de múltiples cadenas separadas por espacio en blanco, donde cada cadena es de la forma nombre[/versión]. Por ejemplo, @code{BaseHTTP/0.2'}.
@end deffn

@geindex sys_version (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler sys_version}@anchor{3aa3}
@deffn {Atributo} sys_version

Contiene la versión del sistema Python, en una forma utilizable por el método @ref{3aa4,,version_string} y la variable de clase @ref{3aa2,,server_version}. Por ejemplo, @code{Python/1.4'}.
@end deffn

@geindex error_message_format (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler error_message_format}@anchor{3aa5}
@deffn {Atributo} error_message_format

Especifica una cadena de formato que debe ser usada por el método @ref{fd0,,send_error()} para construir una respuesta de error al cliente. La cadena se rellena por defecto con variables de @ref{3969,,responses} basadas en el código de estado que pasó a @ref{fd0,,send_error()}.
@end deffn

@geindex error_content_type (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler error_content_type}@anchor{3aa6}
@deffn {Atributo} error_content_type

Especifica el encabezado `HTTP Content-Type' de las respuestas de error enviadas al cliente.  El valor predeterminado es @code{'text/html'}.
@end deffn

@geindex protocol_version (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler protocol_version}@anchor{3aa7}
@deffn {Atributo} protocol_version

Especifica la versión de HTTP con la cual el servidor es conforme. Es enviada como respuesta para informarle al cliente sobre las capacidades de comunicación del servidor para siguientes peticiones. Si se establece en @code{'HTTP/1.1'}, el servidor permitirá conexiones persistentes HTTP; sin embargo, el servidor `debe' incluir un encabezado exacto @code{Content-Length} (usando @ref{3aa8,,send_header()}) en todas sus respuestas a los clientes. Para la compatibilidad con versiones anteriores, el valor predeterminado es @code{'HTTP/1.0'}.
@end deffn

@geindex MessageClass (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler MessageClass}@anchor{3a9f}
@deffn {Atributo} MessageClass

Especifica una @ref{3d1,,email.message.Message}-como clase para analizar los encabezados HTTP.  Típicamente, esto no es anulado, y por defecto es @ref{3980,,http.client.HTTPMessage}.
@end deffn

@geindex responses (atributo de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler responses}@anchor{3969}
@deffn {Atributo} responses

Este atributo contiene una asignación de enteros de código de error a tuplas de dos elementos que contienen un mensaje corto y largo. Por ejemplo, @code{@{code (shortmessage, longmessage)@}}. El `shortmessage' se utiliza normalmente como la clave `message' en una respuesta de error, y `longmessage' como la clave `explain'.  Es utilizado por @ref{3aa9,,send_response_only()} y @ref{fd0,,send_error()} métodos.
@end deffn

Una instancia @ref{1140,,BaseHTTPRequestHandler} tiene los siguientes métodos:

@geindex handle() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle}@anchor{3aaa}
@deffn {Método} handle ()

Calls @ref{3a9a,,handle_one_request()} once (or, if persistent connections are
enabled, multiple times) to handle incoming HTTP requests. You should
never need to override it; instead, implement appropriate @code{do_*()}
methods.
@end deffn

@geindex handle_one_request() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle_one_request}@anchor{3a9a}
@deffn {Método} handle_one_request ()

This method will parse and dispatch the request to the appropriate
@code{do_*()} method.  You should never need to override it.
@end deffn

@geindex handle_expect_100() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle_expect_100}@anchor{3aab}
@deffn {Método} handle_expect_100 ()

Cuando un servidor compatible con HTTP/1.1 recibe un encabezado de solicitud @code{Expect: 100-continue}, responde con un @code{100 Continue} seguido de encabezados @code{200 OK}. Este método se puede anular para generar un error si el servidor no desea que el cliente continúe. Por ejemplo, el servidor puede optar por enviar @code{417 Expectation Failed} como encabezado de respuesta y @code{return False}.


Added in version 3.2.

@end deffn

@geindex send_error() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_error}@anchor{fd0}
@deffn {Método} send_error (code, message=None, explain=None)

Sends and logs a complete error reply to the client. The numeric `code'
specifies the HTTP error code, with `message' as an optional, short, human
readable description of the error.  The `explain' argument can be used to
provide more detailed information about the error; it will be formatted
using the @ref{3aa5,,error_message_format} attribute and emitted, after
a complete set of headers, as the response body.  The @ref{3969,,responses}
attribute holds the default values for `message' and `explain' that
will be used if no value is provided; for unknown codes the default value
for both is the string @code{???}. The body will be empty if the method is
HEAD or the response code is one of the following: @code{1@var{xx}},
@code{204 No Content}, @code{205 Reset Content}, @code{304 Not Modified}.


Distinto en la versión 3.4: La respuesta de error incluye un encabezado de longitud de contenido. Añadido el argumento `explain'.

@end deffn

@geindex send_response() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_response}@anchor{3aac}
@deffn {Método} send_response (code, message=None)

Agrega un encabezado de respuesta al búfer de encabezados y registra la solicitud aceptada. La línea de respuesta HTTP se escribe en el búfer interno, seguido de los encabezados `Server' y `Date'. Los valores de estos dos encabezados se recogen de los métodos @ref{3aa4,,version_string()} y @ref{3aad,,date_time_string()}, respectivamente. Si el servidor no tiene la intención de enviar ningún otro encabezado utilizando el método @ref{3aa8,,send_header()}, entonces @ref{3aac,,send_response()} debe ir seguido de una llamada @ref{1141,,end_headers()}.


Distinto en la versión 3.3: Los encabezados se almacenan en un búfer interno y @ref{1141,,end_headers()} debe llamarse explícitamente.

@end deffn

@geindex send_header() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_header}@anchor{3aa8}
@deffn {Método} send_header (keyword, value)

Agrega el encabezado HTTP a un búfer interno que se escribirá en la secuencia de salida cuando se invoca @ref{1141,,end_headers()} o @ref{3aae,,flush_headers()}. `keyword' debe especificar la palabra clave `header', con `value' especificando su valor. Tenga en cuenta que, después de que se realizan las llamadas `send_header', @ref{1141,,end_headers()} DEBE llamarse para completar la operación.


Distinto en la versión 3.2: Los encabezados se almacenan en un búfer interno.

@end deffn

@geindex send_response_only() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_response_only}@anchor{3aa9}
@deffn {Método} send_response_only (code, message=None)

Envía el encabezado de respuesta solamente, usado para los propósitos cuando la respuesta @code{100 Continue} es enviada por el servidor al cliente. Los encabezados no se almacenan en el buffer y envían directamente el flujo de salida. Si no se especifica el `message', se envía el mensaje HTTP correspondiente al `code' de respuesta.


Added in version 3.2.

@end deffn

@geindex end_headers() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler end_headers}@anchor{1141}
@deffn {Método} end_headers ()

Adds a blank line
(indicating the end of the HTTP headers in the response)
to the headers buffer and calls @ref{3aae,,flush_headers()}.


Distinto en la versión 3.2: Los encabezados del buffer se escriben en el flujo de salida.

@end deffn

@geindex flush_headers() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler flush_headers}@anchor{3aae}
@deffn {Método} flush_headers ()

Finalmente envía los encabezados al flujo de salida y limpia el buffer interno de los cabezales.


Added in version 3.3.

@end deffn

@geindex log_request() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_request}@anchor{3aaf}
@deffn {Método} log_request (code='-', size='-')

Registra una solicitud aceptada (exitosa). El `code' debe especificar el código numérico HTTP asociado a la respuesta. Si un tamaño de la respuesta está disponible, entonces debe ser pasado como el parámetro `size'.
@end deffn

@geindex log_error() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_error}@anchor{3ab0}
@deffn {Método} log_error (...)

Registra un error cuando una solicitud no puede ser cumplida. Por defecto, pasa el mensaje a @ref{3ab1,,log_message()}, por lo que toma los mismos argumentos (`format' y valores adicionales).
@end deffn

@geindex log_message() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_message}@anchor{3ab1}
@deffn {Método} log_message (format, ...)

Registra un mensaje arbitrario en @code{sys.stderr}. Normalmente se anula para crear mecanismos personalizados de registro de errores. El argumento `format' es una cadena de formato estándar de estilo de impresión, donde los argumentos adicionales a @ref{3ab1,,log_message()} se aplican como entradas al formato. La dirección ip del cliente y la fecha y hora actual son prefijadas a cada mensaje registrado.
@end deffn

@geindex version_string() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler version_string}@anchor{3aa4}
@deffn {Método} version_string ()

Retorna la cadena de versiones del software del servidor. Esta es una combinación de los atributos @ref{3aa2,,server_version} y @ref{3aa3,,sys_version}.
@end deffn

@geindex date_time_string() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler date_time_string}@anchor{3aad}
@deffn {Método} date_time_string (timestamp=None)

Retorna la fecha y la hora dadas por `timestamp' (que debe ser @code{None} o en el formato retornado por @code{time.time`()}), formateado para un encabezado de mensaje. Si se omite `timestamp', utiliza la fecha y la hora actuales.

El resultado se muestra como @code{Sun, 06 Nov 1994 08:49:37 GMT'}.
@end deffn

@geindex log_date_time_string() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_date_time_string}@anchor{3ab2}
@deffn {Método} log_date_time_string ()

Retorna la fecha y la hora actuales, formateadas para el registro.
@end deffn

@geindex address_string() (método de http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler address_string}@anchor{3ab3}
@deffn {Método} address_string ()

Retorna la dirección del cliente.


Distinto en la versión 3.3: Anteriormente, se realizó una búsqueda de nombres. Para evitar retrasos en la resolución del nombre, ahora siempre retorna la dirección IP.

@end deffn
@end deffn

@geindex SimpleHTTPRequestHandler (clase en http.server)
@anchor{library/http server http server SimpleHTTPRequestHandler}@anchor{bcb}
@deffn {Clase} http.server.SimpleHTTPRequestHandler (request, client_address, server, directory=None)

Esta clase sirve archivos del directorio `directory' e inferior, o del directorio actual si no se proporciona `directory', mapeando directamente la estructura del directorio a las solicitudes HTTP.


Distinto en la versión 3.7: Added the `directory' parameter.



Distinto en la versión 3.9: El parámetro `directory' acepta un @ref{3f0,,path-like object}.


La carga de trabajo, como el análisis de la solicitud, lo hace la clase base @ref{1140,,BaseHTTPRequestHandler}.  Esta clase implementa las funciones @ref{3ab4,,do_GET()} y @ref{3ab5,,do_HEAD()}.

Los siguientes se definen como atributos de clase de @ref{bcb,,SimpleHTTPRequestHandler}:

@geindex server_version (atributo de http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler server_version}@anchor{3ab6}
@deffn {Atributo} server_version

Esto sería @code{"SimpleHTTP/" + __version__}, donde @code{__version__} se define a nivel de módulo.
@end deffn

@geindex extensions_map (atributo de http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler extensions_map}@anchor{3ab7}
@deffn {Atributo} extensions_map

Un diccionario que asigna sufijos a tipos MIME contiene sobreescrituras personalizadas para las asignaciones predeterminadas del sistema. El mapeo se usa sin distinción entre mayúsculas y minúsculas, por lo que solo debe contener claves en minúsculas.


Distinto en la versión 3.9: Este diccionario ya no contiene las asignaciones predeterminadas del sistema, sino que solo contiene anulaciones.

@end deffn

Una instancia @ref{bcb,,SimpleHTTPRequestHandler} tiene los siguientes métodos:

@geindex do_HEAD() (método de http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler do_HEAD}@anchor{3ab5}
@deffn {Método} do_HEAD ()

Este método sirve para el tipo de petición: @code{'HEAD'} envía los encabezados que enviaría para la petición equivalente @code{GET}. Ver el método @ref{3ab4,,do_GET()} para una explicación más completa de los posibles encabezados.
@end deffn

@geindex do_GET() (método de http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler do_GET}@anchor{3ab4}
@deffn {Método} do_GET ()

La solicitud se asigna a un archivo local interpretando la solicitud como una ruta relativa al directorio de trabajo actual.

Si la solicitud fue mapeada a un directorio, el directorio se comprueba para un archivo llamado @code{index.html} or @code{index.htm} (en ese orden). Si se encuentra, se retorna el contenido del archivo; de lo contrario, se genera un listado del directorio llamando al método @code{list_directory()}. Este método utiliza @ref{116c,,os.listdir()} para escanear el directorio, y retorna una respuesta de error @code{404} si falla el @ref{116c,,listdir()}.

If the request was mapped to a file, it is opened. Any @ref{4d5,,OSError}
exception in opening the requested file is mapped to a @code{404},
@code{'File not found'} error. If there was an @code{'If-Modified-Since'}
header in the request, and the file was not modified after this time,
a @code{304}, @code{'Not Modified'} response is sent. Otherwise, the content
type is guessed by calling the @code{guess_type()} method, which in turn
uses the `extensions_map' variable, and the file contents are returned.

Un encabezado de @code{'Content-type:'} con el tipo de contenido adivinado, seguido de un encabezado de @code{'Content-Length:'} con el tamaño del archivo y un encabezado de @code{'Last-Modified:'} con el tiempo de modificación del archivo.

Luego sigue una línea en blanco que significa el final de los encabezados, y luego se imprime el contenido del archivo. Si el tipo MIME del archivo comienza con @code{text/} el archivo se abre en modo de texto; en caso contrario se utiliza el modo binario.

Por ejemplo, ver la implementación de la función @code{test} en Lib/http/server.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/server.py}.


Distinto en la versión 3.7: Soporta la cabecera @code{'If-Modified-Since'}.

@end deffn
@end deffn

La clase @ref{bcb,,SimpleHTTPRequestHandler} puede ser usada de la siguiente manera para crear un servidor web muy básico que sirva archivos relativos al directorio actual:

@example
import http.server
import socketserver

PORT = 8000

Handler = http.server.SimpleHTTPRequestHandler

with socketserver.TCPServer(("", PORT), Handler) as httpd:
    print("serving at port", PORT)
    httpd.serve_forever()
@end example

@ref{bcb,,SimpleHTTPRequestHandler} can also be subclassed to enhance behavior,
such as using different index file names by overriding the class attribute
@code{index_pages}.
@anchor{library/http server http-server-cli}@anchor{fd1}
@ref{72,,http.server} también puede ser invocado directamente usando la opción @ref{187,,-m} del intérprete. Como en el ejemplo anterior, esto sirve a los archivos relativos al directorio actual:

@example
python -m http.server
@end example

Por defecto, el servidor escucha en el puerto 8000. El valor predeterminado se puede anular pasando el número de puerto deseado como argumento:

@example
python -m http.server 9000
@end example

Por defecto, el servidor se vincula a todas las interfaces.  La opción @code{-b/--bind} especifica una dirección específica a la que se vinculará. Tanto las direcciones IPv4 como las IPv6 están soportadas. Por ejemplo, el siguiente comando hace que el servidor se vincule sólo al localhost:

@example
python -m http.server --bind 127.0.0.1
@end example


Distinto en la versión 3.4: Added the @code{--bind} option.



Distinto en la versión 3.8: Support IPv6 in the @code{--bind} option.


Por defecto, el servidor utiliza el directorio actual. La opción @code{-d/--directory} especifica un directorio al que debe servir los archivos. Por ejemplo, el siguiente comando utiliza un directorio específico:

@example
python -m http.server --directory /tmp/
@end example


Distinto en la versión 3.7: Added the @code{--directory} option.


Por defecto, el servidor es conforme con HTTP/1.0. La opción @code{-p/--protocol} especifica la versión HTTP con la que cumple el servidor. Por ejemplo, el siguiente comando ejecuta un servidor conforme con HTTP/1.1:

@example
python -m http.server --protocol HTTP/1.1
@end example


Distinto en la versión 3.11: Added the @code{--protocol} option.


@geindex CGIHTTPRequestHandler (clase en http.server)
@anchor{library/http server http server CGIHTTPRequestHandler}@anchor{1cf}
@deffn {Clase} http.server.CGIHTTPRequestHandler (request, client_address, server)

Esta clase se utiliza para servir tanto a los archivos como a la salida de los scripts CGI del directorio actual y del siguiente. Note que el mapeo de la estructura jerárquica de HTTP a la estructura del directorio local es exactamente como en @ref{bcb,,SimpleHTTPRequestHandler}.

@cartouche
@quotation Nota 
Los scripts CGI ejecutados por la clase @ref{1cf,,CGIHTTPRequestHandler} no pueden ejecutar redirecciones (código HTTP 302), porque el código 200 (la salida del script sigue) se envía antes de la ejecución del script CGI.  Esto adelanta el código de estado.
@end quotation
@end cartouche

La clase, sin embargo, ejecutará el script CGI, en lugar de servirlo como un archivo, si adivina que es un script CGI.  Sólo se usan CGI basados en directorios — la otra configuración común del servidor es tratar las extensiones especiales como denotando los scripts CGI.

Las funciones @code{do_GET()} y @code{do_HEAD()} se modifican para ejecutar scripts CGI y servir la salida, en lugar de servir archivos, si la petición lleva a algún lugar por debajo de la ruta @code{cgi_directories}.

La @ref{1cf,,CGIHTTPRequestHandler} define el siguiente miembro de datos:

@geindex cgi_directories (atributo de http.server.CGIHTTPRequestHandler)
@anchor{library/http server http server CGIHTTPRequestHandler cgi_directories}@anchor{3ab8}
@deffn {Atributo} cgi_directories

Esto por defecto es @code{['/cgi-bin', '/htbin']} y describe los directorios a tratar como si contuvieran scripts CGI.
@end deffn

La @ref{1cf,,CGIHTTPRequestHandler} define el siguiente método:

@geindex do_POST() (método de http.server.CGIHTTPRequestHandler)
@anchor{library/http server http server CGIHTTPRequestHandler do_POST}@anchor{3ab9}
@deffn {Método} do_POST ()

Este método sirve para el tipo de petición @code{'POST'}, sólo permitido para scripts CGI.  El error 501, «Can only POST to CGI scripts», se produce cuando se intenta enviar a una url no CGI.
@end deffn

Tenga en cuenta que los scripts CGI se ejecutarán con UID de usuario `nobody', por razones de seguridad.  Los problemas con el script CGI serán traducidos al error 403.


Deprecated since version 3.13, will be removed in version 3.15: @ref{1cf,,CGIHTTPRequestHandler} is being removed in 3.15.  CGI has not
been considered a good way to do things for well over a decade. This code
has been unmaintained for a while now and sees very little practical use.
Retaining it could lead to further @ref{3a96,,security considerations}.

@end deffn

@ref{1cf,,CGIHTTPRequestHandler} puede ser activado en la línea de comandos pasando la opción @code{--cgi}:

@example
python -m http.server --cgi
@end example


Deprecated since version 3.13, will be removed in version 3.15: @ref{72,,http.server} command line @code{--cgi} support is being removed
because @ref{1cf,,CGIHTTPRequestHandler} is being removed.


@cartouche
@quotation Advertencia 
@ref{1cf,,CGIHTTPRequestHandler} and the @code{--cgi} command line option
are not intended for use by untrusted clients and may be vulnerable
to exploitation. Always use within a secure environment.
@end quotation
@end cartouche

@menu
* Consideraciones de seguridad: Consideraciones de seguridad<3>. 

@end menu

@node Consideraciones de seguridad<3>,,,http server — HTTP servers
@anchor{library/http server http-server-security}@anchor{3a96}@anchor{library/http server security-considerations}@anchor{3aba}
@subsubsection Consideraciones de seguridad


@geindex http.server;security

@ref{bcb,,SimpleHTTPRequestHandler} seguirá los enlaces simbólicos cuando gestione peticiones, esto hace posible que se sirvan ficheros fuera del directorio especificado.

Earlier versions of Python did not scrub control characters from the
log messages emitted to stderr from @code{python -m http.server} or the
default @ref{1140,,BaseHTTPRequestHandler} @code{.log_message}
implementation. This could allow remote clients connecting to your
server to send nefarious control codes to your terminal.


Distinto en la versión 3.12: Control characters are scrubbed in stderr logs.


@node http cookies — HTTP state management,http cookiejar — Cookie handling for HTTP clients,http server — HTTP servers,Protocolos y soporte de Internet
@anchor{library/http cookies doc}@anchor{3abb}@anchor{library/http cookies http-cookies-http-state-management}@anchor{3abc}@anchor{library/http cookies module-http cookies}@anchor{71}
@subsection @code{http.cookies} — HTTP state management


@geindex module; http.cookies

`Source code:' Lib/http/cookies.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/cookies.py}


__________________________________________________________________


El módulo @ref{71,,http.cookies} define clases para abstraer el concepto de cookies, un mecanismo de gestión de estado HTTP. Admite cookies simples de solo cadenas de caracteres y proporciona una abstracción para tener cualquier tipo de datos serializable como valor de cookie.

The module formerly strictly applied the parsing rules described in the
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} and 
@geindex RFC; RFC 2068
RFC 2068@footnote{https://datatracker.ietf.org/doc/html/rfc2068.html} specifications.  It has since been discovered that
MSIE 3.0x didn’t follow the character rules outlined in those specs; many
current-day browsers and servers have also relaxed parsing rules when it comes
to cookie handling.  As a result, this module now uses parsing rules that are a
bit less strict than they once were.

The character set, @ref{132d,,string.ascii_letters}, @ref{22c5,,string.digits} and
@code{!#$%&'*+-.^_`|~:} denote the set of valid characters allowed by this module
in a cookie name (as @ref{c89,,key}).


Distinto en la versión 3.3: Allowed “:” as a valid cookie name character.


@cartouche
@quotation Nota 
Al encontrar una cookie no válida, se lanza @ref{3abd,,CookieError}, por lo que si los datos de su cookie provienen de un navegador, siempre debe prepararse para los datos no válidos y detectar @ref{3abd,,CookieError} en el análisis.
@end quotation
@end cartouche

@geindex CookieError
@anchor{library/http cookies http cookies CookieError}@anchor{3abd}
@deffn {Excepción} http.cookies.CookieError

Error de excepción debido a la invalidez de 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html}: atributos incorrectos, encabezado @code{Set-Cookie} incorrecto, etc.
@end deffn

@geindex BaseCookie (clase en http.cookies)
@anchor{library/http cookies http cookies BaseCookie}@anchor{3abe}
@deffn {Clase} http.cookies.BaseCookie ([input])

Esta clase es un objeto similar a un diccionario cuyas claves son cadenas  de caracteres y cuyos valores son @ref{c8c,,Morsel}. Tenga en cuenta que al establecer una clave en un valor, el valor se convierte primero en @ref{c8c,,Morsel} que contiene la clave y el valor.

Si se proporciona `input', se pasa al método @ref{3abf,,load()}.
@end deffn

@geindex SimpleCookie (clase en http.cookies)
@anchor{library/http cookies http cookies SimpleCookie}@anchor{1a4a}
@deffn {Clase} http.cookies.SimpleCookie ([input])

This class derives from @ref{3abe,,BaseCookie} and overrides @ref{3ac0,,value_decode()}
and @ref{3ac1,,value_encode()}. @code{SimpleCookie} supports
strings as cookie values. When setting the value, @code{SimpleCookie}
calls the builtin @ref{237,,str()} to convert
the value to a string. Values received from HTTP are kept as strings.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{70,,http.cookiejar}

Manejo de cookies HTTP para web `clients'. Los módulos @ref{70,,http.cookiejar} and @ref{71,,http.cookies} no dependen el uno del otro.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - Mecanismo de gestión de estado HTTP

Esta es la especificación de gestión de estado implementada por este módulo.
@end table


@menu
* Objetos de cookie:: 
* Objetos Morsel:: 
* Ejemplo: Ejemplo<12>. 

@end menu

@node Objetos de cookie,Objetos Morsel,,http cookies — HTTP state management
@anchor{library/http cookies cookie-objects}@anchor{3ac2}@anchor{library/http cookies id1}@anchor{3ac3}
@subsubsection Objetos de cookie


@geindex value_decode() (método de http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie value_decode}@anchor{3ac0}
@deffn {Método} BaseCookie.value_decode (val)

Retorna una tupla @code{(real_value, coded_value)} de una representación de cadena de caracteres. @code{real_value} puede ser de cualquier tipo. Este método no decodifica en @ref{3abe,,BaseCookie} — existe por lo que puede ser anulado.
@end deffn

@geindex value_encode() (método de http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie value_encode}@anchor{3ac1}
@deffn {Método} BaseCookie.value_encode (val)

Retorna una tupla @code{(real_value, coded_value)}. `val' puede ser de cualquier tipo, pero @code{coded_value} siempre se convertirá en una cadena de caracteres. Este método no codifica en @ref{3abe,,BaseCookie} — existe por lo que se puede anular.

En general, debería darse el caso de que @ref{3ac1,,value_encode()} y @ref{3ac0,,value_decode()} sean inversas en el rango de `value_decode'.
@end deffn

@geindex output() (método de http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie output}@anchor{3ac4}
@deffn {Método} BaseCookie.output (attrs=None, header='Set-Cookie:', sep='\r\n')

Retorna una representación de cadena de caracteres adecuada para enviarse como encabezados HTTP. `attrs' y `header' se envían a cada método @ref{c8c,,Morsel}’s @ref{3ac4,,output()}. `sep' se usa para unir los encabezados y es por defecto la combinación @code{'\r\n'} (CRLF).
@end deffn

@geindex js_output() (método de http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie js_output}@anchor{3ac5}
@deffn {Método} BaseCookie.js_output (attrs=None)

Retorna un fragmento de código JavaScript que, si se ejecuta en un navegador que admita JavaScript, actuará de la misma forma que si se enviaran los encabezados HTTP.

El significado de `attrs' es el mismo que en @ref{3ac4,,output()}.
@end deffn

@geindex load() (método de http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie load}@anchor{3abf}
@deffn {Método} BaseCookie.load (rawdata)

Si `rawdata' es una cadena de caracteres, analícela como un @code{HTTP_COOKIE} y agregue los valores que se encuentran allí como @ref{c8c,,Morsel}s. Si es un diccionario, equivale a:

@example
for k, v in rawdata.items():
    cookie[k] = v
@end example
@end deffn

@node Objetos Morsel,Ejemplo<12>,Objetos de cookie,http cookies — HTTP state management
@anchor{library/http cookies id2}@anchor{3ac6}@anchor{library/http cookies morsel-objects}@anchor{3ac7}
@subsubsection Objetos Morsel


@geindex Morsel (clase en http.cookies)
@anchor{library/http cookies http cookies Morsel}@anchor{c8c}
@deffn {Clase} http.cookies.Morsel

Resumen de un par clave/valor, que tiene algunos atributos 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html}.

Morsels are dictionary-like objects, whose set of keys is constant — the valid
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} attributes, which are:

@quotation

@geindex expires (atributo de http.cookies.Morsel)
@geindex path (atributo de http.cookies.Morsel)
@geindex comment (atributo de http.cookies.Morsel)
@geindex domain (atributo de http.cookies.Morsel)
@geindex secure (atributo de http.cookies.Morsel)
@geindex version (atributo de http.cookies.Morsel)
@geindex httponly (atributo de http.cookies.Morsel)
@geindex samesite (atributo de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel expires}@anchor{3ac8}
@deffn {Atributo} expires
@anchor{library/http cookies http cookies Morsel path}@anchor{3ac9}
@deffnx {Atributo} path
@anchor{library/http cookies http cookies Morsel comment}@anchor{3aca}
@deffnx {Atributo} comment
@anchor{library/http cookies http cookies Morsel domain}@anchor{3acb}
@deffnx {Atributo} domain

@deffnx {Atributo} max@w{-}age
@anchor{library/http cookies http cookies Morsel secure}@anchor{3acc}
@deffnx {Atributo} secure
@anchor{library/http cookies http cookies Morsel version}@anchor{3acd}
@deffnx {Atributo} version
@anchor{library/http cookies http cookies Morsel httponly}@anchor{1410}
@deffnx {Atributo} httponly
@anchor{library/http cookies http cookies Morsel samesite}@anchor{3ace}
@deffnx {Atributo} samesite
@end deffn
@end quotation

El atributo @ref{1410,,httponly} especifica que la cookie solo se transfiere en solicitudes HTTP y no es accesible a través de JavaScript. Esto tiene como objetivo mitigar algunas formas de secuencias de comandos entre sitios.

El atributo @ref{3ace,,samesite} especifica que el navegador no puede enviar la cookie junto con solicitudes entre sitios. Esto ayuda a mitigar los ataques CSRF. Los valores válidos para este atributo son «Strict» y «Lax».

Las claves no distinguen entre mayúsculas y minúsculas y su valor predeterminado es @code{'@w{'}}.


Distinto en la versión 3.5: @code{__eq__()} now takes @ref{c89,,key} and @ref{c8a,,value}
into account.



Distinto en la versión 3.7: Los atributos @ref{c89,,key}, @ref{c8a,,value} y @ref{c8b,,coded_value} son de solo lectura. Utilice @ref{c8d,,set()} para configurarlos.



Distinto en la versión 3.8: Se agregó soporte para el atributo @ref{3ace,,samesite}.

@end deffn

@geindex value (atributo de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel value}@anchor{c8a}
@deffn {Atributo} Morsel.value

El valor de la cookie.
@end deffn

@geindex coded_value (atributo de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel coded_value}@anchor{c8b}
@deffn {Atributo} Morsel.coded_value

El valor codificado de la cookie — esto es lo que se debe enviar.
@end deffn

@geindex key (atributo de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel key}@anchor{c89}
@deffn {Atributo} Morsel.key

El nombre de la cookie.
@end deffn

@geindex set() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel set}@anchor{c8d}
@deffn {Método} Morsel.set (key, value, coded_value)

Establezca los atributos `key', `value' y `coded_value'.
@end deffn

@geindex isReservedKey() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel isReservedKey}@anchor{3acf}
@deffn {Método} Morsel.isReservedKey (K)

Si `K' es miembro del conjunto de claves de una @ref{c8c,,Morsel}.
@end deffn

@geindex output() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel output}@anchor{3ad0}
@deffn {Método} Morsel.output (attrs=None, header='Set-Cookie:')

Retorna una representación de cadena de caracteres del Morsel, adecuada para enviarse como un encabezado HTTP. De forma predeterminada, se incluyen todos los atributos, a menos que se proporcione `attrs', en cuyo caso debería ser una lista de atributos a utilizar. `header' es por defecto @code{"Set-Cookie:"}.
@end deffn

@geindex js_output() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel js_output}@anchor{3ad1}
@deffn {Método} Morsel.js_output (attrs=None)

Retorna un fragmento de código JavaScript que, si se ejecuta en un navegador que admita JavaScript, actuará de la misma forma que si se hubiera enviado el encabezado HTTP.

El significado de `attrs' es el mismo que en @ref{3ad0,,output()}.
@end deffn

@geindex OutputString() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel OutputString}@anchor{3ad2}
@deffn {Método} Morsel.OutputString (attrs=None)

Retorna una cadena de caracteres que representa el Morsel, sin ningún HTTP o JavaScript circundante.

El significado de `attrs' es el mismo que en @ref{3ad0,,output()}.
@end deffn

@geindex update() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel update}@anchor{f4a}
@deffn {Método} Morsel.update (values)

Actualice los valores en el diccionario Morsel con los valores en el diccionario `values'. Lanza un error si alguna de las claves en el `values' dict no es un atributo válido 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html}.


Distinto en la versión 3.5: se lanza un error para claves no válidas.

@end deffn

@geindex copy() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel copy}@anchor{f49}
@deffn {Método} Morsel.copy (value)

Retorna una copia superficial del objeto Morsel.


Distinto en la versión 3.5: retorna un objeto Morsel en lugar de un dict.

@end deffn

@geindex setdefault() (método de http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel setdefault}@anchor{3ad3}
@deffn {Método} Morsel.setdefault (key, value=None)

Lanza un error si la clave no es un atributo válido 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html}; de lo contrario, se comporta igual que @ref{10f5,,dict.setdefault()}.
@end deffn

@node Ejemplo<12>,,Objetos Morsel,http cookies — HTTP state management
@anchor{library/http cookies cookie-example}@anchor{3ad4}@anchor{library/http cookies example}@anchor{3ad5}
@subsubsection Ejemplo


El siguiente ejemplo demuestra cómo utilizar el módulo @ref{71,,http.cookies}.

@example
>>> from http import cookies
>>> C = cookies.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> print(C) # generate HTTP headers
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> print(C.output()) # same thing
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> C = cookies.SimpleCookie()
>>> C["rocky"] = "road"
>>> C["rocky"]["path"] = "/cookie"
>>> print(C.output(header="Cookie:"))
Cookie: rocky=road; Path=/cookie
>>> print(C.output(attrs=[], header="Cookie:"))
Cookie: rocky=road
>>> C = cookies.SimpleCookie()
>>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header)
>>> print(C)
Set-Cookie: chips=ahoy
Set-Cookie: vienna=finger
>>> C = cookies.SimpleCookie()
>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"
>>> C = cookies.SimpleCookie()
>>> C["oreo"] = "doublestuff"
>>> C["oreo"]["path"] = "/"
>>> print(C)
Set-Cookie: oreo=doublestuff; Path=/
>>> C = cookies.SimpleCookie()
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
>>> C = cookies.SimpleCookie()
>>> C["number"] = 7 # equivalent to C["number"] = str(7)
>>> C["string"] = "seven"
>>> C["number"].value
'7'
>>> C["string"].value
'seven'
>>> print(C)
Set-Cookie: number=7
Set-Cookie: string=seven
@end example

@node http cookiejar — Cookie handling for HTTP clients,xmlrpc — Módulos XMLRPC para cliente y servidor,http cookies — HTTP state management,Protocolos y soporte de Internet
@anchor{library/http cookiejar doc}@anchor{3ad6}@anchor{library/http cookiejar http-cookiejar-cookie-handling-for-http-clients}@anchor{3ad7}@anchor{library/http cookiejar module-http cookiejar}@anchor{70}
@subsection @code{http.cookiejar} — Cookie handling for HTTP clients


@geindex module; http.cookiejar

`Código fuente:' Lib/http/cookiejar.py@footnote{https://github.com/python/cpython/tree/main/Lib/http/cookiejar.py}


__________________________________________________________________


El módulo @ref{70,,http.cookiejar} define clases para el manejo automático de cookies HTTP. Es útil para acceder a sitios web que requieren pequeñas piezas de datos – `cookies' – para establecerse en el equipo del cliente a través de una respuesta HTTP de un servidor web, y que además retornan al servidor más tarde en forma de requests de HTTP.

Se manejan tanto el protocolo de cookies normal de Netscape como el protocolo definido por 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. El manejo de RFC 2965 está desactivado de forma predeterminada. Las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} se analizan como cookies de Netscape y, posteriormente, se tratan como cookies de Netscape o RFC 2965 de acuerdo con la «política» en vigor. Tenga en cuenta que la gran mayoría de las cookies en Internet son cookies de Netscape. @ref{70,,http.cookiejar} intenta seguir el protocolo de cookies de Netscape de facto (que difiere sustancialmente del establecido en la especificación original de Netscape), incluida la toma de nota de los atributos de cookies @code{max-age} y @code{port} introducidos con RFC 2965.

@cartouche
@quotation Nota 
Diversos parámetros nombrados que se encuentran en @code{Set-Cookie} y @code{Set-Cookie2} (ejem. @code{domain} y @code{expires}) son convencionalmente referidos como `attributes'. Para distinguirlos de los atributos de Python, la documentación de este módulo utiliza el término `cookie-attribute'.
@end quotation
@end cartouche

El módulo define la siguiente excepción:

@geindex LoadError
@anchor{library/http cookiejar http cookiejar LoadError}@anchor{3ad8}
@deffn {Excepción} http.cookiejar.LoadError

Las instancias de @ref{3ad9,,FileCookieJar} provocan esta excepción al no cargar las cookies desde un archivo. @ref{3ad8,,LoadError} es una subclase de @ref{4d5,,OSError}.


Distinto en la versión 3.3: @ref{3ad8,,LoadError} used to be a subtype of @ref{10ce,,IOError}, which is now an
alias of @ref{4d5,,OSError}.

@end deffn

Se proporcionan las siguientes clases:

@geindex CookieJar (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar CookieJar}@anchor{3909}
@deffn {Clase} http.cookiejar.CookieJar (policy=None)

`policy' es un objeto implementando la interfaz @ref{3ada,,CookiePolicy}.

La clase @ref{3909,,CookieJar} almacena HTTP cookies. Ésta extrae cookies de los request de HTTP, y las retorna en forma de responses de HTTP. Las instancias de @ref{3909,,CookieJar} automáticamente expiran las cookies contenidas cuando es necesario. Las subclases también son responsables de almacenar y recuperar cookies de un archivo o base de datos.
@end deffn

@geindex FileCookieJar (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar FileCookieJar}@anchor{3ad9}
@deffn {Clase} http.cookiejar.FileCookieJar (filename=None, delayload=None, policy=None)

`policy' es un objeto implementando la interfaz @ref{3ada,,CookiePolicy}. Para los otros argumentos, te recomendamos visitar la documentación correspondiente a los atributos.

Una @ref{3909,,CookieJar} puede cargar cookies de, y posiblemente almacenar, un archivo en el disco. Las cookies `NO' son cargadas desde un archivo nombrado hasta que alguno de los métodos @ref{3adb,,load()} o @ref{3adc,,revert()} es llamado. Subclases de esta clase son documentadas en la sección @ref{3add,,Subclases FileCookieJar y co-operación con navegadores web}.

Esto no debe inicializarse directamente; en su lugar, use sus subclases a continuación.


Distinto en la versión 3.8: El parámetro filename soporta un @ref{3f0,,path-like object}.

@end deffn

@geindex CookiePolicy (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar CookiePolicy}@anchor{3ada}
@deffn {Clase} http.cookiejar.CookiePolicy

Esta clase es responsable de decidir si cada cookie debe ser aceptada del servidor, o retornada al mismo.
@end deffn

@geindex DefaultCookiePolicy (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy}@anchor{1a19}
@deffn {Clase} http.cookiejar.DefaultCookiePolicy (blocked_domains=None, allowed_domains=None, netscape=True, rfc2965=False, rfc2109_as_netscape=None, hide_cookie2=False, strict_domain=False, strict_rfc2965_unverifiable=True, strict_ns_unverifiable=False, strict_ns_domain=DefaultCookiePolicy.DomainLiberal, strict_ns_set_initial_dollar=False, strict_ns_set_path=False, secure_protocols=('https', 'wss'))

Los argumentos del constructor sólo deben ser dados como argumentos clave. `blocked_domains' es una secuencia de nombres de dominio cuyas cookies nunca deben de ser aceptadas o retornadas. `allowed_domains' y no @ref{716,,None}, es una secuencia de sólo dominios que podemos aceptar y retornar cookies. `secure_protocols' es una secuencia de protocolos para los que se pueden agregar cookies seguras. De manera predeterminada `https' y `wss' (websocket seguro) son considerados protocolos seguros. Para todos los demás argumentos, te recomendamos visitar la documentación para los objetos @ref{3ada,,CookiePolicy} y @ref{1a19,,DefaultCookiePolicy}.

@ref{1a19,,DefaultCookiePolicy} implementa el estándar de reglas aceptar/rechazar para cookies Netscape y 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. De manera predeterminada, las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} (es decir, las cookies que reciben una cabecera @code{Set-Cookie} con una versión cookie-attribute de 1) son tratadas de acuerdo con las reglas del RFC 2965. Sin embargo, si el manejo del RFC2965 se encuentra apagado o @ref{3ade,,rfc2109_as_netscape} es @code{True}, las cookies RFC 2109 son “degradadas” por la instancia @ref{3909,,CookieJar} a las cookies Netscape, configurando la @code{version} del atributo de la instancia @ref{3adf,,Cookie} como 0. @ref{1a19,,DefaultCookiePolicy} también provee algunos parámetros que permiten fine-tunning en el policy.
@end deffn

@geindex Cookie (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar Cookie}@anchor{3adf}
@deffn {Clase} http.cookiejar.Cookie

Esta clase representa Netscape, las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} y 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. No se espera que los usuarios de @ref{70,,http.cookiejar} construyan sus propias instancias de @ref{3adf,,Cookie}. En vez de ello, si es necesario, llama al método @code{make_cookies()} de la instancia @ref{3909,,CookieJar}.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{10b,,urllib.request}

Apertura de URL con manejo automático de cookies.

@item Módulo @ref{71,,http.cookies}

Clases de cookies HTTP, principalmente útiles para código server-side. Los módulos @ref{70,,http.cookiejar} y @ref{71,,http.cookies} no dependen uno del otro.

@item @indicateurl{https://curl.se/rfc/cookie_spec.html}

La especificación original del protocolo de cookies Netscape. Aunque éste sigue siendo el protocolo dominante, el “protocolo de cookies Netscape” implementado por la mayoría de los navegadores (y el protocolo @ref{70,,http.cookiejar}) sólo tienen in parecido pasajero con el bosquejado en @code{cookie_spec.html}.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - Mecanismo de Gestión de Estados HTTP

Obsoleto por 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. Usa @code{Set-Cookie} con versión=1.

@geindex RFC; RFC 2965

@item RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} - Mecanismo de Gestión de Estados HTTP

El protocolo Netscape con los errores solucionados. Usa @code{Set-Cookie2} en lugar de @code{Set-Cookie}. No es ampliamente usado.

@item @indicateurl{https://kristol.org/cookie/errata.html}

Fe de erratas sin finalizar hasta el 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.
@end table

@geindex RFC; RFC 2964
RFC 2964@footnote{https://datatracker.ietf.org/doc/html/rfc2964.html} - Mecanismo de Gestión de Estados HTTP


@menu
* Objetos CookieJar y FileCookieJar:: 
* Subclases FileCookieJar y co-operación con navegadores web:: 
* Objetos CookiePolicy:: 
* Objetos DefaultCookiePolicy:: 
* Objetos Cookie:: 
* Ejemplos: Ejemplos<27>. 

@end menu

@node Objetos CookieJar y FileCookieJar,Subclases FileCookieJar y co-operación con navegadores web,,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-jar-objects}@anchor{3ae0}@anchor{library/http cookiejar cookiejar-and-filecookiejar-objects}@anchor{3ae1}
@subsubsection Objetos CookieJar y FileCookieJar


Los objetos @ref{3909,,CookieJar} soportan el protocolo @ref{313,,iterator} para iterar sobre los objetos @ref{3adf,,Cookie} contenidos.

@ref{3909,,CookieJar} tiene los siguientes métodos:

@geindex add_cookie_header() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar add_cookie_header}@anchor{3ae2}
@deffn {Método} CookieJar.add_cookie_header (request)

Añade la cookie correcta a la cabecera del request.

Si el `policy' admite (ie. los atributos @code{rfc2965} y @code{hide_cookie2} de la instancia @ref{3909,,CookieJar} del @ref{3ada,,CookiePolicy} son de manera respectiva verdadero y falso), la cabecera @code{Cookie2} es igualmente añadido cuando es apropiado.

El objeto `request' (usualmente una instancia de @ref{1057,,urllib.request.Request}) debe soportar los métodos @code{get_full_url()}, @code{has_header()}, @code{get_header()}, @code{header_items()}, @code{add_unredirected_header()} y los atributos @code{host}, @code{type}, @code{unverifiable} y @code{origin_req_host} según lo documentado por @ref{10b,,urllib.request}.


Distinto en la versión 3.3: el objeto `request' necesita del atributo  @code{origin_req_host}. La dependencia en el método deprecado @code{get_origin_req_host()} ha sido removida.

@end deffn

@geindex extract_cookies() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar extract_cookies}@anchor{3ae3}
@deffn {Método} CookieJar.extract_cookies (response, request)

Extrae las cookies del `response' HTTP y las almacena en el @ref{3909,,CookieJar}, donde está permitido por la policy.

El @ref{3909,,CookieJar} buscará por cabeceras @code{Set-Cookie} y @code{Set-Cookie2} permitidos en el argumento `response', y almacena las cookies cuando es apropiado (sujeto a la aprobación del método @ref{3ae4,,CookiePolicy.set_ok()}).

El objeto `response' (usualmente el resultado de llamar @ref{20a,,urllib.request.urlopen()}, o similares) debe de soportar un método @code{info()} , el cual retorna una instancia @ref{3d1,,email.message.Message}.

El objeto `request' (usualmente una instancia de @ref{1057,,urllib.request.Request}) debe soportar los métodos @code{get_full_url()} y los atributos @code{host}, @code{unverifiable} y @code{origin_req_host} según lo documentado por @ref{10b,,urllib.request}. La solicitud se utiliza para establecer valores predeterminados para los atributos de las cookies, así como para verificar si la cookie puede establecerse.


Distinto en la versión 3.3: el objeto `request' necesita del atributo  @code{origin_req_host}. La dependencia en el método deprecado @code{get_origin_req_host()} ha sido removida.

@end deffn

@geindex set_policy() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_policy}@anchor{3ae5}
@deffn {Método} CookieJar.set_policy (policy)

Establece la instancia @ref{3ada,,CookiePolicy} para ser usada.
@end deffn

@geindex make_cookies() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar make_cookies}@anchor{3ae6}
@deffn {Método} CookieJar.make_cookies (response, request)

Retorna una secuencia de objetos @ref{3adf,,Cookie} extraída del objeto `response'.

Revisa la documentación @ref{3ae3,,extract_cookies()} para conocer las interfaces necesarias de los argumentos `response' y `request'.
@end deffn

@geindex set_cookie_if_ok() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie_if_ok}@anchor{3ae7}
@deffn {Método} CookieJar.set_cookie_if_ok (cookie, request)

Establece una @ref{3adf,,Cookie} si la política (`policy') dice OK para hacerlo.
@end deffn

@geindex set_cookie() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie}@anchor{3ae8}
@deffn {Método} CookieJar.set_cookie (cookie)

Establece una @ref{3adf,,Cookie}, sin consultar con la política (`policy') para ver si se debe de establecer o no.
@end deffn

@geindex clear() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar clear}@anchor{3ae9}
@deffn {Método} CookieJar.clear ([domain[, path[, name]]])

Borra algunas cookies.

Si se invoca sin argumentos, borra todas las cookies. Si se le da un solo argumento. sólo las cookies que pertenecen a tal `domain' serán removidas. Si se le da dos argumentos, las cookies pertenecientes al especificado `domain' y `path' URL serán removidas. Si se le da tres argumentos, entonces la cookie con el especificado `domain', `path' y `name' será removida.

Lanza @ref{438,,KeyError} si no existe ninguna cookie que coincida.
@end deffn

@geindex clear_session_cookies() (método de http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar clear_session_cookies}@anchor{3aea}
@deffn {Método} CookieJar.clear_session_cookies ()

Descarta todas las cookies de la sesión.

Descarta todas las cookies que tengan un atributo @code{discard} true (usualmente porque no tienen @code{max-age} o @code{expires} atributos’cookie, o un explícito atributo-cookie @code{discard}). Para los navegadores interactivos, el fin de la sesión usualmente corresponde con el cierre de la ventana del navegador.

Nota que el método @code{save()} no guardará las cookies de la sesión de todas maneras, a menos que de otra manera preguntes para pasar un argumento `ignore_discard' como true.
@end deffn

@ref{3ad9,,FileCookieJar} implementa los siguientes métodos adicionales:

@geindex save() (método de http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar save}@anchor{3aeb}
@deffn {Método} FileCookieJar.save (filename=None, ignore_discard=False, ignore_expires=False)

Guarda las cookies en un archivo.

Esta clase base genera @ref{384,,NotImplementedError}. Las subclases podrían dejar este método sin implementar.

`filename' es el nombre del archivo en el que se guardarán las cookies. Si `filename' no es especificado, @code{self.filename} es utilizado (cuyo valor predeterminado es el valor que será pasado al constructor, si hay alguno); si @code{self.filename} es @ref{716,,None}, se genera un @ref{360,,ValueError}.

`ignore_discard': almacena incluso las cookies configuradas para ser descartadas. `ignore_expires': almacena las cookies que han caducado

El archivo se sobrescribe si ya existe, borrando así todas las cookies que contiene. Las cookies guardadas se pueden restaurar después utilizando los métodos @ref{3adb,,load()} o @ref{3adc,,revert()}.
@end deffn

@geindex load() (método de http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar load}@anchor{3adb}
@deffn {Método} FileCookieJar.load (filename=None, ignore_discard=False, ignore_expires=False)

Carga las cookies desde un archivo.

Las viejas cookies son guardadas a menos que sean sobre escritas por nuevas recién cargadas.

Los argumentos son en cuanto a @ref{3aeb,,save()}.

El archivo nombrado debe estar en un formato entendible para la clase, o se lanzará un @ref{3ad8,,LoadError}. Además, puede generarse un @ref{4d5,,OSError}, por ejemplo, si el archivo no existe.


Distinto en la versión 3.3: Solía levantarse un @ref{10ce,,IOError}, pero ahora es un alias de @ref{4d5,,OSError}.

@end deffn

@geindex revert() (método de http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar revert}@anchor{3adc}
@deffn {Método} FileCookieJar.revert (filename=None, ignore_discard=False, ignore_expires=False)

Limpia todas las cookies y recarga las cookies de un archivo guardado.

@ref{3adc,,revert()} puede levantar las mismas excepciones que @ref{3adb,,load()}. Si hay un fallo. el estado del objeto no se alterará.
@end deffn

Instancias @ref{3ad9,,FileCookieJar} tienen los siguientes atributos públicos:

@geindex filename (atributo de http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar filename}@anchor{3aec}
@deffn {Atributo} FileCookieJar.filename

Nombre del archivo predeterminado para el archivo en donde se almacenan las cookies. Este atributo podría ser asignado.
@end deffn

@geindex delayload (atributo de http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar delayload}@anchor{3aed}
@deffn {Atributo} FileCookieJar.delayload

Si es true, carga perezosamente las cookies desde el disco. Este atributo no se debería de asignar. Esta es solo una pista, debido a que solo el rendimiento, y no al comportamiento (a menos que las cookies en el disco sean cambiadas). Un objeto @ref{3909,,CookieJar} puede ignorarlo. Ninguna de las clases de @ref{3ad9,,FileCookieJar} incluidas en la librería estándar carga las cookies de manera perezosa.
@end deffn

@node Subclases FileCookieJar y co-operación con navegadores web,Objetos CookiePolicy,Objetos CookieJar y FileCookieJar,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar file-cookie-jar-classes}@anchor{3add}@anchor{library/http cookiejar filecookiejar-subclasses-and-co-operation-with-web-browsers}@anchor{3aee}
@subsubsection Subclases FileCookieJar y co-operación con navegadores web


Las siguientes subclases @ref{3909,,CookieJar} son proveídas para lectura y escritura.

@geindex MozillaCookieJar (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar MozillaCookieJar}@anchor{3aef}
@deffn {Clase} http.cookiejar.MozillaCookieJar (filename=None, delayload=None, policy=None)

Un @ref{3ad9,,FileCookieJar} que puede cargar y guardar cookies al disco en el formato de archivo @code{cookies.txt} de Mozilla (que también es utilizado por curl y los navegadores Lynx y Netscape).

@cartouche
@quotation Nota 
Esto puede perder información acerca de cookies 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}, y también sobre atributos nuevos o no estándar como @code{port}.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Realiza una copia de seguridad de tus cookies antes de guardarlas, especialmente si tienes cookies cuya perdida / corrupción puede ser inconveniente (hay algunas sutilezas que pueden conducir a ligeros cambios en el archivo sobre una carga / guardado round-trip).
@end quotation
@end cartouche

También toma en cuenta que las cookies guardadas mientras Mozilla se está ejecutando se volverán torpes debido a Mozilla.
@end deffn

@geindex LWPCookieJar (clase en http.cookiejar)
@anchor{library/http cookiejar http cookiejar LWPCookieJar}@anchor{3af0}
@deffn {Clase} http.cookiejar.LWPCookieJar (filename=None, delayload=None, policy=None)

Un @ref{3ad9,,FileCookieJar} que puede cargar y guardar en disco en formato compatible con el formato de archivo @code{Set-Cookie3} de la librería libwww-perl. Estos es conveniente si tu quieres guardar cookies en un archivo legible para los humanos.


Distinto en la versión 3.8: El parámetro filename soporta un @ref{3f0,,path-like object}.

@end deffn

@node Objetos CookiePolicy,Objetos DefaultCookiePolicy,Subclases FileCookieJar y co-operación con navegadores web,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-policy-objects}@anchor{3af1}@anchor{library/http cookiejar cookiepolicy-objects}@anchor{3af2}
@subsubsection Objetos CookiePolicy


Objetos implementando la interfaz @ref{3ada,,CookiePolicy} tienen los siguientes métodos:

@geindex set_ok() (método de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy set_ok}@anchor{3ae4}
@deffn {Método} CookiePolicy.set_ok (cookie, request)

Retorna un valor booleano indicando si la cookie debe ser aceptada o no desde el servidor.

`cookie' es una instancia de @ref{3adf,,Cookie}. `request' es un objeto implementando la interfaz definida por la documentación de @ref{3ae3,,CookieJar.extract_cookies()}.
@end deffn

@geindex return_ok() (método de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy return_ok}@anchor{3af3}
@deffn {Método} CookiePolicy.return_ok (cookie, request)

Retorna un valor booleano indicando si la cookie debe ser retornada o no al servidor.

`cookie' es una instancia de @ref{3adf,,Cookie}. `request' es un objeto implementando la interfaz definida por la documentación de @ref{3ae2,,CookieJar.add_cookie_header()}.
@end deffn

@geindex domain_return_ok() (método de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy domain_return_ok}@anchor{3af4}
@deffn {Método} CookiePolicy.domain_return_ok (domain, request)

Retorna @code{False} si las cookies no deben de ser retornadas, a partir del dominio cookie dado.

Este método es una optimización. Elimina la necesidad de verificar cada cookie con un domino en particular (lo cual puede involucrar la lectura de muchos archivos). Retornando true de @ref{3af4,,domain_return_ok()} y @ref{3af5,,path_return_ok()} deja todo el trabajo a @ref{3af3,,return_ok()}.

Si @ref{3af4,,domain_return_ok()} retorna true para el dominio de cookies, @ref{3af5,,path_return_ok()} es llamado para el path de cookies. De otra manera, @ref{3af5,,path_return_ok()} y @ref{3af3,,return_ok()} no son nunca llamados para ese dominio de cookies. Si @ref{3af5,,path_return_ok()} retorna true, @ref{3af3,,return_ok()} es llamado con el objeto @ref{3adf,,Cookie} en sí para una revisión completa. De otra manera, @ref{3af3,,return_ok()} es nunca llamado para ese path de cookies.

Ten en cuenta que @ref{3af4,,domain_return_ok()} es llamado para cada dominio `cookie', no solamente para el dominio `request'. Por ejemplo, la función podría ser llamada con ambos @code{".example.com"} y @code{"www.example.com"} si el dominio request es @code{"www.example.com"}. Lo mismo se aplica para @ref{3af5,,path_return_ok()}.

El argumento `request' es tal y como es documentado para @ref{3af3,,return_ok()}.
@end deffn

@geindex path_return_ok() (método de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy path_return_ok}@anchor{3af5}
@deffn {Método} CookiePolicy.path_return_ok (path, request)

Retorna @code{False} si las cookies no deben de ser retornadas, dado el path de las cookies.

Revisa la documentación para @ref{3af4,,domain_return_ok()}.
@end deffn

Adicionalmente a los métodos implementados anteriormente, las implementaciones de la interfaz @ref{3ada,,CookiePolicy} también deben de proporcionar los siguientes atributos, indicando cuales protocolos deben de ser utilizados, y como. Todos estos atributos se pueden asignar.

@geindex netscape (atributo de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy netscape}@anchor{3af6}
@deffn {Atributo} CookiePolicy.netscape

Implementa el protocolo Netscape.
@end deffn

@geindex rfc2965 (atributo de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy rfc2965}@anchor{3af7}
@deffn {Atributo} CookiePolicy.rfc2965

Implementa el protocolo 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.
@end deffn

@geindex hide_cookie2 (atributo de http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy hide_cookie2}@anchor{3af8}
@deffn {Atributo} CookiePolicy.hide_cookie2

No añadas la cabecera @code{Cookie2} a las requests (la presencia de esta cabecera indica al servidor que nosotros entendemos las cookies 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}).
@end deffn

El camino más útil para definir una clase @ref{3ada,,CookiePolicy} es haciendo una subclase de @ref{1a19,,DefaultCookiePolicy} y sobre escribir algunos o todos los métodos anteriores. @ref{3ada,,CookiePolicy} en sí misma puede ser utilizada como una “null policy” para permitir establecer y recibir algunas o todas las cookies (esto raramente puede ser útil).

@node Objetos DefaultCookiePolicy,Objetos Cookie,Objetos CookiePolicy,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar default-cookie-policy-objects}@anchor{3af9}@anchor{library/http cookiejar defaultcookiepolicy-objects}@anchor{3afa}
@subsubsection Objetos DefaultCookiePolicy


Implementa las reglas estándar para aceptar y retornar cookies.

Ambas cookies, 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} y Netscape son cubiertas. El manejo del RFC 2965 está desactivado de forma predeterminada.

La forma más sencilla de proporcionar tu propia política (`policy') es sobre escribir esta clase y llamar sus métodos en tus implementaciones modificadas antes de añadir tu propias comprobaciones adicionales:

@example
import http.cookiejar
class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):
    def set_ok(self, cookie, request):
        if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):
            return False
        if i_dont_want_to_store_this_cookie(cookie):
            return False
        return True
@end example

En adición a las características requeridas para implementar la interfaz @ref{3ada,,CookiePolicy}, esta clase te permite que bloquees o permitas dominios de establecer y recibir cookies. También hay algunos interruptores estrictos que te permiten ajustar un poco las reglas flojas del protocolo Netscape (a costa de bloquear algunas cookies benignas).

Se proporciona una lista de bloqueo y una lista de permitidos del dominio (ambos desactivados de forma predeterminada). Solo los dominios que no están en la lista de bloqueo y que están presentes en la lista de permisos (si la lista de permisos está activa) participan en la configuración y devolución de cookies. Utilice el argumento del constructor `blocked_domains' y los métodos @code{blocked_domains()} y @code{set_blocked_domains()} (y el argumento y los métodos correspondientes para `allowed_domains'). Si configura una lista de permitidos, puede desactivarla nuevamente configurándola en @ref{716,,None}.

Los dominios en listas de bloqueos o permitidos que no comienzan con un punto deben ser iguales al dominio de la cookie para que coincidan. Por ejemplo, @code{"example.com"} coincide con una entrada de lista de bloqueo de @code{"example.com"}, pero @code{"www.example.com"} no. Los dominios que comienzan con un punto también se corresponden con dominios más específicos. Por ejemplo, tanto @code{"www.example.com"} como @code{"www.coyote.example.com"} coinciden con @code{".example.com"} (pero el propio @code{"example.com"} no lo hace). Las direcciones IP son una excepción y deben coincidir exactamente. Por ejemplo, si block_domains contiene @code{"192.168.1.2"} y @code{".168.1.2"}, 192.168.1.2 está bloqueado, pero 193.168.1.2 no.

@ref{1a19,,DefaultCookiePolicy} implementa los siguientes métodos adicionales:

@geindex blocked_domains() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy blocked_domains}@anchor{3afb}
@deffn {Método} DefaultCookiePolicy.blocked_domains ()

Retorna una secuencia de dominios bloqueados (en forma de tupla).
@end deffn

@geindex set_blocked_domains() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_blocked_domains}@anchor{3afc}
@deffn {Método} DefaultCookiePolicy.set_blocked_domains (blocked_domains)

Establece la secuencia de dominios bloqueados.
@end deffn

@geindex is_blocked() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_blocked}@anchor{3afd}
@deffn {Método} DefaultCookiePolicy.is_blocked (domain)

Retorna @code{True} si `domain' está en la lista de bloqueo para establecer o recibir cookies.
@end deffn

@geindex allowed_domains() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy allowed_domains}@anchor{3afe}
@deffn {Método} DefaultCookiePolicy.allowed_domains ()

Retorna @ref{716,,None}, o la secuencia de los dominios permitidos (en forma de tupla).
@end deffn

@geindex set_allowed_domains() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_allowed_domains}@anchor{3aff}
@deffn {Método} DefaultCookiePolicy.set_allowed_domains (allowed_domains)

Establece la secuencia de los dominios permitidos, o @ref{716,,None}.
@end deffn

@geindex is_not_allowed() (método de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_not_allowed}@anchor{3b00}
@deffn {Método} DefaultCookiePolicy.is_not_allowed (domain)

Retorna @code{True} si `domain' no está en la lista de permitidos para establecer o recibir cookies.
@end deffn

Las instancias @ref{1a19,,DefaultCookiePolicy} tienen los siguientes atributos, que son todos inicializados desde los argumentos del constructor del mismo nombre, y el cual todos pueden ser asignados a.

@geindex rfc2109_as_netscape (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy rfc2109_as_netscape}@anchor{3ade}
@deffn {Atributo} DefaultCookiePolicy.rfc2109_as_netscape

Si es true, solicita que la instancia @ref{3909,,CookieJar} degrade las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} (es decir, las cookies recibidas en una cabecera @code{Set-Cookie} con un cookie-attribute versión de 1) a cookies Netscape al establecer la versión del atributo de la instancia @ref{3adf,,Cookie} a 0. El valor predeterminado es @ref{716,,None}, en cuyo caso las cookies RFC 2109 son degradadas si y sólo si el control de 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} se encuentra apagado. Por lo tanto, las cookies RFC 2109 son degradadas de forma predeterminada.
@end deffn

Interruptores generales de rigurosidad:

@geindex strict_domain (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_domain}@anchor{3b01}
@deffn {Atributo} DefaultCookiePolicy.strict_domain

No permite que los sitios establezcan dominios de dos componentes con dominios country-code top-level como @code{.co.uk}, @code{.gov.uk}, @code{.co.nz}.etc. ¡Esto está lejos de ser perfecto y no está garantizado a que vaya a funcionar!
@end deffn

Interruptores de rigurosidad del protocolo 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}:

@geindex strict_rfc2965_unverifiable (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_rfc2965_unverifiable}@anchor{3b02}
@deffn {Atributo} DefaultCookiePolicy.strict_rfc2965_unverifiable

Siga las reglas 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} sobre transacciones no verificables (normalmente, una transacción no verificable es una del resultado de una redirección o una solicitud de una imagen alojada en otro sitio). Si esto es falso, las cookies `nunca' se bloquean en base a la verificabilidad
@end deffn

Interruptores de rigurosidad del protocolo Netscape:

@geindex strict_ns_unverifiable (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_unverifiable}@anchor{3b03}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_unverifiable

Aplica las reglas del 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} a transacciones no verificables incluso a cookies Netscape.
@end deffn

@geindex strict_ns_domain (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_domain}@anchor{3b04}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_domain

Indicadores que señalan que tan estricto deben ser con las reglas de domain-matching para cookies Netscape. Consulte a continuación los valores aceptables.
@end deffn

@geindex strict_ns_set_initial_dollar (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_initial_dollar}@anchor{3b05}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_set_initial_dollar

Ignora las cookies en las cabeceras Set-Cookie: que tengan nombres que comienzan con @code{'$'}.
@end deffn

@geindex strict_ns_set_path (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_path}@anchor{3b06}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_set_path

No permite establecer cookies cuyo path no concuerde con el request URI.
@end deffn

@code{strict_ns_domain} es una colección de indicadores. Su valor está construido o siendo construido en conjunto (por ejemplo, @code{DomainStrictNoDots|DomainStrictNonDomain} significa que ambos indicadores se encuentran establecidos).

@geindex DomainStrictNoDots (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNoDots}@anchor{3b07}
@deffn {Atributo} DefaultCookiePolicy.DomainStrictNoDots

Cuando configuras las cookies, el “host prefix” no debe de contener un punto (ejem. @code{www.foo.bar.com} no puede establecer una cookie para @code{.bar.com}, porque @code{www.foo} tiene un punto).
@end deffn

@geindex DomainStrictNonDomain (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNonDomain}@anchor{3b08}
@deffn {Atributo} DefaultCookiePolicy.DomainStrictNonDomain

Las cookies que no especifican explícitamente un cookie-attribute @code{domain} sólo se pueden retornar a un dominio igual al que estableció la cookie (ejem. @code{spam.example.com} no retornará las cookies de @code{example.com} que no tuvieran un cookie-attribute @code{domain})
@end deffn

@geindex DomainRFC2965Match (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainRFC2965Match}@anchor{3b09}
@deffn {Atributo} DefaultCookiePolicy.DomainRFC2965Match

Cuando se establecen las cookies, requiere de un completo emparejamiento de dominio 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.
@end deffn

Los siguientes atributos son proveídos por conveniencia, y son las combinaciones más útiles de los indicadores anteriores:

@geindex DomainLiberal (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainLiberal}@anchor{3b0a}
@deffn {Atributo} DefaultCookiePolicy.DomainLiberal

Equivalente a 0 (es decir, todos los anteriores indicadores de rigurosidad de los dominios Netscape están apagados).
@end deffn

@geindex DomainStrict (atributo de http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrict}@anchor{3b0b}
@deffn {Atributo} DefaultCookiePolicy.DomainStrict

Equivalente a @code{DomainStrictNoDots|DomainStrictNonDomain}.
@end deffn

@node Objetos Cookie,Ejemplos<27>,Objetos DefaultCookiePolicy,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-objects}@anchor{3b0c}
@subsubsection Objetos Cookie


Las instancias @ref{3adf,,Cookie} tienen atributos Python mas o menos correspondientes a los estándar cookie-attribute especificados en los diferentes estándares cookie. La correspondencia no es uno a uno, porque existen complicadas reglas para asignar valores predeterminados, debido a que los cookie-attribute @code{max-age} y @code{expires} contienen información equivalente, además que las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} pueden estar “downgraded” por @ref{70,,http.cookiejar} desde la versión 1 a la 0 (Netscape) cookies.

La asignación a estos atributos no debe de ser necesario excepto en raras circunstancias en un método @ref{3ada,,CookiePolicy}. La clase no aplica consistencia interna, por lo que tienes que saber lo que estás haciendo si lo estas aplicando.

@geindex version (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie version}@anchor{3b0d}
@deffn {Atributo} Cookie.version

Entero o @ref{716,,None}. Las cookies Netscape tienen @ref{3b0d,,version} 0. 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} y las cookies 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} tienen una @code{version} del cookie-attribute de 1. Sin embargo, ten en cuenta que @ref{70,,http.cookiejar} puede “downgrade” las cookies RFC 2109 a Netscape cookies, en cuyo caso @ref{3b0d,,version} es 0.
@end deffn

@geindex name (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie name}@anchor{3b0e}
@deffn {Atributo} Cookie.name

Nombre de la cookie (un string).
@end deffn

@geindex value (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie value}@anchor{3b0f}
@deffn {Atributo} Cookie.value

El valor de la cookie (una string), o @ref{716,,None}.
@end deffn

@geindex port (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie port}@anchor{3b10}
@deffn {Atributo} Cookie.port

String que representa un puerto o un conjunto de puertos (ejem. “80”, o “80,8080”) o incluso @ref{716,,None}.
@end deffn

@geindex domain (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain}@anchor{3b11}
@deffn {Atributo} Cookie.domain

Cookie domain (a string).
@end deffn

@geindex path (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie path}@anchor{3b12}
@deffn {Atributo} Cookie.path

Ruta de la cookie (un string, ejem. @code{'/acme/rocket_launchers'}).
@end deffn

@geindex secure (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie secure}@anchor{3b13}
@deffn {Atributo} Cookie.secure

@code{True} si cookie sólo debe de ser retornada sobre una conexión segura.
@end deffn

@geindex expires (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie expires}@anchor{3b14}
@deffn {Atributo} Cookie.expires

Fecha de caducidad entera en segundos desde la parte temporal, o @ref{716,,None}. Véase también el método @ref{3b15,,is_expired()}.
@end deffn

@geindex discard (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie discard}@anchor{3b16}
@deffn {Atributo} Cookie.discard

@code{True} si esta es una sesión de cookies.
@end deffn

@geindex comment (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie comment}@anchor{3b17}
@deffn {Atributo} Cookie.comment

Comentario string del servidor explicando la función de esta cookie, o @ref{716,,None}.
@end deffn

@geindex comment_url (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie comment_url}@anchor{3b18}
@deffn {Atributo} Cookie.comment_url

URL que enlaza a un comentario desde un servidor explicando la función de esta cookie, o @ref{716,,None}.
@end deffn

@geindex rfc2109 (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie rfc2109}@anchor{3b19}
@deffn {Atributo} Cookie.rfc2109

@code{True} si esta cookie fue recibida como una cookie 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} (es decir, la cookie fue recibida en una cabecera @code{Set-Cookie}, y el valor del cookie-attribute Versión en la cabecera fue de 1). Este atributo es proveído porque @ref{70,,http.cookiejar} puede “degradar” cookies RFC 2109 a cookies Netscape, en cuyo caso @ref{3b0d,,version} es 0.
@end deffn

@geindex port_specified (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie port_specified}@anchor{3b1a}
@deffn {Atributo} Cookie.port_specified

@code{True} si un puerto o un conjunto de puertos fue explícitamente especificado por el servidor (en la cabecera @code{Set-Cookie} / @code{Set-Cookie2}).
@end deffn

@geindex domain_specified (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain_specified}@anchor{3b1b}
@deffn {Atributo} Cookie.domain_specified

@code{True} si un domino fue explícitamente especificado por el servidor.
@end deffn

@geindex domain_initial_dot (atributo de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain_initial_dot}@anchor{3b1c}
@deffn {Atributo} Cookie.domain_initial_dot

@code{True} si el dominio explícitamente especificado por el servidor empieza con un punto (@code{'.'}).
@end deffn

Las cookies pueden tener cookie-attribute no estándar adicionales. Se pueden acceder a estos usando los siguientes métodos:

@geindex has_nonstandard_attr() (método de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie has_nonstandard_attr}@anchor{3b1d}
@deffn {Método} Cookie.has_nonstandard_attr (name)

Retorna @code{True} si cookie tiene nombrado el cookie-attribute.
@end deffn

@geindex get_nonstandard_attr() (método de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie get_nonstandard_attr}@anchor{3b1e}
@deffn {Método} Cookie.get_nonstandard_attr (name, default=None)

Si la cookie tiene nombrado el cookie-attribute, retorna su valor. De otra manera, retorna `default'.
@end deffn

@geindex set_nonstandard_attr() (método de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie set_nonstandard_attr}@anchor{3b1f}
@deffn {Método} Cookie.set_nonstandard_attr (name, value)

Retorna el valor del nombrado cookie-attribute.
@end deffn

La clase @ref{3adf,,Cookie} también define el siguiente método:

@geindex is_expired() (método de http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie is_expired}@anchor{3b15}
@deffn {Método} Cookie.is_expired (now=None)

@code{True} si la cookie ha excedido el tiempo que el servidor solicitó para que expirara. Si `now' es dado (en segundos desde la parte temporal), retorna si la cookie ha expirado en el momento especificado.
@end deffn

@node Ejemplos<27>,,Objetos Cookie,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar examples}@anchor{3b20}
@subsubsection Ejemplos


El primer ejemplo muestra el uso más común de @ref{70,,http.cookiejar}:

@example
import http.cookiejar, urllib.request
cj = http.cookiejar.CookieJar()
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

Este ejemplo ilustra como abrir una URL usando tus cookies Netscape, Mozilla, o Lynx (asume la convención Unix/Netscape para la ubicación del archivo de cookies):

@example
import os, http.cookiejar, urllib.request
cj = http.cookiejar.MozillaCookieJar()
cj.load(os.path.join(os.path.expanduser("~"), ".netscape", "cookies.txt"))
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

El siguiente ejemplo ilustra el uso de @ref{1a19,,DefaultCookiePolicy}. Activa las cookies 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}, es más estricto con respecto a los dominios cuando se establecen o se retornan cookies Netscape, y bloquea algunos dominios para establecer o retornar cookies:

@example
import urllib.request
from http.cookiejar import CookieJar, DefaultCookiePolicy
policy = DefaultCookiePolicy(
    rfc2965=True, strict_ns_domain=Policy.DomainStrict,
    blocked_domains=["ads.net", ".ads.net"])
cj = CookieJar(policy)
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

@node xmlrpc — Módulos XMLRPC para cliente y servidor,xmlrpc client — XML-RPC client access,http cookiejar — Cookie handling for HTTP clients,Protocolos y soporte de Internet
@anchor{library/xmlrpc doc}@anchor{3b21}@anchor{library/xmlrpc xmlrpc-xmlrpc-server-and-client-modules}@anchor{3b22}
@subsection @code{xmlrpc} — Módulos XMLRPC para cliente y servidor


XML-RPC es un método de Llamada a Procedimiento Remoto (o RPC en inglés) que usa XML usando HTTP como vía de transporte. Con esto, un cliente puede llamar a método con parámetros en un servidor remoto (el servidor se identifica mediante una URI) y traer de vuelta datos de forma estructurada.

@code{xmlrpc} es un paquete que agrupa los módulos, tanto de cliente como de servidor, que implementan XML-RPC. Los módulos son:


@itemize *

@item 
@ref{12d,,xmlrpc.client}

@item 
@ref{12e,,xmlrpc.server}
@end itemize

@node xmlrpc client — XML-RPC client access,xmlrpc server — Basic XML-RPC servers,xmlrpc — Módulos XMLRPC para cliente y servidor,Protocolos y soporte de Internet
@anchor{library/xmlrpc client doc}@anchor{3b23}@anchor{library/xmlrpc client module-xmlrpc client}@anchor{12d}@anchor{library/xmlrpc client xmlrpc-client-xml-rpc-client-access}@anchor{3b24}
@subsection @code{xmlrpc.client} — XML-RPC client access


@geindex module; xmlrpc.client

`Source code:' Lib/xmlrpc/client.py@footnote{https://github.com/python/cpython/tree/main/Lib/xmlrpc/client.py}

@c XXX Not everything is documented yet.  It might be good to describe
@c Marshaller, Unmarshaller, getparser and Transport.


__________________________________________________________________


XML-RPC es un método de llamada a procedimiento remoto que utiliza XML pasado a través de HTTP(S) como transporte. Con él, un cliente puede llamar a métodos con parámetros en un servidor remoto (el servidor es nombrado por un URI) y recuperar datos estructurados. Este módulo admite la escritura de código de cliente XML-RPC; maneja todos los detalles de la traducción entre objetos de Python conformes y XML en el cable.

@cartouche
@quotation Advertencia 
El módulo @ref{12d,,xmlrpc.client} no es seguro contra datos construidos maliciosamente. Si necesita analizar datos que no son de confianza o no autenticados, consulte @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche


Distinto en la versión 3.5: Para HTTPS URI, @ref{12d,,xmlrpc.client} ahora realiza todas las comprobaciones necesarias de certificados y nombres de host de forma predeterminada.


@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@geindex ServerProxy (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client ServerProxy}@anchor{ae8}
@deffn {Clase} xmlrpc.client.ServerProxy (uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, headers=(), context=None)

Una @ref{ae8,,ServerProxy} instancia un objeto que gestiona la comunicación con un servidor XML-RPC remoto. El primer argumento requerido es un URI (`Uniform Resource Indicator') y normalmente será la URL del servidor. El segundo argumento opcional es una instancia de fábrica de transporte; de forma predeterminada, es una instancia interna @code{SafeTransport} para https: URL y una instancia interna HTTP @code{Transport} en caso contrario. El tercer argumento opcional es una codificación, por defecto UTF-8. El cuarto argumento opcional es un indicador de depuración.

Los siguientes parámetros rigen el uso de la instancia de proxy retornada. Si `allow_none' es verdadero, la constante de Python @code{None} se traducirá a XML; el comportamiento predeterminado es que @code{None} genere un @ref{228,,TypeError}. Esta es una extensión de uso común para la especificación XML-RPC, pero no todos los clientes y servidores la admiten; ver http://ontosys.com/xml-rpc/extensions.php@footnote{https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php} para una descripción. La opción `use_builtin_types' puede usarse para hacer que los valores de fecha/hora se presenten como objetos @ref{32f,,datetime.datetime} y los datos binarios pueden ser presentados como objetos @ref{325,,bytes}; esta opción es falsa por defecto. Los objetos @ref{32f,,datetime.datetime}, @ref{325,,bytes} y @ref{5e0,,bytearray} se pueden pasar a las llamadas. El parámetro `headers' es una secuencia opcional de encabezados HTTP para enviar con cada solicitud, expresada como una secuencia de 2 tuplas que representan el nombre y el valor del encabezado. (por ejemplo, @cite{[(“Header-Name”@comma{} “value”)]}). La opción obsoleta `use_datetime' es similar a `use_builtin_types' pero solo se aplica a los valores de fecha/hora.
@end deffn


Distinto en la versión 3.3: La opción `use_builtin_types' fue añadida.



Distinto en la versión 3.8: El parámetro `headers' fue añadida.

Tanto los transportes HTTP como HTTPS admiten la extensión de sintaxis de URL para la autenticación básica HTTP:@code{http://user:pass@@host:port/path}. La parte @code{user:pass} se codificará en base64 como un encabezado HTTP de “Authorization” y se enviará al servidor remoto como parte del proceso de conexión al invocar un método XML-RPC. Solo necesita usar esto si el servidor remoto requiere un usuario y contraseña de autenticación básica. Si se proporciona una URL HTTPS, el `context' puede ser @ref{1fa,,ssl.SSLContext} y configura la configuración SSL de la conexión HTTPS subyacente.

La instancia retornada es un objeto proxy con métodos que se pueden utilizar para invocar las correspondientes llamadas RPC en el servidor remoto. Si el servidor remoto admite la API de introspección, el proxy también se puede utilizar para consultar al servidor remoto los métodos que admite (descubrimiento de servicios) y recuperar otros metadatos asociados al servidor.

Los tipos que son conformes (por ejemplo, que se pueden clasificar a través de XML) incluyen lo siguiente (y, excepto donde se indique, no se clasifican como el mismo tipo de Python):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo XML-RPC

@tab

Tipo de Python

@item

@code{boolean}

@tab

@ref{513,,bool}

@item

@code{int}, @code{i1},
@code{i2},  @code{i4},
@code{i8} or
@code{biginteger}

@tab

@ref{1f0,,int} en el rango de -2147483648 a 2147483647. Los valores obtienen la etiqueta @code{<int>} .

@item

@code{double} o @code{float}

@tab

@ref{153,,float}.  Los valores obtienen la etiqueta @code{<double>}.

@item

@code{string}

@tab

@ref{237,,str}

@item

@code{array}

@tab

@ref{18e,,list} o @ref{464,,tuple} que contiene elementos determinados. Las matrices se retornan como @ref{18e,,lists}.

@item

@code{struct}

@tab

@ref{190,,dict}. Las claves deben ser cadenas de caracteres, los valores pueden ser de cualquier tipo determinado. Pueden pasarse objetos de clases definidas por el usuario; sólo se transmite su atributo @ref{5fe,,__dict__} .

@item

@code{dateTime.iso8601}

@tab

@ref{1423,,DateTime} o @ref{32f,,datetime.datetime}. El tipo retornado depende de los valores de los indicadores `use_builtin_types' y `use_datetime' .

@item

@code{base64}

@tab

@ref{3b25,,Binary}, @ref{325,,bytes} o @ref{5e0,,bytearray}. El tipo retornado depende del valor de la marca `use_builtin_types'.

@item

@code{nil}

@tab

La constante @code{None}. Solo se permite pasar si `allow_none' es verdadero.

@item

@code{bigdecimal}

@tab

@ref{16a,,decimal.Decimal}. Retornado solo el tipo.

@end multitable


Este es el conjunto completo de tipos de datos admitidos por XML-RPC. Las llamadas a métodos también pueden generar una instancia especial @ref{3b26,,Fault}, que se usa para señalar errores del servidor XML-RPC, o @ref{3b27,,ProtocolError} que se usa para señalar un error en la capa de transporte HTTP/HTTPS. Ambos @ref{3b26,,Fault} y @ref{3b27,,ProtocolError} derivan de una clase base llamada @code{Error}. Tenga en cuenta que el módulo de cliente xmlrpc actualmente no clasifica instancias de subclases de tipos integrados.

Al pasar cadenas de caracteres, los caracteres especiales de XML como @code{<}, @code{>} y @code{&} se escaparán automáticamente. Sin embargo, es responsabilidad de la persona que llama asegurarse de que la cadena de caracteres esté libre de caracteres que no están permitidos en XML, como los caracteres de control con valores ASCII entre 0 y 31 (excepto, por supuesto, tabulación, nueva línea y retorno de carro); no hacer esto resultará en una solicitud XML-RPC que no es XML bien formado. Si tiene que pasar bytes arbitrarios a través de XML-RPC, use las clases @ref{325,,bytes} o @ref{5e0,,bytearray} o la clase contenedora @ref{3b25,,Binary} descrita a continuación.

@code{Server} se conserva como un alias para @ref{ae8,,ServerProxy} para compatibilidad con versiones anteriores. El nuevo código debe usar @ref{ae8,,ServerProxy}.


Distinto en la versión 3.5: Se agregó el argumento `context'.



Distinto en la versión 3.6: Se agregó soporte para etiquetas de tipo con prefijos (por ejemplo. @code{ex:nil}). Se agregó soporte para desagrupar los tipos adicionales utilizados por la implementación Apache XML-RPC para números: @code{i1}, @code{i2}, @code{i8}, @code{biginteger}, @code{float} y @code{bigdecimal}. Consulte @indicateurl{http://ws.apache.org/xmlrpc/types.html} para obtener una descripción.




@subsubheading Ver también



@table @asis

@item XML-RPC HOWTO@footnote{https://tldp.org/HOWTO/XML-RPC-HOWTO/index.html}

Una buena descripción del funcionamiento de XML-RPC y del software cliente en varios idiomas. Contiene prácticamente todo lo que un desarrollador de cliente XML-RPC necesita saber.

@item XML-RPC Introspection@footnote{https://xmlrpc-c.sourceforge.io/introspection.html}

Describe la extensión del protocolo XML-RPC para la introspección.

@item XML-RPC Specification@footnote{http://xmlrpc.scripting.com/spec.html}

La especificación oficial.
@end table


@menu
* Objetos ServerProxy:: 
* Objetos DateTime:: 
* Objetos binarios:: 
* Objetos Faults:: 
* Objetos ProtocolError:: 
* Objetos MultiCall:: 
* Funciones de Conveniencia:: 
* Ejemplo de uso de cliente:: 
* Ejemplo de uso de cliente y servidor:: 

@end menu

@node Objetos ServerProxy,Objetos DateTime,,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client id1}@anchor{3b28}@anchor{library/xmlrpc client serverproxy-objects}@anchor{3b29}
@subsubsection Objetos `ServerProxy'


La instancia de @ref{ae8,,ServerProxy} tiene un método correspondiente a cada llamada de procedimiento remoto aceptada por el servidor XML-RPC. Llamar al método realiza un RPC, enviado por nombre y firma de argumento (por ejemplo, el mismo nombre de método puede sobrecargarse con múltiples firmas de argumento). El RPC finaliza retornando un valor, que puede ser datos retornados en un tipo conforme o un objeto @ref{3b26,,Fault} o @ref{3b27,,ProtocolError} que indica un error.

Los servidores que admiten la API de introspección XML admiten algunos métodos comunes agrupados bajo el atributo reservado @code{system}:

@geindex listMethods() (método de xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system listMethods}@anchor{3b2a}
@deffn {Método} ServerProxy.system.listMethods ()

Este método retorna una lista de cadenas, una para cada método (que no es del sistema) admitido por el servidor XML-RPC.
@end deffn

@geindex methodSignature() (método de xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodSignature}@anchor{3b2b}
@deffn {Método} ServerProxy.system.methodSignature (name)

Este método toma un parámetro, el nombre de un método implementado por el servidor XML-RPC. Retorna una matriz de posibles firmas para este método. Una firma es una variedad de tipos. El primero de estos tipos es el tipo de retorno del método, el resto son parámetros.

Debido a que se permiten múltiples firmas (es decir, sobrecarga), este método retorna una lista de firmas en lugar de un singleton.

Las propias firmas están restringidas a los parámetros de nivel superior esperados por un método. Por ejemplo, si un método espera una matriz de estructuras como parámetro y retorna una cadena de caracteres, su firma es simplemente «cadena, matriz». Si espera tres enteros y retorna una cadena, su firma es «string, int, int, int».

Si no se define una firma para el método, se retorna un valor que no es una matriz. En Python, esto significa que el tipo de valor retornado será diferente a una lista.
@end deffn

@geindex methodHelp() (método de xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodHelp}@anchor{3b2c}
@deffn {Método} ServerProxy.system.methodHelp (name)

Este método toma un parámetro, el nombre de un método implementado por el servidor XML-RPC. Retorna una cadena de caracteres de documentación que describe el uso de ese método. Si no hay tal cadena de caracteres disponible, se retorna una cadena de caracteres vacía. La cadena de caracteres de documentación puede contener marcado HTML.
@end deffn


Distinto en la versión 3.5: Las instancias de @ref{ae8,,ServerProxy} admiten el protocolo @ref{675,,context manager} para cerrar el transporte subyacente.


A continuación se muestra un ejemplo práctico. El código del servidor:

@example
from xmlrpc.server import SimpleXMLRPCServer

def is_even(n):
    return n % 2 == 0

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(is_even, "is_even")
server.serve_forever()
@end example

El código de cliente para el servidor anterior:

@example
import xmlrpc.client

with xmlrpc.client.ServerProxy("http://localhost:8000/") as proxy:
    print("3 is even: %s" % str(proxy.is_even(3)))
    print("100 is even: %s" % str(proxy.is_even(100)))
@end example

@node Objetos DateTime,Objetos binarios,Objetos ServerProxy,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client datetime-objects}@anchor{3b2d}@anchor{library/xmlrpc client id2}@anchor{3b2e}
@subsubsection Objetos `DateTime'


@geindex DateTime (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client DateTime}@anchor{1423}
@deffn {Clase} xmlrpc.client.DateTime

Esta clase puede inicializarse con segundos desde la época, una tupla de tiempo, una cadena de fecha/hora ISO 8601 o una instancia @ref{32f,,datetime.datetime}. Tiene los siguientes métodos, soportados principalmente para uso interno por el código de clasificación/eliminación de clasificación:

@geindex decode() (método de xmlrpc.client.DateTime)
@anchor{library/xmlrpc client xmlrpc client DateTime decode}@anchor{3b2f}
@deffn {Método} decode (string)

Acepta una cadena de caracteres como el nuevo valor de tiempo de la instancia.
@end deffn

@geindex encode() (método de xmlrpc.client.DateTime)
@anchor{library/xmlrpc client xmlrpc client DateTime encode}@anchor{3b30}
@deffn {Método} encode (out)

Escribe la codificación XML-RPC de este elemento @ref{1423,,DateTime} en el objeto de flujo `out'.
@end deffn

It also supports certain of Python’s built-in operators through
@ref{1372,,rich comparison} and @ref{6bd,,__repr__()}
methods.
@end deffn

A continuación se muestra un ejemplo práctico. El código del servidor:

@example
import datetime
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def today():
    today = datetime.datetime.today()
    return xmlrpc.client.DateTime(today)

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(today, "today")
server.serve_forever()
@end example

El código de cliente para el servidor anterior:

@example
import xmlrpc.client
import datetime

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")

today = proxy.today()
# convert the ISO8601 string to a datetime object
converted = datetime.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S")
print("Today: %s" % converted.strftime("%d.%m.%Y, %H:%M"))
@end example

@node Objetos binarios,Objetos Faults,Objetos DateTime,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client binary-objects}@anchor{3b31}@anchor{library/xmlrpc client id3}@anchor{3b32}
@subsubsection Objetos binarios


@geindex Binary (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client Binary}@anchor{3b25}
@deffn {Clase} xmlrpc.client.Binary

Esta clase puede inicializarse a partir de datos de bytes (que pueden incluir NUL). El acceso principal al contenido de un objeto @ref{3b25,,Binary} lo proporciona un atributo:

@geindex data (atributo de xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary data}@anchor{3b33}
@deffn {Atributo} data

Los datos binarios encapsulados por la instancia @ref{3b25,,Binary}. Los datos se proporcionan como un objeto @ref{325,,bytes}.
@end deffn

Los objetos @ref{3b25,,Binary} tienen los siguientes métodos, soportados principalmente para uso interno por el código de clasificación/desagrupación:

@geindex decode() (método de xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary decode}@anchor{3b34}
@deffn {Método} decode (bytes)

Acepta un objeto base64 @ref{325,,bytes} y se descodifica como los nuevos datos de la instancia.
@end deffn

@geindex encode() (método de xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary encode}@anchor{3b35}
@deffn {Método} encode (out)

Escribe la codificación XML-RPC base 64 de este elemento binario en el objeto de flujo `out'.

Los datos codificados tendrán líneas nuevas cada 76 caracteres según RFC 2045 sección 6.8 
@geindex RFC; RFC 2045 Section 6.8
RFC 2045 Section 6.8@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html#section-6.8}, que era la especificación estándar de facto base64 cuando se escribió la especificación XML-RPC.
@end deffn

It also supports certain of Python’s built-in operators through
@ref{b85,,__eq__()} and @ref{1558,,__ne__()} methods.
@end deffn

Ejemplo de uso de los objetos binarios. Vamos a transferir una imagen sobre XMLRPC:

@example
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def python_logo():
    with open("python_logo.jpg", "rb") as handle:
        return xmlrpc.client.Binary(handle.read())

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(python_logo, 'python_logo')

server.serve_forever()
@end example

El cliente obtiene la imagen y la guarda en un archivo:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
with open("fetched_python_logo.jpg", "wb") as handle:
    handle.write(proxy.python_logo().data)
@end example

@node Objetos Faults,Objetos ProtocolError,Objetos binarios,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client fault-objects}@anchor{3b36}@anchor{library/xmlrpc client id4}@anchor{3b37}
@subsubsection Objetos Faults


@geindex Fault (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client Fault}@anchor{3b26}
@deffn {Clase} xmlrpc.client.Fault

Un objeto @ref{3b26,,Fault} encapsula el contenido de una etiqueta de error XML-RPC. Los objetos de error tienen los siguientes atributos:

@geindex faultCode (atributo de xmlrpc.client.Fault)
@anchor{library/xmlrpc client xmlrpc client Fault faultCode}@anchor{3b38}
@deffn {Atributo} faultCode

Un entero que indica el tipo de falla.
@end deffn

@geindex faultString (atributo de xmlrpc.client.Fault)
@anchor{library/xmlrpc client xmlrpc client Fault faultString}@anchor{3b39}
@deffn {Atributo} faultString

Una cadena de caracteres que contiene un mensaje de diagnóstico asociado con el fallo.
@end deffn
@end deffn

En el siguiente ejemplo vamos a causar intencionalmente un @ref{3b26,,Fault} al retornar un objeto de tipo complejo. El código del servidor:

@example
from xmlrpc.server import SimpleXMLRPCServer

# A marshalling error is going to occur because we're returning a
# complex number
def add(x, y):
    return x+y+0j

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(add, 'add')

server.serve_forever()
@end example

El código de cliente para el servidor anterior:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
try:
    proxy.add(2, 5)
except xmlrpc.client.Fault as err:
    print("A fault occurred")
    print("Fault code: %d" % err.faultCode)
    print("Fault string: %s" % err.faultString)
@end example

@node Objetos ProtocolError,Objetos MultiCall,Objetos Faults,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client protocol-error-objects}@anchor{3b3a}@anchor{library/xmlrpc client protocolerror-objects}@anchor{3b3b}
@subsubsection Objetos ProtocolError


@geindex ProtocolError (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client ProtocolError}@anchor{3b27}
@deffn {Clase} xmlrpc.client.ProtocolError

El objeto @ref{3b27,,ProtocolError} describe un error de protocolo en la capa de transporte subyacente (como un error 404 “no encontrado” si el servidor nombrado por el URI no existe). Tiene los siguientes atributos:

@geindex url (atributo de xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError url}@anchor{3b3c}
@deffn {Atributo} url

El URI o URL que provocó el error.
@end deffn

@geindex errcode (atributo de xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError errcode}@anchor{3b3d}
@deffn {Atributo} errcode

El código de error.
@end deffn

@geindex errmsg (atributo de xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError errmsg}@anchor{3b3e}
@deffn {Atributo} errmsg

El mensaje de error o la cadena de caracteres de diagnóstico.
@end deffn

@geindex headers (atributo de xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError headers}@anchor{3b3f}
@deffn {Atributo} headers

Un diccionario que contiene los encabezados de la solicitud HTTP/HTTPS que desencadenó el error.
@end deffn
@end deffn

En el siguiente ejemplo, vamos a causar intencionalmente un @ref{3b27,,ProtocolError} proporcionando un URI inválido:

@example
import xmlrpc.client

# create a ServerProxy with a URI that doesn't respond to XMLRPC requests
proxy = xmlrpc.client.ServerProxy("http://google.com/")

try:
    proxy.some_method()
except xmlrpc.client.ProtocolError as err:
    print("A protocol error occurred")
    print("URL: %s" % err.url)
    print("HTTP/HTTPS headers: %s" % err.headers)
    print("Error code: %d" % err.errcode)
    print("Error message: %s" % err.errmsg)
@end example

@node Objetos MultiCall,Funciones de Conveniencia,Objetos ProtocolError,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client multicall-objects}@anchor{3b40}
@subsubsection Objetos MultiCall


El objeto @ref{3b41,,MultiCall} proporciona una forma de encapsular múltiples llamadas a un servidor remoto en una sola solicitud @footnote{
Este enfoque se presentó por primera vez en @uref{https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic,una discusión en xmlrpc.com}.
}.

@geindex MultiCall (clase en xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client MultiCall}@anchor{3b41}
@deffn {Clase} xmlrpc.client.MultiCall (server)

Crea un objeto usado para llamadas al método boxcar. `server' es el objetivo final de la llamada. Se pueden realizar llamadas al objeto de resultado, pero retornarán inmediatamente @code{None} y solo almacenarán el nombre y los parámetros de la llamada en el objeto @ref{3b41,,MultiCall}. Llamar al objeto en sí hace que todas las llamadas almacenadas se transmitan como una única solicitud de @code{system.multicall}. El resultado de esta llamada es un @ref{10dd,,generator}; iterar sobre este generador produce los resultados individuales.
@end deffn

A continuación se muestra un ejemplo de uso de esta clase. El código del servidor:

@example
from xmlrpc.server import SimpleXMLRPCServer

def add(x, y):
    return x + y

def subtract(x, y):
    return x - y

def multiply(x, y):
    return x * y

def divide(x, y):
    return x // y

# A simple server with simple arithmetic functions
server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_multicall_functions()
server.register_function(add, 'add')
server.register_function(subtract, 'subtract')
server.register_function(multiply, 'multiply')
server.register_function(divide, 'divide')
server.serve_forever()
@end example

El código de cliente para el servidor anterior:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
multicall = xmlrpc.client.MultiCall(proxy)
multicall.add(7, 3)
multicall.subtract(7, 3)
multicall.multiply(7, 3)
multicall.divide(7, 3)
result = multicall()

print("7+3=%d, 7-3=%d, 7*3=%d, 7//3=%d" % tuple(result))
@end example

@node Funciones de Conveniencia,Ejemplo de uso de cliente,Objetos MultiCall,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client convenience-functions}@anchor{3b42}
@subsubsection Funciones de Conveniencia


@geindex dumps() (en el módulo xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client dumps}@anchor{3b43}
@deffn {Función} xmlrpc.client.dumps (params, methodname=None, methodresponse=None, encoding=None, allow_none=False)

Convierta `params' en una solicitud XML-RPC. o en una respuesta si `methodresponse' es verdadero. `params' puede ser una tupla de argumentos o una instancia de la clase de excepción @ref{3b26,,Fault}. Si `methodresponse' es verdadero, solo se puede devolver un único valor, lo que significa que `params' debe tener una longitud de 1. `encoding', si se proporciona, es la codificación que se utilizará en el XML generado; el predeterminado es UTF-8. El valor de Python @ref{716,,None} no se puede usar en XML-RPC estándar; para permitir su uso a través de una extensión, proporcione un valor verdadero para `allow_none'.
@end deffn

@geindex loads() (en el módulo xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client loads}@anchor{1474}
@deffn {Función} xmlrpc.client.loads (data, use_datetime=False, use_builtin_types=False)

Convierte una solicitud o respuesta XML-RPC en objetos Python, un @code{(params, methodname)}.  `params' es una tupla de argumento;  `methodname' es una cadena de caracteres, o @code{None} si no hay ningún nombre de método presente en el paquete. Si el paquete XML-RPC representa una condición de falla, esta función lanzará una excepción @ref{3b26,,Fault}. La opción `use_builtin_types' puede usarse para hacer que los valores de fecha/hora se presenten como objetos de  @ref{32f,,datetime.datetime} y datos binarios que se presenten como objetos de @ref{325,,bytes}; esta opción es falsa por defecto.

La opción obsoleta `use_datetime' es similar a `use_builtin_types' pero esto aplica solo a valores fecha/hora.


Distinto en la versión 3.3: La opción `use_builtin_types' fue añadida.

@end deffn

@node Ejemplo de uso de cliente,Ejemplo de uso de cliente y servidor,Funciones de Conveniencia,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client example-of-client-usage}@anchor{3b44}@anchor{library/xmlrpc client xmlrpc-client-example}@anchor{3b45}
@subsubsection Ejemplo de uso de cliente


@example
# simple test program (from the XML-RPC specification)
from xmlrpc.client import ServerProxy, Error

# server = ServerProxy("http://localhost:8000") # local server
with ServerProxy("http://betty.userland.com") as proxy:

    print(proxy)

    try:
        print(proxy.examples.getStateName(41))
    except Error as v:
        print("ERROR", v)
@end example

Para acceder a un servidor XML-RPC a través de un proxy HTTP, debe definir un transporte personalizado. El siguiente ejemplo muestra cómo:

@example
import http.client
import xmlrpc.client

class ProxiedTransport(xmlrpc.client.Transport):

    def set_proxy(self, host, port=None, headers=None):
        self.proxy = host, port
        self.proxy_headers = headers

    def make_connection(self, host):
        connection = http.client.HTTPConnection(*self.proxy)
        connection.set_tunnel(host, headers=self.proxy_headers)
        self._connection = host, connection
        return connection

transport = ProxiedTransport()
transport.set_proxy('proxy-server', 8080)
server = xmlrpc.client.ServerProxy('http://betty.userland.com', transport=transport)
print(server.examples.getStateName(41))
@end example

@node Ejemplo de uso de cliente y servidor,,Ejemplo de uso de cliente,xmlrpc client — XML-RPC client access
@anchor{library/xmlrpc client example-of-client-and-server-usage}@anchor{3b46}
@subsubsection Ejemplo de uso de cliente y servidor


Vea @ref{3b47,,Ejemplo de SimpleXMLRPCServer}.

@subsubheading Notas al pie


@c the link now points to webarchive since the one at

@c http://www.xmlrpc.com/discuss/msgReader%241208 is broken (and webadmin

@c doesn't reply)

@node xmlrpc server — Basic XML-RPC servers,ipaddress — IPv4/IPv6 manipulation library,xmlrpc client — XML-RPC client access,Protocolos y soporte de Internet
@anchor{library/xmlrpc server doc}@anchor{3b48}@anchor{library/xmlrpc server module-xmlrpc server}@anchor{12e}@anchor{library/xmlrpc server xmlrpc-server-basic-xml-rpc-servers}@anchor{3b49}
@subsection @code{xmlrpc.server} — Basic XML-RPC servers


@geindex module; xmlrpc.server

`Código fuente:' Lib/xmlrpc/server.py@footnote{https://github.com/python/cpython/tree/main/Lib/xmlrpc/server.py}


__________________________________________________________________


El módulo @ref{12e,,xmlrpc.server} proporciona un marco de servidor básico para servidores XML-RPC escritos en Python. Los servidores pueden ser independientes, utilizando @ref{3b4a,,SimpleXMLRPCServer}, o integrados en un entorno CGI, utilizando @ref{3b4b,,CGIXMLRPCRequestHandler}.

@cartouche
@quotation Advertencia 
El módulo @ref{12e,,xmlrpc.server} no es seguro contra datos construidos maliciosamente. Si necesita analizar sintácticamente datos no confiables o no autentificados, consulte @ref{36a2,,Vulnerabilidades XML}.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@geindex SimpleXMLRPCServer (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer}@anchor{3b4a}
@deffn {Clase} xmlrpc.server.SimpleXMLRPCServer (addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

Crea una nueva instancia de servidor. Esta clase proporciona métodos para el registro de funciones que pueden ser llamados por el protocolo XML-RPC. El parámetro `requestHandler' debe ser un generador para las instancias del controlador de solicitudes; el valor predeterminado es @ref{138f,,SimpleXMLRPCRequestHandler}. Los parámetros `addr' y `requestHandler' se pasan al constructor @code{socketserver. TCPServer}. Si `logRequests' es verdadero (valor predeterminado), se registrarán las solicitudes; establecer este parámetro como falso desactivará el registro. Los parámetros `allow_none' y `encoding' se pasan a @ref{12d,,xmlrpc.client} y controlan las respuestas XML-RPC que se devolverán desde el servidor. El parámetro `bind_and_activate' controla si @code{server_bind()} y @code{server_activate()} son llamados inmediatamente por el constructor; por defecto es verdadero. Establecerlo como false permite que el código manipule la variable de clase `allow_reuse_address' antes de enlazar la dirección. El parámetro `use_builtin_types' se pasa a la función @ref{1474,,loads()} y controla qué tipos se procesan cuando se reciben valores de fecha y hora o datos binarios; el valor predeterminado es false.


Distinto en la versión 3.3: Se ha añadido el indicador `use_builtin_types'.

@end deffn

@geindex CGIXMLRPCRequestHandler (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler}@anchor{3b4b}
@deffn {Clase} xmlrpc.server.CGIXMLRPCRequestHandler (allow_none=False, encoding=None, use_builtin_types=False)

Crea una nueva instancia para gestionar solicitudes XML-RPC en un entorno CGI.  Los parámetros `allow_none' y `encoding' se pasan a @ref{12d,,xmlrpc.client} y controlan las respuestas XML-RPC que se devolverán desde el servidor. El parámetro `use_builtin_types' se pasa a la función @ref{1474,,loads()} y controla qué tipos se procesan cuando se reciben valores de fecha y hora o datos binarios; el valor predeterminado es falso.


Distinto en la versión 3.3: Se ha añadido el indicador `use_builtin_types'.

@end deffn

@geindex SimpleXMLRPCRequestHandler (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler}@anchor{138f}
@deffn {Clase} xmlrpc.server.SimpleXMLRPCRequestHandler

Crea una nueva instancia del controlador de solicitudes.  Este controlador de solicitudes admite solicitudes @code{POST} y modifica el registro para que se respete el parámetro `logRequests' del parámetro constructor @ref{3b4a,,SimpleXMLRPCServer}.
@end deffn

@menu
* Objetos SimpleXMLRPCServer:: 
* CGIXMLRPCRequestHandler:: 
* Documentando el servidor XMLRPC:: 
* Objetos DocXMLRPCServer:: 
* DocCGIXMLRPCRequestHandler:: 

@end menu

@node Objetos SimpleXMLRPCServer,CGIXMLRPCRequestHandler,,xmlrpc server — Basic XML-RPC servers
@anchor{library/xmlrpc server simple-xmlrpc-servers}@anchor{3b4c}@anchor{library/xmlrpc server simplexmlrpcserver-objects}@anchor{3b4d}
@subsubsection Objetos SimpleXMLRPCServer


La clase @ref{3b4a,,SimpleXMLRPCServer} se basa en @ref{1387,,socketserver.TCPServer} y proporciona un medio para crear servidores XML-RPC simples e independientes.

@geindex register_function() (método de xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_function}@anchor{3b4e}
@deffn {Método} SimpleXMLRPCServer.register_function (function=None, name=None)

Register a function that can respond to XML-RPC requests.  If `name' is given,
it will be the method name associated with `function', otherwise
@ref{133c,,function.__name__} will be used.  `name' is a string, and may contain
characters not legal in Python identifiers, including the period character.

This method can also be used as a decorator.  When used as a decorator,
`name' can only be given as a keyword argument to register `function' under
`name'.  If no `name' is given, @ref{133c,,function.__name__} will be used.


Distinto en la versión 3.7: @ref{3b4e,,register_function()} puede ser usado como decorador.

@end deffn

@geindex register_instance() (método de xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_instance}@anchor{3b4f}
@deffn {Método} SimpleXMLRPCServer.register_instance (instance, allow_dotted_names=False)

Registre un objeto que se usa para exponer nombre de métodos que no se han registrado usando @ref{3b4e,,register_function()}. Si `instance' contiene un método @code{_dispatch()}, este será llamado con el nombre del método solicitado y los parámetros de la solicitud. Su API es @code{def _dispatch(self, method, params)} (tenga en cuenta que `params' no representa una lista de argumentos variables). Si se invoca a una función subyacente para realizar su tarea, esa función es llamada como @code{func(*params)}, expandiendo la lista de parámetros. El valor de retorno de @code{_dispatch()} se retorna al cliente como resultado. Si `instance' no tiene un método @code{_dispatch()}, se busca un atributo que coincida con el nombre del método solicitado.

Si el argumento opcional `allow_dotted_names' es verdadero y la instancia no tiene un método @code{_dispatch()}, entonces si el nombre solicitado contiene puntos, cada componente del nombre del método se busca individualmente, con el efecto con el efecto que produce una búsqueda jerárquica simple. El valor encontrado en esta búsqueda es entonces llamado con los parámetros de la solicitud y el valor de retorno se devuelve al cliente.

@cartouche
@quotation Advertencia 
Habilitando la opción `allow_dotted_names' permite a los intrusos acceder a las variables globales de su módulo y puede permitir que los intrusos ejecuten código arbitrario en su máquina. Utilice esta opción únicamente en una red cerrada y segura.
@end quotation
@end cartouche
@end deffn

@geindex register_introspection_functions() (método de xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_introspection_functions}@anchor{3b50}
@deffn {Método} SimpleXMLRPCServer.register_introspection_functions ()

Registre las funciones de introspección XML-RPC @code{system.listMethods}, @code{system.methodHelp} y @code{system.methodSignature}.
@end deffn

@geindex register_multicall_functions() (método de xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_multicall_functions}@anchor{3b51}
@deffn {Método} SimpleXMLRPCServer.register_multicall_functions ()

Registre la función de llamada múltiple XML-RPC system.multicall.
@end deffn

@geindex rpc_paths (atributo de xmlrpc.server.SimpleXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler rpc_paths}@anchor{3b52}
@deffn {Atributo} SimpleXMLRPCRequestHandler.rpc_paths

Un valor de atributo que debe ser una tupla que enumere porciones de rota válidas de la URL para recibir solicitudes XML-RPC. Las solicitudes publicadas en otras rutas darán como resultado un error HTTP 404 «no existe tal página». Si esta tupla está vacía, todas las rutas se considerarán válidas. El valor predeterminado es @code{('/', '/RPC2')}.
@end deffn

@menu
* Ejemplo de SimpleXMLRPCServer:: 

@end menu

@node Ejemplo de SimpleXMLRPCServer,,,Objetos SimpleXMLRPCServer
@anchor{library/xmlrpc server id1}@anchor{3b53}@anchor{library/xmlrpc server simplexmlrpcserver-example}@anchor{3b47}
@subsubsection Ejemplo de SimpleXMLRPCServer


Código del servidor:

@example
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# Restrict to a particular path.
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# Create server
with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name
    def adder_function(x, y):
        return x + y
    server.register_function(adder_function, 'add')

    # Register an instance; all the methods of the instance are
    # published as XML-RPC methods (in this case, just 'mul').
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # Run the server's main loop
    server.serve_forever()
@end example

El siguiente código de cliente llamará a los métodos disponibles por el servidor anterior:

@example
import xmlrpc.client

s = xmlrpc.client.ServerProxy('http://localhost:8000')
print(s.pow(2,3))  # Returns 2**3 = 8
print(s.add(2,3))  # Returns 5
print(s.mul(5,2))  # Returns 5*2 = 10

# Print list of available methods
print(s.system.listMethods())
@end example

@code{register_function()} también se puede utilizar como decorador. El ejemplo de servidor anterior puede registrar funciones a modo de decorador:

@example
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name, using
    # register_function as a decorator. *name* can only be given
    # as a keyword argument.
    @@server.register_function(name='add')
    def adder_function(x, y):
        return x + y

    # Register a function under function.__name__.
    @@server.register_function
    def mul(x, y):
        return x * y

    server.serve_forever()
@end example

El siguiente ejemplo incluido en el módulo @code{Lib/xmlrpc/server.py} muestra un servidor que permite nombres con puntos y registra una función de llamada múltiple.

@cartouche
@quotation Advertencia 
Habilitar la opción `allow_dotted_names' permite a los intrusos acceder a las variables globales de su módulo y puede permitir que los intrusos ejecuten código arbitrario en su máquina. Utilice este ejemplo únicamente dentro de una red cerrada y segura.
@end quotation
@end cartouche

@example
import datetime

class ExampleService:
    def getData(self):
        return '42'

    class currentTime:
        @@staticmethod
        def getCurrentTime():
            return datetime.datetime.now()

with SimpleXMLRPCServer(("localhost", 8000)) as server:
    server.register_function(pow)
    server.register_function(lambda x,y: x+y, 'add')
    server.register_instance(ExampleService(), allow_dotted_names=True)
    server.register_multicall_functions()
    print('Serving XML-RPC on localhost port 8000')
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print("\nKeyboard interrupt received, exiting.")
        sys.exit(0)
@end example

Esta demostración de ExampleService se puede invocar desde la línea de comando:

@example
python -m xmlrpc.server
@end example

El cliente que interactúa con el servidor anterior está incluido en @cite{Lib/xmlrpc/client.py}:

@example
server = ServerProxy("http://localhost:8000")

try:
    print(server.currentTime.getCurrentTime())
except Error as v:
    print("ERROR", v)

multi = MultiCall(server)
multi.getData()
multi.pow(2,9)
multi.add(1,2)
try:
    for response in multi():
        print(response)
except Error as v:
    print("ERROR", v)
@end example

Este cliente que interactúa con el servidor XMLRPC de demostración se puede invocar como:

@example
python -m xmlrpc.client
@end example

@node CGIXMLRPCRequestHandler,Documentando el servidor XMLRPC,Objetos SimpleXMLRPCServer,xmlrpc server — Basic XML-RPC servers
@anchor{library/xmlrpc server cgixmlrpcrequesthandler}@anchor{3b54}
@subsubsection CGIXMLRPCRequestHandler


La clase @ref{3b4b,,CGIXMLRPCRequestHandler} se puede usar para manejar solicitudes XML-RPC enviadas a scripts Python CGI.

@geindex register_function() (método de xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_function}@anchor{3b55}
@deffn {Método} CGIXMLRPCRequestHandler.register_function (function=None, name=None)

Register a function that can respond to XML-RPC requests.  If `name' is given,
it will be the method name associated with `function', otherwise
@ref{133c,,function.__name__} will be used.  `name' is a string, and may contain
characters not legal in Python identifiers, including the period character.

This method can also be used as a decorator.  When used as a decorator,
`name' can only be given as a keyword argument to register `function' under
`name'.  If no `name' is given, @ref{133c,,function.__name__} will be used.


Distinto en la versión 3.7: @ref{3b55,,register_function()} puede ser usado como decorador.

@end deffn

@geindex register_instance() (método de xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_instance}@anchor{3b56}
@deffn {Método} CGIXMLRPCRequestHandler.register_instance (instance)

Registra un objeto que se usa para exponer nombres de métodos que no se han registrado usando @ref{3b55,,register_function()}. Si la instancia contiene un método @code{_dispatch()}, se llama con el nombre del método solicitado y los parámetros de la solicitud; el valor de retorno se devuelve al cliente como resultado. Si la instancia no tiene un método @code{_dispatch()}, se busca un atributo que coincida con el nombre del método solicitado; si el nombre del método contiene puntos, cada componente del nombre del método se busca individualmente, con el efecto con el efecto que produce una búsqueda jerárquica simple. El valor encontrado en esta búsqueda es entonces llamado con los parámetros de la solicitud y el valor de retorno se devuelve al cliente.
@end deffn

@geindex register_introspection_functions() (método de xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_introspection_functions}@anchor{3b57}
@deffn {Método} CGIXMLRPCRequestHandler.register_introspection_functions ()

Registra las funciones de introspección @code{system.listMethods}, @code{system.methodHelp} y @code{system.methodSignature}.
@end deffn

@geindex register_multicall_functions() (método de xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_multicall_functions}@anchor{3b58}
@deffn {Método} CGIXMLRPCRequestHandler.register_multicall_functions ()

Registra la función de llamada múltiple XML-RPC @code{system.multicall}.
@end deffn

@geindex handle_request() (método de xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler handle_request}@anchor{3b59}
@deffn {Método} CGIXMLRPCRequestHandler.handle_request (request_text=None)

Maneja una solicitud XML-RPC. Si se proporciona `request_text', deberían ser los datos POST proporcionados por el servidor HTTP, de lo contrario se utilizará el contenido de stdin.
@end deffn

Ejemplo:

@example
class MyFuncs:
    def mul(self, x, y):
        return x * y


handler = CGIXMLRPCRequestHandler()
handler.register_function(pow)
handler.register_function(lambda x,y: x+y, 'add')
handler.register_introspection_functions()
handler.register_instance(MyFuncs())
handler.handle_request()
@end example

@node Documentando el servidor XMLRPC,Objetos DocXMLRPCServer,CGIXMLRPCRequestHandler,xmlrpc server — Basic XML-RPC servers
@anchor{library/xmlrpc server documenting-xmlrpc-server}@anchor{3b5a}
@subsubsection Documentando el servidor XMLRPC


Estas clases amplían las clases anteriores para proporcionar documentación HTML en respuesta a solicitudes HTTP GET. Los servidores pueden ser independientes, usando @ref{19c7,,DocXMLRPCServer}, o integrados en un entorno CGI, usando @ref{3b5b,,DocCGIXMLRPCRequestHandler}.

@geindex DocXMLRPCServer (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer}@anchor{19c7}
@deffn {Clase} xmlrpc.server.DocXMLRPCServer (addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

Crea una nueva instancia de servidor. Todos los parámetros tienen el mismo significado que para @ref{3b4a,,SimpleXMLRPCServer}; `requestHandler' tiene como valor predeterminado @ref{3b5c,,DocXMLRPCRequestHandler}.


Distinto en la versión 3.3: Se ha añadido el indicador `use_builtin_types'.

@end deffn

@geindex DocCGIXMLRPCRequestHandler (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler}@anchor{3b5b}
@deffn {Clase} xmlrpc.server.DocCGIXMLRPCRequestHandler

Crea una nueva instancia para manejar solicitudes XML-RPC en un entorno CGI.
@end deffn

@geindex DocXMLRPCRequestHandler (clase en xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCRequestHandler}@anchor{3b5c}
@deffn {Clase} xmlrpc.server.DocXMLRPCRequestHandler

Crea una nueva instancia de controlador de solicitudes. Este controlador de solicitudes admite solicitudes XML-RPC POST, solicitudes GET de documentación y modifica el registro para que se respete el parámetro `logRequests' del parámetro constructor @ref{19c7,,DocXMLRPCServer}.
@end deffn

@node Objetos DocXMLRPCServer,DocCGIXMLRPCRequestHandler,Documentando el servidor XMLRPC,xmlrpc server — Basic XML-RPC servers
@anchor{library/xmlrpc server doc-xmlrpc-servers}@anchor{3b5d}@anchor{library/xmlrpc server docxmlrpcserver-objects}@anchor{3b5e}
@subsubsection Objetos DocXMLRPCServer


La clase @ref{19c7,,DocXMLRPCServer} se deriva de @ref{3b4a,,SimpleXMLRPCServer} y proporciona un medio para crear servidores XML-RPC autónomos y autodocumentados. Las solicitudes HTTP POST se manejan como llamadas al método XML-RPC. Las solicitudes HTTP GET se manejan generando documentación HTML al estilo pydoc. Esto permite que un servidor proporcione su propia documentación basada en web.

@geindex set_server_title() (método de xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_title}@anchor{3b5f}
@deffn {Método} DocXMLRPCServer.set_server_title (server_title)

Establezca el título utilizado en la documentación HTML generada. Este título se utilizará dentro del elemento HTML «title».
@end deffn

@geindex set_server_name() (método de xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_name}@anchor{3b60}
@deffn {Método} DocXMLRPCServer.set_server_name (server_name)

Establezca el nombre utilizado en la documentación HTML generada. Este nombre aparecerá en la parte superior de la documentación generada dentro de un elemento «h1».
@end deffn

@geindex set_server_documentation() (método de xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_documentation}@anchor{3b61}
@deffn {Método} DocXMLRPCServer.set_server_documentation (server_documentation)

Establezca la descripción utilizada en la documentación HTML generada. Esta descripción aparecerá como un párrafo, debajo del nombre del servidor, en la documentación.
@end deffn

@node DocCGIXMLRPCRequestHandler,,Objetos DocXMLRPCServer,xmlrpc server — Basic XML-RPC servers
@anchor{library/xmlrpc server doccgixmlrpcrequesthandler}@anchor{3b62}
@subsubsection DocCGIXMLRPCRequestHandler


La clase @ref{3b5b,,DocCGIXMLRPCRequestHandler} se deriva de @ref{3b4b,,CGIXMLRPCRequestHandler} y proporciona un medio para crear scripts CGI XML-RPC autodocumentados. Las solicitudes HTTP POST se manejan como llamadas al método XML-RPC. Las solicitudes HTTP GET se manejan generando documentación HTML al estilo pydoc. Esto permite que un servidor proporcione su propia documentación basada en web.

@geindex set_server_title() (método de xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_title}@anchor{3b63}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_title (server_title)

Establezca el título utilizado en la documentación HTML generada. Este título se utilizará dentro del elemento HTML «title».
@end deffn

@geindex set_server_name() (método de xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_name}@anchor{3b64}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_name (server_name)

Establezca el nombre utilizado en la documentación HTML generada. Este nombre aparecerá en la parte superior de la documentación generada dentro de un elemento «h1».
@end deffn

@geindex set_server_documentation() (método de xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_documentation}@anchor{3b65}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_documentation (server_documentation)

Establezca la descripción utilizada en la documentación HTML generada. Esta descripción aparecerá como un párrafo, debajo del nombre del servidor, en la documentación.
@end deffn

@node ipaddress — IPv4/IPv6 manipulation library,,xmlrpc server — Basic XML-RPC servers,Protocolos y soporte de Internet
@anchor{library/ipaddress doc}@anchor{3b66}@anchor{library/ipaddress ipaddress-ipv4-ipv6-manipulation-library}@anchor{3b67}@anchor{library/ipaddress module-ipaddress}@anchor{80}
@subsection @code{ipaddress} — IPv4/IPv6 manipulation library


@geindex module; ipaddress

`Source code:' Lib/ipaddress.py@footnote{https://github.com/python/cpython/tree/main/Lib/ipaddress.py}


__________________________________________________________________


@ref{80,,ipaddress} proporciona las capacidades para crear, manipular y operar en redes y direcciones IPv4 e IPv6.

Las funciones y clases de este módulo facilitan el manejo de varias tareas relacionadas con las direcciones IP, incluida la verificación de si dos hosts están en la misma subred, la iteración sobre todos los hosts de una subred en particular, la verificación de si una cadena representa un valor válido o no. Dirección IP o definición de red, etc.

Esta es la referencia completa de la API del módulo; para obtener una descripción general y una introducción, consulte @ref{3b68,,Introducción al modulo ipaddress}.


Added in version 3.3.


@c import ipaddress
@c from ipaddress import (
@c     ip_network, IPv4Address, IPv4Interface, IPv4Network,
@c )

@menu
* Funciones de fábrica de conveniencia:: 
* Direcciones IP:: 
* Definiciones de red IP:: 
* Objetos de interfaz:: 
* Otras funciones de nivel de módulo:: 
* Excepciones personalizadas:: 

@end menu

@node Funciones de fábrica de conveniencia,Direcciones IP,,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress convenience-factory-functions}@anchor{3b69}
@subsubsection Funciones de fábrica de conveniencia


El módulo @ref{80,,ipaddress} proporciona funciones de fábrica para crear cómodamente direcciones IP, redes e interfaces:

@geindex ip_address() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_address}@anchor{3b6a}
@deffn {Función} ipaddress.ip_address (address)

Retorna un objeto @ref{35a,,IPv4Address} o @ref{35b,,IPv6Address} según la dirección IP pasada como argumento. Se pueden proporcionar direcciones IPv4 o IPv6; los enteros menores que @code{2**32} se considerarán IPv4 de forma predeterminada. Se lanza un @ref{360,,ValueError} si `address' no representa una dirección IPv4 o IPv6 válida.

@example
>>> ipaddress.ip_address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.ip_address('2001:db8::')
IPv6Address('2001:db8::')
@end example
@end deffn

@geindex ip_network() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_network}@anchor{3b6b}
@deffn {Función} ipaddress.ip_network (address, strict=True)

Retorna un objeto @ref{35c,,IPv4Network} o @ref{35d,,IPv6Network} dependiendo de la dirección IP pasada como argumento.  `address' es una cadena o entero que representa la red IP.  Se pueden suministrar redes IPv4 o IPv6; los enteros menores que @code{2**32} se considerarán IPv4 de forma predeterminada. `strict' se pasa a @ref{35c,,IPv4Network} o @ref{35d,,IPv6Network} constructor.  Se genera un @ref{360,,ValueError} si `address' no representa una dirección IPv4 o IPv6 válida, o si la red tiene bits de host establecidos.

@example
>>> ipaddress.ip_network('192.168.0.0/28')
IPv4Network('192.168.0.0/28')
@end example
@end deffn

@geindex ip_interface() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_interface}@anchor{3b6c}
@deffn {Función} ipaddress.ip_interface (address)

Retorna un objeto @ref{1815,,IPv4Interface} o @ref{1816,,IPv6Interface} dependiendo de la dirección IP pasada como argumento.  `address' es una cadena o entero que representa la dirección IP.  Se pueden proporcionar direcciones IPv4 o IPv6; los enteros menores que @code{2**32} se considerarán IPv4 de forma predeterminada.  Se genera un @ref{360,,ValueError} si `address' no representa una dirección IPv4 o IPv6 válida.
@end deffn

Una desventaja de estas funciones de conveniencia es que la necesidad de manejar los formatos IPv4 e IPv6 significa que los mensajes de error brindan información mínima sobre el error exacto, ya que las funciones no saben si se pretendía usar el formato IPv4 o IPv6. Se pueden obtener informes de errores más detallados llamando directamente a los constructores de clases específicos de la versión adecuada.

@node Direcciones IP,Definiciones de red IP,Funciones de fábrica de conveniencia,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress ip-addresses}@anchor{3b6d}
@subsubsection Direcciones IP


@menu
* Objetos de dirección:: 
* Conversión a cadenas y enteros:: 
* Operadores: Operadores<3>. 

@end menu

@node Objetos de dirección,Conversión a cadenas y enteros,,Direcciones IP
@anchor{library/ipaddress address-objects}@anchor{3b6e}
@subsubsection Objetos de dirección


Los objetos @ref{35a,,IPv4Address} y @ref{35b,,IPv6Address} comparten muchos atributos comunes. Algunos atributos que solo son significativos para direcciones IPv6 también son implementados por objetos @ref{35a,,IPv4Address}, a fin de facilitar la escritura de código que maneje ambas versiones de IP correctamente. Los objetos de dirección son @ref{6b1,,hashable}, por lo que se pueden usar como claves en diccionarios.

@geindex IPv4Address (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv4Address}@anchor{35a}
@deffn {Clase} ipaddress.IPv4Address (address)

Construya una dirección IPv4. Se genera un @ref{3b6f,,AddressValueError} si `address' no es una dirección IPv4 válida.

Lo siguiente constituye una dirección IPv4 válida:


@enumerate 

@item 
Una cadena en notación de punto decimal, que consta de cuatro enteros decimales en el rango inclusivo 0-255, separados por puntos (por ejemplo, @code{192.168.0.1}). Cada entero representa un octeto (byte) en la dirección. No se toleran ceros iniciales para evitar confusiones con la notación octal.

@item 
Un número entero que cabe en 32 bits.

@item 
Un entero empaquetado en un objeto @ref{325,,bytes} de longitud 4 (primero el octeto más significativo).
@end enumerate

@example
>>> ipaddress.IPv4Address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.IPv4Address(3232235521)
IPv4Address('192.168.0.1')
>>> ipaddress.IPv4Address(b'\xC0\xA8\x00\x01')
IPv4Address('192.168.0.1')
@end example


Distinto en la versión 3.8: Se toleran los ceros iniciales, incluso en casos ambiguos que parecen notación octal.



Distinto en la versión 3.9.5: Los ceros iniciales ya no se toleran y se tratan como un error. Las cadenas de direcciones IPv4 ahora se analizan tan estrictamente como glibc @ref{9f5,,inet_pton()}.


@geindex version (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address version}@anchor{3b70}
@deffn {Atributo} version

El número de versión apropiado: @code{4} para IPv4, @code{6} para IPv6.


Distinto en la versión 3.14: Made available on the class.

@end deffn

@geindex max_prefixlen (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address max_prefixlen}@anchor{3b71}
@deffn {Atributo} max_prefixlen

El número total de bits en la representación de direcciones para esta versión: @code{32} para IPv4, @code{128} para IPv6.

El prefijo define el número de bits iniciales en una dirección que se comparan para determinar si una dirección es parte de una red o no.


Distinto en la versión 3.14: Made available on the class.

@end deffn

@geindex compressed (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address compressed}@anchor{3b72}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address exploded}@anchor{3b73}
@deffn {Atributo} exploded

Representación de cadena en notación decimal con puntos. Los ceros iniciales nunca se incluyen en la representación.

Como IPv4 no define una notación abreviada para direcciones con octetos establecidos en cero, estos dos atributos son siempre los mismos que @code{str(addr)} para direcciones IPv4. La exposición de estos atributos facilita la escritura de código de visualización que pueda manejar direcciones IPv4 e IPv6.
@end deffn

@geindex packed (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address packed}@anchor{3b74}
@deffn {Atributo} packed

La representación binaria de esta dirección: un objeto @ref{325,,bytes} de la longitud adecuada (primero el octeto más significativo). Son 4 bytes para IPv4 y 16 bytes para IPv6.
@end deffn

@geindex reverse_pointer (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address reverse_pointer}@anchor{3b75}
@deffn {Atributo} reverse_pointer

El nombre del registro PTR de DNS inverso para la dirección IP, por ejemplo:

@example
>>> ipaddress.ip_address("127.0.0.1").reverse_pointer
'1.0.0.127.in-addr.arpa'
>>> ipaddress.ip_address("2001:db8::1").reverse_pointer
'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'
@end example

Este es el nombre que podría usarse para realizar una búsqueda PTR, no el nombre de host resuelto en sí.


Added in version 3.5.

@end deffn

@geindex is_multicast (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_multicast}@anchor{3b76}
@deffn {Atributo} is_multicast

@code{True} si la dirección está reservada para uso de multidifusión. Consulte 
@geindex RFC; RFC 3171
RFC 3171@footnote{https://datatracker.ietf.org/doc/html/rfc3171.html} (para IPv4) o 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_private (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_private}@anchor{1654}
@deffn {Atributo} is_private

@code{True} if the address is defined as not globally reachable by
iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (for IPv4) or iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml}
(for IPv6) with the following exceptions:


@itemize *

@item 
@code{is_private} is @code{False} for the shared address space (@code{100.64.0.0/10})

@item 
For IPv4-mapped IPv6-addresses the @code{is_private} value is determined by the
semantics of the underlying IPv4 addresses and the following condition holds
(see @ref{3b77,,IPv6Address.ipv4_mapped}):

@example
address.is_private == address.ipv4_mapped.is_private
@end example
@end itemize

@code{is_private} has value opposite to @ref{fdf,,is_global}, except for the shared address space
(@code{100.64.0.0/10} range) where they are both @code{False}.


Distinto en la versión 3.13: Fixed some false positives and false negatives.


@itemize *

@item 
@code{192.0.0.0/24} is considered private with the exception of @code{192.0.0.9/32} and
@code{192.0.0.10/32} (previously: only the @code{192.0.0.0/29} sub-range was considered private).

@item 
@code{64:ff9b:1::/48} is considered private.

@item 
@code{2002::/16} is considered private.

@item 
There are exceptions within @code{2001::/23} (otherwise considered private): @code{2001:1::1/128},
@code{2001:1::2/128}, @code{2001:3::/32}, @code{2001:4:112::/48}, @code{2001:20::/28}, @code{2001:30::/28}.
The exceptions are not considered private.
@end itemize

@end deffn

@geindex is_global (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_global}@anchor{fdf}
@deffn {Atributo} is_global

@code{True} if the address is defined as globally reachable by
iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (for IPv4) or iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml}
(for IPv6) with the following exception:

For IPv4-mapped IPv6-addresses the @code{is_private} value is determined by the
semantics of the underlying IPv4 addresses and the following condition holds
(see @ref{3b77,,IPv6Address.ipv4_mapped}):

@example
address.is_global == address.ipv4_mapped.is_global
@end example

@code{is_global} has value opposite to @ref{1654,,is_private}, except for the shared address space
(@code{100.64.0.0/10} range) where they are both @code{False}.


Added in version 3.4.



Distinto en la versión 3.13: Fixed some false positives and false negatives, see @ref{1654,,is_private} for details.

@end deffn

@geindex is_unspecified (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_unspecified}@anchor{3b78}
@deffn {Atributo} is_unspecified

@code{True} si la dirección no está especificada. Consulte 
@geindex RFC; RFC 5735
RFC 5735@footnote{https://datatracker.ietf.org/doc/html/rfc5735.html} (para IPv4) o 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_reserved (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_reserved}@anchor{3b79}
@deffn {Atributo} is_reserved

@code{True} si la dirección está reservada IETF.
@end deffn

@geindex is_loopback (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_loopback}@anchor{3b7a}
@deffn {Atributo} is_loopback

@code{True} si se trata de una dirección de bucle invertido. Consulte 
@geindex RFC; RFC 3330
RFC 3330@footnote{https://datatracker.ietf.org/doc/html/rfc3330.html} (para IPv4) o 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_link_local (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_link_local}@anchor{3b7b}
@deffn {Atributo} is_link_local

@code{True} si se trata de una dirección de bucle invertido. Consulte 
@geindex RFC; RFC 3330
RFC 3330@footnote{https://datatracker.ietf.org/doc/html/rfc3330.html} (para IPv4) o 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6). @code{True} si la dirección está reservada para uso local de enlace. Ver 
@geindex RFC; RFC 3927
RFC 3927@footnote{https://datatracker.ietf.org/doc/html/rfc3927.html}.
@end deffn

@geindex ipv6_mapped (atributo de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address ipv6_mapped}@anchor{359}
@deffn {Atributo} ipv6_mapped

@ref{35a,,IPv4Address} object representing the IPv4-mapped IPv6 address. See 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html}.


Added in version 3.13.

@end deffn
@end deffn

@geindex __format__() (método de ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address __format__}@anchor{3b7c}
@deffn {Método} IPv4Address.__format__ (fmt)

Devuelve una representación de cadena de la dirección IP, controlada por una cadena de formato explícito. `fmt' puede ser uno de los siguientes: @code{'s'}, la opción predeterminada, equivalente a @ref{237,,str()}, @code{'b'} para una cadena binaria con relleno de ceros, @code{'X'} o @code{'x'} para una representación hexadecimal en mayúsculas o minúsculas, o @code{'n'}, que es equivalente a @code{'b'} para direcciones IPv4 y @code{'x'} para IPv6. Para representaciones binarias y hexadecimales, el especificador de formulario @code{'#'} y la opción de agrupación @code{'_'} están disponibles. @code{__format__} es utilizado por @code{format}, @code{str.format} y f-strings.

@example
>>> format(ipaddress.IPv4Address('192.168.0.1'))
'192.168.0.1'
>>> '@{:#b@}'.format(ipaddress.IPv4Address('192.168.0.1'))
'0b11000000101010000000000000000001'
>>> f'@{ipaddress.IPv6Address("2001:db8::1000"):s@}'
'2001:db8::1000'
>>> format(ipaddress.IPv6Address('2001:db8::1000'), '_X')
'2001_0DB8_0000_0000_0000_0000_0000_1000'
>>> '@{:#_n@}'.format(ipaddress.IPv6Address('2001:db8::1000'))
'0x2001_0db8_0000_0000_0000_0000_0000_1000'
@end example


Added in version 3.9.

@end deffn

@geindex IPv6Address (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv6Address}@anchor{35b}
@deffn {Clase} ipaddress.IPv6Address (address)

Construya una dirección IPv6. Se genera un @ref{3b6f,,AddressValueError} si `address' no es una dirección IPv6 válida.

Lo siguiente constituye una dirección IPv6 válida:


@enumerate 

@item 
Una cadena que consta de ocho grupos de cuatro dígitos hexadecimales, cada grupo representa 16 bits. Los grupos están separados por dos puntos. Esto describe una notación `explotada' (a mano). La cadena también se puede `comprimir' (notación abreviada) por varios medios. Consulte 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} para obtener más detalles. Por ejemplo, @code{"0000:0000:0000:0000:0000:0abc:0007:0def"} se puede comprimir en @code{"::abc:7:def"}.

Opcionalmente, la cadena también puede tener un ID de zona de alcance, expresado con un sufijo @code{%scope_id}. Si está presente, el ID de alcance no debe estar vacío y no puede contener @code{%}. Consulte 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html} para obtener más detalles. Por ejemplo, @code{fe80::1234%1} podría identificar la dirección @code{fe80::1234} en el primer enlace del nodo.

@item 
Un número entero que cabe en 128 bits.

@item 
Un entero empaquetado en un objeto @ref{325,,bytes} de longitud 16, big-endian.
@end enumerate

@example
>>> ipaddress.IPv6Address('2001:db8::1000')
IPv6Address('2001:db8::1000')
>>> ipaddress.IPv6Address('ff02::5678%1')
IPv6Address('ff02::5678%1')
@end example

@geindex compressed (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address compressed}@anchor{3b7d}
@deffn {Atributo} compressed
@end deffn

La forma corta de la representación de la dirección, con ceros a la izquierda en los grupos omitidos y la secuencia más larga de grupos que consta completamente de ceros colapsó en un solo grupo vacío.

Este también es el valor devuelto por @code{str(addr)} para las direcciones IPv6.

@geindex exploded (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address exploded}@anchor{3b7e}
@deffn {Atributo} exploded
@end deffn

La forma larga de la representación de la dirección, con todos los ceros a la izquierda y los grupos que constan completamente de ceros incluidos.

Para los siguientes atributos y métodos, consulte la documentación correspondiente de la clase @ref{35a,,IPv4Address}:

@geindex packed (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address packed}@anchor{3b7f}
@deffn {Atributo} packed
@end deffn

@geindex reverse_pointer (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address reverse_pointer}@anchor{15d1}
@deffn {Atributo} reverse_pointer
@end deffn

@geindex version (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address version}@anchor{3b80}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address max_prefixlen}@anchor{3b81}
@deffn {Atributo} max_prefixlen
@end deffn

@geindex is_multicast (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_multicast}@anchor{3b82}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_private}@anchor{1655}
@deffn {Atributo} is_private
@end deffn

@geindex is_global (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_global}@anchor{1656}
@deffn {Atributo} is_global


Added in version 3.4.

@end deffn

@geindex is_unspecified (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_unspecified}@anchor{3b83}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_reserved}@anchor{3b84}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_loopback}@anchor{1640}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_link_local}@anchor{3b85}
@deffn {Atributo} is_link_local
@end deffn

@geindex is_site_local (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_site_local}@anchor{3b86}
@deffn {Atributo} is_site_local

@code{True} si la dirección está reservada para uso local del sitio. Tenga en cuenta que el espacio de direcciones local del sitio ha quedado obsoleto por 
@geindex RFC; RFC 3879
RFC 3879@footnote{https://datatracker.ietf.org/doc/html/rfc3879.html}. Utilice @ref{1654,,is_private} para probar si esta dirección está en el espacio de direcciones locales únicas como se define en 
@geindex RFC; RFC 4193
RFC 4193@footnote{https://datatracker.ietf.org/doc/html/rfc4193.html}.
@end deffn

@geindex ipv4_mapped (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address ipv4_mapped}@anchor{3b77}
@deffn {Atributo} ipv4_mapped

Para las direcciones que parecen ser direcciones IPv4 asignadas (que comienzan con @code{::FFFF/96}), esta propiedad informará la dirección IPv4 incrustada. Para cualquier otra dirección, esta propiedad será @code{None}.
@end deffn

@geindex scope_id (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address scope_id}@anchor{9a4}
@deffn {Atributo} scope_id

Para las direcciones de ámbito definido por 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html}, esta propiedad identifica la zona particular del ámbito de la dirección a la que pertenece la dirección, como una cadena. Cuando no se especifica ninguna zona de alcance, esta propiedad será @code{None}.
@end deffn

@geindex sixtofour (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address sixtofour}@anchor{3b87}
@deffn {Atributo} sixtofour

Para direcciones que parecen ser direcciones 6to4 (comenzando con @code{2002::/16}) según lo definido por 
@geindex RFC; RFC 3056
RFC 3056@footnote{https://datatracker.ietf.org/doc/html/rfc3056.html}, esta propiedad informará la dirección IPv4 incrustada. Para cualquier otra dirección, esta propiedad será @code{None}.
@end deffn

@geindex teredo (atributo de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address teredo}@anchor{3b88}
@deffn {Atributo} teredo

Para las direcciones que parecen ser direcciones Teredo (que comienzan con @code{2001::/32}) según lo definido por 
@geindex RFC; RFC 4380
RFC 4380@footnote{https://datatracker.ietf.org/doc/html/rfc4380.html}, esta propiedad informará el par de direcciones IP @code{(servidor, cliente)} incrustado. Para cualquier otra dirección, esta propiedad será @code{None}.
@end deffn
@end deffn

@geindex __format__() (método de ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address __format__}@anchor{3b89}
@deffn {Método} IPv6Address.__format__ (fmt)

Consulte la documentación del método correspondiente en @ref{35a,,IPv4Address}.


Added in version 3.9.

@end deffn

@node Conversión a cadenas y enteros,Operadores<3>,Objetos de dirección,Direcciones IP
@anchor{library/ipaddress conversion-to-strings-and-integers}@anchor{3b8a}
@subsubsection Conversión a cadenas y enteros


Para interoperar con interfaces de red como el módulo de socket, las direcciones deben convertirse en cadenas o números enteros. Esto se maneja usando las funciones integradas @ref{237,,str()} y @ref{1f0,,int()}

@example
>>> str(ipaddress.IPv4Address('192.168.0.1'))
'192.168.0.1'
>>> int(ipaddress.IPv4Address('192.168.0.1'))
3232235521
>>> str(ipaddress.IPv6Address('::1'))
'::1'
>>> int(ipaddress.IPv6Address('::1'))
1
@end example

Tenga en cuenta que las direcciones de ámbito IPv6 se convierten en números enteros sin ID de zona de ámbito.

@node Operadores<3>,,Conversión a cadenas y enteros,Direcciones IP
@anchor{library/ipaddress operators}@anchor{3b8b}
@subsubsection Operadores


Los objetos de dirección admiten algunos operadores. A menos que se indique lo contrario, los operadores solo se pueden aplicar entre objetos compatibles (es decir, IPv4 con IPv4, IPv6 con IPv6).

@menu
* Operadores de comparación:: 
* Operadores aritméticos:: 

@end menu

@node Operadores de comparación,Operadores aritméticos,,Operadores<3>
@anchor{library/ipaddress comparison-operators}@anchor{3b8c}
@subsubsection Operadores de comparación


Los objetos de dirección se pueden comparar con el conjunto habitual de operadores de comparación. Las mismas direcciones IPv6 con diferentes ID de zona de alcance no son iguales. Algunos ejemplos:

@example
>>> IPv4Address('127.0.0.2') > IPv4Address('127.0.0.1')
True
>>> IPv4Address('127.0.0.2') == IPv4Address('127.0.0.1')
False
>>> IPv4Address('127.0.0.2') != IPv4Address('127.0.0.1')
True
>>> IPv6Address('fe80::1234') == IPv6Address('fe80::1234%1')
False
>>> IPv6Address('fe80::1234%1') != IPv6Address('fe80::1234%2')
True
@end example

@node Operadores aritméticos,,Operadores de comparación,Operadores<3>
@anchor{library/ipaddress arithmetic-operators}@anchor{3b8d}
@subsubsection Operadores aritméticos


Los números enteros se pueden sumar o restar de los objetos de dirección. Algunos ejemplos:

@example
>>> IPv4Address('127.0.0.2') + 3
IPv4Address('127.0.0.5')
>>> IPv4Address('127.0.0.2') - 3
IPv4Address('126.255.255.255')
>>> IPv4Address('255.255.255.255') + 1
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address
@end example

@node Definiciones de red IP,Objetos de interfaz,Direcciones IP,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress ip-network-definitions}@anchor{3b8e}
@subsubsection Definiciones de red IP


Los objetos @ref{35c,,IPv4Network} y @ref{35d,,IPv6Network} proporcionan un mecanismo para definir e inspeccionar las definiciones de red IP. Una definición de red consta de una * máscara * y una * dirección de red * y, como tal, define un rango de direcciones IP que son iguales a la dirección de red cuando están enmascaradas (Y binario) con la máscara. Por ejemplo, una definición de red con la máscara @code{255.255.255.0} y la dirección de red @code{192.168.1.0} consta de direcciones IP en el rango inclusivo de @code{192.168.1.0} a @code{192.168.1.255}.

@menu
* Prefijo@comma{} máscara de red y máscara de host: Prefijo máscara de red y máscara de host. 
* Objetos de red:: 
* Operadores: Operadores<4>. 

@end menu

@node Prefijo máscara de red y máscara de host,Objetos de red,,Definiciones de red IP
@anchor{library/ipaddress prefix-net-mask-and-host-mask}@anchor{3b8f}
@subsubsection Prefijo, máscara de red y máscara de host


Hay varias formas equivalentes de especificar máscaras de red IP. Un `prefix' @code{/<nbits>} es una notación que indica cuántos bits de orden superior se establecen en la máscara de red. Una máscara de red (`mask') es una dirección IP con una cierta cantidad de bits de orden superior establecidos. Por lo tanto, el prefijo @code{/24} es equivalente a la máscara de red @code{255.255.255.0} en IPv4, o @code{ffff:ff00::} en IPv6. Además, una * máscara de host * es el inverso lógico de una * máscara de red * y, a veces, se utiliza (por ejemplo, en las listas de control de acceso de Cisco) para indicar una máscara de red. La máscara de host equivalente a @code{/24} en IPv4 es @code{0.0.0.255}.

@node Objetos de red,Operadores<4>,Prefijo máscara de red y máscara de host,Definiciones de red IP
@anchor{library/ipaddress network-objects}@anchor{3b90}
@subsubsection Objetos de red


Todos los atributos implementados por objetos de dirección también son implementados por objetos de red. Además, los objetos de red implementan atributos adicionales. Todos estos son comunes entre @ref{35c,,IPv4Network} y @ref{35d,,IPv6Network}, por lo que para evitar la duplicación solo se documentan para @ref{35c,,IPv4Network}. Los objetos de red son @ref{6b1,,hashable}, por lo que se pueden usar como claves en diccionarios.

@geindex IPv4Network (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv4Network}@anchor{35c}
@deffn {Clase} ipaddress.IPv4Network (address, strict=True)

Construya una definición de red IPv4. `address' puede ser una de las siguientes:


@enumerate 

@item 
Una cadena que consta de una dirección IP y una máscara opcional, separadas por una barra (@code{/}). La dirección IP es la dirección de red y la máscara puede ser un solo número, lo que significa que es un `prefix', o una representación de cadena de caracteres de una dirección IPv4.  Si es la última, la máscara es interpretada como una `net mask' si comienza con un campo no nulo, o como una `host mask' si comienza con un campo cero, con la excepción de una máscara de solo ceros la cual es tratada como una `net mask'. Si no se proporciona una máscara, se considera @code{/32}.

Por ejemplo, las siguientes especificaciones de `address' son equivalentes: @code{192.168.1.0/24}, @code{192.168.1.0/255.255.255.0} y @code{192.168.1.0/0.0.0.255}.

@item 
Un número entero que cabe en 32 bits. Esto es equivalente a una red de una sola dirección, con la dirección de red `address' y la máscara @code{/32}.

@item 
Un entero empaquetado en un objeto @ref{325,,bytes} de longitud 4, big-endian. La interpretación es similar a una `address' entera.

@item 
A two-tuple of an address description and a netmask, where the address
description is either a string, a 32-bits integer, a 4-bytes packed
integer, or an existing @ref{35a,,IPv4Address} object; and the netmask is either
an integer representing the prefix length (e.g. @code{24}) or a string
representing the prefix mask (e.g. @code{255.255.255.0}).
@end enumerate

Se genera un @ref{3b6f,,AddressValueError} si `address' no es una dirección IPv4 válida. A @ref{3b91,,NetmaskValueError} se genera si la máscara no es válida para una dirección IPv4.

Si `strict' es @code{True} y los bits de host están configurados en la dirección proporcionada, entonces @ref{360,,ValueError} se genera. De lo contrario, los bits del host se enmascaran para determinar la dirección de red adecuada.

A menos que se indique lo contrario, todos los métodos de red que acepten otros objetos de red / dirección generarán @ref{228,,TypeError} si la versión de IP del argumento es incompatible con @code{self}.


Distinto en la versión 3.5: Se agregó la forma de dos tuplas para el parámetro de constructor `address'.


@geindex version (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network version}@anchor{3b92}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network max_prefixlen}@anchor{3b93}
@deffn {Atributo} max_prefixlen

Consulte la documentación del atributo correspondiente en @ref{35a,,IPv4Address}.
@end deffn

@geindex is_multicast (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_multicast}@anchor{3b94}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_private}@anchor{3b95}
@deffn {Atributo} is_private
@end deffn

@geindex is_unspecified (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_unspecified}@anchor{3b96}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_reserved}@anchor{3b97}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_loopback}@anchor{3b98}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_link_local}@anchor{3b99}
@deffn {Atributo} is_link_local

Estos atributos son verdaderos para la red en su conjunto si lo son tanto para la dirección de red como para la dirección de transmisión.
@end deffn

@geindex network_address (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network network_address}@anchor{3b9a}
@deffn {Atributo} network_address

La dirección de red de la red. La dirección de red y la longitud del prefijo juntos definen de forma única una red.
@end deffn

@geindex broadcast_address (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network broadcast_address}@anchor{3b9b}
@deffn {Atributo} broadcast_address

La dirección de transmisión de la red. Todos los hosts de la red deben recibir los paquetes enviados a la dirección de transmisión.
@end deffn

@geindex hostmask (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network hostmask}@anchor{3b9c}
@deffn {Atributo} hostmask

La máscara de host, como un objeto @ref{35a,,IPv4Address}.
@end deffn

@geindex netmask (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network netmask}@anchor{3b9d}
@deffn {Atributo} netmask

La máscara de red, como un objeto @ref{35a,,IPv4Address}.
@end deffn

@geindex with_prefixlen (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_prefixlen}@anchor{3b9e}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex compressed (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network compressed}@anchor{3b9f}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network exploded}@anchor{3ba0}
@deffn {Atributo} exploded

Una representación de cadena de la red, con la máscara en notación de prefijo.

@code{with_prefixlen} y @code{compressed} son siempre lo mismo que @code{str(red)}. @code{exploded} utiliza la forma explosionada de la dirección de red.
@end deffn

@geindex with_netmask (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_netmask}@anchor{3ba1}
@deffn {Atributo} with_netmask

Una representación de cadena de la red, con la máscara en notación de máscara de red.
@end deffn

@geindex with_hostmask (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_hostmask}@anchor{3ba2}
@deffn {Atributo} with_hostmask

Una representación de cadena de la red, con la máscara en notación de máscara de host.
@end deffn

@geindex num_addresses (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network num_addresses}@anchor{3ba3}
@deffn {Atributo} num_addresses

El número total de direcciones en la red.
@end deffn

@geindex prefixlen (atributo de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network prefixlen}@anchor{3ba4}
@deffn {Atributo} prefixlen

Longitud del prefijo de red, en bits.
@end deffn

@geindex hosts() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network hosts}@anchor{3ba5}
@deffn {Método} hosts ()

Longitud de Devuelve un iterador sobre los hosts utilizables en la red. Los hosts utilizables son todas las direcciones IP que pertenecen a la red, excepto la dirección de red en sí y la dirección de transmisión de la red. Para redes con una longitud de máscara de 31, la dirección de red y la dirección de transmisión de red también se incluyen en el resultado. Las redes con una máscara de 32 devolverán una lista que contiene la dirección de host única, el prefijo de red, en bits.

@example
>>> list(ip_network('192.0.2.0/29').hosts())  
[IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'),
 IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'),
 IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')]
>>> list(ip_network('192.0.2.0/31').hosts())
[IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]
>>> list(ip_network('192.0.2.1/32').hosts())
[IPv4Address('192.0.2.1')]
@end example
@end deffn

@geindex overlaps() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network overlaps}@anchor{3ba6}
@deffn {Método} overlaps (other)

@code{True} si esta red está total o parcialmente contenida en `other' o `other' está completamente contenido en esta red.
@end deffn

@geindex address_exclude() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network address_exclude}@anchor{3ba7}
@deffn {Método} address_exclude (network)

Calcula las definiciones de red resultantes de eliminar la `network' dada de esta. Devuelve un iterador de objetos de red. Genera @ref{360,,ValueError} si `network' no está completamente contenido en esta red.

@example
>>> n1 = ip_network('192.0.2.0/28')
>>> n2 = ip_network('192.0.2.1/32')
>>> list(n1.address_exclude(n2))  
[IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'),
 IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]
@end example
@end deffn

@geindex subnets() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network subnets}@anchor{f21}
@deffn {Método} subnets (prefixlen_diff=1, new_prefix=None)

Las subredes que se unen para crear la definición de red actual, según los valores de los argumentos. `prefixlen_diff' es la cantidad en la que se debe aumentar la longitud de nuestro prefijo. `new_prefix' es el nuevo prefijo deseado de las subredes; debe ser más grande que nuestro prefijo. Se debe establecer uno y solo uno de `prefixlen_diff' y `new_prefix'. Devuelve un iterador de objetos de red.

@example
>>> list(ip_network('192.0.2.0/24').subnets())
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
>>> list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))  
[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=26))  
[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=23))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    raise ValueError('new prefix must be longer')
ValueError: new prefix must be longer
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=25))
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
@end example
@end deffn

@geindex supernet() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network supernet}@anchor{f22}
@deffn {Método} supernet (prefixlen_diff=1, new_prefix=None)

La superred que contiene esta definición de red, según los valores de los argumentos. `prefixlen_diff' es la cantidad en la que se debe reducir la longitud de nuestro prefijo. `new_prefix' es el nuevo prefijo deseado de la superred; debe ser más pequeño que nuestro prefijo. Se debe establecer uno y solo uno de `prefixlen_diff' y `new_prefix'. Devuelve un solo objeto de red.

@example
>>> ip_network('192.0.2.0/24').supernet()
IPv4Network('192.0.2.0/23')
>>> ip_network('192.0.2.0/24').supernet(prefixlen_diff=2)
IPv4Network('192.0.0.0/22')
>>> ip_network('192.0.2.0/24').supernet(new_prefix=20)
IPv4Network('192.0.0.0/20')
@end example
@end deffn

@geindex subnet_of() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network subnet_of}@anchor{3ba8}
@deffn {Método} subnet_of (other)

Devuelve @code{True} si esta red es una subred de `other'.

@example
>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> b.subnet_of(a)
True
@end example


Added in version 3.7.

@end deffn

@geindex supernet_of() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network supernet_of}@anchor{3ba9}
@deffn {Método} supernet_of (other)

Devuelve @code{True} si esta red es una superred de `other'.

@example
>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> a.supernet_of(b)
True
@end example


Added in version 3.7.

@end deffn

@geindex compare_networks() (método de ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network compare_networks}@anchor{3baa}
@deffn {Método} compare_networks (other)

Compare esta red con `other'. En esta comparación solo se consideran las direcciones de red; los bits de host no lo son. Devuelve @code{-1}, @code{0} o @code{1}.

@example
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32'))
-1
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32'))
1
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))
0
@end example


Obsoleto desde la versión 3.7: Utiliza el mismo algoritmo de ordenación y comparación que «<», «==» y «>»

@end deffn
@end deffn

@geindex IPv6Network (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv6Network}@anchor{35d}
@deffn {Clase} ipaddress.IPv6Network (address, strict=True)

Construya una definición de red IPv6. `address' puede ser una de las siguientes:


@enumerate 

@item 
Una cadena que consta de una dirección IP y una longitud de prefijo opcional, separados por una barra (@code{/}). La dirección IP es la dirección de red y la longitud del prefijo debe ser un solo número, el `prefix'. Si no se proporciona una longitud de prefijo, se considera que es @code{/128}.

Tenga en cuenta que las máscaras de red expandidas actualmente no son compatibles. Eso significa que @code{2001:db00::0/24} es un argumento válido mientras que @code{2001:db00::0/ffff:ff00::} no lo es.

@item 
Un número entero que cabe en 128 bits. Esto es equivalente a una red de una sola dirección, con la dirección de red `address' y la máscara @code{/128}.

@item 
Un entero empaquetado en un objeto @ref{325,,bytes} de longitud 16, big-endian. La interpretación es similar a una `address' entera.

@item 
A two-tuple of an address description and a netmask, where the address
description is either a string, a 128-bits integer, a 16-bytes packed
integer, or an existing @ref{35b,,IPv6Address} object; and the netmask is an
integer representing the prefix length.
@end enumerate

Se genera un @ref{3b6f,,AddressValueError} si `address' no es una dirección IPv6 válida. A @ref{3b91,,NetmaskValueError} se genera si la máscara no es válida para una dirección IPv6.

Si `strict' es @code{True} y los bits de host están configurados en la dirección proporcionada, entonces @ref{360,,ValueError} se genera. De lo contrario, los bits del host se enmascaran para determinar la dirección de red adecuada.


Distinto en la versión 3.5: Se agregó la forma de dos tuplas para el parámetro de constructor `address'.


@geindex version (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network version}@anchor{3bab}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network max_prefixlen}@anchor{3bac}
@deffn {Atributo} max_prefixlen
@end deffn

@geindex is_multicast (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_multicast}@anchor{3bad}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_private}@anchor{3bae}
@deffn {Atributo} is_private
@end deffn

@geindex is_unspecified (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_unspecified}@anchor{3baf}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_reserved}@anchor{3bb0}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_loopback}@anchor{3bb1}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_link_local}@anchor{3bb2}
@deffn {Atributo} is_link_local
@end deffn

@geindex network_address (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network network_address}@anchor{3bb3}
@deffn {Atributo} network_address
@end deffn

@geindex broadcast_address (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network broadcast_address}@anchor{3bb4}
@deffn {Atributo} broadcast_address
@end deffn

@geindex hostmask (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network hostmask}@anchor{3bb5}
@deffn {Atributo} hostmask
@end deffn

@geindex netmask (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network netmask}@anchor{3bb6}
@deffn {Atributo} netmask
@end deffn

@geindex with_prefixlen (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_prefixlen}@anchor{3bb7}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex compressed (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network compressed}@anchor{3bb8}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network exploded}@anchor{3bb9}
@deffn {Atributo} exploded
@end deffn

@geindex with_netmask (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_netmask}@anchor{3bba}
@deffn {Atributo} with_netmask
@end deffn

@geindex with_hostmask (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_hostmask}@anchor{3bbb}
@deffn {Atributo} with_hostmask
@end deffn

@geindex num_addresses (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network num_addresses}@anchor{3bbc}
@deffn {Atributo} num_addresses
@end deffn

@geindex prefixlen (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network prefixlen}@anchor{3bbd}
@deffn {Atributo} prefixlen
@end deffn

@geindex hosts() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network hosts}@anchor{3bbe}
@deffn {Método} hosts ()

Devuelve un iterador sobre los hosts utilizables en la red. Los hosts utilizables son todas las direcciones IP que pertenecen a la red, excepto la dirección Anycast del Subnet-Router. Para redes con una longitud de máscara de 127, la dirección anycast del Subnet-Router también se incluye en el resultado. Las redes con una máscara de 128 devolverán una lista que contiene la única dirección de host.
@end deffn

@geindex overlaps() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network overlaps}@anchor{3bbf}
@deffn {Método} overlaps (other)
@end deffn

@geindex address_exclude() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network address_exclude}@anchor{3bc0}
@deffn {Método} address_exclude (network)
@end deffn

@geindex subnets() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network subnets}@anchor{3bc1}
@deffn {Método} subnets (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex supernet() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network supernet}@anchor{3bc2}
@deffn {Método} supernet (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex subnet_of() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network subnet_of}@anchor{3bc3}
@deffn {Método} subnet_of (other)
@end deffn

@geindex supernet_of() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network supernet_of}@anchor{3bc4}
@deffn {Método} supernet_of (other)
@end deffn

@geindex compare_networks() (método de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network compare_networks}@anchor{3bc5}
@deffn {Método} compare_networks (other)

Consulte la documentación del atributo correspondiente en @ref{35c,,IPv4Network}.
@end deffn

@geindex is_site_local (atributo de ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_site_local}@anchor{3bc6}
@deffn {Atributo} is_site_local

This attribute is true for the network as a whole if it is true
for both the network address and the broadcast address.
@end deffn
@end deffn

@node Operadores<4>,,Objetos de red,Definiciones de red IP
@anchor{library/ipaddress id1}@anchor{3bc7}
@subsubsection Operadores


Este atributo es verdadero para la red en su conjunto si es cierto para ambos objetos de red que admiten algunos operadores. A menos que se indique lo contrario, los operadores solo se pueden aplicar entre objetos compatibles (es decir, IPv4 con IPv4, IPv6 con IPv6).

@menu
* Operadores lógicos:: 
* Iteración:: 
* Redes como contenedores de direcciones:: 

@end menu

@node Operadores lógicos,Iteración,,Operadores<4>
@anchor{library/ipaddress logical-operators}@anchor{3bc8}
@subsubsection Operadores lógicos


Los objetos de red se pueden comparar con el conjunto habitual de operadores lógicos. Los objetos de red se ordenan primero por dirección de red y luego por máscara de red.

@node Iteración,Redes como contenedores de direcciones,Operadores lógicos,Operadores<4>
@anchor{library/ipaddress iteration}@anchor{3bc9}
@subsubsection Iteración


Los objetos de red se pueden iterar para enumerar todas las direcciones que pertenecen a la red. Para la iteración, se devuelven `todos' los hosts, incluidos los hosts inutilizables (para hosts utilizables, use el método @ref{3ba5,,hosts()}). Un ejemplo:

@example
>>> for addr in IPv4Network('192.0.2.0/28'):
...     addr
...
IPv4Address('192.0.2.0')
IPv4Address('192.0.2.1')
IPv4Address('192.0.2.2')
IPv4Address('192.0.2.3')
IPv4Address('192.0.2.4')
IPv4Address('192.0.2.5')
IPv4Address('192.0.2.6')
IPv4Address('192.0.2.7')
IPv4Address('192.0.2.8')
IPv4Address('192.0.2.9')
IPv4Address('192.0.2.10')
IPv4Address('192.0.2.11')
IPv4Address('192.0.2.12')
IPv4Address('192.0.2.13')
IPv4Address('192.0.2.14')
IPv4Address('192.0.2.15')
@end example

@node Redes como contenedores de direcciones,,Iteración,Operadores<4>
@anchor{library/ipaddress networks-as-containers-of-addresses}@anchor{3bca}
@subsubsection Redes como contenedores de direcciones


Los objetos de red pueden actuar como contenedores de direcciones. Algunos ejemplos:

@example
>>> IPv4Network('192.0.2.0/28')[0]
IPv4Address('192.0.2.0')
>>> IPv4Network('192.0.2.0/28')[15]
IPv4Address('192.0.2.15')
>>> IPv4Address('192.0.2.6') in IPv4Network('192.0.2.0/28')
True
>>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28')
False
@end example

@node Objetos de interfaz,Otras funciones de nivel de módulo,Definiciones de red IP,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress interface-objects}@anchor{3bcb}
@subsubsection Objetos de interfaz


Los objetos de interfaz son @ref{6b1,,hashable}, por lo que se pueden usar como claves en diccionarios.

@geindex IPv4Interface (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv4Interface}@anchor{1815}
@deffn {Clase} ipaddress.IPv4Interface (address)

Construya una interfaz IPv4. El significado de `address' es como en el constructor de @ref{35c,,IPv4Network}, excepto que siempre se aceptan direcciones de host arbitrarias.

@ref{1815,,IPv4Interface} es una subclase de @ref{35a,,IPv4Address}, por lo que hereda todos los atributos de esa clase. Además, están disponibles los siguientes atributos:

@geindex ip (atributo de ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface ip}@anchor{3bcc}
@deffn {Atributo} ip

The address (@ref{35a,,IPv4Address}) without network information.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.ip
IPv4Address('192.0.2.5')
@end example
@end deffn

@geindex network (atributo de ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface network}@anchor{3bcd}
@deffn {Atributo} network

La red (@ref{35c,,IPv4Network}) a la que pertenece esta interfaz.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.network
IPv4Network('192.0.2.0/24')
@end example
@end deffn

@geindex with_prefixlen (atributo de ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_prefixlen}@anchor{3bce}
@deffn {Atributo} with_prefixlen

Una representación de cadena de la interfaz con la máscara en notación de prefijo.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_prefixlen
'192.0.2.5/24'
@end example
@end deffn

@geindex with_netmask (atributo de ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_netmask}@anchor{3bcf}
@deffn {Atributo} with_netmask

Una representación de cadena de la interfaz con la red como máscara de red.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_netmask
'192.0.2.5/255.255.255.0'
@end example
@end deffn

@geindex with_hostmask (atributo de ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_hostmask}@anchor{3bd0}
@deffn {Atributo} with_hostmask

Una representación de cadena de la interfaz con la red como máscara de host.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_hostmask
'192.0.2.5/0.0.0.255'
@end example
@end deffn
@end deffn

@geindex IPv6Interface (clase en ipaddress)
@anchor{library/ipaddress ipaddress IPv6Interface}@anchor{1816}
@deffn {Clase} ipaddress.IPv6Interface (address)

Construya una interfaz IPv6. El significado de `address' es como en el constructor de @ref{35d,,IPv6Network}, excepto que siempre se aceptan direcciones de host arbitrarias.

@ref{1816,,IPv6Interface} es una subclase de @ref{35b,,IPv6Address}, por lo que hereda todos los atributos de esa clase. Además, están disponibles los siguientes atributos:

@geindex ip (atributo de ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface ip}@anchor{3bd1}
@deffn {Atributo} ip
@end deffn

@geindex network (atributo de ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface network}@anchor{3bd2}
@deffn {Atributo} network
@end deffn

@geindex with_prefixlen (atributo de ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_prefixlen}@anchor{3bd3}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex with_netmask (atributo de ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_netmask}@anchor{3bd4}
@deffn {Atributo} with_netmask
@end deffn

@geindex with_hostmask (atributo de ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_hostmask}@anchor{3bd5}
@deffn {Atributo} with_hostmask

Consulte la documentación del atributo correspondiente en @ref{1815,,IPv4Interface}.
@end deffn
@end deffn

@menu
* Operadores: Operadores<5>. 

@end menu

@node Operadores<5>,,,Objetos de interfaz
@anchor{library/ipaddress id2}@anchor{3bd6}
@subsubsection Operadores


Los objetos de interfaz admiten algunos operadores. A menos que se indique lo contrario, los operadores solo se pueden aplicar entre objetos compatibles (es decir, IPv4 con IPv4, IPv6 con IPv6).

@menu
* Operadores lógicos: Operadores lógicos<2>. 

@end menu

@node Operadores lógicos<2>,,,Operadores<5>
@anchor{library/ipaddress id3}@anchor{3bd7}
@subsubsection Operadores lógicos


Los objetos de interfaz se pueden comparar con el conjunto habitual de operadores lógicos.

Para la comparación de igualdad (@code{==} y @code{!=}), Tanto la dirección IP como la red deben ser iguales para que los objetos sean iguales. Una interfaz no se comparará con ninguna dirección u objeto de red.

Para ordenar (@code{<}, @code{>}, etc) las reglas son diferentes. Los objetos de interfaz y dirección con la misma versión de IP se pueden comparar, y los objetos de dirección siempre se clasificarán antes que los objetos de interfaz. Primero se comparan dos objetos de interfaz por sus redes y, si son iguales, luego por sus direcciones IP.

@node Otras funciones de nivel de módulo,Excepciones personalizadas,Objetos de interfaz,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress other-module-level-functions}@anchor{3bd8}
@subsubsection Otras funciones de nivel de módulo


El módulo también proporciona las siguientes funciones de nivel de módulo:

@geindex v4_int_to_packed() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress v4_int_to_packed}@anchor{3bd9}
@deffn {Función} ipaddress.v4_int_to_packed (address)

Represente una dirección como 4 bytes empaquetados en orden de red (big-endian). `address' es una representación entera de una dirección IP IPv4. A @ref{360,,ValueError} se genera si el número entero es negativo o demasiado grande para ser una dirección IP IPv4.

@example
>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.v4_int_to_packed(3221225985)
b'\xc0\x00\x02\x01'
@end example
@end deffn

@geindex v6_int_to_packed() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress v6_int_to_packed}@anchor{3bda}
@deffn {Función} ipaddress.v6_int_to_packed (address)

Representa una dirección como 16 bytes empaquetados en orden de red (big-endian). `address' es una representación entera de una dirección IP IPv6. A @ref{360,,ValueError} se genera si el número entero es negativo o demasiado grande para ser una dirección IP IPv6.
@end deffn

@geindex summarize_address_range() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress summarize_address_range}@anchor{f23}
@deffn {Función} ipaddress.summarize_address_range (first, last)

Devuelve un iterador del rango de red resumido dadas la primera y la última dirección IP. `first' es el primero @ref{35a,,IPv4Address} o @ref{35b,,IPv6Address} en el rango y `last' es el último @ref{35a,,IPv4Address} o @ref{35b,,IPv6Address} en el rango. A @ref{228,,TypeError} se genera si `first' o `last' no son direcciones IP o no son de la misma versión. A @ref{360,,ValueError} se genera si `last' no es mayor que `first' o si la `first' versión de la dirección no es 4 o 6.

@example
>>> [ipaddr for ipaddr in ipaddress.summarize_address_range(
...    ipaddress.IPv4Address('192.0.2.0'),
...    ipaddress.IPv4Address('192.0.2.130'))]
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]
@end example
@end deffn

@geindex collapse_addresses() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress collapse_addresses}@anchor{f24}
@deffn {Función} ipaddress.collapse_addresses (addresses)

Return an iterator of the collapsed @ref{35c,,IPv4Network} or
@ref{35d,,IPv6Network} objects.  `addresses' is an @ref{1294,,iterable} of
@ref{35c,,IPv4Network} or @ref{35d,,IPv6Network} objects.  A @ref{228,,TypeError} is
raised if `addresses' contains mixed version objects.

@example
>>> [ipaddr for ipaddr in
... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),
... ipaddress.IPv4Network('192.0.2.128/25')])]
[IPv4Network('192.0.2.0/24')]
@end example
@end deffn

@geindex get_mixed_type_key() (en el módulo ipaddress)
@anchor{library/ipaddress ipaddress get_mixed_type_key}@anchor{3bdb}
@deffn {Función} ipaddress.get_mixed_type_key (obj)

Devuelve una clave adecuada para clasificar entre redes y direcciones. Los objetos de dirección y red no se pueden ordenar de forma predeterminada; son fundamentalmente diferentes, por lo que la expresión

@example
IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')
@end example

doesn’t make sense.  There are some times however, where you may wish to
have @ref{80,,ipaddress} sort these anyway.  If you need to do this, you can use
this function as the `key' argument to @ref{c56,,sorted()}.

`obj' es un objeto de red o de dirección.
@end deffn

@node Excepciones personalizadas,,Otras funciones de nivel de módulo,ipaddress — IPv4/IPv6 manipulation library
@anchor{library/ipaddress custom-exceptions}@anchor{3bdc}
@subsubsection Excepciones personalizadas


Para admitir informes de errores más específicos de los constructores de clases, el módulo define las siguientes excepciones:

@geindex AddressValueError
@anchor{library/ipaddress ipaddress AddressValueError}@anchor{3b6f}
@deffn {Excepción} ipaddress.AddressValueError (ValueError)

Cualquier error de valor relacionado con la dirección.
@end deffn

@geindex NetmaskValueError
@anchor{library/ipaddress ipaddress NetmaskValueError}@anchor{3b91}
@deffn {Excepción} ipaddress.NetmaskValueError (ValueError)

Cualquier error de valor relacionado con la máscara de red.
@end deffn

@node Servicios Multimedia,Internacionalización,Protocolos y soporte de Internet,La biblioteca estándar de Python
@anchor{library/mm doc}@anchor{3bdd}@anchor{library/mm mmedia}@anchor{3bde}@anchor{library/mm multimedia-services}@anchor{3bdf}
@section Servicios Multimedia


Los módulos descritos en este capítulo implementan varios algoritmos o interfaces que son útiles principalmente para aplicaciones multimedia. Su disponibilidad depende de la instalación. He aquí una visión general:

@menu
* wave — Read and write WAV files:: 
* colorsys — Conversions between color systems:: 

@end menu

@node wave — Read and write WAV files,colorsys — Conversions between color systems,,Servicios Multimedia
@anchor{library/wave doc}@anchor{3be0}@anchor{library/wave module-wave}@anchor{113}@anchor{library/wave wave-read-and-write-wav-files}@anchor{3be1}
@subsection @code{wave} — Read and write WAV files


@geindex module; wave

@c Documentations stolen from comments in file.

`Código fuente:' Lib/wave.py@footnote{https://github.com/python/cpython/tree/main/Lib/wave.py}


__________________________________________________________________


The @ref{113,,wave} module provides a convenient interface to the Waveform Audio
«WAVE» (or «WAV») file format. Only uncompressed PCM encoded wave files are
supported.


Distinto en la versión 3.12: Support for @code{WAVE_FORMAT_EXTENSIBLE} headers was added, provided that the
extended format is @code{KSDATAFORMAT_SUBTYPE_PCM}.


El módulo @ref{113,,wave} define la siguiente función y excepción:

@geindex open() (en el módulo wave)
@anchor{library/wave wave open}@anchor{9de}
@deffn {Función} wave.open (file, mode=None)

Si `file' es una cadena, abra el archivo con ese nombre, de lo contrario trátelo como un objeto similar a un archivo.  `mode' puede ser:


@table @asis

@item @code{'rb'}

Modo de solo lectura.

@item @code{'wb'}

Modo de solo escritura.
@end table

Tenga en cuenta que no permite archivos WAV de lectura/escritura.

Un `mode' de @code{'rb'} retorna un objeto @ref{1df,,Wave_read}, mientras que un `mode' de @code{'wb'} retorna un objeto @ref{1e0,,Wave_write}.  Si se omite `mode' y se pasa un objeto similar a un archivo como `file', @code{file.mode} se usa como el valor predeterminado para `mode'.

If you pass in a file-like object, the wave object will not close it when its
@code{close()} method is called; it is the caller’s responsibility to close
the file object.

The @ref{9de,,open()} function may be used in a @ref{673,,with} statement.  When
the @code{with} block completes, the @ref{3be2,,Wave_read.close()} or
@ref{3be3,,Wave_write.close()} method is called.


Distinto en la versión 3.4: Se agregó soporte para archivos no encontrados.

@end deffn

@geindex Error
@anchor{library/wave wave Error}@anchor{3be4}
@deffn {Excepción} wave.Error

Error que se produce cuando algo es imposible porque viola la especificación WAV o alcanza una deficiencia de implementación.
@end deffn

@menu
* Los objetos Wave_read:: 
* Los objetos Wave_write:: 

@end menu

@node Los objetos Wave_read,Los objetos Wave_write,,wave — Read and write WAV files
@anchor{library/wave id1}@anchor{3be5}@anchor{library/wave wave-read-objects}@anchor{3be6}
@subsubsection Los objetos `Wave_read'


@geindex Wave_read (clase en wave)
@anchor{library/wave wave Wave_read}@anchor{1df}
@deffn {Clase} wave.Wave_read

Read a WAV file.

Los objetos `Wave_read', tal como lo retorna @ref{9de,,open()}, tienen los siguientes métodos:

@geindex close() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read close}@anchor{3be2}
@deffn {Método} close ()

Cierra la secuencia si fue abierta por @ref{113,,wave}, y hace que la instancia sea inutilizable. Esto es llamado automáticamente en la colección de objetos.
@end deffn

@geindex getnchannels() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getnchannels}@anchor{3be7}
@deffn {Método} getnchannels ()

Retorna el número de canales de audio (@code{1} para mono, @code{2} para estéreo).
@end deffn

@geindex getsampwidth() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getsampwidth}@anchor{3be8}
@deffn {Método} getsampwidth ()

Retorna el ancho de la muestra en bytes.
@end deffn

@geindex getframerate() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getframerate}@anchor{3be9}
@deffn {Método} getframerate ()

Retorna la frecuencia del muestreo.
@end deffn

@geindex getnframes() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getnframes}@anchor{3bea}
@deffn {Método} getnframes ()

Retorna el número de cuadros del audio.
@end deffn

@geindex getcomptype() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getcomptype}@anchor{3beb}
@deffn {Método} getcomptype ()

Retorna el tipo de compresión (@code{'NONE'} es el único tipo admitido).
@end deffn

@geindex getcompname() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getcompname}@anchor{3bec}
@deffn {Método} getcompname ()

Versión legible para humanos de @ref{3beb,,getcomptype()}. Generalmente @code{'not compressed'} significa @code{'NONE'}.
@end deffn

@geindex getparams() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getparams}@anchor{3bed}
@deffn {Método} getparams ()

Returns a @ref{32d,,namedtuple()} @code{(nchannels, sampwidth,
framerate, nframes, comptype, compname)}, equivalent to output of the
@code{get*()} methods.
@end deffn

@geindex readframes() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read readframes}@anchor{3bee}
@deffn {Método} readframes (n)

Lee y retorna como máximo `n' cuadros de audio, como un objeto @ref{325,,bytes}.
@end deffn

@geindex rewind() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read rewind}@anchor{3bef}
@deffn {Método} rewind ()

Rebobina el puntero del archivo hasta el principio de la secuencia de audio.
@end deffn

The following two methods are defined for compatibility with the old @code{aifc}
module, and don’t do anything interesting.

@geindex getmarkers() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getmarkers}@anchor{1de}
@deffn {Método} getmarkers ()

Retorna @code{None}.


Deprecated since version 3.13, will be removed in version 3.15: The method only existed for compatibility with the @code{aifc} module
which has been removed in Python 3.13.

@end deffn

@geindex getmark() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read getmark}@anchor{1dd}
@deffn {Método} getmark (id)

Lanza un error.


Deprecated since version 3.13, will be removed in version 3.15: The method only existed for compatibility with the @code{aifc} module
which has been removed in Python 3.13.

@end deffn

Los dos métodos siguientes definen un término «posición» que es compatible entre ellos y, es dependiente de la implementación.

@geindex setpos() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read setpos}@anchor{3bf0}
@deffn {Método} setpos (pos)

Establece el puntero del archivo en la posición especificada.
@end deffn

@geindex tell() (método de wave.Wave_read)
@anchor{library/wave wave Wave_read tell}@anchor{3bf1}
@deffn {Método} tell ()

Retorna la posición actual del puntero del archivo.
@end deffn
@end deffn

@node Los objetos Wave_write,,Los objetos Wave_read,wave — Read and write WAV files
@anchor{library/wave id2}@anchor{3bf2}@anchor{library/wave wave-write-objects}@anchor{1068}
@subsubsection Los objetos `Wave_write'


@geindex Wave_write (clase en wave)
@anchor{library/wave wave Wave_write}@anchor{1e0}
@deffn {Clase} wave.Wave_write

Write a WAV file.

Wave_write objects, as returned by @ref{9de,,open()}.

For seekable output streams, the @code{wave} header will automatically be updated
to reflect the number of frames actually written.  For unseekable streams, the
`nframes' value must be accurate when the first frame data is written.  An
accurate `nframes' value can be achieved either by calling
@ref{3bf3,,setnframes()} or @ref{3bf4,,setparams()} with the number
of frames that will be written before @ref{3be3,,close()} is called and
then using @ref{1069,,writeframesraw()} to write the frame data, or by
calling @ref{106a,,writeframes()} with all of the frame data to be
written.  In the latter case @ref{106a,,writeframes()} will calculate
the number of frames in the data and set `nframes' accordingly before writing
the frame data.


Distinto en la versión 3.4: Se agregó soporte para archivos no encontrados.


Wave_write objects have the following methods:

@geindex close() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write close}@anchor{3be3}
@deffn {Método} close ()

Asegúrese de que `nframes' sea correcto y cierre el archivo si fue abierto por @ref{113,,wave}. Este método es invocado en la colección de objetos. Levantará una excepción si la secuencia de salida no se puede buscar y `nframes' no coinciden con el número de cuadros realmente escritos.
@end deffn

@geindex setnchannels() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setnchannels}@anchor{3bf5}
@deffn {Método} setnchannels (n)

Configure el número de canales.
@end deffn

@geindex setsampwidth() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setsampwidth}@anchor{3bf6}
@deffn {Método} setsampwidth (n)

Establezca el ancho de la muestra en `n' bytes.
@end deffn

@geindex setframerate() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setframerate}@anchor{3bf7}
@deffn {Método} setframerate (n)

Establezca la velocidad del cuadro en `n'.


Distinto en la versión 3.2: Una entrada no-entera para este método se redondea al número entero más cercano.

@end deffn

@geindex setnframes() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setnframes}@anchor{3bf3}
@deffn {Método} setnframes (n)

Establezca el número de cuadros en `n'. Esto se cambiará más adelante si el número de cuadros realmente escritos es diferente (este intento de actualización levantará un error si no se encuentra la secuencia de salida).
@end deffn

@geindex setcomptype() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setcomptype}@anchor{3bf8}
@deffn {Método} setcomptype (type, name)

Establece el tipo de compresión y la descripción. Por el momento, solo se admite el tipo de compresión @code{NONE}, lo que significa que no hay compresión.
@end deffn

@geindex setparams() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write setparams}@anchor{3bf4}
@deffn {Método} setparams (tuple)

The `tuple' should be @code{(nchannels, sampwidth, framerate, nframes, comptype,
compname)}, with values valid for the @code{set*()} methods.  Sets all
parameters.
@end deffn

@geindex tell() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write tell}@anchor{3bf9}
@deffn {Método} tell ()

Retorna la posición actual en el archivo, con el mismo descargo para los métodos @ref{3bf1,,Wave_read.tell()} y @ref{3bf0,,Wave_read.setpos()}.
@end deffn

@geindex writeframesraw() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write writeframesraw}@anchor{1069}
@deffn {Método} writeframesraw (data)

Escribe cuadros de audio, sin corregir `nframes'.


Distinto en la versión 3.4: Todo @ref{db4,,bytes-like object} ahora es aceptado.

@end deffn

@geindex writeframes() (método de wave.Wave_write)
@anchor{library/wave wave Wave_write writeframes}@anchor{106a}
@deffn {Método} writeframes (data)

Escribe cuadros de audio y se asegura de que `nframes' sea correcto. Levantará un error si no se puede encontrar la secuencia de salida y si el número total de cuadros que se han escrito después de que se haya escrito `data' no coincide con el valor establecido previamente para `nframes'.


Distinto en la versión 3.4: Todo @ref{db4,,bytes-like object} ahora es aceptado.


Tenga en cuenta que no es válido establecer ningún parámetro después de invocar a @ref{106a,,writeframes()} o @ref{1069,,writeframesraw()}, y cualquier intento de hacerlo levantará @ref{3be4,,wave.Error}.
@end deffn
@end deffn

@node colorsys — Conversions between color systems,,wave — Read and write WAV files,Servicios Multimedia
@anchor{library/colorsys doc}@anchor{3bfa}@anchor{library/colorsys colorsys-conversions-between-color-systems}@anchor{3bfb}@anchor{library/colorsys module-colorsys}@anchor{20}
@subsection @code{colorsys} — Conversions between color systems


@geindex module; colorsys

`Código fuente:' Lib/colorsys.py@footnote{https://github.com/python/cpython/tree/main/Lib/colorsys.py}


__________________________________________________________________


The @ref{20,,colorsys} module defines bidirectional conversions of color values
between colors expressed in the RGB (Red Green Blue) color space used in
computer monitors and three other coordinate systems: YIQ, HLS (Hue Lightness
Saturation) and HSV (Hue Saturation Value).  Coordinates in all of these color
spaces are floating-point values.  In the YIQ space, the Y coordinate is between
0 and 1, but the I and Q coordinates can be positive or negative.  In all other
spaces, the coordinates are all between 0 and 1.


@subsubheading Ver también


Puede encontrar más información sobre los espacios de color en @indicateurl{http://poynton.ca/ColorFAQ.html} y @indicateurl{https://www.cambridgeincolour.com/tutorials/color-spaces.htm}.


El módulo @ref{20,,colorsys} define las siguientes funciones:

@geindex rgb_to_yiq() (en el módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_yiq}@anchor{3bfc}
@deffn {Función} colorsys.rgb_to_yiq (r, g, b)

Convierte el color de las coordenadas RGB en coordenadas YIQ.
@end deffn

@geindex yiq_to_rgb() (en el módulo colorsys)
@anchor{library/colorsys colorsys yiq_to_rgb}@anchor{3bfd}
@deffn {Función} colorsys.yiq_to_rgb (y, i, q)

Convierte el color de las coordenadas YIQ en coordenadas RGB.
@end deffn

@geindex rgb_to_hls() (en el módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_hls}@anchor{1707}
@deffn {Función} colorsys.rgb_to_hls (r, g, b)

Convierte el color de las coordenadas RGB en coordenadas HLS.
@end deffn

@geindex hls_to_rgb() (en el módulo colorsys)
@anchor{library/colorsys colorsys hls_to_rgb}@anchor{3bfe}
@deffn {Función} colorsys.hls_to_rgb (h, l, s)

Convierte el color de las coordenadas HLS en coordenadas RGB.
@end deffn

@geindex rgb_to_hsv() (en el módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_hsv}@anchor{3bff}
@deffn {Función} colorsys.rgb_to_hsv (r, g, b)

Convierte el color de las coordenadas RGB en coordenadas HSV.
@end deffn

@geindex hsv_to_rgb() (en el módulo colorsys)
@anchor{library/colorsys colorsys hsv_to_rgb}@anchor{3c00}
@deffn {Función} colorsys.hsv_to_rgb (h, s, v)

Convierte el color de las coordenadas HSV en coordenadas RGB.
@end deffn

Ejemplo:

@example
>>> import colorsys
>>> colorsys.rgb_to_hsv(0.2, 0.4, 0.4)
(0.5, 0.5, 0.4)
>>> colorsys.hsv_to_rgb(0.5, 0.5, 0.4)
(0.2, 0.4, 0.4)
@end example

@node Internacionalización,Frameworks de programa,Servicios Multimedia,La biblioteca estándar de Python
@anchor{library/i18n doc}@anchor{3c01}@anchor{library/i18n i18n}@anchor{3c02}@anchor{library/i18n internationalization}@anchor{3c03}
@section Internacionalización


Los módulos descritos en este capítulo te ayudan a escribir software que es independiente del idioma y lugar al proporcionar mecanismos para seleccionar un idioma a ser usado en  mensajes de programas o adaptar la salida para que coincida con las convenciones locales.

La lista de módulos descritos en este capítulo es:

@menu
* gettext — Multilingual internationalization services:: 
* locale — Internationalization services:: 

@end menu

@node gettext — Multilingual internationalization services,locale — Internationalization services,,Internacionalización
@anchor{library/gettext doc}@anchor{3c04}@anchor{library/gettext gettext-multilingual-internationalization-services}@anchor{3c05}@anchor{library/gettext module-gettext}@anchor{63}
@subsection @code{gettext} — Multilingual internationalization services


@geindex module; gettext

`Código fuente:' Lib/gettext.py@footnote{https://github.com/python/cpython/tree/main/Lib/gettext.py}


__________________________________________________________________


El módulo @ref{63,,gettext} proporciona servicios de internacionalización (I18N) y localización (L10N) para sus módulos y aplicaciones Python. Admite tanto la API del catálogo de mensajes GNU @code{gettext} como una API basada en clases de nivel superior que puede ser más apropiada para los archivos Python. La interfaz que se describe a continuación le permite escribir sus mensajes de módulo y aplicación en un idioma natural, y proporcionar un catálogo de mensajes traducidos para ejecutar en diferentes idiomas naturales.

También se dan algunas sugerencias para localizar sus módulos y aplicaciones Python.

@menu
* GNU API gettext:: 
* API basada en clases:: 
* Internacionalizando sus programas y módulos:: 
* Agradecimientos: Agradecimientos<9>. 

@end menu

@node GNU API gettext,API basada en clases,,gettext — Multilingual internationalization services
@anchor{library/gettext gnu-gettext-api}@anchor{3c06}
@subsubsection GNU API @code{gettext}


El módulo @ref{63,,gettext} define la siguiente API, que es muy similar al programa GNU @code{gettext} API. Si usa esta API, afectará la traducción de toda su aplicación a nivel mundial. A menudo, esto es lo que desea si su aplicación es monolingüe, y la elección del idioma depende de la configuración regional de su usuario. Si está localizando un módulo de Python, o si su aplicación necesita cambiar idiomas sobre la marcha, probablemente desee utilizar la API basada en clases.

@geindex bindtextdomain() (en el módulo gettext)
@anchor{library/gettext gettext bindtextdomain}@anchor{3c07}
@deffn {Función} gettext.bindtextdomain (domain, localedir=None)

Enlaza (`bind') el `domain' al directorio de configuración regional `localedir'. Más concretamente, @ref{63,,gettext} buscará archivos binarios @code{.mo} para el dominio dado usando la ruta (en Unix): @code{`localedir'/`language'/LC_MESSAGES /`domain'.mo}, donde se busca `language' en las variables de entorno 
@geindex LANGUAGE
@geindex variables de entorno; LANGUAGE
@code{LANGUAGE}, 
@geindex LC_ALL
@geindex variables de entorno; LC_ALL
@code{LC_ALL}, 
@geindex LC_MESSAGES
@geindex variables de entorno; LC_MESSAGES
@code{LC_MESSAGES} y 
@geindex LANG
@geindex variables de entorno; LANG
@code{LANG} respectivamente.

Si `localedir' se omite o es @code{None}, se retorna el enlace actual para `domain'. @footnote{
The default locale directory is system dependent; for example, on Red Hat Linux
it is @code{/usr/share/locale}, but on Solaris it is @code{/usr/lib/locale}.
The @code{gettext} module does not try to support these system dependent
defaults; instead its default is @code{`sys.base_prefix'/share/locale} (see
@ref{280,,sys.base_prefix}). For this reason, it is always best to call
@ref{3c07,,bindtextdomain()} with an explicit absolute path at the start of your
application.
}
@end deffn

@geindex textdomain() (en el módulo gettext)
@anchor{library/gettext gettext textdomain}@anchor{3c08}
@deffn {Función} gettext.textdomain (domain=None)

Cambia o consulta el dominio global actual. Si `domain' es @code{None}, se retorna el dominio global actual; de lo contrario, el dominio global se establece en `domain', que se retorna.
@end deffn

@geindex _ (underscore);gettext

@geindex gettext() (en el módulo gettext)
@anchor{library/gettext gettext gettext}@anchor{14a6}
@deffn {Función} gettext.gettext (message)

Retorna la traducción localizada de `message', basada en el dominio global actual, el idioma y el directorio de configuración regional. Esta función suele tener un alias como @code{_()} en el espacio de nombres local (ver ejemplos a continuación).
@end deffn

@geindex dgettext() (en el módulo gettext)
@anchor{library/gettext gettext dgettext}@anchor{3c09}
@deffn {Función} gettext.dgettext (domain, message)

Como @ref{14a6,,gettext()}, pero busque el mensaje en el `domain' especificado.
@end deffn

@geindex ngettext() (en el módulo gettext)
@anchor{library/gettext gettext ngettext}@anchor{3c0a}
@deffn {Función} gettext.ngettext (singular, plural, n)

Como @ref{14a6,,gettext()}, pero considere formas plurales. Si se encuentra una traducción, aplique la fórmula plural a `n' y retorna el mensaje resultante (algunos idiomas tienen más de dos formas plurales). Si no se encuentra ninguna traducción, retorna `singular' if `n' es 1; retorna `plural' de lo contrario.

La fórmula Plural se toma del encabezado del catálogo. Es una expresión C o Python que tiene una variable libre `n'; la expresión se evalúa como el índice del plural en el catálogo. Consulte la documentación de GNU gettext@footnote{https://www.gnu.org/software/gettext/manual/gettext.html} para conocer la sintaxis precisa que se utilizará en archivos @code{.po} y las fórmulas para un variedad de idiomas.
@end deffn

@geindex dngettext() (en el módulo gettext)
@anchor{library/gettext gettext dngettext}@anchor{3c0b}
@deffn {Función} gettext.dngettext (domain, singular, plural, n)

Como @ref{3c0a,,ngettext()}, pero busque el mensaje en el `domain' especificado.
@end deffn

@geindex pgettext() (en el módulo gettext)
@anchor{library/gettext gettext pgettext}@anchor{a87}
@deffn {Función} gettext.pgettext (context, message)
@end deffn

@geindex dpgettext() (en el módulo gettext)
@anchor{library/gettext gettext dpgettext}@anchor{3c0c}
@deffn {Función} gettext.dpgettext (domain, context, message)
@end deffn

@geindex npgettext() (en el módulo gettext)
@anchor{library/gettext gettext npgettext}@anchor{3c0d}
@deffn {Función} gettext.npgettext (context, singular, plural, n)
@end deffn

@geindex dnpgettext() (en el módulo gettext)
@anchor{library/gettext gettext dnpgettext}@anchor{3c0e}
@deffn {Función} gettext.dnpgettext (domain, context, singular, plural, n)

Similar a las funciones correspondientes sin la @code{p} en el prefijo (es decir, @ref{63,,gettext()}, @ref{3c09,,dgettext()}, @ref{3c0a,,ngettext()}, @ref{3c0b,,dngettext()}), pero la traducción está restringida al mensaje dado `context'.


Added in version 3.8.

@end deffn

Tenga en cuenta que @code{gettext} de GNU también define un método @code{dcgettext()}, pero esto no se consideró útil, por lo que actualmente no está implementado.

Aquí hay un ejemplo del uso típico de esta API:

@example
import gettext
gettext.bindtextdomain('myapplication', '/path/to/my/language/directory')
gettext.textdomain('myapplication')
_ = gettext.gettext
# ...
print(_('This is a translatable string.'))
@end example

@node API basada en clases,Internacionalizando sus programas y módulos,GNU API gettext,gettext — Multilingual internationalization services
@anchor{library/gettext class-based-api}@anchor{3c0f}
@subsubsection API basada en clases


La API basada en clases del módulo @ref{63,,gettext} ofrece más flexibilidad y mayor conveniencia que la API de @code{gettext} de GNU. Es la forma recomendada para localizar sus aplicaciones y módulos Python. @code{gettext} define una clase @ref{3c10,,GNUTranslations} que implementa el análisis de archivos en formato @code{.mo} de GNU, y tiene métodos para retornar cadenas de caracteres. Instancias de esta clase también pueden auto instalarse en el espacio de nombres incorporado como la función @code{_()}.

@geindex find() (en el módulo gettext)
@anchor{library/gettext gettext find}@anchor{3c11}
@deffn {Función} gettext.find (domain, localedir=None, languages=None, all=False)

Esta función implementa el algoritmo de búsqueda de archivos estándar @code{.mo}. Toma un `domain', idéntico al que toma @ref{3c08,,textdomain()}. Opcional `localedir' es como en @ref{3c07,,bindtextdomain()}. `languages' opcionales es una lista de cadenas, donde cada cadena es un código de idioma.

Si no se proporciona `localedir', se utiliza el directorio de configuración regional predeterminado del sistema. @footnote{
Vea la nota al pie de página para @ref{3c07,,bindtextdomain()} arriba.
} Si no se proporcionan `languages', se buscan las siguientes variables de entorno: 
@geindex LANGUAGE
@geindex variables de entorno; LANGUAGE
@code{LANGUAGE}, 
@geindex LC_ALL
@geindex variables de entorno; LC_ALL
@code{LC_ALL}, 
@geindex LC_MESSAGES
@geindex variables de entorno; LC_MESSAGES
@code{LC_MESSAGES}, y 
@geindex LANG
@geindex variables de entorno; LANG
@code{LANG}. El primero que retorna un valor no vacío se usa para la variable `languages'. Las variables de entorno deben contener una lista de idiomas separados por dos puntos, que se dividirá en dos puntos para producir la lista esperada de cadenas de código de idioma.

@ref{3c11,,find()} luego expande y normaliza los idiomas, y luego los itera, buscando un archivo existente construido con estos componentes:

@code{`localedir'/`language'/LC_MESSAGES/`domain'.mo}

El primer nombre de archivo que existe es retornado por @ref{3c11,,find()}. Si no se encuentra dicho archivo, se retorna @code{None}. Si se proporciona `all', retorna una lista de todos los nombres de archivo, en el orden en que aparecen en la lista de idiomas o las variables de entorno.
@end deffn

@geindex translation() (en el módulo gettext)
@anchor{library/gettext gettext translation}@anchor{3c12}
@deffn {Función} gettext.translation (domain, localedir=None, languages=None, class_=None, fallback=False)

Retorna una instancia de @code{*Translations} basada en `domain', `localedir' y `languages', que primero se pasan a @ref{3c11,,find()} para obtener una lista de las rutas de archivos @code{.mo} asociadas. Las instancias con nombres de archivos @code{.mo} idénticos se almacenan en caché. La clase concreta instanciada es `class_' si se proporciona, de lo contrario será @ref{3c10,,GNUTranslations}. El constructor de esta clase debe aceptar un único argumento de tipo @ref{1230,,file object}.

Si se encuentran varios archivos, los archivos posteriores se utilizan como retrocesos para los anteriores. Para permitir la configuración de la reserva, @ref{5d7,,copy.copy()} se utiliza para clonar cada objeto de traducción del caché; los datos de la instancia real aún se comparten con el caché.

Si no se encuentra el archivo @code{.mo}, esta función genera @ref{4d5,,OSError} si `fallback' es falso (que es el valor predeterminado) y retorna una instancia de @ref{3c13,,NullTranslations} si `fallback' is verdadero.


Distinto en la versión 3.3: @ref{10ce,,IOError} used to be raised, it is now an alias of @ref{4d5,,OSError}.



Distinto en la versión 3.11: el parámetro `codeset' se removió.

@end deffn

@geindex install() (en el módulo gettext)
@anchor{library/gettext gettext install}@anchor{b08}
@deffn {Función} gettext.install (domain, localedir=None, *, names=None)

Esto instala la función @code{_()} en el espacio de nombres incorporado de Python, basado en `domain' y `localedir' que se pasan a la función @ref{3c12,,translation()}.

Para el parámetro `names', consulte la descripción del método del objeto de traducción @ref{3c14,,install()}.

Como se ve a continuación, generalmente marca las cadenas en su aplicación que son candidatas para la traducción, envolviéndolas en una llamada a la función @code{_()}, como esta:

@example
print(_('This string will be translated.'))
@end example

Para mayor comodidad, desea que la función @code{_()} se instale en el espacio de nombres integrado de Python, para que sea fácilmente accesible en todos los módulos de su aplicación.


Distinto en la versión 3.11: `names' ahora es un parámetro de solo palabra clave.

@end deffn

@menu
* La clase NullTranslations:: 
* La clase GNUTranslations:: 
* Soporte de catálogo de mensajes de Solaris:: 
* El constructor del catálogo:: 

@end menu

@node La clase NullTranslations,La clase GNUTranslations,,API basada en clases
@anchor{library/gettext the-nulltranslations-class}@anchor{3c15}
@subsubsection La clase @code{NullTranslations}


Las clases de traducción son las que realmente implementan la traducción de cadenas de mensajes del archivo fuente original a cadenas de mensajes traducidas. La clase base utilizada por todas las clases de traducción es @ref{3c13,,NullTranslations}; Esto proporciona la interfaz básica que puede utilizar para escribir sus propias clases de traducción especializadas. Estos son los métodos de @code{NullTranslations}:

@geindex NullTranslations (clase en gettext)
@anchor{library/gettext gettext NullTranslations}@anchor{3c13}
@deffn {Clase} gettext.NullTranslations (fp=None)

Toma un término opcional @ref{1230,,file object} `fp', que es ignorado por la clase base. Inicializa las variables de instancia «protegidas» `_info' y `_charset' que se establecen mediante clases derivadas, así como `_fallback', que se establece a través de @ref{3c16,,add_fallback()}. Luego llama a @code{self._parse(fp)} if `fp' no es @code{None}.

@geindex _parse() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations _parse}@anchor{3c17}
@deffn {Método} _parse (fp)

No operativo en la clase base, este método toma el objeto de archivo `fp' y lee los datos del archivo, inicializando su catálogo de mensajes. Si tiene un formato de archivo de catálogo de mensajes no admitido, debe sobrescribir este método para analizar su formato.
@end deffn

@geindex add_fallback() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations add_fallback}@anchor{3c16}
@deffn {Método} add_fallback (fallback)

Agrega `fallback' como el objeto de respaldo para el objeto de traducción actual. Un objeto de traducción debe consultar la reserva si no puede proporcionar una traducción para un mensaje dado.
@end deffn

@geindex gettext() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations gettext}@anchor{3c18}
@deffn {Método} gettext (message)

Si se ha establecido una reserva, reenvíe @code{gettext()} a la reserva. De lo contrario, retorna `message'. Anulado en clases derivadas.
@end deffn

@geindex ngettext() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations ngettext}@anchor{3c19}
@deffn {Método} ngettext (singular, plural, n)

Si se ha establecido una reserva, reenvíe @code{ngettext()} a la reserva. De lo contrario, retorna `singular' si `n' es 1; volver `plural' de lo contrario. Anulado en clases derivadas.
@end deffn

@geindex pgettext() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations pgettext}@anchor{3c1a}
@deffn {Método} pgettext (context, message)

Si se ha establecido una reserva, reenvía @ref{a87,,pgettext()} a la reserva. De lo contrario, retorna el mensaje traducido. Anulado en clases derivadas.


Added in version 3.8.

@end deffn

@geindex npgettext() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations npgettext}@anchor{3c1b}
@deffn {Método} npgettext (context, singular, plural, n)

Si se ha establecido una reserva, reenvía @ref{3c0d,,npgettext()} a la reserva. De lo contrario, retorna el mensaje traducido. Anulado en clases derivadas.


Added in version 3.8.

@end deffn

@geindex info() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations info}@anchor{3c1c}
@deffn {Método} info ()

Return a dictionary containing
the metadata found in the message catalog file.
@end deffn

@geindex charset() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations charset}@anchor{3c1d}
@deffn {Método} charset ()

Retorna la codificación del archivo de catálogo de mensajes.
@end deffn

@geindex install() (método de gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations install}@anchor{3c14}
@deffn {Método} install (names=None)

Este método instala @ref{3c18,,gettext()} en el espacio de nombres incorporado, vinculándolo a @code{_}.

Si se proporciona el parámetro `names', debe ser una secuencia que contenga los nombres de las funciones que desea instalar en el espacio de nombres incorporado, además de @code{_()}. Los nombres compatibles son @code{'gettext'}, @code{'ngettext'}, @code{'pgettext'} y @code{'npgettext'}.

Considere que esta es solo una manera, aunque la más conveniente, de hacer disponible la función @code{_()} en su aplicación. Ya que afecta a toda la aplicación de manera global, y en particular al espacio de nombres integrado, los módulos localizados nunca deben instalar @code{_()}. En lugar de ello, deberían utilizar este código para hacer que @code{_()} esté disponible en su módulo:

@example
import gettext
t = gettext.translation('mymodule', ...)
_ = t.gettext
@end example

Esto pone @code{_()} solo en el espacio de nombres global del módulo y, por lo tanto, solo afecta las llamadas dentro de este módulo.


Distinto en la versión 3.8: Se agregó @code{'pgettext'} y @code{'npgettext'}.

@end deffn
@end deffn

@node La clase GNUTranslations,Soporte de catálogo de mensajes de Solaris,La clase NullTranslations,API basada en clases
@anchor{library/gettext the-gnutranslations-class}@anchor{3c1e}
@subsubsection La clase @code{GNUTranslations}


The @code{gettext} module provides one additional class derived from
@ref{3c13,,NullTranslations}: @ref{3c10,,GNUTranslations}.  This class overrides
@code{_parse()} to enable reading GNU @code{gettext} format @code{.mo} files
in both big-endian and little-endian format.

@ref{3c10,,GNUTranslations} parses optional metadata out of the translation
catalog. It is convention with GNU @code{gettext} to include metadata as
the translation for the empty string. This metadata is in 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html}-style
@code{key: value} pairs, and should contain the @code{Project-Id-Version} key.  If the
key @code{Content-Type} is found, then the @code{charset} property is used to
initialize the «protected» @code{_charset} instance variable, defaulting to
@code{None} if not found.  If the charset encoding is specified, then all message
ids and message strings read from the catalog are converted to Unicode using
this encoding, else ASCII is assumed.

Ya que los identificadores de mensajes también se leen como cadenas Unicode, todos los métodos @code{*gettext()} considerarán a los identificadores de mensajes como cadenas Unicode, y no como cadenas de bytes.

The entire set of key/value pairs are placed into a dictionary and set as the
«protected» @code{_info} instance variable.

Si el número mágico del archivo @code{.mo} no es válido, el número de versión principal es inesperado, o si se producen otros problemas al leer el archivo, se crea una instancia de @ref{3c10,,GNUTranslations} puede generar @ref{4d5,,OSError}.

@geindex GNUTranslations (clase en gettext)
@anchor{library/gettext gettext GNUTranslations}@anchor{3c10}
@deffn {Clase} gettext.GNUTranslations

Los siguientes métodos se anulan desde la implementación de la clase base:

@geindex gettext() (método de gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations gettext}@anchor{3c1f}
@deffn {Método} gettext (message)

Busca el `message' id en el catálogo y retorna la cadena de caracteres de mensaje correspondiente, como una cadena Unicode. Si no hay una entrada en el catálogo para el `message' id, y se ha establecido una retroceso (`fallback'), la búsqueda se reenvía al método de retroceso @ref{3c18,,gettext()}. De lo contrario, se retorna el `message' id.
@end deffn

@geindex ngettext() (método de gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations ngettext}@anchor{3c20}
@deffn {Método} ngettext (singular, plural, n)

Realiza una búsqueda de formas plurales de una identificación de mensaje. `singular' se usa como la identificación del mensaje para fines de búsqueda en el catálogo, mientras que `n' se usa para determinar qué forma plural usar. La cadena del mensaje retornado es una cadena de caracteres Unicode.

Si la identificación del mensaje no se encuentra en el catálogo y se especifica una reserva, la solicitud se reenvía al método de reserva @ref{3c19,,ngettext()}. De lo contrario, cuando `n' es 1 se retorna `singular', y `plural' se retorna en todos los demás casos.

Aquí hay un ejemplo:

@example
n = len(os.listdir('.'))
cat = GNUTranslations(somefile)
message = cat.ngettext(
    'There is %(num)d file in this directory',
    'There are %(num)d files in this directory',
    n) % @{'num': n@}
@end example
@end deffn

@geindex pgettext() (método de gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations pgettext}@anchor{3c21}
@deffn {Método} pgettext (context, message)

Busca el `context' y `message' id en el catálogo y retorna la cadena de de caracteres mensaje correspondiente, como una cadena de caracteres Unicode. Si no hay ninguna entrada en el catálogo para el `message' id y `context', y se ha establecido un retroceso (`fallback'), la búsqueda se reenvía al método de retroceso @ref{a87,,pgettext()}. De lo contrario, se retorna el `message' id.


Added in version 3.8.

@end deffn

@geindex npgettext() (método de gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations npgettext}@anchor{3c22}
@deffn {Método} npgettext (context, singular, plural, n)

Realiza una búsqueda de formas plurales de una identificación de mensaje. `singular' se usa como la identificación del mensaje para fines de búsqueda en el catálogo, mientras que `n' se usa para determinar qué forma plural usar.

Si la identificación del mensaje para `context' no se encuentra en el catálogo y se especifica una reserva, la solicitud se reenvía al método de reserva @ref{3c0d,,npgettext()}. De lo contrario, cuando `n * es 1 se retorna *singular', y `plural' se retorna en todos los demás casos.


Added in version 3.8.

@end deffn
@end deffn

@node Soporte de catálogo de mensajes de Solaris,El constructor del catálogo,La clase GNUTranslations,API basada en clases
@anchor{library/gettext solaris-message-catalog-support}@anchor{3c23}
@subsubsection Soporte de catálogo de mensajes de Solaris


El sistema operativo Solaris define su propio formato de archivo binario @code{.mo}, pero como no se puede encontrar documentación sobre este formato, no es compatible en este momento.

@node El constructor del catálogo,,Soporte de catálogo de mensajes de Solaris,API basada en clases
@anchor{library/gettext the-catalog-constructor}@anchor{3c24}
@subsubsection El constructor del catálogo


@geindex GNOME

GNOME usa una versión del módulo @ref{63,,gettext} de James Henstridge, pero esta versión tiene una API ligeramente diferente. Su uso documentado fue:

@example
import gettext
cat = gettext.Catalog(domain, localedir)
_ = cat.gettext
print(_('hello world'))
@end example

Para la compatibilidad con este módulo anterior, la función @code{Catalog()} es un alias para la función @ref{3c12,,translation()} descrita anteriormente.

Una diferencia entre este módulo y el de Henstridge: sus objetos de catálogo admitían el acceso a través de una API de mapeo, pero esto parece estar sin usar y, por lo tanto, actualmente no es compatible.

@node Internacionalizando sus programas y módulos,Agradecimientos<9>,API basada en clases,gettext — Multilingual internationalization services
@anchor{library/gettext i18n-howto}@anchor{2cb9}@anchor{library/gettext internationalizing-your-programs-and-modules}@anchor{3c25}
@subsubsection Internacionalizando sus programas y módulos


La internacionalización (I18N) se refiere a la operación mediante la cual un programa conoce varios idiomas. La localización (L10N) se refiere a la adaptación de su programa, una vez internacionalizado, al idioma local y los hábitos culturales. Para proporcionar mensajes multilingües para sus programas de Python, debe seguir los siguientes pasos:


@enumerate 

@item 
prepare su programa o módulo marcando especialmente cadenas traducibles

@item 
ejecuta un conjunto de herramientas sobre tus archivos marcados para generar catálogos de mensajes sin procesar

@item 
crear traducciones específicas del idioma de los catálogos de mensajes

@item 
use el módulo @ref{63,,gettext} para que las cadenas de caracteres de mensajes se traduzcan correctamente
@end enumerate

Para preparar su código para la internacionalización (I18N), necesita revisar todas las cadenas de texto en sus archivos. Cualquier cadena que requiera traducción debe ser marcada envolviéndola en @code{_('...')} —, lo que equivale a una llamada a la función @ref{63,,_}. Por ejemplo:

@example
filename = 'mylog.txt'
message = _('writing a log message')
with open(filename, 'w') as fp:
    fp.write(message)
@end example

En este ejemplo, la cadena de caracteres @code{'writing a log message'} está marcada como candidata para la traducción, mientras que las cadenas @code{'mylog.txt'} y @code{'w'} no lo están.

Hay algunas herramientas para extraer las cadenas destinadas a la traducción. El GNU @code{gettext} original solo admitía el código fuente C o C++, pero su versión extendida @code{xgettext} escanea el código escrito en varios idiomas, incluido Python, para encontrar cadenas marcadas como traducibles. Babel@footnote{https://babel.pocoo.org/} es una biblioteca de internacionalización de Python que incluye un script @code{pybabel} para extraer y compilar catálogos de mensajes. El programa de François Pinard llamado @code{xpot} hace un trabajo similar y está disponible como parte de su po-utils package@footnote{https://github.com/pinard/po-utils}.

(Python también incluye versiones de Python puro de estos programas, llamadas @code{pygettext.py} y @code{msgfmt.py}; algunas distribuciones de Python las instalarán por usted. @code{pygettext.py} es similar a @code{xgettext}, pero solo entiende el código fuente de Python y no puede manejar otros lenguajes de programación como C o C++. @code{pygettext.py} admite una interfaz de línea de comandos similar a @code{xgettext}; para detalles sobre su uso, ejecute @code{pygettext.py --help}. @code{msgfmt.py} es binario compatible con GNU @code{msgfmt}. Con estos dos programas, es posible que no necesite el paquete GNU @code{gettext} para internacionalizar sus aplicaciones Python.)

@code{xgettext}, @code{pygettext}, y herramientas similares generan archivos @code{.po} que son catálogos de mensajes. Son archivos estructurados legibles por humanos que contienen cada cadena marcada en el código fuente, junto con un marcador de posición para las versiones traducidas de estas cadenas.

Las copias de estos archivos @code{.po} se entregan a los traductores humanos individuales que escriben traducciones para cada lenguaje natural compatible. Envían las versiones completas específicas del idioma como un archivo @code{<nombre-idioma >.po} que se compila en un archivo binario @code{.mo} de lectura mecánica utilizando el programa @code{msgfmt} . Los archivos @code{.mo} son utilizados por el módulo @ref{63,,gettext} para el procesamiento de traducción real en tiempo de ejecución.

Como use el módulo @ref{63,,gettext} en su código depende de si está internacionalizando un solo módulo o toda su aplicación. Las siguientes dos secciones discutirán cada caso.

@menu
* Agregar configuración regional a su módulo:: 
* Agregar configuración regional a su aplicación:: 
* Cambiar idiomas sobre la marcha:: 
* Traducciones diferidas:: 

@end menu

@node Agregar configuración regional a su módulo,Agregar configuración regional a su aplicación,,Internacionalizando sus programas y módulos
@anchor{library/gettext localizing-your-module}@anchor{3c26}
@subsubsection Agregar configuración regional a su módulo


Si está aplicando configuración regional a su módulo, debe tener cuidado de no realizar cambios globales, por ejemplo, al espacio de nombres integrado. No debe utilizar la API GNU @code{gettext}, sino la API basada en clases.

Digamos que su módulo se llama «spam» y los diversos archivos @code{.mo} de traducciones del lenguaje natural del módulo residen en @code{/usr/share/locale} en formato GNU @code{gettext}. Esto es lo que pondría en la parte superior de su módulo:

@example
import gettext
t = gettext.translation('spam', '/usr/share/locale')
_ = t.gettext
@end example

@node Agregar configuración regional a su aplicación,Cambiar idiomas sobre la marcha,Agregar configuración regional a su módulo,Internacionalizando sus programas y módulos
@anchor{library/gettext localizing-your-application}@anchor{3c27}
@subsubsection Agregar configuración regional a su aplicación


Si está localizando su aplicación, puede instalar globalmente la función @code{_()} en el espacio de nombres integrado, normalmente en el archivo principal de su aplicación. Esto hará que todos los archivos específicos de la aplicación puedan usar @code{_('...')} sin necesidad de instalarla explícitamente en cada uno de ellos.

En el caso simple, entonces, solo necesita agregar el siguiente bit de código al archivo del controlador principal de su aplicación:

@example
import gettext
gettext.install('myapplication')
@end example

Si necesita establecer el directorio de configuración regional, puede pasarlo a la función @ref{b08,,install()}:

@example
import gettext
gettext.install('myapplication', '/usr/share/locale')
@end example

@node Cambiar idiomas sobre la marcha,Traducciones diferidas,Agregar configuración regional a su aplicación,Internacionalizando sus programas y módulos
@anchor{library/gettext changing-languages-on-the-fly}@anchor{3c28}
@subsubsection Cambiar idiomas sobre la marcha


Si su programa necesita admitir muchos idiomas al mismo tiempo, es posible que desee crear varias instancias de traducción y luego cambiar entre ellas explícitamente, de esta manera:

@example
import gettext

lang1 = gettext.translation('myapplication', languages=['en'])
lang2 = gettext.translation('myapplication', languages=['fr'])
lang3 = gettext.translation('myapplication', languages=['de'])

# start by using language1
lang1.install()

# ... time goes by, user selects language 2
lang2.install()

# ... more time goes by, user selects language 3
lang3.install()
@end example

@node Traducciones diferidas,,Cambiar idiomas sobre la marcha,Internacionalizando sus programas y módulos
@anchor{library/gettext deferred-translations}@anchor{3c29}
@subsubsection Traducciones diferidas


En la mayoría de las situaciones de codificación, las cadenas se traducen donde se codifican. Sin embargo, ocasionalmente, debe marcar cadenas para la traducción, pero diferir la traducción real hasta más tarde. Un ejemplo clásico es:

@example
animals = ['mollusk',
           'albatross',
           'rat',
           'penguin',
           'python', ]
# ...
for a in animals:
    print(a)
@end example

Aquí, desea marcar las cadenas en la lista de @code{animals} como traducibles, pero en realidad no desea traducirlas hasta que se impriman.

Aquí hay una manera de manejar esta situación:

@example
def _(message): return message

animals = [_('mollusk'),
           _('albatross'),
           _('rat'),
           _('penguin'),
           _('python'), ]

del _

# ...
for a in animals:
    print(_(a))
@end example

Esto funciona ya que la definición ficticia de @code{_()} devuelve simplemente la cadena sin modificar. Además, esta definición ficticia sobrescribirá de manera temporal cualquier definición de @code{_()} en el espacio de nombres integrado (hasta el uso del comando @ref{17ae,,del}). No obstante, tenga cuidado si ya existe una definición previa de @code{_()} en el espacio de nombres local.

Tenga en cuenta que el segundo uso de @code{_()} no identificará «a» como traducible al programa @code{gettext}, porque el parámetro no es un literal de cadena.

Otra forma de manejar esto es con el siguiente ejemplo:

@example
def N_(message): return message

animals = [N_('mollusk'),
           N_('albatross'),
           N_('rat'),
           N_('penguin'),
           N_('python'), ]

# ...
for a in animals:
    print(_(a))
@end example

En este caso, está marcando las cadenas traducibles con la función @code{N_()}, la cual no generará conflictos con ninguna definición de @code{_()}. Sin embargo, deberá enseñar a su programa de extracción de mensajes a buscar cadenas traducibles marcadas con @code{N_()}. @code{xgettext}, @code{pygettext}, @code{pybabel extract}, y @code{xpot} todos soportan esto mediante el uso de la opción de línea de comandos @code{-k}. La elección de @code{N_`()} aquí es completamente arbitraria; podría haber sido también @code{MarkThisStringForTranslation()}.

@node Agradecimientos<9>,,Internacionalizando sus programas y módulos,gettext — Multilingual internationalization services
@anchor{library/gettext acknowledgements}@anchor{3c2a}
@subsubsection Agradecimientos


Las siguientes personas contribuyeron con código, comentarios, sugerencias de diseño, implementaciones anteriores y una valiosa experiencia para la creación de este módulo:


@itemize *

@item 
`Peter Funk'

@item 
`James Henstridge'

@item 
`Juan David Ibáñez Palomar'

@item 
`Marc-André Lemburg'

@item 
Martin von Löwis

@item 
`François Pinard'

@item 
`Barry Warsaw'

@item 
`Gustavo Niemeyer'
@end itemize

@subsubheading Notas al pie


@node locale — Internationalization services,,gettext — Multilingual internationalization services,Internacionalización
@anchor{library/locale doc}@anchor{3c2b}@anchor{library/locale locale-internationalization-services}@anchor{3c2c}@anchor{library/locale module-locale}@anchor{86}
@subsection @code{locale} — Internationalization services


@geindex module; locale

`Source code:' Lib/locale.py@footnote{https://github.com/python/cpython/tree/main/Lib/locale.py}


__________________________________________________________________


El módulo @ref{86,,locale} abre el acceso a la base de datos y la funcionalidad de POSIX locale. El mecanismo POSIX locale permite a los programadores tratar ciertos problemas culturales en una aplicación, sin requerir que el programador conozca todos los detalles de cada país donde se ejecuta el software.

@geindex module;_locale

The @ref{86,,locale} module is implemented on top of the @code{_locale} module,
which in turn uses an ANSI C locale implementation if available.

El módulo @ref{86,,locale} define las siguientes excepciones y funciones:

@geindex Error
@anchor{library/locale locale Error}@anchor{3c2d}
@deffn {Excepción} locale.Error

Cuando el `locale' pasado a @ref{1d2,,setlocale()} no es reconocido, se lanza una excepción.
@end deffn

@geindex setlocale() (en el módulo locale)
@anchor{library/locale locale setlocale}@anchor{1d2}
@deffn {Función} locale.setlocale (category, locale=None)

Si `locale' está dado y no es @code{None}, @ref{1d2,,setlocale()} modifica la configuración de localización para `category'. Las categorías disponibles se enumeran en la descripción de los datos que figura a continuación. `locale' puede ser una cadena de caracteres, o una iterable de dos cadenas de caracteres (código de idioma y codificación). Si es iterable, se convierte a un nombre de configuración regional usando el motor de `aliasing' de la configuración regional. Una cadena de caracteres vacía especifica la configuración predeterminada del usuario. Si la modificación de la localización falla, se genera la excepción  @ref{3c2d,,Error} . Si tiene éxito, se retorna la nueva configuración de localización.

Si se omite `locale' o es @code{None}, se retorna la configuración actual para `category'.

@ref{1d2,,setlocale()} no es seguro para subprocesos en la mayoría de los sistemas. Las aplicaciones normalmente comienzan con una llamada de

@example
import locale
locale.setlocale(locale.LC_ALL, '@w{'})
@end example

Esto establece la configuración regional de todas las categorías en la configuración predeterminada del usuario (normalmente especificada en la variable de entorno 
@geindex LANG
@geindex variables de entorno; LANG
@code{LANG} ).  Si la configuración regional no se cambia a partir de entonces, el uso de multiprocesamiento, no debería causar problemas.
@end deffn

@geindex localeconv() (en el módulo locale)
@anchor{library/locale locale localeconv}@anchor{c86}
@deffn {Función} locale.localeconv ()

Retorna la base de datos de las convenciones locales como diccionario. Este diccionario tiene las siguientes cadenas de caracteres como claves:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Categoría

@tab

Clave

@tab

Significado

@item

@ref{3c2e,,LC_NUMERIC}

@tab

@code{'decimal_point'}

@tab

Carácter de punto decimal.

@item

@tab

@code{'agrupación'}

@tab

Secuencia de números que especifica qué posiciones relativas se espera el @code{'miles_sep'}. Si la secuencia termina con @ref{3c2f,,CHAR_MAX}, no se realiza ninguna agrupación adicional. Si la secuencia termina con un @code{0}, el último tamaño de grupo se usa repetidamente.

@item

@tab

@code{'thousands_sep'}

@tab

Carácter utilizado entre grupos.

@item

@ref{3c30,,LC_MONETARY}

@tab

@code{'int_curr_symbol'}

@tab

Símbolo de moneda internacional.

@item

@tab

@code{'currency_symbol'}

@tab

Símbolo de moneda local.

@item

@tab

@code{'p_cs_precedes/n_cs_precedes'}

@tab

Si el símbolo de moneda precede al valor (para valores positivos o negativos).

@item

@tab

@code{'p_sep_by_space/n_sep_by_space'}

@tab

Si el símbolo de moneda está separado del valor por un espacio (para valores positivos o negativos).

@item

@tab

@code{'mon_decimal_point'}

@tab

Punto decimal utilizado para valores monetarios.

@item

@tab

@code{'frac_digits'}

@tab

Número de dígitos fraccionarios utilizados en el formateo local de valores monetarios.

@item

@tab

@code{'int_frac_digits'}

@tab

Número de dígitos fraccionarios utilizados en el formateo internacional de valores monetarios.

@item

@tab

@code{'mon_thousands_sep'}

@tab

Separador de grupo utilizado para valores monetarios.

@item

@tab

@code{'mon_grouping'}

@tab

Equivalente a @code{'grouping'}, utilizada para valores monetarios.

@item

@tab

@code{'positive_sign'}

@tab

Símbolo utilizado para anotar un valor monetario positivo.

@item

@tab

@code{'negative_sign'}

@tab

Símbolo utilizado para anotar un valor monetario negativo.

@item

@tab

@code{'p_sign_posn/n_sign_posn'}

@tab

La posición del signo (para respuestas positivas. valores negativos), ver abajo.

@end multitable


Todos los valores numéricos se pueden establecer a @ref{3c2f,,CHAR_MAX} para indicar que no hay ningún valor especificado en esta configuración regional.

Los valores posibles para @code{'p_sign_posn'} y @code{'n_sign_posn'} se dan a continuación.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Explicación

@item

@code{0}

@tab

Moneda y valor están rodeados por paréntesis.

@item

@code{1}

@tab

El signo debe preceder al valor y al símbolo de moneda.

@item

@code{2}

@tab

El signo debe seguir el valor y el símbolo de moneda.

@item

@code{3}

@tab

El signo debe preceder inmediatamente al valor.

@item

@code{4}

@tab

El signo debe seguir inmediatamente al valor.

@item

@code{CHAR_MAX}

@tab

No se especifica nada en esta configuración regional.

@end multitable


The function temporarily sets the @code{LC_CTYPE} locale to the @code{LC_NUMERIC}
locale or the @code{LC_MONETARY} locale if locales are different and numeric or
monetary strings are non-ASCII. This temporary change affects other threads.


Distinto en la versión 3.7: The function now temporarily sets the @code{LC_CTYPE} locale to the
@code{LC_NUMERIC} locale in some cases.

@end deffn

@geindex nl_langinfo() (en el módulo locale)
@anchor{library/locale locale nl_langinfo}@anchor{22f}
@deffn {Función} locale.nl_langinfo (option)

Retorna información específica de la configuración regional como una cadena de caracteres.  Esta función no está disponible en todos los sistemas, y el conjunto de opciones posibles también puede variar entre plataformas.  Los posibles valores de argumento son números, para los cuales las constantes simbólicas están disponibles en el módulo de configuración regional.

La función @ref{22f,,nl_langinfo()} acepta una de las siguientes claves.  La mayoría de las descripciones están tomadas de la descripción correspondiente en la biblioteca C de GNU.

@geindex CODESET (en el módulo locale)
@anchor{library/locale locale CODESET}@anchor{3c31}
@deffn {Dato} locale.CODESET

Obtiene una cadena de caracteres con el nombre de la codificación de caracteres utilizada en la configuración regional seleccionada.
@end deffn

@geindex D_T_FMT (en el módulo locale)
@anchor{library/locale locale D_T_FMT}@anchor{3c32}
@deffn {Dato} locale.D_T_FMT

Obtiene una cadena de caracteres que se puede utilizar como cadena de caracteres de formato para @ref{1256,,time.strftime()} para representar la fecha y la hora de una manera específica de la configuración regional.
@end deffn

@geindex D_FMT (en el módulo locale)
@anchor{library/locale locale D_FMT}@anchor{3c33}
@deffn {Dato} locale.D_FMT

Obtiene una cadena de caracteres que se puede utilizar como cadena de formato para @ref{1256,,time.strftime()} para representar una fecha de una manera específica de la configuración regional.
@end deffn

@geindex T_FMT (en el módulo locale)
@anchor{library/locale locale T_FMT}@anchor{3c34}
@deffn {Dato} locale.T_FMT

Obtiene una cadena de caracteres que se puede utilizar como cadena de formato para @ref{1256,,time.strftime()} para representar un tiempo de una manera específica de la configuración regional.
@end deffn

@geindex T_FMT_AMPM (en el módulo locale)
@anchor{library/locale locale T_FMT_AMPM}@anchor{3c35}
@deffn {Dato} locale.T_FMT_AMPM

Obtiene una cadena de caracteres de formato para @ref{1256,,time.strftime()} para representar el tiempo en el formato am/pm.
@end deffn

@geindex DAY_1 (en el módulo locale)
@geindex DAY_2 (en el módulo locale)
@geindex DAY_3 (en el módulo locale)
@geindex DAY_4 (en el módulo locale)
@geindex DAY_5 (en el módulo locale)
@geindex DAY_6 (en el módulo locale)
@geindex DAY_7 (en el módulo locale)
@anchor{library/locale locale DAY_1}@anchor{3c36}
@deffn {Dato} locale.DAY_1
@anchor{library/locale locale DAY_2}@anchor{3c37}
@deffnx {Dato} locale.DAY_2
@anchor{library/locale locale DAY_3}@anchor{3c38}
@deffnx {Dato} locale.DAY_3
@anchor{library/locale locale DAY_4}@anchor{3c39}
@deffnx {Dato} locale.DAY_4
@anchor{library/locale locale DAY_5}@anchor{3c3a}
@deffnx {Dato} locale.DAY_5
@anchor{library/locale locale DAY_6}@anchor{3c3b}
@deffnx {Dato} locale.DAY_6
@anchor{library/locale locale DAY_7}@anchor{3c3c}
@deffnx {Dato} locale.DAY_7

Consigue el nombre del n-ésimo día de la semana.

@cartouche
@quotation Nota 
Esto sigue la convención estadounidense de @ref{3c36,,DAY_1} siendo domingo, no la convención internacional (ISO 8601) que el lunes es el primer día de la semana.
@end quotation
@end cartouche
@end deffn

@geindex ABDAY_1 (en el módulo locale)
@geindex ABDAY_2 (en el módulo locale)
@geindex ABDAY_3 (en el módulo locale)
@geindex ABDAY_4 (en el módulo locale)
@geindex ABDAY_5 (en el módulo locale)
@geindex ABDAY_6 (en el módulo locale)
@geindex ABDAY_7 (en el módulo locale)
@anchor{library/locale locale ABDAY_1}@anchor{3c3d}
@deffn {Dato} locale.ABDAY_1
@anchor{library/locale locale ABDAY_2}@anchor{3c3e}
@deffnx {Dato} locale.ABDAY_2
@anchor{library/locale locale ABDAY_3}@anchor{3c3f}
@deffnx {Dato} locale.ABDAY_3
@anchor{library/locale locale ABDAY_4}@anchor{3c40}
@deffnx {Dato} locale.ABDAY_4
@anchor{library/locale locale ABDAY_5}@anchor{3c41}
@deffnx {Dato} locale.ABDAY_5
@anchor{library/locale locale ABDAY_6}@anchor{3c42}
@deffnx {Dato} locale.ABDAY_6
@anchor{library/locale locale ABDAY_7}@anchor{3c43}
@deffnx {Dato} locale.ABDAY_7

Obtener el nombre abreviado del n-ésimo día de la semana.
@end deffn

@geindex MON_1 (en el módulo locale)
@geindex MON_2 (en el módulo locale)
@geindex MON_3 (en el módulo locale)
@geindex MON_4 (en el módulo locale)
@geindex MON_5 (en el módulo locale)
@geindex MON_6 (en el módulo locale)
@geindex MON_7 (en el módulo locale)
@geindex MON_8 (en el módulo locale)
@geindex MON_9 (en el módulo locale)
@geindex MON_10 (en el módulo locale)
@geindex MON_11 (en el módulo locale)
@geindex MON_12 (en el módulo locale)
@anchor{library/locale locale MON_1}@anchor{3c44}
@deffn {Dato} locale.MON_1
@anchor{library/locale locale MON_2}@anchor{3c45}
@deffnx {Dato} locale.MON_2
@anchor{library/locale locale MON_3}@anchor{3c46}
@deffnx {Dato} locale.MON_3
@anchor{library/locale locale MON_4}@anchor{3c47}
@deffnx {Dato} locale.MON_4
@anchor{library/locale locale MON_5}@anchor{3c48}
@deffnx {Dato} locale.MON_5
@anchor{library/locale locale MON_6}@anchor{3c49}
@deffnx {Dato} locale.MON_6
@anchor{library/locale locale MON_7}@anchor{3c4a}
@deffnx {Dato} locale.MON_7
@anchor{library/locale locale MON_8}@anchor{3c4b}
@deffnx {Dato} locale.MON_8
@anchor{library/locale locale MON_9}@anchor{3c4c}
@deffnx {Dato} locale.MON_9
@anchor{library/locale locale MON_10}@anchor{3c4d}
@deffnx {Dato} locale.MON_10
@anchor{library/locale locale MON_11}@anchor{3c4e}
@deffnx {Dato} locale.MON_11
@anchor{library/locale locale MON_12}@anchor{3c4f}
@deffnx {Dato} locale.MON_12

Obtener el nombre del n-ésimo mes.
@end deffn

@geindex ABMON_1 (en el módulo locale)
@geindex ABMON_2 (en el módulo locale)
@geindex ABMON_3 (en el módulo locale)
@geindex ABMON_4 (en el módulo locale)
@geindex ABMON_5 (en el módulo locale)
@geindex ABMON_6 (en el módulo locale)
@geindex ABMON_7 (en el módulo locale)
@geindex ABMON_8 (en el módulo locale)
@geindex ABMON_9 (en el módulo locale)
@geindex ABMON_10 (en el módulo locale)
@geindex ABMON_11 (en el módulo locale)
@geindex ABMON_12 (en el módulo locale)
@anchor{library/locale locale ABMON_1}@anchor{3c50}
@deffn {Dato} locale.ABMON_1
@anchor{library/locale locale ABMON_2}@anchor{3c51}
@deffnx {Dato} locale.ABMON_2
@anchor{library/locale locale ABMON_3}@anchor{3c52}
@deffnx {Dato} locale.ABMON_3
@anchor{library/locale locale ABMON_4}@anchor{3c53}
@deffnx {Dato} locale.ABMON_4
@anchor{library/locale locale ABMON_5}@anchor{3c54}
@deffnx {Dato} locale.ABMON_5
@anchor{library/locale locale ABMON_6}@anchor{3c55}
@deffnx {Dato} locale.ABMON_6
@anchor{library/locale locale ABMON_7}@anchor{3c56}
@deffnx {Dato} locale.ABMON_7
@anchor{library/locale locale ABMON_8}@anchor{3c57}
@deffnx {Dato} locale.ABMON_8
@anchor{library/locale locale ABMON_9}@anchor{3c58}
@deffnx {Dato} locale.ABMON_9
@anchor{library/locale locale ABMON_10}@anchor{3c59}
@deffnx {Dato} locale.ABMON_10
@anchor{library/locale locale ABMON_11}@anchor{3c5a}
@deffnx {Dato} locale.ABMON_11
@anchor{library/locale locale ABMON_12}@anchor{3c5b}
@deffnx {Dato} locale.ABMON_12

Obtener el nombre abreviado del enésimo mes.
@end deffn

@geindex RADIXCHAR (en el módulo locale)
@anchor{library/locale locale RADIXCHAR}@anchor{3c5c}
@deffn {Dato} locale.RADIXCHAR

Obtener el carácter radical (punto decimal, coma decimal, etc.).
@end deffn

@geindex THOUSEP (en el módulo locale)
@anchor{library/locale locale THOUSEP}@anchor{3c5d}
@deffn {Dato} locale.THOUSEP

Obtener el carácter separador de miles (grupos de tres dígitos).
@end deffn

@geindex YESEXPR (en el módulo locale)
@anchor{library/locale locale YESEXPR}@anchor{3c5e}
@deffn {Dato} locale.YESEXPR

Obtener una expresión regular que se pueda usar con la función regex para reconocer una respuesta positiva a una pregunta de sí / no.
@end deffn

@geindex NOEXPR (en el módulo locale)
@anchor{library/locale locale NOEXPR}@anchor{3c5f}
@deffn {Dato} locale.NOEXPR

Get a regular expression that can be used with the @code{regex(3)} function to
recognize a negative response to a yes/no question.

@cartouche
@quotation Nota 
The regular expressions for @ref{3c5e,,YESEXPR} and
@ref{3c5f,,NOEXPR} use syntax suitable for the
@code{regex} function from the C library, which might
differ from the syntax used in @ref{b9,,re}.
@end quotation
@end cartouche
@end deffn

@geindex CRNCYSTR (en el módulo locale)
@anchor{library/locale locale CRNCYSTR}@anchor{3c60}
@deffn {Dato} locale.CRNCYSTR

Obtener el símbolo de moneda, precedido por «-» si el símbolo debe aparecer antes del valor, «+» si el símbolo debe aparecer después del valor, o «.» si el símbolo debe reemplazar el carácter raíz.
@end deffn

@geindex ERA (en el módulo locale)
@anchor{library/locale locale ERA}@anchor{3c61}
@deffn {Dato} locale.ERA

Obtener una cadena de caracteres que represente la era utilizada en la configuración regional actual.

La mayoría de las configuraciones regionales no definen este valor.  Un ejemplo de una localidad que sí define este valor es la japonesa.  En Japón, la representación tradicional de fechas incluye el nombre de la época correspondiente al reinado del entonces emperador.

Normalmente no debería ser necesario utilizar este valor directamente. Especificar el modificador @code{E} en sus cadenas de caracteres de formato hace que la función @ref{1256,,time.strftime()} use esta información. El formato de la cadena de caracteres retornada no está especificado, y por lo tanto no debe asumir conocimiento de él en diferentes sistemas.
@end deffn

@geindex ERA_D_T_FMT (en el módulo locale)
@anchor{library/locale locale ERA_D_T_FMT}@anchor{3c62}
@deffn {Dato} locale.ERA_D_T_FMT

Obtener una cadena de caracteres de formato para @ref{1256,,time.strftime()} para representar la fecha y la hora de una manera específica de la era.
@end deffn

@geindex ERA_D_FMT (en el módulo locale)
@anchor{library/locale locale ERA_D_FMT}@anchor{3c63}
@deffn {Dato} locale.ERA_D_FMT

Obtener una cadena de caracteres de formato para @ref{1256,,time.strftime()} para representar una fecha de una manera basada en una era específica.
@end deffn

@geindex ERA_T_FMT (en el módulo locale)
@anchor{library/locale locale ERA_T_FMT}@anchor{3c64}
@deffn {Dato} locale.ERA_T_FMT

Obtener una cadena de caracteres de formato para @ref{1256,,time.strftime()} para representar una hora de una manera basada en una era específica.
@end deffn

@geindex ALT_DIGITS (en el módulo locale)
@anchor{library/locale locale ALT_DIGITS}@anchor{3c65}
@deffn {Dato} locale.ALT_DIGITS

Get a string consisting of up to 100 semicolon-separated symbols used
to represent the values 0 to 99 in a locale-specific way.
In most locales this is an empty string.
@end deffn

The function temporarily sets the @code{LC_CTYPE} locale to the locale
of the category that determines the requested value (@code{LC_TIME},
@code{LC_NUMERIC}, @code{LC_MONETARY} or @code{LC_MESSAGES}) if locales are
different and the resulting string is non-ASCII.
This temporary change affects other threads.


Distinto en la versión 3.14: The function now temporarily sets the @code{LC_CTYPE} locale in some cases.

@end deffn

@geindex getdefaultlocale() (en el módulo locale)
@anchor{library/locale locale getdefaultlocale}@anchor{1d0}
@deffn {Función} locale.getdefaultlocale ([envvars])

Intenta determinar la configuración regional por defecto y los retorna como una tupla del formulario @code{(código de idioma, codificación)}.

De acuerdo con POSIX, un programa que no ha llamado a @code{setlocale(LC_ALL, '@w{'})} se ejecuta utilizando la configuración regional portátil @code{'C'} . Llamar a @code{setlocale(LC_ALL, ' ')} le permite usar la configuración regional predeterminada definida por la variable 
@geindex LANG
@geindex variables de entorno; LANG
@code{LANG} . Dado que no queremos interferir con la configuración de configuración regional actual, emulamos el comportamiento de la manera descrita anteriormente.

Para mantener la compatibilidad con otras plataformas, no sólo se prueba la variable 
@geindex LANG
@geindex variables de entorno; LANG
@code{LANG} sino una lista de variables dadas como parámetro `envvars'.  Se utilizará la primera que se encuentre definida.  `envvars' por defecto a la ruta de búsqueda utilizada en GNU gettext; siempre debe contener el nombre de la variable @code{'LANG '}.  La ruta de búsqueda GNU gettext contiene @code{'LC_ALL '}, @code{'LC_CTYPE '}, @code{'LANG '} y @code{'LANGUAGE '}, en ese orden.

Excepto por el código @code{'C'}, el código de lenguaje corresponde a 
@geindex RFC; RFC 1766
RFC 1766@footnote{https://datatracker.ietf.org/doc/html/rfc1766.html}. `language code' y `encoding' pueden ser @code{None} si sus valores no pueden determinarse.


Deprecated since version 3.11, will be removed in version 3.15.

@end deffn

@geindex getlocale() (en el módulo locale)
@anchor{library/locale locale getlocale}@anchor{1d1}
@deffn {Función} locale.getlocale (category=LC_CTYPE)

Returns the current setting for the given locale category as sequence containing
`language code', `encoding'. `category' may be one of the @code{LC_*} values
except @ref{3c66,,LC_ALL}.  It defaults to @ref{3c67,,LC_CTYPE}.

Excepto por el código @code{'C'}, el código de lenguaje corresponde a 
@geindex RFC; RFC 1766
RFC 1766@footnote{https://datatracker.ietf.org/doc/html/rfc1766.html}. `language code' y `encoding' pueden ser @code{None} si sus valores no pueden determinarse.
@end deffn

@geindex getpreferredencoding() (en el módulo locale)
@anchor{library/locale locale getpreferredencoding}@anchor{5dc}
@deffn {Función} locale.getpreferredencoding (do_setlocale=True)

Retorna la @ref{39b,,locale encoding} utilizada para los datos de texto, según las preferencias del usuario.  Las preferencias del usuario se expresan de manera diferente en diferentes sistemas, y puede que no estén disponibles programáticamente en algunos sistemas, por lo que esta función solo retorna una suposición.

En algunos sistemas, es necesario invocar @ref{1d2,,setlocale()} para obtener las preferencias del usuario, por lo que esta función no es segura para subprocesos. Si invocar `setlocale' no es necesario o deseado, `do_setlocale' se debe ajustar a @code{False}.

En Android o si @ref{6f7,,Python UTF-8 Mode} está habilitado, siempre retorna @code{'utf-8'}, el argumento @ref{39b,,locale encoding} y `do_setlocale' se ignoran.

La @ref{3c68,,pre-inicializacioń de Python} configura la configuración regional LC_CTYPE. Véase también la @ref{5dd,,codificación del sistema de archivos y manejador de errores}.


Distinto en la versión 3.7: La función ahora siempre retorna @code{"utf-8"} en Android o si @ref{6f7,,Python UTF-8 Mode} está habilitado.

@end deffn

@geindex getencoding() (en el módulo locale)
@anchor{library/locale locale getencoding}@anchor{1d3}
@deffn {Función} locale.getencoding ()

Obtenga el @ref{39b,,locale encoding} actual:


@itemize *

@item 
En Android y VxWorks, retorna @code{"utf-8"}.

@item 
En Unix, retorna la codificación de la configuración regional @ref{3c67,,LC_CTYPE} actual. Retorna @code{"utf-8"} si @code{nl_langinfo(CODESET)} retorna una cadena vacía: por ejemplo, si no se admite la configuración regional actual de LC_CTYPE.

@item 
En Windows, retorna la página de códigos ANSI.
@end itemize

La @ref{3c68,,pre-inicializacioń de Python} configura la configuración regional LC_CTYPE. Véase también la @ref{5dd,,codificación del sistema de archivos y manejador de errores}.

Esta función es similar a @ref{5dc,,getpreferredencoding(False)} excepto que esta función ignora @ref{6f7,,Python UTF-8 Mode}.


Added in version 3.11.

@end deffn

@geindex normalize() (en el módulo locale)
@anchor{library/locale locale normalize}@anchor{3c69}
@deffn {Función} locale.normalize (localename)

Retorna un código de configuración regional normalizado para el nombre configuración regional dado.  El código de configuración regional retornado está formateado para usarse con @ref{1d2,,setlocale()}.  Si la normalización falla, el nombre original se retorna sin cambios.

Si no se conoce la codificación dada, la función por defecto codifica el código de configuración regional como @ref{1d2,,setlocale()}.
@end deffn

@geindex strcoll() (en el módulo locale)
@anchor{library/locale locale strcoll}@anchor{3c6a}
@deffn {Función} locale.strcoll (string1, string2)

Compara dos cadenas según la configuración actual @ref{3c6b,,LC_COLLATE} . Como cualquier otra función de comparación, retorna un valor negativo o positivo, o @code{0}, dependiendo de si `string1' compila antes o después de `string2' o es igual a él.
@end deffn

@geindex strxfrm() (en el módulo locale)
@anchor{library/locale locale strxfrm}@anchor{3c6c}
@deffn {Función} locale.strxfrm (string)

Transforma una cadena en una que se puede utilizar en comparaciones de localización.  Por ejemplo, @code{strxfrm(s1) < strxfrm(s2)} es equivalente a @code{strcoll(s1, s2) < 0}.  Esta función se puede utilizar cuando la misma cadena se compara repetidamente, p. ej., al agrupar una secuencia de cadenas.
@end deffn

@geindex format_string() (en el módulo locale)
@anchor{library/locale locale format_string}@anchor{5c2}
@deffn {Función} locale.format_string (format, val, grouping=False, monetary=False)

Formats a number `val' according to the current @ref{3c2e,,LC_NUMERIC} setting.
The format follows the conventions of the @code{%} operator.  For floating-point
values, the decimal point is modified if appropriate.  If `grouping' is @code{True},
also takes the grouping into account.

Si `monetary' es verdadero, la conversión utiliza separador monetario de miles y cadenas de caracteres de agrupación.

Procesa especificadores de formato como en @code{format % val}, pero tiene en cuenta los ajustes de configuración regional actuales.


Distinto en la versión 3.7: Se añadió el parámetro de la palabra clave `monetary'.

@end deffn

@geindex currency() (en el módulo locale)
@anchor{library/locale locale currency}@anchor{3c6d}
@deffn {Función} locale.currency (val, symbol=True, grouping=False, international=False)

Formatea un número `val' según la configuración actual @ref{3c30,,LC_MONETARY} .

The returned string includes the currency symbol if `symbol' is true, which is
the default. If `grouping' is @code{True} (which is not the default), grouping is done
with the value. If `international' is @code{True} (which is not the default), the
international currency symbol is used.

@cartouche
@quotation Nota 
This function will not work with the “C” locale, so you have to set a
locale via @ref{1d2,,setlocale()} first.
@end quotation
@end cartouche
@end deffn

@geindex str() (en el módulo locale)
@anchor{library/locale locale str}@anchor{3c6e}
@deffn {Función} locale.str (float)

Formats a floating-point number using the same format as the built-in function
@code{str(float)}, but takes the decimal point into account.
@end deffn

@geindex delocalize() (en el módulo locale)
@anchor{library/locale locale delocalize}@anchor{eaa}
@deffn {Función} locale.delocalize (string)

Convierte una cadena de caracteres en una cadena de números normalizada, siguiendo la configuración @ref{3c2e,,LC_NUMERIC}.


Added in version 3.5.

@end deffn

@geindex localize() (en el módulo locale)
@anchor{library/locale locale localize}@anchor{3c6f}
@deffn {Función} locale.localize (string, grouping=False, monetary=False)

Convierte una cadena de números normalizada en una cadena de caracteres formateada siguiendo la configuración @ref{3c2e,,LC_NUMERIC}.


Added in version 3.10.

@end deffn

@geindex atof() (en el módulo locale)
@anchor{library/locale locale atof}@anchor{3c70}
@deffn {Función} locale.atof (string, func=float)

Convierte una cadena en un número, siguiendo la configuración de @ref{3c2e,,LC_NUMERIC}, llamando a `func' según el resultado de llamar a @ref{eaa,,delocalize()} en `string'.
@end deffn

@geindex atoi() (en el módulo locale)
@anchor{library/locale locale atoi}@anchor{3c71}
@deffn {Función} locale.atoi (string)

Convierte una cadena de caracteres a un entero, siguiendo las convenciones @ref{3c2e,,LC_NUMERIC} .
@end deffn

@geindex LC_CTYPE (en el módulo locale)
@anchor{library/locale locale LC_CTYPE}@anchor{3c67}
@deffn {Dato} locale.LC_CTYPE

Locale category for the character type functions.  Most importantly, this
category defines the text encoding, i.e. how bytes are interpreted as
Unicode codepoints.  See 
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} and 
@geindex Python Enhancement Proposals; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} for how this variable
might be automatically coerced to @code{C.UTF-8} to avoid issues created by
invalid settings in containers or incompatible settings passed over remote
SSH connections.

Python doesn’t internally use locale-dependent character transformation functions
from @code{ctype.h}. Instead, an internal @code{pyctype.h} provides locale-independent
equivalents like @code{Py_TOLOWER}.
@end deffn

@geindex LC_COLLATE (en el módulo locale)
@anchor{library/locale locale LC_COLLATE}@anchor{3c6b}
@deffn {Dato} locale.LC_COLLATE

Categoría de configuración regional para ordenar cadenas de caracteres.  Las funciones @ref{3c6a,,strcoll()} y @ref{3c6c,,strxfrm()} del módulo @ref{86,,locale} están afectadas.
@end deffn

@geindex LC_TIME (en el módulo locale)
@anchor{library/locale locale LC_TIME}@anchor{3c72}
@deffn {Dato} locale.LC_TIME

Categoría de configuración regional para el formateo de hora.  La función @ref{1256,,time.strftime()} sigue estas convenciones.
@end deffn

@geindex LC_MONETARY (en el módulo locale)
@anchor{library/locale locale LC_MONETARY}@anchor{3c30}
@deffn {Dato} locale.LC_MONETARY

Categoría de configuración regional para el formateo de valores monetarios.  Las opciones disponibles están disponibles en la función @ref{c86,,localeconv()} .
@end deffn

@geindex LC_MESSAGES (en el módulo locale)
@anchor{library/locale locale LC_MESSAGES}@anchor{3c73}
@deffn {Dato} locale.LC_MESSAGES

Categoría de configuración regional para visualización de mensajes. Python actualmente no admite mensajes de configuración regional específicos de la aplicación.  Los mensajes mostrados por el sistema operativo, como los retornados por @ref{2b28,,os.strerror()} podrían verse afectados por esta categoría.

This value may not be available on operating systems not conforming to the
POSIX standard, most notably Windows.
@end deffn

@geindex LC_NUMERIC (en el módulo locale)
@anchor{library/locale locale LC_NUMERIC}@anchor{3c2e}
@deffn {Dato} locale.LC_NUMERIC

Locale category for formatting numbers.  The functions @ref{5c2,,format_string()},
@ref{3c71,,atoi()}, @ref{3c70,,atof()} and @ref{3c6e,,str()} of the @ref{86,,locale} module are
affected by that category.  All other numeric formatting operations are not
affected.
@end deffn

@geindex LC_ALL (en el módulo locale)
@anchor{library/locale locale LC_ALL}@anchor{3c66}
@deffn {Dato} locale.LC_ALL

Combinación de todos los ajustes de configuración regional.  Si se utiliza este indicador cuando se cambia la localización, se intenta establecer la localización para todas las categorías. Si eso falla para cualquier categoría, ninguna categoría se cambia en absoluto.  Cuando la configuración regional se recupera usando este indicador, se retorna una cadena de caracteres que indica la configuración para todas las categorías. Esta cadena de caracteres se puede usar más tarde para restaurar la configuración.
@end deffn

@geindex CHAR_MAX (en el módulo locale)
@anchor{library/locale locale CHAR_MAX}@anchor{3c2f}
@deffn {Dato} locale.CHAR_MAX

Esta es una constante simbólica utilizada para diferentes valores retornados por @ref{c86,,localeconv()}.
@end deffn

Ejemplo:

@example
>>> import locale
>>> loc = locale.getlocale()  # get current locale
# use German locale; name might vary with platform
>>> locale.setlocale(locale.LC_ALL, 'de_DE')
>>> locale.strcoll('f\xe4n', 'foo')  # compare a string containing an umlaut
>>> locale.setlocale(locale.LC_ALL, '@w{'})   # use user's preferred locale
>>> locale.setlocale(locale.LC_ALL, 'C')  # use default (C) locale
>>> locale.setlocale(locale.LC_ALL, loc)  # restore saved locale
@end example

@menu
* Segundo plano@comma{} detalles@comma{} indicaciones@comma{} consejos y advertencias: Segundo plano detalles indicaciones consejos y advertencias. 
* Para escritores de extensión y programas que incrustan Python:: 
* Acceso a los catálogos de mensajes:: 

@end menu

@node Segundo plano detalles indicaciones consejos y advertencias,Para escritores de extensión y programas que incrustan Python,,locale — Internationalization services
@anchor{library/locale background-details-hints-tips-and-caveats}@anchor{3c74}
@subsubsection Segundo plano, detalles, indicaciones, consejos y advertencias


El estándar C define la configuración regional como una propiedad de todo el programa que puede ser relativamente costosa de cambiar.  Además de eso, alguna implementación se rompe de tal manera que los cambios de configuración local frecuentes pueden causar volcados de núcleo.  Esto hace que la configuración regional sea algo dolorosa de usar correctamente.

Inicialmente, cuando se inicia un programa, la configuración regional es la configuración regional @code{C}, no importa cuál sea la configuración regional preferida por el usuario.  Hay una excepción: la categoría @ref{3c67,,LC_CTYPE} se cambia al inicio para establecer la codificación de la configuración regional actual en la codificación de configuración regional preferida del usuario. El programa debe decir explícitamente que quiere la configuración regional preferida del usuario para otras categorías llamando a @code{setlocale(LC_ALL, '@w{'})}.

Generalmente es una mala idea llamar @ref{1d2,,setlocale()} en alguna rutina de biblioteca, ya que como efecto secundario afecta a todo el programa.  Guardar y restaurar es casi igual de malo: es caro y afecta a otros hilos que se ejecutan antes de que los ajustes se hayan restaurado.

Si, al codificar un módulo para uso general, se necesita una versión configuración regional independiente de una operación que se ve afectada por la localización (como ciertos formatos utilizados con @ref{1256,,time.strftime()}), tendrá que encontrar una manera de hacerlo sin usar la rutina de biblioteca estándar.  Aún mejor es convencerse a sí mismo de que el uso de la configuración regional está bien.  Sólo como último recurso debe documentar que su módulo no es compatible con la configuración regional no-   @code{C}.

The only way to perform numeric operations according to the locale is to use the
special functions defined by this module: @ref{3c70,,atof()}, @ref{3c71,,atoi()},
@ref{5c2,,format_string()}, @ref{3c6e,,str()}.

No hay manera de realizar conversiones de casos y clasificaciones de caracteres de acuerdo a la configuración regional.  Para cadenas de texto (Unicode) estas se hacen de acuerdo con el valor de carácter solamente, mientras que para cadenas de bytes, las conversiones y clasificaciones se hacen de acuerdo con el valor ASCII del byte, y bytes cuyo bit alto se establece (es decir, bytes no ASCII) nunca se convierten o se consideran parte de una clase de caracteres como letra o espacio en blanco.

@node Para escritores de extensión y programas que incrustan Python,Acceso a los catálogos de mensajes,Segundo plano detalles indicaciones consejos y advertencias,locale — Internationalization services
@anchor{library/locale embedding-locale}@anchor{3c75}@anchor{library/locale for-extension-writers-and-programs-that-embed-python}@anchor{3c76}
@subsubsection Para escritores de extensión y programas que incrustan Python


Los módulos de extensión nunca deben llamar a @ref{1d2,,setlocale()}, excepto para averiguar cuál es la configuración regional actual.  Pero dado que el valor de retorno sólo se puede utilizar portablemente para restaurarlo, eso no es muy útil (excepto quizás para averiguar si la localización es o no es @code{C}).

When Python code uses the @ref{86,,locale} module to change the locale, this also
affects the embedding application.  If the embedding application doesn’t want
this to happen, it should remove the @code{_locale} extension module (which does
all the work) from the table of built-in modules in the @code{config.c} file,
and make sure that the @code{_locale} module is not accessible as a shared
library.

@node Acceso a los catálogos de mensajes,,Para escritores de extensión y programas que incrustan Python,locale — Internationalization services
@anchor{library/locale access-to-message-catalogs}@anchor{3c77}@anchor{library/locale locale-gettext}@anchor{3c78}
@subsubsection Acceso a los catálogos de mensajes


@geindex gettext() (en el módulo locale)
@anchor{library/locale locale gettext}@anchor{3c79}
@deffn {Función} locale.gettext (msg)
@end deffn

@geindex dgettext() (en el módulo locale)
@anchor{library/locale locale dgettext}@anchor{3c7a}
@deffn {Función} locale.dgettext (domain, msg)
@end deffn

@geindex dcgettext() (en el módulo locale)
@anchor{library/locale locale dcgettext}@anchor{3c7b}
@deffn {Función} locale.dcgettext (domain, msg, category)
@end deffn

@geindex textdomain() (en el módulo locale)
@anchor{library/locale locale textdomain}@anchor{3c7c}
@deffn {Función} locale.textdomain (domain)
@end deffn

@geindex bindtextdomain() (en el módulo locale)
@anchor{library/locale locale bindtextdomain}@anchor{3c7d}
@deffn {Función} locale.bindtextdomain (domain, dir)
@end deffn

@geindex bind_textdomain_codeset() (en el módulo locale)
@anchor{library/locale locale bind_textdomain_codeset}@anchor{3c7e}
@deffn {Función} locale.bind_textdomain_codeset (domain, codeset)
@end deffn

The locale module exposes the C library’s gettext interface on systems that
provide this interface.  It consists of the functions @ref{63,,gettext()},
@ref{3c7a,,dgettext()}, @ref{3c7b,,dcgettext()}, @ref{3c7c,,textdomain()}, @ref{3c7d,,bindtextdomain()},
and @ref{3c7e,,bind_textdomain_codeset()}.  These are similar to the same functions in
the @ref{63,,gettext} module, but use the C library’s binary format for message
catalogs, and the C library’s search algorithms for locating message catalogs.

Python applications should normally find no need to invoke these functions, and
should use @ref{63,,gettext} instead.  A known exception to this rule are
applications that link with additional C libraries which internally invoke
C functions @code{gettext} or @code{dcgettext}.  For these applications, it may be
necessary to bind the text domain, so that the libraries can properly locate
their message catalogs.

@node Frameworks de programa,Interfaces gráficas de usuario con Tk,Internacionalización,La biblioteca estándar de Python
@anchor{library/frameworks doc}@anchor{3c7f}@anchor{library/frameworks frameworks}@anchor{3c80}@anchor{library/frameworks program-frameworks}@anchor{3c81}
@section `Frameworks' de programa


Los módulos descritos en este capitulo son `frameworks' que dictarán en gran medida la estructura de su programa. Actualmente, los módulos descritos aquí están orientados para escribir en las interfaces de línea de comandos.

La lista completa de módulos descritos en este capítulo es:

@menu
* turtle — Gráficos con Turtle:: 
* cmd — Support for line-oriented command interpreters:: 
* shlex — Simple lexical analysis:: 

@end menu

@node turtle — Gráficos con Turtle,cmd — Support for line-oriented command interpreters,,Frameworks de programa
@anchor{library/turtle doc}@anchor{3c82}@anchor{library/turtle module-turtle}@anchor{101}@anchor{library/turtle turtle-turtle-graphics}@anchor{3c83}
@subsection @code{turtle} — Gráficos con `Turtle'


@geindex module; turtle

`Código fuente:' Lib/turtle.py@footnote{https://github.com/python/cpython/tree/main/Lib/turtle.py}

@c from turtle import *
@c turtle = Turtle()

@c import os
@c os.remove("my_drawing.ps")


__________________________________________________________________


@menu
* Introducción: Introducción<9>. 
* Get started:: 
* Tutorial: Tutorial<3>. 
* How to…:: 
* Turtle graphics reference:: 
* Métodos de RawTurtle/Turtle Y sus correspondientes funciones:: 
* Métodos de TurtleScreen/Screen y sus correspondientes funciones:: 
* Clases públicas:: 
* Explanation:: 
* Ayuda y configuración:: 
* turtledemo — Scripts de demostración:: 
* Cambios desde Python 2.6: Cambios desde Python 2 6. 
* Cambios desde Python 3.0: Cambios desde Python 3 0. 

@end menu

@node Introducción<9>,Get started,,turtle — Gráficos con Turtle
@anchor{library/turtle introduction}@anchor{3c84}
@subsubsection Introducción


Turtle graphics is an implementation of the popular geometric drawing tools introduced in Logo@footnote{https://en.wikipedia.org/wiki/Turtle_(robot)}, developed by Wally Feurzeig, Seymour Papert and Cynthia Solomon
in 1967.

@node Get started,Tutorial<3>,Introducción<9>,turtle — Gráficos con Turtle
@anchor{library/turtle get-started}@anchor{3c85}
@subsubsection Get started


Imagine a robotic turtle starting at (0, 0) in the x-y plane.  After an @code{import turtle}, give it the
command @code{turtle.forward(15)}, and it moves (on-screen!) 15 pixels in the
direction it is facing, drawing a line as it moves.  Give it the command
@code{turtle.right(25)}, and it rotates in-place 25 degrees clockwise.

@subsubheading Turtle star



Turtle puede dibujar figuras intrincadas usando programas que repiten movimientos simples.

@image{python-figures/turtle-star,,,,png}

In Python, turtle graphics provides a representation of a physical «turtle»
(a little robot with a pen) that draws on a sheet of paper on the floor.

It’s an effective and well-proven way for learners to encounter
programming concepts and interaction with software, as it provides instant,
visible feedback. It also provides convenient access to graphical output
in general.

Turtle drawing was originally created as an educational tool, to be used by
teachers in the classroom. For the programmer who needs to produce some
graphical output it can be a way to do that without the overhead of
introducing more complex or external libraries into their work.

@node Tutorial<3>,How to…,Get started,turtle — Gráficos con Turtle
@anchor{library/turtle turtle-tutorial}@anchor{3c86}@anchor{library/turtle tutorial}@anchor{3c87}
@subsubsection Tutorial


New users should start here. In this tutorial we’ll explore some of the
basics of turtle drawing.

@menu
* Starting a turtle environment:: 
* Basic drawing:: 
* Making algorithmic patterns:: 

@end menu

@node Starting a turtle environment,Basic drawing,,Tutorial<3>
@anchor{library/turtle starting-a-turtle-environment}@anchor{3c88}
@subsubsection Starting a turtle environment


In a Python shell, import all the objects of the @code{turtle} module:

@example
from turtle import *
@end example

If you run into a @code{No module named '_tkinter'} error, you’ll have to
install the @ref{f0,,Tk interface package} on your system.

@node Basic drawing,Making algorithmic patterns,Starting a turtle environment,Tutorial<3>
@anchor{library/turtle basic-drawing}@anchor{3c89}
@subsubsection Basic drawing


Send the turtle forward 100 steps:

@example
forward(100)
@end example

You should see (most likely, in a new window on your display) a line
drawn by the turtle, heading East. Change the direction of the turtle,
so that it turns 120 degrees left (anti-clockwise):

@example
left(120)
@end example

Let’s continue by drawing a triangle:

@example
forward(100)
left(120)
forward(100)
@end example

Notice how the turtle, represented by an arrow, points in different
directions as you steer it.

Experiment with those commands, and also with @code{backward()} and
@code{right()}.

@menu
* Control del lápiz:: 
* The turtle’s position:: 

@end menu

@node Control del lápiz,The turtle’s position,,Basic drawing
@anchor{library/turtle pen-control}@anchor{3c8a}
@subsubsection Control del lápiz


Try changing the color - for example, @code{color('blue')} - and
width of the line - for example, @code{width(3)} - and then drawing again.

You can also move the turtle around without drawing, by lifting up the pen:
@code{up()} before moving. To start drawing again, use @code{down()}.

@node The turtle’s position,,Control del lápiz,Basic drawing
@anchor{library/turtle the-turtle-s-position}@anchor{3c8b}
@subsubsection The turtle’s position


Send your turtle back to its starting-point (useful if it has disappeared
off-screen):

@example
home()
@end example

The home position is at the center of the turtle’s screen. If you ever need to
know them, get the turtle’s x-y coordinates with:

@example
pos()
@end example

Home is at @code{(0, 0)}.

And after a while, it will probably help to clear the window so we can start
anew:

@example
clearscreen()
@end example

@node Making algorithmic patterns,,Basic drawing,Tutorial<3>
@anchor{library/turtle making-algorithmic-patterns}@anchor{3c8c}
@subsubsection Making algorithmic patterns


Using loops, it’s possible to build up geometric patterns:

@example
for steps in range(100):
    for c in ('blue', 'red', 'green'):
        color(c)
        forward(steps)
        right(30)
@end example

- which of course, are limited only by the imagination!

Let’s draw the star shape at the top of this page. We want red lines,
filled in with yellow:

@example
color('red')
fillcolor('yellow')
@end example

Just as @code{up()} and @code{down()} determine whether lines will be drawn,
filling can be turned on and off:

@example
begin_fill()
@end example

Next we’ll create a loop:

@example
while True:
    forward(200)
    left(170)
    if abs(pos()) < 1:
        break
@end example

@code{abs(pos()) < 1} is a good way to know when the turtle is back at its
home position.

Finally, complete the filling:

@example
end_fill()
@end example

(Note that filling only actually takes place when you give the
@code{end_fill()} command.)

@node How to…,Turtle graphics reference,Tutorial<3>,turtle — Gráficos con Turtle
@anchor{library/turtle how-to}@anchor{3c8d}@anchor{library/turtle turtle-how-to}@anchor{3c8e}
@subsubsection How to…


This section covers some typical turtle use-cases and approaches.

@menu
* Get started as quickly as possible:: 
* Use the turtle module namespace:: 
* Use turtle graphics in a script:: 
* Use object-oriented turtle graphics:: 

@end menu

@node Get started as quickly as possible,Use the turtle module namespace,,How to…
@anchor{library/turtle get-started-as-quickly-as-possible}@anchor{3c8f}
@subsubsection Get started as quickly as possible


One of the joys of turtle graphics is the immediate, visual feedback that’s
available from simple commands - it’s an excellent way to introduce children
to programming ideas, with a minimum of overhead (not just children, of
course).

The turtle module makes this possible by exposing all its basic functionality
as functions, available with @code{from turtle import *}. The @ref{3c86,,turtle graphics tutorial} covers this approach.

It’s worth noting that many of the turtle commands also have even more terse
equivalents, such as @code{fd()} for @ref{3c90,,forward()}. These are especially
useful when working with learners for whom typing is not a skill.
@anchor{library/turtle note}@anchor{3c91}
@quotation

You’ll need to have the @ref{f0,,Tk interface package} installed on
your system for turtle graphics to work. Be warned that this is not
always straightforward, so check this in advance if you’re planning to
use turtle graphics with a learner.
@end quotation

@node Use the turtle module namespace,Use turtle graphics in a script,Get started as quickly as possible,How to…
@anchor{library/turtle use-the-turtle-module-namespace}@anchor{3c92}
@subsubsection Use the @code{turtle} module namespace


Using @code{from turtle import *} is convenient - but be warned that it imports a
rather large collection of objects, and if you’re doing anything but turtle
graphics you run the risk of a name conflict (this becomes even more an issue
if you’re using turtle graphics in a script where other modules might be
imported).

The solution is to use @code{import turtle} - @code{fd()} becomes
@code{turtle.fd()}, @code{width()} becomes @code{turtle.width()} and so on. (If typing
«turtle» over and over again becomes tedious, use for example @code{import turtle
as t} instead.)

@node Use turtle graphics in a script,Use object-oriented turtle graphics,Use the turtle module namespace,How to…
@anchor{library/turtle use-turtle-graphics-in-a-script}@anchor{3c93}
@subsubsection Use turtle graphics in a script


It’s recommended to use the @code{turtle} module namespace as described
immediately above, for example:

@example
import turtle as t
from random import random

for i in range(100):
    steps = int(random() * 100)
    angle = int(random() * 360)
    t.right(angle)
    t.fd(steps)
@end example

Another step is also required though - as soon as the script ends, Python
will also close the turtle’s window. Add:

@example
t.mainloop()
@end example

to the end of the script. The script will now wait to be dismissed and
will not exit until it is terminated, for example by closing the turtle
graphics window.

@node Use object-oriented turtle graphics,,Use turtle graphics in a script,How to…
@anchor{library/turtle use-object-oriented-turtle-graphics}@anchor{3c94}
@subsubsection Use object-oriented turtle graphics



@subsubheading Ver también


@ref{3c95,,Explanation of the object-oriented interface}


Other than for very basic introductory purposes, or for trying things out
as quickly as possible, it’s more usual and much more powerful to use the
object-oriented approach to turtle graphics. For example, this allows
multiple turtles on screen at once.

In this approach, the various turtle commands are methods of objects (mostly of
@code{Turtle} objects). You `can' use the object-oriented approach in the shell,
but it would be more typical in a Python script.

The example above then becomes:

@example
from turtle import Turtle
from random import random

t = Turtle()
for i in range(100):
    steps = int(random() * 100)
    angle = int(random() * 360)
    t.right(angle)
    t.fd(steps)

t.screen.mainloop()
@end example

Note the last line. @code{t.screen} is an instance of the @ref{3c96,,Screen}
that a Turtle instance exists on; it’s created automatically along with
the turtle.

The turtle’s screen can be customised, for example:

@example
t.screen.title('Object-oriented turtle demo')
t.screen.bgcolor("orange")
@end example

@node Turtle graphics reference,Métodos de RawTurtle/Turtle Y sus correspondientes funciones,How to…,turtle — Gráficos con Turtle
@anchor{library/turtle turtle-graphics-reference}@anchor{3c97}
@subsubsection Turtle graphics reference


@cartouche
@quotation Nota 
En la siguiente documentación se proporciona la listas de argumentos para las funciones. Los métodos, por su puesto, tienen el argumento principal adicional `self' que se omite aquí.
@end quotation
@end cartouche

@menu
* Métodos Turtle:: 
* Métodos de TurtleScreen/Screen:: 

@end menu

@node Métodos Turtle,Métodos de TurtleScreen/Screen,,Turtle graphics reference
@anchor{library/turtle turtle-methods}@anchor{3c98}
@subsubsection Métodos Turtle



@table @asis

@item Movimiento de Turtle


@table @asis

@item Mover y dibujar


@display
@ref{3c90,,forward()} | @ref{3c99,,fd()}@w{ }
@ref{3c9a,,backward()} | @ref{3c9b,,bk()} | @ref{3c9c,,back()}@w{ }
@ref{3c9d,,right()} | @ref{3c9e,,rt()}@w{ }
@ref{3c9f,,left()} | @ref{3ca0,,lt()}@w{ }
@ref{3ca1,,goto()} | @ref{3ca2,,setpos()} | @ref{3ca3,,setposition()}@w{ }
@ref{172d,,teleport()}@w{ }
@ref{3ca4,,setx()}@w{ }
@ref{3ca5,,sety()}@w{ }
@ref{3ca6,,setheading()} | @ref{3ca7,,seth()}@w{ }
@ref{3ca8,,home()}@w{ }
@ref{3ca9,,circle()}@w{ }
@ref{3caa,,dot()}@w{ }
@ref{3cab,,stamp()}@w{ }
@ref{3cac,,clearstamp()}@w{ }
@ref{3cad,,clearstamps()}@w{ }
@ref{3cae,,undo()}@w{ }
@ref{3caf,,speed()}@w{ }
@end display



@item Mostrar el estado de la tortuga


@display
@ref{3cb0,,position()} | @ref{3cb1,,pos()}@w{ }
@ref{3cb2,,towards()}@w{ }
@ref{3cb3,,xcor()}@w{ }
@ref{3cb4,,ycor()}@w{ }
@ref{3cb5,,heading()}@w{ }
@ref{3cb6,,distance()}@w{ }
@end display



@item Ajuste y unidades de medida


@display
@ref{3cb7,,degrees()}@w{ }
@ref{3cb8,,radians()}@w{ }
@end display


@end table

@item Control del lápiz


@table @asis

@item Estado de dibujo


@display
@ref{3cb9,,pendown()} | @ref{3cba,,pd()} | @ref{3cbb,,down()}@w{ }
@ref{3cbc,,penup()} | @ref{3cbd,,pu()} | @ref{3cbe,,up()}@w{ }
@ref{3cbf,,pensize()} | @ref{3cc0,,width()}@w{ }
@ref{3cc1,,pen()}@w{ }
@ref{3cc2,,isdown()}@w{ }
@end display



@item Control del color


@display
@ref{3cc3,,color()}@w{ }
@ref{3cc4,,pencolor()}@w{ }
@ref{3cc5,,fillcolor()}@w{ }
@end display



@item Relleno


@display
@ref{3cc6,,filling()}@w{ }
@ref{3cc7,,begin_fill()}@w{ }
@ref{3cc8,,end_fill()}@w{ }
@end display



@item Más controles de dibujo


@display
@ref{3cc9,,reset()}@w{ }
@ref{3cca,,clear()}@w{ }
@ref{3ccb,,write()}@w{ }
@end display


@end table

@item Estado de la Tortuga


@table @asis

@item Visibilidad


@display
@ref{3ccc,,showturtle()} | @ref{3ccd,,st()}@w{ }
@ref{3cce,,hideturtle()} | @ref{3ccf,,ht()}@w{ }
@ref{3cd0,,isvisible()}@w{ }
@end display



@item Apariencia


@display
@ref{3cd1,,shape()}@w{ }
@ref{3cd2,,resizemode()}@w{ }
@ref{3cd3,,shapesize()} | @ref{3cd4,,turtlesize()}@w{ }
@ref{3cd5,,shearfactor()}@w{ }
@ref{7c1,,tiltangle()}@w{ }
@ref{3cd6,,tilt()}@w{ }
@ref{3cd7,,shapetransform()}@w{ }
@ref{3cd8,,get_shapepoly()}@w{ }
@end display


@end table

@item Usando eventos


@display
@ref{3cd9,,onclick()}@w{ }
@ref{3cda,,onrelease()}@w{ }
@ref{3cdb,,ondrag()}@w{ }
@end display



@item Métodos especiales de `Turtle'


@display
@ref{3cdc,,begin_poly()}@w{ }
@ref{3cdd,,end_poly()}@w{ }
@ref{3cde,,get_poly()}@w{ }
@ref{3cdf,,clone()}@w{ }
@ref{3ce0,,getturtle()} | @ref{3ce1,,getpen()}@w{ }
@ref{3ce2,,getscreen()}@w{ }
@ref{3ce3,,setundobuffer()}@w{ }
@ref{3ce4,,undobufferentries()}@w{ }
@end display


@end table

@node Métodos de TurtleScreen/Screen,,Métodos Turtle,Turtle graphics reference
@anchor{library/turtle methods-of-turtlescreen-screen}@anchor{3ce5}
@subsubsection Métodos de TurtleScreen/Screen



@table @asis

@item Control de ventana


@display
@ref{3ce6,,bgcolor()}@w{ }
@ref{3ce7,,bgpic()}@w{ }
@ref{3ce8,,clearscreen()}@w{ }
@ref{3ce9,,resetscreen()}@w{ }
@ref{3cea,,screensize()}@w{ }
@ref{3ceb,,setworldcoordinates()}@w{ }
@end display



@item Control de animación


@display
@ref{3cec,,delay()}@w{ }
@ref{3ced,,tracer()}@w{ }
@ref{3cee,,update()}@w{ }
@end display



@item Usando eventos de pantalla


@display
@ref{3cef,,listen()}@w{ }
@ref{3cf0,,onkey()} | @ref{3cf1,,onkeyrelease()}@w{ }
@ref{3cf2,,onkeypress()}@w{ }
@ref{3cd9,,onclick()} | @ref{3cf3,,onscreenclick()}@w{ }
@ref{3cf4,,ontimer()}@w{ }
@ref{3cf5,,mainloop()} | @ref{3cf6,,done()}@w{ }
@end display



@item Configuración y métodos especiales


@display
@ref{3cf7,,mode()}@w{ }
@ref{3cf8,,colormode()}@w{ }
@ref{3cf9,,getcanvas()}@w{ }
@ref{3cfa,,getshapes()}@w{ }
@ref{3cfb,,register_shape()} | @ref{3cfc,,addshape()}@w{ }
@ref{3cfd,,turtles()}@w{ }
@ref{3cfe,,window_height()}@w{ }
@ref{3cff,,window_width()}@w{ }
@end display



@item Métodos de entrada


@display
@ref{18cb,,textinput()}@w{ }
@ref{18cc,,numinput()}@w{ }
@end display



@item Métodos específicos para `Screen'


@display
@ref{3d00,,bye()}@w{ }
@ref{3d01,,exitonclick()}@w{ }
@ref{160e,,save()}@w{ }
@ref{3d02,,setup()}@w{ }
@ref{3d03,,title()}@w{ }
@end display


@end table

@node Métodos de RawTurtle/Turtle Y sus correspondientes funciones,Métodos de TurtleScreen/Screen y sus correspondientes funciones,Turtle graphics reference,turtle — Gráficos con Turtle
@anchor{library/turtle methods-of-rawturtle-turtle-and-corresponding-functions}@anchor{3d04}
@subsubsection Métodos de `RawTurtle/Turtle' Y sus correspondientes funciones


Casi todos los ejemplos de esta sección se refieren a una instancia Turtle llamada @code{turtle}.

@menu
* Movimiento de Turtle:: 
* Mostrar el estado de la tortuga:: 
* Configuración de las medidas:: 
* Control del lápiz: Control del lápiz<2>. 
* Estado de la Tortuga:: 
* Usando eventos:: 
* Métodos especiales de Turtle:: 
* Formas compuestas:: 

@end menu

@node Movimiento de Turtle,Mostrar el estado de la tortuga,,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle turtle-motion}@anchor{3d05}
@subsubsection Movimiento de Turtle


@geindex forward() (en el módulo turtle)
@geindex fd() (en el módulo turtle)
@anchor{library/turtle turtle forward}@anchor{3c90}
@deffn {Función} turtle.forward (distance)
@anchor{library/turtle turtle fd}@anchor{3c99}
@deffnx {Función} turtle.fd (distance)

@*Parámetros: 
@code{distance} – un número (entero o flotante)


Mover hacia adelante la tortuga la `ditance' especificada, en la dirección en la que la tortuga apunta.

@example
>>> turtle.position()
(0.00,0.00)
>>> turtle.forward(25)
>>> turtle.position()
(25.00,0.00)
>>> turtle.forward(-75)
>>> turtle.position()
(-50.00,0.00)
@end example
@end deffn

@geindex back() (en el módulo turtle)
@geindex bk() (en el módulo turtle)
@geindex backward() (en el módulo turtle)
@anchor{library/turtle turtle back}@anchor{3c9c}
@deffn {Función} turtle.back (distance)
@anchor{library/turtle turtle bk}@anchor{3c9b}
@deffnx {Función} turtle.bk (distance)
@anchor{library/turtle turtle backward}@anchor{3c9a}
@deffnx {Función} turtle.backward (distance)

@*Parámetros: 
@code{distance} – un número


Mover hacia atrás la tortuga la `distance' especificada, opuesta a la dirección en que la tortuga apunta. No cambia la dirección de la tortuga.

@c >>> turtle.goto(0, 0)

@example
>>> turtle.position()
(0.00,0.00)
>>> turtle.backward(30)
>>> turtle.position()
(-30.00,0.00)
@end example
@end deffn

@geindex right() (en el módulo turtle)
@geindex rt() (en el módulo turtle)
@anchor{library/turtle turtle right}@anchor{3c9d}
@deffn {Función} turtle.right (angle)
@anchor{library/turtle turtle rt}@anchor{3c9e}
@deffnx {Función} turtle.rt (angle)

@*Parámetros: 
@code{angle} – un número (entero o flotante)


Gira la tortuga a la derecha tomando los `angle' como unidad de medida. (La unidad de medida por defecto son los grado, pero se puede configurar a través de las funciones @ref{3cb7,,degrees()} y @ref{3cb8,,radians()}.) La orientación de los ángulos depende del modo en que está la tortuga, ver @ref{3cf7,,mode()}.

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.right(45)
>>> turtle.heading()
337.0
@end example
@end deffn

@geindex left() (en el módulo turtle)
@geindex lt() (en el módulo turtle)
@anchor{library/turtle turtle left}@anchor{3c9f}
@deffn {Función} turtle.left (angle)
@anchor{library/turtle turtle lt}@anchor{3ca0}
@deffnx {Función} turtle.lt (angle)

@*Parámetros: 
@code{angle} – un número (entero o flotante)


Gira la tortuga a la izquierda tomando los `ángulos' como unidad de medida. (La unidad de medida por defecto son los grado, pero se puede configurar a través de las funciones @ref{3cb7,,degrees()} y @ref{3cb8,,radians()}.) La orientación de los ángulos depende del modo en que está la tortuga, ver @ref{3cf7,,mode()}.

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.left(45)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex goto() (en el módulo turtle)
@geindex setpos() (en el módulo turtle)
@geindex setposition() (en el módulo turtle)
@anchor{library/turtle turtle goto}@anchor{3ca1}
@deffn {Función} turtle.goto (x, y=None)
@anchor{library/turtle turtle setpos}@anchor{3ca2}
@deffnx {Función} turtle.setpos (x, y=None)
@anchor{library/turtle turtle setposition}@anchor{3ca3}
@deffnx {Función} turtle.setposition (x, y=None)

@*Parámetros: 

@itemize *

@item 
@code{x} – un número o un par/vector de números

@item 
@code{y} – un número o @code{None}
@end itemize


Si `y' es @code{None}, `x' debe ser un par de coordenadas o un @ref{3d06,,Vec2D} (ejemplo: según lo devuelto por @ref{3cb1,,pos()}).

Mueve la tortuga a una posición absoluta. Si el lápiz está bajo, traza una linea. No cambia la orientación de la tortuga.

@c >>> turtle.goto(0, 0)

@example
>>> tp = turtle.pos()
>>> tp
(0.00,0.00)
>>> turtle.setpos(60,30)
>>> turtle.pos()
(60.00,30.00)
>>> turtle.setpos((20,80))
>>> turtle.pos()
(20.00,80.00)
>>> turtle.setpos(tp)
>>> turtle.pos()
(0.00,0.00)
@end example
@end deffn

@geindex teleport() (en el módulo turtle)
@anchor{library/turtle turtle teleport}@anchor{172d}
@deffn {Función} turtle.teleport (x, y=None, *, fill_gap=False)

@*Parámetros: 

@itemize *

@item 
@code{x} – un número o @code{None}

@item 
@code{y} – un número o @code{None}

@item 
@code{fill_gap} – a boolean
@end itemize


Move turtle to an absolute position. Unlike goto(x, y), a line will not
be drawn. The turtle’s orientation does not change. If currently
filling, the polygon(s) teleported from will be filled after leaving,
and filling will begin again after teleporting. This can be disabled
with fill_gap=True, which makes the imaginary line traveled during
teleporting act as a fill barrier like in goto(x, y).

@c >>> turtle.goto(0, 0)

@example
>>> tp = turtle.pos()
>>> tp
(0.00,0.00)
>>> turtle.teleport(60)
>>> turtle.pos()
(60.00,0.00)
>>> turtle.teleport(y=10)
>>> turtle.pos()
(60.00,10.00)
>>> turtle.teleport(20, 30)
>>> turtle.pos()
(20.00,30.00)
@end example


Added in version 3.12.

@end deffn

@geindex setx() (en el módulo turtle)
@anchor{library/turtle turtle setx}@anchor{3ca4}
@deffn {Función} turtle.setx (x)

@*Parámetros: 
@code{x} – un número (entero o flotante)


Establece la primera coordenada de la tortuga a `x', deja la segunda coordenada sin cambios.

@c >>> turtle.goto(0, 240)

@example
>>> turtle.position()
(0.00,240.00)
>>> turtle.setx(10)
>>> turtle.position()
(10.00,240.00)
@end example
@end deffn

@geindex sety() (en el módulo turtle)
@anchor{library/turtle turtle sety}@anchor{3ca5}
@deffn {Función} turtle.sety (y)

@*Parámetros: 
@code{y} – un número (entero o flotante)


Establece la segunda coordenada de la tortuga a `y', deja la primera coordenada sin cambios.

@c >>> turtle.goto(0, 40)

@example
>>> turtle.position()
(0.00,40.00)
>>> turtle.sety(-10)
>>> turtle.position()
(0.00,-10.00)
@end example
@end deffn

@geindex setheading() (en el módulo turtle)
@geindex seth() (en el módulo turtle)
@anchor{library/turtle turtle setheading}@anchor{3ca6}
@deffn {Función} turtle.setheading (to_angle)
@anchor{library/turtle turtle seth}@anchor{3ca7}
@deffnx {Función} turtle.seth (to_angle)

@*Parámetros: 
@code{to_angle} – un número (entero o flotante)


Establece la orientación de la tortuga a `to_angle'. Aquí hay algunas direcciones comunes en grados:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

modo estándar

@tab

modo logo

@item

0 - este

@tab

0 - norte

@item

90 - norte

@tab

90 - este

@item

180 - oeste

@tab

180 - sur

@item

270 - sur

@tab

270 - oeste

@end multitable


@example
>>> turtle.setheading(90)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex home() (en el módulo turtle)
@anchor{library/turtle turtle home}@anchor{3ca8}
@deffn {Función} turtle.home ()

Mueve la tortuga al origen – coordenadas (0,0) – y establece la orientación a la orientación original (que depende del modo, ver @ref{3cf7,,mode()}).

@c >>> turtle.setheading(90)
@c >>> turtle.goto(0, -10)

@example
>>> turtle.heading()
90.0
>>> turtle.position()
(0.00,-10.00)
>>> turtle.home()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex circle() (en el módulo turtle)
@anchor{library/turtle turtle circle}@anchor{3ca9}
@deffn {Función} turtle.circle (radius, extent=None, steps=None)

@*Parámetros: 

@itemize *

@item 
@code{radius} – un número

@item 
@code{extent} – un número (o @code{None})

@item 
@code{steps} – un entero (o @code{None})
@end itemize


Dibuja un círculo con el `radius' (radio) dado. El centro es `radius' unidades a la izquierda de la tortuga; `extent' – un ángulo – determina que parte del círculo se dibuja. Si no se pasa `extent', dibuja el círculo entero. Si `extent' no es un círculo completo, un punto final del arco es la posición actual de lápiz. Dibuja el arco en dirección antihorario si `radius' es positivo, si no en dirección horaria. Finalmente la dirección de la tortuga es modificada por el aumento de `extent'.

Como el círculo se aproxima a un polígono regular inscripto, `steps' determina el número de pasos a usar. Si no se da, será calculado automáticamente. Puede ser usado para dibujar polígonos regulares.

@example
>>> turtle.home()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
>>> turtle.circle(50)
>>> turtle.position()
(-0.00,0.00)
>>> turtle.heading()
0.0
>>> turtle.circle(120, 180)  # draw a semicircle
>>> turtle.position()
(0.00,240.00)
>>> turtle.heading()
180.0
@end example
@end deffn

@geindex dot() (en el módulo turtle)
@anchor{library/turtle turtle dot}@anchor{3caa}
@deffn {Función} turtle.dot (size=None, *color)

@*Parámetros: 

@itemize *

@item 
@code{size} – un entero >= 1 (si se da)

@item 
@code{color} – un `colorstring' o una tupla numérica de color
@end itemize


Dibuja un punto circular con diámetro `size', usando `color'. Si `size' no se da, el máximo de pensize+4 y 2*pensize es usado.

@example
>>> turtle.home()
>>> turtle.dot()
>>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50)
>>> turtle.position()
(100.00,-0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex stamp() (en el módulo turtle)
@anchor{library/turtle turtle stamp}@anchor{3cab}
@deffn {Función} turtle.stamp ()

Estampa una copia de la forma de la tortuga en el lienzo en la posición actual. Devuelve un stamp_id por cada estampa, que puede ser usado para borrarlo al llamar @code{clearstamp(stamp_id)}.

@example
>>> turtle.color("blue")
>>> stamp_id = turtle.stamp()
>>> turtle.fd(50)
@end example
@end deffn

@geindex clearstamp() (en el módulo turtle)
@anchor{library/turtle turtle clearstamp}@anchor{3cac}
@deffn {Función} turtle.clearstamp (stampid)

@*Parámetros: 
@code{stampid} – un entero, debe devolver el valor de la llamada previa de la función @ref{3cab,,stamp()} call


Borra la estampa con el `stampid' dado.

@example
>>> turtle.position()
(150.00,-0.00)
>>> turtle.color("blue")
>>> astamp = turtle.stamp()
>>> turtle.fd(50)
>>> turtle.position()
(200.00,-0.00)
>>> turtle.clearstamp(astamp)
>>> turtle.position()
(200.00,-0.00)
@end example
@end deffn

@geindex clearstamps() (en el módulo turtle)
@anchor{library/turtle turtle clearstamps}@anchor{3cad}
@deffn {Función} turtle.clearstamps (n=None)

@*Parámetros: 
@code{n} – un entero (o @code{None})


Borra todas o las primeros/últimos `n' estampas de la tortuga. Si `n' es @code{None} , borra todas las estampas, Si `n' `> 0' borra la primera estampa `n', sino y `n' `< 0' borra la última estampa `n'.

@example
>>> for i in range(8):
...     unused_stamp_id = turtle.stamp()
...     turtle.fd(30)
>>> turtle.clearstamps(2)
>>> turtle.clearstamps(-2)
>>> turtle.clearstamps()
@end example
@end deffn

@geindex undo() (en el módulo turtle)
@anchor{library/turtle turtle undo}@anchor{3cae}
@deffn {Función} turtle.undo ()

Deshace (repetidamente) la(s) última(s) acción(es) de la tortuga. El número de acciones a deshacer es determinado por el tamaño del `undobuffer'.

@example
>>> for i in range(4):
...     turtle.fd(50); turtle.lt(80)
...
>>> for i in range(8):
...     turtle.undo()
@end example
@end deffn

@geindex speed() (en el módulo turtle)
@anchor{library/turtle turtle speed}@anchor{3caf}
@deffn {Función} turtle.speed (speed=None)

@*Parámetros: 
@code{speed} – un entero en el rango 0..10 o un `speedstring' (ver abajo)


Establecer la velocidad de la tortuga a un valor entero en el rango 0..10. Si no se pasa ningún argumento, vuelve a la velocidad actual.

Si el parámetro de entrada es un número mayor que 10 o menor que 0.5, la velocidad se establece a 0. La frase acerca de la velocidad es mapeada a valores de velocidad de la siguiente manera:


@itemize *

@item 
«fastest»:  0

@item 
«fast»:  10

@item 
«normal»:  6

@item 
«slow»:  3

@item 
«slowest»:  1
@end itemize

Velocidades de 1 a 10 generan una animación cada vez más rápida al dibujar las líneas y en el giro de la tortuga.

Atención: `speed' = 0 implica que `no' habrá ninguna animación. Los métodos `fordward/back' harán que la tortuga salte, de la misma manera que `left/right' hará que la tortuga gire instantáneamente.

@example
>>> turtle.speed()
3
>>> turtle.speed('normal')
>>> turtle.speed()
6
>>> turtle.speed(9)
>>> turtle.speed()
9
@end example
@end deffn

@node Mostrar el estado de la tortuga,Configuración de las medidas,Movimiento de Turtle,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle tell-turtle-s-state}@anchor{3d07}
@subsubsection Mostrar el estado de la tortuga


@geindex position() (en el módulo turtle)
@geindex pos() (en el módulo turtle)
@anchor{library/turtle turtle position}@anchor{3cb0}
@deffn {Función} turtle.position ()
@anchor{library/turtle turtle pos}@anchor{3cb1}
@deffnx {Función} turtle.pos ()

Devuelve la posición actual de la tortuga (x,y) (como un vector @ref{3d06,,Vec2D})

@example
>>> turtle.pos()
(440.00,-0.00)
@end example
@end deffn

@geindex towards() (en el módulo turtle)
@anchor{library/turtle turtle towards}@anchor{3cb2}
@deffn {Función} turtle.towards (x, y=None)

@*Parámetros: 

@itemize *

@item 
@code{x} – un número o par de vectores numéricos o una instancia de la tortuga

@item 
@code{y} – un número si `x' es un número, si no @code{None}
@end itemize


Retorna el ángulo entre la línea en la posición de la tortuga a la posición especificada en (x, y), el vector o la otra tortuga. Esto depende de la posición inicial de la tortuga, que depende del modo - «standard»/»world» o «logo».

@example
>>> turtle.goto(10, 10)
>>> turtle.towards(0,0)
225.0
@end example
@end deffn

@geindex xcor() (en el módulo turtle)
@anchor{library/turtle turtle xcor}@anchor{3cb3}
@deffn {Función} turtle.xcor ()

Devuelve la coordinada `x' de la tortuga.

@example
>>> turtle.home()
>>> turtle.left(50)
>>> turtle.forward(100)
>>> turtle.pos()
(64.28,76.60)
>>> print(round(turtle.xcor(), 5))
64.27876
@end example
@end deffn

@geindex ycor() (en el módulo turtle)
@anchor{library/turtle turtle ycor}@anchor{3cb4}
@deffn {Función} turtle.ycor ()

Devuelve la coordenada `y' de la tortuga.

@example
>>> turtle.home()
>>> turtle.left(60)
>>> turtle.forward(100)
>>> print(turtle.pos())
(50.00,86.60)
>>> print(round(turtle.ycor(), 5))
86.60254
@end example
@end deffn

@geindex heading() (en el módulo turtle)
@anchor{library/turtle turtle heading}@anchor{3cb5}
@deffn {Función} turtle.heading ()

Devuelve la orientación actual de la tortuga (el valor depende del modo de la tortuga, ver @ref{3cf7,,mode()}).

@example
>>> turtle.home()
>>> turtle.left(67)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex distance() (en el módulo turtle)
@anchor{library/turtle turtle distance}@anchor{3cb6}
@deffn {Función} turtle.distance (x, y=None)

@*Parámetros: 

@itemize *

@item 
@code{x} – un número o par de vectores numéricos o una instancia de la tortuga

@item 
@code{y} – un número si `x' es un número, si no @code{None}
@end itemize


Devuelve la distancia desde la tortuga al vector (x,y) dado, otra instancia de la tortuga, el valor es unidad pasos de tortuga.

@example
>>> turtle.home()
>>> turtle.distance(30,40)
50.0
>>> turtle.distance((30,40))
50.0
>>> joe = Turtle()
>>> joe.forward(77)
>>> turtle.distance(joe)
77.0
@end example
@end deffn

@node Configuración de las medidas,Control del lápiz<2>,Mostrar el estado de la tortuga,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle settings-for-measurement}@anchor{3d08}
@subsubsection Configuración de las medidas


@geindex degrees() (en el módulo turtle)
@anchor{library/turtle turtle degrees}@anchor{3cb7}
@deffn {Función} turtle.degrees (fullcircle=360.0)

@*Parámetros: 
@code{fullcircle} – un número


Establece la unidad de medida del ángulo, por ejemplo establece el número de «grados» para un círculo completo. El valor por defecto es 36 grados.

@example
>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0

Change angle measurement unit to grad (also known as gon,
grade, or gradian and equals 1/100-th of the right angle.)
>>> turtle.degrees(400.0)
>>> turtle.heading()
100.0
>>> turtle.degrees(360)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex radians() (en el módulo turtle)
@anchor{library/turtle turtle radians}@anchor{3cb8}
@deffn {Función} turtle.radians ()

Establece la unidad de medida del ángulo a radianes. Equivalente a @code{degrees(2*math.pi)}.

@example
>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0
>>> turtle.radians()
>>> turtle.heading()
1.5707963267948966
@end example

@c >>> turtle.degrees(360)
@end deffn

@node Control del lápiz<2>,Estado de la Tortuga,Configuración de las medidas,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle id1}@anchor{3d09}
@subsubsection Control del lápiz


@menu
* Estado de dibujo:: 
* Control del color:: 
* Relleno:: 
* Más controles de dibujo:: 

@end menu

@node Estado de dibujo,Control del color,,Control del lápiz<2>
@anchor{library/turtle drawing-state}@anchor{3d0a}
@subsubsection Estado de dibujo


@geindex pendown() (en el módulo turtle)
@geindex pd() (en el módulo turtle)
@geindex down() (en el módulo turtle)
@anchor{library/turtle turtle pendown}@anchor{3cb9}
@deffn {Función} turtle.pendown ()
@anchor{library/turtle turtle pd}@anchor{3cba}
@deffnx {Función} turtle.pd ()
@anchor{library/turtle turtle down}@anchor{3cbb}
@deffnx {Función} turtle.down ()

Baja el lápiz – dibuja mientras se mueve.
@end deffn

@geindex penup() (en el módulo turtle)
@geindex pu() (en el módulo turtle)
@geindex up() (en el módulo turtle)
@anchor{library/turtle turtle penup}@anchor{3cbc}
@deffn {Función} turtle.penup ()
@anchor{library/turtle turtle pu}@anchor{3cbd}
@deffnx {Función} turtle.pu ()
@anchor{library/turtle turtle up}@anchor{3cbe}
@deffnx {Función} turtle.up ()

Levanta el lápiz – no dibuja mientras se mueve.
@end deffn

@geindex pensize() (en el módulo turtle)
@geindex width() (en el módulo turtle)
@anchor{library/turtle turtle pensize}@anchor{3cbf}
@deffn {Función} turtle.pensize (width=None)
@anchor{library/turtle turtle width}@anchor{3cc0}
@deffnx {Función} turtle.width (width=None)

@*Parámetros: 
@code{width} – un número positivo


Establece el grosos de la línea a `width' o lo devuelve. Si `resizemode' se establece a «auto» y turtleshape es un polígono, ese polígono es dibujado con el mismo grosor de línea. Si no se dan argumentos, devuelve el grosor del lápiz actual.

@example
>>> turtle.pensize()
1
>>> turtle.pensize(10)   # from here on lines of width 10 are drawn
@end example
@end deffn

@geindex pen() (en el módulo turtle)
@anchor{library/turtle turtle pen}@anchor{3cc1}
@deffn {Función} turtle.pen (pen=None, **pendict)

@*Parámetros: 

@itemize *

@item 
@code{pen} – un diccionario con algunos o todos las claves listadas debajo

@item 
@code{pendict} – uno o más argumentos-palabras claves con las claves listadas debajo como palabras claves
@end itemize


Devuelve o establece los atributos del lápiz en un «diccionario-lápiz» con el siguiente para de valores/claves:


@itemize *

@item 
«shown»: True/False

@item 
«pendown»: True/False

@item 
«pencolor»: color-string or color-tuple

@item 
«fillcolor»: color-string or color-tuple

@item 
«pensize»: número positivo

@item 
«speed»: número en el rango 0..10

@item 
«resizemode»: «auto» or «user» or «noresize»

@item 
«stretchfactor»: (número positivo, número positivo)

@item 
«outline»: número positivo

@item 
«tilt»: número
@end itemize

Este diccionario puede usarse como argumento de una llamada subsecuente a la función @ref{3cc1,,pen()} para restaurar el estado anterior del lápiz. Más aún, uno o más de estos atributos pueden darse como argumentos  claves. Esto puede usarse para establecer diferentes atributos del lápiz en una sola definición.

@example
>>> turtle.pen(fillcolor="black", pencolor="red", pensize=10)
>>> sorted(turtle.pen().items())
[('fillcolor', 'black'), ('outline', 1), ('pencolor', 'red'),
 ('pendown', True), ('pensize', 10), ('resizemode', 'noresize'),
 ('shearfactor', 0.0), ('shown', True), ('speed', 9),
 ('stretchfactor', (1.0, 1.0)), ('tilt', 0.0)]
>>> penstate=turtle.pen()
>>> turtle.color("yellow", "")
>>> turtle.penup()
>>> sorted(turtle.pen().items())[:3]
[('fillcolor', '@w{'}), ('outline', 1), ('pencolor', 'yellow')]
>>> turtle.pen(penstate, fillcolor="green")
>>> sorted(turtle.pen().items())[:3]
[('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')]
@end example
@end deffn

@geindex isdown() (en el módulo turtle)
@anchor{library/turtle turtle isdown}@anchor{3cc2}
@deffn {Función} turtle.isdown ()

Devuelve @code{True} si el lápiz está abajo, si está arriba @code{False}.

@example
>>> turtle.penup()
>>> turtle.isdown()
False
>>> turtle.pendown()
>>> turtle.isdown()
True
@end example
@end deffn

@node Control del color,Relleno,Estado de dibujo,Control del lápiz<2>
@anchor{library/turtle color-control}@anchor{3d0b}
@subsubsection Control del color


@geindex pencolor() (en el módulo turtle)
@anchor{library/turtle turtle pencolor}@anchor{3cc4}
@deffn {Función} turtle.pencolor (*args)

Devuelve o establece el color del lápiz.

Se permiten cuatro formatos de entrada:


@table @asis

@item @code{pencolor()}

Devuelve el color del lápiz actual como una palabra específica de algún color o como una tupla (ver ejemplo). Puede ser usado como una entrada para otra llamada de `color/pencolor/fillcolor'.

@item @code{pencolor(colorstring)}

Establece el color del lápiz a `colorstring', que es una palabra que especifica un color `Tk', tales como @code{"red"}, @code{"yellow"}, o @code{"#33cc8c"}.

@item @code{pencolor((r, g, b))}

Establece el color del lápiz representado como una tupla de `r', `g', y `b'.  Cada valor `r', `g', y `b' debe ser un valor entero en el rango 0..colormode, donde colormode es 1.0 o 255 (ver @ref{3cf8,,colormode()}).

@item @code{pencolor(r, g, b)}

Establece el color del lápiz al color RGB representado por `r', `g', y `b'. Cada valor `r', `g', y `b' debe estar en el rango 0..colormode.
@end table

Si `turtleshape' es un polígono, la línea del polígono es dibujado con el muevo color de lápiz elegido.

@example
>>> colormode()
1.0
>>> turtle.pencolor()
'red'
>>> turtle.pencolor("brown")
>>> turtle.pencolor()
'brown'
>>> tup = (0.2, 0.8, 0.55)
>>> turtle.pencolor(tup)
>>> turtle.pencolor()
(0.2, 0.8, 0.5490196078431373)
>>> colormode(255)
>>> turtle.pencolor()
(51.0, 204.0, 140.0)
>>> turtle.pencolor('#32c18f')
>>> turtle.pencolor()
(50.0, 193.0, 143.0)
@end example
@end deffn

@geindex fillcolor() (en el módulo turtle)
@anchor{library/turtle turtle fillcolor}@anchor{3cc5}
@deffn {Función} turtle.fillcolor (*args)

Return or set the fillcolor.

Se permiten cuatro formatos de entrada:


@table @asis

@item @code{fillcolor()}

Devuelve el valor actual de `fillcolor' como una palabra, posiblemente en formato de tupla (ver ejemplo). Puede ser usado como entrada de otra llamada `color/pencolor/fillcolor'.

@item @code{fillcolor(colorstring)}

Establece `fillcolor' a `colorstring', que es un color TK especificado como una palabra (en inglés), tales como `«red»', `«yellow»', o @code{"#33cc8c"}.

@item @code{fillcolor((r, g, b))}

Establece `fillcolor' al color RGB representado por la tupla `r', `g', y `b'. Cada uno de los valores `r', `g', y `b' debe estar en el rango 0..colormode, donde `colormode' es 1.0 o 255 (ver @ref{3cf8,,colormode()}).

@item @code{fillcolor(r, g, b)}

Establece `fillcolor' al color RGB representado por `r', `g', y `b'. Cada uno de los valores `r', `g' y `b' debe ser un valor en el rango 0..colormode.
@end table

Si `turtleshape' es un polígono, el interior de ese polígono es dibujado con el color establecido en `fillcolor'.

@example
>>> turtle.fillcolor("violet")
>>> turtle.fillcolor()
'violet'
>>> turtle.pencolor()
(50.0, 193.0, 143.0)
>>> turtle.fillcolor((50, 193, 143))  # Integers, not floats
>>> turtle.fillcolor()
(50.0, 193.0, 143.0)
>>> turtle.fillcolor('#ffffff')
>>> turtle.fillcolor()
(255.0, 255.0, 255.0)
@end example
@end deffn

@geindex color() (en el módulo turtle)
@anchor{library/turtle turtle color}@anchor{3cc3}
@deffn {Función} turtle.color (*args)

Retorna o establece `pencolor' (el color del lápiz) y `fillcolor' (el color de relleno).

Se permiten varios formatos de entrada. Usan de 0 a 3 argumentos como se muestra a continuación:


@table @asis

@item @code{color()}

Devuelve el valor actual de `pencolor' y el valor actual de `fillcolor' como un par de colores especificados como palabras o tuplas, como devuelven las funciones @ref{3cc4,,pencolor()} y @ref{3cc5,,fillcolor()}.

@item @code{color(colorstring)}, @code{color((r,g,b))}, @code{color(r,g,b)}

Entradas como en  @ref{3cc4,,pencolor()}, establece al valor dado tanto, `fillcolor' como `pencolor'.

@item @code{color(colorstring1, colorstring2)}, @code{color((r1,g1,b1), (r2,g2,b2))}

Equivalente a @code{pencolor(colorstring1)} y @code{fillcolor(colorstring2)} y análogamente si se usa el otro formato de entrada.
@end table

Si `turtleshape' es un polígono, la línea y el interior de ese polígono e dibujado con los nuevos colores que se establecieron.

@example
>>> turtle.color("red", "green")
>>> turtle.color()
('red', 'green')
>>> color("#285078", "#a0c8f0")
>>> color()
((40.0, 80.0, 120.0), (160.0, 200.0, 240.0))
@end example
@end deffn

Ver también: Método `Screeen' @ref{3cf8,,colormode()}.

@node Relleno,Más controles de dibujo,Control del color,Control del lápiz<2>
@anchor{library/turtle filling}@anchor{3d0c}
@subsubsection Relleno


@c >>> turtle.home()

@geindex filling() (en el módulo turtle)
@anchor{library/turtle turtle filling}@anchor{3cc6}
@deffn {Función} turtle.filling ()

Devuelve `fillstate' (@code{True} si está lleno, sino @code{False}).

@example
>>> turtle.begin_fill()
>>> if turtle.filling():
...    turtle.pensize(5)
... else:
...    turtle.pensize(3)
@end example
@end deffn

@geindex begin_fill() (en el módulo turtle)
@anchor{library/turtle turtle begin_fill}@anchor{3cc7}
@deffn {Función} turtle.begin_fill ()

Para ser llamada justo antes de dibujar una forma a rellenar.
@end deffn

@geindex end_fill() (en el módulo turtle)
@anchor{library/turtle turtle end_fill}@anchor{3cc8}
@deffn {Función} turtle.end_fill ()

Rellena la forma dibujada después de última llamada a la función @ref{3cc7,,begin_fill()}.

Superponer o no, regiones de polígonos auto-intersectados o múltiples formas, estas son rellenadas dependiendo de los gráficos del sistema operativo, tipo de superposición y número de superposiciones. Por ejemplo, la flecha de la tortuga de arriba, puede ser toda amarilla o tener algunas regiones blancas.

@example
>>> turtle.color("black", "red")
>>> turtle.begin_fill()
>>> turtle.circle(80)
>>> turtle.end_fill()
@end example
@end deffn

@node Más controles de dibujo,,Relleno,Control del lápiz<2>
@anchor{library/turtle more-drawing-control}@anchor{3d0d}
@subsubsection Más controles de dibujo


@geindex reset() (en el módulo turtle)
@anchor{library/turtle turtle reset}@anchor{3cc9}
@deffn {Función} turtle.reset ()

Borra el dibujo de la tortuga de la pantalla, centra la tortuga y establece las variables a los valores por defecto.

@example
>>> turtle.goto(0,-22)
>>> turtle.left(100)
>>> turtle.position()
(0.00,-22.00)
>>> turtle.heading()
100.0
>>> turtle.reset()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex clear() (en el módulo turtle)
@anchor{library/turtle turtle clear}@anchor{3cca}
@deffn {Función} turtle.clear ()

Borra el dibujo de la tortuga de la pantalla. No mueve la tortuga. El estado y posición de la tortuga así como los todos los dibujos de las otras tortugas no son afectados.
@end deffn

@geindex write() (en el módulo turtle)
@anchor{library/turtle turtle write}@anchor{3ccb}
@deffn {Función} turtle.write (arg, move=False, align='left', font=('Arial', 8, 'normal'))

@*Parámetros: 

@itemize *

@item 
@code{arg} – objeto que se escribirá en `TurtleScreen'

@item 
@code{move} – True/False

@item 
@code{align} – una de las frases «`left'», «`center'» o «`right'»

@item 
@code{font} – un trio (nombre de fuente, tamaño de fuente, tipo de fuente)
@end itemize


Escribe texto - la representación de cadena de caracteres de `arg' - en la posición actual de la tortuga de acuerdo con `align' («izquierda», «centro» o «derecha») y con la fuente dada. Si `mov' es verdadero, el lápiz se mueve a la esquina inferior derecha del texto. De forma predeterminada, `move' es @code{False}.

@example
>>> turtle.write("Home = ", True, align="center")
>>> turtle.write((0,0), True)
@end example
@end deffn

@node Estado de la Tortuga,Usando eventos,Control del lápiz<2>,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle turtle-state}@anchor{3d0e}
@subsubsection Estado de la Tortuga


@menu
* Visibilidad:: 
* Apariencia:: 

@end menu

@node Visibilidad,Apariencia,,Estado de la Tortuga
@anchor{library/turtle visibility}@anchor{3d0f}
@subsubsection Visibilidad


@geindex hideturtle() (en el módulo turtle)
@geindex ht() (en el módulo turtle)
@anchor{library/turtle turtle hideturtle}@anchor{3cce}
@deffn {Función} turtle.hideturtle ()
@anchor{library/turtle turtle ht}@anchor{3ccf}
@deffnx {Función} turtle.ht ()

Hace invisible a la tortuga, Es una buena idea hacer eso mientras está haciendo dibujos complejos, ya que esconder a la tortuga acelera dibujo de manera observable.

@example
>>> turtle.hideturtle()
@end example
@end deffn

@geindex showturtle() (en el módulo turtle)
@geindex st() (en el módulo turtle)
@anchor{library/turtle turtle showturtle}@anchor{3ccc}
@deffn {Función} turtle.showturtle ()
@anchor{library/turtle turtle st}@anchor{3ccd}
@deffnx {Función} turtle.st ()

Hace visible la tortuga.

@example
>>> turtle.showturtle()
@end example
@end deffn

@geindex isvisible() (en el módulo turtle)
@anchor{library/turtle turtle isvisible}@anchor{3cd0}
@deffn {Función} turtle.isvisible ()

Devuelve @code{True} si la tortuga se muestra, @code{False} si está oculta.

@example
>>> turtle.hideturtle()
>>> turtle.isvisible()
False
>>> turtle.showturtle()
>>> turtle.isvisible()
True
@end example
@end deffn

@node Apariencia,,Visibilidad,Estado de la Tortuga
@anchor{library/turtle appearance}@anchor{3d10}
@subsubsection Apariencia


@geindex shape() (en el módulo turtle)
@anchor{library/turtle turtle shape}@anchor{3cd1}
@deffn {Función} turtle.shape (name=None)

@*Parámetros: 
@code{name} – una cadena de caracteres que es un nombre de forma válido


Establece la forma de la tortuga al `name' que se establece o, si no se establece un nombre, devuelve el nombre actual de su forma. La forma `name' debe existir en el diccionario de formas de `TurtleScreen'. Inicialmente están las siguientes formas poligonales: «`arrow'», «`turtle'», «`circle'», «`square'», «`triangle'», «`classic'». Para aprender como trabajar con estas formas ver los métodos de Screen @ref{3cfb,,register_shape()}.

@example
>>> turtle.shape()
'classic'
>>> turtle.shape("turtle")
>>> turtle.shape()
'turtle'
@end example
@end deffn

@geindex resizemode() (en el módulo turtle)
@anchor{library/turtle turtle resizemode}@anchor{3cd2}
@deffn {Función} turtle.resizemode (rmode=None)

@*Parámetros: 
@code{rmode} – una de las cadenas «`auto'», «`user'», «`noresize'»


Establece `resizemode' a alguno de los valores: «`auto'», «`user'», «`noresize'». Si `mode' no se aporta, devuelve el actual `resizemode'. Distintos `resizemode' tienen los siguientes efectos:


@itemize -

@item 
«`auto'»: adapta la apariencia de la tortuga al correspondiente valor del lápiz.

@item 
«`user'»: adapta la apariencia de la tortuga de acuerdo a los valores de `sretchfactor' y `outlinewidth' (contorno), que se establece con la función @ref{3cd3,,shapesize()}.

@item 
«`noresize'»: no se adapta la apariencia de la tortuga.
@end itemize

@code{resizemode("user")} es llamado por la función @ref{3cd3,,shapesize()} cuando se usa con argumentos.

@example
>>> turtle.resizemode()
'noresize'
>>> turtle.resizemode("auto")
>>> turtle.resizemode()
'auto'
@end example
@end deffn

@geindex shapesize() (en el módulo turtle)
@geindex turtlesize() (en el módulo turtle)
@anchor{library/turtle turtle shapesize}@anchor{3cd3}
@deffn {Función} turtle.shapesize (stretch_wid=None, stretch_len=None, outline=None)
@anchor{library/turtle turtle turtlesize}@anchor{3cd4}
@deffnx {Función} turtle.turtlesize (stretch_wid=None, stretch_len=None, outline=None)

@*Parámetros: 

@itemize *

@item 
@code{stretch_wid} – número positivo

@item 
@code{stretch_len} – número positivo

@item 
@code{outline} – número positivo
@end itemize


Return or set the pen’s attributes x/y-stretchfactors and/or outline.  Set
resizemode to «user».  If and only if resizemode is set to «user», the turtle
will be displayed stretched according to its stretchfactors: `stretch_wid' is
stretchfactor perpendicular to its orientation, `stretch_len' is
stretchfactor in direction of its orientation, `outline' determines the width
of the shape’s outline.

@example
>>> turtle.shapesize()
(1.0, 1.0, 1)
>>> turtle.resizemode("user")
>>> turtle.shapesize(5, 5, 12)
>>> turtle.shapesize()
(5, 5, 12)
>>> turtle.shapesize(outline=8)
>>> turtle.shapesize()
(5, 5, 8)
@end example
@end deffn

@geindex shearfactor() (en el módulo turtle)
@anchor{library/turtle turtle shearfactor}@anchor{3cd5}
@deffn {Función} turtle.shearfactor (shear=None)

@*Parámetros: 
@code{shear} – número (opcional)


Establece o devuelve el valor actual del estiramiento. Estira la forma de la tortuga de acuerdo a la inclinación del factor de corte, que es la tangente del ángulo de corte. No cambia el rumbo de la tortuga (dirección del movimiento). Si no de da un valor de inclinación: devuelve el factor actual, por ejemplo la tangente del ángulo de inclinación, por el cual se cortan la líneas paralelas al rumbo de la tortuga.

@example
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.shearfactor(0.5)
>>> turtle.shearfactor()
0.5
@end example
@end deffn

@geindex tilt() (en el módulo turtle)
@anchor{library/turtle turtle tilt}@anchor{3cd6}
@deffn {Función} turtle.tilt (angle)

@*Parámetros: 
@code{angle} – un número


Rota la forma de la tortuga en `ángulo' desde su ángulo de inclinación actual, pero no cambia el rumbo de la tortuga (dirección del movimiento).

@example
>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(30)
>>> turtle.fd(50)
>>> turtle.tilt(30)
>>> turtle.fd(50)
@end example
@end deffn

@geindex tiltangle() (en el módulo turtle)
@anchor{library/turtle turtle tiltangle}@anchor{7c1}
@deffn {Función} turtle.tiltangle (angle=None)

@*Parámetros: 
@code{angle} – un número (opcional)


Establece o devuelve el ángulo de inclinación actual. Si se otorga un ángulo, rota la forma de la tortuga para apuntar en la dirección del ángulo especificado, independientemente de su actual ángulo de inclinación. No cambia el rumbo de la tortuga (dirección del movimiento). Si no se da el ángulo: devuelve el ángulo de inclinación actual, por ejemplo: el ángulo entre la orientación de la forma de la tortuga y el rumbo de la tortuga (su dirección de movimiento).

@example
>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(45)
>>> turtle.tiltangle()
45.0
@end example
@end deffn

@geindex shapetransform() (en el módulo turtle)
@anchor{library/turtle turtle shapetransform}@anchor{3cd7}
@deffn {Función} turtle.shapetransform (t11=None, t12=None, t21=None, t22=None)

@*Parámetros: 

@itemize *

@item 
@code{t11} – un número (opcional)

@item 
@code{t12} – un número (opcional)

@item 
@code{t21} – un número (opcional)

@item 
@code{t12} – un número (opcional)
@end itemize


Establece o devuelve la matriz de transformación actual de la forma de la tortuga.

Si no se proporciona ninguno de los elementos de la matriz, retorna la matriz de transformación como una tupla de 4 elementos. De lo contrario, establezca los elementos dados y transforme la forma de tortuga de acuerdo con la matriz que consta de la primera fila t11, t12 y la segunda fila t21, t22. El determinante t11 * t22 - t12 * t21 no debe ser cero, de lo contrario se genera un error. Modifique el factor de estiramiento, el factor de corte y el ángulo de inclinación de acuerdo con la matriz dada.

@example
>>> turtle = Turtle()
>>> turtle.shape("square")
>>> turtle.shapesize(4,2)
>>> turtle.shearfactor(-0.5)
>>> turtle.shapetransform()
(4.0, -1.0, -0.0, 2.0)
@end example
@end deffn

@geindex get_shapepoly() (en el módulo turtle)
@anchor{library/turtle turtle get_shapepoly}@anchor{3cd8}
@deffn {Función} turtle.get_shapepoly ()

Devuelve el polígono de la forma actual como tupla de pares de coordenadas. Esto puede ser usado para definir una nueva forma o componentes de una forma compuesta.

@example
>>> turtle.shape("square")
>>> turtle.shapetransform(4, -1, 0, 2)
>>> turtle.get_shapepoly()
((50, -20), (30, 20), (-50, 20), (-30, -20))
@end example
@end deffn

@node Usando eventos,Métodos especiales de Turtle,Estado de la Tortuga,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle using-events}@anchor{3d11}
@subsubsection Usando eventos



@deffn {Función} turtle.onclick (fun, btn=1, add=None)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función con dos argumentos que se invocará con las coordenadas del punto en el que se hizo clic en el lienzo

@item 
@code{btn} – número del botón del mouse, el valor predeterminado es 1 (botón izquierdo del mouse)

@item 
@code{add} – @code{True} o @code{False} – si es @code{True}, se agrega un nuevo enlace, de lo contrario reemplazará el enlace anterior
@end itemize


Enlaza `acciones divertidas' a eventos de click en la tortuga. Si la `accion' es @code{None}, las acciones asociadas son borradas. Ejemplo para la tortuga anónima, en la forma procedimental:

@example
>>> def turn(x, y):
...     left(180)
...
>>> onclick(turn)  # Now clicking into the turtle will turn it.
>>> onclick(None)  # event-binding will be removed
@end example
@end deffn

@geindex onrelease() (en el módulo turtle)
@anchor{library/turtle turtle onrelease}@anchor{3cda}
@deffn {Función} turtle.onrelease (fun, btn=1, add=None)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función con dos argumentos que se invocará con las coordenadas del punto en el que se hizo clic en el lienzo

@item 
@code{btn} – número del botón del mouse, el valor predeterminado es 1 (botón izquierdo del mouse)

@item 
@code{add} – @code{True} o @code{False} – si es @code{True}, se agrega un nuevo enlace, de lo contrario reemplazará el enlace anterior
@end itemize


Enlaza `acciones divertidas' a eventos del tipo soltar botón del mouse en la tortuga. SI la `acción' es @code{None}, las acciones asociadas son borradas.

@example
>>> class MyTurtle(Turtle):
...     def glow(self,x,y):
...         self.fillcolor("red")
...     def unglow(self,x,y):
...         self.fillcolor("")
...
>>> turtle = MyTurtle()
>>> turtle.onclick(turtle.glow)     # clicking on turtle turns fillcolor red,
>>> turtle.onrelease(turtle.unglow) # releasing turns it to transparent.
@end example
@end deffn

@geindex ondrag() (en el módulo turtle)
@anchor{library/turtle turtle ondrag}@anchor{3cdb}
@deffn {Función} turtle.ondrag (fun, btn=1, add=None)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función con dos argumentos que se invocará con las coordenadas del punto en el que se hizo clic en el lienzo

@item 
@code{btn} – número del botón del mouse, el valor predeterminado es 1 (botón izquierdo del mouse)

@item 
@code{add} – @code{True} o @code{False} – si es @code{True}, se agrega un nuevo enlace, de lo contrario reemplazará el enlace anterior
@end itemize


Enlaza `acciones divertidas' a eventos en los movimientos del mouse. Si la `acción' es @code{None}, las acciones asociadas son borradas.

Observación: cada secuencia de los eventos de movimiento del mouse en una tortuga es precedida por un evento de click del mouse en esa tortuga.

@example
>>> turtle.ondrag(turtle.goto)
@end example

Subsecuentemente, clickear y arrastrar la Tortuga la moverá a través de la pantalla produciendo dibujos a mano alzada (si el lápiz está abajo).
@end deffn

@node Métodos especiales de Turtle,Formas compuestas,Usando eventos,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle special-turtle-methods}@anchor{3d12}
@subsubsection Métodos especiales de `Turtle'


@geindex begin_poly() (en el módulo turtle)
@anchor{library/turtle turtle begin_poly}@anchor{3cdc}
@deffn {Función} turtle.begin_poly ()

Comienza a grabar los vértices de un polígono. La posición actual de la tortuga es el primer vértice del polígono.
@end deffn

@geindex end_poly() (en el módulo turtle)
@anchor{library/turtle turtle end_poly}@anchor{3cdd}
@deffn {Función} turtle.end_poly ()

Deja de grabar los vértices de un polígono. La posición actual de la tortuga es el último vértice del polígono. Esto se conectará con el primer vértice.
@end deffn

@geindex get_poly() (en el módulo turtle)
@anchor{library/turtle turtle get_poly}@anchor{3cde}
@deffn {Función} turtle.get_poly ()

Devuelve el último polígono grabado.

@example
>>> turtle.home()
>>> turtle.begin_poly()
>>> turtle.fd(100)
>>> turtle.left(20)
>>> turtle.fd(30)
>>> turtle.left(60)
>>> turtle.fd(50)
>>> turtle.end_poly()
>>> p = turtle.get_poly()
>>> register_shape("myFavouriteShape", p)
@end example
@end deffn

@geindex clone() (en el módulo turtle)
@anchor{library/turtle turtle clone}@anchor{3cdf}
@deffn {Función} turtle.clone ()

Crea y devuelve un clon de la tortuga con la misma posición, dirección y propiedades de la tortuga.

@example
>>> mick = Turtle()
>>> joe = mick.clone()
@end example
@end deffn

@geindex getturtle() (en el módulo turtle)
@geindex getpen() (en el módulo turtle)
@anchor{library/turtle turtle getturtle}@anchor{3ce0}
@deffn {Función} turtle.getturtle ()
@anchor{library/turtle turtle getpen}@anchor{3ce1}
@deffnx {Función} turtle.getpen ()

Devuelve el objeto Tortuga en si. El único uso razonable: es como una función para devolver la «tortuga anónima»:

@example
>>> pet = getturtle()
>>> pet.fd(50)
>>> pet
<turtle.Turtle object at 0x...>
@end example
@end deffn

@geindex getscreen() (en el módulo turtle)
@anchor{library/turtle turtle getscreen}@anchor{3ce2}
@deffn {Función} turtle.getscreen ()

Devuelve el objeto @ref{3d13,,TurtleScreen} sobre el cual la tortuga está dibujando. Los métodos `TurtleScreen' luego pueden ser llamados para ese objeto.

@example
>>> ts = turtle.getscreen()
>>> ts
<turtle._Screen object at 0x...>
>>> ts.bgcolor("pink")
@end example
@end deffn

@geindex setundobuffer() (en el módulo turtle)
@anchor{library/turtle turtle setundobuffer}@anchor{3ce3}
@deffn {Función} turtle.setundobuffer (size)

@*Parámetros: 
@code{size} – un entero o @code{None}


Establecer o deshabilitar deshacer búfer. Si `size' es un número entero, se instala un búfer de deshacer vacío de un tamaño determinado. `size' da el número máximo de acciones de tortuga que se pueden deshacer mediante el método/función @ref{3cae,,undo()}. Si `size' es @code{None}, el búfer para deshacer está deshabilitado.

@example
>>> turtle.setundobuffer(42)
@end example
@end deffn

@geindex undobufferentries() (en el módulo turtle)
@anchor{library/turtle turtle undobufferentries}@anchor{3ce4}
@deffn {Función} turtle.undobufferentries ()

Devuelve el número de entradas en el buffer para deshacer acciones.

@example
>>> while undobufferentries():
...     undo()
@end example
@end deffn

@node Formas compuestas,,Métodos especiales de Turtle,Métodos de RawTurtle/Turtle Y sus correspondientes funciones
@anchor{library/turtle compound-shapes}@anchor{3d14}@anchor{library/turtle compoundshapes}@anchor{3d15}
@subsubsection Formas compuestas


Para usar formas complejas con la tortuga, que consiste en varios polígonos de diferentes colores, deberá usar la clase de ayuda @ref{3d16,,Shape} explícitamente como se describe debajo:


@enumerate 

@item 
Crear una objeto de forma vacía del tipo `compound'.

@item 
Add as many components to this object as desired, using the
@ref{3d17,,addcomponent()} method.

Por ejemplo:

@example
>>> s = Shape("compound")
>>> poly1 = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s.addcomponent(poly1, "red", "blue")
>>> poly2 = ((0,0),(10,-5),(-10,-5))
>>> s.addcomponent(poly2, "blue", "red")
@end example

@item 
Ahora agregar la forma a la lista de formas de la pantalla y úsela:

@example
>>> register_shape("myshape", s)
>>> shape("myshape")
@end example
@end enumerate

@cartouche
@quotation Nota 
La clase @ref{3d16,,Shape} es usada internamente por el método @ref{3cfb,,register_shape()} en maneras diferentes. El programador deberá lidiar con la clase `Shape' ¡solo cuando use formas compuestas como las que se mostraron arriba!
@end quotation
@end cartouche

@node Métodos de TurtleScreen/Screen y sus correspondientes funciones,Clases públicas,Métodos de RawTurtle/Turtle Y sus correspondientes funciones,turtle — Gráficos con Turtle
@anchor{library/turtle methods-of-turtlescreen-screen-and-corresponding-functions}@anchor{3d18}
@subsubsection Métodos de `TurtleScreen/Screen' y sus correspondientes funciones


La mayoría de los ejemplos en esta sección se refieren a la instancia de `TurtleScreen' llamada @code{screen}.

@c >>> screen = Screen()

@menu
* Control de ventana:: 
* Control de animación:: 
* Usando eventos de pantalla:: 
* Métodos de entrada:: 
* Configuración y métodos especiales:: 
* Métodos específicos de Screen@comma{} no heredados de TurtleScreen: Métodos específicos de Screen no heredados de TurtleScreen. 

@end menu

@node Control de ventana,Control de animación,,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle window-control}@anchor{3d19}
@subsubsection Control de ventana


@geindex bgcolor() (en el módulo turtle)
@anchor{library/turtle turtle bgcolor}@anchor{3ce6}
@deffn {Función} turtle.bgcolor (*args)

@*Parámetros: 
@code{args} – una cadena de color o tres números en el rango 0..*colormode* o una tupla de 3 de esos números


Establece o devuelve el color de fondo de `TurtleScreen'.

@example
>>> screen.bgcolor("orange")
>>> screen.bgcolor()
'orange'
>>> screen.bgcolor("#800080")
>>> screen.bgcolor()
(128.0, 0.0, 128.0)
@end example
@end deffn

@geindex bgpic() (en el módulo turtle)
@anchor{library/turtle turtle bgpic}@anchor{3ce7}
@deffn {Función} turtle.bgpic (picname=None)

@*Parámetros: 
@code{picname} – una cadena, nombre o archivo gif o @code{"nopic"}, o @code{None}


Establece la imagen de fondo o devuelve el nombre de la imagen de fondo actual. Si `picname' es un nombre de archivo, establece la imagen correspondiente como fondo. Si `picname' es @code{"nopic"}, borra la imagen de fondo, si hay alguna presente. Si `picname' es @code{None}, devuelve el nombre de archivo de la imagen de fondo actual.

@example
>>> screen.bgpic()
'nopic'
>>> screen.bgpic("landscape.gif")
>>> screen.bgpic()
"landscape.gif"
@end example
@end deffn


@deffn {Función} turtle.clear ()

@cartouche
@quotation Nota 
Este método de `TurtleScreen' está disponible como una función global solo bajo el nombre @code{clearscreen}. La función global @code{clear} es otra, derivada del método de `Turtle' @code{clear}.
@end quotation
@end cartouche
@end deffn

@geindex clearscreen() (en el módulo turtle)
@anchor{library/turtle turtle clearscreen}@anchor{3ce8}
@deffn {Función} turtle.clearscreen ()

Borra todos los dibujos y todas las tortugas del la pantalla de la tortuga. Reinicia la ahora vacía pantalla de la tortuga a su estado inicial: fondo blanco, sin imagen de fondo, sin enlaces a eventos o seguimientos.
@end deffn


@deffn {Función} turtle.reset ()

@cartouche
@quotation Nota 
Este método `TurtleScreen' esta disponible como una función global solo bajo el nombre @code{resetscreen}. La función global @code{reset} es otra, derivada del método `Turtle' @code{reset}.
@end quotation
@end cartouche
@end deffn

@geindex resetscreen() (en el módulo turtle)
@anchor{library/turtle turtle resetscreen}@anchor{3ce9}
@deffn {Función} turtle.resetscreen ()

Reinicia todas las tortugas de la pantalla a su estado inicial.
@end deffn

@geindex screensize() (en el módulo turtle)
@anchor{library/turtle turtle screensize}@anchor{3cea}
@deffn {Función} turtle.screensize (canvwidth=None, canvheight=None, bg=None)

@*Parámetros: 

@itemize *

@item 
@code{canvwidth} – entero positivo, nueva anchura del lienzo en pixeles

@item 
@code{canvheight} – entero positivo, nueva altura del lienzo en pixeles

@item 
@code{bg} – `colorstrng' o tupla de color, muevo color de fondo
@end itemize


Si no se dan argumentos, devuelve el actual (ancho y alto del lienzo). Sino redimensiona el lienzo en el que la tortuga está dibujando. No altera la ventana de dibujo. Para ver las partes ocultas del lienzo, use la barra de desplazamiento. Con este método, se pueden hacer visibles aquellas partes de un dibujo que antes estaban fuera del lienzo.

@example
>>> screen.screensize()
(400, 300)
>>> screen.screensize(2000,1500)
>>> screen.screensize()
(2000, 1500)
@end example

ej. buscar una tortuga que se escapó por error ;-)
@end deffn

@geindex setworldcoordinates() (en el módulo turtle)
@anchor{library/turtle turtle setworldcoordinates}@anchor{3ceb}
@deffn {Función} turtle.setworldcoordinates (llx, lly, urx, ury)

@*Parámetros: 

@itemize *

@item 
@code{llx} – un número, coordenada x de la esquina inferior izquierda del lienzo

@item 
@code{lly} – un número, coordenada y de la esquina inferior izquierda del lienzo

@item 
@code{urx} – un número, coordenada x de la esquina superior derecha del lienzo

@item 
@code{ury} – un número, coordenada z de la esquina superior derecha del lienzo
@end itemize


Configura coordenadas definidas por el usuario y cambia al modo `world' si es necesario. Esto realiza un @code{screen.reset()}. Si el modo `world' ya está activo, todos los dibujos se re dibujan de acuerdo a las nuevas coordenadas.

`ATENCIÓN': en los sistemas de coordenadas definidos por el usuario, los ángulos pueden aparecer distorsionados.

@example
>>> screen.reset()
>>> screen.setworldcoordinates(-50,-7.5,50,7.5)
>>> for _ in range(72):
...     left(10)
...
>>> for _ in range(8):
...     left(45); fd(2)   # a regular octagon
@end example

@c >>> screen.reset()
@c >>> for t in turtles():
@c ...      t.reset()
@end deffn

@node Control de animación,Usando eventos de pantalla,Control de ventana,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle animation-control}@anchor{3d1a}
@subsubsection Control de animación


@geindex delay() (en el módulo turtle)
@anchor{library/turtle turtle delay}@anchor{3cec}
@deffn {Función} turtle.delay (delay=None)

@*Parámetros: 
@code{delay} – entero positivo


Establece o retorna el `retraso' del dibujo en mili segundos. ( Este es aproximadamente, el tiempo de intervalo entre dos actualizaciones consecutivas del lienzo). Mientras más largo sea el retraso, más lenta la animación.

Argumento opcional:

@example
>>> screen.delay()
10
>>> screen.delay(5)
>>> screen.delay()
5
@end example
@end deffn

@geindex tracer() (en el módulo turtle)
@anchor{library/turtle turtle tracer}@anchor{3ced}
@deffn {Función} turtle.tracer (n=None, delay=None)

@*Parámetros: 

@itemize *

@item 
@code{n} – entero no negativo

@item 
@code{delay} – entero no negativo
@end itemize


Activa o desactiva la animación de la tortuga y establece el retraso para la actualización de los dibujos. Si se da `n', solo cada enésima actualización regular de pantalla se realiza realmente. (Puede usarse para acelerar los dibujos de gráficos complejos). Cuando es llamada sin argumentos, devuelve el valor de `n' guardado actualmente. El segundo argumento establece el valor de retraso (ver @ref{3cec,,delay()}).

@example
>>> screen.tracer(8, 25)
>>> dist = 2
>>> for i in range(200):
...     fd(dist)
...     rt(90)
...     dist += 2
@end example
@end deffn

@geindex update() (en el módulo turtle)
@anchor{library/turtle turtle update}@anchor{3cee}
@deffn {Función} turtle.update ()

Realiza una actualización de la pantalla de la tortuga. Para ser usada cuando `tracer' está deshabilitada.
@end deffn

Ver también el método `RawTurtle/Turtle' @ref{3caf,,speed()}.

@node Usando eventos de pantalla,Métodos de entrada,Control de animación,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle using-screen-events}@anchor{3d1b}
@subsubsection Usando eventos de pantalla


@geindex listen() (en el módulo turtle)
@anchor{library/turtle turtle listen}@anchor{3cef}
@deffn {Función} turtle.listen (xdummy=None, ydummy=None)

Establece el foco en la pantalla de la tortuga (para recoger eventos de teclado). Los argumentos `dummy' se proveen en orden de ser capaces de pasar @ref{3cef,,listen()} a los métodos `onclick'.
@end deffn

@geindex onkey() (en el módulo turtle)
@geindex onkeyrelease() (en el módulo turtle)
@anchor{library/turtle turtle onkey}@anchor{3cf0}
@deffn {Función} turtle.onkey (fun, key)
@anchor{library/turtle turtle onkeyrelease}@anchor{3cf1}
@deffnx {Función} turtle.onkeyrelease (fun, key)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función sin argumentos o @code{None}

@item 
@code{key} – una cadena de caracteres: tecla (por ejemplo, «a») o una acción del teclado (por ejemplo, «space»)
@end itemize


Vincula `fun' a un evento de liberación de una tecla. Si `fun' es @code{None}, los eventos vinculados son removidos. Aclaración: para poder registrar eventos de teclado, `TurtleScreen' tiene que tener el foco. (ver el método @ref{3cef,,listen()}.)

@example
>>> def f():
...     fd(50)
...     lt(60)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onkeypress() (en el módulo turtle)
@anchor{library/turtle turtle onkeypress}@anchor{3cf2}
@deffn {Función} turtle.onkeypress (fun, key=None)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función sin argumentos o @code{None}

@item 
@code{key} – una cadena de caracteres: tecla (por ejemplo, «a») o una acción del teclado (por ejemplo, «space»)
@end itemize


Vincula `fun' a un evento de pulsado de una tecla, o a cualquier evento de pulsado de tecla si no se da una. Aclaración: para poder registrar eventos de teclado, `TurtleScreen' tiene que tener el foco. (ver el método @ref{3cef,,listen()}.)

@example
>>> def f():
...     fd(50)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onclick() (en el módulo turtle)
@geindex onscreenclick() (en el módulo turtle)
@anchor{library/turtle turtle onclick}@anchor{3cd9}
@deffn {Función} turtle.onclick (fun, btn=1, add=None)
@anchor{library/turtle turtle onscreenclick}@anchor{3cf3}
@deffnx {Función} turtle.onscreenclick (fun, btn=1, add=None)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función con dos argumentos que se invocará con las coordenadas del punto en el que se hizo clic en el lienzo

@item 
@code{btn} – número del botón del mouse, el valor predeterminado es 1 (botón izquierdo del mouse)

@item 
@code{add} – @code{True} o @code{False} – si es @code{True}, se agrega un nuevo enlace, de lo contrario reemplazará el enlace anterior
@end itemize


Vincula `fun' a eventos de click del mouse en esta pantalla. Si `fun' es @code{None}, los vínculos existentes son removidos.

Ejemplo de una instancia TurtleScreen llamada @code{screen} y una instancia Turtle llamada @code{turtle}:

@example
>>> screen.onclick(turtle.goto) # Subsequently clicking into the TurtleScreen will
>>>                             # make the turtle move to the clicked point.
>>> screen.onclick(None)        # remove event binding again
@end example

@cartouche
@quotation Nota 
Este método `TurtleScreen' está disponible como una función global solo bajo el nombre @code{onscreenclick}. La función global @code{onclick} es otra derivada del método Turtle @code{onclick}.
@end quotation
@end cartouche
@end deffn

@geindex ontimer() (en el módulo turtle)
@anchor{library/turtle turtle ontimer}@anchor{3cf4}
@deffn {Función} turtle.ontimer (fun, t=0)

@*Parámetros: 

@itemize *

@item 
@code{fun} – una función sin argumentos

@item 
@code{t} – un número >= 0
@end itemize


Instala un temporizador que llama a `fun' cada `t' milisegundos.

@example
>>> running = True
>>> def f():
...     if running:
...         fd(50)
...         lt(60)
...         screen.ontimer(f, 250)
>>> f()   ### makes the turtle march around
>>> running = False
@end example
@end deffn

@geindex mainloop() (en el módulo turtle)
@geindex done() (en el módulo turtle)
@anchor{library/turtle turtle mainloop}@anchor{3cf5}
@deffn {Función} turtle.mainloop ()
@anchor{library/turtle turtle done}@anchor{3cf6}
@deffnx {Función} turtle.done ()

Comienza un bucle de evento - llamando a la función `mainloop' del `Tkinter'. Debe ser la última declaración en un programa gráfico de turtle. `No' debe ser usado si algún script es corrido dentro del IDLE en modo -n (Sin subproceso) - para uso interactivo de gráficos turtle.:

@example
>>> screen.mainloop()
@end example
@end deffn

@node Métodos de entrada,Configuración y métodos especiales,Usando eventos de pantalla,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle input-methods}@anchor{3d1c}
@subsubsection Métodos de entrada


@geindex textinput() (en el módulo turtle)
@anchor{library/turtle turtle textinput}@anchor{18cb}
@deffn {Función} turtle.textinput (title, prompt)

@*Parámetros: 

@itemize *

@item 
@code{title} – cadena de caracteres

@item 
@code{prompt} – cadena de caracteres
@end itemize


Abre una ventana de diálogo para ingresar una cadena de caracteres. El parámetro `title' es el título de la ventana de diálogo, `prompt' es un texto que usualmente describe que información se debe ingresar. Devuelve la cadena ingresada. Si el diálogo es cancelado, devuelve @code{None}.

@example
>>> screen.textinput("NIM", "Name of first player:")
@end example
@end deffn

@geindex numinput() (en el módulo turtle)
@anchor{library/turtle turtle numinput}@anchor{18cc}
@deffn {Función} turtle.numinput (title, prompt, default=None, minval=None, maxval=None)

@*Parámetros: 

@itemize *

@item 
@code{title} – cadena de caracteres

@item 
@code{prompt} – cadena de caracteres

@item 
@code{default} – número (opcional)

@item 
@code{minval} – número (opcional)

@item 
@code{maxval} – número (opcional)
@end itemize


Pop up a dialog window for input of a number. title is the title of the
dialog window, prompt is a text mostly describing what numerical information
to input. default: default value, minval: minimum value for input,
maxval: maximum value for input.
The number input must be in the range minval .. maxval if these are
given. If not, a hint is issued and the dialog remains open for
correction.
Return the number input. If the dialog is canceled,  return @code{None}.

@example
>>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)
@end example
@end deffn

@node Configuración y métodos especiales,Métodos específicos de Screen no heredados de TurtleScreen,Métodos de entrada,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle settings-and-special-methods}@anchor{3d1d}
@subsubsection Configuración y métodos especiales


@geindex mode() (en el módulo turtle)
@anchor{library/turtle turtle mode}@anchor{3cf7}
@deffn {Función} turtle.mode (mode=None)

@*Parámetros: 
@code{mode} – una de las cadenas `«standard»', `«logo'» o `«world'»


Establece el mode de la tortuga  (`«standard»', `«logo»' o `«world»') y realiza un reinicio. Si no se da «`mode'», retorna el modo actual.

El modo `«standard»' es compatible con el antiguo @ref{101,,turtle}. El modo `«logo»' es compatible con la mayoría de los gráficos de tortuga Logo. El modo `«world»' usa coordenadas de mundo definidas por el usuario. `Atención': en este modo los ángulos aparecen distorsionados si la relación de unidad @code{x/y} no es igual a 1.


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modo

@tab

Rumbo inicial de la tortuga

@tab

ángulos positivos

@item

`«standard»'

@tab

hacia la derecha (este)

@tab

sentido antihorario

@item

`«logo»'

@tab

hacia arriba (norte)

@tab

sentido horario

@end multitable


@example
>>> mode("logo")   # resets turtle heading to north
>>> mode()
'logo'
@end example
@end deffn

@geindex colormode() (en el módulo turtle)
@anchor{library/turtle turtle colormode}@anchor{3cf8}
@deffn {Función} turtle.colormode (cmode=None)

@*Parámetros: 
@code{cmode} – uno de los valores 1.0 o 255


Return the colormode or set it to 1.0 or 255.  Subsequently `r', `g', `b'
values of color triples have to be in the range 0..*cmode*.

@example
>>> screen.colormode(1)
>>> turtle.pencolor(240, 160, 80)
Traceback (most recent call last):
     ...
TurtleGraphicsError: bad color sequence: (240, 160, 80)
>>> screen.colormode()
1.0
>>> screen.colormode(255)
>>> screen.colormode()
255
>>> turtle.pencolor(240,160,80)
@end example
@end deffn

@geindex getcanvas() (en el módulo turtle)
@anchor{library/turtle turtle getcanvas}@anchor{3cf9}
@deffn {Función} turtle.getcanvas ()

Devuelve el lienzo de este `TurtleScreen'. Útil para conocedores que saben que hace con un `TKinter' `Canvas'.

@example
>>> cv = screen.getcanvas()
>>> cv
<turtle.ScrolledCanvas object ...>
@end example
@end deffn

@geindex getshapes() (en el módulo turtle)
@anchor{library/turtle turtle getshapes}@anchor{3cfa}
@deffn {Función} turtle.getshapes ()

Devuelve la lista de nombres de todas las formas de la tortuga actualmente disponibles.

@example
>>> screen.getshapes()
['arrow', 'blank', 'circle', ..., 'turtle']
@end example
@end deffn

@geindex register_shape() (en el módulo turtle)
@geindex addshape() (en el módulo turtle)
@anchor{library/turtle turtle register_shape}@anchor{3cfb}
@deffn {Función} turtle.register_shape (name, shape=None)
@anchor{library/turtle turtle addshape}@anchor{3cfc}
@deffnx {Función} turtle.addshape (name, shape=None)

Hay tres formas distintas de llamar a esta función:


@enumerate 

@item 
`name' es el nombre de un archivo gif y `shape' es @code{None}: instala la imagen correspondiente.

@example
>>> screen.register_shape("turtle.gif")
@end example

@cartouche
@quotation Nota 
Las imágenes de tipo `shapes' no rotan cuando la tortuga gira, así que ellas ¡no muestran el rumbo de la tortuga!
@end quotation
@end cartouche

@item 
`name' es una cadena de caracteres arbitraria y `shape' es una tupla de pares de coordenadas: Instala la forma poligonal correspondiente.

@example
>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))
@end example

@item 
`name' is an arbitrary string and `shape' is a (compound) @ref{3d16,,Shape}
object: Install the corresponding compound shape.
@end enumerate

Agregar una forma de tortuga a la lista  de formas de `TurtleScreen'. Solo las formas registradas de esta manera pueden ser usadas invocando el comando @code{shape(shapename)}.
@end deffn

@geindex turtles() (en el módulo turtle)
@anchor{library/turtle turtle turtles}@anchor{3cfd}
@deffn {Función} turtle.turtles ()

Devuelve la lista de tortugas en la pantalla.

@example
>>> for turtle in screen.turtles():
...     turtle.color("red")
@end example
@end deffn

@geindex window_height() (en el módulo turtle)
@anchor{library/turtle turtle window_height}@anchor{3cfe}
@deffn {Función} turtle.window_height ()

Devuelve la altura de la ventana de la tortuga.

@example
>>> screen.window_height()
480
@end example
@end deffn

@geindex window_width() (en el módulo turtle)
@anchor{library/turtle turtle window_width}@anchor{3cff}
@deffn {Función} turtle.window_width ()

Devuelve el ancho de la ventana de la tortuga.

@example
>>> screen.window_width()
640
@end example
@end deffn

@node Métodos específicos de Screen no heredados de TurtleScreen,,Configuración y métodos especiales,Métodos de TurtleScreen/Screen y sus correspondientes funciones
@anchor{library/turtle methods-specific-to-screen-not-inherited-from-turtlescreen}@anchor{3d1e}@anchor{library/turtle screenspecific}@anchor{3d1f}
@subsubsection Métodos específicos de `Screen', no heredados de `TurtleScreen'


@geindex bye() (en el módulo turtle)
@anchor{library/turtle turtle bye}@anchor{3d00}
@deffn {Función} turtle.bye ()

Apaga la ventana gráfica de la tortuga.
@end deffn

@geindex exitonclick() (en el módulo turtle)
@anchor{library/turtle turtle exitonclick}@anchor{3d01}
@deffn {Función} turtle.exitonclick ()

Ata el método @code{bye()} al click del ratón sobre la pantalla.

Si el valor `«using_IDLE»' en la configuración del diccionario es @code{False} (valor por defecto), también ingresa `mainloop'. Observaciones: si se usa la `IDLE' con el modificador (no subproceso) @code{-n}, este valor debe establecerse a @code{True} en @code{turtle.cfg}. En este caso el propio `mainloop' de la `IDLE' está activa también para script cliente.
@end deffn

@geindex save() (en el módulo turtle)
@anchor{library/turtle turtle save}@anchor{160e}
@deffn {Función} turtle.save (filename, overwrite=False)

Save the current turtle drawing (and turtles) as a PostScript file.

@*Parámetros: 

@itemize *

@item 
@code{filename} – the path of the saved PostScript file

@item 
@code{overwrite} – if @code{False} and there already exists a file with the given
filename, then the function will raise a
@code{FileExistsError}. If it is @code{True}, the file will be
overwritten.
@end itemize


@example
>>> screen.save("my_drawing.ps")
>>> screen.save("my_drawing.ps", overwrite=True)
@end example


Added in version 3.14.

@end deffn

@geindex setup() (en el módulo turtle)
@anchor{library/turtle turtle setup}@anchor{3d02}
@deffn {Función} turtle.setup (width=_CFG['width'], height=_CFG['height'], startx=_CFG['leftright'], starty=_CFG['topbottom'])

Establece el tamaño y la posición de la ventana principal. Los valores por defecto de los argumentos son guardados en el diccionario de configuración y puede ser cambiado a través del archivo  @code{turtle.cfg}.

@*Parámetros: 

@itemize *

@item 
@code{width} – si es un entero, el tamaño en pixeles, si es un número flotante, una fracción de la pantalla; el valor por defecto es 50% de la pantalla

@item 
@code{height} – si es un entero, la altura en pixeles, si es un número flotante, una fracción de la pantalla; el valor por defecto es 75% de la pantalla

@item 
@code{startx} – si es positivo, punto de inicio en pixeles desde la esquina izquierda de la pantalla, si es negativo desde la esquina derecha de la pantalla, si es @code{None}, centra la ventana horizontalmente

@item 
@code{starty} – si es positivo, punto de inicio en pixeles desde la parte superior de la pantalla, si es negativo desde la parte inferior de la pantalla, si es @code{None}, centra la ventana verticalmente
@end itemize


@example
>>> screen.setup (width=200, height=200, startx=0, starty=0)
>>>              # sets window to 200x200 pixels, in upper left of screen
>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
>>>              # sets window to 75% of screen by 50% of screen and centers
@end example
@end deffn

@geindex title() (en el módulo turtle)
@anchor{library/turtle turtle title}@anchor{3d03}
@deffn {Función} turtle.title (titlestring)

@*Parámetros: 
@code{titlestring} – una cadena de caracteres que se muestra en la barra de título de la ventana gráfica de la tortuga


Establece el título de la ventana de la tortuga a `titlestring'.

@example
>>> screen.title("Welcome to the turtle zoo!")
@end example
@end deffn

@node Clases públicas,Explanation,Métodos de TurtleScreen/Screen y sus correspondientes funciones,turtle — Gráficos con Turtle
@anchor{library/turtle public-classes}@anchor{3d20}
@subsubsection Clases públicas


@geindex RawTurtle (clase en turtle)
@geindex RawPen (clase en turtle)
@anchor{library/turtle turtle RawTurtle}@anchor{3d21}
@deffn {Clase} turtle.RawTurtle (canvas)
@anchor{library/turtle turtle RawPen}@anchor{3d22}
@deffnx {Clase} turtle.RawPen (canvas)

@*Parámetros: 
@code{canvas} – a @code{tkinter.Canvas}, a @ref{3d23,,ScrolledCanvas} or a
@ref{3d13,,TurtleScreen}


Crea una tortuga. La tortuga tiene todos los métodos descriptos anteriormente como «métodos de `«Turtle/RawTurtle»'.
@end deffn

@geindex Turtle (clase en turtle)
@anchor{library/turtle turtle Turtle}@anchor{3d24}
@deffn {Clase} turtle.Turtle

Subclase de `RawTurtle', tiene la misma interface pero dibuja sobre una objeto por defecto @ref{3c96,,Screen} creado automáticamente cuando es necesario por primera vez.
@end deffn

@geindex TurtleScreen (clase en turtle)
@anchor{library/turtle turtle TurtleScreen}@anchor{3d13}
@deffn {Clase} turtle.TurtleScreen (cv)

@*Parámetros: 
@code{cv} – a @code{tkinter.Canvas}


Provides screen oriented methods like @ref{3ce6,,bgcolor()} etc. that are described
above.
@end deffn

@geindex Screen (clase en turtle)
@anchor{library/turtle turtle Screen}@anchor{3c96}
@deffn {Clase} turtle.Screen

Subclase de `TurtleScreen', con @ref{3d1f,,cuatro métodos agregados}.
@end deffn

@geindex ScrolledCanvas (clase en turtle)
@anchor{library/turtle turtle ScrolledCanvas}@anchor{3d23}
@deffn {Clase} turtle.ScrolledCanvas (master)

@*Parámetros: 
@code{master} – algunos `widgets' `TKinter' para contener el `ScrollCanvas', por ejemplo un lienzo `Tkinter' con barras de desplazamiento agregadas


Usado por la clase `Screen', que proporciona automáticamente un `ScrolledCanvas' como espacio de trabajo para las tortugas.
@end deffn

@geindex Shape (clase en turtle)
@anchor{library/turtle turtle Shape}@anchor{3d16}
@deffn {Clase} turtle.Shape (type_, data)

@*Parámetros: 
@code{type_} – una de las cadenas de caracteres `«polygon»', `«image»', `«compound»'


Estructura de datos que modela las formas. El par @code{(type_, data)} debe seguir estas especificaciones:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`type_'

@tab

`data'

@item

`«polygon»'

@tab

una tupla para el polígono, por ejemplo: una tupla de par de coordenadas

@item

`«image»'

@tab

una imagen (en esta forma solo se usa ¡internamente!)

@item

`«compound»'

@tab

@code{None} (una forma compuesta tiene que ser construida usando el método @ref{3d17,,addcomponent()})

@end multitable


@geindex addcomponent() (método de turtle.Shape)
@anchor{library/turtle turtle Shape addcomponent}@anchor{3d17}
@deffn {Método} addcomponent (poly, fill, outline=None)

@*Parámetros: 

@itemize *

@item 
@code{poly} – un polígono, por ejemplo una tupla de pares de números

@item 
@code{fill} – un color con el que el polígono será llenado

@item 
@code{outline} – un color con el que se delineará el polígono (se de ingresa)
@end itemize


Ejemplo:

@example
>>> poly = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s = Shape("compound")
>>> s.addcomponent(poly, "red", "blue")
>>> # ... add more components and then use register_shape()
@end example

Ver @ref{3d15,,Formas compuestas}.
@end deffn
@end deffn

@geindex Vec2D (clase en turtle)
@anchor{library/turtle turtle Vec2D}@anchor{3d06}
@deffn {Clase} turtle.Vec2D (x, y)

Una clase de vectores bidimensionales, usado como clase de ayuda para implementar gráficos de tortuga. Puede ser útil para los programas de gráficos de tortugas también. Derivado de la tupla, ¡por lo que un vector es una tupla!

Proporciona (para `a', `b' vectores, `k' números)


@itemize *

@item 
@code{a + b} suma de vectores

@item 
@code{a - b} resta de vectores

@item 
@code{a * b} producto interno

@item 
@code{k * a} y @code{a * k} multiplicación con escalar

@item 
@code{abs(a)} valor absoluto de a

@item 
@code{a.rotate(angle)} rotación
@end itemize
@end deffn

@node Explanation,Ayuda y configuración,Clases públicas,turtle — Gráficos con Turtle
@anchor{library/turtle explanation}@anchor{3d25}@anchor{library/turtle turtle-explanation}@anchor{3c95}
@subsubsection Explanation


A turtle object draws on a screen object, and there a number of key classes in
the turtle object-oriented interface that can be used to create them and relate
them to each other.

A @ref{3d24,,Turtle} instance will automatically create a @ref{3c96,,Screen}
instance if one is not already present.

@code{Turtle} is a subclass of @ref{3d21,,RawTurtle}, which `doesn’t' automatically
create a drawing surface - a `canvas' will need to be provided or created for
it. The `canvas' can be a @code{tkinter.Canvas}, @ref{3d23,,ScrolledCanvas}
or @ref{3d13,,TurtleScreen}.

@ref{3d13,,TurtleScreen} is the basic drawing surface for a
turtle. @ref{3c96,,Screen} is a subclass of @code{TurtleScreen}, and
includes @ref{3d1f,,some additional methods} for managing its
appearance (including size and title) and behaviour. @code{TurtleScreen}’s
constructor needs a @code{tkinter.Canvas} or a
@ref{3d23,,ScrolledCanvas} as an argument.

The functional interface for turtle graphics uses the various methods of
@code{Turtle} and @code{TurtleScreen}/@code{Screen}. Behind the scenes, a screen
object is automatically created whenever a function derived from a @code{Screen}
method is called. Similarly, a turtle object is automatically created
whenever any of the functions derived from a Turtle method is called.

To use multiple turtles on a screen, the object-oriented interface must be
used.

@node Ayuda y configuración,turtledemo — Scripts de demostración,Explanation,turtle — Gráficos con Turtle
@anchor{library/turtle help-and-configuration}@anchor{3d26}
@subsubsection Ayuda y configuración


@menu
* Cómo usar la ayuda:: 
* Traducción de cadenas de documentos a diferentes idiomas:: 
* Cómo configurar Screen and Turtles:: 

@end menu

@node Cómo usar la ayuda,Traducción de cadenas de documentos a diferentes idiomas,,Ayuda y configuración
@anchor{library/turtle how-to-use-help}@anchor{3d27}
@subsubsection Cómo usar la ayuda


Los métodos públicos de las clases Screen y Turtle están ampliamente documentados a través de cadenas de documentación. Por lo tanto, estos se pueden usar como ayuda en línea a través de las instalaciones de ayuda de Python:


@itemize -

@item 
Cuando se usa IDLE, la información sobre herramientas muestra las firmas y las primeras líneas de las cadenas de documentos de las llamadas de función/método escritas.

@item 
Llamar a @ref{96e,,help()} en métodos o funciones muestra los docstrings:

@example
>>> help(Screen.bgcolor)
Help on method bgcolor in module turtle:

bgcolor(self, *args) unbound turtle.Screen method
    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers
    in the range 0..colormode or a 3-tuple of such numbers.


    >>> screen.bgcolor("orange")
    >>> screen.bgcolor()
    "orange"
    >>> screen.bgcolor(0.5,0,0.5)
    >>> screen.bgcolor()
    "#800080"

>>> help(Turtle.penup)
Help on method penup in module turtle:

penup(self) unbound turtle.Turtle method
    Pull the pen up -- no drawing when moving.

    Aliases: penup | pu | up

    No argument

    >>> turtle.penup()
@end example

@item 
Los docstrings de las funciones que se derivan de los métodos tienen una forma modificada:

@example
>>> help(bgcolor)
Help on function bgcolor in module turtle:

bgcolor(*args)
    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers
    in the range 0..colormode or a 3-tuple of such numbers.

    Example::

      >>> bgcolor("orange")
      >>> bgcolor()
      "orange"
      >>> bgcolor(0.5,0,0.5)
      >>> bgcolor()
      "#800080"

>>> help(penup)
Help on function penup in module turtle:

penup()
    Pull the pen up -- no drawing when moving.

    Aliases: penup | pu | up

    No argument

    Example:
    >>> penup()
@end example
@end itemize

Estos docstrings modificados se crean automáticamente junto con las definiciones de función que se derivan de los métodos en el momento de la importación.

@node Traducción de cadenas de documentos a diferentes idiomas,Cómo configurar Screen and Turtles,Cómo usar la ayuda,Ayuda y configuración
@anchor{library/turtle translation-of-docstrings-into-different-languages}@anchor{3d28}
@subsubsection Traducción de cadenas de documentos a diferentes idiomas


Existe una utilidad para crear un diccionario cuyas claves son los nombres de los métodos y cuyos valores son los docstrings de los métodos públicos de las clases Screen y Turtle.

@geindex write_docstringdict() (en el módulo turtle)
@anchor{library/turtle turtle write_docstringdict}@anchor{3d29}
@deffn {Función} turtle.write_docstringdict (filename='turtle_docstringdict')

@*Parámetros: 
@code{filename} – una cadena de caracteres, utilizada como nombre de archivo


Crea y escribe un diccionario-docstring en un script de Python con el nombre de archivo dado. Esta función tiene que ser llamada explícitamente (no es utilizada por las clases de gráficos de tortugas). El diccionario de docstrings se escribirá en el script de Python @code{`filename'.py}. Está destinado a servir como plantilla para la traducción de las cadenas de documentos a diferentes idiomas.
@end deffn

Si usted (o sus estudiantes) desea utilizar @ref{101,,turtle} con ayuda en línea en su idioma nativo, debe traducir los docstrings y guardar el archivo resultante como, por ejemplo, @code{turtle_docstringdict_german.py}.

Si tiene una entrada adecuada en su archivo @code{turtle.cfg}, este diccionario se leerá en el momento de la importación y reemplazará los docstrings originales en inglés.

En el momento de escribir este artículo, existen diccionarios de docstrings en alemán e italiano. (Solicitudes por favor a @email{glingl@@aon.at}.)

@node Cómo configurar Screen and Turtles,,Traducción de cadenas de documentos a diferentes idiomas,Ayuda y configuración
@anchor{library/turtle how-to-configure-screen-and-turtles}@anchor{3d2a}
@subsubsection Cómo configurar Screen and Turtles


La configuración predeterminada incorporada imita la apariencia y el comportamiento del antiguo módulo de tortuga para mantener la mejor compatibilidad posible con él.

Si desea utilizar una configuración diferente que refleje mejor las características de este módulo o que se adapte mejor a sus necesidades, por ejemplo, para su uso en un aula, puede preparar un archivo de configuración @code{turtle.cfg} que se leerá en el momento de la importación y modificará la configuración de acuerdo con su configuración.

The built in configuration would correspond to the following @code{turtle.cfg}:

@example
width = 0.5
height = 0.75
leftright = None
topbottom = None
canvwidth = 400
canvheight = 300
mode = standard
colormode = 1.0
delay = 10
undobuffersize = 1000
shape = classic
pencolor = black
fillcolor = black
resizemode = noresize
visible = True
language = english
exampleturtle = turtle
examplescreen = screen
title = Python Turtle Graphics
using_IDLE = False
@end example

Breve explicación de las entradas seleccionadas:


@itemize -

@item 
The first four lines correspond to the arguments of the @ref{3d02,,Screen.setup}
method.

@item 
Line 5 and 6 correspond to the arguments of the method
@ref{3cea,,Screen.screensize}.

@item 
`shape' puede ser cualquiera de las formas integradas, por ejemplo: arrow, turtle, etc. Para obtener más información, pruebe con @code{help(shape)}.

@item 
If you want to use no fill color (i.e. make the turtle transparent), you have
to write @code{fillcolor = ""} (but all nonempty strings must not have quotes in
the cfg file).

@item 
Si desea reflejar el estado de la tortuga, debe usar @code{resizemode = auto}.

@item 
If you set e.g. @code{language = italian} the docstringdict
@code{turtle_docstringdict_italian.py} will be loaded at import time (if
present on the import path, e.g. in the same directory as @ref{101,,turtle}).

@item 
Las entradas `exampleturtle' y `examplescreen' definen los nombres de estos objetos a medida que aparecen en las cadenas de documentos. La transformación de método-docstrings en función-docstrings eliminará estos nombres de las docstrings.

@item 
`using_IDLE': Set this to @code{True} if you regularly work with IDLE and its @code{-n}
switch («no subprocess»).  This will prevent @ref{3d01,,exitonclick()} to enter the
mainloop.
@end itemize

Puede haber un archivo @code{turtle.cfg} en el directorio donde se almacena @ref{101,,turtle} y uno adicional en el directorio de trabajo actual. Este último anulará la configuración del primero.

El directorio @code{Lib/turtledemo} contiene un archivo @code{turtle.cfg}. Puede estudiarlo como un ejemplo y ver sus efectos al ejecutar las demostraciones (preferiblemente no desde el visor de demostraciones).

@node turtledemo — Scripts de demostración,Cambios desde Python 2 6,Ayuda y configuración,turtle — Gráficos con Turtle
@anchor{library/turtle module-turtledemo}@anchor{102}@anchor{library/turtle turtledemo-demo-scripts}@anchor{3d2b}
@subsubsection @code{turtledemo} — Scripts de demostración


@geindex module; turtledemo

El paquete @ref{102,,turtledemo} incluye un conjunto de scripts de demostración. Estos scripts se pueden ejecutar y visualizar utilizando el visor de demostración suministrado de la siguiente manera:

@example
python -m turtledemo
@end example

Alternativamente, puede ejecutar los scripts de demostración individualmente. Por ejemplo,

@example
python -m turtledemo.bytedesign
@end example

El directorio del paquete @ref{102,,turtledemo} contiene:


@itemize -

@item 
Un visor de demostración @code{__main__.py} que se puede utilizar para ver el código fuente de los scripts y ejecutarlos al mismo tiempo.

@item 
Múltiples scripts que demuestran diferentes características del módulo @ref{101,,turtle}. Se puede acceder a los ejemplos a través del menú de ejemplos. También se pueden ejecutar de forma independiente.

@item 
Un archivo @code{turtle.cfg} que sirve como ejemplo de cómo escribir y usar dichos archivos.
@end itemize

Los scripts de demostración son:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Descripción

@tab

Características

@item

bytedesign

@tab

patrón de gráficos de tortuga clásica compleja

@tab

@ref{3ced,,tracer()}, retrasar (`delay'), @ref{3cee,,update()}

@item

caos

@tab

gráficos dinámicos de Verhulst, muestra que los cálculos de la computadora pueden generar resultados a veces contra las expectativas del sentido común

@tab

coordenadas mundiales

@item

reloj

@tab

reloj analógico que muestra la hora de su computadora

@tab

tortugas como manecillas de reloj, temporizador

@item

colormixer

@tab

experimento con r, g, b

@tab

@ref{3cdb,,ondrag()}

@item

bosque

@tab

3 árboles de ancho primero

@tab

aleatorización

@item

fractalcurves

@tab

Curvas Hilbert & Koch

@tab

recursión

@item

lindenmayer

@tab

etnomatemáticas (kolams indios)

@tab

Sistema-L

@item

minimal_hanoi

@tab

Torres de Hanoi

@tab

Tortugas rectangulares como discos de Hanoi (shape, tamaño de forma)

@item

nim

@tab

juega el clásico juego de nim con tres montones de palos contra la computadora.

@tab

tortugas como nimsticks, impulsado por eventos (mouse, teclado)

@item

pintar

@tab

programa de dibujo super minimalista

@tab

@ref{3cd9,,onclick()}

@item

paz

@tab

elemental

@tab

turtle: apariencia y animación

@item

penrose

@tab

embaldosado aperiódico con cometas y dardos

@tab

@ref{3cab,,stamp()}

@item

planet_and_moon

@tab

simulación de sistema gravitacional

@tab

formas compuestas, @ref{3d06,,Vec2D}

@item

rosette

@tab

un patrón del artículo de wikipedia sobre gráficos de tortuga (`turtle')

@tab

@ref{3cdf,,clone()},
@ref{3cae,,undo()}

@item

round_dance

@tab

tortugas bailarinas que giran por parejas en dirección opuesta

@tab

formas compuestas, clonar tamaño de forma, tilt, get_shapepoly, update

@item

sorting_animate

@tab

demostración visual de diferentes métodos de ordenamiento

@tab

alineación simple, aleatorización

@item

árbol

@tab

un primer árbol de amplitud (gráfico, usando generadores)

@tab

@ref{3cdf,,clone()}

@item

two_canvases

@tab

diseño simple

@tab

tortugas en dos lienzos (`two_canvases')

@item

yinyang

@tab

otro ejemplo elemental

@tab

@ref{3ca9,,circle()}

@end multitable


¡Diviértete!

@node Cambios desde Python 2 6,Cambios desde Python 3 0,turtledemo — Scripts de demostración,turtle — Gráficos con Turtle
@anchor{library/turtle changes-since-python-2-6}@anchor{3d2c}
@subsubsection Cambios desde Python 2.6



@itemize -

@item 
The methods @ref{3ced,,Turtle.tracer}, @ref{3cff,,Turtle.window_width} and
@ref{3cfe,,Turtle.window_height} have been eliminated.
Methods with these names and functionality are now available only
as methods of @ref{3c96,,Screen}. The functions derived from these remain
available. (In fact already in Python 2.6 these methods were merely
duplications of the corresponding
@ref{3d13,,TurtleScreen}/@ref{3c96,,Screen} methods.)

@item 
The method @code{Turtle.fill()} has been eliminated.
The behaviour of @ref{3cc7,,begin_fill()} and @ref{3cc8,,end_fill()}
have changed slightly: now every filling process must be completed with an
@code{end_fill()} call.

@item 
A method @ref{3cc6,,Turtle.filling} has been added. It returns a boolean
value: @code{True} if a filling process is under way, @code{False} otherwise.
This behaviour corresponds to a @code{fill()} call without arguments in
Python 2.6.
@end itemize

@node Cambios desde Python 3 0,,Cambios desde Python 2 6,turtle — Gráficos con Turtle
@anchor{library/turtle changes-since-python-3-0}@anchor{3d2d}
@subsubsection Cambios desde Python 3.0



@itemize -

@item 
The @ref{3d24,,Turtle} methods @ref{3cd5,,shearfactor()}, @ref{3cd7,,shapetransform()} and
@ref{3cd8,,get_shapepoly()} have been added. Thus the full range of
regular linear transforms is now available for transforming turtle shapes.
@ref{7c1,,tiltangle()} has been enhanced in functionality: it now can
be used to get or set the tilt angle.

@item 
The @ref{3c96,,Screen} method @ref{3cf2,,onkeypress()} has been added as a complement to
@ref{3cf0,,onkey()}. As the latter binds actions to the key release event,
an alias: @ref{3cf1,,onkeyrelease()} was also added for it.

@item 
The method @ref{3cf5,,Screen.mainloop} has been added,
so there is no longer a need to use the standalone @ref{3cf5,,mainloop()} function
when working with @ref{3c96,,Screen} and @ref{3d24,,Turtle} objects.

@item 
Two input methods have been added: @ref{18cb,,Screen.textinput} and
@ref{18cc,,Screen.numinput}. These pop up input dialogs and return
strings and numbers respectively.
@end itemize

@c >>> for turtle in turtles():
@c ...      turtle.reset()
@c >>> turtle.penup()
@c >>> turtle.goto(-200,25)
@c >>> turtle.pendown()
@c >>> turtle.write("No one expects the Spanish Inquisition!",
@c ...      font=("Arial", 20, "normal"))
@c >>> turtle.penup()
@c >>> turtle.goto(-100,-50)
@c >>> turtle.pendown()
@c >>> turtle.write("Our two chief Turtles are...",
@c ...      font=("Arial", 16, "normal"))
@c >>> turtle.penup()
@c >>> turtle.goto(-450,-75)
@c >>> turtle.write(str(turtles()))

@node cmd — Support for line-oriented command interpreters,shlex — Simple lexical analysis,turtle — Gráficos con Turtle,Frameworks de programa
@anchor{library/cmd doc}@anchor{3d2e}@anchor{library/cmd cmd-support-for-line-oriented-command-interpreters}@anchor{3d2f}@anchor{library/cmd module-cmd}@anchor{1a}
@subsection @code{cmd} — Support for line-oriented command interpreters


@geindex module; cmd

`Código fuente:' Lib/cmd.py@footnote{https://github.com/python/cpython/tree/main/Lib/cmd.py}


__________________________________________________________________


La clase @ref{16cf,,Cmd} proporciona un `framework' simple para escribir intérpretes de comandos orientados a línea. A menudo son útiles para agentes de prueba, herramientas administrativas y prototipos que luego se incluirán en una interfaz más sofisticada.

@geindex Cmd (clase en cmd)
@anchor{library/cmd cmd Cmd}@anchor{16cf}
@deffn {Clase} cmd.Cmd (completekey='tab', stdin=None, stdout=None)

Una instancia @ref{16cf,,Cmd} o subclase de la instancia es un `framework' intérprete orientado a líneas. No hay una buena razón para crear instancias @ref{16cf,,Cmd}; mas bien, es útil como una super clase de una clase intérprete que usted define con el fin de heredar métodos @ref{16cf,,Cmd} y encapsular métodos de acción.

El argumento opcional `completekey' es el nombre @ref{ba,,readline} de una llave de finalización; por defecto es @code{Tab}. Si `completekey' no es @ref{716,,None} y @ref{ba,,readline} está disponible, el comando de finalización es hecho automáticamente.

The default, @code{'tab'}, is treated specially, so that it refers to the
@code{Tab} key on every @ref{16b7,,readline.backend}.
Specifically, if @ref{16b7,,readline.backend} is @code{editline},
@code{Cmd} will use @code{'^I'} instead of @code{'tab'}.
Note that other values are not treated this way, and might only work
with a specific backend.

Los argumentos opcionales `stdin' y `stdout' especifican la entrada y salida de los objetos archivo que la instancia Cmd o la instancia subclase usará para la entrada y salida. Si no está especificado, se predeterminarán a @ref{5df,,sys.stdin} y @ref{b61,,sys.stdout}.

Si desea un `stdin' dado a ser usado, asegúrese de establecer las instancias atributo @ref{3d30,,use_rawinput} a @code{False}, de lo contrario `stdin' será ignorado.


Distinto en la versión 3.13: @code{completekey='tab'} is replaced by @code{'^I'} for @code{editline}.

@end deffn

@menu
* Objetos Cmd:: 
* Ejemplo Cmd:: 

@end menu

@node Objetos Cmd,Ejemplo Cmd,,cmd — Support for line-oriented command interpreters
@anchor{library/cmd cmd-objects}@anchor{3d31}@anchor{library/cmd id1}@anchor{3d32}
@subsubsection Objetos Cmd


Una instancia @ref{16cf,,Cmd} tiene los siguientes métodos:

@geindex cmdloop() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd cmdloop}@anchor{3d33}
@deffn {Método} Cmd.cmdloop (intro=None)

Emita repetidamente una solicitud, acepte la entrada, analice un prefijo inicial de la entrada recibida y envíe a los métodos de acción, pasándoles el resto de la línea como argumento.

El argumento opcional es un `banner' o cadena de caracteres introductoria que se tramitará antes del primer mensaje (esto anula el atributo de clase @ref{3d34,,intro}).

Si el módulo @ref{ba,,readline} es cargado, la entrada heredará automáticamente @code{bash}-como edición historia-lista (e.g. @code{Control-P} retorna al último comando, @code{Control-N} adelanta al siguiente, @code{Control-F} mueve el cursor a la derecha no destructivamente, @code{Control-B} mueve el cursor a la izquierda no destructivamente, etc.).

Un fin-de-archivo en la entrada es retornado como cadena de caracteres @code{’EOF’}.

@geindex ? (signo de interrogación);en un intérprete de comandos
@geindex ! (exclamación);en un intérprete de comandos

An interpreter instance will recognize a command name @code{foo} if and only if it
has a method @code{do_foo()}.  As a special case, a line beginning with the
character @code{'?'} is dispatched to the method @ref{16bc,,do_help()}.  As another
special case, a line beginning with the character @code{'!'} is dispatched to the
method @code{do_shell()} (if such a method is defined).

This method will return when the @ref{3d35,,postcmd()} method returns a true value.
The `stop' argument to @ref{3d35,,postcmd()} is the return value from the command’s
corresponding @code{do_*()} method.

If completion is enabled, completing commands will be done automatically, and
completing of commands args is done by calling @code{complete_foo()} with
arguments `text', `line', `begidx', and `endidx'.  `text' is the string prefix
we are attempting to match: all returned matches must begin with it. `line' is
the current input line with leading whitespace removed, `begidx' and `endidx'
are the beginning and ending indexes of the prefix text, which could be used to
provide different completion depending upon which position the argument is in.
@end deffn

@geindex do_help() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd do_help}@anchor{16bc}
@deffn {Método} Cmd.do_help (arg)

All subclasses of @ref{16cf,,Cmd} inherit a predefined @code{do_help()}.  This
method, called with an argument @code{'bar'}, invokes the corresponding method
@code{help_bar()}, and if that is not present, prints the docstring of
@code{do_bar()}, if available.  With no argument, @code{do_help()} lists all
available help topics (that is, all commands with corresponding
@code{help_*()} methods or commands that have docstrings), and also lists any
undocumented commands.
@end deffn

@geindex onecmd() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd onecmd}@anchor{3d36}
@deffn {Método} Cmd.onecmd (str)

Interpret the argument as though it had been typed in response to the prompt.
This may be overridden, but should not normally need to be; see the
@ref{3d37,,precmd()} and @ref{3d35,,postcmd()} methods for useful execution hooks.  The
return value is a flag indicating whether interpretation of commands by the
interpreter should stop.  If there is a @code{do_*()} method for the command
`str', the return value of that method is returned, otherwise the return value
from the @ref{3d38,,default()} method is returned.
@end deffn

@geindex emptyline() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd emptyline}@anchor{3d39}
@deffn {Método} Cmd.emptyline ()

Método llamado cuando se ingresa una línea vacía en respuesta a la solicitud. Si este método no se anula, repite el último comando no vacío ingresado.
@end deffn

@geindex default() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd default}@anchor{3d38}
@deffn {Método} Cmd.default (line)

Método llamado en una línea de entrada cuando no se reconoce el prefijo del comando. Si este método no se anula, imprime un mensaje de error y retorna.
@end deffn

@geindex completedefault() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd completedefault}@anchor{3d3a}
@deffn {Método} Cmd.completedefault (text, line, begidx, endidx)

Method called to complete an input line when no command-specific
@code{complete_*()} method is available.  By default, it returns an empty list.
@end deffn

@geindex columnize() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd columnize}@anchor{186e}
@deffn {Método} Cmd.columnize (list, displaywidth=80)

Método llamado para mostrar una lista de cadenas de caracteres como un set compacto de columnas. Cada columna es tan amplia como sea necesaria. Las columnas se separan por dos espacios para facilidad de lectura.
@end deffn

@geindex precmd() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd precmd}@anchor{3d37}
@deffn {Método} Cmd.precmd (line)

Método de enlace ejecutado justo antes de que se interprete la línea de comando `line', pero después de que se genere y emita la solicitud de entrada. Este método es un trozo en @ref{16cf,,Cmd}; existe para ser anulado por subclases. El valor de retorno es utilizado como el comando que se ejecutará mediante el método @ref{3d36,,onecmd()}; la implementación @ref{3d37,,precmd()} puede reescribir el comando o simplemente retornar `line' sin cambios.
@end deffn

@geindex postcmd() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd postcmd}@anchor{3d35}
@deffn {Método} Cmd.postcmd (stop, line)

Método de enlace ejecutado justo después de que finaliza un despacho de comando. Este método es un trozo en @ref{16cf,,Cmd}; existe para ser anulado por subclases. `line' es la línea de comando que se ejecutó, y `stop' es una bandera que indica si la ejecución finalizará después de la llamada a @ref{3d35,,postcmd()}; este será el valor de retorno del método @ref{3d36,,onecmd()}. El valor de retorno de este método será usado como el nuevo valor para la bandera interna que corresponde a `stop'; retornando falso hará que la interpretación continúe.
@end deffn

@geindex preloop() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd preloop}@anchor{3d3b}
@deffn {Método} Cmd.preloop ()

Método de enlace ejecutado una vez cuando @ref{3d33,,cmdloop()} es llamado. Este método es un trozo en @ref{16cf,,Cmd}; existe para ser anulado por subclases.
@end deffn

@geindex postloop() (método de cmd.Cmd)
@anchor{library/cmd cmd Cmd postloop}@anchor{3d3c}
@deffn {Método} Cmd.postloop ()

Método de enlace ejecutado una vez cuando @ref{3d33,,cmdloop()} está a punto de retornar. Este método es un trozo en @ref{16cf,,Cmd}; existe para ser anulado por subclases.
@end deffn

Instancias de subclases @ref{16cf,,Cmd} tienen algunas variables de instancia públicas:

@geindex prompt (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd prompt}@anchor{3d3d}
@deffn {Atributo} Cmd.prompt

El aviso emitido para solicitar entradas.
@end deffn

@geindex identchars (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd identchars}@anchor{3d3e}
@deffn {Atributo} Cmd.identchars

La cadena de caracteres aceptada para el prefijo del comando.
@end deffn

@geindex lastcmd (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd lastcmd}@anchor{3d3f}
@deffn {Atributo} Cmd.lastcmd

El último prefijo de comando no vacío visto.
@end deffn

@geindex cmdqueue (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd cmdqueue}@anchor{3d40}
@deffn {Atributo} Cmd.cmdqueue

Una lista de líneas de entrada puestas en cola. La lista `cmdqueue' es verificada en @ref{3d33,,cmdloop()} cuando una nueva entrada es necesitada; Si es no vacía, sus elementos serán procesados en orden, como si se ingresara en la solicitud.
@end deffn

@geindex intro (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd intro}@anchor{3d34}
@deffn {Atributo} Cmd.intro

Una cadena para emitir como introducción o `banner'. Puede ser anulado dando un argumento al método @ref{3d33,,cmdloop()}.
@end deffn

@geindex doc_header (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd doc_header}@anchor{3d41}
@deffn {Atributo} Cmd.doc_header

El encabezado a tramitar si la salida de ayuda tiene una sección para comandos documentados.
@end deffn

@geindex misc_header (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd misc_header}@anchor{3d42}
@deffn {Atributo} Cmd.misc_header

The header to issue if the help output has a section for miscellaneous  help
topics (that is, there are @code{help_*()} methods without corresponding
@code{do_*()} methods).
@end deffn

@geindex undoc_header (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd undoc_header}@anchor{3d43}
@deffn {Atributo} Cmd.undoc_header

The header to issue if the help output has a section for undocumented  commands
(that is, there are @code{do_*()} methods without corresponding @code{help_*()}
methods).
@end deffn

@geindex ruler (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd ruler}@anchor{3d44}
@deffn {Atributo} Cmd.ruler

El carácter utilizado para dibujar líneas separadoras debajo de los encabezados mensajes-ayuda. Si está vacío, no se dibuja una línea regla. El valor predeterminado es @code{’=‘}.
@end deffn

@geindex use_rawinput (atributo de cmd.Cmd)
@anchor{library/cmd cmd Cmd use_rawinput}@anchor{3d30}
@deffn {Atributo} Cmd.use_rawinput

A flag, defaulting to true.  If true, @ref{3d33,,cmdloop()} uses @ref{1340,,input()} to
display a prompt and read the next command; if false, @ref{b61,,sys.stdout.write()}
and @ref{5df,,sys.stdin.readline()} are used. (This means that by importing
@ref{ba,,readline}, on systems that support it, the interpreter will automatically
support @code{Emacs}-like line editing  and command-history keystrokes.)
@end deffn

@node Ejemplo Cmd,,Objetos Cmd,cmd — Support for line-oriented command interpreters
@anchor{library/cmd cmd-example}@anchor{3d45}@anchor{library/cmd id2}@anchor{3d46}
@subsubsection Ejemplo Cmd


El módulo @ref{1a,,cmd} es principalmente útil para construir shells personalizados que permiten al usuario trabajar con un programa de forma interactiva.

Esta sección presenta un ejemplo simple de cómo construir un `shell' alrededor de algunos de los comandos en el módulo @ref{101,,turtle}.

Basic turtle commands such as @ref{3c90,,forward()} are added to a
@ref{16cf,,Cmd} subclass with method named @code{do_forward()}.  The argument is
converted to a number and dispatched to the turtle module.  The docstring is
used in the help utility provided by the shell.

The example also includes a basic record and playback facility implemented with
the @ref{3d37,,precmd()} method which is responsible for converting the input to
lowercase and writing the commands to a file.  The @code{do_playback()} method
reads the file and adds the recorded commands to the @ref{3d40,,cmdqueue} for
immediate playback:

@example
import cmd, sys
from turtle import *

class TurtleShell(cmd.Cmd):
    intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
    prompt = '(turtle) '
    file = None

    # ----- basic turtle commands -----
    def do_forward(self, arg):
        'Move the turtle forward by the specified distance:  FORWARD 10'
        forward(*parse(arg))
    def do_right(self, arg):
        'Turn turtle right by given number of degrees:  RIGHT 20'
        right(*parse(arg))
    def do_left(self, arg):
        'Turn turtle left by given number of degrees:  LEFT 90'
        left(*parse(arg))
    def do_goto(self, arg):
        'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
        goto(*parse(arg))
    def do_home(self, arg):
        'Return turtle to the home position:  HOME'
        home()
    def do_circle(self, arg):
        'Draw circle with given radius an options extent and steps:  CIRCLE 50'
        circle(*parse(arg))
    def do_position(self, arg):
        'Print the current turtle position:  POSITION'
        print('Current position is %d %d\n' % position())
    def do_heading(self, arg):
        'Print the current turtle heading in degrees:  HEADING'
        print('Current heading is %d\n' % (heading(),))
    def do_color(self, arg):
        'Set the color:  COLOR BLUE'
        color(arg.lower())
    def do_undo(self, arg):
        'Undo (repeatedly) the last turtle action(s):  UNDO'
    def do_reset(self, arg):
        'Clear the screen and return turtle to center:  RESET'
        reset()
    def do_bye(self, arg):
        'Stop recording, close the turtle window, and exit:  BYE'
        print('Thank you for using Turtle')
        self.close()
        bye()
        return True

    # ----- record and playback -----
    def do_record(self, arg):
        'Save future commands to filename:  RECORD rose.cmd'
        self.file = open(arg, 'w')
    def do_playback(self, arg):
        'Playback commands from a file:  PLAYBACK rose.cmd'
        self.close()
        with open(arg) as f:
            self.cmdqueue.extend(f.read().splitlines())
    def precmd(self, line):
        line = line.lower()
        if self.file and 'playback' not in line:
            print(line, file=self.file)
        return line
    def close(self):
        if self.file:
            self.file.close()
            self.file = None

def parse(arg):
    'Convert a series of zero or more numbers to an argument tuple'
    return tuple(map(int, arg.split()))

if __name__ == '__main__':
    TurtleShell().cmdloop()
@end example

Aquí hay una sesión de muestra con la `turle shell' mostrando las funciones de ayuda, de ayuda, usando líneas en blanco para repetir comandos, un registro simple y facilidad de reproducción:

@example
Welcome to the turtle shell.   Type help or ? to list commands.

(turtle) ?

Documented commands (type help <topic>):
========================================
bye     color    goto     home  playback  record  right
circle  forward  heading  left  position  reset   undo

(turtle) help forward
Move the turtle forward by the specified distance:  FORWARD 10
(turtle) record spiral.cmd
(turtle) position
Current position is 0 0

(turtle) heading
Current heading is 0

(turtle) reset
(turtle) circle 20
(turtle) right 30
(turtle) circle 40
(turtle) right 30
(turtle) circle 60
(turtle) right 30
(turtle) circle 80
(turtle) right 30
(turtle) circle 100
(turtle) right 30
(turtle) circle 120
(turtle) right 30
(turtle) circle 120
(turtle) heading
Current heading is 180

(turtle) forward 100
(turtle)
(turtle) right 90
(turtle) forward 100
(turtle)
(turtle) right 90
(turtle) forward 400
(turtle) right 90
(turtle) forward 500
(turtle) right 90
(turtle) forward 400
(turtle) right 90
(turtle) forward 300
(turtle) playback spiral.cmd
Current position is 0 0

Current heading is 0

Current heading is 180

(turtle) bye
Thank you for using Turtle
@end example

@node shlex — Simple lexical analysis,,cmd — Support for line-oriented command interpreters,Frameworks de programa
@anchor{library/shlex doc}@anchor{3d47}@anchor{library/shlex module-shlex}@anchor{c4}@anchor{library/shlex shlex-simple-lexical-analysis}@anchor{3d48}
@subsection @code{shlex} — Simple lexical analysis


@geindex module; shlex

`Código fuente:' Lib/shlex.py@footnote{https://github.com/python/cpython/tree/main/Lib/shlex.py}


__________________________________________________________________


La clase @ref{d54,,shlex} facilita la escritura de analizadores léxicos para sintaxis simples que se parecen al intérprete de comandos de Unix. Esto será a menudo útil para escribir pequeños lenguajes, (por ejemplo, en archivos de control para aplicaciones Python) o para analizar cadenas de texto citadas.

El módulo @ref{c4,,shlex} define las siguientes funciones:

@geindex split() (en el módulo shlex)
@anchor{library/shlex shlex split}@anchor{5de}
@deffn {Función} shlex.split (s, comments=False, posix=True)

Divide la cadena de caracteres `s' usando una sintaxis similar a la de un intérprete de comandos.  Si `comments' es @ref{bbf,,False} (por defecto), el análisis de los comentarios en la cadena de caracteres dada sera deshabilitada (estableciendo el atributo @ref{3d49,,commenters} de la instancia @ref{d54,,shlex} a la cadena de caracteres vacía). Esta función trabaja en modo POSIX por defecto, pero utiliza el modo non-POSIX si el argumento `posix' es falso.


Distinto en la versión 3.12: Pasar @code{None} para el argumento `s' ahora lanza una excepción, en lugar de leer @ref{5df,,sys.stdin}.

@end deffn

@geindex join() (en el módulo shlex)
@anchor{library/shlex shlex join}@anchor{ab9}
@deffn {Función} shlex.join (split_command)

Concatena los tokens de la lista `split_command' y retorna una cadena. Esta función es la inversa de @ref{5de,,split()}.

@example
>>> from shlex import join
>>> print(join(['echo', '-n', 'Multiple words']))
echo -n 'Multiple words'
@end example

El valor retornado se escapa del intérprete de comandos para protegerlo contra vulnerabilidades de inyección (consulte @ref{3d2,,quote()}).


Added in version 3.8.

@end deffn

@geindex quote() (en el módulo shlex)
@anchor{library/shlex shlex quote}@anchor{3d2}
@deffn {Función} shlex.quote (s)

Retorna una versión con escape del intérprete de comandos de la cadena `s'.  El valor retornado es una cadena que se puede usar de forma segura como un token en un intérprete de línea de comandos, para los casos en los que no se puede usar una lista.
@anchor{library/shlex shlex-quote-warning}@anchor{3166}
@cartouche
@quotation Advertencia 
El módulo @code{shlex} `solo está diseñado para los intérpretes de comandos UNIX'.

No se garantiza que la función @ref{3d2,,quote()} sea correcta en shells no compatibles con POSIX o shells de otros sistemas operativos como Windows. La ejecución de comandos citados por este módulo en tales shells puede abrir la posibilidad de una vulnerabilidad de inyección de comandos.

Considere el uso de funciones que pasen argumentos mediante listas tal como @ref{c0e,,subprocess.run()} con @code{shell=False}.
@end quotation
@end cartouche

Este idioma sería inseguro:

@example
>>> filename = 'somefile; rm -rf ~'
>>> command = 'ls -l @{@}'.format(filename)
>>> print(command)  # executed by a shell: boom!
ls -l somefile; rm -rf ~
@end example

@ref{3d2,,quote()} te permite tapar el agujero de seguridad:

@example
>>> from shlex import quote
>>> command = 'ls -l @{@}'.format(quote(filename))
>>> print(command)
ls -l 'somefile; rm -rf ~'
>>> remote_command = 'ssh home @{@}'.format(quote(command))
>>> print(remote_command)
ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"'@w{'}
@end example

La cita es compatible con los intérpretes de comandos UNIX y con @ref{5de,,split()}:

@example
>>> from shlex import split
>>> remote_command = split(remote_command)
>>> remote_command
['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]
>>> command = split(remote_command[-1])
>>> command
['ls', '-l', 'somefile; rm -rf ~']
@end example


Added in version 3.3.

@end deffn

El módulo @ref{c4,,shlex} define las siguientes clases:

@geindex shlex (clase en shlex)
@anchor{library/shlex shlex shlex}@anchor{d54}
@deffn {Clase} shlex.shlex (instream=None, infile=None, posix=False, punctuation_chars=False)

Una instancia o instancia de la subclase @ref{d54,,shlex} es un objeto de analizador léxico.  El argumento de inicialización, si está presente, especifica de dónde leer caracteres.  Debe ser un objeto similar a un archivo/stream con los métodos @ref{1c8c,,read()} y @ref{1cc4,,readline()} o una cadena de caracteres.  Si no se da ningún argumento, la entrada se tomará de @code{sys.stdin}. El segundo argumento opcional es una cadena de nombre de archivo, que establece el valor inicial del atributo @ref{3d4a,,infile}.  Si el argumento `instream' es omitido o es igual a @code{sys.stdin}, este segundo argumento tiene como valor predeterminado «stdin».  El argumento `posix' define el modo operativo: cuando `posix' no es true (predeterminado), la instancia @ref{d54,,shlex} funcionará en modo de compatibilidad.  Cuando se opera en modo POSIX, @ref{d54,,shlex} intentará estar lo más cerca posible de las reglas de análisis de el intérprete de comandos POSIX.  El argumento `punctuation_chars' proporciona una manera de hacer que el comportamiento sea aún más cercano a la forma en que se analizan los intérpretes de comandos reales.  Esto puede tomar una serie de valores: el valor predeterminado, @code{False}, conserva el comportamiento visto en Python 3.5 y versiones anteriores.  Si se establece en @code{True}, se cambia el análisis de los caracteres @code{();<>|&}: cualquier ejecución de estos caracteres (caracteres considerados de puntuación) se retorna como un único token.  Si se establece en una cadena de caracteres no vacía, esos caracteres se utilizarán como caracteres de puntuación.  Los caracteres del atributo @ref{3d4b,,wordchars} que aparecen en `punctuation_chars' se eliminarán de @ref{3d4b,,wordchars}.  Consulte @ref{d55,,Compatibilidad mejorada con intérprete de comandos} para obtener más información. `punctuation_chars' solo se puede establecer en la creación de la instancia @ref{d54,,shlex} y no se puede modificar más adelante.


Distinto en la versión 3.6: Se añadió el parámetro `punctuation_chars'.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{23,,configparser}

Analizador de archivos de configuración similares a los archivos @code{.ini} de Windows.
@end table


@menu
* objetos shlex:: 
* Reglas de análisis:: 
* Compatibilidad mejorada con intérprete de comandos:: 

@end menu

@node objetos shlex,Reglas de análisis,,shlex — Simple lexical analysis
@anchor{library/shlex id1}@anchor{3d4c}@anchor{library/shlex shlex-objects}@anchor{3d4d}
@subsubsection objetos @code{shlex}


Una instancia @ref{d54,,shlex} tiene los siguientes métodos:

@geindex get_token() (método de shlex.shlex)
@anchor{library/shlex shlex shlex get_token}@anchor{3d4e}
@deffn {Método} shlex.get_token ()

Retorna un token.  Si los tokens han sido apiladas usando @ref{3d4f,,push_token()}, saca una ficha de la pila.  De lo contrario, lee uno de la secuencia de entrada.  Si la lectura encuentra un fin de archivo inmediato, @ref{3d50,,eof} se retorna (la cadena de caracteres vacía (@code{'@w{'}}) en modo no-POSIX, y @code{None} en modo POSIX).
@end deffn

@geindex push_token() (método de shlex.shlex)
@anchor{library/shlex shlex shlex push_token}@anchor{3d4f}
@deffn {Método} shlex.push_token (str)

Coloca el argumento en la pila de tokens.
@end deffn

@geindex read_token() (método de shlex.shlex)
@anchor{library/shlex shlex shlex read_token}@anchor{3d51}
@deffn {Método} shlex.read_token ()

Lee un token sin procesar. Ignora la pila de retroceso y no interpreta las peticiones de la fuente.  (Este no es normalmente un punto de entrada útil, y está documentado aquí sólo para completarlo.)
@end deffn

@geindex sourcehook() (método de shlex.shlex)
@anchor{library/shlex shlex shlex sourcehook}@anchor{3d52}
@deffn {Método} shlex.sourcehook (filename)

Cuando @ref{d54,,shlex} detecta una petición de fuente (ver @ref{3d53,,source} abajo) este método recibe el siguiente token como argumento, y se espera que retorne una tupla que consista en un nombre de archivo y un archivo abierto como objeto.

Normalmente, este método primero elimina las comillas del argumento.  Si el resultado es un nombre de ruta absoluto, o no había ninguna solicitud de origen anterior en vigor, o el origen anterior era una secuencia (como @code{sys.stdin}), el resultado se deja solo.  De lo contrario, si el resultado es un nombre de ruta relativo, la parte del directorio del nombre del archivo se pone inmediatamente antes en la pila de inclusión de origen (este comportamiento es similar a la forma en que el preprocesador de C controla @code{#include "file.h"}).

El resultado de las manipulaciones se trata como un nombre de archivo y se retorna como el primer componente de la tupla, con @ref{1be,,open()} llamado en él para producir el segundo componente. (Nota: esto es lo contrario del orden de los argumentos en la inicialización de instancia!)

Este enlace se expone para que pueda usarlo para implementar rutas de búsqueda de directorios, adición de extensiones de archivo y otros trucos de espacios de nombres. No hay ningún enlace “close” correspondiente, pero una instancia de @code{shlex} llamará el método @ref{354,,close()} de la secuencia de entrada de origen cuando retorna EOF.

Para un control más explícito del apilamiento de código fuente, utilice los métodos @ref{3d54,,push_source()} y @ref{3d55,,pop_source()}.
@end deffn

@geindex push_source() (método de shlex.shlex)
@anchor{library/shlex shlex shlex push_source}@anchor{3d54}
@deffn {Método} shlex.push_source (newstream, newfile=None)

Inserta una secuencia de fuente de entrada en la pila de entrada.  Si se especifica el argumento de nombre de archivo, más adelante estará disponible para su uso en mensajes de error.  Este es el mismo método utilizado internamente por el método @ref{3d52,,sourcehook()}.
@end deffn

@geindex pop_source() (método de shlex.shlex)
@anchor{library/shlex shlex shlex pop_source}@anchor{3d55}
@deffn {Método} shlex.pop_source ()

Saca la última fuente de entrada de la pila de entrada. Este es el mismo método que el analizador léxico utiliza cuando llega al EOF en una secuencia de entrada apilada.
@end deffn

@geindex error_leader() (método de shlex.shlex)
@anchor{library/shlex shlex shlex error_leader}@anchor{3d56}
@deffn {Método} shlex.error_leader (infile=None, lineno=None)

Este método genera un mensaje de error líder en el formato de una etiqueta de error del compilador de Unix C; el formato es @code{'"%s", line %d: '}, donde el @code{%s} es reemplazado con el nombre del archivo fuente actual y el @code{%d} con el número de línea de entrada actual (los argumentos opcionales pueden ser usado para sobrescribir estos).

Esta conveniencia se proporciona para animar a los usuarios de @ref{c4,,shlex} a generar mensajes de error en el formato estándar y analizable que entienden Emacs y otras herramientas de Unix.
@end deffn

Las instancias de las subclases @ref{d54,,shlex} tienen algunas variables de instancia pública que controlan el análisis léxico o pueden ser usadas para la depuración:

@geindex commenters (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex commenters}@anchor{3d49}
@deffn {Atributo} shlex.commenters

La cadena de caracteres que son reconocidos como comentarios de principiantes. Todos los caracteres desde el comentario principiante hasta el final de la línea son ignorados. Incluye sólo @code{'#'} por defecto.
@end deffn

@geindex wordchars (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex wordchars}@anchor{3d4b}
@deffn {Atributo} shlex.wordchars

La cadena de caracteres que se acumulará en tokens de varios caracteres.  Por defecto, incluye todos los alfanuméricos ASCII y el subrayado.  En el modo POSIX, los caracteres acentuados del conjunto Latin-1 también están incluidos.  Si @ref{19da,,punctuation_chars} no está vacío, los caracteres @code{~-./*?=}, que pueden aparecer en las especificaciones del nombre de archivo y en los parámetros de la línea de comandos, también se incluirán en este atributo, y cualquier carácter que aparezca en @code{punctuation_chars} será eliminado de @code{wordchars} si están presentes allí. Si @ref{3d57,,whitespace_split} se establece en @code{True}, esto no tendrá ningún efecto.
@end deffn

@geindex whitespace (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex whitespace}@anchor{3d58}
@deffn {Atributo} shlex.whitespace

Caracteres que serán considerados como espacio en blanco y salteados.  El espacio blanco limita los tokens.  Por defecto, incluye espacio, tabulación, salto de línea y retorno de carro.
@end deffn

@geindex escape (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex escape}@anchor{3d59}
@deffn {Atributo} shlex.escape

Caracteres que serán considerados como de escape. Esto sólo se usará en el modo POSIX, e incluye sólo @code{'\'} por defecto.
@end deffn

@geindex quotes (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex quotes}@anchor{3d5a}
@deffn {Atributo} shlex.quotes

Los caracteres que serán considerados como citas de la cadena.  El token se acumula hasta que la misma cita se encuentra de nuevo (así, los diferentes tipos de citas se protegen entre sí como en el intérprete de comandos.) Por defecto, incluye ASCII comillas simples y dobles.
@end deffn

@geindex escapedquotes (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex escapedquotes}@anchor{3d5b}
@deffn {Atributo} shlex.escapedquotes

Caracteres en @ref{3d5a,,quotes} que interpretarán los caracteres de escape definidos en @ref{3d59,,escape}.  Esto sólo se usa en el modo POSIX, e incluye sólo @code{'"'} por defecto.
@end deffn

@geindex whitespace_split (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex whitespace_split}@anchor{3d57}
@deffn {Atributo} shlex.whitespace_split

Si es @code{True}, los tokens sólo se dividirán en espacios en blanco.  Esto es útil, por ejemplo, para analizar las líneas de comando con @ref{d54,,shlex}, obteniendo los tokens de forma similar a los argumentos de el intérprete de comandos.  Cuando se utiliza en combinación con @code{puntuation_chars}, los tokens se dividirán en espacios en blanco además de esos caracteres.


Distinto en la versión 3.8: El atributo @code{puntuation_chars} se hizo compatible con el atributo @ref{3d57,,whitespace_split}.

@end deffn

@geindex infile (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex infile}@anchor{3d4a}
@deffn {Atributo} shlex.infile

El nombre del archivo de entrada actual, como se estableció inicialmente al momento de la instanciación de la clase o apilado por solicitudes de fuente posteriores.  Puede ser útil examinar esto cuando se construyan mensajes de error.
@end deffn

@geindex instream (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex instream}@anchor{3d5c}
@deffn {Atributo} shlex.instream

El flujo de entrada del cual esta instancia @ref{d54,,shlex} está leyendo caracteres.
@end deffn

@geindex source (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex source}@anchor{3d53}
@deffn {Atributo} shlex.source

Este atributo es @code{None} por defecto.  Si le asignas una cadena, esa cadena será reconocida como una solicitud de inclusión a nivel léxico similar a la palabra clave @code{source} en varios intérpretes de comandos.  Es decir, el token inmediatamente siguiente se abrirá como un nombre de archivo y la entrada se tomará de ese flujo hasta EOF, en cuyo momento se llamará al método @ref{354,,close()} de ese flujo y la fuente de entrada se convertirá de nuevo en el flujo de entrada original.  Las peticiones de origen pueden ser apiladas a cualquier número de niveles de profundidad.
@end deffn

@geindex debug (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex debug}@anchor{3d5d}
@deffn {Atributo} shlex.debug

Si este atributo es numérico y @code{1} o más, una instancia @ref{d54,,shlex} imprimirá una salida de progreso verboso en su comportamiento.  Si necesitas usar esto, puedes leer el código fuente del módulo para conocer los detalles.
@end deffn

@geindex lineno (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex lineno}@anchor{3d5e}
@deffn {Atributo} shlex.lineno

Numero de linea de fuente (conteo de las nuevas lineas vistas hasta ahora mas uno).
@end deffn

@geindex token (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex token}@anchor{3d5f}
@deffn {Atributo} shlex.token

El buffer de tokens.  Puede ser útil examinarlo cuando se capturan excepciones.
@end deffn

@geindex eof (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex eof}@anchor{3d50}
@deffn {Atributo} shlex.eof

Token usado para determinar el final del archivo. Esto se ajustará a la cadena de caracteres vacía (@code{'@w{'}}), en el modo no-POSIX, y a @code{None} en el modo POSIX.
@end deffn

@geindex punctuation_chars (atributo de shlex.shlex)
@anchor{library/shlex shlex shlex punctuation_chars}@anchor{19da}
@deffn {Atributo} shlex.punctuation_chars

Una propiedad de sólo lectura. Caracteres que serán considerados como puntuación. Las series de caracteres de puntuación se retornarán como un único token. Sin embargo, tenga en cuenta que no se realizará ninguna comprobación de validez semántica: por ejemplo, “>>>” podría ser retornado como un token, aunque no sea reconocido como tal por los intérpretes de comandos.


Added in version 3.6.

@end deffn

@node Reglas de análisis,Compatibilidad mejorada con intérprete de comandos,objetos shlex,shlex — Simple lexical analysis
@anchor{library/shlex parsing-rules}@anchor{3d60}@anchor{library/shlex shlex-parsing-rules}@anchor{3d61}
@subsubsection Reglas de análisis


Cuando se opera en modo no-POSIX, @ref{d54,,shlex} intentará obedecer las siguientes reglas.


@itemize *

@item 
Los caracteres entre comillas no son reconocidos dentro de las palabras (@code{Do"Not"Separate} es analizado como la única palabra @code{Do"Not"Separate});

@item 
Los caracteres de escape no son reconocidos;

@item 
El encerrar los caracteres entre comillas preserva el valor literal de todos los caracteres dentro de las comillas;

@item 
Las comillas finales separan las palabras (@code{"Do"Separate} es analizado como @code{"Do"} y @code{Separate});

@item 
Si @code{whitepace_split} es @code{False}, cualquier carácter que no sea declarado como un carácter de palabra, espacio en blanco, o una cita será retornado como un token de un solo carácter. Si es @code{True}, @ref{d54,,shlex} sólo dividirá las palabras en espacios en blanco;

@item 
EOF es señalado con una cadena de caracteres vacía (@code{'@w{'}});

@item 
No es posible analizar cadenas de caracteres vacías, incluso si se citan.
@end itemize

Cuando se opera en el modo POSIX, @ref{d54,,shlex} intentará obedecer a las siguientes reglas de análisis.


@itemize *

@item 
Las comillas se eliminan y no separan las palabras (@code{"Do"Not"Separate"} se analiza como la sola palabra @code{DoNotSeparate});

@item 
Los caracteres de escape no citados (por ejemplo @code{'\'}) conservan el valor literal del siguiente carácter que continua;

@item 
Encerrar caracteres entre comillas que no forman parte de @ref{3d5b,,escapedquotes} (por ejemplo, @code{""}) conservan el valor literal de todos los caracteres dentro de las comillas;

@item 
Encerrar caracteres entre comillas que forman parte de @ref{3d5b,,escapedquotes} (por ejemplo, @code{""}) conserva el valor literal de todos los caracteres dentro de las comillas, con la excepción de los caracteres mencionados en @ref{3d59,,escape}.  Los caracteres de escape conservan su significado especial solo cuando van seguidos de la comilla en uso, o el propio carácter de escape. De lo contrario, el carácter de escape sera considerado un carácter normal.

@item 
EOF es señalado con un valor @ref{716,,None};

@item 
Se permiten cadenas de caracteres vacías entrecomilladas (@code{'@w{'}}).
@end itemize

@node Compatibilidad mejorada con intérprete de comandos,,Reglas de análisis,shlex — Simple lexical analysis
@anchor{library/shlex improved-compatibility-with-shells}@anchor{3d62}@anchor{library/shlex improved-shell-compatibility}@anchor{d55}
@subsubsection Compatibilidad mejorada con intérprete de comandos



Added in version 3.6.


La clase @ref{c4,,shlex} provee compatibilidad con el análisis realizado por los intérprete de comandos comunes de Unix como @code{bash}, @code{dash} y @code{sh}.  Para aprovechar esta compatibilidad, especifica el argumento @code{punctuation_chars} en el constructor.  Esto por defecto es @code{False}, el cual conserva el comportamiento pre-3.6. Sin embargo, si se establece como @code{True}, entonces se cambia el análisis de los caracteres @code{();<>|&}: cualquier ejecución de estos caracteres se retorna como un único token.  Mientras que esto se queda corto en un analizador completo para los intérprete de comandos (que estaría fuera del alcance de la biblioteca estándar, dada la multiplicidad de intérpretes de comandos que hay), te permite realizar el procesamiento de las líneas de comandos más fácilmente de lo que podrías hacerlo de otra manera.  Para ilustrarlo, puede ver la diferencia en el siguiente fragmento:

@example
>>> import shlex
>>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"
>>> s = shlex.shlex(text, posix=True)
>>> s.whitespace_split = True
>>> list(s)
['a', '&&', 'b;', 'c', '&&', 'd', '||', 'e;', 'f', '>abc;', '(def', 'ghi)']
>>> s = shlex.shlex(text, posix=True, punctuation_chars=True)
>>> s.whitespace_split = True
>>> list(s)
['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', 'abc', ';',
'(', 'def', 'ghi', ')']
@end example

Por supuesto, se retornarán tokens que no son válidos para los intérpretes de comandos y deberá implementar sus propias comprobaciones de errores en los tokens retornados.

En lugar de pasar @code{True} como valor para el parámetro punctuation_chars, puede pasar una cadena con caracteres específicos, que se usará para determinar qué caracteres constituyen puntuación. Por ejemplo:

@example
>>> import shlex
>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
>>> list(s)
['a', '&', '&', 'b', '||', 'c']
@end example

@cartouche
@quotation Nota 
Cuando es especificado @code{punctuation_chars}, el atributo @ref{3d4b,,wordchars} se aumenta con los caracteres @code{~-./*?=}.  Esto se debe a que estos caracteres pueden aparecer en los nombres de archivo (incluidos los comodines) y en los argumentos de la línea de comandos (por ejemplo, @code{--color=auto}). Por lo tanto:

@example
>>> import shlex
>>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',
...                 punctuation_chars=True)
>>> list(s)
['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']
@end example

Sin embargo, para que coincida con el intérprete de comandos lo más cerca posible, se recomienda utilizar siempre @code{posix} y @ref{3d57,,whitespace_split} cuando se utiliza @ref{19da,,punctuation_chars}, el cual negará por completo @ref{3d4b,,wordchars}.
@end quotation
@end cartouche

Para obtener el mejor efecto, @code{punctuation_chars} debe establecerse junto con @code{posix=True}. (Tenga en cuenta que @code{posix=False} es el valor predeterminado para @ref{d54,,shlex}.)

@node Interfaces gráficas de usuario con Tk,Herramientas de desarrollo,Frameworks de programa,La biblioteca estándar de Python
@anchor{library/tk doc}@anchor{3d63}@anchor{library/tk graphical-user-interfaces-with-tk}@anchor{3d64}@anchor{library/tk tkinter}@anchor{3d65}
@section Interfaces gráficas de usuario con Tk


@geindex GUI
@geindex Interfaz Gráfica de Usuario
@geindex Tkinter
@geindex Tk

Tk/Tcl has long been an integral part of Python.  It provides a robust and
platform independent windowing toolkit, that is available to Python programmers
using the @ref{f0,,tkinter} package, and its extension, the @ref{f9,,tkinter.ttk} module.

El paquete @ref{f0,,tkinter} es una fina capa orientada a objetos encima de Tcl/Tk. Para usar @ref{f0,,tkinter}, no necesita escribir código Tcl, pero deberá consultar la documentación de Tk y, ocasionalmente, la documentación de Tcl. @ref{f0,,tkinter} es un conjunto de envoltorios que implementan los widgets Tk como clases de Python.

Las principales virtudes de @ref{f0,,tkinter} son que es rápido y que generalmente viene incluido con Python. Aunque su documentación estándar es débil, se dispone de buen material, que incluye: referencias, tutoriales, un libro y otros. @ref{f0,,tkinter} también es famoso por tener un aspecto y una sensación obsoletos, que se ha mejorado enormemente en Tk 8.5. Sin embargo, hay muchas otras bibliotecas GUI en las que podría estar interesado. La wiki de Python enumera varias GUI frameworks and tools@footnote{https://wiki.python.org/moin/GuiProgramming} alternativas.

@menu
* tkinter — Python interface to Tcl/Tk:: 
* tkinter.colorchooser — Color choosing dialog: tkinter colorchooser — Color choosing dialog. 
* tkinter.font — Tkinter font wrapper: tkinter font — Tkinter font wrapper. 
* Diálogos tkinter:: 
* tkinter.messagebox — Tkinter message prompts: tkinter messagebox — Tkinter message prompts. 
* tkinter.scrolledtext — Scrolled Text Widget: tkinter scrolledtext — Scrolled Text Widget. 
* tkinter.dnd — Drag and drop support: tkinter dnd — Drag and drop support. 
* tkinter.ttk — Tk themed widgets: tkinter ttk — Tk themed widgets. 
* IDLE: IDLE<60>. 

@end menu

@node tkinter — Python interface to Tcl/Tk,tkinter colorchooser — Color choosing dialog,,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter doc}@anchor{3d66}@anchor{library/tkinter module-tkinter}@anchor{f0}@anchor{library/tkinter tkinter-python-interface-to-tcl-tk}@anchor{3d67}
@subsection @code{tkinter} — Python interface to Tcl/Tk


@geindex module; tkinter

`Código fuente:' Lib/tkinter/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/__init__.py}


__________________________________________________________________


El paquete @ref{f0,,tkinter} («interfaz Tk») es la interfaz por defecto de Python para el kit de herramientas de GUI Tk. Tanto Tk como @ref{f0,,tkinter} están disponibles en la mayoría de las plataformas Unix, así como en sistemas Windows (Tk en sí no es parte de Python, es mantenido por ActiveState).

Ejecutar @code{python -m tkinter} desde la línea de comandos debería abrir una ventana que demuestre una interfaz Tk simple para saber si @ref{f0,,tkinter} está instalado correctamente en su sistema. También muestra qué versión de Tcl/Tk está instalada para que pueda leer la documentación de Tcl/Tk específica de esa versión.

Tkinter soporta un amplio rango de versiones TCL/TK, construidos con o sin soporte de hilo. La versión oficial del binario de python incluye Tcl/Tk 8.6 con subprocesos. Vea el código fuente para el módulo @ref{3,,_tkinter}  para mayor información acerca de las versiones soportadas.

Tkinter no es un subproceso liviano pero agrega una buena cantidad de su propia lógica para hacer la experiencia mas pythónico. Esta documentación se concentrará en estas adiciones y cambios, refiriéndose sobre la documentación oficial de Tcl-Tk para los detalles que no han sido cambiados.

@cartouche
@quotation Nota 
Tcl/Tk 8.5 (2007) introdujo un moderno conjunto de componentes temáticos de interfaz de usuario en conjunto con una nueva API para ser usada. Ambas API tanto la antigua como la nueva están disponibles. La mayor parte de la documentación que podrá encontrar en línea aún usa la antigua versión de la API y por lo tanto podría estar desactualizada.
@end quotation
@end cartouche


@subsubheading Ver también



@itemize *

@item 

@table @asis

@item TkDocs@footnote{https://tkdocs.com/}

Es un extenso tutorial sobre como crear interfaces de usuario con Tkinter. Explica conceptos clave y muestra enfoques recomendados para usar la API moderna.
@end table

@item 

@table @asis

@item Tkinter 8.5 reference: a GUI for Python@footnote{https://www.tkdocs.com/shipman/}

Documentación de referencia sobre Tkinter 8.5 donde se detallan clases disponibles, métodos y opciones.
@end table
@end itemize

Recursos de Tcl/Tk:


@itemize *

@item 

@table @asis

@item Comandos Tk@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm}

Referencia exhaustiva para cada uno de los comandos subyacentes utilizados por Tkinter.
@end table

@item 

@table @asis

@item Tcl/Tk Home Page@footnote{https://www.tcl.tk}

Documentación adicional y enlaces al núcleo de desarrollo de Tcl/Tk.
@end table
@end itemize

Libros:


@itemize *

@item 

@table @asis

@item Modern Tkinter for Busy Python Developers@footnote{https://www.amazon.com/Modern-Tkinter-Python-Developers-ebook/dp/B0071QDNLO/}

Escrito por Mark Roseman (ISBN 978-1999149567)
@end table

@item 

@table @asis

@item Python GUI programming with Tkinter@footnote{https://www.packtpub.com/en-us/product/python-gui-programming-with-tkinter-9781788835886}

By Alan D. Moore. (ISBN 978-1788835886)
@end table

@item 

@table @asis

@item Programming Python@footnote{https://learning-python.com/about-pp4e.html}

Escrito por Mark Lutz, que cubre los tópicos de Tkinter de forma excelente. (ISBN 978-0596158101)
@end table

@item 

@table @asis

@item Tcl and the Tk Toolkit@footnote{https://www.amazon.com/exec/obidos/ASIN/020163337X}

Escrito por John Ousterhout, creador de Tcl/Tk y Kevin Jones, el cual no cubre Tkinter. (ISBN 978-0321336330)
@end table
@end itemize


@menu
* Arquitectura:: 
* Módulos Tkinter:: 
* Guía de supervivencia de Tkinter:: 
* Modelo de subprocesamiento:: 
* Guía práctica:: 
* Gestor de archivos:: 

@end menu

@node Arquitectura,Módulos Tkinter,,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter architecture}@anchor{3d68}
@subsubsection Arquitectura


Tcl/Tk no es una biblioteca única mas bien consiste en unos pocos módulos distintivos entre si. cada uno separados por funcionalidades y que poseen su documentación oficial. Las versiones del binario de Python también incluyen un módulo adicional con esto.


@table @asis

@item Tcl

Tcl es un lenguaje de programación interpretado y dinámico, tal como Python. Aunque puede ser usado en si mismo como un lenguaje de programación de uso general, lo más común es que se utilice en aplicaciones del lenguaje C como un motor de secuencias de comandos o como una interfaz hacia el kit de herramientas de Tk. La librería TCL contiene una interfaz con C que crea y gestiona una o más instancias del intérprete de TCL, corre los comandos en TCL en esas instancias y agrega comandos personalizados tanto en Tcl o C. Cada intérprete tiene su cola de eventos y entrega facilidades para enviar procesos a la cola y procesarlos. A diferencia de Python, el modelo de ejecución en Tcl es diseñado alrededor de cooperar en múltiples asignaciones y Tkinter ayuda a salvar estas diferencias (ver @ref{3d69,,Threading model} para más detalles).

@item Tk

Tk es un paquete de Tcl@footnote{https://wiki.tcl-lang.org/37432} implementado en C que agrega comandos personalizados que permiten manipular widget en la GUI. Cada objeto de la clase @ref{1642,,Tk} agrega su instancia de interprete Tcl con Tk cargado en el. Los widget de Tk son muy personalizables, aunque a costa de una apariencia anticuada. Tk usa eventos de la cola de Tcl para generar y procesar eventos de la GUI.

@item Ttk

El nuevo tema Tk (Ttk) es una nueva familia de widgets de Tk que proveen una mejor apariencia en diferentes plataformas mas que varios de los widgets clásicos de Tk. Ttk es distribuido como parte de Tk estando disponible a partir de la versión 8.5. Enlaces para Python son entregados en un módulo aparte, @ref{f9,,tkinter.ttk}.
@end table

Internamente, Tk y Ttk usan funcionalidades del sistema operativo subyacente, en otras palabras, Xlib en Unix/X11, Cocoa en macOS o GDI en Windows.

Cuando su aplicación de Python una una clase en Tkinter, p.ej, para crear un widget, el módulo @ref{f0,,tkinter} ensambla una cadena de comando Tcl/Tk. Entonces se pasa esa cadena de comando Tcl a un módulo binario interno @ref{3,,_tkinter}, que luego llama al intérprete Tcl para evaluarlo. El intérprete de Tcl llamará a los paquetes Tk y o Ttk, que a su vez realizarán llamadas a Xlib, Cocoa o GDI.

@node Módulos Tkinter,Guía de supervivencia de Tkinter,Arquitectura,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter tkinter-modules}@anchor{3d6a}
@subsubsection Módulos Tkinter


El soporte para Tkinter se distribuye para varios módulos. la mayor parte de las aplicaciones necesitaran el módulo base @ref{f0,,tkinter}, así como también el módulo @ref{f9,,tkinter.ttk}, el cual entrega el conjunto de widget temáticos y la API correspondiente:

@example
from tkinter import *
from tkinter import ttk
@end example

@geindex Tk (clase en tkinter)
@anchor{library/tkinter tkinter Tk}@anchor{1642}
@deffn {Clase} tkinter.Tk (screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)

Esto crea un widget de nivel superior de Tk que generalmente es la ventana principal de una aplicación. Cada instancia tiene su propio intérprete Tcl asociado.

La clase @ref{1642,,Tk} normalmente se instancia utilizando los valores predeterminados. No obstante, se reconocen los siguientes argumentos de palabra clave:


@table @asis

@item `screenName'

Cuando se proporciona (como cadena de caracteres), establece la variable de entorno 
@geindex DISPLAY
@geindex variables de entorno; DISPLAY
@code{DISPLAY}. (solo X11)

@item `baseName'

Nombre del archivo de perfil. De forma predeterminada, `baseName' se deriva del nombre del programa (@code{sys.argv[0]}).

@item `className'

Nombre de la clase del widget. Se utiliza como archivo de perfil y como nombre con el que se invoca a Tcl (`argv0' en `interp').

@item `useTk'

Si es `True', inicializa el subsistema Tk. La función @ref{3d6b,,tkinter.Tcl()} se establece en `False'.

@item `sync'

Si es @code{True}, ejecuta todos los comandos del servidor X de forma síncrona, por lo tanto, los errores se notifican inmediatamente. Se puede utilizar en el proceso de depuración. (solo X11)

@item `use'

Especifica el `id' de la ventana en la que se incrustar la aplicación, en lugar de crearla como una ventana independiente de nivel superior. El `id' debe especificarse de la misma manera que el valor para la opción -use de los widgets de nivel superior (es decir, emplea el formato de retorno de @code{winfo_id()}).

Hay que tener en cuenta que en algunas plataformas, esto solo funcionará correctamente si el `id' se refiere a un marco Tk o a un nivel superior que tenga habilitada la opción -container.
@end table

@ref{1642,,Tk} lee e interpreta los archivos de perfil, nombrados @code{.`className'.tcl} y @code{. `baseName'.tcl}, en  el intérprete Tcl y llama a @ref{2ea,,exec()} sobre el contenido de @code{.`className'.py} y @code{.`baseName'.py}. La ruta de los archivos de perfil se encuentra en la variable de entorno 
@geindex HOME
@geindex variables de entorno; HOME
@code{HOME} o, si no está definida, en @ref{27cd,,os.curdir}.

@geindex tk (atributo de tkinter.Tk)
@anchor{library/tkinter tkinter Tk tk}@anchor{3d6c}
@deffn {Atributo} tk

El objeto de la aplicación Tk creado al instanciar @ref{1642,,Tk}. Esto proporciona acceso al intérprete de Tcl. Todos los widget que se adjuntan a la misma instancia de @ref{1642,,Tk} tienen el mismo valor para el atributo @ref{3d6c,,tk}.
@end deffn

@geindex master (atributo de tkinter.Tk)
@anchor{library/tkinter tkinter Tk master}@anchor{3d6d}
@deffn {Atributo} master

El objeto widget que contiene este widget. Para @ref{1642,,Tk}, `master' es @ref{716,,None}, ya que es la ventana principal. Los términos `master' y `parent' son similares, y a veces se usan indistintamente como nombres de argumento; Sin embargo, al llamar a @code{winfo_parent()} este retorna una cadena con del nombre del widget, mientras que @ref{3d6d,,master} retorna el objeto. `parent'/`child' refleja la relación en forma de árbol, mientras que `master'/`slave', refleja la estructura del contenedor.
@end deffn

@geindex children (atributo de tkinter.Tk)
@anchor{library/tkinter tkinter Tk children}@anchor{3d6e}
@deffn {Atributo} children

Los descendientes directos de este widget como @ref{190,,dict} con los nombres del widget secundario como clave y los objetos de instancia secundarios como valor.
@end deffn
@end deffn

@geindex Tcl() (en el módulo tkinter)
@anchor{library/tkinter tkinter Tcl}@anchor{3d6b}
@deffn {Función} tkinter.Tcl (screenName=None, baseName=None, className='Tk', useTk=False)

La función @ref{3d6b,,Tcl()} es una función de fábrica que crea un objeto muy similar al creado por la clase @ref{1642,,Tk}, excepto que no inicializa el subsistema Tk. Esto suele ser útil cuando se maneja el intérprete de Tcl en un entorno en el que no se desean crear ventanas de nivel superior extrañas o donde no se puede (como los sistemas Unix/Linux sin un servidor X). Un objeto creado por el objeto @ref{3d6b,,Tcl()} puede tener una ventana `Toplevel' creada (y el subsistema Tk inicializado) llamando a su método @code{loadtk()}.
@end deffn

Otros módulos que proporcionan soporte a Tk incluyen:


@table @asis

@item @ref{f0,,tkinter}

Módulos de Tkinter.

@item @ref{f1,,tkinter.colorchooser}

Cuadro de diálogo que permite al usuario elegir un color.

@item @ref{f2,,tkinter.commondialog}

Clase base para cuadros de diálogo definidos en los otros módulos listados aquí.

@item @ref{f4,,tkinter.filedialog}

Cuadros de diálogo por defecto que permiten al usuario especificar un archivo para abrir o guardar.

@item @ref{f5,,tkinter.font}

Utilidades para ayudar a trabajar con fuentes.

@item @ref{f6,,tkinter.messagebox}

Acceso a cuadros de diálogo estándar de Tk.

@item @ref{f7,,tkinter.scrolledtext}

Widget de texto con una barra de desplazamiento vertical integrada.

@item @ref{f8,,tkinter.simpledialog}

Cuadros de diálogo simples y funciones útiles.

@item @ref{f9,,tkinter.ttk}

Un set de widgets temáticos fueron añadidos en Tk 8.5, entregando alternativas modernas para muchos de los widgets clásicos en el módulo principal de @ref{f0,,tkinter}.
@end table

Módulos adicionales:

@geindex module; _tkinter
@anchor{library/tkinter module-_tkinter}@anchor{3}

@table @asis

@item @ref{3,,_tkinter}

Un módulo binario que contiene una interfaz de bajo nivel con Tcl/Tk. . Esto es automáticamente importado al módulo principal @ref{f0,,tkinter} y nunca debe ser usado directamente por los p programadores de aplicaciones. Esto es usualmente una librería compartida (or DLL), pero podría en ciertos casos ser añadidos de forma estática por el interprete de Python.

@item @ref{73,,idlelib}

Entorno de aprendizaje y desarrollo integrado de Python (IDLE). Basado en @ref{f0,,tkinter}.

@item @code{tkinter.constants}

Constantes simbólicas que pueden ser utilizadas en en lugar de cadenas de texto cuando se pasan varios parámetros a las llamadas de Tkinter. Automáticamente son importadas por el módulo principal @ref{f0,,tkinter}.

@item @ref{f3,,tkinter.dnd}

De forma experimental está el soporte de arrastrar y soltar (`drag-and-drop') para @ref{f0,,tkinter}. Esto no se mantendrá cuando sea reemplazado por Tk DND.

@item @ref{101,,turtle}

Gráficos de tortuga en una ventana Tk.
@end table

@node Guía de supervivencia de Tkinter,Modelo de subprocesamiento,Módulos Tkinter,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter tkinter-life-preserver}@anchor{3d6f}
@subsubsection Guía de supervivencia de Tkinter


Esta sección no fue pensada en ser un tutorial exhaustivo sobre cada tópico de Tk o Tkinter. Para esto, puede consultar en alguno de los recursos externos que fueron presentados anteriormente. En vez de eso, esta apartado entrega una orientación breve sobre como es ve una aplicación en Tkinter, identifica conceptos claves de Tk y explica como el empaquetador de Tkinter está estructurado.

Es resto de esta sección lo ayudará a identificar las clases, métodos y opciones que necesitará en una aplicación de Tkinter y donde se puede encontrar documentación más detallada sobre esto, incluida en la guía de referencia oficial de Tcl/Tk.

@menu
* Un programa simple de Hola Mundo:: 
* Conceptos importantes de Tk:: 
* Entendiendo como funcionan los empaquetadores de Tcl/Tk:: 
* ¿Cómo lo hago?@comma{} ¿Cómo funciona?: ¿Cómo lo hago? ¿Cómo funciona?. 
* Navegando en el manual de referencia de Tcl/Tk:: 

@end menu

@node Un programa simple de Hola Mundo,Conceptos importantes de Tk,,Guía de supervivencia de Tkinter
@anchor{library/tkinter a-hello-world-program}@anchor{3d70}
@subsubsection Un programa simple de Hola Mundo


Comenzaremos a explorar Tkinter a través de una simple aplicación «Hola Mundo». Esta no es la aplicación mas pequeña que podríamos escribir, pero es suficiente para ilustrar algunos conceptos claves que necesitará saber.

@example
from tkinter import *
from tkinter import ttk
root = Tk()
frm = ttk.Frame(root, padding=10)
frm.grid()
ttk.Label(frm, text="Hello World!").grid(column=0, row=0)
ttk.Button(frm, text="Quit", command=root.destroy).grid(column=1, row=0)
root.mainloop()
@end example

Después de las declaraciones de import, la línea siguiente será la de crear la instancia de la clase @code{Tk} la cual iniciativa Tk y crea el interprete asociado a Tcl. Esto también crea una ventana de nivel superior, conocida como la ventana raíz la cual sirve como la ventana principal de la aplicación.

En la siguiente línea se crea el marco del widget, el cual en este caso contendrá la etiqueta y el botón que crearemos después. El marco encaja dentro de la ventana raíz.

La próxima línea crea una etiqueta para el widget que contiene una cadena de texto estática. El método @code{grid()} es usado para especificar la posición del diseño de la etiqueta que está dentro del marco del widget, similar a como trabajan las tablas en HTML.

Es entonces cuando el botón del widget es creado y dejado a la derecha de la etiqueta. Una vez pulsado llamará al método @code{destroy()} de la ventana raíz.

Finalmente el método @code{mainloop()} muestra todo en pantalla y responde a la entrada del usuario hasta que el programa termina.

@node Conceptos importantes de Tk,Entendiendo como funcionan los empaquetadores de Tcl/Tk,Un programa simple de Hola Mundo,Guía de supervivencia de Tkinter
@anchor{library/tkinter important-tk-concepts}@anchor{3d71}
@subsubsection Conceptos importantes de Tk


Incluso con este sencillo programa se pueden mostrar conceptos claves de Tk:


@table @asis

@item widgets

Una interfaz de usuario de Tkinter está compuesta de varios `widgets' individuales. Cada widget es representado como un objeto de Python, instanciado desde clases tales como @code{ttk.Frame}, @code{ttk.Label} y @code{ttk.Button}.

@item jerarquía de los widgets

Los widgets se organizan en `jerarquías'. La etiqueta y el botón estaban dentro del marco el que a su vez estaba contenido dentro del marco raíz. Cuando se crea cada `child' del widget su `parent' es pasado como el primer argumento del constructor del widget.

@item opciones de configuración

Los widgets tienen `opciones de configuración' los cuales modifican su apariencia y comportamiento, como el texto que se despliega en la etiqueta o el botón. Diferentes clases de widgets tendrán diferentes conjuntos de opciones.

@item gestión del diseño de formularios

Los widgets no son añadidos automáticamente a la interfaz de usuario una vez que han sido creados. Un `administrador de geometrías' como @code{grid} controla donde la interfaz de usuario es colocada.

@item ejecución del evento

Tkinter reacciona a la entrada del usuario, realiza los cambios del programa e incluso actualiza lo que se muestra en pantalla solo cuando se ejecuta activamente un `event loop'. Si el programa no esta ejecutando el evento, su interfaz de usuario no se actualizará.
@end table

@node Entendiendo como funcionan los empaquetadores de Tcl/Tk,¿Cómo lo hago? ¿Cómo funciona?,Conceptos importantes de Tk,Guía de supervivencia de Tkinter
@anchor{library/tkinter understanding-how-tkinter-wraps-tcl-tk}@anchor{3d72}
@subsubsection Entendiendo como funcionan los empaquetadores de Tcl/Tk


Cuando su aplicación utiliza las clases y métodos de Tkinter, internamente Tkinter está ensamblando cadenas que representan comandos Tcl/Tk, y ejecutando esos comandos en el intérprete Tcl adjunto a la instancia @code{Tk} de su aplicación.

Tanto si se está intentando navegar en la documentación de referencia o intentando encontrar el método u opción correcta o adaptando algún código ya existente o depurando su aplicación en Tkinter, hay veces que es útil entender como son esos comandos subyacentes de Tcl/Tk.

Para ilustrar, aquí se tiene un equivalente en Tcl/Tk de la parte principal del script Tkinter anterior.

@example
ttk::frame .frm -padding 10
grid .frm
grid [ttk::label .frm.lbl -text "Hello World!"] -column 0 -row 0
grid [ttk::button .frm.btn -text "Quit" -command "destroy ."] -column 1 -row 0
@end example

La sintaxis es similar a varios lenguajes de línea de comandos, donde la primera palabra es el comando que debe ser ejecutado con los argumentos que le siguen al comando, separados por espacios, Sin entrar en demasiados detalles, note lo siguiente:


@itemize *

@item 
Los comandos usados para crear widgets (tales como @code{ttk::frame}) corresponden a las clases de widgets en Tkinter.

@item 
Opciones de widget en Tcl (por ejemplo @code{-text}) corresponden a argumentos clave en Tkinter.

@item 
Los widgets son reverenciados con un `pathname' in Tcl (por ejemplo @code{.frm.btn}) mientras que Tkinter no usa nombres sino que referencia a objetos.

@item 
El lugar del widget en la jerarquía es codificada (jerárquicamente) en nombre de archivo, usando un @code{.} (punto) como separador de búsqueda. El nombre de ruta del archivo para la ventana raíz es un @code{.} (punto), la jerarquía no es definida por la ruta del archivo pero si por la especificación del widget padre cuando se crea cada widget hijo.

@item 
Las operaciones que se implementan como `commands' separados en Tcl (por ejemplo @code{grid} or @code{destroy}) son representados como  `methods' en objetos de widget de Tkinter. Como se verá en breve, en otras ocasiones, Tcl usa lo que parecen ser llamadas a métodos en objetos de widget, que reflejan más de cerca lo que se usa en Tkinter.
@end itemize

@node ¿Cómo lo hago? ¿Cómo funciona?,Navegando en el manual de referencia de Tcl/Tk,Entendiendo como funcionan los empaquetadores de Tcl/Tk,Guía de supervivencia de Tkinter
@anchor{library/tkinter how-do-i-what-option-does}@anchor{3d73}
@subsubsection ¿Cómo lo hago?, ¿Cómo funciona?


Si no esta seguro sobre como realizar ciertas acciones en Tkinter y no se puede encontrar información de forma rápida en el tutorial o en la documentación de referencias que estas usando, aquí hay varias estrategias que pueden ser de mucha ayuda.

Primero, recordar que los detalles sobre como cada widget trabaja en las diferentes versiones de Tcl/Tk pueden variar según la versión. Si está buscando información, asegúrese de que corresponde a la versión tanto de Python como de Tcl/Tk instaladas en su sistema.

Cuando se busca sobre como usar una API, puede ser muy útil el saber exactamente el nombre de la clase, opción o método que está utilizando. Tener esto en cuenta de antemano, ya sea en un shell de Python interactivo o con @ref{ff4,,print()}, puede ayudar a identificar lo que necesitas.

Para encontrar que opciones de configuración están disponibles en cada widget, se utiliza la llamada al método @code{configure()}, el cual retorna un diccionario que contiene una gran variedad de información sobre cada objeto, incluyendo valores por defecto y actuales. Utilice el @code{keys()} para saber los nombres de cada opción.

@example
btn = ttk.Button(frm, ...)
print(btn.configure().keys())
@end example

La mayoría de los widgets tienen varias opciones de configuraciones en común, puede ser útil averiguar cuales son específicos de una clase de widget en particular. Comparando la lista de opciones de un widget sencillo como por ejemplo un frame es una de las formas de hacerlo.

@example
print(set(btn.configure().keys()) - set(frm.configure().keys()))
@end example

De manera similar se pueden encontrar los métodos disponibles para un objeto de un widget utilizando la función standard @ref{6d3,,dir()}. Si lo intentas podrás ver alrededor de 200 métodos comunes para los widgets por lo que de nuevo, es muy importante identificar las especificaciones de un widget.

@example
print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))
@end example

@node Navegando en el manual de referencia de Tcl/Tk,,¿Cómo lo hago? ¿Cómo funciona?,Guía de supervivencia de Tkinter
@anchor{library/tkinter navigating-the-tcl-tk-reference-manual}@anchor{3d74}
@subsubsection Navegando en el manual de referencia de Tcl/Tk


Como se ha señalado, el manual oficial de referencia de Tk commands@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm} (en las páginas del manual) es a menudo la descripción mas precisa sobre que hacen las operaciones especificas de los widgets. Incluso sabiendo el nombre de la opción o método que necesitas, es posible que puedas encontrar información adicional.

Mientras todas las operaciones en Tkinter son implementadas como llamadas de método sobre objetos del widget, se puede ver cuantas operaciones de Tcl/Tk aparecen como comandos que toman el nombre de ruta del widget como el primer parámetro, seguido de parámetros opcionales, por ejemplo.

@example
destroy .
grid .frm.btn -column 0 -row 0
@end example

Otros, sin embargo, se parecen más a métodos llamados en un objeto del widget (de hecho, cuando se crea un widget en Tcl / Tk, este a su vez crea un comando Tcl con el nombre de la ruta del widget, siendo el primer parámetro de ese comando el nombre de un método para llamar).

@example
.frm.btn invoke
.frm.lbl configure -text "Goodbye"
@end example

En la documentación oficial de referencia para Tcl/Tk, se podrán encontrar mas operaciones que son similares a las llamadas a métodos de la pagina principal de un widget en especifico ( p.ej., se podrá encontrar el método @code{invoke()} en la página principal de ttk::button@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_button.htm} ) mientras que las funciones que toman un widget como un parámetro a menudo tienen su propia página principal (p.ej., grid@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/grid.htm}).

Se podrán encontrar varias opciones en común y metidos en las páginas del manual options@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/options.htm} o ttk::widget@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_widget.htm}, mientras que otras opciones se encuentran en las páginas del manual de una clase de widget específica.

También se puede encontrar cuantos métodos de Tkinter poseen nombres compuestos, p.ej, @code{winfo_x()}, @code{winfo_height()}, @code{winfo_viewable()}. Usted también encuentra información para todo esto en las páginas del manual en winfo <@indicateurl{https://www.tcl.tk/man/tcl8.6/TkCmd/winfo.htm}>`_.

@cartouche
@quotation Nota 
Puede ser algo confuso, pero también hay métodos en todos los widgets de Tkinter los cuales no operan directamente en el widget pero operan a nivel global, independiente del widget. Ejemplos de esto son los métodos para acceder al portapapeles o a llamados del sistema. (Ellos aparecen al ser implementados como métodos en la clase base @code{Widget} clase que todos los widgets en Tkinter heredan).
@end quotation
@end cartouche

@node Modelo de subprocesamiento,Guía práctica,Guía de supervivencia de Tkinter,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter threading-model}@anchor{3d69}
@subsubsection Modelo de subprocesamiento


Python y Tcl/Tk tienen modelos de subprocesamiento muy diferentes, con lo cual el módulo @ref{f0,,tkinter} intenta ser un puente entre ambos. Si usted usa hilos, es muy posible que deba ser consciente de esto.

Un interprete de Python puede tener varios hilos asociados. En Tcl, diferentes hilos pueden ser creados, pero cada hilo tiene una instancia del interprete de Tcl asociada por separado. Los hilos también pueden crear mas de una instancia del interprete, aunque cada instancia del intérprete puede ser usada solo por el hilo que ha sido creado.

Cada objeto de la clase @code{Tk} creado por @ref{f0,,tkinter} contiene un interprete para TCL. Esto también mantiene un seguimiento de cada hilo creado por el interprete. Las llamadas al módulo @ref{f0,,tkinter} se pueden realizar desde cualquier módulo de Python. De forma interna si una llamada proviene desde un hilo diferente al creado por objeto @code{Tk}, un evento es publicado por la cola de eventos del interprete y cuando es ejecutado, el resultado es retornado al hilo de llamadas de Python.

Las aplicaciones de Tcl/Tk son normalmente basados en eventos, lo que significa que después de la inicialización, el interprete corre un bucle de eventos (p.ej. @code{Tk.mainloop()}) que responde a los eventos. Al ser un evento de un solo proceso, los controladores responden rápidamente, en caso contrario ellos bloquearán el procesamiento de otros eventos. Para evitar esto, cualquier procesamiento de larga duración no deben ser procesados en el controlador de eventos, o en caso contrario ser separados en pequeñas piezas usando temporizadores o correr el proceso en otro hilo. Esto es diferente a muchos kits de herramientas de GUI donde GUI se ejecuta en un hilo completamente separado del código de la aplicación, incluido el controlador de eventos.

Si el intérprete de Tcl no se está ejecutando el bucle del evento o procesando eventos, cualquier llamada a @ref{f0,,tkinter} realizada desde hilos distintos al que ejecuta el intérprete de Tcl, fallará.

Existen varios casos especiales:


@itemize *

@item 
Las librerías de Tcl/Tk pueden ser construidas para que no sean conscientes de los subprocesos. En este caso, el @ref{f0,,tkinter} llama a la librería a partir del hilo originado desde Python, incluso si este es diferente al hilo creado en el intérprete de Tcl. Un cierre global asegura que solo ocurra una llamada a la vez.

@item 
Mientras el @ref{f0,,tkinter} permite crear una o mas instancias del objeto de @code{Tk} (con su propio intérprete), todos los interpretes son parte del mismo hilo compartido en la cola de eventos, lo cual se torna complicado rápidamente. En la practica, no se debe crear mas de una instancia de la clase @code{Tk} a la vez. De lo contrario, es lo mejor crearlos en hilos separados y asegurarse de que se esta ejecutando un hilo compatible con los subprocesos.

@item 
Bloquear los controladores de eventos no son la única manera de prevenir que el intérprete de Tcl reingrese al bucle de eventos. Es incluso posible ejecutar una cantidad de bucles de eventos anidados o abandonar el bucle de forma completa, Si está realizando alguna tarea complicada cuando se trata de eventos o hilos hay que tener en cuenta estas posibilidades.

@item 
Hay algunas funciones select @ref{f0,,tkinter} que ahora solo funcionan cuando se les llama desde el hilo que creó el intérprete Tcl.
@end itemize

@node Guía práctica,Gestor de archivos,Modelo de subprocesamiento,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter handy-reference}@anchor{3d75}
@subsubsection Guía práctica


@menu
* Configuración de opciones:: 
* El empaquetador:: 
* Opciones del empaquetador:: 
* Asociación de variables de widget:: 
* El gestor de ventanas:: 
* Tipos de datos de opciones Tk:: 
* Enlaces y eventos:: 
* El parámetro índice:: 
* Imágenes:: 

@end menu

@node Configuración de opciones,El empaquetador,,Guía práctica
@anchor{library/tkinter setting-options}@anchor{3d76}@anchor{library/tkinter tkinter-setting-options}@anchor{3d77}
@subsubsection Configuración de opciones


Las opciones controlan parámetros como el color y el ancho del borde de un widget. Las opciones se pueden configurar de tres maneras:


@table @asis

@item En el momento de la creación del objeto, utilizando argumentos de palabras clave

@example
fred = Button(self, fg="red", bg="blue")
@end example

@item Después de la creación del objeto, tratando el nombre de la opción como un índice de diccionario

@example
fred["fg"] = "red"
fred["bg"] = "blue"
@end example

@item Usando el método `config()' para actualizar múltiples atributos después de la creación del objeto

@example
fred.config(fg="red", bg="blue")
@end example
@end table

Para obtener una explicación completa de las opciones y su comportamiento, consulte las páginas de manual de Tk para el widget en cuestión.

Tenga en cuenta que las páginas del manual enumeran «OPCIONES ESTÁNDAR» y «OPCIONES ESPECÍFICAS DE WIDGET» para cada widget. La primera es una lista de opciones que son comunes a muchos widgets, la segunda son las opciones que son específicas para ese widget en particular. Las opciones estándar están documentadas en la página del manual @code{options(3)@footnote{https://manpages.debian.org/options(3)}}.

No se hace distinción entre las opciones estándar y las opciones específicas del widget en este documento. Algunas opciones no se aplican a algunos tipos de widgets. Si un determinado widget responde a una opción particular depende de la clase del widget. Los botones tienen la opción @code{command}, las etiquetas no.

Las opciones admitidas por un widget dado se enumeran en la página de manual de ese widget, o se pueden consultar en tiempo de ejecución llamando al método @code{config()} sin argumentos, o llamando al método @code{keys()} en ese widget. El valor retornado en esas llamadas es un diccionario cuya clave es el nombre de la opción como una cadena (por ejemplo, @code{'relief'}) y cuyo valor es una tupla de 5 elementos.

Algunas opciones, como @code{bg}, son sinónimos de opciones comunes con nombres largos (@code{bg} es la abreviatura de `«background»'). Al pasar el método @code{config()}, el nombre de una opción abreviada retornará una tupla de 2 elementos (en lugar de 5). Esta tupla contiene nombres de sinónimos y nombres de opciones «reales» (como @code{('bg', 'background')}).


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@tab

Ejemplo

@item

0

@tab

nombre de la opción

@tab

@code{'relief'}

@item

1

@tab

nombre de la opción para la búsqueda en la base de datos

@tab

@code{'relief'}

@item

2

@tab

clase de la opción para la consulta de base de datos

@tab

@code{'Relief'}

@item

3

@tab

valor por defecto

@tab

@code{'raised'}

@item

4

@tab

valor actual

@tab

@code{'groove'}

@end multitable


Ejemplo:

@example
>>> print(fred.config())
@{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')@}
@end example

Por supuesto, el diccionario impreso incluirá todas las opciones disponibles y sus valores. Esto es solo un ejemplo.

@node El empaquetador,Opciones del empaquetador,Configuración de opciones,Guía práctica
@anchor{library/tkinter the-packer}@anchor{3d78}
@subsubsection El empaquetador


@geindex empaquetado (widgets)

El empaquetador es uno de los mecanismos de gestión de geometría de Tk. Los administradores de geometría se utilizan para especificar la posición relativa de los widgets dentro de su contenedor: su `master' mutuo. En contraste con el `placer' más engorroso (que se usa con menos frecuencia, y no cubrimos aquí), el empaquetador toma la especificación de relación cualitativa - `above', `to the left of', `filling', etc - y funciona todo para determinar las coordenadas de ubicación exactas para usted.

El tamaño de cualquier widget maestro está determinado por el tamaño del widget esclavo interno. El empaquetador se usa para controlar dónde se colocará el widget esclavo en el widget maestro de destino. Para lograr el diseño deseado, puede empaquetar el widget en un marco y luego empaquetar ese marco en otro. Además, una vez empaquetado, la disposición se ajusta dinámicamente de acuerdo con los cambios de configuración posteriores.

Tenga en cuenta que los widgets no aparecen hasta que su geometría no se haya especificado con un administrador de diseño de pantalla. Es un error común de principiante ignorar la especificación de la geometría, y luego sorprenderse cuando se crea el widget pero no aparece nada. Un objeto gráfico solo aparece después que, por ejemplo, se le haya aplicado el método @code{pack()} del empaquetador.

Se puede llamar al método `pack()' con pares palabra-clave/valor que controlan dónde debe aparecer el widget dentro de su contenedor y cómo se comportará cuando se cambie el tamaño de la ventana principal de la aplicación. Aquí hay unos ejemplos:

@example
fred.pack()                     # defaults to side = "top"
fred.pack(side="left")
fred.pack(expand=1)
@end example

@node Opciones del empaquetador,Asociación de variables de widget,El empaquetador,Guía práctica
@anchor{library/tkinter packer-options}@anchor{3d79}
@subsubsection Opciones del empaquetador


Para obtener más información sobre el empaquetador y las opciones que puede tomar, consulte el manual y la página 183 del libro de John Ousterhout.


@table @asis

@item `anchor'

Tipo de anclaje. Indica dónde debe colocar el empaquetador a cada esclavo en su espacio.

@item `expand'

Un valor booleano, @code{0} o @code{1}.

@item `fill'

Los valores legales son: @code{'x'}, @code{'y'}, @code{'both'}, @code{'none'}.

@item `ipadx' y `ipady'

Una distancia que designa el relleno interno a cada lado del widget esclavo.

@item `padx' y `pady'

Una distancia que designa el relleno externo a cada lado del widget esclavo.

@item `side'

Los valores legales son: @code{'left'}, @code{'right'}, @code{'top'}, @code{'bottom'}.
@end table

@node Asociación de variables de widget,El gestor de ventanas,Opciones del empaquetador,Guía práctica
@anchor{library/tkinter coupling-widget-variables}@anchor{3d7a}
@subsubsection Asociación de variables de widget


La asignación de un valor a ciertos objetos gráficos (como los widgets de entrada de texto) se puede vincular directamente a variables en su aplicación utilizando opciones especiales. Estas opciones son @code{variable}, @code{textvariable}, @code{onvalue}, @code{offvalue}, y @code{value}. Esta conexión funciona en ambos sentidos: si la variable cambia por algún motivo, el widget al que está conectado se actualizará para reflejar el nuevo valor.

Desafortunadamente, en la implementación actual de @ref{f0,,tkinter} no es posible entregar una variable arbitraria de Python a un widget a través de una opción @code{variable} o @code{textvariable} . Los únicos tipos de variables para las cuales esto funciona son variables que son subclases de la clase Variable, definida en @ref{f0,,tkinter}.

Hay muchas subclases útiles de Variable ya definidas: @code{StringVar}, @code{IntVar}, @code{DoubleVar}, and @code{BooleanVar}. Para leer el valor actual de dicha variable, es necesario llamar al método @code{get()}, y para cambiar su valor, al método @code{set()}. Si se sigue este protocolo, el widget siempre rastreará el valor de la variable, sin ser necesaria ninguna otra intervención.

Por ejemplo:

@example
import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # Create the application variable.
        self.contents = tk.StringVar()
        # Set it to some value.
        self.contents.set("this is a variable")
        # Tell the entry widget to watch this variable.
        self.entrythingy["textvariable"] = self.contents

        # Define a callback for when the user hits return.
        # It prints the current value of the variable.
        self.entrythingy.bind('<Key-Return>',
                             self.print_contents)

    def print_contents(self, event):
        print("Hi. The current entry content is:",
              self.contents.get())

root = tk.Tk()
myapp = App(root)
myapp.mainloop()
@end example

@node El gestor de ventanas,Tipos de datos de opciones Tk,Asociación de variables de widget,Guía práctica
@anchor{library/tkinter the-window-manager}@anchor{3d7b}
@subsubsection El gestor de ventanas


@geindex gestor de ventanas (widgets)

En Tk hay un comando útil, @code{wm}, para interactuar con el gestor de ventanas. Las opciones del comando @code{wm} le permiten controlar cosas como títulos, ubicación, iconos de ventana y similares. En @ref{f0,,tkinter}, estos comandos se han implementado como métodos de la clase @code{Wm}. Los widgets de alto nivel son subclases de @code{Wm}, por lo que se puede llamar directamente a los métodos de @code{Wm}.

Para acceder a la ventana `Toplevel' que contiene un objeto gráfico dado, a menudo puede simplemente referirse al padre de este objeto gráfico. Por supuesto, si el objeto gráfico fue empaquetado dentro de un marco, el padre no representará la ventana de nivel superior. Para acceder a la ventana de nivel superior que contiene un objeto gráfico arbitrario, puede llamar al método @code{_root()} . Este método comienza con un subrayado para indicar que esta función es parte de la implementación y no de una interfaz a la funcionalidad Tk.

Aquí hay algunos ejemplos típicos:

@example
import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# create the application
myapp = App()

#
# here are method calls to the window manager class
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# start the program
myapp.mainloop()
@end example

@node Tipos de datos de opciones Tk,Enlaces y eventos,El gestor de ventanas,Guía práctica
@anchor{library/tkinter tk-option-data-types}@anchor{3d7c}
@subsubsection Tipos de datos de opciones Tk


@geindex Tipos de datos de opciones Tk


@table @asis

@item `anchor'

Los valores legales son los puntos de la brújula: @code{"n"}, @code{"ne"}, @code{"e"}, @code{"se"}, @code{"s"}, @code{"sw"}, @code{"w"}, @code{"nw"}, y también @code{"center"}.

@item `bitmap'

Hay ocho nombres de `bitmaps' integrados: @code{'error'}, @code{'gray25'}, @code{'gray50'}, @code{'hourglass'}, @code{'info'}, @code{'questhead'}, @code{'question'}, @code{'warning'}. Para especificar un nombre de archivo de mapa de bits de X, indique la ruta completa del archivo, precedida por una @code{@@}, como en @code{"@@/usr/contrib/bitmap/gumby.bit"}.

@item `boolean'

Se puede pasar enteros 0 o 1 o las cadenas @code{"yes"} or @code{"no"}.

@item `callback'

Esto es cualquier función de Python que no toma argumentos. Por ejemplo:

@example
def print_it():
    print("hi there")
fred["command"] = print_it
@end example

@item `color'

Los colores se pueden dar como nombres de colores de X en el archivo @code{rgb.txt}, o como cadenas que representan valores RGB. La cadena que representa el valor RGB toma un rango de 4 bits:@code{"#RGB"}, 8 bits: @code{"#RRGGBB"}, 12 bits» @code{"#RRRGGGBBB"}, o 16 bits @code{"#RRRRGGGGBBBB"} donde R, G, B representan cualquier dígito hexadecimal legal. Consulte la página 160 del libro de Ousterhout para más detalles.

@item `cursor'

Los nombres estándar del cursor X de @code{cursorfont.h} se pueden usar sin el prefijo @code{XC_}. Por ejemplo, para obtener un cursor de mano (@code{XC_hand2}), use la cadena @code{"hand2"}. También se puede especificar su propio mapa de bits y archivo de máscara. Ver página 179 del libro de Ousterhout.

@item `distance'

Las distancias de pantalla se pueden especificar tanto en píxeles como en distancias absolutas. Los píxeles se dan como números y las distancias absolutas como cadenas con el carácter final que indica unidades: @code{c} para centímetros, @code{i} para pulgadas, @code{m} para milímetros, @code{p} para puntos de impresora. Por ejemplo, 3.5 pulgadas se expresa como @code{"3.5i"}.

@item `font'

Tk usa un formato de lista para los nombres de fuentes, como @code{@{courier 10 bold@}}. Los tamaños de fuente expresados en números positivos se miden en puntos, mientras que los tamaños con números negativos se miden en píxeles.

@item geometry

Es una cadena de caracteres del estilo @code{widthxheight}, donde el ancho y la altura se miden en píxeles para la mayoría de los widgets (en caracteres para widgets que muestran texto). Por ejemplo: @code{fred["geometry"] = "200x100"}.

@item justify

Los valores legales son las cadenas de caracteres: @code{"left"}, @code{"center"}, @code{"right"}, y @code{"fill"}.

@item region

Es una cadena de caracteres con cuatro elementos delimitados por espacios, cada uno de ellos es una distancia legal (ver arriba). Por ejemplo: @code{"2 3 4 5"} , @code{"3i 2i 4.5i 2i"} y @code{"3c 2c 4c 10.43c"} son todas regiones legales.

@item relief

Determina cuál será el estilo de borde de un widget. Los valores legales son: @code{"raised"}, @code{"sunken"}, @code{"flat"}, @code{"groove"}, y @code{"ridge"}.

@item scrollcommand

Este es casi siempre el método @code{set()} de algún widget de barra de desplazamiento, pero puede ser cualquier método de un widget que tome un solo argumento.

@item wrap

Debe ser uno de estos: @code{"none"}, @code{"char"}, o @code{"word"}.
@end table

@node Enlaces y eventos,El parámetro índice,Tipos de datos de opciones Tk,Guía práctica
@anchor{library/tkinter bindings-and-events}@anchor{3d7d}@anchor{library/tkinter id2}@anchor{3d7e}
@subsubsection Enlaces y eventos


@geindex vincular (widgets)
@geindex eventos (widgets)

El método de enlace (`binding') del comando del widget le permite observar ciertos eventos y hacer que la función de devolución de llamada se active cuando se produce ese tipo de evento. La forma del método de enlace es:

@example
def bind(self, sequence, func, add='@w{'}):
@end example

donde:


@table @asis

@item sequence

es una cadena que denota el tipo de evento objetivo. Para obtener más información, consulte la página del manual de Bind y la página 201 del libro de John Ousterhout.

@item func

es una función de Python que toma un argumento y se llama cuando ocurre el evento. La instancia del evento se pasa como el argumento mencionado. (Las funciones implementadas de esta manera a menudo se llaman `callbacks'.)

@item add

es opcional, ya sea @code{'@w{'}} o @code{'+'}. Pasar una cadena de caracteres vacía indica que este enlace anulará cualquier otro enlace asociado con este evento. Pasar @code{'+'} agrega esta función a la lista de funciones vinculadas a este tipo de evento.
@end table

Por ejemplo:

@example
def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)
@end example

Observe cómo se accede al campo del widget del evento en la devolución de llamada @code{turn_red()}. Este campo contiene el widget que capturó el evento de X. La siguiente tabla enumera los otros campos de eventos a los que puede acceder y cómo se indican en Tk, lo que puede ser útil cuando se hace referencia a las páginas del manual de Tk.


@multitable {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tk

@tab

Campo evento de Tkinter

@tab

Tk

@tab

Campo evento de Tkinter

@item

%f

@tab

focus

@tab

%A

@tab

char

@item

%h

@tab

height

@tab

%E

@tab

send_event

@item

%k

@tab

keycode

@tab

%K

@tab

keysym

@item

%s

@tab

state

@tab

%N

@tab

keysym_num

@item

%t

@tab

time

@tab

%T

@tab

type

@item

%w

@tab

width

@tab

%W

@tab

widget

@item

%x

@tab

x

@tab

%X

@tab

x_root

@item

%y

@tab

y

@tab

%Y

@tab

y_root

@end multitable


@node El parámetro índice,Imágenes,Enlaces y eventos,Guía práctica
@anchor{library/tkinter the-index-parameter}@anchor{3d7f}
@subsubsection El parámetro índice


Muchos widgets requieren que se pase un parámetro  de tipo índice. Esto se utiliza para señalar ubicaciones específicas en el widget de texto, caracteres específicos en el widget de entrada, o elementos particulares en el widget de menú.


@table @asis

@item Índice de widget de entrada (índice, índice de vista, etc.)

El widget entrada tiene una opción para referirse a la posición de los caracteres del texto que se muestra. Puede acceder a estos puntos especiales en un widget de texto utilizando la siguiente función de @ref{f0,,tkinter}:

@item Índice de widget de texto

La notación de índice del widget de texto es muy rica y se detalla mejor en las páginas del manual de Tk.

@item Índices de menú (`menu.invoke()', `menu.entryconfig()', etc.)

Algunas opciones y métodos para menús manipulan entradas de menú específicas. Cada vez que se necesita un índice de menú para una opción o un parámetro, se puede pasar:


@itemize *

@item 
un número entero que se refiere a la posición numérica de la entrada en el widget, contada desde arriba, comenzando con 0;

@item 
la cadena @code{"active"}, que se refiere a la posición del menú que está actualmente debajo del cursor;

@item 
la cadena de caracteres @code{"last"} que se refiere al último elemento del menú;

@item 
Un número entero precedido por @code{@@}, como en @code{@@6}, donde el entero es interpretado como una coordenada `y' de píxeles en el sistema de coordenadas del menú;

@item 
la cadena de caracteres @code{"none"}, que indica que no hay entrada de menú, usado frecuentemente con `menu.activate()' para desactivar todas las entradas; y, finalmente,

@item 
una cadena de texto cuyo patrón coincide con la etiqueta de la entrada del menú, tal como se explora desde la parte superior del menú hasta la parte inferior. Tenga en cuenta que este tipo de índice se considera después de todos los demás, lo que significa que las coincidencias para los elementos del menú etiquetados @code{last}, @code{active}, o @code{none} pueden interpretarse de hecho como los literales anteriores.
@end itemize
@end table

@node Imágenes,,El parámetro índice,Guía práctica
@anchor{library/tkinter images}@anchor{3d80}
@subsubsection Imágenes


Se pueden crear imágenes de diferentes formatos a través de la correspondiente subclase de @code{tkinter.Image}:


@itemize *

@item 
@code{BitmapImage} para imágenes en formato XBM.

@item 
@code{PhotoImage} para imágenes en formatos PGM, PPM, GIF y PNG. Este último es compatible a partir de Tk 8.6.
@end itemize

Cualquier tipo de imagen se crea a través de la opción @code{file} o @code{data} (también hay otras opciones disponibles).


Distinto en la versión 3.13: Added the @code{PhotoImage} method @code{copy_replace()} to copy a region
from one image to other image, possibly with pixel zooming and/or
subsampling.
Add `from_coords' parameter to @code{PhotoImage} methods @code{copy()},
@code{zoom()} and @code{subsample()}.
Add `zoom' and `subsample' parameters to @code{PhotoImage} method
@code{copy()}.


El objeto imagen se puede usar siempre que algún widget admita una opción de @code{image} (por ejemplo, etiquetas, botones, menús). En estos casos, Tk no mantendrá una referencia a la imagen. Cuando se elimina la última referencia de Python al objeto de imagen, los datos de la imagen también se eliminan, y Tk mostrará un cuadro vacío donde se utilizó la imagen.


@subsubheading Ver también


El paquete Pillow@footnote{https://python-pillow.org/} añade soporte para los formatos del tipo BMP, JPEG, TIFF, y WebP, entre otros.


@node Gestor de archivos,,Guía práctica,tkinter — Python interface to Tcl/Tk
@anchor{library/tkinter file-handlers}@anchor{3d81}@anchor{library/tkinter tkinter-file-handlers}@anchor{3d82}
@subsubsection Gestor de archivos


Tk permite registrar y anular el registro de una función de devolución de llamada que se llamará desde el mainloop de Tk cuando la E/S sea posible en un descriptor de archivo. Solo se puede registrar un controlador por descriptor de archivo. Código de ejemplo:

@example
import tkinter
widget = tkinter.Tk()
mask = tkinter.READABLE | tkinter.WRITABLE
widget.tk.createfilehandler(file, mask, callback)
...
widget.tk.deletefilehandler(file)
@end example

Esta función no está disponible en Windows.

Dado que no se sabe cuántos bytes están disponibles para su lectura, no use métodos de @ref{735,,BufferedIOBase} o @ref{736,,TextIOBase} @ref{1390,,read()} o @ref{1391,,readline()}, ya que estos requieren leer un número predefinido de bytes. Para `sockets', los métodos @ref{e2a,,recv()} o @ref{e2b,,recvfrom()} trabajan bien; para otros archivos, use lectura sin formato o @code{os.read(file.fileno(), maxbytecount)}.

@geindex createfilehandler() (método de _tkinter.Widget.tk)
@anchor{library/tkinter tkinter Widget tk createfilehandler}@anchor{3d83}
@deffn {Método} Widget.tk.createfilehandler (file, mask, func)

Registra la función `callback' gestor de archivos `func'. El argumento `file' puede ser un objeto con un método @code{fileno()} (como un archivo u objeto de socket), o un descriptor de archivo entero. El argumento `mask' es una combinación ORed de cualquiera de las tres constantes que siguen. La retrollamada se llama de la siguiente manera:

@example
callback(file, mask)
@end example
@end deffn

@geindex deletefilehandler() (método de _tkinter.Widget.tk)
@anchor{library/tkinter tkinter Widget tk deletefilehandler}@anchor{3d84}
@deffn {Método} Widget.tk.deletefilehandler (file)

Anula el registro de un gestor de archivos.
@end deffn

@geindex READABLE (en el módulo _tkinter)
@geindex WRITABLE (en el módulo _tkinter)
@geindex EXCEPTION (en el módulo _tkinter)
@anchor{library/tkinter tkinter READABLE}@anchor{3d85}
@deffn {Dato} _tkinter.READABLE
@anchor{library/tkinter tkinter WRITABLE}@anchor{3d86}
@deffnx {Dato} _tkinter.WRITABLE
@anchor{library/tkinter tkinter EXCEPTION}@anchor{3d87}
@deffnx {Dato} _tkinter.EXCEPTION

Constantes utilizadas en los argumentos `mask'.
@end deffn

@node tkinter colorchooser — Color choosing dialog,tkinter font — Tkinter font wrapper,tkinter — Python interface to Tcl/Tk,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter colorchooser doc}@anchor{3d88}@anchor{library/tkinter colorchooser module-tkinter colorchooser}@anchor{f1}@anchor{library/tkinter colorchooser tkinter-colorchooser-color-choosing-dialog}@anchor{3d89}
@subsection @code{tkinter.colorchooser} — Color choosing dialog


@geindex module; tkinter.colorchooser

`Código fuente:' Lib/tkinter/colorchooser.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/colorchooser.py}


__________________________________________________________________


El módulo @ref{f1,,tkinter.colorchooser} proporciona la clase @ref{3d8a,,Chooser} como una interfaz para el diálogo del selector de color nativo. @code{Chooser} implementa una ventana de diálogo de elección de color modal. La clase @code{Chooser} hereda de la clase @ref{3d8b,,Dialog}.

@geindex Chooser (clase en tkinter.colorchooser)
@anchor{library/tkinter colorchooser tkinter colorchooser Chooser}@anchor{3d8a}
@deffn {Clase} tkinter.colorchooser.Chooser (master=None, **options)
@end deffn

@geindex askcolor() (en el módulo tkinter.colorchooser)
@anchor{library/tkinter colorchooser tkinter colorchooser askcolor}@anchor{3d8c}
@deffn {Función} tkinter.colorchooser.askcolor (color=None, **options)

Cree un cuadro de diálogo de elección de color. Una llamada a este método mostrará la ventana, esperará a que el usuario haga una selección y devolverá el color seleccionado (o @code{None}) a la persona que llama.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{f2,,tkinter.commondialog}

Módulo de diálogo estándar de Tkinter
@end table


@node tkinter font — Tkinter font wrapper,Diálogos tkinter,tkinter colorchooser — Color choosing dialog,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter font doc}@anchor{3d8d}@anchor{library/tkinter font module-tkinter font}@anchor{f5}@anchor{library/tkinter font tkinter-font-tkinter-font-wrapper}@anchor{3d8e}
@subsection @code{tkinter.font} — Tkinter font wrapper


@geindex module; tkinter.font

`Código fuente:' Lib/tkinter/font.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/font.py}


__________________________________________________________________


El módulo @ref{f5,,tkinter.font} proporciona la clase @ref{1913,,Font} para crear y usar fuentes con nombre.

Los diferentes pesos e inclinaciones de la fuente son:

@geindex NORMAL (en el módulo tkinter.font)
@geindex BOLD (en el módulo tkinter.font)
@geindex ITALIC (en el módulo tkinter.font)
@geindex ROMAN (en el módulo tkinter.font)
@anchor{library/tkinter font tkinter font NORMAL}@anchor{3d8f}
@deffn {Dato} tkinter.font.NORMAL
@anchor{library/tkinter font tkinter font BOLD}@anchor{3d90}
@deffnx {Dato} tkinter.font.BOLD
@anchor{library/tkinter font tkinter font ITALIC}@anchor{3d91}
@deffnx {Dato} tkinter.font.ITALIC
@anchor{library/tkinter font tkinter font ROMAN}@anchor{3d92}
@deffnx {Dato} tkinter.font.ROMAN
@end deffn

@geindex Font (clase en tkinter.font)
@anchor{library/tkinter font tkinter font Font}@anchor{1913}
@deffn {Clase} tkinter.font.Font (root=None, font=None, name=None, exists=False, **options)

La clase @ref{1913,,Font} representa una fuente con nombre. Las instancias `Font' reciben nombres únicos y se pueden especificar por su configuración de familia, tamaño y estilo. Las fuentes con nombre son el método de Tk para crear e identificar fuentes como un solo objeto, en lugar de especificar una fuente por sus atributos con cada aparición.

@quotation

argumentos:

@quotation


@display
`font' - tupla de especificador de fuente (familia, tamaño, opciones)@w{ }
`name' - nombre de fuente único@w{ }
`exists' - self apunta a la fuente con nombre existente si es verdadera@w{ }
@end display


@end quotation

opciones de palabras clave adicionales (ignoradas si se especifica `font'):

@quotation


@display
`family' - familia de la fuente, es decir, Courier, Times@w{ }
`size' - tamaño de fuente@w{ }
@display
Si `size' es positivo, se interpreta como tamaño en puntos.@w{ }
Si `size' es un número negativo, se trata su valor absoluto@w{ }
como tamaño en píxeles.@w{ }
@end display
`weight' - énfasis de fuente (NORMAL, BOLD)@w{ }
`slant' - ROMAN, ITALIC@w{ }
`underline' - subrayado de fuente (0 - ninguno, 1 - subrayado)@w{ }
`overstrike' - tachado de fuente (0 - ninguno, 1 - tachado)@w{ }
@end display


@end quotation
@end quotation

@geindex actual() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font actual}@anchor{3d93}
@deffn {Método} actual (option=None, displayof=None)

Retorna los atributos de la fuente.
@end deffn

@geindex cget() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font cget}@anchor{3d94}
@deffn {Método} cget (option)

Recupera un atributo de la fuente.
@end deffn

@geindex config() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font config}@anchor{3d95}
@deffn {Método} config (**options)

Modifica los atributos de la fuente.
@end deffn

@geindex copy() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font copy}@anchor{3d96}
@deffn {Método} copy ()

Retorna una nueva instancia de la fuente actual.
@end deffn

@geindex measure() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font measure}@anchor{3d97}
@deffn {Método} measure (text, displayof=None)

Retorna la cantidad de espacio que ocuparía el texto en la pantalla especificada cuando se formatee en la fuente actual. Si no se especifica ninguna pantalla, se asume la ventana principal de la aplicación.
@end deffn

@geindex metrics() (método de tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font metrics}@anchor{3d98}
@deffn {Método} metrics (*options, **kw)

Retorna datos específicos de la fuente. Las opciones incluyen:


@table @asis

@item `ascent' - distancia entre la línea de base y el punto más alto que un

el carácter de la fuente puede ocupar

@item `descent' - distancia entre la línea de base y el punto más bajo que un

el carácter de la fuente puede ocupar

@item `linespace' - separación vertical mínima necesaria entre dos

caracteres de la fuente que aseguran que no haya superposición vertical entre líneas.
@end table

`fixed' - 1 si la fuente es de ancho fijo en caso contrario 0
@end deffn
@end deffn

@geindex families() (en el módulo tkinter.font)
@anchor{library/tkinter font tkinter font families}@anchor{3d99}
@deffn {Función} tkinter.font.families (root=None, displayof=None)

Retorna las diferentes familias de fuentes.
@end deffn

@geindex names() (en el módulo tkinter.font)
@anchor{library/tkinter font tkinter font names}@anchor{3d9a}
@deffn {Función} tkinter.font.names (root=None)

Retorna los nombres de las fuentes definidas.
@end deffn

@geindex nametofont() (en el módulo tkinter.font)
@anchor{library/tkinter font tkinter font nametofont}@anchor{1915}
@deffn {Función} tkinter.font.nametofont (name, root=None)

Retorna una representación @ref{1913,,Font} de una fuente con nombre tk.


Distinto en la versión 3.10: Se agregó el parámetro `root'.

@end deffn

@node Diálogos tkinter,tkinter messagebox — Tkinter message prompts,tkinter font — Tkinter font wrapper,Interfaces gráficas de usuario con Tk
@anchor{library/dialog doc}@anchor{3d9b}@anchor{library/dialog tkinter-dialogs}@anchor{3d9c}
@subsection Diálogos tkinter


@menu
* tkinter.simpledialog —Diálogos de entrada estándar de Tkinter: tkinter simpledialog —Diálogos de entrada estándar de Tkinter. 
* Diálogos de selección de archivos:: 
* tkinter.commondialog — Plantillas de ventanas de diálogo: tkinter commondialog — Plantillas de ventanas de diálogo. 

@end menu

@node tkinter simpledialog —Diálogos de entrada estándar de Tkinter,Diálogos de selección de archivos,,Diálogos tkinter
@anchor{library/dialog module-tkinter simpledialog}@anchor{f8}@anchor{library/dialog tkinter-simpledialog-standard-tkinter-input-dialogs}@anchor{3d9d}
@subsubsection @code{tkinter.simpledialog} —Diálogos de entrada estándar de Tkinter


@geindex module; tkinter.simpledialog

`Código fuente:' Lib/tkinter/simpledialog.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/simpledialog.py}


__________________________________________________________________


El módulo @ref{f8,,tkinter.simpledialog} contiene clases y funciones convenientes para crear diálogos modales simples para obtener un valor de entrada del usuario.

@geindex askfloat() (en el módulo tkinter.simpledialog)
@geindex askinteger() (en el módulo tkinter.simpledialog)
@geindex askstring() (en el módulo tkinter.simpledialog)
@anchor{library/dialog tkinter simpledialog askfloat}@anchor{3d9e}
@deffn {Función} tkinter.simpledialog.askfloat (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askinteger}@anchor{1916}
@deffnx {Función} tkinter.simpledialog.askinteger (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askstring}@anchor{3d9f}
@deffnx {Función} tkinter.simpledialog.askstring (title, prompt, **kw)

Las tres funciones anteriores proporcionan diálogos que piden al usuario que introduzca un valor del tipo deseado.
@end deffn

@geindex Dialog (clase en tkinter.simpledialog)
@anchor{library/dialog tkinter simpledialog Dialog}@anchor{3da0}
@deffn {Clase} tkinter.simpledialog.Dialog (parent, title=None)

La clase base para los diálogos personalizados.

@geindex body() (método de tkinter.simpledialog.Dialog)
@anchor{library/dialog tkinter simpledialog Dialog body}@anchor{3da1}
@deffn {Método} body (master)

Sobrescribir para construir la interfaz del dialogo y retornar el widget que debe tener el foco inicial.
@end deffn

@geindex buttonbox() (método de tkinter.simpledialog.Dialog)
@anchor{library/dialog tkinter simpledialog Dialog buttonbox}@anchor{3da2}
@deffn {Método} buttonbox ()

El comportamiento por defecto añade los botones OK y Cancelar. Sobrescribir para diseños de botones personalizados.
@end deffn
@end deffn

@node Diálogos de selección de archivos,tkinter commondialog — Plantillas de ventanas de diálogo,tkinter simpledialog —Diálogos de entrada estándar de Tkinter,Diálogos tkinter
@anchor{library/dialog module-tkinter filedialog}@anchor{f4}@anchor{library/dialog tkinter-filedialog-file-selection-dialogs}@anchor{3da3}
@subsubsection Diálogos de selección de archivos


@geindex module; tkinter.filedialog

`Código fuente:' Lib/tkinter/filedialog.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/filedialog.py}


__________________________________________________________________


El módulo @ref{f4,,tkinter.filedialog} proporciona clases y funciones de factoría para crear ventanas de selección de archivos/directorios.

@menu
* Diálogos nativos de carga/guardado:: 

@end menu

@node Diálogos nativos de carga/guardado,,,Diálogos de selección de archivos
@anchor{library/dialog native-load-save-dialogs}@anchor{3da4}
@subsubsection Diálogos nativos de carga/guardado


Las siguientes clases y funciones proporcionan ventanas de diálogo de archivos que combinan un aspecto nativo con opciones de configuración para personalizar el comportamiento. Los siguientes argumentos son aplicables a las clases y funciones enumeradas a continuación:

@quotation


@display
`parent' - la ventana sobre la que se situará el diálogo@w{ }
@end display




@display
`title' - el título de la ventana@w{ }
@end display




@display
`initialdir' - el directorio en el que inicia el diálogo@w{ }
@end display




@display
`initialfile' - el archivo seleccionado al abrir el diálogo@w{ }
@end display




@display
`filetypes' - una secuencia de tuplas (label, pattern), se permite el comodín “*”@w{ }
@end display




@display
`defaultextension' - extensión por defecto para añadir al archivo (diálogos de guardado)@w{ }
@end display




@display
`multiple' - cuando es verdadero, se permite la selección de múltiples elementos@w{ }
@end display


@end quotation

`Funciones estáticas de factoría'

Las siguientes funciones, al ser invocadas, crean un diálogo modal de aspecto nativo, esperan la selección del usuario y retornan el(los) valor(es) seleccionado(s) o @code{Ninguno} a la llamada.

@geindex askopenfile() (en el módulo tkinter.filedialog)
@geindex askopenfiles() (en el módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askopenfile}@anchor{3da5}
@deffn {Función} tkinter.filedialog.askopenfile (mode='r', **options)
@anchor{library/dialog tkinter filedialog askopenfiles}@anchor{3da6}
@deffnx {Función} tkinter.filedialog.askopenfiles (mode='r', **options)

Las dos funciones anteriores crean un diálogo @ref{3da7,,Open} y retornan el( los) objeto(s) de archivo(s) abierto(s) en modo de sólo lectura.
@end deffn

@geindex asksaveasfile() (en el módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog asksaveasfile}@anchor{3da8}
@deffn {Función} tkinter.filedialog.asksaveasfile (mode='w', **options)

Crea un diálogo @ref{3da9,,SaveAs} y retorna un objeto de un archivo abierto en modo de sólo escritura.
@end deffn

@geindex askopenfilename() (en el módulo tkinter.filedialog)
@geindex askopenfilenames() (en el módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askopenfilename}@anchor{3daa}
@deffn {Función} tkinter.filedialog.askopenfilename (**options)
@anchor{library/dialog tkinter filedialog askopenfilenames}@anchor{3dab}
@deffnx {Función} tkinter.filedialog.askopenfilenames (**options)

Las dos funciones anteriores crean un diálogo @ref{3da7,,Open} y retornan el( los) nombre(s) de archivo(s) seleccionado(s) que corresponde(n) a un(os) archivo(s) existente(s).
@end deffn

@geindex asksaveasfilename() (en el módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog asksaveasfilename}@anchor{3dac}
@deffn {Función} tkinter.filedialog.asksaveasfilename (**options)

Crea un diálogo @ref{3da9,,SaveAs} y retorna el nombre del archivo seleccionado.
@end deffn

@geindex askdirectory() (en el módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askdirectory}@anchor{3dad}
@deffn {Función} tkinter.filedialog.askdirectory (**options)


@display
Pide al usuario que seleccione un directorio.@w{ }
Argumento opcional adicional:@w{ }
@display
`mustexist' - determina si la selección debe ser un directorio existente.@w{ }
@end display
@end display


@end deffn

@geindex Open (clase en tkinter.filedialog)
@geindex SaveAs (clase en tkinter.filedialog)
@anchor{library/dialog tkinter filedialog Open}@anchor{3da7}
@deffn {Clase} tkinter.filedialog.Open (master=None, **options)
@anchor{library/dialog tkinter filedialog SaveAs}@anchor{3da9}
@deffnx {Clase} tkinter.filedialog.SaveAs (master=None, **options)

Las dos clases anteriores proporcionan ventanas de diálogo nativas para guardar y cargar archivos.
@end deffn

`Clases de conveniencia'

Las siguientes clases se utilizan para crear ventanas de archivos/directorios desde cero. Estas no emulan el aspecto nativo de la plataforma.

@geindex Directory (clase en tkinter.filedialog)
@anchor{library/dialog tkinter filedialog Directory}@anchor{3dae}
@deffn {Clase} tkinter.filedialog.Directory (master=None, **options)

Crear un diálogo que solicite al usuario que seleccione un directorio.
@end deffn

@cartouche
@quotation Nota 
La clase `FileDialog' debe ser subclasificada para el manejo de eventos y comportamiento personalizados.
@end quotation
@end cartouche

@geindex FileDialog (clase en tkinter.filedialog)
@anchor{library/dialog tkinter filedialog FileDialog}@anchor{3daf}
@deffn {Clase} tkinter.filedialog.FileDialog (master, title=None)

Crear un diálogo básico de selección de archivos.

@geindex cancel_command() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog cancel_command}@anchor{3db0}
@deffn {Método} cancel_command (event=None)

Activa la terminación de la ventana de diálogo.
@end deffn

@geindex dirs_double_event() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog dirs_double_event}@anchor{3db1}
@deffn {Método} dirs_double_event (event)

Manejador de eventos para el evento de doble clic sobre un directorio.
@end deffn

@geindex dirs_select_event() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog dirs_select_event}@anchor{3db2}
@deffn {Método} dirs_select_event (event)

Manejador de eventos para el evento de clic sobre un directorio.
@end deffn

@geindex files_double_event() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog files_double_event}@anchor{3db3}
@deffn {Método} files_double_event (event)

Manejador de eventos para el evento de doble clic sobre un archivo.
@end deffn

@geindex files_select_event() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog files_select_event}@anchor{3db4}
@deffn {Método} files_select_event (event)

Manejador de eventos para el evento de un solo clic sobre un archivo.
@end deffn

@geindex filter_command() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog filter_command}@anchor{3db5}
@deffn {Método} filter_command (event=None)

Filtra los archivos por directorio.
@end deffn

@geindex get_filter() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog get_filter}@anchor{3db6}
@deffn {Método} get_filter ()

Recupera el filtro de archivos que se está utilizando actualmente.
@end deffn

@geindex get_selection() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog get_selection}@anchor{3db7}
@deffn {Método} get_selection ()

Recupera el elemento seleccionado actualmente.
@end deffn

@geindex go() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog go}@anchor{3db8}
@deffn {Método} go (dir_or_file=os.curdir, pattern='*', default='@w{'}, key=None)

Renderiza el diálogo e inicia el bucle de eventos.
@end deffn

@geindex ok_event() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog ok_event}@anchor{3db9}
@deffn {Método} ok_event (event)

Salir del diálogo retornando la selección actual.
@end deffn

@geindex quit() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog quit}@anchor{3dba}
@deffn {Método} quit (how=None)

Salir del diálogo retornando el nombre del archivo, si lo hay.
@end deffn

@geindex set_filter() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog set_filter}@anchor{3dbb}
@deffn {Método} set_filter (dir, pat)

Establece el filtro de archivos.
@end deffn

@geindex set_selection() (método de tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog set_selection}@anchor{3dbc}
@deffn {Método} set_selection (file)

Actualiza la selección de archivos actual a `archivo'.
@end deffn
@end deffn

@geindex LoadFileDialog (clase en tkinter.filedialog)
@anchor{library/dialog tkinter filedialog LoadFileDialog}@anchor{3dbd}
@deffn {Clase} tkinter.filedialog.LoadFileDialog (master, title=None)

Una subclase de FileDialog que crea una ventana de diálogo para seleccionar un archivo existente.

@geindex ok_command() (método de tkinter.filedialog.LoadFileDialog)
@anchor{library/dialog tkinter filedialog LoadFileDialog ok_command}@anchor{3dbe}
@deffn {Método} ok_command ()

Comprueba que se proporciona un archivo y que la selección indica un archivo ya existente.
@end deffn
@end deffn

@geindex SaveFileDialog (clase en tkinter.filedialog)
@anchor{library/dialog tkinter filedialog SaveFileDialog}@anchor{3dbf}
@deffn {Clase} tkinter.filedialog.SaveFileDialog (master, title=None)

Una subclase de FileDialog que crea una ventana de diálogo para seleccionar un archivo de destino.

@geindex ok_command() (método de tkinter.filedialog.SaveFileDialog)
@anchor{library/dialog tkinter filedialog SaveFileDialog ok_command}@anchor{3dc0}
@deffn {Método} ok_command ()

Comprueba si la selección apunta a un archivo válido que no es un directorio. Se requiere confirmación si se selecciona un archivo ya existente.
@end deffn
@end deffn

@node tkinter commondialog — Plantillas de ventanas de diálogo,,Diálogos de selección de archivos,Diálogos tkinter
@anchor{library/dialog module-tkinter commondialog}@anchor{f2}@anchor{library/dialog tkinter-commondialog-dialog-window-templates}@anchor{3dc1}
@subsubsection @code{tkinter.commondialog} — Plantillas de ventanas de diálogo


@geindex module; tkinter.commondialog

`Código fuente:' Lib/tkinter/commondialog.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/commondialog.py}


__________________________________________________________________


El módulo @ref{f2,,tkinter.commondialog} proporciona la clase @ref{3d8b,,Dialog} que es la clase base para los diálogos definidos en otros módulos de soporte.

@geindex Dialog (clase en tkinter.commondialog)
@anchor{library/dialog tkinter commondialog Dialog}@anchor{3d8b}
@deffn {Clase} tkinter.commondialog.Dialog (master=None, **options)

@geindex show() (método de tkinter.commondialog.Dialog)
@anchor{library/dialog tkinter commondialog Dialog show}@anchor{3dc2}
@deffn {Método} show (color=None, **options)

Renderiza la ventana de diálogo.
@end deffn
@end deffn


@subsubheading Ver también


Módulos @ref{f6,,tkinter.messagebox}, @ref{1c86,,Leyendo y escribiendo archivos}


@node tkinter messagebox — Tkinter message prompts,tkinter scrolledtext — Scrolled Text Widget,Diálogos tkinter,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter messagebox doc}@anchor{3dc3}@anchor{library/tkinter messagebox module-tkinter messagebox}@anchor{f6}@anchor{library/tkinter messagebox tkinter-messagebox-tkinter-message-prompts}@anchor{3dc4}
@subsection @code{tkinter.messagebox} — Tkinter message prompts


@geindex module; tkinter.messagebox

`Código fuente:' Lib/tkinter/messagebox.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/messagebox.py}


__________________________________________________________________


The @ref{f6,,tkinter.messagebox} module provides a template base class as well as
a variety of convenience methods for commonly used configurations. The message
boxes are modal and will return a subset of (@code{True}, @code{False}, @code{None},
@ref{3dc5,,OK}, @ref{3dc6,,CANCEL}, @ref{3dc7,,YES}, @ref{3dc8,,NO}) based on
the user’s selection. Common message box styles and layouts include but are not
limited to:


@float Figure

@image{python-figures/tk_msg,,,,png}

@end float


@geindex Message (clase en tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox Message}@anchor{3dc9}
@deffn {Clase} tkinter.messagebox.Message (master=None, **options)

Create a message window with an application-specified message, an icon
and a set of buttons.
Each of the buttons in the message window is identified by a unique symbolic name (see the `type' options).

The following options are supported:

@quotation


@table @asis

@item `command'

Specifies the function to invoke when the user closes the dialog.
The name of the button clicked by the user to close the dialog is
passed as argument.
This is only available on macOS.

@item `default'

Gives the @ref{3dca,,symbolic name} of the default button
for this message window (@ref{3dc5,,OK}, @ref{3dc6,,CANCEL}, and so on).
If this option is not specified, the first button in the dialog will
be made the default.

@item `detail'

Specifies an auxiliary message to the main message given by the
`message' option.
The message detail will be presented beneath the main message and,
where supported by the OS, in a less emphasized font than the main
message.

@item `icon'

Specifies an @ref{3dcb,,icon} to display.
If this option is not specified, then the @ref{3dcc,,INFO} icon will be
displayed.

@item `message'

Specifies the message to display in this message box.
The default value is an empty string.

@item `parent'

Makes the specified window the logical parent of the message box.
The message box is displayed on top of its parent window.

@item `title'

Specifies a string to display as the title of the message box.
This option is ignored on macOS, where platform guidelines forbid
the use of a title on this kind of dialog.

@item `type'

Arranges for a @ref{3dcd,,predefined set of buttons}
to be displayed.
@end table
@end quotation

@geindex show() (método de tkinter.messagebox.Message)
@anchor{library/tkinter messagebox tkinter messagebox Message show}@anchor{3dce}
@deffn {Método} show (**options)

Display a message window and wait for the user to select one of the buttons. Then return the symbolic name of the selected button.
Keyword arguments can override options specified in the constructor.
@end deffn
@end deffn

`Cuadro de mensaje de información'

@geindex showinfo() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showinfo}@anchor{3dcf}
@deffn {Función} tkinter.messagebox.showinfo (title=None, message=None, **options)

Creates and displays an information message box with the specified title
and message.
@end deffn

`Cuadros de mensaje de advertencia'

@geindex showwarning() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showwarning}@anchor{3dd0}
@deffn {Función} tkinter.messagebox.showwarning (title=None, message=None, **options)

Creates and displays a warning message box with the specified title
and message.
@end deffn

@geindex showerror() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showerror}@anchor{3dd1}
@deffn {Función} tkinter.messagebox.showerror (title=None, message=None, **options)

Creates and displays an error message box with the specified title
and message.
@end deffn

`Cuadros de mensajes de preguntas'

@geindex askquestion() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askquestion}@anchor{3dd2}
@deffn {Función} tkinter.messagebox.askquestion (title=None, message=None, *, type=YESNO, **options)

Ask a question. By default shows buttons @ref{3dc7,,YES} and @ref{3dc8,,NO}.
Returns the symbolic name of the selected button.
@end deffn

@geindex askokcancel() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askokcancel}@anchor{3dd3}
@deffn {Función} tkinter.messagebox.askokcancel (title=None, message=None, **options)

Ask if operation should proceed. Shows buttons @ref{3dc5,,OK} and @ref{3dc6,,CANCEL}.
Returns @code{True} if the answer is ok and @code{False} otherwise.
@end deffn

@geindex askretrycancel() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askretrycancel}@anchor{3dd4}
@deffn {Función} tkinter.messagebox.askretrycancel (title=None, message=None, **options)

Ask if operation should be retried. Shows buttons @ref{3dd5,,RETRY} and @ref{3dc6,,CANCEL}.
Return @code{True} if the answer is yes and @code{False} otherwise.
@end deffn

@geindex askyesno() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askyesno}@anchor{3dd6}
@deffn {Función} tkinter.messagebox.askyesno (title=None, message=None, **options)

Ask a question. Shows buttons @ref{3dc7,,YES} and @ref{3dc8,,NO}.
Returns @code{True} if the answer is yes and @code{False} otherwise.
@end deffn

@geindex askyesnocancel() (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askyesnocancel}@anchor{3dd7}
@deffn {Función} tkinter.messagebox.askyesnocancel (title=None, message=None, **options)

Ask a question. Shows buttons @ref{3dc7,,YES}, @ref{3dc8,,NO} and @ref{3dc6,,CANCEL}.
Return @code{True} if the answer is yes, @code{None} if cancelled, and @code{False}
otherwise.
@end deffn
@anchor{library/tkinter messagebox messagebox-buttons}@anchor{3dca}
Symbolic names of buttons:

@geindex ABORT (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ABORT}@anchor{3dd8}
@deffn {Dato} tkinter.messagebox.ABORT = 'abort'
@end deffn

@geindex RETRY (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox RETRY}@anchor{3dd5}
@deffn {Dato} tkinter.messagebox.RETRY = 'retry'
@end deffn

@geindex IGNORE (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox IGNORE}@anchor{3dd9}
@deffn {Dato} tkinter.messagebox.IGNORE = 'ignore'
@end deffn

@geindex OK (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox OK}@anchor{3dc5}
@deffn {Dato} tkinter.messagebox.OK = 'ok'
@end deffn

@geindex CANCEL (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox CANCEL}@anchor{3dc6}
@deffn {Dato} tkinter.messagebox.CANCEL = 'cancel'
@end deffn

@geindex YES (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YES}@anchor{3dc7}
@deffn {Dato} tkinter.messagebox.YES = 'yes'
@end deffn

@geindex NO (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox NO}@anchor{3dc8}
@deffn {Dato} tkinter.messagebox.NO = 'no'
@end deffn
@anchor{library/tkinter messagebox messagebox-types}@anchor{3dcd}
Predefined sets of buttons:

@geindex ABORTRETRYIGNORE (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ABORTRETRYIGNORE}@anchor{3dda}
@deffn {Dato} tkinter.messagebox.ABORTRETRYIGNORE = 'abortretryignore'

Displays three buttons whose symbolic names are @ref{3dd8,,ABORT},
@ref{3dd5,,RETRY} and @ref{3dd9,,IGNORE}.
@end deffn


@deffn {Dato} tkinter.messagebox.OK = 'ok'

Displays one button whose symbolic name is @ref{3dc5,,OK}.
@end deffn

@geindex OKCANCEL (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox OKCANCEL}@anchor{3ddb}
@deffn {Dato} tkinter.messagebox.OKCANCEL = 'okcancel'

Displays two buttons whose symbolic names are @ref{3dc5,,OK} and
@ref{3dc6,,CANCEL}.
@end deffn

@geindex RETRYCANCEL (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox RETRYCANCEL}@anchor{3ddc}
@deffn {Dato} tkinter.messagebox.RETRYCANCEL = 'retrycancel'

Displays two buttons whose symbolic names are @ref{3dd5,,RETRY} and
@ref{3dc6,,CANCEL}.
@end deffn

@geindex YESNO (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YESNO}@anchor{3ddd}
@deffn {Dato} tkinter.messagebox.YESNO = 'yesno'

Displays two buttons whose symbolic names are @ref{3dc7,,YES} and
@ref{3dc8,,NO}.
@end deffn

@geindex YESNOCANCEL (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YESNOCANCEL}@anchor{3dde}
@deffn {Dato} tkinter.messagebox.YESNOCANCEL = 'yesnocancel'

Displays three buttons whose symbolic names are @ref{3dc7,,YES},
@ref{3dc8,,NO} and @ref{3dc6,,CANCEL}.
@end deffn
@anchor{library/tkinter messagebox messagebox-icons}@anchor{3dcb}
Icon images:

@geindex ERROR (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ERROR}@anchor{3ddf}
@deffn {Dato} tkinter.messagebox.ERROR = 'error'
@end deffn

@geindex INFO (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox INFO}@anchor{3dcc}
@deffn {Dato} tkinter.messagebox.INFO = 'info'
@end deffn

@geindex QUESTION (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox QUESTION}@anchor{3de0}
@deffn {Dato} tkinter.messagebox.QUESTION = 'question'
@end deffn

@geindex WARNING (en el módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox WARNING}@anchor{3de1}
@deffn {Dato} tkinter.messagebox.WARNING = 'warning'
@end deffn

@node tkinter scrolledtext — Scrolled Text Widget,tkinter dnd — Drag and drop support,tkinter messagebox — Tkinter message prompts,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter scrolledtext doc}@anchor{3de2}@anchor{library/tkinter scrolledtext module-tkinter scrolledtext}@anchor{f7}@anchor{library/tkinter scrolledtext tkinter-scrolledtext-scrolled-text-widget}@anchor{3de3}
@subsection @code{tkinter.scrolledtext} — Scrolled Text Widget


@geindex module; tkinter.scrolledtext

`Código fuente:' Lib/tkinter/scrolledtext.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/scrolledtext.py}


__________________________________________________________________


El módulo @ref{f7,,tkinter.scrolledtext} proporciona una clase del mismo nombre que implementa un widget de texto básico que tiene una barra de desplazamiento vertical configurada para hacer «lo correcto». Usar la clase @ref{3de4,,ScrolledText} es mucho más fácil que configurar un widget de texto y una barra de desplazamiento directamente.

El widget de texto y la barra de desplazamiento se empaquetan juntos en un @code{Frame}, y los métodos de los administradores de geometría @code{Grid} y @code{Pack} se adquieren del objeto @code{Frame}. Esto permite que el widget @ref{3de4,,ScrolledText} sea usado directamente para lograr el funcionamiento más normal del administrador de geometría.

Si fuera necesario un control más específico, los siguientes atributos están disponibles:

@geindex ScrolledText (clase en tkinter.scrolledtext)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText}@anchor{3de4}
@deffn {Clase} tkinter.scrolledtext.ScrolledText (master=None, **kw)

@geindex frame (atributo de tkinter.scrolledtext.ScrolledText)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText frame}@anchor{3de5}
@deffn {Atributo} frame

El marco que rodea el texto y los widgets de la barra de desplazamiento.
@end deffn

@geindex vbar (atributo de tkinter.scrolledtext.ScrolledText)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText vbar}@anchor{3de6}
@deffn {Atributo} vbar

El widget de la barra de desplazamiento.
@end deffn
@end deffn

@node tkinter dnd — Drag and drop support,tkinter ttk — Tk themed widgets,tkinter scrolledtext — Scrolled Text Widget,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter dnd doc}@anchor{3de7}@anchor{library/tkinter dnd module-tkinter dnd}@anchor{f3}@anchor{library/tkinter dnd tkinter-dnd-drag-and-drop-support}@anchor{3de8}
@subsection @code{tkinter.dnd} — Drag and drop support


@geindex module; tkinter.dnd

`Código fuente:' Lib/tkinter/dnd.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/dnd.py}


__________________________________________________________________


@cartouche
@quotation Nota 
Esto es experimental y quedará obsoleto cuando se sustituya por el Tk DND.
@end quotation
@end cartouche

El módulo @ref{f3,,tkinter.dnd} proporciona soporte para arrastrar y soltar objetos dentro de una sola aplicación, dentro de la misma ventana o entre ventanas. Para permitir que se arrastre un objeto, debe crear un enlace de evento para él que inicie el proceso de arrastrar y soltar. Por lo general, vincula un evento ButtonPress a una función de devolución de llamada que escribe (consulte @ref{3d7d,,Enlaces y eventos}). La función debe llamar a @ref{3de9,,dnd_start()}, donde “fuente” es el objeto que se va a arrastrar y “evento” es el evento que invoca la llamada (el argumento de la función de devolución de llamada).

La selección de un objeto de destino ocurre de la siguiente manera:


@enumerate 

@item 
Búsqueda de arriba hacia abajo del área debajo del mouse para el widget de destino
@end enumerate

@quotation


@itemize *

@item 
El widget de destino debe tener un atributo `dnd_accept' invocable

@item 
If `dnd_accept' is not present or returns @code{None}, search moves to parent widget

@item 
If no target widget is found, then the target object is @code{None}
@end itemize
@end quotation


@enumerate 2

@item 
Llama a `<old_target>.dnd_leave(source, event)'

@item 
Llama a `<new_target>.dnd_enter(source, event)'

@item 
Llama a `<target>.dnd_commit(source, event)' para notificar la caída

@item 
Llama a `<source>.dnd_end(target, event)' para señalar el final de arrastrar y soltar
@end enumerate

@geindex DndHandler (clase en tkinter.dnd)
@anchor{library/tkinter dnd tkinter dnd DndHandler}@anchor{3dea}
@deffn {Clase} tkinter.dnd.DndHandler (source, event)

La clase `DndHandler' maneja los eventos de arrastrar y soltar que rastrean los eventos Motion y ButtonRelease en la raíz del widget de eventos.

@geindex cancel() (método de tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler cancel}@anchor{3deb}
@deffn {Método} cancel (event=None)

Cancela el proceso de arrastrar y soltar.
@end deffn

@geindex finish() (método de tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler finish}@anchor{3dec}
@deffn {Método} finish (event, commit=0)

Ejecuta el fin de las funciones de arrastrar y soltar.
@end deffn

@geindex on_motion() (método de tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler on_motion}@anchor{3ded}
@deffn {Método} on_motion (event)

Inspecciona el área debajo del mouse en busca de objetos de destino mientras se realiza el arrastre.
@end deffn

@geindex on_release() (método de tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler on_release}@anchor{3dee}
@deffn {Método} on_release (event)

Señal de fin de arrastre cuando se activa el patrón de liberación.
@end deffn
@end deffn

@geindex dnd_start() (en el módulo tkinter.dnd)
@anchor{library/tkinter dnd tkinter dnd dnd_start}@anchor{3de9}
@deffn {Función} tkinter.dnd.dnd_start (source, event)

Función de fábrica para el proceso de arrastrar y soltar.
@end deffn


@subsubheading Ver también


@ref{3d7d,,Enlaces y eventos}


@node tkinter ttk — Tk themed widgets,IDLE<60>,tkinter dnd — Drag and drop support,Interfaces gráficas de usuario con Tk
@anchor{library/tkinter ttk doc}@anchor{3def}@anchor{library/tkinter ttk module-tkinter ttk}@anchor{f9}@anchor{library/tkinter ttk tkinter-ttk-tk-themed-widgets}@anchor{3df0}
@subsection @code{tkinter.ttk} — Tk themed widgets


@geindex module; tkinter.ttk

`Código fuente:' Lib/tkinter/ttk.py@footnote{https://github.com/python/cpython/tree/main/Lib/tkinter/ttk.py}

@geindex ttk


__________________________________________________________________


El módulo @ref{f9,,tkinter.ttk} brinda acceso al conjunto de widgets temáticos de Tk, introducido en Tk 8.5. Este brinda beneficios adicionales, incluida la representación de fuentes suavizadas en X11 y la transparencia de la ventana (que requiere un administrador de ventanas de composición en X11).

La idea básica de @ref{f9,,tkinter.ttk} es separar, en la medida de lo posible, el comportamiento de un widget del código que implementa su apariencia.


@subsubheading Ver también



@table @asis

@item Soporte para estilos de Widgets Tk@footnote{https://core.tcl.tk/tips/doc/trunk/tip/48.md}

Un documento que presenta apoyo temático para Tk
@end table


@menu
* Uso de Ttk:: 
* Ttk widgets:: 
* Widget:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk Styling:: 

@end menu

@node Uso de Ttk,Ttk widgets,,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk using-ttk}@anchor{3df1}
@subsubsection Uso de Ttk


Para empezar a utilizar Ttk, hay que importar su módulo:

@example
from tkinter import ttk
@end example

Para anular los widgets Tk básicos, la importación debe seguir la importación de Tk:

@example
from tkinter import *
from tkinter.ttk import *
@end example

Ese código hace que varios widgets @ref{f9,,tkinter.ttk} (@code{Button}, @code{Checkbutton}, @code{Entry}, @code{Frame}, @code{Label}, @code{LabelFrame}, @code{Menubutton}, @code{PanedWindow}, @code{Radiobutton}, @code{Scale} y @code{Scrollbar}) reemplacen automáticamente los widgets Tk.

Esto tiene el beneficio de usar los nuevos widgets que dan una mejor apariencia en todas las plataformas; sin embargo, el reemplazo de widgets no es completamente compatible. La principal diferencia es que las opciones de widgets como «fg», «bg» y otras relacionadas con el estilo del widget ya no están presentes en los widgets de Ttk. En su lugar, utiliza la clase @code{ttk.Style} para mejorar los efectos de estilo.


@subsubheading Ver también



@table @asis

@item Conversión de aplicaciones existentes para usar widgets Tile@footnote{http://tktable.sourceforge.net/tile/doc/converting.txt}

Una monografía (utilizando la terminología Tcl) sobre las diferencias que normalmente se encuentran al modificar aplicaciones para usar los nuevos widgets.
@end table


@node Ttk widgets,Widget,Uso de Ttk,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk ttk-widgets}@anchor{3df2}
@subsubsection Ttk widgets


Ttk viene con 18 widgets, doce de los cuales ya existían en tkinter: @code{Button}, @code{Checkbutton}, @code{Entry}, @code{Frame}, @code{Label}, @code{LabelFrame}, @code{Menubutton}, @code{PanedWindow}, @code{Radiobutton}, @code{Scale}, @code{Scrollbar} y @ref{c1c,,Spinbox}. Los otros seis son nuevos: @ref{3df3,,Combobox}, @ref{3df4,,Notebook}, @ref{3df5,,Progressbar}, @code{Separator}, @code{Sizegrip} y @ref{b1f,,Treeview}. Y todas ellas son subclases de @ref{3df6,,Widget}.

El uso de los widgets Ttk le da a la aplicación un aspecto mejorado. Como se ha mencionado anteriormente, hay diferencias en cómo se codifica el estilo.

Código Tk:

@example
l1 = tkinter.Label(text="Test", fg="black", bg="white")
l2 = tkinter.Label(text="Test", fg="black", bg="white")
@end example

Código Ttk:

@example
style = ttk.Style()
style.configure("BW.TLabel", foreground="black", background="white")

l1 = ttk.Label(text="Test", style="BW.TLabel")
l2 = ttk.Label(text="Test", style="BW.TLabel")
@end example

Para obtener más información acerca de @ref{3df7,,TtkStyling}, consulta la documentación de la clase @ref{3b0,,Style}.

@node Widget,Combobox,Ttk widgets,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk widget}@anchor{3df8}
@subsubsection Widget


@code{ttk.Widget} define las opciones y métodos estándar compatibles con los widgets temáticos de Tk y no se crea una instancia directamente.

@menu
* Opciones estándar:: 
* Opciones de widgets desplegables:: 
* Opciones de etiqueta:: 
* Opciones de compatibilidad:: 
* Estados del widget:: 
* ttk.Widget: ttk Widget. 

@end menu

@node Opciones estándar,Opciones de widgets desplegables,,Widget
@anchor{library/tkinter ttk standard-options}@anchor{3df9}
@subsubsection Opciones estándar


Todos los Widgets @code{ttk} aceptan las siguientes opciones:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

class

@tab

Especifica la clase de ventana. La clase se usa cuando se consulta la base de datos de opciones para las otras opciones de la ventana, para determinar las etiquetas de enlace (`bindtags') predeterminadas para la ventana y para seleccionar el diseño y estilo predeterminados del widget. Esta opción es de solo lectura y solo se puede especificar cuando se crea la ventana.

@item

cursor

@tab

Especifica el cursor del mouse que se utilizará para el widget. Si se establece en la cadena vacía (el valor predeterminado), el cursor se hereda para el widget principal.

@item

takefocus

@tab

Determina si la ventana acepta el foco durante el recorrido del teclado. Se retorna 0, 1 o una cadena vacía. Si se retorna 0, significa que la ventana debe omitirse por completo durante el recorrido del teclado. Si es 1, significa que la ventana debe recibir el foco de entrada siempre que sea visible. Y una cadena vacía significa que los scripts transversales toman la decisión sobre si enfocarse o no en la ventana.

@item

style

@tab

Se puede usar para especificar un estilo personalizado para el widget.

@end multitable


@node Opciones de widgets desplegables,Opciones de etiqueta,Opciones estándar,Widget
@anchor{library/tkinter ttk scrollable-widget-options}@anchor{3dfa}
@subsubsection Opciones de widgets desplegables


Los widgets controlados por una barra deslizante presentan las siguientes opciones.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

xscrollcommand

@tab

Se usa para interactuar con las barras deslizantes horizontales.

Cuando la vista en la ventana del widget cambia, el widget generará un comando Tcl basado en el scrollcommand.

Por lo general, esta opción consiste en el método @code{Scrollbar.set()} de barras deslizantes. Esto hará que la barra deslizante se actualice cada vez que cambie la vista de la ventana.

@item

yscrollcommand

@tab

Se utiliza para comunicarse con las barras deslizantes verticales. Para obtener más información, consulta más arriba.

@end multitable


@node Opciones de etiqueta,Opciones de compatibilidad,Opciones de widgets desplegables,Widget
@anchor{library/tkinter ttk label-options}@anchor{3dfb}
@subsubsection Opciones de etiqueta


Las siguientes opciones son compatibles con etiquetas, botones y otros widgets similares a botones.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

text

@tab

Especifica una cadena de texto que se mostrará dentro del widget.

@item

textvariable

@tab

Especifica un nombre cuyo valor se utilizará en lugar del recurso de opción de texto.

@item

underline

@tab

Si se activa, especifica el índice (empezando por 0) de un carácter que se va a subrayar en la cadena de texto. El carácter subrayado se utiliza para la activación mnemotécnica.

@item

image

@tab

Especifica una imagen que se va a mostrar. Es una lista de 1 o más elementos. El primer elemento es el nombre de imagen predeterminado. El resto de la lista es una secuencia de pares statespec/value según lo definido por @ref{1927,,Style.map()}, especificando diferentes imágenes para usar cuando el widget está en un estado determinado o una combinación de estados. Todas las imágenes de la lista deben tener el mismo tamaño.

@item

compound

@tab

Especifica cómo mostrar la imagen en relación con el texto, en el caso de que estén presentes las opciones de texto e imágenes. Los valores válidos son:


@itemize *

@item 
text: mostrar solo texto

@item 
image: mostrar solo la imagen

@item 
top, bottom, left, right: muestra la imagen por encima, por debajo, a la izquierda o a la derecha del texto, respectivamente.

@item 
none: valor predeterminado. Mostrar la imagen si está presente, de lo contrario el texto.
@end itemize

@item

width

@tab

Si es mayor que cero, especifica cuánto espacio, en ancho de caracteres, se debe asignar para la etiqueta de texto; si es menor que cero, especifica un ancho mínimo. Si es cero o no se especifica, se utiliza el ancho natural de la etiqueta de texto.

@end multitable


@node Opciones de compatibilidad,Estados del widget,Opciones de etiqueta,Widget
@anchor{library/tkinter ttk compatibility-options}@anchor{3dfc}
@subsubsection Opciones de compatibilidad



@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

state

@tab

Se puede establecer en «normal» o «deshabilitado» para controlar el bit de estado «deshabilitado». Esta es una opción de solo escritura: establecerlo cambia el estado del widget, pero el método @ref{3dfd,,Widget.state()} no afecta a esta opción.

@end multitable


@node Estados del widget,ttk Widget,Opciones de compatibilidad,Widget
@anchor{library/tkinter ttk widget-states}@anchor{3dfe}
@subsubsection Estados del widget


El estado del widget es un mapa de bits de indicadores de estado independientes.


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Indicador de estado

@tab

Descripción

@item

active

@tab

El puntero está sobre el widget y clickeando sobre él producirá alguna acción

@item

disabled

@tab

El widget está desactivado bajo el control del programa

@item

focus

@tab

El widget tiene el enfoque del teclado

@item

pressed

@tab

El widget está siendo pulsado

@item

selected

@tab

«On», «true» o «current» para aspectos como Checkbuttons y radiobuttons

@item

background

@tab

Windows y Mac tienen el concepto de ventana «activa» o en primer plano. El estado `background' se establece para los widgets en una ventana de fondo y se borra para los que están en la ventana en primer plano

@item

readonly

@tab

El widget no debe permitir la modificación del usuario

@item

alternate

@tab

Un formato de visualización alternativo específico del widget

@item

invalid

@tab

El valor del widget no es válido

@end multitable


Una especificación de estado es una secuencia de nombres de estado, opcionalmente prefijados con un signo de exclamación que indica que el bit está desactivado.

@node ttk Widget,,Estados del widget,Widget
@anchor{library/tkinter ttk ttk-widget}@anchor{3dff}
@subsubsection ttk.Widget


Además de los métodos descritos a continuación, el @code{ttk.Widget} soporta los métodos @code{tkinter.Widget.cget()} y @code{tkinter.Widget.configure()}.

@geindex Widget (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Widget}@anchor{3df6}
@deffn {Clase} tkinter.ttk.Widget

@geindex identify() (método de tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget identify}@anchor{3e00}
@deffn {Método} identify (x, y)

Retorna el nombre del elemento en la posición `x' `y' o la cadena vacía si el punto no se encuentra dentro de ningún elemento.

`x' e `y' son coordenadas en píxeles relativas al widget.
@end deffn

@geindex instate() (método de tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget instate}@anchor{3e01}
@deffn {Método} instate (statespec, callback=None, *args, **kw)

Prueba el estado del widget. Si no se especifica una retrollamada, retorna @code{True} si el estado del widget coincide con `statespec' y @code{False} en caso contrario. Si se especifica la retrollamada, se llama con argumentos (`args') si el estado del widget coincide con `statespec'.
@end deffn

@geindex state() (método de tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget state}@anchor{3dfd}
@deffn {Método} state (statespec=None)

Modifica o pregunta el estado del widget. Si se especifica `statespec', establece el estado del widget según éste y retorna un nuevo `statespec' informando cuales indicadores se han cambiado. Si no se especifica `statespec', retorna los indicadores de estado habilitados actualmente.
@end deffn

`statespec' es generalmente una lista o una tupla.
@end deffn

@node Combobox,Spinbox,Widget,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk combobox}@anchor{3e02}
@subsubsection Combobox


El widget @code{ttk.Combobox} combina un campo de texto con una lista desplegable de valores. Este widget es una subclase de @code{Entry}.

Además de los métodos heredados de @ref{3df6,,Widget}: @code{Widget.cget()}, @code{Widget.configure()}, @ref{3e00,,Widget.identify()}, @ref{3e01,,Widget.instate()} y @ref{3dfd,,Widget.state()}, y los siguientes heredados de @code{Entry}: @code{Entry.bbox()}, @code{Entry.delete()}, @code{Entry.icursor()}, @code{Entry.index()}, @code{Entry.insert()}, @code{Entry.selection()}, @code{Entry.xview()}, tiene algunos otros métodos, descritos en @code{ttk.Combobox}.

@menu
* Opciones:: 
* Eventos virtuales:: 
* ttk.Combobox: ttk Combobox. 

@end menu

@node Opciones,Eventos virtuales,,Combobox
@anchor{library/tkinter ttk options}@anchor{3e03}
@subsubsection Opciones


Este widget acepta las siguientes opciones específicas:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

exportselection

@tab

Valor booleano. Si se establece, la selección del widget está vinculada a la selección del Administrador de ventanas (que se puede retornar invocando Misc.selection_get, por ejemplo).

@item

justify

@tab

Especifica cómo el texto se alinea en el widget. Uno de «left», «center» o «right».

@item

height

@tab

Especifica el largo/altura del cuadro de la lista desplegable, en filas.

@item

postcommand

@tab

Un script (posiblemente registrado con Misc.register) que se llama inmediatamente antes de mostrar los valores. Puede especificar qué valores mostrar.

@item

state

@tab

Uno de «normal», «readonly» o «disabled». En el estado «readonly» el valor no se puede editar directamente y el usuario solo puede seleccionar los valores de la lista desplegable. En el estado «normal» el campo de texto se puede editar directamente. En el estado «deshabilitado» no es posible ninguna interacción.

@item

textvariable

@tab

Especifica un nombre cuyo valor está vinculado al valor del widget. Cada vez que cambia el valor asociado a ese nombre, se actualiza el valor del widget y viceversa. Véase @code{tkinter.StringVar}.

@item

values

@tab

Especifica la lista de valores que se mostrarán en el cuadro de lista desplegable.

@item

width

@tab

Especifica un valor entero que indica el ancho deseado de la ventana de entrada, en caracteres de tamaño medio de la fuente del widget.

@end multitable


@node Eventos virtuales,ttk Combobox,Opciones,Combobox
@anchor{library/tkinter ttk virtual-events}@anchor{3e04}
@subsubsection Eventos virtuales


Los widgets de cuadro combinado generan un evento virtual `<<ComboboxSelected>>' cuando el usuario selecciona un elemento de la lista de valores.

@node ttk Combobox,,Eventos virtuales,Combobox
@anchor{library/tkinter ttk ttk-combobox}@anchor{3e05}
@subsubsection ttk.Combobox


@geindex Combobox (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Combobox}@anchor{3df3}
@deffn {Clase} tkinter.ttk.Combobox

@geindex current() (método de tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox current}@anchor{3e06}
@deffn {Método} current (newindex=None)

Si se especifica `newindex', establece el valor del cuadro combinado en la posición del elemento `newindex'. De lo contrario, retorna el índice del valor actual o -1 si el valor actual no está en la lista de valores.
@end deffn

@geindex get() (método de tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox get}@anchor{3e07}
@deffn {Método} get ()

Retorna el valor actual del cuadro combinado.
@end deffn

@geindex set() (método de tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox set}@anchor{3e08}
@deffn {Método} set (value)

Establece el valor del cuadro combinado a `value'.
@end deffn
@end deffn

@node Spinbox,Notebook,Combobox,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk spinbox}@anchor{3e09}
@subsubsection Spinbox


El widget @code{ttk.Spinbox} es un @code{ttk.Entry} mejorado con flechas de incremento y decremento. Se puede utilizar para números o listas de valores de cadena. Este widget es una subclase de @code{Entry}.

Además de los métodos heredados de @ref{3df6,,Widget}: @code{Widget.cget()}, @code{Widget.configure()}, @ref{3e00,,Widget.identify()}, @ref{3e01,,Widget.instate()} y @ref{3dfd,,Widget.state()}, y los siguientes heredados de @code{Entry}: @code{Entry.bbox()}, @code{Entry.delete()}, @code{Entry.icursor()}, @code{Entry.index()}, @code{Entry.insert()}, @code{Entry.xview()}, tiene algunos otros métodos, descritos en @code{ttk.Spinbox}.

@menu
* Opciones: Opciones<2>. 
* Eventos virtuales: Eventos virtuales<2>. 
* ttk.Spinbox: ttk Spinbox. 

@end menu

@node Opciones<2>,Eventos virtuales<2>,,Spinbox
@anchor{library/tkinter ttk id1}@anchor{3e0a}
@subsubsection Opciones


Este widget acepta las siguientes opciones específicas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

from

@tab

Valor flotante. Si se establece, este es el valor mínimo al que se reducirá el botón de disminución. Debe escribirse como @code{from_} cuando se usa como argumento, ya que @code{from} es una palabra clave de Python.

@item

to

@tab

Valor flotante. Si se establece, este es el valor máximo al que se incrementará el botón de incremento.

@item

increment

@tab

Valor flotante. Especifica la cantidad por la cual los botones de incremento/disminución cambian el valor. Por defecto la cantidad es de 1.0.

@item

values

@tab

Secuencia de valores de cadena o flotantes. Si se especifica, los botones de incremento/disminución recorrerán los elementos de esta secuencia en lugar de incrementar o disminuir los números.

@item

wrap

@tab

Valor booleano. Si es @code{True}, los botones de incremento y disminución pasarán del valor @code{to} al valor @code{from} o del valor @code{from} al valor @code{to}, respectivamente.

@item

format

@tab

Valor de cadena. Especifica el formato de los números establecidos por los botones de incremento/disminución. Debe tener la forma «%W.Pf», donde W es el ancho de relleno del valor, P es la precisión, y “%” y “f” son literales.

@item

command

@tab

Python invocable. Se llamará sin argumentos cada vez que se presione alguno de los botones de incremento o disminución.

@end multitable


@node Eventos virtuales<2>,ttk Spinbox,Opciones<2>,Spinbox
@anchor{library/tkinter ttk id2}@anchor{3e0b}
@subsubsection Eventos virtuales


El widget spinbox genera un evento virtual `<<Increment>>' cuando el usuario presiona <Up>, y un evento virtual `<<Decrement>>' cuando el usuario presiona <Down>.

@node ttk Spinbox,,Eventos virtuales<2>,Spinbox
@anchor{library/tkinter ttk ttk-spinbox}@anchor{3e0c}
@subsubsection ttk.Spinbox


@geindex Spinbox (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Spinbox}@anchor{c1c}
@deffn {Clase} tkinter.ttk.Spinbox

@geindex get() (método de tkinter.ttk.Spinbox)
@anchor{library/tkinter ttk tkinter ttk Spinbox get}@anchor{3e0d}
@deffn {Método} get ()

Retorna el valor actual del spinbox.
@end deffn

@geindex set() (método de tkinter.ttk.Spinbox)
@anchor{library/tkinter ttk tkinter ttk Spinbox set}@anchor{3e0e}
@deffn {Método} set (value)

Establece el valor del spinbox a `value'.
@end deffn
@end deffn

@node Notebook,Progressbar,Spinbox,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk notebook}@anchor{3e0f}
@subsubsection Notebook


El widget Ttk Notebook administra una colección de ventanas y muestra una sola a la vez. Cada ventana secundaria está asociada a una pestaña, que el usuario puede seleccionar para cambiar la ventana que se muestra actualmente.

@menu
* Opciones: Opciones<3>. 
* Opciones de pestañas:: 
* Identificadores de pestañas:: 
* Eventos virtuales: Eventos virtuales<3>. 
* ttk.Notebook: ttk Notebook. 

@end menu

@node Opciones<3>,Opciones de pestañas,,Notebook
@anchor{library/tkinter ttk id3}@anchor{3e10}
@subsubsection Opciones


Este widget acepta las siguientes opciones específicas:


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

height

@tab

Si está presente y es mayor que cero, especifica la altura deseada del área del panel (sin incluir el relleno interno o las pestañas). De lo contrario, se utiliza la altura máxima de todos los paneles.

@item

padding

@tab

Especifica la cantidad de espacio adicional que se va a agregar alrededor del exterior del bloc de notas. El relleno es una lista de hasta cuatro especificaciones de longitud izquierda superior derecha inferior. Si se especifican menos de cuatro elementos, el valor predeterminado inferior es el superior, el valor predeterminado de la derecha es el de la izquierda y el valor predeterminado superior es el de la izquierda.

@item

width

@tab

Si está presente y es mayor que cero, especifica el ancho deseado del área del panel (sin incluir el relleno interno). De lo contrario, se utiliza el ancho máximo de todos los paneles.

@end multitable


@node Opciones de pestañas,Identificadores de pestañas,Opciones<3>,Notebook
@anchor{library/tkinter ttk tab-options}@anchor{3e11}
@subsubsection Opciones de pestañas


Las opciones específicas para pestañas son:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

state

@tab

O bien «normal», «disabled» o «hidden». Si es «disabled», la pestaña no se puede seleccionar. Si es «hidden», la pestaña no se muestra.

@item

sticky

@tab

Especifica cómo se coloca la ventana secundaria dentro del área del panel. `Value' es una cadena que contiene cero o más de los caracteres «n», «s», «e» o «w». Cada letra se refiere a un lado (norte, sur, este u oeste) al que se pegará la ventana secundaria, según el administrador de geometría @code{grid()}.

@item

padding

@tab

Especifica la cantidad de espacio adicional que se va a agregar entre el notebook y este panel. La sintaxis es la misma que para el relleno de opciones utilizado por Notebook.

@item

text

@tab

Especifica un texto que se muestra en la pestaña.

@item

image

@tab

Especifica una imagen que se muestra en la pestaña. Consulta la opción de imagen descrita en @ref{3df6,,Widget}.

@item

compound

@tab

Especifica cómo mostrar la imagen en relación con el texto, en el caso de que tanto el texto como la imagen estén presentes. Consulta @ref{3dfb,,Label Options} para obtener valores válidos.

@item

underline

@tab

Especifica el índice (basado en 0) de un carácter que se va a subrayar en la cadena de texto. El carácter subrayado se utiliza para la activación mnemotécnica si se llama a @ref{3e12,,Notebook.enable_traversal()}.

@end multitable


@node Identificadores de pestañas,Eventos virtuales<3>,Opciones de pestañas,Notebook
@anchor{library/tkinter ttk tab-identifiers}@anchor{3e13}
@subsubsection Identificadores de pestañas


El tab_id presente en varios métodos de @code{ttk.Notebook} puede tener cualquiera de las siguientes formas:


@itemize *

@item 
Un entero entre cero y el número de pestañas

@item 
El nombre de una ventana secundaria

@item 
Un especificación de posición de la forma «@@x,y» que identifique la pestaña

@item 
El valor «current» el cual identifica la pestaña seleccionada actualmente

@item 
El valor «end» que retorna el número de pestañas (válido solo para @ref{3e14,,Notebook.index()})
@end itemize

@node Eventos virtuales<3>,ttk Notebook,Identificadores de pestañas,Notebook
@anchor{library/tkinter ttk id4}@anchor{3e15}
@subsubsection Eventos virtuales


Este widget genera un evento virtual `<<NotebookTabChanged>>' después de seleccionar una nueva pestaña.

@node ttk Notebook,,Eventos virtuales<3>,Notebook
@anchor{library/tkinter ttk ttk-notebook}@anchor{3e16}
@subsubsection ttk.Notebook


@geindex Notebook (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Notebook}@anchor{3df4}
@deffn {Clase} tkinter.ttk.Notebook

@geindex add() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook add}@anchor{3e17}
@deffn {Método} add (child, **kw)

Añade una nueva pestaña al notebook.

Si la ventana está actualmente administrada por el notebook pero oculta, se restaura a su posición anterior.

Consulta @ref{3e11,,Tab Options} para la lista de opciones disponibles.
@end deffn

@geindex forget() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook forget}@anchor{3e18}
@deffn {Método} forget (tab_id)

Quita la pestaña especificada por `tab_id', desasigna y quita la ventana asociada.
@end deffn

@geindex hide() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook hide}@anchor{3e19}
@deffn {Método} hide (tab_id)

Oculta la pestaña especificada por `tab_id'.

La pestaña no se mostrará, pero la ventana asociada permanece administrada por el notebook y se recordará su configuración. Las pestañas ocultas se pueden restaurar con el comando @ref{3e17,,add()}.
@end deffn

@geindex identify() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook identify}@anchor{3e1a}
@deffn {Método} identify (x, y)

Retorna el nombre del elemento de la pestaña en la posición `x', `y' o cadena vacía si no hay ninguno.
@end deffn

@geindex index() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook index}@anchor{3e14}
@deffn {Método} index (tab_id)

Retorna el índice numérico de la pestaña especificada por `tab_id', o el número total de pestañas si `tab_id' es la cadena «end».
@end deffn

@geindex insert() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook insert}@anchor{3e1b}
@deffn {Método} insert (pos, child, **kw)

Añade un panel en la posición especificada.

`pos' es la cadena «end», un índice entero o el nombre de un elemento secundario administrado. Si el bloc de notas ya administra `child', lo mueve a la posición especificada.

Consulta @ref{3e11,,Tab Options} para la lista de opciones disponibles.
@end deffn

@geindex select() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook select}@anchor{3e1c}
@deffn {Método} select (tab_id=None)

Selecciona el `tab_id' especificado.

Se mostrará la ventana secundaria asociada y la ventana previamente seleccionada (si es diferente) no se debe asignar. Si se omite `tab_id', retorna el nombre del widget del panel seleccionado actualmente.
@end deffn

@geindex tab() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook tab}@anchor{3e1d}
@deffn {Método} tab (tab_id, option=None, **kw)

Consultar o modificar las opciones del `tab_id' específico.

Si no se proporciona `kw', retorna un diccionario de los valores de las opciones de pestañas. Si se especifica `option', retorna el valor de esa `option'. De lo contrario, establece las opciones en los valores correspondientes.
@end deffn

@geindex tabs() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook tabs}@anchor{3e1e}
@deffn {Método} tabs ()

Retorna una lista de ventanas administradas por el notebook.
@end deffn

@geindex enable_traversal() (método de tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook enable_traversal}@anchor{3e12}
@deffn {Método} enable_traversal ()

Habilita la tabulación para una ventana de nivel superior que contenga este notebook.

Esto extenderá los enlaces para la ventana de nivel superior que contiene el notebook del siguiente modo:


@itemize *

@item 
@code{Control-Tab}: selecciona la pestaña siguiente a la seleccionada actualmente.

@item 
@code{Shift-Control-Tab}: selecciona la pestaña precedente a la seleccionada actualmente.

@item 
@code{Alt-K}: donde `K' es el carácter mnemotécnico (subrayado) de cualquier pestaña, seleccionará esa pestaña.
@end itemize

Se pueden habilitar varios notebooks en un único nivel superior para la tabulación, incluidos los notebooks anidados. Sin embargo, la tabulación entre notebooks solo funciona correctamente si todos los paneles tienen el notebook en el que se encuentran como maestro.
@end deffn
@end deffn

@node Progressbar,Separator,Notebook,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk progressbar}@anchor{3e1f}
@subsubsection Progressbar


El widget @code{ttk.Progressbar} muestra el estado de una operación de larga duración. Puede funcionar en dos modos: 1) el modo determinado que muestra la cantidad completada en función de la cantidad total de trabajo a realizar y 2) el modo indeterminado que proporciona una pantalla animada para que el usuario sepa que la operación está en curso.

@menu
* Opciones: Opciones<4>. 
* ttk.Progressbar: ttk Progressbar. 

@end menu

@node Opciones<4>,ttk Progressbar,,Progressbar
@anchor{library/tkinter ttk id5}@anchor{3e20}
@subsubsection Opciones


Este widget acepta las siguientes opciones específicas:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

orient

@tab

Puede ser «horizontal» o «vertical». Especifica la orientación de la barra de progreso.

@item

length

@tab

Especifica la longitud del eje largo de la barra de progreso (ancho si horizontal, alto si es vertical).

@item

mode

@tab

Puede ser «determinate» o «indeterminate».

@item

maximum

@tab

Número que especifica el valor máximo. Por defecto el valor es 100.

@item

value

@tab

El valor actual de la barra de progreso. En el modo «determinado», representa la cantidad de trabajo completado. En el modo «indeterminado», se interpreta como módulo `maximum', es decir, la barra de progreso completa un «ciclo» cuando su valor aumenta en `maximum'.

@item

variable

@tab

Nombre vinculado al valor de la opción. Si se especifica, el valor de la barra de progreso se establece automáticamente en el valor de este nombre cada vez que se modifica dicho valor.

@item

phase

@tab

Variable de solo lectura. El widget incrementa periódicamente el valor de esta opción siempre que su valor sea mayor que 0 y, en modo determinado, menor que el máximo. Esta opción puede ser utilizada por el tema actual para proporcionar efectos de animación adicionales.

@end multitable


@node ttk Progressbar,,Opciones<4>,Progressbar
@anchor{library/tkinter ttk ttk-progressbar}@anchor{3e21}
@subsubsection ttk.Progressbar


@geindex Progressbar (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Progressbar}@anchor{3df5}
@deffn {Clase} tkinter.ttk.Progressbar

@geindex start() (método de tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar start}@anchor{3e22}
@deffn {Método} start (interval=None)

Inicia el modo de incremento automático: programa un evento `timer' periódico que llama a @ref{3e23,,Progressbar.step()} cada `interval' milisegundos. Si se omite, `interval' tiene como valor predeterminado 50 milisegundos.
@end deffn

@geindex step() (método de tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar step}@anchor{3e23}
@deffn {Método} step (amount=None)

Incrementa el valor de la barra de progreso en `amount'.

`amount' vale 1.0 por defecto si se omite.
@end deffn

@geindex stop() (método de tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar stop}@anchor{3e24}
@deffn {Método} stop ()

Para el modo de incremento automático: cancela cualquier evento `timer' periódico iniciado por @ref{3e22,,Progressbar.start()} para la barra de progreso en cuestión.
@end deffn
@end deffn

@node Separator,Sizegrip,Progressbar,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk separator}@anchor{3e25}
@subsubsection Separator


El widget @code{ttk.Separator} muestra una barra de separación horizontal o vertical.

No tiene otros métodos aparte de aquellos heredados de @code{ttk.Widget}.

@menu
* Opciones: Opciones<5>. 

@end menu

@node Opciones<5>,,,Separator
@anchor{library/tkinter ttk id6}@anchor{3e26}
@subsubsection Opciones


Este widget acepta las opción específica siguiente:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

orient

@tab

Puede ser «horizontal» o «vertical». Especifica la orientación del separador.

@end multitable


@node Sizegrip,Treeview,Separator,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk sizegrip}@anchor{3e27}
@subsubsection Sizegrip


El widget @code{ttk.Sizegrip} (también conocido como `grow box') permite al usuario cambiar el tamaño de la ventana de nivel superior que lo contiene presionando y arrastrando la esquina.

Este widget no tiene ni opciones ni métodos específicos, aparte de aquellos heredados de @code{ttk.Widget}.

@menu
* Notas específicas por plataforma:: 
* Errores detectados:: 

@end menu

@node Notas específicas por plataforma,Errores detectados,,Sizegrip
@anchor{library/tkinter ttk platform-specific-notes}@anchor{3e28}
@subsubsection Notas específicas por plataforma



@itemize *

@item 
En macOS, las ventanas de nivel superior incluyen automáticamente un control de tamaño integrado de forma predeterminada. Agregar un @code{Sizegrip} es inofensivo, ya que el agarre integrado solo enmascara el widget.
@end itemize

@node Errores detectados,,Notas específicas por plataforma,Sizegrip
@anchor{library/tkinter ttk bugs}@anchor{3e29}
@subsubsection Errores detectados



@itemize *

@item 
Si la posición del nivel superior que lo contiene se especifica en relación con la parte derecha o inferior de la pantalla (por ejemplo,…), el widget @code{Sizegrip} no cambiará el tamaño de la ventana.

@item 
El widget solo soporta el cambio de tamaño desde la esquina inferior derecha.
@end itemize

@node Treeview,Ttk Styling,Sizegrip,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk treeview}@anchor{3e2a}
@subsubsection Treeview


El widget @code{ttk.Treeview} muestra una colección en árbol de elementos. Cada elemento tiene una etiqueta textual, una imagen opcional y una lista opcional de valores de datos. Los valores de datos se muestran en columnas sucesivas después de la etiqueta de árbol.

El orden en que se muestran los valores de datos se puede controlar estableciendo la opción de widget @code{displaycolumns}. El Treeview también puede mostrar encabezados. Se puede acceder a las columnas por número o nombres simbólicos enumerados en las columnas de opciones del widget. Consulte @ref{3e2b,,Column Identifiers}.

Cada elemento se identifica con un nombre único. El widget genera IDs para los elementos si no se proporcionan en la declaración. Hay un elemento raíz distinguido, denominado @code{@{@}}. El elemento raíz en sí no se muestra; sus hijos aparecen en el nivel superior de la jerarquía.

Cada elemento también tiene una lista de etiquetas que se pueden usar para asociar enlaces de eventos con elementos individuales y controlar la apariencia del elemento.

El widget Treeview admite el deslizamiento horizontal y vertical, según las opciones descritas en @ref{3dfa,,Scrollable Widget Options} y los métodos @ref{3e2c,,Treeview.xview()} y @ref{3e2d,,Treeview.yview()}.

@menu
* Opciones: Opciones<6>. 
* Opciones de elementos:: 
* Opciones de etiqueta: Opciones de etiqueta<2>. 
* Identificadores de columna:: 
* Eventos virtuales: Eventos virtuales<4>. 
* ttk.Treeview: ttk Treeview. 

@end menu

@node Opciones<6>,Opciones de elementos,,Treeview
@anchor{library/tkinter ttk id7}@anchor{3e2e}
@subsubsection Opciones


Este widget acepta las siguientes opciones específicas:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

columns

@tab

Una lista de identificadores de columna, que especifican el número de columnas y sus nombres.

@item

displaycolumns

@tab

Una lista de identificadores de columna (índices simbólicos o enteros) que especifican qué columnas de datos se muestran y el orden en que aparecen, o la cadena «#all».

@item

height

@tab

Especifica el número de filas que deben estar visibles. Nota: el ancho solicitado se determina a partir de la suma de los anchos de columna.

@item

padding

@tab

Especifica el relleno interno del widget. El relleno es una lista de hasta cuatro especificaciones de longitud.

@item

selectmode

@tab

Controla cómo los enlaces de clase integrados administran la selección. Puede ser «extended», «browse» o «none». Si se establece en «extended» (valor predeterminado), se pueden seleccionar varios elementos. Si se elige «browse», se seleccionará un solo elemento a la vez. Si se elige «none», la selección no se cambiará.

Tenga en cuenta que el código de la aplicación y los enlaces de etiqueta pueden establecer la selección como deseen, independientemente del valor de esta opción.

@item

show

@tab

Una lista que contiene cero o más de los siguientes valores, especificando qué elementos del árbol se van a mostrar.


@itemize *

@item 
tree: muestra las etiquetas del árbol en la columna #0.

@item 
headings: muestra la fila de encabezado.
@end itemize

El valor predeterminado es «tree headings», es decir, mostrar todos los elementos.

`Nota': la columna #0 siempre hace referencia a la columna del árbol, incluso si no se especifica show=»tree».

@end multitable


@node Opciones de elementos,Opciones de etiqueta<2>,Opciones<6>,Treeview
@anchor{library/tkinter ttk item-options}@anchor{3e2f}
@subsubsection Opciones de elementos


Las siguientes opciones de elemento se pueden especificar para los elementos de los comandos de inserción y de elementos del widget.


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

text

@tab

La etiqueta textual que se va a mostrar para el elemento.

@item

image

@tab

Una imagen Tk, que se muestra a la izquierda de la etiqueta.

@item

values

@tab

La lista de valores asociados al elemento.

Cada elemento debe tener el mismo número de valores que las columnas de opciones del widget. Si hay menos valores que columnas, los valores restantes se asumen vacíos. Si hay más valores que columnas, se omiten los valores adicionales.

@item

open

@tab

Valor @code{True}/@code{False} que indica si los elementos secundarios deben mostrarse u ocultarse.

@item

tags

@tab

La lista de etiquetas asociadas al elemento.

@end multitable


@node Opciones de etiqueta<2>,Identificadores de columna,Opciones de elementos,Treeview
@anchor{library/tkinter ttk tag-options}@anchor{3e30}
@subsubsection Opciones de etiqueta


Se pueden especificar las opciones siguientes para etiquetas:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opción

@tab

Descripción

@item

foreground

@tab

Especifica el color de primer plano del texto.

@item

background

@tab

Especifica el color de fondo de la celda o elemento.

@item

font

@tab

Especifica la fuente que se utilizará al añadir texto.

@item

image

@tab

Especifica la imagen del elemento, en caso de que la opción de imagen del elemento esté vacía.

@end multitable


@node Identificadores de columna,Eventos virtuales<4>,Opciones de etiqueta<2>,Treeview
@anchor{library/tkinter ttk column-identifiers}@anchor{3e2b}
@subsubsection Identificadores de columna


Los identificadores de columna toman cualquiera de los siguientes formas:


@itemize *

@item 
Un nombre simbólico de la lista de opciones de columna.

@item 
Un entero n, especificando la enésima columna de datos.

@item 
Una cadena de la forma #n, donde n es un entero, especificando la enésima columna mostrada.
@end itemize

Notas:


@itemize *

@item 
Los valores de opciones del elemento se pueden mostrar en un orden diferente al orden en el que se almacenan.

@item 
La columna #0 siempre hace referencia a la columna del árbol, incluso si no se especifica show=»tree».
@end itemize

Un número de columna de datos es un índice en la lista de valores de opciones de un elemento; el número de columna se visualiza en el árbol donde se muestran los valores. Las etiquetas de árbol se muestran en la columna #0. Si no se establece la opción displaycolumns, la columna de datos n se muestra en la columna #n+1. Una vez más, `la columna #0 siempre hace referencia a la columna del árbol'.

@node Eventos virtuales<4>,ttk Treeview,Identificadores de columna,Treeview
@anchor{library/tkinter ttk id8}@anchor{3e31}
@subsubsection Eventos virtuales


El widget Treeview genera los siguientes eventos virtuales.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Evento

@tab

Descripción

@item

<<TreeviewSelect>>

@tab

Se genera cada vez que cambia la selección.

@item

<<TreeviewOpen>>

@tab

Generado justo antes configurar el elemento de resalto a open=True.

@item

<<TreeviewClose>>

@tab

Generado justo después de establecer el elemento de resalto a open=False.

@end multitable


Los métodos @ref{3e32,,Treeview.focus()} y @ref{b1e,,Treeview.selection()} se pueden utilizar para determinar el elemento o elementos afectados.

@node ttk Treeview,,Eventos virtuales<4>,Treeview
@anchor{library/tkinter ttk ttk-treeview}@anchor{3e33}
@subsubsection ttk.Treeview


@geindex Treeview (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Treeview}@anchor{b1f}
@deffn {Clase} tkinter.ttk.Treeview

@geindex bbox() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview bbox}@anchor{3e34}
@deffn {Método} bbox (item, column=None)

Retorna el cuadro delimitador (en relación con la ventana del widget de Treeview) del `item' especificado con el formato (x, y, ancho, alto).

Si se especifica `column', retorna el cuadro delimitador de esa celda. Si el `item' no está visible (es decir, si es descendiente de un elemento cerrado o se desplaza fuera de la pantalla), retorna una cadena vacía.
@end deffn

@geindex get_children() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview get_children}@anchor{3e35}
@deffn {Método} get_children (item=None)

Retorna la lista de elementos secundarios que pertenecen a `item'.

Si no se especifica `item', retorna la raíz.
@end deffn

@geindex set_children() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview set_children}@anchor{3e36}
@deffn {Método} set_children (item, *newchildren)

Reemplaza el elemento secundario de `item' por `newchildren'.

Los elementos secundarios presentes en `item' que no están presentes en `newchildren' se separan del árbol. Ningún elemento de `newchildren' puede ser un antecesor de `item'. Tenga en cuenta que si no se especifica `newchildren' se desasocian los elementos secundarios de `item'.
@end deffn

@geindex column() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview column}@anchor{3e37}
@deffn {Método} column (column, option=None, **kw)

Consultar o modificar las opciones para la `columna' especificada.

Si no se proporciona `kw', retorna un diccionario de los valores de opciones de columna. Si se especifica `option', se retorna el valor de esa `option'. De lo contrario, establece las opciones en los valores correspondientes.

Las opciones/valores válidos son:


@table @asis

@item `id'

Retorna el nombre de la columna. Esta es una opción de solo lectura.

@item `anchor': One of the standard Tk anchor values.

Especifica cómo se debe alinear el texto de esta columna con respecto a la celda.

@item `minwidth': width

El ancho mínimo de la columna en píxeles. El widget Treeview no hará que la columna sea más pequeña de lo especificado por esta opción cuando se cambie el tamaño del widget o el usuario arrastre una columna.

@item `stretch': @code{True}/@code{False}

Especifica si el ancho de la columna debe ajustarse cuando se cambia el tamaño del widget.

@item `width': width

El ancho de la columna en píxeles.
@end table

Se puede establecer `column = «#0»' para configurar el árbol de la columna.
@end deffn

@geindex delete() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview delete}@anchor{3e38}
@deffn {Método} delete (*items)

Elimina todos los `items' especificados y todos sus descendientes.

El elemento raíz no se elimina.
@end deffn

@geindex detach() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview detach}@anchor{3e39}
@deffn {Método} detach (*items)

Desvincula todos los `items' especificados del árbol.

Los objetos y todos sus descendientes todavía existen, y pueden ser reinsertados en otro punto del árbol, pero no se mostrarán.

El elemento raíz no se desvincula.
@end deffn

@geindex exists() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview exists}@anchor{3e3a}
@deffn {Método} exists (item)

Retorna @code{True} si el `item' especificado está presente en el árbol.
@end deffn

@geindex focus() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview focus}@anchor{3e32}
@deffn {Método} focus (item=None)

Si se especifica `item', establece el elemento de foco en `item'. De lo contrario, retorna el elemento de foco actual o “” si no hay ninguno.
@end deffn

@geindex heading() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview heading}@anchor{3e3b}
@deffn {Método} heading (column, option=None, **kw)

Consulta o modifica las opciones de encabezado para la `column' especificada.

Si no se proporciona `kw', retorna un diccionario de los valores de opciones de encabezado. Si se especifica `option', se retorna el valor de esa `option'. De lo contrario, establece las opciones en los valores correspondientes.

Las opciones/valores válidos son:


@table @asis

@item `text': text

El texto se muestra en el encabezado de la columna.

@item `image': imageName

Especifica una imagen para mostrar en la parte derecha del encabezado de la columna.

@item `anchor': anchor

Especifica el alineamiento del texto del encabezado. Es uno de los valores estándar de Tk anchor.

@item `command': callback

Una retrollamada que se ejecutará cuando se presione la etiqueta de encabezado.
@end table

Se especifica `column =»#0»' para configurar el encabezado de la columna de árbol.
@end deffn

@geindex identify() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify}@anchor{3e3c}
@deffn {Método} identify (component, x, y)

Retorna una descripción del `component' especificado bajo el punto dado por `x' e `y', o la cadena vacía si no existe dicho `component' en esa posición.
@end deffn

@geindex identify_row() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_row}@anchor{3e3d}
@deffn {Método} identify_row (y)

Retorna el identificador del elemento en la posición `y'.
@end deffn

@geindex identify_column() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_column}@anchor{3e3e}
@deffn {Método} identify_column (x)

Retorna el identificador de los datos de columna de la celda en la posición `x'.

La columna del árbol tiene ID #0.
@end deffn

@geindex identify_region() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_region}@anchor{3e3f}
@deffn {Método} identify_region (x, y)

Retorna uno de:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

zona

@tab

significado

@item

heading

@tab

Zona de encabezado del árbol.

@item

separator

@tab

Espacio entre dos encabezados de columna.

@item

tree

@tab

La zona del árbol.

@item

cell

@tab

Datos de celda.

@end multitable


Disponibilidad: Tk 8.6.
@end deffn

@geindex identify_element() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_element}@anchor{3e40}
@deffn {Método} identify_element (x, y)

Retorna el elemento en la posición `x', `y'.

Disponibilidad: Tk 8.6.
@end deffn

@geindex index() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview index}@anchor{3e41}
@deffn {Método} index (item)

Retorna el índice entero de `item' dentro de la lista de elementos secundarios de su elemento primario.
@end deffn

@geindex insert() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview insert}@anchor{3e42}
@deffn {Método} insert (parent, index, iid=None, **kw)

Crea un nuevo elemento y retorna el identificador del elemento recién creado.

`parent' es el identificador del elemento primario o la cadena vacía para crear un nuevo elemento de nivel superior. `index' es un entero, o el valor «end», especificando dónde insertar el nuevo elemento en la lista de elementos secundarios del elemento primario. Si `index' es menor o igual que cero, el nuevo nodo se inserta al principio; si `index' es mayor o igual que el número actual de elementos secundarios, se inserta al final. Si se especifica `iid', se utiliza como identificador de elemento; `iid' no debe existir en el árbol previamente. De lo contrario, se genera un nuevo identificador único.

See @ref{3e2f,,Item Options} for the list of available options.
@end deffn

@geindex item() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview item}@anchor{3e43}
@deffn {Método} item (item, option=None, **kw)

Consulta o modifica las opciones para el `item' especificado.

Si no se proporciona ninguna opción, se retorna un diccionario con opciones/valores para el elemento. Si se especifica `option', se retorna el valor de esa opción. De lo contrario, establece las opciones en los valores correspondientes según `kw'.
@end deffn

@geindex move() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview move}@anchor{3e44}
@deffn {Método} move (item, parent, index)

Mueve `item' a la posición `index' en la lista de elementos secundarios de `parent'.

No se permite mover un elemento bajo uno de sus descendientes. Si `index' es menor o igual que cero, `item' se mueve al principio; si es mayor o igual que el número de hijos, se mueve hasta el final. Si `item' se desvincula, se vuelve a conectar.
@end deffn

@geindex next() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview next}@anchor{3e45}
@deffn {Método} next (item)

Retorna el identificador del siguiente elemento de `item', o “” si `item' es el último elemento secundario de su elemento primario.
@end deffn

@geindex parent() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview parent}@anchor{3e46}
@deffn {Método} parent (item)

Retorna el identificador del elemento primario de `item' o “” si `item' está en el nivel superior de la jerarquía.
@end deffn

@geindex prev() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview prev}@anchor{3e47}
@deffn {Método} prev (item)

Retorna el identificador del elemento anterior de `item', o “” si `item' es el primer elemento secundario de su elemento primario.
@end deffn

@geindex reattach() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview reattach}@anchor{3e48}
@deffn {Método} reattach (item, parent, index)

Un alias para @ref{3e44,,Treeview.move()}.
@end deffn

@geindex see() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview see}@anchor{3e49}
@deffn {Método} see (item)

Garantiza que `item' está visible.

Establece todas las opciones modificables de los antecesores de `item' a @code{True} y desplaza el widget si es necesario para que `item' esté dentro de la parte visible del árbol.
@end deffn

@geindex selection() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection}@anchor{b1e}
@deffn {Método} selection ()

Retorna una tupla de los elementos seleccionados.


Distinto en la versión 3.8: @code{selection()} ya no toma argumentos. Para cambiar el estado de selección, utiliza los siguientes métodos de selección.

@end deffn

@geindex selection_set() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_set}@anchor{b20}
@deffn {Método} selection_set (*items)

`items' se convierte en la nueva selección.


Distinto en la versión 3.6: `items' se pueden pasar como argumentos separados, no solo como una sola tupla.

@end deffn

@geindex selection_add() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_add}@anchor{3e4a}
@deffn {Método} selection_add (*items)

Añade `items' a la selección.


Distinto en la versión 3.6: `items' se pueden pasar como argumentos separados, no solo como una sola tupla.

@end deffn

@geindex selection_remove() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_remove}@anchor{3e4b}
@deffn {Método} selection_remove (*items)

Elimina `elementos' de la selección.


Distinto en la versión 3.6: `items' se pueden pasar como argumentos separados, no solo como una sola tupla.

@end deffn

@geindex selection_toggle() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_toggle}@anchor{3e4c}
@deffn {Método} selection_toggle (*items)

Alterna el estado de selección de cada elemento en `items'.


Distinto en la versión 3.6: `items' se pueden pasar como argumentos separados, no solo como una sola tupla.

@end deffn

@geindex set() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview set}@anchor{3e4d}
@deffn {Método} set (item, column=None, value=None)

Con un argumento, retorna un diccionario de pares columna/valor para el `item' especificado. Con dos argumentos, retorna el valor actual de la `columna' especificada. Con tres argumentos, establece el valor de determinado `column' en un `item' determinado en el `value' especificado.
@end deffn

@geindex tag_bind() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_bind}@anchor{3e4e}
@deffn {Método} tag_bind (tagname, sequence=None, callback=None)

Enlaza una retrollamada para el evento `sequence' a la etiqueta `tagname'. Cuando se entrega un evento a un elemento, se llama a las retrollamadas de cada una de las etiquetas del elemento.
@end deffn

@geindex tag_configure() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_configure}@anchor{3e4f}
@deffn {Método} tag_configure (tagname, option=None, **kw)

Consulta o modifica las opciones para el `tagname' especificado.

Si no se proporciona `kw', retorna un diccionario de la configuración de opciones para `tagname'. Si se especifica `option', retorna el valor de esa `option' para el `tagname' especificado. De lo contrario, establece las opciones en los valores correspondientes para el `tagname' dado.
@end deffn

@geindex tag_has() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_has}@anchor{3e50}
@deffn {Método} tag_has (tagname, item=None)

Si se especifica `item', retorna 1 o 0 dependiendo de si el `item' tiene el `tagname' especificado. De lo contrario, retorna una lista de todos los elementos que tienen la etiqueta especificada.

Disponibilidad: Tk 8.6
@end deffn

@geindex xview() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview xview}@anchor{3e2c}
@deffn {Método} xview (*args)

Consulta o modifica la posición horizontal de la vista de árbol.
@end deffn

@geindex yview() (método de tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview yview}@anchor{3e2d}
@deffn {Método} yview (*args)

Consulta o modifica la posición vertical de la vista de árbol.
@end deffn
@end deffn

@node Ttk Styling,,Treeview,tkinter ttk — Tk themed widgets
@anchor{library/tkinter ttk ttk-styling}@anchor{3e51}@anchor{library/tkinter ttk ttkstyling}@anchor{3df7}
@subsubsection Ttk Styling


A cada widget en @code{ttk} se le asigna un estilo, que especifica el conjunto de elementos que componen el widget y cómo se organizan, junto con la configuración dinámica y predeterminada para las opciones de elemento. De forma predeterminada, el nombre del estilo es el mismo que el nombre de clase del widget, pero puede ser reemplazado por la opción de estilo del widget. Si no conoces el nombre de clase de un widget, utiliza el método @code{Misc.winfo_class()} (somewidget.winfo_class()).


@subsubheading Ver también



@table @asis

@item Presentación de la conferencia Tcl'2004@footnote{http://tktable.sourceforge.net/tile/tile-tcl2004.pdf}

Este documento explica cómo funciona el motor de temas
@end table


@geindex Style (clase en tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Style}@anchor{3b0}
@deffn {Clase} tkinter.ttk.Style

Esta clase se utiliza para manipular la base de datos de estilos.

@geindex configure() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style configure}@anchor{3e52}
@deffn {Método} configure (style, query_opt=None, **kw)

Consulta o establece el valor predeterminado de las opciones especificadas en `style'.

Cada clave en `kw' es una opción y cada valor es una cadena que identifica el valor de esa opción.

Por ejemplo, para cambiar cualquier botón por defecto a un botón plano con borde interno y un color de fondo distinto:

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

ttk.Style().configure("TButton", padding=6, relief="flat",
   background="#ccc")

btn = ttk.Button(text="Sample")
btn.pack()

root.mainloop()
@end example
@end deffn

@geindex map() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style map}@anchor{1927}
@deffn {Método} map (style, query_opt=None, **kw)

Consulta o establece valores dinámicos de opciones específicas en `style'.

Cada clave en `kw' es una opción y cada valor es una lista o tupla (generalmente) que contiene `statespecs' agrupados en tuplas, listas o alguna otra preferencia. Una `statespec' es un compuesto de uno o más estados y un valor.

Un ejemplo puede hacerlo más comprensible:

@example
import tkinter
from tkinter import ttk

root = tkinter.Tk()

style = ttk.Style()
style.map("C.TButton",
    foreground=[('pressed', 'red'), ('active', 'blue')],
    background=[('pressed', '!disabled', 'black'), ('active', 'white')]
    )

colored_btn = ttk.Button(text="Test", style="C.TButton").pack()

root.mainloop()
@end example

Ten en cuenta que el orden de las secuencias (estado, valor) para una opción es importante, si se cambia el orden a @code{[('active', 'blue'), ('pressed', 'red')]} en la opción en primer plano, por ejemplo, el resultado sería un primer plano azul cuando el widget se encuentre en los estados `active' o `pressed'.
@end deffn

@geindex lookup() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style lookup}@anchor{3e53}
@deffn {Método} lookup (style, option, state=None, default=None)

Retorna el valor especificado para `option' en `style'.

Si `state' se especifica, se espera que sea una secuencia de uno o más estados. Si se establece el argumento `default', se usa como valor de reserva en caso de que no se especifique una opción.

Para verificar qué fuente usa un Button por defecto:

@example
from tkinter import ttk

print(ttk.Style().lookup("TButton", "font"))
@end example
@end deffn

@geindex layout() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style layout}@anchor{3e54}
@deffn {Método} layout (style, layoutspec=None)

Define el diseño del widget para un `estilo' dado. Si se omite `layoutspec', retorna la especificación de diseño para un estilo determinado.

`layoutspec', si se especifica, se espera que sea una lista o algún otro tipo de secuencia (excluyendo cadenas), donde cada elemento debe ser una tupla y el primer elemento es el nombre de diseño y el segundo elemento debe tener el formato descrito en @ref{3e55,,Layouts}.

Para entender el formato, consulta el siguiente ejemplo (no está pensado para hacer nada útil):

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.layout("TMenubutton", [
   ("Menubutton.background", None),
   ("Menubutton.button", @{"children":
       [("Menubutton.focus", @{"children":
           [("Menubutton.padding", @{"children":
               [("Menubutton.label", @{"side": "left", "expand": 1@})]
           @})]
       @})]
   @}),
])

mbtn = ttk.Menubutton(text='Text')
mbtn.pack()
root.mainloop()
@end example
@end deffn

@geindex element_create() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_create}@anchor{3af}
@deffn {Método} element_create (elementname, etype, *args, **kw)

Create a new element in the current theme, of the given `etype' which is
expected to be either «image», «from» or «vsapi».
The latter is only available in Tk 8.6 on Windows.

Si se utiliza «image», `args' debe contener el nombre de imagen predeterminado seguido de pares statespec/value (esta es imagespec), y `kw' puede tener las siguientes opciones:


@table @asis

@item border=padding

el relleno interno es una lista de hasta cuatro enteros, especificando los bordes izquierdo, superior, derecho e inferior, respectivamente.

@item height=height

Especifica una altura mínima para el elemento. Si es menor que cero, la altura de la imagen base se utiliza como valor predeterminado.

@item padding=padding

Especifica el relleno interior del elemento. El valor predeterminado es el valor del borde si no se especifica.

@item sticky=spec

Especifica cómo se coloca la imagen dentro de la sección. `spec' contiene cero o más caracteres «n», «s», «w» o «e».

@item width=width

Especifica un ancho mínimo para el elemento. Si es menor que cero, el ancho de la imagen base se utiliza como valor predeterminado.
@end table

Example:

@example
img1 = tkinter.PhotoImage(master=root, file='button.png')
img1 = tkinter.PhotoImage(master=root, file='button-pressed.png')
img1 = tkinter.PhotoImage(master=root, file='button-active.png')
style = ttk.Style(root)
style.element_create('Button.button', 'image',
                     img1, ('pressed', img2), ('active', img3),
                     border=(2, 4), sticky='we')
@end example

Si se utiliza «from» como valor de `etype', @ref{3af,,element_create()} clonará un elemento existente. `args' contiene un themename, desde el que se clonará el elemento y, opcionalmente, un elemento desde el que clonar. Si no se especifica este elemento para clonar, se usará un elemento vacío. `kw' se descarta.

Example:

@example
style = ttk.Style(root)
style.element_create('plain.background', 'from', 'default')
@end example

If «vsapi» is used as the value of `etype', @ref{3af,,element_create()}
will create a new element in the current theme whose visual appearance
is drawn using the Microsoft Visual Styles API which is responsible
for the themed styles on Windows XP and Vista.
`args' is expected to contain the Visual Styles class and part as
given in the Microsoft documentation followed by an optional sequence
of tuples of ttk states and the corresponding Visual Styles API state
value.
`kw' may have the following options:


@table @asis

@item padding=padding

Specify the element’s interior padding.
`padding' is a list of up to four integers specifying the left,
top, right and bottom padding quantities respectively.
If fewer than four elements are specified, bottom defaults to top,
right defaults to left, and top defaults to left.
In other words, a list of three numbers specify the left, vertical,
and right padding; a list of two numbers specify the horizontal
and the vertical padding; a single number specifies the same
padding all the way around the widget.
This option may not be mixed with any other options.

@item margins=padding

Specifies the elements exterior padding.
`padding' is a list of up to four integers specifying the left, top,
right and bottom padding quantities respectively.
This option may not be mixed with any other options.

@item width=width

Specifies the width for the element.
If this option is set then the Visual Styles API will not be queried
for the recommended size or the part.
If this option is set then `height' should also be set.
The `width' and `height' options cannot be mixed with the `padding'
or `margins' options.

@item height=height

Specifies the height of the element.
See the comments for `width'.
@end table

Example:

@example
style = ttk.Style(root)
style.element_create('pin', 'vsapi', 'EXPLORERBAR', 3, [
                     ('pressed', '!selected', 3),
                     ('active', '!selected', 2),
                     ('pressed', 'selected', 6),
                     ('active', 'selected', 5),
                     ('selected', 4),
                     ('@w{'}, 1)])
style.layout('Explorer.Pin',
             [('Explorer.Pin.pin', @{'sticky': 'news'@})])
pin = ttk.Checkbutton(style='Explorer.Pin')
pin.pack(expand=True, fill='both')
@end example


Distinto en la versión 3.13: Added support of the «vsapi» element factory.

@end deffn

@geindex element_names() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_names}@anchor{3e56}
@deffn {Método} element_names ()

Retorna la lista de elementos definidos en le tema actual.
@end deffn

@geindex element_options() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_options}@anchor{3e57}
@deffn {Método} element_options (elementname)

Retorna la lista de opciones de `elementname'.
@end deffn

@geindex theme_create() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_create}@anchor{3e58}
@deffn {Método} theme_create (themename, parent=None, settings=None)

Crea un tema nuevo.

Es un error si `themename' ya existe. Si se especifica `parent', el nuevo tema heredará estilos, elementos y diseños del tema primario. Si se especifica `settings', se espera que tengan la misma sintaxis utilizada para @ref{3e59,,theme_settings()}.
@end deffn

@geindex theme_settings() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_settings}@anchor{3e59}
@deffn {Método} theme_settings (themename, settings)

Establece temporalmente el tema actual en `themename', aplica los `settings' especificados y, a continuación, restaura el tema anterior.

Cada clave en `settings' es un estilo y cada valor puede contener las teclas “configure”, “map”, “layout” y “element create” y se espera que tengan el mismo formato especificado por los métodos @ref{3e52,,Style.configure()}, @ref{1927,,Style.map()}, @ref{3e54,,Style.layout()} y @ref{3af,,Style.element_create()} respectivamente.

Como ejemplo, vamos a cambiar un poco el Combobox por el tema predeterminado:

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.theme_settings("default", @{
   "TCombobox": @{
       "configure": @{"padding": 5@},
       "map": @{
           "background": [("active", "green2"),
                          ("!disabled", "green4")],
           "fieldbackground": [("!disabled", "green3")],
           "foreground": [("focus", "OliveDrab1"),
                          ("!disabled", "OliveDrab2")]
       @}
   @}
@})

combo = ttk.Combobox().pack()

root.mainloop()
@end example
@end deffn

@geindex theme_names() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_names}@anchor{3e5a}
@deffn {Método} theme_names ()

Retorna una lista de temas conocidos.
@end deffn

@geindex theme_use() (método de tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_use}@anchor{3e5b}
@deffn {Método} theme_use (themename=None)

Si no se proporciona `themename', retorna el tema en uso. De lo contrario, establece el tema actual en `themename', actualiza todos los widgets y emite un evento <<ThemeChanged>>.
@end deffn
@end deffn

@menu
* Diseños:: 

@end menu

@node Diseños,,,Ttk Styling
@anchor{library/tkinter ttk layouts}@anchor{3e55}
@subsubsection Diseños


A layout can be just @code{None}, if it takes no options, or a dict of
options specifying how to arrange the element. The layout mechanism
uses a simplified version of the pack geometry manager: given an
initial cavity, each element is allocated a parcel.

Las opciones/valores válidos son:


@table @asis

@item `side': whichside

Especifica en qué lado de la cavidad colocar el elemento; sea arriba, derecha, abajo o izquierda. Si se omite, el elemento ocupa toda la cavidad.

@item `sticky': nswe

Especifica dónde se coloca el elemento dentro de su sección asignada.

@item `unit': 0 or 1

Si se establece en 1, hace que el elemento y todos sus descendientes sean tratados como un único elemento en métodos como @ref{3e00,,Widget.identify()} y otros. Se utiliza para cosas como los `thumbs' de la barra de desplazamiento.

@item `children': [sublayout… ]

Especifica una lista de elementos para colocar dentro del elemento. Cada elemento es una tupla (u otro tipo de secuencia) donde el primer elemento es el nombre de diseño y el otro es un @ref{3e55,,Layout}.
@end table
@anchor{library/tkinter ttk layout}@anchor{3e5c}
@node IDLE<60>,,tkinter ttk — Tk themed widgets,Interfaces gráficas de usuario con Tk
@anchor{library/idle doc}@anchor{3e5d}@anchor{library/idle id1}@anchor{3e5e}@anchor{library/idle idle}@anchor{1091}
@subsection IDLE


`Código fuente:' Lib/idlelib/@footnote{https://github.com/python/cpython/tree/main/Lib/idlelib/}

@geindex IDLE
@geindex Python Editor
@geindex Integrated Development Environment


__________________________________________________________________


IDLE es el entorno de desarrollo integrado de Python.

IDLE tiene las siguientes características:


@itemize *

@item 
multiplataforma: funciona en su mayoría igual en Windows, Unix y macOS

@item 
La ventana del shell de Python (interprete interactivo) con coloreado de código de entrada, salida y mensajes de error

@item 
editor de texto multiventana con deshacer múltiple, coloreación Python, indentado inteligente, sugerencias de llamadas a funciones, autocompletado y otras características

@item 
búsqueda dentro de cualquier ventana, reemplazo dentro de las ventanas del editor, y búsqueda a través de múltiples archivos (grep)

@item 
depurador con breakpoints persistentes, por pasos y visualización de espacios de nombres globales y locales

@item 
configuración, navegadores y otros cuadros de diálogo
@end itemize

@menu
* Menús:: 
* Edición y navegación:: 
* Inicio y ejecución de código:: 
* Ayuda y preferencias:: 
* idlelib:: 

@end menu

@node Menús,Edición y navegación,,IDLE<60>
@anchor{library/idle menus}@anchor{3e5f}
@subsubsection Menús


IDLE tiene dos tipos de ventana principales, la ventana del shell y la ventana del editor.  Es posible tener múltiples ventanas de edición simultáneamente.  En Windows y Linux, cada una tiene su propio menú principal.  Cada menú documentado abajo indica con cuál tipo de ventana está asociada esta.

Las ventanas de salida, como las que se usan para Editar => Encontrar en archivos, son un subtipo de la ventana de edición.  Actualmente tienen el mismo menú principal pero un título predeterminado y un menú contextual diferente.

En macOS, hay un menú de aplicación.  Este cambia dinámicamente de acuerdo la ventana actualmente seleccionada.  Tiene un menú IDLE y algunas de las entradas descritas a continuación se mueven de acuerdo con las pautas de Apple.

@menu
* Menú de archivo (Shell y Editor): Menú de archivo Shell y Editor. 
* Menú editar (Shell y Editor): Menú editar Shell y Editor. 
* Menú de formato (solo ventana del Editor): Menú de formato solo ventana del Editor. 
* Menú ejecutar (solo ventana Editor): Menú ejecutar solo ventana Editor. 
* Menú de shell (solo ventana de shell): Menú de shell solo ventana de shell. 
* Menú de depuración (solo ventana de shell): Menú de depuración solo ventana de shell. 
* Menú de opciones (Shell y editor): Menú de opciones Shell y editor. 
* Menú de ventana (shell y editor): Menú de ventana shell y editor. 
* Menú de ayuda (shell y editor): Menú de ayuda shell y editor. 
* Menús contextuales:: 

@end menu

@node Menú de archivo Shell y Editor,Menú editar Shell y Editor,,Menús
@anchor{library/idle file-menu-shell-and-editor}@anchor{3e60}
@subsubsection Menú de archivo (Shell y Editor)



@table @asis

@item Nuevo archivo

Crea una nueva ventana de edición de archivos.

@item Abrir…

Abre un archivo existente con un cuadro de dialogo para abrir.

@item Abrir módulo…

Abre un módulo existente (buscar en sys.path).

@item Archivos recientes

Abre una lista de archivos recientes.  Haga click en alguno para abrirlo.
@end table

@geindex Module browser
@geindex Path browser


@table @asis

@item Navegador de módulo

Muestra las funciones, clases y métodos en estructura de árbol en el archivo actual del Editor.  En el shell, primero abra un módulo.

@item Navegador de ruta

Muestra directorios, módulos, funciones, clases y métodos de sys.path en una estructura de árbol.

@item Guardar

Guarda la ventana actual en el archivo asociado, si existe alguno.  Las ventanas que han sido modificadas desde que se abrieron o se guardaron por última vez tienen un * antes y después del título de la ventana.  Si no hay un archivo asociado, ejecute Guardar como en su lugar.

@item Guardar como…

Guarda la ventana actual con el cuadro de diálogo Guardar como. El archivo guardado se convierte en un archivo nuevo asociado para la ventana. (Si su administrador de nombres está configurado para ocultar extensiones, la extensión actual se omitirá en el cuadro de nombre de archivo. Si el nombre de archivo nuevo no tiene “.”, se agregarán “.py” y “.txt” para Python y los archivos de texto, excepto que en macOS Aqua se agregará “.py” para todos los archivos.)

@item Guardar copia como…

Guarda la ventana actual en un archivo diferente sin cambiar el archivo asociado. (Consultar la nota anterior Guardar como sobre las extensiones de nombre de archivo.)

@item Imprimir ventana

Imprime la ventana actual en la impresora predeterminada.

@item Cerrar ventana

Cierra la ventana actual (si es un editor no guardado, solicita guardar; si es un Shell no guardado, solicita salir de la ejecución). Llamar a @code{exit()} o @code{close()} en la ventana de Shell también cierra el Shell. Si esta es la única ventana, también sale del IDLE.

@item Salir del IDLE

Cierra todas las ventanas y sale del IDLE (solicita guardar ventanas de edición no guardadas).
@end table

@node Menú editar Shell y Editor,Menú de formato solo ventana del Editor,Menú de archivo Shell y Editor,Menús
@anchor{library/idle edit-menu-shell-and-editor}@anchor{3e61}
@subsubsection Menú editar (Shell y Editor)



@table @asis

@item Deshacer

Deshace el último cambio a la ventana actual.  Se puede deshacer un máximo de 1000 cambios.

@item Rehacer

Vuelve a aplicar el último cambio deshecho a la ventana actual.

@item Seleccionar todo

Selecciona el contenido completo de la ventana actual.

@item Cortar

Copia la selección en el portapapeles global; después elimina la selección.

@item Copiar

Copia la selección en el portapapeles global.

@item Pegar

Inserta el contenido del portapapeles global en la ventana actual.
@end table

Las funciones del portapapeles también están disponibles en los menús contextuales.


@table @asis

@item Encontrar…

Abre un cuadro de diálogo de búsqueda con muchas opciones

@item Buscar de nuevo

Repite la última búsqueda, si hay alguna.

@item Encontrar selección

Busca la cadena de caracteres seleccionada actualmente, si hay alguna.

@item Encontrar en Archivos…

Abre un cuadro de diálogo de búsqueda de archivos.  Presenta los resultados en una nueva ventana de salida.

@item Reemplazar…

Abre un cuadro de diálogo de búsqueda y reemplazo.

@item Ir a la línea

Mueve el cursor al inicio de la línea solicitada y hace que esa línea sea visible.  Una solicitud a partir del final del archivo lo lleva al final. Borra cualquier selección y actualiza el estado de la línea y la columna.

@item Mostrar complementos

Abre una lista navegable que permite la selección de valores existentes. Consultar @ref{3e62,,Terminaciones} en la sección Edición y Navegación a continuación.

@item Expandir palabra

Completa un prefijo que se ha escrito para que coincida con una palabra completa en la misma ventana; intente nuevamente para obtener un complemento diferente.

@item Mostrar sugerencias de llamada

Después de un paréntesis abierto para una función, abre una pequeña ventana con sugerencias sobre parámetros de función. Consultar @ref{3e63,,Sugerencias de llamada} en la sección Edición y navegación a continuación.

@item Mostrar los paréntesis alrededor

Resalta los paréntesis.
@end table

@node Menú de formato solo ventana del Editor,Menú ejecutar solo ventana Editor,Menú editar Shell y Editor,Menús
@anchor{library/idle format-menu}@anchor{3e64}@anchor{library/idle format-menu-editor-window-only}@anchor{3e65}
@subsubsection Menú de formato (solo ventana del Editor)



@table @asis

@item Formatear párrafo

Reformatea el párrafo actual delimitado por líneas en blanco en un bloque de comentarios o una cadena de caracteres multilínea o una línea seleccionada en una cadena de caracteres.  Todas las líneas en el párrafo estarán formateadas con menos de N columnas, donde N por defecto es 72.

@item Zona de indentación

Desplaza las líneas seleccionadas a la derecha en un nivel de indentación (por defecto 4 espacios).

@item Zona de deindentación

Desplaza las líneas seleccionadas hacia la izquierda en un nivel de indentación (por defecto 4 espacios).

@item Zona comentada

Inserta ## delante de las líneas seleccionadas.

@item Zona descomentada

Elimina los # o ## al inicio de las líneas seleccionadas.

@item Zona tabulada

Transforma los tramos de espacios `iniciales' en tabs. (Nota: Recomendamos usar 4 bloques de espacio para indentar el código de Python).

@item Zona destabulada

Transforma `todos' los tabs en el número correcto de espacios.

@item Alternar tabs

Abre un cuadro de diálogo para cambiar entre indentado con espacios y tabs.

@item Nuevo tamaño de indentación

Abre un cuadro de diálogo para cambiar el tamaño de indentación. El valor predeterminado aceptado por la comunidad de Python es de 4 espacios.

@item Remover espacios en blanco al final

Elimina el espacio final en la línea y otros caracteres de espacio en blanco después del último carácter que no sea un espacio en blanco aplicando str.rstrip a cada línea, incluyendo las líneas dentro de cadenas de caracteres multilíneas.  Excepto para las ventanas de consola, elimina nuevas líneas adicionales al final del archivo.
@end table

@geindex Run script

@node Menú ejecutar solo ventana Editor,Menú de shell solo ventana de shell,Menú de formato solo ventana del Editor,Menús
@anchor{library/idle run-menu-editor-window-only}@anchor{3e66}
@subsubsection Menú ejecutar (solo ventana Editor)

@anchor{library/idle run-module}@anchor{3e67}

@table @asis

@item Módulo ejecutar

Hace lo que dice en @ref{3e68,,Verificar módulo}.  Si no hay errores, reinicia el shell para limpiar el entorno, luego ejecuta el módulo.  La salida es mostrada en la ventana de shell.  Tener en cuenta que la visualización requiere el uso de @code{print} o @code{write}. Cuando finaliza la ejecución, el shell permanece activo y muestra un mensaje. En este punto, se puede explorar interactivamente el resultado de la ejecución. Esto es similar a ejecutar un archivo con @code{python -i file} en una línea de comando.
@end table
@anchor{library/idle run-custom}@anchor{3e69}

@table @asis

@item Ejecutar… Personalizado

Igual que @ref{3e67,,Módulo ejecutar}, pero ejecuta el módulo con parámetros personalizados.  `Los argumentos de la línea de comandos' extienden @ref{12d2,,sys.argv} como si se pasaran por una línea de comando. El módulo se puede ejecutar en el shell sin reiniciar.
@end table
@anchor{library/idle check-module}@anchor{3e68}

@table @asis

@item Verificar módulo

Comprueba la sintaxis del módulo actualmente abierto en la ventana de edición. Si el módulo no ha sido guardado IDLE solicitará al usuario que guarde o guarde automáticamente, como se seleccionó en la pestaña General del cuadro de diálogo Configuración de inactividad.  Si hay algún error de sintaxis, la ubicación aproximada será indicada en la ventana del Editor.
@end table
@anchor{library/idle python-shell}@anchor{3e6a}

@table @asis

@item Shell de Python

Abrir o activar la ventana del shell de Python.
@end table

@node Menú de shell solo ventana de shell,Menú de depuración solo ventana de shell,Menú ejecutar solo ventana Editor,Menús
@anchor{library/idle shell-menu-shell-window-only}@anchor{3e6b}
@subsubsection Menú de shell (solo ventana de shell)



@table @asis

@item Ver el último reinicio

Navega la ventana del shell hasta el último reinicio del mismo.

@item Reiniciar shell

Reinicia el shell para limpiar el entorno.

@item Historial anterior

Recorre los comandos anteriores en el historial que coinciden con la entrada actual.

@item Historial siguiente

Recorre los comandos posteriores en el historial que coinciden con la entrada actual.

@item Ejecución de interrupción

Detiene un programa en ejecución.
@end table

@node Menú de depuración solo ventana de shell,Menú de opciones Shell y editor,Menú de shell solo ventana de shell,Menús
@anchor{library/idle debug-menu-shell-window-only}@anchor{3e6c}
@subsubsection Menú de depuración (solo ventana de shell)



@table @asis

@item Ir al Archivo/Línea

Busca en la línea actual, con el cursor y la línea de arriba para un nombre de archivo y número de línea.  Si lo encuentra, abre el archivo si aún no está abierto y muestra la línea.  Usa esto para ver las líneas de origen referenciadas en un rastreo de excepción y las líneas encontradas por Buscar en archivos. También disponible en el menú contextual de la ventana del shell y las ventanas de salida.
@end table

@geindex debugger
@geindex stack viewer


@table @asis

@item Depurador (alternar)

Cuando esta función está habilitada, el código ingresado en el shell o ejecutado desde el editor se ejecutará con el depurador.  En el editor, los breakpoints se pueden establecer con el menú contextual.  Esta funcionalidad aún está incompleta y es en cierto modo experimental.

@item Visualizador de pila

Muestra el seguimiento de la pila de la última excepción en un complemento de árbol, con acceso a locales y globales.

@item Auto-abrir visualizador de pila

Activa/desactiva automáticamente el visualizador de pila en una excepción no controlada.
@end table

@node Menú de opciones Shell y editor,Menú de ventana shell y editor,Menú de depuración solo ventana de shell,Menús
@anchor{library/idle options-menu-shell-and-editor}@anchor{3e6d}
@subsubsection Menú de opciones (Shell y editor)



@table @asis

@item Configurar IDLE

Abre un cuadro de diálogo de configuración y cambia las preferencias por lo siguiente: fuentes, indentación, combinaciones de teclas, temas de color de texto, ventanas y tamaño de inicio, fuentes de ayuda adicionales y extensiones.  En macOS, abre el cuadro de diálogo de configuración seleccionando Preferencias en el menú de la aplicación. Para obtener más detalles, consultar @ref{3e6e,,Configurar preferencias} en Ayuda y preferencias.
@end table

La mayoría de los ajustes de configuración se aplican a todas las ventanas, abiertas o no. Los siguientes elementos de opción se aplican solo a la ventana activa.


@table @asis

@item Mostrar/Ocultar el contexto del código (solo ventana del Editor)

Abre un panel en la parte superior de la ventana de edición el cual muestra el contexto de bloque de código que se ha desplazado sobre la parte superior de la ventana.  Consultar @ref{3e6f,,Contexto de código} en la sección Edición y Navegación a continuación.

@item Mostrar/Ocultar números de línea (solo ventana del Editor)

Abre una columna a la izquierda de la ventana de edición que muestra el número de cada línea de texto.  El valor por defecto de esta característica es desactivado, este puede modificarse en las preferencias (consultar @ref{3e6e,,Configuración de preferencias}).

@item Ampliar/Restaurar altura

Alterna la ventana entre el tamaño normal y la altura máxima. El tamaño inicial predeterminado es 40 líneas por 80 caracteres a menos que se cambie en la pestaña General del cuadro de diálogo Configurar IDLE.  La altura máxima para una pantalla es determinada maximizando momentáneamente una ventana la primera vez que se acerca la pantalla. Cambiar la configuración de la pantalla puede invalidar la altura guardada.  Este alternado no tiene efecto cuando se maximiza una ventana.
@end table

@node Menú de ventana shell y editor,Menú de ayuda shell y editor,Menú de opciones Shell y editor,Menús
@anchor{library/idle window-menu-shell-and-editor}@anchor{3e70}
@subsubsection Menú de ventana (shell y editor)


Enumera los nombres de todas las ventanas abiertas; seleccione uno para ponerlo en primer plano (deiconificándolo si es necesario).

@node Menú de ayuda shell y editor,Menús contextuales,Menú de ventana shell y editor,Menús
@anchor{library/idle help-menu-shell-and-editor}@anchor{3e71}
@subsubsection Menú de ayuda (shell y editor)



@table @asis

@item Acerca de IDLE

Muestra la versión, derechos de autor, licencia, créditos y más.

@item Ayuda de IDLE

Muestra este documento IDLE, que detalla las opciones del menú, edición y navegación básica y otros consejos.

@item Documentación de Python

Accede a la documentación local de Python, si está instalada, o inicia un navegador web y abre docs.python.org mostrando la última documentación de Python.

@item Demostración Turtle

Ejecuta el módulo turtledemo con ejemplos de código Python y dibujos de tortugas.
@end table

Se pueden agregar fuentes de ayuda adicionales aquí con el cuadro de diálogo Configurar IDLE en la pestaña General. Consultar la subsección @ref{3e72,,Fuentes de ayuda} a continuación para obtener más información sobre las opciones del menú Ayuda.

@geindex Cortar
@geindex Copiar
@geindex Pegar
@geindex Establecer breakpoint
@geindex Eliminar breakpoint
@geindex breakpoints

@node Menús contextuales,,Menú de ayuda shell y editor,Menús
@anchor{library/idle context-menus}@anchor{3e73}
@subsubsection Menús contextuales


Se abre un menú contextual haciendo click derecho en una ventana (Control-click en macOS). Los menús contextuales tienen las funciones estándar del portapapeles también en el menú Editar.


@table @asis

@item Cortar

Copia la selección en el portapapeles global; después elimina la selección.

@item Copiar

Copia la selección en el portapapeles global.

@item Pegar

Inserta el contenido del portapapeles global en la ventana actual.
@end table

Las ventanas del editor también tienen funciones de breakpoint.  Las líneas con un conjunto de breakpoints están especialmente marcadas.  Los breakpoints solo tienen efecto cuando se ejecutan bajo el depurador.  Los breakpoints para un archivo se guardan en el directorio @code{.idlerc} del usuario.


@table @asis

@item Establecer breakpoint

Establecer un breakpoint en la línea actual.

@item Eliminar breakpoint

Eliminar el breakpoint en esa línea.
@end table

Las ventanas de shell y de salida también tienen los siguientes elementos.


@table @asis

@item Ir a archivo/línea

Hace lo mismo que el menú depurar.
@end table

La ventana de shell también tiene una función de `squeezing' de salida explicada en la subsección `ventana de shell de Python' a continuación.


@table @asis

@item Exprimir

Si el cursor está sobre una línea de salida, comprime toda la salida entre el código de arriba y el mensaje de abajo hasta la etiqueta “Texto `squeezed'”.
@end table

@node Edición y navegación,Inicio y ejecución de código,Menús,IDLE<60>
@anchor{library/idle editing-and-navigation}@anchor{3e74}@anchor{library/idle id2}@anchor{3e75}
@subsubsection Edición y navegación


@menu
* Ventana del editor:: 
* Atajos de teclado:: 
* Indentación automática:: 
* Buscar y reemplazar:: 
* Terminaciones:: 
* Sugerencias de llamada:: 
* Contexto del código:: 
* Ventana de Shell:: 
* Colores del texto:: 

@end menu

@node Ventana del editor,Atajos de teclado,,Edición y navegación
@anchor{library/idle editor-windows}@anchor{3e76}
@subsubsection Ventana del editor


IDLE puede abrir ventanas del editor cuando se inicia, dependiendo de la configuración y de cómo inicies el IDLE.  A partir de ahí, usar el menú Archivo.  Solo puede haber una ventana de editor abierta para un archivo determinado.

La barra de título contiene el nombre del archivo, la ruta completa y la versión de Python e IDLE que ejecuta la ventana.  La barra de estado contiene el número de línea (“Ln”) y el número de columna (“Col”).  Los números de línea comienzan con 1; los números de columna con 0.

El IDLE supone que los archivos con una extensión .py* conocida contienen código Python y que los otros archivos no. Ejecuta el código Python con el menú Ejecutar.

@node Atajos de teclado,Indentación automática,Ventana del editor,Edición y navegación
@anchor{library/idle key-bindings}@anchor{3e77}
@subsubsection Atajos de teclado


The IDLE insertion cursor is a thin vertical bar between character
positions.  When characters are entered, the insertion cursor and
everything to its right moves right one character and
the new character is entered in the new space.

Several non-character keys move the cursor and possibly
delete characters.  Deletion does not puts text on the clipboard,
but IDLE has an undo list.  Wherever this doc discusses keys,
“C” refers to the @code{Control} key on Windows and
Unix and the @code{Command} key on macOS.  (And all such discussions
assume that the keys have not been re-bound to something else.)


@itemize *

@item 
Arrow keys move the cursor one character or line.

@item 
@code{C-LeftArrow} and @code{C-RightArrow} moves left or right one word.

@item 
@code{Home} and @code{End} go to the beginning or end of the line.

@item 
@code{Page Up} and @code{Page Down} go up or down one screen.

@item 
@code{C-Home} and @code{C-End} go to beginning or end of the file.

@item 
@code{Backspace} and @code{Del} (or @code{C-d}) delete the previous
or next character.

@item 
@code{C-Backspace} and @code{C-Del} delete one word left or right.

@item 
@code{C-k} deletes (“kills”) everything to the right.
@end itemize

Las combinaciones de teclas estándar (como @code{C-c} para copiar y @code{C-v} para pegar) pueden funcionar. Las combinaciones de teclas se seleccionan en el cuadro de diálogo Configurar IDLE.

@node Indentación automática,Buscar y reemplazar,Atajos de teclado,Edición y navegación
@anchor{library/idle automatic-indentation}@anchor{3e78}
@subsubsection Indentación automática


Después de una declaración de apertura de bloque, la siguiente línea está indentada por 4 espacios (en la ventana del shell de Python por un tab).  Después de ciertas palabras clave (saltar, retornar, etc.), la siguiente línea se deindenta.  En la indentación principal, @code{Backspace} elimina hasta 4 espacios si están allí. @code{Tab} inserta espacios (en la ventana del shell de Python un tab), el número depende del tamaño de la indentación. Actualmente, los tabs están restringidos a cuatro espacios debido a las limitaciones de Tcl/Tk.

Consulte también los comandos de zona de indexación/deindentación en @ref{3e64,,Menú de formato}.

@node Buscar y reemplazar,Terminaciones,Indentación automática,Edición y navegación
@anchor{library/idle search-and-replace}@anchor{3e79}
@subsubsection Buscar y reemplazar


Cualquier selección se convierte en un objetivo de búsqueda. Sin embargo, solo funcionan las selecciones dentro de una línea porque las búsquedas solo se realizan dentro de las líneas con la nueva línea de terminal eliminada. Si se marca la @code{[x] Expresión regular}, el objetivo se interpreta de acuerdo al módulo @cite{re} de Python.

@node Terminaciones,Sugerencias de llamada,Buscar y reemplazar,Edición y navegación
@anchor{library/idle completions}@anchor{3e62}@anchor{library/idle id3}@anchor{3e7a}
@subsubsection Terminaciones


Cuando se solicitan y están disponibles, se suministran complementos para los nombres de los módulos, los atributos de las clases o las funciones, o los nombres de los archivos.  Cada método de solicitud muestra un cuadro para completar con los nombres existentes.  (Para cualquier cuadro, cambie el nombre que se está completando y el elemento resaltado en el cuadro escribiendo y borrando caracteres; pulsando las teclas @code{Up}, @code{Down}, @code{PageUp}, @code{PageDown}, @code{Home}, y @code{End}; y con un solo clic dentro del cuadro.  Cierra la caja con las teclas @code{Escape}, @code{Enter} y doble @code{Tab} o con clics fuera de la caja. Un doble clic dentro de la caja selecciona y cierra.

Una forma de abrir una caja es escribir un carácter clave y esperar un intervalo predefinido.  Este intervalo es por defecto de 2 segundos; se puede modificar en el diálogo de configuración.  (Para evitar las ventanas emergentes automáticas, establezca el retardo a un número grande de milisegundos, como 100000000). Para nombres de módulos importados o atributos de clases o funciones, escriba “.”. Para nombres de archivos en el directorio raíz, escriba @ref{70b,,os.sep} o @ref{70c,,os.altsep} inmediatamente después de una comilla de apertura.  (En Windows, se puede especificar una unidad de disco primero.) Muévase a los subdirectorios escribiendo un nombre de directorio y un separador.

En lugar de esperar, o después de cerrar una caja, abra una caja de finalización inmediatamente con Mostrar finalizaciones en el menú Edición.  La tecla rápida por defecto es @code{C-espacio}.  Si se teclea un prefijo para el nombre deseado antes de abrir el cuadro, la primera coincidencia o casi coincidencia se hace visible. El resultado es el mismo que si se introduce un prefijo después de mostrar la caja.  Mostrar las terminaciones después de una cita completa de los nombres de archivo en el directorio actual en lugar de un directorio raíz.

Pulsar @code{Tab} después de un prefijo suele tener el mismo efecto que el de mostrar las terminaciones.  (Sin prefijo, se indenta.) Sin embargo, si solo hay una coincidencia con el prefijo, esa coincidencia se añade inmediatamente al texto del editor sin abrir una caja.

Al invocar “Mostrar las terminaciones”, o al pulsar @code{Tab} después de un prefijo, fuera de una cadena y sin un “.” precedente, se abre un cuadro con las palabras clave, los nombres incorporados y los nombres disponibles a nivel de módulo.

Cuando se edita el código en un editor (a diferencia de Shell), aumentar los nombres disponibles a nivel de módulo mediante la ejecución de su código y no reiniciar el Shell después.  Esto es especialmente útil después de añadir importaciones en la parte superior de un archivo.  Esto también aumenta las posibles terminaciones de atributos.

Los cuadros de  excluyen inicialmente los valores que empiezan por “_” o, en el caso de los módulos, no incluidos en “__all__”.  Se puede acceder a los nombres ocultos escribiendo “_” después de “.”, ya sea antes o después de abrir la caja.

@node Sugerencias de llamada,Contexto del código,Terminaciones,Edición y navegación
@anchor{library/idle calltips}@anchor{3e63}@anchor{library/idle id4}@anchor{3e7b}
@subsubsection Sugerencias de llamada


Se muestra una sugerencia de llamada cuando se escribe @code{(} después del nombre de una función `accesible'.  Una expresión de nombre puede incluir puntos y subíndices.  Una sugerencia permanece hasta que se hace click, el cursor se mueve fuera del área de argumento o es escrito @code{)}.  Cada vez que el cursor está en la parte del argumento de una definición, el menú o acceso directo muestra una sugerencia de llamada.

La sugerencia de llamada consiste en la firma de la función y el docstring hasta la primera línea en blanco de este último o la quinta línea no en blanco.  (Algunas funciones incorporadas carecen de una firma accesible.) Un “/” o “*” en la firma indica que los argumentos anteriores o posteriores se pasan solo por posición o por nombre (palabra clave).  Los detalles están sujetos a cambios.

En Shell, las funciones accesibles dependen de los módulos que se hayan importado en el proceso del usuario, incluidos los importados por el propio Idle, y de las definiciones que se hayan ejecutado, todo ello desde el último reinicio.

Por ejemplo, reinicie el Shell e ingrese @code{itertools.count(}.  Una sugerencia de llamada aparece porque el Idle importa itertools en el proceso del usuario para su propio uso. (Esto puede cambiar.)  Al ingresar @code{turtle.write(} nada aparece.  El Idle no importa turtle.  El menú o el acceso directo tampoco hace nada.  Al ingresar @code{import turtle} y luego @code{turtle.write(} funcionará.

En un editor, las declaraciones de importación no tienen efecto hasta que se ejecuta el archivo.  Es posible que desee ejecutar un archivo después de escribir las declaraciones de importación en la parte superior o ejecutar inmediatamente un archivo existente antes de editarlo.

@node Contexto del código,Ventana de Shell,Sugerencias de llamada,Edición y navegación
@anchor{library/idle code-context}@anchor{3e6f}@anchor{library/idle id5}@anchor{3e7c}
@subsubsection Contexto del código


Dentro de una ventana del editor que contiene código Python, el contexto del código se puede alternar para mostrar u ocultar un panel en la parte superior de la ventana.  Cuando se muestra, este panel congela las líneas de apertura por bloques de código, como aquellos que comienzan con las palabras clave @code{class}, @code{def}, o @code{if}, que de otro modo se habrían desplazado fuera de la vista.  El tamaño del panel se expandirá y contraerá según sea necesario para mostrar todos los niveles actuales de contexto, hasta el número máximo de líneas definidas en el cuadro de diálogo Configurar IDLE (que por defecto es 15).  Si no hay líneas de contexto actuales y la función está activada, se visualizará una sola línea en blanco.  Al hacer click en una línea en el panel de contexto, esa línea se moverá a la parte superior del editor.

El texto y los colores de fondo para el panel de contexto se pueden configurar en la pestaña destacados en el cuadro de diálogo Configurar IDLE.

@node Ventana de Shell,Colores del texto,Contexto del código,Edición y navegación
@anchor{library/idle shell-window}@anchor{3e7d}
@subsubsection Ventana de Shell


Con el Shell del IDLE, se ingresa, edita y recupera declaraciones completas. (La mayoría de consolas y terminales solo funcionan con una sola línea física a la vez).

Envía una declaración de una sola línea para su ejecución al presionar @code{Return} con el cursor en cualquier parte de la línea. Si una línea se extiende con una barra invertida (@code{\}), el cursor debe estar en la última línea física. Envía una declaración compuesta de varias líneas al ingresar una línea vacía después de la declaración.

Cuando se pega código en el Shell, este no se compila y posiblemente se ejecuta hasta que se teclea @code{Return}, como se especifica arriba. Se puede editar el código pegado primero. Si se pega más de una declaración en el Shell, el resultado será un @ref{150,,SyntaxError} cuando se compilan varias declaraciones como si fueran una sola.

Las líneas que contienen @code{RESTART} significan que el proceso de ejecución del usuario se ha reiniciado. Esto ocurre cuando falla el proceso de ejecución del usuario, solicita un reinicio en el menú del Shell o ejecuta código en una ventana del editor.

The editing features described in previous subsections work when entering
code interactively.  IDLE’s Shell window also responds to the following:


@itemize *

@item 
@code{C-c} attempts to interrupt statement execution (but may fail).

@item 
@code{C-d} closes Shell if typed at a @code{>>>} prompt.

@item 
@code{Alt-p} and @code{Alt-n} (@code{C-p} and @code{C-n} on macOS)
retrieve to the current prompt the previous or next previously
entered statement that matches anything already typed.

@item 
@code{Return} while the cursor is on any previous statement
appends the latter to anything already typed at the prompt.
@end itemize

@node Colores del texto,,Ventana de Shell,Edición y navegación
@anchor{library/idle text-colors}@anchor{3e7e}
@subsubsection Colores del texto


El idle por defecto es negro sobre texto blanco, pero colorea el texto con significados especiales. Para el shell, estos son: la salida del shell, error del shell, salida del usuario y error del usuario.  Para el código Python, en el indicador de comandos de shell o en un editor, estos son: palabras clave, nombres de funciones y clases incorporadas, los siguientes nombres @code{class} and @code{def}, cadenas de caracteres y comentarios. Para cualquier ventana de texto, estos son: el cursor (cuando está presente), el texto encontrado (cuando sea posible) y el texto seleccionado.

IDLE también resalta las @ref{8a3,,palabras claves ligeras} @ref{8a4,,match}, @ref{8a4,,case}, y @ref{8a5,,_} en sentencias de patrones coincidentes. Sin embargo, este resaltado no es perfecto y será incorrecto en algunos raras ocasiones, incluyendo algunos @code{_}-s en patrones @code{case}.

La coloración del texto se realiza en segundo plano, por lo que ocasionalmente se puede ver el texto sin colorear.  Para cambiar la combinación de colores, use la pestaña Resaltar en el cuadro de diálogo Configurar IDLE.  El marcado de líneas de breakpoint del depurador en el editor y el texto en ventanas emergentes y cuadros de diálogo no es configurable por el usuario.

@node Inicio y ejecución de código,Ayuda y preferencias,Edición y navegación,IDLE<60>
@anchor{library/idle startup-and-code-execution}@anchor{3e7f}
@subsubsection Inicio y ejecución de código


Al iniciar con la opción @code{-s}, el IDLE ejecutará el archivo al que hacen referencia las variables de entorno  
@geindex IDLESTARTUP
@geindex variables de entorno; IDLESTARTUP
@code{IDLESTARTUP} o 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}. El IDLE primero verifica @code{IDLESTARTUP}; si @code{IDLESTARTUP} está presente, se ejecuta el archivo al que se hace referencia.  Si @code{IDLESTARTUP} no está presente, IDLE verifica @code{PYTHONSTARTUP}.  Los archivos referenciados por estas variables de entorno son lugares convenientes para almacenar funciones que son usadas con frecuencia desde el shell del IDLE o para ejecutar declaraciones importadas para importar módulos comunes.

Además, @code{Tk} también carga un archivo de inicio si este está presente.  Tenga en cuenta que el archivo Tk se carga incondicionalmente.  Este archivo adicional es @code{.Idle.py} y es buscado en el directorio de inicio del usuario.  Las declaraciones en este archivo se ejecutarán en el espacio de nombres Tk, por lo que este archivo no es útil para importar funciones que se utilizarán desde el shell de Python del IDLE.

@menu
* Uso de línea de comando:: 
* Error de inicio:: 
* Ejecutando código del usuario:: 
* Salida del usuario en consola:: 
* Desarrollando aplicaciones tkinter:: 
* Ejecutando sin un subproceso:: 

@end menu

@node Uso de línea de comando,Error de inicio,,Inicio y ejecución de código
@anchor{library/idle command-line-usage}@anchor{3e80}
@subsubsection Uso de línea de comando


@example
idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...

-c command  run command in the shell window
-d          enable debugger and open shell window
-e          open editor window
-h          print help message with legal combinations and exit
-i          open shell window
-r file     run file in shell window
-s          run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
-t title    set title of shell window
-           run stdin in shell (- must be last option before args)
@end example

Si están los argumentos:


@itemize *

@item 
Si se usa @code{-}, @code{-c} o @code{r}, todos los argumentos se colocan en @code{sys.argv [1:...]} y @code{sys.argv[0]} se establece en @code{'@w{'}}, @code{'-c'} o @code{'-r'}.  No se abre ninguna ventana del editor, incluso si ese es el conjunto predeterminado en el cuadro de diálogo opciones.

@item 
De lo contrario, los argumentos son archivos abiertos para edición y @code{sys.argv} refleja los argumentos pasados al IDLE.
@end itemize

@node Error de inicio,Ejecutando código del usuario,Uso de línea de comando,Inicio y ejecución de código
@anchor{library/idle startup-failure}@anchor{3e81}
@subsubsection Error de inicio


El IDLE usa un socket para comunicarse entre el proceso del GUI de IDLE y el proceso de ejecución del código de usuario.  Se debe establecer una conexión cada vez que el Shell se inicia o reinicia.  (Esto último se indica mediante una línea divisoria que dice “REINICIAR” (`RESTART')). Si el proceso del usuario no se conecta al proceso de la GUI, muestra un cuadro de error @code{Tk} con un mensaje de “no se puede conectar” que dirige al usuario aquí. Y después se detiene.

Una falla de conexión específica en sistemas Unix es el resultado de una mala configuración de las reglas de enmascarado en algún lugar de la configuración del sistema de red. Cuando el IDLE inicia desde la terminal, puede verse un mensaje que comienza con ``@w{`}' Invalid host:@code{. The valid value is `@w{`}127.0.0.1 (idlelib.rpc.LOCALHOST)`@w{`}**. Se puede diagnosticar con `@w{`}tcpconnect -irv 127.0.0.1 6543} en una ventana de la terminal y @code{tcplisten <same args>} en otra.

Una causa común de falla se da cuando un archivo escrito por el usuario tiene el mismo nombre de un módulo de biblioteca estándar, como `random.py' y `tkinter.py'. Cuando dicho archivo se encuentra en el mismo directorio que un archivo que está por ejecutarse, el IDLE no puede importar el archivo stdlib.  La solución actual es cambiar el nombre del archivo del usuario.

Aunque es menos común que en el pasado, un programa de antivirus o firewall puede detener la conexión.  Si el programa no se puede configurar para permitir la conexión, debe estar apagado para que funcione el IDLE.  Es seguro permitir esta conexión interna porque no hay datos visibles en puertos externos.  Un problema similar es una configuración incorrecta de la red que bloquea las conexiones.

Los problemas de instalación de Python ocasionalmente detienen el IDLE: puede darse un conflicto entre versiones o una sola instalación puede requerir privilegios de administrador.  Si se soluciona el conflicto o no se puede o quiere ejecutar como administrador, puede ser más fácil desinstalar completamente Python y comenzar de nuevo.

Un proceso zombie pythonw.exe podría ser un problema.  En Windows, use el Administrador de tareas para buscar uno y detenerlo si lo hay.  A veces, un reinicio iniciado por un bloqueo del programa o una interrupción del teclado (control-C) puede fallar al conectarse.  Descartar el cuadro de error o usar Reiniciar Shell en el menú del Shell puede solucionar un problema temporal.

Cuando el IDLE se inicia por primera vez, intenta leer los archivos de configuración de usuario en @code{~/.idlerc/} (~ este es el directorio principal).  Si hay un problema, se mostrará un mensaje de error.  Dejando de lado los fallos aleatorios del disco, esto se puede evitar si nunca se editan los archivos a mano.  En su lugar, utilice el cuadro de diálogo de configuración, en Opciones.  Una vez que hay un error en un archivo de configuración de usuario, la mejor solución puede ser eliminarlo y empezar de nuevo con el cuadro de diálogo de configuración.

Si el IDLE se cierra sin mensaje y este no fue iniciado desde una consola, intente iniciarlo desde una consola o terminal (@code{python -m idlelib}) y observe si esto genera un mensaje de error.

En sistemas basados en Unix con tcl/tk más antiguos que @code{8.6.11} (ver @code{About IDLE}) ciertos caracteres de ciertas fuentes pueden causar un fallo a tk con un mensaje hacia la terminal. Esto puede pasar cuando se inicia el IDLE para editar un archivo con dicho carácter o luego cuando se ingresa ese carácter. Si no se puede actualizar tcl/tk, entonces re configurar el IDLE para usar una fuente que funcione mejor.

@node Ejecutando código del usuario,Salida del usuario en consola,Error de inicio,Inicio y ejecución de código
@anchor{library/idle running-user-code}@anchor{3e82}
@subsubsection Ejecutando código del usuario


Con raras excepciones, el resultado de ejecutar el código de Python con el IDLE se supone es el mismo que al ejecutar el mismo código por el método predeterminado, directamente con Python en una consola de sistema en modo de texto o una ventana de terminal. Sin embargo, las diferentes interfaces y operaciones ocasionalmente afectan los resultados visibles.  Por ejemplo, @code{sys.modules} comienza con más entradas y @code{threading.activeCount()} retorna 2 en lugar de 1.

De forma predeterminada, el IDLE ejecuta el código de usuario en un proceso separado del sistema operativo en lugar de hacerlo en el proceso de la interfaz de usuario que ejecuta el shell y el editor.  En el proceso de ejecución, este reemplaza @code{sys.stdin}, @code{sys.stdout}, y @code{sys.stderr} con objetos que recuperan las entradas desde y envían las salidas hacia la ventana de la consola. Los valores originales almacenados en @code{sys.__stdin__}, @code{sys.__stdout__}, y @code{sys.__stderr__} no se ven afectados, pero pueden ser @code{None}.

El envío de la salida de impresión de un proceso a un widget de texto en otro es más lento que la impresión a un terminal del sistema en el mismo proceso. Esto tiene el mayor efecto cuando se imprimen múltiples argumentos, ya que la cadena de cada argumento, cada separador y la nueva línea se envían por separado. Para el desarrollo, esto no suele ser un problema, pero si uno quiere imprimir más rápido en IDLE, formatea y une todo lo que quiere mostrar junto y luego imprime una sola cadena.  Tanto las cadenas de formato como @ref{21b5,,str.join()} pueden ayudar a combinar campos y líneas.

Las sustituciones de flujo estándar del IDLE no son heredadas por subprocesos creados en el proceso de ejecución, siendo directamente por código de usuario o por módulos como el multiprocesamiento.  Si tal subproceso usa @code{input} desde sys.stdin o @code{print} o @code{write} hacia sys.stdout o sys.stderr, el IDLE debe ser iniciado en una ventana de línea de comando. (En Windows, utilice @code{python} o @code{py} en lugar de @code{pythonw} o @code{pyw}.) El subproceso secundario será adjuntado a esa ventana para entrada y salida.

Si @code{sys} es restablecido mediante un código de usuario, tal como @code{importlib.reload(sys)}, los cambios del IDLE se perderán y la entrada del teclado y la salida de la pantalla no funcionarán correctamente.

Cuando el shell está en primer plano, controla el teclado y la pantalla.  Este es transparente normalmente, pero las funciones que acceden directamente al teclado y la pantalla no funcionarán.  Estas incluyen funciones específicas del sistema que determinan si se ha presionado una tecla y de ser así, cuál.

La ejecución de código del IDLE en el proceso de ejecución agrega marcos a la pila de llamadas que de otro modo no estarían allí.  el IDLE encapsula @code{sys.getrecursionlimit} y @code{sys.setrecursionlimit} para reducir el efecto de los marcos de pila adicionales.

Cuando el código de usuario genera SystemExit directamente o llamando a sys.exit, el IDLE regresa al visualizador del Shell en lugar de salir.

@node Salida del usuario en consola,Desarrollando aplicaciones tkinter,Ejecutando código del usuario,Inicio y ejecución de código
@anchor{library/idle user-output-in-shell}@anchor{3e83}
@subsubsection Salida del usuario en consola


Cuando un programa muestra texto, el resultado está determinado por el dispositivo de salida correspondiente.  Cuando el IDLE ejecuta el código de usuario @code{sys.stdout} y @code{sys.stderr} se conectan al área de visualización del Shell del IDLE.  Algunas de estas características son heredadas de los widgets de texto Tk subyacentes.  Otras son adiciones programadas.  Donde es importante, el shell está diseñado para el desarrollo en lugar de la ejecución de producción.

Por ejemplo, el Shell nunca elimina la salida. Un programa que envía salidas ilimitadas al Shell eventualmente llenará la memoria, lo que resultará en un error de memoria. Por el contrario, algunas ventanas de texto del sistema solo conservan las últimas n líneas de salida. Una consola de Windows, por ejemplo, mantiene una línea configurable por el usuario de 1 a 9999, con 300 por defecto.

Un widget de texto de Tk, y por lo tanto el Shell de IDLE, muestra caracteres (puntos de código) en el subconjunto BMP (plano multilingual básico) de Unicode.  Aquellos caracteres que se muestran con un glifo adecuado y los cuales con una caja de reemplazo depende del sistema operativo y las fuentes instaladas.  Los caracteres de tabulación hacen que el texto siguiente comience después de la siguiente tabulación. (Ocurre cada 8 “caracteres”).  Los caracteres de nueva línea hacen que el texto siguiente aparezca en una nueva línea.  Otros caracteres de control se omiten o se muestran como un espacio, cuadro u otra cosa, dependiendo del sistema operativo y la fuente.  (Mover el cursor del texto a través de esa salida con las teclas de flecha puede mostrar algún comportamiento de espaciado sorpresivo.)

@example
>>> s = 'a\tb\a<\x02><\r>\bc\nd'  # Enter 22 chars.
>>> len(s)
14
>>> s  # Display repr(s)
'a\tb\x07<\x02><\r>\x08c\nd'
>>> print(s, end='@w{'})  # Display s as is.
# Result varies by OS and font.  Try it.
@end example

La función @code{repr} es usada para la visualización interactiva del valor de las expresiones.  Esta retorna una versión modificada de la cadena de caracteres de entrada en la que los códigos de control, algunos puntos de código BMP y todos los puntos de código que no son BMP son reemplazados con caracteres de escape. Como se demostró anteriormente, esto permite identificar los caracteres en una cadena de caracteres, independientemente de cómo sean mostrados.

La salida normal y de error generalmente se mantienen separadas (en líneas separadas) de la entrada de código y entre sí. Cada una obtiene diferentes colores de resaltado.

Para el `traceback' de SyntaxError, el marcado normal “^” dónde se detectó el error se reemplaza coloreando el texto con un resaltado de error. Cuando el código ejecutado desde un archivo causa otras excepciones, se puede hacer click derecho en un `traceback' para saltar a la línea correspondiente en un editor del IDLE. El archivo se abrirá si es necesario.

El Shell tiene una funcionalidad especial para exprimir las líneas de salida hasta una etiqueta de “Texto `Squeezed'”.  Esto se hace automáticamente para una salida sobre N líneas (N = 50 por defecto). N se puede cambiar en la sección PyShell de la página General del cuadro de diálogo Configuración.  La salida con menos líneas puede ser `squeezed' haciendo click derecho en la salida.  Esto puede ser útil en líneas suficientemente largas para bajar el tiempo de desplazamiento.

La salida `squeezed' se expande en su lugar haciendo doble click en la etiqueta. También se puede enviar al portapapeles o a una ventana de vista separada haciendo click derecho en la etiqueta.

@node Desarrollando aplicaciones tkinter,Ejecutando sin un subproceso,Salida del usuario en consola,Inicio y ejecución de código
@anchor{library/idle developing-tkinter-applications}@anchor{3e84}
@subsubsection Desarrollando aplicaciones tkinter


El IDLE es intencionalmente diferente de Python estándar para facilitar el desarrollo de programas tkinter.  Ingrese @code{import tkinter as tk; root = tk.Tk()} en Python estándar y no aparecerá nada. Ingrese lo mismo en el IDLE y aparecerá una ventana tk.  En Python estándar, también se debe ingresar @code{root.update()} para ver la ventana.  El IDLE hace el equivalente en segundo plano, aproximadamente 20 veces por segundo, lo que es aproximadamente cada 50 milisegundos. Luego ingrese @code{b = tk.Button(root, text='button'); b.pack()}.  Del mismo modo, no hay cambios visibles en Python estándar hasta que ingrese @code{root.update()}.

La mayoría de los programas tkinter ejecutan @code{root.mainloop()}, que generalmente no retorna hasta que se destruye la aplicación tk.  Si el programa se ejecuta con @code{python -i} o desde un editor del IDLE, no aparecerá un mensaje @code{>>>} del shell hasta que retorne @code{mainloop()}, momento en el cual no queda nada con lo que interactuar.

Al ejecutar un programa tkinter desde un editor IDLE, se puede comentar la llamada de bucle principal.  Luego se recibe un aviso del shell inmediatamente y se puede interactuar con la aplicación en vivo.  Solo se debe recordar reactivar la llamada al bucle principal cuando se ejecuta en Python estándar.

@node Ejecutando sin un subproceso,,Desarrollando aplicaciones tkinter,Inicio y ejecución de código
@anchor{library/idle running-without-a-subprocess}@anchor{3e85}
@subsubsection Ejecutando sin un subproceso


Por defecto, el IDLE ejecuta el código de usuario en un subproceso separado a través de un socket, el cual utiliza la interfaz de bucle interno.  Esta conexión no es visible externamente y no son enviados ni recibidos datos de Internet. Si el software de cortafuego sigue presentando problemas, puede ignorarlo.

Si el intento de conexión del socket falla, IDLE lo notificará. Este tipo de falla a veces es temporal, pero si persiste, el problema puede provenir de un cortafuego que bloquea la conexión o de una mala configuración en un sistema en particular.  Hasta que se solucione el problema, se puede ejecutar el Idle con el modificador de línea de comandos -n.

Si el IDLE se inicia con el modificador de línea de comandos -n, se ejecutará en un único proceso y no creará el subproceso que ejecuta el servidor de ejecución de Python RPC.  Esto puede ser útil si Python no puede crear el subproceso o la interfaz de socket RPC en su plataforma.  Sin embargo, en este modo el código de usuario no está aislado en sí del IDLE.  Además, el entorno no se reinicia cuando se selecciona Ejecutar/Ejecutar módulo (F5).  Si el código se ha modificado, se debe volver a cargar() los módulos afectados y volver a importar cualquier elemento específico (por ejemplo, desde `foo' importar `baz') para que los cambios surtan efecto.  Por estas razones, es preferible ejecutar el IDLE con el subproceso predeterminado si es posible.


Obsoleto desde la versión 3.4.


@node Ayuda y preferencias,idlelib,Inicio y ejecución de código,IDLE<60>
@anchor{library/idle help-and-preferences}@anchor{3e86}
@subsubsection Ayuda y preferencias


@menu
* Recursos de ayuda:: 
* Preferencias de configuración:: 
* IDLE en macOS:: 
* Extensiones:: 

@end menu

@node Recursos de ayuda,Preferencias de configuración,,Ayuda y preferencias
@anchor{library/idle help-sources}@anchor{3e72}@anchor{library/idle id6}@anchor{3e87}
@subsubsection Recursos de ayuda


La entrada del menú Ayuda «Ayuda IDLE» muestra una versión HTML formateada del capítulo IDLE de la Referencia de la biblioteca.  El resultado, en una ventana de texto tkinter de solo lectura, está cerca de lo que se ve en un navegador web. Navegue por el texto con la rueda del ratón, la barra de desplazamiento o presionando las teclas de flecha arriba y abajo. O haga click en el botón TDC (Tabla de contenido) y seleccione un encabezado de sección en el cuadro abierto.

La entrada del menú de ayuda «Documentos de Python» abre amplias fuentes de ayuda, incluyendo tutoriales, disponibles en @code{docs.python.org/x.y}, donde “x.y” es la versión de Python actualmente en ejecución.  Si su sistema tiene una copia fuera de línea de los documentos (esta puede ser una opción de instalación), esta se abrirá en su lugar.

Las URL seleccionadas se pueden agregar o eliminar del menú de ayuda en cualquier momento utilizando la pestaña General del cuadro de diálogo Configurar IDLE.

@node Preferencias de configuración,IDLE en macOS,Recursos de ayuda,Ayuda y preferencias
@anchor{library/idle preferences}@anchor{3e6e}@anchor{library/idle setting-preferences}@anchor{3e88}
@subsubsection Preferencias de configuración


Las preferencias de fuente, resaltado, teclas y preferencias generales se pueden cambiar en Configurar IDLE en el menú opción. Las configuraciones de usuario no predeterminadas se guardan en un directorio @code{.idlerc} en el directorio de inicio del usuario.  Los problemas causados por archivos de configuración de usuario incorrectos se resuelven editando o eliminando uno o más de los archivos en @code{.idlerc}.

En la pestaña Fuentes (`Font'), consulte la muestra de texto para ver el efecto de la fuente y el tamaño de la fuente en varios caracteres en varios idiomas.  Edite la muestra para agregar otros caracteres de interés personal.  Use la muestra para seleccionar fuentes monoespaciadas.  Si determinados caracteres tienen problemas en el shell o en el editor, agréguelos a la parte inicial de la muestra e intente cambiar primero el tamaño y luego la fuente.

En la pestaña Resaltado y Teclas (`Highlights and Keys'), seleccione un tema de color integrado o personalizado y un conjunto de teclas.  Para utilizar un nuevo tema de color integrado o un conjunto de teclas con IDLE más antiguos, guárdelo como un nuevo tema personalizado o conjunto de teclas y será accesible para los IDLE más antiguos.

@node IDLE en macOS,Extensiones,Preferencias de configuración,Ayuda y preferencias
@anchor{library/idle idle-on-macos}@anchor{3e89}
@subsubsection IDLE en macOS


En Preferencias del sistema: Dock, puede establecer «Preferencias de pestañas al abrir documentos» en el valor «Siempre».  Este parámetro no es compatible con la interfaz gráfica de usuario del framework tk/tkinter utilizado por IDLE y rompe algunas funcionalidades del IDLE.

@node Extensiones,,IDLE en macOS,Ayuda y preferencias
@anchor{library/idle extensions}@anchor{3e8a}
@subsubsection Extensiones


IDLE incluye una herramienta de extensiones.  Las preferencias para las extensiones se pueden cambiar con la pestaña Extensiones de la ventana de preferencias. Lea el inicio de config-extensions.def en la carpeta idlelib para obtener más información.  La única extensión utilizada actualmente por defecto es zzdummy, un ejemplo que también se utiliza para realizar pruebas.

@node idlelib,,Ayuda y preferencias,IDLE<60>
@anchor{library/idle idlelib}@anchor{3e8b}@anchor{library/idle module-idlelib}@anchor{73}
@subsubsection idlelib


@geindex module; idlelib

`Código fuente:' Lib/idlelib@footnote{https://github.com/python/cpython/tree/main/Lib/idlelib}


__________________________________________________________________


El paquete Lib/idlelib implementa la aplicación del IDLE. Consultar el resto de esta página para saber cómo utilizar el IDLE.

Los archivos en idlelib se describen en idlelib/README.txt. Accede a él en idlelib o haga clic en Ayuda => Acerca del IDLE en el menú del IDLE. Este archivo también asigna elementos del menú del IDLE al código que implementa el elemento. Excepto para archivos enumerados en “Inicio”, el código de idlelib es “privado” en el sentido de que los cambios de características pueden ser portados (consultar 
@geindex Python Enhancement Proposals; PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/}).

@c Other sections I have in mind are
@c Tkinter internals
@c Freezing Tkinter applications

@node Herramientas de desarrollo,Depuración y perfilado,Interfaces gráficas de usuario con Tk,La biblioteca estándar de Python
@anchor{library/development doc}@anchor{3e8c}@anchor{library/development development}@anchor{3e8d}@anchor{library/development development-tools}@anchor{3e8e}
@section Herramientas de desarrollo


The modules described in this chapter help you write software.  For example, the
@ref{b5,,pydoc} module takes a module and generates documentation based on the
module’s contents.  The @ref{3b,,doctest} and @ref{106,,unittest} modules contains
frameworks for writing unit tests that automatically exercise code and verify
that the expected output is produced.

La lista de módulos descritos en este capítulo es:

@menu
* typing — Soporte para type hints:: 
* pydoc — Documentation generator and online help system:: 
* Modo de desarrollo de Python:: 
* doctest — Test interactive Python examples:: 
* unittest — Unit testing framework:: 
* unittest.mock — mock object library: unittest mock — mock object library. 
* unittest.mock — getting started: unittest mock — getting started. 
* test — Regression tests package for Python:: 
* test.support — Utilidades para el conjunto de pruebas de Python: test support — Utilidades para el conjunto de pruebas de Python. 
* test.support.socket_helper — Utilidades para pruebas de socket: test support socket_helper — Utilidades para pruebas de socket. 
* test.support.script_helper —Utilidades para las pruebas de ejecución de Python: test support script_helper —Utilidades para las pruebas de ejecución de Python. 
* test.support.bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode: test support bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode. 
* test.support.threading_helper — Utilidades para pruebas con hilos: test support threading_helper — Utilidades para pruebas con hilos. 
* test.support.os_helper — Utilidades para pruebas de sistemas operativos: test support os_helper — Utilidades para pruebas de sistemas operativos. 
* test.support.import_helper — Utilidades para pruebas de importación: test support import_helper — Utilidades para pruebas de importación. 
* test.support.warnings_helper — Utilidades para pruebas de advertencias: test support warnings_helper — Utilidades para pruebas de advertencias. 

@end menu

@node typing — Soporte para type hints,pydoc — Documentation generator and online help system,,Herramientas de desarrollo
@anchor{library/typing doc}@anchor{3e8f}@anchor{library/typing typing-support-for-type-hints}@anchor{3e90}
@subsection @code{typing} — Soporte para `type hints'


@c import typing
@c from dataclasses import dataclass
@c from typing import *

@geindex module; typing
@anchor{library/typing module-typing}@anchor{104}

Added in version 3.5.


`Source code:' Lib/typing.py@footnote{https://github.com/python/cpython/tree/main/Lib/typing.py}

@cartouche
@quotation Nota 
The Python runtime does not enforce function and variable type annotations.
They can be used by third party tools such as @ref{3c4,,type checkers},
IDEs, linters, etc.
@end quotation
@end cartouche


__________________________________________________________________


This module provides runtime support for type hints.

Consider the function below:

@example
def surface_area_of_cube(edge_length: float) -> str:
    return f"The surface area of the cube is @{6 * edge_length ** 2@}."
@end example

The function @code{surface_area_of_cube} takes an argument expected to
be an instance of @ref{153,,float}, as indicated by the @ref{1f81,,type hint}
@code{edge_length: float}. The function is expected to return an instance
of @ref{237,,str}, as indicated by the @code{-> str} hint.

While type hints can be simple classes like @ref{153,,float} or @ref{237,,str},
they can also be more complex. The @ref{104,,typing} module provides a vocabulary of
more advanced type hints.

New features are frequently added to the @code{typing} module.
The typing_extensions@footnote{https://pypi.org/project/typing_extensions/} package
provides backports of these new features to older versions of Python.


@subsubheading Ver también



@table @asis

@item "Typing cheat sheet"@footnote{https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html}

A quick overview of type hints (hosted at the mypy docs)

@item «Type System Reference» section of the mypy docs@footnote{https://mypy.readthedocs.io/en/stable/index.html}

The Python typing system is standardised via PEPs, so this reference
should broadly apply to most Python type checkers. (Some parts may still
be specific to mypy.)

@item "Static Typing with Python"@footnote{https://typing.readthedocs.io/en/latest/}

Type-checker-agnostic documentation written by the community detailing
type system features, useful typing related tools and typing best
practices.
@end table


@menu
* Specification for the Python Type System:: 
* Alias de tipo:: 
* NewType:: 
* Annotating callable objects:: 
* Genéricos:: 
* Annotating tuples:: 
* The type of class objects:: 
* Annotating generators and coroutines:: 
* Tipos genéricos definidos por el usuario:: 
* El tipo Any:: 
* Subtipado nominal vs estructural:: 
* Contenido del módulo: Contenido del módulo<3>. 
* Línea de tiempo de obsolescencia de características principales:: 

@end menu

@node Specification for the Python Type System,Alias de tipo,,typing — Soporte para type hints
@anchor{library/typing relevant-peps}@anchor{3e91}@anchor{library/typing specification-for-the-python-type-system}@anchor{3e92}
@subsubsection Specification for the Python Type System


The canonical, up-to-date specification of the Python type system can be
found at "Specification for the Python type system"@footnote{https://typing.readthedocs.io/en/latest/spec/index.html}.

@node Alias de tipo,NewType,Specification for the Python Type System,typing — Soporte para type hints
@anchor{library/typing id2}@anchor{3e93}@anchor{library/typing type-aliases}@anchor{500}
@subsubsection Alias de tipo


A type alias is defined using the @ref{4e6,,type} statement, which creates
an instance of @ref{501,,TypeAliasType}. In this example,
@code{Vector} and @code{list[float]} will be treated equivalently by static type
checkers:

@example
type Vector = list[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# passes type checking; a list of floats qualifies as a Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])
@end example

Los alias de tipo son útiles para simplificar firmas de tipo complejas. Por ejemplo:

@example
from collections.abc import Sequence

type ConnectionOptions = dict[str, str]
type Address = tuple[str, int]
type Server = tuple[Address, ConnectionOptions]

def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    ...

# The static type checker will treat the previous type signature as
# being exactly equivalent to this one.
def broadcast_message(
    message: str,
    servers: Sequence[tuple[tuple[str, int], dict[str, str]]]
) -> None:
    ...
@end example

The @ref{4e6,,type} statement is new in Python 3.12. For backwards
compatibility, type aliases can also be created through simple assignment:

@example
Vector = list[float]
@end example

Or marked with @ref{862,,TypeAlias} to make it explicit that this is a type alias,
not a normal variable assignment:

@example
from typing import TypeAlias

Vector: TypeAlias = list[float]
@end example

@node NewType,Annotating callable objects,Alias de tipo,typing — Soporte para type hints
@anchor{library/typing distinct}@anchor{3e94}@anchor{library/typing newtype}@anchor{3e95}
@subsubsection NewType


Utilícese la clase auxiliar @ref{d7c,,NewType} para crear tipos distintos:

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

El validador estático de tipos tratará el nuevo tipo como si fuera una subclase del tipo original. Esto es útil para capturar errores lógicos:

@example
def get_user_name(user_id: UserId) -> str:
    ...

# passes type checking
user_a = get_user_name(UserId(42351))

# fails type checking; an int is not a UserId
user_b = get_user_name(-1)
@end example

Se pueden realizar todas las operaciones de @code{int} en una variable de tipo @code{UserId}, pero el resultado siempre será de tipo @code{int}. Esto permite pasar un @code{UserId} allí donde se espere un @code{int}, pero evitará la creación accidental de un @code{UserId} de manera incorrecta:

@example
# 'output' is of type 'int', not 'UserId'
output = UserId(23413) + UserId(54341)
@end example

Tenga en cuenta que estas validaciones solo las aplica el verificador de tipo estático. En tiempo de ejecución, la declaración @code{Derived = NewType('Derived', Base)} hará que @code{Derived} sea una clase que retorna inmediatamente cualquier parámetro que le pase. Eso significa que la expresión @code{Derived(some_value)} no crea una nueva clase ni introduce mucha sobrecarga más allá de la de una llamada de función regular.

Más concretamente, la expresión @code{some_value is Derived(some_value)} será siempre verdadera en tiempo de ejecución.

No es válido crear un subtipo de @code{Derived}:

@example
from typing import NewType

UserId = NewType('UserId', int)

# Fails at runtime and does not pass type checking
class AdminUserId(UserId): pass
@end example

Sin embargo, es posible crear un @ref{d7c,,NewType} basado en un @code{NewType} “derivado”:

@example
from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)
@end example

y la comprobación de tipo para @code{ProUserId} funcionará como se espera.

Véase 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para más detalle.

@cartouche
@quotation Nota 
Recall that the use of a type alias declares two types to be `equivalent' to
one another. Doing @code{type Alias = Original} will make the static type checker
treat @code{Alias} as being `exactly equivalent' to @code{Original} in all cases.
This is useful when you want to simplify complex type signatures.

En cambio, @code{NewType} declara un tipo que es `subtipo' de otro. Haciendo @code{Derived = NewType('Derived', Original)} hará que el Validador estático de tipos trate @code{Derived} como una `subclase' de @code{Original}, lo que implica que un valor de tipo @code{Original} no puede ser usado allí donde se espere un valor de tipo @code{Derived}. Esto es útil para prevenir errores lógicos con un coste de ejecución mínimo.
@end quotation
@end cartouche


Added in version 3.5.2.



Distinto en la versión 3.10: @code{NewType} is now a class rather than a function.  As a result, there is
some additional runtime cost when calling @code{NewType} over a regular
function.



Distinto en la versión 3.11: The performance of calling @code{NewType} has been restored to its level in
Python 3.9.


@node Annotating callable objects,Genéricos,NewType,typing — Soporte para type hints
@anchor{library/typing annotating-callable-objects}@anchor{3e96}@anchor{library/typing annotating-callables}@anchor{2526}
@subsubsection Annotating callable objects


Functions – or other @ref{28ea,,callable} objects – can be annotated using
@ref{881,,collections.abc.Callable} or deprecated @ref{85e,,typing.Callable}.
@code{Callable[[int], str]} signifies a function that takes a single parameter
of type @ref{1f0,,int} and returns a @ref{237,,str}.

For example:

@example
from collections.abc import Callable, Awaitable

def feeder(get_next_item: Callable[[], str]) -> None:
    ...  # Body

def async_query(on_success: Callable[[int], None],
                on_error: Callable[[int, Exception], None]) -> None:
    ...  # Body

async def on_update(value: str) -> None:
    ...  # Body

callback: Callable[[str], Awaitable[None]] = on_update
@end example

The subscription syntax must always be used with exactly two values: the
argument list and the return type.  The argument list must be a list of types,
a @ref{2ca,,ParamSpec}, @ref{85d,,Concatenate}, or an ellipsis. The return type must
be a single type.

If a literal ellipsis @code{...} is given as the argument list, it indicates that
a callable with any arbitrary parameter list would be acceptable:

@example
def concat(x: str, y: str) -> str:
    return x + y

x: Callable[..., str]
x = str     # OK
x = concat  # Also OK
@end example

@code{Callable} cannot express complex signatures such as functions that take a
variadic number of arguments, @ref{3e97,,overloaded functions}, or
functions that have keyword-only parameters. However, these signatures can be
expressed by defining a @ref{3bb,,Protocol} class with a
@ref{5fb,,__call__()} method:

@example
from collections.abc import Iterable
from typing import Protocol

class Combiner(Protocol):
    def __call__(self, *vals: bytes, maxlen: int | None = None) -> list[bytes]: ...

def batch_proc(data: Iterable[bytes], cb_results: Combiner) -> bytes:
    for item in data:
        ...

def good_cb(*vals: bytes, maxlen: int | None = None) -> list[bytes]:
    ...
def bad_cb(*vals: bytes, maxitems: int | None) -> list[bytes]:
    ...

batch_proc([], good_cb)  # OK
batch_proc([], bad_cb)   # Error! Argument 2 has incompatible type because of
                         # different name and kind in the callback
@end example

Los invocables que toman otros invocables como argumentos pueden indicar que sus tipos de parámetros dependen unos de otros utilizando @ref{2ca,,ParamSpec}. Además, si ese invocable agrega o elimina argumentos de otros invocables, se puede utilizar el operador @ref{85d,,Concatenate}. Toman la forma @code{Callable[ParamSpecVariable, ReturnType]} y @code{Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]} respectivamente.


Distinto en la versión 3.10: @code{Callable} ahora es compatible con @ref{2ca,,ParamSpec} y @ref{85d,,Concatenate}. Consulte 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para obtener más información.



@subsubheading Ver también


La documentación de @ref{2ca,,ParamSpec} y @ref{85d,,Concatenate} proporciona ejemplos de uso en @code{Callable}.


@node Genéricos,Annotating tuples,Annotating callable objects,typing — Soporte para type hints
@anchor{library/typing generics}@anchor{1f7f}@anchor{library/typing id3}@anchor{3e98}
@subsubsection Genéricos


Since type information about objects kept in containers cannot be statically
inferred in a generic way, many container classes in the standard library support
subscription to denote the expected types of container elements.

@example
from collections.abc import Mapping, Sequence

class Employee: ...

# Sequence[Employee] indicates that all elements in the sequence
# must be instances of "Employee".
# Mapping[str, str] indicates that all keys and all values in the mapping
# must be strings.
def notify_by_email(employees: Sequence[Employee],
                    overrides: Mapping[str, str]) -> None: ...
@end example

Generic functions and classes can be parameterized by using
@ref{3fc,,type parameter syntax}:

@example
from collections.abc import Sequence

def first[T](l: Sequence[T]) -> T:  # Function is generic over the TypeVar "T"
    return l[0]
@end example

Or by using the @ref{2c9,,TypeVar} factory directly:

@example
from collections.abc import Sequence
from typing import TypeVar

U = TypeVar('U')                  # Declare type variable "U"

def second(l: Sequence[U]) -> U:  # Function is generic over the TypeVar "U"
    return l[1]
@end example


Distinto en la versión 3.12: Syntactic support for generics is new in Python 3.12.


@node Annotating tuples,The type of class objects,Genéricos,typing — Soporte para type hints
@anchor{library/typing annotating-tuples}@anchor{3e99}@anchor{library/typing id4}@anchor{3e9a}
@subsubsection Annotating tuples


For most containers in Python, the typing system assumes that all elements in
the container will be of the same type. For example:

@example
from collections.abc import Mapping

# Type checker will infer that all elements in `@w{`}x`@w{`} are meant to be ints
x: list[int] = []

# Type checker error: `@w{`}list`@w{`} only accepts a single type argument:
y: list[int, str] = [1, 'foo']

# Type checker will infer that all keys in `@w{`}z`@w{`} are meant to be strings,
# and that all values in `@w{`}z`@w{`} are meant to be either strings or ints
z: Mapping[str, str | int] = @{@}
@end example

@ref{18e,,list} only accepts one type argument, so a type checker would emit an
error on the @code{y} assignment above. Similarly,
@ref{961,,Mapping} only accepts two type arguments: the first
indicates the type of the keys, and the second indicates the type of the
values.

Unlike most other Python containers, however, it is common in idiomatic Python
code for tuples to have elements which are not all of the same type. For this
reason, tuples are special-cased in Python’s typing system. @ref{464,,tuple}
accepts `any number' of type arguments:

@example
# OK: `@w{`}x`@w{`} is assigned to a tuple of length 1 where the sole element is an int
x: tuple[int] = (5,)

# OK: `@w{`}y`@w{`} is assigned to a tuple of length 2;
# element 1 is an int, element 2 is a str
y: tuple[int, str] = (5, "foo")

# Error: the type annotation indicates a tuple of length 1,
# but `@w{`}z`@w{`} has been assigned to a tuple of length 3
z: tuple[int] = (1, 2, 3)
@end example

To denote a tuple which could be of `any' length, and in which all elements are
of the same type @code{T}, use @code{tuple[T, ...]}. To denote an empty tuple, use
@code{tuple[()]}. Using plain @code{tuple} as an annotation is equivalent to using
@code{tuple[Any, ...]}:

@example
x: tuple[int, ...] = (1, 2)
# These reassignments are OK: `@w{`}tuple[int, ...]`@w{`} indicates x can be of any length
x = (1, 2, 3)
x = ()
# This reassignment is an error: all elements in `@w{`}x`@w{`} must be ints
x = ("foo", "bar")

# `@w{`}y`@w{`} can only ever be assigned to an empty tuple
y: tuple[()] = ()

z: tuple = ("foo", "bar")
# These reassignments are OK: plain `@w{`}tuple`@w{`} is equivalent to `@w{`}tuple[Any, ...]`@w{`}
z = (1, 2, 3)
z = ()
@end example

@node The type of class objects,Annotating generators and coroutines,Annotating tuples,typing — Soporte para type hints
@anchor{library/typing the-type-of-class-objects}@anchor{3e9b}@anchor{library/typing type-of-class-objects}@anchor{3e9c}
@subsubsection The type of class objects


A variable annotated with @code{C} may accept a value of type @code{C}. In
contrast, a variable annotated with @code{type[C]} (or deprecated
@ref{3e9d,,typing.Type[C]}) may accept values that are classes
themselves – specifically, it will accept the `class object' of @code{C}. For
example:

@example
a = 3         # Has type `@w{`}int`@w{`}
b = int       # Has type `@w{`}type[int]`@w{`}
c = type(a)   # Also has type `@w{`}type[int]`@w{`}
@end example

Note that @code{type[C]} is covariant:

@example
class User: ...
class ProUser(User): ...
class TeamUser(User): ...

def make_new_user(user_class: type[User]) -> User:
    # ...
    return user_class()

make_new_user(User)      # OK
make_new_user(ProUser)   # Also OK: `@w{`}type[ProUser]`@w{`} is a subtype of `@w{`}type[User]`@w{`}
make_new_user(TeamUser)  # Still fine
make_new_user(User())    # Error: expected `@w{`}type[User]`@w{`} but got `@w{`}User`@w{`}
make_new_user(int)       # Error: `@w{`}type[int]`@w{`} is not a subtype of `@w{`}type[User]`@w{`}
@end example

The only legal parameters for @ref{dcf,,type} are classes, @ref{74d,,Any},
@ref{1f7f,,type variables}, and unions of any of these types.
For example:

@example
def new_non_team_user(user_class: type[BasicUser | ProUser]): ...

new_non_team_user(BasicUser)  # OK
new_non_team_user(ProUser)    # OK
new_non_team_user(TeamUser)   # Error: `@w{`}type[TeamUser]`@w{`} is not a subtype
                              # of `@w{`}type[BasicUser | ProUser]`@w{`}
new_non_team_user(User)       # Also an error
@end example

@code{type[Any]} is equivalent to @ref{dcf,,type}, which is the root of Python’s
@ref{1f73,,metaclass hierarchy}.

@node Annotating generators and coroutines,Tipos genéricos definidos por el usuario,The type of class objects,typing — Soporte para type hints
@anchor{library/typing annotating-generators-and-coroutines}@anchor{2527}@anchor{library/typing id5}@anchor{3e9e}
@subsubsection Annotating generators and coroutines


A generator can be annotated using the generic type
@ref{e60,,Generator[YieldType@comma{} SendType@comma{} ReturnType]}.
For example:

@example
def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'
@end example

Note that unlike many other generic classes in the standard library,
the @code{SendType} of @ref{e60,,Generator} behaves
contravariantly, not covariantly or invariantly.

The @code{SendType} and @code{ReturnType} parameters default to @code{None}:

@example
def infinite_stream(start: int) -> Generator[int]:
    while True:
        yield start
        start += 1
@end example

It is also possible to set these types explicitly:

@example
def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1
@end example

Simple generators that only ever yield values can also be annotated
as having a return type of either
@ref{2253,,Iterable[YieldType]}
or @ref{2254,,Iterator[YieldType]}:

@example
def infinite_stream(start: int) -> Iterator[int]:
    while True:
        yield start
        start += 1
@end example

Async generators are handled in a similar fashion, but don’t
expect a @code{ReturnType} type argument
(@ref{d13,,AsyncGenerator[YieldType@comma{} SendType]}).
The @code{SendType} argument defaults to @code{None}, so the following definitions
are equivalent:

@example
async def infinite_stream(start: int) -> AsyncGenerator[int]:
    while True:
        yield start
        start = await increment(start)

async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
    while True:
        yield start
        start = await increment(start)
@end example

As in the synchronous case,
@ref{e64,,AsyncIterable[YieldType]}
and @ref{e63,,AsyncIterator[YieldType]} are
available as well:

@example
async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)
@end example

Coroutines can be annotated using
@ref{e62,,Coroutine[YieldType@comma{} SendType@comma{} ReturnType]}.
Generic arguments correspond to those of @ref{e60,,Generator},
for example:

@example
from collections.abc import Coroutine
c: Coroutine[list[str], str, int]  # Some coroutine defined elsewhere
x = c.send('hi')                   # Inferred type of 'x' is list[str]
async def bar() -> None:
    y = await c                    # Inferred type of 'y' is int
@end example

@node Tipos genéricos definidos por el usuario,El tipo Any,Annotating generators and coroutines,typing — Soporte para type hints
@anchor{library/typing user-defined-generic-types}@anchor{3e9f}@anchor{library/typing user-defined-generics}@anchor{576}
@subsubsection Tipos genéricos definidos por el usuario


Una clase definida por el usuario puede ser definida como una clase genérica.

@example
from logging import Logger

class LoggedVar[T]:
    def __init__(self, value: T, name: str, logger: Logger) -> None:
        self.name = name
        self.logger = logger
        self.value = value

    def set(self, new: T) -> None:
        self.log('Set ' + repr(self.value))
        self.value = new

    def get(self) -> T:
        self.log('Get ' + repr(self.value))
        return self.value

    def log(self, message: str) -> None:
        self.logger.info('%s: %s', self.name, message)
@end example

This syntax indicates that the class @code{LoggedVar} is parameterised around a
single @ref{3ea0,,type variable} @code{T} . This also makes @code{T} valid as
a type within the class body.

Generic classes implicitly inherit from @ref{15f6,,Generic}. For compatibility
with Python 3.11 and lower, it is also possible to inherit explicitly from
@ref{15f6,,Generic} to indicate a generic class:

@example
from typing import TypeVar, Generic

T = TypeVar('T')

class LoggedVar(Generic[T]):
    ...
@end example

Generic classes have @ref{7d6,,__class_getitem__()} methods, meaning they
can be parameterised at runtime (e.g. @code{LoggedVar[int]} below):

@example
from collections.abc import Iterable

def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    for var in vars:
        var.set(0)
@end example

Un tipo genérico puede tener un numero cualquiera de variables de tipo. Se permiten todas las variaciones de @ref{2c9,,TypeVar} para ser usadas como parámetros de un tipo genérico:

@example
from typing import TypeVar, Generic, Sequence

class WeirdTrio[T, B: Sequence[bytes], S: (int, str)]:
    ...

OldT = TypeVar('OldT', contravariant=True)
OldB = TypeVar('OldB', bound=Sequence[bytes], covariant=True)
OldS = TypeVar('OldS', int, str)

class OldWeirdTrio(Generic[OldT, OldB, OldS]):
    ...
@end example

Cada argumento de variable de tipo en una clase @ref{15f6,,Generic} debe ser distinto. Así, no será válido:

@example
from typing import TypeVar, Generic
...

class Pair[M, M]:  # SyntaxError
    ...

T = TypeVar('T')

class Pair(Generic[T, T]):   # INVALID
    ...
@end example

Generic classes can also inherit from other classes:

@example
from collections.abc import Sized

class LinkedList[T](Sized):
    ...
@end example

When inheriting from generic classes, some type parameters could be fixed:

@example
from collections.abc import Mapping

class MyDict[T](Mapping[str, T]):
    ...
@end example

En este caso @code{MyDict} tiene un solo parámetro, @code{T}.

Using a generic class without specifying type parameters assumes
@ref{74d,,Any} for each position. In the following example, @code{MyIterable} is
not generic but implicitly inherits from @code{Iterable[Any]}:

@example
from collections.abc import Iterable

class MyIterable(Iterable): # Same as Iterable[Any]
    ...
@end example

User-defined generic type aliases are also supported. Examples:

@example
from collections.abc import Iterable

type Response[S] = Iterable[S] | int

# Return type here is same as Iterable[str] | int
def response(query: str) -> Response[str]:
    ...

type Vec[T] = Iterable[tuple[T, T]]

def inproduct[T: (int, float, complex)](v: Vec[T]) -> T: # Same as Iterable[tuple[T, T]]
    return sum(x*y for x, y in v)
@end example

For backward compatibility, generic type aliases can also be created
through a simple assignment:

@example
from collections.abc import Iterable
from typing import TypeVar

S = TypeVar("S")
Response = Iterable[S] | int
@end example


Distinto en la versión 3.7: @ref{15f6,,Generic} ya no posee una metaclase personalizable.



Distinto en la versión 3.12: Syntactic support for generics and type aliases is new in version 3.12.
Previously, generic classes had to explicitly inherit from @ref{15f6,,Generic}
or contain a type variable in one of their bases.


User-defined generics for parameter expressions are also supported via parameter
specification variables in the form @code{[**P]}.  The behavior is consistent
with type variables” described above as parameter specification variables are
treated by the typing module as a specialized type variable.  The one exception
to this is that a list of types can be used to substitute a @ref{2ca,,ParamSpec}:

@example
>>> class Z[T, **P]: ...  # T is a TypeVar; P is a ParamSpec
...
>>> Z[int, [dict, float]]
__main__.Z[int, [dict, float]]
@end example

Classes generic over a @ref{2ca,,ParamSpec} can also be created using explicit
inheritance from @ref{15f6,,Generic}. In this case, @code{**} is not used:

@example
from typing import ParamSpec, Generic

P = ParamSpec('P')

class Z(Generic[P]):
    ...
@end example

Another difference between @ref{2c9,,TypeVar} and @ref{2ca,,ParamSpec} is that a
generic with only one parameter specification variable will accept
parameter lists in the forms @code{X[[Type1, Type2, ...]]} and also
@code{X[Type1, Type2, ...]} for aesthetic reasons.  Internally, the latter is converted
to the former, so the following are equivalent:

@example
>>> class X[**P]: ...
...
>>> X[int, str]
__main__.X[[int, str]]
>>> X[[int, str]]
__main__.X[[int, str]]
@end example

Note that generics with @ref{2ca,,ParamSpec} may not have correct
@code{__parameters__} after substitution in some cases because they
are intended primarily for static type checking.


Distinto en la versión 3.10: @ref{15f6,,Generic} ahora se puede parametrizar sobre expresiones de parámetros. Consulte @ref{2ca,,ParamSpec} y 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para obtener más detalles.


A user-defined generic class can have ABCs as base classes without a metaclass
conflict. Generic metaclasses are not supported. The outcome of parameterizing
generics is cached, and most types in the typing module are @ref{6b1,,hashable} and
comparable for equality.

@node El tipo Any,Subtipado nominal vs estructural,Tipos genéricos definidos por el usuario,typing — Soporte para type hints
@anchor{library/typing the-any-type}@anchor{3ea1}
@subsubsection El tipo @code{Any}


Un caso especial de tipo es @ref{74d,,Any}. Un Validador estático de tipos tratará cualquier tipo como compatible con @ref{74d,,Any}, y @ref{74d,,Any} como compatible con todos los tipos.

Esto significa que es posible realizar cualquier operación o llamada a un método en un valor de tipo @ref{74d,,Any} y asignarlo a cualquier variable:

@example
from typing import Any

a: Any = None
a = []          # OK
a = 2           # OK

s: str = '@w{'}
s = a           # OK

def foo(item: Any) -> int:
    # Passes type checking; 'item' could be any type,
    # and that type might have a 'bar' method
    item.bar()
    ...
@end example

Nótese que no se realiza comprobación de tipo cuando se asigna un valor de tipo @ref{74d,,Any} a un tipo más preciso. Por ejemplo, el Validador estático de tipos no reportó ningún error cuando se asignó @code{a} a @code{s}, aún cuando se declaró @code{s} como de tipo @ref{237,,str} y recibió un valor @ref{1f0,,int} en tiempo de ejecución!

Además, todas las funciones sin un tipo de retorno o tipos en los parámetros serán asignadas implícitamente a @ref{74d,,Any} por defecto:

@example
def legacy_parser(text):
    ...
    return data

# A static type checker will treat the above
# as having the same signature as:
def legacy_parser(text: Any) -> Any:
    ...
    return data
@end example

Este comportamiento permite que @ref{74d,,Any} sea usado como una `vía de escape' cuando es necesario mezclar código tipado estática y dinámicamente.

Compárese el comportamiento de @ref{74d,,Any} con el de @ref{b18,,object}. De manera similar a @ref{74d,,Any}, todo tipo es un subtipo de @ref{b18,,object}. Sin embargo, en oposición a @ref{74d,,Any}, lo contrario no es cierto: @ref{b18,,object} `no' es un subtipo de ningún otro tipo.

Esto implica que cuando el tipo de un valor es @ref{b18,,object}, un validador de tipos rechazará prácticamente todas las operaciones con él, y al asignarlo a una variable (o usarlo como valor de retorno) de un tipo más preciso será un error de tipo. Por ejemplo:

@example
def hash_a(item: object) -> int:
    # Fails type checking; an object does not have a 'magic' method.
    item.magic()
    ...

def hash_b(item: Any) -> int:
    # Passes type checking
    item.magic()
    ...

# Passes type checking, since ints and strs are subclasses of object
hash_a(42)
hash_a("foo")

# Passes type checking, since Any is compatible with all types
hash_b(42)
hash_b("foo")
@end example

Úsese @ref{b18,,object} para indicar que un valor puede ser de cualquier tipo de manera segura. Úsese @ref{74d,,Any} para indicar que un valor es de tipado dinámico.

@node Subtipado nominal vs estructural,Contenido del módulo<3>,El tipo Any,typing — Soporte para type hints
@anchor{library/typing nominal-vs-structural-subtyping}@anchor{3ea2}
@subsubsection Subtipado nominal vs estructural


Inicialmente, el 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} definió el uso de `subtipado nominal' para el sistema de tipado estático de Python. Esto implica que una clase @code{A} será permitida allí donde se espere una clase @code{B} si y solo si @code{A} es una subclase de @code{B}.

Este requisito también se aplicaba anteriormente a clases base abstractas (ABC), tales como @ref{2253,,Iterable}. El problema con esta estrategia es que una clase debía de ser marcada explícitamente para proporcionar tal funcionalidad, lo que resulta poco `pythónico' (idiomático) y poco ajustado a lo que uno normalmente haría en un código Python tipado dinámicamente. Por ejemplo, esto sí se ajusta al 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}:

@example
from collections.abc import Sized, Iterable, Iterator

class Bucket(Sized, Iterable[int]):
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...
@end example

El 
@geindex Python Enhancement Proposals; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} permite resolver este problema al permitir escribir el código anterior sin una clase base explícita en la definición de la clase, permitiendo que el Validador estático de tipo considere implícitamente que @code{Bucket} es un subtipo tanto de @code{Sized} como de @code{Iterable[int]}. Esto se conoce como tipado `estructural' (o `duck-typing' estático):

@example
from collections.abc import Iterator, Iterable

class Bucket:  # Note: no base classes
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket())  # Passes type check
@end example

Asimismo, creando subclases de la clase especial  @ref{3bb,,Protocol}, el usuario puede definir nuevos protocolos personalizados y beneficiarse del tipado estructural (véanse los ejemplos de abajo).

@node Contenido del módulo<3>,Línea de tiempo de obsolescencia de características principales,Subtipado nominal vs estructural,typing — Soporte para type hints
@anchor{library/typing module-contents}@anchor{3ea3}
@subsubsection Contenido del módulo


The @code{typing} module defines the following classes, functions and decorators.

@menu
* Primitivos especiales de tipado:: 
* Protocolos: Protocolos<3>. 
* ABCs for working with IO:: 
* Funciones y decoradores:: 
* Ayudas de introspección:: 
* Constantes: Constantes<10>. 
* Deprecated aliases:: 

@end menu

@node Primitivos especiales de tipado,Protocolos<3>,,Contenido del módulo<3>
@anchor{library/typing special-typing-primitives}@anchor{3ea4}
@subsubsection Primitivos especiales de tipado


@menu
* Tipos especiales:: 
* Formas especiales:: 
* Building generic types and type aliases:: 
* Otras directivas especiales:: 

@end menu

@node Tipos especiales,Formas especiales,,Primitivos especiales de tipado
@anchor{library/typing special-types}@anchor{3ea5}
@subsubsection Tipos especiales


These can be used as types in annotations. They do not support subscription
using @code{[]}.

@geindex Any (en el módulo typing)
@anchor{library/typing typing Any}@anchor{74d}
@deffn {Dato} typing.Any

Tipo especial que indica un tipo sin restricciones.


@itemize *

@item 
Todos los tipos son compatibles con @ref{74d,,Any}.

@item 
@ref{74d,,Any} es compatible con todos los tipos.
@end itemize


Distinto en la versión 3.11: @ref{74d,,Any} can now be used as a base class. This can be useful for
avoiding type checker errors with classes that can duck type anywhere or
are highly dynamic.

@end deffn

@geindex AnyStr (en el módulo typing)
@anchor{library/typing typing AnyStr}@anchor{3fb}
@deffn {Dato} typing.AnyStr

A @ref{3ea6,,constrained type variable}.

Definition:

@example
AnyStr = TypeVar('AnyStr', str, bytes)
@end example

@code{AnyStr} is meant to be used for functions that may accept @ref{237,,str} or
@ref{325,,bytes} arguments but cannot allow the two to mix.

Por ejemplo:

@example
def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    return a + b

concat("foo", "bar")    # OK, output has type 'str'
concat(b"foo", b"bar")  # OK, output has type 'bytes'
concat("foo", b"bar")   # Error, cannot mix str and bytes
@end example

Note that, despite its name, @code{AnyStr} has nothing to do with the
@ref{74d,,Any} type, nor does it mean «any string». In particular, @code{AnyStr}
and @code{str | bytes} are different from each other and have different use
cases:

@example
# Invalid use of AnyStr:
# The type variable is used only once in the function signature,
# so cannot be "solved" by the type checker
def greet_bad(cond: bool) -> AnyStr:
    return "hi there!" if cond else b"greetings!"

# The better way of annotating this function:
def greet_proper(cond: bool) -> str | bytes:
    return "hi there!" if cond else b"greetings!"
@end example


Deprecated since version 3.13, will be removed in version 3.18: Deprecated in favor of the new @ref{3fc,,type parameter syntax}.
Use @code{class A[T: (str, bytes)]: ...} instead of importing @code{AnyStr}. See
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} for more details.

In Python 3.16, @code{AnyStr} will be removed from @code{typing.__all__}, and
deprecation warnings will be emitted at runtime when it is accessed or
imported from @code{typing}. @code{AnyStr} will be removed from @code{typing}
in Python 3.18.

@end deffn

@geindex LiteralString (en el módulo typing)
@anchor{library/typing typing LiteralString}@anchor{66b}
@deffn {Dato} typing.LiteralString

Special type that includes only literal strings.

Any string
literal is compatible with @code{LiteralString}, as is another
@code{LiteralString}. However, an object typed as just @code{str} is not.
A string created by composing @code{LiteralString}-typed objects
is also acceptable as a @code{LiteralString}.

Example:

@example
def run_query(sql: LiteralString) -> None:
    ...

def caller(arbitrary_string: str, literal_string: LiteralString) -> None:
    run_query("SELECT * FROM students")  # OK
    run_query(literal_string)  # OK
    run_query("SELECT * FROM " + literal_string)  # OK
    run_query(arbitrary_string)  # type checker error
    run_query(  # type checker error
        f"SELECT * FROM students WHERE name = @{arbitrary_string@}"
    )
@end example

@code{LiteralString} is useful for sensitive APIs where arbitrary user-generated
strings could generate problems. For example, the two cases above
that generate type checker errors could be vulnerable to an SQL
injection attack.

Véase 
@geindex Python Enhancement Proposals; PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} para más detalle.


Added in version 3.11.

@end deffn

@geindex Never (en el módulo typing)
@geindex NoReturn (en el módulo typing)
@anchor{library/typing typing Never}@anchor{749}
@deffn {Dato} typing.Never
@anchor{library/typing typing NoReturn}@anchor{3ea7}
@deffnx {Dato} typing.NoReturn

@code{Never} and @code{NoReturn} represent the
bottom type@footnote{https://en.wikipedia.org/wiki/Bottom_type},
a type that has no members.

They can be used to indicate that a function never returns,
such as @ref{13b0,,sys.exit()}:

@example
from typing import Never  # or NoReturn

def stop() -> Never:
    raise RuntimeError('no way')
@end example

Or to define a function that should never be
called, as there are no valid arguments, such as
@ref{748,,assert_never()}:

@example
from typing import Never  # or NoReturn

def never_call_me(arg: Never) -> None:
    pass

def int_or_str(arg: int | str) -> None:
    never_call_me(arg)  # type checker error
    match arg:
        case int():
            print("It's an int")
        case str():
            print("It's a str")
        case _:
            never_call_me(arg)  # OK, arg is of type Never (or NoReturn)
@end example

@code{Never} and @code{NoReturn} have the same meaning in the type system
and static type checkers treat both equivalently.


Added in version 3.6.2: Added @ref{3ea7,,NoReturn}.



Added in version 3.11: Added @ref{749,,Never}.

@end deffn

@geindex Self (en el módulo typing)
@anchor{library/typing typing Self}@anchor{668}
@deffn {Dato} typing.Self

Special type to represent the current enclosed class.

Por ejemplo:

@example
from typing import Self, reveal_type

class Foo:
    def return_self(self) -> Self:
        ...
        return self

class SubclassOfFoo(Foo): pass

reveal_type(Foo().return_self())  # Revealed type is "Foo"
reveal_type(SubclassOfFoo().return_self())  # Revealed type is "SubclassOfFoo"
@end example

Esta anotación es semánticamente equivalente a lo siguiente, aunque de una manera más sucinta:

@example
from typing import TypeVar

Self = TypeVar("Self", bound="Foo")

class Foo:
    def return_self(self: Self) -> Self:
        ...
        return self
@end example

In general, if something returns @code{self}, as in the above examples, you
should use @code{Self} as the return annotation. If @code{Foo.return_self} was
annotated as returning @code{"Foo"}, then the type checker would infer the
object returned from @code{SubclassOfFoo.return_self} as being of type @code{Foo}
rather than @code{SubclassOfFoo}.

Otros casos de uso comunes incluyen:


@itemize -

@item 
@ref{2d2,,classmethod} usados como constructores alternativos y retornan instancias del parámetro @code{cls}.

@item 
Anotar un método @ref{669,,__enter__()} que retorna self.
@end itemize

You should not use @code{Self} as the return annotation if the method is not
guaranteed to return an instance of a subclass when the class is
subclassed:

@example
class Eggs:
    # Self would be an incorrect return annotation here,
    # as the object returned is always an instance of Eggs,
    # even in subclasses
    def returns_eggs(self) -> "Eggs":
        return Eggs()
@end example

Véase 
@geindex Python Enhancement Proposals; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} para más detalle.


Added in version 3.11.

@end deffn

@geindex TypeAlias (en el módulo typing)
@anchor{library/typing typing TypeAlias}@anchor{862}
@deffn {Dato} typing.TypeAlias

Special annotation for explicitly declaring a @ref{500,,type alias}.

Por ejemplo:

@example
from typing import TypeAlias

Factors: TypeAlias = list[int]
@end example

@code{TypeAlias} is particularly useful on older Python versions for annotating
aliases that make use of forward references, as it can be hard for type
checkers to distinguish these from normal variable assignments:

@example
from typing import Generic, TypeAlias, TypeVar

T = TypeVar("T")

# "Box" does not exist yet,
# so we have to use quotes for the forward reference on Python <3.12.
# Using `@w{`}TypeAlias`@w{`} tells the type checker that this is a type alias declaration,
# not a variable assignment to a string.
BoxOfStrings: TypeAlias = "Box[str]"

class Box(Generic[T]):
    @@classmethod
    def make_box_of_strings(cls) -> BoxOfStrings: ...
@end example

See 
@geindex Python Enhancement Proposals; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} for more details.


Added in version 3.10.



Obsoleto desde la versión 3.12: @ref{862,,TypeAlias} is deprecated in favor of the @ref{4e6,,type} statement,
which creates instances of @ref{501,,TypeAliasType}
and which natively supports forward references.
Note that while @ref{862,,TypeAlias} and @ref{501,,TypeAliasType} serve
similar purposes and have similar names, they are distinct and the
latter is not the type of the former.
Removal of @ref{862,,TypeAlias} is not currently planned, but users
are encouraged to migrate to @ref{4e6,,type} statements.

@end deffn

@node Formas especiales,Building generic types and type aliases,Tipos especiales,Primitivos especiales de tipado
@anchor{library/typing special-forms}@anchor{3ea8}
@subsubsection Formas especiales


These can be used as types in annotations. They all support subscription using
@code{[]}, but each has a unique syntax.

@geindex Union (en el módulo typing)
@anchor{library/typing typing Union}@anchor{6dc}
@deffn {Dato} typing.Union

Tipo de unión; @code{Union[X, Y]} es equivalente a @code{X | Y} y significa X o Y.

Para definir una unión, use p. ej. @code{Union[int, str]} o la abreviatura @code{int | str}. Se recomienda el uso de la abreviatura. Detalles:


@itemize *

@item 
Los argumentos deben ser tipos y haber al menos uno.

@item 
Las uniones de uniones se simplifican (se aplanan), p. ej.:

@example
Union[Union[int, str], float] == Union[int, str, float]
@end example

@item 
Las uniones con un solo argumento se eliminan, p. ej.:

@example
Union[int] == int  # The constructor actually returns int
@end example

@item 
Argumentos repetidos se omiten, p. ej.:

@example
Union[int, str, int] == Union[int, str] == int | str
@end example

@item 
Cuando se comparan uniones, el orden de los argumentos se ignoran, p. ej.:

@example
Union[int, str] == Union[str, int]
@end example

@item 
No es posible crear una subclase o instanciar un @code{Union}.

@item 
No es posible escribir @code{Union[X][Y]}.
@end itemize


Distinto en la versión 3.7: No elimina subclases explícitas de una unión en tiempo de ejecución.



Distinto en la versión 3.10: Las uniones ahora se pueden escribir como @code{X | Y}. Consulte @ref{85b,,union type expressions}.

@end deffn

@geindex Optional (en el módulo typing)
@anchor{library/typing typing Optional}@anchor{754}
@deffn {Dato} typing.Optional

@code{Optional[X]} es equivalente a @code{X | None} (o @code{Union[X, None]}).

Nótese que no es lo mismo que un argumento opcional, que es aquel que tiene un valor por defecto. Un argumento opcional con un valor por defecto no necesita el indicador @code{Optional} en su anotación de tipo simplemente por que sea opcional. Por ejemplo:

@example
def foo(arg: int = 0) -> None:
    ...
@end example

Por otro lado, si se permite un valor @code{None}, es apropiado el uso de @code{Optional}, independientemente de que sea opcional o no. Por ejemplo:

@example
def foo(arg: Optional[int] = None) -> None:
    ...
@end example


Distinto en la versión 3.10: Optional ahora se puede escribir como @code{X | None}. Consulte @ref{85b,,union type expressions}.

@end deffn

@geindex Concatenate (en el módulo typing)
@anchor{library/typing typing Concatenate}@anchor{85d}
@deffn {Dato} typing.Concatenate

Special form for annotating higher-order functions.

@code{Concatenate} can be used in conjunction with @ref{2526,,Callable} and
@ref{2ca,,ParamSpec} to annotate a higher-order callable which adds, removes,
or transforms parameters of another
callable.  Usage is in the form
@code{Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]}. @code{Concatenate}
is currently only valid when used as the first argument to a @ref{2526,,Callable}.
The last parameter to @code{Concatenate} must be a @ref{2ca,,ParamSpec} or
ellipsis (@code{...}).

Por ejemplo, para anotar un decorador @code{with_lock} que proporciona un @ref{1682,,threading.Lock} a la función decorada, @code{Concatenate} puede usarse para indicar que @code{with_lock} espera un invocable que toma un @code{Lock} como primer argumento y retorna un invocable con un tipo de firma diferente. En este caso, el @ref{2ca,,ParamSpec} indica que los tipos de parámetros de los invocables retornados dependen de los tipos de parámetros de los invocables que se pasan en

@example
from collections.abc import Callable
from threading import Lock
from typing import Concatenate

# Use this lock to ensure that only one thread is executing a function
# at any time.
my_lock = Lock()

def with_lock[**P, R](f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '@w{'}'A type-safe decorator which provides a lock.'@w{'}'
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        # Provide the lock as the first argument.
        return f(my_lock, *args, **kwargs)
    return inner

@@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '@w{'}'Add a list of numbers together in a thread-safe manner.'@w{'}'
    with lock:
        return sum(numbers)

# We don't need to pass in the lock ourselves thanks to the decorator.
sum_threadsafe([1.1, 2.2, 3.3])
@end example


Added in version 3.10.



@subsubheading Ver también



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} – Parameter Specification Variables (the PEP which introduced
@code{ParamSpec} and @code{Concatenate})

@item 
@ref{2ca,,ParamSpec}

@item 
@ref{2526,,Annotating callable objects}
@end itemize

@end deffn

@geindex Literal (en el módulo typing)
@anchor{library/typing typing Literal}@anchor{8ec}
@deffn {Dato} typing.Literal

Special typing form to define «literal types».

@code{Literal} can be used to indicate to type checkers that the
annotated object has a value equivalent to one of the
provided literals.

Por ejemplo:

@example
def validate_simple(data: Any) -> Literal[True]:  # always returns True
    ...

type Mode = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: Mode) -> str:
    ...

open_helper('/some/path', 'r')      # Passes type check
open_helper('/other/path', 'typo')  # Error in type checker
@end example

@code{Literal[...]} no puede ser derivado. En tiempo de ejecución, se permite un valor arbitrario como argumento de tipo de @code{Literal[...]}, pero los validadores de tipos pueden imponer sus restricciones. Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} para más detalles sobre tipos literales.


Added in version 3.8.



Distinto en la versión 3.9.1: @code{Literal} ahora elimina los parámetros duplicados. Las comparaciones de igualdad de los objetos @code{Literal} ya no dependen del orden. Los objetos @code{Literal} ahora lanzarán una excepción @ref{228,,TypeError} durante las comparaciones de igualdad si uno de sus parámetros no es @ref{6b1,,hashable}.

@end deffn

@geindex ClassVar (en el módulo typing)
@anchor{library/typing typing ClassVar}@anchor{3bd}
@deffn {Dato} typing.ClassVar

Construcción especial para tipado para marcar variables de clase.

Tal y como introduce 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, una anotación de variable rodeada por ClassVar indica que la intención de un atributo dado es ser usado como variable de clase y que no debería ser modificado en las instancias de esa misma clase. Uso:

@example
class Starship:
    stats: ClassVar[dict[str, int]] = @{@} # class variable
    damage: int = 10                     # instance variable
@end example

@ref{3bd,,ClassVar} solo acepta tipos y no admite más niveles de subíndices.

@ref{3bd,,ClassVar} no es un clase en sí misma, y no debe ser usado con @ref{4ef,,isinstance()} o @ref{85a,,issubclass()}. @ref{3bd,,ClassVar} no modifica el comportamiento de Python en tiempo de ejecución pero puede ser utilizado por validadores de terceros. Por ejemplo, un validador de tipos puede marcar el siguiente código como erróneo:

@example
enterprise_d = Starship(3000)
enterprise_d.stats = @{@} # Error, setting class variable on instance
Starship.stats = @{@}     # This is OK
@end example


Added in version 3.5.3.



Distinto en la versión 3.13: @ref{3bd,,ClassVar} can now be nested in @ref{3be,,Final} and vice versa.

@end deffn

@geindex Final (en el módulo typing)
@anchor{library/typing typing Final}@anchor{3be}
@deffn {Dato} typing.Final

Special typing construct to indicate final names to type checkers.

Final names cannot be reassigned in any scope. Final names declared in class
scopes cannot be overridden in subclasses.

Por ejemplo:

@example
MAX_SIZE: Final = 9000
MAX_SIZE += 1  # Error reported by type checker

class Connection:
    TIMEOUT: Final[int] = 10

class FastConnector(Connection):
    TIMEOUT = 1  # Error reported by type checker
@end example

No hay comprobación en tiempo de ejecución para estas propiedades. Véase 
@geindex Python Enhancement Proposals; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/} para más detalles.


Added in version 3.8.



Distinto en la versión 3.13: @ref{3be,,Final} can now be nested in @ref{3bd,,ClassVar} and vice versa.

@end deffn

@geindex Required (en el módulo typing)
@anchor{library/typing typing Required}@anchor{665}
@deffn {Dato} typing.Required

Special typing construct to mark a @ref{2ce,,TypedDict} key as required.

This is mainly useful for @code{total=False} TypedDicts. See @ref{2ce,,TypedDict}
and 
@geindex Python Enhancement Proposals; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} for more details.


Added in version 3.11.

@end deffn

@geindex NotRequired (en el módulo typing)
@anchor{library/typing typing NotRequired}@anchor{666}
@deffn {Dato} typing.NotRequired

Special typing construct to mark a @ref{2ce,,TypedDict} key as potentially
missing.

Véase @ref{2ce,,TypedDict} y 
@geindex Python Enhancement Proposals; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} para más detalle.


Added in version 3.11.

@end deffn

@geindex ReadOnly (en el módulo typing)
@anchor{library/typing typing ReadOnly}@anchor{2cd}
@deffn {Dato} typing.ReadOnly

A special typing construct to mark an item of a @ref{2ce,,TypedDict} as read-only.

Por ejemplo:

@example
class Movie(TypedDict):
   title: ReadOnly[str]
   year: int

def mutate_movie(m: Movie) -> None:
   m["year"] = 1999  # allowed
   m["title"] = "The Matrix"  # typechecker error
@end example

There is no runtime checking for this property.

See @ref{2ce,,TypedDict} and 
@geindex Python Enhancement Proposals; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/} for more details.


Added in version 3.13.

@end deffn

@geindex Annotated (en el módulo typing)
@anchor{library/typing typing Annotated}@anchor{9d0}
@deffn {Dato} typing.Annotated

Special typing form to add context-specific metadata to an annotation.

Add metadata @code{x} to a given type @code{T} by using the annotation
@code{Annotated[T, x]}. Metadata added using @code{Annotated} can be used by
static analysis tools or at runtime. At runtime, the metadata is stored
in a @code{__metadata__} attribute.

If a library or tool encounters an annotation @code{Annotated[T, x]} and has
no special logic for the metadata, it should ignore the metadata and simply
treat the annotation as @code{T}. As such, @code{Annotated} can be useful for code
that wants to use annotations for purposes outside Python’s static typing
system.

Using @code{Annotated[T, x]} as an annotation still allows for static
typechecking of @code{T}, as type checkers will simply ignore the metadata @code{x}.
In this way, @code{Annotated} differs from the
@ref{755,,@@no_type_check} decorator, which can also be used for
adding annotations outside the scope of the typing system, but
completely disables typechecking for a function or class.

The responsibility of how to interpret the metadata
lies with the tool or library encountering an
@code{Annotated} annotation. A tool or library encountering an @code{Annotated} type
can scan through the metadata elements to determine if they are of interest
(e.g., using @ref{4ef,,isinstance()}).


@deffn {Describe} Annotated[<type>, <metadata>]
@end deffn

Here is an example of how you might use @code{Annotated} to add metadata to
type annotations if you were doing range analysis:

@example
@@dataclass
class ValueRange:
    lo: int
    hi: int

T1 = Annotated[int, ValueRange(-10, 5)]
T2 = Annotated[T1, ValueRange(-20, 3)]
@end example

Details of the syntax:


@itemize *

@item 
El primer argumento en @code{Annotated} debe ser un tipo válido

@item 
Multiple metadata elements can be supplied (@code{Annotated} supports variadic
arguments):

@example
@@dataclass
class ctype:
    kind: str

Annotated[int, ValueRange(3, 10), ctype("char")]
@end example

It is up to the tool consuming the annotations to decide whether the
client is allowed to add multiple metadata elements to one annotation and how to
merge those annotations.

@item 
@code{Annotated} must be subscripted with at least two arguments (
@code{Annotated[int]} is not valid)

@item 
The order of the metadata elements is preserved and matters for equality
checks:

@example
assert Annotated[int, ValueRange(3, 10), ctype("char")] != Annotated[
    int, ctype("char"), ValueRange(3, 10)
]
@end example

@item 
Nested @code{Annotated} types are flattened. The order of the metadata elements
starts with the innermost annotation:

@example
assert Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
    int, ValueRange(3, 10), ctype("char")
]
@end example

@item 
Duplicated metadata elements are not removed:

@example
assert Annotated[int, ValueRange(3, 10)] != Annotated[
    int, ValueRange(3, 10), ValueRange(3, 10)
]
@end example

@item 
@code{Annotated} can be used with nested and generic aliases:

@example
@@dataclass
class MaxLen:
    value: int

type Vec[T] = Annotated[list[tuple[T, T]], MaxLen(10)]

# When used in a type annotation, a type checker will treat "V" the same as
# `@w{`}Annotated[list[tuple[int, int]], MaxLen(10)]`@w{`}:
type V = Vec[int]
@end example

@item 
@code{Annotated} cannot be used with an unpacked @ref{2cb,,TypeVarTuple}:

@example
type Variadic[*Ts] = Annotated[*Ts, Ann1]  # NOT valid
@end example

This would be equivalent to:

@example
Annotated[T1, T2, T3, ..., Ann1]
@end example

where @code{T1}, @code{T2}, etc. are @ref{2c9,,TypeVars}. This would be
invalid: only one type should be passed to Annotated.

@item 
By default, @ref{752,,get_type_hints()} strips the metadata from annotations.
Pass @code{include_extras=True} to have the metadata preserved:

@example
>>> from typing import Annotated, get_type_hints
>>> def func(x: Annotated[int, "metadata"]) -> None: pass
...
>>> get_type_hints(func)
@{'x': <class 'int'>, 'return': <class 'NoneType'>@}
>>> get_type_hints(func, include_extras=True)
@{'x': typing.Annotated[int, 'metadata'], 'return': <class 'NoneType'>@}
@end example

@item 
At runtime, the metadata associated with an @code{Annotated} type can be
retrieved via the @code{__metadata__} attribute:

@example
>>> from typing import Annotated
>>> X = Annotated[int, "very", "important", "metadata"]
>>> X
typing.Annotated[int, 'very', 'important', 'metadata']
>>> X.__metadata__
('very', 'important', 'metadata')
@end example

@item 
At runtime, if you want to retrieve the original
type wrapped by @code{Annotated}, use the @code{__origin__} attribute:

@example
>>> from typing import Annotated, get_origin
>>> Password = Annotated[str, "secret"]
>>> Password.__origin__
<class 'str'>
@end example

Note that using @ref{ad9,,get_origin()} will return @code{Annotated} itself:

@example
>>> get_origin(Password)
typing.Annotated
@end example
@end itemize


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 593

@item PEP 593@footnote{https://peps.python.org/pep-0593/} - Flexible function and variable annotations

The PEP introducing @code{Annotated} to the standard library.
@end table



Added in version 3.9.

@end deffn

@geindex TypeIs (en el módulo typing)
@anchor{library/typing typing TypeIs}@anchor{2cf}
@deffn {Dato} typing.TypeIs

Special typing construct for marking user-defined type predicate functions.

@code{TypeIs} can be used to annotate the return type of a user-defined
type predicate function.  @code{TypeIs} only accepts a single type argument.
At runtime, functions marked this way should return a boolean and take at
least one positional argument.

@code{TypeIs} aims to benefit `type narrowing' – a technique used by static
type checkers to determine a more precise type of an expression within a
program’s code flow.  Usually type narrowing is done by analyzing
conditional code flow and applying the narrowing to a block of code.  The
conditional expression here is sometimes referred to as a «type predicate»:

@example
def is_str(val: str | float):
    # "isinstance" type predicate
    if isinstance(val, str):
        # Type of `@w{`}val`@w{`} is narrowed to `@w{`}str`@w{`}
        ...
    else:
        # Else, type of `@w{`}val`@w{`} is narrowed to `@w{`}float`@w{`}.
        ...
@end example

Sometimes it would be convenient to use a user-defined boolean function
as a type predicate.  Such a function should use @code{TypeIs[...]} or
@ref{2d0,,TypeGuard} as its return type to alert static type checkers to
this intention.  @code{TypeIs} usually has more intuitive behavior than
@code{TypeGuard}, but it cannot be used when the input and output types
are incompatible (e.g., @code{list[object]} to @code{list[int]}) or when the
function does not return @code{True} for all instances of the narrowed type.

Using  @code{-> TypeIs[NarrowedType]} tells the static type checker that for a given
function:


@enumerate 

@item 
El valor de retorno es un booleano.

@item 
If the return value is @code{True}, the type of its argument
is the intersection of the argument’s original type and @code{NarrowedType}.

@item 
If the return value is @code{False}, the type of its argument
is narrowed to exclude @code{NarrowedType}.
@end enumerate

Por ejemplo:

@example
from typing import assert_type, final, TypeIs

class Parent: pass
class Child(Parent): pass
@@final
class Unrelated: pass

def is_parent(val: object) -> TypeIs[Parent]:
    return isinstance(val, Parent)

def run(arg: Child | Unrelated):
    if is_parent(arg):
        # Type of `@w{`}arg`@w{`} is narrowed to the intersection
        # of `@w{`}Parent`@w{`} and `@w{`}Child`@w{`}, which is equivalent to
        # `@w{`}Child`@w{`}.
        assert_type(arg, Child)
    else:
        # Type of `@w{`}arg`@w{`} is narrowed to exclude `@w{`}Parent`@w{`},
        # so only `@w{`}Unrelated`@w{`} is left.
        assert_type(arg, Unrelated)
@end example

The type inside @code{TypeIs} must be consistent with the type of the
function’s argument; if it is not, static type checkers will raise
an error.  An incorrectly written @code{TypeIs} function can lead to
unsound behavior in the type system; it is the user’s responsibility
to write such functions in a type-safe manner.

If a @code{TypeIs} function is a class or instance method, then the type in
@code{TypeIs} maps to the type of the second parameter (after @code{cls} or
@code{self}).

In short, the form @code{def foo(arg: TypeA) -> TypeIs[TypeB]: ...},
means that if @code{foo(arg)} returns @code{True}, then @code{arg} is an instance
of @code{TypeB}, and if it returns @code{False}, it is not an instance of @code{TypeB}.

@code{TypeIs} also works with type variables.  For more information, see
@geindex Python Enhancement Proposals; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/} (Narrowing types with @code{TypeIs}).


Added in version 3.13.

@end deffn

@geindex TypeGuard (en el módulo typing)
@anchor{library/typing typing TypeGuard}@anchor{2d0}
@deffn {Dato} typing.TypeGuard

Special typing construct for marking user-defined type predicate functions.

Type predicate functions are user-defined functions that return whether their
argument is an instance of a particular type.
@code{TypeGuard} works similarly to @ref{2cf,,TypeIs}, but has subtly different
effects on type checking behavior (see below).

El uso de @code{-> TypeGuard} le dice al verificador de tipo estático que para una función determinada:


@enumerate 

@item 
El valor de retorno es un booleano.

@item 
Si el valor de retorno es @code{True}, el tipo de su argumento es el tipo dentro de @code{TypeGuard}.
@end enumerate

@code{TypeGuard} también funciona con variables de tipo. Véase 
@geindex Python Enhancement Proposals; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/} para más detalles.

Por ejemplo:

@example
def is_str_list(val: list[object]) -> TypeGuard[list[str]]:
    '@w{'}'Determines whether all objects in the list are strings'@w{'}'
    return all(isinstance(x, str) for x in val)

def func1(val: list[object]):
    if is_str_list(val):
        # Type of `@w{`}val`@w{`} is narrowed to `@w{`}list[str]`@w{`}.
        print(" ".join(val))
    else:
        # Type of `@w{`}val`@w{`} remains as `@w{`}list[object]`@w{`}.
        print("Not a list of strings!")
@end example

@code{TypeIs} and @code{TypeGuard} differ in the following ways:


@itemize *

@item 
@code{TypeIs} requires the narrowed type to be a subtype of the input type, while
@code{TypeGuard} does not.  The main reason is to allow for things like
narrowing @code{list[object]} to @code{list[str]} even though the latter
is not a subtype of the former, since @code{list} is invariant.

@item 
When a @code{TypeGuard} function returns @code{True}, type checkers narrow the type of the
variable to exactly the @code{TypeGuard} type. When a @code{TypeIs} function returns @code{True},
type checkers can infer a more precise type combining the previously known type of the
variable with the @code{TypeIs} type. (Technically, this is known as an intersection type.)

@item 
When a @code{TypeGuard} function returns @code{False}, type checkers cannot narrow the type of
the variable at all. When a @code{TypeIs} function returns @code{False}, type checkers can narrow
the type of the variable to exclude the @code{TypeIs} type.
@end itemize


Added in version 3.10.

@end deffn

@geindex Unpack (en el módulo typing)
@anchor{library/typing typing Unpack}@anchor{163b}
@deffn {Dato} typing.Unpack

Typing operator to conceptually mark an object as having been unpacked.

For example, using the unpack operator @code{*} on a
@ref{3ea9,,type variable tuple} is equivalent to using @code{Unpack}
to mark the type variable tuple as having been unpacked:

@example
Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]
# Effectively does:
tup: tuple[Unpack[Ts]]
@end example

In fact, @code{Unpack} can be used interchangeably with @code{*} in the context
of @ref{2cb,,typing.TypeVarTuple} and
@ref{464,,builtins.tuple} types. You might see @code{Unpack} being used
explicitly in older versions of Python, where @code{*} couldn’t be used in
certain places:

@example
# In older versions of Python, TypeVarTuple and Unpack
# are located in the `typing_extensions` backports package.
from typing_extensions import TypeVarTuple, Unpack

Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]         # Syntax error on Python <= 3.10!
tup: tuple[Unpack[Ts]]  # Semantically equivalent, and backwards-compatible
@end example

@code{Unpack} can also be used along with @ref{2ce,,typing.TypedDict} for typing
@code{**kwargs} in a function signature:

@example
from typing import TypedDict, Unpack

class Movie(TypedDict):
    name: str
    year: int

# This function expects two keyword arguments - `name` of type `str`
# and `year` of type `int`.
def foo(**kwargs: Unpack[Movie]): ...
@end example

See 
@geindex Python Enhancement Proposals; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} for more details on using @code{Unpack} for @code{**kwargs} typing.


Added in version 3.11.

@end deffn

@node Building generic types and type aliases,Otras directivas especiales,Formas especiales,Primitivos especiales de tipado
@anchor{library/typing building-generic-types-and-type-aliases}@anchor{3eaa}
@subsubsection Building generic types and type aliases


The following classes should not be used directly as annotations.
Their intended purpose is to be building blocks
for creating generic types and type aliases.

These objects can be created through special syntax
(@ref{3fc,,type parameter lists} and the @ref{4e6,,type} statement).
For compatibility with Python 3.11 and earlier, they can also be created
without the dedicated syntax, as documented below.

@geindex Generic (clase en typing)
@anchor{library/typing typing Generic}@anchor{15f6}
@deffn {Clase} typing.Generic

Clase base abstracta para tipos genéricos.

A generic type is typically declared by adding a list of type parameters
after the class name:

@example
class Mapping[KT, VT]:
    def __getitem__(self, key: KT) -> VT:
        ...
        # Etc.
@end example

Such a class implicitly inherits from @code{Generic}.
The runtime semantics of this syntax are discussed in the
@ref{4fe,,Language Reference}.

Entonces, esta clase se puede usar como sigue:

@example
def lookup_name[X, Y](mapping: Mapping[X, Y], key: X, default: Y) -> Y:
    try:
        return mapping[key]
    except KeyError:
        return default
@end example

Here the brackets after the function name indicate a
@ref{4ff,,generic function}.

For backwards compatibility, generic classes can also be
declared by explicitly inheriting from
@code{Generic}. In this case, the type parameters must be declared
separately:

@example
KT = TypeVar('KT')
VT = TypeVar('VT')

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
        # Etc.
@end example
@end deffn

@geindex TypeVar (clase en typing)
@anchor{library/typing typevar}@anchor{3ea0}@anchor{library/typing typing TypeVar}@anchor{2c9}
@deffn {Clase} typing.TypeVar (name, *constraints, bound=None, covariant=False, contravariant=False, infer_variance=False, default=typing.NoDefault)

Variable de tipo.

The preferred way to construct a type variable is via the dedicated syntax
for @ref{4ff,,generic functions},
@ref{4fe,,generic classes}, and
@ref{502,,generic type aliases}:

@example
class Sequence[T]:  # T is a TypeVar
    ...
@end example

This syntax can also be used to create bounded and constrained type
variables:

@example
class StrSequence[S: str]:  # S is a TypeVar with a `str` upper bound;
    ...                     # we can say that S is "bounded by `str`"


class StrOrBytesSequence[A: (str, bytes)]:  # A is a TypeVar constrained to str or bytes
    ...
@end example

However, if desired, reusable type variables can also be constructed manually, like so:

@example
T = TypeVar('T')  # Can be anything
S = TypeVar('S', bound=str)  # Can be any subtype of str
A = TypeVar('A', str, bytes)  # Must be exactly str or bytes
@end example

Type variables exist primarily for the benefit of static type
checkers.  They serve as the parameters for generic types as well
as for generic function and type alias definitions.
See @ref{15f6,,Generic} for more
information on generic types.  Generic functions work as follows:

@example
def repeat[T](x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x]*n


def print_capitalized[S: str](x: S) -> S:
    """Print x capitalized, and return x."""
    print(x.capitalize())
    return x


def concatenate[A: (str, bytes)](x: A, y: A) -> A:
    """Add two strings or bytes objects together."""
    return x + y
@end example

Note that type variables can be `bounded', `constrained', or neither, but
cannot be both bounded `and' constrained.

The variance of type variables is inferred by type checkers when they are created
through the @ref{3fc,,type parameter syntax} or when
@code{infer_variance=True} is passed.
Manually created type variables may be explicitly marked covariant or contravariant by passing
@code{covariant=True} or @code{contravariant=True}.
By default, manually created type variables are invariant.
See 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} and 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} for more details.

Bounded type variables and constrained type variables have different
semantics in several important ways. Using a `bounded' type variable means
that the @code{TypeVar} will be solved using the most specific type possible:

@example
x = print_capitalized('a string')
reveal_type(x)  # revealed type is str

class StringSubclass(str):
    pass

y = print_capitalized(StringSubclass('another string'))
reveal_type(y)  # revealed type is StringSubclass

z = print_capitalized(45)  # error: int is not a subtype of str
@end example

The upper bound of a type variable can be a concrete type, abstract type
(ABC or Protocol), or even a union of types:

@example
# Can be anything with an __abs__ method
def print_abs[T: SupportsAbs](arg: T) -> None:
    print("Absolute value:", abs(arg))

U = TypeVar('U', bound=str|bytes)  # Can be any subtype of the union str|bytes
V = TypeVar('V', bound=SupportsAbs)  # Can be anything with an __abs__ method
@end example
@anchor{library/typing typing-constrained-typevar}@anchor{3ea6}
Sin embargo, usar una variable de tipo `constrained' significa que la @code{TypeVar} sólo podrá ser determinada como exactamente una de las restricciones dadas:

@example
a = concatenate('one', 'two')
reveal_type(a)  # revealed type is str

b = concatenate(StringSubclass('one'), StringSubclass('two'))
reveal_type(b)  # revealed type is str, despite StringSubclass being passed in

c = concatenate('one', b'two')  # error: type variable 'A' can be either str or bytes in a function call, but not both
@end example

At runtime, @code{isinstance(x, T)} will raise @ref{228,,TypeError}.

@geindex __name__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __name__}@anchor{3eab}
@deffn {Atributo} __name__

The name of the type variable.
@end deffn

@geindex __covariant__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __covariant__}@anchor{3eac}
@deffn {Atributo} __covariant__

Whether the type var has been explicitly marked as covariant.
@end deffn

@geindex __contravariant__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __contravariant__}@anchor{3ead}
@deffn {Atributo} __contravariant__

Whether the type var has been explicitly marked as contravariant.
@end deffn

@geindex __infer_variance__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __infer_variance__}@anchor{3eae}
@deffn {Atributo} __infer_variance__

Whether the type variable’s variance should be inferred by type checkers.


Added in version 3.12.

@end deffn

@geindex __bound__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __bound__}@anchor{3eaf}
@deffn {Atributo} __bound__

The upper bound of the type variable, if any.


Distinto en la versión 3.12: For type variables created through @ref{3fc,,type parameter syntax},
the bound is evaluated only when the attribute is accessed, not when
the type variable is created (see @ref{503,,Evaluación perezosa}).

@end deffn

@geindex evaluate_bound() (método de typing.TypeVar)
@anchor{library/typing typing TypeVar evaluate_bound}@anchor{3eb0}
@deffn {Método} evaluate_bound ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3eaf,,__bound__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3eaf,,__bound__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format.


Added in version 3.14.

@end deffn

@geindex __constraints__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __constraints__}@anchor{3eb3}
@deffn {Atributo} __constraints__

A tuple containing the constraints of the type variable, if any.


Distinto en la versión 3.12: For type variables created through @ref{3fc,,type parameter syntax},
the constraints are evaluated only when the attribute is accessed, not when
the type variable is created (see @ref{503,,Evaluación perezosa}).

@end deffn

@geindex evaluate_constraints() (método de typing.TypeVar)
@anchor{library/typing typing TypeVar evaluate_constraints}@anchor{3eb4}
@deffn {Método} evaluate_constraints ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3eb3,,__constraints__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3eb3,,__constraints__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format.


Added in version 3.14.

@end deffn

@geindex __default__ (atributo de typing.TypeVar)
@anchor{library/typing typing TypeVar __default__}@anchor{3eb5}
@deffn {Atributo} __default__

The default value of the type variable, or @ref{3b9,,typing.NoDefault} if it
has no default.


Added in version 3.13.

@end deffn

@geindex evaluate_default() (método de typing.TypeVar)
@anchor{library/typing typing TypeVar evaluate_default}@anchor{3eb6}
@deffn {Método} evaluate_default ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3eb5,,__default__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3eb5,,__default__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format.


Added in version 3.14.

@end deffn

@geindex has_default() (método de typing.TypeVar)
@anchor{library/typing typing TypeVar has_default}@anchor{3eb7}
@deffn {Método} has_default ()

Return whether or not the type variable has a default value. This is equivalent
to checking whether @ref{3eb5,,__default__} is not the @ref{3b9,,typing.NoDefault}
singleton, except that it does not force evaluation of the
@ref{503,,lazily evaluated} default value.


Added in version 3.13.

@end deffn


Distinto en la versión 3.12: Type variables can now be declared using the
@ref{3fc,,type parameter} syntax introduced by 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.
The @code{infer_variance} parameter was added.



Distinto en la versión 3.13: Support for default values was added.

@end deffn

@geindex TypeVarTuple (clase en typing)
@anchor{library/typing typevartuple}@anchor{3ea9}@anchor{library/typing typing TypeVarTuple}@anchor{2cb}
@deffn {Clase} typing.TypeVarTuple (name, *, default=typing.NoDefault)

Type variable tuple. A specialized form of @ref{3ea0,,type variable}
that enables `variadic' generics.

Type variable tuples can be declared in @ref{3fc,,type parameter lists}
using a single asterisk (@code{*}) before the name:

@example
def move_first_element_to_last[T, *Ts](tup: tuple[T, *Ts]) -> tuple[*Ts, T]:
    return (*tup[1:], tup[0])
@end example

Or by explicitly invoking the @code{TypeVarTuple} constructor:

@example
T = TypeVar("T")
Ts = TypeVarTuple("Ts")

def move_first_element_to_last(tup: tuple[T, *Ts]) -> tuple[*Ts, T]:
    return (*tup[1:], tup[0])
@end example

Una variable de tipo normal permite parametrizar con un solo tipo. Una tupla de variables de tipo, en contraste, permite la parametrización con un número `arbitrario' de tipos, al actuar como un número `arbitrario' de variables de tipo envueltas en una tupla. Por ejemplo:

@example
# T is bound to int, Ts is bound to ()
# Return value is (1,), which has type tuple[int]
move_first_element_to_last(tup=(1,))

# T is bound to int, Ts is bound to (str,)
# Return value is ('spam', 1), which has type tuple[str, int]
move_first_element_to_last(tup=(1, 'spam'))

# T is bound to int, Ts is bound to (str, float)
# Return value is ('spam', 3.0, 1), which has type tuple[str, float, int]
move_first_element_to_last(tup=(1, 'spam', 3.0))

# This fails to type check (and fails at runtime)
# because tuple[()] is not compatible with tuple[T, *Ts]
# (at least one element is required)
move_first_element_to_last(tup=())
@end example

Nótese el uso del operador de desempaquetado @code{*} en @code{tuple[T, *Ts]}. Conceptualmente, puede pensarse en @code{Ts} como una tupla de variables de tipo @code{(T1, T2, ...)}. @code{tuple[T, *Ts]} se convertiría en @code{tuple[T, *(T1, T2, ...)]}, lo que es equivalente a @code{tuple[T, T1, T2, ...]}. (Nótese que en versiones más antiguas de Python, ésto puede verse escrito usando en cambio @ref{163b,,Unpack}, en la forma @code{Unpack[Ts]}.)

Type variable tuples must `always' be unpacked. This helps distinguish type
variable tuples from normal type variables:

@example
x: Ts          # Not valid
x: tuple[Ts]   # Not valid
x: tuple[*Ts]  # The correct way to do it
@end example

Las tuplas de variables de tipo pueden ser utilizadas en los mismos contextos que las variables de tipo normales. Por ejemplo en definiciones de clases, argumentos y tipos de retorno:

@example
class Array[*Shape]:
    def __getitem__(self, key: tuple[*Shape]) -> float: ...
    def __abs__(self) -> "Array[*Shape]": ...
    def get_shape(self) -> tuple[*Shape]: ...
@end example

Type variable tuples can be happily combined with normal type variables:

@example
class Array[DType, *Shape]:  # This is fine
    pass

class Array2[*Shape, DType]:  # This would also be fine
    pass

class Height: ...
class Width: ...

float_array_1d: Array[float, Height] = Array()     # Totally fine
int_array_2d: Array[int, Height, Width] = Array()  # Yup, fine too
@end example

Sin embargo, nótese que en una determinada lista de argumentos de tipo o de parámetros de tipo puede haber como máximo una tupla de variables de tipo:

@example
x: tuple[*Ts, *Ts]            # Not valid
class Array[*Shape, *Shape]:  # Not valid
    pass
@end example

Finalmente, una tupla de variables de tipo desempaquetada puede ser utilizada como la anotación de tipo de @code{*args}:

@example
def call_soon[*Ts](
    callback: Callable[[*Ts], None],
    *args: *Ts
) -> None:
    ...
    callback(*args)
@end example

En contraste con las anotaciones no-desempaquetadas de @code{*args}, por ej. @code{*args: int}, que especificaría que `todos' los argumentos son @code{int} - @code{*args: *Ts} permite referenciar los tipos de los argumentos `individuales' en @code{*args}. Aquí, ésto permite asegurarse de que los tipos de los @code{*args} que son pasados a @code{call_soon} calcen con los tipos de los argumentos (posicionales) de @code{callback}.

Véase 
@geindex Python Enhancement Proposals; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} para obtener más detalles sobre las tuplas de variables de tipo.

@geindex __name__ (atributo de typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple __name__}@anchor{3eb8}
@deffn {Atributo} __name__

The name of the type variable tuple.
@end deffn

@geindex __default__ (atributo de typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple __default__}@anchor{3eb9}
@deffn {Atributo} __default__

The default value of the type variable tuple, or @ref{3b9,,typing.NoDefault} if it
has no default.


Added in version 3.13.

@end deffn

@geindex evaluate_default() (método de typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple evaluate_default}@anchor{3eba}
@deffn {Método} evaluate_default ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3eb9,,__default__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3eb9,,__default__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format.


Added in version 3.14.

@end deffn

@geindex has_default() (método de typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple has_default}@anchor{3ebb}
@deffn {Método} has_default ()

Return whether or not the type variable tuple has a default value. This is equivalent
to checking whether @ref{3eb9,,__default__} is not the @ref{3b9,,typing.NoDefault}
singleton, except that it does not force evaluation of the
@ref{503,,lazily evaluated} default value.


Added in version 3.13.

@end deffn


Added in version 3.11.



Distinto en la versión 3.12: Type variable tuples can now be declared using the
@ref{3fc,,type parameter} syntax introduced by 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Distinto en la versión 3.13: Support for default values was added.

@end deffn

@geindex ParamSpec (clase en typing)
@anchor{library/typing typing ParamSpec}@anchor{2ca}
@deffn {Clase} typing.ParamSpec (name, *, bound=None, covariant=False, contravariant=False, default=typing.NoDefault)

Parameter specification variable.  A specialized version of
@ref{3ea0,,type variables}.

In @ref{3fc,,type parameter lists}, parameter specifications
can be declared with two asterisks (@code{**}):

@example
type IntFunc[**P] = Callable[P, int]
@end example

For compatibility with Python 3.11 and earlier, @code{ParamSpec} objects
can also be created as follows:

@example
P = ParamSpec('P')
@end example

Las variables de especificación de parámetros existen principalmente para el beneficio de los verificadores de tipo estático. Se utilizan para reenviar los tipos de parámetros de un invocable a otro invocable, un patrón que se encuentra comúnmente en funciones y decoradores de orden superior. Solo son válidos cuando se utilizan en @code{Concatenate}, o como primer argumento de @code{Callable}, o como parámetros para genéricos definidos por el usuario. Consulte @ref{15f6,,Generic} para obtener más información sobre tipos genéricos.

Por ejemplo, para agregar un registro básico a una función, se puede crear un decorador @code{add_logging} para registrar llamadas a funciones. La variable de especificación de parámetros le dice al verificador de tipo que el invocable pasado al decorador y el nuevo invocable retornado por él tienen parámetros de tipo interdependientes:

@example
from collections.abc import Callable
import logging

def add_logging[T, **P](f: Callable[P, T]) -> Callable[P, T]:
    '@w{'}'A type-safe decorator to add logging to a function.'@w{'}'
    def inner(*args: P.args, **kwargs: P.kwargs) -> T:
        logging.info(f'@{f.__name__@} was called')
        return f(*args, **kwargs)
    return inner

@@add_logging
def add_two(x: float, y: float) -> float:
    '@w{'}'Add two numbers together.'@w{'}'
    return x + y
@end example

Without @code{ParamSpec}, the simplest way to annotate this previously was to
use a @ref{2c9,,TypeVar} with upper bound @code{Callable[..., Any]}.  However this
causes two problems:


@enumerate 

@item 
El verificador de tipo no puede verificar la función @code{inner} porque @code{*args} y @code{**kwargs} deben escribirse @ref{74d,,Any}.

@item 
Es posible que se requiera @ref{3ebc,,cast()} en el cuerpo del decorador @code{add_logging} al retornar la función @code{inner}, o se debe indicar al verificador de tipo estático que ignore el @code{return inner}.
@end enumerate

@geindex args (atributo de typing.ParamSpec)
@anchor{library/typing typing ParamSpec args}@anchor{3ebd}
@deffn {Atributo} args
@end deffn

@geindex kwargs (atributo de typing.ParamSpec)
@anchor{library/typing typing ParamSpec kwargs}@anchor{3ebe}
@deffn {Atributo} kwargs

Dado que @code{ParamSpec} captura tanto parámetros posicionales como de palabras clave, @code{P.args} y @code{P.kwargs} se pueden utilizar para dividir un @code{ParamSpec} en sus componentes. @code{P.args} representa la tupla de parámetros posicionales en una llamada determinada y solo debe usarse para anotar @code{*args}. @code{P.kwargs} representa la asignación de parámetros de palabras clave a sus valores en una llamada determinada y solo debe usarse para anotar @code{**kwargs}. Ambos atributos requieren que el parámetro anotado esté dentro del alcance. En tiempo de ejecución, @code{P.args} y @code{P.kwargs} son instancias respectivamente de @ref{85f,,ParamSpecArgs} y @ref{860,,ParamSpecKwargs}.
@end deffn

@geindex __name__ (atributo de typing.ParamSpec)
@anchor{library/typing typing ParamSpec __name__}@anchor{3ebf}
@deffn {Atributo} __name__

The name of the parameter specification.
@end deffn

@geindex __default__ (atributo de typing.ParamSpec)
@anchor{library/typing typing ParamSpec __default__}@anchor{3ec0}
@deffn {Atributo} __default__

The default value of the parameter specification, or @ref{3b9,,typing.NoDefault} if it
has no default.


Added in version 3.13.

@end deffn

@geindex evaluate_default() (método de typing.ParamSpec)
@anchor{library/typing typing ParamSpec evaluate_default}@anchor{3ec1}
@deffn {Método} evaluate_default ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3ec0,,__default__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3ec0,,__default__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format.


Added in version 3.14.

@end deffn

@geindex has_default() (método de typing.ParamSpec)
@anchor{library/typing typing ParamSpec has_default}@anchor{3ec2}
@deffn {Método} has_default ()

Return whether or not the parameter specification has a default value. This is equivalent
to checking whether @ref{3ec0,,__default__} is not the @ref{3b9,,typing.NoDefault}
singleton, except that it does not force evaluation of the
@ref{503,,lazily evaluated} default value.


Added in version 3.13.

@end deffn

Las variables de especificación de parámetros creadas con @code{covariant=True} o @code{contravariant=True} se pueden utilizar para declarar tipos genéricos covariantes o contravariantes. También se acepta el argumento @code{bound}, similar a @ref{2c9,,TypeVar}. Sin embargo, la semántica real de estas palabras clave aún no se ha decidido.


Added in version 3.10.



Distinto en la versión 3.12: Parameter specifications can now be declared using the
@ref{3fc,,type parameter} syntax introduced by 
@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Distinto en la versión 3.13: Support for default values was added.


@cartouche
@quotation Nota 
Solo las variables de especificación de parámetros definidas en el ámbito global pueden ser serializadas.
@end quotation
@end cartouche


@subsubheading Ver también



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} – Parameter Specification Variables (the PEP which introduced
@code{ParamSpec} and @code{Concatenate})

@item 
@ref{85d,,Concatenate}

@item 
@ref{2526,,Annotating callable objects}
@end itemize

@end deffn

@geindex ParamSpecArgs (en el módulo typing)
@geindex ParamSpecKwargs (en el módulo typing)
@anchor{library/typing typing ParamSpecArgs}@anchor{85f}
@deffn {Dato} typing.ParamSpecArgs
@anchor{library/typing typing ParamSpecKwargs}@anchor{860}
@deffnx {Dato} typing.ParamSpecKwargs

Argumentos y atributos de argumentos de palabras clave de un @ref{2ca,,ParamSpec}. El atributo @code{P.args} de un @code{ParamSpec} es una instancia de @code{ParamSpecArgs} y @code{P.kwargs} es una instancia de @code{ParamSpecKwargs}. Están pensados para la introspección en tiempo de ejecución y no tienen un significado especial para los verificadores de tipo estático.

Calling @ref{ad9,,get_origin()} on either of these objects will return the
original @code{ParamSpec}:

@example
>>> from typing import ParamSpec, get_origin
>>> P = ParamSpec("P")
>>> get_origin(P.args) is P
True
>>> get_origin(P.kwargs) is P
True
@end example


Added in version 3.10.

@end deffn

@geindex TypeAliasType (clase en typing)
@anchor{library/typing typing TypeAliasType}@anchor{501}
@deffn {Clase} typing.TypeAliasType (name, value, *, type_params=())

The type of type aliases created through the @ref{4e6,,type} statement.

Example:

@example
>>> type Alias = int
>>> type(Alias)
<class 'typing.TypeAliasType'>
@end example


Added in version 3.12.


@geindex __name__ (atributo de typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __name__}@anchor{3ec3}
@deffn {Atributo} __name__

The name of the type alias:

@example
>>> type Alias = int
>>> Alias.__name__
'Alias'
@end example
@end deffn

@geindex __module__ (atributo de typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __module__}@anchor{3ec4}
@deffn {Atributo} __module__

The module in which the type alias was defined:

@example
>>> type Alias = int
>>> Alias.__module__
'__main__'
@end example
@end deffn

@geindex __type_params__ (atributo de typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __type_params__}@anchor{3ec5}
@deffn {Atributo} __type_params__

The type parameters of the type alias, or an empty tuple if the alias is
not generic:

@example
>>> type ListOrSet[T] = list[T] | set[T]
>>> ListOrSet.__type_params__
(T,)
>>> type NotGeneric = int
>>> NotGeneric.__type_params__
()
@end example
@end deffn

@geindex __value__ (atributo de typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __value__}@anchor{3ec6}
@deffn {Atributo} __value__

The type alias’s value. This is @ref{503,,lazily evaluated},
so names used in the definition of the alias are not resolved until the
@code{__value__} attribute is accessed:

@example
>>> type Mutually = Recursive
>>> type Recursive = Mutually
>>> Mutually
Mutually
>>> Recursive
Recursive
>>> Mutually.__value__
Recursive
>>> Recursive.__value__
Mutually
@end example
@end deffn

@geindex evaluate_value() (método de typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType evaluate_value}@anchor{3ec7}
@deffn {Método} evaluate_value ()

An @ref{3eb1,,evaluate function} corresponding to the @ref{3ec6,,__value__} attribute.
When called directly, this method supports only the @ref{142,,VALUE}
format, which is equivalent to accessing the @ref{3ec6,,__value__} attribute directly,
but the method object can be passed to @ref{3eb2,,annotationlib.call_evaluate_function()}
to evaluate the value in a different format:

@example
>>> type Alias = undefined
>>> Alias.__value__
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> from annotationlib import Format, call_evaluate_function
>>> Alias.evaluate_value(Format.VALUE)
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> call_evaluate_function(Alias.evaluate_value, Format.FORWARDREF)
ForwardRef('undefined')
@end example


Added in version 3.14.

@end deffn
@end deffn

@node Otras directivas especiales,,Building generic types and type aliases,Primitivos especiales de tipado
@anchor{library/typing other-special-directives}@anchor{3ec8}
@subsubsection Otras directivas especiales


These functions and classes should not be used directly as annotations.
Their intended purpose is to be building blocks for creating and declaring
types.

@geindex NamedTuple (clase en typing)
@anchor{library/typing typing NamedTuple}@anchor{1db}
@deffn {Clase} typing.NamedTuple

Versión para anotación de tipos de @ref{32d,,collections.namedtuple()}.

Uso:

@example
class Employee(NamedTuple):
    name: str
    id: int
@end example

Esto es equivalente a:

@example
Employee = collections.namedtuple('Employee', ['name', 'id'])
@end example

Para proporcionar a un campo un valor por defecto se puede asignar en el cuerpo de la clase:

@example
class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3
@end example

Los campos con un valor por defecto deben ir después de los campos sin valor por defecto.

La clase resultante tiene un atributo extra @code{__annotations__} que proporciona un diccionario que mapea el nombre de los campos con sus respectivos tipos. (Los nombres de los campos están en el atributo @code{_fields} y sus valores por defecto en el atributo @code{_field_defaults}, ambos parte de la API @ref{32d,,namedtuple()}.)

Las subclases de @code{NamedTuple} también pueden tener `docstrings' y métodos:

@example
class Employee(NamedTuple):
    """Represents an employee."""
    name: str
    id: int = 3

    def __repr__(self) -> str:
        return f'<Employee @{self.name@}, id=@{self.id@}>'
@end example

Las subclases de @code{NamedTuple} pueden ser genéricas:

@example
class Group[T](NamedTuple):
    key: T
    group: list[T]
@end example

Uso retrocompatible:

@example
# For creating a generic NamedTuple on Python 3.11
T = TypeVar("T")

class Group(NamedTuple, Generic[T]):
    key: T
    group: list[T]

# A functional syntax is also supported
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
@end example


Distinto en la versión 3.6: Soporte añadido para la sintaxis de anotación de variables propuesto en 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}.



Distinto en la versión 3.6.1: Soporte añadido para valores por defecto, métodos y `docstrings'.



Distinto en la versión 3.8: Los atributos @code{_field_types} y @code{__annotations__} son simples diccionarios en vez de instancias de @code{OrderedDict}.



Distinto en la versión 3.9: Se remueve el atributo @code{_field_types} en favor del atributo más estándar @code{__annotations__} que tiene la misma información.



Distinto en la versión 3.11: Se agrega soporte para `namedtuples' genéricas.



Deprecated since version 3.13, will be removed in version 3.15: The undocumented keyword argument syntax for creating NamedTuple classes
(@code{NT = NamedTuple("NT", x=int)}) is deprecated, and will be disallowed
in 3.15. Use the class-based syntax or the functional syntax instead.



Deprecated since version 3.13, will be removed in version 3.15: When using the functional syntax to create a NamedTuple class, failing to
pass a value to the “fields” parameter (@code{NT = NamedTuple("NT")}) is
deprecated. Passing @code{None} to the “fields” parameter
(@code{NT = NamedTuple("NT", None)}) is also deprecated. Both will be
disallowed in Python 3.15. To create a NamedTuple class with 0 fields,
use @code{class NT(NamedTuple): pass} or @code{NT = NamedTuple("NT", [])}.

@end deffn

@geindex NewType (clase en typing)
@anchor{library/typing typing NewType}@anchor{d7c}
@deffn {Clase} typing.NewType (name, tp)

Helper class to create low-overhead @ref{3e94,,distinct types}.

A @code{NewType} is considered a distinct type by a typechecker. At runtime,
however, calling a @code{NewType} returns its argument unchanged.

Uso:

@example
UserId = NewType('UserId', int)  # Declare the NewType "UserId"
first_user = UserId(1)  # "UserId" returns the argument unchanged at runtime
@end example

@geindex __module__ (atributo de typing.NewType)
@anchor{library/typing typing NewType __module__}@anchor{3ec9}
@deffn {Atributo} __module__

The module in which the new type is defined.
@end deffn

@geindex __name__ (atributo de typing.NewType)
@anchor{library/typing typing NewType __name__}@anchor{3eca}
@deffn {Atributo} __name__

The name of the new type.
@end deffn

@geindex __supertype__ (atributo de typing.NewType)
@anchor{library/typing typing NewType __supertype__}@anchor{3ecb}
@deffn {Atributo} __supertype__

The type that the new type is based on.
@end deffn


Added in version 3.5.2.



Distinto en la versión 3.10: @code{NewType} es ahora una clase en lugar de una función.

@end deffn

@geindex Protocol (clase en typing)
@anchor{library/typing typing Protocol}@anchor{3bb}
@deffn {Clase} typing.Protocol (Generic)

Base class for protocol classes.

Protocol classes are defined like this:

@example
class Proto(Protocol):
    def meth(self) -> int:
        ...
@end example

Tales clases son usadas principalmente con validadores estáticos de tipos que detectan subtipado estructural (`duck-typing' estático), por ejemplo:

@example
class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check
@end example

Véase 
@geindex Python Enhancement Proposals; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} para más detalles. Las clases protocolo decoradas con @ref{4f0,,runtime_checkable()} (descrito más adelante) se comportan como protocolos simplistas en tiempo de ejecución que solo comprueban la presencia de atributos dados, ignorando su firma de tipo.

Las clases protocolo pueden ser genéricas, por ejemplo:

@example
class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
@end example

In code that needs to be compatible with Python 3.11 or older, generic
Protocols can be written as follows:

@example
T = TypeVar("T")

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...
@end example


Added in version 3.8.

@end deffn

@geindex runtime_checkable() (en el módulo typing)
@anchor{library/typing typing runtime_checkable}@anchor{4f0}
@deffn {Función} @@typing.runtime_checkable

Marca una clase protocolo como aplicable en tiempo de ejecución (lo convierte en un `runtime protocol').

Tal protocolo se puede usar con @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}. Esto lanzará una excepción @ref{228,,TypeError} cuando se aplique a una clase que no es un protocolo. Esto permite una comprobación estructural simple, muy semejante a «one trick ponies» en @ref{1f,,collections.abc} con @ref{3ecc,,Iterable}. Por ejemplo:

@example
@@runtime_checkable
class Closable(Protocol):
    def close(self): ...

assert isinstance(open('/some/file'), Closable)

@@runtime_checkable
class Named(Protocol):
    name: str

import threading
assert isinstance(threading.Thread(name='Bob'), Named)
@end example

@cartouche
@quotation Nota 
@code{runtime_checkable()} will check only the presence of the required
methods or attributes, not their type signatures or types.
For example, @ref{c09,,ssl.SSLObject}
is a class, therefore it passes an @ref{85a,,issubclass()}
check against @ref{2526,,Callable}. However, the
@code{ssl.SSLObject.__init__} method exists only to raise a
@ref{228,,TypeError} with a more informative message, therefore making
it impossible to call (instantiate) @ref{c09,,ssl.SSLObject}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
An @ref{4ef,,isinstance()} check against a runtime-checkable protocol can be
surprisingly slow compared to an @code{isinstance()} check against
a non-protocol class. Consider using alternative idioms such as
@ref{579,,hasattr()} calls for structural checks in performance-sensitive
code.
@end quotation
@end cartouche


Added in version 3.8.



Distinto en la versión 3.12: The internal implementation of @ref{4ef,,isinstance()} checks against
runtime-checkable protocols now uses @ref{53d,,inspect.getattr_static()}
to look up attributes (previously, @ref{579,,hasattr()} was used).
As a result, some objects which used to be considered instances
of a runtime-checkable protocol may no longer be considered instances
of that protocol on Python 3.12+, and vice versa.
Most users are unlikely to be affected by this change.



Distinto en la versión 3.12: The members of a runtime-checkable protocol are now considered «frozen»
at runtime as soon as the class has been created. Monkey-patching
attributes onto a runtime-checkable protocol will still work, but will
have no impact on @ref{4ef,,isinstance()} checks comparing objects to the
protocol. See @ref{578,,«What’s new in Python 3.12»}
for more details.

@end deffn

@geindex TypedDict (clase en typing)
@anchor{library/typing typing TypedDict}@anchor{2ce}
@deffn {Clase} typing.TypedDict (dict)

Es una construcción especial para añadir indicadores de tipo a un diccionario. En tiempo de ejecución es un @ref{190,,dict} simple.

@code{TypedDict} crea un tipo de diccionario que espera que todas sus instancias tenga un cierto conjunto de claves, donde cada clave está asociada con un valor de un tipo determinado. Esta exigencia no se comprueba en tiempo de ejecución y solo es aplicada por validadores de tipo. Uso:

@example
class Point2D(TypedDict):
    x: int
    y: int
    label: str

a: Point2D = @{'x': 1, 'y': 2, 'label': 'good'@}  # OK
b: Point2D = @{'z': 3, 'label': 'bad'@}           # Fails type check

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
@end example

An alternative way to create a @code{TypedDict} is by using
function-call syntax. The second argument must be a literal @ref{190,,dict}:

@example
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': str@})
@end example

This functional syntax allows defining keys which are not valid
@ref{1e94,,identifiers}, for example because they are
keywords or contain hyphens:

@example
# raises SyntaxError
class Point2D(TypedDict):
    in: int  # 'in' is a keyword
    x-y: int  # name with hyphens

# OK, functional syntax
Point2D = TypedDict('Point2D', @{'in': int, 'x-y': int@})
@end example

De forma predeterminada, todas las llaves deben estar presentes en un @code{TypedDict}. Es posible marcar llaves individuales como `no requeridas' utilizando @ref{666,,NotRequired}:

@example
class Point2D(TypedDict):
    x: int
    y: int
    label: NotRequired[str]

# Alternative syntax
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': NotRequired[str]@})
@end example

Esto significa que en un @code{TypedDict} que sea una instancia de @code{Point2D}, será posible omitir la llave @code{label}.

Además, es posible marcar todas las llaves como no-requeridas por defecto, al especificar un valor de @code{False} en el argumento `total':

@example
class Point2D(TypedDict, total=False):
    x: int
    y: int

# Alternative syntax
Point2D = TypedDict('Point2D', @{'x': int, 'y': int@}, total=False)
@end example

Esto significa que un @code{TypedDict} @code{Point2D} puede tener cualquiera de las llaves omitidas. Solo se espera que un verificador de tipo admita un @code{False} literal o @code{True} como valor del argumento @code{total}. @code{True} es el predeterminado y hace que todos los elementos definidos en el cuerpo de la clase sean obligatorios.

Las llaves individuales de un @code{TypedDict} @code{total=False} pueden ser marcadas como requeridas utilizando @ref{665,,Required}:

@example
class Point2D(TypedDict, total=False):
    x: Required[int]
    y: Required[int]
    label: str

# Alternative syntax
Point2D = TypedDict('Point2D', @{
    'x': Required[int],
    'y': Required[int],
    'label': str
@}, total=False)
@end example

Es posible que un tipo @code{TypedDict} herede de uno o más tipos @code{TypedDict} usando la sintaxis de clase. Uso:

@example
class Point3D(Point2D):
    z: int
@end example

@code{Point3D} tiene tres elementos: @code{x}, @code{y} y @code{z}. Lo que es equivalente a la siguiente definición:

@example
class Point3D(TypedDict):
    x: int
    y: int
    z: int
@end example

Un @code{TypedDict} no puede heredar de una clase que no sea una subclase de @code{TypedDict}, exceptuando @ref{15f6,,Generic}. Por ejemplo:

@example
class X(TypedDict):
    x: int

class Y(TypedDict):
    y: int

class Z(object): pass  # A non-TypedDict class

class XY(X, Y): pass  # OK

class XZ(X, Z): pass  # raises TypeError
@end example

Un @code{TypedDict} puede ser genérico:

@example
class Group[T](TypedDict):
    key: T
    group: list[T]
@end example

To create a generic @code{TypedDict} that is compatible with Python 3.11
or lower, inherit from @ref{15f6,,Generic} explicitly:

@example
T = TypeVar("T")

class Group(TypedDict, Generic[T]):
    key: T
    group: list[T]
@end example

A @code{TypedDict} can be introspected via annotations dicts
(see @ref{870,,Prácticas recomendadas para las anotaciones} for more information on annotations best practices),
@ref{3ecd,,__total__}, @ref{3ece,,__required_keys__}, and @ref{3ecf,,__optional_keys__}.

@geindex __total__ (atributo de typing.TypedDict)
@anchor{library/typing typing TypedDict __total__}@anchor{3ecd}
@deffn {Atributo} __total__

@code{Point2D.__total__} gives the value of the @code{total} argument.
Example:

@example
>>> from typing import TypedDict
>>> class Point2D(TypedDict): pass
>>> Point2D.__total__
True
>>> class Point2D(TypedDict, total=False): pass
>>> Point2D.__total__
False
>>> class Point3D(Point2D): pass
>>> Point3D.__total__
True
@end example

This attribute reflects `only' the value of the @code{total} argument
to the current @code{TypedDict} class, not whether the class is semantically
total. For example, a @code{TypedDict} with @code{__total__} set to @code{True} may
have keys marked with @ref{666,,NotRequired}, or it may inherit from another
@code{TypedDict} with @code{total=False}. Therefore, it is generally better to use
@ref{3ece,,__required_keys__} and @ref{3ecf,,__optional_keys__} for introspection.
@end deffn

@geindex __required_keys__ (atributo de typing.TypedDict)
@anchor{library/typing typing TypedDict __required_keys__}@anchor{3ece}
@deffn {Atributo} __required_keys__


Added in version 3.9.

@end deffn

@geindex __optional_keys__ (atributo de typing.TypedDict)
@anchor{library/typing typing TypedDict __optional_keys__}@anchor{3ecf}
@deffn {Atributo} __optional_keys__

@code{Point2D.__required_keys__} y @code{Point2D.__optional_keys__} retornan objetos de la clase @ref{67b,,frozenset}, que contienen las llaves requeridas y no requeridas, respectivamente.

Las llaves marcadas con @ref{665,,Required} siempre aparecerán en @code{__required_keys__} y las llaves marcadas con @ref{666,,NotRequired} siempre aparecerán en @code{__optional_keys__}.

For backwards compatibility with Python 3.10 and below,
it is also possible to use inheritance to declare both required and
non-required keys in the same @code{TypedDict} . This is done by declaring a
@code{TypedDict} with one value for the @code{total} argument and then
inheriting from it in another @code{TypedDict} with a different value for
@code{total}:

@example
>>> class Point2D(TypedDict, total=False):
...     x: int
...     y: int
...
>>> class Point3D(Point2D):
...     z: int
...
>>> Point3D.__required_keys__ == frozenset(@{'z'@})
True
>>> Point3D.__optional_keys__ == frozenset(@{'x', 'y'@})
True
@end example


Added in version 3.9.


@cartouche
@quotation Nota 
If @code{from __future__ import annotations} is used or if annotations
are given as strings, annotations are not evaluated when the
@code{TypedDict} is defined. Therefore, the runtime introspection that
@code{__required_keys__} and @code{__optional_keys__} rely on may not work
properly, and the values of the attributes may be incorrect.
@end quotation
@end cartouche
@end deffn

Support for @ref{2cd,,ReadOnly} is reflected in the following attributes:

@geindex __readonly_keys__ (atributo de typing.TypedDict)
@anchor{library/typing typing TypedDict __readonly_keys__}@anchor{3ed0}
@deffn {Atributo} __readonly_keys__

A @ref{67b,,frozenset} containing the names of all read-only keys. Keys
are read-only if they carry the @ref{2cd,,ReadOnly} qualifier.


Added in version 3.13.

@end deffn

@geindex __mutable_keys__ (atributo de typing.TypedDict)
@anchor{library/typing typing TypedDict __mutable_keys__}@anchor{3ed1}
@deffn {Atributo} __mutable_keys__

A @ref{67b,,frozenset} containing the names of all mutable keys. Keys
are mutable if they do not carry the @ref{2cd,,ReadOnly} qualifier.


Added in version 3.13.

@end deffn

Véase 
@geindex Python Enhancement Proposals; PEP 589
PEP 589@footnote{https://peps.python.org/pep-0589/} para más ejemplos y reglas detalladas del uso de @code{TypedDict}.


Added in version 3.8.



Distinto en la versión 3.11: Se agrega soporte para marcar llaves individuales como @ref{665,,Required} o @ref{666,,NotRequired}. Véase 
@geindex Python Enhancement Proposals; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}.



Distinto en la versión 3.11: Se agrega soporte para @code{TypedDict} genéricos.



Distinto en la versión 3.13: Removed support for the keyword-argument method of creating @code{TypedDict}s.



Distinto en la versión 3.13: Support for the @ref{2cd,,ReadOnly} qualifier was added.



Deprecated since version 3.13, will be removed in version 3.15: When using the functional syntax to create a TypedDict class, failing to
pass a value to the “fields” parameter (@code{TD = TypedDict("TD")}) is
deprecated. Passing @code{None} to the “fields” parameter
(@code{TD = TypedDict("TD", None)}) is also deprecated. Both will be
disallowed in Python 3.15. To create a TypedDict class with 0 fields,
use @code{class TD(TypedDict): pass} or @code{TD = TypedDict("TD", @{@})}.

@end deffn

@node Protocolos<3>,ABCs for working with IO,Primitivos especiales de tipado,Contenido del módulo<3>
@anchor{library/typing protocols}@anchor{3ed2}
@subsubsection Protocolos


The following protocols are provided by the typing module. All are decorated
with @ref{4f0,,@@runtime_checkable}.

@geindex SupportsAbs (clase en typing)
@anchor{library/typing typing SupportsAbs}@anchor{3ed3}
@deffn {Clase} typing.SupportsAbs

Una ABC con un método abstracto @code{__abs__} que es covariante en su tipo retornado.
@end deffn

@geindex SupportsBytes (clase en typing)
@anchor{library/typing typing SupportsBytes}@anchor{68a}
@deffn {Clase} typing.SupportsBytes

Una ABC con un método abstracto @code{__bytes__}.
@end deffn

@geindex SupportsComplex (clase en typing)
@anchor{library/typing typing SupportsComplex}@anchor{689}
@deffn {Clase} typing.SupportsComplex

Una ABC con un método abstracto @code{__complex__}.
@end deffn

@geindex SupportsFloat (clase en typing)
@anchor{library/typing typing SupportsFloat}@anchor{3ed4}
@deffn {Clase} typing.SupportsFloat

Una ABC con un método abstracto @code{__float__}.
@end deffn

@geindex SupportsIndex (clase en typing)
@anchor{library/typing typing SupportsIndex}@anchor{ad8}
@deffn {Clase} typing.SupportsIndex

Una ABC con un método abstracto @code{__index__}.


Added in version 3.8.

@end deffn

@geindex SupportsInt (clase en typing)
@anchor{library/typing typing SupportsInt}@anchor{ad7}
@deffn {Clase} typing.SupportsInt

Una ABC con un método abstracto @code{__int__}.
@end deffn

@geindex SupportsRound (clase en typing)
@anchor{library/typing typing SupportsRound}@anchor{3ed5}
@deffn {Clase} typing.SupportsRound

Una ABC con un método abstracto @code{__round__} que es covariantes en su tipo retornado.
@end deffn

@node ABCs for working with IO,Funciones y decoradores,Protocolos<3>,Contenido del módulo<3>
@anchor{library/typing abcs-for-working-with-io}@anchor{3ed6}
@subsubsection ABCs for working with IO


@geindex IO (clase en typing)
@geindex TextIO (clase en typing)
@geindex BinaryIO (clase en typing)
@anchor{library/typing typing IO}@anchor{7c7}
@deffn {Clase} typing.IO
@anchor{library/typing typing TextIO}@anchor{3ed7}
@deffnx {Clase} typing.TextIO
@anchor{library/typing typing BinaryIO}@anchor{3ed8}
@deffnx {Clase} typing.BinaryIO

El tipo genérico @code{IO[AnyStr]} y sus subclases @code{TextIO(IO[str])} y @code{BinaryIO(IO[bytes])} representan los tipos de flujos de E/S como los retornados por @ref{1be,,open()}.
@end deffn

@node Funciones y decoradores,Ayudas de introspección,ABCs for working with IO,Contenido del módulo<3>
@anchor{library/typing functions-and-decorators}@anchor{3ed9}
@subsubsection Funciones y decoradores


@geindex cast() (en el módulo typing)
@anchor{library/typing typing cast}@anchor{3ebc}
@deffn {Función} typing.cast (typ, val)

Convertir un valor a un tipo.

Esto retorna el valor sin modificar. Para el validador de tipos esto indica que el valor de retorno tiene el tipo señalado pero, de manera intencionada, no se comprobará en tiempo de ejecución (para maximizar la velocidad).
@end deffn

@geindex assert_type() (en el módulo typing)
@anchor{library/typing typing assert_type}@anchor{74c}
@deffn {Función} typing.assert_type (val, typ, /)

Solicitar a un validador de tipos que confirme que `val' tiene `typ' por tipo inferido.

At runtime this does nothing: it returns the first argument unchanged with no
checks or side effects, no matter the actual type of the argument.

When a static type checker encounters a call to @code{assert_type()}, it
emits an error if the value is not of the specified type:

@example
def greet(name: str) -> None:
    assert_type(name, str)  # OK, inferred type of `name` is `str`
    assert_type(name, int)  # type checker error
@end example

Esta función es útil para asegurarse de que la comprensión que el validador de tipos tiene sobre un `script' está alineada con las intenciones de le desarrolladores:

@example
def complex_function(arg: object):
    # Do some complex type-narrowing logic,
    # after which we hope the inferred type will be `int`
    ...
    # Test whether the type checker correctly understands our function
    assert_type(arg, int)
@end example


Added in version 3.11.

@end deffn

@geindex assert_never() (en el módulo typing)
@anchor{library/typing typing assert_never}@anchor{748}
@deffn {Función} typing.assert_never (arg, /)

Solicitar a un validador estático de tipos confirmar que una línea de código no es alcanzable.

Por ejemplo:

@example
def int_or_str(arg: int | str) -> None:
    match arg:
        case int():
            print("It's an int")
        case str():
            print("It's a str")
        case _ as unreachable:
            assert_never(unreachable)
@end example

Here, the annotations allow the type checker to infer that the
last case can never execute, because @code{arg} is either
an @ref{1f0,,int} or a @ref{237,,str}, and both options are covered by
earlier cases.

If a type checker finds that a call to @code{assert_never()} is
reachable, it will emit an error. For example, if the type annotation
for @code{arg} was instead @code{int | str | float}, the type checker would
emit an error pointing out that @code{unreachable} is of type @ref{153,,float}.
For a call to @code{assert_never} to pass type checking, the inferred type of
the argument passed in must be the bottom type, @ref{749,,Never}, and nothing
else.

En tiempo de ejecución, ésto lanza una excepción cuando es llamado.


@subsubheading Ver también


Unreachable Code and Exhaustiveness Checking@footnote{https://typing.readthedocs.io/en/latest/guides/unreachable.html} has more
information about exhaustiveness checking with static typing.



Added in version 3.11.

@end deffn

@geindex reveal_type() (en el módulo typing)
@anchor{library/typing typing reveal_type}@anchor{74b}
@deffn {Función} typing.reveal_type (obj, /)

Ask a static type checker to reveal the inferred type of an expression.

When a static type checker encounters a call to this function,
it emits a diagnostic with the inferred type of the argument. For example:

@example
x: int = 1
reveal_type(x)  # Revealed type is "builtins.int"
@end example

Ésto puede ser de utilidad cuando se desea `debuguear' cómo tu validador de tipos maneja una pieza particular de código.

At runtime, this function prints the runtime type of its argument to
@ref{9cc,,sys.stderr} and returns the argument unchanged (allowing the call to
be used within an expression):

@example
x = reveal_type(1)  # prints "Runtime type is int"
print(x)  # prints "1"
@end example

Note that the runtime type may be different from (more or less specific
than) the type statically inferred by a type checker.

Most type checkers support @code{reveal_type()} anywhere, even if the
name is not imported from @code{typing}. Importing the name from
@code{typing}, however, allows your code to run without runtime errors and
communicates intent more clearly.


Added in version 3.11.

@end deffn

@geindex dataclass_transform() (en el módulo typing)
@anchor{library/typing typing dataclass_transform}@anchor{57b}
@deffn {Función} @@typing.dataclass_transform (*, eq_default=True, order_default=False, kw_only_default=False, frozen_default=False, field_specifiers=(), **kwargs)

Decorator to mark an object as providing
@ref{32e,,dataclass}-like behavior.

@code{dataclass_transform} may be used to
decorate a class, metaclass, or a function that is itself a decorator.
The presence of @code{@@dataclass_transform()} tells a static type checker that the
decorated object performs runtime «magic» that
transforms a class in a similar way to
@ref{32e,,@@dataclasses.dataclass}.

Example usage with a decorator function:

@example
@@dataclass_transform()
def create_model[T](cls: type[T]) -> type[T]:
    ...
    return cls

@@create_model
class CustomerModel:
    id: int
    name: str
@end example

En una clase base:

@example
@@dataclass_transform()
class ModelBase: ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

En una metaclase:

@example
@@dataclass_transform()
class ModelMeta(type): ...

class ModelBase(metaclass=ModelMeta): ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

Las clases @code{CustomerModel} definidas arribe serán tratadas por los validadores de tipo de forma similar a las clases que sean creadas con  @ref{32e,,@@dataclasses.dataclass}. Por ejemplo, los validadores de tipo asumirán que estas clases tienen métodos @code{__init__} que aceptan @code{id} y @code{name}.

La clase, metaclase o función decorada puede aceptar los siguientes argumentos booleanos, de los cuales los validadores de tipos asumirán que tienen el mismo efecto que tendrían en el decorador @ref{32e,,@@dataclasses.dataclass}: @code{init}, @code{eq}, @code{order}, @code{unsafe_hash}, @code{frozen}, @code{match_args}, @code{kw_only}, y @code{slots}. Debe ser posible evaluar estáticamente el valor de estos argumentos (@code{True} o @code{False}).

Es posible utilizar los argumentos del decorador @code{dataclass_transform} para personalizar los comportamientos por defecto de la clase, metaclase o función decorada:

@*Parámetros: 

@itemize *

@item 
@code{eq_default} (@ref{513,,bool}) – Indicates whether the @code{eq} parameter is assumed to be
@code{True} or @code{False} if it is omitted by the caller.
Defaults to @code{True}.

@item 
@code{order_default} (@ref{513,,bool}) – Indicates whether the @code{order} parameter is
assumed to be @code{True} or @code{False} if it is omitted by the caller.
Defaults to @code{False}.

@item 
@code{kw_only_default} (@ref{513,,bool}) – Indicates whether the @code{kw_only} parameter is
assumed to be @code{True} or @code{False} if it is omitted by the caller.
Defaults to @code{False}.

@item 
@code{frozen_default} (@ref{513,,bool}) – 
Indicates whether the @code{frozen} parameter is
assumed to be @code{True} or @code{False} if it is omitted by the caller.
Defaults to @code{False}.


Added in version 3.12.



@item 
@code{field_specifiers} (@ref{464,,tuple}@code{[}@ref{881,,Callable}@code{[}@code{...}@code{, }@code{Any}@code{]}@code{, }@code{...}@code{]}) – Specifies a static list of supported classes
or functions that describe fields, similar to @ref{15f7,,dataclasses.field()}.
Defaults to @code{()}.

@item 
@code{**kwargs} (@code{Any}) – Es posible pasar arbitrariamente otros argumentos nombrados para permitir posibles extensiones futuras.
@end itemize


Type checkers recognize the following optional parameters on field
specifiers:
`Recognised parameters for field specifiers'



@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Parameter name

@tab

Description

@item

@code{init}

@tab

Indicates whether the field should be included in the
synthesized @code{__init__} method. If unspecified, @code{init} defaults to
@code{True}.

@item

@code{default}

@tab

Provides the default value for the field.

@item

@code{default_factory}

@tab

Provides a runtime callback that returns the
default value for the field. If neither @code{default} nor
@code{default_factory} are specified, the field is assumed to have no
default value and must be provided a value when the class is
instantiated.

@item

@code{factory}

@tab

An alias for the @code{default_factory} parameter on field specifiers.

@item

@code{kw_only}

@tab

Indicates whether the field should be marked as
keyword-only. If @code{True}, the field will be keyword-only. If
@code{False}, it will not be keyword-only. If unspecified, the value of
the @code{kw_only} parameter on the object decorated with
@code{dataclass_transform} will be used, or if that is unspecified, the
value of @code{kw_only_default} on @code{dataclass_transform} will be used.

@item

@code{alias}

@tab

Provides an alternative name for the field. This alternative
name is used in the synthesized @code{__init__} method.

@end multitable


En tiempo de ejecución, este decorador registra sus argumentos en el atributo @code{__dataclass_transform__} del objeto decorado. No tiene otro efecto en tiempo de ejecución.

Véase 
@geindex Python Enhancement Proposals; PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/} para más detalle.


Added in version 3.11.

@end deffn

@geindex overload() (en el módulo typing)
@anchor{library/typing overload}@anchor{3e97}@anchor{library/typing typing overload}@anchor{3eda}
@deffn {Función} @@typing.overload

Decorator for creating overloaded functions and methods.

The @code{@@overload} decorator allows describing functions and methods
that support multiple different combinations of argument types. A series
of @code{@@overload}-decorated definitions must be followed by exactly one
non-@code{@@overload}-decorated definition (for the same function/method).

@code{@@overload}-decorated definitions are for the benefit of the
type checker only, since they will be overwritten by the
non-@code{@@overload}-decorated definition. The non-@code{@@overload}-decorated
definition, meanwhile, will be used at
runtime but should be ignored by a type checker.  At runtime, calling
an @code{@@overload}-decorated function directly will raise
@ref{384,,NotImplementedError}.

An example of overload that gives a more
precise type than can be expressed using a union or a type variable:

@example
@@overload
def process(response: None) -> None:
    ...
@@overload
def process(response: int) -> tuple[int, str]:
    ...
@@overload
def process(response: bytes) -> str:
    ...
def process(response):
    ...  # actual implementation goes here
@end example

Véase 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para más detalle y comparación con otras semánticas de tipado.


Distinto en la versión 3.11: Ahora es posible introspectar en tiempo de ejecución las funciones sobrecargadas utilizando @ref{74f,,get_overloads()}.

@end deffn

@geindex get_overloads() (en el módulo typing)
@anchor{library/typing typing get_overloads}@anchor{74f}
@deffn {Función} typing.get_overloads (func)

Return a sequence of @ref{3eda,,@@overload}-decorated definitions for
`func'.

`func' is the function object for the implementation of the
overloaded function. For example, given the definition of @code{process} in
the documentation for @ref{3eda,,@@overload},
@code{get_overloads(process)} will return a sequence of three function objects
for the three defined overloads. If called on a function with no overloads,
@code{get_overloads()} returns an empty sequence.

@code{get_overloads()} puede ser utilizada para introspectar en tiempo de ejecución una función sobrecargada.


Added in version 3.11.

@end deffn

@geindex clear_overloads() (en el módulo typing)
@anchor{library/typing typing clear_overloads}@anchor{750}
@deffn {Función} typing.clear_overloads ()

Clear all registered overloads in the internal registry.

This can be used to reclaim the memory used by the registry.


Added in version 3.11.

@end deffn

@geindex final() (en el módulo typing)
@anchor{library/typing typing final}@anchor{74e}
@deffn {Función} @@typing.final

Decorator to indicate final methods and final classes.

Decorating a method with @code{@@final} indicates to a type checker that the
method cannot be overridden in a subclass. Decorating a class with @code{@@final}
indicates that it cannot be subclassed.

Por ejemplo:

@example
class Base:
    @@final
    def done(self) -> None:
        ...
class Sub(Base):
    def done(self) -> None:  # Error reported by type checker
        ...

@@final
class Leaf:
    ...
class Other(Leaf):  # Error reported by type checker
    ...
@end example

No hay comprobación en tiempo de ejecución para estas propiedades. Véase 
@geindex Python Enhancement Proposals; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/} para más detalles.


Added in version 3.8.



Distinto en la versión 3.11: The decorator will now attempt to set a @code{__final__} attribute to @code{True}
on the decorated object. Thus, a check like
@code{if getattr(obj, "__final__", False)} can be used at runtime
to determine whether an object @code{obj} has been marked as final.
If the decorated object does not support setting attributes,
the decorator returns the object unchanged without raising an exception.

@end deffn

@geindex no_type_check() (en el módulo typing)
@anchor{library/typing typing no_type_check}@anchor{755}
@deffn {Función} @@typing.no_type_check

Un decorador para indicar que las anotaciones no deben ser comprobadas como indicadores de tipo.

This works as a class or function @ref{7cd,,decorator}.  With a class, it
applies recursively to all methods and classes defined in that class
(but not to methods defined in its superclasses or subclasses). Type
checkers will ignore all annotations in a function or class with this
decorator.

@code{@@no_type_check} mutates the decorated object in place.
@end deffn

@geindex no_type_check_decorator() (en el módulo typing)
@anchor{library/typing typing no_type_check_decorator}@anchor{1dc}
@deffn {Función} @@typing.no_type_check_decorator

Un decorador que asigna a otro decorador el efecto de @ref{755,,no_type_check()} (no comprobar tipo).

Esto hace que el decorador decorado añada el efecto de @ref{755,,no_type_check()} a la función decorada.


Deprecated since version 3.13, will be removed in version 3.15: No type checker ever added support for @code{@@no_type_check_decorator}. It
is therefore deprecated, and will be removed in Python 3.15.

@end deffn

@geindex override() (en el módulo typing)
@anchor{library/typing typing override}@anchor{4f8}
@deffn {Función} @@typing.override

Decorator to indicate that a method in a subclass is intended to override a
method or attribute in a superclass.

Type checkers should emit an error if a method decorated with @code{@@override}
does not, in fact, override anything.
This helps prevent bugs that may occur when a base class is changed without
an equivalent change to a child class.

For example:

@example
class Base:
    def log_status(self) -> None:
        ...

class Sub(Base):
    @@override
    def log_status(self) -> None:  # Okay: overrides Base.log_status
        ...

    @@override
    def done(self) -> None:  # Error reported by type checker
        ...
@end example

There is no runtime checking of this property.

The decorator will attempt to set an @code{__override__} attribute to @code{True} on
the decorated object. Thus, a check like
@code{if getattr(obj, "__override__", False)} can be used at runtime to determine
whether an object @code{obj} has been marked as an override.  If the decorated object
does not support setting attributes, the decorator returns the object unchanged
without raising an exception.

See 
@geindex Python Enhancement Proposals; PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/} for more details.


Added in version 3.12.

@end deffn

@geindex type_check_only() (en el módulo typing)
@anchor{library/typing typing type_check_only}@anchor{3edb}
@deffn {Función} @@typing.type_check_only

Decorator to mark a class or function as unavailable at runtime.

Este decorador no está disponible en tiempo de ejecución. Existe principalmente para marcar clases que se definen en archivos `stub' para cuando una implementación retorna una instancia de una clase privada:

@example
@@type_check_only
class Response:  # private or not available at runtime
    code: int
    def get_header(self, name: str) -> str: ...

def fetch_response() -> Response: ...
@end example

Nótese que no se recomienda retornar instancias de clases privadas. Normalmente es preferible convertirlas en clases públicas.
@end deffn

@node Ayudas de introspección,Constantes<10>,Funciones y decoradores,Contenido del módulo<3>
@anchor{library/typing introspection-helpers}@anchor{3edc}
@subsubsection Ayudas de introspección


@geindex get_type_hints() (en el módulo typing)
@anchor{library/typing typing get_type_hints}@anchor{752}
@deffn {Función} typing.get_type_hints (obj, globalns=None, localns=None, include_extras=False)

Retorna un diccionario que contiene indicaciones de tipo para una función, método, módulo o objeto clase.

This is often the same as @code{obj.__annotations__}, but this function makes
the following changes to the annotations dictionary:


@itemize *

@item 
Forward references encoded as string literals or @ref{184a,,ForwardRef}
objects are handled by evaluating them in `globalns', `localns', and
(where applicable) `obj'’s @ref{3fc,,type parameter} namespace.
If `globalns' or `localns' is not given, appropriate namespace
dictionaries are inferred from `obj'.

@item 
@code{None} is replaced with @ref{8e9,,types.NoneType}.

@item 
If @ref{755,,@@no_type_check} has been applied to `obj', an
empty dictionary is returned.

@item 
If `obj' is a class @code{C}, the function returns a dictionary that merges
annotations from @code{C}’s base classes with those on @code{C} directly. This
is done by traversing @ref{1f2a,,C.__mro__} and iteratively
combining
@code{__annotations__} dictionaries. Annotations on classes appearing
earlier in the @ref{2188,,method resolution order} always take precedence over
annotations on classes appearing later in the method resolution order.

@item 
The function recursively replaces all occurrences of @code{Annotated[T, ...]}
with @code{T}, unless `include_extras' is set to @code{True} (see
@ref{9d0,,Annotated} for more information).
@end itemize

See also @ref{8aa,,inspect.get_annotations()}, a lower-level function that
returns annotations more directly.

@cartouche
@quotation Nota 
If any forward references in the annotations of `obj' are not resolvable
or are not valid Python code, this function will raise an exception
such as @ref{4ec,,NameError}. For example, this can happen with imported
@ref{500,,type aliases} that include forward references,
or with names imported under @ref{d7b,,if TYPE_CHECKING}.
@end quotation
@end cartouche


Distinto en la versión 3.9: Added @code{include_extras} parameter as part of 
@geindex Python Enhancement Proposals; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}.
See the documentation on @ref{9d0,,Annotated} for more information.



Distinto en la versión 3.11: Anteriormente, se agregaba @code{Optional[t]} en las anotaciones de funciones o métodos si se establecía un valor por defecto igual a @code{None}. Ahora la anotación es retornada sin cambios.

@end deffn

@geindex get_origin() (en el módulo typing)
@anchor{library/typing typing get_origin}@anchor{ad9}
@deffn {Función} typing.get_origin (tp)

Get the unsubscripted version of a type: for a typing object of the form
@code{X[Y, Z, ...]} return @code{X}.

If @code{X} is a typing-module alias for a builtin or
@ref{1e,,collections} class, it will be normalized to the original class.
If @code{X} is an instance of @ref{85f,,ParamSpecArgs} or @ref{860,,ParamSpecKwargs},
return the underlying @ref{2ca,,ParamSpec}.
Return @code{None} for unsupported objects.

Examples:

@example
assert get_origin(str) is None
assert get_origin(Dict[str, int]) is dict
assert get_origin(Union[int, str]) is Union
assert get_origin(Annotated[str, "metadata"]) is Annotated
P = ParamSpec('P')
assert get_origin(P.args) is P
assert get_origin(P.kwargs) is P
@end example


Added in version 3.8.

@end deffn

@geindex get_args() (en el módulo typing)
@anchor{library/typing typing get_args}@anchor{916}
@deffn {Función} typing.get_args (tp)

Get type arguments with all substitutions performed: for a typing object
of the form @code{X[Y, Z, ...]} return @code{(Y, Z, ...)}.

If @code{X} is a union or @ref{8ec,,Literal} contained in another
generic type, the order of @code{(Y, Z, ...)} may be different from the order
of the original arguments @code{[Y, Z, ...]} due to type caching.
Return @code{()} for unsupported objects.

Examples:

@example
assert get_args(int) == ()
assert get_args(Dict[int, str]) == (int, str)
assert get_args(Union[int, str]) == (int, str)
@end example


Added in version 3.8.

@end deffn

@geindex get_protocol_members() (en el módulo typing)
@anchor{library/typing typing get_protocol_members}@anchor{3ba}
@deffn {Función} typing.get_protocol_members (tp)

Return the set of members defined in a @ref{3bb,,Protocol}.

@example
>>> from typing import Protocol, get_protocol_members
>>> class P(Protocol):
...     def a(self) -> str: ...
...     b: int
>>> get_protocol_members(P) == frozenset(@{'a', 'b'@})
True
@end example

Raise @ref{228,,TypeError} for arguments that are not Protocols.


Added in version 3.13.

@end deffn

@geindex is_protocol() (en el módulo typing)
@anchor{library/typing typing is_protocol}@anchor{3bc}
@deffn {Función} typing.is_protocol (tp)

Determine if a type is a @ref{3bb,,Protocol}.

Por ejemplo:

@example
class P(Protocol):
    def a(self) -> str: ...
    b: int

is_protocol(P)    # => True
is_protocol(int)  # => False
@end example


Added in version 3.13.

@end deffn

@geindex is_typeddict() (en el módulo typing)
@anchor{library/typing typing is_typeddict}@anchor{8ed}
@deffn {Función} typing.is_typeddict (tp)

Compruebe si un tipo es @ref{2ce,,TypedDict}.

For example:

@example
class Film(TypedDict):
    title: str
    year: int

assert is_typeddict(Film)
assert not is_typeddict(list | str)

# TypedDict is a factory for creating typed dicts,
# not a typed dict itself
assert not is_typeddict(TypedDict)
@end example


Added in version 3.10.

@end deffn

@geindex ForwardRef (clase en typing)
@anchor{library/typing typing ForwardRef}@anchor{184a}
@deffn {Clase} typing.ForwardRef

Class used for internal typing representation of string forward references.

For example, @code{List["SomeClass"]} is implicitly transformed into
@code{List[ForwardRef("SomeClass")]}.  @code{ForwardRef} should not be instantiated by
a user, but may be used by introspection tools.

@cartouche
@quotation Nota 
Los tipos genéricos de 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}, como @code{list["SomeClass"]}, no se transformarán implícitamente en @code{list[ForwardRef("SomeClass")]} y, por lo tanto, no se resolverán automáticamente en @code{list[SomeClass]}.
@end quotation
@end cartouche


Added in version 3.7.4.



Distinto en la versión 3.14: This is now an alias for @ref{15aa,,annotationlib.ForwardRef}.

@end deffn

@geindex evaluate_forward_ref() (en el módulo typing)
@anchor{library/typing typing evaluate_forward_ref}@anchor{3edd}
@deffn {Función} typing.evaluate_forward_ref (forward_ref, *, owner=None, globals=None, locals=None, type_params=None, format=annotationlib.Format.VALUE)

Evaluate an @ref{15aa,,annotationlib.ForwardRef} as a @ref{1f81,,type hint}.

This is similar to calling @ref{3ede,,annotationlib.ForwardRef.evaluate()},
but unlike that method, @code{evaluate_forward_ref()} also:


@itemize *

@item 
Recursively evaluates forward references nested within the type hint.

@item 
Raises @ref{228,,TypeError} when it encounters certain objects that are
not valid type hints.

@item 
Replaces type hints that evaluate to @code{None} with
@ref{8e9,,types.NoneType}.

@item 
Supports the @ref{143,,FORWARDREF} and
@ref{144,,STRING} formats.
@end itemize

`forward_ref' must be an instance of @ref{15aa,,ForwardRef}.
`owner', if given, should be the object that holds the annotations that
the forward reference derived from, such as a module, class object, or function.
It is used to infer the namespaces to use for looking up names.
`globals' and `locals' can also be explicitly given to provide
the global and local namespaces.
`type_params' is a tuple of @ref{3fc,,type parameters} that
are in scope when evaluating the forward reference.
This parameter must be provided (though it may be an empty tuple) if `owner'
is not given and the forward reference does not already have an owner set.
`format' specifies the format of the annotation and is a member of
the @ref{182,,annotationlib.Format} enum.


Added in version 3.14.

@end deffn

@geindex NoDefault (en el módulo typing)
@anchor{library/typing typing NoDefault}@anchor{3b9}
@deffn {Dato} typing.NoDefault

A sentinel object used to indicate that a type parameter has no default
value. For example:

@example
>>> T = TypeVar("T")
>>> T.__default__ is typing.NoDefault
True
>>> S = TypeVar("S", default=None)
>>> S.__default__ is None
True
@end example


Added in version 3.13.

@end deffn

@node Constantes<10>,Deprecated aliases,Ayudas de introspección,Contenido del módulo<3>
@anchor{library/typing constant}@anchor{3edf}
@subsubsection Constantes


@geindex TYPE_CHECKING (en el módulo typing)
@anchor{library/typing typing TYPE_CHECKING}@anchor{d7b}
@deffn {Dato} typing.TYPE_CHECKING

A special constant that is assumed to be @code{True} by 3rd party static
type checkers. It is @code{False} at runtime.

Uso:

@example
if TYPE_CHECKING:
    import expensive_mod

def fun(arg: 'expensive_mod.SomeType') -> None:
    local_var: expensive_mod.AnotherType = other_fun()
@end example

Nótese que la primera anotación de tipo debe estar rodeada por comillas, convirtiéndola en una «referencia directa», para ocultar al intérprete la referencia @code{expensive_mod} en tiempo de ejecución. Las anotaciones de tipo para variables locales no se evalúan, así que la segunda anotación no necesita comillas.

@cartouche
@quotation Nota 
Si se utiliza @code{from __future__ import annotations}, las anotaciones no son evaluadas al momento de la definición de funciones. En cambio, serán almacenadas como cadenas de texto en @code{__annotations__}. Ésto vuelve innecesario el uso de comillas alrededor de la anotación (véase 
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}).
@end quotation
@end cartouche


Added in version 3.5.2.

@end deffn
@anchor{library/typing generic-concrete-collections}@anchor{3ee0}
@node Deprecated aliases,,Constantes<10>,Contenido del módulo<3>
@anchor{library/typing deprecated-aliases}@anchor{3ee1}@anchor{library/typing id6}@anchor{3ee2}
@subsubsection Deprecated aliases


This module defines several deprecated aliases to pre-existing
standard library classes. These were originally included in the typing
module in order to support parameterizing these generic classes using @code{[]}.
However, the aliases became redundant in Python 3.9 when the
corresponding pre-existing classes were enhanced to support @code{[]} (see
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}).

The redundant types are deprecated as of Python 3.9. However, while the aliases
may be removed at some point, removal of these aliases is not currently
planned. As such, no deprecation warnings are currently issued by the
interpreter for these aliases.

If at some point it is decided to remove these deprecated aliases, a
deprecation warning will be issued by the interpreter for at least two releases
prior to removal. The aliases are guaranteed to remain in the typing module
without deprecation warnings until at least Python 3.14.

Type checkers are encouraged to flag uses of the deprecated types if the
program they are checking targets a minimum Python version of 3.9 or newer.

@menu
* Aliases to built-in types:: 
* Aliases to types in collections:: 
* Aliases to other concrete types:: 
* Aliases to container ABCs in collections.abc: Aliases to container ABCs in collections abc. 
* Aliases to asynchronous ABCs in collections.abc: Aliases to asynchronous ABCs in collections abc. 
* Aliases to other ABCs in collections.abc: Aliases to other ABCs in collections abc. 
* Aliases to contextlib ABCs:: 

@end menu

@node Aliases to built-in types,Aliases to types in collections,,Deprecated aliases
@anchor{library/typing aliases-to-built-in-types}@anchor{3ee3}@anchor{library/typing corresponding-to-built-in-types}@anchor{3ee4}
@subsubsection Aliases to built-in types


@geindex Dict (clase en typing)
@anchor{library/typing typing Dict}@anchor{3ee5}
@deffn {Clase} typing.Dict (dict, MutableMapping[KT, VT])

Deprecated alias to @ref{190,,dict}.

Note that to annotate arguments, it is preferred
to use an abstract collection type such as @ref{961,,Mapping}
rather than to use @ref{190,,dict} or @code{typing.Dict}.


Obsoleto desde la versión 3.9: @ref{190,,builtins.dict} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex List (clase en typing)
@anchor{library/typing typing List}@anchor{3ee6}
@deffn {Clase} typing.List (list, MutableSequence[T])

Deprecated alias to @ref{18e,,list}.

Note that to annotate arguments, it is preferred
to use an abstract collection type such as
@ref{1231,,Sequence} or @ref{2253,,Iterable}
rather than to use @ref{18e,,list} or @code{typing.List}.


Obsoleto desde la versión 3.9: @ref{18e,,builtins.list} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Set (clase en typing)
@anchor{library/typing typing Set}@anchor{3ee7}
@deffn {Clase} typing.Set (set, MutableSet[T])

Deprecated alias to @ref{67a,,builtins.set}.

Note that to annotate arguments, it is preferred
to use an abstract collection type such as @ref{224b,,collections.abc.Set}
rather than to use @ref{67a,,set} or @ref{3ee7,,typing.Set}.


Obsoleto desde la versión 3.9: @ref{67a,,builtins.set} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex FrozenSet (clase en typing)
@anchor{library/typing typing FrozenSet}@anchor{3ee8}
@deffn {Clase} typing.FrozenSet (frozenset, AbstractSet[T_co])

Deprecated alias to @ref{67b,,builtins.frozenset}.


Obsoleto desde la versión 3.9: @ref{67b,,builtins.frozenset} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Tuple (en el módulo typing)
@anchor{library/typing typing Tuple}@anchor{3ee9}
@deffn {Dato} typing.Tuple

Deprecated alias for @ref{464,,tuple}.

@ref{464,,tuple} and @code{Tuple} are special-cased in the type system; see
@ref{3e99,,Annotating tuples} for more details.


Obsoleto desde la versión 3.9: @ref{464,,builtins.tuple} ahora soporta el uso de subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Type (clase en typing)
@anchor{library/typing typing Type}@anchor{3e9d}
@deffn {Clase} typing.Type (Generic[CT_co])

Deprecated alias to @ref{dcf,,type}.

See @ref{3e9c,,The type of class objects} for details on using @ref{dcf,,type} or
@code{typing.Type} in type annotations.


Added in version 3.5.2.



Obsoleto desde la versión 3.9: @ref{dcf,,builtins.type} ahora soporta el uso de subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@node Aliases to types in collections,Aliases to other concrete types,Aliases to built-in types,Deprecated aliases
@anchor{library/typing aliases-to-types-in-collections}@anchor{3eea}@anchor{library/typing corresponding-to-types-in-collections}@anchor{3eeb}
@subsubsection Aliases to types in @code{collections}


@geindex DefaultDict (clase en typing)
@anchor{library/typing typing DefaultDict}@anchor{3eec}
@deffn {Clase} typing.DefaultDict (collections.defaultdict, MutableMapping[KT, VT])

Deprecated alias to @ref{122a,,collections.defaultdict}.


Added in version 3.5.2.



Obsoleto desde la versión 3.9: @ref{122a,,collections.defaultdict} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex OrderedDict (clase en typing)
@anchor{library/typing typing OrderedDict}@anchor{3eed}
@deffn {Clase} typing.OrderedDict (collections.OrderedDict, MutableMapping[KT, VT])

Deprecated alias to @ref{67c,,collections.OrderedDict}.


Added in version 3.7.2.



Obsoleto desde la versión 3.9: @ref{67c,,collections.OrderedDict} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex ChainMap (clase en typing)
@anchor{library/typing typing ChainMap}@anchor{3eee}
@deffn {Clase} typing.ChainMap (collections.ChainMap, MutableMapping[KT, VT])

Deprecated alias to @ref{ca4,,collections.ChainMap}.


Added in version 3.6.1.



Obsoleto desde la versión 3.9: @ref{ca4,,collections.ChainMap} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Counter (clase en typing)
@anchor{library/typing typing Counter}@anchor{3eef}
@deffn {Clase} typing.Counter (collections.Counter, Dict[T, int])

Deprecated alias to @ref{110e,,collections.Counter}.


Added in version 3.6.1.



Obsoleto desde la versión 3.9: @ref{110e,,collections.Counter} ahora soporta subíndices (@code{[]})`. Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Deque (clase en typing)
@anchor{library/typing typing Deque}@anchor{3ef0}
@deffn {Clase} typing.Deque (deque, MutableSequence[T])

Deprecated alias to @ref{67d,,collections.deque}.


Added in version 3.6.1.



Obsoleto desde la versión 3.9: @ref{67d,,collections.deque} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@node Aliases to other concrete types,Aliases to container ABCs in collections abc,Aliases to types in collections,Deprecated aliases
@anchor{library/typing aliases-to-other-concrete-types}@anchor{3ef1}@anchor{library/typing other-concrete-types}@anchor{3ef2}
@subsubsection Aliases to other concrete types


@geindex Pattern (clase en typing)
@geindex Match (clase en typing)
@anchor{library/typing typing Pattern}@anchor{7c8}
@deffn {Clase} typing.Pattern
@anchor{library/typing typing Match}@anchor{3ef3}
@deffnx {Clase} typing.Match

Deprecated aliases corresponding to the return types from
@ref{c5b,,re.compile()} and @ref{129a,,re.match()}.

These types (and the corresponding functions) are generic over
@ref{3fb,,AnyStr}. @code{Pattern} can be specialised as @code{Pattern[str]} or
@code{Pattern[bytes]}; @code{Match} can be specialised as @code{Match[str]} or
@code{Match[bytes]}.


Obsoleto desde la versión 3.9: Las clases @code{Pattern} y @code{Match} de @ref{b9,,re} ahora soportan @code{[]}. Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Text (clase en typing)
@anchor{library/typing typing Text}@anchor{205}
@deffn {Clase} typing.Text

Deprecated alias for @ref{237,,str}.

@code{Text} is provided to supply a forward
compatible path for Python 2 code: in Python 2, @code{Text} is an alias for
@code{unicode}.

Úsese @code{Text} para indicar que un valor debe contener una cadena de texto Unicode de manera que sea compatible con Python 2 y Python 3:

@example
def add_unicode_checkmark(text: Text) -> Text:
    return text + u' \u2713'
@end example


Added in version 3.5.2.



Obsoleto desde la versión 3.11: Python 2 is no longer supported, and most type checkers also no longer
support type checking Python 2 code. Removal of the alias is not
currently planned, but users are encouraged to use
@ref{237,,str} instead of @code{Text}.

@end deffn
@anchor{library/typing abstract-base-classes}@anchor{3ef4}
@node Aliases to container ABCs in collections abc,Aliases to asynchronous ABCs in collections abc,Aliases to other concrete types,Deprecated aliases
@anchor{library/typing aliases-to-container-abcs-in-collections-abc}@anchor{3ef5}@anchor{library/typing corresponding-to-collections-in-collections-abc}@anchor{3ef6}
@subsubsection Aliases to container ABCs in @code{collections.abc}


@geindex AbstractSet (clase en typing)
@anchor{library/typing typing AbstractSet}@anchor{3ef7}
@deffn {Clase} typing.AbstractSet (Collection[T_co])

Deprecated alias to @ref{224b,,collections.abc.Set}.


Obsoleto desde la versión 3.9: @ref{224b,,collections.abc.Set} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Collection (clase en typing)
@anchor{library/typing typing Collection}@anchor{d7a}
@deffn {Clase} typing.Collection (Sized, Iterable[T_co], Container[T_co])

Deprecated alias to @ref{d11,,collections.abc.Collection}.


Added in version 3.6.



Obsoleto desde la versión 3.9: @ref{d11,,collections.abc.Collection} ahora soporta la sintaxis de subíndice (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Container (clase en typing)
@anchor{library/typing typing Container}@anchor{3ef8}
@deffn {Clase} typing.Container (Generic[T_co])

Deprecated alias to @ref{2255,,collections.abc.Container}.


Obsoleto desde la versión 3.9: @ref{2255,,collections.abc.Container} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex ItemsView (clase en typing)
@anchor{library/typing typing ItemsView}@anchor{3ef9}
@deffn {Clase} typing.ItemsView (MappingView, AbstractSet[tuple[KT_co, VT_co]])

Deprecated alias to @ref{2259,,collections.abc.ItemsView}.


Obsoleto desde la versión 3.9: @ref{2259,,collections.abc.ItemsView} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex KeysView (clase en typing)
@anchor{library/typing typing KeysView}@anchor{3efa}
@deffn {Clase} typing.KeysView (MappingView, AbstractSet[KT_co])

Deprecated alias to @ref{2258,,collections.abc.KeysView}.


Obsoleto desde la versión 3.9: @ref{2258,,collections.abc.KeysView} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Mapping (clase en typing)
@anchor{library/typing typing Mapping}@anchor{3efb}
@deffn {Clase} typing.Mapping (Collection[KT], Generic[KT, VT_co])

Deprecated alias to @ref{961,,collections.abc.Mapping}.


Obsoleto desde la versión 3.9: @ref{961,,collections.abc.Mapping} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex MappingView (clase en typing)
@anchor{library/typing typing MappingView}@anchor{3efc}
@deffn {Clase} typing.MappingView (Sized)

Deprecated alias to @ref{2257,,collections.abc.MappingView}.


Obsoleto desde la versión 3.9: @ref{2257,,collections.abc.MappingView} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex MutableMapping (clase en typing)
@anchor{library/typing typing MutableMapping}@anchor{3efd}
@deffn {Clase} typing.MutableMapping (Mapping[KT, VT])

Deprecated alias to @ref{1123,,collections.abc.MutableMapping}.


Obsoleto desde la versión 3.9: @ref{1123,,collections.abc.MutableMapping} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex MutableSequence (clase en typing)
@anchor{library/typing typing MutableSequence}@anchor{3efe}
@deffn {Clase} typing.MutableSequence (Sequence[T])

Deprecated alias to @ref{309,,collections.abc.MutableSequence}.


Obsoleto desde la versión 3.9: @ref{309,,collections.abc.MutableSequence} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex MutableSet (clase en typing)
@anchor{library/typing typing MutableSet}@anchor{3eff}
@deffn {Clase} typing.MutableSet (AbstractSet[T])

Deprecated alias to @ref{2256,,collections.abc.MutableSet}.


Obsoleto desde la versión 3.9: @ref{2256,,collections.abc.MutableSet} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Sequence (clase en typing)
@anchor{library/typing typing Sequence}@anchor{3f00}
@deffn {Clase} typing.Sequence (Reversible[T_co], Collection[T_co])

Deprecated alias to @ref{1231,,collections.abc.Sequence}.


Obsoleto desde la versión 3.9: @ref{1231,,collections.abc.Sequence} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex ValuesView (clase en typing)
@anchor{library/typing typing ValuesView}@anchor{3f01}
@deffn {Clase} typing.ValuesView (MappingView, Collection[_VT_co])

Deprecated alias to @ref{225a,,collections.abc.ValuesView}.


Obsoleto desde la versión 3.9: @ref{225a,,collections.abc.ValuesView} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@node Aliases to asynchronous ABCs in collections abc,Aliases to other ABCs in collections abc,Aliases to container ABCs in collections abc,Deprecated aliases
@anchor{library/typing aliases-to-asynchronous-abcs-in-collections-abc}@anchor{3f02}@anchor{library/typing asynchronous-programming}@anchor{3f03}
@subsubsection Aliases to asynchronous ABCs in @code{collections.abc}


@geindex Coroutine (clase en typing)
@anchor{library/typing typing Coroutine}@anchor{1954}
@deffn {Clase} typing.Coroutine (Awaitable[ReturnType], Generic[YieldType, SendType, ReturnType])

Deprecated alias to @ref{e62,,collections.abc.Coroutine}.

See @ref{2527,,Annotating generators and coroutines}
for details on using @ref{e62,,collections.abc.Coroutine}
and @code{typing.Coroutine} in type annotations.


Added in version 3.5.3.



Obsoleto desde la versión 3.9: @ref{e62,,collections.abc.Coroutine} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex AsyncGenerator (clase en typing)
@anchor{library/typing typing AsyncGenerator}@anchor{1638}
@deffn {Clase} typing.AsyncGenerator (AsyncIterator[YieldType], Generic[YieldType, SendType])

Deprecated alias to @ref{d13,,collections.abc.AsyncGenerator}.

See @ref{2527,,Annotating generators and coroutines}
for details on using @ref{d13,,collections.abc.AsyncGenerator}
and @code{typing.AsyncGenerator} in type annotations.


Added in version 3.6.1.



Obsoleto desde la versión 3.9: @code{collections.abc.AsycGenerator} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.



Distinto en la versión 3.13: The @code{SendType} parameter now has a default.

@end deffn

@geindex AsyncIterable (clase en typing)
@anchor{library/typing typing AsyncIterable}@anchor{3f04}
@deffn {Clase} typing.AsyncIterable (Generic[T_co])

Deprecated alias to @ref{e64,,collections.abc.AsyncIterable}.


Added in version 3.5.2.



Obsoleto desde la versión 3.9: @ref{e64,,collections.abc.AsyncIterable} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex AsyncIterator (clase en typing)
@anchor{library/typing typing AsyncIterator}@anchor{3f05}
@deffn {Clase} typing.AsyncIterator (AsyncIterable[T_co])

Deprecated alias to @ref{e63,,collections.abc.AsyncIterator}.


Added in version 3.5.2.



Obsoleto desde la versión 3.9: @ref{e63,,collections.abc.AsyncIterator} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Awaitable (clase en typing)
@anchor{library/typing typing Awaitable}@anchor{3f06}
@deffn {Clase} typing.Awaitable (Generic[T_co])

Deprecated alias to @ref{e61,,collections.abc.Awaitable}.


Added in version 3.5.2.



Obsoleto desde la versión 3.9: @ref{e61,,collections.abc.Awaitable} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@node Aliases to other ABCs in collections abc,Aliases to contextlib ABCs,Aliases to asynchronous ABCs in collections abc,Deprecated aliases
@anchor{library/typing aliases-to-other-abcs-in-collections-abc}@anchor{3f07}@anchor{library/typing corresponding-to-other-types-in-collections-abc}@anchor{3f08}
@subsubsection Aliases to other ABCs in @code{collections.abc}


@geindex Iterable (clase en typing)
@anchor{library/typing typing Iterable}@anchor{3ecc}
@deffn {Clase} typing.Iterable (Generic[T_co])

Deprecated alias to @ref{2253,,collections.abc.Iterable}.


Obsoleto desde la versión 3.9: @ref{2253,,collections.abc.Iterable} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Iterator (clase en typing)
@anchor{library/typing typing Iterator}@anchor{3f09}
@deffn {Clase} typing.Iterator (Iterable[T_co])

Deprecated alias to @ref{2254,,collections.abc.Iterator}.


Obsoleto desde la versión 3.9: @ref{2254,,collections.abc.Iterator} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Callable (en el módulo typing)
@anchor{library/typing typing Callable}@anchor{85e}
@deffn {Dato} typing.Callable

Deprecated alias to @ref{881,,collections.abc.Callable}.

See @ref{2526,,Annotating callable objects} for details on how to use
@ref{881,,collections.abc.Callable} and @code{typing.Callable} in type annotations.


Obsoleto desde la versión 3.9: @ref{881,,collections.abc.Callable} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.



Distinto en la versión 3.10: @code{Callable} ahora es compatible con @ref{2ca,,ParamSpec} y @ref{85d,,Concatenate}. Consulte 
@geindex Python Enhancement Proposals; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para obtener más información.

@end deffn

@geindex Generator (clase en typing)
@anchor{library/typing typing Generator}@anchor{1637}
@deffn {Clase} typing.Generator (Iterator[YieldType], Generic[YieldType, SendType, ReturnType])

Deprecated alias to @ref{e60,,collections.abc.Generator}.

See @ref{2527,,Annotating generators and coroutines}
for details on using @ref{e60,,collections.abc.Generator}
and @code{typing.Generator} in type annotations.


Obsoleto desde la versión 3.9: @ref{e60,,collections.abc.Generator} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.



Distinto en la versión 3.13: Default values for the send and return types were added.

@end deffn

@geindex Hashable (clase en typing)
@anchor{library/typing typing Hashable}@anchor{598}
@deffn {Clase} typing.Hashable

Deprecated alias to @ref{59a,,collections.abc.Hashable}.


Obsoleto desde la versión 3.12: Use @ref{59a,,collections.abc.Hashable} directly instead.

@end deffn

@geindex Reversible (clase en typing)
@anchor{library/typing typing Reversible}@anchor{3f0a}
@deffn {Clase} typing.Reversible (Iterable[T_co])

Deprecated alias to @ref{d12,,collections.abc.Reversible}.


Obsoleto desde la versión 3.9: @ref{d12,,collections.abc.Reversible} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.

@end deffn

@geindex Sized (clase en typing)
@anchor{library/typing typing Sized}@anchor{599}
@deffn {Clase} typing.Sized

Deprecated alias to @ref{59b,,collections.abc.Sized}.


Obsoleto desde la versión 3.12: Use @ref{59b,,collections.abc.Sized} directly instead.

@end deffn

@node Aliases to contextlib ABCs,,Aliases to other ABCs in collections abc,Deprecated aliases
@anchor{library/typing aliases-to-contextlib-abcs}@anchor{3f0b}@anchor{library/typing context-manager-types}@anchor{3f0c}
@subsubsection Aliases to @code{contextlib} ABCs


@geindex ContextManager (clase en typing)
@anchor{library/typing typing ContextManager}@anchor{d17}
@deffn {Clase} typing.ContextManager (Generic[T_co, ExitT_co])

Deprecated alias to @ref{d16,,contextlib.AbstractContextManager}.

The first type parameter, @code{T_co}, represents the type returned by
the @ref{669,,__enter__()} method. The optional second type parameter, @code{ExitT_co},
which defaults to @code{bool | None}, represents the type returned by the
@ref{1367,,__exit__()} method.


Added in version 3.5.4.



Obsoleto desde la versión 3.9: @ref{d16,,contextlib.AbstractContextManager} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.



Distinto en la versión 3.13: Added the optional second type parameter, @code{ExitT_co}.

@end deffn

@geindex AsyncContextManager (clase en typing)
@anchor{library/typing typing AsyncContextManager}@anchor{1635}
@deffn {Clase} typing.AsyncContextManager (Generic[T_co, AExitT_co])

Deprecated alias to @ref{bb4,,contextlib.AbstractAsyncContextManager}.

The first type parameter, @code{T_co}, represents the type returned by
the @ref{1fd1,,__aenter__()} method. The optional second type parameter, @code{AExitT_co},
which defaults to @code{bool | None}, represents the type returned by the
@ref{1636,,__aexit__()} method.


Added in version 3.6.2.



Obsoleto desde la versión 3.9: @ref{bb4,,contextlib.AbstractAsyncContextManager} ahora soporta subíndices (@code{[]}). Véase 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} y @ref{753,,Tipo Alias Genérico}.



Distinto en la versión 3.13: Added the optional second type parameter, @code{AExitT_co}.

@end deffn

@node Línea de tiempo de obsolescencia de características principales,,Contenido del módulo<3>,typing — Soporte para type hints
@anchor{library/typing deprecation-timeline-of-major-features}@anchor{3f0d}
@subsubsection Línea de tiempo de obsolescencia de características principales


Algunas características de @code{typing} están obsoletas y podrán ser removidas en versiones futuras de Python. Lo que sigue es una tabla que resume las principales obsolescencias para su conveniencia. Ésto está sujeto a cambio y no todas las obsolescencias están representadas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Característica

@tab

En desuso desde

@tab

Eliminación proyectada

@tab

PEP/issue

@item

Versiones @code{typing} de colecciones estándares

@tab

3.9

@tab

Undecided (see @ref{3ee1,,Deprecated aliases} for more information)

@tab

@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}

@item

@ref{205,,typing.Text}

@tab

3.11

@tab

No decidido

@tab

gh-92332@footnote{https://github.com/python/cpython/issues/92332}

@item

@ref{598,,typing.Hashable} and @ref{599,,typing.Sized}

@tab

3.12

@tab

No decidido

@tab

gh-94309@footnote{https://github.com/python/cpython/issues/94309}

@item

@ref{862,,typing.TypeAlias}

@tab

3.12

@tab

No decidido

@tab

@geindex Python Enhancement Proposals; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}

@item

@ref{1dc,,@@typing.no_type_check_decorator}

@tab

3.13

@tab

3.15

@tab

gh-106309@footnote{https://github.com/python/cpython/issues/106309}

@item

@ref{3fb,,typing.AnyStr}

@tab

3.13

@tab

3.18

@tab

gh-105578@footnote{https://github.com/python/cpython/issues/105578}

@end multitable


@node pydoc — Documentation generator and online help system,Modo de desarrollo de Python,typing — Soporte para type hints,Herramientas de desarrollo
@anchor{library/pydoc doc}@anchor{3f0e}@anchor{library/pydoc module-pydoc}@anchor{b5}@anchor{library/pydoc pydoc-documentation-generator-and-online-help-system}@anchor{3f0f}
@subsection @code{pydoc} — Documentation generator and online help system


@geindex module; pydoc

`Código fuente:' Lib/pydoc.py@footnote{https://github.com/python/cpython/tree/main/Lib/pydoc.py}

@geindex documentation;generation
@geindex documentation;online
@geindex help;online


__________________________________________________________________


The @code{pydoc} module automatically generates documentation from Python
modules.  The documentation can be presented as pages of text on the console,
served to a web browser, or saved to HTML files.

For modules, classes, functions and methods, the displayed documentation is
derived from the docstring (i.e. the @ref{9bb,,__doc__} attribute) of the object,
and recursively of its documentable members.  If there is no docstring,
@code{pydoc} tries to obtain a description from the block of comment lines just
above the definition of the class, function or method in the source file, or at
the top of the module (see @ref{15cf,,inspect.getcomments()}).

The built-in function @ref{96e,,help()} invokes the online help system in the
interactive interpreter, which uses @code{pydoc} to generate its documentation
as text on the console.  The same text documentation can also be viewed from
outside the Python interpreter by running @code{pydoc} as a script at the
operating system’s command prompt. For example, running

@example
python -m pydoc sys
@end example

en la entrada de la consola mostrará la documentación sobre el módulo @ref{d9,,sys}, en un estilo similar a las páginas del manual que se muestran por el comando @code{man} de Unix.  El argumento de @code{pydoc} puede ser el nombre de una función, módulo, o paquete, o una referencia con puntos (`dotted reference') de una clase, método, o función dentro de un módulo o módulo en un paquete.  Si el argumento de @code{pydoc} se parece a una ruta (`path') (es decir, que contiene el separador de rutas para tu sistema operativo como una barra en Unix), y hace referencia a un archivo fuente de Python existente, entonces se produce la documentación para ese archivo.

@cartouche
@quotation Nota 
In order to find objects and their documentation, @code{pydoc} imports the
module(s) to be documented.  Therefore, any code on module level will be
executed on that occasion.  Use an @code{if __name__ == '__main__':} guard to
only execute code when a file is invoked as a script and not just imported.
@end quotation
@end cartouche

When printing output to the console, @code{pydoc} attempts to paginate the
output for easier reading.  If either the 
@geindex MANPAGER
@geindex variables de entorno; MANPAGER
@code{MANPAGER} or the
@geindex PAGER
@geindex variables de entorno; PAGER
@code{PAGER} environment variable is set, @code{pydoc} will use its
value as a pagination program. When both are set, 
@geindex MANPAGER
@geindex variables de entorno; MANPAGER
@code{MANPAGER} is used.

Especificar un bandera (`flag') @code{-w} antes del argumento hará que la documentación HTML sea escrita en un archivo de la carpeta actual, en vez de mostrar el texto en la consola.

Especificar una bandera (`flag') @code{-k} antes del argumento buscará las líneas de la sinopsis de todos los módulos disponibles por la palabra clave (`keyword') dada como argumento, de nuevo en una manera similar al comando @code{man} de Unix.  La sinopsis de un módulo es la primera línea de su cadena de documentación.

You can also use @code{pydoc} to start an HTTP server on the local machine
that will serve documentation to visiting web browsers.  @code{python -m pydoc -p 1234}
will start a HTTP server on port 1234, allowing you to browse the
documentation at @code{http://localhost:1234/} in your preferred web browser.
Specifying @code{0} as the port number will select an arbitrary unused port.

@code{python -m pydoc -n <hostname>} will start the server listening at the given
hostname.  By default the hostname is “localhost” but if you want the server to
be reached from other machines, you may want to change the host name that the
server responds to.  During development this is especially useful if you want
to run pydoc from within a container.

@code{python -m pydoc -b} will start the server and additionally open a web
browser to a module index page.  Each served page has a navigation bar at the
top where you can `Get' help on an individual item, `Search' all modules with a
keyword in their synopsis line, and go to the `Module index', `Topics' and
`Keywords' pages.

Cuando @code{pydoc} genera la documentación, se usa el entorno y ruta actual para localizar los módulos.  Así, invocar @code{pydoc spam} precisamente documenta la versión del módulo que tu obtendrías si empezaras el interpretador de Python y escribieras @code{import spam}.

Module docs for core modules are assumed to reside in
@code{https://docs.python.org/X.Y/library/} where @code{X} and @code{Y} are the
major and minor version numbers of the Python interpreter.  This can
be overridden by setting the @code{PYTHONDOCS} environment variable
to a different URL or to a local directory containing the Library
Reference Manual pages.


Distinto en la versión 3.2: Se añadió la opción @code{-b}.



Distinto en la versión 3.3: La opción de la línea de comandos @code{-g} se eliminó.



Distinto en la versión 3.4: @code{pydoc} now uses @ref{181,,inspect.signature()} rather than
@ref{7d4,,inspect.getfullargspec()} to extract signature information from
callables.



Distinto en la versión 3.7: Se añadió la opción @code{-n}.


@node Modo de desarrollo de Python,doctest — Test interactive Python examples,pydoc — Documentation generator and online help system,Herramientas de desarrollo
@anchor{library/devmode doc}@anchor{3f10}@anchor{library/devmode devmode}@anchor{356}@anchor{library/devmode python-development-mode}@anchor{3f11}
@subsection Modo de desarrollo de Python



Added in version 3.7.


El modo de desarrollo de Python introduce comprobaciones adicionales en tiempo de ejecución que son muy costosas para ser activadas por defecto. No debería ser más verboso que el predeterminado si el código es correcto; sólo se emiten nuevas advertencias cuando se detecta un problema.

Puede activarse mediante la opción de línea de comandos @ref{2e2,,-X dev} o estableciendo la variable de entorno 
@geindex PYTHONDEVMODE
@geindex variables de entorno; PYTHONDEVMODE
@ref{b78,,PYTHONDEVMODE} en @code{1}.

Consulte también @ref{357,,Compilación de depuración de Python}.

@menu
* Efectos del modo de desarrollo de Python:: 
* Ejemplo de ResourceWarning:: 
* Ejemplo de error de descriptor de archivo incorrecto:: 

@end menu

@node Efectos del modo de desarrollo de Python,Ejemplo de ResourceWarning,,Modo de desarrollo de Python
@anchor{library/devmode effects-of-the-python-development-mode}@anchor{3f12}
@subsubsection Efectos del modo de desarrollo de Python


Activar el modo de desarrollo de Python es similar al siguiente comando, pero con efectos adicionales que se describen a continuación:

@example
PYTHONMALLOC=debug PYTHONASYNCIODEBUG=1 python -W default -X faulthandler
@end example

Efectos del modo de desarrollo de Python:


@itemize *

@item 
Añadir @code{default} @ref{1d3f,,filtro de avisos}.Se muestran las siguientes advertencias:


@itemize *

@item 
@ref{1da,,DeprecationWarning}

@item 
@ref{59f,,ImportWarning}

@item 
@ref{95f,,PendingDeprecationWarning}

@item 
@ref{39d,,ResourceWarning}
@end itemize

Normalmente, los advertencias son filtradas por defecto @ref{1d3f,,warning filters}.

Se comporta como si se utilizara la opción de línea de comandos @ref{95e,,-W default}.

Utilice la opción de línea de comandos @ref{95e,,-W error} o establezca la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} en @code{error} para tratar las advertencias como errores.

@item 
Instalar hooks(enganches) de depuración en los asignadores de memoria para comprobar:


@itemize *

@item 
Desbordamiento del búfer

@item 
Sobrecarga del búfer

@item 
Violación de la API del asignador de memoria

@item 
Uso inseguro del GIL
@end itemize

Ver la función en C @ref{cf2,,PyMem_SetupDebugHooks()}.

Se comporta como si la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} estuviera establecida en @code{debug}.

Para activar el modo de desarrollo de Python sin instalar ganchos de depuración en los asignadores de memoria, establezca la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} a @code{default}.

@item 
Llama a @ref{d27,,faulthandler.enable()} al inicio de Python para instalar los handlers(manejadores) de las señales @ref{1d4f,,SIGSEGV}, @ref{1d50,,SIGFPE}, @ref{1d51,,SIGABRT}, @ref{1d52,,SIGBUS} y @ref{1d53,,SIGILL} para volcar la traza de Python en caso de fallo.

Se comporta como si se utilizara la opción de línea de comandos @ref{2e2,,-X faulthandler} o si la variable de entorno 
@geindex PYTHONFAULTHANDLER
@geindex variables de entorno; PYTHONFAULTHANDLER
@ref{10fc,,PYTHONFAULTHANDLER} se establece en @code{1}.

@item 
Habilitar @ref{1d55,,asyncio debug mode}. Por ejemplo, @ref{b,,asyncio} comprueba las corutinas que no fueron esperadas y las registra.

Se comporta como si la variable de entorno 
@geindex PYTHONASYNCIODEBUG
@geindex variables de entorno; PYTHONASYNCIODEBUG
@ref{1d54,,PYTHONASYNCIODEBUG} estuviera establecida en @code{1}.

@item 
Comprueba los argumentos `encoding' y `errors' para las operaciones de codificación y decodificación de cadenas. Ejemplos: @ref{1be,,open()}, @ref{96c,,str.encode()} y @ref{96d,,bytes.decode()}.

Por defecto, para un mejor rendimiento, el argumento `errors' sólo se comprueba en el primer error de codificación/decodificación y el argumento `encoding' a veces se ignora para las cadenas vacías.

@item 
El destructor de @ref{353,,io.IOBase} registra las excepciones @code{close()}.

@item 
Establece el atributo @ref{1aa8,,dev_mode} de @ref{72d,,sys.flags} a @code{True}.
@end itemize

El Modo de Desarrollo de Python no habilita el módulo @ref{ff,,tracemalloc} por defecto, porque el costo de la sobrecarga (para el rendimiento y la memoria) sería demasiado grande. Activar el módulo @ref{ff,,tracemalloc} proporciona información adicional sobre el origen de algunos errores. Por ejemplo, @ref{39d,,ResourceWarning} registra la traza donde se asignó el recurso, y un error de desbordamiento de búfer registra la traza donde se asignó el bloque de memoria.

El modo de desarrollo de Python no impide que la opción de línea de comandos @ref{14f,,-O} elimine las declaraciones @ref{9fa,,assert} ni que establezca @ref{871,,__debug__} a @code{False}.

El modo de desarrollo de Python solo se puede habilitar en el inicio de Python. Su valor se puede leer en @ref{72d,,sys.flags.dev_mode}.


Distinto en la versión 3.8: El destructor de @ref{353,,io.IOBase} ahora registra las excepciones @code{close()}.



Distinto en la versión 3.9: Los argumentos `enconding' y `errors' se comprueban ahora para las operaciones de codificación y descodificación de cadenas.


@node Ejemplo de ResourceWarning,Ejemplo de error de descriptor de archivo incorrecto,Efectos del modo de desarrollo de Python,Modo de desarrollo de Python
@anchor{library/devmode resourcewarning-example}@anchor{3f13}
@subsubsection Ejemplo de ResourceWarning


Ejemplo de un script que cuenta el número de líneas del archivo de texto especificado en la línea de comandos:

@example
import sys

def main():
    fp = open(sys.argv[1])
    nlines = len(fp.readlines())
    print(nlines)
    # The file is closed implicitly

if __name__ == "__main__":
    main()
@end example

El script no cierra el archivo explícitamente. Por defecto, Python no emite ninguna advertencia. Ejemplo usando README.txt, que tiene 269 líneas:

@example
$ python script.py README.txt
269
@end example

Al activar el modo de desarrollo de Python aparece una advertencia @ref{39d,,ResourceWarning}:

@example
$ python -X dev script.py README.txt
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
@end example

Además, al activar @ref{ff,,tracemalloc} se muestra la línea en la que se abrió el archivo:

@example
$ python -X dev -X tracemalloc=5 script.py README.rst
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
Object allocated at (most recent call last):
  File "script.py", lineno 10
    main()
  File "script.py", lineno 4
    fp = open(sys.argv[1])
@end example

La solución es cerrar explícitamente el archivo. Ejemplo utilizando un gestor de contexto:

@example
def main():
    # Close the file explicitly when exiting the with block
    with open(sys.argv[1]) as fp:
        nlines = len(fp.readlines())
    print(nlines)
@end example

No cerrar un recurso explícitamente puede dejar un recurso abierto durante mucho más tiempo del estimado; puede causar graves problemas al salir de Python. Es malo en CPython, pero es aún peor en PyPy. Cerrar los recursos explícitamente hace que una aplicación sea más detallista y más fiable.

@node Ejemplo de error de descriptor de archivo incorrecto,,Ejemplo de ResourceWarning,Modo de desarrollo de Python
@anchor{library/devmode bad-file-descriptor-error-example}@anchor{3f14}
@subsubsection Ejemplo de error de descriptor de archivo incorrecto


Script que muestra la primera línea de sí mismo:

@example
import os

def main():
    fp = open(__file__)
    firstline = fp.readline()
    print(firstline.rstrip())
    os.close(fp.fileno())
    # The file is closed implicitly

main()
@end example

Por defecto, Python no emite ninguna advertencia:

@example
$ python script.py
import os
@end example

El modo de desarrollo de Python muestra un @ref{39d,,ResourceWarning} y registra un error «Bad file descriptor» cuando termina el objeto archivo:

@example
$ python -X dev script.py
import os
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
Exception ignored in: <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
Traceback (most recent call last):
  File "script.py", line 10, in <module>
    main()
OSError: [Errno 9] Bad file descriptor
@end example

@code{os.close(fp.fileno())} cierra el descriptor de archivo. Cuando el finalizador de objetos de archivo intenta cerrar el descriptor de archivo de nuevo, falla con el error @code{Bad file descriptor}. Un descriptor de archivo debe cerrarse sólo una vez. En el peor de los casos, cerrarlo dos veces puede provocar un fallo (ver bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748} para un ejemplo).

La solución es eliminar la línea @code{os.close(fp.fileno())}, o abrir el archivo con @code{closefd=False}.

@node doctest — Test interactive Python examples,unittest — Unit testing framework,Modo de desarrollo de Python,Herramientas de desarrollo
@anchor{library/doctest doc}@anchor{3f15}@anchor{library/doctest doctest-test-interactive-python-examples}@anchor{3f16}@anchor{library/doctest module-doctest}@anchor{3b}
@subsection @code{doctest} — Test interactive Python examples


@geindex module; doctest

`Código fuente:' Lib/doctest.py@footnote{https://github.com/python/cpython/tree/main/Lib/doctest.py}


__________________________________________________________________


El módulo @ref{3b,,doctest} busca pedazos de texto que lucen como sesiones interactivas de Python, y entonces ejecuta esas sesiones para verificar que funcionen exactamente como son mostradas. Hay varias maneras de usar doctest:


@itemize *

@item 
Para revisar que los docstrings de un módulo están al día al verificar que todos los ejemplos interactivos todavía trabajan como está documentado.

@item 
Para realizar pruebas de regresión al verificar que los ejemplos interactivos de un archivo de pruebas o un objeto de pruebas trabaje como sea esperado.

@item 
Para escribir documentación de tutorial para un paquete, generosamente ilustrado con ejemplos de entrada-salida. Dependiendo si los ejemplos o el texto expositivo son enfatizados, tiene el sabor de «pruebas literarias» o «documentación ejecutable».
@end itemize

Aquí hay un módulo de ejemplo completo pero pequeño:

@example
"""
This is the "example" module.

The example module supplies one function, factorial().  For example,

>>> factorial(5)
120
"""

def factorial(n):
    """Return the factorial of n, an exact integer >= 0.

    >>> [factorial(n) for n in range(6)]
    [1, 1, 2, 6, 24, 120]
    >>> factorial(30)
    265252859812191058636308480000000
    >>> factorial(-1)
    Traceback (most recent call last):
        ...
    ValueError: n must be >= 0

    Factorials of floats are OK, but the float must be an exact integer:
    >>> factorial(30.1)
    Traceback (most recent call last):
        ...
    ValueError: n must be exact integer
    >>> factorial(30.0)
    265252859812191058636308480000000

    It must also not be ridiculously large:
    >>> factorial(1e100)
    Traceback (most recent call last):
        ...
    OverflowError: n too large
    """

    import math
    if not n >= 0:
        raise ValueError("n must be >= 0")
    if math.floor(n) != n:
        raise ValueError("n must be exact integer")
    if n+1 == n:  # catch a value like 1e300
        raise OverflowError("n too large")
    result = 1
    factor = 2
    while factor <= n:
        result *= factor
        factor += 1
    return result


if __name__ == "__main__":
    import doctest
    doctest.testmod()
@end example

Si ejecutas @code{example.py} directamente desde la línea de comandos, @ref{3b,,doctest} hará su magia:

@example
$ python example.py
$
@end example

¡No hay salida! Eso es normal, y significa que todos los ejemplos funcionaron. Pasa @code{-v} al script, y @ref{3b,,doctest} imprime un registro detallado de lo que está intentando, e imprime un resumen al final:

@example
$ python example.py -v
Trying:
    factorial(5)
Expecting:
    120
ok
Trying:
    [factorial(n) for n in range(6)]
Expecting:
    [1, 1, 2, 6, 24, 120]
ok
@end example

Y demás, eventualmente terminando con:

@example
Trying:
    factorial(1e100)
Expecting:
    Traceback (most recent call last):
        ...
    OverflowError: n too large
ok
2 items passed all tests:
   1 test in __main__
   6 tests in __main__.factorial
7 tests in 2 items.
7 passed.
Test passed.
$
@end example

That’s all you need to know to start making productive use of @ref{3b,,doctest}!
Jump in.  The following sections provide full details.  Note that there are many
examples of doctests in the standard Python test suite and libraries.
Especially useful examples can be found in the standard test file
@code{Lib/test/test_doctest/test_doctest.py}.

@menu
* Uso simple; verificar ejemplos en docstrings: Uso simple verificar ejemplos en docstrings. 
* Uso Simple; Verificar ejemplos en un Archivo de Texto: Uso Simple Verificar ejemplos en un Archivo de Texto. 
* Cómo funciona:: 
* API básica:: 
* API de unittest:: 
* API avanzada:: 
* Depuración:: 
* Plataforma improvisada:: 

@end menu

@node Uso simple verificar ejemplos en docstrings,Uso Simple Verificar ejemplos en un Archivo de Texto,,doctest — Test interactive Python examples
@anchor{library/doctest doctest-simple-testmod}@anchor{3f17}@anchor{library/doctest simple-usage-checking-examples-in-docstrings}@anchor{3f18}
@subsubsection Uso simple: verificar ejemplos en docstrings


The simplest way to start using doctest (but not necessarily the way you’ll
continue to do it) is to end each module @code{M} with:

@example
if __name__ == "__main__":
    import doctest
    doctest.testmod()
@end example

@code{doctest} then examines docstrings in module @code{M}.

Ejecutar el módulo como un script causa que los ejemplos en los docstrings se ejecuten y sean verificados:

@example
python M.py
@end example

No mostrará nada a menos que un ejemplo falle, en cuyo caso el ejemplo fallido o ejemplos fallidos y sus causas de la falla son imprimidas a stdout, y la línea final de salida es @code{***Test Failed*** N failures.}, donde `N' es el número de ejemplos que fallaron.

Ejecútalo con el modificador @code{-v} en su lugar:

@example
python M.py -v
@end example

y un reporte detallado de todos los ejemplos intentados es impreso a la salida estándar, junto con resúmenes clasificados  al final.

Puedes forzar el modo verboso al pasar @code{verbose=True} a @ref{14aa,,testmod()}, o prohibirlo al pasarlo @code{verbose=False}. En cualquiera de estas casos, @code{sys.argv} no es examinado por @ref{14aa,,testmod()} (por lo que pasar o no @code{-v}, no tiene efecto).

También hay un atajo de línea de comandos para ejecutar @ref{14aa,,testmod()}. Puedes instruir al intérprete de Python para ejecutar el módulo doctest directamente de la biblioteca estándar y pasar los nombres del módulo en la línea de comandos:

@example
python -m doctest -v example.py
@end example

Esto importará @code{example.py} como un módulo independiente y ejecutará a @ref{14aa,,testmod()}. Note que esto puede no funcionar correctamente si el archivo es parte de un paquete e importa otros submódulos de ese paquete.

Para más información de @ref{14aa,,testmod()}, consulte la sección @ref{3f19,,API básica}.

@node Uso Simple Verificar ejemplos en un Archivo de Texto,Cómo funciona,Uso simple verificar ejemplos en docstrings,doctest — Test interactive Python examples
@anchor{library/doctest doctest-simple-testfile}@anchor{3f1a}@anchor{library/doctest simple-usage-checking-examples-in-a-text-file}@anchor{3f1b}
@subsubsection Uso Simple: Verificar ejemplos en un Archivo de Texto


Otra simple aplicación de doctest es probar ejemplos interactivos en un archivo de texto.  Esto puede ser hecho con la función @ref{3f1c,,testfile()}:

@example
import doctest
doctest.testfile("example.txt")
@end example

Este script corto ejecuta y verifica cualquier ejemplo interactivo de Python contenido en el archivo @code{example.txt}. El contenido del archivo es tratado como si fuese un solo gran docstring; ¡el archivo no necesita contener un programa de Python! Por ejemplo, tal vez @code{example.txt} contenga esto:

@example
The `@w{`}example`@w{`} module
======================

Using `@w{`}factorial`@w{`}
-------------------

This is an example text file in reStructuredText format.  First import
`@w{`}factorial`@w{`} from the `@w{`}example`@w{`} module:

    >>> from example import factorial

Now use it:

    >>> factorial(6)
    120
@end example

Ejecutar @code{doctest.testfile("example.txt")} entonces encuentra el error en esta documentación:

@example
File "./example.txt", line 14, in example.txt
Failed example:
    factorial(6)
Expected:
    120
Got:
    720
@end example

Como con @ref{14aa,,testmod()}, @ref{3f1c,,testfile()} no mostrará nada a menos que un ejemplo falle. Si un ejemplo no falla, entonces los ejemplos fallidos y sus causas son impresas a stdout, usando el mismo formato como @ref{14aa,,testmod()}.

Por defecto, @ref{3f1c,,testfile()} busca archivos en el directorio del módulo al que se llama. Véase la sección @ref{3f19,,API básica} para una descripción de los argumentos opcionales que pueden ser usados para decirle que busque archivos en otros lugares.

Como @ref{14aa,,testmod()}, la verbosidad de @ref{3f1c,,testfile()} puede ser establecida con el modificador de la línea de comandos @code{-v} o con el argumento por palabra clave opcional `verbose'.

También hay un atajo de línea de comandos para ejecutar @ref{3f1c,,testfile()}. Puedes indicar al intérprete de Python para correr el módulo doctest directamente desde la biblioteca estándar y pasar el nombre de los archivos en la línea de comandos:

@example
python -m doctest -v example.txt
@end example

Porque el nombre del archivo no termina con @code{.py}, @ref{3b,,doctest} infiere que se debe ejecutar con @ref{3f1c,,testfile()}, no @ref{14aa,,testmod()}.

Para más información en @ref{3f1c,,testfile()}, véase la sección @ref{3f19,,API básica}.

@node Cómo funciona,API básica,Uso Simple Verificar ejemplos en un Archivo de Texto,doctest — Test interactive Python examples
@anchor{library/doctest doctest-how-it-works}@anchor{3f1d}@anchor{library/doctest how-it-works}@anchor{3f1e}
@subsubsection Cómo funciona


Esta sección examina en detalle cómo funciona doctest: qué docstrings revisa, cómo encuentra ejemplos interactivos, qué contexto de ejecución usa, cómo maneja las excepciones, y cómo las banderas pueden ser usadas para controlar su comportamiento. Esta es la información que necesitas saber para escribir ejemplos de doctest; para información sobre ejecutar doctest en estos ejemplos, véase las siguientes secciones.

@menu
* ¿Qué docstrings son examinados?:: 
* ¿Cómo se reconocen los ejemplos de docstring?:: 
* ¿Cuál es el contexto de ejecución?:: 
* ¿Y las excepciones?:: 
* Banderas de Opción:: 
* Directivas:: 
* Advertencias: Advertencias<2>. 

@end menu

@node ¿Qué docstrings son examinados?,¿Cómo se reconocen los ejemplos de docstring?,,Cómo funciona
@anchor{library/doctest doctest-which-docstrings}@anchor{3f1f}@anchor{library/doctest which-docstrings-are-examined}@anchor{3f20}
@subsubsection ¿Qué docstrings son examinados?


Se busca en el docstring del módulo, y todos los docstrings de las funciones, clases, y métodos.  Los objetos importados en el módulo no se buscan.

In addition, there are cases when you want tests to be part of a module but not part
of the help text, which requires that the tests not be included in the docstring.
Doctest looks for a module-level variable called @code{__test__} and uses it to locate other
tests. If @code{M.__test__} exists, it must be a dict, and each
entry maps a (string) name to a function object, class object, or string.
Function and class object docstrings found from @code{M.__test__} are searched, and
strings are treated as if they were docstrings.  In output, a key @code{K} in
@code{M.__test__} appears with name @code{M.__test__.K}.

For example, place this block of code at the top of @code{example.py}:

@example
__test__ = @{
    'numbers': """
>>> factorial(6)
720

>>> [factorial(n) for n in range(6)]
[1, 1, 2, 6, 24, 120]
"""
@}
@end example

The value of @code{example.__test__["numbers"]} will be treated as a
docstring and all the tests inside it will be run. It is
important to note that the value can be mapped to a function,
class object, or module; if so, @code{doctest}
searches them recursively for docstrings, which are then scanned for tests.

Todas las clases encontradas se buscan recursivamente de manera similar, para probar docstrings en sus métodos contenidos y clases anidadas.

@node ¿Cómo se reconocen los ejemplos de docstring?,¿Cuál es el contexto de ejecución?,¿Qué docstrings son examinados?,Cómo funciona
@anchor{library/doctest doctest-finding-examples}@anchor{3f21}@anchor{library/doctest how-are-docstring-examples-recognized}@anchor{3f22}
@subsubsection ¿Cómo se reconocen los ejemplos de docstring?


En la mayoría de los casos un copiar y pegar de una sesión de consola interactiva funciona bien, pero doctest no está intentando hacer una emulación exacta de ningún shell específico de Python.

@example
>>> # comments are ignored
>>> x = 12
>>> x
12
>>> if x == 13:
...     print("yes")
... else:
...     print("no")
...     print("NO")
...     print("NO!!!")
...
no
NO
NO!!!
>>>
@end example

@geindex >>>;interpreter prompt
@geindex ...;interpreter prompt

Cualquier salida esperada debe seguir inmediatamente el final de la línea @code{'>>>'} o @code{'...'} conteniendo el código, y la salida esperada (si la hubiera) se extiende hasta el siguiente @code{'>>>'} o la línea en blanco.

La letra pequeña:


@itemize *

@item 
La salida esperada no puede contener una línea de espacios en blanco, ya que ese tipo de línea se toma para indicar el fin de la salida esperada. Si la salida esperada de verdad contiene una línea en blanco, pon @code{<BLANKLINE>} en tu ejemplo de doctest en cada lugar donde una línea en blanco sea esperada.

@item 
Todos los caracteres de tabulación se expanden a espacios, usando paradas de tabulación de 8 -columnas. Las tabulaciones generadas por el código en pruebas no son modificadas. Ya que todas las tabulaciones en la salida de prueba `son' expandidas, significa que si el código de salida incluye tabulaciones, la única manera de que el doctest pueda pasar es si la opción @ref{3f23,,NORMALIZE_WHITESPACE} o @ref{3f24,,directive} está en efecto. Alternativamente, la prueba puede ser reescrita para capturar la salida y compararla a un valor esperado como parte de la prueba. Se llegó a este tratamiento de tabulaciones en la fuente a través de prueba y error, y ha demostrado ser la manera menos propensa a errores de manejarlos. Es posible usar un algoritmo diferente para manejar tabulaciones al escribir una clase @ref{3f25,,DocTestParser} personalizada.

@item 
La salida a stdout es capturada, pero no la salida a stderr (los rastreos de la excepción son capturados a través de maneras diferentes).

@item 
Si continuas una línea poniendo una barra invertida en una sesión interactiva, o por cualquier otra razón usas una barra invertida, debes usar un docstring crudo, que preservará tus barras invertidas exactamente como las escribes:

@example
>>> def f(x):
...     r'@w{'}'Backslashes in a raw docstring: m\n'@w{'}'
...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
@end example

De otra manera, la barra invertida será interpretada como parte de una cadena. Por ejemplo, el @code{\n} arriba sería interpretado como un carácter de nueva línea. Alternativamente, puedes duplicar cada barra invertida en  la versión de doctest (y no usar una cadena de caracteres cruda):

@example
>>> def f(x):
...     '@w{'}'Backslashes in a raw docstring: m\\n'@w{'}'
...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
@end example

@item 
La columna inicial no importa:

@example
>>> assert "Easy!"
      >>> import math
          >>> math.floor(1.9)
          1
@end example

y tantos espacios en blanco al principio se eliminan de la salida esperada como aparece en la línea @code{'>>>'} inicial que empezó el ejemplo.
@end itemize

@node ¿Cuál es el contexto de ejecución?,¿Y las excepciones?,¿Cómo se reconocen los ejemplos de docstring?,Cómo funciona
@anchor{library/doctest doctest-execution-context}@anchor{3f26}@anchor{library/doctest what-s-the-execution-context}@anchor{3f27}
@subsubsection ¿Cuál es el contexto de ejecución?


By default, each time @ref{3b,,doctest} finds a docstring to test, it uses a
`shallow copy' of @code{M}’s globals, so that running tests doesn’t change the
module’s real globals, and so that one test in @code{M} can’t leave behind
crumbs that accidentally allow another test to work.  This means examples can
freely use any names defined at top-level in @code{M}, and names defined earlier
in the docstring being run. Examples cannot see names defined in other
docstrings.

Puedes forzar el uso de tus propios diccionarios como contexto de ejecución al pasar @code{globs=your_dict} a @ref{14aa,,testmod()} o @ref{3f1c,,testfile()} en su lugar.

@node ¿Y las excepciones?,Banderas de Opción,¿Cuál es el contexto de ejecución?,Cómo funciona
@anchor{library/doctest doctest-exceptions}@anchor{3f28}@anchor{library/doctest what-about-exceptions}@anchor{3f29}
@subsubsection ¿Y las excepciones?


No hay problema, siempre que el rastreo sea la única salida producida por el ejemplo: sólo copia el rastreo.  @footnote{
No se admiten los ejemplos que contienen una salida esperada y una excepción. Intentar adivinar dónde una termina y la otra empieza es muy propenso a errores, y da lugar a una prueba confusa.
} Ya que los rastreos contienen detalles que probablemente cambien rápidamente (por ejemplo, rutas de archivos exactas y números de línea), este es un caso donde doctest trabaja duro para ser flexible en lo que acepta.

Ejemplo simple:

@example
>>> [1, 2, 3].remove(42)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: list.remove(x): x not in list
@end example

El doctest tiene éxito si se lanza @ref{360,,ValueError}, con el detalle @code{list.remove(x): x not in list} como se muestra.

La salida esperada para una excepción debe empezar con una cabecera de rastreo, que puede ser una de las siguientes dos líneas, con el mismo sangrado de la primera línea del ejemplo:

@example
Traceback (most recent call last):
Traceback (innermost last):
@end example

La cabecera de rastreo es seguida por una pila de rastreo opcional, cuyo contenido es ignorado por doctest.  La pila de rastreo es típicamente omitida, o copiada palabra por palabra de una sesión interactiva.

La pila de rastreo es seguida por la parte más interesante: la línea o líneas conteniendo el tipo de excepción y detalle. Esto es usualmente la última línea de un rastreo, pero se puede extender a través de múltiples líneas si la excepción tiene un detalle de varias líneas:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: multi
    line
detail
@end example

Las últimas tres líneas (empezando con @ref{360,,ValueError}) son comparados con el tipo de excepción y detalle, y el resto es ignorado.

La mejor práctica es omitir la pila de rastreo, a menos que añada valor de documentación significante al ejemplo. Por lo que el último ejemplo es probablemente mejor como:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
    ...
ValueError: multi
    line
detail
@end example

Note que los rastreos son tratados de manera especial. En particular, en el ejemplo reescrito, el uso de @code{...} es independiente de la opción @ref{14ab,,ELLIPSIS} de doctest. Se pueden excluir los puntos suspensivos en ese ejemplo, así como también pueden haber tres (o trescientas) comas o dígitos, o una transcripción sangrada de un `sketch' de Monty Python.

Algunos detalles que debes leer una vez, pero no necesitarás recordar:


@itemize *

@item 
Doctest no puede adivinar si tu salida esperada vino de una excepción de rastreo o de una impresión ordinaria. Así que, un ejemplo que espera @code{ValueError: 42 is prime} pasará, ya sea si de hecho se lance @ref{360,,ValueError} o si el ejemplo simplemente imprime ese texto de rastreo. En la práctica, la salida ordinaria raramente comienza con una línea de cabecera de rastreo, por lo que esto no crea problemas reales.

@item 
Cada línea de la pila de rastreo (si se presenta) debe estar más sangrada que la primera línea del ejemplo, `o' empezar con un carácter no alfanumérico. la primera línea que sigue a la cabecera de rastreo sangrada de igual forma y empezando con un alfanumérico es considerado el inicio del detalle de la excepción. Por supuesto que esto es lo correcto para rastreos genuinos.

@item 
Cuando se especifica la opción @ref{1370,,IGNORE_EXCEPTION_DETAIL} de doctest. todo lo que sigue a los dos puntos más a la izquierda y cualquier otra información del módulo en el nombre de la excepción se ignora.

@item 
El shell interactivo omite la línea de la cabecera de rastreo para algunos @ref{150,,SyntaxError}. Pero doctest usa la línea de la cabecera de rastreo para distinguir excepciones de los que no son. Así que en algunos casos raros donde necesitas probar un @ref{150,,SyntaxError} que omite la cabecera de rastreo, necesitarás poner manualmente la línea de cabecera de rastreo en tu ejemplo de prueba.
@end itemize

@geindex ^ (caret);marker


@itemize *

@item 
En el caso de algunas excepciones Python señala la posición donde ocurrió el error usando un marcador @code{^}:

@example
>>> 1 + None
  File "<stdin>", line 1
    1 + None
    ~~^~~~~~
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
@end example

Ya que las líneas mostrando la posición del error vienen antes del tipo de excepción y detalle, no son revisadas por doctest. Por ejemplo, el siguiente test pasaría, a pesar de que pone el marcador @code{^} en la posición equivocada:

@example
>>> 1 + None
  File "<stdin>", line 1
    1 + None
    ^~~~~~~~
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
@end example
@end itemize
@anchor{library/doctest option-flags-and-directives}@anchor{3f2a}
@node Banderas de Opción,Directivas,¿Y las excepciones?,Cómo funciona
@anchor{library/doctest doctest-options}@anchor{fb3}@anchor{library/doctest option-flags}@anchor{3f2b}
@subsubsection Banderas de Opción


Varias banderas de opción controlan diversos aspectos del comportamiento de doctest. Los nombres simbólicos para las banderas son proporcionados como constantes del módulo, que se pueden conectar mediante @ref{206d,,*OR* bit a bit}  y pasar a varias funciones. Los nombres también pueden ser usados en las @ref{3f24,,directivas de doctest}, y se pueden pasar a la interfaz de la línea de comandos de doctest a través de la opción @code{-o}.


Added in version 3.4: La opción de la línea de comandos @code{-o}.


El primer grupo de opciones definen las semánticas de la prueba, controlando aspectos de cómo doctest decide si la salida de hecho concuerda con la salida esperada del ejemplo:

@geindex DONT_ACCEPT_TRUE_FOR_1 (en el módulo doctest)
@anchor{library/doctest doctest DONT_ACCEPT_TRUE_FOR_1}@anchor{3f2c}
@deffn {Dato} doctest.DONT_ACCEPT_TRUE_FOR_1

Por defecto, si un bloque de salida esperada contiene sólo @code{1}, se considera igual a un bloque de salida real conteniendo sólo @code{1} o @code{true}, y similarmente para @code{0} contra @code{False}. Cuando se especifica @code{DONT_ACCEPT_TRUE_FOR_1`}, no se permite ninguna sustitución.  El comportamiento por defecto atiende a que Python cambió el tipo de retorno de muchas funciones de enteros a booleanos; los doctest esperando salidas «de pequeño enteros» todavía trabajan en estos casos. Esta opción probablemente se vaya, pero no por muchos años.
@end deffn

@geindex <BLANKLINE>

@geindex DONT_ACCEPT_BLANKLINE (en el módulo doctest)
@anchor{library/doctest doctest DONT_ACCEPT_BLANKLINE}@anchor{3f2d}
@deffn {Dato} doctest.DONT_ACCEPT_BLANKLINE

Por defecto, si un bloque de salida esperada contiene una línea que sólo tiene la cadena de caracteres @code{<BLANKLINE>}, entonces esa línea corresponderá a una línea en blanco en la salida real. Ya que una línea en blanca auténtica delimita la salida esperada, esta es la única manera de comunicar que una línea en blanco es esperada. Cuando se especifica @ref{3f2d,,DONT_ACCEPT_BLANKLINE}, esta substitución no se permite.
@end deffn

@geindex NORMALIZE_WHITESPACE (en el módulo doctest)
@anchor{library/doctest doctest NORMALIZE_WHITESPACE}@anchor{3f23}
@deffn {Dato} doctest.NORMALIZE_WHITESPACE

Cuando se especifica, todas las secuencias de espacios en blanco (vacías y nuevas líneas) son tratadas como iguales. Cualquier secuencia de espacios en blanco dentro de la salida esperada corresponderá a cualquier secuencia de espacios en blanco dentro de la salida real. Por defecto, los espacios en blanco deben corresponderse exactamente.  @ref{3f23,,NORMALIZE_WHITESPACE} es especialmente útil cuando una línea de la salida esperada es muy larga, y quieres envolverla a través de múltiples líneas en tu código fuente.
@end deffn

@geindex ...;in doctests

@geindex ELLIPSIS (en el módulo doctest)
@anchor{library/doctest doctest ELLIPSIS}@anchor{14ab}
@deffn {Dato} doctest.ELLIPSIS

Cuando se especifica, un marcador de puntos suspensivos (@code{...}) en la salida esperada puede corresponder a cualquier cadena de caracteres en la salida real. Esto incluye las cadenas de caracteres que abarcan límites de líneas, y cadenas de caracteres vacías, por lo que es mejor mantener su uso simple. Usos complicados pueden conducir a los mismo tipos de sorpresa de «ups, coincidió demasiado» que @code{.*} es propenso a hacer en expresiones regulares.
@end deffn

@geindex IGNORE_EXCEPTION_DETAIL (en el módulo doctest)
@anchor{library/doctest doctest IGNORE_EXCEPTION_DETAIL}@anchor{1370}
@deffn {Dato} doctest.IGNORE_EXCEPTION_DETAIL

Cuando se especifica, las excepciones que doctest espera, pasarán siempre que sea lanzada una excepción del tipo esperado, incluso si los detalles (mensaje y nombre completo de la excepción) no coinciden.

Por ejemplo, si se espera @code{ValueError: 42}, el test pasará si la verdadera excepción lanzada es @code{ValueError: 3*14}, pero fallará si es lanzada un @ref{228,,TypeError}. También ignorará cualquier nombre completo incluido antes de la clase de la excepción, lo cual puede variar entre implementaciones y versiones de Python y bibliotecas/código en uso. Por lo tanto, las tres variaciones funcionarán con la bandera especificada:

@example
>>> raise Exception('message')
Traceback (most recent call last):
Exception: message

>>> raise Exception('message')
Traceback (most recent call last):
builtins.Exception: message

>>> raise Exception('message')
Traceback (most recent call last):
__main__.Exception: message
@end example

Tenga en cuenta que @ref{14ab,,ELLIPSIS} también puede ser usado para ignorar detalles del mensaje de la excepción, pero dicha prueba aún podría fallar si el nombre del modulo está presente o si hay coincidencias exactas.


Distinto en la versión 3.2: @ref{1370,,IGNORE_EXCEPTION_DETAIL} también ignora cualquier información relacionada al módulo conteniendo la excepción bajo prueba.

@end deffn

@geindex SKIP (en el módulo doctest)
@anchor{library/doctest doctest SKIP}@anchor{3f2e}
@deffn {Dato} doctest.SKIP

Cuando se especifica, no ejecuta el ejemplo del todo. Puede ser útil en contextos donde los ejemplos de doctest sirven como documentación y casos de prueba a la vez, y un ejemplo debe ser incluido para propósitos de documentación, pero no debe ser revisado. P. ej., la salida del ejemplo puede ser aleatoria, o el ejemplo puede depender de recursos que no estarían disponibles para el controlador de pruebas.

La bandera `SKIP' también se puede usar para temporalmente «quitar» ejemplos.
@end deffn

@geindex COMPARISON_FLAGS (en el módulo doctest)
@anchor{library/doctest doctest COMPARISON_FLAGS}@anchor{3f2f}
@deffn {Dato} doctest.COMPARISON_FLAGS

Una máscara de bits o juntadas lógicamente todas las banderas de arriba.
@end deffn

El segundo grupo de opciones controla cómo las fallas de las pruebas son reportadas:

@geindex REPORT_UDIFF (en el módulo doctest)
@anchor{library/doctest doctest REPORT_UDIFF}@anchor{14ac}
@deffn {Dato} doctest.REPORT_UDIFF

Cuando se especifica, las fallas que involucran salidas multilínea esperadas y reales son mostradas usando una diferencia (`diff') unificada.
@end deffn

@geindex REPORT_CDIFF (en el módulo doctest)
@anchor{library/doctest doctest REPORT_CDIFF}@anchor{14ad}
@deffn {Dato} doctest.REPORT_CDIFF

Cuando se especifica, las fallas que involucran salidas multilínea esperadas y reales se mostrarán usando una diferencia (`diff') contextual.
@end deffn

@geindex REPORT_NDIFF (en el módulo doctest)
@anchor{library/doctest doctest REPORT_NDIFF}@anchor{14ae}
@deffn {Dato} doctest.REPORT_NDIFF

Cuando se especifica, las diferencias son computadas por @code{difflib.Differ}, usando el mismo algoritmo que la popular utilidad @code{ndiff.py}. Este es el único método que marca diferencias dentro de líneas también como a través de líneas. Por ejemplo, si una línea de salida esperada contiene el dígito @code{1} donde la salida actual contiene la letra @code{l}, se inserta una línea con una marca de inserción marcando la posición de las columnas que no coinciden.
@end deffn

@geindex REPORT_ONLY_FIRST_FAILURE (en el módulo doctest)
@anchor{library/doctest doctest REPORT_ONLY_FIRST_FAILURE}@anchor{3f30}
@deffn {Dato} doctest.REPORT_ONLY_FIRST_FAILURE

Cuando se especifica, muestra el primer ejemplo fallido en cada doctest, pero suprime la salida para todos ejemplos restantes. Esto evitará que doctest reporte los ejemplos correctos que se rompen por causa de fallos tempranos; pero también puede esconder ejemplos incorrectos que fallen independientemente de la primera falla. Cuando se especifica @ref{3f30,,REPORT_ONLY_FIRST_FAILURE}, los ejemplos restantes aún se ejecutan, y aún cuentan para el número total de fallas reportadas, sólo se suprime la salida.
@end deffn

@geindex FAIL_FAST (en el módulo doctest)
@anchor{library/doctest doctest FAIL_FAST}@anchor{fb4}
@deffn {Dato} doctest.FAIL_FAST

Cuando se especifica, sale después del primer ejemplo fallido y no intenta ejecutar los ejemplos restantes. Por consiguiente, el número de fallas reportadas será como mucho 1. Esta bandera puede ser útil durante la depuración, ya que los ejemplos después de la primera falla ni siquiera producirán salida de depuración.

La línea de comandos de doctest acepta la opción @code{-f} como un atajo para @code{-o FAIL_FAST}.


Added in version 3.4.

@end deffn

@geindex REPORTING_FLAGS (en el módulo doctest)
@anchor{library/doctest doctest REPORTING_FLAGS}@anchor{3f31}
@deffn {Dato} doctest.REPORTING_FLAGS

Una máscara de bits o todas las banderas de reporte arriba combinadas.
@end deffn

También hay una manera de registrar nombres de nuevas opciones de banderas, aunque esto no es útil a menos que intentes extender @ref{3b,,doctest} a través de herencia:

@geindex register_optionflag() (en el módulo doctest)
@anchor{library/doctest doctest register_optionflag}@anchor{3f32}
@deffn {Función} doctest.register_optionflag (name)

Crea una nueva bandera de opción con un nombre dado, y retorna el valor entero de la nueva bandera. se puede usar @ref{3f32,,register_optionflag()} cuando se hereda @ref{3f33,,OutputChecker} o @ref{3f34,,DocTestRunner} para crear nuevas opciones que sean compatibles con tus clases heredadas. @ref{3f32,,register_optionflag()} siempre debe ser llamado usando la siguiente expresión:

@example
MY_FLAG = register_optionflag('MY_FLAG')
@end example
@end deffn

@geindex # (hash);in doctests
@geindex + (plus);in doctests
@geindex - (minus);in doctests

@node Directivas,Advertencias<2>,Banderas de Opción,Cómo funciona
@anchor{library/doctest directives}@anchor{3f35}@anchor{library/doctest doctest-directives}@anchor{3f24}
@subsubsection Directivas


Se pueden usar las directivas de doctest para modificar las @ref{fb3,,banderas de opción} para un ejemplo individual. Las directivas de doctest son comentarios de Python especiales que siguen el código fuente de un ejemplo:

@example
@anchor{library/doctest grammar-token-doctest-directive}@anchor{3f36}directive             ::= "#" "doctest:" directive_options
@anchor{library/doctest grammar-token-doctest-directive_options}@anchor{3f37}directive_options     ::= directive_option ("," directive_option)*
@anchor{library/doctest grammar-token-doctest-directive_option}@anchor{3f38}directive_option      ::= on_or_off directive_option_name
@anchor{library/doctest grammar-token-doctest-on_or_off}@anchor{3f39}on_or_off             ::= "+" | "-"
@anchor{library/doctest grammar-token-doctest-directive_option_name}@anchor{3f3a}directive_option_name ::= "DONT_ACCEPT_BLANKLINE" | "NORMALIZE_WHITESPACE" | ...
@end example

No se permite el espacio en blanco entre el @code{+} o @code{-} y el nombre de la opción de directiva (`directive option name'). El nombre de la opción de directiva puede ser cualquiera de los nombres de las banderas de opciones explicadas arriba.

Las directivas de doctest de un ejemplo modifican el comportamiento de doctest para ese único ejemplo. Usa @code{+} para habilitar el comportamiento nombrado, o @code{-} para deshabilitarlo.

Por ejemplo, esta prueba se ejecuta con normalidad:

@example
>>> print(list(range(20)))  # doctest: +NORMALIZE_WHITESPACE
[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,
10,  11, 12, 13, 14, 15, 16, 17, 18, 19]
@end example

Sin la directiva esto fallaría, porque de hecho la salida verdadera no tiene dos espacios en blanco antes de cada elemento de la lista, y además porque la la salida verdadera está en una sola línea. Mientras tanto, la siguiente prueba también pasa, y de la misma forma requiere de directivas para hacerlo:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
[0, 1, ..., 18, 19]
@end example

Se pueden usar varias directivas en una sola línea, separadas por comas:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

Si las diferentes directivas se usan para un sólo ejemplo, entonces estas se combinarán:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
...                         # doctest: +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

Como se muestran en los ejemplos anteriores, puedes añadir líneas de @code{...} a tus ejemplos conteniendo sólo directivas. Puede ser útil cuando un ejemplo es demasiado largo para que una directiva pueda caber cómodamente en la misma línea:

@example
>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
... # doctest: +ELLIPSIS
[0, ..., 4, 10, ..., 19, 30, ..., 39]
@end example

Tenga en cuenta que ya que todas las opciones están deshabilitadas por defecto, y las directivas sólo aplican a los ejemplos en los que aparecen, habilitarlas (a través de @code{+} en la directiva) usualmente es la única opción significativa. Sin embargo, las banderas de opciones también pueden ser pasadas a funciones que ejecutan doctests, estableciendo valores por defecto diferentes. En tales casos, deshabilitar una opción a través de @code{-} en una directiva puede ser útil.

@node Advertencias<2>,,Directivas,Cómo funciona
@anchor{library/doctest doctest-warnings}@anchor{3f3b}@anchor{library/doctest warnings}@anchor{3f3c}
@subsubsection Advertencias


@ref{3b,,doctest} es serio acerca de requerir coincidencias exactas en la salida esperada. Si incluso un solo carácter no coincide, el test falla. Esto probablemente te sorprenderá algunas veces, mientras aprendes exactamente lo que Python asegura y no asegura sobre la salida. Por ejemplo, cuando se imprime un conjunto, Python no asegura que el elemento sea impreso en ningún orden particular, por lo que una prueba como:

@example
>>> foo()
@{"spam", "eggs"@}
@end example

¡es vulnerable! Una solución puede ser hacer:

@example
>>> foo() == @{"spam", "eggs"@}
True
@end example

en su lugar. Otra es hacer

@example
>>> d = sorted(foo())
>>> d
['eggs', 'spam']
@end example

Existen otros casos, pero ya captas la idea.

Otra mala idea es imprimir elementos que tienen la dirección de un objeto, como por ejemplo

@example
>>> id(1.0)  # certain to fail some of the time  
7948648
>>> class C: pass
>>> C()  # the default repr() for instances embeds an address   
<C object at 0x00AC18F0>
@end example

Con la directiva @ref{14ab,,ELLIPSIS} podemos sacar ventaja del último ejemplo:

@example
>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>
@end example

Los números de coma flotante también son sujetos a pequeñas variaciones de la salida a través de las plataformas, porque Python defiere a la librería C de la plataforma para el formato de flotantes, y las librerías de C varían extensamente en calidad aquí.

@example
>>> 1./7  # risky
0.14285714285714285
>>> print(1./7) # safer
0.142857142857
>>> print(round(1./7, 6)) # much safer
0.142857
@end example

Números de la forma @code{I/2.**J} son seguros a lo largo de todas las plataformas, y yo frecuentemente planeo ejemplos de doctest para producir números de esa forma:

@example
>>> 3./4  # utterly safe
0.75
@end example

Las facciones simples también son más fáciles de entender para las personas, y eso conduce a una mejor documentación.

@node API básica,API de unittest,Cómo funciona,doctest — Test interactive Python examples
@anchor{library/doctest basic-api}@anchor{3f3d}@anchor{library/doctest doctest-basic-api}@anchor{3f19}
@subsubsection API básica


Las funciones @ref{14aa,,testmod()} y @ref{3f1c,,testfile()} proporcionan una interfaz simple para doctest que debe ser suficiente para la mayoría de los usos básicos. Para una introducción menos formal a estas funciones, véase las secciones @ref{3f17,,Uso simple; verificar ejemplos en docstrings} y @ref{3f1a,,Uso Simple; Verificar ejemplos en un Archivo de Texto}.

@geindex testfile() (en el módulo doctest)
@anchor{library/doctest doctest testfile}@anchor{3f1c}
@deffn {Función} doctest.testfile (filename, module_relative=True, name=None, package=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, parser=DocTestParser(), encoding=None)

Todos los argumentos excepto `filename' son opcionales, y deben ser especificados en forma de palabras claves.

Prueba los ejemplos en el archivo con nombre `filename'. Retorna @code{(failure_count, test_count)}.

El argumento opcional `module_relative' especifica cómo el nombre de archivo debe ser interpretado:


@itemize *

@item 
Si `module_relative' es @code{True} (el valor por defecto), entonces `filename' especifica una ruta relativa al módulo que es independiente del SO. Por defecto, esta ruta es relativa al directorio del módulo que lo invoca; pero si el argumento `package' es especificado, entonces es relativo a ese paquete. Para asegurar la independencia del SO, `filename' debe usar caracteres @code{/} para separar segmentos, y no puede ser una ruta absoluta (por ejemplo., no puede empezar con @code{/}).

@item 
Si `module_relative' es @code{False}, entonces `filename' especifica una ruta especifica del SO. La ruta puede ser absoluta o relativa; las rutas relativas son resueltas con respecto al directorio de trabajo actual.
@end itemize

El argumento opcional `name' proporciona el nombre de la prueba; por defecto, o si es @code{None}, se usa @code{os.path.basename(filename)}.

El argumento opcional `package' es un paquete de Python o el nombre de una paquete de Python cuyo directorio debe ser usado como el directorio base para un nombre de archivo relativo al módulo. Si no se especifica ningún paquete, entonces el directorio del módulo que invoca se usa como el directorio base para los nombres de archivos relativos al módulo. Es un error especificar `package' si `module_relative' es @code{False}.

El argumento opcional `globs' proporciona un diccionario a ser usado como los globales cuando se ejecuten los ejemplos. Se crea una nueva copia superficial de este diccionario para el doctest, por lo que sus ejemplos empiezan con una pizarra en blanco. Por defecto, o si es @code{None}, se usa un nuevo diccionario vacío.

El argumento opcional `extraglobs' proporciona un diccionario mezclado con los globales usados para ejecutar ejemplos. Funciona como @ref{14a2,,dict.update()}: si `globs' y `extraglobs' tienen una clave en común, el valor asociado en `extraglobs' aparece en el diccionario combinado. Por defecto, o si es @code{None}, no se usa ninguna variable global. Es una característica avanzada que permite la parametrización de doctests. Por ejemplo, un doctest puede ser escribo para una clase base, usando un nombre genérico para la clase, y luego reusado para probar cualquier número de clases heredadas al pasar un diccionario de `extraglobs' mapeando el nombre genérico a la clase heredada para ser probada.

El argumento opcional `verbose' imprime un montón de cosas si es verdadero, e imprime sólo las fallas si es falso; por defecto, o si es @code{None}, es verdadero si y sólo si @code{'-v'} está en @code{sys.argv}.

El argumento opcional `report' imprime un resumen al final cuando es verdadero; si no, no imprime nada al final. En modo verboso (`verbose'), el resumen es detallado; si no, el resumen es muy corto (de hecho, vacío si todos las pruebas pasan).

El argumento opcional `optionflags' (valor por defecto 0) toma las banderas de opciones @ref{206d,,juntadas lógicamente por un OR}. Véase la sección @ref{fb3,,Banderas de Opción}.

El argumento opcional `raise_on_error' tiene como valor por defecto `false'. Si es `true', se lanza una excepción sobre la primera falla o excepción no esperada en un ejemplo. Esto permite que los fallos sean depurados en un análisis a posteriori. El comportamiento por defecto es continuar corriendo los ejemplos.

El argumento opcional `parser' especifica un @ref{3f25,,DocTestParser} (o subclase) que debe ser usado para extraer las pruebas de los archivos. Su valor por defecto es un analizador sintáctico normal (i.e., @code{DocTestParser()}).

El argumento opcional `encoding' especifica una codificación que debe ser usada para convertir el archivo a `unicode'.
@end deffn

@geindex testmod() (en el módulo doctest)
@anchor{library/doctest doctest testmod}@anchor{14aa}
@deffn {Función} doctest.testmod (m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)

Todos los argumentos son opcionales, y todos excepto por `m' deben ser especificados en forma de palabras claves.

Prueba los ejemplos en los docstring de las funciones y clases alcanzables desde el módulo `m' (o desde el módulo @ref{1,,__main__} si `m' no es proporcionado o es @code{None}), empezando con @code{m.__doc__}.

Also test examples reachable from dict @code{m.__test__}, if it exists.
@code{m.__test__} maps names (strings) to functions, classes and
strings; function and class docstrings are searched for examples; strings are
searched directly, as if they were docstrings.

Sólo se buscan los docstrings anexados a los objetos pertenecientes al módulo `m'.

Retorna @code{(failure_count, test_count)}.

El argumento opcional `name' proporciona el nombre del módulo; por defecto, o si es @code{None}, se usa @code{m.__name__}.

Optional argument `exclude_empty' defaults to false.  If true, objects for which
no doctests are found are excluded from consideration. The default is a backward
compatibility hack, so that code still using
@ref{3f3e,,doctest.master.summarize} in
conjunction with @ref{14aa,,testmod()} continues to get output for objects with no
tests. The `exclude_empty' argument to the newer @ref{163e,,DocTestFinder}
constructor defaults to true.

Los argumentos opcionales `extraglobs', `verbose', `report', `optionflags', `raise_on_error', y `globs' son los mismos en cuanto a la función @ref{3f1c,,testfile()} arriba, excepto que `globs' es por defecto @code{m.__dict__}.
@end deffn

@geindex run_docstring_examples() (en el módulo doctest)
@anchor{library/doctest doctest run_docstring_examples}@anchor{3f3f}
@deffn {Función} doctest.run_docstring_examples (f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)

Prueba los ejemplos asociados con el objeto `f'; por ejemplo, `f' puede ser una cadena de caracteres, un módulo, una función, o un objeto clase.

Una copia superficial del diccionario del argumento `globs' se usa para la ejecución del contexto.

Se usa el argumento opcional `name' en mensajes de fallos, y por defecto es @code{"NoName"}.

Si el argumento opcional `verbose' es verdadero, la salida se genera incluso si no hay fallas. Por defecto, la salida se genera sólo en caso de la falla de un ejemplo.

El argumento opcional `compileflags' proporciona el conjunto de banderas que se deben usar por el compilador de Python cuando se corran los ejemplos. Por defecto, o si es @code{None}, las banderas se deducen correspondiendo al conjunto de características futuras encontradas en `globs'.

El argumento opcional `optionflags' trabaja con respecto a la función @ref{3f1c,,testfile()} de arriba.
@end deffn

@node API de unittest,API avanzada,API básica,doctest — Test interactive Python examples
@anchor{library/doctest doctest-unittest-api}@anchor{3f40}@anchor{library/doctest unittest-api}@anchor{3f41}
@subsubsection API de unittest


As your collection of doctest’ed modules grows, you’ll want a way to run all
their doctests systematically.  @ref{3b,,doctest} provides two functions that can
be used to create @ref{106,,unittest} test suites from modules and text files
containing doctests.  To integrate with @ref{106,,unittest} test discovery, include
a @ref{3f42,,load_tests} function in your test module:

@example
import unittest
import doctest
import my_module_with_doctests

def load_tests(loader, tests, ignore):
    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))
    return tests
@end example

Hay dos funciones principales para crear instancias de @ref{e79,,unittest.TestSuite} desde los archivos de texto y módulos con doctests:

@geindex DocFileSuite() (en el módulo doctest)
@anchor{library/doctest doctest DocFileSuite}@anchor{3f43}
@deffn {Función} doctest.DocFileSuite (*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)

Convierte las pruebas de doctest de uno o más archivos de texto a una @ref{e79,,unittest.TestSuite}.

The returned @ref{e79,,unittest.TestSuite} is to be run by the unittest framework
and runs the interactive examples in each file.  If an example in any file
fails, then the synthesized unit test fails, and a @ref{3f44,,failureException}
exception is raised showing the name of the file containing the test and a
(sometimes approximate) line number.  If all the examples in a file are
skipped, then the synthesized unit test is also marked as skipped.

Pasa una o más rutas (como cadenas de caracteres) a archivos de texto para ser examinados.

Se pueden proporcionar las opciones como argumentos por palabra clave:

El argumento opcional `module_relative' especifica cómo los nombres de archivos en `paths' se deben interpretar:


@itemize *

@item 
Si `module_relative' is @code{True} (el  valor por defecto), entonces cada archivo de nombre en `paths' especifica una ruta relativa al módulo independiente del SO. Por defecto, esta ruta es relativa al directorio del módulo lo está invocando; pero si se especifica el argumento `package', entonces es relativo a ese paquete. Para asegurar la independencia del SO, cada nombre de archivo debe usar caracteres @code{/} para separar los segmentos de rutas, y puede no ser una ruta absoluta (i.e., puede no empezar con @code{/}).

@item 
Si `module_relative' es @code{False}, entonces cada archivo de nombre en `paths' especifica una ruta especifica al SO. La ruta puede ser absoluta o relativa; las rutas relativas son resueltas con respecto a directorio de trabajo actual.
@end itemize

El argumento opcional `package' es un paquete de Python o el nombre de un paquete de Python cuyo directorio debe ser usado como el directorio base para los nombres de archivos relativos al módulo en `paths'. Si no se especifica ningún paquete, entonces el directorio del módulo que lo está invocando se usa como el directorio base para los archivos de nombres relativos al módulo. Es un error especificar `package' si `module_relative' es @code{False}.

El argumento opcional `setUp' especifica una función de configuración para el banco de pruebas. Es invocado antes de ejecutar las pruebas en cada archivo. La función `setUp' se pasará a un objeto @ref{16ba,,DocTest}. La función `setUp' puede acceder a las variables globales de prueba como el atributo `globs' de la prueba pasada.

El argumento opcional `tearDown' especifica una función de destrucción para el banco de pruebas. Es invocado después de ejecutar las pruebas en cada archivo. Se pasará un objeto @ref{16ba,,DocTest} a la función `tearDown'. La función `setUp' de configuración puede acceder a los globales de la prueba como el atributo `globs' de la prueba pasada.

El argumento opcional `globs' es un diccionario que contiene las variables globales iniciales para las pruebas. Se crea una nueva copia de este diccionario para cada prueba. Por defecto, `globs' es un nuevo diccionario vacío.

El argumento opcional `optionflags' especifica las opciones de doctest por defecto para las pruebas, creado al juntar lógicamente las opciones de bandera individuales. Véase la sección @ref{fb3,,Banderas de Opción}. Véase la función @ref{3f45,,set_unittest_reportflags()} abajo para una mejor manera de definir las opciones de informe.

El argumento opcional `parser' especifica un @ref{3f25,,DocTestParser} (o subclase) que debe ser usado para extraer las pruebas de los archivos. Su valor por defecto es un analizador sintáctico normal (i.e., @code{DocTestParser()}).

El argumento opcional `encoding' especifica una codificación que debe ser usada para convertir el archivo a `unicode'.

Se añade el global @code{__file__} a los globales proporcionados a los doctests cargados desde un archivo de texto usando @ref{3f43,,DocFileSuite()}.
@end deffn

@geindex DocTestSuite() (en el módulo doctest)
@anchor{library/doctest doctest DocTestSuite}@anchor{e78}
@deffn {Función} doctest.DocTestSuite (module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, optionflags=0, checker=None)

Convierte las pruebas de doctest para un módulo a un  @ref{e79,,unittest.TestSuite}.

The returned @ref{e79,,unittest.TestSuite} is to be run by the unittest framework
and runs each doctest in the module.  If any of the doctests fail, then the
synthesized unit test fails, and a @ref{3f44,,failureException} exception is raised
showing the name of the file containing the test and a (sometimes approximate)
line number.  If all the examples in a docstring are skipped, then the
synthesized unit test is also marked as skipped.

El argumento opcional `module' proporciona el módulo a probar. Puede ser un objeto de módulo o un nombre (posiblemente punteado)  de módulo. Si no se especifica, se usa el módulo que invoca esta función.

El argumento opcional `globs' es un diccionario que contiene las variables globales iniciales para las pruebas. Se crea una nueva copia de este diccionario para cada prueba. Por defecto, `globs' es un nuevo diccionario vacío.

El argumento opcional `extraglobs' especifica un conjunto de variables globales adicionales que son mezcladas con `globs'. Por defecto, no se usa ningún global adicional.

El argumento opcional `test_finder' es el objeto @ref{163e,,DocTestFinder} (o un reemplazo directo) que se usa para extraer doctests desde el módulo.

Los argumentos opcionales `setUp', `tearDown', y `optionflags' son lo mismo con respecto a la función @ref{3f43,,DocFileSuite()} arriba.

Esta función usa la misma técnica de búsqueda que @ref{14aa,,testmod()}.


Distinto en la versión 3.5: @ref{e78,,DocTestSuite()} retorna un @ref{e79,,unittest.TestSuite} vacío si `module' no contiene ningún docstring en vez de lanzar  un @ref{360,,ValueError}.

@end deffn

@geindex failureException
@anchor{library/doctest doctest failureException}@anchor{3f44}
@deffn {Excepción} doctest.failureException

When doctests which have been converted to unit tests by @ref{3f43,,DocFileSuite()}
or @ref{e78,,DocTestSuite()} fail, this exception is raised showing the name of
the file containing the test and a (sometimes approximate) line number.
@end deffn

Under the covers, @ref{e78,,DocTestSuite()} creates a @ref{e79,,unittest.TestSuite} out
of @code{doctest.DocTestCase} instances, and @code{DocTestCase} is a
subclass of @ref{4fa,,unittest.TestCase}. @code{DocTestCase} isn’t documented
here (it’s an internal detail), but studying its code can answer questions about
the exact details of @ref{106,,unittest} integration.

Similarly, @ref{3f43,,DocFileSuite()} creates a @ref{e79,,unittest.TestSuite} out of
@code{doctest.DocFileCase} instances, and @code{DocFileCase} is a subclass
of @code{DocTestCase}.

So both ways of creating a @ref{e79,,unittest.TestSuite} run instances of
@code{DocTestCase}.  This is important for a subtle reason: when you run
@ref{3b,,doctest} functions yourself, you can control the @ref{3b,,doctest} options in
use directly, by passing option flags to @ref{3b,,doctest} functions.  However, if
you’re writing a @ref{106,,unittest} framework, @ref{106,,unittest} ultimately controls
when and how tests get run.  The framework author typically wants to control
@ref{3b,,doctest} reporting options (perhaps, e.g., specified by command line
options), but there’s no way to pass options through @ref{106,,unittest} to
@ref{3b,,doctest} test runners.

Por esta razón, @ref{3b,,doctest} también admite una noción de banderas de informe de @ref{3b,,doctest} específicas para la compatibilidad con @ref{106,,unittest}, a través de esta función:

@geindex set_unittest_reportflags() (en el módulo doctest)
@anchor{library/doctest doctest set_unittest_reportflags}@anchor{3f45}
@deffn {Función} doctest.set_unittest_reportflags (flags)

Establece las banderas de informe de @ref{3b,,doctest} a usar.

El argumento `flags' toma la @ref{206d,,combinación por el operador OR} de las banderas de opciones. Véase la sección @ref{fb3,,Banderas de Opción}. Sólo se pueden usar las «banderas de informe».

This is a module-global setting, and affects all future doctests run by module
@ref{106,,unittest}:  the @code{runTest()} method of @code{DocTestCase} looks at
the option flags specified for the test case when the @code{DocTestCase}
instance was constructed.  If no reporting flags were specified (which is the
typical and expected case), @code{doctest}’s @ref{106,,unittest} reporting flags are
@ref{206d,,bitwise ORed} into the option flags, and the option flags
so augmented are passed to the @ref{3f34,,DocTestRunner} instance created to
run the doctest.  If any reporting flags were specified when the
@code{DocTestCase} instance was constructed, @code{doctest}’s
@ref{106,,unittest} reporting flags are ignored.

La función retorna el valor de las banderas de informe de @ref{106,,unittest} en efecto antes de que la función fuera invocada.
@end deffn

@node API avanzada,Depuración,API de unittest,doctest — Test interactive Python examples
@anchor{library/doctest advanced-api}@anchor{3f46}@anchor{library/doctest doctest-advanced-api}@anchor{3f47}
@subsubsection API avanzada


La API básica es un simple envoltorio que sirve para hacer los doctest fáciles de usar. Es bastante flexible, y debe cumplir las necesidades de la mayoría de los usuarios; si requieres un control más preciso en las pruebas, o deseas extender las capacidades de doctest, entonces debes usar la API avanzada.

La API avanzada gira en torno a dos clases contenedoras, que se usan para guardar los ejemplos interactivos extraídos de los casos doctest:


@itemize *

@item 
@ref{3f48,,Example}: Un @ref{2777,,statement} de Python, emparejado con su salida esperada.

@item 
@ref{16ba,,DocTest}: Una colección de clases @ref{3f48,,Example}, típicamente extraídos de un sólo docstring o archivo de texto.
@end itemize

Se definen clases de procesamiento adicionales para encontrar, analizar sintácticamente, y ejecutar, y comprobar ejemplos de doctest:


@itemize *

@item 
@ref{163e,,DocTestFinder}: Encuentra todos los docstrings en un módulo dado, y usa un @ref{3f25,,DocTestParser} para crear un @ref{16ba,,DocTest} de cada docstring que contiene ejemplos interactivos.

@item 
@ref{3f25,,DocTestParser}: Crea un objeto @ref{16ba,,DocTest} de una cadena de caracteres (tal como un docstring de un objeto).

@item 
@ref{3f34,,DocTestRunner}: Ejecuta los ejemplos en un @ref{16ba,,DocTest}, y usa un @ref{3f33,,OutputChecker} para verificar su salida.

@item 
@ref{3f33,,OutputChecker}: Compara la salida real de un ejemplo de doctest con la salida esperada, y decide si coinciden.
@end itemize

Las relaciones entre estas clases de procesamiento se resumen en el siguiente diagrama:

@example
                            list of:
+------+                   +---------+
|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results
+------+    |        ^     +---------+     |       ^    (printed)
            |        |     | Example |     |       |
            v        |     |   ...   |     v       |
           DocTestParser   | Example |   OutputChecker
                           +---------+
@end example

@menu
* Objetos DocTest:: 
* Objetos Example:: 
* Objetos DocTestFinder:: 
* Objetos DocTestParser:: 
* TestResults objects:: 
* Objetos DocTestRunner:: 
* Objetos OutputChecker:: 

@end menu

@node Objetos DocTest,Objetos Example,,API avanzada
@anchor{library/doctest doctest-doctest}@anchor{3f49}@anchor{library/doctest doctest-objects}@anchor{3f4a}
@subsubsection Objetos DocTest


@geindex DocTest (clase en doctest)
@anchor{library/doctest doctest DocTest}@anchor{16ba}
@deffn {Clase} doctest.DocTest (examples, globs, name, filename, lineno, docstring)

Una colección de ejemplos de doctest que deben ejecutarse en un sólo nombre de espacios. Se usan los argumentos del constructor para inicializar los atributos de los mismos nombres.

@ref{16ba,,DocTest} define los siguientes atributos. Son inicializados por el constructor, y no deben ser modificados directamente.

@geindex examples (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest examples}@anchor{3f4b}
@deffn {Atributo} examples

Una lista de objetos @ref{3f48,,Example} codificando los ejemplos interactivos de Python individuales que esta prueba debe ejecutar.
@end deffn

@geindex globs (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest globs}@anchor{3f4c}
@deffn {Atributo} globs

El nombre de espacios (alias `globals') en que los ejemplos se deben ejecutar. Este es un diccionario que mapea nombres a valores. Cualquier cambio al nombre de espacios hecho por los ejemplos (tal como juntar nuevas variables) se reflejará en @ref{3f4c,,globs} después de que se ejecute la prueba.
@end deffn

@geindex name (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest name}@anchor{3f4d}
@deffn {Atributo} name

Un nombre de cadena de caracteres que identifica el @ref{16ba,,DocTest}. Normalmente, este es el nombre del objeto o archivo del que se extrajo la prueba.
@end deffn

@geindex filename (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest filename}@anchor{3f4e}
@deffn {Atributo} filename

El nombre del archivo del que se extrajo este @ref{16ba,,DocTest}; o @code{None} si el nombre del archivo se desconoce, o si @ref{16ba,,DocTest} no se extrajo de un archivo.
@end deffn

@geindex lineno (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest lineno}@anchor{17e6}
@deffn {Atributo} lineno

El número de línea dentro de @ref{3f4e,,filename} donde este @ref{16ba,,DocTest} comienza, o @code{None} si el número de línea no está disponible. Este número de línea es comienza en 0 con respecto al comienzo del archivo.
@end deffn

@geindex docstring (atributo de doctest.DocTest)
@anchor{library/doctest doctest DocTest docstring}@anchor{3f4f}
@deffn {Atributo} docstring

La cadena de caracteres del que se extrajo la cadena, o @code{None} si la cadena no está disponible, o si la prueba no se extrajo de una cadena de caracteres.
@end deffn
@end deffn

@node Objetos Example,Objetos DocTestFinder,Objetos DocTest,API avanzada
@anchor{library/doctest doctest-example}@anchor{3f50}@anchor{library/doctest example-objects}@anchor{3f51}
@subsubsection Objetos `Example'


@geindex Example (clase en doctest)
@anchor{library/doctest doctest Example}@anchor{3f48}
@deffn {Clase} doctest.Example (source, want, exc_msg=None, lineno=0, indent=0, options=None)

Un sólo ejemplo interactivo, que consta de una sentencia de Python y su salida esperada. Los argumentos del constructor se usan para inicializar los atributos del mismo nombre.

La clase @ref{3f48,,Example} define los siguientes atributos. Son inicializados por el constructor, y no deben ser modificados directamente.

@geindex source (atributo de doctest.Example)
@anchor{library/doctest doctest Example source}@anchor{3f52}
@deffn {Atributo} source

Una cadena de caracteres que contiene el código fuente del ejemplo. Este código fuente consiste de una sola sentencia Python, y siempre termina en una nueva línea; el constructor añade una nueva línea cuando sea necesario.
@end deffn

@geindex want (atributo de doctest.Example)
@anchor{library/doctest doctest Example want}@anchor{3f53}
@deffn {Atributo} want

La salida esperada de ejecutar el código fuente del ejemplo (o desde la salida estándar, o un seguimiento en caso de una excepción). @code{wants} termina con una nueva línea a menos que no se espera ninguna salida, en cuyo caso es una cadena vacía. El constructor añade una nueva línea cuando sea necesario.
@end deffn

@geindex exc_msg (atributo de doctest.Example)
@anchor{library/doctest doctest Example exc_msg}@anchor{3f54}
@deffn {Atributo} exc_msg

El mensaje de excepción que el ejemplo genera, si se espera que el ejemplo genere una excepción; o @code{None} si no se espera que genere una excepción. Se compara este mensaje de excepción con el valor de retorno de @ref{8e5,,traceback.format_exception_only()}.  @ref{3f54,,exc_msg} termina con una nueva línea a menos que sea @code{None}.  El constructor añade una nueva línea si se necesita.
@end deffn

@geindex lineno (atributo de doctest.Example)
@anchor{library/doctest doctest Example lineno}@anchor{3f55}
@deffn {Atributo} lineno

El número de línea dentro de la cadena de caracteres que contiene este ejemplo donde el ejemplo comienza. Este número de línea comienza en 0 con respecto al comienzo de la cadena que lo contiene.
@end deffn

@geindex indent (atributo de doctest.Example)
@anchor{library/doctest doctest Example indent}@anchor{3f56}
@deffn {Atributo} indent

La sangría del ejemplo en la cadena que lo contiene; i.e., el número de caracteres de espacio que preceden la primera entrada del ejemplo.
@end deffn

@geindex options (atributo de doctest.Example)
@anchor{library/doctest doctest Example options}@anchor{3f57}
@deffn {Atributo} options

A dictionary mapping from option flags to @code{True} or @code{False}, which is used
to override default options for this example.  Any option flags not contained
in this dictionary are left at their default value (as specified by the
@ref{3f34,,DocTestRunner}’s @ref{fb3,,optionflags}).
By default, no options are set.
@end deffn
@end deffn

@node Objetos DocTestFinder,Objetos DocTestParser,Objetos Example,API avanzada
@anchor{library/doctest doctest-doctestfinder}@anchor{3f58}@anchor{library/doctest doctestfinder-objects}@anchor{3f59}
@subsubsection Objetos `DocTestFinder'


@geindex DocTestFinder (clase en doctest)
@anchor{library/doctest doctest DocTestFinder}@anchor{163e}
@deffn {Clase} doctest.DocTestFinder (verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)

Una clase de procesamiento que se usa para extraer los @ref{16ba,,DocTest} que son relevantes para un objeto dado, desde su docstring y los docstring de sus objetos contenidos. Se puede extraer los @ref{16ba,,DocTest} de los módulos, clases, funciones, métodos, métodos estáticos, métodos de clase, y propiedades.

Se puede usar el argumento opcional `verbose' para mostrar los objetos buscados por `finder'. Su valor por defecto es @code{False} (ninguna salida).

El argumento opcional `parser' especifica el objeto @ref{3f25,,DocTestParser} (o un reemplazo directo) que se usa para extraer doctests desde docstrings.

Si el argumento opcional `recurse' es falso, entonces el método @ref{1704,,DocTestFinder.find()} sólo examinará el objeto dado, y no cualquier objeto contenido.

Si el argumento opcional `exclude_empty' es falso, entonces @ref{1704,,DocTestFinder.find()} incluirá pruebas para objetos con docstrings vacíos.

@ref{163e,,DocTestFinder} define los siguientes métodos:

@geindex find() (método de doctest.DocTestFinder)
@anchor{library/doctest doctest DocTestFinder find}@anchor{1704}
@deffn {Método} find (obj[, name][, module][, globs][, extraglobs])

Retorna una lista de los @code{Doctest} que se definen por el docstring de `obj', o por cualquiera de los docstring de sus objetos contenidos.

El argumento opcional `name' especifica el nombre del objeto; este nombre será usado para construir los nombres de los @ref{16ba,,DocTest} retornados. Si `name' no se especifica, entonces se usa @code{obj.__name__}.

El parámetro opcional `module' es el módulo que contiene el objeto dado. Si no se especifica el módulo o si es @code{None}, entonces el buscador de pruebas tratará de determinar automáticamente el módulo correcto. Se usa el módulo del objeto:


@itemize *

@item 
Como un espacio de nombres por defecto, si no se especifica `globs'.

@item 
Para evitar que `DocTestFinder' extraiga DocTests desde objetos que se importan desde otros módulos. (Se ignoran objetos contenidos con módulos aparte de `module'.)

@item 
Para encontrar el nombre del archivo conteniendo el objeto.

@item 
Para ayudar a encontrar el número de línea del objeto dentro de su archivo.
@end itemize

Si `module' es falso, no se hará ningún intento de encontrar el módulo. Es poco claro, de uso mayormente para probar doctest en si mismo: si `module' es @code{False}, o es @code{None} pero no se puede encontrar automáticamente, entonces todos los objetos se consideran que pertenecen al módulo (inexistente), por lo que todos los objetos contenidos se buscarán (recursivamente) por doctests.

Los globales para cada @ref{16ba,,DocTest} se forma al combinar `globs' y `extraglobs' (los enlaces en `extraglobs' anulan los enlaces en `globs'). Se crea una nueva copia superficial del diccionario de globales para cada @ref{16ba,,DocTest}. Si `globs' no se especifica, entonces su valor por defecto es el `__dict__' del módulo, si se especifica, o es @code{@{@}} de lo contrario, si `extraglobs' no se especifica, entonces su valor por defecto es @code{@{@}}.
@end deffn
@end deffn

@node Objetos DocTestParser,TestResults objects,Objetos DocTestFinder,API avanzada
@anchor{library/doctest doctest-doctestparser}@anchor{3f5a}@anchor{library/doctest doctestparser-objects}@anchor{3f5b}
@subsubsection Objetos `DocTestParser'


@geindex DocTestParser (clase en doctest)
@anchor{library/doctest doctest DocTestParser}@anchor{3f25}
@deffn {Clase} doctest.DocTestParser

Un clase de procesamiento usada para extraer ejemplos interactivos de una cadena de caracteres, y usarlos para crear un objeto @ref{16ba,,DocTest}.

@ref{3f25,,DocTestParser} define los siguientes métodos:

@geindex get_doctest() (método de doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser get_doctest}@anchor{3f5c}
@deffn {Método} get_doctest (string, globs, name, filename, lineno)

Extrae todos los ejemplos de `doctest' de una cadena dada, y los recolecta en un objeto @ref{16ba,,DocTest}.

`globs', `name', `filename', y `lineno' son atributos para el nuevo objeto @ref{16ba,,DocTest}. Véase la documentación de @ref{16ba,,DocTest} para más información.
@end deffn

@geindex get_examples() (método de doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser get_examples}@anchor{3f5d}
@deffn {Método} get_examples (string, name='<string>')

Extrae todos los ejemplos de la cadena de caracteres dada, y los retorna como una lista de objetos @ref{3f48,,Example}. Los números de línea empiezan en 0. El argumento opcional `name' es una nombre identificando esta cadena, y sólo es usada para mensajes de errores.
@end deffn

@geindex parse() (método de doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser parse}@anchor{3f5e}
@deffn {Método} parse (string, name='<string>')

Divide el string dado en ejemplos y texto intermedio, y los retorna como una lista que alterna entre objetos @ref{3f48,,Example} y cadenas de caracteres. Los números de línea para los objetos @ref{3f48,,Example} empiezan en 0. El argumento opcional `name' es un nombre identificando esta cadena, y sólo se usa en mensajes de error.
@end deffn
@end deffn

@node TestResults objects,Objetos DocTestRunner,Objetos DocTestParser,API avanzada
@anchor{library/doctest testresults-objects}@anchor{3f5f}
@subsubsection TestResults objects


@geindex TestResults (clase en doctest)
@anchor{library/doctest doctest TestResults}@anchor{3f60}
@deffn {Clase} doctest.TestResults (failed, attempted)

@geindex failed (atributo de doctest.TestResults)
@anchor{library/doctest doctest TestResults failed}@anchor{3f61}
@deffn {Atributo} failed

Number of failed tests.
@end deffn

@geindex attempted (atributo de doctest.TestResults)
@anchor{library/doctest doctest TestResults attempted}@anchor{3f62}
@deffn {Atributo} attempted

Number of attempted tests.
@end deffn

@geindex skipped (atributo de doctest.TestResults)
@anchor{library/doctest doctest TestResults skipped}@anchor{341}
@deffn {Atributo} skipped

Number of skipped tests.


Added in version 3.13.

@end deffn
@end deffn

@node Objetos DocTestRunner,Objetos OutputChecker,TestResults objects,API avanzada
@anchor{library/doctest doctest-doctestrunner}@anchor{3f63}@anchor{library/doctest doctestrunner-objects}@anchor{3f64}
@subsubsection Objetos `DocTestRunner'


@geindex DocTestRunner (clase en doctest)
@anchor{library/doctest doctest DocTestRunner}@anchor{3f34}
@deffn {Clase} doctest.DocTestRunner (checker=None, verbose=None, optionflags=0)

Una clase de procesamiento usada para ejecutar y verificar los ejemplos interactivos en un @ref{16ba,,DocTest}.

La comparación entre salidas esperadas y salidas reales se hace por un @ref{3f33,,OutputChecker}. Esta comparación puede ser personalizada con un número de banderas de opción; véase la sección @ref{fb3,,Banderas de Opción} para más información. Si las banderas de opción son insuficientes, entonces la comparación también puede ser personalizada al pasar una subclase de @ref{3f33,,OutputChecker} al constructor.

The test runner’s display output can be controlled in two ways. First, an output
function can be passed to @ref{33f,,run()}; this function will be called
with strings that should be displayed.  It defaults to @code{sys.stdout.write}.  If
capturing the output is not sufficient, then the display output can be also
customized by subclassing DocTestRunner, and overriding the methods
@ref{3f65,,report_start()}, @ref{3f66,,report_success()},
@ref{3f67,,report_unexpected_exception()}, and @ref{3f68,,report_failure()}.

El argumento por palabra clave opcional `checker' especifica el objeto @ref{3f33,,OutputChecker} (o un reemplazo directo) que se debe usar para comparar las salidas esperadas con las salidas reales de los ejemplos de doctest.

El argumento por palabra clave opcional `verbose' controla la verbosidad de @ref{3f34,,DocTestRunner}. Si `verbose' es @code{True}, entonces la información de cada ejemplo se imprime , mientras se ejecuta. Si `verbose' es @code{False}, entonces sólo las fallas se imprimen. Si `verbose' no se especifica, o es @code{None}, entonces la salida verbosa se usa si y sólo se usa el modificador de la línea de comandos @code{-v}.

El argumento por palabra clave opcional `optionflags' se puede usar para controlar cómo el `test runner' compara la salida esperada con una salida real, y cómo muestra las fallas. Para más información, véase la sección @ref{fb3,,Banderas de Opción}.

The test runner accumulates statistics. The aggregated number of attempted,
failed and skipped examples is also available via the @ref{3f69,,tries},
@ref{3f6a,,failures} and @ref{340,,skips} attributes. The @ref{33f,,run()} and
@ref{3f3e,,summarize()} methods return a @ref{3f60,,TestResults} instance.

@ref{3f34,,DocTestRunner} defines the following methods:

@geindex report_start() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_start}@anchor{3f65}
@deffn {Método} report_start (out, test, example)

Notifica que el `test runner' está a punto de procesar el ejemplo dado. Este método es proporcionado para permitir que clases heredadas de @ref{3f34,,DocTestRunner} personalicen su salida; no debe ser invocado directamente.

`example' es el ejemplo a punto de ser procesado. `test' es la prueba que contiene a `example'. `out' es la función de salida que se pasó a @ref{33f,,DocTestRunner.run()}.
@end deffn

@geindex report_success() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_success}@anchor{3f66}
@deffn {Método} report_success (out, test, example, got)

Notifica que el ejemplo dado se ejecutó correctamente. Este método es proporcionado para permitir que las clases heredadas de @ref{3f34,,DocTestRunner} personalicen su salida; no debe ser invocado directamente.

`example' es el ejemplo a punto de ser procesado. `got' es la salida real del ejemplo. `test' es la prueba conteniendo `example'. `out' es la función de salida que se pasa a @ref{33f,,DocTestRunner.run()}.
@end deffn

@geindex report_failure() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_failure}@anchor{3f68}
@deffn {Método} report_failure (out, test, example, got)

Notifica que el ejemplo dado falló. Este método es proporcionado para permitir que clases heredadas de @ref{3f34,,DocTestRunner} personalicen su salida; no debe ser invocado directamente.

`example' es el ejemplo a punto de ser procesado. `got' es la salida real del ejemplo. `test' es la prueba conteniendo `example'. `out' es la función de salida que se pasa a @ref{33f,,DocTestRunner.run()}.
@end deffn

@geindex report_unexpected_exception() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_unexpected_exception}@anchor{3f67}
@deffn {Método} report_unexpected_exception (out, test, example, exc_info)

Notifica que el ejemplo dado lanzó una excepción inesperada. Este método es proporcionado para permitir que las clases heredadas de @ref{3f34,,DocTestRunner} personalicen su salida; no debe ser invocado directamente.

`example' es el ejemplo a punto de ser procesado, `exc_info' es una tupla que contiene información sobre la excepción inesperada (como se retorna por @ref{72b,,sys.exc_info()}). `test' es la prueba conteniendo `example'. `out' es la función de salida que debe ser pasada a @ref{33f,,DocTestRunner.run()}.
@end deffn

@geindex run() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner run}@anchor{33f}
@deffn {Método} run (test, compileflags=None, out=None, clear_globs=True)

Run the examples in `test' (a @ref{16ba,,DocTest} object), and display the
results using the writer function `out'. Return a @ref{3f60,,TestResults}
instance.

Los ejemplo se ejecutan en el espacio de nombres @code{test.globs}. Si `clear_globs' es verdadero (el valor por defecto), entonces este espacio de nombres será limpiado después de la prueba se ejecute, para ayudar con la colección de basura. Si quisieras examinar el espacio de nombres después de que la prueba se complete, entonces use `clear_globs=False'.

`compileflags' da el conjunto de banderas que se deben usar por el compilador de Python cuando se ejecutan los ejemplos. Si no se especifica, entonces su valor por defecto será el conjunto de banderas de `future-import' que aplican a `globs'.

The output of each example is checked using the @ref{3f34,,DocTestRunner}’s
output checker, and the results are formatted by the
@code{DocTestRunner.report_*()} methods.
@end deffn

@geindex summarize() (método de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner summarize}@anchor{3f3e}
@deffn {Método} summarize (verbose=None)

Print a summary of all the test cases that have been run by this DocTestRunner,
and return a @ref{3f60,,TestResults} instance.

El argumento opcional `verbose' controla qué tan detallado es el resumen. Si no se especifica la verbosidad, entonces se usa la verbosidad de @ref{3f34,,DocTestRunner}.
@end deffn

@ref{3f25,,DocTestParser} has the following attributes:

@geindex tries (atributo de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner tries}@anchor{3f69}
@deffn {Atributo} tries

Number of attempted examples.
@end deffn

@geindex failures (atributo de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner failures}@anchor{3f6a}
@deffn {Atributo} failures

Number of failed examples.
@end deffn

@geindex skips (atributo de doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner skips}@anchor{340}
@deffn {Atributo} skips

Number of skipped examples.


Added in version 3.13.

@end deffn
@end deffn

@node Objetos OutputChecker,,Objetos DocTestRunner,API avanzada
@anchor{library/doctest doctest-outputchecker}@anchor{3f6b}@anchor{library/doctest outputchecker-objects}@anchor{3f6c}
@subsubsection Objetos `OutputChecker'


@geindex OutputChecker (clase en doctest)
@anchor{library/doctest doctest OutputChecker}@anchor{3f33}
@deffn {Clase} doctest.OutputChecker

Una clase que se usa para verificar si la salida real de un ejemplo de doctest coincide con la salida esperada. @ref{3f33,,OutputChecker} define dos métodos: @ref{3f6d,,check_output()}, que compara un par de salidas dadas, y retorna @code{True} si coinciden; y @ref{3f6e,,output_difference()}, que retorna una cadena que describe las diferencias entre las dos salidas.

@ref{3f33,,OutputChecker} define los siguientes métodos:

@geindex check_output() (método de doctest.OutputChecker)
@anchor{library/doctest doctest OutputChecker check_output}@anchor{3f6d}
@deffn {Método} check_output (want, got, optionflags)

Retorna @code{True} si y sólo si la salida real de un ejemplo (`got') coincide con la salida esperada (`want'). Siempre se considera que estas cadenas coinciden si son idénticas; pero dependiendo de qué banderas de opción el `test runner' esté usando, varias coincidencias inexactas son posibles. Véase la sección @ref{fb3,,Banderas de Opción} para más información sobre las banderas de opción.
@end deffn

@geindex output_difference() (método de doctest.OutputChecker)
@anchor{library/doctest doctest OutputChecker output_difference}@anchor{3f6e}
@deffn {Método} output_difference (example, got, optionflags)

Retorna una cadena que describe las diferencias entre la salida esperada para un ejemplo dado (`example') y la salida real (`got'). `optionflags' es el conjunto de banderas de opción usado para comparar `want' y `got'.
@end deffn
@end deffn

@node Depuración,Plataforma improvisada,API avanzada,doctest — Test interactive Python examples
@anchor{library/doctest debugging}@anchor{3f6f}@anchor{library/doctest doctest-debugging}@anchor{3f70}
@subsubsection Depuración


Doctest proporciona varios mecanismos para depurar los ejemplos de doctest:


@itemize *

@item 
Varias funciones convierten los doctest en programas de Python ejecutables, que pueden ser ejecutadas bajo el depurador de Python, @ref{a5,,pdb}.

@item 
La clase @ref{3f71,,DebugRunner} es una subclase de @ref{3f34,,DocTestRunner} que lanza una excepción por el primer ejemplo fallido, conteniendo información sobre ese ejemplo. Esta información se puede usar para realizar depuración a posteriori en el ejemplo.

@item 
Los casos de @ref{106,,unittest} generados por @ref{e78,,DocTestSuite()} admiten el método @ref{3f72,,debug()} definido por @ref{4fa,,unittest.TestCase}.

@item 
Puedes añadir una llamada a @ref{1a7,,pdb.set_trace()} en un ejemplo de doctest, y bajarás al depurador de Python cuando esa línea sea ejecutada. Entonces puedes inspeccionar los valores de las variables, y demás. Por ejemplo, supongamos que @code{a.py} contiene sólo este docstring de módulo:

@example
"""
>>> def f(x):
...     g(x*2)
>>> def g(x):
...     print(x+3)
...     import pdb; pdb.set_trace()
>>> f(3)
9
"""
@end example

Entonces una sesión interactiva puede lucir como esta:

@example
>>> import a, doctest
>>> doctest.testmod(a)
--Return--
> <doctest a[1]>(3)g()->None
-> import pdb; pdb.set_trace()
(Pdb) list
  1     def g(x):
  2         print(x+3)
  3  ->     import pdb; pdb.set_trace()
[EOF]
(Pdb) p x
6
(Pdb) step
--Return--
> <doctest a[0]>(2)f()->None
-> g(x*2)
(Pdb) list
  1     def f(x):
  2  ->     g(x*2)
[EOF]
(Pdb) p x
3
(Pdb) step
--Return--
> <doctest a[2]>(1)?()->None
-> f(3)
(Pdb) cont
(0, 3)
>>>
@end example
@end itemize

Funciones que convierten los doctest a código de Python, y posiblemente ejecuten el código sintetizado debajo del depurador:

@geindex script_from_examples() (en el módulo doctest)
@anchor{library/doctest doctest script_from_examples}@anchor{3f73}
@deffn {Función} doctest.script_from_examples (s)

Convierte texto con ejemplos a un script.

El argumento `s' es una cadena que contiene los ejemplos de doctest. La cadena se convierte a un script de Python, donde los ejemplos de doctest en `s' se convierten en código regular, y todo lo demás se convierte en comentarios de Python. El script generado se retorna como una cadena, Por ejemplo,

@example
import doctest
print(doctest.script_from_examples(r"""
    Set x and y to 1 and 2.
    >>> x, y = 1, 2

    Print their sum:
    >>> print(x+y)
    3
"""))
@end example

muestra:

@example
# Set x and y to 1 and 2.
x, y = 1, 2
#
# Print their sum:
print(x+y)
# Expected:
## 3
@end example

Esta función se usa internamente por otras funciones (véase más abajo), pero también pueden ser útiles cuando quieres transformar una sesión de Python interactiva en un script de Python.
@end deffn

@geindex testsource() (en el módulo doctest)
@anchor{library/doctest doctest testsource}@anchor{3f74}
@deffn {Función} doctest.testsource (module, name)

Convierte el doctest para un objeto en un script.

Argument `module' is a module object, or dotted name of a module, containing the
object whose doctests are of interest.  Argument `name' is the name (within the
module) of the object with the doctests of interest.  The result is a string,
containing the object’s docstring converted to a Python script, as described for
@ref{3f73,,script_from_examples()} above.  For example, if module @code{a.py}
contains a top-level function @code{f()}, then

@example
import a, doctest
print(doctest.testsource(a, "a.f"))
@end example

prints a script version of function @code{f()}”s docstring, with doctests
converted to code, and the rest placed in comments.
@end deffn

@geindex debug() (en el módulo doctest)
@anchor{library/doctest doctest debug}@anchor{3f72}
@deffn {Función} doctest.debug (module, name, pm=False)

Depura los doctest para un objeto.

Los argumentos `module' y `name' son los mismos que para la función @ref{3f74,,testsource()} arriba. El script de Python sintetizado para el docstring del objeto nombrado es escrito en un archivo temporal, y entonces ese archivo es ejecutado bajo el control del depurador de PYthon, @ref{a5,,pdb}.

Se usa una copia superficial de @code{module.__dict__} para el contexto de ejecución local y global.

El argumento opcional `pm' controla si se usa la depuración post-mortem. Si `pm' tiene un valor verdadero, el archivo de script es ejecutado directamente, y el depurador está involucrado sólo si el script termina a través del lanzamiento de una excepción. Si lo hace, entonces la depuración post-mortem es invocada, a través de @ref{141a,,pdb.post_mortem()}, pasando el objeto de rastreo desde la excepción sin tratar. Si no se especifica `pm', o si es falso, el script se ejecuta bajo el depurador desde el inicio, a través de una llamada de @ref{2ea,,exec()} apropiada a @ref{3f75,,pdb.run()}.
@end deffn

@geindex debug_src() (en el módulo doctest)
@anchor{library/doctest doctest debug_src}@anchor{3f76}
@deffn {Función} doctest.debug_src (src, pm=False, globs=None)

Depura los doctest en una cadena de caracteres.

Es como la función function @ref{3f72,,debug()} arriba, excepto que una cadena de caracteres que contiene los ejemplos de doctest se especifica directamente, a través del argumento `src'.

El argumento opcional `pm' tiene el mismo significado como en la función @ref{3f72,,debug()} arriba.

El argumento opcional `globs' proporciona un diccionario a usar como contexto de ejecución local y global. Si no se especifica, o es @code{None}, se usa un diccionario vacío. Si se especifica, se usa una copia superficial del diccionario.
@end deffn

La clase @ref{3f71,,DebugRunner}, y las excepciones especiales que puede lanzar, son de más interés a los autores de frameworks de pruebas, y sólo serán descritos brevemente aquí. Véase el código fuente, y especialmente el docstring de @ref{3f71,,DebugRunner} (¡que es un doctest!) para más detalles:

@geindex DebugRunner (clase en doctest)
@anchor{library/doctest doctest DebugRunner}@anchor{3f71}
@deffn {Clase} doctest.DebugRunner (checker=None, verbose=None, optionflags=0)

Una subclase de @ref{3f34,,DocTestRunner} que lanza una excepción tan pronto como se encuentra una falla. Si ocurre una excepción inesperada, se lanza una excepción @ref{3f77,,UnexpectedException}, conteniendo la prueba, el ejemplo, y la excepción original. Si la salida no coincide, entonces se lanza una excepción @ref{3f78,,DocTestFailure}, conteniendo la prueba, el ejemplo, y la salida real.

Para información sobre los parámetros de construcción y los métodos, véase la documentación para @ref{3f34,,DocTestRunner} en la sección @ref{3f47,,API avanzada}.
@end deffn

Hay dos excepciones que se pueden lanzar por instancias de @ref{3f71,,DebugRunner}:

@geindex DocTestFailure
@anchor{library/doctest doctest DocTestFailure}@anchor{3f78}
@deffn {Excepción} doctest.DocTestFailure (test, example, got)

Una excepción lanzada por @ref{3f34,,DocTestRunner} para señalar que la salida real del ejemplo de un doctest no coincidió con su salida esperada. Los argumentos del constructor se usan para inicializar los atributos del mismo nombre.
@end deffn

@ref{3f78,,DocTestFailure} define los siguientes atributos:

@geindex test (atributo de doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure test}@anchor{3f79}
@deffn {Atributo} DocTestFailure.test

El objeto @ref{16ba,,DocTest} que estaba siendo ejecutado cuando el ejemplo falló.
@end deffn

@geindex example (atributo de doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure example}@anchor{3f7a}
@deffn {Atributo} DocTestFailure.example

El objeto @ref{3f48,,Example} que falló.
@end deffn

@geindex got (atributo de doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure got}@anchor{3f7b}
@deffn {Atributo} DocTestFailure.got

La salida real del ejemplo.
@end deffn

@geindex UnexpectedException
@anchor{library/doctest doctest UnexpectedException}@anchor{3f77}
@deffn {Excepción} doctest.UnexpectedException (test, example, exc_info)

Una excepción lanzada por @ref{3f34,,DocTestRunner} para señalar que un ejemplo de doctest lanzó una excepción inesperada. Los argumentos del constructor se usan para inicializar los atributos del mismo nombre.
@end deffn

@ref{3f77,,UnexpectedException} define los siguientes atributos:

@geindex test (atributo de doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException test}@anchor{3f7c}
@deffn {Atributo} UnexpectedException.test

El objeto @ref{16ba,,DocTest} que estaba siendo ejecutado cuando el ejemplo falló.
@end deffn

@geindex example (atributo de doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException example}@anchor{3f7d}
@deffn {Atributo} UnexpectedException.example

El objeto @ref{3f48,,Example} que falló.
@end deffn

@geindex exc_info (atributo de doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException exc_info}@anchor{3f7e}
@deffn {Atributo} UnexpectedException.exc_info

Una tupla que contiene información sobre la excepción inesperada, como es retornado por @ref{72b,,sys.exc_info()}.
@end deffn

@node Plataforma improvisada,,Depuración,doctest — Test interactive Python examples
@anchor{library/doctest doctest-soapbox}@anchor{3f7f}@anchor{library/doctest soapbox}@anchor{3f80}
@subsubsection Plataforma improvisada


Como se menciona en la introducción, @ref{3b,,doctest} ha crecido para tener tres usos primarios:


@enumerate 

@item 
Verificar los ejemplos en los docstring.

@item 
Pruebas de regresión.

@item 
Documentación ejecutable / pruebas literarias.
@end enumerate

Estos usos tienen diferentes requerimientos, y es importante distinguirlos. En particular, llenar tus docstring con casos de prueba desconocidos conduce a mala documentación.

Cuando se escribe un docstring, escoja ejemplos de docstring con cuidado. Hay un arte para eso que se debe aprender – puede no ser natural al comienzo. Los ejemplos deben añadir valor genuino a la documentación. Un buen ejemplo a menudo puede valer muchas palabras. Si se hace con cuidado, los ejemplos serán invaluables para tus usuarios, y compensarán el tiempo que toma recolectarlos varias veces mientras los años pasan y las cosas cambian. Todavía estoy sorprendido de qué tan frecuente uno de mis ejemplos de @ref{3b,,doctest} paran de funcionar después de un cambio «inofensivo».

Doctest también es una excelente herramienta para pruebas de regresión, especialmente si no escatimas en texto explicativo. Al intercalar prosa y ejemplos, se hace mucho más fácil mantener el seguimiento de lo que realmente se está probando, y por qué. Cuando una prueba falla, buena prosa puede hacer mucho más fácil comprender cuál es el problema, y cómo debe ser arreglado. Es verdad que puedes escribir comentarios extensos en pruebas basadas en código, pero pocos programadores lo hacen. Quizás es porque simplemente doctest hace escribir pruebas mucho más fácil que escribir código, mientras que escribir comentarios en código es mucho más difícil. Pienso que va más allá de eso: la actitud natural cuando se escribe una prueba basada en doctest es que quieres explicar los puntos finos de tu software, e ilustrarlos con ejemplos. Esto naturalmente lleva a archivos de pruebas que empiezan con las características más simples, y lógicamente progresan a complicaciones y casos extremos. Una narrativa coherente es el resultado, en vez de una colección de funciones aisladas que pruebas trozos aislados de funcionalidad aparentemente al azar. Es una actitud diferente, y produce resultados diferentes, difuminando la distinción entre probar y explicar.

Pruebas de regresión se limitan mejor a objetos o archivos dedicados. Hay varias opciones para organizar pruebas:


@itemize *

@item 
Escribe archivos de texto que contienen los casos de prueba como ejemplos interactivos, y prueba los archivos usando @ref{3f1c,,testfile()} o @ref{3f43,,DocFileSuite()}. Esto es lo recomendado, aunque es más fácil hacerlo para nuevos proyectos, diseñados desde el comienzo para usar doctest.

@item 
Define funciones nombradas @code{_regrtest_topic} que consisten en docstrings únicas, que contienen casos de prueba por los tópicos nombrados. Estas funciones se pueden incluir en el mismo archivo que el módulo, o separadas en un archivo de prueba separado.

@item 
Define un diccionario @code{__test__} que asigna desde temas de prueba de integración a los docstring que contienen casos de prueba.
@end itemize

Cuando has puesto tus pruebas en un módulo, el módulo puede ser el mismo `test runner'. Cuando una prueba falla, puedes hacer que tu `test runner' vuelva a ejecutar sólo los doctest fallidos mientras que tu depuras el problema. Aquí hay un ejemplo mínimo de tal `test runner':

@example
if __name__ == '__main__':
    import doctest
    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST
    if len(sys.argv) > 1:
        name = sys.argv[1]
        if name in globals():
            obj = globals()[name]
        else:
            obj = __test__[name]
        doctest.run_docstring_examples(obj, globals(), name=name,
                                       optionflags=flags)
    else:
        fail, total = doctest.testmod(optionflags=flags)
        print(f"@{fail@} failures out of @{total@} tests")
@end example

@subsubheading Notas al pie de página


@node unittest — Unit testing framework,unittest mock — mock object library,doctest — Test interactive Python examples,Herramientas de desarrollo
@anchor{library/unittest doc}@anchor{3f81}@anchor{library/unittest module-unittest}@anchor{106}@anchor{library/unittest unittest-unit-testing-framework}@anchor{3f82}
@subsection @code{unittest} — Unit testing framework


@geindex module; unittest

`Código fuente:' Lib/unittest/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/unittest/__init__.py}


__________________________________________________________________


(Si ya estás familiarizado con los conceptos básicos de realización de tests, puedes saltar a @ref{3f83,,la lista de métodos de aserción}.)

La infraestructura de tests unitarios @ref{106,,unittest} se inspiró en primera instancia en JUnit y ofrece aspectos similares a las principales estructuras de tests unitarios más importantes de otros lenguajes.  Da soporte a automatización de tests, inicialización compartida, código de cierre de los tests, agregación de los tests en colecciones e independencia de los tests de la infraestructura que los reporta.

Para conseguir esto, @ref{106,,unittest} da soporte a ciertos conceptos importantes de una forma orientada a objetos:


@table @asis

@item configuración de prueba (`fixture')

Un `test fixture' representa los preparativos para realizar una o más pruebas y las acciones de limpieza asociadas. Esto puede incluir, por ejemplo, la creación de bases de datos temporales, directorios o el arranque de procesos del servidor.

@item caso de prueba

Un `test case' es la unidad mínima de prueba. Verifica la respuesta específica a un juego particular de entradas. @ref{106,,unittest} proporciona una clase base, @ref{4fa,,TestCase}, que se puede utilizar para crear nuevos casos de uso.

@item conjunto de pruebas

Un `test suite' es una colección de casos de prueba, juegos de prueba o ambos. Se usa para agrupar pruebas que se han de ejecutar juntas.

@item ejecutor de pruebas

Un `test runner' es un componente que dirige la ejecución de las pruebas y proporciona un resultado. El ejecutor puede disponer de una interfaz gráfica, de texto o devolver un valor especial que indique el resultado de la ejecución de las pruebas.
@end table


@subsubheading Ver también



@table @asis

@item Módulo @ref{3b,,doctest}

Otro módulo de soporte a pruebas con una solución muy diferente.

@item Simple Smalltalk Testing: With Patterns@footnote{https://web.archive.org/web/20150315073817/http://www.xprogramming.com/testfram.htm}

El documento original de Kent Beck sobre infraestructuras de prueba mediante el patrón que utiliza @ref{106,,unittest}.

@item pytest@footnote{https://docs.pytest.org/}

Una infraestructura de pruebas unitarias de otro proveedor con una sintaxis más ligera de escritura de pruebas, por ejemplo: @code{assert func(10) == 42}.

@item The Python Testing Tools Taxonomy@footnote{https://wiki.python.org/moin/PythonTestingToolsTaxonomy}

Una lista extensa de herramientas de prueba para Python incluyendo infraestructuras de pruebas funcionales y librerías de objetos sucedáneos.

@item Testing in Python Mailing List@footnote{http://lists.idyll.org/listinfo/testing-in-python}

Grupo especializado en debate sobre las pruebas y las herramientas de prueba de Python.
@end table

El script @code{Tools/unittestgui/unittestgui.py} en la distribución de código fuente de Python es una herramienta gráfica para el descubrimiento y ejecución de pruebas.  Está orientado principalmente a facilitar su uso para aquellos que son nuevos en las pruebas unitarias.  Para entornos de producción, se recomienda que las pruebas sean ejecutadas por un sistema de integración continua como Buildbot@footnote{https://buildbot.net/}, Jenkins@footnote{https://www.jenkins.io/}, GitHub Actions@footnote{https://github.com/features/actions}, o AppVeyor@footnote{https://www.appveyor.com/}.


@menu
* Ejemplo sencillo:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<3>. 
* Descubrimiento de pruebas:: 
* Organización del código de pruebas:: 
* Reutilización de código de prueba anterior:: 
* Omitir tests y fallos esperados:: 
* Distinguiendo iteraciones de tests empleando subtests:: 
* Clases y funciones:: 
* Instalaciones para clases y módulos:: 
* Manejo de señales:: 

@end menu

@node Ejemplo sencillo,Interfaz de línea de comandos<3>,,unittest — Unit testing framework
@anchor{library/unittest basic-example}@anchor{3f84}@anchor{library/unittest unittest-minimal-example}@anchor{3f85}
@subsubsection Ejemplo sencillo


El módulo @ref{106,,unittest} proporciona un conjunto de herramientas para construir y ejecutar pruebas. Esta sección demuestra que un pequeño subconjunto de las herramientas es suficiente para satisfacer las necesidades de la mayoría.

He aquí un breve script para probar estros tres métodos de cadena:

@example
import unittest

class TestStringMethods(unittest.TestCase):

    def test_upper(self):
        self.assertEqual('foo'.upper(), 'FOO')

    def test_isupper(self):
        self.assertTrue('FOO'.isupper())
        self.assertFalse('Foo'.isupper())

    def test_split(self):
        s = 'hello world'
        self.assertEqual(s.split(), ['hello', 'world'])
        # check that s.split fails when the separator is not a string
        with self.assertRaises(TypeError):
            s.split(2)

if __name__ == '__main__':
    unittest.main()
@end example

Para crear un caso de prueba se genera una subclase de @ref{4fa,,unittest.TestCase}. Las tres pruebas se definen con métodos cuyos nombres comienzan por las letras @code{test}. Esta convención sobre nombres indica al ejecutor de pruebas qué métodos representan pruebas.

El quid de cada test es la llamada a  @ref{5cc,,assertEqual()} para verificar un resultado esperado; @ref{5ca,,assertTrue()} o @ref{5cb,,assertFalse()} para verificar una condición; o @ref{5d0,,assertRaises()} para asegurar que se lanza una excepción específica. Se utilizan estos métodos en lugar de la sentencia @ref{9fa,,assert} para que el ejecutor de pruebas pueda acumular todos los resultados de la prueba de cara a realizar un informe.

Los métodos @ref{13a0,,setUp()} y @ref{13a1,,tearDown()} permiten definir instrucciones que han de ser ejecutadas antes y después, respectivamente, de cada método de prueba. Se describen con mas detalle en la sección @ref{3f86,,Organización del código de pruebas}.

El bloque final muestra un modo sencillo de ejecutar las pruebas. @ref{1062,,unittest.main()} proporciona una interfaz de línea de órdenes para el script de prueba. Cuando se ejecuta desde la línea de órdenes, el script anterior produce una salida como:

@example
...
----------------------------------------------------------------------
Ran 3 tests in 0.000s

OK
@end example

Si se le pasa una opción @code{-v} al script de prueba, se establecerá un nivel mayor de detalle del proceso de @ref{1062,,unittest.main()} y se obtendrá la siguiente salida:

@example
test_isupper (__main__.TestStringMethods.test_isupper) ... ok
test_split (__main__.TestStringMethods.test_split) ... ok
test_upper (__main__.TestStringMethods.test_upper) ... ok

----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK
@end example

Los ejemplos anteriores muestra las características más usuales de @ref{106,,unittest}, que son suficientes para solventar las necesidades cotidianas de pruebas. El resto de la documentación explora el juego completo de características, que abundan en los mismos principios.


Distinto en la versión 3.11: El comportamiento de retornar un valor de un método de prueba (que no sea el valor por defecto @code{None}), ahora está obsoleto.


@node Interfaz de línea de comandos<3>,Descubrimiento de pruebas,Ejemplo sencillo,unittest — Unit testing framework
@anchor{library/unittest command-line-interface}@anchor{3f87}@anchor{library/unittest unittest-command-line-interface}@anchor{3f88}
@subsubsection Interfaz de línea de comandos


Se puede usar el módulo @cite{unittest} desde la línea de órdenes para ejecutar pruebas de módulos, clases o hasta métodos de prueba individuales:

@example
python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
@end example

Se puede pasar una lista con cualquier combinación de nombres de módulo, así como clases o métodos completamente cualificados.

Se puede especificar los módulos de prueba por ruta de fichero también:

@example
python -m unittest tests/test_something.py
@end example

Esto permite usar el completado automático de nombre de fichero de la shell para especificar el módulo de pruebas. El fichero especificado aún debe ser susceptible de importarse como módulo. La ruta se convierte en nombre de módulo eliminando “.py” y convirtiendo el separador de directorios por “.”. Si se desea ejecutar un fichero de prueba que no se puede importar como módulo, se ha de ejecutar el fichero directamente.

Se pueden ejecutar las pruebas con más nivel de detalle (mayor verbosidad) pasando el parámetro @cite{-v}:

@example
python -m unittest -v test_module
@end example

Cuando se ejecuta sin argumentos, se inicia @ref{3f89,,Descubrimiento de pruebas}:

@example
python -m unittest
@end example

Para obtener una lista de todas las opciones de línea de órdenes:

@example
python -m unittest -h
@end example


Distinto en la versión 3.2: En versiones anteriores sólo era posible ejecutar métodos de prueba individuales, pero no módulos ni clases.


@menu
* Opciones de la línea de órdenes:: 

@end menu

@node Opciones de la línea de órdenes,,,Interfaz de línea de comandos<3>
@anchor{library/unittest command-line-options}@anchor{3f8a}
@subsubsection Opciones de la línea de órdenes


@code{unittest} da soporte a las siguientes opciones de línea de órdenes:

@geindex opción de línea de comando unittest; -b
@geindex opción de línea de comando unittest; --buffer
@anchor{library/unittest cmdoption-unittest-b}@anchor{1399}@anchor{library/unittest cmdoption-unittest-buffer}@anchor{3f8b}
@deffn {Option} @w{-}b, @w{-}@w{-}buffer

Los flujos de datos de salida estándar y error estándar se acumulan en un búfer durante la ejecución de pruebas. La salida de las pruebas correctas se descarta. La salida de las pruebas que fallan o devuelven un error se añade a los mensajes de fallo.
@end deffn

@geindex opción de línea de comando unittest; -c
@geindex opción de línea de comando unittest; --catch
@anchor{library/unittest cmdoption-unittest-c}@anchor{139a}@anchor{library/unittest cmdoption-unittest-catch}@anchor{3f8c}
@deffn {Option} @w{-}c, @w{-}@w{-}catch

La pulsación de @code{Control-C} durante la ejecución de pruebas espera a que termine la prueba en curso y da un informe de los resultados hasta ese momento. Una segunda pulsación de @code{Control-C} lanza la excepción @ref{a63,,KeyboardInterrupt} usual.

Consultar  en @ref{3f8d,,Gestión de señales} las funciones que proporcionan esta funcionalidad.
@end deffn

@geindex opción de línea de comando unittest; -f
@geindex opción de línea de comando unittest; --failfast
@anchor{library/unittest cmdoption-unittest-f}@anchor{139c}@anchor{library/unittest cmdoption-unittest-failfast}@anchor{3f8e}
@deffn {Option} @w{-}f, @w{-}@w{-}failfast

Finaliza la ejecución tras el primer error o fallo.
@end deffn

@geindex opción de línea de comando unittest; -k
@anchor{library/unittest cmdoption-unittest-k}@anchor{3f8f}
@deffn {Option} @w{-}k

Ejecutar solamente los métodos y clases de prueba que coincidan con el patrón o subcadena de caracteres. Esta opción se puede usar más de una vez, en cuyo caso se incluirán todos los casos de prueba que coincidan con cualquiera de los patrones dados.

Los patrones que contengan un comodín (@code{*}) se comprueban contra el nombre de la prueba usando @ref{18a9,,fnmatch.fnmatchcase()}; si no lo contienen, se usa una comprobación de contenido simple sensible a mayúsculas.

Los patrones se comprueban contra el nombre del método completamente cualificado como lo importa el cargador de pruebas.

Por ejemplo, @code{-k foo} coincide con @code{foo_tests.SomeTest.test_something} y con @code{bar_tests.SomeTest.test_foo}, pero no con @code{bar_tests.FooTest.test_something}.
@end deffn

@geindex opción de línea de comando unittest; --locals
@anchor{library/unittest cmdoption-unittest-locals}@anchor{3f90}
@deffn {Option} @w{-}@w{-}locals

Muestra las variables locales en las trazas.
@end deffn

@geindex opción de línea de comando unittest; --durations
@anchor{library/unittest cmdoption-unittest-durations}@anchor{3f91}
@deffn {Option} @w{-}@w{-}durations N

Muestra los N casos de prueba más lentos (N=0 para todos).
@end deffn


Added in version 3.2: Se añadieron las opciones de línea de órdenes @code{-b}, @code{-c} y @code{-f}.



Added in version 3.5: La opción de línea de órdenes @code{--locals}.



Added in version 3.7: La opción de línea de órdenes @code{-k}.



Added in version 3.12: La opción de línea de órdenes @code{--durations}.


La línea de órdenes también se puede usar para descubrimiento de pruebas, para ejecutar todas las pruebas de un proyecto o un subconjunto de éstas.

@node Descubrimiento de pruebas,Organización del código de pruebas,Interfaz de línea de comandos<3>,unittest — Unit testing framework
@anchor{library/unittest test-discovery}@anchor{3f92}@anchor{library/unittest unittest-test-discovery}@anchor{3f89}
@subsubsection Descubrimiento de pruebas



Added in version 3.2.


Unittest da soporte al descubrimiento de pruebas simples. Para ser compatible con el descubrimiento de pruebas, todos los ficheros de prueba deben ser @ref{1c5d,,módulos} o @ref{1c6e,,paquetes} importables desde el directorio superior del proyecto (por lo que sus nombres han de ser @ref{1e94,,identificadores} válidos).

El descubrimiento de pruebas está implementado en @ref{1064,,TestLoader.discover()}, pero también se puede usar desde la línea de órdenes. La línea de órdenes básica es:

@example
cd project_directory
python -m unittest discover
@end example

@cartouche
@quotation Nota 
Como atajo, @code{python -m unittest} es el equivalente de @code{python -m unittest discover}. Si se desea pasar argumentos al descubrimiento de pruebas, hay que pasar la sub-orden @code{discover} explícitamente.
@end quotation
@end cartouche

La sub-orden @code{discover} cuenta con las siguientes opciones:

@geindex opción de línea de comando unittest-discover; -v
@geindex opción de línea de comando unittest-discover; --verbose
@anchor{library/unittest cmdoption-unittest-discover-v}@anchor{3f93}@anchor{library/unittest cmdoption-unittest-discover-verbose}@anchor{3f94}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

Salida verbosa
@end deffn

@geindex opción de línea de comando unittest-discover; -s
@geindex opción de línea de comando unittest-discover; --start-directory
@anchor{library/unittest cmdoption-unittest-discover-s}@anchor{3f95}@anchor{library/unittest cmdoption-unittest-discover-start-directory}@anchor{3f96}
@deffn {Option} @w{-}s, @w{-}@w{-}start@w{-}directory directory

Directorio de inicio para el descubrimiento (@code{.} si se omite)
@end deffn

@geindex opción de línea de comando unittest-discover; -p
@geindex opción de línea de comando unittest-discover; --pattern
@anchor{library/unittest cmdoption-unittest-discover-p}@anchor{3f97}@anchor{library/unittest cmdoption-unittest-discover-pattern}@anchor{3f98}
@deffn {Option} @w{-}p, @w{-}@w{-}pattern pattern

Patrón para la búsqueda de ficheros de prueba (@code{test*.py} si se omite)
@end deffn

@geindex opción de línea de comando unittest-discover; -t
@geindex opción de línea de comando unittest-discover; --top-level-directory
@anchor{library/unittest cmdoption-unittest-discover-t}@anchor{3f99}@anchor{library/unittest cmdoption-unittest-discover-top-level-directory}@anchor{3f9a}
@deffn {Option} @w{-}t, @w{-}@w{-}top@w{-}level@w{-}directory directory

Directorio superior del proyecto (el directorio inicial si se omite)
@end deffn

Las opciones @ref{3f95,,-s}, @ref{3f97,,-p}, y @ref{3f99,,-t} se pueden pasar por posición en el orden mostrado. Las siguientes líneas de órdenes son equivalentes:

@example
python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"
@end example

Además de pasar una ruta, es posible pasar el nombre de un paquete, por ejemplo @code{myproject.subpackage.test}, como directorio de inicio. El nombre de paquete proporcionado será importado y su ubicación en el sistema de archivos será utilizada como directorio de inicio.

@cartouche
@quotation Prudencia 
El descubrimiento de pruebas carga las pruebas importándolas. Una vez que el descubrimiento ha encontrado todos los ficheros de prueba a partir del directorio inicial, especificado, convierte las rutas en nombres de paquetes a importar. Por ejemplo, @code{foo/bar/baz.py} será importado como @code{foo.bar.baz}.

Si hay un paquete instalado globalmente y se intenta hacer un descubrimiento sobre una copia diferente a la instalada del paquete, `podría' ocurrir que se importe la versión incorrecta. Si ocurre esto, el descubrimiento lanza una advertencia y abandona.

Si se proporciona el directorio de inicio como nombre de paquete en lugar de ruta a un directorio, el descubrimiento asume que la ubicación importada es la deseada, así que no se da la advertencia descrita.
@end quotation
@end cartouche

Los módulos y paquetes de prueba pueden personalizar la carta y descubrimiento de pruebas mediante el @ref{3f9b,,protocolo load_tests}.


Distinto en la versión 3.4: Test discovery supports @ref{1b8,,namespace packages}.



Distinto en la versión 3.11: Test discovery dropped the @ref{1b8,,namespace packages}
support. It has been broken since Python 3.7.
Start directory and its subdirectories containing tests must be regular
package that have @code{__init__.py} file.

If the start directory is the dotted name of the package, the ancestor packages
can be namespace packages.



Distinto en la versión 3.14: Test discovery supports @ref{1b8,,namespace package} as start directory again.
To avoid scanning directories unrelated to Python,
tests are not searched in subdirectories that do not contain @code{__init__.py}.


@node Organización del código de pruebas,Reutilización de código de prueba anterior,Descubrimiento de pruebas,unittest — Unit testing framework
@anchor{library/unittest organizing-test-code}@anchor{3f9c}@anchor{library/unittest organizing-tests}@anchor{3f86}
@subsubsection Organización del código de pruebas


Los bloques de construcción básicos de las pruebas unitarias son los `test cases', escenarios simples que se han de configurar y cuya corrección hay que comprobar. En @ref{106,,unittest}, los casos de prueba están representados por instancias de @ref{4fa,,unittest.TestCase}. Para crear nuevos casos de prueba, hay que escribir subclases de @ref{4fa,,TestCase} o usar @ref{170e,,FunctionTestCase}.

El código de pruebas de una instancia de @ref{4fa,,TestCase} debería ser completamente autónomo, de tal modo que se pueda ejecutar aisladamente o en una combinación arbitraria con otras clases de prueba.

La subclase más simple de @ref{4fa,,TestCase} se limita a implementar un método test (o un método que empiece por @code{test}) para realizar código de prueba específico:

@example
import unittest

class DefaultWidgetSizeTestCase(unittest.TestCase):
    def test_default_widget_size(self):
        widget = Widget('The widget')
        self.assertEqual(widget.size(), (50, 50))
@end example

Note that in order to test something, we use one of the @ref{3f83,,assert* methods}
provided by the @ref{4fa,,TestCase} base class.  If the test fails, an
exception will be raised with an explanatory message, and @ref{106,,unittest}
will identify the test case as a `failure'.  Any other exceptions will be
treated as `errors'.

Las pruebas pueden ser muchas y su preparación puede ser repetitiva. Por suerte, se puede «sacar factor común» a la preparación implementando un método @ref{13a0,,setUp()}, al que la infraestructura de prueba llamará para cada prueba que se ejecute:

@example
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def test_default_widget_size(self):
        self.assertEqual(self.widget.size(), (50,50),
                         'incorrect default size')

    def test_widget_resize(self):
        self.widget.resize(100,150)
        self.assertEqual(self.widget.size(), (100,150),
                         'wrong size after resize')
@end example

@cartouche
@quotation Nota 
El orden en que se ejecutan las diversas pruebas se determina por orden alfabético de los nombres de métodos de prueba.
@end quotation
@end cartouche

Si el método @ref{13a0,,setUp()} lanza una excepción mientras se ejecuta la prueba, la infraestructura considerará que la prueba ha sufrido un error y no se ejecutará el método de prueba propiamente dicho.

Análogamente, se puede proporcionar un método @ref{13a1,,tearDown()} que haga limpieza después de que se ejecute el método de prueba:

@example
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
@end example

Si @ref{13a0,,setUp()} se ejecuta sin errores, @ref{13a1,,tearDown()} se ejecutará tanto si el método de prueba tuvo éxito como si no.

Un entorno de trabajo así para el código de pruebas se llama `test fixture' . Se crea una nueva instancia de TestCase como juego de datos de prueba que se utiliza para cada método de prueba. De este modo, @ref{13a0,,setUp()}, @ref{13a1,,tearDown()} y @code{__init__()} se llamarán una vez por prueba.

Se recomienda usar implementaciones de @cite{TestCase} para agrupar las pruebas de acuerdo con las características probadas. @ref{106,,unittest} proporciona una mecanismo para esto: el `test suite', representado por la clase @ref{e79,,TestSuite} de @ref{106,,unittest}. En la mayor parte de los casos, llamar a @ref{1062,,unittest.main()} hará lo correcto y recolectará todos los casos de prueba del módulo para su ejecución.

Sin embargo, si se desea personalizar la construcción del paquete de pruebas, se puede hacer:

@example
def suite():
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase('test_default_widget_size'))
    suite.addTest(WidgetTestCase('test_widget_resize'))
    return suite

if __name__ == '__main__':
    runner = unittest.TextTestRunner()
    runner.run(suite())
@end example

Se puede poner las definiciones de los casos de prueba y de los paquetes de prueba en los mismos módulos que el código que prueban.(tal como @code{widget.py}), pero sacarlos a un módulo aparte como @code{test_widget.py} tiene diversas ventajas:


@itemize *

@item 
El módulo de pruebas se puede ejecutar aisladamente desde la línea de órdenes.

@item 
El código de pruebas se puede separar con más facilidad del código de producción.

@item 
Disminuye la tentación de cambiar el código de prueba para ajustarse al código bajo prueba.

@item 
El código de pruebas debería modificarse con mucha menor frecuencia que el código bajo prueba.

@item 
Es más sencillo refactorizar el código bajo prueba.

@item 
El código para probar módulos escritos en C ha de estar en módulos aparte, así que ¿por qué no mantener la consistencia?

@item 
Si cambia la estrategia de prueba, no hay razón para cambiar el código fuente principal.
@end itemize

@node Reutilización de código de prueba anterior,Omitir tests y fallos esperados,Organización del código de pruebas,unittest — Unit testing framework
@anchor{library/unittest legacy-unit-tests}@anchor{3f9d}@anchor{library/unittest re-using-old-test-code}@anchor{3f9e}
@subsubsection Reutilización de código de prueba anterior


Habrá personas que tengan código de prueba previo que deseen ejecutar desde @ref{106,,unittest}, sin conversión previa de cada antigua función de prueba a una subclase de @ref{4fa,,TestCase}.

Por esto, @ref{106,,unittest} proporciona una clase @ref{170e,,FunctionTestCase}. Se puede utilizar esta subclase de @ref{4fa,,TestCase} para envolver una función de prueba existente. Se pueden proporcionar también funciones de preparación y desmontaje.

Dada la siguiente función de prueba:

@example
def testSomething():
    something = makeSomething()
    assert something.name is not None
    # ...
@end example

se puede crear una instancia de caso de prueba de la siguiente manera, con métodos opcionales de preparación y desmontaje:

@example
testcase = unittest.FunctionTestCase(testSomething,
                                     setUp=makeSomethingDB,
                                     tearDown=deleteSomethingDB)
@end example

@cartouche
@quotation Nota 
Aunque se puede usar @ref{170e,,FunctionTestCase} para convertir rápidamente unas pruebas existentes a un sistema basado en @ref{106,,unittest}, no es una vía recomendada. Tomarse el tiempo de construir subclases bien construidas de @ref{4fa,,TestCase} hará las futuras refactorizaciones de pruebas futura considerablemente más fácil.
@end quotation
@end cartouche

En algunos casos, los tests existentes pueden haber sido escritos usando el módulo @ref{3b,,doctest}. En ese caso, @ref{3b,,doctest} tiene una clase @code{DocTestSuite} que puede construir automáticamente instancias de @ref{e79,,unittest.TestSuite} partiendo de los test basados en @ref{3b,,doctest}.

@node Omitir tests y fallos esperados,Distinguiendo iteraciones de tests empleando subtests,Reutilización de código de prueba anterior,unittest — Unit testing framework
@anchor{library/unittest skipping-tests-and-expected-failures}@anchor{3f9f}@anchor{library/unittest unittest-skipping}@anchor{3fa0}
@subsubsection Omitir tests y fallos esperados



Added in version 3.1.


Unittest soporta omitir métodos individuales de tests e incluso clases completas de tests. Además, soporta marcar un test como un «fallo esperado», un test que está roto y va a fallar, pero no debería ser contado como fallo en @ref{11d8,,TestResult}.

Omitir un test es solo cuestión de emplear el @ref{7cd,,decorator} @ref{19e2,,skip()} o una de sus variantes condicionales, llamando a @ref{3fa1,,TestCase.skipTest()} dentro de @ref{13a0,,setUp()} o en un método de test, o lanzando @ref{1063,,SkipTest} directamente.

La omisión más básica tiene la siguiente forma:

@example
class MyTestCase(unittest.TestCase):

    @@unittest.skip("demonstrating skipping")
    def test_nothing(self):
        self.fail("shouldn't happen")

    @@unittest.skipIf(mylib.__version__ < (1, 3),
                     "not supported in this library version")
    def test_format(self):
        # Tests that work for only a certain version of the library.
        pass

    @@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    def test_windows_support(self):
        # windows specific testing code
        pass

    def test_maybe_skipped(self):
        if not external_resource_available():
            self.skipTest("external resource not available")
        # test code that depends on the external resource
        pass
@end example

Esta es la salida de ejecutar el ejemplo superior en modo verboso:

@example
test_format (__main__.MyTestCase.test_format) ... skipped 'not supported in this library version'
test_nothing (__main__.MyTestCase.test_nothing) ... skipped 'demonstrating skipping'
test_maybe_skipped (__main__.MyTestCase.test_maybe_skipped) ... skipped 'external resource not available'
test_windows_support (__main__.MyTestCase.test_windows_support) ... skipped 'requires Windows'

----------------------------------------------------------------------
Ran 4 tests in 0.005s

OK (skipped=4)
@end example

Las clases pueden ser omitidas igual que los métodos:

@example
@@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
    def test_not_run(self):
        pass
@end example

@ref{13a0,,TestCase.setUp()} puede omitir también el test. Esto es útil cuando un recurso que necesita ser puesto a punto no está disponible.

Los fallos esperados emplean el decorador @ref{3fa2,,expectedFailure()}.

@example
class ExpectedFailureTestCase(unittest.TestCase):
    @@unittest.expectedFailure
    def test_fail(self):
        self.assertEqual(1, 0, "broken")
@end example

Es fácil lanzar tus propios decoradores que omitan haciendo un decorador que llame a @ref{19e2,,skip()}  en el test cuando quiere ser omitido. Este decorador omite el test a menos que el objeto pasado tenga un cierto atributo:

@example
def skipUnlessHasattr(obj, attr):
    if hasattr(obj, attr):
        return lambda func: func
    return unittest.skip("@{!r@} doesn't have @{!r@}".format(obj, attr))
@end example

Los siguientes decoradores y la excepción implementan la omisión de tests y los fallos esperados:

@geindex skip() (en el módulo unittest)
@anchor{library/unittest unittest skip}@anchor{19e2}
@deffn {Función} @@unittest.skip (reason)

Omitir incondicionalmente el test decorado. `reason' debe describir porqué el test está siendo omitido.
@end deffn

@geindex skipIf() (en el módulo unittest)
@anchor{library/unittest unittest skipIf}@anchor{3fa3}
@deffn {Función} @@unittest.skipIf (condition, reason)

Omitir el test decorado si `condition' es verdadero.
@end deffn

@geindex skipUnless() (en el módulo unittest)
@anchor{library/unittest unittest skipUnless}@anchor{3fa4}
@deffn {Función} @@unittest.skipUnless (condition, reason)

Omitir el test decorado a menos que `condition' sea verdadero.
@end deffn

@geindex expectedFailure() (en el módulo unittest)
@anchor{library/unittest unittest expectedFailure}@anchor{3fa2}
@deffn {Función} @@unittest.expectedFailure

Marca el test como un fallo esperado.  Si falla el test o hay errores en la función de test misma (en lugar de en alguno de los métodos `test fixture') será considerado un éxito. Si el test pasa, será considerado un fallo.
@end deffn

@geindex SkipTest
@anchor{library/unittest unittest SkipTest}@anchor{1063}
@deffn {Excepción} unittest.SkipTest (reason)

Esta excepción es lanzada para omitir un test.

Normalmente puedes usar directamente @ref{3fa1,,TestCase.skipTest()} o uno de los decoradores de omisión en vez de lanzar esta excepción.
@end deffn

Los tests omitidos no ejecutarán @ref{13a0,,setUp()} o @ref{13a1,,tearDown()}. Las clases omitidas no ejecutarán @ref{ae1,,setUpClass()} o @ref{139e,,tearDownClass()}. Los módulos omitidos no ejecutarán @code{setUpModule()} o @code{tearDownModule()}.

@node Distinguiendo iteraciones de tests empleando subtests,Clases y funciones,Omitir tests y fallos esperados,unittest — Unit testing framework
@anchor{library/unittest distinguishing-test-iterations-using-subtests}@anchor{3fa5}@anchor{library/unittest subtests}@anchor{1061}
@subsubsection Distinguiendo iteraciones de tests empleando subtests



Added in version 3.4.


Cuando hay diferencias muy pequeñas entre tus tests, por ejemplo algunos parámetros, unittest te permite distinguirlos dentro del cuerpo de un método de test empleando el administrador de contexto @ref{1060,,subTest()} .

Por ejemplo, el siguiente test:

@example
class NumbersTest(unittest.TestCase):

    def test_even(self):
        """
        Test that numbers between 0 and 5 are all even.
        """
        for i in range(0, 6):
            with self.subTest(i=i):
                self.assertEqual(i % 2, 0)
@end example

producirá la siguiente salida:

@example
======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=1)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=3)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=5)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0
@end example

Sin usar un subtest, la ejecución se pararía después del primer fallo, y el error sería más difícil de diagnosticar porque el valor de  @code{i} no se mostraría:

@example
======================================================================
FAIL: test_even (__main__.NumbersTest.test_even)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0
@end example

@node Clases y funciones,Instalaciones para clases y módulos,Distinguiendo iteraciones de tests empleando subtests,unittest — Unit testing framework
@anchor{library/unittest classes-and-functions}@anchor{3fa6}@anchor{library/unittest unittest-contents}@anchor{3fa7}
@subsubsection Clases y funciones


Esta sección describe en detalle la API de @ref{106,,unittest}.

@menu
* Casos de test:: 
* Agrupando tests:: 
* Cargando y ejecutando tests:: 

@end menu

@node Casos de test,Agrupando tests,,Clases y funciones
@anchor{library/unittest test-cases}@anchor{3fa8}@anchor{library/unittest testcase-objects}@anchor{3fa9}
@subsubsection Casos de test


@geindex TestCase (clase en unittest)
@anchor{library/unittest unittest TestCase}@anchor{4fa}
@deffn {Clase} unittest.TestCase (methodName='runTest')

Las instancias de la clase  @ref{4fa,,TestCase} representan las unidades lógicas de test en el universo de @ref{106,,unittest}. Esta clase está pensada para ser utilizada como clase base, con los test específicos siendo implementados por subclases concretas. Esta clase implementa la interfaz que necesita el ejecutor de tests para permitirle llevar a cabo los tests, y métodos que el código de test puede utilizar para chequear y reportar distintos tipos de fallo.

Cada instancia de @ref{4fa,,TestCase}  ejecutará un solo método base: el método llamado `methodName'. En la mayoría de usos de @ref{4fa,,TestCase}, no tendrás que cambiar el `methodName'  ni reimplementar el método por defecto  @code{runTest()}.


Distinto en la versión 3.2: @ref{4fa,,TestCase} puede instancias con éxito sin dar un `methodName'.  Esto permite experimentar de manera sencilla con @ref{4fa,,TestCase}  en el intérprete interactivo.


Las instancias de @ref{4fa,,TestCase}  proveen tres grupos de métodos: un grupo empleado para ejecutar el test, otro usado para que la implementación del test chequee condiciones y reporte fallos, y algunos métodos de indagación que permiten recopilar información sobre el test en si mismo.

Los métodos en el primer grupo (ejecutando el test) son:

@geindex setUp() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase setUp}@anchor{13a0}
@deffn {Método} setUp ()

Método llamado para preparar el banco de test. Es invocado inmediatamente antes de llamar al método de test; cualquier excepción lanzada por este método que no sea @ref{74a,,AssertionError} o @ref{1063,,SkipTest} será considerada un error en vez de un fallo del test. La implementación por defecto no hace nada.
@end deffn

@geindex tearDown() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase tearDown}@anchor{13a1}
@deffn {Método} tearDown ()

Método llamado inmediatamente después de que se haya llamado el método de prueba y se haya registrado el resultado.  Se llama así aunque el método de ensayo haya planteado una excepción, por lo que la aplicación en las subclases puede tener que ser especialmente cuidadosa en cuanto a la comprobación del estado interno.  Cualquier excepción, que no sea  @ref{74a,,AssertionError} o  @ref{1063,,SkipTest}, planteada por este método se considerará un error adicional en lugar de un fallo de la prueba (aumentando así el número total de errores reportados). Este método sólo se llamará si @ref{13a0,,setUp()} tiene éxito, independientemente del resultado del método de prueba. La implementación por defecto no hace nada.
@end deffn

@geindex setUpClass() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase setUpClass}@anchor{ae1}
@deffn {Método} setUpClass ()

Un método de clase llamado antes de que los tests en una clase individual sean ejecutados. @code{setUpClass} es llamado con la clase como el único argumento y debe ser decorada como @ref{2d2,,classmethod()}:

@example
@@classmethod
def setUpClass(cls):
    ...
@end example

Vea  @ref{3faa,,Class and Module Fixtures} para más detalles.


Added in version 3.2.

@end deffn

@geindex tearDownClass() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase tearDownClass}@anchor{139e}
@deffn {Método} tearDownClass ()

Un método de clase llamado después de que se hayan realizado tests en una clase individual. @code{tearDownClass} se llama con la clase como único argumento y debe ser decorado como un @ref{2d2,,classmethod()}:

@example
@@classmethod
def tearDownClass(cls):
    ...
@end example

Vea  @ref{3faa,,Class and Module Fixtures} para más detalles.


Added in version 3.2.

@end deffn

@geindex run() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase run}@anchor{11d7}
@deffn {Método} run (result=None)

Ejecutar la prueba, recogiendo el resultado en el objeto  @ref{11d8,,TestResult}  pasado como `result'.  Si se omite `result' o @code{None}, se crea un objeto resultado temporal (llamando al método @ref{3fab,,defaultTestResult()}) y se emplea ese. El objeto resultante se devuelve al invocador de @ref{11d7,,run()}.

El mismo efecto puede conseguirse simplemente llamando a la instancia @ref{4fa,,TestCase}.


Distinto en la versión 3.3: Las versiones previas de @code{run} no retornaban el resultado. Tampoco lo hacía la llamada a una instancia.

@end deffn

@geindex skipTest() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase skipTest}@anchor{3fa1}
@deffn {Método} skipTest (reason)

Llamar a esto durante un método de prueba o @ref{13a0,,setUp()} se salta el test actual.  Ver  @ref{3fa0,,Omitir tests y fallos esperados} para más información.


Added in version 3.1.

@end deffn

@geindex subTest() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase subTest}@anchor{1060}
@deffn {Método} subTest (msg=None, **params)

Retorna un gestor de contexto que ejecuta el bloque de código adjunto como un subtest.  `msg' y `params' son valores opcionales y arbitrarios que se muestran cuando falla un subtest, permitiéndole identificarlos claramente.

Un caso de test puede contener cualquier número de declaraciones de subtest, y pueden anidarse arbitrariamente.

Ver @ref{1061,,Distinguiendo iteraciones de tests empleando subtests} para más información.


Added in version 3.4.

@end deffn

@geindex debug() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase debug}@anchor{189d}
@deffn {Método} debug ()

Realice el test sin recoger el resultado.  Esto permite que las excepciones planteadas por el test se propaguen al invocado, y puede utilizarse para apoyar la ejecución de tests bajo un depurador.
@end deffn
@anchor{library/unittest assert-methods}@anchor{3f83}
La clase @ref{4fa,,TestCase} proporciona varios métodos de afirmación para comprobar y reportar fallos.  En la siguiente tabla se enumeran los métodos más utilizados (consulte las tablas siguientes para ver más métodos de afirmación):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Comprueba que

@tab

Nuevo en

@item

@ref{5cc,,assertEqual(a@comma{} b)}

@tab

@code{a == b}

@tab

@item

@ref{5cd,,assertNotEqual(a@comma{} b)}

@tab

@code{a != b}

@tab

@item

@ref{5ca,,assertTrue(x)}

@tab

@code{bool(x) is True}

@tab

@item

@ref{5cb,,assertFalse(x)}

@tab

@code{bool(x) is False}

@tab

@item

@ref{13a2,,assertIs(a@comma{} b)}

@tab

@code{a is b}

@tab

3.1

@item

@ref{13a3,,assertIsNot(a@comma{} b)}

@tab

@code{a is not b}

@tab

3.1

@item

@ref{12f7,,assertIsNone(x)}

@tab

@code{x is None}

@tab

3.1

@item

@ref{12f8,,assertIsNotNone(x)}

@tab

@code{x is not None}

@tab

3.1

@item

@ref{13ab,,assertIn(a@comma{} b)}

@tab

@code{a in b}

@tab

3.1

@item

@ref{13ac,,assertNotIn(a@comma{} b)}

@tab

@code{a not in b}

@tab

3.1

@item

@ref{13a4,,assertIsInstance(a@comma{} b)}

@tab

@code{isinstance(a, b)}

@tab

3.2

@item

@ref{13a5,,assertNotIsInstance(a@comma{} b)}

@tab

@code{not isinstance(a, b)}

@tab

3.2

@end multitable


Todos los métodos de aserción aceptan un argumento `msg' que, si se especifica, se utiliza como mensaje de error en caso de fallo (véase también @ref{139d,,longMessage}). Tenga en cuenta que el argumento de la palabra clave `msg' puede pasarse a @ref{5d0,,assertRaises()}, @ref{5d2,,assertRaisesRegex()}, @ref{11d5,,assertWarns()}, @ref{11d6,,assertWarnsRegex()} sólo cuando se utilizan como gestor de contexto.

@geindex assertEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertEqual}@anchor{5cc}
@deffn {Método} assertEqual (first, second, msg=None)

Testea que `first' y `second' son iguales. Si los valores no comparan como iguales, el test fallará.

Además, si `first' y `second' son exactamente del mismo tipo y uno de lista, tuple, dict, set, frozenset o str o cualquier tipo que una subclase registre con @ref{13af,,addTypeEqualityFunc()} se llamará a la función de igualdad específica del tipo para generar un mensaje de error por defecto más útil (véase también la @ref{3fac,,lista de métodos específicos del tipo}).


Distinto en la versión 3.1: Añadida la llamada automática de la función de igualdad de tipo específico.



Distinto en la versión 3.2: @ref{13aa,,assertMultiLineEqual()} añadido como la función por defecto para igualdad de tipos cuando se comparan cadenas.

@end deffn

@geindex assertNotEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertNotEqual}@anchor{5cd}
@deffn {Método} assertNotEqual (first, second, msg=None)

Testea que `first' y `second' no son iguales.  Si los valores son iguales, el test fallará.
@end deffn

@geindex assertTrue() (método de unittest.TestCase)
@geindex assertFalse() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertTrue}@anchor{5ca}
@deffn {Método} assertTrue (expr, msg=None)
@anchor{library/unittest unittest TestCase assertFalse}@anchor{5cb}
@deffnx {Método} assertFalse (expr, msg=None)

Testea que `expr' es verdadero (o falso).

Note que esto es equivalente a @code{bool(expr) is True} y no a @code{expr is True} (use @code{assertIs(expr, True)} para lo último).  Este método también debe evitarse cuando se disponga de métodos más específicos (por ejemplo, @code{assertEqual(a, b)} en lugar de @code{assertTrue(a == b)}), porque proporcionan un mejor mensaje de error en caso de fallo.
@end deffn

@geindex assertIs() (método de unittest.TestCase)
@geindex assertIsNot() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIs}@anchor{13a2}
@deffn {Método} assertIs (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertIsNot}@anchor{13a3}
@deffnx {Método} assertIsNot (first, second, msg=None)

Testea si `first' y `second' son (o no) el mismo objeto.


Added in version 3.1.

@end deffn

@geindex assertIsNone() (método de unittest.TestCase)
@geindex assertIsNotNone() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIsNone}@anchor{12f7}
@deffn {Método} assertIsNone (expr, msg=None)
@anchor{library/unittest unittest TestCase assertIsNotNone}@anchor{12f8}
@deffnx {Método} assertIsNotNone (expr, msg=None)

Testea que `expr'  es (o no es) @code{None}.


Added in version 3.1.

@end deffn

@geindex assertIn() (método de unittest.TestCase)
@geindex assertNotIn() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIn}@anchor{13ab}
@deffn {Método} assertIn (member, container, msg=None)
@anchor{library/unittest unittest TestCase assertNotIn}@anchor{13ac}
@deffnx {Método} assertNotIn (member, container, msg=None)

Testea que `member' está (o no está) en `container'.


Added in version 3.1.

@end deffn

@geindex assertIsInstance() (método de unittest.TestCase)
@geindex assertNotIsInstance() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIsInstance}@anchor{13a4}
@deffn {Método} assertIsInstance (obj, cls, msg=None)
@anchor{library/unittest unittest TestCase assertNotIsInstance}@anchor{13a5}
@deffnx {Método} assertNotIsInstance (obj, cls, msg=None)

Testea que `obj' es (o no es) una instancia de `cls' (que puede ser una clase o una tupla de clases, de la misma forma que soporta @ref{4ef,,isinstance()}). Para chequear por el tipo exacto, use @ref{13a2,,assertIs(type(obj)@comma{} cls)}.


Added in version 3.2.

@end deffn

Es también posible chequear la producción de excepciones, advertencias y mensajes de log usando los siguientes métodos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Método

@tab

Comprueba que

@tab

Nuevo en

@item

@ref{5d0,,assertRaises(exc@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} lanza `exc'

@tab

@item

@ref{5d2,,assertRaisesRegex(exc@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} lanza `exc' y el mensaje coincide con regex `r'

@tab

3.1

@item

@ref{11d5,,assertWarns(warn@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} lanza `warn'

@tab

3.2

@item

@ref{11d6,,assertWarnsRegex(warn@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} lanza `warn' y el mensaje coincide con regex `r'

@tab

3.2

@item

@ref{8f0,,assertLogs(logger@comma{} level)}

@tab

El bloque @code{with} vuelca sus logs a `logger' con el `level' mínimo

@tab

3.4

@item

@ref{8f0,,assertLogs(logger@comma{} level)}

@tab


@table @asis

@item El bloque @code{with} no ingresa

El bloque @code{with} vuelca sus logs a `logger' con el `level' mínimo
@end table

@tab

3.10

@end multitable


@geindex assertRaises() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRaises}@anchor{5d0}
@deffn {Método} assertRaises (exception, callable, *args, **kwds)

@deffnx {Método} assertRaises (exception, *, msg=None)

Testea que se lanza una excepción cuando se llama a `callable' con cualquier argumento posicional o de palabra clave que también se pasa a  @ref{5d0,,assertRaises()}. El test pasa si se lanza `exception', es un error si se lanza otra excepción, o falla si no se lanza ninguna excepción. Para tener en cuenta cualquiera de un grupo de excepciones, una tupla que contenga las clases de excepción puede ser pasada como `exception'.

Si sólo se dan los argumentos de `exception' y posiblemente `msg', retorna un administrador de contexto para que el código testado pueda ser escrito en línea en lugar de como una función:

@example
with self.assertRaises(SomeException):
    do_something()
@end example

Cuando se emplea como un administrador de contexto, @ref{5d0,,assertRaises()} acepta el argumento por palabra clave adicional  `msg'.

El gestor de contexto almacenará el objeto de excepción capturado en su atributo @code{exception} .  Esto puede ser útil si la intención es realizar comprobaciones adicionales sobre la excepción planteada:

@example
with self.assertRaises(SomeException) as cm:
    do_something()

the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)
@end example


Distinto en la versión 3.1: Añadió la capacidad de usar @ref{5d0,,assertRaises()} como gestor de contexto.



Distinto en la versión 3.2: Añadido el atributo  @code{exception} .



Distinto en la versión 3.3: Añadido el argumento por palabra clave `msg' cuando se emplea un gestor de contexto.

@end deffn

@geindex assertRaisesRegex() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRaisesRegex}@anchor{5d2}
@deffn {Método} assertRaisesRegex (exception, regex, callable, *args, **kwds)

@deffnx {Método} assertRaisesRegex (exception, regex, *, msg=None)

Como @ref{5d0,,assertRaises()} pero también testea que `regex' coincide en la representación de la cadena de la excepción planteada.  `regex' puede ser un objeto de expresión regular o una cadena que contiene una expresión regular adecuada para ser usada por @ref{1299,,re.search()}.  Ejemplos:

@example
self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
                       int, 'XYZ')
@end example

o:

@example
with self.assertRaisesRegex(ValueError, 'literal'):
   int('XYZ')
@end example


Added in version 3.1: Añadido bajo el nombre de @code{assertRaisesRegexp}.



Distinto en la versión 3.2: Renombrado a  @ref{5d2,,assertRaisesRegex()}.



Distinto en la versión 3.3: Añadido el argumento por palabra clave `msg' cuando se emplea un gestor de contexto.

@end deffn

@geindex assertWarns() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertWarns}@anchor{11d5}
@deffn {Método} assertWarns (warning, callable, *args, **kwds)

@deffnx {Método} assertWarns (warning, *, msg=None)

Testea que una advertencia se activa cuando se llama a `callable' con cualquier argumento posicional o de palabra clave que también se pasa a @ref{11d5,,assertWarns()}. El test pasa si se activa el `warning' y falla si no lo hace.  Cualquier excepción es un error. Para considerar cualquiera de un grupo de advertencias, una tupla que contenga las clases de advertencia puede ser pasada como `warnings'.

Si sólo se dan los argumentos de `advertencia' y  `msg', retorna un gestor de contexto para que el código testado pueda ser escrito en línea en lugar de como una función:

@example
with self.assertWarns(SomeWarning):
    do_something()
@end example

Cuando se usa como gestor de contexto, @ref{11d5,,assertWarns()}  acepta el argumento de palabra clave adicional `msg'.

El gestor de contexto almacenará el objeto de advertencia capturado en su atributo @code{warning}, y la línea del código que disparó las advertencias en los atributos  @code{filename}  y @code{lineno} . Esto puede ser útil si la intención es realizar comprobaciones adicionales sobre la advertencia capturada:

@example
with self.assertWarns(SomeWarning) as cm:
    do_something()

self.assertIn('myfile.py', cm.filename)
self.assertEqual(320, cm.lineno)
@end example

Este método funciona independientemente de los filtros de aviso que estén en su lugar cuando se llame.


Added in version 3.2.



Distinto en la versión 3.3: Añadido el argumento por palabra clave `msg' cuando se emplea un gestor de contexto.

@end deffn

@geindex assertWarnsRegex() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertWarnsRegex}@anchor{11d6}
@deffn {Método} assertWarnsRegex (warning, regex, callable, *args, **kwds)

@deffnx {Método} assertWarnsRegex (warning, regex, *, msg=None)

Como @ref{11d5,,assertWarns()} pero también testea que `regex' coincide en el mensaje del aviso disparado.  `regex' puede ser un objeto de expresión regular o una cadena que contiene una expresión regular adecuada para ser usada por @ref{1299,,re.search()}.  Ejemplo:

@example
self.assertWarnsRegex(DeprecationWarning,
                      r'legacy_function\(\) is deprecated',
                      legacy_function, 'XYZ')
@end example

o:

@example
with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    frobnicate('/etc/passwd')
@end example


Added in version 3.2.



Distinto en la versión 3.3: Añadido el argumento por palabra clave `msg' cuando se emplea un gestor de contexto.

@end deffn

@geindex assertLogs() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertLogs}@anchor{8f0}
@deffn {Método} assertLogs (logger=None, level=None)

Un gestor de contexto para comprobar que al menos un mensaje está registrado en el `logger' o en uno de sus hijos, con al menos el `level' dado.

Si se da, `logger' debería ser un objeto @ref{bd7,,logging.Logger} o un @ref{237,,str} dando el nombre de un logger.  El valor por defecto es el root logger, que captará todos los mensajes.

Si se da, `level' debería ser un nivel de registro numérico o su equivalente en cadena de caracteres (por ejemplo, ya sea @code{"ERROR"} o @ref{1cfc,,logging.ERROR}).  El valor predeterminado es @ref{1cfa,,logging.INFO}.

El test pasa si al menos un mensaje emitido dentro del bloque @code{with}  coincide con las condiciones de `logger' y `level', de lo contrario falla.

El objeto devuelto por el gestor de contexto es un ayudante de grabación que lleva un registro de los mensajes de registro que coinciden.  Tiene dos atributos:

@geindex records (atributo de unittest.TestCase)
@anchor{library/unittest unittest TestCase records}@anchor{3fad}
@deffn {Atributo} records

Una lista de objetos @ref{1065,,logging.LogRecord} de los mensajes de log coincidentes.
@end deffn

@geindex output (atributo de unittest.TestCase)
@anchor{library/unittest unittest TestCase output}@anchor{3fae}
@deffn {Atributo} output

Una lista de objetos @ref{237,,str} con la salida forrajeada en los mensajes coincidentes.
@end deffn

Ejemplo:

@example
with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])
@end example


Added in version 3.4.

@end deffn

@geindex assertNoLogs() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertNoLogs}@anchor{8ef}
@deffn {Método} assertNoLogs (logger=None, level=None)

Un gestor de contexto para comprobar que al menos un mensaje está registrado en el `logger' o en uno de sus hijos, con al menos el `level' dado.

Si se da, `logger' debería ser un objeto @ref{bd7,,logging.Logger} o un @ref{237,,str} dándole el nombre de un logger.  El valor por defecto es el root logger, que captará todos los mensajes.

Si se da, `level' debería ser un nivel de registro numérico o su equivalente en cadena de caracteres (por ejemplo, ya sea @code{"ERROR"} o @ref{1cfc,,logging.ERROR}).  El valor predeterminado es @ref{1cfa,,logging.INFO}.

A diferencia de @ref{8f0,,assertLogs()}, el gestor de contexto no devolverá nada.


Added in version 3.10.

@end deffn

Hay también otros métodos empleados para realizar comprobaciones más específicas, tales como:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Comprueba que

@tab

Nuevo en

@item

@ref{5ce,,assertAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) == 0}

@tab

@item

@ref{5cf,,assertNotAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) != 0}

@tab

@item

@ref{13a6,,assertGreater(a@comma{} b)}

@tab

@code{a > b}

@tab

3.1

@item

@ref{13a7,,assertGreaterEqual(a@comma{} b)}

@tab

@code{a >= b}

@tab

3.1

@item

@ref{13a8,,assertLess(a@comma{} b)}

@tab

@code{a < b}

@tab

3.1

@item

@ref{13a9,,assertLessEqual(a@comma{} b)}

@tab

@code{a <= b}

@tab

3.1

@item

@ref{5d1,,assertRegex(s@comma{} r)}

@tab

@code{r.search(s)}

@tab

3.1

@item

@ref{5d3,,assertNotRegex(s@comma{} r)}

@tab

@code{not r.search(s)}

@tab

3.2

@item

@ref{1297,,assertCountEqual(a@comma{} b)}

@tab

`a' y `b' tienen los mismos elementos y en el mismo número, sin importar su orden.

@tab

3.2

@end multitable


@geindex assertAlmostEqual() (método de unittest.TestCase)
@geindex assertNotAlmostEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertAlmostEqual}@anchor{5ce}
@deffn {Método} assertAlmostEqual (first, second, places=7, msg=None, delta=None)
@anchor{library/unittest unittest TestCase assertNotAlmostEqual}@anchor{5cf}
@deffnx {Método} assertNotAlmostEqual (first, second, places=7, msg=None, delta=None)

Testea que `first' y `second' son aproximadamente (o no aproximadamente) iguales calculando su diferencia, redondeando al número dado de puntos `places' decimales (por defecto 7), y comparado a cero. Nótese que estos métodos redondean los valores al número dado de `puntos decimales' (por ejemplo como la función @ref{1342,,round()}) y no `cifras significativas'.

Si se suministra `delta' en vez de `places' que entonces la diferencia entre `first' y `second' deba ser menor o igual a (o mayor que) `delta'.

Suministrar tanto `delta' como `places' lanza un @ref{228,,TypeError}.


Distinto en la versión 3.2: @ref{5ce,,assertAlmostEqual()} considera automáticamente casi iguales a los objetos que se comparan igual. @ref{5cf,,assertNotAlmostEqual()} falla automáticamente si los objetos comparan iguales.  Añadido el argumento de palabra clave `delta'.

@end deffn

@geindex assertGreater() (método de unittest.TestCase)
@geindex assertGreaterEqual() (método de unittest.TestCase)
@geindex assertLess() (método de unittest.TestCase)
@geindex assertLessEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertGreater}@anchor{13a6}
@deffn {Método} assertGreater (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertGreaterEqual}@anchor{13a7}
@deffnx {Método} assertGreaterEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLess}@anchor{13a8}
@deffnx {Método} assertLess (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLessEqual}@anchor{13a9}
@deffnx {Método} assertLessEqual (first, second, msg=None)

Prueba que `first' es respectivamente >, >=, < o <= que `second' dependiendo del nombre del método.  Si no, el test fallará:

@example
>>> self.assertGreaterEqual(3, 4)
AssertionError: "3" unexpectedly not greater than or equal to "4"
@end example


Added in version 3.1.

@end deffn

@geindex assertRegex() (método de unittest.TestCase)
@geindex assertNotRegex() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRegex}@anchor{5d1}
@deffn {Método} assertRegex (text, regex, msg=None)
@anchor{library/unittest unittest TestCase assertNotRegex}@anchor{5d3}
@deffnx {Método} assertNotRegex (text, regex, msg=None)

Testea que una búsqueda `regex' coincide (o no coincide) con el `text'.  En caso de fallo, el mensaje de error incluirá el patrón y el `text' (o el patrón y la parte de `text' que coincida inesperadamente).  `regex' puede ser un objeto de expresión regular o una cadena que contiene una expresión regular adecuada para ser utilizada por @ref{1299,,re.search()}.


Added in version 3.1: Añadido bajo el nombre de @code{assertRegexpMatches}.



Distinto en la versión 3.2: El método @code{assertRegexpMatches()} ha sido renombrado a @ref{5d1,,assertRegex()}.



Added in version 3.2: @ref{5d3,,assertNotRegex()}.

@end deffn

@geindex assertCountEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertCountEqual}@anchor{1297}
@deffn {Método} assertCountEqual (first, second, msg=None)

Testea que la secuencia `first' contiene los mismos elementos que `second', independientemente de su orden. Cuando no lo hagan, se generará un mensaje de error con las diferencias entre las secuencias.

Los elementos duplicados `no' son ignorados cuando se comparan `first' y `second'. Verifica si cada elemento tiene la misma cuenta en ambas secuencias. Equivalente a: @code{assertEqual(Counter(list(first)), Counter(list(second)))} pero funciona también con secuencias de objetos que no son hashable.


Added in version 3.2.

@end deffn
@anchor{library/unittest type-specific-methods}@anchor{3fac}
El método @ref{5cc,,assertEqual()} envía la comprobación de igualdad de los objetos del mismo tipo a diferentes métodos específicos de tipo.  Estos métodos ya están implementados para la mayoría de los tipos incorporados, pero también es posible registrar nuevos métodos usando @ref{13af,,addTypeEqualityFunc()}:

@geindex addTypeEqualityFunc() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase addTypeEqualityFunc}@anchor{13af}
@deffn {Método} addTypeEqualityFunc (typeobj, function)

Registra un método específico de tipo llamado por @ref{5cc,,assertEqual()} para comprobar si dos objetos del mismo `typeobj' (no subclases) comparan como iguales.  `function' debe tomar dos argumentos posicionales y un tercer argumento de palabra clave msg=None tal y como lo hace @ref{5cc,,assertEqual()}.  Debe lanzar   @ref{3faf,,self.failureException(msg)} cuando se detecta una desigualdad entre los dos primeros parámetros, posiblemente proporcionando información útil y explicando las desigualdades en detalle en el mensaje de error.


Added in version 3.1.

@end deffn

La lista de métodos específicos de tipo utilizados automáticamente por @ref{5cc,,assertEqual()} se resumen en la siguiente tabla.  Tenga en cuenta que normalmente no es necesario invocar estos métodos directamente.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Usado para comparar

@tab

Nuevo en

@item

@ref{13aa,,assertMultiLineEqual(a@comma{} b)}

@tab

strings

@tab

3.1

@item

@ref{12f6,,assertSequenceEqual(a@comma{} b)}

@tab

sequences

@tab

3.1

@item

@ref{12f4,,assertListEqual(a@comma{} b)}

@tab

lists

@tab

3.1

@item

@ref{12f5,,assertTupleEqual(a@comma{} b)}

@tab

tuples

@tab

3.1

@item

@ref{12f2,,assertSetEqual(a@comma{} b)}

@tab

sets or frozensets

@tab

3.1

@item

@ref{12f3,,assertDictEqual(a@comma{} b)}

@tab

dicts

@tab

3.1

@end multitable


@geindex assertMultiLineEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertMultiLineEqual}@anchor{13aa}
@deffn {Método} assertMultiLineEqual (first, second, msg=None)

Testea que la cadena multilínea `first' es igual a la cadena `second'. Cuando no sea igual, una diferencia de las dos cadenas que resalte las diferencias se incluirá en el mensaje de error. Este método se utiliza por defecto cuando se comparan cadenas con @ref{5cc,,assertEqual()}.


Added in version 3.1.

@end deffn

@geindex assertSequenceEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertSequenceEqual}@anchor{12f6}
@deffn {Método} assertSequenceEqual (first, second, msg=None, seq_type=None)

Testea que dos secuencias son iguales.  Si se suministra un `seq_type', tanto `first' como  `second' deben ser instancias de `seq_type' o se lanzará un fallo.  Si las secuencias son diferentes se construye un mensaje de error que muestra la diferencia entre las dos.

Este método no es llamado directamente por @ref{5cc,,assertEqual()}, pero se usa para implementar @ref{12f4,,assertListEqual()} y @ref{12f5,,assertTupleEqual()}.


Added in version 3.1.

@end deffn

@geindex assertListEqual() (método de unittest.TestCase)
@geindex assertTupleEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertListEqual}@anchor{12f4}
@deffn {Método} assertListEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertTupleEqual}@anchor{12f5}
@deffnx {Método} assertTupleEqual (first, second, msg=None)

Testea que dos listas o tuplas son iguales.  Si no es así, se construye un mensaje de error que muestra sólo las diferencias entre las dos.  También se lanza un error si alguno de los parámetros es del tipo equivocado. Estos métodos se utilizan por defecto cuando se comparan listas o tuplas con @ref{5cc,,assertEqual()}.


Added in version 3.1.

@end deffn

@geindex assertSetEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertSetEqual}@anchor{12f2}
@deffn {Método} assertSetEqual (first, second, msg=None)

Testea que dos conjuntos son iguales.  Si no es así, se construye un mensaje de error que enumera las diferencias entre los conjuntos.  Este método se utiliza por defecto cuando se comparan los conjuntos o frozensets con @ref{5cc,,assertEqual()}.

Falla si cualquiera de `first' o `second' no tiene un método de @code{set.difference()}.


Added in version 3.1.

@end deffn

@geindex assertDictEqual() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase assertDictEqual}@anchor{12f3}
@deffn {Método} assertDictEqual (first, second, msg=None)

Testea que dos diccionarios son iguales.  Si no es así, se construye un mensaje de error que muestra las diferencias en los diccionarios. Este método se usará por defecto para comparar los diccionarios en las llamadas a @ref{5cc,,assertEqual()}.


Added in version 3.1.

@end deffn
@anchor{library/unittest other-methods-and-attrs}@anchor{3fb0}
Finalmente, @ref{4fa,,TestCase} proporciona los siguientes métodos y atributos:

@geindex fail() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase fail}@anchor{3fb1}
@deffn {Método} fail (msg=None)

Señala un fallo del test incondicionalmente, con `msg' o  @code{None} para el mensaje de error.
@end deffn

@geindex failureException (atributo de unittest.TestCase)
@anchor{library/unittest unittest TestCase failureException}@anchor{3faf}
@deffn {Atributo} failureException

Este atributo de clase da la excepción lanzada por el método de test.  Si un marco de pruebas necesita utilizar una excepción especializada, posiblemente para llevar información adicional, debe subclasificar esta excepción para «jugar limpio» con el marco.  El valor inicial de este atributo es @ref{74a,,AssertionError}.
@end deffn

@geindex longMessage (atributo de unittest.TestCase)
@anchor{library/unittest unittest TestCase longMessage}@anchor{139d}
@deffn {Atributo} longMessage

Este atributo de clase determina lo que ocurre cuando se pasa un mensaje de fallo personalizado como el argumento msg a una llamada assertXYY que falla. @code{True} es el valor por defecto. En este caso, el mensaje personalizado se añade al final del mensaje de fallo estándar. Cuando se establece en @code{False}, el mensaje personalizado reemplaza al mensaje estándar.

La configuración de la clase puede ser anulada en los métodos de test individuales asignando un atributo de instancia, self.longMessage, a @code{True} o @code{False} antes de llamar a los métodos assert.

La configuración de la clase se reajusta antes de cada llamada de test.


Added in version 3.1.

@end deffn

@geindex maxDiff (atributo de unittest.TestCase)
@anchor{library/unittest unittest TestCase maxDiff}@anchor{1298}
@deffn {Atributo} maxDiff

Este atributo controla la longitud máxima de las diferencias de salida de métodos assert que reportan diferencias en caso de fallo. El valor predeterminado es de 80*8 caracteres. Los métodos assert afectados por este atributo son @ref{12f6,,assertSequenceEqual()} (incluyendo todos los métodos de comparación de secuencias que le delegan), @ref{12f3,,assertDictEqual()} y @ref{13aa,,assertMultiLineEqual()}.

Poner @code{maxDiff} en @code{None} significa que no hay una longitud máxima de diferencias.


Added in version 3.2.

@end deffn

Los marcos de test pueden utilizar los siguientes métodos para reunir información sobre el test:

@geindex countTestCases() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase countTestCases}@anchor{3fb2}
@deffn {Método} countTestCases ()

Retorna el número de tests representados por este objeto de test.  Para las instancias de @ref{4fa,,TestCase}, este siempre será @code{1}.
@end deffn

@geindex defaultTestResult() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase defaultTestResult}@anchor{3fab}
@deffn {Método} defaultTestResult ()

Retorna una instancia de la clase de resultado de test que debería utilizarse para esta clase de caso de test (si no se proporciona otra instancia de resultado al método @ref{11d7,,run()}).

Para las instancias de @ref{4fa,,TestCase}, ésta siempre será una instancia de @ref{11d8,,TestResult}; las subclases de @ref{4fa,,TestCase} deben anular esto según sea necesario.
@end deffn

@geindex id() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase id}@anchor{3fb3}
@deffn {Método} id ()

Devuelva una cadena que identifique el caso de test específico.  Normalmente es el nombre completo del método de test, incluyendo el nombre del módulo y de la clase.
@end deffn

@geindex shortDescription() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase shortDescription}@anchor{3fb4}
@deffn {Método} shortDescription ()

Devuelve una descripción de la prueba, o @code{None} si no se ha proporcionado ninguna descripción.  La implementación por defecto de este método devuelve la primera línea de la docstring del método de test, si está disponible, o  @code{None} .


Distinto en la versión 3.1: En 3.1 esto se cambió para añadir el nombre del test a la descripción corta incluso en presencia de una docstring.  Esto causó problemas de compatibilidad con las extensiones de unittest y la adición del nombre de test  fue movida a la @ref{5d4,,TextTestResult} en Python 3.2.

@end deffn

@geindex addCleanup() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase addCleanup}@anchor{b0e}
@deffn {Método} addCleanup (function, /, *args, **kwargs)

Añade una función que se llamará después de @ref{13a1,,tearDown()} a los recursos de limpieza utilizados durante el test. Las funciones se llamarán en orden inverso al orden en que se agregan (@abbr{LIFO}).  Se llaman con cualquier argumento y argumentos de palabra clave que se pase a @ref{b0e,,addCleanup()} cuando se agregan.

Si @ref{13a0,,setUp()} falla, lo que significa que @ref{13a1,,tearDown()} no se llama, entonces cualquier función de limpieza añadida seguirá siendo llamada.


Added in version 3.1.

@end deffn

@geindex enterContext() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase enterContext}@anchor{75a}
@deffn {Método} enterContext (cm)

Introduce el gestor de contexto @code{context()} suministrado. Si es exitoso, añade también su método @ref{1367,,__exit__()} como función de limpieza mediante @ref{b0e,,addCleanup()} y retorna el resultado del método @ref{669,,__enter__()}.


Added in version 3.11.

@end deffn

@geindex doCleanups() (método de unittest.TestCase)
@anchor{library/unittest unittest TestCase doCleanups}@anchor{139f}
@deffn {Método} doCleanups ()

Este método se llama incondicionalmente después de  @ref{13a1,,tearDown()},  o después de @ref{13a0,,setUp()}  si @ref{13a0,,setUp()} lanza una excepción.

Es responsable de llamar a todas las funciones de limpieza añadidas por @ref{b0e,,addCleanup()}. Si necesitas que las funciones de limpieza se llamen `con anterioridad' a @ref{13a1,,tearDown()} entonces puedes llamar a @ref{139f,,doCleanups()} tú mismo.

@ref{139f,,doCleanups()} saca los métodos de la pila de funciones de limpieza uno a uno, así que se puede llamar en cualquier momento.


Added in version 3.1.

@end deffn

@geindex addClassCleanup() (método de clase de unittest.TestCase)
@anchor{library/unittest unittest TestCase addClassCleanup}@anchor{ae0}
@deffn {Método} classmethod addClassCleanup (function, /, *args, **kwargs)

Añade una función que se llamará después de @ref{139e,,tearDownClass()} para limpiar recursos utilizados durante la clase de test. Las funciones se llamarán en orden inverso al orden en que se agregan (@abbr{LIFO}). Se llaman con cualquier argumento y argumento de palabra clave que se pase a @ref{ae0,,addClassCleanup()} cuando se añadan.

Si @ref{ae1,,setUpClass()} falla, lo que significa que @ref{139e,,tearDownClass()} no se invoca, entonces cualquier función de limpieza añadida seguirá siendo llamada.


Added in version 3.8.

@end deffn

@geindex enterClassContext() (método de clase de unittest.TestCase)
@anchor{library/unittest unittest TestCase enterClassContext}@anchor{75b}
@deffn {Método} classmethod enterClassContext (cm)

Introduce el @ref{675,,context manager} suministrado. Si es exitoso, añade también su método @ref{1367,,__exit__()} como función de limpieza mediante @ref{ae0,,addClassCleanup()} y retorna el resultado del método @ref{669,,__enter__()}.


Added in version 3.11.

@end deffn

@geindex doClassCleanups() (método de clase de unittest.TestCase)
@anchor{library/unittest unittest TestCase doClassCleanups}@anchor{3fb5}
@deffn {Método} classmethod doClassCleanups ()

Este método se llama incondicionalmente después de @ref{139e,,tearDownClass()}, o después de @ref{ae1,,setUpClass()}  si @ref{ae1,,setUpClass()} lanza una excepción.

Es responsable de llamar a todas las funciones de limpieza añadidas por @code{addCleanupClass()}. Si necesitas que las funciones de limpieza se llamen `con anterioridad' a @ref{139e,,tearDownClass()} entonces puedes llamar a @code{doCleanupsClass()} tú mismo.

@code{doCleanupsClass()} saca los métodos de la pila de funciones de limpieza de uno en uno, así que se puede llamar en cualquier momento.


Added in version 3.8.

@end deffn
@end deffn

@geindex IsolatedAsyncioTestCase (clase en unittest)
@anchor{library/unittest unittest IsolatedAsyncioTestCase}@anchor{206}
@deffn {Clase} unittest.IsolatedAsyncioTestCase (methodName='runTest')

Esta clase proporciona una API similar a @ref{4fa,,TestCase} y también acepta corutinas como funciones de test.


Added in version 3.8.


@geindex loop_factory (atributo de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase loop_factory}@anchor{3fb6}
@deffn {Atributo} loop_factory

The `loop_factory' passed to @ref{6a1,,asyncio.Runner}. Override
in subclasses with @ref{16fc,,asyncio.EventLoop} to avoid using the
asyncio policy system.


Added in version 3.13.

@end deffn

@geindex asyncSetUp() (método de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncSetUp}@anchor{3fb7}
@deffn {Método} coroutine asyncSetUp ()

Método llamado para preparar la configuración de test. Esto se llama después de @code{setUp()}. Se llama inmediatamente antes de llamar al método de test; aparte de @ref{74a,,AssertionError} o @ref{1063,,SkipTest}, cualquier excepción lanzada por este método se considerará un error más que un fallo del test. La implementación por defecto no hace nada.
@end deffn

@geindex asyncTearDown() (método de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncTearDown}@anchor{3fb8}
@deffn {Método} coroutine asyncTearDown ()

Método llamado inmediatamente después de que se haya llamado el método de test y se haya registrado el resultado.  Esto se llama antes de @code{tearDown()}. Se llama así aunque el método de test haya lanzado una excepción, por lo que la implementación en las subclases puede necesitar ser particularmente cuidadosa en la comprobación del estado interno.  Cualquier excepción, que no sea @ref{74a,,AssertionError} o @ref{1063,,SkipTest}, lanzada por este método se considerará un error adicional en lugar de un fallo del test (aumentando así el número total de errores reportados). Este método sólo se llamará si @ref{3fb7,,asyncSetUp()} tiene éxito, independientemente del resultado del método de test. La implementación por defecto no hace nada.
@end deffn

@geindex addAsyncCleanup() (método de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase addAsyncCleanup}@anchor{3fb9}
@deffn {Método} addAsyncCleanup (function, /, *args, **kwargs)

Este método acepta una corutina que puede ser utilizada como función de limpieza.
@end deffn

@geindex enterAsyncContext() (método de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase enterAsyncContext}@anchor{75c}
@deffn {Método} coroutine enterAsyncContext (cm)

Introduce el @ref{678,,asynchronous context manager} suministrado. Si es exitoso, añade también su método @ref{1636,,__aexit__()} como función de limpieza mediante @ref{3fb9,,addAsyncCleanup()} y retorna el resultado del método @ref{1fd1,,__aenter__()}.


Added in version 3.11.

@end deffn

@geindex run() (método de unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase run}@anchor{3fba}
@deffn {Método} run (result=None)

Establece un nuevo bucle de eventos para ejecutar el test, recogiendo el resultado en el objeto @ref{11d8,,TestResult} pasado como `result'.  Si se omite `result' o @code{None}, se crea un objeto resultado temporal (llamando al método @code{defaultTestResult()}) y se utiliza. El objeto resultante se devuelve al invocado de @ref{3fba,,run()}. Al final del test se cancelan todas las tareas del bucle de eventos.
@end deffn

Un ejemplo ilustrando el orden:

@example
from unittest import IsolatedAsyncioTestCase

events = []


class Test(IsolatedAsyncioTestCase):


    def setUp(self):
        events.append("setUp")

    async def asyncSetUp(self):
        self._async_connection = await AsyncConnection()
        events.append("asyncSetUp")

    async def test_response(self):
        events.append("test_response")
        response = await self._async_connection.get("https://example.com")
        self.assertEqual(response.status_code, 200)
        self.addAsyncCleanup(self.on_cleanup)

    def tearDown(self):
        events.append("tearDown")

    async def asyncTearDown(self):
        await self._async_connection.close()
        events.append("asyncTearDown")

    async def on_cleanup(self):
        events.append("cleanup")

if __name__ == "__main__":
    unittest.main()
@end example

Después de ejecutar el test,  @code{events} contendría  @code{[“setUp”, “asyncSetUp”, “test_response”, “asyncTearDown”, “tearDown”, “cleanup”]}.
@end deffn

@geindex FunctionTestCase (clase en unittest)
@anchor{library/unittest unittest FunctionTestCase}@anchor{170e}
@deffn {Clase} unittest.FunctionTestCase (testFunc, setUp=None, tearDown=None, description=None)

Esta clase implementa la porción de la interfaz @ref{4fa,,TestCase} que permite al corredor de tests conducir los tests, pero no proporciona los métodos que el código de test puede utilizar para comprobar e informar de los errores.  Se utiliza para crear casos de test utilizando código de prueba heredado, lo que permite que se integre en un marco de tests basado en @ref{106,,unittest}.
@end deffn

@node Agrupando tests,Cargando y ejecutando tests,Casos de test,Clases y funciones
@anchor{library/unittest grouping-tests}@anchor{3fbb}@anchor{library/unittest testsuite-objects}@anchor{3fbc}
@subsubsection Agrupando tests


@geindex TestSuite (clase en unittest)
@anchor{library/unittest unittest TestSuite}@anchor{e79}
@deffn {Clase} unittest.TestSuite (tests=())

Esta clase representa una agregación de casos de test individuales y conjuntos de tests. La clase presenta la interfaz que necesita el corredor de tests para poder ser ejecutado como cualquier otro caso de test.  Ejecutar una instancia @ref{e79,,TestSuite} es lo mismo que iterar sobre el conjunto, ejecutando cada test individualmente.

Si se indican `tests', debe ser un iterable de casos de test individuales u otros conjuntos de tests que se usarán para construir el conjunto inicialmente. Se proporcionan métodos adicionales para añadir casos de test y conjuntos a la colección más adelante.

Los objetos de @ref{e79,,TestSuite} se comportan de manera muy parecida a los objetos de @ref{4fa,,TestCase}, excepto que no implementan un test.  En cambio, se usan para agregar tests en grupos de tests que deben ser ejecutados juntos. Existen algunos métodos adicionales para agregar tests a las instancias de @ref{e79,,TestSuite}:

@geindex addTest() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite addTest}@anchor{3fbd}
@deffn {Método} addTest (test)

Añade un @ref{4fa,,TestCase} o @ref{e79,,TestSuite} al conjunto.
@end deffn

@geindex addTests() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite addTests}@anchor{3fbe}
@deffn {Método} addTests (tests)

Añade todos los tests de un iterable de @ref{4fa,,TestCase} y @ref{e79,,TestSuite} a este conjunto de tests.

Esto equivale a iterar sobre `tests', llamando a @ref{3fbd,,addTest()} para cada elemento.
@end deffn

@ref{e79,,TestSuite} comparte los siguientes métodos con @ref{4fa,,TestCase}:

@geindex run() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite run}@anchor{3fbf}
@deffn {Método} run (result)

Ejecuta los tests asociados a este conjunto, recogiendo el resultado en el objeto de resultado del test pasado como `result'.  Tenga en cuenta que a diferencia de @ref{11d7,,TestCase.run()}, @ref{3fbf,,TestSuite.run()} requiere que se pase el objeto resultado.
@end deffn

@geindex debug() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite debug}@anchor{3fc0}
@deffn {Método} debug ()

Ejecuta los tests asociados con este conjunto sin recoger los resultados. Esto permite que las excepciones lanzadas por este test sean propagadas al invocador y puedes ser usadas para apoyar tests que están ejecutándose con un debugger.
@end deffn

@geindex countTestCases() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite countTestCases}@anchor{3fc1}
@deffn {Método} countTestCases ()

Retorna el numero de tests representados por este objeto de test, incluidos todos los test individuales y los sub-conjuntos.
@end deffn

@geindex __iter__() (método de unittest.TestSuite)
@anchor{library/unittest unittest TestSuite __iter__}@anchor{10a5}
@deffn {Método} __iter__ ()

Tests grouped by a @ref{e79,,TestSuite} are always accessed by iteration.
Subclasses can lazily provide tests by overriding @code{__iter__()}. Note
that this method may be called several times on a single suite (for
example when counting tests or comparing for equality) so the tests
returned by repeated iterations before @ref{3fbf,,TestSuite.run()} must be the
same for each call iteration. After @ref{3fbf,,TestSuite.run()}, callers should
not rely on the tests returned by this method unless the caller uses a
subclass that overrides @code{TestSuite._removeTestAtIndex()} to preserve
test references.


Distinto en la versión 3.2: In earlier versions the @ref{e79,,TestSuite} accessed tests directly rather
than through iteration, so overriding @code{__iter__()} wasn’t sufficient
for providing tests.



Distinto en la versión 3.4: En versiones anteriores, la @ref{e79,,TestSuite} tenía referencias a cada @ref{4fa,,TestCase} después de @ref{3fbf,,TestSuite.run()}. Las subclases pueden restaurar ese comportamiento anulando @code{TestSuite._removeTestAtIndex()}.

@end deffn

En el uso típico de un objeto @ref{e79,,TestSuite}, el método @ref{3fbf,,run()} es invocado por un @code{TestRunner} en lugar de por el marco de test de pruebas automático del usuario final.
@end deffn

@node Cargando y ejecutando tests,,Agrupando tests,Clases y funciones
@anchor{library/unittest loading-and-running-tests}@anchor{3fc2}
@subsubsection Cargando y ejecutando tests


@geindex TestLoader (clase en unittest)
@anchor{library/unittest unittest TestLoader}@anchor{3e2}
@deffn {Clase} unittest.TestLoader

La clase @ref{3e2,,TestLoader} se utiliza para crear conjuntos de tests a partir de clases y módulos.  Normalmente, no es necesario crear una instancia de esta clase; el módulo @ref{106,,unittest} proporciona una instancia que puede ser compartida como @ref{3fc3,,unittest.defaultTestLoader}.  Sin embargo, el uso de una subclase o instancia permite la personalización de algunas propiedades configurables.

Los objetos @ref{3e2,,TestLoader}  tienen los siguientes atributos:

@geindex errors (atributo de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader errors}@anchor{f0f}
@deffn {Atributo} errors

Una lista de los errores no fatales encontrados durante la carga de tests. No reseteados por el cargador en ningún momento. Los errores fatales son señalados por el método relevante que lanza una excepción al invocador. Los errores no fatales también son indicados por una prueba sintética que lanzará el error original cuando se ejecute.


Added in version 3.5.

@end deffn

Los objetos @ref{3e2,,TestLoader} tienen los siguientes métodos:

@geindex loadTestsFromTestCase() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromTestCase}@anchor{3e4}
@deffn {Método} loadTestsFromTestCase (testCaseClass)

Devuelve un conjunto de todos los casos de test contenidos en la @ref{4fa,,TestCase}derivada de @code{testCaseClass}.

Se crea una instancia de caso de test para cada método nombrado por @ref{3e5,,getTestCaseNames()}. Por defecto, estos son los nombres de los métodos que comienzan con @code{test}. Si @ref{3e5,,getTestCaseNames()} no retorna ningún método, pero se implementa el método @code{runTest()}, se crea un único caso de test para ese método.
@end deffn

@geindex loadTestsFromModule() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromModule}@anchor{3e3}
@deffn {Método} loadTestsFromModule (module, *, pattern=None)

Devuelva un conjunto de todos los casos de test contenidos en el módulo dado. Este método busca en `module' clases derivadas de @ref{4fa,,TestCase} y crea una instancia de la clase para cada método de test definido para la clase.

@cartouche
@quotation Nota 
Aunque el uso de una jerarquía de clases derivadas de  @ref{4fa,,TestCase}  puede ser conveniente para compartir configuraciones y funciones de ayuda, la definición de métodos de test en clases base que no están destinadas a ser instanciadas directamente no complementa bien con este método.  Hacerlo, sin embargo, puede ser útil cuando las configuraciones son diferentes y están definidas en subclases.
@end quotation
@end cartouche

Si un módulo proporciona una función @code{load_tests} será llamado para cargar los tests. Esto permite a los módulos personalizar la carga de los tests. Este es el @ref{3f9b,,load_tests protocol}.  El argumento `pattern' se pasa como tercer argumento a @code{load_tests}.


Distinto en la versión 3.2: Se ha añadido soporte para @code{load_tests}.



Distinto en la versión 3.5: Se ha agregado soporte para un argumento `pattern' de solo palabra clave.



Distinto en la versión 3.12: El parámetro no documentado y no oficial `use_load_tests' ha sido eliminado.

@end deffn

@geindex loadTestsFromName() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromName}@anchor{13ad}
@deffn {Método} loadTestsFromName (name, module=None)

Retorna un conjunto de todos los casos de test dado un especificador de cadena.

El especificador `name' es un «nombre punteado» que puede resolverse ya sea a un módulo, una clase de caso de test, un método de test dentro de una clase de caso de test, una instancia @ref{e79,,TestSuite}, o un objeto invocable que devuelve una instancia @ref{4fa,,TestCase} o @ref{e79,,TestSuite}.  Estas comprobaciones se aplican en el orden que se indica aquí; es decir, un método en una posible clase de caso de test se recogerá como «un método de test dentro de una clase de caso de test”, en lugar de «un objeto invocable”.

Por ejemplo, si tiene un módulo @code{SampleTests} que contiene una clase derivada de @ref{4fa,,TestCase} @code{SampleTestCase} con tres métodos de test (@code{test_one()}, @code{test_two()}, y @code{test_three()}), el especificador @code{SampleTests.SampleTestCase'} haría que este método devolviera una suite que ejecutara los tres métodos de prueba. El uso del especificador @code{SampleTests.SampleTestCase.test_two'} provocaría que este método devolviera una suite de tests que ejecutaría sólo el método de test @code{test_two()}. El especificador puede referirse a los módulos y paquetes que no han sido importados; serán importados como un efecto secundario.

El método opcionalmente resuelve `name' relativo al `module' dado.


Distinto en la versión 3.5: Si un @ref{4d7,,ImportError} o @ref{441,,AttributeError} ocurre mientras atraviesa `name' entonces se devolverá un test sintético que lanza ese error cuando se ejecuta. Estos errores están incluidos en los errores acumulados por self.errors.

@end deffn

@geindex loadTestsFromNames() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromNames}@anchor{3fc4}
@deffn {Método} loadTestsFromNames (names, module=None)

Similar a @ref{13ad,,loadTestsFromName()}, pero toma una secuencia de nombres en lugar de un solo nombre.  El valor de retorno es una suite de tests que soporta todos los test  definidos para cada nombre.
@end deffn

@geindex getTestCaseNames() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader getTestCaseNames}@anchor{3e5}
@deffn {Método} getTestCaseNames (testCaseClass)

Devuelve una secuencia ordenada de nombres de métodos encontrados dentro de `testCaseClass'; esta debería ser una subclase de @ref{4fa,,TestCase}.
@end deffn

@geindex discover() (método de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader discover}@anchor{1064}
@deffn {Método} discover (start_dir, pattern='test*.py', top_level_dir=None)

Encuentra todos los módulos de prueba recurriendo a subdirectorios del directorio de inicio especificado, y retorna un objeto de TestSuite que los contenga. Sólo se cargarán los archivos de test que coincidan con el `pattern'. (Utilizando la coincidencia de patrones de estilo de shell.) Sólo se cargarán los nombres de los módulos que sean importables (es decir, que sean identificadores Python válidos).

All test modules must be importable from the top level of the project. If
the start directory is not the top level directory then `top_level_dir'
must be specified separately.

Si la importación de un módulo falla, por ejemplo debido a un error de sintaxis, entonces esto se registrará como un error único y el descubrimiento continuará.  Si el fallo en la importación se debe a que @ref{1063,,SkipTest} se ha lanzado, se registrará como un salto en lugar de un error.

Si se encuentra un paquete (un directorio que contiene un archivo llamado @code{__init__.py}), se comprobará si el paquete tiene una función @code{load_tests}. Si existe, entonces se invocará @code{package.load_tests(loader, tests, pattern)}. Test discovery se encarga de asegurar que un paquete sólo se comprueba una vez durante una invocación, incluso si la propia función load_tests llama a @code{loader.discover}.

Si @code{load_tests} existe, entonces el descubrimiento `no' recurre en el paquete, @code{load_tests} es responsable de cargar todos los tests en el paquete.

The pattern is deliberately not stored as a loader attribute so that
packages can continue discovery themselves.

`top_level_dir' is stored internally, and used as a default to any
nested calls to @code{discover()}. That is, if a package’s @code{load_tests}
calls @code{loader.discover()}, it does not need to pass this argument.

`start_dir' puede ser un nombre de módulo punteado así como un directorio.


Added in version 3.2.



Distinto en la versión 3.4: Los módulos que lanzan @ref{1063,,SkipTest} en la importación se registran como saltos, no como errores.

`start_dir' puede ser un @ref{1b8,,paquete de espacios de nombres}.

Las rutas se ordenan antes de ser importadas para que el orden de ejecución sea el mismo, incluso si el orden del sistema de archivos subyacente no depende del nombre del archivo.



Distinto en la versión 3.5: Los paquetes encontrados son ahora comprobados para @code{load_tests} sin importar si su ruta coincide con el `pattern', porque es imposible que el nombre de un paquete coincida con el patrón por defecto.



Distinto en la versión 3.11: `start_dir' can not be a @ref{1b8,,namespace packages}.
It has been broken since Python 3.7, and Python 3.11 officially removes it.



Distinto en la versión 3.13: `top_level_dir' is only stored for the duration of `discover' call.



Distinto en la versión 3.14: `start_dir' can once again be a @ref{1b8,,namespace package}.

@end deffn

Los siguientes atributos de un @ref{3e2,,TestLoader} pueden ser configurados ya sea por subclasificación o asignación en una instancia:

@geindex testMethodPrefix (atributo de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader testMethodPrefix}@anchor{3fc5}
@deffn {Atributo} testMethodPrefix

Cadena que da el prefijo de los nombres de métodos que serán interpretados como métodos de test.  El valor por defecto es @code{'test'}.

This affects @ref{3e5,,getTestCaseNames()} and all the @code{loadTestsFrom*}
methods.
@end deffn

@geindex sortTestMethodsUsing (atributo de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader sortTestMethodsUsing}@anchor{3fc6}
@deffn {Atributo} sortTestMethodsUsing

Function to be used to compare method names when sorting them in
@ref{3e5,,getTestCaseNames()} and all the @code{loadTestsFrom*} methods.
@end deffn

@geindex suiteClass (atributo de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader suiteClass}@anchor{13ae}
@deffn {Atributo} suiteClass

Objeto invocable que construye un conjunto de pruebas a partir de una lista de pruebas. No se necesitan métodos en el objeto resultante.  El valor por defecto es la clase @ref{e79,,TestSuite}.

This affects all the @code{loadTestsFrom*} methods.
@end deffn

@geindex testNamePatterns (atributo de unittest.TestLoader)
@anchor{library/unittest unittest TestLoader testNamePatterns}@anchor{3fc7}
@deffn {Atributo} testNamePatterns

Lista de patrones de nombres de test de comodines al estilo del shell de Unix que los métodos de test tienen que coincidir con para ser incluidos en las suites de test (ver opción @code{-k}).

Si este atributo no es @code{None} (el predeterminado), todos los métodos de test que se incluyan en los paquetes de test deben coincidir con uno de los patrones de esta lista. Tenga en cuenta que las coincidencias se realizan siempre utilizando @ref{18a9,,fnmatch.fnmatchcase()}, por lo que a diferencia de los patrones pasados a la opción @code{-k}, los patrones de subcadena simple tendrán que ser convertidos utilizando comodines @code{*}.

This affects all the @code{loadTestsFrom*} methods.


Added in version 3.7.

@end deffn
@end deffn

@geindex TestResult (clase en unittest)
@anchor{library/unittest unittest TestResult}@anchor{11d8}
@deffn {Clase} unittest.TestResult

Esta clase se utiliza para recopilar información sobre qué tests han tenido éxito y cuáles han fracasado.

Un objeto  @ref{11d8,,TestResult}  almacena los resultados de una serie de pruebas.  Las clases @ref{4fa,,TestCase} y @ref{e79,,TestSuite} aseguran que los resultados se registren correctamente; los autores de los tests no tienen que preocuparse de registrar el resultado de las mismas.

Los marcos de pruebas construidos sobre @ref{106,,unittest} pueden querer acceder al objeto @ref{11d8,,TestResult} generado por la ejecución de un conjunto de tests con fines de reporte; una instancia @ref{11d8,,TestResult} es devuelta por el método @code{TestRunner.run()} para este propósito.

Las instancias de @ref{11d8,,TestResult} tienen los siguientes atributos que serán de interés cuando se inspeccionen los resultados de la ejecución de un conjunto de tests:

@geindex errors (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult errors}@anchor{3fc8}
@deffn {Atributo} errors

Una lista que contiene tuplas de 2 elementos de instancias @ref{4fa,,TestCase} y cadenas con formato de tracebacks. Cada tupla representa una prueba que lanzó una excepción inesperada.
@end deffn

@geindex failures (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult failures}@anchor{3fc9}
@deffn {Atributo} failures

A list containing 2-tuples of @ref{4fa,,TestCase} instances and strings
holding formatted tracebacks. Each tuple represents a test where a failure
was explicitly signalled using the @ref{3f83,,assert* methods}.
@end deffn

@geindex skipped (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult skipped}@anchor{3fca}
@deffn {Atributo} skipped

Una lista que contiene tuplas de 2 elementos de instancias de @ref{4fa,,TestCase} y cadenas que contienen la razón para saltarse el test.


Added in version 3.1.

@end deffn

@geindex expectedFailures (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult expectedFailures}@anchor{3fcb}
@deffn {Atributo} expectedFailures

Una lista que contiene tuplas de 2 elementos de instancias @ref{4fa,,TestCase} y cadenas con formato de traceback.  Cada tupla representa un fallo esperado del caso de test.
@end deffn

@geindex unexpectedSuccesses (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult unexpectedSuccesses}@anchor{3fcc}
@deffn {Atributo} unexpectedSuccesses

Una lista que contiene instancias de  @ref{4fa,,TestCase}  que fueron marcadas como fracasos esperados, pero tuvieron éxito.
@end deffn

@geindex collectedDurations (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult collectedDurations}@anchor{1714}
@deffn {Atributo} collectedDurations

Una lista que contiene tuplas de 2 elementos con nombres de casos de prueba y números flotantes que representan el tiempo transcurrido de cada prueba que se ejecutó.


Added in version 3.12.

@end deffn

@geindex shouldStop (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult shouldStop}@anchor{3fcd}
@deffn {Atributo} shouldStop

Puesto en @code{True} cuando la ejecución de los tests se detenga por @ref{3fce,,stop()}.
@end deffn

@geindex testsRun (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult testsRun}@anchor{3fcf}
@deffn {Atributo} testsRun

El número total de tests realizados hasta ahora.
@end deffn

@geindex buffer (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult buffer}@anchor{3fd0}
@deffn {Atributo} buffer

Si se ajusta a true, @code{sys.stdout} y @code{sys.stderr} serán almacenados entre @ref{3fd1,,startTest()} y @ref{3fd2,,stopTest()} siendo llamados. La salida recolectada sólo tendrá eco en el verdadero @code{sys.stdout} y @code{sys.stderr} si la prueba falla o se equivoca. Cualquier salida también se adjunta al mensaje de fallo / error.


Added in version 3.2.

@end deffn

@geindex failfast (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult failfast}@anchor{3fd3}
@deffn {Atributo} failfast

Si se ajusta a true @ref{3fce,,stop()} se llamará al primer fallo o error, deteniendo la ejecución de la prueba.


Added in version 3.2.

@end deffn

@geindex tb_locals (atributo de unittest.TestResult)
@anchor{library/unittest unittest TestResult tb_locals}@anchor{3fd4}
@deffn {Atributo} tb_locals

Si se ajusta a true entonces las variables locales se mostrarán en los tracebacks.


Added in version 3.5.

@end deffn

@geindex wasSuccessful() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult wasSuccessful}@anchor{3fd5}
@deffn {Método} wasSuccessful ()

Devuelve @code{True} si todas las pruebas realizadas hasta ahora han pasado, de lo contrario devuelve @code{False}.


Distinto en la versión 3.4: Devuelve @code{False} si hubo algún @ref{3fcc,,unexpectedSuccesses} de las pruebas marcadas con el decorador @ref{3fa2,,expectedFailure()}.

@end deffn

@geindex stop() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult stop}@anchor{3fce}
@deffn {Método} stop ()

Este método puede ser llamado para señalar que el conjunto de pruebas que se están ejecutando debe ser abortado poniendo el atributo @ref{3fcd,,shouldStop} en @code{True}. @code{TestRunner} los objetos deben respetar esta bandera y regresar sin ejecutar ninguna prueba adicional.

Por ejemplo, esta característica es utilizada por la clase @ref{174a,,TextTestRunner} para detener el marco de pruebas cuando el usuario señala una interrupción desde el teclado.  Las herramientas interactivas que proporcionan implementaciones de @code{TestRunner} pueden usar esto de manera similar.
@end deffn

Los siguientes métodos de la clase @ref{11d8,,TestResult} se utilizan para mantener las estructuras de datos internos, y pueden ampliarse en subclases para apoyar los requisitos de información adicionales.  Esto es particularmente útil para construir herramientas que apoyen la presentación de informes interactivos mientras se ejecutan las pruebas.

@geindex startTest() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult startTest}@anchor{3fd1}
@deffn {Método} startTest (test)

Llamado cuando el caso de prueba `test' está a punto de ser ejecutado.
@end deffn

@geindex stopTest() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult stopTest}@anchor{3fd2}
@deffn {Método} stopTest (test)

Llamado después de que el caso de prueba `prueba' haya sido ejecutado, independientemente del resultado.
@end deffn

@geindex startTestRun() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult startTestRun}@anchor{13b1}
@deffn {Método} startTestRun ()

Llamado una vez antes de que se ejecute cualquier prueba.


Added in version 3.1.

@end deffn

@geindex stopTestRun() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult stopTestRun}@anchor{13b2}
@deffn {Método} stopTestRun ()

Llamado una vez después de que se ejecuten todas las pruebas.


Added in version 3.1.

@end deffn

@geindex addError() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addError}@anchor{18a0}
@deffn {Método} addError (test, err)

Llamado cuando el caso de prueba `test' plantea una excepción inesperada. `err' es una tupla de la forma devuelta por @ref{72b,,sys.exc_info()}: @code{(type, value, traceback)}.

La implementación por defecto añade una tupla @code{(test, formatted_err)} al atributo @ref{3fc8,,errors} de la instancia, donde `formatted_err' es una traza formateada derivada de `err'.
@end deffn

@geindex addFailure() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addFailure}@anchor{189f}
@deffn {Método} addFailure (test, err)

Llamado cuando el caso de prueba `test' señala un fallo. `err' es una tupla de la forma devuelta por @ref{72b,,sys.exc_info()}: @code{(type, value, traceback)}.

La implementación por defecto añade una tupla @code{(test, formatted_err)} al atributo @ref{3fc9,,failures} de la instancia, donde `formatted_err' es una traza formateada derivada de `err'.
@end deffn

@geindex addSuccess() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addSuccess}@anchor{3fd6}
@deffn {Método} addSuccess (test)

Llamado cuando el caso de prueba `test' tenga éxito.

La implementación por defecto no hace nada.
@end deffn

@geindex addSkip() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addSkip}@anchor{18a1}
@deffn {Método} addSkip (test, reason)

Llamado cuando se salta el caso de prueba `test'. `reason' es la razón que la prueba dio para saltarse.

La implementación por defecto añade una tupla @code{(test, reason)} al atributo @ref{3fca,,skipped} de la instancia.
@end deffn

@geindex addExpectedFailure() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addExpectedFailure}@anchor{3fd7}
@deffn {Método} addExpectedFailure (test, err)

Llamó cuando el caso de prueba `test' falla, pero fue marcado con el decorador @ref{3fa2,,expectedFailure()}.

La implementación por defecto añade una tupla @code{(test, formatted_err)} al atributo @ref{3fcb,,expectedFailures} de la instancia, donde `formatted_err' es una traza formateada derivada de `err'.
@end deffn

@geindex addUnexpectedSuccess() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addUnexpectedSuccess}@anchor{3fd8}
@deffn {Método} addUnexpectedSuccess (test)

Llamó cuando el caso de prueba `test' se marcó con el decorador @ref{3fa2,,expectedFailure()}, pero tuvo éxito.

La implementación por defecto añade la prueba al atributo @ref{3fcc,,unexpectedSuccesses} de la instancia.
@end deffn

@geindex addSubTest() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addSubTest}@anchor{18a2}
@deffn {Método} addSubTest (test, subtest, outcome)

Llamado cuando termina una subtest.  `test' es el caso de prueba correspondiente al método de test.  `subtest' es una instancia personalizada @ref{4fa,,TestCase} que describe el test.

Si `outcome' es @ref{716,,None}, el subtest tuvo éxito.  De lo contrario, falló con una excepción en la que `outcome' es una tupla de la forma devuelta por @ref{72b,,sys.exc_info()}: @code{(type, value, traceback)}.

La implementación por defecto no hace nada cuando el resultado es un éxito, y registra los fallos del subtest como fallos normales.


Added in version 3.4.

@end deffn

@geindex addDuration() (método de unittest.TestResult)
@anchor{library/unittest unittest TestResult addDuration}@anchor{174b}
@deffn {Método} addDuration (test, elapsed)

Llamado cuando el caso de prueba finaliza.  `elapsed' es el tiempo representado en segundos e incluye la ejecución de funciones de limpieza.


Added in version 3.12.

@end deffn
@end deffn

@geindex TextTestResult (clase en unittest)
@anchor{library/unittest unittest TextTestResult}@anchor{5d4}
@deffn {Clase} unittest.TextTestResult (stream, descriptions, verbosity, *, durations=None)

Una implementación concreta de @ref{11d8,,TestResult} utilizada por el @ref{174a,,TextTestRunner}. Las subclases deberían aceptar @code{**kwargs} para garantizar la compatibilidad a medida que cambia la interfaz.


Added in version 3.2.



Distinto en la versión 3.12: Added the `durations' keyword parameter.

@end deffn

@geindex defaultTestLoader (en el módulo unittest)
@anchor{library/unittest unittest defaultTestLoader}@anchor{3fc3}
@deffn {Dato} unittest.defaultTestLoader

Instancia de la clase @ref{3e2,,TestLoader} destinada a ser compartida.  Si no es necesario personalizar la clase @ref{3e2,,TestLoader}, esta instancia puede utilizarse en lugar de crear repetidamente nuevas instancias.
@end deffn

@geindex TextTestRunner (clase en unittest)
@anchor{library/unittest unittest TextTestRunner}@anchor{174a}
@deffn {Clase} unittest.TextTestRunner (stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False, durations=None)

Una implementación básica del test runner que produce resultados en una corriente. Si `stream' es @code{None}, el valor por defecto, @ref{9cc,,sys.stderr} se utiliza como flujo de salida. Esta clase tiene unos pocos parámetros configurables, pero es esencialmente muy simple.  Las aplicaciones gráficas que ejecutan las suites de prueba deben proporcionar implementaciones alternativas. Tales implementaciones deberían aceptar @code{**kwargs} como interfaz para construir los cambios de los corredores cuando se añaden características a unittest.

Por defecto este runner muestra @ref{1da,,DeprecationWarning}, @ref{95f,,PendingDeprecationWarning}, @ref{39d,,ResourceWarning} y @ref{59f,,ImportWarning} incluso si están @ref{3fd9,,ignorados por defecto}.  Este comportamiento se puede anular utilizando las opciones @code{-Wd} o @code{-Wa} de Python (consulte @ref{1d3e,,Control de advertencias}) y dejando `warnings' en @code{None}.


Distinto en la versión 3.2: Se añadió el argumento `warnings'.



Distinto en la versión 3.2: El flujo por defecto está configurado como @ref{9cc,,sys.stderr} en tiempo de instanciación en lugar de tiempo de importación.



Distinto en la versión 3.5: Se añadió el parámetro `tb_locals'.



Distinto en la versión 3.12: Se añadió el parámetro `durations'.


@geindex _makeResult() (método de unittest.TextTestRunner)
@anchor{library/unittest unittest TextTestRunner _makeResult}@anchor{3fda}
@deffn {Método} _makeResult ()

Este método devuelve la instancia de @code{TestResult} usada por @ref{3fdb,,run()}. No está destinado a ser llamado directamente, pero puede ser anulado en subclases para proporcionar un @code{TestResult} personalizado.

@code{_makeResult()} instanciando la clase o el pasaje llamado en el constructor @code{TextTestRunner} como el argumento de @code{resultclass}. Por defecto es @ref{5d4,,TextTestResult} si no se proporciona ninguna @code{resultclass}. La clase de resultado se instanciará con los siguientes argumentos:

@example
stream, descriptions, verbosity
@end example
@end deffn

@geindex run() (método de unittest.TextTestRunner)
@anchor{library/unittest unittest TextTestRunner run}@anchor{3fdb}
@deffn {Método} run (test)

Este método es la principal interfaz pública del @code{TextTestRunner}. Este método toma una instancia @ref{e79,,TestSuite} o @ref{4fa,,TestCase}. Se crea una @ref{11d8,,TestResult} llamando a @ref{3fda,,_makeResult()} y se ejecuta(n) la(s) prueba(s) y se imprimen los resultados a stdout.
@end deffn
@end deffn

@geindex main() (en el módulo unittest)
@anchor{library/unittest unittest main}@anchor{1062}
@deffn {Función} unittest.main (module='__main__', defaultTest=None, argv=None, testRunner=None, testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, failfast=None, catchbreak=None, buffer=None, warnings=None)

Un programa de línea de comandos que carga un conjunto de pruebas de `módulo' y las ejecuta; esto es principalmente para hacer los módulos de prueba convenientemente ejecutables. El uso más simple de esta función es incluir la siguiente línea al final de un guión de prueba:

@example
if __name__ == '__main__':
    unittest.main()
@end example

Puedes hacer pruebas con información más detallada pasando el argumento de la verbosity:

@example
if __name__ == '__main__':
    unittest.main(verbosity=2)
@end example

El argumento `defaultTest' es el nombre de una prueba única o un iterable de nombres de pruebas a ejecutar si no se especifican nombres de pruebas a través de `argv'.  Si no se especifica o @code{Ninguno} y no se proporcionan nombres de pruebas vía `argv', se ejecutan todas las pruebas encontradas en `modulo'.

El argumento `argv' puede ser una lista de opciones pasadas al programa, siendo el primer elemento el nombre del programa.  Si no se especifica o @code{Ninguno}, se utilizan los valores de @ref{12d2,,sys.argv}.

The `testRunner' argument can either be a test runner class or an already
created instance of it. By default @code{main} calls @ref{13b0,,sys.exit()} with
an exit code indicating success (0) or failure (1) of the tests run.
An exit code of 5 indicates that no tests were run or skipped.

El argumento `testLoader' tiene que ser una instancia @ref{3e2,,TestLoader}, y por defecto @ref{3fc3,,defaultTestLoader}.

@code{main} apoya el uso del intérprete interactivo pasando el argumento @code{exit=False}. Esto muestra el resultado en la salida estándar sin llamar a @ref{13b0,,sys.exit()}:

@example
>>> from unittest import main
>>> main(module='test_module', exit=False)
@end example

Los parámetros `failfast', `catchbreak' y `buffer' tienen el mismo efecto que las @ref{3f8a,,command-line options} del mismo nombre.

El argumento `warnings' especifica el @ref{960,,filtro de aviso} que debe ser usado mientras se realizan los tests.  Si no se especifica, permanecerá como @code{None} si se pasa una opción @code{-W} a @code{python} (ver @ref{1d3e,,Warning control}), de lo contrario se establecerá como @code{’default’}.

Calling @code{main} returns an object with the @code{result} attribute that contains
the result of the tests run as a @ref{11d8,,unittest.TestResult}.


Distinto en la versión 3.1: El parámetro `exit' fue añadido.



Distinto en la versión 3.2: Los parámetros `verbosity', `failfast', `catchbreak', `buffer' y `warnings' fueron añadidos.



Distinto en la versión 3.4: El parámetro `defaultTest' fue cambiado para aceptar también un iterable de nombres de pruebas.

@end deffn

@menu
* load_tests protocolo:: 

@end menu

@node load_tests protocolo,,,Cargando y ejecutando tests
@anchor{library/unittest id1}@anchor{3f9b}@anchor{library/unittest load-tests-protocol}@anchor{3f42}
@subsubsection load_tests protocolo



Added in version 3.2.


Los módulos o paquetes pueden personalizar la forma en que se cargan las pruebas a partir de ellos durante las ejecuciones de prueba normales o el descubrimiento de pruebas mediante la implementación de una función llamada @code{load_tests}.

Si un módulo de tests define @code{load_tests} será llamado por @ref{3e3,,TestLoader.loadTestsFromModule()} con los siguientes argumentos:

@example
load_tests(loader, standard_tests, pattern)
@end example

donde `pattern' se pasa directamente desde @code{loadTestsFromModule}.  Por defecto es @code{None}.

Debe retornar una @ref{e79,,TestSuite}.

`loader' es la instancia de @ref{3e2,,TestLoader} haciendo la carga. `standard_tests' son los tests que se cargarían por defecto desde el módulo. Es común que los módulos de test sólo quieran añadir o quitar tests del conjunto de tests estándar. El tercer argumento se usa cuando se cargan paquetes como parte del descubrimiento de tests.

Una típica función de @code{load_tests} que carga pruebas de un conjunto específico de @code{TestCase`class:`TestCase} puede ser como:

@example
test_cases = (TestCase1, TestCase2, TestCase3)

def load_tests(loader, tests, pattern):
    suite = TestSuite()
    for test_class in test_cases:
        tests = loader.loadTestsFromTestCase(test_class)
        suite.addTests(tests)
    return suite
@end example

Si discovery se inicia en un directorio que contiene un paquete, ya sea desde la línea de comandos o llamando a @ref{1064,,TestLoader.discover()}, entonces el paquete @code{__init__.py} se comprobará por @code{load_tests}.  Si esa función no existe, discover se reincorporará al paquete como si fuera un directorio más.  De lo contrario, el descubrimiento de los tests del paquete se dejará en @code{load_tests} que se llama con los siguientes argumentos:

@example
load_tests(loader, standard_tests, pattern)
@end example

Esto debería devolver un @ref{e79,,TestSuite} que represente todas las pruebas del paquete. (@code{test_estándar} sólo contendrá las pruebas recogidas de @code{__init__.py}.)

Debido a que el patrón se pasa a @code{load_tests} el paquete es libre de continuar (y potencialmente modificar) el descubrimiento de pruebas. Una función de “no hace nada” @code{load_test} para un paquete de pruebas se vería como:

@example
def load_tests(loader, standard_tests, pattern):
    # top level directory cached on loader instance
    this_dir = os.path.dirname(__file__)
    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
    standard_tests.addTests(package_tests)
    return standard_tests
@end example


Distinto en la versión 3.5: Discovery ya no comprueba si los nombres de los paquetes coinciden con el `patrón' debido a la imposibilidad de que los nombres de los paquetes coincidan con el patrón por defecto.


@node Instalaciones para clases y módulos,Manejo de señales,Clases y funciones,unittest — Unit testing framework
@anchor{library/unittest class-and-module-fixtures}@anchor{3faa}
@subsubsection Instalaciones para clases y módulos


Los accesorios de nivel de clase y módulo se implementan en @ref{e79,,TestSuite}. Cuando el conjunto de pruebas se encuentra con una prueba de una nueva clase entonces se llama @code{tearDownClass()} de la clase anterior (si existe), seguido de @code{setUpClass()} de la nueva clase.

Del mismo modo, si una prueba es de un módulo diferente de la prueba anterior, entonces se ejecuta @code{DesmontarMódulo} del módulo anterior, seguido de @code{DesmontarMódulo} del nuevo módulo.

Después de todas las pruebas, se ejecutan los últimos @code{tearDownClass} y @code{tearDownModule}.

Tenga en cuenta que los accesorios compartidos no juegan bien con las características [potenciales] como la paralelización de la prueba y rompen el aislamiento de la prueba. Deben ser usados con cuidado.

El orden por defecto de las pruebas creadas por los cargadores de pruebas unitarias es agrupar todas las pruebas de los mismos módulos y clases. Esto llevará a que @code{setUpClass} / @code{setUpModule} (etc) sea llamado exactamente una vez por clase y módulo. Si se aleatoriza el orden, de manera que las pruebas de diferentes módulos y clases sean adyacentes entre sí, entonces estas funciones compartidas de fixture pueden ser llamadas varias veces en una sola ejecución de prueba.

Los accesorios compartidos no están pensados para trabajar con suites con pedidos no estándar. Todavía existe una @code{BaseTestSuite} para los marcos de trabajo que no quieren soportar accesorios compartidos.

Si hay alguna excepción planteada durante una de las funciones compartidas del aparato, la prueba se notifica como un error. Debido a que no hay una instancia de prueba correspondiente, se crea un objeto @code{_ErrorHolder} (que tiene la misma interfaz que un @ref{4fa,,TestCase}) para representar el error. Si sólo estás usando el standard unittest test runner entonces este detalle no importa, pero si eres un autor de marcos de trabajo puede ser relevante.

@menu
* setUpClass y tearDownClass:: 
* setUpModule y tearDownModule:: 

@end menu

@node setUpClass y tearDownClass,setUpModule y tearDownModule,,Instalaciones para clases y módulos
@anchor{library/unittest setupclass-and-teardownclass}@anchor{3fdc}
@subsubsection setUpClass y tearDownClass


Estos deben ser implementados como métodos de clase:

@example
import unittest

class Test(unittest.TestCase):
    @@classmethod
    def setUpClass(cls):
        cls._connection = createExpensiveConnectionObject()

    @@classmethod
    def tearDownClass(cls):
        cls._connection.destroy()
@end example

Si quieres que se invoque a @code{SetUpClass} y @code{BreakdownClass} en clases base, debes llamarlos tú mismo. Las implementaciones en  @ref{4fa,,TestCase}  están vacías.

Si se lanza una excepción durante una @code{setUpClass}, entonces los tests de la clase no se ejecutan y la @code{tearDownClass} no se ejecuta. Las clases que se salten no tendrán @code{setUpClass} o @code{tearDownClass}. Si la excepción es una @ref{1063,,SkipTest}  entonces la clase será reportada como salteada en lugar de como un error.

@node setUpModule y tearDownModule,,setUpClass y tearDownClass,Instalaciones para clases y módulos
@anchor{library/unittest setupmodule-and-teardownmodule}@anchor{3fdd}
@subsubsection setUpModule y tearDownModule


Estos deben ser implementados como funciones:

@example
def setUpModule():
    createConnection()

def tearDownModule():
    closeConnection()
@end example

Si se lanza una excepción en un  @code{setUpModule}, entonces no se ejecutará ninguna de las pruebas del módulo y no se ejecutará el @code{tearDownModule}. Si la excepción es una @ref{1063,,SkipTest}   entonces el módulo será reportado como saltado en lugar de como un error.

Para agregar código de limpieza que se debe ejecutar incluso en el caso de una excepción, utilice @code{addModuleCleanup}:

@geindex addModuleCleanup() (en el módulo unittest)
@anchor{library/unittest unittest addModuleCleanup}@anchor{adf}
@deffn {Función} unittest.addModuleCleanup (function, /, *args, **kwargs)

Añade una función que se llamará después de @code{tearDownModule()} para limpiar los recursos utilizados durante la clase de test. Las funciones se llamarán en orden inverso al orden en que se agregan (@abbr{LIFO}). Se llaman con cualquier argumento y palabra clave que se pase a @ref{adf,,addModuleCleanup()} cuando se añadan.

Si @code{setUpModule()} falla, lo que significa que @code{tearDownModule()} no se invoca, entonces cualquier función de limpieza añadida seguirá siendo invocada.


Added in version 3.8.

@end deffn

@geindex enterModuleContext() (en el módulo unittest)
@anchor{library/unittest unittest enterModuleContext}@anchor{75d}
@deffn {Método} classmethod unittest.enterModuleContext (cm)

Introduce el @ref{675,,context manager} suministrado. Si es exitoso, añade también su método @ref{1367,,__exit__()} como función de limpieza mediante @ref{adf,,addModuleCleanup()} y retorna el resultado del método @ref{669,,__enter__()}.


Added in version 3.11.

@end deffn

@geindex doModuleCleanups() (en el módulo unittest)
@anchor{library/unittest unittest doModuleCleanups}@anchor{1843}
@deffn {Función} unittest.doModuleCleanups ()

Esta función se llama incondicionalmente después de @code{tearDownModule()}, o después de @code{setUpModule()} si @code{setUpModule()} lanza una excepción.

Es responsable de invocar a todas las funciones de limpieza añadidas por @code{addCleanupModule()}. Si necesitas que las funciones de limpieza se llamen `previamente' a @code{tearDownModule()} entonces puedes invocar a @ref{1843,,doModuleCleanups()} tú mismo.

@ref{1843,,doModuleCleanups()} saca los métodos de la pila de funciones de limpieza uno a uno, así que se puede llamar en cualquier momento.


Added in version 3.8.

@end deffn

@node Manejo de señales,,Instalaciones para clases y módulos,unittest — Unit testing framework
@anchor{library/unittest signal-handling}@anchor{3f8d}
@subsubsection Manejo de señales



Added in version 3.2.


The @ref{139a,,-c/--catch} command-line option to unittest,
along with the @code{catchbreak} parameter to @ref{1062,,unittest.main()}, provide
more friendly handling of control-C during a test run. With catch break
behavior enabled control-C will allow the currently running test to complete,
and the test run will then end and report all the results so far. A second
control-c will raise a @ref{a63,,KeyboardInterrupt} in the usual way.

El manejador de señales de manejo de control-c intenta permanecer compatible con el código o las pruebas que instalan su propio manejador @ref{8db,,signal.SIGINT} . Si se llama al manejador @code{unittest} pero `no es' el manejador @ref{8db,,signal.SIGINT} instalado, es decir, ha sido reemplazado por el sistema bajo test y delegado, entonces llama al manejador por defecto. Este será normalmente el comportamiento esperado por el código que reemplaza un manejador instalado y delega en él. Para las pruebas individuales que necesiten el manejo de control-c de @code{unittest} deshabilitado se puede usar el decorador @ref{139b,,removeHandler()}.

Hay algunas funciones de utilidad para que los autores de marcos de trabajo habiliten la funcionalidad de control de control-c dentro de los marcos de prueba.

@geindex installHandler() (en el módulo unittest)
@anchor{library/unittest unittest installHandler}@anchor{3fde}
@deffn {Función} unittest.installHandler ()

Instala el controlador de control-c. Cuando se recibe una @ref{8db,,signal.SIGINT}  (normalmente en respuesta a que el usuario presione control-c) todos los resultados registrados tienen @ref{3fce,,stop()} llamado.
@end deffn

@geindex registerResult() (en el módulo unittest)
@anchor{library/unittest unittest registerResult}@anchor{3fdf}
@deffn {Función} unittest.registerResult (result)

Registrar un objeto  @ref{11d8,,TestResult}  para el manejo de control-c. El registro de un resultado almacena una referencia débil a él, por lo que no evita que el resultado sea recogido por el recolector de basura.

El registro de un objeto @ref{11d8,,TestResult} no tiene efectos secundarios si el manejo de control-c no está habilitado, por lo que los marcos de pruebas pueden registrar incondicionalmente todos los resultados que crean independientemente de si el manejo está habilitado o no.
@end deffn

@geindex removeResult() (en el módulo unittest)
@anchor{library/unittest unittest removeResult}@anchor{3fe0}
@deffn {Función} unittest.removeResult (result)

Elimine un resultado registrado. Una vez que un resultado ha sido eliminado, @ref{3fce,,stop()} ya no se llamará en ese objeto de resultado en respuesta a un control-c.
@end deffn

@geindex removeHandler() (en el módulo unittest)
@anchor{library/unittest unittest removeHandler}@anchor{139b}
@deffn {Función} unittest.removeHandler (function=None)

Cuando se llama sin argumentos, esta función quita el gestor control-c si se ha instalado. Esta función también se puede utilizar como decorador de tests para quitar temporalmente el controlador mientras se ejecuta el test:

@example
@@unittest.removeHandler
def test_signal_handling(self):
    ...
@end example
@end deffn

@node unittest mock — mock object library,unittest mock — getting started,unittest — Unit testing framework,Herramientas de desarrollo
@anchor{library/unittest mock doc}@anchor{3fe1}@anchor{library/unittest mock module-unittest mock}@anchor{107}@anchor{library/unittest mock unittest-mock-mock-object-library}@anchor{3fe2}
@subsection @code{unittest.mock} — mock object library


@geindex module; unittest.mock


Added in version 3.3.


`Source code:' Lib/unittest/mock.py@footnote{https://github.com/python/cpython/tree/main/Lib/unittest/mock.py}


__________________________________________________________________


@ref{107,,unittest.mock} es una biblioteca para pruebas de software en Python. Te permite reemplazar partes del sistema bajo prueba con objetos simulados y hacer aserciones sobre cómo se han utilizado.

El módulo @ref{107,,unittest.mock} proporciona una clase principal @ref{ade,,Mock} eliminando la necesidad de crear una gran cantidad de stubs en todo el conjunto de pruebas. Después de realizar una determinada acción, puedes hacer aserciones sobre qué métodos/atributos se usaron y los argumentos con los que se llamaron. También puedes especificar valores de retorno y establecer los atributos necesarios de la forma habitual.

Además, mock proporciona un decorador @ref{f13,,patch()} que puede manejar el parcheo de atributos a nivel de clase y de módulo dentro del ámbito de una prueba, junto con @ref{c28,,sentinel} para crear objetos únicos. Consulta @ref{3fe3,,quick guide} para ver algunos ejemplos de cómo utilizar @ref{ade,,Mock}, @ref{f12,,MagicMock} y @ref{f13,,patch()}.

Mock está diseñado para ser utilizado junto a @ref{106,,unittest}. Mock se basa en el patrón “acción -> aserción” en lugar de usar el patrón “grabación -> reproducción” utilizado por muchos frameworks de simulación.

There is a backport of @ref{107,,unittest.mock} for earlier versions of Python,
available as mock@footnote{https://pypi.org/project/mock/} on PyPI.

@menu
* Guía rápida:: 
* La clase Mock:: 
* Parcheadores:: 
* MagicMock y el soporte de métodos mágicos:: 
* Ayudantes:: 
* Order of precedence of side_effect@comma{} return_value and wraps: Order of precedence of side_effect return_value and wraps. 

@end menu

@node Guía rápida,La clase Mock,,unittest mock — mock object library
@anchor{library/unittest mock quick-guide}@anchor{3fe3}
@subsubsection Guía rápida


@c class ProductionClass:
@c     def method(self, a, b, c):
@c         pass
@c 
@c class SomeClass:
@c     @staticmethod
@c     def static_method(args):
@c         return args
@c 
@c     @classmethod
@c     def class_method(cls, args):
@c         return args

Los objetos de las clases @ref{ade,,Mock} y @ref{f12,,MagicMock} van creando todos los atributos y métodos a medida que se accede a ellos y almacenan detalles de cómo se han utilizado. Puedes configurarlos para especificar valores de retorno o limitar qué atributos están disponibles y posteriormente hacer aserciones sobre cómo han sido utilizados:

@example
>>> from unittest.mock import MagicMock
>>> thing = ProductionClass()
>>> thing.method = MagicMock(return_value=3)
>>> thing.method(3, 4, 5, key='value')
3
>>> thing.method.assert_called_with(3, 4, 5, key='value')
@end example

@ref{3fe4,,side_effect} allows you to perform side effects, including raising an
exception when a mock is called:

@example
>>> from unittest.mock import Mock
>>> mock = Mock(side_effect=KeyError('foo'))
>>> mock()
Traceback (most recent call last):
 ...
KeyError: 'foo'
@end example

@example
>>> values = @{'a': 1, 'b': 2, 'c': 3@}
>>> def side_effect(arg):
...     return values[arg]
...
>>> mock.side_effect = side_effect
>>> mock('a'), mock('b'), mock('c')
(1, 2, 3)
>>> mock.side_effect = [5, 4, 3, 2, 1]
>>> mock(), mock(), mock()
(5, 4, 3)
@end example

Existen muchas otras formas de configurar y controlar el comportamiento de Mock. Por ejemplo, el argumento `spec' configura el objeto simulado para que tome su especificación de otro objeto. Cualquier intento de acceder a atributos o métodos en el objeto simulado que no existan en la especificación fallará lanzando una excepción @ref{441,,AttributeError}.

El decorador / gestor de contexto @ref{f13,,patch()} facilita la simulación de clases u objetos en un módulo bajo prueba. El objeto que especifiques será reemplazado por un objeto simulado (u otro objeto) durante la prueba y será restaurado cuando esta finalice:

@example
>>> from unittest.mock import patch
>>> @@patch('module.ClassName2')
... @@patch('module.ClassName1')
... def test(MockClass1, MockClass2):
...     module.ClassName1()
...     module.ClassName2()
...     assert MockClass1 is module.ClassName1
...     assert MockClass2 is module.ClassName2
...     assert MockClass1.called
...     assert MockClass2.called
...
>>> test()
@end example

@cartouche
@quotation Nota 
Cuando anidas decoradores patch, los objetos simulados se pasan a la función decorada en el mismo orden en el que fueron aplicados (el orden normal en el que se aplican los decoradores en `Python'). Esto significa de abajo hacia arriba, por lo que en el ejemplo anterior se pasa primero el objeto simulado para @code{module.ClassName1}.

Al usar @ref{f13,,patch()} es importante que parchees los objetos en el espacio de nombres donde son buscados. Esto normalmente es sencillo, pero para una guía rápida, lee @ref{3fe5,,dónde parchear}.
@end quotation
@end cartouche

Además de decorador, la función @ref{f13,,patch()} se puede usar como gestor de contexto en una declaración with:

@example
>>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method:
...     thing = ProductionClass()
...     thing.method(1, 2, 3)
...
>>> mock_method.assert_called_once_with(1, 2, 3)
@end example

También existe la función @ref{1605,,patch.dict()} que permite establecer valores en un diccionario dentro de un ámbito y restaurar el diccionario a su estado original cuando finaliza la prueba:

@example
>>> foo = @{'key': 'value'@}
>>> original = foo.copy()
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}, clear=True):
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> assert foo == original
@end example

Mock admite la simulación de los @ref{3fe6,,métodos mágicos} de Python. La forma más sencilla de utilizar métodos mágicos es mediante la clase @ref{f12,,MagicMock}. Te permite hacer cosas como:

@example
>>> mock = MagicMock()
>>> mock.__str__.return_value = 'foobarbaz'
>>> str(mock)
'foobarbaz'
>>> mock.__str__.assert_called_with()
@end example

Mock también permite asignar funciones (u otras instancias de Mock) a métodos mágicos y se asegura de que serán llamadas de forma apropiada. La clase @ref{f12,,MagicMock} es solo una variante de Mock con la diferencia de que tiene todos los métodos mágicos previamente creados para ti (bueno, todos los que son útiles).

El siguiente es un ejemplo de uso de métodos mágicos utilizando la clase Mock ordinaria:

@example
>>> mock = Mock()
>>> mock.__str__ = Mock(return_value='wheeeeee')
>>> str(mock)
'wheeeeee'
@end example

Para asegurarte de que los objetos simulados en tus pruebas tienen exactamente la misma API que los objetos que están reemplazando, puedes usar @ref{3fe7,,autoespecificación}. La autoespecificación se puede realizar a través del argumento `autospec' de patch, o mediante la función @ref{15c9,,create_autospec()}. La autoespecificación crea objetos simulados que tienen los mismos atributos y métodos que los objetos que están reemplazando, y todas las función y métodos (incluidos los constructores) tienen la misma firma de llamada que los objetos reales.

Esto asegura que tus simulaciones fallarán, si se utilizan incorrectamente, de la misma manera que lo haría tu código en producción:

@example
>>> from unittest.mock import create_autospec
>>> def function(a, b, c):
...     pass
...
>>> mock_function = create_autospec(function, return_value='fishy')
>>> mock_function(1, 2, 3)
'fishy'
>>> mock_function.assert_called_once_with(1, 2, 3)
>>> mock_function('wrong arguments')
Traceback (most recent call last):
 ...
TypeError: missing a required argument: 'b'
@end example

@ref{15c9,,create_autospec()} también se puede usar en clases, donde copia la firma del método @code{__init__}, y en objetos invocables, donde copia la firma del método @code{__call__}.

@node La clase Mock,Parcheadores,Guía rápida,unittest mock — mock object library
@anchor{library/unittest mock the-mock-class}@anchor{3fe8}
@subsubsection La clase Mock


@c import asyncio
@c import inspect
@c import unittest
@c import threading
@c from unittest.mock import sentinel, DEFAULT, ANY
@c from unittest.mock import patch, call, Mock, MagicMock, PropertyMock, AsyncMock
@c from unittest.mock import ThreadingMock
@c from unittest.mock import mock_open

@ref{ade,,Mock} es un objeto simulado flexible, destinado a reemplazar el uso de stubs y dobles de prueba en todo tu código. Los objetos Mock son invocables y crean atributos en el mismo momento que se accede a ellos como nuevos objetos Mock @footnote{
Las únicas excepciones son los métodos y atributos mágicos (aquellos que tienen doble subrayado al principio y al final). Mock no los crea automáticamente, sino que lanza una excepción @ref{441,,AttributeError}. Esto se debe a que el intérprete a menudo solicitará implícitamente estos métodos y terminaría `muy' confundido si obtiene un nuevo objeto Mock cuando espera un método mágico. Si necesitas soporte para métodos mágicos, consulta @ref{3fe6,,métodos mágicos}.
}. Acceder al mismo atributo siempre retornará el mismo objeto Mock. Además, registran cómo los usas, lo que te permite hacer aserciones sobre cómo tu código ha interaccionado con ellos.

@ref{f12,,MagicMock} es una subclase de @ref{ade,,Mock} con todos los métodos mágicos creados previamente y listos para ser usados. También hay variantes no invocables, útiles cuando se están simulando objetos que no se pueden llamar: @ref{3fe9,,NonCallableMock} y @ref{3fea,,NonCallableMagicMock}

Los decoradores @ref{f13,,patch()} facilitan la sustitución temporal de clases en un módulo en particular con un objeto @ref{ade,,Mock}. Por defecto, @ref{f13,,patch()} creará un objeto @ref{f12,,MagicMock} automáticamente. Se puede especificar una clase alternativa a @ref{ade,,Mock} usando el argumento `new_callable' de @ref{f13,,patch()}.

@geindex Mock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock Mock}@anchor{ade}
@deffn {Clase} unittest.mock.Mock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

Crea un nuevo objeto @ref{ade,,Mock}. @ref{ade,,Mock} toma varios argumentos opcionales que especifican el comportamiento del objeto Mock:


@itemize *

@item 
`spec': Puede ser una lista de cadenas de caracteres o un objeto existente previamente (una clase o una instancia) que actúa como la especificación del objeto simulado. Si pasas un objeto, se forma una lista de cadenas llamando a la función `dir' en el objeto (excluyendo los métodos y atributos mágicos no admitidos). Acceder a cualquier atributo que no esté en esta lista lanzará una excepción @ref{441,,AttributeError}.

If `spec' is an object (rather than a list of strings) then
@ref{14e9,,__class__} returns the class of the spec object. This
allows mocks to pass @ref{4ef,,isinstance()} tests.

@item 
`spec_set': Una variante más estricta de `spec'. Si se utiliza, cualquier intento de `establecer' u obtener un atributo del objeto simulado que no esté en el objeto pasado como `spec_set' lanzará una excepción @ref{441,,AttributeError}.

@item 
`side_effect': Una función que se llamará cada vez que el objeto simulado sea invocado. Consultar el atributo @ref{3fe4,,side_effect} para más información. Es útil para lanzar excepciones o para cambiar dinámicamente valores de retorno. La función se llama con los mismos argumentos que el objeto simulado, y a menos que retorne @ref{3feb,,DEFAULT}, su valor de retorno se utiliza como valor de retorno del propio objeto simulado.

Alternativamente `side_effect' puede ser una clase o instancia de excepción. En este caso, se lanza la excepción cuando se llama al objeto simulado.

Si `side_effect' es un iterable, cada llamada al objeto simulado retornará el siguiente valor del iterable.

Un `side_effect' se puede desactivar estableciéndolo en @code{None}.

@item 
`return_value': El valor retornado cuando se llama al objeto simulado. Por defecto, este es una nueva instancia de la clase Mock (creada en el primer acceso). Consultar el atributo @ref{3fec,,return_value} para más detalles.

@item 
`unsafe': Por defecto, el acceso a cualquier atributo cuyo nombre comience por `assert', `assret', `asert', `aseert' o `assrt' generará un error @ref{441,,AttributeError}. Si se pasa @code{unsafe=True} se permitirá el acceso a estos atributos.


Added in version 3.5.


@item 
`wraps': objeto a envolver (simular) por la instancia de Mock. Si `wraps' no es @code{None}, al llamar al objeto Mock se pasa la llamada a través del objeto envuelto (retornando el resultado real). Acceder a un atributo del objeto simulado retornará otro objeto Mock que envuelve al atributo correspondiente del objeto real envuelto (de modo que intentar acceder a un atributo que no existe lanzará una excepción @ref{441,,AttributeError}).

Si el objeto simulado tiene un `return_value' explícito establecido, las llamadas no se pasan al objeto envuelto y `return_value' se retorna en su lugar.

@item 
`name': Si el objeto simulado tiene un nombre, será utilizado en la representación imprimible del mismo. Esto puede ser útil para la depuración. El nombre se propaga a los objetos simulados hijos.
@end itemize

Los objetos simulados también pueden ser invocados con argumentos por palabra clave arbitrarios. Estos serán utilizados para establecer atributos en el objeto simulado una vez creado. Consultar el método @ref{3fed,,configure_mock()} para más detalles.

@geindex assert_called() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called}@anchor{d7f}
@deffn {Método} assert_called ()

Assert cuando el objeto simulado se ha invocado al menos una vez.

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called()
@end example


Added in version 3.6.

@end deffn

@geindex assert_called_once() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_once}@anchor{d80}
@deffn {Método} assert_called_once ()

Assert si el objeto simulado se ha invocado exactamente una vez.

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_once()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_once()
Traceback (most recent call last):
...
AssertionError: Expected 'method' to have been called once. Called 2 times.
Calls: [call(), call()].
@end example


Added in version 3.6.

@end deffn

@geindex assert_called_with() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_with}@anchor{1a28}
@deffn {Método} assert_called_with (*args, **kwargs)

Este método es una manera apropiada de asertar si la última llamada se ha realizado de una manera particular:

@example
>>> mock = Mock()
>>> mock.method(1, 2, 3, test='wow')
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_with(1, 2, 3, test='wow')
@end example
@end deffn

@geindex assert_called_once_with() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_once_with}@anchor{3fee}
@deffn {Método} assert_called_once_with (*args, **kwargs)

Assert si el objeto simulado se ha invocado exactamente una vez y si esa llamada se realizó con los argumentos especificados.

@example
>>> mock = Mock(return_value=None)
>>> mock('foo', bar='baz')
>>> mock.assert_called_once_with('foo', bar='baz')
>>> mock('other', bar='values')
>>> mock.assert_called_once_with('other', bar='values')
Traceback (most recent call last):
  ...
AssertionError: Expected 'mock' to be called once. Called 2 times.
Calls: [call('foo', bar='baz'), call('other', bar='values')].
@end example
@end deffn

@geindex assert_any_call() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_any_call}@anchor{3fef}
@deffn {Método} assert_any_call (*args, **kwargs)

assert si el objeto simulado se ha invocado con los argumentos especificados.

La aserción pasa si el objeto simulado se ha invocado `en algún momento', a diferencia de @ref{1a28,,assert_called_with()} y @ref{3fee,,assert_called_once_with()}, con los que solo pasa la aserción si la llamada es la más reciente, y en el caso de @ref{3fee,,assert_called_once_with()} también debe ser la única llamada realizada.

@example
>>> mock = Mock(return_value=None)
>>> mock(1, 2, arg='thing')
>>> mock('some', 'thing', 'else')
>>> mock.assert_any_call(1, 2, arg='thing')
@end example
@end deffn

@geindex assert_has_calls() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_has_calls}@anchor{16b2}
@deffn {Método} assert_has_calls (calls, any_order=False)

assert si el objeto simulado se ha invocado con las llamadas especificadas. La lista @ref{3ff0,,mock_calls} se compara con la lista de llamadas.

Si `any_order' es falso entonces las llamadas deben ser secuenciales. No puede haber llamadas adicionales antes o después de las llamadas especificadas.

Si `any_order' es verdadero, las llamadas pueden estar en cualquier orden, pero deben aparecer todas en @ref{3ff0,,mock_calls}.

@example
>>> mock = Mock(return_value=None)
>>> mock(1)
>>> mock(2)
>>> mock(3)
>>> mock(4)
>>> calls = [call(2), call(3)]
>>> mock.assert_has_calls(calls)
>>> calls = [call(4), call(2), call(3)]
>>> mock.assert_has_calls(calls, any_order=True)
@end example
@end deffn

@geindex assert_not_called() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_not_called}@anchor{f11}
@deffn {Método} assert_not_called ()

Assert si el objeto simulado nunca fue invocado.

@example
>>> m = Mock()
>>> m.hello.assert_not_called()
>>> obj = m.hello()
>>> m.hello.assert_not_called()
Traceback (most recent call last):
  ...
AssertionError: Expected 'hello' to not have been called. Called 1 times.
Calls: [call()].
@end example


Added in version 3.5.

@end deffn

@geindex reset_mock() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock reset_mock}@anchor{d81}
@deffn {Método} reset_mock (*, return_value=False, side_effect=False)

El método `reset_mock' restablece todos los atributos de llamada en un objeto simulado:

@example
>>> mock = Mock(return_value=None)
>>> mock('hello')
>>> mock.called
True
>>> mock.reset_mock()
>>> mock.called
False
@end example

This can be useful where you want to make a series of assertions that
reuse the same object.

`return_value' parameter when set to @code{True} resets @ref{3fec,,return_value}:

@example
>>> mock = Mock(return_value=5)
>>> mock('hello')
5
>>> mock.reset_mock(return_value=True)
>>> mock('hello')  
<Mock name='mock()' id='...'>
@end example

`side_effect' parameter when set to @code{True} resets @ref{3fe4,,side_effect}:

@example
>>> mock = Mock(side_effect=ValueError)
>>> mock('hello')
Traceback (most recent call last):
  ...
ValueError
>>> mock.reset_mock(side_effect=True)
>>> mock('hello')  
<Mock name='mock()' id='...'>
@end example

Note that @ref{d81,,reset_mock()} `doesn’t' clear the
@ref{3fec,,return_value}, @ref{3fe4,,side_effect} or any child attributes you have
set using normal assignment by default.

Child mocks are reset as well.


Distinto en la versión 3.6: Se añadieron dos argumentos de palabra clave a la función `reset_mock'.

@end deffn

@geindex mock_add_spec() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock mock_add_spec}@anchor{3ff1}
@deffn {Método} mock_add_spec (spec, spec_set=False)

Agrega una especificación a un objeto simulado. `spec' puede ser un objeto o una lista de cadenas de caracteres. Solo los atributos presentes en `spec' pueden ser obtenidos desde el objeto simulado.

Si `spec_set' es verdadero, solo los atributos de la especificación pueden ser establecidos.
@end deffn

@geindex attach_mock() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock attach_mock}@anchor{15f1}
@deffn {Método} attach_mock (mock, attribute)

Adjunta otro objeto simulado como un atributo de la instancia actual, substituyendo su nombre y su padre. Las llamadas al objeto simulado adjuntado se registrarán en los atributos @ref{3ff2,,method_calls} y @ref{3ff0,,mock_calls} del padre.
@end deffn

@geindex configure_mock() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock configure_mock}@anchor{3fed}
@deffn {Método} configure_mock (**kwargs)

Establece los atributos del objeto simulado por medio de argumentos por palabra clave.

Los atributos, los valores de retorno y los efectos de colaterales se pueden configurar en los objetos simulados hijos usando la notación de punto estándar y desempaquetando un diccionario en la llamada al método:

@example
>>> mock = Mock()
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock.configure_mock(**attrs)
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

Lo mismo se puede lograr en la llamada al constructor de los objetos simulados:

@example
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

@ref{3fed,,configure_mock()} existe con el fin de facilitar la configuración después de que el objeto simulado haya sido creado.
@end deffn

@geindex __dir__() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock __dir__}@anchor{3ff3}
@deffn {Método} __dir__ ()

Los objetos @ref{ade,,Mock} limitan los resultados de @code{dir(some_mock)} a resultados útiles. Para los objetos simulados con una especificación (`spec'), esto incluye todos los atributos permitidos para el mismo.

Consultar @ref{3ff4,,FILTER_DIR} para conocer que hace este filtrado y la forma de desactivarlo.
@end deffn

@geindex _get_child_mock() (método de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock _get_child_mock}@anchor{3ff5}
@deffn {Método} _get_child_mock (**kw)

Crea los objetos simulados hijos para los atributos y el valor de retorno. Por defecto los objetos simulados hijos serán del mismo tipo que el padre. Las subclases de Mock pueden redefinir este método para personalizar la forma en la que se construye el objeto simulado hijo.

Para objetos simulados no invocables la variante invocable será utilizada (en lugar de cualquier subclase personalizada).
@end deffn

@geindex called (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock called}@anchor{3ff6}
@deffn {Atributo} called

Un booleano que representa si el objeto simulado ha sido invocado o no:

@example
>>> mock = Mock(return_value=None)
>>> mock.called
False
>>> mock()
>>> mock.called
True
@end example
@end deffn

@geindex call_count (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_count}@anchor{3ff7}
@deffn {Atributo} call_count

Un entero que le indica cuántas veces el objeto simulado ha sido invocado:

@example
>>> mock = Mock(return_value=None)
>>> mock.call_count
0
>>> mock()
>>> mock()
>>> mock.call_count
2
@end example
@end deffn

@geindex return_value (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock return_value}@anchor{3fec}
@deffn {Atributo} return_value

Establece este atributo para configurar el valor a retornar cuando se llama al objeto simulado:

@example
>>> mock = Mock()
>>> mock.return_value = 'fish'
>>> mock()
'fish'
@end example

El valor de retorno por defecto es otro objeto simulado y se puede configurar de forma habitual:

@example
>>> mock = Mock()
>>> mock.return_value.attribute = sentinel.Attribute
>>> mock.return_value()
<Mock name='mock()()' id='...'>
>>> mock.return_value.assert_called_with()
@end example

@ref{3fec,,return_value} también se puede establecer directamente en el constructor:

@example
>>> mock = Mock(return_value=3)
>>> mock.return_value
3
>>> mock()
3
@end example
@end deffn

@geindex side_effect (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock side_effect}@anchor{3fe4}
@deffn {Atributo} side_effect

Este atributo puede ser una función a ser llamada cuando se llame al objeto simulado, un iterable o una excepción (clase o instancia) para ser lanzada.

Si pasas una función, será llamada con los mismos argumentos que el objeto simulado y, a menos que la función retorne el singleton @ref{3feb,,DEFAULT}, la llamada al objeto simulado retornará lo mismo que retorna la función. En cambio, si la función retorna @ref{3feb,,DEFAULT}, entonces el objeto simulado retornará su valor normal (el del atributo @ref{3fec,,return_value}).

Si pasas un iterable, se utiliza para obtener un iterador a partir del mismo que debe producir un valor en cada llamada. Este valor puede ser una instancia de la excepción a ser lanzada o un valor a retornar al llamar al objeto simulado (el manejo de @ref{3feb,,DEFAULT} es igual que en el caso en el que se pasa una función).

Un ejemplo de un objeto simulado que genera una excepción (para probar el manejo de excepciones de una API):

@example
>>> mock = Mock()
>>> mock.side_effect = Exception('Boom!')
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

Usando @ref{3fe4,,side_effect} para retornar una secuencia de valores:

@example
>>> mock = Mock()
>>> mock.side_effect = [3, 2, 1]
>>> mock(), mock(), mock()
(3, 2, 1)
@end example

Usando un objeto invocable:

@example
>>> mock = Mock(return_value=3)
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> mock.side_effect = side_effect
>>> mock()
3
@end example

@ref{3fe4,,side_effect} se puede establecer en el constructor. Aquí hay un ejemplo que suma uno al valor del objeto simulado invocado y lo retorna:

@example
>>> side_effect = lambda value: value + 1
>>> mock = Mock(side_effect=side_effect)
>>> mock(3)
4
>>> mock(-8)
-7
@end example

Establecer @ref{3fe4,,side_effect} en @code{None} lo desactiva:

@example
>>> m = Mock(side_effect=KeyError, return_value=3)
>>> m()
Traceback (most recent call last):
 ...
KeyError
>>> m.side_effect = None
>>> m()
3
@end example
@end deffn

@geindex call_args (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_args}@anchor{1989}
@deffn {Atributo} call_args

Este atributo es @code{None} (si el objeto simulado no ha sido invocado) o los argumentos con los que se llamó por última vez. En este último caso, será una tupla con dos elementos: el primer miembro, que también es accesible a través de la propiedad @code{args}, son los argumentos posicionales con los que el objeto simulado se llamó (o una tupla vacía si no se pasó ninguno) y el segundo miembro, que también es accesible mediante la propiedad @code{kwargs}, son los argumento por palabra clave pasados (o un diccionario vacío si no se pasó ninguno).

@example
>>> mock = Mock(return_value=None)
>>> print(mock.call_args)
None
>>> mock()
>>> mock.call_args
call()
>>> mock.call_args == ()
True
>>> mock(3, 4)
>>> mock.call_args
call(3, 4)
>>> mock.call_args == ((3, 4),)
True
>>> mock.call_args.args
(3, 4)
>>> mock.call_args.kwargs
@{@}
>>> mock(3, 4, 5, key='fish', next='w00t!')
>>> mock.call_args
call(3, 4, 5, key='fish', next='w00t!')
>>> mock.call_args.args
(3, 4, 5)
>>> mock.call_args.kwargs
@{'key': 'fish', 'next': 'w00t!'@}
@end example

El atributo @ref{1989,,call_args}, junto con los miembros de las listas @ref{3ff8,,call_args_list}, @ref{3ff2,,method_calls} y @ref{3ff0,,mock_calls} son objetos @ref{19d7,,call}. Estos objetos son tuplas, con la finalidad de que puedan ser desempaquetadas para acceder a los argumentos individuales y hacer aserciones más complejas. Consultar @ref{3ff9,,objetos call como tuplas} para más información.


Distinto en la versión 3.8: Propiedades @code{args} y @code{kwargs} agregadas.

@end deffn

@geindex call_args_list (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_args_list}@anchor{3ff8}
@deffn {Atributo} call_args_list

Este argumento es una lista de todas las llamadas consecutivas realizadas al objeto simulado (por lo que la longitud de la lista es el número de veces que se ha invocado). Previamente a que se hayan realizado llamadas es una lista vacía. El objeto @ref{19d7,,call} se puede utilizar para construir convenientemente las listas de llamadas a comparar con @ref{3ff8,,call_args_list}.

@example
>>> mock = Mock(return_value=None)
>>> mock()
>>> mock(3, 4)
>>> mock(key='fish', next='w00t!')
>>> mock.call_args_list
[call(), call(3, 4), call(key='fish', next='w00t!')]
>>> expected = [(), ((3, 4),), (@{'key': 'fish', 'next': 'w00t!'@},)]
>>> mock.call_args_list == expected
True
@end example

Los miembros de @ref{3ff8,,call_args_list} son objetos @ref{19d7,,call}. Estos pueden ser desempaquetados como tuplas para acceder a los argumentos individuales. Consultar @ref{3ff9,,objetos call como tuplas} para más información.
@end deffn

@geindex method_calls (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock method_calls}@anchor{3ff2}
@deffn {Atributo} method_calls

Igual que realizan un seguimiento de las llamadas hechas a sí mismos, los objetos simulados también realizan un seguimiento a `sus' métodos y atributos, así como de las llamadas hechas a los mismos:

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.property.method.attribute()
<Mock name='mock.property.method.attribute()' id='...'>
>>> mock.method_calls
[call.method(), call.property.method.attribute()]
@end example

Los miembros de @ref{3ff2,,method_calls} son objetos @ref{19d7,,call}. Estos pueden ser desempaquetados como tuplas para acceder a los atributos individuales. Consultar @ref{3ff9,,objetos call como tuplas} para más información.
@end deffn

@geindex mock_calls (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock mock_calls}@anchor{3ff0}
@deffn {Atributo} mock_calls

@ref{3ff0,,mock_calls} registra `todas' las llamadas al objeto simulado, sus métodos, métodos mágicos `y' objetos simulados del valor de retorno.

@example
>>> mock = MagicMock()
>>> result = mock(1, 2, 3)
>>> mock.first(a=3)
<MagicMock name='mock.first()' id='...'>
>>> mock.second()
<MagicMock name='mock.second()' id='...'>
>>> int(mock)
1
>>> result(1)
<MagicMock name='mock()()' id='...'>
>>> expected = [call(1, 2, 3), call.first(a=3), call.second(),
... call.__int__(), call()(1)]
>>> mock.mock_calls == expected
True
@end example

Los miembros de @ref{3ff0,,mock_calls} son objetos @ref{19d7,,call}. Estos pueden ser desempaquetados como tuplas para acceder a los argumentos individuales. Consultar @ref{3ff9,,objetos call como tuplas} para más información.

@cartouche
@quotation Nota 
La forma como se registra el atributo @ref{3ff0,,mock_calls} implica que cuando se realizan llamadas anidadas, los parámetros de las llamadas previas no se registran, por lo que siempre resultan iguales al comparar:

@example
>>> mock = MagicMock()
>>> mock.top(a=3).bottom()
<MagicMock name='mock.top().bottom()' id='...'>
>>> mock.mock_calls
[call.top(a=3), call.top().bottom()]
>>> mock.mock_calls[-1] == call.top(a=-1).bottom()
True
@end example
@end quotation
@end cartouche
@end deffn

@geindex __class__ (atributo de unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock __class__}@anchor{3ffa}
@deffn {Atributo} __class__

Normally the @code{__class__} attribute of an object will return its type.
For a mock object with a @code{spec}, @code{__class__} returns the spec class
instead. This allows mock objects to pass @ref{4ef,,isinstance()} tests for the
object they are replacing / masquerading as:

@example
>>> mock = Mock(spec=3)
>>> isinstance(mock, int)
True
@end example

@code{__class__} is assignable to, this allows a mock to pass an
@ref{4ef,,isinstance()} check without forcing you to use a spec:

@example
>>> mock = Mock()
>>> mock.__class__ = dict
>>> isinstance(mock, dict)
True
@end example
@end deffn
@end deffn

@geindex NonCallableMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock NonCallableMock}@anchor{3fe9}
@deffn {Clase} unittest.mock.NonCallableMock (spec=None, wraps=None, name=None, spec_set=None, **kwargs)

Una versión no invocable de @ref{ade,,Mock}. Los parámetros del constructor tienen el mismo significado que en @ref{ade,,Mock}, con la excepción de `return_value' y `side_effect' que no tienen sentido en un objeto simulado no invocable.
@end deffn

Mock objects that use a class or an instance as a @code{spec} or
@code{spec_set} are able to pass @ref{4ef,,isinstance()} tests:

@example
>>> mock = Mock(spec=SomeClass)
>>> isinstance(mock, SomeClass)
True
>>> mock = Mock(spec_set=SomeClass())
>>> isinstance(mock, SomeClass)
True
@end example

Las clases @ref{ade,,Mock} tienen soporte para simular los métodos mágicos. Consultar la sección dedicada a los @ref{3fe6,,métodos mágicos} para ver los detalles.

Las clases simuladas y los decoradores @ref{f13,,patch()} aceptan todas argumentos por palabra clave arbitrarios para la configuración. En los decoradores @ref{f13,,patch()} los argumentos por palabra clave se pasan al constructor del objeto simulado creado. Estos argumentos se usan para configurar los atributos del propio objeto simulado:

@example
>>> m = MagicMock(attribute=3, other='fish')
>>> m.attribute
3
>>> m.other
'fish'
@end example

Tanto el valor de retorno como el efecto colateral del objeto simulado pueden ser establecidos de la misma manera, mediante notación de punto. En cambio, si se quieren establecer mediante el constructor, dado que no se puede utilizar notación de punto directamente en una llamada, se tiene que crear un diccionario y desempaquetarlo usando @code{**}:

@example
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

Un objeto simulado invocable que fue creado con un `spec' (o un `spec_set') introspeccionará la firma del objeto de la especificación en el momento de emparejar las llamadas al objeto simulado. Esto le permite hacer coincidir sus argumentos con los argumentos de la llamada real, independientemente de si se pasaron por posición o por nombre:

@example
>>> def f(a, b, c): pass
...
>>> mock = Mock(spec=f)
>>> mock(1, 2, c=3)
<Mock name='mock()' id='140161580456576'>
>>> mock.assert_called_with(1, 2, 3)
>>> mock.assert_called_with(a=1, b=2, c=3)
@end example

Esto se aplica a @ref{1a28,,assert_called_with()}, @ref{3fee,,assert_called_once_with()}, @ref{16b2,,assert_has_calls()} y @ref{3fef,,assert_any_call()}. Cuando se hace uso de @ref{3fe7,,Autoespecificación}, también se aplicará a las llamadas a los métodos del objeto simulado.


Distinto en la versión 3.4: Se añadió introspección de firma en objetos simulados especificados y autoespecificados.


@geindex PropertyMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock PropertyMock}@anchor{3ffb}
@deffn {Clase} unittest.mock.PropertyMock (*args, **kwargs)

A mock intended to be used as a @ref{2fd,,property}, or other
@ref{1f70,,descriptor}, on a class. @ref{3ffb,,PropertyMock} provides
@ref{1527,,__get__()} and @ref{1f69,,__set__()} methods
so you can specify a return value when it is fetched.

La obtención de una instancia @ref{3ffb,,PropertyMock} desde un objeto ocasiona una llamada al objeto simulado, sin argumentos. Establecer su valor también llama al objeto simulado, con el valor a establecer como argumento.

@example
>>> class Foo:
...     @@property
...     def foo(self):
...         return 'something'
...     @@foo.setter
...     def foo(self, value):
...         pass
...
>>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo:
...     mock_foo.return_value = 'mockity-mock'
...     this_foo = Foo()
...     print(this_foo.foo)
...     this_foo.foo = 6
...
mockity-mock
>>> mock_foo.mock_calls
[call(), call(6)]
@end example
@end deffn

Debido a la forma en que se almacenan los atributos simulados, no es posible conectar directamente un @ref{3ffb,,PropertyMock} a un objeto simulado. En su lugar se puede conectar al tipo (type) del objeto simulado:

@example
>>> m = MagicMock()
>>> p = PropertyMock(return_value=3)
>>> type(m).foo = p
>>> m.foo
3
>>> p.assert_called_once_with()
@end example

@cartouche
@quotation Prudencia 
If an @ref{441,,AttributeError} is raised by @ref{3ffb,,PropertyMock},
it will be interpreted as a missing descriptor and
@ref{57a,,__getattr__()} will be called on the parent mock:

@example
>>> m = MagicMock()
>>> no_attribute = PropertyMock(side_effect=AttributeError)
>>> type(m).my_property = no_attribute
>>> m.my_property
<MagicMock name='mock.my_property' id='140165240345424'>
@end example

See @ref{57a,,__getattr__()} for details.
@end quotation
@end cartouche

@geindex AsyncMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock AsyncMock}@anchor{add}
@deffn {Clase} unittest.mock.AsyncMock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

Una versión asíncrona de @ref{ade,,Mock}. El objeto @ref{add,,AsyncMock} se comportará de tal modo que el objeto es reconocido como una función asíncrona y el resultado de su llamada es un objeto aguardable (awaitable).

@example
>>> mock = AsyncMock()
>>> inspect.iscoroutinefunction(mock)
True
>>> inspect.isawaitable(mock())  
True
@end example

El resultado de @code{mock()} es una función asíncrona que proporcionará el resultado de @code{side_effect} o de @code{return_value} después de haber sido aguardada:


@itemize -

@item 
si @code{side_effect} es una función, la función asíncrona retornará el resultado de esa función,

@item 
si @code{side_effect} es una excepción, la función asíncrona lanzará la excepción,

@item 
si @code{side_effect} es un iterable, la función asíncrona retornará el siguiente valor del iterable, sin embargo, si se agota la secuencia de resultados, se lanza una excepción @code{StopAsyncIteration} inmediatamente,

@item 
si @code{side_effect} no está definido, la función asíncrona retornará el valor definido por @code{return_value}, por lo tanto, la función asíncrona retorna un nuevo objeto @ref{add,,AsyncMock} por defecto.
@end itemize

Establecer el argumento `spec' de un objeto @ref{ade,,Mock} o @ref{f12,,MagicMock} en una función asíncrona resultará en que un objeto corrutina será retornado después de la llamada al objeto.

@example
>>> async def async_func(): pass
...
>>> mock = MagicMock(async_func)
>>> mock
<MagicMock spec='function' id='...'>
>>> mock()  
<coroutine object AsyncMockMixin._mock_call at ...>
@end example

Establecer el argumento `spec' de un objeto @ref{ade,,Mock}, @ref{f12,,MagicMock} o @ref{add,,AsyncMock} en una clase que tiene simultáneamente funciones asíncronas y síncronas hará que se detecten automáticamente las funciones sincrónicas y las establecerá como @ref{f12,,MagicMock} (si el objeto simulado padre es @ref{add,,AsyncMock} o @ref{f12,,MagicMock}) o @ref{ade,,Mock} (si el objeto simulado padre es @ref{ade,,Mock}) . Todas las funciones asíncronas serán @ref{add,,AsyncMock}.

@example
>>> class ExampleClass:
...     def sync_foo():
...         pass
...     async def async_foo():
...         pass
...
>>> a_mock = AsyncMock(ExampleClass)
>>> a_mock.sync_foo
<MagicMock name='mock.sync_foo' id='...'>
>>> a_mock.async_foo
<AsyncMock name='mock.async_foo' id='...'>
>>> mock = Mock(ExampleClass)
>>> mock.sync_foo
<Mock name='mock.sync_foo' id='...'>
>>> mock.async_foo
<AsyncMock name='mock.async_foo' id='...'>
@end example


Added in version 3.8.


@geindex assert_awaited() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited}@anchor{3ffc}
@deffn {Método} assert_awaited ()

Assert si el objeto simulado fue aguardado al menos una vez. Ten en cuenta que, independientemente del objeto que ha sido invocado, la palabra clave @code{await} debe ser utilizada:

@example
>>> mock = AsyncMock()
>>> async def main(coroutine_mock):
...     await coroutine_mock
...
>>> coroutine_mock = mock()
>>> mock.called
True
>>> mock.assert_awaited()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited.
>>> asyncio.run(main(coroutine_mock))
>>> mock.assert_awaited()
@end example
@end deffn

@geindex assert_awaited_once() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once}@anchor{3ffd}
@deffn {Método} assert_awaited_once ()

Assert si el objeto simulado fue aguardado exactamente una vez.

@example
>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.assert_awaited_once()
>>> asyncio.run(main())
>>> mock.assert_awaited_once()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited once. Awaited 2 times.
@end example
@end deffn

@geindex assert_awaited_with() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_with}@anchor{3ffe}
@deffn {Método} assert_awaited_with (*args, **kwargs)

Assert si el último aguardo (await) fue con los argumentos especificados.

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_with('foo', bar='bar')
>>> mock.assert_awaited_with('other')
Traceback (most recent call last):
...
AssertionError: expected await not found.
Expected: mock('other')
Actual: mock('foo', bar='bar')
@end example
@end deffn

@geindex assert_awaited_once_with() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once_with}@anchor{3fff}
@deffn {Método} assert_awaited_once_with (*args, **kwargs)

Assert si que el objeto simulado se ha aguardado exactamente una vez y con los argumentos especificados.

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_once_with('foo', bar='bar')
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_once_with('foo', bar='bar')
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited once. Awaited 2 times.
@end example
@end deffn

@geindex assert_any_await() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_any_await}@anchor{4000}
@deffn {Método} assert_any_await (*args, **kwargs)

Assert si el objeto simulado nunca se ha aguardado con los argumentos especificados.

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> asyncio.run(main('hello'))
>>> mock.assert_any_await('foo', bar='bar')
>>> mock.assert_any_await('other')
Traceback (most recent call last):
...
AssertionError: mock('other') await not found
@end example
@end deffn

@geindex assert_has_awaits() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_has_awaits}@anchor{4001}
@deffn {Método} assert_has_awaits (calls, any_order=False)

Assert si el objeto simulado ha sido aguardado con las llamadas especificadas. Para comprobar los aguardos (awaits) se utiliza la lista @ref{1988,,await_args_list}.

Si `any_order' es falso, los aguardos (awaits) deben ser secuenciales. No puede haber llamadas adicionales antes o después de los aguardos especificados.

Si `any_order' es verdadero, entonces los aguardos (awaits) pueden estar en cualquier orden, pero deben aparecer todos en @ref{1988,,await_args_list}.

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> calls = [call("foo"), call("bar")]
>>> mock.assert_has_awaits(calls)
Traceback (most recent call last):
...
AssertionError: Awaits not found.
Expected: [call('foo'), call('bar')]
Actual: []
>>> asyncio.run(main('foo'))
>>> asyncio.run(main('bar'))
>>> mock.assert_has_awaits(calls)
@end example
@end deffn

@geindex assert_not_awaited() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_not_awaited}@anchor{4002}
@deffn {Método} assert_not_awaited ()

Assert si el objeto simulado nunca ha sido aguardado.

@example
>>> mock = AsyncMock()
>>> mock.assert_not_awaited()
@end example
@end deffn

@geindex reset_mock() (método de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock reset_mock}@anchor{4003}
@deffn {Método} reset_mock (*args, **kwargs)

Consultar @ref{d81,,Mock.reset_mock()}. Además, también establece @ref{4004,,await_count} a 0, @ref{4005,,await_args} a None y borra @ref{1988,,await_args_list}.
@end deffn

@geindex await_count (atributo de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_count}@anchor{4004}
@deffn {Atributo} await_count

Un registro entero de cuántas veces se ha aguardado el objeto simulado.

@example
>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.await_count
1
>>> asyncio.run(main())
>>> mock.await_count
2
@end example
@end deffn

@geindex await_args (atributo de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_args}@anchor{4005}
@deffn {Atributo} await_args

Este atributo es @code{None} (si el objeto simulado no se ha aguardado) o los argumentos con los que fue aguardado la última vez. Su funcionamiento es idéntico al de @ref{1989,,Mock.call_args}.

@example
>>> mock = AsyncMock()
>>> async def main(*args):
...     await mock(*args)
...
>>> mock.await_args
>>> asyncio.run(main('foo'))
>>> mock.await_args
call('foo')
>>> asyncio.run(main('bar'))
>>> mock.await_args
call('bar')
@end example
@end deffn

@geindex await_args_list (atributo de unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_args_list}@anchor{1988}
@deffn {Atributo} await_args_list

Es una lista de todas los aguardos (awaits) realizados en el objeto simulado de forma secuencial (por lo que la longitud de la lista es el número de veces que se ha aguardado el objeto). Si no se han realizado aguardos previos, es una lista vacía.

@example
>>> mock = AsyncMock()
>>> async def main(*args):
...     await mock(*args)
...
>>> mock.await_args_list
[]
>>> asyncio.run(main('foo'))
>>> mock.await_args_list
[call('foo')]
>>> asyncio.run(main('bar'))
>>> mock.await_args_list
[call('foo'), call('bar')]
@end example
@end deffn
@end deffn

@geindex ThreadingMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock ThreadingMock}@anchor{4006}
@deffn {Clase} unittest.mock.ThreadingMock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, *, timeout=UNSET, **kwargs)

A version of @ref{f12,,MagicMock} for multithreading tests. The
@ref{4006,,ThreadingMock} object provides extra methods to wait for a call to
be invoked, rather than assert on it immediately.

The default timeout is specified by the @code{timeout} argument, or if unset by the
@ref{4007,,ThreadingMock.DEFAULT_TIMEOUT} attribute, which defaults to blocking (@code{None}).

You can configure the global default timeout by setting @ref{4007,,ThreadingMock.DEFAULT_TIMEOUT}.

@geindex wait_until_called() (método de unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_called}@anchor{4008}
@deffn {Método} wait_until_called (*, timeout=UNSET)

Waits until the mock is called.

If a timeout was passed at the creation of the mock or if a timeout
argument is passed to this function, the function raises an
@ref{74a,,AssertionError} if the call is not performed in time.

@example
>>> mock = ThreadingMock()
>>> thread = threading.Thread(target=mock)
>>> thread.start()
>>> mock.wait_until_called(timeout=1)
>>> thread.join()
@end example
@end deffn

@geindex wait_until_any_call_with() (método de unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_any_call_with}@anchor{4009}
@deffn {Método} wait_until_any_call_with (*args, **kwargs)

Waits until the mock is called with the specified arguments.

If a timeout was passed at the creation of the mock
the function raises an @ref{74a,,AssertionError} if the call is not performed in time.

@example
>>> mock = ThreadingMock()
>>> thread = threading.Thread(target=mock, args=("arg1", "arg2",), kwargs=@{"arg": "thing"@})
>>> thread.start()
>>> mock.wait_until_any_call_with("arg1", "arg2", arg="thing")
>>> thread.join()
@end example
@end deffn

@geindex DEFAULT_TIMEOUT (atributo de unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock DEFAULT_TIMEOUT}@anchor{4007}
@deffn {Atributo} DEFAULT_TIMEOUT

Global default timeout in seconds to create instances of @ref{4006,,ThreadingMock}.
@end deffn


Added in version 3.13.

@end deffn

@menu
* Llamar a los objetos simulados:: 
* Eliminar atributos:: 
* Los nombres de los objetos simulados y el atributo name:: 
* Adjuntar objetos simulados como atributos:: 

@end menu

@node Llamar a los objetos simulados,Eliminar atributos,,La clase Mock
@anchor{library/unittest mock calling}@anchor{400a}
@subsubsection Llamar a los objetos simulados


Los objetos Mock son invocables. La llamada a uno retornará el valor establecido en el atributo @ref{3fec,,return_value}. El valor de retorno por defecto es un nuevo objeto Mock, el cual se crea la primera vez que se accede al valor de retorno (ya sea explícitamente o llamando al objeto Mock). Una vez creado, se almacena y el mismo objeto es retornado cada vez que se solicita.

Las llamadas realizadas al objeto serán registradas en los atributos @ref{1989,,call_args} y @ref{3ff8,,call_args_list}.

If @ref{3fe4,,side_effect} is set then it will be called after the call has
been recorded, so if @code{side_effect} raises an exception the call is still
recorded.

La forma más sencilla de hacer que un objeto simulado lance de una excepción cuando sea invocado es establecer su atributo @ref{3fe4,,side_effect} como una clase o instancia de excepción:

@example
>>> m = MagicMock(side_effect=IndexError)
>>> m(1, 2, 3)
Traceback (most recent call last):
  ...
IndexError
>>> m.mock_calls
[call(1, 2, 3)]
>>> m.side_effect = KeyError('Bang!')
>>> m('two', 'three', 'four')
Traceback (most recent call last):
  ...
KeyError: 'Bang!'
>>> m.mock_calls
[call(1, 2, 3), call('two', 'three', 'four')]
@end example

If @ref{3fe4,,side_effect} is a function then whatever that function returns is what
calls to the mock return. The @code{side_effect} function is called with the
same arguments as the mock. This allows you to vary the return value of the
call dynamically, based on the input:

@example
>>> def side_effect(value):
...     return value + 1
...
>>> m = MagicMock(side_effect=side_effect)
>>> m(1)
2
>>> m(2)
3
>>> m.mock_calls
[call(1), call(2)]
@end example

If you want the mock to still return the default return value (a new mock), or
any set return value, then there are two ways of doing this. Either return
@ref{3fec,,return_value} from inside @ref{3fe4,,side_effect}, or return @ref{3feb,,DEFAULT}:

@example
>>> m = MagicMock()
>>> def side_effect(*args, **kwargs):
...     return m.return_value
...
>>> m.side_effect = side_effect
>>> m.return_value = 3
>>> m()
3
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> m.side_effect = side_effect
>>> m()
3
@end example

To remove a @ref{3fe4,,side_effect}, and return to the default behaviour, set the
@code{side_effect} to @code{None}:

@example
>>> m = MagicMock(return_value=6)
>>> def side_effect(*args, **kwargs):
...     return 3
...
>>> m.side_effect = side_effect
>>> m()
3
>>> m.side_effect = None
>>> m()
6
@end example

The @ref{3fe4,,side_effect} can also be any iterable object. Repeated calls to the mock
will return values from the iterable (until the iterable is exhausted and
a @ref{c82,,StopIteration} is raised):

@example
>>> m = MagicMock(side_effect=[1, 2, 3])
>>> m()
1
>>> m()
2
>>> m()
3
>>> m()
Traceback (most recent call last):
  ...
StopIteration
@end example

Si cualquier miembro del iterable es una excepción, se lanzará en lugar de retornarse:

@example
>>> iterable = (33, ValueError, 66)
>>> m = MagicMock(side_effect=iterable)
>>> m()
33
>>> m()
Traceback (most recent call last):
 ...
ValueError
>>> m()
66
@end example

@node Eliminar atributos,Los nombres de los objetos simulados y el atributo name,Llamar a los objetos simulados,La clase Mock
@anchor{library/unittest mock deleting-attributes}@anchor{400b}@anchor{library/unittest mock id2}@anchor{400c}
@subsubsection Eliminar atributos


Los objetos simulados crean atributos en demanda. Esto les permite hacerse pasar por objetos de cualquier tipo.

You may want a mock object to return @code{False} to a @ref{579,,hasattr()} call, or raise an
@ref{441,,AttributeError} when an attribute is fetched. You can do this by providing
an object as a @code{spec} for a mock, but that isn’t always convenient.

Puedes «bloquear» atributos eliminándolos. Una vez eliminado, el acceso a un atributo lanzará una excepción @ref{441,,AttributeError}.

@example
>>> mock = MagicMock()
>>> hasattr(mock, 'm')
True
>>> del mock.m
>>> hasattr(mock, 'm')
False
>>> del mock.f
>>> mock.f
Traceback (most recent call last):
    ...
AttributeError: f
@end example

@node Los nombres de los objetos simulados y el atributo name,Adjuntar objetos simulados como atributos,Eliminar atributos,La clase Mock
@anchor{library/unittest mock mock-names-and-the-name-attribute}@anchor{400d}
@subsubsection Los nombres de los objetos simulados y el atributo `name'


Dado que «name» es un argumento para el constructor de la clase @ref{ade,,Mock}, si quieres que tu objeto simulado tenga un atributo «name», no puedes simplemente pasarlo al constructor en tiempo de creación. Hay dos alternativas. Una opción es usar el método @ref{3fed,,configure_mock()}:

@example
>>> mock = MagicMock()
>>> mock.configure_mock(name='my_name')
>>> mock.name
'my_name'
@end example

Una opción más sencilla es simplemente establecer el atributo «name» después de la creación del objeto simulado:

@example
>>> mock = MagicMock()
>>> mock.name = "foo"
@end example

@node Adjuntar objetos simulados como atributos,,Los nombres de los objetos simulados y el atributo name,La clase Mock
@anchor{library/unittest mock attaching-mocks-as-attributes}@anchor{400e}
@subsubsection Adjuntar objetos simulados como atributos


Cuando se adjunta un objeto simulado como un atributo de otro objeto simulado (o como su valor de retorno) se convierte en un «hijo» del mismo. Las llamadas a los hijos se registran en los atributos @ref{3ff2,,method_calls} y @ref{3ff0,,mock_calls} del padre. Esto es útil para configurar objetos simulados hijos para después adjuntarlos al padre, o para adjuntar objetos simulados a un padre que se encargará de registrar todas las llamadas a los hijos, permitiéndote hacer aserciones sobre el orden de las llamadas entre objetos simulados:

@example
>>> parent = MagicMock()
>>> child1 = MagicMock(return_value=None)
>>> child2 = MagicMock(return_value=None)
>>> parent.child1 = child1
>>> parent.child2 = child2
>>> child1(1)
>>> child2(2)
>>> parent.mock_calls
[call.child1(1), call.child2(2)]
@end example

La excepción a lo anterior es si el objeto simulado tiene un nombre. Esto te permite evitar el comportamiento de «parentesco» explicado previamente, si por alguna razón no deseas que suceda.

@example
>>> mock = MagicMock()
>>> not_a_child = MagicMock(name='not-a-child')
>>> mock.attribute = not_a_child
>>> mock.attribute()
<MagicMock name='not-a-child()' id='...'>
>>> mock.mock_calls
[]
@end example

Los objetos simulados creados automáticamente por la función @ref{f13,,patch()} también reciben nombres automáticamente. Para adjuntar un objeto simulado con nombre a un padre debes utilizar el método @ref{15f1,,attach_mock()}:

@example
>>> thing1 = object()
>>> thing2 = object()
>>> parent = MagicMock()
>>> with patch('__main__.thing1', return_value=None) as child1:
...     with patch('__main__.thing2', return_value=None) as child2:
...         parent.attach_mock(child1, 'child1')
...         parent.attach_mock(child2, 'child2')
...         child1('one')
...         child2('two')
...
>>> parent.mock_calls
[call.child1('one'), call.child2('two')]
@end example

@node Parcheadores,MagicMock y el soporte de métodos mágicos,La clase Mock,unittest mock — mock object library
@anchor{library/unittest mock the-patchers}@anchor{400f}
@subsubsection Parcheadores


Los decoradores patch se utilizan para parchear los objetos solo dentro del ámbito de la función que decoran. Se encargan automáticamente de desparchear una vez terminada la prueba, incluso si se lanzan excepciones. Todas estas funciones también se pueden utilizar con declaraciones o como decoradores de clase.

@menu
* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* métodos start y stop de patch:: 
* parchear objetos incorporados (builtins): parchear objetos incorporados builtins. 
* TEST_PREFIX:: 
* Anidando decoradores patch:: 
* Dónde parchear:: 
* Parcheando descriptores y objetos proxy:: 

@end menu

@node patch,patch object,,Parcheadores
@anchor{library/unittest mock patch}@anchor{4010}
@subsubsection patch


@cartouche
@quotation Nota 
La clave es realizar el parche en el mismo espacio de nombre. Para más detalles consultar la sección @ref{4011,,where to patch}.
@end quotation
@end cartouche

@geindex patch() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch}@anchor{f13}
@deffn {Función} unittest.mock.patch (target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

@ref{f13,,patch()} actúa como decorador de función, decorador de clase o como gestor de contexto. Ya sea en el interior del cuerpo de una función o dentro de una declaración with, `target' es parcheado con un objeto `new'. Cuando la función / declaración with termina su ejecución el parche se deshace automáticamente.

Si se omite `new', entonces el objetivo se reemplaza por un objeto @ref{add,,AsyncMock} si el objeto parcheado es una función asíncrona, o con un objeto @ref{f12,,MagicMock} en caso contrario. Si se utiliza @ref{f13,,patch()} como decorador y se omite `new', el objeto simulado creado se pasa como un argumento adicional a la función decorada. Si se utiliza @ref{f13,,patch()} como un gestor de contexto, el objeto simulado creado es retornado por el gestor de contexto.

`target' debe ser una cadena de la forma @code{'paquete.modulo.NombreDeLaClase'}. `target' es importado y el objeto especificado reemplazado por el objeto `new', por lo que `target' debe ser importable desde el entorno desde el cual estás llamando a @ref{f13,,patch()}. Hay que tener presente que `target' es importado cuando se ejecuta la función decorada, no en tiempo de decoración.

Los argumentos `spec' y `spec_set' se pasan a @ref{f12,,MagicMock} si patch está creando automáticamente uno para ti.

Además, puedes pasar @code{spec=True} o @code{spec_set=True}, lo que causa que patch pase el objeto que está siendo simulado como el objeto spec/spec_set.

`new_callable' te permite especificar una clase diferente, o un objeto invocable, que será invocada para crear el objeto `new'. Por defecto se utiliza @ref{add,,AsyncMock} para las funciones asíncronas y @ref{f12,,MagicMock} para el resto.

Una variante más poderosa de `spec' es `autospec'. Si estableces @code{autospec=True} el objeto simulado se creará con una especificación del objeto que está siendo reemplazado. Todos los atributos del objeto simulado también tendrán la especificación del atributo correspondiente del objeto que está siendo reemplazado. Los argumentos de los métodos y funciones simulados son comprobados y se lanzará una excepción @ref{228,,TypeError} si se les llama con la firma incorrecta. Para los objetos simulados que sustituyen a una clase, su valor de retorno (la “instancia”) tendrá la misma especificación que la clase. Consultar la función @ref{15c9,,create_autospec()} y @ref{3fe7,,Autoespecificación} para más detalles.

En lugar de @code{autospec=True}, puedes pasar @code{autospec=some_object} para utilizar un objeto arbitrario como especificación en lugar del objeto reemplazado.

Por defecto, @ref{f13,,patch()} fallará al intentar reemplazar atributos que no existen. Si pasas @code{create=True} y no existe el atributo, patch crea el atributo cuando la función se llama y lo elimina de nuevo en cuanto termina de ejecutarse . Esto es útil para implementar pruebas para atributos que tu código de producción crea en tiempo de ejecución. Está desactivado por defecto, ya que puede ser peligroso. ¡Al activarlo se pueden implementar pruebas que validen APIs que en realidad no existen!

@cartouche
@quotation Nota 

Distinto en la versión 3.5: Si estás parcheando objetos incorporados (builtins) en un módulo, no es necesario pasar @code{create=True}, ya que en este caso se agrega de forma predeterminada.

@end quotation
@end cartouche

Patch can be used as a @ref{4fa,,TestCase} class decorator. It works by
decorating each test method in the class. This reduces the boilerplate
code when your test methods share a common patchings set. @ref{f13,,patch()} finds
tests by looking for method names that start with @code{patch.TEST_PREFIX}.
By default this is @code{'test'}, which matches the way @ref{106,,unittest} finds tests.
You can specify an alternative prefix by setting @code{patch.TEST_PREFIX}.

Patch puede ser usado como un gestor de contexto, con la declaración with. En este caso el parcheo se aplica al bloque sangrado inmediatamente después de la declaración with. Si utilizas «as», el objeto parcheado será enlazado al nombre especificado después de «as»; muy útil si @ref{f13,,patch()} está creando un objeto simulado automáticamente.

@ref{f13,,patch()} toma argumentos por palabra clave arbitrarios. Estos serán pasados a @ref{add,,AsyncMock} si el objeto parcheado es asincrónico, si es de otra forma @ref{f12,,MagicMock} o a un `new_callable' si es especificado.

@code{patch.dict(...)}, @code{patch.multiple(...)} y @code{patch.object(...)} están disponibles para casos de uso alternativos.
@end deffn

@ref{f13,,patch()} como decorador de función, crea el objeto simulado por ti y lo pasa a la función decorada:

@example
>>> @@patch('__main__.SomeClass')
... def function(normal_argument, mock_class):
...     print(mock_class is SomeClass)
...
>>> function(None)
True
@end example

Parchear una clase sustituye a la clase por una `instancia' de @ref{f12,,MagicMock}. Si la clase se instancia en el código bajo prueba, el atributo @ref{3fec,,return_value} del objeto simulado será el utilizado.

Si la clase se instancia en múltiples ocasiones, puedes utilizar el atributo @ref{3fe4,,side_effect} para retornar un nuevo objeto simulado cada vez. O también puedes establecer `return_value' para que sea lo que tu quieras.

To configure return values on methods of `instances' on the patched class
you must do this on the @ref{3fec,,return_value}. For example:

@example
>>> class Class:
...     def method(self):
...         pass
...
>>> with patch('__main__.Class') as MockClass:
...     instance = MockClass.return_value
...     instance.method.return_value = 'foo'
...     assert Class() is instance
...     assert Class().method() == 'foo'
...
@end example

Si utilizas `spec' o `spec_set' y @ref{f13,,patch()} está reemplazando una `clase', el valor de retorno del objeto simulado creado tendrá las mismas especificaciones:

@example
>>> Original = Class
>>> patcher = patch('__main__.Class', spec=True)
>>> MockClass = patcher.start()
>>> instance = MockClass()
>>> assert isinstance(instance, Original)
>>> patcher.stop()
@end example

El argumento `new_callable' es útil cuando deseas utilizar una clase por defecto alternativa a @ref{f12,,MagicMock} para el objeto simulado creado. Por ejemplo, si quieres que se use una clase @ref{3fe9,,NonCallableMock} por defecto:

@example
>>> thing = object()
>>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing:
...     assert thing is mock_thing
...     thing()
...
Traceback (most recent call last):
  ...
TypeError: 'NonCallableMock' object is not callable
@end example

Otro caso de uso podría ser la sustitución de un objeto por una instancia de @ref{fa9,,io.StringIO}:

@example
>>> from io import StringIO
>>> def foo():
...     print('Something')
...
>>> @@patch('sys.stdout', new_callable=StringIO)
... def test(mock_stdout):
...     foo()
...     assert mock_stdout.getvalue() == 'Something\n'
...
>>> test()
@end example

Cuando @ref{f13,,patch()} crea un objeto simulado para ti, a menudo lo primero que tienes que hacer es configurar el objeto simulado recién creado. Parte de la configuración se puede hacer en la propia llamada a patch. Cualquier palabra clave arbitraria que pases a la llamada será utilizada para establecer los atributos del objeto simulado creado:

@example
>>> patcher = patch('__main__.thing', first='one', second='two')
>>> mock_thing = patcher.start()
>>> mock_thing.first
'one'
>>> mock_thing.second
'two'
@end example

Los atributos de los objetos simulados hijos, como @ref{3fec,,return_value} y @ref{3fe4,,side_effect}, también puede ser configurados en la llamada, dado que los objetos simulados hijos son atributos en si mismos del objeto simulado padre creado. Eso si, estos no son sintácticamente válidos para ser pasados directamente como argumentos por palabras clave a la función patch, pero un diccionario con ellos como claves si que puede ser expandido en una llama a @ref{f13,,patch()} usando @code{**}:

@example
>>> config = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> patcher = patch('__main__.thing', **config)
>>> mock_thing = patcher.start()
>>> mock_thing.method()
3
>>> mock_thing.other()
Traceback (most recent call last):
  ...
KeyError
@end example

Por defecto, el intento de parchear una función en un módulo (o un método o atributo en una clase) que no existe fallará lanzando una excepción @ref{441,,AttributeError}:

@example
>>> @@patch('sys.non_existing_attribute', 42)
... def test():
...     assert sys.non_existing_attribute == 42
...
>>> test()
Traceback (most recent call last):
  ...
AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing_attribute'
@end example

pero añadir @code{create=True} en la llamada a @ref{f13,,patch()} hará que el ejemplo previo funcione como se esperaba:

@example
>>> @@patch('sys.non_existing_attribute', 42, create=True)
... def test(mock_stdout):
...     assert sys.non_existing_attribute == 42
...
>>> test()
@end example


Distinto en la versión 3.8: @ref{f13,,patch()} ahora retorna una instancia de @ref{add,,AsyncMock} si el objetivo es una función asíncrona.


@node patch object,patch dict,patch,Parcheadores
@anchor{library/unittest mock patch-object}@anchor{4012}
@subsubsection patch.object


@geindex patch.object() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch object}@anchor{1596}
@deffn {Función} patch.object (target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

parchea el miembro `attribute' invocado de un objeto `target' con un objeto simulado.

@ref{1596,,patch.object()} se puede utilizar como un decorador, decorador de clase o un gestor de contexto. Los argumentos `new', `spec', `create', `spec_set', `autospec' y `new_callable' tienen el mismo significado que en la función @ref{f13,,patch()}. Al igual que @ref{f13,,patch()}, @ref{1596,,patch.object()} toma argumentos por palabras clave arbitrarios para la configuración del objeto simulado que crea.

Cuando se utiliza como un decorador de clase @ref{1596,,patch.object()} se rige por @code{patch.TEST_PREFIX} a la hora de elegir los métodos a envolver.
@end deffn

Puedes llamar a @ref{1596,,patch.object()} con tres argumentos o con dos argumentos. La forma de tres argumento toma el objeto a parchear, el nombre del atributo y el objeto con el que reemplazar el atributo.

Al llamar usando la variante de dos argumento se omite el objeto de sustitución, por lo tanto se crea un objeto simulado automáticamente y se pasa como argumento adicional a la función decorada:

@example
>>> @@patch.object(SomeClass, 'class_method')
... def test(mock_method):
...     SomeClass.class_method(3)
...     mock_method.assert_called_with(3)
...
>>> test()
@end example

`spec', `create' y el resto de argumentos de @ref{1596,,patch.object()} tienen el mismo significado que en la función @ref{f13,,patch()}.

@node patch dict,patch multiple,patch object,Parcheadores
@anchor{library/unittest mock patch-dict}@anchor{4013}
@subsubsection patch.dict


@geindex patch.dict() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch dict}@anchor{1605}
@deffn {Función} patch.dict (in_dict, values=(), clear=False, **kwargs)

Patch a dictionary, or dictionary like object, and restore the dictionary
to its original state after the test, where the restored dictionary is a
copy of the dictionary as it was before the test.

`in_dict' puede ser un diccionario o un contenedor similar a uno. Si se trata de un objeto similar a un diccionario, debe soportar como mínimo el establecimiento, la obtención y la eliminación de elementos, además de permitir la iteración sobre las claves.

`in_dict' también puede ser una cadena que especifique el nombre del diccionario a parchear, el nombre es usado para obtener el diccionario mediante importación.

`values' puede ser otro diccionario con valores para ser añadidos al diccionario. `values' también puede ser un iterable de parejas @code{(clave, valor)}.

Si `clear' es verdadero, el contenido del diccionario se borrará antes de establecer los nuevos valores.

La función @ref{1605,,patch.dict()} también puede ser invocada con argumentos por palabra clave arbitrarios para establecer los valores en el diccionario.


Distinto en la versión 3.8: La función @ref{1605,,patch.dict()} ahora retorna el diccionario parcheado cuando se utiliza como gestor de contexto.

@end deffn

@ref{1605,,patch.dict()} se puede utilizar como gestor de contexto, decorador o decorador de clase:

@example
>>> foo = @{@}
>>> @@patch.dict(foo, @{'newkey': 'newvalue'@})
... def test():
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> test()
>>> assert foo == @{@}
@end example

Cuando se utiliza @ref{1605,,patch.dict()} como decorador de clase, se rige por @code{patch.TEST_PREFIX} (por defecto @code{'test'}) a la hora de elegir qué métodos envolver:

@example
>>> import os
>>> import unittest
>>> from unittest.mock import patch
>>> @@patch.dict('os.environ', @{'newkey': 'newvalue'@})
... class TestSample(unittest.TestCase):
...     def test_sample(self):
...         self.assertEqual(os.environ['newkey'], 'newvalue')
@end example

Si deseas utilizar un prefijo diferente para tu prueba, puede informar a los parcheadores del nuevo prefijo a usar estableciendo @code{patch.TEST_PREFIX}. Para más detalles sobre cómo cambiar el valor del atributo consultar @ref{4014,,TEST_PREFIX}.

@ref{1605,,patch.dict()} puede utilizarse para agregar miembros a un diccionario, o simplemente para dejar que una prueba modifique un diccionario y asegurarte de que el diccionario será restablecido cuando finalice la misma.

@example
>>> foo = @{@}
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}) as patched_foo:
...     assert foo == @{'newkey': 'newvalue'@}
...     assert patched_foo == @{'newkey': 'newvalue'@}
...     # You can add, update or delete keys of foo (or patched_foo, it's the same dict)
...     patched_foo['spam'] = 'eggs'
...
>>> assert foo == @{@}
>>> assert patched_foo == @{@}
@end example

@example
>>> import os
>>> with patch.dict('os.environ', @{'newkey': 'newvalue'@}):
...     print(os.environ['newkey'])
...
newvalue
>>> assert 'newkey' not in os.environ
@end example

Se pueden utilizar argumentos por palabra clave en la llamada a @ref{1605,,patch.dict()} para establecer valores en el diccionario:

@example
>>> mymodule = MagicMock()
>>> mymodule.function.return_value = 'fish'
>>> with patch.dict('sys.modules', mymodule=mymodule):
...     import mymodule
...     mymodule.function('some', 'args')
...
'fish'
@end example

@ref{1605,,patch.dict()} can be used with dictionary like objects that aren’t actually
dictionaries. At the very minimum they must support item getting, setting,
deleting and either iteration or membership test. This corresponds to the
magic methods @ref{3d8,,__getitem__()}, @ref{1505,,__setitem__()},
@ref{1506,,__delitem__()} and either @ref{1cc8,,__iter__()} or
@ref{1f5d,,__contains__()}.

@example
>>> class Container:
...     def __init__(self):
...         self.values = @{@}
...     def __getitem__(self, name):
...         return self.values[name]
...     def __setitem__(self, name, value):
...         self.values[name] = value
...     def __delitem__(self, name):
...         del self.values[name]
...     def __iter__(self):
...         return iter(self.values)
...
>>> thing = Container()
>>> thing['one'] = 1
>>> with patch.dict(thing, one=2, two=3):
...     assert thing['one'] == 2
...     assert thing['two'] == 3
...
>>> assert thing['one'] == 1
>>> assert list(thing) == ['one']
@end example

@node patch multiple,métodos start y stop de patch,patch dict,Parcheadores
@anchor{library/unittest mock patch-multiple}@anchor{4015}
@subsubsection patch.multiple


@geindex patch.multiple() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch multiple}@anchor{4016}
@deffn {Función} patch.multiple (target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

Realiza múltiples parches en una sola llamada. Se toma el objeto a ser parcheado (ya sea como un objeto o una cadena de caracteres con el nombre del mismo para obtener el objeto mediante importación) y los argumentos por palabras clave para los parches:

@example
with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...
@end example

Usa @ref{3feb,,DEFAULT} como valor si deseas que la función @ref{4016,,patch.multiple()} cree objetos simulados automáticamente por ti. En este caso, los objetos simulados creados son pasados a la función decorada mediante palabra clave y se retorna un diccionario cuando @ref{4016,,patch.multiple()} se utiliza como gestor de contexto.

La función @ref{4016,,patch.multiple()} se puede utilizar como un decorador, decorador de clase o como gestor de contexto. La argumentos `spec', `spec_set', `create', `autospec' y `new_callable' tienen el mismo significado que en la función @ref{f13,,patch()}. Estos argumentos se aplicarán a `todos' los parches realizados por @ref{4016,,patch.multiple()}.

Cuando se utiliza como decorador de clase, @ref{4016,,patch.multiple()} se rige por @code{patch.TEST_PREFIX} a la hora de elegir qué métodos envolver.
@end deffn

Si deseas que @ref{4016,,patch.multiple()} cree objetos simulados automáticamente por ti, puedes utilizar @ref{3feb,,DEFAULT} como valor. Si utilizas @ref{4016,,patch.multiple()} como decorador, entonces los objetos simulados creados se pasan a la función decorada por palabra clave:

@example
>>> thing = object()
>>> other = object()

>>> @@patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(thing, other):
...     assert isinstance(thing, MagicMock)
...     assert isinstance(other, MagicMock)
...
>>> test_function()
@end example

@ref{4016,,patch.multiple()} se puede anidar junto a otros decoradores @code{patch}, pero los argumentos pasados por palabra clave se deben agregar `después' de cualquier argumento estándar creado por @ref{f13,,patch()}:

@example
>>> @@patch('sys.exit')
... @@patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(mock_exit, other, thing):
...     assert 'other' in repr(other)
...     assert 'thing' in repr(thing)
...     assert 'exit' in repr(mock_exit)
...
>>> test_function()
@end example

Si @ref{4016,,patch.multiple()} se utiliza como un gestor de contexto, el valor retornado por el mismo es un diccionario en el que los objetos simulados creados son almacenados, usando sus nombres como claves:

@example
>>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values:
...     assert 'other' in repr(values['other'])
...     assert 'thing' in repr(values['thing'])
...     assert values['thing'] is thing
...     assert values['other'] is other
...
@end example

@node métodos start y stop de patch,parchear objetos incorporados builtins,patch multiple,Parcheadores
@anchor{library/unittest mock patch-methods-start-and-stop}@anchor{4017}@anchor{library/unittest mock start-and-stop}@anchor{4018}
@subsubsection métodos start y stop de patch


All the patchers have @code{start()} and @code{stop()} methods. These make it simpler to do
patching in @code{setUp} methods or where you want to do multiple patches without
nesting decorators or with statements.

To use them call @ref{f13,,patch()}, @ref{1596,,patch.object()} or @ref{1605,,patch.dict()} as
normal and keep a reference to the returned @code{patcher} object. You can then
call @code{start()} to put the patch in place and @code{stop()} to undo it.

Si estás utilizando @ref{f13,,patch()} para crear un objeto simulado automáticamente, este será retornado por la llamada a @code{patcher.start}:

@example
>>> patcher = patch('package.module.ClassName')
>>> from package import module
>>> original = module.ClassName
>>> new_mock = patcher.start()
>>> assert module.ClassName is not original
>>> assert module.ClassName is new_mock
>>> patcher.stop()
>>> assert module.ClassName is original
>>> assert module.ClassName is not new_mock
@end example

A typical use case for this might be for doing multiple patches in the @code{setUp}
method of a @ref{4fa,,TestCase}:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         self.patcher1 = patch('package.module.Class1')
...         self.patcher2 = patch('package.module.Class2')
...         self.MockClass1 = self.patcher1.start()
...         self.MockClass2 = self.patcher2.start()
...
...     def tearDown(self):
...         self.patcher1.stop()
...         self.patcher2.stop()
...
...     def test_something(self):
...         assert package.module.Class1 is self.MockClass1
...         assert package.module.Class2 is self.MockClass2
...
>>> MyTest('test_something').run()
@end example

@cartouche
@quotation Prudencia 
Si se utiliza esta técnica debes asegurarte de que el parcheo está «sin aplicar» llamando a @code{stop}. Esto puede ser más complicado de lo que parece, ya que si se produce una excepción en el @code{setUp} no se llama a @code{tearDown} a continuación. @ref{b0e,,unittest.TestCase.addCleanup()} hace que esto sea más fácil:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         patcher = patch('package.module.Class')
...         self.MockClass = patcher.start()
...         self.addCleanup(patcher.stop)
...
...     def test_something(self):
...         assert package.module.Class is self.MockClass
...
@end example

Como beneficio adicional, ya no es necesario mantener una referencia al objeto @code{patcher}.
@end quotation
@end cartouche

También es posible detener todos los parches que han sido iniciados usando @ref{4019,,patch.stopall()}.

@geindex patch.stopall() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch stopall}@anchor{4019}
@deffn {Función} patch.stopall ()

Detiene todos los parches activos. Solo se detienen parches iniciados con @code{start}.
@end deffn

@node parchear objetos incorporados builtins,TEST_PREFIX,métodos start y stop de patch,Parcheadores
@anchor{library/unittest mock id4}@anchor{401a}@anchor{library/unittest mock patch-builtins}@anchor{401b}
@subsubsection parchear objetos incorporados (builtins)


Puedes parchear cualquier objeto incorporado dentro de un módulo. El siguiente ejemplo parchea la función incorporada @ref{1eef,,ord()}:

@example
>>> @@patch('__main__.ord')
... def test(mock_ord):
...     mock_ord.return_value = 101
...     print(ord('c'))
...
>>> test()
101
@end example

@node TEST_PREFIX,Anidando decoradores patch,parchear objetos incorporados builtins,Parcheadores
@anchor{library/unittest mock id5}@anchor{401c}@anchor{library/unittest mock test-prefix}@anchor{4014}
@subsubsection TEST_PREFIX


Todos los parcheadores se puede utilizar como decoradores de clase. Cuando se usan de esta forma, todos los métodos a probar en la clase son envueltos. Los parcheadores reconocen los métodos que comienzan con @code{'test'} como métodos a probar. Esta es la misma forma que la clase @ref{3e2,,unittest.TestLoader} usa para encontrar métodos de prueba por defecto.

Cabe la posibilidad de que desees utilizar un prefijo diferente para las pruebas. Puedes informar a los parcheadores del cambio de prefijo estableciendo el atributo @code{patch.TEST_PREFIX}:

@example
>>> patch.TEST_PREFIX = 'foo'
>>> value = 3
>>>
>>> @@patch('__main__.value', 'not three')
... class Thing:
...     def foo_one(self):
...         print(value)
...     def foo_two(self):
...         print(value)
...
>>>
>>> Thing().foo_one()
not three
>>> Thing().foo_two()
not three
>>> value
3
@end example

@node Anidando decoradores patch,Dónde parchear,TEST_PREFIX,Parcheadores
@anchor{library/unittest mock nesting-patch-decorators}@anchor{401d}
@subsubsection Anidando decoradores patch


Si deseas aplicar múltiples parches, solo tienes que apilar los decoradores.

Puede apilar múltiples decoradores patch usando el siguiente patrón:

@example
>>> @@patch.object(SomeClass, 'class_method')
... @@patch.object(SomeClass, 'static_method')
... def test(mock1, mock2):
...     assert SomeClass.static_method is mock1
...     assert SomeClass.class_method is mock2
...     SomeClass.static_method('foo')
...     SomeClass.class_method('bar')
...     return mock1, mock2
...
>>> mock1, mock2 = test()
>>> mock1.assert_called_once_with('foo')
>>> mock2.assert_called_once_with('bar')
@end example

Ten en cuenta que los decoradores se aplican desde abajo hacia arriba. Esta es la manera estándar de Python para aplicar decoradores. El orden en el que los objetos simulados generados se pasan a la función de prueba coincide con este orden.

@node Dónde parchear,Parcheando descriptores y objetos proxy,Anidando decoradores patch,Parcheadores
@anchor{library/unittest mock id6}@anchor{4011}@anchor{library/unittest mock where-to-patch}@anchor{3fe5}
@subsubsection Dónde parchear


@ref{f13,,patch()} funciona cambiando (temporalmente) el objeto al que apunta `name' con otro. Puede haber muchos nombres apuntando a cualquier objeto individual, por lo que para que el parcheo funcione, debes asegurarte de parchear el nombre utilizado para el objeto por el sistema concreto bajo prueba.

El principio básico es parchear donde un objeto es `buscado', que no es necesariamente el mismo lugar donde está definido. Un par de ejemplos ayudarán a aclarar esto.

Imaginemos que tenemos un proyecto, que queremos probar, con la siguiente estructura:

@example
a.py
    -> Defines SomeClass

b.py
    -> from a import SomeClass
    -> some_function instantiates SomeClass
@end example

Ahora queremos probar @code{some_function}, pero queremos simular @code{SomeClass} utilizando @ref{f13,,patch()}. El problema es que cuando importamos el módulo b, lo cual tenemos que hacer obligatoriamente, se importa @code{SomeClass} del módulo a. Si utilizamos @ref{f13,,patch()} para simular @code{a.SomeClass}, no tendrá ningún efecto en nuestra prueba; el módulo b ya tiene una referencia a la @code{SomeClass} `real', por lo que parece que nuestro parcheo no tuvo ningún efecto.

La clave es parchear @code{SomeClass} donde se utiliza (o donde es buscado). En este caso @code{some_function} realmente va a buscar @code{SomeClass} en el módulo b, donde lo hemos importado. La aplicación de parches debe ser similar a:

@example
@@patch('b.SomeClass')
@end example

Sin embargo, ten en cuenta el escenario alternativo donde en el módulo b en lugar de @code{from a import SomeClass} se hace @code{import a} y @code{some_function} usa @code{a.SomeClass}. Ambas formas de importación son comunes. En este caso, la clase que queremos parchear está siendo buscada en el módulo, por lo que tenemos que parchear @code{a.SomeClass}:

@example
@@patch('a.SomeClass')
@end example

@node Parcheando descriptores y objetos proxy,,Dónde parchear,Parcheadores
@anchor{library/unittest mock patching-descriptors-and-proxy-objects}@anchor{401e}
@subsubsection Parcheando descriptores y objetos proxy


Tanto @ref{4010,,patch} como @ref{4012,,patch.object} parchean y restauran correctamente los descriptores: métodos de clase, métodos estáticos y propiedades. Debe parcharlos en el `class' en lugar de una instancia. También funcionan con objetos `some' que acceden a atributos de proxy, como django settings object@footnote{https://web.archive.org/web/20200603181648/http://www.voidspace.org.uk/python/weblog/arch_d7_2010_12_04.shtml#e1198}.

@node MagicMock y el soporte de métodos mágicos,Ayudantes,Parcheadores,unittest mock — mock object library
@anchor{library/unittest mock magicmock-and-magic-method-support}@anchor{401f}
@subsubsection MagicMock y el soporte de métodos mágicos


@menu
* Simular métodos mágicos:: 
* Magic Mock:: 

@end menu

@node Simular métodos mágicos,Magic Mock,,MagicMock y el soporte de métodos mágicos
@anchor{library/unittest mock magic-methods}@anchor{3fe6}@anchor{library/unittest mock mocking-magic-methods}@anchor{4020}
@subsubsection Simular métodos mágicos


@ref{ade,,Mock} supports mocking the Python protocol methods, also known as
@ref{4021,,«magic methods»}. This allows mock objects to replace
containers or other objects that implement Python protocols.

Dado que los métodos mágicos se buscan de manera diferente a los métodos normales @footnote{
Los métodos mágicos `deben' ser buscados en la clase en lugar de en la instancia. Diferentes versiones de Python son inconsistentes sobre la aplicación de esta regla. Los métodos de protocolo soportados deben trabajar con todas las versiones de Python.
}, este soporte ha sido especialmente implementado. Esto significa que solo es compatible con métodos mágicos específicos. La lista de métodos soportados incluye `casi' todos los existentes. Si hay alguno que falta y que consideras necesario, por favor háznoslo saber.

Puedes simular métodos mágicos estableciendo el método que te interesa en una función o en una instancia simulada. Si utilizas una función, `debe' aceptar @code{self} como primer argumento @footnote{
La función está básicamente conectada a la clase, pero cada instancia @code{Mock} se mantiene aislada de las demás.
}.

@example
>>> def __str__(self):
...     return 'fooble'
...
>>> mock = Mock()
>>> mock.__str__ = __str__
>>> str(mock)
'fooble'
@end example

@example
>>> mock = Mock()
>>> mock.__str__ = Mock()
>>> mock.__str__.return_value = 'fooble'
>>> str(mock)
'fooble'
@end example

@example
>>> mock = Mock()
>>> mock.__iter__ = Mock(return_value=iter([]))
>>> list(mock)
[]
@end example

Un caso de uso para esto es simular objetos usados como gestores de contexto en una declaración @ref{673,,with}:

@example
>>> mock = Mock()
>>> mock.__enter__ = Mock(return_value='foo')
>>> mock.__exit__ = Mock(return_value=False)
>>> with mock as m:
...     assert m == 'foo'
...
>>> mock.__enter__.assert_called_with()
>>> mock.__exit__.assert_called_with(None, None, None)
@end example

Las llamadas a métodos mágicos no aparecen registradas en @ref{3ff2,,method_calls}, aunque si se registran en @ref{3ff0,,mock_calls}.

@cartouche
@quotation Nota 
Si se utiliza el argumento por palabra clave `spec' para crear un objeto simulado, intentar después establecer un método mágico que no está en la especificación lanzará una excepción @ref{441,,AttributeError}.
@end quotation
@end cartouche

La lista completa de los métodos mágicos soportados es la siguiente:


@itemize *

@item 
@code{__hash__}, @code{__sizeof__}, @code{__repr__} y @code{__str__}

@item 
@code{__dir__}, @code{__format__} y @code{__subclasses__}

@item 
@code{__round__}, @code{__floor__}, @code{__trunc__} y @code{__ceil__}

@item 
Comparaciones: @code{__lt__}, @code{__gt__}, @code{__le__}, @code{__ge__}, @code{__eq__} y @code{__ne__}

@item 
Métodos de contenedores: @code{__getitem__}, @code{__setitem__}, @code{__delitem__}, @code{__contains__}, @code{__len__}, @code{__iter__}, @code{__reversed__} y @code{__missing__}

@item 
Administrador de contexto: @code{__enter__}, @code{__exit__}, @code{__aenter__} y @code{__aexit__}

@item 
Métodos numéricos unarios: @code{__neg__}, @code{__pos__} y @code{__invert__}

@item 
Los métodos numéricos (incluidas las variantes de mano derecha e in situ): @code{__add__}, @code{__sub__}, @code{__mul__}, @code{__matmul__}, @code{__truediv__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__lshift__}, @code{__rshift__}, @code{__and__}, @code{__xor__}, @code{__or__} y @code{__pow__}

@item 
Métodos de conversión numérica: @code{__complex__}, @code{__int__}, @code{__float__} y @code{__index__}

@item 
Métodos de descriptores: @code{__get__}, @code{__set__} y @code{__delete__}

@item 
Pickling: @code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} y @code{__setstate__}

@item 
Representación de rutas del sistema de archivos: @code{__fspath__}

@item 
Métodos de iteración asíncronos: @code{__aiter__} y @code{__anext__}
@end itemize


Distinto en la versión 3.8: Se añadió soporte para @ref{cda,,os.PathLike.__fspath__()}.



Distinto en la versión 3.8: Se añadió soporte para @code{__aenter__}, @code{__aexit__}, @code{__aiter__} y @code{__anext__}.


Los siguientes métodos existen pero `no' están soportados, ya sea porque son usados por el propio objeto simulado, porque no se pueden establecer dinámicamente o porque pueden causar problemas:


@itemize *

@item 
@code{__getattr__}, @code{__setattr__}, @code{__init__} y @code{__new__}

@item 
@code{__prepare__}, @code{__instancecheck__}, @code{__subclasscheck__} y @code{__del__}
@end itemize

@node Magic Mock,,Simular métodos mágicos,MagicMock y el soporte de métodos mágicos
@anchor{library/unittest mock magic-mock}@anchor{4022}
@subsubsection Magic Mock


Hay dos variantes de @code{MagicMock}: @ref{f12,,MagicMock} y @ref{3fea,,NonCallableMagicMock}.

@geindex MagicMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock MagicMock}@anchor{f12}
@deffn {Clase} unittest.mock.MagicMock (*args, **kw)

@code{MagicMock} is a subclass of @ref{ade,,Mock} with default implementations
of most of the @ref{4021,,magic methods}. You can use
@code{MagicMock} without having to configure the magic methods yourself.

Los parámetros del constructor tienen el mismo significado que en @ref{ade,,Mock}.

Si utilizas los argumentos `spec' o `spec_set' entonces `solo' los métodos mágicos que existan en la especificación serán creados.
@end deffn

@geindex NonCallableMagicMock (clase en unittest.mock)
@anchor{library/unittest mock unittest mock NonCallableMagicMock}@anchor{3fea}
@deffn {Clase} unittest.mock.NonCallableMagicMock (*args, **kw)

Una versión no invocable de @ref{f12,,MagicMock}.

Los parámetros del constructor tienen el mismo significado que en @ref{f12,,MagicMock}, con la excepción de `return_value' y `side_effect' que no tienen significado en un objeto simulado no invocable.
@end deffn

Los métodos mágicos están implementados mediante objetos @ref{f12,,MagicMock}, por lo que puedes configurarlos y utilizarlos de la forma habitual:

@example
>>> mock = MagicMock()
>>> mock[3] = 'fish'
>>> mock.__setitem__.assert_called_with(3, 'fish')
>>> mock.__getitem__.return_value = 'result'
>>> mock[2]
'result'
@end example

Por defecto, muchos de los métodos de protocolo están obligados a retornar objetos de un tipo específico. Estos métodos están preconfigurados con un valor de retorno por defecto, de manera que puedan ser utilizados sin tener que hacer nada más, siempre que no estés interesado en el valor de retorno. En todo caso, puedes `establecer' el valor de retorno de forma manual si deseas cambiar el valor predeterminado.

Métodos y sus valores por defecto:


@itemize *

@item 
@code{__lt__}: @ref{227,,NotImplemented}

@item 
@code{__gt__}: @code{NotImplemented}

@item 
@code{__le__}: @code{NotImplemented}

@item 
@code{__ge__}: @code{NotImplemented}

@item 
@code{__int__}: @code{1}

@item 
@code{__contains__}: @code{False}

@item 
@code{__len__}: @code{0}

@item 
@code{__iter__}: @code{iter([])}

@item 
@code{__exit__}: @code{False}

@item 
@code{__aexit__}: @code{False}

@item 
@code{__complex__}: @code{1j}

@item 
@code{__float__}: @code{1.0}

@item 
@code{__bool__}: @code{True}

@item 
@code{__index__}: @code{1}

@item 
@code{__hash__}: hash predeterminado del objeto simulado

@item 
@code{__str__}: str predeterminado del objeto simulado

@item 
@code{__sizeof__}: sizeof predeterminado del objeto simulado
@end itemize

Por ejemplo:

@example
>>> mock = MagicMock()
>>> int(mock)
1
>>> len(mock)
0
>>> list(mock)
[]
>>> object() in mock
False
@end example

The two equality methods, @code{__eq__()} and @code{__ne__()}, are special.
They do the default equality comparison on identity, using the
@ref{3fe4,,side_effect} attribute, unless you change their return value to
return something else:

@example
>>> MagicMock() == 3
False
>>> MagicMock() != 3
True
>>> mock = MagicMock()
>>> mock.__eq__.return_value = True
>>> mock == 3
True
@end example

El valor de retorno de @code{MagicMock.__iter__()} puede ser cualquier objeto iterable, no se requiere que sea un iterador:

@example
>>> mock = MagicMock()
>>> mock.__iter__.return_value = ['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
@end example

Si el valor de retorno `es' un iterador, iterar sobre él una vez que se consume, y cualquier iteración posterior, resultará en una lista vacía:

@example
>>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
[]
@end example

@code{MagicMock} tiene todos los métodos mágicos soportados configurados a excepción de algunos de los más oscuros y obsoletos. De todas formas, puedes configurar estos también si lo deseas.

Los métodos mágicos que son compatibles, pero que no están configurados por defecto en @code{MagicMock} son:


@itemize *

@item 
@code{__subclasses__}

@item 
@code{__dir__}

@item 
@code{__format__}

@item 
@code{__get__}, @code{__set__} y @code{__delete__}

@item 
@code{__reversed__} y @code{__missing__}

@item 
@code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} y @code{__setstate__}

@item 
@code{__getformat__}
@end itemize

@node Ayudantes,Order of precedence of side_effect return_value and wraps,MagicMock y el soporte de métodos mágicos,unittest mock — mock object library
@anchor{library/unittest mock helpers}@anchor{4023}
@subsubsection Ayudantes


@menu
* sentinel:: 
* DEFAULT:: 
* call:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* Autoespecificación:: 
* Sellar objetos simulados:: 

@end menu

@node sentinel,DEFAULT,,Ayudantes
@anchor{library/unittest mock sentinel}@anchor{4024}
@subsubsection sentinel


@geindex sentinel (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock sentinel}@anchor{c28}
@deffn {Dato} unittest.mock.sentinel

El objeto @code{sentinel} proporciona una manera conveniente de proporcionar objetos únicos para tus pruebas.

Los atributos se crean a demanda, en el instante en el que se accede a ellos por su nombre por primera vez. El acceso al mismo atributo siempre retornará el mismo objeto. Los objetos retornados tienen una reproducción (repr) apropiada para que los mensajes de error de la prueba sean legibles.


Distinto en la versión 3.7: Los atributos @code{sentinel} ahora preservan su identidad cuando son @ref{26,,copiados} o @ref{a6,,serializados con pickle}.

@end deffn

A veces, cuando implementas pruebas, necesitas probar que un determinado objeto se pasa como argumento a otro método, o se retorna. Crear objetos centinela con un nombre para probar esto puede ser una práctica común. @ref{c28,,sentinel} proporciona una manera conveniente de crear y probar la identidad de este tipo de objetos.

En el siguiente ejemplo, parcheamos @code{method} para retornar @code{sentinel.some_object}:

@example
>>> real = ProductionClass()
>>> real.method = Mock(name="method")
>>> real.method.return_value = sentinel.some_object
>>> result = real.method()
>>> assert result is sentinel.some_object
>>> result
sentinel.some_object
@end example

@node DEFAULT,call,sentinel,Ayudantes
@anchor{library/unittest mock default}@anchor{4025}
@subsubsection DEFAULT


@geindex DEFAULT (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock DEFAULT}@anchor{3feb}
@deffn {Dato} unittest.mock.DEFAULT

El objeto @ref{3feb,,DEFAULT} es un centinela pre-creado (actualmente @code{sentinel.DEFAULT}). Puede ser usado por las funciones @ref{3fe4,,side_effect} para indicar que el valor de retorno normal debe ser utilizado.
@end deffn

@node call,create_autospec,DEFAULT,Ayudantes
@anchor{library/unittest mock call}@anchor{4026}
@subsubsection call


@geindex call() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock call}@anchor{19d7}
@deffn {Función} unittest.mock.call (*args, **kwargs)

@ref{19d7,,call()} es un objeto ayudante que puede usarse para hacer aserciones simples, para comparar con @ref{1989,,call_args}, @ref{3ff8,,call_args_list}, @ref{3ff0,,mock_calls} y @ref{3ff2,,method_calls}. @ref{19d7,,call()} y también se puede utilizar con @ref{16b2,,assert_has_calls()}.

@example
>>> m = MagicMock(return_value=None)
>>> m(1, 2, a='foo', b='bar')
>>> m()
>>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()]
True
@end example
@end deffn

@geindex call_list() (método de unittest.mock.call)
@anchor{library/unittest mock unittest mock call call_list}@anchor{4027}
@deffn {Método} call.call_list ()

Para un objeto call que representa múltiples llamadas, el método @ref{4027,,call_list()} retorna una lista con todas las llamadas intermedias, así como la llamada final.
@end deffn

@code{call_list} es particularmente útil para hacer aserciones sobre «llamadas encadenadas». Una llamada encadenada es varias llamadas en una sola línea de código. Esto resulta en múltiples entradas en el atributo @ref{3ff0,,mock_calls} de un objeto simulado. Construir manualmente la secuencia de llamadas puede ser tedioso.

@ref{4027,,call_list()} puede construir la secuencia de llamadas desde la misma llamada encadenada:

@example
>>> m = MagicMock()
>>> m(1).method(arg='foo').other('bar')(2.0)
<MagicMock name='mock().method().other()()' id='...'>
>>> kall = call(1).method(arg='foo').other('bar')(2.0)
>>> kall.call_list()
[call(1),
 call().method(arg='foo'),
 call().method().other('bar'),
 call().method().other()(2.0)]
>>> m.mock_calls == kall.call_list()
True
@end example
@anchor{library/unittest mock calls-as-tuples}@anchor{3ff9}
Un objeto @code{call}, dependiendo de cómo fuera construido, puede ser una tupla de la forma (argumentos posicionales, argumentos por palabras clave) o bien de la forma (nombre, argumentos posicionales, argumentos por palabras clave). Esto no es particularmente interesante cuando los construyes por ti mismo, pero la introspección de los objetos @code{call} que conforman los atributos @ref{1989,,Mock.call_args}, @ref{3ff8,,Mock.call_args_list} y @ref{3ff0,,Mock.mock_calls} si pueden ser de utilidad para para acceder a los argumentos individuales que contienen.

Los objetos @code{call} en @ref{1989,,Mock.call_args} y @ref{3ff8,,Mock.call_args_list} están conformados por dos tuplas (argumentos posicionales, argumentos por palabra clave) mientras que los objetos @code{call} en @ref{3ff0,,Mock.mock_calls}, junto con los que construyas por ti mismo, constan de tres tuplas (nombre, argumentos posicionales, argumentos por palabra clave).

Puedes utilizar esta presentación en forma de tuplas para obtener los argumentos individuales, con la finalidad de llevar a cabo introspección y aserciones más complejas. Los argumentos posicionales son una tupla (vacía si no hay ninguno) y los argumentos por palabra clave son un diccionario:

@example
>>> m = MagicMock(return_value=None)
>>> m(1, 2, 3, arg='one', arg2='two')
>>> kall = m.call_args
>>> kall.args
(1, 2, 3)
>>> kall.kwargs
@{'arg': 'one', 'arg2': 'two'@}
>>> kall.args is kall[0]
True
>>> kall.kwargs is kall[1]
True
@end example

@example
>>> m = MagicMock()
>>> m.foo(4, 5, 6, arg='two', arg2='three')
<MagicMock name='mock.foo()' id='...'>
>>> kall = m.mock_calls[0]
>>> name, args, kwargs = kall
>>> name
'foo'
>>> args
(4, 5, 6)
>>> kwargs
@{'arg': 'two', 'arg2': 'three'@}
>>> name is m.mock_calls[0][0]
True
@end example

@node create_autospec,ANY,call,Ayudantes
@anchor{library/unittest mock create-autospec}@anchor{4028}
@subsubsection create_autospec


@geindex create_autospec() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock create_autospec}@anchor{15c9}
@deffn {Función} unittest.mock.create_autospec (spec, spec_set=False, instance=False, **kwargs)

Crea un nuevo objeto simulado utilizando otro objeto (`spec') como especificación. Los atributos del objeto simulado utilizarán el atributo correspondiente del objeto `spec' como su especificación.

Los argumentos de las funciones o métodos simulados se validarán para asegurarse de que son invocados con la firma correcta.

Si `spec_set' es @code{True}, tratar de establecer atributos que no existen en el objeto especificado lanzará una excepción @ref{441,,AttributeError}.

Si se utiliza una clase como especificación, el valor de retorno del objeto simulado (la instancia de la clase) tendrá la misma especificación. Se puede utilizar una clase como especificación de una instancia pasando @code{instance=True}. El objeto simulado retornado solo será invocable si las instancias del objeto simulado son también invocables.

@ref{15c9,,create_autospec()} también acepta argumentos por palabra clave arbitrarios, que son pasados al constructor del objeto simulado creado.
@end deffn

Consultar @ref{3fe7,,Autoespecificación} para ver ejemplos de cómo utilizar la autoespecificación mediante @ref{15c9,,create_autospec()} y el argumento `autospec' de @ref{f13,,patch()}.


Distinto en la versión 3.8: @ref{15c9,,create_autospec()} ahora retorna un objeto @ref{add,,AsyncMock} si el objetivo a simular es una función asíncrona.


@node ANY,FILTER_DIR,create_autospec,Ayudantes
@anchor{library/unittest mock any}@anchor{4029}
@subsubsection ANY


@geindex ANY (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock ANY}@anchor{19d5}
@deffn {Dato} unittest.mock.ANY
@end deffn

A veces puede que necesites hacer aserciones sobre `algunos' de los argumentos de una llamada al objeto simulado, pero sin preocuparte por el resto, o puede que quieras hacer uso de ellos de forma individual fuera de @ref{1989,,call_args} y hacer aserciones más complejas con ellos.

Para ignorar ciertos argumentos puedes pasar objetos que se comparan como iguales con `cualquier cosa'. En este caso, las llamadas a @ref{1a28,,assert_called_with()} y @ref{3fee,,assert_called_once_with()} tendrán éxito sin importar lo que se haya pasado realmente.

@example
>>> mock = Mock(return_value=None)
>>> mock('foo', bar=object())
>>> mock.assert_called_once_with('foo', bar=ANY)
@end example

@ref{19d5,,ANY} también se puede utilizar en las comparaciones con las listas de llamadas, como @ref{3ff0,,mock_calls}:

@example
>>> m = MagicMock(return_value=None)
>>> m(1)
>>> m(1, 2)
>>> m(object())
>>> m.mock_calls == [call(1), call(1, 2), ANY]
True
@end example

@ref{19d5,,ANY} is not limited to comparisons with call objects and so
can also be used in test assertions:

@example
class TestStringMethods(unittest.TestCase):

    def test_split(self):
        s = 'hello world'
        self.assertEqual(s.split(), ['hello', ANY])
@end example

@node FILTER_DIR,mock_open,ANY,Ayudantes
@anchor{library/unittest mock filter-dir}@anchor{402a}
@subsubsection FILTER_DIR


@geindex FILTER_DIR (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock FILTER_DIR}@anchor{3ff4}
@deffn {Dato} unittest.mock.FILTER_DIR
@end deffn

@ref{3ff4,,FILTER_DIR} es una variable de nivel de módulo que controla la forma en que los objetos simulados responden a @ref{6d3,,dir()}. El valor predeterminado es @code{True}, que utiliza el filtrado que se describe a continuación para mostrar solo los miembros útiles. Si no le gusta este filtrado o necesita desactivarlo con fines de diagnóstico, configure @code{mock.FILTER_DIR = False}.

Con el filtrado activado, @code{dir(some_mock)} mostrará solo atributos útiles y además incluirá cualquier atributo creado dinámicamente, que normalmente no se mostraría. Si el objeto simulado fue creado con un `spec' (o `autospec') se muestran todos los atributos del objeto original, incluso si no se ha accedido a ellos todavía:

@example
>>> dir(Mock())
['assert_any_call',
 'assert_called',
 'assert_called_once',
 'assert_called_once_with',
 'assert_called_with',
 'assert_has_calls',
 'assert_not_called',
 'attach_mock',
 ...
>>> from urllib import request
>>> dir(Mock(spec=request))
['AbstractBasicAuthHandler',
 'AbstractDigestAuthHandler',
 'AbstractHTTPHandler',
 'BaseHandler',
 ...
@end example

Muchos de los atributos con subrayado y doble subrayado no muy útiles (atributos privados de @ref{ade,,Mock} y no del objeto real que se está simulando) se han filtrado del resultado de llamar a @ref{6d3,,dir()} en un objeto @ref{ade,,Mock}. Si no te gusta este comportamiento, puedes desactivarlo estableciendo el modificador a nivel de módulo @ref{3ff4,,FILTER_DIR}:

@example
>>> from unittest import mock
>>> mock.FILTER_DIR = False
>>> dir(mock.Mock())
['_NonCallableMock__get_return_value',
 '_NonCallableMock__get_side_effect',
 '_NonCallableMock__return_value_doc',
 '_NonCallableMock__set_return_value',
 '_NonCallableMock__set_side_effect',
 '__call__',
 '__class__',
 ...
@end example

Alternatively you can just use @code{vars(my_mock)} (instance members) and
@code{dir(type(my_mock))} (type members) to bypass the filtering irrespective of
@ref{3ff4,,FILTER_DIR}.

@node mock_open,Autoespecificación,FILTER_DIR,Ayudantes
@anchor{library/unittest mock mock-open}@anchor{402b}
@subsubsection mock_open


@geindex mock_open() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock mock_open}@anchor{170f}
@deffn {Función} unittest.mock.mock_open (mock=None, read_data=None)

Una función auxiliar que permite crear un objeto simulado con la finalidad de reemplazar el uso de @ref{1be,,open()}. Funciona para simular llamadas directas a @ref{1be,,open()} y para aquellos casos en los que es utilizada como gestor de contexto.

El argumento `mock' es el objeto simulado a configurar. Si es @code{None} (por defecto) un objeto @ref{f12,,MagicMock} se creará para ti, con la API limitada a métodos o atributos disponibles en los gestores de fichero estándares.

`read_data' is a string for the @ref{ea1,,read()},
@ref{1391,,readline()}, and @ref{2336,,readlines()} methods
of the file handle to return.  Calls to those methods will take data from
`read_data' until it is depleted.  The mock of these methods is pretty
simplistic: every time the `mock' is called, the `read_data' is rewound to
the start.  If you need more control over the data that you are feeding to
the tested code you will need to customize this mock for yourself.  When that
is insufficient, one of the in-memory filesystem packages on PyPI@footnote{https://pypi.org} can offer a realistic filesystem for testing.


Distinto en la versión 3.4: Added @ref{1391,,readline()} and @ref{2336,,readlines()} support.
The mock of @ref{ea1,,read()} changed to consume `read_data' rather
than returning it on each call.



Distinto en la versión 3.5: `read_data' ahora es restablecido en cada llamada al `mock'.



Distinto en la versión 3.8: Added @ref{1cc8,,__iter__()} to implementation so that iteration
(such as in for loops) correctly consumes `read_data'.

@end deffn

Usar @ref{1be,,open()} como gestor de contexto es una buena manera de asegurarse de que los gestores de archivos se cierren correctamente al terminar y se está convirtiendo en una práctica común:

@example
with open('/some/path', 'w') as f:
    f.write('something')
@end example

The issue is that even if you mock out the call to @ref{1be,,open()} it is the
`returned object' that is used as a context manager (and has @ref{669,,__enter__()} and
@ref{1367,,__exit__()} called).

Simular gestores de contexto con un @ref{f12,,MagicMock} es lo suficientemente común y complicado como para que una función auxiliar sea útil:

@example
>>> m = mock_open()
>>> with patch('__main__.open', m):
...     with open('foo', 'w') as h:
...         h.write('some stuff')
...
>>> m.mock_calls
[call('foo', 'w'),
 call().__enter__(),
 call().write('some stuff'),
 call().__exit__(None, None, None)]
>>> m.assert_called_once_with('foo', 'w')
>>> handle = m()
>>> handle.write.assert_called_once_with('some stuff')
@end example

Y para la lectura de archivos:

@example
>>> with patch('__main__.open', mock_open(read_data='bibble')) as m:
...     with open('foo') as h:
...         result = h.read()
...
>>> m.assert_called_once_with('foo')
>>> assert result == 'bibble'
@end example

@node Autoespecificación,Sellar objetos simulados,mock_open,Ayudantes
@anchor{library/unittest mock auto-speccing}@anchor{3fe7}@anchor{library/unittest mock autospeccing}@anchor{402c}
@subsubsection Autoespecificación


Autospeccing is based on the existing @code{spec} feature of mock. It limits the
api of mocks to the api of an original object (the spec), but it is recursive
(implemented lazily) so that attributes of mocks only have the same api as
the attributes of the spec. In addition mocked functions / methods have the
same call signature as the original so they raise a @ref{228,,TypeError} if they are
called incorrectly.

Antes de explicar cómo funciona la autoespecificación, he aquí por qué se necesita.

@ref{ade,,Mock} is a very powerful and flexible object, but it suffers from a flaw which
is general to mocking. If you refactor some of your code, rename members and so on, any
tests for code that is still using the `old api' but uses mocks instead of the real
objects will still pass. This means your tests can all pass even though your code is
broken.


Distinto en la versión 3.5: Before 3.5, tests with a typo in the word assert would silently pass when they should
raise an error. You can still achieve this behavior by passing @code{unsafe=True} to Mock.


Ten en cuenta que esta es otra razón por la que necesitas pruebas de integración además de pruebas unitarias. Probar todo de forma aislada está muy bien, pero si no pruebas cómo están «conectadas entre sí» tus unidades, todavía hay mucho espacio para errores que las pruebas deberían haber detectado.

@ref{107,,unittest.mock} already provides a feature to help with this, called speccing. If you
use a class or instance as the @code{spec} for a mock then you can only access
attributes on the mock that exist on the real class:

@example
>>> from urllib import request
>>> mock = Mock(spec=request.Request)
>>> mock.assret_called_with  # Intentional typo!
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
@end example

La especificación solo se aplica al propio objeto simulado, por lo que aún tenemos el mismo problema con cualquiera de los métodos del mismo:

@example
>>> mock.has_data()
<mock.Mock object at 0x...>
>>> mock.has_data.assret_called_with()  # Intentional typo!
@end example

La autoespecificación resuelve este problema. Puedes pasar @code{autospec=True} a @ref{f13,,patch()} / @ref{1596,,patch.object()} o utilizar la función @ref{15c9,,create_autospec()} para crear un objeto simulado con una especificación. Si utilizas el argumento @code{autospec=True} de @ref{f13,,patch()}, el objeto que se va a reemplazar se utiliza como objeto de especificación. Debido a que la especificación se hace «perezosamente» (la especificación se crea en el instante en el que se accede a los atributos del objeto simulado, no antes), se puede utilizar con objetos muy complejos o anidadas (como módulos que importan módulos que, a su vez, importan otros módulos) sin un gran impacto en el rendimiento.

He aquí un ejemplo de ello en acción:

@example
>>> from urllib import request
>>> patcher = patch('__main__.request', autospec=True)
>>> mock_request = patcher.start()
>>> request is mock_request
True
>>> mock_request.Request
<MagicMock name='request.Request' spec='Request' id='...'>
@end example

You can see that @code{request.Request} has a spec. @code{request.Request} takes two
arguments in the constructor (one of which is `self'). Here’s what happens if
we try to call it incorrectly:

@example
>>> req = request.Request()
Traceback (most recent call last):
 ...
TypeError: <lambda>() takes at least 2 arguments (1 given)
@end example

La especificación también se aplica a las clases instanciadas (es decir, el valor de retorno de los objetos simulados especificados):

@example
>>> req = request.Request('foo')
>>> req
<NonCallableMagicMock name='request.Request()' spec='Request' id='...'>
@end example

@code{Request} objects are not callable, so the return value of instantiating our
mocked out @code{request.Request} is a non-callable mock. With the spec in place
any typos in our asserts will raise the correct error:

@example
>>> req.add_header('spam', 'eggs')
<MagicMock name='request.Request().add_header()' id='...'>
>>> req.add_header.assret_called_with  # Intentional typo!
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
>>> req.add_header.assert_called_with('spam', 'eggs')
@end example

En muchos casos, podrás simplemente añadir @code{autospec=True} a tus llamadas @ref{f13,,patch()} existentes y así estar protegido contra errores tipográficos y cambios de la API.

Además de poder usar `autospec' a través de @ref{f13,,patch()}, existe la función @ref{15c9,,create_autospec()} para crear directamente objetos simulados autoespecificados:

@example
>>> from urllib import request
>>> mock_request = create_autospec(request)
>>> mock_request.Request('foo', 'bar')
<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>
@end example

Sin embargo, este no es el comportamiento predeterminado, ya que no está exento de advertencias y restricciones. Con el fin de conocer qué atributos están disponibles en el objeto especificado, autospec tiene que hacer uso de introspección sobre la especificación (acceder a los atributos). A medida que recorres los atributos en el objeto simulado, se produce paralelamente y de forma soterrada un recorrido del objeto original. Si alguno de tus objetos especificados tienen propiedades o descriptores que puedan desencadenar la ejecución de código, quizás no deberías utilizar la autoespecificación. De todas formas, es siempre mucho mejor diseñar tus objetos de modo que la introspección sea segura @footnote{
Esto solo se aplica a las clases u objetos ya instanciados. Llamar a una clase simulada para crear una instancia simulada `no' crea una instancia real. Solo se llevan a cabo las búsqueda de atributos (mediante llamadas a @ref{6d3,,dir()}).
}.

A more serious problem is that it is common for instance attributes to be
created in the @ref{751,,__init__()} method and not to exist on the class at all.
`autospec' can’t know about any dynamically created attributes and restricts
the api to visible attributes.

@example
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a
...
Traceback (most recent call last):
  ...
AttributeError: Mock object has no attribute 'a'
@end example

Hay diferentes formas de resolver este problema. La forma más sencilla, pero no necesariamente la menos molesta, es simplemente establecer los atributos necesarios en el objeto simulado después de la creación del mismo. El hecho de que `autospec' no te permita buscar atributos que no existen en la especificación no impide que los establezcas manualmente después:

@example
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a = 33
...
@end example

Existe una versión más agresiva de `spec' y `autospec' que impide establecer atributos inexistentes. Esto es útil si deseas asegurarte de que tu código solo `establece' atributos válidos, pero obviamente evitando este escenario en particular:

@example
>>> with patch('__main__.Something', autospec=True, spec_set=True):
...   thing = Something()
...   thing.a = 33
...
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'a'
@end example

Probably the best way of solving the problem is to add class attributes as
default values for instance members initialised in @ref{751,,__init__()}.
Note that if
you are only setting default attributes in @code{__init__()} then providing them via
class attributes (shared between instances of course) is faster too. e.g.

@example
class Something:
    a = 33
@end example

Esto nos plantea otro problema. Es relativamente común proporcionar un valor predeterminado de @code{None} para los miembros que posteriormente se convertirán en objetos de un tipo diferente. @code{None} es inútil como especificación dado que no permite acceder a `ningún' atributo o método. Como @code{None} `nunca' será útil como especificación, y probablemente indica un miembro que normalmente será de algún otro tipo en el futuro, la autoespecificación no usa una especificación para aquellos miembros configurados con @code{None} como valor. Estos serán simplemente objetos simulados ordinarios (MagicMocks en realidad):

@example
>>> class Something:
...     member = None
...
>>> mock = create_autospec(Something)
>>> mock.member.foo.bar.baz()
<MagicMock name='mock.member.foo.bar.baz()' id='...'>
@end example

Si modificar tus clases en producción para agregar valores predeterminados no es de tu agrado, dispones de otras opciones. Una de ellas es simplemente usar una instancia como especificación en lugar de la clase. La otra es crear una subclase de la clase en producción y agregar los valores predeterminados a la subclase, sin afectar a la clase en producción. Ambas alternativas requieren que uses un objeto alternativo como especificación. Afortunadamente @ref{f13,,patch()} admite esto, simplemente tienes que pasar el objeto alternativo mediante el argumento `autospec':

@example
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> class SomethingForTest(Something):
...   a = 33
...
>>> p = patch('__main__.Something', autospec=SomethingForTest)
>>> mock = p.start()
>>> mock.a
<NonCallableMagicMock name='Something.a' spec='int' id='...'>
@end example

@node Sellar objetos simulados,,Autoespecificación,Ayudantes
@anchor{library/unittest mock sealing-mocks}@anchor{402d}
@subsubsection Sellar objetos simulados


@c from unittest.mock import seal

@geindex seal() (en el módulo unittest.mock)
@anchor{library/unittest mock unittest mock seal}@anchor{c29}
@deffn {Función} unittest.mock.seal (mock)

Seal desactivará la creación automática de objetos simulados al acceder a un atributo del objeto simulado que está siendo sellado, o a cualquiera de sus atributos que ya sean objetos simulados de forma recursiva.

Si una instancia simulada con un nombre o una especificación es asignada a un atributo no será considerada en la cadena de sellado. Esto permite evitar que seal fije partes del objeto simulado.

@example
>>> mock = Mock()
>>> mock.submock.attribute1 = 2
>>> mock.not_submock = mock.Mock(name="sample_name")
>>> seal(mock)
>>> mock.new_attribute  # This will raise AttributeError.
>>> mock.submock.attribute2  # This will raise AttributeError.
>>> mock.not_submock.attribute2  # This won't raise.
@end example


Added in version 3.7.

@end deffn

@node Order of precedence of side_effect return_value and wraps,,Ayudantes,unittest mock — mock object library
@anchor{library/unittest mock order-of-precedence-of-side-effect-return-value-and-wraps}@anchor{402e}
@subsubsection Order of precedence of @code{side_effect}, @code{return_value} and `wraps'


The order of their precedence is:


@enumerate 

@item 
@ref{3fe4,,side_effect}

@item 
@ref{3fec,,return_value}

@item 
`wraps'
@end enumerate

If all three are set, mock will return the value from @ref{3fe4,,side_effect},
ignoring @ref{3fec,,return_value} and the wrapped object altogether. If any
two are set, the one with the higher precedence will return the value.
Regardless of the order of which was set first, the order of precedence
remains unchanged.

@example
>>> from unittest.mock import Mock
>>> class Order:
...     @@staticmethod
...     def get_value():
...         return "third"
...
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.get_value.side_effect = ["first"]
>>> order_mock.get_value.return_value = "second"
>>> order_mock.get_value()
'first'
@end example

As @code{None} is the default value of @ref{3fe4,,side_effect}, if you reassign
its value back to @code{None}, the order of precedence will be checked between
@ref{3fec,,return_value} and the wrapped object, ignoring
@ref{3fe4,,side_effect}.

@example
>>> order_mock.get_value.side_effect = None
>>> order_mock.get_value()
'second'
@end example

If the value being returned by @ref{3fe4,,side_effect} is @ref{3feb,,DEFAULT},
it is ignored and the order of precedence moves to the successor to obtain the
value to return.

@example
>>> from unittest.mock import DEFAULT
>>> order_mock.get_value.side_effect = [DEFAULT]
>>> order_mock.get_value()
'second'
@end example

When @ref{ade,,Mock} wraps an object, the default value of
@ref{3fec,,return_value} will be @ref{3feb,,DEFAULT}.

@example
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.return_value
sentinel.DEFAULT
>>> order_mock.get_value.return_value
sentinel.DEFAULT
@end example

The order of precedence will ignore this value and it will move to the last
successor which is the wrapped object.

As the real call is being made to the wrapped object, creating an instance of
this mock will return the real instance of the class. The positional arguments,
if any, required by the wrapped object must be passed.

@example
>>> order_mock_instance = order_mock()
>>> isinstance(order_mock_instance, Order)
True
>>> order_mock_instance.get_value()
'third'
@end example

@example
>>> order_mock.get_value.return_value = DEFAULT
>>> order_mock.get_value()
'third'
@end example

@example
>>> order_mock.get_value.return_value = "second"
>>> order_mock.get_value()
'second'
@end example

But if you assign @code{None} to it, this will not be ignored as it is an
explicit assignment. So, the order of precedence will not move to the wrapped
object.

@example
>>> order_mock.get_value.return_value = None
>>> order_mock.get_value() is None
True
@end example

Even if you set all three at once when initializing the mock, the order of
precedence remains the same:

@example
>>> order_mock = Mock(spec=Order, wraps=Order,
...                   **@{"get_value.side_effect": ["first"],
...                      "get_value.return_value": "second"@}
...                   )
...
>>> order_mock.get_value()
'first'
>>> order_mock.get_value.side_effect = None
>>> order_mock.get_value()
'second'
>>> order_mock.get_value.return_value = DEFAULT
>>> order_mock.get_value()
'third'
@end example

If @ref{3fe4,,side_effect} is exhausted, the order of precedence will not
cause a value to be obtained from the successors. Instead, @code{StopIteration}
exception is raised.

@example
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.get_value.side_effect = ["first side effect value",
...                                     "another side effect value"]
>>> order_mock.get_value.return_value = "second"
@end example

@example
>>> order_mock.get_value()
'first side effect value'
>>> order_mock.get_value()
'another side effect value'
@end example

@example
>>> order_mock.get_value()
Traceback (most recent call last):
 ...
StopIteration
@end example

@node unittest mock — getting started,test — Regression tests package for Python,unittest mock — mock object library,Herramientas de desarrollo
@anchor{library/unittest mock-examples doc}@anchor{402f}@anchor{library/unittest mock-examples unittest-mock-getting-started}@anchor{4030}
@subsection @code{unittest.mock} — getting started



Added in version 3.3.

@anchor{library/unittest mock-examples getting-started}@anchor{4031}
@c import asyncio
@c import unittest
@c from unittest.mock import Mock, MagicMock, AsyncMock, patch, call, sentinel
@c 
@c class SomeClass:
@c     attribute = 'this is a doctest'
@c 
@c     @staticmethod
@c     def static_method():
@c         pass

@menu
* Usando mock:: 
* Decoradores de Parches:: 
* Otros ejemplos:: 

@end menu

@node Usando mock,Decoradores de Parches,,unittest mock — getting started
@anchor{library/unittest mock-examples using-mock}@anchor{4032}
@subsubsection Usando mock


@menu
* Métodos de parcheo mock:: 
* Mock de llamadas a métodos sobre un objeto:: 
* Clases de Mock:: 
* Nombrando tus mocks:: 
* Siguiendo todas las llamadas:: 
* Establecer valores de retorno y atributos:: 
* Generar excepciones con mocks:: 
* Funciones de efectos secundarios e iterables:: 
* Iteradores asincrónicos de Mocking:: 
* El gestor de contexto asincrónico de Mocking:: 
* Creando un mock desde un objeto existente:: 
* Uso de side_effect para devolver el contenido por archivo:: 

@end menu

@node Métodos de parcheo mock,Mock de llamadas a métodos sobre un objeto,,Usando mock
@anchor{library/unittest mock-examples mock-patching-methods}@anchor{4033}
@subsubsection Métodos de parcheo mock


Usos comunes para objetos @ref{ade,,Mock} incluye:


@itemize *

@item 
Métodos de parcheo

@item 
Métodos de grabación de llamadas sobre objetos
@end itemize

Es posible que desee reemplazar un método en un objeto para comprobar que se llama con los argumentos correctos por otra parte del sistema:

@example
>>> real = SomeClass()
>>> real.method = MagicMock(name='method')
>>> real.method(3, 4, 5, key='value')
<MagicMock name='method()' id='...'>
@end example

Una vez que se ha utilizado nuestro mock (@code{real.method} en este ejemplo) tiene métodos y atributos que le permiten hacer afirmaciones sobre cómo se ha utilizado.

@cartouche
@quotation Nota 
En la mayoría de estos ejemplos, las clases @ref{ade,,Mock} y @ref{f12,,MagicMock} son intercambiables. Como el @code{MagicMock} es la clase más capaz, hace que sea sensato usarlo por defecto.
@end quotation
@end cartouche

Una vez que el mock ha sido llamado su atributo @ref{3ff6,,called} se establece en @code{True}. Lo que es más importante, podemos usar el método @ref{1a28,,assert_called_with()} o @ref{3fee,,assert_called_once_with()} para comprobar que se llamó con los argumentos correctos.

En este ejemplo se prueba que llamar a @code{ProductionClass().method} da como resultado una llamada al método @code{something}:

@example
>>> class ProductionClass:
...     def method(self):
...         self.something(1, 2, 3)
...     def something(self, a, b, c):
...         pass
...
>>> real = ProductionClass()
>>> real.something = MagicMock()
>>> real.method()
>>> real.something.assert_called_once_with(1, 2, 3)
@end example

@node Mock de llamadas a métodos sobre un objeto,Clases de Mock,Métodos de parcheo mock,Usando mock
@anchor{library/unittest mock-examples mock-for-method-calls-on-an-object}@anchor{4034}
@subsubsection Mock de llamadas a métodos sobre un objeto


En el último ejemplo, parcheamos un método directamente en un objeto para comprobar que se llamó correctamente. Otro caso de uso común es pasar un objeto a un método (o a alguna parte del sistema sometido a prueba) y, a continuación, comprobar que se utiliza de la manera correcta.

La sencilla @code{ProductionClass} a continuación tiene un método @code{closer}. Si se llama con un objeto, entonces llama a @code{close} en él.

@example
>>> class ProductionClass:
...     def closer(self, something):
...         something.close()
...
@end example

Así que para probarlo necesitamos pasar un objeto con un método @code{close} y comprobar que se llamó correctamente.

@example
>>> real = ProductionClass()
>>> mock = Mock()
>>> real.closer(mock)
>>> mock.close.assert_called_with()
@end example

No tenemos que hacer ningún trabajo para proporcionar el método de “close” en nuestro mock. El acceso al cierre lo crea. Por lo tanto, si “close” aún no se ha llamado, entonces acceder a él en la prueba lo creará, pero @ref{1a28,,assert_called_with()} lanzará una excepción de error.

@node Clases de Mock,Nombrando tus mocks,Mock de llamadas a métodos sobre un objeto,Usando mock
@anchor{library/unittest mock-examples mocking-classes}@anchor{4035}
@subsubsection Clases de Mock


Un caso de uso común es simular las clases que crea la instancia del código que se está probando. Cuando se aplica un parche a una clase, esa clase se reemplaza por un mock. Las instancias se crean `llamando a la clase'. Esto significa que tiene acceso a la «instancia mock» examinando el valor devuelto de la clase simulada.

En el ejemplo siguiente tenemos una función @code{some_function} que crea una instancia de @code{Foo} y llama a un método en él. La llamada a @ref{f13,,patch()} reemplaza la clase @code{Foo} con un mock. La instancia @code{Foo} es el resultado de llamar al mock, por lo que se configura modificando el mock @code{-Mock.return_value}.

@example
>>> def some_function():
...     instance = module.Foo()
...     return instance.method()
...
>>> with patch('module.Foo') as mock:
...     instance = mock.return_value
...     instance.method.return_value = 'the result'
...     result = some_function()
...     assert result == 'the result'
@end example

@node Nombrando tus mocks,Siguiendo todas las llamadas,Clases de Mock,Usando mock
@anchor{library/unittest mock-examples naming-your-mocks}@anchor{4036}
@subsubsection Nombrando tus mocks


Puede ser útil poner un nombre a tus mocks. El nombre se muestra en la reproducción del mock y puede ser útil cuando el mock aparece en los mensajes de error de la prueba. El nombre también se propaga a los atributos o métodos del mock:

@example
>>> mock = MagicMock(name='foo')
>>> mock
<MagicMock name='foo' id='...'>
>>> mock.method
<MagicMock name='foo.method' id='...'>
@end example

@node Siguiendo todas las llamadas,Establecer valores de retorno y atributos,Nombrando tus mocks,Usando mock
@anchor{library/unittest mock-examples tracking-all-calls}@anchor{4037}
@subsubsection Siguiendo todas las llamadas


A menudo, desea realizar un seguimiento de más de una llamada a un método. El atributo @code{mock_calls} registra todas las llamadas a los atributos secundarios del mock, y también a sus hijos.

@example
>>> mock = MagicMock()
>>> mock.method()
<MagicMock name='mock.method()' id='...'>
>>> mock.attribute.method(10, x=53)
<MagicMock name='mock.attribute.method()' id='...'>
>>> mock.mock_calls
[call.method(), call.attribute.method(10, x=53)]
@end example

Si realiza una afirmación sobre @code{mock_calls} y se ha llamado a cualquier método inesperado, la aserción fallará. Esto es útil porque además de afirmar que se han realizado las llamadas que esperaba, también está comprobando que se hicieron en el orden correcto y sin llamadas adicionales:

Utiliza el objeto @ref{19d7,,call} para construir listas y compararlas con @code{mock_calls}:

@example
>>> expected = [call.method(), call.attribute.method(10, x=53)]
>>> mock.mock_calls == expected
True
@end example

Sin embargo, los parámetros de las llamadas que devuelven mocks no se registran, lo que significa que no es posible realizar un seguimiento de las llamadas anidadas donde los parámetros utilizados para crear ancestros son importantes:

@example
>>> m = Mock()
>>> m.factory(important=True).deliver()
<Mock name='mock.factory().deliver()' id='...'>
>>> m.mock_calls[-1] == call.factory(important=False).deliver()
True
@end example

@node Establecer valores de retorno y atributos,Generar excepciones con mocks,Siguiendo todas las llamadas,Usando mock
@anchor{library/unittest mock-examples setting-return-values-and-attributes}@anchor{4038}
@subsubsection Establecer valores de retorno y atributos


Establecer los valores de retorno en un objeto mock es sumamente fácil:

@example
>>> mock = Mock()
>>> mock.return_value = 3
>>> mock()
3
@end example

Por supuesto, puede hacer lo mismo con los métodos en el mock:

@example
>>> mock = Mock()
>>> mock.method.return_value = 3
>>> mock.method()
3
@end example

El valor devuelto también se puede establecer en el constructor:

@example
>>> mock = Mock(return_value=3)
>>> mock()
3
@end example

Si necesitas una configuración de atributo en su mock, simplemente haga:

@example
>>> mock = Mock()
>>> mock.x = 3
>>> mock.x
3
@end example

A veces desea simular una situación más compleja, como por ejemplo @code{mock.connection.cursor().execute("SELECT 1")}. Si esperamos que esta llamada devuelva una lista, entonces tenemos que configurar el resultado de la llamada anidada.

Podemos usar @ref{19d7,,call} para construir el conjunto de llamadas en una «llamada encadenada» como esta para una fácil afirmación después:

@example
>>> mock = Mock()
>>> cursor = mock.connection.cursor.return_value
>>> cursor.execute.return_value = ['foo']
>>> mock.connection.cursor().execute("SELECT 1")
['foo']
>>> expected = call.connection.cursor().execute("SELECT 1").call_list()
>>> mock.mock_calls
[call.connection.cursor(), call.connection.cursor().execute('SELECT 1')]
>>> mock.mock_calls == expected
True
@end example

Es la llamada a @code{.call_list()} la que convierte nuestro objeto de llamada en una lista de llamadas que representan las llamadas encadenadas.

@node Generar excepciones con mocks,Funciones de efectos secundarios e iterables,Establecer valores de retorno y atributos,Usando mock
@anchor{library/unittest mock-examples raising-exceptions-with-mocks}@anchor{4039}
@subsubsection Generar excepciones con mocks


Un atributo útil es @ref{3fe4,,side_effect}. Si establece esto en una clase o instancia de excepción, se producirá la excepción cuando se llame al mock.

@example
>>> mock = Mock(side_effect=Exception('Boom!'))
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

@node Funciones de efectos secundarios e iterables,Iteradores asincrónicos de Mocking,Generar excepciones con mocks,Usando mock
@anchor{library/unittest mock-examples side-effect-functions-and-iterables}@anchor{403a}
@subsubsection Funciones de efectos secundarios e iterables


@code{side_effect} también se puede asignar en una función o en una iterable. El caso de uso para @code{side_effect} como un iterable es donde se va a llamar a su mock varias veces, y desea que cada llamada devuelva un valor diferente. Cuando se asigna @code{side_effect} en un iterable cada llamada al mock devuelve el siguiente valor de lo iterable:

@example
>>> mock = MagicMock(side_effect=[4, 5, 6])
>>> mock()
4
>>> mock()
5
>>> mock()
6
@end example

Para casos de uso más avanzados, como variar dinámicamente los valores devueltos en función de cómo se llame al mock, @code{side_effect} puede ser una función. Se llamará a la función con los mismos argumentos que el mock. Lo que sea que la función devuelve es lo que devuelve la llamada:

@example
>>> vals = @{(1, 2): 1, (2, 3): 2@}
>>> def side_effect(*args):
...     return vals[args]
...
>>> mock = MagicMock(side_effect=side_effect)
>>> mock(1, 2)
1
>>> mock(2, 3)
2
@end example

@node Iteradores asincrónicos de Mocking,El gestor de contexto asincrónico de Mocking,Funciones de efectos secundarios e iterables,Usando mock
@anchor{library/unittest mock-examples mocking-asynchronous-iterators}@anchor{403b}
@subsubsection Iteradores asincrónicos de Mocking


Desde Python 3.8, @code{AsyncMock} y @code{MagicMock} tienen soporte para mock @ref{dff,,Iteradores asíncronos} through @code{__aiter__}. El @ref{3fec,,return_value} atributo de @code{__aiter__} puede ser usado para asignar los valores de retorno que podrían ser usados por iteración.

@example
>>> mock = MagicMock()  # AsyncMock also works here
>>> mock.__aiter__.return_value = [1, 2, 3]
>>> async def main():
...     return [i async for i in mock]
...
>>> asyncio.run(main())
[1, 2, 3]
@end example

@node El gestor de contexto asincrónico de Mocking,Creando un mock desde un objeto existente,Iteradores asincrónicos de Mocking,Usando mock
@anchor{library/unittest mock-examples mocking-asynchronous-context-manager}@anchor{403c}
@subsubsection El gestor de contexto asincrónico de Mocking


Desde Python 3.8, @code{AsyncMock} y @code{MagicMock} tienen soporte para mock @ref{69c,,Gestores de contexto asíncronos} a través de @code{__aenter__} y @code{__aexit__}. De forma predeterminada, las instancias @code{__aenter__} y @code{__aexit__} son instancias de @code{AsyncMock} que devuelven una función asincrónica.

@example
>>> class AsyncContextManager:
...     async def __aenter__(self):
...         return self
...     async def __aexit__(self, exc_type, exc, tb):
...         pass
...
>>> mock_instance = MagicMock(AsyncContextManager())  # AsyncMock also works here
>>> async def main():
...     async with mock_instance as result:
...         pass
...
>>> asyncio.run(main())
>>> mock_instance.__aenter__.assert_awaited_once()
>>> mock_instance.__aexit__.assert_awaited_once()
@end example

@node Creando un mock desde un objeto existente,Uso de side_effect para devolver el contenido por archivo,El gestor de contexto asincrónico de Mocking,Usando mock
@anchor{library/unittest mock-examples creating-a-mock-from-an-existing-object}@anchor{403d}
@subsubsection Creando un mock desde un objeto existente


Un problema con el uso excesivo de mocking es que combina sus pruebas a la implementación de sus mocks en lugar de su código real. Supongamos que tiene una clase que implementa @code{some_method}. En una prueba para otra clase, se proporciona un mock de este objeto que `also' proporciona @code{some_method}. Si más tarde refactoriza la primera clase, para que ya no tenga @code{some_method} - entonces sus pruebas seguirán pasando a pesar de que su código está ahora roto!

@ref{ade,,Mock} le permite proporcionar un objeto como especificación para el mock, utilizando el argumento de palabra clave `spec'. El acceso a métodos / atributos en el mock que no existen en el objeto de especificación lanzará inmediatamente un error de atributo. Si cambia la implementación de la especificación, las pruebas que usan esa clase comenzarán a fallar inmediatamente sin tener que crear instancias de la clase en esas pruebas.

@example
>>> mock = Mock(spec=SomeClass)
>>> mock.old_method()
Traceback (most recent call last):
   ...
AttributeError: Mock object has no attribute 'old_method'. Did you mean: 'class_method'?
@end example

El uso de una especificación también permite una coincidencia más inteligente de las llamadas realizadas al mock, independientemente de si algunos parámetros se pasaron como argumentos posicionales o con nombre:

@example
>>> def f(a, b, c): pass
...
>>> mock = Mock(spec=f)
>>> mock(1, 2, 3)
<Mock name='mock()' id='140161580456576'>
>>> mock.assert_called_with(a=1, b=2, c=3)
@end example

Si desea que esta coincidencia más inteligente también funcione con llamadas de método en el mock, puede usar @ref{3fe7,,auto-speccing}.

Si desea una forma más fuerte de especificación que impida la configuración de atributos arbitrarios, así como la obtención de ellos, entonces puede usar `spec_set' en lugar de `spec'.

@node Uso de side_effect para devolver el contenido por archivo,,Creando un mock desde un objeto existente,Usando mock
@anchor{library/unittest mock-examples using-side-effect-to-return-per-file-content}@anchor{403e}
@subsubsection Uso de side_effect para devolver el contenido por archivo


@ref{170f,,mock_open()} se utiliza para parchear el método @ref{1be,,open()}. @ref{3fe4,,side_effect} se puede utilizar para devolver un nuevo objeto Mock por llamada. Esto puede usarse para devolver diferentes contenidos por fichero almacenado en un diccionario:

@example
DEFAULT = "default"
data_dict = @{"file1": "data1",
             "file2": "data2"@}

def open_side_effect(name):
    return mock_open(read_data=data_dict.get(name, DEFAULT))()

with patch("builtins.open", side_effect=open_side_effect):
    with open("file1") as file1:
        assert file1.read() == "data1"

    with open("file2") as file2:
        assert file2.read() == "data2"

    with open("file3") as file2:
        assert file2.read() == "default"
@end example

@node Decoradores de Parches,Otros ejemplos,Usando mock,unittest mock — getting started
@anchor{library/unittest mock-examples patch-decorators}@anchor{403f}
@subsubsection Decoradores de Parches


@cartouche
@quotation Nota 
Con @ref{f13,,patch()} importa que parchee objetos en el espacio de nombres donde se buscan. Esto es normalmente sencillo, pero para una guía rápida lea @ref{3fe5,,where to patch}.
@end quotation
@end cartouche

Una necesidad común en las pruebas es aplicar revisiones a un atributo de clase o a un atributo de módulo, por ejemplo, aplicar revisiones a una clase integrada o parchear una clase en un módulo para probar que se crea una instancia. Los módulos y las clases son efectivamente globales, por lo que el parcheo en ellos tiene que deshacerse después de la prueba o el parche persistirá en otras pruebas y causará problemas difíciles de diagnosticar.

mock proporciona tres decoradores convenientes para esto: @ref{f13,,patch()}, @ref{1596,,patch.object()} y @ref{1605,,patch.dict()}. @code{patch} toma una sola cadena del formulario @code{package.module.Class.attribute} para especificar el atributo que está parcheando. También, opcionalmente, toma un valor con el que desea que se reemplace el atributo (o clase o lo que sea). “patch.object” toma un objeto y el nombre del atributo con el que desea parchear, además, opcionalmente, del valor con el que parcharlo.

@code{patch.object}:

@example
>>> original = SomeClass.attribute
>>> @@patch.object(SomeClass, 'attribute', sentinel.attribute)
... def test():
...     assert SomeClass.attribute == sentinel.attribute
...
>>> test()
>>> assert SomeClass.attribute == original

>>> @@patch('package.module.attribute', sentinel.attribute)
... def test():
...     from package.module import attribute
...     assert attribute is sentinel.attribute
...
>>> test()
@end example

Si está parcheando un módulo (incluyendo @ref{13,,builtins}) entonces use @ref{f13,,patch()} en lugar de @ref{1596,,patch.object()}:

@example
>>> mock = MagicMock(return_value=sentinel.file_handle)
>>> with patch('builtins.open', mock):
...     handle = open('filename', 'r')
...
>>> mock.assert_called_with('filename', 'r')
>>> assert handle == sentinel.file_handle, "incorrect file handle returned"
@end example

EL nombre del módulo puede ser “dotted”, en el formulario @code{package.module} si es necesario:

@example
>>> @@patch('package.module.ClassName.attribute', sentinel.attribute)
... def test():
...     from package.module import ClassName
...     assert ClassName.attribute == sentinel.attribute
...
>>> test()
@end example

Un buen patrón en realidad es decorar los métodos de pruebas propios:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch.object(SomeClass, 'attribute', sentinel.attribute)
...     def test_something(self):
...         self.assertEqual(SomeClass.attribute, sentinel.attribute)
...
>>> original = SomeClass.attribute
>>> MyTest('test_something').test_something()
>>> assert SomeClass.attribute == original
@end example

Si desea parchear con un Mock, puede usar @ref{f13,,patch()} con un solo argumento (o @ref{1596,,patch.object()} con dos argumentos). El mock se creará para usted y se pasará a la función de prueba / método:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch.object(SomeClass, 'static_method')
...     def test_something(self, mock_method):
...         SomeClass.static_method()
...         mock_method.assert_called_with()
...
>>> MyTest('test_something').test_something()
@end example

Puede apilar varios decoradores de parches utilizando este patrón:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch('package.module.ClassName1')
...     @@patch('package.module.ClassName2')
...     def test_something(self, MockClass2, MockClass1):
...         self.assertIs(package.module.ClassName1, MockClass1)
...         self.assertIs(package.module.ClassName2, MockClass2)
...
>>> MyTest('test_something').test_something()
@end example

Al anidar decoradores de parches, los mocks se pasan a la función decorada en el mismo orden en que se aplicaron (el orden normal `Python' que se aplican los decoradores). Esto significa de abajo hacia arriba, así que en el ejemplo anterior el simulacro de @code{test_module.ClassName2} se pasa primero.

También está @ref{1605,,patch.dict()} para establecer valores en un diccionario solo durante un ámbito y restaurar el diccionario a su estado original cuando finaliza la prueba:

@example
>>> foo = @{'key': 'value'@}
>>> original = foo.copy()
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}, clear=True):
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> assert foo == original
@end example

@code{patch}, @code{patch.object} and @code{patch.dict} se pueden utilizar como gestores de contexto.

Donde utilice @ref{f13,,patch()} para crear un simulacro para usted, puede obtener una referencia al simulacro utilizando la forma «as» de la instrucción with:

@example
>>> class ProductionClass:
...     def method(self):
...         pass
...
>>> with patch.object(ProductionClass, 'method') as mock_method:
...     mock_method.return_value = None
...     real = ProductionClass()
...     real.method(1, 2, 3)
...
>>> mock_method.assert_called_with(1, 2, 3)
@end example

Como alternativa @code{patch}, @code{patch.object} and @code{patch.dict} se pueden utilizar como decoradores de clase. Cuando se utiliza de esta manera es lo mismo que aplicar el decorador individualmente a cada método cuyo nombre comienza con «test».

@node Otros ejemplos,,Decoradores de Parches,unittest mock — getting started
@anchor{library/unittest mock-examples further-examples}@anchor{4040}@anchor{library/unittest mock-examples id1}@anchor{4041}
@subsubsection Otros ejemplos


Estos son algunos ejemplos más para algunos escenarios ligeramente más avanzados.

@menu
* Mocking de llamadas encadenadas:: 
* Mocking parcial:: 
* Mocking de un método generador:: 
* Aplicar el mismo parche a cada método de prueba:: 
* Mocking de métodos sin enlazar:: 
* Comprobación de varias llamadas con mock:: 
* Copiando con argumentos mutables:: 
* Anidando parches:: 
* Mocking a un diccionario usando MagickMock:: 
* Mock de subclases y sus atributos:: 
* Importaciones de Mocking con patch.dict: Importaciones de Mocking con patch dict. 
* Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas:: 
* Coincidencia de argumentos más compleja:: 

@end menu

@node Mocking de llamadas encadenadas,Mocking parcial,,Otros ejemplos
@anchor{library/unittest mock-examples mocking-chained-calls}@anchor{4042}
@subsubsection Mocking de llamadas encadenadas


Mocking de las llamadas encadenadas es en realidad sencillo con mock una vez que entiende el atributo @ref{3fec,,return_value} . Cuando se llama a un mock por primera vez, o se obtiene su @code{return_value} antes de que se llame, se crea un nuevo @ref{ade,,Mock}.

Esto significa que puede ver cómo se ha utilizado el objeto devuelto de una llamada a un objeto simulado interrogando el simulado @code{return_value}:

@example
>>> mock = Mock()
>>> mock().foo(a=2, b=3)
<Mock name='mock().foo()' id='...'>
>>> mock.return_value.foo.assert_called_with(a=2, b=3)
@end example

Desde aquí es un paso simple para configurar y luego hacer aserciones sobre llamadas encadenadas. Por supuesto, otra alternativa es escribir su código de una manera más comprobable en primer lugar…

Por lo tanto, supongamos que tenemos algún código que se ve un poco como este:

@example
>>> class Something:
...     def __init__(self):
...         self.backend = BackendProvider()
...     def method(self):
...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
...         # more code
@end example

Suponiendo que @code{BackendProvider} ya está bien probado, ¿cómo probamos @code{method()}? En concreto, queremos probar que la sección de código @code{# more code} usa el objeto de respuesta de la manera correcta.

A medida que esta cadena de llamadas se realiza a partir de un atributo de instancia, podemos parchear el atributo @code{backend} en una instancia de @code{Something}. En este caso en particular sólo estamos interesados en el valor devuelto de la llamada final a @code{start_call} por lo que no tenemos mucha configuración que hacer. Supongamos que el objeto que devuelve es “similar a un archivo”, por lo que nos aseguraremos de que nuestro objeto de respuesta utilice el compilado @ref{1be,,open()} as its @code{spec}.

Para ello creamos una instancia mock como nuestro back-end simulado y creamos un objeto de respuesta mock para ella. Para establecer la respuesta como el valor devuelto de ese @code{start_call} final podríamos hacer lo siguiente:

@example
mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response
@end example

Podemos hacerlo de una manera un poco mejor usando el método @ref{3fed,,configure_mock()} para establecer directamente el valor devuelto para nosotros:

@example
>>> something = Something()
>>> mock_response = Mock(spec=open)
>>> mock_backend = Mock()
>>> config = @{'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response@}
>>> mock_backend.configure_mock(**config)
@end example

Con estos monkey patch el «backend simulado» en su lugar y puede hacer la llamada real:

@example
>>> something.backend = mock_backend
>>> something.method()
@end example

Usando @ref{3ff0,,mock_calls} podemos comprobar la llamada encadenada con una sola afirmación. Una llamada encadenada es varias llamadas en una línea de código, por lo que habrá varias entradas en @code{mock_calls}. Podemos usar @ref{4027,,call.call_list()} para crear esta lista de llamadas para nosotros:

@example
>>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
>>> call_list = chained.call_list()
>>> assert mock_backend.mock_calls == call_list
@end example

@node Mocking parcial,Mocking de un método generador,Mocking de llamadas encadenadas,Otros ejemplos
@anchor{library/unittest mock-examples partial-mocking}@anchor{4043}
@subsubsection Mocking parcial


En algunas pruebas quería un mock de una llamada a @ref{150a,,datetime.date.today()} para devolver una fecha conocida, pero no quería evitar que el código sometido a prueba creara nuevos objetos de fecha. Desafortunadamente @ref{330,,datetime.date} está escrito en C, por lo que no podía simplemente hacer un `monkey-patch' del método estático @ref{150a,,datetime.date.today()}.

Encontré una forma sencilla de hacer esto que implicaba ajustar eficazmente la clase date con un mock, pero pasar llamadas al constructor a la clase real (y devolver instancias reales).

El @ref{f13,,patch decorator} se utiliza aquí como un mock de la clase @code{date} en el módulo en pruebas. Entonces, el atributo @ref{3fe4,,side_effect} de la clase de fecha simulada se establece en una función lambda que devuelve una fecha real. Cuando la clase de fecha simulada es llamada, una fecha real se construirá y devolverá por @code{side_effect}.

@example
>>> from datetime import date
>>> with patch('mymodule.date') as mock_date:
...     mock_date.today.return_value = date(2010, 10, 8)
...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
...
...     assert mymodule.date.today() == date(2010, 10, 8)
...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)
@end example

Tenga en cuenta que no parcheamos @ref{330,,datetime.date} globalmente, parcheamos @code{date} en el módulo que `uses'. Consulte @ref{3fe5,,where to patch}.

Cuando @code{date.today()} es llamada se retorna una fecha conocida, pero llama al constructor @code{date(...)} este constructor todavía devuelve fechas normales. Sin esto, puede encontrarse teniendo que calcular un resultado esperado utilizando exactamente el mismo algoritmo que el código en prueba, que es un anti-patrón de prueba clásico.

Las llamadas al constructor de fecha se registran en los atributos @code{mock_date} (@code{call_count} y amigos) que también pueden ser útiles para las pruebas.

Una forma alternativa de tratar con fechas de mock, u otras clases integradas, se discute en esta entrada de blog@footnote{https://williambert.online/2011/07/how-to-unit-testing-in-django-with-mocking-and-patching/}.

@node Mocking de un método generador,Aplicar el mismo parche a cada método de prueba,Mocking parcial,Otros ejemplos
@anchor{library/unittest mock-examples mocking-a-generator-method}@anchor{4044}
@subsubsection Mocking de un método generador


Un generador de Python es una función o método que utiliza la instrucción @ref{a5f,,yield} para devolver una serie de valores cuando se itera sobre @footnote{
También hay expresiones generadoras y más usos avanzados <@indicateurl{http://www.dabeaz.com/coroutines/index.html}>”_ de generadores, pero no nos preocupan los que están aquí. Una muy buena introducción a los generadores y lo potentes que son es: @uref{http://www.dabeaz.com/generators/,Generator Tricks for Systems Programmers}.
}.

Se llama a un método / función del generador para devolver el objeto generador. Es el objeto generador que luego se itera. El método de protocolo para la iteración es @ref{1cc8,,__iter__()}, por lo que podemos hacer mock de esto usando una @ref{f12,,MagicMock}.

Aquí hay una clase de ejemplo con un método «iter» implementado como generador:

@example
>>> class Foo:
...     def iter(self):
...         for i in [1, 2, 3]:
...             yield i
...
>>> foo = Foo()
>>> list(foo.iter())
[1, 2, 3]
@end example

¿Cómo haríamos un mock de esta clase y, en particular, de su método «iter»?

Para configurar los valores devueltos desde la iteración (implícita en la llamada a @ref{18e,,list}), necesitamos configurar el objeto devuelto por la llamada a @code{foo.iter()}.

@example
>>> mock_foo = MagicMock()
>>> mock_foo.iter.return_value = iter([1, 2, 3])
>>> list(mock_foo.iter())
[1, 2, 3]
@end example

@node Aplicar el mismo parche a cada método de prueba,Mocking de métodos sin enlazar,Mocking de un método generador,Otros ejemplos
@anchor{library/unittest mock-examples applying-the-same-patch-to-every-test-method}@anchor{4045}
@subsubsection Aplicar el mismo parche a cada método de prueba


Si desea que se coloquen varias revisiones para varios métodos de prueba, la forma obvia es aplicar los decoradores de parches a cada método. Esto puede parecer una repetición innecesaria. En cambio, puede utilizar @ref{f13,,patch()} (en todas sus diversas formas) como decorador de clases. Esto aplica las revisiones a todos los métodos de prueba de la clase. Un método de prueba se identifica mediante métodos cuyos nombres comienzan con @code{test}:

@example
>>> @@patch('mymodule.SomeClass')
... class MyTest(unittest.TestCase):
...
...     def test_one(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def test_two(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def not_a_test(self):
...         return 'something'
...
>>> MyTest('test_one').test_one()
>>> MyTest('test_two').test_two()
>>> MyTest('test_two').not_a_test()
'something'
@end example

Una forma alternativa de administrar parches es usar @ref{4018,,métodos start y stop de patch}. Estos le permiten mover el parche en sus métodos @code{setUp} y @code{tearDown}.

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         self.patcher = patch('mymodule.foo')
...         self.mock_foo = self.patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
...     def tearDown(self):
...         self.patcher.stop()
...
>>> MyTest('test_foo').run()
@end example

Si utiliza esta técnica, debe asegurarse de que la aplicación de parches se «undone» llamando a @code{stop}. Esto puede ser más complicado de lo que podría pensar, porque si se produce una excepción en el setUp, no se llama a tearDown. @ref{b0e,,unittest.TestCase.addCleanup()} hace que esto sea más fácil:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         patcher = patch('mymodule.foo')
...         self.addCleanup(patcher.stop)
...         self.mock_foo = patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
>>> MyTest('test_foo').run()
@end example

@node Mocking de métodos sin enlazar,Comprobación de varias llamadas con mock,Aplicar el mismo parche a cada método de prueba,Otros ejemplos
@anchor{library/unittest mock-examples mocking-unbound-methods}@anchor{4046}
@subsubsection Mocking de métodos sin enlazar


Mientras escribía pruebas hoy en día, necesitaba parchear un método `unbound method' (parchear el método en la clase en lugar de en la instancia). Necesitaba que se pasara a sí mismo como primer argumento porque quiero hacer aserciones sobre qué objetos estaban llamando a este método en particular. El problema es que no se puede parchear con un mock para esto, porque si reemplaza un método independiente con un mock, no se convierte en un método enlazado cuando se obtiene de la instancia, por lo que no se pasa por sí mismo. La solución es revisar el método independiente con una función real en su lugar. El decorador @ref{f13,,patch()} hace que sea tan simple parchear métodos con un mock que tener que crear una función real se convierte en una molestia.

Si pasa @code{autospec=True} al parche, entonces hace el parche con un objeto de función `real'. Este objeto de función tiene la misma firma que el que está reemplazando, pero delega en un mock bajo el capó. Usted todavía consigue su mock de auto-creado exactamente de la misma manera que antes. Lo que significa, sin embargo, es que si lo usa para parchear un método independiente en una clase, la función simulada se convertirá en un método enlazado si se obtiene de una instancia. Tendrá @code{self} pasado como el primer argumento, que es exactamente lo que quería:

@example
>>> class Foo:
...   def foo(self):
...     pass
...
>>> with patch.object(Foo, 'foo', autospec=True) as mock_foo:
...   mock_foo.return_value = 'foo'
...   foo = Foo()
...   foo.foo()
...
'foo'
>>> mock_foo.assert_called_once_with(foo)
@end example

Si no usamos @code{autospec=True} entonces el método independiente se parchea con una instancia de Mock en su lugar, y no se llama con @code{self}.

@node Comprobación de varias llamadas con mock,Copiando con argumentos mutables,Mocking de métodos sin enlazar,Otros ejemplos
@anchor{library/unittest mock-examples checking-multiple-calls-with-mock}@anchor{4047}
@subsubsection Comprobación de varias llamadas con mock


mock tiene una buena API para hacer aserciones sobre cómo se usan sus objetos ficticios.

@example
>>> mock = Mock()
>>> mock.foo_bar.return_value = None
>>> mock.foo_bar('baz', spam='eggs')
>>> mock.foo_bar.assert_called_with('baz', spam='eggs')
@end example

Si su mock solo se llama una vez, puede usar el método @ref{3fee,,assert_called_once_with()} que también afirma que @ref{3ff7,,call_count} es uno.

@example
>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
>>> mock.foo_bar()
>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
Traceback (most recent call last):
    ...
AssertionError: Expected 'foo_bar' to be called once. Called 2 times.
Calls: [call('baz', spam='eggs'), call()].
@end example

Tanto @code{assert_called_with} como @code{assert_called_once_with} hacen afirmaciones sobre la llamada `más reciente'. Si su mock va a ser llamado varias veces, y desea hacer aserciones sobre `todas' esas llamadas que puede utilizar @ref{3ff8,,call_args_list}:

@example
>>> mock = Mock(return_value=None)
>>> mock(1, 2, 3)
>>> mock(4, 5, 6)
>>> mock()
>>> mock.call_args_list
[call(1, 2, 3), call(4, 5, 6), call()]
@end example

El helper @ref{19d7,,call} facilita la toma de aserciones sobre estas llamadas. Puede crear una lista de llamadas esperadas y compararla con @code{call_args_list}. Esto se ve notablemente similar al repr de la @code{call_args_list}:

@example
>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
>>> mock.call_args_list == expected
True
@end example

@node Copiando con argumentos mutables,Anidando parches,Comprobación de varias llamadas con mock,Otros ejemplos
@anchor{library/unittest mock-examples coping-with-mutable-arguments}@anchor{4048}
@subsubsection Copiando con argumentos mutables


Otra situación es rara, pero puede morderte, es cuando se llama a tu mock con argumentos mutables. @code{call_args} y @code{call_args_list} almacenan `referencias' a los argumentos. Si el código sometido a prueba muta los argumentos ya no puede realizar aserciones sobre cuáles eran los valores cuando se llamó al mock.

Este es un código de ejemplo que muestra el problema. Imagine las siguientes funciones definidas en “mymodule”:

@example
def frob(val):
    pass

def grob(val):
    "First frob and then clear val"
    frob(val)
    val.clear()
@end example

Cuando tratamos de probar que @code{grob} llama @code{frob} con el argumento correcto mira lo que sucede:

@example
>>> with patch('mymodule.frob') as mock_frob:
...     val = @{6@}
...     mymodule.grob(val)
...
>>> val
set()
>>> mock_frob.assert_called_with(@{6@})
Traceback (most recent call last):
    ...
AssertionError: Expected: ((@{6@},), @{@})
Called with: ((set(),), @{@})
@end example

Una posibilidad sería que el mock copiara los argumentos que pasa. Esto podría causar problemas si realiza aserciones que se basan en la identidad del objeto para la igualdad.

Aquí hay una solución que utiliza la funcionalidad @ref{3fe4,,side_effect}. Si proporciona una función @code{side_effect} para un mock, se llamará a @code{side_effect} con los mismos argumentos que el mock. Esto nos da la oportunidad de copiar los argumentos y almacenarlos para aserciones posteriores. En este ejemplo estoy usando `otro' mock para almacenar los argumentos de modo que pueda usar los métodos ficticios para hacer la aserción. Una vez más, una función auxiliar configura esto para mí.

@example
>>> from copy import deepcopy
>>> from unittest.mock import Mock, patch, DEFAULT
>>> def copy_call_args(mock):
...     new_mock = Mock()
...     def side_effect(*args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         new_mock(*args, **kwargs)
...         return DEFAULT
...     mock.side_effect = side_effect
...     return new_mock
...
>>> with patch('mymodule.frob') as mock_frob:
...     new_mock = copy_call_args(mock_frob)
...     val = @{6@}
...     mymodule.grob(val)
...
>>> new_mock.assert_called_with(@{6@})
>>> new_mock.call_args
call(@{6@})
@end example

@code{copy_call_args} se llama con el mock que se llamará. Devuelve un nuevo mock en el que hacemos la aserción. La función @code{side_effect} hace una copia de los args y llama a nuestro @code{new_mock} con la copia.

@cartouche
@quotation Nota 
Si su simulacro solo se va a usar una vez, hay una forma más fácil de verificar los argumentos en el punto en que se llaman. Simplemente puede hacer la comprobación dentro de una función @code{side_effect}.

@example
>>> def side_effect(arg):
...     assert arg == @{6@}
...
>>> mock = Mock(side_effect=side_effect)
>>> mock(@{6@})
>>> mock(set())
Traceback (most recent call last):
    ...
AssertionError
@end example
@end quotation
@end cartouche

Un enfoque alternativo es crear una subclase de @ref{ade,,Mock} o @ref{f12,,MagicMock} que copie (usando @ref{bf6,,copy.deepcopy()}) los argumentos. A continuación se muestra un ejemplo de implementación:

@example
>>> from copy import deepcopy
>>> class CopyingMock(MagicMock):
...     def __call__(self, /, *args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         return super().__call__(*args, **kwargs)
...
>>> c = CopyingMock(return_value=None)
>>> arg = set()
>>> c(arg)
>>> arg.add(1)
>>> c.assert_called_with(set())
>>> c.assert_called_with(arg)
Traceback (most recent call last):
    ...
AssertionError: expected call not found.
Expected: mock(@{1@})
Actual: mock(set())
>>> c.foo
<CopyingMock name='mock.foo' id='...'>
@end example

Cuando subclases @code{Mock} o @code{MagicMock} todos los atributos creados dinámicamente, y el @code{return_value} usará tu subclase automáticamente. Eso significa que todos los elementos secundarios de un @code{CopyingMock} también tendrán el tipo @code{CopyingMock}.

@node Anidando parches,Mocking a un diccionario usando MagickMock,Copiando con argumentos mutables,Otros ejemplos
@anchor{library/unittest mock-examples nesting-patches}@anchor{4049}
@subsubsection Anidando parches


Usar parches como administradores de contexto es bueno, pero si haces varios parches, puedes terminar con instrucciones anidadas que se sangran cada vez más a la derecha:

@example
>>> class MyTest(unittest.TestCase):
...
...     def test_foo(self):
...         with patch('mymodule.Foo') as mock_foo:
...             with patch('mymodule.Bar') as mock_bar:
...                 with patch('mymodule.Spam') as mock_spam:
...                     assert mymodule.Foo is mock_foo
...                     assert mymodule.Bar is mock_bar
...                     assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').test_foo()
>>> assert mymodule.Foo is original
@end example

Con las funciones unittest @code{cleanup} y @ref{4018,,métodos start y stop de patch} podemos lograr el mismo efecto sin la sangría anidada. Un método auxiliar simple, @code{create_patch}, pone el parche en su lugar y devuelve el mock creado para nosotros:

@example
>>> class MyTest(unittest.TestCase):
...
...     def create_patch(self, name):
...         patcher = patch(name)
...         thing = patcher.start()
...         self.addCleanup(patcher.stop)
...         return thing
...
...     def test_foo(self):
...         mock_foo = self.create_patch('mymodule.Foo')
...         mock_bar = self.create_patch('mymodule.Bar')
...         mock_spam = self.create_patch('mymodule.Spam')
...
...         assert mymodule.Foo is mock_foo
...         assert mymodule.Bar is mock_bar
...         assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').run()
>>> assert mymodule.Foo is original
@end example

@node Mocking a un diccionario usando MagickMock,Mock de subclases y sus atributos,Anidando parches,Otros ejemplos
@anchor{library/unittest mock-examples mocking-a-dictionary-with-magicmock}@anchor{404a}
@subsubsection Mocking a un diccionario usando MagickMock


Es posible que desee simular un diccionario u otro objeto contenedor, registrando todo el acceso a él mientras todavía se comporta como un diccionario.

Podemos hacer esto con @ref{f12,,MagicMock}, que se comportará como un diccionario, y usando @ref{3fe4,,side_effect} para delegar el acceso del diccionario a un diccionario subyacente real que está bajo nuestro control.

Cuando se llama a los métodos @ref{3d8,,__getitem__()} y @ref{1505,,__setitem__()} de nuestro @code{MagicMock} (acceso normal al diccionario), entonces se llama a @code{side_effect} con la clave (y el valor también en el caso de @code{__setitem__}). También podemos controlar lo que se devuelve.

Después de que se haya utilizado el @code{MagicMock} podemos usar atributos como @ref{3ff8,,call_args_list} para afirmar cómo se usó el diccionario:

@example
>>> my_dict = @{'a': 1, 'b': 2, 'c': 3@}
>>> def getitem(name):
...      return my_dict[name]
...
>>> def setitem(name, val):
...     my_dict[name] = val
...
>>> mock = MagicMock()
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem
@end example

@cartouche
@quotation Nota 
Una alternativa al uso de @code{MagicMock} es usar @code{Mock} y `solo' proporcionar los métodos mágicos que desea específicamente:

@example
>>> mock = Mock()
>>> mock.__getitem__ = Mock(side_effect=getitem)
>>> mock.__setitem__ = Mock(side_effect=setitem)
@end example

Una `tercera' opción es usar @code{MagicMock} pero pasando @code{dict} como el argumento `spec' (o `spec_set') para que el @code{MagicMock} creado solo tenga métodos mágicos de diccionario disponibles:

@example
>>> mock = MagicMock(spec_set=dict)
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem
@end example
@end quotation
@end cartouche

Con estas funciones de efectos secundarios en su lugar, el @code{mock} se comportará como un diccionario normal pero registrando el acceso. Incluso genera un @ref{438,,KeyError} si intenta acceder a una clave que no existe.

@example
>>> mock['a']
1
>>> mock['c']
3
>>> mock['d']
Traceback (most recent call last):
    ...
KeyError: 'd'
>>> mock['b'] = 'fish'
>>> mock['d'] = 'eggs'
>>> mock['b']
'fish'
>>> mock['d']
'eggs'
@end example

Una vez utilizado, puede realizar aserciones sobre el acceso utilizando los métodos y atributos mock normales:

@example
>>> mock.__getitem__.call_args_list
[call('a'), call('c'), call('d'), call('b'), call('d')]
>>> mock.__setitem__.call_args_list
[call('b', 'fish'), call('d', 'eggs')]
>>> my_dict
@{'a': 1, 'b': 'fish', 'c': 3, 'd': 'eggs'@}
@end example

@node Mock de subclases y sus atributos,Importaciones de Mocking con patch dict,Mocking a un diccionario usando MagickMock,Otros ejemplos
@anchor{library/unittest mock-examples mock-subclasses-and-their-attributes}@anchor{404b}
@subsubsection Mock de subclases y sus atributos


Hay varias razones por las que es posible que desee crear subclases @ref{ade,,Mock} Una razón podría ser agregar métodos auxiliares. Aquí hay un ejemplo simple:

@example
>>> class MyMock(MagicMock):
...     def has_been_called(self):
...         return self.called
...
>>> mymock = MyMock(return_value=None)
>>> mymock
<MyMock id='...'>
>>> mymock.has_been_called()
False
>>> mymock()
>>> mymock.has_been_called()
True
@end example

El comportamiento estándar para las instancias @code{Mock} es que los atributos y los simulacros de valor devuelto son del mismo tipo que el simulacro en el que se accede a ellos. Esto garantiza que los atributos @code{Mock} son @code{Mocks} y los atributos @code{MagicMock} son @code{MagicMocks} @footnote{
Una excepción a esta regla son los mock no invocables. Los atributos usan la variante a la que se puede llamar porque, de lo contrario, los simulacros a los que no se puede llamar no podrían tener métodos a los que se puede llamar.
}.  Por lo tanto, si está creando subclases para agregar métodos auxiliares, también estarán disponibles en los atributos y el valor devuelto mock de las instancias de su subclase.

@example
>>> mymock.foo
<MyMock name='mock.foo' id='...'>
>>> mymock.foo.has_been_called()
False
>>> mymock.foo()
<MyMock name='mock.foo()' id='...'>
>>> mymock.foo.has_been_called()
True
@end example

A veces esto es inconveniente. Por ejemplo, un usuario@footnote{https://code.google.com/archive/p/mock/issues/105} está creando subclases de mock para crear un Twisted adaptor@footnote{https://twisted.org/documents/11.0.0/api/twisted.python.components.html}. Tener esto aplicado a los atributos también puede causar errores en realidad.

@code{Mock} (en todos sus sabores) utiliza un método llamado @code{_get_child_mock} para crear estos «sub-mocks» para atributos y valores devueltos. Puede evitar que la subclase se utilice para los atributos invalidando este método. La firma es que toma argumentos de palabra clave arbitrarios (@code{**kwargs}) que luego se pasan al constructor ficticio:

@example
>>> class Subclass(MagicMock):
...     def _get_child_mock(self, /, **kwargs):
...         return MagicMock(**kwargs)
...
>>> mymock = Subclass()
>>> mymock.foo
<MagicMock name='mock.foo' id='...'>
>>> assert isinstance(mymock, Subclass)
>>> assert not isinstance(mymock.foo, Subclass)
>>> assert not isinstance(mymock(), Subclass)
@end example

@node Importaciones de Mocking con patch dict,Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas,Mock de subclases y sus atributos,Otros ejemplos
@anchor{library/unittest mock-examples mocking-imports-with-patch-dict}@anchor{404c}
@subsubsection Importaciones de Mocking con patch.dict


Una situación en la que un mocking puede ser difícil es cuando tiene una importación local dentro de una función. Estos son más difíciles de simular porque no están usando un objeto del espacio de nombres del módulo que podemos revisar.

Por lo general, deben evitarse las importaciones locales. A veces se hacen para evitar dependencias circulares, para las que hay `generalmente' una manera mucho mejor de resolver el problema (refactorizar el código) o para evitar «costos iniciales» retrasando la importación. Esto también se puede resolver de mejores maneras que una importación local incondicional (almacenar el módulo como una clase o atributo de módulo y solo hacer la importación en el primer uso).

Aparte de eso, hay una manera de usar @code{mock} para afectar los resultados de una importación. La importación obtiene un `objeto' del diccionario @ref{1976,,sys.modules}. Tenga en cuenta que obtiene un `objeto', que no tiene por qué ser un módulo. La importación de un módulo por primera vez da como resultado que un objeto de módulo se coloque en @code{sys.modules}, por lo que normalmente cuando importe algo devuelve un modulo. Sin embargo, este no tiene por qué ser el caso.

Esto significa que puede usar @ref{1605,,patch.dict()} para `temporalmente' poner un mock en su lugar sobre @ref{1976,,sys.modules}. Cualquier importación mientras este parche está activo recuperará el mock. Cuando el parche está completo (la función decorada sale, el cuerpo de la instrucción with está completo o se llama a @code{patcher.stop()}) entonces lo que había anteriormente se restaurará de forma segura.

Aquí hay un ejemplo de mock del módulo “fooble”.

@example
>>> import sys
>>> mock = Mock()
>>> with patch.dict('sys.modules', @{'fooble': mock@}):
...    import fooble
...    fooble.blob()
...
<Mock name='mock.blob()' id='...'>
>>> assert 'fooble' not in sys.modules
>>> mock.blob.assert_called_once_with()
@end example

Como puede ver, el @code{import fooble} tiene éxito, pero al salir no queda ningún “fooble” en @ref{1976,,sys.modules}.

Esto también funciona para el formulario @code{from module import name}:

@example
>>> mock = Mock()
>>> with patch.dict('sys.modules', @{'fooble': mock@}):
...    from fooble import blob
...    blob.blip()
...
<Mock name='mock.blob.blip()' id='...'>
>>> mock.blob.blip.assert_called_once_with()
@end example

Con un poco más de trabajo también puede simular las importaciones de paquetes:

@example
>>> mock = Mock()
>>> modules = @{'package': mock, 'package.module': mock.module@}
>>> with patch.dict('sys.modules', modules):
...    from package.module import fooble
...    fooble()
...
<Mock name='mock.module.fooble()' id='...'>
>>> mock.module.fooble.assert_called_once_with()
@end example

@node Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas,Coincidencia de argumentos más compleja,Importaciones de Mocking con patch dict,Otros ejemplos
@anchor{library/unittest mock-examples tracking-order-of-calls-and-less-verbose-call-assertions}@anchor{404d}
@subsubsection Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas


La clase @ref{ade,,Mock} le permite realizar un seguimiento del `orden' de las llamadas a métodos en sus objetos mock a través del atributo @ref{3ff2,,method_calls}. Esto no le permite rastrear el orden de las llamadas entre objetos simulados separados, sin embargo, podemos usar @ref{3ff0,,mock_calls} para lograr el mismo efecto.

Debido a que los mocks rastrean las llamadas a mocks secundarios en @code{mock_calls}, y el acceso a un atributo arbitrario de un mock crea un mock secundario, podemos crear nuestros mocks separados de uno primario. Las llamadas a esos mocks hijos se grabarán, en orden, en el @code{mock_calls} del padre:

@example
>>> manager = Mock()
>>> mock_foo = manager.foo
>>> mock_bar = manager.bar
@end example

@example
>>> mock_foo.something()
<Mock name='mock.foo.something()' id='...'>
>>> mock_bar.other.thing()
<Mock name='mock.bar.other.thing()' id='...'>
@end example

@example
>>> manager.mock_calls
[call.foo.something(), call.bar.other.thing()]
@end example

A continuación, podemos realizar afirmaciones sobre las llamadas, incluido el orden, comparando con el atributo @code{mock_calls} en el mock administrador:

@example
>>> expected_calls = [call.foo.something(), call.bar.other.thing()]
>>> manager.mock_calls == expected_calls
True
@end example

Si @code{patch} está creando y poniendo en su lugar, sus mocks, puede adjuntarlos a un mock administrador usando el método @ref{15f1,,attach_mock()} . Después de adjuntar las llamadas se registrarán en @code{mock_calls} del administrador.

@example
>>> manager = MagicMock()
>>> with patch('mymodule.Class1') as MockClass1:
...     with patch('mymodule.Class2') as MockClass2:
...         manager.attach_mock(MockClass1, 'MockClass1')
...         manager.attach_mock(MockClass2, 'MockClass2')
...         MockClass1().foo()
...         MockClass2().bar()
<MagicMock name='mock.MockClass1().foo()' id='...'>
<MagicMock name='mock.MockClass2().bar()' id='...'>
>>> manager.mock_calls
[call.MockClass1(),
call.MockClass1().foo(),
call.MockClass2(),
call.MockClass2().bar()]
@end example

Si se han realizado muchas llamadas, pero solo está interesado en una secuencia particular de ellas, entonces una alternativa es usar el método @ref{16b2,,assert_has_calls()} . Esto toma una lista de llamadas (construidas con el objeto @ref{19d7,,call}). Si esa secuencia de llamadas sobre @ref{3ff0,,mock_calls}, la aserción se realiza correctamente.

@example
>>> m = MagicMock()
>>> m().foo().bar().baz()
<MagicMock name='mock().foo().bar().baz()' id='...'>
>>> m.one().two().three()
<MagicMock name='mock.one().two().three()' id='...'>
>>> calls = call.one().two().three().call_list()
>>> m.assert_has_calls(calls)
@end example

Aunque la llamada encadenada @code{m.one().two().three()} no son las únicas llamadas que se han realizado al mock, la aserción aún tiene éxito.

A veces, un mock puede tener varias llamadas, y solo le interesa afirmar sobre `algunas' de esas llamadas. Puede que ni siquiera importe el pedido. En este caso, puede pasar @code{any_order=True} a @code{assert_has_calls}:

@example
>>> m = MagicMock()
>>> m(1), m.two(2, 3), m.seven(7), m.fifty('50')
(...)
>>> calls = [call.fifty('50'), call(1), call.seven(7)]
>>> m.assert_has_calls(calls, any_order=True)
@end example

@node Coincidencia de argumentos más compleja,,Seguimiento del orden de las llamadas y de las aserciones de llamadas menos detalladas,Otros ejemplos
@anchor{library/unittest mock-examples more-complex-argument-matching}@anchor{404e}
@subsubsection Coincidencia de argumentos más compleja


Usando el mismo concepto básico que @ref{19d5,,ANY} podemos implementar comparadores para hacer afirmaciones más complejas en objetos usados como argumentos para mocks.

Supongamos que esperamos que algún objeto se pase a un mock que, por defecto, se compara igual en función de la identidad del objeto (que es el valor predeterminado de Python para las clases definidas por el usuario). Para usar @ref{1a28,,assert_called_with()} tendríamos que pasar exactamente el mismo objeto. Si solo estamos interesados en algunos de los atributos de este objeto, podemos crear un comparador que verifique estos atributos por nosotros.

Puede ver en este ejemplo cómo una llamada “estándar” a @code{assert_called_with} no es suficiente:

@example
>>> class Foo:
...     def __init__(self, a, b):
...         self.a, self.b = a, b
...
>>> mock = Mock(return_value=None)
>>> mock(Foo(1, 2))
>>> mock.assert_called_with(Foo(1, 2))
Traceback (most recent call last):
    ...
AssertionError: expected call not found.
Expected: mock(<__main__.Foo object at 0x...>)
Actual: mock(<__main__.Foo object at 0x...>)
@end example

Una función de comparación para nuestra clase @code{Foo} podría verse así:

@example
>>> def compare(self, other):
...     if not type(self) == type(other):
...         return False
...     if self.a != other.a:
...         return False
...     if self.b != other.b:
...         return False
...     return True
...
@end example

Y un objeto comparador que puede usar funciones de comparación como esta para su operación de igualdad se vería así:

@example
>>> class Matcher:
...     def __init__(self, compare, some_obj):
...         self.compare = compare
...         self.some_obj = some_obj
...     def __eq__(self, other):
...         return self.compare(self.some_obj, other)
...
@end example

Poniendo todo esto junto:

@example
>>> match_foo = Matcher(compare, Foo(1, 2))
>>> mock.assert_called_with(match_foo)
@end example

El @code{Matcher} es instanciado con nuestra función de comparación y el objeto @code{Foo} con el que queremos comparar. En @code{assert_called_with} se llamará al método de igualdad @code{Matcher}, que compara el objeto con el que se llamó al mock con el que creamos nuestro matcher. Si coinciden, entonces pasa @code{assert_called_with}, y si no lo hacen, se lanzará un @ref{74a,,AssertionError}:

@example
>>> match_wrong = Matcher(compare, Foo(3, 4))
>>> mock.assert_called_with(match_wrong)
Traceback (most recent call last):
    ...
AssertionError: Expected: ((<Matcher object at 0x...>,), @{@})
Called with: ((<Foo object at 0x...>,), @{@})
@end example

Con un poco de ajuste, podría hacer que la función de comparación genere el @ref{74a,,AssertionError} directamente y proporcione un mensaje de falla más útil.

A partir de la versión 1.5, la biblioteca de pruebas de Python PyHamcrest@footnote{https://pyhamcrest.readthedocs.io/} proporciona una funcionalidad similar, que puede ser útil aquí, en la forma de su comparador de igualdad (hamcrest.library.integration.match_equality@footnote{https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality}).

@node test — Regression tests package for Python,test support — Utilidades para el conjunto de pruebas de Python,unittest mock — getting started,Herramientas de desarrollo
@anchor{library/test doc}@anchor{404f}@anchor{library/test module-test}@anchor{e2}@anchor{library/test test-regression-tests-package-for-python}@anchor{4050}
@subsection @code{test} — Regression tests package for Python


@geindex module; test

@cartouche
@quotation Nota 
El paquete @ref{e2,,test} está destinado solo para uso interno de Python. Está documentado para beneficio de los desarrolladores principales de Python. Se desaconseja el uso de este paquete fuera de la biblioteca estándar de Python, ya que el código mencionado aquí puede cambiar o eliminarse sin previo aviso entre versiones de Python.
@end quotation
@end cartouche


__________________________________________________________________


El paquete @ref{e2,,test} contiene todas las pruebas de regresión para Python, así como los módulos @ref{e4,,test.support} y @ref{e3,,test.regrtest}. Se utiliza @ref{e4,,test.support} para mejorar sus pruebas, mientras que @ref{e3,,test.regrtest} maneja el conjunto de pruebas.

Cada módulo en el paquete @ref{e2,,test} cuyo nombre comienza con @code{test_} es un conjunto de pruebas para un módulo o característica específica. Todas las pruebas nuevas deben escribirse usando el módulo @ref{106,,unittest} o @ref{3b,,doctest}. Algunas pruebas anteriores se escriben utilizando un estilo de prueba «tradicional» que compara la salida impresa con @code{sys.stdout}; este estilo de prueba se considera obsoleto.


@subsubheading Ver también



@table @asis

@item Módulo @ref{106,,unittest}

Escritura de pruebas de regresión de PyUnit.

@item Módulo @ref{3b,,doctest}

Pruebas integradas en cadenas de caracteres de documentación.
@end table


@menu
* Escritura de pruebas unitarias para el paquete test:: 
* Ejecución de pruebas utilizando la interfaz de línea de comandos:: 

@end menu

@node Escritura de pruebas unitarias para el paquete test,Ejecución de pruebas utilizando la interfaz de línea de comandos,,test — Regression tests package for Python
@anchor{library/test writing-tests}@anchor{4051}@anchor{library/test writing-unit-tests-for-the-test-package}@anchor{4052}
@subsubsection Escritura de pruebas unitarias para el paquete @code{test}


Se prefiere que las pruebas que utilizan el módulo @ref{106,,unittest} sigan algunas pautas. Una es nombrar el módulo de prueba comenzándolo con @code{test_} y terminarlo con el nombre del módulo que se está probando. Los métodos de prueba en el módulo de prueba deben comenzar con @code{test_} y terminar con una descripción de lo que el método está probando. Esto es necesario para que el controlador de prueba reconozca los métodos como métodos de prueba. Por lo tanto, no se debe incluir una cadena de caracteres de documentación para el método. Se debe usar un comentario (como @code{# Tests function returns only True or False}) para proporcionar documentación para los métodos de prueba. Esto se hace porque las cadenas de documentación se imprimen si existen y, por lo tanto, no se indica qué prueba se está ejecutando.

A menudo se usa una plantilla básica:

@example
import unittest
from test import support

class MyTestCase1(unittest.TestCase):

    # Only use setUp() and tearDown() if necessary

    def setUp(self):
        ... code to execute in preparation for tests ...

    def tearDown(self):
        ... code to execute to clean up after tests ...

    def test_feature_one(self):
        # Test feature one.
        ... testing code ...

    def test_feature_two(self):
        # Test feature two.
        ... testing code ...

    ... more test methods ...

class MyTestCase2(unittest.TestCase):
    ... same structure as MyTestCase1 ...

... more test classes ...

if __name__ == '__main__':
    unittest.main()
@end example

Este patrón de código permite que el conjunto de pruebas sea ejecutado por @ref{e3,,test.regrtest}, como un script que admite la CLI @ref{106,,unittest}, o mediante la CLI @code{python -m unittest}.

El objetivo de las pruebas de regresión es intentar romper el código. Esto lleva a algunas pautas a seguir:


@itemize *

@item 
El conjunto de pruebas debe ejercer todas las clases, funciones y constantes. Esto incluye no solo la API externa que se presentará al mundo exterior sino también el código «privado».

@item 
Se prefiere la prueba de caja blanca (examinar el código que se prueba cuando se escriben las pruebas). Las pruebas de caja negra (probar solo la interfaz de usuario publicada) no son lo suficientemente completas como para garantizar que se prueben todos los casos límite y límite.

@item 
Asegúrese de que todos los valores posibles son probados, incluidos los no válidos. Esto asegura que no solo todos los valores válidos sean aceptables, sino que los valores incorrectos se manejen correctamente.

@item 
Agote tantas rutas de código cómo sea posible. Pruebe donde se produce la ramificación y, por lo tanto, adapte la entrada para asegurarse de que se toman muchas rutas diferentes a través del código.

@item 
Añada una prueba explícita para cualquier error descubierto para el código probado. Esto asegurará que el error no vuelva a aparecer si el código se cambia en el futuro.

@item 
Asegúrese de limpiar después de sus pruebas (así como cerrar y eliminar todos los archivos temporales).

@item 
Si una prueba depende de una condición específica del sistema operativo, verifique que la condición ya existe antes de intentar la prueba.

@item 
Importe la menor cantidad de módulos posible y hágalo lo antes posible. Esto minimiza las dependencias externas de las pruebas y también minimiza el posible comportamiento anómalo de los efectos secundarios de importar un módulo.

@item 
Intente maximizar la reutilización del código. En ocasiones, las pruebas variarán en algo tan pequeño como qué tipo de entrada se utiliza. Minimice la duplicación de código usando como clase base una clase de prueba básica con una clase que especifique la entrada:

@example
class TestFuncAcceptsSequencesMixin:

    func = mySuperWhammyFunction

    def test_func(self):
        self.func(self.arg)

class AcceptLists(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = [1, 2, 3]

class AcceptStrings(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = 'abc'

class AcceptTuples(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = (1, 2, 3)
@end example

When using this pattern, remember that all classes that inherit from
@ref{4fa,,unittest.TestCase} are run as tests.  The @code{TestFuncAcceptsSequencesMixin} class in the example above
does not have any data and so can’t be run by itself, thus it does not
inherit from @ref{4fa,,unittest.TestCase}.
@end itemize


@subsubheading Ver también



@table @asis

@item Desarrollo dirigido por pruebas (`Test Driven Development')

Un libro de `Kent Beck' sobre pruebas de escritura antes del código.
@end table


@node Ejecución de pruebas utilizando la interfaz de línea de comandos,,Escritura de pruebas unitarias para el paquete test,test — Regression tests package for Python
@anchor{library/test module-test regrtest}@anchor{e3}@anchor{library/test regrtest}@anchor{1085}@anchor{library/test running-tests-using-the-command-line-interface}@anchor{4053}
@subsubsection Ejecución de pruebas utilizando la interfaz de línea de comandos


@geindex module; test.regrtest

El paquete @ref{e2,,test} puede ejecutarse como un script para controlar el conjunto de pruebas de regresión de Python, gracias a la opción @ref{187,,-m} :  @code{python -m test}. Internamente, se utiliza @ref{e3,,test.regrtest}; la llamada @code{python -m test.regrtest} utilizada en versiones anteriores de Python todavía funciona. Ejecuta el script por sí mismo automáticamente y comienza a ejecutar todas las pruebas de regresión en el paquete @code{test.regrtest. Lo hace buscando todos los módulos en el paquete cuyo nombre comienza con `@w{`}test_`}, importándolos y ejecutando la función @code{test_main()} si está presente o cargando las pruebas a través de `unittest.TestLoader.loadTestsFromModule' si @code{test_main} no existe. Los nombres de las pruebas a ejecutar también se pueden pasar al script. La especificación de una prueba de regresión única (@code{python -m test test_spam}) minimizará la salida y solo imprimirá si la prueba pasó o no.

Ejecutando @ref{e2,,test} directamente permite establecer qué recursos están disponibles para que se usen las pruebas. Para ello, use la opción de línea de comandos @code{-u}. Al especificar @code{all} como el valor para la opción @code{-u} se habilitan todos los recursos posibles: @code{python -m test -uall}. Si se desean todos los recursos menos uno (un caso más común), se puede enumerar una lista de recursos separados por comas que no se desean después de @code{all}. El comando @code{python -m test -uall,-audio,-largefile} ejecutará @ref{e2,,test} con todos los recursos excepto los recursos @code{audio} y @code{largefile}. Para obtener una lista de todos los recursos y más opciones de línea de comandos, ejecute @code{python -m test -h}.

Algunas otras formas de ejecutar las pruebas de regresión dependen de en qué plataforma se ejecuten las pruebas. En Unix, puede ejecutar @code{make test} en el directorio de nivel superior donde se construyó Python. En Windows, ejecutar @code{rt.bat} desde su directorio @code{PCbuild} ejecutará todas las pruebas de regresión.

@node test support — Utilidades para el conjunto de pruebas de Python,test support socket_helper — Utilidades para pruebas de socket,test — Regression tests package for Python,Herramientas de desarrollo
@anchor{library/test module-test support}@anchor{e4}@anchor{library/test test-support-utilities-for-the-python-test-suite}@anchor{4054}
@subsection @code{test.support} — Utilidades para el conjunto de pruebas de Python


@geindex module; test.support

El módulo @ref{e4,,test.support} proporciona soporte para el conjunto de pruebas de regresión de Python.

@cartouche
@quotation Nota 
@ref{e4,,test.support} no es un módulo público. Está documentado aquí para ayudar a los desarrolladores de Python a escribir pruebas. La API de este módulo está sujeta a cambios sin problemas de compatibilidad con versiones anteriores entre versiones.
@end quotation
@end cartouche

Este módulo define las siguientes excepciones:

@geindex TestFailed
@anchor{library/test test support TestFailed}@anchor{4055}
@deffn {Excepción} test.support.TestFailed

Excepción que se lanzará cuando una prueba falle. Está en desuso a favor de pruebas basadas en @ref{106,,unittest}y los métodos de aserción de @ref{4fa,,unittest.TestCase}.
@end deffn

@geindex ResourceDenied
@anchor{library/test test support ResourceDenied}@anchor{4056}
@deffn {Excepción} test.support.ResourceDenied

La subclase de @ref{1063,,unittest.SkipTest}. Se lanza cuando un recurso (como una conexión de red) no está disponible. Lanzado por la función @ref{4057,,requires()}.
@end deffn

El módulo @ref{e4,,test.support} define las siguientes constantes:

@geindex verbose (en el módulo test.support)
@anchor{library/test test support verbose}@anchor{4058}
@deffn {Dato} test.support.verbose

@code{True} cuando la salida detallada está habilitada. Debe verificarse cuando se desea información más detallada sobre una prueba en ejecución. `verbose' está establecido por @ref{e3,,test.regrtest}.
@end deffn

@geindex is_jython (en el módulo test.support)
@anchor{library/test test support is_jython}@anchor{4059}
@deffn {Dato} test.support.is_jython

@code{True} si el intérprete en ejecución es Jython.
@end deffn

@geindex is_android (en el módulo test.support)
@anchor{library/test test support is_android}@anchor{405a}
@deffn {Dato} test.support.is_android

@code{True} si el sistema es Android.
@end deffn

@geindex unix_shell (en el módulo test.support)
@anchor{library/test test support unix_shell}@anchor{405b}
@deffn {Dato} test.support.unix_shell

Ruta del shell si no está en Windows; de otra manera @code{None}.
@end deffn

@geindex LOOPBACK_TIMEOUT (en el módulo test.support)
@anchor{library/test test support LOOPBACK_TIMEOUT}@anchor{19bd}
@deffn {Dato} test.support.LOOPBACK_TIMEOUT

Tiempo de espera en segundos para las pruebas que utilizan un servidor de red que escucha en la interfaz local de loopback de la red como @code{127.0.0.1}.

El tiempo de espera es lo suficientemente largo para evitar el fracaso de la prueba: tiene en cuenta que el cliente y el servidor pueden ejecutarse en diferentes hilos o incluso en diferentes procesos.

El tiempo de espera debe ser lo suficientemente largo para los métodos @ref{e29,,connect()}, @ref{e2a,,recv()} y @ref{e2d,,send()} de @ref{e27,,socket.socket}.

Su valor por defecto es de 5 segundos.

Ver también @ref{19be,,INTERNET_TIMEOUT}.
@end deffn

@geindex INTERNET_TIMEOUT (en el módulo test.support)
@anchor{library/test test support INTERNET_TIMEOUT}@anchor{19be}
@deffn {Dato} test.support.INTERNET_TIMEOUT

Tiempo de espera en segundos para las solicitudes de red que van a Internet.

El tiempo de espera es lo suficientemente corto como para evitar que una prueba espere demasiado tiempo si la solicitud de Internet se bloquea por cualquier motivo.

Normalmente, un tiempo de espera utilizando @ref{19be,,INTERNET_TIMEOUT} no debería marcar una prueba como fallida, sino que debería omitir la prueba: ver @ref{405c,,transient_internet()}.

Su valor por defecto es de 1 minuto.

Ver también @ref{19bd,,LOOPBACK_TIMEOUT}.
@end deffn

@geindex SHORT_TIMEOUT (en el módulo test.support)
@anchor{library/test test support SHORT_TIMEOUT}@anchor{18b7}
@deffn {Dato} test.support.SHORT_TIMEOUT

Tiempo de espera en segundos para marcar una prueba como fallida si la prueba tarda «demasiado».

El valor del tiempo de espera depende de la opción de línea de comandos regrtest @code{--timeout}.

Si una prueba que utiliza @ref{18b7,,SHORT_TIMEOUT} empieza a fallar aleatoriamente en buildbots lentos, utilice en su lugar @ref{19bf,,LONG_TIMEOUT}.

Su valor por defecto es de 30 segundos.
@end deffn

@geindex LONG_TIMEOUT (en el módulo test.support)
@anchor{library/test test support LONG_TIMEOUT}@anchor{19bf}
@deffn {Dato} test.support.LONG_TIMEOUT

Tiempo de espera en segundos para detectar cuando se cuelga una prueba.

Es lo suficientemente largo como para reducir el riesgo de fracaso de la prueba en los buildbots de Python más lentos. No debe utilizarse para marcar una prueba como fallida si la prueba tarda «demasiado».  El valor del tiempo de espera depende de la opción de línea de comandos regrtest @code{--timeout}.

Su valor por defecto es de 5 minutos.

Ver también @ref{19bd,,LOOPBACK_TIMEOUT}, @ref{19be,,INTERNET_TIMEOUT} y @ref{18b7,,SHORT_TIMEOUT}.
@end deffn

@geindex PGO (en el módulo test.support)
@anchor{library/test test support PGO}@anchor{405d}
@deffn {Dato} test.support.PGO

Establecido cuando se pueden omitir las pruebas cuando no son útiles para `PGO'.
@end deffn

@geindex PIPE_MAX_SIZE (en el módulo test.support)
@anchor{library/test test support PIPE_MAX_SIZE}@anchor{405e}
@deffn {Dato} test.support.PIPE_MAX_SIZE

Una constante que probablemente sea más grande que el tamaño del búfer de la tubería (`pipe') del sistema operativo subyacente, para bloquear las escrituras.
@end deffn

@geindex Py_DEBUG (en el módulo test.support)
@anchor{library/test test support Py_DEBUG}@anchor{405f}
@deffn {Dato} test.support.Py_DEBUG

@code{True} if Python was built with the @ref{4060,,Py_DEBUG} macro
defined, that is, if
Python was @ref{357,,built in debug mode}.


Added in version 3.12.

@end deffn

@geindex SOCK_MAX_SIZE (en el módulo test.support)
@anchor{library/test test support SOCK_MAX_SIZE}@anchor{4061}
@deffn {Dato} test.support.SOCK_MAX_SIZE

Una constante que probablemente sea más grande que el tamaño del búfer del socket del sistema operativo subyacente para bloquear las escrituras.
@end deffn

@geindex TEST_SUPPORT_DIR (en el módulo test.support)
@anchor{library/test test support TEST_SUPPORT_DIR}@anchor{4062}
@deffn {Dato} test.support.TEST_SUPPORT_DIR

Establecido en el directorio de nivel superior que contiene @ref{e4,,test.support}.
@end deffn

@geindex TEST_HOME_DIR (en el módulo test.support)
@anchor{library/test test support TEST_HOME_DIR}@anchor{4063}
@deffn {Dato} test.support.TEST_HOME_DIR

Establecido en el directorio de nivel superior para el paquete de prueba.
@end deffn

@geindex TEST_DATA_DIR (en el módulo test.support)
@anchor{library/test test support TEST_DATA_DIR}@anchor{4064}
@deffn {Dato} test.support.TEST_DATA_DIR

Establecido en el directorio @code{data} dentro del paquete de prueba.
@end deffn

@geindex MAX_Py_ssize_t (en el módulo test.support)
@anchor{library/test test support MAX_Py_ssize_t}@anchor{4065}
@deffn {Dato} test.support.MAX_Py_ssize_t

Establecido @ref{1232,,sys.maxsize} para pruebas de gran memoria.
@end deffn

@geindex max_memuse (en el módulo test.support)
@anchor{library/test test support max_memuse}@anchor{4066}
@deffn {Dato} test.support.max_memuse

Establecido por @ref{4067,,set_memlimit()} como límite de memoria para pruebas de memoria grande. Limitado por @ref{4065,,MAX_Py_ssize_t}.
@end deffn

@geindex real_max_memuse (en el módulo test.support)
@anchor{library/test test support real_max_memuse}@anchor{4068}
@deffn {Dato} test.support.real_max_memuse

Establecido por @ref{4067,,set_memlimit()} como límite de memoria para pruebas de memoria grande. No limitado por @ref{4065,,MAX_Py_ssize_t}.
@end deffn

@geindex MISSING_C_DOCSTRINGS (en el módulo test.support)
@anchor{library/test test support MISSING_C_DOCSTRINGS}@anchor{4069}
@deffn {Dato} test.support.MISSING_C_DOCSTRINGS

Vale @code{True} si Python se construye sin cadenas de documentos (la macro @code{WITH_DOC_STRINGS} no está definida). Consulte la opción @ref{1db4,,configure --without-doc-strings}.

Consulte también la variable @ref{406a,,HAVE_DOCSTRINGS}.
@end deffn

@geindex HAVE_DOCSTRINGS (en el módulo test.support)
@anchor{library/test test support HAVE_DOCSTRINGS}@anchor{406a}
@deffn {Dato} test.support.HAVE_DOCSTRINGS

Vale @code{True} si las cadenas de documentación de la función están disponibles. Consulte la opción @ref{14f,,python -OO}, que elimina las cadenas de documentación de las funciones implementadas en Python.

Consulte también la variable @ref{4069,,MISSING_C_DOCSTRINGS}.
@end deffn

@geindex TEST_HTTP_URL (en el módulo test.support)
@anchor{library/test test support TEST_HTTP_URL}@anchor{406b}
@deffn {Dato} test.support.TEST_HTTP_URL

Define la URL de un servidor HTTP dedicado para las pruebas de red.
@end deffn

@geindex ALWAYS_EQ (en el módulo test.support)
@anchor{library/test test support ALWAYS_EQ}@anchor{406c}
@deffn {Dato} test.support.ALWAYS_EQ

Objeto que es igual a cualquier cosa. Se utiliza para probar la comparación de tipos mixtos.
@end deffn

@geindex NEVER_EQ (en el módulo test.support)
@anchor{library/test test support NEVER_EQ}@anchor{406d}
@deffn {Dato} test.support.NEVER_EQ

Objeto que no es igual a nada (incluso a @ref{406c,,ALWAYS_EQ}). Se utiliza para probar la comparación de tipos mixtos.
@end deffn

@geindex LARGEST (en el módulo test.support)
@anchor{library/test test support LARGEST}@anchor{406e}
@deffn {Dato} test.support.LARGEST

Objeto que es mayor que cualquier cosa (excepto a sí mismo). Se utiliza para probar la comparación de tipos mixtos.
@end deffn

@geindex SMALLEST (en el módulo test.support)
@anchor{library/test test support SMALLEST}@anchor{406f}
@deffn {Dato} test.support.SMALLEST

Objeto que es menor que cualquier cosa (excepto él mismo). Se utiliza para probar la comparación de tipos mixtos.
@end deffn

El módulo @ref{e4,,test.support} define las siguientes funciones:

@geindex busy_retry() (en el módulo test.support)
@anchor{library/test test support busy_retry}@anchor{4070}
@deffn {Función} test.support.busy_retry (timeout, err_msg=None, /, *, error=True)

Run the loop body until @code{break} stops the loop.

After `timeout' seconds, raise an @ref{74a,,AssertionError} if `error' is true,
or just stop the loop if `error' is false.

Example:

@example
for _ in support.busy_retry(support.SHORT_TIMEOUT):
    if check():
        break
@end example

Example of error=False usage:

@example
for _ in support.busy_retry(support.SHORT_TIMEOUT, error=False):
    if check():
        break
else:
    raise RuntimeError('my custom error')
@end example
@end deffn

@geindex sleeping_retry() (en el módulo test.support)
@anchor{library/test test support sleeping_retry}@anchor{4071}
@deffn {Función} test.support.sleeping_retry (timeout, err_msg=None, /, *, init_delay=0.010, max_delay=1.0, error=True)

Wait strategy that applies exponential backoff.

Run the loop body until @code{break} stops the loop. Sleep at each loop
iteration, but not at the first iteration. The sleep delay is doubled at
each iteration (up to `max_delay' seconds).

See @ref{4070,,busy_retry()} documentation for the parameters usage.

Example raising an exception after SHORT_TIMEOUT seconds:

@example
for _ in support.sleeping_retry(support.SHORT_TIMEOUT):
    if check():
        break
@end example

Example of error=False usage:

@example
for _ in support.sleeping_retry(support.SHORT_TIMEOUT, error=False):
    if check():
        break
else:
    raise RuntimeError('my custom error')
@end example
@end deffn

@geindex is_resource_enabled() (en el módulo test.support)
@anchor{library/test test support is_resource_enabled}@anchor{4072}
@deffn {Función} test.support.is_resource_enabled (resource)

Retorna @code{True} si `resource' está habilitado y disponible. La lista de recursos disponibles solo se establece cuando @ref{e3,,test.regrtest} está ejecutando las pruebas.
@end deffn

@geindex python_is_optimized() (en el módulo test.support)
@anchor{library/test test support python_is_optimized}@anchor{4073}
@deffn {Función} test.support.python_is_optimized ()

Retorna @code{True} si Python no fue construido con @code{-O0} o @code{-Og}.
@end deffn

@geindex with_pymalloc() (en el módulo test.support)
@anchor{library/test test support with_pymalloc}@anchor{4074}
@deffn {Función} test.support.with_pymalloc ()

Return @code{_testcapi.WITH_PYMALLOC}.
@end deffn

@geindex requires() (en el módulo test.support)
@anchor{library/test test support requires}@anchor{4057}
@deffn {Función} test.support.requires (resource, msg=None)

Lanza @ref{4056,,ResourceDenied} si `resource' no está disponible. `msg' es el argumento para @ref{4056,,ResourceDenied} si se lanza. Siempre retorna @code{True} si es invocado por una función cuyo @code{__name__} es @code{'__main__'}. Se usa cuando se ejecutan pruebas por @ref{e3,,test.regrtest}.
@end deffn

@geindex sortdict() (en el módulo test.support)
@anchor{library/test test support sortdict}@anchor{4075}
@deffn {Función} test.support.sortdict (dict)

Retorna una representación del `diccionario' con las claves ordenadas.
@end deffn

@geindex findfile() (en el módulo test.support)
@anchor{library/test test support findfile}@anchor{4076}
@deffn {Función} test.support.findfile (filename, subdir=None)

Retorna la ruta al archivo llamado `filename'. Si no se encuentra ninguna coincidencia, se retorna `filename'. Esto no equivale a un fallo, ya que podría ser la ruta al archivo.

La configuración `subdir' indica una ruta relativa a utilizar para encontrar el archivo en lugar de buscar directamente en los directorios de ruta.
@end deffn

@geindex get_pagesize() (en el módulo test.support)
@anchor{library/test test support get_pagesize}@anchor{4077}
@deffn {Función} test.support.get_pagesize ()

Get size of a page in bytes.


Added in version 3.12.

@end deffn

@geindex setswitchinterval() (en el módulo test.support)
@anchor{library/test test support setswitchinterval}@anchor{4078}
@deffn {Función} test.support.setswitchinterval (interval)

Establecido @ref{9dd,,sys.setswitchinterval()} en el `intervalo' dado. Define un intervalo mínimo para los sistemas Android para evitar que el sistema se cuelgue.
@end deffn

@geindex check_impl_detail() (en el módulo test.support)
@anchor{library/test test support check_impl_detail}@anchor{4079}
@deffn {Función} test.support.check_impl_detail (**guards)

Use esta verificación para proteger las pruebas específicas de implementación de CPython o para ejecutarlas solo en las implementaciones protegidas por los argumentos. Esta función retorna @code{True} o @code{False} según la plataforma del host. Ejemplo de uso:

@example
check_impl_detail()               # Only on CPython (default).
check_impl_detail(jython=True)    # Only on Jython.
check_impl_detail(cpython=False)  # Everywhere except CPython.
@end example
@end deffn

@geindex set_memlimit() (en el módulo test.support)
@anchor{library/test test support set_memlimit}@anchor{4067}
@deffn {Función} test.support.set_memlimit (limit)

Establece los valores para @ref{4066,,max_memuse} y @ref{4068,,real_max_memuse} para pruebas de memoria grande.
@end deffn

@geindex record_original_stdout() (en el módulo test.support)
@anchor{library/test test support record_original_stdout}@anchor{407a}
@deffn {Función} test.support.record_original_stdout (stdout)

Almacene el valor de `stdout'. Está destinado a mantener el `stdout' en el momento en que comenzó el regrtest.
@end deffn

@geindex get_original_stdout() (en el módulo test.support)
@anchor{library/test test support get_original_stdout}@anchor{407b}
@deffn {Función} test.support.get_original_stdout ()

Retorna el `stdout' original establecido por @ref{407a,,record_original_stdout()} o @code{sys.stdout} si no está configurado.
@end deffn

@geindex args_from_interpreter_flags() (en el módulo test.support)
@anchor{library/test test support args_from_interpreter_flags}@anchor{407c}
@deffn {Función} test.support.args_from_interpreter_flags ()

Retorna una lista de argumentos de línea de comandos que reproducen la configuración actual en @code{sys.flags} y @code{sys.warnoptions}.
@end deffn

@geindex optim_args_from_interpreter_flags() (en el módulo test.support)
@anchor{library/test test support optim_args_from_interpreter_flags}@anchor{407d}
@deffn {Función} test.support.optim_args_from_interpreter_flags ()

Retorna una lista de argumentos de línea de comandos que reproducen la configuración de optimización actual en @code{sys.flags}.
@end deffn

@geindex captured_stdin() (en el módulo test.support)
@geindex captured_stdout() (en el módulo test.support)
@geindex captured_stderr() (en el módulo test.support)
@anchor{library/test test support captured_stdin}@anchor{407e}
@deffn {Función} test.support.captured_stdin ()
@anchor{library/test test support captured_stdout}@anchor{407f}
@deffnx {Función} test.support.captured_stdout ()
@anchor{library/test test support captured_stderr}@anchor{19fe}
@deffnx {Función} test.support.captured_stderr ()

Un administrador de contexto que reemplaza temporalmente la secuencia nombrada con un objeto @ref{fa9,,io.StringIO}.

Ejemplo de uso con flujos de salida:

@example
with captured_stdout() as stdout, captured_stderr() as stderr:
    print("hello")
    print("error", file=sys.stderr)
assert stdout.getvalue() == "hello\n"
assert stderr.getvalue() == "error\n"
@end example

Ejemplo de uso con flujo de entrada:

@example
with captured_stdin() as stdin:
    stdin.write('hello\n')
    stdin.seek(0)
    # call test code that consumes from sys.stdin
    captured = input()
self.assertEqual(captured, "hello")
@end example
@end deffn

@geindex disable_faulthandler() (en el módulo test.support)
@anchor{library/test test support disable_faulthandler}@anchor{4080}
@deffn {Función} test.support.disable_faulthandler ()

Un administrador de contexto que deshabilita temporalmente @ref{58,,faulthandler}.
@end deffn

@geindex gc_collect() (en el módulo test.support)
@anchor{library/test test support gc_collect}@anchor{4081}
@deffn {Función} test.support.gc_collect ()

Se fuerza la mayor cantidad posible de objetos para ser recolectados. Esto es necesario porque el recolector de basura no garantiza la desasignación oportuna. Esto significa que los métodos @code{__del__} pueden llamarse más tarde de lo esperado y las referencias débiles pueden permanecer vivas por más tiempo de lo esperado.
@end deffn

@geindex disable_gc() (en el módulo test.support)
@anchor{library/test test support disable_gc}@anchor{4082}
@deffn {Función} test.support.disable_gc ()

Un administrador de contexto que deshabilita el recolector de basura al entrar. Al salir, el recolector de basura se restaura a su estado anterior.
@end deffn

@geindex swap_attr() (en el módulo test.support)
@anchor{library/test test support swap_attr}@anchor{4083}
@deffn {Función} test.support.swap_attr (obj, attr, new_val)

Administrador de contexto para intercambiar un atributo con un nuevo objeto.

Uso:

@example
with swap_attr(obj, "attr", 5):
    ...
@end example

Esto establecerá @code{obj.attr} en 5 durante la duración del bloque @code{with}, restaurando el valor anterior al final del bloque. Si @code{attr} no existe en @code{obj}, se creará y luego se eliminará al final del bloque.

El valor anterior (o @code{None} si no existe) se asignará al objetivo de la cláusula «como», si existe.
@end deffn

@geindex swap_item() (en el módulo test.support)
@anchor{library/test test support swap_item}@anchor{4084}
@deffn {Función} test.support.swap_item (obj, attr, new_val)

Administrador de contexto para intercambiar un elemento con un nuevo objeto.

Uso:

@example
with swap_item(obj, "item", 5):
    ...
@end example

Esto establecerá @code{obj ["item"]} a 5 durante la duración del bloque @code{with}, restaurando el valor anterior al final del bloque. Si @code{item} no existe en @code{obj}, se creará y luego se eliminará al final del bloque.

El valor anterior (o @code{None} si no existe) se asignará al objetivo de la cláusula «como», si existe.
@end deffn

@geindex flush_std_streams() (en el módulo test.support)
@anchor{library/test test support flush_std_streams}@anchor{4085}
@deffn {Función} test.support.flush_std_streams ()

Llama al método @code{flush()} en @ref{b61,,sys.stdout} y luego en @ref{9cc,,sys.stderr}. Se puede usar para asegurarse de que el orden de los registros sea consistente antes de escribir en stderr.


Added in version 3.11.

@end deffn

@geindex print_warning() (en el módulo test.support)
@anchor{library/test test support print_warning}@anchor{4086}
@deffn {Función} test.support.print_warning (msg)

Imprime una advertencia en @ref{4087,,sys.__stderr__}. Formatea el mensaje como: @code{f "Warning -- @{msg@}"}. Si `msg' se compone de varias líneas, añade el prefijo @code{"Warning --"} a cada línea.


Added in version 3.9.

@end deffn

@geindex wait_process() (en el módulo test.support)
@anchor{library/test test support wait_process}@anchor{197d}
@deffn {Función} test.support.wait_process (pid, *, exitcode, timeout=None)

Espere hasta que el proceso `pid' termine y comprobará que el código de salida del proceso es `exitcode'.

Lanza un @ref{74a,,AssertionError} si el código de salida del proceso no es igual a `exitcode'.

Si el proceso se ejecuta durante más tiempo que `timeout' en segundos (@ref{18b7,,SHORT_TIMEOUT} por defecto), mata el proceso y lanza un @ref{74a,,AssertionError}. La función de tiempo de espera no está disponible en Windows.


Added in version 3.9.

@end deffn

@geindex calcobjsize() (en el módulo test.support)
@anchor{library/test test support calcobjsize}@anchor{4088}
@deffn {Función} test.support.calcobjsize (fmt)

Retorna el tamaño del @ref{42d,,PyObject} cuyos miembros de estructura están definidos por `fmt'. El valor retornado incluye el tamaño del encabezado y la alineación del objeto de Python.
@end deffn

@geindex calcvobjsize() (en el módulo test.support)
@anchor{library/test test support calcvobjsize}@anchor{4089}
@deffn {Función} test.support.calcvobjsize (fmt)

Retorna el tamaño del @ref{408a,,PyVarObject} cuyos miembros de estructura están definidos por `fmt'. El valor retornado incluye el tamaño del encabezado y la alineación del objeto de Python.
@end deffn

@geindex checksizeof() (en el módulo test.support)
@anchor{library/test test support checksizeof}@anchor{408b}
@deffn {Función} test.support.checksizeof (test, o, size)

Para el caso de prueba (`testcase'), se aserciona que el @code{sys.getsizeof} para `o' más el tamaño del encabezado `GC' es igual a `size'.
@end deffn

@geindex anticipate_failure() (en el módulo test.support)
@anchor{library/test test support anticipate_failure}@anchor{408c}
@deffn {Función} @@test.support.anticipate_failure (condition)

Un decorador para marcar condicionalmente las pruebas con @ref{3fa2,,unittest.expectedFailure()}. Cualquier uso de este decorador debe tener un comentario asociado que identifique el problema relevante del rastreador.
@end deffn

@geindex system_must_validate_cert() (en el módulo test.support)
@anchor{library/test test support system_must_validate_cert}@anchor{408d}
@deffn {Función} test.support.system_must_validate_cert (f)

Un decorador que se salta la prueba decorada en los errores de validación de la certificación TLS.
@end deffn

@geindex run_with_locale() (en el módulo test.support)
@anchor{library/test test support run_with_locale}@anchor{408e}
@deffn {Función} @@test.support.run_with_locale (catstr, *locales)

Un decorador para ejecutar una función en una configuración regional diferente, restableciéndola correctamente una vez que ha finalizado. `catstr' es la categoría de configuración regional como una cadena (por ejemplo, @code{"LC_ALL"}). Las `locales' aprobadas se probarán secuencialmente y se utilizará la primera configuración regional válida.
@end deffn

@geindex run_with_tz() (en el módulo test.support)
@anchor{library/test test support run_with_tz}@anchor{408f}
@deffn {Función} @@test.support.run_with_tz (tz)

Un decorador para ejecutar una función en una zona horaria específica, restableciéndola correctamente una vez que haya finalizado.
@end deffn

@geindex requires_freebsd_version() (en el módulo test.support)
@anchor{library/test test support requires_freebsd_version}@anchor{4090}
@deffn {Función} @@test.support.requires_freebsd_version (*min_version)

Decorador para la versión mínima cuando se ejecuta la prueba en FreeBSD. Si la versión de FreeBSD es inferior a la mínima, se salta la prueba.
@end deffn

@geindex requires_linux_version() (en el módulo test.support)
@anchor{library/test test support requires_linux_version}@anchor{4091}
@deffn {Función} @@test.support.requires_linux_version (*min_version)

Decorador para la versión mínima cuando se ejecuta la prueba en Linux. Si la versión de Linux es inferior a la mínima, se omite la prueba.
@end deffn

@geindex requires_mac_version() (en el módulo test.support)
@anchor{library/test test support requires_mac_version}@anchor{4092}
@deffn {Función} @@test.support.requires_mac_version (*min_version)

Decorador para la versión mínima cuando se ejecuta la prueba en macOS. Si la versión de macOS es inferior a la mínima, se omite la prueba.
@end deffn

@geindex requires_gil_enabled() (en el módulo test.support)
@anchor{library/test test support requires_gil_enabled}@anchor{4093}
@deffn {Función} @@test.support.requires_gil_enabled

Decorator for skipping tests on the free-threaded build.  If the
@ref{2c5,,GIL} is disabled, the test is skipped.
@end deffn

@geindex requires_IEEE_754() (en el módulo test.support)
@anchor{library/test test support requires_IEEE_754}@anchor{4094}
@deffn {Función} @@test.support.requires_IEEE_754

Decorador para omitir pruebas en plataformas que no son `IEEE 754'.
@end deffn

@geindex requires_zlib() (en el módulo test.support)
@anchor{library/test test support requires_zlib}@anchor{4095}
@deffn {Función} @@test.support.requires_zlib

Decorador para omitir pruebas si @ref{132,,zlib} no existe.
@end deffn

@geindex requires_gzip() (en el módulo test.support)
@anchor{library/test test support requires_gzip}@anchor{4096}
@deffn {Función} @@test.support.requires_gzip

Decorador para omitir pruebas si @ref{67,,gzip} no existe.
@end deffn

@geindex requires_bz2() (en el módulo test.support)
@anchor{library/test test support requires_bz2}@anchor{4097}
@deffn {Función} @@test.support.requires_bz2

Decorador para omitir pruebas si @ref{14,,bz2} no existe.
@end deffn

@geindex requires_lzma() (en el módulo test.support)
@anchor{library/test test support requires_lzma}@anchor{4098}
@deffn {Función} @@test.support.requires_lzma

Decorador para omitir pruebas si @ref{8a,,lzma} no existe.
@end deffn

@geindex requires_resource() (en el módulo test.support)
@anchor{library/test test support requires_resource}@anchor{4099}
@deffn {Función} @@test.support.requires_resource (resource)

Decorador para omitir pruebas si `resource' no está disponible.
@end deffn

@geindex requires_docstrings() (en el módulo test.support)
@anchor{library/test test support requires_docstrings}@anchor{409a}
@deffn {Función} @@test.support.requires_docstrings

Decorador para ejecutar solo la prueba si @ref{406a,,HAVE_DOCSTRINGS}.
@end deffn

@geindex requires_limited_api() (en el módulo test.support)
@anchor{library/test test support requires_limited_api}@anchor{409b}
@deffn {Función} @@test.support.requires_limited_api

Decorator for only running the test if @ref{488,,Limited C API}
is available.
@end deffn

@geindex cpython_only() (en el módulo test.support)
@anchor{library/test test support cpython_only}@anchor{409c}
@deffn {Función} @@test.support.cpython_only

Decorador para pruebas solo aplicable a CPython.
@end deffn

@geindex impl_detail() (en el módulo test.support)
@anchor{library/test test support impl_detail}@anchor{409d}
@deffn {Función} @@test.support.impl_detail (msg=None, **guards)

Decorador para invocar @ref{4079,,check_impl_detail()} en `guards'. Si eso retorna @code{False}, entonces usa `msg' como la razón para omitir la prueba.
@end deffn

@geindex no_tracing() (en el módulo test.support)
@anchor{library/test test support no_tracing}@anchor{409e}
@deffn {Función} @@test.support.no_tracing

Decorador para desactivar temporalmente el seguimiento durante la duración de la prueba.
@end deffn

@geindex refcount_test() (en el módulo test.support)
@anchor{library/test test support refcount_test}@anchor{409f}
@deffn {Función} @@test.support.refcount_test

Decorador para pruebas que implican conteo de referencias. El decorador no ejecuta la prueba si CPython no la ejecuta. Cualquier función de rastreo no se establece durante la duración de la prueba para evitar conteos de referencia(`refcounts') inesperados causados por la función de rastreo.
@end deffn

@geindex bigmemtest() (en el módulo test.support)
@anchor{library/test test support bigmemtest}@anchor{40a0}
@deffn {Función} @@test.support.bigmemtest (size, memuse, dry_run=True)

Decorador para pruebas `bigmem'.

`size' es un tamaño solicitado para la prueba (en unidades arbitrarias interpretadas por la prueba). `memuse' es el número de bytes por unidad para la prueba, o una buena estimación de la misma. Por ejemplo, una prueba que necesita dos búfers de byte, de 4 `GiB' cada uno, podría decorarse con @code{@@bigmemtest(size=_4G, memuse=2)}.

El argumento `size' normalmente se pasa al método de prueba decorado como un argumento adicional. Si `dry_run' es @code{True}, el valor pasado al método de prueba puede ser menor que el valor solicitado. Si `dry_run' es @code{False}, significa que la prueba no admite ejecuciones ficticias cuando no se especifica @code{-M}.
@end deffn

@geindex bigaddrspacetest() (en el módulo test.support)
@anchor{library/test test support bigaddrspacetest}@anchor{40a1}
@deffn {Función} @@test.support.bigaddrspacetest

Decorador para pruebas que llenan el espacio de direcciones.
@end deffn

@geindex check_syntax_error() (en el módulo test.support)
@anchor{library/test test support check_syntax_error}@anchor{40a2}
@deffn {Función} test.support.check_syntax_error (testcase, statement, errtext='@w{'}, *, lineno=None, offset=None)

Prueba los errores de sintaxis en `statement' intentando compilar `statement'. `testcase' es la instancia @ref{106,,unittest} para la prueba. `errtext' es la expresión regular que debe coincidir con la representación de cadena de caracteres que es lanza en @ref{150,,SyntaxError}. Si `lineno' no es @code{None}, se compara con la línea de la excepción. Si `offset' no es @code{None}, se compara con el desplazamiento de la excepción.
@end deffn

@geindex open_urlresource() (en el módulo test.support)
@anchor{library/test test support open_urlresource}@anchor{40a3}
@deffn {Función} test.support.open_urlresource (url, *args, **kw)

Abre `url'. Si la apertura falla, se lanza @ref{4055,,TestFailed}.
@end deffn

@geindex reap_children() (en el módulo test.support)
@anchor{library/test test support reap_children}@anchor{40a4}
@deffn {Función} test.support.reap_children ()

Se utiliza esto al final de @code{test_main} siempre que se inicien subprocesos. Esto ayudará a garantizar que ningún proceso hijo adicional (zombies) se quede para acumular recursos y crear problemas al buscar refleaks.
@end deffn

@geindex get_attribute() (en el módulo test.support)
@anchor{library/test test support get_attribute}@anchor{40a5}
@deffn {Función} test.support.get_attribute (obj, name)

Obtiene un atributo, lanzando @ref{1063,,unittest.SkipTest} si @ref{441,,AttributeError} está activado.
@end deffn

@geindex catch_unraisable_exception() (en el módulo test.support)
@anchor{library/test test support catch_unraisable_exception}@anchor{19e1}
@deffn {Función} test.support.catch_unraisable_exception ()

El administrador de contexto detectando excepciones imposibles de evaluar usando @ref{355,,sys.unraisablehook()}.

El almacenamiento del valor de excepción (@code{cm.unraisable.exc_value}) crea un ciclo de referencia. El ciclo de referencia se interrumpe explícitamente cuando sale el administrador de contexto.

El almacenamiento del objeto (@code{cm.unraisable.object}) puede resucitarlo si se establece en un objeto que se está finalizando. Salir del administrador de contexto borra el objeto almacenado.

Uso:

@example
with support.catch_unraisable_exception() as cm:
    # code creating an "unraisable exception"
    ...

    # check the unraisable exception: use cm.unraisable
    ...

# cm.unraisable attribute no longer exists at this point
# (to break a reference cycle)
@end example


Added in version 3.8.

@end deffn

@geindex load_package_tests() (en el módulo test.support)
@anchor{library/test test support load_package_tests}@anchor{40a6}
@deffn {Función} test.support.load_package_tests (pkg_dir, loader, standard_tests, pattern)

La implementación genérica del protocolo @ref{106,,unittest} @code{load_tests} para usar en paquetes de prueba. `pkg_dir' es el directorio raíz del paquete; `loader', `standard_tests' y `pattern' son los argumentos esperados por @code{load_tests}. En casos simples, el paquete de prueba @code{__init __. Py} puede ser el siguiente:

@example
import os
from test.support import load_package_tests

def load_tests(*args):
    return load_package_tests(os.path.dirname(__file__), *args)
@end example
@end deffn

@geindex detect_api_mismatch() (en el módulo test.support)
@anchor{library/test test support detect_api_mismatch}@anchor{40a7}
@deffn {Función} test.support.detect_api_mismatch (ref_api, other_api, *, ignore=())

Retorna el conjunto de atributos, funciones o métodos de `ref_api' que no se encuentra en `other_api *, excepto por una lista definida de elementos que se ignorarán en esta comprobación especificada en *ignore'.

De forma predeterminada, omite los atributos privados que comienzan con “_” pero incluye todos los métodos mágicos, es decir, los que comienzan y terminan en “__”.


Added in version 3.5.

@end deffn

@geindex patch() (en el módulo test.support)
@anchor{library/test test support patch}@anchor{40a8}
@deffn {Función} test.support.patch (test_instance, object_to_patch, attr_name, new_value)

Se anula `object_to_patch.attr_name' con `new_value'. Se agrega también el procedimiento de limpieza a `test_instance' para restaurar `object_to_patch' para `attr_name'. `Attr_name' debe ser un atributo válido para `object_to_patch'.
@end deffn

@geindex run_in_subinterp() (en el módulo test.support)
@anchor{library/test test support run_in_subinterp}@anchor{40a9}
@deffn {Función} test.support.run_in_subinterp (code)

Ejecuta `code' en el subinterpretador. Lanza @ref{1063,,unittest.SkipTest} si @ref{ff,,tracemalloc} está habilitado.
@end deffn

@geindex check_free_after_iterating() (en el módulo test.support)
@anchor{library/test test support check_free_after_iterating}@anchor{40aa}
@deffn {Función} test.support.check_free_after_iterating (test, iter, cls, args=())

Las instancias de aserción de `cls' se desalojan después de la iteración.
@end deffn

@geindex missing_compiler_executable() (en el módulo test.support)
@anchor{library/test test support missing_compiler_executable}@anchor{40ab}
@deffn {Función} test.support.missing_compiler_executable (cmd_names=[])

Verifica la existencia de los ejecutables del compilador cuyos nombres figuran en `cmd_names' o todos los ejecutables del compilador cuando `cmd_names' está vacío y retorna el primer ejecutable faltante o @code{None} cuando no se encuentra ninguno.
@end deffn

@geindex check__all__() (en el módulo test.support)
@anchor{library/test test support check__all__}@anchor{1956}
@deffn {Función} test.support.check__all__ (test_case, module, name_of_module=None, extra=(), not_exported=())

Aserciona que la variable @code{_all__} de `module' contiene todos los nombres públicos.

Los nombres públicos del módulo (su API) se detectan automáticamente en función de si coinciden con la convención de nombres públicos y se definieron en `module'.

El argumento `name_of_module' puede especificar (como una cadena o tupla del mismo) qué módulo(s) se podría definir una API para ser detectada como una API pública. Un caso para esto es cuando `module' importa parte de su API pública desde otros módulos, posiblemente un `backend de C' (como @code{csv} y su @code{_csv}).

The `extra' argument can be a set of names that wouldn’t otherwise be automatically
detected as «public», like objects without a proper @ref{227b,,__module__}
attribute. If provided, it will be added to the automatically detected ones.

El argumento `not_exported' puede ser un conjunto de nombres que no deben tratarse como parte de la API pública aunque sus nombres indiquen lo contrario.

Ejemplo de uso:

@example
import bar
import foo
import unittest
from test import support

class MiscTestCase(unittest.TestCase):
    def test__all__(self):
        support.check__all__(self, foo)

class OtherTestCase(unittest.TestCase):
    def test__all__(self):
        extra = @{'BAR_CONST', 'FOO_CONST'@}
        not_exported = @{'baz'@}  # Undocumented name.
        # bar imports part of its API from _bar.
        support.check__all__(self, bar, ('bar', '_bar'),
                             extra=extra, not_exported=not_exported)
@end example


Added in version 3.6.

@end deffn

@geindex skip_if_broken_multiprocessing_synchronize() (en el módulo test.support)
@anchor{library/test test support skip_if_broken_multiprocessing_synchronize}@anchor{1957}
@deffn {Función} test.support.skip_if_broken_multiprocessing_synchronize ()

Omite las pruebas si el módulo no se encuentra al @code{multiprocessing.synchronize}, si no hay una implementación de semáforo disponible, o si crear un `lock' lanza un @ref{4d5,,OSError}.


Added in version 3.10.

@end deffn

@geindex check_disallow_instantiation() (en el módulo test.support)
@anchor{library/test test support check_disallow_instantiation}@anchor{40ac}
@deffn {Función} test.support.check_disallow_instantiation (test_case, tp, *args, **kwds)

Se aserciona que el tipo `tp' no pueda ser instanciado usando `args' y `kwds'.


Added in version 3.10.

@end deffn

@geindex adjust_int_max_str_digits() (en el módulo test.support)
@anchor{library/test test support adjust_int_max_str_digits}@anchor{40ad}
@deffn {Función} test.support.adjust_int_max_str_digits (max_digits)

Esta función devuelve un administrador de contexto que cambiará la configuración global de @ref{17c6,,sys.set_int_max_str_digits()} durante la duración del contexto para permitir la ejecución de código de prueba que necesita un límite diferente en la cantidad de dígitos al convertir entre un número entero y una cadena.


Added in version 3.11.

@end deffn

El módulo @ref{e4,,test.support} define las siguientes clases:

@geindex SuppressCrashReport (clase en test.support)
@anchor{library/test test support SuppressCrashReport}@anchor{40ae}
@deffn {Clase} test.support.SuppressCrashReport

Un administrador de contexto suele intentar evitar ventanas emergentes de diálogo de bloqueo en las pruebas que se espera que bloqueen un subproceso.

En Windows, deshabilita los cuadros de diálogo de Informe de errores de Windows usando SetErrorMode@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621.aspx}.

On UNIX, @ref{40af,,resource.setrlimit()} is used to set
@ref{40b0,,resource.RLIMIT_CORE}’s soft limit to 0 to prevent coredump file
creation.

On both platforms, the old value is restored by @ref{1367,,__exit__()}.
@end deffn

@geindex SaveSignals (clase en test.support)
@anchor{library/test test support SaveSignals}@anchor{40b1}
@deffn {Clase} test.support.SaveSignals

Clase para guardar y restaurar manejadores (`handlers') de señal registrados por el manejador de señal Python.

@geindex save() (método de test.support.SaveSignals)
@anchor{library/test test support SaveSignals save}@anchor{40b2}
@deffn {Método} save (self)

Guarda los controladores de señales en un diccionario que asigna números de señales al controlador de señales actual.
@end deffn

@geindex restore() (método de test.support.SaveSignals)
@anchor{library/test test support SaveSignals restore}@anchor{40b3}
@deffn {Método} restore (self)

Establece los números de señal del diccionario @ref{40b2,,save()} en el controlador guardado.
@end deffn
@end deffn

@geindex Matcher (clase en test.support)
@anchor{library/test test support Matcher}@anchor{40b4}
@deffn {Clase} test.support.Matcher

@geindex matches() (método de test.support.Matcher)
@anchor{library/test test support Matcher matches}@anchor{40b5}
@deffn {Método} matches (self, d, **kwargs)

Intenta hacer coincidir una sola sentencia con los argumentos proporcionados.
@end deffn

@geindex match_value() (método de test.support.Matcher)
@anchor{library/test test support Matcher match_value}@anchor{40b6}
@deffn {Método} match_value (self, k, dv, v)

Intenta hacer coincidir un único valor almacenado (`dv') con un valor proporcionado (`v').
@end deffn
@end deffn

@node test support socket_helper — Utilidades para pruebas de socket,test support script_helper —Utilidades para las pruebas de ejecución de Python,test support — Utilidades para el conjunto de pruebas de Python,Herramientas de desarrollo
@anchor{library/test module-test support socket_helper}@anchor{e9}@anchor{library/test test-support-socket-helper-utilities-for-socket-tests}@anchor{40b7}
@subsection @code{test.support.socket_helper} — Utilidades para pruebas de socket


@geindex module; test.support.socket_helper

El módulo @ref{e9,,test.support.socket_helper} proporciona soporte para las pruebas de socket.


Added in version 3.9.


@geindex IPV6_ENABLED (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper IPV6_ENABLED}@anchor{40b8}
@deffn {Dato} test.support.socket_helper.IPV6_ENABLED

Se establece como @code{True} si IPv6 está habilitado en este host, @code{False} en caso contrario.
@end deffn

@geindex find_unused_port() (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper find_unused_port}@anchor{40b9}
@deffn {Función} test.support.socket_helper.find_unused_port (family=socket.AF_INET, socktype=socket.SOCK_STREAM)

Retorna un puerto no utilizado que debería ser adecuado para el enlace. Esto se logra creando un `socket' temporal con la misma familia y tipo que el parámetro @code{sock} (el valor predeterminado es @ref{1824,,AF_INET}, @ref{135a,,SOCK_STREAM}) y vinculándolo a la dirección de host especificada (por defecto es @code{0.0.0.0}) con el puerto establecido en 0, provocando un puerto efímero no utilizado del sistema operativo. El `socket' temporal se cierra y se elimina, y se retorna el puerto efímero.

Este método o @ref{40ba,,bind_port()} debe usarse para cualquier prueba en la que un `socket' del servidor deba estar vinculado a un puerto en particular durante la duración de la prueba. Cuál usar depende de si el código de llamada está creando un `socket' Python, o si un puerto no utilizado debe proporcionarse en un constructor o pasar a un programa externo (es decir, el argumento @code{-accept} al modo `s_server de openssl'). Siempre es preferible @ref{40ba,,bind_port()} sobre @ref{40b9,,find_unused_port()} donde sea posible. Se desaconseja el uso de un puerto codificado ya que puede hacer que varias instancias de la prueba sean imposibles de ejecutar simultáneamente, lo cual es un problema para los `buildbots'.
@end deffn

@geindex bind_port() (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper bind_port}@anchor{40ba}
@deffn {Función} test.support.socket_helper.bind_port (sock, host=HOST)

Se enlaza el `socket' a un puerto libre y retorna el número de puerto. Se basa en puertos efímeros para garantizar que estemos utilizando un puerto independiente. Esto es importante ya que muchas pruebas pueden ejecutarse simultáneamente, especialmente en un entorno `buildbot'. Este método lanza una excepción si @code{sock.family} es @code{AF_INET} y @code{sock.type} es @code{SOCK_STREAM}, y el `socket' tiene @code{SO_REUSEADDR} o @code{SO_REUSEPORT} establecido en él. Las pruebas nunca deben configurar estas opciones de `socket' para los `sockets TCP/IP'. El único caso para configurar estas opciones es probar la multidifusión (`multicasting') a través de múltiples `sockets UDP'.

Además, si la opción de `socket' @code{SO_EXCLUSIVEADDRUSE} está disponible (es decir, en Windows), se establecerá en el `socket'. Esto evitará que otras personas se vinculen a nuestro host/puerto mientras dure la prueba.
@end deffn

@geindex bind_unix_socket() (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper bind_unix_socket}@anchor{40bb}
@deffn {Función} test.support.socket_helper.bind_unix_socket (sock, addr)

Enlaza un socket Unix, lanzando @ref{1063,,unittest.SkipTest} si se lanza @ref{dc9,,PermissionError}.
@end deffn

@geindex skip_unless_bind_unix_socket() (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper skip_unless_bind_unix_socket}@anchor{40bc}
@deffn {Función} @@test.support.socket_helper.skip_unless_bind_unix_socket

Un decorador para ejecutar pruebas que requieren un enlace(@code{bind()}) funcional para sockets en sistemas Unix.
@end deffn

@geindex transient_internet() (en el módulo test.support.socket_helper)
@anchor{library/test test support socket_helper transient_internet}@anchor{405c}
@deffn {Función} test.support.socket_helper.transient_internet (resource_name, *, timeout=30.0, errnos=())

Un gestor de contexto que lanza @ref{4056,,ResourceDenied} cuando varios problemas con la conexión a Internet se manifiestan como excepciones.
@end deffn

@node test support script_helper —Utilidades para las pruebas de ejecución de Python,test support bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode,test support socket_helper — Utilidades para pruebas de socket,Herramientas de desarrollo
@anchor{library/test module-test support script_helper}@anchor{e8}@anchor{library/test test-support-script-helper-utilities-for-the-python-execution-tests}@anchor{40bd}
@subsection @code{test.support.script_helper} —Utilidades para las pruebas de ejecución de Python


@geindex module; test.support.script_helper

El módulo @ref{e8,,test.support.script_helper} proporciona soporte para las pruebas de ejecución de script de Python.

@geindex interpreter_requires_environment() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper interpreter_requires_environment}@anchor{40be}
@deffn {Función} test.support.script_helper.interpreter_requires_environment ()

Retorna @code{True} si el @code{sys.executable interpreter} requiere variables de entorno para poder ejecutarse.

Esto está diseñado para usarse con @code{@@unittest.skipIf()} para anotar pruebas que necesitan usar una función @code{assert_python*()} para iniciar un modo aislado (@code{-I}) o sin entorno proceso de subinterpretador de modo (@code{-E}).

Una compilación y prueba normal no se encuentra en esta situación, pero puede suceder cuando se intenta ejecutar el conjunto de pruebas de biblioteca estándar desde un intérprete que no tiene un directorio principal obvio con la lógica de búsqueda de directorio principal actual de Python.

La configuración 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} es una forma de hacer que la mayoría del `testuite' se ejecute en esa situación. 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} o 
@geindex PYTHONUSERSITE
@geindex variables de entorno; PYTHONUSERSITE
@code{PYTHONUSERSITE} son otras variables de entorno comunes que pueden afectar si el intérprete puede o no comenzar.
@end deffn

@geindex run_python_until_end() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper run_python_until_end}@anchor{40bf}
@deffn {Función} test.support.script_helper.run_python_until_end (*args, **env_vars)

Configura el entorno basado en `env_vars' para ejecutar el intérprete en un subproceso. Los valores pueden incluir @code{__isolated}, @code{__cleanenv}, @code{__cwd} y @code{TERM}.


Distinto en la versión 3.9: La función ya no elimina los espacios en blanco de `stderr'.

@end deffn

@geindex assert_python_ok() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper assert_python_ok}@anchor{40c0}
@deffn {Función} test.support.script_helper.assert_python_ok (*args, **env_vars)

Aserción de que ejecutar el intérprete con `arg' y variables de entorno opcionales `env_vars' tiene éxito (@code{rc == 0}) y retorna una tupla @code{(código de retorno, stdout, stderr)}.

Si se establece el parámetro de solo palabra clave `__cleanenv', `env_vars' se usa como un entorno nuevo.

Python se inicia en modo aislado (opción de línea de comando @code{-I}), excepto si el parámetro de solo palabra clave `__isolated' se establece en @code{False}.


Distinto en la versión 3.9: La función ya no elimina los espacios en blanco de `stderr'.

@end deffn

@geindex assert_python_failure() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper assert_python_failure}@anchor{40c1}
@deffn {Función} test.support.script_helper.assert_python_failure (*args, **env_vars)

Aserciona que la ejecución del intérprete con `args' y variables de entorno opcionales `env_vars' falla (@code{rc! = 0}) y retorna una tupla @code{(return code, stdout, stderr)}.

Consulte @ref{40c0,,assert_python_ok()} para más opciones.


Distinto en la versión 3.9: La función ya no elimina los espacios en blanco de `stderr'.

@end deffn

@geindex spawn_python() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper spawn_python}@anchor{40c2}
@deffn {Función} test.support.script_helper.spawn_python (*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)

Ejecuta un subproceso de Python con los argumentos dados.

`kw' es un argumento adicional de palabras clave para pasar a @ref{301,,subprocess.Popen()}. Retorna un objeto a @ref{301,,subprocess.Popen}.
@end deffn

@geindex kill_python() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper kill_python}@anchor{40c3}
@deffn {Función} test.support.script_helper.kill_python (p)

Ejecuta el proceso dado @ref{301,,subprocess.Popen} hasta que finalice y retorne `stdout'.
@end deffn

@geindex make_script() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper make_script}@anchor{40c4}
@deffn {Función} test.support.script_helper.make_script (script_dir, script_basename, source, omit_suffix=False)

Crea un script que contiene `source' en la ruta `script_dir' y `script_basename'. Si `omit_suffix' es @code{False}, agregue @code{.py} al nombre. Retorna la ruta completa del script.
@end deffn

@geindex make_zip_script() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper make_zip_script}@anchor{40c5}
@deffn {Función} test.support.script_helper.make_zip_script (zip_dir, zip_basename, script_name, name_in_zip=None)

Crea un archivo zip en `zip_dir' y `zip_basename' con la extensión @code{zip} que contiene los archivos en `script_name'. `name_in_zip' es el nombre del archivo. Retorna una tupla que contiene @code{(ruta completa, ruta completa del nombre del archivo)}.
@end deffn

@geindex make_pkg() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper make_pkg}@anchor{40c6}
@deffn {Función} test.support.script_helper.make_pkg (pkg_dir, init_source='@w{'})

Crea un directorio llamado `pkg_dir' que contiene un archivo @code{__init__} con `init_source' como su contenido.
@end deffn

@geindex make_zip_pkg() (en el módulo test.support.script_helper)
@anchor{library/test test support script_helper make_zip_pkg}@anchor{40c7}
@deffn {Función} test.support.script_helper.make_zip_pkg (zip_dir, zip_basename, pkg_name, script_basename, source, depth=1, compiled=False)

Crea un directorio de paquete zip con una ruta de `zip_dir' y `zip_basename' que contiene un archivo @code{__init__} vacío y un archivo `script_basename' que contiene el `source'. Si `compilado' es @code{True}, ambos archivos fuente se compilarán y se agregarán al paquete zip. Retorna una tupla de la ruta zip completa y el nombre de archivo para el archivo zip.
@end deffn

@node test support bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode,test support threading_helper — Utilidades para pruebas con hilos,test support script_helper —Utilidades para las pruebas de ejecución de Python,Herramientas de desarrollo
@anchor{library/test module-test support bytecode_helper}@anchor{e5}@anchor{library/test test-support-bytecode-helper-support-tools-for-testing-correct-bytecode-generation}@anchor{40c8}
@subsection @code{test.support.bytecode_helper} — Herramientas de apoyo para comprobar la correcta generación de bytecode


@geindex module; test.support.bytecode_helper

El módulo @ref{e5,,test.support.bytecode_helper} proporciona soporte para probar e inspeccionar la generación de código de bytes.


Added in version 3.9.


El módulo define la siguiente clase:

@geindex BytecodeTestCase (clase en test.support.bytecode_helper)
@anchor{library/test test support bytecode_helper BytecodeTestCase}@anchor{40c9}
@deffn {Clase} test.support.bytecode_helper.BytecodeTestCase (unittest.TestCase)

Esta clase tiene métodos de aserción personalizados para inspeccionar el código de bytes.
@end deffn

@geindex get_disassembly_as_string() (método de test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase get_disassembly_as_string}@anchor{40ca}
@deffn {Método} BytecodeTestCase.get_disassembly_as_string (co)

Retorna el desensamblaje de `co' como cadena.
@end deffn

@geindex assertInBytecode() (método de test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase assertInBytecode}@anchor{40cb}
@deffn {Método} BytecodeTestCase.assertInBytecode (x, opname, argval=_UNSPECIFIED)

Retorna instr si se encuentra `opname', de lo contrario lanza @ref{74a,,AssertionError}.
@end deffn

@geindex assertNotInBytecode() (método de test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase assertNotInBytecode}@anchor{40cc}
@deffn {Método} BytecodeTestCase.assertNotInBytecode (x, opname, argval=_UNSPECIFIED)

Lanza @ref{74a,,AssertionError} si se encuentra `opname'.
@end deffn

@node test support threading_helper — Utilidades para pruebas con hilos,test support os_helper — Utilidades para pruebas de sistemas operativos,test support bytecode_helper — Herramientas de apoyo para comprobar la correcta generación de bytecode,Herramientas de desarrollo
@anchor{library/test module-test support threading_helper}@anchor{ea}@anchor{library/test test-support-threading-helper-utilities-for-threading-tests}@anchor{40cd}
@subsection @code{test.support.threading_helper} — Utilidades para pruebas con hilos


@geindex module; test.support.threading_helper

El módulo @ref{ea,,test.support.threading_helper} proporciona soporte para las pruebas de socket.


Added in version 3.10.


@geindex join_thread() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper join_thread}@anchor{40ce}
@deffn {Función} test.support.threading_helper.join_thread (thread, timeout=None)

Se une un `thread' dentro de `timeout'. Lanza un @ref{74a,,AssertionError} si el hilo sigue vivo después de unos segundos de `timeout'.
@end deffn

@geindex reap_threads() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper reap_threads}@anchor{40cf}
@deffn {Función} @@test.support.threading_helper.reap_threads

Decorador para garantizar que los hilos se limpien incluso si la prueba falla.
@end deffn

@geindex start_threads() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper start_threads}@anchor{40d0}
@deffn {Función} test.support.threading_helper.start_threads (threads, unlock=None)

Administrador de contexto para iniciar `threads', que es una secuencia de subprocesos. `unlock' es una función a la que se llama después de que se inician los subprocesos, incluso si se generó una excepción; un ejemplo sería @ref{306b,,threading.Event.set()}. @code{start_threads} intentará unirse a los subprocesos iniciados al salir.
@end deffn

@geindex threading_cleanup() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper threading_cleanup}@anchor{40d1}
@deffn {Función} test.support.threading_helper.threading_cleanup (*original_values)

Se limpia los hilos no especificados en `original_values'. Diseñado para emitir una advertencia si una prueba deja hilos en ejecución en segundo plano.
@end deffn

@geindex threading_setup() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper threading_setup}@anchor{40d2}
@deffn {Función} test.support.threading_helper.threading_setup ()

Retorna el recuento del hilo actual y copia de subprocesos colgantes.
@end deffn

@geindex wait_threads_exit() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper wait_threads_exit}@anchor{40d3}
@deffn {Función} test.support.threading_helper.wait_threads_exit (timeout=None)

El administrador de contexto debe esperar hasta que salgan todos los hilos creados en la declaración @code{with}.
@end deffn

@geindex catch_threading_exception() (en el módulo test.support.threading_helper)
@anchor{library/test test support threading_helper catch_threading_exception}@anchor{40d4}
@deffn {Función} test.support.threading_helper.catch_threading_exception ()

El administrador de contexto captura @ref{9df,,threading.Thread} excepción usando @ref{8e2,,threading.excepthook()}.

Atributos establecidos cuando se captura una excepción:


@itemize *

@item 
@code{exc_type}

@item 
@code{exc_value}

@item 
@code{exc_traceback}

@item 
@code{thread}
@end itemize

Consulte la documentación para @ref{8e2,,threading.excepthook()}.

Estos atributos se eliminan en la salida del administrador de contexto.

Uso:

@example
with threading_helper.catch_threading_exception() as cm:
    # code spawning a thread which raises an exception
    ...

    # check the thread exception, use cm attributes:
    # exc_type, exc_value, exc_traceback, thread
    ...

# exc_type, exc_value, exc_traceback, thread attributes of cm no longer
# exists at this point
# (to avoid reference cycles)
@end example


Added in version 3.8.

@end deffn

@node test support os_helper — Utilidades para pruebas de sistemas operativos,test support import_helper — Utilidades para pruebas de importación,test support threading_helper — Utilidades para pruebas con hilos,Herramientas de desarrollo
@anchor{library/test module-test support os_helper}@anchor{e7}@anchor{library/test test-support-os-helper-utilities-for-os-tests}@anchor{40d5}
@subsection @code{test.support.os_helper} — Utilidades para pruebas de sistemas operativos


@geindex module; test.support.os_helper

El módulo @ref{e7,,test.support.os_helper} proporciona soporte para las pruebas de sistemas operativos.


Added in version 3.10.


@geindex FS_NONASCII (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper FS_NONASCII}@anchor{40d6}
@deffn {Dato} test.support.os_helper.FS_NONASCII

Un carácter no codificable ASCII codificable por @ref{cdd,,os.fsencode()}.
@end deffn

@geindex SAVEDCWD (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper SAVEDCWD}@anchor{40d7}
@deffn {Dato} test.support.os_helper.SAVEDCWD

Establecido @ref{159a,,os.getcwd()}.
@end deffn

@geindex TESTFN (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN}@anchor{40d8}
@deffn {Dato} test.support.os_helper.TESTFN

Establecido a un nombre que sea seguro de usar como nombre de un archivo temporal. Cualquier archivo temporal que se cree debe cerrarse y desvincularse (eliminarse).
@end deffn

@geindex TESTFN_NONASCII (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_NONASCII}@anchor{40d9}
@deffn {Dato} test.support.os_helper.TESTFN_NONASCII

Establecido en un nombre de archivo que contiene el carácter @ref{40d6,,FS_NONASCII}, si existe. Esto garantiza que, si existe el nombre de archivo, se puede codificar y decodificar con la codificación predeterminada del sistema de archivos. Esto permite omitir fácilmente las pruebas que requieren un nombre de archivo que no sea ASCII en plataformas donde no pueden funcionar.
@end deffn

@geindex TESTFN_UNENCODABLE (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNENCODABLE}@anchor{40da}
@deffn {Dato} test.support.os_helper.TESTFN_UNENCODABLE

Establecido un nombre de archivo (tipo `str') que no se pueda codificar mediante la codificación del sistema de archivos en modo estricto. Puede ser @code{None} si no es posible generar dicho nombre de archivo.
@end deffn

@geindex TESTFN_UNDECODABLE (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNDECODABLE}@anchor{40db}
@deffn {Dato} test.support.os_helper.TESTFN_UNDECODABLE

Establecido un nombre de archivo (tipo de bytes) que no pueda descodificarse mediante la codificación del sistema de archivos en modo estricto. Puede ser @code{None} si no es posible generar dicho nombre de archivo.
@end deffn

@geindex TESTFN_UNICODE (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNICODE}@anchor{40dc}
@deffn {Dato} test.support.os_helper.TESTFN_UNICODE

Establecido un nombre que no sea ASCII para un archivo temporal.
@end deffn

@geindex EnvironmentVarGuard (clase en test.support.os_helper)
@anchor{library/test test support os_helper EnvironmentVarGuard}@anchor{1422}
@deffn {Clase} test.support.os_helper.EnvironmentVarGuard

Clase utilizada para establecer o deshabilitar temporalmente las variables de entorno. Las instancias se pueden usar como un administrador de contexto y tienen una interfaz de diccionario completa para consultar/modificar el @code{os.environ} subyacente. Después de salir del administrador de contexto, todos los cambios en las variables de entorno realizados a través de esta instancia se revertirán.


Distinto en la versión 3.1: Añadido una interfaz de diccionario.

@end deffn

@geindex FakePath (clase en test.support.os_helper)
@anchor{library/test test support os_helper FakePath}@anchor{40dd}
@deffn {Clase} test.support.os_helper.FakePath (path)

Simple @ref{3f0,,path-like object}.  It implements the
@ref{cda,,__fspath__()}
method which just returns the `path' argument.  If `path' is an exception,
it will be raised in @code{__fspath__()}.
@end deffn

@geindex set() (método de test.support.os_helper.EnvironmentVarGuard)
@anchor{library/test test support os_helper EnvironmentVarGuard set}@anchor{40de}
@deffn {Método} EnvironmentVarGuard.set (envvar, value)

Se establece temporalmente la variable de entorno @code{envvar} en el valor de @code{value}.
@end deffn

@geindex unset() (método de test.support.os_helper.EnvironmentVarGuard)
@anchor{library/test test support os_helper EnvironmentVarGuard unset}@anchor{40df}
@deffn {Método} EnvironmentVarGuard.unset (envvar)

Deshabilita temporalmente la variable de entorno @code{envvar}.
@end deffn

@geindex can_symlink() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper can_symlink}@anchor{40e0}
@deffn {Función} test.support.os_helper.can_symlink ()

Retorna @code{True} si el sistema operativo admite links simbólicos, de lo contrario @code{False}.
@end deffn

@geindex can_xattr() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper can_xattr}@anchor{40e1}
@deffn {Función} test.support.os_helper.can_xattr ()

Retorna @code{True} si el sistema operativo admite `xattr', de lo contrario @code{False}.
@end deffn

@geindex change_cwd() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper change_cwd}@anchor{40e2}
@deffn {Función} test.support.os_helper.change_cwd (path, quiet=False)

Un administrador de contexto que cambia temporalmente el directorio de trabajo actual a `path' y produce el directorio.

Si `quiet' es @code{False}, el administrador de contexto lanza una excepción en caso de error. De lo contrario, solo emite una advertencia y mantiene el directorio de trabajo actual igual.
@end deffn

@geindex create_empty_file() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper create_empty_file}@anchor{40e3}
@deffn {Función} test.support.os_helper.create_empty_file (filename)

Crea un archivo vacío con `filename'. Si ya existe, truncarlo.
@end deffn

@geindex fd_count() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper fd_count}@anchor{40e4}
@deffn {Función} test.support.os_helper.fd_count ()

Cuenta el número de descriptores de archivo abiertos.
@end deffn

@geindex fs_is_case_insensitive() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper fs_is_case_insensitive}@anchor{40e5}
@deffn {Función} test.support.os_helper.fs_is_case_insensitive (directory)

Retorna @code{True} si el sistema de archivos para `directory' no distingue entre mayúsculas y minúsculas.
@end deffn

@geindex make_bad_fd() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper make_bad_fd}@anchor{40e6}
@deffn {Función} test.support.os_helper.make_bad_fd ()

Se crea un descriptor de archivo no válido abriendo y cerrando un archivo temporal y retornando su descriptor.
@end deffn

@geindex rmdir() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper rmdir}@anchor{40e7}
@deffn {Función} test.support.os_helper.rmdir (filename)

Llama a @ref{1166,,os.rmdir()} en `filename'. En las plataformas Windows, esto se envuelve con un ciclo de espera que verifica la existencia del archivo, que es necesario debido a los programas antivirus que pueden mantener los archivos abiertos y evitar que se eliminen.
@end deffn

@geindex rmtree() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper rmtree}@anchor{40e8}
@deffn {Función} test.support.os_helper.rmtree (path)

Llama a @ref{1f9,,shutil.rmtree()} en `path' o llama a @ref{549,,os.lstat()} y @ref{1166,,os.rmdir()} para eliminar una ruta y su contenido. Al igual que con @ref{40e7,,rmdir()}, en las plataformas de Windows esto se envuelve con un ciclo de espera que verifica la existencia de los archivos.
@end deffn

@geindex skip_unless_symlink() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper skip_unless_symlink}@anchor{40e9}
@deffn {Función} @@test.support.os_helper.skip_unless_symlink

Un decorador para ejecutar pruebas que requieren soporte para enlaces simbólicos.
@end deffn

@geindex skip_unless_xattr() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper skip_unless_xattr}@anchor{40ea}
@deffn {Función} @@test.support.os_helper.skip_unless_xattr

Un decorador para ejecutar pruebas que requieren soporte para `xattr'.
@end deffn

@geindex temp_cwd() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_cwd}@anchor{40eb}
@deffn {Función} test.support.os_helper.temp_cwd (name='tempcwd', quiet=False)

Un administrador de contexto que crea temporalmente un nuevo directorio y cambia el directorio de trabajo actual (`CWD').

El administrador de contexto crea un directorio temporal en el directorio actual con el nombre `name' antes de cambiar temporalmente el directorio de trabajo actual. Si `name' es @code{None} , el directorio temporal se crea usando @ref{37c,,tempfile.mkdtemp()}.

Si `quiet' es @code{False} y no es posible crear o cambiar el `CWD', se lanza un error. De lo contrario, solo se lanza una advertencia y se utiliza el `CWD' original.
@end deffn

@geindex temp_dir() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_dir}@anchor{40ec}
@deffn {Función} test.support.os_helper.temp_dir (path=None, quiet=False)

Un administrador de contexto que crea un directorio temporal en `path' y produce el directorio.

Si `path' es @code{None}, el directorio temporal se crea usando @ref{37c,,tempfile.mkdtemp()}. Si `quiet' es @code{False}, el administrador de contexto lanza una excepción en caso de error. De lo contrario, si se especifica `path' y no se puede crear, solo se emite una advertencia.
@end deffn

@geindex temp_umask() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_umask}@anchor{40ed}
@deffn {Función} test.support.os_helper.temp_umask (umask)

Un administrador de contexto que establece temporalmente el proceso `umask'.
@end deffn

@geindex unlink() (en el módulo test.support.os_helper)
@anchor{library/test test support os_helper unlink}@anchor{40ee}
@deffn {Función} test.support.os_helper.unlink (filename)

Llama a @ref{1168,,os.unlink()} en `filename'. Al igual que con @ref{40e7,,rmdir()}, en las plataformas Windows, esto se envuelve con un ciclo de espera que verifica la existencia del archivo.
@end deffn

@node test support import_helper — Utilidades para pruebas de importación,test support warnings_helper — Utilidades para pruebas de advertencias,test support os_helper — Utilidades para pruebas de sistemas operativos,Herramientas de desarrollo
@anchor{library/test module-test support import_helper}@anchor{e6}@anchor{library/test test-support-import-helper-utilities-for-import-tests}@anchor{40ef}
@subsection @code{test.support.import_helper} — Utilidades para pruebas de importación


@geindex module; test.support.import_helper

El módulo @ref{e6,,test.support.import_helper} proporciona soporte para las pruebas de importación.


Added in version 3.10.


@geindex forget() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper forget}@anchor{40f0}
@deffn {Función} test.support.import_helper.forget (module_name)

Elimina el módulo llamado `module_name' de @code{sys.modules} y elimina los archivos compilados por bytes del módulo.
@end deffn

@geindex import_fresh_module() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper import_fresh_module}@anchor{18b6}
@deffn {Función} test.support.import_helper.import_fresh_module (name, fresh=(), blocked=(), deprecated=False)

Esta función importa y retorna una copia nueva del módulo Python nombrado eliminando el módulo nombrado de @code{sys.modules} antes de realizar la importación. Tenga en cuenta que a diferencia de @code{reload()}, el módulo original no se ve afectado por esta operación.

`fresh' es un iterable de nombres de módulos adicionales que también se eliminan del caché @code{sys.modules} antes de realizar la importación.

`bloqueado' es un iterable de nombres de módulos que se reemplazan con @code{None} en la memoria caché del módulo durante la importación para garantizar que los intentos de importarlos generen @ref{4d7,,ImportError}.

El módulo nombrado y los módulos nombrados en los parámetros `fresh' y `bloqueado' se guardan antes de comenzar la importación y luego se vuelven a insertar en @code{sys.modules} cuando se completa la importación fresca.

Los mensajes de deprecación de módulos y paquetes se suprimen durante esta importación si `deprecated' es @code{True}.

Esta función lanzará @ref{4d7,,ImportError} si el módulo nombrado no puede importarse.

Ejemplo de uso:

@example
# Get copies of the warnings module for testing without affecting the
# version being used by the rest of the test suite. One copy uses the
# C implementation, the other is forced to use the pure Python fallback
# implementation
py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
c_warnings = import_fresh_module('warnings', fresh=['_warnings'])
@end example


Added in version 3.1.

@end deffn

@geindex import_module() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper import_module}@anchor{40f1}
@deffn {Función} test.support.import_helper.import_module (name, deprecated=False, *, required_on=())

Esta función importa y retorna el módulo nombrado. A diferencia de una importación normal, esta función lanza @ref{1063,,unittest.SkipTest} si el módulo no se puede importar.

Los mensajes de deprecación de módulos y paquetes se suprimen durante esta importación si `deprecated' es @code{True}. Si se requiere un módulo en una plataforma pero es opcional para otros, establezca `required_on' en un iterable de prefijos de plataforma que se compararán con @ref{b19,,sys.platform}.


Added in version 3.1.

@end deffn

@geindex modules_setup() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper modules_setup}@anchor{40f2}
@deffn {Función} test.support.import_helper.modules_setup ()

Retorna una copia de @ref{1976,,sys.modules}.
@end deffn

@geindex modules_cleanup() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper modules_cleanup}@anchor{40f3}
@deffn {Función} test.support.import_helper.modules_cleanup (oldmodules)

Elimina los módulos a excepción de `oldmodules' y @code{encodings} para preservar la memoria caché interna.
@end deffn

@geindex unload() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper unload}@anchor{40f4}
@deffn {Función} test.support.import_helper.unload (name)

Elimina `name' de @code{sys.modules}.
@end deffn

@geindex make_legacy_pyc() (en el módulo test.support.import_helper)
@anchor{library/test test support import_helper make_legacy_pyc}@anchor{40f5}
@deffn {Función} test.support.import_helper.make_legacy_pyc (source)

Mueve un archivo `pyc' de 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} a su ubicación heredada y retorna la ruta del sistema de archivos al archivo de `pyc' heredado. El valor de origen es la ruta del sistema de archivos al archivo fuente. No es necesario que exista, sin embargo, debe existir el archivo PEP 3147/488 `pyc'.
@end deffn

@geindex CleanImport (clase en test.support.import_helper)
@anchor{library/test test support import_helper CleanImport}@anchor{40f6}
@deffn {Clase} test.support.import_helper.CleanImport (*module_names)

Un administrador de contexto para forzar la importación para retornar una nueva referencia de módulo. Esto es útil para probar comportamientos a nivel de módulo, como la emisión de un @ref{1da,,DeprecationWarning} en la importación. Ejemplo de uso:

@example
with CleanImport('foo'):
    importlib.import_module('foo')  # New reference.
@end example
@end deffn

@geindex DirsOnSysPath (clase en test.support.import_helper)
@anchor{library/test test support import_helper DirsOnSysPath}@anchor{40f7}
@deffn {Clase} test.support.import_helper.DirsOnSysPath (*paths)

Un administrador de contexto para agregar directorios temporalmente a @ref{27e,,sys.path}.

Esto hace una copia de @ref{27e,,sys.path}, agrega cualquier directorio dado como argumento posicional, luego revierte @ref{27e,,sys.path} a la configuración copiada cuando finaliza el contexto.

Tenga en cuenta que `all' @ref{27e,,sys.path} produce modificaciones en el cuerpo del administrador de contexto, incluida la sustitución del objeto, se revertirán al final del bloque.
@end deffn

@node test support warnings_helper — Utilidades para pruebas de advertencias,,test support import_helper — Utilidades para pruebas de importación,Herramientas de desarrollo
@anchor{library/test module-test support warnings_helper}@anchor{eb}@anchor{library/test test-support-warnings-helper-utilities-for-warnings-tests}@anchor{40f8}
@subsection @code{test.support.warnings_helper} — Utilidades para pruebas de advertencias


@geindex module; test.support.warnings_helper

El módulo @ref{eb,,test.support.warnings_helper} proporciona soporte para las pruebas de advertencias.


Added in version 3.10.


@geindex ignore_warnings() (en el módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper ignore_warnings}@anchor{40f9}
@deffn {Función} test.support.warnings_helper.ignore_warnings (*, category)

Suppress warnings that are instances of `category',
which must be @ref{22b6,,Warning} or a subclass.
Roughly equivalent to @ref{628,,warnings.catch_warnings()}
with @ref{762,,warnings.simplefilter('ignore'@comma{} category=category)}.
For example:

@example
@@warning_helper.ignore_warnings(category=DeprecationWarning)
def test_suppress_warning():
    # do something
@end example


Added in version 3.8.

@end deffn

@geindex check_no_resource_warning() (en el módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_no_resource_warning}@anchor{40fa}
@deffn {Función} test.support.warnings_helper.check_no_resource_warning (testcase)

Gestor de contexto para comprobar que no se ha lanzado un @ref{39d,,ResourceWarning} . Debe eliminar el objeto que puede emitir @ref{39d,,ResourceWarning} antes del final del administrador de contexto.
@end deffn

@geindex check_syntax_warning() (en el módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_syntax_warning}@anchor{40fb}
@deffn {Función} test.support.warnings_helper.check_syntax_warning (testcase, statement, errtext='@w{'}, *, lineno=1, offset=None)

Prueba la advertencia de sintaxis en `statement' intentando compilar `statement'. Pruebe también que @ref{511,,SyntaxWarning} se emite solo una vez, y que se convertirá en @ref{150,,SyntaxError} cuando se convierta en error. `testcase' es la instancia @ref{106,,unittest} para la prueba. `errtext' es la expresión regular que debe coincidir con la representación de cadena del emitido @ref{511,,SyntaxWarning} y lanza @ref{150,,SyntaxError} . Si `lineno' no es @code{None}, se compara con la línea de advertencia y excepción. Si `offset' no es @code{None}, se compara con el desplazamiento de la excepción.


Added in version 3.8.

@end deffn

@geindex check_warnings() (en el módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_warnings}@anchor{40fc}
@deffn {Función} test.support.warnings_helper.check_warnings (*filters, quiet=True)

A convenience wrapper for @ref{628,,warnings.catch_warnings()} that makes it
easier to test that a warning was correctly raised.  It is approximately
equivalent to calling @code{warnings.catch_warnings(record=True)} with
@ref{762,,warnings.simplefilter()} set to @code{always} and with the option to
automatically validate the results that are recorded.

@code{check_warnings} acepta 2 tuplas de la forma @code{("mensaje regexp", WarningCategory)} como argumentos posicionales. Si se proporcionan uno o más `filters', o si el argumento opcional de palabra clave `quiet' es @code{False}, se verifica para asegurarse de que las advertencias sean las esperadas: cada filtro especificado debe coincidir con al menos una de las advertencias lanzadas por el código adjunto o la prueba falla, y si se lanzan advertencias que no coinciden con ninguno de los filtros especificados, la prueba falla. Para deshabilitar la primera de estas comprobaciones, configure `quiet' en @code{True}.

Si no se especifican argumentos, el valor predeterminado es:

@example
check_warnings(("", Warning), quiet=True)
@end example

En este caso, se capturan todas las advertencias y no se lanzaran errores.

En la entrada al administrador de contexto, se retorna una instancia de @code{WarningRecorder}. La lista de advertencias subyacentes de @ref{628,,catch_warnings()} está disponible a través del atributo @ref{112,,warnings} del objeto del registrador. Como conveniencia, también se puede acceder directamente a los atributos del objeto que representa la advertencia más reciente a través del objeto grabador (vea el ejemplo a continuación). Si no se ha lanzado ninguna advertencia, cualquiera de los atributos que de otro modo se esperarían en un objeto que representa una advertencia retornará @code{None}.

El objeto grabador (`recorder object') también tiene un método @code{reset()}, que borra la lista de advertencias.

El administrador de contexto está diseñado para usarse así:

@example
with check_warnings(("assertion is always true", SyntaxWarning),
                    ("", UserWarning)):
    exec('assert(False, "Hey!")')
    warnings.warn(UserWarning("Hide me!"))
@end example

En este caso, si no se generó ninguna advertencia, o si surgió alguna otra advertencia, @ref{40fc,,check_warnings()} lanzaría un error.

Cuando una prueba necesita analizar más profundamente las advertencias, en lugar de simplemente verificar si ocurrieron o no, se puede usar un código como este:

@example
with check_warnings(quiet=True) as w:
    warnings.warn("foo")
    assert str(w.args[0]) == "foo"
    warnings.warn("bar")
    assert str(w.args[0]) == "bar"
    assert str(w.warnings[0].args[0]) == "foo"
    assert str(w.warnings[1].args[0]) == "bar"
    w.reset()
    assert len(w.warnings) == 0
@end example

Aquí se capturarán todas las advertencias, y el código de prueba prueba las advertencias capturadas directamente.


Distinto en la versión 3.2: Nuevos argumentos opcionales `filters' y `quiet'.

@end deffn

@geindex WarningsRecorder (clase en test.support.warnings_helper)
@anchor{library/test test support warnings_helper WarningsRecorder}@anchor{40fd}
@deffn {Clase} test.support.warnings_helper.WarningsRecorder

La clase utilizada para registrar advertencias para pruebas unitarias. Consulte la documentación de @ref{40fc,,check_warnings()} arriba para obtener más detalles.
@end deffn

@node Depuración y perfilado,Empaquetado y distribución de software,Herramientas de desarrollo,La biblioteca estándar de Python
@anchor{library/debug doc}@anchor{40fe}@anchor{library/debug debugging-and-profiling}@anchor{40ff}
@section Depuración y perfilado


Estas bibliotecas le ayudan con el desarrollo de Python: el depurador le permite recorrer paso a paso el código, analizar marcos de pila y establecer puntos de interrupción, etc., y los perfiladores ejecutan código y le proporcionan un desglose detallado de los tiempos de ejecución, lo que le permite identificar cuellos de botella en sus programas. Los eventos de auditoría proporcionan visibilidad de los comportamientos en tiempo de ejecución que, de lo contrario, requerirían depuración o parches intrusivos.

@geindex eventos de auditoría
@anchor{library/audit_events audit-events}@anchor{1878}
@menu
* Tabla de auditoría de eventos:: 
* bdb — Debugger framework:: 
* faulthandler — Dump the Python traceback:: 
* pdb — El Depurador de Python:: 
* Los perfiladores de Python:: 
* timeit — Measure execution time of small code snippets:: 
* trace — Trace or track Python statement execution:: 
* tracemalloc — Trace memory allocations:: 

@end menu

@node Tabla de auditoría de eventos,bdb — Debugger framework,,Depuración y perfilado
@anchor{library/audit_events doc}@anchor{4100}@anchor{library/audit_events audit-events-table}@anchor{4101}
@subsection Tabla de auditoría de eventos


This table contains all events raised by @ref{15af,,sys.audit()} or
@ref{463,,PySys_Audit()} calls throughout the CPython runtime and the
standard library.  These calls were added in 3.8 or later (see 
@geindex Python Enhancement Proposals; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/}).

Ver @ref{4102,,sys.addaudithook()} y @ref{4103,,PySys_AddAuditHook()} para informarse en el manejo de estos eventos.

`Detalles de implementación de CPython:' Esta tabla es generada desde la documentación de CPython, y no debe guardar eventos lanzados por otras implementaciones. Ver la documentación de tus especificaciones en tiempo de ejecución para los eventos lanzados recientemente.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Audit event

@tab

Arguments

@tab

References

@item

_thread.start_new_thread

@tab

@code{function}, @code{args}, @code{kwargs}

@tab

@ref{4104,,[1]}

@item

array.__new__

@tab

@code{typecode}, @code{initializer}

@tab

@ref{308,,[1]}

@item

builtins.breakpoint

@tab

@code{breakpointhook}

@tab

@ref{1a6,,[1]}

@item

builtins.id

@tab

@code{id}

@tab

@ref{1462,,[1]}

@item

builtins.input

@tab

@code{prompt}

@tab

@ref{1340,,[1]}

@item

builtins.input/result

@tab

@code{result}

@tab

@ref{1340,,[1]}

@item

code.__new__

@tab

@code{code}, @code{filename}, @code{name}, @code{argcount}, @code{posonlyargcount}, @code{kwonlyargcount}, @code{nlocals}, @code{stacksize}, @code{flags}

@tab

@ref{1d8,,[1]}

@item

compile

@tab

@code{source}, @code{filename}

@tab

@ref{2fb,,[1]}

@item

cpython.PyInterpreterState_Clear

@tab



@tab

@ref{4105,,[1]}

@item

cpython.PyInterpreterState_New

@tab



@tab

@ref{4106,,[1]}

@item

cpython._PySys_ClearAuditHooks

@tab



@tab

@ref{d9c,,[1]}

@item

cpython.run_command

@tab

@code{command}

@tab

@ref{681,,[1]}

@item

cpython.run_file

@tab

@code{filename}

@tab

@ref{4107,,[1]}

@item

cpython.run_interactivehook

@tab

@code{hook}

@tab

@ref{1046,,[1]}

@item

cpython.run_module

@tab

@code{module-name}

@tab

@ref{187,,[1]}

@item

cpython.run_startup

@tab

@code{filename}

@tab

@ref{1047,,[1]}

@item

cpython.run_stdin

@tab



@tab

@ref{4108,,[1]}@ref{4109,,[2]}@ref{410a,,[3]}

@item

ctypes.addressof

@tab

@code{obj}

@tab

@ref{3020,,[1]}

@item

ctypes.call_function

@tab

@code{func_pointer}, @code{arguments}

@tab

@ref{3018,,[1]}

@item

ctypes.cdata

@tab

@code{address}

@tab

@ref{3031,,[1]}

@item

ctypes.cdata/buffer

@tab

@code{pointer}, @code{size}, @code{offset}

@tab

@ref{302f,,[1]}@ref{3030,,[2]}

@item

ctypes.create_string_buffer

@tab

@code{init}, @code{size}

@tab

@ref{2fd8,,[1]}

@item

ctypes.create_unicode_buffer

@tab

@code{init}, @code{size}

@tab

@ref{19d8,,[1]}

@item

ctypes.dlopen

@tab

@code{name}

@tab

@ref{3016,,[1]}

@item

ctypes.dlsym

@tab

@code{library}, @code{name}

@tab

@ref{3016,,[1]}

@item

ctypes.dlsym/handle

@tab

@code{handle}, @code{name}

@tab

@ref{3016,,[1]}

@item

ctypes.get_errno

@tab



@tab

@ref{300f,,[1]}

@item

ctypes.get_last_error

@tab



@tab

@ref{3012,,[1]}

@item

ctypes.set_errno

@tab

@code{errno}

@tab

@ref{3010,,[1]}

@item

ctypes.set_exception

@tab

@code{code}

@tab

@ref{3018,,[1]}

@item

ctypes.set_last_error

@tab

@code{error}

@tab

@ref{3013,,[1]}

@item

ctypes.string_at

@tab

@code{ptr}, @code{size}

@tab

@ref{3029,,[1]}

@item

ctypes.wstring_at

@tab

@code{ptr}, @code{size}

@tab

@ref{302b,,[1]}

@item

ensurepip.bootstrap

@tab

@code{root}

@tab

@ref{410b,,[1]}

@item

exec

@tab

@code{code_object}

@tab

@ref{2eb,,[1]}@ref{2ea,,[2]}

@item

fcntl.fcntl

@tab

@code{fd}, @code{cmd}, @code{arg}

@tab

@ref{338c,,[1]}

@item

fcntl.flock

@tab

@code{fd}, @code{operation}

@tab

@ref{410c,,[1]}

@item

fcntl.ioctl

@tab

@code{fd}, @code{request}, @code{arg}

@tab

@ref{14b6,,[1]}

@item

fcntl.lockf

@tab

@code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}

@tab

@ref{142c,,[1]}

@item

ftplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{39b3,,[1]}

@item

ftplib.sendcmd

@tab

@code{self}, @code{cmd}

@tab

@ref{39b8,,[1]}@ref{39b9,,[2]}

@item

function.__new__

@tab

@code{code}

@tab

@ref{91b,,[1]}

@item

gc.get_objects

@tab

@code{generation}

@tab

@ref{89a,,[1]}

@item

gc.get_referents

@tab

@code{objs}

@tab

@ref{89c,,[1]}

@item

gc.get_referrers

@tab

@code{objs}

@tab

@ref{89b,,[1]}

@item

glob.glob

@tab

@code{pathname}, @code{recursive}

@tab

@ref{3ef,,[1]}@ref{89e,,[2]}

@item

glob.glob/2

@tab

@code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}

@tab

@ref{3ef,,[1]}@ref{89e,,[2]}

@item

http.client.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{3996,,[1]}

@item

http.client.send

@tab

@code{self}, @code{data}

@tab

@ref{399b,,[1]}

@item

imaplib.open

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{99b,,[1]}

@item

imaplib.send

@tab

@code{self}, @code{data}

@tab

@ref{3a0a,,[1]}

@item

import

@tab

@code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}

@tab

@ref{682,,[1]}

@item

marshal.dumps

@tab

@code{value}, @code{version}

@tab

@ref{28b5,,[1]}

@item

marshal.load

@tab



@tab

@ref{1a1b,,[1]}

@item

marshal.loads

@tab

@code{bytes}

@tab

@ref{1a1b,,[1]}

@item

mmap.__new__

@tab

@code{fileno}, @code{length}, @code{access}, @code{offset}

@tab

@ref{368,,[1]}

@item

msvcrt.get_osfhandle

@tab

@code{fd}

@tab

@ref{410d,,[1]}

@item

msvcrt.locking

@tab

@code{fd}, @code{mode}, @code{nbytes}

@tab

@ref{410e,,[1]}

@item

msvcrt.open_osfhandle

@tab

@code{handle}, @code{flags}

@tab

@ref{410f,,[1]}

@item

object.__delattr__

@tab

@code{obj}, @code{name}

@tab

@ref{1f2f,,[1]}

@item

object.__getattr__

@tab

@code{obj}, @code{name}

@tab

@ref{c5a,,[1]}

@item

object.__setattr__

@tab

@code{obj}, @code{name}, @code{value}

@tab

@ref{1f2e,,[1]}

@item

open

@tab

@code{path}, @code{mode}, @code{flags}

@tab

@ref{1be,,[1]}@ref{5c0,,[2]}@ref{e18,,[3]}

@item

os.add_dll_directory

@tab

@code{path}

@tab

@ref{a7c,,[1]}

@item

os.chdir

@tab

@code{path}

@tab

@ref{6ae,,[1]}@ref{e0f,,[2]}

@item

os.chflags

@tab

@code{path}, @code{flags}

@tab

@ref{1160,,[1]}@ref{2b80,,[2]}

@item

os.chmod

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{378,,[1]}@ref{379,,[2]}@ref{377,,[3]}

@item

os.chown

@tab

@code{path}, @code{uid}, @code{gid}, @code{dir_fd}

@tab

@ref{1161,,[1]}@ref{e10,,[2]}@ref{2b81,,[3]}

@item

os.exec

@tab

@code{path}, @code{args}, @code{env}

@tab

@ref{2bbd,,[1]}

@item

os.fork

@tab



@tab

@ref{2ff,,[1]}

@item

os.forkpty

@tab



@tab

@ref{300,,[1]}

@item

os.fwalk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks}, @code{dir_fd}

@tab

@ref{be3,,[1]}

@item

os.getxattr

@tab

@code{path}, @code{attribute}

@tab

@ref{1176,,[1]}

@item

os.kill

@tab

@code{pid}, @code{sig}

@tab

@ref{13c7,,[1]}

@item

os.killpg

@tab

@code{pgid}, @code{sig}

@tab

@ref{19df,,[1]}

@item

os.link

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{1162,,[1]}

@item

os.listdir

@tab

@code{path}

@tab

@ref{116c,,[1]}

@item

os.listdrives

@tab



@tab

@ref{545,,[1]}

@item

os.listmounts

@tab

@code{volume}

@tab

@ref{547,,[1]}

@item

os.listvolumes

@tab



@tab

@ref{546,,[1]}

@item

os.listxattr

@tab

@code{path}

@tab

@ref{1177,,[1]}

@item

os.lockf

@tab

@code{fd}, @code{cmd}, @code{len}

@tab

@ref{1185,,[1]}

@item

os.mkdir

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{37b,,[1]}@ref{37a,,[2]}

@item

os.posix_spawn

@tab

@code{path}, @code{argv}, @code{env}

@tab

@ref{37d,,[1]}@ref{1a36,,[2]}

@item

os.putenv

@tab

@code{key}, @code{value}

@tab

@ref{198,,[1]}

@item

os.remove

@tab

@code{path}, @code{dir_fd}

@tab

@ref{1163,,[1]}@ref{2b85,,[2]}@ref{1168,,[3]}

@item

os.removexattr

@tab

@code{path}, @code{attribute}

@tab

@ref{1178,,[1]}

@item

os.rename

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{1164,,[1]}@ref{2b86,,[2]}@ref{1165,,[3]}

@item

os.rmdir

@tab

@code{path}, @code{dir_fd}

@tab

@ref{1166,,[1]}

@item

os.scandir

@tab

@code{path}

@tab

@ref{1a2,,[1]}

@item

os.setxattr

@tab

@code{path}, @code{attribute}, @code{value}, @code{flags}

@tab

@ref{1179,,[1]}

@item

os.spawn

@tab

@code{mode}, @code{path}, @code{args}, @code{env}

@tab

@ref{1c6,,[1]}

@item

os.startfile

@tab

@code{path}, @code{operation}

@tab

@ref{18d4,,[1]}

@item

os.startfile/2

@tab

@code{path}, @code{operation}, @code{arguments}, @code{cwd}, @code{show_cmd}

@tab

@ref{18d4,,[1]}

@item

os.symlink

@tab

@code{src}, @code{dst}, @code{dir_fd}

@tab

@ref{1167,,[1]}

@item

os.system

@tab

@code{command}

@tab

@ref{149a,,[1]}

@item

os.truncate

@tab

@code{fd}, @code{length}

@tab

@ref{e15,,[1]}@ref{ec1,,[2]}

@item

os.unsetenv

@tab

@code{key}

@tab

@ref{199,,[1]}

@item

os.utime

@tab

@code{path}, @code{times}, @code{ns}, @code{dir_fd}

@tab

@ref{1169,,[1]}

@item

os.walk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{followlinks}

@tab

@ref{551,,[1]}

@item

pathlib.Path.glob

@tab

@code{self}, @code{pattern}

@tab

@ref{388,,[1]}

@item

pathlib.Path.rglob

@tab

@code{self}, @code{pattern}

@tab

@ref{389,,[1]}

@item

pdb.Pdb

@tab



@tab

@ref{1a8,,[1]}

@item

pickle.find_class

@tab

@code{module}, @code{name}

@tab

@ref{2892,,[1]}

@item

poplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{9b7,,[1]}@ref{9b8,,[2]}

@item

poplib.putline

@tab

@code{self}, @code{line}

@tab

@ref{9b7,,[1]}@ref{9b8,,[2]}

@item

pty.spawn

@tab

@code{argv}

@tab

@ref{1001,,[1]}

@item

resource.prlimit

@tab

@code{pid}, @code{resource}, @code{limits}

@tab

@ref{1008,,[1]}

@item

resource.setrlimit

@tab

@code{resource}, @code{limits}

@tab

@ref{40af,,[1]}

@item

setopencodehook

@tab



@tab

@ref{1730,,[1]}

@item

shutil.chown

@tab

@code{path}, @code{user}, @code{group}

@tab

@ref{399,,[1]}

@item

shutil.copyfile

@tab

@code{src}, @code{dst}

@tab

@ref{aeb,,[1]}@ref{aec,,[2]}@ref{aea,,[3]}

@item

shutil.copymode

@tab

@code{src}, @code{dst}

@tab

@ref{aeb,,[1]}@ref{16b4,,[2]}

@item

shutil.copystat

@tab

@code{src}, @code{dst}

@tab

@ref{aec,,[1]}@ref{11a0,,[2]}

@item

shutil.copytree

@tab

@code{src}, @code{dst}

@tab

@ref{abb,,[1]}

@item

shutil.make_archive

@tab

@code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}

@tab

@ref{55a,,[1]}

@item

shutil.move

@tab

@code{src}, @code{dst}

@tab

@ref{aed,,[1]}

@item

shutil.rmtree

@tab

@code{path}, @code{dir_fd}

@tab

@ref{1f9,,[1]}

@item

shutil.unpack_archive

@tab

@code{filename}, @code{extract_dir}, @code{format}

@tab

@ref{516,,[1]}

@item

signal.pthread_kill

@tab

@code{thread_id}, @code{signalnum}

@tab

@ref{11a3,,[1]}

@item

smtplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{19d3,,[1]}

@item

smtplib.send

@tab

@code{self}, @code{data}

@tab

@ref{9c0,,[1]}

@item

socket.__new__

@tab

@code{self}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{e27,,[1]}

@item

socket.bind

@tab

@code{self}, @code{address}

@tab

@ref{157a,,[1]}

@item

socket.connect

@tab

@code{self}, @code{address}

@tab

@ref{e29,,[1]}@ref{1579,,[2]}

@item

socket.getaddrinfo

@tab

@code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{175a,,[1]}

@item

socket.gethostbyaddr

@tab

@code{ip_address}

@tab

@ref{18d5,,[1]}

@item

socket.gethostbyname

@tab

@code{hostname}

@tab

@ref{3381,,[1]}@ref{18d6,,[2]}

@item

socket.gethostname

@tab



@tab

@ref{2b2a,,[1]}

@item

socket.getnameinfo

@tab

@code{sockaddr}

@tab

@ref{16cd,,[1]}

@item

socket.getservbyname

@tab

@code{servicename}, @code{protocolname}

@tab

@ref{3383,,[1]}

@item

socket.getservbyport

@tab

@code{port}, @code{protocolname}

@tab

@ref{3384,,[1]}

@item

socket.sendmsg

@tab

@code{self}, @code{address}

@tab

@ref{521,,[1]}

@item

socket.sendto

@tab

@code{self}, @code{address}

@tab

@ref{e2f,,[1]}

@item

socket.sethostname

@tab

@code{name}

@tab

@ref{11ad,,[1]}

@item

sqlite3.connect

@tab

@code{database}

@tab

@ref{3f5,,[1]}

@item

sqlite3.connect/handle

@tab

@code{connection_handle}

@tab

@ref{3f5,,[1]}

@item

sqlite3.enable_load_extension

@tab

@code{connection}, @code{enabled}

@tab

@ref{8d5,,[1]}

@item

sqlite3.load_extension

@tab

@code{connection}, @code{path}

@tab

@ref{55f,,[1]}

@item

subprocess.Popen

@tab

@code{executable}, @code{args}, @code{cwd}, @code{env}

@tab

@ref{301,,[1]}

@item

sys._current_exceptions

@tab



@tab

@ref{569,,[1]}

@item

sys._current_frames

@tab



@tab

@ref{1472,,[1]}

@item

sys._getframe

@tab

@code{frame}

@tab

@ref{781,,[1]}

@item

sys._getframemodulename

@tab

@code{depth}

@tab

@ref{1777,,[1]}

@item

sys.addaudithook

@tab



@tab

@ref{4103,,[1]}@ref{4102,,[2]}

@item

sys.excepthook

@tab

@code{hook}, @code{type}, @code{value}, @code{traceback}

@tab

@ref{8a2,,[1]}

@item

sys.set_asyncgen_hooks_finalizer

@tab



@tab

@ref{1632,,[1]}

@item

sys.set_asyncgen_hooks_firstiter

@tab



@tab

@ref{1632,,[1]}

@item

sys.setprofile

@tab



@tab

@ref{153f,,[1]}

@item

sys.settrace

@tab



@tab

@ref{1540,,[1]}

@item

sys.unraisablehook

@tab

@code{hook}, @code{unraisable}

@tab

@ref{355,,[1]}

@item

syslog.closelog

@tab



@tab

@ref{5e2,,[1]}

@item

syslog.openlog

@tab

@code{ident}, @code{logoption}, @code{facility}

@tab

@ref{5e1,,[1]}

@item

syslog.setlogmask

@tab

@code{maskpri}

@tab

@ref{4110,,[1]}

@item

syslog.syslog

@tab

@code{priority}, @code{message}

@tab

@ref{5e3,,[1]}

@item

tempfile.mkdtemp

@tab

@code{fullpath}

@tab

@ref{12a1,,[1]}@ref{37c,,[2]}

@item

tempfile.mkstemp

@tab

@code{fullpath}

@tab

@ref{56d,,[1]}@ref{2845,,[2]}@ref{2846,,[3]}

@item

time.sleep

@tab

@code{secs}

@tab

@ref{4111,,[1]}

@item

urllib.Request

@tab

@code{fullurl}, @code{data}, @code{headers}, @code{method}

@tab

@ref{20a,,[1]}

@item

webbrowser.open

@tab

@code{url}

@tab

@ref{387d,,[1]}

@item

winreg.ConnectRegistry

@tab

@code{computer_name}, @code{key}

@tab

@ref{4112,,[1]}

@item

winreg.CreateKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{4113,,[1]}@ref{13c2,,[2]}

@item

winreg.DeleteKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{4114,,[1]}@ref{13c3,,[2]}

@item

winreg.DeleteValue

@tab

@code{key}, @code{value}

@tab

@ref{4115,,[1]}

@item

winreg.DisableReflectionKey

@tab

@code{key}

@tab

@ref{13c4,,[1]}

@item

winreg.EnableReflectionKey

@tab

@code{key}

@tab

@ref{13c5,,[1]}

@item

winreg.EnumKey

@tab

@code{key}, @code{index}

@tab

@ref{4116,,[1]}

@item

winreg.EnumValue

@tab

@code{key}, @code{index}

@tab

@ref{4117,,[1]}

@item

winreg.ExpandEnvironmentStrings

@tab

@code{str}

@tab

@ref{1438,,[1]}

@item

winreg.LoadKey

@tab

@code{key}, @code{sub_key}, @code{file_name}

@tab

@ref{4118,,[1]}

@item

winreg.OpenKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{4119,,[1]}

@item

winreg.OpenKey/result

@tab

@code{key}

@tab

@ref{4113,,[1]}@ref{13c2,,[2]}@ref{4119,,[3]}

@item

winreg.PyHKEY.Detach

@tab

@code{key}

@tab

@ref{411a,,[1]}

@item

winreg.QueryInfoKey

@tab

@code{key}

@tab

@ref{411b,,[1]}

@item

winreg.QueryReflectionKey

@tab

@code{key}

@tab

@ref{13c6,,[1]}

@item

winreg.QueryValue

@tab

@code{key}, @code{sub_key}, @code{value_name}

@tab

@ref{411c,,[1]}@ref{411d,,[2]}

@item

winreg.SaveKey

@tab

@code{key}, @code{file_name}

@tab

@ref{411e,,[1]}

@item

winreg.SetValue

@tab

@code{key}, @code{sub_key}, @code{type}, @code{value}

@tab

@ref{411f,,[1]}@ref{1796,,[2]}

@end multitable


Los siguientes eventos se generan internamente y no corresponden a ninguna API pública de CPython:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Evento de auditoría

@tab

Argumentos

@item

_winapi.CreateFile

@tab

@code{file_name}, @code{desired_access},
@code{share_mode}, @code{creation_disposition},
@code{flags_and_attributes}

@item

_winapi.CreateJunction

@tab

@code{src_path}, @code{dst_path}

@item

_winapi.CreateNamedPipe

@tab

@code{name}, @code{open_mode}, @code{pipe_mode}

@item

_winapi.CreatePipe

@tab

@item

_winapi.CreateProcess

@tab

@code{application_name}, @code{command_line},
@code{current_directory}

@item

_winapi.OpenProcess

@tab

@code{process_id}, @code{desired_access}

@item

_winapi.TerminateProcess

@tab

@code{handle}, @code{exit_code}

@item

ctypes.PyObj_FromPtr

@tab

@code{obj}

@end multitable


@node bdb — Debugger framework,faulthandler — Dump the Python traceback,Tabla de auditoría de eventos,Depuración y perfilado
@anchor{library/bdb doc}@anchor{4120}@anchor{library/bdb bdb-debugger-framework}@anchor{4121}@anchor{library/bdb module-bdb}@anchor{10}
@subsection @code{bdb} — Debugger framework


@geindex module; bdb

`Source code:' Lib/bdb.py@footnote{https://github.com/python/cpython/tree/main/Lib/bdb.py}


__________________________________________________________________


El módulo @ref{10,,bdb} maneja las funciones básicas del depurador, como establecer puntos de interrupción o gestionar la ejecución a través del mismo.

La siguiente excepción es definida:

@geindex BdbQuit
@anchor{library/bdb bdb BdbQuit}@anchor{4122}
@deffn {Excepción} bdb.BdbQuit

Excepción lanzada por la clase @ref{1369,,Bdb} al salir del depurador.
@end deffn

El módulo @ref{10,,bdb} también define dos clases:

@geindex Breakpoint (clase en bdb)
@anchor{library/bdb bdb Breakpoint}@anchor{4123}
@deffn {Clase} bdb.Breakpoint (self, file, line, temporary=False, cond=None, funcname=None)

Esta clase implementa puntos de interrupción temporales, permitiendo ignorar recuentos, desactivar y (re-)activar puntos de interrupción y definir condiciones de interrupción para los mismos.

Los puntos de interrupción se indexan numéricamente mediante una lista llamada @ref{4124,,bpbynumber} y por pares @code{(archivo, linea)} mediante @ref{4125,,bplist}. En el primer caso se apunta a una única instancia de @ref{4123,,Breakpoint}. En el segundo caso se apunta a una lista de tales instancias, ya que puede haber más de un punto de interrupción por línea.

Al crear un punto de interrupción, el @ref{4126,,nombre del archivo} asociado debe estar en su forma canónica. Si se define un @ref{4127,,funcname}, se contará un @ref{4128,,hit} de punto de interrupción cuando se ejecute la primera línea de esa función. Un punto de interrupción @ref{4129,,condicional} siempre cuenta un @ref{4128,,hit}.

Las instancias de la clase @ref{4123,,Breakpoint} tienen los siguientes métodos:

@geindex deleteMe() (método de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint deleteMe}@anchor{412a}
@deffn {Método} deleteMe ()

Elimina el punto de interrupción de la lista asociada a un archivo/línea. Si es el último punto de interrupción en esa posición, también borra la entrada correspondiente del archivo/línea correspondiente.
@end deffn

@geindex enable() (método de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint enable}@anchor{412b}
@deffn {Método} enable ()

Marca el punto de interrupción como habilitado.
@end deffn

@geindex disable() (método de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint disable}@anchor{412c}
@deffn {Método} disable ()

Marca el punto de interrupción como deshabilitado.
@end deffn

@geindex bpformat() (método de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpformat}@anchor{412d}
@deffn {Método} bpformat ()

Retorna una cadena de caracteres que contiene toda la información sobre el punto de interrupción, apropiadamente formateada:


@itemize *

@item 
El número del punto de interrupción.

@item 
Estado temporal (del o keep)

@item 
Posición del archivo/línea.

@item 
Condición de interrupción.

@item 
Número de veces para ignorar.

@item 
Número de veces alcanzado.
@end itemize


Added in version 3.2.

@end deffn

@geindex bpprint() (método de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpprint}@anchor{412e}
@deffn {Método} bpprint (out=None)

Imprime la salida de @ref{412d,,bpformat()} en el archivo `out', o en la salida estándar si es @code{None}.
@end deffn

Las instancias de la clase @ref{4123,,Breakpoint} tienen los siguientes atributos:

@geindex file (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint file}@anchor{4126}
@deffn {Atributo} file

Nombre del archivo de la clase @ref{4123,,Breakpoint}.
@end deffn

@geindex line (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint line}@anchor{412f}
@deffn {Atributo} line

Número de línea de la clase @ref{4123,,Breakpoint} dentro de @ref{4126,,file}.
@end deffn

@geindex temporary (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint temporary}@anchor{4130}
@deffn {Atributo} temporary

@code{True} if a @ref{4123,,Breakpoint} at (file, line) is temporary.
@end deffn

@geindex cond (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint cond}@anchor{4129}
@deffn {Atributo} cond

Condición para evaluar una clase @ref{4123,,Breakpoint} en (file, line).
@end deffn

@geindex funcname (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint funcname}@anchor{4127}
@deffn {Atributo} funcname

Nombre de la función que define si se alcanza un @ref{4123,,Breakpoint} al ingresar a la función.
@end deffn

@geindex enabled (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint enabled}@anchor{4131}
@deffn {Atributo} enabled

@code{True} if @ref{4123,,Breakpoint} is enabled.
@end deffn

@geindex bpbynumber (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpbynumber}@anchor{4124}
@deffn {Atributo} bpbynumber

Índice numérico para una sola instancia de un @ref{4123,,Breakpoint}.
@end deffn

@geindex bplist (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bplist}@anchor{4125}
@deffn {Atributo} bplist

Diccionario de instancias @ref{4123,,Breakpoint} indexadas por tuplas (@ref{4126,,file}, @ref{412f,,line}).
@end deffn

@geindex ignore (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint ignore}@anchor{4132}
@deffn {Atributo} ignore

Número de veces para ignorar un @ref{4123,,Breakpoint}.
@end deffn

@geindex hits (atributo de bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint hits}@anchor{4128}
@deffn {Atributo} hits

Recuento del número de veces que se alcanzó un @ref{4123,,Breakpoint}.
@end deffn
@end deffn

@geindex Bdb (clase en bdb)
@anchor{library/bdb bdb Bdb}@anchor{1369}
@deffn {Clase} bdb.Bdb (skip=None)

La clase @ref{1369,,Bdb} actúa como clase base del depurador genérico de Python.

Esta clase se encarga de los detalles de la funcionalidad de seguimiento; una clase derivada debería encargarse de implementar la interacción con el usuario. Un ejemplo es la clase de depuración estándar (@ref{1a8,,pdb.Pdb}).

El argumento `skip', si se proporciona, debe ser un iterable con patrones de nombre de archivo, al estilo del módulo glob. El depurador no entrará en aquellos marcos de ejecución que se originen en un módulo que coincida con uno de estos patrones. Para determinar si un marco de ejecución se origina en un módulo determinado, se hace uso de @code{__name__} en las variables globales del marco de ejecución dado.


Distinto en la versión 3.1: Added the `skip' parameter.


Los siguientes métodos de la clase @ref{1369,,Bdb} normalmente no necesitan ser redefinidos.

@geindex canonic() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb canonic}@anchor{4133}
@deffn {Método} canonic (filename)

Retorna la forma canónica de `filename'.

Para nombres de archivos reales, la forma canónica es una @ref{1383,,ruta absoluta} @ref{27cc,,normalizada entre mayúsculas y minúsculas} que depende del sistema operativo. Un `filename' con corchetes angulares, como @code{"<stdin>"} generado en modo interactivo, se retorna sin cambios.
@end deffn

@geindex reset() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb reset}@anchor{4134}
@deffn {Método} reset ()

Set the @code{botframe}, @code{stopframe}, @code{returnframe} and
@ref{4135,,quitting} attributes with values ready to start debugging.
@end deffn

@geindex trace_dispatch() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb trace_dispatch}@anchor{4136}
@deffn {Método} trace_dispatch (frame, event, arg)

Esta función se instala como función de seguimiento de los marcos de ejecución depurados. Su valor de retorno es la nueva función de seguimiento a usar (en la mayoría de los casos, ella misma).

La implementación predeterminada decide cómo despachar un marco de ejecución, dependiendo del tipo de evento (pasado como una cadena) que está a punto de ejecutarse. `event' puede tomar uno de los siguientes valores:


@itemize *

@item 
@code{"line"}: Se va a ejecutar una nueva línea de código.

@item 
@code{"call"}: Está a punto de llamarse a una función o se ha entrado en otro bloque de código.

@item 
@code{"return"}: Una función u otro bloque de código está a punto de retornar.

@item 
@code{"exception"}: Ha ocurrido una excepción.

@item 
@code{"c_call"}: Una función de C está a punto de llamarse .

@item 
@code{"c_return"}: Una función de C ha retornado.

@item 
@code{"c_exception"}: Una función de C ha lanzado una excepción.
@end itemize

Para los eventos de Python, son llamadas funciones especializadas (ver más abajo). En cambio, para los eventos de C no se realiza ninguna acción.

El parámetro `arg' depende del evento previo.

Consulta la documentación de @ref{1540,,sys.settrace()} para obtener más información sobre la función de seguimiento. Para obtener más información sobre los objetos código y los objetos marco consulte @ref{1ee4,,Jerarquía de tipos estándar}.
@end deffn

@geindex dispatch_line() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_line}@anchor{4137}
@deffn {Método} dispatch_line (frame)

If the debugger should stop on the current line, invoke the
@ref{4138,,user_line()} method (which should be overridden in subclasses).
Raise a @ref{4122,,BdbQuit} exception if the @ref{4135,,quitting} flag is set
(which can be set from @ref{4138,,user_line()}).  Return a reference to the
@ref{4136,,trace_dispatch()} method for further tracing in that scope.
@end deffn

@geindex dispatch_call() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_call}@anchor{4139}
@deffn {Método} dispatch_call (frame, arg)

If the debugger should stop on this function call, invoke the
@ref{413a,,user_call()} method (which should be overridden in subclasses).
Raise a @ref{4122,,BdbQuit} exception if the @ref{4135,,quitting} flag is set
(which can be set from @ref{413a,,user_call()}).  Return a reference to the
@ref{4136,,trace_dispatch()} method for further tracing in that scope.
@end deffn

@geindex dispatch_return() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_return}@anchor{413b}
@deffn {Método} dispatch_return (frame, arg)

If the debugger should stop on this function return, invoke the
@ref{413c,,user_return()} method (which should be overridden in subclasses).
Raise a @ref{4122,,BdbQuit} exception if the @ref{4135,,quitting} flag is set
(which can be set from @ref{413c,,user_return()}).  Return a reference to the
@ref{4136,,trace_dispatch()} method for further tracing in that scope.
@end deffn

@geindex dispatch_exception() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_exception}@anchor{413d}
@deffn {Método} dispatch_exception (frame, arg)

If the debugger should stop at this exception, invokes the
@ref{413e,,user_exception()} method (which should be overridden in subclasses).
Raise a @ref{4122,,BdbQuit} exception if the @ref{4135,,quitting} flag is set
(which can be set from @ref{413e,,user_exception()}).  Return a reference to the
@ref{4136,,trace_dispatch()} method for further tracing in that scope.
@end deffn

Las clases derivadas normalmente no necesitan redefinir los siguientes métodos, pero pueden hacerlo si necesitan redefinir la definición de parada y los puntos de interrupción.

@geindex is_skipped_line() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb is_skipped_line}@anchor{413f}
@deffn {Método} is_skipped_line (module_name)

Return @code{True} if `module_name' matches any skip pattern.
@end deffn

@geindex stop_here() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb stop_here}@anchor{4140}
@deffn {Método} stop_here (frame)

Return @code{True} if `frame' is below the starting frame in the stack.
@end deffn

@geindex break_here() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb break_here}@anchor{4141}
@deffn {Método} break_here (frame)

Return @code{True} if there is an effective breakpoint for this line.

Comprueba si existe un punto de interrupción de línea o de una función y si está en vigor. Elimina puntos de interrupción temporales basados en la información de @ref{4142,,effective()}.
@end deffn

@geindex break_anywhere() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb break_anywhere}@anchor{4143}
@deffn {Método} break_anywhere (frame)

Return @code{True} if any breakpoint exists for `frame'’s filename.
@end deffn

Las clases derivadas deben redefinir estos métodos para adquirir el control sobre las operaciones de depuración.

@geindex user_call() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb user_call}@anchor{413a}
@deffn {Método} user_call (frame, argument_list)

Se llama desde @ref{4139,,dispatch_call()} si una interrupción puede detenerse dentro de la función llamada.

`argument_list' is not used anymore and will always be @code{None}.
The argument is kept for backwards compatibility.
@end deffn

@geindex user_line() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb user_line}@anchor{4138}
@deffn {Método} user_line (frame)

Se llama desde @ref{4137,,dispatch_line()} cuando @ref{4140,,stop_here()} o @ref{4141,,break_here()} retornan @code{True}.
@end deffn

@geindex user_return() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb user_return}@anchor{413c}
@deffn {Método} user_return (frame, return_value)

Se llama desde @ref{413b,,dispatch_return()} cuando @ref{4140,,stop_here()} retorna @code{True}.
@end deffn

@geindex user_exception() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb user_exception}@anchor{413e}
@deffn {Método} user_exception (frame, exc_info)

Se llama desde @ref{413d,,dispatch_exception()} cuando @ref{4140,,stop_here()} retorna @code{True}.
@end deffn

@geindex do_clear() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb do_clear}@anchor{4144}
@deffn {Método} do_clear (arg)

Maneja cómo un punto de interrupción debe ser eliminado cuando es temporal.

Este método debe ser implementado por las clases derivadas.
@end deffn

Las clases derivadas y los clientes pueden llamar a los siguientes métodos para influir en el estado de transición.

@geindex set_step() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_step}@anchor{4145}
@deffn {Método} set_step ()

Se detiene después de una línea de código.
@end deffn

@geindex set_next() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_next}@anchor{4146}
@deffn {Método} set_next (frame)

Se detiene en la siguiente línea del marco de ejecución dado o en la de uno inferior.
@end deffn

@geindex set_return() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_return}@anchor{4147}
@deffn {Método} set_return (frame)

Se detiene cuando se retorna desde el marco de ejecución dado.
@end deffn

@geindex set_until() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_until}@anchor{4148}
@deffn {Método} set_until (frame, lineno=None)

Se detiene cuando se alcanza la línea con el `lineno' mayor que el actual o al retornar desde el marco actual.
@end deffn

@geindex set_trace() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_trace}@anchor{4149}
@deffn {Método} set_trace ([frame])

Inicia la depuración desde el marco de ejecución `frame'. Si `frame' no se especifica, la depuración se inicia desde el marco de ejecución que produce la llamada.


Distinto en la versión 3.13: @ref{414a,,set_trace()} will enter the debugger immediately, rather than
on the next line of code to be executed.

@end deffn

@geindex set_continue() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_continue}@anchor{414b}
@deffn {Método} set_continue ()

Se detiene solo en los puntos de interrupción o cuando haya terminado. Si no hay puntos de interrupción, se configura la función de seguimiento del sistema en @code{None}.
@end deffn

@geindex set_quit() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_quit}@anchor{4135}
@deffn {Método} set_quit ()

@geindex quitting (bdb.Bdb attribute)

Set the @code{quitting} attribute to @code{True}.  This raises @ref{4122,,BdbQuit} in
the next call to one of the @code{dispatch_*()} methods.
@end deffn

Las clases derivadas y los clientes pueden llamar a los siguientes métodos para manipular los puntos de interrupción. Estos métodos retornan una cadena de caracteres que contiene un mensaje de error si algo fue mal, o @code{None} si todo fue correctamente.

@geindex set_break() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb set_break}@anchor{414c}
@deffn {Método} set_break (filename, lineno, temporary=False, cond=None, funcname=None)

Establece un nuevo punto de interrupción. Si la línea en la posición `lineno' no existe en el archivo con nombre `filename' pasado como argumento, se retorna un mensaje de error. `filename' debe estar en su forma canónica, tal como se describe en el método @ref{4133,,canonic()}.
@end deffn

@geindex clear_break() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_break}@anchor{414d}
@deffn {Método} clear_break (filename, lineno)

Elimina los puntos de interrupción en `filename' y `lineno'. Si no se estableció ninguno, se retorna un mensaje de error.
@end deffn

@geindex clear_bpbynumber() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_bpbynumber}@anchor{414e}
@deffn {Método} clear_bpbynumber (arg)

Elimina el punto de interrupción que tiene el índice `arg' en @ref{4124,,Breakpoint.bpbynumber}. Si `arg' no es un valor numérico o es un indice fuera de rango, se retorna un mensaje de error.
@end deffn

@geindex clear_all_file_breaks() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_all_file_breaks}@anchor{414f}
@deffn {Método} clear_all_file_breaks (filename)

Elimina todos los puntos de interrupción en `filename'. Si no se estableció ninguno, se retorna un mensaje de error.
@end deffn

@geindex clear_all_breaks() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_all_breaks}@anchor{4150}
@deffn {Método} clear_all_breaks ()

Elimina todos los puntos de interrupción. Si no se estableció ninguno, se retorna un mensaje de error.
@end deffn

@geindex get_bpbynumber() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_bpbynumber}@anchor{4151}
@deffn {Método} get_bpbynumber (arg)

Retorna un punto de interrupción especificado por el número dado. Si `arg' es una cadena de caracteres, será convertida en un número. Si `arg' es una cadena no numérica, o el punto de interrupción dado nunca existió o ya ha sido eliminado, se lanza una excepción @ref{360,,ValueError}.


Added in version 3.2.

@end deffn

@geindex get_break() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_break}@anchor{4152}
@deffn {Método} get_break (filename, lineno)

Return @code{True} if there is a breakpoint for `lineno' in `filename'.
@end deffn

@geindex get_breaks() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_breaks}@anchor{4153}
@deffn {Método} get_breaks (filename, lineno)

Retorna todos los puntos de interrupción en la línea número `lineno' del archivo `filename', o una lista vacía si no se ha establecido ninguno.
@end deffn

@geindex get_file_breaks() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_file_breaks}@anchor{4154}
@deffn {Método} get_file_breaks (filename)

Retorna todos los puntos de interrupción en el archivo `filename', o una lista vacía si no hay ninguno establecido.
@end deffn

@geindex get_all_breaks() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_all_breaks}@anchor{4155}
@deffn {Método} get_all_breaks ()

Retorna todos los puntos de interrupción establecidos.
@end deffn

Las clases derivadas y clientes pueden llamar los siguientes métodos para obtener una estructura de datos que representa un seguimiento de pila.

@geindex get_stack() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb get_stack}@anchor{4156}
@deffn {Método} get_stack (f, t)

Retorna una lista de tuplas (frame, lineno) en un seguimiento de pila y un tamaño.

El marco llamado más recientemente es el último en la lista. El tamaño es el número de marcos por debajo del marco en el que se invocó el depurador.
@end deffn

@geindex format_stack_entry() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb format_stack_entry}@anchor{4157}
@deffn {Método} format_stack_entry (frame_lineno, lprefix=': ')

Retorna una cadena de caracteres con información sobre una entrada de pila, identificada por una tupla de la forma @code{(frame, lineno)}. La cadena de caracteres que retorna contiene:


@itemize *

@item 
El nombre de archivo canónico que contiene el marco de ejecución.

@item 
El nombre de la función o @code{"<lambda>"}.

@item 
Los argumentos de entrada.

@item 
El valor de retorno.

@item 
La linea de código (si existe).
@end itemize
@end deffn

Los dos métodos descritos a continuación pueden ser llamados por los clientes para usar un depurador que se encargue de depurar un @ref{2777,,statement}, proporcionado como una cadena de caracteres.

@geindex run() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb run}@anchor{4158}
@deffn {Método} run (cmd, globals=None, locals=None)

Debug a statement executed via the @ref{2ea,,exec()} function.  `globals'
defaults to @code{__main__.__dict__}, `locals' defaults to `globals'.
@end deffn

@geindex runeval() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb runeval}@anchor{4159}
@deffn {Método} runeval (expr, globals=None, locals=None)

Depura una expresión ejecutada mediante la función @ref{2eb,,eval()}. `globals' y `locals' tienen el mismo significado que en @ref{4158,,run()}.
@end deffn

@geindex runctx() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb runctx}@anchor{415a}
@deffn {Método} runctx (cmd, globals, locals)

Definido solo por compatibilidad con versiones anteriores. Llama al método @ref{4158,,run()}.
@end deffn

@geindex runcall() (método de bdb.Bdb)
@anchor{library/bdb bdb Bdb runcall}@anchor{b0b}
@deffn {Método} runcall (func, /, *args, **kwds)

Depura una única llamada a función y retorna su resultado.
@end deffn
@end deffn

Por último, el módulo también define las siguientes funciones:

@geindex checkfuncname() (en el módulo bdb)
@anchor{library/bdb bdb checkfuncname}@anchor{415b}
@deffn {Función} bdb.checkfuncname (b, frame)

Return @code{True} if we should break here, depending on the way the
@ref{4123,,Breakpoint} `b' was set.

Si se estableció a través del número de línea, comprueba si @ref{412f,,b.line} es el mismo que el de `frame'. Si el punto de interrupción se estableció a través del @ref{4127,,nombre de la función}, se tiene que comprobar que estamos en el `frame' correcto (la función correcta) y si se está en su primera línea ejecutable.
@end deffn

@geindex effective() (en el módulo bdb)
@anchor{library/bdb bdb effective}@anchor{4142}
@deffn {Función} bdb.effective (file, line, frame)

Retorna @code{(active breakpoint, delete temporary flag)} o @code{(None, None)} como el punto de interrupción para actuar.

The `active breakpoint' is the first entry in
@ref{4125,,bplist} for the
(@ref{4126,,file}, @ref{412f,,line})
(which must exist) that is @ref{4131,,enabled}, for
which @ref{415b,,checkfuncname()} is true, and that has neither a false
@ref{4129,,condition} nor positive
@ref{4132,,ignore} count.  The `flag', meaning that a
temporary breakpoint should be deleted, is @code{False} only when the
@ref{4129,,cond} cannot be evaluated (in which case,
@ref{4132,,ignore} count is ignored).

If no such entry exists, then @code{(None, None)} is returned.
@end deffn

@geindex set_trace() (en el módulo bdb)
@anchor{library/bdb bdb set_trace}@anchor{414a}
@deffn {Función} bdb.set_trace ()

Inicia la depuración usando una instancia de @ref{1369,,Bdb}, partiendo desde el marco de ejecución que realiza la llamada.
@end deffn

@node faulthandler — Dump the Python traceback,pdb — El Depurador de Python,bdb — Debugger framework,Depuración y perfilado
@anchor{library/faulthandler doc}@anchor{415c}@anchor{library/faulthandler faulthandler-dump-the-python-traceback}@anchor{415d}@anchor{library/faulthandler module-faulthandler}@anchor{58}
@subsection @code{faulthandler} — Dump the Python traceback


@geindex module; faulthandler


Added in version 3.3.



__________________________________________________________________


This module contains functions to dump Python tracebacks explicitly, on a fault,
after a timeout, or on a user signal. Call @ref{d27,,faulthandler.enable()} to
install fault handlers for the @ref{1d4f,,SIGSEGV},
@ref{1d50,,SIGFPE}, @ref{1d51,,SIGABRT}, @ref{1d52,,SIGBUS}, and
@ref{1d53,,SIGILL} signals. You can also
enable them at startup by setting the 
@geindex PYTHONFAULTHANDLER
@geindex variables de entorno; PYTHONFAULTHANDLER
@ref{10fc,,PYTHONFAULTHANDLER} environment
variable or by using the @ref{2e2,,-X} @code{faulthandler} command line option.

The fault handler is compatible with system fault handlers like Apport or the
Windows fault handler. The module uses an alternative stack for signal handlers
if the @code{sigaltstack()} function is available. This allows it to dump the
traceback even on a stack overflow.

El gestor de fallos se llama en casos catastróficos y, por lo tanto, solo puede utilizar funciones seguras en señales (por ejemplo, no puede asignar memoria en el heap). Debido a esta limitación, el volcado del rastreo es mínimo comparado a los rastreos normales de Python:


@itemize *

@item 
Solo se soporta ASCII. El gestor de errores @code{backslashreplace} se utiliza en la codificación.

@item 
Cada cadena de caracteres está limitada a 500 caracteres.

@item 
Solo se muestran el nombre de archivo, el nombre de la función y el número de línea. (sin código fuente)

@item 
Está limitado a 100 frames y 100 hilos.

@item 
El orden se invierte: la llamada más reciente se muestra primero.
@end itemize

Por defecto, el rastreo de Python se escribe en @ref{9cc,,sys.stderr}. Para ver los rastreos, las aplicaciones deben ejecutarse en la terminal. Alternativamente se puede pasar un archivo de registro a @ref{d27,,faulthandler.enable()}.

El módulo está implementado en C, así los rastreos se pueden volcar en un fallo o cuando Python está en bloqueo mutuo.

El @ref{356,,Modo de Desarrollo Python} llama a @code{failurehandler.enable()} al inicio de Python.


@subsubheading Ver también



@table @asis

@item Módulo @ref{a5,,pdb}

Depurador interactivo de código fuente para programas en Python.

@item Módulo @ref{fe,,traceback}

Interfaz estándar para extraer, formatear e imprimir trazas de pila de programas en Python.
@end table


@menu
* Volcar el rastreo:: 
* Estado del gestor de fallos:: 
* Volcar los rastreos después de un tiempo de espera:: 
* Volcar el rastreo en una señal del usuario:: 
* Problema con descriptores de archivo:: 
* Ejemplo: Ejemplo<13>. 

@end menu

@node Volcar el rastreo,Estado del gestor de fallos,,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-traceback}@anchor{415e}
@subsubsection Volcar el rastreo


@geindex dump_traceback() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler dump_traceback}@anchor{e83}
@deffn {Función} faulthandler.dump_traceback (file=sys.stderr, all_threads=True)

Vuelca los rastreos de todos los hilos en el archivo `file'. Si `all_threads' es @code{False}, vuelca solo el hilo actual.


@subsubheading Ver también


@ref{f08,,traceback.print_tb()}, que se puede utilizar para imprimir un objeto de traza de pila.



Distinto en la versión 3.5: Se añadió soporte para pasar el descriptor de archivo a esta función.

@end deffn

@node Estado del gestor de fallos,Volcar los rastreos después de un tiempo de espera,Volcar el rastreo,faulthandler — Dump the Python traceback
@anchor{library/faulthandler fault-handler-state}@anchor{415f}
@subsubsection Estado del gestor de fallos


@geindex enable() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler enable}@anchor{d27}
@deffn {Función} faulthandler.enable (file=sys.stderr, all_threads=True)

Enable the fault handler: install handlers for the @ref{1d4f,,SIGSEGV},
@ref{1d50,,SIGFPE}, @ref{1d51,,SIGABRT}, @ref{1d52,,SIGBUS}
and @ref{1d53,,SIGILL}
signals to dump the Python traceback. If `all_threads' is @code{True},
produce tracebacks for every running thread. Otherwise, dump only the current
thread.

El archivo `file' se debe mantener abierto hasta que se desactive el gestor de fallos: ver @ref{4160,,problema con descriptores de archivo}.


Distinto en la versión 3.5: Se añadió soporte para pasar el descriptor de archivo a esta función.



Distinto en la versión 3.6: En Windows, también se instaló un gestor para la excepción de Windows.



Distinto en la versión 3.10: Ahora el volcado menciona si se está ejecutando una colección de recolectores de basura si `all_threads' es verdadero.

@end deffn

@geindex disable() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler disable}@anchor{4161}
@deffn {Función} faulthandler.disable ()

Desactiva el gestor de fallos: desinstala los gestores de señales instalados por @ref{d27,,enable()}.
@end deffn

@geindex is_enabled() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler is_enabled}@anchor{4162}
@deffn {Función} faulthandler.is_enabled ()

Comprueba si el gestor de fallos está activado.
@end deffn

@node Volcar los rastreos después de un tiempo de espera,Volcar el rastreo en una señal del usuario,Estado del gestor de fallos,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-tracebacks-after-a-timeout}@anchor{4163}
@subsubsection Volcar los rastreos después de un tiempo de espera


@geindex dump_traceback_later() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler dump_traceback_later}@anchor{e84}
@deffn {Función} faulthandler.dump_traceback_later (timeout, repeat=False, file=sys.stderr, exit=False)

Dump the tracebacks of all threads, after a timeout of `timeout' seconds, or
every `timeout' seconds if `repeat' is @code{True}.  If `exit' is @code{True}, call
@code{_exit()} with status=1 after dumping the tracebacks.  (Note
@code{_exit()} exits the process immediately, which means it doesn’t do any
cleanup like flushing file buffers.) If the function is called twice, the new
call replaces previous parameters and resets the timeout. The timer has a
sub-second resolution.

El archivo `file' se debe mantener abierto hasta que se vuelque el rastreo o se llame a @ref{4164,,cancel_dump_traceback_later()}: ver @ref{4160,,problema con descriptores de archivo}.

Esta función está implementada utilizando un hilo vigilante.


Distinto en la versión 3.5: Se añadió soporte para pasar el descriptor de archivo a esta función.



Distinto en la versión 3.7: Ahora esta función está siempre disponible.

@end deffn

@geindex cancel_dump_traceback_later() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler cancel_dump_traceback_later}@anchor{4164}
@deffn {Función} faulthandler.cancel_dump_traceback_later ()

Cancela la última llamada a @ref{e84,,dump_traceback_later()}.
@end deffn

@node Volcar el rastreo en una señal del usuario,Problema con descriptores de archivo,Volcar los rastreos después de un tiempo de espera,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-traceback-on-a-user-signal}@anchor{4165}
@subsubsection Volcar el rastreo en una señal del usuario


@geindex register() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler register}@anchor{e82}
@deffn {Función} faulthandler.register (signum, file=sys.stderr, all_threads=True, chain=False)

Registra una señal del usuario: instala un gestor para la señal `signum' para volcar el rastreo de todos los hilos, o del hilo actual si `all_threads' es @code{False}, en el archivo file. Llama al gestor previo si chain es @code{True}.

El archivo `file' se debe mantener abierto hasta que la señal sea anulada por @ref{4166,,unregister()}: ver @ref{4160,,problema con descriptores de archivo}.

No está disponible en Windows.


Distinto en la versión 3.5: Se añadió soporte para pasar el descriptor de archivo a esta función.

@end deffn

@geindex unregister() (en el módulo faulthandler)
@anchor{library/faulthandler faulthandler unregister}@anchor{4166}
@deffn {Función} faulthandler.unregister (signum)

Anula una señal del usuario: desinstala el gestor de la señal `signum' instalada por @ref{e82,,register()}. Retorna @code{True} si la señal fue registrada, @code{False} en otro caso.

No está disponible en Windows.
@end deffn

@node Problema con descriptores de archivo,Ejemplo<13>,Volcar el rastreo en una señal del usuario,faulthandler — Dump the Python traceback
@anchor{library/faulthandler faulthandler-fd}@anchor{4160}@anchor{library/faulthandler issue-with-file-descriptors}@anchor{4167}
@subsubsection Problema con descriptores de archivo


@ref{d27,,enable()}, @ref{e84,,dump_traceback_later()} y @ref{e82,,register()} guardan el descriptor de archivo de su argumento `file'. Si se cierra el archivo y su descriptor de archivo es reutilizado por un nuevo archivo, o si se usa @ref{beb,,os.dup2()} para reemplazar el descriptor de archivo, el rastreo se escribirá en un archivo diferente. Llame a estas funciones nuevamente cada vez que se reemplace el archivo.

@node Ejemplo<13>,,Problema con descriptores de archivo,faulthandler — Dump the Python traceback
@anchor{library/faulthandler example}@anchor{4168}
@subsubsection Ejemplo


Ejemplo de un fallo de segmentación en Linux con y sin activar el gestor de fallos:

@example
$ python -c "import ctypes; ctypes.string_at(0)"
Segmentation fault

$ python -q -X faulthandler
>>> import ctypes
>>> ctypes.string_at(0)
Fatal Python error: Segmentation fault

Current thread 0x00007fb899f39700 (most recent call first):
  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
  File "<stdin>", line 1 in <module>
Segmentation fault
@end example

@node pdb — El Depurador de Python,Los perfiladores de Python,faulthandler — Dump the Python traceback,Depuración y perfilado
@anchor{library/pdb doc}@anchor{4169}@anchor{library/pdb debugger}@anchor{416a}@anchor{library/pdb module-pdb}@anchor{a5}@anchor{library/pdb pdb-the-python-debugger}@anchor{416b}
@subsection @code{pdb} — El Depurador de Python


@geindex module; pdb

`Código fuente:' Lib/unittest/mock.py@footnote{https://github.com/python/cpython/tree/main/Lib/unittest/mock.py}

@geindex debugging


__________________________________________________________________


El módulo @ref{a5,,pdb} define un depurador de código fuente interactivo para programas Python.  Soporta el establecimiento de puntos de ruptura (condicionales) y pasos sencillos a nivel de línea de código fuente, inspección de marcos de pila, listado de código fuente, y evaluación de código Python arbitrario en el contexto de cualquier marco de pila.  También soporta depuración post-mortem y puede ser llamado bajo control del programa.

@geindex Pdb (class in pdb)
@geindex module;bdb
@geindex module;cmd

El depurador es extensible – en realidad se define como la clase @ref{1a8,,Pdb}. Esto no está actualmente documentado pero se entiende fácilmente leyendo la fuente.  La interfaz de extensión usa los módulos @ref{10,,bdb} y @ref{1a,,cmd}.


@subsubheading Ver también



@table @asis

@item Module @ref{58,,faulthandler}

Used to dump Python tracebacks explicitly, on a fault, after a timeout,
or on a user signal.

@item Module @ref{fe,,traceback}

Standard interface to extract, format and print stack traces of Python programs.
@end table


The typical usage to break into the debugger is to insert:

@example
import pdb; pdb.set_trace()
@end example

Or:

@example
breakpoint()
@end example

at the location you want to break into the debugger, and then run the program.
You can then step through the code following this statement, and continue
running without the debugger using the @ref{416c,,continue} command.


Distinto en la versión 3.7: The built-in @ref{1a6,,breakpoint()}, when called with defaults, can be used
instead of @code{import pdb; pdb.set_trace()}.


@example
def double(x):
   breakpoint()
   return x * 2
val = 3
print(f"@{val@} * 2 is @{double(val)@}")
@end example

The debugger’s prompt is @code{(Pdb)}, which is the indicator that you are in debug mode:

@example
> ...(2)double()
-> breakpoint()
(Pdb) p x
3
(Pdb) continue
3 * 2 is 6
@end example


Distinto en la versión 3.3: La finalización de tabulación a través del módulo @ref{ba,,readline} está disponible para comandos y argumentos de comando, por ejemplo. Los nombres globales y locales actuales se ofrecen como argumentos del comando @code{p}.


You can also invoke @ref{a5,,pdb} from the command line to debug other scripts.  For
example:

@example
python -m pdb myscript.py
@end example

When invoked as a module, pdb will automatically enter post-mortem debugging if
the program being debugged exits abnormally.  After post-mortem debugging (or
after normal exit of the program), pdb will restart the program.  Automatic
restarting preserves pdb’s state (such as breakpoints) and in most cases is more
useful than quitting the debugger upon program’s exit.


Distinto en la versión 3.2: Added the @code{-c} option to execute commands as if given
in a @code{.pdbrc} file; see @ref{416d,,Comandos del depurador}.



Distinto en la versión 3.7: Added the @code{-m} option to execute modules similar to the way
@code{python -m} does. As with a script, the debugger will pause execution just
before the first line of the module.


Typical usage to execute a statement under control of the debugger is:

@example
>>> import pdb
>>> def f(x):
...     print(1 / x)
>>> pdb.run("f(2)")
> <string>(1)<module>()
(Pdb) continue
0.5
>>>
@end example

El uso típico para inspeccionar un programa que se ha estrellado es:

@example
>>> import pdb
>>> def f(x):
...     print(1 / x)
...
>>> f(0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in f
ZeroDivisionError: division by zero
>>> pdb.pm()
> <stdin>(2)f()
(Pdb) p x
0
(Pdb)
@end example


Distinto en la versión 3.13: The implementation of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} means that name assignments made via @code{pdb}
will immediately affect the active scope, even when running inside an
@ref{2e9,,optimized scope}.


El módulo define las siguientes funciones; cada una de ellas entra en el depurador de una manera ligeramente diferente:

@geindex run() (en el módulo pdb)
@anchor{library/pdb pdb run}@anchor{3f75}
@deffn {Función} pdb.run (statement, globals=None, locals=None)

Ejecutar el `statement' (dado como una cadena o un objeto de código) bajo el control del depurador.  El prompt del depurador aparece antes de que se ejecute cualquier código; puedes establecer puntos de ruptura y escribir @ref{416c,,continue}, o puedes pasar por la declaración usando @ref{416e,,step} o @ref{416f,,next} (todos estos comandos se explican más abajo).  Los argumentos opcionales `globals' y `locals' especifican el entorno en el que se ejecuta el código; por defecto se utiliza el diccionario del módulo @ref{1,,__main__}.  (Ver la explicación de las funciones incorporadas @ref{2ea,,exec()} o @ref{2eb,,eval()}).
@end deffn

@geindex runeval() (en el módulo pdb)
@anchor{library/pdb pdb runeval}@anchor{4170}
@deffn {Función} pdb.runeval (expression, globals=None, locals=None)

Evaluate the `expression' (given as a string or a code object) under debugger
control.  When @ref{4170,,runeval()} returns, it returns the value of the
`expression'.  Otherwise this function is similar to @ref{3f75,,run()}.
@end deffn

@geindex runcall() (en el módulo pdb)
@anchor{library/pdb pdb runcall}@anchor{4171}
@deffn {Función} pdb.runcall (function, *args, **kwds)

Llama a la `function' (un objeto de función o método, no una cadena) con los argumentos dados.  Cuando @ref{4171,,runcall()} retorna, retorna lo que sea que la llamada de la función haya retornado.  El aviso del depurador aparece tan pronto como se introduce la función.
@end deffn

@geindex set_trace() (en el módulo pdb)
@anchor{library/pdb pdb set_trace}@anchor{1a7}
@deffn {Función} pdb.set_trace (*, header=None, commands=None)

Enter the debugger at the calling stack frame.  This is useful to hard-code
a breakpoint at a given point in a program, even if the code is not
otherwise being debugged (e.g. when an assertion fails).  If given,
`header' is printed to the console just before debugging begins.
The `commands' argument, if given, is a list of commands to execute
when the debugger starts.


Distinto en la versión 3.7: El argumento de la palabra clave `header'.



Distinto en la versión 3.13: @ref{1a7,,set_trace()} will enter the debugger immediately, rather than
on the next line of code to be executed.



Added in version 3.14: The `commands' argument.

@end deffn

@geindex post_mortem() (en el módulo pdb)
@anchor{library/pdb pdb post_mortem}@anchor{141a}
@deffn {Función} pdb.post_mortem (traceback=None)

Ingresa a la depuración post-mortem del objeto `traceback' dado.  Si no se da un `traceback', utiliza el de la excepción que se está manejando actualmente (una excepción debe ser manejada si se va a utilizar el predeterminado).
@end deffn

@geindex pm() (en el módulo pdb)
@anchor{library/pdb pdb pm}@anchor{390}
@deffn {Función} pdb.pm ()

Enter post-mortem debugging of the exception found in
@ref{565,,sys.last_exc}.
@end deffn

Las funciones @code{run*} y @ref{1a7,,set_trace()} son alias para instanciar la clase @ref{1a8,,Pdb} y llamar al método del mismo nombre.  Si quieres acceder a más funciones, tienes que hacerlo tú mismo:

@geindex Pdb (clase en pdb)
@anchor{library/pdb pdb Pdb}@anchor{1a8}
@deffn {Clase} pdb.Pdb (completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True, mode=None)

@ref{1a8,,Pdb} es la clase de depuración.

Los argumentos `completekey', `stdin' y `stdout' se pasan a la subyacente @ref{16cf,,cmd.Cmd} class; ver la descripción allí.

El argumento `skip', si se da, debe ser un iterable de los patrones de nombre de los módulos de estilo global.  El depurador no entrará en marcos que se originen en un módulo que coincida con uno de estos patrones. @footnote{
Si se considera que un marco se origina en un determinado módulo se determina por el @code{__name__} en el marcos globales.
}

By default, Pdb sets a handler for the SIGINT signal (which is sent when the
user presses @code{Ctrl-C} on the console) when you give a @ref{416c,,continue} command.
This allows you to break into the debugger again by pressing @code{Ctrl-C}.  If you
want Pdb not to touch the SIGINT handler, set `nosigint' to true.

El argumento * readrc * por defecto es verdadero y controla si Pdb cargará archivos .pdbrc desde el sistema de archivos.

The `mode' argument specifies how the debugger was invoked.
It impacts the workings of some debugger commands.
Valid values are @code{'inline'} (used by the breakpoint() builtin),
@code{'cli'} (used by the command line invocation)
or @code{None} (for backwards compatible behaviour, as before the `mode'
argument was added).

Ejemplo de llamada para permitir el rastreo con `skip':

@example
import pdb; pdb.Pdb(skip=['django.*']).set_trace()
@end example

Levanta una @ref{18c3,,auditing event} @code{pdb.Pdb} sin argumentos.


Distinto en la versión 3.1: Added the `skip' parameter.



Distinto en la versión 3.2: Added the `nosigint' parameter.
Previously, a SIGINT handler was never set by Pdb.



Distinto en la versión 3.6: El argumento `readrc'.



Added in version 3.14: Added the `mode' argument.


@geindex run() (método de pdb.Pdb)
@geindex runeval() (método de pdb.Pdb)
@geindex runcall() (método de pdb.Pdb)
@geindex set_trace() (método de pdb.Pdb)
@anchor{library/pdb pdb Pdb run}@anchor{4172}
@deffn {Método} run (statement, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runeval}@anchor{4173}
@deffnx {Método} runeval (expression, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runcall}@anchor{4174}
@deffnx {Método} runcall (function, *args, **kwds)
@anchor{library/pdb pdb Pdb set_trace}@anchor{1a9}
@deffnx {Método} set_trace ()

Véase la documentación para las funciones explicadas anteriormente.
@end deffn
@end deffn

@menu
* Comandos del depurador:: 

@end menu

@node Comandos del depurador,,,pdb — El Depurador de Python
@anchor{library/pdb debugger-commands}@anchor{416d}@anchor{library/pdb id2}@anchor{4175}
@subsubsection Comandos del depurador


Los comandos reconocidos por el depurador se enumeran a continuación.  La mayoría de los comandos pueden abreviarse a una o dos letras como se indica; por ejemplo, @code{h(elp)} significa que se puede usar @code{h} o @code{help} para introducir el comando de ayuda (pero no @code{he} o @code{hel}, ni @code{H} o @code{Help} o @code{HELP}).  Los argumentos de los comandos deben estar separados por espacios en blanco (espacios o tabulaciones).  Los argumentos opcionales están encerrados entre corchetes (@code{[]}) en la sintaxis del comando; los corchetes no deben escribirse.  Las alternativas en la sintaxis de los comandos están separadas por una barra vertical (@code{|}).

Introducir una línea en blanco repite el último comando introducido.  Excepción: si el último comando fue un @ref{4176,,list} comando, las siguientes 11 líneas están listadas.

Se supone que los comandos que el depurador no reconoce son declaraciones en Python y se ejecutan en el contexto del programa que se está depurando.  Las declaraciones en Python también pueden ser precedidas por un signo de exclamación (@code{!}).  Esta es una manera poderosa de inspeccionar el programa que se está depurando; incluso es posible cambiar una variable o llamar a una función.  Cuando se produce una excepción en una sentencia de este tipo, se imprime el nombre de la excepción pero no se cambia el estado del depurador.


Distinto en la versión 3.13: Expressions/Statements whose prefix is a pdb command are now correctly
identified and executed.


El depurador soporta @ref{4177,,aliases}.  Los alias pueden tener parámetros que permiten un cierto nivel de adaptabilidad al contexto que se está examinando.

Multiple commands may be entered on a single line, separated by @code{;;}.  (A
single @code{;} is not used as it is the separator for multiple commands in a line
that is passed to the Python parser.)  No intelligence is applied to separating
the commands; the input is split at the first @code{;;} pair, even if it is in the
middle of a quoted string. A workaround for strings with double semicolons
is to use implicit string concatenation @code{';'@w{'};'} or @code{";"";"}.

To set a temporary global variable, use a `convenience variable'. A `convenience
variable' is a variable whose name starts with @code{$}.  For example, @code{$foo = 1}
sets a global variable @code{$foo} which you can use in the debugger session.  The
`convenience variables' are cleared when the program resumes execution so it’s
less likely to interfere with your program compared to using normal variables
like @code{foo = 1}.

There are three preset `convenience variables':


@itemize *

@item 
@code{$_frame}: the current frame you are debugging

@item 
@code{$_retval}: the return value if the frame is returning

@item 
@code{$_exception}: the exception if the frame is raising an exception
@end itemize


Added in version 3.12: Added the `convenience variable' feature.


@geindex .pdbrc;file
@geindex debugger;configuration;file

If a file @code{.pdbrc} exists in the user’s home directory or in the current
directory, it is read with @code{'utf-8'} encoding and executed as if it had been
typed at the debugger prompt, with the exception that empty lines and lines
starting with @code{#} are ignored.  This is particularly useful for aliases.  If both
files exist, the one in the home directory is read first and aliases defined there
can be overridden by the local file.


Distinto en la versión 3.2: @code{.pdbrc} puede ahora contener comandos que continúan depurando, como @ref{416c,,continue} o @ref{416f,,next}.  Anteriormente, estos comandos no tenían ningún efecto.



Distinto en la versión 3.11: @code{.pdbrc} es ahora leído con codificación @code{'utf-8'}. Antes, era leído con la codificación correspondiente a la configuración regional del sistema.


@geindex help (pdb command)
@anchor{library/pdb pdbcommand-help}@anchor{4178}
@deffn {Pdbcommand} h(elp) [command]

Sin argumento, imprime la lista de comandos disponibles.  Con un `command' como argumento, imprime la ayuda sobre ese comando.  @code{help pdb} muestra la documentación completa (el docstring del módulo @ref{a5,,pdb}).  Como el argumento `command' debe ser un identificador, hay que introducir @code{help exec} para obtener ayuda sobre el comando @code{!}.
@end deffn

@geindex where (pdb command)
@anchor{library/pdb pdbcommand-where}@anchor{4179}
@deffn {Pdbcommand} w(here) [count]

Print a stack trace, with the most recent frame at the bottom.  if `count'
is 0, print the current frame entry. If `count' is negative, print the least
recent - `count' frames. If `count' is positive, print the most recent
`count' frames.  An arrow (@code{>})
indicates the current frame, which determines the context of most commands.


Distinto en la versión 3.14: `count' argument is added.

@end deffn

@geindex down (pdb command)
@anchor{library/pdb pdbcommand-down}@anchor{417a}
@deffn {Pdbcommand} d(own) [count]

Mueve los niveles del marco actual `count' (por defecto uno) hacia abajo en el trazado de la pila (`stack trace') (a un marco más nuevo).
@end deffn

@geindex up (pdb command)
@anchor{library/pdb pdbcommand-up}@anchor{417b}
@deffn {Pdbcommand} u(p) [count]

Mueve el marco actual `count' (por defecto uno) niveles hacia arriba en el trazado de la pila (`stack trace') (a un marco más antiguo).
@end deffn

@geindex break (pdb command)
@anchor{library/pdb pdbcommand-break}@anchor{417c}
@deffn {Pdbcommand} b(reak) [([filename:]lineno | function) [, condition]]

With a `lineno' argument, set a break at line `lineno' in the current file.
The line number may be prefixed with a `filename' and a colon,
to specify a breakpoint in another file (possibly one that hasn’t been loaded
yet).  The file is searched on @ref{27e,,sys.path}.  Acceptable forms of `filename'
are @code{/abspath/to/file.py}, @code{relpath/file.py}, @code{module} and
@code{package.module}.

With a `function' argument, set a break at the first executable statement within
that function. `function' can be any expression that evaluates to a function
in the current namespace.

Si un segundo argumento está presente, es una expresión que debe ser evaluada como verdadera antes de que el punto de ruptura sea honrado.

Sin argumento, enumere todas las interrupciones, incluyendo para cada punto de interrupción, el número de veces que se ha alcanzado ese punto de interrupción, el conteo de ignorancia actual y la condición asociada, si la hay.

Each breakpoint is assigned a number to which all the other
breakpoint commands refer.
@end deffn

@geindex tbreak (pdb command)
@anchor{library/pdb pdbcommand-tbreak}@anchor{417d}
@deffn {Pdbcommand} tbreak [([filename:]lineno | function) [, condition]]

Punto de interrupción temporal, que se elimina automáticamente cuando se ejecuta por primera vez. Los argumentos son los mismos que para @ref{417c,,break}.
@end deffn

@geindex clear (pdb command)
@anchor{library/pdb pdbcommand-clear}@anchor{417e}
@deffn {Pdbcommand} cl(ear) [filename:lineno | bpnumber ...]

Con el argumento `filename:lineno', despeja todos los puntos de interrupción en esta línea. Con una lista de números de puntos de interrupción separados por espacios, despeja esos puntos de interrupción. Sin el argumento, despeja todos los puntos de interrupción (pero primero pide confirmación).
@end deffn

@geindex disable (pdb command)
@anchor{library/pdb pdbcommand-disable}@anchor{417f}
@deffn {Pdbcommand} disable bpnumber [bpnumber ...]

Deshabilitar los puntos de ruptura interrupción como una lista de números de puntos de ruptura separados por espacios.  Desactivar un punto de interrupción significa que no puede hacer que el programa detenga la ejecución, pero a diferencia de borrar un punto de interrupción, permanece en la lista de puntos de interrupción y puede ser (re)activado.
@end deffn

@geindex enable (pdb command)
@anchor{library/pdb pdbcommand-enable}@anchor{4180}
@deffn {Pdbcommand} enable bpnumber [bpnumber ...]

Habilitar los puntos de interrupción especificados.
@end deffn

@geindex ignore (pdb command)
@anchor{library/pdb pdbcommand-ignore}@anchor{4181}
@deffn {Pdbcommand} ignore bpnumber [count]

Set the ignore count for the given breakpoint number.  If `count' is omitted,
the ignore count is set to 0.  A breakpoint becomes active when the ignore
count is zero.  When non-zero, the `count' is decremented each time the
breakpoint is reached and the breakpoint is not disabled and any associated
condition evaluates to true.
@end deffn

@geindex condition (pdb command)
@anchor{library/pdb pdbcommand-condition}@anchor{4182}
@deffn {Pdbcommand} condition bpnumber [condition]

Establece una nueva `condition' para el punto de interrupción, una expresión que debe evaluarse como verdadera antes de que el punto de ruptura sea honrado.  Si la condición está ausente, se elimina cualquier condición existente, es decir, el punto de ruptura se hace incondicional.
@end deffn

@geindex commands (pdb command)
@anchor{library/pdb pdbcommand-commands}@anchor{1ab}
@deffn {Pdbcommand} commands [bpnumber]

Especifique una lista de comandos para el número del punto de interrupción `bpnumber'.  Los comandos mismos aparecen en las siguientes líneas.  Escriba una línea que contenga sólo @code{end} para terminar los comandos. Un ejemplo:

@example
(Pdb) commands 1
(com) p some_variable
(com) end
(Pdb)
@end example

Para eliminar todos los comandos de un punto de interrupción, escribe @code{commands}  y sigue inmediatamente con @code{end} , es decir, no des órdenes.

Sin el argumento `bpnumber', @code{commands} se refiere al último punto de interrupción establecido.

Puede utilizar los comandos de punto de interrupción para iniciar el programa de nuevo.  Simplemente usa el comando @ref{416c,,continue}, o @ref{416e,,step}, o cualquier otro comando que reanude la ejecución.

Specifying any command resuming execution
(currently @ref{416c,,continue}, @ref{416e,,step}, @ref{416f,,next},
@ref{4183,,return}, @ref{4184,,until}, @ref{4185,,jump}, @ref{4186,,quit} and their abbreviations)
terminates the command list (as if
that command was immediately followed by end). This is because any time you
resume execution (even with a simple next or step), you may encounter another
breakpoint—which could have its own command list, leading to ambiguities about
which list to execute.

If the list of commands contains the @code{silent} command, or a command that
resumes execution, then the breakpoint message containing information about
the frame is not displayed.


Distinto en la versión 3.14: Frame information will not be displayed if a command that resumes execution
is present in the command list.

@end deffn

@geindex step (pdb command)
@anchor{library/pdb pdbcommand-step}@anchor{416e}
@deffn {Pdbcommand} s(tep)

Ejecutar la línea actual, detenerse en la primera ocasión posible (ya sea en una función que se llame o en la siguiente línea de la función actual).
@end deffn

@geindex next (pdb command)
@anchor{library/pdb pdbcommand-next}@anchor{416f}
@deffn {Pdbcommand} n(ext)

Continúe la ejecución hasta que se alcance la siguiente línea de la función actual o vuelva.  (La diferencia entre @ref{416f,,next} y @ref{416e,,step} es que @ref{416e,,step} se detiene dentro de una función llamada, mientras que @ref{416f,,next} ejecuta las funciones llamadas a (casi) toda velocidad, deteniéndose sólo en la siguiente línea de la función actual).
@end deffn

@geindex until (pdb command)
@anchor{library/pdb pdbcommand-until}@anchor{4184}
@deffn {Pdbcommand} unt(il) [lineno]

Sin argumento, continúe la ejecución hasta que se alcance la línea con un número mayor que el actual.

With `lineno', continue execution until a line with a number greater or
equal to `lineno' is reached.  In both cases, also stop when the current frame
returns.


Distinto en la versión 3.2: Permita dar un número de línea explícito.

@end deffn

@geindex return (pdb command)
@anchor{library/pdb pdbcommand-return}@anchor{4183}
@deffn {Pdbcommand} r(eturn)

Continúe la ejecución hasta que vuelva la función actual.
@end deffn

@geindex continue (pdb command)
@anchor{library/pdb pdbcommand-continue}@anchor{416c}
@deffn {Pdbcommand} c(ont(inue))

Continúa la ejecución, sólo se detiene cuando se encuentra un punto de ruptura.
@end deffn

@geindex jump (pdb command)
@anchor{library/pdb pdbcommand-jump}@anchor{4185}
@deffn {Pdbcommand} j(ump) lineno

Establezca la siguiente línea que será ejecutada.  Sólo disponible en el marco de más bajo.  Esto te permite saltar hacia atrás y ejecutar el código de nuevo, o saltar hacia adelante para saltar el código que no quieres ejecutar.

Cabe señalar que no todos los saltos están permitidos – por ejemplo, no es posible saltar en medio de un bucle @ref{1eb,,for} o fuera de una cláusula @ref{a5c,,finally}.
@end deffn

@geindex list (pdb command)
@anchor{library/pdb pdbcommand-list}@anchor{4176}
@deffn {Pdbcommand} l(ist) [first[, last]]

Enumere el código fuente del archivo actual.  Sin argumentos, enumere 11 líneas alrededor de la línea actual o continúe la lista anterior.  Con @code{.} como argumento, enumere 11 líneas alrededor de la línea actual.  Con un argumento, enumere 11 líneas alrededor de esa línea.  Con dos argumentos, enumere el rango dado; si el segundo argumento es menor que el primero, se interpreta como un conteo.

La línea actual en el cuadro actual se indica con @code{->}.  Si se está depurando una excepción, la línea donde la excepción fue originalmente planteada o propagada se indica con @code{>>}, si difiere de la línea actual.


Distinto en la versión 3.2: Added the @code{>>} marker.

@end deffn

@geindex ll (pdb command)
@anchor{library/pdb pdbcommand-ll}@anchor{4187}
@deffn {Pdbcommand} ll | longlist

Enumere todos los códigos fuente de la función o marco actual.  Las líneas interesantes están marcadas como @ref{4176,,list}.


Added in version 3.2.

@end deffn

@geindex args (pdb command)
@anchor{library/pdb pdbcommand-args}@anchor{4188}
@deffn {Pdbcommand} a(rgs)

Print the arguments of the current function and their current values.
@end deffn

@geindex p (pdb command)
@anchor{library/pdb pdbcommand-p}@anchor{ff5}
@deffn {Pdbcommand} p expression

Evaluate `expression' in the current context and print its value.

@cartouche
@quotation Nota 
@code{print()} también se puede usar, pero no es un comando de depuración — esto ejecuta la función Python @ref{ff4,,print()}.
@end quotation
@end cartouche
@end deffn

@geindex pp (pdb command)
@anchor{library/pdb pdbcommand-pp}@anchor{4189}
@deffn {Pdbcommand} pp expression

Like the @ref{ff5,,p} command, except the value of `expression' is
pretty-printed using the @ref{ae,,pprint} module.
@end deffn

@geindex whatis (pdb command)
@anchor{library/pdb pdbcommand-whatis}@anchor{418a}
@deffn {Pdbcommand} whatis expression

Print the type of `expression'.
@end deffn

@geindex source (pdb command)
@anchor{library/pdb pdbcommand-source}@anchor{418b}
@deffn {Pdbcommand} source expression

Try to get source code of `expression' and display it.


Added in version 3.2.

@end deffn

@geindex display (pdb command)
@anchor{library/pdb pdbcommand-display}@anchor{1aa}
@deffn {Pdbcommand} display [expression]

Display the value of `expression' if it changed, each time execution stops
in the current frame.

Without `expression', list all display expressions for the current frame.

@cartouche
@quotation Nota 
Display evaluates `expression' and compares to the result of the previous
evaluation of `expression', so when the result is mutable, display may not
be able to pick up the changes.
@end quotation
@end cartouche

Example:

@example
lst = []
breakpoint()
pass
lst.append(1)
print(lst)
@end example

Display won’t realize @code{lst} has been changed because the result of evaluation
is modified in place by @code{lst.append(1)} before being compared:

@example
> example.py(3)<module>()
-> pass
(Pdb) display lst
display lst: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
(Pdb)
@end example

You can do some tricks with copy mechanism to make it work:

@example
> example.py(3)<module>()
-> pass
(Pdb) display lst[:]
display lst[:]: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
display lst[:]: [1]  [old: []]
(Pdb)
@end example


Added in version 3.2.

@end deffn

@geindex undisplay (pdb command)
@anchor{library/pdb pdbcommand-undisplay}@anchor{418c}
@deffn {Pdbcommand} undisplay [expression]

Do not display `expression' anymore in the current frame.  Without
`expression', clear all display expressions for the current frame.


Added in version 3.2.

@end deffn

@geindex interact (pdb command)
@anchor{library/pdb pdbcommand-interact}@anchor{418d}
@deffn {Pdbcommand} interact

Start an interactive interpreter (using the @ref{1b,,code} module) in a new
global namespace initialised from the local and global namespaces for the
current scope. Use @code{exit()} or @code{quit()} to exit the interpreter and
return to the debugger.

@cartouche
@quotation Nota 
As @code{interact} creates a new dedicated namespace for code execution,
assignments to variables will not affect the original namespaces.
However, modifications to any referenced mutable objects will be reflected
in the original namespaces as usual.
@end quotation
@end cartouche


Added in version 3.2.



Distinto en la versión 3.13: @code{exit()} and @code{quit()} can be used to exit the @ref{418d,,interact}
command.



Distinto en la versión 3.13: @ref{418d,,interact} directs its output to the debugger’s
output channel rather than @ref{9cc,,sys.stderr}.

@end deffn

@geindex alias (pdb command)
@anchor{library/pdb debugger-aliases}@anchor{4177}@anchor{library/pdb pdbcommand-alias}@anchor{418e}
@deffn {Pdbcommand} alias [name [command]]

Create an alias called `name' that executes `command'.  The `command' must
`not' be enclosed in quotes.  Replaceable parameters can be indicated by
@code{%1}, @code{%2}, … and @code{%9}, while @code{%*} is replaced by all the parameters.
If `command' is omitted, the current alias for `name' is shown. If no
arguments are given, all aliases are listed.

Los alias pueden anidarse y pueden contener cualquier cosa que se pueda teclear legalmente en el prompt de pdb.  Tenga en cuenta que los comandos internos de pdb `pueden' ser anulados por los alias.  Dicho comando se oculta hasta que se elimina el alias.  El alias se aplica de forma recursiva a la primera palabra de la línea de comandos; todas las demás palabras de la línea se dejan en paz.

Como ejemplo, aquí hay dos alias útiles (especialmente cuando se colocan en el archivo @code{.pdbrc}):

@example
# Print instance variables (usage "pi classInst")
alias pi for k in %1.__dict__.keys(): print(f"%1.@{k@} = @{%1.__dict__[k]@}")
# Print instance variables in self
alias ps pi self
@end example
@end deffn

@geindex unalias (pdb command)
@anchor{library/pdb pdbcommand-unalias}@anchor{418f}
@deffn {Pdbcommand} unalias name

Delete the specified alias `name'.
@end deffn

@geindex ! (pdb command)
@anchor{library/pdb pdbcommand-0}@anchor{4190}
@deffn {Pdbcommand} ! statement

Execute the (one-line) `statement' in the context of the current stack frame.
The exclamation point can be omitted unless the first word of the statement
resembles a debugger command, e.g.:

@example
(Pdb) ! n=42
(Pdb)
@end example

To set a global variable, you can prefix the assignment command with a
@ref{2f5,,global} statement on the same line, e.g.:

@example
(Pdb) global list_options; list_options = ['-l']
(Pdb)
@end example
@end deffn

@geindex run (pdb command)
@geindex restart (pdb command)
@anchor{library/pdb pdbcommand-run}@anchor{4191}
@deffn {Pdbcommand} run [args ...]
@anchor{library/pdb pdbcommand-restart}@anchor{4192}
@deffnx {Pdbcommand} restart [args ...]

Restart the debugged Python program.  If `args' is supplied, it is split
with @ref{c4,,shlex} and the result is used as the new @ref{12d2,,sys.argv}.
History, breakpoints, actions and debugger options are preserved.
@ref{4192,,restart} is an alias for @ref{4191,,run}.


Distinto en la versión 3.14: @ref{4191,,run} and @ref{4192,,restart} commands are disabled when the
debugger is invoked in @code{'inline'} mode.

@end deffn

@geindex quit (pdb command)
@anchor{library/pdb pdbcommand-quit}@anchor{4186}
@deffn {Pdbcommand} q(uit)

Salga del depurador.  El programa que se está ejecutando fue abortado.
@end deffn

@geindex debug (pdb command)
@anchor{library/pdb pdbcommand-debug}@anchor{4193}
@deffn {Pdbcommand} debug code

Enter a recursive debugger that steps through `code'
(which is an arbitrary expression or statement to be
executed in the current environment).
@end deffn

@geindex retval (pdb command)
@anchor{library/pdb pdbcommand-retval}@anchor{4194}
@deffn {Pdbcommand} retval

Print the return value for the last return of the current function.
@end deffn

@geindex exceptions (pdb command)
@anchor{library/pdb pdbcommand-exceptions}@anchor{391}
@deffn {Pdbcommand} exceptions [excnumber]

List or jump between chained exceptions.

When using @code{pdb.pm()}  or @code{Pdb.post_mortem(...)} with a chained exception
instead of a traceback, it allows the user to move between the
chained exceptions using @code{exceptions} command to list exceptions, and
@code{exception <number>} to switch to that exception.

Example:

@example
def out():
    try:
        middle()
    except Exception as e:
        raise ValueError("reraise middle() error") from e

def middle():
    try:
        return inner(0)
    except Exception as e:
        raise ValueError("Middle fail")

def inner(x):
    1 / x

 out()
@end example

calling @code{pdb.pm()} will allow to move between exceptions:

@example
> example.py(5)out()
-> raise ValueError("reraise middle() error") from e

(Pdb) exceptions
  0 ZeroDivisionError('division by zero')
  1 ValueError('Middle fail')
> 2 ValueError('reraise middle() error')

(Pdb) exceptions 0
> example.py(16)inner()
-> 1 / x

(Pdb) up
> example.py(10)middle()
-> return inner(0)
@end example


Added in version 3.13.

@end deffn

@subsubheading Notas de pie de página


@node Los perfiladores de Python,timeit — Measure execution time of small code snippets,pdb — El Depurador de Python,Depuración y perfilado
@anchor{library/profile doc}@anchor{4195}@anchor{library/profile profile}@anchor{4196}@anchor{library/profile the-python-profilers}@anchor{4197}
@subsection Los perfiladores de Python


`Código fuente:' Lib/profile.py@footnote{https://github.com/python/cpython/tree/main/Lib/profile.py} y Lib/pstats.py@footnote{https://github.com/python/cpython/tree/main/Lib/pstats.py}


__________________________________________________________________


@menu
* Introducción a los perfiladores:: 
* Manual instantáneo de usuario:: 
* Referencia del módulo profile y cProfile:: 
* La clase Stats:: 
* ¿Qué es el perfil determinista?:: 
* Limitaciones:: 
* Calibración:: 
* Usando un temporizador personalizado:: 

@end menu

@node Introducción a los perfiladores,Manual instantáneo de usuario,,Los perfiladores de Python
@anchor{library/profile introduction-to-the-profilers}@anchor{4198}@anchor{library/profile profiler-introduction}@anchor{4199}
@subsubsection Introducción a los perfiladores


@geindex deterministic profiling
@geindex profiling@comma{} deterministic

@ref{28,,cProfile} y @ref{af,,profile} proporcionan `deterministic profiling' de los programas de Python. `profile' es un conjunto de estadísticas que describe con qué frecuencia y durante cuánto tiempo se ejecutaron varias partes del programa. Estas estadísticas pueden formatearse en informes a través del módulo @ref{b0,,pstats}.

La biblioteca estándar de Python proporciona dos implementaciones diferentes de la misma interfaz de creación de perfiles:


@enumerate 

@item 
@ref{28,,cProfile} se recomienda para la mayoría de los usuarios; Es una extensión C con una sobrecarga razonable que la hace adecuada para perfilar programas de larga duración. Basado en @code{lsprof}, aportado por Brett Rosen y Ted Czotter.

@item 
@ref{af,,profile}, un módulo Python puro cuya interfaz es imitada por @ref{28,,cProfile}, pero que agrega una sobrecarga significativa a los programas perfilados. Si está intentando extender el generador de perfiles de alguna manera, la tarea podría ser más fácil con este módulo. Originalmente diseñado y escrito por Jim Roskind.
@end enumerate

@cartouche
@quotation Nota 
Los módulos del generador de perfiles están diseñados para proporcionar un perfil de ejecución para un programa determinado, no para fines de evaluación comparativa (para eso, está @ref{ef,,timeit} que permite obtener resultados razonablemente precisos). Esto se aplica particularmente a la evaluación comparativa del código Python contra el código C: los perfiladores introducen gastos generales para el código Python, pero no para las funciones de nivel C, por lo que el código C parecería más rápido que cualquier Python.
@end quotation
@end cartouche

@node Manual instantáneo de usuario,Referencia del módulo profile y cProfile,Introducción a los perfiladores,Los perfiladores de Python
@anchor{library/profile instant-user-s-manual}@anchor{419a}@anchor{library/profile profile-instant}@anchor{419b}
@subsubsection Manual instantáneo de usuario


Esta sección se proporciona a los usuarios que «no quieren leer el manual». Proporciona una visión general muy breve y permite a un usuario realizar perfiles rápidamente en una aplicación existente.

Para perfilar una función que toma un solo argumento, puede hacer:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")')
@end example

(Use @ref{af,,profile} en lugar de @ref{28,,cProfile} si este último no está disponible en su sistema.)

La acción anterior ejecutaría @ref{c5b,,re.compile()} e imprime resultados de perfil como los siguientes:

@example
      214 function calls (207 primitive calls) in 0.002 seconds

Ordered by: cumulative time

ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     1    0.000    0.000    0.002    0.002 @{built-in method builtins.exec@}
     1    0.000    0.000    0.001    0.001 <string>:1(<module>)
     1    0.000    0.000    0.001    0.001 __init__.py:250(compile)
     1    0.000    0.000    0.001    0.001 __init__.py:289(_compile)
     1    0.000    0.000    0.000    0.000 _compiler.py:759(compile)
     1    0.000    0.000    0.000    0.000 _parser.py:937(parse)
     1    0.000    0.000    0.000    0.000 _compiler.py:598(_code)
     1    0.000    0.000    0.000    0.000 _parser.py:435(_parse_sub)
@end example

The first line indicates that 214 calls were monitored.  Of those calls, 207
were `primitive', meaning that the call was not induced via recursion. The
next line: @code{Ordered by: cumulative time} indicates the output is sorted
by the @code{cumtime} values. The column headings include:


@table @asis

@item ncalls

por el número de llamadas.

@item tottime

para el tiempo total empleado en la función dada (y excluyendo el tiempo realizado en llamadas a subfunciones)

@item percall

es el cociente de @code{tottime} dividido por @code{ncalls}

@item cumtime

es el tiempo acumulado empleado en esta y todas las subfunciones (desde la invocación hasta la salida). Esta cifra es precisa `incluso' para funciones recursivas.

@item percall

es el cociente de @code{cumtime} dividido por llamadas primitivas

@item filename:lineno(function)

proporciona los datos respectivos de cada función
@end table

Cuando hay dos números en la primera columna (por ejemplo, @code{3/1}), significa que la función se repite. El segundo valor es el número de llamadas primitivas y el primero es el número total de llamadas. Tenga en cuenta que cuando la función no se repite, estos dos valores son iguales y solo se imprime la figura.

En lugar de imprimir la salida al final de la ejecución del perfil, puede guardar los resultados en un archivo especificando un nombre de archivo en la función @code{run()}:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")', 'restats')
@end example

La clase @ref{419c,,pstats.Stats} lee los resultados del perfil desde un archivo y los formatea de varias maneras.
@anchor{library/profile profile-cli}@anchor{419d}
Los archivos @ref{28,,cProfile} y @ref{af,,profile} también se pueden invocar como un script para perfilar otro script. Por ejemplo:

@example
python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)
@end example

@code{-o} escribe los resultados del perfil en un archivo en lugar de stdout

@code{-s} especifica uno de los valores de clasificación @ref{419e,,sort_stats()} para ordenar la salida. Esto solo se aplica cuando @code{-o} no se suministra.

@code{-m} especifica que se está perfilando un módulo en lugar de un script.


Added in version 3.7: Se agregó la opción @code{-m} a @ref{28,,cProfile}.



Added in version 3.8: Se agregó la opción @code{-m} a @ref{af,,profile}.


Los módulos @ref{b0,,pstats} clase @ref{419c,,Stats} tienen una variedad de métodos para manipular e imprimir los datos guardados en un archivo de resultados de perfil:

@example
import pstats
from pstats import SortKey
p = pstats.Stats('restats')
p.strip_dirs().sort_stats(-1).print_stats()
@end example

El método @ref{419f,,strip_dirs()} eliminó la ruta extraña de todos los nombres de módulos. El método @ref{419e,,sort_stats()} clasificó todas las entradas de acuerdo con el módulo/línea/nombre de cadena de caracteres estándar que se imprime. El método @ref{41a0,,print_stats()} imprimió todas las estadísticas. Puede intentar las siguientes llamadas de clasificación:

@example
p.sort_stats(SortKey.NAME)
p.print_stats()
@end example

La primera llamada realmente ordenará la lista por nombre de función, y la segunda llamada imprimirá las estadísticas. Las siguientes son algunas llamadas interesantes para experimentar:

@example
p.sort_stats(SortKey.CUMULATIVE).print_stats(10)
@end example

Esto ordena el perfil por tiempo acumulado en una función y luego solo imprime las diez líneas más significativas. Si desea comprender qué algoritmos están tomando tiempo, la línea anterior es lo que usaría.

Si estuviera buscando ver qué funciones se repetían mucho y toman mucho tiempo, usted haría:

@example
p.sort_stats(SortKey.TIME).print_stats(10)
@end example

para ordenar según el tiempo dedicado a cada función y luego imprimir las estadísticas de las diez funciones principales.

También puedes probar:

@example
p.sort_stats(SortKey.FILENAME).print_stats('__init__')
@end example

Esto ordenará todas las estadísticas por nombre de archivo y luego imprimirá estadísticas solo para los métodos de inicio de clase (ya que están escritos con @code{__init__} en ellos). Como último ejemplo, puedes probar:

@example
p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')
@end example

Esta línea clasifica las estadísticas con una clave primaria de tiempo y una clave secundaria de tiempo acumulado, y luego imprime algunas de las estadísticas. Para ser específicos, la lista primero se reduce al 50% (re: @code{.5}) de su tamaño original, luego solo se mantienen las líneas que contienen @code{`init} y se imprime esa sub-sublista.

Si se preguntó qué funciones denominaban las funciones anteriores, ahora podría (@code{p} todavía está ordenada según el último criterio) hacer:

@example
p.print_callers(.5, 'init')
@end example

y obtendría una lista de llamadas para cada una de las funciones enumeradas.

Si desea más funcionalidad, tendrá que leer el manual o adivinar lo que hacen las siguientes funciones:

@example
p.print_callees()
p.add('restats')
@end example

Invocado como un script, el módulo @ref{b0,,pstats} es un navegador de estadísticas para leer y examinar volcados de perfil. Tiene una interfaz simple orientada a la línea de comandos (implementada usando @ref{1a,,cmd}) y ayuda interactiva.

@node Referencia del módulo profile y cProfile,La clase Stats,Manual instantáneo de usuario,Los perfiladores de Python
@anchor{library/profile module-cProfile}@anchor{28}@anchor{library/profile profile-and-cprofile-module-reference}@anchor{41a1}
@subsubsection Referencia del módulo @code{profile} y @code{cProfile}


@geindex module; cProfile

@geindex module; profile
@anchor{library/profile module-profile}@anchor{af}
Los módulos @ref{af,,profile} y @ref{28,,cProfile} proporcionan las siguientes funciones:

@geindex run() (en el módulo profile)
@anchor{library/profile profile run}@anchor{41a2}
@deffn {Función} profile.run (command, filename=None, sort=-1)

Esta función toma un único argumento que se puede pasar a la función @ref{2ea,,exec()} y un nombre de archivo opcional. En todos los casos esta rutina ejecuta:

@example
exec(command, __main__.__dict__, __main__.__dict__)
@end example

y recopila estadísticas de perfiles de la ejecución. Si no hay ningún nombre de archivo, esta función crea automáticamente una instancia de @ref{419c,,Stats} e imprime un informe de perfil simple. Si se especifica el valor de clasificación, se pasa a esta instancia @ref{419c,,Stats} para controlar cómo se ordenan los resultados.
@end deffn

@geindex runctx() (en el módulo profile)
@anchor{library/profile profile runctx}@anchor{41a3}
@deffn {Función} profile.runctx (command, globals, locals, filename=None, sort=-1)

This function is similar to @ref{41a2,,run()}, with added arguments to supply the
globals and locals mappings for the `command' string. This routine
executes:

@example
exec(command, globals, locals)
@end example

y recopila estadísticas de perfiles como en la función @ref{41a2,,run()} anterior.
@end deffn

@geindex Profile (clase en profile)
@anchor{library/profile profile Profile}@anchor{a75}
@deffn {Clase} profile.Profile (timer=None, timeunit=0.0, subcalls=True, builtins=True)

Esta clase normalmente solo es usada si se necesita un control más preciso sobre la creación de perfiles que el que proporciona la función @code{cProfile.run()}.

Se puede suministrar un temporizador personalizado para medir cuánto tiempo tarda el código en ejecutarse mediante el argumento `timer'. Esta debe ser una función que retorna un solo número que representa la hora actual. Si el número es un entero, la `timeunit' especifica un multiplicador que especifica la duración de cada unidad de tiempo. Por ejemplo, si el temporizador retorna tiempos medidos en miles de segundos, la unidad de tiempo sería @code{.001}.

El uso directo de la clase @ref{a75,,Profile} permite formatear los resultados del perfil sin escribir los datos del perfil en un archivo:

@example
import cProfile, pstats, io
from pstats import SortKey
pr = cProfile.Profile()
pr.enable()
# ... do something ...
pr.disable()
s = io.StringIO()
sortby = SortKey.CUMULATIVE
ps = pstats.Stats(pr, stream=s).sort_stats(sortby)
ps.print_stats()
print(s.getvalue())
@end example

La clase @ref{a75,,Profile} también se puede usar como administrador de contexto (solo se admite en el módulo @ref{28,,cProfile}. Ver @ref{1fbf,,Tipos gestores de contexto}):

@example
import cProfile

with cProfile.Profile() as pr:
    # ... do something ...

    pr.print_stats()
@end example


Distinto en la versión 3.8: Se agregó soporte de administrador de contexto.


@geindex enable() (método de profile.Profile)
@anchor{library/profile profile Profile enable}@anchor{41a4}
@deffn {Método} enable ()

Comienza a recopilar datos de perfiles. Solo en @ref{28,,cProfile}.
@end deffn

@geindex disable() (método de profile.Profile)
@anchor{library/profile profile Profile disable}@anchor{41a5}
@deffn {Método} disable ()

Deja de recopilar datos de perfiles. Solo en @ref{28,,cProfile}.
@end deffn

@geindex create_stats() (método de profile.Profile)
@anchor{library/profile profile Profile create_stats}@anchor{41a6}
@deffn {Método} create_stats ()

Deja de recopilar datos de perfiles y registre los resultados internamente como el perfil actual.
@end deffn

@geindex print_stats() (método de profile.Profile)
@anchor{library/profile profile Profile print_stats}@anchor{41a7}
@deffn {Método} print_stats (sort=-1)

Crea un objeto @ref{419c,,Stats} en función del perfil actual e imprima los resultados en `stdout'.

The `sort' parameter specifies the sorting order of the displayed
statistics. It accepts a single key or a tuple of keys to enable
multi-level sorting, as in @ref{419e,,Stats.sort_stats}.


Added in version 3.13: @ref{41a7,,print_stats()} now accepts a tuple of keys.

@end deffn

@geindex dump_stats() (método de profile.Profile)
@anchor{library/profile profile Profile dump_stats}@anchor{41a8}
@deffn {Método} dump_stats (filename)

Escribe los resultados del perfil actual en `filename'.
@end deffn

@geindex run() (método de profile.Profile)
@anchor{library/profile profile Profile run}@anchor{41a9}
@deffn {Método} run (cmd)

Perfila el cmd a través de @ref{2ea,,exec()}.
@end deffn

@geindex runctx() (método de profile.Profile)
@anchor{library/profile profile Profile runctx}@anchor{41aa}
@deffn {Método} runctx (cmd, globals, locals)

Perfila el cmd a través de @ref{2ea,,exec()} con el entorno global y local especificado.
@end deffn

@geindex runcall() (método de profile.Profile)
@anchor{library/profile profile Profile runcall}@anchor{b0a}
@deffn {Método} runcall (func, /, *args, **kwargs)

Perfila @code{func(*args, **kwargs)}
@end deffn
@end deffn

Tenga en cuenta que la creación de perfiles solo funcionará si el comando/función llamado realmente regresa. Si el intérprete se termina (por ejemplo, a través de una llamada a @ref{13b0,,sys.exit()} durante la ejecución del comando/función llamado) no se imprimirán resultados de generación de perfiles.

@node La clase Stats,¿Qué es el perfil determinista?,Referencia del módulo profile y cProfile,Los perfiladores de Python
@anchor{library/profile profile-stats}@anchor{41ab}@anchor{library/profile the-stats-class}@anchor{41ac}
@subsubsection La clase @code{Stats}


El análisis de los datos del generador de perfiles es realizado utilizando la clase @ref{419c,,Stats}.

@geindex module; pstats

@geindex Stats (clase en pstats)
@anchor{library/profile module-pstats}@anchor{b0}@anchor{library/profile pstats Stats}@anchor{419c}
@deffn {Clase} pstats.Stats (*filenames or profile, stream=sys.stdout)

Este constructor de clase crea una instancia de un «objeto de estadísticas» a partir de un `filename' (o una lista de nombres de archivo) o de una instancia @code{Profile}. La salida se imprimirá en la secuencia especificada por `stream'.

El archivo seleccionado por el constructor anterior debe haber sido creado por la versión correspondiente de @ref{af,,profile} o @ref{28,,cProfile}. Para ser específicos, `no' hay compatibilidad de archivos garantizada con futuras versiones de este generador de perfiles, y no hay compatibilidad con archivos producidos por otros perfiladores, o el mismo generador de perfiles ejecutado en un sistema operativo diferente. Si se proporcionan varios archivos, se combinarán todas las estadísticas para funciones idénticas, de modo que se pueda considerar una vista general de varios procesos en un solo informe. Si es necesario combinar archivos adicionales con datos en un objeto existente @ref{419c,,Stats}, se puede usar el método @ref{41ad,,add()}.

En lugar de leer los datos del perfil de un archivo, se puede usar un objeto @code{cProfile.Profile} o @ref{a75,,profile.Profile} como fuente de datos del perfil.

los objetos @ref{419c,,Stats} tienen los siguientes métodos:

@geindex strip_dirs() (método de pstats.Stats)
@anchor{library/profile pstats Stats strip_dirs}@anchor{419f}
@deffn {Método} strip_dirs ()

Este método para la clase @ref{419c,,Stats} elimina toda la información de ruta principal de los nombres de archivo. Es muy útil para reducir el tamaño de la impresión para que quepa en (cerca de) 80 columnas. Este método modifica el objeto y se pierde la información eliminada. Después de realizar una operación de tira, se considera que el objeto tiene sus entradas en un orden «aleatorio», como lo fue justo después de la inicialización y carga del objeto. Si @ref{419f,,strip_dirs()} hace que dos nombres de funciones no se puedan distinguir (están en la misma línea del mismo nombre de archivo y tienen el mismo nombre de función), entonces las estadísticas para estas dos entradas se acumulan en un sola entrada.
@end deffn

@geindex add() (método de pstats.Stats)
@anchor{library/profile pstats Stats add}@anchor{41ad}
@deffn {Método} add (*filenames)

Este método de la clase @ref{419c,,Stats} acumula información de perfil adicional en el objeto de perfil actual. Sus argumentos deben referirse a los nombres de archivo creados por la versión correspondiente de @ref{41a2,,profile.run()} or @code{cProfile.run()}. Las estadísticas para funciones con nombre idéntico (re: archivo, línea, nombre) se acumulan automáticamente en estadísticas de función única.
@end deffn

@geindex dump_stats() (método de pstats.Stats)
@anchor{library/profile pstats Stats dump_stats}@anchor{41ae}
@deffn {Método} dump_stats (filename)

Guarda los datos cargados en el objeto @ref{419c,,Stats} en un archivo llamado `filename'. El archivo se crea si no existe y se sobrescribe si ya existe. Esto es equivalente al método del mismo nombre en las clases: class @ref{a75,,profile.Profile} y @code{cProfile.Profile}.
@end deffn

@geindex sort_stats() (método de pstats.Stats)
@anchor{library/profile pstats Stats sort_stats}@anchor{419e}
@deffn {Método} sort_stats (*keys)

Este método modifica el objeto @ref{419c,,Stats} ordenándolo de acuerdo con los criterios proporcionados. El argumento puede ser una cadena de caracteres o una enumeración SortKey que identifica la base de una clasificación (ejemplo: @code{'time'}, @code{'name'}, @code{SortKey.TIME} o @code{SortKey.NAME}). El argumento enumeraciones SortKey tiene ventaja sobre el argumento de cadena de caracteres en que es más robusto y menos propenso a errores.

Cuando se proporciona más de una llave, se utilizan llaves adicionales como criterios secundarios cuando hay igualdad en todas las llaves seleccionadas antes que ellas. Por ejemplo, @code{sort_stats(SortKey.NAME, SortKey.FILE)} ordenará todas las entradas de acuerdo con el nombre de su función y resolverá todos los vínculos (nombres de función idénticos) clasificándolos por nombre de archivo.

Para el argumento de cadena de caracteres, se pueden usar abreviaturas para cualquier nombre de llaves, siempre que la abreviatura no sea ambigua.

Los siguientes son la cadena de caracteres válida y SortKey:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Arg de cadena de caracteres válido

@tab

Arg de enumeración válido

@tab

Significado

@item

@code{'calls'}

@tab

SortKey.CALLS

@tab

recuento de llamadas

@item

@code{'cumulative'}

@tab

SortKey.CUMULATIVE

@tab

tiempo acumulado

@item

@code{'cumtime'}

@tab

N/A

@tab

tiempo acumulado

@item

@code{'file'}

@tab

N/A

@tab

nombre de archivo

@item

@code{'filename'}

@tab

SortKey.FILENAME

@tab

nombre de archivo

@item

@code{'module'}

@tab

N/A

@tab

nombre de archivo

@item

@code{'ncalls'}

@tab

N/A

@tab

recuento de llamadas

@item

@code{'pcalls'}

@tab

SortKey.PCALLS

@tab

recuento de llamadas primitivas

@item

@code{'line'}

@tab

SortKey.LINE

@tab

número de línea

@item

@code{'name'}

@tab

SortKey.NAME

@tab

nombre de la función

@item

@code{'nfl'}

@tab

SortKey.NFL

@tab

nombre/archivo/línea

@item

@code{'stdname'}

@tab

SortKey.STDNAME

@tab

nombre estándar

@item

@code{'time'}

@tab

SortKey.TIME

@tab

tiempo interno

@item

@code{'tottime'}

@tab

N/A

@tab

tiempo interno

@end multitable


Tenga en cuenta que todos los tipos de estadísticas están en orden descendente (colocando primero los elementos que requieren más tiempo), donde las búsquedas de nombre, archivo y número de línea están en orden ascendente (alfabético). La sutil distinción entre @code{SortKey.NFL} y @code{SortKey.STDNAME} es que el nombre estándar es una especie de nombre tal como está impreso, lo que significa que los números de línea incrustados se comparan de manera extraña. Por ejemplo, las líneas 3, 20 y 40 aparecerían (si los nombres de los archivos fueran los mismos) en el orden de las cadenas 20, 3 y 40. En contraste, @code{SortKey.NFL} hace una comparación numérica de los números de línea. De hecho, @code{sort_stats(SortKey.NFL)} es lo mismo que @code{sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)}.

Por razones de compatibilidad con versiones anteriores, se permiten los argumentos numéricos @code{-1}, @code{0}, @code{1}, y @code{2}. Se interpretan como @code{'stdname'}, @code{'calls'}, @code{'time'}, y @code{'cumulative'} respectivamente. Si se usa este formato de estilo antiguo (numérico), solo se usará una clave de clasificación (la tecla numérica) y los argumentos adicionales se ignorarán en silencio.

@c For compatibility with the old profiler.


Added in version 3.7: Enumeración SortKey añadida.

@end deffn

@geindex reverse_order() (método de pstats.Stats)
@anchor{library/profile pstats Stats reverse_order}@anchor{41af}
@deffn {Método} reverse_order ()

Este método para la clase @ref{419c,,Stats} invierte el orden de la lista básica dentro del objeto. Tenga en cuenta que, de forma predeterminada, el orden ascendente vs descendente se selecciona correctamente en función de la llave de clasificación elegida.

@c This method is provided primarily for compatibility with the old
@c profiler.
@end deffn

@geindex print_stats() (método de pstats.Stats)
@anchor{library/profile pstats Stats print_stats}@anchor{41a0}
@deffn {Método} print_stats (*restrictions)

Este método para la clase @ref{419c,,Stats} imprime un informe como se describe en la definición @ref{41a2,,profile.run()}.

El orden de la impresión se basa en la última operación @ref{419e,,sort_stats()} realizada en el objeto (sujeto a advertencias en @ref{41ad,,add()} y @ref{419f,,strip_dirs()}).

Los argumentos proporcionados (si los hay) se pueden usar para limitar la lista a las entradas significativas. Inicialmente, se considera que la lista es el conjunto completo de funciones perfiladas. Cada restricción es un número entero (para seleccionar un recuento de líneas), o una fracción decimal entre 0.0 y 1.0 inclusive (para seleccionar un porcentaje de líneas), o una cadena que se interpretará como una expresión regular (para que el patrón coincida con el nombre estándar eso está impreso). Si se proporcionan varias restricciones, se aplican secuencialmente. Por ejemplo:

@example
print_stats(.1, 'foo:')
@end example

primero limitaría la impresión al primer 10% de la lista, y luego solo imprimiría las funciones que formaban parte del nombre del archivo @code{.*foo:}. En contraste, el comando:

@example
print_stats('foo:', .1)
@end example

limitaría la lista a todas las funciones que tengan nombres de archivo: archivo @code{.*foo:}, y luego procedería a imprimir solo el primer 10% de ellas.
@end deffn

@geindex print_callers() (método de pstats.Stats)
@anchor{library/profile pstats Stats print_callers}@anchor{41b0}
@deffn {Método} print_callers (*restrictions)

Este método para la clase @ref{419c,,Stats} imprime una lista de todas las funciones que llamaron a cada función en la base de datos perfilada. El orden es idéntico al proporcionado por @ref{41a0,,print_stats()}, y la definición del argumento de restricción también es idéntica. Cada persona que llama se informa en su propia línea. El formato difiere ligeramente según el generador de perfiles que produjo las estadísticas:


@itemize *

@item 
Con @ref{af,,profile}, se muestra un número entre paréntesis después de cada llamada para mostrar cuántas veces se realizó esta llamada específica. Por conveniencia, un segundo número sin paréntesis repite el tiempo acumulado empleado en la función de la derecha.

@item 
Con @ref{28,,cProfile}, cada persona que llama está precedida por tres números: la cantidad de veces que se realizó esta llamada específica y los tiempos totales y acumulativos gastados en la función actual mientras fue invocada por esta persona que llama.
@end itemize
@end deffn

@geindex print_callees() (método de pstats.Stats)
@anchor{library/profile pstats Stats print_callees}@anchor{41b1}
@deffn {Método} print_callees (*restrictions)

Este método para la clase @ref{419c,,Stats} imprime una lista de todas las funciones que fueron llamadas por la función indicada. Aparte de esta inversión de la dirección de las llamadas (re: llamado vs fue llamado por), los argumentos y el orden son idénticos al método @ref{41b0,,print_callers()}.
@end deffn

@geindex get_stats_profile() (método de pstats.Stats)
@anchor{library/profile pstats Stats get_stats_profile}@anchor{41b2}
@deffn {Método} get_stats_profile ()

Este método retorna una instancia de StatsProfile, la cual contiene un mapeo de nombres de función a instancias de FunctionProfile. Cada instancia de FunctionProfile mantiene información relacionada al perfil de la función, como cuánto demoró la función en ejecutarse, cuantas veces fue llamada, etc…


Added in version 3.9: Añadidas las siguientes clases de datos: StatsProfile, FunctionProfile. Añadida la siguiente función: get_stats_profile.

@end deffn
@end deffn

@node ¿Qué es el perfil determinista?,Limitaciones,La clase Stats,Los perfiladores de Python
@anchor{library/profile deterministic-profiling}@anchor{41b3}@anchor{library/profile what-is-deterministic-profiling}@anchor{41b4}
@subsubsection ¿Qué es el perfil determinista?


`Deterministic profiling' está destinada a reflejar el hecho de que se supervisan todos los eventos `function call', `function return', y `exception', y se realizan temporizaciones precisas para los intervalos entre estos eventos (durante los cuales el código del usuario se está ejecutando). Por el contrario, `statistical profiling' (que no se realiza en este módulo) muestrea aleatoriamente el puntero de instrucción efectivo y deduce dónde se está gastando el tiempo. La última técnica tradicionalmente implica menos sobrecarga (ya que el código no necesita ser instrumentado), pero proporciona solo indicaciones relativas de dónde se está gastando el tiempo.

En Python, dado que hay un intérprete activo durante la ejecución, no se requiere la presencia de código instrumentado para realizar un perfil determinista. Python proporciona automáticamente un `hook' (retrollamada  opcional) para cada evento. Además, la naturaleza interpretada de Python tiende a agregar tanta sobrecarga a la ejecución, que los perfiles deterministas tienden a agregar solo una pequeña sobrecarga de procesamiento en aplicaciones típicas. El resultado es que el perfil determinista no es tan costoso, pero proporciona estadísticas extensas de tiempo de ejecución sobre la ejecución de un programa Python.

Las estadísticas de recuento de llamadas se pueden usar para identificar errores en el código (recuentos sorprendentes) e identificar posibles puntos de expansión en línea (recuentos altos de llamadas). Las estadísticas de tiempo interno se pueden utilizar para identificar «bucles activos» que deben optimizarse cuidadosamente. Las estadísticas de tiempo acumulativo deben usarse para identificar errores de alto nivel en la selección de algoritmos. Tenga en cuenta que el manejo inusual de los tiempos acumulativos en este generador de perfiles permite que las estadísticas de implementaciones recursivas de algoritmos se comparen directamente con implementaciones iterativas.

@node Limitaciones,Calibración,¿Qué es el perfil determinista?,Los perfiladores de Python
@anchor{library/profile limitations}@anchor{41b5}@anchor{library/profile profile-limitations}@anchor{41b6}
@subsubsection Limitaciones


Una limitación tiene que ver con la precisión de la información de sincronización. Hay un problema fundamental con los perfiladores deterministas que implican precisión. La restricción más obvia es que el «reloj» subyacente solo funciona a una velocidad (típicamente) de aproximadamente 0,001 segundos. Por lo tanto, ninguna medición será más precisa que el reloj subyacente. Si se toman suficientes medidas, entonces el «error» tenderá a promediar. Desafortunadamente, eliminar este primer error induce una segunda fuente de error.

El segundo problema es que «lleva un tiempo» desde que se distribuye un evento hasta que la llamada del generador de perfiles para obtener la hora en realidad `obtiene' el estado del reloj. Del mismo modo, hay un cierto retraso al salir del controlador de eventos del generador de perfiles desde el momento en que se obtuvo el valor del reloj (y luego se retiró), hasta que el código del usuario se está ejecutando nuevamente. Como resultado, las funciones que se llaman muchas veces, o llaman a muchas funciones, generalmente acumularán este error. El error que se acumula de esta manera es típicamente menor que la precisión del reloj (menos de un tic de reloj), pero `puede' acumularse y volverse muy significativo.

El problema es más importante con @ref{af,,profile} que con la sobrecarga inferior @ref{28,,cProfile}. Por esta razón, @ref{af,,profile} proporciona un medio para calibrarse a sí mismo para una plataforma dada para que este error pueda ser eliminado probabilísticamente (en promedio). Después de calibrar el generador de perfiles, será más preciso (en un sentido al menos cuadrado), pero a veces producirá números negativos (cuando el recuento de llamadas es excepcionalmente bajo y los dioses de la probabilidad trabajan en su contra :-) ) `No' se alarme por los números negativos en el perfil. Deberían aparecer `solo' si ha calibrado su generador de perfiles, y los resultados son realmente mejores que sin calibración.

@node Calibración,Usando un temporizador personalizado,Limitaciones,Los perfiladores de Python
@anchor{library/profile calibration}@anchor{41b7}@anchor{library/profile profile-calibration}@anchor{41b8}
@subsubsection Calibración


El generador de perfiles del módulo @ref{af,,profile} resta una constante de cada tiempo de manejo de eventos para compensar la sobrecarga de llamar a la función de tiempo y eliminar los resultados. Por defecto, la constante es 0. El siguiente procedimiento se puede usar para obtener una mejor constante para una plataforma dada (ver @ref{41b6,,Limitaciones}).

@example
import profile
pr = profile.Profile()
for i in range(5):
    print(pr.calibrate(10000))
@end example

El método ejecuta la cantidad de llamadas de Python dadas por el argumento, directamente y nuevamente bajo el generador de perfiles, midiendo el tiempo para ambos. Luego, calcula la sobrecarga oculta por evento del generador de perfiles y la retorna como un valor flotante. Por ejemplo, en un Intel Core i5 de 1.8Ghz que ejecuta macOS y usa el time.process_time () de Python como temporizador, el número mágico es aproximadamente 4.04e-6.

El objetivo de este ejercicio es obtener un resultado bastante consistente. Si su computadora es `muy' rápida, o su función de temporizador tiene una resolución pobre, es posible que tenga que pasar 100000, o incluso 1000000, para obtener resultados consistentes.

Cuando tiene una respuesta consistente, hay tres formas de usarla:

@example
import profile

# 1. Apply computed bias to all Profile instances created hereafter.
profile.Profile.bias = your_computed_bias

# 2. Apply computed bias to a specific Profile instance.
pr = profile.Profile()
pr.bias = your_computed_bias

# 3. Specify computed bias in instance constructor.
pr = profile.Profile(bias=your_computed_bias)
@end example

Si tiene una opción, es mejor que elija una constante más pequeña, y luego sus resultados «con menos frecuencia» se mostrarán como negativos en las estadísticas del perfil.

@node Usando un temporizador personalizado,,Calibración,Los perfiladores de Python
@anchor{library/profile profile-timers}@anchor{41b9}@anchor{library/profile using-a-custom-timer}@anchor{41ba}
@subsubsection Usando un temporizador personalizado


Si desea cambiar la forma en que se determina el tiempo actual (por ejemplo, para forzar el uso del tiempo del reloj de pared o el tiempo transcurrido del proceso), pase la función de temporización que desee a la clase constructora @code{Profile}:

@example
pr = profile.Profile(your_time_func)
@end example

El generador de perfiles resultante llamará a @code{your_time_func}. Dependiendo de si está utilizando @ref{a75,,profile.Profile} o @code{cProfile.Profile}, el valor de retorno de @code{your_time_func} se interpretará de manera diferente:


@table @asis

@item @ref{a75,,profile.Profile}

@code{your_time_func} debería retornar un solo número o una lista de números cuya suma es la hora actual (como lo que @ref{1187,,os.times()} retorna). Si la función retorna un número de tiempo único o la lista de números retornados tiene una longitud de 2, obtendrá una versión especialmente rápida de la rutina de envío.

Be warned that you should calibrate the profiler class for the timer function
that you choose (see @ref{41b8,,Calibración}).  For most machines, a timer
that returns a lone integer value will provide the best results in terms of
low overhead during profiling.  (@ref{1187,,os.times()} is `pretty' bad, as it
returns a tuple of floating-point values).  If you want to substitute a
better timer in the cleanest fashion, derive a class and hardwire a
replacement dispatch method that best handles your timer call, along with the
appropriate calibration constant.

@item @code{cProfile.Profile}

@code{your_time_func} debería retornar un solo número. Si retorna enteros, también puede invocar al constructor de la clase con un segundo argumento que especifique la duración real de una unidad de tiempo. Por ejemplo, si @code{your_integer_time_func} retorna tiempos medidos en miles de segundos, construiría la instancia @code{Profile} de la siguiente manera:

@example
pr = cProfile.Profile(your_integer_time_func, 0.001)
@end example

As the @code{cProfile.Profile} class cannot be calibrated, custom timer
functions should be used with care and should be as fast as possible.  For
the best results with a custom timer, it might be necessary to hard-code it
in the C source of the internal @code{_lsprof} module.
@end table

Python 3.3 agrega varias funciones nuevas en @ref{ee,,time} que se puede usar para realizar mediciones precisas del proceso o el tiempo del reloj de pared (`wall-clock time'). Por ejemplo, vea @ref{b14,,time.perf_counter()}.

@node timeit — Measure execution time of small code snippets,trace — Trace or track Python statement execution,Los perfiladores de Python,Depuración y perfilado
@anchor{library/timeit doc}@anchor{41bb}@anchor{library/timeit module-timeit}@anchor{ef}@anchor{library/timeit timeit-measure-execution-time-of-small-code-snippets}@anchor{41bc}
@subsection @code{timeit} — Measure execution time of small code snippets


@geindex module; timeit

`Código fuente:' Lib/timeit.py@footnote{https://github.com/python/cpython/tree/main/Lib/timeit.py}

@geindex Benchmarking
@geindex Performance


__________________________________________________________________


Este módulo proporciona una forma sencilla de cronometrar pequeños fragmentos de código Python. Tiene tanto una @ref{41bd,,Interfaz de línea de comandos} como una @ref{41be,,invocable}. Evita una serie de trampas comunes para medir los tiempos de ejecución. Véase también la introducción de Tim Peters al capítulo «Algoritmos» en la segunda edición de `Python Cookbook', publicado por O’Reilly.

@menu
* Ejemplos básicos:: 
* Interfaz de Python:: 
* Interfaz de línea de comandos: Interfaz de línea de comandos<4>. 
* Ejemplos: Ejemplos<28>. 

@end menu

@node Ejemplos básicos,Interfaz de Python,,timeit — Measure execution time of small code snippets
@anchor{library/timeit basic-examples}@anchor{41bf}
@subsubsection Ejemplos básicos


En el ejemplo siguiente se muestra cómo se puede utilizar @ref{41bd,,Interfaz de línea de comandos} para comparar tres expresiones diferentes:

@example
$ python -m timeit "'-'.join(str(n) for n in range(100))"
10000 loops, best of 5: 30.2 usec per loop
$ python -m timeit "'-'.join([str(n) for n in range(100)])"
10000 loops, best of 5: 27.5 usec per loop
$ python -m timeit "'-'.join(map(str, range(100)))"
10000 loops, best of 5: 23.2 usec per loop
@end example

Esto se puede lograr desde @ref{41be,,Interfaz de Python} con:

@example
>>> import timeit
>>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000)
0.3018611848820001
>>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000)
0.2727368790656328
>>> timeit.timeit('"-".join(map(str, range(100)))', number=10000)
0.23702679807320237
@end example

Un invocable también se puede pasar desde el @ref{41be,,Interfaz de Python}:

@example
>>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000)
0.19665591977536678
@end example

Sin embargo, tenga en cuenta que @ref{f01,,timeit()} determinará automáticamente el número de repeticiones solo cuando se utiliza la interfaz de línea de comandos.  En la sección @ref{41c0,,Ejemplos} puede encontrar ejemplos más avanzados.

@node Interfaz de Python,Interfaz de línea de comandos<4>,Ejemplos básicos,timeit — Measure execution time of small code snippets
@anchor{library/timeit id1}@anchor{41c1}@anchor{library/timeit python-interface}@anchor{41be}
@subsubsection Interfaz de Python


El módulo define tres funciones de conveniencia y una clase pública:

@geindex timeit() (en el módulo timeit)
@anchor{library/timeit timeit timeit}@anchor{f01}
@deffn {Función} timeit.timeit (stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)

Cree una instancia de @ref{1504,,Timer} con la instrucción dada, el código `setup' y la función `timer' y ejecute su método @ref{d74,,timeit()} con las ejecuciones `number'. El argumento `globals' opcional especifica un espacio de nombres en el que se ejecutará el código.


Distinto en la versión 3.5: El parámetro opcional `globals' fue añadido.

@end deffn

@geindex repeat() (en el módulo timeit)
@anchor{library/timeit timeit repeat}@anchor{41c2}
@deffn {Función} timeit.repeat (stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)

Crea una instancia de @ref{1504,,Timer} con la instrucción dada, el código `setup' y la función `timer' y ejecuta su método @ref{41c3,,repeat()} con las ejecuciones `repeat' y `number' dadas.  El argumento `globals' opcional especifica un espacio de nombres en el que se ejecutará el código.


Distinto en la versión 3.5: El parámetro opcional `globals' fue añadido.



Distinto en la versión 3.7: El valor por defecto para `repeat' cambió de 3 a 5.

@end deffn

@geindex default_timer() (en el módulo timeit)
@anchor{library/timeit timeit default_timer}@anchor{41c4}
@deffn {Función} timeit.default_timer ()

El temporizador por defecto, que es siempre time.perf_counter(), retorna segundos como un número de punto flotante. Como alternativa, time.perf_counter_ns retorna un número entero de nanosegundos.


Distinto en la versión 3.3: @ref{b14,,time.perf_counter()} es ahora el temporizador por defecto.

@end deffn

@geindex Timer (clase en timeit)
@anchor{library/timeit timeit Timer}@anchor{1504}
@deffn {Clase} timeit.Timer (stmt='pass', setup='pass', timer=<timer function>, globals=None)

Clase para la velocidad de tiempo de ejecución de pequeños fragmentos de código.

El constructor toma una instrucción que se cronometra, una instrucción adicional utilizada para la instalación, y una función de temporizador.  Ambas instrucciones tienen como valor predeterminado @code{'pass'}; la función del temporizador depende de la plataforma (consulte la cadena `doc' del módulo). `stmt' y `setup' también pueden contener varias instrucciones separadas por @code{;} o líneas nuevas, siempre y cuando no contengan literales de cadena de varias líneas.  La instrucción se ejecutará de forma predeterminada dentro del espacio de nombres timeit; este comportamiento se puede controlar pasando un espacio de nombres a `globals'.

Para medir el tiempo de ejecución de la primera instrucción, utilice el método @ref{d74,,timeit()}.  Los métodos @ref{41c3,,repeat()} y @ref{d73,,autorange()} son métodos de conveniencia para llamar al método @ref{d74,,timeit()} varias veces.

El tiempo de ejecución de `setup' se excluye de la ejecución de tiempo total.

Los parámetros `stmt' y `setup' también pueden tomar objetos a los que se puede llamar sin argumentos.  Esto embebe llamadas a ellos en una función de temporizador que luego será ejecutada por @ref{d74,,timeit()}.  Tenga en cuenta que la sobrecarga de tiempo es un poco mayor en este caso debido a las llamadas de función adicionales.


Distinto en la versión 3.5: El parámetro opcional `globals' fue añadido.


@geindex timeit() (método de timeit.Timer)
@anchor{library/timeit timeit Timer timeit}@anchor{d74}
@deffn {Método} timeit (number=1000000)

Registra la duración de `number' ejecuciones de la sentencia principal.  Esto ejecuta la sentencia `setup' una vez y, a continuación, retorna el tiempo que se tarda en ejecutar la sentencia principal varias veces. El temporizador por defecto retorna segundos como un número de punto flotante. El argumento es el número de veces que se ejecuta el bucle, tomando por defecto un millón.  La sentencia principal, la instrucción `setup' y la función `timer' que se va a utilizar se pasan al constructor.

@cartouche
@quotation Nota 
De forma predeterminada, @ref{d74,,timeit()} desactiva temporalmente @ref{1922,,garbage collection} durante la medición.  La ventaja de este enfoque es que hace que los tiempos independientes sean más comparables.  La desventaja es que GC puede ser un componente importante del rendimiento de la función que se está midiendo.  Si es así, GC se puede volver a habilitar como la primera instrucción en la cadena `setup'.  Por ejemplo:

@example
timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()
@end example
@end quotation
@end cartouche
@end deffn

@geindex autorange() (método de timeit.Timer)
@anchor{library/timeit timeit Timer autorange}@anchor{d73}
@deffn {Método} autorange (callback=None)

Determina automáticamente cuántas veces llamar a @ref{d74,,timeit()}.

This is a convenience function that calls @ref{d74,,timeit()} repeatedly
so that the total time >= 0.2 second, returning the eventual
(number of loops, time taken for that number of loops). It calls
@ref{d74,,timeit()} with increasing numbers from the sequence 1, 2, 5,
10, 20, 50, … until the time taken is at least 0.2 seconds.

Si `callback' se da y no es @code{None}, se llamará después de cada prueba con dos argumentos: @code{callback(number, time_taken)}.


Added in version 3.6.

@end deffn

@geindex repeat() (método de timeit.Timer)
@anchor{library/timeit timeit Timer repeat}@anchor{41c3}
@deffn {Método} repeat (repeat=5, number=1000000)

Llama a @ref{d74,,timeit()} algunas veces.

Esta es una función de conveniencia que llama a @ref{d74,,timeit()} repetidamente, retornando una lista de resultados.  El primer argumento especifica cuántas veces se debe llamar a @ref{d74,,timeit()}.  El segundo argumento especifica el argumento `number' para @ref{d74,,timeit()}.

@cartouche
@quotation Nota 
Es tentador calcular la media y la desviación estándar del vector de resultados e informar de estos.  Sin embargo, esto no es muy útil. En un caso típico, el valor más bajo proporciona un límite inferior para la rapidez con la que el equipo puede ejecutar el fragmento de código especificado; valores más altos en el vector de resultado normalmente no son causados por la variabilidad en la velocidad de Python, sino por otros procesos que interfieren con su precisión de sincronización. Así que el @ref{f8b,,min()} del resultado es probablemente el único número que debería estar interesado en.  Después de eso, usted debe mirar todo el vector y aplicar el sentido común en lugar de las estadísticas.
@end quotation
@end cartouche


Distinto en la versión 3.7: El valor por defecto para `repeat' cambió de 3 a 5.

@end deffn

@geindex print_exc() (método de timeit.Timer)
@anchor{library/timeit timeit Timer print_exc}@anchor{41c5}
@deffn {Método} print_exc (file=None)

Ayudante para imprimir un seguimiento desde el código cronometrado.

Uso típico:

@example
t = Timer(...)       # outside the try/except
try:
    t.timeit(...)    # or t.repeat(...)
except Exception:
    t.print_exc()
@end example

La ventaja sobre el seguimiento estándar es que se mostrarán las líneas de origen de la plantilla compilada.  El argumento opcional `file' dirige dónde se envía el seguimiento; por defecto a @ref{9cc,,sys.stderr}.
@end deffn
@end deffn

@node Interfaz de línea de comandos<4>,Ejemplos<28>,Interfaz de Python,timeit — Measure execution time of small code snippets
@anchor{library/timeit command-line-interface}@anchor{41c6}@anchor{library/timeit timeit-command-line-interface}@anchor{41bd}
@subsubsection Interfaz de línea de comandos


Cuando se llama como un programa desde la línea de comandos, se utiliza el siguiente formulario:

@example
python -m timeit [-n N] [-r N] [-u U] [-s S] [-p] [-v] [-h] [statement ...]
@end example

Cuando las siguientes opciones son entendidas:

@geindex opción de línea de comando timeit; -n
@geindex opción de línea de comando timeit; --number
@anchor{library/timeit cmdoption-timeit-n}@anchor{41c7}@anchor{library/timeit cmdoption-timeit-number}@anchor{41c8}
@deffn {Option} @w{-}n N, @w{-}@w{-}number=N

cuantas veces para ejecutar “`statement'”
@end deffn

@geindex opción de línea de comando timeit; -r
@geindex opción de línea de comando timeit; --repeat
@anchor{library/timeit cmdoption-timeit-r}@anchor{41c9}@anchor{library/timeit cmdoption-timeit-repeat}@anchor{41ca}
@deffn {Option} @w{-}r N, @w{-}@w{-}repeat=N

cuantas veces se va a repetir el temporizador (predeterminado 5)
@end deffn

@geindex opción de línea de comando timeit; -s
@geindex opción de línea de comando timeit; --setup
@anchor{library/timeit cmdoption-timeit-s}@anchor{41cb}@anchor{library/timeit cmdoption-timeit-setup}@anchor{41cc}
@deffn {Option} @w{-}s S, @w{-}@w{-}setup=S

instrucción a ser ejecutada una vez inicialmente (por defecto @code{pass})
@end deffn

@geindex opción de línea de comando timeit; -p
@geindex opción de línea de comando timeit; --process
@anchor{library/timeit cmdoption-timeit-p}@anchor{41cd}@anchor{library/timeit cmdoption-timeit-process}@anchor{41ce}
@deffn {Option} @w{-}p, @w{-}@w{-}process

mide el tiempo de proceso, no el tiempo total de ejecución, utilizando @ref{b15,,time.process_time()} en lugar de @ref{b14,,time.perf_counter()}, que es el valor predeterminado


Added in version 3.3.

@end deffn

@geindex opción de línea de comando timeit; -u
@geindex opción de línea de comando timeit; --unit
@anchor{library/timeit cmdoption-timeit-u}@anchor{41cf}@anchor{library/timeit cmdoption-timeit-unit}@anchor{41d0}
@deffn {Option} @w{-}u, @w{-}@w{-}unit=U

especifica una unidad de tiempo para la salida del temporizador; puede seleccionar @code{nsec}, @code{usec}, @code{msec} o @code{sec}


Added in version 3.5.

@end deffn

@geindex opción de línea de comando timeit; -v
@geindex opción de línea de comando timeit; --verbose
@anchor{library/timeit cmdoption-timeit-v}@anchor{41d1}@anchor{library/timeit cmdoption-timeit-verbose}@anchor{41d2}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

imprime los resultados de tiempo en bruto; repetir para más dígitos de precisión
@end deffn

@geindex opción de línea de comando timeit; -h
@geindex opción de línea de comando timeit; --help
@anchor{library/timeit cmdoption-timeit-h}@anchor{41d3}@anchor{library/timeit cmdoption-timeit-help}@anchor{41d4}
@deffn {Option} @w{-}h, @w{-}@w{-}help

imprime un mensaje de uso corto y sale
@end deffn

Se puede dar una instrucción de varias líneas especificando cada línea como un argumento de instrucción independiente; Las líneas con sangría son posibles entrecomillando un argumento y utilizando espacios iniciales.  Múltiples opciones @ref{41cb,,-s} se tratan de forma similar.

Si no se da @ref{41c7,,-n}, se calcula un número adecuado de bucles intentando aumentar los números de la secuencia 1, 2, 5, 10, 20, 50, … hasta que el tiempo total sea de al menos 0.2 segundos.

Las mediciones de @ref{41c4,,default_timer()} pueden verse afectadas por otros programas que se ejecutan en la misma máquina, por lo que lo mejor que se puede hacer cuando es necesario una medición de tiempo precisa es repetir la medición un par de veces y utilizar el mejor tiempo.  La opción @ref{41c9,,-r} es buena para esto; el valor predeterminado de 5 repeticiones es probablemente suficiente en la mayoría de los casos.  Puede usar @ref{b15,,time.process_time()} para medir el tiempo de CPU.

@cartouche
@quotation Nota 
Hay una cierta sobrecarga de línea base asociada con la ejecución de una instrucción pass. El código aquí no intenta ocultarlo, pero debe ser consciente de ello.  La sobrecarga de línea base se puede medir invocando el programa sin argumentos y puede diferir entre versiones de Python.
@end quotation
@end cartouche

@node Ejemplos<28>,,Interfaz de línea de comandos<4>,timeit — Measure execution time of small code snippets
@anchor{library/timeit examples}@anchor{41d5}@anchor{library/timeit timeit-examples}@anchor{41c0}
@subsubsection Ejemplos


Es posible proporcionar una instrucción `setup' que se ejecuta solo una vez al inicio:

@example
$ python -m timeit -s "text = 'sample string'; char = 'g'" "char in text"
5000000 loops, best of 5: 0.0877 usec per loop
$ python -m timeit -s "text = 'sample string'; char = 'g'" "text.find(char)"
1000000 loops, best of 5: 0.342 usec per loop
@end example

En la salida, hay tres campos. El conteo del bucle, que indica cuántas veces se ejecutó el cuerpo de la declaración por tiempo de repetición del bucle. El conteo de repeticiones («el mejor de 5») el cual indica cuántas veces se repitió el ciclo de tiempo y, finalmente, el tiempo promedio que tomó el cuerpo de la declaración dentro de la mejor repetición del ciclo de tiempo. Es decir, el tiempo que tomó la repetición más rápida dividido por el número de bucles.

@example
>>> import timeit
>>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"')
0.41440500499993504
>>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"')
1.7246671520006203
@end example

Se puede hacer lo mismo usando la clase @ref{1504,,Timer} y sus métodos:

@example
>>> import timeit
>>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"')
>>> t.timeit()
0.3955516149999312
>>> t.repeat()
[0.40183617287970225, 0.37027556854118704, 0.38344867356679524, 0.3712595970846668, 0.37866875250654886]
@end example

En los ejemplos siguientes se muestra cómo cronometrar expresiones que contienen varias líneas. Aquí comparamos el coste de usar @ref{579,,hasattr()} frente a @ref{789,,try}/@ref{2f6,,except} para probar los atributos de objeto faltantes y presentes:

@example
$ python -m timeit "try:" "  str.__bool__" "except AttributeError:" "  pass"
20000 loops, best of 5: 15.7 usec per loop
$ python -m timeit "if hasattr(str, '__bool__'): pass"
50000 loops, best of 5: 4.26 usec per loop

$ python -m timeit "try:" "  int.__bool__" "except AttributeError:" "  pass"
200000 loops, best of 5: 1.43 usec per loop
$ python -m timeit "if hasattr(int, '__bool__'): pass"
100000 loops, best of 5: 2.23 usec per loop
@end example

@example
>>> import timeit
>>> # attribute is missing
>>> s = """\
... try:
...     str.__bool__
... except AttributeError:
...     pass
... """
>>> timeit.timeit(stmt=s, number=100000)
0.9138244460009446
>>> s = "if hasattr(str, '__bool__'): pass"
>>> timeit.timeit(stmt=s, number=100000)
0.5829014980008651
>>>
>>> # attribute is present
>>> s = """\
... try:
...     int.__bool__
... except AttributeError:
...     pass
... """
>>> timeit.timeit(stmt=s, number=100000)
0.04215312199994514
>>> s = "if hasattr(int, '__bool__'): pass"
>>> timeit.timeit(stmt=s, number=100000)
0.08588060699912603
@end example

Para dar al módulo @ref{ef,,timeit} acceso a las funciones que defina, puede pasar un parámetro `setup' que contenga una instrucción import:

@example
def test():
    """Stupid test function"""
    L = [i for i in range(100)]

if __name__ == '__main__':
    import timeit
    print(timeit.timeit("test()", setup="from __main__ import test"))
@end example

Otra opción es pasar @ref{186f,,globals()} al parámetro `globals', lo que hará que el código se ejecute dentro del espacio de nombres global actual.  Esto puede ser más conveniente que especificar individualmente las importaciones:

@example
def f(x):
    return x**2
def g(x):
    return x**4
def h(x):
    return x**8

import timeit
print(timeit.timeit('[func(42) for func in (f,g,h)]', globals=globals()))
@end example

@node trace — Trace or track Python statement execution,tracemalloc — Trace memory allocations,timeit — Measure execution time of small code snippets,Depuración y perfilado
@anchor{library/trace doc}@anchor{41d6}@anchor{library/trace module-trace}@anchor{fd}@anchor{library/trace trace-trace-or-track-python-statement-execution}@anchor{41d7}
@subsection @code{trace} — Trace or track Python statement execution


@geindex module; trace

`Código fuente:' Lib/trace.py@footnote{https://github.com/python/cpython/tree/main/Lib/trace.py}


__________________________________________________________________


El módulo @ref{fd,,trace} le permite rastrear la ejecución del programa, generar listas de cobertura de declaraciones anotadas, imprimir relaciones entre llamador/destinatario y listar funciones ejecutadas durante la ejecución de un programa. Se puede utilizar en otro programa o desde la línea de comandos.


@subsubheading Ver también



@table @asis

@item Coverage.py@footnote{https://coverage.readthedocs.io/}

Una herramienta popular de terceros de cobertura que proporciona salida HTML junto con funciones avanzadas como cobertura de sucursales.
@end table


@menu
* Uso de la línea de comandos: Uso de la línea de comandos<3>. 
* Interfaz programática:: 

@end menu

@node Uso de la línea de comandos<3>,Interfaz programática,,trace — Trace or track Python statement execution
@anchor{library/trace command-line-usage}@anchor{41d8}@anchor{library/trace trace-cli}@anchor{41d9}
@subsubsection Uso de la línea de comandos


El módulo @ref{fd,,trace} se puede invocar desde la línea de comandos. Puede ser tan simple como

@example
python -m trace --count -C . somefile.py ...
@end example

Lo anterior ejecutará @code{somefile.py} y generará listados anotados de todos los módulos de Python importados durante la ejecución en el directorio actual.

@geindex opción de línea de comando trace; --help
@anchor{library/trace cmdoption-trace-help}@anchor{41da}
@deffn {Option} @w{-}@w{-}help

Muestra uso y sale.
@end deffn

@geindex opción de línea de comando trace; --version
@anchor{library/trace cmdoption-trace-version}@anchor{41db}
@deffn {Option} @w{-}@w{-}version

Muestra la versión del módulo y sale.
@end deffn


Added in version 3.8: Se agregó la opción @code{--module} que permite ejecutar un módulo ejecutable.


@menu
* Opciones principales:: 
* Modificadores:: 
* Filtros:: 

@end menu

@node Opciones principales,Modificadores,,Uso de la línea de comandos<3>
@anchor{library/trace main-options}@anchor{41dc}
@subsubsection Opciones principales


Se debe especificar al menos una de las siguientes opciones al invocar @ref{fd,,trace}. La opción @ref{41dd,,--listfuncs} es mutuamente excluyente con las opciones @ref{41de,,--trace} y @ref{41df,,--count}. Cuando se proporciona @ref{41dd,,--listfuncs}, no se aceptan @ref{41df,,--count} ni @ref{41de,,--trace}, y viceversa.

@geindex opción de línea de comando trace; -c
@geindex opción de línea de comando trace; --count
@anchor{library/trace cmdoption-trace-c}@anchor{41df}@anchor{library/trace cmdoption-trace-count}@anchor{41e0}
@deffn {Option} @w{-}c, @w{-}@w{-}count

Genera un conjunto de archivos de lista anotados al finalizar el programa que muestra cuántas veces se ejecutó cada instrucción. Vea también @ref{41e1,,--coverdir}, @ref{41e2,,--file} y @ref{41e3,,--no-report} a continuación.
@end deffn

@geindex opción de línea de comando trace; -t
@geindex opción de línea de comando trace; --trace
@anchor{library/trace cmdoption-trace-t}@anchor{41de}@anchor{library/trace cmdoption-trace-trace}@anchor{41e4}
@deffn {Option} @w{-}t, @w{-}@w{-}trace

Muestra las líneas a medida que se ejecutan.
@end deffn

@geindex opción de línea de comando trace; -l
@geindex opción de línea de comando trace; --listfuncs
@anchor{library/trace cmdoption-trace-l}@anchor{41dd}@anchor{library/trace cmdoption-trace-listfuncs}@anchor{41e5}
@deffn {Option} @w{-}l, @w{-}@w{-}listfuncs

Muestra las funciones ejecutadas al ejecutar el programa.
@end deffn

@geindex opción de línea de comando trace; -r
@geindex opción de línea de comando trace; --report
@anchor{library/trace cmdoption-trace-r}@anchor{41e6}@anchor{library/trace cmdoption-trace-report}@anchor{41e7}
@deffn {Option} @w{-}r, @w{-}@w{-}report

Genera una lista anotada de una ejecución del programa anterior que utilizó la opción @ref{41df,,--count} y @ref{41e2,,--file}. Esto no ejecuta ningún código.
@end deffn

@geindex opción de línea de comando trace; -T
@geindex opción de línea de comando trace; --trackcalls
@anchor{library/trace cmdoption-trace-T}@anchor{41e8}@anchor{library/trace cmdoption-trace-trackcalls}@anchor{41e9}
@deffn {Option} @w{-}T, @w{-}@w{-}trackcalls

Muestra las relaciones de llamada expuestas al ejecutar el programa.
@end deffn

@node Modificadores,Filtros,Opciones principales,Uso de la línea de comandos<3>
@anchor{library/trace modifiers}@anchor{41ea}
@subsubsection Modificadores


@geindex opción de línea de comando trace; -f
@geindex opción de línea de comando trace; --file
@anchor{library/trace cmdoption-trace-f}@anchor{41e2}@anchor{library/trace cmdoption-trace-file}@anchor{41eb}
@deffn {Option} @w{-}f, @w{-}@w{-}file=<file>

Nombre de un archivo para acumular recuentos durante varias ejecuciones de seguimiento. Debe usarse con la opción @ref{41df,,--count}.
@end deffn

@geindex opción de línea de comando trace; -C
@geindex opción de línea de comando trace; --coverdir
@anchor{library/trace cmdoption-trace-C}@anchor{41e1}@anchor{library/trace cmdoption-trace-coverdir}@anchor{41ec}
@deffn {Option} @w{-}C, @w{-}@w{-}coverdir=<dir>

Directorio donde van los archivos del informe. El informe de cobertura para @code{paquete.modulo} se escribe en el archivo @code{`directorio'/`paquete'/`modulo'.cobertura}.
@end deffn

@geindex opción de línea de comando trace; -m
@geindex opción de línea de comando trace; --missing
@anchor{library/trace cmdoption-trace-m}@anchor{41ed}@anchor{library/trace cmdoption-trace-missing}@anchor{41ee}
@deffn {Option} @w{-}m, @w{-}@w{-}missing

Al generar listados anotados, marque las líneas que no se ejecutaron con @code{>>>>>>}.
@end deffn

@geindex opción de línea de comando trace; -s
@geindex opción de línea de comando trace; --summary
@anchor{library/trace cmdoption-trace-s}@anchor{41ef}@anchor{library/trace cmdoption-trace-summary}@anchor{41f0}
@deffn {Option} @w{-}s, @w{-}@w{-}summary

Cuando use @ref{41df,,--count} o @ref{41e6,,--report}, escriba un breve resumen en stdout para cada archivo procesado.
@end deffn

@geindex opción de línea de comando trace; -R
@geindex opción de línea de comando trace; --no-report
@anchor{library/trace cmdoption-trace-R}@anchor{41e3}@anchor{library/trace cmdoption-trace-no-report}@anchor{41f1}
@deffn {Option} @w{-}R, @w{-}@w{-}no@w{-}report

No genera listados anotados. Esto es útil si tiene la intención de realizar varias ejecuciones con @ref{41df,,--count}, y luego producir un solo conjunto de listados anotados al final.
@end deffn

@geindex opción de línea de comando trace; -g
@geindex opción de línea de comando trace; --timing
@anchor{library/trace cmdoption-trace-g}@anchor{41f2}@anchor{library/trace cmdoption-trace-timing}@anchor{41f3}
@deffn {Option} @w{-}g, @w{-}@w{-}timing

Prefija cada línea con la hora desde que se inició el programa. Solo se usa durante el rastreo.
@end deffn

@node Filtros,,Modificadores,Uso de la línea de comandos<3>
@anchor{library/trace filters}@anchor{41f4}
@subsubsection Filtros


Estas opciones pueden repetirse varias veces.

@geindex opción de línea de comando trace; --ignore-module
@anchor{library/trace cmdoption-trace-ignore-module}@anchor{41f5}
@deffn {Option} @w{-}@w{-}ignore@w{-}module=<mod>

Ignora cada uno de los nombres de módulo dados y sus submódulos (si es un paquete). El argumento puede ser una lista de nombres separados por una coma.
@end deffn

@geindex opción de línea de comando trace; --ignore-dir
@anchor{library/trace cmdoption-trace-ignore-dir}@anchor{41f6}
@deffn {Option} @w{-}@w{-}ignore@w{-}dir=<dir>

Ignora todos los módulos y paquetes en el directorio y subdirectorios nombrados. El argumento puede ser una lista de directorios separados por @ref{1d4a,,os.pathsep}.
@end deffn

@node Interfaz programática,,Uso de la línea de comandos<3>,trace — Trace or track Python statement execution
@anchor{library/trace programmatic-interface}@anchor{41f7}@anchor{library/trace trace-api}@anchor{41f8}
@subsubsection Interfaz programática


@geindex Trace (clase en trace)
@anchor{library/trace trace Trace}@anchor{41f9}
@deffn {Clase} trace.Trace (count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)

Crea un objeto para rastrear la ejecución de una sola declaración o expresión. Todos los parámetros son opcionales. `count' habilita el conteo de números de línea. `trace' habilita el seguimiento de ejecución de línea. `countfuncs' habilita la lista de las funciones llamadas durante la ejecución. `countcallers' habilita el seguimiento de la relación de llamadas. `ignoremods' es una lista de módulos o paquetes para ignorar. `ignoredirs' es una lista de directorios cuyos módulos o paquetes deben ignorarse. `infile' es el nombre del archivo desde el cual leer la información de conteo almacenada. `outfile' es el nombre del archivo en el que se escribe la información de conteo actualizada. `timing' permite mostrar una marca de tiempo relativa al momento en que se inició el seguimiento.

@geindex run() (método de trace.Trace)
@anchor{library/trace trace Trace run}@anchor{41fa}
@deffn {Método} run (cmd)

Ejecuta el comando y recopile estadísticas de la ejecución con los parámetros de seguimiento actuales. `cmd' debe ser una cadena o un objeto de código, adecuado para pasar a @ref{2ea,,exec()}.
@end deffn

@geindex runctx() (método de trace.Trace)
@anchor{library/trace trace Trace runctx}@anchor{41fb}
@deffn {Método} runctx (cmd, globals=None, locals=None)

Ejecuta el comando y recopile estadísticas de la ejecución con los parámetros de seguimiento actuales, en los entornos globales y locales definidos. Si no está definido, `globals' y `locals' por defecto son diccionarios vacíos.
@end deffn

@geindex runfunc() (método de trace.Trace)
@anchor{library/trace trace Trace runfunc}@anchor{b0c}
@deffn {Método} runfunc (func, /, *args, **kwds)

Llama a `func' con los argumentos dados bajo el control del objeto @ref{41f9,,Trace} con los parámetros de rastreo actuales.
@end deffn

@geindex results() (método de trace.Trace)
@anchor{library/trace trace Trace results}@anchor{41fc}
@deffn {Método} results ()

Retorna un objeto @ref{41fd,,CoverageResults} que contiene los resultados acumulativos de todas las llamadas anteriores a @code{run}, @code{runctx} y @code{runfunc} para la instancia dada @ref{41f9,,Trace}. No restablece los resultados de seguimiento acumulados.
@end deffn
@end deffn

@geindex CoverageResults (clase en trace)
@anchor{library/trace trace CoverageResults}@anchor{41fd}
@deffn {Clase} trace.CoverageResults

Un contenedor para los resultados de la cobertura, creado por @ref{41fc,,Trace.results()}. No debe ser creado directamente por el usuario.

@geindex update() (método de trace.CoverageResults)
@anchor{library/trace trace CoverageResults update}@anchor{41fe}
@deffn {Método} update (other)

Fusiona datos de otro objeto @ref{41fd,,CoverageResults}.
@end deffn

@geindex write_results() (método de trace.CoverageResults)
@anchor{library/trace trace CoverageResults write_results}@anchor{41ff}
@deffn {Método} write_results (show_missing=True, summary=False, coverdir=None, *, ignore_missing_files=False)

Escribe los resultados de la cobertura. Configure `show_missing' para mostrar las líneas que no tuvieron coincidencias. Configurar `summary' para incluir en la salida el resumen de cobertura por módulo. `coverdir' especifica el directorio en el que se enviarán los archivos de resultado de cobertura. Si es @code{None}, los resultados de cada archivo fuente se colocan en su directorio.

If `ignore_missing_files' is @code{True}, coverage counts for files that no
longer exist are silently ignored. Otherwise, a missing file will
raise a @ref{f46,,FileNotFoundError}.


Distinto en la versión 3.13: Added `ignore_missing_files' parameter.

@end deffn
@end deffn

Un ejemplo simple que demuestra el uso de la interfaz programática:

@example
import sys
import trace

# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# run the new command using the given tracer
tracer.run('main()')

# make a report, placing output in the current directory
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")
@end example

@node tracemalloc — Trace memory allocations,,trace — Trace or track Python statement execution,Depuración y perfilado
@anchor{library/tracemalloc doc}@anchor{4200}@anchor{library/tracemalloc module-tracemalloc}@anchor{ff}@anchor{library/tracemalloc tracemalloc-trace-memory-allocations}@anchor{4201}
@subsection @code{tracemalloc} — Trace memory allocations


@geindex module; tracemalloc


Added in version 3.4.


`Código fuente:' Lib/tracemalloc.py@footnote{https://github.com/python/cpython/tree/main/Lib/tracemalloc.py}


__________________________________________________________________


El módulo tracemalloc es una herramienta de depuración para rastrear los espacios de memoria asignados por Python. Este proporciona la siguiente información:


@itemize *

@item 
El rastreo al lugar de origen del objeto asignado

@item 
Las estadísticas en los espacios de memoria asignados por nombre de archivo y por número de línea: tamaño total, número y tamaño promedio de los espacios de memoria asignados

@item 
Calcula las diferencias entre dos informes instantáneos para detectar alguna filtración en la memoria
@end itemize

Para rastrear la mayoría de los espacios de memoria asignados por Python; el módulo debe empezar tan pronto como sea posible configurando la variable del entorno 
@geindex PYTHONTRACEMALLOC
@geindex variables de entorno; PYTHONTRACEMALLOC
@ref{1d42,,PYTHONTRACEMALLOC} a @code{1}, o usando la opción del comando de línea @ref{2e2,,-X} @code{tracemalloc}. La función @ref{1d41,,tracemalloc.start()} puede ser llamada en tiempo de ejecución para empezar a rastrear las asignaciones de memoria de Python.

Por defecto, el rastreo de un espacio de memoria asignado solo guarda el cuadro mas reciente (1 cuadro). Para guardar 25 cuadros desde el 
@geindex PYTHONTRACEMALLOC`comienzo@comma{} configura la variable del entorno a `@w{`}25`
@geindex variables de entorno; PYTHONTRACEMALLOC`comienzo@comma{} configura la variable del entorno a `@w{`}25`
@code{PYTHONTRACEMALLOC`comienzo, configura la variable del entorno a `@w{`}25`}, o usa @ref{2e2,,-X} @code{tracemalloc=25} en la opción de línea de comando.

@menu
* Ejemplos: Ejemplos<29>. 
* API:: 

@end menu

@node Ejemplos<29>,API,,tracemalloc — Trace memory allocations
@anchor{library/tracemalloc examples}@anchor{4202}
@subsubsection Ejemplos


@menu
* Mostrar los 10 principales:: 
* Calcula las diferencias:: 
* Consigue el seguimiento del bloque de memoria:: 
* Los 10 más bonitos:: 

@end menu

@node Mostrar los 10 principales,Calcula las diferencias,,Ejemplos<29>
@anchor{library/tracemalloc display-the-top-10}@anchor{4203}
@subsubsection Mostrar los 10 principales


Mostrar los 10 archivos asignando la mayor cantidad de memoria:

@example
import tracemalloc

tracemalloc.start()

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('lineno')

print("[ Top 10 ]")
for stat in top_stats[:10]:
    print(stat)
@end example

Ejemplo de la salida del conjunto de pruebas de Python:

@example
[ Top 10 ]
<frozen importlib._bootstrap>:716: size=4855 KiB, count=39328, average=126 B
<frozen importlib._bootstrap>:284: size=521 KiB, count=3199, average=167 B
/usr/lib/python3.4/collections/__init__.py:368: size=244 KiB, count=2315, average=108 B
/usr/lib/python3.4/unittest/case.py:381: size=185 KiB, count=779, average=243 B
/usr/lib/python3.4/unittest/case.py:402: size=154 KiB, count=378, average=416 B
/usr/lib/python3.4/abc.py:133: size=88.7 KiB, count=347, average=262 B
<frozen importlib._bootstrap>:1446: size=70.4 KiB, count=911, average=79 B
<frozen importlib._bootstrap>:1454: size=52.0 KiB, count=25, average=2131 B
<string>:5: size=49.7 KiB, count=148, average=344 B
/usr/lib/python3.4/sysconfig.py:411: size=48.0 KiB, count=1, average=48.0 KiB
@end example

Se puede ver que Python ha cargado @code{4855 KiB} de data (código de bytes y constantes) desde los módulos y que el modulo @ref{1e,,collections} asigno @code{24KiB} para crear tipos @ref{32d,,namedtuple}.

Mira @ref{4204,,Snapshot.statistics()} para más opciones.

@node Calcula las diferencias,Consigue el seguimiento del bloque de memoria,Mostrar los 10 principales,Ejemplos<29>
@anchor{library/tracemalloc compute-differences}@anchor{4205}
@subsubsection Calcula las diferencias


Toma dos capturas instantáneas y muestra las diferencias:

@example
import tracemalloc
tracemalloc.start()
# ... start your application ...

snapshot1 = tracemalloc.take_snapshot()
# ... call the function leaking memory ...
snapshot2 = tracemalloc.take_snapshot()

top_stats = snapshot2.compare_to(snapshot1, 'lineno')

print("[ Top 10 differences ]")
for stat in top_stats[:10]:
    print(stat)
@end example

Ejemplo de la salida antes y después de probar el conjunto de pruebas de Python:

@example
[ Top 10 differences ]
<frozen importlib._bootstrap>:716: size=8173 KiB (+4428 KiB), count=71332 (+39369), average=117 B
/usr/lib/python3.4/linecache.py:127: size=940 KiB (+940 KiB), count=8106 (+8106), average=119 B
/usr/lib/python3.4/unittest/case.py:571: size=298 KiB (+298 KiB), count=589 (+589), average=519 B
<frozen importlib._bootstrap>:284: size=1005 KiB (+166 KiB), count=7423 (+1526), average=139 B
/usr/lib/python3.4/mimetypes.py:217: size=112 KiB (+112 KiB), count=1334 (+1334), average=86 B
/usr/lib/python3.4/http/server.py:848: size=96.0 KiB (+96.0 KiB), count=1 (+1), average=96.0 KiB
/usr/lib/python3.4/inspect.py:1465: size=83.5 KiB (+83.5 KiB), count=109 (+109), average=784 B
/usr/lib/python3.4/unittest/mock.py:491: size=77.7 KiB (+77.7 KiB), count=143 (+143), average=557 B
/usr/lib/python3.4/urllib/parse.py:476: size=71.8 KiB (+71.8 KiB), count=969 (+969), average=76 B
/usr/lib/python3.4/contextlib.py:38: size=67.2 KiB (+67.2 KiB), count=126 (+126), average=546 B
@end example

Se puede ver que Python cargó @code{8173 KiB} de información del modulo (código de bytes y constantes), y que eso es @code{4428KiB} más de lo que ha sido cargado antes de los test, cuando la anterior captura de pantalla fue tomada. De manera similar, el modulo @ref{85,,linecache} ha almacenado en caché @code{940 KiB} del código fuente de Python para formatear los seguimientos, todo desde la captura instantánea.

Si el sistema tiene poca memoria libre, los informes instantáneos pueden ser escritos en el disco usando el método @ref{4206,,Snapshot.dump()} para analizar el informe instantáneo offline. Después usa el método @ref{4207,,Snapshot.load()} para actualizar el informe.

@node Consigue el seguimiento del bloque de memoria,Los 10 más bonitos,Calcula las diferencias,Ejemplos<29>
@anchor{library/tracemalloc get-the-traceback-of-a-memory-block}@anchor{4208}
@subsubsection Consigue el seguimiento del bloque de memoria


Código para configurar el seguimiento del bloque de memoria más grande:

@example
import tracemalloc

# Store 25 frames
tracemalloc.start(25)

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('traceback')

# pick the biggest memory block
stat = top_stats[0]
print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024))
for line in stat.traceback.format():
    print(line)
@end example

Ejemplo de la salida del conjunto de pruebas de Python (rastreo limitado a 25 cuadros):

@example
903 memory blocks: 870.1 KiB
  File "<frozen importlib._bootstrap>", line 716
  File "<frozen importlib._bootstrap>", line 1036
  File "<frozen importlib._bootstrap>", line 934
  File "<frozen importlib._bootstrap>", line 1068
  File "<frozen importlib._bootstrap>", line 619
  File "<frozen importlib._bootstrap>", line 1581
  File "<frozen importlib._bootstrap>", line 1614
  File "/usr/lib/python3.4/doctest.py", line 101
    import pdb
  File "<frozen importlib._bootstrap>", line 284
  File "<frozen importlib._bootstrap>", line 938
  File "<frozen importlib._bootstrap>", line 1068
  File "<frozen importlib._bootstrap>", line 619
  File "<frozen importlib._bootstrap>", line 1581
  File "<frozen importlib._bootstrap>", line 1614
  File "/usr/lib/python3.4/test/support/__init__.py", line 1728
    import doctest
  File "/usr/lib/python3.4/test/test_pickletools.py", line 21
    support.run_doctest(pickletools)
  File "/usr/lib/python3.4/test/regrtest.py", line 1276
    test_runner()
  File "/usr/lib/python3.4/test/regrtest.py", line 976
    display_failure=not verbose)
  File "/usr/lib/python3.4/test/regrtest.py", line 761
    match_tests=ns.match_tests)
  File "/usr/lib/python3.4/test/regrtest.py", line 1563
    main()
  File "/usr/lib/python3.4/test/__main__.py", line 3
    regrtest.main_in_temp_cwd()
  File "/usr/lib/python3.4/runpy.py", line 73
    exec(code, run_globals)
  File "/usr/lib/python3.4/runpy.py", line 160
    "__main__", fname, loader, pkg_name)
@end example

Se puede ver que la mayor parte de la memoria fue asignada en el módulo @ref{77,,importlib} para cargar datos (códigos de bytes y constantes) desde módulos @code{870.1 KiB}. El rastreo esta donde el módulo @ref{77,,importlib} cargó datos más recientemente: en la linea @code{import pdb} el módulo @ref{3b,,doctest}. El rastreo puede cambiar si se carga un nuevo módulo.

@node Los 10 más bonitos,,Consigue el seguimiento del bloque de memoria,Ejemplos<29>
@anchor{library/tracemalloc pretty-top}@anchor{4209}
@subsubsection @code{Los 10 más bonitos}


Codifica para configurar las 10 líneas que asignan gran parte de la memoria con una salida @code{bonita}, ignorando los archivos @code{<frozen importlib._bootstrap>} y @code{<unkownn>}:

@example
import linecache
import os
import tracemalloc

def display_top(snapshot, key_type='lineno', limit=10):
    snapshot = snapshot.filter_traces((
        tracemalloc.Filter(False, "<frozen importlib._bootstrap>"),
        tracemalloc.Filter(False, "<unknown>"),
    ))
    top_stats = snapshot.statistics(key_type)

    print("Top %s lines" % limit)
    for index, stat in enumerate(top_stats[:limit], 1):
        frame = stat.traceback[0]
        print("#%s: %s:%s: %.1f KiB"
              % (index, frame.filename, frame.lineno, stat.size / 1024))
        line = linecache.getline(frame.filename, frame.lineno).strip()
        if line:
            print('    %s' % line)

    other = top_stats[limit:]
    if other:
        size = sum(stat.size for stat in other)
        print("%s other: %.1f KiB" % (len(other), size / 1024))
    total = sum(stat.size for stat in top_stats)
    print("Total allocated size: %.1f KiB" % (total / 1024))

tracemalloc.start()

# ... run your application ...

snapshot = tracemalloc.take_snapshot()
display_top(snapshot)
@end example

Ejemplo de la salida del conjunto de pruebas de Python:

@example
Top 10 lines
#1: Lib/base64.py:414: 419.8 KiB
    _b85chars2 = [(a + b) for a in _b85chars for b in _b85chars]
#2: Lib/base64.py:306: 419.8 KiB
    _a85chars2 = [(a + b) for a in _a85chars for b in _a85chars]
#3: collections/__init__.py:368: 293.6 KiB
    exec(class_definition, namespace)
#4: Lib/abc.py:133: 115.2 KiB
    cls = super().__new__(mcls, name, bases, namespace)
#5: unittest/case.py:574: 103.1 KiB
    testMethod()
#6: Lib/linecache.py:127: 95.4 KiB
    lines = fp.readlines()
#7: urllib/parse.py:476: 71.8 KiB
    for a in _hexdig for b in _hexdig@}
#8: <string>:5: 62.0 KiB
#9: Lib/_weakrefset.py:37: 60.0 KiB
    self.data = set()
#10: Lib/base64.py:142: 59.8 KiB
    _b32tab2 = [a + b for a in _b32tab for b in _b32tab]
6220 other: 3602.8 KiB
Total allocated size: 5303.1 KiB
@end example

Mira @ref{4204,,Snapshot.statistics()} para más opciones.

@menu
* Graba los tamaños actual y máximo de todos los bloques de memoria rastreados:: 

@end menu

@node Graba los tamaños actual y máximo de todos los bloques de memoria rastreados,,,Los 10 más bonitos
@anchor{library/tracemalloc record-the-current-and-peak-size-of-all-traced-memory-blocks}@anchor{420a}
@subsubsection Graba los tamaños actual y máximo de todos los bloques de memoria rastreados


El siguiente código calcula dos sumas como @code{0 + 1 + 2 + ...} de forma ineficiente, creando una lista con estos números. Esta lista consume mucha memoria de forma temporal. Podemos usar @ref{420b,,get_traced_memory()} y @ref{9ce,,reset_peak()} para observar el pequeño uso de memoria después de que la suma es calculada, así como también el uso máximo de memoria durante el cálculo:

@example
import tracemalloc

tracemalloc.start()

# Example code: compute a sum with a large temporary list
large_sum = sum(list(range(100000)))

first_size, first_peak = tracemalloc.get_traced_memory()

tracemalloc.reset_peak()

# Example code: compute a sum with a small temporary list
small_sum = sum(list(range(1000)))

second_size, second_peak = tracemalloc.get_traced_memory()

print(f"@{first_size=@}, @{first_peak=@}")
print(f"@{second_size=@}, @{second_peak=@}")
@end example

Salida:

@example
first_size=664, first_peak=3592984
second_size=804, second_peak=29704
@end example

El uso de @ref{9ce,,reset_peak()} asegura que podemos registrar precisamente el uso máximo de memoria durante el cálculo de @code{small_sum}, incluso si es mucho menor al máximo total desde la llamada a @ref{1d41,,start()}. Sin la llamada a @ref{9ce,,reset_peak()}, @code{second_peak} seguiría siendo el uso máximo de memoria del cálculo de @code{large_sum} (es decir, igual a @code{first_peak}). En este caso ambos máximos son mucho mayores al uso final de memoria, lo que sugiere que podemos optimizar (removiendo la llamada innecesaria a @ref{18e,,list}, y escribiendo @code{sum(range(...))}).

@node API,,Ejemplos<29>,tracemalloc — Trace memory allocations
@anchor{library/tracemalloc api}@anchor{420c}
@subsubsection API


@menu
* Funciones: Funciones<9>. 
* Filtro de dominio:: 
* Filtro:: 
* Cuadro:: 
* Captura instantánea:: 
* Estadística:: 
* StatisticDiff:: 
* Rastro:: 
* Seguimiento:: 

@end menu

@node Funciones<9>,Filtro de dominio,,API
@anchor{library/tracemalloc functions}@anchor{420d}
@subsubsection Funciones


@geindex clear_traces() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc clear_traces}@anchor{420e}
@deffn {Función} tracemalloc.clear_traces ()

Limpia los rastros de los bloques de memoria asignados por Python.

Mira también la función @ref{420f,,stop()}.
@end deffn

@geindex get_object_traceback() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_object_traceback}@anchor{1b5f}
@deffn {Función} tracemalloc.get_object_traceback (obj)

Obtiene el rastreo de donde el objeto de Python fue asignado. Retorna una instancia @ref{c1e,,Traceback} o @code{None} si el módulo @ref{ff,,tracemalloc} no esta rastreando ninguna asignación de memoria o no rastreó la asignación del objeto.

Mira también las funciones @ref{89b,,gc.get_referrers()} y @ref{1772,,sys.getsizeof()}.
@end deffn

@geindex get_traceback_limit() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_traceback_limit}@anchor{4210}
@deffn {Función} tracemalloc.get_traceback_limit ()

Obtiene el número máximo de cuadros guardados en el seguimiento de un rastro.

El módulo @ref{ff,,tracemalloc} debe rastrear las asignaciones de memoria para obtener el límite, de otra manera se inicia una excepción.

El limite es establecido por la función @ref{1d41,,start()}.
@end deffn

@geindex get_traced_memory() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_traced_memory}@anchor{420b}
@deffn {Función} tracemalloc.get_traced_memory ()

Obtiene el tamaño actual y tamaño pico de los bloques de memorias rastreados por el módulo @ref{ff,,tracemalloc} como una tupla: @code{(current: int, peak: int)}.
@end deffn

@geindex reset_peak() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc reset_peak}@anchor{9ce}
@deffn {Función} tracemalloc.reset_peak ()

Establece el tamaño máximo de los bloques de memorias rastreados por el módulo @ref{ff,,tracemalloc} al tamaño actual.

No realiza ninguna acción si el módulo @ref{ff,,tracemalloc} no está rastreando asignaciones de memoria.

Esta función sólo modifica el valor guardado para el uso máximo de memoria, y no modifica o borra ningún rastreo, no como @ref{420e,,clear_traces()}. Capturas tomadas con @ref{4211,,take_snapshot()} antes de una llamada a @ref{9ce,,reset_peak()} pueden ser comparadas significativamente con capturas hechas después de la llamada.

Mira también la función @ref{420b,,get_traced_memory()}.


Added in version 3.9.

@end deffn

@geindex get_tracemalloc_memory() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_tracemalloc_memory}@anchor{4212}
@deffn {Función} tracemalloc.get_tracemalloc_memory ()

Obtiene el uso de la memoria en bytes desde el modulo @ref{ff,,tracemalloc} usado para guardar rastreos de bloques de memoria. Retorna una clase @ref{1f0,,int}.
@end deffn

@geindex is_tracing() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc is_tracing}@anchor{4213}
@deffn {Función} tracemalloc.is_tracing ()

Si el módulo @ref{ff,,tracemalloc} esta rastreando asignaciones de memoria de Python retorna @code{True} sino retorna @code{False}.

También mira las funciones @ref{1d41,,start()} y @ref{420f,,stop()}.
@end deffn

@geindex start() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc start}@anchor{1d41}
@deffn {Función} tracemalloc.start (nframe: int = 1)

Empieza a rastrear las asignaciones de memoria de Python: instala `hooks' en las asignaciones de memoria de Python. Los rastreos coleccionados van a estar limitados a `nframe'. Por defecto, un rastro de un bloque de memoria solo guarda el cuadro mas reciente: el limite es @code{1}. `nframe' debe ser mayor o igual a @cite{1}.

El número original de cuadros totales que componen el seguimiento observando el atributo @ref{4214,,Traceback.total_nframe}.

Guardar mas de @code{1} cuadro es solo útil para calcular estadísticas agrupadas por seguimiento o para calcular estadísticas acumulativa: mira las funciones @ref{4215,,Snapshot.compare_to()} y @ref{4204,,Snapshot.statistics()}.

Guardar mas cuadros aumenta la memoria y la sobrecargar de la CPU del modulo @ref{ff,,tracemalloc}. Usa la función @ref{4212,,get_tracemalloc_memory()} para medir cuanta memoria se usa por el módulo @ref{ff,,tracemalloc}.

La variable del entorno 
@geindex PYTHONTRACEMALLOC
@geindex variables de entorno; PYTHONTRACEMALLOC
@ref{1d42,,PYTHONTRACEMALLOC} (@code{PYTHONTRACEMALLOC=NFRAME}) y la opción de comando de linea @ref{2e2,,-X} @code{tracemalloc=NFRAME} se puede usar para empezar a rastrear desde el inicio.

También mira las funciones @ref{420f,,stop()}, @ref{4213,,is_tracing()} y @ref{4210,,get_traceback_limit()}.
@end deffn

@geindex stop() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc stop}@anchor{420f}
@deffn {Función} tracemalloc.stop ()

Detiene el rastreo de las asignaciones de memoria de Python: desinstala los `hooks'. También limpia todos los rastros de memoria recolectados acerca de los bloques de memoria asignados por Python.

Llama a la función @ref{4211,,take_snapshot()} para tomar una captura instantánea de los rastreos, antes de limpiarlos.

También mira las funciones @ref{1d41,,start()}, @ref{4213,,is_tracing()} y @ref{420e,,clear_traces()}.
@end deffn

@geindex take_snapshot() (en el módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc take_snapshot}@anchor{4211}
@deffn {Función} tracemalloc.take_snapshot ()

Toma una captura instantánea de los bloques de memoria asignados por Python. Retorna una nueva instancia de la clase @ref{4216,,Snapshot}.

La captura instantánea no incluye ningún bloque de memoria asignado antes de que el módulo @ref{ff,,tracemalloc} haya empezado a rastrear asignaciones de memoria.

Los seguimientos de los rastros son limitados por la función @ref{4210,,get_traceback_limit()}. Usa el parámetro `nframe' de la función @ref{1d41,,start()} para guardar mas cuadros.

El módulo @ref{ff,,tracemalloc} debe empezar a rastrear las asignaciones de memoria para tomar una captura instantánea. Mira la función @ref{1d41,,start()}.

También mira la función @ref{1b5f,,get_object_traceback()}.
@end deffn

@node Filtro de dominio,Filtro,Funciones<9>,API
@anchor{library/tracemalloc domainfilter}@anchor{4217}
@subsubsection Filtro de dominio


@geindex DomainFilter (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc DomainFilter}@anchor{d78}
@deffn {Clase} tracemalloc.DomainFilter (inclusive: bool, domain: int)

Filtra los rastros de los bloques de memoria por su espacio de dirección (dominio).


Added in version 3.6.


@geindex inclusive (atributo de tracemalloc.DomainFilter)
@anchor{library/tracemalloc tracemalloc DomainFilter inclusive}@anchor{4218}
@deffn {Atributo} inclusive

Si `inclusive' es @code{True} (incluye), relaciona los bloques de memoria asignados en el espacio de dirección @ref{4219,,domain}.

Si `inclusive' es @code{False} (excluye), relaciona los bloques de memoria no asignados en el espacio de dirección @ref{4219,,domain}.
@end deffn

@geindex domain (atributo de tracemalloc.DomainFilter)
@anchor{library/tracemalloc tracemalloc DomainFilter domain}@anchor{4219}
@deffn {Atributo} domain

Espacio de dirección de un bloque de memoria (@code{int}). Propiedad solo-lectura.
@end deffn
@end deffn

@node Filtro,Cuadro,Filtro de dominio,API
@anchor{library/tracemalloc filter}@anchor{421a}
@subsubsection Filtro


@geindex Filter (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Filter}@anchor{421b}
@deffn {Clase} tracemalloc.Filter (inclusive: bool, filename_pattern: str, lineno: int = None, all_frames: bool = False, domain: int = None)

Filtra los rastros de los bloques de memoria.

También mira la función @ref{18a8,,fnmatch.fnmatch()} para la sintaxis de `filename_pattern'. La extensión @code{'.pyc'} es remplazada por @code{'.py'}.

Ejemplos:


@itemize *

@item 
@code{Filter(True, subprocess.__file__)} solo incluye los rastros de el módulo @ref{d6,,subprocess}

@item 
@code{Filter(False, tracemalloc.__file__)} excluye los rastros de memoria del módulo @ref{ff,,tracemalloc}

@item 
@code{Filter(False, "<unknown>")} excluye los seguimientos vacíos
@end itemize


Distinto en la versión 3.5: La extensión @code{'.pyo'} ya no se remplaza con @code{'.py'}.



Distinto en la versión 3.6: Agregado el atributo @ref{421c,,domain} .


@geindex domain (atributo de tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter domain}@anchor{421c}
@deffn {Atributo} domain

El espacio de dirección de un bloque de memoria (@code{int} o @code{None}).

tracemalloc usa el dominio @code{0} para rastrear las asignaciones de memoria hechas por Python. Las extensiones C pueden usar otros dominios para rastrear otros recursos.
@end deffn

@geindex inclusive (atributo de tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter inclusive}@anchor{421d}
@deffn {Atributo} inclusive

Si `inclusive' es @code{True} (incluye), solo relaciona los bloques de memoria asignados en un archivo con el nombre coincidiendo con el atributo @ref{421e,,filename_pattern} en el número de línea del atributo @ref{421f,,lineno}.

Si `inclusive' es @code{False} (excluye), ignora los bloques de memoria asignados en un archivo con el nombre coincidiendo con el atributo @ref{421e,,filename_pattern} en el número de línea del atributo @ref{421f,,lineno}.
@end deffn

@geindex lineno (atributo de tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter lineno}@anchor{421f}
@deffn {Atributo} lineno

El número de linea (@code{int}) del filtro. Si `lineno' es @code{None}, el filtro se relaciona con cualquier número de linea.
@end deffn

@geindex filename_pattern (atributo de tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter filename_pattern}@anchor{421e}
@deffn {Atributo} filename_pattern

El patrón del nombre de archivo del filtro (@code{str}). Propiedad solo-lectura.
@end deffn

@geindex all_frames (atributo de tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter all_frames}@anchor{4220}
@deffn {Atributo} all_frames

Si `all_frames' es @code{True}, todos los cuadros de los rastreos son chequeados. Si `all_frames' es @code{False}, solo el cuadro mas reciente es chequeado.

El atributo no tiene efecto si el limite de rastreo es @code{1}.  Mira la función @ref{4210,,get_traceback_limit()} y el atributo @ref{4221,,Snapshot.traceback_limit}.
@end deffn
@end deffn

@node Cuadro,Captura instantánea,Filtro,API
@anchor{library/tracemalloc frame}@anchor{4222}
@subsubsection Cuadro


@geindex Frame (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Frame}@anchor{4223}
@deffn {Clase} tracemalloc.Frame

Cuadro de un rastreo.

La clase @ref{c1e,,Traceback} es una secuencia de las instancias de la clase @ref{4223,,Frame}.

@geindex filename (atributo de tracemalloc.Frame)
@anchor{library/tracemalloc tracemalloc Frame filename}@anchor{4224}
@deffn {Atributo} filename

Nombre de archivo (@code{str}).
@end deffn

@geindex lineno (atributo de tracemalloc.Frame)
@anchor{library/tracemalloc tracemalloc Frame lineno}@anchor{4225}
@deffn {Atributo} lineno

Número de línea (@code{int}).
@end deffn
@end deffn

@node Captura instantánea,Estadística,Cuadro,API
@anchor{library/tracemalloc snapshot}@anchor{4226}
@subsubsection Captura instantánea


@geindex Snapshot (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Snapshot}@anchor{4216}
@deffn {Clase} tracemalloc.Snapshot

Captura instantánea de los rastros de los bloques de memoria asignados por Python.

La función @ref{4211,,take_snapshot()} crea una instancia de captura instantánea.

@geindex compare_to() (método de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot compare_to}@anchor{4215}
@deffn {Método} compare_to (old_snapshot: Snapshot, key_type: str, cumulative: bool = False)

Calcula las diferencias con una vieja captura instantánea. Obtiene las estadísticas en una lista ordenada de instancias de la clase @ref{4227,,StatisticDiff} agrupadas por `key_type'.

Mira el método @ref{4204,,Snapshot.statistics()} para los parámetros `key_type' y `cumulative'.

El resultado esta guardado desde el más grande al más pequeño por los valores absolutos de @ref{4228,,StatisticDiff.size_diff()}, @ref{4229,,StatisticDiff.size()}, el valor absoluto de @ref{422a,,StatisticDiff.count_diff()}, @ref{422b,,Statistic.count()} y después por el atributo @ref{422c,,StatisticDiff.traceback()}.
@end deffn

@geindex dump() (método de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot dump}@anchor{4206}
@deffn {Método} dump (filename)

Escribe la captura instantánea en un archivo.

Usa el método @ref{4207,,load()} para recargar la captura instantánea.
@end deffn

@geindex filter_traces() (método de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot filter_traces}@anchor{422d}
@deffn {Método} filter_traces (filters)

Crea una nueva instancia de clase @ref{4216,,Snapshot} con una secuencia de @ref{422e,,traces} filtrados, `filters' es una lista de las instancias de @ref{d78,,DomainFilter} y @ref{421b,,Filter}.  Si `filters' es una lista vacía, retorna una nueva instancia de clase @ref{4216,,Snapshot} con una copia de los rastreos.

Los filtros @code{todo incluido} se aplican de a uno, si los filtros no incluidos coinciden. Si al menos un filtro exclusivo coincide, se ignora un rastro.


Distinto en la versión 3.6: Las instancias de clase @ref{d78,,DomainFilter} ahora también son aceptadas en `filters'.

@end deffn

@geindex load() (método de clase de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot load}@anchor{4207}
@deffn {Método} classmethod load (filename)

Carga la captura instantánea desde un archivo.

También mira el método @ref{4206,,dump()}.
@end deffn

@geindex statistics() (método de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot statistics}@anchor{4204}
@deffn {Método} statistics (key_type: str, cumulative: bool = False)

Obtiene estadísticas como una lista ordenada, de instancias de @ref{422f,,Statistic} agrupadas por `key_type':


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

key_type

@tab

descripción

@item

@code{'filename'}

@tab

nombre del archivo

@item

@code{'lineno'}

@tab

nombre del archivo y número de línea

@item

@code{'traceback'}

@tab

seguimiento

@end multitable


Si `cumulative' es @code{True}, acumula el tamaño y cuenta los bloques de memoria de todos los cuadros del seguimiento de un rastro, no solo el cuadro mas reciente. El modo acumulativo solo puede ser usado cuando `key_type' se iguala a @code{'filename'} y @code{'lineno'}.

El resultado se organiza desde el más grande hasta el más pequeño por el atributo @ref{4230,,Statistic.size}, @ref{422b,,Statistic.count} y después por @ref{4231,,Statistic.traceback}.
@end deffn

@geindex traceback_limit (atributo de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot traceback_limit}@anchor{4221}
@deffn {Atributo} traceback_limit

El número máximo de cuadros organizados en el rastreo del atributo @ref{422e,,traces}: resulta de la función @ref{4210,,get_traceback_limit} cuando la captura instantánea fue tomada.
@end deffn

@geindex traces (atributo de tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot traces}@anchor{422e}
@deffn {Atributo} traces

Rastros de todos los bloques de memoria asignados por Python: secuencia de instancias de @ref{4232,,Trace}.

La secuencia tiene un orden que no esta definido. Usa el método @ref{4204,,Snapshot.statistics()} para obtener una lista ordenada de estadísticas.
@end deffn
@end deffn

@node Estadística,StatisticDiff,Captura instantánea,API
@anchor{library/tracemalloc statistic}@anchor{4233}
@subsubsection Estadística


@geindex Statistic (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Statistic}@anchor{422f}
@deffn {Clase} tracemalloc.Statistic

Estadística de las asignaciones de memoria.

@ref{4204,,Snapshot.statistics()} retorna una lista de instancias de la clase @ref{422f,,Statistic}.

También mira la clase @ref{4227,,StatisticDiff}.

@geindex count (atributo de tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic count}@anchor{422b}
@deffn {Atributo} count

Número de bloques de memoria (@code{int}).
@end deffn

@geindex size (atributo de tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic size}@anchor{4230}
@deffn {Atributo} size

El tamaño total de los bloques de memoria en bytes (@code{int}).
@end deffn

@geindex traceback (atributo de tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic traceback}@anchor{4231}
@deffn {Atributo} traceback

Rastrea donde un bloque de memoria fue asignado, la instancia de la clase @ref{c1e,,Traceback}.
@end deffn
@end deffn

@node StatisticDiff,Rastro,Estadística,API
@anchor{library/tracemalloc statisticdiff}@anchor{4234}
@subsubsection StatisticDiff


@geindex StatisticDiff (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc StatisticDiff}@anchor{4227}
@deffn {Clase} tracemalloc.StatisticDiff

La diferencia de estadística en las asignaciones de memoria entre una vieja y una nueva instancia de clase @ref{4216,,Snapshot}.

@ref{4215,,Snapshot.compare_to()} retorna una lista de instancias de la clase @ref{4227,,StatisticDiff}. Mira también la clase @ref{422f,,Statistic}.

@geindex count (atributo de tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff count}@anchor{4235}
@deffn {Atributo} count

El número de bloques de memoria en la nueva captura de pantalla (@code{int}): @code{0} si los bloques de memoria han sido liberados en la nueva captura instantánea.
@end deffn

@geindex count_diff (atributo de tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff count_diff}@anchor{422a}
@deffn {Atributo} count_diff

La diferencia de los números de los bloques de memoria entre las capturas viejas y nuevas (@code{int}): @code{0} si el bloque de memoria ha sido asignado en la nueva captura instantánea.
@end deffn

@geindex size (atributo de tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff size}@anchor{4229}
@deffn {Atributo} size

El tamaño total de los bloques de memoria en bytes en la nueva captura instantánea (@code{int}): @code{0} si el bloque de memoria ha sido liberado en la nueva captura instantánea.
@end deffn

@geindex size_diff (atributo de tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff size_diff}@anchor{4228}
@deffn {Atributo} size_diff

La diferencia de el tamaño total de un bloque de memoria en bytes entre las capturas instantáneas viejas y nuevas (@code{int}): @code{0} si el bloque de memoria ha sido asignado en la nueva captura instantánea.
@end deffn

@geindex traceback (atributo de tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff traceback}@anchor{422c}
@deffn {Atributo} traceback

Rastrea donde los bloques de memoria han sido asignados, instancia de la clase @ref{c1e,,Traceback}.
@end deffn
@end deffn

@node Rastro,Seguimiento,StatisticDiff,API
@anchor{library/tracemalloc trace}@anchor{4236}
@subsubsection Rastro


@geindex Trace (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Trace}@anchor{4232}
@deffn {Clase} tracemalloc.Trace

Rastro de un bloque de memoria.

El atributo @ref{422e,,Snapshot.traces} es una secuencia de las instancias de la clase @ref{4232,,Trace}.


Distinto en la versión 3.6: Agregado el atributo @ref{4237,,domain} .


@geindex domain (atributo de tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace domain}@anchor{4237}
@deffn {Atributo} domain

Espacio de dirección de un bloque de memoria (@code{int}). Propiedad solo-lectura.

tracemalloc usa el dominio @code{0} para rastrear las asignaciones de memoria hechas por Python. Las extensiones C pueden usar otros dominios para rastrear otros recursos.
@end deffn

@geindex size (atributo de tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace size}@anchor{4238}
@deffn {Atributo} size

Tamaño de un bloque de memoria en bytes (@code{int}).
@end deffn

@geindex traceback (atributo de tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace traceback}@anchor{4239}
@deffn {Atributo} traceback

Rastrea donde un bloque de memoria fue asignado, la instancia de la clase @ref{c1e,,Traceback}.
@end deffn
@end deffn

@node Seguimiento,,Rastro,API
@anchor{library/tracemalloc traceback}@anchor{423a}
@subsubsection Seguimiento


@geindex Traceback (clase en tracemalloc)
@anchor{library/tracemalloc tracemalloc Traceback}@anchor{c1e}
@deffn {Clase} tracemalloc.Traceback

La secuencia de las instancias de la clase @ref{4223,,Frame} organizadas desde el cuadro mas antiguo al más reciente.

Un seguimiento contiene por lo menos @code{1} cuadro. Si el módulo @code{tracemalloc} falla al traer un cuadro, se usa el nombre del archivo @code{"<unknown>"} en el número de linea @code{0}.

Cuando se toma una captura, los seguimientos de los rastreos se limitan a @ref{4210,,get_traceback_limit()} cuadros. Ver la función @ref{4211,,take_snapshot()}. El número original de cuadros del seguimiento se guarda en el atributo @ref{4214,,Traceback.total_nframe}. Esto permite saber si un seguimiento fue truncado por el límite de seguimientos.

El atributo @ref{4239,,Trace.traceback} es una instancia de la clase @ref{c1e,,Traceback}.


Distinto en la versión 3.7: Los cuadros están organizados desde el mas antiguo hasta el más reciente, en vez de el más reciente al más antiguo.


@geindex total_nframe (atributo de tracemalloc.Traceback)
@anchor{library/tracemalloc tracemalloc Traceback total_nframe}@anchor{4214}
@deffn {Atributo} total_nframe

Número total de cuadros que componen el seguimiento antes de ser truncado. Este atributo puede ser @code{None} si no hay información disponible.
@end deffn


Distinto en la versión 3.9: El atributo @ref{4214,,Traceback.total_nframe} fue añadido.


@geindex format() (método de tracemalloc.Traceback)
@anchor{library/tracemalloc tracemalloc Traceback format}@anchor{c1f}
@deffn {Método} format (limit=None, most_recent_first=False)

Formatea el seguimiento como una lista de líneas. Usa el módulo @ref{85,,linecache} para recuperar líneas del código fuente. Si se configura el límite, formatea los cuadros más recientes de los límites, si límite es positivo. De otra manera, formatea los cuadros más antiguos de @code{abs(limit)}. Si `most_recent_first' es @code{True}, se invierte el orden de los cuadros formateados, devolviendo el cuadro más reciente en lugar del último.

Similar a la función @ref{423b,,traceback.format_tb()}, excepto por el método @ref{c1f,,format()} que no incluye nuevas líneas.

Ejemplo:

@example
print("Traceback (most recent call first):")
for line in traceback:
    print(line)
@end example

Salida:

@example
Traceback (most recent call first):
  File "test.py", line 9
    obj = Object()
  File "test.py", line 12
    tb = tracemalloc.get_object_traceback(f())
@end example
@end deffn
@end deffn

@node Empaquetado y distribución de software,Servicios en tiempo de ejecución de Python,Depuración y perfilado,La biblioteca estándar de Python
@anchor{library/distribution doc}@anchor{423c}@anchor{library/distribution software-packaging-and-distribution}@anchor{423d}
@section Empaquetado y distribución de software


Estas bibliotecas te ayudan a publicar e instalar software de Python. Aunque estos módulos están diseñados para funcionar junto con Python Package Index@footnote{https://pypi.org}, también pueden ser utilizados con un servidor de indexado local, o sin servidor de indexado.

@menu
* ensurepip — Bootstrapping the pip installer:: 
* venv — Creation of virtual environments:: 
* zipapp — Manage executable Python zip archives:: 

@end menu

@node ensurepip — Bootstrapping the pip installer,venv — Creation of virtual environments,,Empaquetado y distribución de software
@anchor{library/ensurepip doc}@anchor{423e}@anchor{library/ensurepip ensurepip-bootstrapping-the-pip-installer}@anchor{423f}@anchor{library/ensurepip module-ensurepip}@anchor{55}
@subsection @code{ensurepip} — Bootstrapping the @code{pip} installer


@geindex module; ensurepip


Added in version 3.4.


`Source code:' Lib/ensurepip@footnote{https://github.com/python/cpython/tree/main/Lib/ensurepip}


__________________________________________________________________


El paquete @ref{55,,ensurepip} proporciona soporte para ejecutar el instalador @code{pip} en una instalación de Python existente o en un entorno virtual. Este enfoque de arranque refleja el hecho de que @code{pip} es un proyecto independiente con su propio ciclo de lanzamiento, y la última versión estable disponible se incluye con el mantenimiento y las versiones de características del intérprete de referencia CPython.

En la mayoría de los casos, los usuarios finales de Python no deberían tener que invocar este módulo directamente (como @code{pip} deben arrancarse de forma predeterminada), pero puede ser necesario si se omitió la instalación de @code{pip} al instalar Python (o al crear un entorno virtual) o después de desinstalar explícitamente @code{pip}.

@cartouche
@quotation Nota 
Este módulo `no' accede a Internet. Todos los componentes necesarios para ejecutar @code{pip} se incluyen como partes internas del paquete.
@end quotation
@end cartouche


@subsubheading Ver también



@table @asis

@item @ref{f78,,Instalando módulos de Python}

La guía del usuario final para instalar paquetes python

@geindex Python Enhancement Proposals; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/}: Arranque explícito de pip en instalaciones de Python

La justificación original y la especificación de este módulo.
@end table


@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@menu
* Interfaz de línea de comandos: Interfaz de línea de comandos<5>. 
* API del módulo:: 

@end menu

@node Interfaz de línea de comandos<5>,API del módulo,,ensurepip — Bootstrapping the pip installer
@anchor{library/ensurepip command-line-interface}@anchor{4240}
@subsubsection Interfaz de línea de comandos


La interfaz de línea de comandos se invoca mediante el modificador @code{-m} del intérprete.

La invocación más simple posible es:

@example
python -m ensurepip
@end example

Esta invocación instalará @code{pip} si aún no está instalado, pero de lo contrario no hace nada. Para asegurarse de que la versión instalada de @code{pip} sea al menos tan reciente como la disponible en @code{ensurepip}, pase la opción @code{--upgrade}:

@example
python -m ensurepip --upgrade
@end example

De forma predeterminada, @code{pip} se instala en el entorno virtual actual (si uno está activo) o en los paquetes de sitio del sistema (si no hay ningún entorno virtual activo). La ubicación de instalación se puede controlar a través de dos opciones de línea de comandos adicionales:


@itemize *

@item 
@code{--root @var{dir}}: Installs @code{pip} relative to the given root directory
rather than the root of the currently active virtual environment (if any)
or the default root for the current Python installation.

@item 
@code{--user}: Instala @code{pip} en el directorio de paquetes de sitio de usuario en lugar de globalmente para la instalación actual de Python (esta opción no está permitida dentro de un entorno virtual activo).
@end itemize

De forma predeterminada, se instalarán los scripts @code{pipX} y @code{pipX.Y} (donde X.Y representa la versión de Python utilizada para invocar @code{ensurepip}). Los scripts instalados se pueden controlar a través de dos opciones de línea de comandos adicionales:


@itemize *

@item 
@code{--altinstall}: si se solicita una instalación alternativa, `no' se instalará el script @code{pipX}.

@item 
@code{--default-pip}: si se solicita una instalación de «pip predeterminado», se instalará el script @code{pip} además de los dos scripts regulares.
@end itemize

Proporcionar ambas opciones de selección de script desencadenará una excepción.

@node API del módulo,,Interfaz de línea de comandos<5>,ensurepip — Bootstrapping the pip installer
@anchor{library/ensurepip module-api}@anchor{4241}
@subsubsection API del módulo


@ref{55,,ensurepip} expone dos funciones para su uso programático:

@geindex version() (en el módulo ensurepip)
@anchor{library/ensurepip ensurepip version}@anchor{4242}
@deffn {Función} ensurepip.version ()

Retorna una cadena que especifica la versión disponible de pip que se instalará al arrancar un entorno.
@end deffn

@geindex bootstrap() (en el módulo ensurepip)
@anchor{library/ensurepip ensurepip bootstrap}@anchor{410b}
@deffn {Función} ensurepip.bootstrap (root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)

Ejecuta @code{pip} en el entorno actual o designado.

`root' especifica un directorio raíz alternativo para instalar en relación con. Si `root' es @code{None}, la instalación utiliza la ubicación de instalación predeterminada para el entorno actual.

`upgrade' indica si se debe actualizar o no una instalación existente de una versión anterior de @code{pip} a la versión disponible.

`user' indica si se debe utilizar el esquema de usuario en lugar de instalar globalmente.

De forma predeterminada, se instalarán los scripts @code{pipX} y @code{pipX.Y} (donde X.Y representa la versión actual de Python).

Si se establece `altinstall', `no' se instalará @code{pipX}.

Si se establece `default_pip', se instalará @code{pip} además de los dos scripts normales.

Establecer tanto `altinstall' como `default_pip' desencadenará @ref{360,,ValueError}.

`verbosity' controla el nivel de salida a @ref{b61,,sys.stdout} de la operación de ejecución.

Genera un evento @ref{18c3,,auditing} @code{ensurepip.bootstrap} con el argumento @code{root}.

@cartouche
@quotation Nota 
El proceso de ejecución tiene efectos secundarios tanto en @code{sys.path} como @code{os.environ}. Invocar la interfaz de línea de comandos en un subproceso en su lugar permite evitar estos efectos secundarios.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
El proceso de ejecución puede instalar módulos adicionales requeridos por @code{pip}, pero otro software no debe asumir que esas dependencias siempre estarán presentes de forma predeterminada (ya que las dependencias se pueden eliminar en una versión futura de @code{pip}).
@end quotation
@end cartouche
@end deffn

@node venv — Creation of virtual environments,zipapp — Manage executable Python zip archives,ensurepip — Bootstrapping the pip installer,Empaquetado y distribución de software
@anchor{library/venv doc}@anchor{4243}@anchor{library/venv module-venv}@anchor{111}@anchor{library/venv venv-creation-of-virtual-environments}@anchor{4244}
@subsection @code{venv} — Creation of virtual environments


@geindex module; venv


Added in version 3.3.


`Código fuente:' Lib/venv/@footnote{https://github.com/python/cpython/tree/main/Lib/venv/}

@geindex Environments;virtual


__________________________________________________________________

@anchor{library/venv venv-def}@anchor{4245}@anchor{library/venv venv-intro}@anchor{4246}
El módulo @code{venv} admite la creación de «entornos virtuales» ligeros, cada uno con su propio conjunto independiente de paquetes de Python instalados en sus directorios @ref{c7,,site}. Se crea un entorno virtual sobre una instalación existente de Python, conocida como la «base» del entorno virtual de Python y, opcionalmente, se puede aislar de los paquetes en la base del entorno, así que solo están disponibles los instalados explícitamente en el entorno virtual.

When used from within a virtual environment, common installation tools such as
pip@footnote{https://pypi.org/project/pip/} will install Python packages into a virtual environment
without needing to be told to do so explicitly.

A virtual environment is (amongst other things):


@itemize *

@item 
Used to contain a specific Python interpreter and software libraries and
binaries which are needed to support a project (library or application). These
are by default isolated from software in other virtual environments and Python
interpreters and libraries installed in the operating system.

@item 
Contained in a directory, conventionally named @code{.venv} or @code{venv} in
the project directory, or under a container directory for lots of virtual
environments, such as @code{~/.virtualenvs}.

@item 
Not checked into source control systems such as Git.

@item 
Considered as disposable – it should be simple to delete and recreate it from
scratch. You don’t place any project code in the environment.

@item 
Not considered as movable or copyable – you just recreate the same
environment in the target location.
@end itemize

Ver 
@geindex Python Enhancement Proposals; PEP 405
PEP 405@footnote{https://peps.python.org/pep-0405/} para más información sobre los entornos virtuales de Python.


@subsubheading Ver también


Python Packaging User Guide: Creating and using virtual environments@footnote{https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments}


@c include for modules that don't work on WASM or mobile platforms

@ref{1d5a,,Availability}: not Android, not iOS, not WASI.

This module is not supported on @ref{1e5b,,mobile platforms}
or @ref{17e8,,WebAssembly platforms}.

@menu
* Creación de entornos virtuales:: 
* Cómo funcionan los venvs:: 
* API: API<2>. 
* Un ejemplo de la extensión de EnvBuilder:: 

@end menu

@node Creación de entornos virtuales,Cómo funcionan los venvs,,venv — Creation of virtual environments
@anchor{library/venv creating-virtual-environments}@anchor{4247}
@subsubsection Creación de entornos virtuales


@ref{4245,,Virtual environments} are created by executing the @code{venv}
module:

@example
python -m venv /path/to/new/virtual/environment
@end example

This creates the target directory (including parent directories as needed)
and places a @code{pyvenv.cfg} file in it with a @code{home} key
pointing to the Python installation from which the command was run.
It also creates a @code{bin} (or @code{Scripts} on Windows) subdirectory
containing a copy or symlink of the Python executable
(as appropriate for the platform or arguments used at environment creation time).
It also creates a @code{lib/pythonX.Y/site-packages} subdirectory
(on Windows, this is @code{Libsite-packages}).
If an existing directory is specified, it will be re-used.


Distinto en la versión 3.5: The use of @code{venv} is now recommended for creating virtual environments.



Deprecated since version 3.6, removed in version 3.8: @code{pyvenv} was the recommended tool for creating virtual environments
for Python 3.3 and 3.4, and replaced in 3.5 by executing @code{venv} directly.


On Windows, invoke the @code{venv} command as follows:

@example
PS> python -m venv C:\path\to\new\virtual\environment
@end example

The command, if run with @code{-h}, will show the available options:

@example
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
            [--upgrade] [--without-pip] [--prompt PROMPT] [--upgrade-deps]
            [--without-scm-ignore-files]
            ENV_DIR [ENV_DIR ...]

Creates virtual Python environments in one or more target directories.

positional arguments:
  ENV_DIR               A directory to create the environment in.

options:
  -h, --help            show this help message and exit
  --system-site-packages
                        Give the virtual environment access to the system
                        site-packages dir.
  --symlinks            Try to use symlinks rather than copies, when
                        symlinks are not the default for the platform.
  --copies              Try to use copies rather than symlinks, even when
                        symlinks are the default for the platform.
  --clear               Delete the contents of the environment directory
                        if it already exists, before environment creation.
  --upgrade             Upgrade the environment directory to use this
                        version of Python, assuming Python has been
                        upgraded in-place.
  --without-pip         Skips installing or upgrading pip in the virtual
                        environment (pip is bootstrapped by default)
  --prompt PROMPT       Provides an alternative prompt prefix for this
                        environment.
  --upgrade-deps        Upgrade core dependencies (pip) to the latest
                        version in PyPI
  --without-scm-ignore-files
                        Skips adding SCM ignore files to the environment
                        directory (Git is supported by default).

Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.
@end example


Distinto en la versión 3.4: Installs pip by default, added the @code{--without-pip}  and @code{--copies}
options.



Distinto en la versión 3.4: In earlier versions, if the target directory already existed, an error was
raised, unless the @code{--clear} or @code{--upgrade} option was provided.



Distinto en la versión 3.9: Add @code{--upgrade-deps} option to upgrade pip + setuptools to the latest on PyPI.



Distinto en la versión 3.12: @code{setuptools} is no longer a core venv dependency.



Distinto en la versión 3.13: Added the @code{--without-scm-ignore-files} option.



Distinto en la versión 3.13: @code{venv} now creates a @code{.gitignore} file for Git by default.


@cartouche
@quotation Nota 
While symlinks are supported on Windows, they are not recommended. Of
particular note is that double-clicking @code{python.exe} in File Explorer
will resolve the symlink eagerly and ignore the virtual environment.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
On Microsoft Windows, it may be required to enable the @code{Activate.ps1}
script by setting the execution policy for the user. You can do this by
issuing the following PowerShell command:

@example
PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
@end example

See About Execution Policies@footnote{https://go.microsoft.com/fwlink/?LinkID=135170}
for more information.
@end quotation
@end cartouche

The created @code{pyvenv.cfg} file also includes the
@code{include-system-site-packages} key, set to @code{true} if @code{venv} is
run with the @code{--system-site-packages} option, @code{false} otherwise.

Unless the @code{--without-pip} option is given, @ref{55,,ensurepip} will be
invoked to bootstrap @code{pip} into the virtual environment.

Multiple paths can be given to @code{venv}, in which case an identical virtual
environment will be created, according to the given options, at each provided
path.

@node Cómo funcionan los venvs,API<2>,Creación de entornos virtuales,venv — Creation of virtual environments
@anchor{library/venv how-venvs-work}@anchor{4248}@anchor{library/venv venv-explanation}@anchor{4f9}
@subsubsection Cómo funcionan los venvs


When a Python interpreter is running from a virtual environment,
@ref{281,,sys.prefix} and @ref{27c,,sys.exec_prefix}
point to the directories of the virtual environment,
whereas @ref{280,,sys.base_prefix} and @ref{27b,,sys.base_exec_prefix}
point to those of the base Python used to create the environment.
It is sufficient to check
@code{sys.prefix != sys.base_prefix} to determine if the current interpreter is
running from a virtual environment.

A virtual environment may be «activated» using a script in its binary directory
(@code{bin} on POSIX; @code{Scripts} on Windows).
This will prepend that directory to your 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}, so that running
@code{python} will invoke the environment’s Python interpreter
and you can run installed scripts without having to use their full path.
The invocation of the activation script is platform-specific
(@code{@var{<venv>}} must be replaced by the path to the directory
containing the virtual environment):


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Plataforma

@tab

Shell

@tab

Comando para activar el entorno virtual

@item

POSIX

@tab

bash/zsh

@tab

@code{$ source @var{<venv>}/bin/activate}

@item

fish

@tab

@code{$ source @var{<venv>}/bin/activate.fish}

@item

csh/tcsh

@tab

@code{$ source @var{<venv>}/bin/activate.csh}

@item

pwsh

@tab

@code{$ @var{<venv>}/bin/Activate.ps1}

@item

Windows

@tab

cmd.exe

@tab

@code{C:\> @var{<venv>}\Scripts\activate.bat}

@item

PowerShell

@tab

@code{PS C:\> @var{<venv>}\Scripts\Activate.ps1}

@end multitable



Added in version 3.4: @code{fish} and @code{csh} activation scripts.



Added in version 3.8: Scripts de activación de PowerShell instalados en POSIX para compatibilidad con PowerShell Core.


No `necesita' específicamente activar un entorno virtual, ya que puede solo especificar la ruta completa al intérprete de Python de ese entorno al invocar Python. Además, todos los scripts instalados en el entorno deben poder ejecutarse sin activarlo.

In order to achieve this, scripts installed into virtual environments have
a «shebang» line which points to the environment’s Python interpreter,
@code{#!/@var{<path-to-venv>}/bin/python}.
This means that the script will run with that interpreter regardless of the
value of 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}. On Windows, «shebang» line processing is supported if
you have the @ref{65f,,Lanzador de Python para Windows} installed. Thus, double-clicking an installed
script in a Windows Explorer window should run it with the correct interpreter
without the environment needing to be activated or on the 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.

Cuando se ha activado un entorno virtual, la variable de entorno @code{VIRTUAL_ENV} se establece en la ruta del entorno. Dado que no se requiere activar explícitamente una entorno virtual para usarla, no se puede confiar en @code{VIRTUAL_ENV} para determinar si se está usando un entorno virtual.

@cartouche
@quotation Advertencia 
Debido a que los scripts instalados en entornos no deben esperar a que el entorno se active, sus líneas shebang contienen las rutas absolutas a los intérpretes de su entorno. Debido a esto, los entornos son inherentemente no portables, en el caso general. Siempre debe tener un medio simple para recrear un entorno (por ejemplo, si tiene un archivo de requisitos @code{requirements.txt}, puede invocar @code{pip install -r requirements.txt} al usar @code{pip} del entorno para instalar todos los paquetes que necesite el entorno). Si por alguna razón necesita mover el entorno a una nueva ubicación, debe recrearlo en la ubicación deseada y eliminar el de la ubicación anterior. Si mueve un entorno porque movió un directorio principal del mismo, debe recrear el entorno en su nueva ubicación. De lo contrario, el software instalado en el entorno puede no funcionar como se espera.
@end quotation
@end cartouche

Puede desactivar un entorno virtual al escribir @code{deactivate} en el shell. El mecanismo exacto es específico de la plataforma y es un detalle de implementación interno (se usará normalmente una función de script o shell).

@node API<2>,Un ejemplo de la extensión de EnvBuilder,Cómo funcionan los venvs,venv — Creation of virtual environments
@anchor{library/venv api}@anchor{4249}@anchor{library/venv venv-api}@anchor{f75}
@subsubsection API


El método de alto nivel descrito anteriormente utiliza una sencilla API que proporciona mecanismos para que les creadores de entornos virtuales de terceras/os puedan personalizar la creación de entornos según sus necesidades, la clase @ref{3c1,,EnvBuilder}.

@geindex EnvBuilder (clase en venv)
@anchor{library/venv venv EnvBuilder}@anchor{3c1}
@deffn {Clase} venv.EnvBuilder (system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

La clase @ref{3c1,,EnvBuilder} acepta los siguientes argumentos de palabras clave en la instanciación:


@itemize *

@item 
`system_site_packages' – a boolean value indicating that the system Python
site-packages should be available to the environment (defaults to @code{False}).

@item 
`clear' – a boolean value which, if true, will delete the contents of
any existing target directory, before creating the environment.

@item 
`symlinks' – a boolean value indicating whether to attempt to symlink the
Python binary rather than copying.

@item 
`upgrade' – a boolean value which, if true, will upgrade an existing
environment with the running Python - for use when that Python has been
upgraded in-place (defaults to @code{False}).

@item 
`with_pip' – a boolean value which, if true, ensures pip is
installed in the virtual environment. This uses @ref{55,,ensurepip} with
the @code{--default-pip} option.

@item 
`prompt' – a string to be used after virtual environment is activated
(defaults to @code{None} which means directory name of the environment would
be used). If the special string @code{"."} is provided, the basename of the
current directory is used as the prompt.

@item 
`upgrade_deps' – Update the base venv modules to the latest on PyPI

@item 
`scm_ignore_files' – Create ignore files based for the specified source
control managers (SCM) in the iterable. Support is defined by having a
method named @code{create_@{scm@}_ignore_file}. The only value supported by
default is @code{"git"} via @ref{424a,,create_git_ignore_file()}.
@end itemize


Distinto en la versión 3.4: Añadido el parámetro @code{with_pip}



Distinto en la versión 3.6: Añadido el parámetro @code{prompt}



Distinto en la versión 3.9: Se agregó el parámetro @code{upgrade_deps}



Distinto en la versión 3.13: Added the @code{scm_ignore_files} parameter


@ref{3c1,,EnvBuilder} may be used as a base class.

@geindex create() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create}@anchor{424b}
@deffn {Método} create (env_dir)

Crear un entorno virtual especificando el directorio de destino (de forma absoluta o relativa al directorio actual) que ha de contener el entorno virtual. El método @code{create} creará el entorno en el directorio especificado, o lanzará la correspondiente excepción.

El método @code{create} de la clase @ref{3c1,,EnvBuilder} ilustra los enlaces disponibles para la personalización de la subclase:

@example
def create(self, env_dir):
    """
    Create a virtualized Python environment in a directory.
    env_dir is the target directory to create an environment in.
    """
    env_dir = os.path.abspath(env_dir)
    context = self.ensure_directories(env_dir)
    self.create_configuration(context)
    self.setup_python(context)
    self.setup_scripts(context)
    self.post_setup(context)
@end example

Cada uno de los métodos @ref{424c,,ensure_directories()}, @ref{424d,,create_configuration()}, @ref{424e,,setup_python()}, @ref{424f,,setup_scripts()} y @ref{4250,,post_setup()} pueden ser anulados.
@end deffn

@geindex ensure_directories() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder ensure_directories}@anchor{424c}
@deffn {Método} ensure_directories (env_dir)

Crea el directorio del entorno y todos los subdirectorios necesarios que aún no existen, y retorna un objeto de contexto. Este objeto de contexto es solo un contenedor de atributos (como rutas) para que lo usen otros métodos. Si se crea @ref{3c1,,EnvBuilder} con el argumento @code{clear=True}, se borrará el contenido del directorio del entorno y luego se recrearán todos los subdirectorios necesarios.

El objeto de contexto que retorna es un @ref{334,,types.SimpleNamespace} con los siguientes atributos:


@itemize *

@item 
@code{env_dir} - La ubicación del entorno virtual. Se usa para @code{__VENV_DIR__} en scripts de activación (ver @ref{4251,,install_scripts()}).

@item 
@code{env_name} - El nombre del entorno virtual. Se usa para @code{__VENV_NAME__} en scripts de activación (ver @ref{4251,,install_scripts()}).

@item 
@code{prompt} - El prompt que utilizarán los scripts de activación. Se usa para @code{__VENV_PROMPT__} en scripts de activación (ver @ref{4251,,install_scripts()}).

@item 
@code{executable} - El ejecutable de Python subyacente que se utiliza por el entorno virtual. Esto tiene en cuenta el caso donde se crea un entorno virtual a partir de otro entorno virtual.

@item 
@code{inc_path} - La ruta de include para el entorno virtual.

@item 
@code{lib_path} - La ruta de purelib para el entorno virtual.

@item 
@code{bin_path} - La ruta del script para el entorno virtual.

@item 
@code{bin_name} - El nombre de la ruta del script en relación con la ubicación del entorno virtual. Se usa para @code{__VENV_BIN_NAME__} en scripts de activación (ver @ref{4251,,install_scripts()}).

@item 
@code{env_exe} - El nombre del intérprete de Python en el entorno virtual. Se usa para @code{__VENV_PYTHON__} en scripts de activación (ver @ref{4251,,install_scripts()}).

@item 
@code{env_exec_cmd} - El nombre del intérprete de Python, teniendo en cuenta las redirecciones del sistema de archivos. Se puede utilizar para ejecutar Python en el entorno virtual.
@end itemize


Distinto en la versión 3.11: El @ref{730,,esquema de instalación de sysconfig} de `venv' se utiliza para construir las rutas de los directorios creados.



Distinto en la versión 3.12: Se agregó el atributo @code{lib_path} al contexto y se documentó el objeto de contexto.

@end deffn

@geindex create_configuration() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create_configuration}@anchor{424d}
@deffn {Método} create_configuration (context)

Crea el archivo de configuración @code{pyvenv.cfg} en el entorno.
@end deffn

@geindex setup_python() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder setup_python}@anchor{424e}
@deffn {Método} setup_python (context)

Crea una copia o enlace simbólico al ejecutable Python en el entorno. En los sistemas POSIX, si se usó un ejecutable específico @code{python3.x}, se crearán enlaces simbólicos a @code{python} y @code{python3} apuntando a ese ejecutable, a menos que ya existan archivos con esos nombres.
@end deffn

@geindex setup_scripts() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder setup_scripts}@anchor{424f}
@deffn {Método} setup_scripts (context)

Instala los scripts de activación apropiados para la plataforma en el entorno virtual.
@end deffn

@geindex upgrade_dependencies() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder upgrade_dependencies}@anchor{4252}
@deffn {Método} upgrade_dependencies (context)

Upgrades the core venv dependency packages (currently pip@footnote{https://pypi.org/project/pip/})
in the environment. This is done by shelling out to the
@code{pip} executable in the environment.


Added in version 3.9.



Distinto en la versión 3.12: setuptools@footnote{https://pypi.org/project/setuptools/} is no longer a core venv dependency.

@end deffn

@geindex post_setup() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder post_setup}@anchor{4250}
@deffn {Método} post_setup (context)

Un método de marcador de posición que puede ser anulado en implementaciones de terceros/as para previo instalar paquetes en el entorno virtual o realizar otros pasos posteriores a la creación.
@end deffn

@geindex install_scripts() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder install_scripts}@anchor{4251}
@deffn {Método} install_scripts (context, path)

This method can be
called from @ref{424f,,setup_scripts()} or @ref{4250,,post_setup()} in subclasses to
assist in installing custom scripts into the virtual environment.

`path' is the path to a directory that should contain subdirectories
@code{common}, @code{posix}, @code{nt}; each containing scripts destined for the
@code{bin} directory in the environment.  The contents of @code{common} and the
directory corresponding to @ref{2b06,,os.name} are copied after some text
replacement of placeholders:


@itemize *

@item 
@code{__VENV_DIR__} se sustituye por la ruta absoluta del directorio del entorno.

@item 
@code{__VENV_NAME__} se sustituye por el nombre del entorno (parte final de la ruta del directorio del entorno).

@item 
@code{__VENV_PROMPT__} se sustituye por el `prompt' (el nombre del entorno entre paréntesis y con un espacio posterior)

@item 
@code{__VENV_BIN_NAME__} se sustituye con el nombre del directorio `bin' (ya sea @code{bin} o @code{Scripts}).

@item 
@code{__VENV_PYTHON__} se sustituye con la ruta absoluta del ejecutable del entorno.
@end itemize

Se permite la existencia de los directorios (para cuando se está actualizando un entorno existente).
@end deffn

@geindex create_git_ignore_file() (método de venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create_git_ignore_file}@anchor{424a}
@deffn {Método} create_git_ignore_file (context)

Creates a @code{.gitignore} file within the virtual environment that causes
the entire directory to be ignored by the Git source control manager.


Added in version 3.13.

@end deffn


Distinto en la versión 3.7.2: Windows ahora usa scripts de redireccionamiento para @code{python[w].exe} en lugar de copiar los propios binarios. Para 3.7.2 solamente @ref{424e,,setup_python()} no hace nada a menos que se ejecute desde una compilación en el árbol de directorios fuente.



Distinto en la versión 3.7.3: Windows copia los scripts de redireccionamiento como parte de @ref{424e,,setup_python()} en lugar de @ref{424f,,setup_scripts()}. Este no era el caso para 3.7.2. Cuando se usan enlaces simbólicos, los ejecutables originales se enlazan.

@end deffn

También hay una función de conveniencia a nivel de módulo:

@geindex create() (en el módulo venv)
@anchor{library/venv venv create}@anchor{3c2}
@deffn {Función} venv.create (env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

Crea un @ref{3c1,,EnvBuilder} con los argumentos de la palabra clave dada, y llama a su método @ref{424b,,create()} con el argumento `env_dir'.


Added in version 3.3.



Distinto en la versión 3.4: Added the `with_pip' parameter



Distinto en la versión 3.6: Added the `prompt' parameter



Distinto en la versión 3.9: Added the `upgrade_deps' parameter



Distinto en la versión 3.13: Added the `scm_ignore_files' parameter

@end deffn

@node Un ejemplo de la extensión de EnvBuilder,,API<2>,venv — Creation of virtual environments
@anchor{library/venv an-example-of-extending-envbuilder}@anchor{4253}
@subsubsection Un ejemplo de la extensión de @code{EnvBuilder}


El siguiente script muestra como extender @ref{3c1,,EnvBuilder} implementando una subclase que instala setuptools y pip en un entorno virtual creado:

@example
import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlparse
from urllib.request import urlretrieve
import venv

class ExtendedEnvBuilder(venv.EnvBuilder):
    """
    This builder installs setuptools and pip so that you can pip or
    easy_install other packages into the created virtual environment.

    :param nodist: If true, setuptools and pip are not installed into the
                   created virtual environment.
    :param nopip: If true, pip is not installed into the created
                  virtual environment.
    :param progress: If setuptools or pip are installed, the progress of the
                     installation can be monitored by passing a progress
                     callable. If specified, it is called with two
                     arguments: a string indicating some progress, and a
                     context indicating where the string is coming from.
                     The context argument can have one of three values:
                     'main', indicating that it is called from virtualize()
                     itself, and 'stdout' and 'stderr', which are obtained
                     by reading lines from the output streams of a subprocess
                     which is used to install the app.

                     If a callable is not specified, default progress
                     information is output to sys.stderr.
    """

    def __init__(self, *args, **kwargs):
        self.nodist = kwargs.pop('nodist', False)
        self.nopip = kwargs.pop('nopip', False)
        self.progress = kwargs.pop('progress', None)
        self.verbose = kwargs.pop('verbose', False)
        super().__init__(*args, **kwargs)

    def post_setup(self, context):
        """
        Set up any packages which need to be pre-installed into the
        virtual environment being created.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        os.environ['VIRTUAL_ENV'] = context.env_dir
        if not self.nodist:
            self.install_setuptools(context)
        # Can't install pip without setuptools
        if not self.nopip and not self.nodist:
            self.install_pip(context)

    def reader(self, stream, context):
        """
        Read lines from a subprocess' output stream and either pass to a progress
        callable (if specified) or write progress information to sys.stderr.
        """
        progress = self.progress
        while True:
            s = stream.readline()
            if not s:
                break
            if progress is not None:
                progress(s, context)
            else:
                if not self.verbose:
                    sys.stderr.write('.')
                else:
                    sys.stderr.write(s.decode('utf-8'))
                sys.stderr.flush()
        stream.close()

    def install_script(self, context, name, url):
        _, _, path, _, _, _ = urlparse(url)
        fn = os.path.split(path)[-1]
        binpath = context.bin_path
        distpath = os.path.join(binpath, fn)
        # Download script into the virtual environment's binaries folder
        urlretrieve(url, distpath)
        progress = self.progress
        if self.verbose:
            term = '\n'
        else:
            term = '@w{'}
        if progress is not None:
            progress('Installing %s ...%s' % (name, term), 'main')
        else:
            sys.stderr.write('Installing %s ...%s' % (name, term))
            sys.stderr.flush()
        # Install in the virtual environment
        args = [context.env_exe, fn]
        p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
        t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
        t1.start()
        t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
        t2.start()
        p.wait()
        t1.join()
        t2.join()
        if progress is not None:
            progress('done.', 'main')
        else:
            sys.stderr.write('done.\n')
        # Clean up - no longer needed
        os.unlink(distpath)

    def install_setuptools(self, context):
        """
        Install setuptools in the virtual environment.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        url = "https://bootstrap.pypa.io/ez_setup.py"
        self.install_script(context, 'setuptools', url)
        # clear up the setuptools archive which gets downloaded
        pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
        files = filter(pred, os.listdir(context.bin_path))
        for f in files:
            f = os.path.join(context.bin_path, f)
            os.unlink(f)

    def install_pip(self, context):
        """
        Install pip in the virtual environment.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        url = 'https://bootstrap.pypa.io/get-pip.py'
        self.install_script(context, 'pip', url)


def main(args=None):
    import argparse

    parser = argparse.ArgumentParser(prog=__name__,
                                     description='Creates virtual Python '
                                                 'environments in one or '
                                                 'more target '
                                                 'directories.')
    parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
                        help='A directory in which to create the '
                             'virtual environment.')
    parser.add_argument('--no-setuptools', default=False,
                        action='store_true', dest='nodist',
                        help="Don't install setuptools or pip in the "
                             "virtual environment.")
    parser.add_argument('--no-pip', default=False,
                        action='store_true', dest='nopip',
                        help="Don't install pip in the virtual "
                             "environment.")
    parser.add_argument('--system-site-packages', default=False,
                        action='store_true', dest='system_site',
                        help='Give the virtual environment access to the '
                             'system site-packages dir.')
    if os.name == 'nt':
        use_symlinks = False
    else:
        use_symlinks = True
    parser.add_argument('--symlinks', default=use_symlinks,
                        action='store_true', dest='symlinks',
                        help='Try to use symlinks rather than copies, '
                             'when symlinks are not the default for '
                             'the platform.')
    parser.add_argument('--clear', default=False, action='store_true',
                        dest='clear', help='Delete the contents of the '
                                           'virtual environment '
                                           'directory if it already '
                                           'exists, before virtual '
                                           'environment creation.')
    parser.add_argument('--upgrade', default=False, action='store_true',
                        dest='upgrade', help='Upgrade the virtual '
                                             'environment directory to '
                                             'use this version of '
                                             'Python, assuming Python '
                                             'has been upgraded '
                                             'in-place.')
    parser.add_argument('--verbose', default=False, action='store_true',
                        dest='verbose', help='Display the output '
                                             'from the scripts which '
                                             'install setuptools and pip.')
    options = parser.parse_args(args)
    if options.upgrade and options.clear:
        raise ValueError('you cannot supply --upgrade and --clear together.')
    builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
                                   clear=options.clear,
                                   symlinks=options.symlinks,
                                   upgrade=options.upgrade,
                                   nodist=options.nodist,
                                   nopip=options.nopip,
                                   verbose=options.verbose)
    for d in options.dirs:
        builder.create(d)

if __name__ == '__main__':
    rc = 1
    try:
        main()
        rc = 0
    except Exception as e:
        print('Error: %s' % e, file=sys.stderr)
    sys.exit(rc)
@end example

Este script está también disponible para su descarga online@footnote{https://gist.github.com/vsajip/4673395}.

@node zipapp — Manage executable Python zip archives,,venv — Creation of virtual environments,Empaquetado y distribución de software
@anchor{library/zipapp doc}@anchor{4254}@anchor{library/zipapp module-zipapp}@anchor{12f}@anchor{library/zipapp zipapp-manage-executable-python-zip-archives}@anchor{4255}
@subsection @code{zipapp} — Manage executable Python zip archives


@geindex module; zipapp


Added in version 3.5.


`Código fuente:' Lib/zipapp.py@footnote{https://github.com/python/cpython/tree/main/Lib/zipapp.py}

@geindex Archivos Zip Ejecutables


__________________________________________________________________


Este módulo provee herramientas para administrar la creación de archivos zip que contengan código Python, los que pueden ser @ref{1d2f,,ejecutados directamente por el intérprete de Python}. El módulo provee tanto una @ref{4256,,Interfaz de línea de comando} y una @ref{4257,,API de Python}.

@menu
* Ejemplo básico:: 
* Interfaz de línea de comando:: 
* API de Python:: 
* Ejemplos: Ejemplos<30>. 
* Especificar el intérprete:: 
* Creando aplicaciones independientes con zipapp:: 
* El formato de archivado Zip de aplicaciones Python:: 

@end menu

@node Ejemplo básico,Interfaz de línea de comando,,zipapp — Manage executable Python zip archives
@anchor{library/zipapp basic-example}@anchor{4258}
@subsubsection Ejemplo básico


El siguiente ejemplo muestra cómo la @ref{4256,,Interfaz de línea de comando} puede utilizarse para crear un archivador ejecutable de un directorio que contenga código en Python. Al ponerse en funcionamiento, el archivador ejecutará la función @code{main} del módulo @code{myapp} en el archivador.

@example
$ python -m zipapp myapp -m "myapp:main"
$ python myapp.pyz
<output from myapp>
@end example

@node Interfaz de línea de comando,API de Python,Ejemplo básico,zipapp — Manage executable Python zip archives
@anchor{library/zipapp command-line-interface}@anchor{4259}@anchor{library/zipapp zipapp-command-line-interface}@anchor{4256}
@subsubsection Interfaz de línea de comando


En la ejecución como programa desde la línea de comandos, se utiliza el siguiente formato:

@example
$ python -m zipapp source [options]
@end example

Si `source' es un directorio, se creará un archivador zip para los contenidos de `source'. Si `source' es un archivo, debería ser un archivador, y se copiará al archivador de destino (o los contenidos de su línea `shebang' se mostrarán si se especifica la opción –info).

Se aceptan las siguientes opciones:

@geindex opción de línea de comando zipapp; -o
@geindex opción de línea de comando zipapp; --output
@anchor{library/zipapp cmdoption-zipapp-o}@anchor{425a}@anchor{library/zipapp cmdoption-zipapp-output}@anchor{425b}
@deffn {Option} @w{-}o <output>, @w{-}@w{-}output=<output>

Escribe la salida a un archivo llamado `output'. Si esta opción no está especificada, el nombre del archivo de salida será el mismo que la entrada `source', con la extensión @code{.pyz} agregada. Si se provee de un nombre de archivo explícito, se usa tal como está (por lo que una extensión @code{.pyz} debería incluirse si esto se requiere).

Un nombre de archivo de salida debe especificarse si `source' es un archivador (y en ese caso, `output' no debería ser igual que `source').
@end deffn

@geindex opción de línea de comando zipapp; -p
@geindex opción de línea de comando zipapp; --python
@anchor{library/zipapp cmdoption-zipapp-p}@anchor{425c}@anchor{library/zipapp cmdoption-zipapp-python}@anchor{425d}
@deffn {Option} @w{-}p <interpreter>, @w{-}@w{-}python=<interpreter>

Agrega una línea @code{#!} al archivador especificando `interpreter' como comando a ejecutar. También en POSIX, convierte al archivador en ejecutable. La opción por defecto es no escribir una línea @code{#!}, y no hacer que el archivo sea ejecutable.
@end deffn

@geindex opción de línea de comando zipapp; -m
@geindex opción de línea de comando zipapp; --main
@anchor{library/zipapp cmdoption-zipapp-m}@anchor{425e}@anchor{library/zipapp cmdoption-zipapp-main}@anchor{425f}
@deffn {Option} @w{-}m <mainfn>, @w{-}@w{-}main=<mainfn>

Escribe un archivo @code{__main__.py} en el archivador que ejecuta `mainfn'.  El argumento `mainfn' debería tener la forma «pkg.mod:fn», donde «pkg.mod» is un paquete/módulo en el archivador, y «fn» es un invocable (`callable') en ese módulo. El archivo @code{__main__.py} ejecutará ese invocable.

@ref{425e,,--main} no puede especificarse al copiar un archivador.
@end deffn

@geindex opción de línea de comando zipapp; -c
@geindex opción de línea de comando zipapp; --compress
@anchor{library/zipapp cmdoption-zipapp-c}@anchor{4260}@anchor{library/zipapp cmdoption-zipapp-compress}@anchor{4261}
@deffn {Option} @w{-}c, @w{-}@w{-}compress

Comprime los archivos con el método `deflate', lo que reduce el tamaño del archivo de salida. Por defecto, los archivos se guardan sin comprimir en el archivador.

@ref{4260,,--compress} no surte efecto al copiar un archivador.


Added in version 3.7.

@end deffn

@geindex opción de línea de comando zipapp; --info
@anchor{library/zipapp cmdoption-zipapp-info}@anchor{4262}
@deffn {Option} @w{-}@w{-}info

Muestra el intérprete incrustado en el archivador, para diagnósticos. En este caso cualquier otra opción se ignora, y SOURCE debe ser un archivador, no un directorio.
@end deffn

@geindex opción de línea de comando zipapp; -h
@geindex opción de línea de comando zipapp; --help
@anchor{library/zipapp cmdoption-zipapp-h}@anchor{4263}@anchor{library/zipapp cmdoption-zipapp-help}@anchor{4264}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Muestra un breve mensaje sobre el modo de uso, y sale.
@end deffn

@node API de Python,Ejemplos<30>,Interfaz de línea de comando,zipapp — Manage executable Python zip archives
@anchor{library/zipapp python-api}@anchor{4265}@anchor{library/zipapp zipapp-python-api}@anchor{4257}
@subsubsection API de Python


El módulo define dos funciones convenientes:

@geindex create_archive() (en el módulo zipapp)
@anchor{library/zipapp zipapp create_archive}@anchor{c38}
@deffn {Función} zipapp.create_archive (source, target=None, interpreter=None, main=None, filter=None, compressed=False)

Crea un archivador de aplicación a partir de `source'. Este `source' (origen), puede ser cualquiera de los siguientes:


@itemize *

@item 
El nombre de un directorio, o un @ref{3f0,,path-like object} que se refiera a un directorio, en cuyo caso un nuevo archivador de aplicación se creará a partir del contenido de dicho directorio.

@item 
El nombre de un archivador de aplicación existente o un  @ref{3f0,,path-like object} que refiera a dicho archivo, en cuyo caso el archivo se copiará al destino (modificándolo para reflejar el valor dado por el argumento `interpreter'. El nombre de archivo debería incluir la extensión @code{.pyz}, si se requiere.

@item 
Un objeto archivo abierto para lectura en modo bytes. El contenido del archivo debería ser un archivador de aplicación. Se infiere que el objeto archivo está posicionado al comienzo del archivador.
@end itemize

El argumento `target' determina dónde quedará escrito el archivador resultante:


@itemize *

@item 
Si es el nombre de un archivo, o un @ref{3f0,,path-like object}, el archivador será escrito a ese archivo.

@item 
Si es un objeto archivo abierto, el archivador se escribirá en ese objeto archivo, el cual debe estar abierto para escritura en modo bytes.

@item 
Si el destino (`target') se omite (o es @code{None}), el origen (`source') debe ser un directorio, y el destino será un archivo con el mismo nombre que el origen, con la extensión @code{.pyz} añadida.
@end itemize

El argumento `interpreter' especifica el nombre del intérprete Python con el que el archivador será ejecutado. Se escribe como una línea `«shebang»' al comienzo del archivador. En POSIX, el Sistema Operativo será quien lo interprete, y en Windows será gestionado por el lanzador Python. Omitir el `interpreter' tendrá como consecuencia que no se escribirá ninguna línea `shebang'. Si se especifica un intérprete y el destino (`target') es un nombre de archivo, el bit de ejecución del archivo destino será activado.

El argumento `main' especifica el nombre de un invocable (`callable') que se utilizará como programa principal para el archivador. Solamente se puede especificar si el origen (`source') es un directorio que no contiene un archivo @code{__main__.py}. El argumento `main' debería tener la forma «pkg.module:callable», y el archivador será ejecutado importando «pkg.module» y ejecutando el `callable' sin argumentos. Es un error omitir `main' si el origen es un directorio que no contiene un archivo @code{__main__.py}, ya que esto resultaría en un archivador no ejecutable.

El argumento opcional `filter' especifica una función `callback' que se pasa como objeto Path, para representar el `path' (ruta) al archivo que se está añadiendo (ruta relativa al directorio origen, `source'). Debería retornar @code{True} si el archivo será añadido.

El argumento opcional `compressed' determina si los archivos están comprimidos. Si se define como @code{True}, los archivos en el archivador serán comprimidos con el método deflate.

Si se especifica un objeto archivo  para `source' o `target', es responsabilidad de quien invoca cerrarlo luego de invocar a create_archive.

Al copiar un archivador existente, los objetos archivo provistos, solamente necesitan los métodos @code{read} y @code{readline}, o bien @code{write}. Al crear un archivador a partir de un directorio, si el destino (`target') es un objeto archivo, éste se pasará a la clase @code{zipfile.ZipFile}, y debe proveer los métodos que esa clase necesita.


Distinto en la versión 3.7: Added the `filter' and `compressed' parameters.

@end deffn

@geindex get_interpreter() (en el módulo zipapp)
@anchor{library/zipapp zipapp get_interpreter}@anchor{4266}
@deffn {Función} zipapp.get_interpreter (archive)

Retorna el intérprete especificado en la línea @code{#!} al comienzo del archivador. Si no hay línea @code{#!}, retorna @ref{716,,None}. El argumento `archive' (archivador), puede ser un nombre de archivo o un objeto tipo archivo abierto para lectura en modo bytes. Se supone que está al principio del archivador.
@end deffn

@node Ejemplos<30>,Especificar el intérprete,API de Python,zipapp — Manage executable Python zip archives
@anchor{library/zipapp examples}@anchor{4267}@anchor{library/zipapp zipapp-examples}@anchor{4268}
@subsubsection Ejemplos


Empaqueta un directorio en un archivador, y lo ejecuta.

@example
$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>
@end example

Lo mismo puede lograrse utilizando la función @ref{c38,,create_archive()}:

@example
>>> import zipapp
>>> zipapp.create_archive('myapp', 'myapp.pyz')
@end example

Para que la aplicación sea ejecutable directamente en POSIX, especifica un intérprete.

@example
$ python -m zipapp myapp -p "/usr/bin/env python"
$ ./myapp.pyz
<output from myapp>
@end example

Para reemplazar la línea `shebang' en un archivador existente, cree un archivador modificado, utilizando la función @ref{c38,,create_archive()}:

@example
>>> import zipapp
>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')
@end example

Para actualizar el archivo en el lugar, reemplaza en memoria utilizando un objeto @ref{f25,,BytesIO}, y luego sobreescribe el origen (`source'). Nótese que hay un riesgo al sobreescribir un archivo en el lugar, ya que un error resultará en la pérdida del archivo original. Este código no ofrece protección contra este tipo de errores, pero los códigos de producción deberían hacerlo. Además, este método solamente funcionará si el archivador cabe en la memoria:

@example
>>> import zipapp
>>> import io
>>> temp = io.BytesIO()
>>> zipapp.create_archive('myapp.pyz', temp, '/usr/bin/python2')
>>> with open('myapp.pyz', 'wb') as f:
>>>     f.write(temp.getvalue())
@end example

@node Especificar el intérprete,Creando aplicaciones independientes con zipapp,Ejemplos<30>,zipapp — Manage executable Python zip archives
@anchor{library/zipapp specifying-the-interpreter}@anchor{4269}@anchor{library/zipapp zipapp-specifying-the-interpreter}@anchor{426a}
@subsubsection Especificar el intérprete


Nótese que si se especifica el intérprete y luego se distribuye el archivador de aplicación, es necesario asegurarse de que el intérprete utilizado es portable. El lanzador Python para Windows soporta las formas más comunes de líneas @code{#!} POSIX, pero hay otras cuestiones a considerar:


@itemize *

@item 
Si se utiliza «/usr/bin/env python» (u otras formas del comando «python», como «/usr/bin/python»), es necesario considerar que los usuarios quizá tengan tanto Python2 como Python3 como versión por defecto, y el código debe escribirse bajo ambas versiones.

@item 
Si se utiliza una versión específica, por ejemplo «/usr/bin/env python3», la aplicación no funcionará para los usuarios que no tengan esa versión.  (Esta puede ser la opción deseada si no se hecho el código compatible con Python 2).

@item 
No hay manera de decir «python X.Y o posterior», así que se debe ser cuidadoso al utilizar una versión exacta, tal como «/usr/bin/env python3.4», ya que será necesario cambiar la línea `shebang' para usuarios de Python 3.5, por ejemplo.
@end itemize

Normalmente, se debería utilizar  «/usr/bin/env python2» o «/usr/bin/env python3», según si el código está escrito para Python 2 ó 3.

@node Creando aplicaciones independientes con zipapp,El formato de archivado Zip de aplicaciones Python,Especificar el intérprete,zipapp — Manage executable Python zip archives
@anchor{library/zipapp creating-standalone-applications-with-zipapp}@anchor{426b}
@subsubsection Creando aplicaciones independientes con zipapp


Utilizando el módulo @ref{12f,,zipapp}, es posible crear programas Python auto-contenidos, que pueden ser distribuidos a usuarios finales que solo necesitarán una versión adecuada de Python instalada en sus sistemas. La clave es empaquetar todas las dependencias de la aplicación dentro del archivador, junto al código de la misma.

Los pasos para crear un archivador independiente son los siguientes:


@enumerate 

@item 
Crea tu aplicación en un directorio normalmente, tal que tengas una directorio @code{myapp} que contenga un archivo @code{__main__.py}, y cualquier código extra de la aplicación.

@item 
Instala todas las dependencias de la aplicación en el directorio @code{myapp}, usando pip:

@example
$ python -m pip install -r requirements.txt --target myapp
@end example

(se supone que tienes los requisitos de tu proyecto en un archivo @code{requirements.txt}, de lo contrario, puedes listar manualmente las dependencias en la línea de comandos de pip).

@item 
Empaqueta la aplicación utilizando:

@example
$ python -m zipapp -p "interpreter" myapp
@end example
@end enumerate

Esto producirá un ejecutable independiente, que puede ser ejecutado en cualquier máquina que disponga del intérprete apropiado. Véase @ref{426a,,Especificar el intérprete} para más detalles. Puede enviarse a los usuarios como un solo archivo.

En Unix, el archivo @code{myapp.pyz} será ejecutable tal como está. Puede ser renombrado, para quitar la extensión @code{.pyz} si se prefiere un nombre de comando «simple». En Windows, el archivo @code{myapp.pyz[w]} es ejecutable, ya que el intérprete Python registra las extensiones @code{.pyz} y @code{pyzw} al ser instalado.

@menu
* Advertencias: Advertencias<3>. 

@end menu

@node Advertencias<3>,,,Creando aplicaciones independientes con zipapp
@anchor{library/zipapp caveats}@anchor{426c}
@subsubsection Advertencias


Si la aplicación depende de un paquete que incluye una extensión C, ese paquete no puede ser ejecutado desde un archivo zip (esta es una limitación del sistema operativo, dado que el código ejecutable debe estar presente en el sistema de archivos para que el `loader' del SO lo pueda cargar). En este caso, se puede excluir la dependencia del archivo zip, y requerir que los usuarios la tengan instalada, o bien distribuirla conjuntamente con el archivo zip, y agregar código al @code{__main__.py} para que incluya el directorio que contiene el módulo descomprimido en @code{sys.path}. En este caso, será necesario asegurarse de distribuir los binarios adecuados para la/s arquitectura/s a las que esté destinada la aplicación (y potencialmente elegir la versión correcta para agregar a @code{sys.path} en tiempo de ejecución, basándose en la máquina del usuario).

@node El formato de archivado Zip de aplicaciones Python,,Creando aplicaciones independientes con zipapp,zipapp — Manage executable Python zip archives
@anchor{library/zipapp the-python-zip-application-archive-format}@anchor{426d}
@subsubsection El formato de archivado Zip de aplicaciones Python


Python puede ejecutar archivadores zip que contengan un archivo @code{__main__.py} desde la versión 2.6. Para que sea ejecutada por Python, basta con que una aplicación de archivador sea un archivo zip estándar que contenga un archivo @code{__main__.py}, el cual será ejecutado como punto de entrada para la aplicación. Como es usual para cualquier script Python, el elemento padre del script (en este caso, el archivo zip), será ubicado en @ref{27e,,sys.path}, por lo que pueden importarse otros módulos desde el archivo zip.

El formato de archivo zip, permite que se antepongan al archivo datos arbitrarios. El formato de aplicación zip utiliza esta capacidad para anteponer una línea «`shebang'» POSIX estándar al archivo (@code{#!/ruta/al/interprete}).

Formalmente, el Formato de archivado Zip de aplicaciones Python es:


@enumerate 

@item 
An optional shebang line, containing the characters @code{b'#!'} followed by an
interpreter name, and then a newline (@code{b'\n'}) character.  The interpreter
name can be anything acceptable to the OS «shebang» processing, or the Python
launcher on Windows.  The interpreter should be encoded in UTF-8 on Windows,
and in @ref{ce1,,sys.getfilesystemencoding()} on POSIX.

@item 
Los datos estándares de archivo zip, tal como se generan en el módulo @ref{130,,zipfile}. El contenido del archivo zip `debe' incluir un archivo llamado @code{__main__.py} (que debe estar en la «raíz» del archivo zip, es decir, no puede estar en un subdirectorio). El los datos del archivo zip pueden estar comprimidos o no.
@end enumerate

Si un archivador de aplicación tiene una línea de shebang, puede tener el bit de ejecución activado en los sistemas POSIX, para permitir que sea ejecutado directamente.

No se requiere que las herramientas de este módulo sean las que se utilicen para crear archivadores de aplicación. El módulo es útil, pero cualquier archivo que esté en el formato descripto anteriormente es aceptable para Python, no importa cómo haya sido creado.

@node Servicios en tiempo de ejecución de Python,Intérpretes de Python personalizados,Empaquetado y distribución de software,La biblioteca estándar de Python
@anchor{library/python doc}@anchor{426e}@anchor{library/python python}@anchor{426f}@anchor{library/python python-runtime-services}@anchor{4270}
@section Servicios en tiempo de ejecución de Python


Los módulos descritos en este capítulo proporcionan una amplia gama de servicios relacionados con el intérprete de Python y su interacción con su entorno.  Esta es una descripción general:

@menu
* sys — System-specific parameters and functions:: 
* sys.monitoring — Execution event monitoring: sys monitoring — Execution event monitoring. 
* sysconfig — Provide access to Python’s configuration information:: 
* builtins — Built-in objects:: 
* __main__ — Top-level code environment:: 
* warnings — Warning control:: 
* dataclasses — Data Classes:: 
* contextlib — Utilidades para declaraciones de contexto with:: 
* abc — Abstract Base Classes:: 
* atexit — Exit handlers:: 
* traceback — Print or retrieve a stack traceback:: 
* __future__ — Future statement definitions:: 
* gc — Garbage Collector interface:: 
* inspect — Inspect live objects:: 
* annotationlib — Functionality for introspecting annotations:: 
* site — Site-specific configuration hook:: 

@end menu

@node sys — System-specific parameters and functions,sys monitoring — Execution event monitoring,,Servicios en tiempo de ejecución de Python
@anchor{library/sys doc}@anchor{4271}@anchor{library/sys module-sys}@anchor{d9}@anchor{library/sys sys-system-specific-parameters-and-functions}@anchor{4272}
@subsection @code{sys} — System-specific parameters and functions


@geindex module; sys


__________________________________________________________________


Este módulo provee acceso a algunas variables usadas o mantenidas por el intérprete y a funciones que interactúan fuertemente con el intérprete. Siempre está disponible.

@geindex abiflags (en el módulo sys)
@anchor{library/sys sys abiflags}@anchor{af4}
@deffn {Dato} sys.abiflags

En los sistemas POSIX donde Python se construyó con el script estándar @code{configure}, este contiene los indicadores ABI según lo especificado por 
@geindex Python Enhancement Proposals; PEP 3149
PEP 3149@footnote{https://peps.python.org/pep-3149/}.


Added in version 3.2.



Distinto en la versión 3.8: Los flags por defecto se convirtieron en una cadena de caracteres vacía (el flag @code{m} para pymalloc ha sido eliminado).


@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex addaudithook() (en el módulo sys)
@anchor{library/sys sys addaudithook}@anchor{4102}
@deffn {Función} sys.addaudithook (hook)

Agrega el `hook' invocable a la lista de enlaces de inspección activos para el (sub)intérprete actual.

Cuando se genera un evento de auditoría a través de la función @ref{15af,,sys.audit()}, cada hook será llamado en el orden en que se agregó con el nombre del evento y la tupla de argumentos. Los hooks nativos agregados por @ref{4103,,PySys_AddAuditHook()} se llaman primero, seguidos de los hooks agregados en el (sub)intérprete actual. Los hooks pueden registrar un evento, lanzar una excepción para abortar la operación, o terminar el proceso completamente.

Tenga en cuenta que los ganchos de auditoría son principalmente para recopilar información sobre acciones internas o no observables, ya sea por Python o bibliotecas escritas en Python. No son adecuados para implementar una «caja de arena» (sandbox). En particular, el código malicioso puede desactivar o eludir trivialmente los hooks añadidos mediante esta función. Como mínimo, cualquier hook sensible a la seguridad debe añadirse utilizando la API de C @ref{4103,,PySys_AddAuditHook()} antes de inicializar el tiempo de ejecución, y cualquier módulo que permita la modificación arbitraria de la memoria (como @ref{2b,,ctypes}) debe ser completamente eliminado o supervisado de cerca.

Llamar @ref{4102,,sys.addaudithook()} lanzará por si mismo un evento de auditoria llamado @code{sys.addaudithook} sin argumentos. Si uno de los hooks existentes lanza un excepción derivada de @ref{1e5,,RuntimeError}, el nuevo hook no será agregado y la excepción será suprimida. Como resultado, los que llaman no podrán asumir que el hook a sido agregado a menos que ellos controlen todos los hooks existentes.

Consulte la @ref{1878,,tabla de eventos de auditoría} para todos los eventos lanzados por CPython, y 
@geindex Python Enhancement Proposals; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para discusión del diseño original.


Added in version 3.8.



Distinto en la versión 3.8.1: Las excepciones derivadas de @ref{a6b,,Exception} pero no @ref{1e5,,RuntimeError} ya no se suprimen.


`Detalles de implementación de CPython:' Cuando el rastreo está habilitado (ver @ref{1540,,settrace()}), los ganchos de Python solo se rastrean si el invocable tiene un miembro @code{__cantrace__} que se establece en un valor verdadero. De lo contrario, las funciones de seguimiento omitirán el enlace.
@end deffn

@geindex argv (en el módulo sys)
@anchor{library/sys sys argv}@anchor{12d2}
@deffn {Dato} sys.argv

La lista de argumentos de la línea de comandos pasados a un script de Python. @code{argv[0]} es el nombre del script (depende del sistema operativo si se trata de una ruta completa o no). Si el comando se ejecutó usando la opción @ref{681,,-c} de la línea de comandos del intérprete, @code{argv[0]} se establece en la cadena de caracteres @code{'-c'}. Si no se pasó ningún nombre de secuencia de comandos al intérprete de Python, @code{argv[0]} es la cadena de caracteres vacía.

Para recorrer la entrada estándar, o la lista de archivos dada en la línea de comando, vea el módulo @ref{5b,,fileinput}.

También ver @ref{8d7,,sys.orig_argv}.

@cartouche
@quotation Nota 
En Unix, los argumentos de la línea de comandos se pasan por bytes desde el sistema operativo. Python los decodifica con la codificación del sistema de archivos y el controlador de errores «surrogateescape». Cuando necesite bytes originales, puede obtenerlos mediante @code{[os.fsencode (arg) for arg in sys.argv]}.
@end quotation
@end cartouche
@end deffn

@geindex audit() (en el módulo sys)
@anchor{library/sys auditing}@anchor{18c3}@anchor{library/sys sys audit}@anchor{15af}
@deffn {Función} sys.audit (event, *args)

@geindex auditoría

Activar un evento de auditoría y activar cualquier hook de auditoría activo. `event' es una cadena que identifica el evento, y `args' puede contener argumentos opcionales con más información sobre el evento.  El número y los tipos de argumentos para un evento determinado se consideran una API pública y estable y no deberían modificarse entre versiones.

Por ejemplo, un evento de auditoría se llama @code{os.chdir}. Este evento tiene un argumento llamado `path' que contendrá el nuevo directorio de trabajo solicitado.

@ref{15af,,sys.audit()} llamará a los ganchos de auditoría existentes, pasando el nombre del evento y los argumentos, y volverá a lanzar la primera excepción de cualquier hook. En general, si se lanza una excepción, no debería ser manejada y el proceso debería terminar lo más rápidamente posible. Esto permite que las implementaciones de los hook decidan cómo responder a determinados eventos: pueden limitarse a registrar el evento o abortar la operación lanzando una excepción.

Los ganchos se agregan usando las funciones @ref{4102,,sys.addaudithook()} o @ref{4103,,PySys_AddAuditHook()}.

El equivalente nativo de esta función es @ref{463,,PySys_Audit()}. Se prefiere usar la función nativa cuando sea posible.

Consulte la @ref{1878,,tabla de eventos de auditoría} para todos los eventos lanzados por CPython.


Added in version 3.8.

@end deffn

@geindex base_exec_prefix (en el módulo sys)
@anchor{library/sys sys base_exec_prefix}@anchor{27b}
@deffn {Dato} sys.base_exec_prefix

Se establece durante el inicio de Python, antes de que se ejecute @code{site.py}, en el mismo valor que @ref{27c,,exec_prefix}. Si no se ejecuta en un @ref{4245,,entorno virtual}, los valores permanecerán iguales; Si @code{site.py} encuentra que se está utilizando un entorno virtual, los valores de @ref{281,,prefix} y @ref{27c,,exec_prefix} se cambiarán para apuntar al entorno virtual, mientras que @ref{280,,base_prefix} y @ref{27b,,base_exec_prefix} seguirá apuntando a la instalación base de Python (aquella desde la que se creó el entorno virtual).


Added in version 3.3.

@end deffn

@geindex base_prefix (en el módulo sys)
@anchor{library/sys sys base_prefix}@anchor{280}
@deffn {Dato} sys.base_prefix

Se establece durante el inicio de Python, antes de que se ejecute @code{site.py}, al mismo valor que @ref{281,,prefix}. Si no se ejecuta en un @ref{4245,,entorno virtual}, los valores permanecerán iguales; si @code{site.py} encuentra que se está utilizando un entorno virtual, los valores de @ref{281,,prefix} y @ref{27c,,exec_prefix} se cambiarán para apuntar al entorno virtual, mientras que @ref{280,,base_prefix} y @ref{27b,,base_exec_prefix} seguirá apuntando a la instalación base de Python (aquella desde la que se creó el entorno virtual).


Added in version 3.3.

@end deffn

@geindex byteorder (en el módulo sys)
@anchor{library/sys sys byteorder}@anchor{21a3}
@deffn {Dato} sys.byteorder

Un indicador del orden de bytes nativo. Esto tendrá el valor @code{'big'} en las plataformas big-endian (el byte más significativo primero) y @code{'little'} en las plataformas little-endian (el byte menos significativo primero).
@end deffn

@geindex builtin_module_names (en el módulo sys)
@anchor{library/sys sys builtin_module_names}@anchor{1c66}
@deffn {Dato} sys.builtin_module_names

Una tupla de cadenas de caracteres que contiene los nombres de todos los módulos que se compilan en este intérprete de Python. (Esta información no está disponible de ninguna otra manera — @code{modules.keys()} solo enumera los módulos importados.)

Consulte también la lista @ref{8d8,,sys.stdlib_module_names}.
@end deffn

@geindex call_tracing() (en el módulo sys)
@anchor{library/sys sys call_tracing}@anchor{1839}
@deffn {Función} sys.call_tracing (func, args)

Call @code{func(*args)}, while tracing is enabled.  The tracing state is saved,
and restored afterwards.  This is intended to be called from a debugger from
a checkpoint, to recursively debug or profile some other code.

Tracing is suspended while calling a tracing function set by
@ref{1540,,settrace()} or @ref{153f,,setprofile()} to avoid infinite recursion.
@code{call_tracing()} enables explicit recursion of the tracing function.
@end deffn

@geindex copyright (en el módulo sys)
@anchor{library/sys sys copyright}@anchor{4273}
@deffn {Dato} sys.copyright

Una cadena de caracteres que contiene los derechos de autor pertenecientes al intérprete de Python.
@end deffn

@geindex _clear_type_cache() (en el módulo sys)
@anchor{library/sys sys _clear_type_cache}@anchor{167c}
@deffn {Función} sys._clear_type_cache ()

Borre la caché de tipo interno. La caché de tipos se utiliza para acelerar las búsquedas de métodos y atributos. Utilice la función `solo' para eliminar referencias innecesarias durante la depuración de fugas de referencia.

Esta función debe usarse solo para fines internos y especializados.


Obsoleto desde la versión 3.13: Use the more general @ref{167b,,_clear_internal_caches()} function instead.

@end deffn

@geindex _clear_internal_caches() (en el módulo sys)
@anchor{library/sys sys _clear_internal_caches}@anchor{167b}
@deffn {Función} sys._clear_internal_caches ()

Clear all internal performance-related caches. Use this function `only' to
release unnecessary references and memory blocks when hunting for leaks.


Added in version 3.13.

@end deffn

@geindex _current_frames() (en el módulo sys)
@anchor{library/sys sys _current_frames}@anchor{1472}
@deffn {Función} sys._current_frames ()

Retorna un diccionario que asigna el identificador de cada subproceso al marco de pila superior actualmente activo en ese subproceso en el momento en que se llama a la función. Tenga en cuenta que las funciones en el módulo @ref{fe,,traceback} pueden construir la pila de llamadas dado tal marco.

Esto es más útil para depurar `deadlock': esta función no requiere la cooperación de los subprocesos con `deadlock', y las pilas de llamadas de dichos subprocesos se congelan mientras permanezcan en `deadlock'. El marco retornado para un subproceso no en `deadlock' puede no tener relación con la actividad actual de ese subproceso en el momento en que el código de llamada examina el marco.

Esta función debe usarse solo para fines internos y especializados.

Lanza un @ref{18c3,,auditing event} @code{sys._current_frames} sin argumentos.
@end deffn

@geindex _current_exceptions() (en el módulo sys)
@anchor{library/sys sys _current_exceptions}@anchor{569}
@deffn {Función} sys._current_exceptions ()

Retorna un diccionario que mapea el identificador de cada hilo a la excepción mas alta actualmente activa en ese hilo en el tiempo que la función fue llamada. Si un hilo no esta manejando una excepción en el momento, no se incluye en el resultado del diccionario.

Esto es más útil para la elaboración de perfiles estadísticos.

Esta función debe usarse solo para fines internos y especializados.

Lanza un @ref{18c3,,auditing event} @code{sys._current_exceptions} sin argumentos.


Distinto en la versión 3.12: Cada valor del diccionario es ahora una única instancia de excepción, en lugar de una tripleta como la devuelta por @code{sys.exc_info()}.

@end deffn

@geindex breakpointhook() (en el módulo sys)
@anchor{library/sys sys breakpointhook}@anchor{b65}
@deffn {Función} sys.breakpointhook ()

Esta función de gancho es llamada por built-in @ref{1a6,,breakpoint()}. De forma predeterminada, lo coloca en el depurador @ref{a5,,pdb}, pero se puede configurar en cualquier otra función para que pueda elegir qué depurador se utiliza.

La firma de esta función depende de lo que llame. Por ejemplo, el enlace predeterminado (por ejemplo, @code{pdb.set_trace()}) no espera argumentos, pero puede vincularlo a una función que espera argumentos adicionales (posicional o palabra clave). La función incorporada @code{breakpoint()} pasa sus @code{*args} y @code{**kws} directamente. Lo que sea que retorne @code{breakpointhooks()} se retorna desde @code{breakpoint()}.

La implementación predeterminada consulta primero la variable de entorno 
@geindex PYTHONBREAKPOINT
@geindex variables de entorno; PYTHONBREAKPOINT
@ref{b66,,PYTHONBREAKPOINT}. Si se establece en @code{"0"}, esta función vuelve inmediatamente; es decir, no es una operación. Si la variable de entorno no se establece, o se establece en la cadena vacía, se llama a @code{pdb.set_trace()}. De lo contrario, esta variable debería nombrar una función para ejecutar, utilizando la nomenclatura de importación con puntos de Python, por ejemplo @code{package.subpackage.module.function}. En este caso, se importaría @code{package.subpackage.module} y el módulo resultante debe tener un invocable llamado @code{function()}. Esto se ejecuta, pasando @code{*args} y @code{**kws}, y lo que sea que @code{function()} retorna, @code{sys.breakpointhook()} retorna a la función @ref{1a6,,breakpoint()}.

Tenga en cuenta que si algo sale mal al importar el invocable nombrado por 
@geindex PYTHONBREAKPOINT
@geindex variables de entorno; PYTHONBREAKPOINT
@ref{b66,,PYTHONBREAKPOINT}, se informa un @ref{323,,RuntimeWarning} y se ignora el punto de interrupción (`breakpoint').

También tenga en cuenta que si @code{sys.breakpointhook()} se anula mediante programación, 
@geindex PYTHONBREAKPOINT
@geindex variables de entorno; PYTHONBREAKPOINT
@ref{b66,,PYTHONBREAKPOINT} `no' se consulta.


Added in version 3.7.

@end deffn

@geindex _debugmallocstats() (en el módulo sys)
@anchor{library/sys sys _debugmallocstats}@anchor{4274}
@deffn {Función} sys._debugmallocstats ()

Imprime información de bajo nivel para stderr sobre el estado del asignador de memoria de CPython.

Si Python es @ref{357,,built in debug mode} (@ref{4e0,,configure --with-pydebug option}), también realiza algunas costosas comprobaciones de coherencia interna.


Added in version 3.3.


`Detalles de implementación de CPython:' Esta función es específica de CPython. El formato exacto de salida no se define aquí y puede cambiar.
@end deffn

@geindex dllhandle (en el módulo sys)
@anchor{library/sys sys dllhandle}@anchor{4275}
@deffn {Dato} sys.dllhandle

Número entero que especifica el identificador de la DLL de Python.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex displayhook() (en el módulo sys)
@anchor{library/sys sys displayhook}@anchor{1560}
@deffn {Función} sys.displayhook (value)

Si `value' no es @code{None}, esta función imprime @code{repr(value)} en @code{sys.stdout} y guarda `value' en @code{builtins._}. Si @code{repr(value)} no se puede codificar en @code{sys.stdout.encoding} con el controlador de errores @code{sys.stdout.errors} (que probablemente sea @code{'strict'}), codifíquelo para @code{sys.stdout.encoding} con el controlador de errores @code{'backslashreplace'}.

Se llama a @code{sys.displayhook} como resultado de evaluar un @ref{1f85,,expression} ingresado en una sesión interactiva de Python. La visualización de estos valores se puede personalizar asignando otra función de un argumento a @code{sys.displayhook}.

Pseudo-código:

@example
def displayhook(value):
    if value is None:
        return
    # Set '_' to None to avoid recursion
    builtins._ = None
    text = repr(value)
    try:
        sys.stdout.write(text)
    except UnicodeEncodeError:
        bytes = text.encode(sys.stdout.encoding, 'backslashreplace')
        if hasattr(sys.stdout, 'buffer'):
            sys.stdout.buffer.write(bytes)
        else:
            text = bytes.decode(sys.stdout.encoding, 'strict')
            sys.stdout.write(text)
    sys.stdout.write("\n")
    builtins._ = value
@end example


Distinto en la versión 3.2: Usa el manejador de error @code{'backslashreplace'} en @ref{718,,UnicodeEncodeError}.

@end deffn

@geindex dont_write_bytecode (en el módulo sys)
@anchor{library/sys sys dont_write_bytecode}@anchor{4276}
@deffn {Dato} sys.dont_write_bytecode

Si esto es cierto, Python no intentará escribir archivos @code{.pyc} en la importación de módulos fuente. Este valor se establece inicialmente en @code{True} o @code{False} según la opción @ref{140d,,-B} de la línea de comando y la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE}, pero puede configurarlo usted mismo para controlar el código de bytes generación de archivos.
@end deffn

@geindex _emscripten_info (en el módulo sys)
@anchor{library/sys sys _emscripten_info}@anchor{1808}
@deffn {Dato} sys._emscripten_info

Un @ref{6ef,,named tuple} que contiene información sobre el medio ambiente en la plataforma `wasm32-emscripten'. La tupla nombrada es provisional y puede cambiar en el futuro.

@geindex emscripten_version (atributo de sys._emscripten_info)
@anchor{library/sys sys _emscripten_info emscripten_version}@anchor{4277}
@deffn {Atributo} _emscripten_info.emscripten_version

Versión de Emscripten como tupla de enteros (mayor, menor, micro), por ejemplo @code{(3, 1, 8)}.
@end deffn

@geindex runtime (atributo de sys._emscripten_info)
@anchor{library/sys sys _emscripten_info runtime}@anchor{4278}
@deffn {Atributo} _emscripten_info.runtime

Cadena de tiempo de ejecución, por ejemplo, agente de usuario del navegador, @code{'Node.js v14.18.2'}, o @code{'UNKNOWN'}.
@end deffn

@geindex pthreads (atributo de sys._emscripten_info)
@anchor{library/sys sys _emscripten_info pthreads}@anchor{4279}
@deffn {Atributo} _emscripten_info.pthreads

@code{True} si Python está compilado con soporte para pthreads de Emscripten.
@end deffn

@geindex shared_memory (atributo de sys._emscripten_info)
@anchor{library/sys sys _emscripten_info shared_memory}@anchor{427a}
@deffn {Atributo} _emscripten_info.shared_memory

@code{True} si Python está compilado con soporte de memoria compartida.
@end deffn

@ref{1d5a,,Availability}: Emscripten.


Added in version 3.11.

@end deffn

@geindex pycache_prefix (en el módulo sys)
@anchor{library/sys sys pycache_prefix}@anchor{a36}
@deffn {Dato} sys.pycache_prefix

Si se establece esto (no @code{None}), Python escribirá archivos @code{.pyc} de caché de código de bytes en (y los leerá desde) un árbol de directorios paralelo con raíz en este directorio, en lugar de los directorios @code{__pycache__} en el árbol de código fuente. Se ignorarán todos los directorios @code{__pycache__} en el árbol del código fuente y se escribirán nuevos archivos @code{.pyc} dentro del prefijo de pycache. Por lo tanto, si usa @ref{21,,compileall} como paso previo a la compilación, debe asegurarse de ejecutarlo con el mismo prefijo de pycache (si corresponde) que usará en tiempo de ejecución.

Una ruta relativa se interpreta en relación con el directorio de directorio actual.

Este valor se establece inicialmente en función del valor de la opción de línea de comandos @ref{2e2,,-X} @code{pycache_prefix=PATH} o la variable de entorno 
@geindex PYTHONPYCACHEPREFIX
@geindex variables de entorno; PYTHONPYCACHEPREFIX
@ref{a35,,PYTHONPYCACHEPREFIX} (la línea de comandos tiene prioridad). Si no se establece ninguno, es @code{None}.


Added in version 3.8.

@end deffn

@geindex excepthook() (en el módulo sys)
@anchor{library/sys sys excepthook}@anchor{8a2}
@deffn {Función} sys.excepthook (type, value, traceback)

Esta función imprime un rastreo y una excepción dados a @code{sys.stderr}.

Cuando se genera y no se detecta una excepción distinta de @ref{dc7,,SystemExit}, el intérprete llama a @code{sys.excepthook} con tres argumentos: la clase de excepción, la instancia de excepción y un objeto de rastreo. En una sesión interactiva, esto sucede justo antes de que se devuelva el control al indicador; en un programa Python esto sucede justo antes de que salga el programa. El manejo de dichas excepciones de nivel superior se puede personalizar asignando otra función de tres argumentos a @code{sys.excepthook}.

Genere un evento de auditoría @code{sys.excepthook} con argumentos @code{hook}, @code{type}, @code{value}, @code{traceback} cuando se produzca una excepción no detectada. Si no se ha colocado ningún gancho, @code{hook} puede ser @code{None}. Si algún gancho (`hook') lanza una excepción derivada de @ref{1e5,,RuntimeError}, la llamada al gancho será suprimida. De lo contrario, se informará que la excepción del gancho de auditoría no se puede evaluar y se llamará a @code{sys.excepthook}.


@subsubheading Ver también


La función @ref{355,,sys.unraisablehook()} maneja las excepciones que no se pueden evaluar y la función @ref{8e2,,threading.excepthook()} maneja la excepción lanzada por @ref{acf,,threading.Thread.run()}.

@end deffn

@geindex __breakpointhook__ (en el módulo sys)
@geindex __displayhook__ (en el módulo sys)
@geindex __excepthook__ (en el módulo sys)
@geindex __unraisablehook__ (en el módulo sys)
@anchor{library/sys sys __breakpointhook__}@anchor{427b}
@deffn {Dato} sys.__breakpointhook__
@anchor{library/sys sys __displayhook__}@anchor{427c}
@deffnx {Dato} sys.__displayhook__
@anchor{library/sys sys __excepthook__}@anchor{427d}
@deffnx {Dato} sys.__excepthook__
@anchor{library/sys sys __unraisablehook__}@anchor{427e}
@deffnx {Dato} sys.__unraisablehook__

Estos objetos contienen los valores originales de @code{breakpointhook}, @code{displayhook}, @code{excepthook} y @code{unraisablehook} al inicio del programa. Se guardan para que @code{breakpointhook}, @code{displayhook} y @code{excepthook}, @code{unraisablehook} se puedan restaurar en caso de que sean reemplazados por objetos rotos o alternativos.


Added in version 3.7: __breakpointhook__



Added in version 3.8: __unraisablehook__

@end deffn

@geindex exception() (en el módulo sys)
@anchor{library/sys sys exception}@anchor{72c}
@deffn {Función} sys.exception ()

Esta función, cuando se llama mientras se ejecuta un manejador de excepciones (como una cláusula @code{except} o @code{except*}), retorna la instancia de la excepción que fue capturada por este manejador. Cuando los manejadores de excepciones están anidados unos dentro de otros, sólo la excepción manejada por el manejador más interno es accesible.

Si no se está ejecutando ningún manejador de excepciones, esta función retorna @code{None}.


Added in version 3.11.

@end deffn

@geindex exc_info() (en el módulo sys)
@anchor{library/sys sys exc_info}@anchor{72b}
@deffn {Función} sys.exc_info ()

Esta función retorna la representación de estilo antiguo de la excepción manejada. Si se maneja una excepción @code{e} (por lo que @ref{72c,,exception()} retornaría @code{e}), @ref{72b,,exc_info()} retorna la tupla @code{(type(e), e, e.__traceback__)}. Es decir, una tupla que contiene el tipo de la excepción (una subclase de @ref{65c,,BaseException}), la propia excepción, y un objeto @ref{b7f,,objeto traceback} que suele encapsular la pila de llamadas en el punto en el que se produjo la última excepción.

@geindex objeto;seguimiento

Si no se está manejando ninguna excepción en ninguna parte de la pila, esta función retorna una tupla que contiene tres valores @code{None}.


Distinto en la versión 3.11: Los campos @code{type} y @code{traceback} ahora se derivan del @code{value} (la instancia de excepción), de modo que cuando se modifica una excepción mientras se maneja, los cambios se reflejan en los resultados de las subsiguientes llamadas a @ref{72b,,exc_info()}.

@end deffn

@geindex exec_prefix (en el módulo sys)
@anchor{library/sys sys exec_prefix}@anchor{27c}
@deffn {Dato} sys.exec_prefix

Una cadena de caracteres que proporciona el prefijo de directorio específico del sitio donde están instalados los archivos Python dependientes de la plataforma; de forma predeterminada, también es @code{'/usr/local'}. Esto se puede configurar en el momento de la compilación con el argumento @code{--exec-prefix} del script @code{configure}. Específicamente, todos los archivos de configuración (por ejemplo, el archivo de encabezado @code{pyconfig.h}) se instalan en el directorio @code{`exec_prefix'/lib/python`XY'/config}, y los módulos de la biblioteca compartida se instalan en @code{`exec_prefix'/lib/python`XY'/lib-dynload}, donde `XY' es el número de versión de Python, por ejemplo,`@w{`}3.2`@w{`}.

@cartouche
@quotation Nota 
Si un @ref{4245,,virtual environment} está en efecto, este valor se cambiará en @code{site.py} para apuntar al entorno virtual. El valor para la instalación de Python seguirá estando disponible a través de @ref{27b,,base_exec_prefix}.
@end quotation
@end cartouche
@end deffn

@geindex executable (en el módulo sys)
@anchor{library/sys sys executable}@anchor{283}
@deffn {Dato} sys.executable

Una cadena de caracteres que proporciona la ruta absoluta del binario ejecutable para el intérprete de Python, en sistemas donde esto tiene sentido. Si Python no puede recuperar la ruta real a su ejecutable, @ref{283,,sys.executable} será una cadena de caracteres vacía o @code{None}.
@end deffn

@geindex exit() (en el módulo sys)
@anchor{library/sys sys exit}@anchor{13b0}
@deffn {Función} sys.exit ([arg])

Genera una excepción @ref{dc7,,SystemExit}, indicando la intención de salir del intérprete.

El argumento opcional `arg' puede ser un número entero que dé el estado de salida (por defecto es cero) u otro tipo de objeto. Si es un número entero, cero se considera «terminación exitosa» y cualquier valor distinto de cero se considera «terminación anormal» por los shells y similares. La mayoría de los sistemas requieren que esté en el rango 0-127 y, de lo contrario, producen resultados indefinidos. Algunos sistemas tienen una convención para asignar significados específicos a códigos de salida específicos, pero estos generalmente están subdesarrollados; Los programas Unix generalmente usan 2 para errores de sintaxis de línea de comandos y 1 para todos los demás tipos de errores. Si se pasa otro tipo de objeto, @code{None} equivale a pasar cero, y cualquier otro objeto se imprime en @ref{9cc,,stderr} y da como resultado un código de salida de 1. En particular, @code{sys.exit("algún mensaje de error")} es una forma rápida de salir de un programa cuando ocurre un error.

Dado que @ref{2191,,exit()} en última instancia «sólo» genera una excepción, sólo saldrá del proceso cuando se le llame desde el hilo principal y la excepción no se interceptará. Se respetan las acciones de limpieza especificadas por las cláusulas finalmente de las declaraciones @ref{789,,try} y es posible interceptar el intento de salida en un nivel externo.


Distinto en la versión 3.6: Si se produce un error en la limpieza después de que el intérprete de Python haya detectado @code{SystemSalir} (como un error al vaciar los datos almacenados en el búfer en los flujos estándar), el estado de salida cambia a 120.

@end deffn

@geindex flags (en el módulo sys)
@anchor{library/sys sys flags}@anchor{72d}
@deffn {Dato} sys.flags

El @ref{6ef,,named tuple} `flags' expone el estado de los indicadores de la línea de comando. Los atributos son de solo lectura.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex debug (atributo de sys.flags)
@anchor{library/sys sys flags debug}@anchor{427f}
@deffn {Atributo} flags.debug
@end deffn

@tab

@ref{1d37,,-d}

@item

@geindex inspect (atributo de sys.flags)
@anchor{library/sys sys flags inspect}@anchor{4280}
@deffn {Atributo} flags.inspect
@end deffn

@tab

@ref{151b,,-i}

@item

@geindex interactive (atributo de sys.flags)
@anchor{library/sys sys flags interactive}@anchor{4281}
@deffn {Atributo} flags.interactive
@end deffn

@tab

@ref{151b,,-i}

@item

@geindex isolated (atributo de sys.flags)
@anchor{library/sys sys flags isolated}@anchor{4282}
@deffn {Atributo} flags.isolated
@end deffn

@tab

@ref{9f1,,-I}

@item

@geindex optimize (atributo de sys.flags)
@anchor{library/sys sys flags optimize}@anchor{4283}
@deffn {Atributo} flags.optimize
@end deffn

@tab

@ref{14f,,-O} o @ref{e3b,,-OO}

@item

@geindex dont_write_bytecode (atributo de sys.flags)
@anchor{library/sys sys flags dont_write_bytecode}@anchor{4284}
@deffn {Atributo} flags.dont_write_bytecode
@end deffn

@tab

@ref{140d,,-B}

@item

@geindex no_user_site (atributo de sys.flags)
@anchor{library/sys sys flags no_user_site}@anchor{4285}
@deffn {Atributo} flags.no_user_site
@end deffn

@tab

@ref{13eb,,-s}

@item

@geindex no_site (atributo de sys.flags)
@anchor{library/sys sys flags no_site}@anchor{4286}
@deffn {Atributo} flags.no_site
@end deffn

@tab

@ref{1217,,-S}

@item

@geindex ignore_environment (atributo de sys.flags)
@anchor{library/sys sys flags ignore_environment}@anchor{4287}
@deffn {Atributo} flags.ignore_environment
@end deffn

@tab

@ref{9f0,,-E}

@item

@geindex verbose (atributo de sys.flags)
@anchor{library/sys sys flags verbose}@anchor{4288}
@deffn {Atributo} flags.verbose
@end deffn

@tab

@ref{1464,,-v}

@item

@geindex bytes_warning (atributo de sys.flags)
@anchor{library/sys sys flags bytes_warning}@anchor{4289}
@deffn {Atributo} flags.bytes_warning
@end deffn

@tab

@ref{683,,-b}

@item

@geindex quiet (atributo de sys.flags)
@anchor{library/sys sys flags quiet}@anchor{428a}
@deffn {Atributo} flags.quiet
@end deffn

@tab

@ref{1d3a,,-q}

@item

@geindex hash_randomization (atributo de sys.flags)
@anchor{library/sys sys flags hash_randomization}@anchor{428b}
@deffn {Atributo} flags.hash_randomization
@end deffn

@tab

@ref{1a9e,,-R}

@item

@geindex dev_mode (atributo de sys.flags)
@anchor{library/sys sys flags dev_mode}@anchor{1aa8}
@deffn {Atributo} flags.dev_mode
@end deffn

@tab

@ref{2e2,,-X dev} (@ref{356,,Modo de desarrollo de Python})

@item

@geindex utf8_mode (atributo de sys.flags)
@anchor{library/sys sys flags utf8_mode}@anchor{428c}
@deffn {Atributo} flags.utf8_mode
@end deffn

@tab

@ref{2e2,,-X utf8}

@item

@geindex safe_path (atributo de sys.flags)
@anchor{library/sys sys flags safe_path}@anchor{38f}
@deffn {Atributo} flags.safe_path
@end deffn

@tab

@ref{645,,-P}

@item

@geindex int_max_str_digits (atributo de sys.flags)
@anchor{library/sys sys flags int_max_str_digits}@anchor{227f}
@deffn {Atributo} flags.int_max_str_digits
@end deffn

@tab

@ref{2e2,,-X int_max_str_digits}
(@ref{695,,integer string conversion length limitation})

@item

@geindex warn_default_encoding (atributo de sys.flags)
@anchor{library/sys sys flags warn_default_encoding}@anchor{428d}
@deffn {Atributo} flags.warn_default_encoding
@end deffn

@tab

@ref{2e2,,-X warn_default_encoding}

@end multitable



Distinto en la versión 3.2: Agregado el atributo @code{quiet} para el nuevo flag @ref{1d3a,,-q}.



Added in version 3.2.3: El atributo @code{hash_randomization}.



Distinto en la versión 3.3: Eliminado el atributo obsoleto @code{division_warning}.



Distinto en la versión 3.4: Agregado el atributo @code{isolated} para  el flag @ref{9f1,,-I} @code{isolated}.



Distinto en la versión 3.7: Se agregó el atributo @code{dev_mode} para el nuevo @ref{356,,Modo de Desarrollo de Python} y el atributo @code{utf8_mode} para la bandera @ref{2e2,,-X} @code{utf8}.



Distinto en la versión 3.10: Se agregó el atributo @code{warn_default_encoding} para el indicador @ref{2e2,,-X} @code{warn_default_encoding}.



Distinto en la versión 3.11: Se agregó el atributo @code{safe_path} para la opción @ref{645,,-P}.



Distinto en la versión 3.11: Se agregó el atributo @code{int_max_str_digits}.

@end deffn

@geindex float_info (en el módulo sys)
@anchor{library/sys sys float_info}@anchor{19f4}
@deffn {Dato} sys.float_info

Un @ref{6ef,,named tuple} que contiene información sobre el tipo de flotante. Contiene información de bajo nivel sobre la precisión y la representación interna. Los valores corresponden a las diversas constantes de coma flotante definidas en el archivo de encabezado estándar @code{float.h} para el lenguaje de programación “C”; consulte la sección 5.2.4.2.2 de la norma `ISO/IEC' C de 1999 @ref{428e,,[C99]}, “Características de los tipos flotantes”, para obtener más detalles.
Atributos de @code{float_info} named tuple



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

atributo

@tab

macro float.h

@tab

explicación

@item

@geindex epsilon (atributo de sys.float_info)
@anchor{library/sys sys float_info epsilon}@anchor{428f}
@deffn {Atributo} float_info.epsilon
@end deffn

@tab

@code{DBL_EPSILON}

@tab

diferencia entre 1,0 y el valor mínimo mayor que 1,0 que se puede representar como un flotante.

Vea también @ref{9a8,,math.ulp()}.

@item

@geindex dig (atributo de sys.float_info)
@anchor{library/sys sys float_info dig}@anchor{4290}
@deffn {Atributo} float_info.dig
@end deffn

@tab

@code{DBL_DIG}

@tab

El número máximo de dígitos decimales que se pueden representar fielmente en un flotante; vea abajo.

@item

@geindex mant_dig (atributo de sys.float_info)
@anchor{library/sys sys float_info mant_dig}@anchor{4291}
@deffn {Atributo} float_info.mant_dig
@end deffn

@tab

@code{DBL_MANT_DIG}

@tab

Precisión de flotador: el número de dígitos en base @code{radix} en el significado de un flotador.

@item

@geindex max (atributo de sys.float_info)
@anchor{library/sys sys float_info max}@anchor{4292}
@deffn {Atributo} float_info.max
@end deffn

@tab

@code{DBL_MAX}

@tab

El flotador finito positivo máximo representable.

@item

@geindex max_exp (atributo de sys.float_info)
@anchor{library/sys sys float_info max_exp}@anchor{4293}
@deffn {Atributo} float_info.max_exp
@end deffn

@tab

@code{DBL_MAX_EXP}

@tab

El entero máximo `e' tal que @code{radix**(e-1)} es un flotante finito representable.

@item

@geindex max_10_exp (atributo de sys.float_info)
@anchor{library/sys sys float_info max_10_exp}@anchor{4294}
@deffn {Atributo} float_info.max_10_exp
@end deffn

@tab

@code{DBL_MAX_10_EXP}

@tab

El entero máximo `e' tal que @code{10**e} esté en el rango de flotadores finitos representables.

@item

@geindex min (atributo de sys.float_info)
@anchor{library/sys sys float_info min}@anchor{4295}
@deffn {Atributo} float_info.min
@end deffn

@tab

@code{DBL_MIN}

@tab

El flotador `normalized' positivo mínimo representable.

Usa @ref{9a8,,math.ulp(0.0)} para obtener el menor flotante positivo `denormalizado' representable.

@item

@geindex min_exp (atributo de sys.float_info)
@anchor{library/sys sys float_info min_exp}@anchor{4296}
@deffn {Atributo} float_info.min_exp
@end deffn

@tab

@code{DBL_MIN_EXP}

@tab

El entero mínimo `e' tal que @code{radix**(e-1)} sea un flotante normalizado.

@item

@geindex min_10_exp (atributo de sys.float_info)
@anchor{library/sys sys float_info min_10_exp}@anchor{4297}
@deffn {Atributo} float_info.min_10_exp
@end deffn

@tab

@code{DBL_MIN_10_EXP}

@tab

El entero mínimo `e' tal que @code{10**e} sea un flotante normalizado.

@item

@geindex radix (atributo de sys.float_info)
@anchor{library/sys sys float_info radix}@anchor{4298}
@deffn {Atributo} float_info.radix
@end deffn

@tab

@code{FLT_RADIX}

@tab

La base de la representación del exponente.

@item

@geindex rounds (atributo de sys.float_info)
@anchor{library/sys sys float_info rounds}@anchor{4299}
@deffn {Atributo} float_info.rounds
@end deffn

@tab

@code{FLT_ROUNDS}

@tab

Un número entero que representa el modo de redondeo para la aritmética de punto flotante. Esto refleja el valor de la macro @code{FLT_ROUNDS} del sistema en el momento de inicio del intérprete:


@itemize *

@item 
@code{-1}: indeterminable

@item 
@code{0}: toward zero

@item 
@code{1}: to nearest

@item 
@code{2}: toward positive infinity

@item 
@code{3}: toward negative infinity
@end itemize

Todos los demás valores de @code{FLT_ROUNDS} caracterizan el comportamiento de redondeo definido por la implementación.

@end multitable


El atributo @ref{4290,,sys.float_info.dig} necesita más explicación. Si @code{s} es cualquier cadena que representa un número decimal con como máximo @code{sys.float_info.dig} dígitos significativos, entonces al convertir @code{s} a un flotante y viceversa se recuperará una cadena que representa el mismo valor decimal:

@example
>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # decimal string with 15 significant digits
>>> format(float(s), '.15g')  # convert to float and back -> same value
'3.14159265358979'
@end example

Pero para cadenas con más de @ref{4290,,sys.float_info.dig} dígitos significativos, esto no siempre es cierto:

@example
>>> s = '9876543211234567'    # 16 significant digits is too many!
>>> format(float(s), '.16g')  # conversion changes value
'9876543211234568'
@end example
@end deffn

@geindex float_repr_style (en el módulo sys)
@anchor{library/sys sys float_repr_style}@anchor{1361}
@deffn {Dato} sys.float_repr_style

Una cadena que indica cómo se comporta la función @ref{894,,repr()} para los flotantes. Si la cadena tiene el valor @code{'short'}, entonces para un flotante finito @code{x}, @code{repr(x)} tiene como objetivo producir una cadena corta con la propiedad de que @code{float(repr(x)) == x}. Este es el comportamiento habitual en Python 3.1 y posteriores. De lo contrario, @code{float_repr_style} tiene el valor @code{'legacy'} y @code{repr(x)} se comporta de la misma manera que en las versiones de Python anteriores a la 3.1.


Added in version 3.1.

@end deffn

@geindex getallocatedblocks() (en el módulo sys)
@anchor{library/sys sys getallocatedblocks}@anchor{1044}
@deffn {Función} sys.getallocatedblocks ()

Return the number of memory blocks currently allocated by the interpreter,
regardless of their size.  This function is mainly useful for tracking
and debugging memory leaks.  Because of the interpreter’s internal
caches, the result can vary from call to call; you may have to call
@ref{167b,,_clear_internal_caches()} and @ref{acc,,gc.collect()} to get more
predictable results.

If a Python build or implementation cannot reasonably compute this
information, @ref{1044,,getallocatedblocks()} is allowed to return 0 instead.


Added in version 3.4.

@end deffn

@geindex getunicodeinternedsize() (en el módulo sys)
@anchor{library/sys sys getunicodeinternedsize}@anchor{429a}
@deffn {Función} sys.getunicodeinternedsize ()

Devuelve el número de objetos unicode que han sido internados.


Added in version 3.12.

@end deffn

@geindex getandroidapilevel() (en el módulo sys)
@anchor{library/sys sys getandroidapilevel}@anchor{c12}
@deffn {Función} sys.getandroidapilevel ()

Return the build-time API level of Android as an integer. This represents the
minimum version of Android this build of Python can run on. For runtime
version information, see @ref{1657,,platform.android_ver()}.

@ref{1d5a,,Availability}: Android.


Added in version 3.7.

@end deffn

@geindex getdefaultencoding() (en el módulo sys)
@anchor{library/sys sys getdefaultencoding}@anchor{429b}
@deffn {Función} sys.getdefaultencoding ()

Retorna el nombre de la codificación de cadena predeterminada actual utilizada por la implementación de Unicode.
@end deffn

@geindex getdlopenflags() (en el módulo sys)
@anchor{library/sys sys getdlopenflags}@anchor{1550}
@deffn {Función} sys.getdlopenflags ()

Devuelve el valor actual de los indicadores que se utilizan para las llamadas @code{dlopen()}. Los nombres simbólicos para los valores de las banderas se pueden encontrar en el módulo @ref{a1,,os} (constantes @code{RTLD_@var{xxx}}, por ejemplo, @ref{118a,,os.RTLD_LAZY}).

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex getfilesystemencoding() (en el módulo sys)
@anchor{library/sys sys getfilesystemencoding}@anchor{ce1}
@deffn {Función} sys.getfilesystemencoding ()

Obtenga @ref{5dd,,filesystem encoding}: la codificación utilizada con @ref{5dd,,filesystem error handler} para convertir entre nombres de archivos Unicode y nombres de archivos en bytes. El controlador de errores del sistema de archivos se devuelve desde @ref{d6d,,getfilesystemencodeerrors()}.

Para la mejor compatibilidad, str debe ser usado por nombres de archivos en todos los casos, aunque representar nombres de archivos en bytes también es soportado. Funciones que acepta o retornan nombres de archivos deben soportar tanto str como bytes e internamente convertir el valor a representación preferida por el sistema.

@ref{cdd,,os.fsencode()} y @ref{cdc,,os.fsdecode()} deben usarse para garantizar que se utilizan la codificación correcta y el modo de errores.

El @ref{5dd,,codificación del sistema de archivos y manejo de errores} está configurado en el inicio de Python por la función @ref{829,,PyConfig_Read()}: ver @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} que son miembros de @ref{499,,PyConfig}.


Distinto en la versión 3.2: el resultado de @ref{ce1,,getfilesystemencoding()} ya no puede ser @code{None}.



Distinto en la versión 3.6: Ya no se garantiza que Windows retorne @code{'mbcs'}. Consulte 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} y @ref{1e6,,_enablelegacywindowsfsencoding()} para obtener más información.



Distinto en la versión 3.7: Retorna @code{'utf-8'} si @ref{6f7,,Modo UTF-8 de Python} esta habilitado.

@end deffn

@geindex getfilesystemencodeerrors() (en el módulo sys)
@anchor{library/sys sys getfilesystemencodeerrors}@anchor{d6d}
@deffn {Función} sys.getfilesystemencodeerrors ()

Obtener la @ref{5dd,,codificación de sistema de archivos}: La codificación usada con el @ref{5dd,,gestor de errores de sistema de archivos} para convertir nombres de archivos en Unicode a nombres de archivos en bytes. El gestor de errores del sistema de archivos es retornado desde @ref{ce1,,getfilesystemencoding()}.

@ref{cdd,,os.fsencode()} y @ref{cdc,,os.fsdecode()} deben usarse para garantizar que se utilizan la codificación correcta y el modo de errores.

El @ref{5dd,,codificación del sistema de archivos y manejo de errores} está configurado en el inicio de Python por la función @ref{829,,PyConfig_Read()}: ver @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} que son miembros de @ref{499,,PyConfig}.


Added in version 3.6.

@end deffn

@geindex get_int_max_str_digits() (en el módulo sys)
@anchor{library/sys sys get_int_max_str_digits}@anchor{2281}
@deffn {Función} sys.get_int_max_str_digits ()

Devuelve el valor actual de @ref{695,,integer string conversion length limitation}. Véase también @ref{17c6,,set_int_max_str_digits()}.


Added in version 3.11.

@end deffn

@geindex getrefcount() (en el módulo sys)
@anchor{library/sys sys getrefcount}@anchor{429c}
@deffn {Función} sys.getrefcount (object)

Retorna el recuento de referencias del `object'. El recuento retornado es generalmente uno más alto de lo que cabría esperar, porque incluye la referencia (temporal) como argumento para @ref{429c,,getrefcount()}.

Note that the returned value may not actually reflect how many
references to the object are actually held.  For example, some
objects are @ref{429d,,immortal} and have a very high refcount that does not
reflect the actual number of references.  Consequently, do not rely
on the returned value to be accurate, other than a value of 0 or 1.


Distinto en la versión 3.12: Los objetos inmortales tienen refcounts muy grandes que no coinciden con el número real de referencias al objeto.

@end deffn

@geindex getrecursionlimit() (en el módulo sys)
@anchor{library/sys sys getrecursionlimit}@anchor{56b}
@deffn {Función} sys.getrecursionlimit ()

Retorna el valor actual del límite de recursividad, la profundidad máxima de la pila de intérpretes de Python. Este límite evita que la recursividad infinita cause un desbordamiento de la pila C y bloquee Python. Se puede configurar mediante @ref{56a,,setrecursionlimit()}.
@end deffn

@geindex getsizeof() (en el módulo sys)
@anchor{library/sys sys getsizeof}@anchor{1772}
@deffn {Función} sys.getsizeof (object[, default])

Retorna el tamaño de un objeto en bytes. El objeto puede ser cualquier tipo de objeto. Todos los objetos integrados retornarán resultados correctos, pero esto no tiene por qué ser cierto para las extensiones de terceros, ya que es una implementación específica.

Solo se tiene en cuenta el consumo de memoria atribuido directamente al objeto, no el consumo de memoria de los objetos a los que se refiere.

Si se proporciona, se retornará `predeterminado' si el objeto no proporciona los medios para recuperar el tamaño. De lo contrario, se lanzará un @ref{228,,TypeError}.

@ref{1772,,getsizeof()} llama al método @code{__sizeof__} del objeto y agrega una sobrecarga adicional del recolector de basura si el objeto es administrado por el recolector de basura.

See recursive sizeof recipe@footnote{https://code.activestate.com/recipes/577504-compute-memory-footprint-of-an-object-and-its-cont/}
for an example of using @ref{1772,,getsizeof()} recursively to find the size of
containers and all their contents.
@end deffn

@geindex getswitchinterval() (en el módulo sys)
@anchor{library/sys sys getswitchinterval}@anchor{9dc}
@deffn {Función} sys.getswitchinterval ()

Retorna el «intervalo de cambio de hilo» del intérprete; ver @ref{9dd,,setswitchinterval()}.


Added in version 3.2.

@end deffn

@geindex _getframe() (en el módulo sys)
@anchor{library/sys sys _getframe}@anchor{781}
@deffn {Función} sys._getframe ([depth])

Retorna un objeto de marco de la pila de llamadas. Si se proporciona un entero opcional `depth', retorna el objeto de marco que muchas llamadas debajo de la parte superior de la pila. Si eso es más profundo que la pila de llamadas, se lanza @ref{360,,ValueError}. El valor predeterminado de `depth' es cero, lo que retorna el marco en la parte superior de la pila de llamadas.

Genera un @ref{18c3,,auditing event} @code{sys._getframe} con el argumento @code{frame}.

`Detalles de implementación de CPython:' Esta función debe utilizarse únicamente para fines internos y especializados. No se garantiza que exista en todas las implementaciones de Python.
@end deffn

@geindex _getframemodulename() (en el módulo sys)
@anchor{library/sys sys _getframemodulename}@anchor{1777}
@deffn {Función} sys._getframemodulename ([depth])

Devuelve el nombre de un módulo de la pila de llamadas. Si se proporciona el entero opcional `depth', devuelve el módulo que muchas llamadas se encuentran debajo de la parte superior de la pila. Si es más profundo que la pila de llamadas, o si el módulo no es identificable, se devuelve @code{None}. El valor predeterminado para `depth' es cero, lo que devuelve el módulo a la parte superior de la pila de llamadas.

Genera un @ref{18c3,,auditing event} @code{sys._getframemodulename} con el argumento @code{depth}.

`Detalles de implementación de CPython:' Esta función debe utilizarse únicamente para fines internos y especializados. No se garantiza que exista en todas las implementaciones de Python.
@end deffn

@geindex getobjects() (en el módulo sys)
@anchor{library/sys sys getobjects}@anchor{1b5}
@deffn {Función} sys.getobjects (limit[, type])

This function only exists if CPython was built using the
specialized configure option @ref{487,,--with-trace-refs}.
It is intended only for debugging garbage-collection issues.

Return a list of up to `limit' dynamically allocated Python objects.
If `type' is given, only objects of that exact type (not subtypes)
are included.

Objects from the list are not safe to use.
Specifically, the result will include objects from all interpreters that
share their object allocator state (that is, ones created with
@ref{429e,,PyInterpreterConfig.use_main_obmalloc} set to 1
or using @ref{17be,,Py_NewInterpreter()}, and the
@ref{62b,,main interpreter}).
Mixing objects from different interpreters may lead to crashes
or other unexpected behavior.

`Detalles de implementación de CPython:' This function should be used for specialized purposes only.
It is not guaranteed to exist in all implementations of Python.


Distinto en la versión 3.14.0a1 (unreleased): The result may include objects from other interpreters.

@end deffn

@geindex getprofile() (en el módulo sys)
@anchor{library/sys sys getprofile}@anchor{1420}
@deffn {Función} sys.getprofile ()

@geindex función de perfil
@geindex perfilador

Obtiene la función de generador de perfiles establecida por @ref{153f,,setprofile()}.
@end deffn

@geindex gettrace() (en el módulo sys)
@anchor{library/sys sys gettrace}@anchor{1421}
@deffn {Función} sys.gettrace ()

@geindex función de seguimiento
@geindex depurador(debugger)

Obtiene la función de seguimiento (`trace') establecida por @ref{1540,,settrace()}.

`Detalles de implementación de CPython:' La función @ref{1421,,gettrace()} está pensada solo para implementar depuradores, perfiladores, herramientas de cobertura y similares. Su comportamiento es parte de la plataforma de implementación, en lugar de parte de la definición del lenguaje y, por lo tanto, es posible que no esté disponible en todas las implementaciones de Python.
@end deffn

@geindex getwindowsversion() (en el módulo sys)
@anchor{library/sys sys getwindowsversion}@anchor{d6e}
@deffn {Función} sys.getwindowsversion ()

Retorna una tupla con nombre que describe la versión de Windows que se está ejecutando actualmente. Los elementos nombrados son `major', `minor', `build', `platform', `service_pack', `service_pack_minor', `service_pack_major', `suite_mask', `product_type' y `platform_version'. `service_pack' contiene una cadena de caracteres, `platform_version' una tupla de 3 y todos los demás valores son números enteros. También se puede acceder a los componentes por su nombre, por lo que @code{sys.getwindowsversion()[0]} es equivalente a @code{sys.getwindowsversion().major}. Para compatibilidad con versiones anteriores, solo los primeros 5 elementos se pueden recuperar mediante la indexación.

`platform' será @code{2} (VER_PLATFORM_WIN32_NT).

`product_type' puede ser uno de los siguientes valores:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{1} (VER_NT_WORKSTATION)

@tab

El sistema es una estación de trabajo.

@item

@code{2} (VER_NT_DOMAIN_CONTROLLER)

@tab

El sistema es un controlador de dominio.

@item

@code{3} (VER_NT_SERVER)

@tab

El sistema es un servidor, pero no un controlador de dominio.

@end multitable


Esta función envuelve la función Win32 @code{GetVersionEx()}; consulte la documentación de Microsoft sobre @code{OSVERSIONINFOEX()} para obtener más información sobre estos campos.

`platform_version' retorna la versión principal, la versión secundaria y el número de compilación del sistema operativo actual, en lugar de la versión que se está emulando para el proceso. Está diseñado para su uso en el registro en lugar de para la detección de características.

@cartouche
@quotation Nota 
`platform_version' deriva la versión desde kernel32.dll que puede ser de una versión diferente a la versión de SO. Por favor usar el módulo @ref{aa,,platform} para obtener una versión de SO precisa.
@end quotation
@end cartouche

@ref{1d5a,,Availability}: Windows.


Distinto en la versión 3.2: Cambiada a una tupla con nombre y agregado `service_pack_minor', `service_pack_major', `suite_mask', y `product_type'.



Distinto en la versión 3.6: Agregado `platform_version'

@end deffn

@geindex get_asyncgen_hooks() (en el módulo sys)
@anchor{library/sys sys get_asyncgen_hooks}@anchor{183a}
@deffn {Función} sys.get_asyncgen_hooks ()

Devuelve un objeto `asyncgen_hooks', que es similar a un @ref{32d,,namedtuple} con el formato @code{(firstiter, finalizer)}, donde se espera que `firstiter' y `finalizer' sean @code{None} o funciones que toman un @ref{429f,,asynchronous generator iterator} como argumento y se utilizan para programar la finalización de un generador asíncrono mediante un bucle de eventos. .


Added in version 3.6: Ver 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} para más detalles.


@cartouche
@quotation Nota 
Esta función se ha añadido de forma provisional (consulte 
@geindex Python Enhancement Proposals; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para obtener más detalles).
@end quotation
@end cartouche
@end deffn

@geindex get_coroutine_origin_tracking_depth() (en el módulo sys)
@anchor{library/sys sys get_coroutine_origin_tracking_depth}@anchor{c13}
@deffn {Función} sys.get_coroutine_origin_tracking_depth ()

Obtiene la profundidad de seguimiento del origen de la corrutina actual, según lo establecido por @ref{c14,,set_coroutine_origin_tracking_depth()}.


Added in version 3.7.


@cartouche
@quotation Nota 
Esta función se ha añadido de forma provisional (consulte 
@geindex Python Enhancement Proposals; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para obtener más detalles). Úsela sólo para fines de depuración.
@end quotation
@end cartouche
@end deffn

@geindex hash_info (en el módulo sys)
@anchor{library/sys sys hash_info}@anchor{107b}
@deffn {Dato} sys.hash_info

A @ref{6ef,,named tuple} dando parámetros de la implementación de hash numérico. Para obtener más detalles sobre el hash de tipos numéricos, consulte @ref{21aa,,Calculo del hash de tipos numéricos}.

@geindex width (atributo de sys.hash_info)
@anchor{library/sys sys hash_info width}@anchor{42a0}
@deffn {Atributo} hash_info.width

El ancho en bits utilizado para los valores hash.
@end deffn

@geindex modulus (atributo de sys.hash_info)
@anchor{library/sys sys hash_info modulus}@anchor{21ab}
@deffn {Atributo} hash_info.modulus

El módulo principal P utilizado para el esquema hash numérico
@end deffn

@geindex inf (atributo de sys.hash_info)
@anchor{library/sys sys hash_info inf}@anchor{42a1}
@deffn {Atributo} hash_info.inf

El valor hash devuelto para un infinito positivo
@end deffn

@geindex nan (atributo de sys.hash_info)
@anchor{library/sys sys hash_info nan}@anchor{42a2}
@deffn {Atributo} hash_info.nan

(Este atributo ya no se utiliza)
@end deffn

@geindex imag (atributo de sys.hash_info)
@anchor{library/sys sys hash_info imag}@anchor{42a3}
@deffn {Atributo} hash_info.imag

El multiplicador utilizado para la parte imaginaria de un número complejo.
@end deffn

@geindex algorithm (atributo de sys.hash_info)
@anchor{library/sys sys hash_info algorithm}@anchor{42a4}
@deffn {Atributo} hash_info.algorithm

El nombre del algoritmo para el hash de cadena, bytes y vista de memoria.
@end deffn

@geindex hash_bits (atributo de sys.hash_info)
@anchor{library/sys sys hash_info hash_bits}@anchor{42a5}
@deffn {Atributo} hash_info.hash_bits

El tamaño de salida interno del algoritmo hash.
@end deffn

@geindex seed_bits (atributo de sys.hash_info)
@anchor{library/sys sys hash_info seed_bits}@anchor{42a6}
@deffn {Atributo} hash_info.seed_bits

El tamaño de la clave semilla del algoritmo hash.
@end deffn


Added in version 3.2.



Distinto en la versión 3.4: Agregado `algoritmo', `hash_bits' y `seed_bits'

@end deffn

@geindex hexversion (en el módulo sys)
@anchor{library/sys sys hexversion}@anchor{42a7}
@deffn {Dato} sys.hexversion

El número de versión codificado como un solo entero. Se garantiza que esto aumentará con cada versión, incluido el soporte adecuado para versiones que no son de producción. Por ejemplo, para probar que el intérprete de Python es al menos la versión 1.5.2, use:

@example
if sys.hexversion >= 0x010502F0:
    # use some advanced feature
    ...
else:
    # use an alternative implementation or warn the user
    ...
@end example

Esto se llama @code{hexversion} ya que solo parece realmente significativo cuando se ve como el resultado de pasarlo a la función incorporada @ref{1337,,hex()}. El @ref{6ef,,named tuple} @ref{741,,sys.version_info} puede usarse para una codificación más amigable para los humanos de la misma información.

Se pueden encontrar más detalles de @code{hexversion} en @ref{42a8,,Versiones de API y ABI}.
@end deffn

@geindex implementation (en el módulo sys)
@anchor{library/sys sys implementation}@anchor{5bb}
@deffn {Dato} sys.implementation

Un objeto que contiene información sobre la implementación del intérprete de Python en ejecución. Los siguientes atributos deben existir en todas las implementaciones de Python.

`name' es el identificador de la implementación, por ejemplo @code{'cpython'}. La cadena de caracteres real está definida por la implementación de Python, pero se garantiza que estará en minúsculas.

`version' es una tupla con nombre, en el mismo formato que @ref{741,,sys.version_info}. Representa la versión de la `implementación' de Python. Esto tiene un significado distinto de la versión específica del `lenguaje' de Python al que se ajusta el intérprete que se está ejecutando actualmente, que representa @code{sys.version_info}. Por ejemplo, para PyPy 1.8 @code{sys.implementation.version} podría ser @code{sys.version_info(1, 8, 0, 'final', 0)}, mientras que @code{sys.version_info} sería @code{sys.version_info(2, 7, 2, 'final', 0)}. Para CPython tienen el mismo valor, ya que es la implementación de referencia.

`hexversion' es la versión de implementación en formato hexadecimal, como @ref{42a7,,sys.hexversion}.

`cache_tag' es la etiqueta utilizada por la maquinaria de importación en los nombres de archivo de los módulos almacenados en caché. Por convención, sería una combinación del nombre y la versión de la implementación, como @code{'cpython-33'}. Sin embargo, una implementación de Python puede usar algún otro valor si corresponde. Si @code{cache_tag} está configurado como @code{None}, indica que el almacenamiento en caché del módulo debe estar deshabilitado.

@ref{5bb,,sys.implementation} puede contener atributos adicionales específicos de la implementación de Python. Estos atributos no estándar deben comenzar con un guion bajo y no se describen aquí. Independientemente de su contenido, @ref{5bb,,sys.implementation} no cambiará durante la ejecución del intérprete, ni entre las versiones de implementación. (Sin embargo, puede cambiar entre las versiones del lenguaje Python). Consulte 
@geindex Python Enhancement Proposals; PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/} para obtener más información.


Added in version 3.3.


@cartouche
@quotation Nota 
La adición de nuevos atributos obligatorios debe pasar por el proceso normal de PEP. Consulte 
@geindex Python Enhancement Proposals; PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/} para obtener más información.
@end quotation
@end cartouche
@end deffn

@geindex int_info (en el módulo sys)
@anchor{library/sys sys int_info}@anchor{1300}
@deffn {Dato} sys.int_info

Un @ref{6ef,,named tuple} que contiene información sobre la representación interna de Python de los enteros. Los atributos son de solo lectura.

@geindex bits_per_digit (atributo de sys.int_info)
@anchor{library/sys sys int_info bits_per_digit}@anchor{42a9}
@deffn {Atributo} int_info.bits_per_digit

El número de bits contenidos en cada dígito. Los enteros de Python se almacenan internamente en la base @code{2**int_info.bits_per_digit}.
@end deffn

@geindex sizeof_digit (atributo de sys.int_info)
@anchor{library/sys sys int_info sizeof_digit}@anchor{42aa}
@deffn {Atributo} int_info.sizeof_digit

El tamaño en bytes del tipo C utilizado para representar un dígito.
@end deffn

@geindex default_max_str_digits (atributo de sys.int_info)
@anchor{library/sys sys int_info default_max_str_digits}@anchor{2280}
@deffn {Atributo} int_info.default_max_str_digits

El valor predeterminado para @ref{2281,,sys.get_int_max_str_digits()} cuando no está configurado explícitamente de otra manera.
@end deffn

@geindex str_digits_check_threshold (atributo de sys.int_info)
@anchor{library/sys sys int_info str_digits_check_threshold}@anchor{42ab}
@deffn {Atributo} int_info.str_digits_check_threshold

El valor mínimo distinto de cero para @ref{17c6,,sys.set_int_max_str_digits()}, 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS} o @ref{2e2,,-X int_max_str_digits}.
@end deffn


Added in version 3.1.



Distinto en la versión 3.11: Se agregaron @ref{2280,,default_max_str_digits} y @ref{42ab,,str_digits_check_threshold}.

@end deffn

@geindex __interactivehook__ (en el módulo sys)
@anchor{library/sys sys __interactivehook__}@anchor{1046}
@deffn {Dato} sys.__interactivehook__

Cuando existe este atributo, su valor se llama automáticamente (sin argumentos) cuando se lanza el intérprete en @ref{1045,,modo interactivo}. Esto se hace después de leer el archivo 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}, para que pueda establecer este enlace allí. El módulo @ref{c7,,site} @ref{1048,,establece este}.

Lanza un @ref{18c3,,auditing event} @code{cpython.run_interactivehook} con el objeto gancho (`hook') como argumento cuando se llama al gancho en el inicio.


Added in version 3.4.

@end deffn

@geindex intern() (en el módulo sys)
@anchor{library/sys sys intern}@anchor{1343}
@deffn {Función} sys.intern (string)

Ingresa `string' en la tabla de cadenas de caracteres «internadas» y retorna la cadena de caracteres interna, que es `string' en sí misma o una copia. Internar cadenas de caracteres es útil para obtener un poco de rendimiento en la búsqueda de diccionario: si las claves en un diccionario están internadas y la clave de búsqueda está interna, las comparaciones de claves (después del hash) se pueden realizar mediante una comparación de punteros en lugar de una comparación de cadenas. Normalmente, los nombres utilizados en los programas de Python se internan automáticamente, y los diccionarios utilizados para contener los atributos de módulo, clase o instancia tienen claves internas.

Interned strings are not @ref{429d,,immortal}; you must keep a reference to the
return value of @ref{1343,,intern()} around to benefit from it.
@end deffn

@geindex _is_gil_enabled() (en el módulo sys)
@anchor{library/sys sys _is_gil_enabled}@anchor{42ac}
@deffn {Función} sys._is_gil_enabled ()

Return @ref{c95,,True} if the @ref{2c5,,GIL} is enabled and @ref{bbf,,False} if
it is disabled.


Added in version 3.13.

@end deffn

@geindex is_finalizing() (en el módulo sys)
@anchor{library/sys sys is_finalizing}@anchor{ef5}
@deffn {Función} sys.is_finalizing ()

Return @ref{c95,,True} if the main Python interpreter is
@ref{2bb,,shutting down}. Return @ref{bbf,,False} otherwise.

See also the @ref{2ba,,PythonFinalizationError} exception.


Added in version 3.5.

@end deffn

@geindex last_exc (en el módulo sys)
@anchor{library/sys sys last_exc}@anchor{565}
@deffn {Dato} sys.last_exc

Esta variable no siempre está definida; se establece en la instancia de excepción cuando no se maneja una excepción y el intérprete imprime un mensaje de error y un seguimiento de la pila. Su uso previsto es permitir que un usuario interactivo importe un módulo depurador y realice una depuración post-mortem sin tener que volver a ejecutar el comando que causó el error. (El uso típico es @code{import pdb; pdb.pm()} para ingresar al depurador post-mortem; consulte el módulo @ref{a5,,pdb} para obtener más información).


Added in version 3.12.

@end deffn

@geindex _is_interned() (en el módulo sys)
@anchor{library/sys sys _is_interned}@anchor{3a9}
@deffn {Función} sys._is_interned (string)

Return @ref{c95,,True} if the given string is «interned», @ref{bbf,,False}
otherwise.


Added in version 3.13.


`Detalles de implementación de CPython:' It is not guaranteed to exist in all implementations of Python.
@end deffn

@geindex last_type (en el módulo sys)
@geindex last_value (en el módulo sys)
@geindex last_traceback (en el módulo sys)
@anchor{library/sys sys last_type}@anchor{566}
@deffn {Dato} sys.last_type
@anchor{library/sys sys last_value}@anchor{567}
@deffnx {Dato} sys.last_value
@anchor{library/sys sys last_traceback}@anchor{568}
@deffnx {Dato} sys.last_traceback

Estas tres variables están obsoletas; utilice @ref{565,,sys.last_exc} en su lugar. Contienen la representación heredada de @code{sys.last_exc}, devuelta por @ref{72b,,exc_info()}.
@end deffn

@geindex maxsize (en el módulo sys)
@anchor{library/sys sys maxsize}@anchor{1232}
@deffn {Dato} sys.maxsize

Un entero que da el valor máximo que puede tomar una variable de tipo @ref{af0,,Py_ssize_t}. Suele ser @code{2**31 - 1} en una plataforma de 32 bits y @code{2** 63 - 1} en una plataforma de 64 bits.
@end deffn

@geindex maxunicode (en el módulo sys)
@anchor{library/sys sys maxunicode}@anchor{10c8}
@deffn {Dato} sys.maxunicode

Un número entero que da el valor del punto de código Unicode más grande, es decir, @code{1114111} (@code{0x10FFFF} en hexadecimal).


Distinto en la versión 3.3: Antes 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, @code{sys.maxunicode} solía ser @code{0xFFFF} o @code{0x10FFFF}, dependiendo de la opción de configuración que especificaba si los caracteres Unicode se almacenaban como UCS-2 o UCS-4.

@end deffn

@geindex meta_path (en el módulo sys)
@anchor{library/sys sys meta_path}@anchor{db2}
@deffn {Dato} sys.meta_path

A list of @ref{10ec,,meta path finder} objects that have their
@ref{8ff,,find_spec()} methods called to see if one
of the objects can find the module to be imported. By default, it holds entries
that implement Python’s default import semantics. The
@ref{8ff,,find_spec()} method is called with at
least the absolute name of the module being imported. If the module to be
imported is contained in a package, then the parent package’s
@ref{1c74,,__path__}
attribute is passed in as a second argument. The method returns a
@ref{1f15,,module spec}, or @code{None} if the module cannot be found.


@subsubheading Ver también



@table @asis

@item @ref{905,,importlib.abc.MetaPathFinder}

La clase base abstracta que define la interfaz de los objetos del buscador en @ref{db2,,meta_path}.

@item @ref{1e69,,importlib.machinery.ModuleSpec}

La clase concreta que @ref{8ff,,find_spec()} debería retornar instancias de.
@end table



Distinto en la versión 3.4: @ref{1f15,,Module specs} were introduced in Python 3.4, by
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}.



Distinto en la versión 3.12: Removed the fallback that looked for a @code{find_module()} method
if a @ref{db2,,meta_path} entry didn’t have a
@ref{8ff,,find_spec()} method.

@end deffn

@geindex modules (en el módulo sys)
@anchor{library/sys sys modules}@anchor{1976}
@deffn {Dato} sys.modules

Este es un diccionario que asigna nombres de módulos a módulos que ya se han cargado. Esto se puede manipular para forzar la recarga de módulos y otros trucos. Sin embargo, reemplazar el diccionario no necesariamente funcionará como se esperaba y eliminar elementos esenciales del diccionario puede provocar que Python falle. Si desea iterar sobre este diccionario global, utilice siempre @code{sys.modules.copy()} o @code{tuple(sys.modules)} para evitar excepciones, ya que su tamaño puede cambiar durante la iteración como efecto secundario del código o la actividad en otros subprocesos.
@end deffn

@geindex orig_argv (en el módulo sys)
@anchor{library/sys sys orig_argv}@anchor{8d7}
@deffn {Dato} sys.orig_argv

La lista de los argumentos originales de la línea de comando que son pasados al ejecutable de Python.

The elements of @ref{8d7,,sys.orig_argv} are the arguments to the Python interpreter,
while the elements of @ref{12d2,,sys.argv} are the arguments to the user’s program.
Arguments consumed by the interpreter itself will be present in @ref{8d7,,sys.orig_argv}
and missing from @ref{12d2,,sys.argv}.


Added in version 3.10.

@end deffn

@geindex path (en el módulo sys)
@anchor{library/sys sys path}@anchor{27e}
@deffn {Dato} sys.path

@geindex módulo;búsqueda;ruta

Una lista de cadenas de caracteres que especifica la ruta de búsqueda de módulos. Inicializado desde la variable de entorno 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}, más un valor predeterminado que depende de la instalación.

De forma predeterminada, tal como se inicializa al iniciar el programa, se antepone una ruta potencialmente insegura a @ref{27e,,sys.path} (`before' son las entradas insertadas como resultado de 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}):


@itemize *

@item 
Línea de comando @code{python -m module}: anteponga el directorio de trabajo actual.

@item 
@code{python script.py} línea de comandos: anteponer el directorio del script. Si es un enlace simbólico, resuelve los enlaces simbólicos.

@item 
Líneas de comando @code{python -c code} y @code{python} (REPL): anteponen una cadena vacía, que significa el directorio de trabajo actual.
@end itemize

Para no anteponer esta ruta potencialmente insegura, utilice la opción de línea de comando @ref{645,,-P} o la variable de entorno 
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH}.

Un programa es libre de modificar esta lista para sus propios fines. Sólo se deben agregar cadenas a @ref{27e,,sys.path}; todos los demás tipos de datos se ignoran durante la importación.


@subsubheading Ver también



@itemize *

@item 
Módulo @ref{c7,,site} Esto describe cómo usar archivos .pth para extender @ref{27e,,sys.path}.
@end itemize

@end deffn

@geindex path_hooks (en el módulo sys)
@anchor{library/sys sys path_hooks}@anchor{10a0}
@deffn {Dato} sys.path_hooks

Una lista de invocables que toman un argumento de ruta para intentar crear un @ref{1f1c,,finder} para la ruta. Si se puede crear un buscador, el invocable debe retornar; de lo contrario, lanza @ref{4d7,,ImportError}.

Especificado originalmente en 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.
@end deffn

@geindex path_importer_cache (en el módulo sys)
@anchor{library/sys sys path_importer_cache}@anchor{684}
@deffn {Dato} sys.path_importer_cache

Un diccionario que actúa como caché para objetos @ref{1f1c,,finder}. Las claves son rutas que se han pasado a @ref{10a0,,sys.path_hooks} y los valores son los buscadores que se encuentran. Si una ruta es una ruta de sistema de archivos válida pero no se encuentra ningún buscador en @ref{10a0,,sys.path_hooks}, entonces se almacena @code{None}.

Especificado originalmente en 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.
@end deffn

@geindex platform (en el módulo sys)
@anchor{library/sys sys platform}@anchor{b19}
@deffn {Dato} sys.platform

A string containing a platform identifier. Known values are:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sistema

@tab

valor @code{platform}

@item

AIX

@tab

@code{'aix'}

@item

Android

@tab

@code{'android'}

@item

Emscripten

@tab

@code{'emscripten'}

@item

iOS

@tab

@code{'ios'}

@item

Linux

@tab

@code{'linux'}

@item

macOS

@tab

@code{'darwin'}

@item

Windows

@tab

@code{'win32'}

@item

Windows/Cygwin

@tab

@code{'cygwin'}

@item

WASI

@tab

@code{'wasi'}

@end multitable


On Unix systems not listed in the table, the value is the lowercased OS name
as returned by @code{uname -s}, with the first part of the version as returned by
@code{uname -r} appended, e.g. @code{'sunos5'} or @code{'freebsd8'}, `at the time
when Python was built'.  Unless you want to test for a specific system
version, it is therefore recommended to use the following idiom:

@example
if sys.platform.startswith('freebsd'):
    # FreeBSD-specific code here...
@end example


Distinto en la versión 3.3: On Linux, @ref{b19,,sys.platform} doesn’t contain the major version anymore.
It is always @code{'linux'}, instead of @code{'linux2'} or @code{'linux3'}.



Distinto en la versión 3.8: On AIX, @ref{b19,,sys.platform} doesn’t contain the major version anymore.
It is always @code{'aix'}, instead of @code{'aix5'} or @code{'aix7'}.



Distinto en la versión 3.13: On Android, @ref{b19,,sys.platform} now returns @code{'android'} rather than
@code{'linux'}.



@subsubheading Ver también


@ref{2b06,,os.name} tiene una granularidad más gruesa. @ref{1188,,os.uname()} proporciona información de versión dependiente del sistema.

El módulo @ref{aa,,platform} proporciona comprobaciones detalladas de la identidad del sistema.

@end deffn

@geindex platlibdir (en el módulo sys)
@anchor{library/sys sys platlibdir}@anchor{9cb}
@deffn {Dato} sys.platlibdir

Nombre del directorio de la biblioteca específica de la plataforma. Se utiliza para construir la ruta de la biblioteca estándar y las rutas de los módulos de extensión instalados.

Es igual a @code{"lib"} en la mayoría de las plataformas. En Fedora y SuSE, es igual a @code{"lib64"} en plataformas de 64 bits, lo que da las siguientes rutas @code{sys.path} (donde @code{X.Y} es la versión @code{mayor.menor} de Python):


@itemize *

@item 
@code{/usr/lib64/pythonX.Y/}: Biblioteca estándar (como @code{os.py} del módulo @ref{a1,,os})

@item 
@code{/usr/lib64/pythonX.Y/lib-dynload/}: Módulos de extensión C de la biblioteca estándar (como el módulo @ref{57,,errno}, el nombre exacto del archivo es específico de la plataforma)

@item 
@code{/usr/lib/pythonX.Y/site-packages/} (utilice siempre @code{lib}, no @ref{9cb,,sys.platlibdir}): Módulos de terceros

@item 
@code{/usr/lib64/pythonX.Y/site-packages/}: Módulos de extensión C de paquetes de terceros
@end itemize


Added in version 3.9.

@end deffn

@geindex prefix (en el módulo sys)
@anchor{library/sys sys prefix}@anchor{281}
@deffn {Dato} sys.prefix

Una cadena que proporciona el prefijo del directorio específico del sitio donde se instalan los archivos Python independientes de la plataforma; en Unix, el valor predeterminado es @code{/usr/local}. Esto se puede configurar en el momento de la compilación con el argumento @ref{1d66,,--prefix} del script @code{configure}. Consulte @ref{730,,Rutas de instalación} para conocer las rutas derivadas.

@cartouche
@quotation Nota 
Si un @ref{4245,,virtual environment} está en efecto, este valor se cambiará en @code{site.py} para apuntar al entorno virtual. El valor para la instalación de Python seguirá estando disponible a través de @ref{280,,base_prefix}.
@end quotation
@end cartouche
@end deffn

@geindex ps1 (en el módulo sys)
@geindex ps2 (en el módulo sys)
@anchor{library/sys sys ps1}@anchor{1d4b}
@deffn {Dato} sys.ps1
@anchor{library/sys sys ps2}@anchor{1d4c}
@deffnx {Dato} sys.ps2

@geindex indicaciones del intérprete
@geindex indicadores@comma{} intérprete
@geindex >>>;intérprete prompt
@geindex ...;intérprete prompt

Cadenas de caracteres que especifican el indicador principal y secundario del intérprete. Estos solo se definen si el intérprete está en modo interactivo. Sus valores iniciales en este caso son @code{'>>>'} y @code{'...'}. Si se asigna un objeto que no es una cadena a cualquiera de las variables, su @ref{237,,str()} se vuelve a evaluar cada vez que el intérprete se prepara para leer un nuevo comando interactivo; esto se puede utilizar para implementar un mensaje dinámico.
@end deffn

@geindex setdlopenflags() (en el módulo sys)
@anchor{library/sys sys setdlopenflags}@anchor{1191}
@deffn {Función} sys.setdlopenflags (n)

Configure los indicadores utilizados por el intérprete para las llamadas @code{dlopen()}, como cuando el intérprete carga módulos de extensión. Entre otras cosas, esto permitirá una resolución diferida de símbolos al importar un módulo, si se llama como @code{sys.setdlopenflags(0)}. Para compartir símbolos entre módulos de extensión, llame como @code{sys.setdlopenflags(os.RTLD_GLOBAL)}. Los nombres simbólicos para los valores de las banderas se pueden encontrar en el módulo @ref{a1,,os} (constantes @code{RTLD_@var{xxx}}, por ejemplo, @ref{118a,,os.RTLD_LAZY}).

@ref{1d5a,,Availability}: Unix.
@end deffn

@geindex set_int_max_str_digits() (en el módulo sys)
@anchor{library/sys sys set_int_max_str_digits}@anchor{17c6}
@deffn {Función} sys.set_int_max_str_digits (maxdigits)

Establece la @ref{695,,limitación de la longitud de conversión de cadenas enteras} utilizada por este intérprete. Véase también @ref{2281,,get_int_max_str_digits()}.


Added in version 3.11.

@end deffn

@geindex setprofile() (en el módulo sys)
@anchor{library/sys sys setprofile}@anchor{153f}
@deffn {Función} sys.setprofile (profilefunc)

@geindex función de perfil
@geindex perfilador

Configura la función de perfil del sistema, que le permite implementar un generador de perfiles de código fuente de Python en Python. Consulte el capítulo @ref{4196,,Los perfiladores de Python} para obtener más información sobre el generador de perfiles de Python. La función de perfil del sistema se llama de manera similar a la función de seguimiento del sistema (ver @ref{1540,,settrace()}), pero se llama con diferentes eventos, por ejemplo, no se llama para cada línea de código ejecutada (solo al llamar y regresar, pero el evento de retorno se informa incluso cuando se ha establecido una excepción). La función es específica de subprocesos, pero el generador de perfiles no tiene forma de conocer los cambios de contexto entre subprocesos, por lo que no tiene sentido usar esto en presencia de varios subprocesos. Además, su valor de retorno no se usa, por lo que simplemente puede retornar @code{None}. Un error en la función del perfil provocará su desarmado.

@cartouche
@quotation Nota 
The same tracing mechanism is used for @code{setprofile()} as @ref{1540,,settrace()}.
To trace calls with @code{setprofile()} inside a tracing function
(e.g. in a debugger breakpoint), see @ref{1839,,call_tracing()}.
@end quotation
@end cartouche

Las funciones de perfil deben tener tres argumentos: `frame', `event' y `arg'. `frame' es el marco de pila actual. `event' es una cadena de caracteres:  @code{'call'}, @code{'return'}, @code{'c_call'}, @code{'c_return'}, o @code{'c_exception'}. `arg' depende del tipo de evento.

Los eventos tienen el siguiente significado:


@table @asis

@item @code{'call'}

Se llama a una función (o se ingresa algún otro bloque de código). Se llama a la función de perfil; `arg' es @code{None}.

@item @code{'return'}

Una función (u otro bloque de código) está a punto de regresar. Se llama a la función de perfil; `arg' es el valor que se retornará, o @code{None} si el evento es causado por una excepción.

@item @code{'c_call'}

Una función C está a punto de ser llamada. Esta puede ser una función de extensión o una incorporada. `arg' es el objeto de función de C.

@item @code{'c_return'}

Ha vuelto una función C. `arg' es el objeto de función de C.

@item @code{'c_exception'}

Una función C ha generado una excepción. `arg' es el objeto de función de C.
@end table

Lanza un @ref{18c3,,auditing event} @code{sys.setprofile} sin argumentos.
@end deffn

@geindex setrecursionlimit() (en el módulo sys)
@anchor{library/sys sys setrecursionlimit}@anchor{56a}
@deffn {Función} sys.setrecursionlimit (limit)

Establece la profundidad máxima de la pila de intérpretes de Python en `limit'. Este límite evita que la recursividad infinita cause un desbordamiento de la pila C y bloquee Python.

El límite más alto posible depende de la plataforma. Un usuario puede necesitar establecer un límite más alto cuando tiene un programa que requiere una recursividad profunda y una plataforma que admite un límite más alto. Esto debe hacerse con cuidado, ya que un límite demasiado alto puede provocar un accidente.

Si el nuevo límite es demasiado bajo en la profundidad de recursividad actual, se genera una excepción @ref{df1,,RecursionError}.


Distinto en la versión 3.5.1: A la excepción @ref{df1,,RecursionError} ahora se lanza si el nuevo límite es demasiado bajo en la profundidad de recursión actual.

@end deffn

@geindex setswitchinterval() (en el módulo sys)
@anchor{library/sys sys setswitchinterval}@anchor{9dd}
@deffn {Función} sys.setswitchinterval (interval)

Establece el intervalo de cambio de hilo del intérprete (en segundos). Este valor de punto flotante determina la duración ideal de los «segmentos de tiempo» asignados a los subprocesos de Python que se ejecutan simultáneamente. Tenga en cuenta que el valor real puede ser mayor, especialmente si se utilizan funciones o métodos internos de larga duración. Además, qué hilo se programa al final del intervalo es decisión del sistema operativo. El intérprete no tiene su propio programador.


Added in version 3.2.

@end deffn

@geindex settrace() (en el módulo sys)
@anchor{library/sys sys settrace}@anchor{1540}
@deffn {Función} sys.settrace (tracefunc)

@geindex función de seguimiento
@geindex depurador(debugger)

Configura la función de seguimiento del sistema, que le permite implementar un depurador de código fuente de Python en Python. La función es específica del hilo; para que un depurador admita múltiples subprocesos, debe registrar una función de seguimiento usando @ref{1540,,settrace()} para cada subproceso que se depura o use @ref{8df,,threading.settrace()}.

Las funciones de seguimiento deben tener tres argumentos: `frame', `event' y `arg'. `frame' es el marco de pila actual. `event' es una cadena de caracteres: @code{'call'}, @code{'line'}, @code{'return'}, @code{'exception'} or @code{'opcode'}. `arg' depende del tipo de evento.

La función de rastreo se invoca (con `event' establecido en @code{'call'}) cada vez que se ingresa un nuevo ámbito local; debe retornar una referencia a una función de rastreo local que se usará para el nuevo alcance, o @code{None} si no se debe rastrear el alcance.

The local trace function should return a reference to itself, or to another
function which would then be used as the local trace function for the scope.

Si se produce algún error en la función de seguimiento, se desarmará, al igual que se llama a @code{settrace(None)}.

@cartouche
@quotation Nota 
Tracing is disabled while calling the trace function (e.g. a function set by
@code{settrace()}). For recursive tracing see @ref{1839,,call_tracing()}.
@end quotation
@end cartouche

Los eventos tienen el siguiente significado:


@table @asis

@item @code{'call'}

Se llama a una función (o se ingresa algún otro bloque de código). Se llama a la función de rastreo global; `arg' es @code{None}; el valor de retorno especifica la función de rastreo local.

@item @code{'line'}

The interpreter is about to execute a new line of code or re-execute the
condition of a loop.  The local trace function is called; `arg' is
@code{None}; the return value specifies the new local trace function.  See
@code{Objects/lnotab_notes.txt} for a detailed explanation of how this
works.
Per-line events may be disabled for a frame by setting
@ref{c63,,f_trace_lines} to @ref{bbf,,False} on that
@ref{780,,frame}.

@item @code{'return'}

Una función (u otro bloque de código) está a punto de regresar. Se llama a la función de rastreo local; `arg' es el valor que se retornará, o @code{None} si el evento es causado por una excepción. Se ignora el valor de retorno de la función de seguimiento.

@item @code{'exception'}

Ha ocurrido una excepción. Se llama a la función de rastreo local; `arg' es una tupla @code{(exception, value, traceback)}; el valor de retorno especifica la nueva función de rastreo local.

@item @code{'opcode'}

The interpreter is about to execute a new opcode (see @ref{39,,dis} for
opcode details).  The local trace function is called; `arg' is
@code{None}; the return value specifies the new local trace function.
Per-opcode events are not emitted by default: they must be explicitly
requested by setting @ref{c64,,f_trace_opcodes} to @ref{c95,,True} on the
@ref{780,,frame}.
@end table

Tenga en cuenta que como una excepción se propaga a lo largo de la cadena de llamadas de funciones, se lanza un evento de @code{'excepción'} en cada nivel.

Para un uso más detallado, es posible establecer una función de seguimiento asignando @code{frame.f_trace = tracefunc} explícitamente, en lugar de confiar en que se establezca indirectamente a través del valor de retorno de una función de seguimiento ya instalada. Esto también es necesario para activar la función de seguimiento en el marco actual, lo cual @ref{1540,,settrace()} no funciona. Tenga en cuenta que para que esto funcione, se debe haber instalado una función de rastreo global con @ref{1540,,settrace()} para habilitar la maquinaria de rastreo en tiempo de ejecución, pero no necesita ser la misma función de rastreo (por ejemplo, podría ser una función de rastreo de sobrecarga baja que simplemente retorna @code{None} para deshabilitarse inmediatamente en cada cuadro).

Para obtener más información sobre los objetos de código y marco, consulte @ref{1ee4,,Jerarquía de tipos estándar}.

Lanza un @ref{18c3,,auditing event} @code{sys.settrace} sin argumentos.

`Detalles de implementación de CPython:' La función @ref{1540,,settrace()} está pensada únicamente para implementar depuradores, perfiladores, herramientas de cobertura y similares. Su comportamiento es parte de la plataforma de implementación, en lugar de parte de la definición del lenguaje y, por lo tanto, es posible que no esté disponible en todas las implementaciones de Python.


Distinto en la versión 3.7: @code{'opcode'} event type added; @ref{c63,,f_trace_lines} and
@ref{c64,,f_trace_opcodes} attributes added to frames

@end deffn

@geindex set_asyncgen_hooks() (en el módulo sys)
@anchor{library/sys sys set_asyncgen_hooks}@anchor{1632}
@deffn {Función} sys.set_asyncgen_hooks ([firstiter] [, finalizer])

Acepta dos argumentos de palabras clave opcionales que son invocables que aceptan un @ref{429f,,asynchronous generator iterator} como argumento. Se llamará al `firstiter' invocable cuando se repita un generador asincrónico por primera vez. Se llamará al `finalizer' cuando un generador asincrónico esté a punto de ser recolectado como basura.

Lanza un @ref{18c3,,auditing event} @code{sys.set_asyncgen_hooks_firstiter} sin argumentos.

Lanza un @ref{18c3,,auditing event} @code{sys.set_asyncgen_hooks_finalizer} sin argumentos.

Se lanzan dos eventos de auditoría porque la API subyacente consta de dos llamadas, cada una de las cuales debe generar su propio evento.


Added in version 3.6: Ver 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} para más detalles, y para un ejemplo de referencia de un método `finalizer' ver la implementación de @code{asyncio.Loop.shutdown_asyncgens} en Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/main/Lib/asyncio/base_events.py}


@cartouche
@quotation Nota 
Esta función se ha añadido de forma provisional (consulte 
@geindex Python Enhancement Proposals; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para obtener más detalles).
@end quotation
@end cartouche
@end deffn

@geindex set_coroutine_origin_tracking_depth() (en el módulo sys)
@anchor{library/sys sys set_coroutine_origin_tracking_depth}@anchor{c14}
@deffn {Función} sys.set_coroutine_origin_tracking_depth (depth)

Allows enabling or disabling coroutine origin tracking. When
enabled, the @code{cr_origin} attribute on coroutine objects will
contain a tuple of (filename, line number, function name) tuples
describing the traceback where the coroutine object was created,
with the most recent call first. When disabled, @code{cr_origin} will
be @code{None}.

To enable, pass a `depth' value greater than zero; this sets the
number of frames whose information will be captured. To disable,
set `depth' to zero.

Esta configuración es específica de cada hilo.


Added in version 3.7.


@cartouche
@quotation Nota 
Esta función se ha añadido de forma provisional (consulte 
@geindex Python Enhancement Proposals; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para obtener más detalles). Úsela sólo para fines de depuración.
@end quotation
@end cartouche
@end deffn

@geindex activate_stack_trampoline() (en el módulo sys)
@anchor{library/sys sys activate_stack_trampoline}@anchor{51a}
@deffn {Función} sys.activate_stack_trampoline (backend, /)

Activa el trampolín `backend' del perfilador de pila. El único backend soportado es @code{"perf"}.

Stack trampolines cannot be activated if the JIT is active.

@ref{1d5a,,Availability}: Linux.


Added in version 3.12.



@subsubheading Ver también



@itemize *

@item 
@ref{2f8,,Soporte de Python para el perfilador perf de Linux}

@item 
@indicateurl{https://perf.wiki.kernel.org}
@end itemize

@end deffn

@geindex deactivate_stack_trampoline() (en el módulo sys)
@anchor{library/sys sys deactivate_stack_trampoline}@anchor{51b}
@deffn {Función} sys.deactivate_stack_trampoline ()

Desactive el backend del trampolín del perfilador de pila actual.

Si no se está ejecutando ningún perfilador, esta función no tiene efecto.

@ref{1d5a,,Availability}: Linux.


Added in version 3.12.

@end deffn

@geindex is_stack_trampoline_active() (en el módulo sys)
@anchor{library/sys sys is_stack_trampoline_active}@anchor{51c}
@deffn {Función} sys.is_stack_trampoline_active ()

Retorna @code{True} si un trampolín de perfil de pila está activo.

@ref{1d5a,,Availability}: Linux.


Added in version 3.12.

@end deffn

@geindex _enablelegacywindowsfsencoding() (en el módulo sys)
@anchor{library/sys sys _enablelegacywindowsfsencoding}@anchor{1e6}
@deffn {Función} sys._enablelegacywindowsfsencoding ()

Cambia la @ref{5dd,,codificación del sistema de archivos y manejo de errores} a “mbcs” y “replace” respectivamente, para mantener la coherencia con las versiones de Python anteriores a la 3.6.

Esto es equivalente a definir la variable de entorno 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} antes de iniciar Python.

También ver @ref{ce1,,sys.getfilesystemencoding()} y @ref{d6d,,sys.getfilesystemencodeerrors()}.

@ref{1d5a,,Availability}: Windows.

@cartouche
@quotation Nota 
Changing the filesystem encoding after Python startup is risky because
the old fsencoding or paths encoded by the old fsencoding may be cached
somewhere. Use 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} instead.
@end quotation
@end cartouche


Added in version 3.6: Consulte 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para obtener más detalles.



Deprecated since version 3.13, will be removed in version 3.16: Use 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} instead.

@end deffn

@geindex stdin (en el módulo sys)
@geindex stdout (en el módulo sys)
@geindex stderr (en el módulo sys)
@anchor{library/sys sys stdin}@anchor{5df}
@deffn {Dato} sys.stdin
@anchor{library/sys sys stdout}@anchor{b61}
@deffnx {Dato} sys.stdout
@anchor{library/sys sys stderr}@anchor{9cc}
@deffnx {Dato} sys.stderr

@ref{1230,,Objetos de archivo} utilizado por el intérprete para entradas, salidas y errores estándar:


@itemize *

@item 
@code{stdin} se usa para todas las entradas interactivas (incluidas las llamadas a @ref{1340,,input()});

@item 
@code{stdout} se usa para la salida de @ref{ff4,,print()} y @ref{1f85,,expression} y para las solicitudes de @ref{1340,,input()};

@item 
Las propias indicaciones del intérprete y sus mensajes de error van a @code{stderr}.
@end itemize

Estos flujos son regulares @ref{1c8d,,archivos de texto} como los retornados por la función @ref{1be,,open()}. Sus parámetros se eligen de la siguiente manera:


@itemize *

@item 
La codificación y manejo de error son inicializado desde @ref{496,,PyConfig.stdio_encoding}  y @ref{42ad,,PyConfig.stdio_errors}.

En Windows, se usa UTF-8 para el dispositivo de consola. Los dispositivos que no son caracteres, como archivos de disco y tuberías, utilizan la codificación de la configuración regional del sistema (por ejemplo, la página de códigos ANSI). Los dispositivos de caracteres que no son de consola, como NUL (es decir, donde @code{isatty()} retorna @code{True}) utilizan el valor de las páginas de códigos de entrada y salida de la consola al inicio, respectivamente para stdin y stdout/stderr. Esto pasa por defecto al sistema de @ref{39b,,codificación local} si el proceso no esta inicialmente acoplado a una consola.

El comportamiento especial de la consola se puede anular configurando la variable de entorno PYTHONLEGACYWINDOWSSTDIO antes de iniciar Python. En ese caso, las páginas de códigos de la consola se utilizan como para cualquier otro dispositivo de caracteres.

En todas las plataformas, puede anular la codificación de caracteres configurando la variable de entorno 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING} antes de iniciar Python o usando la nueva @ref{2e2,,-X} @code{utf8} opción de línea de comando y 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} variable de entorno. Sin embargo, para la consola de Windows, esto solo se aplica cuando 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@ref{ce3,,PYTHONLEGACYWINDOWSSTDIO} también está configurado.

@item 
Cuando es interactivo, el flujo de @code{stdout} se almacena en búfer de línea. En caso contrario, se almacena en búfer de bloque como los archivos de texto normales.  El flujo @code{stderr} tiene un búfer de línea en ambos casos.  Puede hacer que ambos flujos no tengan búfer pasando la opción de línea de comandos @ref{19ad,,-u} o estableciendo la variable de entorno 
@geindex PYTHONUNBUFFERED
@geindex variables de entorno; PYTHONUNBUFFERED
@ref{19ae,,PYTHONUNBUFFERED}.
@end itemize


Distinto en la versión 3.9: Ahora, @code{stderr} no interactivo tiene búfer de línea en lugar de búfer completo.


@cartouche
@quotation Nota 
Para escribir o leer datos binarios desde/hacia los flujos estándar, use el objeto binario subyacente @ref{130e,,buffer}. Por ejemplo, para escribir bytes en @ref{b61,,stdout}, use @code{sys.stdout.buffer.write(b'abc')}.

However, if you are writing a library (and do not control in which
context its code will be executed), be aware that the standard streams
may be replaced with file-like objects like @ref{fa9,,io.StringIO} which
do not support the @code{buffer} attribute.
@end quotation
@end cartouche
@end deffn

@geindex __stdin__ (en el módulo sys)
@geindex __stdout__ (en el módulo sys)
@geindex __stderr__ (en el módulo sys)
@anchor{library/sys sys __stdin__}@anchor{42ae}
@deffn {Dato} sys.__stdin__
@anchor{library/sys sys __stdout__}@anchor{2876}
@deffnx {Dato} sys.__stdout__
@anchor{library/sys sys __stderr__}@anchor{4087}
@deffnx {Dato} sys.__stderr__

Estos objetos contienen los valores originales de @code{stdin}, @code{stderr} y @code{stdout} al inicio del programa. Se utilizan durante la finalización y podrían ser útiles para imprimir en el flujo estándar real sin importar si el objeto @code{sys.std*} ha sido redirigido.

También se puede utilizar para restaurar los archivos reales a objetos de archivo de trabajo conocidos en caso de que se hayan sobrescrito con un objeto roto. Sin embargo, la forma preferida de hacer esto es guardar explícitamente la secuencia anterior antes de reemplazarla y restaurar el objeto guardado.

@cartouche
@quotation Nota 
En algunas condiciones, @code{stdin}, @code{stdout} y @code{stderr}, así como los valores originales @code{__stdin__}, @code{__stdout__} y @code{__stderr__} pueden ser @code{None} . Suele ser el caso de las aplicaciones GUI de Windows que no están conectadas a una consola y las aplicaciones Python que comienzan con @code{pythonw}.
@end quotation
@end cartouche
@end deffn

@geindex stdlib_module_names (en el módulo sys)
@anchor{library/sys sys stdlib_module_names}@anchor{8d8}
@deffn {Dato} sys.stdlib_module_names

Un fronzenset de strings que contiene los nombres de los módulos de la librería estándar.

Es lo mismo para todas las plataformas. Módulos que no están disponibles en algunas plataformas y deshabilitados durante la construcción de Python también son listados. Todos los tipos de modulo son listados: Python puro, incorporados, congelados y módulos de extensión. Módulos de prueba son excluidos.

Para paquete, solo el principal es listado; sub-paquetes y sub-módulos no son listados. Por ejemplo, el paquete @code{email} es listado, pero el sub-paquete @code{email.mime} y el sub-módulo @code{email.message} no es listado.

Consulte también la lista @ref{1c66,,sys.builtin_module_names}.


Added in version 3.10.

@end deffn

@geindex thread_info (en el módulo sys)
@anchor{library/sys sys thread_info}@anchor{11c1}
@deffn {Dato} sys.thread_info

Un @ref{6ef,,named tuple} que contiene información sobre la implementación del hilo.

@geindex name (atributo de sys.thread_info)
@anchor{library/sys sys thread_info name}@anchor{42af}
@deffn {Atributo} thread_info.name

El nombre de la implementación del hilo:


@itemize *

@item 
@code{"nt"}: hilos de Windows

@item 
@code{"pthread"}: hilos de POSIX

@item 
@code{"pthread-stubs"}: stub de hilos POSIX (en plataformas WebAssembly sin soporte de hilos)

@item 
@code{"solaris"}: hilos de Solaris
@end itemize
@end deffn

@geindex lock (atributo de sys.thread_info)
@anchor{library/sys sys thread_info lock}@anchor{42b0}
@deffn {Atributo} thread_info.lock

El nombre de la implementación del bloqueo:


@itemize *

@item 
@code{"semaphore"}: un bloqueo que utiliza un semáforo

@item 
@code{"mutex+cond"}: un bloqueo que utiliza un mutex y una variable de condición

@item 
@code{None} si esta información es desconocida
@end itemize
@end deffn

@geindex version (atributo de sys.thread_info)
@anchor{library/sys sys thread_info version}@anchor{42b1}
@deffn {Atributo} thread_info.version

El nombre y la versión de la biblioteca de subprocesos. Es una cadena, o @code{None} si se desconoce esta información.
@end deffn


Added in version 3.3.

@end deffn

@geindex tracebacklimit (en el módulo sys)
@anchor{library/sys sys tracebacklimit}@anchor{15dd}
@deffn {Dato} sys.tracebacklimit

Cuando esta variable se establece en un valor entero, determina el número máximo de niveles de información de rastreo que se imprime cuando ocurre una excepción no controlada. El valor predeterminado es @code{1000}. Cuando se establece en @code{0} o menos, toda la información de rastreo se suprime y solo se imprimen el tipo y el valor de excepción.
@end deffn

@geindex unraisablehook() (en el módulo sys)
@anchor{library/sys sys unraisablehook}@anchor{355}
@deffn {Función} sys.unraisablehook (unraisable, /)

Maneja una excepción que no se puede lanzar.

Se llama cuando se ha producido una excepción pero no hay forma de que Python la maneje. Por ejemplo, cuando un destructor lanza una excepción o durante la recolección de basura (@ref{acc,,gc.collect()}).

El argumento `unraisable' tiene los siguientes atributos:


@itemize *

@item 
@code{exc_type}: tipo de excepción.

@item 
@code{exc_value}: Valor de excepción, puede ser @code{None}.

@item 
@code{exc_traceback}: rastreo de excepción, puede ser @code{None}.

@item 
@code{err_msg}: Mensaje de error, puede ser @code{None}.

@item 
@code{object}: Objeto que causa la excepción, puede ser @code{None}.
@end itemize

El enlace predeterminado da formato a @code{err_msg} y @code{object} como: @code{f'@{err_msg@}: @{object!r@}'}; utilice el mensaje de error «Excepción ignorada en» si @code{err_msg} es @code{None}.

@ref{355,,sys.unraisablehook()} se puede anular para controlar cómo se manejan las excepciones que no se pueden evaluar.


@subsubheading Ver también


@ref{8a2,,excepthook()} que maneja excepciones no detectadas.


@cartouche
@quotation Advertencia 
Almacenar @code{exc_value} usando un gancho personalizado puede crear un ciclo de referencia. Se debe borrar explícitamente la interrupción del ciclo de referencia cuando la excepción ya no sea necesaria.

Almacenar @code{object} usando un gancho personalizado puede resucitarlo si está configurado en un objeto que se está finalizando. Evite almacenar @code{object} después de que se complete el gancho personalizado para evitar resucitar objetos.
@end quotation
@end cartouche

Genera un evento de auditoría @code{sys.unraisablehook} con los argumentos `hook', `unraisable' cuando ocurre una excepción que no se puede manejar. El objeto `unraisable' es el mismo que se pasará al gancho. Si no se ha establecido ningún gancho, `hook' puede ser @code{None}.


Added in version 3.8.

@end deffn

@geindex version (en el módulo sys)
@anchor{library/sys sys version}@anchor{2e4}
@deffn {Dato} sys.version

Una cadena de caracteres que contiene el número de versión del intérprete de Python más información adicional sobre el número de compilación y el compilador utilizado. Esta cadena se muestra cuando se inicia el intérprete interactivo. No extraiga información de la versión de él, en su lugar, use @ref{741,,version_info} y las funciones proporcionadas por el módulo @ref{aa,,platform}.
@end deffn

@geindex api_version (en el módulo sys)
@anchor{library/sys sys api_version}@anchor{42b2}
@deffn {Dato} sys.api_version

La versión de API C para este intérprete. Los programadores pueden encontrar esto útil al depurar conflictos de versiones entre Python y módulos de extensión.
@end deffn

@geindex version_info (en el módulo sys)
@anchor{library/sys sys version_info}@anchor{741}
@deffn {Dato} sys.version_info

Una tupla que contiene los cinco componentes del número de versión: `major', `minor', `micro', `releaselevel', y `serial'. Todos los valores excepto `releaselevel' son números enteros; el nivel de lanzamiento es @code{'alpha'}, @code{'beta'}, @code{'candidate'}, o @code{'final'}. El valor de @code{version_info} correspondiente a la versión 2.0 de Python es @code{(2, 0, 0, 'final', 0)}. También se puede acceder a los componentes por su nombre, por lo que @code{sys.version_info[0]} es equivalente a @code{sys.version_info.major} y así sucesivamente.


Distinto en la versión 3.1: Se agregaron atributos de componentes con nombre.

@end deffn

@geindex warnoptions (en el módulo sys)
@anchor{library/sys sys warnoptions}@anchor{279}
@deffn {Dato} sys.warnoptions

Este es un detalle de implementación del marco de advertencias; No modifique este valor. Consulte el módulo @ref{112,,warnings} para obtener más información sobre el marco de advertencias.
@end deffn

@geindex winver (en el módulo sys)
@anchor{library/sys sys winver}@anchor{42b3}
@deffn {Dato} sys.winver

El número de versión utilizado para formar claves de registro en plataformas Windows. Esto se almacena como recurso de cadena 1000 en la DLL de Python. El valor normalmente son las versiones principal y secundaria del intérprete de Python en ejecución. Se proporciona en el módulo @ref{d9,,sys} con fines informativos; modificar este valor no tiene ningún efecto en las claves de registro utilizadas por Python.

@ref{1d5a,,Availability}: Windows.
@end deffn


@deffn {Dato} sys.monitoring

Espacio de nombres(Namespace) que contiene funciones y constantes para registrar retrollamadas(callbacks) y controlar eventos de monitorización. Véase @ref{da,,sys.monitoring} para más detalles.
@end deffn

@geindex _xoptions (en el módulo sys)
@anchor{library/sys sys _xoptions}@anchor{1d45}
@deffn {Dato} sys._xoptions

Un diccionario de las diversas flags específicas de la implementación pasa a través de la opción de línea de comandos @ref{2e2,,-X}. Los nombres de las opciones se asignan a sus valores, si se dan explícitamente, o a @ref{c95,,True}. Ejemplo:

@example
$ ./python -Xa=b -Xc
Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50)
[GCC 4.4.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys._xoptions
@{'a': 'b', 'c': True@}
@end example

`Detalles de implementación de CPython:' Esta es una forma específica de CPython de acceder a las opciones que se pasan a través de @ref{2e2,,-X}. Otras implementaciones pueden exportarlos a través de otros medios, o no exportarlos.


Added in version 3.2.

@end deffn

@subsubheading Citas


@anchor{library/sys c99}@anchor{428e}@w{(C99)} 
ISO/CEI 9899:1999. «Lenguajes de programación - C.» Un borrador público de este estándar está disponible en @indicateurl{https://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf}.

@node sys monitoring — Execution event monitoring,sysconfig — Provide access to Python’s configuration information,sys — System-specific parameters and functions,Servicios en tiempo de ejecución de Python
@anchor{library/sys monitoring doc}@anchor{42b4}@anchor{library/sys monitoring module-sys monitoring}@anchor{da}@anchor{library/sys monitoring sys-monitoring-execution-event-monitoring}@anchor{42b5}
@subsection @code{sys.monitoring} — Execution event monitoring


@geindex module; sys.monitoring


Added in version 3.12.



__________________________________________________________________


@cartouche
@quotation Nota 
@ref{da,,sys.monitoring} is a namespace within the @ref{d9,,sys} module,
not an independent module, so there is no need to
@code{import sys.monitoring}, simply @code{import sys} and then use
@code{sys.monitoring}.
@end quotation
@end cartouche

Este espacio de nombres proporciona acceso a las funciones y constantes necesarias para activar y controlar el monitoreo de eventos.

As programs execute, events occur that might be of interest to tools that
monitor execution. The @ref{da,,sys.monitoring} namespace provides means to
receive callbacks when events of interest occur.

La API de monitoreo consta de tres componentes:


@itemize *

@item 
@ref{42b6,,Tool identifiers}

@item 
@ref{42b7,,Events}

@item 
@ref{42b8,,Callbacks}
@end itemize

@menu
* Identificadores de herramientas:: 
* Eventos:: 
* Activar y desactivar eventos:: 
* Registrando funciones de retrollamada:: 

@end menu

@node Identificadores de herramientas,Eventos,,sys monitoring — Execution event monitoring
@anchor{library/sys monitoring tool-identifiers}@anchor{42b6}
@subsubsection Identificadores de herramientas


A tool identifier is an integer and the associated name.
Tool identifiers are used to discourage tools from interfering with each
other and to allow multiple tools to operate at the same time.
Currently tools are completely independent and cannot be used to
monitor each other. This restriction may be lifted in the future.

Before registering or activating events, a tool should choose an identifier.
Identifiers are integers in the range 0 to 5 inclusive.

@menu
* Registro y uso de herramientas:: 

@end menu

@node Registro y uso de herramientas,,,Identificadores de herramientas
@anchor{library/sys monitoring registering-and-using-tools}@anchor{42b9}
@subsubsection Registro y uso de herramientas


@geindex use_tool_id() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring use_tool_id}@anchor{42ba}
@deffn {Función} sys.monitoring.use_tool_id (tool_id: int, name: str, /) -> None

Must be called before `tool_id' can be used.
`tool_id' must be in the range 0 to 5 inclusive.
Raises a @ref{360,,ValueError} if `tool_id' is in use.
@end deffn

@geindex clear_tool_id() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring clear_tool_id}@anchor{15c3}
@deffn {Función} sys.monitoring.clear_tool_id (tool_id: int, /) -> None

Unregister all events and callback functions associated with `tool_id'.
@end deffn

@geindex free_tool_id() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring free_tool_id}@anchor{42bb}
@deffn {Función} sys.monitoring.free_tool_id (tool_id: int, /) -> None

Should be called once a tool no longer requires `tool_id'.
Will call @ref{15c3,,clear_tool_id()} before releasing `tool_id'.
@end deffn

@geindex get_tool() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_tool}@anchor{42bc}
@deffn {Función} sys.monitoring.get_tool (tool_id: int, /) -> str | None

Returns the name of the tool if `tool_id' is in use,
otherwise it returns @code{None}.
`tool_id' must be in the range 0 to 5 inclusive.
@end deffn

La máquina virtual trata todos los ID de la misma manera con respecto a los eventos, pero los siguientes ID están predefinidos para facilitar la cooperación de las herramientas:

@example
sys.monitoring.DEBUGGER_ID = 0
sys.monitoring.COVERAGE_ID = 1
sys.monitoring.PROFILER_ID = 2
sys.monitoring.OPTIMIZER_ID = 5
@end example

@node Eventos,Activar y desactivar eventos,Identificadores de herramientas,sys monitoring — Execution event monitoring
@anchor{library/sys monitoring events}@anchor{42b7}
@subsubsection Eventos


Son aceptados los siguientes eventos:

@geindex BRANCH (monitoring event)
@anchor{library/sys monitoring monitoring-event-BRANCH}@anchor{42bd}
@deffn {monitoring-event} sys.monitoring.events.BRANCH

Una rama condicional es aceptada (o no).
@end deffn

@geindex CALL (monitoring event)
@anchor{library/sys monitoring monitoring-event-CALL}@anchor{1651}
@deffn {monitoring-event} sys.monitoring.events.CALL

Una llamada en código Python (el evento ocurre antes de la llamada).
@end deffn

@geindex C_RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RAISE}@anchor{42be}
@deffn {monitoring-event} sys.monitoring.events.C_RAISE

An exception raised from any callable, except for Python functions (event occurs after the exit).
@end deffn

@geindex C_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RETURN}@anchor{42bf}
@deffn {monitoring-event} sys.monitoring.events.C_RETURN

Return from any callable, except for Python functions (event occurs after the return).
@end deffn

@geindex EXCEPTION_HANDLED (monitoring event)
@anchor{library/sys monitoring monitoring-event-EXCEPTION_HANDLED}@anchor{42c0}
@deffn {monitoring-event} sys.monitoring.events.EXCEPTION_HANDLED

Se maneja una excepción.
@end deffn

@geindex INSTRUCTION (monitoring event)
@anchor{library/sys monitoring monitoring-event-INSTRUCTION}@anchor{42c1}
@deffn {monitoring-event} sys.monitoring.events.INSTRUCTION

Está a punto de ejecutarse una instrucción de VM.
@end deffn

@geindex JUMP (monitoring event)
@anchor{library/sys monitoring monitoring-event-JUMP}@anchor{42c2}
@deffn {monitoring-event} sys.monitoring.events.JUMP

Se realiza un salto incondicional en el gráfico de flujo de control.
@end deffn

@geindex LINE (monitoring event)
@anchor{library/sys monitoring monitoring-event-LINE}@anchor{42c3}
@deffn {monitoring-event} sys.monitoring.events.LINE

Está a punto de ejecutarse una instrucción que tiene un número de línea diferente al de la instrucción anterior.
@end deffn

@geindex PY_RESUME (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RESUME}@anchor{42c4}
@deffn {monitoring-event} sys.monitoring.events.PY_RESUME

Resumption of a Python function (for generator and coroutine functions), except for @code{throw()} calls.
@end deffn

@geindex PY_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RETURN}@anchor{42c5}
@deffn {monitoring-event} sys.monitoring.events.PY_RETURN

Retorna de una función Python (ocurre inmediatamente antes del retorno, el marco del destinatario estará en la pila).
@end deffn

@geindex PY_START (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_START}@anchor{42c6}
@deffn {monitoring-event} sys.monitoring.events.PY_START

Inicio de una función Python (ocurre inmediatamente después de la llamada, el marco del destinatario estará en la pila)
@end deffn

@geindex PY_THROW (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_THROW}@anchor{42c7}
@deffn {monitoring-event} sys.monitoring.events.PY_THROW

A Python function is resumed by a @code{throw()} call.
@end deffn

@geindex PY_UNWIND (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_UNWIND}@anchor{42c8}
@deffn {monitoring-event} sys.monitoring.events.PY_UNWIND

Salida de una función Python durante la resolución de excepciones.
@end deffn

@geindex PY_YIELD (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_YIELD}@anchor{42c9}
@deffn {monitoring-event} sys.monitoring.events.PY_YIELD

Rinde (`yield') desde una función Python (ocurre inmediatamente antes del rendimiento, el marco del destinatario estará en la pila).
@end deffn

@geindex RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RAISE}@anchor{1612}
@deffn {monitoring-event} sys.monitoring.events.RAISE

An exception is raised, except those that cause a @ref{42ca,,STOP_ITERATION} event.
@end deffn

@geindex RERAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RERAISE}@anchor{42cb}
@deffn {monitoring-event} sys.monitoring.events.RERAISE

An exception is re-raised, for example at the end of a @ref{a5c,,finally} block.
@end deffn

@geindex STOP_ITERATION (monitoring event)
@anchor{library/sys monitoring monitoring-event-STOP_ITERATION}@anchor{42ca}
@deffn {monitoring-event} sys.monitoring.events.STOP_ITERATION

An artificial @ref{c82,,StopIteration} is raised; see @ref{42cc,,the STOP_ITERATION event}.
@end deffn

Es posible que se agreguen más eventos en el futuro.

These events are attributes of the @code{sys.monitoring.events} namespace.
Each event is represented as a power-of-2 integer constant.
To define a set of events, simply bitwise or the individual events together.
For example, to specify both @ref{42c5,,PY_RETURN} and @ref{42c6,,PY_START}
events, use the expression @code{PY_RETURN | PY_START}.

@geindex NO_EVENTS (monitoring event)
@anchor{library/sys monitoring monitoring-event-NO_EVENTS}@anchor{42cd}
@deffn {monitoring-event} sys.monitoring.events.NO_EVENTS

An alias for @code{0} so users can do explicit comparisons like:

@example
if get_events(DEBUGGER_ID) == NO_EVENTS:
    ...
@end example
@end deffn

Los eventos se dividen en tres grupos:

@menu
* Eventos locales:: 
* Eventos auxiliares:: 
* Otros eventos:: 
* El evento STOP_ITERATION:: 

@end menu

@node Eventos locales,Eventos auxiliares,,Eventos
@anchor{library/sys monitoring local-events}@anchor{42ce}
@subsubsection Eventos locales


Los eventos locales están asociados con la ejecución normal del programa y ocurren en lugares claramente definidos. Todos los eventos locales se pueden desactivar. Los eventos locales son:


@itemize *

@item 
@ref{42c6,,PY_START}

@item 
@ref{42c4,,PY_RESUME}

@item 
@ref{42c5,,PY_RETURN}

@item 
@ref{42c9,,PY_YIELD}

@item 
@ref{1651,,CALL}

@item 
@ref{42c3,,LINE}

@item 
@ref{42c1,,INSTRUCTION}

@item 
@ref{42c2,,JUMP}

@item 
@ref{42bd,,BRANCH}

@item 
@ref{42ca,,STOP_ITERATION}
@end itemize

@node Eventos auxiliares,Otros eventos,Eventos locales,Eventos
@anchor{library/sys monitoring ancillary-events}@anchor{42cf}
@subsubsection Eventos auxiliares


Los eventos auxiliares se pueden monitorear como otros eventos, pero están controlados por otros eventos:


@itemize *

@item 
@ref{42be,,C_RAISE}

@item 
@ref{42bf,,C_RETURN}
@end itemize

The @ref{42bf,,C_RETURN} and @ref{42be,,C_RAISE} events
are controlled by the @ref{1651,,CALL} event.
@ref{42bf,,C_RETURN} and @ref{42be,,C_RAISE} events will only be seen if the
corresponding @ref{1651,,CALL} event is being monitored.

@node Otros eventos,El evento STOP_ITERATION,Eventos auxiliares,Eventos
@anchor{library/sys monitoring other-events}@anchor{42d0}
@subsubsection Otros eventos


Otros eventos no están necesariamente vinculados a una ubicación específica del programa y no se pueden desactivar individualmente.

Los otros eventos que se pueden monitorear son:


@itemize *

@item 
@ref{42c7,,PY_THROW}

@item 
@ref{42c8,,PY_UNWIND}

@item 
@ref{1612,,RAISE}

@item 
@ref{42c0,,EXCEPTION_HANDLED}
@end itemize

@node El evento STOP_ITERATION,,Otros eventos,Eventos
@anchor{library/sys monitoring the-stop-iteration-event}@anchor{42cc}
@subsubsection El evento STOP_ITERATION


@geindex Python Enhancement Proposals; PEP 380#use-of-stopiteration-to-return-values
PEP 380@footnote{https://peps.python.org/pep-0380/#use-of-stopiteration-to-return-values}
specifies that a @ref{c82,,StopIteration} exception is raised when returning a value
from a generator or coroutine. However, this is a very inefficient way to
return a value, so some Python implementations, notably CPython 3.12+, do not
raise an exception unless it would be visible to other code.

To allow tools to monitor for real exceptions without slowing down generators
and coroutines, the @ref{42ca,,STOP_ITERATION} event is provided.
@ref{42ca,,STOP_ITERATION} can be locally disabled, unlike @ref{1612,,RAISE}.

Note that the @ref{42ca,,STOP_ITERATION} event and the @ref{1612,,RAISE}
event for a @ref{c82,,StopIteration} exception are equivalent, and are treated as interchangeable
when generating events. Implementations will favor @ref{42ca,,STOP_ITERATION} for
performance reasons, but may generate a @ref{1612,,RAISE} event with a @ref{c82,,StopIteration}.

@node Activar y desactivar eventos,Registrando funciones de retrollamada,Eventos,sys monitoring — Execution event monitoring
@anchor{library/sys monitoring turning-events-on-and-off}@anchor{42d1}
@subsubsection Activar y desactivar eventos


In order to monitor an event, it must be turned on and a corresponding callback
must be registered.
Events can be turned on or off by setting the events either globally or
for a particular code object.

@menu
* Configuración de eventos globalmente:: 
* Eventos por objeto de código:: 
* Deshabilitando eventos:: 

@end menu

@node Configuración de eventos globalmente,Eventos por objeto de código,,Activar y desactivar eventos
@anchor{library/sys monitoring setting-events-globally}@anchor{42d2}
@subsubsection Configuración de eventos globalmente


Los eventos se pueden controlar globalmente modificando el conjunto de eventos que están siendo monitoreados.

@geindex get_events() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_events}@anchor{42d3}
@deffn {Función} sys.monitoring.get_events (tool_id: int, /) -> int

Retorna el @code{int} que representa todos los eventos activos.
@end deffn

@geindex set_events() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring set_events}@anchor{42d4}
@deffn {Función} sys.monitoring.set_events (tool_id: int, event_set: int, /) -> None

Activates all events which are set in `event_set'.
Raises a @ref{360,,ValueError} if `tool_id' is not in use.
@end deffn

No hay eventos activos de forma predeterminada.

@node Eventos por objeto de código,Deshabilitando eventos,Configuración de eventos globalmente,Activar y desactivar eventos
@anchor{library/sys monitoring per-code-object-events}@anchor{42d5}
@subsubsection Eventos por objeto de código


Events can also be controlled on a per code object basis. The functions
defined below which accept a @ref{1d8,,types.CodeType} should be prepared
to accept a look-alike object from functions which are not defined
in Python (see @ref{2c8,,Monitoring C API}).

@geindex get_local_events() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_local_events}@anchor{42d6}
@deffn {Función} sys.monitoring.get_local_events (tool_id: int, code: CodeType, /) -> int

Returns all the local events for `code'
@end deffn

@geindex set_local_events() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring set_local_events}@anchor{42d7}
@deffn {Función} sys.monitoring.set_local_events (tool_id: int, code: CodeType, event_set: int, /) -> None

Activates all the local events for `code' which are set in `event_set'.
Raises a @ref{360,,ValueError} if `tool_id' is not in use.
@end deffn

Los eventos locales se suman a los eventos globales, pero no los enmascaran. En otras palabras, todos los eventos globales se activarán para un objeto de código, independientemente de los eventos locales.

@node Deshabilitando eventos,,Eventos por objeto de código,Activar y desactivar eventos
@anchor{library/sys monitoring disabling-events}@anchor{42d8}
@subsubsection Deshabilitando eventos


@geindex DISABLE (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring DISABLE}@anchor{42d9}
@deffn {Dato} sys.monitoring.DISABLE

A special value that can be returned from a callback function to disable
events for the current code location.
@end deffn

Local events can be disabled for a specific code location by returning
@ref{42d9,,sys.monitoring.DISABLE} from a callback function. This does not change
which events are set, or any other code locations for the same event.

Deshabilitar eventos para ubicaciones específicas es muy importante para el monitoreo de alto rendimiento. Por ejemplo, un programa se puede ejecutar con un depurador sin gastos adicionales si el depurador desactiva toda la supervisión excepto algunos puntos de interrupción.

@geindex restart_events() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring restart_events}@anchor{42da}
@deffn {Función} sys.monitoring.restart_events () -> None

Enable all the events that were disabled by @ref{42d9,,sys.monitoring.DISABLE}
for all tools.
@end deffn

@node Registrando funciones de retrollamada,,Activar y desactivar eventos,sys monitoring — Execution event monitoring
@anchor{library/sys monitoring callbacks}@anchor{42b8}@anchor{library/sys monitoring registering-callback-functions}@anchor{42db}
@subsubsection Registrando funciones de retrollamada


Para registrar un invocable para eventos llame

@geindex register_callback() (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring register_callback}@anchor{42dc}
@deffn {Función} sys.monitoring.register_callback (tool_id: int, event: int, func: Callable | None, /) -> Callable | None

Registers the callable `func' for the `event' with the given `tool_id'

If another callback was registered for the given `tool_id' and `event',
it is unregistered and returned.
Otherwise @ref{42dc,,register_callback()} returns @code{None}.
@end deffn

Funciones pueden ser canceladas llamando @code{sys.monitoring.register_callback(tool_id, event, None)}.

Las funciones de retrollamada se pueden registrar y cancelar en cualquier momento.

Registering or unregistering a callback function will generate a @ref{15af,,sys.audit()} event.

@menu
* Argumentos de la función de retrollamada:: 

@end menu

@node Argumentos de la función de retrollamada,,,Registrando funciones de retrollamada
@anchor{library/sys monitoring callback-function-arguments}@anchor{42dd}
@subsubsection Argumentos de la función de retrollamada


@geindex MISSING (en el módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring MISSING}@anchor{42de}
@deffn {Dato} sys.monitoring.MISSING

A special value that is passed to a callback function to indicate
that there are no arguments to the call.
@end deffn

Cuando ocurre un evento activo, se llama a la función de retrollamada registrada. Diferentes eventos proporcionarán a la función de retrollamada con diferentes argumentos, de la siguiente manera:


@itemize *

@item 
@ref{42c6,,PY_START} and @ref{42c4,,PY_RESUME}:

@example
func(code: CodeType, instruction_offset: int) -> DISABLE | Any
@end example

@item 
@ref{42c5,,PY_RETURN} and @ref{42c9,,PY_YIELD}:

@example
func(code: CodeType, instruction_offset: int, retval: object) -> DISABLE | Any
@end example

@item 
@ref{1651,,CALL}, @ref{42be,,C_RAISE} and @ref{42bf,,C_RETURN}:

@example
func(code: CodeType, instruction_offset: int, callable: object, arg0: object | MISSING) -> DISABLE | Any
@end example

If there are no arguments, `arg0' is set to @ref{42de,,sys.monitoring.MISSING}.

@item 
@ref{1612,,RAISE}, @ref{42cb,,RERAISE}, @ref{42c0,,EXCEPTION_HANDLED},
@ref{42c8,,PY_UNWIND}, @ref{42c7,,PY_THROW} and @ref{42ca,,STOP_ITERATION}:

@example
func(code: CodeType, instruction_offset: int, exception: BaseException) -> DISABLE | Any
@end example

@item 
@ref{42c3,,LINE}:

@example
func(code: CodeType, line_number: int) -> DISABLE | Any
@end example

@item 
@ref{42bd,,BRANCH} and @ref{42c2,,JUMP}:

@example
func(code: CodeType, instruction_offset: int, destination_offset: int) -> DISABLE | Any
@end example

Note that the `destination_offset' is where the code will next execute.
For an untaken branch this will be the offset of the instruction following
the branch.

@item 
@ref{42c1,,INSTRUCTION}:

@example
func(code: CodeType, instruction_offset: int) -> DISABLE | Any
@end example
@end itemize

@node sysconfig — Provide access to Python’s configuration information,builtins — Built-in objects,sys monitoring — Execution event monitoring,Servicios en tiempo de ejecución de Python
@anchor{library/sysconfig doc}@anchor{42df}@anchor{library/sysconfig module-sysconfig}@anchor{db}@anchor{library/sysconfig sysconfig-provide-access-to-python-s-configuration-information}@anchor{42e0}
@subsection @code{sysconfig} — Provide access to Python’s configuration information


@geindex module; sysconfig


Added in version 3.2.


`Source code:' Lib/sysconfig@footnote{https://github.com/python/cpython/tree/main/Lib/sysconfig}

@geindex configuration information


__________________________________________________________________


El módulo @ref{db,,sysconfig} proporcionado acceso a la información de configuración de Python, como la lista de rutas de instalación y las variables de configuración relevantes para la plataforma actual.

@menu
* Variables de configuración:: 
* Rutas de instalación:: 
* User scheme:: 
* Home scheme:: 
* Prefix scheme:: 
* Installation path functions:: 
* Otras funciones: Otras funciones<3>. 
* Usando sysconfig como un script:: 

@end menu

@node Variables de configuración,Rutas de instalación,,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig configuration-variables}@anchor{42e1}
@subsubsection Variables de configuración


A Python distribution contains a @code{Makefile} and a @code{pyconfig.h}
header file that are necessary to build both the Python binary itself and
third-party C extensions compiled using @code{setuptools}.

@ref{db,,sysconfig} coloca todas las variables que se encuentran en estos archivos un diccionario al que se puede acceder usando @ref{10a8,,get_config_vars()} o @ref{10a7,,get_config_var()}.

Tenga en cuenta que en Windows, es un conjunto mucho más pequeño.

@geindex get_config_vars() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_vars}@anchor{10a8}
@deffn {Función} sysconfig.get_config_vars (*args)

Sin argumentos, retorna un diccionario de todas las variables de configuración relevantes para la plataforma actual.

Con argumentos, retorna un lista de valores que resultan de buscar cada argumento en el diccionario de variables de configuración.

Por cada argumento, si no se encuentra el valor, retorna @code{None}.
@end deffn

@geindex get_config_var() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_var}@anchor{10a7}
@deffn {Función} sysconfig.get_config_var (name)

Retorna el valor de un solo nombre de variable (`name'). Equivalente a @code{get_config_vars().get(name)}.

Si no se encuentra `name', retorna @code{None}.
@end deffn

Ejemplos de uso:

@example
>>> import sysconfig
>>> sysconfig.get_config_var('Py_ENABLE_SHARED')
0
>>> sysconfig.get_config_var('LIBDIR')
'/usr/local/lib'
>>> sysconfig.get_config_vars('AR', 'CXX')
['ar', 'g++']
@end example

@node Rutas de instalación,User scheme,Variables de configuración,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig id1}@anchor{42e2}@anchor{library/sysconfig installation-paths}@anchor{730}
@subsubsection Rutas de instalación


Python uses an installation scheme that differs depending on the platform and on
the installation options.  These schemes are stored in @ref{db,,sysconfig} under
unique identifiers based on the value returned by @ref{2b06,,os.name}.
The schemes are used by package installers to determine where to copy files to.

Python actualmente admite nueve esquemas:


@itemize -

@item 
`posix_prefix': esquema para plataformas POSIX como Linux o macOS. Este es el esquema predeterminado que se usa cuando se instala Python o un componente.

@item 
`posix_home': scheme for POSIX platforms, when the `home' option is used.
This scheme defines paths located under a specific home prefix.

@item 
`posix_user': scheme for POSIX platforms, when the `user' option is used.
This scheme defines paths located under the user’s home directory
(@ref{1384,,site.USER_BASE}).

@item 
`posix_venv': scheme for @ref{111,,Python virtual environments} on POSIX
platforms; by default it is the same as `posix_prefix'.

@item 
`nt': scheme for Windows.
This is the default scheme used when Python or a component is installed.

@item 
`nt_user': scheme for Windows, when the `user' option is used.

@item 
`nt_venv': scheme for @ref{111,,Python virtual environments} on Windows;
by default it is the same as `nt'.

@item 
`venv': a scheme with values from either `posix_venv' or `nt_venv' depending
on the platform Python runs on.

@item 
`nt_user': esquema para macOS, cuando se usa la opción `user'.
@end itemize

Cada esquema está compuesto por una serie de rutas y cada ruta tiene un identificador único. Python actualmente usa ocho rutas:


@itemize -

@item 
`stdlib': directorio que contiene los archivos de la biblioteca estándar de Python que no son específicos de la plataforma.

@item 
`platstdlib': directorio que contiene los archivos de la biblioteca estándar de Python que son específicos de la plataforma.

@item 
`platlib': directorio para archivos específicos del sitio, específicos de la plataforma.

@item 
`purelib': directory for site-specific, non-platform-specific files (“pure” Python).

@item 
`include': directorio para plataformas no especificadas para archivos de encabezado de Python C-API.

@item 
`include': directorio para plataformas especificadas para archivos de encabezado de Python C-API.

@item 
`scripts': directorio para archivos de script.

@item 
`data': directorio para archivos de datos.
@end itemize

@node User scheme,Home scheme,Rutas de instalación,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig sysconfig-user-scheme}@anchor{1d4d}@anchor{library/sysconfig user-scheme}@anchor{42e3}
@subsubsection User scheme


This scheme is designed to be the most convenient solution for users that don’t
have write permission to the global site-packages directory or don’t want to
install into it.

Files will be installed into subdirectories of @ref{1384,,site.USER_BASE} (written
as @code{`userbase'} hereafter).  This scheme installs pure Python modules and
extension modules in the same location (also known as @ref{1d3b,,site.USER_SITE}).

@menu
* posix_user:: 
* nt_user:: 
* osx_framework_user:: 

@end menu

@node posix_user,nt_user,,User scheme
@anchor{library/sysconfig posix-user}@anchor{42e4}
@subsubsection @code{posix_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`userbase'/lib/python`X.Y'}

@item

`platstdlib'

@tab

@code{`userbase'/lib/python`X.Y'}

@item

`platlib'

@tab

@code{`userbase'/lib/python`X.Y'/site-packages}

@item

`purelib'

@tab

@code{`userbase'/lib/python`X.Y'/site-packages}

@item

`include'

@tab

@code{`userbase'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`userbase'/bin}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node nt_user,osx_framework_user,posix_user,User scheme
@anchor{library/sysconfig nt-user}@anchor{42e5}
@subsubsection @code{nt_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`userbase'\Python`XY'}

@item

`platstdlib'

@tab

@code{`userbase'\Python`XY'}

@item

`platlib'

@tab

@code{`userbase'\Python`XY'\site-packages}

@item

`purelib'

@tab

@code{`userbase'\Python`XY'\site-packages}

@item

`include'

@tab

@code{`userbase'\Python`XY'\Include}

@item

`scripts'

@tab

@code{`userbase'\Python`XY'\Scripts}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node osx_framework_user,,nt_user,User scheme
@anchor{library/sysconfig osx-framework-user}@anchor{42e6}
@subsubsection @code{osx_framework_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`userbase'/lib/python}

@item

`platstdlib'

@tab

@code{`userbase'/lib/python}

@item

`platlib'

@tab

@code{`userbase'/lib/python/site-packages}

@item

`purelib'

@tab

@code{`userbase'/lib/python/site-packages}

@item

`include'

@tab

@code{`userbase'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`userbase'/bin}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node Home scheme,Prefix scheme,User scheme,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig home-scheme}@anchor{42e7}@anchor{library/sysconfig sysconfig-home-scheme}@anchor{42e8}
@subsubsection Home scheme


The idea behind the «home scheme» is that you build and maintain a personal
stash of Python modules.  This scheme’s name is derived from the idea of a
«home» directory on Unix, since it’s not unusual for a Unix user to make their
home directory have a layout similar to @code{/usr/} or @code{/usr/local/}.
This scheme can be used by anyone, regardless of the operating system they
are installing for.

@menu
* posix_home:: 

@end menu

@node posix_home,,,Home scheme
@anchor{library/sysconfig posix-home}@anchor{42e9}
@subsubsection @code{posix_home}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`home'/lib/python}

@item

`platstdlib'

@tab

@code{`home'/lib/python}

@item

`platlib'

@tab

@code{`home'/lib/python}

@item

`purelib'

@tab

@code{`home'/lib/python}

@item

`include'

@tab

@code{`home'/include/python}

@item

`platinclude'

@tab

@code{`home'/include/python}

@item

`scripts'

@tab

@code{`home'/bin}

@item

`data'

@tab

@code{`home'}

@end multitable


@node Prefix scheme,Installation path functions,Home scheme,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig prefix-scheme}@anchor{42ea}@anchor{library/sysconfig sysconfig-prefix-scheme}@anchor{42eb}
@subsubsection Prefix scheme


The «prefix scheme» is useful when you wish to use one Python installation to
perform the build/install (i.e., to run the setup script), but install modules
into the third-party module directory of a different Python installation (or
something that looks like a different Python installation).  If this sounds a
trifle unusual, it is—that’s why the user and home schemes come before.  However,
there are at least two known cases where the prefix scheme will be useful.

First, consider that many Linux distributions put Python in @code{/usr}, rather
than the more traditional @code{/usr/local}.  This is entirely appropriate,
since in those cases Python is part of «the system» rather than a local add-on.
However, if you are installing Python modules from source, you probably want
them to go in @code{/usr/local/lib/python2.`X'} rather than
@code{/usr/lib/python2.`X'}.

Another possibility is a network filesystem where the name used to write to a
remote directory is different from the name used to read it: for example, the
Python interpreter accessed as @code{/usr/local/bin/python} might search for
modules in @code{/usr/local/lib/python2.`X'}, but those modules would have to
be installed to, say, @code{/mnt/`@@server'/export/lib/python2.`X'}.

@menu
* posix_prefix:: 
* nt:: 

@end menu

@node posix_prefix,nt,,Prefix scheme
@anchor{library/sysconfig posix-prefix}@anchor{42ec}
@subsubsection @code{posix_prefix}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`prefix'/lib/python`X.Y'}

@item

`platstdlib'

@tab

@code{`prefix'/lib/python`X.Y'}

@item

`platlib'

@tab

@code{`prefix'/lib/python`X.Y'/site-packages}

@item

`purelib'

@tab

@code{`prefix'/lib/python`X.Y'/site-packages}

@item

`include'

@tab

@code{`prefix'/include/python`X.Y'}

@item

`platinclude'

@tab

@code{`prefix'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`prefix'/bin}

@item

`data'

@tab

@code{`prefix'}

@end multitable


@node nt,,posix_prefix,Prefix scheme
@anchor{library/sysconfig nt}@anchor{42ed}
@subsubsection @code{nt}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

Installation directory

@item

`stdlib'

@tab

@code{`prefix'\Lib}

@item

`platstdlib'

@tab

@code{`prefix'\Lib}

@item

`platlib'

@tab

@code{`prefix'\Lib\site-packages}

@item

`purelib'

@tab

@code{`prefix'\Lib\site-packages}

@item

`include'

@tab

@code{`prefix'\Include}

@item

`platinclude'

@tab

@code{`prefix'\Include}

@item

`scripts'

@tab

@code{`prefix'\Scripts}

@item

`data'

@tab

@code{`prefix'}

@end multitable


@node Installation path functions,Otras funciones<3>,Prefix scheme,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig installation-path-functions}@anchor{42ee}
@subsubsection Installation path functions


@ref{db,,sysconfig} provides some functions to determine these installation paths.

@geindex get_scheme_names() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_scheme_names}@anchor{42ef}
@deffn {Función} sysconfig.get_scheme_names ()

Retorna una tupla que contiene todos los esquemas admitidos actualmente en @ref{db,,sysconfig}.
@end deffn

@geindex get_default_scheme() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_default_scheme}@anchor{182a}
@deffn {Función} sysconfig.get_default_scheme ()

Retorna el nombre del esquema predeterminado para la plataforma actual.


Added in version 3.10: Esta función se llamaba anteriormente @code{_get_default_scheme()} y se consideraba un detalle de implementación.



Distinto en la versión 3.11: Cuando Python se ejecuta desde un entorno virtual, este retorna el esquema `venv'.

@end deffn

@geindex get_preferred_scheme() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_preferred_scheme}@anchor{731}
@deffn {Función} sysconfig.get_preferred_scheme (key)

Retorna un nombre de esquema preferido para un diseño de instalación especificado por `key'.

`key' debe ser @code{"prefix"}, @code{"home"} o @code{"user"}.

El valor de retorno es un nombre de esquema que aparece en @ref{42ef,,get_scheme_names()}. Se puede pasar a funciones @ref{db,,sysconfig} que toman un argumento `scheme', como @ref{12b1,,get_paths()}.


Added in version 3.10.



Distinto en la versión 3.11: Cuando Python se ejecuta desde un entorno virtual con @code{key="prefix"}, este retorna el esquema `venv'.

@end deffn

@geindex _get_preferred_schemes() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig _get_preferred_schemes}@anchor{42f0}
@deffn {Función} sysconfig._get_preferred_schemes ()

Retorna un diccionario que contiene los nombres de los esquemas preferidos en la plataforma actual. Los implementadores y redistribuidores de Python pueden agregar sus esquemas preferidos al valor global de nivel de módulo @code{_INSTALL_SCHEMES} y modificar esta función para devolver esos nombres de esquema, p. Ej. proporcionan diferentes esquemas para que los utilicen los administradores de paquetes de idioma y sistema, de modo que los paquetes instalados por uno no se mezclen con los del otro.

End users should not use this function, but @ref{182a,,get_default_scheme()} and
@ref{731,,get_preferred_scheme()} instead.


Added in version 3.10.

@end deffn

@geindex get_path_names() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_path_names}@anchor{42f1}
@deffn {Función} sysconfig.get_path_names ()

Retorna una tupla que contiene todo los nombres de rutas admitidos actualmente en @ref{db,,sysconfig}.
@end deffn

@geindex get_path() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_path}@anchor{1395}
@deffn {Función} sysconfig.get_path (name[, scheme[, vars[, expand]]])

Retorna una ruta de instalación correspondiente a la ruta `name', del esquema de instalación denominado `scheme'.

`name' tiene que ser un valor de la lista retornado por @ref{42f1,,get_path_names()}.

@ref{db,,sysconfig} almacena las rutas de instalación correspondientes a cada nombre de ruta, para cada plataforma, con variables que se expandirán. Por ejemplo, la ruta `stdlib' para el esquema `nt' es: @code{@{base@}/Lib}.

@ref{1395,,get_path()} utilizará las variables retornadas por @ref{10a8,,get_config_vars()} para expandir la ruta. Todas las variables tienen valores predeterminados para cada plataforma, por lo que se puede llamar a esta función y obtener el valor predeterminado.

Si se proporciona el esquema (`scheme'), debe ser un valor de la lista retornada por @ref{42ef,,get_scheme_names()}. De lo contrario, se utiliza el esquema predeterminado para la plataforma actual.

If `vars' is provided, it must be a dictionary of variables that will update
the dictionary returned by @ref{10a8,,get_config_vars()}.

Si `expand' se establece en @code{False}, la ruta no se expandirá usando las variables.

Si no se encuentra `name', lanza un @ref{438,,KeyError}.
@end deffn

@geindex get_paths() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_paths}@anchor{12b1}
@deffn {Función} sysconfig.get_paths ([scheme[, vars[, expand]]])

Retorna un diccionario de contiene todas las rutas de instalación correspondientes a un esquema de instalación. Consulte @ref{1395,,get_path()} para obtener más información.

Si no se proporciona el esquema (`scheme'), utilizará el esquema predeterminado para la plataforma actual.

Si se proporciona `vars', debe ser un diccionario de variables que actualizará el diccionario utilizado para expandir las rutas.

Si `expand' se establece en falso, las rutas no se expandirán.

Si `scheme' no es un esquema existente, @ref{12b1,,get_paths()} lanzará un @ref{438,,KeyError}.
@end deffn

@node Otras funciones<3>,Usando sysconfig como un script,Installation path functions,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig other-functions}@anchor{42f2}
@subsubsection Otras funciones


@geindex get_python_version() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_python_version}@anchor{12b0}
@deffn {Función} sysconfig.get_python_version ()

Retorna el número de versión versión @code{MAJOR.MINOR} de Python como una cadena. Similar a @code{'%d.%d' % sys.version_info[:2]}.
@end deffn

@geindex get_platform() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_platform}@anchor{12af}
@deffn {Función} sysconfig.get_platform ()

Retorna una cadena que identifica la plataforma actual.

This is used mainly to distinguish platform-specific build directories and
platform-specific built distributions.  Typically includes the OS name and
version and the architecture (as supplied by @ref{1188,,os.uname()}), although the
exact information included depends on the OS; e.g., on Linux, the kernel
version isn’t particularly important.

Ejemplo de valores retornados:


@itemize -

@item 
linux-i586

@item 
linux-alpha (?)

@item 
solaris-2.6-sun4u
@end itemize

Windows retornará uno de:


@itemize -

@item 
win-amd64 (Windows de 64 bits en AMD64, también conocido como x86_64, Intel64 y EM64T)

@item 
win32 (todos los demás - específicamente se retorna sys.platform)
@end itemize

macOS puede retornar:


@itemize -

@item 
macosx-10.6-ppc

@item 
macosx-10.4-ppc64

@item 
macosx-10.3-i386

@item 
macosx-10.4-fat
@end itemize

Para otras plataformas que no son POSIX, actualmente solo retorna @ref{b19,,sys.platform}.
@end deffn

@geindex is_python_build() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig is_python_build}@anchor{1fc}
@deffn {Función} sysconfig.is_python_build ()

Retorna @code{True} si el intérprete de Python en ejecución se compiló a partir de la fuente y se está ejecutando desde su ubicación compilada, y no desde una ubicación resultante de por ejemplo ejecutando @code{make install} o instalando a través de un instalador binario.
@end deffn

@geindex parse_config_h() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig parse_config_h}@anchor{42f3}
@deffn {Función} sysconfig.parse_config_h (fp[, vars])

Analiza un archivo de estilo @code{config.h}.

`fp' es un objeto similar a un archivo que apunta al archivo similar a @code{config.h}.

Se retorna un diccionario que contiene pares de nombre/valor. Si se pasa un diccionario opcional como un segundo argumento, se utiliza en lugar de un nuevo diccionario y se actualiza con los valores leídos en el archivo.
@end deffn

@geindex get_config_h_filename() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_h_filename}@anchor{42f4}
@deffn {Función} sysconfig.get_config_h_filename ()

Retorna la ruta de @code{pyconfig.h}.
@end deffn

@geindex get_makefile_filename() (en el módulo sysconfig)
@anchor{library/sysconfig sysconfig get_makefile_filename}@anchor{42f5}
@deffn {Función} sysconfig.get_makefile_filename ()

Retorna la ruta de @code{Makefile}.
@end deffn

@node Usando sysconfig como un script,,Otras funciones<3>,sysconfig — Provide access to Python’s configuration information
@anchor{library/sysconfig sysconfig-cli}@anchor{42f6}@anchor{library/sysconfig using-sysconfig-as-a-script}@anchor{42f7}
@subsubsection Usando @code{sysconfig} como un script


Puedes usar @ref{db,,sysconfig} como un script con la opción `-m' de Python:

@example
$ python -m sysconfig
Platform: "macosx-10.4-i386"
Python version: "3.2"
Current installation scheme: "posix_prefix"

Paths:
        data = "/usr/local"
        include = "/Users/tarek/Dev/svn.python.org/py3k/Include"
        platinclude = "."
        platlib = "/usr/local/lib/python3.2/site-packages"
        platstdlib = "/usr/local/lib/python3.2"
        purelib = "/usr/local/lib/python3.2/site-packages"
        scripts = "/usr/local/bin"
        stdlib = "/usr/local/lib/python3.2"

Variables:
        AC_APPLE_UNIVERSAL_BUILD = "0"
        AIX_GENUINE_CPLUSPLUS = "0"
        AR = "ar"
        ARFLAGS = "rc"
        ...
@end example

Esta llamada imprimirá en la salida estándar la información retornada por @ref{12af,,get_platform()}, @ref{12b0,,get_python_version()}, @ref{1395,,get_path()} y @ref{10a8,,get_config_vars()}.

@node builtins — Built-in objects,__main__ — Top-level code environment,sysconfig — Provide access to Python’s configuration information,Servicios en tiempo de ejecución de Python
@anchor{library/builtins doc}@anchor{42f8}@anchor{library/builtins builtins-built-in-objects}@anchor{42f9}@anchor{library/builtins module-builtins}@anchor{13}
@subsection @code{builtins} — Built-in objects


@geindex module; builtins


__________________________________________________________________


This module provides direct access to all “built-in” identifiers of Python; for
example, @code{builtins.open} is the full name for the built-in function @ref{1be,,open()}.

Este módulo normalmente no es accedido explícitamente por la mayoría de las aplicaciones, pero puede ser útil en módulos que provean objetos con el mismo nombre que un valor incorporado, pero que sea necesario también el incorporado con ese nombre. Por ejemplo, en un módulo que quiera implementar una función @ref{1be,,open()} que envuelva la integrada @ref{1be,,open()}, este módulo puede se usado directamente:

@example
import builtins

def open(path):
    f = builtins.open(path, 'r')
    return UpperCaser(f)

class UpperCaser:
    '@w{'}'Wrapper around a file that converts output to uppercase.'@w{'}'

    def __init__(self, f):
        self._f = f

    def read(self, count=-1):
        return self._f.read(count).upper()

    # ...
@end example

Como un detalle de implementación, la mayoría de los módulos tienen el nombre @code{__builtins__} disponible como parte de sus globales. El valor de @code{__builtins__} es normalmente o este módulo o el valor del atributo @ref{5fe,,__dict__} de este módulo. Como este es un detalle de implementación, puede que no sea usado por implementaciones alternativas de Python.


@subsubheading Ver también



@itemize *

@item 
@ref{218c,,Constantes incorporadas}

@item 
@ref{188b,,Excepciones incorporadas}

@item 
@ref{12ca,,Funciones incorporadas}

@item 
@ref{2196,,Tipos integrados}
@end itemize


@node __main__ — Top-level code environment,warnings — Warning control,builtins — Built-in objects,Servicios en tiempo de ejecución de Python
@anchor{library/__main__ doc}@anchor{42fa}@anchor{library/__main__ main-top-level-code-environment}@anchor{42fb}@anchor{library/__main__ module-__main__}@anchor{1}
@subsection @code{__main__} — Top-level code environment


@geindex module; __main__


__________________________________________________________________


En Python, el nombre especial @code{__main__} es utilizado para dos constructos importantes:


@enumerate 

@item 
el nombre del entorno de máximo nivel del programa, que puede ser verificado usando la expresión @code{__name__=='__main__'}; y

@item 
el archivo @code{__main__.py} en paquetes de Python.
@end enumerate

Ambos de estos mecanismos están relacionados con módulos de Python; como los usuarios interactúan con ellos y como ellos interactúan entre sí.  Están explicados en detalle más abajo.  Si estás empezando con los módulos de Python, mira la sección tutorial @ref{1c5d,,Módulos} para una introducción.

@menu
* __name__ == '__main__':: 
* __main__.py en paquetes de Python: __main__ py en paquetes de Python. 
* import __main__:: 

@end menu

@node __name__ == '__main__',__main__ py en paquetes de Python,,__main__ — Top-level code environment
@anchor{library/__main__ name-equals-main}@anchor{42fc}@anchor{library/__main__ name-main}@anchor{42fd}
@subsubsection @code{__name__ == '__main__'}


Cuando un módulo o paquete de Python es importado, @code{__name__} es asignado al nombre del módulo.  Normalmente, este es el nombre del archivo de Python sin la extensión @code{.py}:

@example
>>> import configparser
>>> configparser.__name__
'configparser'
@end example

Si el archivo es parte de un paquete, @code{__name__} también incluirá la ruta del paquete padre:

@example
>>> from concurrent.futures import process
>>> process.__name__
'concurrent.futures.process'
@end example

Sin embargo, si el módulo es ejecutado en el entorno de código de máximo nivel, su @code{__name__} se le asigna el valor del string @code{'__main__'}.

@menu
* ¿Qué es el «entorno de código de máximo nivel»?:: 
* Uso idiomático:: 
* Consideraciones de empaquetado:: 

@end menu

@node ¿Qué es el «entorno de código de máximo nivel»?,Uso idiomático,,__name__ == '__main__'
@anchor{library/__main__ what-is-the-top-level-code-environment}@anchor{42fe}
@subsubsection ¿Qué es el «entorno de código de máximo nivel»?


@code{__main__} es el nombre del entorno en el cual se ejecuta el código de máximo nivel. «Código de máximo nivel» es el primer módulo de Python especificado por el usuario que empieza a ejecutarse. Es «de máximo nivel» porque importa todos los demás módulos que necesita el programa. A veces «código de máximo nivel» es llamado un `punto de entrada' a la aplicación.

El entorno de código de máximo nivel puede ser:


@itemize *

@item 
el ámbito de un intérprete interactivo:

@example
>>> __name__
'__main__'
@end example

@item 
el módulo de Python pasado al intérprete de Python como un argumento de archivo:

@example
$ python helloworld.py
Hello, world!
@end example

@item 
el módulo o paquete de Python pasado al interprete de Python con el argumento @ref{187,,-m}:

@example
$ python -m tarfile
usage: tarfile.py [-h] [-v] (...)
@end example

@item 
Código de Python leído por el interprete desde input estándar:

@example
$ echo "import this" | python
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...
@end example

@item 
Código de Python pasado al intérprete Python con el argumento @ref{681,,-c}:

@example
$ python -c "import this"
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...
@end example
@end itemize

En cada una de estas situaciones, al @code{__name__} del módulo de máximo nivel se le asigna el valor @code{'__main__'}.

En consecuencia, un módulo puede descubrir si se está ejecutando o no en el ámbito principal al verificar su propio @code{__name__}, lo cual permite un vocablo común para ejecutar código condicionalmente cuando el módulo no es inicializado desde una declaración de importado:

@example
if __name__ == '__main__':
    # Execute when the module is not initialized from an import statement.
    ...
@end example


@subsubheading Ver también


Para una vista más detallada de como @code{__name__} es asignado en todas las situaciones, ver la sección tutorial @ref{1c5d,,Módulos}.


@node Uso idiomático,Consideraciones de empaquetado,¿Qué es el «entorno de código de máximo nivel»?,__name__ == '__main__'
@anchor{library/__main__ idiomatic-usage}@anchor{42ff}
@subsubsection Uso idiomático


Some modules contain code that is intended for script use only, like parsing
command-line arguments or fetching data from standard input.  If a module
like this was imported from a different module, for example to unit test
it, the script code would unintentionally execute as well.

Aquí es donde es útil usar el código de bloque @code{if __name__=='__main__'}. El código dentro desde bloque no se ejecutará a menos que el módulo se ejecute en el entorno de máximo nivel.

Putting as few statements as possible in the block below @code{if __name__ ==
'__main__'} can improve code clarity and correctness. Most often, a function
named @code{main} encapsulates the program’s primary behavior:

@example
# echo.py

import shlex
import sys

def echo(phrase: str) -> None:
   """A dummy wrapper around print."""
   # for demonstration purposes, you can imagine that there is some
   # valuable and reusable logic inside this function
   print(phrase)

def main() -> int:
    """Echo the input arguments to standard output"""
    phrase = shlex.join(sys.argv)
    echo(phrase)
    return 0

if __name__ == '__main__':
    sys.exit(main())  # next section explains the use of sys.exit
@end example

Note que si el módulo no encapsulase el código dentro de la función @code{main} pero en vez lo pusiese directo dentro del bloque  @code{if __name__=='__main__'}, la variable @code{phrase} sería global al módulo entero.  Esto está propenso a generar errores ya que otras funciones dentro del módulo pudiesen estar usando involuntariamente la variable global en lugar de un nombre local.  Una función @code{main} resuelve este problema.

Usar una función @code{main} tiene el beneficio añadido de que la función @code{echo} está aislada y es importable en otros sitios. Cuando @code{echo.py} es importado, las funciones @code{echo} y @code{main} serán definidas, pero ninguna de ellas será llamada porque @code{__name!='__main__'}.

@node Consideraciones de empaquetado,,Uso idiomático,__name__ == '__main__'
@anchor{library/__main__ packaging-considerations}@anchor{4300}
@subsubsection Consideraciones de empaquetado


Las funciones @code{main} se utilizan a menudo para crear líneas de comando al especificarlas como puntos de entrada para scripts de terminal.  Cuando esto se hace, pip@footnote{https://pip.pypa.io/} inserta la llamada de la función a un script plantilla, donde el valor retornado de @code{main} se pasa a @ref{13b0,,sys.exit()}. Por ejemplo:

@example
sys.exit(main())
@end example

Dado que la llamada a @code{main} está dentro de @ref{13b0,,sys.exit()}, la expectativa es que tu función devolverá un valor aceptable como una entrada a @ref{13b0,,sys.exit()}; típicamente, un int o @code{None} (que se retorna implícitamente si tu función no tiene una declaración de retorno).

By proactively following this convention ourselves, our module will have the
same behavior when run directly (i.e. @code{python echo.py}) as it will have if
we later package it as a console script entry-point in a pip-installable
package.

En particular, ten cuidado al devolver cadenas de texto con tu función @code{main}. @ref{13b0,,sys.exit()} interpretará un argumento de cadena de texto como un mensaje de fallo, entonces tu programa tendrá un código de salida de @code{1}, indicando fallo, y la cadena de texto será escrita a @ref{9cc,,sys.stderr}.  El ejemplo @code{echo.py} de antes muestra como usar la convención @code{sys.exit(main())}.


@subsubheading Ver también


Python Packaging User Guide@footnote{https://packaging.python.org/} contiene una colección de tutoriales y referencias sobre como distribuir e instalar paquetes de Python con herramientas modernas.


@node __main__ py en paquetes de Python,import __main__,__name__ == '__main__',__main__ — Top-level code environment
@anchor{library/__main__ main-py-in-python-packages}@anchor{4301}
@subsubsection @code{__main__.py} en paquetes de Python


Si no estás familiarizado con paquetes de Python, ver la sección @ref{1c6e,,Paquetes} del tutorial.  Comúnmente, el archivo @code{__main__.py} es utilizado para proveer una interfaz de línea de comando para un paquete. Considera el siguiente paquete hipotético, «`bandclass'»:

@example
bandclass
  ├── __init__.py
  ├── __main__.py
  └── student.py
@end example

@code{__main__.py} será ejecutado cuando el paquete sea invocado directamente desde la línea de comandos usando el indicador @ref{187,,-m}. Por ejemplo:

@example
$ python -m bandclass
@end example

Este comando causará que @code{__main__.py} se ejecute. El como se use este mecanismo dependerá de la naturaleza del paquete que estás escribiendo, pero en este caso hipotético, puede tener sentido permitir que el profesor busque estudiantes:

@example
# bandclass/__main__.py

import sys
from .student import search_students

student_name = sys.argv[1] if len(sys.argv) >= 2 else '@w{'}
print(f'Found student: @{search_students(student_name)@}')
@end example

Note that @code{from .student import search_students} is an example of a relative
import.  This import style can be used when referencing modules within a
package.  For more details, see @ref{1c72,,Referencias internas en paquetes} in the
@ref{1c5d,,Módulos} section of the tutorial.

@menu
* Uso idiomático: Uso idiomático<2>. 

@end menu

@node Uso idiomático<2>,,,__main__ py en paquetes de Python
@anchor{library/__main__ id1}@anchor{4302}
@subsubsection Uso idiomático


The content of @code{__main__.py} typically isn’t fenced with an
@code{if __name__ == '__main__'} block.  Instead, those files are kept
short and import functions to execute from other modules.  Those other modules can then be
easily unit-tested and are properly reusable.

Si se usa, un bloque @code{if __name__=='__main__'} seguirá funcionando como se espera para un archivo @code{__main__.py} dentro de un paquete, porque su atributo @code{__name__} incluirá la ruta del paquete si es importado:

@example
>>> import asyncio.__main__
>>> asyncio.__main__.__name__
'asyncio.__main__'
@end example

This won’t work for @code{__main__.py} files in the root directory of a
@code{.zip} file though.  Hence, for consistency, a minimal @code{__main__.py}
without a @code{__name__} check is preferred.


@subsubheading Ver también


See @ref{111,,venv} for an example of a package with a minimal @code{__main__.py}
in the standard library. It doesn’t contain a @code{if __name__ == '__main__'}
block. You can invoke it with @code{python -m venv [directory]}.

Ver @ref{be,,runpy} para más detalles sobre el indicador @ref{187,,-m} para el interprete ejecutable.

Ver @ref{12f,,zipapp} para más información sobre como ejecutar aplicaciones empaquetadas como archivos `.zip'. En este caso Python busca un archivo @code{__main__.py} en el directorio raíz del archivo comprimido.


@node import __main__,,__main__ py en paquetes de Python,__main__ — Top-level code environment
@anchor{library/__main__ import-main}@anchor{4303}
@subsubsection @code{import __main__}


Independientemente de con cual módulo se ha iniciado un programa de Python, otros módulos que están siendo ejecutados dentro del mismo programa pueden importar el ámbito del entorno de máximo nivel (@ref{1c5e,,namespace}) al importar el módulo @code{__main__}.  Esto no importa un archivo @code{__main__.py} pero en su lugar cualquier módulo que recibió el nombre especial @code{'__main__'}.

Acá hay un módulo ejemplo que consume el nombre de espacio @code{__main__}:

@example
# namely.py

import __main__

def did_user_define_their_name():
    return 'my_name' in dir(__main__)

def print_user_name():
    if not did_user_define_their_name():
        raise ValueError('Define the variable `my_name`!')

    if '__file__' in dir(__main__):
        print(__main__.my_name, "found in file", __main__.__file__)
    else:
        print(__main__.my_name)
@end example

Ejemplo del uso de este módulo puede ser:

@example
# start.py

import sys

from namely import print_user_name

# my_name = "Dinsdale"

def main():
    try:
        print_user_name()
    except ValueError as ve:
        return str(ve)

if __name__ == "__main__":
    sys.exit(main())
@end example

Si ahora iniciamos nuestro programa el resultado sería así:

@example
$ python start.py
Define the variable `my_name`!
@end example

El código de salida del programa sería 1, indicando un error. Des-comentando la línea con @code{my_name = "Dinsdale"} arregla el programa y ahora sale con un código de estado 0, indicando éxito:

@example
$ python start.py
Dinsdale found in file /path/to/start.py
@end example

Note que importar @code{__main__} no causa ningún problema de involuntariamente ejecutar código de máximo nivel que ha sido pensado para uso por scripts que es puesto en el bloque @code{if __name__=="__main__"} del módulo @code{start}. ¿Por qué funciona esto?

Python inserts an empty @code{__main__} module in @ref{1976,,sys.modules} at
interpreter startup, and populates it by running top-level code. In our example
this is the @code{start} module which runs line by line and imports @code{namely}.
In turn, @code{namely} imports @code{__main__} (which is really @code{start}). That’s an
import cycle! Fortunately, since the partially populated @code{__main__}
module is present in @ref{1976,,sys.modules}, Python passes that to @code{namely}.
See @ref{200b,,Special considerations for __main__} in the
import system’s reference for details on how this works.

El REPL Python es otro ejemplo de un «entorno de máximo nivel», por lo tanto, cualquier cosa definida en el REPL se hace parte del ámbito @code{__main__}:

@example
>>> import namely
>>> namely.did_user_define_their_name()
False
>>> namely.print_user_name()
Traceback (most recent call last):
...
ValueError: Define the variable `my_name`!
>>> my_name = 'Jabberwocky'
>>> namely.did_user_define_their_name()
True
>>> namely.print_user_name()
Jabberwocky
@end example

Note que en este caso el ámbito @code{__main__} no contiene un atributo @code{__file__} ya que es interactivo.

El ámbito @code{__main__} es utilizado en la implementación de @ref{a5,,pdb} y @ref{bd,,rlcompleter}.

@node warnings — Warning control,dataclasses — Data Classes,__main__ — Top-level code environment,Servicios en tiempo de ejecución de Python
@anchor{library/warnings doc}@anchor{4304}@anchor{library/warnings module-warnings}@anchor{112}@anchor{library/warnings warnings-warning-control}@anchor{4305}
@subsection @code{warnings} — Warning control


@geindex module; warnings

`Código fuente:' Lib/warnings.py@footnote{https://github.com/python/cpython/tree/main/Lib/warnings.py}

@geindex warnings


__________________________________________________________________


Los mensajes de advertencia suelen emitirse en situaciones en las que es útil alertar al usuario de alguna condición en un programa, cuando esa condición (normalmente) no justifica que se haga una excepción y se termine el programa.  Por ejemplo, se puede emitir una advertencia cuando un programa utiliza un módulo obsoleto.

Los programadores de Python emiten advertencias llamando a la función @ref{155a,,warn()} definida en este módulo.  (Los programadores de C usan @ref{148a,,PyErr_WarnEx()}; ver @ref{4306,,Manejo de excepciones} para más detalles)

Los mensajes de advertencia se escriben normalmente en @ref{9cc,,sys.stderr}, pero su disposición puede cambiarse de manera flexible, desde ignorar todas las advertencias hasta convertirlas en excepciones.  La disposición de las advertencias puede variar en función de la @ref{22b5,,warning category}, el texto del mensaje de advertencia y la ubicación de la fuente donde se emite.  Las repeticiones de una advertencia particular para la misma ubicación de la fuente son típicamente suprimidas.

El control de las advertencias consta de dos etapas: en primer lugar, cada vez que se emite una advertencia, se determina si se debe emitir un mensaje o no; en segundo lugar, si se debe emitir un mensaje, se le da formato y se imprime utilizando un gancho establecido por el usuario.

La determinación de si se debe emitir un mensaje de advertencia está controlada por el @ref{960,,warning filter}, que es una secuencia de reglas y acciones que coinciden. Se pueden añadir reglas al filtro llamando a @ref{14e5,,filterwarnings()} y restablecer su estado por defecto llamando a @ref{4307,,resetwarnings()}.

La impresión de los mensajes de advertencia se realiza llamando a @ref{4308,,showwarning()}, que puede ser anulado; la implementación por defecto de esta función da formato al mensaje llamando a @ref{1a1d,,formatwarning()}, que también está disponible para su uso en implementaciones personalizadas.


@subsubheading Ver también


@ref{2d19,,logging.captureWarnings()} permite manejar todas las advertencias con la infraestructura de registro estándar.


@menu
* Categorías de advertencia:: 
* El filtro de advertencias:: 
* Eliminación temporal de las advertencias:: 
* Advertencias de prueba:: 
* Actualización del código para las nuevas versiones de las dependencias:: 
* Funciones disponibles:: 
* Gestores de contexto disponibles:: 

@end menu

@node Categorías de advertencia,El filtro de advertencias,,warnings — Warning control
@anchor{library/warnings id1}@anchor{4309}@anchor{library/warnings warning-categories}@anchor{22b5}
@subsubsection Categorías de advertencia


Hay una serie de excepciones incorporadas que representan categorías de advertencia. Esta categorización es útil para poder filtrar grupos de advertencias.

Aunque técnicamente se trata de @ref{22b3,,built-in exceptions}, están documentadas aquí, porque  pertenecen al mecanismo de advertencias.

El código de usuario puede definir categorías de advertencia adicionales mediante la subclasificación de una de las categorías de advertencia estándar.  Una categoría de advertencia siempre debe ser una subclase de la clase @ref{22b6,,Warning} class.

Actualmente están definidas las siguientes clases de categorías de advertencias:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Clase

@tab

Descripción

@item

@ref{22b6,,Warning}

@tab

Esta es la clase principal para todas las clases que pertenecen a la categoría de advertencia.  Es una subclase de @ref{a6b,,Exception}.

@item

@ref{22b7,,UserWarning}

@tab

La categoría por defecto para @ref{155a,,warn()}.

@item

@ref{1da,,DeprecationWarning}

@tab

Categoría principal para advertencias sobre características obsoletas cuando esas advertencias están destinadas a otros desarrolladores de Python (ignoradas por defecto, a menos que sean activadas por el código en @code{__main__}).

@item

@ref{511,,SyntaxWarning}

@tab

Categoría principal para las advertencias sobre características sintácticas dudosas.

@item

@ref{323,,RuntimeWarning}

@tab

Categoría principal para las advertencias sobre características dudosas de tiempo de ejecución.

@item

@ref{4d4,,FutureWarning}

@tab

Categoría principal para las advertencias sobre características obsoletas cuando esas advertencias están destinadas a los usuarios finales de aplicaciones escritas en Python.

@item

@ref{95f,,PendingDeprecationWarning}

@tab

Categoría principal para las advertencias sobre las características que serán desaprobadas en el futuro (ignoradas por defecto).

@item

@ref{59f,,ImportWarning}

@tab

Categoría principal para las advertencias que se activan durante el proceso de importación de un módulo (se ignoran por defecto).

@item

@ref{1463,,UnicodeWarning}

@tab

Categoría principal para las advertencias relacionadas con Unicode.

@item

@ref{cab,,BytesWarning}

@tab

Categoría principal para las advertencias relacionadas con @ref{325,,bytes} y @ref{5e0,,bytearray}.

@item

@ref{39d,,ResourceWarning}

@tab

Categoría base para las advertencias relacionadas con el uso de los recursos (ignorada por defecto).

@end multitable



Distinto en la versión 3.7: Anteriormente @ref{1da,,DeprecationWarning} y @ref{4d4,,FutureWarning} se distinguían en función de si una característica se eliminaba por completo o se cambiaba su comportamiento. Ahora se distinguen en función de su público objetivo y de la forma en que son manejados por los filtros de advertencia predeterminados.


@node El filtro de advertencias,Eliminación temporal de las advertencias,Categorías de advertencia,warnings — Warning control
@anchor{library/warnings the-warnings-filter}@anchor{430a}@anchor{library/warnings warning-filter}@anchor{960}
@subsubsection El filtro de advertencias


El filtro de advertencias controla si las advertencias se ignoran, se muestran o se convierten en errores (planteando una excepción).

Conceptualmente, el filtro de advertencias mantiene una lista ordenada de especificaciones de filtros; cualquier advertencia específica se compara con cada especificación de filtro de la lista por turno hasta que se encuentra una coincidencia; el filtro determina la disposición de la coincidencia.  Cada entrada es una tupla de la forma (`action', `message', `category', `module', `lineno'), donde:


@itemize *

@item 
`action' es una de las siguientes cadenas:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Disposición

@item

@code{"default"}

@tab

imprime la primera ocurrencia de advertencias coincidentes para cada lugar (módulo + número de línea) donde se emite la advertencia

@item

@code{"error"}

@tab

convertir las advertencias de coincidencia en excepciones

@item

@code{"ignore"}

@tab

nunca imprime advertencias que coincidan

@item

@code{"always"}

@tab

siempre imprime advertencias que coinciden

@item

@code{"all"}

@tab

alias to «always»

@item

@code{"module"}

@tab

imprime la primera ocurrencia de advertencias coincidentes para cada módulo en el que se emite la advertencia (independientemente del número de línea)

@item

@code{"once"}

@tab

imprime sólo la primera aparición de advertencias coincidentes, independientemente de la ubicación

@end multitable


@item 
`message' esa cadena de caracteres que contiene una expresión regular que debería coincidir con el inicio del mensaje de advertencia, sin discriminar mayúsculas ni minúsculas. En @ref{95e,,-W} y 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}, `message' es una cadena de caracteres literal que debería coincidir con el inicio del mensaje de advertencia discriminando mayúsculas y/o minúsculas, pero ignorando cualquier espacio en blanco al inicio de `message'.

@item 
`category' es una clase (una subclase de @ref{22b6,,Warning}) de la cual la categoría de advertencia debe ser una subclase para poder coincidir.

@item 
`module' es un cadena de caracteres que contiene una expresión regular, la cual debe coincidir exactamente (con mayúsculas y minúsculas) al nombre completo del módulo. En @ref{95e,,-W} y 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}, `module' es string literal que debe ser igual (con mayúsculas y minúsculas) al nombre completo del módulo, ignorando cualquier espacio en blanco al inicio o final de `module'.

@item 
`lineno' es un número entero que el número de línea donde ocurrió la advertencia debe coincidir, o @code{0} para coincidir con todos los números de línea.
@end itemize

Como la clase @ref{22b6,,Warning} se deriva de la clase @code{Excepción} incorporada, para convertir una advertencia en un error simplemente lanzamos @code{category(message)}.

Si se informa de una advertencia y no coincide con ningún filtro registrado, se aplica la acción «por defecto» (de ahí su nombre).

@menu
* Repeated Warning Suppression Criteria:: 
* Descripción de los filtros de advertencia:: 
* Filtro de advertencia predeterminado:: 
* Anulando el filtro por defecto:: 

@end menu

@node Repeated Warning Suppression Criteria,Descripción de los filtros de advertencia,,El filtro de advertencias
@anchor{library/warnings id2}@anchor{430b}@anchor{library/warnings repeated-warning-suppression-criteria}@anchor{430c}
@subsubsection Repeated Warning Suppression Criteria


The filters that suppress repeated warnings apply the following criteria to determine if a warning is considered a repeat:


@itemize -

@item 
@code{"default"}: A warning is considered a repeat only if the (`message', `category', `module', `lineno') are all the same.

@item 
@code{"module"}: A warning is considered a repeat if the (`message', `category', `module') are the same, ignoring the line number.

@item 
@code{"once"}: A warning is considered a repeat if the (`message', `category') are the same, ignoring the module and line number.
@end itemize

@node Descripción de los filtros de advertencia,Filtro de advertencia predeterminado,Repeated Warning Suppression Criteria,El filtro de advertencias
@anchor{library/warnings describing-warning-filters}@anchor{1d3f}@anchor{library/warnings id3}@anchor{430d}
@subsubsection Descripción de los filtros de advertencia


El filtro de advertencias se inicializa con @ref{95e,,-W} options pasado a la línea de comandos del intérprete de Python y la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}. El intérprete guarda los argumentos de todas las entradas suministradas sin interpretación en @ref{279,,sys.warnoptions}; el módulo @ref{112,,warnings} los analiza cuando se importa por primera vez (las opciones no válidas se ignoran, después de imprimir un mensaje a @ref{9cc,,sys.stderr}).

Los filtros de advertencia individuales se especifican como una secuencia de campos separados por dos puntos:

@example
action:message:category:module:line
@end example

El significado de cada uno de estos campos es como se describe en @ref{960,,El filtro de advertencias}. Cuando se enumeran varios filtros en una sola línea (como en 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS}), los filtros individuales se separan por comas y los filtros que se enumeran más tarde tienen prioridad sobre los que se enumeran antes de ellos (ya que se aplican de izquierda a derecha, y los filtros aplicados más recientemente tienen prioridad sobre los anteriores).

Los filtros de advertencia comúnmente utilizados se aplican a todas las advertencias, a las advertencias de una categoría particular o a las advertencias planteadas por módulos o paquetes particulares. Algunos ejemplos:

@example
default                      # Show all warnings (even those ignored by default)
ignore                       # Ignore all warnings
error                        # Convert all warnings to errors
error::ResourceWarning       # Treat ResourceWarning messages as errors
default::DeprecationWarning  # Show DeprecationWarning messages
ignore,default:::mymodule    # Only report warnings triggered by "mymodule"
error:::mymodule             # Convert warnings to errors in "mymodule"
@end example

@node Filtro de advertencia predeterminado,Anulando el filtro por defecto,Descripción de los filtros de advertencia,El filtro de advertencias
@anchor{library/warnings default-warning-filter}@anchor{430e}@anchor{library/warnings id4}@anchor{430f}
@subsubsection Filtro de advertencia predeterminado


Por defecto, Python instala varios filtros de advertencia, que pueden ser anulados por la opción de línea de comandos @ref{95e,,-W}, la variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} y llamadas a @ref{14e5,,filterwarnings()}.

En versiones regulares, el filtro de advertencia por defecto tiene las siguientes entradas (en orden de precedencia):

@example
default::DeprecationWarning:__main__
ignore::DeprecationWarning
ignore::PendingDeprecationWarning
ignore::ImportWarning
ignore::ResourceWarning
@end example

En una @ref{357,,compilación de depuración}, la lista de filtros de advertencia predeterminados está vacía.


Distinto en la versión 3.2: @ref{1da,,DeprecationWarning} es ahora ignorado por defecto además de @ref{95f,,PendingDeprecationWarning}.



Distinto en la versión 3.7: @ref{1da,,DeprecationWarning} se muestra de nuevo por defecto cuando se activa directamente por código en @code{__main__}.



Distinto en la versión 3.7: @ref{cab,,BytesWarning} ya no aparece en la lista de filtros por defecto y en su lugar se configura a través de @ref{279,,sys.warnoptions} cuando @ref{683,,-b} se especifica dos veces.


@node Anulando el filtro por defecto,,Filtro de advertencia predeterminado,El filtro de advertencias
@anchor{library/warnings overriding-the-default-filter}@anchor{4310}@anchor{library/warnings warning-disable}@anchor{4311}
@subsubsection Anulando el filtro por defecto


Los desarrolladores de aplicaciones escritas en Python pueden desear ocultar `todas' las advertencias de nivel de Python a sus usuarios por defecto, y sólo mostrarlas cuando se realizan pruebas o se trabaja de otra manera en la aplicación. El atributo @ref{279,,sys.warnoptions} utilizado para pasar las configuraciones de los filtros al intérprete puede utilizarse como marcador para indicar si las advertencias deben ser desactivadas o no:

@example
import sys

if not sys.warnoptions:
    import warnings
    warnings.simplefilter("ignore")
@end example

Se aconseja a los desarrolladores de pruebas de código Python que se aseguren de que `todas' las advertencias se muestren por defecto para el código que se está probando, usando un código como:

@example
import sys

if not sys.warnoptions:
    import os, warnings
    warnings.simplefilter("default") # Change the filter in this process
    os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses
@end example

Por último, se aconseja a los desarrolladores de shells interactivos que ejecuten el código de usuario en un espacio de nombres distinto de @code{__main__} que se aseguren de que los mensajes @ref{1da,,DeprecationWarning} se hagan visibles por defecto, utilizando un código como el siguiente (donde @code{user_ns} es el módulo utilizado para ejecutar el código introducido interactivamente):

@example
import warnings
warnings.filterwarnings("default", category=DeprecationWarning,
                                   module=user_ns.get("__name__"))
@end example

@node Eliminación temporal de las advertencias,Advertencias de prueba,El filtro de advertencias,warnings — Warning control
@anchor{library/warnings temporarily-suppressing-warnings}@anchor{4312}@anchor{library/warnings warning-suppress}@anchor{4313}
@subsubsection Eliminación temporal de las advertencias


Si está utilizando un código que sabe que va a provocar una advertencia, como una función obsoleta, pero no quiere ver la advertencia (incluso cuando las advertencias se han configurado explícitamente a través de la línea de comandos), entonces es posible suprimir la advertencia utilizando el gestor de contexto @ref{628,,catch_warnings}:

@example
import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    fxn()
@end example

Mientras que dentro del gestor de contexto todas las advertencias serán simplemente ignoradas. Esto le permite utilizar el código conocido como obsoleto sin tener que ver la advertencia, mientras que no suprime la advertencia para otro código que podría no ser consciente de su uso de código obsoleto.  Nota: esto sólo puede garantizarse en una aplicación de un solo hilo. Si dos o más hilos utilizan el gestor de contexto @ref{628,,catch_warnings} al mismo tiempo, el comportamiento es indefinido.

@node Advertencias de prueba,Actualización del código para las nuevas versiones de las dependencias,Eliminación temporal de las advertencias,warnings — Warning control
@anchor{library/warnings testing-warnings}@anchor{4314}@anchor{library/warnings warning-testing}@anchor{4315}
@subsubsection Advertencias de prueba


Para probar las advertencias planteadas por el código, use el administrador de contexto @ref{628,,catch_warnings}. Con él puedes mutar temporalmente el filtro de advertencias para facilitar tus pruebas. Por ejemplo, haz lo siguiente para capturar todas las advertencias levantadas para comprobar:

@example
import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings(record=True) as w:
    # Cause all warnings to always be triggered.
    warnings.simplefilter("always")
    # Trigger a warning.
    fxn()
    # Verify some things
    assert len(w) == 1
    assert issubclass(w[-1].category, DeprecationWarning)
    assert "deprecated" in str(w[-1].message)
@end example

También se puede hacer que todas las advertencias sean excepciones usando @code{error} en lugar de @code{always}. Una cosa que hay que tener en cuenta es que si una advertencia ya se ha planteado debido a una regla de @code{once} o @code{default}, entonces no importa qué filtros estén establecidos, la advertencia no se verá de nuevo a menos que el registro de advertencias relacionadas con la advertencia se haya borrado.

Una vez que se cierra el gestor de contexto, el filtro de advertencias se restablece al estado en que se encontraba al entrar en el contexto. Esto evita que las pruebas cambien el filtro de advertencias de forma inesperada entre una prueba y otra, y que se produzcan resultados indeterminados en las pruebas. La función @ref{4308,,showwarning()} del módulo también se restaura a su valor original.  Nota: esto sólo puede garantizarse en una aplicación de un solo hilo. Si dos o más hilos utilizan el gestor de contexto @ref{628,,catch_warnings} al mismo tiempo, el comportamiento es indefinido.

Cuando se prueban múltiples operaciones que plantean el mismo tipo de advertencia, es importante probarlas de manera que se confirme que cada operación plantea una nueva advertencia (por ejemplo, establecer advertencias que se planteen como excepciones y comprobar que las operaciones plantean excepciones, comprobar que la longitud de la lista de advertencias siga aumentando después de cada operación, o bien suprimir las entradas anteriores de la lista de advertencias antes de cada nueva operación).

@node Actualización del código para las nuevas versiones de las dependencias,Funciones disponibles,Advertencias de prueba,warnings — Warning control
@anchor{library/warnings updating-code-for-new-versions-of-dependencies}@anchor{4316}@anchor{library/warnings warning-ignored}@anchor{3fd9}
@subsubsection Actualización del código para las nuevas versiones de las dependencias


Las categorías de advertencia que interesan principalmente a los desarrolladores de Python (más que a los usuarios finales de aplicaciones escritas en Python) se ignoran por defecto.

En particular, esta lista de «ignorados por defecto» incluye @ref{1da,,DeprecationWarning} (para cada módulo excepto @code{__main__}), lo que significa que los desarrolladores deben asegurarse de probar su código con advertencias típicamente ignoradas hechas visibles para recibir notificaciones oportunas de futuros cambios del API a última hora(ya sea en la biblioteca estándar o en paquetes de terceros).

En el caso ideal, el código tendrá un conjunto de pruebas adecuado, y el corredor de pruebas se encargará de habilitar implícitamente todas las advertencias cuando se ejecuten las pruebas (el corredor de pruebas proporcionado por el módulo @ref{106,,unittest} hace esto).

En casos menos ideales, las aplicaciones pueden ser revisadas por el uso de interfaces desaprobadas pasando @ref{95e,,-Wd} al intérprete de Python (esto es la abreviatura de @code{-W default}) o ajustando @code{PYTHONWARNINGS=default} en el entorno. Esto permite el manejo por defecto de todas las advertencias, incluyendo aquellas que son ignoradas por defecto. Para cambiar la acción que se lleva a cabo para las advertencias encontradas puede cambiar el argumento que se pasa a @ref{95e,,-W} (por ejemplo @code{-W error}). Consulte el indicador @ref{95e,,-W} para obtener más detalles sobre lo que es posible.

@node Funciones disponibles,Gestores de contexto disponibles,Actualización del código para las nuevas versiones de las dependencias,warnings — Warning control
@anchor{library/warnings available-functions}@anchor{4317}@anchor{library/warnings warning-functions}@anchor{4318}
@subsubsection Funciones disponibles


@geindex warn() (en el módulo warnings)
@anchor{library/warnings warnings warn}@anchor{155a}
@deffn {Función} warnings.warn (message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=())

Emite una advertencia, o tal vez la ignorar o lanza una excepción.  El argumento `category', si se da, debe ser un @ref{22b5,,warning category class}; por defecto es @ref{22b7,,UserWarning}.  Alternativamente, `message' puede ser una instancia @ref{22b6,,Warning}, en cuyo caso `category' será ignorada y se usará @code{message.__class__}. En este caso, el texto del mensaje será @code{str(message)}. Esta función hace una excepción si la advertencia particular emitida es convertida en un error por el @ref{960,,warnings filter}.   El argumento `stacklevel' puede ser usado por funciones de envoltura escritas en Python, como esta:

@example
def deprecated_api(message):
    warnings.warn(message, DeprecationWarning, stacklevel=2)
@end example

Esto hace que la advertencia se refiera al invocador de @code{deprecated_api}, en lugar de a la fuente de @code{deprecated_api} en sí (ya que esta última perdería el propósito del mensaje de advertencia).

El parámetro de palabra clave `skip_file_prefixes' se puede utilizar para indicar qué `frames' de pila se ignoran al contar los niveles de pila. Esto puede ser útil cuando desea que la advertencia aparezca siempre en los sitios de llamadas fuera de un paquete cuando una constante `stacklevel' no se ajusta a todas las rutas de llamadas o en otro caso es difícil de mantener. Si se proporciona, debe ser una tupla de cadenas de caracteres. Cuando se proporcionan prefijos, el `stacklevel' se sobreescribe implícitamente con @code{max(2, stacklevel)}. Para hacer que se atribuya una advertencia al invocador desde afuera del paquete actual, puede escribir:

@example
# example/lower.py
_warn_skips = (os.path.dirname(__file__),)

def one_way(r_luxury_yacht=None, t_wobbler_mangrove=None):
    if r_luxury_yacht:
        warnings.warn("Please migrate to t_wobbler_mangrove=.",
                      skip_file_prefixes=_warn_skips)

# example/higher.py
from . import lower

def another_way(**kw):
    lower.one_way(**kw)
@end example

Esto hace que la advertencia se refiera a ambos lugares de llamada @code{example.lower.one_way()} y @code{package.higher.another_way()} únicamente desde el código de llamada que se encuentra fuera del paquete @code{example}.

`source', si se suministra, es el objeto destruido que emitió un @ref{39d,,ResourceWarning}.


Distinto en la versión 3.6: Añadido parámetro `source'.



Distinto en la versión 3.12: Añadido `skip_file_prefixes'.

@end deffn

@geindex warn_explicit() (en el módulo warnings)
@anchor{library/warnings warnings warn_explicit}@anchor{d87}
@deffn {Función} warnings.warn_explicit (message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)

Se trata de una interfaz de bajo nivel para la funcionalidad de @ref{155a,,warn()}, pasando explícitamente el mensaje, la categoría, el nombre de archivo y el número de línea, y opcionalmente el nombre del módulo y el registro (que debería ser el diccionario @code{__warningregistry__} del módulo).  El nombre del módulo por defecto es el nombre de archivo con @cite{.py} desmembrado; si no se pasa el registro, la advertencia nunca se suprime. `message' debe ser una cadena y `category' una subclase de @ref{22b6,,Warning} o `message' puede ser una instancia @ref{22b6,,Warning}, en cuyo caso `category' será ignorada.

`module_globals', si se suministra, debe ser el espacio de nombres global en uso por el código para el que se emite la advertencia.  (Este argumento se utiliza para apoyar la visualización de la fuente de los módulos que se encuentran en los archivos zip o en otras fuentes de importación que no son del sistema de archivos).

`source', si se suministra, es el objeto destruido que emitió un @ref{39d,,ResourceWarning}.


Distinto en la versión 3.6: Añade el parámetro `source'.

@end deffn

@geindex showwarning() (en el módulo warnings)
@anchor{library/warnings warnings showwarning}@anchor{4308}
@deffn {Función} warnings.showwarning (message, category, filename, lineno, file=None, line=None)

Escriba una advertencia en un archivo.  La implementación por defecto llama @code{formatwarning(message, category, filename, lineno, line)} y escribe la cadena resultante a `file', que por defecto es @ref{9cc,,sys.stderr}.  Puede reemplazar esta función con cualquier interlocutor asignando a @code{warnings.showwarning}. `line' es una línea de código fuente que se incluirá en el mensaje de advertencia; si no se proporciona `line', @ref{4308,,showwarning()} intentará leer la línea especificada por `nombre de archivo' y `lineno'.
@end deffn

@geindex formatwarning() (en el módulo warnings)
@anchor{library/warnings warnings formatwarning}@anchor{1a1d}
@deffn {Función} warnings.formatwarning (message, category, filename, lineno, line=None)

Formatea una advertencia de la manera estándar.  Esto retorna una cadena que puede contener nuevas líneas incrustadas y termina en una nueva línea.  `line' es una línea de código fuente a incluir en el mensaje de advertencia; si `line' no se suministra, @ref{1a1d,,formatwarning()} intentará leer la línea especificada por el nombre de fichero `filename' y `lineno'.
@end deffn

@geindex filterwarnings() (en el módulo warnings)
@anchor{library/warnings warnings filterwarnings}@anchor{14e5}
@deffn {Función} warnings.filterwarnings (action, message='@w{'}, category=Warning, module='@w{'}, lineno=0, append=False)

Inserta una entrada en la lista de @ref{960,,warnings filter specifications}.  La entrada se inserta por defecto en el frente; si `append' es verdadero, se inserta al final.  Esto comprueba los tipos de los argumentos, compila las expresiones regulares `message' y `module', y las inserta como una tupla en la lista de filtros de aviso.  Las entradas más cercanas al principio de la lista anulan las entradas posteriores de la lista, si ambas coinciden con una advertencia en particular.  Los argumentos omitidos predeterminan un valor que coincide con todo.
@end deffn

@geindex simplefilter() (en el módulo warnings)
@anchor{library/warnings warnings simplefilter}@anchor{762}
@deffn {Función} warnings.simplefilter (action, category=Warning, lineno=0, append=False)

Inserte una simple entrada en la lista de @ref{960,,warnings filter specifications}.  El significado de los parámetros de la función es el mismo que el de @ref{14e5,,filterwarnings()}, pero no se necesitan expresiones regulares ya que el filtro insertado siempre coincide con cualquier mensaje de cualquier módulo siempre que la categoría y el número de línea coincidan.
@end deffn

@geindex resetwarnings() (en el módulo warnings)
@anchor{library/warnings warnings resetwarnings}@anchor{4307}
@deffn {Función} warnings.resetwarnings ()

Reajusta el filtro de advertencias.  Esto descarta el efecto de todas las llamadas previas a @ref{14e5,,filterwarnings()}, incluyendo la de las opciones de línea de comandos de @ref{95e,,-W} y las llamadas a @ref{762,,simplefilter()}.
@end deffn

@geindex deprecated() (en el módulo warnings)
@anchor{library/warnings warnings deprecated}@anchor{2cc}
@deffn {Función} @@warnings.deprecated (msg, *, category=DeprecationWarning, stacklevel=1)

Decorator to indicate that a class, function or overload is deprecated.

When this decorator is applied to an object,
deprecation warnings may be emitted at runtime when the object is used.
@ref{3c4,,static type checkers}
will also generate a diagnostic on usage of the deprecated object.

Usage:

@example
from warnings import deprecated
from typing import overload

@@deprecated("Use B instead")
class A:
    pass

@@deprecated("Use g instead")
def f():
    pass

@@overload
@@deprecated("int support is deprecated")
def g(x: int) -> int: ...
@@overload
def g(x: str) -> int: ...
@end example

The warning specified by `category' will be emitted at runtime
on use of deprecated objects. For functions, that happens on calls;
for classes, on instantiation and on creation of subclasses.
If the `category' is @code{None}, no warning is emitted at runtime.
The `stacklevel' determines where the
warning is emitted. If it is @code{1} (the default), the warning
is emitted at the direct caller of the deprecated object; if it
is higher, it is emitted further up the stack.
Static type checker behavior is not affected by the `category'
and `stacklevel' arguments.

The deprecation message passed to the decorator is saved in the
@code{__deprecated__} attribute on the decorated object.
If applied to an overload, the decorator
must be after the @ref{3eda,,@@overload} decorator
for the attribute to exist on the overload as returned by
@ref{74f,,typing.get_overloads()}.


Added in version 3.13: See 
@geindex Python Enhancement Proposals; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}.

@end deffn

@node Gestores de contexto disponibles,,Funciones disponibles,warnings — Warning control
@anchor{library/warnings available-context-managers}@anchor{4319}
@subsubsection Gestores de contexto disponibles


@geindex catch_warnings (clase en warnings)
@anchor{library/warnings warnings catch_warnings}@anchor{628}
@deffn {Clase} warnings.catch_warnings (*, record=False, module=None, action=None, category=Warning, lineno=0, append=False)

Un gestor de contexto que copia y, al salir, restaura el filtro de advertencias y la función @ref{4308,,showwarning()}. Si el argumento `record' es @ref{bbf,,False} (por defecto) el gestor de contextos retorna @ref{716,,None} al entrar. Si `record' es @ref{c95,,True}, se retorna una lista que se va poblando progresivamente de objetos como se ve por una función personalizada de @ref{4308,,showwarning()} (que también suprime la salida a @code{sys.stdout}). Cada objeto de la lista tiene atributos con los mismos nombres que los argumentos de @ref{4308,,showwarning()}.

El argumento `module' toma un módulo que será usado en lugar del módulo retornado cuando se importa @ref{112,,warnings} cuyo filtro será protegido. Este argumento existe principalmente para probar el propio módulo @ref{112,,warnings}.

Si el argumento `action' es diferente a @code{None}, los demás argumentos serán enviados a la función @ref{762,,simplefilter()} como si fueran invocados inmediatamente al entrar al contexto.

See @ref{960,,El filtro de advertencias} for the meaning of the `category' and `lineno'
parameters.

@cartouche
@quotation Nota 
El gestor @ref{628,,catch_warnings} funciona reemplazando y luego restaurando la función @ref{4308,,showwarning()} del módulo y la lista interna de especificaciones del filtro.  Esto significa que el gestor de contexto está modificando el estado global y por lo tanto no es seguro para los hilos.
@end quotation
@end cartouche


Distinto en la versión 3.11: Agrega los parámetros `action', `category', `lineno' y `append'.

@end deffn

@node dataclasses — Data Classes,contextlib — Utilidades para declaraciones de contexto with,warnings — Warning control,Servicios en tiempo de ejecución de Python
@anchor{library/dataclasses doc}@anchor{431a}@anchor{library/dataclasses dataclasses-data-classes}@anchor{431b}@anchor{library/dataclasses module-dataclasses}@anchor{30}
@subsection @code{dataclasses} — Data Classes


@geindex module; dataclasses

`Código fuente:' Lib/dataclasses.py@footnote{https://github.com/python/cpython/tree/main/Lib/dataclasses.py}


__________________________________________________________________


This module provides a decorator and functions for automatically
adding generated @ref{18b4,,special methods} such as @ref{751,,__init__()} and
@ref{6bd,,__repr__()} to user-defined classes.  It was originally described
in 
@geindex Python Enhancement Proposals; PEP 557
PEP 557@footnote{https://peps.python.org/pep-0557/}.

Las variables miembro a utilizar en estos métodos generados son definidas teniendo en cuenta anotaciones de tipo 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}. Por ejemplo, en este código:

@example
from dataclasses import dataclass

@@dataclass
class InventoryItem:
    """Class for keeping track of an item in inventory."""
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand
@end example

will add, among other things, a @code{__init__()} that looks like:

@example
def __init__(self, name: str, unit_price: float, quantity_on_hand: int = 0):
    self.name = name
    self.unit_price = unit_price
    self.quantity_on_hand = quantity_on_hand
@end example

Note that this method is automatically added to the class: it is not
directly specified in the @code{InventoryItem} definition shown above.


Added in version 3.7.


@menu
* Contenidos del módulo: Contenidos del módulo<4>. 
* Procesamiento posterior a la inicialización:: 
* Variables de clase:: 
* Variable de solo inicialización:: 
* Instancias congeladas:: 
* Herencia: Herencia<2>. 
* Re-ordering of keyword-only parameters in __init__(): Re-ordering of keyword-only parameters in __init__. 
* Funciones fábrica por defecto:: 
* Valores por defecto mutables:: 
* Campos tipo descriptor:: 

@end menu

@node Contenidos del módulo<4>,Procesamiento posterior a la inicialización,,dataclasses — Data Classes
@anchor{library/dataclasses module-contents}@anchor{431c}
@subsubsection Contenidos del módulo


@geindex dataclass() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses dataclass}@anchor{32e}
@deffn {Función} @@dataclasses.dataclass (*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False)

This function is a @ref{7cd,,decorator} that is used to add generated
@ref{18b4,,special methods} to classes, as described below.

The @code{@@dataclass} decorator examines the class to find
@code{field}s.  A @code{field} is defined as a class variable that has a
@ref{ddb,,type annotation}.  With two
exceptions described below, nothing in @code{@@dataclass}
examines the type specified in the variable annotation.

El orden de los campos en los métodos generados es el mismo en el que se encuentran en la definición de la clase.

The @code{@@dataclass} decorator will add various «dunder» methods to
the class, described below.  If any of the added methods already
exist in the class, the behavior depends on the parameter, as documented
below. The decorator returns the same class that it is called on; no new
class is created.

If @code{@@dataclass} is used just as a simple decorator with no parameters,
it acts as if it has the default values documented in this
signature.  That is, these three uses of @code{@@dataclass} are
equivalent:

@example
@@dataclass
class C:
    ...

@@dataclass()
class C:
    ...

@@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False,
           match_args=True, kw_only=False, slots=False, weakref_slot=False)
class C:
    ...
@end example

The parameters to @code{@@dataclass} are:


@itemize -

@item 
`init': If true (the default), a @ref{751,,__init__()} method will be
generated.

If the class already defines @code{__init__()}, this parameter is
ignored.

@item 
`repr': If true (the default), a @ref{6bd,,__repr__()} method will be
generated.  The generated repr string will have the class name and
the name and repr of each field, in the order they are defined in
the class.  Fields that are marked as being excluded from the repr
are not included.  For example:
@code{InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)}.

If the class already defines @code{__repr__()}, this parameter is
ignored.

@item 
`eq': If true (the default), an @ref{b85,,__eq__()} method will be
generated.  This method compares the class as if it were a tuple
of its fields, in order.  Both instances in the comparison must
be of the identical type.

If the class already defines @code{__eq__()}, this parameter is
ignored.

@item 
`order': If true (the default is @code{False}), @ref{1372,,__lt__()},
@ref{1373,,__le__()}, @ref{1374,,__gt__()}, and @ref{1375,,__ge__()} methods will be
generated.  These compare the class as if it were a tuple of its
fields, in order.  Both instances in the comparison must be of the
identical type.  If `order' is true and `eq' is false, a
@ref{360,,ValueError} is raised.

If the class already defines any of @code{__lt__()},
@code{__le__()}, @code{__gt__()}, or @code{__ge__()}, then
@ref{228,,TypeError} is raised.

@item 
`unsafe_hash': If @code{False} (the default), a @ref{b86,,__hash__()} method
is generated according to how `eq' and `frozen' are set.

@code{__hash__()} is used by built-in @ref{68b,,hash()}, and when objects are
added to hashed collections such as dictionaries and sets.  Having a
@code{__hash__()} implies that instances of the class are immutable.
Mutability is a complicated property that depends on the programmer’s
intent, the existence and behavior of @code{__eq__()}, and the values of
the `eq' and `frozen' flags in the @code{@@dataclass} decorator.

By default, @code{@@dataclass} will not implicitly add a @ref{b86,,__hash__()}
method unless it is safe to do so.  Neither will it add or change an
existing explicitly defined @code{__hash__()} method.  Setting the class
attribute @code{__hash__ = None} has a specific meaning to Python, as
described in the @code{__hash__()} documentation.

If @code{__hash__()} is not explicitly defined, or if it is set to @code{None},
then @code{@@dataclass} `may' add an implicit @code{__hash__()} method.
Although not recommended, you can force @code{@@dataclass} to create a
@code{__hash__()} method with @code{unsafe_hash=True}. This might be the case
if your class is logically immutable but can still be mutated.
This is a specialized use case and should be considered carefully.

Here are the rules governing implicit creation of a @code{__hash__()}
method.  Note that you cannot both have an explicit @code{__hash__()}
method in your dataclass and set @code{unsafe_hash=True}; this will result
in a @ref{228,,TypeError}.

If `eq' and `frozen' are both true, by default @code{@@dataclass} will
generate a @code{__hash__()} method for you.  If `eq' is true and
`frozen' is false, @code{__hash__()} will be set to @code{None}, marking it
unhashable (which it is, since it is mutable).  If `eq' is false,
@code{__hash__()} will be left untouched meaning the @code{__hash__()}
method of the superclass will be used (if the superclass is
@ref{b18,,object}, this means it will fall back to id-based hashing).

@item 
`frozen': If true (the default is @code{False}), assigning to fields will
generate an exception.  This emulates read-only frozen instances.  If
@ref{1f2e,,__setattr__()} or @ref{1f2f,,__delattr__()} is defined in the class, then
@ref{228,,TypeError} is raised.  See the discussion below.

@item 
`match_args': If true (the default is @code{True}), the
@ref{18c8,,__match_args__} tuple will be created from the list of
parameters to the generated @ref{751,,__init__()} method (even if
@code{__init__()} is not generated, see above).  If false, or if
@code{__match_args__} is already defined in the class, then
@code{__match_args__} will not be generated.
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
`kw_only': If true (the default value is @code{False}), then all
fields will be marked as keyword-only.  If a field is marked as
keyword-only, then the only effect is that the @ref{751,,__init__()}
parameter generated from a keyword-only field must be specified
with a keyword when @code{__init__()} is called.  There is no
effect on any other aspect of dataclasses.  See the
@ref{1efc,,parameter} glossary entry for details.  Also see the
@ref{431d,,KW_ONLY} section.
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
`slots': If true (the default is @code{False}), @ref{152a,,__slots__} attribute
will be generated and new class will be returned instead of the original one.
If @code{__slots__} is already defined in the class, then @ref{228,,TypeError}
is raised.
@end itemize

@quotation

@cartouche
@quotation Advertencia 
Passing parameters to a base class @ref{6d2,,__init_subclass__()}
when using @code{slots=True} will result in a @ref{228,,TypeError}.
Either use @code{__init_subclass__} with no parameters
or use default values as a workaround.
See gh-91126@footnote{https://github.com/python/cpython/issues/91126} for full details.
@end quotation
@end cartouche


Added in version 3.10.



Distinto en la versión 3.11: If a field name is already included in the @code{__slots__}
of a base class, it will not be included in the generated @code{__slots__}
to prevent @ref{1f6e,,overriding them}.
Therefore, do not use @code{__slots__} to retrieve the field names of a
dataclass. Use @ref{15ca,,fields()} instead.
To be able to determine inherited slots,
base class @code{__slots__} may be any iterable, but `not' an iterator.

@end quotation


@itemize -

@item 
`weakref_slot': If true (the default is @code{False}), add a slot
named «__weakref__», which is required to make an instance
@ref{106d,,weakref-able}.
It is an error to specify @code{weakref_slot=True}
without also specifying @code{slots=True}.
@end itemize

@quotation


Added in version 3.11.

@end quotation

Los @code{fields} pueden especificar un valor por defecto opcionalmente, simplemente usando la sintaxis normal de Python:

@example
@@dataclass
class C:
    a: int       # 'a' has no default value
    b: int = 0   # assign a default value for 'b'
@end example

In this example, both @code{a} and @code{b} will be included in the added
@ref{751,,__init__()} method, which will be defined as:

@example
def __init__(self, a: int, b: int = 0):
@end example

Si, en la definición de una clase, a un campo con valor por defecto le sigue un campo sin valor por defecto será lanzada una excepción @ref{228,,TypeError}. Esto se aplica también a la implementación de una clase única o como resultado de herencia de clases.
@end deffn

@geindex field() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses field}@anchor{15f7}
@deffn {Función} dataclasses.field (*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING, doc=None)

For common and simple use cases, no other functionality is
required.  There are, however, some dataclass features that
require additional per-field information.  To satisfy this need for
additional information, you can replace the default field value
with a call to the provided @code{field()} function.  For example:

@example
@@dataclass
class C:
    mylist: list[int] = field(default_factory=list)

c = C()
c.mylist += [1, 2, 3]
@end example

Como se muestra arriba, el valor @ref{431e,,MISSING} es un objeto centinela que se usa para detectar si el usuario proporciona algunos parámetros. Este centinela se utiliza porque @code{None} es un valor válido para algunos parámetros con un significado distinto. Ningún código debe utilizar directamente el valor @ref{431e,,MISSING}.

The parameters to @code{field()} are:


@itemize -

@item 
`default': If provided, this will be the default value for this
field.  This is needed because the @code{field()} call itself
replaces the normal position of the default value.

@item 
`default_factory': If provided, it must be a zero-argument
callable that will be called when a default value is needed for
this field.  Among other purposes, this can be used to specify
fields with mutable default values, as discussed below.  It is an
error to specify both `default' and `default_factory'.

@item 
`init': If true (the default), this field is included as a
parameter to the generated @ref{751,,__init__()} method.

@item 
`repr': If true (the default), this field is included in the
string returned by the generated @ref{6bd,,__repr__()} method.

@item 
`hash': This can be a bool or @code{None}.  If true, this field is
included in the generated @ref{b86,,__hash__()} method.  If @code{None} (the
default), use the value of `compare': this would normally be
the expected behavior.  A field should be considered in the hash
if it’s used for comparisons.  Setting this value to anything
other than @code{None} is discouraged.

Una posible razón para definir @code{hash=False} y @code{compare=True} podría ser el caso en el que computar el valor `hash' para dicho campo es costoso pero el campo es necesario para los métodos de comparación, siempre que existan otros campos que contribuyen al valor hash del tipo. Incluso si un campo se excluye del hash, se seguirá utilizando a la hora de comparar.

@item 
`compare': If true (the default), this field is included in the
generated equality and comparison methods (@ref{b85,,__eq__()},
@ref{1374,,__gt__()}, et al.).

@item 
`metadata': This can be a mapping or @code{None}. @code{None} is treated as
an empty dict.  This value is wrapped in
@ref{518,,MappingProxyType()} to make it read-only, and exposed
on the @ref{15f8,,Field} object. It is not used at all by Data
Classes, and is provided as a third-party extension mechanism.
Multiple third-parties can each have their own key, to use as a
namespace in the metadata.

@item 
`kw_only': If true, this field will be marked as keyword-only.
This is used when the generated @ref{751,,__init__()} method’s
parameters are computed.
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
@code{doc}: optional docstring for this field.
@end itemize

@quotation


Added in version 3.13.

@end quotation

If the default value of a field is specified by a call to
@code{field()}, then the class attribute for this field will be
replaced by the specified `default' value.  If `default' is not
provided, then the class attribute will be deleted.  The intent is
that after the @ref{32e,,@@dataclass} decorator runs, the class
attributes will all contain the default values for the fields, just
as if the default value itself were specified.  For example,
after:

@example
@@dataclass
class C:
    x: int
    y: int = field(repr=False)
    z: int = field(repr=False, default=10)
    t: int = 20
@end example

The class attribute @code{C.z} will be @code{10}, the class attribute
@code{C.t} will be @code{20}, and the class attributes @code{C.x} and
@code{C.y} will not be set.
@end deffn

@geindex Field (clase en dataclasses)
@anchor{library/dataclasses dataclasses Field}@anchor{15f8}
@deffn {Clase} dataclasses.Field

@code{Field} objects describe each defined field. These objects
are created internally, and are returned by the @ref{15ca,,fields()}
module-level method (see below).  Users should never instantiate a
@code{Field} object directly.  Its documented attributes are:


@itemize -

@item 
@code{name}: The name of the field.

@item 
@code{type}: The type of the field.

@item 
@code{default}, @code{default_factory}, @code{init}, @code{repr}, @code{hash},
@code{compare}, @code{metadata}, and @code{kw_only} have the identical
meaning and values as they do in the @ref{15f7,,field()} function.
@end itemize

Pueden existir otros atributos, pero son privados y no deberían ser considerados ni depender de ellos.
@end deffn

@geindex fields() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses fields}@anchor{15ca}
@deffn {Función} dataclasses.fields (class_or_instance)

Retorna una tupla de objetos @ref{15f8,,Field} que definen los campos para esta clase de datos. Acepta tanto una clase de datos como una instancia de esta. Lanza una excepción @ref{228,,TypeError} si se le pasa cualquier otro objeto. No retorna pseudocampos, que son @code{ClassVar} o @code{InitVar}.
@end deffn

@geindex asdict() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses asdict}@anchor{172b}
@deffn {Función} dataclasses.asdict (obj, *, dict_factory=dict)

Converts the dataclass `obj' to a dict (by using the
factory function `dict_factory').  Each dataclass is converted
to a dict of its fields, as @code{name: value} pairs.  dataclasses, dicts,
lists, and tuples are recursed into.  Other objects are copied with
@ref{bf6,,copy.deepcopy()}.

Example of using @code{asdict()} on nested dataclasses:

@example
@@dataclass
class Point:
     x: int
     y: int

@@dataclass
class C:
     mylist: list[Point]

p = Point(10, 20)
assert asdict(p) == @{'x': 10, 'y': 20@}

c = C([Point(0, 0), Point(10, 4)])
assert asdict(c) == @{'mylist': [@{'x': 0, 'y': 0@}, @{'x': 10, 'y': 4@}]@}
@end example

To create a shallow copy, the following workaround may be used:

@example
@{field.name: getattr(obj, field.name) for field in fields(obj)@}
@end example

@code{asdict()} raises @ref{228,,TypeError} if `obj' is not a dataclass
instance.
@end deffn

@geindex astuple() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses astuple}@anchor{1735}
@deffn {Función} dataclasses.astuple (obj, *, tuple_factory=tuple)

Converts the dataclass `obj' to a tuple (by using the
factory function `tuple_factory').  Each dataclass is converted
to a tuple of its field values.  dataclasses, dicts, lists, and
tuples are recursed into. Other objects are copied with
@ref{bf6,,copy.deepcopy()}.

Continuando con el ejemplo anterior:

@example
assert astuple(p) == (10, 20)
assert astuple(c) == ([(0, 0), (10, 4)],)
@end example

To create a shallow copy, the following workaround may be used:

@example
tuple(getattr(obj, field.name) for field in dataclasses.fields(obj))
@end example

@code{astuple()} raises @ref{228,,TypeError} if `obj' is not a dataclass
instance.
@end deffn

@geindex make_dataclass() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses make_dataclass}@anchor{15db}
@deffn {Función} dataclasses.make_dataclass (cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False, module=None, decorator=dataclass)

Creates a new dataclass with name `cls_name', fields as defined
in `fields', base classes as given in `bases', and initialized
with a namespace as given in `namespace'.  `fields' is an
iterable whose elements are each either @code{name}, @code{(name, type)},
or @code{(name, type, Field)}.  If just @code{name} is supplied,
@ref{74d,,typing.Any} is used for @code{type}.  The values of `init',
`repr', `eq', `order', `unsafe_hash', `frozen',
`match_args', `kw_only', `slots', and `weakref_slot' have
the same meaning as they do in @ref{32e,,@@dataclass}.

If `module' is defined, the @code{__module__} attribute
of the dataclass is set to that value.
By default, it is set to the module name of the caller.

The `decorator' parameter is a callable that will be used to create the dataclass.
It should take the class object as a first argument and the same keyword arguments
as @ref{32e,,@@dataclass}. By default, the @ref{32e,,@@dataclass}
function is used.

This function is not strictly required, because any Python
mechanism for creating a new class with @code{__annotations__} can
then apply the @ref{32e,,@@dataclass} function to convert that class to
a dataclass.  This function is provided as a convenience.  For
example:

@example
C = make_dataclass('C',
                   [('x', int),
                     'y',
                    ('z', int, field(default=5))],
                   namespace=@{'add_one': lambda self: self.x + 1@})
@end example

Es equivalente a:

@example
@@dataclass
class C:
    x: int
    y: 'typing.Any'
    z: int = 5

    def add_one(self):
        return self.x + 1
@end example


Added in version 3.14: Added the `decorator' parameter.

@end deffn

@geindex replace() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses replace}@anchor{16ff}
@deffn {Función} dataclasses.replace (obj, /, **changes)

Creates a new object of the same type as `obj', replacing
fields with values from `changes'.  If `obj' is not a Data
Class, raises @ref{228,,TypeError}.  If keys in `changes' are not
field names of the given dataclass, raises @ref{228,,TypeError}.

The newly returned object is created by calling the @ref{751,,__init__()}
method of the dataclass.  This ensures that
@ref{431f,,__post_init__()}, if present, is also called.

Init-only variables without default values, if any exist, must be
specified on the call to @code{replace()} so that they can be passed to
@code{__init__()} and @ref{431f,,__post_init__()}.

It is an error for `changes' to contain any fields that are
defined as having @code{init=False}.  A @ref{360,,ValueError} will be raised
in this case.

Be forewarned about how @code{init=False} fields work during a call to
@code{replace()}.  They are not copied from the source object, but
rather are initialized in @ref{431f,,__post_init__()}, if they’re
initialized at all.  It is expected that @code{init=False} fields will
be rarely and judiciously used.  If they are used, it might be wise
to have alternate class constructors, or perhaps a custom
@code{replace()} (or similarly named) method which handles instance
copying.

Dataclass instances are also supported by generic function @ref{15f,,copy.replace()}.
@end deffn

@geindex is_dataclass() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses is_dataclass}@anchor{187a}
@deffn {Función} dataclasses.is_dataclass (obj)

Return @code{True} if its parameter is a dataclass (including subclasses of a
dataclass) or an instance of one, otherwise return @code{False}.

Si se necesita conocer si una clase es una instancia de `dataclass' (y no una clase de datos en si misma), se debe agregar una verificación adicional para @code{not isinstance(obj, type)}:

@example
def is_dataclass_instance(obj):
    return is_dataclass(obj) and not isinstance(obj, type)
@end example
@end deffn

@geindex MISSING (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses MISSING}@anchor{431e}
@deffn {Dato} dataclasses.MISSING

Un valor centinela que significa que falta un default o default_factory.
@end deffn

@geindex KW_ONLY (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses KW_ONLY}@anchor{431d}
@deffn {Dato} dataclasses.KW_ONLY

A sentinel value used as a type annotation.  Any fields after a
pseudo-field with the type of @code{KW_ONLY} are marked as
keyword-only fields.  Note that a pseudo-field of type
@code{KW_ONLY} is otherwise completely ignored.  This includes the
name of such a field.  By convention, a name of @code{_} is used for a
@code{KW_ONLY} field.  Keyword-only fields signify
@ref{751,,__init__()} parameters that must be specified as keywords when
the class is instantiated.

En este ejemplo, los campos @code{y} y @code{z} se marcarán como campos de solo palabras clave:

@example
@@dataclass
class Point:
    x: float
    _: KW_ONLY
    y: float
    z: float

p = Point(0, y=1.5, z=2.0)
@end example

In a single dataclass, it is an error to specify more than one
field whose type is @code{KW_ONLY}.


Added in version 3.10.

@end deffn

@geindex FrozenInstanceError
@anchor{library/dataclasses dataclasses FrozenInstanceError}@anchor{4320}
@deffn {Excepción} dataclasses.FrozenInstanceError

Raised when an implicitly defined @ref{1f2e,,__setattr__()} or
@ref{1f2f,,__delattr__()} is called on a dataclass which was defined with
@code{frozen=True}. It is a subclass of @ref{441,,AttributeError}.
@end deffn

@node Procesamiento posterior a la inicialización,Variables de clase,Contenidos del módulo<4>,dataclasses — Data Classes
@anchor{library/dataclasses id1}@anchor{4321}@anchor{library/dataclasses post-init-processing}@anchor{4322}
@subsubsection Procesamiento posterior a la inicialización


@geindex __post_init__() (en el módulo dataclasses)
@anchor{library/dataclasses dataclasses __post_init__}@anchor{431f}
@deffn {Función} dataclasses.__post_init__ ()

When defined on the class, it will be called by the generated
@ref{751,,__init__()}, normally as @code{self.__post_init__()}.
However, if any @code{InitVar} fields are defined, they will also be
passed to @code{__post_init__()} in the order they were defined in the
class.  If no @code{__init__()} method is generated, then
@code{__post_init__()} will not automatically be called.

Entre otros usos, esto permite inicializar valores de campo que dependen de uno o más campos. Por ejemplo:

@example
@@dataclass
class C:
    a: float
    b: float
    c: float = field(init=False)

    def __post_init__(self):
        self.c = self.a + self.b
@end example
@end deffn

The @ref{751,,__init__()} method generated by @ref{32e,,@@dataclass} does not call base
class @code{__init__()} methods. If the base class has an @code{__init__()} method
that has to be called, it is common to call this method in a
@ref{431f,,__post_init__()} method:

@example
class Rectangle:
    def __init__(self, height, width):
        self.height = height
        self.width = width

@@dataclass
class Square(Rectangle):
    side: float

    def __post_init__(self):
        super().__init__(self.side, self.side)
@end example

Note, however, that in general the dataclass-generated @code{__init__()} methods
don’t need to be called, since the derived dataclass will take care of
initializing all fields of any base class that is a dataclass itself.

See the section below on init-only variables for ways to pass
parameters to @code{__post_init__()}.  Also see the warning about how
@ref{16ff,,replace()} handles @code{init=False} fields.

@node Variables de clase,Variable de solo inicialización,Procesamiento posterior a la inicialización,dataclasses — Data Classes
@anchor{library/dataclasses class-variables}@anchor{4323}@anchor{library/dataclasses dataclasses-class-variables}@anchor{4324}
@subsubsection Variables de clase


One of the few places where @ref{32e,,@@dataclass} actually inspects the type
of a field is to determine if a field is a class variable as defined
in 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}.  It does this by checking if the type of the field is
@ref{3bd,,typing.ClassVar}.  If a field is a @code{ClassVar}, it is excluded
from consideration as a field and is ignored by the dataclass
mechanisms.  Such @code{ClassVar} pseudo-fields are not returned by the
module-level @ref{15ca,,fields()} function.

@node Variable de solo inicialización,Instancias congeladas,Variables de clase,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-init-only-variables}@anchor{4325}@anchor{library/dataclasses init-only-variables}@anchor{4326}
@subsubsection Variable de solo inicialización


Another place where @ref{32e,,@@dataclass} inspects a type annotation is to
determine if a field is an init-only variable.  It does this by seeing
if the type of a field is of type @code{dataclasses.InitVar}.  If a field
is an @code{InitVar}, it is considered a pseudo-field called an init-only
field.  As it is not a true field, it is not returned by the
module-level @ref{15ca,,fields()} function.  Init-only fields are added as
parameters to the generated @ref{751,,__init__()} method, and are passed to
the optional @ref{431f,,__post_init__()} method.  They are not otherwise used
by dataclasses.

Por ejemplo, supongamos que se va a inicializar un campo desde una base de datos, de no proporcionarse un valor al crear la clase:

@example
@@dataclass
class C:
    i: int
    j: int | None = None
    database: InitVar[DatabaseType | None] = None

    def __post_init__(self, database):
        if self.j is None and database is not None:
            self.j = database.lookup('j')

c = C(10, database=my_database)
@end example

In this case, @ref{15ca,,fields()} will return @ref{15f8,,Field} objects for @code{i} and
@code{j}, but not for @code{database}.

@node Instancias congeladas,Herencia<2>,Variable de solo inicialización,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-frozen}@anchor{4327}@anchor{library/dataclasses frozen-instances}@anchor{4328}
@subsubsection Instancias congeladas


It is not possible to create truly immutable Python objects.  However,
by passing @code{frozen=True} to the @ref{32e,,@@dataclass} decorator you can
emulate immutability.  In that case, dataclasses will add
@ref{1f2e,,__setattr__()} and @ref{1f2f,,__delattr__()} methods to the class.  These
methods will raise a @ref{4320,,FrozenInstanceError} when invoked.

There is a tiny performance penalty when using @code{frozen=True}:
@ref{751,,__init__()} cannot use simple assignment to initialize fields, and
must use @code{object.__setattr__()}.

@c Make sure to not remove "object" from "object.__setattr__" in the above markup!

@node Herencia<2>,Re-ordering of keyword-only parameters in __init__,Instancias congeladas,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-inheritance}@anchor{4329}@anchor{library/dataclasses inheritance}@anchor{432a}
@subsubsection Herencia


When the dataclass is being created by the @ref{32e,,@@dataclass} decorator,
it looks through all of the class’s base classes in reverse MRO (that
is, starting at @ref{b18,,object}) and, for each dataclass that it finds,
adds the fields from that base class to an ordered mapping of fields.
After all of the base class fields are added, it adds its own fields
to the ordered mapping.  All of the generated methods will use this
combined, calculated ordered mapping of fields.  Because the fields
are in insertion order, derived classes override base classes.  An
example:

@example
@@dataclass
class Base:
    x: Any = 15.0
    y: int = 0

@@dataclass
class C(Base):
    z: int = 10
    x: int = 15
@end example

The final list of fields is, in order, @code{x}, @code{y}, @code{z}.  The final
type of @code{x} is @ref{1f0,,int}, as specified in class @code{C}.

The generated @ref{751,,__init__()} method for @code{C} will look like:

@example
def __init__(self, x: int = 15, y: int = 0, z: int = 10):
@end example

@node Re-ordering of keyword-only parameters in __init__,Funciones fábrica por defecto,Herencia<2>,dataclasses — Data Classes
@anchor{library/dataclasses re-ordering-of-keyword-only-parameters-in-init}@anchor{432b}
@subsubsection Re-ordering of keyword-only parameters in @code{__init__()}


After the parameters needed for @ref{751,,__init__()} are computed, any
keyword-only parameters are moved to come after all regular
(non-keyword-only) parameters.  This is a requirement of how
keyword-only parameters are implemented in Python: they must come
after non-keyword-only parameters.

In this example, @code{Base.y}, @code{Base.w}, and @code{D.t} are keyword-only
fields, and @code{Base.x} and @code{D.z} are regular fields:

@example
@@dataclass
class Base:
    x: Any = 15.0
    _: KW_ONLY
    y: int = 0
    w: int = 1

@@dataclass
class D(Base):
    z: int = 10
    t: int = field(kw_only=True, default=0)
@end example

The generated @code{__init__()} method for @code{D} will look like:

@example
def __init__(self, x: Any = 15.0, z: int = 10, *, y: int = 0, w: int = 1, t: int = 0):
@end example

Tenga en cuenta que los parámetros se han reordenado a partir de cómo aparecen en la lista de campos: los parámetros derivados de los campos regulares son seguidos por los parámetros derivados de los campos de solo palabras clave.

The relative ordering of keyword-only parameters is maintained in the
re-ordered @code{__init__()} parameter list.

@node Funciones fábrica por defecto,Valores por defecto mutables,Re-ordering of keyword-only parameters in __init__,dataclasses — Data Classes
@anchor{library/dataclasses default-factory-functions}@anchor{432c}
@subsubsection Funciones fábrica por defecto


If a @ref{15f7,,field()} specifies a `default_factory', it is called with
zero arguments when a default value for the field is needed.  For
example, to create a new instance of a list, use:

@example
mylist: list = field(default_factory=list)
@end example

If a field is excluded from @ref{751,,__init__()} (using @code{init=False})
and the field also specifies `default_factory', then the default
factory function will always be called from the generated
@code{__init__()} function.  This happens because there is no other
way to give the field an initial value.

@node Valores por defecto mutables,Campos tipo descriptor,Funciones fábrica por defecto,dataclasses — Data Classes
@anchor{library/dataclasses mutable-default-values}@anchor{432d}
@subsubsection Valores por defecto mutables


Python almacena los valores miembros por defecto en atributos de clase. Considera este ejemplo, sin usar clases de datos:

@example
class C:
    x = []
    def add(self, element):
        self.x.append(element)

o1 = C()
o2 = C()
o1.add(1)
o2.add(2)
assert o1.x == [1, 2]
assert o1.x is o2.x
@end example

Note that the two instances of class @code{C} share the same class
variable @code{x}, as expected.

Usando clases de datos, `si' este código fuera válido:

@example
@@dataclass
class D:
    x: list = []      # This code raises ValueError
    def add(self, element):
        self.x.append(element)
@end example

generaría un código similar a:

@example
class D:
    x = []
    def __init__(self, x=x):
        self.x = x
    def add(self, element):
        self.x.append(element)

assert D().x is D().x
@end example

This has the same issue as the original example using class @code{C}.
That is, two instances of class @code{D} that do not specify a value
for @code{x} when creating a class instance will share the same copy
of @code{x}.  Because dataclasses just use normal Python class
creation they also share this behavior.  There is no general way
for Data Classes to detect this condition.  Instead, the
@ref{32e,,@@dataclass} decorator will raise a @ref{360,,ValueError} if it
detects an unhashable default parameter.  The assumption is that if
a value is unhashable, it is mutable.  This is a partial solution,
but it does protect against many common errors.

Usar las funciones de fábrica por defecto es una forma de crear nuevas instancias de tipos mutables como valores por defecto para campos:

@example
@@dataclass
class D:
    x: list = field(default_factory=list)

assert D().x is not D().x
@end example


Distinto en la versión 3.11: Instead of looking for and disallowing objects of type @ref{18e,,list},
@ref{190,,dict}, or @ref{67a,,set}, unhashable objects are now not allowed as
default values.  Unhashability is used to approximate
mutability.


@node Campos tipo descriptor,,Valores por defecto mutables,dataclasses — Data Classes
@anchor{library/dataclasses descriptor-typed-fields}@anchor{432e}
@subsubsection Campos tipo descriptor


Los campos a los que se asigna @ref{cd7,,objetos descriptor} como valor por defecto tienen los siguientes comportamientos especiales:


@itemize *

@item 
The value for the field passed to the dataclass’s @ref{751,,__init__()} method is
passed to the descriptor’s @ref{1f69,,__set__()} method rather than overwriting the
descriptor object.

@item 
Similarly, when getting or setting the field, the descriptor’s
@ref{1527,,__get__()} or @code{__set__()} method is called rather than returning or
overwriting the descriptor object.

@item 
To determine whether a field contains a default value, @ref{32e,,@@dataclass}
will call the descriptor’s @code{__get__()} method using its class access
form: @code{descriptor.__get__(obj=None, type=cls)}.  If the
descriptor returns a value in this case, it will be used as the
field’s default. On the other hand, if the descriptor raises
@ref{441,,AttributeError} in this situation, no default value will be
provided for the field.
@end itemize

@example
class IntConversionDescriptor:
    def __init__(self, *, default):
        self._default = default

    def __set_name__(self, owner, name):
        self._name = "_" + name

    def __get__(self, obj, type):
        if obj is None:
            return self._default

        return getattr(obj, self._name, self._default)

    def __set__(self, obj, value):
        setattr(obj, self._name, int(value))

@@dataclass
class InventoryItem:
    quantity_on_hand: IntConversionDescriptor = IntConversionDescriptor(default=100)

i = InventoryItem()
print(i.quantity_on_hand)   # 100
i.quantity_on_hand = 2.5    # calls __set__ with 2.5
print(i.quantity_on_hand)   # 2
@end example

Tenga en cuenta que si un campo está anotado con un tipo de descriptor, pero no se le asigna un objeto descriptor como valor por defecto, el campo actuará como un campo normal.

@node contextlib — Utilidades para declaraciones de contexto with,abc — Abstract Base Classes,dataclasses — Data Classes,Servicios en tiempo de ejecución de Python
@anchor{library/contextlib doc}@anchor{432f}@anchor{library/contextlib contextlib-utilities-for-with-statement-contexts}@anchor{4330}@anchor{library/contextlib module-contextlib}@anchor{24}
@subsection @code{contextlib} — Utilidades para declaraciones de contexto @code{with}


@geindex module; contextlib

`Código fuente:' Lib/contextlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/contextlib.py}


__________________________________________________________________


Este módulo proporciona utilidades para tareas comunes que involucran la declaración @ref{673,,with}. Para obtener más información, consulte también @ref{1fbf,,Tipos gestores de contexto} y @ref{1fbd,,Gestores de Contexto en la Declaración with}.

@menu
* Utilidades:: 
* Ejemplos y recetas:: 
* Gestores de contexto de uso único@comma{} reutilizables y reentrantes: Gestores de contexto de uso único reutilizables y reentrantes. 

@end menu

@node Utilidades,Ejemplos y recetas,,contextlib — Utilidades para declaraciones de contexto with
@anchor{library/contextlib utilities}@anchor{4331}
@subsubsection Utilidades


Funciones y clases proporcionadas:

@geindex AbstractContextManager (clase en contextlib)
@anchor{library/contextlib contextlib AbstractContextManager}@anchor{d16}
@deffn {Clase} contextlib.AbstractContextManager

Una @ref{1224,,clase base abstracta} para clases que implementan @ref{669,,object.__enter__()} y @ref{1367,,object.__exit__()}. Se proporciona una implementación predeterminada para @ref{669,,object.__enter__()} que retorna @code{self} mientras que @ref{1367,,object.__exit__()} es un método abstracto que por defecto retorna @code{None}. Véase también la definición de @ref{1fbf,,Tipos gestores de contexto}.


Added in version 3.6.

@end deffn

@geindex AbstractAsyncContextManager (clase en contextlib)
@anchor{library/contextlib contextlib AbstractAsyncContextManager}@anchor{bb4}
@deffn {Clase} contextlib.AbstractAsyncContextManager

Una @ref{1224,,clase base abstracta} para clases que implementan @ref{1fd1,,object.__aenter__()} y @ref{1636,,object.__aexit__()}. Se proporciona una implementación predeterminada para @ref{1fd1,,object.__aenter__()} que retorna @code{self} mientras que @ref{1636,,object.__aexit__()} es un método abstracto que por defecto retorna @code{None}. Véase también la definición de @ref{69c,,Gestores de contexto asíncronos}.


Added in version 3.7.

@end deffn

@geindex contextmanager() (en el módulo contextlib)
@anchor{library/contextlib contextlib contextmanager}@anchor{126f}
@deffn {Función} @@contextlib.contextmanager

This function is a @ref{7cd,,decorator} that can be used to define a factory
function for @ref{673,,with} statement context managers, without needing to
create a class or separate @ref{669,,__enter__()} and @ref{1367,,__exit__()} methods.

Si bien muchos objetos admiten de forma nativa el uso con declaraciones, a veces es necesario administrar un recurso que no sea un administrador de contexto por sí mismo y no implemente un método @code{close()} para usar con @code{contextlib.close}

Un ejemplo abstracto sería el siguiente para garantizar la gestión correcta de los recursos:

@example
from contextlib import contextmanager

@@contextmanager
def managed_resource(*args, **kwds):
    # Code to acquire resource, e.g.:
    resource = acquire_resource(*args, **kwds)
    try:
        yield resource
    finally:
        # Code to release resource, e.g.:
        release_resource(resource)
@end example

La función se puede usar así:

@example
>>> with managed_resource(timeout=3600) as resource:
...     # Resource is released at the end of this block,
...     # even if code in the block raises an exception
@end example

La función que se está decorando debe retornar un iterador @ref{10dd,,generador} cuando se llama. Este iterador debe producir exactamente un valor, que estará vinculado a los objetivos en la @ref{673,,with} declaración de la cláusula @code{as}, si existe.

En el punto donde el generador cede, se ejecuta el bloque anidado en la palabra clave @ref{673,,with}. El generador se reanuda luego de salir del bloque. Si se produce una excepción no controlada en el bloque, se vuelve a plantear dentro del generador en el punto donde se produjo el rendimiento. Por lo tanto, puede usar una declaración @ref{789,,try}…@ref{2f6,,except}…@ref{a5c,,finally} para atrapar el error (si lo hay), o asegurarse de que se realice una limpieza. Si una excepción queda atrapada simplemente para registrarla o realizar alguna acción (en lugar de suprimirla por completo), el generador debe volver a generar esa excepción. De lo contrario, el administrador de contexto del generador indicará a la palabra clave @code{with} que se ha manejado la excepción, y la ejecución se reanudará con la declaración inmediatamente siguiente a la palabra clave @code{with}.

@ref{126f,,contextmanager()} usa @ref{126e,,ContextDecorator} para que los gestores de contexto que crea se puedan usar como decoradores, así como en declaraciones @ref{673,,with}. Cuando se usa como decorador, se crea implícitamente una nueva instancia de generador en cada llamada de función (esto permite que los gestores de contexto «de-un-tiro» creados por @ref{126f,,contextmanager()} cumplan el requisito de que los gestores de contexto admitan múltiples invocaciones para ser utilizado como decoradores).


Distinto en la versión 3.2: Uso de @ref{126e,,ContextDecorator}.

@end deffn

@geindex asynccontextmanager() (en el módulo contextlib)
@anchor{library/contextlib contextlib asynccontextmanager}@anchor{bb3}
@deffn {Función} @@contextlib.asynccontextmanager

@quotation

Similar a @ref{126f,,contextmanager()}, pero crea un @ref{69c,,administrador de contexto asíncrono}.

This function is a @ref{7cd,,decorator} that can be used to define a factory
function for @ref{676,,async with} statement asynchronous context managers,
without needing to create a class or separate @ref{1fd1,,__aenter__()} and
@ref{1636,,__aexit__()} methods. It must be applied to an @ref{2039,,asynchronous generator} function.

Un ejemplo simple:

@example
from contextlib import asynccontextmanager

@@asynccontextmanager
async def get_connection():
    conn = await acquire_db_connection()
    try:
        yield conn
    finally:
        await release_db_connection(conn)

async def get_all_users():
    async with get_connection() as conn:
        return conn.query('SELECT ...')
@end example


Added in version 3.7.


Los administradores de contexto definidos con @ref{bb3,,asynccontextmanager()} se pueden utilizar como decoradores o con declaraciones @ref{676,,async with}:

@example
import time
from contextlib import asynccontextmanager

@@asynccontextmanager
async def timeit():
    now = time.monotonic()
    try:
        yield
    finally:
        print(f'it took @{time.monotonic() - now@}s to run')

@@timeit()
async def main():
    # ... async code ...
@end example

Cuando se utiliza como decorador, se crea implícitamente una nueva instancia de generador en cada llamada de función. Esto permite que los administradores de contexto de otro modo «únicos» creados por @ref{bb3,,asynccontextmanager()} cumplan con el requisito de que los administradores de contexto admitan múltiples invocaciones para ser utilizados como decoradores.
@end quotation


Distinto en la versión 3.10: Los administradores de contexto asíncronos creados con @ref{bb3,,asynccontextmanager()} se pueden utilizar como decoradores.

@end deffn

@geindex closing() (en el módulo contextlib)
@anchor{library/contextlib contextlib closing}@anchor{2940}
@deffn {Función} contextlib.closing (thing)

retorna un gestor de contexto que cierra `thing' al completar el bloque. Esto es básicamente equivalente a:

@example
from contextlib import contextmanager

@@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()
@end example

Y te permite escribir código como este:

@example
from contextlib import closing
from urllib.request import urlopen

with closing(urlopen('https://www.python.org')) as page:
    for line in page:
        print(line)
@end example

sin necesidad de cerrar explícitamente la @code{page}. Incluso si se produce un error, se llamará a @code{page.close()} cuando salga el bloque @ref{673,,with}.

@cartouche
@quotation Nota 
Most types managing resources support the @ref{675,,context manager} protocol,
which closes `thing' on leaving the @ref{673,,with} statement.
As such, @code{closing()} is most useful for third party types that don’t
support context managers.
This example is purely for illustration purposes,
as @ref{20a,,urlopen()} would normally be used in a context manager.
@end quotation
@end cartouche
@end deffn

@geindex aclosing() (en el módulo contextlib)
@anchor{library/contextlib contextlib aclosing}@anchor{884}
@deffn {Función} contextlib.aclosing (thing)

Retorna un administrador de contexto asíncrono que llama al método @code{aclose()} de `thing' una vez completado el bloque. Esto es básicamente equivalente a:

@example
from contextlib import asynccontextmanager

@@asynccontextmanager
async def aclosing(thing):
    try:
        yield thing
    finally:
        await thing.aclose()
@end example

Significativamente, @code{aclosing()} admite la limpieza determinista de generadores asincrónicos cuando salen temprano por @ref{b34,,break} o una excepción. Por ejemplo:

@example
from contextlib import aclosing

async with aclosing(my_generator()) as values:
    async for value in values:
        if value == 42:
            break
@end example

Este patrón garantiza que el código de salida asíncrono del generador se ejecute en el mismo contexto que sus iteraciones (de modo que las excepciones y las variables de contexto funcionen como se esperaba, y el código de salida no se ejecute después de la vida útil de alguna tarea de la que depende).


Added in version 3.10.

@end deffn

@geindex nullcontext() (en el módulo contextlib)
@anchor{library/contextlib simplifying-support-for-single-optional-context-managers}@anchor{4332}@anchor{library/contextlib contextlib nullcontext}@anchor{885}
@deffn {Función} contextlib.nullcontext (enter_result=None)

retorna un gestor de contexto que retorna `enter_result' de @code{__enter__}, pero de lo contrario no hace nada. Está destinado a ser utilizado como un sustituto para un administrador de contexto opcional, por ejemplo:

@example
def myfunction(arg, ignore_exceptions=False):
    if ignore_exceptions:
        # Use suppress to ignore all exceptions.
        cm = contextlib.suppress(Exception)
    else:
        # Do not ignore any exceptions, cm has no effect.
        cm = contextlib.nullcontext()
    with cm:
        # Do something
@end example

Un ejemplo usando `enter_result':

@example
def process_file(file_or_path):
    if isinstance(file_or_path, str):
        # If string, open file
        cm = open(file_or_path)
    else:
        # Caller is responsible for closing file
        cm = nullcontext(file_or_path)

    with cm as file:
        # Perform processing on the file
@end example

También se puede utilizar como sustituto de @ref{69c,,asynchronous context managers}:

@example
async def send_http(session=None):
    if not session:
        # If no http session, create it with aiohttp
        cm = aiohttp.ClientSession()
    else:
        # Caller is responsible for closing the session
        cm = nullcontext(session)

    async with cm as session:
        # Send http requests with session
@end example


Added in version 3.7.



Distinto en la versión 3.10: Se agregó compatibilidad con @ref{678,,asynchronous context manager}.

@end deffn

@geindex suppress() (en el módulo contextlib)
@anchor{library/contextlib contextlib suppress}@anchor{fa8}
@deffn {Función} contextlib.suppress (*exceptions)

Retorna un administrador de contexto que suprime cualquiera de las excepciones especificadas si ocurren en el cuerpo de una instrucción @code{with} y luego reanuda la ejecución con la primera instrucción que sigue al final de la instrucción @code{with}.

Al igual que con cualquier otro mecanismo que suprima completamente las excepciones, este administrador de contexto debe usarse solo para cubrir errores muy específicos en los que se sabe que continuar silenciosamente con la ejecución del programa es lo correcto.

Por ejemplo:

@example
from contextlib import suppress

with suppress(FileNotFoundError):
    os.remove('somefile.tmp')

with suppress(FileNotFoundError):
    os.remove('someotherfile.tmp')
@end example

Este código es equivalente a:

@example
try:
    os.remove('somefile.tmp')
except FileNotFoundError:
    pass

try:
    os.remove('someotherfile.tmp')
except FileNotFoundError:
    pass
@end example

Este gestor de contexto es @ref{4333,,reentrant}.

If the code within the @code{with} block raises a
@ref{3b6,,BaseExceptionGroup}, suppressed exceptions are removed from the
group.  Any exceptions of the group which are not suppressed are re-raised in
a new group which is created using the original group’s @ref{16c8,,derive()}
method.


Added in version 3.4.



Distinto en la versión 3.12: @code{suppress} now supports suppressing exceptions raised as
part of a @ref{3b6,,BaseExceptionGroup}.

@end deffn

@geindex redirect_stdout() (en el módulo contextlib)
@anchor{library/contextlib contextlib redirect_stdout}@anchor{e6d}
@deffn {Función} contextlib.redirect_stdout (new_target)

Administrador de contexto para redirigir temporalmente @ref{b61,,sys.stdout} a otro archivo u objeto similar a un archivo.

Esta herramienta agrega flexibilidad a las funciones o clases existentes cuya salida está programada para stdout.

Por ejemplo, la salida de @ref{96e,,help()} normalmente se envía a `sys.stdout'. Puede capturar esa salida en una cadena redirigiendo la salida a un objeto @ref{fa9,,io.StringIO}. La secuencia de reemplazo se retorna desde el método @code{__enter__} y, por lo tanto, está disponible como destino de la declaración @ref{673,,with}:

@example
with redirect_stdout(io.StringIO()) as f:
    help(pow)
s = f.getvalue()
@end example

Para enviar la salida de @ref{96e,,help()} a un archivo en el disco, redirija la salida a un archivo normal:

@example
with open('help.txt', 'w') as f:
    with redirect_stdout(f):
        help(pow)
@end example

Para enviar la salida de @ref{96e,,help()} a `sys.stderr':

@example
with redirect_stdout(sys.stderr):
    help(pow)
@end example

Tenga en cuenta que el efecto secundario global en @ref{b61,,sys.stdout} significa que este administrador de contexto no es adecuado para su uso en el código de la biblioteca y en la mayoría de las aplicaciones con subprocesos. Tampoco tiene efecto en la salida de subprocesos. Sin embargo, sigue siendo un enfoque útil para muchos scripts de utilidad.

Este gestor de contexto es @ref{4333,,reentrant}.


Added in version 3.4.

@end deffn

@geindex redirect_stderr() (en el módulo contextlib)
@anchor{library/contextlib contextlib redirect_stderr}@anchor{e6c}
@deffn {Función} contextlib.redirect_stderr (new_target)

Similar a @ref{e6d,,redirect_stdout()} pero redirigiendo @ref{9cc,,sys.stderr} a otro archivo u objeto similar a un archivo.

Este gestor de contexto es @ref{4333,,reentrant}.


Added in version 3.5.

@end deffn

@geindex chdir() (en el módulo contextlib)
@anchor{library/contextlib contextlib chdir}@anchor{6ad}
@deffn {Función} contextlib.chdir (path)

Administrador de contexto no seguro en paralelo para cambiar el directorio de trabajo actual. Como esto cambia un estado global, el directorio de trabajo, no es adecuado para su uso en la mayoría de los contextos asincrónicos o de subprocesos. Tampoco es adecuado para la mayoría de las ejecuciones de código no lineal, como los generadores, donde la ejecución del programa se abandona temporalmente; a menos que se desee explícitamente, no debe ceder el paso cuando este administrador de contexto está activo.

Este es un contenedor simple alrededor de @ref{6ae,,chdir()}, cambia el directorio de trabajo actual al ingresar y restaura el anterior al salir.

Este gestor de contexto es @ref{4333,,reentrant}.


Added in version 3.11.

@end deffn

@geindex ContextDecorator (clase en contextlib)
@anchor{library/contextlib contextlib ContextDecorator}@anchor{126e}
@deffn {Clase} contextlib.ContextDecorator

Una clase base que permite que un administrador de contexto también se use como decorador.

Los gestores de contexto que heredan de @code{ContextDecorator} tienen que implementar @code{__enter__} y @code{__exit__} de manera normal. @code{__exit__} conserva su manejo opcional de excepciones incluso cuando se usa como decorador.

@code{ContextDecorator} es utilizado por @ref{126f,,contextmanager()}, por lo que obtiene esta funcionalidad automáticamente.

Ejemplo de @code{ContextDecorator}:

@example
from contextlib import ContextDecorator

class mycontext(ContextDecorator):
    def __enter__(self):
        print('Starting')
        return self

    def __exit__(self, *exc):
        print('Finishing')
        return False
@end example

La clase se puede usar así:

@example
>>> @@mycontext()
... def function():
...     print('The bit in the middle')
...
>>> function()
Starting
The bit in the middle
Finishing

>>> with mycontext():
...     print('The bit in the middle')
...
Starting
The bit in the middle
Finishing
@end example

Este cambio es solo azúcar sintáctico para cualquier construcción de la siguiente forma:

@example
def f():
    with cm():
        # Do stuff
@end example

@code{ContextDecorator} le permite escribir en su lugar:

@example
@@cm()
def f():
    # Do stuff
@end example

Deja en claro que el @code{cm} se aplica a toda la función, en lugar de solo una parte de ella (y guardar un nivel de sangría también es bueno).

Los gestores de contexto existentes que ya tienen una clase base pueden ampliarse utilizando @code{ContextDecorator} como una clase mezcla (`mixin'):

@example
from contextlib import ContextDecorator

class mycontext(ContextBaseClass, ContextDecorator):
    def __enter__(self):
        return self

    def __exit__(self, *exc):
        return False
@end example

@cartouche
@quotation Nota 
Como la función decorada debe poder llamarse varias veces, el gestor de contexto subyacente debe admitir el uso en múltiples declaraciones @ref{673,,with}. Si este no es el caso, se debe utilizar la construcción original con la declaración explícita @code{with} dentro de la función.
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex AsyncContextDecorator (clase en contextlib)
@anchor{library/contextlib contextlib AsyncContextDecorator}@anchor{886}
@deffn {Clase} contextlib.AsyncContextDecorator

Similar a @ref{126e,,ContextDecorator} pero solo para funciones asincrónicas.

Ejemplo de @code{AsyncContextDecorator}:

@example
from asyncio import run
from contextlib import AsyncContextDecorator

class mycontext(AsyncContextDecorator):
    async def __aenter__(self):
        print('Starting')
        return self

    async def __aexit__(self, *exc):
        print('Finishing')
        return False
@end example

La clase se puede usar así:

@example
>>> @@mycontext()
... async def function():
...     print('The bit in the middle')
...
>>> run(function())
Starting
The bit in the middle
Finishing

>>> async def function():
...    async with mycontext():
...         print('The bit in the middle')
...
>>> run(function())
Starting
The bit in the middle
Finishing
@end example


Added in version 3.10.

@end deffn

@geindex ExitStack (clase en contextlib)
@anchor{library/contextlib contextlib ExitStack}@anchor{bb2}
@deffn {Clase} contextlib.ExitStack

Un gestor de contexto que está diseñado para facilitar la combinación programática de otros gestores de contexto y funciones de limpieza, especialmente aquellas que son opcionales o que de otro modo son impulsadas por los datos de entrada.

Por ejemplo, un conjunto de archivos puede manejarse fácilmente en una sola declaración de la siguiente manera:

@example
with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # All opened files will automatically be closed at the end of
    # the with statement, even if attempts to open files later
    # in the list raise an exception
@end example

The @ref{669,,__enter__()} method returns the @ref{bb2,,ExitStack} instance, and
performs no additional operations.

Cada instancia mantiene una pila de retrollamadas registradas que se llaman en orden inverso cuando la instancia se cierra (ya sea explícita o implícitamente al final de una instrucción @ref{673,,with}). Tenga en cuenta que las retrollamadas `no' se invocan implícitamente cuando la instancia de la pila de contexto se recolecta basura.

Este modelo de pila se utiliza para que los administradores de contexto que adquieren sus recursos en su método @code{__init__} (como los objetos de archivo) se puedan manejar correctamente.

Dado que las retrollamadas registradas se invocan en el orden inverso del registro, esto termina comportándose como si se hubieran utilizado múltiples instrucciones anidadas @ref{673,,with} con el conjunto registrado de retrollamadas. Esto incluso se extiende al manejo de excepciones: si una retrollamada interna suprime o reemplaza una excepción, las retrollamadas externas se pasarán argumentos basados en ese estado actualizado.

Esta es una API de nivel relativamente bajo que se ocupa de los detalles de desenrollar correctamente la pila de retrollamadas de salida. Proporciona una base adecuada para administradores de contexto de nivel superior que manipulan la pila de salida en formas específicas de la aplicación.


Added in version 3.3.


@geindex enter_context() (método de contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack enter_context}@anchor{674}
@deffn {Método} enter_context (cm)

Enters a new context manager and adds its @ref{1367,,__exit__()} method to
the callback stack. The return value is the result of the context
manager’s own @ref{669,,__enter__()} method.

Estos administradores de contexto pueden suprimir excepciones tal como lo harían normalmente si se usaran directamente como parte de una declaración @ref{673,,with}.


Distinto en la versión 3.11: Lanza @ref{228,,TypeError} en lugar de @ref{441,,AttributeError} si `cm' no es un administrador de contexto.

@end deffn

@geindex push() (método de contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack push}@anchor{4334}
@deffn {Método} push (exit)

Adds a context manager’s @ref{1367,,__exit__()} method to the callback stack.

As @code{__enter__} is `not' invoked, this method can be used to cover
part of an @ref{669,,__enter__()} implementation with a context manager’s own
@ref{1367,,__exit__()} method.

If passed an object that is not a context manager, this method assumes
it is a callback with the same signature as a context manager’s
@ref{1367,,__exit__()} method and adds it directly to the callback stack.

By returning true values, these callbacks can suppress exceptions the
same way context manager @ref{1367,,__exit__()} methods can.

El objeto pasado se retorna desde la función, lo que permite que este método se use como decorador de funciones.
@end deffn

@geindex callback() (método de contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack callback}@anchor{b10}
@deffn {Método} callback (callback, /, *args, **kwds)

Acepta una función de retrollamada arbitraria y argumentos y la agrega a la pila de retrollamada.

A diferencia de los otros métodos, las retrollamadas agregadas de esta manera no pueden suprimir excepciones (ya que nunca se pasan los detalles de excepción).

La retrollamada pasada se retorna desde la función, lo que permite que este método se use como decorador de funciones.
@end deffn

@geindex pop_all() (método de contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack pop_all}@anchor{4335}
@deffn {Método} pop_all ()

Transfiere la pila de retrollamada a una instancia fresca @ref{bb2,,ExitStack} y la retorna. Esta operación no invoca retrollamadas; en cambio, ahora se invocarán cuando se cierre la nueva pila (ya sea explícita o implícitamente al final de una instrucción @ref{673,,with}).

Por ejemplo, un grupo de archivos se puede abrir como una operación de «todo o nada» de la siguiente manera:

@example
with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # Hold onto the close method, but don't call it yet.
    close_files = stack.pop_all().close
    # If opening any file fails, all previously opened files will be
    # closed automatically. If all files are opened successfully,
    # they will remain open even after the with statement ends.
    # close_files() can then be invoked explicitly to close them all.
@end example
@end deffn

@geindex close() (método de contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack close}@anchor{4336}
@deffn {Método} close ()

Inmediatamente desenrolla la pila de retrollamada, invocando retrollamadas en el orden inverso de registro. Para los administradores de contexto y las retrollamadas de salida registradas, los argumentos pasados indicarán que no se produjo ninguna excepción.
@end deffn
@end deffn

@geindex AsyncExitStack (clase en contextlib)
@anchor{library/contextlib contextlib AsyncExitStack}@anchor{bb5}
@deffn {Clase} contextlib.AsyncExitStack

Un @ref{69c,,gestor de contexto asíncrono}, similar a @ref{bb2,,ExitStack}, que admite la combinación de gestores de contexto síncrono y asíncrono, además de tener rutinas para la lógica de limpieza.

The @ref{4336,,close()} method is not implemented; @ref{4337,,aclose()} must be used
instead.

@geindex enter_async_context() (método de contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack enter_async_context}@anchor{677}
@deffn {Método} coroutine enter_async_context (cm)

Similar to @ref{674,,ExitStack.enter_context()} but expects an asynchronous context
manager.


Distinto en la versión 3.11: Lanza @ref{228,,TypeError} en lugar de @ref{441,,AttributeError} si `cm' no es un administrador de contexto asíncrono.

@end deffn

@geindex push_async_exit() (método de contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack push_async_exit}@anchor{4338}
@deffn {Método} push_async_exit (exit)

Similar to @ref{4334,,ExitStack.push()} but expects either an asynchronous context manager
or a coroutine function.
@end deffn

@geindex push_async_callback() (método de contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack push_async_callback}@anchor{b11}
@deffn {Método} push_async_callback (callback, /, *args, **kwds)

Similar to @ref{b10,,ExitStack.callback()} but expects a coroutine function.
@end deffn

@geindex aclose() (método de contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack aclose}@anchor{4337}
@deffn {Método} coroutine aclose ()

Similar to @ref{4336,,ExitStack.close()} but properly handles awaitables.
@end deffn

Continuando con el ejemplo para @ref{bb3,,asynccontextmanager()}:

@example
async with AsyncExitStack() as stack:
    connections = [await stack.enter_async_context(get_connection())
        for i in range(5)]
    # All opened connections will automatically be released at the end of
    # the async with statement, even if attempts to open a connection
    # later in the list raise an exception.
@end example


Added in version 3.7.

@end deffn

@node Ejemplos y recetas,Gestores de contexto de uso único reutilizables y reentrantes,Utilidades,contextlib — Utilidades para declaraciones de contexto with
@anchor{library/contextlib examples-and-recipes}@anchor{4339}
@subsubsection Ejemplos y recetas


Esta sección describe algunos ejemplos y recetas para hacer un uso efectivo de las herramientas proporcionadas por @ref{24,,contextlib}.

@menu
* Apoyando un número variable de gestores de contexto:: 
* Capturando excepciones de los métodos __enter__:: 
* Limpieza en una implementación __enter__:: 
* Reemplazar cualquier uso de try-finally y marcar variables:: 
* Usar un gestor de contexto como decorador de funciones:: 

@end menu

@node Apoyando un número variable de gestores de contexto,Capturando excepciones de los métodos __enter__,,Ejemplos y recetas
@anchor{library/contextlib supporting-a-variable-number-of-context-managers}@anchor{433a}
@subsubsection Apoyando un número variable de gestores de contexto


El caso de uso principal para @ref{bb2,,ExitStack} es el que se proporciona en la documentación de la clase: admite un número variable de gestores de contexto y otras operaciones de limpieza en una sola @ref{673,,with}. La variabilidad puede provenir de la cantidad de gestores de contexto que necesitan ser impulsados por la entrada del usuario (como abrir una colección de archivos especificada por el usuario), o de que algunos de los gestores de contexto sean opcionales:

@example
with ExitStack() as stack:
    for resource in resources:
        stack.enter_context(resource)
    if need_special_resource():
        special = acquire_special_resource()
        stack.callback(release_special_resource, special)
    # Perform operations that use the acquired resources
@end example

Como se muestra, @ref{bb2,,ExitStack} también hace que sea bastante fácil de usar @ref{673,,with} para administrar recursos arbitrarios que no admiten de forma nativa el protocolo de gestión de contexto.

@node Capturando excepciones de los métodos __enter__,Limpieza en una implementación __enter__,Apoyando un número variable de gestores de contexto,Ejemplos y recetas
@anchor{library/contextlib catching-exceptions-from-enter-methods}@anchor{433b}
@subsubsection Capturando excepciones de los métodos @code{__enter__}


Ocasionalmente es deseable capturar excepciones de una implementación del método @code{__enter__}, `sin' capturar inadvertidamente excepciones del cuerpo de la declaración @ref{673,,with} o el método @code{__exit__} del gestor de contexto. Al usar @ref{bb2,,ExitStack}, los pasos en el protocolo de gestor de contexto se pueden separar ligeramente para permitir esto:

@example
stack = ExitStack()
try:
    x = stack.enter_context(cm)
except Exception:
    # handle __enter__ exception
else:
    with stack:
        # Handle normal case
@end example

Es probable que la necesidad de hacer esto indique que la API subyacente debería proporcionar una interfaz de administración de recursos directa para usar con @ref{789,,try}/@ref{2f6,,except}/@ref{a5c,,finally}, pero no todas las API están bien diseñados en ese sentido. Cuando un administrador de contexto es la única API de administración de recursos proporcionada, entonces @ref{bb2,,ExitStack} puede facilitar el manejo de diversas situaciones que no se pueden manejar directamente en una declaración @ref{673,,with}.

@node Limpieza en una implementación __enter__,Reemplazar cualquier uso de try-finally y marcar variables,Capturando excepciones de los métodos __enter__,Ejemplos y recetas
@anchor{library/contextlib cleaning-up-in-an-enter-implementation}@anchor{433c}
@subsubsection Limpieza en una implementación @code{__enter__}


As noted in the documentation of @ref{4334,,ExitStack.push()}, this
method can be useful in cleaning up an already allocated resource if later
steps in the @ref{669,,__enter__()} implementation fail.

Aquí hay un ejemplo de cómo hacer esto para un administrador de contexto que acepta funciones de adquisición y liberación de recursos, junto con una función de validación opcional, y las asigna al protocolo de administración de contexto:

@example
from contextlib import contextmanager, AbstractContextManager, ExitStack

class ResourceManager(AbstractContextManager):

    def __init__(self, acquire_resource, release_resource, check_resource_ok=None):
        self.acquire_resource = acquire_resource
        self.release_resource = release_resource
        if check_resource_ok is None:
            def check_resource_ok(resource):
                return True
        self.check_resource_ok = check_resource_ok

    @@contextmanager
    def _cleanup_on_error(self):
        with ExitStack() as stack:
            stack.push(self)
            yield
            # The validation check passed and didn't raise an exception
            # Accordingly, we want to keep the resource, and pass it
            # back to our caller
            stack.pop_all()

    def __enter__(self):
        resource = self.acquire_resource()
        with self._cleanup_on_error():
            if not self.check_resource_ok(resource):
                msg = "Failed validation for @{!r@}"
                raise RuntimeError(msg.format(resource))
        return resource

    def __exit__(self, *exc_details):
        # We don't need to duplicate any of our resource release logic
        self.release_resource()
@end example

@node Reemplazar cualquier uso de try-finally y marcar variables,Usar un gestor de contexto como decorador de funciones,Limpieza en una implementación __enter__,Ejemplos y recetas
@anchor{library/contextlib replacing-any-use-of-try-finally-and-flag-variables}@anchor{433d}
@subsubsection Reemplazar cualquier uso de @code{try-finally} y marcar variables


Un patrón que a veces verá es una declaración de @code{try-finally} con una variable de indicador para indicar si el cuerpo de la cláusula @code{finally} debe ejecutarse o no. En su forma más simple (que ya no puede manejarse simplemente usando una cláusula @code{except} en su lugar), se parece a esto:

@example
cleanup_needed = True
try:
    result = perform_operation()
    if result:
        cleanup_needed = False
finally:
    if cleanup_needed:
        cleanup_resources()
@end example

Al igual que con cualquier código basado en la declaración @code{try}, esto puede causar problemas de desarrollo y revisión, porque el código de configuración y el código de limpieza pueden terminar separados por secciones de código arbitrariamente largas.

@ref{bb2,,ExitStack} hace posible registrar una retrollamada para su ejecución al final de una instrucción @code{with}, y luego decide omitir la ejecución de esa retrollamada:

@example
from contextlib import ExitStack

with ExitStack() as stack:
    stack.callback(cleanup_resources)
    result = perform_operation()
    if result:
        stack.pop_all()
@end example

This allows the intended cleanup behaviour to be made explicit up front,
rather than requiring a separate flag variable.

Si una aplicación particular usa mucho este patrón, puede simplificarse aún más por medio de una pequeña clase auxiliar:

@example
from contextlib import ExitStack

class Callback(ExitStack):
    def __init__(self, callback, /, *args, **kwds):
        super().__init__()
        self.callback(callback, *args, **kwds)

    def cancel(self):
        self.pop_all()

with Callback(cleanup_resources) as cb:
    result = perform_operation()
    if result:
        cb.cancel()
@end example

Si la limpieza del recurso no está bien agrupada en una función independiente, entonces todavía es posible usar la forma decoradora de @ref{b10,,ExitStack.callback()} para declarar la limpieza del recurso por adelantado:

@example
from contextlib import ExitStack

with ExitStack() as stack:
    @@stack.callback
    def cleanup_resources():
        ...
    result = perform_operation()
    if result:
        stack.pop_all()
@end example

Debido a la forma en que funciona el protocolo decorador, una función de retrollamada declarada de esta manera no puede tomar ningún parámetro. En cambio, se debe acceder a los recursos que se liberarán como variables de cierre.

@node Usar un gestor de contexto como decorador de funciones,,Reemplazar cualquier uso de try-finally y marcar variables,Ejemplos y recetas
@anchor{library/contextlib using-a-context-manager-as-a-function-decorator}@anchor{433e}
@subsubsection Usar un gestor de contexto como decorador de funciones


@ref{126e,,ContextDecorator} hace posible usar un gestor de contexto tanto en una instrucción ordinaria @code{with} como también como decorador de funciones.

Por ejemplo, a veces es útil envolver funciones o grupos de declaraciones con un registrador que puede rastrear la hora de entrada y la hora de salida. En lugar de escribir tanto un decorador de funciones como un administrador de contexto para la tarea, heredar de @ref{126e,,ContextDecorator} proporciona ambas capacidades en una sola definición:

@example
from contextlib import ContextDecorator
import logging

logging.basicConfig(level=logging.INFO)

class track_entry_and_exit(ContextDecorator):
    def __init__(self, name):
        self.name = name

    def __enter__(self):
        logging.info('Entering: %s', self.name)

    def __exit__(self, exc_type, exc, exc_tb):
        logging.info('Exiting: %s', self.name)
@end example

Las instancias de esta clase se pueden usar como un gestor de contexto:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

Y también como decorador de funciones:

@example
@@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()
@end example

Note that there is one additional limitation when using context managers
as function decorators: there’s no way to access the return value of
@ref{669,,__enter__()}. If that value is needed, then it is still necessary to use
an explicit @code{with} statement.


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - La declaración «with»

La especificación, antecedentes y ejemplos de la declaración de Python @ref{673,,with}.
@end table


@node Gestores de contexto de uso único reutilizables y reentrantes,,Ejemplos y recetas,contextlib — Utilidades para declaraciones de contexto with
@anchor{library/contextlib single-use-reusable-and-reentrant-cms}@anchor{faa}@anchor{library/contextlib single-use-reusable-and-reentrant-context-managers}@anchor{433f}
@subsubsection Gestores de contexto de uso único, reutilizables y reentrantes


La mayoría de los gestores de contexto están escritos de una manera que significa que solo se pueden usar de manera efectiva en una declaración @ref{673,,with} una vez. Estos administradores de contexto de un solo uso deben crearse de nuevo cada vez que se usan; si intenta usarlos por segunda vez, se activará una excepción o, de lo contrario, no funcionará correctamente.

Esta limitación común significa que generalmente es aconsejable crear gestores de contexto directamente en el encabezado de la palabra clave @ref{673,,with} donde se usan (como se muestra en todos los ejemplos de uso anteriores).

Los archivos son un ejemplo de gestores de contexto de un solo uso, ya que la primera @ref{673,,with} cerrará el archivo, evitando cualquier otra operación de E/S que use ese objeto de archivo.

Los gestores de contexto creados usando @ref{126f,,contextmanager()} también son gestores de contexto de un solo uso, y se quejarán de la falla del generador subyacente si se intenta usarlos por segunda vez:

@example
>>> from contextlib import contextmanager
>>> @@contextmanager
... def singleuse():
...     print("Before")
...     yield
...     print("After")
...
>>> cm = singleuse()
>>> with cm:
...     pass
...
Before
After
>>> with cm:
...     pass
...
Traceback (most recent call last):
    ...
RuntimeError: generator didn't yield
@end example

@menu
* Gestores contextuales reentrantes:: 
* Gestores contextuales reutilizables:: 

@end menu

@node Gestores contextuales reentrantes,Gestores contextuales reutilizables,,Gestores de contexto de uso único reutilizables y reentrantes
@anchor{library/contextlib reentrant-cms}@anchor{4333}@anchor{library/contextlib reentrant-context-managers}@anchor{4340}
@subsubsection Gestores contextuales reentrantes


Los gestores de contexto más sofisticados pueden ser «reentrantes». Estos administradores de contexto no solo se pueden usar en múltiples declaraciones @ref{673,,with}, sino que también se pueden usar `inside' a @code{with} que ya está usando el mismo gestor de contexto.

@ref{1d7,,threading.RLock} es un ejemplo de administrador de contexto reentrante, al igual que @ref{fa8,,suppress()}, @ref{e6d,,redirect_stdout()} y @ref{6ad,,chdir()}. Aquí hay un ejemplo muy simple de uso de reentrada:

@example
>>> from contextlib import redirect_stdout
>>> from io import StringIO
>>> stream = StringIO()
>>> write_to_stream = redirect_stdout(stream)
>>> with write_to_stream:
...     print("This is written to the stream rather than stdout")
...     with write_to_stream:
...         print("This is also written to the stream")
...
>>> print("This is written directly to stdout")
This is written directly to stdout
>>> print(stream.getvalue())
This is written to the stream rather than stdout
This is also written to the stream
@end example

Es más probable que los ejemplos del mundo real de reentrada impliquen múltiples funciones que se llaman entre sí y, por lo tanto, sean mucho más complicadas que este ejemplo.

Tenga en cuenta también que ser reentrante `no' es lo mismo que ser seguro para subprocesos. @ref{e6d,,redirect_stdout()}, por ejemplo, definitivamente no es seguro para subprocesos, ya que realiza una modificación global al estado del sistema al vincular @ref{b61,,sys.stdout} a una secuencia diferente.

@node Gestores contextuales reutilizables,,Gestores contextuales reentrantes,Gestores de contexto de uso único reutilizables y reentrantes
@anchor{library/contextlib reusable-cms}@anchor{4341}@anchor{library/contextlib reusable-context-managers}@anchor{4342}
@subsubsection Gestores contextuales reutilizables


Distintos de los administradores de contexto de uso único y reentrante son los administradores de contexto «reutilizables» (o, para ser completamente explícitos, los administradores de contexto «reutilizables, pero no reentrantes», ya que los administradores de contexto reentrantes también son reutilizables). Estos administradores de contexto admiten que se usen varias veces, pero fallarán (o de lo contrario no funcionarán correctamente) si la instancia específica del administrador de contexto ya se ha utilizado en una declaración que contiene.

@ref{1682,,threading.Lock} es un ejemplo de un gestor de contexto reutilizable, pero no reentrante (para un bloqueo reentrante, es necesario usar @ref{1d7,,threading.RLock} en su lugar).

Otro ejemplo de un administrador de contexto reutilizable, pero no reentrante es @ref{bb2,,ExitStack}, ya que invoca `all' las retrollamadas registradas actualmente al dejar cualquier con declaración, independientemente de dónde se agregaron esas retrollamadas:

@example
>>> from contextlib import ExitStack
>>> stack = ExitStack()
>>> with stack:
...     stack.callback(print, "Callback: from first context")
...     print("Leaving first context")
...
Leaving first context
Callback: from first context
>>> with stack:
...     stack.callback(print, "Callback: from second context")
...     print("Leaving second context")
...
Leaving second context
Callback: from second context
>>> with stack:
...     stack.callback(print, "Callback: from outer context")
...     with stack:
...         stack.callback(print, "Callback: from inner context")
...         print("Leaving inner context")
...     print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Callback: from outer context
Leaving outer context
@end example

Como muestra el resultado del ejemplo, la reutilización de un solo objeto de pila en múltiples con declaraciones funciona correctamente, pero intentar anidarlos hará que la pila se borre al final de la declaración más interna, lo que es poco probable que sea un comportamiento deseable.

El uso de instancias separadas @ref{bb2,,ExitStack} en lugar de reutilizar una sola instancia evita ese problema:

@example
>>> from contextlib import ExitStack
>>> with ExitStack() as outer_stack:
...     outer_stack.callback(print, "Callback: from outer context")
...     with ExitStack() as inner_stack:
...         inner_stack.callback(print, "Callback: from inner context")
...         print("Leaving inner context")
...     print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Leaving outer context
Callback: from outer context
@end example

@node abc — Abstract Base Classes,atexit — Exit handlers,contextlib — Utilidades para declaraciones de contexto with,Servicios en tiempo de ejecución de Python
@anchor{library/abc doc}@anchor{4343}@anchor{library/abc abc-abstract-base-classes}@anchor{4344}@anchor{library/abc module-abc}@anchor{4}
@subsection @code{abc} — Abstract Base Classes


@geindex module; abc

@c much of the content adapted from docstrings

`Código fuente:' Lib/abc.py@footnote{https://github.com/python/cpython/tree/main/Lib/abc.py}


__________________________________________________________________


Este módulo proporciona la infraestructura para definir @ref{1224,,clases de base abstracta} (CBAs) en Python, como se describe en 
@geindex Python Enhancement Proposals; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}; consulte en el PEP el porqué fue agregado a Python. (Véase también 
@geindex Python Enhancement Proposals; PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/} y el módulo @ref{9e,,numbers} con respecto a una jerarquía de tipos para números basados en CBAs.)

The @ref{1e,,collections} module has some concrete classes that derive from
ABCs; these can, of course, be further derived. In addition, the
@ref{1f,,collections.abc} submodule has some ABCs that can be used to test whether
a class or instance provides a particular interface, for example, if it is
@ref{6b1,,hashable} or if it is a @ref{1229,,mapping}.

Este módulo provee la metaclase @ref{f9b,,ABCMeta} para definir CBAs y una clase auxiliar @ref{f9a,,ABC} para definir CBAs alternativamente a través de herencia:

@geindex ABC (clase en abc)
@anchor{library/abc abc ABC}@anchor{f9a}
@deffn {Clase} abc.ABC

A helper class that has @ref{f9b,,ABCMeta} as its metaclass.  With this class,
an abstract base class can be created by simply deriving from @code{ABC}
avoiding sometimes confusing metaclass usage, for example:

@example
from abc import ABC

class MyABC(ABC):
    pass
@end example

Note that the type of @code{ABC} is still @ref{f9b,,ABCMeta}, therefore
inheriting from @code{ABC} requires the usual precautions regarding
metaclass usage, as multiple inheritance may lead to metaclass conflicts.
One may also define an abstract base class by passing the metaclass
keyword and using @code{ABCMeta} directly, for example:

@example
from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass
@end example


Added in version 3.4.

@end deffn

@geindex ABCMeta (clase en abc)
@anchor{library/abc abc ABCMeta}@anchor{f9b}
@deffn {Clase} abc.ABCMeta

Metaclases para definir Clases de Base Abstracta (CBAs).

Utilice esta metaclase para crear una CBA.  Una CBA puede ser heredada directamente y así, actuar como una clase mixta.  También se puede registrar clases concretas no relacionadas (incluso clases integradas) y CBAs no relacionadas como «subclases virtuales» – estas y sus descendientes serán consideradas subclases del CBA registrado por la función integrada @ref{85a,,issubclass()}, pero la CBA registrada no aparecerá en su `MRO' (Orden de Resolución de Métodos) ni las implementaciones de método definidas por la CBA registrada serán invocables (ni siquiera a través de @ref{155,,super()}). @footnote{
Los desarrolladores de C++ pueden notar que el concepto de clase base virtual de Python no es el mismo que en C++.
}

Classes created with a metaclass of @code{ABCMeta} have the following method:

@geindex register() (método de abc.ABCMeta)
@anchor{library/abc abc ABCMeta register}@anchor{1105}
@deffn {Método} register (subclass)

Registre la `subclase' como una «subclase virtual» de esta CBA. Por ejemplo:

@example
from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

assert issubclass(tuple, MyABC)
assert isinstance((), MyABC)
@end example


Distinto en la versión 3.3: Retorna la subclase registrada, para permitir su uso como decorador de clase.



Distinto en la versión 3.4: To detect calls to @code{register()}, you can use the
@ref{f99,,get_cache_token()} function.

@end deffn

También se puede redefinir este método en una clase de base abstracta:

@geindex __subclasshook__() (método de abc.ABCMeta)
@anchor{library/abc abc ABCMeta __subclasshook__}@anchor{2524}
@deffn {Método} __subclasshook__ (subclass)

(Debe ser definido como un método de clase.)

Check whether `subclass' is considered a subclass of this ABC.  This means
that you can customize the behavior of @ref{85a,,issubclass()} further without the
need to call @ref{1105,,register()} on every class you want to consider a
subclass of the ABC.  (This class method is called from the
@ref{1f7d,,__subclasscheck__()} method of the ABC.)

This method should return @code{True}, @code{False} or @ref{227,,NotImplemented}.  If
it returns @code{True}, the `subclass' is considered a subclass of this ABC.
If it returns @code{False}, the `subclass' is not considered a subclass of
this ABC, even if it would normally be one.  If it returns
@code{NotImplemented}, the subclass check is continued with the usual
mechanism.

@c XXX explain the "usual mechanism"
@end deffn

Para una demostración de estos conceptos, vea este ejemplo de la definición CBA:

@example
class Foo:
    def __getitem__(self, index):
        ...
    def __len__(self):
        ...
    def get_iterator(self):
        return iter(self)

class MyIterable(ABC):

    @@abstractmethod
    def __iter__(self):
        while False:
            yield None

    def get_iterator(self):
        return self.__iter__()

    @@classmethod
    def __subclasshook__(cls, C):
        if cls is MyIterable:
            if any("__iter__" in B.__dict__ for B in C.__mro__):
                return True
        return NotImplemented

MyIterable.register(Foo)
@end example

The ABC @code{MyIterable} defines the standard iterable method,
@ref{1ccb,,__iter__()}, as an abstract method.  The implementation given
here can still be called from subclasses.  The @code{get_iterator()} method
is also part of the @code{MyIterable} abstract base class, but it does not have
to be overridden in non-abstract derived classes.

The @ref{2524,,__subclasshook__()} class method defined here says that any class
that has an @ref{1ccb,,__iter__()} method in its
@ref{5fe,,__dict__} (or in that of one of its base classes, accessed
via the @ref{1f2a,,__mro__} list) is considered a @code{MyIterable} too.

Finally, the last line makes @code{Foo} a virtual subclass of @code{MyIterable},
even though it does not define an @ref{1ccb,,__iter__()} method (it uses
the old-style iterable protocol, defined in terms of @ref{1f62,,__len__()} and
@ref{3d8,,__getitem__()}).  Note that this will not make @code{get_iterator}
available as a method of @code{Foo}, so it is provided separately.
@end deffn

The @code{abc} module also provides the following decorator:

@geindex abstractmethod() (en el módulo abc)
@anchor{library/abc abc abstractmethod}@anchor{1102}
@deffn {Función} @@abc.abstractmethod

Un decorador que indica métodos abstractos.

Using this decorator requires that the class’s metaclass is @ref{f9b,,ABCMeta}
or is derived from it.  A class that has a metaclass derived from
@code{ABCMeta} cannot be instantiated unless all of its abstract methods
and properties are overridden.  The abstract methods can be called using any
of the normal “super” call mechanisms.  @code{abstractmethod()} may be used
to declare abstract methods for properties and descriptors.

Dynamically adding abstract methods to a class, or attempting to modify the
abstraction status of a method or class once it is created, are only
supported using the @ref{4345,,update_abstractmethods()} function.  The
@code{abstractmethod()} only affects subclasses derived using regular
inheritance; «virtual subclasses» registered with the ABC’s
@ref{1105,,register()} method are not affected.

When @code{abstractmethod()} is applied in combination with other method
descriptors, it should be applied as the innermost decorator, as shown in
the following usage examples:

@example
class C(ABC):
    @@abstractmethod
    def my_abstract_method(self, arg1):
        ...
    @@classmethod
    @@abstractmethod
    def my_abstract_classmethod(cls, arg2):
        ...
    @@staticmethod
    @@abstractmethod
    def my_abstract_staticmethod(arg3):
        ...

    @@property
    @@abstractmethod
    def my_abstract_property(self):
        ...
    @@my_abstract_property.setter
    @@abstractmethod
    def my_abstract_property(self, val):
        ...

    @@abstractmethod
    def _get_x(self):
        ...
    @@abstractmethod
    def _set_x(self, val):
        ...
    x = property(_get_x, _set_x)
@end example

In order to correctly interoperate with the abstract base class machinery,
the descriptor must identify itself as abstract using
@code{__isabstractmethod__}. In general, this attribute should be @code{True}
if any of the methods used to compose the descriptor are abstract. For
example, Python’s built-in @ref{2fd,,property} does the equivalent of:

@example
class Descriptor:
    ...
    @@property
    def __isabstractmethod__(self):
        return any(getattr(f, '__isabstractmethod__', False) for
                   f in (self._fget, self._fset, self._fdel))
@end example

@cartouche
@quotation Nota 
A diferencia de los métodos abstractos de Java, estos métodos abstractos pueden tener una implementación. Esta implementación se puede llamar a través del mecanismo @ref{155,,super()} de la clase que lo invalida.  Esto podría ser útil como un `end-point' para una super llamada en un `framework' que use herencia múltiple cooperativa.
@end quotation
@end cartouche
@end deffn

The @code{abc} module also supports the following legacy decorators:

@geindex abstractclassmethod() (en el módulo abc)
@anchor{library/abc abc abstractclassmethod}@anchor{1103}
@deffn {Función} @@abc.abstractclassmethod


Added in version 3.2.



Obsoleto desde la versión 3.3: Ahora es posible utilizar @ref{2d2,,classmethod} con @ref{1102,,abstractmethod()}, lo cual hace que este decorador sea redundante.


Una subclase de la @ref{2d2,,classmethod()} incorporada, indicando un método de clase abstracto. De otra forma, es similar a @ref{1102,,abstractmethod()}.

Este caso especial está obsoleto, ya que el decorador @ref{2d2,,classmethod()} ahora es identificado correctamente como abstracto cuando se aplica a un método abstracto:

@example
class C(ABC):
    @@classmethod
    @@abstractmethod
    def my_abstract_classmethod(cls, arg):
        ...
@end example
@end deffn

@geindex abstractstaticmethod() (en el módulo abc)
@anchor{library/abc abc abstractstaticmethod}@anchor{1104}
@deffn {Función} @@abc.abstractstaticmethod


Added in version 3.2.



Obsoleto desde la versión 3.3: Ahora es posible utilizar @ref{22e,,staticmethod} con @ref{1102,,abstractmethod()}, haciendo que este decorador sea redundante.


Una subclase de la @ref{22e,,staticmethod()} incorporada, indicando un método estático abstracto. De otra forma, es similar a @ref{1102,,abstractmethod()}.

Este caso especial está obsoleto, ya que el decorador @ref{22e,,staticmethod()} ahora es identificado correctamente como abstracto cuando se aplica a un método abstracto:

@example
class C(ABC):
    @@staticmethod
    @@abstractmethod
    def my_abstract_staticmethod(arg):
        ...
@end example
@end deffn

@geindex abstractproperty() (en el módulo abc)
@anchor{library/abc abc abstractproperty}@anchor{1101}
@deffn {Función} @@abc.abstractproperty


Obsoleto desde la versión 3.3: Ahora es posible utilizar @ref{2fd,,property}, @ref{1665,,property.getter()}, @ref{1666,,property.setter()} y @ref{1667,,property.deleter()} con @ref{1102,,abstractmethod()}, lo cual hace que este decorador sea redundante.


Una subclase de la @ref{2fd,,property()} integrada, que indica una propiedad abstracta.

Este caso especial está obsoleto, ya que el decorador @ref{2fd,,property()} ahora es identificado correctamente como abstracto cuando es aplicado a un método abstracto:

@example
class C(ABC):
    @@property
    @@abstractmethod
    def my_abstract_property(self):
        ...
@end example

En el ejemplo anterior se define una propiedad de solo lectura; también se puede definir una propiedad abstracta de lectura y escritura marcando adecuadamente uno o varios de los métodos subyacentes como abstractos:

@example
class C(ABC):
    @@property
    def x(self):
        ...

    @@x.setter
    @@abstractmethod
    def x(self, val):
        ...
@end example

Si solo algunos componentes son abstractos, solo estos componentes necesitan ser actualizados para crear una propiedad concreta en una subclase:

@example
class D(C):
    @@C.x.setter
    def x(self, val):
        ...
@end example
@end deffn

The @code{abc} module also provides the following functions:

@geindex get_cache_token() (en el módulo abc)
@anchor{library/abc abc get_cache_token}@anchor{f99}
@deffn {Función} abc.get_cache_token ()

Retorna el token de caché de la clase base abstracta actual.

El token es un objeto opaco (que admite pruebas de igualdad) que identifica la versión actual de la caché de clases de base abstractas para subclases virtuales. El token cambia con cada llamada a @ref{1105,,ABCMeta.register()} en cualquier CBA.


Added in version 3.4.

@end deffn

@geindex update_abstractmethods() (en el módulo abc)
@anchor{library/abc abc update_abstractmethods}@anchor{4345}
@deffn {Función} abc.update_abstractmethods (cls)

Una función para recalcular el estado de abstracción de una clase abstracta. Se debe llamar a esta función si los métodos abstractos de una clase se han implementado o cambiado después de su creación. Por lo general, esta función debe llamarse desde dentro de un decorador de clases.

Retorna `cls', para permitir su uso como decorador de clases.

Si `cls' no es una instancia de @ref{f9b,,ABCMeta}, no hace nada.

@cartouche
@quotation Nota 
Esta función asume que las superclases de `cls' ya están actualizadas. No actualiza subclases.
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@subsubheading Notas al pie


@node atexit — Exit handlers,traceback — Print or retrieve a stack traceback,abc — Abstract Base Classes,Servicios en tiempo de ejecución de Python
@anchor{library/atexit doc}@anchor{4346}@anchor{library/atexit atexit-exit-handlers}@anchor{4347}@anchor{library/atexit module-atexit}@anchor{d}
@subsection @code{atexit} — Exit handlers


@geindex module; atexit


__________________________________________________________________


El módulo @ref{d,,atexit} define funciones para registrar y cancelar el registro de las funciones de limpieza. Las funciones así registradas se ejecutan de forma automática al terminar el intérprete normalmente. El módulo @ref{d,,atexit} realiza estas funciones en el orden `inverso' en el que se registraron; si ingresa @code{A}, @code{B}, y @code{C}, cuando el intérprete se detenga, se ejecutarán en el orden @code{C}, @code{B}, @code{A}.

`Nota:' Las funciones registradas a través de este módulo no son llamadas cuando el programa es eliminado por una señal no manejada por Python, cuando se detecta un error fatal interno en Python o cuando se llama a la función @ref{229b,,os._exit()}.

`Nota:' El efecto de registrar o cancelar el registro de funciones dentro de una función de limpieza no esta definido.


Distinto en la versión 3.7: Cuando se usan con sub-intérpretes API C, las funciones registradas son locales para el intérprete en el que se registraron.


@geindex register() (en el módulo atexit)
@anchor{library/atexit atexit register}@anchor{915}
@deffn {Función} atexit.register (func, *args, **kwargs)

Registra `func' como una función que se ejecutará cuando el intérprete se termine. Cualquier argumento opcional que deba pasarse a `func' debe pasarse como un argumento para la función @ref{915,,register()}. Es posible registrar la misma función y argumentos más de una vez.

En la finalización normal del programa (por ejemplo, si se llama a la función @ref{13b0,,sys.exit()} o finaliza la ejecución del módulo principal), todas las funciones registradas son llamadas en el orden último en entrar, primero en salir. Se supone que los módulos de menor nivel normalmente se importarán antes que los módulos de mayor nivel,  y por lo tanto, se limpiarán al final.

Si se lanza una excepción durante la ejecución de los manejadores de salida, se muestra un rastreo (a menos que se haya lanzado @ref{dc7,,SystemExit}) y se guarda la información de la excepción. Después de que todos los manejadores de salida hayan tenido la oportunidad de ejecutarse, la última excepción lanzada se vuelve a lanzar.

Esta función retorna `func', lo que hace posible usarlo como decorador.

@cartouche
@quotation Advertencia 
Iniciar nuevos hilos o llamar a @ref{2ff,,os.fork()} desde una función registrada puede llevar a una condición de carrera entre el hilo principal de Python liberando estados de hilos mientras las rutinas internas de @ref{ed,,threading} o el nuevo proceso intentan usar ese estado. Esto puede provocar fallos en lugar de un cierre limpio.
@end quotation
@end cartouche


Distinto en la versión 3.12: Los intentos de iniciar un nuevo hilo o @ref{2ff,,bifurcar} un nuevo proceso en una función registrada conducen ahora a un @ref{1e5,,RuntimeError}.

@end deffn

@geindex unregister() (en el módulo atexit)
@anchor{library/atexit atexit unregister}@anchor{4348}
@deffn {Función} atexit.unregister (func)

Elimina `func' de la lista de funciones que se ejecutarán en el apagado del intérprete. La función @ref{4348,,unregister()} silenciosamente no hace nada si la `func' no se registró previamente. Si `func' se ha registrado más de una vez, se eliminarán todas las apariciones de esa función en la pila de llamadas de @ref{d,,atexit}. Se utilizan comparaciones de igualdad (“”==””) internamente durante la cancelación del registro, por lo que las referencias de funciones no necesitan tener identidades coincidentes.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{ba,,readline}

Un ejemplo útil del uso de @ref{d,,atexit} para leer y escribir archivos de historial @ref{ba,,readline}.
@end table


@menu
* Ejemplo con atexit:: 

@end menu

@node Ejemplo con atexit,,,atexit — Exit handlers
@anchor{library/atexit atexit-example}@anchor{4349}@anchor{library/atexit id1}@anchor{434a}
@subsubsection Ejemplo con @code{atexit}


El siguiente ejemplo muestra cómo un módulo puede inicializar un contador desde un archivo cuando se importa, y guardar el valor del contador actualizado automáticamente cuando finaliza el programa, sin necesidad de que la aplicación realice una llamada explícita en este módulo cuando el intérprete se detiene.

@example
try:
    with open('counterfile') as infile:
        _count = int(infile.read())
except FileNotFoundError:
    _count = 0

def incrcounter(n):
    global _count
    _count = _count + n

def savecounter():
    with open('counterfile', 'w') as outfile:
        outfile.write('%d' % _count)

import atexit

atexit.register(savecounter)
@end example

Los argumentos posicionales y de palabras clave también se pueden pasar a la función @ref{915,,register()} para volver a pasar a la función registrada cuando se llama:

@example
def goodbye(name, adjective):
    print('Goodbye %s, it was %s to meet you.' % (name, adjective))

import atexit

atexit.register(goodbye, 'Donny', 'nice')
# or:
atexit.register(goodbye, adjective='nice', name='Donny')
@end example

Usar como un @ref{7cd,,decorator}:

@example
import atexit

@@atexit.register
def goodbye():
    print('You are now leaving the Python sector.')
@end example

Esto solo funciona con funciones que se puedan llamar sin argumentos.

@node traceback — Print or retrieve a stack traceback,__future__ — Future statement definitions,atexit — Exit handlers,Servicios en tiempo de ejecución de Python
@anchor{library/traceback doc}@anchor{434b}@anchor{library/traceback module-traceback}@anchor{fe}@anchor{library/traceback traceback-print-or-retrieve-a-stack-traceback}@anchor{434c}
@subsection @code{traceback} — Print or retrieve a stack traceback


@geindex module; traceback

`Código fuente:' Lib/traceback.py@footnote{https://github.com/python/cpython/tree/main/Lib/traceback.py}


__________________________________________________________________


This module provides a standard interface to extract, format and print
stack traces of Python programs. It is more flexible than the
interpreter’s default traceback display, and therefore makes it
possible to configure certain aspects of the output. Finally,
it contains a utility for capturing enough information about an
exception to print it later, without the need to save a reference
to the actual exception. Since exceptions can be the roots of large
objects graph, this utility can significantly improve
memory management.

@geindex object;traceback

The module uses @ref{b7f,,traceback objects} — these are
objects of type @ref{b7d,,types.TracebackType},
which are assigned to the @ref{1330,,__traceback__} field of
@ref{65c,,BaseException} instances.


@subsubheading Ver también



@table @asis

@item Módulo @ref{58,,faulthandler}

Usado para volcar explícitamente los rastreos Python, en un error, después de un tiempo de espera (`timeout'), o en una señal de usuario.

@item Módulo @ref{a5,,pdb}

Depurador interactivo de código fuente para programas Python.
@end table


The module’s API can be divided into two parts:


@itemize *

@item 
Module-level functions offering basic functionality, which are useful for interactive
inspection of exceptions and tracebacks.

@item 
@ref{3b3,,TracebackException} class and its helper classes
@ref{f06,,StackSummary} and @ref{f07,,FrameSummary}. These offer both more
flexibility in the output generated and the ability to store the information
necessary for later formatting without holding references to actual exception
and traceback objects.
@end itemize

@menu
* Module-Level Functions:: 
* TracebackException Objects:: 
* StackSummary Objects:: 
* FrameSummary Objects:: 
* Examples of Using the Module-Level Functions:: 
* Examples of Using TracebackException:: 

@end menu

@node Module-Level Functions,TracebackException Objects,,traceback — Print or retrieve a stack traceback
@anchor{library/traceback module-level-functions}@anchor{434d}
@subsubsection Module-Level Functions


@geindex print_tb() (en el módulo traceback)
@anchor{library/traceback traceback print_tb}@anchor{f08}
@deffn {Función} traceback.print_tb (tb, limit=None, file=None)

Print up to `limit' stack trace entries from
@ref{b7f,,traceback object} `tb' (starting
from the caller’s frame) if `limit' is positive.  Otherwise, print the last
@code{abs(limit)} entries.  If `limit' is omitted or @code{None}, all entries are
printed.  If `file' is omitted or @code{None}, the output goes to
@ref{9cc,,sys.stderr}; otherwise it should be an open
@ref{1230,,file} or @ref{2586,,file-like object} to
receive the output.

@cartouche
@quotation Nota 
The meaning of the `limit' parameter is different than the meaning
of @ref{15dd,,sys.tracebacklimit}. A negative `limit' value corresponds to
a positive value of @code{sys.tracebacklimit}, whereas the behaviour of
a positive `limit' value cannot be achieved with
@code{sys.tracebacklimit}.
@end quotation
@end cartouche


Distinto en la versión 3.5: Soporte para `limit' negativo añadido.

@end deffn

@geindex print_exception() (en el módulo traceback)
@anchor{library/traceback traceback print_exception}@anchor{8e6}
@deffn {Función} traceback.print_exception (exc, /[, value, tb], limit=None, file=None, chain=True)

Print exception information and stack trace entries from
@ref{b7f,,traceback object}
`tb' to `file'. This differs from @ref{f08,,print_tb()} in the following
ways:


@itemize *

@item 
si `tb' no es @code{None}, muestra una cabecera @code{Traceback (most recent call last):}

@item 
imprime el tipo de excepción y `value' después del seguimiento de la pila
@end itemize

@geindex ^ (caret);marker


@itemize *

@item 
si `type(value)' es @ref{150,,SyntaxError} y `value' tiene el formato apropiado, muestra la línea donde el error sintáctico ha ocurrido con un cursor indicando la posición aproximada del error.
@end itemize

Desde Python 3.10, en lugar de pasar `value' y `tb', se puede pasar un objeto de excepción como primer argumento. Si se proporcionan `value' y `tb', el primer argumento se ignora para proporcionar compatibilidad con versiones anteriores.

The optional `limit' argument has the same meaning as for @ref{f08,,print_tb()}.
If `chain' is true (the default), then chained exceptions (the
@ref{1332,,__cause__} or @ref{1331,,__context__}
attributes of the exception) will be
printed as well, like the interpreter itself does when printing an unhandled
exception.


Distinto en la versión 3.5: El argumento `etype' es ignorado e infiere desde el tipo de `value'.



Distinto en la versión 3.10: El parámetro `etype' ha cambiado de nombre a `exc' y ahora es solo posicional.

@end deffn

@geindex print_exc() (en el módulo traceback)
@anchor{library/traceback traceback print_exc}@anchor{1887}
@deffn {Función} traceback.print_exc (limit=None, file=None, chain=True)

Esto es un atajo para @code{print_exception(sys.exception(), limit, file, chain)}.
@end deffn

@geindex print_last() (en el módulo traceback)
@anchor{library/traceback traceback print_last}@anchor{434e}
@deffn {Función} traceback.print_last (limit=None, file=None, chain=True)

Esto es un atajo para @code{print_exception(sys.last_exc, limit, file, chain)}. En general, solo funciona después de que una excepción ha alcanzado un prompt interactivo (ver @ref{565,,sys.last_exc}).
@end deffn

@geindex print_stack() (en el módulo traceback)
@anchor{library/traceback traceback print_stack}@anchor{f09}
@deffn {Función} traceback.print_stack (f=None, limit=None, file=None)

Print up to `limit' stack trace entries (starting from the invocation
point) if `limit' is positive.  Otherwise, print the last @code{abs(limit)}
entries.  If `limit' is omitted or @code{None}, all entries are printed.
The optional `f' argument can be used to specify an alternate
@ref{780,,stack frame}
to start.  The optional `file' argument has the same meaning as for
@ref{f08,,print_tb()}.


Distinto en la versión 3.5: Soporte para `limit' negativo añadido.

@end deffn

@geindex extract_tb() (en el módulo traceback)
@anchor{library/traceback traceback extract_tb}@anchor{434f}
@deffn {Función} traceback.extract_tb (tb, limit=None)

Return a @ref{f06,,StackSummary} object representing a list of «pre-processed»
stack trace entries extracted from the
@ref{b7f,,traceback object} `tb'.  It is useful
for alternate formatting of stack traces.  The optional `limit' argument has
the same meaning as for @ref{f08,,print_tb()}.  A «pre-processed» stack trace
entry is a @ref{f07,,FrameSummary} object containing attributes
@ref{4350,,filename}, @ref{4351,,lineno},
@ref{4352,,name}, and @ref{4353,,line} representing the
information that is usually printed for a stack trace.
@end deffn

@geindex extract_stack() (en el módulo traceback)
@anchor{library/traceback traceback extract_stack}@anchor{4354}
@deffn {Función} traceback.extract_stack (f=None, limit=None)

Extract the raw traceback from the current
@ref{780,,stack frame}.  The return value has
the same format as for @ref{434f,,extract_tb()}.  The optional `f' and `limit'
arguments have the same meaning as for @ref{f09,,print_stack()}.
@end deffn

@geindex format_list() (en el módulo traceback)
@anchor{library/traceback traceback format_list}@anchor{4355}
@deffn {Función} traceback.format_list (extracted_list)

Dada una lista de tuplas u objetos @ref{f07,,FrameSummary} según lo retornado por @ref{434f,,extract_tb()} o @ref{4354,,extract_stack()}, retorna una lista de cadenas preparadas para ser mostradas. Cada cadena en la lista resultante corresponde con el elemento con el mismo índice en la lista de argumentos. Cada cadena finaliza en una nueva línea; las cadenas pueden contener nuevas líneas internas también, para aquellos elementos cuya línea de texto de origen no es @code{None}.
@end deffn

@geindex format_exception_only() (en el módulo traceback)
@anchor{library/traceback traceback format_exception_only}@anchor{8e5}
@deffn {Función} traceback.format_exception_only (exc, /[, value], *, show_group=False)

Format the exception part of a traceback using an exception value such as
given by @ref{567,,sys.last_value}.  The return value is a list of strings, each
ending in a newline.  The list contains the exception’s message, which is
normally a single string; however, for @ref{150,,SyntaxError} exceptions, it
contains several lines that (when printed) display detailed information
about where the syntax error occurred. Following the message, the list
contains the exception’s @ref{2288,,notes}.

Desde Python 3,10, en lugar de pasar `value', un objeto de excepción se puede pasar como primer argumento. Si se proporciona `value', el primer argumento se ignora el fin de proporcionar compatibilidad hacia atrás.

When `show_group' is @code{True}, and the exception is an instance of
@ref{3b6,,BaseExceptionGroup}, the nested exceptions are included as
well, recursively, with indentation relative to their nesting depth.


Distinto en la versión 3.10: El parámetro `etype' ha cambiado de nombre a `exc' y ahora es solo posicional.



Distinto en la versión 3.11: The returned list now includes any
@ref{2288,,notes} attached to the exception.



Distinto en la versión 3.13: `show_group' parameter was added.

@end deffn

@geindex format_exception() (en el módulo traceback)
@anchor{library/traceback traceback format_exception}@anchor{8e4}
@deffn {Función} traceback.format_exception (exc, /[, value, tb], limit=None, chain=True)

Formatea una traza de pila y la información de la excepción. Los argumentos tienen el mismo significado que los argumentos correspondientes a @ref{8e6,,print_exception()}. El valor retornado es una lista de cadenas, acabando cada una en una nueva línea y algunas contienen nuevas líneas internas. Cuando estas líneas son concatenadas y mostradas, exactamente el mismo texto es mostrado como hace @ref{8e6,,print_exception()}.


Distinto en la versión 3.5: El argumento `etype' es ignorado e infiere desde el tipo de `value'.



Distinto en la versión 3.10: El comportamiento y la firma de esta función se modificaron para coincidir con @ref{8e6,,print_exception()}.

@end deffn

@geindex format_exc() (en el módulo traceback)
@anchor{library/traceback traceback format_exc}@anchor{4356}
@deffn {Función} traceback.format_exc (limit=None, chain=True)

Esto es como @code{print_exc(limit)} pero retorna una cadena en lugar de imprimirlo en un archivo.
@end deffn

@geindex format_tb() (en el módulo traceback)
@anchor{library/traceback traceback format_tb}@anchor{423b}
@deffn {Función} traceback.format_tb (tb, limit=None)

Un atajo para @code{format_list(extract_tb(tb, limit))}.
@end deffn

@geindex format_stack() (en el módulo traceback)
@anchor{library/traceback traceback format_stack}@anchor{4357}
@deffn {Función} traceback.format_stack (f=None, limit=None)

Un atajo para @code{format_list(extract_stack(f, limit))}.
@end deffn

@geindex clear_frames() (en el módulo traceback)
@anchor{library/traceback traceback clear_frames}@anchor{1053}
@deffn {Función} traceback.clear_frames (tb)

Clears the local variables of all the stack frames in a
@ref{b7f,,traceback} `tb'
by calling the @ref{3d5,,clear()} method of each
@ref{780,,frame object}.


Added in version 3.4.

@end deffn

@geindex walk_stack() (en el módulo traceback)
@anchor{library/traceback traceback walk_stack}@anchor{f04}
@deffn {Función} traceback.walk_stack (f)

Walk a stack following @ref{825,,f.f_back} from the given frame,
yielding the frame
and line number for each frame. If `f' is @code{None}, the current stack is
used. This helper is used with @ref{4358,,StackSummary.extract()}.


Added in version 3.5.

@end deffn

@geindex walk_tb() (en el módulo traceback)
@anchor{library/traceback traceback walk_tb}@anchor{f05}
@deffn {Función} traceback.walk_tb (tb)

Walk a traceback following @ref{b7e,,tb_next} yielding the frame and
line number
for each frame. This helper is used with @ref{4358,,StackSummary.extract()}.


Added in version 3.5.

@end deffn

@node TracebackException Objects,StackSummary Objects,Module-Level Functions,traceback — Print or retrieve a stack traceback
@anchor{library/traceback tracebackexception-objects}@anchor{4359}
@subsubsection @code{TracebackException} Objects



Added in version 3.5.


@code{TracebackException} objects are created from actual exceptions to
capture data for later printing.  They offer a more lightweight method of
storing this information by avoiding holding references to
@ref{b7f,,traceback} and @ref{780,,frame} objects
In addition, they expose more options to configure the output compared to
the module-level functions described above.

@geindex TracebackException (clase en traceback)
@anchor{library/traceback traceback TracebackException}@anchor{3b3}
@deffn {Clase} traceback.TracebackException (exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False, compact=False, max_group_width=15, max_group_depth=10)

Capture an exception for later rendering. The meaning of `limit',
`lookup_lines' and `capture_locals' are as for the @ref{f06,,StackSummary}
class.

If `compact' is true, only data that is required by
@code{TracebackException}’s @ref{6c0,,format()} method
is saved in the class attributes. In particular, the
@ref{435a,,__context__} field is calculated only if @ref{435b,,__cause__} is
@code{None} and @ref{435c,,__suppress_context__} is false.

Tenga en cuenta que cuando se capturan locales, también se muestran en el rastreo.

`max_group_width' (`anchura máxima del grupo') y `max_group_depth' (`profundidad máxima del grupo') controlan el formato del grupo de excepciones (ver @ref{3b6,,BaseExceptionGroup}). La profundidad (`depth') se refiere al nivel de anidamiento del grupo, y la anchura (`width') se refiere al tamaño de una excepción simple perteneciente al arreglo del grupo de excepciones. El formato de salida se trunca cuando se excede el límite.


Distinto en la versión 3.10: Se agregó el parámetro `compact'.



Distinto en la versión 3.11: Se agregaron los parámetros `max_group_width' y `max_group_depth'


@geindex __cause__ (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __cause__}@anchor{435b}
@deffn {Atributo} __cause__

A @code{TracebackException} of the original
@ref{1332,,__cause__}.
@end deffn

@geindex __context__ (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __context__}@anchor{435a}
@deffn {Atributo} __context__

A @code{TracebackException} of the original
@ref{1331,,__context__}.
@end deffn

@geindex exceptions (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exceptions}@anchor{435d}
@deffn {Atributo} exceptions

If @code{self} represents an @ref{31d,,ExceptionGroup}, this field holds a list of
@code{TracebackException} instances representing the nested exceptions.
Otherwise it is @code{None}.


Added in version 3.11.

@end deffn

@geindex __suppress_context__ (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __suppress_context__}@anchor{435c}
@deffn {Atributo} __suppress_context__

The @ref{20b3,,__suppress_context__} value from the original
exception.
@end deffn

@geindex __notes__ (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __notes__}@anchor{435e}
@deffn {Atributo} __notes__

The @ref{2288,,__notes__} value from the original exception,
or @code{None}
if the exception does not have any notes. If it is not @code{None}
is it formatted in the traceback after the exception string.


Added in version 3.11.

@end deffn

@geindex stack (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException stack}@anchor{435f}
@deffn {Atributo} stack

Una clase @ref{f06,,StackSummary} representando el seguimiento de pila.
@end deffn

@geindex exc_type (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exc_type}@anchor{3b4}
@deffn {Atributo} exc_type

La clase del seguimiento de pila original.


Obsoleto desde la versión 3.13.

@end deffn

@geindex exc_type_str (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exc_type_str}@anchor{3b2}
@deffn {Atributo} exc_type_str

String display of the class of the original exception.


Added in version 3.13.

@end deffn

@geindex filename (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException filename}@anchor{4360}
@deffn {Atributo} filename

Para errores sintácticos - el nombre del archivo donde el error ha ocurrido.
@end deffn

@geindex lineno (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException lineno}@anchor{4361}
@deffn {Atributo} lineno

Para errores sintácticos - el número de línea donde el error ha ocurrido.
@end deffn

@geindex end_lineno (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException end_lineno}@anchor{4362}
@deffn {Atributo} end_lineno

Para errores sintácticos - el número de línea donde el error ha ocurrido. Puede ser @code{None} si no está presente.


Added in version 3.10.

@end deffn

@geindex text (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException text}@anchor{4363}
@deffn {Atributo} text

Para errores sintácticos - el texto donde el error ha ocurrido.
@end deffn

@geindex offset (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException offset}@anchor{4364}
@deffn {Atributo} offset

Para errores sintácticos - el `offset' en el texto donde el error ha ocurrido.
@end deffn

@geindex end_offset (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException end_offset}@anchor{4365}
@deffn {Atributo} end_offset

Para errores sintácticos - el `offset' en el texto donde el error ha ocurrido. Puede ser @code{None} si no está presente.


Added in version 3.10.

@end deffn

@geindex msg (atributo de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException msg}@anchor{4366}
@deffn {Atributo} msg

Para errores sintácticos - el mensaje de error del compilador.
@end deffn

@geindex from_exception() (método de clase de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException from_exception}@anchor{4367}
@deffn {Método} classmethod from_exception (exc, *, limit=None, lookup_lines=True, capture_locals=False)

Captura una excepción para su posterior procesado. `limit', `lookup_lines' y `capture_locals' son como para la clase @ref{f06,,StackSummary}.

Tenga en cuenta que cuando se capturan locales, también se muestran en el rastreo.
@end deffn

@geindex print() (método de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException print}@anchor{745}
@deffn {Método} print (*, file=None, chain=True)

Imprime en `file' (@code{sys.stderr} por defecto) la información de la excepción retornada por @ref{6c0,,format()}.


Added in version 3.11.

@end deffn

@geindex format() (método de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException format}@anchor{4368}
@deffn {Método} format (*, chain=True)

Formatea la excepción.

If `chain' is not @code{True}, @ref{435b,,__cause__} and @ref{435a,,__context__}
will not be formatted.

El valor retornado es un generador de cadenas, donde cada una acaba en una nueva línea y algunas contienen nuevas líneas internas. @ref{8e6,,print_exception()} es un contenedor alrededor de este método que simplemente muestra las líneas de un archivo.
@end deffn

@geindex format_exception_only() (método de traceback.TracebackException)
@anchor{library/traceback traceback TracebackException format_exception_only}@anchor{3b5}
@deffn {Método} format_exception_only (*, show_group=False)

Formatea la parte de la excepción de un seguimiento de pila.

El valor retornado es un generador de cadenas, donde cada una acaba en una nueva línea.

When `show_group' is @code{False}, the generator emits the exception’s
message followed by its notes (if it has any). The exception message
is normally a single string; however, for @ref{150,,SyntaxError} exceptions,
it consists of several lines that (when printed) display detailed
information about where the syntax error occurred.

When `show_group' is @code{True}, and the exception is an instance of
@ref{3b6,,BaseExceptionGroup}, the nested exceptions are included as
well, recursively, with indentation relative to their nesting depth.


Distinto en la versión 3.11: The exception’s @ref{2288,,notes} are now
included in the output.



Distinto en la versión 3.13: Added the `show_group' parameter.

@end deffn
@end deffn

@node StackSummary Objects,FrameSummary Objects,TracebackException Objects,traceback — Print or retrieve a stack traceback
@anchor{library/traceback stacksummary-objects}@anchor{4369}
@subsubsection @code{StackSummary} Objects



Added in version 3.5.


@code{StackSummary} objects represent a call stack ready for formatting.

@geindex StackSummary (clase en traceback)
@anchor{library/traceback traceback StackSummary}@anchor{f06}
@deffn {Clase} traceback.StackSummary

@geindex extract() (método de clase de traceback.StackSummary)
@anchor{library/traceback traceback StackSummary extract}@anchor{4358}
@deffn {Método} classmethod extract (frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)

Construct a @code{StackSummary} object from a frame generator (such as
is returned by @ref{f04,,walk_stack()} or
@ref{f05,,walk_tb()}).

If `limit' is supplied, only this many frames are taken from `frame_gen'.
If `lookup_lines' is @code{False}, the returned @ref{f07,,FrameSummary}
objects will not have read their lines in yet, making the cost of
creating the @code{StackSummary} cheaper (which may be valuable if it
may not actually get formatted). If `capture_locals' is @code{True} the
local variables in each @code{FrameSummary} are captured as object
representations.


Distinto en la versión 3.12: Las excepciones lanzadas desde @ref{894,,repr()} en una variable local (cuando `capture_locals' es @code{True}) no son propagadas al invocador.

@end deffn

@geindex from_list() (método de clase de traceback.StackSummary)
@anchor{library/traceback traceback StackSummary from_list}@anchor{436a}
@deffn {Método} classmethod from_list (a_list)

Construct a @code{StackSummary} object from a supplied list of
@ref{f07,,FrameSummary} objects or old-style list of tuples.  Each tuple
should be a 4-tuple with `filename', `lineno', `name', `line' as the
elements.
@end deffn

@geindex format() (método de traceback.StackSummary)
@anchor{library/traceback traceback StackSummary format}@anchor{436b}
@deffn {Método} format ()

Returns a list of strings ready for printing.  Each string in the
resulting list corresponds to a single @ref{780,,frame} from
the stack.
Each string ends in a newline; the strings may contain internal
newlines as well, for those items with source text lines.

Para secuencias largas del mismo marco y línea, se muestran las primeras repeticiones, seguidas de una línea de resumen que indica el número exacto de repeticiones adicionales.


Distinto en la versión 3.6: Las secuencias largas de cuadros repetidos ahora se abrevian.

@end deffn

@geindex format_frame_summary() (método de traceback.StackSummary)
@anchor{library/traceback traceback StackSummary format_frame_summary}@anchor{744}
@deffn {Método} format_frame_summary (frame_summary)

Returns a string for printing one of the @ref{780,,frames}
involved in the stack.
This method is called for each @ref{f07,,FrameSummary} object to be
printed by @ref{436b,,StackSummary.format()}. If it returns @code{None}, the
frame is omitted from the output.


Added in version 3.11.

@end deffn
@end deffn

@node FrameSummary Objects,Examples of Using the Module-Level Functions,StackSummary Objects,traceback — Print or retrieve a stack traceback
@anchor{library/traceback framesummary-objects}@anchor{436c}
@subsubsection @code{FrameSummary} Objects



Added in version 3.5.


A @code{FrameSummary} object represents a single @ref{780,,frame}
in a @ref{b7f,,traceback}.

@geindex FrameSummary (clase en traceback)
@anchor{library/traceback traceback FrameSummary}@anchor{f07}
@deffn {Clase} traceback.FrameSummary (filename, lineno, name, lookup_line=True, locals=None, line=None)

Represents a single @ref{780,,frame} in the
@ref{b7f,,traceback} or stack that is being formatted
or printed. It may optionally have a stringified version of the frame’s
locals included in it. If `lookup_line' is @code{False}, the source code is not
looked up until the @code{FrameSummary} has the @ref{4353,,line}
attribute accessed (which also happens when casting it to a @ref{464,,tuple}).
@ref{4353,,line} may be directly provided, and will prevent line
lookups happening at all. `locals' is an optional local variable
mapping, and if supplied the variable representations are stored in the
summary for later display.

@code{FrameSummary} instances have the following attributes:

@geindex filename (atributo de traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary filename}@anchor{4350}
@deffn {Atributo} filename

The filename of the source code for this frame. Equivalent to accessing
@ref{13cd,,f.f_code.co_filename} on a
@ref{780,,frame object} `f'.
@end deffn

@geindex lineno (atributo de traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary lineno}@anchor{4351}
@deffn {Atributo} lineno

The line number of the source code for this frame.
@end deffn

@geindex name (atributo de traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary name}@anchor{4352}
@deffn {Atributo} name

Equivalent to accessing @ref{1f37,,f.f_code.co_name} on
a @ref{780,,frame object} `f'.
@end deffn

@geindex line (atributo de traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary line}@anchor{4353}
@deffn {Atributo} line

A string representing the source code for this frame, with leading and
trailing whitespace stripped.
If the source is not available, it is @code{None}.
@end deffn
@end deffn

@node Examples of Using the Module-Level Functions,Examples of Using TracebackException,FrameSummary Objects,traceback — Print or retrieve a stack traceback
@anchor{library/traceback examples-of-using-the-module-level-functions}@anchor{436d}@anchor{library/traceback traceback-example}@anchor{436e}
@subsubsection Examples of Using the Module-Level Functions


Este ejemplo sencillo implementa un bucle de lectura, evaluación e impresión básico, similar a (pero menos útil) el bucle del intérprete interactivo estándar de Python. Para una implementación más completa del bucle del intérprete, ir al módulo @ref{1b,,code}

@example
import sys, traceback

def run_user_code(envdir):
    source = input(">>> ")
    try:
        exec(source, envdir)
    except Exception:
        print("Exception in user code:")
        print("-"*60)
        traceback.print_exc(file=sys.stdout)
        print("-"*60)

envdir = @{@}
while True:
    run_user_code(envdir)
@end example

El siguiente ejemplo demuestra las diferentes manera para mostrar y formatear la excepción y el seguimiento de pila:

@example
import sys, traceback

def lumberjack():
    bright_side_of_life()

def bright_side_of_life():
    return tuple()[0]

try:
    lumberjack()
except IndexError as exc:
    print("*** print_tb:")
    traceback.print_tb(exc.__traceback__, limit=1, file=sys.stdout)
    print("*** print_exception:")
    traceback.print_exception(exc, limit=2, file=sys.stdout)
    print("*** print_exc:")
    traceback.print_exc(limit=2, file=sys.stdout)
    print("*** format_exc, first and last line:")
    formatted_lines = traceback.format_exc().splitlines()
    print(formatted_lines[0])
    print(formatted_lines[-1])
    print("*** format_exception:")
    print(repr(traceback.format_exception(exc)))
    print("*** extract_tb:")
    print(repr(traceback.extract_tb(exc.__traceback__)))
    print("*** format_tb:")
    print(repr(traceback.format_tb(exc.__traceback__)))
    print("*** tb_lineno:", exc.__traceback__.tb_lineno)
@end example

La salida para el ejemplo podría ser similar a esto:

@example
*** print_tb:
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
*** print_exception:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
IndexError: tuple index out of range
*** print_exc:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
IndexError: tuple index out of range
*** format_exc, first and last line:
Traceback (most recent call last):
IndexError: tuple index out of range
*** format_exception:
['Traceback (most recent call last):\n',
 '  File "<doctest default[0]>", line 10, in <module>\n    lumberjack()\n    ~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n    ~~~~~~~~~~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\n',
 'IndexError: tuple index out of range\n']
*** extract_tb:
[<FrameSummary file <doctest...>, line 10 in <module>>,
 <FrameSummary file <doctest...>, line 4 in lumberjack>,
 <FrameSummary file <doctest...>, line 7 in bright_side_of_life>]
*** format_tb:
['  File "<doctest default[0]>", line 10, in <module>\n    lumberjack()\n    ~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n    ~~~~~~~~~~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\n']
*** tb_lineno: 10
@end example

El siguiente ejemplo muestra las diferentes maneras de imprimir y formatear la pila:

@example
>>> import traceback
>>> def another_function():
...     lumberstack()
...
>>> def lumberstack():
...     traceback.print_stack()
...     print(repr(traceback.extract_stack()))
...     print(repr(traceback.format_stack()))
...
>>> another_function()
  File "<doctest>", line 10, in <module>
    another_function()
  File "<doctest>", line 3, in another_function
    lumberstack()
  File "<doctest>", line 6, in lumberstack
    traceback.print_stack()
[('<doctest>', 10, '<module>', 'another_function()'),
 ('<doctest>', 3, 'another_function', 'lumberstack()'),
 ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]
['  File "<doctest>", line 10, in <module>\n    another_function()\n',
 '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',
 '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']
@end example

Este último ejemplo demuestra las últimas funciones de formateo:

@example
>>> import traceback
>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])
['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',
 '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']
>>> an_error = IndexError('tuple index out of range')
>>> traceback.format_exception_only(an_error)
['IndexError: tuple index out of range\n']
@end example

@node Examples of Using TracebackException,,Examples of Using the Module-Level Functions,traceback — Print or retrieve a stack traceback
@anchor{library/traceback examples-of-using-tracebackexception}@anchor{436f}
@subsubsection Examples of Using @code{TracebackException}


With the helper class, we have more options:

@example
>>> import sys
>>> from traceback import TracebackException
>>>
>>> def lumberjack():
...     bright_side_of_life()
...
>>> def bright_side_of_life():
...     t = "bright", "side", "of", "life"
...     return t[5]
...
>>> try:
...     lumberjack()
... except IndexError as e:
...     exc = e
...
>>> try:
...     try:
...         lumberjack()
...     except:
...         1/0
... except Exception as e:
...     chained_exc = e
...
>>> # limit works as with the module-level functions
>>> TracebackException.from_exception(exc, limit=-2).print()
Traceback (most recent call last):
  File "<python-input-1>", line 6, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-1>", line 10, in bright_side_of_life
    return t[5]
           ~^^^
IndexError: tuple index out of range

>>> # capture_locals adds local variables in frames
>>> TracebackException.from_exception(exc, limit=-2, capture_locals=True).print()
Traceback (most recent call last):
  File "<python-input-1>", line 6, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-1>", line 10, in bright_side_of_life
    return t[5]
           ~^^^
    t = ("bright", "side", "of", "life")
IndexError: tuple index out of range

>>> # The *chain* kwarg to print() controls whether chained
>>> # exceptions are displayed
>>> TracebackException.from_exception(chained_exc).print()
Traceback (most recent call last):
  File "<python-input-19>", line 4, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<python-input-8>", line 7, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-8>", line 11, in bright_side_of_life
    return t[5]
           ~^^^
IndexError: tuple index out of range

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<python-input-19>", line 6, in <module>
    1/0
    ~^~
ZeroDivisionError: division by zero

>>> TracebackException.from_exception(chained_exc).print(chain=False)
Traceback (most recent call last):
  File "<python-input-19>", line 6, in <module>
    1/0
    ~^~
ZeroDivisionError: division by zero
@end example

@node __future__ — Future statement definitions,gc — Garbage Collector interface,traceback — Print or retrieve a stack traceback,Servicios en tiempo de ejecución de Python
@anchor{library/__future__ doc}@anchor{4370}@anchor{library/__future__ future-future-statement-definitions}@anchor{4371}@anchor{library/__future__ module-__future__}@anchor{0}
@subsection @code{__future__} — Future statement definitions


@geindex module; __future__

`Código fuente:' Lib/__future__.py@footnote{https://github.com/python/cpython/tree/main/Lib/__future__.py}


__________________________________________________________________


Imports of the form @code{from __future__ import feature} are called
@ref{2f4,,future statements}. These are special-cased by the Python compiler
to allow the use of new Python features in modules containing the future statement
before the release in which the feature becomes standard.

While these future statements are given additional special meaning by the
Python compiler, they are still executed like any other import statement and
the @ref{0,,__future__} exists and is handled by the import system the same way
any other Python module would be. This design serves three purposes:


@itemize *

@item 
Para evitar confundir las herramientas existentes que analizan las declaraciones de importación y esperan encontrar los módulos que están importando.

@item 
Documentar cuándo se introdujeron cambios incompatibles y cuándo serán — o fueron — obligatorios. Esta es una forma de documentación ejecutable y se puede inspeccionar mediante programación importando @ref{0,,__future__} y examinando su contenido.

@item 
To ensure that @ref{2f4,,future statements} run under releases prior to
Python 2.1 at least yield runtime exceptions (the import of @ref{0,,__future__}
will fail, because there was no module of that name prior to 2.1).
@end itemize

@menu
* Module Contents:: 

@end menu

@node Module Contents,,,__future__ — Future statement definitions
@anchor{library/__future__ module-contents}@anchor{4372}
@subsubsection Module Contents


Ninguna descripción de característica se eliminará de @ref{0,,__future__}. Desde su introducción en Python 2.1, las siguientes características han encontrado su camino en el lenguaje usando este mecanismo:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

característica

@tab

opcional en

@tab

obligatorio en

@tab

efecto

@item

nested_scopes

@tab

2.1.0b1

@tab

2.2

@tab

@geindex Python Enhancement Proposals; PEP 227
PEP 227@footnote{https://peps.python.org/pep-0227/}: `Ámbitos anidados estáticamente'

@item

generadores

@tab

2.2.0a1

@tab

2.3

@tab

@geindex Python Enhancement Proposals; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/}: `Generadores simples'

@item

división

@tab

2.2.0a2

@tab

3.0

@tab

@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: `Cambio de operador de división'

@item

absolute_import

@tab

2.5.0a1

@tab

3.0

@tab

@geindex Python Enhancement Proposals; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/}: `Importaciones: Multilínea y Absoluto/Relativo'

@item

with_statement

@tab

2.5.0a1

@tab

2.6

@tab

@geindex Python Enhancement Proposals; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}: `La declaración «with»'

@item

print_function

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Python Enhancement Proposals; PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}: `Hacer de print una función'

@item

unicode_literals

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Python Enhancement Proposals; PEP 3112
PEP 3112@footnote{https://peps.python.org/pep-3112/}: `Bytes literales en Python 3000'

@item

generator_stop

@tab

3.5.0b1

@tab

3.7

@tab

@geindex Python Enhancement Proposals; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}: `Manejo de StopIteration dentro de generadores'

@item

anotaciones

@tab

3.7.0b1

@tab

Never @footnote{
@code{from __future__ import annotations} was previously scheduled to
become mandatory in Python 3.10, but the change was delayed and ultimately
canceled. This feature will eventually be deprecated and removed. See
@geindex Python Enhancement Proposals; PEP 649
@uref{https://peps.python.org/pep-0649/,PEP 649} and 
@geindex Python Enhancement Proposals; PEP 749
@uref{https://peps.python.org/pep-0749/,PEP 749}.
}

@tab

@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}:
`Postponed evaluation of annotations',
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}: `Deferred evaluation of
annotations using descriptors'

@end multitable


@c XXX Adding a new entry?  Remember to update simple_stmts.rst, too.

@geindex _Feature (clase en __future__)
@anchor{library/__future__ future-classes}@anchor{4373}@anchor{library/__future__ future__ _Feature}@anchor{216b}
@deffn {Clase} __future__._Feature

Cada declaración en @code{__future__.py} tiene la forma:

@example
FeatureName = _Feature(OptionalRelease, MandatoryRelease,
                       CompilerFlag)
@end example

donde, normalmente, `OptionalRelease' es menor que `MandatoryRelease' y ambos son 5-tuplas de la misma forma que @ref{741,,sys.version_info}:

@example
(PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
 PY_MINOR_VERSION, # the 1; an int
 PY_MICRO_VERSION, # the 0; an int
 PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
 PY_RELEASE_SERIAL # the 3; an int
)
@end example
@end deffn

@geindex getOptionalRelease() (método de __future__._Feature)
@anchor{library/__future__ future__ _Feature getOptionalRelease}@anchor{4374}
@deffn {Método} _Feature.getOptionalRelease ()

`OptionalRelease' registra la primera versión en la que se aceptó la característica.
@end deffn

@geindex getMandatoryRelease() (método de __future__._Feature)
@anchor{library/__future__ future__ _Feature getMandatoryRelease}@anchor{4375}
@deffn {Método} _Feature.getMandatoryRelease ()

En el caso de un `MandatoryRelease' que aún no se ha producido, `MandatoryRelease' predice el lanzamiento en el que la característica pasará a formar parte del lenguaje.

De otro modo, `MandatoryRelease' registra cuándo la característica se convirtió en parte del lenguaje; en versiones en o después de este, los módulos ya no necesitan una declaración futura para usar la característica en cuestión, pero pueden continuar usando dichas importaciones.

`MandatoryRelease' may also be @code{None}, meaning that a planned feature got
dropped or that it is not yet decided.
@end deffn

@geindex compiler_flag (atributo de __future__._Feature)
@anchor{library/__future__ future__ _Feature compiler_flag}@anchor{216a}
@deffn {Atributo} _Feature.compiler_flag

`CompilerFlag' is the (bitfield) flag that should be passed in the fourth
argument to the built-in function @ref{2fb,,compile()} to enable the feature in
dynamically compiled code.  This flag is stored in the @ref{216a,,_Feature.compiler_flag}
attribute on @ref{216b,,_Feature} instances.
@end deffn


@subsubheading Ver también



@table @asis

@item @ref{2f4,,Declaraciones Futuras}

Cómo trata el compilador las importaciones futuras.

@geindex Python Enhancement Proposals; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - Back to the __future__

The original proposal for the __future__ mechanism.
@end table


@node gc — Garbage Collector interface,inspect — Inspect live objects,__future__ — Future statement definitions,Servicios en tiempo de ejecución de Python
@anchor{library/gc doc}@anchor{4376}@anchor{library/gc gc-garbage-collector-interface}@anchor{4377}@anchor{library/gc module-gc}@anchor{60}
@subsection @code{gc} — Garbage Collector interface


@geindex module; gc


__________________________________________________________________


Este módulo proporciona una interfaz para el recolector de basura opcional (recolector de basura cíclico generacional). Proporciona la capacidad de deshabilitar el recolector, ajustar la frecuencia de recolección y establecer opciones de depuración. También proporciona acceso a objetos inaccesibles (`unreachables') que el recolector encontró pero no pudo liberar. Dado que el recolector de basura complementa el conteo de referencias, que ya se utiliza en Python, es posible desactivarlo siempre que se esté seguro de que el programa no crea referencias cíclicas. La recolección automática se puede desactivar llamando a @code{gc.disable()}. Para depurar un programa con fugas de memoria, se debe llamar a @code{gc.set_debug(gc.DEBUG_LEAK)}. Se debe tener en cuenta que la llamada anterior incluye @code{gc.DEBUG_SAVEALL}, lo que hace que los objetos recolectados se guarden en `gc.garbage' para su inspección.

El módulo @ref{60,,gc} proporciona las siguientes funciones:

@geindex enable() (en el módulo gc)
@anchor{library/gc gc enable}@anchor{4378}
@deffn {Función} gc.enable ()

Habilita la recolección automática de basura.
@end deffn

@geindex disable() (en el módulo gc)
@anchor{library/gc gc disable}@anchor{4379}
@deffn {Función} gc.disable ()

Deshabilita la recolección automática de basura.
@end deffn

@geindex isenabled() (en el módulo gc)
@anchor{library/gc gc isenabled}@anchor{437a}
@deffn {Función} gc.isenabled ()

Retorna @code{True} si la recolección automática está habilitada.
@end deffn

@geindex collect() (en el módulo gc)
@anchor{library/gc gc collect}@anchor{acc}
@deffn {Función} gc.collect (generation=2)

Perform a collection.  The optional argument `generation'
may be an integer specifying which generation to collect (from 0 to 2).  A
@ref{360,,ValueError} is raised if the generation number is invalid. The sum of
collected objects and uncollectable objects is returned.

Calling @code{gc.collect(0)} will perform a GC collection on the young generation.

Calling @code{gc.collect(1)} will perform a GC collection on the young generation
and an increment of the old generation.

Calling @code{gc.collect(2)} or @code{gc.collect()} performs a full collection

Las listas libres mantenidas para varios tipos incorporados son borradas cada vez que se ejecuta una recolección completa o una recolección de la generación más alta (2). No obstante, no todos los elementos de algunas listas libres pueden ser liberados, particularmente @ref{153,,float}, debido a su implementación particular.

El efecto de llamar a @code{gc.collect()} mientras el intérprete ya está realizando una recolección es indefinido.


Distinto en la versión 3.13: @code{generation=1} performs an increment of collection.

@end deffn

@geindex set_debug() (en el módulo gc)
@anchor{library/gc gc set_debug}@anchor{437b}
@deffn {Función} gc.set_debug (flags)

Establece las flags de depuración para la recolección de basura. La información de depuración se escribirá en @code{sys.stderr}. A continuación se puede consultar una lista con las flags de depuración disponibles, que se pueden combinar mediante operaciones de bits para controlar la depuración.
@end deffn

@geindex get_debug() (en el módulo gc)
@anchor{library/gc gc get_debug}@anchor{437c}
@deffn {Función} gc.get_debug ()

Retorna las flags de depuración actualmente establecidas.
@end deffn

@geindex get_objects() (en el módulo gc)
@anchor{library/gc gc get_objects}@anchor{89a}
@deffn {Función} gc.get_objects (generation=None)

Returns a list of all objects tracked by the collector, excluding the list
returned. If `generation' is not @code{None}, return only the objects as follows:


@itemize *

@item 
0: All objects in the young generation

@item 
1: No objects, as there is no generation 1 (as of Python 3.13)

@item 
2: All objects in the old generation
@end itemize


Distinto en la versión 3.8: Se agregó el parámetro `generation'.



Distinto en la versión 3.13: Generation 1 is removed


Lanza un @ref{18c3,,evento de auditoría} @code{gc.get_objects} con el argumento @code{generation}.
@end deffn

@geindex get_stats() (en el módulo gc)
@anchor{library/gc gc get_stats}@anchor{fc4}
@deffn {Función} gc.get_stats ()

Retorna una lista de tres diccionarios, uno por cada generación, que contienen estadísticas de recolección desde el inicio del intérprete. El número de claves puede cambiar en el futuro, pero actualmente cada diccionario contendrá los siguientes elementos:


@itemize *

@item 
@code{collections} es el número de veces que se recolectó esta generación;

@item 
@code{collected} es el número total de objetos recolectados dentro de esta generación;

@item 
@code{uncollectable} es el número total de objetos que se consideraron no recolectables (y por lo tanto, se movieron a la lista @ref{122e,,garbage}) dentro de esta generación.
@end itemize


Added in version 3.4.

@end deffn

@geindex set_threshold() (en el módulo gc)
@anchor{library/gc gc set_threshold}@anchor{437d}
@deffn {Función} gc.set_threshold (threshold0[, threshold1[, threshold2]])

Establece los umbrales de recolección (la frecuencia de recolección). Si se establece `threshold0' en cero se deshabilita la recolección.

The GC classifies objects into two generations depending on whether they have
survived a collection. New objects are placed in the young generation. If an
object survives a collection it is moved into the old generation.

In order to decide when to run, the collector keeps track of the number of object
allocations and deallocations since the last collection.  When the number of
allocations minus the number of deallocations exceeds `threshold0', collection
starts. For each collection, all the objects in the young generation and some
fraction of the old generation is collected.

The fraction of the old generation that is collected is `inversely' proportional
to `threshold1'. The larger `threshold1' is, the slower objects in the old generation
are collected.
For the default value of 10, 1% of the old generation is scanned during each collection.

`threshold2' is ignored.

See Garbage collector design@footnote{https://devguide.python.org/garbage_collector} for more information.


Distinto en la versión 3.13: `threshold2' is ignored

@end deffn

@geindex get_count() (en el módulo gc)
@anchor{library/gc gc get_count}@anchor{437e}
@deffn {Función} gc.get_count ()

Retorna los recuentos de la recolección actual como una tupla de la forma @code{(count0, count1, count2)}.
@end deffn

@geindex get_threshold() (en el módulo gc)
@anchor{library/gc gc get_threshold}@anchor{437f}
@deffn {Función} gc.get_threshold ()

Retorna los umbrales de la recolección actual como una tupla de la forma @code{(threshold0, threshold1, threshold2)}.
@end deffn

@geindex get_referrers() (en el módulo gc)
@anchor{library/gc gc get_referrers}@anchor{89b}
@deffn {Función} gc.get_referrers (*objs)

Retorna la lista de objetos que referencian de forma directa a cualquiera de `objs'. Esta función solo localizará aquellos contenedores que admitan la recolección de basura; no se localizarán los tipos de extensión que referencian a otros objetos pero que no admiten la recolección de basura.

Téngase en cuenta que los objetos que ya se han desreferenciado, pero que tienen referencias cíclicas y aún no han sido recolectados por el recolector de basura pueden enumerarse entre las referencias resultantes. Para obtener solo los objetos activos actualmente, llame a @ref{acc,,collect()} antes de llamar a @ref{89b,,get_referrers()}.

@cartouche
@quotation Advertencia 
Se debe tener un especial cuidado cuando se usan objetos retornados por @ref{89b,,get_referrers()} dado que algunos de ellos aún podrían estar en construcción y por tanto en un estado temporalmente inválido. Debe evitarse el uso de @ref{89b,,get_referrers()} para cualquier propósito que no sea la depuración.
@end quotation
@end cartouche

Lanza un @ref{18c3,,evento de auditoría} @code{gc.get_referrers} con el argumento @code{objs}.
@end deffn

@geindex get_referents() (en el módulo gc)
@anchor{library/gc gc get_referents}@anchor{89c}
@deffn {Función} gc.get_referents (*objs)

Retorna una lista de objetos a los que hace referencia directamente cualquiera de los argumentos. Las referencias retornadas son aquellos objetos visitados por los métodos @ref{818,,tp_traverse} a nivel de C de los argumentos (si los hay) y es posible que no todos los objetos sean directamente accesibles realmente. Los métodos @ref{818,,tp_traverse} solo son compatibles con los objetos que admiten recolección de basura y solo se requieren para visitar objetos que pueden estar involucrados en un ciclo de referencias. Lo que quiere decir que, por ejemplo, si se puede acceder directamente a un número entero desde uno de los argumento, ese objeto entero puede aparecer o no en la lista de resultados.

Lanza un @ref{18c3,,evento de auditoría} @code{gc.get_referents} con el argumento @code{objs}.
@end deffn

@geindex is_tracked() (en el módulo gc)
@anchor{library/gc gc is_tracked}@anchor{1376}
@deffn {Función} gc.is_tracked (obj)

Retorna @code{True} si el recolector de basura rastrea actualmente el objeto y @code{False} en caso contrario. Como regla general, las instancias de tipos atómicos no se rastrean y las instancias de tipos no atómicos (contenedores, objetos definidos por el usuario …) sí. Sin embargo, algunas optimizaciones específicas de tipo pueden estar presentes para suprimir el impacto del recolector de basura en instancias simples (por ejemplo, diccionarios que contienen solo claves y valores atómicos):

@example
>>> gc.is_tracked(0)
False
>>> gc.is_tracked("a")
False
>>> gc.is_tracked([])
True
>>> gc.is_tracked(@{@})
False
>>> gc.is_tracked(@{"a": 1@})
False
>>> gc.is_tracked(@{"a": []@})
True
@end example


Added in version 3.1.

@end deffn

@geindex is_finalized() (en el módulo gc)
@anchor{library/gc gc is_finalized}@anchor{993}
@deffn {Función} gc.is_finalized (obj)

Retorna @code{True} si el objeto dado ha sido finalizado por el recolector de basura, @code{False} en caso contrario.

@example
>>> x = None
>>> class Lazarus:
...     def __del__(self):
...         global x
...         x = self
...
>>> lazarus = Lazarus()
>>> gc.is_finalized(lazarus)
False
>>> del lazarus
>>> gc.is_finalized(x)
True
@end example


Added in version 3.9.

@end deffn

@geindex freeze() (en el módulo gc)
@anchor{library/gc gc freeze}@anchor{bc2}
@deffn {Función} gc.freeze ()

Congela todos los objetos rastreados por el recolector de basura; los mueve a una generación permanente y los ignora en todas las recolecciones futuras.

Si un proceso va a llamar a @code{fork()} sin llamar a @code{exec()}, evitar la copia en escritura innecesaria en procesos secundarios maximizará el intercambio de memoria y reducirá el uso general de la memoria. Esto requiere tanto evitar la creación de «agujeros» liberados en las páginas de memoria del proceso principal y garantizar que las colecciones de GC en los procesos secundarios no tocarán el contador @code{gc_refs} de objetos de larga duración que se originan en el proceso principal. Para lograr ambas cosas, llame a @code{gc.disable()} al principio del proceso principal, a @code{gc.freeze()} justo antes de @code{fork()} y a @code{gc.enable()} al principio. en procesos secundarios.


Added in version 3.7.

@end deffn

@geindex unfreeze() (en el módulo gc)
@anchor{library/gc gc unfreeze}@anchor{bc3}
@deffn {Función} gc.unfreeze ()

Descongela los objetos de la generación permanente y vuelve a colocarlos en la generación más antigua.


Added in version 3.7.

@end deffn

@geindex get_freeze_count() (en el módulo gc)
@anchor{library/gc gc get_freeze_count}@anchor{bc4}
@deffn {Función} gc.get_freeze_count ()

Retorna el número de objetos de la generación permanente.


Added in version 3.7.

@end deffn

Las siguientes variables se proporcionan para acceso de solo lectura (se pueden mutar los valores pero no se deben vincular de nuevo):

@geindex garbage (en el módulo gc)
@anchor{library/gc gc garbage}@anchor{122e}
@deffn {Dato} gc.garbage

Una lista de objetos que el recolector consideró inaccesibles pero que no pudieron ser liberados (objetos que no se pueden recolectar). A partir de Python 3.4, esta lista debe estar vacía la mayor parte del tiempo, excepto cuando se utilizan instancias de tipos de extensión C en los que la ranura (`slot') @code{tp_del} no sea @code{NULL}.

Si se establece @ref{4380,,DEBUG_SAVEALL}, todos los objetos inaccesibles se agregarán a esta lista en lugar de ser liberados.


Distinto en la versión 3.2: Si la lista no está vacía en el momento del @ref{2bb,,interpreter shutdown}, se emite un @ref{39d,,ResourceWarning}, que es silencioso de forma predeterminada. Si se establece @ref{122f,,DEBUG_UNCOLLECTABLE}, además se imprimen todos los objetos no recolectables.



Distinto en la versión 3.4: Siguiendo con 
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}, los objetos con un método @ref{1f60,,__del__()} ya no terminan en @ref{122e,,gc.garbage}.

@end deffn

@geindex callbacks (en el módulo gc)
@anchor{library/gc gc callbacks}@anchor{113c}
@deffn {Dato} gc.callbacks

Una lista de retrollamadas que el recolector de basura invocará antes y después de la recolección. Las retrollamadas serán llamadas con dos argumentos, `phase' e `info'.

`phase' puede tomar uno de estos valores:

@quotation

«start»: la recolección de basura está a punto de comenzar.

«stop»: la recolección de basura ha terminado.
@end quotation

`info' es un diccionario que proporciona información adicional para la retrollamada. Las siguientes claves están definidas actualmente:

@quotation

«generation»: la generación más antigua que ha sido recolectada.

«collected»: cuando `phase' es «stop», el número de objetos recolectados satisfactoriamente.

«uncollectable»: cuando `phase' es «stop», el número de objetos que no pudieron ser recolectados y fueron ubicados en @ref{122e,,garbage}.
@end quotation

Las aplicaciones pueden agregar sus propias retrollamadas a esta lista. Los principales casos de uso son:

@quotation

Recopilar estadísticas sobre la recolección de basura, como la frecuencia con la que se recolectan varias generaciones y cuánto tiempo lleva la recolección.

Permitir que las aplicaciones identifiquen y borren sus propios tipos no recolectables cuando aparecen en @ref{122e,,garbage}.
@end quotation


Added in version 3.3.

@end deffn

Las siguientes constantes son proporcionadas para ser usadas con @ref{437b,,set_debug()}:

@geindex DEBUG_STATS (en el módulo gc)
@anchor{library/gc gc DEBUG_STATS}@anchor{4381}
@deffn {Dato} gc.DEBUG_STATS

Imprime estadísticas durante la recolección. Esta información puede resultar útil para ajustar la frecuencia de recolección.
@end deffn

@geindex DEBUG_COLLECTABLE (en el módulo gc)
@anchor{library/gc gc DEBUG_COLLECTABLE}@anchor{4382}
@deffn {Dato} gc.DEBUG_COLLECTABLE

Imprime información sobre los objetos recolectables encontrados.
@end deffn

@geindex DEBUG_UNCOLLECTABLE (en el módulo gc)
@anchor{library/gc gc DEBUG_UNCOLLECTABLE}@anchor{122f}
@deffn {Dato} gc.DEBUG_UNCOLLECTABLE

Imprime información sobre los objetos no recolectables encontrados (objetos inaccesibles, pero que el recolector no puede liberar). Estos objetos se agregarán a la lista @code{garbage}.


Distinto en la versión 3.2: También imprime el contenido de la lista @ref{122e,,garbage} durante @ref{2bb,,interpreter shutdown}, si no está vacía.

@end deffn

@geindex DEBUG_SAVEALL (en el módulo gc)
@anchor{library/gc gc DEBUG_SAVEALL}@anchor{4380}
@deffn {Dato} gc.DEBUG_SAVEALL

Cuando se establece, todos los objetos inaccesibles encontrados se agregarán a `garbage' en lugar de ser liberados. Esto puede resultar útil para depurar un programa con fugas de memoria.
@end deffn

@geindex DEBUG_LEAK (en el módulo gc)
@anchor{library/gc gc DEBUG_LEAK}@anchor{4383}
@deffn {Dato} gc.DEBUG_LEAK

Las flags de depuración necesarias para que el recolector imprima información sobre un programa con fugas de memoria (igual a @code{DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL}).
@end deffn

@node inspect — Inspect live objects,annotationlib — Functionality for introspecting annotations,gc — Garbage Collector interface,Servicios en tiempo de ejecución de Python
@anchor{library/inspect doc}@anchor{4384}@anchor{library/inspect inspect-inspect-live-objects}@anchor{4385}
@subsection @code{inspect} — Inspect live objects


@c import inspect
@c from inspect import *

@geindex module; inspect
@anchor{library/inspect module-inspect}@anchor{7e}
`Código fuente:' Lib/inspect.py@footnote{https://github.com/python/cpython/tree/main/Lib/inspect.py}


__________________________________________________________________


El módulo @ref{7e,,inspect} proporciona varias funciones útiles para ayudar a obtener información sobre objetos vivos como módulos, clases, métodos, funciones, tracebacks, objetos de marco y objetos de código.  Por ejemplo, puede ayudarte a examinar el contenido de una clase, recuperar el código fuente de un método, extraer y dar formato a la lista de argumentos de una función, u obtener toda la información que necesitas para mostrar un traceback detallado.

Hay cuatro tipos principales de servicios que ofrece este módulo: comprobación de tipos, obtención del código fuente, inspección de clases y funciones, y examinar la pila del intérprete.

@menu
* Tipos y miembros:: 
* Recuperar el código fuente:: 
* Introspección de los invocables con el objeto Signature:: 
* Clases y funciones: Clases y funciones<2>. 
* La pila del interprete:: 
* Obteniendo atributos estáticamente:: 
* Current State of Generators@comma{} Coroutines@comma{} and Asynchronous Generators: Current State of Generators Coroutines and Asynchronous Generators. 
* Objetos de código Bit Flags:: 
* Buffer flags:: 
* Interfaz de la línea de comando:: 

@end menu

@node Tipos y miembros,Recuperar el código fuente,,inspect — Inspect live objects
@anchor{library/inspect inspect-types}@anchor{19b3}@anchor{library/inspect types-and-members}@anchor{4386}
@subsubsection Tipos y miembros


The @ref{185c,,getmembers()} function retrieves the members of an object such as a
class or module. The functions whose names begin with «is» are mainly
provided as convenient choices for the second argument to @ref{185c,,getmembers()}.
They also help you determine when you can expect to find the following special
attributes (see @ref{1f13,,Import-related attributes on module objects} for module attributes):

@c this function name is too big to fit in the ascii-art table below


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Atributo

@tab

Descripción

@item

clase

@tab

__doc__

@tab

cadena de caracteres de documentación

@item

@tab

__name__

@tab

nombre con el que se definió esta clase

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

__module__

@tab

nombre del módulo en el que se definió esta clase

@item

@tab

__type_params__

@tab

A tuple containing the
@ref{3fc,,type parameters} of
a generic class

@item

método

@tab

__doc__

@tab

cadena de caracteres de documentación

@item

@tab

__name__

@tab

nombre con el que se definió este método

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

__func__

@tab

objeto función que contiene la implementación del método

@item

@tab

__self__

@tab

instancia a la que este método está ligado, o @code{None}

@item

@tab

__module__

@tab

nombre del módulo en el cual este método fue definido

@item

función

@tab

__doc__

@tab

cadena de caracteres de documentación

@item

@tab

__name__

@tab

nombre con el que se definió esta función

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

__code__

@tab

objeto de código que contiene la función compilada @ref{2f2,,bytecode}

@item

@tab

__defaults__

@tab

tupla de cualquier valor por defecto para los parámetros de posición o de palabras clave

@item

@tab

__kwdefaults__

@tab

mapeo de cualquier valor predeterminado para parámetros de sólo palabras clave

@item

@tab

__globals__

@tab

namespace global en el que se definió esta función

@item

@tab

__builtins__

@tab

Espacio de nombres builtins

@item

@tab

__annotations__

@tab

mapeo de los nombres de parámetros a las anotaciones; la tecla @code{"return"} está reservada para las anotaciones de retorno.

@item

@tab

__type_params__

@tab

A tuple containing the
@ref{3fc,,type parameters} of
a generic function

@item

@tab

__module__

@tab

nombre del módulo en el cual esta función fue definida

@item

traceback

@tab

tb_frame

@tab

enmarcar el objeto a este nivel

@item

@tab

tb_lasti

@tab

índice del último intento de instrucción en código de bytes

@item

@tab

tb_lineno

@tab

número de línea actual en el código fuente de Python

@item

@tab

tb_next

@tab

el siguiente objeto de traceback interno (llamado por este nivel)

@item

marco

@tab

f_back

@tab

el siguiente objeto exterior del marco (el que llama a este marco)

@item

@tab

f_builtins

@tab

construye el namespace visto por este marco

@item

@tab

f_code

@tab

objeto de código que se ejecuta en este marco

@item

@tab

f_globals

@tab

el namespace global visto por este marco

@item

@tab

f_lasti

@tab

índice del último intento de instrucción en código de bytes

@item

@tab

f_lineno

@tab

número de línea actual en el código fuente de Python

@item

@tab

f_locals

@tab

el namespace local visto por este marco

@item

@tab

f_trace

@tab

función de rastreo para este marco, o @code{None}

@item

@tab

f_trace_lines

@tab

indicate whether a
tracing event is
triggered for each source
source line

@item

@tab

f_trace_opcodes

@tab

indicate whether
per-opcode events are
requested

@item

@tab

clear()

@tab

used to clear all
references to local
variables

@item

code

@tab

co_argcount

@tab

número de argumentos (sin incluir los argumentos de palabras clave, * o ** args)

@item

@tab

co_code

@tab

cadena de bytecode compilados en bruto

@item

@tab

co_cellvars

@tab

tupla de nombres de variables de celda (referenciados por contener alcances)

@item

@tab

co_consts

@tab

tupla de constantes utilizadas en el bytecode

@item

@tab

co_filename

@tab

nombre del archivo en el que este objeto código fue creado

@item

@tab

co_firstlineno

@tab

número de la primera línea del código fuente de Python

@item

@tab

co_flags

@tab

mapa de bits de los flags @code{CO_*}, leer más @ref{1f45,,aquí}

@item

@tab

co_lnotab

@tab

mapeo codificado de los números de línea a los índices de bytecode

@item

@tab

co_freevars

@tab

tupla de nombres de variables libres (referenciados a través del cierre de una función)

@item

@tab

co_posonlyargcount

@tab

número de argumentos solo posicionales

@item

@tab

co_kwonlyargcount

@tab

número de argumentos de sólo palabras clave (sin incluir el ** arg)

@item

@tab

co_name

@tab

nombre con el que se definió este objeto de código

@item

@tab

co_qualname

@tab

nombre completo con el que se definió este objeto de código

@item

@tab

co_names

@tab

tupla de nombres que no sean argumentos y funciones locales

@item

@tab

co_nlocals

@tab

número de variables locales

@item

@tab

co_stacksize

@tab

se requiere espacio en la pila de máquina virtual

@item

@tab

co_varnames

@tab

tupla de nombres de argumentos y variables locales

@item

@tab

co_lines()

@tab

returns an iterator that
yields successive
bytecode ranges

@item

@tab

co_positions()

@tab

returns an iterator of
source code positions for
each bytecode instruction

@item

@tab

replace()

@tab

returns a copy of the
code object with new
values

@item

generador

@tab

__name__

@tab

nombre

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

gi_frame

@tab

marco

@item

@tab

gi_running

@tab

¿Está el generador en ejecución?

@item

@tab

gi_code

@tab

code

@item

@tab

gi_yieldfrom

@tab

el objeto siendo iterado por @code{yield from}, o @code{None}

@item

async generator

@tab

__name__

@tab

nombre

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

ag_await

@tab

objeto al que se espera, o @code{None}

@item

@tab

ag_frame

@tab

marco

@item

@tab

ag_running

@tab

¿Está el generador en ejecución?

@item

@tab

ag_code

@tab

code

@item

corutina

@tab

__name__

@tab

nombre

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

cr_await

@tab

objeto al que se espera, o @code{None}

@item

@tab

cr_frame

@tab

marco

@item

@tab

cr_running

@tab

¿Está la corutina en ejecución?

@item

@tab

cr_code

@tab

code

@item

@tab

cr_origin

@tab

donde se creó la corutina, o @code{None}. Ver @ref{c14,,sys.set_coroutine_origin_tracking_depth()}

@item

incorporado

@tab

__doc__

@tab

cadena de caracteres de documentación

@item

@tab

__name__

@tab

nombre original de esta función o método

@item

@tab

__qualname__

@tab

nombre calificado

@item

@tab

__self__

@tab

instancia a la que está ligada un método, o @code{None}

@end multitable



Distinto en la versión 3.5: Agrega atributos @code{__qualname__} y @code{gi_yieldfrom} a los generadores.

El atributo @code{__name__} de los generadores se establece ahora a partir del nombre de la función, en lugar del nombre del código, y ahora puede ser modificado.



Distinto en la versión 3.7: Agrega el atributo @code{cr_origin} a las corutinas.



Distinto en la versión 3.10: Agrega el atributo @code{__builtins__} a funciones.


@geindex getmembers() (en el módulo inspect)
@anchor{library/inspect inspect getmembers}@anchor{185c}
@deffn {Función} inspect.getmembers (object[, predicate])

Retorna todos los miembros de un objeto en una lista de pares @code{(name, value)} ordenados por nombre. Si se proporciona el argumento `predicate' opcional, que se llamará con el objeto @code{value} de cada miembro, solo se incluyen los miembros para los que el predicado retorna un valor verdadero.

@cartouche
@quotation Nota 
@ref{185c,,getmembers()} will only return class attributes defined in the
metaclass when the argument is a class and those attributes have been
listed in the metaclass” custom @ref{1f66,,__dir__()}.
@end quotation
@end cartouche
@end deffn

@geindex getmembers_static() (en el módulo inspect)
@anchor{library/inspect inspect getmembers_static}@anchor{6ea}
@deffn {Función} inspect.getmembers_static (object[, predicate])

Retorna todos los miembros de un objeto en una lista de pares @code{(name, value)} ordenados por nombre sin activar la búsqueda dinámica a través del protocolo descriptor, __getattr__ o __getattribute__. Opcionalmente, solo retorna miembros que satisfagan un predicado determinado.

@cartouche
@quotation Nota 
Es posible que @ref{6ea,,getmembers_static()} no pueda recuperar todos los miembros que getmembers puede obtener (como atributos creados dinámicamente) y puede encontrar miembros que getmembers no puede (como descriptores que generan AttributeError). También puede retornar objetos descriptores en lugar de miembros de instancia en algunos casos.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex getmodulename() (en el módulo inspect)
@anchor{library/inspect inspect getmodulename}@anchor{dc0}
@deffn {Función} inspect.getmodulename (path)

Retorna el nombre del módulo nombrado por el `ruta' de archivo, sin incluir los nombres de los paquetes adjuntos. La extensión del archivo se comprueba con todas las entradas en @ref{4387,,importlib.machinery.all_suffixes()}. Si coincide, el componente final de la ruta se retorna con la extensión eliminada. En caso contrario, se retorna @code{None}.

Ten en cuenta que esta función `sólo' retorna un nombre significativo para los módulos reales de Python - las rutas que potencialmente se refieren a los paquetes de Python seguirán retornando @code{None}.


Distinto en la versión 3.3: La función se basa directamente en @ref{77,,importlib}.

@end deffn

@geindex ismodule() (en el módulo inspect)
@anchor{library/inspect inspect ismodule}@anchor{4388}
@deffn {Función} inspect.ismodule (object)

Retorna @code{True} si el objeto es un módulo.
@end deffn

@geindex isclass() (en el módulo inspect)
@anchor{library/inspect inspect isclass}@anchor{4389}
@deffn {Función} inspect.isclass (object)

Retorna @code{True} si el objeto es una clase, ya sea incorporada o creada en código Python.
@end deffn

@geindex ismethod() (en el módulo inspect)
@anchor{library/inspect inspect ismethod}@anchor{438a}
@deffn {Función} inspect.ismethod (object)

Retorna @code{True} si el objeto es un método ligado escrito en Python.
@end deffn

@geindex ispackage() (en el módulo inspect)
@anchor{library/inspect inspect ispackage}@anchor{184}
@deffn {Función} inspect.ispackage (object)

Return @code{True} if the object is a @ref{185,,package}.


Added in version 3.14.

@end deffn

@geindex isfunction() (en el módulo inspect)
@anchor{library/inspect inspect isfunction}@anchor{438b}
@deffn {Función} inspect.isfunction (object)

Retorna @code{True} si el objeto es una función de Python, que incluye funciones creadas por una expresión @ref{272f,,lambda}.
@end deffn

@geindex isgeneratorfunction() (en el módulo inspect)
@anchor{library/inspect inspect isgeneratorfunction}@anchor{17d8}
@deffn {Función} inspect.isgeneratorfunction (object)

Retorna @code{True} si el objeto es una función generadora de Python.


Distinto en la versión 3.8: Funciones envueltas en @ref{17a,,functools.partial()} ahora retornan @code{True} si la función envuelta es una función Python generadora.



Distinto en la versión 3.13: Functions wrapped in @ref{17b,,functools.partialmethod()} now return @code{True}
if the wrapped function is a Python generator function.

@end deffn

@geindex isgenerator() (en el módulo inspect)
@anchor{library/inspect inspect isgenerator}@anchor{438c}
@deffn {Función} inspect.isgenerator (object)

Retorna @code{True} si el objeto es un generador.
@end deffn

@geindex iscoroutinefunction() (en el módulo inspect)
@anchor{library/inspect inspect iscoroutinefunction}@anchor{1c3}
@deffn {Función} inspect.iscoroutinefunction (object)

Return @code{True} if the object is a @ref{dfc,,coroutine function} (a function
defined with an @ref{672,,async def} syntax), a @ref{17a,,functools.partial()}
wrapping a @ref{dfc,,coroutine function}, or a sync function marked with
@ref{539,,markcoroutinefunction()}.


Added in version 3.5.



Distinto en la versión 3.8: Funciones envueltas en @ref{17a,,functools.partial()} ahora retornan @code{True} si la función envuelta es un @ref{dfc,,coroutine function}.



Distinto en la versión 3.12: Sync functions marked with @ref{539,,markcoroutinefunction()} now return
@code{True}.



Distinto en la versión 3.13: Functions wrapped in @ref{17b,,functools.partialmethod()} now return @code{True}
if the wrapped function is a @ref{dfc,,coroutine function}.

@end deffn

@geindex markcoroutinefunction() (en el módulo inspect)
@anchor{library/inspect inspect markcoroutinefunction}@anchor{539}
@deffn {Función} inspect.markcoroutinefunction (func)

Decorator to mark a callable as a @ref{dfc,,coroutine function} if it would not
otherwise be detected by @ref{1c3,,iscoroutinefunction()}.

This may be of use for sync functions that return a @ref{53a,,coroutine}, if
the function is passed to an API that requires @ref{1c3,,iscoroutinefunction()}.

When possible, using an @ref{672,,async def} function is preferred. Also
acceptable is calling the function and testing the return with
@ref{e9b,,iscoroutine()}.


Added in version 3.12.

@end deffn

@geindex iscoroutine() (en el módulo inspect)
@anchor{library/inspect inspect iscoroutine}@anchor{e9b}
@deffn {Función} inspect.iscoroutine (object)

Retorna verdadero si el objeto es un @ref{53a,,coroutine} creado por una función @ref{672,,async def}.


Added in version 3.5.

@end deffn

@geindex isawaitable() (en el módulo inspect)
@anchor{library/inspect inspect isawaitable}@anchor{e9c}
@deffn {Función} inspect.isawaitable (object)

Retorna @code{True} si el objeto puede ser usado en la expresión @ref{14e,,await}.

Can also be used to distinguish generator-based coroutines from regular
generators:

@example
import types

def gen():
    yield
@@types.coroutine
def gen_coro():
    yield

assert not isawaitable(gen())
assert isawaitable(gen_coro())
@end example


Added in version 3.5.

@end deffn

@geindex isasyncgenfunction() (en el módulo inspect)
@anchor{library/inspect inspect isasyncgenfunction}@anchor{17d9}
@deffn {Función} inspect.isasyncgenfunction (object)

Return @code{True} if the object is an @ref{2039,,asynchronous generator} function,
for example:

@example
>>> async def agen():
...     yield 1
...
>>> inspect.isasyncgenfunction(agen)
True
@end example


Added in version 3.6.



Distinto en la versión 3.8: Functions wrapped in @ref{17a,,functools.partial()} now return @code{True} if the
wrapped function is an @ref{2039,,asynchronous generator} function.



Distinto en la versión 3.13: Functions wrapped in @ref{17b,,functools.partialmethod()} now return @code{True}
if the wrapped function is a @ref{dfc,,coroutine function}.

@end deffn

@geindex isasyncgen() (en el módulo inspect)
@anchor{library/inspect inspect isasyncgen}@anchor{438d}
@deffn {Función} inspect.isasyncgen (object)

Retorna verdadero si el objeto es un @ref{429f,,asynchronous generator iterator} creado por una función @ref{2039,,asynchronous generator}.


Added in version 3.6.

@end deffn

@geindex istraceback() (en el módulo inspect)
@anchor{library/inspect inspect istraceback}@anchor{438e}
@deffn {Función} inspect.istraceback (object)

Retorna @code{True} si el objeto es un traceback.
@end deffn

@geindex isframe() (en el módulo inspect)
@anchor{library/inspect inspect isframe}@anchor{438f}
@deffn {Función} inspect.isframe (object)

Retorna @code{True} si el objeto es un marco.
@end deffn

@geindex iscode() (en el módulo inspect)
@anchor{library/inspect inspect iscode}@anchor{4390}
@deffn {Función} inspect.iscode (object)

Retorna @code{True} si el objeto es un código.
@end deffn

@geindex isbuiltin() (en el módulo inspect)
@anchor{library/inspect inspect isbuiltin}@anchor{4391}
@deffn {Función} inspect.isbuiltin (object)

Retorna @code{True} si el objeto es una función incorporada o un método ligado incorporado.
@end deffn

@geindex ismethodwrapper() (en el módulo inspect)
@anchor{library/inspect inspect ismethodwrapper}@anchor{6eb}
@deffn {Función} inspect.ismethodwrapper (object)

Retorna @code{True} si el tipo de objeto es @ref{6ec,,MethodWrapperType}.

Estas son instancias de @ref{6ec,,MethodWrapperType}, como @ref{6be,,__str__()}, @ref{b85,,__eq__()} y @ref{6bd,,__repr__()}.


Added in version 3.11.

@end deffn

@geindex isroutine() (en el módulo inspect)
@anchor{library/inspect inspect isroutine}@anchor{184d}
@deffn {Función} inspect.isroutine (object)

Retorna @code{True} si el objeto es una función o método definido por el usuario o incorporado.
@end deffn

@geindex isabstract() (en el módulo inspect)
@anchor{library/inspect inspect isabstract}@anchor{4392}
@deffn {Función} inspect.isabstract (object)

Retorna @code{True} si el objeto es una clase base abstracta.
@end deffn

@geindex ismethoddescriptor() (en el módulo inspect)
@anchor{library/inspect inspect ismethoddescriptor}@anchor{15ea}
@deffn {Función} inspect.ismethoddescriptor (object)

Retorna @code{True} si el objeto es un descriptor de método, pero no si @ref{438a,,ismethod()}, @ref{4389,,isclass()}, @ref{438b,,isfunction()} o @ref{4391,,isbuiltin()} son verdaderos.

This, for example, is true of @code{int.__add__}.  An object passing this test
has a @ref{1527,,__get__()} method, but not a @ref{1f69,,__set__()}
method or a @ref{15eb,,__delete__()} method.  Beyond that, the set of
attributes varies.  A @ref{10e2,,__name__} attribute is usually
sensible, and @ref{9bb,,__doc__} often is.

Methods implemented via descriptors that also pass one of the other tests
return @code{False} from the @ref{15ea,,ismethoddescriptor()} test, simply because the
other tests promise more – you can, e.g., count on having the
@ref{1363,,__func__} attribute (etc) when an object passes
@ref{438a,,ismethod()}.


Distinto en la versión 3.13: This function no longer incorrectly reports objects with @ref{1527,,__get__()}
and @ref{15eb,,__delete__()}, but not @ref{1f69,,__set__()}, as being method
descriptors (such objects are data descriptors, not method descriptors).

@end deffn

@geindex isdatadescriptor() (en el módulo inspect)
@anchor{library/inspect inspect isdatadescriptor}@anchor{4393}
@deffn {Función} inspect.isdatadescriptor (object)

Retorna @code{True} si el objeto es un descriptor de datos.

Data descriptors have a @ref{1f69,,__set__} or a @ref{15eb,,__delete__} method.
Examples are properties (defined in Python), getsets, and members.  The
latter two are defined in C and there are more specific tests available for
those types, which is robust across Python implementations.  Typically, data
descriptors will also have @ref{10e2,,__name__} and @code{__doc__} attributes
(properties, getsets, and members have both of these attributes), but this is
not guaranteed.
@end deffn

@geindex isgetsetdescriptor() (en el módulo inspect)
@anchor{library/inspect inspect isgetsetdescriptor}@anchor{4394}
@deffn {Función} inspect.isgetsetdescriptor (object)

Retorna @code{True} si el objeto es un descriptor de conjunto.

`Detalles de implementación de CPython:' conjuntos son atributos definidos en módulos de extensión a través de estructuras @ref{c40,,PyGetSetDef}.  Para implementaciones de Python sin tales tipos, este método siempre retornará @code{False}.
@end deffn

@geindex ismemberdescriptor() (en el módulo inspect)
@anchor{library/inspect inspect ismemberdescriptor}@anchor{4395}
@deffn {Función} inspect.ismemberdescriptor (object)

Retorna @code{True} si el objeto es un descriptor de miembro.

`Detalles de implementación de CPython:' Los descriptores de miembros son atributos definidos en los módulos de extensión a través de las estructuras @ref{5f2,,PyMemberDef}.  Para implementaciones de Python sin tales tipos, este método siempre retornará @code{False}.
@end deffn

@node Recuperar el código fuente,Introspección de los invocables con el objeto Signature,Tipos y miembros,inspect — Inspect live objects
@anchor{library/inspect inspect-source}@anchor{4396}@anchor{library/inspect retrieving-source-code}@anchor{4397}
@subsubsection Recuperar el código fuente


@geindex getdoc() (en el módulo inspect)
@anchor{library/inspect inspect getdoc}@anchor{a8c}
@deffn {Función} inspect.getdoc (object)

Obtiene la cadena de documentación de un objeto, limpiada con @ref{16bd,,cleandoc()}. Si no se proporciona la cadena de documentación para un objeto y el objeto es una clase, un método, una propiedad o un descriptor, recupera la cadena de documentación de la jerarquía de herencia. Retorna @code{None} si la cadena de documentación no es válida o falta.


Distinto en la versión 3.5: Las cadenas de documentación son ahora heredadas, si no anuladas.

@end deffn

@geindex getcomments() (en el módulo inspect)
@anchor{library/inspect inspect getcomments}@anchor{15cf}
@deffn {Función} inspect.getcomments (object)

Retorna en una sola cadena las líneas de comentarios que preceden inmediatamente al código fuente del objeto (para una clase, función o método), o en la parte superior del archivo fuente de Python (si el objeto es un módulo).  Si el código fuente del objeto no está disponible, retorna @code{None}.  Esto podría suceder si el objeto ha sido definido en C o en el shell interactivo.
@end deffn

@geindex getfile() (en el módulo inspect)
@anchor{library/inspect inspect getfile}@anchor{1aab}
@deffn {Función} inspect.getfile (object)

Retorna el nombre del archivo (de texto o binario) en el que se definió un objeto. Esto fallará con un @ref{228,,TypeError} si el objeto es un módulo, clase o función incorporada.
@end deffn

@geindex getmodule() (en el módulo inspect)
@anchor{library/inspect inspect getmodule}@anchor{17eb}
@deffn {Función} inspect.getmodule (object)

Intenta adivinar en qué módulo se definió un objeto. Retorna @code{None} si no se puede determinar el módulo.
@end deffn

@geindex getsourcefile() (en el módulo inspect)
@anchor{library/inspect inspect getsourcefile}@anchor{17ec}
@deffn {Función} inspect.getsourcefile (object)

Retorna el nombre del archivo fuente de Python en el que se definió un objeto o @code{None} si no se puede identificar ninguna forma de obtener la fuente. Esto fallará con un @ref{228,,TypeError} si el objeto es un módulo, una clase o una función incorporados.
@end deffn

@geindex getsourcelines() (en el módulo inspect)
@anchor{library/inspect inspect getsourcelines}@anchor{4398}
@deffn {Función} inspect.getsourcelines (object)

Return a list of source lines and starting line number for an object. The
argument may be a module, class, method, function, traceback, frame, or code
object.  The source code is returned as a list of the lines corresponding to the
object and the line number indicates where in the original source file the first
line of code was found.  An @ref{4d5,,OSError} is raised if the source code cannot
be retrieved.
A @ref{228,,TypeError} is raised if the object is a built-in module, class, or
function.


Distinto en la versión 3.3: @ref{4d5,,OSError} se lanza en lugar de @ref{10ce,,IOError}, ahora un alias del primero.

@end deffn

@geindex getsource() (en el módulo inspect)
@anchor{library/inspect inspect getsource}@anchor{15ce}
@deffn {Función} inspect.getsource (object)

Return the text of the source code for an object. The argument may be a module,
class, method, function, traceback, frame, or code object.  The source code is
returned as a single string.  An @ref{4d5,,OSError} is raised if the source code
cannot be retrieved.
A @ref{228,,TypeError} is raised if the object is a built-in module, class, or
function.


Distinto en la versión 3.3: @ref{4d5,,OSError} se lanza en lugar de @ref{10ce,,IOError}, ahora un alias del primero.

@end deffn

@geindex cleandoc() (en el módulo inspect)
@anchor{library/inspect inspect cleandoc}@anchor{16bd}
@deffn {Función} inspect.cleandoc (doc)

Limpiar la indentación de los docstrings que están indentados para alinearse con los bloques de código.

Todos los espacios blancos principales se eliminan de la primera línea.  Cualquier espacio blanco principal que pueda ser uniformemente removido de la segunda línea en adelante es removido.  Las líneas vacías al principio y al final se eliminan posteriormente.  Además, todas las pestañas se expanden a los espacios.
@end deffn

@node Introspección de los invocables con el objeto Signature,Clases y funciones<2>,Recuperar el código fuente,inspect — Inspect live objects
@anchor{library/inspect inspect-signature-object}@anchor{4399}@anchor{library/inspect introspecting-callables-with-the-signature-object}@anchor{439a}
@subsubsection Introspección de los invocables con el objeto Signature



Added in version 3.3.


The @ref{332,,Signature} object represents the call signature of a callable object
and its return annotation. To retrieve a @code{Signature} object,
use the @code{signature()}
function.

@geindex signature() (en el módulo inspect)
@anchor{library/inspect inspect signature}@anchor{181}
@deffn {Función} inspect.signature (callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False, annotation_format=Format.VALUE)

Return a @ref{332,,Signature} object for the given `callable':

@example
>>> from inspect import signature
>>> def foo(a, *, b:int, **kwargs):
...     pass

>>> sig = signature(foo)

>>> str(sig)
'(a, *, b: int, **kwargs)'

>>> str(sig.parameters['b'])
'b: int'

>>> sig.parameters['b'].annotation
<class 'int'>
@end example

Acepta un amplio rango de invocables de Python, desde funciones y clases simples hasta objetos @ref{17a,,functools.partial()}.

If some of the annotations are strings (e.g., because
@code{from __future__ import annotations} was used), @ref{181,,signature()} will
attempt to automatically un-stringize the annotations using
@ref{147,,annotationlib.get_annotations()}.  The
`globals', `locals', and `eval_str' parameters are passed
into @code{annotationlib.get_annotations()} when resolving the
annotations; see the documentation for @code{annotationlib.get_annotations()}
for instructions on how to use these parameters. A member of the
@ref{182,,annotationlib.Format} enum can be passed to the
`annotation_format' parameter to control the format of the returned
annotations. For example, use
@code{annotation_format=annotationlib.Format.STRING} to return annotations in string
format.

Raises @ref{360,,ValueError} if no signature can be provided, and
@ref{228,,TypeError} if that type of object is not supported.  Also,
if the annotations are stringized, and `eval_str' is not false,
the @code{eval()} call(s) to un-stringize the annotations in @ref{147,,annotationlib.get_annotations()}
could potentially raise any kind of exception.

A slash (/) in the signature of a function denotes that the parameters prior
to it are positional-only. For more info, see
@ref{217a,,the FAQ entry on positional-only parameters}.


Distinto en la versión 3.5: The `follow_wrapped' parameter was added.
Pass @code{False} to get a signature of
`callable' specifically (@code{callable.__wrapped__} will not be used to
unwrap decorated callables.)



Distinto en la versión 3.10: The `globals', `locals', and `eval_str' parameters were added.



Distinto en la versión 3.14: The `annotation_format' parameter was added.


@cartouche
@quotation Nota 
Algunos invocables pueden no ser introspeccionables en ciertas implementaciones de Python.  Por ejemplo, en CPython, algunas funciones incorporadas definidas en C no proporcionan metadatos sobre sus argumentos.
@end quotation
@end cartouche

`Detalles de implementación de CPython:' If the passed object has a @code{__signature__} attribute,
we may use it to create the signature.
The exact semantics are an implementation detail and are subject to
unannounced changes. Consult the source code for current semantics.
@end deffn

@geindex Signature (clase en inspect)
@anchor{library/inspect inspect Signature}@anchor{332}
@deffn {Clase} inspect.Signature (parameters=None, *, return_annotation=Signature.empty)

A @code{Signature} object represents the call signature of a function
and its return
annotation.  For each parameter accepted by the function it stores a
@ref{333,,Parameter} object in its @ref{439b,,parameters} collection.

El argumento opcional `parámetros' es una secuencia de objetos @ref{333,,Parameter}, que se valida para comprobar que no hay parámetros con nombres duplicados, y que los parámetros están en el orden correcto, es decir, primero sólo de posición, luego de posición o palabra clave, y que los parámetros con valores por defecto siguen a los parámetros sin valores por defecto.

The optional `return_annotation' argument can be an arbitrary Python object.
It represents the «return» annotation of the callable.

@code{Signature} objects are `immutable'.  Use @ref{439c,,Signature.replace()} or
@ref{15f,,copy.replace()} to make a modified copy.


Distinto en la versión 3.5: @code{Signature} objects are now picklable and @ref{6b1,,hashable}.


@geindex empty (atributo de inspect.Signature)
@anchor{library/inspect inspect Signature empty}@anchor{439d}
@deffn {Atributo} empty

Un marcador especial de clase para especificar la ausencia de una anotación de retorno.
@end deffn

@geindex parameters (atributo de inspect.Signature)
@anchor{library/inspect inspect Signature parameters}@anchor{439b}
@deffn {Atributo} parameters

Un mapeo ordenado de los nombres de los parámetros a los correspondientes objetos @ref{333,,Parameter}.  Los parámetros aparecen en estricto orden de definición, incluyendo parámetros de sólo palabras clave.


Distinto en la versión 3.7: Python sólo garantizó explícitamente que conservaba el orden de declaración de los parámetros de sólo palabras clave a partir de la versión 3.7, aunque en la práctica este orden siempre se había conservado en Python 3.

@end deffn

@geindex return_annotation (atributo de inspect.Signature)
@anchor{library/inspect inspect Signature return_annotation}@anchor{439e}
@deffn {Atributo} return_annotation

La anotación de «retorno» para el invocable.  Si el invocable no tiene ninguna anotación de «return», este atributo se establece en @ref{439d,,Signature.empty}.
@end deffn

@geindex bind() (método de inspect.Signature)
@anchor{library/inspect inspect Signature bind}@anchor{15fb}
@deffn {Método} bind (*args, **kwargs)

Crear un mapeo de argumentos posicionales y de palabras clave a los parámetros. Retorna @ref{10e5,,BoundArguments} si @code{*args} y @code{**kwargs} coinciden con el signature, o lanza un @ref{228,,TypeError}.
@end deffn

@geindex bind_partial() (método de inspect.Signature)
@anchor{library/inspect inspect Signature bind_partial}@anchor{439f}
@deffn {Método} bind_partial (*args, **kwargs)

Funciona de la misma manera que @ref{15fb,,Signature.bind()}, pero permite la omisión de algunos argumentos requeridos (imita el comportamiento de @ref{17a,,functools.partial()}.) Retorna @ref{10e5,,BoundArguments}, o lanza un @ref{228,,TypeError} si los argumentos pasados no coinciden con la firma.
@end deffn

@geindex replace() (método de inspect.Signature)
@anchor{library/inspect inspect Signature replace}@anchor{439c}
@deffn {Método} replace (*[, parameters][, return_annotation])

Create a new @ref{332,,Signature} instance based on the instance
@ref{439c,,replace()} was invoked on.
It is possible to pass different `parameters' and/or
`return_annotation' to override the corresponding properties of the base
signature.  To remove @code{return_annotation} from the copied
@code{Signature}, pass in
@ref{439d,,Signature.empty}.

@example
>>> def test(a, b):
...     pass
...
>>> sig = signature(test)
>>> new_sig = sig.replace(return_annotation="new return anno")
>>> str(new_sig)
"(a, b) -> 'new return anno'"
@end example

@ref{332,,Signature} objects are also supported by the generic function
@ref{15f,,copy.replace()}.
@end deffn

@geindex format() (método de inspect.Signature)
@anchor{library/inspect inspect Signature format}@anchor{183}
@deffn {Método} format (*, max_width=None, quote_annotation_strings=True)

Create a string representation of the @ref{332,,Signature} object.

If `max_width' is passed, the method will attempt to fit
the signature into lines of at most `max_width' characters.
If the signature is longer than `max_width',
all parameters will be on separate lines.

If `quote_annotation_strings' is False, @ref{140,,annotations}
in the signature are displayed without opening and closing quotation
marks if they are strings. This is useful if the signature was created with the
@ref{144,,STRING} format or if
@code{from __future__ import annotations} was used.


Added in version 3.13.



Distinto en la versión 3.14: The `unquote_annotations' parameter was added.

@end deffn

@geindex from_callable() (método de clase de inspect.Signature)
@anchor{library/inspect inspect Signature from_callable}@anchor{7d5}
@deffn {Método} classmethod from_callable (obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)

Return a @ref{332,,Signature} (or its subclass) object for a given callable
`obj'.

This method simplifies subclassing of @ref{332,,Signature}:

@example
class MySignature(Signature):
    pass
sig = MySignature.from_callable(sum)
assert isinstance(sig, MySignature)
@end example

Its behavior is otherwise identical to that of @ref{181,,signature()}.


Added in version 3.5.



Distinto en la versión 3.10: The `globals', `locals', and `eval_str' parameters were added.

@end deffn
@end deffn

@geindex Parameter (clase en inspect)
@anchor{library/inspect inspect Parameter}@anchor{333}
@deffn {Clase} inspect.Parameter (name, kind, *, default=Parameter.empty, annotation=Parameter.empty)

@code{Parameter} objects are `immutable'.
Instead of modifying a @code{Parameter} object,
you can use @ref{43a0,,Parameter.replace()} or @ref{15f,,copy.replace()} to create a modified copy.


Distinto en la versión 3.5: Parameter objects are now picklable and @ref{6b1,,hashable}.


@geindex empty (atributo de inspect.Parameter)
@anchor{library/inspect inspect Parameter empty}@anchor{43a1}
@deffn {Atributo} empty

Un marcador especial de clase para especificar la ausencia de valores predeterminados y anotaciones.
@end deffn

@geindex name (atributo de inspect.Parameter)
@anchor{library/inspect inspect Parameter name}@anchor{43a2}
@deffn {Atributo} name

El nombre del parámetro como una cadena.  El nombre debe ser un identificador Python válido.

`Detalles de implementación de CPython:' CPython genera nombres de parámetros implícitos de la forma @code{.0} en los objetos de código utilizados para implementar expresiones de comprensiones y generadores.


Distinto en la versión 3.6: These parameter names are now exposed by this module as names like
@code{implicit0}.

@end deffn

@geindex default (atributo de inspect.Parameter)
@anchor{library/inspect inspect Parameter default}@anchor{43a3}
@deffn {Atributo} default

El valor por defecto del parámetro.  Si el parámetro no tiene un valor por defecto, este atributo se establece en @ref{43a1,,Parameter.empty}.
@end deffn

@geindex annotation (atributo de inspect.Parameter)
@anchor{library/inspect inspect Parameter annotation}@anchor{43a4}
@deffn {Atributo} annotation

La anotación para el parámetro.  Si el parámetro no tiene ninguna anotación, este atributo se establece como @ref{43a1,,Parameter.empty}.
@end deffn

@geindex kind (atributo de inspect.Parameter)
@anchor{library/inspect inspect Parameter kind}@anchor{43a5}
@deffn {Atributo} kind

Describes how argument values are bound to the parameter.  The possible
values are accessible via @ref{333,,Parameter} (like @code{Parameter.KEYWORD_ONLY}),
and support comparison and ordering, in the following order:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre

@tab

Significado

@item

`POSITIONAL_ONLY'

@tab

El valor debe proporcionarse como un argumento posicional. Los parámetros solo posicionales son aquellos que aparecen antes de una entrada @code{/} (si está presente) en una definición de función de Python. aceptan sólo uno o dos parámetros) los aceptan.

@item

`POSITIONAL_OR_KEYWORD'

@tab

El valor puede ser suministrado como una palabra clave o como un argumento posicional (este es el comportamiento estándar de unión para las funciones implementadas en Python)

@item

`VAR_POSITIONAL'

@tab

Una tupla de argumentos posicionales que no están ligados a ningún otro parámetro. Esto corresponde a un parámetro @code{*args} en una definición de función Python.

@item

`KEYWORD_ONLY'

@tab

El valor debe ser suministrado como argumento de la palabra clave. Los parámetros de sólo palabras clave son los que aparecen después de una entrada @code{*} o @code{*args} en una definición de función Python.

@item

`VAR_KEYWORD'

@tab

Un dictado de argumentos de palabras clave que no están ligadas a ningún otro parámetro. Esto corresponde a un parámetro @code{**kwargs} en una definición de función Python.

@end multitable


Example: print all keyword-only arguments without default values:

@example
>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     if (param.kind == param.KEYWORD_ONLY and
...                        param.default is param.empty):
...         print('Parameter:', param)
Parameter: c
@end example
@end deffn

@geindex description (atributo de inspect.Parameter.kind)
@anchor{library/inspect inspect Parameter kind description}@anchor{43a6}
@deffn {Atributo} kind.description

Describes an enum value of @ref{43a5,,Parameter.kind}.


Added in version 3.8.


Example: print all descriptions of arguments:

@example
>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     print(param.kind.description)
positional or keyword
positional or keyword
keyword-only
keyword-only
@end example
@end deffn

@geindex replace() (método de inspect.Parameter)
@anchor{library/inspect inspect Parameter replace}@anchor{43a0}
@deffn {Método} replace (*[, name][, kind][, default][, annotation])

Create a new @ref{333,,Parameter} instance based on the instance replaced was invoked
on.  To override a @code{Parameter} attribute, pass the corresponding
argument.  To remove a default value or/and an annotation from a
@code{Parameter}, pass @ref{43a1,,Parameter.empty}.

@example
>>> from inspect import Parameter
>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
>>> str(param)
'foo=42'

>>> str(param.replace()) # Will create a shallow copy of 'param'
'foo=42'

>>> str(param.replace(default=Parameter.empty, annotation='spam'))
"foo: 'spam'"
@end example

@ref{333,,Parameter} objects are also supported by the generic function
@ref{15f,,copy.replace()}.
@end deffn


Distinto en la versión 3.4: In Python 3.3 @ref{333,,Parameter} objects were allowed to have @code{name} set
to @code{None} if their @code{kind} was set to @code{POSITIONAL_ONLY}.
This is no longer permitted.

@end deffn

@geindex BoundArguments (clase en inspect)
@anchor{library/inspect inspect BoundArguments}@anchor{10e5}
@deffn {Clase} inspect.BoundArguments

Resultado de una llamada @ref{15fb,,Signature.bind()} o @ref{439f,,Signature.bind_partial()}. Mantiene el mapeo de los argumentos a los parámetros de la función.

@geindex arguments (atributo de inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments arguments}@anchor{9a2}
@deffn {Atributo} arguments

Un mapeo mutable de los nombres de los parámetros a los valores de los argumentos. Contiene solo argumentos vinculados explícitamente. Los cambios en @ref{9a2,,arguments} se reflejarán en @ref{43a7,,args} y @ref{43a8,,kwargs}.

Debe ser usado en conjunto con @ref{439b,,Signature.parameters} para cualquier propósito de procesamiento de argumentos.

@cartouche
@quotation Nota 
Los argumentos para los cuales @ref{15fb,,Signature.bind()} o @ref{439f,,Signature.bind_partial()} se basaban en un valor por defecto se saltan. Sin embargo, si es necesario, use @ref{e9a,,BoundArguments.apply_defaults()} para añadirlos.
@end quotation
@end cartouche


Distinto en la versión 3.9: @ref{9a2,,arguments} ahora es de tipo @ref{190,,dict}. Anteriormente, era de tipo @ref{67c,,collections.OrderedDict}.

@end deffn

@geindex args (atributo de inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments args}@anchor{43a7}
@deffn {Atributo} args

Una tupla de valores de argumentos posicionales.  Calculados dinámicamente a partir del atributo @ref{9a2,,arguments}.
@end deffn

@geindex kwargs (atributo de inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments kwargs}@anchor{43a8}
@deffn {Atributo} kwargs

A dict of keyword arguments values.  Dynamically computed from the
@ref{9a2,,arguments} attribute.  Arguments that can be passed positionally
are included in @ref{43a7,,args} instead.
@end deffn

@geindex signature (atributo de inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments signature}@anchor{43a9}
@deffn {Atributo} signature

Una referencia al objeto padre @ref{332,,Signature}.
@end deffn

@geindex apply_defaults() (método de inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments apply_defaults}@anchor{e9a}
@deffn {Método} apply_defaults ()

Establece valores por defecto para los argumentos que faltan.

Para los argumentos de posición variable (@code{*args}) el valor por defecto es una tupla vacía.

Para los argumentos de palabras clave variables (@code{**kwargs}) el valor por defecto es un diccionario vacío.

@example
>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
@{'a': 'spam', 'b': 'ham', 'args': ()@}
@end example


Added in version 3.5.

@end deffn

The @ref{43a7,,args} and @ref{43a8,,kwargs} properties can be used to invoke
functions:

@example
def test(a, *, b):
    ...

sig = signature(test)
ba = sig.bind(10, b=20)
test(*ba.args, **ba.kwargs)
@end example
@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/} - Función Objeto Signature.

La especificación detallada, los detalles de implementación y los ejemplos.
@end table


@node Clases y funciones<2>,La pila del interprete,Introspección de los invocables con el objeto Signature,inspect — Inspect live objects
@anchor{library/inspect classes-and-functions}@anchor{43aa}@anchor{library/inspect inspect-classes-functions}@anchor{43ab}
@subsubsection Clases y funciones


@geindex getclasstree() (en el módulo inspect)
@anchor{library/inspect inspect getclasstree}@anchor{43ac}
@deffn {Función} inspect.getclasstree (classes, unique=False)

Organizar la lista de clases dada en una jerarquía de listas anidadas. Cuando aparece una lista anidada, contiene clases derivadas de la clase cuya entrada precede inmediatamente a la lista.  Cada entrada es una tupla de 2 valores que contienen una clase y una tupla de sus clases base.  Si el argumento `unique' es cierto, aparece exactamente una entrada en la estructura retornada para cada clase de la lista dada.  De lo contrario, las clases que utilizan la herencia múltiple y sus descendientes aparecerán varias veces.
@end deffn

@geindex getfullargspec() (en el módulo inspect)
@anchor{library/inspect inspect getfullargspec}@anchor{7d4}
@deffn {Función} inspect.getfullargspec (func)

Obtener los nombres y valores por defecto de los parámetros de una función de Python.  Se retorna un @ref{6ef,,named tuple}:

@code{FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults,
annotations)}

`args' es una lista de los nombres de los parámetros posicionales. `varargs' es el nombre del parámetro @code{*} o @code{None} si no se aceptan argumentos posicionales arbitrarios. `varkw' es el nombre del parámetro @code{**} o @code{None} si no se aceptan argumentos de palabras clave arbitrarias. `defaults' es una `n'-tupla de valores de argumentos por defecto que corresponden a los últimos parámetros de posición `n', o @code{None} si no hay tales valores por defecto definidos. `kwonlyargs' es una lista de nombres de parámetros de sólo palabras clave en orden de declaración. `kwonlydefaults' es un diccionario que asigna los nombres de los parámetros de `kwonlyargs' a los valores por defecto utilizados si no se suministra ningún argumento. `annotations' es un diccionario que asigna los nombres de los parámetros a las anotaciones. La tecla especial @code{"return"} se utiliza para informar de la anotación del valor de retorno de la función (si existe).

Observe que @ref{181,,signature()} y @ref{4399,,Objeto Signature} proporcionan la API recomendada para la introspección invocable, y soportan comportamientos adicionales (como los argumentos de sólo posición) que a veces se encuentran en las API de los módulos de extensión. Esta función se conserva principalmente para su uso en el código que necesita mantener la compatibilidad con la API de módulos de @code{inspect} de Python 2.


Distinto en la versión 3.4: Esta función se basa ahora en @ref{181,,signature()}, pero sigue ignorando los atributos @code{__wrapped__} e incluye el primer parámetro ya ligado en la salida del signature para los métodos ligados.



Distinto en la versión 3.6: Este método fue documentado anteriormente como obsoleto en favor de @ref{181,,signature()} en Python 3.5, pero esa decisión ha sido revocada para restaurar una interfaz estándar claramente soportada para el código de una sola fuente en Python 2/3 que se aleja de la API heredada @code{getargspec()}.



Distinto en la versión 3.7: Python sólo garantizó explícitamente que conservaba el orden de declaración de los parámetros de sólo palabras clave a partir de la versión 3.7, aunque en la práctica este orden siempre se había conservado en Python 3.

@end deffn

@geindex getargvalues() (en el módulo inspect)
@anchor{library/inspect inspect getargvalues}@anchor{f3f}
@deffn {Función} inspect.getargvalues (frame)

Obtener información sobre los argumentos pasados en un marco particular.  Un @ref{6ef,,named tuple} @code{ArgInfo(args, varargs, keywords, locals)} es retornado. `args' es una lista de los nombres de los argumentos.  `varargs' y `keywords' son los nombres de los argumentos @code{*} y @code{**} o @code{None}.  `locals' es el diccionario local del marco dado.

@cartouche
@quotation Nota 
Esta función fue inadvertidamente marcada como obsoleta en Python 3.5.
@end quotation
@end cartouche
@end deffn

@geindex formatargvalues() (en el módulo inspect)
@anchor{library/inspect inspect formatargvalues}@anchor{f40}
@deffn {Función} inspect.formatargvalues (args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])

Formatea una bonita especificación de argumentos de los cuatro valores retornados por @ref{f3f,,getargvalues()}.  Los argumentos de formato* son las correspondientes funciones de formato opcionales que se llaman para convertir nombres y valores en cadenas.

@cartouche
@quotation Nota 
Esta función fue inadvertidamente marcada como obsoleta en Python 3.5.
@end quotation
@end cartouche
@end deffn

@geindex getmro() (en el módulo inspect)
@anchor{library/inspect inspect getmro}@anchor{43ad}
@deffn {Función} inspect.getmro (cls)

Retorna una tupla de clases base de cls, incluyendo cls, en orden de resolución de métodos.  Ninguna clase aparece más de una vez en esta tupla. Obsérvese que el orden de resolución de los métodos depende del tipo de cls.  A menos que se utilice un meta tipo muy peculiar definido por el usuario, cls será el primer elemento de la tupla.
@end deffn

@geindex getcallargs() (en el módulo inspect)
@anchor{library/inspect inspect getcallargs}@anchor{f3e}
@deffn {Función} inspect.getcallargs (func, /, *args, **kwds)

Bind the `args' and `kwds' to the argument names of the Python function or
method `func', as if it was called with them. For bound methods, bind also the
first argument (typically named @code{self}) to the associated instance. A dict
is returned, mapping the argument names (including the names of the @code{*} and
@code{**} arguments, if any) to their values from `args' and `kwds'. In case of
invoking `func' incorrectly, i.e. whenever @code{func(*args, **kwds)} would raise
an exception because of incompatible signature, an exception of the same type
and the same or similar message is raised. For example:

@example
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
...     pass
...
>>> getcallargs(f, 1, 2, 3) == @{'a': 1, 'named': @{@}, 'b': 2, 'pos': (3,)@}
True
>>> getcallargs(f, a=2, x=4) == @{'a': 2, 'named': @{'x': 4@}, 'b': 1, 'pos': ()@}
True
>>> getcallargs(f)
Traceback (most recent call last):
...
TypeError: f() missing 1 required positional argument: 'a'
@end example


Added in version 3.2.



Obsoleto desde la versión 3.5: Usa @ref{15fb,,Signature.bind()} y @ref{439f,,Signature.bind_partial()} en su lugar.

@end deffn

@geindex getclosurevars() (en el módulo inspect)
@anchor{library/inspect inspect getclosurevars}@anchor{1149}
@deffn {Función} inspect.getclosurevars (func)

Obtener el mapeo de referencias de nombres externos en una función o método `func' de Python a sus valores actuales. Un @ref{6ef,,named tuple} @code{ClosureVars(nonlocals, globals, builtins, unbound)} es retornado. `nonlocals' asigna los nombres referidos a las variables de cierre léxicas, `globals' a los globals de los módulos de la función y `builtins' a los builtins visibles desde el cuerpo de la función. `unbound' es el conjunto de nombres referenciados en la función que no pudieron ser resueltos en absoluto dados los actuales globals y builtins del módulo.

@ref{228,,TypeError} es lanzado si `func' no es una función o método de Python.


Added in version 3.3.

@end deffn

@geindex unwrap() (en el módulo inspect)
@anchor{library/inspect inspect unwrap}@anchor{fdc}
@deffn {Función} inspect.unwrap (func, *, stop=None)

Obtiene el objeto envuelto por `func'. Sigue la cadena de atributos @code{__wrapped__} retornando el último objeto de la cadena.

`stop' es una retrollamada opcional que acepta un objeto de la cadena envuelta como único argumento que permite terminar el desenvolvimiento antes de tiempo si la retrollamada retorna un valor real. Si la retrollamada nunca retorna un valor verdadero, el último objeto de la cadena se retorna como de costumbre. Por ejemplo, @ref{181,,signature()} utiliza esto para detener el desenvolvimiento si algún objeto de la cadena tiene definido el atributo @code{__signature__}.

@ref{360,,ValueError} es lanzado si se encuentra un ciclo.


Added in version 3.4.

@end deffn

@geindex get_annotations() (en el módulo inspect)
@anchor{library/inspect inspect get_annotations}@anchor{8aa}
@deffn {Función} inspect.get_annotations (obj, *, globals=None, locals=None, eval_str=False, format=annotationlib.Format.VALUE)

Calcular el diccionario de anotaciones de un objeto.

This is an alias for @ref{147,,annotationlib.get_annotations()}; see the documentation
of that function for more information.


Added in version 3.10.



Distinto en la versión 3.14: This function is now an alias for @ref{147,,annotationlib.get_annotations()}.
Calling it as @code{inspect.get_annotations} will continue to work.

@end deffn

@node La pila del interprete,Obteniendo atributos estáticamente,Clases y funciones<2>,inspect — Inspect live objects
@anchor{library/inspect inspect-stack}@anchor{43ae}@anchor{library/inspect the-interpreter-stack}@anchor{43af}
@subsubsection La pila del interprete


Algunas de las siguientes funciones retornan objetos @ref{6ed,,FrameInfo}. Por compatibilidad con versiones anteriores, estos objetos permiten operaciones similares a tuplas en todos los atributos excepto @code{positions}. Este comportamiento se considera obsoleto y puede eliminarse en el futuro.

@geindex FrameInfo (clase en inspect)
@anchor{library/inspect inspect FrameInfo}@anchor{6ed}
@deffn {Clase} inspect.FrameInfo

@geindex frame (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo frame}@anchor{43b0}
@deffn {Atributo} frame

El @ref{780,,frame object} al que corresponde el registro.
@end deffn

@geindex filename (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo filename}@anchor{43b1}
@deffn {Atributo} filename

El nombre del archivo asociado con el código que está ejecutando el marco al que corresponde este registro.
@end deffn

@geindex lineno (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo lineno}@anchor{43b2}
@deffn {Atributo} lineno

El número de línea de la línea actual asociada con el código que está ejecutando el marco al que corresponde este registro.
@end deffn

@geindex function (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo function}@anchor{43b3}
@deffn {Atributo} function

El nombre de la función que está ejecutando el marco al que corresponde este registro.
@end deffn

@geindex code_context (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo code_context}@anchor{43b4}
@deffn {Atributo} code_context

Una lista de líneas de contexto del código fuente que ejecuta el marco al que corresponde este registro.
@end deffn

@geindex index (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo index}@anchor{43b5}
@deffn {Atributo} index

El índice de la línea actual que se está ejecutando en la lista @ref{43b4,,code_context}.
@end deffn

@geindex positions (atributo de inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo positions}@anchor{43b6}
@deffn {Atributo} positions

Un objeto @ref{15d7,,dis.Positions} que contiene el número de línea inicial, el número de línea final, el desplazamiento de columna inicial y el desplazamiento de columna final asociado con la instrucción que ejecuta el marco al que corresponde este registro.
@end deffn


Distinto en la versión 3.5: Retorna un @ref{6ef,,named tuple} en lugar de un @ref{464,,tuple}.



Distinto en la versión 3.11: @code{FrameInfo} ahora es una instancia de clase (que es retrocompatible con el anterior @ref{6ef,,named tuple}).

@end deffn

@geindex Traceback (clase en inspect)
@anchor{library/inspect inspect Traceback}@anchor{6ee}
@deffn {Clase} inspect.Traceback

@geindex filename (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback filename}@anchor{43b7}
@deffn {Atributo} filename

El nombre de archivo asociado con el código que ejecuta el marco al que corresponde este rastreo.
@end deffn

@geindex lineno (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback lineno}@anchor{43b8}
@deffn {Atributo} lineno

El número de línea de la línea actual asociada con el código que está ejecutando el marco al que corresponde este rastreo.
@end deffn

@geindex function (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback function}@anchor{43b9}
@deffn {Atributo} function

El nombre de la función que está ejecutando el marco al que corresponde este rastreo.
@end deffn

@geindex code_context (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback code_context}@anchor{43ba}
@deffn {Atributo} code_context

Una lista de líneas de contexto del código fuente que ejecuta el marco al que corresponde este rastreo.
@end deffn

@geindex index (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback index}@anchor{43bb}
@deffn {Atributo} index

El índice de la línea actual que se está ejecutando en la lista @ref{43ba,,code_context}.
@end deffn

@geindex positions (atributo de inspect.Traceback)
@anchor{library/inspect inspect Traceback positions}@anchor{43bc}
@deffn {Atributo} positions

Un objeto @ref{15d7,,dis.Positions} que contiene el número de línea inicial, el número de línea final, el desplazamiento de columna inicial y el desplazamiento de columna final asociado con la instrucción que ejecuta el marco al que corresponde este rastreo.
@end deffn


Distinto en la versión 3.11: @code{Traceback} ahora es una instancia de clase (que es retrocompatible con el anterior @ref{6ef,,named tuple}).

@end deffn

@cartouche
@quotation Nota 
Mantener referencias a los objetos marco, como se encuentra en el primer elemento de los registros marco que estas funciones retornan, puede hacer que su programa cree ciclos de referencia.  Una vez creado un ciclo de referencia, la vida útil de todos los objetos a los que se puede acceder desde los objetos que forman el ciclo puede ser mucho mayor, incluso si el detector de ciclos opcional de Python está activado.  Si es necesario crear tales ciclos, es importante asegurarse de que se rompen explícitamente para evitar la destrucción retardada de los objetos y el aumento del consumo de memoria que se produce.

Aunque el detector de ciclos los captará, la destrucción de los marcos (y las variables locales) puede hacerse determinísticamente eliminando el ciclo en una cláusula de @ref{a5c,,finally}.  Esto también es importante si el detector de ciclos fue desactivado cuando se compiló Python o usando @ref{4379,,gc.disable()}.  Por ejemplo:

@example
def handle_stackframe_without_leak():
    frame = inspect.currentframe()
    try:
        # do something with the frame
    finally:
        del frame
@end example

Si quieres mantener el marco alrededor (por ejemplo para imprimir una traceback más tarde), también puedes romper los ciclos de referencia utilizando el método @ref{3d5,,frame.clear()}.
@end quotation
@end cartouche

El argumento opcional de `context', apoyado por la mayoría de estas funciones, especifica el número de líneas de contexto a retornar, que se centran en la línea actual.

@geindex getframeinfo() (en el módulo inspect)
@anchor{library/inspect inspect getframeinfo}@anchor{6f0}
@deffn {Función} inspect.getframeinfo (frame, context=1)

Obtiene información sobre un marco o un objeto de rastreo. Se retorna un objeto @ref{6ee,,Traceback}.


Distinto en la versión 3.11: Se retorna un objeto @ref{6ee,,Traceback} en lugar de una tupla con nombre.

@end deffn

@geindex getouterframes() (en el módulo inspect)
@anchor{library/inspect inspect getouterframes}@anchor{6f1}
@deffn {Función} inspect.getouterframes (frame, context=1)

Obtiene una lista de objetos @ref{6ed,,FrameInfo} para un marco y todos los marcos externos. Estos marcos representan las llamadas que conducen a la creación de `frame'. La primera entrada en la lista retornada representa `frame'; la última entrada representa la llamada más externa en la pila de `frame'.


Distinto en la versión 3.5: Una lista de @ref{6ef,,named tuples} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} es retornada.



Distinto en la versión 3.11: Se retorna una lista de objetos @ref{6ed,,FrameInfo}.

@end deffn

@geindex getinnerframes() (en el módulo inspect)
@anchor{library/inspect inspect getinnerframes}@anchor{6f2}
@deffn {Función} inspect.getinnerframes (traceback, context=1)

Obtiene una lista de objetos @ref{6ed,,FrameInfo} para el marco de un rastreo y todos los marcos internos. Estos marcos representan llamadas realizadas como consecuencia de `frame'. La primera entrada de la lista representa `traceback'; la última entrada representa dónde se generó la excepción.


Distinto en la versión 3.5: Una lista de @ref{6ef,,named tuples} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} es retornada.



Distinto en la versión 3.11: Se retorna una lista de objetos @ref{6ed,,FrameInfo}.

@end deffn

@geindex currentframe() (en el módulo inspect)
@anchor{library/inspect inspect currentframe}@anchor{782}
@deffn {Función} inspect.currentframe ()

Retorna el objeto marco para el marco de la pila del que llama.

`Detalles de implementación de CPython:' Esta función se basa en el soporte del marco de la pila de Python en el intérprete, que no está garantizado que exista en todas las implementaciones de Python.  Si se ejecuta en una implementación sin soporte de marcos de pila de Python, esta función retorna @code{None}.
@end deffn

@geindex stack() (en el módulo inspect)
@anchor{library/inspect inspect stack}@anchor{6f3}
@deffn {Función} inspect.stack (context=1)

Retorna una lista de objetos @ref{6ed,,FrameInfo} para la pila del que llama. La primera entrada en la lista retornada representa al que llama; la última entrada representa la llamada más externa de la pila.


Distinto en la versión 3.5: Una lista de @ref{6ef,,named tuples} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} es retornada.



Distinto en la versión 3.11: Se retorna una lista de objetos @ref{6ed,,FrameInfo}.

@end deffn

@geindex trace() (en el módulo inspect)
@anchor{library/inspect inspect trace}@anchor{6f4}
@deffn {Función} inspect.trace (context=1)

Retorna una lista de objetos @ref{6ed,,FrameInfo} para la pila entre el marco actual y el marco en el que se generó una excepción que se está manejando actualmente. La primera entrada en la lista representa al que llama; la última entrada representa dónde se generó la excepción.


Distinto en la versión 3.5: Una lista de @ref{6ef,,named tuples} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} es retornada.



Distinto en la versión 3.11: Se retorna una lista de objetos @ref{6ed,,FrameInfo}.

@end deffn

@node Obteniendo atributos estáticamente,Current State of Generators Coroutines and Asynchronous Generators,La pila del interprete,inspect — Inspect live objects
@anchor{library/inspect fetching-attributes-statically}@anchor{43bd}
@subsubsection Obteniendo atributos estáticamente


Both @ref{c59,,getattr()} and @ref{579,,hasattr()} can trigger code execution when
fetching or checking for the existence of attributes. Descriptors, like
properties, will be invoked and @ref{57a,,__getattr__()} and
@ref{c5a,,__getattribute__()}
may be called.

Para los casos en los que se quiera una introspección pasiva, como las herramientas de documentación, esto puede ser un inconveniente. @ref{53d,,getattr_static()} tiene la misma firma que @ref{c59,,getattr()} pero evita la ejecución de código cuando obtiene atributos.

@geindex getattr_static() (en el módulo inspect)
@anchor{library/inspect inspect getattr_static}@anchor{53d}
@deffn {Función} inspect.getattr_static (obj, attr, default=None)

Retrieve attributes without triggering dynamic lookup via the
descriptor protocol, @ref{57a,,__getattr__()}
or @ref{c5a,,__getattribute__()}.

Nota: es posible que esta función no pueda recuperar todos los atributos que getattr puede recuperar (como los atributos creados dinámicamente) y puede encontrar atributos que getattr no puede (como los descriptores que lanzan AttributeError). También puede retornar objetos descriptores en lugar de miembros de la instancia.

Si la instancia @ref{5fe,,__dict__} es ensombrecida por otro miembro (por ejemplo una propiedad) entonces esta función no podrá encontrar miembros de la instancia.


Added in version 3.2.

@end deffn

@ref{53d,,getattr_static()} no resuelve los descriptores, por ejemplo los descriptores de ranura o los descriptores de getset en los objetos implementados en C. El objeto descriptor se retorna en lugar del atributo subyacente.

Puedes manejar esto con un código como el siguiente. Tenga en cuenta que la invocación de los descriptores de getset arbitrarios pueden desencadenar la ejecución del código:

@example
# example code for resolving the builtin descriptor types
class _foo:
    __slots__ = ['foo']

slot_descriptor = type(_foo.foo)
getset_descriptor = type(type(open(__file__)).name)
wrapper_descriptor = type(str.__dict__['__add__'])
descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)

result = getattr_static(some_object, 'foo')
if type(result) in descriptor_types:
    try:
        result = result.__get__()
    except AttributeError:
        # descriptors can raise AttributeError to
        # indicate there is no underlying value
        # in which case the descriptor itself will
        # have to do
        pass
@end example

@node Current State of Generators Coroutines and Asynchronous Generators,Objetos de código Bit Flags,Obteniendo atributos estáticamente,inspect — Inspect live objects
@anchor{library/inspect current-state-of-generators-coroutines-and-asynchronous-generators}@anchor{43be}
@subsubsection Current State of Generators, Coroutines, and Asynchronous Generators


Al implementar los programadores de corutinas y para otros usos avanzados de los generadores, es útil determinar si un generador se está ejecutando actualmente, si está esperando para iniciarse o reanudarse o si ya ha terminado. @ref{12a3,,getgeneratorstate()} permite determinar fácilmente el estado actual de un generador.

@geindex getgeneratorstate() (en el módulo inspect)
@anchor{library/inspect inspect getgeneratorstate}@anchor{12a3}
@deffn {Función} inspect.getgeneratorstate (generator)

Obtener el estado actual de un generador-iterador.

Los posibles estados son:


@itemize *

@item 
GEN_CREATED: Esperando para iniciar la ejecución.

@item 
GEN_RUNNING: Actualmente está siendo ejecutado por el intérprete.

@item 
GEN_SUSPENDED: Actualmente suspendido en una expresión yield.

@item 
GEN_CLOSED: La ejecución se ha completado.
@end itemize


Added in version 3.2.

@end deffn

@geindex getcoroutinestate() (en el módulo inspect)
@anchor{library/inspect inspect getcoroutinestate}@anchor{e9e}
@deffn {Función} inspect.getcoroutinestate (coroutine)

Obtener el estado actual de un objeto de corutina.  La función está pensada para ser usada con objetos de corutina creados por las funciones @ref{672,,async def}, pero aceptará cualquier objeto de corutina que tenga los atributos @code{cr_running} y @code{cr_frame}.

Los posibles estados son:


@itemize *

@item 
CORO_CREATED: Esperando para iniciar la ejecución.

@item 
CORO_RUNNING: Actualmente está siendo ejecutado por el intérprete.

@item 
CORO_SUSPENDED: Actualmente suspendido en una expresión de espera.

@item 
CORO_CLOSED: La ejecución se ha completado.
@end itemize


Added in version 3.5.

@end deffn

@geindex getasyncgenstate() (en el módulo inspect)
@anchor{library/inspect inspect getasyncgenstate}@anchor{53b}
@deffn {Función} inspect.getasyncgenstate (agen)

Get current state of an asynchronous generator object.  The function is
intended to be used with asynchronous iterator objects created by
@ref{672,,async def} functions which use the @ref{a5f,,yield} statement,
but will accept any asynchronous generator-like object that has
@code{ag_running} and @code{ag_frame} attributes.

Los posibles estados son:


@itemize *

@item 
AGEN_CREATED: Waiting to start execution.

@item 
AGEN_RUNNING: Currently being executed by the interpreter.

@item 
AGEN_SUSPENDED: Currently suspended at a yield expression.

@item 
AGEN_CLOSED: Execution has completed.
@end itemize


Added in version 3.12.

@end deffn

También se puede consultar el estado interno actual del generador. Esto es mayormente útil para fines de prueba, para asegurar que el estado interno se actualiza como se espera:

@geindex getgeneratorlocals() (en el módulo inspect)
@anchor{library/inspect inspect getgeneratorlocals}@anchor{114a}
@deffn {Función} inspect.getgeneratorlocals (generator)

Consigue el mapeo de las variables vivas locales en `generator' a sus valores actuales.  Se retorna un diccionario que mapea de los nombres de las variables a los valores. Esto es el equivalente a llamar @ref{2ae,,locals()} en el cuerpo del generador, y se aplican todas las mismas advertencias.

Si `generator' es un @ref{10dd,,generator} sin marco asociado actualmente, entonces se retorna un diccionario vacío. @ref{228,,TypeError} es lanzado si `generator' no es un objeto generador de Python.

`Detalles de implementación de CPython:' Esta función se basa en que el generador exponga un marco de pila de Python para la introspección, lo cual no está garantizado en todas las implementaciones de Python. En tales casos, esta función siempre retornará un diccionario vacío.


Added in version 3.3.

@end deffn

@geindex getcoroutinelocals() (en el módulo inspect)
@anchor{library/inspect inspect getcoroutinelocals}@anchor{e9d}
@deffn {Función} inspect.getcoroutinelocals (coroutine)

Esta función es análoga a @ref{114a,,getgeneratorlocals()}, pero funciona para los objetos de corutina creados por funciones @ref{672,,async def}.


Added in version 3.5.

@end deffn

@geindex getasyncgenlocals() (en el módulo inspect)
@anchor{library/inspect inspect getasyncgenlocals}@anchor{53c}
@deffn {Función} inspect.getasyncgenlocals (agen)

This function is analogous to @ref{114a,,getgeneratorlocals()}, but
works for asynchronous generator objects created by @ref{672,,async def}
functions which use the @ref{a5f,,yield} statement.


Added in version 3.12.

@end deffn

@node Objetos de código Bit Flags,Buffer flags,Current State of Generators Coroutines and Asynchronous Generators,inspect — Inspect live objects
@anchor{library/inspect code-objects-bit-flags}@anchor{43bf}@anchor{library/inspect inspect-module-co-flags}@anchor{1f45}
@subsubsection Objetos de código Bit Flags


Python code objects have a @ref{15ae,,co_flags} attribute,
which is a bitmap of the following flags:

@geindex CO_OPTIMIZED (en el módulo inspect)
@anchor{library/inspect inspect CO_OPTIMIZED}@anchor{43c0}
@deffn {Dato} inspect.CO_OPTIMIZED

El objeto del código está optimizado, usando locales rápidas (`fast locals').
@end deffn

@geindex CO_NEWLOCALS (en el módulo inspect)
@anchor{library/inspect inspect CO_NEWLOCALS}@anchor{43c1}
@deffn {Dato} inspect.CO_NEWLOCALS

If set, a new dict will be created for the frame’s @ref{2ed,,f_locals}
when the code object is executed.
@end deffn

@geindex CO_VARARGS (en el módulo inspect)
@anchor{library/inspect inspect CO_VARARGS}@anchor{43c2}
@deffn {Dato} inspect.CO_VARARGS

El objeto del código tiene un parámetro posicional variable (similar a @code{*args}).
@end deffn

@geindex CO_VARKEYWORDS (en el módulo inspect)
@anchor{library/inspect inspect CO_VARKEYWORDS}@anchor{43c3}
@deffn {Dato} inspect.CO_VARKEYWORDS

El objeto del código tiene un parámetro de palabra clave variable (similar a @code{**kwargs}).
@end deffn

@geindex CO_NESTED (en el módulo inspect)
@anchor{library/inspect inspect CO_NESTED}@anchor{43c4}
@deffn {Dato} inspect.CO_NESTED

El flag se fija cuando el objeto del código es una función anidada.
@end deffn

@geindex CO_GENERATOR (en el módulo inspect)
@anchor{library/inspect inspect CO_GENERATOR}@anchor{43c5}
@deffn {Dato} inspect.CO_GENERATOR

El flag se fija cuando el objeto del código es una función generadora, es decir, un objeto generador es retornado cuando el objeto del código se ejecuta.
@end deffn

@geindex CO_COROUTINE (en el módulo inspect)
@anchor{library/inspect inspect CO_COROUTINE}@anchor{43c6}
@deffn {Dato} inspect.CO_COROUTINE

El flag se configura cuando el objeto del código es una función de corutina. Cuando el objeto código se ejecuta, retorna un objeto de corutina. Ver 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} para más detalles.


Added in version 3.5.

@end deffn

@geindex CO_ITERABLE_COROUTINE (en el módulo inspect)
@anchor{library/inspect inspect CO_ITERABLE_COROUTINE}@anchor{43c7}
@deffn {Dato} inspect.CO_ITERABLE_COROUTINE

El flag se utiliza para transformar generadores en corutinas basadas en generadores.  Los objetos generadores con este flag pueden ser usados en la expresión @code{await}, y objetos de corutina @code{yield from}. Ver 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} para más detalles.


Added in version 3.5.

@end deffn

@geindex CO_ASYNC_GENERATOR (en el módulo inspect)
@anchor{library/inspect inspect CO_ASYNC_GENERATOR}@anchor{43c8}
@deffn {Dato} inspect.CO_ASYNC_GENERATOR

El flag se configura cuando el objeto del código es una función generadora asíncrona.  Cuando el objeto código se ejecuta, retorna un objeto generador asíncrono.  Ver 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} para más detalles.


Added in version 3.6.

@end deffn

@geindex CO_HAS_DOCSTRING (en el módulo inspect)
@anchor{library/inspect inspect CO_HAS_DOCSTRING}@anchor{43c9}
@deffn {Dato} inspect.CO_HAS_DOCSTRING

The flag is set when there is a docstring for the code object in
the source code. If set, it will be the first item in
@ref{15ad,,co_consts}.


Added in version 3.14.

@end deffn

@cartouche
@quotation Nota 
Los flags son específicos de CPython, y no pueden ser definidas en otras implementaciones de Python.  Además, los flags son un detalle de la implementación, y pueden ser eliminados o desaprobados en futuras versiones de Python. Se recomienda utilizar las APIs públicas del módulo @ref{7e,,inspect} para cualquier necesidad de introspección.
@end quotation
@end cartouche

@node Buffer flags,Interfaz de la línea de comando,Objetos de código Bit Flags,inspect — Inspect live objects
@anchor{library/inspect buffer-flags}@anchor{43ca}
@subsubsection Buffer flags


@geindex BufferFlags (clase en inspect)
@anchor{library/inspect inspect BufferFlags}@anchor{50b}
@deffn {Clase} inspect.BufferFlags

This is an @ref{22fd,,enum.IntFlag} that represents the flags that
can be passed to the @ref{50a,,__buffer__()} method of objects
implementing the @ref{48a,,buffer protocol}.

The meaning of the flags is explained at @ref{43cb,,Tipos de solicitud búfer}.

@geindex SIMPLE (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags SIMPLE}@anchor{43cc}
@deffn {Atributo} SIMPLE
@end deffn

@geindex WRITABLE (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags WRITABLE}@anchor{43cd}
@deffn {Atributo} WRITABLE
@end deffn

@geindex FORMAT (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FORMAT}@anchor{43ce}
@deffn {Atributo} FORMAT
@end deffn

@geindex ND (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags ND}@anchor{43cf}
@deffn {Atributo} ND
@end deffn

@geindex STRIDES (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDES}@anchor{43d0}
@deffn {Atributo} STRIDES
@end deffn

@geindex C_CONTIGUOUS (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags C_CONTIGUOUS}@anchor{43d1}
@deffn {Atributo} C_CONTIGUOUS
@end deffn

@geindex F_CONTIGUOUS (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags F_CONTIGUOUS}@anchor{43d2}
@deffn {Atributo} F_CONTIGUOUS
@end deffn

@geindex ANY_CONTIGUOUS (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags ANY_CONTIGUOUS}@anchor{43d3}
@deffn {Atributo} ANY_CONTIGUOUS
@end deffn

@geindex INDIRECT (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags INDIRECT}@anchor{43d4}
@deffn {Atributo} INDIRECT
@end deffn

@geindex CONTIG (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags CONTIG}@anchor{43d5}
@deffn {Atributo} CONTIG
@end deffn

@geindex CONTIG_RO (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags CONTIG_RO}@anchor{43d6}
@deffn {Atributo} CONTIG_RO
@end deffn

@geindex STRIDED (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDED}@anchor{43d7}
@deffn {Atributo} STRIDED
@end deffn

@geindex STRIDED_RO (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDED_RO}@anchor{43d8}
@deffn {Atributo} STRIDED_RO
@end deffn

@geindex RECORDS (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags RECORDS}@anchor{43d9}
@deffn {Atributo} RECORDS
@end deffn

@geindex RECORDS_RO (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags RECORDS_RO}@anchor{43da}
@deffn {Atributo} RECORDS_RO
@end deffn

@geindex FULL (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FULL}@anchor{43db}
@deffn {Atributo} FULL
@end deffn

@geindex FULL_RO (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FULL_RO}@anchor{43dc}
@deffn {Atributo} FULL_RO
@end deffn

@geindex READ (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags READ}@anchor{43dd}
@deffn {Atributo} READ
@end deffn

@geindex WRITE (atributo de inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags WRITE}@anchor{43de}
@deffn {Atributo} WRITE
@end deffn


Added in version 3.12.

@end deffn

@node Interfaz de la línea de comando,,Buffer flags,inspect — Inspect live objects
@anchor{library/inspect command-line-interface}@anchor{43df}@anchor{library/inspect inspect-module-cli}@anchor{fdb}
@subsubsection Interfaz de la línea de comando


El módulo @ref{7e,,inspect} también proporciona una capacidad básica de introspección desde la línea de comandos.

Por defecto, acepta el nombre de un módulo e imprime la fuente de ese módulo. Una clase o función dentro del módulo puede imprimirse en su lugar añadiendo dos puntos y el nombre calificado del objeto objetivo.

@geindex opción de línea de comando inspect; --details
@anchor{library/inspect cmdoption-inspect-details}@anchor{43e0}
@deffn {Option} @w{-}@w{-}details

Imprimir información sobre el objeto especificado en lugar del código fuente
@end deffn

@node annotationlib — Functionality for introspecting annotations,site — Site-specific configuration hook,inspect — Inspect live objects,Servicios en tiempo de ejecución de Python
@anchor{library/annotationlib doc}@anchor{43e1}@anchor{library/annotationlib annotationlib-functionality-for-introspecting-annotations}@anchor{43e2}@anchor{library/annotationlib module-annotationlib}@anchor{6}
@subsection @code{annotationlib} — Functionality for introspecting annotations


@geindex module; annotationlib

`Source code:' Lib/annotationlib.py@footnote{https://github.com/python/cpython/tree/main/Lib/annotationlib.py}

@c import annotationlib
@c from annotationlib import *


__________________________________________________________________


The @code{annotationlib} module provides tools for introspecting
@ref{140,,annotations} on modules, classes, and functions.

Annotations are @ref{503,,lazily evaluated} and often contain
forward references to objects that are not yet defined when the annotation
is created. This module provides a set of low-level tools that can be used to retrieve annotations in a reliable way, even
in the presence of forward references and other edge cases.

This module supports retrieving annotations in three main formats
(see @ref{182,,Format}), each of which works best for different use cases:


@itemize *

@item 
@ref{142,,VALUE} evaluates the annotations and returns their value.
This is most straightforward to work with, but it may raise errors,
for example if the annotations contain references to undefined names.

@item 
@ref{143,,FORWARDREF} returns @ref{15aa,,ForwardRef} objects
for annotations that cannot be resolved, allowing you to inspect the
annotations without evaluating them. This is useful when you need to
work with annotations that may contain unresolved forward references.

@item 
@ref{144,,STRING} returns the annotations as a string, similar
to how it would appear in the source file. This is useful for documentation
generators that want to display annotations in a readable way.
@end itemize

The @ref{147,,get_annotations()} function is the main entry point for
retrieving annotations. Given a function, class, or module, it returns
an annotations dictionary in the requested format. This module also provides
functionality for working directly with the @ref{141,,annotate function}
that is used to evaluate annotations, such as @ref{1f28,,get_annotate_function()}
and @ref{43e3,,call_annotate_function()}, as well as the
@ref{3eb2,,call_evaluate_function()} function for working with
@ref{3eb1,,evaluate functions}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} proposed the current model for how annotations work in Python.

@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} expanded on various aspects of 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} and introduced the
@code{annotationlib} module.

@ref{870,,Prácticas recomendadas para las anotaciones} provides best practices for working with
annotations.

typing-extensions@footnote{https://pypi.org/project/typing-extensions/} provides a backport of @ref{147,,get_annotations()}
that works on earlier versions of Python.


@menu
* Annotation semantics:: 
* Classes:: 
* Functions: Functions<2>. 

@end menu

@node Annotation semantics,Classes,,annotationlib — Functionality for introspecting annotations
@anchor{library/annotationlib annotation-semantics}@anchor{43e4}
@subsubsection Annotation semantics


The way annotations are evaluated has changed over the history of Python 3,
and currently still depends on a @ref{2f4,,future import}.
There have been execution models for annotations:


@itemize *

@item 
`Stock semantics' (default in Python 3.0 through 3.13; see 
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}
and 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}): Annotations are evaluated eagerly, as they are
encountered in the source code.

@item 
`Stringified annotations' (used with @code{from __future__ import annotations}
in Python 3.7 and newer; see 
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}): Annotations are stored as
strings only.

@item 
`Deferred evaluation' (default in Python 3.14 and newer; see 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} and
@geindex Python Enhancement Proposals; PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}): Annotations are evaluated lazily, only when they are accessed.
@end itemize

As an example, consider the following program:

@example
def func(a: Cls) -> None:
    print(a)

class Cls: pass

print(func.__annotations__)
@end example

This will behave as follows:


@itemize *

@item 
Under stock semantics (Python 3.13 and earlier), it will throw a
@ref{4ec,,NameError} at the line where @code{func} is defined,
because @code{Cls} is an undefined name at that point.

@item 
Under stringified annotations (if @code{from __future__ import annotations}
is used), it will print @code{@{'a': 'Cls', 'return': 'None'@}}.

@item 
Under deferred evaluation (Python 3.14 and later), it will print
@code{@{'a': <class 'Cls'>, 'return': None@}}.
@end itemize

Stock semantics were used when function annotations were first introduced
in Python 3.0 (by 
@geindex Python Enhancement Proposals; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}) because this was the simplest, most obvious
way to implement annotations. The same execution model was used when variable
annotations were introduced in Python 3.6 (by 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}). However,
stock semantics caused problems when using annotations as type hints,
such as a need to refer to names that are not yet defined when the
annotation is encountered. In addition, there were performance problems
with executing annotations at module import time. Therefore, in Python 3.7,
@geindex Python Enhancement Proposals; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} introduced the ability to store annotations as strings using the
@code{from __future__ import annotations} syntax. The plan at the time was to
eventually make this behavior the default, but a problem appeared:
stringified annotations are more difficult to process for those who
introspect annotations at runtime. An alternative proposal, 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/},
introduced the third execution model, deferred evaluation, and was implemented
in Python 3.14. Stringified annotations are still used if
@code{from __future__ import annotations} is present, but this behavior will
eventually be removed.

@node Classes,Functions<2>,Annotation semantics,annotationlib — Functionality for introspecting annotations
@anchor{library/annotationlib classes}@anchor{43e5}
@subsubsection Classes


@geindex Format (clase en annotationlib)
@anchor{library/annotationlib annotationlib Format}@anchor{182}
@deffn {Clase} annotationlib.Format

An @ref{d66,,IntEnum} describing the formats in which annotations
can be returned. Members of the enum, or their equivalent integer values,
can be passed to @ref{147,,get_annotations()} and other functions in this
module, as well as to @ref{161a,,__annotate__} functions.

@geindex VALUE (atributo de annotationlib.Format)
@anchor{library/annotationlib annotationlib Format VALUE}@anchor{142}
@deffn {Atributo} VALUE = 1

Values are the result of evaluating the annotation expressions.
@end deffn

@geindex FORWARDREF (atributo de annotationlib.Format)
@anchor{library/annotationlib annotationlib Format FORWARDREF}@anchor{143}
@deffn {Atributo} FORWARDREF = 2

Values are real annotation values (as per @ref{142,,Format.VALUE} format)
for defined values, and @ref{15aa,,ForwardRef} proxies for undefined
values. Real objects may contain references to, @ref{15aa,,ForwardRef}
proxy objects.
@end deffn

@geindex STRING (atributo de annotationlib.Format)
@anchor{library/annotationlib annotationlib Format STRING}@anchor{144}
@deffn {Atributo} STRING = 3

Values are the text string of the annotation as it appears in the
source code, up to modifications including, but not restricted to,
whitespace normalizations and constant values optimizations.

The exact values of these strings may change in future versions of Python.
@end deffn


Added in version 3.14.

@end deffn

@geindex ForwardRef (clase en annotationlib)
@anchor{library/annotationlib annotationlib ForwardRef}@anchor{15aa}
@deffn {Clase} annotationlib.ForwardRef

A proxy object for forward references in annotations.

Instances of this class are returned when the @ref{143,,FORWARDREF}
format is used and annotations contain a name that cannot be resolved.
This can happen when a forward reference is used in an annotation, such as
when a class is referenced before it is defined.

@geindex __forward_arg__ (atributo de annotationlib.ForwardRef)
@anchor{library/annotationlib annotationlib ForwardRef __forward_arg__}@anchor{43e6}
@deffn {Atributo} __forward_arg__

A string containing the code that was evaluated to produce the
@ref{15aa,,ForwardRef}. The string may not be exactly equivalent
to the original source.
@end deffn

@geindex evaluate() (método de annotationlib.ForwardRef)
@anchor{library/annotationlib annotationlib ForwardRef evaluate}@anchor{3ede}
@deffn {Método} evaluate (*, globals=None, locals=None, type_params=None, owner=None)

Evaluate the forward reference, returning its value.

This may throw an exception, such as @ref{4ec,,NameError}, if the forward
reference refers to names that do not exist. The arguments to this
method can be used to provide bindings for names that would otherwise
be undefined.

@ref{15aa,,ForwardRef} instances returned by @ref{147,,get_annotations()}
retain references to information about the scope they originated from,
so calling this method with no further arguments may be sufficient to
evaluate such objects. @ref{15aa,,ForwardRef} instances created by other
means may not have any information about their scope, so passing
arguments to this method may be necessary to evaluate them successfully.

`globals' and `locals' are passed to @ref{2eb,,eval()}, representing
the global and local namespaces in which the name is evaluated.
`type_params', if given, must be a tuple of
@ref{3fc,,type parameters} that are in scope while the forward
reference is being evaluated. `owner' is the object that owns the
annotation from which the forward reference derives, usually a function,
class, or module.

@cartouche
@quotation Importante 
Once a @ref{15aa,,ForwardRef} instance has been evaluated, it caches
the evaluated value, and future calls to @ref{3ede,,evaluate()} will return
the cached value, regardless of the parameters passed in.
@end quotation
@end cartouche
@end deffn


Added in version 3.14.

@end deffn

@node Functions<2>,,Classes,annotationlib — Functionality for introspecting annotations
@anchor{library/annotationlib functions}@anchor{43e7}
@subsubsection Functions


@geindex annotations_to_string() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib annotations_to_string}@anchor{43e8}
@deffn {Función} annotationlib.annotations_to_string (annotations)

Convert an annotations dict containing runtime values to a
dict containing only strings. If the values are not already strings,
they are converted using @ref{43e9,,value_to_string()}.
This is meant as a helper for user-provided
annotate functions that support the @ref{144,,STRING} format but
do not have access to the code creating the annotations.

For example, this is used to implement the @ref{144,,STRING} for
@ref{2ce,,typing.TypedDict} classes created through the functional syntax:

@example
>>> from typing import TypedDict
>>> Movie = TypedDict("movie", @{"name": str, "year": int@})
>>> get_annotations(Movie, format=Format.STRING)
@{'name': 'str', 'year': 'int'@}
@end example


Added in version 3.14.

@end deffn

@geindex call_annotate_function() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib call_annotate_function}@anchor{43e3}
@deffn {Función} annotationlib.call_annotate_function (annotate, format, *, owner=None)

Call the @ref{141,,annotate function} `annotate' with the given `format',
a member of the @ref{182,,Format} enum, and return the annotations
dictionary produced by the function.

This helper function is required because annotate functions generated by
the compiler for functions, classes, and modules only support
the @ref{142,,VALUE} format when called directly.
To support other formats, this function calls the annotate function
in a special environment that allows it to produce annotations in the
other formats. This is a useful building block when implementing
functionality that needs to partially evaluate annotations while a class
is being constructed.

`owner' is the object that owns the annotation function, usually
a function, class, or module. If provided, it is used in the
@ref{143,,FORWARDREF} format to produce a @ref{15aa,,ForwardRef}
object that carries more information.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 649#the-stringizer-and-the-fake-globals-environment
PEP 649@footnote{https://peps.python.org/pep-0649/#the-stringizer-and-the-fake-globals-environment}
contains an explanation of the implementation technique used by this
function.



Added in version 3.14.

@end deffn

@geindex call_evaluate_function() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib call_evaluate_function}@anchor{3eb2}
@deffn {Función} annotationlib.call_evaluate_function (evaluate, format, *, owner=None)

Call the @ref{3eb1,,evaluate function} `evaluate' with the given `format',
a member of the @ref{182,,Format} enum, and return the value produced by
the function. This is similar to @ref{43e3,,call_annotate_function()},
but the latter always returns a dictionary mapping strings to annotations,
while this function returns a single value.

This is intended for use with the evaluate functions generated for lazily
evaluated elements related to type aliases and type parameters:


@itemize *

@item 
@ref{3ec7,,typing.TypeAliasType.evaluate_value()}, the value of type aliases

@item 
@ref{3eb0,,typing.TypeVar.evaluate_bound()}, the bound of type variables

@item 
@ref{3eb4,,typing.TypeVar.evaluate_constraints()}, the constraints of
type variables

@item 
@ref{3eb6,,typing.TypeVar.evaluate_default()}, the default value of
type variables

@item 
@ref{3ec1,,typing.ParamSpec.evaluate_default()}, the default value of
parameter specifications

@item 
@ref{3eba,,typing.TypeVarTuple.evaluate_default()}, the default value of
type variable tuples
@end itemize

`owner' is the object that owns the evaluate function, such as the type
alias or type variable object.

`format' can be used to control the format in which the value is returned:

@example
>>> type Alias = undefined
>>> call_evaluate_function(Alias.evaluate_value, Format.VALUE)
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> call_evaluate_function(Alias.evaluate_value, Format.FORWARDREF)
ForwardRef('undefined')
>>> call_evaluate_function(Alias.evaluate_value, Format.STRING)
'undefined'
@end example


Added in version 3.14.

@end deffn

@geindex get_annotate_function() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib get_annotate_function}@anchor{1f28}
@deffn {Función} annotationlib.get_annotate_function (obj)

Retrieve the @ref{141,,annotate function} for `obj'. Return @code{None}
if `obj' does not have an annotate function.

This is usually equivalent to accessing the @ref{161a,,__annotate__}
attribute of `obj', but direct access to the attribute may return the wrong
object in certain situations involving metaclasses. This function should be
used instead of accessing the attribute directly.


Added in version 3.14.

@end deffn

@geindex get_annotations() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib get_annotations}@anchor{147}
@deffn {Función} annotationlib.get_annotations (obj, *, globals=None, locals=None, eval_str=False, format=Format.VALUE)

Compute the annotations dict for an object.

`obj' may be a callable, class, module, or other object with
@ref{161a,,__annotate__} and @ref{e08,,__annotations__} attributes.
Passing in an object of any other type raises @ref{228,,TypeError}.

The `format' parameter controls the format in which annotations are returned,
and must be a member of the @ref{182,,Format} enum or its integer equivalent.

Returns a dict. @code{get_annotations()} returns a new dict every time
it’s called; calling it twice on the same object will return two
different but equivalent dicts.

This function handles several details for you:


@itemize *

@item 
If `eval_str' is true, values of type @code{str} will
be un-stringized using @ref{2eb,,eval()}. This is intended
for use with stringized annotations
(@code{from __future__ import annotations}). It is an error
to set `eval_str' to true with formats other than @ref{142,,Format.VALUE}.

@item 
If `obj' doesn’t have an annotations dict, returns an
empty dict. (Functions and methods always have an
annotations dict; classes, modules, and other types of
callables may not.)

@item 
Ignores inherited annotations on classes, as well as annotations
on metaclasses. If a class
doesn’t have its own annotations dict, returns an empty dict.

@item 
All accesses to object members and dict values are done
using @code{getattr()} and @code{dict.get()} for safety.
@end itemize

`eval_str' controls whether or not values of type @code{str} are
replaced with the result of calling @ref{2eb,,eval()} on those values:


@itemize *

@item 
If eval_str is true, @ref{2eb,,eval()} is called on values of type
@code{str}. (Note that @code{get_annotations()} doesn’t catch
exceptions; if @ref{2eb,,eval()} raises an exception, it will unwind
the stack past the @code{get_annotations()} call.)

@item 
If `eval_str' is false (the default), values of type @code{str} are
unchanged.
@end itemize

`globals' and `locals' are passed in to @ref{2eb,,eval()}; see the documentation
for @ref{2eb,,eval()} for more information. If `globals' or `locals'
is @code{None}, this function may replace that value with a
context-specific default, contingent on @code{type(obj)}:


@itemize *

@item 
If `obj' is a module, `globals' defaults to @code{obj.__dict__}.

@item 
If `obj' is a class, `globals' defaults to
@code{sys.modules[obj.__module__].__dict__} and `locals' defaults
to the `obj' class namespace.

@item 
If `obj' is a callable, `globals' defaults to
@ref{133b,,obj.__globals__},
although if `obj' is a wrapped function (using
@ref{109e,,functools.update_wrapper()}) or a @ref{17a,,functools.partial} object,
it is unwrapped until a non-wrapped function is found.
@end itemize

Calling @code{get_annotations()} is best practice for accessing the
annotations dict of any object. See @ref{870,,Prácticas recomendadas para las anotaciones} for
more information on annotations best practices.

@example
>>> def f(a: int, b: str) -> float:
...     pass
>>> get_annotations(f)
@{'a': <class 'int'>, 'b': <class 'str'>, 'return': <class 'float'>@}
@end example


Added in version 3.14.

@end deffn

@geindex value_to_string() (en el módulo annotationlib)
@anchor{library/annotationlib annotationlib value_to_string}@anchor{43e9}
@deffn {Función} annotationlib.value_to_string (value)

Convert an arbitrary Python value to a format suitable for use by the
@ref{144,,STRING} format. This calls @ref{894,,repr()} for most
objects, but has special handling for some objects, such as type objects.

This is meant as a helper for user-provided
annotate functions that support the @ref{144,,STRING} format but
do not have access to the code creating the annotations. It can also
be used to provide a user-friendly string representation for other
objects that contain values that are commonly encountered in annotations.


Added in version 3.14.

@end deffn

@node site — Site-specific configuration hook,,annotationlib — Functionality for introspecting annotations,Servicios en tiempo de ejecución de Python
@anchor{library/site doc}@anchor{43ea}@anchor{library/site module-site}@anchor{c7}@anchor{library/site site-site-specific-configuration-hook}@anchor{43eb}
@subsection @code{site} — Site-specific configuration hook


@geindex module; site

`Código Fuente:' Lib/site.py@footnote{https://github.com/python/cpython/tree/main/Lib/site.py}


__________________________________________________________________


`Este módulo se importa automáticamente durante la inicialización.' La importación automática se puede suprimir utilizando la opción del intérprete opción @ref{1217,,-S} .

@geindex module;search;path

Importing this module normally appends site-specific paths to the module search path
and adds @ref{218f,,callables}, including @ref{96e,,help()} to the built-in
namespace. However, Python startup option @ref{1217,,-S} blocks this and this module
can be safely imported with no automatic modifications to the module search path
or additions to the builtins.  To explicitly trigger the usual site-specific
additions, call the @ref{1d3c,,main()} function.


Distinto en la versión 3.3: Importar el módulo utilizado para activar la manipulación de rutas incluso cuando se utiliza @ref{1217,,-S}.


@geindex site-packages;directory

It starts by constructing up to four directories from a head and a tail part.
For the head part, it uses @code{sys.prefix} and @code{sys.exec_prefix}; empty heads
are skipped.  For the tail part, it uses the empty string and then
@code{lib/site-packages} (on Windows) or
@code{lib/python`X.Y[t]'/site-packages} (on Unix and macOS). (The
optional suffix «t» indicates the @ref{43ec,,free threading} build, and is
appended if @code{"t"} is present in the @ref{af4,,sys.abiflags} constant.)
For each
of the distinct head-tail combinations, it sees if it refers to an existing
directory, and if so, adds it to @code{sys.path} and also inspects the newly
added path for configuration files.


Distinto en la versión 3.5: Se ha eliminado la compatibilidad con el directorio «site-python».



Distinto en la versión 3.13: On Unix, @ref{43ec,,Free threading} Python installations are
identified by the «t» suffix in the version-specific directory name, such as
@code{lib/python3.13t/}.


Si un archivo llamado «pyvenv.cfg» existe un directorio por encima de `sys.executable', `sys.prefix' y `sys.exec_prefix' se establecen en ese directorio y también se comprueba si hay paquetes de sitio (`sys.base_prefix' y `sys.base_exec_prefix' siempre serán los prefijos «reales» de la instalación de Python). Si «pyvenv.cfg» (un archivo de configuración de arranque) contiene la clave «include-system-site-packages» configurada con un valor diferente a «true» (no distingue entre mayúsculas y minúsculas), no se buscarán los prefijos de nivel de sistema para paquetes de sitio; de lo contrario lo harán.

@geindex # (hash);comment
@geindex statement;import

Un archivo de configuración de ruta es un archivo cuyo nombre tiene la forma @code{`name'.pth} y existe en uno de los cuatro directorios mencionados anteriormente; su contenido son elementos adicionales (uno por línea) que se agregarán a @code{sys.path}. Los elementos que no existen nunca se agregan a @code{sys.path} y no se comprueba que el elemento se refiera a un directorio en lugar de a un archivo. No se agrega ningún elemento a @code{sys.path} más de una vez. Se omiten las líneas en blanco y las que comienzan con @code{#}. Se ejecutan las líneas que comienzan con @code{import} (seguidas de un espacio o tabulación).

@cartouche
@quotation Nota 
Una línea ejecutable en un archivo @code{.pth} se ejecuta en cada inicio de Python, independientemente de si se va a utilizar un módulo en particular. Por tanto, su impacto debería reducirse al mínimo. El propósito principal de las líneas ejecutables es hacer que los módulos correspondientes se puedan importar (cargar ganchos de importación de terceros, ajustar 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}, etc.). Se supone que cualquier otra inicialización se debe realizar en la importación real de un módulo, siempre y cuando ocurra. Limitar un fragmento de código a una sola línea es una medida deliberada para desalentar la inclusión de algo más complejo aquí.
@end quotation
@end cartouche


Distinto en la versión 3.13: The @code{.pth} files are now decoded by UTF-8 at first and then by the
@ref{39b,,locale encoding} if it fails.


@geindex package
@geindex path;configuration;file

Por ejemplo, supongamos que @code{sys.prefix} y @code{sys.exec_prefix} están configurados en @code{/usr/local}. La biblioteca Python X.Y se instala en @code{/usr/local/lib/python`X.Y'}. Supongamos que tiene un subdirectorio @code{/usr/local/lib/python`X.Y'/site-packages} con tres subsubdirectorios, @code{foo}, @code{bar} y @code{spam}, y dos archivos de configuración de ruta, @code{foo.pth} y @code{bar.pth}. Suponga @code{foo.pth} contiene lo siguiente:

@example
# foo package configuration

foo
bar
bletch
@end example

y @code{bar.pth} contiene:

@example
# bar package configuration

bar
@end example

Luego, los siguientes directorios específicos de la versión se agregan a @code{sys.path}, en este orden:

@example
/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo
@end example

Tenga en cuenta que @code{bletch} se omite porque no existe; el directorio @code{bar} precede al directorio @code{foo} porque @code{bar.pth} viene alfabéticamente antes de @code{foo.pth}; y @code{spam} se omite porque no se menciona en ninguno de los archivos de configuración de ruta.

@menu
* sitecustomize:: 
* usercustomize:: 
* Configuración de Readline:: 
* Contenido del módulo: Contenido del módulo<4>. 
* Interfaz de línea de comando: Interfaz de línea de comando<2>. 

@end menu

@node sitecustomize,usercustomize,,site — Site-specific configuration hook
@anchor{library/site module-sitecustomize}@anchor{c8}@anchor{library/site sitecustomize}@anchor{43ed}
@subsubsection @code{sitecustomize}


@geindex module; sitecustomize

After these path manipulations, an attempt is made to import a module named
@ref{c8,,sitecustomize}, which can perform arbitrary site-specific customizations.
It is typically created by a system administrator in the site-packages
directory.  If this import fails with an @ref{4d7,,ImportError} or its subclass
exception, and the exception’s @ref{228c,,name}
attribute equals to @code{'sitecustomize'},
it is silently ignored.  If Python is started without output streams available, as
with @code{pythonw.exe} on Windows (which is used by default to start IDLE),
attempted output from @ref{c8,,sitecustomize} is ignored.  Any other exception
causes a silent and perhaps mysterious failure of the process.

@node usercustomize,Configuración de Readline,sitecustomize,site — Site-specific configuration hook
@anchor{library/site module-usercustomize}@anchor{10e}@anchor{library/site usercustomize}@anchor{43ee}
@subsubsection @code{usercustomize}


@geindex module; usercustomize

After this, an attempt is made to import a module named @ref{10e,,usercustomize},
which can perform arbitrary user-specific customizations, if
@ref{43ef,,ENABLE_USER_SITE} is true.  This file is intended to be created in the
user site-packages directory (see below), which is part of @code{sys.path} unless
disabled by @ref{13eb,,-s}.  If this import fails with an @ref{4d7,,ImportError} or
its subclass exception, and the exception’s @ref{228c,,name}
attribute equals to @code{'usercustomize'}, it is silently ignored.

Tenga en cuenta que para algunos sistemas que no son Unix, @code{sys.prefix} y @code{sys.exec_prefix} están vacíos y se omiten las manipulaciones de la ruta; sin embargo, se sigue intentando importar @ref{c8,,sitecustomize} y @ref{10e,,usercustomize}.

@node Configuración de Readline,Contenido del módulo<4>,usercustomize,site — Site-specific configuration hook
@anchor{library/site readline-configuration}@anchor{43f0}@anchor{library/site rlcompleter-config}@anchor{1048}
@subsubsection Configuración de `Readline'


En los sistemas que admiten @ref{ba,,readline}, este módulo también importará y configurará el módulo @ref{bd,,rlcompleter}, si Python se inicia en @ref{1045,,modo interactivo} y sin la opción @ref{1217,,-S}. El comportamiento predeterminado es habilitar la finalización de tabulación y usar @code{~/.python_history} como archivo de guardado del historial. Para deshabilitarlo, borre (o anule) el atributo @ref{1046,,sys.__interactivehook__} en su @ref{c8,,sitecustomize} o @ref{10e,,usercustomize} module o su archivo 
@geindex PYTHONSTARTUP
@geindex variables de entorno; PYTHONSTARTUP
@ref{1047,,PYTHONSTARTUP}.


Distinto en la versión 3.4: La activación de `rlcompleter' y el historial se hizo automática.


@node Contenido del módulo<4>,Interfaz de línea de comando<2>,Configuración de Readline,site — Site-specific configuration hook
@anchor{library/site module-contents}@anchor{43f1}
@subsubsection Contenido del módulo


@geindex PREFIXES (en el módulo site)
@anchor{library/site site PREFIXES}@anchor{43f2}
@deffn {Dato} site.PREFIXES

Una lista de prefijos para directorios de site-packages.
@end deffn

@geindex ENABLE_USER_SITE (en el módulo site)
@anchor{library/site site ENABLE_USER_SITE}@anchor{43ef}
@deffn {Dato} site.ENABLE_USER_SITE

Flag que muestra el estado del directorio site-packages del usuario. @code{True} significa que está habilitado y se agregó a @code{sys.path}. @code{False} significa que fue deshabilitado por solicitud del usuario (con @ref{13eb,,-s} o 
@geindex PYTHONNOUSERSITE
@geindex variables de entorno; PYTHONNOUSERSITE
@ref{13ec,,PYTHONNOUSERSITE}). @code{None} significa que fue deshabilitado por razones de seguridad (falta de coincidencia entre la identificación de usuario o grupo y la identificación efectiva) o por un administrador.
@end deffn

@geindex USER_SITE (en el módulo site)
@anchor{library/site site USER_SITE}@anchor{1d3b}
@deffn {Dato} site.USER_SITE

Path to the user site-packages for the running Python.  Can be @code{None} if
@ref{12ad,,getusersitepackages()} hasn’t been called yet.  Default value is
@code{~/.local/lib/python`X.Y'[t]/site-packages} for UNIX and non-framework
macOS builds, @code{~/Library/Python/`X.Y'/lib/python/site-packages} for macOS
framework builds, and @code{`%APPDATA%'\Python\Python`XY'\site-packages}
on Windows.  The optional «t» indicates the free-threaded build.  This
directory is a site directory, which means that @code{.pth} files in it
will be processed.
@end deffn

@geindex USER_BASE (en el módulo site)
@anchor{library/site site USER_BASE}@anchor{1384}
@deffn {Dato} site.USER_BASE

Path to the base directory for the user site-packages.  Can be @code{None} if
@ref{12ac,,getuserbase()} hasn’t been called yet.  Default value is
@code{~/.local} for UNIX and macOS non-framework builds,
@code{~/Library/Python/`X.Y'} for macOS framework builds, and
@code{`%APPDATA%'\Python} for Windows.  This value is used to
compute the installation directories for scripts, data files, Python modules,
etc. for the @ref{1d4d,,user installation scheme}.
See also 
@geindex PYTHONUSERBASE
@geindex variables de entorno; PYTHONUSERBASE
@ref{13ea,,PYTHONUSERBASE}.
@end deffn

@geindex main() (en el módulo site)
@anchor{library/site site main}@anchor{1d3c}
@deffn {Función} site.main ()

Agrega todos los directorios estándar específicos del sitio a la ruta de búsqueda del módulo. Esta función se llama automáticamente cuando se importa este módulo, a menos que el intérprete de Python se haya iniciado con la opción @ref{1217,,-S}.


Distinto en la versión 3.3: Esta función solía llamarse incondicionalmente.

@end deffn

@geindex addsitedir() (en el módulo site)
@anchor{library/site site addsitedir}@anchor{43f3}
@deffn {Función} site.addsitedir (sitedir, known_paths=None)

Agrega un directorio a sys.path y procesa sus archivos @code{.pth}. Típicamente utilizado en @ref{c8,,sitecustomize} o @ref{10e,,usercustomize} (ver arriba).
@end deffn

@geindex getsitepackages() (en el módulo site)
@anchor{library/site site getsitepackages}@anchor{12ab}
@deffn {Función} site.getsitepackages ()

Retorna una lista que contiene todos los directorios `site-packages' globales.


Added in version 3.2.

@end deffn

@geindex getuserbase() (en el módulo site)
@anchor{library/site site getuserbase}@anchor{12ac}
@deffn {Función} site.getuserbase ()

Retorna la ruta del directorio base del usuario @ref{1384,,USER_BASE}. Si  este aún no fue inicializado, esta función también lo configurará, respetando 
@geindex PYTHONUSERBASE
@geindex variables de entorno; PYTHONUSERBASE
@ref{13ea,,PYTHONUSERBASE}.


Added in version 3.2.

@end deffn

@geindex getusersitepackages() (en el módulo site)
@anchor{library/site site getusersitepackages}@anchor{12ad}
@deffn {Función} site.getusersitepackages ()

Retorna la ruta del directorio base del usuario @ref{1d3b,,USER_SITE}. Si  este aún no fue inicializado, esta función también lo configurará, respetando @ref{1384,,USER_BASE}. Para determinar si los paquetes específicos del sitio de usuario fueron añadidos a @code{sys.path} debe usarse @ref{43ef,,ENABLE_USER_SITE}.


Added in version 3.2.

@end deffn

@node Interfaz de línea de comando<2>,,Contenido del módulo<4>,site — Site-specific configuration hook
@anchor{library/site command-line-interface}@anchor{43f4}@anchor{library/site site-commandline}@anchor{43f5}
@subsubsection Interfaz de línea de comando


El módulo @ref{c7,,site} también proporciona una forma de obtener los directorios del usuario desde la línea de comandos:

@example
$ python -m site --user-site
/home/user/.local/lib/python3.11/site-packages
@end example

Si se llama sin argumentos, imprimirá el contenido de @ref{27e,,sys.path} en la salida estándar, seguido del valor de @ref{1384,,USER_BASE} y si el directorio existe, entonces lo mismo para @ref{1d3b,,USER_SITE}, y finalmente el valor de @ref{43ef,,ENABLE_USER_SITE}.

@geindex opción de línea de comando site; --user-base
@anchor{library/site cmdoption-site-user-base}@anchor{43f6}
@deffn {Option} @w{-}@w{-}user@w{-}base

Imprime la ruta al directorio base del usuario.
@end deffn

@geindex opción de línea de comando site; --user-site
@anchor{library/site cmdoption-site-user-site}@anchor{43f7}
@deffn {Option} @w{-}@w{-}user@w{-}site

Imprime la ruta al directorio `site-packages' del usuario.
@end deffn

Si se dan ambas opciones, la ruta del directorio base y la del directorio `site-packages' del usuario se imprimirán (siempre en este orden), separados por @ref{1d4a,,os.pathsep}.

Si se da alguna opción, el script saldrá con uno de estos valores: @code{0} si el directorio `site-packages' del usuario está habilitado, @code{1} si fue deshabilitado por el usuario, @code{2} si está deshabilitado por razones de seguridad o por un administrador, y un valor mayor que 2 si hay un error.


@subsubheading Ver también



@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} - Directorio `site-packages' de cada usuario

@item 
@ref{1c67,,La inicialización de la ruta de búsqueda de módulo de sys.path} – Inicialización de @ref{27e,,sys.path}.
@end itemize


@node Intérpretes de Python personalizados,Importando módulos,Servicios en tiempo de ejecución de Python,La biblioteca estándar de Python
@anchor{library/custominterp doc}@anchor{43f8}@anchor{library/custominterp custom-python-interpreters}@anchor{43f9}@anchor{library/custominterp custominterp}@anchor{43fa}
@section Intérpretes de Python personalizados


Los módulos descritos en este capítulo permiten escribir interfaces similares al intérprete interactivo de Python. Si desea un intérprete de Python que admita alguna característica especial además del lenguaje Python, debe mirar el módulo @ref{1b,,code}. (El módulo @ref{1d,,codeop} es de más bajo nivel y se utiliza para soportar la compilación de un fragmento posiblemente incompleto de código Python).

La lista completa de módulos descritos en este capítulo es:

@menu
* code — Interpreter base classes:: 
* codeop — Compile Python code:: 

@end menu

@node code — Interpreter base classes,codeop — Compile Python code,,Intérpretes de Python personalizados
@anchor{library/code doc}@anchor{43fb}@anchor{library/code code-interpreter-base-classes}@anchor{43fc}@anchor{library/code module-code}@anchor{1b}
@subsection @code{code} — Interpreter base classes


@geindex module; code

`Código fuente::' Lib/code.py@footnote{https://github.com/python/cpython/tree/main/Lib/code.py}


__________________________________________________________________


El módulo de @code{code} proporciona facilidades para implementar bucles de lectura-evaluación-impresión en Python. Se incluyen dos clases y funciones de conveniencia que se pueden usar para crear aplicaciones que brinden un `prompt' interactivo del intérprete.

@geindex InteractiveInterpreter (clase en code)
@anchor{library/code code InteractiveInterpreter}@anchor{15dc}
@deffn {Clase} code.InteractiveInterpreter (locals=None)

This class deals with parsing and interpreter state (the user’s namespace); it
does not deal with input buffering or prompting or input file naming (the
filename is always passed in explicitly). The optional `locals' argument
specifies a mapping to use as the namespace in which code will be executed;
it defaults to a newly created dictionary with key @code{'__name__'} set to
@code{'__console__'} and key @code{'__doc__'} set to @code{None}.
@end deffn

@geindex InteractiveConsole (clase en code)
@anchor{library/code code InteractiveConsole}@anchor{239e}
@deffn {Clase} code.InteractiveConsole (locals=None, filename='<console>', local_exit=False)

Closely emulate the behavior of the interactive Python interpreter. This class
builds on @ref{15dc,,InteractiveInterpreter} and adds prompting using the familiar
@code{sys.ps1} and @code{sys.ps2}, and input buffering. If `local_exit' is true,
@code{exit()} and @code{quit()} in the console will not raise @ref{dc7,,SystemExit}, but
instead return to the calling code.


Distinto en la versión 3.13: Added `local_exit' parameter.

@end deffn

@geindex interact() (en el módulo code)
@anchor{library/code code interact}@anchor{16de}
@deffn {Función} code.interact (banner=None, readfunc=None, local=None, exitmsg=None, local_exit=False)

Convenience function to run a read-eval-print loop.  This creates a new
instance of @ref{239e,,InteractiveConsole} and sets `readfunc' to be used as
the @ref{43fd,,InteractiveConsole.raw_input()} method, if provided.  If `local' is
provided, it is passed to the @ref{239e,,InteractiveConsole} constructor for
use as the default namespace for the interpreter loop.  If `local_exit' is provided,
it is passed to the @ref{239e,,InteractiveConsole} constructor.  The @ref{43fe,,interact()}
method of the instance is then run with `banner' and `exitmsg' passed as the
banner and exit message to use, if provided.  The console object is discarded
after use.


Distinto en la versión 3.6: Se agregó el parámetro `exitmsg'.



Distinto en la versión 3.13: Added `local_exit' parameter.

@end deffn

@geindex compile_command() (en el módulo code)
@anchor{library/code code compile_command}@anchor{43ff}
@deffn {Función} code.compile_command (source, filename='<input>', symbol='single')

Esta función es útil para programas que desean emular el bucle principal del intérprete de Python (también conocido como bucle `read-eval-print'). La parte complicada es determinar cuándo el usuario ha ingresado un comando incompleto que se puede completar ingresando más texto (en lugar de un comando completo o un error de sintaxis). Esta función `casi' siempre toma la misma decisión que el bucle principal del intérprete real.

`source' es la cadena de caracteres fuente; `filename' es el nombre de archivo opcional desde el que se leyó la fuente, por defecto es @code{'<input>'}; y `symbol' es el símbolo de inicio gramatical opcional, que debería ser @code{'single'} (el predeterminado), @code{'eval'} o @code{'exec'}.

Retorna un objeto de código (lo mismo que @code{compile(source, filename, symbol)}) si el comando está completo y es válido; @code{None} si el comando está incompleto; lanza @ref{150,,SyntaxError} si el comando está completo y contiene un error de sintaxis, o lanza @ref{919,,OverflowError} o @ref{360,,ValueError} si el comando contiene un literal no válido.
@end deffn

@menu
* Objetos de intérprete interactivo:: 
* Objetos de consola interactiva:: 

@end menu

@node Objetos de intérprete interactivo,Objetos de consola interactiva,,code — Interpreter base classes
@anchor{library/code interactive-interpreter-objects}@anchor{4400}@anchor{library/code interpreter-objects}@anchor{4401}
@subsubsection Objetos de intérprete interactivo


@geindex runsource() (método de code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter runsource}@anchor{4402}
@deffn {Método} InteractiveInterpreter.runsource (source, filename='<input>', symbol='single')

Compila y ejecuta alguna fuente en el intérprete. Los argumentos son los mismos que para @ref{43ff,,compile_command()}; el valor predeterminado para `filename' es @code{'<input>'}, y para `symbol' es @code{'single'}. Puede suceder una de varias cosas:


@itemize *

@item 
La entrada es incorrecta; @ref{43ff,,compile_command()} generó una excepción (@ref{150,,SyntaxError} o @ref{919,,OverflowError}). Se imprime un seguimiento de sintaxis llamando al método @ref{4403,,showsyntaxerror()}. @ref{4402,,runsource()} retorna @code{False}.

@item 
La entrada está incompleta y se requiere más información; @ref{43ff,,compile_command()} retorna @code{None}. @ref{4402,,runsource()} retorna @code{True}.

@item 
La entrada está completa; @ref{43ff,,compile_command()} retornó un objeto de código. El código se ejecuta llamando a @ref{4404,,runcode()} (que también maneja excepciones en tiempo de ejecución, excepto @ref{dc7,,SystemExit}). @ref{4402,,runsource()} retorna @code{False}.
@end itemize

El valor de retorno se puede usar para decidir si usar @code{sys.ps1} o @code{sys.ps2} para solicitar la siguiente línea.
@end deffn

@geindex runcode() (método de code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter runcode}@anchor{4404}
@deffn {Método} InteractiveInterpreter.runcode (code)

Ejecuta un objeto de código. Cuando ocurre una excepción, se llama a @ref{e55,,showtraceback()} para mostrar un seguimiento del código. Se capturan todas las excepciones excepto @ref{dc7,,SystemExit}, que puede propagarse.

Una nota sobre @ref{a63,,KeyboardInterrupt}: esta excepción puede ocurrir en otra parte de este código y no siempre se detecta. Quien llama la función debe estar preparado para manejar esto.
@end deffn

@geindex showsyntaxerror() (método de code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter showsyntaxerror}@anchor{4403}
@deffn {Método} InteractiveInterpreter.showsyntaxerror (filename=None)

Muestra el error de sintaxis que acaba de ocurrir. Esto no muestra la traza de seguimiento porque no la hay para errores de sintaxis. Si se proporciona `filename', se incluirá en la excepción en lugar del nombre de archivo predeterminado proporcionado por el analizador de Python, ya que siempre usa @code{'<string>'} cuando lee de una cadena de caracteres. La salida se escribe mediante el método @ref{4405,,write()}.
@end deffn

@geindex showtraceback() (método de code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter showtraceback}@anchor{e55}
@deffn {Método} InteractiveInterpreter.showtraceback ()

Muestra la excepción que acaba de ocurrir. Eliminamos el primer elemento de la pila porque está dentro de la implementación del intérprete. La salida se escribe mediante el método @ref{4405,,write()}.


Distinto en la versión 3.5: Se muestra la traza de seguimiento encadenada completa en lugar de solo la traza primaria de pila.

@end deffn

@geindex write() (método de code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter write}@anchor{4405}
@deffn {Método} InteractiveInterpreter.write (data)

Escribe una cadena de caracteres en el flujo de error estándar (@code{sys.stderr}). Las clases derivadas deben reemplazar esto para proporcionar el manejo de salida apropiado según sea necesario.
@end deffn

@node Objetos de consola interactiva,,Objetos de intérprete interactivo,code — Interpreter base classes
@anchor{library/code console-objects}@anchor{4406}@anchor{library/code interactive-console-objects}@anchor{4407}
@subsubsection Objetos de consola interactiva


La clase @ref{239e,,InteractiveConsole} es una subclase de @ref{15dc,,InteractiveInterpreter}, por lo que ofrece todos los métodos de los objetos del intérprete, así como las siguientes adiciones.

@geindex interact() (método de code.InteractiveConsole)
@anchor{library/code code InteractiveConsole interact}@anchor{43fe}
@deffn {Método} InteractiveConsole.interact (banner=None, exitmsg=None)

Emula estrictamente la consola interactiva de Python. El argumento opcional `banner' especifica la bandera a imprimir antes de la primera interacción; de forma predeterminada, imprime una bandera similar al impreso por el intérprete estándar de Python, seguido del nombre de clase del objeto de la consola entre paréntesis (para no confundir esto con el intérprete real, ¡ya que está muy cerca!)

El argumento opcional `exitmsg' especifica un mensaje de salida que se imprime al salir. Pase la cadena de caracteres vacía para suprimir el mensaje de salida. Si no se proporciona `exitmsg' o es @code{None}, se imprime el mensaje predeterminado.


Distinto en la versión 3.4: Para suprimir la impresión de cualquier bandera, pase una cadena de caracteres vacía.



Distinto en la versión 3.6: Imprime un mensaje de salida al salir.

@end deffn

@geindex push() (método de code.InteractiveConsole)
@anchor{library/code code InteractiveConsole push}@anchor{4408}
@deffn {Método} InteractiveConsole.push (line)

Envía una línea de texto fuente al intérprete. La línea no debe tener un salto de línea al final; puede tener nuevas líneas internas. La línea se agrega a un búfer y se llama al método @ref{4402,,runsource()} del intérprete con el contenido concatenado del búfer y la nueva fuente. Si indica que el comando se ejecutó o no es válido, el búfer se restablece; de lo contrario, el comando está incompleto y el búfer se deja como estaba después de agregar la línea. Si se requieren más entradas el valor de retorno es @code{True}, @code{False} si la línea se procesó de alguna manera (esto es lo mismo que @code{runsource()}).
@end deffn

@geindex resetbuffer() (método de code.InteractiveConsole)
@anchor{library/code code InteractiveConsole resetbuffer}@anchor{4409}
@deffn {Método} InteractiveConsole.resetbuffer ()

Elimina cualquier texto fuente no gestionado del búfer de entrada.
@end deffn

@geindex raw_input() (método de code.InteractiveConsole)
@anchor{library/code code InteractiveConsole raw_input}@anchor{43fd}
@deffn {Método} InteractiveConsole.raw_input (prompt='@w{'})

Escribe un `prompt' y lee una línea. La línea retornada no incluye el salto de línea final. Cuando el usuario ingresa la secuencia de teclas EOF, se lanza @code{OFError}. La implementación base lee de @code{sys.stdin}; una subclase puede reemplazar esto con una implementación diferente.
@end deffn

@node codeop — Compile Python code,,code — Interpreter base classes,Intérpretes de Python personalizados
@anchor{library/codeop doc}@anchor{440a}@anchor{library/codeop codeop-compile-python-code}@anchor{440b}@anchor{library/codeop module-codeop}@anchor{1d}
@subsection @code{codeop} — Compile Python code


@geindex module; codeop

`Código fuente:' Lib/codeop.py@footnote{https://github.com/python/cpython/tree/main/Lib/codeop.py}


__________________________________________________________________


El módulo @ref{1d,,codeop} proporciona herramientas para emular el bucle principal del intérprete de Python (también conocido como read-eval-print), tal como se hace en el módulo @ref{1b,,code}.  Por lo tanto, este módulo no está diseñado para utilizarlo directamente; si desea incluir un ciclo de este tipo en su programa, probablemente es mejor utilizar el módulo @ref{1b,,code} en su lugar.

Esta actividad consta de dos partes:


@enumerate 

@item 
Being able to tell if a line of input completes a Python statement: in
short, telling whether to print “@code{>>>}” or “@code{...}” next.

@item 
Remembering which future statements the user has entered, so subsequent
input can be compiled with these in effect.
@end enumerate

El módulo @ref{1d,,codeop} proporciona formas de realizar estas dos partes, tanto de forma independiente, como en conjunto.

Para hacer lo anterior:

@geindex compile_command() (en el módulo codeop)
@anchor{library/codeop codeop compile_command}@anchor{17d0}
@deffn {Función} codeop.compile_command (source, filename='<input>', symbol='single')

Tries to compile `source', which should be a string of Python code and return a
code object if `source' is valid Python code.  In that case, the filename
attribute of the code object will be `filename', which defaults to
@code{'<input>'}.  Returns @code{None} if `source' is `not' valid Python code, but is a
prefix of valid Python code.

Si hay un problema con `source', se lanzará una excepción. @ref{150,,SyntaxError} se lanza si hay una sintaxis de Python no válida, y @ref{919,,OverflowError} o @ref{360,,ValueError} si hay un literal no válido.

The `symbol' argument determines whether `source' is compiled as a statement
(@code{'single'}, the default), as a sequence of @ref{2777,,statement} (@code{'exec'}) or
as an @ref{1f85,,expression} (@code{'eval'}).  Any other value will
cause @ref{360,,ValueError} to be raised.

@cartouche
@quotation Nota 
Es posible (pero no probable) que el analizador deje de analizar con un resultado exitoso antes de llegar al final de la fuente; en este caso, los símbolos finales pueden ignorarse en lugar de provocar un error. Por ejemplo, una barra invertida seguida de dos nuevas líneas puede ir seguida de basura arbitraria. Esto se solucionará una vez que la API para el analizador sea mejor.
@end quotation
@end cartouche
@end deffn

@geindex Compile (clase en codeop)
@anchor{library/codeop codeop Compile}@anchor{440c}
@deffn {Clase} codeop.Compile

Instances of this class have @ref{5fb,,__call__()} methods identical in signature to
the built-in function @ref{2fb,,compile()}, but with the difference that if the
instance compiles program text containing a @ref{0,,__future__} statement, the
instance “remembers” and compiles all subsequent program texts with the
statement in force.
@end deffn

@geindex CommandCompiler (clase en codeop)
@anchor{library/codeop codeop CommandCompiler}@anchor{440d}
@deffn {Clase} codeop.CommandCompiler

Instances of this class have @ref{5fb,,__call__()} methods identical in signature to
@ref{17d0,,compile_command()}; the difference is that if the instance compiles program
text containing a @ref{0,,__future__} statement, the instance “remembers” and
compiles all subsequent program texts with the statement in force.
@end deffn

@node Importando módulos,Servicios del lenguaje Python,Intérpretes de Python personalizados,La biblioteca estándar de Python
@anchor{library/modules doc}@anchor{440e}@anchor{library/modules importing-modules}@anchor{440f}@anchor{library/modules modules}@anchor{4410}
@section Importando módulos


Los módulos descritos en este capítulo proporcionan nuevas formas de importar otros módulos de Python y ganchos para personalizar los procesos de importación.

La lista completa de módulos descritos en este capítulo es:

@menu
* zipimport — Import modules from Zip archives:: 
* pkgutil — Package extension utility:: 
* modulefinder — Find modules used by a script:: 
* runpy — Locating and executing Python modules:: 
* importlib — La implementación de import:: 
* importlib.resources – Package resource reading@comma{} opening and access: importlib resources – Package resource reading opening and access. 
* importlib.resources.abc – Abstract base classes for resources: importlib resources abc – Abstract base classes for resources. 
* importlib.metadata – Acceso a los metadatos de los paquetes: importlib metadata – Acceso a los metadatos de los paquetes. 
* La inicialización de la ruta de búsqueda de módulo de sys.path: La inicialización de la ruta de búsqueda de módulo de sys path. 

@end menu

@node zipimport — Import modules from Zip archives,pkgutil — Package extension utility,,Importando módulos
@anchor{library/zipimport doc}@anchor{4411}@anchor{library/zipimport module-zipimport}@anchor{131}@anchor{library/zipimport zipimport-import-modules-from-zip-archives}@anchor{4412}
@subsection @code{zipimport} — Import modules from Zip archives


@geindex module; zipimport

`Código fuente:' Lib/zipimport.py@footnote{https://github.com/python/cpython/tree/main/Lib/zipimport.py}


__________________________________________________________________


Este módulo añade la capacidad de importar módulos de Python (@code{*.py}, @code{*.pyc}) y paquetes de archivos de formato ZIP. Por lo general, no es necesario utilizar el módulo @ref{131,,zipimport} explícitamente; se utiliza automáticamente por el mecanismo incorporado @ref{682,,import} para los ítems @ref{27e,,sys.path} que son rutas a archivos ZIP.

Típicamente @ref{27e,,sys.path} es una lista de cadenas con nombres de directorios. Este módulo también permite a un elemento de  @ref{27e,,sys.path} ser una cadena con la que se nombre a un archivo ZIP. El archivo ZIP puede contener una estructura de subdirectorios para soportar la importación de paquetes, y una ruta dentro del archivo puede ser especificada para únicamente importar desde un subdirectorio. Por ejemplo, la ruta  @code{example.zip/lib/} sólo importaría desde el subdirectorio @code{lib/} dentro del archivo.

Cualquier archivo puede estar presente en el archivo ZIP, pero los importadores solo son invocados para archivos @code{.py} y @code{.pyc}. La importación ZIP de módulos dinámicos (@code{.pyd}, @code{.so}) no está permitida. Cabe señalar que si un archivo ZIP contiene solamente archivos @code{.py}, Python no intentará modificar el archivo agregando los correspondientes archivos @code{.pyc}, esto quiere decir que si un archivo ZIP no contiene archivos @code{.pyc} la importación puede ser algo lenta.


Distinto en la versión 3.13: ZIP64 is supported



Distinto en la versión 3.8: Anteriormente, los archivos ZIP con un comentario de archivo no eran compatibles.



@subsubheading Ver también



@table @asis

@item PKZIP Nota de aplicación@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

Documentación sobre el formato de archivo ZIP por Phil Katz, el creador del formato y algoritmos utilizados.

@geindex Python Enhancement Proposals; PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - Importar módulos de archivos Zip

Escrito por James C. Ahlstrom, quien también proporcionó una implementación. Python 2.3 sigue la especificación en PEP 273, pero utiliza una implementación escrita por Just van Rossum que utiliza los ganchos importados descritos en PEP 302.

@item @ref{77,,importlib} - La implementación de la maquinaria de importación

El paquete proporciona los protocolos relevantes para que los implementen todos los importadores.
@end table


Este módulo define una excepción:

@geindex ZipImportError
@anchor{library/zipimport zipimport ZipImportError}@anchor{4413}
@deffn {Excepción} zipimport.ZipImportError

Excepción lanzada por objetos zipimporter. Es una subclase de @ref{4d7,,ImportError}, por lo que también puede ser capturada como @ref{4d7,,ImportError}.
@end deffn

@menu
* Objetos zipimporter:: 
* Ejemplos: Ejemplos<31>. 

@end menu

@node Objetos zipimporter,Ejemplos<31>,,zipimport — Import modules from Zip archives
@anchor{library/zipimport id1}@anchor{4414}@anchor{library/zipimport zipimporter-objects}@anchor{4415}
@subsubsection Objetos zipimporter


@ref{4416,,zipimporter} es la clase para importar archivos ZIP.

@geindex zipimporter (clase en zipimport)
@anchor{library/zipimport zipimport zipimporter}@anchor{4416}
@deffn {Clase} zipimport.zipimporter (archivepath)

Crea una nueva instancia zipimporter. `archivepath' debe ser una ruta a un archivo ZIP, o a una ruta específica dentro de un archivo ZIP. Por ejemplo, un `archivepath' de @code{foo/bar.zip/lib} buscará módulos en el directorio @code{lib} dentro del archivo ZIP @code{foo/bar.zip} (siempre que exista).

@ref{4413,,ZipImportError} es lanzada si `archivepath' no apunta a un archivo ZIP válido.


Distinto en la versión 3.12: Los métodos @code{find_loader()} y @code{find_module()}, deprecados en la versión 3.10, han sido eliminados.  Use en su lugar @ref{8f5,,find_spec()}.


@geindex create_module() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter create_module}@anchor{8f6}
@deffn {Método} create_module (spec)

Implementación de @ref{d37,,importlib.abc.Loader.create_module()} que retorna @ref{716,,None} para solicitar explícitamente la semántica predeterminada.


Added in version 3.10.

@end deffn

@geindex exec_module() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter exec_module}@anchor{20d}
@deffn {Método} exec_module (module)

Implementación de @ref{901,,importlib.abc.Loader.exec_module()}.


Added in version 3.10.

@end deffn

@geindex find_spec() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter find_spec}@anchor{8f5}
@deffn {Método} find_spec (fullname, target=None)

Una implementación de @ref{903,,importlib.abc.PathEntryFinder.find_spec()}.


Added in version 3.10.

@end deffn

@geindex get_code() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_code}@anchor{4417}
@deffn {Método} get_code (fullname)

Retorna el objeto de código para el módulo especificado. Lanza @ref{4413,,ZipImportError} si el módulo no se pudo importar.
@end deffn

@geindex get_data() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_data}@anchor{4418}
@deffn {Método} get_data (pathname)

Retorna los datos asociados con `pathname'. Lanza @ref{4d5,,OSError} si el archivo no fue encontrado.


Distinto en la versión 3.3: @ref{10ce,,IOError} used to be raised, it is now an alias of @ref{4d5,,OSError}.

@end deffn

@geindex get_filename() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_filename}@anchor{4419}
@deffn {Método} get_filename (fullname)

Retorna el valor que se le habría asignado a @code{__file__} si el módulo especificado fue importado. Lanza @ref{4413,,ZipImportError} si el módulo no se pudo importar.


Added in version 3.1.

@end deffn

@geindex get_source() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_source}@anchor{441a}
@deffn {Método} get_source (fullname)

Retorna el código fuente para el módulo especificado. Lanza @ref{4413,,ZipImportError} si el módulo no pudo ser encontrado, retorna @ref{716,,None} si el archivo contiene al módulo, pero no tiene fuente para ello.
@end deffn

@geindex is_package() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter is_package}@anchor{441b}
@deffn {Método} is_package (fullname)

Retorna @code{True} si el módulo especificado por `fullname' es un paquete. Lanza @ref{4413,,ZipImportError} si el módulo no pudo ser encontrado.
@end deffn

@geindex load_module() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter load_module}@anchor{20c}
@deffn {Método} load_module (fullname)

Carga el módulo especificado por `fullname'. `fullname' debe ser el nombre completo de módulo (punteado). Retorna el módulo importado, o lanza @ref{4413,,ZipImportError} si no fue encontrado.


Obsoleto desde la versión 3.10: Utilizar en su lugar @ref{20d,,exec_module()}.

@end deffn

@geindex invalidate_caches() (método de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter invalidate_caches}@anchor{8f7}
@deffn {Método} invalidate_caches ()

Limpia la caché interna de información sobre los archivos que se encuentran dentro del archivo ZIP.


Added in version 3.10.

@end deffn

@geindex archive (atributo de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter archive}@anchor{441c}
@deffn {Atributo} archive

El nombre de archivo del archivo ZIP asociado del importador, sin una posible sub-ruta.
@end deffn

@geindex prefix (atributo de zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter prefix}@anchor{441d}
@deffn {Atributo} prefix

La sub-ruta dentro del archivo ZIP donde se buscan los módulos. Esta es la cadena vacía para objetos zipimporter la cual apunta a la raíz del archivo ZIP.
@end deffn

Los atributos @ref{441c,,archive} y @ref{441d,,prefix}, cuando son combinados con una barra diagonal, son iguales al argumento original `archivepath' dado al constructor @ref{4416,,zipimporter}.
@end deffn

@node Ejemplos<31>,,Objetos zipimporter,zipimport — Import modules from Zip archives
@anchor{library/zipimport examples}@anchor{441e}@anchor{library/zipimport zipimport-examples}@anchor{441f}
@subsubsection Ejemplos


Este es un ejemplo que importa un módulo de un archivo ZIP - tenga en cuenta que el módulo @ref{131,,zipimport} no está usado explícitamente.

@example
$ unzip -l example.zip
Archive:  example.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  11-26-02 22:30   jwzthreading.py
 --------                   -------
     8467                   1 file
$ ./python
Python 2.3 (#1, Aug 1 2003, 19:54:32)
>>> import sys
>>> sys.path.insert(0, 'example.zip')  # Add .zip file to front of path
>>> import jwzthreading
>>> jwzthreading.__file__
'example.zip/jwzthreading.py'
@end example

@node pkgutil — Package extension utility,modulefinder — Find modules used by a script,zipimport — Import modules from Zip archives,Importando módulos
@anchor{library/pkgutil doc}@anchor{4420}@anchor{library/pkgutil module-pkgutil}@anchor{a9}@anchor{library/pkgutil pkgutil-package-extension-utility}@anchor{4421}
@subsection @code{pkgutil} — Package extension utility


@geindex module; pkgutil

`Código fuente:' Lib/pkgutil.py@footnote{https://github.com/python/cpython/tree/main/Lib/pkgutil.py}


__________________________________________________________________


Este módulo proporciona utilidades para el sistema de importación, en particular soporte para paquetes.

@geindex ModuleInfo (clase en pkgutil)
@anchor{library/pkgutil pkgutil ModuleInfo}@anchor{dd2}
@deffn {Clase} pkgutil.ModuleInfo (module_finder, name, ispkg)

Una tupla nombrada que contiene un breve resumen de la información del módulo.


Added in version 3.6.

@end deffn

@geindex extend_path() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil extend_path}@anchor{15b9}
@deffn {Función} pkgutil.extend_path (path, name)

Extiende la ruta de búsqueda de los módulos que componen un paquete. El uso previsto es colocar el siguiente código en @code{__init__.py}: de un paquete:

@example
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
@end example

For each directory on @ref{27e,,sys.path} that has a subdirectory that matches the
package name, add the subdirectory to the package’s
@ref{1c74,,__path__}. This is useful
if one wants to distribute different parts of a single logical package as multiple
directories.

It also looks for @code{*.pkg} files beginning where @code{*} matches the
`name' argument.  This feature is similar to @code{*.pth} files (see the
@ref{c7,,site} module for more information), except that it doesn’t special-case
lines starting with @code{import}.  A @code{*.pkg} file is trusted at face
value: apart from skipping blank lines and ignoring comments, all entries
found in a @code{*.pkg} file are added to the path, regardless of whether
they exist on the filesystem (this is a feature).

Si la ruta de entrada no es una lista (como es el caso de los paquetes congelados), se retorna sin cambios. La ruta de entrada no se modifica; se retorna una copia ampliada. Los elementos solo se adjuntan a la copia al final.

Se supone que @ref{27e,,sys.path} es una secuencia. Los elementos de @ref{27e,,sys.path} que no sean cadenas de caracteres que se refieran a directorios existentes se ignoran. Los elementos Unicode en @ref{27e,,sys.path} que causan errores cuando se utilizan como nombres de archivo pueden hacer que esta función lance una excepción (en línea con el comportamiento de @ref{aa2,,os.path.isdir()}).
@end deffn

@geindex get_importer() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil get_importer}@anchor{4422}
@deffn {Función} pkgutil.get_importer (path_item)

Recupera un @ref{1f1c,,finder} para el `path_item'.

El buscador retornado se almacena en caché en @ref{684,,sys.path_importer_cache} si fue creado recientemente por un enlace de ruta.

La caché (o parte de ella) puede ser borrada manualmente si el escaneo de @ref{10a0,,sys.path_hooks} es necesario.


Distinto en la versión 3.3: Actualizado para basarse directamente en @ref{77,,importlib} en lugar de depender del paquete interno 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} emulación de importación.

@end deffn

@geindex iter_importers() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil iter_importers}@anchor{1209}
@deffn {Función} pkgutil.iter_importers (fullname='@w{'})

Cede (`yield') objetos @ref{1f1c,,finder} para el nombre de módulo dado.

If fullname contains a @code{'.'}, the finders will be for the package
containing fullname, otherwise they will be all registered top level
finders (i.e. those on both @ref{db2,,sys.meta_path} and @ref{10a0,,sys.path_hooks}).

Si el módulo nombrado está en un paquete, ese paquete se importa como un efecto secundario de invocar esta función.

Si no se especifica ningún nombre de módulo, se generan todos los buscadores de nivel superior.


Distinto en la versión 3.3: Actualizado para basarse directamente en @ref{77,,importlib} en lugar de depender del paquete interno 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} emulación de importación.

@end deffn

@geindex iter_modules() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil iter_modules}@anchor{dd1}
@deffn {Función} pkgutil.iter_modules (path=None, prefix='@w{'})

Yields @ref{dd2,,ModuleInfo} for all submodules on `path', or, if
`path' is @code{None}, all top-level modules on @ref{27e,,sys.path}.

`path' tendría que ser @code{None} o una list de rutas en las que buscar módulos.

`prefix' es una cadena para mostrar delante de cada nombre de módulo en la salida.

@cartouche
@quotation Nota 
Sólo funciona para un @ref{1f1c,,finder} que define un método @code{iter_modules()}. Esta interfaz no es estándar, por lo que el módulo también proporciona implementaciones para @ref{10ee,,importlib.machinery.FileFinder} y @ref{4416,,zipimport.zipimporter}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Actualizado para basarse directamente en @ref{77,,importlib} en lugar de depender del paquete interno 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} emulación de importación.

@end deffn

@geindex walk_packages() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil walk_packages}@anchor{c87}
@deffn {Función} pkgutil.walk_packages (path=None, prefix='@w{'}, onerror=None)

Cede (`yield') @ref{dd2,,ModuleInfo} para todos los módulos de forma recursiva en `path', o, si `path' es @code{None}, todos los módulos accesibles.

`path' tendría que ser @code{None} o una list de rutas en las que buscar módulos.

`prefix' es una cadena para mostrar delante de cada nombre de módulo en la salida.

Note que esta función debe importar todos los `packages' (¡`no' todos los módulos!) en el `path' especificado, para acceder al atributo @code{__path__} para encontrar submódulos.

`onerror' es una función que se llama con un argumento (el nombre del paquete que se estaba importando) si se produce alguna excepción al intentar importar un paquete. Si no se proporciona ninguna función `onerror', los @ref{4d7,,ImportError} se capturan e ignoran, mientras que todas las demás excepciones se propagan, terminando la búsqueda.

Ejemplos:

@example
# list all modules python can access
walk_packages()

# list all submodules of ctypes
walk_packages(ctypes.__path__, ctypes.__name__ + '.')
@end example

@cartouche
@quotation Nota 
Sólo funciona para un @ref{1f1c,,finder} que define un método @code{iter_modules()}. Esta interfaz no es estándar, por lo que el módulo también proporciona implementaciones para @ref{10ee,,importlib.machinery.FileFinder} y @ref{4416,,zipimport.zipimporter}.
@end quotation
@end cartouche


Distinto en la versión 3.3: Actualizado para basarse directamente en @ref{77,,importlib} en lugar de depender del paquete interno 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} emulación de importación.

@end deffn

@geindex get_data() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil get_data}@anchor{4423}
@deffn {Función} pkgutil.get_data (package, resource)

Obtiene un recurso de un paquete.

Esto es un contenedor para la API @ref{16b8,,loader} @ref{4424,,get_data}. El argumento `package' debe ser el nombre de un paquete, en formato de módulo estándar (@code{foo.bar}).El argumento `resource' debe tener la forma de un nombre de archivo relativo, utilizando @code{/} como separador de ruta.El nombre del directorio principal @code{..} no está permitido, ni tampoco un nombre raíz (empezando por @code{/}).

La función retorna una cadena de caracteres binaria que es el contenido del recurso especificado.

Para los paquetes ubicados en el sistema de archivos, que ya se han importado, este es el equivalente aproximado de:

@example
d = os.path.dirname(sys.modules[package].__file__)
data = open(os.path.join(d, resource), 'rb').read()
@end example

Si el paquete no puede ser localizado o cargado, o usa un @ref{16b8,,loader} el cuál no soporta @ref{4424,,get_data}, entonces retorna @code{None}. En particular, el: término @ref{16b8,,loader} para @ref{1b8,,namespace packages} no soporta @ref{4424,,get_data}.
@end deffn

@geindex resolve_name() (en el módulo pkgutil)
@anchor{library/pkgutil pkgutil resolve_name}@anchor{4425}
@deffn {Función} pkgutil.resolve_name (name)

Resuelve un nombre a un objeto.

Esta funcionalidad es usada en numerosos lugares en la librería estándar (ver bpo-12915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12915}) - y existe funcionalidad equivalente también en librerías de terceros ampliamente usadas, tales como setuptools, Django y Pyramid.

Se espera que `name' sea una cadena de caracteres en uno de los siguientes formatos, donde W representa un identificador de Python válido, y un punto representa literalmente un punto en las siguientes pseudo-expresiones regulares:


@itemize *

@item 
@code{W(.W)*}

@item 
@code{W(.W)*:(W(.W)*)?}
@end itemize

La primera forma existe sólo para mantener compatibilidad con versiones anteriores. Asume que parte del nombre con puntos es un paquete, y el resto es un objeto en algún lugar dentro de ese paquete, posiblemente anidado dentro de otros objetos. Dado que el lugar donde el paquete termina y la jerarquía de objetos comienza no puede ser inferida por inspección, con esta forma se debe realizar repetidos intentos de importación.

En la segunda forma, el usuario hace claro el punto de división al proveer un signo de dos puntos: el nombre con puntos a la izquierda de los dos puntos es el paquete a ser importado, y el nombre con puntos a la derecha es la jerarquía de nombres dentro de ese paquete. Sólo una importación se necesaria con esta forma. Si termina con dos puntos, entonces se retorna un objeto módulo.

La función retornará un objeto (el cual puede ser un módulo), o lanzará una de las siguientes excepciones:

@ref{360,,ValueError} – si `name' no tiene un formato reconocido.

@ref{4d7,,ImportError} – si una importación falló cuando no lo debería haber hecho.

@ref{441,,AttributeError} – Si un fallo ocurrió mientras se atravesaba la jerarquía de objetos dentro del paquete importado para obtener el objeto deseado.


Added in version 3.9.

@end deffn

@node modulefinder — Find modules used by a script,runpy — Locating and executing Python modules,pkgutil — Package extension utility,Importando módulos
@anchor{library/modulefinder doc}@anchor{4426}@anchor{library/modulefinder module-modulefinder}@anchor{91}@anchor{library/modulefinder modulefinder-find-modules-used-by-a-script}@anchor{4427}
@subsection @code{modulefinder} — Find modules used by a script


@geindex module; modulefinder

`Código fuente:' Lib/modulefinder.py@footnote{https://github.com/python/cpython/tree/main/Lib/modulefinder.py}


__________________________________________________________________


Este módulo provee una clase @ref{1a0b,,ModuleFinder} que puede ser usada para determinar el conjunto de módulos importados en un script. @code{modulefinder.py} puede también ejecutarse como un script, dando el nombre de un archivo de Python como argumento, tras lo cual se imprimirá un reporte de los módulos importados.

@geindex AddPackagePath() (en el módulo modulefinder)
@anchor{library/modulefinder modulefinder AddPackagePath}@anchor{4428}
@deffn {Función} modulefinder.AddPackagePath (pkg_name, path)

Registra que el paquete llamado `pkg_name' pueda ser encontrado en el `path' especificado.
@end deffn

@geindex ReplacePackage() (en el módulo modulefinder)
@anchor{library/modulefinder modulefinder ReplacePackage}@anchor{4429}
@deffn {Función} modulefinder.ReplacePackage (oldname, newname)

Permite especificar que el módulo llamado `oldname' es de hecho el paquete llamado `newname'.
@end deffn

@geindex ModuleFinder (clase en modulefinder)
@anchor{library/modulefinder modulefinder ModuleFinder}@anchor{1a0b}
@deffn {Clase} modulefinder.ModuleFinder (path=None, debug=0, excludes=[], replace_paths=[])

Esta clase provee los métodos @ref{442a,,run_script()} y @ref{442b,,report()} que determinan el conjunto de módulos importados por un script. `path' puede ser un listado de directorios a buscar por módulos; si no es especificado, se usará @code{sys.path}. `debug' define el nivel de depuración; valores más altos hacen que la clase imprima mensajes de depuración acerca de lo que está haciendo. `excludes' es una lista de nombres de módulos que serán excluidos del análisis. `replace_paths' es una lista de tuplas @code{(oldpath, newpath)} que serán remplazadas en las rutas de los módulos.

@geindex report() (método de modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder report}@anchor{442b}
@deffn {Método} report ()

Imprime un reporte a la salida estándar que lista los módulos importados por el script y sus rutas, así como los módulos que faltan o parecieran faltar.
@end deffn

@geindex run_script() (método de modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder run_script}@anchor{442a}
@deffn {Método} run_script (pathname)

Analiza los contenidos del archivo `pathname', que debe contener código Python.
@end deffn

@geindex modules (atributo de modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder modules}@anchor{442c}
@deffn {Atributo} modules

Un diccionario que mapea los nombres de los módulos a los módulos. Vea @ref{442d,,Ejemplo de uso de ModuleFinder}.
@end deffn
@end deffn

@menu
* Ejemplo de uso de ModuleFinder:: 

@end menu

@node Ejemplo de uso de ModuleFinder,,,modulefinder — Find modules used by a script
@anchor{library/modulefinder example-usage-of-modulefinder}@anchor{442e}@anchor{library/modulefinder modulefinder-example}@anchor{442d}
@subsubsection Ejemplo de uso de @code{ModuleFinder}


El script que será analizado más adelante (bacon.py):

@example
import re, itertools

try:
    import baconhameggs
except ImportError:
    pass

try:
    import guido.python.ham
except ImportError:
    pass
@end example

El script que generará el reporte de bacon.py:

@example
from modulefinder import ModuleFinder

finder = ModuleFinder()
finder.run_script('bacon.py')

print('Loaded modules:')
for name, mod in finder.modules.items():
    print('%s: ' % name, end='@w{'})
    print(','.join(list(mod.globalnames.keys())[:3]))

print('-'*50)
print('Modules not imported:')
print('\n'.join(finder.badmodules.keys()))
@end example

Resultado de ejemplo (puede variar dependiendo de la arquitectura):

@example
Loaded modules:
_types:
copyreg:  _inverted_registry,_slotnames,__all__
re._compiler:  isstring,_sre,_optimize_unicode
_sre:
re._constants:  REPEAT_ONE,makedict,AT_END_LINE
sys:
re:  __module__,finditer,_expand
itertools:
__main__:  re,itertools,baconhameggs
re._parser:  _PATTERNENDERS,SRE_FLAG_UNICODE
array:
types:  __module__,IntType,TypeType
---------------------------------------------------
Modules not imported:
guido.python.ham
baconhameggs
@end example

@node runpy — Locating and executing Python modules,importlib — La implementación de import,modulefinder — Find modules used by a script,Importando módulos
@anchor{library/runpy doc}@anchor{442f}@anchor{library/runpy module-runpy}@anchor{be}@anchor{library/runpy runpy-locating-and-executing-python-modules}@anchor{4430}
@subsection @code{runpy} — Locating and executing Python modules


@geindex module; runpy

`Código Fuente:' Lib/runpy.py@footnote{https://github.com/python/cpython/tree/main/Lib/runpy.py}


__________________________________________________________________


El modulo @ref{be,,runpy} es usado para localizar y correr módulos Python sin importarlo primero. Su uso principal es implementar la opción @ref{187,,-m} cambiando la línea de comando que permite que los scripts se ubiquen utilizando el espacio de nombres del módulo de Python en lugar del sistema de archivos.

Tenga en cuenta que este `no' es un módulo de espacio aislado - todo el código es ejecutado en el proceso actual, y cualquier efecto secundario (como las importaciones en cache de otros módulos) permanecerán en su lugar después de que las funciones hayan retornado.

Además, no se garantiza que las funciones y clases definidas por el código ejecutado funcionen correctamente después de que se haya devuelto la función @ref{be,,runpy}. Si esa limitación no es aceptable para un caso de uso determinado, es probable que @ref{77,,importlib} sea una opción más adecuada que este módulo.

El modulo @ref{be,,runpy} proporciona dos funciones:

@geindex run_module() (en el módulo runpy)
@anchor{library/runpy runpy run_module}@anchor{1813}
@deffn {Función} runpy.run_module (mod_name, init_globals=None, run_name=None, alter_sys=False)

@geindex module;__main__

Execute the code of the specified module and return the resulting module’s
globals dictionary. The module’s code is first located using the standard
import mechanism (refer to 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} for details) and then executed in a
fresh module namespace.

El argumento `mod_name' debe ser un nombre de módulo absoluto. Si el nombre del módulo se refiere a un paquete en lugar de a un módulo normal, entonces ese paquete se importa y el submódulo @ref{1,,__main__} dentro de ese paquete se ejecuta y se devuelve el diccionario de globales del módulo resultante.

The optional dictionary argument `init_globals' may be used to pre-populate
the module’s globals dictionary before the code is executed.
`init_globals' will not be modified. If any of the special global variables
below are defined in `init_globals', those definitions are
overridden by @ref{1813,,run_module()}.

The special global variables @code{__name__}, @code{__spec__}, @code{__file__},
@code{__cached__}, @code{__loader__} and @code{__package__} are set in the globals
dictionary before the module code is executed. (Note that this is a
minimal set of variables - other variables may be set implicitly as an
interpreter implementation detail.)

@code{__name__} se establece en `run_name' si el argumento opcional no es @ref{716,,None}, para @code{mod_name + ‘.__main__’} si módulo nombrado es un paquete y al argumento `mod_name' en caso contrario.

@code{__spec__} will be set appropriately for the `actually' imported
module (that is, @code{__spec__.name} will always be `mod_name' or
@code{mod_name + '.__main__'}, never `run_name').

@code{__file__}, @code{__cached__}, @code{__loader__} y @code{__package__} son @ref{1f13,,establecidos de forma normal}  basados en la especificación del módulo.

Si el argumento `alter_sys' es proporcionado y evaluado a @ref{c95,,True}, entonces @code{sys.argv[0]} es actualizado y el valor de @code{__file__} y @code{sys.modules[__name__]} es actualizado con un objeto de módulo temporal para el módulo que se esta ejecutado. Ambas @code{sys.argv[0]} y @code{sys.modules[__name__]} son restauradas a sus valores originales antes del retorno de la función.

Tenga en cuenta que esta manipulación de @ref{d9,,sys} no es segura para los hilos. Otros hilos pueden ver el módulo parcialmente inicializado, así como la lista de argumentos alterada. Se recomienda no utilizar el módulo @code{sys} cuando se invoque a esta función desde código con hilos.


@subsubheading Ver también


La opción @ref{187,,-m} ofrece una funcionalidad equivalente desde la línea de comandos.



Distinto en la versión 3.1: Se agrego la capacidad de ejecutar paquetes buscando un submódulo @ref{1,,__main__}.



Distinto en la versión 3.2: Se agrego la variable global @code{__cached__} (consultar 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}).



Distinto en la versión 3.4: Se ha actualizado para aprovechar la función de especificación de módulos añadida por 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}. Esto permite que @code{__cached__} se establezca correctamente para que los módulos se ejecuten de esta manera, así como asegurar que el nombre real del módulo siempre sea accesible como @code{__spec__.name}.



Distinto en la versión 3.12: El establecimiento de @code{__cached__}, @code{__loader__}, y @code{__package__} están obsoletos. Véase @ref{1e69,,ModuleSpec} para alternativas.

@end deffn

@geindex run_path() (en el módulo runpy)
@anchor{library/runpy runpy run_path}@anchor{2ec}
@deffn {Función} runpy.run_path (path_name, init_globals=None, run_name=None)

@geindex module;__main__

Execute the code at the named filesystem location and return the resulting
module’s globals dictionary. As with a script name supplied to the CPython
command line, `file_path' may refer to a Python source file, a
compiled bytecode file or a valid @ref{27e,,sys.path} entry containing a
@ref{1,,__main__} module
(e.g. a zipfile containing a top-level @code{__main__.py} file).

Para un script simple, el código especificado simplemente se ejecuta en un espacio de nombres de módulo nuevo. Para una entrada @ref{27e,,sys.path} válida (normalmente un archivo zip o directorio), la entrada se añade primero al principio de @code{sys.path}. A continuación, la función busca y ejecuta un módulo @ref{1,,__main__} utilizando la ruta actualizada. Tenga en cuenta que no hay ninguna protección especial contra la invocación de una entrada @code{__main__} existente ubicada en otro lugar de @code{sys.path} si no existe tal módulo en la ubicación especificada.

The optional dictionary argument `init_globals' may be used to pre-populate
the module’s globals dictionary before the code is executed.
`init_globals' will not be modified. If any of the special global variables
below are defined in `init_globals', those definitions are
overridden by @ref{2ec,,run_path()}.

The special global variables @code{__name__}, @code{__spec__}, @code{__file__},
@code{__cached__}, @code{__loader__} and @code{__package__} are set in the globals
dictionary before the module code is executed. (Note that this is a
minimal set of variables - other variables may be set implicitly as an
interpreter implementation detail.)

@code{__name__} se establece para `run_name' si el argumento opcional no es @ref{716,,None} y a @code{'<run_path>'} de lo contrario.

If `file_path' directly references a script file (whether as source
or as precompiled byte code), then @code{__file__} will be set to
`file_path', and @code{__spec__}, @code{__cached__}, @code{__loader__} and
@code{__package__} will all be set to @ref{716,,None}.

If `file_path' is a reference to a valid @ref{27e,,sys.path} entry, then
@code{__spec__} will be set appropriately for the imported @ref{1,,__main__}
module (that is, @code{__spec__.name} will always be @code{__main__}).
@code{__file__}, @code{__cached__}, @code{__loader__} and @code{__package__} will be
@ref{1f13,,set as normal} based on the module spec.

A number of alterations are also made to the @ref{d9,,sys} module. Firstly,
@ref{27e,,sys.path} may be altered as described above. @code{sys.argv[0]} is updated
with the value of `file_path' and @code{sys.modules[__name__]} is updated
with a temporary module object for the module being executed. All
modifications to items in @ref{d9,,sys} are reverted before the function
returns.

Tenga en cuenta que, a diferencia de @ref{1813,,run_module()}, las alteraciones realizadas en @ref{d9,,sys} no son opcionales en esta función, ya que estos ajustes son esenciales para permitir la ejecución de las entradas de @ref{27e,,sys.path}. Como las limitaciones de seguridad de hilos aún se aplican, el uso de esta función en código con hilos debe ser serializado con el bloqueo de importación o delegado a un proceso separado.


@subsubheading Ver también


@ref{1d2f,,Opciones de interfaz} para una funcionalidad equivalente en la línea de comandos (@code{python path/to/script}).



Added in version 3.2.



Distinto en la versión 3.4: Se ha actualizado para aprovechar la función de especificación de módulos añadida por 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}. Esto permite que @code{__cached__} se establezca correctamente en el caso de que @code{__main__} se importe desde una entrada @ref{27e,,sys.path} válida en lugar de ejecutarse directamente.



Distinto en la versión 3.12: El establecimiento de @code{__cached__}, @code{__loader__} y @code{__package__} están en desuso.

@end deffn


@subsubheading Ver también



@table @asis

@geindex Python Enhancement Proposals; PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} – Ejecutando módulos como scripts

PEP escrito e implementado por Nick Coghlan.

@geindex Python Enhancement Proposals; PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/} – Importaciones relativas explícitas del módulo principal

PEP escrito e implementado por Nick Coghlan.

@geindex Python Enhancement Proposals; PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/} — Un tipo ModuleSpec para el sistema de Importación

PEP escrito e implementado por Eric Snow
@end table

@ref{19c8,,Línea de comandos y entorno} - Detalles de la línea de comandos CPython

La función @ref{5bc,,importlib.import_module()}


@node importlib — La implementación de import,importlib resources – Package resource reading opening and access,runpy — Locating and executing Python modules,Importando módulos
@anchor{library/importlib doc}@anchor{4431}@anchor{library/importlib importlib-the-implementation-of-import}@anchor{4432}@anchor{library/importlib module-importlib}@anchor{77}
@subsection @code{importlib} — La implementación de @code{import}


@geindex module; importlib


Added in version 3.1.


`Código fuente:' Lib/importlib/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/__init__.py}


__________________________________________________________________


@menu
* Introducción: Introducción<10>. 
* Funciones: Funciones<10>. 
* importlib.abc – Clases base abstractas relacionadas con la importación: importlib abc – Clases base abstractas relacionadas con la importación. 
* importlib.machinery – Importadores y enlaces de ruta: importlib machinery – Importadores y enlaces de ruta. 
* importlib.util – Código de utilidad para importadores: importlib util – Código de utilidad para importadores. 
* Ejemplos: Ejemplos<32>. 

@end menu

@node Introducción<10>,Funciones<10>,,importlib — La implementación de import
@anchor{library/importlib introduction}@anchor{4433}
@subsubsection Introducción


El propósito del paquete @ref{77,,importlib} es triple:

Uno es proveer la implementación de la declaración de @ref{682,,import} (y así, por extensión, el método @ref{96b,,__import__()} ) en el código fuente de Python. Esto provee una implementación de la @code{import} la cual es compatible con cualquier intérprete de Python. También provee una implementación que es más fácil de comprender que una implementada en un lenguajes que no es Python.

Dos, los componentes incluidos para implementar @ref{682,,import}  están expuestos en este paquete para que sea más fácil para los usuarios crear sus propios objetos (conocidos de forma genérica como @ref{1ff5,,importer}) para participar en el proceso de importación.

Tres, el paquete contiene módulos exponiendo funcionalidad adicional para administrar aspectos de paquetes de Python:


@itemize *

@item 
@ref{7a,,importlib.metadata} presenta acceso a metadatos de distribuciones de terceros.

@item 
@ref{7b,,importlib.resources} provee rutinas para acceder a `recursos' que no son código de paquetes de Python.
@end itemize


@subsubheading Ver también



@table @asis

@item @ref{682,,La declaración import}

La referencia en el lenguaje para la declaración de @ref{682,,import}.

@item Especificaciones de paquetes@footnote{https://www.python.org/doc/essays/packages/}

Especificaciones originales de los paquetes. Algunas semánticas han cambiado desde que este documento fue escrito (ejemplo, redirección de acuerdo a @code{None} en @ref{1976,,sys.modules}).

@item La función @ref{10e9,,__import__()}

La declaración de @ref{682,,import} es una decoración sintáctica para esta función.

@item @ref{1c67,,La inicialización de la ruta de búsqueda de módulo de sys.path}

La inicialización de @ref{27e,,sys.path}.

@geindex Python Enhancement Proposals; PEP 235

@item PEP 235@footnote{https://peps.python.org/pep-0235/}

Importar en sistemas que no distinguen entre mayúsculas y minúsculas

@geindex Python Enhancement Proposals; PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/}

Definiendo las codificaciones del código fuente de Python

@geindex Python Enhancement Proposals; PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/}

Nuevos ganchos de importación

@geindex Python Enhancement Proposals; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/}

Importaciones: Multilíneas, y absolutos/relativos

@geindex Python Enhancement Proposals; PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/}

Importaciones relativas, explicitas, del módulo principal

@geindex Python Enhancement Proposals; PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/}

Paquetes implícitos en el espacio de nombres

@geindex Python Enhancement Proposals; PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/}

Un tipo de ModuleSpec para el sistema de importación

@geindex Python Enhancement Proposals; PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/}

Eliminación de archivos PYO

@geindex Python Enhancement Proposals; PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/}

Inicialización de extensión de módulo en múltiples fases

@geindex Python Enhancement Proposals; PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/}

Pycs determinísticos

@geindex Python Enhancement Proposals; PEP 3120

@item PEP 3120@footnote{https://peps.python.org/pep-3120/}

Usando UTF-8 como la codificación fuente por defecto

@geindex Python Enhancement Proposals; PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/}

Repositorio de directorios PYC
@end table


@node Funciones<10>,importlib abc – Clases base abstractas relacionadas con la importación,Introducción<10>,importlib — La implementación de import
@anchor{library/importlib functions}@anchor{4434}
@subsubsection Funciones


@geindex __import__() (en el módulo importlib)
@anchor{library/importlib importlib __import__}@anchor{10e9}
@deffn {Función} importlib.__import__ (name, globals=None, locals=None, fromlist=(), level=0)

Una implementación de la función @ref{96b,,__import__()} incorporada.

@cartouche
@quotation Nota 
La importación programática los módulos debe usar @ref{5bc,,import_module()} en lugar de esta función.
@end quotation
@end cartouche
@end deffn

@geindex import_module() (en el módulo importlib)
@anchor{library/importlib importlib import_module}@anchor{5bc}
@deffn {Función} importlib.import_module (name, package=None)

Importar un módulo. El argumento llamado `name' especifica qué módulo importar en términos absolutos o relativos (ejemplo, puede ser @code{pkg.mod} o @code{..mod}). Si el nombre fuera especificado en términos relativos, entonces el argumento llamado `package' debe ser igual al nombre del paquete que será el ancla para resolver el nombre del paquete (ejemplo @code{import_module('..mod', 'pkg.subpkg')} importará @code{pkg.mod}).

La función @ref{5bc,,import_module()} actúa como un envoltorio simplificador alrededor de @ref{10e9,,importlib.__import__()}.  Esto quiere decir que las semánticas de la función son derivadas de @ref{10e9,,importlib.__import__()}. La diferencia más importante entre las dos funciones es que @ref{5bc,,import_module()} retorna el paquete especificado o el módulo (ejemplo @code{pkg.mod}), mientras que @ref{96b,,__import__()} retorna el paquete o módulo del nivel superior (ejemplo @code{pkg}).

Si está importando dinámicamente un módulo que se creó desde que el intérprete comenzó la ejecución (por ejemplo, creó un archivo fuente de Python), es posible que deba llamar a @ref{c98,,invalidate_caches()} para que el nuevo módulo sea detectado por el sistema de importación.


Distinto en la versión 3.3: Paquetes padres son importados automáticamente.

@end deffn

@geindex invalidate_caches() (en el módulo importlib)
@anchor{library/importlib importlib invalidate_caches}@anchor{c98}
@deffn {Función} importlib.invalidate_caches ()

Invalide los cache internos de ubicadores encontrados en @ref{db2,,sys.meta_path}.Si un buscador implementa @code{invalidate_caches()} entonces será llamado para realizar la invalidación.Esta función debe ser llamada si cualquier módulo ha sido creado/instalado mientras tu programa esta siendo ejecutado para garantizar que todos los buscadores noten la existencia del nuevo módulo.


Added in version 3.3.



Distinto en la versión 3.10: Paquetes de espacio de nombres creados/instalados en una ubicación @ref{27e,,sys.path} distinta después de que el mismo espacio de nombres fue importado son notados.

@end deffn

@geindex reload() (en el módulo importlib)
@anchor{library/importlib importlib reload}@anchor{5bd}
@deffn {Función} importlib.reload (module)

Recarga un `modulo' previamente importado. El argumento debe ser un objeto módulo, por lo que debe haber sido importado exitosamente. Esto es útil cuando has editado el código fuente de un archivo usando un editor externo y deseas probar la nueva versión sin abandonar el interprete de Python. El valor retornado es el objeto módulo (que puede ser diferente si la reimportación crea un nuevo objeto en @ref{1976,,sys.modules}).

Cuando @ref{5bd,,reload()} es ejecutada:


@itemize *

@item 
El código de un módulo de Python es recompilado y el código del módulo reejecutado, definiendo un nuevo conjunto de objetos que son asignados a los nombres de los módulos en el diccionario, reusando el @ref{16b8,,loader} que originalmente carga los módulos. El método @code{init} de los módulos de extension no es llamado de nuevo.

@item 
Al igual que con todos los demás objetos en Python, los objetos antiguos solo se recuperan después de que sus recuentos de referencias caen a cero.

@item 
Los nombres en el espacio de nombres del módulo se actualizan para señalar cualquier objeto nuevo o modificado.

@item 
Otras referencias a los objetos antiguos (como los nombres externos al módulo) no se vuelven a vincular para hacer referencia a los nuevos objetos y deben actualizarse en cada espacio de nombres donde se produzcan si se desea.
@end itemize

Hay una serie de otras advertencias:

Cuando se vuelve a cargar un módulo, se conserva su diccionario (que contiene las variables globales del módulo). Las redefiniciones de nombres anularán las antiguas definiciones, por lo que generalmente esto no es un problema. Si la nueva versión de un módulo no define un nombre que fue definido por la versión anterior, la definición anterior permanece. Esta característica se puede utilizar en beneficio del módulo si mantiene una tabla global o caché de objetos — con una declaración @ref{789,,try} puede probar la presencia de la tabla y omitir su inicialización si lo desea:

@example
try:
    cache
except NameError:
    cache = @{@}
@end example

Por lo general, no es muy útil recargar módulos integrados o cargados dinámicamente. No se recomienda recargar @ref{d9,,sys}, @ref{1,,__main__}, @ref{13,,builtins} y otros módulos clave. En muchos casos, los módulos de extensión no están diseñados para inicializarse más de una vez y pueden fallar de manera arbitraria cuando se vuelven a cargar.

Si un módulo importa objetos de otro módulo usando @ref{1317,,from} … @ref{682,,import} …, al llamar a @ref{5bd,,reload()} para el otro módulo no redefine los objetos importados de él — una forma de evitar esto es volver a ejecutar la instrucción @code{from}, otra es usar @code{import} y nombres calificados (`module.name') en su lugar.

Si un módulo crea instancias de una clase, volver a cargar el módulo que define la clase no afecta las definiciones de método de las instancias — continúan usando la definición de clase anterior. Lo mismo ocurre con las clases derivadas.


Added in version 3.4.



Distinto en la versión 3.7: @ref{bcf,,ModuleNotFoundError} se lanza cuando el módulo que se está recargando carece de @ref{1e69,,ModuleSpec}.

@end deffn

@node importlib abc – Clases base abstractas relacionadas con la importación,importlib machinery – Importadores y enlaces de ruta,Funciones<10>,importlib — La implementación de import
@anchor{library/importlib importlib-abc-abstract-base-classes-related-to-import}@anchor{4435}@anchor{library/importlib module-importlib abc}@anchor{78}
@subsubsection @code{importlib.abc} – Clases base abstractas relacionadas con la importación


@geindex module; importlib.abc

`Código fuente:' Lib/importlib/abc.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/abc.py}


__________________________________________________________________


El módulo @ref{78,,importlib.abc} contiene todas las clases base abstractas principales utilizadas por @ref{682,,import}. También se proporcionan algunas subclases de las clases base abstractas centrales para ayudar a implementar los ABC centrales.

Jerarquía ABC:

@example
object
 +-- MetaPathFinder
 +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader
@end example

@geindex MetaPathFinder (clase en importlib.abc)
@anchor{library/importlib importlib abc MetaPathFinder}@anchor{905}
@deffn {Clase} importlib.abc.MetaPathFinder

Una clase base abstracta que representa @ref{10ec,,meta path finder}.


Added in version 3.3.



Distinto en la versión 3.10: No longer a subclass of @code{Finder}.


@geindex find_spec() (método de importlib.abc.MetaPathFinder)
@anchor{library/importlib importlib abc MetaPathFinder find_spec}@anchor{8ff}
@deffn {Método} find_spec (fullname, path, target=None)

An abstract method for finding a @ref{1f15,,spec} for
the specified module.  If this is a top-level import, `path' will
be @code{None}.  Otherwise, this is a search for a subpackage or
module and `path' will be the value of @ref{1c74,,__path__} from the
parent package. If a spec cannot be found, @code{None} is returned.
When passed in, @code{target} is a module object that the finder may
use to make a more educated guess about what spec to return.
@ref{904,,importlib.util.spec_from_loader()} may be useful for implementing
concrete @code{MetaPathFinders}.


Added in version 3.4.

@end deffn

@geindex invalidate_caches() (método de importlib.abc.MetaPathFinder)
@anchor{library/importlib importlib abc MetaPathFinder invalidate_caches}@anchor{4436}
@deffn {Método} invalidate_caches ()

Un método opcional que, cuando se llama, debería invalidar cualquier caché interno utilizado por el buscador. Utilizado por @ref{c98,,importlib.invalidate_caches()} al invalidar los cachés de todos los buscadores en @ref{db2,,sys.meta_path}.


Distinto en la versión 3.4: Returns @code{None} when called instead of @ref{227,,NotImplemented}.

@end deffn
@end deffn

@geindex PathEntryFinder (clase en importlib.abc)
@anchor{library/importlib importlib abc PathEntryFinder}@anchor{906}
@deffn {Clase} importlib.abc.PathEntryFinder

Una clase base abstracta que representa un @ref{10ed,,buscador de entradas de ruta}. Aunque tiene algunas similitudes con @ref{905,,MetaPathFinder}, @code{PathEntryFinder} está diseñado para usarse solo dentro del subsistema de importación basado en rutas proporcionado por @ref{109f,,importlib.machinery.PathFinder}.


Added in version 3.3.



Distinto en la versión 3.10: No longer a subclass of @code{Finder}.


@geindex find_spec() (método de importlib.abc.PathEntryFinder)
@anchor{library/importlib importlib abc PathEntryFinder find_spec}@anchor{903}
@deffn {Método} find_spec (fullname, target=None)

Un método abstracto para encontrar un @ref{1f15,,spec} para el módulo especificado. El buscador buscará el módulo solo dentro del @ref{2004,,path entry} a la que está asignado. Si no se puede encontrar una especificación, se retorna @code{None}. Cuando se pasa, @code{target} es un objeto de módulo que el buscador puede usar para hacer una suposición más informada sobre qué especificación retornar. @ref{904,,importlib.util.spec_from_loader()} puede ser útil para implementar @code{PathEntryFinders} concretos.


Added in version 3.4.

@end deffn

@geindex invalidate_caches() (método de importlib.abc.PathEntryFinder)
@anchor{library/importlib importlib abc PathEntryFinder invalidate_caches}@anchor{4437}
@deffn {Método} invalidate_caches ()

Un método opcional que, cuando se llama, debería invalidar cualquier caché interno utilizado por el buscador. Usado por @ref{c97,,importlib.machinery.PathFinder.invalidate_caches()} al invalidar las cachés de todos los buscadores en caché.
@end deffn
@end deffn

@geindex Loader (clase en importlib.abc)
@anchor{library/importlib importlib abc Loader}@anchor{f48}
@deffn {Clase} importlib.abc.Loader

Una clase base abstracta para un @ref{16b8,,loader}. Consulte 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para obtener la definición exacta de cargador.

Los cargadores que deseen admitir la lectura de recursos deben implementar un método @code{get_resource_reader()} según lo especificado por @ref{b88,,importlib.abc.ResourceReader}.


Distinto en la versión 3.7: Introducido el método opcional @code{get_resource_reader()}.


@geindex create_module() (método de importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader create_module}@anchor{d37}
@deffn {Método} create_module (spec)

Un método que retorna el objeto de módulo que se utilizará al importar un módulo. Este método puede retornar @code{None}, lo que indica que se debe llevar a cabo la semántica de creación de módulos predeterminada.


Added in version 3.4.



Distinto en la versión 3.6: Este método ya no es opcional cuando se defina @ref{901,,exec_module()}.

@end deffn

@geindex exec_module() (método de importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader exec_module}@anchor{901}
@deffn {Método} exec_module (module)

Un método abstracto que ejecuta el módulo en su propio espacio de nombres cuando se importa o se vuelve a cargar un módulo. El módulo ya debería estar inicializado cuando se llama a @ref{901,,exec_module()}. Cuando existe este método, se debe definir @ref{d37,,create_module()}.


Added in version 3.4.



Distinto en la versión 3.6: @ref{d37,,create_module()} también debe definirse.

@end deffn

@geindex load_module() (método de importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader load_module}@anchor{900}
@deffn {Método} load_module (fullname)

Un método heredado para cargar un módulo. Si el módulo no se puede cargar, se lanza @ref{4d7,,ImportError}; de lo contrario, se retorna el módulo cargado.

If the requested module already exists in @ref{1976,,sys.modules}, that
module should be used and reloaded.
Otherwise the loader should create a new module and insert it into
@ref{1976,,sys.modules} before any loading begins, to prevent recursion
from the import.  If the loader inserted a module and the load fails, it
must be removed by the loader from @ref{1976,,sys.modules}; modules already
in @ref{1976,,sys.modules} before the loader began execution should be left
alone.

El cargador debe establecer varios atributos en el módulo (tenga en cuenta que algunos de estos atributos pueden cambiar cuando se recarga un módulo):


@itemize -

@item 
@ref{13e8,,module.__name__}

@item 
@ref{1f1b,,module.__file__}

@item 
@ref{1cb,,module.__cached__} `(deprecated)'

@item 
@ref{1c74,,module.__path__}

@item 
@ref{1cd,,module.__package__} `(deprecated)'

@item 
@ref{1e2,,module.__loader__} `(deprecated)'
@end itemize

Cuando @ref{901,,exec_module()} está disponible, se proporciona una funcionalidad compatible con versiones anteriores.


Distinto en la versión 3.4: Lanza @ref{4d7,,ImportError} cuando se llama en lugar de @ref{384,,NotImplementedError}. Funcionalidad proporcionada cuando @ref{901,,exec_module()} está disponible.



Obsoleto desde la versión 3.4: La API recomendada para cargar un módulo es @ref{901,,exec_module()} (y @ref{d37,,create_module()}). Los cargadores deberían implementarlo en lugar de @ref{900,,load_module()}. La maquinaria de importación se encarga de todas las demás responsabilidades de @ref{900,,load_module()} cuando se implementa @ref{901,,exec_module()}.

@end deffn
@end deffn

@geindex ResourceLoader (clase en importlib.abc)
@anchor{library/importlib importlib abc ResourceLoader}@anchor{c6f}
@deffn {Clase} importlib.abc.ResourceLoader

Una clase base abstracta para un @ref{16b8,,loader} que implementa el protocolo opcional 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para cargar recursos arbitrarios desde el back-end de almacenamiento.


Obsoleto desde la versión 3.7: Este ABC está en desuso a favor de admitir la carga de recursos a través de @ref{4438,,importlib.resources.abc.ResourceReader}.


@geindex get_data() (método de importlib.abc.ResourceLoader)
@anchor{library/importlib importlib abc ResourceLoader get_data}@anchor{4424}
@deffn {Método} abstractmethod get_data (path)

An abstract method to return the bytes for the data located at `path'.
Loaders that have a file-like storage back-end
that allows storing arbitrary data
can implement this abstract method to give direct access
to the data stored. @ref{4d5,,OSError} is to be raised if the `path' cannot
be found. The `path' is expected to be constructed using a module’s
@ref{1f1b,,__file__} attribute or an item from a package’s
@ref{1c74,,__path__}.


Distinto en la versión 3.4: Lanza @ref{4d5,,OSError} en vez de @ref{384,,NotImplementedError}.

@end deffn
@end deffn

@geindex InspectLoader (clase en importlib.abc)
@anchor{library/importlib importlib abc InspectLoader}@anchor{fd4}
@deffn {Clase} importlib.abc.InspectLoader

Una clase base abstracta para un @ref{16b8,,loader} que implementa el protocolo opcional 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para cargadores que inspeccionan módulos.

@geindex get_code() (método de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader get_code}@anchor{fd5}
@deffn {Método} get_code (fullname)

Retorna el objeto código para un módulo, o @code{None} si el módulo no tiene un objeto código (como sería el caso, por ejemplo, para un módulo integrado). Lanza un @ref{4d7,,ImportError} si el cargador no puede encontrar el módulo solicitado.

@cartouche
@quotation Nota 
Si bien el método tiene una implementación predeterminada, se sugiere que se anule si es posible para mejorar el rendimiento.
@end quotation
@end cartouche

@geindex universal newlines;importlib.abc.InspectLoader.get_source method


Distinto en la versión 3.4: Ya no es un método abstracto y se proporciona una implementación concreta.

@end deffn

@geindex get_source() (método de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader get_source}@anchor{fd8}
@deffn {Método} abstractmethod get_source (fullname)

Un método abstracto para retornar la fuente de un módulo. Se retorna como una cadena de caracteres de texto usando @ref{dc1,,universal newlines}, traduciendo todos los separadores de línea reconocidos en caracteres @code{'
'}. Retorna @code{None} si no hay una fuente disponible (por ejemplo, un módulo integrado). Lanza @ref{4d7,,ImportError} si el cargador no puede encontrar el módulo especificado.


Distinto en la versión 3.4: Lanza @ref{4d7,,ImportError} en vez de @ref{384,,NotImplementedError}.

@end deffn

@geindex is_package() (método de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader is_package}@anchor{4439}
@deffn {Método} is_package (fullname)

Un método opcional para retornar un valor verdadero si el módulo es un paquete, un valor falso en caso contrario. Se lanza @ref{4d7,,ImportError} si el @ref{16b8,,cargador} no puede encontrar el módulo.


Distinto en la versión 3.4: Lanza @ref{4d7,,ImportError} en vez de @ref{384,,NotImplementedError}.

@end deffn

@geindex source_to_code() (método estático de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader source_to_code}@anchor{e96}
@deffn {Método} static source_to_code (data, path='<string>')

Cree un objeto de código a partir de la fuente de Python.

El argumento `data' puede ser cualquier cosa que admita la función @ref{2fb,,compile()} (es decir, cadena de caracteres o bytes). El argumento `path' debe ser la «ruta» de donde se originó el código fuente, que puede ser un concepto abstracto (por ejemplo, ubicación en un archivo zip).

Con el objeto de código subsiguiente, uno puede ejecutarlo en un módulo ejecutando @code{exec(code, module.__dict__)}.


Added in version 3.4.



Distinto en la versión 3.5: Hace el método estático.

@end deffn

@geindex exec_module() (método de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader exec_module}@anchor{108e}
@deffn {Método} exec_module (module)

Implementación de @ref{901,,Loader.exec_module()}.


Added in version 3.4.

@end deffn

@geindex load_module() (método de importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader load_module}@anchor{443a}
@deffn {Método} load_module (fullname)

Implementación de @ref{900,,Loader.load_module()}.


Obsoleto desde la versión 3.4: use @ref{108e,,exec_module()} en su lugar.

@end deffn
@end deffn

@geindex ExecutionLoader (clase en importlib.abc)
@anchor{library/importlib importlib abc ExecutionLoader}@anchor{443b}
@deffn {Clase} importlib.abc.ExecutionLoader

Una clase base abstracta que hereda de @ref{fd4,,InspectLoader} que, cuando se implementa, ayuda a que un módulo se ejecute como un script. El ABC representa un protocolo opcional 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@geindex get_filename() (método de importlib.abc.ExecutionLoader)
@anchor{library/importlib importlib abc ExecutionLoader get_filename}@anchor{443c}
@deffn {Método} abstractmethod get_filename (fullname)

An abstract method that is to return the value of
@ref{1f1b,,__file__} for the specified module. If no path is
available, @ref{4d7,,ImportError} is raised.

Si el código fuente está disponible, entonces el método debe devolver la ruta al archivo fuente, independientemente de si se utilizó un código de bytes para cargar el módulo.


Distinto en la versión 3.4: Lanza @ref{4d7,,ImportError} en vez de @ref{384,,NotImplementedError}.

@end deffn
@end deffn

@geindex FileLoader (clase en importlib.abc)
@anchor{library/importlib importlib abc FileLoader}@anchor{10ef}
@deffn {Clase} importlib.abc.FileLoader (fullname, path)

Una clase base abstracta que hereda de @ref{c6f,,ResourceLoader} y @ref{443b,,ExecutionLoader}, proporcionando implementaciones concretas de @ref{4424,,ResourceLoader.get_data()} y @ref{443c,,ExecutionLoader.get_filename()}.

El argumento `fullname' es un nombre completamente resuelto del módulo que el cargador debe manejar. El argumento `path' es la ruta al archivo del módulo.


Added in version 3.3.


@geindex name (atributo de importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader name}@anchor{443d}
@deffn {Atributo} name

El nombre del módulo que puede manejar el cargador.
@end deffn

@geindex path (atributo de importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader path}@anchor{443e}
@deffn {Atributo} path

Ruta al archivo del módulo.
@end deffn

@geindex load_module() (método de importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader load_module}@anchor{443f}
@deffn {Método} load_module (fullname)

Llama a super’s @code{load_module()}.


Obsoleto desde la versión 3.4: Utilice @ref{901,,Loader.exec_module()} en su lugar.

@end deffn

@geindex get_filename() (método de importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader get_filename}@anchor{4440}
@deffn {Método} abstractmethod get_filename (fullname)

Retorna @ref{443e,,path}.
@end deffn

@geindex get_data() (método de importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader get_data}@anchor{4441}
@deffn {Método} abstractmethod get_data (path)

Lee `path' como un archivo binario y devuelve los bytes de él.
@end deffn
@end deffn

@geindex SourceLoader (clase en importlib.abc)
@anchor{library/importlib importlib abc SourceLoader}@anchor{4442}
@deffn {Clase} importlib.abc.SourceLoader

Una clase base abstracta para implementar la carga de archivos fuente (y opcionalmente bytecode). La clase hereda tanto de @ref{c6f,,ResourceLoader} como de @ref{443b,,ExecutionLoader}, lo que requiere la implementación de:


@itemize *

@item 
@ref{4424,,ResourceLoader.get_data()}

@item 

@table @asis

@item @ref{443c,,ExecutionLoader.get_filename()}

Solo debe devolver la ruta al archivo de origen; la carga sin fuente no es compatible.
@end table
@end itemize

Los métodos abstractos definidos por esta clase son para agregar soporte de archivo de código de bytes opcional. No implementar estos métodos opcionales (o hacer que se lance @ref{384,,NotImplementedError}) hace que el cargador solo funcione con el código fuente. La implementación de los métodos permite que el cargador trabaje con archivos fuente `y' código de bytes; no permite la carga `sin fuente' donde solo se proporciona un código de bytes. Los archivos de código de bytes son una optimización para acelerar la carga al eliminar el paso de análisis del compilador de Python, por lo que no se expone ninguna API específica de código de bytes.

@geindex path_stats() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader path_stats}@anchor{11fb}
@deffn {Método} path_stats (path)

Método abstracto opcional que devuelve un @ref{190,,dict} que contiene metadatos sobre la ruta especificada. Las claves de diccionario admitidas son:


@itemize -

@item 
@code{'mtime'} (obligatorio): un número entero o de punto flotante que representa la hora de modificación del código fuente;

@item 
@code{'size'} (opcional): el tamaño en bytes del código fuente.
@end itemize

Cualquier otra clave del diccionario se ignora para permitir futuras extensiones. Si no se puede manejar la ruta, se genera @ref{4d5,,OSError}.


Added in version 3.3.



Distinto en la versión 3.4: Lanza @ref{4d5,,OSError} en vez de @ref{384,,NotImplementedError}.

@end deffn

@geindex path_mtime() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader path_mtime}@anchor{11fa}
@deffn {Método} path_mtime (path)

Método abstracto opcional que retorna la hora de modificación de la ruta especificada.


Obsoleto desde la versión 3.3: Este método está obsoleto en favor de @ref{11fb,,path_stats()}. No tiene que implementarlo, pero aún está disponible para fines de compatibilidad. Lanza @ref{4d5,,OSError} si la ruta no se puede manejar.



Distinto en la versión 3.4: Lanza @ref{4d5,,OSError} en vez de @ref{384,,NotImplementedError}.

@end deffn

@geindex set_data() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader set_data}@anchor{4443}
@deffn {Método} set_data (path, data)

Método abstracto opcional que escribe los bytes especificados en una ruta de archivo. Los directorios intermedios que no existan se crearán automáticamente.

When writing to the path fails because the path is read-only
(@ref{22b0,,errno.EACCES}/@ref{dc9,,PermissionError}), do not propagate the
exception.


Distinto en la versión 3.4: Ya no lanza @ref{384,,NotImplementedError} cuando se llama.

@end deffn

@geindex get_code() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader get_code}@anchor{4444}
@deffn {Método} get_code (fullname)

Implementación concreta de @ref{fd5,,InspectLoader.get_code()}.
@end deffn

@geindex exec_module() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader exec_module}@anchor{108f}
@deffn {Método} exec_module (module)

Implementación concreta de @ref{901,,Loader.exec_module()}.


Added in version 3.4.

@end deffn

@geindex load_module() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader load_module}@anchor{4445}
@deffn {Método} load_module (fullname)

Implementación concreta de @ref{900,,Loader.load_module()}.


Obsoleto desde la versión 3.4: Utilice @ref{108f,,exec_module()} en su lugar.

@end deffn

@geindex get_source() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader get_source}@anchor{109d}
@deffn {Método} get_source (fullname)

Implementación concreta de @ref{fd8,,InspectLoader.get_source()}.
@end deffn

@geindex is_package() (método de importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader is_package}@anchor{4446}
@deffn {Método} is_package (fullname)

Implementación concreta de @ref{4439,,InspectLoader.is_package()}. Se determina que un módulo es un paquete si su ruta de archivo (proporcionada por @ref{443c,,ExecutionLoader.get_filename()}) es un archivo llamado @code{__init__} cuando se elimina la extensión del archivo `y' el nombre del módulo sí lo hace no termina en @code{__init__}.
@end deffn
@end deffn

@geindex ResourceReader (clase en importlib.abc)
@anchor{library/importlib importlib abc ResourceReader}@anchor{b88}
@deffn {Clase} importlib.abc.ResourceReader

`Superseded by TraversableResources'

An @ref{1224,,abstract base class} to provide the ability to read
`resources'.

From the perspective of this ABC, a `resource' is a binary
artifact that is shipped within a package. Typically this is
something like a data file that lives next to the @code{__init__.py}
file of the package. The purpose of this class is to help abstract
out the accessing of such data files so that it does not matter if
the package and its data file(s) are stored e.g. in a zip file
versus on the file system.

For any of methods of this class, a `resource' argument is
expected to be a @ref{3f0,,path-like object} which represents
conceptually just a file name. This means that no subdirectory
paths should be included in the `resource' argument. This is
because the location of the package the reader is for, acts as the
«directory». Hence the metaphor for directories and file
names is packages and resources, respectively. This is also why
instances of this class are expected to directly correlate to
a specific package (instead of potentially representing multiple
packages or a module).

Loaders that wish to support resource reading are expected to
provide a method called @code{get_resource_reader(fullname)} which
returns an object implementing this ABC’s interface. If the module
specified by fullname is not a package, this method should return
@ref{716,,None}. An object compatible with this ABC should only be
returned when the specified module is a package.


Added in version 3.7.



Deprecated since version 3.12, removed in version 3.14: Use @ref{21a,,importlib.resources.abc.TraversableResources} instead.


@geindex open_resource() (método de importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader open_resource}@anchor{4447}
@deffn {Método} abstractmethod open_resource (resource)

Returns an opened, @ref{2586,,file-like object} for binary reading
of the `resource'.

If the resource cannot be found, @ref{f46,,FileNotFoundError} is
raised.
@end deffn

@geindex resource_path() (método de importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader resource_path}@anchor{4448}
@deffn {Método} abstractmethod resource_path (resource)

Returns the file system path to the `resource'.

If the resource does not concretely exist on the file system,
raise @ref{f46,,FileNotFoundError}.
@end deffn

@geindex is_resource() (método de importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader is_resource}@anchor{4449}
@deffn {Método} abstractmethod is_resource (name)

Returns @code{True} if the named `name' is considered a resource.
@ref{f46,,FileNotFoundError} is raised if `name' does not exist.
@end deffn

@geindex contents() (método de importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader contents}@anchor{1a4b}
@deffn {Método} abstractmethod contents ()

Returns an @ref{1294,,iterable} of strings over the contents of
the package. Do note that it is not required that all names
returned by the iterator be actual resources, e.g. it is
acceptable to return names for which @ref{4449,,is_resource()} would
be false.

Allowing non-resource names to be returned is to allow for
situations where how a package and its resources are stored
are known a priori and the non-resource names would be useful.
For instance, returning subdirectory names is allowed so that
when it is known that the package and resources are stored on
the file system then those subdirectory names can be used
directly.

The abstract method returns an iterable of no items.
@end deffn
@end deffn

@geindex Traversable (clase en importlib.abc)
@anchor{library/importlib importlib abc Traversable}@anchor{188c}
@deffn {Clase} importlib.abc.Traversable

An object with a subset of @ref{19b,,pathlib.Path} methods suitable for
traversing directories and opening files.

For a representation of the object on the file-system, use
@ref{536,,importlib.resources.as_file()}.


Added in version 3.9.



Deprecated since version 3.12, removed in version 3.14: Use @ref{219,,importlib.resources.abc.Traversable} instead.


@geindex name (atributo de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable name}@anchor{444a}
@deffn {Atributo} name

Abstract. The base name of this object without any parent references.
@end deffn

@geindex iterdir() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable iterdir}@anchor{444b}
@deffn {Método} abstractmethod iterdir ()

Yield @code{Traversable} objects in @code{self}.
@end deffn

@geindex is_dir() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable is_dir}@anchor{444c}
@deffn {Método} abstractmethod is_dir ()

Return @code{True} if @code{self} is a directory.
@end deffn

@geindex is_file() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable is_file}@anchor{444d}
@deffn {Método} abstractmethod is_file ()

Return @code{True} if @code{self} is a file.
@end deffn

@geindex joinpath() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable joinpath}@anchor{444e}
@deffn {Método} abstractmethod joinpath (child)

Return Traversable child in @code{self}.
@end deffn

@geindex __truediv__() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable __truediv__}@anchor{444f}
@deffn {Método} abstractmethod __truediv__ (child)

Return @code{Traversable} child in @code{self}.
@end deffn

@geindex open() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable open}@anchor{4450}
@deffn {Método} abstractmethod open (mode='r', *args, **kwargs)

`mode' may be “r” or “rb” to open as text or binary. Return a handle
suitable for reading (same as @ref{27b5,,pathlib.Path.open}).

When opening as text, accepts encoding parameters such as those
accepted by @ref{854,,io.TextIOWrapper}.
@end deffn

@geindex read_bytes() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable read_bytes}@anchor{4451}
@deffn {Método} read_bytes ()

Read contents of @code{self} as bytes.
@end deffn

@geindex read_text() (método de importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable read_text}@anchor{4452}
@deffn {Método} read_text (encoding=None)

Read contents of @code{self} as text.
@end deffn
@end deffn

@geindex TraversableResources (clase en importlib.abc)
@anchor{library/importlib importlib abc TraversableResources}@anchor{188a}
@deffn {Clase} importlib.abc.TraversableResources

An abstract base class for resource readers capable of serving
the @ref{537,,importlib.resources.files()} interface. Subclasses
@ref{4438,,importlib.resources.abc.ResourceReader} and provides
concrete implementations of the @ref{4438,,importlib.resources.abc.ResourceReader}’s
abstract methods. Therefore, any loader supplying
@ref{188a,,importlib.abc.TraversableResources} also supplies ResourceReader.

Loaders that wish to support resource reading are expected to
implement this interface.


Added in version 3.9.



Deprecated since version 3.12, removed in version 3.14: Use @ref{21a,,importlib.resources.abc.TraversableResources} instead.


@geindex files() (método de importlib.abc.TraversableResources)
@anchor{library/importlib importlib abc TraversableResources files}@anchor{4453}
@deffn {Método} abstractmethod files ()

Returns a @ref{219,,importlib.resources.abc.Traversable} object for the loaded
package.
@end deffn
@end deffn

@node importlib machinery – Importadores y enlaces de ruta,importlib util – Código de utilidad para importadores,importlib abc – Clases base abstractas relacionadas con la importación,importlib — La implementación de import
@anchor{library/importlib importlib-machinery-importers-and-path-hooks}@anchor{4454}@anchor{library/importlib module-importlib machinery}@anchor{79}
@subsubsection @code{importlib.machinery} – Importadores y enlaces de ruta


@geindex module; importlib.machinery

`Código fuente:' Lib/importlib/machinery.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/machinery.py}


__________________________________________________________________


Este módulo contiene varios objetos que ayudan @ref{682,,import} buscar y cargar módulos.

@geindex SOURCE_SUFFIXES (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery SOURCE_SUFFIXES}@anchor{5b8}
@deffn {Atributo} importlib.machinery.SOURCE_SUFFIXES

Una lista de cadenas de caracteres que representan los sufijos de archivo reconocidos para los módulos de origen.


Added in version 3.3.

@end deffn

@geindex DEBUG_BYTECODE_SUFFIXES (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery DEBUG_BYTECODE_SUFFIXES}@anchor{4455}
@deffn {Atributo} importlib.machinery.DEBUG_BYTECODE_SUFFIXES

Una lista de cadenas que representan los sufijos de archivo para módulos de código de bytes no optimizados.


Added in version 3.3.



Obsoleto desde la versión 3.5: Utilice @ref{5ba,,BYTECODE_SUFFIXES} en su lugar.

@end deffn

@geindex OPTIMIZED_BYTECODE_SUFFIXES (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery OPTIMIZED_BYTECODE_SUFFIXES}@anchor{4456}
@deffn {Atributo} importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

Una lista de cadenas de caracteres que representan los sufijos de archivo para módulos de código de bytes optimizados.


Added in version 3.3.



Obsoleto desde la versión 3.5: Utilice @ref{5ba,,BYTECODE_SUFFIXES} en su lugar.

@end deffn

@geindex BYTECODE_SUFFIXES (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery BYTECODE_SUFFIXES}@anchor{5ba}
@deffn {Atributo} importlib.machinery.BYTECODE_SUFFIXES

Una lista de cadenas de caracteres que representan los sufijos de archivo reconocidos para los módulos de código de bytes (incluido el punto inicial).


Added in version 3.3.



Distinto en la versión 3.5: El valor ya no depende de @code{__debug__}.

@end deffn

@geindex EXTENSION_SUFFIXES (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery EXTENSION_SUFFIXES}@anchor{5b9}
@deffn {Atributo} importlib.machinery.EXTENSION_SUFFIXES

Una lista de cadenas de caracteres que representan los sufijos de archivo reconocidos para los módulos de extensión.


Added in version 3.3.

@end deffn

@geindex all_suffixes() (en el módulo importlib.machinery)
@anchor{library/importlib importlib machinery all_suffixes}@anchor{4387}
@deffn {Función} importlib.machinery.all_suffixes ()

Retorna una lista combinada de cadenas de caracteres que representan todos los sufijos de archivo para módulos reconocidos por la maquinaria de importación estándar. Este es un ayudante para el código que simplemente necesita saber si una ruta del sistema de archivos potencialmente se refiere a un módulo sin necesidad de detalles sobre el tipo de módulo (por ejemplo, @ref{dc0,,inspect.getmodulename()}).


Added in version 3.3.

@end deffn

@geindex BuiltinImporter (clase en importlib.machinery)
@anchor{library/importlib importlib machinery BuiltinImporter}@anchor{d38}
@deffn {Clase} importlib.machinery.BuiltinImporter

Un @ref{1ff5,,importer} para módulos integrados. Todos los módulos integrados conocidos se enumeran en @ref{1c66,,sys.builtin_module_names}. Esta clase implementa los ABC @ref{905,,importlib.abc.MetaPathFinder} y @ref{fd4,,importlib.abc.InspectLoader}.

Esta clase solo define los métodos de clase para aliviar la necesidad de instanciación.


Distinto en la versión 3.5: Como parte de 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}, el importador integrado ahora implementa @code{Loader.create_module()} y @code{Loader.exec_module()}

@end deffn

@geindex FrozenImporter (clase en importlib.machinery)
@anchor{library/importlib importlib machinery FrozenImporter}@anchor{109b}
@deffn {Clase} importlib.machinery.FrozenImporter

Un @ref{1ff5,,importer} para módulos congelados. Esta clase implementa los ABC @ref{905,,importlib.abc.MetaPathFinder} y @ref{fd4,,importlib.abc.InspectLoader}.

Esta clase solo define los métodos de clase para aliviar la necesidad de instanciación.


Distinto en la versión 3.4: Métodos obtenidos @code{create_module()} y @code{exec_module()}.

@end deffn

@geindex WindowsRegistryFinder (clase en importlib.machinery)
@anchor{library/importlib importlib machinery WindowsRegistryFinder}@anchor{db1}
@deffn {Clase} importlib.machinery.WindowsRegistryFinder

@ref{1f1c,,Finder} para los módulos declarados en el registro de Windows. Esta clase implementa el @ref{905,,importlib.abc.MetaPathFinder} ABC.

Esta clase solo define los métodos de clase para aliviar la necesidad de instanciación.


Added in version 3.3.



Obsoleto desde la versión 3.6: Utilice la configuración de @ref{c7,,site} en su lugar. Es posible que las versiones futuras de Python no habiliten este buscador de forma predeterminada.

@end deffn

@geindex PathFinder (clase en importlib.machinery)
@anchor{library/importlib importlib machinery PathFinder}@anchor{109f}
@deffn {Clase} importlib.machinery.PathFinder

Un @ref{1f1c,,Finder} para @ref{27e,,sys.path} y atributos del paquete @code{__path__}. Esta clase implementa el @ref{905,,importlib.abc.MetaPathFinder} ABC.

Esta clase solo define los métodos de clase para aliviar la necesidad de instanciación.

@geindex find_spec() (método de clase de importlib.machinery.PathFinder)
@anchor{library/importlib importlib machinery PathFinder find_spec}@anchor{108d}
@deffn {Método} classmethod find_spec (fullname, path=None, target=None)

Método de clase que intenta encontrar un @ref{1f15,,spec} para el módulo especificado por `fullname' en @ref{27e,,sys.path} o, si está definido, en `path'. Para cada entrada de ruta que se busca, se comprueba @ref{684,,sys.path_importer_cache}. Si se encuentra un objeto que no es falso, se utiliza como @ref{10ed,,path entry finder} para buscar el módulo que se está buscando. Si no se encuentra ninguna entrada en @ref{684,,sys.path_importer_cache}, entonces @ref{10a0,,sys.path_hooks} se busca un buscador para la entrada de ruta y, si se encuentra, se almacena en @ref{684,,sys.path_importer_cache} junto con ser consultado sobre el módulo. Si nunca se encuentra ningún buscador, entonces @code{None} se almacena en el caché y se retorna.


Added in version 3.4.



Distinto en la versión 3.5: Si el directorio de trabajo actual, representado por una cadena de caracteres vacía, ya no es válido, se retorna @code{None} pero no se almacena ningún valor en @ref{684,,sys.path_importer_cache}.

@end deffn

@geindex invalidate_caches() (método de clase de importlib.machinery.PathFinder)
@anchor{library/importlib importlib machinery PathFinder invalidate_caches}@anchor{c97}
@deffn {Método} classmethod invalidate_caches ()

Llama @ref{4437,,importlib.abc.PathEntryFinder.invalidate_caches()} en todos los buscadores almacenados en @ref{684,,sys.path_importer_cache} que definen el método. De lo contrario, las entradas en @ref{684,,sys.path_importer_cache} establecidas en @code{None} se eliminan.


Distinto en la versión 3.7: Se eliminan las entradas de @code{None} en @ref{684,,sys.path_importer_cache}.

@end deffn


Distinto en la versión 3.4: Llama a objetos en @ref{10a0,,sys.path_hooks} con el directorio de trabajo actual para @code{'@w{'}} (es decir, la cadena de caracteres vacía).

@end deffn

@geindex FileFinder (clase en importlib.machinery)
@anchor{library/importlib importlib machinery FileFinder}@anchor{10ee}
@deffn {Clase} importlib.machinery.FileFinder (path, *loader_details)

Una implementación concreta de @ref{906,,importlib.abc.PathEntryFinder} que almacena en caché los resultados del sistema de archivos.

El argumento `path' es el directorio que el buscador se encarga de buscar.

El argumento `loader_details' es un número variable de tuplas de 2 elementos, cada una de las cuales contiene un cargador y una secuencia de sufijos de archivo que el cargador reconoce. Se espera que los cargadores sean invocables que acepten dos argumentos del nombre del módulo y la ruta al archivo encontrado.

El buscador almacenará en caché el contenido del directorio según sea necesario, haciendo llamadas estadísticas para cada búsqueda de módulo para verificar que la caché no esté desactualizada. Debido a que la obsolescencia de la caché se basa en la granularidad de la información de estado del sistema operativo del sistema de archivos, existe una condición de carrera potencial de buscar un módulo, crear un nuevo archivo y luego buscar el módulo que representa el nuevo archivo. Si las operaciones ocurren lo suficientemente rápido como para ajustarse a la granularidad de las llamadas estadísticas, la búsqueda del módulo fallará. Para evitar que esto suceda, cuando cree un módulo dinámicamente, asegúrese de llamar a @ref{c98,,importlib.invalidate_caches()}.


Added in version 3.3.


@geindex path (atributo de importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder path}@anchor{4457}
@deffn {Atributo} path

La ruta en la que buscará el buscador.
@end deffn

@geindex find_spec() (método de importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder find_spec}@anchor{f47}
@deffn {Método} find_spec (fullname, target=None)

Intente encontrar la especificación para manejar `fullname' dentro de @ref{4457,,path}.


Added in version 3.4.

@end deffn

@geindex invalidate_caches() (método de importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder invalidate_caches}@anchor{4458}
@deffn {Método} invalidate_caches ()

Borrar el caché interno.
@end deffn

@geindex path_hook() (método de clase de importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder path_hook}@anchor{4459}
@deffn {Método} classmethod path_hook (*loader_details)

A class method which returns a closure for use on @ref{10a0,,sys.path_hooks}.
An instance of @ref{10ee,,FileFinder} is returned by the closure using the
path argument given to the closure directly and `loader_details'
indirectly.

Si el argumento del cierre no es un directorio existente, se lanza @ref{4d7,,ImportError}.
@end deffn
@end deffn

@geindex SourceFileLoader (clase en importlib.machinery)
@anchor{library/importlib importlib machinery SourceFileLoader}@anchor{10f0}
@deffn {Clase} importlib.machinery.SourceFileLoader (fullname, path)

Una implementación concreta de @ref{4442,,importlib.abc.SourceLoader} subclasificando @ref{10ef,,importlib.abc.FileLoader} y proporcionando algunas implementaciones concretas de otros métodos.


Added in version 3.3.


@geindex name (atributo de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader name}@anchor{445a}
@deffn {Atributo} name

El nombre del módulo que manejará este cargador.
@end deffn

@geindex path (atributo de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader path}@anchor{445b}
@deffn {Atributo} path

La ruta al archivo de origen.
@end deffn

@geindex is_package() (método de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader is_package}@anchor{445c}
@deffn {Método} is_package (fullname)

Devuelve @code{True} si @ref{445b,,path} parece ser para un paquete.
@end deffn

@geindex path_stats() (método de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader path_stats}@anchor{445d}
@deffn {Método} path_stats (path)

Implementación concreta de @ref{11fb,,importlib.abc.SourceLoader.path_stats()}.
@end deffn

@geindex set_data() (método de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader set_data}@anchor{445e}
@deffn {Método} set_data (path, data)

Implementación concreta de @ref{4443,,importlib.abc.SourceLoader.set_data()}.
@end deffn

@geindex load_module() (método de importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader load_module}@anchor{daf}
@deffn {Método} load_module (name=None)

Implementación concreta de @ref{900,,importlib.abc.Loader.load_module()} donde especificar el nombre del módulo a cargar es opcional.


Obsoleto desde la versión 3.6: Utilice @ref{901,,importlib.abc.Loader.exec_module()} en su lugar.

@end deffn
@end deffn

@geindex SourcelessFileLoader (clase en importlib.machinery)
@anchor{library/importlib importlib machinery SourcelessFileLoader}@anchor{10f1}
@deffn {Clase} importlib.machinery.SourcelessFileLoader (fullname, path)

Una implementación concreta de @ref{10ef,,importlib.abc.FileLoader} que puede importar archivos de código de bytes (es decir, no existen archivos de código fuente).

Tenga en cuenta que el uso directo de archivos de código de bytes (y, por lo tanto, no de archivos de código fuente) impide que sus módulos sean utilizables por todas las implementaciones de Python o las nuevas versiones de Python que cambian el formato de código de bytes.


Added in version 3.3.


@geindex name (atributo de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader name}@anchor{445f}
@deffn {Atributo} name

El nombre del módulo que manejará el cargador.
@end deffn

@geindex path (atributo de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader path}@anchor{4460}
@deffn {Atributo} path

La ruta al archivo de código de bytes.
@end deffn

@geindex is_package() (método de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader is_package}@anchor{4461}
@deffn {Método} is_package (fullname)

Determina si el módulo es un paquete basado en @ref{4460,,path}.
@end deffn

@geindex get_code() (método de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader get_code}@anchor{4462}
@deffn {Método} get_code (fullname)

Retorna el objeto de código para @ref{445f,,name} creado a partir de @ref{4460,,path}.
@end deffn

@geindex get_source() (método de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader get_source}@anchor{4463}
@deffn {Método} get_source (fullname)

Devuelve @code{None} ya que los archivos de código de bytes no tienen fuente cuando se usa este cargador.
@end deffn

@geindex load_module() (método de importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader load_module}@anchor{db0}
@deffn {Método} load_module (name=None)
@end deffn

Implementación concreta de @ref{900,,importlib.abc.Loader.load_module()} donde especificar el nombre del módulo a cargar es opcional.


Obsoleto desde la versión 3.6: Utilice @ref{901,,importlib.abc.Loader.exec_module()} en su lugar.

@end deffn

@geindex ExtensionFileLoader (clase en importlib.machinery)
@anchor{library/importlib importlib machinery ExtensionFileLoader}@anchor{d39}
@deffn {Clase} importlib.machinery.ExtensionFileLoader (fullname, path)

Una implementación concreta de @ref{443b,,importlib.abc.ExecutionLoader} para módulos de extensión.

El argumento `fullname' especifica el nombre del módulo que el cargador debe admitir. El argumento `path' es la ruta al archivo del módulo de extensión.

Note that, by default, importing an extension module will fail
in subinterpreters if it doesn’t implement multi-phase init
(see 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}), even if it would otherwise import successfully.


Added in version 3.3.



Distinto en la versión 3.12: Multi-phase init is now required for use in subinterpreters.


@geindex name (atributo de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader name}@anchor{4464}
@deffn {Atributo} name

Nombre del módulo que admite el cargador.
@end deffn

@geindex path (atributo de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader path}@anchor{4465}
@deffn {Atributo} path

Ruta al módulo de extensión.
@end deffn

@geindex create_module() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader create_module}@anchor{4466}
@deffn {Método} create_module (spec)

Crea el objeto de módulo a partir de la especificación dada de acuerdo con 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}.


Added in version 3.5.

@end deffn

@geindex exec_module() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader exec_module}@anchor{4467}
@deffn {Método} exec_module (module)

Inicializa el objeto de módulo dado de acuerdo con 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}.


Added in version 3.5.

@end deffn

@geindex is_package() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader is_package}@anchor{4468}
@deffn {Método} is_package (fullname)

Retorna @code{True} si la ruta del archivo apunta al módulo @code{__init__} de un paquete basado en @ref{5b9,,EXTENSION_SUFFIXES}.
@end deffn

@geindex get_code() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_code}@anchor{4469}
@deffn {Método} get_code (fullname)

Retorna @code{None} ya que los módulos de extensión carecen de un objeto de código.
@end deffn

@geindex get_source() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_source}@anchor{446a}
@deffn {Método} get_source (fullname)

Retorna @code{None} ya que los módulos de extensión no tienen código fuente.
@end deffn

@geindex get_filename() (método de importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_filename}@anchor{fd9}
@deffn {Método} get_filename (fullname)

Retorna @ref{4465,,path}.


Added in version 3.4.

@end deffn
@end deffn

@geindex NamespaceLoader (clase en importlib.machinery)
@anchor{library/importlib importlib machinery NamespaceLoader}@anchor{fd6}
@deffn {Clase} importlib.machinery.NamespaceLoader (name, path, path_finder)

Una implementación concreta de @ref{fd4,,importlib.abc.InspectLoader} para paquetes de espacio de nombres. Ésta es un alias para una clase privada y sólo se hace pública para introspeccionar el atributo @code{__loader__} en paquetes de espacio de nombres:

@example
>>> from importlib.machinery import NamespaceLoader
>>> import my_namespace
>>> isinstance(my_namespace.__loader__, NamespaceLoader)
True
>>> import importlib.abc
>>> isinstance(my_namespace.__loader__, importlib.abc.Loader)
True
@end example


Added in version 3.11.

@end deffn

@geindex ModuleSpec (clase en importlib.machinery)
@anchor{library/importlib importlib machinery ModuleSpec}@anchor{1e69}
@deffn {Clase} importlib.machinery.ModuleSpec (name, loader, *, origin=None, loader_state=None, is_package=None)

A specification for a module’s import-system-related state.  This is
typically exposed as the module’s @ref{1f16,,__spec__} attribute.  Many
of these attributes are also available directly on a module: for example,
@code{module.__spec__.origin == module.__file__}.  Note, however, that
while the `values' are usually equivalent, they can differ since there is
no synchronization between the two objects.  For example, it is possible to
update the module’s @ref{1f1b,,__file__} at runtime and this will not be
automatically reflected in the module’s
@ref{446b,,__spec__.origin}, and vice versa.


Added in version 3.4.


@geindex name (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec name}@anchor{1f17}
@deffn {Atributo} name

The module’s fully qualified name (see @ref{13e8,,module.__name__}).
The @ref{1f1c,,finder} should always set this attribute to a non-empty string.
@end deffn

@geindex loader (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec loader}@anchor{1e3}
@deffn {Atributo} loader

The @ref{16b8,,loader} used to load the module (see @ref{1e2,,module.__loader__}).
The @ref{1f1c,,finder} should always set this attribute.
@end deffn

@geindex origin (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec origin}@anchor{446b}
@deffn {Atributo} origin

The location the @ref{16b8,,loader} should use to load the module
(see @ref{1f1b,,module.__file__}).
For example, for modules loaded from a @code{.py} file this is the filename.
The @ref{1f1c,,finder} should always set this attribute to a meaningful value
for the @ref{16b8,,loader} to use.  In the uncommon case that there is not one
(like for namespace packages), it should be set to @code{None}.
@end deffn

@geindex submodule_search_locations (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec submodule_search_locations}@anchor{1f1a}
@deffn {Atributo} submodule_search_locations

A (possibly empty) @ref{597,,sequence} of strings enumerating the locations
in which a package’s submodules will be found
(see @ref{1c74,,module.__path__}). Most of the time there will only be a
single directory in this list.

The @ref{1f1c,,finder} should set this attribute to a sequence, even an empty
one, to indicate
to the import system that the module is a package.  It should be set to @code{None} for
non-package modules.  It is set automatically later to a special object for
namespace packages.
@end deffn

@geindex loader_state (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec loader_state}@anchor{446c}
@deffn {Atributo} loader_state

El @ref{1f1c,,buscador} podría establecer este atributo a un objeto conteniendo datos adicionales y específicos al módulo para usar cuando se carga el módulo.. De lo contrario, debe establecerse en @code{None}.
@end deffn

@geindex cached (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec cached}@anchor{1cc}
@deffn {Atributo} cached

The filename of a compiled version of the module’s code
(see @ref{1cb,,module.__cached__}).
The @ref{1f1c,,finder} should always set this attribute but it may be @code{None}
for modules that do not need compiled code stored.
@end deffn

@geindex parent (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec parent}@anchor{1ce}
@deffn {Atributo} parent

(Read-only) The fully qualified name of the package the module is in (or the
empty string for a top-level module).
See @ref{1cd,,module.__package__}.
If the module is a package then this is the same as @ref{1f17,,name}.
@end deffn

@geindex has_location (atributo de importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec has_location}@anchor{446d}
@deffn {Atributo} has_location

@code{True} if the spec’s @ref{446b,,origin} refers to a loadable location,
@code{False} otherwise.  This value impacts how @code{origin} is interpreted
and how the module’s @ref{1f1b,,__file__} is populated.
@end deffn
@end deffn

@geindex AppleFrameworkLoader (clase en importlib.machinery)
@anchor{library/importlib importlib machinery AppleFrameworkLoader}@anchor{1e68}
@deffn {Clase} importlib.machinery.AppleFrameworkLoader (name, path)

A specialization of @ref{d39,,importlib.machinery.ExtensionFileLoader} that
is able to load extension modules in Framework format.

For compatibility with the iOS App Store, `all' binary modules in an iOS app
must be dynamic libraries, contained in a framework with appropriate
metadata, stored in the @code{Frameworks} folder of the packaged app. There can
be only a single binary per framework, and there can be no executable binary
material outside the Frameworks folder.

To accommodate this requirement, when running on iOS, extension module
binaries are `not' packaged as @code{.so} files on @code{sys.path}, but as
individual standalone frameworks. To discover those frameworks, this loader
is be registered against the @code{.fwork} file extension, with a @code{.fwork}
file acting as a placeholder in the original location of the binary on
@code{sys.path}. The @code{.fwork} file contains the path of the actual binary in
the @code{Frameworks} folder, relative to the app bundle. To allow for
resolving a framework-packaged binary back to the original location, the
framework is expected to contain a @code{.origin} file that contains the
location of the @code{.fwork} file, relative to the app bundle.

For example, consider the case of an import @code{from foo.bar import _whiz},
where @code{_whiz} is implemented with the binary module
@code{sources/foo/bar/_whiz.abi3.so}, with @code{sources} being the location
registered on @code{sys.path}, relative to the application bundle. This module
`must' be distributed as
@code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz} (creating the framework
name from the full import path of the module), with an @code{Info.plist} file
in the @code{.framework} directory identifying the binary as a framework. The
@code{foo.bar._whiz} module would be represented in the original location with
a @code{sources/foo/bar/_whiz.abi3.fwork} marker file, containing the path
@code{Frameworks/foo.bar._whiz/foo.bar._whiz}. The framework would also contain
@code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}, containing the
path to the @code{.fwork} file.

When a module is loaded with this loader, the @code{__file__} for the module
will report as the location of the @code{.fwork} file. This allows code to use
the @code{__file__} of a  module as an anchor for file system traversal.
However, the spec origin will reference the location of the `actual' binary
in the @code{.framework} folder.

The Xcode project building the app is responsible for converting any @code{.so}
files from wherever they exist in the @code{PYTHONPATH} into frameworks in the
@code{Frameworks} folder (including stripping extensions from the module file,
the addition of framework metadata, and signing the resulting framework),
and creating the @code{.fwork} and @code{.origin} files. This will usually be done
with a build step in the Xcode project; see the iOS documentation for
details on how to construct this build step.


Added in version 3.13.


@ref{1d5a,,Availability}: iOS.

@geindex name (atributo de importlib.machinery.AppleFrameworkLoader)
@anchor{library/importlib importlib machinery AppleFrameworkLoader name}@anchor{446e}
@deffn {Atributo} name

Nombre del módulo que admite el cargador.
@end deffn

@geindex path (atributo de importlib.machinery.AppleFrameworkLoader)
@anchor{library/importlib importlib machinery AppleFrameworkLoader path}@anchor{446f}
@deffn {Atributo} path

Path to the @code{.fwork} file for the extension module.
@end deffn
@end deffn

@node importlib util – Código de utilidad para importadores,Ejemplos<32>,importlib machinery – Importadores y enlaces de ruta,importlib — La implementación de import
@anchor{library/importlib importlib-util-utility-code-for-importers}@anchor{4470}@anchor{library/importlib module-importlib util}@anchor{7d}
@subsubsection @code{importlib.util} – Código de utilidad para importadores


@geindex module; importlib.util

`Código fuente:' Lib/importlib/util.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/util.py}


__________________________________________________________________


Este módulo contiene los diversos objetos que ayudan en la construcción de un @ref{1ff5,,importer}.

@geindex MAGIC_NUMBER (en el módulo importlib.util)
@anchor{library/importlib importlib util MAGIC_NUMBER}@anchor{5b7}
@deffn {Atributo} importlib.util.MAGIC_NUMBER

Los bytes que representan el número de versión del código de bytes. Si necesita ayuda para cargar/escribir código de bytes, considere @ref{4442,,importlib.abc.SourceLoader}.


Added in version 3.4.

@end deffn

@geindex cache_from_source() (en el módulo importlib.util)
@anchor{library/importlib importlib util cache_from_source}@anchor{1f6}
@deffn {Función} importlib.util.cache_from_source (path, debug_override=None, *, optimization=None)

Retorna la ruta 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} al archivo compilado por bytes asociado con la `path' de origen. Por ejemplo, si `path' es @code{/foo/bar/baz.py}, el valor de retorno sería @code{/foo/bar/__pycache__/baz.cpython-32.pyc} para Python 3.2. La cadena de caracteres @code{cpython-32} proviene de la etiqueta mágica actual (ver @code{get_tag()}; si @code{sys.implementation.cache_tag} no está definido, se lanzará @ref{384,,NotImplementedError}).

El parámetro `optimization' se utiliza para especificar el nivel de optimización del archivo de código de bytes. Una cadena de caracteres vacía no representa optimización, por lo que @code{/foo/bar/baz.py} con una `optimization' de @code{'@w{'}} dará como resultado una ruta de código de bytes de @code{/foo/bar/__pycache__/baz.cpython-32.pyc}. @code{None} hace que se utilice el nivel de optimización del intérprete. Se usa la representación de cadena de caracteres de cualquier otro valor, por lo que @code{/foo/bar/baz.py} con una `optimization' de @code{2} conducirá a la ruta del código de bytes de @code{/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc}. La representación de cadena de caracteres `optimization' solo puede ser alfanumérica, de lo contrario se lanza @ref{360,,ValueError}.

El parámetro `debug_override' está obsoleto y se puede usar para anular el valor del sistema para @code{__debug__}. Un valor @code{True} es el equivalente a establecer `optimization' en la cadena de caracteres vacía. Un valor @code{False} es lo mismo que establecer `optimization' en @code{1}. Si tanto `debug_override' como `optimization' no es @code{None}, entonces se lanza @ref{228,,TypeError}.


Added in version 3.4.



Distinto en la versión 3.5: Se agregó el parámetro `optimization' y el parámetro `debug_override' quedó obsoleto.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex source_from_cache() (en el módulo importlib.util)
@anchor{library/importlib importlib util source_from_cache}@anchor{5be}
@deffn {Función} importlib.util.source_from_cache (path)

Dado el `path' a un nombre de archivo 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, retorna la ruta del archivo del código fuente asociado. Por ejemplo, si `path' es @code{/foo/bar/__pycache__/baz.cpython-32.pyc}, la ruta retornada sería @code{/foo/bar/baz.py}. `path' no necesita existir, sin embargo, si no se ajusta al formato 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} o 
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}, se lanza un @ref{360,,ValueError}. Si @code{sys.implementation.cache_tag} no está definido, se lanza @ref{384,,NotImplementedError}.


Added in version 3.4.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex decode_source() (en el módulo importlib.util)
@anchor{library/importlib importlib util decode_source}@anchor{fd7}
@deffn {Función} importlib.util.decode_source (source_bytes)

Decodifica los bytes dados que representan el código fuente y los retorna como una cadena de caracteres con nuevas líneas universales (como lo requiere @ref{fd8,,importlib.abc.InspectLoader.get_source()}).


Added in version 3.4.

@end deffn

@geindex resolve_name() (en el módulo importlib.util)
@anchor{library/importlib importlib util resolve_name}@anchor{9a0}
@deffn {Función} importlib.util.resolve_name (name, package)

Resuelve un nombre de módulo relativo a uno absoluto.

Si `name' no tiene puntos iniciales, entonces `name' simplemente se retorna. Esto permite el uso como @code{importlib.util.resolve_name('sys', __spec__.parent)} sin hacer una verificación para ver si se necesita el argumento `package'.

@ref{4d7,,ImportError} se lanza si `name' es un nombre de módulo relativo pero `package' es un valor falso (por ejemplo, @code{None} o la cadena de caracteres vacía). También se lanza @ref{4d7,,ImportError} si un nombre relativo escaparía del paquete que lo contiene (por ejemplo, solicitando @code{..bacon} desde el paquete @code{spam}).


Added in version 3.3.



Distinto en la versión 3.9: Para mejorar la coherencia con las declaraciones de importación, aumente @ref{4d7,,ImportError} en lugar de @ref{360,,ValueError} para intentos de importación relativa no válidos.

@end deffn

@geindex find_spec() (en el módulo importlib.util)
@anchor{library/importlib importlib util find_spec}@anchor{3ff}
@deffn {Función} importlib.util.find_spec (name, package=None)

Find the @ref{1f15,,spec} for a module, optionally relative to
the specified `package' name. If the module is in @ref{1976,,sys.modules},
then @code{sys.modules[name].__spec__} is returned (unless the spec would be
@code{None} or is not set, in which case @ref{360,,ValueError} is raised).
Otherwise a search using @ref{db2,,sys.meta_path} is done. @code{None} is
returned if no spec is found.

Si `name' es para un submódulo (contiene un punto), el módulo principal se importa automáticamente.

`name' y `package' funcionan igual que para @code{import_module()}.


Added in version 3.4.



Distinto en la versión 3.7: Raises @ref{bcf,,ModuleNotFoundError} instead of @ref{441,,AttributeError} if
`package' is in fact not a package (i.e. lacks a
@ref{1c74,,__path__} attribute).

@end deffn

@geindex module_from_spec() (en el módulo importlib.util)
@anchor{library/importlib importlib util module_from_spec}@anchor{e97}
@deffn {Función} importlib.util.module_from_spec (spec)

Cree un nuevo módulo basado en `spec' y @ref{d37,,spec.loader.create_module}.

Si @ref{d37,,spec.loader.create_module} no retorna @code{None}, no se restablecerán los atributos preexistentes. Además, no se lanzará @ref{441,,AttributeError} si se activa mientras se accede a `spec' o se establece un atributo en el módulo.

Esta función es preferible a usar @ref{e98,,types.ModuleType} para crear un nuevo módulo ya que `spec' se usa para establecer tantos atributos de importación controlados en el módulo como sea posible.


Added in version 3.5.

@end deffn

@geindex spec_from_loader() (en el módulo importlib.util)
@anchor{library/importlib importlib util spec_from_loader}@anchor{904}
@deffn {Función} importlib.util.spec_from_loader (name, loader, *, origin=None, is_package=None)

Una función de fábrica para crear una instancia de @ref{1e69,,ModuleSpec} basada en un cargador. Los parámetros tienen el mismo significado que para ModuleSpec. La función utiliza APIs disponibles de @ref{16b8,,loader}, tal como @code{InspectLoader.is_package()}, para completar cualquier información que falte en la especificación.


Added in version 3.4.

@end deffn

@geindex spec_from_file_location() (en el módulo importlib.util)
@anchor{library/importlib importlib util spec_from_file_location}@anchor{d3a}
@deffn {Función} importlib.util.spec_from_file_location (name, location, *, loader=None, submodule_search_locations=None)

Una función de fábrica para crear una instancia de @ref{1e69,,ModuleSpec} basada en la ruta a un archivo. La información que falte se completará en la especificación mediante el uso de las API de loader y la implicación de que el módulo estará basado en archivos.


Added in version 3.4.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.

@end deffn

@geindex source_hash() (en el módulo importlib.util)
@anchor{library/importlib importlib util source_hash}@anchor{4471}
@deffn {Función} importlib.util.source_hash (source_bytes)

Retorna el hash de `source_bytes' como bytes. Un archivo @code{.pyc} basado en hash incrusta @ref{4471,,source_hash()} del contenido del archivo fuente correspondiente en su encabezado.


Added in version 3.7.

@end deffn

@geindex _incompatible_extension_module_restrictions() (en el módulo importlib.util)
@anchor{library/importlib importlib util _incompatible_extension_module_restrictions}@anchor{4472}
@deffn {Función} importlib.util._incompatible_extension_module_restrictions (*, disable_check)

A context manager that can temporarily skip the compatibility check
for extension modules.  By default the check is enabled and will fail
when a single-phase init module is imported in a subinterpreter.
It will also fail for a multi-phase init module that doesn’t
explicitly support a per-interpreter GIL, when imported
in an interpreter with its own GIL.

Note that this function is meant to accommodate an unusual case;
one which is likely to eventually go away.  There’s is a pretty good
chance this is not what you were looking for.

You can get the same effect as this function by implementing the
basic interface of multi-phase init (
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) and lying about
support for multiple interpreters (or per-interpreter GIL).

@cartouche
@quotation Advertencia 
Using this function to disable the check can lead to
unexpected behavior and even crashes.  It should only be used during
extension module development.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex LazyLoader (clase en importlib.util)
@anchor{library/importlib importlib util LazyLoader}@anchor{d36}
@deffn {Clase} importlib.util.LazyLoader (loader)

Una clase que pospone la ejecución del cargador de un módulo hasta que el módulo tiene acceso a un atributo.

This class `only' works with loaders that define
@ref{901,,exec_module()} as control over what module type
is used for the module is required. For those same reasons, the loader’s
@ref{d37,,create_module()} method must return @code{None} or a
type for which its @code{__class__} attribute can be mutated along with not
using @ref{680,,slots}. Finally, modules which substitute the object
placed into @ref{1976,,sys.modules} will not work as there is no way to properly
replace the module references throughout the interpreter safely;
@ref{360,,ValueError} is raised if such a substitution is detected.

@cartouche
@quotation Nota 
Para proyectos donde el tiempo de inicio es crítico, esta clase permite minimizar potencialmente el costo de cargar un módulo si nunca se usa. Para proyectos en los que el tiempo de inicio no es esencial, el uso de esta clase se desaconseja `en gran medida' debido a que los mensajes de error creados durante la carga se posponen y, por lo tanto, ocurren fuera de contexto.
@end quotation
@end cartouche


Added in version 3.5.



Distinto en la versión 3.6: Comenzó a llamar @ref{d37,,create_module()}, eliminando la advertencia de compatibilidad para @ref{d38,,importlib.machinery.BuiltinImporter} y @ref{d39,,importlib.machinery.ExtensionFileLoader}.


@geindex factory() (método de clase de importlib.util.LazyLoader)
@anchor{library/importlib importlib util LazyLoader factory}@anchor{4473}
@deffn {Método} classmethod factory (loader)

A class method which returns a callable that creates a lazy loader. This
is meant to be used in situations where the loader is passed by class
instead of by instance.

@example
suffixes = importlib.machinery.SOURCE_SUFFIXES
loader = importlib.machinery.SourceFileLoader
lazy_loader = importlib.util.LazyLoader.factory(loader)
finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))
@end example
@end deffn
@end deffn

@node Ejemplos<32>,,importlib util – Código de utilidad para importadores,importlib — La implementación de import
@anchor{library/importlib examples}@anchor{4474}@anchor{library/importlib importlib-examples}@anchor{4475}
@subsubsection Ejemplos


@menu
* Importar programáticamente:: 
* Comprobando si se puede importar un módulo:: 
* Importar un archivo fuente directamente:: 
* Implementar importaciones diferidas:: 
* Configurar un importador:: 
* Aproximando importlib.import_module(): Aproximando importlib import_module. 

@end menu

@node Importar programáticamente,Comprobando si se puede importar un módulo,,Ejemplos<32>
@anchor{library/importlib importing-programmatically}@anchor{4476}
@subsubsection Importar programáticamente


Para importar un módulo mediante programación, use @ref{5bc,,importlib.import_module()}.

@example
import importlib

itertools = importlib.import_module('itertools')
@end example

@node Comprobando si se puede importar un módulo,Importar un archivo fuente directamente,Importar programáticamente,Ejemplos<32>
@anchor{library/importlib checking-if-a-module-can-be-imported}@anchor{4477}
@subsubsection Comprobando si se puede importar un módulo


Si necesita averiguar si un módulo se puede importar sin realmente realizar la importación, entonces debe usar @ref{3ff,,importlib.util.find_spec()}.

Note que si @code{name} es un sub-módulo (contiene sólo un punto), @ref{3ff,,importlib.util.find_spec()} importará el módulo padre.

@example
import importlib.util
import sys

# For illustrative purposes.
name = 'itertools'

if name in sys.modules:
    print(f"@{name!r@} already in sys.modules")
elif (spec := importlib.util.find_spec(name)) is not None:
    # If you chose to perform the actual import ...
    module = importlib.util.module_from_spec(spec)
    sys.modules[name] = module
    spec.loader.exec_module(module)
    print(f"@{name!r@} has been imported")
else:
    print(f"can't find the @{name!r@} module")
@end example

@node Importar un archivo fuente directamente,Implementar importaciones diferidas,Comprobando si se puede importar un módulo,Ejemplos<32>
@anchor{library/importlib importing-a-source-file-directly}@anchor{4478}
@subsubsection Importar un archivo fuente directamente


This recipe should be used with caution: it is an approximation of an import
statement where the file path is specified directly, rather than
@ref{27e,,sys.path} being searched. Alternatives should first be considered first,
such as modifying @ref{27e,,sys.path} when a proper module is required, or using
@ref{2ec,,runpy.run_path()} when the global namespace resulting from running a Python
file is appropriate.

To import a Python source file directly from a path, use the following recipe:

@example
import importlib.util
import sys


def import_from_path(module_name, file_path):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    sys.modules[module_name] = module
    spec.loader.exec_module(module)
    return module


# For illustrative purposes only (use of `json` is arbitrary).
import json
file_path = json.__file__
module_name = json.__name__

# Similar outcome as `import json`.
json = import_from_path(module_name, file_path)
@end example

@node Implementar importaciones diferidas,Configurar un importador,Importar un archivo fuente directamente,Ejemplos<32>
@anchor{library/importlib implementing-lazy-imports}@anchor{4479}
@subsubsection Implementar importaciones diferidas


El ejemplo de abajo muestra cómo implementar importaciones diferidas:

@example
>>> import importlib.util
>>> import sys
>>> def lazy_import(name):
...     spec = importlib.util.find_spec(name)
...     loader = importlib.util.LazyLoader(spec.loader)
...     spec.loader = loader
...     module = importlib.util.module_from_spec(spec)
...     sys.modules[name] = module
...     loader.exec_module(module)
...     return module
...
>>> lazy_typing = lazy_import("typing")
>>> #lazy_typing is a real module object,
>>> #but it is not loaded in memory yet.
>>> lazy_typing.TYPE_CHECKING
False
@end example

@node Configurar un importador,Aproximando importlib import_module,Implementar importaciones diferidas,Ejemplos<32>
@anchor{library/importlib setting-up-an-importer}@anchor{447a}
@subsubsection Configurar un importador


For deep customizations of import, you typically want to implement an
@ref{1ff5,,importer}. This means managing both the @ref{1f1c,,finder} and @ref{16b8,,loader}
side of things. For finders there are two flavours to choose from depending on
your needs: a @ref{10ec,,meta path finder} or a @ref{10ed,,path entry finder}. The
former is what you would put on @ref{db2,,sys.meta_path} while the latter is what
you create using a @ref{2006,,path entry hook} on @ref{10a0,,sys.path_hooks} which works
with @ref{27e,,sys.path} entries to potentially create a finder. This example will
show you how to register your own importers so that import will use them (for
creating an importer for yourself, read the documentation for the appropriate
classes defined within this package):

@example
import importlib.machinery
import sys

# For illustrative purposes only.
SpamMetaPathFinder = importlib.machinery.PathFinder
SpamPathEntryFinder = importlib.machinery.FileFinder
loader_details = (importlib.machinery.SourceFileLoader,
                  importlib.machinery.SOURCE_SUFFIXES)

# Setting up a meta path finder.
# Make sure to put the finder in the proper location in the list in terms of
# priority.
sys.meta_path.append(SpamMetaPathFinder)

# Setting up a path entry finder.
# Make sure to put the path hook in the proper location in the list in terms
# of priority.
sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))
@end example

@node Aproximando importlib import_module,,Configurar un importador,Ejemplos<32>
@anchor{library/importlib approximating-importlib-import-module}@anchor{447b}
@subsubsection Aproximando @code{importlib.import_module()}


La importación en sí está implementada en código Python, lo que permite exponer la mayor parte de la maquinaria de importación a través de importlib. Lo siguiente ayuda a ilustrar las diversas API que importlib expone al proporcionar una implementación aproximada de @ref{5bc,,importlib.import_module()}:

@example
import importlib.util
import sys

def import_module(name, package=None):
    """An approximate implementation of import."""
    absolute_name = importlib.util.resolve_name(name, package)
    try:
        return sys.modules[absolute_name]
    except KeyError:
        pass

    path = None
    if '.' in absolute_name:
        parent_name, _, child_name = absolute_name.rpartition('.')
        parent_module = import_module(parent_name)
        path = parent_module.__spec__.submodule_search_locations
    for finder in sys.meta_path:
        spec = finder.find_spec(absolute_name, path)
        if spec is not None:
            break
    else:
        msg = f'No module named @{absolute_name!r@}'
        raise ModuleNotFoundError(msg, name=absolute_name)
    module = importlib.util.module_from_spec(spec)
    sys.modules[absolute_name] = module
    spec.loader.exec_module(module)
    if path is not None:
        setattr(parent_module, child_name, module)
    return module
@end example

@node importlib resources – Package resource reading opening and access,importlib resources abc – Abstract base classes for resources,importlib — La implementación de import,Importando módulos
@anchor{library/importlib resources doc}@anchor{447c}@anchor{library/importlib resources importlib-resources-package-resource-reading-opening-and-access}@anchor{447d}@anchor{library/importlib resources module-importlib resources}@anchor{7b}
@subsection @code{importlib.resources} – Package resource reading, opening and access


@geindex module; importlib.resources

`Source code:' Lib/importlib/resources/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/resources/__init__.py}


__________________________________________________________________



Added in version 3.7.


This module leverages Python’s import system to provide access to `resources'
within `packages'.

«Resources» are file-like resources associated with a module or package in
Python. The resources may be contained directly in a package, within a
subdirectory contained in that package, or adjacent to modules outside a
package. Resources may be text or binary. As a result, Python module sources
(.py) of a package and compilation artifacts (pycache) are technically
de-facto resources of that package. In practice, however, resources are
primarily those non-Python artifacts exposed specifically by the package
author.

Resources can be opened or read in either binary or text mode.

Los recursos son más o menos similares a los archivos dentro de los directorios, aunque es importante tener en cuenta que esto es solo una metáfora. Los recursos y paquetes `no' deben existir como archivos y directorios físicos en el sistema de archivos: por ejemplo, un paquete y sus recursos se pueden importar desde un archivo zip usando @ref{131,,zipimport}.

@cartouche
@quotation Nota 
Este módulo proporciona una funcionalidad similar a pkg_resources@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html} Acceso a los recursos básicos@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access} sin la sobrecarga de rendimiento de ese paquete. Esto facilita la lectura de los recursos incluidos en los paquetes, con una semántica más estable y consistente.

El soporte independiente de este módulo proporciona más información sobre el uso de importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/using.html} y migración de pkg_resources a importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/migration.html}.
@end quotation
@end cartouche

@ref{f48,,Los loaders} que deseen soportar la lectura de recursos deben implementar un método @code{get_resource_reader(fullname)} según lo especificado por @ref{4438,,importlib.resources.abc.ResourceReader}.

@geindex Anchor (clase en importlib.resources)
@anchor{library/importlib resources importlib resources Anchor}@anchor{447e}
@deffn {Clase} importlib.resources.Anchor

Represents an anchor for resources, either a @ref{e98,,module object} or a module name as a string. Defined as
@code{Union[str, ModuleType]}.
@end deffn

@geindex files() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources files}@anchor{537}
@deffn {Función} importlib.resources.files (anchor: Anchor | None = None)

Returns a @ref{219,,Traversable} object
representing the resource container (think directory) and its resources
(think files). A Traversable may contain other containers (think
subdirectories).

`anchor' is an optional @ref{447e,,Anchor}. If the anchor is a
package, resources are resolved from that package. If a module,
resources are resolved adjacent to that module (in the same package
or the package root). If the anchor is omitted, the caller’s module
is used.


Added in version 3.9.



Distinto en la versión 3.12: `package' parameter was renamed to `anchor'. `anchor' can now
be a non-package module and if omitted will default to the caller’s
module. `package' is still accepted for compatibility but will raise
a @ref{1da,,DeprecationWarning}. Consider passing the anchor positionally or
using @code{importlib_resources >= 5.10} for a compatible interface
on older Pythons.

@end deffn

@geindex as_file() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources as_file}@anchor{536}
@deffn {Función} importlib.resources.as_file (traversable)

Given a @ref{219,,Traversable} object representing
a file or directory, typically from @ref{537,,importlib.resources.files()},
return a context manager for use in a @ref{673,,with} statement.
The context manager provides a @ref{19b,,pathlib.Path} object.

Exiting the context manager cleans up any temporary file or directory
created when the resource was extracted from e.g. a zip file.

Use @code{as_file} when the Traversable methods
(@code{read_text}, etc) are insufficient and an actual file or directory on
the file system is required.


Added in version 3.9.



Distinto en la versión 3.12: Added support for `traversable' representing a directory.

@end deffn

@menu
* Functional API:: 

@end menu

@node Functional API,,,importlib resources – Package resource reading opening and access
@anchor{library/importlib resources functional-api}@anchor{447f}@anchor{library/importlib resources importlib-resources-functional}@anchor{4480}
@subsubsection Functional API


A set of simplified, backwards-compatible helpers is available.
These allow common operations in a single function call.

For all the following functions:


@itemize -

@item 
`anchor' is an @ref{447e,,Anchor},
as in @ref{537,,files()}.
Unlike in @code{files}, it may not be omitted.

@item 
`path_names' are components of a resource’s path name, relative to
the anchor.
For example, to get the text of resource named @code{info.txt}, use:

@example
importlib.resources.read_text(my_module, "info.txt")
@end example

Like @ref{219,,Traversable.joinpath},
The individual components should use forward slashes (@code{/})
as path separators.
For example, the following are equivalent:

@example
importlib.resources.read_binary(my_module, "pics/painting.png")
importlib.resources.read_binary(my_module, "pics", "painting.png")
@end example

For backward compatibility reasons, functions that read text require
an explicit `encoding' argument if multiple `path_names' are given.
For example, to get the text of @code{info/chapter1.txt}, use:

@example
importlib.resources.read_text(my_module, "info", "chapter1.txt",
                              encoding='utf-8')
@end example
@end itemize

@geindex open_binary() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources open_binary}@anchor{34c}
@deffn {Función} importlib.resources.open_binary (anchor, *path_names)

Open the named resource for binary reading.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.

This function returns a @ref{3ed8,,BinaryIO} object,
that is, a binary stream open for reading.

This function is roughly equivalent to:

@example
files(anchor).joinpath(*path_names).open('rb')
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.

@end deffn

@geindex open_text() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources open_text}@anchor{34d}
@deffn {Función} importlib.resources.open_text (anchor, *path_names, encoding='utf-8', errors='strict')

Open the named resource for text reading.
By default, the contents are read as strict UTF-8.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.
`encoding' and `errors' have the same meaning as in built-in @ref{1be,,open()}.

For backward compatibility reasons, the `encoding' argument must be given
explicitly if there are multiple `path_names'.
This limitation is scheduled to be removed in Python 3.15.

This function returns a @ref{3ed7,,TextIO} object,
that is, a text stream open for reading.

This function is roughly equivalent to:

@example
files(anchor).joinpath(*path_names).open('r', encoding=encoding)
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.
`encoding' and `errors' must be given as keyword arguments.

@end deffn

@geindex read_binary() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources read_binary}@anchor{34f}
@deffn {Función} importlib.resources.read_binary (anchor, *path_names)

Read and return the contents of the named resource as @ref{325,,bytes}.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.

This function is roughly equivalent to:

@example
files(anchor).joinpath(*path_names).read_bytes()
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.

@end deffn

@geindex read_text() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources read_text}@anchor{350}
@deffn {Función} importlib.resources.read_text (anchor, *path_names, encoding='utf-8', errors='strict')

Read and return the contents of the named resource as @ref{237,,str}.
By default, the contents are read as strict UTF-8.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.
`encoding' and `errors' have the same meaning as in built-in @ref{1be,,open()}.

For backward compatibility reasons, the `encoding' argument must be given
explicitly if there are multiple `path_names'.
This limitation is scheduled to be removed in Python 3.15.

This function is roughly equivalent to:

@example
files(anchor).joinpath(*path_names).read_text(encoding=encoding)
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.
`encoding' and `errors' must be given as keyword arguments.

@end deffn

@geindex path() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources path}@anchor{34e}
@deffn {Función} importlib.resources.path (anchor, *path_names)

Provides the path to the `resource' as an actual file system path.  This
function returns a context manager for use in a @ref{673,,with} statement.
The context manager provides a @ref{19b,,pathlib.Path} object.

Exiting the context manager cleans up any temporary files created, e.g.
when the resource needs to be extracted from a zip file.

For example, the @ref{8ba,,stat()} method requires
an actual file system path; it can be used like this:

@example
with importlib.resources.path(anchor, "resource.txt") as fspath:
    result = fspath.stat()
@end example

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.

This function is roughly equivalent to:

@example
as_file(files(anchor).joinpath(*path_names))
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.
`encoding' and `errors' must be given as keyword arguments.

@end deffn

@geindex is_resource() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources is_resource}@anchor{34b}
@deffn {Función} importlib.resources.is_resource (anchor, *path_names)

Return @code{True} if the named resource exists, otherwise @code{False}.
This function does not consider directories to be resources.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.

This function is roughly equivalent to:

@example
files(anchor).joinpath(*path_names).is_file()
@end example


Distinto en la versión 3.13: Multiple `path_names' are accepted.

@end deffn

@geindex contents() (en el módulo importlib.resources)
@anchor{library/importlib resources importlib resources contents}@anchor{351}
@deffn {Función} importlib.resources.contents (anchor, *path_names)

Return an iterable over the named items within the package or path.
The iterable returns names of resources (e.g. files) and non-resources
(e.g. directories) as @ref{237,,str}.
The iterable does not recurse into subdirectories.

See @ref{4480,,the introduction} for
details on `anchor' and `path_names'.

This function is roughly equivalent to:

@example
for resource in files(anchor).joinpath(*path_names).iterdir():
    yield resource.name
@end example


Obsoleto desde la versión 3.11: Prefer @code{iterdir()} as above, which offers more control over the
results and richer functionality.

@end deffn

@node importlib resources abc – Abstract base classes for resources,importlib metadata – Acceso a los metadatos de los paquetes,importlib resources – Package resource reading opening and access,Importando módulos
@anchor{library/importlib resources abc doc}@anchor{4481}@anchor{library/importlib resources abc importlib-resources-abc-abstract-base-classes-for-resources}@anchor{4482}@anchor{library/importlib resources abc module-importlib resources abc}@anchor{7c}
@subsection @code{importlib.resources.abc} – Abstract base classes for resources


@geindex module; importlib.resources.abc

`Source code:' Lib/importlib/resources/abc.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/resources/abc.py}


__________________________________________________________________



Added in version 3.11.


@geindex ResourceReader (clase en importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc ResourceReader}@anchor{4438}
@deffn {Clase} importlib.resources.abc.ResourceReader

`Superseded by TraversableResources'

Un @ref{1224,,abstract base class} para proporcionar la capacidad de leer `resources'.

From the perspective of this ABC, a `resource' is a binary
artifact that is shipped within a package. Typically this is
something like a data file that lives next to the @code{__init__.py}
file of the package. The purpose of this class is to help abstract
out the accessing of such data files so that it does not matter if
the package and its data file(s) are stored e.g. in a zip file
versus on the file system.

Para cualquiera de los métodos de esta clase, se espera que un argumento `resource' sea un @ref{3f0,,path-like object} que represente conceptualmente solo un nombre de archivo. Esto significa que no se deben incluir rutas de subdirectorios en el argumento `resource'. Esto se debe a que la ubicación del paquete para el que se encuentra el lector actúa como el «directorio». Por lo tanto, la metáfora de directorios y nombres de archivos es paquetes y recursos, respectivamente. Esta es también la razón por la que se espera que las instancias de esta clase se correlacionen directamente con un paquete específico (en lugar de representar potencialmente varios paquetes o un módulo).

Se espera que los cargadores que deseen admitir la lectura de recursos proporcionen un método llamado @code{get_resource_reader(fullname)} que retorna un objeto que implementa la interfaz de este ABC. Si el módulo especificado por nombre completo no es un paquete, este método debería retornar @ref{716,,None}. Un objeto compatible con este ABC solo debe retornarse cuando el módulo especificado es un paquete.


Deprecated since version 3.12, removed in version 3.14: Use @ref{21a,,importlib.resources.abc.TraversableResources} instead.


@geindex open_resource() (método de importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader open_resource}@anchor{4483}
@deffn {Método} abstractmethod open_resource (resource)

Retorna un @ref{2586,,file-like object} abierto para la lectura binaria del `resource'.

Si no se puede encontrar el recurso, se genera @ref{f46,,FileNotFoundError}.
@end deffn

@geindex resource_path() (método de importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader resource_path}@anchor{4484}
@deffn {Método} abstractmethod resource_path (resource)

Retorna la ruta del sistema de archivos al `resource'.

Si el recurso no existe concretamente en el sistema de archivos, lanza @ref{f46,,FileNotFoundError}.
@end deffn

@geindex is_resource() (método de importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader is_resource}@anchor{4485}
@deffn {Método} abstractmethod is_resource (name)

Retorna @code{True} si el `name' con nombre se considera un recurso. @ref{f46,,FileNotFoundError} se genera si `name' no existe.
@end deffn

@geindex contents() (método de importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader contents}@anchor{4486}
@deffn {Método} abstractmethod contents ()

Retorna un @ref{1294,,iterable} de cadenas sobre el contenido del paquete. Tenga en cuenta que no se requiere que todos los nombres devueltos por el iterador sean recursos reales, p. es aceptable devolver nombres para los que @ref{4485,,is_resource()} sería falso.

Permitir que se retornen nombres que no son de recursos es permitir situaciones en las que se conoce a priori cómo se almacenan un paquete y sus recursos y los nombres que no son de recursos serían útiles. Por ejemplo, se permite devolver nombres de subdirectorios para que cuando se sepa que el paquete y los recursos están almacenados en el sistema de archivos, esos nombres de subdirectorios se puedan usar directamente.

El método abstracto retorna un iterable sin elementos.
@end deffn
@end deffn

@geindex Traversable (clase en importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc Traversable}@anchor{219}
@deffn {Clase} importlib.resources.abc.Traversable

An object with a subset of @ref{19b,,pathlib.Path} methods suitable for
traversing directories and opening files.

For a representation of the object on the file-system, use
@ref{536,,importlib.resources.as_file()}.

@geindex name (atributo de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable name}@anchor{4487}
@deffn {Atributo} name

Resumen. El nombre base de este objeto sin ninguna referencia principal.
@end deffn

@geindex iterdir() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable iterdir}@anchor{4488}
@deffn {Método} abstractmethod iterdir ()

Produce generador iterador de objetos Traversable en self.
@end deffn

@geindex is_dir() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable is_dir}@anchor{4489}
@deffn {Método} abstractmethod is_dir ()

Return @code{True} if self is a directory.
@end deffn

@geindex is_file() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable is_file}@anchor{448a}
@deffn {Método} abstractmethod is_file ()

Return @code{True} if self is a file.
@end deffn

@geindex joinpath() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable joinpath}@anchor{448b}
@deffn {Método} abstractmethod joinpath (*pathsegments)

Traverse directories according to `pathsegments' and return
the result as @code{Traversable}.

Each `pathsegments' argument may contain multiple names separated by
forward slashes (@code{/}, @code{posixpath.sep} ).
For example, the following are equivalent:

@example
files.joinpath('subdir', 'subsuddir', 'file.txt')
files.joinpath('subdir/subsuddir/file.txt')
@end example

Note that some @code{Traversable} implementations
might not be updated to the latest version of the protocol.
For compatibility with such implementations, provide a single argument
without path separators to each call to @code{joinpath}. For example:

@example
files.joinpath('subdir').joinpath('subsubdir').joinpath('file.txt')
@end example


Distinto en la versión 3.11: @code{joinpath} accepts multiple `pathsegments', and these segments
may contain forward slashes as path separators.
Previously, only a single `child' argument was accepted.

@end deffn

@geindex __truediv__() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable __truediv__}@anchor{448c}
@deffn {Método} abstractmethod __truediv__ (child)

Return Traversable child in self.
Equivalent to @code{joinpath(child)}.
@end deffn

@geindex open() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable open}@anchor{448d}
@deffn {Método} abstractmethod open (mode='r', *args, **kwargs)

`mode' puede ser “r” o “rb” para abrir como texto o binario. Retorna un identificador adecuado para la lectura (igual que @ref{27b5,,pathlib.Path.open}).

When opening as text, accepts encoding parameters such as those
accepted by @ref{854,,io.TextIOWrapper}.
@end deffn

@geindex read_bytes() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable read_bytes}@anchor{448e}
@deffn {Método} read_bytes ()

Lee el contenido de self como bytes.
@end deffn

@geindex read_text() (método de importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable read_text}@anchor{448f}
@deffn {Método} read_text (encoding=None)

Lee el contenido de self como texto.
@end deffn
@end deffn

@geindex TraversableResources (clase en importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc TraversableResources}@anchor{21a}
@deffn {Clase} importlib.resources.abc.TraversableResources

An abstract base class for resource readers capable of serving
the @ref{537,,importlib.resources.files()} interface. Subclasses
@ref{4438,,ResourceReader} and provides
concrete implementations of the @code{ResourceReader}’s
abstract methods. Therefore, any loader supplying
@code{TraversableResources} also supplies @code{ResourceReader}.

Se espera que los cargadores que deseen admitir la lectura de recursos implementen esta interfaz.

@geindex files() (método de importlib.resources.abc.TraversableResources)
@anchor{library/importlib resources abc importlib resources abc TraversableResources files}@anchor{4490}
@deffn {Método} abstractmethod files ()

Retorna un objeto @ref{219,,importlib.resources.abc.Traversable} para el paquete cargado.
@end deffn
@end deffn

@node importlib metadata – Acceso a los metadatos de los paquetes,La inicialización de la ruta de búsqueda de módulo de sys path,importlib resources abc – Abstract base classes for resources,Importando módulos
@anchor{library/importlib metadata doc}@anchor{4491}@anchor{library/importlib metadata importlib-metadata-accessing-package-metadata}@anchor{4492}@anchor{library/importlib metadata module-importlib metadata}@anchor{7a}@anchor{library/importlib metadata using}@anchor{4493}
@subsection @code{importlib.metadata} – Acceso a los metadatos de los paquetes


@geindex module; importlib.metadata


Added in version 3.8.



Distinto en la versión 3.10: @code{importlib.metadata} ya no es provisional.


`Source code:' Lib/importlib/metadata/__init__.py@footnote{https://github.com/python/cpython/tree/main/Lib/importlib/metadata/__init__.py}

@code{importlib.metadata} is a library that provides access to
the metadata of an installed Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package},
such as its entry points
or its top-level names (Import Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Import-Package}s, modules, if any).
Built in part on Python’s import system, this library
intends to replace similar functionality in the entry point API@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points} and metadata API@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api} of @code{pkg_resources}. Along with
@ref{7b,,importlib.resources},
this package can eliminate the need to use the older and less efficient
@code{pkg_resources} package.

@code{importlib.metadata} operates on third-party `distribution packages'
installed into Python’s @code{site-packages} directory via tools such as
pip@footnote{https://pypi.org/project/pip/}.
Specifically, it works with distributions with discoverable
@code{dist-info} or @code{egg-info} directories,
and metadata defined by the Core metadata specifications@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata}.

@cartouche
@quotation Importante 
These are `not' necessarily equivalent to or correspond 1:1 with
the top-level `import package' names
that can be imported inside Python code.
One `distribution package' can contain multiple `import packages'
(and single modules),
and one top-level `import package'
may map to multiple `distribution packages'
if it is a namespace package.
You can use @ref{8a7,,packages_distributions()}
to get a mapping between them.
@end quotation
@end cartouche

By default, distribution metadata can live on the file system
or in zip archives on
@ref{27e,,sys.path}. Through an extension mechanism, the metadata can live almost
anywhere.


@subsubheading Ver también



@table @asis

@item @indicateurl{https://importlib-metadata.readthedocs.io/}

La documentación de @code{importlib_metadata}, que proporciona un backport de @code{importlib.metadata}. Esto incluye una Referencia API@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html} para las clases y funciones de este módulo, así como una Guía de migración@footnote{https://importlib-metadata.readthedocs.io/en/latest/migration.html} para los usuarios existentes de @code{pkg_resources}.
@end table


@menu
* Descripción general:: 
* API funcional:: 
* Distribuciones:: 
* Distribution Discovery:: 
* Implementing Custom Providers:: 

@end menu

@node Descripción general,API funcional,,importlib metadata – Acceso a los metadatos de los paquetes
@anchor{library/importlib metadata overview}@anchor{4494}
@subsubsection Descripción general


Let’s say you wanted to get the version string for a
Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} you’ve installed
using @code{pip}. We start by creating a virtual environment and installing
something into it:

@example
$ python -m venv example
$ source example/bin/activate
(example) $ python -m pip install wheel
@end example

Se puede obtener la cadena de versión para @code{wheel} ejecutando lo siguiente:

@example
(example) $ python
>>> from importlib.metadata import version  
>>> version('wheel')  
'0.32.3'
@end example

You can also get a collection of entry points selectable by properties of the EntryPoint (typically “group” or “name”), such as
@code{console_scripts}, @code{distutils.commands} and others. Each group contains a
collection of @ref{3d9,,EntryPoint} objects.

Se pueden obtener los @ref{4495,,metadatos para una distribución}:

@example
>>> list(metadata('wheel'))  
['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist']
@end example

También se puede obtener el @ref{4496,,número de versión de una distribución}, enumerar sus @ref{4497,,archivos constituyentes} y obtener una lista de los @ref{4498,,Requerimientos de la distribución} de la distribución.

@geindex PackageNotFoundError
@anchor{library/importlib metadata importlib metadata PackageNotFoundError}@anchor{4499}
@deffn {Excepción} importlib.metadata.PackageNotFoundError

Subclass of @ref{bcf,,ModuleNotFoundError} raised by several functions in this
module when queried for a distribution package which is not installed in the
current Python environment.
@end deffn

@node API funcional,Distribuciones,Descripción general,importlib metadata – Acceso a los metadatos de los paquetes
@anchor{library/importlib metadata functional-api}@anchor{449a}
@subsubsection API funcional


Este paquete provee la siguiente funcionalidad a través de su API pública.

@menu
* Puntos de entrada:: 
* Metadatos de distribución:: 
* Versiones de distribución:: 
* Archivos de distribución:: 
* Requerimientos de la distribución:: 
* Mapeo de paquetes de importación a distribución:: 

@end menu

@node Puntos de entrada,Metadatos de distribución,,API funcional
@anchor{library/importlib metadata entry-points}@anchor{3d9}@anchor{library/importlib metadata id2}@anchor{449b}
@subsubsection Puntos de entrada


@geindex entry_points() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata entry_points}@anchor{449c}
@deffn {Función} importlib.metadata.entry_points (**select_params)

Returns a @ref{449d,,EntryPoints} instance describing entry points for the
current environment. Any given keyword parameters are passed to the
@code{select()} method for comparison to the attributes of
the individual entry point definitions.

Note: it is not currently possible to query for entry points based on
their @code{EntryPoint.dist} attribute (as different @code{Distribution}
instances do not currently compare equal, even if they have the same attributes)
@end deffn

@geindex EntryPoints (clase en importlib.metadata)
@anchor{library/importlib metadata importlib metadata EntryPoints}@anchor{449d}
@deffn {Clase} importlib.metadata.EntryPoints

Details of a collection of installed entry points.

Also provides a @code{.groups} attribute that reports all identifed entry
point groups, and a @code{.names} attribute that reports all identified entry
point names.
@end deffn

@geindex EntryPoint (clase en importlib.metadata)
@anchor{library/importlib metadata importlib metadata EntryPoint}@anchor{449e}
@deffn {Clase} importlib.metadata.EntryPoint

Details of an installed entry point.

Each @code{EntryPoint} instance has @code{.name}, @code{.group}, and @code{.value}
attributes and a @code{.load()} method to resolve the value. There are also
@code{.module}, @code{.attr}, and @code{.extras} attributes for getting the
components of the @code{.value} attribute, and @code{.dist} for obtaining
information regarding the distribution package that provides the entry point.
@end deffn

Consultar todos los puntos de entrada:

@example
>>> eps = entry_points()  
@end example

The @code{entry_points()} function returns a @code{EntryPoints} object,
a collection of all @code{EntryPoint} objects with @code{names} and @code{groups}
attributes for convenience:

@example
>>> sorted(eps.groups)  
['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']
@end example

@code{EntryPoints} has a @code{select()} method to select entry points
matching specific properties. Select entry points in the
@code{console_scripts} group:

@example
>>> scripts = eps.select(group='console_scripts')  
@end example

Equivalently, since @code{entry_points()} passes keyword arguments
through to select:

@example
>>> scripts = entry_points(group='console_scripts')  
@end example

Elige un script específico llamado «wheel» (que se encuentra en el proyecto `wheel'):

@example
>>> 'wheel' in scripts.names  
True
>>> wheel = scripts['wheel']  
@end example

De manera equivalente, consulta por ese punto de entrada durante la selección:

@example
>>> (wheel,) = entry_points(group='console_scripts', name='wheel')  
>>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')  
@end example

Inspeccionar el punto de entrada resuelto:

@example
>>> wheel  
EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
>>> wheel.module  
'wheel.cli'
>>> wheel.attr  
'main'
>>> wheel.extras  
[]
>>> main = wheel.load()  
>>> main  
<function main at 0x103528488>
@end example

The @code{group} and @code{name} are arbitrary values defined by the package author
and usually a client will wish to resolve all entry points for a particular
group. Read the setuptools docs@footnote{https://setuptools.pypa.io/en/latest/userguide/entry_point.html}
for more information on entry points, their definition, and usage.


Distinto en la versión 3.12: The «selectable» entry points were introduced in @code{importlib_metadata}
3.6 and Python 3.10. Prior to those changes, @code{entry_points} accepted
no parameters and always returned a dictionary of entry points, keyed
by group. With @code{importlib_metadata} 5.0 and Python 3.12,
@code{entry_points} always returns an @code{EntryPoints} object. See
backports.entry_points_selectable@footnote{https://pypi.org/project/backports.entry_points_selectable/}
for compatibility options.



Distinto en la versión 3.13: @code{EntryPoint} objects no longer present a tuple-like interface
(@ref{3d8,,__getitem__()}).


@node Metadatos de distribución,Versiones de distribución,Puntos de entrada,API funcional
@anchor{library/importlib metadata distribution-metadata}@anchor{449f}@anchor{library/importlib metadata metadata}@anchor{4495}
@subsubsection Metadatos de distribución


@geindex metadata() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata metadata}@anchor{44a0}
@deffn {Función} importlib.metadata.metadata (distribution_name)

Return the distribution metadata corresponding to the named
distribution package as a @ref{44a1,,PackageMetadata} instance.

Raises @ref{4499,,PackageNotFoundError} if the named distribution
package is not installed in the current Python environment.
@end deffn

@geindex PackageMetadata (clase en importlib.metadata)
@anchor{library/importlib metadata importlib metadata PackageMetadata}@anchor{44a1}
@deffn {Clase} importlib.metadata.PackageMetadata

A concrete implementation of the
PackageMetadata protocol@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata}.

In addition to providing the defined protocol methods and attributes, subscripting
the instance is equivalent to calling the @code{get()} method.
@end deffn

Every Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package}
includes some metadata, which you can extract using the @code{metadata()} function:

@example
>>> wheel_metadata = metadata('wheel')  
@end example

The keys of the returned data structure name the metadata keywords, and
the values are returned unparsed from the distribution metadata:

@example
>>> wheel_metadata['Requires-Python']  
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
@end example

@ref{44a1,,PackageMetadata} also presents a @code{json} attribute that returns
all the metadata in a JSON-compatible form per 
@geindex Python Enhancement Proposals; PEP 566
PEP 566@footnote{https://peps.python.org/pep-0566/}:

@example
>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
@end example

The full set of available metadata is not described here.
See the PyPA Core metadata specification@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata} for additional details.


Distinto en la versión 3.10: La @code{Descripción} ahora se incluye en los metadatos cuando se presenta a través de la carga útil. Se han eliminado los caracteres de continuación de línea.

El atributo @code{json} fue añadido.


@node Versiones de distribución,Archivos de distribución,Metadatos de distribución,API funcional
@anchor{library/importlib metadata distribution-versions}@anchor{44a2}@anchor{library/importlib metadata version}@anchor{4496}
@subsubsection Versiones de distribución


@geindex version() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata version}@anchor{1604}
@deffn {Función} importlib.metadata.version (distribution_name)

Return the installed distribution package version for the named
distribution package.

Raises @ref{4499,,PackageNotFoundError} if the named distribution
package is not installed in the current Python environment.
@end deffn

The @code{version()} function is the quickest way to get a
Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package}’s version
number, as a string:

@example
>>> version('wheel')  
'0.32.3'
@end example

@node Archivos de distribución,Requerimientos de la distribución,Versiones de distribución,API funcional
@anchor{library/importlib metadata distribution-files}@anchor{44a3}@anchor{library/importlib metadata files}@anchor{4497}
@subsubsection Archivos de distribución


@geindex files() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata files}@anchor{44a4}
@deffn {Función} importlib.metadata.files (distribution_name)

Return the full set of files contained within the named
distribution package.

Raises @ref{4499,,PackageNotFoundError} if the named distribution
package is not installed in the current Python environment.

Returns @ref{716,,None} if the distribution is found but the installation
database records reporting the files associated with the distribuion package
are missing.
@end deffn

@geindex PackagePath (clase en importlib.metadata)
@anchor{library/importlib metadata importlib metadata PackagePath}@anchor{44a5}
@deffn {Clase} importlib.metadata.PackagePath

A @ref{54e,,pathlib.PurePath} derived object with additional @code{dist},
@code{size}, and @code{hash} properties corresponding to the distribution
package’s installation metadata for that file.
@end deffn

The @code{files()} function takes a
Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package}
name and returns all of the files installed by this distribution. Each file is reported
as a @ref{44a5,,PackagePath} instance. For example:

@example
>>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]  
>>> util  
PackagePath('wheel/util.py')
>>> util.size  
859
>>> util.dist  
<importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>
>>> util.hash  
<FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>
@end example

Una vez que se tiene el archivo, también se puede leer su contenido:

@example
>>> print(util.read_text())  
import base64
import sys
...
def as_bytes(s):
    if isinstance(s, text_type):
        return s.encode('utf-8')
    return s
@end example

You can also use the @code{locate()} method to get the absolute
path to the file:

@example
>>> util.locate()  
PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')
@end example

In the case where the metadata file listing files
(@code{RECORD} or @code{SOURCES.txt}) is missing, @code{files()} will
return @ref{716,,None}. The caller may wish to wrap calls to
@code{files()} in always_iterable@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable}
or otherwise guard against this condition if the target
distribution is not known to have the metadata present.

@node Requerimientos de la distribución,Mapeo de paquetes de importación a distribución,Archivos de distribución,API funcional
@anchor{library/importlib metadata distribution-requirements}@anchor{44a6}@anchor{library/importlib metadata requirements}@anchor{4498}
@subsubsection Requerimientos de la distribución


@geindex requires() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata requires}@anchor{44a7}
@deffn {Función} importlib.metadata.requires (distribution_name)

Return the declared dependency specifiers for the named
distribution package.

Raises @ref{4499,,PackageNotFoundError} if the named distribution
package is not installed in the current Python environment.
@end deffn

To get the full set of requirements for a Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package},
use the @code{requires()}
function:

@example
>>> requires('wheel')  
["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]
@end example
@anchor{library/importlib metadata package-distributions}@anchor{8a7}
@node Mapeo de paquetes de importación a distribución,,Requerimientos de la distribución,API funcional
@anchor{library/importlib metadata import-distribution-package-mapping}@anchor{44a8}@anchor{library/importlib metadata mapping-import-to-distribution-packages}@anchor{44a9}
@subsubsection Mapeo de paquetes de importación a distribución


@geindex packages_distributions() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata packages_distributions}@anchor{44aa}
@deffn {Función} importlib.metadata.packages_distributions ()

Return a mapping from the top level module and import package
names found via @ref{db2,,sys.meta_path} to the names of the distribution
packages (if any) that provide the corresponding files.

To allow for namespace packages (which may have members provided by
multiple distribution packages), each top level import name maps to a
list of distribution names rather than mapping directly to a single name.
@end deffn

Un método práctico para resolver el nombre del Paquete de distribución@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} (o nombres, en el caso de un paquete de espacio de nombres) que proporciona cada módulo Python de nivel superior importable o Paquete de importación@footnote{https://packaging.python.org/en/latest/glossary/#term-Import-Package}:

@example
>>> packages_distributions()
@{'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...@}
@end example

Algunas instalaciones editables, no suministran nombres de nivel superior@footnote{https://github.com/pypa/packaging-problems/issues/609}, por lo que esta función no es fiable con dichas instalaciones.


Added in version 3.10.


@node Distribuciones,Distribution Discovery,API funcional,importlib metadata – Acceso a los metadatos de los paquetes
@anchor{library/importlib metadata distributions}@anchor{8a8}@anchor{library/importlib metadata id9}@anchor{44ab}
@subsubsection Distribuciones


@geindex distribution() (en el módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata distribution}@anchor{44ac}
@deffn {Función} importlib.metadata.distribution (distribution_name)

Return a @ref{44ad,,Distribution} instance describing the named
distribution package.

Raises @ref{4499,,PackageNotFoundError} if the named distribution
package is not installed in the current Python environment.
@end deffn

@geindex Distribution (clase en importlib.metadata)
@anchor{library/importlib metadata importlib metadata Distribution}@anchor{44ad}
@deffn {Clase} importlib.metadata.Distribution

Details of an installed distribution package.

Note: different @code{Distribution} instances do not currently compare
equal, even if they relate to the same installed distribution and
accordingly have the same attributes.
@end deffn

While the module level API described above is the most common and convenient usage,
you can get all of that information from the @code{Distribution} class.
@code{Distribution} is an abstract object that represents the metadata for
a Python Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package}.
You can get the concreate @code{Distribution} subclass instance for an installed
distribution package by calling the @ref{44ac,,distribution()} function:

@example
>>> from importlib.metadata import distribution  
>>> dist = distribution('wheel')  
>>> type(dist)  
<class 'importlib.metadata.PathDistribution'>
@end example

Thus, an alternative way to get the version number is through the
@code{Distribution} instance:

@example
>>> dist.version  
'0.32.3'
@end example

There are all kinds of additional metadata available on @code{Distribution}
instances:

@example
>>> dist.metadata['Requires-Python']  
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
>>> dist.metadata['License']  
'MIT'
@end example

For editable packages, an @code{origin} property may present 
@geindex Python Enhancement Proposals; PEP 610
PEP 610@footnote{https://peps.python.org/pep-0610/}
metadata:

@example
>>> dist.origin.url
'file:///path/to/wheel-0.32.3.editable-py3-none-any.whl'
@end example

The full set of available metadata is not described here.
See the PyPA Core metadata specification@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata} for additional details.


Added in version 3.13: The @code{.origin} property was added.


@node Distribution Discovery,Implementing Custom Providers,Distribuciones,importlib metadata – Acceso a los metadatos de los paquetes
@anchor{library/importlib metadata distribution-discovery}@anchor{44ae}
@subsubsection Distribution Discovery


Por defecto, este paquete proporciona soporte incorporado para el descubrimiento de metadatos para el sistema de archivos y archivos zip Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package}s. Este buscador de metadatos busca por defecto @code{sys.path}, pero varía ligeramente en cómo interpreta esos valores respecto a cómo lo hace otra maquinaria de importación. En particular:


@itemize -

@item 
@code{importlib.metadata} does not honor @ref{325,,bytes} objects on @code{sys.path}.

@item 
@code{importlib.metadata} respetará incidentalmente los objetos @code{pathlib.Path`} en @code{sys.path} aunque tales valores serán ignorados para las importaciones.
@end itemize

@node Implementing Custom Providers,,Distribution Discovery,importlib metadata – Acceso a los metadatos de los paquetes
@anchor{library/importlib metadata implementing-custom-providers}@anchor{44af}
@subsubsection Implementing Custom Providers


@code{importlib.metadata} address two API surfaces, one for `consumers'
and another for `providers'. Most users are consumers, consuming
metadata provided by the packages. There are other use-cases, however,
where users wish to expose metadata through some other mechanism,
such as alongside a custom importer. Such a use case calls for a
`custom provider'.

Because Distribution Package@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} metadata
is not available through @ref{27e,,sys.path} searches, or
package loaders directly,
the metadata for a distribution is found through import
system @ref{1ff3,,finders}. To find a distribution package’s metadata,
@code{importlib.metadata} queries the list of @ref{10ec,,meta path finders} on
@ref{db2,,sys.meta_path}.

The implementation has hooks integrated into the @code{PathFinder},
serving metadata for distribution packages found on the file system.

La clase abstracta @ref{905,,importlib.abc.MetaPathFinder} define la interfaz que se espera de los buscadores por el sistema de importación de Python. @code{importlib.metadata} amplía este protocolo buscando una @code{find_distributions} opcional invocable en los buscadores desde @ref{db2,,sys.meta_path} y presenta esta interfaz extendida como la clase base abstracta @code{DistributionFinder}, que define este método abstracto:

@example
@@abc.abstractmethod
def find_distributions(context=DistributionFinder.Context()) -> Iterable[Distribution]:
    """Return an iterable of all Distribution instances capable of
    loading the metadata for packages for the indicated `@w{`}context`@w{`}.
    """
@end example

The @code{DistributionFinder.Context} object provides @code{.path} and @code{.name}
properties indicating the path to search and name to match and may
supply other relevant context sought by the consumer.

In practice, to support finding distribution package
metadata in locations other than the file system, subclass
@code{Distribution} and implement the abstract methods. Then from
a custom finder, return instances of this derived @code{Distribution} in the
@code{find_distributions()} method.

@menu
* Example:: 

@end menu

@node Example,,,Implementing Custom Providers
@anchor{library/importlib metadata example}@anchor{44b0}
@subsubsection Example


Imagine a custom finder that loads Python modules from a database:

@example
class DatabaseImporter(importlib.abc.MetaPathFinder):
    def __init__(self, db):
        self.db = db

    def find_spec(self, fullname, target=None) -> ModuleSpec:
        return self.db.spec_from_name(fullname)

sys.meta_path.append(DatabaseImporter(connect_db(...)))
@end example

That importer now presumably provides importable modules from a
database, but it provides no metadata or entry points. For this
custom importer to provide metadata, it would also need to implement
@code{DistributionFinder}:

@example
from importlib.metadata import DistributionFinder

class DatabaseImporter(DistributionFinder):
    ...

    def find_distributions(self, context=DistributionFinder.Context()):
        query = dict(name=context.name) if context.name else @{@}
        for dist_record in self.db.query_distributions(query):
            yield DatabaseDistribution(dist_record)
@end example

In this way, @code{query_distributions} would return records for
each distribution served by the database matching the query. For
example, if @code{requests-1.0} is in the database, @code{find_distributions}
would yield a @code{DatabaseDistribution} for @code{Context(name='requests')}
or @code{Context(name=None)}.

For the sake of simplicity, this example ignores @code{context.path}. The
@code{path} attribute defaults to @code{sys.path} and is the set of import paths to
be considered in the search. A @code{DatabaseImporter} could potentially function
without any concern for a search path. Assuming the importer does no
partitioning, the «path» would be irrelevant. In order to illustrate the
purpose of @code{path}, the example would need to illustrate a more complex
@code{DatabaseImporter} whose behavior varied depending on
@code{sys.path}/@code{PYTHONPATH}. In that case, the @code{find_distributions} should
honor the @code{context.path} and only yield @code{Distribution}s pertinent to that
path.

@code{DatabaseDistribution}, then, would look something like:

@example
class DatabaseDistribution(importlib.metadata.Distribution):
    def __init__(self, record):
        self.record = record

    def read_text(self, filename):
        """
        Read a file like "METADATA" for the current distribution.
        """
        if filename == "METADATA":
            return f"""Name: @{self.record.name@}
Version: @{self.record.version@}
"""
        if filename == "entry_points.txt":
            return "\n".join(
              f"""[@{ep.group@}]\n@{ep.name@}=@{ep.value@}"""
              for ep in self.record.entry_points)

    def locate_file(self, path):
        raise RuntimeError("This distribution has no file system")
@end example

This basic implementation should provide metadata and entry points for
packages served by the @code{DatabaseImporter}, assuming that the
@code{record} supplies suitable @code{.name}, @code{.version}, and
@code{.entry_points} attributes.

The @code{DatabaseDistribution} may also provide other metadata files, like
@code{RECORD} (required for @code{Distribution.files}) or override the
implementation of @code{Distribution.files}. See the source for more inspiration.

@node La inicialización de la ruta de búsqueda de módulo de sys path,,importlib metadata – Acceso a los metadatos de los paquetes,Importando módulos
@anchor{library/sys_path_init doc}@anchor{44b1}@anchor{library/sys_path_init sys-path-init}@anchor{1c67}@anchor{library/sys_path_init the-initialization-of-the-sys-path-module-search-path}@anchor{44b2}
@subsection La inicialización de la ruta de búsqueda de módulo de @code{sys.path}


Una ruta de búsqueda de módulo se inicializa cuando se inicia Python. Se puede acceder a esta ruta de búsqueda de módulo en @ref{27e,,sys.path}.

La primera entrada en la ruta de búsqueda de módulo es el directorio que contiene el script de entrada, si lo hay. De lo contrario, la primera entrada es el directorio actual, que es el caso cuando se ejecuta el shell interactivo, un comando @ref{681,,-c} o un módulo @ref{187,,-m}.

La variable de entorno 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} se utiliza a menudo para añadir directorios a la ruta de búsqueda. Si se encuentra esta variable de entorno, su contenido se añade a la ruta de búsqueda del módulo.

@cartouche
@quotation Nota 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} afectará a todas las versiones/entornos de Python instalados. Tenga cuidado al establecer esto en su perfil de shell o en las variables de entorno globales. El módulo @ref{c7,,site} ofrece técnicas más suavizadas como se menciona a continuación.
@end quotation
@end cartouche

Los siguientes elementos que se añaden son los directorios que contienen los módulos estándar de Python, así como los @ref{44b3,,extension module} de los que dependen estos módulos. Los módulos de extensión son archivos @code{.pyd} en Windows y archivos @code{.so} en otras plataformas. El directorio con los módulos Python independientes de la plataforma se llama @code{prefix}. El directorio con los módulos de extensión se llama @code{exec_prefix}.

La variable de entorno 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} puede utilizarse para establecer las ubicaciones @code{prefix} y @code{exec_prefix}. De lo contrario, estos directorios se encuentran utilizando el ejecutable de Python como punto de partida y luego buscando varios archivos y directorios «de referencia». Tenga en cuenta que cualquier enlace simbólico se sigue, por lo que la ubicación real del ejecutable de Python se utiliza como punto de partida de la búsqueda. La ubicación del ejecutable de Python se llama @code{home}.

Una vez determinado @code{home}, el directorio @code{prefix} se encuentra buscando primero @code{python`majorversion'`minorversion'.zip} (@code{python311.zip}). En Windows el archivo zip se busca en @code{home} y en Unix se espera que el archivo esté en @code{lib}. Tenga en cuenta que la ubicación esperada del archivo zip se añade a la ruta de búsqueda del módulo incluso si el archivo no existe. Si no se encuentra ningún archivo, Python en Windows continuará la búsqueda de @code{prefix} buscando en @code{Lib\os.py}. Python en Unix buscará @code{lib/python`majorversion'.`minorversion'/os.py} (@code{lib/python3.11/os.py}). En Windows @code{prefix} y @code{prefix_exec} son los mismos, sin embargo en otras plataformas se busca @code{lib/python`majorversion'.`minorversion'/lib-dynload} (@code{lib/python3.11/lib-dynload}) y se utiliza como ancla para @code{prefix_exec}. En algunas plataformas @code{lib} puede ser @code{lib64} u otro valor, ver @ref{9cb,,sys.platlibdir} y 
@geindex PYTHONPLATLIBDIR
@geindex variables de entorno; PYTHONPLATLIBDIR
@ref{1949,,PYTHONPLATLIBDIR}.

Una vez encontrados, @code{prefix} y @code{exec_prefix} están disponibles en @ref{281,,sys.prefix} y @ref{27c,,sys.exec_prefix} respectivamente.

Finalmente, el módulo @ref{c7,,site} se procesa y los directorios @code{site-packages} se añaden a la ruta de búsqueda de módulo. Una forma común de personalizar la ruta de búsqueda es crear módulos @ref{c8,,sitecustomize} o @ref{10e,,usercustomize} como se describe en la documentación del módulo @ref{c7,,site}.

@cartouche
@quotation Nota 
Ciertas opciones de la línea de comandos pueden afectar aún más los cálculos de ruta. Vea @ref{9f0,,-E}, @ref{9f1,,-I}, @ref{13eb,,-s} y @ref{1217,,-S} para más detalles.
@end quotation
@end cartouche

@menu
* Entornos virtuales: Entornos virtuales<2>. 
* Archivos _pth:: 
* Python embebido:: 

@end menu

@node Entornos virtuales<2>,Archivos _pth,,La inicialización de la ruta de búsqueda de módulo de sys path
@anchor{library/sys_path_init virtual-environments}@anchor{44b4}
@subsubsection Entornos virtuales


Si Python se ejecuta en un entorno virtual (como se describe en @ref{1d05,,Entornos virtuales y paquetes}) entonces @code{prefix} y @code{exec_prefix} son específicos del entorno virtual.

Si se encuentra un archivo @code{pyvenv.cfg} junto al ejecutable principal, o en el directorio un nivel por encima del ejecutable, se aplican las siguientes variaciones:


@itemize *

@item 
Si @code{home} es una ruta absoluta y 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} no está establecido, esta ruta se utiliza en lugar de la ruta al ejecutable principal cuando se deduce @code{prefix} y @code{exec_prefix}.
@end itemize

@node Archivos _pth,Python embebido,Entornos virtuales<2>,La inicialización de la ruta de búsqueda de módulo de sys path
@anchor{library/sys_path_init pth-files}@anchor{44b5}
@subsubsection Archivos _pth


Para anular completamente @ref{27e,,sys.path} cree un archivo @code{._pth} con el mismo nombre que la biblioteca compartida o el ejecutable (@code{python._pth} o @code{python311._pth}). La ruta de la biblioteca compartida se conoce siempre en Windows, pero puede no estar disponible en otras plataformas. En el archivo @code{._pth} especifique una línea por cada ruta a añadir a @code{sys.path`}. El archivo basado en el nombre de la biblioteca compartida anula el basado en el ejecutable, lo que permite restringir las rutas para cualquier programa en tiempo de ejecución si se desea.

Cuando el archivo existe, se ignoran todas las variables de registro y de entorno, se habilita el modo aislado y no se importa @ref{c7,,site} a menos que una línea del archivo especifique @code{import site}. Las rutas en blanco y las líneas que comienzan con @code{#} son ignoradas. Cada ruta puede ser absoluta o relativa a la ubicación del fichero. No se permiten declaraciones de importación distintas de @code{site}, y no se puede especificar código arbitrario.

Tenga en cuenta que los archivos @code{.pth} (sin guión bajo inicial) serán procesados normalmente por el módulo @ref{c7,,site} cuando se haya especificado @code{import site}.

@node Python embebido,,Archivos _pth,La inicialización de la ruta de búsqueda de módulo de sys path
@anchor{library/sys_path_init embedded-python}@anchor{44b6}
@subsubsection Python embebido


If Python is embedded within another application @ref{4a6,,Py_InitializeFromConfig()} and
the @ref{499,,PyConfig} structure can be used to initialize Python. The path specific
details are described at @ref{944,,Configuración de la ruta de Python}.


@subsubheading Ver también



@itemize *

@item 
@ref{ca9,,Encontrar módulos} para las notas detalladas de Windows.

@item 
@ref{1d5e,,Uso de Python en plataformas Unix} para los detalles de Unix.
@end itemize


@node Servicios del lenguaje Python,Servicios Específicos para MS Windows,Importando módulos,La biblioteca estándar de Python
@anchor{library/language doc}@anchor{44b7}@anchor{library/language language}@anchor{44b8}@anchor{library/language python-language-services}@anchor{44b9}
@section Servicios del lenguaje Python


Python proporciona una serie de módulos para ayudar a trabajar con el lenguaje Python. Estos módulos admiten tokenización, análisis, análisis sintáctico, desensamblado de código de bytes, entre otras funciones.

Estos módulos incluyen:

@menu
* ast — Abstract Syntax Trees:: 
* symtable — Access to the compiler’s symbol tables:: 
* token — Constants used with Python parse trees:: 
* keyword — Testing for Python keywords:: 
* tokenize — Tokenizer for Python source:: 
* tabnanny — Detection of ambiguous indentation:: 
* pyclbr — Python module browser support:: 
* py_compile — Compile Python source files:: 
* compileall — Byte-compile Python libraries:: 
* dis — Disassembler for Python bytecode:: 
* pickletools — Tools for pickle developers:: 

@end menu

@node ast — Abstract Syntax Trees,symtable — Access to the compiler’s symbol tables,,Servicios del lenguaje Python
@anchor{library/ast doc}@anchor{44ba}@anchor{library/ast ast-abstract-syntax-trees}@anchor{44bb}@anchor{library/ast module-ast}@anchor{9}
@subsection @code{ast} — Abstract Syntax Trees


@geindex module; ast

@c import ast

`Código fuente:' Lib/ast.py@footnote{https://github.com/python/cpython/tree/main/Lib/ast.py}


__________________________________________________________________


El módulo @ref{9,,ast} ayuda a las aplicaciones de Python a procesar árboles de la gramática de sintaxis abstracta de Python. La sintaxis abstracta en sí misma puede cambiar con cada versión de Python; Este módulo ayuda a descubrir mediante programación cómo se ve la gramática actual.

Se puede generar un árbol de sintaxis abstracta pasando @ref{44bc,,ast.PyCF_ONLY_AST} como un indicador de la función incorporada @ref{2fb,,compile()}, o usando el ayudante @ref{30f,,parse()} provisto en este módulo. El resultado será un árbol de objetos cuyas clases todas heredan de @ref{30d,,ast.AST}. Se puede compilar un árbol de sintaxis abstracta en un objeto de código Python utilizando la función incorporada @ref{2fb,,compile()}.

@menu
* Gramática abstracta:: 
* Clases nodo:: 
* Ayudantes de ast:: 
* Banderas del compilador: Banderas del compilador<2>. 
* Uso en línea de comandos:: 

@end menu

@node Gramática abstracta,Clases nodo,,ast — Abstract Syntax Trees
@anchor{library/ast abstract-grammar}@anchor{44bd}@anchor{library/ast id1}@anchor{44be}
@subsubsection Gramática abstracta


La gramática abstracta se define actualmente de la siguiente manera:

@example
-- ASDL's 4 builtin types are:
-- identifier, int, string, constant

module Python
@{
    mod = Module(stmt* body, type_ignore* type_ignores)
        | Interactive(stmt* body)
        | Expression(expr body)
        | FunctionType(expr* argtypes, expr returns)

    stmt = FunctionDef(identifier name, arguments args,
                       stmt* body, expr* decorator_list, expr? returns,
                       string? type_comment, type_param* type_params)
          | AsyncFunctionDef(identifier name, arguments args,
                             stmt* body, expr* decorator_list, expr? returns,
                             string? type_comment, type_param* type_params)

          | ClassDef(identifier name,
             expr* bases,
             keyword* keywords,
             stmt* body,
             expr* decorator_list,
             type_param* type_params)
          | Return(expr? value)

          | Delete(expr* targets)
          | Assign(expr* targets, expr value, string? type_comment)
          | TypeAlias(expr name, type_param* type_params, expr value)
          | AugAssign(expr target, operator op, expr value)
          -- 'simple' indicates that we annotate simple name without parens
          | AnnAssign(expr target, expr annotation, expr? value, int simple)

          -- use 'orelse' because else is a keyword in target languages
          | For(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)
          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)
          | While(expr test, stmt* body, stmt* orelse)
          | If(expr test, stmt* body, stmt* orelse)
          | With(withitem* items, stmt* body, string? type_comment)
          | AsyncWith(withitem* items, stmt* body, string? type_comment)

          | Match(expr subject, match_case* cases)

          | Raise(expr? exc, expr? cause)
          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
          | TryStar(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
          | Assert(expr test, expr? msg)

          | Import(alias* names)
          | ImportFrom(identifier? module, alias* names, int? level)

          | Global(identifier* names)
          | Nonlocal(identifier* names)
          | Expr(expr value)
          | Pass | Break | Continue

          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

          -- BoolOp() can use left & right?
    expr = BoolOp(boolop op, expr* values)
         | NamedExpr(expr target, expr value)
         | BinOp(expr left, operator op, expr right)
         | UnaryOp(unaryop op, expr operand)
         | Lambda(arguments args, expr body)
         | IfExp(expr test, expr body, expr orelse)
         | Dict(expr* keys, expr* values)
         | Set(expr* elts)
         | ListComp(expr elt, comprehension* generators)
         | SetComp(expr elt, comprehension* generators)
         | DictComp(expr key, expr value, comprehension* generators)
         | GeneratorExp(expr elt, comprehension* generators)
         -- the grammar constrains where yield expressions can occur
         | Await(expr value)
         | Yield(expr? value)
         | YieldFrom(expr value)
         -- need sequences for compare to distinguish between
         -- x < 4 < 3 and (x < 4) < 3
         | Compare(expr left, cmpop* ops, expr* comparators)
         | Call(expr func, expr* args, keyword* keywords)
         | FormattedValue(expr value, int conversion, expr? format_spec)
         | JoinedStr(expr* values)
         | Constant(constant value, string? kind)

         -- the following expression can appear in assignment context
         | Attribute(expr value, identifier attr, expr_context ctx)
         | Subscript(expr value, expr slice, expr_context ctx)
         | Starred(expr value, expr_context ctx)
         | Name(identifier id, expr_context ctx)
         | List(expr* elts, expr_context ctx)
         | Tuple(expr* elts, expr_context ctx)

         -- can appear only in Subscript
         | Slice(expr? lower, expr? upper, expr? step)

          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    expr_context = Load | Store | Del

    boolop = And | Or

    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift
                 | RShift | BitOr | BitXor | BitAnd | FloorDiv

    unaryop = Invert | Not | UAdd | USub

    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn

    comprehension = (expr target, expr iter, expr* ifs, int is_async)

    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)
                    attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    arguments = (arg* posonlyargs, arg* args, arg? vararg, arg* kwonlyargs,
                 expr* kw_defaults, arg? kwarg, expr* defaults)

    arg = (identifier arg, expr? annotation, string? type_comment)
           attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    -- keyword arguments supplied to call (NULL identifier for **kwargs)
    keyword = (identifier? arg, expr value)
               attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    -- import name with optional 'as' alias.
    alias = (identifier name, identifier? asname)
             attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    withitem = (expr context_expr, expr? optional_vars)

    match_case = (pattern pattern, expr? guard, stmt* body)

    pattern = MatchValue(expr value)
            | MatchSingleton(constant value)
            | MatchSequence(pattern* patterns)
            | MatchMapping(expr* keys, pattern* patterns, identifier? rest)
            | MatchClass(expr cls, pattern* patterns, identifier* kwd_attrs, pattern* kwd_patterns)

            | MatchStar(identifier? name)
            -- The optional "rest" MatchMapping parameter handles capturing extra mapping keys

            | MatchAs(pattern? pattern, identifier? name)
            | MatchOr(pattern* patterns)

             attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)

    type_ignore = TypeIgnore(int lineno, string tag)

    type_param = TypeVar(identifier name, expr? bound, expr? default_value)
               | ParamSpec(identifier name, expr? default_value)
               | TypeVarTuple(identifier name, expr? default_value)
               attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)
@}
@end example

@node Clases nodo,Ayudantes de ast,Gramática abstracta,ast — Abstract Syntax Trees
@anchor{library/ast node-classes}@anchor{44bf}
@subsubsection Clases nodo


@geindex AST (clase en ast)
@anchor{library/ast ast AST}@anchor{30d}
@deffn {Clase} ast.AST

This is the base of all AST node classes.  The actual node classes are
derived from the @code{Parser/Python.asdl} file, which is reproduced
@ref{44bd,,above}.  They are defined in the @code{_ast} C
module and re-exported in @ref{9,,ast}.

Hay una clase definida para cada símbolo del lado izquierdo en la gramática abstracta (por ejemplo, @code{ast.stmt} o @code{ast.expr}). Además, hay una clase definida para cada constructor en el lado derecho; estas clases heredan de las clases para los árboles del lado izquierdo. Por ejemplo, @ref{19d6,,ast.BinOp} hereda de @code{ast.expr}. Para las reglas de producción con alternativas (también conocidas como «sumas»), la clase del lado izquierdo es abstracta: solo se crean instancias de nodos de constructor específicos.

@geindex ? (question mark);Gramática abstracta

@geindex * (asterisk);Gramática abstracta

@geindex _fields (atributo de ast.AST)
@anchor{library/ast ast AST _fields}@anchor{15a5}
@deffn {Atributo} _fields

Each concrete class has an attribute @code{_fields} which gives the names
of all child nodes.

Cada instancia de una clase concreta tiene un atributo para cada nodo secundario, del tipo definido en la gramática. Por ejemplo, las instancias @ref{19d6,,ast.BinOp} tienen un atributo @code{left} de tipo @code{ast.expr}.

Si estos atributos están marcados como opcionales en la gramática (usando un signo de interrogación), el valor podría ser @code{None}. Si los atributos pueden tener cero o más valores (marcados con un asterisco), los valores se representan como listas de Python. Todos los atributos posibles deben estar presentes y tener valores válidos al compilar un AST con @ref{2fb,,compile()}.
@end deffn

@geindex _field_types (atributo de ast.AST)
@anchor{library/ast ast AST _field_types}@anchor{30e}
@deffn {Atributo} _field_types

The @code{_field_types} attribute on each concrete class is a dictionary
mapping field names (as also listed in @ref{15a5,,_fields}) to their types.

@example
>>> ast.TypeVar._field_types
@{'name': <class 'str'>, 'bound': ast.expr | None, 'default_value': ast.expr | None@}
@end example


Added in version 3.13.

@end deffn

@geindex lineno (atributo de ast.AST)
@geindex col_offset (atributo de ast.AST)
@geindex end_lineno (atributo de ast.AST)
@geindex end_col_offset (atributo de ast.AST)
@anchor{library/ast ast AST lineno}@anchor{44c0}
@deffn {Atributo} lineno
@anchor{library/ast ast AST col_offset}@anchor{44c1}
@deffnx {Atributo} col_offset
@anchor{library/ast ast AST end_lineno}@anchor{44c2}
@deffnx {Atributo} end_lineno
@anchor{library/ast ast AST end_col_offset}@anchor{44c3}
@deffnx {Atributo} end_col_offset

Las instancias de las subclases @code{ast.expr} y @code{ast.stmt} tienen atributos @ref{44c0,,lineno}, @ref{44c1,,col_offset}, @ref{44c0,,lineno}, y @ref{44c1,,col_offset}. @ref{44c0,,lineno} y @ref{44c2,,end_lineno} son los números de la primera y última línea del intervalo de texto de origen (1 indexado, por lo que la primera línea es la línea 1), y @ref{44c1,,col_offset} y @ref{44c3,,end_col_offset} son las correspondientes compensaciones de bytes UTF-8 del primer y último token que generó el nodo. El desplazamiento UTF-8 se registra porque el analizador utiliza UTF-8 internamente.

Tenga en cuenta que el compilador no requiere las posiciones finales y, por lo tanto, son opcionales. El desplazamiento final es `después' del último símbolo, por ejemplo, uno puede obtener el segmento fuente de un nodo de expresión de una línea usando @code{source_line[node.col_offset: node.end_col_offset]}.
@end deffn

El constructor de una clase @code{ast.T} analiza sus argumentos de la siguiente manera:


@itemize *

@item 
Si hay argumentos posicionales, debe haber tantos como elementos en @code{T._fields}; serán asignados como atributos de estos nombres.

@item 
Si hay argumentos de palabras clave, establecerán los atributos de los mismos nombres a los valores dados.
@end itemize

Por ejemplo, para crear y completar un nodo @ref{44c4,,ast.UnaryOp}, puede usar

@example
node = ast.UnaryOp(ast.USub(), ast.Constant(5, lineno=0, col_offset=0),
                   lineno=0, col_offset=0)
@end example

If a field that is optional in the grammar is omitted from the constructor,
it defaults to @code{None}. If a list field is omitted, it defaults to the empty
list. If a field of type @code{ast.expr_context} is omitted, it defaults to
@ref{30c,,Load()}. If any other field is omitted, a @ref{1da,,DeprecationWarning} is raised
and the AST node will not have this field. In Python 3.15, this condition will
raise an error.
@end deffn


Distinto en la versión 3.8: La clase @ref{211,,ast.Constant} ahora se usa para todas las constantes.



Distinto en la versión 3.9: Los índices simples se representan por su valor, los segmentos extendidos se representan como tuplas.



Distinto en la versión 3.14: The @ref{6bd,,__repr__()} output of @ref{30d,,AST} nodes includes
the values of the node fields.



Obsoleto desde la versión 3.8: Old classes @code{ast.Num}, @code{ast.Str}, @code{ast.Bytes},
@code{ast.NameConstant} and @code{ast.Ellipsis} are still available,
but they will be removed in future Python releases.  In the meantime,
instantiating them will return an instance of a different class.



Obsoleto desde la versión 3.9: Old classes @code{ast.Index} and @code{ast.ExtSlice} are still
available, but they will be removed in future Python releases.
In the meantime, instantiating them will return an instance of
a different class.



Deprecated since version 3.13, will be removed in version 3.15: Previous versions of Python allowed the creation of AST nodes that were missing
required fields. Similarly, AST node constructors allowed arbitrary keyword
arguments that were set as attributes of the AST node, even if they did not
match any of the fields of the AST node. This behavior is deprecated and will
be removed in Python 3.15.


@cartouche
@quotation Nota 
Las descripciones de las clases de nodo específicas mostradas aquí fueron adaptadas inicialmente del fantástico proyecto Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/en/latest/} y todos sus contribuidores.
@end quotation
@end cartouche

@menu
* Nodos raíz:: 
* Literales: Literales<3>. 
* Variables:: 
* Expresiones: Expresiones<2>. 
* Declaraciones:: 
* Control de flujo:: 
* La coincidencia de patrones:: 
* Tipos de parámetro:: 
* Definiciones de función y clase:: 
* Async y await:: 

@end menu

@node Nodos raíz,Literales<3>,,Clases nodo
@anchor{library/ast ast-root-nodes}@anchor{44c5}@anchor{library/ast root-nodes}@anchor{44c6}
@subsubsection Nodos raíz


@geindex Module (clase en ast)
@anchor{library/ast ast Module}@anchor{44c7}
@deffn {Clase} ast.Module (body, type_ignores)

Un módulo de Python, como con @ref{2142,,archivo-entrada}. Tipo de nodo generado por @ref{30f,,ast.parse()} en el modo por defecto @code{"exec"} `mode'.*mode*.

@code{body} is a @ref{18e,,list} of the module’s @ref{44c8,,Declaraciones}.

@code{type_ignores} is a @ref{18e,,list} of the module’s type ignore comments;
see @ref{30f,,ast.parse()} for more details.

@example
>>> print(ast.dump(ast.parse('x = 1'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1))])
@end example
@end deffn

@geindex Expression (clase en ast)
@anchor{library/ast ast Expression}@anchor{44c9}
@deffn {Clase} ast.Expression (body)

Una única @ref{2148,,expression input} de Python. Tipo de nodo generado por @ref{30f,,ast.parse()} cuando `mode' es @code{"eval"}.

@code{body} is a single node,
one of the @ref{44ca,,expression types}.

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex Interactive (clase en ast)
@anchor{library/ast ast Interactive}@anchor{44cb}
@deffn {Clase} ast.Interactive (body)

Una única @ref{2145,,entrada interactiva}, como en @ref{2db,,Modo interactivo}. Tipo de nodo generado por @ref{30f,,ast.parse()} cuando `mode' es @code{"single"}.

@code{body} is a @ref{18e,,list} of @ref{44c8,,statement nodes}.

@example
>>> print(ast.dump(ast.parse('x = 1; y = 2', mode='single'), indent=4))
Interactive(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1)),
        Assign(
            targets=[
                Name(id='y', ctx=Store())],
            value=Constant(value=2))])
@end example
@end deffn

@geindex FunctionType (clase en ast)
@anchor{library/ast ast FunctionType}@anchor{44cc}
@deffn {Clase} ast.FunctionType (argtypes, returns)

Una interpretación de un comentario de tipo de estilo antiguo para funciones, ya que las versiones de Python anteriores a la 3.5 no soportaban anotaciones 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}. Tipo de nodo generado por @ref{30f,,ast.parse()} cuando `mode' es @code{"func_type"}.

Los comentarios de este tipo tendrían el siguiente aspecto:

@example
def sum_two_number(a, b):
    # type: (int, int) -> int
    return a + b
@end example

@code{argtypes} is a @ref{18e,,list} of @ref{44ca,,expression nodes}.

@code{returns} is a single @ref{44ca,,expression node}.

@example
>>> print(ast.dump(ast.parse('(int, str) -> List[int]', mode='func_type'), indent=4))
FunctionType(
    argtypes=[
        Name(id='int', ctx=Load()),
        Name(id='str', ctx=Load())],
    returns=Subscript(
        value=Name(id='List', ctx=Load()),
        slice=Name(id='int', ctx=Load()),
        ctx=Load()))
@end example


Added in version 3.8.

@end deffn

@node Literales<3>,Variables,Nodos raíz,Clases nodo
@anchor{library/ast literals}@anchor{44cd}
@subsubsection Literales


@geindex Constant (clase en ast)
@anchor{library/ast ast Constant}@anchor{211}
@deffn {Clase} ast.Constant (value)

Un valor constante. El atributo @code{value} del literal @code{Constant} contiene el objeto de Python que este representa. Los valores representados pueden ser de tipos simple como un número, una cadena de caracteres o @code{None}; pero también pueden ser de tipos de contenedores inmutables (tuplas y @code{frozensets}) si todos sus elementos son constantes.

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex FormattedValue (clase en ast)
@anchor{library/ast ast FormattedValue}@anchor{44ce}
@deffn {Clase} ast.FormattedValue (value, conversion, format_spec)

Nodo que representa un único campo de formato en una @code{f-string}. Si la cadena de caracteres contiene un único campo de formato y nada más, el nodo puede estar aislado de otra manera aparece en  @ref{16f1,,JoinedStr}.


@itemize *

@item 
@code{value} es cualquier nodo de expresión (como un literal, una variable o una llamada a función).

@item 
@code{conversion} es un entero:


@itemize *

@item 
-1: sin formato

@item 
115: @code{!s} formato de cadena de caracteres

@item 
114: @code{!r} formato repr

@item 
97: @code{!a} formato ascii
@end itemize

@item 
@code{format_spec} es un nodo @ref{16f1,,JoinedStr} que representa el formato del valor, o @code{None} si no se ha especificado un formato. Ambos, @code{conversion} y @code{format_spec}, pueden estar especificados al mismo tiempo.
@end itemize
@end deffn

@geindex JoinedStr (clase en ast)
@anchor{library/ast ast JoinedStr}@anchor{16f1}
@deffn {Clase} ast.JoinedStr (values)

Un f-string que comprende una serie de nodos @ref{44ce,,FormattedValue} y @ref{211,,Constant}.

@example
>>> print(ast.dump(ast.parse('f"sin(@{a@}) is @{sin(a):.3@}"', mode='eval'), indent=4))
Expression(
    body=JoinedStr(
        values=[
            Constant(value='sin('),
            FormattedValue(
                value=Name(id='a', ctx=Load()),
                conversion=-1),
            Constant(value=') is '),
            FormattedValue(
                value=Call(
                    func=Name(id='sin', ctx=Load()),
                    args=[
                        Name(id='a', ctx=Load())]),
                conversion=-1,
                format_spec=JoinedStr(
                    values=[
                        Constant(value='.3')]))]))
@end example
@end deffn

@geindex List (clase en ast)
@geindex Tuple (clase en ast)
@anchor{library/ast ast List}@anchor{44cf}
@deffn {Clase} ast.List (elts, ctx)
@anchor{library/ast ast Tuple}@anchor{44d0}
@deffnx {Clase} ast.Tuple (elts, ctx)

Una lista o tupla. @code{elts} contiene una lista de nodos que representa a los elementos. @code{ctx} es @ref{44d1,,Store} si el contenedor es un objetivo de asignación (por ejemplo @code{(x,y)=something}), y @ref{30c,,Load} en cualquier otro caso.

@example
>>> print(ast.dump(ast.parse('[1, 2, 3]', mode='eval'), indent=4))
Expression(
    body=List(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)],
        ctx=Load()))
>>> print(ast.dump(ast.parse('(1, 2, 3)', mode='eval'), indent=4))
Expression(
    body=Tuple(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)],
        ctx=Load()))
@end example
@end deffn

@geindex Set (clase en ast)
@anchor{library/ast ast Set}@anchor{44d2}
@deffn {Clase} ast.Set (elts)

Un set. @code{elts} contiene una lista de nodos que representa a un set de elementos.

@example
>>> print(ast.dump(ast.parse('@{1, 2, 3@}', mode='eval'), indent=4))
Expression(
    body=Set(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)]))
@end example
@end deffn

@geindex Dict (clase en ast)
@anchor{library/ast ast Dict}@anchor{1967}
@deffn {Clase} ast.Dict (keys, values)

Un diccionario. @code{keys} y @code{values} contienen listas de nodos que representan las claves y los valores respectivamente en el orden correspondiente (el orden que retornaría @code{dictionary.keys()} y @code{dictionary.values()}).

Cuando se desempaqueta un diccionario utilizando literales de diccionario, la expresión a ser expandida va en la lista @code{values}, con @code{None} en la posición correspondiente en @code{keys}.

@example
>>> print(ast.dump(ast.parse('@{"a":1, **d@}', mode='eval'), indent=4))
Expression(
    body=Dict(
        keys=[
            Constant(value='a'),
            None],
        values=[
            Constant(value=1),
            Name(id='d', ctx=Load())]))
@end example
@end deffn

@node Variables,Expresiones<2>,Literales<3>,Clases nodo
@anchor{library/ast variables}@anchor{44d3}
@subsubsection Variables


@geindex Name (clase en ast)
@anchor{library/ast ast Name}@anchor{1948}
@deffn {Clase} ast.Name (id, ctx)

Un nombre de variable. @code{id} contiene el nombre de una cadena de caracteres y @code{ctx} es uno de los siguientes tipos.
@end deffn

@geindex Load (clase en ast)
@geindex Store (clase en ast)
@geindex Del (clase en ast)
@anchor{library/ast ast Load}@anchor{30c}
@deffn {Clase} ast.Load
@anchor{library/ast ast Store}@anchor{44d1}
@deffnx {Clase} ast.Store
@anchor{library/ast ast Del}@anchor{44d4}
@deffnx {Clase} ast.Del

Referencias a variables que pueden ser usadas para cargar el valor de una variable, asignar un nuevo valor o borrarlo. Las referencias a variables reciben un contexto para distinguir entre estos casos.

@example
>>> print(ast.dump(ast.parse('a'), indent=4))
Module(
    body=[
        Expr(
            value=Name(id='a', ctx=Load()))])

>>> print(ast.dump(ast.parse('a = 1'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store())],
            value=Constant(value=1))])

>>> print(ast.dump(ast.parse('del a'), indent=4))
Module(
    body=[
        Delete(
            targets=[
                Name(id='a', ctx=Del())])])
@end example
@end deffn

@geindex Starred (clase en ast)
@anchor{library/ast ast Starred}@anchor{44d5}
@deffn {Clase} ast.Starred (value, ctx)

Una referencia a variable @code{*var}. @code{value} contiene la variable, típicamente un nodo @ref{1948,,Name}. Este tipo puede ser usado cuando se construye un nodo @ref{44d6,,Call} con @code{*args}.

@example
>>> print(ast.dump(ast.parse('a, *b = it'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Tuple(
                    elts=[
                        Name(id='a', ctx=Store()),
                        Starred(
                            value=Name(id='b', ctx=Store()),
                            ctx=Store())],
                    ctx=Store())],
            value=Name(id='it', ctx=Load()))])
@end example
@end deffn

@node Expresiones<2>,Declaraciones,Variables,Clases nodo
@anchor{library/ast ast-expressions}@anchor{44ca}@anchor{library/ast expressions}@anchor{44d7}
@subsubsection Expresiones


@geindex Expr (clase en ast)
@anchor{library/ast ast Expr}@anchor{44d8}
@deffn {Clase} ast.Expr (value)

Cuando una expresión, como un llamado a función, aparece como una declaración por sí misma sin que su valor de retorno se use o se almacene, está dentro de este contenedor. @code{value} contiene uno de los otros nodos en esta sección, un nodo @ref{211,,Constant}, @ref{1948,,Name}, @ref{44d9,,Lambda}, @ref{44da,,Yield} o @ref{44db,,YieldFrom}.

@example
>>> print(ast.dump(ast.parse('-a'), indent=4))
Module(
    body=[
        Expr(
            value=UnaryOp(
                op=USub(),
                operand=Name(id='a', ctx=Load())))])
@end example
@end deffn

@geindex UnaryOp (clase en ast)
@anchor{library/ast ast UnaryOp}@anchor{44c4}
@deffn {Clase} ast.UnaryOp (op, operand)

Una operación unaria. @code{op} es el operador y @code{operand} es cualquier nodo de expresión.
@end deffn

@geindex UAdd (clase en ast)
@geindex USub (clase en ast)
@geindex Not (clase en ast)
@geindex Invert (clase en ast)
@anchor{library/ast ast UAdd}@anchor{44dc}
@deffn {Clase} ast.UAdd
@anchor{library/ast ast USub}@anchor{44dd}
@deffnx {Clase} ast.USub
@anchor{library/ast ast Not}@anchor{44de}
@deffnx {Clase} ast.Not
@anchor{library/ast ast Invert}@anchor{44df}
@deffnx {Clase} ast.Invert

Tokens de operador unario. @ref{44de,,Not} es la palabra clave @code{not}, @ref{44df,,Invert} es el operador @code{~}.

@example
>>> print(ast.dump(ast.parse('not x', mode='eval'), indent=4))
Expression(
    body=UnaryOp(
        op=Not(),
        operand=Name(id='x', ctx=Load())))
@end example
@end deffn

@geindex BinOp (clase en ast)
@anchor{library/ast ast BinOp}@anchor{19d6}
@deffn {Clase} ast.BinOp (left, op, right)

Una operación binaria (como la suma o división(. @code{op} es el operador, y @code{left} y @code{right} son cualquier nodo de expresión.

@example
>>> print(ast.dump(ast.parse('x + y', mode='eval'), indent=4))
Expression(
    body=BinOp(
        left=Name(id='x', ctx=Load()),
        op=Add(),
        right=Name(id='y', ctx=Load())))
@end example
@end deffn

@geindex Add (clase en ast)
@geindex Sub (clase en ast)
@geindex Mult (clase en ast)
@geindex Div (clase en ast)
@geindex FloorDiv (clase en ast)
@geindex Mod (clase en ast)
@geindex Pow (clase en ast)
@geindex LShift (clase en ast)
@geindex RShift (clase en ast)
@geindex BitOr (clase en ast)
@geindex BitXor (clase en ast)
@geindex BitAnd (clase en ast)
@geindex MatMult (clase en ast)
@anchor{library/ast ast Add}@anchor{44e0}
@deffn {Clase} ast.Add
@anchor{library/ast ast Sub}@anchor{44e1}
@deffnx {Clase} ast.Sub
@anchor{library/ast ast Mult}@anchor{44e2}
@deffnx {Clase} ast.Mult
@anchor{library/ast ast Div}@anchor{44e3}
@deffnx {Clase} ast.Div
@anchor{library/ast ast FloorDiv}@anchor{44e4}
@deffnx {Clase} ast.FloorDiv
@anchor{library/ast ast Mod}@anchor{44e5}
@deffnx {Clase} ast.Mod
@anchor{library/ast ast Pow}@anchor{44e6}
@deffnx {Clase} ast.Pow
@anchor{library/ast ast LShift}@anchor{44e7}
@deffnx {Clase} ast.LShift
@anchor{library/ast ast RShift}@anchor{44e8}
@deffnx {Clase} ast.RShift
@anchor{library/ast ast BitOr}@anchor{44e9}
@deffnx {Clase} ast.BitOr
@anchor{library/ast ast BitXor}@anchor{44ea}
@deffnx {Clase} ast.BitXor
@anchor{library/ast ast BitAnd}@anchor{44eb}
@deffnx {Clase} ast.BitAnd
@anchor{library/ast ast MatMult}@anchor{44ec}
@deffnx {Clase} ast.MatMult

Tokens de operador binario.
@end deffn

@geindex BoolOp (clase en ast)
@anchor{library/ast ast BoolOp}@anchor{44ed}
@deffn {Clase} ast.BoolOp (op, values)

Una operación booleana, “or” y “and”. @code{op} es @ref{44ee,,Or} o @ref{44ef,,And}. @code{values} son los valores involucrados. Operaciones consecutivas con el mismo operador, como @code{a or b or c}, colapsan en un nodo con varios valores.

Esto no incluye @code{not}, el cual es un @ref{44c4,,UnaryOp}.

@example
>>> print(ast.dump(ast.parse('x or y', mode='eval'), indent=4))
Expression(
    body=BoolOp(
        op=Or(),
        values=[
            Name(id='x', ctx=Load()),
            Name(id='y', ctx=Load())]))
@end example
@end deffn

@geindex And (clase en ast)
@geindex Or (clase en ast)
@anchor{library/ast ast And}@anchor{44ef}
@deffn {Clase} ast.And
@anchor{library/ast ast Or}@anchor{44ee}
@deffnx {Clase} ast.Or

Tokens de operador booleano.
@end deffn

@geindex Compare (clase en ast)
@anchor{library/ast ast Compare}@anchor{44f0}
@deffn {Clase} ast.Compare (left, ops, comparators)

Una comparación de dos o más valores. @code{left} es el primer valor en la comparación, @code{ops} es la lista de operadores, y @code{comparators} es la lista de valores después de el primer elemento en la comparación.

@example
>>> print(ast.dump(ast.parse('1 <= a < 10', mode='eval'), indent=4))
Expression(
    body=Compare(
        left=Constant(value=1),
        ops=[
            LtE(),
            Lt()],
        comparators=[
            Name(id='a', ctx=Load()),
            Constant(value=10)]))
@end example
@end deffn

@geindex Eq (clase en ast)
@geindex NotEq (clase en ast)
@geindex Lt (clase en ast)
@geindex LtE (clase en ast)
@geindex Gt (clase en ast)
@geindex GtE (clase en ast)
@geindex Is (clase en ast)
@geindex IsNot (clase en ast)
@geindex In (clase en ast)
@geindex NotIn (clase en ast)
@anchor{library/ast ast Eq}@anchor{44f1}
@deffn {Clase} ast.Eq
@anchor{library/ast ast NotEq}@anchor{44f2}
@deffnx {Clase} ast.NotEq
@anchor{library/ast ast Lt}@anchor{44f3}
@deffnx {Clase} ast.Lt
@anchor{library/ast ast LtE}@anchor{44f4}
@deffnx {Clase} ast.LtE
@anchor{library/ast ast Gt}@anchor{44f5}
@deffnx {Clase} ast.Gt
@anchor{library/ast ast GtE}@anchor{44f6}
@deffnx {Clase} ast.GtE
@anchor{library/ast ast Is}@anchor{44f7}
@deffnx {Clase} ast.Is
@anchor{library/ast ast IsNot}@anchor{44f8}
@deffnx {Clase} ast.IsNot
@anchor{library/ast ast In}@anchor{44f9}
@deffnx {Clase} ast.In
@anchor{library/ast ast NotIn}@anchor{44fa}
@deffnx {Clase} ast.NotIn

Tokens de operador de comparación.
@end deffn

@geindex Call (clase en ast)
@anchor{library/ast ast Call}@anchor{44d6}
@deffn {Clase} ast.Call (func, args, keywords)

Un llamado a función. @code{func} is la función, la cual suele ser un objeto @ref{1948,,Name} o @ref{44fb,,Attribute}. De los argumentos:


@itemize *

@item 
@code{args} contiene una lista de argumentos pasados por posición.

@item 
@code{keywords} contiene una lista de objetos @ref{44fc,,keyword} que representan argumentos pasados por nombre clave.
@end itemize

The @code{args} and @code{keywords} arguments are optional and default to empty lists.

@example
>>> print(ast.dump(ast.parse('func(a, b=c, *d, **e)', mode='eval'), indent=4))
Expression(
    body=Call(
        func=Name(id='func', ctx=Load()),
        args=[
            Name(id='a', ctx=Load()),
            Starred(
                value=Name(id='d', ctx=Load()),
                ctx=Load())],
        keywords=[
            keyword(
                arg='b',
                value=Name(id='c', ctx=Load())),
            keyword(
                value=Name(id='e', ctx=Load()))]))
@end example
@end deffn

@geindex keyword (clase en ast)
@anchor{library/ast ast keyword}@anchor{44fc}
@deffn {Clase} ast.keyword (arg, value)

Un argumento de palabra clave para una llamada de función o definición de clase. @code{arg} es una cadena de caracteres sin formato del nombre del parámetro, @code{valor} es un nodo para pasar.
@end deffn

@geindex IfExp (clase en ast)
@anchor{library/ast ast IfExp}@anchor{44fd}
@deffn {Clase} ast.IfExp (test, body, orelse)

Una expresión como @code{a if b else c}. Cada campo contiene un único nodo, por lo que en el siguiente ejemplo, todos son nodos  @ref{1948,,Name}.

@example
>>> print(ast.dump(ast.parse('a if b else c', mode='eval'), indent=4))
Expression(
    body=IfExp(
        test=Name(id='b', ctx=Load()),
        body=Name(id='a', ctx=Load()),
        orelse=Name(id='c', ctx=Load())))
@end example
@end deffn

@geindex Attribute (clase en ast)
@anchor{library/ast ast Attribute}@anchor{44fb}
@deffn {Clase} ast.Attribute (value, attr, ctx)

Acceso a atributos, por ejemplo @code{d.keys}. @code{value} es un nodo, típicamente un @ref{1948,,Name}. @code{attr} es una simple cadena de caracteres que da el nombre del atributo, y @code{ctx} es @ref{30c,,Load}, @ref{44d1,,Store} o @ref{44d4,,Del} de acuerdo a cómo se actúe sobre el atributo.

@example
>>> print(ast.dump(ast.parse('snake.colour', mode='eval'), indent=4))
Expression(
    body=Attribute(
        value=Name(id='snake', ctx=Load()),
        attr='colour',
        ctx=Load()))
@end example
@end deffn

@geindex NamedExpr (clase en ast)
@anchor{library/ast ast NamedExpr}@anchor{44fe}
@deffn {Clase} ast.NamedExpr (target, value)

Una expresión con nombre. Este nodo AST es producido por el operador de expresiones de asignación (también conocido como el operador walrus). A diferencia del nodo @ref{44ff,,Assign} en el cual el primer argumento puede ser varios nodos, en este caso @code{target} y @code{value} deben ser nodos únicos.

@example
>>> print(ast.dump(ast.parse('(x := 4)', mode='eval'), indent=4))
Expression(
    body=NamedExpr(
        target=Name(id='x', ctx=Store()),
        value=Constant(value=4)))
@end example


Added in version 3.8.

@end deffn

@menu
* Subindexado:: 
* Comprensiones:: 

@end menu

@node Subindexado,Comprensiones,,Expresiones<2>
@anchor{library/ast subscripting}@anchor{4500}
@subsubsection Subindexado


@geindex Subscript (clase en ast)
@anchor{library/ast ast Subscript}@anchor{4501}
@deffn {Clase} ast.Subscript (value, slice, ctx)

Un subíndice, como @code{l[1]}. @code{value} es el objeto subindicado (usualmente una secuencia o mapeo). @code{slice} es un índice, un segmento o una clave. Este puede ser una @ref{44d0,,Tuple} y contener un @ref{4502,,Slice}. @code{ctx} es @ref{30c,,Load}, @ref{44d1,,Store} or @ref{44d4,,Del} de acuerdo a la acción tomada con el subíndice.

@example
>>> print(ast.dump(ast.parse('l[1:2, 3]', mode='eval'), indent=4))
Expression(
    body=Subscript(
        value=Name(id='l', ctx=Load()),
        slice=Tuple(
            elts=[
                Slice(
                    lower=Constant(value=1),
                    upper=Constant(value=2)),
                Constant(value=3)],
            ctx=Load()),
        ctx=Load()))
@end example
@end deffn

@geindex Slice (clase en ast)
@anchor{library/ast ast Slice}@anchor{4502}
@deffn {Clase} ast.Slice (lower, upper, step)

Una segmentación regular (en la forma @code{lower:upper} o @code{lower:upper:step}). Puede ocurrir solamente dentro del campo `slice' de @ref{4501,,Subscript}, ya sea directamente o como un elemento de @ref{44d0,,Tuple}.

@example
>>> print(ast.dump(ast.parse('l[1:2]', mode='eval'), indent=4))
Expression(
    body=Subscript(
        value=Name(id='l', ctx=Load()),
        slice=Slice(
            lower=Constant(value=1),
            upper=Constant(value=2)),
        ctx=Load()))
@end example
@end deffn

@node Comprensiones,,Subindexado,Expresiones<2>
@anchor{library/ast comprehensions}@anchor{4503}
@subsubsection Comprensiones


@geindex ListComp (clase en ast)
@geindex SetComp (clase en ast)
@geindex GeneratorExp (clase en ast)
@geindex DictComp (clase en ast)
@anchor{library/ast ast ListComp}@anchor{4504}
@deffn {Clase} ast.ListComp (elt, generators)
@anchor{library/ast ast SetComp}@anchor{4505}
@deffnx {Clase} ast.SetComp (elt, generators)
@anchor{library/ast ast GeneratorExp}@anchor{4506}
@deffnx {Clase} ast.GeneratorExp (elt, generators)
@anchor{library/ast ast DictComp}@anchor{4507}
@deffnx {Clase} ast.DictComp (key, value, generators)

Listas y sets por comprensión, expresiones de generadores, y diccionarios por comprensión. @code{elt} (o @code{key} y @code{value}) es un único nodo que representa la parte que va a ser evaluada por cada item.

@code{generators} es una lista de nodos @ref{4508,,comprehension}.

@example
>>> print(ast.dump(
...     ast.parse('[x for x in numbers]', mode='eval'),
...     indent=4,
... ))
Expression(
    body=ListComp(
        elt=Name(id='x', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
>>> print(ast.dump(
...     ast.parse('@{x: x**2 for x in numbers@}', mode='eval'),
...     indent=4,
... ))
Expression(
    body=DictComp(
        key=Name(id='x', ctx=Load()),
        value=BinOp(
            left=Name(id='x', ctx=Load()),
            op=Pow(),
            right=Constant(value=2)),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
>>> print(ast.dump(
...     ast.parse('@{x for x in numbers@}', mode='eval'),
...     indent=4,
... ))
Expression(
    body=SetComp(
        elt=Name(id='x', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
@end example
@end deffn

@geindex comprehension (clase en ast)
@anchor{library/ast ast comprehension}@anchor{4508}
@deffn {Clase} ast.comprehension (target, iter, ifs, is_async)

Una cláusula @code{for} en una comprensión. @code{target} es la referencia a usarse por cada elemento - típicamente un nodo @ref{1948,,Name} o @ref{44d0,,Tuple}. @code{iter} es el objeto por el cual se itera. @code{ifs} es una lista de expresiones de prueba: cada cláusula @code{for} puede tener múltiples @code{ifs}.

@code{is_async} indica que una compresión es asíncrona (usando @code{async for} en lugar de @code{for}). El valor es un entero (0 o 1).

@example
>>> print(ast.dump(ast.parse('[ord(c) for line in file for c in line]', mode='eval'),
...                indent=4)) # Multiple comprehensions in one.
Expression(
    body=ListComp(
        elt=Call(
            func=Name(id='ord', ctx=Load()),
            args=[
                Name(id='c', ctx=Load())]),
        generators=[
            comprehension(
                target=Name(id='line', ctx=Store()),
                iter=Name(id='file', ctx=Load()),
                is_async=0),
            comprehension(
                target=Name(id='c', ctx=Store()),
                iter=Name(id='line', ctx=Load()),
                is_async=0)]))

>>> print(ast.dump(ast.parse('(n**2 for n in it if n>5 if n<10)', mode='eval'),
...                indent=4)) # generator comprehension
Expression(
    body=GeneratorExp(
        elt=BinOp(
            left=Name(id='n', ctx=Load()),
            op=Pow(),
            right=Constant(value=2)),
        generators=[
            comprehension(
                target=Name(id='n', ctx=Store()),
                iter=Name(id='it', ctx=Load()),
                ifs=[
                    Compare(
                        left=Name(id='n', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=5)]),
                    Compare(
                        left=Name(id='n', ctx=Load()),
                        ops=[
                            Lt()],
                        comparators=[
                            Constant(value=10)])],
                is_async=0)]))

>>> print(ast.dump(ast.parse('[i async for i in soc]', mode='eval'),
...                indent=4)) # Async comprehension
Expression(
    body=ListComp(
        elt=Name(id='i', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='i', ctx=Store()),
                iter=Name(id='soc', ctx=Load()),
                is_async=1)]))
@end example
@end deffn

@node Declaraciones,Control de flujo,Expresiones<2>,Clases nodo
@anchor{library/ast ast-statements}@anchor{44c8}@anchor{library/ast statements}@anchor{4509}
@subsubsection Declaraciones


@geindex Assign (clase en ast)
@anchor{library/ast ast Assign}@anchor{44ff}
@deffn {Clase} ast.Assign (targets, value, type_comment)

Una asignación. @code{targets} es una lista de nodos, y @code{value} es un nodo único.

Nodos múltiples en @code{targets} representa asignar el mismo valor a cada uno. El desempaquetado se representa poniendo una @ref{44d0,,Tuple} o @ref{44cf,,List} en @code{targets}.

@geindex type_comment (atributo de ast.Assign)
@anchor{library/ast ast Assign type_comment}@anchor{450a}
@deffn {Atributo} type_comment

@code{type_comment} es una cadena de caracteres opcional con la anotación de tipos como comentario.
@end deffn

@example
>>> print(ast.dump(ast.parse('a = b = 1'), indent=4)) # Multiple assignment
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store()),
                Name(id='b', ctx=Store())],
            value=Constant(value=1))])

>>> print(ast.dump(ast.parse('a,b = c'), indent=4)) # Unpacking
Module(
    body=[
        Assign(
            targets=[
                Tuple(
                    elts=[
                        Name(id='a', ctx=Store()),
                        Name(id='b', ctx=Store())],
                    ctx=Store())],
            value=Name(id='c', ctx=Load()))])
@end example
@end deffn

@geindex AnnAssign (clase en ast)
@anchor{library/ast ast AnnAssign}@anchor{450b}
@deffn {Clase} ast.AnnAssign (target, annotation, value, simple)

An assignment with a type annotation. @code{target} is a single node and can
be a @ref{1948,,Name}, an @ref{44fb,,Attribute} or a @ref{4501,,Subscript}.
@code{annotation} is the annotation, such as a @ref{211,,Constant} or @ref{1948,,Name}
node. @code{value} is a single optional node.

@code{simple} is always either 0 (indicating a «complex» target) or 1
(indicating a «simple» target). A «simple» target consists solely of a
@ref{1948,,Name} node that does not appear between parentheses; all other
targets are considered complex. Only simple targets appear in
the @ref{e08,,__annotations__} dictionary of modules and classes.

@example
>>> print(ast.dump(ast.parse('c: int'), indent=4))
Module(
    body=[
        AnnAssign(
            target=Name(id='c', ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=1)])

>>> print(ast.dump(ast.parse('(a): int = 1'), indent=4)) # Annotation with parenthesis
Module(
    body=[
        AnnAssign(
            target=Name(id='a', ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            value=Constant(value=1),
            simple=0)])

>>> print(ast.dump(ast.parse('a.b: int'), indent=4)) # Attribute annotation
Module(
    body=[
        AnnAssign(
            target=Attribute(
                value=Name(id='a', ctx=Load()),
                attr='b',
                ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=0)])

>>> print(ast.dump(ast.parse('a[1]: int'), indent=4)) # Subscript annotation
Module(
    body=[
        AnnAssign(
            target=Subscript(
                value=Name(id='a', ctx=Load()),
                slice=Constant(value=1),
                ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=0)])
@end example
@end deffn

@geindex AugAssign (clase en ast)
@anchor{library/ast ast AugAssign}@anchor{450c}
@deffn {Clase} ast.AugAssign (target, op, value)

Asignación aumentada, como @code{a+=1}. En el siguiente ejemplo, @code{target} es un nodo @ref{1948,,Name} para @code{x} (con el contexto @ref{44d1,,Store}), @code{op} es @ref{44e0,,Add} y @code{value} es un @ref{211,,Constant} con valor 1.

El atributo @code{target} no puede ser de clase @ref{44d0,,Tuple} o @ref{44cf,,List}, a diferencia de los objetivos de @ref{44ff,,Assign}.

@example
>>> print(ast.dump(ast.parse('x += 2'), indent=4))
Module(
    body=[
        AugAssign(
            target=Name(id='x', ctx=Store()),
            op=Add(),
            value=Constant(value=2))])
@end example
@end deffn

@geindex Raise (clase en ast)
@anchor{library/ast ast Raise}@anchor{450d}
@deffn {Clase} ast.Raise (exc, cause)

Una declaración @code{raise}. @code{exc} es el objeto de excepción a ser lanzado, normalmente un @ref{44d6,,Call} or @ref{1948,,Name}, o @code{None} para un @code{raise} solo. @code{cause} es la parte opcional para @code{y} en @code{raise x from y}.

@example
>>> print(ast.dump(ast.parse('raise x from y'), indent=4))
Module(
    body=[
        Raise(
            exc=Name(id='x', ctx=Load()),
            cause=Name(id='y', ctx=Load()))])
@end example
@end deffn

@geindex Assert (clase en ast)
@anchor{library/ast ast Assert}@anchor{450e}
@deffn {Clase} ast.Assert (test, msg)

Una aserción. @code{test} contiene la condición, como un nodo @ref{44f0,,Compare}. @code{msg} contiene el mensaje de fallo.

@example
>>> print(ast.dump(ast.parse('assert x,y'), indent=4))
Module(
    body=[
        Assert(
            test=Name(id='x', ctx=Load()),
            msg=Name(id='y', ctx=Load()))])
@end example
@end deffn

@geindex Delete (clase en ast)
@anchor{library/ast ast Delete}@anchor{450f}
@deffn {Clase} ast.Delete (targets)

Contiene una declaración @code{del}. @code{targets} es una lista de nodos, como nodos @ref{1948,,Name}, @ref{44fb,,Attribute} o @ref{4501,,Subscript}.

@example
>>> print(ast.dump(ast.parse('del x,y,z'), indent=4))
Module(
    body=[
        Delete(
            targets=[
                Name(id='x', ctx=Del()),
                Name(id='y', ctx=Del()),
                Name(id='z', ctx=Del())])])
@end example
@end deffn

@geindex Pass (clase en ast)
@anchor{library/ast ast Pass}@anchor{4510}
@deffn {Clase} ast.Pass

Una declaración @code{pass}.

@example
>>> print(ast.dump(ast.parse('pass'), indent=4))
Module(
    body=[
        Pass()])
@end example
@end deffn

@geindex TypeAlias (clase en ast)
@anchor{library/ast ast TypeAlias}@anchor{16ea}
@deffn {Clase} ast.TypeAlias (name, type_params, value)

Un alias @ref{500,,type alias} creado mediante la sentencia @ref{4e6,,type}. @code{name} es el nombre del alias, @code{type_params} es una lista de parámetros @ref{4511,,type}, y @code{value} es el valor del alias de tipo.

@example
>>> print(ast.dump(ast.parse('type Alias = int'), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            value=Name(id='int', ctx=Load()))])
@end example


Added in version 3.12.

@end deffn

Otras declaraciones que solo son aplicables dentro de funciones o bucles descritos en otras secciones.

@menu
* Importaciones:: 

@end menu

@node Importaciones,,,Declaraciones
@anchor{library/ast imports}@anchor{4512}
@subsubsection Importaciones


@geindex Import (clase en ast)
@anchor{library/ast ast Import}@anchor{4513}
@deffn {Clase} ast.Import (names)

Una declaración de importación. @code{names} es una lista de nodos @ref{18c7,,alias}.

@example
>>> print(ast.dump(ast.parse('import x,y,z'), indent=4))
Module(
    body=[
        Import(
            names=[
                alias(name='x'),
                alias(name='y'),
                alias(name='z')])])
@end example
@end deffn

@geindex ImportFrom (clase en ast)
@anchor{library/ast ast ImportFrom}@anchor{4514}
@deffn {Clase} ast.ImportFrom (module, names, level)

Representa @code{form x import y}. @code{module} es una cadena de caracteres sin formato del nombre “from”, sin puntos, o @code{None} para declaraciones como @code{from . import foo}. @code{level} es un entero que contiene el nivel relativo de la importación (0 significa una importación absoluta).

@example
>>> print(ast.dump(ast.parse('from y import x,y,z'), indent=4))
Module(
    body=[
        ImportFrom(
            module='y',
            names=[
                alias(name='x'),
                alias(name='y'),
                alias(name='z')],
            level=0)])
@end example
@end deffn

@geindex alias (clase en ast)
@anchor{library/ast ast alias}@anchor{18c7}
@deffn {Clase} ast.alias (name, asname)

Ambos parámetros son cadenas de caracteres sin formato para los nombres. @code{asname} puede ser @code{None} si se va a usar el nombre regular.

@example
>>> print(ast.dump(ast.parse('from ..foo.bar import a as b, c'), indent=4))
Module(
    body=[
        ImportFrom(
            module='foo.bar',
            names=[
                alias(name='a', asname='b'),
                alias(name='c')],
            level=2)])
@end example
@end deffn

@node Control de flujo,La coincidencia de patrones,Declaraciones,Clases nodo
@anchor{library/ast control-flow}@anchor{4515}
@subsubsection Control de flujo


@cartouche
@quotation Nota 
Cláusulas opcionales como @code{else} se guardan como una lista vacía si no están presentes.
@end quotation
@end cartouche

@geindex If (clase en ast)
@anchor{library/ast ast If}@anchor{4516}
@deffn {Clase} ast.If (test, body, orelse)

Una declaración @code{if}. @code{test} contiene un único nodo, como un nodo @ref{44f0,,Compare}. @code{body} y @code{orelse} contiene cada uno una lista de nodos.

Cláusulas @code{elif} no tienen una representación especial en AST, pero pueden aparecer como nodos extra @ref{4516,,If} dentro de la sección @code{orelse} del nodo anterior.

@example
>>> print(ast.dump(ast.parse("""
... if x:
...    ...
... elif y:
...    ...
... else:
...    ...
... """), indent=4))
Module(
    body=[
        If(
            test=Name(id='x', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                If(
                    test=Name(id='y', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))],
                    orelse=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example
@end deffn

@geindex For (clase en ast)
@anchor{library/ast ast For}@anchor{4517}
@deffn {Clase} ast.For (target, iter, body, orelse, type_comment)

Un bucle @code{for}. @code{target} contiene las variables a las que asigna el bucle, como un único nodo @ref{1948,,Name}, @ref{44d0,,Tuple}, @ref{44cf,,List}, @ref{44fb,,Attribute} o @ref{4501,,Subscript}. @code{iter} contiene el elemento sobre el que se realizará el bucle, nuevamente como un solo nodo. @code{body} y @code{orelse} contienen listas de nodos para ejecutar. Los de @code{orelse} se ejecutan si el ciclo finaliza normalmente, en lugar de mediante una instrucción @code{break}.

@geindex type_comment (atributo de ast.For)
@anchor{library/ast ast For type_comment}@anchor{4518}
@deffn {Atributo} type_comment

@code{type_comment} es una cadena de caracteres opcional con la anotación de tipos como comentario.
@end deffn

@example
>>> print(ast.dump(ast.parse("""
... for x in y:
...     ...
... else:
...     ...
... """), indent=4))
Module(
    body=[
        For(
            target=Name(id='x', ctx=Store()),
            iter=Name(id='y', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex While (clase en ast)
@anchor{library/ast ast While}@anchor{4519}
@deffn {Clase} ast.While (test, body, orelse)

Un bucle @code{while}. @code{test} contiene la condición, como un nodo @ref{44f0,,Compare}.

@example
>> print(ast.dump(ast.parse("""
... while x:
...    ...
... else:
...    ...
... """), indent=4))
Module(
    body=[
        While(
            test=Name(id='x', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex Break (clase en ast)
@geindex Continue (clase en ast)
@anchor{library/ast ast Break}@anchor{451a}
@deffn {Clase} ast.Break
@anchor{library/ast ast Continue}@anchor{451b}
@deffnx {Clase} ast.Continue

Las declaraciones @code{break} y @code{continue}.

@example
>>> print(ast.dump(ast.parse("""\
... for a in b:
...     if a > 5:
...         break
...     else:
...         continue
...
... """), indent=4))
Module(
    body=[
        For(
            target=Name(id='a', ctx=Store()),
            iter=Name(id='b', ctx=Load()),
            body=[
                If(
                    test=Compare(
                        left=Name(id='a', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=5)]),
                    body=[
                        Break()],
                    orelse=[
                        Continue()])])])
@end example
@end deffn

@geindex Try (clase en ast)
@anchor{library/ast ast Try}@anchor{451c}
@deffn {Clase} ast.Try (body, handlers, orelse, finalbody)

Bloques @code{try}. Todos los atributos son listas de nodos a ejecutar, excepto para @code{handlers}, el cual es una lista de nodos @ref{451d,,ExceptHandler}.

@example
>>> print(ast.dump(ast.parse("""
... try:
...    ...
... except Exception:
...    ...
... except OtherException as e:
...    ...
... else:
...    ...
... finally:
...    ...
... """), indent=4))
Module(
    body=[
        Try(
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            handlers=[
                ExceptHandler(
                    type=Name(id='Exception', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                ExceptHandler(
                    type=Name(id='OtherException', ctx=Load()),
                    name='e',
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))],
            finalbody=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex TryStar (clase en ast)
@anchor{library/ast ast TryStar}@anchor{451e}
@deffn {Clase} ast.TryStar (body, handlers, orelse, finalbody)

Bloques @code{try} que van seguidos de cláusulas @code{except*}. Los atributos son los mismos que para @ref{451c,,Try} pero los nodos @ref{451d,,ExceptHandler} en @code{handlers} se interpretan como bloques @code{except*} en lugar de @code{except}.

@example
>>> print(ast.dump(ast.parse("""
... try:
...    ...
... except* Exception:
...    ...
... """), indent=4))
Module(
    body=[
        TryStar(
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            handlers=[
                ExceptHandler(
                    type=Name(id='Exception', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.11.

@end deffn

@geindex ExceptHandler (clase en ast)
@anchor{library/ast ast ExceptHandler}@anchor{451d}
@deffn {Clase} ast.ExceptHandler (type, name, body)

Una sola cláusula @code{except}. @code{type} es el tipo de excepción con el que coincidirá, normalmente un nodo @ref{1948,,Name} (o @code{None} para una cláusula @code{except:} generalizada). @code{name} es una cadena sin formato para que el nombre contenga la excepción, o @code{None} si la cláusula no tiene @code{as foo}. @code{body} es una lista de nodos.

@example
>>> print(ast.dump(ast.parse("""\
... try:
...     a + 1
... except TypeError:
...     pass
... """), indent=4))
Module(
    body=[
        Try(
            body=[
                Expr(
                    value=BinOp(
                        left=Name(id='a', ctx=Load()),
                        op=Add(),
                        right=Constant(value=1)))],
            handlers=[
                ExceptHandler(
                    type=Name(id='TypeError', ctx=Load()),
                    body=[
                        Pass()])])])
@end example
@end deffn

@geindex With (clase en ast)
@anchor{library/ast ast With}@anchor{451f}
@deffn {Clase} ast.With (items, body, type_comment)

Un bloque @code{with}. @code{items} es una lista de nodos @ref{4520,,withitem} que representan los administradores de contexto, y @code{body} es el bloque con sangría dentro del contexto.

@geindex type_comment (atributo de ast.With)
@anchor{library/ast ast With type_comment}@anchor{4521}
@deffn {Atributo} type_comment

@code{type_comment} es una cadena de caracteres opcional con la anotación de tipos como comentario.
@end deffn
@end deffn

@geindex withitem (clase en ast)
@anchor{library/ast ast withitem}@anchor{4520}
@deffn {Clase} ast.withitem (context_expr, optional_vars)

Un administrador de contexto único en un bloque @code{with}. @code{context_expr} es el administrador de contexto, a menudo un nodo @ref{44d6,,Call}. @code{optional_vars} es un @ref{1948,,Name}, @ref{44d0,,Tuple} o @ref{44cf,,List} para la parte @code{as foo}, o @code{None} si no se usa.

@example
>>> print(ast.dump(ast.parse("""\
... with a as b, c as d:
...    something(b, d)
... """), indent=4))
Module(
    body=[
        With(
            items=[
                withitem(
                    context_expr=Name(id='a', ctx=Load()),
                    optional_vars=Name(id='b', ctx=Store())),
                withitem(
                    context_expr=Name(id='c', ctx=Load()),
                    optional_vars=Name(id='d', ctx=Store()))],
            body=[
                Expr(
                    value=Call(
                        func=Name(id='something', ctx=Load()),
                        args=[
                            Name(id='b', ctx=Load()),
                            Name(id='d', ctx=Load())]))])])
@end example
@end deffn

@node La coincidencia de patrones,Tipos de parámetro,Control de flujo,Clases nodo
@anchor{library/ast pattern-matching}@anchor{4522}
@subsubsection La coincidencia de patrones


@geindex Match (clase en ast)
@anchor{library/ast ast Match}@anchor{4523}
@deffn {Clase} ast.Match (subject, cases)

Una declaración @code{match}. @code{subject} contiene el sujeto de la coincidencia (el objeto que se compara con los casos) y @code{cases} contiene un iterable de nodos @ref{4524,,match_case} con los diferentes casos.


Added in version 3.10.

@end deffn

@geindex match_case (clase en ast)
@anchor{library/ast ast match_case}@anchor{4524}
@deffn {Clase} ast.match_case (pattern, guard, body)

Un patrón de caso único en una declaración @code{match}. @code{pattern} contiene el patrón de coincidencia con el que se comparará el sujeto. Tenga en cuenta que los nodos @ref{30d,,AST} producidos para patrones difieren de los producidos para expresiones, incluso cuando comparten la misma sintaxis.

El atributo @code{guard} contiene una expresión que se evaluará si el patrón coincide con el sujeto.

@code{body} contiene una lista de nodos para ejecutar si el patrón coincide y el resultado de evaluar la expresión de protección es verdadero.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] if x>0:
...         ...
...     case tuple():
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchAs(name='x')]),
                    guard=Compare(
                        left=Name(id='x', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=0)]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='tuple', ctx=Load())),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchValue (clase en ast)
@anchor{library/ast ast MatchValue}@anchor{4525}
@deffn {Clase} ast.MatchValue (value)

Un patrón de valor o literal de coincidencia que se compara por igualdad. @code{value} es un nodo de expresión. Los nodos de valores permitidos están restringidos como se describe en la documentación de la declaración de coincidencia. Este patrón tiene éxito si el sujeto de la coincidencia es igual al valor evaluado.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case "Relevant":
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchValue(
                        value=Constant(value='Relevant')),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchSingleton (clase en ast)
@anchor{library/ast ast MatchSingleton}@anchor{4526}
@deffn {Clase} ast.MatchSingleton (value)

Un patrón literal de coincidencia que se compara por identidad. @code{value} es el singleton que se va a comparar con: @code{None}, @code{True} o @code{False}. Este patrón tiene éxito si el sujeto de la coincidencia es la constante dada.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case None:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSingleton(value=None),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchSequence (clase en ast)
@anchor{library/ast ast MatchSequence}@anchor{4527}
@deffn {Clase} ast.MatchSequence (patterns)

Un patrón de secuencia de coincidencia. @code{patterns} contiene los patrones que se compararán con los elementos del sujeto si el sujeto es una secuencia. Coincide con una secuencia de longitud variable si uno de los subpatrones es un nodo @code{MatchStar}; de lo contrario, coincide con una secuencia de longitud fija.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [1, 2]:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchValue(
                                value=Constant(value=1)),
                            MatchValue(
                                value=Constant(value=2))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchStar (clase en ast)
@anchor{library/ast ast MatchStar}@anchor{4528}
@deffn {Clase} ast.MatchStar (name)

Coincide con el resto de la secuencia en un patrón de secuencia de coincidencia de longitud variable. Si @code{name} no es @code{None}, una lista que contiene los elementos de secuencia restantes está vinculada a ese nombre si el patrón de secuencia general es exitoso.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [1, 2, *rest]:
...         ...
...     case [*_]:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchValue(
                                value=Constant(value=1)),
                            MatchValue(
                                value=Constant(value=2)),
                            MatchStar(name='rest')]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchStar()]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchMapping (clase en ast)
@anchor{library/ast ast MatchMapping}@anchor{4529}
@deffn {Clase} ast.MatchMapping (keys, patterns, rest)

Un patrón de mapeo de coincidencias. @code{keys} es una secuencia de nodos de expresión. @code{patterns} es una secuencia correspondiente de nodos de patrón. @code{rest} es un nombre opcional que se puede especificar para capturar los elementos de mapeo restantes. Las expresiones clave permitidas están restringidas como se describe en la documentación de la declaración de coincidencia.

Este patrón tiene éxito si el sujeto es un mapeo, todas las expresiones clave evaluadas están presentes en el mapeo y el valor correspondiente a cada clave coincide con el subpatrón correspondiente. Si @code{rest} no es @code{None}, un dict que contiene los elementos de mapeo restantes se vincula a ese nombre si el patrón de mapeo general es exitoso.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case @{1: _, 2: _@}:
...         ...
...     case @{**rest@}:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchMapping(
                        keys=[
                            Constant(value=1),
                            Constant(value=2)],
                        patterns=[
                            MatchAs(),
                            MatchAs()]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchMapping(rest='rest'),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchClass (clase en ast)
@anchor{library/ast ast MatchClass}@anchor{452a}
@deffn {Clase} ast.MatchClass (cls, patterns, kwd_attrs, kwd_patterns)

Un patrón de clase coincidente. @code{cls} es una expresión que da la clase nominal que se va a emparejar. @code{patterns} es una secuencia de nodos de patrón que se compararán con la secuencia definida por la clase de atributos de coincidencia de patrones. @code{kwd_attrs} es una secuencia de atributos adicionales que deben coincidir (especificados como argumentos de palabra clave en el patrón de clase), @code{kwd_patterns} son los patrones correspondientes (especificados como valores de palabras clave en el patrón de clase).

Este patrón tiene éxito si el sujeto es una instancia de la clase nominada, todos los patrones posicionales coinciden con los atributos definidos por la clase correspondientes y cualquier atributo de palabra clave especificado coincide con su patrón correspondiente.

Nota: las clases pueden definir una propiedad que retorna self para hacer coincidir un nodo de patrón con la instancia que se está comparando. Varios tipos incorporados también se combinan de esa manera, como se describe en la documentación de la declaración de coincidencia.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case Point2D(0, 0):
...         ...
...     case Point3D(x=0, y=0, z=0):
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='Point2D', ctx=Load()),
                        patterns=[
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='Point3D', ctx=Load()),
                        kwd_attrs=[
                            'x',
                            'y',
                            'z'],
                        kwd_patterns=[
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchAs (clase en ast)
@anchor{library/ast ast MatchAs}@anchor{452b}
@deffn {Clase} ast.MatchAs (pattern, name)

Una coincidencia «como patrón», patrón de captura o patrón comodín. @code{pattern} contiene el patrón de coincidencia con el que se comparará el sujeto. Si el patrón es @code{None}, el nodo representa un patrón de captura (es decir, un nombre simple) y siempre tendrá éxito.

El atributo @code{name} contiene el nombre que se vinculará si el patrón tiene éxito. Si @code{name} es @code{None}, @code{pattern} también debe ser @code{None} y el nodo representa el patrón comodín.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] as y:
...         ...
...     case _:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchAs(
                        pattern=MatchSequence(
                            patterns=[
                                MatchAs(name='x')]),
                        name='y'),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchAs(),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchOr (clase en ast)
@anchor{library/ast ast MatchOr}@anchor{452c}
@deffn {Clase} ast.MatchOr (patterns)

Una coincidencia «o patrón». Un patrón-o hace coincidir cada uno de sus subpatrones con el sujeto, hasta que uno tiene éxito. Entonces se considera que el patrón-o tiene éxito. Si ninguno de los subpatrones tiene éxito, el patrón o falla. El atributo @code{patterns} contiene una lista de nodos de patrones de coincidencia que se compararán con el sujeto.

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] | (y):
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchOr(
                        patterns=[
                            MatchSequence(
                                patterns=[
                                    MatchAs(name='x')]),
                            MatchAs(name='y')]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@node Tipos de parámetro,Definiciones de función y clase,La coincidencia de patrones,Clases nodo
@anchor{library/ast ast-type-params}@anchor{4511}@anchor{library/ast type-parameters}@anchor{452d}
@subsubsection Tipos de parámetro


«@ref{3fc,,Parámetros de tipo} pueden existir en clases, funciones y tipos de alias»

@geindex TypeVar (clase en ast)
@anchor{library/ast ast TypeVar}@anchor{452e}
@deffn {Clase} ast.TypeVar (name, bound, default_value)

A @ref{2c9,,typing.TypeVar}. @code{name} is the name of the type variable.
@code{bound} is the bound or constraints, if any. If @code{bound} is a @ref{44d0,,Tuple},
it represents constraints; otherwise it represents the bound. @code{default_value}
is the default value; if the @code{TypeVar} has no default, this
attribute will be set to @code{None}.

@example
>>> print(ast.dump(ast.parse("type Alias[T: int = bool] = list[T]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                TypeVar(
                    name='T',
                    bound=Name(id='int', ctx=Load()),
                    default_value=Name(id='bool', ctx=Load()))],
            value=Subscript(
                value=Name(id='list', ctx=Load()),
                slice=Name(id='T', ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



Distinto en la versión 3.13: Added the `default_value' parameter.

@end deffn

@geindex ParamSpec (clase en ast)
@anchor{library/ast ast ParamSpec}@anchor{452f}
@deffn {Clase} ast.ParamSpec (name, default_value)

A @ref{2ca,,typing.ParamSpec}. @code{name} is the name of the parameter specification.
@code{default_value} is the default value; if the @code{ParamSpec} has no default,
this attribute will be set to @code{None}.

@example
>>> print(ast.dump(ast.parse("type Alias[**P = (int, str)] = Callable[P, int]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                ParamSpec(
                    name='P',
                    default_value=Tuple(
                        elts=[
                            Name(id='int', ctx=Load()),
                            Name(id='str', ctx=Load())],
                        ctx=Load()))],
            value=Subscript(
                value=Name(id='Callable', ctx=Load()),
                slice=Tuple(
                    elts=[
                        Name(id='P', ctx=Load()),
                        Name(id='int', ctx=Load())],
                    ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



Distinto en la versión 3.13: Added the `default_value' parameter.

@end deffn

@geindex TypeVarTuple (clase en ast)
@anchor{library/ast ast TypeVarTuple}@anchor{4530}
@deffn {Clase} ast.TypeVarTuple (name, default_value)

A @ref{2cb,,typing.TypeVarTuple}. @code{name} is the name of the type variable tuple.
@code{default_value} is the default value; if the @code{TypeVarTuple} has no
default, this attribute will be set to @code{None}.

@example
>>> print(ast.dump(ast.parse("type Alias[*Ts = ()] = tuple[*Ts]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                TypeVarTuple(
                    name='Ts',
                    default_value=Tuple(ctx=Load()))],
            value=Subscript(
                value=Name(id='tuple', ctx=Load()),
                slice=Tuple(
                    elts=[
                        Starred(
                            value=Name(id='Ts', ctx=Load()),
                            ctx=Load())],
                    ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



Distinto en la versión 3.13: Added the `default_value' parameter.

@end deffn

@node Definiciones de función y clase,Async y await,Tipos de parámetro,Clases nodo
@anchor{library/ast function-and-class-definitions}@anchor{4531}
@subsubsection Definiciones de función y clase


@geindex FunctionDef (clase en ast)
@anchor{library/ast ast FunctionDef}@anchor{170d}
@deffn {Clase} ast.FunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

Una definición de función.


@itemize *

@item 
@code{name} es una cadena de caracteres sin formato del nombre de la función.

@item 
@code{args} es un nodo @ref{4532,,arguments}.

@item 
@code{body} es la lista de nodos dentro de la función.

@item 
@code{decorator_list} es la lista de decoradores que se aplicarán, almacenados en el exterior primero (es decir, el primero de la lista se aplicará al final).

@item 
@code{returns} es la anotación de retorno.

@item 
@code{type_params} es una lista de  @ref{4511,,parametros de tipo}.
@end itemize

@geindex type_comment (atributo de ast.FunctionDef)
@anchor{library/ast ast FunctionDef type_comment}@anchor{4533}
@deffn {Atributo} type_comment

@code{type_comment} es una cadena de caracteres opcional con la anotación de tipos como comentario.
@end deffn


Distinto en la versión 3.12: Se ha añadido @code{type_params}.

@end deffn

@geindex Lambda (clase en ast)
@anchor{library/ast ast Lambda}@anchor{44d9}
@deffn {Clase} ast.Lambda (args, body)

@code{lambda} es una definición de función mínima que se puede utilizar dentro de una expresión. A diferencia de @ref{170d,,FunctionDef}, @code{body} tiene un solo nodo.

@example
>>> print(ast.dump(ast.parse('lambda x,y: ...'), indent=4))
Module(
    body=[
        Expr(
            value=Lambda(
                args=arguments(
                    args=[
                        arg(arg='x'),
                        arg(arg='y')]),
                body=Constant(value=Ellipsis)))])
@end example
@end deffn

@geindex arguments (clase en ast)
@anchor{library/ast ast arguments}@anchor{4532}
@deffn {Clase} ast.arguments (posonlyargs, args, vararg, kwonlyargs, kw_defaults, kwarg, defaults)

Los argumentos para una función.


@itemize *

@item 
@code{posonlyargs}, @code{args} y @code{kwonlyargs} son listas de nodos @ref{4534,,arg}.

@item 
@code{vararg} y @code{kwarg} son nodos @ref{4534,,arg} únicos, en referencia a los parámetros @code{*args, **kwargs}.

@item 
@code{kw_defaults} es una lista de valores predeterminados para argumentos de solo palabras clave. Si uno es @code{None}, se requiere el argumento correspondiente.

@item 
@code{defaults} es una lista de valores predeterminados para argumentos que se pueden pasar posicionalmente. Si hay menos valores predeterminados, corresponden a los últimos n argumentos.
@end itemize
@end deffn

@geindex arg (clase en ast)
@anchor{library/ast ast arg}@anchor{4534}
@deffn {Clase} ast.arg (arg, annotation, type_comment)

A single argument in a list. @code{arg} is a raw string of the argument
name; @code{annotation} is its annotation, such as a @ref{1948,,Name} node.

@geindex type_comment (atributo de ast.arg)
@anchor{library/ast ast arg type_comment}@anchor{4535}
@deffn {Atributo} type_comment

@code{type_comment} es una cadena opcional con la anotación de tipo como comentario
@end deffn

@example
>>> print(ast.dump(ast.parse("""\
... @@decorator1
... @@decorator2
... def f(a: 'annotation', b=1, c=2, *d, e, f=3, **g) -> 'return annotation':
...     pass
... """), indent=4))
Module(
    body=[
        FunctionDef(
            name='f',
            args=arguments(
                args=[
                    arg(
                        arg='a',
                        annotation=Constant(value='annotation')),
                    arg(arg='b'),
                    arg(arg='c')],
                vararg=arg(arg='d'),
                kwonlyargs=[
                    arg(arg='e'),
                    arg(arg='f')],
                kw_defaults=[
                    None,
                    Constant(value=3)],
                kwarg=arg(arg='g'),
                defaults=[
                    Constant(value=1),
                    Constant(value=2)]),
            body=[
                Pass()],
            decorator_list=[
                Name(id='decorator1', ctx=Load()),
                Name(id='decorator2', ctx=Load())],
            returns=Constant(value='return annotation'))])
@end example
@end deffn

@geindex Return (clase en ast)
@anchor{library/ast ast Return}@anchor{4536}
@deffn {Clase} ast.Return (value)

Una declaración @code{return}.

@example
>>> print(ast.dump(ast.parse('return 4'), indent=4))
Module(
    body=[
        Return(
            value=Constant(value=4))])
@end example
@end deffn

@geindex Yield (clase en ast)
@geindex YieldFrom (clase en ast)
@anchor{library/ast ast Yield}@anchor{44da}
@deffn {Clase} ast.Yield (value)
@anchor{library/ast ast YieldFrom}@anchor{44db}
@deffnx {Clase} ast.YieldFrom (value)

A @code{yield} or @code{yield from} expression. Because these are expressions, they
must be wrapped in an @ref{44d8,,Expr} node if the value sent back is not used.

@example
>>> print(ast.dump(ast.parse('yield x'), indent=4))
Module(
    body=[
        Expr(
            value=Yield(
                value=Name(id='x', ctx=Load())))])

>>> print(ast.dump(ast.parse('yield from x'), indent=4))
Module(
    body=[
        Expr(
            value=YieldFrom(
                value=Name(id='x', ctx=Load())))])
@end example
@end deffn

@geindex Global (clase en ast)
@geindex Nonlocal (clase en ast)
@anchor{library/ast ast Global}@anchor{4537}
@deffn {Clase} ast.Global (names)
@anchor{library/ast ast Nonlocal}@anchor{4538}
@deffnx {Clase} ast.Nonlocal (names)

Declaraciones @code{global} y @code{nonlocal}. @code{names} es una lista de cadenas sin formato.

@example
>>> print(ast.dump(ast.parse('global x,y,z'), indent=4))
Module(
    body=[
        Global(
            names=[
                'x',
                'y',
                'z'])])

>>> print(ast.dump(ast.parse('nonlocal x,y,z'), indent=4))
Module(
    body=[
        Nonlocal(
            names=[
                'x',
                'y',
                'z'])])
@end example
@end deffn

@geindex ClassDef (clase en ast)
@anchor{library/ast ast ClassDef}@anchor{170b}
@deffn {Clase} ast.ClassDef (name, bases, keywords, body, decorator_list, type_params)

Una definición de clase.


@itemize *

@item 
@code{name} es una cadena sin formato para el nombre de la clase

@item 
@code{bases} es una lista de nodos para clases base especificadas explícitamente.

@item 
@code{keywords} is a list of @ref{44fc,,keyword} nodes, principally for “metaclass”.
Other keywords will be passed to the metaclass, as per 
@geindex Python Enhancement Proposals; PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}.

@item 
@code{body} es una lista de nodos que representan el código dentro de la definición de clase.

@item 
@code{decorator_list} es una lista de nodos, como en @ref{170d,,FunctionDef}.

@item 
@code{type_params} es una lista de  @ref{4511,,parametros de tipo}.
@end itemize

@example
>>> print(ast.dump(ast.parse("""\
... @@decorator1
... @@decorator2
... class Foo(base1, base2, metaclass=meta):
...     pass
... """), indent=4))
Module(
    body=[
        ClassDef(
            name='Foo',
            bases=[
                Name(id='base1', ctx=Load()),
                Name(id='base2', ctx=Load())],
            keywords=[
                keyword(
                    arg='metaclass',
                    value=Name(id='meta', ctx=Load()))],
            body=[
                Pass()],
            decorator_list=[
                Name(id='decorator1', ctx=Load()),
                Name(id='decorator2', ctx=Load())])])
@end example


Distinto en la versión 3.12: Se ha añadido @code{type_params}.

@end deffn

@node Async y await,,Definiciones de función y clase,Clases nodo
@anchor{library/ast async-and-await}@anchor{4539}
@subsubsection Async y await


@geindex AsyncFunctionDef (clase en ast)
@anchor{library/ast ast AsyncFunctionDef}@anchor{170c}
@deffn {Clase} ast.AsyncFunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

Una definición de función @code{async def}. Tiene los mismos campos que @ref{170d,,FunctionDef}.


Distinto en la versión 3.12: Se ha añadido @code{type_params}.

@end deffn

@geindex Await (clase en ast)
@anchor{library/ast ast Await}@anchor{453a}
@deffn {Clase} ast.Await (value)

Una expresión @code{await}. @code{value} es lo que espera. Solo válido en el cuerpo de un @ref{170c,,AsyncFunctionDef}.
@end deffn

@example
>>> print(ast.dump(ast.parse("""\
... async def f():
...     await other_func()
... """), indent=4))
Module(
    body=[
        AsyncFunctionDef(
            name='f',
            args=arguments(),
            body=[
                Expr(
                    value=Await(
                        value=Call(
                            func=Name(id='other_func', ctx=Load()))))])])
@end example

@geindex AsyncFor (clase en ast)
@geindex AsyncWith (clase en ast)
@anchor{library/ast ast AsyncFor}@anchor{453b}
@deffn {Clase} ast.AsyncFor (target, iter, body, orelse, type_comment)
@anchor{library/ast ast AsyncWith}@anchor{453c}
@deffnx {Clase} ast.AsyncWith (items, body, type_comment)

Bucles @code{async for} y administradores de contexto @code{async with}. Tienen los mismos campos que @ref{4517,,For} y @ref{451f,,With}, respectivamente. Solo válido en el cuerpo de un @ref{170c,,AsyncFunctionDef}.
@end deffn

@cartouche
@quotation Nota 
Cuando @ref{30f,,ast.parse()} analiza una cadena, los nodos de operador (subclases de @code{ast.operator}, @code{ast.unaryop}, @code{ast.cmpop}, @code{ast.boolop} y @code{ast.expr_context}) en el árbol retornado serán singletons. Los cambios en uno se reflejarán en todas las demás ocurrencias del mismo valor (por ejemplo, @ref{44e0,,ast.Add}).
@end quotation
@end cartouche

@node Ayudantes de ast,Banderas del compilador<2>,Clases nodo,ast — Abstract Syntax Trees
@anchor{library/ast ast-helpers}@anchor{453d}
@subsubsection Ayudantes de @code{ast}


Además de las clases de nodo, el módulo @ref{9,,ast} define estas funciones y clases de utilidad para atravesar árboles de sintaxis abstracta:

@geindex parse() (en el módulo ast)
@anchor{library/ast ast parse}@anchor{30f}
@deffn {Función} ast.parse (source, filename='<unknown>', mode='exec', *, type_comments=False, feature_version=None, optimize=-1)

Parse the source into an AST node.  Equivalent to @code{compile(source,
filename, mode, flags=FLAGS_VALUE, optimize=optimize)},
where @code{FLAGS_VALUE} is @code{ast.PyCF_ONLY_AST} if @code{optimize <= 0}
and @code{ast.PyCF_OPTIMIZED_AST} otherwise.

If @code{type_comments=True} is given, the parser is modified to check
and return type comments as specified by 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} and 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}.
This is equivalent to adding @ref{453e,,ast.PyCF_TYPE_COMMENTS} to the
flags passed to @ref{2fb,,compile()}.  This will report syntax errors
for misplaced type comments.  Without this flag, type comments will
be ignored, and the @code{type_comment} field on selected AST nodes
will always be @code{None}.  In addition, the locations of @code{# type:
ignore} comments will be returned as the @code{type_ignores}
attribute of @ref{44c7,,Module} (otherwise it is always an empty list).

Además, si @code{modo} es @code{'func_type'}, la sintaxis de entrada se modifica para corresponder a 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} «comentarios de tipo de firma», por ejemplo @code{(str, int) -> List[str]}.

Setting @code{feature_version} to a tuple @code{(major, minor)} will result in
a «best-effort» attempt to parse using that Python version’s grammar.
For example, setting @code{feature_version=(3, 9)} will attempt to disallow
parsing of @ref{8a4,,match} statements.
Currently @code{major} must equal to @code{3}. The lowest supported version is
@code{(3, 7)} (and this may increase in future Python versions);
the highest is @code{sys.version_info[0:2]}. «Best-effort» attempt means there
is no guarantee that the parse (or success of the parse) is the same as
when run on the Python version corresponding to @code{feature_version}.

If source contains a null character (@code{\0}), @ref{360,,ValueError} is raised.

@cartouche
@quotation Advertencia 
Tenga en cuenta que analizar correctamente el código fuente en un objeto AST no garantiza que el código fuente proporcionado sea un código Python válido que se pueda ejecutar, ya que el paso de compilación puede lanzar más excepciones @ref{150,,SyntaxError}. Por ejemplo, la fuente @code{return 42} genera un nodo AST válido para una declaración de retorno, pero no se puede compilar solo (debe estar dentro de un nodo de función).

En particular, @ref{30f,,ast.parse()} no realizará ninguna verificación de alcance, lo que hace el paso de compilación.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Es posible bloquear el intérprete de Python con una cadena de caracteres suficientemente grande/compleja debido a las limitaciones de profundidad de pila en el compilador AST de Python.
@end quotation
@end cartouche


Distinto en la versión 3.8: Se agregaron @code{type_comments}, @code{mode='func_type'} y @code{feature_version}.



Distinto en la versión 3.13: The minimum supported version for @code{feature_version} is now @code{(3, 7)}.
The @code{optimize} argument was added.

@end deffn

@geindex unparse() (en el módulo ast)
@anchor{library/ast ast unparse}@anchor{97c}
@deffn {Función} ast.unparse (ast_obj)

Analice un objeto @ref{30d,,ast.AST} y genere una cadena con código que produciría un objeto @ref{30d,,ast.AST} equivalente si se analiza con @ref{30f,,ast.parse()}.

@cartouche
@quotation Advertencia 
La cadena de código producida no será necesariamente igual al código original que generó el objeto @ref{30d,,ast.AST} (sin ninguna optimización del compilador, como tuplas constantes / frozensets).
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
Intentar descomprimir una expresión muy compleja daría como resultado @ref{df1,,RecursionError}.
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex literal_eval() (en el módulo ast)
@anchor{library/ast ast literal_eval}@anchor{ca0}
@deffn {Función} ast.literal_eval (node_or_string)

Evalúa un nodo de expresión o una cadena de caracteres que contenga únicamente un literal de Python o visualizador de contenedor.  La cadena o nodo proporcionado sólo puede consistir en las siguientes estructuras literales de Python: cadenas de caracteres, bytes, números, tuplas, listas, diccionarios, conjuntos, booleanos, @code{None} y @code{Ellipsis}.

Esto se puede usar para evaluar de forma segura las cadenas de caracteres que contienen valores de Python sin la necesidad de analizar los valores uno mismo.  No es capaz de evaluar expresiones complejas arbitrariamente, por ejemplo, que involucran operadores o indexación.

Esta función había sido documentada como «segura» en el pasado sin definir lo que eso significaba. Eso era engañoso. Está diseñada específicamente no para ejecutar código Python, a diferencia de la más general @ref{2eb,,eval()}. No hay espacio de nombres, ni búsqueda de nombres, ni capacidad de llamada. Pero no está libre de ataques: Una entrada relativamente pequeña puede llevar a un agotamiento de la memoria o de la pila de C, haciendo colapsar el proceso. También existe la posibilidad de denegación de servicio por consumo excesivo de CPU en algunas entradas. Por lo tanto, no se recomienda llamarlo con datos no confiables.

@cartouche
@quotation Advertencia 
Es posible bloquear el intérprete de Python debido a las limitaciones de profundidad de pila en el compilador AST de Python.

Puede generar @ref{360,,ValueError}, @ref{228,,TypeError}, @ref{150,,SyntaxError}, @ref{16cb,,MemoryError} y @ref{df1,,RecursionError} dependiendo de la entrada mal formada.
@end quotation
@end cartouche


Distinto en la versión 3.2: Ahora permite bytes y establece literales.



Distinto en la versión 3.9: Ahora admite la creación de conjuntos vacíos con @code{'set()'}.



Distinto en la versión 3.10: Para las entradas de cadena, los espacios iniciales y las tabulaciones ahora se eliminan.

@end deffn

@geindex get_docstring() (en el módulo ast)
@anchor{library/ast ast get_docstring}@anchor{1a61}
@deffn {Función} ast.get_docstring (node, clean=True)

Retorna la cadena de caracteres de documentación del `node' dado (que debe ser un nodo @ref{170d,,FunctionDef}, @ref{170c,,AsyncFunctionDef}, @ref{170b,,ClassDef}, o @ref{44c7,,Module}), o @code{None} si no tiene docstring. Si `clean' es verdadero, limpia la sangría del docstring con @ref{16bd,,inspect.cleandoc()}.


Distinto en la versión 3.5: @ref{170c,,AsyncFunctionDef} ahora está soportada.

@end deffn

@geindex get_source_segment() (en el módulo ast)
@anchor{library/ast ast get_source_segment}@anchor{a69}
@deffn {Función} ast.get_source_segment (source, node, *, padded=False)

Get source code segment of the `source' that generated `node'.
If some location information (@ref{44c0,,lineno}, @ref{44c2,,end_lineno},
@ref{44c1,,col_offset}, or @ref{44c3,,end_col_offset}) is missing, return @code{None}.

Si `padded' es @code{True}, la primera línea de una declaración de varias líneas se rellenará con espacios para que coincidan con su posición original.


Added in version 3.8.

@end deffn

@geindex fix_missing_locations() (en el módulo ast)
@anchor{library/ast ast fix_missing_locations}@anchor{453f}
@deffn {Función} ast.fix_missing_locations (node)

When you compile a node tree with @ref{2fb,,compile()}, the compiler expects
@ref{44c0,,lineno} and @ref{44c1,,col_offset} attributes for every node that supports
them.  This is rather tedious to fill in for generated nodes, so this helper
adds these attributes recursively where not already set, by setting them to
the values of the parent node.  It works recursively starting at `node'.
@end deffn

@geindex increment_lineno() (en el módulo ast)
@anchor{library/ast ast increment_lineno}@anchor{179e}
@deffn {Función} ast.increment_lineno (node, n=1)

Incremente el número de línea y el número de línea final de cada nodo en el árbol comenzando en `node' por `n'. Esto es útil para «mover código» a una ubicación diferente en un archivo.
@end deffn

@geindex copy_location() (en el módulo ast)
@anchor{library/ast ast copy_location}@anchor{4540}
@deffn {Función} ast.copy_location (new_node, old_node)

Copy source location (@ref{44c0,,lineno}, @ref{44c1,,col_offset}, @ref{44c2,,end_lineno},
and @ref{44c3,,end_col_offset}) from `old_node' to `new_node' if possible,
and return `new_node'.
@end deffn

@geindex iter_fields() (en el módulo ast)
@anchor{library/ast ast iter_fields}@anchor{4541}
@deffn {Función} ast.iter_fields (node)

Produce (`yield') una tupla de @code{(fieldname, value)} para cada campo en @code{node._fields} que está presente en `node'.
@end deffn

@geindex iter_child_nodes() (en el módulo ast)
@anchor{library/ast ast iter_child_nodes}@anchor{4542}
@deffn {Función} ast.iter_child_nodes (node)

Cede todos los nodos secundarios directos de `node', es decir, todos los campos que son nodos y todos los elementos de campos que son listas de nodos.
@end deffn

@geindex walk() (en el módulo ast)
@anchor{library/ast ast walk}@anchor{4543}
@deffn {Función} ast.walk (node)

Recursivamente produce todos los nodos descendientes en el árbol comenzando en `node' (incluido `node' en sí mismo), en ningún orden especificado. Esto es útil si solo desea modificar los nodos en su lugar y no le importa el contexto.
@end deffn

@geindex NodeVisitor (clase en ast)
@anchor{library/ast ast NodeVisitor}@anchor{212}
@deffn {Clase} ast.NodeVisitor

Una clase base de visitante de nodo que recorre el árbol de sintaxis abstracta y llama a una función de visitante para cada nodo encontrado. Esta función puede retornar un valor que se reenvía mediante el método @ref{4544,,visit()}.

Esta clase está destinada a ser subclase, con la subclase agregando métodos de visitante.

@geindex visit() (método de ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor visit}@anchor{4544}
@deffn {Método} visit (node)

Visita un nodo. La implementación predeterminada llama al método llamado @code{self.visit_@var{classname}} donde `classname' es el nombre de la clase de nodo, o @ref{4545,,generic_visit()} si ese método no existe.
@end deffn

@geindex generic_visit() (método de ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor generic_visit}@anchor{4545}
@deffn {Método} generic_visit (node)

Este visitante llama @ref{4544,,visit()} en todos los hijos del nodo.

Tenga en cuenta que los nodos secundarios de los nodos que tienen un método de visitante personalizado no se visitarán a menos que el visitante llame @ref{4545,,generic_visit()} o los visite a sí mismo.
@end deffn

@geindex visit_Constant() (método de ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor visit_Constant}@anchor{afd}
@deffn {Método} visit_Constant (node)

Handles all constant nodes.
@end deffn

No use @ref{212,,NodeVisitor} si desea aplicar cambios a los nodos durante el recorrido. Para esto existe un visitante especial (@ref{4546,,NodeTransformer}) que permite modificaciones.


Obsoleto desde la versión 3.8: Methods @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()},
@code{visit_NameConstant()} and @code{visit_Ellipsis()} are deprecated
now and will not be called in future Python versions.  Add the
@ref{afd,,visit_Constant()} method to handle all constant nodes.

@end deffn

@geindex NodeTransformer (clase en ast)
@anchor{library/ast ast NodeTransformer}@anchor{4546}
@deffn {Clase} ast.NodeTransformer

Una subclase de @ref{212,,NodeVisitor} que recorre el árbol de sintaxis abstracta y permite la modificación de nodos.

La clase @ref{4546,,NodeTransformer} recorrerá el AST y usará el valor de retorno de los métodos del visitante para reemplazar o eliminar el nodo anterior. Si el valor de retorno del método de visitante es @code{None}, el nodo se eliminará de su ubicación; de lo contrario, se reemplazará con el valor de retorno. El valor de retorno puede ser el nodo original, en cuyo caso no se realiza ningún reemplazo.

Aquí hay un transformador de ejemplo que reescribe todas las apariciones de búsquedas de nombres (@code{foo}) en @code{data['foo']}:

@example
class RewriteName(NodeTransformer):

    def visit_Name(self, node):
        return Subscript(
            value=Name(id='data', ctx=Load()),
            slice=Constant(value=node.id),
            ctx=node.ctx
        )
@end example

Keep in mind that if the node you’re operating on has child nodes you must
either transform the child nodes yourself or call the @ref{4545,,generic_visit()}
method for the node first.

Para los nodos que formaban parte de una colección de declaraciones (que se aplica a todos los nodos de declaración), el visitante también puede retornar una lista de nodos en lugar de solo un nodo.

If @ref{4546,,NodeTransformer} introduces new nodes (that weren’t part of
original tree) without giving them location information (such as
@ref{44c0,,lineno}), @ref{453f,,fix_missing_locations()} should be called with
the new sub-tree to recalculate the location information:

@example
tree = ast.parse('foo', mode='eval')
new_tree = fix_missing_locations(RewriteName().visit(tree))
@end example

Usualmente usas el transformador así:

@example
node = YourTransformer().visit(node)
@end example
@end deffn

@geindex dump() (en el módulo ast)
@anchor{library/ast ast dump}@anchor{97b}
@deffn {Función} ast.dump (node, annotate_fields=True, include_attributes=False, *, indent=None, show_empty=False)

Retorna un volcado formateado del árbol en `node'. Esto es principalmente útil para propósitos de depuración. Si `annotate_fields' es verdadero (por defecto), la cadena de caracteres retornada mostrará los nombres y los valores de los campos. Si `annotate_fields' es falso, la cadena de resultados será más compacta omitiendo nombres de campo no ambiguos. Los atributos como los números de línea y las compensaciones de columna no se vuelcan de forma predeterminada. Si esto se desea, `include_attributes' se puede establecer en verdadero.

Si `indent' es un entero no negativo o una cadena de caracteres, entonces el árbol será impreso de forma linda con ese nivel de sangría.  Un nivel de sangría de 0, negativo, o @code{""} solo insertará nuevas líneas. @code{None} (el valor por defecto) selecciona la representación de línea simple. Al usar un entero positivo se sangrará esa cantidad de espacios como sangría.  Si `indent' es una cadena de caracteres (como @code{"\t"}), esa cadena se usa para sangrar cada nivel.

If `show_empty' is @code{False} (the default), empty lists and fields that are @code{None}
will be omitted from the output.


Distinto en la versión 3.9: Añadida la opción `indent'.



Distinto en la versión 3.13: Added the `show_empty' option.

@example
>>> print(ast.dump(ast.parse("""\
... async def f():
...     await other_func()
... """), indent=4, show_empty=True))
Module(
    body=[
        AsyncFunctionDef(
            name='f',
            args=arguments(
                posonlyargs=[],
                args=[],
                kwonlyargs=[],
                kw_defaults=[],
                defaults=[]),
            body=[
                Expr(
                    value=Await(
                        value=Call(
                            func=Name(id='other_func', ctx=Load()),
                            args=[],
                            keywords=[])))],
            decorator_list=[],
            type_params=[])],
    type_ignores=[])
@end example

@end deffn

@node Banderas del compilador<2>,Uso en línea de comandos,Ayudantes de ast,ast — Abstract Syntax Trees
@anchor{library/ast ast-compiler-flags}@anchor{2169}@anchor{library/ast compiler-flags}@anchor{4547}
@subsubsection Banderas del compilador


Los siguientes indicadores pueden pasarse a @ref{2fb,,compile()} para cambiar los efectos en la compilación de un programa:

@geindex PyCF_ALLOW_TOP_LEVEL_AWAIT (en el módulo ast)
@anchor{library/ast ast PyCF_ALLOW_TOP_LEVEL_AWAIT}@anchor{4548}
@deffn {Dato} ast.PyCF_ALLOW_TOP_LEVEL_AWAIT

Habilita el soporte para @code{await}, @code{async for}, @code{async with} y comprensiones asíncronas de nivel superior.


Added in version 3.8.

@end deffn

@geindex PyCF_ONLY_AST (en el módulo ast)
@anchor{library/ast ast PyCF_ONLY_AST}@anchor{44bc}
@deffn {Dato} ast.PyCF_ONLY_AST

Genera y retorna un árbol de sintaxis abstracto en lugar de retornar un objeto de código compilado.
@end deffn

@geindex PyCF_OPTIMIZED_AST (en el módulo ast)
@anchor{library/ast ast PyCF_OPTIMIZED_AST}@anchor{4549}
@deffn {Dato} ast.PyCF_OPTIMIZED_AST

The returned AST is optimized according to the `optimize' argument
in @ref{2fb,,compile()} or @ref{30f,,ast.parse()}.


Added in version 3.13.

@end deffn

@geindex PyCF_TYPE_COMMENTS (en el módulo ast)
@anchor{library/ast ast PyCF_TYPE_COMMENTS}@anchor{453e}
@deffn {Dato} ast.PyCF_TYPE_COMMENTS

Habilita el soporte para comentarios de tipo de estilo 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} y 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} (@code{# type: <type>}, @code{# type: ignore <stuff>}).


Added in version 3.8.

@end deffn

@geindex compare() (en el módulo ast)
@anchor{library/ast ast compare}@anchor{15e}
@deffn {Función} ast.compare (a, b, /, *, compare_attributes=False)

Recursively compares two ASTs.

`compare_attributes' affects whether AST attributes are considered
in the comparison. If `compare_attributes' is @code{False} (default), then
attributes are ignored. Otherwise they must all be equal. This
option is useful to check whether the ASTs are structurally equal but
differ in whitespace or similar details. Attributes include line numbers
and column offsets.


Added in version 3.14.

@end deffn

@node Uso en línea de comandos,,Banderas del compilador<2>,ast — Abstract Syntax Trees
@anchor{library/ast ast-cli}@anchor{454a}@anchor{library/ast command-line-usage}@anchor{454b}
@subsubsection Uso en línea de comandos



Added in version 3.9.


El módulo @ref{9,,ast} puede ser ejecutado como un script desde la línea de comandos. Es tan simple como:

@example
python -m ast [-m <mode>] [-a] [infile]
@end example

Las siguientes opciones son aceptadas:

@geindex opción de línea de comando ast; -h
@geindex opción de línea de comando ast; --help
@anchor{library/ast cmdoption-ast-h}@anchor{454c}@anchor{library/ast cmdoption-ast-help}@anchor{454d}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Muestra el mensaje de ayuda y sale.
@end deffn

@geindex opción de línea de comando ast; -m
@geindex opción de línea de comando ast; --mode
@anchor{library/ast cmdoption-ast-m}@anchor{454e}
@deffn {Option} @w{-}m <mode>
@anchor{library/ast cmdoption-ast-mode}@anchor{454f}
@deffnx {Option} @w{-}@w{-}mode <mode>

Especifica qué tipo de código debe ser compilado, como el argumento `mode' en @ref{30f,,parse()}.
@end deffn

@geindex opción de línea de comando ast; --no-type-comments
@anchor{library/ast cmdoption-ast-no-type-comments}@anchor{4550}
@deffn {Option} @w{-}@w{-}no@w{-}type@w{-}comments

No analizar los comentarios de tipo.
@end deffn

@geindex opción de línea de comando ast; -a
@geindex opción de línea de comando ast; --include-attributes
@anchor{library/ast cmdoption-ast-a}@anchor{4551}@anchor{library/ast cmdoption-ast-include-attributes}@anchor{4552}
@deffn {Option} @w{-}a, @w{-}@w{-}include@w{-}attributes

Incluye atributos como números de línea y sangrías.
@end deffn

@geindex opción de línea de comando ast; -i
@geindex opción de línea de comando ast; --indent
@anchor{library/ast cmdoption-ast-i}@anchor{4553}
@deffn {Option} @w{-}i <indent>
@anchor{library/ast cmdoption-ast-indent}@anchor{4554}
@deffnx {Option} @w{-}@w{-}indent <indent>

Sangría de nodos en AST (número de espacios).
@end deffn

Si @code{infile} es especificado, su contenido es analizado a AST y mostrado en stdout. De otra forma, el contenido es leído desde stdin.


@subsubheading Ver también


Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/}, un recurso de documentación externo, tiene buenos detalles sobre cómo trabajar con Python AST.

ASTTokens@footnote{https://asttokens.readthedocs.io/en/latest/user-guide.html} anota ASTs de Python con la posición de tokens y texto en el código fuente que los genera. Esto es de ayuda para herramientas que hacen transformaciones de código fuente.

leoAst.py@footnote{https://leo-editor.github.io/leo-editor/appendices.html#leoast-py}
unifies the
token-based and parse-tree-based views of python programs by inserting
two-way links between tokens and ast nodes.

LibCST@footnote{https://libcst.readthedocs.io/} analiza código como Árboles de Sintaxis Concreta que se ven como ASTs y mantienen todos los detalles de formato. Es útil para construir herramientas de refactor automáticas y linters.

Parso@footnote{https://parso.readthedocs.io} is a Python parser that supports
error recovery and round-trip parsing for different Python versions (in
multiple Python versions). Parso is also able to list multiple syntax errors
in your Python file.


@node symtable — Access to the compiler’s symbol tables,token — Constants used with Python parse trees,ast — Abstract Syntax Trees,Servicios del lenguaje Python
@anchor{library/symtable doc}@anchor{4555}@anchor{library/symtable module-symtable}@anchor{d8}@anchor{library/symtable symtable-access-to-the-compiler-s-symbol-tables}@anchor{4556}
@subsection @code{symtable} — Access to the compiler’s symbol tables


@geindex module; symtable

`Código fuente:' Lib/symtable.py@footnote{https://github.com/python/cpython/tree/main/Lib/symtable.py}


__________________________________________________________________


Las tablas de símbolos son generadas por el compilador a partir del AST justo antes de que el bytecode sea generado. La tabla de símbolos es responsable de calcular el ámbito de cada identificador en el código.  @ref{d8,,symtable} provee una interfaz para examinar esas tablas.

@menu
* Generando tablas de símbolos:: 
* Examinando la tabla de símbolos:: 
* Command-Line Usage:: 

@end menu

@node Generando tablas de símbolos,Examinando la tabla de símbolos,,symtable — Access to the compiler’s symbol tables
@anchor{library/symtable generating-symbol-tables}@anchor{4557}
@subsubsection Generando tablas de símbolos


@geindex symtable() (en el módulo symtable)
@anchor{library/symtable symtable symtable}@anchor{19f6}
@deffn {Función} symtable.symtable (code, filename, compile_type)

Retorna la @ref{4558,,SymbolTable} del nivel más alto para el código Python `code'. `filename' es el nombre del archivo conteniendo el código. `compile_type' es como el argumento `mode' de la función @ref{2fb,,compile()}.
@end deffn

@node Examinando la tabla de símbolos,Command-Line Usage,Generando tablas de símbolos,symtable — Access to the compiler’s symbol tables
@anchor{library/symtable examining-symbol-tables}@anchor{4559}
@subsubsection Examinando la tabla de símbolos


@geindex SymbolTableType (clase en symtable)
@anchor{library/symtable symtable SymbolTableType}@anchor{15ee}
@deffn {Clase} symtable.SymbolTableType

An enumeration indicating the type of a @ref{4558,,SymbolTable} object.

@geindex MODULE (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType MODULE}@anchor{455a}
@deffn {Atributo} MODULE = "module"

Used for the symbol table of a module.
@end deffn

@geindex FUNCTION (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType FUNCTION}@anchor{455b}
@deffn {Atributo} FUNCTION = "function"

Used for the symbol table of a function.
@end deffn

@geindex CLASS (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType CLASS}@anchor{455c}
@deffn {Atributo} CLASS = "class"

Used for the symbol table of a class.
@end deffn

The following members refer to different flavors of
@ref{2f3,,annotation scopes}.

@geindex ANNOTATION (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType ANNOTATION}@anchor{455d}
@deffn {Atributo} ANNOTATION = "annotation"

Used for annotations if @code{from __future__ import annotations} is active.
@end deffn

@geindex TYPE_ALIAS (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_ALIAS}@anchor{455e}
@deffn {Atributo} TYPE_ALIAS = "type alias"

Used for the symbol table of @ref{4e6,,type} constructions.
@end deffn

@geindex TYPE_PARAMETERS (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_PARAMETERS}@anchor{455f}
@deffn {Atributo} TYPE_PARAMETERS = "type parameters"

Used for the symbol table of @ref{4ff,,generic functions}
or @ref{4fe,,generic classes}.
@end deffn

@geindex TYPE_VARIABLE (atributo de symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_VARIABLE}@anchor{4560}
@deffn {Atributo} TYPE_VARIABLE = "type variable"

Used for the symbol table of the bound, the constraint tuple or the
default value of a single type variable in the formal sense, i.e.,
a TypeVar, a TypeVarTuple or a ParamSpec object (the latter two do
not support a bound or a constraint tuple).
@end deffn


Added in version 3.13.

@end deffn

@geindex SymbolTable (clase en symtable)
@anchor{library/symtable symtable SymbolTable}@anchor{4558}
@deffn {Clase} symtable.SymbolTable

Un espacio de nombres para el bloque. El constructor no es público.

@geindex get_type() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_type}@anchor{15ef}
@deffn {Método} get_type ()

Return the type of the symbol table.  Possible values are members
of the @ref{15ee,,SymbolTableType} enumeration.


Distinto en la versión 3.12: Se agregaron @code{'annotation'}, @code{'TypeVar bound'}, @code{'type alias'} y @code{'type parameter'} como posibles valores de retorno.



Distinto en la versión 3.13: Return values are members of the @ref{15ee,,SymbolTableType} enumeration.

The exact values of the returned string may change in the future,
and thus, it is recommended to use @ref{15ee,,SymbolTableType} members
instead of hard-coded strings.

@end deffn

@geindex get_id() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_id}@anchor{4561}
@deffn {Método} get_id ()

Retorna el identificador de la tabla.
@end deffn

@geindex get_name() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_name}@anchor{4562}
@deffn {Método} get_name ()

Retorna el nombre de la tabla. Es el nombre de la clase si la tabla es para una clase, el nombre de la función si la tabla es para una función o @code{'top} si la tabla es global (@ref{15ef,,get_type()} retorna @code{'module}). Para ámbitos de parámetros de tipo (que se utilizan para clases genéricas, funciones y alias de tipo), es el nombre de la clase, función o alias de tipo subyacente. Para ámbitos de alias de tipo, es el nombre del alias de tipo. Para ámbitos enlazados @ref{2c9,,TypeVar}, es el nombre del @code{TypeVar}.
@end deffn

@geindex get_lineno() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_lineno}@anchor{4563}
@deffn {Método} get_lineno ()

Retorna el número de la primera línea en el bloque que esta tabla representa.
@end deffn

@geindex is_optimized() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable is_optimized}@anchor{4564}
@deffn {Método} is_optimized ()

Retorna @code{True} si los locales en esta tabla pueden ser optimizados.
@end deffn

@geindex is_nested() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable is_nested}@anchor{4565}
@deffn {Método} is_nested ()

Retorna @code{True} si el bloque es una clase o función anidadas.
@end deffn

@geindex has_children() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable has_children}@anchor{4566}
@deffn {Método} has_children ()

Retorna @code{True} si el bloque contiene espacios de nombres anidados en él. Estos pueden ser obtenidos con @ref{4567,,get_children()}.
@end deffn

@geindex get_identifiers() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_identifiers}@anchor{4568}
@deffn {Método} get_identifiers ()

Retorna una vista de objeto que contiene los nombres de los símbolos en la tabla. Lee la @ref{2249,,documentación de vistas de objetos}.
@end deffn

@geindex lookup() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable lookup}@anchor{4569}
@deffn {Método} lookup (name)

Busca `name' en la tabla y retorna una instancia de @ref{1b0,,Symbol}.
@end deffn

@geindex get_symbols() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_symbols}@anchor{456a}
@deffn {Método} get_symbols ()

Retorna una lista de instancias de @ref{1b0,,Symbol} de los nombres en la tabla.
@end deffn

@geindex get_children() (método de symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_children}@anchor{4567}
@deffn {Método} get_children ()

Retorna una lista de las tablas de símbolos anidadas.
@end deffn
@end deffn

@geindex Function (clase en symtable)
@anchor{library/symtable symtable Function}@anchor{456b}
@deffn {Clase} symtable.Function

A namespace for a function or method.  This class inherits from
@ref{4558,,SymbolTable}.

@geindex get_parameters() (método de symtable.Function)
@anchor{library/symtable symtable Function get_parameters}@anchor{456c}
@deffn {Método} get_parameters ()

Retorna una tupla conteniendo los nombres de los parámetros de esta función.
@end deffn

@geindex get_locals() (método de symtable.Function)
@anchor{library/symtable symtable Function get_locals}@anchor{456d}
@deffn {Método} get_locals ()

Retorna una tupla conteniendo los nombres de los locales en esta función.
@end deffn

@geindex get_globals() (método de symtable.Function)
@anchor{library/symtable symtable Function get_globals}@anchor{456e}
@deffn {Método} get_globals ()

Retorna una tupla conteniendo los nombres de los globales en esta función.
@end deffn

@geindex get_nonlocals() (método de symtable.Function)
@anchor{library/symtable symtable Function get_nonlocals}@anchor{456f}
@deffn {Método} get_nonlocals ()

Return a tuple containing names of explicitly declared nonlocals in this function.
@end deffn

@geindex get_frees() (método de symtable.Function)
@anchor{library/symtable symtable Function get_frees}@anchor{4570}
@deffn {Método} get_frees ()

Return a tuple containing names of @ref{1f40,,free (closure) variables}
in this function.
@end deffn
@end deffn

@geindex Class (clase en symtable)
@anchor{library/symtable symtable Class}@anchor{4571}
@deffn {Clase} symtable.Class

A namespace of a class.  This class inherits from @ref{4558,,SymbolTable}.

@geindex get_methods() (método de symtable.Class)
@anchor{library/symtable symtable Class get_methods}@anchor{1c7}
@deffn {Método} get_methods ()

Return a tuple containing the names of method-like functions declared
in the class.

Here, the term “method” designates `any' function defined in the class
body via @ref{1497,,def} or @ref{672,,async def}.

Functions defined in a deeper scope (e.g., in an inner class) are not
picked up by @ref{1c7,,get_methods()}.

For example:

@c import warnings
@c context = warnings.catch_warnings()
@c context.__enter__()
@c warnings.simplefilter("ignore", category=DeprecationWarning)

@c context.__exit__()

@example
>>> import symtable
>>> st = symtable.symtable('@w{'}'
... def outer(): pass
...
... class A:
...    def f():
...        def w(): pass
...
...    def g(self): pass
...
...    @@classmethod
...    async def h(cls): pass
...
...    global outer
...    def outer(self): pass
... '@w{'}', 'test', 'exec')
>>> class_A = st.get_children()[2]
>>> class_A.get_methods()
('f', 'g', 'h')
@end example

Although @code{A().f()} raises @ref{228,,TypeError} at runtime, @code{A.f} is still
considered as a method-like function.


Deprecated since version 3.14, will be removed in version 3.16.

@end deffn
@end deffn

@geindex Symbol (clase en symtable)
@anchor{library/symtable symtable Symbol}@anchor{1b0}
@deffn {Clase} symtable.Symbol

Una entrada en una @ref{4558,,SymbolTable} correspondiente a un identificador en el código. El constructor no es público.

@geindex get_name() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol get_name}@anchor{4572}
@deffn {Método} get_name ()

Retorna el nombre del símbolo.
@end deffn

@geindex is_referenced() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_referenced}@anchor{4573}
@deffn {Método} is_referenced ()

Retorna @code{True} si el símbolo es usado en su bloque.
@end deffn

@geindex is_imported() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_imported}@anchor{4574}
@deffn {Método} is_imported ()

Retorna @code{True} si el símbolo es creado desde una instrucción `import'.
@end deffn

@geindex is_parameter() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_parameter}@anchor{4575}
@deffn {Método} is_parameter ()

Retorna @code{True} si el símbolo es un parámetro.
@end deffn

@geindex is_type_parameter() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_type_parameter}@anchor{15f0}
@deffn {Método} is_type_parameter ()

Return @code{True} if the symbol is a type parameter.


Added in version 3.14.

@end deffn

@geindex is_global() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_global}@anchor{4576}
@deffn {Método} is_global ()

Retorna @code{True} si el símbolo es global.
@end deffn

@geindex is_nonlocal() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_nonlocal}@anchor{1a32}
@deffn {Método} is_nonlocal ()

Retorna @code{True} si el símbolo es no local.
@end deffn

@geindex is_declared_global() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_declared_global}@anchor{138d}
@deffn {Método} is_declared_global ()

Retorna @code{True} si el símbolo es declarado global con una instrucción `global'.
@end deffn

@geindex is_local() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_local}@anchor{4577}
@deffn {Método} is_local ()

Retorna @code{True} si el símbolo es local a su bloque.
@end deffn

@geindex is_annotated() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_annotated}@anchor{4578}
@deffn {Método} is_annotated ()

Retorna @code{True} si el símbolo está anotado.


Added in version 3.6.

@end deffn

@geindex is_free() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_free}@anchor{4579}
@deffn {Método} is_free ()

Retorna @code{True} si el símbolo es referenciado en su bloque pero no asignado.
@end deffn

@geindex is_free_class() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_free_class}@anchor{1b3}
@deffn {Método} is_free_class ()

Return `True' if a class-scoped symbol is free from
the perspective of a method.

Consider the following example:

@example
def f():
    x = 1  # function-scoped
    class C:
        x = 2  # class-scoped
        def method(self):
            return x
@end example

In this example, the class-scoped symbol @code{x} is considered to
be free from the perspective of @code{C.method}, thereby allowing
the latter to return `1' at runtime and not `2'.


Added in version 3.14.

@end deffn

@geindex is_assigned() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_assigned}@anchor{457a}
@deffn {Método} is_assigned ()

Retorna @code{True} si el símbolo es asignado en su bloque.
@end deffn

@geindex is_comp_iter() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_comp_iter}@anchor{1b2}
@deffn {Método} is_comp_iter ()

Return @code{True} if the symbol is a comprehension iteration variable.


Added in version 3.14.

@end deffn

@geindex is_comp_cell() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_comp_cell}@anchor{1b1}
@deffn {Método} is_comp_cell ()

Return @code{True} if the symbol is a cell in an inlined comprehension.


Added in version 3.14.

@end deffn

@geindex is_namespace() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol is_namespace}@anchor{457b}
@deffn {Método} is_namespace ()

Retorna @code{True} si la vinculación de nombres introduce un nuevo espacio de nombres.

Si el nombre es usado como objetivo de una instrucción `function' o `class' retornará verdadero.

Por ejemplo:

@example
>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True
@end example

Note que un solo nombre puede estar vinculado a varios objetos. Si el resultado es @code{True}, el nombre puede estar vinculado también a otros objetos, como un entero o una lista, esto no introduce un nuevo espacio de nombres.
@end deffn

@geindex get_namespaces() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol get_namespaces}@anchor{457c}
@deffn {Método} get_namespaces ()

Retorna una lista de espacios de nombres vinculados a este nombre.
@end deffn

@geindex get_namespace() (método de symtable.Symbol)
@anchor{library/symtable symtable Symbol get_namespace}@anchor{457d}
@deffn {Método} get_namespace ()

Retorna el espacio de nombre vinculado a este nombre. Si hay más de un espacio de nombre vinculado o ninguno a ese nombre se levanta un @ref{360,,ValueError}.
@end deffn
@end deffn

@node Command-Line Usage,,Examinando la tabla de símbolos,symtable — Access to the compiler’s symbol tables
@anchor{library/symtable command-line-usage}@anchor{457e}@anchor{library/symtable symtable-cli}@anchor{457f}
@subsubsection Command-Line Usage



Added in version 3.13.


The @ref{d8,,symtable} module can be executed as a script from the command line.

@example
python -m symtable [infile...]
@end example

Symbol tables are generated for the specified Python source files and
dumped to stdout.
If no input file is specified, the content is read from stdin.

@node token — Constants used with Python parse trees,keyword — Testing for Python keywords,symtable — Access to the compiler’s symbol tables,Servicios del lenguaje Python
@anchor{library/token doc}@anchor{4580}@anchor{library/token module-token}@anchor{fa}@anchor{library/token token-constants-used-with-python-parse-trees}@anchor{4581}
@subsection @code{token} — Constants used with Python parse trees


@geindex module; token

`Código fuente:' Lib/token.py@footnote{https://github.com/python/cpython/tree/main/Lib/token.py}


__________________________________________________________________


Este módulo proporciona constantes que representan los valores numéricos de los nodos hoja del árbol de análisis (tokens terminales). Consulte el archivo @code{Grammar/Tokens} en la distribución de Python para conocer las definiciones de los nombres en el contexto de la gramática del lenguaje. Los valores numéricos específicos a los que se asignan los nombres pueden cambiar entre las versiones de Python.

El módulo también proporciona un mapeo de códigos numéricos a nombres y algunas funciones.  Las funciones asemejan definiciones en los archivos Python C encabezados.

@geindex tok_name (en el módulo token)
@anchor{library/token token tok_name}@anchor{4582}
@deffn {Dato} token.tok_name

Diccionario que mapea los valores numéricos de las constantes definidas en este módulo a cadenas de nombres, permitiendo una representación de árboles de sintaxis a ser generados más legible para humanos.
@end deffn

@geindex ISTERMINAL() (en el módulo token)
@anchor{library/token token ISTERMINAL}@anchor{4583}
@deffn {Función} token.ISTERMINAL (x)

Retorna @code{True} para valores token terminales.
@end deffn

@geindex ISNONTERMINAL() (en el módulo token)
@anchor{library/token token ISNONTERMINAL}@anchor{4584}
@deffn {Función} token.ISNONTERMINAL (x)

Retorna @code{True} para valores token no terminales.
@end deffn

@geindex ISEOF() (en el módulo token)
@anchor{library/token token ISEOF}@anchor{4585}
@deffn {Función} token.ISEOF (x)

Retorna @code{True} si `x' es el marcador indicando el final del input.
@end deffn

Las constantes de token son:

@c Auto-generated by Tools/build/generate_token.py

@geindex ENDMARKER (en el módulo token)
@anchor{library/token token ENDMARKER}@anchor{4586}
@deffn {Dato} token.ENDMARKER
@end deffn

@geindex NAME (en el módulo token)
@anchor{library/token token NAME}@anchor{4587}
@deffn {Dato} token.NAME
@end deffn

@geindex NUMBER (en el módulo token)
@anchor{library/token token NUMBER}@anchor{4588}
@deffn {Dato} token.NUMBER
@end deffn

@geindex STRING (en el módulo token)
@anchor{library/token token STRING}@anchor{4589}
@deffn {Dato} token.STRING
@end deffn

@geindex NEWLINE (en el módulo token)
@anchor{library/token token NEWLINE}@anchor{458a}
@deffn {Dato} token.NEWLINE
@end deffn

@geindex INDENT (en el módulo token)
@anchor{library/token token INDENT}@anchor{458b}
@deffn {Dato} token.INDENT
@end deffn

@geindex DEDENT (en el módulo token)
@anchor{library/token token DEDENT}@anchor{458c}
@deffn {Dato} token.DEDENT
@end deffn

@geindex LPAR (en el módulo token)
@anchor{library/token token LPAR}@anchor{458d}
@deffn {Dato} token.LPAR

Valor de token para @code{"("}.
@end deffn

@geindex RPAR (en el módulo token)
@anchor{library/token token RPAR}@anchor{458e}
@deffn {Dato} token.RPAR

Valor de token para @code{")"}.
@end deffn

@geindex LSQB (en el módulo token)
@anchor{library/token token LSQB}@anchor{458f}
@deffn {Dato} token.LSQB

Valor de token para @code{"["}.
@end deffn

@geindex RSQB (en el módulo token)
@anchor{library/token token RSQB}@anchor{4590}
@deffn {Dato} token.RSQB

Valor de token para @code{"]"}.
@end deffn

@geindex COLON (en el módulo token)
@anchor{library/token token COLON}@anchor{4591}
@deffn {Dato} token.COLON

Valor de token para @code{":"}.
@end deffn

@geindex COMMA (en el módulo token)
@anchor{library/token token COMMA}@anchor{4592}
@deffn {Dato} token.COMMA

Valor de token para @code{","}.
@end deffn

@geindex SEMI (en el módulo token)
@anchor{library/token token SEMI}@anchor{4593}
@deffn {Dato} token.SEMI

Valor de token para @code{";"}.
@end deffn

@geindex PLUS (en el módulo token)
@anchor{library/token token PLUS}@anchor{4594}
@deffn {Dato} token.PLUS

Valor de token para @code{"+"}.
@end deffn

@geindex MINUS (en el módulo token)
@anchor{library/token token MINUS}@anchor{4595}
@deffn {Dato} token.MINUS

Valor de token para @code{"-"}.
@end deffn

@geindex STAR (en el módulo token)
@anchor{library/token token STAR}@anchor{4596}
@deffn {Dato} token.STAR

Valor de token para @code{"*"}.
@end deffn

@geindex SLASH (en el módulo token)
@anchor{library/token token SLASH}@anchor{4597}
@deffn {Dato} token.SLASH

Valor de token para @code{"/"}.
@end deffn

@geindex VBAR (en el módulo token)
@anchor{library/token token VBAR}@anchor{4598}
@deffn {Dato} token.VBAR

Valor de token para @code{"|"}.
@end deffn

@geindex AMPER (en el módulo token)
@anchor{library/token token AMPER}@anchor{4599}
@deffn {Dato} token.AMPER

Valor de token para @code{"&"}.
@end deffn

@geindex LESS (en el módulo token)
@anchor{library/token token LESS}@anchor{459a}
@deffn {Dato} token.LESS

Valor de token para @code{"<"}.
@end deffn

@geindex GREATER (en el módulo token)
@anchor{library/token token GREATER}@anchor{459b}
@deffn {Dato} token.GREATER

Valor de token para @code{">"}.
@end deffn

@geindex EQUAL (en el módulo token)
@anchor{library/token token EQUAL}@anchor{459c}
@deffn {Dato} token.EQUAL

Valor de token para @code{"="}.
@end deffn

@geindex DOT (en el módulo token)
@anchor{library/token token DOT}@anchor{459d}
@deffn {Dato} token.DOT

Valor de token para @code{"."}.
@end deffn

@geindex PERCENT (en el módulo token)
@anchor{library/token token PERCENT}@anchor{459e}
@deffn {Dato} token.PERCENT

Valor de token para @code{"%"}.
@end deffn

@geindex LBRACE (en el módulo token)
@anchor{library/token token LBRACE}@anchor{459f}
@deffn {Dato} token.LBRACE

Valor de token para @code{"@{"}.
@end deffn

@geindex RBRACE (en el módulo token)
@anchor{library/token token RBRACE}@anchor{45a0}
@deffn {Dato} token.RBRACE

Valor de token para @code{"@}"}.
@end deffn

@geindex EQEQUAL (en el módulo token)
@anchor{library/token token EQEQUAL}@anchor{45a1}
@deffn {Dato} token.EQEQUAL

Valor de token para @code{"=="}.
@end deffn

@geindex NOTEQUAL (en el módulo token)
@anchor{library/token token NOTEQUAL}@anchor{45a2}
@deffn {Dato} token.NOTEQUAL

Valor de token para @code{"!="}.
@end deffn

@geindex LESSEQUAL (en el módulo token)
@anchor{library/token token LESSEQUAL}@anchor{45a3}
@deffn {Dato} token.LESSEQUAL

Valor de token para @code{"<="}.
@end deffn

@geindex GREATEREQUAL (en el módulo token)
@anchor{library/token token GREATEREQUAL}@anchor{45a4}
@deffn {Dato} token.GREATEREQUAL

Valor de token para @code{">="}.
@end deffn

@geindex TILDE (en el módulo token)
@anchor{library/token token TILDE}@anchor{45a5}
@deffn {Dato} token.TILDE

Valor de token para @code{"~"}.
@end deffn

@geindex CIRCUMFLEX (en el módulo token)
@anchor{library/token token CIRCUMFLEX}@anchor{45a6}
@deffn {Dato} token.CIRCUMFLEX

Valor de token para @code{"^"}.
@end deffn

@geindex LEFTSHIFT (en el módulo token)
@anchor{library/token token LEFTSHIFT}@anchor{45a7}
@deffn {Dato} token.LEFTSHIFT

Valor de token para @code{"<<"}.
@end deffn

@geindex RIGHTSHIFT (en el módulo token)
@anchor{library/token token RIGHTSHIFT}@anchor{45a8}
@deffn {Dato} token.RIGHTSHIFT

Valor de token para @code{">>"}.
@end deffn

@geindex DOUBLESTAR (en el módulo token)
@anchor{library/token token DOUBLESTAR}@anchor{45a9}
@deffn {Dato} token.DOUBLESTAR

Valor de token para @code{"**"}.
@end deffn

@geindex PLUSEQUAL (en el módulo token)
@anchor{library/token token PLUSEQUAL}@anchor{45aa}
@deffn {Dato} token.PLUSEQUAL

Valor de token para @code{"+="}.
@end deffn

@geindex MINEQUAL (en el módulo token)
@anchor{library/token token MINEQUAL}@anchor{45ab}
@deffn {Dato} token.MINEQUAL

Valor de token para @code{"-="}.
@end deffn

@geindex STAREQUAL (en el módulo token)
@anchor{library/token token STAREQUAL}@anchor{45ac}
@deffn {Dato} token.STAREQUAL

Valor de token para @code{"*="}.
@end deffn

@geindex SLASHEQUAL (en el módulo token)
@anchor{library/token token SLASHEQUAL}@anchor{45ad}
@deffn {Dato} token.SLASHEQUAL

Valor de token para @code{"/="}.
@end deffn

@geindex PERCENTEQUAL (en el módulo token)
@anchor{library/token token PERCENTEQUAL}@anchor{45ae}
@deffn {Dato} token.PERCENTEQUAL

Valor de token para @code{"%="}.
@end deffn

@geindex AMPEREQUAL (en el módulo token)
@anchor{library/token token AMPEREQUAL}@anchor{45af}
@deffn {Dato} token.AMPEREQUAL

Valor de token para @code{"&="}.
@end deffn

@geindex VBAREQUAL (en el módulo token)
@anchor{library/token token VBAREQUAL}@anchor{45b0}
@deffn {Dato} token.VBAREQUAL

Valor de token para @code{"|="}.
@end deffn

@geindex CIRCUMFLEXEQUAL (en el módulo token)
@anchor{library/token token CIRCUMFLEXEQUAL}@anchor{45b1}
@deffn {Dato} token.CIRCUMFLEXEQUAL

Valor de token para @code{"^="}.
@end deffn

@geindex LEFTSHIFTEQUAL (en el módulo token)
@anchor{library/token token LEFTSHIFTEQUAL}@anchor{45b2}
@deffn {Dato} token.LEFTSHIFTEQUAL

Valor de token para @code{"<<="}.
@end deffn

@geindex RIGHTSHIFTEQUAL (en el módulo token)
@anchor{library/token token RIGHTSHIFTEQUAL}@anchor{45b3}
@deffn {Dato} token.RIGHTSHIFTEQUAL

Valor de token para @code{">>="}.
@end deffn

@geindex DOUBLESTAREQUAL (en el módulo token)
@anchor{library/token token DOUBLESTAREQUAL}@anchor{45b4}
@deffn {Dato} token.DOUBLESTAREQUAL

Valor de token para @code{"**="}.
@end deffn

@geindex DOUBLESLASH (en el módulo token)
@anchor{library/token token DOUBLESLASH}@anchor{45b5}
@deffn {Dato} token.DOUBLESLASH

Valor de token para @code{"//"}.
@end deffn

@geindex DOUBLESLASHEQUAL (en el módulo token)
@anchor{library/token token DOUBLESLASHEQUAL}@anchor{45b6}
@deffn {Dato} token.DOUBLESLASHEQUAL

Valor de token para @code{"//="}.
@end deffn

@geindex AT (en el módulo token)
@anchor{library/token token AT}@anchor{45b7}
@deffn {Dato} token.AT

Valor de token para @code{"@@"}.
@end deffn

@geindex ATEQUAL (en el módulo token)
@anchor{library/token token ATEQUAL}@anchor{45b8}
@deffn {Dato} token.ATEQUAL

Valor de token para @code{"@@="}.
@end deffn

@geindex RARROW (en el módulo token)
@anchor{library/token token RARROW}@anchor{45b9}
@deffn {Dato} token.RARROW

Valor de token para @code{"->"}.
@end deffn

@geindex ELLIPSIS (en el módulo token)
@anchor{library/token token ELLIPSIS}@anchor{45ba}
@deffn {Dato} token.ELLIPSIS

Valor de token para @code{"..."}.
@end deffn

@geindex COLONEQUAL (en el módulo token)
@anchor{library/token token COLONEQUAL}@anchor{45bb}
@deffn {Dato} token.COLONEQUAL

Valor de token para @code{":="}.
@end deffn

@geindex EXCLAMATION (en el módulo token)
@anchor{library/token token EXCLAMATION}@anchor{45bc}
@deffn {Dato} token.EXCLAMATION

Valor de token para @code{"!"}.
@end deffn

@geindex OP (en el módulo token)
@anchor{library/token token OP}@anchor{45bd}
@deffn {Dato} token.OP
@end deffn

@geindex TYPE_IGNORE (en el módulo token)
@anchor{library/token token TYPE_IGNORE}@anchor{45be}
@deffn {Dato} token.TYPE_IGNORE
@end deffn

@geindex TYPE_COMMENT (en el módulo token)
@anchor{library/token token TYPE_COMMENT}@anchor{45bf}
@deffn {Dato} token.TYPE_COMMENT
@end deffn

@geindex SOFT_KEYWORD (en el módulo token)
@anchor{library/token token SOFT_KEYWORD}@anchor{45c0}
@deffn {Dato} token.SOFT_KEYWORD
@end deffn

@geindex FSTRING_START (en el módulo token)
@anchor{library/token token FSTRING_START}@anchor{45c1}
@deffn {Dato} token.FSTRING_START
@end deffn

@geindex FSTRING_MIDDLE (en el módulo token)
@anchor{library/token token FSTRING_MIDDLE}@anchor{45c2}
@deffn {Dato} token.FSTRING_MIDDLE
@end deffn

@geindex FSTRING_END (en el módulo token)
@anchor{library/token token FSTRING_END}@anchor{45c3}
@deffn {Dato} token.FSTRING_END
@end deffn

@geindex COMMENT (en el módulo token)
@anchor{library/token token COMMENT}@anchor{45c4}
@deffn {Dato} token.COMMENT
@end deffn

@geindex NL (en el módulo token)
@anchor{library/token token NL}@anchor{45c5}
@deffn {Dato} token.NL
@end deffn

@geindex ERRORTOKEN (en el módulo token)
@anchor{library/token token ERRORTOKEN}@anchor{45c6}
@deffn {Dato} token.ERRORTOKEN
@end deffn

@geindex N_TOKENS (en el módulo token)
@anchor{library/token token N_TOKENS}@anchor{45c7}
@deffn {Dato} token.N_TOKENS
@end deffn

@geindex NT_OFFSET (en el módulo token)
@anchor{library/token token NT_OFFSET}@anchor{45c8}
@deffn {Dato} token.NT_OFFSET
@end deffn

Los siguientes tipos de valores tokens no son usados por el tokenizador C pero son necesarios para el módulo @ref{fb,,tokenize}.


@deffn {Dato} token.COMMENT

Valores token usados para indicar un comentario.
@end deffn


@deffn {Dato} token.NL

Valor token usado para indicar una nueva línea no terminante.  El token @ref{458a,,NEWLINE} indica el final de una línea lógica de código Python; los tokens @code{NL} son generados cuando una línea lógica de código es continuada sobre múltiples líneas físicas.
@end deffn

@geindex ENCODING (en el módulo token)
@anchor{library/token token ENCODING}@anchor{45c9}
@deffn {Dato} token.ENCODING

Valor de token que indica la codificación usada para decodificar los bytes de origen en texto. El primer token retornado por @ref{581,,tokenize.tokenize()} siempre será un token @code{ENCODING}.
@end deffn


@deffn {Dato} token.TYPE_COMMENT

Token value indicating that a type comment was recognized.  Such
tokens are only produced when @ref{30f,,ast.parse()} is invoked with
@code{type_comments=True}.
@end deffn


Distinto en la versión 3.5: Added @code{AWAIT} and @code{ASYNC} tokens.



Distinto en la versión 3.7: Agregados los tokens @ref{45c4,,COMMENT}, @ref{45c5,,NL} y @ref{45c9,,ENCODING}.



Distinto en la versión 3.7: Removed @code{AWAIT} and @code{ASYNC} tokens. «async» and «await» are
now tokenized as @ref{4587,,NAME} tokens.



Distinto en la versión 3.8: Added @ref{45bf,,TYPE_COMMENT}, @ref{45be,,TYPE_IGNORE}, @ref{45bb,,COLONEQUAL}.
Added @code{AWAIT} and @code{ASYNC} tokens back (they’re needed
to support parsing older Python versions for @ref{30f,,ast.parse()} with
@code{feature_version} set to 6 or lower).



Distinto en la versión 3.13: Removed @code{AWAIT} and @code{ASYNC} tokens again.


@node keyword — Testing for Python keywords,tokenize — Tokenizer for Python source,token — Constants used with Python parse trees,Servicios del lenguaje Python
@anchor{library/keyword doc}@anchor{45ca}@anchor{library/keyword keyword-testing-for-python-keywords}@anchor{45cb}@anchor{library/keyword module-keyword}@anchor{84}
@subsection @code{keyword} — Testing for Python keywords


@geindex module; keyword

`Código fuente:' Lib/keyword.py@footnote{https://github.com/python/cpython/tree/main/Lib/keyword.py}


__________________________________________________________________


This module allows a Python program to determine if a string is a
@ref{1e9c,,keyword} or @ref{8a3,,soft keyword}.

@geindex iskeyword() (en el módulo keyword)
@anchor{library/keyword keyword iskeyword}@anchor{21ca}
@deffn {Función} keyword.iskeyword (s)

Retorna @code{True} si `s' es una @ref{1e9c,,palabra clave} Python.
@end deffn

@geindex kwlist (en el módulo keyword)
@anchor{library/keyword keyword kwlist}@anchor{45cc}
@deffn {Dato} keyword.kwlist

Secuencia que contiene todos las @ref{1e9c,,palabras clave} definidos para el intérprete. Si cualquier palabra clave es definida para estar activa sólo cuando las declaraciones particulares @ref{0,,__future__} están vigentes, estas se incluirán también.
@end deffn

@geindex issoftkeyword() (en el módulo keyword)
@anchor{library/keyword keyword issoftkeyword}@anchor{45cd}
@deffn {Función} keyword.issoftkeyword (s)

Return @code{True} if `s' is a Python @ref{8a3,,soft keyword}.


Added in version 3.9.

@end deffn

@geindex softkwlist (en el módulo keyword)
@anchor{library/keyword keyword softkwlist}@anchor{45ce}
@deffn {Dato} keyword.softkwlist

Sequence containing all the @ref{8a3,,soft keywords} defined for the
interpreter.  If any soft keywords are defined to only be active when particular
@ref{0,,__future__} statements are in effect, these will be included as well.


Added in version 3.9.

@end deffn

@node tokenize — Tokenizer for Python source,tabnanny — Detection of ambiguous indentation,keyword — Testing for Python keywords,Servicios del lenguaje Python
@anchor{library/tokenize doc}@anchor{45cf}@anchor{library/tokenize module-tokenize}@anchor{fb}@anchor{library/tokenize tokenize-tokenizer-for-python-source}@anchor{45d0}
@subsection @code{tokenize} — Tokenizer for Python source


@geindex module; tokenize

`Código fuente:' Lib/tokenize.py@footnote{https://github.com/python/cpython/tree/main/Lib/tokenize.py}


__________________________________________________________________


El módulo @ref{fb,,tokenize} provee un analizador léxico para código fuente Python, implementado en Python. Este analizador también retorna comentarios como tokens, siendo útil para implementar `«pretty-printers»', como `colorizers' para impresiones en pantalla.

Para simplificar el manejo de flujos de tokens, todos los tokens @ref{1edc,,operator} y @ref{1edd,,delimiter} y @ref{218d,,Ellipsis} se retorna usando el tipo genérico @ref{45bd,,OP}. El tipo exacto se puede determinar usando la propiedad @code{exact_type} en la @ref{6ef,,named tuple} retornada por @ref{581,,tokenize.tokenize()}.

@cartouche
@quotation Advertencia 
Ten en cuenta que las funciones en este módulo están diseñadas únicamente para analizar código Python sintácticamente válido (código que no genera errores al ser analizado usando @ref{30f,,ast.parse()}). El comportamiento de las funciones en este módulo es `indefinido' cuando se proporciona código Python no válido y puede cambiar en cualquier momento.
@end quotation
@end cartouche

@menu
* Convirtiendo la entrada en tokens:: 
* Uso como línea de comandos:: 
* Ejemplos: Ejemplos<33>. 

@end menu

@node Convirtiendo la entrada en tokens,Uso como línea de comandos,,tokenize — Tokenizer for Python source
@anchor{library/tokenize tokenizing-input}@anchor{45d1}
@subsubsection Convirtiendo la entrada en `tokens'


El punto de entrada principal es un @ref{10dd,,generador}:

@geindex tokenize() (en el módulo tokenize)
@anchor{library/tokenize tokenize tokenize}@anchor{581}
@deffn {Función} tokenize.tokenize (readline)

El generador @ref{581,,tokenize()} requiere un argumento, `readline', que debe ser un objeto invocable que provee la misma interfaz que el método @ref{1391,,io.IOBase.readline()} de los objetos archivos. Cada llamada a la función debe retornar una línea de entrada como bytes.

El generador produce una tupla con los siguientes 5 miembros: El tipo de token, la cadena del token, una tupla @code{(srow, scol)} de enteros especificando la fila y columna donde el token empieza en el código, una @code{(erow, ecol)} de enteros especificando la fila y columna donde el token acaba en el código, y la línea en la que se encontró el token. La línea pasada (el último elemento de la tupla) es la línea `física'. La tupla se retorna como una @ref{6ef,,named tuple} con los campos: @code{type string start end line}.

La @ref{6ef,,named tuple} retorna tiene una propiedad adicional llamada @code{exact_type} que contiene el tipo de operador exacto para tokens @ref{45bd,,OP}. Para todos los otros tipos de token, @code{exact_type} es el valor del campo @code{type} de la tupla con su respectivo nombre.


Distinto en la versión 3.1: Añadido soporte para tuplas con nombre.



Distinto en la versión 3.3: Añadido soporte para @code{exact_type}.


@ref{581,,tokenize()} determina la codificación del fichero buscando una marca BOM UTF-8 o una `cookie' de codificación, de acuerdo con 
@geindex Python Enhancement Proposals; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}.
@end deffn

@geindex generate_tokens() (en el módulo tokenize)
@anchor{library/tokenize tokenize generate_tokens}@anchor{582}
@deffn {Función} tokenize.generate_tokens (readline)

Convertir a tokens una fuente leyendo cadenas unicode en lugar de bytes.

Como @ref{581,,tokenize()}, el argumento `readline' es un invocable que retorna una sola línea de entrada. Sin embargo, @ref{582,,generate_tokens()} espera que `readline' retorne un objeto `str' en lugar de `bytes'.

El resultado es un iterador que produce tuplas con nombre, exactamente como @ref{581,,tokenize()}. No produce un token @ref{45c9,,ENCODING}.
@end deffn

Todas las constantes del módulo @ref{fa,,token} se exportan también desde @ref{fb,,tokenize}.

Otra función se encarga de invertir el proceso de conversión. Esto es útil para crear herramientas que convierten a tokens un script, modificar el flujo de token, y escribir el script modificado.

@geindex untokenize() (en el módulo tokenize)
@anchor{library/tokenize tokenize untokenize}@anchor{160a}
@deffn {Función} tokenize.untokenize (iterable)

Convierte los `tokens' de vuelta en código fuente Python. El `iterable' debe retornar secuencias con al menos dos elementos, el tipo de `token' y la cadena del `token'. Cualquier otro elemento de la secuencia es ignorado.

El `script' reconstruido se retorna como una cadena simple. El resultado está garantizado de que se convierte en `tokens' de vuelta a la misma entrada, de modo que la conversión no tiene pérdida y que las conversiones de ida y de vuelta están aseguradas. La garantía aplica sólo al tipo y la cadena del `token', ya que el espaciado entre `tokens' (posiciones de columna) pueden variar.

Retorna bytes, codificados usando el token @ref{45c9,,ENCODING}, que es el primer elemento de la secuencia retornada por @ref{581,,tokenize()}. Si no hay un token de codificación en la entrada, retorna una cadena.
@end deffn

@ref{581,,tokenize()} necesita detectar la codificación de los ficheros fuente que convierte a tokens. La función que utiliza para hacer esto está disponible como:

@geindex detect_encoding() (en el módulo tokenize)
@anchor{library/tokenize tokenize detect_encoding}@anchor{285a}
@deffn {Función} tokenize.detect_encoding (readline)

La función @ref{285a,,detect_encoding()} se usa para detectar la codificación que debería usarse al leer un fichero fuente Python. Requiere un argumento, `readline', del mismo modo que el generador @ref{581,,tokenize()}.

Llamará a `readline' un máximo de dos veces, retornando la codificación usada, como cadena, y una lista del resto de líneas leídas, no descodificadas de `bytes'.

Detecta la codificación a partir de la presencia de una marca BOM UTF-8 o una `cookie' de codificación, como se especifica en 
@geindex Python Enhancement Proposals; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}. Si ambas están presentes pero en desacuerdo, se lanzará un @ref{150,,SyntaxError}. Resaltar que si se encuentra la marca BOM, se retornará @code{'utf-8-sig'} como codificación.

Si no se especifica una codificación, por defecto se retornará @code{'utf-8'}.

Usa @ref{2859,,open()} para abrir ficheros fuente Python: Ésta utiliza @ref{285a,,detect_encoding()} para detectar la codificación del fichero.
@end deffn

@geindex open() (en el módulo tokenize)
@anchor{library/tokenize tokenize open}@anchor{2859}
@deffn {Función} tokenize.open (filename)

Abrir un fichero en modo sólo lectura usando la codificación detectada por @ref{285a,,detect_encoding()}.


Added in version 3.2.

@end deffn

@geindex TokenError
@anchor{library/tokenize tokenize TokenError}@anchor{5e5}
@deffn {Excepción} tokenize.TokenError

Lanzada cuando una expresión o docstring que puede separarse en más líneas no está completa en el fichero, por ejemplo:

@example
"""Beginning of
docstring
@end example

o:

@example
[1,
 2,
 3
@end example
@end deffn

@node Uso como línea de comandos,Ejemplos<33>,Convirtiendo la entrada en tokens,tokenize — Tokenizer for Python source
@anchor{library/tokenize command-line-usage}@anchor{45d2}@anchor{library/tokenize tokenize-cli}@anchor{45d3}
@subsubsection Uso como línea de comandos



Added in version 3.3.


El módulo @ref{fb,,tokenize} se puede ejecutar como script desde la línea de comandos. Es tan simple como:

@example
python -m tokenize [-e] [filename.py]
@end example

Se aceptan las siguientes opciones:

@geindex opción de línea de comando tokenize; -h
@geindex opción de línea de comando tokenize; --help
@anchor{library/tokenize cmdoption-tokenize-h}@anchor{45d4}@anchor{library/tokenize cmdoption-tokenize-help}@anchor{45d5}
@deffn {Option} @w{-}h, @w{-}@w{-}help

muestra el mensaje de ayuda y sale
@end deffn

@geindex opción de línea de comando tokenize; -e
@geindex opción de línea de comando tokenize; --exact
@anchor{library/tokenize cmdoption-tokenize-e}@anchor{45d6}@anchor{library/tokenize cmdoption-tokenize-exact}@anchor{45d7}
@deffn {Option} @w{-}e, @w{-}@w{-}exact

muestra los nombres de token usando el tipo exacto
@end deffn

Si se especifica @code{filename.py}, se convierte su contenido a tokens por la salida estándar. En otro caso, se convierte la entrada estándar.

@node Ejemplos<33>,,Uso como línea de comandos,tokenize — Tokenizer for Python source
@anchor{library/tokenize examples}@anchor{45d8}
@subsubsection Ejemplos


Ejemplo de un script que transforma literales float en objetos Decimal:

@example
from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
from io import BytesIO

def decistmt(s):
    """Substitute Decimals for floats in a string of statements.

    >>> from decimal import Decimal
    >>> s = 'print(+21.3e-5*-.1234/81.7)'
    >>> decistmt(s)
    "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"

    The format of the exponent is inherited from the platform C library.
    Known cases are "e-007" (Windows) and "e-07" (not Windows).  Since
    we're only showing 12 digits, and the 13th isn't close to 5, the
    rest of the output should be platform-independent.

    >>> exec(s)  #doctest: +ELLIPSIS
    -3.21716034272e-0...7

    Output from calculations with Decimal should be identical across all
    platforms.

    >>> exec(decistmt(s))
    -3.217160342717258261933904529E-7
    """
    result = []
    g = tokenize(BytesIO(s.encode('utf-8')).readline)  # tokenize the string
    for toknum, tokval, _, _, _ in g:
        if toknum == NUMBER and '.' in tokval:  # replace NUMBER tokens
            result.extend([
                (NAME, 'Decimal'),
                (OP, '('),
                (STRING, repr(tokval)),
                (OP, ')')
            ])
        else:
            result.append((toknum, tokval))
    return untokenize(result).decode('utf-8')
@end example

Ejemplo de conversión desde la línea de comandos. El `script':

@example
def say_hello():
    print("Hello, World!")

say_hello()
@end example

se convertirá en la salida siguiente, donde la primera columna es el rango de coordenadas línea/columna donde se encuentra el token, la segunda columna es el nombre del token, y la última columna es el valor del token, si lo hay

@example
$ python -m tokenize hello.py
0,0-0,0:            ENCODING       'utf-8'
1,0-1,3:            NAME           'def'
1,4-1,13:           NAME           'say_hello'
1,13-1,14:          OP             '('
1,14-1,15:          OP             ')'
1,15-1,16:          OP             ':'
1,16-1,17:          NEWLINE        '\n'
2,0-2,4:            INDENT         '    '
2,4-2,9:            NAME           'print'
2,9-2,10:           OP             '('
2,10-2,25:          STRING         '"Hello, World!"'
2,25-2,26:          OP             ')'
2,26-2,27:          NEWLINE        '\n'
3,0-3,1:            NL             '\n'
4,0-4,0:            DEDENT         '@w{'}
4,0-4,9:            NAME           'say_hello'
4,9-4,10:           OP             '('
4,10-4,11:          OP             ')'
4,11-4,12:          NEWLINE        '\n'
5,0-5,0:            ENDMARKER      '@w{'}
@end example

Los nombres de tipos de token exactos se pueden mostrar con la opción @ref{45d6,,-e}:

@example
$ python -m tokenize -e hello.py
0,0-0,0:            ENCODING       'utf-8'
1,0-1,3:            NAME           'def'
1,4-1,13:           NAME           'say_hello'
1,13-1,14:          LPAR           '('
1,14-1,15:          RPAR           ')'
1,15-1,16:          COLON          ':'
1,16-1,17:          NEWLINE        '\n'
2,0-2,4:            INDENT         '    '
2,4-2,9:            NAME           'print'
2,9-2,10:           LPAR           '('
2,10-2,25:          STRING         '"Hello, World!"'
2,25-2,26:          RPAR           ')'
2,26-2,27:          NEWLINE        '\n'
3,0-3,1:            NL             '\n'
4,0-4,0:            DEDENT         '@w{'}
4,0-4,9:            NAME           'say_hello'
4,9-4,10:           LPAR           '('
4,10-4,11:          RPAR           ')'
4,11-4,12:          NEWLINE        '\n'
5,0-5,0:            ENDMARKER      '@w{'}
@end example

Ejemplo de tokenización de un fichero programáticamente, leyendo cadenas unicode en lugar de `bytes' con @ref{582,,generate_tokens()}:

@example
import tokenize

with tokenize.open('hello.py') as f:
    tokens = tokenize.generate_tokens(f.readline)
    for token in tokens:
        print(token)
@end example

O leyendo `bytes' directamente con @ref{581,,tokenize()}:

@example
import tokenize

with open('hello.py', 'rb') as f:
    tokens = tokenize.tokenize(f.readline)
    for token in tokens:
        print(token)
@end example

@node tabnanny — Detection of ambiguous indentation,pyclbr — Python module browser support,tokenize — Tokenizer for Python source,Servicios del lenguaje Python
@anchor{library/tabnanny doc}@anchor{45d9}@anchor{library/tabnanny module-tabnanny}@anchor{dd}@anchor{library/tabnanny tabnanny-detection-of-ambiguous-indentation}@anchor{45da}
@subsection @code{tabnanny} — Detection of ambiguous indentation


@geindex module; tabnanny

@c rudimentary documentation based on module comments

`Código fuente:' Lib/tabnanny.py@footnote{https://github.com/python/cpython/tree/main/Lib/tabnanny.py}


__________________________________________________________________


Por el momento, este módulo está pensado para ser llamado como un script. Sin embargo, es posible importarlo en un IDE y usar la función @ref{45db,,check()} que se describe a continuación.

@cartouche
@quotation Nota 
Es probable que la API proporcionada por este módulo cambie en versiones futuras; dichos cambios pueden no ser compatibles con versiones anteriores.
@end quotation
@end cartouche

@geindex check() (en el módulo tabnanny)
@anchor{library/tabnanny tabnanny check}@anchor{45db}
@deffn {Función} tabnanny.check (file_or_dir)

Si `file_or_dir' es un directorio y no un enlace simbólico, desciende recursivamente en el árbol de directorios nombrado por `file_or_dir', verificando todos los archivos @code{.py} al mismo tiempo. Si `file_or_dir' es un archivo fuente normal de Python, se comprueba si hay problemas relacionados con los espacios en blanco. Los mensajes de diagnóstico se escriben en la salida estándar mediante la función @ref{ff4,,print()}.
@end deffn

@geindex verbose (en el módulo tabnanny)
@anchor{library/tabnanny tabnanny verbose}@anchor{45dc}
@deffn {Dato} tabnanny.verbose

Marcador que indica si se deben imprimir mensajes detallados. Esto se incrementa con la opción @code{-v} si se llama como un script.
@end deffn

@geindex filename_only (en el módulo tabnanny)
@anchor{library/tabnanny tabnanny filename_only}@anchor{45dd}
@deffn {Dato} tabnanny.filename_only

Marcador que indica si se deben imprimir solo los nombres de archivo de los archivos que contienen problemas relacionados con los espacios en blanco. Esto se establece como verdadero con la opción @code{-q}  si se llama como un script.
@end deffn

@geindex NannyNag
@anchor{library/tabnanny tabnanny NannyNag}@anchor{45de}
@deffn {Excepción} tabnanny.NannyNag

Invocada por @ref{45df,,process_tokens()} sí detecta una indentación ambigua. Capturada y gestionada en @ref{45db,,check()}.
@end deffn

@geindex process_tokens() (en el módulo tabnanny)
@anchor{library/tabnanny tabnanny process_tokens}@anchor{45df}
@deffn {Función} tabnanny.process_tokens (tokens)

Esta función es utilizada por @ref{45db,,check()} para procesar los tokens generados por el módulo @ref{fb,,tokenize}.
@end deffn

@c XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
@c reset_globals


@subsubheading Ver también



@table @asis

@item Módulo @ref{fb,,tokenize}

Escáner léxico para código fuente Python.
@end table


@node pyclbr — Python module browser support,py_compile — Compile Python source files,tabnanny — Detection of ambiguous indentation,Servicios del lenguaje Python
@anchor{library/pyclbr doc}@anchor{45e0}@anchor{library/pyclbr module-pyclbr}@anchor{b4}@anchor{library/pyclbr pyclbr-python-module-browser-support}@anchor{45e1}
@subsection @code{pyclbr} — Python module browser support


@geindex module; pyclbr

`Código fuente:' Lib/pyclbr.py@footnote{https://github.com/python/cpython/tree/main/Lib/pyclbr.py}


__________________________________________________________________


El módulo @ref{b4,,pyclbr} proporciona información limitada sobre las funciones, clases y métodos definidos en un módulo de Python. La información es suficiente para implementar un navegador de módulos. La información se extrae del código fuente de Python en lugar de importar el módulo, por lo que este módulo es seguro de usar con código que no es de confianza. Esta restricción hace que sea imposible utilizar este módulo con módulos no implementados en Python, incluidos todos los módulos de extensión estándar y opcionales.

@geindex readmodule() (en el módulo pyclbr)
@anchor{library/pyclbr pyclbr readmodule}@anchor{8c2}
@deffn {Función} pyclbr.readmodule (module, path=None)

Retorna un diccionario que asigna nombres de clase a nivel de módulo con descriptores de clase. Si es posible, se incluyen descriptores para las clases base importadas. El parámetro `module' es una cadena con el nombre del módulo que se va a leer; puede ser el nombre de un módulo dentro de un paquete. Si se indica, `path' es una secuencia de rutas de directorios antepuesto a @code{sys.path}, que se utiliza para localizar el código fuente del módulo.

Esta función es la interfaz original y sólo se mantiene por compatibilidad. Retorna una versión filtrada de lo siguiente.
@end deffn

@geindex readmodule_ex() (en el módulo pyclbr)
@anchor{library/pyclbr pyclbr readmodule_ex}@anchor{8c3}
@deffn {Función} pyclbr.readmodule_ex (module, path=None)

Retorna un árbol basado en diccionarios que contiene un descriptor de función o clase para cada función y clase definida en el módulo con una instrucción @code{def} o @code{class}. El diccionario retornado asigna nombres de clase y función a nivel de módulo con sus descriptores. Los objetos anidados se introducen en el diccionario hijo de su elemento padre. Al igual que con `readmodule', `module' nombra el módulo que se va a leer y `path' se antepone a sys.path. Si el módulo que se lee es un paquete, el diccionario retornado tiene una clave @code{'__path__'} cuyo valor es una lista que contiene la ruta del paquete.
@end deffn


Added in version 3.7: Descriptores para definiciones anidadas. Se accede a ellos a través del nuevo atributo `children'. Cada uno tiene un nuevo atributo `parent'.


Los descriptores retornados por estas funciones son instancias de las clases Function y Class. No se espera que los usuarios creen instancias de estas clases.

@menu
* Objetos Function:: 
* Objetos Class:: 

@end menu

@node Objetos Function,Objetos Class,,pyclbr — Python module browser support
@anchor{library/pyclbr function-objects}@anchor{45e2}@anchor{library/pyclbr pyclbr-function-objects}@anchor{45e3}
@subsubsection Objetos Function


@geindex Function (clase en pyclbr)
@anchor{library/pyclbr pyclbr Function}@anchor{45e4}
@deffn {Clase} pyclbr.Function

Class @code{Function} instances describe functions defined by def
statements.  They have the following attributes:

@geindex file (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function file}@anchor{45e5}
@deffn {Atributo} file

Nombre del archivo en el cual la función está definida.
@end deffn

@geindex module (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function module}@anchor{45e6}
@deffn {Atributo} module

El nombre del módulo que define la función descrita.
@end deffn

@geindex name (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function name}@anchor{45e7}
@deffn {Atributo} name

El nombre de la función.
@end deffn

@geindex lineno (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function lineno}@anchor{45e8}
@deffn {Atributo} lineno

El número de línea el en archivo donde inicia la definición.
@end deffn

@geindex parent (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function parent}@anchor{45e9}
@deffn {Atributo} parent

For top-level functions, @code{None}.  For nested functions, the parent.


Added in version 3.7.

@end deffn

@geindex children (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function children}@anchor{45ea}
@deffn {Atributo} children

A @ref{190,,dictionary} mapping names to descriptors for nested functions and
classes.


Added in version 3.7.

@end deffn

@geindex is_async (atributo de pyclbr.Function)
@anchor{library/pyclbr pyclbr Function is_async}@anchor{45eb}
@deffn {Atributo} is_async

@code{True} for functions that are defined with the
@ref{672,,async} prefix, @code{False} otherwise.


Added in version 3.10.

@end deffn
@end deffn

@node Objetos Class,,Objetos Function,pyclbr — Python module browser support
@anchor{library/pyclbr class-objects}@anchor{45ec}@anchor{library/pyclbr pyclbr-class-objects}@anchor{45ed}
@subsubsection Objetos Class


@geindex Class (clase en pyclbr)
@anchor{library/pyclbr pyclbr Class}@anchor{45ee}
@deffn {Clase} pyclbr.Class

Class @code{Class} instances describe classes defined by class
statements.  They have the same attributes as @ref{45e4,,Functions}
and two more.

@geindex file (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class file}@anchor{45ef}
@deffn {Atributo} file

Nombre del archivo en el que la clase está definida.
@end deffn

@geindex module (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class module}@anchor{45f0}
@deffn {Atributo} module

Nombre del módulo que define la clase descrita.
@end deffn

@geindex name (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class name}@anchor{45f1}
@deffn {Atributo} name

El nombre de la clase.
@end deffn

@geindex lineno (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class lineno}@anchor{45f2}
@deffn {Atributo} lineno

El número de línea el en archivo donde inicia la definición.
@end deffn

@geindex parent (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class parent}@anchor{45f3}
@deffn {Atributo} parent

For top-level classes, @code{None}.  For nested classes, the parent.


Added in version 3.7.

@end deffn

@geindex children (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class children}@anchor{45f4}
@deffn {Atributo} children

Un diccionario asignando nombres con descriptores para las clases y funciones anidadas.


Added in version 3.7.

@end deffn

@geindex super (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class super}@anchor{45f5}
@deffn {Atributo} super

A list of @code{Class} objects which describe the immediate base
classes of the class being described.  Classes which are named as
superclasses but which are not discoverable by @ref{8c3,,readmodule_ex()}
are listed as a string with the class name instead of as
@code{Class} objects.
@end deffn

@geindex methods (atributo de pyclbr.Class)
@anchor{library/pyclbr pyclbr Class methods}@anchor{45f6}
@deffn {Atributo} methods

A @ref{190,,dictionary} mapping method names to line numbers.
This can be derived from the newer @ref{45f4,,children} dictionary,
but remains for
back-compatibility.
@end deffn
@end deffn

@node py_compile — Compile Python source files,compileall — Byte-compile Python libraries,pyclbr — Python module browser support,Servicios del lenguaje Python
@anchor{library/py_compile doc}@anchor{45f7}@anchor{library/py_compile module-py_compile}@anchor{b3}@anchor{library/py_compile py-compile-compile-python-source-files}@anchor{45f8}
@subsection @code{py_compile} — Compile Python source files


@geindex module; py_compile

@c documentation based on module docstrings

`Código fuente' Lib/py_compile.py@footnote{https://github.com/python/cpython/tree/main/Lib/py_compile.py}

@geindex file;byte-code


__________________________________________________________________


El módulo @ref{b3,,py_compile} provee una función para generar un archivo de código de bytes de un archivo fuente, y otra función usada cuando el módulo archivo fuente es invocado como un script.

Aunque no es necesario seguidamente, esta función puede ser útil cuando se instalan módulos para uso compartido, especialmente si algunos de los usuarios pueden no tener permisos para escribir el archivo caché de bytes en el directorio conteniendo el código fuente.

@geindex PyCompileError
@anchor{library/py_compile py_compile PyCompileError}@anchor{45f9}
@deffn {Excepción} py_compile.PyCompileError

Cuando un error ocurre mientras se intenta compilar el archivo, se lanza una excepción.
@end deffn

@geindex compile() (en el módulo py_compile)
@anchor{library/py_compile py_compile compile}@anchor{ab7}
@deffn {Función} py_compile.compile (file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP, quiet=0)

Compile a source file to byte-code and write out the byte-code cache file.
The source code is loaded from the file named `file'.  The byte-code is
written to `cfile', which defaults to the 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python Enhancement Proposals; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} path, ending
in @code{.pyc}.
For example, if `file' is @code{/foo/bar/baz.py} `cfile' will default to
@code{/foo/bar/__pycache__/baz.cpython-32.pyc} for Python 3.2.  If `dfile' is
specified, it is used instead of `file' as the name of the source file from
which source lines are obtained for display in exception tracebacks.
If `doraise' is true, a @ref{45f9,,PyCompileError} is raised
when an error is encountered while compiling `file'. If `doraise' is false
(the default), an error string is written to @code{sys.stderr}, but no exception
is raised.  This function returns the path to byte-compiled file, i.e.
whatever `cfile' value was used.

Los argumentos `doraise' y `quiet' determinan cómo los errores son gestionados mientras se compila el archivo. Si `quiet' es 0 o 1, y `doraise' es falso, la conducta por defecto es habilitada: un error cadena de caracteres es escrito a @code{sys.stderr}, y la función retorna @code{None} en vez de una ruta. Si `doraise' es verdadero, se lanzará un @ref{45f9,,PyCompileError}. Sin embargo si `quiet' es 2, ningún mensaje es escrito y `doraise' no tiene efecto.

Si la ruta que `cfile' se convierte (sea especificada explícitamente o computada) es un enlace simbólico o archivo no regular, se lanzará @ref{109c,,FileExistsError}. Esto es para actuar como una advertencia que la importación convertirá esas rutas en archivos regulares si ésta tiene permitido escribir archivos compilados en bytes a esas rutas. Este es un efecto secundario de importar usando el renombramiento de archivos para colocar el archivo de bytes compilado final en el lugar para prevenir problemas de escritura en archivos simultáneos.

`optimize' controla el nivel de optimización y si es pasado a la función construida @ref{2fb,,compile()}.  El predeterminado de @code{-1} selecciona el nivel de optimización del intérprete actual.

`invalidation_mode' debería ser un miembro del enum @ref{45fa,,PycInvalidationMode} y controla cómo el caché de código de bytes generado es invalidado en el tiempo de ejecución.  El predeterminado es @ref{45fb,,PycInvalidationMode.CHECKED_HASH} si la variable de entorno 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} está establecida, de otra manera el predeterminado es @ref{45fc,,PycInvalidationMode.TIMESTAMP}.


Distinto en la versión 3.2: Cambiado el valor por defecto de `cfile' para que cumpla 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}. El por defecto anterior era `file' + @code{'c'} (@code{'o'} si la optimización estaba habilitada). También agregado el parámetro `optimize'.



Distinto en la versión 3.4: Se cambió el código para usar @ref{77,,importlib} para la escritura del archivo almacenado de código de bytes. Esto significa que la semántica de la creación/escritura del archivo ahora coincide con lo que @ref{77,,importlib} hace, por ejemplo permisos, semántica de escribir-y-mover, etc. Además se agregó la consideración de que @ref{109c,,FileExistsError} es lanzado si `cfile' es un enlace simbólico o un archivo no regular.



Distinto en la versión 3.7: El parámetro `invalidation_mode' fue agregado como se especificó en 
@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/}. Si la variable de entorno 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} se establece, `invalidation_mode' será forzada a @ref{45fb,,PycInvalidationMode.CHECKED_HASH}.



Distinto en la versión 3.7.2: La variable de entorno 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} ya no sobreescribe el valor del argumento `invalidation_mode', y en vez de eso determina su valor por defecto.



Distinto en la versión 3.8: El parámetro `quiet' fue agregado.

@end deffn

@geindex PycInvalidationMode (clase en py_compile)
@anchor{library/py_compile py_compile PycInvalidationMode}@anchor{45fa}
@deffn {Clase} py_compile.PycInvalidationMode

An enumeration of possible methods the interpreter can use to determine
whether a bytecode file is up to date with a source file. The @code{.pyc} file
indicates the desired invalidation mode in its header. See
@ref{68c,,Invalidación del código de bytes en caché} for more information on how Python invalidates
@code{.pyc} files at runtime.


Added in version 3.7.


@geindex TIMESTAMP (atributo de py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode TIMESTAMP}@anchor{45fc}
@deffn {Atributo} TIMESTAMP

El archivo @code{.pyc} incluye una marca de tiempo y tamaño del archivo fuente, el cual Python comparará contra los metadatos del archivo fuente durante el tiempo de ejecución para determinar si el archivo @code{.pyc} necesita ser regenerado.
@end deffn

@geindex CHECKED_HASH (atributo de py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode CHECKED_HASH}@anchor{45fb}
@deffn {Atributo} CHECKED_HASH

El archivo @code{.pyc} incluye un hash del contenido del archivo fuente, el cual Python comparará contra la fuente durante el tiempo de ejecución para determinar si el archivo @code{.pyc} necesita ser regenerado.
@end deffn

@geindex UNCHECKED_HASH (atributo de py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode UNCHECKED_HASH}@anchor{45fd}
@deffn {Atributo} UNCHECKED_HASH

Como @ref{45fb,,CHECKED_HASH}, el archivo @code{.pyc} incluye un has del contenido del archivo fuente. Sin embargo, Python asumirá durante el tiempo de ejecución que el archivo @code{.pyc} está actualizado y no validará el @code{.pyc} contra el archivo fuente en lo absoluto.

Esta opción es útil cuando los @code{.pucs} se mantienen actualizados al día por algún sistema externo a Python como un sistema de compilación.
@end deffn
@end deffn

@menu
* Interfaz de línea de comandos: Interfaz de línea de comandos<6>. 

@end menu

@node Interfaz de línea de comandos<6>,,,py_compile — Compile Python source files
@anchor{library/py_compile command-line-interface}@anchor{45fe}@anchor{library/py_compile py-compile-cli}@anchor{45ff}
@subsubsection Interfaz de línea de comandos


Este módulo puede invocarse como un script para compilar varios archivos fuente. Los archivos nombrados en `filenames' se compilan y el código de bytes resultante se almacena en caché de la manera normal. Este programa no busca en una estructura de directorio para localizar archivos fuente; solo compila archivos nombrados explícitamente. El estado de salida es distinto de cero si uno de los archivos no se pudo compilar.

@geindex opción de línea de comando python--m-py_compile; <file>
@geindex opción de línea de comando python--m-py_compile; -
@anchor{library/py_compile cmdoption-python-m-py_compile-arg-file}@anchor{4600}
@deffn {Option} <file> ... <fileN>
@anchor{library/py_compile cmdoption-python-m-py_compile}@anchor{4601}
@deffnx {Option} @w{-}

Los argumentos posicionales son archivos para compilar. Si @code{-} es el único parámetro, la lista de archivos se toma de la entrada estándar.
@end deffn

@geindex opción de línea de comando python--m-py_compile; -q
@geindex opción de línea de comando python--m-py_compile; --quiet
@anchor{library/py_compile cmdoption-python-m-py_compile-q}@anchor{4602}@anchor{library/py_compile cmdoption-python-m-py_compile-quiet}@anchor{4603}
@deffn {Option} @w{-}q, @w{-}@w{-}quiet

Suprime la salida de errores.
@end deffn


Distinto en la versión 3.2: Agregado soporte para @code{-}.



Distinto en la versión 3.10: Agregado soporte para @ref{4602,,-q}.



@subsubheading Ver también



@table @asis

@item Módulo @ref{21,,compileall}

Utilidades para compilar todos los archivos fuente Python en el árbol del directorio.
@end table


@node compileall — Byte-compile Python libraries,dis — Disassembler for Python bytecode,py_compile — Compile Python source files,Servicios del lenguaje Python
@anchor{library/compileall doc}@anchor{4604}@anchor{library/compileall compileall-byte-compile-python-libraries}@anchor{4605}@anchor{library/compileall module-compileall}@anchor{21}
@subsection @code{compileall} — Byte-compile Python libraries


@geindex module; compileall

`Código fuente:' Lib/compileall.py@footnote{https://github.com/python/cpython/tree/main/Lib/compileall.py}


__________________________________________________________________


Este módulo proporciona algunas funciones de utilidad para admitir la instalación de bibliotecas Python. Estas funciones compilan archivos fuente de Python en un árbol de directorios. Este módulo se puede usar para crear los archivos de código de bytes almacenados en caché en el momento de la instalación de la biblioteca, que los hace disponibles para su uso incluso por usuarios que no tienen permiso de escritura en los directorios de la biblioteca.

@c include for modules that don't work on WASM

@ref{1d5a,,Availability}: not WASI.

This module does not work or is not available on WebAssembly. See
@ref{17e8,,Plataformas WebAssembly} for more information.

@menu
* Uso de la línea de comandos: Uso de la línea de comandos<4>. 
* Funciones públicas:: 

@end menu

@node Uso de la línea de comandos<4>,Funciones públicas,,compileall — Byte-compile Python libraries
@anchor{library/compileall command-line-use}@anchor{4606}@anchor{library/compileall compileall-cli}@anchor{4607}
@subsubsection Uso de la línea de comandos


Este módulo puede funcionar como un `script' (usando  @code{python -m compileall}) para compilar fuentes de Python.

@geindex opción de línea de comando compileall; directory
@geindex opción de línea de comando compileall; file
@anchor{library/compileall cmdoption-compileall-arg-directory}@anchor{4608}
@deffn {Option} directory ...
@anchor{library/compileall cmdoption-compileall-arg-file}@anchor{4609}
@deffnx {Option} file ...

Positional arguments are files to compile or directories that contain
source files, traversed recursively.  If no argument is given, behave as if
the command line was @code{-l @var{<directories from sys.path>}}.
@end deffn

@geindex opción de línea de comando compileall; -l
@anchor{library/compileall cmdoption-compileall-l}@anchor{460a}
@deffn {Option} @w{-}l

No se recurre en subdirectorios, solo compila archivos de código fuente contenidos en directorios nombrados o implícitos.
@end deffn

@geindex opción de línea de comando compileall; -f
@anchor{library/compileall cmdoption-compileall-f}@anchor{460b}
@deffn {Option} @w{-}f

Forzar la reconstrucción incluso si las marcas de tiempo están actualizadas.
@end deffn

@geindex opción de línea de comando compileall; -q
@anchor{library/compileall cmdoption-compileall-q}@anchor{460c}
@deffn {Option} @w{-}q

No imprimir la lista de archivos compilados. Si se pasa una vez, los mensajes de error se imprimirán. Si se pasa dos veces, (@code{-qq}), se suprime toda la salida.
@end deffn

@geindex opción de línea de comando compileall; -d
@anchor{library/compileall cmdoption-compileall-d}@anchor{460d}
@deffn {Option} @w{-}d destdir

Directorio antepuesto a la ruta de cada archivo que está siendo compilado. Esto aparecerá en las devoluciones de tiempo de compilación, y también se compila en el archivo de código de bytes, donde se usará en las devoluciones de seguimiento y otros mensajes en casos donde el archivo fuente no existe al momento en que el archivo de código de bytes se ejecuta.
@end deffn

@geindex opción de línea de comando compileall; -s
@anchor{library/compileall cmdoption-compileall-s}@anchor{460e}
@deffn {Option} @w{-}s strip_prefix
@end deffn

@geindex opción de línea de comando compileall; -p
@anchor{library/compileall cmdoption-compileall-p}@anchor{460f}
@deffn {Option} @w{-}p prepend_prefix

Elimina (@code{-s}) o agrega (@code{-p}) el prefijo dado de rutas registradas en los archivos @code{.pyc}. No se puede combinar con @code{-d}.
@end deffn

@geindex opción de línea de comando compileall; -x
@anchor{library/compileall cmdoption-compileall-x}@anchor{4610}
@deffn {Option} @w{-}x regex

regex se usa para buscar la ruta completa a cada archivo considerado para compilación, y si la regex produce una coincidencia, se omite el archivo.
@end deffn

@geindex opción de línea de comando compileall; -i
@anchor{library/compileall cmdoption-compileall-i}@anchor{4611}
@deffn {Option} @w{-}i list

Leer el archivo @code{list} y cada línea que contiene la lista de archivos y directorios a compilar. Si @code{list} es @code{-}, leer líneas desde @code{stdin}.
@end deffn

@geindex opción de línea de comando compileall; -b
@anchor{library/compileall cmdoption-compileall-b}@anchor{4612}
@deffn {Option} @w{-}b

Escribir los archivos de código de byte en las locaciones y nombres de herencia, que pueden sobreescribir los archivos de código de bytes creado para otra versión de Python. El comportamiento por defecto es escribir archivos en sus locaciones y nombres 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, lo cual permite que archivos de código de byte de versiones múltiples de Python coexistan.
@end deffn

@geindex opción de línea de comando compileall; -r
@anchor{library/compileall cmdoption-compileall-r}@anchor{4613}
@deffn {Option} @w{-}r

Controlar el nivel máximo de recurrencia para subdirectorios. Si esto está dado, la opción @code{-l} no se tendrá en cuenta. @code{python -m compileall <directory> -r 0} es equivalente a @code{python -m compileall <directory> -l}.
@end deffn

@geindex opción de línea de comando compileall; -j
@anchor{library/compileall cmdoption-compileall-j}@anchor{4614}
@deffn {Option} @w{-}j N

Use `N' workers to compile the files within the given directory.
If @code{0} is used, then the result of @ref{327,,os.process_cpu_count()}
will be used.
@end deffn

@geindex opción de línea de comando compileall; --invalidation-mode
@anchor{library/compileall cmdoption-compileall-invalidation-mode}@anchor{4615}
@deffn {Option} @w{-}@w{-}invalidation@w{-}mode [timestamp|checked@w{-}hash|unchecked@w{-}hash]

Controlar cómo los archivos de código de byte generados se invalidan al momento de ejecución. El valor @code{timestamp} significa que se generarán los archivos @code{.pyc} con la marca de tiempo fuente y el tamaño insertados. Los valores @code{checked-hash} y @code{unchecked-hash} generan `pycs' basados en hash. Los `pycs' basados en hash del archivo insertan un hash de los contenidos del archivo fuente, en lugar de una marca de tiempo. Véase @ref{68c,,Invalidación del código de bytes en caché} para mayor información sobre cómo Python valida archivos de cache de código de bytes. El valor por defecto es @code{timestamp}  si la variable de entorno 
@geindex SOURCE_DATE_EPOCH
@geindex variables de entorno; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} no está definida, y @code{checked-hash} si la variable de entorno @code{SOURCE_DATE_EPOCH} está definida.
@end deffn

@geindex opción de línea de comando compileall; -o
@anchor{library/compileall cmdoption-compileall-o}@anchor{4616}
@deffn {Option} @w{-}o level

Compila con el nivel de optimización dado. Puede usarse varias veces para compilar varios niveles a la vez (por ejemplo, @code{compileall -o 1 -o 2}).
@end deffn

@geindex opción de línea de comando compileall; -e
@anchor{library/compileall cmdoption-compileall-e}@anchor{4617}
@deffn {Option} @w{-}e dir

Ignora los enlaces simbólicos que apuntan fuera del directorio dado.
@end deffn

@geindex opción de línea de comando compileall; --hardlink-dupes
@anchor{library/compileall cmdoption-compileall-hardlink-dupes}@anchor{4618}
@deffn {Option} @w{-}@w{-}hardlink@w{-}dupes

Si dos archivos @code{.pyc} con diferente nivel de optimización tienen el mismo contenido, use enlaces físicos para consolidar los archivos duplicados.
@end deffn


Distinto en la versión 3.2: Se agregaron las opciones @code{-i}, @code{-b} y @code{-h}.



Distinto en la versión 3.5: Se agregaron las opciones @code{-j}, @code{-r}, and @code{-qq}. La opción @code{-q} se cambió a un valor multinivel. @code{-b} siempre producirá un archivo de código de byte que termina en @code{.pyc}, nunca @code{.pyo}.



Distinto en la versión 3.7: Se agregó la opción @code{--invalidation-mode}.



Distinto en la versión 3.9: Se agregaron las opciones @code{-s}, @code{-p}, @code{-e} y @code{--hardlink-dupes}. Se elevó el límite de recursividad predeterminado de 10 a @ref{56b,,sys.getrecursionlimit()}. Se agregó la posibilidad de especificar la opción @code{-o} varias veces.


No hay opción de línea de comando para controlar el nivel de optimización que usa la función @ref{2fb,,compile()} porque el intérprete de Python en sí mismo ya proporciona la opción: @code{python -O -m compileall}.

Similarly, the @ref{2fb,,compile()} function respects the @ref{a36,,sys.pycache_prefix}
setting. The generated bytecode cache will only be useful if @ref{2fb,,compile()} is
run with the same @ref{a36,,sys.pycache_prefix} (if any) that will be used at
runtime.

@node Funciones públicas,,Uso de la línea de comandos<4>,compileall — Byte-compile Python libraries
@anchor{library/compileall public-functions}@anchor{4619}
@subsubsection Funciones públicas


@geindex compile_dir() (en el módulo compileall)
@anchor{library/compileall compileall compile_dir}@anchor{baf}
@deffn {Función} compileall.compile_dir (dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)

Descender recursivamente el árbol de directorio invocado por `dir', compilando todos los archivos @code{.py} que encuentra en el camino. Devolver un valor verdadero si todos los archivos se compilan exitosamente, y un valor falso en el caso contrario.

El parámetro `maxlevels' se usar para limitar la profundidad de la recursión; toma como valor predeterminado @code{sys.getrecursionlimit()}.

Si `ddir' está dado, se antepone a la ruta de cada archivo que se compila para usar en los rastreos de tiempo de compilación, y también se compilar en el archivo código de byte, donde se usarán en trazas y otros mensajes en casos donde el archivo fuente no existe en el momento cuando el archivo de código de byte se ejecuta.

Si `force' es verdadero, los módulos se re-compilan aun cuando las marcas de tiempo están actualizadas.

Si se proporciona `rx', se llama a su método @code{search} en la ruta completa a cada archivo considerado para compilación, y si retorna un valor verdadero, se omite el archivo. Esto se puede usar para excluir archivos que coincidan con una expresión regular, dada como un objeto @ref{1005,,re.Pattern}.

Si `quiet' es @code{False} o @code{0} (el valor predeterminado), los nombres de archivo y otra información se imprimen en salida estándar. Si se configura en @code{1}, solo se imprimen los errores. Si se configura en @code{2}, se suprime toda la salida.

Si `legacy' es verdadero, los archivos de código de byte se escriben en sus locaciones y nombres de herencia, que pueden sobreescribir los archivos de código de byte creado por otra versión de Python. El comportamiento por defecto es escribir archivos en sus locaciones y nombres 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, lo cual permite que archivos de código de byte de múltiples versiones de Python coexistan.

`optimize' especifica el nivel de optimización para el compilador. Se pasa a una función incorporada @ref{2fb,,compile()}. Acepta también una secuencia de niveles de optimización que conducen a múltiples compilaciones de un archivo @code{.py} en una llamada.

El argumento `workers' especifica cuántos workers se usan para compilar archivos en paralelo. El comportamiento por defecto es no usar múltiples workers. Si la plataforma no puede usar workers múltiples y el argumento `workers' está dado, la compilación secuencial se usará como `fallback'. Si `workers' es 0, el número de núcleos se usa en el sistema. Si `workers' es menor que @code{0}, se genera un @ref{360,,ValueError}.

`invalidation_mode' debería ser un miembro de la enumeración @ref{45fa,,py_compile.PycInvalidationMode} y controla cómo se invalidan los pycs generados en el momento de ejecución.

The `stripdir', `prependdir' and `limit_sl_dest' arguments correspond to
the @code{-s}, @code{-p} and @code{-e} options described above.
They may be specified as @code{str} or @ref{cd9,,os.PathLike}.

Si `hardlink_dupes' es verdadero y dos archivos @code{.pyc} con diferente nivel de optimización tienen el mismo contenido, use enlaces físicos para consolidar los archivos duplicados.


Distinto en la versión 3.2: Se agregó el parámetro `legacy' y `optimize'.



Distinto en la versión 3.5: Se agregó el parámetro `workers'.



Distinto en la versión 3.5: El parámetro `quiet' se cambió a un valor multinivel.



Distinto en la versión 3.5: El parámetro `legacy' solo escribe archivos @code{.pyc}, no archivos @code{.pyo}, no import cuál sea el valor de `optimize'.



Distinto en la versión 3.6: Acepta un @ref{3f0,,path-like object}.



Distinto en la versión 3.7: Se agregó el parámetro `invalidation_mode'.



Distinto en la versión 3.7.2: The `invalidation_mode' parameter’s default value is updated to @code{None}.



Distinto en la versión 3.8: Configurar `workers' a 0 ahora elige el número óptimo de núcleos.



Distinto en la versión 3.9: Se agregaron los argumentos `stripdir', `prependdir', `limit_sl_dest' y `hardlink_dupes'. El valor predeterminado de `maxlevels' se cambió de @code{10} a @code{sys.getrecursionlimit()}

@end deffn

@geindex compile_file() (en el módulo compileall)
@anchor{library/compileall compileall compile_file}@anchor{e66}
@deffn {Función} compileall.compile_file (fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)

Compilar el archivo con ruta `fullname'. Retorna un valor verdadero si el archivo se compila exitosamente, y uno falso en el caso contrario.

Si `ddir' está dado, se antepone a la ruta del archivo que está siendo compilado para su uso en las trazas de tiempo de compilación, y también se compilar en el archivo de código de bytes, donde será utilizado en trazas y otros mensajes en casos donde el archivo fuente no existe en el momento en que el archivo de código de bytes es ejecutado.

Si se proporciona `rx', a su método @code{search} se le pasa el nombre de ruta completo al archivo que se está compilando, y si retorna un valor verdadero, el archivo no se compila y se retorna @code{True}. Esto se puede usar para excluir archivos que coincidan con una expresión regular, dada como un objeto @ref{1005,,re.Pattern}.

Si `quiet' es @code{False} o @code{0} (el valor predeterminado), los nombres de archivo y otra información se imprimen en salida estándar. Si se configura en @code{1}, solo se imprimen los errores. Si se configura en @code{2}, se suprime toda la salida.

Si `legacy' es verdadero, los archivos de código de byte se escriben en sus locaciones y nombres de herencia, que pueden sobreescribir los archivos de código de byte creado por otra versión de Python. El comportamiento por defecto es escribir archivos en sus locaciones y nombres 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, lo cual permite que archivos de código de byte de múltiples versiones de Python coexistan.

`optimize' especifica el nivel de optimización para el compilador. Se pasa a una función incorporada @ref{2fb,,compile()}. Acepta también una secuencia de niveles de optimización que conducen a múltiples compilaciones de un archivo @code{.py} en una llamada.

`invalidation_mode' debería ser un miembro de la enumeración @ref{45fa,,py_compile.PycInvalidationMode} y controla cómo se invalidan los pycs generados en el momento de ejecución.

The `stripdir', `prependdir' and `limit_sl_dest' arguments correspond to
the @code{-s}, @code{-p} and @code{-e} options described above.
They may be specified as @code{str} or @ref{cd9,,os.PathLike}.

Si `hardlink_dupes' es verdadero y dos archivos @code{.pyc} con diferente nivel de optimización tienen el mismo contenido, use enlaces físicos para consolidar los archivos duplicados.


Added in version 3.2.



Distinto en la versión 3.5: El parámetro `quiet' se cambió a un valor multinivel.



Distinto en la versión 3.5: El parámetro `legacy' solo escribe archivos @code{.pyc}, no archivos @code{.pyo}, no import cuál sea el valor de `optimize'.



Distinto en la versión 3.7: Se agregó el parámetro `invalidation_mode'.



Distinto en la versión 3.7.2: The `invalidation_mode' parameter’s default value is updated to @code{None}.



Distinto en la versión 3.9: Se agregaron los argumentos `stripdir', `prependdir', `limit_sl_dest' y `hardlink_dupes'.

@end deffn

@geindex compile_path() (en el módulo compileall)
@anchor{library/compileall compileall compile_path}@anchor{e67}
@deffn {Función} compileall.compile_path (skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=None)

Compila en bytes todos los archivos @code{.py} a lo largo de @code{sys.path}. Retorna un valor verdadero si todos los archivos se compilan exitosamente, y uno falso en el caso contrario.

Si `skip_curdir' es verdadero (el valor predeterminado), el directorio actual no está incluido en la búsqueda. Todos los otros parámetros se pasan a la función @ref{baf,,compile_dir()}. Nótese que, al contrario de las otras funciones de compilación, @code{maxlevels} tomar @code{0} como valor predeterminado.


Distinto en la versión 3.2: Se agregó el parámetro `legacy' y `optimize'.



Distinto en la versión 3.5: El parámetro `quiet' se cambió a un valor multinivel.



Distinto en la versión 3.5: El parámetro `legacy' solo escribe archivos @code{.pyc}, no archivos @code{.pyo}, no import cuál sea el valor de `optimize'.



Distinto en la versión 3.7: Se agregó el parámetro `invalidation_mode'.



Distinto en la versión 3.7.2: The `invalidation_mode' parameter’s default value is updated to @code{None}.

@end deffn

Para forzar la re-compilación del los archivos @code{.py} en el subdirectorio @code{Lib/} y todos sus subdirectorios:

@example
import compileall

compileall.compile_dir('Lib/', force=True)

# Perform same compilation, excluding files in .svn directories.
import re
compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)

# pathlib.Path objects can also be used.
import pathlib
compileall.compile_dir(pathlib.Path('Lib/'), force=True)
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{b3,,py_compile}

Compilación byte de un solo archivo fuente.
@end table


@node dis — Disassembler for Python bytecode,pickletools — Tools for pickle developers,compileall — Byte-compile Python libraries,Servicios del lenguaje Python
@anchor{library/dis doc}@anchor{461a}@anchor{library/dis dis-disassembler-for-python-bytecode}@anchor{461b}@anchor{library/dis module-dis}@anchor{39}
@subsection @code{dis} — Disassembler for Python bytecode


@geindex module; dis

`Código fuente:' Lib/dis.py@footnote{https://github.com/python/cpython/tree/main/Lib/dis.py}

@c import dis
@c def myfunc(alist):
@c     return len(alist)


__________________________________________________________________


El módulo @ref{39,,dis} admite el análisis de CPython @ref{2f2,,bytecode} al desarmarlo. El bytecode de CPython que este módulo toma como entrada se define en el archivo @code{Include/opcode.h} y lo utilizan el compilador y el intérprete.

`Detalles de implementación de CPython:' Bytecode es un detalle de implementación del intérprete CPython. No se garantiza que el bytecode no se agregará, eliminará ni cambiará entre las versiones de Python. El uso de este módulo no debe considerarse para trabajar en diferentes máquinas virtuales Python o versiones de Python.


Distinto en la versión 3.6: Use 2 bytes para cada instrucción. Anteriormente, el número de bytes variaba según la instrucción.



Distinto en la versión 3.10: El argumento de las instrucciones de salto, manejo de excepciones y bucle ahora es el desplazamiento de instrucción en lugar del desplazamiento de byte.



Distinto en la versión 3.11: Some instructions are accompanied by one or more inline cache entries,
which take the form of @ref{799,,CACHE} instructions. These instructions
are hidden by default, but can be shown by passing @code{show_caches=True} to
any @ref{39,,dis} utility. Furthermore, the interpreter now adapts the
bytecode to specialize it for different runtime conditions. The
adaptive bytecode can be shown by passing @code{adaptive=True}.



Distinto en la versión 3.12: The argument of a jump is the offset of the target instruction relative
to the instruction that appears immediately after the jump instruction’s
@ref{799,,CACHE} entries.

As a consequence, the presence of the @ref{799,,CACHE} instructions is
transparent for forward jumps but needs to be taken into account when
reasoning about backward jumps.



Distinto en la versión 3.13: The output shows logical labels rather than instruction offsets
for jump targets and exception handlers. The @code{-O} command line
option and the @code{show_offsets} argument were added.



Distinto en la versión 3.14: The @ref{175,,-P} command-line option
and the @code{show_positions} argument were added.


Example: Given the function @code{myfunc()}:

@example
def myfunc(alist):
    return len(alist)
@end example

the following command can be used to display the disassembly of
@code{myfunc()}:

@example
>>> dis.dis(myfunc)
  2           RESUME                   0

  3           LOAD_GLOBAL              1 (len + NULL)
              LOAD_FAST                0 (alist)
              CALL                     1
              RETURN_VALUE
@end example

(El «2» es un número de línea).

@menu
* Command-line interface: Command-line interface<3>. 
* Análisis de bytecode:: 
* Funciones de análisis:: 
* Instrucciones bytecode de Python:: 
* Colecciones opcode:: 

@end menu

@node Command-line interface<3>,Análisis de bytecode,,dis — Disassembler for Python bytecode
@anchor{library/dis command-line-interface}@anchor{461c}@anchor{library/dis dis-cli}@anchor{461d}
@subsubsection Command-line interface


The @ref{39,,dis} module can be invoked as a script from the command line:

@example
python -m dis [-h] [-C] [-O] [-P] [infile]
@end example

The following options are accepted:

@geindex opción de línea de comando dis; -h
@geindex opción de línea de comando dis; --help
@anchor{library/dis cmdoption-dis-h}@anchor{461e}@anchor{library/dis cmdoption-dis-help}@anchor{461f}
@deffn {Opción De Programa} @w{-}h, @w{-}@w{-}help

Display usage and exit.
@end deffn

@geindex opción de línea de comando dis; -C
@geindex opción de línea de comando dis; --show-caches
@anchor{library/dis cmdoption-dis-C}@anchor{4620}@anchor{library/dis cmdoption-dis-show-caches}@anchor{4621}
@deffn {Opción De Programa} @w{-}C, @w{-}@w{-}show@w{-}caches

Show inline caches.
@end deffn

@geindex opción de línea de comando dis; -O
@geindex opción de línea de comando dis; --show-offsets
@anchor{library/dis cmdoption-dis-O}@anchor{33c}@anchor{library/dis cmdoption-dis-show-offsets}@anchor{4622}
@deffn {Opción De Programa} @w{-}O, @w{-}@w{-}show@w{-}offsets

Show offsets of instructions.
@end deffn

@geindex opción de línea de comando dis; -P
@geindex opción de línea de comando dis; --show-positions
@anchor{library/dis cmdoption-dis-P}@anchor{175}@anchor{library/dis cmdoption-dis-show-positions}@anchor{4623}
@deffn {Opción De Programa} @w{-}P, @w{-}@w{-}show@w{-}positions

Show positions of instructions in the source code.
@end deffn

If @code{infile} is specified, its disassembled code will be written to stdout.
Otherwise, disassembly is performed on compiled source code received from stdin.

@node Análisis de bytecode,Funciones de análisis,Command-line interface<3>,dis — Disassembler for Python bytecode
@anchor{library/dis bytecode-analysis}@anchor{4624}
@subsubsection Análisis de bytecode



Added in version 3.4.


La API de análisis de bytecode permite que partes del código Python se envuelvan en un objeto @ref{171,,Bytecode} que proporciona un fácil acceso a los detalles del código compilado.

@geindex Bytecode (clase en dis)
@anchor{library/dis dis Bytecode}@anchor{171}
@deffn {Clase} dis.Bytecode (x, *, first_line=None, current_offset=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

Analiza el bytecode correspondiente a una función, generador, generador asíncrono, corutina, método, cadena de código fuente o un objeto de código (como lo retorna @ref{2fb,,compile()}).

Este es un contenedor conveniente para muchas de las funciones enumeradas a continuación, en particular @ref{33d,,get_instructions()}, ya que iterar sobre una instancia de @ref{171,,Bytecode} produce las operaciones de bytecode como instancias de @ref{170,,Instruction}.

Si `first_line' no es @code{None}, indica el número de línea que se debe informar para la primera línea de origen en el código desmontado. De lo contrario, la información de la línea de origen (si la hay) se toma directamente del objeto de código desmontado.

Si `current_offset' no es @code{None}, se refiere a un desplazamiento de instrucción en el código desmontado. Establecer esto significa @ref{faf,,dis()} mostrará un marcador de «instrucción actual» contra el código de operación especificado.

If `show_caches' is @code{True}, @ref{faf,,dis()} will display inline cache
entries used by the interpreter to specialize the bytecode.

If `adaptive' is @code{True}, @ref{faf,,dis()} will display specialized bytecode
that may be different from the original bytecode.

If `show_offsets' is @code{True}, @ref{faf,,dis()} will include instruction
offsets in the output.

If `show_positions' is @code{True}, @ref{faf,,dis()} will include instruction
source code positions in the output.

@geindex from_traceback() (método de clase de dis.Bytecode)
@anchor{library/dis dis Bytecode from_traceback}@anchor{fb0}
@deffn {Método} classmethod from_traceback (tb, *, show_caches=False)

Construye una instancia de @ref{171,,Bytecode} a partir del `traceback' dado, estableciendo `current_offset' en la instrucción responsable de la excepción.
@end deffn

@geindex Bytecode.codeobj (en el módulo dis)
@anchor{library/dis dis Bytecode codeobj}@anchor{4625}
@deffn {Dato} codeobj

El objeto de código compilado.
@end deffn

@geindex Bytecode.first_line (en el módulo dis)
@anchor{library/dis dis Bytecode first_line}@anchor{4626}
@deffn {Dato} first_line

La primera línea de origen del objeto de código (si está disponible)
@end deffn

@geindex dis() (método de dis.Bytecode)
@anchor{library/dis dis Bytecode dis}@anchor{faf}
@deffn {Método} dis ()

Retorna una vista formateada de las operaciones de bytecode (lo mismo que impreso por @ref{172,,dis.dis()}, pero retornado como una cadena de caracteres multilínea).
@end deffn

@geindex info() (método de dis.Bytecode)
@anchor{library/dis dis Bytecode info}@anchor{4627}
@deffn {Método} info ()

Retorna una cadena de caracteres multilínea formateada con información detallada sobre el objeto de código, como @ref{12a6,,code_info()}.
@end deffn


Distinto en la versión 3.7: Esto ahora puede manejar objetos generadores asíncronos y de corutinas.



Distinto en la versión 3.11: Added the `show_caches' and `adaptive' parameters.



Distinto en la versión 3.13: Added the `show_offsets' parameter



Distinto en la versión 3.14: Added the `show_positions' parameter.

@end deffn

Ejemplo:

@example
>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST
CALL
RETURN_VALUE
@end example

@node Funciones de análisis,Instrucciones bytecode de Python,Análisis de bytecode,dis — Disassembler for Python bytecode
@anchor{library/dis analysis-functions}@anchor{4628}
@subsubsection Funciones de análisis


El módulo @ref{39,,dis} también define las siguientes funciones de análisis que convierten la entrada directamente en la salida deseada. Pueden ser útiles si solo se realiza una sola operación, por lo que el objeto de análisis intermedio no es útil:

@geindex code_info() (en el módulo dis)
@anchor{library/dis dis code_info}@anchor{12a6}
@deffn {Función} dis.code_info (x)

Retorna una cadena de caracteres multilínea formateada con información detallada del objeto de código para la función, generador, generador asíncrono, corutina, método, cadena de código fuente u objeto de código suministrados.

Tenga en cuenta que el contenido exacto de las cadenas de información de código depende en gran medida de la implementación y puede cambiar arbitrariamente en las diferentes máquinas virtuales Python o las versiones de Python.


Added in version 3.2.



Distinto en la versión 3.7: Esto ahora puede manejar objetos generadores asíncronos y de corutinas.

@end deffn

@geindex show_code() (en el módulo dis)
@anchor{library/dis dis show_code}@anchor{fae}
@deffn {Función} dis.show_code (x, *, file=None)

Imprime información detallada del objeto de código para la función, método, cadena de código fuente u objeto de código suministrado en `file' (o @code{sys.stdout} si `file' no está especificado).

Esta es una abreviatura conveniente para @code{print(code_info(x), file=file)}, destinado a la exploración interactiva en el indicador del intérprete (`prompt').


Added in version 3.2.



Distinto en la versión 3.4: Agrega un parámetro `file'.

@end deffn

@geindex dis() (en el módulo dis)
@anchor{library/dis dis dis}@anchor{172}
@deffn {Función} dis.dis (x=None, *, file=None, depth=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

Disassemble the `x' object.  `x' can denote either a module, a class, a
method, a function, a generator, an asynchronous generator, a coroutine,
a code object, a string of source code or a byte sequence of raw bytecode.
For a module, it disassembles all functions. For a class, it disassembles
all methods (including class and static methods). For a code object or
sequence of raw bytecode, it prints one line per bytecode instruction.
It also recursively disassembles nested code objects. These can include
generator expressions, nested functions, the bodies of nested classes,
and the code objects used for @ref{2f3,,annotation scopes}.
Strings are first compiled to code objects with the @ref{2fb,,compile()}
built-in function before being disassembled.  If no object is provided, this
function disassembles the last traceback.

El desensamblaje se escribe como texto en el argumento `file' proporcionado si se proporciona y, de lo contrario, @code{sys.stdout}.

La profundidad máxima de recursión está limitada por `depth' a menos que sea @code{None}. @code{depth=0} significa que no hay recursión.

If `show_caches' is @code{True}, this function will display inline cache
entries used by the interpreter to specialize the bytecode.

If `adaptive' is @code{True}, this function will display specialized bytecode
that may be different from the original bytecode.


Distinto en la versión 3.4: Agrega un parámetro `file'.



Distinto en la versión 3.7: Desensamblaje recursivo implementado y parámetro agregado `depth'.



Distinto en la versión 3.7: Esto ahora puede manejar objetos generadores asíncronos y de corutinas.



Distinto en la versión 3.11: Added the `show_caches' and `adaptive' parameters.



Distinto en la versión 3.13: Added the `show_offsets' parameter.



Distinto en la versión 3.14: Added the `show_positions' parameter.

@end deffn

@geindex distb() (en el módulo dis)
@anchor{library/dis dis distb}@anchor{173}
@deffn {Función} dis.distb (tb=None, *, file=None, show_caches=False, adaptive=False, show_offset=False, show_positions=False)

Desmonta la función de inicio de pila de un rastreo, utilizando el último rastreo si no se pasó ninguno. Se indica la instrucción que causa la excepción.

El desensamblaje se escribe como texto en el argumento `file' proporcionado si se proporciona y, de lo contrario, @code{sys.stdout}.


Distinto en la versión 3.4: Agrega un parámetro `file'.



Distinto en la versión 3.11: Added the `show_caches' and `adaptive' parameters.



Distinto en la versión 3.13: Added the `show_offsets' parameter.



Distinto en la versión 3.14: Added the `show_positions' parameter.

@end deffn

@geindex disassemble() (en el módulo dis)
@geindex disco() (en el módulo dis)
@anchor{library/dis dis disassemble}@anchor{174}
@deffn {Función} dis.disassemble (code, lasti=-1, *, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)
@anchor{library/dis dis disco}@anchor{4629}
@deffnx {Función} dis.disco (code, lasti=-1, *, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

Desmonta un objeto de código, que indica la última instrucción si se proporcionó `lasti'. La salida se divide en las siguientes columnas:


@enumerate 

@item 
the source code location of the instruction. Complete location information
is shown if `show_positions' is true. Otherwise (the default) only the
line number is displayed.

@item 
la instrucción actual, indicada como @code{-->},

@item 
una instrucción etiquetada, indicada con @code{>>},

@item 
la dirección de la instrucción,

@item 
el nombre del código de operación,

@item 
parámetros de operación, y

@item 
interpretación de los parámetros entre paréntesis.
@end enumerate

La interpretación de parámetros reconoce nombres de variables locales y globales, valores constantes, objetivos de ramificación y operadores de comparación.

El desensamblaje se escribe como texto en el argumento `file' proporcionado si se proporciona y, de lo contrario, @code{sys.stdout}.


Distinto en la versión 3.4: Agrega un parámetro `file'.



Distinto en la versión 3.11: Added the `show_caches' and `adaptive' parameters.



Distinto en la versión 3.13: Added the `show_offsets' parameter.



Distinto en la versión 3.14: Added the `show_positions' parameter.

@end deffn

@geindex get_instructions() (en el módulo dis)
@anchor{library/dis dis get_instructions}@anchor{33d}
@deffn {Función} dis.get_instructions (x, *, first_line=None, show_caches=False, adaptive=False)

Retorna un iterador sobre las instrucciones en la función, método, cadena de código fuente u objeto de código suministrado.

El iterador genera una serie de tuplas con nombre @ref{170,,Instruction} que dan los detalles de cada operación en el código suministrado.

Si `first_line' no es @code{None}, indica el número de línea que se debe informar para la primera línea de origen en el código desmontado. De lo contrario, la información de la línea de origen (si la hay) se toma directamente del objeto de código desmontado.

The `adaptive' parameter works as it does in @ref{39,,dis()}.


Added in version 3.4.



Distinto en la versión 3.11: Added the `show_caches' and `adaptive' parameters.



Distinto en la versión 3.13: The `show_caches' parameter is deprecated and has no effect. The iterator
generates the @ref{170,,Instruction} instances with the `cache_info'
field populated (regardless of the value of `show_caches') and it no longer
generates separate items for the cache entries.

@end deffn

@geindex findlinestarts() (en el módulo dis)
@anchor{library/dis dis findlinestarts}@anchor{462a}
@deffn {Función} dis.findlinestarts (code)

This generator function uses the @ref{1f3,,co_lines()} method
of the @ref{335,,code object} `code' to find the offsets which
are starts of
lines in the source code.  They are generated as @code{(offset, lineno)} pairs.


Distinto en la versión 3.6: Los números de línea pueden estar disminuyendo. Antes, siempre estaban aumentando.



Distinto en la versión 3.10: The 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} @ref{1f3,,co_lines()} method is used instead of the
@ref{1f43,,co_firstlineno} and @ref{1d9,,co_lnotab}
attributes of the @ref{335,,code object}.



Distinto en la versión 3.13: Line numbers can be @code{None} for bytecode that does not map to source lines.

@end deffn

@geindex findlabels() (en el módulo dis)
@anchor{library/dis dis findlabels}@anchor{462b}
@deffn {Función} dis.findlabels (code)

Detecta todos los desplazamientos en la cadena de caracteres de código de byte compilada `code' que son objetivos de salto y retorna una lista de estos desplazamientos.
@end deffn

@geindex stack_effect() (en el módulo dis)
@anchor{library/dis dis stack_effect}@anchor{fb1}
@deffn {Función} dis.stack_effect (opcode, oparg=None, *, jump=None)

Calcula el efecto de pila de `opcode' con el argumento `oparg'.

Si el código tiene un objetivo de salto y `jump' es @code{True}, @ref{fb1,,stack_effect()} retornará el efecto de pila del salto. Si `jump' es @code{False}, retornará el efecto de acumulación de no saltar. Y si `jump' es @code{None} (predeterminado), retornará el efecto de acumulación máxima de ambos casos.


Added in version 3.4.



Distinto en la versión 3.8: Agrega un parámetro `jump'.



Distinto en la versión 3.13: If @code{oparg} is omitted (or @code{None}), the stack effect is now returned
for @code{oparg=0}. Previously this was an error for opcodes that use their
arg. It is also no longer an error to pass an integer @code{oparg} when
the @code{opcode} does not use it; the @code{oparg} in this case is ignored.

@end deffn

@node Instrucciones bytecode de Python,Colecciones opcode,Funciones de análisis,dis — Disassembler for Python bytecode
@anchor{library/dis bytecodes}@anchor{653}@anchor{library/dis python-bytecode-instructions}@anchor{462c}
@subsubsection Instrucciones bytecode de Python


La función @ref{33d,,get_instructions()} y clase @ref{171,,Bytecode} proporcionan detalles de las instrucciones bytecode como instancias @ref{170,,Instruction}:

@geindex Instruction (clase en dis)
@anchor{library/dis dis Instruction}@anchor{170}
@deffn {Clase} dis.Instruction

Detalles para una operación de bytecode

@geindex Instruction.opcode (en el módulo dis)
@anchor{library/dis dis Instruction opcode}@anchor{462d}
@deffn {Dato} opcode

código numérico para la operación, correspondiente a los valores del opcode listados a continuación y los valores de bytecode en @ref{462e,,Colecciones opcode}.
@end deffn

@geindex Instruction.opname (en el módulo dis)
@anchor{library/dis dis Instruction opname}@anchor{462f}
@deffn {Dato} opname

nombre legible por humanos para la operación
@end deffn

@geindex Instruction.baseopcode (en el módulo dis)
@anchor{library/dis dis Instruction baseopcode}@anchor{4630}
@deffn {Dato} baseopcode

numeric code for the base operation if operation is specialized;
otherwise equal to @ref{462d,,opcode}
@end deffn

@geindex Instruction.baseopname (en el módulo dis)
@anchor{library/dis dis Instruction baseopname}@anchor{4631}
@deffn {Dato} baseopname

human readable name for the base operation if operation is specialized;
otherwise equal to @ref{4632,,opname}
@end deffn

@geindex Instruction.arg (en el módulo dis)
@anchor{library/dis dis Instruction arg}@anchor{4633}
@deffn {Dato} arg

argumento numérico para la operación (si existe), de lo contrario @code{None}
@end deffn

@geindex Instruction.oparg (en el módulo dis)
@anchor{library/dis dis Instruction oparg}@anchor{4634}
@deffn {Dato} oparg

alias for @ref{4633,,arg}
@end deffn

@geindex Instruction.argval (en el módulo dis)
@anchor{library/dis dis Instruction argval}@anchor{4635}
@deffn {Dato} argval

valor de argumento resuelto (si lo hay); de lo contrario, @code{None}
@end deffn

@geindex Instruction.argrepr (en el módulo dis)
@anchor{library/dis dis Instruction argrepr}@anchor{4636}
@deffn {Dato} argrepr

descripción legible por humanos del argumento de la operación (si lo hay); de lo contrario, una cadena vacía.
@end deffn

@geindex Instruction.offset (en el módulo dis)
@anchor{library/dis dis Instruction offset}@anchor{4637}
@deffn {Dato} offset

índice de inicio de operación dentro de la secuencia de bytecode
@end deffn

@geindex Instruction.start_offset (en el módulo dis)
@anchor{library/dis dis Instruction start_offset}@anchor{4638}
@deffn {Dato} start_offset

start index of operation within bytecode sequence, including prefixed
@code{EXTENDED_ARG} operations if present; otherwise equal to @ref{4637,,offset}
@end deffn

@geindex Instruction.cache_offset (en el módulo dis)
@anchor{library/dis dis Instruction cache_offset}@anchor{4639}
@deffn {Dato} cache_offset

start index of the cache entries following the operation
@end deffn

@geindex Instruction.end_offset (en el módulo dis)
@anchor{library/dis dis Instruction end_offset}@anchor{463a}
@deffn {Dato} end_offset

end index of the cache entries following the operation
@end deffn

@geindex Instruction.starts_line (en el módulo dis)
@anchor{library/dis dis Instruction starts_line}@anchor{463b}
@deffn {Dato} starts_line

@code{True} if this opcode starts a source line, otherwise @code{False}
@end deffn

@geindex Instruction.line_number (en el módulo dis)
@anchor{library/dis dis Instruction line_number}@anchor{463c}
@deffn {Dato} line_number

source line number associated with this opcode (if any), otherwise @code{None}
@end deffn

@geindex Instruction.is_jump_target (en el módulo dis)
@anchor{library/dis dis Instruction is_jump_target}@anchor{463d}
@deffn {Dato} is_jump_target

@code{True} si otro código salta aquí, de lo contrario, @code{False}
@end deffn

@geindex Instruction.jump_target (en el módulo dis)
@anchor{library/dis dis Instruction jump_target}@anchor{463e}
@deffn {Dato} jump_target

bytecode index of the jump target if this is a jump operation,
otherwise @code{None}
@end deffn

@geindex Instruction.positions (en el módulo dis)
@anchor{library/dis dis Instruction positions}@anchor{463f}
@deffn {Dato} positions

Objeto @ref{15d7,,dis.Positions} que contiene las ubicaciones de inicio y finalización cubiertas por esta instrucción.
@end deffn

@c data::cache_info
@c 
@c Information about the cache entries of this instruction, as
@c triplets of the form ``(name, size, data)``, where the ``name``
@c and ``size`` describe the cache format and data is the contents
@c of the cache. ``cache_info`` is ``None`` if the instruction does not have
@c caches.


Added in version 3.4.



Distinto en la versión 3.11: Se agrega el campo @code{positions}.



Distinto en la versión 3.13: Changed field @code{starts_line}.

Added fields @code{start_offset}, @code{cache_offset}, @code{end_offset},
@code{baseopname}, @code{baseopcode}, @code{jump_target}, @code{oparg},
@code{line_number} and @code{cache_info}.

@end deffn

@geindex Positions (clase en dis)
@anchor{library/dis dis Positions}@anchor{15d7}
@deffn {Clase} dis.Positions

En caso de que la información no esté disponible, algunos campos pueden ser @code{None}.

@geindex Positions.lineno (en el módulo dis)
@anchor{library/dis dis Positions lineno}@anchor{4640}
@deffn {Dato} lineno
@end deffn

@geindex Positions.end_lineno (en el módulo dis)
@anchor{library/dis dis Positions end_lineno}@anchor{4641}
@deffn {Dato} end_lineno
@end deffn

@geindex Positions.col_offset (en el módulo dis)
@anchor{library/dis dis Positions col_offset}@anchor{4642}
@deffn {Dato} col_offset
@end deffn

@geindex Positions.end_col_offset (en el módulo dis)
@anchor{library/dis dis Positions end_col_offset}@anchor{4643}
@deffn {Dato} end_col_offset
@end deffn


Added in version 3.11.

@end deffn

El compilador de Python actualmente genera las siguientes instrucciones de bytecode.

`Instrucciones generales'

In the following, We will refer to the interpreter stack as @code{STACK} and describe
operations on it as if it was a Python list. The top of the stack corresponds to
@code{STACK[-1]} in this language.

@geindex NOP (opcode)
@anchor{library/dis opcode-NOP}@anchor{4644}
@deffn {Opcode} NOP

Código que no hace nada. Utilizado como marcador de posición por el optimizador de bytecode y para generar eventos de seguimiento de línea.
@end deffn

@geindex POP_TOP (opcode)
@anchor{library/dis opcode-POP_TOP}@anchor{4645}
@deffn {Opcode} POP_TOP

Removes the top-of-stack item:

@example
STACK.pop()
@end example
@end deffn

@geindex END_FOR (opcode)
@anchor{library/dis opcode-END_FOR}@anchor{4646}
@deffn {Opcode} END_FOR

Removes the top-of-stack item.
Equivalent to @code{POP_TOP}.
Used to clean up at the end of loops, hence the name.


Added in version 3.12.

@end deffn

@geindex END_SEND (opcode)
@anchor{library/dis opcode-END_SEND}@anchor{4647}
@deffn {Opcode} END_SEND

Implements @code{del STACK[-2]}.
Used to clean up when a generator exits.


Added in version 3.12.

@end deffn

@geindex COPY (opcode)
@anchor{library/dis opcode-COPY}@anchor{7a9}
@deffn {Opcode} COPY (i)

Push the i-th item to the top of the stack without removing it from its original
location:

@example
assert i > 0
STACK.append(STACK[-i])
@end example


Added in version 3.11.

@end deffn

@geindex SWAP (opcode)
@anchor{library/dis opcode-SWAP}@anchor{7aa}
@deffn {Opcode} SWAP (i)

Swap the top of the stack with the i-th element:

@example
STACK[-i], STACK[-1] = STACK[-1], STACK[-i]
@end example


Added in version 3.11.

@end deffn

@geindex CACHE (opcode)
@anchor{library/dis opcode-CACHE}@anchor{799}
@deffn {Opcode} CACHE

En lugar de ser una instrucción real, este código de operación se usa para marcar espacio adicional para que el intérprete almacene en caché datos útiles directamente en el bytecode. Todas las utilidades @code{dis} lo ocultan automáticamente, pero se puede ver con @code{show_caches=True}.

Lógicamente, este espacio forma parte de la instrucción anterior. Muchos códigos de operación esperan ser seguidos por un número exacto de cachés y le indicarán al intérprete que los omita en tiempo de ejecución.

Los cachés poblados pueden parecer instrucciones arbitrarias, por lo que se debe tener mucho cuidado al leer o modificar el bytecode adaptativo sin procesar que contiene datos acelerados.


Added in version 3.11.

@end deffn

`Operaciones unarias'

Las operaciones unarias toman la parte superior de la pila, aplican la operación y retornan el resultado a la pila.

@geindex UNARY_NEGATIVE (opcode)
@anchor{library/dis opcode-UNARY_NEGATIVE}@anchor{4648}
@deffn {Opcode} UNARY_NEGATIVE

Implements @code{STACK[-1] = -STACK[-1]}.
@end deffn

@geindex UNARY_NOT (opcode)
@anchor{library/dis opcode-UNARY_NOT}@anchor{16f6}
@deffn {Opcode} UNARY_NOT

Implements @code{STACK[-1] = not STACK[-1]}.


Distinto en la versión 3.13: This instruction now requires an exact @ref{513,,bool} operand.

@end deffn

@geindex UNARY_INVERT (opcode)
@anchor{library/dis opcode-UNARY_INVERT}@anchor{4649}
@deffn {Opcode} UNARY_INVERT

Implements @code{STACK[-1] = ~STACK[-1]}.
@end deffn

@geindex GET_ITER (opcode)
@anchor{library/dis opcode-GET_ITER}@anchor{464a}
@deffn {Opcode} GET_ITER

Implements @code{STACK[-1] = iter(STACK[-1])}.
@end deffn

@geindex GET_YIELD_FROM_ITER (opcode)
@anchor{library/dis opcode-GET_YIELD_FROM_ITER}@anchor{464b}
@deffn {Opcode} GET_YIELD_FROM_ITER

If @code{STACK[-1]} is a @ref{c66,,generator iterator} or @ref{53a,,coroutine} object
it is left as is.  Otherwise, implements @code{STACK[-1] = iter(STACK[-1])}.


Added in version 3.5.

@end deffn

@geindex TO_BOOL (opcode)
@anchor{library/dis opcode-TO_BOOL}@anchor{16f3}
@deffn {Opcode} TO_BOOL

Implements @code{STACK[-1] = bool(STACK[-1])}.


Added in version 3.13.

@end deffn

`Operaciones binarias e in situ'

Binary operations remove the top two items from the stack (@code{STACK[-1]} and
@code{STACK[-2]}). They perform the operation, then put the result back on the stack.

In-place operations are like binary operations, but the operation is done in-place
when @code{STACK[-2]} supports it, and the resulting @code{STACK[-1]} may be (but does
not have to be) the original @code{STACK[-2]}.

@geindex BINARY_OP (opcode)
@anchor{library/dis opcode-BINARY_OP}@anchor{7a6}
@deffn {Opcode} BINARY_OP (op)

Implements the binary and in-place operators (depending on the value of
`op'):

@example
rhs = STACK.pop()
lhs = STACK.pop()
STACK.append(lhs op rhs)
@end example


Added in version 3.11.

@end deffn

@geindex BINARY_SUBSCR (opcode)
@anchor{library/dis opcode-BINARY_SUBSCR}@anchor{1747}
@deffn {Opcode} BINARY_SUBSCR

Implements:

@example
key = STACK.pop()
container = STACK.pop()
STACK.append(container[key])
@end example
@end deffn

@geindex STORE_SUBSCR (opcode)
@anchor{library/dis opcode-STORE_SUBSCR}@anchor{1822}
@deffn {Opcode} STORE_SUBSCR

Implements:

@example
key = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[key] = value
@end example
@end deffn

@geindex DELETE_SUBSCR (opcode)
@anchor{library/dis opcode-DELETE_SUBSCR}@anchor{464c}
@deffn {Opcode} DELETE_SUBSCR

Implements:

@example
key = STACK.pop()
container = STACK.pop()
del container[key]
@end example
@end deffn

@geindex BINARY_SLICE (opcode)
@anchor{library/dis opcode-BINARY_SLICE}@anchor{586}
@deffn {Opcode} BINARY_SLICE

Implements:

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
STACK.append(container[start:end])
@end example


Added in version 3.12.

@end deffn

@geindex STORE_SLICE (opcode)
@anchor{library/dis opcode-STORE_SLICE}@anchor{587}
@deffn {Opcode} STORE_SLICE

Implements:

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
values = STACK.pop()
container[start:end] = value
@end example


Added in version 3.12.

@end deffn

`Opcodes de corutinas'

@geindex GET_AWAITABLE (opcode)
@anchor{library/dis opcode-GET_AWAITABLE}@anchor{183d}
@deffn {Opcode} GET_AWAITABLE (where)

Implements @code{STACK[-1] = get_awaitable(STACK[-1])}, where @code{get_awaitable(o)}
returns @code{o} if @code{o} is a coroutine object or a generator object with
the @ref{43c7,,CO_ITERABLE_COROUTINE} flag, or resolves
@code{o.__await__}.

@quotation

Si el operando @code{where} es distinto de cero, indica dónde ocurre la instrucción:


@itemize *

@item 
@code{1}: After a call to @code{__aenter__}

@item 
@code{2}: After a call to @code{__aexit__}
@end itemize
@end quotation


Added in version 3.5.



Distinto en la versión 3.11: Anteriormente, esta instrucción no tenía un oparg.

@end deffn

@geindex GET_AITER (opcode)
@anchor{library/dis opcode-GET_AITER}@anchor{464d}
@deffn {Opcode} GET_AITER

Implements @code{STACK[-1] = STACK[-1].__aiter__()}.


Added in version 3.5.



Distinto en la versión 3.7: Ya no se admite el retorno de objetos `awaitable' de @code{__aiter__}.

@end deffn

@geindex GET_ANEXT (opcode)
@anchor{library/dis opcode-GET_ANEXT}@anchor{464e}
@deffn {Opcode} GET_ANEXT

Implement @code{STACK.append(get_awaitable(STACK[-1].__anext__()))} to the stack.
See @code{GET_AWAITABLE} for details about @code{get_awaitable}.


Added in version 3.5.

@end deffn

@geindex END_ASYNC_FOR (opcode)
@anchor{library/dis opcode-END_ASYNC_FOR}@anchor{b35}
@deffn {Opcode} END_ASYNC_FOR

Terminates an @ref{b36,,async for} loop.  Handles an exception raised
when awaiting a next item. The stack contains the async iterable in
@code{STACK[-2]} and the raised exception in @code{STACK[-1]}. Both are popped.
If the exception is not @ref{1a34,,StopAsyncIteration}, it is re-raised.


Added in version 3.8.



Distinto en la versión 3.11: La representación de excepciones en la pila ahora consta de uno, no de tres elementos.

@end deffn

@geindex CLEANUP_THROW (opcode)
@anchor{library/dis opcode-CLEANUP_THROW}@anchor{58a}
@deffn {Opcode} CLEANUP_THROW

Handles an exception raised during a @ref{59d,,throw()} or
@ref{16fa,,close()} call through the current frame.  If @code{STACK[-1]} is an
instance of @ref{c82,,StopIteration}, pop three values from the stack and push
its @code{value} member.  Otherwise, re-raise @code{STACK[-1]}.


Added in version 3.12.

@end deffn

`Opcodes misceláneos'

@geindex SET_ADD (opcode)
@anchor{library/dis opcode-SET_ADD}@anchor{464f}
@deffn {Opcode} SET_ADD (i)

Implements:

@example
item = STACK.pop()
set.add(STACK[-i], item)
@end example

Used to implement set comprehensions.
@end deffn

@geindex LIST_APPEND (opcode)
@anchor{library/dis opcode-LIST_APPEND}@anchor{4650}
@deffn {Opcode} LIST_APPEND (i)

Implements:

@example
item = STACK.pop()
list.append(STACK[-i], item)
@end example

Used to implement list comprehensions.
@end deffn

@geindex MAP_ADD (opcode)
@anchor{library/dis opcode-MAP_ADD}@anchor{b37}
@deffn {Opcode} MAP_ADD (i)

Implements:

@example
value = STACK.pop()
key = STACK.pop()
dict.__setitem__(STACK[-i], key, value)
@end example

Used to implement dict comprehensions.


Added in version 3.1.



Distinto en la versión 3.8: Map value is @code{STACK[-1]} and map key is @code{STACK[-2]}. Before, those
were reversed.

@end deffn

Para todas las instrucciones @ref{464f,,SET_ADD}, @ref{4650,,LIST_APPEND} y @ref{b37,,MAP_ADD}, mientras el valor agregado o el par clave/valor aparece, el objeto contenedor permanece en la pila para que quede disponible para futuras iteraciones del bucle.

@geindex RETURN_VALUE (opcode)
@anchor{library/dis opcode-RETURN_VALUE}@anchor{17af}
@deffn {Opcode} RETURN_VALUE

Returns with @code{STACK[-1]} to the caller of the function.
@end deffn

@geindex YIELD_VALUE (opcode)
@anchor{library/dis opcode-YIELD_VALUE}@anchor{407}
@deffn {Opcode} YIELD_VALUE

Yields @code{STACK.pop()} from a @ref{10dd,,generator}.


Distinto en la versión 3.11: oparg set to be the stack depth.



Distinto en la versión 3.12: oparg set to be the exception block depth, for efficient closing of generators.



Distinto en la versión 3.13: oparg is @code{1} if this instruction is part of a yield-from or await, and @code{0}
otherwise.

@end deffn

@geindex SETUP_ANNOTATIONS (opcode)
@anchor{library/dis opcode-SETUP_ANNOTATIONS}@anchor{dda}
@deffn {Opcode} SETUP_ANNOTATIONS

Comprueba si @code{__anotaciones__} está definido en @code{locals()}, si no está configurado como un @code{dict} vacío. Este código de operación solo se emite si el cuerpo de una clase o módulo contiene @ref{ddb,,anotaciones de variables} estáticamente.


Added in version 3.6.

@end deffn

@geindex POP_EXCEPT (opcode)
@anchor{library/dis opcode-POP_EXCEPT}@anchor{4651}
@deffn {Opcode} POP_EXCEPT

Extrae un valor de la pila, que se utiliza para restaurar el estado de excepción.


Distinto en la versión 3.11: La representación de excepciones en la pila ahora consta de uno, no de tres elementos.

@end deffn

@geindex RERAISE (opcode)
@anchor{library/dis opcode-RERAISE}@anchor{4652}
@deffn {Opcode} RERAISE

Re-raises the exception currently on top of the stack. If oparg is non-zero,
pops an additional value from the stack which is used to set
@ref{920,,f_lasti} of the current frame.


Added in version 3.9.



Distinto en la versión 3.11: La representación de excepciones en la pila ahora consta de uno, no de tres elementos.

@end deffn

@geindex PUSH_EXC_INFO (opcode)
@anchor{library/dis opcode-PUSH_EXC_INFO}@anchor{7a3}
@deffn {Opcode} PUSH_EXC_INFO

Extrae un valor de la pila. Agrega la excepción actual a la parte superior de la pila. Agrega el valor que apareció originalmente de vuelta a la pila. Se utiliza en los controladores de excepciones.


Added in version 3.11.

@end deffn

@geindex CHECK_EXC_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EXC_MATCH}@anchor{7ab}
@deffn {Opcode} CHECK_EXC_MATCH

Performs exception matching for @code{except}. Tests whether the @code{STACK[-2]}
is an exception matching @code{STACK[-1]}. Pops @code{STACK[-1]} and pushes the boolean
result of the test.


Added in version 3.11.

@end deffn

@geindex CHECK_EG_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EG_MATCH}@anchor{7a2}
@deffn {Opcode} CHECK_EG_MATCH

Performs exception matching for @code{except*}. Applies @code{split(STACK[-1])} on
the exception group representing @code{STACK[-2]}.

En caso de coincidencia, extrae dos elementos de la pila y agrega el subgrupo que no coincide (@code{None} en caso de coincidencia total) seguido del subgrupo coincidente. Cuando no hay ninguna coincidencia, muestra un elemento (el tipo de coincidencia) y presiona @code{None}.


Added in version 3.11.

@end deffn

@geindex WITH_EXCEPT_START (opcode)
@anchor{library/dis opcode-WITH_EXCEPT_START}@anchor{4653}
@deffn {Opcode} WITH_EXCEPT_START

Llama a la función en la posición 4 de la pila con argumentos (tipo, val, tb) que representan la excepción en la parte superior de la pila. Se utiliza para implementar la llamada @code{context_manager.__exit__(*exc_info())} cuando se ha producido una excepción en una sentencia @ref{673,,with}.


Added in version 3.9.



Distinto en la versión 3.11: La función @code{__exit__} está en la posición 4 de la pila en lugar de la 7. La representación de excepciones en la pila ahora consta de uno, no de tres, elementos.

@end deffn

@geindex LOAD_COMMON_CONSTANT (opcode)
@anchor{library/dis opcode-LOAD_COMMON_CONSTANT}@anchor{161b}
@deffn {Opcode} LOAD_COMMON_CONSTANT

Pushes a common constant onto the stack. The interpreter contains a hardcoded
list of constants supported by this instruction.  Used by the @ref{9fa,,assert}
statement to load @ref{74a,,AssertionError}.


Added in version 3.14.

@end deffn

@geindex LOAD_BUILD_CLASS (opcode)
@anchor{library/dis opcode-LOAD_BUILD_CLASS}@anchor{4654}
@deffn {Opcode} LOAD_BUILD_CLASS

Pushes @code{builtins.__build_class__()} onto the stack.  It is later called
to construct a class.
@end deffn

@geindex GET_LEN (opcode)
@anchor{library/dis opcode-GET_LEN}@anchor{4655}
@deffn {Opcode} GET_LEN

Perform @code{STACK.append(len(STACK[-1]))}. Used in @ref{8a4,,match} statements where
comparison with structure of pattern is needed.


Added in version 3.10.

@end deffn

@geindex MATCH_MAPPING (opcode)
@anchor{library/dis opcode-MATCH_MAPPING}@anchor{4656}
@deffn {Opcode} MATCH_MAPPING

If @code{STACK[-1]} is an instance of @ref{961,,collections.abc.Mapping} (or, more
technically: if it has the @ref{18ac,,Py_TPFLAGS_MAPPING} flag set in its
@ref{18c6,,tp_flags}), push @code{True} onto the stack.  Otherwise,
push @code{False}.


Added in version 3.10.

@end deffn

@geindex MATCH_SEQUENCE (opcode)
@anchor{library/dis opcode-MATCH_SEQUENCE}@anchor{4657}
@deffn {Opcode} MATCH_SEQUENCE

If @code{STACK[-1]} is an instance of @ref{1231,,collections.abc.Sequence} and is `not' an instance
of @ref{237,,str}/@ref{325,,bytes}/@ref{5e0,,bytearray} (or, more technically: if it has
the @ref{18ad,,Py_TPFLAGS_SEQUENCE} flag set in its @ref{18c6,,tp_flags}),
push @code{True} onto the stack.  Otherwise, push @code{False}.


Added in version 3.10.

@end deffn

@geindex MATCH_KEYS (opcode)
@anchor{library/dis opcode-MATCH_KEYS}@anchor{7b2}
@deffn {Opcode} MATCH_KEYS

@code{STACK[-1]} is a tuple of mapping keys, and @code{STACK[-2]} is the match subject.
If @code{STACK[-2]} contains all of the keys in @code{STACK[-1]}, push a @ref{464,,tuple}
containing the corresponding values. Otherwise, push @code{None}.


Added in version 3.10.



Distinto en la versión 3.11: Anteriormente, esta instrucción también generaba un valor booleano que indicaba éxito (@code{True}) o falla (@code{False}).

@end deffn

@geindex STORE_NAME (opcode)
@anchor{library/dis opcode-STORE_NAME}@anchor{4658}
@deffn {Opcode} STORE_NAME (namei)

Implements @code{name = STACK.pop()}. `namei' is the index of `name' in the attribute
@ref{1f42,,co_names} of the @ref{335,,code object}.
The compiler tries to use @ref{16f7,,STORE_FAST} or @ref{4659,,STORE_GLOBAL} if possible.
@end deffn

@geindex DELETE_NAME (opcode)
@anchor{library/dis opcode-DELETE_NAME}@anchor{465a}
@deffn {Opcode} DELETE_NAME (namei)

Implements @code{del name}, where `namei' is the index into @ref{1f42,,co_names}
attribute of the @ref{335,,code object}.
@end deffn

@geindex UNPACK_SEQUENCE (opcode)
@anchor{library/dis opcode-UNPACK_SEQUENCE}@anchor{183f}
@deffn {Opcode} UNPACK_SEQUENCE (count)

Unpacks @code{STACK[-1]} into `count' individual values, which are put onto the stack
right-to-left. Require there to be exactly `count' values.:

@example
assert(len(STACK[-1]) == count)
STACK.extend(STACK.pop()[:-count-1:-1])
@end example
@end deffn

@geindex UNPACK_EX (opcode)
@anchor{library/dis opcode-UNPACK_EX}@anchor{465b}
@deffn {Opcode} UNPACK_EX (counts)

Implements assignment with a starred target: Unpacks an iterable in @code{STACK[-1]}
into individual values, where the total number of values can be smaller than the
number of items in the iterable: one of the new values will be a list of all
leftover items.

The number of values before and after the list value is limited to 255.

The number of values before the list value is encoded in the argument of the
opcode. The number of values after the list if any is encoded using an
@code{EXTENDED_ARG}. As a consequence, the argument can be seen as a two bytes values
where the low byte of `counts' is the number of values before the list value, the
high byte of `counts' the number of values after it.

The extracted values are put onto the stack right-to-left, i.e. @code{a, *b, c = d}
will be stored after execution as @code{STACK.extend((a, b, c))}.
@end deffn

@geindex STORE_ATTR (opcode)
@anchor{library/dis opcode-STORE_ATTR}@anchor{183e}
@deffn {Opcode} STORE_ATTR (namei)

Implements:

@example
obj = STACK.pop()
value = STACK.pop()
obj.name = value
@end example

where `namei' is the index of name in @ref{1f42,,co_names} of the
@ref{335,,code object}.
@end deffn

@geindex DELETE_ATTR (opcode)
@anchor{library/dis opcode-DELETE_ATTR}@anchor{465c}
@deffn {Opcode} DELETE_ATTR (namei)

Implements:

@example
obj = STACK.pop()
del obj.name
@end example

where `namei' is the index of name into @ref{1f42,,co_names} of the
@ref{335,,code object}.
@end deffn

@geindex STORE_GLOBAL (opcode)
@anchor{library/dis opcode-STORE_GLOBAL}@anchor{4659}
@deffn {Opcode} STORE_GLOBAL (namei)

Funciona como @ref{4658,,STORE_NAME}, pero almacena el nombre como global.
@end deffn

@geindex DELETE_GLOBAL (opcode)
@anchor{library/dis opcode-DELETE_GLOBAL}@anchor{465d}
@deffn {Opcode} DELETE_GLOBAL (namei)

Funciona como @ref{465a,,DELETE_NAME}, pero elimina un nombre global.
@end deffn

@geindex LOAD_CONST (opcode)
@anchor{library/dis opcode-LOAD_CONST}@anchor{465e}
@deffn {Opcode} LOAD_CONST (consti)

Apila @code{co_consts[consti]} en la pila.
@end deffn

@geindex LOAD_SMALL_INT (opcode)
@anchor{library/dis opcode-LOAD_SMALL_INT}@anchor{15b0}
@deffn {Opcode} LOAD_SMALL_INT (i)

Pushes the integer @code{i} onto the stack.
@code{i} must be in @code{range(256)}


Added in version 3.14.

@end deffn

@geindex LOAD_CONST_IMMORTAL (opcode)
@anchor{library/dis opcode-LOAD_CONST_IMMORTAL}@anchor{15b1}
@deffn {Opcode} LOAD_CONST_IMMORTAL (consti)

Pushes @code{co_consts[consti]} onto the stack.
Can be used when the constant value is known to be immortal.


Added in version 3.14.

@end deffn

@geindex LOAD_NAME (opcode)
@anchor{library/dis opcode-LOAD_NAME}@anchor{465f}
@deffn {Opcode} LOAD_NAME (namei)

Pushes the value associated with @code{co_names[namei]} onto the stack.
The name is looked up within the locals, then the globals, then the builtins.
@end deffn

@geindex LOAD_LOCALS (opcode)
@anchor{library/dis opcode-LOAD_LOCALS}@anchor{58f}
@deffn {Opcode} LOAD_LOCALS

Pushes a reference to the locals dictionary onto the stack.  This is used
to prepare namespace dictionaries for @ref{58d,,LOAD_FROM_DICT_OR_DEREF}
and @ref{58e,,LOAD_FROM_DICT_OR_GLOBALS}.


Added in version 3.12.

@end deffn

@geindex LOAD_FROM_DICT_OR_GLOBALS (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_GLOBALS}@anchor{58e}
@deffn {Opcode} LOAD_FROM_DICT_OR_GLOBALS (i)

Pops a mapping off the stack and looks up the value for @code{co_names[namei]}.
If the name is not found there, looks it up in the globals and then the builtins,
similar to @ref{16f0,,LOAD_GLOBAL}.
This is used for loading global variables in
@ref{2f3,,annotation scopes} within class bodies.


Added in version 3.12.

@end deffn

@geindex BUILD_TUPLE (opcode)
@anchor{library/dis opcode-BUILD_TUPLE}@anchor{4660}
@deffn {Opcode} BUILD_TUPLE (count)

Creates a tuple consuming `count' items from the stack, and pushes the
resulting tuple onto the stack:

@example
if count == 0:
    value = ()
else:
    value = tuple(STACK[-count:])
    STACK = STACK[:-count]

STACK.append(value)
@end example
@end deffn

@geindex BUILD_LIST (opcode)
@anchor{library/dis opcode-BUILD_LIST}@anchor{4661}
@deffn {Opcode} BUILD_LIST (count)

Funciona como @ref{4660,,BUILD_TUPLE}, pero crea una lista.
@end deffn

@geindex BUILD_SET (opcode)
@anchor{library/dis opcode-BUILD_SET}@anchor{4662}
@deffn {Opcode} BUILD_SET (count)

Funciona como @ref{4660,,BUILD_TUPLE}, pero crea un conjunto.
@end deffn

@geindex BUILD_MAP (opcode)
@anchor{library/dis opcode-BUILD_MAP}@anchor{1614}
@deffn {Opcode} BUILD_MAP (count)

Pushes a new dictionary object onto the stack.  Pops @code{2 * count} items
so that the dictionary holds `count' entries:
@code{@{..., STACK[-4]: STACK[-3], STACK[-2]: STACK[-1]@}}.


Distinto en la versión 3.5: El diccionario se crea a partir de elementos de la pila en lugar de crear un diccionario vacío dimensionado previamente para contener `count' elementos.

@end deffn

@geindex BUILD_STRING (opcode)
@anchor{library/dis opcode-BUILD_STRING}@anchor{dd7}
@deffn {Opcode} BUILD_STRING (count)

Concatena `count' cadenas de caracteres de la pila y empuja la cadena de caracteres resultante en la pila.


Added in version 3.6.

@end deffn

@geindex LIST_EXTEND (opcode)
@anchor{library/dis opcode-LIST_EXTEND}@anchor{4663}
@deffn {Opcode} LIST_EXTEND (i)

Implements:

@example
seq = STACK.pop()
list.extend(STACK[-i], seq)
@end example

Used to build lists.


Added in version 3.9.

@end deffn

@geindex SET_UPDATE (opcode)
@anchor{library/dis opcode-SET_UPDATE}@anchor{4664}
@deffn {Opcode} SET_UPDATE (i)

Implements:

@example
seq = STACK.pop()
set.update(STACK[-i], seq)
@end example

Used to build sets.


Added in version 3.9.

@end deffn

@geindex DICT_UPDATE (opcode)
@anchor{library/dis opcode-DICT_UPDATE}@anchor{4665}
@deffn {Opcode} DICT_UPDATE (i)

Implements:

@example
map = STACK.pop()
dict.update(STACK[-i], map)
@end example

Used to build dicts.


Added in version 3.9.

@end deffn

@geindex DICT_MERGE (opcode)
@anchor{library/dis opcode-DICT_MERGE}@anchor{4666}
@deffn {Opcode} DICT_MERGE (i)

Como @ref{4665,,DICT_UPDATE} pero lanza una excepción para claves duplicadas.


Added in version 3.9.

@end deffn

@geindex LOAD_ATTR (opcode)
@anchor{library/dis opcode-LOAD_ATTR}@anchor{585}
@deffn {Opcode} LOAD_ATTR (namei)

If the low bit of @code{namei} is not set, this replaces @code{STACK[-1]} with
@code{getattr(STACK[-1], co_names[namei>>1])}.

If the low bit of @code{namei} is set, this will attempt to load a method named
@code{co_names[namei>>1]} from the @code{STACK[-1]} object. @code{STACK[-1]} is popped.
This bytecode distinguishes two cases: if @code{STACK[-1]} has a method with the
correct name, the bytecode pushes the unbound method and @code{STACK[-1]}.
@code{STACK[-1]} will be used as the first argument (@code{self}) by @ref{7a7,,CALL}
or @ref{1610,,CALL_KW} when calling the unbound method.
Otherwise, @code{NULL} and the object returned by
the attribute lookup are pushed.


Distinto en la versión 3.12: If the low bit of @code{namei} is set, then a @code{NULL} or @code{self} is
pushed to the stack before the attribute or unbound method respectively.

@end deffn

@geindex LOAD_SUPER_ATTR (opcode)
@anchor{library/dis opcode-LOAD_SUPER_ATTR}@anchor{583}
@deffn {Opcode} LOAD_SUPER_ATTR (namei)

This opcode implements @ref{155,,super()}, both in its zero-argument and
two-argument forms (e.g. @code{super().method()}, @code{super().attr} and
@code{super(cls, self).method()}, @code{super(cls, self).attr}).

It pops three values from the stack (from top of stack down):


@itemize *

@item 
@code{self}: the first argument to the current method

@item 
@code{cls}: the class within which the current method was defined

@item 
the global @code{super}
@end itemize

With respect to its argument, it works similarly to @ref{585,,LOAD_ATTR},
except that @code{namei} is shifted left by 2 bits instead of 1.

The low bit of @code{namei} signals to attempt a method load, as with
@ref{585,,LOAD_ATTR}, which results in pushing @code{NULL} and the loaded method.
When it is unset a single value is pushed to the stack.

The second-low bit of @code{namei}, if set, means that this was a two-argument
call to @ref{155,,super()} (unset means zero-argument).


Added in version 3.12.

@end deffn

@geindex COMPARE_OP (opcode)
@anchor{library/dis opcode-COMPARE_OP}@anchor{9fb}
@deffn {Opcode} COMPARE_OP (opname)

Performs a Boolean operation.  The operation name can be found in
@code{cmp_op[opname >> 5]}. If the fifth-lowest bit of @code{opname} is set
(@code{opname & 16}), the result should be coerced to @code{bool}.


Distinto en la versión 3.13: The fifth-lowest bit of the oparg now indicates a forced conversion to
@ref{513,,bool}.

@end deffn

@geindex IS_OP (opcode)
@anchor{library/dis opcode-IS_OP}@anchor{15d3}
@deffn {Opcode} IS_OP (invert)

Realiza una comparación @code{is} o @code{is not} si @code{invert} es 1.


Added in version 3.9.

@end deffn

@geindex CONTAINS_OP (opcode)
@anchor{library/dis opcode-CONTAINS_OP}@anchor{15d2}
@deffn {Opcode} CONTAINS_OP (invert)

Realiza una comparación @code{in} o @code{not in} si @code{invert} es 1.


Added in version 3.9.

@end deffn

@geindex IMPORT_NAME (opcode)
@anchor{library/dis opcode-IMPORT_NAME}@anchor{4667}
@deffn {Opcode} IMPORT_NAME (namei)

Imports the module @code{co_names[namei]}.  @code{STACK[-1]} and @code{STACK[-2]} are
popped and provide the `fromlist' and `level' arguments of @ref{96b,,__import__()}.
The module object is pushed onto the stack.  The current namespace is not affected: for a proper import statement, a subsequent @ref{16f7,,STORE_FAST} instruction
modifies the namespace.
@end deffn

@geindex IMPORT_FROM (opcode)
@anchor{library/dis opcode-IMPORT_FROM}@anchor{4668}
@deffn {Opcode} IMPORT_FROM (namei)

Loads the attribute @code{co_names[namei]} from the module found in @code{STACK[-1]}.
The resulting object is pushed onto the stack, to be subsequently stored by a
@ref{16f7,,STORE_FAST} instruction.
@end deffn

@geindex JUMP_FORWARD (opcode)
@anchor{library/dis opcode-JUMP_FORWARD}@anchor{160f}
@deffn {Opcode} JUMP_FORWARD (delta)

Incrementa el contador de bytecode en `delta'.
@end deffn

@geindex JUMP_BACKWARD (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD}@anchor{7ac}
@deffn {Opcode} JUMP_BACKWARD (delta)

Decrementa el contador de bytecode en `delta'. Comprueba si hay interrupciones.


Added in version 3.11.

@end deffn

@geindex JUMP_BACKWARD_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD_NO_INTERRUPT}@anchor{79f}
@deffn {Opcode} JUMP_BACKWARD_NO_INTERRUPT (delta)

Decrementa el contador de bytecode en `delta'. No busca interrupciones.


Added in version 3.11.

@end deffn

@geindex POP_JUMP_IF_TRUE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_TRUE}@anchor{16f4}
@deffn {Opcode} POP_JUMP_IF_TRUE (delta)

If @code{STACK[-1]} is true, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.


Distinto en la versión 3.11: The oparg is now a relative delta rather than an absolute target.
This opcode is a pseudo-instruction, replaced in final bytecode by
the directed versions (forward/backward).



Distinto en la versión 3.12: This is no longer a pseudo-instruction.



Distinto en la versión 3.13: This instruction now requires an exact @ref{513,,bool} operand.

@end deffn

@geindex POP_JUMP_IF_FALSE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_FALSE}@anchor{16f5}
@deffn {Opcode} POP_JUMP_IF_FALSE (delta)

If @code{STACK[-1]} is false, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.


Distinto en la versión 3.11: The oparg is now a relative delta rather than an absolute target.
This opcode is a pseudo-instruction, replaced in final bytecode by
the directed versions (forward/backward).



Distinto en la versión 3.12: This is no longer a pseudo-instruction.



Distinto en la versión 3.13: This instruction now requires an exact @ref{513,,bool} operand.

@end deffn

@geindex POP_JUMP_IF_NOT_NONE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_NOT_NONE}@anchor{17fe}
@deffn {Opcode} POP_JUMP_IF_NOT_NONE (delta)

If @code{STACK[-1]} is not @code{None}, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.

This opcode is a pseudo-instruction, replaced in final bytecode by
the directed versions (forward/backward).


Added in version 3.11.



Distinto en la versión 3.12: This is no longer a pseudo-instruction.

@end deffn

@geindex POP_JUMP_IF_NONE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_NONE}@anchor{17fd}
@deffn {Opcode} POP_JUMP_IF_NONE (delta)

If @code{STACK[-1]} is @code{None}, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.

This opcode is a pseudo-instruction, replaced in final bytecode by
the directed versions (forward/backward).


Added in version 3.11.



Distinto en la versión 3.12: This is no longer a pseudo-instruction.

@end deffn

@geindex FOR_ITER (opcode)
@anchor{library/dis opcode-FOR_ITER}@anchor{1759}
@deffn {Opcode} FOR_ITER (delta)

@code{STACK[-1]} is an @ref{313,,iterator}.  Call its @ref{1335,,__next__()} method.
If this yields a new value, push it on the stack (leaving the iterator below
it).  If the iterator indicates it is exhausted then the byte code counter is
incremented by `delta'.


Distinto en la versión 3.12: Up until 3.11 the iterator was popped when it was exhausted.

@end deffn

@geindex LOAD_GLOBAL (opcode)
@anchor{library/dis opcode-LOAD_GLOBAL}@anchor{16f0}
@deffn {Opcode} LOAD_GLOBAL (namei)

Carga el @code{co_names[namei>>1]} global llamado en la pila.


Distinto en la versión 3.11: Si se establece el bit bajo de @code{namei}, se agrega un @code{NULL} a la pila antes de la variable global.

@end deffn

@geindex LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST}@anchor{4669}
@deffn {Opcode} LOAD_FAST (var_num)

Apila una referencia al local @code{co_varnames[var_num]} sobre la pila.


Distinto en la versión 3.12: This opcode is now only used in situations where the local variable is
guaranteed to be initialized. It cannot raise @ref{1576,,UnboundLocalError}.

@end deffn

@geindex LOAD_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST_LOAD_FAST}@anchor{466a}
@deffn {Opcode} LOAD_FAST_LOAD_FAST (var_nums)

Pushes references to @code{co_varnames[var_nums >> 4]} and
@code{co_varnames[var_nums & 15]} onto the stack.


Added in version 3.13.

@end deffn

@geindex LOAD_FAST_CHECK (opcode)
@anchor{library/dis opcode-LOAD_FAST_CHECK}@anchor{58c}
@deffn {Opcode} LOAD_FAST_CHECK (var_num)

Pushes a reference to the local @code{co_varnames[var_num]} onto the stack,
raising an @ref{1576,,UnboundLocalError} if the local variable has not been
initialized.


Added in version 3.12.

@end deffn

@geindex LOAD_FAST_AND_CLEAR (opcode)
@anchor{library/dis opcode-LOAD_FAST_AND_CLEAR}@anchor{58b}
@deffn {Opcode} LOAD_FAST_AND_CLEAR (var_num)

Pushes a reference to the local @code{co_varnames[var_num]} onto the stack (or
pushes @code{NULL} onto the stack if the local variable has not been
initialized) and sets @code{co_varnames[var_num]} to @code{NULL}.


Added in version 3.12.

@end deffn

@geindex STORE_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST}@anchor{16f7}
@deffn {Opcode} STORE_FAST (var_num)

Stores @code{STACK.pop()} into the local @code{co_varnames[var_num]}.
@end deffn

@geindex STORE_FAST_STORE_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST_STORE_FAST}@anchor{466b}
@deffn {Opcode} STORE_FAST_STORE_FAST (var_nums)

Stores @code{STACK[-1]} into @code{co_varnames[var_nums >> 4]}
and @code{STACK[-2]} into @code{co_varnames[var_nums & 15]}.


Added in version 3.13.

@end deffn

@geindex STORE_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST_LOAD_FAST}@anchor{466c}
@deffn {Opcode} STORE_FAST_LOAD_FAST (var_nums)

Stores @code{STACK.pop()} into the local @code{co_varnames[var_nums >> 4]}
and pushes a reference to the local @code{co_varnames[var_nums & 15]}
onto the stack.


Added in version 3.13.

@end deffn

@geindex DELETE_FAST (opcode)
@anchor{library/dis opcode-DELETE_FAST}@anchor{466d}
@deffn {Opcode} DELETE_FAST (var_num)

Elimina la @code{co_varnames[var_num]} local.
@end deffn

@geindex MAKE_CELL (opcode)
@anchor{library/dis opcode-MAKE_CELL}@anchor{7a0}
@deffn {Opcode} MAKE_CELL (i)

Creates a new cell in slot @code{i}.  If that slot is nonempty then
that value is stored into the new cell.


Added in version 3.11.

@end deffn

@geindex LOAD_DEREF (opcode)
@anchor{library/dis opcode-LOAD_DEREF}@anchor{466e}
@deffn {Opcode} LOAD_DEREF (i)

Carga la celda contenida en el slot @code{i} del almacenamiento «fast locals». Agrega una referencia al objeto que contiene la celda en la pila.


Distinto en la versión 3.11: @code{i} is no longer offset by the length of @ref{1f3d,,co_varnames}.

@end deffn

@geindex LOAD_FROM_DICT_OR_DEREF (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_DEREF}@anchor{58d}
@deffn {Opcode} LOAD_FROM_DICT_OR_DEREF (i)

Pops a mapping off the stack and looks up the name associated with
slot @code{i} of the «fast locals» storage in this mapping.
If the name is not found there, loads it from the cell contained in
slot @code{i}, similar to @ref{466e,,LOAD_DEREF}. This is used for loading
@ref{1f40,,closure variables} in class bodies (which previously used
@code{LOAD_CLASSDEREF}) and in
@ref{2f3,,annotation scopes} within class bodies.


Added in version 3.12.

@end deffn

@geindex STORE_DEREF (opcode)
@anchor{library/dis opcode-STORE_DEREF}@anchor{466f}
@deffn {Opcode} STORE_DEREF (i)

Stores @code{STACK.pop()} into the cell contained in slot @code{i} of the «fast locals»
storage.


Distinto en la versión 3.11: @code{i} is no longer offset by the length of @ref{1f3d,,co_varnames}.

@end deffn

@geindex DELETE_DEREF (opcode)
@anchor{library/dis opcode-DELETE_DEREF}@anchor{4670}
@deffn {Opcode} DELETE_DEREF (i)

Vacía la celda contenida en la ranura @code{i} del almacenamiento de «locales rápidos». Utilizado por la instrucción @ref{17ae,,del}.


Added in version 3.2.



Distinto en la versión 3.11: @code{i} is no longer offset by the length of @ref{1f3d,,co_varnames}.

@end deffn

@geindex COPY_FREE_VARS (opcode)
@anchor{library/dis opcode-COPY_FREE_VARS}@anchor{79e}
@deffn {Opcode} COPY_FREE_VARS (n)

Copies the @code{n} @ref{1f40,,free (closure) variables} from the closure
into the frame. Removes the need for special code on the caller’s side when calling
closures.


Added in version 3.11.

@end deffn

@geindex RAISE_VARARGS (opcode)
@anchor{library/dis opcode-RAISE_VARARGS}@anchor{4671}
@deffn {Opcode} RAISE_VARARGS (argc)

Provoca una excepción utilizando una de las 3 formas de la declaración @code{raise}, dependiendo del valor de `argc':


@itemize *

@item 
0: @code{raise} (vuelve a lanzar la excepción anterior)

@item 
1: @code{raise STACK[-1]} (raise exception instance or type at @code{STACK[-1]})

@item 
2: @code{raise STACK[-2] from STACK[-1]} (raise exception instance or type at
@code{STACK[-2]} with @code{__cause__} set to @code{STACK[-1]})
@end itemize
@end deffn

@geindex CALL (opcode)
@anchor{library/dis opcode-CALL}@anchor{7a7}
@deffn {Opcode} CALL (argc)

Calls a callable object with the number of arguments specified by @code{argc}.
On the stack are (in ascending order):


@itemize *

@item 
El llamable

@item 
@code{self} or @code{NULL}

@item 
Los argumentos posicionales restantes
@end itemize

@code{argc} is the total of the positional arguments, excluding @code{self}.

@code{CALL} extrae todos los argumentos y el objeto invocable de la pila, llama al objeto invocable con esos argumentos y agrega el valor retornado por el objeto invocable.


Added in version 3.11.



Distinto en la versión 3.13: The callable now always appears at the same position on the stack.



Distinto en la versión 3.13: Calls with keyword arguments are now handled by @ref{1610,,CALL_KW}.

@end deffn

@geindex CALL_KW (opcode)
@anchor{library/dis opcode-CALL_KW}@anchor{1610}
@deffn {Opcode} CALL_KW (argc)

Calls a callable object with the number of arguments specified by @code{argc},
including one or more named arguments. On the stack are (in ascending order):


@itemize *

@item 
El llamable

@item 
@code{self} or @code{NULL}

@item 
Los argumentos posicionales restantes

@item 
Los argumentos nombrados

@item 
A @ref{464,,tuple} of keyword argument names
@end itemize

@code{argc} is the total of the positional and named arguments, excluding @code{self}.
The length of the tuple of keyword argument names is the number of named arguments.

@code{CALL_KW} pops all arguments, the keyword names, and the callable object
off the stack, calls the callable object with those arguments, and pushes the
return value returned by the callable object.


Added in version 3.13.

@end deffn

@geindex CALL_FUNCTION_EX (opcode)
@anchor{library/dis opcode-CALL_FUNCTION_EX}@anchor{dd9}
@deffn {Opcode} CALL_FUNCTION_EX (flags)

Llama a un objeto invocable con un conjunto variable de argumentos posicionales y de palabras clave. Si se establece el bit más bajo de `flags', la parte superior de la pila contiene un objeto de mapeo que contiene argumentos de palabras clave adicionales. Antes de que se llame al invocable, el objeto de mapeo y el objeto iterable se «desempaquetan» y su contenido se pasa como palabra clave y argumentos posicionales, respectivamente. @code{CALL_FUNCTION_EX} saca todos los argumentos y el objeto invocable de la pila, llama al objeto invocable con esos argumentos y empuja el valor de retorno retornado por el objeto invocable.


Added in version 3.6.

@end deffn

@geindex PUSH_NULL (opcode)
@anchor{library/dis opcode-PUSH_NULL}@anchor{7a8}
@deffn {Opcode} PUSH_NULL

Agrega un @code{NULL} a la pila. Se usa en la secuencia de llamadas para hacer coincidir el @code{NULL} enviado por @ref{ca7,,LOAD_METHOD} para llamadas que no son de método.


Added in version 3.11.

@end deffn

@geindex MAKE_FUNCTION (opcode)
@anchor{library/dis opcode-MAKE_FUNCTION}@anchor{dd8}
@deffn {Opcode} MAKE_FUNCTION

Pushes a new function object on the stack built from the code object at @code{STACK[-1]}.


Distinto en la versión 3.10: El valor indicador @code{0x04} es una tupla de cadena de caracteres en vez de un diccionario



Distinto en la versión 3.11: Qualified name at @code{STACK[-1]} was removed.



Distinto en la versión 3.13: Extra function attributes on the stack, signaled by oparg flags, were
removed. They now use @ref{4672,,SET_FUNCTION_ATTRIBUTE}.

@end deffn

@geindex SET_FUNCTION_ATTRIBUTE (opcode)
@anchor{library/dis opcode-SET_FUNCTION_ATTRIBUTE}@anchor{4672}
@deffn {Opcode} SET_FUNCTION_ATTRIBUTE (flag)

Sets an attribute on a function object. Expects the function at @code{STACK[-1]}
and the attribute value to set at @code{STACK[-2]}; consumes both and leaves the
function at @code{STACK[-1]}. The flag determines which attribute to set:


@itemize *

@item 
@code{0x01}, una tupla de valores predeterminados para solo parámetros posicionales y posicionales o de palabras clave en orden posicional

@item 
@code{0x02} un diccionario de valores predeterminados de solo palabras clave

@item 
@code{0x04} una tupla de cadenas de caracteres que contiene anotaciones de parámetros

@item 
@code{0x08} una tupla que contiene celdas para variables libres, haciendo un cierre (`closure')
@end itemize


Added in version 3.13.

@end deffn

@geindex BUILD_SLICE (opcode)
@anchor{library/dis opcode-BUILD_SLICE}@anchor{4673}
@deffn {Opcode} BUILD_SLICE (argc)

@geindex built-in function;slice

Pushes a slice object on the stack.  `argc' must be 2 or 3.  If it is 2, implements:

@example
end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end))
@end example

if it is 3, implements:

@example
step = STACK.pop()
end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end, step))
@end example

See the @ref{514,,slice()} built-in function for more information.
@end deffn

@geindex EXTENDED_ARG (opcode)
@anchor{library/dis opcode-EXTENDED_ARG}@anchor{17ad}
@deffn {Opcode} EXTENDED_ARG (ext)

Prefija cualquier código de operación que tenga un argumento demasiado grande para caber en el byte predeterminado. `ext' contiene un byte adicional que actúa como bits más altos en el argumento. Para cada opcode, como máximo se permiten tres prefijos @code{EXTENDED_ARG}, formando un argumento de dos bytes a cuatro bytes.
@end deffn

@geindex CONVERT_VALUE (opcode)
@anchor{library/dis opcode-CONVERT_VALUE}@anchor{4674}
@deffn {Opcode} CONVERT_VALUE (oparg)

Convert value to a string, depending on @code{oparg}:

@example
value = STACK.pop()
result = func(value)
STACK.append(result)
@end example


@itemize *

@item 
@code{oparg == 1}: call @ref{237,,str()} on `value'

@item 
@code{oparg == 2}: call @ref{894,,repr()} on `value'

@item 
@code{oparg == 3}: call @ref{1426,,ascii()} on `value'
@end itemize

Used for implementing formatted literal strings (f-strings).


Added in version 3.13.

@end deffn

@geindex FORMAT_SIMPLE (opcode)
@anchor{library/dis opcode-FORMAT_SIMPLE}@anchor{4675}
@deffn {Opcode} FORMAT_SIMPLE

Formats the value on top of stack:

@example
value = STACK.pop()
result = value.__format__("")
STACK.append(result)
@end example

Used for implementing formatted literal strings (f-strings).


Added in version 3.13.

@end deffn

@geindex FORMAT_WITH_SPEC (opcode)
@anchor{library/dis opcode-FORMAT_WITH_SPEC}@anchor{4676}
@deffn {Opcode} FORMAT_WITH_SPEC

Formats the given value with the given format spec:

@example
spec = STACK.pop()
value = STACK.pop()
result = value.__format__(spec)
STACK.append(result)
@end example

Used for implementing formatted literal strings (f-strings).


Added in version 3.13.

@end deffn

@geindex MATCH_CLASS (opcode)
@anchor{library/dis opcode-MATCH_CLASS}@anchor{7b1}
@deffn {Opcode} MATCH_CLASS (count)

@code{STACK[-1]} is a tuple of keyword attribute names, @code{STACK[-2]} is the class
being matched against, and @code{STACK[-3]} is the match subject.  `count' is the
number of positional sub-patterns.

Pop @code{STACK[-1]}, @code{STACK[-2]}, and @code{STACK[-3]}. If @code{STACK[-3]} is an
instance of @code{STACK[-2]} and has the positional and keyword attributes
required by `count' and @code{STACK[-1]}, push a tuple of extracted attributes.
Otherwise, push @code{None}.


Added in version 3.10.



Distinto en la versión 3.11: Anteriormente, esta instrucción también generaba un valor booleano que indicaba éxito (@code{True}) o falla (@code{False}).

@end deffn

@geindex RESUME (opcode)
@anchor{library/dis opcode-RESUME}@anchor{408}
@deffn {Opcode} RESUME (context)

Un no-op. Realiza comprobaciones internas de seguimiento, depuración y optimización.

The @code{context} operand consists of two parts. The lowest two bits
indicate where the @code{RESUME} occurs:


@itemize *

@item 
@code{0} The start of a function, which is neither a generator, coroutine
nor an async generator

@item 
@code{1} Después de una expresión @code{yield}

@item 
@code{2} Después de una expresión @code{yield from}

@item 
@code{3} Después de una expresión @code{await}
@end itemize

The next bit is @code{1} if the RESUME is at except-depth @code{1}, and @code{0}
otherwise.


Added in version 3.11.



Distinto en la versión 3.13: The oparg value changed to include information about except-depth

@end deffn

@geindex RETURN_GENERATOR (opcode)
@anchor{library/dis opcode-RETURN_GENERATOR}@anchor{79c}
@deffn {Opcode} RETURN_GENERATOR

Create a generator, coroutine, or async generator from the current frame.
Used as first opcode of in code object for the above mentioned callables.
Clear the current frame and return the newly created generator.


Added in version 3.11.

@end deffn

@geindex SEND (opcode)
@anchor{library/dis opcode-SEND}@anchor{79d}
@deffn {Opcode} SEND (delta)

Equivalent to @code{STACK[-1] = STACK[-2].send(STACK[-1])}. Used in @code{yield from}
and @code{await} statements.

If the call raises @ref{c82,,StopIteration}, pop the top value from the stack,
push the exception’s @code{value} attribute, and increment the bytecode counter
by `delta'.


Added in version 3.11.

@end deffn

@geindex HAVE_ARGUMENT (opcode)
@anchor{library/dis opcode-HAVE_ARGUMENT}@anchor{532}
@deffn {Opcode} HAVE_ARGUMENT

This is not really an opcode.  It identifies the dividing line between
opcodes in the range [0,255] which don’t use their argument and those
that do (@code{< HAVE_ARGUMENT} and @code{>= HAVE_ARGUMENT}, respectively).

If your application uses pseudo instructions or specialized instructions,
use the @ref{3ee,,hasarg} collection instead.


Distinto en la versión 3.6: Ahora cada instrucción tiene un argumento, pero los códigos de operación @code{<HAVE_ARGUMENT} la ignoran. Antes, solo los códigos de operación @code{> = HAVE_ARGUMENT} tenían un argumento.



Distinto en la versión 3.12: Pseudo instructions were added to the @ref{39,,dis} module, and for them
it is not true that comparison with @code{HAVE_ARGUMENT} indicates whether
they use their arg.



Obsoleto desde la versión 3.13: Use @ref{3ee,,hasarg} instead.

@end deffn

@geindex CALL_INTRINSIC_1 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_1}@anchor{588}
@deffn {Opcode} CALL_INTRINSIC_1

Calls an intrinsic function with one argument. Passes @code{STACK[-1]} as the
argument and sets @code{STACK[-1]} to the result. Used to implement
functionality that is not performance critical.

The operand determines which intrinsic function is called:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operand

@tab

Description

@item

@code{INTRINSIC_1_INVALID}

@tab

Not valid

@item

@code{INTRINSIC_PRINT}

@tab

Prints the argument to standard
out. Used in the REPL.

@item

@code{INTRINSIC_IMPORT_STAR}

@tab

Performs @code{import *} for the
named module.

@item

@code{INTRINSIC_STOPITERATION_ERROR}

@tab

Extracts the return value from a
@code{StopIteration} exception.

@item

@code{INTRINSIC_ASYNC_GEN_WRAP}

@tab

Wraps an async generator value

@item

@code{INTRINSIC_UNARY_POSITIVE}

@tab

Performs the unary @code{+}
operation

@item

@code{INTRINSIC_LIST_TO_TUPLE}

@tab

Converts a list to a tuple

@item

@code{INTRINSIC_TYPEVAR}

@tab

Creates a @ref{2c9,,typing.TypeVar}

@item

@code{INTRINSIC_PARAMSPEC}

@tab

Creates a
@ref{2ca,,typing.ParamSpec}

@item

@code{INTRINSIC_TYPEVARTUPLE}

@tab

Creates a
@ref{2cb,,typing.TypeVarTuple}

@item

@code{INTRINSIC_SUBSCRIPT_GENERIC}

@tab

Returns @ref{15f6,,typing.Generic}
subscripted with the argument

@item

@code{INTRINSIC_TYPEALIAS}

@tab

Creates a
@ref{501,,typing.TypeAliasType};
used in the @ref{4e6,,type}
statement. The argument is a tuple
of the type alias’s name,
type parameters, and value.

@end multitable



Added in version 3.12.

@end deffn

@geindex CALL_INTRINSIC_2 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_2}@anchor{589}
@deffn {Opcode} CALL_INTRINSIC_2

Calls an intrinsic function with two arguments. Used to implement functionality
that is not performance critical:

@example
arg2 = STACK.pop()
arg1 = STACK.pop()
result = intrinsic2(arg1, arg2)
STACK.append(result)
@end example

The operand determines which intrinsic function is called:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operand

@tab

Description

@item

@code{INTRINSIC_2_INVALID}

@tab

Not valid

@item

@code{INTRINSIC_PREP_RERAISE_STAR}

@tab

Calculates the
@ref{31d,,ExceptionGroup} to raise
from a @code{try-except*}.

@item

@code{INTRINSIC_TYPEVAR_WITH_BOUND}

@tab

Creates a @ref{2c9,,typing.TypeVar}
with a bound.

@item

@code{INTRINSIC_TYPEVAR_WITH_CONSTRAINTS}

@tab

Creates a
@ref{2c9,,typing.TypeVar} with
constraints.

@item

@code{INTRINSIC_SET_FUNCTION_TYPE_PARAMS}

@tab

Sets the @code{__type_params__}
attribute of a function.

@end multitable



Added in version 3.12.

@end deffn

@geindex LOAD_SPECIAL (opcode)
@anchor{library/dis opcode-LOAD_SPECIAL}@anchor{1616}
@deffn {Opcode} LOAD_SPECIAL

Performs special method lookup on @code{STACK[-1]}.
If @code{type(STACK[-1]).__xxx__} is a method, leave
@code{type(STACK[-1]).__xxx__; STACK[-1]} on the stack.
If @code{type(STACK[-1]).__xxx__} is not a method, leave
@code{STACK[-1].__xxx__; NULL} on the stack.


Added in version 3.14.

@end deffn

`Pseudo-instructions'

These opcodes do not appear in Python bytecode. They are used by the compiler
but are replaced by real opcodes or removed before bytecode is generated.

@geindex SETUP_FINALLY (opcode)
@anchor{library/dis opcode-SETUP_FINALLY}@anchor{4677}
@deffn {Opcode} SETUP_FINALLY (target)

Set up an exception handler for the following code block. If an exception
occurs, the value stack level is restored to its current state and control
is transferred to the exception handler at @code{target}.
@end deffn

@geindex SETUP_CLEANUP (opcode)
@anchor{library/dis opcode-SETUP_CLEANUP}@anchor{4678}
@deffn {Opcode} SETUP_CLEANUP (target)

Like @code{SETUP_FINALLY}, but in case of an exception also pushes the last
instruction (@code{lasti}) to the stack so that @code{RERAISE} can restore it.
If an exception occurs, the value stack level and the last instruction on
the frame are restored to their current state, and control is transferred
to the exception handler at @code{target}.
@end deffn

@geindex SETUP_WITH (opcode)
@anchor{library/dis opcode-SETUP_WITH}@anchor{4679}
@deffn {Opcode} SETUP_WITH (target)

Like @code{SETUP_CLEANUP}, but in case of an exception one more item is popped
from the stack before control is transferred to the exception handler at
@code{target}.

This variant is used in @ref{673,,with} and @ref{676,,async with}
constructs, which push the return value of the context manager’s
@ref{669,,__enter__()} or @ref{1fd1,,__aenter__()} to the stack.
@end deffn

@geindex POP_BLOCK (opcode)
@anchor{library/dis opcode-POP_BLOCK}@anchor{467a}
@deffn {Opcode} POP_BLOCK

Marks the end of the code block associated with the last @code{SETUP_FINALLY},
@code{SETUP_CLEANUP} or @code{SETUP_WITH}.
@end deffn

@geindex JUMP (opcode)
@anchor{library/dis opcode-JUMP}@anchor{467b}
@deffn {Opcode} JUMP
@end deffn

@geindex JUMP_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP_NO_INTERRUPT}@anchor{1820}
@deffn {Opcode} JUMP_NO_INTERRUPT

Undirected relative jump instructions which are replaced by their
directed (forward/backward) counterparts by the assembler.
@end deffn

@geindex JUMP_IF_TRUE (opcode)
@anchor{library/dis opcode-JUMP_IF_TRUE}@anchor{467c}
@deffn {Opcode} JUMP_IF_TRUE
@end deffn

@geindex JUMP_IF_FALSE (opcode)
@anchor{library/dis opcode-JUMP_IF_FALSE}@anchor{467d}
@deffn {Opcode} JUMP_IF_FALSE

Conditional jumps which do not impact the stack. Replaced by the sequence
@code{COPY 1}, @code{TO_BOOL}, @code{POP_JUMP_IF_TRUE/FALSE}.
@end deffn

@geindex LOAD_CLOSURE (opcode)
@anchor{library/dis opcode-LOAD_CLOSURE}@anchor{16f2}
@deffn {Opcode} LOAD_CLOSURE (i)

Pushes a reference to the cell contained in slot @code{i} of the «fast locals»
storage.

Note that @code{LOAD_CLOSURE} is replaced with @code{LOAD_FAST} in the assembler.


Distinto en la versión 3.13: This opcode is now a pseudo-instruction.

@end deffn

@geindex LOAD_METHOD (opcode)
@anchor{library/dis opcode-LOAD_METHOD}@anchor{ca7}
@deffn {Opcode} LOAD_METHOD

Optimized unbound method lookup. Emitted as a @code{LOAD_ATTR} opcode
with a flag set in the arg.
@end deffn

@node Colecciones opcode,,Instrucciones bytecode de Python,dis — Disassembler for Python bytecode
@anchor{library/dis id1}@anchor{467e}@anchor{library/dis opcode-collections}@anchor{462e}
@subsubsection Colecciones opcode


Estas colecciones se proporcionan para la introspección automática de instrucciones de bytecode:


Distinto en la versión 3.12: The collections now contain pseudo instructions and instrumented
instructions as well. These are opcodes with values @code{>= MIN_PSEUDO_OPCODE}
and @code{>= MIN_INSTRUMENTED_OPCODE}.


@geindex opname (en el módulo dis)
@anchor{library/dis dis opname}@anchor{4632}
@deffn {Dato} dis.opname

Secuencia de nombres de operaciones, indexable utilizando el bytecode.
@end deffn

@geindex opmap (en el módulo dis)
@anchor{library/dis dis opmap}@anchor{467f}
@deffn {Dato} dis.opmap

Nombres de operaciones de mapeo de diccionario a bytecodes.
@end deffn

@geindex cmp_op (en el módulo dis)
@anchor{library/dis dis cmp_op}@anchor{4680}
@deffn {Dato} dis.cmp_op

Secuencia de todos los nombres de operaciones de comparación.
@end deffn

@geindex hasarg (en el módulo dis)
@anchor{library/dis dis hasarg}@anchor{3ee}
@deffn {Dato} dis.hasarg

Sequence of bytecodes that use their argument.


Added in version 3.12.

@end deffn

@geindex hasconst (en el módulo dis)
@anchor{library/dis dis hasconst}@anchor{4681}
@deffn {Dato} dis.hasconst

Secuencia de bytecodes que acceden a una constante.
@end deffn

@geindex hasfree (en el módulo dis)
@anchor{library/dis dis hasfree}@anchor{4682}
@deffn {Dato} dis.hasfree

Sequence of bytecodes that access a @ref{1f40,,free (closure) variable}.
“free” in this context refers to names in the current scope that are
referenced by inner scopes or names in outer scopes that are referenced
from this scope.  It does `not' include references to global or builtin scopes.
@end deffn

@geindex hasname (en el módulo dis)
@anchor{library/dis dis hasname}@anchor{4683}
@deffn {Dato} dis.hasname

Secuencia de bytecodes que acceden a un atributo por nombre.
@end deffn

@geindex hasjump (en el módulo dis)
@anchor{library/dis dis hasjump}@anchor{4684}
@deffn {Dato} dis.hasjump

Sequence of bytecodes that have a jump target. All jumps
are relative.


Added in version 3.13.

@end deffn

@geindex haslocal (en el módulo dis)
@anchor{library/dis dis haslocal}@anchor{4685}
@deffn {Dato} dis.haslocal

Secuencia de códigos de bytes que acceden a una variable local.
@end deffn

@geindex hascompare (en el módulo dis)
@anchor{library/dis dis hascompare}@anchor{4686}
@deffn {Dato} dis.hascompare

Secuencia de bytecodes de operaciones booleanas.
@end deffn

@geindex hasexc (en el módulo dis)
@anchor{library/dis dis hasexc}@anchor{533}
@deffn {Dato} dis.hasexc

Sequence of bytecodes that set an exception handler.


Added in version 3.12.

@end deffn

@geindex hasjrel (en el módulo dis)
@anchor{library/dis dis hasjrel}@anchor{4687}
@deffn {Dato} dis.hasjrel

Secuencia de bytecodes que tienen un objetivo de salto relativo.


Obsoleto desde la versión 3.13: All jumps are now relative. Use @ref{4684,,hasjump}.

@end deffn

@geindex hasjabs (en el módulo dis)
@anchor{library/dis dis hasjabs}@anchor{4688}
@deffn {Dato} dis.hasjabs

Secuencia de bytecodes que tienen un objetivo de salto absoluto.


Obsoleto desde la versión 3.13: All jumps are now relative. This list is empty.

@end deffn

@node pickletools — Tools for pickle developers,,dis — Disassembler for Python bytecode,Servicios del lenguaje Python
@anchor{library/pickletools doc}@anchor{4689}@anchor{library/pickletools module-pickletools}@anchor{a7}@anchor{library/pickletools pickletools-tools-for-pickle-developers}@anchor{468a}
@subsection @code{pickletools} — Tools for pickle developers


@geindex module; pickletools

`Código fuente:' Lib/pickletools.py@footnote{https://github.com/python/cpython/tree/main/Lib/pickletools.py}


__________________________________________________________________


Este módulo contiene varias constantes relacionadas con los detalles íntimos del módulo @ref{a6,,pickle}, algunos comentarios largos sobre la implementación y algunas funciones útiles para analizar pickled data.  El contenido de este módulo es útil para los desarrolladores principales de Python que están trabajando en el @ref{a6,,pickle}; los usuarios ordinarios del módulo @ref{a6,,pickle} probablemente no encontrarán relevante el módulo @ref{a7,,pickletools}.

@menu
* Uso de la línea de comandos: Uso de la línea de comandos<5>. 
* Interfaz programática: Interfaz programática<2>. 

@end menu

@node Uso de la línea de comandos<5>,Interfaz programática<2>,,pickletools — Tools for pickle developers
@anchor{library/pickletools command-line-usage}@anchor{468b}@anchor{library/pickletools pickletools-cli}@anchor{468c}
@subsubsection Uso de la línea de comandos



Added in version 3.2.


Cuando se invoca desde la línea de comandos, @code{python -m pickletools} desensamblará el contenido de uno o más archivos pickle.  Tenga en cuenta que si desea ver el objeto Python almacenado en el pickle en lugar de los detalles del formato de pickle, es posible que desee utilizar @code{-m pickle} en su lugar. Sin embargo, cuando el archivo de pickle que desea examinar proviene de una fuente que no es de confianza, @code{-m pickletools} es una opción más segura porque no ejecuta el código de bytes de pickle.

Por ejemplo, con una tupla @code{(1, 2)} pickled en el archivo @code{x.pickle}:

@example
$ python -m pickle x.pickle
(1, 2)

$ python -m pickletools x.pickle
    0: \x80 PROTO      3
    2: K    BININT1    1
    4: K    BININT1    2
    6: \x86 TUPLE2
    7: q    BINPUT     0
    9: .    STOP
highest protocol among opcodes = 2
@end example

@menu
* Opciones de línea de comandos: Opciones de línea de comandos<3>. 

@end menu

@node Opciones de línea de comandos<3>,,,Uso de la línea de comandos<5>
@anchor{library/pickletools command-line-options}@anchor{468d}
@subsubsection Opciones de línea de comandos


@geindex opción de línea de comando pickletools; -a
@geindex opción de línea de comando pickletools; --annotate
@anchor{library/pickletools cmdoption-pickletools-a}@anchor{468e}@anchor{library/pickletools cmdoption-pickletools-annotate}@anchor{468f}
@deffn {Option} @w{-}a, @w{-}@w{-}annotate

Anote cada línea con una breve descripción del código de operación.
@end deffn

@geindex opción de línea de comando pickletools; -o
@geindex opción de línea de comando pickletools; --output
@anchor{library/pickletools cmdoption-pickletools-o}@anchor{4690}@anchor{library/pickletools cmdoption-pickletools-output}@anchor{4691}
@deffn {Option} @w{-}o, @w{-}@w{-}output=<file>

Nombre de un archivo donde se debe escribir la salida.
@end deffn

@geindex opción de línea de comando pickletools; -l
@geindex opción de línea de comando pickletools; --indentlevel
@anchor{library/pickletools cmdoption-pickletools-l}@anchor{4692}@anchor{library/pickletools cmdoption-pickletools-indentlevel}@anchor{4693}
@deffn {Option} @w{-}l, @w{-}@w{-}indentlevel=<num>

Número de espacios en blanco por los que se aplica una sangría a un nuevo nivel de MARK.
@end deffn

@geindex opción de línea de comando pickletools; -m
@geindex opción de línea de comando pickletools; --memo
@anchor{library/pickletools cmdoption-pickletools-m}@anchor{4694}@anchor{library/pickletools cmdoption-pickletools-memo}@anchor{4695}
@deffn {Option} @w{-}m, @w{-}@w{-}memo

Cuando se desensamblan varios objetos, conserve la nota entre los ensamblajes.
@end deffn

@geindex opción de línea de comando pickletools; -p
@geindex opción de línea de comando pickletools; --preamble
@anchor{library/pickletools cmdoption-pickletools-p}@anchor{4696}@anchor{library/pickletools cmdoption-pickletools-preamble}@anchor{4697}
@deffn {Option} @w{-}p, @w{-}@w{-}preamble=<preamble>

Cuando se especifica más de un archivo pickle, imprima un preámbulo determinado antes de cada desensamblado.
@end deffn

@node Interfaz programática<2>,,Uso de la línea de comandos<5>,pickletools — Tools for pickle developers
@anchor{library/pickletools programmatic-interface}@anchor{4698}
@subsubsection Interfaz programática


@geindex dis() (en el módulo pickletools)
@anchor{library/pickletools pickletools dis}@anchor{d4a}
@deffn {Función} pickletools.dis (pickle, out=None, memo=None, indentlevel=4, annotate=0)

Produce un desensamblado simbólico del pickle en el objeto similar a un archivo `salida', de forma predeterminada en @code{sys.stdout}.  `pickle' puede ser una cadena o un objeto similar a un archivo.  `memo' puede ser un diccionario Python que se utilizará como nota del pickle; se puede utilizar para realizar ensamblajes de desuso en varios pickles creados por el mismo selector. Los niveles sucesivos, indicados por los códigos de operación @code{MARK} en la secuencia, son indentados por espacios `indentlevel'.  Si se da un valor distinto de cero a `anotar', cada código de operación de la salida se anota con una breve descripción.  El valor de `anotar' se utiliza como sugerencia para la columna donde debe comenzar la anotación.


Distinto en la versión 3.2: Added the `annotate' parameter.

@end deffn

@geindex genops() (en el módulo pickletools)
@anchor{library/pickletools pickletools genops}@anchor{4699}
@deffn {Función} pickletools.genops (pickle)

Proporciona un @ref{313,,iterator} sobre todos los códigos de operación en un pickle, retornando una secuencia de triples @code{(opcode, arg, pos)}.  `opcode' es una instancia de una clase @code{OpcodeInfo}; `arg' es el valor descodificado, como un objeto Python, del argumento del código de operación; `pos' es la posición en la que se encuentra este código de operación. `pickle' puede ser una cadena o un objeto similar a un archivo.
@end deffn

@geindex optimize() (en el módulo pickletools)
@anchor{library/pickletools pickletools optimize}@anchor{2890}
@deffn {Función} pickletools.optimize (picklestring)

Retorna una nueva cadena pickle equivalente después de eliminar los códigos de operación @code{PUT} no utilizados. El pickle optimizado es más corto, toma menos tiempo de transmisión, requiere menos espacio de almacenamiento y se restaura de manera más eficiente.
@end deffn

@node Servicios Específicos para MS Windows,Servicios específicos de Unix,Servicios del lenguaje Python,La biblioteca estándar de Python
@anchor{library/windows doc}@anchor{469a}@anchor{library/windows ms-windows-specific-services}@anchor{469b}@anchor{library/windows mswin-specific-services}@anchor{1e3a}
@section Servicios Específicos para MS Windows


Este capítulo describe los módulos que sólo están disponibles en plataformas MS Windows.

@menu
* msvcrt — Useful routines from the MS VC++ runtime:: 
* winreg — Windows registry access:: 
* winsound — Sound-playing interface for Windows:: 

@end menu

@node msvcrt — Useful routines from the MS VC++ runtime,winreg — Windows registry access,,Servicios Específicos para MS Windows
@anchor{library/msvcrt doc}@anchor{469c}@anchor{library/msvcrt module-msvcrt}@anchor{93}@anchor{library/msvcrt msvcrt-useful-routines-from-the-ms-vc-runtime}@anchor{469d}
@subsection @code{msvcrt} — Useful routines from the MS VC++ runtime


@geindex module; msvcrt


__________________________________________________________________


These functions provide access to some useful capabilities on Windows platforms.
Some higher-level modules use these functions to build the Windows
implementations of their services. For example, the @ref{62,,getpass} module uses
this in the implementation of the @ref{62,,getpass()} function.

Más información sobre estas funciones se pueden encontrar en la documentación de la API de la plataforma.

El módulo implementa las variantes tanto de caracteres normales como amplios de la API E/S de la consola (se codifican en más de 8 bits, pudiendo llegar hasta 32). La API normal se ocupa solamente de caracteres ASCII y es de uso limitado a aplicaciones internacionales. La API para caracteres amplios se recomienda usar siempre que sea posible.


Distinto en la versión 3.3: Las operaciones en este módulo lanzan ahora @ref{4d5,,OSError} donde antes se lanzaba @ref{10ce,,IOError}.


@menu
* Operaciones con archivos:: 
* Consola E/S:: 
* Otras funciones: Otras funciones<4>. 

@end menu

@node Operaciones con archivos,Consola E/S,,msvcrt — Useful routines from the MS VC++ runtime
@anchor{library/msvcrt file-operations}@anchor{469e}@anchor{library/msvcrt msvcrt-files}@anchor{469f}
@subsubsection Operaciones con archivos


@geindex locking() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt locking}@anchor{410e}
@deffn {Función} msvcrt.locking (fd, mode, nbytes)

Lock part of a file based on file descriptor `fd' from the C runtime. Raises
@ref{4d5,,OSError} on failure. The locked region of the file extends from the
current file position for `nbytes' bytes, and may continue beyond the end of the
file. `mode' must be one of the @code{LK_*} constants listed below. Multiple
regions in a file may be locked at the same time, but may not overlap. Adjacent
regions are not merged; they must be unlocked individually.

Lanza un @ref{18c3,,evento de auditoría} @code{msvcrt.locking} con los argumentos @code{fd}, @code{mode}, @code{nbytes}.
@end deffn

@geindex LK_LOCK (en el módulo msvcrt)
@geindex LK_RLCK (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_LOCK}@anchor{46a0}
@deffn {Dato} msvcrt.LK_LOCK
@anchor{library/msvcrt msvcrt LK_RLCK}@anchor{46a1}
@deffnx {Dato} msvcrt.LK_RLCK

Locks the specified bytes. If the bytes cannot be locked, the program
immediately tries again after 1 second. If, after 10 attempts, the bytes cannot
be locked, @ref{4d5,,OSError} is raised.
@end deffn

@geindex LK_NBLCK (en el módulo msvcrt)
@geindex LK_NBRLCK (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_NBLCK}@anchor{46a2}
@deffn {Dato} msvcrt.LK_NBLCK
@anchor{library/msvcrt msvcrt LK_NBRLCK}@anchor{46a3}
@deffnx {Dato} msvcrt.LK_NBRLCK

Bloquea los bytes especificados. Si no se pueden bloquear, lanza una excepción @ref{4d5,,OSError}.
@end deffn

@geindex LK_UNLCK (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_UNLCK}@anchor{46a4}
@deffn {Dato} msvcrt.LK_UNLCK

Desbloquea los bytes especificados que han sido previamente bloqueados.
@end deffn

@geindex setmode() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt setmode}@anchor{46a5}
@deffn {Función} msvcrt.setmode (fd, flags)

Establece el modo traducción del final de línea del descriptor de un archivo `fd'. Si se establece como modo texto, `flags' debería ser @ref{2b59,,os.O_TEXT}; para establecerlo como modo binario, debería ser @ref{2b4a,,os.O_BINARY}.
@end deffn

@geindex open_osfhandle() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt open_osfhandle}@anchor{410f}
@deffn {Función} msvcrt.open_osfhandle (handle, flags)

Create a C runtime file descriptor from the file handle `handle'. The `flags'
parameter should be a bitwise OR of @ref{2b4c,,os.O_APPEND},
@ref{2b48,,os.O_RDONLY}, @ref{2b59,,os.O_TEXT} and @ref{2b54,,os.O_NOINHERIT}.
The returned file descriptor may be used as a parameter
to @ref{1f33,,os.fdopen()} to create a file object.

The file descriptor is inheritable by default. Pass @ref{2b54,,os.O_NOINHERIT}
flag to make it non inheritable.

Lanza un @ref{18c3,,evento de auditoría} @code{msvcrt.open_osfhandle} con los argumentos @code{handle}, @code{flags}.
@end deffn

@geindex get_osfhandle() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt get_osfhandle}@anchor{410d}
@deffn {Función} msvcrt.get_osfhandle (fd)

Return the file handle for the file descriptor `fd'. Raises @ref{4d5,,OSError} if
`fd' is not recognized.

Lanza un @ref{18c3,,evento de auditoría} @code{msvcrt.get_osfhandle} con el  argumento @code{fd}.
@end deffn

@node Consola E/S,Otras funciones<4>,Operaciones con archivos,msvcrt — Useful routines from the MS VC++ runtime
@anchor{library/msvcrt console-i-o}@anchor{46a6}@anchor{library/msvcrt msvcrt-console}@anchor{46a7}
@subsubsection Consola E/S


@geindex kbhit() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt kbhit}@anchor{46a8}
@deffn {Función} msvcrt.kbhit ()

Returns a nonzero value if a keypress is waiting to be read. Otherwise,
return 0.
@end deffn

@geindex getch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt getch}@anchor{46a9}
@deffn {Función} msvcrt.getch ()

Read a keypress and return the resulting character as a byte string.
Nothing is echoed to the console. This call will block if a keypress
is not already available, but will not wait for @code{Enter} to be
pressed. If the pressed key was a special function key, this will
return @code{'\000'} or @code{'\xe0'}; the next call will return the keycode.
The @code{Control-C} keypress cannot be read with this function.
@end deffn

@geindex getwch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt getwch}@anchor{1435}
@deffn {Función} msvcrt.getwch ()

Variante de carácter amplio de @ref{46a9,,getch()}, retornando un valor Unicode.
@end deffn

@geindex getche() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt getche}@anchor{46aa}
@deffn {Función} msvcrt.getche ()

Similar to @ref{46a9,,getch()}, but the keypress will be echoed if it represents a
printable character.
@end deffn

@geindex getwche() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt getwche}@anchor{1436}
@deffn {Función} msvcrt.getwche ()

Variante de carácter amplio de @ref{46aa,,getche()}, retornando un valor Unicode.
@end deffn

@geindex putch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt putch}@anchor{46ab}
@deffn {Función} msvcrt.putch (char)

Imprime la cadena de caracteres de bytes `char' a la consola sin almacenamiento en buffer.
@end deffn

@geindex putwch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt putwch}@anchor{1437}
@deffn {Función} msvcrt.putwch (unicode_char)

Variante de carácter amplio de @ref{46ab,,putch()}, admitiendo un valor Unicode.
@end deffn

@geindex ungetch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt ungetch}@anchor{46ac}
@deffn {Función} msvcrt.ungetch (char)

Provoca que la cadena de caracteres de bytes `char' sea «colocada de nuevo» en el buffer de la consola, será el siguiente carácter que lea la función @ref{46a9,,getch()} o @ref{46aa,,getche()}.
@end deffn

@geindex ungetwch() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt ungetwch}@anchor{46ad}
@deffn {Función} msvcrt.ungetwch (unicode_char)

Variante de carácter amplio de @ref{46ac,,ungetch()}, admitiendo un valor Unicode.
@end deffn

@node Otras funciones<4>,,Consola E/S,msvcrt — Useful routines from the MS VC++ runtime
@anchor{library/msvcrt msvcrt-other}@anchor{46ae}@anchor{library/msvcrt other-functions}@anchor{46af}
@subsubsection Otras funciones


@geindex heapmin() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt heapmin}@anchor{46b0}
@deffn {Función} msvcrt.heapmin ()

Force the @code{malloc()} heap to clean itself up and return unused blocks to
the operating system. On failure, this raises @ref{4d5,,OSError}.
@end deffn

@geindex set_error_mode() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt set_error_mode}@anchor{46b1}
@deffn {Función} msvcrt.set_error_mode (mode)

Changes the location where the C runtime writes an error message for an error
that might end the program. `mode' must be one of the @code{OUT_*}
constants listed below  or @ref{46b2,,REPORT_ERRMODE}. Returns the old setting
or -1 if an error occurs. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex OUT_TO_DEFAULT (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_DEFAULT}@anchor{46b3}
@deffn {Dato} msvcrt.OUT_TO_DEFAULT

Error sink is determined by the app’s type. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex OUT_TO_STDERR (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_STDERR}@anchor{46b4}
@deffn {Dato} msvcrt.OUT_TO_STDERR

Error sink is a standard error. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex OUT_TO_MSGBOX (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_MSGBOX}@anchor{46b5}
@deffn {Dato} msvcrt.OUT_TO_MSGBOX

Error sink is a message box. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex REPORT_ERRMODE (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt REPORT_ERRMODE}@anchor{46b2}
@deffn {Dato} msvcrt.REPORT_ERRMODE

Report the current error mode value. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex CrtSetReportMode() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CrtSetReportMode}@anchor{46b6}
@deffn {Función} msvcrt.CrtSetReportMode (type, mode)

Specifies the destination or destinations for a specific report type
generated by @code{_CrtDbgReport()} in the MS VC++ runtime. `type' must be
one of the @code{CRT_*} constants listed below. `mode' must be one of the
@code{CRTDBG_*} constants listed below. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex CrtSetReportFile() (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CrtSetReportFile}@anchor{46b7}
@deffn {Función} msvcrt.CrtSetReportFile (type, file)

After you use @ref{46b6,,CrtSetReportMode()} to specify @ref{46b8,,CRTDBG_MODE_FILE},
you can specify the file handle to receive the message text. `type' must be
one of the @code{CRT_*} constants listed below. `file' should be the file
handle your want specified. Only available in
@ref{357,,debug build of Python}.
@end deffn

@geindex CRT_WARN (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_WARN}@anchor{46b9}
@deffn {Dato} msvcrt.CRT_WARN

Warnings, messages, and information that doesn’t need immediate attention.
@end deffn

@geindex CRT_ERROR (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ERROR}@anchor{46ba}
@deffn {Dato} msvcrt.CRT_ERROR

Errors, unrecoverable problems, and issues that require immediate attention.
@end deffn

@geindex CRT_ASSERT (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ASSERT}@anchor{46bb}
@deffn {Dato} msvcrt.CRT_ASSERT

Assertion failures.
@end deffn

@geindex CRTDBG_MODE_DEBUG (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_DEBUG}@anchor{46bc}
@deffn {Dato} msvcrt.CRTDBG_MODE_DEBUG

Writes the message to the debugger’s output window.
@end deffn

@geindex CRTDBG_MODE_FILE (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_FILE}@anchor{46b8}
@deffn {Dato} msvcrt.CRTDBG_MODE_FILE

Writes the message to a user-supplied file handle. @ref{46b7,,CrtSetReportFile()}
should be called to define the specific file or stream to use as
the destination.
@end deffn

@geindex CRTDBG_MODE_WNDW (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_WNDW}@anchor{46bd}
@deffn {Dato} msvcrt.CRTDBG_MODE_WNDW

Creates a message box to display the message along with the @code{Abort},
@code{Retry}, and @code{Ignore} buttons.
@end deffn

@geindex CRTDBG_REPORT_MODE (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_REPORT_MODE}@anchor{46be}
@deffn {Dato} msvcrt.CRTDBG_REPORT_MODE

Returns current `mode' for the specified `type'.
@end deffn

@geindex CRT_ASSEMBLY_VERSION (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ASSEMBLY_VERSION}@anchor{13bf}
@deffn {Dato} msvcrt.CRT_ASSEMBLY_VERSION

The CRT Assembly version, from the @code{crtassem.h} header file.
@end deffn

@geindex VC_ASSEMBLY_PUBLICKEYTOKEN (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt VC_ASSEMBLY_PUBLICKEYTOKEN}@anchor{13c0}
@deffn {Dato} msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN

The VC Assembly public key token, from the @code{crtassem.h} header file.
@end deffn

@geindex LIBRARIES_ASSEMBLY_NAME_PREFIX (en el módulo msvcrt)
@anchor{library/msvcrt msvcrt LIBRARIES_ASSEMBLY_NAME_PREFIX}@anchor{13c1}
@deffn {Dato} msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX

The Libraries Assembly name prefix, from the @code{crtassem.h} header file.
@end deffn

@node winreg — Windows registry access,winsound — Sound-playing interface for Windows,msvcrt — Useful routines from the MS VC++ runtime,Servicios Específicos para MS Windows
@anchor{library/winreg doc}@anchor{46bf}@anchor{library/winreg module-winreg}@anchor{116}@anchor{library/winreg winreg-windows-registry-access}@anchor{46c0}
@subsection @code{winreg} — Windows registry access


@geindex module; winreg


__________________________________________________________________


Estas funciones exponen la API de registro de Windows a Python. En lugar de utilizar un número entero como identificador de registro, se utiliza un @ref{46c1,,handle object} para garantizar que los identificadores se cierren correctamente, incluso si el programador se niega a cerrarlos explícitamente.
@anchor{library/winreg exception-changed}@anchor{46c2}

Distinto en la versión 3.3: Varias funciones de este módulo solían lanzar un @ref{10d0,,WindowsError}, que ahora es un alias de @ref{4d5,,OSError}.


@menu
* Funciones: Funciones<11>. 
* Constantes: Constantes<11>. 
* Objetos de control del registro:: 

@end menu

@node Funciones<11>,Constantes<11>,,winreg — Windows registry access
@anchor{library/winreg functions}@anchor{46c3}@anchor{library/winreg id1}@anchor{46c4}
@subsubsection Funciones


Este módulo ofrece las siguientes funciones:

@geindex CloseKey() (en el módulo winreg)
@anchor{library/winreg winreg CloseKey}@anchor{46c5}
@deffn {Función} winreg.CloseKey (hkey)

Cierra una clave de registro abierta previamente. El argumento `hkey' especifica una clave abierta previamente.

@cartouche
@quotation Nota 
Si `hkey' no se cierra con este método (o mediante @ref{46c6,,hkey.Close()}), se cierra cuando Python destruye el objeto `hkey'.
@end quotation
@end cartouche
@end deffn

@geindex ConnectRegistry() (en el módulo winreg)
@anchor{library/winreg winreg ConnectRegistry}@anchor{4112}
@deffn {Función} winreg.ConnectRegistry (computer_name, key)

Establece una conexión con un identificador de registro predefinido en otra computadora y retorna un @ref{46c1,,handle object}.

`computer_name' es el nombre de la computadora remota, de la forma @code{r”\\computername”}. Si es @code{None}, se utiliza la computadora local.

`key' es el identificador predefinido al que conectarse.

El valor de retorno es el identificador de la llave abierta. Si la función falla, se lanza una excepción @ref{4d5,,OSError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.ConnectRegistry} con argumentos @code{computer_name}, @code{key}.


Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex CreateKey() (en el módulo winreg)
@anchor{library/winreg winreg CreateKey}@anchor{4113}
@deffn {Función} winreg.CreateKey (key, sub_key)

Crea o abre la clave especificada, retornando un @ref{46c1,,handle object}.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que nombra la clave que este método abre o crea.

Si `key' es una de las claves predefinidas, `sub_key' puede ser @code{None}. En ese caso, el identificador retornado es el mismo identificador de clave que se pasó a la función.

Si la clave ya existe, esta función abre la clave existente.

El valor de retorno es el identificador de la llave abierta. Si la función falla, se lanza una excepción @ref{4d5,,OSError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.CreateKey} con los argumentos @code{key}, @code{sub_key}, @code{access}.

Lanza un @ref{18c3,,auditing event} @code{winreg.OpenKey/result} con el argumento @code{key}.


Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex CreateKeyEx() (en el módulo winreg)
@anchor{library/winreg winreg CreateKeyEx}@anchor{13c2}
@deffn {Función} winreg.CreateKeyEx (key, sub_key, reserved=0, access=KEY_WRITE)

Crea o abre la clave especificada, retornando un @ref{46c1,,handle object}.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que nombra la clave que este método abre o crea.

`reserved' es un número entero reservado y debe ser cero. El valor predeterminado es cero.

`access' es un número entero que especifica una máscara de acceso que describe el acceso de seguridad deseado para la clave. El valor predeterminado es @ref{46c8,,KEY_WRITE}. Ver @ref{46c9,,Access Rights} para otros valores permitidos.

Si `key' es una de las claves predefinidas, `sub_key' puede ser @code{None}. En ese caso, el identificador retornado es el mismo identificador de clave que se pasó a la función.

Si la clave ya existe, esta función abre la clave existente.

El valor de retorno es el identificador de la llave abierta. Si la función falla, se lanza una excepción @ref{4d5,,OSError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.CreateKey} con los argumentos @code{key}, @code{sub_key}, @code{access}.

Lanza un @ref{18c3,,auditing event} @code{winreg.OpenKey/result} con el argumento @code{key}.


Added in version 3.2.



Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex DeleteKey() (en el módulo winreg)
@anchor{library/winreg winreg DeleteKey}@anchor{4114}
@deffn {Función} winreg.DeleteKey (key, sub_key)

Elimina la clave especificada.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que debe ser una subclave de la clave identificada por el parámetro `key'. Este valor no debe ser @code{None}, y es posible que la clave no tenga subclaves.

`Este método no puede eliminar claves con subclaves.'

Si el método tiene éxito, se elimina toda la clave, incluidos todos sus valores. Si el método falla, se lanza una excepción @ref{4d5,,OSError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.DeleteKey} con los argumentos @code{key}, @code{sub_key}, @code{access}.


Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex DeleteKeyEx() (en el módulo winreg)
@anchor{library/winreg winreg DeleteKeyEx}@anchor{13c3}
@deffn {Función} winreg.DeleteKeyEx (key, sub_key, access=KEY_WOW64_64KEY, reserved=0)

Elimina la clave especificada.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que debe ser una subclave de la clave identificada por el parámetro `key'. Este valor no debe ser @code{None}, y es posible que la clave no tenga subclaves.

`reserved' es un número entero reservado y debe ser cero. El valor predeterminado es cero.

`access' es un número entero que especifica una máscara de acceso que describe el acceso de seguridad deseado para la clave. El valor predeterminado es @ref{46ca,,KEY_WOW64_64KEY}. En Windows de 32-bit, las constantes WOW64 son ignoradas. Ver @ref{46c9,,Access Rights} para otros valores permitidos.

`Este método no puede eliminar claves con subclaves.'

Si el método tiene éxito, se elimina toda la clave, incluidos todos sus valores. Si el método falla, se lanza una excepción @ref{4d5,,OSError}.

En versiones de Windows no compatibles, se lanza @ref{384,,NotImplementedError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.DeleteKey} con los argumentos @code{key}, @code{sub_key}, @code{access}.


Added in version 3.2.



Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex DeleteValue() (en el módulo winreg)
@anchor{library/winreg winreg DeleteValue}@anchor{4115}
@deffn {Función} winreg.DeleteValue (key, value)

Elimina un valor con nombre de una clave de registro.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`value' es una cadena que identifica el valor a eliminar.

Lanza un @ref{18c3,,auditing event} @code{winreg.DeleteValue} con argumentos @code{key}, @code{value}.
@end deffn

@geindex EnumKey() (en el módulo winreg)
@anchor{library/winreg winreg EnumKey}@anchor{4116}
@deffn {Función} winreg.EnumKey (key, index)

Enumera las subclaves de una clave de registro abierta y retorna una cadena de caracteres.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`index' es un número entero que identifica el índice de la clave a recuperar.

La función recupera el nombre de una subclave cada vez que se llama. Normalmente se llama repetidamente hasta que se lanza una excepción @ref{4d5,,OSError}, lo que indica que no hay más valores disponibles.

Lanza un @ref{18c3,,auditing event} @code{winreg.EnumKey} con argumentos @code{key}, @code{index}.


Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex EnumValue() (en el módulo winreg)
@anchor{library/winreg winreg EnumValue}@anchor{4117}
@deffn {Función} winreg.EnumValue (key, index)

Enumera los valores de una clave de registro abierta y retorna una tupla.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`index' es un número entero que identifica el índice del valor a recuperar.

La función recupera el nombre de una subclave cada vez que se llama. Normalmente se llama repetidamente, hasta que se lanza una excepción @ref{4d5,,OSError}, lo que indica que no hay más valores.

El resultado es una tupla de 3 elementos:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

Una cadena de caracteres que identifica el nombre del valor

@item

@code{1}

@tab

Un objeto que contiene los datos del valor y cuyo tipo depende del tipo de registro subyacente

@item

@code{2}

@tab

Un número entero que identifica el tipo de datos de valor (consulte la tabla en los documentos para @ref{1796,,SetValueEx()})

@end multitable


Lanza un @ref{18c3,,auditing event} @code{winreg.EnumValue} con argumentos @code{key}, @code{index}.


Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex % (percent);environment variables expansion (Windows)

@geindex ExpandEnvironmentStrings() (en el módulo winreg)
@anchor{library/winreg winreg ExpandEnvironmentStrings}@anchor{1438}
@deffn {Función} winreg.ExpandEnvironmentStrings (str)

Expande los marcadores de posición de la variable de entorno @code{%NAME%} en cadenas como @ref{46cb,,REG_EXPAND_SZ}:

@example
>>> ExpandEnvironmentStrings('%windir%')
'C:\\Windows'
@end example

Lanza un @ref{18c3,,auditing event} @code{winreg.ExpandEnvironmentStrings} con el argumento @code{str}.
@end deffn

@geindex FlushKey() (en el módulo winreg)
@anchor{library/winreg winreg FlushKey}@anchor{46cc}
@deffn {Función} winreg.FlushKey (key)

Escribe todos los atributos de una clave en el registro.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

No es necesario llamar a @ref{46cc,,FlushKey()} para cambiar una clave. Los cambios en el registro se descargan en el disco mediante el registro mediante su vaciador diferido. Los cambios en el registro también se vacían en el disco cuando se apaga el sistema. A diferencia de @ref{46c5,,CloseKey()}, el método @ref{46cc,,FlushKey()} retorna solo cuando todos los datos se han escrito en el registro. Una aplicación solo debe llamar a @ref{46cc,,FlushKey()} si requiere absoluta certeza de que los cambios de registro están en el disco.

@cartouche
@quotation Nota 
Si no sabe si se requiere una llamada @ref{46cc,,FlushKey()}, probablemente no lo sea.
@end quotation
@end cartouche
@end deffn

@geindex LoadKey() (en el módulo winreg)
@anchor{library/winreg winreg LoadKey}@anchor{4118}
@deffn {Función} winreg.LoadKey (key, sub_key, file_name)

Crea una subclave bajo la clave especificada y almacena la información de registro de un archivo especificado en esa subclave.

`key' es un identificador retornado por @ref{4112,,ConnectRegistry()} o una de las constantes @ref{46cd,,HKEY_USERS} o @ref{46ce,,HKEY_LOCAL_MACHINE}.

`sub_key' es una cadena de caracteres que identifica la subclave a cargar.

`file_name' es el nombre del archivo desde el que cargar los datos de registro. Este archivo debe haber sido creado con la función @ref{411e,,SaveKey()}. En el sistema de archivos de la tabla de asignación de archivos (FAT), es posible que el nombre del archivo no tenga extensión.

Una llamada a @ref{4118,,LoadKey()} falla si el proceso de llamada no tiene el privilegio @code{SE_RESTORE_PRIVILEGE}. Tenga en cuenta que los privilegios son diferentes de los permisos; consulte la RegLoadKey documentation@footnote{https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx} para obtener más detalles.

Si `key' es un identificador retornado por @ref{4112,,ConnectRegistry()}, entonces la ruta especificada en `file_name' es relativa a la computadora remota.

Lanza un @ref{18c3,,auditing event} @code{winreg.LoadKey} con los argumentos @code{key}, @code{sub_key}, @code{file_name}.
@end deffn

@geindex OpenKey() (en el módulo winreg)
@geindex OpenKeyEx() (en el módulo winreg)
@anchor{library/winreg winreg OpenKey}@anchor{4119}
@deffn {Función} winreg.OpenKey (key, sub_key, reserved=0, access=KEY_READ)
@anchor{library/winreg winreg OpenKeyEx}@anchor{46cf}
@deffnx {Función} winreg.OpenKeyEx (key, sub_key, reserved=0, access=KEY_READ)

Abre la clave especificada, retornando a @ref{46c1,,handle object}.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que identifica la sub_key para abrir.

`reserved' es un número entero reservado y debe ser cero. El valor predeterminado es cero.

`access' es un número entero que especifica una máscara de acceso que describe el acceso de seguridad deseado para la clave. El valor predeterminado es @ref{46d0,,KEY_READ}. Ver @ref{46c9,,Access Rights} para otros valores permitidos.

El resultado es un nuevo identificador para la clave especificada.

Si la función falla, se lanza @ref{4d5,,OSError}.

Lanza un @ref{18c3,,auditing event} @code{winreg.OpenKey} con los argumentos @code{key}, @code{sub_key}, @code{access}.

Lanza un @ref{18c3,,auditing event} @code{winreg.OpenKey/result} con el argumento @code{key}.


Distinto en la versión 3.2: Permite el uso de argumentos con nombre.



Distinto en la versión 3.3: Ver @ref{46c2,,above}.

@end deffn

@geindex QueryInfoKey() (en el módulo winreg)
@anchor{library/winreg winreg QueryInfoKey}@anchor{411b}
@deffn {Función} winreg.QueryInfoKey (key)

Retorna información sobre una clave, como una tupla.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

El resultado es una tupla de 3 elementos:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

Un número entero que indica el número de subclaves que tiene esta clave.

@item

@code{1}

@tab

Un número entero que da el número de valores que tiene esta clave.

@item

@code{2}

@tab

Un número entero que indica la última vez que se modificó la clave (si está disponible) como cientos de nanosegundos desde el 1 de enero de 1601.

@end multitable


Lanza un @ref{18c3,,auditing event} @code{winreg.QueryInfoKey} con el argumento @code{key}.
@end deffn

@geindex QueryValue() (en el módulo winreg)
@anchor{library/winreg winreg QueryValue}@anchor{411c}
@deffn {Función} winreg.QueryValue (key, sub_key)

Recupera el valor sin nombre de una clave, como una cadena de caracteres.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que contiene el nombre de la subclave con la que está asociado el valor. Si este parámetro es @code{None} o está vacío, la función recupera el valor establecido por el método @ref{411f,,SetValue()} para la clave identificada por `key'.

Los valores del registro tienen componentes de nombre, tipo y datos. Este método recupera los datos del primer valor de una clave que tiene un nombre @code{NULL}. Pero la llamada a la API subyacente no retorna el tipo, así que siempre use @ref{411d,,QueryValueEx()} si es posible.

Lanza un @ref{18c3,,auditing event} @code{winreg.QueryValue} con los argumentos @code{key}, @code{sub_key}, @code{value_name}.
@end deffn

@geindex QueryValueEx() (en el módulo winreg)
@anchor{library/winreg winreg QueryValueEx}@anchor{411d}
@deffn {Función} winreg.QueryValueEx (key, value_name)

Recupera el tipo y los datos de un nombre de valor especificado asociado con una clave de registro abierta.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`value_name' es una cadena de caracteres que indica el valor a consultar.

El resultado es una tupla de 2 elementos:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

El valor del elemento de registro.

@item

@code{1}

@tab

Un número entero que proporciona el tipo de registro para este valor (consulte la tabla en docs para @ref{1796,,SetValueEx()})

@end multitable


Lanza un @ref{18c3,,auditing event} @code{winreg.QueryValue} con los argumentos @code{key}, @code{sub_key}, @code{value_name}.
@end deffn

@geindex SaveKey() (en el módulo winreg)
@anchor{library/winreg winreg SaveKey}@anchor{411e}
@deffn {Función} winreg.SaveKey (key, file_name)

Guarda la clave especificada y todas sus subclaves en el archivo especificado.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`file_name' es el nombre del archivo en el que se guardarán los datos del registro. Este archivo no puede existir ya. Si este nombre de archivo incluye una extensión, no se puede usar en sistemas de archivos de tabla de asignación de archivos (FAT) mediante el método @ref{4118,,LoadKey()}.

Si `key' representa una clave en una computadora remota, la ruta descrita por `file_name' es relativa a la computadora remota. El invocador de este método debe poseer el privilegio de seguridad `SeBackupPrivilege'. Tenga en cuenta que los privilegios son diferentes a los permisos – consulte la documentación sobre conflictos entre derechos de usuario y permisos@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx} para más detalles.

Esta función pasa @code{NULL} para `security_attributes' a la API.

Lanza un @ref{18c3,,auditing event} @code{winreg.SaveKey} con los argumentos @code{key}, @code{file_name}.
@end deffn

@geindex SetValue() (en el módulo winreg)
@anchor{library/winreg winreg SetValue}@anchor{411f}
@deffn {Función} winreg.SetValue (key, sub_key, type, value)

Asocia un valor con una clave especificada.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`sub_key' es una cadena de caracteres que nombra la subclave con la que está asociado el valor.

`type' es un número entero que especifica el tipo de datos. Actualmente debe ser @ref{46d1,,REG_SZ}, lo que significa que solo se admiten cadenas de caracteres. Utilice la función: @ref{1796,,SetValueEx()} para admitir otros tipos de datos.

`value' es una cadena de caracteres que especifica el nuevo valor.

Si la clave especificada por el parámetro `sub_key' no existe, la función SetValue la crea.

Las longitudes de los valores están limitadas por la memoria disponible. Los valores largos (más de 2048 bytes) deben almacenarse como archivos con los nombres de archivo almacenados en el registro de configuración. Esto ayuda a que el registro funcione de manera eficiente.

La clave identificada por el parámetro `key' debe haber sido abierta con acceso @ref{46d2,,KEY_SET_VALUE}.

Lanza un @ref{18c3,,auditing event} @code{winreg.SetValue} con argumentos @code{key}, @code{sub_key}, @code{type}, @code{value}.
@end deffn

@geindex SetValueEx() (en el módulo winreg)
@anchor{library/winreg winreg SetValueEx}@anchor{1796}
@deffn {Función} winreg.SetValueEx (key, value_name, reserved, type, value)

Almacena datos en el campo de valor de una clave de registro abierta.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

`value_name' es una cadena de caracteres que nombra la subclave con la que está asociado el valor.

`reserved' puede ser cualquier cosa — cero siempre se pasa a la API.

`type' es un número entero que especifica el tipo de datos. Consulte @ref{46d3,,Value Types} para los tipos disponibles.

`value' es una cadena de caracteres que especifica el nuevo valor.

Este método también puede establecer un valor adicional e información de tipo para la clave especificada. La clave identificada por el parámetro clave debe haber sido abierta con acceso @ref{46d2,,KEY_SET_VALUE}.

Para abrir la clave, use los métodos @ref{4113,,CreateKey()} o @ref{4119,,OpenKey()}.

Las longitudes de los valores están limitadas por la memoria disponible. Los valores largos (más de 2048 bytes) deben almacenarse como archivos con los nombres de archivo almacenados en el registro de configuración. Esto ayuda a que el registro funcione de manera eficiente.

Lanza un @ref{18c3,,auditing event} @code{winreg.SetValue} con argumentos @code{key}, @code{sub_key}, @code{type}, @code{value}.
@end deffn

@geindex DisableReflectionKey() (en el módulo winreg)
@anchor{library/winreg winreg DisableReflectionKey}@anchor{13c4}
@deffn {Función} winreg.DisableReflectionKey (key)

Desactiva la reflexión del registro para los procesos de 32 bits que se ejecutan en un sistema operativo de 64 bits.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

Generalmente lanzará @ref{384,,NotImplementedError} si se ejecuta en un sistema operativo de 32 bits.

Si la clave no está en la lista de reflexión, la función tiene éxito pero no tiene ningún efecto. La desactivación de la reflexión de una clave no afecta la reflexión de ninguna subclave.

Lanza un @ref{18c3,,auditing event} @code{winreg.DisableReflectionKey} con el argumento @code{key}.
@end deffn

@geindex EnableReflectionKey() (en el módulo winreg)
@anchor{library/winreg winreg EnableReflectionKey}@anchor{13c5}
@deffn {Función} winreg.EnableReflectionKey (key)

Restaura la reflexión del registro para la clave deshabilitada especificada.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

Generalmente lanzará @ref{384,,NotImplementedError} si se ejecuta en un sistema operativo de 32 bits.

La restauración de la reflexión de una clave no afecta la reflexión de ninguna subclave.

Lanza un @ref{18c3,,auditing event} @code{winreg.EnableReflectionKey} con el argumento @code{key}.
@end deffn

@geindex QueryReflectionKey() (en el módulo winreg)
@anchor{library/winreg winreg QueryReflectionKey}@anchor{13c6}
@deffn {Función} winreg.QueryReflectionKey (key)

Determina el estado de reflexión para la clave especificada.

`key' es una clave ya abierta, o una de las predefinidas @ref{46c7,,HKEY_* constants}.

Retorna @code{True} si la reflexión está deshabilitada.

Generalmente lanzará @ref{384,,NotImplementedError} si se ejecuta en un sistema operativo de 32 bits.

Lanza un @ref{18c3,,auditing event} @code{winreg.QueryReflectionKey} con el argumento @code{key}.
@end deffn

@node Constantes<11>,Objetos de control del registro,Funciones<11>,winreg — Windows registry access
@anchor{library/winreg constants}@anchor{46d4}@anchor{library/winreg id2}@anchor{46d5}
@subsubsection Constantes


Las siguientes constantes están definidas para su uso en muchas funciones @ref{116,,winreg}.

@menu
* HKEY_* Constantes:: 
* Access Rights:: 
* Tipos de valor:: 

@end menu

@node HKEY_* Constantes,Access Rights,,Constantes<11>
@anchor{library/winreg hkey-constants}@anchor{46c7}@anchor{library/winreg id3}@anchor{46d6}
@subsubsection HKEY_* Constantes


@geindex HKEY_CLASSES_ROOT (en el módulo winreg)
@anchor{library/winreg winreg HKEY_CLASSES_ROOT}@anchor{46d7}
@deffn {Dato} winreg.HKEY_CLASSES_ROOT

Las entradas de registro subordinadas a esta clave definen tipos (o clases) de documentos y las propiedades asociadas con esos tipos. Las aplicaciones Shell y COM utilizan la información almacenada en esta clave.
@end deffn

@geindex HKEY_CURRENT_USER (en el módulo winreg)
@anchor{library/winreg winreg HKEY_CURRENT_USER}@anchor{46d8}
@deffn {Dato} winreg.HKEY_CURRENT_USER

Las entradas de registro subordinadas a esta clave definen las preferencias del usuario actual. Estas preferencias incluyen la configuración de variables de entorno, datos sobre grupos de programas, colores, impresoras, conexiones de red y preferencias de la aplicación.
@end deffn

@geindex HKEY_LOCAL_MACHINE (en el módulo winreg)
@anchor{library/winreg winreg HKEY_LOCAL_MACHINE}@anchor{46ce}
@deffn {Dato} winreg.HKEY_LOCAL_MACHINE

Las entradas de registro subordinadas a esta clave definen el estado físico de la computadora, incluidos los datos sobre el tipo de bus, la memoria del sistema y el hardware y software instalados.
@end deffn

@geindex HKEY_USERS (en el módulo winreg)
@anchor{library/winreg winreg HKEY_USERS}@anchor{46cd}
@deffn {Dato} winreg.HKEY_USERS

Las entradas de registro subordinadas a esta clave definen la configuración de usuario predeterminada para nuevos usuarios en la computadora local y la configuración de usuario para el usuario actual.
@end deffn

@geindex HKEY_PERFORMANCE_DATA (en el módulo winreg)
@anchor{library/winreg winreg HKEY_PERFORMANCE_DATA}@anchor{46d9}
@deffn {Dato} winreg.HKEY_PERFORMANCE_DATA

Las entradas de registro subordinadas a esta clave le permiten acceder a los datos de rendimiento. Los datos no se almacenan realmente en el registro; las funciones de registro hacen que el sistema recopile los datos de su fuente.
@end deffn

@geindex HKEY_CURRENT_CONFIG (en el módulo winreg)
@anchor{library/winreg winreg HKEY_CURRENT_CONFIG}@anchor{46da}
@deffn {Dato} winreg.HKEY_CURRENT_CONFIG

Contiene información sobre el perfil de hardware actual del sistema informático local.
@end deffn

@geindex HKEY_DYN_DATA (en el módulo winreg)
@anchor{library/winreg winreg HKEY_DYN_DATA}@anchor{46db}
@deffn {Dato} winreg.HKEY_DYN_DATA

Esta clave no se usa en versiones de Windows posteriores a la 98.
@end deffn

@node Access Rights,Tipos de valor,HKEY_* Constantes,Constantes<11>
@anchor{library/winreg access-rights}@anchor{46c9}@anchor{library/winreg id4}@anchor{46dc}
@subsubsection Access Rights


Para más información, ver Registry Key Security and Access@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx}.

@geindex KEY_ALL_ACCESS (en el módulo winreg)
@anchor{library/winreg winreg KEY_ALL_ACCESS}@anchor{46dd}
@deffn {Dato} winreg.KEY_ALL_ACCESS

Combina los derechos de acceso STANDARD_RIGHTS_REQUIRED, @ref{46de,,KEY_QUERY_VALUE}, @ref{46d2,,KEY_SET_VALUE}, @ref{46df,,KEY_CREATE_SUB_KEY}, @ref{46e0,,KEY_ENUMERATE_SUB_KEYS}, @ref{46e1,,KEY_NOTIFY}, y @ref{46e2,,KEY_CREATE_LINK}.
@end deffn

@geindex KEY_WRITE (en el módulo winreg)
@anchor{library/winreg winreg KEY_WRITE}@anchor{46c8}
@deffn {Dato} winreg.KEY_WRITE

Combina los derechos de acceso STANDARD_RIGHTS_WRITE, @ref{46d2,,KEY_SET_VALUE}, y @ref{46df,,KEY_CREATE_SUB_KEY}.
@end deffn

@geindex KEY_READ (en el módulo winreg)
@anchor{library/winreg winreg KEY_READ}@anchor{46d0}
@deffn {Dato} winreg.KEY_READ

Combina los valores STANDARD_RIGHTS_READ, @ref{46de,,KEY_QUERY_VALUE}, @ref{46e0,,KEY_ENUMERATE_SUB_KEYS}, y @ref{46e1,,KEY_NOTIFY}.
@end deffn

@geindex KEY_EXECUTE (en el módulo winreg)
@anchor{library/winreg winreg KEY_EXECUTE}@anchor{46e3}
@deffn {Dato} winreg.KEY_EXECUTE

Equivalente a @ref{46d0,,KEY_READ}.
@end deffn

@geindex KEY_QUERY_VALUE (en el módulo winreg)
@anchor{library/winreg winreg KEY_QUERY_VALUE}@anchor{46de}
@deffn {Dato} winreg.KEY_QUERY_VALUE

Requerido para consultar los valores de una clave de registro.
@end deffn

@geindex KEY_SET_VALUE (en el módulo winreg)
@anchor{library/winreg winreg KEY_SET_VALUE}@anchor{46d2}
@deffn {Dato} winreg.KEY_SET_VALUE

Requerido para crear, eliminar o establecer un valor de registro.
@end deffn

@geindex KEY_CREATE_SUB_KEY (en el módulo winreg)
@anchor{library/winreg winreg KEY_CREATE_SUB_KEY}@anchor{46df}
@deffn {Dato} winreg.KEY_CREATE_SUB_KEY

Necesario para crear una subclave de una clave de registro.
@end deffn

@geindex KEY_ENUMERATE_SUB_KEYS (en el módulo winreg)
@anchor{library/winreg winreg KEY_ENUMERATE_SUB_KEYS}@anchor{46e0}
@deffn {Dato} winreg.KEY_ENUMERATE_SUB_KEYS

Requerido para enumerar las subclaves de una clave de registro.
@end deffn

@geindex KEY_NOTIFY (en el módulo winreg)
@anchor{library/winreg winreg KEY_NOTIFY}@anchor{46e1}
@deffn {Dato} winreg.KEY_NOTIFY

Requerido para solicitar notificaciones de cambio para una clave de registro o para subclaves de una clave de registro.
@end deffn

@geindex KEY_CREATE_LINK (en el módulo winreg)
@anchor{library/winreg winreg KEY_CREATE_LINK}@anchor{46e2}
@deffn {Dato} winreg.KEY_CREATE_LINK

Reservado para uso del sistema.
@end deffn

@menu
* Específico de 64 bits:: 

@end menu

@node Específico de 64 bits,,,Access Rights
@anchor{library/winreg bit-access-rights}@anchor{46e4}@anchor{library/winreg bit-specific}@anchor{46e5}
@subsubsection Específico de 64 bits


Para más información, ver Accessing an Alternate Registry View@footnote{https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx}.

@geindex KEY_WOW64_64KEY (en el módulo winreg)
@anchor{library/winreg winreg KEY_WOW64_64KEY}@anchor{46ca}
@deffn {Dato} winreg.KEY_WOW64_64KEY

Indica que una aplicación en Windows de 64 bits debería funcionar en la vista de registro de 64 bits. En Windows de 32 bits, esta constante se ignora.
@end deffn

@geindex KEY_WOW64_32KEY (en el módulo winreg)
@anchor{library/winreg winreg KEY_WOW64_32KEY}@anchor{46e6}
@deffn {Dato} winreg.KEY_WOW64_32KEY

Indica que una aplicación en Windows de 64 bits debería funcionar en la vista de registro de 32 bits. En Windows de 32 bits, esta constante se ignora.
@end deffn

@node Tipos de valor,,Access Rights,Constantes<11>
@anchor{library/winreg id5}@anchor{46e7}@anchor{library/winreg value-types}@anchor{46d3}
@subsubsection Tipos de valor


Para más información, ver Registry Value Types@footnote{https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx}.

@geindex REG_BINARY (en el módulo winreg)
@anchor{library/winreg winreg REG_BINARY}@anchor{46e8}
@deffn {Dato} winreg.REG_BINARY

Datos binarios en cualquier forma.
@end deffn

@geindex REG_DWORD (en el módulo winreg)
@anchor{library/winreg winreg REG_DWORD}@anchor{46e9}
@deffn {Dato} winreg.REG_DWORD

Número de 32 bits.
@end deffn

@geindex REG_DWORD_LITTLE_ENDIAN (en el módulo winreg)
@anchor{library/winreg winreg REG_DWORD_LITTLE_ENDIAN}@anchor{46ea}
@deffn {Dato} winreg.REG_DWORD_LITTLE_ENDIAN

Un número de 32 bits en formato little-endian. Equivalente a @ref{46e9,,REG_DWORD}.
@end deffn

@geindex REG_DWORD_BIG_ENDIAN (en el módulo winreg)
@anchor{library/winreg winreg REG_DWORD_BIG_ENDIAN}@anchor{46eb}
@deffn {Dato} winreg.REG_DWORD_BIG_ENDIAN

Un número de 32 bits en formato big-endian.
@end deffn

@geindex REG_EXPAND_SZ (en el módulo winreg)
@anchor{library/winreg winreg REG_EXPAND_SZ}@anchor{46cb}
@deffn {Dato} winreg.REG_EXPAND_SZ

Cadena de caracteres terminada en nulo que contiene referencias a variables de entorno (@code{%PATH%}).
@end deffn

@geindex REG_LINK (en el módulo winreg)
@anchor{library/winreg winreg REG_LINK}@anchor{46ec}
@deffn {Dato} winreg.REG_LINK

Un enlace simbólico Unicode.
@end deffn

@geindex REG_MULTI_SZ (en el módulo winreg)
@anchor{library/winreg winreg REG_MULTI_SZ}@anchor{19e7}
@deffn {Dato} winreg.REG_MULTI_SZ

Una secuencia de cadenas de caracteres terminadas en nulo, terminadas por dos caracteres nulos. (Python maneja esta terminación automáticamente).
@end deffn

@geindex REG_NONE (en el módulo winreg)
@anchor{library/winreg winreg REG_NONE}@anchor{46ed}
@deffn {Dato} winreg.REG_NONE

Sin tipo de valor definido.
@end deffn

@geindex REG_QWORD (en el módulo winreg)
@anchor{library/winreg winreg REG_QWORD}@anchor{d89}
@deffn {Dato} winreg.REG_QWORD

Un número de 64 bits.


Added in version 3.6.

@end deffn

@geindex REG_QWORD_LITTLE_ENDIAN (en el módulo winreg)
@anchor{library/winreg winreg REG_QWORD_LITTLE_ENDIAN}@anchor{46ee}
@deffn {Dato} winreg.REG_QWORD_LITTLE_ENDIAN

Un número de 64 bits en formato little-endian. Equivalente a @ref{d89,,REG_QWORD}.


Added in version 3.6.

@end deffn

@geindex REG_RESOURCE_LIST (en el módulo winreg)
@anchor{library/winreg winreg REG_RESOURCE_LIST}@anchor{46ef}
@deffn {Dato} winreg.REG_RESOURCE_LIST

Una lista de recursos de controladores de dispositivo.
@end deffn

@geindex REG_FULL_RESOURCE_DESCRIPTOR (en el módulo winreg)
@anchor{library/winreg winreg REG_FULL_RESOURCE_DESCRIPTOR}@anchor{46f0}
@deffn {Dato} winreg.REG_FULL_RESOURCE_DESCRIPTOR

Una configuración de hardware.
@end deffn

@geindex REG_RESOURCE_REQUIREMENTS_LIST (en el módulo winreg)
@anchor{library/winreg winreg REG_RESOURCE_REQUIREMENTS_LIST}@anchor{46f1}
@deffn {Dato} winreg.REG_RESOURCE_REQUIREMENTS_LIST

Una lista de recursos de hardware.
@end deffn

@geindex REG_SZ (en el módulo winreg)
@anchor{library/winreg winreg REG_SZ}@anchor{46d1}
@deffn {Dato} winreg.REG_SZ

Una cadena de caracteres terminada en nulo.
@end deffn

@node Objetos de control del registro,,Constantes<11>,winreg — Windows registry access
@anchor{library/winreg handle-object}@anchor{46c1}@anchor{library/winreg registry-handle-objects}@anchor{46f2}
@subsubsection Objetos de control del registro


Este objeto envuelve un objeto HKEY de Windows y lo cierra automáticamente cuando se destruye. Para garantizar la limpieza, puede llamar al método @ref{46c6,,Close()} en el objeto, o a la función @ref{46c5,,CloseKey()}.

Todas las funciones de registro de este módulo retornan uno de estos objetos.

Todas las funciones de registro de este módulo que aceptan un objeto identificador también aceptan un número entero, sin embargo, se recomienda el uso del objeto identificador.

Los objetos de control proporcionan semántica para @ref{133d,,__bool__()} – así

@example
if handle:
    print("Yes")
@end example

imprimirá @code{Yes} si el controlador es válido actualmente (no se ha cerrado o desprendido).

El objeto también admite la semántica de comparación, por lo que los objetos de identificador se compararán con verdadero si ambos hacen referencia al mismo valor de identificador de Windows subyacente.

Los objetos de identificador se pueden convertir a un número entero (por ejemplo, usando la función incorporada @ref{1f0,,int()} function), en cuyo caso se retorna el valor de identificador de Windows subyacente. También puede usar el método @ref{411a,,Detach()} para retornar el identificador de enteros y también desconectar el identificador de Windows del objeto identificador.

@geindex Close() (método de winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY Close}@anchor{46c6}
@deffn {Método} PyHKEY.Close ()

Cierra el identificador de Windows subyacente.

Si el controlador ya está cerrado, no se lanza ningún error.
@end deffn

@geindex Detach() (método de winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY Detach}@anchor{411a}
@deffn {Método} PyHKEY.Detach ()

Separa el identificador de Windows del objeto identificador.

El resultado es un número entero que contiene el valor del identificador antes de que se separe. Si el controlador ya está separado o cerrado, esto retornará cero.

Después de llamar a esta función, el identificador se invalida efectivamente, pero el identificador no se cierra. Llamaría a esta función cuando necesite que el identificador Win32 subyacente exista más allá de la vida útil del objeto identificador.

Lanza un @ref{18c3,,auditing event} @code{winreg.PyHKEY.Detach} con el argumento @code{key}.
@end deffn

@geindex __enter__() (método de winreg.PyHKEY)
@geindex __exit__() (método de winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY __enter__}@anchor{46f3}
@deffn {Método} PyHKEY.__enter__ ()
@anchor{library/winreg winreg PyHKEY __exit__}@anchor{46f4}
@deffnx {Método} PyHKEY.__exit__ (*exc_info)

El objeto HKEY implementa @ref{669,,__enter__()} y @ref{1367,,__exit__()} y, por lo tanto, admite el protocolo de contexto para la declaración @ref{673,,with}:

@example
with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    ...  # work with key
@end example

cerrará automáticamente `key' cuando el control abandone el bloque @ref{673,,with}.
@end deffn

@node winsound — Sound-playing interface for Windows,,winreg — Windows registry access,Servicios Específicos para MS Windows
@anchor{library/winsound doc}@anchor{46f5}@anchor{library/winsound module-winsound}@anchor{117}@anchor{library/winsound winsound-sound-playing-interface-for-windows}@anchor{46f6}
@subsection @code{winsound} — Sound-playing interface for Windows


@geindex module; winsound


__________________________________________________________________


El modulo @ref{117,,winsound} permite acceder a la maquinaria básica de reproducción de sonidos proporcionada por la plataformas Windows. Incluye funciones y varias constantes.

@geindex Beep() (en el módulo winsound)
@anchor{library/winsound winsound Beep}@anchor{d8b}
@deffn {Función} winsound.Beep (frequency, duration)

Hace sonar el altavoz del PC. El parámetro `frequency' especifica la frecuencia, en hercio (hz), de la señal de audio y debe estar en el rango de 37 a 32.767 hz. El parámetro `duration' especifica el numero de milisegundo de duración de la señal de audio. Si el sistema no puede hacer sonar el altavoz, se lanza @ref{1e5,,RuntimeError}.
@end deffn

@geindex PlaySound() (en el módulo winsound)
@anchor{library/winsound winsound PlaySound}@anchor{d8d}
@deffn {Función} winsound.PlaySound (sound, flags)

Llama a la función responsable de @code{PlaySound()} desde el API de la plataforma.  El parámetro `sound' puede ser un nombre de archivo, un alias de sonido del sistema, datos de audio como un @ref{db4,,bytes-like object} , o @code{None}.  Su interpretación depende del valor de `flags', que puede ser una combinación ORed de las constantes descritas a continuación. Si el parámetro de `sound' es @code{None}, cualquier sonido de forma de onda que se esté reproduciendo en ese momento se detiene. Si el sistema indica un error, se lanza @code{RuntimeError`}.
@end deffn

@geindex MessageBeep() (en el módulo winsound)
@anchor{library/winsound winsound MessageBeep}@anchor{d8c}
@deffn {Función} winsound.MessageBeep (type=MB_OK)

Llama a la función responsable de @code{MensajeBeep()} de la API de la plataforma.  Esto reproduce un sonido como se especifica en el registro.  El argumento `type' especifica qué sonido se reproduce; los valores posibles son @code{-1}, @code{MB_ICONASTERISK}, @code{MB_ICONEXCLAMATION}, @code{MB_ICONHAND}, @code{MB_ICONQUESTION}, y @code{MB_OK}, todos descritos a continuación.  El valor @code{-1} produce un «simple pitido»; este es el último recurso si un sonido no puede ser reproducido de otra manera.  Si el sistema indica un error, se lanza @ref{1e5,,RuntimeError}.
@end deffn

@geindex SND_FILENAME (en el módulo winsound)
@anchor{library/winsound winsound SND_FILENAME}@anchor{46f7}
@deffn {Dato} winsound.SND_FILENAME

El parámetro `sound' es el nombre de un archivo WAV. No lo uses con @ref{46f8,,SND_ALIAS}.
@end deffn

@geindex SND_ALIAS (en el módulo winsound)
@anchor{library/winsound winsound SND_ALIAS}@anchor{46f8}
@deffn {Dato} winsound.SND_ALIAS

El parámetro `sound' es un nombre de asociación de sonido del registro.  Si el registro no contiene tal nombre, reproduce el sonido por defecto del sistema a menos que @ref{46f9,,SND_NODEFAULT} también se especifique. Si no se registra ningún sonido por defecto, se lanza @ref{1e5,,RuntimeError}. No lo uses con @ref{46f7,,SND_FILENAME}.

Todos los sistemas Win32 soportan al menos lo siguiente; la mayoría de los sistemas soportan muchos más:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@ref{d8d,,PlaySound()} `name'

@tab

Panel de control correspondiente nombre (`name') del sonido

@item

@code{'SystemAsterisk'}

@tab

Asterisco

@item

@code{'SystemExclamation'}

@tab

Exclamación

@item

@code{'SystemExit'}

@tab

Salir de Windows

@item

@code{'SystemHand'}

@tab

Parada crítica

@item

@code{'SystemQuestion'}

@tab

Pregunta

@end multitable


Por ejemplo:

@example
import winsound
# Play Windows exit sound.
winsound.PlaySound("SystemExit", winsound.SND_ALIAS)

# Probably play Windows default sound, if any is registered (because
# "*" probably isn't the registered name of any sound).
winsound.PlaySound("*", winsound.SND_ALIAS)
@end example
@end deffn

@geindex SND_LOOP (en el módulo winsound)
@anchor{library/winsound winsound SND_LOOP}@anchor{46fa}
@deffn {Dato} winsound.SND_LOOP

Reproducir el sonido repetidamente.  El flag @ref{46fb,,SND_ASYNC} también debe ser usada para evitar el bloqueo.  No puede ser usada con @ref{46fc,,SND_MEMORY}.
@end deffn

@geindex SND_MEMORY (en el módulo winsound)
@anchor{library/winsound winsound SND_MEMORY}@anchor{46fc}
@deffn {Dato} winsound.SND_MEMORY

El parámetro `sound' de @ref{d8d,,PlaySound()} es una imagen de memoria de un archivo WAV, como un @ref{db4,,bytes-like object}.

@cartouche
@quotation Nota 
Este módulo no admite la reproducción desde una imagen de memoria de forma sincrónica, por lo que una combinación de este indicador y @ref{46fb,,SND_ASYNC} se lanza @ref{1e5,,RuntimeError}.
@end quotation
@end cartouche
@end deffn

@geindex SND_PURGE (en el módulo winsound)
@anchor{library/winsound winsound SND_PURGE}@anchor{46fd}
@deffn {Dato} winsound.SND_PURGE

Detiene la reproducción de todas las instancias de un sonido específico.

@cartouche
@quotation Nota 
Esta flag no esta soportado en las plataformas modernas de Windows.
@end quotation
@end cartouche
@end deffn

@geindex SND_ASYNC (en el módulo winsound)
@anchor{library/winsound winsound SND_ASYNC}@anchor{46fb}
@deffn {Dato} winsound.SND_ASYNC

Retorna inmediatamente, permitiendo que los sonidos se reproduzcan asincrónicamente.
@end deffn

@geindex SND_NODEFAULT (en el módulo winsound)
@anchor{library/winsound winsound SND_NODEFAULT}@anchor{46f9}
@deffn {Dato} winsound.SND_NODEFAULT

Si no se puede encontrar el audio especificado, no reproduce el sonido predeterminado del sistema.
@end deffn

@geindex SND_NOSTOP (en el módulo winsound)
@anchor{library/winsound winsound SND_NOSTOP}@anchor{46fe}
@deffn {Dato} winsound.SND_NOSTOP

No interrumpe los sonidos que se están reproduciendo.
@end deffn

@geindex SND_NOWAIT (en el módulo winsound)
@anchor{library/winsound winsound SND_NOWAIT}@anchor{46ff}
@deffn {Dato} winsound.SND_NOWAIT

Retorna inmediatamente en caso de que  el controlador de sonido está ocupado.

@cartouche
@quotation Nota 
Esta flag no esta soportado en las plataformas modernas de Windows.
@end quotation
@end cartouche
@end deffn

@geindex MB_ICONASTERISK (en el módulo winsound)
@anchor{library/winsound winsound MB_ICONASTERISK}@anchor{4700}
@deffn {Dato} winsound.MB_ICONASTERISK

Reproduce el sonido @code{SystemDefault}.
@end deffn

@geindex MB_ICONEXCLAMATION (en el módulo winsound)
@anchor{library/winsound winsound MB_ICONEXCLAMATION}@anchor{4701}
@deffn {Dato} winsound.MB_ICONEXCLAMATION

Reproduce el sonido @code{SystemExclamation}.
@end deffn

@geindex MB_ICONHAND (en el módulo winsound)
@anchor{library/winsound winsound MB_ICONHAND}@anchor{4702}
@deffn {Dato} winsound.MB_ICONHAND

Reproduce el sonido @code{SystemHand}.
@end deffn

@geindex MB_ICONQUESTION (en el módulo winsound)
@anchor{library/winsound winsound MB_ICONQUESTION}@anchor{4703}
@deffn {Dato} winsound.MB_ICONQUESTION

Reproduce el sonido @code{SystemQuestion}.
@end deffn

@geindex MB_OK (en el módulo winsound)
@anchor{library/winsound winsound MB_OK}@anchor{4704}
@deffn {Dato} winsound.MB_OK

Reproduce el sonido @code{SystemDefault}.
@end deffn

@node Servicios específicos de Unix,Modules command-line interface CLI,Servicios Específicos para MS Windows,La biblioteca estándar de Python
@anchor{library/unix doc}@anchor{4705}@anchor{library/unix unix}@anchor{4706}@anchor{library/unix unix-specific-services}@anchor{4707}
@section Servicios específicos de Unix


Los módulos descritos en este capítulo proporcionan interfaces para las características exclusivas del sistema operativo Unix o, en algunos casos, para algunas o muchas variantes del mismo.  He aquí una visión general:

@menu
* posix — The most common POSIX system calls:: 
* pwd — The password database:: 
* grp — The group database:: 
* termios — POSIX style tty control:: 
* tty — Terminal control functions:: 
* pty — Pseudo-terminal utilities:: 
* fcntl — The fcntl and ioctl system calls:: 
* resource — Resource usage information:: 
* syslog — Unix syslog library routines:: 

@end menu

@node posix — The most common POSIX system calls,pwd — The password database,,Servicios específicos de Unix
@anchor{library/posix doc}@anchor{4708}@anchor{library/posix module-posix}@anchor{ad}@anchor{library/posix posix-the-most-common-posix-system-calls}@anchor{4709}
@subsection @code{posix} — The most common POSIX system calls


@geindex module; posix


__________________________________________________________________


Este módulo proporciona acceso a la funcionalidad del sistema operativo que está estandarizada por el estándar C y el estándar POSIX (una interfaz Unix finamente disfrazada).

@ref{1d5a,,Availability}: Unix.

@geindex module;os

`No importe este módulo directamente.' En su lugar, importe el módulo @ref{a1,,os}, que proporciona una versión `portable' de esta interfaz.  En Unix, el módulo @ref{a1,,os} proporciona un superconjunto de la interfaz @ref{ad,,posix}.  En sistemas operativos que no son Unix, el módulo @ref{ad,,posix} no está disponible, pero un subconjunto siempre está disponible a través de la interfaz @ref{a1,,os}.  Una vez que se importa @ref{a1,,os}, `no' hay penalización de rendimiento en su uso en lugar de @ref{ad,,posix}.  Además, @ref{a1,,os} proporciona algunas funciones adicionales, como llamar automáticamente a @ref{198,,putenv()} cuando se cambia una entrada en @code{os.environ}.

Los errores se notifican como excepciones; las excepciones habituales se proporcionan para los errores de tipo, mientras que los errores notificados por las llamadas del sistema lanzan @ref{4d5,,OSError}.

@menu
* Soporte de archivos grandes:: 
* Contenido notable del módulo:: 

@end menu

@node Soporte de archivos grandes,Contenido notable del módulo,,posix — The most common POSIX system calls
@anchor{library/posix large-file-support}@anchor{470a}@anchor{library/posix posix-large-files}@anchor{470b}
@subsubsection Soporte de archivos grandes


@geindex large files
@geindex file;large files

Several operating systems (including AIX and Solaris) provide
support for files that are larger than 2 GiB from a C programming model where
int and long are 32-bit values. This is typically accomplished
by defining the relevant size and offset types as 64-bit values. Such files are
sometimes referred to as `large files'.

Large file support is enabled in Python when the size of an @code{off_t} is
larger than a long and the long long is at least as large
as an @code{off_t}.
It may be necessary to configure and compile Python with certain compiler flags
to enable this mode. For example, with Solaris 2.6 and 2.7 you need to do
something like:

@example
CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

En sistemas Linux con capacidad para archivos grandes, esto podría funcionar:

@example
CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

@node Contenido notable del módulo,,Soporte de archivos grandes,posix — The most common POSIX system calls
@anchor{library/posix notable-module-contents}@anchor{470c}@anchor{library/posix posix-contents}@anchor{470d}
@subsubsection Contenido notable del módulo


Además de muchas funciones descritas en la documentación del módulo @ref{a1,,os}, @ref{ad,,posix} define el siguiente elemento de datos:

@geindex environ (en el módulo posix)
@anchor{library/posix posix environ}@anchor{470e}
@deffn {Dato} posix.environ

Diccionario que representa el entorno de cadena en el momento en que se inició el intérprete. Las claves y los valores son bytes en Unix y str en Windows. Por ejemplo, @code{environ[b'HOME']} (@code{environ['HOME']} en Windows) es el nombre de ruta de acceso de su directorio principal, equivalente a @code{getenv("HOME")} en C.

La modificación de este diccionario no afecta al entorno de cadena que transmite @ref{2b1d,,execv()}, @ref{1c5,,popen()} o @ref{149a,,system()}; si necesita cambiar el entorno, pase @code{environ} a @ref{116b,,execve()} o agregue asignaciones variables y declaraciones de exportación a la cadena de comandos para @ref{149a,,system()} o @ref{1c5,,popen()}.


Distinto en la versión 3.2: En Unix, las claves y los valores son bytes.


@cartouche
@quotation Nota 
El módulo @ref{a1,,os} proporciona una implementación alternativa de @code{environ} que actualiza el entorno en la modificación. Tenga en cuenta también que la actualización @ref{196,,os.environ} hará que este diccionario sea obsoleto. El uso de la versión del módulo @ref{a1,,os} de esto se recomienda sobre el acceso directo al módulo @ref{ad,,posix}.
@end quotation
@end cartouche
@end deffn

@node pwd — The password database,grp — The group database,posix — The most common POSIX system calls,Servicios específicos de Unix
@anchor{library/pwd doc}@anchor{470f}@anchor{library/pwd module-pwd}@anchor{b2}@anchor{library/pwd pwd-the-password-database}@anchor{4710}
@subsection @code{pwd} — The password database


@geindex module; pwd


__________________________________________________________________


Este módulo proporciona acceso a la base de datos de cuentas de usuario y contraseñas de Unix.  Está disponible en todas las versiones de Unix.

@ref{1d5a,,Availability}: Unix, not WASI, not iOS.

Las entradas de la base de datos de contraseñas se reportan como un objeto de tipo tupla, cuyos atributos corresponden a los miembros de la estructura @code{passwd} (campo Atributo abajo, ver @code{<pwd.h>}):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Atributo

@tab

Significado

@item

0

@tab

@code{pw_name}

@tab

Nombre de usuario

@item

1

@tab

@code{pw_passwd}

@tab

Contraseña encriptada opcional

@item

2

@tab

@code{pw_uid}

@tab

Identificación numérica de usuario

@item

3

@tab

@code{pw_gid}

@tab

Identificación del grupo numérico

@item

4

@tab

@code{pw_gecos}

@tab

Nombre de usuario o campo de comentarios

@item

5

@tab

@code{pw_dir}

@tab

El directorio `home' del usuario

@item

6

@tab

@code{pw_shell}

@tab

Intérprete de comandos de usuario

@end multitable


Los elementos uid y gid son enteros, todos los demás son cadenas. @ref{438,,KeyError} se lanza si la entrada pedida no se encuentra.

@cartouche
@quotation Nota 
In traditional Unix the field @code{pw_passwd} usually contains a password
encrypted with a DES derived algorithm.  However most
modern unices  use a so-called `shadow password' system.  On those unices the
`pw_passwd' field only contains an asterisk (@code{'*'}) or the  letter @code{'x'}
where the encrypted password is stored in a file @code{/etc/shadow} which is
not world readable.  Whether the `pw_passwd' field contains anything useful is
system-dependent.
@end quotation
@end cartouche

Define los siguientes elementos:

@geindex getpwuid() (en el módulo pwd)
@anchor{library/pwd pwd getpwuid}@anchor{1a37}
@deffn {Función} pwd.getpwuid (uid)

Retorna la entrada de la base de datos de contraseñas para el ID de usuario numérico dado.
@end deffn

@geindex getpwnam() (en el módulo pwd)
@anchor{library/pwd pwd getpwnam}@anchor{3156}
@deffn {Función} pwd.getpwnam (name)

Retorna la entrada de la base de datos de contraseñas para el nombre de usuario dado.
@end deffn

@geindex getpwall() (en el módulo pwd)
@anchor{library/pwd pwd getpwall}@anchor{4711}
@deffn {Función} pwd.getpwall ()

Retorna una lista de todas las entradas de la base de datos de contraseñas disponibles, en orden arbitrario.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{66,,grp}

Una interfaz para la base de datos de grupos, similar a esta.
@end table


@node grp — The group database,termios — POSIX style tty control,pwd — The password database,Servicios específicos de Unix
@anchor{library/grp doc}@anchor{4712}@anchor{library/grp grp-the-group-database}@anchor{4713}@anchor{library/grp module-grp}@anchor{66}
@subsection @code{grp} — The group database


@geindex module; grp


__________________________________________________________________


Este módulo proporciona acceso a la base de datos del grupo Unix. Está disponible en todas las versiones de Unix.

@ref{1d5a,,Availability}: Unix, not WASI, not Android, not iOS.

Las entradas de base de datos de grupo se notifican como un objeto similar a una tupla, cuyos atributos corresponden a los miembros de la estructura @code{group} (campo atributo a continuación, véase @code{<grp.h>}):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Atributo

@tab

Significado

@item

0

@tab

gr_name

@tab

el nombre del grupo

@item

1

@tab

gr_passwd

@tab

la contraseña (encriptada) del grupo; usualmente vacío

@item

2

@tab

gr_gid

@tab

el grupo ID numérico

@item

3

@tab

gr_mem

@tab

todos los nombres de usuario de los miembros del grupo

@end multitable


El `gid' es un número entero, el nombre y la contraseña son cadenas y la lista de miembros es una lista de cadenas. (Tenga en cuenta que la mayoría de los usuarios no se enumeran explícitamente como miembros del grupo en el que se encuentran de acuerdo con la base de datos de contraseñas. Consulte ambas bases de datos para obtener información completa sobre la membresía. También tenga en cuenta que un ‘’gr_name’’ que comienza con un @code{+} o @code{-} es probable que sea una referencia de YP/NIS y puede que no sea accesible vía @ref{3155,,getgrnam()} o @ref{dad,,getgrgid()}.)

Define los siguientes elementos:

@geindex getgrgid() (en el módulo grp)
@anchor{library/grp grp getgrgid}@anchor{dad}
@deffn {Función} grp.getgrgid (id)

Retorna la entrada de la base de datos del grupo para el ID de grupo numérico dado. Se genera @ref{438,,KeyError} si no se puede encontrar la entrada solicitada.


Distinto en la versión 3.10: @ref{228,,TypeError} se genera para argumentos no enteros como flotantes o cadenas de caracteres.

@end deffn

@geindex getgrnam() (en el módulo grp)
@anchor{library/grp grp getgrnam}@anchor{3155}
@deffn {Función} grp.getgrnam (name)

Retorna la entrada de la base de datos del grupo para el nombre de grupo dado. Se genera @ref{438,,KeyError} si no se puede encontrar la entrada solicitada.
@end deffn

@geindex getgrall() (en el módulo grp)
@anchor{library/grp grp getgrall}@anchor{4714}
@deffn {Función} grp.getgrall ()

Retorna una lista de todas las entradas de grupo disponibles, en orden arbitrario.
@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{b2,,pwd}

Una interfaz para la base de datos de usuarios, similar a esta.
@end table


@node termios — POSIX style tty control,tty — Terminal control functions,grp — The group database,Servicios específicos de Unix
@anchor{library/termios doc}@anchor{4715}@anchor{library/termios module-termios}@anchor{e1}@anchor{library/termios termios-posix-style-tty-control}@anchor{4716}
@subsection @code{termios} — POSIX style tty control


@geindex module; termios

@geindex POSIX;I/O control
@geindex tty;I/O control


__________________________________________________________________


Este módulo proporciona una interfaz para las llamadas POSIX para el control de E/S (entrada/salida) tty. Para obtener una descripción completa de estas llamadas, consulte @code{termios (3)@footnote{https://manpages.debian.org/termios (3)}} Página de manual de Unix. Solo está disponible para aquellas versiones de Unix que admitan el control de E/S tty estilo POSIX `termios' configurado durante la instalación.

@ref{1d5a,,Availability}: Unix.

Todas las funciones de este módulo toman un descriptor de archivo `fd' como primer argumento. Puede ser un descriptor de archivo entero, como el que retorna @code{sys.stdin.fileno()}, o un @ref{1230,,file object}, como el propio @code{sys.stdin}.

Este módulo también define todas las constantes necesarias para trabajar con las funciones proporcionadas aquí; tienen el mismo nombre que sus contrapartes en C. Consulte la documentación de su sistema para obtener más información sobre el uso de estas interfaces de control de terminal.

El módulo define las siguientes funciones:

@geindex tcgetattr() (en el módulo termios)
@anchor{library/termios termios tcgetattr}@anchor{1681}
@deffn {Función} termios.tcgetattr (fd)

Retorna una lista que contiene los atributos tty para el descriptor de archivo `fd', como se muestra a continuación: @code{[iflag, oflag, cflag, lflag, ispeed, ospeed, cc]} donde `cc' es una lista de los caracteres especiales tty (cada una es una cadena de longitud 1, excepto los elementos con índices @code{VMIN} and @code{VTIME}, que son números enteros cuando se definen estos campos). La interpretación de las banderas y las velocidades, así como la indexación en el arreglo `cc', debe realizarse utilizando las constantes simbólicas definidas en el módulo  @ref{e1,,termios} .
@end deffn

@geindex tcsetattr() (en el módulo termios)
@anchor{library/termios termios tcsetattr}@anchor{16fe}
@deffn {Función} termios.tcsetattr (fd, when, attributes)

Set the tty attributes for file descriptor `fd' from the `attributes', which is
a list like the one returned by @ref{1681,,tcgetattr()}.  The `when' argument
determines when the attributes are changed:

@geindex TCSANOW (en el módulo termios)
@anchor{library/termios termios TCSANOW}@anchor{4717}
@deffn {Dato} termios.TCSANOW

Change attributes immediately.
@end deffn

@geindex TCSADRAIN (en el módulo termios)
@anchor{library/termios termios TCSADRAIN}@anchor{4718}
@deffn {Dato} termios.TCSADRAIN

Change attributes after transmitting all queued output.
@end deffn

@geindex TCSAFLUSH (en el módulo termios)
@anchor{library/termios termios TCSAFLUSH}@anchor{4719}
@deffn {Dato} termios.TCSAFLUSH

Change attributes after transmitting all queued output and
discarding all queued input.
@end deffn
@end deffn

@geindex tcsendbreak() (en el módulo termios)
@anchor{library/termios termios tcsendbreak}@anchor{471a}
@deffn {Función} termios.tcsendbreak (fd, duration)

Envíe una pausa en el descriptor de archivo `fd'. Una `duración' cero envía una pausa de 0.25 a 0.5 segundos;  una `duración' distinta de cero tiene un significado dependiente del sistema.
@end deffn

@geindex tcdrain() (en el módulo termios)
@anchor{library/termios termios tcdrain}@anchor{471b}
@deffn {Función} termios.tcdrain (fd)

Espere hasta que se haya transmitido toda la salida escrita en el descriptor de archivo `fd'.
@end deffn

@geindex tcflush() (en el módulo termios)
@anchor{library/termios termios tcflush}@anchor{471c}
@deffn {Función} termios.tcflush (fd, queue)

Descartar datos en cola en el descriptor de archivo `fd'. El selector `queue' especifica qué cola: @code{TCIFLUSH} para la cola de entrada, @code{TCOFLUSH} para la cola de salida, o @code{TCIOFLUSH} para ambas colas.
@end deffn

@geindex tcflow() (en el módulo termios)
@anchor{library/termios termios tcflow}@anchor{471d}
@deffn {Función} termios.tcflow (fd, action)

Suspender o reanudar la entrada o salida en el descriptor de archivo `fd'. El argumento `action' puede ser  @code{TCOOFF} para suspender la salida, @code{TCOON} para reiniciar la salida, @code{TCIOFF} para suspender la entrada, o @code{TCION} para reiniciar la entrada.
@end deffn

@geindex tcgetwinsize() (en el módulo termios)
@anchor{library/termios termios tcgetwinsize}@anchor{471e}
@deffn {Función} termios.tcgetwinsize (fd)

Devuelve una tupla @code{(ws_row, ws_col)} que contiene el tamaño de la ventana tty para el descriptor de archivo `fd'. Requiere @code{termios.TIOCGWINSZ} o @code{termios.TIOCGSIZE}.


Added in version 3.11.

@end deffn

@geindex tcsetwinsize() (en el módulo termios)
@anchor{library/termios termios tcsetwinsize}@anchor{471f}
@deffn {Función} termios.tcsetwinsize (fd, winsize)

Establezca el tamaño de la ventana tty para el descriptor de archivo `fd' de `winsize', que es un tupla de dos elementos @code{(ws_row, ws_col)} como la devuelta por @ref{471e,,tcgetwinsize()}. Requiere que al menos uno de los pares (@code{termios.TIOCGWINSZ}, @code{termios.TIOCSWINSZ}); (@code{termios.TIOCGSIZE}, @code{termios.TIOCSSIZE}) por definir.


Added in version 3.11.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{100,,tty}

Funciones de conveniencia para operaciones comunes de control de terminal.
@end table


@menu
* Ejemplo: Ejemplo<14>. 

@end menu

@node Ejemplo<14>,,,termios — POSIX style tty control
@anchor{library/termios example}@anchor{4720}@anchor{library/termios termios-example}@anchor{4721}
@subsubsection Ejemplo


Aquí hay una función que solicita una contraseña con el eco desactivado. Tenga en cuenta la técnica utilizando una llamada separada  @ref{1681,,tcgetattr()} y una sentencia @ref{789,,try} … @ref{a5c,,finally}  para asegurarse de que los antiguos atributos tty se restauran exactamente sin importar lo que suceda:

@example
def getpass(prompt="Password: "):
    import termios, sys
    fd = sys.stdin.fileno()
    old = termios.tcgetattr(fd)
    new = termios.tcgetattr(fd)
    new[3] = new[3] & ~termios.ECHO          # lflags
    try:
        termios.tcsetattr(fd, termios.TCSADRAIN, new)
        passwd = input(prompt)
    finally:
        termios.tcsetattr(fd, termios.TCSADRAIN, old)
    return passwd
@end example

@node tty — Terminal control functions,pty — Pseudo-terminal utilities,termios — POSIX style tty control,Servicios específicos de Unix
@anchor{library/tty doc}@anchor{4722}@anchor{library/tty module-tty}@anchor{100}@anchor{library/tty tty-terminal-control-functions}@anchor{4723}
@subsection @code{tty} — Terminal control functions


@geindex module; tty

`Código fuente:' Lib/tty.py@footnote{https://github.com/python/cpython/tree/main/Lib/tty.py}


__________________________________________________________________


El módulo @ref{100,,tty} define funciones para poner la tty en los modos `cbreak' y `raw'.

@ref{1d5a,,Availability}: Unix.

Dado que requiere el módulo @ref{e1,,termios}, solamente funciona en Unix.

El módulo @ref{100,,tty} define las siguientes funciones:

@geindex cfmakeraw() (en el módulo tty)
@anchor{library/tty tty cfmakeraw}@anchor{16d6}
@deffn {Función} tty.cfmakeraw (mode)

Convert the tty attribute list `mode', which is a list like the one returned
by @ref{1681,,termios.tcgetattr()}, to that of a tty in raw mode.


Added in version 3.12.

@end deffn

@geindex cfmakecbreak() (en el módulo tty)
@anchor{library/tty tty cfmakecbreak}@anchor{1684}
@deffn {Función} tty.cfmakecbreak (mode)

Convert the tty attribute list `mode', which is a list like the one returned
by @ref{1681,,termios.tcgetattr()}, to that of a tty in cbreak mode.

This clears the @code{ECHO} and @code{ICANON} local mode flags in `mode' as well
as setting the minimum input to 1 byte with no delay.


Added in version 3.12.



Distinto en la versión 3.12.2: The @code{ICRNL} flag is no longer cleared. This matches Linux and macOS
@code{stty cbreak} behavior and what @ref{1683,,setcbreak()} historically did.

@end deffn

@geindex setraw() (en el módulo tty)
@anchor{library/tty tty setraw}@anchor{16d5}
@deffn {Función} tty.setraw (fd, when=termios.TCSAFLUSH)

Change the mode of the file descriptor `fd' to raw. If `when' is omitted, it
defaults to @ref{4719,,termios.TCSAFLUSH}, and is passed to
@ref{16fe,,termios.tcsetattr()}. The return value of @ref{1681,,termios.tcgetattr()}
is saved before setting `fd' to raw mode; this value is returned.


Distinto en la versión 3.12: The return value is now the original tty attributes, instead of @code{None}.

@end deffn

@geindex setcbreak() (en el módulo tty)
@anchor{library/tty tty setcbreak}@anchor{1683}
@deffn {Función} tty.setcbreak (fd, when=termios.TCSAFLUSH)

Change the mode of file descriptor `fd' to cbreak. If `when' is omitted, it
defaults to @ref{4719,,termios.TCSAFLUSH}, and is passed to
@ref{16fe,,termios.tcsetattr()}. The return value of @ref{1681,,termios.tcgetattr()}
is saved before setting `fd' to cbreak mode; this value is returned.

This clears the @code{ECHO} and @code{ICANON} local mode flags as well as setting
the minimum input to 1 byte with no delay.


Distinto en la versión 3.12: The return value is now the original tty attributes, instead of @code{None}.



Distinto en la versión 3.12.2: The @code{ICRNL} flag is no longer cleared. This restores the behavior
of Python 3.11 and earlier as well as matching what Linux, macOS, & BSDs
describe in their @code{stty(1)} man pages regarding cbreak mode.

@end deffn


@subsubheading Ver también



@table @asis

@item Módulo @ref{e1,,termios}

Interfaz de control de la terminal de bajo nivel.
@end table


@node pty — Pseudo-terminal utilities,fcntl — The fcntl and ioctl system calls,tty — Terminal control functions,Servicios específicos de Unix
@anchor{library/pty doc}@anchor{4724}@anchor{library/pty module-pty}@anchor{b1}@anchor{library/pty pty-pseudo-terminal-utilities}@anchor{4725}
@subsection @code{pty} — Pseudo-terminal utilities


@geindex module; pty

`Código Fuente:' Lib/pty.py@footnote{https://github.com/python/cpython/tree/main/Lib/pty.py}


__________________________________________________________________


El módulo @ref{b1,,pty} define las operaciones para manejar el concepto de pseudo-terminal: iniciar otro proceso para poder escribir y leer desde su propia terminal mediante programación.

@ref{1d5a,,Availability}: Unix.

El manejo de pseudo-terminales depende en gran medida de la plataforma. Este código se prueba principalmente en Linux, FreeBSD y macOS (se supone que funciona en otras plataformas POSIX, pero no se ha probado a fondo).

El modulo @ref{b1,,pty} define las siguientes funciones:

@geindex fork() (en el módulo pty)
@anchor{library/pty pty fork}@anchor{1760}
@deffn {Función} pty.fork ()

Bifurcación. Conectar en su propia terminal (terminal hijo) una pseudo-terminal. El valor de retorno es @code{(pid, fd)}. Tener en cuenta que la terminal hijo tiene como valor `pid' 0 y `fd' es `invalid'. El valor de retorno del padre es el `pid' del hijo, y `fd' es un descriptor de archivo conectado a la terminal hijo (también a la salida y entrada estándar de la terminal hijo)

@cartouche
@quotation Advertencia 
On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using @ref{10b,,urllib.request}.
@end quotation
@end cartouche
@end deffn

@geindex openpty() (en el módulo pty)
@anchor{library/pty pty openpty}@anchor{221}
@deffn {Función} pty.openpty ()

Abre un nuevo par de pseudo-terminales, usando @ref{2b5f,,os.openpty()}, o código de emulación para sistemas genéricos de Unix. Retorna un par de descriptores de archivo @code{(master, slave)}, para el `master' y el `slave' respectivamente.
@end deffn

@geindex spawn() (en el módulo pty)
@anchor{library/pty pty spawn}@anchor{1001}
@deffn {Función} pty.spawn (argv[, master_read[, stdin_read]])

Genera un proceso conectado a su terminal con el io estándar del proceso actual. Esto se usa a frecuentemente para confundir programas que insisten en leer desde la terminal de control. Se espera que el proceso generado detrás de pty sea finalizado y cuando lo haga `spawn' se retornará.

Un bucle copia STDIN del proceso actual al hijo y los datos recibidos del niño a STDOUT del proceso actual. No se le indica al hijo si STDIN del proceso actual se cierra.

A las funciones `master_read' y `stdin_read' se les pasa un descriptor de archivo del cual deben leer, y siempre deben retornar una cadena de bytes. Para forzar el retorno de spawn antes de que el proceso hijo salga, se debe retornar un arreglo de bytes vacía para señalar el final del archivo.

La implementación predeterminada para ambas funciones retornará hasta 1024 bytes cada vez que se llamen. El dato retornado de `master_read' se pasa al descriptor de archivo maestro para leer la salida del proceso hijo, y `stdin_read' pasa el descriptor de archivo 0, para leer desde la entrada del proceso padre.

Retornando una cadena de bytes vacía de cualquier llamado es interpretado como una condición de fin de archivo (EOF), y el llamado no se realizará después de eso. Si `stdin_read' retorna EOF la terminal de control ya no puede comunicarse con el proceso padre o el proceso hijo. A menos que el proceso hijo se cierre sin ninguna entrada `spawn' se repetirá para siempre. Si `master_read' retorna EOF se produce el mismo comportamiento (al menos en Linux)

Retorna el valor del estado de salida de @ref{e20,,os.waitpid()} en el proceso hijo.

@ref{9b1,,os.waitstatus_to_exitcode()} se puede utilizar para convertir el estado de salida en un código de salida.

Lanza un @ref{18c3,,evento de auditoria} @code{pty.spawn}  con el argumento @code{argv}.


Distinto en la versión 3.4: @ref{1001,,spawn()} ahora retorna el valor de estado de  @ref{e20,,os.waitpid()} para los procesos hijos.

@end deffn

@menu
* Ejemplo: Ejemplo<15>. 

@end menu

@node Ejemplo<15>,,,pty — Pseudo-terminal utilities
@anchor{library/pty example}@anchor{4726}
@subsubsection Ejemplo


El siguiente programa actúa como el comando de Unix @code{script(1)@footnote{https://manpages.debian.org/script(1)}}, usando una pseudo-terminal para registrar todas las entradas y salidas de una sesión en «typescript».

@example
import argparse
import os
import pty
import sys
import time

parser = argparse.ArgumentParser()
parser.add_argument('-a', dest='append', action='store_true')
parser.add_argument('-p', dest='use_python', action='store_true')
parser.add_argument('filename', nargs='?', default='typescript')
options = parser.parse_args()

shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh')
filename = options.filename
mode = 'ab' if options.append else 'wb'

with open(filename, mode) as script:
    def read(fd):
        data = os.read(fd, 1024)
        script.write(data)
        return data

    print('Script started, file is', filename)
    script.write(('Script started on %s\n' % time.asctime()).encode())

    pty.spawn(shell, read)

    script.write(('Script done on %s\n' % time.asctime()).encode())
    print('Script done, file is', filename)
@end example

@node fcntl — The fcntl and ioctl system calls,resource — Resource usage information,pty — Pseudo-terminal utilities,Servicios específicos de Unix
@anchor{library/fcntl doc}@anchor{4727}@anchor{library/fcntl fcntl-the-fcntl-and-ioctl-system-calls}@anchor{4728}@anchor{library/fcntl module-fcntl}@anchor{59}
@subsection @code{fcntl} — The @code{fcntl} and @code{ioctl} system calls


@geindex module; fcntl

@geindex UNIX;file control
@geindex UNIX;I/O control


__________________________________________________________________


This module performs file and I/O control on file descriptors. It is an
interface to the @code{fcntl()} and @code{ioctl()} Unix routines.
See the @code{fcntl(2)@footnote{https://manpages.debian.org/fcntl(2)}} and @code{ioctl(2)@footnote{https://manpages.debian.org/ioctl(2)}} Unix manual pages
for full details.

@ref{1d5a,,Availability}: Unix, not WASI.

Todas las funciones de este módulo toman un descriptor de fichero `fd' como su primer argumento.  Puede ser un descriptor de fichero entero, como el retornado por @code{sys.stdin.fileno()}, o un objeto @ref{353,,io.IOBase}, como @code{sys.stdin}, que proporciona un @ref{2848,,fileno()} que retorna un descriptor de fichero original.


Distinto en la versión 3.3: Las operaciones en este módulo solían lanzar un @ref{10ce,,IOError} donde ahora lanzan un @ref{4d5,,OSError}.



Distinto en la versión 3.8: The @code{fcntl} module now contains @code{F_ADD_SEALS}, @code{F_GET_SEALS}, and
@code{F_SEAL_*} constants for sealing of @ref{a9d,,os.memfd_create()} file
descriptors.



Distinto en la versión 3.9: On macOS, the @code{fcntl} module exposes the @code{F_GETPATH} constant,
which obtains the path of a file from a file descriptor.
On Linux(>=3.15), the @code{fcntl} module exposes the @code{F_OFD_GETLK},
@code{F_OFD_SETLK} and @code{F_OFD_SETLKW} constants, which are used when working
with open file description locks.



Distinto en la versión 3.10: On Linux >= 2.6.11, the @code{fcntl} module exposes the @code{F_GETPIPE_SZ} and
@code{F_SETPIPE_SZ} constants, which allow to check and modify a pipe’s size
respectively.



Distinto en la versión 3.11: On FreeBSD, the @code{fcntl} module exposes the @code{F_DUP2FD} and
@code{F_DUP2FD_CLOEXEC} constants, which allow to duplicate a file descriptor,
the latter setting @code{FD_CLOEXEC} flag in addition.



Distinto en la versión 3.12: En Linux >= 4.5, el módulo @ref{59,,fcntl} expone las constantes @code{FICLONE} y @code{FICLONERANGE}, que permiten compartir algunos datos de un fichero con otro fichero mediante el `reflinking' en algunos sistemas de ficheros (por ejemplo, btrfs, OCFS2 y XFS). Este comportamiento se conoce comúnmente como «copy-on-write».



Distinto en la versión 3.13: On Linux >= 2.6.32, the @code{fcntl} module exposes the
@code{F_GETOWN_EX}, @code{F_SETOWN_EX}, @code{F_OWNER_TID}, @code{F_OWNER_PID}, @code{F_OWNER_PGRP} constants, which allow to direct I/O availability signals
to a specific thread, process, or process group.
On Linux >= 4.13, the @code{fcntl} module exposes the
@code{F_GET_RW_HINT}, @code{F_SET_RW_HINT}, @code{F_GET_FILE_RW_HINT},
@code{F_SET_FILE_RW_HINT}, and @code{RWH_WRITE_LIFE_*} constants, which allow
to inform the kernel about the relative expected lifetime of writes on
a given inode or via a particular open file description.
On Linux >= 5.1 and NetBSD, the @code{fcntl} module exposes the
@code{F_SEAL_FUTURE_WRITE} constant for use with @code{F_ADD_SEALS} and
@code{F_GET_SEALS} operations.
On FreeBSD, the @code{fcntl} module exposes the @code{F_READAHEAD}, @code{F_ISUNIONSTACK}, and @code{F_KINFO} constants.
On macOS and FreeBSD, the @code{fcntl} module exposes the @code{F_RDAHEAD}
constant.
On NetBSD and AIX, the @code{fcntl} module exposes the @code{F_CLOSEM}
constant.
On NetBSD, the @code{fcntl} module exposes the @code{F_MAXFD} constant.
On macOS and NetBSD, the @code{fcntl} module exposes the @code{F_GETNOSIGPIPE}
and @code{F_SETNOSIGPIPE} constant.


El módulo define las siguientes funciones:

@geindex fcntl() (en el módulo fcntl)
@anchor{library/fcntl fcntl fcntl}@anchor{338c}
@deffn {Función} fcntl.fcntl (fd, cmd, arg=0)

Realiza la operación `cmd' en el descriptor de fichero `fd' (también se aceptan objetos de fichero que proporcionen un método @ref{2848,,fileno()}). Los valores utilizados para `cmd' dependen del sistema operativo y están disponibles como constantes en el módulo @ref{59,,fcntl}, utilizando los mismos nombres que se utilizan en los archivos de cabecera C relevantes. El argumento `arg' puede ser un valor entero o un objeto @ref{325,,bytes}. Con un valor entero, el valor retornado en esta función es el valor entero retornado por la llamada en C @code{fcntl()} . Cuando el argumento son bytes representa una estructura binaria, e.g. creada por @ref{12e4,,struct.pack()}. Los datos binarios se copian en un búfer cuya dirección se pasa a la llamada en C :@code{fcntl()}. El valor retornado después de una llamada correcta es el contenido del búfer, convertido en un objeto @ref{325,,bytes}. La longitud del objeto retornado será la misma que la longitud del argumento `arg'. Esta longitud está limitada a 1024 bytes. Si la información retornada en el búfer por el sistema operativo es mayor que 1024 bytes, lo más probable es que se produzca una violación de segmento o a una corrupción de datos más sutil.

If the @code{fcntl()} call fails, an @ref{4d5,,OSError} is raised.

Lanza un @ref{18c3,,evento de auditoria} @code{fcntl.fcntl} con argumentos @code{fd}, @code{cmd}, @code{arg}.
@end deffn

@geindex ioctl() (en el módulo fcntl)
@anchor{library/fcntl fcntl ioctl}@anchor{14b6}
@deffn {Función} fcntl.ioctl (fd, request, arg=0, mutate_flag=True)

Esta función es idéntica a la función @ref{338c,,fcntl()}, excepto por el manejo de los argumentos que es aún más complicado.

El parámetro `request' se encuentra limitado a valores que encajen en 32-bits. Se pueden encontrar constantes adicionales de interés para usar como argumento `request' en el módulo @ref{e1,,termios}, con los mismos nombres que se usan en los archivos de cabecera C correspondientes.

El parámetro `arg' puede ser un entero, un objeto que admita una interfaz de búfer de solo lectura (como @ref{325,,bytes}) o un objeto que admita una interfaz de búfer de lectura-escritura (como: clase @ref{5e0,,bytearray}).

En todos los casos, excepto en el último, el comportamiento es el mismo que para la función @ref{338c,,fcntl()}.

Si se pasa un búfer mutable, el comportamiento estará determinado por el valor del parámetro `mutate_flag'.

Si es falso, la mutabilidad del búfer se ignorará y el comportamiento será como el de un búfer de solo lectura, excepto por el límite de 1024 bytes mencionado arriba, que será evitado – siempre que el búfer que pase sea al menos tan largo como el sistema operativo quiera colocar allí, las cosas deberían funcionar.

Si `mutate_flag' es verdadero (valor predeterminado), entonces el búfer se pasa (en efecto) a la llamada al sistema subyacente @ref{14b6,,ioctl()}, el código de retorno de este último retorna una llamada Python, y el nuevo contenido del búfer refleja la acción de @ref{14b6,,ioctl()}. Esto es una ligera simplificación, porque si el búfer proporcionado tiene menos de 1024 bytes de longitud, primero se copia en un búfer estático de 1024 bytes de longitud que luego se pasa a @ref{14b6,,ioctl()} y se copia de nuevo en el búfer proporcionado.

If the @code{ioctl()} call fails, an @ref{4d5,,OSError} exception is raised.

Un ejemplo:

@example
>>> import array, fcntl, struct, termios, os
>>> os.getpgrp()
13341
>>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]
13341
>>> buf = array.array('h', [0])
>>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)
0
>>> buf
array('h', [13341])
@end example

Lanza un @ref{18c3,,evento de auditoria} @code{fcntl.ioctl} con argumentos @code{fd}, @code{request}, @code{arg}.
@end deffn

@geindex flock() (en el módulo fcntl)
@anchor{library/fcntl fcntl flock}@anchor{410c}
@deffn {Función} fcntl.flock (fd, operation)

Realiza la operación de bloqueo `operation' sobre el descriptor de fichero `fd' (también se aceptan objetos de fichero que proporcionen un método @ref{2848,,fileno()}). Ver el manual de Unix @code{flock(2)@footnote{https://manpages.debian.org/flock(2)}} para más detalles. (En algunos sistemas, esta función es emulada usando @code{fcntl()}.)

If the @code{flock()} call fails, an @ref{4d5,,OSError} exception is raised.

Lanza un @ref{18c3,,evento de auditoria} @code{fcntl.flock} con argumentos @code{fd}, @code{operation}.
@end deffn

@geindex lockf() (en el módulo fcntl)
@anchor{library/fcntl fcntl lockf}@anchor{142c}
@deffn {Función} fcntl.lockf (fd, cmd, len=0, start=0, whence=0)

Esto es esencialmente un «wrapper» de las llamadas de bloqueo @ref{338c,,fcntl()}. `fd' es el descriptor de fichero (también se aceptan objetos de fichero que proporcionen un método @ref{2848,,fileno()}) del archivo para bloquear o desbloquear, y `cmd' es uno de los siguientes valores:

@geindex LOCK_UN (en el módulo fcntl)
@anchor{library/fcntl fcntl LOCK_UN}@anchor{4729}
@deffn {Dato} fcntl.LOCK_UN

Release an existing lock.
@end deffn

@geindex LOCK_SH (en el módulo fcntl)
@anchor{library/fcntl fcntl LOCK_SH}@anchor{472a}
@deffn {Dato} fcntl.LOCK_SH

Acquire a shared lock.
@end deffn

@geindex LOCK_EX (en el módulo fcntl)
@anchor{library/fcntl fcntl LOCK_EX}@anchor{472b}
@deffn {Dato} fcntl.LOCK_EX

Acquire an exclusive lock.
@end deffn

@geindex LOCK_NB (en el módulo fcntl)
@anchor{library/fcntl fcntl LOCK_NB}@anchor{472c}
@deffn {Dato} fcntl.LOCK_NB

Bitwise OR with any of the other three @code{LOCK_*} constants to make
the request non-blocking.
@end deffn

If @code{LOCK_NB} is used and the lock cannot be acquired, an
@ref{4d5,,OSError} will be raised and the exception will have an `errno'
attribute set to @ref{22b0,,EACCES} or @ref{22a1,,EAGAIN} (depending on the
operating system; for portability, check for both values).  On at least some
systems, @code{LOCK_EX} can only be used if the file descriptor refers to a
file opened for writing.

`len' es el número de bytes a bloquear, `start' es el desplazamiento de bytes en el que comienza el bloqueo, relativo a `whence', y `whence' es como con @ref{12f9,,io.IOBase.seek()}, específicamente:


@itemize *

@item 
@code{0} – relativo al inicio del archivo (@ref{12fa,,os.SEEK_SET})

@item 
@code{1} – relativo a la posición actual del buffer (@ref{12fb,,os.SEEK_CUR})

@item 
@code{2} – relativo al final del archivo (@ref{12fc,,os.SEEK_END})
@end itemize

El valor por defecto de*start* es 0, lo que significa que comienza al inicio del archivo. El valor por defecto para `len' es 0 lo que significa bloquear hasta el final del archivo. El valor por defecto para `whence' también es 0.

Lanza un @ref{18c3,,evento de auditoria} @code{fcntl.lockf} con argumentos @code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}.
@end deffn

Ejemplos (todos en un sistema compatible con SVR4):

@example
import struct, fcntl, os

f = open(...)
rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)

lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)
rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)
@end example

Tenga en cuenta que en el primer ejemplo, el valor de la variable retornada `rv' contendrá un valor entero; en el segundo ejemplo contendrá un objeto @ref{325,,bytes}. La estructura para la variable `lockdata' depende del sistema — por lo tanto, usar la llamada @ref{410c,,flock()} puede ser mejor.


@subsubheading Ver también



@table @asis

@item Módulo  @ref{a1,,os}

Si los indicadores de bloqueo @ref{146e,,O_SHLOCK} y @ref{146f,,O_EXLOCK} están presentes en el módulo @ref{a1,,os} (sólo en BSD), la función @ref{e18,,os.open()} proporciona una alternativa a las funciones @ref{142c,,lockf()} y @ref{410c,,flock()}.
@end table


@node resource — Resource usage information,syslog — Unix syslog library routines,fcntl — The fcntl and ioctl system calls,Servicios específicos de Unix
@anchor{library/resource doc}@anchor{472d}@anchor{library/resource module-resource}@anchor{bc}@anchor{library/resource resource-resource-usage-information}@anchor{472e}
@subsection @code{resource} — Resource usage information


@geindex module; resource


__________________________________________________________________


Este módulo proporciona mecanismos básicos para medir y controlar los recursos del sistema utilizados por un programa.

@ref{1d5a,,Availability}: Unix, not WASI.

Las constantes simbólicas se utilizan para especificar recursos concretos del sistema y para solicitar información de uso sobre el proceso actual o sus elementos secundarios.

Se genera un @ref{4d5,,OSError} cuando la llamada al sistema (`syscall') falla.

@geindex error
@anchor{library/resource resource error}@anchor{472f}
@deffn {Excepción} resource.error

Un alias en desuso de @ref{4d5,,OSError}.


Distinto en la versión 3.3: Tras 
@geindex Python Enhancement Proposals; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/} esta clase se convirtió en un alias de @ref{4d5,,OSError}.

@end deffn

@menu
* Límites de recursos:: 
* Utilización de recursos:: 

@end menu

@node Límites de recursos,Utilización de recursos,,resource — Resource usage information
@anchor{library/resource resource-limits}@anchor{4730}
@subsubsection Límites de recursos


El uso de recursos se puede limitar usando la función @ref{40af,,setrlimit()} que se describe a continuación. Cada recurso está controlado por un par de límites: un límite flexible y un límite duro. El límite flexible es el límite actual, y puede ser reducido o elevado con el tiempo mediante un proceso. El límite flexible nunca puede exceder el límite duro. El límite duro se puede reducir a cualquier valor mayor que el del límite flexible, pero no se puede elevar. (Solo los procesos con el UID efectivo del superusuario pueden aumentar un límite duro.)

Los recursos específicos que se pueden limitar dependen del sistema. Se describen en la página de manual @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}}. Los recursos enumerados a continuación se admiten cuando el sistema operativo subyacente los admite; los recursos que no pueden ser verificados o controlados por el sistema operativo no se definen en este módulo para esas plataformas.

@geindex RLIM_INFINITY (en el módulo resource)
@anchor{library/resource resource RLIM_INFINITY}@anchor{4731}
@deffn {Dato} resource.RLIM_INFINITY

Constante utilizada para representar el límite de un recurso ilimitado.
@end deffn

@geindex getrlimit() (en el módulo resource)
@anchor{library/resource resource getrlimit}@anchor{4732}
@deffn {Función} resource.getrlimit (resource)

Retorna una tupla @code{(soft, hard)} con los límites flexible y duro actuales de `resource'. Genera @ref{360,,ValueError} si se especifica un recurso no válido o @ref{472f,,error} si la llamada al sistema subyacente falla inesperadamente.
@end deffn

@geindex setrlimit() (en el módulo resource)
@anchor{library/resource resource setrlimit}@anchor{40af}
@deffn {Función} resource.setrlimit (resource, limits)

Establece nuevos límites para el consumo de `resource'. El argumento `limits' debe ser una tupla de dos enteros @code{(soft, hard)} que describe los nuevos límites. Un valor de @ref{4731,,RLIM_INFINITY} se puede utilizar para solicitar un límite ilimitado.

Genera @ref{360,,ValueError} si se especifica un recurso no válido, si el nuevo límite flexible excede el límite duro, o si un proceso intenta aumentar el límite duro. Si se especifica un límite de @ref{4731,,RLIM_INFINITY} cuando el límite duro o el límite del sistema para ese recurso no son ilimitados, se producirá un @ref{360,,ValueError}. Un proceso con el UID efectivo de superusuario puede solicitar cualquier valor de límite válido, incluso ilimitado, pero se lanzará un @ref{360,,ValueError} si el límite solicitado excede el límite impuesto por el sistema.

@code{setrlimit} también puede generar un @ref{472f,,error} si falla la llamada al sistema subyacente.

VxWorks solo admite configurar @ref{4733,,RLIMIT_NOFILE}.

Genera un @ref{18c3,,auditing event} @code{resource.setrlimit} con los argumentos @code{resource}, @code{limits}.
@end deffn

@geindex prlimit() (en el módulo resource)
@anchor{library/resource resource prlimit}@anchor{1008}
@deffn {Función} resource.prlimit (pid, resource[, limits])

Combina @ref{40af,,setrlimit()} y @ref{4732,,getrlimit()} en una sola función y admite obtener y establecer los límites de recursos de un proceso arbitrario. Si `pid' es 0, entonces la llamada se aplica al proceso actual. `resource' y `limits' tienen el mismo significado que en @ref{40af,,setrlimit()}, excepto por que `limits' es opcional.

Cuando no se proporciona `limits' la función retorna el límite de `resource' del proceso `pid'. Cuando se proporciona `limits', se establece el límite de `resource' del proceso y se retorna el límite de recursos anterior.

Genera @ref{10d7,,ProcessLookupError} cuando no se encuentra `pid' y @ref{dc9,,PermissionError} cuando el usuario no tiene @code{CAP_SYS_RESOURCE} para el proceso.

Genera un @ref{18c3,,evento de auditoría} @code{resource.prlimit} con los argumentos @code{pid}, @code{resource}, @code{limits}.

@ref{1d5a,,Availability}: Linux >= 2.6.36 with glibc >= 2.13.


Added in version 3.4.

@end deffn

Estos símbolos definen los recursos cuyo consumo se puede controlar usando las funciones @ref{40af,,setrlimit()} y @ref{4732,,getrlimit()} que se describen más abajo. Los valores de estos símbolos son exactamente las constantes utilizadas por programas en C.

La página de manual de Unix para @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}} detalla los recursos disponibles. Tenga en cuenta que no todos los sistemas usan el mismo símbolo o el mismo valor para referirse al mismo recurso. Este módulo no pretende enmascarar las diferencias entre plataformas — los símbolos no definidos para una plataforma no estarán disponibles en este módulo en esa plataforma.

@geindex RLIMIT_CORE (en el módulo resource)
@anchor{library/resource resource RLIMIT_CORE}@anchor{40b0}
@deffn {Dato} resource.RLIMIT_CORE

El tamaño máximo (en bytes) de un archivo central que puede crear el proceso actual. Esto podría resultar en la creación de un archivo central parcial si se requiriera uno más grande para contener la imagen del proceso entera.
@end deffn

@geindex RLIMIT_CPU (en el módulo resource)
@anchor{library/resource resource RLIMIT_CPU}@anchor{4734}
@deffn {Dato} resource.RLIMIT_CPU

La cantidad máxima de tiempo del procesador (en segundos) que puede utilizar un proceso. Si se excede este límite se envía una señal @code{SIGXCPU} al proceso. (Vea la documentación del módulo @ref{c6,,signal} para más información sobre cómo detectar esta señal y hacer algo productivo, p. ej. descargar los archivos abiertos al disco).
@end deffn

@geindex RLIMIT_FSIZE (en el módulo resource)
@anchor{library/resource resource RLIMIT_FSIZE}@anchor{4735}
@deffn {Dato} resource.RLIMIT_FSIZE

El tamaño máximo de un archivo que pueda crear el proceso.
@end deffn

@geindex RLIMIT_DATA (en el módulo resource)
@anchor{library/resource resource RLIMIT_DATA}@anchor{4736}
@deffn {Dato} resource.RLIMIT_DATA

El tamaño máximo (en bytes) de la memoria `heap' del proceso.
@end deffn

@geindex RLIMIT_STACK (en el módulo resource)
@anchor{library/resource resource RLIMIT_STACK}@anchor{4737}
@deffn {Dato} resource.RLIMIT_STACK

El tamaño máximo (en bytes) de la pila de llamadas para el proceso actual. Esto afecta únicamente a la pila del hilo principal en un proceso multi-hilo.
@end deffn

@geindex RLIMIT_RSS (en el módulo resource)
@anchor{library/resource resource RLIMIT_RSS}@anchor{4738}
@deffn {Dato} resource.RLIMIT_RSS

El tamaño máximo del conjunto residente (`RSS') del que puede disponer el proceso.
@end deffn

@geindex RLIMIT_NPROC (en el módulo resource)
@anchor{library/resource resource RLIMIT_NPROC}@anchor{4739}
@deffn {Dato} resource.RLIMIT_NPROC

El número máximo de procesos que puede crear el proceso actual.
@end deffn

@geindex RLIMIT_NOFILE (en el módulo resource)
@anchor{library/resource resource RLIMIT_NOFILE}@anchor{4733}
@deffn {Dato} resource.RLIMIT_NOFILE

El número máximo de descriptores de archivo abierto para el proceso actual.
@end deffn

@geindex RLIMIT_OFILE (en el módulo resource)
@anchor{library/resource resource RLIMIT_OFILE}@anchor{473a}
@deffn {Dato} resource.RLIMIT_OFILE

El nombre BDS para @ref{4733,,RLIMIT_NOFILE}.
@end deffn

@geindex RLIMIT_MEMLOCK (en el módulo resource)
@anchor{library/resource resource RLIMIT_MEMLOCK}@anchor{473b}
@deffn {Dato} resource.RLIMIT_MEMLOCK

El espacio de direcciones máximo que se puede bloquear en la memoria.
@end deffn

@geindex RLIMIT_VMEM (en el módulo resource)
@anchor{library/resource resource RLIMIT_VMEM}@anchor{473c}
@deffn {Dato} resource.RLIMIT_VMEM

El área de memoria mapeada más grande que puede ocupar el proceso.

@ref{1d5a,,Availability}: FreeBSD >= 11.
@end deffn

@geindex RLIMIT_AS (en el módulo resource)
@anchor{library/resource resource RLIMIT_AS}@anchor{473d}
@deffn {Dato} resource.RLIMIT_AS

El área máxima (en bytes) de espacio de direcciones que puede tomar el proceso.
@end deffn

@geindex RLIMIT_MSGQUEUE (en el módulo resource)
@anchor{library/resource resource RLIMIT_MSGQUEUE}@anchor{1009}
@deffn {Dato} resource.RLIMIT_MSGQUEUE

El número de bytes que se pueden asignar a las colas de mensajes POSIX.

@ref{1d5a,,Availability}: Linux >= 2.6.8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_NICE (en el módulo resource)
@anchor{library/resource resource RLIMIT_NICE}@anchor{100a}
@deffn {Dato} resource.RLIMIT_NICE

El techo del nivel del proceso `nice' (calculado como 20 - rlim_cur).

@ref{1d5a,,Availability}: Linux >= 2.6.12.


Added in version 3.4.

@end deffn

@geindex RLIMIT_RTPRIO (en el módulo resource)
@anchor{library/resource resource RLIMIT_RTPRIO}@anchor{100b}
@deffn {Dato} resource.RLIMIT_RTPRIO

El techo de la prioridad en tiempo real.

@ref{1d5a,,Availability}: Linux >= 2.6.12.


Added in version 3.4.

@end deffn

@geindex RLIMIT_RTTIME (en el módulo resource)
@anchor{library/resource resource RLIMIT_RTTIME}@anchor{100c}
@deffn {Dato} resource.RLIMIT_RTTIME

El límite de tiempo (en microsegundos) en tiempo de CPU que puede dedicar un proceso de programación en tiempo real sin hacer una llamada al sistema de bloqueo.

@ref{1d5a,,Availability}: Linux >= 2.6.25.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SIGPENDING (en el módulo resource)
@anchor{library/resource resource RLIMIT_SIGPENDING}@anchor{100d}
@deffn {Dato} resource.RLIMIT_SIGPENDING

El número de señales que el proceso puede poner en cola.

@ref{1d5a,,Availability}: Linux >= 2.6.8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SBSIZE (en el módulo resource)
@anchor{library/resource resource RLIMIT_SBSIZE}@anchor{100e}
@deffn {Dato} resource.RLIMIT_SBSIZE

El tamaño máximo (en bytes) de uso del búfer del socket para este usuario. Esto limita la cantidad de memoria de red, y por lo tanto la cantidad de mbufs, que este usuario puede retener en todo momento.

@ref{1d5a,,Availability}: FreeBSD.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SWAP (en el módulo resource)
@anchor{library/resource resource RLIMIT_SWAP}@anchor{100f}
@deffn {Dato} resource.RLIMIT_SWAP

El tamaño máximo (en bytes) del espacio de intercambio que puede ser reservado o utilizado por todos los procesos de este ID de usuario. Este límite se aplica solo si se establece el bit 1 de vm.overcommit sysctl. Consulte tuning(7)@footnote{https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7} para obtener una descripción completa de este sysctl.

@ref{1d5a,,Availability}: FreeBSD.


Added in version 3.4.

@end deffn

@geindex RLIMIT_NPTS (en el módulo resource)
@anchor{library/resource resource RLIMIT_NPTS}@anchor{1010}
@deffn {Dato} resource.RLIMIT_NPTS

El número máximo de pseudo-terminales que puede crear esta ID de usuario.

@ref{1d5a,,Availability}: FreeBSD.


Added in version 3.4.

@end deffn

@geindex RLIMIT_KQUEUES (en el módulo resource)
@anchor{library/resource resource RLIMIT_KQUEUES}@anchor{18f1}
@deffn {Dato} resource.RLIMIT_KQUEUES

El número máximo de kqueues que este ID de usuario puede crear.

@ref{1d5a,,Availability}: FreeBSD >= 11.


Added in version 3.10.

@end deffn

@node Utilización de recursos,,Límites de recursos,resource — Resource usage information
@anchor{library/resource resource-usage}@anchor{473e}
@subsubsection Utilización de recursos


Estas funciones se usan para recuperar la información de utilización de recursos:

@geindex getrusage() (en el módulo resource)
@anchor{library/resource resource getrusage}@anchor{1470}
@deffn {Función} resource.getrusage (who)

This function returns an object that describes the resources consumed by either
the current process or its children, as specified by the `who' parameter.  The
`who' parameter should be specified using one of the @code{RUSAGE_*}
constants described below.

Un ejemplo sencillo:

@example
from resource import *
import time

# a non CPU-bound task
time.sleep(3)
print(getrusage(RUSAGE_SELF))

# a CPU-bound task
for i in range(10 ** 8):
   _ = 1 + 1
print(getrusage(RUSAGE_SELF))
@end example

Los campos del valor retornado describen cómo se ha utilizado un recurso específico, p. ej. la cantidad de tiempo dedicada a la ejecución en modo usuario o el número de veces que el proceso ha sido intercambiado desde la memoria principal. Algunos valores dependen del intervalo de tic del reloj, p. ej. la cantidad de memoria que está usando el proceso.

Por compatibilidad con versiones anteriores, el valor retornado es accesible también como una tupla de 16 elementos.

The fields @code{ru_utime} and @code{ru_stime} of the return value are
floating-point values representing the amount of time spent executing in user
mode and the amount of time spent executing in system mode, respectively. The
remaining values are integers. Consult the @code{getrusage(2)@footnote{https://manpages.debian.org/getrusage(2)}} man page for
detailed information about these values. A brief summary is presented here:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Campo

@tab

Recurso

@item

@code{0}

@tab

@code{ru_utime}

@tab

tiempo en modo usuario (flotante en segundos)

@item

@code{1}

@tab

@code{ru_stime}

@tab

tiempo en modo sistema (flotante en segundos)

@item

@code{2}

@tab

@code{ru_maxrss}

@tab

tamaño máximo del conjunto residente

@item

@code{3}

@tab

@code{ru_ixrss}

@tab

tamaño de memoria compartida

@item

@code{4}

@tab

@code{ru_idrss}

@tab

tamaño de memoria no compartida

@item

@code{5}

@tab

@code{ru_isrss}

@tab

tamaño de la pila no compartida

@item

@code{6}

@tab

@code{ru_minflt}

@tab

fallos de página que no requieran E/S

@item

@code{7}

@tab

@code{ru_majflt}

@tab

fallos de página que requieran E/S

@item

@code{8}

@tab

@code{ru_nswap}

@tab

número de intercambios

@item

@code{9}

@tab

@code{ru_inblock}

@tab

bloque de operaciones de entrada

@item

@code{10}

@tab

@code{ru_oublock}

@tab

bloque de operaciones de salida

@item

@code{11}

@tab

@code{ru_msgsnd}

@tab

mensajes enviados

@item

@code{12}

@tab

@code{ru_msgrcv}

@tab

mensajes recibidos

@item

@code{13}

@tab

@code{ru_nsignals}

@tab

señales recibidas

@item

@code{14}

@tab

@code{ru_nvcsw}

@tab

intercambios de contexto voluntarios

@item

@code{15}

@tab

@code{ru_nivcsw}

@tab

intercambios de contexto involuntarios

@end multitable


Esta función lanzará un @ref{360,,ValueError} si el parámetro `who' especificado no es válido. También puede generar una excepción @ref{472f,,error} en circunstancias inusuales.
@end deffn

@geindex getpagesize() (en el módulo resource)
@anchor{library/resource resource getpagesize}@anchor{473f}
@deffn {Función} resource.getpagesize ()

Retorna el número de bytes en una página de sistema. (Esta no es necesariamente del mismo tamaño que la página de hardware).
@end deffn

The following @code{RUSAGE_*} symbols are passed to the @ref{1470,,getrusage()}
function to specify which processes information should be provided for.

@geindex RUSAGE_SELF (en el módulo resource)
@anchor{library/resource resource RUSAGE_SELF}@anchor{4740}
@deffn {Dato} resource.RUSAGE_SELF

Pasar a @ref{1470,,getrusage()} para solicitar recursos consumidos por el proceso de llamada, que es la suma de recursos utilizados por todos los hilos en el proceso.
@end deffn

@geindex RUSAGE_CHILDREN (en el módulo resource)
@anchor{library/resource resource RUSAGE_CHILDREN}@anchor{4741}
@deffn {Dato} resource.RUSAGE_CHILDREN

Pasar a @ref{1470,,getrusage()} para solicitar recursos consumidos por procesos secundarios del proceso de llamada que se han terminado o a los que se les está esperando.
@end deffn

@geindex RUSAGE_BOTH (en el módulo resource)
@anchor{library/resource resource RUSAGE_BOTH}@anchor{4742}
@deffn {Dato} resource.RUSAGE_BOTH

Pasar a @ref{1470,,getrusage()} para solicitar recursos consumidos por el proceso actual y sus procesos secundarios. Puede que no esté disponible en todos los sistemas.
@end deffn

@geindex RUSAGE_THREAD (en el módulo resource)
@anchor{library/resource resource RUSAGE_THREAD}@anchor{4743}
@deffn {Dato} resource.RUSAGE_THREAD

Pasa a @ref{1470,,getrusage()} para solicitar recursos consumidos por el hilo actual. Puede que no esté disponible en todos los sistemas.


Added in version 3.2.

@end deffn

@node syslog — Unix syslog library routines,,resource — Resource usage information,Servicios específicos de Unix
@anchor{library/syslog doc}@anchor{4744}@anchor{library/syslog module-syslog}@anchor{dc}@anchor{library/syslog syslog-unix-syslog-library-routines}@anchor{4745}
@subsection @code{syslog} — Unix syslog library routines


@geindex module; syslog


__________________________________________________________________


Este módulo ofrece una interfaz a las rutinas de la biblioteca @code{syslog} de Unix. Consulte las páginas del manual de Unix para una descripción detallada de la `facility' (es así como se llama en la documentación a un subsistema de aplicaciones) @code{syslog}.

@ref{1d5a,,Availability}: Unix, not WASI, not iOS.

This module wraps the system @code{syslog} family of routines.  A pure Python
library that can speak to a syslog server is available in the
@ref{89,,logging.handlers} module as @ref{6fd,,SysLogHandler}.

El módulo define las siguientes funciones:

@geindex syslog() (en el módulo syslog)
@anchor{library/syslog syslog syslog}@anchor{5e3}
@deffn {Función} syslog.syslog (message)

@deffnx {Función} syslog.syslog (priority, message)

Envía la cadena de caracteres `message' al registrador del sistema. Se añade un final de línea si es necesario. Cada mensaje se etiqueta con una prioridad compuesta por una `facility' y un `nivel'. El argumento opcional `priority', que por defecto es @ref{4746,,LOG_INFO}, determina la prioridad del mensaje. Si la `facility' no está codificada en `priority' usando un OR lógico (@code{LOG_INFO | LOG_USER}), se usará el valor con el que se llama a @ref{5e1,,openlog()}.

Si @ref{5e1,,openlog()} no se ha llamado antes de la llamada a @ref{dc,,syslog()}, entonces @ref{5e1,,openlog()} se llamará sin argumentos.

Lanza un @ref{18c3,,evento de auditoría} @code{syslog.syslog} con los argumentos @code{priority}, @code{message}.


Distinto en la versión 3.2: En versiones anteriores, @ref{5e1,,openlog()} no sería llamado automáticamente si no fuera un llamado previo de la llamada a la función @ref{dc,,syslog()}, postergando la implementación de syslog para llamar a @code{openlog()}.



Distinto en la versión 3.12: Esta función está restringida en subintérpretes. (Solo el código que se ejecuta en múltiples intérpretes se ve afectado y la restricción no es relevante para la mayoría de los usuarios.) @ref{5e1,,openlog()} debe ser llamada en el intérprete principal antes de que @ref{dc,,syslog()} pueda ser utilizada en un subintérprete. De lo contrario, lanzará @ref{1e5,,RuntimeError}.

@end deffn

@geindex openlog() (en el módulo syslog)
@anchor{library/syslog syslog openlog}@anchor{5e1}
@deffn {Función} syslog.openlog ([ident[, logoption[, facility]]])

Las opciones de registro de las llamadas a @ref{dc,,syslog()} pueden establecerse llamando a la función @ref{5e1,,openlog()}. @ref{dc,,syslog()} llamará a @ref{5e1,,openlog()} sin argumentos si el registro no está abierto actualmente.

El argumento por palabra clave opcional `ident' es una cadena de caracteres que precede a cada mensaje, y por defecto es @code{sys.argv[0]} retirando los componentes delanteros de la ruta. El argumento nombrado opcional `logoption' (por defecto es 0) es un campo de tipo bit – véanse a continuación los posibles valores que pueden combinarse. El argumento nombrado opcional `facility' (por defecto es @ref{4747,,LOG_USER}) establece una `facility' por defecto para mensajes que no tienen una `facility' explícitamente codificada.

Lanza un @ref{18c3,,evento de auditoría} @code{syslog.openlog} con los argumentos @code{ident}, @code{logoption}, @code{facility}.


Distinto en la versión 3.2: En versiones anteriores, argumentos por palabras llave no eran permitidos, y la `ident' era obligatoria.



Distinto en la versión 3.12: Esta función está restringida en subintérpretes. (Solo el código que se ejecuta en múltiples intérpretes se ve afectado y la restricción no es relevante para la mayoría de los usuarios.) Esta solo puede ser llamada en el intérprete principal. Lanzará @ref{1e5,,RuntimeError} si se llama en un subintérprete.

@end deffn

@geindex closelog() (en el módulo syslog)
@anchor{library/syslog syslog closelog}@anchor{5e2}
@deffn {Función} syslog.closelog ()

Reinicia los valores del módulo syslog y llama a la librería del sistema @code{closelog()}.

Esto provoca que el módulo actúe como lo hacía cuando fue importado inicialmente. Por ejemplo, se llamará a @ref{5e1,,openlog()} en la primera llamada a @ref{dc,,syslog()} (si no se ha llamado a @ref{5e1,,openlog()} ya), e `ident' y otros parámetros de @ref{5e1,,openlog()} se reiniciarán a sus valores por defecto.

Lanza un @ref{18c3,,evento de auditoría} @code{syslog.closelog} sin argumentos.


Distinto en la versión 3.12: Esta función está restringida en subintérpretes. (Solo el código que se ejecuta en múltiples intérpretes se ve afectado y la restricción no es relevante para la mayoría de los usuarios.) Esta solo puede ser llamada en el intérprete principal. Lanzará @ref{1e5,,RuntimeError} si se llama en un subintérprete.

@end deffn

@geindex setlogmask() (en el módulo syslog)
@anchor{library/syslog syslog setlogmask}@anchor{4110}
@deffn {Función} syslog.setlogmask (maskpri)

Asigna la máscara de prioridad a `maskpri' y retorna el valor anterior de la máscara. Las llamadas a @ref{dc,,syslog()} con un nivel de prioridad no asignado en `maskpri' se ignoran. El comportamiento por defecto es registrar todas las prioridades. La función @code{LOG_MASK(pri)} calcula la máscara para la prioridad individual `pri'. La función @code{LOG_UPTO(pri)} calcula la máscara para todas las prioridades mayores o iguales que `pri'.

Lanza un @ref{18c3,,evento de auditoría} @code{syslog.setlogmask} con argumento @code{maskpri}.
@end deffn

El módulo define las siguientes constantes:

@geindex LOG_EMERG (en el módulo syslog)
@geindex LOG_ALERT (en el módulo syslog)
@geindex LOG_CRIT (en el módulo syslog)
@geindex LOG_ERR (en el módulo syslog)
@geindex LOG_WARNING (en el módulo syslog)
@geindex LOG_NOTICE (en el módulo syslog)
@geindex LOG_INFO (en el módulo syslog)
@geindex LOG_DEBUG (en el módulo syslog)
@anchor{library/syslog syslog LOG_EMERG}@anchor{4748}
@deffn {Dato} syslog.LOG_EMERG
@anchor{library/syslog syslog LOG_ALERT}@anchor{4749}
@deffnx {Dato} syslog.LOG_ALERT
@anchor{library/syslog syslog LOG_CRIT}@anchor{474a}
@deffnx {Dato} syslog.LOG_CRIT
@anchor{library/syslog syslog LOG_ERR}@anchor{474b}
@deffnx {Dato} syslog.LOG_ERR
@anchor{library/syslog syslog LOG_WARNING}@anchor{474c}
@deffnx {Dato} syslog.LOG_WARNING
@anchor{library/syslog syslog LOG_NOTICE}@anchor{474d}
@deffnx {Dato} syslog.LOG_NOTICE
@anchor{library/syslog syslog LOG_INFO}@anchor{4746}
@deffnx {Dato} syslog.LOG_INFO
@anchor{library/syslog syslog LOG_DEBUG}@anchor{474e}
@deffnx {Dato} syslog.LOG_DEBUG

Priority levels (high to low).
@end deffn

@geindex LOG_AUTH (en el módulo syslog)
@geindex LOG_AUTHPRIV (en el módulo syslog)
@geindex LOG_CRON (en el módulo syslog)
@geindex LOG_DAEMON (en el módulo syslog)
@geindex LOG_FTP (en el módulo syslog)
@geindex LOG_INSTALL (en el módulo syslog)
@geindex LOG_KERN (en el módulo syslog)
@geindex LOG_LAUNCHD (en el módulo syslog)
@geindex LOG_LPR (en el módulo syslog)
@geindex LOG_MAIL (en el módulo syslog)
@geindex LOG_NETINFO (en el módulo syslog)
@geindex LOG_NEWS (en el módulo syslog)
@geindex LOG_RAS (en el módulo syslog)
@geindex LOG_REMOTEAUTH (en el módulo syslog)
@geindex LOG_SYSLOG (en el módulo syslog)
@geindex LOG_USER (en el módulo syslog)
@geindex LOG_UUCP (en el módulo syslog)
@geindex LOG_LOCAL0 (en el módulo syslog)
@geindex LOG_LOCAL1 (en el módulo syslog)
@geindex LOG_LOCAL2 (en el módulo syslog)
@geindex LOG_LOCAL3 (en el módulo syslog)
@geindex LOG_LOCAL4 (en el módulo syslog)
@geindex LOG_LOCAL5 (en el módulo syslog)
@geindex LOG_LOCAL6 (en el módulo syslog)
@geindex LOG_LOCAL7 (en el módulo syslog)
@anchor{library/syslog syslog LOG_AUTH}@anchor{474f}
@deffn {Dato} syslog.LOG_AUTH
@anchor{library/syslog syslog LOG_AUTHPRIV}@anchor{4750}
@deffnx {Dato} syslog.LOG_AUTHPRIV
@anchor{library/syslog syslog LOG_CRON}@anchor{4751}
@deffnx {Dato} syslog.LOG_CRON
@anchor{library/syslog syslog LOG_DAEMON}@anchor{4752}
@deffnx {Dato} syslog.LOG_DAEMON
@anchor{library/syslog syslog LOG_FTP}@anchor{4753}
@deffnx {Dato} syslog.LOG_FTP
@anchor{library/syslog syslog LOG_INSTALL}@anchor{4754}
@deffnx {Dato} syslog.LOG_INSTALL
@anchor{library/syslog syslog LOG_KERN}@anchor{4755}
@deffnx {Dato} syslog.LOG_KERN
@anchor{library/syslog syslog LOG_LAUNCHD}@anchor{4756}
@deffnx {Dato} syslog.LOG_LAUNCHD
@anchor{library/syslog syslog LOG_LPR}@anchor{4757}
@deffnx {Dato} syslog.LOG_LPR
@anchor{library/syslog syslog LOG_MAIL}@anchor{4758}
@deffnx {Dato} syslog.LOG_MAIL
@anchor{library/syslog syslog LOG_NETINFO}@anchor{4759}
@deffnx {Dato} syslog.LOG_NETINFO
@anchor{library/syslog syslog LOG_NEWS}@anchor{475a}
@deffnx {Dato} syslog.LOG_NEWS
@anchor{library/syslog syslog LOG_RAS}@anchor{475b}
@deffnx {Dato} syslog.LOG_RAS
@anchor{library/syslog syslog LOG_REMOTEAUTH}@anchor{475c}
@deffnx {Dato} syslog.LOG_REMOTEAUTH
@anchor{library/syslog syslog LOG_SYSLOG}@anchor{475d}
@deffnx {Dato} syslog.LOG_SYSLOG
@anchor{library/syslog syslog LOG_USER}@anchor{4747}
@deffnx {Dato} syslog.LOG_USER
@anchor{library/syslog syslog LOG_UUCP}@anchor{475e}
@deffnx {Dato} syslog.LOG_UUCP
@anchor{library/syslog syslog LOG_LOCAL0}@anchor{475f}
@deffnx {Dato} syslog.LOG_LOCAL0
@anchor{library/syslog syslog LOG_LOCAL1}@anchor{4760}
@deffnx {Dato} syslog.LOG_LOCAL1
@anchor{library/syslog syslog LOG_LOCAL2}@anchor{4761}
@deffnx {Dato} syslog.LOG_LOCAL2
@anchor{library/syslog syslog LOG_LOCAL3}@anchor{4762}
@deffnx {Dato} syslog.LOG_LOCAL3
@anchor{library/syslog syslog LOG_LOCAL4}@anchor{4763}
@deffnx {Dato} syslog.LOG_LOCAL4
@anchor{library/syslog syslog LOG_LOCAL5}@anchor{4764}
@deffnx {Dato} syslog.LOG_LOCAL5
@anchor{library/syslog syslog LOG_LOCAL6}@anchor{4765}
@deffnx {Dato} syslog.LOG_LOCAL6
@anchor{library/syslog syslog LOG_LOCAL7}@anchor{4766}
@deffnx {Dato} syslog.LOG_LOCAL7

Facilities, depending on availability in @code{<syslog.h>} for @ref{4750,,LOG_AUTHPRIV},
@ref{4753,,LOG_FTP}, @ref{4759,,LOG_NETINFO}, @ref{475c,,LOG_REMOTEAUTH},
@ref{4754,,LOG_INSTALL} and @ref{475b,,LOG_RAS}.


Distinto en la versión 3.13: Added @ref{4753,,LOG_FTP}, @ref{4759,,LOG_NETINFO}, @ref{475c,,LOG_REMOTEAUTH},
@ref{4754,,LOG_INSTALL}, @ref{475b,,LOG_RAS}, and @ref{4756,,LOG_LAUNCHD}.

@end deffn

@geindex LOG_PID (en el módulo syslog)
@geindex LOG_CONS (en el módulo syslog)
@geindex LOG_NDELAY (en el módulo syslog)
@geindex LOG_ODELAY (en el módulo syslog)
@geindex LOG_NOWAIT (en el módulo syslog)
@geindex LOG_PERROR (en el módulo syslog)
@anchor{library/syslog syslog LOG_PID}@anchor{4767}
@deffn {Dato} syslog.LOG_PID
@anchor{library/syslog syslog LOG_CONS}@anchor{4768}
@deffnx {Dato} syslog.LOG_CONS
@anchor{library/syslog syslog LOG_NDELAY}@anchor{4769}
@deffnx {Dato} syslog.LOG_NDELAY
@anchor{library/syslog syslog LOG_ODELAY}@anchor{476a}
@deffnx {Dato} syslog.LOG_ODELAY
@anchor{library/syslog syslog LOG_NOWAIT}@anchor{476b}
@deffnx {Dato} syslog.LOG_NOWAIT
@anchor{library/syslog syslog LOG_PERROR}@anchor{476c}
@deffnx {Dato} syslog.LOG_PERROR

Log options, depending on availability in @code{<syslog.h>} for
@ref{476a,,LOG_ODELAY}, @ref{476b,,LOG_NOWAIT} and @ref{476c,,LOG_PERROR}.
@end deffn

@menu
* Ejemplos: Ejemplos<34>. 

@end menu

@node Ejemplos<34>,,,syslog — Unix syslog library routines
@anchor{library/syslog examples}@anchor{476d}
@subsubsection Ejemplos


@menu
* Ejemplo sencillo: Ejemplo sencillo<2>. 

@end menu

@node Ejemplo sencillo<2>,,,Ejemplos<34>
@anchor{library/syslog simple-example}@anchor{476e}
@subsubsection Ejemplo sencillo


Un conjunto sencillo de ejemplos:

@example
import syslog

syslog.syslog('Processing started')
if error:
    syslog.syslog(syslog.LOG_ERR, 'Processing started')
@end example

Un ejemplo de configuración de varias opciones de registro, que incluirán el identificador del proceso en los mensajes registrados, y escribirán los mensajes a la facility de destino usada para el registro de correo:

@example
syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...')
@end example

@node Modules command-line interface CLI,Módulos reemplazados,Servicios específicos de Unix,La biblioteca estándar de Python
@anchor{library/cmdline doc}@anchor{476f}@anchor{library/cmdline modules-command-line-interface-cli}@anchor{4770}
@section Modules command-line interface (CLI)


The following modules have a command-line interface.


@itemize *

@item 
@ref{454a,,ast}

@item 
@ref{31ce,,asyncio}

@item 
@ref{f,,base64}

@item 
@ref{24e4,,calendar}

@item 
@ref{1b,,code}

@item 
@ref{4607,,compileall}

@item 
@ref{28,,cProfile}: see @ref{419d,,profile}

@item 
@ref{2338,,difflib}

@item 
@ref{461d,,dis}

@item 
@ref{3b,,doctest}

@item 
@code{encodings.rot_13}

@item 
@ref{55,,ensurepip}

@item 
@ref{5a,,filecmp}

@item 
@ref{5b,,fileinput}

@item 
@ref{5e,,ftplib}

@item 
@ref{2965,,gzip}

@item 
@ref{fd1,,http.server}

@item 
@code{idlelib}

@item 
@ref{fdb,,inspect}

@item 
@ref{188,,json}

@item 
@ref{8f,,mimetypes}

@item 
@ref{a5,,pdb}

@item 
@ref{a6,,pickle}

@item 
@ref{468c,,pickletools}

@item 
@ref{aa,,platform}

@item 
@ref{ac,,poplib}

@item 
@ref{419d,,profile}

@item 
@ref{b0,,pstats}

@item 
@ref{45ff,,py_compile}

@item 
@ref{b4,,pyclbr}

@item 
@ref{b5,,pydoc}

@item 
@ref{b7,,quopri}

@item 
@ref{2c0,,random}

@item 
@ref{be,,runpy}

@item 
@ref{43f5,,site}

@item 
@ref{4ee,,sqlite3}

@item 
@ref{457f,,symtable}

@item 
@ref{42f6,,sysconfig}

@item 
@ref{dd,,tabnanny}

@item 
@ref{104a,,tarfile}

@item 
@code{this}

@item 
@ref{41bd,,timeit}

@item 
@ref{45d3,,tokenize}

@item 
@ref{41d9,,trace}

@item 
@ref{102,,turtledemo}

@item 
@ref{3f88,,unittest}

@item 
@ref{4f1,,uuid}

@item 
@ref{111,,venv}

@item 
@ref{115,,webbrowser}

@item 
@ref{4256,,zipapp}

@item 
@ref{29d4,,zipfile}
@end itemize

See also the @ref{19c8,,Python command-line interface}.

@node Módulos reemplazados,Removed Modules,Modules command-line interface CLI,La biblioteca estándar de Python
@anchor{library/superseded doc}@anchor{4771}@anchor{library/superseded superseded}@anchor{4772}@anchor{library/superseded superseded-modules}@anchor{4773}
@section Módulos reemplazados


The modules described in this chapter are deprecated or @ref{1c4,,soft deprecated} and only kept for
backwards compatibility. They have been superseded by other modules.

@menu
* getopt — C-style parser for command line options:: 
* optparse — Parser for command line options:: 

@end menu

@node getopt — C-style parser for command line options,optparse — Parser for command line options,,Módulos reemplazados
@anchor{library/getopt doc}@anchor{4774}@anchor{library/getopt getopt-c-style-parser-for-command-line-options}@anchor{4775}@anchor{library/getopt module-getopt}@anchor{61}
@subsection @code{getopt} — C-style parser for command line options


@geindex module; getopt

`Código fuente:' Lib/getopt.py@footnote{https://github.com/python/cpython/tree/main/Lib/getopt.py}


Obsoleto desde la versión 3.13: The @ref{61,,getopt} module is @ref{1c4,,soft deprecated} and will not be
developed further; development will continue with the @ref{7,,argparse}
module.


@cartouche
@quotation Nota 
The @ref{61,,getopt} module is a parser for command line options whose API is
designed to be familiar to users of the C @code{getopt()} function. Users who
are unfamiliar with the C @code{getopt()} function or who would like to write
less code and get better help and error messages should consider using the
@ref{7,,argparse} module instead.
@end quotation
@end cartouche


__________________________________________________________________


This module helps scripts to parse the command line arguments in @code{sys.argv}.
It supports the same conventions as the Unix @code{getopt()} function (including
the special meanings of arguments of the form “@code{-}” and “@code{--}“).  Long
options similar to those supported by GNU software may be used as well via an
optional third argument.

Este módulo proporciona dos funciones y una excepción:

@geindex getopt() (en el módulo getopt)
@anchor{library/getopt getopt getopt}@anchor{14f7}
@deffn {Función} getopt.getopt (args, shortopts, longopts=[])

Parses command line options and parameter list.  `args' is the argument list to
be parsed, without the leading reference to the running program. Typically, this
means @code{sys.argv[1:]}. `shortopts' is the string of option letters that the
script wants to recognize, with options that require an argument followed by a
colon (@code{':'}) and options that accept an optional argument followed by
two colons (@code{'::'}); i.e., the same format that Unix @code{getopt()} uses.

@cartouche
@quotation Nota 
Unlike GNU @code{getopt()}, after a non-option argument, all further
arguments are considered also non-options. This is similar to the way
non-GNU Unix systems work.
@end quotation
@end cartouche

`longopts', if specified, must be a list of strings with the names of the
long options which should be supported.  The leading @code{'--'} characters
should not be included in the option name.  Long options which require an
argument should be followed by an equal sign (@code{'='}).
Long options which accept an optional argument should be followed by
an equal sign and question mark (@code{'=?'}).
To accept only long options, `shortopts' should be an
empty string.  Long options on the command line can be recognized so long as
they provide a prefix of the option name that matches exactly one of the
accepted options.  For example, if `longopts' is @code{['foo', 'frob']}, the
option @code{--fo} will match as @code{--foo}, but @code{--f} will
not match uniquely, so @ref{4776,,GetoptError} will be raised.

El valor de retorno consta de dos elementos: el primero es una lista de pares @code{(option, value)}; el segundo es la lista de argumentos del programa que quedan después de que se eliminó la lista de opciones (esta es una porción final de `args'). Cada par de opción y valor retornado tiene la opción como su primer elemento, con un guión para las opciones cortas (por ejemplo, @code{'-x'}) o dos guiones para las opciones largas (por ejemplo, @code{'--long-option'}), y el argumento de la opción como su segundo elemento, o una cadena vacía si la opción no tiene argumento. Las opciones aparecen en la lista en el mismo orden en que se encontraron, lo que permite múltiples ocurrencias. Las opciones largas y cortas pueden ser mixtas.


Distinto en la versión 3.14: Optional arguments are supported.

@end deffn

@geindex gnu_getopt() (en el módulo getopt)
@anchor{library/getopt getopt gnu_getopt}@anchor{14f6}
@deffn {Función} getopt.gnu_getopt (args, shortopts, longopts=[])

Esta función funciona como @ref{61,,getopt()}, excepto que el modo de escaneo estilo GNU se usa por defecto. Esto significa que los argumentos opcionales y no opcionales pueden estar mezclados. La función @ref{61,,getopt()} detiene el procesamiento de opciones tan pronto como se encuentra un argumento no-opcionales.

If the first character of the option string is @code{'+'}, or if the environment
variable @code{POSIXLY_CORRECT} is set, then option processing stops as
soon as a non-option argument is encountered.

If the first character of the option string is @code{'-'}, non-option arguments
that are followed by options are added to the list of option-and-value pairs
as a pair that has @code{None} as its first element and the list of non-option
arguments as its second element.
The second element of the @code{gnu_getopt()} result is a list of
program arguments after the last option.


Distinto en la versión 3.14: Support for returning intermixed options and non-option arguments in order.

@end deffn

@geindex GetoptError
@anchor{library/getopt getopt GetoptError}@anchor{4776}
@deffn {Excepción} getopt.GetoptError

This is raised when an unrecognized option is found in the argument list or when
an option requiring an argument is given none. The argument to the exception is
a string indicating the cause of the error.  For long options, an argument given
to an option which does not require one will also cause this exception to be
raised.  The attributes @code{msg} and @code{opt} give the error message and
related option; if there is no specific option to which the exception relates,
@code{opt} is an empty string.
@end deffn

@c XXX deprecated?

@geindex error
@anchor{library/getopt getopt error}@anchor{4777}
@deffn {Excepción} getopt.error

Alias para @ref{4776,,GetoptError}; para compatibilidad con versiones anteriores.
@end deffn

Un ejemplo que usa solo opciones de estilo Unix:

@example
>>> import getopt
>>> args = '-a -b -cfoo -d bar a1 a2'.split()
>>> args
['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'abc:d:')
>>> optlist
[('-a', '@w{'}), ('-b', '@w{'}), ('-c', 'foo'), ('-d', 'bar')]
>>> args
['a1', 'a2']
@end example

Usar nombres largos de opciones es igualmente fácil:

@example
>>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'
>>> args = s.split()
>>> args
['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'x', [
...     'condition=', 'output-file=', 'testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', '@w{'}), ('--output-file', 'abc.def'), ('-x', '@w{'})]
>>> args
['a1', 'a2']
@end example

Optional arguments should be specified explicitly:

@example
>>> s = '-Con -C --color=off --color a1 a2'
>>> args = s.split()
>>> args
['-Con', '-C', '--color=off', '--color', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'C::', ['color=?'])
>>> optlist
[('-C', 'on'), ('-C', '@w{'}), ('--color', 'off'), ('--color', '@w{'})]
>>> args
['a1', 'a2']
@end example

The order of options and non-option arguments can be preserved:

@example
>>> s = 'a1 -x a2 a3 a4 --long a5 a6'
>>> args = s.split()
>>> args
['a1', '-x', 'a2', 'a3', 'a4', '--long', 'a5', 'a6']
>>> optlist, args = getopt.gnu_getopt(args, '-x:', ['long='])
>>> optlist
[(None, ['a1']), ('-x', 'a2'), (None, ['a3', 'a4']), ('--long', 'a5')]
>>> args
['a6']
@end example

In a script, typical usage is something like this:

@example
import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError as err:
        # print help information and exit:
        print(err)  # will print something like "option -a not recognized"
        usage()
        sys.exit(2)
    output = None
    verbose = False
    for o, a in opts:
        if o == "-v":
            verbose = True
        elif o in ("-h", "--help"):
            usage()
            sys.exit()
        elif o in ("-o", "--output"):
            output = a
        else:
            assert False, "unhandled option"
    # ...

if __name__ == "__main__":
    main()
@end example

Note that an equivalent command line interface could be produced with less code
and more informative help and error messages by using the @ref{7,,argparse} module:

@example
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    args = parser.parse_args()
    # ... do something with args.output ...
    # ... do something with args.verbose ..
@end example


@subsubheading Ver también



@table @asis

@item Módulo @ref{7,,argparse}

Opción de línea de comando alternativa y biblioteca de análisis de argumentos.
@end table


@node optparse — Parser for command line options,,getopt — C-style parser for command line options,Módulos reemplazados
@anchor{library/optparse doc}@anchor{4778}@anchor{library/optparse module-optparse}@anchor{a0}@anchor{library/optparse optparse-parser-for-command-line-options}@anchor{4779}
@subsection @code{optparse} — Parser for command line options


@geindex module; optparse

`Source code:' Lib/optparse.py@footnote{https://github.com/python/cpython/tree/main/Lib/optparse.py}


Obsoleto desde la versión 3.2: The @ref{a0,,optparse} module is @ref{1c4,,soft deprecated} and will not be
developed further; development will continue with the @ref{7,,argparse}
module.



__________________________________________________________________


@ref{a0,,optparse} es una biblioteca más conveniente, flexible y poderosa para analizar opciones de línea de comandos que el antiguo módulo @ref{61,,getopt}. @ref{a0,,optparse} usa un estilo más declarativo: creas una instancia de @ref{150d,,OptionParser}, le añades las opciones deseadas y realizas el análisis sintáctico de la línea de comandos. @ref{a0,,optparse} permite a los usuarios especificar opciones siguiendo la sintaxis convencional de GNU/POSIX, además de generar mensajes de uso y de ayuda automáticamente.

A continuación puedes ver un ejemplo de uso de @ref{a0,,optparse} mediante un script simple:

@example
from optparse import OptionParser
...
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", default=True,
                  help="don't print status messages to stdout")

(options, args) = parser.parse_args()
@end example

Con estas pocas líneas de código, los usuarios de tu script ahora pueden hacer un uso «normal» del mismo mediante la línea de comandos, por ejemplo:

@example
<yourscript> --file=outfile -q
@end example

A medida que analiza la línea de comandos, @ref{a0,,optparse} establece los atributos del objeto @code{options} retornado por @ref{150e,,parse_args()} basándose en los valores de la línea de comandos proporcionada por el usuario. Cuando @ref{150e,,parse_args()} termina de analizar esta línea de comandos, @code{options.filename} será @code{"outfile"} y @code{options.verbose} será @code{False}. @ref{a0,,optparse} admite opciones largas y cortas, fusionar opciones cortas y asociar opciones con sus argumentos de diversas formas. Por lo tanto, las siguientes líneas de comandos son todas equivalentes al ejemplo previo:

@example
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile
@end example

Además, los usuarios pueden ejecutar uno de los siguientes:

@example
<yourscript> -h
<yourscript> --help
@end example

y @ref{a0,,optparse} imprimirá un breve resumen de las opciones de tu script:

@example
Usage: <yourscript> [options]

Options:
  -h, --help            show this help message and exit
  -f FILE, --file=FILE  write report to FILE
  -q, --quiet           don't print status messages to stdout
@end example

donde el valor de `yourscript' se determina en tiempo de ejecución (normalmente a partir de @code{sys.argv [0]}).

@menu
* Contexto:: 
* Tutorial: Tutorial<4>. 
* Guía de referencia:: 
* Retrollamadas de opción:: 
* Extendiendo el módulo optparse:: 
* Excepciones: Excepciones<19>. 

@end menu

@node Contexto,Tutorial<4>,,optparse — Parser for command line options
@anchor{library/optparse background}@anchor{477a}@anchor{library/optparse optparse-background}@anchor{477b}
@subsubsection Contexto


@ref{a0,,optparse} ha sido diseñado explícitamente para fomentar la creación de programas con interfaces de línea de comandos convencionales y sencillas. Con ese fin en mente, solo admite la sintaxis y semántica de línea de comandos más común y convencionalmente usada en Unix. Si no estás familiarizado con estas convenciones, lee esta sección para familiarizarte con ellas.

@menu
* Terminología:: 
* ¿Qué finalidad tienen las opciones?:: 
* ¿Qué finalidad tienen los argumentos posicionales?:: 

@end menu

@node Terminología,¿Qué finalidad tienen las opciones?,,Contexto
@anchor{library/optparse optparse-terminology}@anchor{477c}@anchor{library/optparse terminology}@anchor{477d}
@subsubsection Terminología



@table @asis

@item argumento

una cadena de caracteres ingresada en la línea de comandos y pasada mediante la shell a @code{execl()} o @code{execv()}. En Python, los argumentos son elementos de @code{sys.argv[1:]} (dado que @code{sys.argv[0]} es el propio nombre del programa que se está ejecutando). Las shells de Unix también usan el término «`word'» (“palabra”) para referirse a ellos.

En ocasiones es deseable proporcionar una lista de argumentos que no sea @code{sys.argv[1:]}, por lo que deberías considerar un “argumento” como “un elemento de @code{sys.argv[1:]} o de alguna otra lista proporcionada como sustituto de @code{sys.argv[1:]}”.

@item opción

un argumento utilizado para proporcionar información adicional con la finalidad de guiar o personalizar la ejecución de un programa. Existen muchas sintaxis diferentes para especificar opciones. La sintaxis tradicional de Unix es un guion (“-”) seguido de una sola letra, por ejemplo @code{-x} o @code{-F}. La sintaxis tradicional de Unix permite además fusionar múltiples opciones en un solo argumento, por ejemplo @code{-x -F} es equivalente a @code{-xF}. Por otro lado, el proyecto GNU introdujo @code{--} seguido de una serie de palabras separadas por guiones, por ejemplo @code{--file} o @code{--dry-run}. Estas son las dos únicas sintaxis para opciones que el módulo @ref{a0,,optparse} proporciona.

Algunas de las otras sintaxis para opciones que el mundo ha visto son:


@itemize *

@item 
un guion seguido de algunas letras, por ejemplo @code{-pf} (esto `no' es lo mismo que múltiples opciones fusionadas en un solo argumento)

@item 
un guion seguido de una palabra completa, por ejemplo @code{-file} (esto es técnicamente equivalente a la sintaxis anterior, pero generalmente no se ven ambas en un mismo programa)

@item 
un signo más seguido de una sola letra, unas pocas letras o una palabra, por ejemplo @code{+f} o @code{+rgb}

@item 
una barra seguida de una letra, de unas pocas letras o de una palabra, por ejemplo @code{/f} o @code{/file}
@end itemize

Estas sintaxis para opciones no son compatibles con @ref{a0,,optparse} y nunca lo serán. Esto es deliberado: los tres primeros no son estándar en ningún entorno y el último solo tiene sentido si se dirige exclusivamente a Windows o alguna plataforma heredada (`legacy') (por ejemplo: VMS, MS-DOS).

@item argumento de opción

un argumento que sigue a una opción, está estrechamente asociado con ella y se consume de la lista de argumentos cuando esa opción es consumida. Con @ref{a0,,optparse}, los argumentos de las opciones pueden estar en un argumento separado de su opción:

@example
-f foo
--file foo
@end example

o incluidos en el mismo argumento:

@example
-ffoo
--file=foo
@end example

Normalmente, una opción dada puede aceptar o no un argumento. Mucha gente desea una característica de «argumentos de opción opcionales», lo que implica que algunas opciones aceptarán un argumento si está presente y no lo aceptarán si no lo está. Esto es algo controvertido, porque hace que el análisis sea ambiguo: si @code{-a} toma un argumento opcional y @code{-b} es otra opción completamente distinta, ¿cómo interpretamos @code{-ab}? Debido a esta ambigüedad, @ref{a0,,optparse} no es compatible con esta funcionalidad.

@item argumento posicional

es algo que queda en la lista de argumentos después de que las opciones hayan sido analizadas sintácticamente, es decir, después de que las opciones y sus argumentos hayan sido analizados y eliminados de la lista de argumentos.

@item opción requerida

es una opción que debe proporcionarse forzosamente en la línea de comandos. Ten en cuenta que la frase «opción requerida» se contradice a si misma. @ref{a0,,optparse} no te impide implementar opciones requeridas, pero tampoco brinda mucha ayuda para ello.
@end table

Por ejemplo, considera esta hipotética linea de comandos:

@example
prog -v --report report.txt foo bar
@end example

@code{-v} y @code{--report} son ambas opciones. @code{report.txt} es un argumento de opción, suponiendo que @code{--report} toma un argumento. En cambio, @code{foo} y @code{bar} son ambos argumentos posicionales.

@node ¿Qué finalidad tienen las opciones?,¿Qué finalidad tienen los argumentos posicionales?,Terminología,Contexto
@anchor{library/optparse optparse-what-options-for}@anchor{477e}@anchor{library/optparse what-are-options-for}@anchor{477f}
@subsubsection ¿Qué finalidad tienen las opciones?


Las opciones se utilizan para poder proporcionar información adicional con el fin de ajustar o personalizar la ejecución de un programa. Por si aún no ha quedado claro, las opciones suelen ser `opcionales'. Un programa debería poder ejecutarse sin problemas sin ninguna opción. (Elija un programa aleatorio del conjunto de herramientas de Unix o GNU. ¿Puede ejecutarse sin ninguna opción y aún así tener sentido? Las principales excepciones son @code{find}, @code{tar} y @code{dd}—los cuales son todos bichos raros mutantes que han sido apropiadamente criticados por su sintaxis no estándar y por tener interfaces confusas).

Como se ha comentado, mucha gente quiere que sus programas tengan «opciones requeridas». Pero pensemos en ello detenidamente. ¡Si es necesario, entonces `no es opcional'! Si hay una pieza de información absolutamente requerida para que tu programa pueda ejecutarse correctamente no uses opciones, para eso están los argumentos posicionales.

Como ejemplo de un buen diseño de una interfaz de línea de comandos, considera la humilde herramienta @code{cp} para copiar archivos. No tiene mucho sentido intentar copiar archivos sin proporcionar un destino y al menos una fuente de origen. Por lo tanto, @code{cp} falla si lo ejecutas sin argumentos. Sin embargo, tiene una sintaxis flexible y útil que no requiere ninguna opción:

@example
cp SOURCE DEST
cp SOURCE ... DEST-DIR
@end example

Puedes hacer mucho simplemente con eso. La mayoría de las implementaciones de @code{cp} proporcionan un montón de opciones para modificar exactamente cómo se copian los archivos: se puede preservar el modo y la fecha de modificación, evitar que se sigan enlaces simbólicos, preguntar antes de sobrescribir el contenido de archivos existentes, etc. Pero nada de esto distrae de la misión principal de @code{cp}, que consiste en copiar uno o varios archivos en otro directorio.

@node ¿Qué finalidad tienen los argumentos posicionales?,,¿Qué finalidad tienen las opciones?,Contexto
@anchor{library/optparse optparse-what-positional-arguments-for}@anchor{4780}@anchor{library/optparse what-are-positional-arguments-for}@anchor{4781}
@subsubsection ¿Qué finalidad tienen los argumentos posicionales?


Los argumentos posicionales son adecuados para aquellas piezas de información que tu programa, absolutamente y sin duda alguna, requiere para funcionar.

Una buena interfaz de usuario debería tener la menor cantidad de requisitos absolutos posibles. Si tu programa requiere 17 piezas distintas de información para ejecutarse correctamente, no importa mucho `cómo' obtengas esa información del usuario; la mayoría de ellos se rendirán y se irán antes de ejecutar con éxito el programa. Esto se aplica tanto si la interfaz de usuario es una línea de comandos, un archivo de configuración o una GUI: si hace demasiadas demandas a sus usuarios, la mayoría simplemente se rendirá.

En resumen, trata de minimizar la cantidad de información que los usuarios están absolutamente obligados a proporcionar, utiliza valores predeterminados sensatos siempre que sea posible. Como es natural, también deseas que tus programas sean razonablemente flexibles, para eso están las opciones. De nuevo, no importa si son entradas en un archivo de configuración, widgets en un cuadro de diálogo de «Preferencias» de una GUI u opciones en la línea de comandos; cuantas más opciones implementes, más flexible será tu programa y más complicada se vuelve su implementación. Una excesiva flexibilidad evidentemente también tiene inconvenientes, demasiadas opciones pueden abrumar a los usuarios y hacer que tu código sea mucho más difícil de mantener.

@node Tutorial<4>,Guía de referencia,Contexto,optparse — Parser for command line options
@anchor{library/optparse optparse-tutorial}@anchor{4782}@anchor{library/optparse tutorial}@anchor{4783}
@subsubsection Tutorial


Si bien @ref{a0,,optparse} es bastante flexible y potente, también es sencillo de usar en la mayoría de los casos. Esta sección cubre los patrones de código comunes a cualquier programa basado en @ref{a0,,optparse}.

En primer lugar, necesitas importar la clase OptionParser y luego, al comienzo del programa principal, crear una instancia de ella:

@example
from optparse import OptionParser
...
parser = OptionParser()
@end example

Ahora ya puedes comenzar a definir opciones. La sintaxis básica es:

@example
parser.add_option(opt_str, ...,
                  attr=value, ...)
@end example

Cada opción tiene una o más cadenas de caracteres de opción, como @code{-f} o @code{--file} y varios atributos de opción que le dicen a @ref{a0,,optparse} qué esperar y qué hacer cuando encuentra esa opción en la línea de comandos.

Normalmente, cada opción tendrá una cadena de opción corta y una cadena de opción larga, por ejemplo:

@example
parser.add_option("-f", "--file", ...)
@end example

Puedes definir tantas cadenas de opción cortas y tantas largas como desees (incluso ninguna), siempre que haya al menos una cadena de opción en total.

Las cadenas de opción pasadas a @ref{2cbe,,OptionParser.add_option()} son en definitiva etiquetas para la opción definida por esa llamada. Simplemente por brevedad, con frecuencia nos referiremos a `encontrar una opción' en la línea de comandos. En realidad, @ref{a0,,optparse} encuentra `cadenas de caracteres de opción' y busca opciones en ellas.

Una vez que todas tus opciones estén definidas, indica a @ref{a0,,optparse} que analice sintácticamente la línea de comandos de tu programa:

@example
(options, args) = parser.parse_args()
@end example

(Si lo deseas, puedes pasar una lista de argumentos personalizada a @ref{150e,,parse_args()}, pero eso rara vez es necesario: por defecto se usa @code{sys.argv [1:]}.)

@ref{150e,,parse_args()} retorna dos valores:


@itemize *

@item 
@code{options}, un objeto que contiene valores para todas tus opciones. Por ejemplo, si @code{--file} toma un argumento de una sola cadena de caracteres, entonces @code{options.file} será el nombre del archivo proporcionado por el usuario o @code{None} si el usuario no proporcionó esa opción en la linea de comandos

@item 
@code{args}, la lista de argumentos posicionales que quedan después de analizar las opciones
@end itemize

Este tutorial solo cubre los cuatro atributos de opción más importantes: @ref{4784,,action}, @ref{4785,,type}, @ref{4786,,dest} (destino) y @ref{4787,,help}. De todos ellos, @ref{4784,,action} es el fundamental.

@menu
* Comprendiendo las acciones de opción:: 
* La acción store:: 
* Manejo de opciones booleanas (flags): Manejo de opciones booleanas flags. 
* Otras acciones:: 
* Valores por defecto:: 
* Generando ayuda:: 
* Imprimir una cadena de caracteres con la versión del programa:: 
* Cómo maneja los errores el módulo optparse:: 
* Reuniendo todas las piezas:: 

@end menu

@node Comprendiendo las acciones de opción,La acción store,,Tutorial<4>
@anchor{library/optparse optparse-understanding-option-actions}@anchor{4788}@anchor{library/optparse understanding-option-actions}@anchor{4789}
@subsubsection Comprendiendo las acciones de opción


Las acciones le dicen a @ref{a0,,optparse} qué hacer cuando encuentra una determinada opción en la línea de comandos. Hay un conjunto fijo de acciones codificadas en @ref{a0,,optparse}. Agregar nuevas acciones es un tema avanzado cubierto en la sección @ref{478a,,Extendiendo el módulo optparse}. La mayoría de las acciones indican a @ref{a0,,optparse} que almacene un valor en alguna variable, por ejemplo, tomar una cadena de caracteres de la línea de comandos y almacenarla en un atributo del objeto @code{options}.

Si no se especifica una acción para la opción, @ref{a0,,optparse} usa por defecto @code{store}.

@node La acción store,Manejo de opciones booleanas flags,Comprendiendo las acciones de opción,Tutorial<4>
@anchor{library/optparse optparse-store-action}@anchor{478b}@anchor{library/optparse the-store-action}@anchor{478c}
@subsubsection La acción store


La acción para opciones más común es @code{store}, que le dice a @ref{a0,,optparse} que tome el siguiente argumento (o el resto del argumento actual), se asegure de que sea del tipo correcto y lo guarde en el destino elegido.

Por ejemplo:

@example
parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")
@end example

Ahora creamos una línea de comandos simulada y le pedimos a @ref{a0,,optparse} que la analice:

@example
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
@end example

Cuando @ref{a0,,optparse} se encuentra con la cadena de opción @code{-f}, consume el siguiente argumento, @code{foo.txt} y lo almacena en @code{options.filename}. Por lo tanto, después de la llamada a @ref{150e,,parse_args()}, @code{options.filename} será @code{"foo.txt"}.

Algunos de los otros tipos de opción admitidos por @ref{a0,,optparse} son @code{int} y @code{float}. Aquí hay una opción que espera un argumento entero:

@example
parser.add_option("-n", type="int", dest="num")
@end example

Ten en cuenta que esta opción no tiene una cadena de opción larga, lo cual es perfectamente aceptable. Además, no hay ninguna acción explícita, ya que el valor predeterminado es @code{store}.

Analicemos otra línea de comandos simulada. En esta ocasión, vamos a proporcionar el argumento de la opción pegado junto a la misma, sin separación entre ambos: dado que @code{-n42} (un argumento) es equivalente a @code{-n 42} (dos argumentos), el código:

@example
(options, args) = parser.parse_args(["-n42"])
print(options.num)
@end example

imprimirá @code{42}.

Si no se especifica un tipo, @ref{a0,,optparse} asume @code{string}. Esto, combinado con el hecho de que la acción predeterminada es @code{store}, implica que nuestro primer ejemplo puede implementarse de forma mucho más concisa:

@example
parser.add_option("-f", "--file", dest="filename")
@end example

Si no se proporciona un destino, @ref{a0,,optparse} infiere un destino por defecto adecuado a partir de las cadenas de opción proporcionadas: si la primera cadena de opción larga es @code{--foo-bar}, entonces el destino predeterminado es @code{foo_bar}. Si no hay cadenas de opción largas, @ref{a0,,optparse} mira la primera cadena de opción corta: por ejemplo, el destino predeterminado para @code{-f} es @code{f}.

@ref{a0,,optparse} también incluye el tipo incorporado @code{complex}. La adición de nuevos tipos se cubre en la sección @ref{478a,,Extendiendo el módulo optparse}.

@node Manejo de opciones booleanas flags,Otras acciones,La acción store,Tutorial<4>
@anchor{library/optparse handling-boolean-flag-options}@anchor{478d}@anchor{library/optparse optparse-handling-boolean-options}@anchor{478e}
@subsubsection Manejo de opciones booleanas (flags)


Las opciones flags—establecen una variable en verdadero o falso cuando se encuentra una opción en particular— son bastante comunes. @ref{a0,,optparse} las admite con dos acciones diferenciadas, @code{store_true} y @code{store_false}. Por ejemplo, puedes tener un flag @code{verbose} que se activa con @code{-v} y se desactiva con @code{-q}:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")
@end example

Aquí tenemos dos opciones diferentes con el mismo destino, lo cual es totalmente correcto. Solo significa que debes tener un poco de cuidado al establecer los valores predeterminados, lo veremos a continuación.

Cuando @ref{a0,,optparse} encuentra @code{-v} en la línea de comandos, establece @code{options.verbose} en @code{True}; cuando encuentra @code{-q}, @code{options.verbose} se establece en @code{False}.

@node Otras acciones,Valores por defecto,Manejo de opciones booleanas flags,Tutorial<4>
@anchor{library/optparse optparse-other-actions}@anchor{478f}@anchor{library/optparse other-actions}@anchor{4790}
@subsubsection Otras acciones


Algunas de las otras acciones soportadas por @ref{a0,,optparse} son:


@table @asis

@item @code{"store_const"}

almacena un valor de constante, preestablecida vía @ref{4791,,Option.const}

@item @code{"append"}

agrega el argumento de esta opción a una lista

@item @code{"count"}

incrementa un contador en uno

@item @code{"callback"}

llama a una función específica
@end table

Estas acciones se tratan en la sección @ref{4792,,Guía de referencia} y en la sección @ref{4793,,Retrollamadas de opción}.

@node Valores por defecto,Generando ayuda,Otras acciones,Tutorial<4>
@anchor{library/optparse default-values}@anchor{4794}@anchor{library/optparse optparse-default-values}@anchor{4795}
@subsubsection Valores por defecto


Todos los ejemplos anteriores implican establecer alguna variable (el «destino») cuando aparecen ciertas opciones en la línea de comandos. ¿Qué pasa si esas opciones nunca se encuentran? Dado que no proporcionamos ningún valor predeterminado, todas las variables están establecidas en @code{None}. Por lo general, esto está bien, pero a veces se desea tener más control. @ref{a0,,optparse} permite proporcionar un valor predeterminado para cada destino, que es asignado antes de analizar la línea de comandos.

Primero, considera el ejemplo verbose/quiet anterior. Si queremos que @ref{a0,,optparse} establezca @code{verbose} en @code{True} a menos que encuentre @code{-q}, entonces podemos hacer lo siguiente:

@example
parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")
@end example

Dado que los valores predeterminados se aplican a `destination' en lugar de a cualquier opción en particular y que estas dos opciones tienen el mismo destino, lo anterior es exactamente equivalente a:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)
@end example

Considera lo siguiente:

@example
parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)
@end example

Nuevamente, el valor predeterminado para @code{verbose} será @code{True}: el último valor predeterminado proporcionado para cualquier destino en particular es el único que se tendrá en cuenta.

Una forma más clara de especificar valores predeterminados es el método @code{set_defaults()} de OptionParser, al que puedes llamar en cualquier momento antes de llamar a @ref{150e,,parse_args()}:

@example
parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()
@end example

Como vimos antes, el último valor especificado para un destino de opción dado es el que cuenta. Para mayor claridad, intenta utilizar un método u otro para establecer valores predeterminados, no ambos.

@node Generando ayuda,Imprimir una cadena de caracteres con la versión del programa,Valores por defecto,Tutorial<4>
@anchor{library/optparse generating-help}@anchor{4796}@anchor{library/optparse optparse-generating-help}@anchor{4797}
@subsubsection Generando ayuda


La capacidad de @ref{a0,,optparse} para generar ayuda y texto de uso automáticamente es útil para crear interfaces de línea de comandos fáciles de usar. Todo lo que tienes que hacer es proporcionar un valor @code{help} para cada opción y, opcionalmente, un breve mensaje de uso para el programa en general. A continuación hay un OptionParser al que se le han añadido múltiples opciones fáciles de usar (documentadas):

@example
usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose",
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")
@end example

Si @ref{a0,,optparse} encuentra @code{-h} o @code{--help} en la línea de comandos, o si simplemente se llama al método @code{parser.print_help()}, se imprime lo siguiente en la salida estándar:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]
@end example

(Si la salida de ayuda se activa mediante una opción de ayuda, @ref{a0,,optparse} termina la ejecución después de imprimir el texto de ayuda.)

Estamos haciendo muchas cosas aquí con el fin de ayudar a que @ref{a0,,optparse} genere el mejor mensaje de ayuda posible:


@itemize *

@item 
el script define su propio mensaje de uso:

@example
usage = "usage: %prog [options] arg1 arg2"
@end example

@ref{a0,,optparse} expande @code{% prog} en la cadena de uso reemplazándolo por el nombre del programa actual, es decir, @code{os.path.basename (sys.argv [0])}. A continuación, la cadena expandida se imprime antes de la ayuda detallada de la opción.

Si no proporcionas una cadena de uso, @ref{a0,,optparse} usa un valor predeterminado anodino pero apropiado: @code{"Usage: %prog [options]"}, lo cual está bien si tu script no toma ningún argumento posicional.

@item 
cada opción simplemente define una cadena de ayuda y no se preocupa por el ajuste de línea. @ref{a0,,optparse} se encarga de ajustar las líneas y hacer que la salida de ayuda se vea bien.

@item 
las opciones que toman un valor indican este hecho en su mensaje de ayuda generado automáticamente, por ejemplo, para la opción «mode»:

@example
-m MODE, --mode=MODE
@end example

Aquí, a «MODE» se le denomina una metavariable: representa el argumento que se espera que el usuario proporcione a @code{-m}/@code{--mode}. De forma predeterminada, @ref{a0,,optparse} convierte el nombre de la variable de destino a mayúsculas y lo usa para la metavariable. En ocasiones, eso no es lo que se desea, por ejemplo, la opción @code{--filename} establece explícitamente @code{metavar="FILE"}, lo que da como resultado la siguiente descripción de opción generada automáticamente:

@example
-f FILE, --filename=FILE
@end example

Sin embargo, esto es importante para algo más que para ahorrar espacio: el texto de ayuda escrito manualmente utiliza la metavariable @code{FILE} para indicarle al usuario que hay una conexión entre la sintaxis semiformal @code{-f FILE} y la descripción semántica informal «escribir la salida en FILE». Esta es una manera simple pero efectiva de hacer que tu texto de ayuda sea mucho más claro y útil para los usuarios finales.

@item 
las opciones que tienen un valor predeterminado pueden incluir @code{%default} en la cadena de ayuda, en cuyo caso, @ref{a0,,optparse} lo reemplazará por el resultado de aplicar @ref{237,,str()} al valor por defecto de esa opción. Si una opción no tiene un valor por defecto (o el valor por defecto es @code{None}), @code{%default} se reemplazará por @code{none}.
@end itemize

@menu
* Agrupando opciones:: 

@end menu

@node Agrupando opciones,,,Generando ayuda
@anchor{library/optparse grouping-options}@anchor{4798}
@subsubsection Agrupando opciones


Cuando se trabaja con muchas opciones, suele ser conveniente agruparlas para obtener una mejor salida de ayuda. La clase @ref{150d,,OptionParser} puede contener varios grupos de opciones, cada uno de los cuales puede contener múltiples opciones.

Podemos obtener un grupo de opciones usando la clase @ref{4799,,OptionGroup}:

@geindex OptionGroup (clase en optparse)
@anchor{library/optparse optparse OptionGroup}@anchor{4799}
@deffn {Clase} optparse.OptionGroup (parser, title, description=None)

donde


@itemize *

@item 
`parser' es la instancia de @ref{150d,,OptionParser} en la que se insertará el grupo

@item 
`title' es el título dado al grupo

@item 
`description', opcional, es la descripción larga del grupo
@end itemize
@end deffn

la clase @ref{4799,,OptionGroup} hereda de @code{OptionContainer} (al igual que @ref{150d,,OptionParser}), por lo que el método @code{add_option()} se puede usar para agregar una opción al grupo.

Una vez que se han declarado todas las opciones, usando el método @code{add_option_group()} de la clase @ref{150d,,OptionParser} el grupo se agrega al analizador sintáctico previamente definido.

Agregar un @ref{4799,,OptionGroup} a un analizador es fácil, continuando con el analizador definido en la sección anterior:

@example
group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)
@end example

Esto daría como resultado la siguiente salida de ayuda:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.
@end example

Un ejemplo un poco más completo podría implicar el uso de más de un grupo, ampliando el ejemplo anterior:

@example
group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

group = OptionGroup(parser, "Debug Options")
group.add_option("-d", "--debug", action="store_true",
                 help="Print debug information")
group.add_option("-s", "--sql", action="store_true",
                 help="Print all SQL statements executed")
group.add_option("-e", action="store_true", help="Print every action done")
parser.add_option_group(group)
@end example

lo que da como resultado la siguiente salida:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert
                        [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

  Debug Options:
    -d, --debug         Print debug information
    -s, --sql           Print all SQL statements executed
    -e                  Print every action done
@end example

Otro método interesante, particularmente cuando se trabaja programáticamente con grupos de opciones, es:

@geindex get_option_group() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_option_group}@anchor{479a}
@deffn {Método} OptionParser.get_option_group (opt_str)

Retorna el @ref{4799,,OptionGroup} al que pertenece la cadena de opción corta o larga `opt_str' (por ejemplo, @code{'-o'} o @code{' --option'}). Si no existe dicho @ref{4799,,OptionGroup}, el método retorna @code{None}.
@end deffn

@node Imprimir una cadena de caracteres con la versión del programa,Cómo maneja los errores el módulo optparse,Generando ayuda,Tutorial<4>
@anchor{library/optparse optparse-printing-version-string}@anchor{479b}@anchor{library/optparse printing-a-version-string}@anchor{479c}
@subsubsection Imprimir una cadena de caracteres con la versión del programa


De forma similar a lo que ocurre con la cadena de uso abreviada, @ref{a0,,optparse} también puede imprimir una cadena de versión para tu programa. Debes proporcionar la cadena mediante el argumento @code{version} de OptionParser:

@example
parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
@end example

@code{%prog} se expande al igual que en @code{usage}. Aparte de eso, @code{version} puede contener cualquier cosa que desees. Cuando se proporciona, @ref{a0,,optparse} agrega automáticamente una opción @code{--version} al analizador. Si encuentra esta opción en la línea de comandos, expande la cadena @code{version} (reemplazando @code{%prog}), la imprime en la salida estándar y termina la ejecución.

Por ejemplo, si tu script se llama @code{/usr/bin/foo}:

@example
$ /usr/bin/foo --version
foo 1.0
@end example

Para imprimir y obtener la cadena de caracteres @code{version}, se pueden utilizar cualquiera de los siguientes métodos:

@geindex print_version() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser print_version}@anchor{479d}
@deffn {Método} OptionParser.print_version (file=None)

Imprime el mensaje con la versión del programa actual (@code{self.version}) en `file' (por defecto, la salida estándar). Al igual que con @ref{479e,,print_usage()}, cualquier aparición de @code{%prog} en @code{self.version} se reemplaza con el nombre del programa actual. El método no hace nada si @code{self.version} está vacío o no está definido.
@end deffn

@geindex get_version() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_version}@anchor{479f}
@deffn {Método} OptionParser.get_version ()

Igual que @ref{479d,,print_version()}, pero retorna la cadena de versión en lugar de imprimirla.
@end deffn

@node Cómo maneja los errores el módulo optparse,Reuniendo todas las piezas,Imprimir una cadena de caracteres con la versión del programa,Tutorial<4>
@anchor{library/optparse how-optparse-handles-errors}@anchor{47a0}@anchor{library/optparse optparse-how-optparse-handles-errors}@anchor{47a1}
@subsubsection Cómo maneja los errores el módulo @code{optparse}


A grandes rasgos, hay dos clases de errores de los que @ref{a0,,optparse} tiene que preocuparse: errores del programador y errores del usuario. Los errores del programador suelen ser el resultado de llamadas erróneas a @ref{2cbe,,OptionParser.add_option()}, como cadenas de opción no válidas, atributos de opción desconocidos, atributos de opción que faltan, etc. Se tratan de la forma habitual: generan una excepción (ya sea @ref{2cc1,,optparse.OptionError} o @ref{228,,TypeError}) y hacen que el programa se bloquee.

Manejar los errores del usuario es mucho más importante, ya que está garantizado que sucederán sin importar cuán estable sea el código. @ref{a0,,optparse} puede detectar automáticamente algunos errores del usuario, como argumentos de opción incorrectos (pasar @code{-n 4x} donde @code{-n} toma un argumento entero) o la falta de argumentos (@code{-n} al final de la línea de comandos, donde @code{-n} toma un argumento de cualquier tipo). Además de esto, puedes llamar a @code{OptionParser.error()} para establecer una condición de error definida por la propia aplicación:

@example
(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")
@end example

En cualquier caso, @ref{a0,,optparse} maneja el error de la misma manera: imprime el mensaje de uso del programa junto a un mensaje de error en la salida de errores estándar y termina la ejecución con el estado de error 2.

Considera el primero de los dos ejemplos anteriores, donde el usuario pasa @code{4x} a una opción que toma un número entero:

@example
$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'
@end example

O, en el caso en el que el usuario definitivamente no pase ningún valor:

@example
$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument
@end example

Los mensajes de error generados por @ref{a0,,optparse} tienen siempre cuidado de mencionar la opción involucrada en el error. Asegúrate de hacer lo mismo cuando llames a @code{OptionParser.error()} desde el código de tu aplicación.

Si el comportamiento del manejo de errores predeterminado de @ref{a0,,optparse} no se adapta a tus necesidades, deberás subclasificar OptionParser y redefinir su método @code{exit()} y/o @code{error()}.

@node Reuniendo todas las piezas,,Cómo maneja los errores el módulo optparse,Tutorial<4>
@anchor{library/optparse optparse-putting-it-all-together}@anchor{47a2}@anchor{library/optparse putting-it-all-together}@anchor{47a3}
@subsubsection Reuniendo todas las piezas


Así es como los scripts basados en @ref{a0,,optparse} usualmente se ven:

@example
from optparse import OptionParser
...
def main():
    usage = "usage: %prog [options] arg"
    parser = OptionParser(usage)
    parser.add_option("-f", "--file", dest="filename",
                      help="read data from FILENAME")
    parser.add_option("-v", "--verbose",
                      action="store_true", dest="verbose")
    parser.add_option("-q", "--quiet",
                      action="store_false", dest="verbose")
    ...
    (options, args) = parser.parse_args()
    if len(args) != 1:
        parser.error("incorrect number of arguments")
    if options.verbose:
        print("reading %s..." % options.filename)
    ...

if __name__ == "__main__":
    main()
@end example

@node Guía de referencia,Retrollamadas de opción,Tutorial<4>,optparse — Parser for command line options
@anchor{library/optparse optparse-reference-guide}@anchor{4792}@anchor{library/optparse reference-guide}@anchor{47a4}
@subsubsection Guía de referencia


@menu
* Creando el analizador sintáctico (parser): Creando el analizador sintáctico parser. 
* Completando el analizador con opciones:: 
* Definiendo las opciones:: 
* Atributos de opción:: 
* Acciones de opción estándares:: 
* Tipos de opción estándares:: 
* Analizando los argumentos:: 
* Consultar y manipular el analizador de opciones:: 
* Conflictos entre opciones:: 
* Limpieza:: 
* Otros métodos:: 

@end menu

@node Creando el analizador sintáctico parser,Completando el analizador con opciones,,Guía de referencia
@anchor{library/optparse creating-the-parser}@anchor{47a5}@anchor{library/optparse optparse-creating-parser}@anchor{47a6}
@subsubsection Creando el analizador sintáctico (parser)


El primer paso para poder usar @ref{a0,,optparse} es crear una instancia de OptionParser.

@geindex OptionParser (clase en optparse)
@anchor{library/optparse optparse OptionParser}@anchor{150d}
@deffn {Clase} optparse.OptionParser (...)

El constructor de la clase OptionParser no tiene argumentos obligatorios, pero sí varios argumentos opcionales por palabra clave. Siempre deben pasarse como argumentos por palabras clave, es decir, no se debe confiar nunca en el orden en que se declaran los argumentos.


@table @asis

@item @code{usage} (por defecto: @code{"%prog [options]"})

El resumen de uso a imprimir cuando el programa se ejecuta incorrectamente o con una opción de ayuda. Cuando @ref{a0,,optparse} imprime la cadena de uso, reemplaza @code{%prog} con @code{os.path.basename(sys.argv[0])} (o con @code{prog} si se proporcionó eso argumento por palabra clave). Para suprimir un mensaje de uso, se debe pasar el valor especial @code{optparse.SUPPRESS_USAGE}.

@item @code{option_list} (por defecto: @code{[]})

Una lista de objetos Option con los que poblar el analizador. Las opciones en @code{option_list} se agregan después de cualquier opción en @code{standard_option_list} (un atributo de clase que puede ser establecido por las subclases de OptionParser), pero antes de cualquier versión u opción de ayuda. Obsoleto: usar en su lugar el método @ref{2cbe,,add_option()}, una vez creado el analizador.

@item @code{option_class} (por defecto: `optparse.Option')

Clase usada por el método @ref{2cbe,,add_option()} para añadir opciones al analizador.

@item @code{version} (por defecto: @code{None})

Una cadena de caracteres con la versión del programa a imprimir cuando el usuario proporciona una opción de versión. Si se proporciona un valor verdadero para @code{version}, @ref{a0,,optparse} agrega automáticamente una opción de versión con @code{--version} como única cadena de opción. La subcadena @code{%prog} se expande de la misma manera que en @code{usage}.

@item @code{conflict_handler} (por defecto: @code{"error"})

Especifica qué hacer cuando se agregan al analizador opciones con cadenas de opción en conflicto entre si. Ver sección @ref{47a7,,Conflictos entre opciones}.

@item @code{description} (por defecto: @code{None})

Un párrafo de texto que ofrece una breve descripción del programa. @ref{a0,,optparse} reformatea este párrafo para que se ajuste al ancho actual de la terminal y lo imprime cuando el usuario solicita ayuda (después de @code{usage}, pero antes de la lista de opciones).

@item @code{formatter} (por defecto: una nueva instancia de la clase @code{IndentedHelpFormatter})

Una instancia de la clase optparse.HelpFormatter que será usada para imprimir el texto de ayuda. El módulo @ref{a0,,optparse} proporciona dos clases concretas para este propósito: IndentedHelpFormatter y TitledHelpFormatter.

@item @code{add_help_option} (por defecto: @code{True})

Si es verdadero, @ref{a0,,optparse} agregará al analizador una opción de ayuda (con las cadenas de opción @code{-h} y @code{--help}).

@item @code{prog}

La cadena de caracteres a usar como substituta de @code{os.path.basename(sys.argv[0])} cuando se expanda @code{%prog} en @code{usage} y en @code{version}.

@item @code{epilog} (por defecto: @code{None})

Un párrafo con texto de ayuda que se imprimirá después de la opción de ayuda.
@end table
@end deffn

@node Completando el analizador con opciones,Definiendo las opciones,Creando el analizador sintáctico parser,Guía de referencia
@anchor{library/optparse optparse-populating-parser}@anchor{47a8}@anchor{library/optparse populating-the-parser}@anchor{47a9}
@subsubsection Completando el analizador con opciones


Hay varias formas de agregar las opciones al analizador. La forma preferida es mediante el método @ref{2cbe,,OptionParser.add_option()}, tal como se muestra en la sección del @ref{4782,,Tutorial}. El método @code{add_option()} se puede llamar de dos formas diferentes:


@itemize *

@item 
pasándole una instancia de Option (como la que retorna @code{make_option()})

@item 
pasándole cualquier combinación de argumentos posicionales y por palabra clave que sean aceptables para @code{make_option()} (es decir, para el constructor de la clase Option), lo que creará la instancia Option automáticamente
@end itemize

La otra alternativa es pasar una lista de instancias de Option previamente construidas al constructor OptionParser, como en el siguiente ejemplo:

@example
option_list = [
    make_option("-f", "--filename",
                action="store", type="string", dest="filename"),
    make_option("-q", "--quiet",
                action="store_false", dest="verbose"),
    ]
parser = OptionParser(option_list=option_list)
@end example

(@code{make_option()} es una función fábrica para crear instancias Option. Actualmente es simplemente un alias para el constructor Option, pero es posible que una futura versión de @ref{a0,,optparse} pueda dividir Option en varias clases, en cuyo caso, @code{make_option()} elegirá la clase correcta a instanciar. Esta es la razón por la que no se debe instanciar Option directamente.)

@node Definiendo las opciones,Atributos de opción,Completando el analizador con opciones,Guía de referencia
@anchor{library/optparse defining-options}@anchor{47aa}@anchor{library/optparse optparse-defining-options}@anchor{47ab}
@subsubsection Definiendo las opciones


Cada instancia de Option representa un conjunto de cadenas de opción sinónimas para la línea de comandos, por ejemplo @code{-f} y @code{--file}. Se puede especificar cualquier número de cadenas de opción cortas o largas, pero se debe proporcionar al menos una cadena de opción en total.

La forma canónica de crear una instancia de @ref{47ac,,Option} es mediante el método @code{add_option()} de la clase @ref{150d,,OptionParser}.

@geindex add_option() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser add_option}@anchor{2cbe}
@deffn {Método} OptionParser.add_option (option)

@deffnx {Método} OptionParser.add_option (*opt_str, attr=value, ...)

Para definir una opción con solo una cadena de opción corta:

@example
parser.add_option("-f", attr=value, ...)
@end example

Y para definir una opción con solo una cadena de opción larga:

@example
parser.add_option("--foo", attr=value, ...)
@end example

Los argumentos por palabra clave definen atributos para el nuevo objeto Option. El atributo de opción más importante es @ref{4784,,action}, que determina en gran medida qué otros atributos son apropiados u obligatorios. Si se pasan atributos de opción no apropiados, o no se pasan los requeridos, @ref{a0,,optparse} lanza una excepción @ref{2cc1,,OptionError} explicando el error.

La acción (`action') de una opción determina que hace el módulo @ref{a0,,optparse} cuando encuentra dicha opción en la línea de comandos. Las acciones de opción estándares codificadas en @ref{a0,,optparse} son:


@table @asis

@item @code{"store"}

almacena el argumento de esta opción (por defecto)

@item @code{"store_const"}

almacena un valor de constante, preestablecida vía @ref{4791,,Option.const}

@item @code{"store_true"}

almacena @code{True}

@item @code{"store_false"}

almacena @code{False}

@item @code{"append"}

agrega el argumento de esta opción a una lista

@item @code{"append_const"}

agrega un valor constante a una lista, preestablecido vía @ref{4791,,Option.const}

@item @code{"count"}

incrementa un contador en uno

@item @code{"callback"}

llama a una función específica

@item @code{"help"}

imprime un mensaje de uso que incluye todas las opciones y la documentación correspondiente
@end table

(Si no se proporciona una acción, el valor predeterminado es @code{"store"}. Para esta acción en concreto, también se pueden proporcionar los atributos de opción @ref{4785,,type} y @ref{4786,,dest}. Consultar @ref{47ad,,Acciones de opción estándares} para más información.)
@end deffn

Como se puede observar, la mayoría de las acciones implican almacenar o actualizar un valor en algún lugar. @ref{a0,,optparse} siempre crea un objeto especial para esto, convencionalmente llamado @code{options}, que resulta ser una instancia de @ref{2cc0,,optparse.Values}.

@geindex Values (clase en optparse)
@anchor{library/optparse optparse Values}@anchor{2cc0}
@deffn {Clase} optparse.Values

Un objeto que mantiene como atributos a los nombres de los argumentos y los valores analizados. Normalmente se crean por invocación cuando llamamos @ref{150e,,OptionParser.parse_args()}, y pueden ser sobreescritos por una subclase personalizada pasada al argumento `values' de @ref{150e,,OptionParser.parse_args()} (como se describe en @ref{47ae,,Analizando los argumentos}).
@end deffn

Los argumentos de opción (y algunos otros valores) se almacenan como atributos de este objeto, de acuerdo con el atributo de opción @code{dest} (destino) establecido.

Por ejemplo, cuando se llama a:

@example
parser.parse_args()
@end example

una de las primeras cosas que hace el módulo @ref{a0,,optparse} es crear el objeto @code{options}:

@example
options = Values()
@end example

Si una de las opciones de este analizador es definida con:

@example
parser.add_option("-f", "--file", action="store", type="string", dest="filename")
@end example

y la línea de comandos que se analiza incluye cualquiera de las siguientes variantes:

@example
-ffoo
-f foo
--file=foo
--file foo
@end example

entonces el módulo @ref{a0,,optparse}, al encontrar esta opción, hará algo equivalente a:

@example
options.filename = "foo"
@end example

Los atributos de opción @ref{4785,,type} y @ref{4786,,dest} son casi tan importantes como @ref{4784,,action}, pero @ref{4784,,action} es el único de ellos que es apropiado para `todas' las opciones.

@node Atributos de opción,Acciones de opción estándares,Definiendo las opciones,Guía de referencia
@anchor{library/optparse option-attributes}@anchor{47af}@anchor{library/optparse optparse-option-attributes}@anchor{47b0}
@subsubsection Atributos de opción


@geindex Option (clase en optparse)
@anchor{library/optparse optparse Option}@anchor{47ac}
@deffn {Clase} optparse.Option

Un único argumento de línea de comando, con varios atributos pasados como palabras clave al constructor. Normalmente se crea con @ref{2cbe,,OptionParser.add_option()} en lugar de directamente, y puede ser sobrescrito por una clase personalizada mediante el argumento `option_class' de @ref{150d,,OptionParser}.
@end deffn

Los siguientes atributos de opción pueden pasarse como argumentos por palabra clave al método @ref{2cbe,,OptionParser.add_option()}. Si se pasa un atributo de opción que no es apropiado para una opción en particular, o no se pasa un atributo de opción obligatorio, @ref{a0,,optparse} lanza una excepción @ref{2cc1,,OptionError}.

@geindex action (atributo de optparse.Option)
@anchor{library/optparse optparse Option action}@anchor{4784}
@deffn {Atributo} Option.action

(por defecto: @code{"store"})

Determina el comportamiento del módulo @ref{a0,,optparse} cuando esta opción se encuentra en la línea de comandos. Las opciones disponibles están documentadas @ref{47ad,,aquí}.
@end deffn

@geindex type (atributo de optparse.Option)
@anchor{library/optparse optparse Option type}@anchor{4785}
@deffn {Atributo} Option.type

(por defecto: @code{"string"})

El tipo de argumento esperado para esta opción (por ejemplo, @code{"string"} o @code{"int"}). Los tipos de opción disponibles están documentados @ref{47b1,,aquí}.
@end deffn

@geindex dest (atributo de optparse.Option)
@anchor{library/optparse optparse Option dest}@anchor{4786}
@deffn {Atributo} Option.dest

(por defecto: derivado de las cadenas de opción)

Si la acción asociada a la opción implica escribir o modificar un valor en algún lugar, este atributo le dice a @ref{a0,,optparse} dónde escribirlo: @ref{4786,,dest} es el nombre de un atributo del objeto @code{options} que @ref{a0,,optparse} construye a medida que analiza la línea de comandos.
@end deffn

@geindex default (atributo de optparse.Option)
@anchor{library/optparse optparse Option default}@anchor{47b2}
@deffn {Atributo} Option.default

El valor que se utilizará como destino de esta opción si la opción no aparece en la línea de comandos. Ver también @ref{47b3,,OptionParser.set_defaults()}.
@end deffn

@geindex nargs (atributo de optparse.Option)
@anchor{library/optparse optparse Option nargs}@anchor{47b4}
@deffn {Atributo} Option.nargs

(por defecto: 1)

Cuántos argumentos de tipo @ref{4785,,type} deben consumirse cuando se encuentre esta opción. Si es mayor a 1, @ref{a0,,optparse} almacenará una tupla con los valores de los argumentos en @ref{4786,,dest}.
@end deffn

@geindex const (atributo de optparse.Option)
@anchor{library/optparse optparse Option const}@anchor{4791}
@deffn {Atributo} Option.const

Para acciones que almacenan un valor constante, el valor constante a almacenar.
@end deffn

@geindex choices (atributo de optparse.Option)
@anchor{library/optparse optparse Option choices}@anchor{47b5}
@deffn {Atributo} Option.choices

Para opciones de tipo @code{"choice"}, la lista con las cadenas que el usuario puede elegir.
@end deffn

@geindex callback (atributo de optparse.Option)
@anchor{library/optparse optparse Option callback}@anchor{47b6}
@deffn {Atributo} Option.callback

Para las opciones con la acción @code{"callback"} asignada, el objeto invocable a llamar cuando se encuentra esta opción. Consultar la sección @ref{4793,,Retrollamadas de opción} para obtener más detalles sobre los argumentos que son pasados al objeto invocable.
@end deffn

@geindex callback_args (atributo de optparse.Option)
@geindex callback_kwargs (atributo de optparse.Option)
@anchor{library/optparse optparse Option callback_args}@anchor{47b7}
@deffn {Atributo} Option.callback_args
@anchor{library/optparse optparse Option callback_kwargs}@anchor{47b8}
@deffnx {Atributo} Option.callback_kwargs

Argumentos posicionales y por palabra clave adicionales para ser pasados a @code{callback} después de los cuatro argumentos pasados a la retrollamada estándar.
@end deffn

@geindex help (atributo de optparse.Option)
@anchor{library/optparse optparse Option help}@anchor{4787}
@deffn {Atributo} Option.help

Texto de ayuda a imprimir para esta opción cuando se enumeran todas las opciones disponibles, después de que el usuario proporcione una opción @ref{4787,,help} (como @code{--help}). Si no se proporciona ningún texto de ayuda, la opción seguirá apareciendo, solo que sin texto de ayuda. Para ocultar esta opción completamente, se debe asignar al atributo el valor especial @code{optparse.SUPPRESS_HELP}.
@end deffn

@geindex metavar (atributo de optparse.Option)
@anchor{library/optparse optparse Option metavar}@anchor{47b9}
@deffn {Atributo} Option.metavar

(por defecto: derivado de las cadenas de opción)

Reemplazo para los argumentos de opción que se utilizará al imprimir el texto de ayuda. Consultar la sección @ref{4782,,Tutorial} para ver un ejemplo.
@end deffn

@node Acciones de opción estándares,Tipos de opción estándares,Atributos de opción,Guía de referencia
@anchor{library/optparse optparse-standard-option-actions}@anchor{47ad}@anchor{library/optparse standard-option-actions}@anchor{47ba}
@subsubsection Acciones de opción estándares


Las diversas acciones de opción tienen requisitos y efectos ligeramente diferentes. La mayoría de las acciones tienen varios atributos de opción relacionados que puedes especificar para dirigir el comportamiento del módulo @ref{a0,,optparse}. Además, algunas de ellas tienen atributos requeridos, que se deben especificar para cualquier opción que utilice esa acción.


@itemize *

@item 
@code{"store"} [atributos relacionados: @ref{4785,,type}, @ref{4786,,dest}, @ref{47b4,,nargs}, @ref{47b5,,choices}]

La opción debe ir seguida de un argumento, que se convierte en un valor de acuerdo a @ref{4785,,type} y se almacena en @ref{4786,,dest}. Si @ref{47b4,,nargs} es mayor que 1, se consumirán varios argumentos de la línea de comandos. Todos ellos se convertirán de acuerdo a @ref{4785,,type} y se almacenarán en @ref{4786,,dest} como una tupla. Consultar la sección @ref{47b1,,Tipos de opción estándares} para más información.

Si se proporciona @ref{47b5,,choices} (una lista o tupla de cadenas de caracteres), el tipo por defecto es @code{"choice"}.

Si no se proporciona @ref{4785,,type}, el tipo por defecto es @code{"string"}.

Si @ref{4786,,dest} no se proporciona, @ref{a0,,optparse} infiere un destino de la primera cadena de opción larga (por ejemplo, @code{--foo-bar} implica que se usará @code{foo_bar} como destino). Si no hay cadenas de opción largas, @ref{a0,,optparse} obtiene el destino a partir de la primera cadena de opción corta (por ejemplo, @code{-f} conlleva que se usará @code{f}).

Ejemplo:

@example
parser.add_option("-f")
parser.add_option("-p", type="float", nargs=3, dest="point")
@end example

Mientras analiza la línea de comandos:

@example
-f foo.txt -p 1 -3.5 4 -fbar.txt
@end example

@ref{a0,,optparse} establecerá:

@example
options.f = "foo.txt"
options.point = (1.0, -3.5, 4.0)
options.f = "bar.txt"
@end example

@item 
@code{"store_const"} [atributo requerido: @ref{4791,,const}; atributo relacionado: @ref{4786,,dest}]

El valor @ref{4791,,const} es almacenado en @ref{4786,,dest}.

Ejemplo:

@example
parser.add_option("-q", "--quiet",
                  action="store_const", const=0, dest="verbose")
parser.add_option("-v", "--verbose",
                  action="store_const", const=1, dest="verbose")
parser.add_option("--noisy",
                  action="store_const", const=2, dest="verbose")
@end example

Si se encuentra @code{--noisy}, @ref{a0,,optparse} establecerá:

@example
options.verbose = 2
@end example

@item 
@code{"store_true"} [atributo relacionado: @ref{4786,,dest}]

Un caso especial de @code{"store_const"} que almacena @code{True} en @ref{4786,,dest}.

@item 
@code{"store_false"} [atributo relacionado: @ref{4786,,dest}]

Como @code{"store_true"}, pero almacena @code{False}.

Ejemplo:

@example
parser.add_option("--clobber", action="store_true", dest="clobber")
parser.add_option("--no-clobber", action="store_false", dest="clobber")
@end example

@item 
@code{"append"} [atributos relacionados: @ref{4785,,type}, @ref{4786,,dest}, @ref{47b4,,nargs}, @ref{47b5,,choices}]

La opción debe ir seguida de un argumento, que se añade a la lista de @ref{4786,,dest}. Si no se proporciona un valor predeterminado para @ref{4786,,dest}, se crea automáticamente una lista vacía cuando @ref{a0,,optparse} encuentra por primera vez esta opción en la línea de comandos. Si @ref{47b4,,nargs} es mayor que 1, se consumen varios argumentos y se agrega una tupla de longitud @ref{47b4,,nargs} a @ref{4786,,dest}.

Los valores por defecto para los atributos @ref{4785,,type} y @ref{4786,,dest} son los mismos que para la acción @code{"store"}.

Ejemplo:

@example
parser.add_option("-t", "--tracks", action="append", type="int")
@end example

Si se encuentra @code{-t3} en la línea de comandos, @ref{a0,,optparse} procede de forma equivalente a:

@example
options.tracks = []
options.tracks.append(int("3"))
@end example

Si, un poco más adelante, se encuentra @code{--tracks=4}, procede así:

@example
options.tracks.append(int("4"))
@end example

La acción @code{append} llama al método @code{append} con el valor actual de la opción. Esto significa que cualquier valor por defecto especificado debe tener un método @code{append}. También significa que si existe un valor por defecto, los elementos por defecto estarán presentes en el valor analizado para la opción, con todos los valores de la línea de comandos agregados a la lista a continuación de ellos:

@example
>>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
>>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
>>> opts.files
['~/.mypkg/defaults', 'overrides.mypkg']
@end example

@item 
@code{"append_const"} [atributo requerido: @ref{4791,,const}; atributo relacionado: @ref{4786,,dest}]

Igual que @code{"store_const"}, pero el valor @ref{4791,,const} se agrega a @ref{4786,,dest}. Como ocurre con @code{"append"}, @ref{4786,,dest} por defecto es @code{None} y se crea automáticamente una lista vacía la primera vez que se encuentra la opción en la linea de comandos.

@item 
@code{"count"} [atributo relacionado: @ref{4786,,dest}]

Incrementa el entero almacenado en @ref{4786,,dest}. Si no se proporciona un valor por defecto, @ref{4786,,dest} se establece en cero antes de incrementarse por primera vez.

Ejemplo:

@example
parser.add_option("-v", action="count", dest="verbosity")
@end example

La primera vez que se encuentra @code{-v} en la línea de comandos, @ref{a0,,optparse} procede de forma equivalente a:

@example
options.verbosity = 0
options.verbosity += 1
@end example

Cada aparición posterior de @code{-v} da como resultado:

@example
options.verbosity += 1
@end example

@item 
@code{"callback"} [atributo requerido: @ref{47b6,,callback}; atributos relacionados: @ref{4785,,type}, @ref{47b4,,nargs}, @ref{47b7,,callback_args}, @ref{47b8,,callback_kwargs}]

Llama a la función especificada por @ref{47b6,,callback}, que es llamada como:

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

Ver sección @ref{4793,,Retrollamadas de opción} para más detalles.

@item 
@code{"help"}

Imprime un mensaje de ayuda completo para todas las opciones presentes en el analizador de opciones actual. El mensaje de ayuda se construye a partir de la cadena @code{usage}, pasada al constructor de OptionParser, y la cadena @ref{4787,,help}, pasada a cada opción.

Si no se proporciona una cadena @ref{4787,,help} para una opción, dicha opción seguirá apareciendo en el mensaje de ayuda. Para omitir una opción por completo, debe usarse el valor especial @code{optparse.SUPPRESS_HELP}.

El módulo @ref{a0,,optparse} agrega automáticamente una opción @ref{4787,,help} a todos los OptionParsers, por lo que normalmente no es necesario crear una.

Ejemplo:

@example
from optparse import OptionParser, SUPPRESS_HELP

# usually, a help option is added automatically, but that can
# be suppressed using the add_help_option argument
parser = OptionParser(add_help_option=False)

parser.add_option("-h", "--help", action="help")
parser.add_option("-v", action="store_true", dest="verbose",
                  help="Be moderately verbose")
parser.add_option("--file", dest="filename",
                  help="Input file to read data from")
parser.add_option("--secret", help=SUPPRESS_HELP)
@end example

Si @ref{a0,,optparse} encuentra @code{-h} o @code{--help} en la línea de comandos, imprimirá un mensaje de ayuda en la salida estándar como el siguiente (asumiendo que @code{sys.argv [0]} es @code{"foo.py"}):

@example
Usage: foo.py [options]

Options:
  -h, --help        Show this help message and exit
  -v                Be moderately verbose
  --file=FILENAME   Input file to read data from
@end example

Después de imprimir el mensaje de ayuda, @ref{a0,,optparse} termina su proceso con @code{sys.exit(0)}.

@item 
@code{"version"}

Imprime el número de versión proporcionado a OptionParser en la salida estándar y termina la ejecución. El número de versión en realidad es formateado e impreso por el método @code{print_version()} de OptionParser. Generalmente solo es relevante si el argumento @code{version} se proporciona al constructor de OptionParser. Al igual que en el caso de las opciones @ref{4787,,help}, rara vez será necesario crear opciones de @code{version}, ya que @ref{a0,,optparse} las agrega automáticamente cuando es necesario.
@end itemize

@node Tipos de opción estándares,Analizando los argumentos,Acciones de opción estándares,Guía de referencia
@anchor{library/optparse optparse-standard-option-types}@anchor{47b1}@anchor{library/optparse standard-option-types}@anchor{47bb}
@subsubsection Tipos de opción estándares


El módulo @ref{a0,,optparse} proporciona cinco tipos de opción incorporados: @code{"string"}, @code{"int"}, @code{"choice"}, @code{"float"} y @code{"complex"}. Consultar la sección @ref{478a,,Extendiendo el módulo optparse} si se necesitan agregar nuevos tipos de opción.

Los argumentos de las opciones en la cadena ingresada no se verifican ni se convierten de ninguna manera: el texto de la línea de comandos se almacena en el destino (o se pasa a la retrollamada) tal cual.

Los argumentos enteros (tipo @code{"int"}) se analizan de la siguiente manera:


@itemize *

@item 
si el número comienza con @code{0x}, se analiza como un número hexadecimal

@item 
si el número comienza con @code{0}, se analiza como un número octal

@item 
si el número comienza con @code{0b}, se analiza como un número binario

@item 
en cualquier otro caso, el número se analiza como un número decimal
@end itemize

La conversión se realiza llamando a @ref{1f0,,int()} con la base apropiada (2, 8, 10 o 16). Si esto falla, también lo hará @ref{a0,,optparse}, aunque mostrando un mensaje de error más útil para el usuario.

Los argumentos de las opciones de tipo @code{"float"} y @code{"complex"} se convierten directamente usando @ref{153,,float()} y @ref{154,,complex()} respectivamente, con un manejo de errores similar.

Las opciones de tipo @code{"choice"} son un subtipo de las opciones @code{"string"}. El atributo de opción @ref{47b5,,choices} (que es una secuencia de cadenas) define el conjunto de argumentos de opción permitidos. Posteriormente, @code{optparse.check_choice()} comparará los argumentos de las opciones proporcionadas por el usuario con esta lista maestra y lanzará una excepción @ref{2cc2,,OptionValueError} si se proporciona una cadena no válida.

@node Analizando los argumentos,Consultar y manipular el analizador de opciones,Tipos de opción estándares,Guía de referencia
@anchor{library/optparse optparse-parsing-arguments}@anchor{47ae}@anchor{library/optparse parsing-arguments}@anchor{47bc}
@subsubsection Analizando los argumentos


El objetivo primario de crear y agregar opciones a un OptionParser es llamar a su método @ref{150e,,parse_args()}.

@geindex parse_args() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser parse_args}@anchor{150e}
@deffn {Método} OptionParser.parse_args (args=None, values=None)

Analiza las opciones de la línea de comando encontradas en `args'.

Los parámetros de entrada son


@table @asis

@item @code{args}

la lista de argumentos a procesar (por defecto: @code{sys.argv [1:]})

@item @code{values}

a @ref{2cc0,,Values} object to store option arguments in (default: a
new instance of @ref{2cc0,,Values}) – if you give an existing object, the
option defaults will not be initialized on it
@end table

y los valores de retorno es un par @code{(options, args)} donde


@table @asis

@item @code{options}

el mismo objeto que se pasó como `values', o la instancia @code{optparse.Values} creada por @ref{a0,,optparse}

@item @code{args}

los argumentos posicionales que quedan en la linea de comandos después de que se hayan procesado todas las opciones
@end table
@end deffn

El uso más habitual es no proporcionar ningún argumento por palabra clave. Si se proporciona @code{values}, dicho argumento será modificado mediante llamadas repetidas a @ref{215f,,setattr()} (aproximadamente una por cada argumento de opción a almacenar en un destino de opción) y finalmente será retornado por el método @ref{150e,,parse_args()}.

Si el método @ref{150e,,parse_args()} encuentra algún error en la lista de argumentos, llama al método @code{error()} de OptionParser con un mensaje de error apropiado para el usuario final. Esto causa que el proceso termine con un estado de salida de 2 (el estado de salida tradicional en Unix para errores en la línea de comandos).

@node Consultar y manipular el analizador de opciones,Conflictos entre opciones,Analizando los argumentos,Guía de referencia
@anchor{library/optparse optparse-querying-manipulating-option-parser}@anchor{47bd}@anchor{library/optparse querying-and-manipulating-your-option-parser}@anchor{47be}
@subsubsection Consultar y manipular el analizador de opciones


El comportamiento predeterminado del analizador de opciones se puede personalizar ligeramente. También se puede indagar en el analizador de opciones y ver qué hay en él. OptionParser proporciona varios métodos para ayudar con éstos propósitos:

@geindex disable_interspersed_args() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser disable_interspersed_args}@anchor{2cbf}
@deffn {Método} OptionParser.disable_interspersed_args ()

Configura el análisis para que se detenga en lo primero que encuentre que no sea una opción. Por ejemplo, si @code{-a} y @code{-b} son opciones simples que no toman argumentos, @ref{a0,,optparse} normalmente acepta esta sintaxis:

@example
prog -a arg1 -b arg2
@end example

y la trata de forma equivalente a:

@example
prog -a -b arg1 arg2
@end example

Para deshabilitar esta funcionalidad, se debe llamar al método @ref{2cbf,,disable_interspersed_args()}. Esto restaura la sintaxis tradicional usada en Unix, donde el análisis de opción se detiene con el primer argumento que no es una opción.

Se debe usar este método si se dispone de un procesador de comandos que ejecuta otro comando con sus propias opciones y se desea asegurarse de que estas opciones no se confunden entre si. Lo que puede ocurrir si, por ejemplo, cada comando tiene un conjunto diferente de opciones.
@end deffn

@geindex enable_interspersed_args() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser enable_interspersed_args}@anchor{47bf}
@deffn {Método} OptionParser.enable_interspersed_args ()

Configura el análisis para que no se detenga si encuentra un argumento que no sea una opción, lo que permite intercalar modificadores con argumentos de linea de comandos. Este es el comportamiento por defecto.
@end deffn

@geindex get_option() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_option}@anchor{47c0}
@deffn {Método} OptionParser.get_option (opt_str)

Retorna la instancia de Option con la cadena de opción `opt_str', o @code{None} si ninguna opción tiene esa cadena de opción.
@end deffn

@geindex has_option() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser has_option}@anchor{47c1}
@deffn {Método} OptionParser.has_option (opt_str)

Retorna @code{True} si OptionParser tiene una opción con la cadena de opción `opt_str' (por ejemplo, @code{-q} o @code{--verbose}).
@end deffn

@geindex remove_option() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser remove_option}@anchor{47c2}
@deffn {Método} OptionParser.remove_option (opt_str)

Si @ref{150d,,OptionParser} tiene una opción correspondiente a `opt_str', esa opción es eliminada. Si esa opción proporcionó cualquier otra cadena de opción, todas esas cadenas de opción quedan invalidadas. Si `opt_str' no aparece en ninguna opción que pertenezca a este @ref{150d,,OptionParser}, se lanza una excepción @ref{360,,ValueError}.
@end deffn

@node Conflictos entre opciones,Limpieza,Consultar y manipular el analizador de opciones,Guía de referencia
@anchor{library/optparse conflicts-between-options}@anchor{47c3}@anchor{library/optparse optparse-conflicts-between-options}@anchor{47a7}
@subsubsection Conflictos entre opciones


Si no se tiene cuidado, es fácil definir opciones con cadenas de opción en conflicto entre si:

@example
parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)
@end example

(Esto es particularmente cierto si se ha definido una subclase propia de OptionParser con algunas opciones estándar.)

Cada vez que se agrega una opción, @ref{a0,,optparse} comprueba si existen conflictos con las opciones ya existentes. Si encuentra alguno, invoca el mecanismo de manejo de conflictos actualmente establecido. Se puede establecer el mecanismo de manejo de conflictos desde el propio constructor:

@example
parser = OptionParser(..., conflict_handler=handler)
@end example

o mediante una llamada separada:

@example
parser.set_conflict_handler(handler)
@end example

Los administradores de conflictos disponibles son:

@quotation


@table @asis

@item @code{"error"} (por defecto)

se asume que los conflictos entre opciones son un error de programación y, por tanto, generarán una excepción @ref{47c4,,OptionConflictError}

@item @code{"resolve"}

resuelve conflictos de opciones de forma inteligente (ver más abajo)
@end table
@end quotation

Como ejemplo, vamos a definir un @ref{150d,,OptionParser} que resuelva conflictos de manera inteligente y agregaremos algunas opciones conflictivas:

@example
parser = OptionParser(conflict_handler="resolve")
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")
@end example

En este punto, @ref{a0,,optparse} detecta que una opción agregada anteriormente ya está usando la cadena de opción @code{-n}. Dado que @code{conflict_handler} es @code{"resolve"}, resuelve la situación eliminando @code{-n} de la lista de cadenas de opción de la opción previa. Ahora @code{--dry-run} es la única forma que el usuario tiene para poder activar esa opción. Si el usuario solicita ayuda, el mensaje de ayuda reflejará la nueva situación:

@example
Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy
@end example

Es posible reducir las cadenas de opción para una opción agregada previamente hasta que no quede ninguna, de forma que el usuario no tenga forma de invocar esa opción desde la línea de comandos. En ese caso, @ref{a0,,optparse} eliminará esa opción por completo, por lo que no aparecerá en el texto de ayuda ni en ningún otro lugar. Continuando con nuestro analizador de opciones existente OptionParser:

@example
parser.add_option("--dry-run", ..., help="new dry-run option")
@end example

En este punto, la opción original @code{-n}/@code{--dry-run} ya no es accesible, por lo que @ref{a0,,optparse} la elimina, dejando el siguiente texto de ayuda:

@example
Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option
@end example

@node Limpieza,Otros métodos,Conflictos entre opciones,Guía de referencia
@anchor{library/optparse cleanup}@anchor{47c5}@anchor{library/optparse optparse-cleanup}@anchor{47c6}
@subsubsection Limpieza


Las instancias de OptionParser tienen varias referencias cíclicas. Esto no debería ser un problema para el recolector de basura de Python, pero es posible que se desee romper las referencias cíclicas explícitamente llamando al método @code{destroy()} de la instancia OptionParser una vez que se haya terminado. Esto es particularmente útil en aplicaciones de larga ejecución en las que OptionParser puede terminar accediendo a grafos de objetos considerablemente grandes.

@node Otros métodos,,Limpieza,Guía de referencia
@anchor{library/optparse optparse-other-methods}@anchor{47c7}@anchor{library/optparse other-methods}@anchor{47c8}
@subsubsection Otros métodos


OptionParser admite varios métodos públicos más:

@geindex set_usage() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser set_usage}@anchor{47c9}
@deffn {Método} OptionParser.set_usage (usage)

Establece la cadena de caracteres de uso de acuerdo a las reglas descritas anteriormente para el argumento por palabra clave @code{usage} del constructor. Pasando @code{None} se establece la cadena de uso por defecto; use el valor especial @code{optparse.SUPPRESS_USAGE} para suprimir el mensaje de uso.
@end deffn

@geindex print_usage() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser print_usage}@anchor{479e}
@deffn {Método} OptionParser.print_usage (file=None)

Imprime el mensaje de uso del programa actual (@code{self.usage}) en `file' (que por defecto es la salida estándar). Cualquier aparición de la cadena de caracteres @code{%prog} en @code{self.usage} es reemplazada con el nombre del programa actual. No hace nada si @code{self.usage} está vacío o no ha sido definido.
@end deffn

@geindex get_usage() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_usage}@anchor{47ca}
@deffn {Método} OptionParser.get_usage ()

Igual que @ref{479e,,print_usage()} pero retorna la cadena de uso en vez de imprimirla.
@end deffn

@geindex set_defaults() (método de optparse.OptionParser)
@anchor{library/optparse optparse OptionParser set_defaults}@anchor{47b3}
@deffn {Método} OptionParser.set_defaults (dest=value, ...)

Establece valores por defecto para varios destinos de opción a la vez. Usar el método @ref{47b3,,set_defaults()} es la forma preferida de establecer valores por defecto para las opciones, ya que varias opciones pueden compartir el mismo destino. Por ejemplo, si varias opciones de @code{mode} tienen el mismo destino, cualquiera de ellas puede establecer el valor por defecto, pero el último establecido es el que finalmente queda establecido:

@example
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # overridden below
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # overrides above setting
@end example

Para evitar esta confusión, usa el método @ref{47b3,,set_defaults()}:

@example
parser.set_defaults(mode="advanced")
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced")
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice")
@end example
@end deffn

@node Retrollamadas de opción,Extendiendo el módulo optparse,Guía de referencia,optparse — Parser for command line options
@anchor{library/optparse option-callbacks}@anchor{47cb}@anchor{library/optparse optparse-option-callbacks}@anchor{4793}
@subsubsection Retrollamadas de opción


Cuando las acciones y tipos incorporados de @ref{a0,,optparse} no son suficientes para tus necesidades, tienes dos opciones: extender @ref{a0,,optparse} o definir una opción con una retrollamada asociada. Extender @ref{a0,,optparse} es más general, pero algo exagerado para muchos casos simples. Es frecuente que una simple retrollamada sea todo lo que necesitas.

Hay dos pasos a seguir para definir una opción con retrollamada:


@itemize *

@item 
definir la opción en sí usando la acción @code{"callback"}

@item 
escribir la retrollamada. Esta es una función (o método) que toma al menos cuatro argumentos, los cuales son descritos a continuación
@end itemize

@menu
* Definición de una opción con retrollamada:: 
* Cómo son invocadas las retrollamadas:: 
* Lanzando errores en una retrollamada:: 
* Ejemplo de retrollamada 1; una retrollamada trivial: Ejemplo de retrollamada 1 una retrollamada trivial. 
* Ejemplo de retrollamada 2; comprobar el orden de las opciones: Ejemplo de retrollamada 2 comprobar el orden de las opciones. 
* Ejemplo de retrollamada 3; comprobar el orden de las opciones (generalizado): Ejemplo de retrollamada 3 comprobar el orden de las opciones generalizado. 
* Ejemplo de retrollamada 4; comprobar una condición arbitraria: Ejemplo de retrollamada 4 comprobar una condición arbitraria. 
* Ejemplo de retrollamada 5; argumentos fijos: Ejemplo de retrollamada 5 argumentos fijos. 
* Ejemplo de retrollamada 6; argumentos variables: Ejemplo de retrollamada 6 argumentos variables. 

@end menu

@node Definición de una opción con retrollamada,Cómo son invocadas las retrollamadas,,Retrollamadas de opción
@anchor{library/optparse defining-a-callback-option}@anchor{47cc}@anchor{library/optparse optparse-defining-callback-option}@anchor{47cd}
@subsubsection Definición de una opción con retrollamada


Generalmente, la forma más sencilla de definir una opción con retrollamada es mediante el método @ref{2cbe,,OptionParser.add_option()}. Aparte de @ref{4784,,action}, el único atributo de opción que debes especificar es @code{callback}, que es la función a llamar:

@example
parser.add_option("-c", action="callback", callback=my_callback)
@end example

@code{callback} es una función (u otro objeto invocable), lo que implica que @code{my_callback()} debe haber sido definida antes de la la creación de esta opción con retrollamada. En este caso simple, @ref{a0,,optparse} ni siquiera sabe si @code{-c} toma algún argumento, lo que generalmente significa que la opción no toma argumentos—la mera presencia de @code{-c} en la línea de comandos es todo lo que necesita saber. Sin embargo, en algunas circunstancias, es posible que se desee que la retrollamada consuma una cantidad arbitraria de argumentos de la propia línea de comandos. Es aquí donde escribir retrollamadas se vuelve complicado; se tratará más adelante en esta sección.

@ref{a0,,optparse} siempre pasa cuatro argumentos concretos a la retrollamada. El método solo pasará argumentos adicionales si se especifica explícitamente a través de @ref{47b7,,callback_args} y @ref{47b8,,callback_kwargs}. Por lo tanto, la firma mínima de la retrollamada es:

@example
def my_callback(option, opt, value, parser):
@end example

Los cuatro argumentos para la retrollamada se describen a continuación.

Hay varios atributos de opción adicionales que se pueden proporcionar cuando se define una opción con retrollamada:


@table @asis

@item @ref{4785,,type}

tiene su significado habitual: al igual que en las acciones @code{"store"} o @code{"append"}, indica a @ref{a0,,optparse} que debe consumir un argumento y convertirlo a @ref{4785,,type} . Sin embargo, en lugar de almacenar el valor (o valores) convertido en algún lugar, @ref{a0,,optparse} lo pasa a la retrollamada.

@item @ref{47b4,,nargs}

también tiene su significado habitual: si se proporciona y es mayor que 1, @ref{a0,,optparse} consumirá @ref{47b4,,nargs} argumentos de la línea de comandos, cada uno de los cuales debe ser convertible a @ref{4785,,type}. Hecho esto, se pasa una tupla con los valores convertidos a la retrollamada.

@item @ref{47b7,,callback_args}

una tupla con los argumentos posicionales adicionales para pasar a la retrollamada

@item @ref{47b8,,callback_kwargs}

un diccionario con los argumentos por palabra clave para pasar a la retrollamada
@end table

@node Cómo son invocadas las retrollamadas,Lanzando errores en una retrollamada,Definición de una opción con retrollamada,Retrollamadas de opción
@anchor{library/optparse how-callbacks-are-called}@anchor{47ce}@anchor{library/optparse optparse-how-callbacks-called}@anchor{47cf}
@subsubsection Cómo son invocadas las retrollamadas


Todas las retrollamadas son invocadas de la siguiente forma:

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

donde


@table @asis

@item @code{option}

es la instancia de Option que invoca a la retrollamada

@item @code{opt_str}

es la cadena de opción encontrada en la línea de comandos que activa la retrollamada. (Si se utilizó una opción larga abreviada, @code{opt_str} será la cadena de opción canónica completa— por ejemplo, si el usuario ingresa @code{--foo} en la línea de comandos como una abreviatura de @code{--foobar}, entonces @code{opt_str} será @code{"--foobar"}.)

@item @code{value}

es el argumento de esta opción encontrado en la línea de comandos. @ref{a0,,optparse} solo esperará un argumento si @ref{4785,,type} está establecido. El tipo de @code{value} será el tipo implícito en el tipo de la propia opción. Si @ref{4785,,type} es @code{None} para esta opción (no se espera ningún argumento), entonces @code{value} será también @code{None}. Si @ref{47b4,,nargs} es mayor que 1, @code{value} será una tupla con los valores del tipo apropiado.

@item @code{parser}

es la instancia de OptionParser que controla todo. Su utilidad principal radica en que permite acceder a otros datos de interés a través de sus atributos de instancia:


@table @asis

@item @code{parser.largs}

la lista actual de argumentos que sobran, es decir, argumentos que se han consumido pero que no son opciones ni argumentos de opción. Siéntete libre de modificar @code{parser.largs}, por ejemplo, agregando más argumentos. (Esta lista se convertirá en @code{args}, el segundo valor de retorno del método @ref{150e,,parse_args()}.)

@item @code{parser.rargs}

la lista actual de argumentos restantes, es decir, los argumentos que quedan a continuación de @code{opt_str} y @code{value} (si corresponde), una vez eliminados ambos. Siéntete libre de modificar @code{parser.rargs}, por ejemplo, consumiendo más argumentos.

@item @code{parser.values}

el objeto donde los valores de las opciones son almacenados por defecto (una instancia de `optparse.OptionValues'). Esto permite que las retrollamadas utilicen el mismo mecanismo que el resto de @ref{a0,,optparse} para almacenar valores de las opciones; no es necesario perder el tiempo con globales o clausuras. También se puede acceder a los valores de las opciones o modificarlos si ya se encuentran en la línea de comandos.
@end table

@item @code{args}

es una tupla de argumentos posicionales arbitrarios suministrados a través del atributo de opción @ref{47b7,,callback_args}.

@item @code{kwargs}

es un diccionario con argumentos por palabra clave arbitrarios proporcionados por @ref{47b8,,callback_kwargs}.
@end table

@node Lanzando errores en una retrollamada,Ejemplo de retrollamada 1 una retrollamada trivial,Cómo son invocadas las retrollamadas,Retrollamadas de opción
@anchor{library/optparse optparse-raising-errors-in-callback}@anchor{47d0}@anchor{library/optparse raising-errors-in-a-callback}@anchor{47d1}
@subsubsection Lanzando errores en una retrollamada


La retrollamada debería lanzar una excepción @ref{2cc2,,OptionValueError} si hay algún problema con la opción o su(s) argumento(s). Esto permite a @ref{a0,,optparse} detectar el problema y finalizar el programa, imprimiendo el mensaje de error que hayas proporciones en la salida de error estándar. El mensaje debe ser claro, conciso, preciso y mencionar la opción que causa la excepción. De lo contrario, el usuario tendrá dificultades para descubrir qué hizo mal.

@node Ejemplo de retrollamada 1 una retrollamada trivial,Ejemplo de retrollamada 2 comprobar el orden de las opciones,Lanzando errores en una retrollamada,Retrollamadas de opción
@anchor{library/optparse callback-example-1-trivial-callback}@anchor{47d2}@anchor{library/optparse optparse-callback-example-1}@anchor{47d3}
@subsubsection Ejemplo de retrollamada 1: una retrollamada trivial


Aquí hay un ejemplo de una opción con retrollamada que no tiene argumentos y simplemente registra que se encontró la opción en la línea de comandos:

@example
def record_foo_seen(option, opt_str, value, parser):
    parser.values.saw_foo = True

parser.add_option("--foo", action="callback", callback=record_foo_seen)
@end example

Ciertamente, se puede hacer lo mismo simplemente con la acción @code{"store_true"}.

@node Ejemplo de retrollamada 2 comprobar el orden de las opciones,Ejemplo de retrollamada 3 comprobar el orden de las opciones generalizado,Ejemplo de retrollamada 1 una retrollamada trivial,Retrollamadas de opción
@anchor{library/optparse callback-example-2-check-option-order}@anchor{47d4}@anchor{library/optparse optparse-callback-example-2}@anchor{47d5}
@subsubsection Ejemplo de retrollamada 2: comprobar el orden de las opciones


Aquí tenemos un ejemplo un poco más interesante: registra el hecho de que se ha encontrado @code{-a}, pero lanza un error si viene después de @code{-b} en la línea de comandos

@example
def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use -a after -b")
    parser.values.a = 1
...
parser.add_option("-a", action="callback", callback=check_order)
parser.add_option("-b", action="store_true", dest="b")
@end example

@node Ejemplo de retrollamada 3 comprobar el orden de las opciones generalizado,Ejemplo de retrollamada 4 comprobar una condición arbitraria,Ejemplo de retrollamada 2 comprobar el orden de las opciones,Retrollamadas de opción
@anchor{library/optparse callback-example-3-check-option-order-generalized}@anchor{47d6}@anchor{library/optparse optparse-callback-example-3}@anchor{47d7}
@subsubsection Ejemplo de retrollamada 3: comprobar el orden de las opciones (generalizado)


If you want to reuse this callback for several similar options (set a flag, but
blow up if @code{-b} has already been seen), it needs a bit of work: the error
message and the flag that it sets must be generalized.

@example
def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use %s after -b" % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("-a", action="callback", callback=check_order, dest='a')
parser.add_option("-b", action="store_true", dest="b")
parser.add_option("-c", action="callback", callback=check_order, dest='c')
@end example

@node Ejemplo de retrollamada 4 comprobar una condición arbitraria,Ejemplo de retrollamada 5 argumentos fijos,Ejemplo de retrollamada 3 comprobar el orden de las opciones generalizado,Retrollamadas de opción
@anchor{library/optparse callback-example-4-check-arbitrary-condition}@anchor{47d8}@anchor{library/optparse optparse-callback-example-4}@anchor{47d9}
@subsubsection Ejemplo de retrollamada 4: comprobar una condición arbitraria


Por supuesto, puedes poner cualquier condición aquí, no estás limitado a verificar los valores de las opciones previamente definidas. Por ejemplo, si tienes opciones que no deberían llamarse cuando hay luna llena, todo lo que tienes que hacer es lo siguiente:

@example
def check_moon(option, opt_str, value, parser):
    if is_moon_full():
        raise OptionValueError("%s option invalid when moon is full"
                               % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("--foo",
                  action="callback", callback=check_moon, dest="foo")
@end example

(La definición de @code{is_moon_full()} se deja como ejercicio para el lector).

@node Ejemplo de retrollamada 5 argumentos fijos,Ejemplo de retrollamada 6 argumentos variables,Ejemplo de retrollamada 4 comprobar una condición arbitraria,Retrollamadas de opción
@anchor{library/optparse callback-example-5-fixed-arguments}@anchor{47da}@anchor{library/optparse optparse-callback-example-5}@anchor{47db}
@subsubsection Ejemplo de retrollamada 5: argumentos fijos


Las cosas se ponen un poco más interesantes cuando se definen opciones con retrollamada que toman un número fijo de argumentos. Especificar que una opción con retrollamada toma argumentos es similar a definir una opción @code{"store"} o @code{"append"}: si se define @ref{4785,,type}, entonces la opción toma un argumento que debe poder convertirse a ese tipo; si además se define @ref{47b4,,nargs}, entonces la opción toma @ref{47b4,,nargs} argumentos.

Aquí hay un ejemplo que simplemente emula la acción @code{"store"} estándar:

@example
def store_value(option, opt_str, value, parser):
    setattr(parser.values, option.dest, value)
...
parser.add_option("--foo",
                  action="callback", callback=store_value,
                  type="int", nargs=3, dest="foo")
@end example

Ten en cuenta que @ref{a0,,optparse} se encarga de consumir 3 argumentos y convertirlos a números enteros por ti; todo lo que tienes que hacer es almacenarlos. (En cualquier caso, obviamente no necesitas hacer uso de una retrollamada para este ejemplo).

@node Ejemplo de retrollamada 6 argumentos variables,,Ejemplo de retrollamada 5 argumentos fijos,Retrollamadas de opción
@anchor{library/optparse callback-example-6-variable-arguments}@anchor{47dc}@anchor{library/optparse optparse-callback-example-6}@anchor{47dd}
@subsubsection Ejemplo de retrollamada 6: argumentos variables


Las cosas se complican si quieres que una opción pueda tomar un número variable de argumentos. En este caso, si que deberás escribir una retrollamada, ya que el módulo @ref{a0,,optparse} no proporciona ninguna capacidad incorporada para ello. Además, tienes que lidiar con ciertos entresijos del análisis convencional de la línea de comandos de Unix, que @ref{a0,,optparse} normalmente maneja por ti. En concreto, las retrollamadas deben implementar las reglas convencionales para los argumentos @code{--} y @code{-} desnudos:


@itemize *

@item 
tanto @code{--} como @code{-} pueden ser argumentos de opción

@item 
@code{--} desnudo (si no es el argumento de alguna opción): detener el procesamiento de la línea de comandos y descartar el @code{--}

@item 
@code{-} desnudo (si no es el argumento de alguna opción): detener el procesamiento de la línea de comandos pero mantener el @code{-} (añadiéndolo a @code{parser.largs})
@end itemize

Si deseas que una opción tenga un número variable de argumentos, hay varios problemas sutiles y complicados de los que deberás preocuparte. La implementación exacta que elijas dependerá de los sacrificios que estés dispuesto a hacer en tu aplicación (razón por la cual, el módulo @ref{a0,,optparse} no admite directamente este tipo de cosas).

En cualquier caso, aquí hay un intento de una retrollamada para una opción con un número de argumentos variable:

@example
def vararg_callback(option, opt_str, value, parser):
    assert value is None
    value = []

    def floatable(str):
        try:
            float(str)
            return True
        except ValueError:
            return False

    for arg in parser.rargs:
        # stop on --foo like options
        if arg[:2] == "--" and len(arg) > 2:
            break
        # stop on -a, but not on -3 or -3.0
        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):
            break
        value.append(arg)

    del parser.rargs[:len(value)]
    setattr(parser.values, option.dest, value)

...
parser.add_option("-c", "--callback", dest="vararg_attr",
                  action="callback", callback=vararg_callback)
@end example

@node Extendiendo el módulo optparse,Excepciones<19>,Retrollamadas de opción,optparse — Parser for command line options
@anchor{library/optparse extending-optparse}@anchor{47de}@anchor{library/optparse optparse-extending-optparse}@anchor{478a}
@subsubsection Extendiendo el módulo @code{optparse}


Dado que los dos factores principales que controlan como el módulo @ref{a0,,optparse} interpreta las opciones de la línea de comandos son la acción y el tipo de cada opción, los objetivos más probables de extensión son agregar nuevas acciones y nuevos tipos.

@menu
* Agregando nuevos tipos:: 
* Agregando nuevas acciones:: 

@end menu

@node Agregando nuevos tipos,Agregando nuevas acciones,,Extendiendo el módulo optparse
@anchor{library/optparse adding-new-types}@anchor{47df}@anchor{library/optparse optparse-adding-new-types}@anchor{47e0}
@subsubsection Agregando nuevos tipos


Para añadir nuevos tipos, necesitas definir tu propia subclase de la clase @ref{47ac,,Option} de @ref{a0,,optparse}. Esta clase tiene un par de atributos que definen los tipos de @ref{a0,,optparse}: @ref{47e1,,TYPES} y @ref{47e2,,TYPE_CHECKER}.

@geindex TYPES (atributo de optparse.Option)
@anchor{library/optparse optparse Option TYPES}@anchor{47e1}
@deffn {Atributo} Option.TYPES

Una tupla con nombres de tipos. En tu subclase, simplemente define una nueva tupla @ref{47e1,,TYPES} que se base en la estándar.
@end deffn

@geindex TYPE_CHECKER (atributo de optparse.Option)
@anchor{library/optparse optparse Option TYPE_CHECKER}@anchor{47e2}
@deffn {Atributo} Option.TYPE_CHECKER

Un diccionario que asigna nombres de tipos a funciones de verificación de tipo. Una función de verificación de tipo tiene la siguiente firma:

@example
def check_mytype(option, opt, value)
@end example

donde @code{option} es una instancia de @ref{47ac,,Option}, @code{opt} es una cadena de opción (por ejemplo, @code{-f}) y @code{value} es la cadena de caracteres de la línea de comandos que debe comprobarse y convertirse al tipo deseado. @code{check_mytype()} debería retornar un objeto del tipo hipotético @code{mytype}. El valor retornado por una función de verificación de tipo terminará formando parte de la instancia de OptionValues retornada por el método @ref{150e,,OptionParser.parse_args()} o será pasada a una retrollamada como parámetro @code{value}.

Tu función de verificación de tipo debería lanzar una excepción @ref{2cc2,,OptionValueError} si encuentra algún problema. @ref{2cc2,,OptionValueError} toma una cadena de caracteres como único argumento, que es pasada tal cual al método @code{error()} de la clase @ref{150d,,OptionParser}, que a su vez antepone a la misma el nombre del programa y la cadena @code{"error:"} e imprime todo en la salida de error estándar antes de finalizar el proceso.
@end deffn

Aquí hay un ejemplo absurdo que demuestra cómo agregar un tipo de opción @code{"complex"} para analizar números complejos al estilo Python en la línea de comandos. (Esto es aún más absurdo de lo que en principio parece, porque en al versión 1.3 de @ref{a0,,optparse} se agregó soporte incorporado para números complejos, pero no importa).

Primero, las importaciones necesarias:

@example
from copy import copy
from optparse import Option, OptionValueError
@end example

En primer lugar, debes definir tu verificador de tipo, ya que se hace referencia a él más adelante (en el atributo de clase @ref{47e2,,TYPE_CHECKER} de tu subclase de Option):

@example
def check_complex(option, opt, value):
    try:
        return complex(value)
    except ValueError:
        raise OptionValueError(
            "option %s: invalid complex value: %r" % (opt, value))
@end example

Finalmente, la subclase de Option:

@example
class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex
@end example

(Si no hacemos una copia (mediante @ref{26,,copy()}), de @ref{47e2,,Option.TYPE_CHECKER}, terminaríamos modificando el atributo @ref{47e2,,TYPE_CHECKER} de la clase Option de @ref{a0,,optparse}. Tratándose de Python, nada te impide hacer eso, excepto los buenos modales y el sentido común.)

¡Y eso es todo! Ahora puedes escribir un script que use tu nuevo tipo de opción como cualquier otro script basado en @ref{a0,,optparse}, excepto que debes indicarle a tu OptionParser que use MyOption en lugar de Option:

@example
parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")
@end example

Alternativamente, puedes crear tu propia lista de opciones y pasarla a OptionParser; si no usas @code{add_option()} de la manera anterior, no necesitas decirle a OptionParser qué clase de opción usar:

@example
option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)
@end example

@node Agregando nuevas acciones,,Agregando nuevos tipos,Extendiendo el módulo optparse
@anchor{library/optparse adding-new-actions}@anchor{47e3}@anchor{library/optparse optparse-adding-new-actions}@anchor{47e4}
@subsubsection Agregando nuevas acciones


Agregar nuevas acciones es un poco más complicado, dado que hay que comprender que @ref{a0,,optparse} establece un par de categorías para las acciones:


@table @asis

@item Acciones «store»

acciones que dan como resultado que @ref{a0,,optparse} almacene un valor en un atributo de la instancia actual de OptionValues. Estas opciones requieren un atributo @ref{4786,,dest} para que pueda ser proporcionado al constructor de Option.

@item Acciones «typed»

acciones que toman un valor de la línea de comandos, esperando que sea de cierto tipo; o mejor dicho, una cadena de caracteres que se pueda convertir a un determinado tipo. Estas opciones requieren un atributo @ref{4785,,type} para el constructor de Option.
@end table

Ambas categorías se solapan entre si: algunas acciones @code{store} predeterminadas son @code{"store"}, @code{"store_const"}, @code{"append"} y @code{"count"}, mientras que las acciones «typed» predeterminadas son @code{"store"}, @code{"append"} y @code{"callback"}.

Cuando agregas una acción, debes categorizarla enumerándola en al menos uno de los siguientes atributos de clase de la clase Option (todos ellos son listas de cadenas de caracteres):

@geindex ACTIONS (atributo de optparse.Option)
@anchor{library/optparse optparse Option ACTIONS}@anchor{47e5}
@deffn {Atributo} Option.ACTIONS

Todas las acciones deben aparecer en ACTIONS.
@end deffn

@geindex STORE_ACTIONS (atributo de optparse.Option)
@anchor{library/optparse optparse Option STORE_ACTIONS}@anchor{47e6}
@deffn {Atributo} Option.STORE_ACTIONS

Las acciones «store» también se enumeran aquí.
@end deffn

@geindex TYPED_ACTIONS (atributo de optparse.Option)
@anchor{library/optparse optparse Option TYPED_ACTIONS}@anchor{47e7}
@deffn {Atributo} Option.TYPED_ACTIONS

Las acciones «typed» también se enumeran aquí.
@end deffn

@geindex ALWAYS_TYPED_ACTIONS (atributo de optparse.Option)
@anchor{library/optparse optparse Option ALWAYS_TYPED_ACTIONS}@anchor{47e8}
@deffn {Atributo} Option.ALWAYS_TYPED_ACTIONS

Las acciones que siempre toman un tipo (es decir, aquellas cuyas opciones siempre toman un valor) también deben enumerarse aquí. La única consecuencia de esto es que @ref{a0,,optparse} asigna el tipo predeterminado, @code{string}, a las opciones cuya acción se enumera en @ref{47e8,,ALWAYS_TYPED_ACTIONS} pero que no tienen asignado un tipo explícito.
@end deffn

Para implementar realmente tu nueva acción, debes redefinir el método @code{take_action()} de Option, implementando un nuevo método que reconozca tu acción.

Por ejemplo, agreguemos una nueva acción @code{"extend"}. Esta es similar a la acción estándar @code{"append"}, pero en lugar de tomar un solo valor de la línea de comandos y agregarlo a una lista existente, @code{"extend"} tomará múltiples valores en una sola cadena de caracteres delimitada por comas y amplía una lista previamente existente con ellos. Es decir, si @code{--names} es una opción @code{"extend"} de tipo @code{"string"}, la línea de comandos

@example
--names=foo,bar --names blah --names ding,dong
@end example

daría como resultado una lista como la siguiente:

@example
["foo", "bar", "blah", "ding", "dong"]
@end example

De nuevo, definimos una subclase de Option:

@example
class MyOption(Option):

    ACTIONS = Option.ACTIONS + ("extend",)
    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)
    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)
    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)

    def take_action(self, action, dest, opt, value, values, parser):
        if action == "extend":
            lvalue = value.split(",")
            values.ensure_value(dest, []).extend(lvalue)
        else:
            Option.take_action(
                self, action, dest, opt, value, values, parser)
@end example

Detalles a tener en cuenta:


@itemize *

@item 
@code{"extend"} espera un valor en la línea de comandos y también almacena ese valor en algún lugar, por lo que lo agregamos tanto a @ref{47e6,,STORE_ACTIONS} como a @ref{47e7,,TYPED_ACTIONS}.

@item 
para asegurarnos de que @ref{a0,,optparse} asigna el tipo predeterminado @code{"string"} a las acciones @code{"extend"}, agregamos también la acción @code{"extend"} a @code{ALWAYS_TYPED_ACTIONS}.

@item 
el método @code{MyOption.take_action()} solo se encarga de implementar esta nueva acción y posteriormente le pasa el control al método @code{Option.take_action()} para las acciones estándar de @ref{a0,,optparse}.

@item 
@code{values} es una instancia de la clase `optparse_parser.Values', que proporciona el útil método @code{ensure_value()}. El método @code{ensure_value()} es en esencia lo mismo que @ref{c59,,getattr()} pero con un mecanismo de seguridad agregado. Es llamado como:

@example
values.ensure_value(attr, value)
@end example

Si el atributo @code{attr} de @code{values} no existe o es @code{None}, entonces `ensure_value()' primero lo establece en @code{value} y luego retorna el atributo actualizado (@code{value}). Esto es muy útil para acciones como @code{"extend"}, @code{"append"} y @code{"count"}, dado que todas ellas acumulan datos en una variable y esperan que esa variable sea de cierto tipo (una lista para las dos primeras, un número entero para la última). Usar el método @code{ensure_value()} significa que los scripts que usan tu acción no tienen que preocuparse por establecer un valor predeterminado para los destinos de opción en cuestión; simplemente pueden dejar el valor predeterminado como @code{None} y @code{secure_value()} se encargará de que todo esté correcto cuando sea necesario.
@end itemize

@node Excepciones<19>,,Extendiendo el módulo optparse,optparse — Parser for command line options
@anchor{library/optparse exceptions}@anchor{47e9}
@subsubsection Excepciones


@geindex OptionError
@anchor{library/optparse optparse OptionError}@anchor{2cc1}
@deffn {Excepción} optparse.OptionError

Lanzada si se crea con argumentos inválidos o inconsistentes una instancia de @ref{47ac,,Option}.
@end deffn

@geindex OptionConflictError
@anchor{library/optparse optparse OptionConflictError}@anchor{47c4}
@deffn {Excepción} optparse.OptionConflictError

Lanzada si se añaden opciones que entren en conflicto en una @ref{150d,,OptionParser}.
@end deffn

@geindex OptionValueError
@anchor{library/optparse optparse OptionValueError}@anchor{2cc2}
@deffn {Excepción} optparse.OptionValueError

Lanzada si se encuentra una opción inválida en la línea de comandos.
@end deffn

@geindex BadOptionError
@anchor{library/optparse optparse BadOptionError}@anchor{47ea}
@deffn {Excepción} optparse.BadOptionError

Lanzada si se pasa una opción inválida en la línea de comandos.
@end deffn

@geindex AmbiguousOptionError
@anchor{library/optparse optparse AmbiguousOptionError}@anchor{47eb}
@deffn {Excepción} optparse.AmbiguousOptionError

Lanzada si se pasa una opción ambigua en la línea de comandos.
@end deffn

@node Removed Modules,Consideraciones de seguridad<4>,Módulos reemplazados,La biblioteca estándar de Python
@anchor{library/removed doc}@anchor{47ec}@anchor{library/removed removed}@anchor{47ed}@anchor{library/removed removed-modules}@anchor{47ee}
@section Removed Modules


The modules described in this chapter have been removed from the Python
standard library.  They are documented here to help people find replacements.

@menu
* aifc — Read and write AIFF and AIFC files:: 
* asynchat — Asynchronous socket command/response handler:: 
* asyncore — Asynchronous socket handler:: 
* audioop — Manipulate raw audio data:: 
* cgi — Common Gateway Interface support:: 
* cgitb — Traceback manager for CGI scripts:: 
* chunk — Read IFF chunked data:: 
* crypt — Function to check Unix passwords:: 
* distutils — Building and installing Python modules:: 
* imghdr — Determine the type of an image:: 
* imp — Access the import internals:: 
* mailcap — Mailcap file handling:: 
* msilib — Read and write Microsoft Installer files:: 
* nis — Interface to Sun’s NIS (Yellow Pages): nis — Interface to Sun’s NIS Yellow Pages. 
* nntplib — NNTP protocol client:: 
* ossaudiodev — Access to OSS-compatible audio devices:: 
* pipes — Interface to shell pipelines:: 
* smtpd — SMTP Server:: 
* sndhdr — Determine type of sound file:: 
* spwd — The shadow password database:: 
* sunau — Read and write Sun AU files:: 
* telnetlib — Telnet client:: 
* uu — Encode and decode uuencode files:: 
* xdrlib — Encode and decode XDR data:: 

@end menu

@node aifc — Read and write AIFF and AIFC files,asynchat — Asynchronous socket command/response handler,,Removed Modules
@anchor{library/aifc doc}@anchor{47ef}@anchor{library/aifc aifc-read-and-write-aiff-and-aifc-files}@anchor{47f0}@anchor{library/aifc module-aifc}@anchor{5}
@subsection @code{aifc} — Read and write AIFF and AIFC files


@geindex module; aifc


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{aifc} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/aifc.html}.

@node asynchat — Asynchronous socket command/response handler,asyncore — Asynchronous socket handler,aifc — Read and write AIFF and AIFC files,Removed Modules
@anchor{library/asynchat doc}@anchor{47f1}@anchor{library/asynchat asynchat-asynchronous-socket-command-response-handler}@anchor{47f2}@anchor{library/asynchat module-asynchat}@anchor{a}
@subsection @code{asynchat} — Asynchronous socket command/response handler


@geindex module; asynchat


Deprecated since version 3.6, removed in version 3.12.


This module is no longer part of the Python standard library.
It was @ref{5a6,,removed in Python 3.12} after
being deprecated in Python 3.6.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Applications should use the @ref{b,,asyncio} module instead.

The last version of Python that provided the @code{asynchat} module was
Python 3.11@footnote{https://docs.python.org/3.11/library/asynchat.html}.

@node asyncore — Asynchronous socket handler,audioop — Manipulate raw audio data,asynchat — Asynchronous socket command/response handler,Removed Modules
@anchor{library/asyncore doc}@anchor{47f3}@anchor{library/asyncore asyncore-asynchronous-socket-handler}@anchor{47f4}@anchor{library/asyncore module-asyncore}@anchor{c}
@subsection @code{asyncore} — Asynchronous socket handler


@geindex module; asyncore


Deprecated since version 3.6, removed in version 3.12.


This module is no longer part of the Python standard library.
It was @ref{5a6,,removed in Python 3.12} after
being deprecated in Python 3.6.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Applications should use the @ref{b,,asyncio} module instead.

The last version of Python that provided the @code{asyncore} module was
Python 3.11@footnote{https://docs.python.org/3.11/library/asyncore.html}.

@node audioop — Manipulate raw audio data,cgi — Common Gateway Interface support,asyncore — Asynchronous socket handler,Removed Modules
@anchor{library/audioop doc}@anchor{47f5}@anchor{library/audioop audioop-manipulate-raw-audio-data}@anchor{47f6}@anchor{library/audioop module-audioop}@anchor{e}
@subsection @code{audioop} — Manipulate raw audio data


@geindex module; audioop


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{audioop} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/audioop.html}.

@node cgi — Common Gateway Interface support,cgitb — Traceback manager for CGI scripts,audioop — Manipulate raw audio data,Removed Modules
@anchor{library/cgi doc}@anchor{47f7}@anchor{library/cgi cgi-common-gateway-interface-support}@anchor{47f8}@anchor{library/cgi module-cgi}@anchor{16}
@subsection @code{cgi} — Common Gateway Interface support


@geindex module; cgi


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A fork of the module on PyPI can be used instead: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}.
This is a copy of the cgi module, no longer maintained or supported by the core
Python team.

The last version of Python that provided the @code{cgi} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/cgi.html}.

@node cgitb — Traceback manager for CGI scripts,chunk — Read IFF chunked data,cgi — Common Gateway Interface support,Removed Modules
@anchor{library/cgitb doc}@anchor{47f9}@anchor{library/cgitb cgitb-traceback-manager-for-cgi-scripts}@anchor{47fa}@anchor{library/cgitb module-cgitb}@anchor{17}
@subsection @code{cgitb} — Traceback manager for CGI scripts


@geindex module; cgitb


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A fork of the module on PyPI can now be used instead: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}.
This is a copy of the cgi module, no longer maintained or supported by the core
Python team.

The last version of Python that provided the @code{cgitb} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/cgitb.html}.

@node chunk — Read IFF chunked data,crypt — Function to check Unix passwords,cgitb — Traceback manager for CGI scripts,Removed Modules
@anchor{library/chunk doc}@anchor{47fb}@anchor{library/chunk chunk-read-iff-chunked-data}@anchor{47fc}@anchor{library/chunk module-chunk}@anchor{18}
@subsection @code{chunk} — Read IFF chunked data


@geindex module; chunk


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{chunk} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/chunk.html}.

@node crypt — Function to check Unix passwords,distutils — Building and installing Python modules,chunk — Read IFF chunked data,Removed Modules
@anchor{library/crypt doc}@anchor{47fd}@anchor{library/crypt crypt-function-to-check-unix-passwords}@anchor{47fe}@anchor{library/crypt module-crypt}@anchor{29}
@subsection @code{crypt} — Function to check Unix passwords


@geindex module; crypt


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Applications can use the @ref{68,,hashlib} module from the standard library.
Other possible replacements are third-party libraries from PyPI:
legacycrypt@footnote{https://pypi.org/project/legacycrypt/}, bcrypt@footnote{https://pypi.org/project/bcrypt/}, argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}, or passlib@footnote{https://pypi.org/project/passlib/}.
These are not supported or maintained by the Python core team.

The last version of Python that provided the @code{crypt} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/crypt.html}.

@node distutils — Building and installing Python modules,imghdr — Determine the type of an image,crypt — Function to check Unix passwords,Removed Modules
@anchor{library/distutils doc}@anchor{47ff}@anchor{library/distutils distutils-building-and-installing-python-modules}@anchor{4800}@anchor{library/distutils module-distutils}@anchor{3a}
@subsection @code{distutils} — Building and installing Python modules


@geindex module; distutils


Deprecated since version 3.10, removed in version 3.12.


This module is no longer part of the Python standard library.
It was @ref{5ac,,removed in Python 3.12} after
being deprecated in Python 3.10.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/},
which has migration advice@footnote{https://peps.python.org/pep-0632/#migration-advice}.

The last version of Python that provided the @code{distutils} module was
Python 3.11@footnote{https://docs.python.org/3.11/library/distutils.html}.

@node imghdr — Determine the type of an image,imp — Access the import internals,distutils — Building and installing Python modules,Removed Modules
@anchor{library/imghdr doc}@anchor{4801}@anchor{library/imghdr imghdr-determine-the-type-of-an-image}@anchor{4802}@anchor{library/imghdr module-imghdr}@anchor{75}
@subsection @code{imghdr} — Determine the type of an image


@geindex module; imghdr


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possible replacements are third-party libraries from PyPI:
filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/}, or python-magic@footnote{https://pypi.org/project/python-magic/}.
These are not supported or maintained by the Python core team.

The last version of Python that provided the @code{imghdr} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/imghdr.html}.

@node imp — Access the import internals,mailcap — Mailcap file handling,imghdr — Determine the type of an image,Removed Modules
@anchor{library/imp doc}@anchor{4803}@anchor{library/imp imp-access-the-import-internals}@anchor{4804}@anchor{library/imp module-imp}@anchor{76}
@subsection @code{imp} — Access the import internals


@geindex module; imp


Deprecated since version 3.4, removed in version 3.12.


This module is no longer part of the Python standard library.
It was @ref{5b6,,removed in Python 3.12} after
being deprecated in Python 3.4.

The @ref{5b6,,removal notice} includes guidance for
migrating code from @code{imp} to @ref{77,,importlib}.

The last version of Python that provided the @code{imp} module was
Python 3.11@footnote{https://docs.python.org/3.11/library/imp.html}.

@node mailcap — Mailcap file handling,msilib — Read and write Microsoft Installer files,imp — Access the import internals,Removed Modules
@anchor{library/mailcap doc}@anchor{4805}@anchor{library/mailcap mailcap-mailcap-file-handling}@anchor{4806}@anchor{library/mailcap module-mailcap}@anchor{8c}
@subsection @code{mailcap} — Mailcap file handling


@geindex module; mailcap


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{mailcap} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/mailcap.html}.

@node msilib — Read and write Microsoft Installer files,nis — Interface to Sun’s NIS Yellow Pages,mailcap — Mailcap file handling,Removed Modules
@anchor{library/msilib doc}@anchor{4807}@anchor{library/msilib module-msilib}@anchor{92}@anchor{library/msilib msilib-read-and-write-microsoft-installer-files}@anchor{4808}
@subsection @code{msilib} — Read and write Microsoft Installer files


@geindex module; msilib


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{msilib} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/msilib.html}.

@node nis — Interface to Sun’s NIS Yellow Pages,nntplib — NNTP protocol client,msilib — Read and write Microsoft Installer files,Removed Modules
@anchor{library/nis doc}@anchor{4809}@anchor{library/nis module-nis}@anchor{9c}@anchor{library/nis nis-interface-to-suns-nis-yellow-pages}@anchor{480a}
@subsection @code{nis} — Interface to Sun’s NIS (Yellow Pages)


@geindex module; nis


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{nis} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/nis.html}.

@node nntplib — NNTP protocol client,ossaudiodev — Access to OSS-compatible audio devices,nis — Interface to Sun’s NIS Yellow Pages,Removed Modules
@anchor{library/nntplib doc}@anchor{480b}@anchor{library/nntplib module-nntplib}@anchor{9d}@anchor{library/nntplib nntplib-nntp-protocol-client}@anchor{480c}
@subsection @code{nntplib} — NNTP protocol client


@geindex module; nntplib


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{nntplib} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/nntplib.html}.

@node ossaudiodev — Access to OSS-compatible audio devices,pipes — Interface to shell pipelines,nntplib — NNTP protocol client,Removed Modules
@anchor{library/ossaudiodev doc}@anchor{480d}@anchor{library/ossaudiodev module-ossaudiodev}@anchor{a3}@anchor{library/ossaudiodev ossaudiodev-access-to-oss-compatible-audio-devices}@anchor{480e}
@subsection @code{ossaudiodev} — Access to OSS-compatible audio devices


@geindex module; ossaudiodev


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{ossaudiodev} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/ossaudiodev.html}.

@node pipes — Interface to shell pipelines,smtpd — SMTP Server,ossaudiodev — Access to OSS-compatible audio devices,Removed Modules
@anchor{library/pipes doc}@anchor{480f}@anchor{library/pipes module-pipes}@anchor{a8}@anchor{library/pipes pipes-interface-to-shell-pipelines}@anchor{4810}
@subsection @code{pipes} — Interface to shell pipelines


@geindex module; pipes


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Applications should use the @ref{d6,,subprocess} module instead.

The last version of Python that provided the @code{pipes} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/pipes.html}.

@node smtpd — SMTP Server,sndhdr — Determine type of sound file,pipes — Interface to shell pipelines,Removed Modules
@anchor{library/smtpd doc}@anchor{4811}@anchor{library/smtpd module-smtpd}@anchor{c9}@anchor{library/smtpd smtpd-smtp-server}@anchor{4812}
@subsection @code{smtpd} — SMTP Server


@geindex module; smtpd


Deprecated since version 3.6, removed in version 3.12.


This module is no longer part of the Python standard library.
It was @ref{5a6,,removed in Python 3.12} after
being deprecated in Python 3.6.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A possible replacement is the third-party aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} library. This
library is not maintained or supported by the Python core team.

The last version of Python that provided the @code{smtpd} module was
Python 3.11@footnote{https://docs.python.org/3.11/library/smtpd.html}.

@node sndhdr — Determine type of sound file,spwd — The shadow password database,smtpd — SMTP Server,Removed Modules
@anchor{library/sndhdr doc}@anchor{4813}@anchor{library/sndhdr module-sndhdr}@anchor{cb}@anchor{library/sndhdr sndhdr-determine-type-of-sound-file}@anchor{4814}
@subsection @code{sndhdr} — Determine type of sound file


@geindex module; sndhdr


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possible replacements are third-party modules from PyPI:
filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/}, or python-magic@footnote{https://pypi.org/project/python-magic/}.
These are not supported or maintained by the Python core team.

The last version of Python that provided the @code{sndhdr} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/sndhdr.html}.

@node spwd — The shadow password database,sunau — Read and write Sun AU files,sndhdr — Determine type of sound file,Removed Modules
@anchor{library/spwd doc}@anchor{4815}@anchor{library/spwd module-spwd}@anchor{ce}@anchor{library/spwd spwd-the-shadow-password-database}@anchor{4816}
@subsection @code{spwd} — The shadow password database


@geindex module; spwd


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A possible replacement is the third-party library python-pam@footnote{https://pypi.org/project/python-pam/}.
This library is not supported or maintained by the Python core team.

The last version of Python that provided the @code{spwd} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/spwd.html}.

@node sunau — Read and write Sun AU files,telnetlib — Telnet client,spwd — The shadow password database,Removed Modules
@anchor{library/sunau doc}@anchor{4817}@anchor{library/sunau module-sunau}@anchor{d7}@anchor{library/sunau sunau-read-and-write-sun-au-files}@anchor{4818}
@subsection @code{sunau} — Read and write Sun AU files


@geindex module; sunau


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{sunau} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/sunau.html}.

@node telnetlib — Telnet client,uu — Encode and decode uuencode files,sunau — Read and write Sun AU files,Removed Modules
@anchor{library/telnetlib doc}@anchor{4819}@anchor{library/telnetlib module-telnetlib}@anchor{df}@anchor{library/telnetlib telnetlib-telnet-client}@anchor{481a}
@subsection @code{telnetlib} — Telnet client


@geindex module; telnetlib


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possible replacements are third-party libraries from PyPI: telnetlib3@footnote{https://pypi.org/project/telnetlib3/}
or Exscript@footnote{https://pypi.org/project/Exscript/}.  These are not supported or maintained by the Python core
team.

The last version of Python that provided the @code{telnetlib} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/telnetlib.html}.

@node uu — Encode and decode uuencode files,xdrlib — Encode and decode XDR data,telnetlib — Telnet client,Removed Modules
@anchor{library/uu doc}@anchor{481b}@anchor{library/uu module-uu}@anchor{10f}@anchor{library/uu uu-encode-and-decode-uuencode-files}@anchor{481c}
@subsection @code{uu} — Encode and decode uuencode files


@geindex module; uu


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{uu} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/uu.html}.

@node xdrlib — Encode and decode XDR data,,uu — Encode and decode uuencode files,Removed Modules
@anchor{library/xdrlib doc}@anchor{481d}@anchor{library/xdrlib module-xdrlib}@anchor{11f}@anchor{library/xdrlib xdrlib-encode-and-decode-xdr-data}@anchor{481e}
@subsection @code{xdrlib} — Encode and decode XDR data


@geindex module; xdrlib


Deprecated since version 3.11, removed in version 3.13.


This module is no longer part of the Python standard library.
It was @ref{2b0,,removed in Python 3.13} after
being deprecated in Python 3.11.  The removal was decided in 
@geindex Python Enhancement Proposals; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

The last version of Python that provided the @code{xdrlib} module was
Python 3.12@footnote{https://docs.python.org/3.12/library/xdrlib.html}.

@geindex security considerations
@anchor{library/security_warnings security-warnings}@anchor{481f}
@node Consideraciones de seguridad<4>,,Removed Modules,La biblioteca estándar de Python
@anchor{library/security_warnings doc}@anchor{4820}@anchor{library/security_warnings security-considerations}@anchor{4821}
@section Consideraciones de seguridad


Los siguientes módulos tienen consideraciones de seguridad específicas:


@itemize *

@item 
@ref{f,,base64}: @ref{3673,,consideraciones de seguridad de base64} en 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}

@item 
@ref{68,,hashlib}: @ref{2ace,,todos los constructores toman un argumento de solo palabra clave «usedforsecurity» que deshabilita algoritmos inseguros y bloqueados conocidos}

@item 
@ref{72,,http.server} is not suitable for production use, only implementing
basic security checks. See the @ref{3a96,,security considerations}.

@item 
@ref{87,,logging}: @ref{2d21,,La configuración de registro usa eval()}

@item 
@ref{94,,multiprocessing}: @ref{30bc,,Connection.recv() usa pickle}

@item 
@ref{a6,,pickle}: @ref{2893,,Restricción de globals en pickle}

@item 
@ref{b8,,random} no debe usarse por motivos de seguridad, usa @ref{c0,,secrets} en su lugar

@item 
@ref{c3,,shelve}: @ref{28af,,el estante se basa en pickle y@comma{} por lo tanto@comma{} no es adecuado para tratar con fuentes no confiables}

@item 
@ref{d0,,ssl}: @ref{3292,,consideraciones de seguridad SSL/TLS}

@item 
@ref{d6,,subprocess}: @ref{3165,,Consideraciones sobre seguridad de subprocesos}

@item 
@ref{e0,,tempfile}: @ref{2851,,mktemp está en desuso debido a la vulnerabilidad a condiciones de urgencia}

@item 
@ref{120,,xml}: @ref{36a2,,vulnerabilidades XML}

@item 
@ref{130,,zipfile}: @ref{29e3,,los archivos de .zip preparados maliciosamente pueden causar agotamiento del volumen del disco}
@end itemize

La opción de línea de comando @ref{9f1,,-I} puede usarse para correr Python en modo aislado. Cuando no puede ser usado, la opción @ref{645,,-P} o la variable de entorno 
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH} pueden usarse para no anteponer un camino potencialmente inseguro al @ref{27e,,sys.path} como el directorio actual, el directorio del script o un string vacío.

@node Ampliación e incrustación del intérprete de Python,Manual de referencia de la API en C de Python,La biblioteca estándar de Python,Top
@anchor{extending/index doc}@anchor{4822}@anchor{extending/index extending-and-embedding-the-python-interpreter}@anchor{4823}@anchor{extending/index extending-index}@anchor{1be2}
@chapter Ampliación e incrustación del intérprete de Python


Este documento describe cómo escribir módulos en C o C++ para extender el intérprete de Python con nuevos módulos. Esos módulos no solo pueden definir nuevas funciones sino también nuevos tipos de objetos y sus métodos. El documento también describe cómo incrustar el intérprete de Python en otra aplicación, para usarlo como un lenguaje de extensión. Finalmente, muestra cómo compilar y vincular módulos de extensión para que puedan cargarse dinámicamente (en tiempo de ejecución) en el intérprete, si el sistema operativo subyacente admite esta característica.

Este documento asume conocimientos básicos sobre Python. Para una introducción informal al lenguaje, consulte @ref{1be1,,El tutorial de Python}. @ref{2b2,,Referencia del Lenguaje Python} da una definición más formal del lenguaje. @ref{2b1,,La biblioteca estándar de Python} documenta los tipos de objetos, funciones y módulos existentes (tanto incorporados como escritos en Python) que le dan al lenguaje su amplio rango de aplicaciones.

Para obtener una descripción detallada de toda la API de Python/C, consulte el apartado separado @ref{1be3,,Manual de referencia de la API en C de Python}.

@menu
* Herramientas de terceros recomendadas:: 
* Crear extensiones sin herramientas de terceros:: 
* Incrustar el tiempo de ejecución de CPython en una aplicación más grande:: 

@end menu

@node Herramientas de terceros recomendadas,Crear extensiones sin herramientas de terceros,,Ampliación e incrustación del intérprete de Python
@anchor{extending/index recommended-third-party-tools}@anchor{4824}
@section Herramientas de terceros recomendadas


This guide only covers the basic tools for creating extensions provided
as part of this version of CPython. Third party tools like
Cython@footnote{https://cython.org/}, cffi@footnote{https://cffi.readthedocs.io},
SWIG@footnote{https://www.swig.org} and Numba@footnote{https://numba.pydata.org/}
offer both simpler and more sophisticated approaches to creating C and C++
extensions for Python.


@subsubheading Ver también



@table @asis

@item Guía del Usuario de Empaquetamiento de Python: Extensiones binarias@footnote{https://packaging.python.org/guides/packaging-binary-extensions/}

La Guía del Usuario de Empaquetamiento de Python no solo cubre varias herramientas disponibles que simplifican la creación de extensiones binarias, sino que también discute las diversas razones por las cuales crear un módulo de extensión puede ser deseable en primer lugar.
@end table


@node Crear extensiones sin herramientas de terceros,Incrustar el tiempo de ejecución de CPython en una aplicación más grande,Herramientas de terceros recomendadas,Ampliación e incrustación del intérprete de Python
@anchor{extending/index creating-extensions-without-third-party-tools}@anchor{4825}
@section Crear extensiones sin herramientas de terceros


Esta sección de la guía cubre la creación de extensiones C y C++ sin la ayuda de herramientas de terceros. Está destinado principalmente a los creadores de esas herramientas, en lugar de ser una forma recomendada de crear sus propias extensiones C.

@menu
* Extendiendo Python con C o C++:: 
* Definición de tipos de extensión; Tutorial: Definición de tipos de extensión Tutorial. 
* Definición de tipos de extensión; temas variados: Definición de tipos de extensión temas variados. 
* Construyendo extensiones C y C++:: 
* Creación de extensiones C y C++ en Windows:: 

@end menu

@node Extendiendo Python con C o C++,Definición de tipos de extensión Tutorial,,Crear extensiones sin herramientas de terceros
@anchor{extending/extending doc}@anchor{4826}@anchor{extending/extending extending-intro}@anchor{4827}@anchor{extending/extending extending-python-with-c-or-c}@anchor{4828}
@subsection Extendiendo Python con C o C++


Es muy fácil agregar nuevos módulos incorporados a Python, si sabe cómo programar en C. Tales como `módulos de extensión' pueden hacer dos cosas que no se pueden hacer directamente en Python: pueden implementar nuevos tipos objetos incorporados, y pueden llamar a funciones de biblioteca C y llamadas de sistema.

Para admitir extensiones, la API de Python (interfaz de programadores de aplicaciones) define un conjunto de funciones, macros y variables que proporcionan acceso a la mayoría de los aspectos del sistema de tiempo de ejecución de Python. La API de Python se incorpora en un archivo fuente C incluyendo el encabezado @code{"Python.h"}.

La compilación de un módulo de extensión depende de su uso previsto, así como de la configuración de su sistema; los detalles se dan en capítulos posteriores.

@cartouche
@quotation Nota 
La interfaz de extensión C es específica de CPython, y los módulos de extensión no funcionan en otras implementaciones de Python. En muchos casos, es posible evitar escribir extensiones C y preservar la portabilidad a otras implementaciones. Por ejemplo, si su caso de uso es llamar a funciones de biblioteca C o llamadas de sistema, debería considerar usar el módulo @ref{2b,,ctypes} o la biblioteca cffi@footnote{https://cffi.readthedocs.io/} en lugar de escribir código personalizado C. Estos módulos le permiten escribir código Python para interactuar con el código C y son más portátiles entre las implementaciones de Python que escribir y compilar un módulo de extensión C.
@end quotation
@end cartouche

@menu
* Un ejemplo simple:: 
* Intermezzo; errores y excepciones: Intermezzo errores y excepciones. 
* De vuelta al ejemplo:: 
* La tabla de métodos del módulo y la función de inicialización:: 
* Compilación y enlazamiento:: 
* Llamando funciones Python desde C:: 
* Extracción de parámetros en funciones de extensión:: 
* Parámetros de palabras clave para funciones de extensión:: 
* Construyendo valores arbitrarios:: 
* Conteo de referencias:: 
* Escribiendo extensiones en C++:: 
* Proporcionar una API C para un módulo de extensión:: 

@end menu

@node Un ejemplo simple,Intermezzo errores y excepciones,,Extendiendo Python con C o C++
@anchor{extending/extending a-simple-example}@anchor{4829}@anchor{extending/extending extending-simpleexample}@anchor{482a}
@subsubsection Un ejemplo simple


Creemos un módulo de extensión llamado @code{spam} (la comida favorita de los fanáticos de Monty Python …) y digamos que queremos crear una interfaz de Python para la función de biblioteca C @code{system()} @footnote{
Ya existe una interfaz para esta función en el módulo estándar @ref{a1,,os} — se eligió como un ejemplo simple y directo.
} . Esta función toma una cadena de caracteres con terminación nula como argumento y retorna un entero. Queremos que esta función se pueda llamar desde Python de la siguiente manera:

@example
>>> import spam
>>> status = spam.system("ls -l")
@end example

Comience creando un archivo @code{spammodule.c}. (Históricamente, si un módulo se llama @code{spam}, el archivo C que contiene su implementación se llama @code{spammodule.c}; si el nombre del módulo es muy largo, como @code{spammify}, el nombre del módulo puede sea solo @code{spammify.c}.)

Las dos primeras líneas de nuestro archivo pueden ser:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

que extrae la API de Python (puede agregar un comentario que describa el propósito del módulo y un aviso de copyright si lo desea).

@cartouche
@quotation Nota 
Dado que Python puede definir algunas definiciones de preprocesador que afectan los encabezados estándar en algunos sistemas, `debe' incluir @code{Python.h} antes de incluir encabezados estándar.

@code{#define PY_SSIZE_T_CLEAN} was used to indicate that @code{Py_ssize_t} should be
used in some APIs instead of @code{int}.
It is not necessary since Python 3.13, but we keep it here for backward compatibility.
See @ref{47d,,Cadena de caracteres y búferes} for a description of this macro.
@end quotation
@end cartouche

Todos los símbolos visibles para el usuario definidos por @code{Python.h} tienen un prefijo @code{Py} o @code{PY}, excepto los definidos en los archivos de encabezado estándar. Por conveniencia, y dado que el intérprete de Python los usa ampliamente, @code{"Python.h"} incluye algunos archivos de encabezado estándar: @code{<stdio.h>}, @code{<string.h>}, @code{<errno.h>}, y @code{<stdlib.h>}. Si el último archivo de encabezado no existe en su sistema, declara las funciones @code{malloc()}, @code{free()} y @code{realloc()} directamente.

Lo siguiente que agregamos a nuestro archivo de módulo es la función C que se llamará cuando se evalúe la expresión Python @code{spam.system(string)} (veremos en breve cómo termina siendo llamado):

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    return PyLong_FromLong(sts);
@}
@end example

Hay una traducción directa de la lista de argumentos en Python (por ejemplo, la única expresión @code{"ls -l"}) a los argumentos pasados a la función C. La función C siempre tiene dos argumentos, llamados convencionalmente `self' y `args'.

El argumento `self' apunta al objeto del módulo para funciones a nivel de módulo; para un método apuntaría a la instancia del objeto.

El argumento `args' será un puntero a un objeto de tupla de Python que contiene los argumentos. Cada elemento de la tupla corresponde a un argumento en la lista de argumentos de la llamada. Los argumentos son objetos de Python — para hacer algo con ellos en nuestra función C tenemos que convertirlos a valores C. La función @ref{615,,PyArg_ParseTuple()} en la API de Python verifica los tipos de argumento y los convierte a valores C. Utiliza una cadena de plantilla para determinar los tipos requeridos de los argumentos, así como los tipos de las variables C en las que almacenar los valores convertidos. Más sobre esto más tarde.

@ref{615,,PyArg_ParseTuple()} retorna verdadero (distinto de cero) si todos los argumentos tienen el tipo correcto y sus componentes se han almacenado en las variables cuyas direcciones se pasan. Retorna falso (cero) si se pasó una lista de argumentos no válidos. En el último caso, también genera una excepción apropiada para que la función de llamada pueda retornar @code{NULL} inmediatamente (como vimos en el ejemplo).

@node Intermezzo errores y excepciones,De vuelta al ejemplo,Un ejemplo simple,Extendiendo Python con C o C++
@anchor{extending/extending extending-errors}@anchor{482b}@anchor{extending/extending intermezzo-errors-and-exceptions}@anchor{482c}
@subsubsection Intermezzo: errores y excepciones


Una convención importante en todo el intérprete de Python es la siguiente: cuando una función falla, debe establecer una condición de excepción y retornar un valor de error (generalmente @code{-1} o un puntero @code{NULL}). La información de excepción se almacena en tres miembros del estado del subproceso del intérprete. Estos son @code{NULL} si no hay excepción. De lo contrario, son los equivalentes en C de los miembros de la tupla Python retornada por @ref{72b,,sys.exc_info()}. Estos son el tipo de excepción, la instancia de excepción y un objeto de rastreo. Es importante conocerlos para comprender cómo se transmiten los errores.

La API de Python define una serie de funciones para establecer varios tipos de excepciones.

El más común es @ref{620,,PyErr_SetString()}. Sus argumentos son un objeto de excepción y una cadena C. El objeto de excepción suele ser un objeto predefinido como @code{PyExc_ZeroDivisionError}. La cadena C indica la causa del error y se convierte en un objeto de cadena Python y se almacena como el «valor asociado» de la excepción.

Otra función útil es @ref{482d,,PyErr_SetFromErrno()}, que solo toma un argumento de excepción y construye el valor asociado mediante la inspección de la variable global @code{errno}. La función más general es @ref{61f,,PyErr_SetObject()}, que toma dos argumentos de objeto, la excepción y su valor asociado. No necesita @ref{612,,Py_INCREF()} los objetos pasados a cualquiera de estas funciones.

Puede probar de forma no destructiva si se ha establecido una excepción con @ref{18fa,,PyErr_Occurred()}. Esto retorna el objeto de excepción actual o @code{NULL} si no se ha producido ninguna excepción. Normalmente no necesita llamar a @ref{18fa,,PyErr_Occurred()} para ver si se produjo un error en una llamada a la función, ya que debería poder distinguir el valor de retorno.

Cuando una función `f' que llama a otra función `g' detecta que esta última falla, `f' debería retornar un valor de error (normalmente @code{NULL} o @code{-1}). Debería `no' llamar a una de las funciones @code{PyErr_*} — `g' ya ha llamado a una. Se supone que la persona que llama a `f' también retornará una indicación de error a `su' persona que la llama, nuevamente `sin' llama a @code{PyErr_*}, y así sucesivamente — la función que lo detectó primero ya informó la causa más detallada del error. Una vez que el error llega al bucle principal del intérprete de Python, este aborta el código de Python que se está ejecutando actualmente e intenta encontrar un controlador de excepciones especificado por el programador de Python.

(Hay situaciones en las que un módulo puede dar un mensaje de error más detallado llamando a otra función @code{PyErr_*}, y en tales casos está bien hacerlo. Sin embargo, como regla general, esto no es necesario y puede causar que se pierda información sobre la causa del error: la mayoría de las operaciones pueden fallar por una variedad de razones).

Para ignorar una excepción establecida por una llamada de función que falló, la condición de excepción debe borrarse explícitamente llamando a @ref{10ad,,PyErr_Clear()}. La única vez que el código C debe llamar @ref{10ad,,PyErr_Clear()} es si no quiere pasar el error al intérprete pero quiere manejarlo completamente por sí mismo (posiblemente probando algo más o pretendiendo que nada salió mal) )

Cada llamada fallida a @code{malloc()} debe convertirse en una excepción — la persona que llama directamente de @code{malloc()} (o @code{realloc()}) debe llamar @ref{482e,,PyErr_NoMemory()} y retorna un indicador de falla en sí mismo. Todas las funciones de creación de objetos (por ejemplo, @ref{1840,,PyLong_FromLong()}) ya hacen esto, por lo que esta nota solo es relevante para aquellos que llaman @code{malloc()} directamente.

También tenga en cuenta que, con la importante excepción de @ref{615,,PyArg_ParseTuple()} y sus amigos, las funciones que retornan un estado entero generalmente retornan un valor positivo o cero para el éxito y @code{-1} para el fracaso, como las llamadas al sistema Unix.

Finalmente, tenga cuidado de limpiar la basura (haciendo @ref{828,,Py_XDECREF()} o @ref{613,,Py_DECREF()} requiere objetos que ya ha creado) cuando retorna un indicador de error!

The choice of which exception to raise is entirely yours.  There are predeclared
C objects corresponding to all built-in Python exceptions, such as
@code{PyExc_ZeroDivisionError}, which you can use directly. Of course, you
should choose exceptions wisely — don’t use @code{PyExc_TypeError} to mean
that a file couldn’t be opened (that should probably be @code{PyExc_OSError}).
If something’s wrong with the argument list, the @ref{615,,PyArg_ParseTuple()}
function usually raises @code{PyExc_TypeError}.  If you have an argument whose
value must be in a particular range or must satisfy other conditions,
@code{PyExc_ValueError} is appropriate.

También puede definir una nueva excepción que sea exclusiva de su módulo. Para esto, generalmente declara una variable de objeto estático al comienzo de su archivo:

@example
static PyObject *SpamError;
@end example

and initialize it in your module’s initialization function (@code{PyInit_spam()})
with an exception object:

@example
PyMODINIT_FUNC
PyInit_spam(void)
@{
    PyObject *m;

    m = PyModule_Create(&spammodule);
    if (m == NULL)
        return NULL;

    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    if (PyModule_AddObjectRef(m, "error", SpamError) < 0) @{
        Py_CLEAR(SpamError);
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Note that the Python name for the exception object is @code{spam.error}.  The
@ref{12d7,,PyErr_NewException()} function may create a class with the base class
being @ref{a6b,,Exception} (unless another class is passed in instead of @code{NULL}),
described in @ref{188b,,Excepciones incorporadas}.

Note also that the @code{SpamError} variable retains a reference to the newly
created exception class; this is intentional!  Since the exception could be
removed from the module by external code, an owned reference to the class is
needed to ensure that it will not be discarded, causing @code{SpamError} to
become a dangling pointer. Should it become a dangling pointer, C code which
raises the exception could cause a core dump or other unintended side effects.

We discuss the use of @ref{1513,,PyMODINIT_FUNC} as a function return type later in this
sample.

The @code{spam.error} exception can be raised in your extension module using a
call to @ref{620,,PyErr_SetString()} as shown below:

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    if (sts < 0) @{
        PyErr_SetString(SpamError, "System command failed");
        return NULL;
    @}
    return PyLong_FromLong(sts);
@}
@end example

@node De vuelta al ejemplo,La tabla de métodos del módulo y la función de inicialización,Intermezzo errores y excepciones,Extendiendo Python con C o C++
@anchor{extending/extending back-to-the-example}@anchor{482f}@anchor{extending/extending backtoexample}@anchor{4830}
@subsubsection De vuelta al ejemplo


Volviendo a nuestra función de ejemplo, ahora debería poder comprender esta declaración:

@example
if (!PyArg_ParseTuple(args, "s", &command))
    return NULL;
@end example

It returns @code{NULL} (the error indicator for functions returning object pointers)
if an error is detected in the argument list, relying on the exception set by
@ref{615,,PyArg_ParseTuple()}.  Otherwise the string value of the argument has been
copied to the local variable @code{command}.  This is a pointer assignment and
you are not supposed to modify the string to which it points (so in Standard C,
the variable @code{command} should properly be declared as @code{const char
*command}).

La siguiente declaración es una llamada a la función Unix @code{system()}, pasándole la cadena que acabamos de obtener de @ref{615,,PyArg_ParseTuple()}:

@example
sts = system(command);
@end example

Our @code{spam.system()} function must return the value of @code{sts} as a
Python object.  This is done using the function @ref{1840,,PyLong_FromLong()}.

@example
return PyLong_FromLong(sts);
@end example

En este caso, retornará un objeto entero. (Sí, ¡incluso los enteros son objetos en el montículo (`heap') en Python!)

Si tiene una función C que no retorna ningún argumento útil (una función que retorna void), la función de Python correspondiente debe retornar @code{None}. Necesita esta expresión para hacerlo (que se implementa mediante la macro @ref{14b0,,Py_RETURN_NONE}):

@example
Py_INCREF(Py_None);
return Py_None;
@end example

@ref{4831,,Py_None} es el nombre C para el objeto especial de Python @code{None}. Es un objeto genuino de Python en lugar de un puntero @code{NULL}, que significa «error» en la mayoría de los contextos, como hemos visto.

@node La tabla de métodos del módulo y la función de inicialización,Compilación y enlazamiento,De vuelta al ejemplo,Extendiendo Python con C o C++
@anchor{extending/extending methodtable}@anchor{4832}@anchor{extending/extending the-module-s-method-table-and-initialization-function}@anchor{4833}
@subsubsection La tabla de métodos del módulo y la función de inicialización


I promised to show how @code{spam_system()} is called from Python programs.
First, we need to list its name and address in a «method table»:

@example
static PyMethodDef SpamMethods[] = @{
    ...
    @{"system",  spam_system, METH_VARARGS,
     "Execute a shell command."@},
    ...
    @{NULL, NULL, 0, NULL@}        /* Sentinel */
@};
@end example

Tenga en cuenta la tercera entrada (@code{METH_VARARGS}). Esta es una bandera que le dice al intérprete la convención de llamada que se utilizará para la función C. Normalmente debería ser siempre @code{METH_VARARGS} o @code{METH_VARARGS | METH_KEYWORDS}; un valor de @code{0} significa que se usa una variante obsoleta de @ref{615,,PyArg_ParseTuple()}.

Cuando se usa solo @code{METH_VARARGS}, la función debe esperar que los parámetros a nivel de Python se pasen como una tupla aceptable para el análisis mediante @ref{615,,PyArg_ParseTuple()}; A continuación se proporciona más información sobre esta función.

The @ref{4834,,METH_KEYWORDS} bit may be set in the third field if keyword
arguments should be passed to the function.  In this case, the C function should
accept a third @code{PyObject *} parameter which will be a dictionary of keywords.
Use @ref{475,,PyArg_ParseTupleAndKeywords()} to parse the arguments to such a
function.

La tabla de métodos debe ser referenciada en la estructura de definición del módulo:

@example
static struct PyModuleDef spammodule = @{
    PyModuleDef_HEAD_INIT,
    "spam",   /* name of module */
    spam_doc, /* module documentation, may be NULL */
    -1,       /* size of per-interpreter state of the module,
                 or -1 if the module keeps state in global variables. */
    SpamMethods
@};
@end example

This structure, in turn, must be passed to the interpreter in the module’s
initialization function.  The initialization function must be named
@code{PyInit_name()}, where `name' is the name of the module, and should be the
only non-@code{static} item defined in the module file:

@example
PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModule_Create(&spammodule);
@}
@end example

Note that @ref{1513,,PyMODINIT_FUNC} declares the function as @code{PyObject *} return type,
declares any special linkage declarations required by the platform, and for C++
declares the function as @code{extern "C"}.

When the Python program imports module @code{spam} for the first time,
@code{PyInit_spam()} is called. (See below for comments about embedding Python.)
It calls @ref{4835,,PyModule_Create()}, which returns a module object, and
inserts built-in function objects into the newly created module based upon the
table (an array of @ref{1517,,PyMethodDef} structures) found in the module definition.
@ref{4835,,PyModule_Create()} returns a pointer to the module object
that it creates.  It may abort with a fatal error for
certain errors, or return @code{NULL} if the module could not be initialized
satisfactorily. The init function must return the module object to its caller,
so that it then gets inserted into @code{sys.modules}.

When embedding Python, the @code{PyInit_spam()} function is not called
automatically unless there’s an entry in the @code{PyImport_Inittab} table.
To add the module to the initialization table, use @ref{17ab,,PyImport_AppendInittab()},
optionally followed by an import of the module:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyStatus status;
    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* Add a built-in module, before Py_Initialize */
    if (PyImport_AppendInittab("spam", PyInit_spam) == -1) @{
        fprintf(stderr, "Error: could not extend in-built modules table\n");
        exit(1);
    @}

    /* Pass argv[0] to the Python interpreter */
    status = PyConfig_SetBytesString(&config, &config.program_name, argv[0]);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    /* Initialize the Python interpreter.  Required.
       If this step fails, it will be a fatal error. */
    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    /* Optionally import the module; alternatively,
       import can be deferred until the embedded script
       imports it. */
    PyObject *pmodule = PyImport_ImportModule("spam");
    if (!pmodule) @{
        PyErr_Print();
        fprintf(stderr, "Error: could not import module 'spam'\n");
    @}

    // ... use Python C API here ...

    return 0;

  exception:
     PyConfig_Clear(&config);
     Py_ExitStatusException(status);
@}
@end example

@cartouche
@quotation Nota 
Eliminar entradas de @code{sys.modules} o importar módulos compilados en múltiples intérpretes dentro de un proceso (o seguir un @code{fork()} sin una intervención @code{exec()}) puede crear problemas para algunas extensiones de módulos. Los autores de módulos de extensiones deben tener precaución al inicializar estructuras de datos internas.
@end quotation
@end cartouche

Se incluye un módulo de ejemplo más sustancial en la distribución fuente de Python como @code{Modules/xxmodule.c}. Este archivo puede usarse como plantilla o simplemente leerse como ejemplo.

@cartouche
@quotation Nota 
A diferencia de nuestro ejemplo de @code{spam}, @code{xxmodule} usa `inicialización de múltiples fases' (nuevo en Python 3.5), donde se retorna una estructura PyModuleDef de @code{PyInit_spam}, y la creación del módulo se deja al maquinaria de importación. Para obtener detalles sobre la inicialización múltiples fases, consulte 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}.
@end quotation
@end cartouche

@node Compilación y enlazamiento,Llamando funciones Python desde C,La tabla de métodos del módulo y la función de inicialización,Extendiendo Python con C o C++
@anchor{extending/extending compilation}@anchor{4836}@anchor{extending/extending compilation-and-linkage}@anchor{4837}
@subsubsection Compilación y enlazamiento


Hay dos cosas más que hacer antes de que pueda usar su nueva extensión: compilarla y vincularla con el sistema Python. Si usa carga dinámica, los detalles pueden depender del estilo de carga dinámica que usa su sistema; Para obtener más información al respecto, consulte los capítulos sobre la creación de módulos de extensión (capítulo @ref{4838,,Construyendo extensiones C y C++}) e información adicional que se refiere solo a la construcción en Windows (capítulo @ref{1e3e,,Creación de extensiones C y C++ en Windows}).

Si no puede utilizar la carga dinámica, o si desea que su módulo sea una parte permanente del intérprete de Python, tendrá que cambiar la configuración (`setup') y reconstruir el intérprete. Afortunadamente, esto es muy simple en Unix: simplemente coloque su archivo (@code{spammodule.c} por ejemplo) en el directorio @code{Modules/ ` de una distribución fuente desempaquetada, agregue una línea al archivo :file:`Modules/Setup.local} que describe su archivo:

@example
spam spammodule.o
@end example

y reconstruya el intérprete ejecutando @code{make} en el directorio de nivel superior. También puede ejecutar @code{make} en el subdirectorio @code{Modules/}, pero primero debe reconstruir @code{Makefile} ejecutando “@code{make} Makefile”. (Esto es necesario cada vez que cambia el archivo @code{Configuración}).

Si su módulo requiere bibliotecas adicionales para vincular, también se pueden enumerar en la línea del archivo de configuración, por ejemplo:

@example
spam spammodule.o -lX11
@end example

@node Llamando funciones Python desde C,Extracción de parámetros en funciones de extensión,Compilación y enlazamiento,Extendiendo Python con C o C++
@anchor{extending/extending calling-python-functions-from-c}@anchor{4839}@anchor{extending/extending callingpython}@anchor{483a}
@subsubsection Llamando funciones Python desde C


Hasta ahora nos hemos concentrado en hacer que las funciones de C puedan llamarse desde Python. Lo contrario también es útil: llamar a las funciones de Python desde C. Este es especialmente el caso de las bibliotecas que admiten las llamadas funciones de «retrollamada». Si una interfaz C utiliza retrollamadas, el Python equivalente a menudo necesita proporcionar un mecanismo de retrollamada al programador de Python; la implementación requerirá llamar a las funciones de retrollamada de Python desde una retrollamada en C. Otros usos también son imaginables.

Afortunadamente, el intérprete de Python se llama fácilmente de forma recursiva, y hay una interfaz estándar para llamar a una función de Python. (No me detendré en cómo llamar al analizador Python con una cadena particular como entrada — si está interesado, eche un vistazo a la implementación de la opción de línea de comando @ref{681,,-c} en @code{Modules/main.c} del código fuente de Python.)

Llamar a una función de Python es fácil. Primero, el programa Python debe de alguna manera pasar el objeto de función Python. Debe proporcionar una función (o alguna otra interfaz) para hacer esto. Cuando se llama a esta función, guarde un puntero en el objeto de la función Python (tenga cuidado de usar @ref{612,,Py_INCREF()}) En una variable global — o donde mejor le parezca. Por ejemplo, la siguiente función podría ser parte de una definición de módulo:

@example
static PyObject *my_callback = NULL;

static PyObject *
my_set_callback(PyObject *dummy, PyObject *args)
@{
    PyObject *result = NULL;
    PyObject *temp;

    if (PyArg_ParseTuple(args, "O:set_callback", &temp)) @{
        if (!PyCallable_Check(temp)) @{
            PyErr_SetString(PyExc_TypeError, "parameter must be callable");
            return NULL;
        @}
        Py_XINCREF(temp);         /* Add a reference to new callback */
        Py_XDECREF(my_callback);  /* Dispose of previous callback */
        my_callback = temp;       /* Remember new callback */
        /* Boilerplate to return "None" */
        Py_INCREF(Py_None);
        result = Py_None;
    @}
    return result;
@}
@end example

This function must be registered with the interpreter using the
@ref{154a,,METH_VARARGS} flag; this is described in section @ref{4832,,La tabla de métodos del módulo y la función de inicialización}.  The
@ref{615,,PyArg_ParseTuple()} function and its arguments are documented in section
@ref{483b,,Extracción de parámetros en funciones de extensión}.

Las macros @ref{af5,,Py_XINCREF()} y @ref{828,,Py_XDECREF()} incrementan/disminuyen el recuento de referencia de un objeto y son seguros en presencia de punteros @code{NULL} (pero tenga en cuenta que `temp' no lo hará ser @code{NULL} en este contexto). Más información sobre ellos en la sección @ref{483c,,Conteo de referencias}.

@geindex PyObject_CallObject (C function)

Más tarde, cuando es hora de llamar a la función, llama a la función C @ref{483d,,PyObject_CallObject()}. Esta función tiene dos argumentos, ambos punteros a objetos arbitrarios de Python: la función Python y la lista de argumentos. La lista de argumentos siempre debe ser un objeto de tupla, cuya longitud es el número de argumentos. Para llamar a la función Python sin argumentos, pase @code{NULL} o una tupla vacía; para llamarlo con un argumento, pasa una tupla singleton. @ref{940,,Py_BuildValue()} retorna una tupla cuando su cadena de formato consta de cero o más códigos de formato entre paréntesis. Por ejemplo:

@example
int arg;
PyObject *arglist;
PyObject *result;
...
arg = 123;
...
/* Time to call the callback */
arglist = Py_BuildValue("(i)", arg);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);
@end example

@ref{483d,,PyObject_CallObject()} retorna un puntero de objeto Python: este es el valor de retorno de la función Python. @ref{483d,,PyObject_CallObject()} es «recuento-referencia-neutral» con respecto a sus argumentos. En el ejemplo, se creó una nueva tupla para servir como lista de argumentos, a la cual se le llama @ref{613,,Py_DECREF()} inmediatamente después de la llamada @ref{483d,,PyObject_CallObject()}.

El valor de retorno de @ref{483d,,PyObject_CallObject()} es «nuevo»: o bien es un objeto nuevo o es un objeto existente cuyo recuento de referencias se ha incrementado. Por lo tanto, a menos que desee guardarlo en una variable global, debería de alguna manera @ref{613,,Py_DECREF()} el resultado, incluso (¡especialmente!) Si no está interesado en su valor.

Sin embargo, antes de hacer esto, es importante verificar que el valor de retorno no sea @code{NULL}. Si es así, la función de Python terminó generando una excepción. Si el código C que llamó @ref{483d,,PyObject_CallObject()} se llama desde Python, ahora debería retornar una indicación de error a su llamador de Python, para que el intérprete pueda imprimir un seguimiento de la pila, o el código de Python que llama puede manejar la excepción. Si esto no es posible o deseable, la excepción se debe eliminar llamando a @ref{10ad,,PyErr_Clear()}. Por ejemplo:

@example
if (result == NULL)
    return NULL; /* Pass error back */
...use result...
Py_DECREF(result);
@end example

Dependiendo de la interfaz deseada para la función de retrollamada de Python, es posible que también deba proporcionar una lista de argumentos para @ref{483d,,PyObject_CallObject()}. En algunos casos, el programa Python también proporciona la lista de argumentos, a través de la misma interfaz que especificó la función de retrollamada. Luego se puede guardar y usar de la misma manera que el objeto de función. En otros casos, puede que tenga que construir una nueva tupla para pasarla como lista de argumentos. La forma más sencilla de hacer esto es llamar a @ref{940,,Py_BuildValue()}. Por ejemplo, si desea pasar un código de evento integral, puede usar el siguiente código:

@example
PyObject *arglist;
...
arglist = Py_BuildValue("(l)", eventcode);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);
if (result == NULL)
    return NULL; /* Pass error back */
/* Here maybe use the result */
Py_DECREF(result);
@end example

¡Observe la ubicación de @code{Py_DECREF(arglist)} inmediatamente después de la llamada, antes de la verificación de errores! También tenga en cuenta que, estrictamente hablando, este código no está completo: @ref{940,,Py_BuildValue()} puede quedarse sin memoria, y esto debe verificarse.

También puede llamar a una función con argumentos de palabras clave utilizando @ref{48f,,PyObject_Call()}, que admite argumentos y argumentos de palabras clave. Como en el ejemplo anterior, usamos @ref{940,,Py_BuildValue()} para construir el diccionario.

@example
PyObject *dict;
...
dict = Py_BuildValue("@{s:i@}", "name", val);
result = PyObject_Call(my_callback, NULL, dict);
Py_DECREF(dict);
if (result == NULL)
    return NULL; /* Pass error back */
/* Here maybe use the result */
Py_DECREF(result);
@end example

@node Extracción de parámetros en funciones de extensión,Parámetros de palabras clave para funciones de extensión,Llamando funciones Python desde C,Extendiendo Python con C o C++
@anchor{extending/extending extracting-parameters-in-extension-functions}@anchor{483e}@anchor{extending/extending parsetuple}@anchor{483b}
@subsubsection Extracción de parámetros en funciones de extensión


@geindex PyArg_ParseTuple (C function)

La función @ref{615,,PyArg_ParseTuple()} se declara de la siguiente manera:

@example
int PyArg_ParseTuple(PyObject *arg, const char *format, ...);
@end example

El argumento `arg' debe ser un objeto de tupla que contenga una lista de argumentos pasada de Python a una función C. El argumento `format' debe ser una cadena de formato, cuya sintaxis se explica en @ref{941,,Analizando argumentos y construyendo valores} en el Manual de referencia de la API de Python/C. Los argumentos restantes deben ser direcciones de variables cuyo tipo está determinado por la cadena de formato.

Tenga en cuenta que si bien @ref{615,,PyArg_ParseTuple()} verifica que los argumentos de Python tengan los tipos requeridos, no puede verificar la validez de las direcciones de las variables C pasadas a la llamada: si comete errores allí, su código probablemente se bloqueará o al menos sobrescribir bits aleatorios en la memoria. ¡Así que ten cuidado!

Tenga en cuenta que las referencias de objetos de Python que se proporcionan a quien llama son referencias prestadas (`borrowed'); ¡no disminuya su recuento de referencias!

Algunas llamadas de ejemplo:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

@example
int ok;
int i, j;
long k, l;
const char *s;
Py_ssize_t size;

ok = PyArg_ParseTuple(args, ""); /* No arguments */
    /* Python call: f() */
@end example

@example
ok = PyArg_ParseTuple(args, "s", &s); /* A string */
    /* Possible Python call: f('whoops!') */
@end example

@example
ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */
    /* Possible Python call: f(1, 2, 'three') */
@end example

@example
ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);
    /* A pair of ints and a string, whose size is also returned */
    /* Possible Python call: f((1, 2), 'three') */
@end example

@example
@{
    const char *file;
    const char *mode = "r";
    int bufsize = 0;
    ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);
    /* A string, and optionally another string and an integer */
    /* Possible Python calls:
       f('spam')
       f('spam', 'w')
       f('spam', 'wb', 100000) */
@}
@end example

@example
@{
    int left, top, right, bottom, h, v;
    ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",
             &left, &top, &right, &bottom, &h, &v);
    /* A rectangle and a point */
    /* Possible Python call:
       f(((0, 0), (400, 300)), (10, 10)) */
@}
@end example

@example
@{
    Py_complex c;
    ok = PyArg_ParseTuple(args, "D:myfunction", &c);
    /* a complex, also providing a function name for errors */
    /* Possible Python call: myfunction(1+2j) */
@}
@end example

@node Parámetros de palabras clave para funciones de extensión,Construyendo valores arbitrarios,Extracción de parámetros en funciones de extensión,Extendiendo Python con C o C++
@anchor{extending/extending keyword-parameters-for-extension-functions}@anchor{483f}@anchor{extending/extending parsetupleandkeywords}@anchor{4840}
@subsubsection Parámetros de palabras clave para funciones de extensión


@geindex PyArg_ParseTupleAndKeywords (C function)

La función @ref{475,,PyArg_ParseTupleAndKeywords()} se declara de la siguiente manera:

@example
int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
                                const char *format, char * const *kwlist, ...);
@end example

Los parámetros `arg' y `format' son idénticos a los de la función @ref{615,,PyArg_ParseTuple()}. El parámetro `kwdict' es el diccionario de palabras clave recibidas como tercer parámetro del tiempo de ejecución de Python. El parámetro `kwlist' es una lista de cadenas terminadas en @code{NULL} que identifican los parámetros; los nombres se corresponden con la información de tipo de `format' de izquierda a derecha. En caso de éxito, @ref{475,,PyArg_ParseTupleAndKeywords()} retorna verdadero; de lo contrario, retorna falso y genera una excepción apropiada.

@cartouche
@quotation Nota 
¡Las tuplas anidadas no se pueden analizar al usar argumentos de palabras clave! Los parámetros de palabras clave pasados que no están presentes en la `kwlist' provocarán que se genere @ref{228,,TypeError}.
@end quotation
@end cartouche

@geindex Philbrick@comma{} Geoff

Aquí hay un módulo de ejemplo que usa palabras clave, basado en un ejemplo de `Geoff Philbrick (philbrick@@hks.com)':

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

static PyObject *
keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds)
@{
    int voltage;
    const char *state = "a stiff";
    const char *action = "voom";
    const char *type = "Norwegian Blue";

    static char *kwlist[] = @{"voltage", "state", "action", "type", NULL@};

    if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist,
                                     &voltage, &state, &action, &type))
        return NULL;

    printf("-- This parrot wouldn't %s if you put %i Volts through it.\n",
           action, voltage);
    printf("-- Lovely plumage, the %s -- It's %s!\n", type, state);

    Py_RETURN_NONE;
@}

static PyMethodDef keywdarg_methods[] = @{
    /* The cast of the function is necessary since PyCFunction values
     * only take two PyObject* parameters, and keywdarg_parrot() takes
     * three.
     */
    @{"parrot", (PyCFunction)(void(*)(void))keywdarg_parrot, METH_VARARGS | METH_KEYWORDS,
     "Print a lovely skit to standard output."@},
    @{NULL, NULL, 0, NULL@}   /* sentinel */
@};

static struct PyModuleDef keywdargmodule = @{
    PyModuleDef_HEAD_INIT,
    "keywdarg",
    NULL,
    -1,
    keywdarg_methods
@};

PyMODINIT_FUNC
PyInit_keywdarg(void)
@{
    return PyModule_Create(&keywdargmodule);
@}
@end example

@node Construyendo valores arbitrarios,Conteo de referencias,Parámetros de palabras clave para funciones de extensión,Extendiendo Python con C o C++
@anchor{extending/extending building-arbitrary-values}@anchor{4841}@anchor{extending/extending buildvalue}@anchor{4842}
@subsubsection Construyendo valores arbitrarios


Esta función es la contraparte de @ref{615,,PyArg_ParseTuple()}. Se declara de la siguiente manera:

@example
PyObject *Py_BuildValue(const char *format, ...);
@end example

Reconoce un conjunto de unidades de formato similares a las reconocidas por @ref{615,,PyArg_ParseTuple()}, pero los argumentos (que son de entrada a la función, no de salida) no deben ser punteros, solo valores. Retorna un nuevo objeto Python, adecuado para regresar de una función C llamada desde Python.

Una diferencia con @ref{615,,PyArg_ParseTuple()}: mientras que este último requiere que su primer argumento sea una tupla (ya que las listas de argumentos de Python siempre se representan como tuplas internamente), @ref{940,,Py_BuildValue()} no siempre construye una tupla . Construye una tupla solo si su cadena de formato contiene dos o más unidades de formato. Si la cadena de formato está vacía, retorna @code{None}; si contiene exactamente una unidad de formato, retorna el objeto que describa esa unidad de formato. Para forzarlo a retornar una tupla de tamaño 0 o uno, agregar paréntesis a la cadena de formato.

Ejemplos (a la izquierda la llamada, a la derecha el valor de Python resultante):

@example
Py_BuildValue("")                        None
Py_BuildValue("i", 123)                  123
Py_BuildValue("iii", 123, 456, 789)      (123, 456, 789)
Py_BuildValue("s", "hello")              'hello'
Py_BuildValue("y", "hello")              b'hello'
Py_BuildValue("ss", "hello", "world")    ('hello', 'world')
Py_BuildValue("s#", "hello", 4)          'hell'
Py_BuildValue("y#", "hello", 4)          b'hell'
Py_BuildValue("()")                      ()
Py_BuildValue("(i)", 123)                (123,)
Py_BuildValue("(ii)", 123, 456)          (123, 456)
Py_BuildValue("(i,i)", 123, 456)         (123, 456)
Py_BuildValue("[i,i]", 123, 456)         [123, 456]
Py_BuildValue("@{s:i,s:i@}",
              "abc", 123, "def", 456)    @{'abc': 123, 'def': 456@}
Py_BuildValue("((ii)(ii)) (ii)",
              1, 2, 3, 4, 5, 6)          (((1, 2), (3, 4)), (5, 6))
@end example

@node Conteo de referencias,Escribiendo extensiones en C++,Construyendo valores arbitrarios,Extendiendo Python con C o C++
@anchor{extending/extending refcounts}@anchor{483c}@anchor{extending/extending reference-counts}@anchor{4843}
@subsubsection Conteo de referencias


En lenguajes como C o C++, el programador es responsable de la asignación dinámica y la desasignación de memoria en el montón. En C, esto se hace usando las funciones @code{malloc()} y @code{free()}. En C++, los operadores @code{new} y @code{delete} se usan esencialmente con el mismo significado y restringiremos la siguiente discusión al caso C.

Every block of memory allocated with @code{malloc()} should eventually be
returned to the pool of available memory by exactly one call to @code{free()}.
It is important to call @code{free()} at the right time.  If a block’s address
is forgotten but @code{free()} is not called for it, the memory it occupies
cannot be reused until the program terminates.  This is called a `memory
leak'.  On the other hand, if a program calls @code{free()} for a block and then
continues to use the block, it creates a conflict with reuse of the block
through another @code{malloc()} call.  This is called `using freed memory'.
It has the same bad consequences as referencing uninitialized data — core
dumps, wrong results, mysterious crashes.

Las causas comunes de pérdidas de memoria son rutas inusuales a través del código. Por ejemplo, una función puede asignar un bloque de memoria, hacer algunos cálculos y luego liberar el bloque nuevamente. Ahora, un cambio en los requisitos de la función puede agregar una prueba al cálculo que detecta una condición de error y puede regresar prematuramente de la función. Es fácil olvidar liberar el bloque de memoria asignado al tomar esta salida prematura, especialmente cuando se agrega más tarde al código. Tales filtraciones, una vez introducidas, a menudo pasan desapercibidas durante mucho tiempo: la salida del error se toma solo en una pequeña fracción de todas las llamadas, y la mayoría de las máquinas modernas tienen mucha memoria virtual, por lo que la filtración solo se hace evidente en un proceso de larga ejecución que usa la función de fugas con frecuencia. Por lo tanto, es importante evitar que se produzcan fugas mediante una convención o estrategia de codificación que minimice este tipo de errores.

Dado que Python hace un uso intensivo de @code{malloc()} y @code{free()}, necesita una estrategia para evitar pérdidas de memoria, así como el uso de memoria liberada. El método elegido se llama `recuento de referencias'. El principio es simple: cada objeto contiene un contador, que se incrementa cuando se almacena una referencia al objeto en algún lugar, y que se reduce cuando se elimina una referencia al mismo. Cuando el contador llega a cero, la última referencia al objeto se ha eliminado y el objeto se libera.

Una estrategia alternativa se llama `recolección automática de basura'. (A veces, el recuento de referencias también se conoce como una estrategia de recolección de basura, de ahí mi uso de «automático» para distinguir los dos). La gran ventaja de la recolección automática de basura es que el usuario no necesita llamar a @code{free()} explícitamente. (Otra ventaja afirmada es una mejora en la velocidad o el uso de la memoria; sin embargo, esto no es un hecho difícil). La desventaja es que para C, no hay un recolector de basura automático verdaderamente portátil, mientras que el conteo de referencias se puede implementar de forma portátil (siempre que las funciones @code{malloc()} y @code{free()} están disponibles — que garantiza el estándar C). Tal vez algún día un recolector de basura automático lo suficientemente portátil estará disponible para C. Hasta entonces, tendremos que vivir con recuentos de referencia.

Si bien Python utiliza la implementación tradicional de conteo de referencias, también ofrece un detector de ciclos que funciona para detectar ciclos de referencia. Esto permite que las aplicaciones no se preocupen por crear referencias circulares directas o indirectas; Estas son las debilidades de la recolección de basura implementada utilizando solo el conteo de referencias. Los ciclos de referencia consisten en objetos que contienen referencias (posiblemente indirectas) a sí mismos, de modo que cada objeto en el ciclo tiene un recuento de referencias que no es cero. Las implementaciones típicas de recuento de referencias no pueden recuperar la memoria que pertenece a algún objeto en un ciclo de referencia, o referenciada a partir de los objetos en el ciclo, a pesar de que no hay más referencias al ciclo en sí.

El detector de ciclos es capaz de detectar ciclos basura y puede recuperarlos. El módulo @ref{60,,gc} expone una forma de ejecutar el detector (la función @ref{acc,,collect()}), así como interfaces de configuración y la posibilidad de desactivar el detector en tiempo de ejecución.

@menu
* Conteo de referencias en Python:: 
* Reglas de propiedad:: 
* Hielo delgado:: 
* Punteros NULL:: 

@end menu

@node Conteo de referencias en Python,Reglas de propiedad,,Conteo de referencias
@anchor{extending/extending refcountsinpython}@anchor{4844}@anchor{extending/extending reference-counting-in-python}@anchor{4845}
@subsubsection Conteo de referencias en Python


Hay dos macros, @code{Py_INCREF(x)} y @code{Py_DECREF(x)}, que manejan el incremento y la disminución del recuento de referencias. @ref{613,,Py_DECREF()} también libera el objeto cuando el recuento llega a cero. Por flexibilidad, no llama a @code{free()} directamente — más bien, realiza una llamada a través de un puntero de función en el objeto `type object'. Para este propósito (y otros), cada objeto también contiene un puntero a su objeto de tipo.

La gran pregunta ahora permanece: ¿cuándo usar @code{Py_INCREF(x)} y @code{Py_DECREF(x)}? Primero introduzcamos algunos términos. Nadie «posee» un objeto; sin embargo, puede `poseer una referencia' a un objeto. El recuento de referencias de un objeto ahora se define como el número de referencias que posee. El propietario de una referencia es responsable de llamar a @ref{613,,Py_DECREF()} cuando la referencia ya no es necesaria. La propiedad de una referencia puede ser transferida. Hay tres formas de deshacerse de una referencia de propiedad: pasarla, almacenarla o llamar a @ref{613,,Py_DECREF()}. Olvidar deshacerse de una referencia de propiedad crea una pérdida de memoria.

También es posible `tomar prestada' @footnote{
La metáfora de «pedir prestado» una referencia no es completamente correcta: el propietario todavía tiene una copia de la referencia.
} una referencia a un objeto. El prestatario de una referencia no debe llamar a @ref{613,,Py_DECREF()}. El prestatario no debe retener el objeto por más tiempo que el propietario del cual fue prestado. El uso de una referencia prestada después de que el propietario la haya eliminado corre el riesgo de usar memoria liberada y debe evitarse por completo @footnote{
¡Comprobar que el recuento de referencia es al menos 1 `no funciona' — el recuento de referencia en sí podría estar en la memoria liberada y, por lo tanto, puede reutilizarse para otro objeto!
}.

La ventaja de pedir prestado sobre tener una referencia es que no necesita ocuparse de disponer de la referencia en todas las rutas posibles a través del código — en otras palabras, con una referencia prestada no corre el riesgo de fugas cuando se toma una salida prematura. La desventaja de pedir prestado sobre la posesión es que hay algunas situaciones sutiles en las que, en un código aparentemente correcto, una referencia prestada se puede usar después de que el propietario del que se tomó prestado la haya eliminado.

Una referencia prestada se puede cambiar en una referencia de propiedad llamando a @ref{612,,Py_INCREF()}. Esto no afecta el estado del propietario del cual se tomó prestada la referencia: crea una nueva referencia de propiedad y otorga responsabilidades completas al propietario (el nuevo propietario debe disponer de la referencia correctamente, así como el propietario anterior).

@node Reglas de propiedad,Hielo delgado,Conteo de referencias en Python,Conteo de referencias
@anchor{extending/extending ownership-rules}@anchor{4846}@anchor{extending/extending ownershiprules}@anchor{4847}
@subsubsection Reglas de propiedad


Cuando una referencia de objeto se pasa dentro o fuera de una función, es parte de la especificación de la interfaz de la función si la propiedad se transfiere con la referencia o no.

La mayoría de las funciones que retornan una referencia a un objeto pasan de propiedad con la referencia. En particular, todas las funciones cuya función es crear un nuevo objeto, como @ref{1840,,PyLong_FromLong()} y @ref{940,,Py_BuildValue()}, pasan la propiedad al receptor. Incluso si el objeto no es realmente nuevo, aún recibirá la propiedad de una nueva referencia a ese objeto. Por ejemplo, @ref{1840,,PyLong_FromLong()} mantiene un caché de valores populares y puede retornar una referencia a un elemento en caché.

Muchas funciones que extraen objetos de otros objetos también transfieren la propiedad con la referencia, por ejemplo @ref{440,,PyObject_GetAttrString()}. Sin embargo, la imagen es menos clara aquí, ya que algunas rutinas comunes son excepciones: @ref{4848,,PyTuple_GetItem()}, @ref{450,,PyList_GetItem()}, @ref{479,,PyDict_GetItem()}, y @ref{47a,,PyDict_GetItemString()} todas las referencias retornadas que tomaste prestadas de la tupla, lista o diccionario.

La función @ref{44d,,PyImport_AddModule()} también retorna una referencia prestada, aunque en realidad puede crear el objeto que retorna: esto es posible porque una referencia de propiedad del objeto se almacena en @code{sys.modules}.

Cuando pasa una referencia de objeto a otra función, en general, la función toma prestada la referencia de usted — si necesita almacenarla, usará @ref{612,,Py_INCREF()} para convertirse en un propietario independiente. Hay exactamente dos excepciones importantes a esta regla: @ref{4849,,PyTuple_SetItem()} y @ref{484a,,PyList_SetItem()}. Estas funciones se hacen cargo de la propiedad del artículo que se les pasa, ¡incluso si fallan! (Tenga en cuenta que @ref{484b,,PyDict_SetItem()} y sus amigos no se hacen cargo de la propiedad — son «normales»)

Cuando se llama a una función C desde Python, toma de la persona que llama referencias a sus argumentos. Quien llama posee una referencia al objeto, por lo que la vida útil de la referencia prestada está garantizada hasta que la función regrese. Solo cuando dicha referencia prestada debe almacenarse o transmitirse, debe convertirse en una referencia propia llamando a @ref{612,,Py_INCREF()}.

La referencia de objeto retornada desde una función C que se llama desde Python debe ser una referencia de propiedad: la propiedad se transfiere de la función a su llamador.

@node Hielo delgado,Punteros NULL,Reglas de propiedad,Conteo de referencias
@anchor{extending/extending thin-ice}@anchor{484c}@anchor{extending/extending thinice}@anchor{484d}
@subsubsection Hielo delgado


Hay algunas situaciones en las que el uso aparentemente inofensivo de una referencia prestada puede generar problemas. Todo esto tiene que ver con invocaciones implícitas del intérprete, lo que puede hacer que el propietario de una referencia se deshaga de él.

El primer y más importante caso que debe conocer es el uso de @ref{613,,Py_DECREF()} en un objeto no relacionado mientras toma prestada una referencia a un elemento de la lista. Por ejemplo:

@example
void
bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);

    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    PyObject_Print(item, stdout, 0); /* BUG! */
@}
@end example

Esta función primero toma prestada una referencia a @code{list[0]}, luego reemplaza @code{list[1]} con el valor @code{0}, y finalmente imprime la referencia prestada. Parece inofensivo, ¿verdad? ¡Pero no lo es!

Let’s follow the control flow into @ref{484a,,PyList_SetItem()}.  The list owns
references to all its items, so when item 1 is replaced, it has to dispose of
the original item 1.  Now let’s suppose the original item 1 was an instance of a
user-defined class, and let’s further suppose that the class defined a
@code{__del__()} method.  If this class instance has a reference count of 1,
disposing of it will call its @code{__del__()} method.

Since it is written in Python, the @code{__del__()} method can execute arbitrary
Python code.  Could it perhaps do something to invalidate the reference to
@code{item} in @code{bug()}?  You bet!  Assuming that the list passed into
@code{bug()} is accessible to the @code{__del__()} method, it could execute a
statement to the effect of @code{del list[0]}, and assuming this was the last
reference to that object, it would free the memory associated with it, thereby
invalidating @code{item}.

La solución, una vez que conoce el origen del problema, es fácil: incremente temporalmente el recuento de referencia. La versión correcta de la función dice:

@example
void
no_bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);

    Py_INCREF(item);
    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    PyObject_Print(item, stdout, 0);
    Py_DECREF(item);
@}
@end example

This is a true story.  An older version of Python contained variants of this bug
and someone spent a considerable amount of time in a C debugger to figure out
why his @code{__del__()} methods would fail…

El segundo caso de problemas con una referencia prestada es una variante que involucra hilos. Normalmente, varios hilos en el intérprete de Python no pueden interponerse entre sí, porque hay un bloqueo global que protege todo el espacio de objetos de Python. Sin embargo, es posible liberar temporalmente este bloqueo usando la macro @ref{484e,,Py_BEGIN_ALLOW_THREADS}, y volver a adquirirlo usando @ref{b1a,,Py_END_ALLOW_THREADS}. Esto es común al bloquear las llamadas de E/S, para permitir que otros subprocesos usen el procesador mientras esperan que se complete la E/S. Obviamente, la siguiente función tiene el mismo problema que la anterior:

@example
void
bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);
    Py_BEGIN_ALLOW_THREADS
    ...some blocking I/O call...
    Py_END_ALLOW_THREADS
    PyObject_Print(item, stdout, 0); /* BUG! */
@}
@end example

@node Punteros NULL,,Hielo delgado,Conteo de referencias
@anchor{extending/extending null-pointers}@anchor{484f}@anchor{extending/extending nullpointers}@anchor{4850}
@subsubsection Punteros NULL


En general, las funciones que toman referencias de objetos como argumentos no esperan que les pase los punteros @code{NULL}, y volcará el núcleo (o causará volcados de núcleo posteriores) si lo hace. Las funciones que retornan referencias a objetos generalmente retornan @code{NULL} solo para indicar que ocurrió una excepción. La razón para no probar los argumentos @code{NULL} es que las funciones a menudo pasan los objetos que reciben a otra función — si cada función probara @code{NULL}, habría muchas pruebas redundantes y el código correría más lentamente.

Es mejor probar @code{NULL} solo en «source:» cuando se recibe un puntero que puede ser @code{NULL}, por ejemplo, de @code{malloc()} o de una función que puede plantear una excepción.

Las macros @ref{612,,Py_INCREF()} y @ref{613,,Py_DECREF()} no comprueban los punteros @code{NULL} — sin embargo, sus variantes @ref{af5,,Py_XINCREF()} y @ref{828,,Py_XDECREF()} lo hacen.

Las macros para verificar un tipo de objeto en particular (@code{Pytype_Check()}) no verifican los punteros @code{NULL} — nuevamente, hay mucho código que llama a varios de estos en una fila para probar un objeto contra varios tipos esperados diferentes, y esto generaría pruebas redundantes. No hay variantes con comprobación @code{NULL}.

El mecanismo de llamada a la función C garantiza que la lista de argumentos pasada a las funciones C (@code{args} en los ejemplos) nunca sea @code{NULL} — de hecho, garantiza que siempre sea una tupla @footnote{
Estas garantías no se cumplen cuando utiliza la convención de llamadas de estilo «antiguo», que todavía se encuentra en muchos códigos existentes.
}.

Es un error grave dejar que un puntero @code{NULL} «escape» al usuario de Python.

@c Frank Stajano:
@c A pedagogically buggy example, along the lines of the previous listing, would
@c be helpful here -- showing in more concrete terms what sort of actions could
@c cause the problem. I can't very well imagine it from the description.

@node Escribiendo extensiones en C++,Proporcionar una API C para un módulo de extensión,Conteo de referencias,Extendiendo Python con C o C++
@anchor{extending/extending cplusplus}@anchor{4851}@anchor{extending/extending writing-extensions-in-c}@anchor{4852}
@subsubsection Escribiendo extensiones en C++


Es posible escribir módulos de extensión en C++. Se aplican algunas restricciones. Si el compilador de C compila y vincula el programa principal (el intérprete de Python), no se pueden usar objetos globales o estáticos con constructores. Esto no es un problema si el programa principal está vinculado por el compilador de C++. Las funciones que serán llamadas por el intérprete de Python (en particular, las funciones de inicialización del módulo) deben declararse usando @code{extern "C"}. No es necesario encerrar los archivos de encabezado de Python en @code{extern "C" @{...@}} — ya usan este formulario si el símbolo @code{__cplusplus} está definido (todos los compiladores recientes de C++ definen este símbolo) .

@node Proporcionar una API C para un módulo de extensión,,Escribiendo extensiones en C++,Extendiendo Python con C o C++
@anchor{extending/extending providing-a-c-api-for-an-extension-module}@anchor{4853}@anchor{extending/extending using-capsules}@anchor{13bd}
@subsubsection Proporcionar una API C para un módulo de extensión


Muchos módulos de extensión solo proporcionan nuevas funciones y tipos para ser utilizados desde Python, pero a veces el código en un módulo de extensión puede ser útil para otros módulos de extensión. Por ejemplo, un módulo de extensión podría implementar un tipo de «colección» que funciona como listas sin orden. Al igual que el tipo de lista Python estándar tiene una API C que permite a los módulos de extensión crear y manipular listas, este nuevo tipo de colección debe tener un conjunto de funciones C para la manipulación directa desde otros módulos de extensión.

A primera vista, esto parece fácil: simplemente escriba las funciones (sin declararlas @code{static}, por supuesto), proporcione un archivo de encabezado apropiado y documente la API de C. Y, de hecho, esto funcionaría si todos los módulos de extensión siempre estuvieran vinculados estáticamente con el intérprete de Python. Sin embargo, cuando los módulos se usan como bibliotecas compartidas, los símbolos definidos en un módulo pueden no ser visibles para otro módulo. Los detalles de visibilidad dependen del sistema operativo; algunos sistemas usan un espacio de nombres global para el intérprete de Python y todos los módulos de extensión (Windows, por ejemplo), mientras que otros requieren una lista explícita de símbolos importados en el momento del enlace del módulo (AIX es un ejemplo) u ofrecen una variedad de estrategias diferentes (la mayoría Unices). E incluso si los símbolos son visibles a nivel mundial, ¡el módulo cuyas funciones uno desea llamar podría no haberse cargado todavía!

Por lo tanto, la portabilidad requiere no hacer suposiciones sobre la visibilidad del símbolo. Esto significa que todos los símbolos en los módulos de extensión deben declararse @code{static}, excepto la función de inicialización del módulo, para evitar conflictos de nombres con otros módulos de extensión (como se discutió en la sección @ref{4832,,La tabla de métodos del módulo y la función de inicialización}). Y significa que los símbolos que `deberían' ser accesibles desde otros módulos de extensión deben exportarse de una manera diferente.

Python proporciona un mecanismo especial para pasar información de nivel C (punteros) de un módulo de extensión a otro: cápsulas. Una cápsula es un tipo de datos de Python que almacena un puntero (void*). Solo se puede crear y acceder a las cápsulas a través de su API C, pero se pueden pasar como cualquier otro objeto de Python. En particular, se pueden asignar a un nombre en el espacio de nombres de un módulo de extensión. Otros módulos de extensión pueden importar este módulo, recuperar el valor de este nombre y luego recuperar el puntero de la Cápsula.

Hay muchas formas en que las Cápsulas se pueden usar para exportar la API de C de un módulo de extensión. Cada función podría tener su propia cápsula, o todos los punteros de API C podrían almacenarse en una matriz cuya dirección se publica en una cápsula. Y las diversas tareas de almacenamiento y recuperación de los punteros se pueden distribuir de diferentes maneras entre el módulo que proporciona el código y los módulos del cliente.

Cualquiera que sea el método que elija, es importante nombrar correctamente sus Cápsulas. La función @ref{4854,,PyCapsule_New()} toma un parámetro de nombre (const char*); se le permite pasar un nombre @code{NULL}, pero le recomendamos encarecidamente que especifique un nombre. Las Cápsulas correctamente nombradas brindan un grado de seguridad de tipo de tiempo de ejecución; no hay una forma factible de distinguir una Cápsula sin nombre de otra.

En particular, las cápsulas utilizadas para exponer las API de C deben recibir un nombre siguiendo esta convención:

@example
modulename.attributename
@end example

La función de conveniencia @ref{1875,,PyCapsule_Import()} facilita la carga de una API C proporcionada a través de una cápsula, pero solo si el nombre de la cápsula coincide con esta convención. Este comportamiento brinda a los usuarios de C API un alto grado de certeza de que la Cápsula que cargan contiene la API de C correcta.

El siguiente ejemplo demuestra un enfoque que pone la mayor parte de la carga sobre el escritor del módulo de exportación, que es apropiado para los módulos de biblioteca de uso común. Almacena todos los punteros de la API de C (¡solo uno en el ejemplo!) en un arreglo de punteros void que se convierte en el valor de una Cápsula. El archivo de encabezado correspondiente al módulo proporciona una macro que se encarga de importar el módulo y recuperar sus punteros C API; los módulos de cliente solo tienen que llamar a esta macro antes de acceder a la API de C.

The exporting module is a modification of the @code{spam} module from section
@ref{482a,,Un ejemplo simple}. The function @code{spam.system()} does not call
the C library function @code{system()} directly, but a function
@code{PySpam_System()}, which would of course do something more complicated in
reality (such as adding «spam» to every command). This function
@code{PySpam_System()} is also exported to other extension modules.

The function @code{PySpam_System()} is a plain C function, declared
@code{static} like everything else:

@example
static int
PySpam_System(const char *command)
@{
    return system(command);
@}
@end example

The function @code{spam_system()} is modified in a trivial way:

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = PySpam_System(command);
    return PyLong_FromLong(sts);
@}
@end example

Al comienzo del módulo, justo después de la línea:

@example
#include <Python.h>
@end example

se deben agregar dos líneas más:

@example
#define SPAM_MODULE
#include "spammodule.h"
@end example

El @code{#define} se usa para decirle al archivo de encabezado que se está incluyendo en el módulo de exportación, no en un módulo de cliente. Finalmente, la función de inicialización del módulo debe encargarse de inicializar la matriz de punteros de API C:

@example
PyMODINIT_FUNC
PyInit_spam(void)
@{
    PyObject *m;
    static void *PySpam_API[PySpam_API_pointers];
    PyObject *c_api_object;

    m = PyModule_Create(&spammodule);
    if (m == NULL)
        return NULL;

    /* Initialize the C API pointer array */
    PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;

    /* Create a Capsule containing the API pointer array's address */
    c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);

    if (PyModule_Add(m, "_C_API", c_api_object) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Note that @code{PySpam_API} is declared @code{static}; otherwise the pointer
array would disappear when @code{PyInit_spam()} terminates!

La mayor parte del trabajo está en el archivo de encabezado @code{spammodule.h}, que se ve así:

@example
#ifndef Py_SPAMMODULE_H
#define Py_SPAMMODULE_H
#ifdef __cplusplus
extern "C" @{
#endif

/* Header file for spammodule */

/* C API functions */
#define PySpam_System_NUM 0
#define PySpam_System_RETURN int
#define PySpam_System_PROTO (const char *command)

/* Total number of C API pointers */
#define PySpam_API_pointers 1


#ifdef SPAM_MODULE
/* This section is used when compiling spammodule.c */

static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;

#else
/* This section is used in modules that use spammodule's API */

static void **PySpam_API;

#define PySpam_System \
 (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])

/* Return -1 on error, 0 on success.
 * PyCapsule_Import will set an exception if there's an error.
 */
static int
import_spam(void)
@{
    PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0);
    return (PySpam_API != NULL) ? 0 : -1;
@}

#endif

#ifdef __cplusplus
@}
#endif

#endif /* !defined(Py_SPAMMODULE_H) */
@end example

All that a client module must do in order to have access to the function
@code{PySpam_System()} is to call the function (or rather macro)
@code{import_spam()} in its initialization function:

@example
PyMODINIT_FUNC
PyInit_client(void)
@{
    PyObject *m;

    m = PyModule_Create(&clientmodule);
    if (m == NULL)
        return NULL;
    if (import_spam() < 0)
        return NULL;
    /* additional initialization can happen here */
    return m;
@}
@end example

La principal desventaja de este enfoque es que el archivo @code{spammodule.h} es bastante complicado. Sin embargo, la estructura básica es la misma para cada función que se exporta, por lo que solo se debe aprender una vez.

Finalmente, debe mencionarse que las cápsulas ofrecen una funcionalidad adicional, que es especialmente útil para la asignación de memoria y la desasignación del puntero almacenado en una cápsula. Los detalles se describen en el Manual de referencia de Python/C API en la sección @ref{257a,,Cápsulas} y en la implementación de Capsules (archivos @code{Include/pycapsule.h} y @code{Objects/pycapsule.c} en la distribución del código fuente de Python).

@subsubheading Notas al pie de página


@node Definición de tipos de extensión Tutorial,Definición de tipos de extensión temas variados,Extendiendo Python con C o C++,Crear extensiones sin herramientas de terceros
@anchor{extending/newtypes_tutorial doc}@anchor{1831}@anchor{extending/newtypes_tutorial defining-extension-types-tutorial}@anchor{4855}@anchor{extending/newtypes_tutorial defining-new-types}@anchor{4856}
@subsection Definición de tipos de extensión: Tutorial


Python le permite al escritor de un módulo de extensión C definir nuevos tipos que pueden ser manipulados desde el código Python, al igual que los tipos incorporados @ref{237,,str} y @ref{18e,,list}. El código para todos los tipos de extensión sigue un patrón, pero hay algunos detalles que debe comprender antes de comenzar. Este documento es una introducción suave al tema.

@menu
* Lo básico:: 
* Agregar datos y métodos al ejemplo básico:: 
* Proporcionar un control más preciso sobre los atributos de datos:: 
* Apoyo a la recolección de basura cíclica:: 
* Subclases de otros tipos:: 

@end menu

@node Lo básico,Agregar datos y métodos al ejemplo básico,,Definición de tipos de extensión Tutorial
@anchor{extending/newtypes_tutorial dnt-basics}@anchor{4857}@anchor{extending/newtypes_tutorial the-basics}@anchor{4858}
@subsubsection Lo básico


The @ref{796,,CPython} runtime sees all Python objects as variables of type
@ref{42d,,PyObject}*, which serves as a «base type» for all Python objects.
The @ref{42d,,PyObject} structure itself only contains the object’s
@ref{4859,,reference count} and a pointer to the object’s «type object».
This is where the action is; the type object determines which (C) functions
get called by the interpreter when, for instance, an attribute gets looked up
on an object, a method called, or it is multiplied by another object.  These
C functions are called «type methods».

Por lo tanto, si desea definir un nuevo tipo de extensión, debe crear un nuevo objeto de tipo.

This sort of thing can only be explained by example, so here’s a minimal, but
complete, module that defines a new type named @code{Custom} inside a C
extension module @code{custom}:

@cartouche
@quotation Nota 
Lo que estamos mostrando aquí es la forma tradicional de definir tipos de extensión `estáticos'. Debe ser adecuado para la mayoría de los usos. La API de C también permite definir tipos de extensiones asignadas en el montón utilizando la función @ref{621,,PyType_FromSpec()}, que no se trata en este tutorial.
@end quotation
@end cartouche

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct @{
    PyObject_HEAD
    /* Type-specific fields go here. */
@} CustomObject;

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_new = PyType_GenericNew,
@};

static PyModuleDef custommodule = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
@};

PyMODINIT_FUNC
PyInit_custom(void)
@{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Ahora, eso es bastante para asimilar a la vez, pero espero que los fragmentos le resulten familiares del capítulo anterior. Este archivo define tres cosas:


@enumerate 

@item 
What a @code{Custom} `object' contains: this is the @code{CustomObject}
struct, which is allocated once for each @code{Custom} instance.

@item 
How the @code{Custom} `type' behaves: this is the @code{CustomType} struct,
which defines a set of flags and function pointers that the interpreter
inspects when specific operations are requested.

@item 
How to initialize the @code{custom} module: this is the @code{PyInit_custom}
function and the associated @code{custommodule} struct.
@end enumerate

La primera parte es:

@example
typedef struct @{
    PyObject_HEAD
@} CustomObject;
@end example

This is what a Custom object will contain.  @code{PyObject_HEAD} is mandatory
at the start of each object struct and defines a field called @code{ob_base}
of type @ref{42d,,PyObject}, containing a pointer to a type object and a
reference count (these can be accessed using the macros @ref{26e,,Py_TYPE}
and @ref{26f,,Py_REFCNT} respectively).  The reason for the macro is to
abstract away the layout and to enable additional fields in @ref{357,,debug builds}.

@cartouche
@quotation Nota 
No hay punto y coma (;) arriba después de la macro @ref{1345,,PyObject_HEAD}. Tenga cuidado de agregar uno por accidente: algunos compiladores se quejarán.
@end quotation
@end cartouche

Por supuesto, los objetos generalmente almacenan datos adicionales además del estándar @code{PyObject_HEAD} repetitivo; por ejemplo, aquí está la definición de puntos flotantes del estándar de Python:

@example
typedef struct @{
    PyObject_HEAD
    double ob_fval;
@} PyFloatObject;
@end example

La segunda parte es la definición del tipo de objeto.

@example
static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_new = PyType_GenericNew,
@};
@end example

@cartouche
@quotation Nota 
Recomendamos utilizar los inicializadores designados al estilo C99 como se indica arriba, para evitar enumerar todos los campos @ref{b30,,PyTypeObject} que no le interesan y también para evitar preocuparse por el orden de declaración de los campos.
@end quotation
@end cartouche

La definición real de @ref{b30,,PyTypeObject} en @code{object.h} tiene muchos más @ref{a1f,,campos} que la definición anterior. El compilador de C rellenará los campos restantes con ceros, y es una práctica común no especificarlos explícitamente a menos que los necesite.

Lo vamos a separar, un campo a la vez:

@example
.ob_base = PyVarObject_HEAD_INIT(NULL, 0)
@end example

Esta línea es obligatoria para inicializar el campo @code{ob_base} mencionado anteriormente.

@example
.tp_name = "custom.Custom",
@end example

El nombre de nuestro tipo. Esto aparecerá en la representación textual predeterminada de nuestros objetos y en algunos mensajes de error, por ejemplo:

@example
>>> "" + custom.Custom()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: can only concatenate str (not "custom.Custom") to str
@end example

Note that the name is a dotted name that includes both the module name and the
name of the type within the module. The module in this case is @code{custom} and
the type is @code{Custom}, so we set the type name to @code{custom.Custom}.
Using the real dotted import path is important to make your type compatible
with the @ref{b5,,pydoc} and @ref{a6,,pickle} modules.

@example
.tp_basicsize = sizeof(CustomObject),
.tp_itemsize = 0,
@end example

This is so that Python knows how much memory to allocate when creating
new @code{Custom} instances.  @ref{1f6f,,tp_itemsize} is
only used for variable-sized objects and should otherwise be zero.

@cartouche
@quotation Nota 
If you want your type to be subclassable from Python, and your type has the same
@ref{a19,,tp_basicsize} as its base type, you may have problems with multiple
inheritance.  A Python subclass of your type will have to list your type first
in its @ref{14e8,,__bases__}, or else it will not be able to call your type’s
@ref{624,,__new__()} method without getting an error.  You can avoid this problem by
ensuring that your type has a larger value for @ref{a19,,tp_basicsize} than its
base type does.  Most of the time, this will be true anyway, because either your
base type will be @ref{b18,,object}, or else you will be adding data members to
your base type, and therefore increasing its size.
@end quotation
@end cartouche

We set the class flags to @ref{485a,,Py_TPFLAGS_DEFAULT}.

@example
.tp_flags = Py_TPFLAGS_DEFAULT,
@end example

Todos los tipos deben incluir esta constante en sus banderas. Habilita todos los miembros definidos hasta al menos Python 3.3. Si necesita más miembros, necesitará O (`OR') las banderas correspondientes.

Proporcionamos una cadena de documentos para el tipo en @ref{485b,,tp_doc}.

@example
.tp_doc = PyDoc_STR("Custom objects"),
@end example

To enable object creation, we have to provide a @ref{623,,tp_new}
handler.  This is the equivalent of the Python method @ref{624,,__new__()}, but
has to be specified explicitly.  In this case, we can just use the default
implementation provided by the API function @ref{485c,,PyType_GenericNew()}.

@example
.tp_new = PyType_GenericNew,
@end example

Everything else in the file should be familiar, except for some code in
@code{PyInit_custom()}:

@example
if (PyType_Ready(&CustomType) < 0)
    return;
@end example

This initializes the @code{Custom} type, filling in a number of members
to the appropriate default values, including @ref{485d,,ob_type} that we initially
set to @code{NULL}.

@example
if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
    Py_DECREF(m);
    return NULL;
@}
@end example

This adds the type to the module dictionary.  This allows us to create
@code{Custom} instances by calling the @code{Custom} class:

@example
>>> import custom
>>> mycustom = custom.Custom()
@end example

That’s it!  All that remains is to build it; put the above code in a file called
@code{custom.c},

@example
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "custom"
version = "1"
@end example

in a file called @code{pyproject.toml}, and

@example
from setuptools import Extension, setup
setup(ext_modules=[Extension("custom", ["custom.c"])])
@end example

en un archivo llamado @code{setup.py}; luego escribiendo

@example
$ python -m pip install .
@end example

in a shell should produce a file @code{custom.so} in a subdirectory
and install it; now fire up Python — you should be able to @code{import custom}
and play around with @code{Custom} objects.

Eso no fue tan difícil, ¿verdad?

Por supuesto, el tipo personalizado actual es bastante poco interesante. No tiene datos y no hace nada. Ni siquiera se puede subclasificar.

@node Agregar datos y métodos al ejemplo básico,Proporcionar un control más preciso sobre los atributos de datos,Lo básico,Definición de tipos de extensión Tutorial
@anchor{extending/newtypes_tutorial adding-data-and-methods-to-the-basic-example}@anchor{485e}
@subsubsection Agregar datos y métodos al ejemplo básico


Let’s extend the basic example to add some data and methods.  Let’s also make
the type usable as a base class. We’ll create a new module, @code{custom2} that
adds these capabilities:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static void
Custom_dealloc(CustomObject *self)
@{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
@{
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_XSETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_XSETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"first", Py_T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"@},
    @{"last", Py_T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"@},
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
@{
    if (self->first == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "first");
        return NULL;
    @}
    if (self->last == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "last");
        return NULL;
    @}
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom2.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_new = Custom_new,
    .tp_init = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
@};

static PyModuleDef custommodule = @{
    .m_base =PyModuleDef_HEAD_INIT,
    .m_name = "custom2",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
@};

PyMODINIT_FUNC
PyInit_custom2(void)
@{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Esta versión del módulo tiene una serie de cambios.

The  @code{Custom} type now has three data attributes in its C struct,
`first', `last', and `number'.  The `first' and `last' variables are Python
strings containing first and last names.  The `number' attribute is a C integer.

La estructura del objeto se actualiza en consecuencia:

@example
typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;
@end example

Debido a que ahora tenemos datos para administrar, debemos ser más cuidadosos con la asignación de objetos y la desasignación. Como mínimo, necesitamos un método de desasignación:

@example
static void
Custom_dealloc(CustomObject *self)
@{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}
@end example

que se asigna al miembro @ref{485f,,tp_dealloc}:

@example
.tp_dealloc = (destructor) Custom_dealloc,
@end example

This method first clears the reference counts of the two Python attributes.
@ref{828,,Py_XDECREF()} correctly handles the case where its argument is
@code{NULL} (which might happen here if @code{tp_new} failed midway).  It then
calls the @ref{4860,,tp_free} member of the object’s type
(computed by @code{Py_TYPE(self)}) to free the object’s memory.  Note that
the object’s type might not be @code{CustomType}, because the object may
be an instance of a subclass.

@cartouche
@quotation Nota 
La conversión explícita a @code{destructor} anterior es necesaria porque definimos @code{Custom_dealloc} para tomar un argumento @code{CustomObject *}, pero el puntero de función @code{tp_dealloc} espera recibir un argumento @code{PyObject *}. De lo contrario, el compilador emitirá una advertencia. Este es un polimorfismo orientado a objetos, en C!
@end quotation
@end cartouche

Queremos asegurarnos de que el nombre y el apellido se inicialicen en cadenas de caracteres vacías, por lo que proporcionamos una implementación @code{tp_new}:

@example
static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = PyUnicode_FromString("");
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = PyUnicode_FromString("");
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}
@end example

e instalarlo en el miembro @ref{623,,tp_new}:

@example
.tp_new = Custom_new,
@end example

The @code{tp_new} handler is responsible for creating (as opposed to initializing)
objects of the type.  It is exposed in Python as the @ref{624,,__new__()} method.
It is not required to define a @code{tp_new} member, and indeed many extension
types will simply reuse @ref{485c,,PyType_GenericNew()} as done in the first
version of the @code{Custom} type above.  In this case, we use the @code{tp_new}
handler to initialize the @code{first} and @code{last} attributes to non-@code{NULL}
default values.

@code{tp_new} se pasa el tipo que se instancia (no necesariamente @code{CustomType}, si se instancia una subclase) y cualquier argumento pasado cuando se llamó al tipo, y se espera que retorna la instancia creada. Los manejadores @code{tp_new} siempre aceptan argumentos posicionales y de palabras clave, pero a menudo ignoran los argumentos, dejando el manejo de argumentos al inicializador (también conocido como, @code{tp_init} en C o @code{__init__} en Python).

@cartouche
@quotation Nota 
@code{tp_new} no debería llamar explícitamente a @code{tp_init}, ya que el intérprete lo hará por sí mismo.
@end quotation
@end cartouche

La implementación @code{tp_new} llama al @ref{4861,,tp_alloc} para asignar memoria:

@example
self = (CustomObject *) type->tp_alloc(type, 0);
@end example

Como la asignación de memoria puede fallar, debemos verificar el resultado @ref{4861,,tp_alloc} contra @code{NULL} antes de continuar.

@cartouche
@quotation Nota 
No llenamos la ranura @ref{4861,,tp_alloc} nosotros mismos. Más bien @ref{816,,PyType_Ready()} lo llena para nosotros al heredarlo de nuestra clase base, que es @ref{b18,,object} por defecto. La mayoría de los tipos utilizan la estrategia de asignación predeterminada.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
If you are creating a co-operative @ref{623,,tp_new} (one
that calls a base type’s @ref{623,,tp_new} or @ref{624,,__new__()}),
you must `not' try to determine what method to call using method resolution
order at runtime.  Always statically determine what type you are going to
call, and call its @ref{623,,tp_new} directly, or via
@code{type->tp_base->tp_new}.  If you do not do this, Python subclasses of your
type that also inherit from other Python-defined classes may not work correctly.
(Specifically, you may not be able to create instances of such subclasses
without getting a @ref{228,,TypeError}.)
@end quotation
@end cartouche

También definimos una función de inicialización que acepta argumentos para proporcionar valores iniciales para nuestra instancia:

@example
static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
@{
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL, *tmp;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        tmp = self->first;
        Py_INCREF(first);
        self->first = first;
        Py_XDECREF(tmp);
    @}
    if (last) @{
        tmp = self->last;
        Py_INCREF(last);
        self->last = last;
        Py_XDECREF(tmp);
    @}
    return 0;
@}
@end example

rellenando la ranura @ref{625,,tp_init}.

@example
.tp_init = (initproc) Custom_init,
@end example

The @ref{625,,tp_init} slot is exposed in Python as the
@ref{751,,__init__()} method.  It is used to initialize an object after it’s
created.  Initializers always accept positional and keyword arguments,
and they should return either @code{0} on success or @code{-1} on error.

Unlike the @code{tp_new} handler, there is no guarantee that @code{tp_init}
is called at all (for example, the @ref{a6,,pickle} module by default
doesn’t call @ref{751,,__init__()} on unpickled instances).  It can also be
called multiple times.  Anyone can call the @code{__init__()} method on
our objects.  For this reason, we have to be extra careful when assigning
the new attribute values.  We might be tempted, for example to assign the
@code{first} member like this:

@example
if (first) @{
    Py_XDECREF(self->first);
    Py_INCREF(first);
    self->first = first;
@}
@end example

Pero esto sería arriesgado. Nuestro tipo no restringe el tipo del @code{primer} miembro, por lo que podría ser cualquier tipo de objeto. Podría tener un destructor que haga que se ejecute código que intente acceder al @code{primer} miembro; o ese destructor podría liberar el @ref{2c5,,Global Interpreter Lock} y permite que se ejecute código arbitrario en otros hilos que acceden y modifican nuestro objeto.

Para ser paranoicos y protegernos de esta posibilidad, casi siempre reasignamos miembros antes de disminuir sus recuentos de referencias. ¿Cuándo no tenemos que hacer esto?


@itemize *

@item 
cuando sabemos absolutamente que el recuento de referencia es mayor que 1;

@item 
cuando sabemos que la desasignación del objeto @footnote{
Esto es cierto cuando sabemos que el objeto es un tipo básico, como una cadena o un flotador.
} no liberará el @ref{2c5,,GIL} ni causará ninguna llamada al código de nuestro tipo;

@item 
al disminuir un recuento de referencias en un manejador @ref{485f,,tp_dealloc} en un tipo que no admite la recolección de basura cíclica @footnote{
Nos basamos en esto en el manejador @ref{485f,,tp_dealloc} en este ejemplo, porque nuestro tipo no admite la recolección de basura.
}.
@end itemize

Queremos exponer nuestras variables de instancia como atributos. Hay varias formas de hacerlo. La forma más simple es definir definiciones de miembros:

@example
static PyMemberDef Custom_members[] = @{
    @{"first", Py_T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"@},
    @{"last", Py_T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"@},
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};
@end example

y poner las definiciones en la ranura @ref{4862,,tp_members}:

@example
.tp_members = Custom_members,
@end example

Cada definición de miembro tiene un nombre de miembro, tipo, desplazamiento, banderas de acceso y cadena de caracteres de documentación. Consulte la sección @ref{4863,,Gestión de atributos genéricos} a continuación para obtener más detalles.

Una desventaja de este enfoque es que no proporciona una forma de restringir los tipos de objetos que se pueden asignar a los atributos de Python. Esperamos que el nombre y el apellido sean cadenas, pero se pueden asignar objetos de Python. Además, los atributos se pueden eliminar, configurando los punteros C en @code{NULL}. Si bien podemos asegurarnos de que los miembros se inicialicen en valores que no sean @code{NULL}, los miembros se pueden establecer en @code{NULL} si se eliminan los atributos.

We define a single method, @code{Custom.name()}, that outputs the objects name as the
concatenation of the first and last names.

@example
static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
@{
    if (self->first == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "first");
        return NULL;
    @}
    if (self->last == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "last");
        return NULL;
    @}
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}
@end example

The method is implemented as a C function that takes a @code{Custom} (or
@code{Custom} subclass) instance as the first argument.  Methods always take an
instance as the first argument. Methods often take positional and keyword
arguments as well, but in this case we don’t take any and don’t need to accept
a positional argument tuple or keyword argument dictionary. This method is
equivalent to the Python method:

@example
def name(self):
    return "%s %s" % (self.first, self.last)
@end example

Note that we have to check for the possibility that our @code{first} and
@code{last} members are @code{NULL}.  This is because they can be deleted, in which
case they are set to @code{NULL}.  It would be better to prevent deletion of these
attributes and to restrict the attribute values to be strings.  We’ll see how to
do that in the next section.

Ahora que hemos definido el método, necesitamos crear un arreglo de definiciones de métodos:

@example
static PyMethodDef Custom_methods[] = @{
    @{"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};
@end example

(note that we used the @ref{1514,,METH_NOARGS} flag to indicate that the method
is expecting no arguments other than `self')

y asignarlo a la ranura @ref{4864,,tp_methods}:

@example
.tp_methods = Custom_methods,
@end example

Finally, we’ll make our type usable as a base class for subclassing.  We’ve
written our methods carefully so far so that they don’t make any assumptions
about the type of the object being created or used, so all we need to do is
to add the @ref{4865,,Py_TPFLAGS_BASETYPE} to our class flag definition:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
@end example

We rename @code{PyInit_custom()} to @code{PyInit_custom2()}, update the
module name in the @ref{a0f,,PyModuleDef} struct, and update the full class
name in the @ref{b30,,PyTypeObject} struct.

Finally, we update our @code{setup.py} file to include the new module,

@example
from setuptools import Extension, setup
setup(ext_modules=[
    Extension("custom", ["custom.c"]),
    Extension("custom2", ["custom2.c"]),
])
@end example

and then we re-install so that we can @code{import custom2}:

@example
$ python -m pip install .
@end example

@node Proporcionar un control más preciso sobre los atributos de datos,Apoyo a la recolección de basura cíclica,Agregar datos y métodos al ejemplo básico,Definición de tipos de extensión Tutorial
@anchor{extending/newtypes_tutorial providing-finer-control-over-data-attributes}@anchor{4866}
@subsubsection Proporcionar un control más preciso sobre los atributos de datos


In this section, we’ll provide finer control over how the @code{first} and
@code{last} attributes are set in the @code{Custom} example. In the previous
version of our module, the instance variables @code{first} and @code{last}
could be set to non-string values or even deleted. We want to make sure that
these attributes always contain strings.

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static void
Custom_dealloc(CustomObject *self)
@{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
@{
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_SETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_SETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
@{
    return Py_NewRef(self->first);
@}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
@{
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    Py_SETREF(self->first, Py_NewRef(value));
    return 0;
@}

static PyObject *
Custom_getlast(CustomObject *self, void *closure)
@{
    return Py_NewRef(self->last);
@}

static int
Custom_setlast(CustomObject *self, PyObject *value, void *closure)
@{
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The last attribute value must be a string");
        return -1;
    @}
    Py_SETREF(self->last, Py_NewRef(value));
    return 0;
@}

static PyGetSetDef Custom_getsetters[] = @{
    @{"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL@},
    @{"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
@{
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom3.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_new = Custom_new,
    .tp_init = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
@};

static PyModuleDef custommodule = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom3",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
@};

PyMODINIT_FUNC
PyInit_custom3(void)
@{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

To provide greater control, over the @code{first} and @code{last} attributes,
we’ll use custom getter and setter functions.  Here are the functions for
getting and setting the @code{first} attribute:

@example
static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
@{
    Py_INCREF(self->first);
    return self->first;
@}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
@{
    PyObject *tmp;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    tmp = self->first;
    Py_INCREF(value);
    self->first = value;
    Py_DECREF(tmp);
    return 0;
@}
@end example

The getter function is passed a @code{Custom} object and a «closure», which is
a void pointer.  In this case, the closure is ignored.  (The closure supports an
advanced usage in which definition data is passed to the getter and setter. This
could, for example, be used to allow a single set of getter and setter functions
that decide the attribute to get or set based on data in the closure.)

The setter function is passed the @code{Custom} object, the new value, and the
closure.  The new value may be @code{NULL}, in which case the attribute is being
deleted.  In our setter, we raise an error if the attribute is deleted or if its
new value is not a string.

Creamos un arreglo de estructuras @ref{c40,,PyGetSetDef}:

@example
static PyGetSetDef Custom_getsetters[] = @{
    @{"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL@},
    @{"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};
@end example

y lo registra en la ranura @ref{4867,,tp_getset}:

@example
.tp_getset = Custom_getsetters,
@end example

El último elemento en la estructura @ref{c40,,PyGetSetDef} es el «cierre» (`closure') mencionado anteriormente. En este caso, no estamos usando un cierre, por lo que simplemente pasamos @code{NULL}.

También eliminamos las definiciones de miembro para estos atributos:

@example
static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};
@end example

También necesitamos actualizar el manejador @ref{625,,tp_init} para permitir que solo se pasen las cadenas @footnote{
Ahora sabemos que el primer y el último miembro son cadenas de caracteres, por lo que quizás podríamos ser menos cuidadosos al disminuir sus recuentos de referencia, sin embargo, aceptamos instancias de subclases de cadenas. A pesar de que la desasignación de cadenas normales no volverá a llamar a nuestros objetos, no podemos garantizar que la desasignación de una instancia de una subclase de cadena de caracteres no vuelva a llamar a nuestros objetos.
}:

@example
static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
@{
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL, *tmp;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        tmp = self->first;
        Py_INCREF(first);
        self->first = first;
        Py_DECREF(tmp);
    @}
    if (last) @{
        tmp = self->last;
        Py_INCREF(last);
        self->last = last;
        Py_DECREF(tmp);
    @}
    return 0;
@}
@end example

Con estos cambios, podemos asegurar que los miembros @code{primero} y @code{último} nunca sean @code{NULL}, por lo que podemos eliminar las comprobaciones de los valores @code{NULL} en casi todos los casos. Esto significa que la mayoría de las llamadas @ref{828,,Py_XDECREF()} se pueden convertir en llamadas @ref{613,,Py_DECREF()}. El único lugar donde no podemos cambiar estas llamadas es en la implementación @code{tp_dealloc}, donde existe la posibilidad de que la inicialización de estos miembros falle en @code{tp_new}.

También cambiamos el nombre de la función de inicialización del módulo y el nombre del módulo en la función de inicialización, como lo hicimos antes, y agregamos una definición adicional al archivo @code{setup.py}.

@node Apoyo a la recolección de basura cíclica,Subclases de otros tipos,Proporcionar un control más preciso sobre los atributos de datos,Definición de tipos de extensión Tutorial
@anchor{extending/newtypes_tutorial supporting-cyclic-garbage-collection}@anchor{4868}
@subsubsection Apoyo a la recolección de basura cíclica


Python tiene un @ref{1922,,recolector de basura cíclico (GC)} que puede identificar objetos innecesarios incluso cuando sus recuentos de referencia no son cero. Esto puede suceder cuando los objetos están involucrados en ciclos. Por ejemplo, considere:

@example
>>> l = []
>>> l.append(l)
>>> del l
@end example

En este ejemplo, creamos una lista que se contiene a sí misma. Cuando lo eliminamos, todavía tiene una referencia de sí mismo. Su recuento de referencia no cae a cero. Afortunadamente, el recolector cíclico de basura de Python finalmente descubrirá que la lista es basura y la liberará.

In the second version of the @code{Custom} example, we allowed any kind of
object to be stored in the @code{first} or @code{last} attributes @footnote{
Además, incluso con nuestros atributos restringidos a instancias de cadenas, el usuario podría pasar subclases arbitrarias @ref{237,,str} y, por lo tanto, seguir creando ciclos de referencia.
}.
Besides, in the second and third versions, we allowed subclassing
@code{Custom}, and subclasses may add arbitrary attributes.  For any of
those two reasons, @code{Custom} objects can participate in cycles:

@example
>>> import custom3
>>> class Derived(custom3.Custom): pass
...
>>> n = Derived()
>>> n.some_attribute = n
@end example

To allow a @code{Custom} instance participating in a reference cycle to
be properly detected and collected by the cyclic GC, our @code{Custom} type
needs to fill two additional slots and to enable a flag that enables these slots:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
@{
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
@}

static int
Custom_clear(CustomObject *self)
@{
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
@}

static void
Custom_dealloc(CustomObject *self)
@{
    PyObject_GC_UnTrack(self);
    Custom_clear(self);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(CustomObject *self, PyObject *args, PyObject *kwds)
@{
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_SETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_SETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_getfirst(CustomObject *self, void *closure)
@{
    return Py_NewRef(self->first);
@}

static int
Custom_setfirst(CustomObject *self, PyObject *value, void *closure)
@{
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    Py_XSETREF(self->first, Py_NewRef(value));
    return 0;
@}

static PyObject *
Custom_getlast(CustomObject *self, void *closure)
@{
    return Py_NewRef(self->last);
@}

static int
Custom_setlast(CustomObject *self, PyObject *value, void *closure)
@{
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The last attribute value must be a string");
        return -1;
    @}
    Py_XSETREF(self->last, Py_NewRef(value));
    return 0;
@}

static PyGetSetDef Custom_getsetters[] = @{
    @{"first", (getter) Custom_getfirst, (setter) Custom_setfirst,
     "first name", NULL@},
    @{"last", (getter) Custom_getlast, (setter) Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored))
@{
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", (PyCFunction) Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom4.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    .tp_new = Custom_new,
    .tp_init = (initproc) Custom_init,
    .tp_dealloc = (destructor) Custom_dealloc,
    .tp_traverse = (traverseproc) Custom_traverse,
    .tp_clear = (inquiry) Custom_clear,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
@};

static PyModuleDef custommodule = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom4",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
@};

PyMODINIT_FUNC
PyInit_custom4(void)
@{
    PyObject *m;
    if (PyType_Ready(&CustomType) < 0)
        return NULL;

    m = PyModule_Create(&custommodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Primero, el método transversal permite que el GC cíclico conozca los subobjetos que podrían participar en los ciclos:

@example
static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
@{
    int vret;
    if (self->first) @{
        vret = visit(self->first, arg);
        if (vret != 0)
            return vret;
    @}
    if (self->last) @{
        vret = visit(self->last, arg);
        if (vret != 0)
            return vret;
    @}
    return 0;
@}
@end example

For each subobject that can participate in cycles, we need to call the
@code{visit()} function, which is passed to the traversal method. The
@code{visit()} function takes as arguments the subobject and the extra argument
`arg' passed to the traversal method.  It returns an integer value that must be
returned if it is non-zero.

Python proporciona una macro @ref{4869,,Py_VISIT()} que automatiza las funciones de visita de llamada. Con @ref{4869,,Py_VISIT()}, podemos minimizar la cantidad de repeticiones en @code{Custom_traverse}:

@example
static int
Custom_traverse(CustomObject *self, visitproc visit, void *arg)
@{
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
@}
@end example

@cartouche
@quotation Nota 
La implementación @ref{818,,tp_traverse} debe nombrar sus argumentos exactamente `visit' y `arg' para usar @ref{4869,,Py_VISIT()}.
@end quotation
@end cartouche

En segundo lugar, debemos proporcionar un método para borrar cualquier subobjeto que pueda participar en los ciclos:

@example
static int
Custom_clear(CustomObject *self)
@{
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
@}
@end example

Observe el uso de la macro @ref{61c,,Py_CLEAR()}. Es la forma recomendada y segura de borrar los atributos de datos de tipos arbitrarios al tiempo que disminuye sus recuentos de referencia. Si tuviera que llamar a @ref{828,,Py_XDECREF()} en lugar del atributo antes de establecerlo en @code{NULL}, existe la posibilidad de que el destructor del atributo vuelva a llamar al código que lee el atributo nuevamente (`especialmente' si hay un ciclo de referencia).

@cartouche
@quotation Nota 
Puede emular @ref{61c,,Py_CLEAR()} escribiendo:

@example
PyObject *tmp;
tmp = self->first;
self->first = NULL;
Py_XDECREF(tmp);
@end example

Sin embargo, es mucho más fácil y menos propenso a errores usar siempre @ref{61c,,Py_CLEAR()} al eliminar un atributo. ¡No intentes micro-optimizar a expensas de la robustez!
@end quotation
@end cartouche

El desasignador @code{Custom_dealloc} puede llamar a un código arbitrario al borrar los atributos. Significa que el GC circular se puede activar dentro de la función. Dado que el GC asume que el recuento de referencias no es cero, debemos destrabar el objeto del GC llamando a @ref{1547,,PyObject_GC_UnTrack()} antes de borrar los miembros. Aquí está nuestro reubicador reimplementado usando @ref{1547,,PyObject_GC_UnTrack()} y @code{Custom_clear}:

@example
static void
Custom_dealloc(CustomObject *self)
@{
    PyObject_GC_UnTrack(self);
    Custom_clear(self);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}
@end example

Finally, we add the @ref{817,,Py_TPFLAGS_HAVE_GC} flag to the class flags:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
@end example

Eso es prácticamente todo. Si hubiéramos escrito controladores personalizados @ref{4861,,tp_alloc} o @ref{4860,,tp_free}, tendríamos que modificarlos para la recolección de basura cíclica. La mayoría de las extensiones usarán las versiones proporcionadas automáticamente.

@node Subclases de otros tipos,,Apoyo a la recolección de basura cíclica,Definición de tipos de extensión Tutorial
@anchor{extending/newtypes_tutorial subclassing-other-types}@anchor{486a}
@subsubsection Subclases de otros tipos


Es posible crear nuevos tipos de extensión que se derivan de los tipos existentes. Es más fácil heredar de los tipos incorporados, ya que una extensión puede usar fácilmente @ref{b30,,PyTypeObject} que necesita. Puede ser difícil compartir estas estructuras @ref{b30,,PyTypeObject} entre módulos de extensión.

In this example we will create a @code{SubList} type that inherits from the
built-in @ref{18e,,list} type. The new type will be completely compatible with
regular lists, but will have an additional @code{increment()} method that
increases an internal counter:

@example
>>> import sublist
>>> s = sublist.SubList(range(3))
>>> s.extend(s)
>>> print(len(s))
6
>>> print(s.increment())
1
>>> print(s.increment())
2
@end example

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct @{
    PyListObject list;
    int state;
@} SubListObject;

static PyObject *
SubList_increment(SubListObject *self, PyObject *unused)
@{
    self->state++;
    return PyLong_FromLong(self->state);
@}

static PyMethodDef SubList_methods[] = @{
    @{"increment", (PyCFunction) SubList_increment, METH_NOARGS,
     PyDoc_STR("increment state counter")@},
    @{NULL@},
@};

static int
SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
@{
    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
@}

static PyTypeObject SubListType = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "sublist.SubList",
    .tp_doc = PyDoc_STR("SubList objects"),
    .tp_basicsize = sizeof(SubListObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_init = (initproc) SubList_init,
    .tp_methods = SubList_methods,
@};

static PyModuleDef sublistmodule = @{
    PyModuleDef_HEAD_INIT,
    .m_name = "sublist",
    .m_doc = "Example module that creates an extension type.",
    .m_size = -1,
@};

PyMODINIT_FUNC
PyInit_sublist(void)
@{
    PyObject *m;
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0)
        return NULL;

    m = PyModule_Create(&sublistmodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

As you can see, the source code closely resembles the @code{Custom} examples in
previous sections. We will break down the main differences between them.

@example
typedef struct @{
    PyListObject list;
    int state;
@} SubListObject;
@end example

La diferencia principal para los objetos de tipo derivado es que la estructura de objeto del tipo base debe ser el primer valor. El tipo base ya incluirá @ref{1345,,PyObject_HEAD()} al comienzo de su estructura.

When a Python object is a @code{SubList} instance, its @code{PyObject *} pointer
can be safely cast to both @code{PyListObject *} and @code{SubListObject *}:

@example
static int
SubList_init(SubListObject *self, PyObject *args, PyObject *kwds)
@{
    if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
@}
@end example

We see above how to call through to the @ref{751,,__init__()} method of the base
type.

Este patrón es importante cuando se escribe un tipo con miembros personalizados @ref{623,,tp_new} y @ref{485f,,tp_dealloc}. El manejador @ref{623,,tp_new} no debería crear realmente la memoria para el objeto con su @ref{4861,,tp_alloc}, pero deja que la clase base lo maneje llamando a su propio @ref{623,,tp_new}.

La estructura @ref{b30,,PyTypeObject} admite a @ref{486b,,tp_base} especificando la clase base concreta del tipo. Debido a problemas de compilación multiplataforma, no puede llenar ese campo directamente con una referencia a @ref{486c,,PyList_Type}; debe hacerse más tarde en la función de inicialización del módulo:

@example
PyMODINIT_FUNC
PyInit_sublist(void)
@{
    PyObject* m;
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0)
        return NULL;

    m = PyModule_Create(&sublistmodule);
    if (m == NULL)
        return NULL;

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        Py_DECREF(m);
        return NULL;
    @}

    return m;
@}
@end example

Antes de llamar a @ref{816,,PyType_Ready()}, la estructura de tipo debe tener el espacio @ref{486b,,tp_base} rellenado. Cuando derivamos un tipo existente, no es necesario completar el @ref{4861,,tp_alloc} ranura con @ref{485c,,PyType_GenericNew()} – la función de asignación del tipo base será heredada.

After that, calling @ref{816,,PyType_Ready()} and adding the type object to the
module is the same as with the basic @code{Custom} examples.

@subsubheading Notas al pie


@node Definición de tipos de extensión temas variados,Construyendo extensiones C y C++,Definición de tipos de extensión Tutorial,Crear extensiones sin herramientas de terceros
@anchor{extending/newtypes doc}@anchor{486d}@anchor{extending/newtypes defining-extension-types-assorted-topics}@anchor{486e}@anchor{extending/newtypes new-types-topics}@anchor{486f}
@subsection Definición de tipos de extensión: temas variados

@anchor{extending/newtypes dnt-type-methods}@anchor{4870}
Esta sección tiene como objetivo dar un vistazo rápido a los diversos métodos de tipo que puede implementar y lo que hacen.

Aquí está la definición de @ref{b30,,PyTypeObject}, con algunos campos que solo se usan en las @ref{357,,versiones de depuración} omitidas:

@example
typedef struct _typeobject @{
    PyObject_VAR_HEAD
    const char *tp_name; /* For printing, in format "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

    /* Methods to implement standard operations */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
                                    or tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* Method suites for standard classes */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* More standard operations (here for binary compatibility) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* Functions to access object as input/output buffer */
    PyBufferProcs *tp_as_buffer;

    /* Flags to define presence of optional/expanded features */
    unsigned long tp_flags;

    const char *tp_doc; /* Documentation string */

    /* Assigned meaning in release 2.0 */
    /* call function for all accessible objects */
    traverseproc tp_traverse;

    /* delete references to contained objects */
    inquiry tp_clear;

    /* Assigned meaning in release 2.1 */
    /* rich comparisons */
    richcmpfunc tp_richcompare;

    /* weak reference enabler */
    Py_ssize_t tp_weaklistoffset;

    /* Iterators */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* Attribute descriptor and subclassing stuff */
    struct PyMethodDef *tp_methods;
    struct PyMemberDef *tp_members;
    struct PyGetSetDef *tp_getset;
    // Strong reference on a heap type, borrowed reference on a static type
    struct _typeobject *tp_base;
    PyObject *tp_dict;
    descrgetfunc tp_descr_get;
    descrsetfunc tp_descr_set;
    Py_ssize_t tp_dictoffset;
    initproc tp_init;
    allocfunc tp_alloc;
    newfunc tp_new;
    freefunc tp_free; /* Low-level free-memory routine */
    inquiry tp_is_gc; /* For PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* method resolution order */
    PyObject *tp_cache;
    PyObject *tp_subclasses;
    PyObject *tp_weaklist;
    destructor tp_del;

    /* Type attribute cache version tag. Added in version 2.6 */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;

    /* bitset of which type-watchers care about this type */
    unsigned char tp_watched;
@} PyTypeObject;
@end example

Esos son `muchos' métodos. Sin embargo, no se preocupe demasiado: si tiene un tipo que desea definir, es muy probable que solo implemente un puñado de estos.

Como probablemente espera ahora, vamos a repasar esto y daremos más información sobre los diversos controladores. No iremos en el orden en que se definen en la estructura, porque hay mucho equipaje histórico que afecta el orden de los campos. A menudo es más fácil encontrar un ejemplo que incluya los campos que necesita y luego cambiar los valores para adaptarlos a su nuevo tipo.

@example
const char *tp_name; /* For printing */
@end example

El nombre del tipo – como se mencionó en el capítulo anterior, aparecerá en varios lugares, casi por completo para fines de diagnóstico. ¡Intente elegir algo que sea útil en tal situación!

@example
Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
@end example

Estos campos le dicen al tiempo de ejecución cuánta memoria asignar cuando se crean nuevos objetos de este tipo. Python tiene algún soporte incorporado para estructuras de longitud variable (piense: cadenas, tuplas) que es donde entra el campo @ref{1f6f,,tp_itemsize}. Esto se tratará más adelante.

@example
const char *tp_doc;
@end example

Aquí puede poner una cadena de caracteres (o su dirección) que desea que se retorne cuando el script de Python haga referencia a @code{obj.__doc__} para recuperar el docstring.

Ahora llegamos a los métodos de tipo básicos: los que implementarán la mayoría de los tipos de extensión.

@menu
* Finalización y desasignación:: 
* Presentación de objetos:: 
* Gestión de atributos:: 
* Comparación de Objetos:: 
* Soporte de protocolo abstracto:: 
* Soporte de referencia débil:: 
* Más Sugerencias:: 

@end menu

@node Finalización y desasignación,Presentación de objetos,,Definición de tipos de extensión temas variados
@anchor{extending/newtypes finalization-and-de-allocation}@anchor{4871}
@subsubsection Finalización y desasignación


@geindex object;deallocation
@geindex deallocation@comma{} object
@geindex object;finalization
@geindex finalization@comma{} of objects

@example
destructor tp_dealloc;
@end example

Se llama a esta función cuando el recuento de referencia de la instancia de su tipo se reduce a cero y el intérprete de Python quiere reclamarlo. Si su tipo tiene memoria para liberar u otra limpieza para realizar, puede ponerla aquí. El objeto en sí mismo necesita ser liberado aquí también. Aquí hay un ejemplo de esta función:

@example
static void
newdatatype_dealloc(newdatatypeobject *obj)
@{
    free(obj->obj_UnderlyingDatatypePtr);
    Py_TYPE(obj)->tp_free((PyObject *)obj);
@}
@end example

Si su tipo admite la recolección de basura, el destructor debe llamar a @ref{1547,,PyObject_GC_UnTrack()} antes de borrar cualquier campo miembro:

@example
static void
newdatatype_dealloc(newdatatypeobject *obj)
@{
    PyObject_GC_UnTrack(obj);
    Py_CLEAR(obj->other_obj);
    ...
    Py_TYPE(obj)->tp_free((PyObject *)obj);
@}
@end example

@geindex PyErr_Fetch (C function)
@geindex PyErr_Restore (C function)

Un requisito importante de la función desasignador es que deja solo las excepciones pendientes. Esto es importante ya que los desasignadores se llaman con frecuencia cuando el intérprete desenrolla la pila de Python; cuando la pila se desenrolla debido a una excepción (en lugar de retornos normales), no se hace nada para proteger a los desasignadores de memoria (`deallocator') de ver que ya se ha establecido una excepción. Cualquier acción que realice un desasignador que pueda hacer que se ejecute código Python adicional puede detectar que se ha establecido una excepción. Esto puede conducir a errores engañosos del intérprete. La forma correcta de protegerse contra esto es guardar una excepción pendiente antes de realizar la acción insegura y restaurarla cuando haya terminado. Esto se puede hacer usando las funciones @ref{28a,,PyErr_Fetch()} y @ref{28d,,PyErr_Restore()}:

@example
static void
my_dealloc(PyObject *obj)
@{
    MyObject *self = (MyObject *) obj;
    PyObject *cbresult;

    if (self->my_callback != NULL) @{
        PyObject *err_type, *err_value, *err_traceback;

        /* This saves the current exception state */
        PyErr_Fetch(&err_type, &err_value, &err_traceback);

        cbresult = PyObject_CallNoArgs(self->my_callback);
        if (cbresult == NULL)
            PyErr_WriteUnraisable(self->my_callback);
        else
            Py_DECREF(cbresult);

        /* This restores the saved exception state */
        PyErr_Restore(err_type, err_value, err_traceback);

        Py_DECREF(self->my_callback);
    @}
    Py_TYPE(obj)->tp_free((PyObject*)self);
@}
@end example

@cartouche
@quotation Nota 
Existen limitaciones para lo que puede hacer de manera segura en una función de desasignación. Primero, si su tipo admite la recolección de basura (usando @ref{818,,tp_traverse} o @ref{4872,,tp_clear}), algunos de los miembros del objeto pueden haber sido borrados o finalizados por el time @ref{485f,,tp_dealloc} es llamado. Segundo, en @ref{485f,,tp_dealloc}, su objeto está en un estado inestable: su recuento de referencia es igual a cero. Cualquier llamada a un objeto o API no trivial (como en el ejemplo anterior) podría terminar llamando @ref{485f,,tp_dealloc} nuevamente, causando una doble liberación y un bloqueo.

Comenzando con Python 3.4, se recomienda no poner ningún código de finalización complejo en @ref{485f,,tp_dealloc}, y en su lugar use el nuevo método de tipo @ref{b31,,tp_finalize}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} explica el nuevo esquema de finalización.

@end quotation
@end cartouche

@geindex string;object representation
@geindex built-in function;repr

@node Presentación de objetos,Gestión de atributos,Finalización y desasignación,Definición de tipos de extensión temas variados
@anchor{extending/newtypes object-presentation}@anchor{4873}
@subsubsection Presentación de objetos


En Python, hay dos formas de generar una representación textual de un objeto: la función @ref{894,,repr()}, y la función @ref{237,,str()}. (La función @ref{ff4,,print()} solo llama a @ref{237,,str()}.) Estos controladores son opcionales.

@example
reprfunc tp_repr;
reprfunc tp_str;
@end example

El manejador @ref{4874,,tp_repr} debe retornar un objeto de cadena que contenga una representación de la instancia para la que se llama. Aquí hay un ejemplo simple:

@example
static PyObject *
newdatatype_repr(newdatatypeobject *obj)
@{
    return PyUnicode_FromFormat("Repr-ified_newdatatype@{@{size:%d@}@}",
                                obj->obj_UnderlyingDatatypePtr->size);
@}
@end example

Si no se especifica un controlador @ref{4874,,tp_repr}, el intérprete proporcionará una representación que utiliza el @ref{18fb,,tp_name} del tipo y un valor de identificación exclusivo para el objeto.

El manejador @ref{4875,,tp_str} es para @ref{237,,str()} lo que el manejador @ref{4874,,tp_repr} descrito arriba es para @ref{894,,repr()}; es decir, se llama cuando el código Python llama @ref{237,,str()} en una instancia de su objeto. Su implementación es muy similar a la función @ref{4874,,tp_repr}, pero la cadena resultante está destinada al consumo humano. Si @ref{4875,,tp_str} no se especifica, en su lugar se utiliza el controlador @ref{4874,,tp_repr}.

Aquí hay un ejemplo simple:

@example
static PyObject *
newdatatype_str(newdatatypeobject *obj)
@{
    return PyUnicode_FromFormat("Stringified_newdatatype@{@{size:%d@}@}",
                                obj->obj_UnderlyingDatatypePtr->size);
@}
@end example

@node Gestión de atributos,Comparación de Objetos,Presentación de objetos,Definición de tipos de extensión temas variados
@anchor{extending/newtypes attribute-management}@anchor{4876}
@subsubsection Gestión de atributos


Para cada objeto que puede soportar atributos, el tipo correspondiente debe proporcionar las funciones que controlan cómo se resuelven los atributos. Es necesario que haya una función que pueda recuperar atributos (si hay alguna definida), y otra para establecer atributos (si se permite establecer atributos). La eliminación de un atributo es un caso especial, para el cual el nuevo valor pasado al controlador es @code{NULL}.

Python admite dos pares de controladores de atributos; un tipo que admite atributos solo necesita implementar las funciones para un par. La diferencia es que un par toma el nombre del atributo como char*, mientras que el otro acepta un @ref{42d,,PyObject}*. Cada tipo puede usar cualquier par que tenga más sentido para la conveniencia de la implementación.

@example
getattrfunc  tp_getattr;        /* char * version */
setattrfunc  tp_setattr;
/* ... */
getattrofunc tp_getattro;       /* PyObject * version */
setattrofunc tp_setattro;
@end example

Si acceder a los atributos de un objeto siempre es una operación simple (esto se explicará en breve), existen implementaciones genéricas que se pueden usar para proporcionar la versión @ref{42d,,PyObject}* de las funciones de administración de atributos. La necesidad real de controladores de atributos específicos de tipo desapareció casi por completo a partir de Python 2.2, aunque hay muchos ejemplos que no se han actualizado para usar algunos de los nuevos mecanismos genéricos disponibles.

@menu
* Gestión de atributos genéricos:: 
* Gestión de atributos específicos de tipo:: 

@end menu

@node Gestión de atributos genéricos,Gestión de atributos específicos de tipo,,Gestión de atributos
@anchor{extending/newtypes generic-attribute-management}@anchor{4863}@anchor{extending/newtypes id1}@anchor{4877}
@subsubsection Gestión de atributos genéricos


La mayoría de los tipos de extensión solo usan atributos `simple'. Entonces, ¿qué hace que los atributos sean simples? Solo hay un par de condiciones que se deben cumplir:


@enumerate 

@item 
El nombre de los atributos debe ser conocido cuando @ref{816,,PyType_Ready()} es llamado.

@item 
No se necesita un procesamiento especial para registrar que un atributo se buscó o se configuró, ni se deben tomar acciones basadas en el valor.
@end enumerate

Tenga en cuenta que esta lista no impone restricciones a los valores de los atributos, cuándo se calculan los valores o cómo se almacenan los datos relevantes.

Cuando se llama a @ref{816,,PyType_Ready()}, utiliza tres tablas a las que hace referencia el objeto de tipo para crear @ref{1f70,,descriptor} que se colocan en el diccionario del objeto de tipo. Cada descriptor controla el acceso a un atributo del objeto de instancia. Cada una de las tablas es opcional; si los tres son @code{NULL}, las instancias del tipo solo tendrán atributos que se heredan de su tipo base, y deberían dejar @ref{16f8,,tp_getattro} y los campos @ref{4878,,tp_setattro} @code{NULL} también, permitiendo que el tipo base maneje los atributos.

Las tablas se declaran como tres campos del tipo objeto:

@example
struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;
@end example

Si @ref{4864,,tp_methods} no es @code{NULL}, debe referirse a un arreglo de estructuras @ref{1517,,PyMethodDef}. Cada entrada en la tabla es una instancia de esta estructura:

@example
typedef struct PyMethodDef @{
    const char  *ml_name;       /* method name */
    PyCFunction  ml_meth;       /* implementation function */
    int          ml_flags;      /* flags */
    const char  *ml_doc;        /* docstring */
@} PyMethodDef;
@end example

One entry should be defined for each method provided by the type; no entries are
needed for methods inherited from a base type.  One additional entry is needed
at the end; it is a sentinel that marks the end of the array.  The
@ref{4879,,ml_name} field of the sentinel must be @code{NULL}.

La segunda tabla se utiliza para definir atributos que se asignan directamente a los datos almacenados en la instancia. Se admite una variedad de tipos C primitivos, y el acceso puede ser de solo lectura o lectura-escritura. Las estructuras en la tabla se definen como:

@example
typedef struct PyMemberDef @{
    const char *name;
    int         type;
    int         offset;
    int         flags;
    const char *doc;
@} PyMemberDef;
@end example

For each entry in the table, a @ref{1f70,,descriptor} will be constructed and added to the
type which will be able to extract a value from the instance structure.  The
@ref{487a,,type} field should contain a type code like @ref{632,,Py_T_INT} or
@ref{633,,Py_T_DOUBLE}; the value will be used to determine how to
convert Python values to and from C values.  The @ref{487b,,flags} field is used to
store flags which control how the attribute can be accessed: you can set it to
@ref{634,,Py_READONLY} to prevent Python code from setting it.

An interesting advantage of using the @ref{4862,,tp_members} table to build
descriptors that are used at runtime is that any attribute defined this way can
have an associated doc string simply by providing the text in the table.  An
application can use the introspection API to retrieve the descriptor from the
class object, and get the doc string using its @ref{1cb3,,__doc__} attribute.

As with the @ref{4864,,tp_methods} table, a sentinel entry with a @ref{4879,,ml_name} value
of @code{NULL} is required.

@c XXX Descriptors need to be explained in more detail somewhere, but not here.
@c 
@c Descriptor objects have two handler functions which correspond to the
@c \member{tp_getattro} and \member{tp_setattro} handlers.  The
@c \method{__get__()} handler is a function which is passed the descriptor,
@c instance, and type objects, and returns the value of the attribute, or it
@c returns \NULL{} and sets an exception.  The \method{__set__()} handler is
@c passed the descriptor, instance, type, and new value;

@node Gestión de atributos específicos de tipo,,Gestión de atributos genéricos,Gestión de atributos
@anchor{extending/newtypes type-specific-attribute-management}@anchor{487c}
@subsubsection Gestión de atributos específicos de tipo


Para simplificar, solo la versión char* será demostrada aquí; el tipo del parámetro con nombre es la única diferencia entre char* y @ref{42d,,PyObject}* de la interfaz. Este ejemplo efectivamente hace lo mismo que el ejemplo genérico anterior, pero no usa el soporte genérico agregado en Python 2.2. Explica cómo se llaman las funciones del controlador, de modo que si necesita ampliar su funcionalidad, comprenderá lo que debe hacerse.

The @ref{487d,,tp_getattr} handler is called when the object requires an attribute
look-up.  It is called in the same situations where the @ref{57a,,__getattr__()}
method of a class would be called.

Aquí hay un ejemplo:

@example
static PyObject *
newdatatype_getattr(newdatatypeobject *obj, char *name)
@{
    if (strcmp(name, "data") == 0)
    @{
        return PyLong_FromLong(obj->data);
    @}

    PyErr_Format(PyExc_AttributeError,
                 "'%.100s' object has no attribute '%.400s'",
                 Py_TYPE(obj)->tp_name, name);
    return NULL;
@}
@end example

The @ref{487e,,tp_setattr} handler is called when the @ref{1f2e,,__setattr__()} or
@ref{1f2f,,__delattr__()} method of a class instance would be called.  When an
attribute should be deleted, the third parameter will be @code{NULL}.  Here is an
example that simply raises an exception; if this were really all you wanted, the
@ref{487e,,tp_setattr} handler should be set to @code{NULL}.

@example
static int
newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v)
@{
    PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);
    return -1;
@}
@end example

@node Comparación de Objetos,Soporte de protocolo abstracto,Gestión de atributos,Definición de tipos de extensión temas variados
@anchor{extending/newtypes object-comparison}@anchor{487f}
@subsubsection Comparación de Objetos


@example
richcmpfunc tp_richcompare;
@end example

The @ref{4880,,tp_richcompare} handler is called when comparisons are needed.  It is
analogous to the @ref{1f61,,rich comparison methods}, like
@code{__lt__()}, and also called by @ref{4881,,PyObject_RichCompare()} and
@ref{19ac,,PyObject_RichCompareBool()}.

Esta función se llama con dos objetos de Python y el operador como argumentos, donde el operador es uno de @code{Py_EQ}, @code{Py_NE}, @code{Py_LE}, @code{Py_GE}, @code{Py_LT} o @code{Py_GT}. Debe comparar los dos objetos con respecto al operador especificado y retornar @code{Py_True} o @code{Py_False} si la comparación es exitosa, @code{Py_NotImplemented} para indicar que la comparación no está implementada y se debe probar el método de comparación del otro objeto, o @code{NULL} si se estableció una excepción.

Aquí hay una implementación de muestra, para un tipo de datos que se considera igual si el tamaño de un puntero interno es igual:

@example
static PyObject *
newdatatype_richcmp(newdatatypeobject *obj1, newdatatypeobject *obj2, int op)
@{
    PyObject *result;
    int c, size1, size2;

    /* code to make sure that both arguments are of type
       newdatatype omitted */

    size1 = obj1->obj_UnderlyingDatatypePtr->size;
    size2 = obj2->obj_UnderlyingDatatypePtr->size;

    switch (op) @{
    case Py_LT: c = size1 <  size2; break;
    case Py_LE: c = size1 <= size2; break;
    case Py_EQ: c = size1 == size2; break;
    case Py_NE: c = size1 != size2; break;
    case Py_GT: c = size1 >  size2; break;
    case Py_GE: c = size1 >= size2; break;
    @}
    result = c ? Py_True : Py_False;
    Py_INCREF(result);
    return result;
 @}
@end example

@node Soporte de protocolo abstracto,Soporte de referencia débil,Comparación de Objetos,Definición de tipos de extensión temas variados
@anchor{extending/newtypes abstract-protocol-support}@anchor{4882}
@subsubsection Soporte de protocolo abstracto


Python admite una variedad de protocolos `abstractos'; las interfaces específicas proporcionadas para usar estas interfaces están documentadas en @ref{4883,,Capa de objetos abstractos}.

Varias de estas interfaces abstractas se definieron temprano en el desarrollo de la implementación de Python. En particular, los protocolos de número, mapeo y secuencia han sido parte de Python desde el principio. Se han agregado otros protocolos con el tiempo. Para los protocolos que dependen de varias rutinas de controlador de la implementación de tipo, los protocolos más antiguos se han definido como bloques opcionales de controladores a los que hace referencia el objeto de tipo. Para los protocolos más nuevos, hay espacios adicionales en el objeto de tipo principal, con un bit de marca que se establece para indicar que los espacios están presentes y el intérprete debe verificarlos. (El bit de indicador no indica que los valores de intervalo no son @code{NULL}. El indicador puede establecerse para indicar la presencia de un intervalo, pero un intervalo aún puede estar vacío.):

@example
PyNumberMethods   *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods  *tp_as_mapping;
@end example

Si desea que su objeto pueda actuar como un número, una secuencia o un objeto de mapeo, entonces coloca la dirección de una estructura que implementa el tipo C @ref{145d,,PyNumberMethods}, @ref{4884,,PySequenceMethods}, o @ref{4885,,PyMappingMethods}, respectivamente. Depende de usted completar esta estructura con los valores apropiados. Puede encontrar ejemplos del uso de cada uno de estos en el directorio @code{Objects} de la distribución fuente de Python.

@example
hashfunc tp_hash;
@end example

Esta función, si elige proporcionarla, debería retornar un número hash para una instancia de su tipo de datos. Aquí hay un ejemplo simple:

@example
static Py_hash_t
newdatatype_hash(newdatatypeobject *obj)
@{
    Py_hash_t result;
    result = obj->some_size + 32767 * obj->some_number;
    if (result == -1)
       result = -2;
    return result;
@}
@end example

@ref{12d1,,Py_hash_t} es un tipo entero con signo con un ancho que varia dependiendo de la plataforma.retornar @code{-1} de @ref{4886,,tp_hash} indica un error, por lo que debe tener cuidado de evitar retornarlo cuando el cálculo de hash sea exitoso, como se vio anteriormente.

@example
ternaryfunc tp_call;
@end example

Esta función se llama cuando una instancia de su tipo de datos se «llama», por ejemplo, si @code{obj1} es una instancia de su tipo de datos y el script de Python contiene @code{obj1('hello')}, el controlador @ref{5fc,,tp_call} se invoca.

Esta función toma tres argumentos:


@enumerate 

@item 
`self' es la instancia del tipo de datos que es el sujeto de la llamada. Si la llamada es @code{obj1('hola')}, entonces `self' es @code{obj1}.

@item 
`args' es una tupla que contiene los argumentos de la llamada. Puede usar @ref{615,,PyArg_ParseTuple()} para extraer los argumentos.

@item 
`kwds' es un diccionario de argumentos de palabras clave que se pasaron. Si no es @code{NULL} y admite argumentos de palabras clave, use @ref{475,,PyArg_ParseTupleAndKeywords()} para extraer los argumentos. Si no desea admitir argumentos de palabras clave y esto no es @code{NULL}, genere un @ref{228,,TypeError} con un mensaje que indique que los argumentos de palabras clave no son compatibles.
@end enumerate

Aquí hay una implementación de juguete @code{tp_call}:

@example
static PyObject *
newdatatype_call(newdatatypeobject *obj, PyObject *args, PyObject *kwds)
@{
    PyObject *result;
    const char *arg1;
    const char *arg2;
    const char *arg3;

    if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) @{
        return NULL;
    @}
    result = PyUnicode_FromFormat(
        "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n",
        obj->obj_UnderlyingDatatypePtr->size,
        arg1, arg2, arg3);
    return result;
@}
@end example

@example
/* Iterators */
getiterfunc tp_iter;
iternextfunc tp_iternext;
@end example

These functions provide support for the iterator protocol.  Both handlers
take exactly one parameter, the instance for which they are being called,
and return a new reference.  In the case of an error, they should set an
exception and return @code{NULL}.  @ref{152e,,tp_iter} corresponds
to the Python @ref{1f5b,,__iter__()} method, while @ref{152f,,tp_iternext}
corresponds to the Python @ref{1335,,__next__()} method.

Cualquier objeto @ref{1294,,iterable} debe implementar el manejador @ref{152e,,tp_iter}, que debe retornar un objeto @ref{313,,iterator}. Aquí se aplican las mismas pautas que para las clases de Python:


@itemize *

@item 
Para colecciones (como listas y tuplas) que pueden admitir múltiples iteradores independientes, cada llamada debe crear y retornar un nuevo iterador a @ref{152e,,tp_iter}.

@item 
Los objetos que solo se pueden iterar una vez (generalmente debido a los efectos secundarios de la iteración, como los objetos de archivo) pueden implementar @ref{152e,,tp_iter} retornando una nueva referencia a ellos mismos y, por lo tanto, también deben implementar el manejador @ref{152f,,tp_iternext}.
@end itemize

Cualquier objeto @ref{313,,iterator} debe implementar tanto @ref{152e,,tp_iter} como @ref{152f,,tp_iternext}. El manejador de un iterador @ref{152e,,tp_iter} debería retornar una nueva referencia al iterador. Su controlador @ref{152f,,tp_iternext} debería retornar una nueva referencia al siguiente objeto en la iteración, si hay uno. Si la iteración ha llegado al final, @ref{152f,,tp_iternext} puede retornar @code{NULL} sin establecer una excepción, o puede establecer @ref{c82,,StopIteration} `además' para retornar @code{NULL}; evitar la excepción puede producir un rendimiento ligeramente mejor. Si se produce un error real, @ref{152f,,tp_iternext} siempre debe establecer una excepción y retornar @code{NULL}.

@node Soporte de referencia débil,Más Sugerencias,Soporte de protocolo abstracto,Definición de tipos de extensión temas variados
@anchor{extending/newtypes weak-reference-support}@anchor{4887}@anchor{extending/newtypes weakref-support}@anchor{2557}
@subsubsection Soporte de referencia débil


Uno de los objetivos de la implementación de referencia débil de Python es permitir que cualquier tipo participe en el mecanismo de referencia débil sin incurrir en la sobrecarga de objetos críticos para el rendimiento (como los números).


@subsubheading Ver también


Documentación para el módulo @ref{114,,weakref}.


For an object to be weakly referenceable, the extension type must set the
@code{Py_TPFLAGS_MANAGED_WEAKREF} bit of the @ref{18c6,,tp_flags}
field. The legacy @ref{a1a,,tp_weaklistoffset} field should
be left as zero.

Concretely, here is how the statically declared type object would look:

@example
static PyTypeObject TrivialType = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    /* ... other members omitted for brevity ... */
    .tp_flags = Py_TPFLAGS_MANAGED_WEAKREF | ...,
@};
@end example

The only further addition is that @code{tp_dealloc} needs to clear any weak
references (by calling @ref{61a,,PyObject_ClearWeakRefs()}):

@example
static void
Trivial_dealloc(TrivialObject *self)
@{
    /* Clear weakrefs first before calling any destructors */
    PyObject_ClearWeakRefs((PyObject *) self);
    /* ... remainder of destruction code omitted for brevity ... */
    Py_TYPE(self)->tp_free((PyObject *) self);
@}
@end example

@node Más Sugerencias,,Soporte de referencia débil,Definición de tipos de extensión temas variados
@anchor{extending/newtypes more-suggestions}@anchor{4888}
@subsubsection Más Sugerencias


Para aprender a implementar cualquier método específico para su nuevo tipo de datos, obtenga el código fuente @ref{796,,CPython}. Vaya al directorio @code{Objects}, luego busque en los archivos fuente C @code{tp_} más la función que desee (por ejemplo, @code{tp_richcompare}). Encontrará ejemplos de la función que desea implementar.

Cuando necesite verificar que un objeto es una instancia concreta del tipo que está implementando, use la función @ref{1900,,PyObject_TypeCheck()}. Una muestra de su uso podría ser algo como lo siguiente:

@example
if (!PyObject_TypeCheck(some_object, &MyType)) @{
    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    return NULL;
@}
@end example


@subsubheading Ver también



@table @asis

@item Descargue las versiones de origen de CPython.

@indicateurl{https://www.python.org/downloads/source/}

@item El proyecto CPython en GitHub, donde se desarrolla el código fuente de CPython.

@indicateurl{https://github.com/python/cpython}
@end table


@node Construyendo extensiones C y C++,Creación de extensiones C y C++ en Windows,Definición de tipos de extensión temas variados,Crear extensiones sin herramientas de terceros
@anchor{extending/building doc}@anchor{4889}@anchor{extending/building building}@anchor{4838}@anchor{extending/building building-c-and-c-extensions}@anchor{488a}
@subsection Construyendo extensiones C y C++


Una extensión C para CPython es una biblioteca compartida (por ejemplo, un archivo @code{.so} en Linux, @code{.pyd} en Windows), que exporta una `función de inicialización'.

To be importable, the shared library must be available on 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH},
and must be named after the module name, with an appropriate extension.
When using setuptools, the correct filename is generated automatically.

La función de inicialización tiene la firma:

@geindex PyInit_modulename (C function)
@anchor{extending/building c PyInit_modulename}@anchor{488b}
@deffn {C Función} @ref{42d,,PyObject} *PyInit_modulename (void)
@end deffn

It returns either a fully initialized module, or a @ref{a0f,,PyModuleDef}
instance. See @ref{488c,,Inicializando módulos en C} for details.

Para los módulos con nombres solo ASCII, la función debe llamarse @code{PyInit_<modulename>}, con @code{<modulename>} reemplazado por el nombre del módulo. Cuando se usa @ref{488d,,Inicialización multifase}, se permiten nombres de módulos que no sean ASCII. En este caso, el nombre de la función de inicialización es @code{PyInitU_<modulename>}, con @code{<modulename>} codificado usando la codificación `punycode' de Python con guiones reemplazados por guiones bajos. En Python:

@example
def initfunc_name(name):
    try:
        suffix = b'_' + name.encode('ascii')
    except UnicodeEncodeError:
        suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')
    return b'PyInit' + suffix
@end example

Es posible exportar múltiples módulos desde una única biblioteca compartida definiendo múltiples funciones de inicialización. Sin embargo, importarlos requiere el uso de enlaces simbólicos o un importador personalizado, porque de forma predeterminada solo se encuentra la función correspondiente al nombre del archivo. Consulte la sección `«Múltiples módulos en una biblioteca»' en 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} para más detalles.
@anchor{extending/building install-index}@anchor{f79}
@menu
* Building C and C++ Extensions with setuptools:: 

@end menu

@node Building C and C++ Extensions with setuptools,,,Construyendo extensiones C y C++
@anchor{extending/building building-c-and-c-extensions-with-setuptools}@anchor{488e}@anchor{extending/building setuptools-index}@anchor{f7a}
@subsubsection Building C and C++ Extensions with setuptools


Python 3.12 and newer no longer come with distutils. Please refer to the
@code{setuptools} documentation at
@indicateurl{https://setuptools.readthedocs.io/en/latest/setuptools.html}
to learn more about how build and distribute C/C++ extensions with setuptools.

@node Creación de extensiones C y C++ en Windows,,Construyendo extensiones C y C++,Crear extensiones sin herramientas de terceros
@anchor{extending/windows doc}@anchor{488f}@anchor{extending/windows building-c-and-c-extensions-on-windows}@anchor{4890}@anchor{extending/windows building-on-windows}@anchor{1e3e}
@subsection Creación de extensiones C y C++ en Windows


Este capítulo explica brevemente cómo crear un módulo de extensión de Windows para Python usando Microsoft Visual C++, y sigue con información de fondo más detallada sobre cómo funciona. El material explicativo es útil tanto para el programador de Windows que está aprendiendo a construir extensiones de Python como para el programador de Unix interesado en producir software que se pueda construir con éxito tanto en Unix como en Windows.

Se alienta a los autores de módulos a utilizar el enfoque distutils para construir módulos de extensión, en lugar del descrito en esta sección. Aún necesitará el compilador de C que se utilizó para construir Python; típicamente Microsoft Visual C++.

@cartouche
@quotation Nota 
Este capítulo menciona varios nombres de archivo que incluyen un número de versión codificado de Python. Estos nombres de archivo se representan con el número de versión que se muestra como @code{XY}; en la práctica, @code{'X'} será el número de versión principal y @code{'Y'} será el número de versión menor de la versión de Python con la que está trabajando. Por ejemplo, si está utilizando Python 2.2.1, @code{XY} en realidad será @code{22}.
@end quotation
@end cartouche

@menu
* Un enfoque de libro de cocina:: 
* Diferencias entre Unix y Windows:: 
* Usar DLL en la práctica:: 

@end menu

@node Un enfoque de libro de cocina,Diferencias entre Unix y Windows,,Creación de extensiones C y C++ en Windows
@anchor{extending/windows a-cookbook-approach}@anchor{4891}@anchor{extending/windows win-cookbook}@anchor{4892}
@subsubsection Un enfoque de libro de cocina


There are two approaches to building extension modules on Windows, just as there
are on Unix: use the @code{setuptools} package to control the build process, or
do things manually.  The setuptools approach works well for most extensions;
documentation on using @code{setuptools} to build and package extension modules
is available in @ref{f7a,,Building C and C++ Extensions with setuptools}.  If you find you really need to do
things manually, it may be instructive to study the project file for the
winsound@footnote{https://github.com/python/cpython/tree/main/PCbuild/winsound.vcxproj} standard library module.

@node Diferencias entre Unix y Windows,Usar DLL en la práctica,Un enfoque de libro de cocina,Creación de extensiones C y C++ en Windows
@anchor{extending/windows differences-between-unix-and-windows}@anchor{4893}@anchor{extending/windows dynamic-linking}@anchor{4894}
@subsubsection Diferencias entre Unix y Windows


Unix y Windows usan paradigmas completamente diferentes para la carga de código en tiempo de ejecución. Antes de intentar construir un módulo que se pueda cargar dinámicamente, tenga en cuenta cómo funciona su sistema.

En Unix, un archivo de objeto compartido (@code{.so}) contiene código para ser utilizado por el programa, y también los nombres de funciones y datos que espera encontrar en el programa. Cuando el archivo se une al programa, todas las referencias a esas funciones y datos en el código del archivo se cambian para apuntar a las ubicaciones reales en el programa donde las funciones y los datos se colocan en la memoria. Esto es básicamente una operación de enlace.

En Windows, un archivo de biblioteca de enlace dinámico (@code{.dll}) no tiene referencias colgantes. En cambio, un acceso a funciones o datos pasa por una tabla de búsqueda. Por lo tanto, el código DLL no tiene que repararse en tiempo de ejecución para referirse a la memoria del programa; en cambio, el código ya usa la tabla de búsqueda de la DLL, y la tabla de búsqueda se modifica en tiempo de ejecución para apuntar a las funciones y los datos.

En Unix, solo hay un tipo de archivo de biblioteca (@code{.a}) que contiene código de varios archivos de objeto (@code{.o}). Durante el paso de enlace para crear un archivo de objeto compartido (@code{.so}), el enlazador puede encontrar que no sabe dónde se define un identificador. El enlazador lo buscará en los archivos de objetos en las bibliotecas; si lo encuentra, incluirá todo el código de ese archivo de objeto.

En Windows, hay dos tipos de biblioteca, una biblioteca estática y una biblioteca de importación (ambas llamadas @code{.lib}). Una biblioteca estática es como un archivo Unix @code{.a}; Contiene código para ser incluido según sea necesario. Una biblioteca de importación se usa básicamente solo para asegurarle al enlazador que cierto identificador es legal y estará presente en el programa cuando se cargue la DLL. Por lo tanto, el enlazador utiliza la información de la biblioteca de importación para crear la tabla de búsqueda para usar identificadores que no están incluidos en la DLL. Cuando se vincula una aplicación o una DLL, se puede generar una biblioteca de importación, que deberá usarse para todas las DLL futuras que dependan de los símbolos en la aplicación o DLL.

Suponga que está creando dos módulos de carga dinámica, B y C, que deberían compartir otro bloque de código A. En Unix, `no' pasaría @code{A.a} al enlazador para @code{B.so} y @code{C.so}; eso haría que se incluyera dos veces, de modo que B y C tengan cada uno su propia copia. En Windows, compilar @code{A.dll} también compilará @code{A.lib}. Usted `si' pasa @code{A.lib} al enlazador para B y C. @code{A.lib} no contiene código; solo contiene información que se usará en tiempo de ejecución para acceder al código de A.

En Windows, usar una biblioteca de importación es como usar @code{importar spam}; le da acceso a los nombres de spam, pero no crea una copia separada. En Unix, vincular con una biblioteca es más como @code{from spam import*}; crea una copia separada.

@node Usar DLL en la práctica,,Diferencias entre Unix y Windows,Creación de extensiones C y C++ en Windows
@anchor{extending/windows using-dlls-in-practice}@anchor{4895}@anchor{extending/windows win-dlls}@anchor{4896}
@subsubsection Usar DLL en la práctica


Windows Python is built in Microsoft Visual C++; using other compilers may or
may not work.  The rest of this section is MSVC++ specific.

Al crear archivos DLL en Windows, debe pasar @code{pythonXY.lib} al enlazador. Para construir dos DLL, spam y ni (que usa funciones C que se encuentran en el spam), puede usar estos comandos:

@example
cl /LD /I/python/include spam.c ../libs/pythonXY.lib
cl /LD /I/python/include ni.c spam.lib ../libs/pythonXY.lib
@end example

El primer comando creó tres archivos: @code{spam.obj}, @code{spam.dll} y @code{spam.lib}. @code{Spam.dll} no contiene ninguna función de Python (como @ref{615,,PyArg_ParseTuple()}), pero sabe cómo encontrar el código de Python gracias a @code{pythonXY.lib}.

El segundo comando creó @code{ni.dll} (y @code{.obj} y @code{.lib}), que sabe cómo encontrar las funciones necesarias del spam, y también del ejecutable de Python.

No todos los identificadores se exportan a la tabla de búsqueda. Si desea que cualquier otro módulo (incluido Python) pueda ver sus identificadores, debe decir @code{_declspec(dllexport)}, como en @code{void _declspec(dllexport) initspam(void)} o @code{PyObject_declspec(dllexport) *NiGetSpamData(void)}.

Developer Studio will throw in a lot of import libraries that you do not really
need, adding about 100K to your executable.  To get rid of them, use the Project
Settings dialog, Link tab, to specify `ignore default libraries'.  Add the
correct @code{msvcrt`xx'.lib} to the list of libraries.

@node Incrustar el tiempo de ejecución de CPython en una aplicación más grande,,Crear extensiones sin herramientas de terceros,Ampliación e incrustación del intérprete de Python
@anchor{extending/index embedding-the-cpython-runtime-in-a-larger-application}@anchor{4897}
@section Incrustar el tiempo de ejecución de CPython en una aplicación más grande


A veces, en lugar de crear una extensión que se ejecute dentro del intérprete de Python como la aplicación principal, es conveniente incorporar el tiempo de ejecución de CPython dentro de una aplicación más grande. Esta sección cubre algunos de los detalles involucrados en hacerlo con éxito.

@menu
* Incrustando Python en otra aplicación:: 

@end menu

@node Incrustando Python en otra aplicación,,,Incrustar el tiempo de ejecución de CPython en una aplicación más grande
@anchor{extending/embedding doc}@anchor{4898}@anchor{extending/embedding embedding}@anchor{1e5a}@anchor{extending/embedding embedding-python-in-another-application}@anchor{4899}
@subsection Incrustando Python en otra aplicación


Los capítulos anteriores discutieron cómo extender Python, es decir, cómo extender la funcionalidad de Python al adjuntarle una biblioteca de funciones C. También es posible hacerlo al revés: enriquezca su aplicación C/C++ incrustando Python en ella. La incrustación proporciona a su aplicación la capacidad de implementar parte de la funcionalidad de su aplicación en Python en lugar de C o C++. Esto se puede usar para muchos propósitos; Un ejemplo sería permitir a los usuarios adaptar la aplicación a sus necesidades escribiendo algunos scripts en Python. También puede usarlo usted mismo si parte de la funcionalidad se puede escribir en Python más fácilmente.

Incrustar Python es similar a extenderlo, pero no del todo. La diferencia es que cuando extiende Python, el programa principal de la aplicación sigue siendo el intérprete de Python, mientras que si incrusta Python, el programa principal puede no tener nada que ver con Python — en cambio, algunas partes de la aplicación ocasionalmente llaman al Intérprete de Python para ejecutar algún código de Python.

Entonces, si está incrustando Python, está proporcionando su propio programa principal. Una de las cosas que tiene que hacer este programa principal es inicializar el intérprete de Python. Como mínimo, debe llamar a la función @ref{247,,Py_Initialize()}. Hay llamadas opcionales para pasar argumentos de línea de comandos a Python. Luego, puede llamar al intérprete desde cualquier parte de la aplicación.

Hay varias formas diferentes de llamar al intérprete: puede pasar una cadena que contiene declaraciones de Python a @ref{489a,,PyRun_SimpleString()}, o puede pasar un puntero de archivo estándar y un nombre de archivo (solo para identificación en mensajes de error) a @ref{489b,,PyRun_SimpleFile()}. También puede llamar a las operaciones de nivel inferior descritas en los capítulos anteriores para construir y usar objetos de Python.


@subsubheading Ver también



@table @asis

@item @ref{1be3,,Manual de referencia de la API en C de Python}

Los detalles de la interfaz C de Python se dan en este manual. Una gran cantidad de información necesaria se puede encontrar aquí.
@end table


@menu
* Incrustación de muy alto nivel:: 
* Más allá de la incrustación de muy alto nivel; una visión general: Más allá de la incrustación de muy alto nivel una visión general. 
* Incrustación pura:: 
* Extendiendo Python incrustado:: 
* Incrustando Python en C++:: 
* Compilar y enlazar bajo sistemas tipo Unix:: 

@end menu

@node Incrustación de muy alto nivel,Más allá de la incrustación de muy alto nivel una visión general,,Incrustando Python en otra aplicación
@anchor{extending/embedding high-level-embedding}@anchor{489c}@anchor{extending/embedding very-high-level-embedding}@anchor{489d}
@subsubsection Incrustación de muy alto nivel


La forma más simple de incrustar Python es el uso de la interfaz de muy alto nivel. Esta interfaz está diseñada para ejecutar un script de Python sin necesidad de interactuar directamente con la aplicación. Esto puede usarse, por ejemplo, para realizar alguna operación en un archivo.

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyStatus status;
    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* optional but recommended */
    status = PyConfig_SetBytesString(&config, &config.program_name, argv[0]);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    PyRun_SimpleString("from time import time,ctime\n"
                       "print('Today is', ctime(time()))\n");
    if (Py_FinalizeEx() < 0) @{
        exit(120);
    @}
    return 0;

  exception:
     PyConfig_Clear(&config);
     Py_ExitStatusException(status);
@}
@end example

@cartouche
@quotation Nota 
@code{#define PY_SSIZE_T_CLEAN} was used to indicate that @code{Py_ssize_t} should be
used in some APIs instead of @code{int}.
It is not necessary since Python 3.13, but we keep it here for backward compatibility.
See @ref{47d,,Cadena de caracteres y búferes} for a description of this macro.
@end quotation
@end cartouche

Setting @ref{4a5,,PyConfig.program_name} should be called before
@ref{4a6,,Py_InitializeFromConfig()} to inform the interpreter about paths to Python run-time
libraries.  Next, the Python interpreter is initialized with
@ref{247,,Py_Initialize()}, followed by the execution of a hard-coded Python script
that prints the date and time.  Afterwards, the @ref{d9c,,Py_FinalizeEx()} call shuts
the interpreter down, followed by the end of the program.  In a real program,
you may want to get the Python script from another source, perhaps a text-editor
routine, a file, or a database.  Getting the Python code from a file can better
be done by using the @ref{489b,,PyRun_SimpleFile()} function, which saves you the
trouble of allocating memory space and loading the file contents.

@node Más allá de la incrustación de muy alto nivel una visión general,Incrustación pura,Incrustación de muy alto nivel,Incrustando Python en otra aplicación
@anchor{extending/embedding beyond-very-high-level-embedding-an-overview}@anchor{489e}@anchor{extending/embedding lower-level-embedding}@anchor{489f}
@subsubsection Más allá de la incrustación de muy alto nivel: una visión general


La interfaz de alto nivel le permite ejecutar piezas arbitrarias de código Python desde su aplicación, pero el intercambio de valores de datos es bastante engorroso, por decir lo menos. Si lo desea, debe usar llamadas de nivel inferior. A costa de tener que escribir más código C, puede lograr casi cualquier cosa.

Cabe señalar que extender Python e incrustar Python es la misma actividad, a pesar de la intención diferente. La mayoría de los temas tratados en los capítulos anteriores siguen siendo válidos. Para mostrar esto, considere lo que realmente hace el código de extensión de Python a C:


@enumerate 

@item 
Convierte valores de datos de Python a C,

@item 
Realice una llamada de función a una rutina C usando los valores convertidos, y

@item 
Convierte los valores de datos de la llamada de C a Python.
@end enumerate

Al incrustar Python, el código de interfaz hace:


@enumerate 

@item 
Convierte valores de datos de C a Python,

@item 
Realice una llamada de función a una rutina de interfaz de Python utilizando los valores convertidos, y

@item 
Convierte los valores de datos de la llamada de Python a C.
@end enumerate

Como puede ver, los pasos de conversión de datos simplemente se intercambian para acomodar la dirección diferente de la transferencia de idiomas cruzados. La única diferencia es la rutina que llama entre ambas conversiones de datos. Al extender, llama a una rutina C, al incrustar, llama a una rutina Python.

Este capítulo no discutirá cómo convertir datos de Python a C y viceversa. Además, se supone que se entiende el uso adecuado de las referencias y el tratamiento de errores. Dado que estos aspectos no difieren de extender el intérprete, puede consultar los capítulos anteriores para obtener la información requerida.

@node Incrustación pura,Extendiendo Python incrustado,Más allá de la incrustación de muy alto nivel una visión general,Incrustando Python en otra aplicación
@anchor{extending/embedding id1}@anchor{48a0}@anchor{extending/embedding pure-embedding}@anchor{48a1}
@subsubsection Incrustación pura


El primer programa tiene como objetivo ejecutar una función en un script Python. Al igual que en la sección sobre la interfaz de muy alto nivel, el intérprete de Python no interactúa directamente con la aplicación (pero eso cambiará en la siguiente sección).

El código para ejecutar una función definida en un script de Python es:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyObject *pName, *pModule, *pFunc;
    PyObject *pArgs, *pValue;
    int i;

    if (argc < 3) @{
        fprintf(stderr,"Usage: call pythonfile funcname [args]\n");
        return 1;
    @}

    Py_Initialize();
    pName = PyUnicode_DecodeFSDefault(argv[1]);
    /* Error checking of pName left out */

    pModule = PyImport_Import(pName);
    Py_DECREF(pName);

    if (pModule != NULL) @{
        pFunc = PyObject_GetAttrString(pModule, argv[2]);
        /* pFunc is a new reference */

        if (pFunc && PyCallable_Check(pFunc)) @{
            pArgs = PyTuple_New(argc - 3);
            for (i = 0; i < argc - 3; ++i) @{
                pValue = PyLong_FromLong(atoi(argv[i + 3]));
                if (!pValue) @{
                    Py_DECREF(pArgs);
                    Py_DECREF(pModule);
                    fprintf(stderr, "Cannot convert argument\n");
                    return 1;
                @}
                /* pValue reference stolen here: */
                PyTuple_SetItem(pArgs, i, pValue);
            @}
            pValue = PyObject_CallObject(pFunc, pArgs);
            Py_DECREF(pArgs);
            if (pValue != NULL) @{
                printf("Result of call: %ld\n", PyLong_AsLong(pValue));
                Py_DECREF(pValue);
            @}
            else @{
                Py_DECREF(pFunc);
                Py_DECREF(pModule);
                PyErr_Print();
                fprintf(stderr,"Call failed\n");
                return 1;
            @}
        @}
        else @{
            if (PyErr_Occurred())
                PyErr_Print();
            fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
        @}
        Py_XDECREF(pFunc);
        Py_DECREF(pModule);
    @}
    else @{
        PyErr_Print();
        fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
        return 1;
    @}
    if (Py_FinalizeEx() < 0) @{
        return 120;
    @}
    return 0;
@}
@end example

Este código carga un script de Python usando @code{argv[1]} y llama a la función nombrada en @code{argv[2]}. Sus argumentos enteros son los otros valores del arreglo @code{argv}. Si usted @ref{48a2,,compila y enlaza} este programa (llamemos al ejecutable terminado @code{call}), y úselo para ejecutar un script Python, como:

@example
def multiply(a,b):
    print("Will compute", a, "times", b)
    c = 0
    for i in range(0, a):
        c = c + b
    return c
@end example

entonces el resultado debería ser:

@example
$ call multiply multiply 3 2
Will compute 3 times 2
Result of call: 6
@end example

Aunque el programa es bastante grande por su funcionalidad, la mayor parte del código es para la conversión de datos entre Python y C, y para informes de errores. La parte interesante con respecto a incrustar Python comienza con:

@example
Py_Initialize();
pName = PyUnicode_DecodeFSDefault(argv[1]);
/* Error checking of pName left out */
pModule = PyImport_Import(pName);
@end example

Después de inicializar el intérprete, el script se carga usando @ref{143c,,PyImport_Import()}. Esta rutina necesita una cadena Python como argumento, que se construye utilizando la rutina de conversión de datos @ref{48a3,,PyUnicode_FromString()}.

@example
pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc is a new reference */

if (pFunc && PyCallable_Check(pFunc)) @{
    ...
@}
Py_XDECREF(pFunc);
@end example

Una vez que se carga el script, el nombre que estamos buscando se recupera usando @ref{440,,PyObject_GetAttrString()}. Si el nombre existe y el objeto retornado es invocable, puede asumir con seguridad que es una función. Luego, el programa continúa construyendo una tupla de argumentos como de costumbre. La llamada a la función Python se realiza con:

@example
pValue = PyObject_CallObject(pFunc, pArgs);
@end example

Al regresar la función, @code{pValue} es @code{NULL} o contiene una referencia al valor de retorno de la función. Asegúrese de liberar la referencia después de examinar el valor.

@node Extendiendo Python incrustado,Incrustando Python en C++,Incrustación pura,Incrustando Python en otra aplicación
@anchor{extending/embedding extending-embedded-python}@anchor{48a4}@anchor{extending/embedding extending-with-embedding}@anchor{48a5}
@subsubsection Extendiendo Python incrustado


Hasta ahora, el intérprete de Python incorporado no tenía acceso a la funcionalidad de la aplicación misma. La API de Python lo permite al extender el intérprete incorporado. Es decir, el intérprete incorporado se amplía con las rutinas proporcionadas por la aplicación. Si bien suena complejo, no es tan malo. Simplemente olvide por un momento que la aplicación inicia el intérprete de Python. En cambio, considere que la aplicación es un conjunto de subrutinas y escriba un código de pegamento que le otorgue a Python acceso a esas rutinas, al igual que escribiría una extensión normal de Python. Por ejemplo:

@example
static int numargs=0;

/* Return the number of arguments of the application command line */
static PyObject*
emb_numargs(PyObject *self, PyObject *args)
@{
    if(!PyArg_ParseTuple(args, ":numargs"))
        return NULL;
    return PyLong_FromLong(numargs);
@}

static PyMethodDef EmbMethods[] = @{
    @{"numargs", emb_numargs, METH_VARARGS,
     "Return the number of arguments received by the process."@},
    @{NULL, NULL, 0, NULL@}
@};

static PyModuleDef EmbModule = @{
    PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,
    NULL, NULL, NULL, NULL
@};

static PyObject*
PyInit_emb(void)
@{
    return PyModule_Create(&EmbModule);
@}
@end example

Inserte el código anterior justo encima de la función @code{main()}. Además, inserte las siguientes dos declaraciones antes de la llamada a @ref{247,,Py_Initialize()}:

@example
numargs = argc;
PyImport_AppendInittab("emb", &PyInit_emb);
@end example

These two lines initialize the @code{numargs} variable, and make the
@code{emb.numargs()} function accessible to the embedded Python interpreter.
With these extensions, the Python script can do things like

@example
import emb
print("Number of arguments", emb.numargs())
@end example

En una aplicación real, los métodos expondrán una API de la aplicación a Python.

@c TODO: threads, code examples do not really behave well if errors happen
@c (what to watch out for)

@node Incrustando Python en C++,Compilar y enlazar bajo sistemas tipo Unix,Extendiendo Python incrustado,Incrustando Python en otra aplicación
@anchor{extending/embedding embedding-python-in-c}@anchor{48a6}@anchor{extending/embedding embeddingincplusplus}@anchor{48a7}
@subsubsection Incrustando Python en C++


También es posible incrustar Python en un programa C++; precisamente cómo se hace esto dependerá de los detalles del sistema C++ utilizado; en general, necesitará escribir el programa principal en C++ y usar el compilador de C++ para compilar y vincular su programa. No es necesario volver a compilar Python usando C++.

@node Compilar y enlazar bajo sistemas tipo Unix,,Incrustando Python en C++,Incrustando Python en otra aplicación
@anchor{extending/embedding compiling}@anchor{48a2}@anchor{extending/embedding compiling-and-linking-under-unix-like-systems}@anchor{48a8}
@subsubsection Compilar y enlazar bajo sistemas tipo Unix


No es necesariamente trivial encontrar los indicadores correctos para pasar a su compilador (y enlazador) para incrustar el intérprete de Python en su aplicación, particularmente porque Python necesita cargar módulos de biblioteca implementados como extensiones dinámicas en C (archivos @code{.so}) enlazados en su contra.

Para conocer los indicadores necesarios del compilador y el enlazador, puede ejecutar el script @code{python`X.Y'-config} que se genera como parte del proceso de instalación (también puede estar disponible un script @code{python3-config} ) Este script tiene varias opciones, de las cuales las siguientes serán directamente útiles para usted:


@itemize *

@item 
@code{pythonX.Y-config --cflags} le dará las banderas recomendadas al compilar:

@example
$ /opt/bin/python3.11-config --cflags
-I/opt/include/python3.11 -I/opt/include/python3.11 -Wsign-compare  -DNDEBUG -g -fwrapv -O3 -Wall
@end example

@item 
@code{pythonX.Y-config --ldflags --embed} will give you the recommended flags
when linking:

@example
$ /opt/bin/python3.11-config --ldflags --embed
-L/opt/lib/python3.11/config-3.11-x86_64-linux-gnu -L/opt/lib -lpython3.11 -lpthread -ldl  -lutil -lm
@end example
@end itemize

@cartouche
@quotation Nota 
Para evitar confusiones entre varias instalaciones de Python (y especialmente entre el sistema Python y su propio Python compilado), se recomienda que use la ruta absoluta a @code{python`X.Y'-config}, como en el ejemplo anterior.
@end quotation
@end cartouche

Si este procedimiento no funciona para usted (no se garantiza que funcione para todas las plataformas tipo Unix; sin embargo, le damos la bienvenida @ref{48a9,,informes de errores}) deberá leer la documentación de su sistema sobre dinámica vincular o examinar Python @code{Makefile} (use @ref{42f5,,sysconfig.get_makefile_filename()} para encontrar su ubicación) y las opciones de compilación. En este caso, el módulo @ref{db,,sysconfig} es una herramienta útil para extraer mediante programación los valores de configuración que querrá combinar. Por ejemplo:

@example
>>> import sysconfig
>>> sysconfig.get_config_var('LIBS')
'-lpthread -ldl  -lutil'
>>> sysconfig.get_config_var('LINKFORSHARED')
'-Xlinker -export-dynamic'
@end example

@c XXX similar documentation for Windows missing

@node Manual de referencia de la API en C de Python,Instalando módulos de Python,Ampliación e incrustación del intérprete de Python,Top
@anchor{c-api/index doc}@anchor{48aa}@anchor{c-api/index c-api-index}@anchor{1be3}@anchor{c-api/index python-c-api-reference-manual}@anchor{48ab}
@chapter Manual de referencia de la API en C de Python


Este manual documenta la API utilizada por los programadores de C y C ++ que desean escribir módulos de extensión o incorporar Python. Es un complemento de @ref{1be2,,Ampliación e incrustación del intérprete de Python}, que describe los principios generales de la escritura de extensión pero no documenta las funciones API en detalle.

@menu
* Introducción: Introducción<11>. 
* Estabilidad de la API en C:: 
* La capa de muy alto nivel:: 
* Conteo de referencias: Conteo de referencias<2>. 
* Manejo de excepciones:: 
* Utilidades: Utilidades<2>. 
* Capa de objetos abstractos:: 
* Capa de objetos concretos:: 
* Inicialización@comma{} finalización e hilos: Inicialización finalización e hilos. 
* Configuración de inicialización de Python:: 
* Gestión de la memoria:: 
* Soporte de implementación de objetos:: 
* Versiones de API y ABI:: 
* Monitoring C API:: 
* Generating Execution Events:: 

@end menu

@node Introducción<11>,Estabilidad de la API en C,,Manual de referencia de la API en C de Python
@anchor{c-api/intro doc}@anchor{48ac}@anchor{c-api/intro api-intro}@anchor{48ad}@anchor{c-api/intro introduction}@anchor{48ae}
@section Introducción


La interfaz del programador de aplicaciones (API) con Python brinda a los programadores de C y C++ acceso al intérprete de Python en una variedad de niveles. La API es igualmente utilizable desde C++, pero por brevedad generalmente se conoce como la API Python/C. Hay dos razones fundamentalmente diferentes para usar la API Python/C. La primera razón es escribir `módulos de extensión' para propósitos específicos; Estos son módulos C que extienden el intérprete de Python. Este es probablemente el uso más común. La segunda razón es usar Python como componente en una aplicación más grande; Esta técnica se conoce generalmente como integración (`embedding') Python en una aplicación.

Escribir un módulo de extensión es un proceso relativamente bien entendido, donde un enfoque de «libro de cocina» (`cookbook') funciona bien. Hay varias herramientas que automatizan el proceso hasta cierto punto. Si bien las personas han integrado Python en otras aplicaciones desde su existencia temprana, el proceso de integrar Python es menos sencillo que escribir una extensión.

Muchas funciones API son útiles independientemente de si está integrando o extendiendo Python; Además, la mayoría de las aplicaciones que integran Python también necesitarán proporcionar una extensión personalizada, por lo que probablemente sea una buena idea familiarizarse con la escritura de una extensión antes de intentar integrar Python en una aplicación real.

@menu
* Estándares de codificación:: 
* Archivos de cabecera (Include): Archivos de cabecera Include. 
* Macros útiles:: 
* Objetos@comma{} tipos y conteos de referencias: Objetos tipos y conteos de referencias. 
* Excepciones: Excepciones<20>. 
* Integración de Python:: 
* Depuración de compilaciones:: 

@end menu

@node Estándares de codificación,Archivos de cabecera Include,,Introducción<11>
@anchor{c-api/intro coding-standards}@anchor{48af}
@subsection Estándares de codificación


Si está escribiendo código C para su inclusión en CPython, `debe' seguir las pautas y estándares definidos en 
@geindex Python Enhancement Proposals; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}. Estas pautas se aplican independientemente de la versión de Python a la que esté contribuyendo. Seguir estas convenciones no es necesario para sus propios módulos de extensión de terceros, a menos que eventualmente espere contribuir con ellos a Python.

@node Archivos de cabecera Include,Macros útiles,Estándares de codificación,Introducción<11>
@anchor{c-api/intro api-includes}@anchor{81d}@anchor{c-api/intro include-files}@anchor{48b0}
@subsection Archivos de cabecera (`Include')


Todas las definiciones de función, tipo y macro necesarias para usar la API Python/C se incluyen en su código mediante la siguiente línea:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

Esto implica la inclusión de los siguientes archivos de encabezado estándar: @code{<stdio.h>}, @code{<string.h>}, @code{<errno.h>}, @code{<limits.h>}, @code{<assert.h>} y @code{<stdlib.h>} (si está disponible).

@cartouche
@quotation Nota 
Dado que Python puede definir algunas definiciones de preprocesador que afectan los encabezados estándar en algunos sistemas, `debe' incluir @code{Python.h} antes de incluir encabezados estándar.

Se recomienda definir siempre @code{PY_SSIZE_T_CLEAN} antes de incluir @code{Python.h}. Consulte @ref{941,,Analizando argumentos y construyendo valores} para obtener una descripción de este macro.
@end quotation
@end cartouche

Todos los nombres visibles del usuario definidos por @code{Python.h} (excepto los definidos por los encabezados estándar incluidos) tienen uno de los prefijos @code{Py} o @code{_Py}. Los nombres que comienzan con @code{_Py} son para uso interno de la implementación de Python y no deben ser utilizados por escritores de extensiones. Los nombres de miembros de estructura no tienen un prefijo reservado.

@cartouche
@quotation Nota 
El código de usuario nunca debe definir nombres que comiencen con @code{Py} o @code{_Py}. Esto confunde al lector y pone en peligro la portabilidad del código de usuario para futuras versiones de Python, que pueden definir nombres adicionales que comienzan con uno de estos prefijos.
@end quotation
@end cartouche

The header files are typically installed with Python.  On Unix, these  are
located in the directories @code{`prefix'/include/pythonversion/} and
@code{`exec_prefix'/include/pythonversion/}, where @ref{1d66,,prefix} and
@ref{1d67,,exec_prefix} are defined by the corresponding parameters to Python’s
@code{configure} script and `version' is
@code{'%d.%d' % sys.version_info[:2]}.  On Windows, the headers are installed
in @code{`prefix'/include}, where @code{prefix} is the installation
directory specified to the installer.

To include the headers, place both directories (if different) on your compiler’s
search path for includes.  Do `not' place the parent directories on the search
path and then use @code{#include <pythonX.Y/Python.h>}; this will break on
multi-platform builds since the platform independent headers under
@ref{1d66,,prefix} include the platform specific headers from
@ref{1d67,,exec_prefix}.

Los usuarios de C++ deben tener en cuenta que aunque la API se define completamente usando C, los archivos de encabezado declaran correctamente que los puntos de entrada son @code{extern "C"}. Como resultado, no es necesario hacer nada especial para usar la API desde C++.

@node Macros útiles,Objetos tipos y conteos de referencias,Archivos de cabecera Include,Introducción<11>
@anchor{c-api/intro useful-macros}@anchor{48b1}
@subsection Macros útiles


Varias macros útiles se definen en los archivos de encabezado de Python. Muchos se definen más cerca de donde son útiles (por ejemplo @ref{14b0,,Py_RETURN_NONE}). Otros de una utilidad más general se definen aquí. Esto no es necesariamente una lista completa.

@geindex PyMODINIT_FUNC (C macro)
@anchor{c-api/intro c PyMODINIT_FUNC}@anchor{1513}
@deffn {C Macro} PyMODINIT_FUNC

Declare an extension module @code{PyInit} initialization function. The function
return type is @ref{42d,,PyObject}*. The macro declares any special linkage
declarations required by the platform, and for C++ declares the function as
@code{extern "C"}.

The initialization function must be named @code{PyInit_@var{name}}, where
`name' is the name of the module, and should be the only non-@code{static}
item defined in the module file. Example:

@example
static struct PyModuleDef spam_module = @{
    PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    ...
@};

PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModule_Create(&spam_module);
@}
@end example
@end deffn

@geindex Py_ABS (C macro)
@anchor{c-api/intro c Py_ABS}@anchor{48b2}
@deffn {C Macro} Py_ABS (x)

Retorna el valor absoluto de @code{x}.


Added in version 3.3.

@end deffn

@geindex Py_ALWAYS_INLINE (C macro)
@anchor{c-api/intro c Py_ALWAYS_INLINE}@anchor{18bf}
@deffn {C Macro} Py_ALWAYS_INLINE

Ordena al compilador a siempre usar inline en una función estática inline. El compilador puede ignorarlo y decidir no usar inline en la función.

Puede ser usado para usar inline en funciones estáticas inline de rendimiento crítico cuando se corre Python en modo de depuración con inline de funciones deshabilitado. Por ejemplo, MSC deshabilita el inline de funciones cuando se configura en modo de depuración.

Marcar ciegamente una función estática inline con Py_ALWAYS_INLINE puede resultar en peor rendimientos (debido a un aumento del tamaño del código, por ejemplo). El compilador es generalmente más inteligente que el desarrollador para el análisis costo/beneficio.

If Python is @ref{357,,built in debug mode} (if the @ref{4060,,Py_DEBUG}
macro is defined), the @ref{18bf,,Py_ALWAYS_INLINE} macro does nothing.

Debe ser especificado antes del tipo de retorno de la función. Uso:

@example
static inline Py_ALWAYS_INLINE int random(void) @{ return 4; @}
@end example


Added in version 3.11.

@end deffn

@geindex Py_CHARMASK (C macro)
@anchor{c-api/intro c Py_CHARMASK}@anchor{48b3}
@deffn {C Macro} Py_CHARMASK (c)

El argumento debe ser un carácter o un número entero en el rango [-128, 127] o [0, 255]. Este macro retorna la conversión @code{c} a un @code{unsigned char}.
@end deffn

@geindex Py_DEPRECATED (C macro)
@anchor{c-api/intro c Py_DEPRECATED}@anchor{b2f}
@deffn {C Macro} Py_DEPRECATED (version)

Use esto para declaraciones obsoletas. El macro debe colocarse antes del nombre del símbolo.

Ejemplo:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example


Distinto en la versión 3.8: Soporte para MSVC fue agregado.

@end deffn

@geindex Py_GETENV (C macro)
@anchor{c-api/intro c Py_GETENV}@anchor{48b4}
@deffn {C Macro} Py_GETENV (s)

Like @code{getenv(s)}, but returns @code{NULL} if @ref{9f0,,-E} was passed on the
command line (see @ref{4ba,,PyConfig.use_environment}).
@end deffn

@geindex Py_MAX (C macro)
@anchor{c-api/intro c Py_MAX}@anchor{48b5}
@deffn {C Macro} Py_MAX (x, y)

Retorna el valor máximo entre @code{x} e @code{y}.


Added in version 3.3.

@end deffn

@geindex Py_MEMBER_SIZE (C macro)
@anchor{c-api/intro c Py_MEMBER_SIZE}@anchor{48b6}
@deffn {C Macro} Py_MEMBER_SIZE (type, member)

Retorna el tamaño de una estructura (@code{type}) @code{member} en bytes.


Added in version 3.6.

@end deffn

@geindex Py_MIN (C macro)
@anchor{c-api/intro c Py_MIN}@anchor{48b7}
@deffn {C Macro} Py_MIN (x, y)

Retorna el valor mínimo entre @code{x} e @code{y}.


Added in version 3.3.

@end deffn

@geindex Py_NO_INLINE (C macro)
@anchor{c-api/intro c Py_NO_INLINE}@anchor{18c0}
@deffn {C Macro} Py_NO_INLINE

Deshabilita el uso de inline en una función. Por ejemplo, reduce el consumo de la pila C: útil en compilaciones LTO+PGO que usan mucho inline (ver bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720}).

Uso:

@example
Py_NO_INLINE static int random(void) @{ return 4; @}
@end example


Added in version 3.11.

@end deffn

@geindex Py_STRINGIFY (C macro)
@anchor{c-api/intro c Py_STRINGIFY}@anchor{48b8}
@deffn {C Macro} Py_STRINGIFY (x)

Convierte @code{x} en una cadena de caracteres C. Por ejemplo, @code{Py_STRINGIFY(123)} retorna @code{"123"}.


Added in version 3.4.

@end deffn

@geindex Py_UNREACHABLE (C macro)
@anchor{c-api/intro c Py_UNREACHABLE}@anchor{c3d}
@deffn {C Macro} Py_UNREACHABLE ()

Use esto cuando tenga una ruta de código a la que no se pueda acceder por diseño. Por ejemplo, en la cláusula @code{default:} en una declaración @code{switch} para la cual todos los valores posibles están cubiertos en declaraciones @code{case}. Use esto en lugares donde podría tener la tentación de poner una llamada @code{assert(0)} o @code{abort()}.

En el modo de lanzamiento, la macro ayuda al compilador a optimizar el código y evita una advertencia sobre el código inalcanzable. Por ejemplo, la macro se implementa con @code{__builtin_unreachable()} en GCC en modo de lanzamiento.

Un uso de @code{Py_UNREACHABLE()} es seguir una llamada a una función que nunca retorna pero que no está declarada @code{_Py_NO_RETURN}.

Si una ruta de código es un código muy poco probable pero se puede acceder en casos excepcionales, esta macro no debe utilizarse. Por ejemplo, en condiciones de poca memoria o si una llamada al sistema retorna un valor fuera del rango esperado. En este caso, es mejor informar el error a la persona que llama. Si no se puede informar del error a la persona que llama, se puede utilizar @ref{a15,,Py_FatalError()}.


Added in version 3.7.

@end deffn

@geindex Py_UNUSED (C macro)
@anchor{c-api/intro c Py_UNUSED}@anchor{1722}
@deffn {C Macro} Py_UNUSED (arg)

Use esto para argumentos no utilizados en una definición de función para silenciar las advertencias del compilador. Ejemplo: @code{int func(int a, int Py_UNUSED(b)) @{return a; @}}.


Added in version 3.4.

@end deffn

@geindex PyDoc_STRVAR (C macro)
@anchor{c-api/intro c PyDoc_STRVAR}@anchor{197b}
@deffn {C Macro} PyDoc_STRVAR (name, str)

Crea una variable con el nombre @code{name} que se puede usar en `docstrings'. Si Python se construye sin `docstrings', el valor estará vacío.

Utilice @ref{197b,,PyDoc_STRVAR} para que los `docstrings' admitan la construcción de Python sin `docstrings', como se especifica en 
@geindex Python Enhancement Proposals; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}.

Ejemplo:

@example
PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element.");

static PyMethodDef deque_methods[] = @{
    // ...
    @{"pop", (PyCFunction)deque_pop, METH_NOARGS, pop_doc@},
    // ...
@}
@end example
@end deffn

@geindex PyDoc_STR (C macro)
@anchor{c-api/intro c PyDoc_STR}@anchor{1812}
@deffn {C Macro} PyDoc_STR (str)

Crea un `docstring' para la cadena de caracteres de entrada dada o una cadena vacía si los `docstrings' están deshabilitados.

Utilice @ref{1812,,PyDoc_STR} al especificar `docstrings' para admitir la construcción de Python sin `docstrings', como se especifica en 
@geindex Python Enhancement Proposals; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}.

Ejemplo:

@example
static PyMethodDef pysqlite_row_methods[] = @{
    @{"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,
        PyDoc_STR("Returns the keys of the row.")@},
    @{NULL, NULL@}
@};
@end example
@end deffn

@node Objetos tipos y conteos de referencias,Excepciones<20>,Macros útiles,Introducción<11>
@anchor{c-api/intro api-objects}@anchor{48b9}@anchor{c-api/intro objects-types-and-reference-counts}@anchor{48ba}
@subsection Objetos, tipos y conteos de referencias


@geindex object;type

Most Python/C API functions have one or more arguments as well as a return value
of type @ref{42d,,PyObject}*.  This type is a pointer to an opaque data type
representing an arbitrary Python object.  Since all Python object types are
treated the same way by the Python language in most situations (e.g.,
assignments, scope rules, and argument passing), it is only fitting that they
should be represented by a single C type.  Almost all Python objects live on the
heap: you never declare an automatic or static variable of type
@ref{42d,,PyObject}, only pointer variables of type @ref{42d,,PyObject}* can  be
declared.  The sole exception are the type objects; since these must never be
deallocated, they are typically static @ref{b30,,PyTypeObject} objects.

Todos los objetos de Python (incluso los enteros de Python) tienen un tipo (`type') y un conteo de referencia (`reference count'). El tipo de un objeto determina qué tipo de objeto es (por ejemplo, un número entero, una lista o una función definida por el usuario; hay muchos más como se explica en @ref{1ee4,,Jerarquía de tipos estándar}). Para cada uno de los tipos conocidos hay un macro para verificar si un objeto es de ese tipo; por ejemplo, @code{PyList_Check(a)} es verdadero si (y solo si) el objeto al que apunta `a' es una lista de Python.

@menu
* Conteo de Referencias:: 
* Tipos:: 

@end menu

@node Conteo de Referencias,Tipos,,Objetos tipos y conteos de referencias
@anchor{c-api/intro api-refcounts}@anchor{48bb}@anchor{c-api/intro reference-counts}@anchor{48bc}
@subsubsection Conteo de Referencias


The reference count is important because today’s computers have a  finite
(and often severely limited) memory size; it counts how many different
places there are that have a @ref{431,,strong reference} to an object.
Such a place could be another object, or a global (or static) C variable,
or a local variable in some C function.
When the last @ref{431,,strong reference} to an object is released
(i.e. its reference count becomes zero), the object is deallocated.
If it contains references to other objects, those references are released.
Those other objects may be deallocated in turn, if there are no more
references to them, and so on.  (There’s an obvious problem  with
objects that reference each other here; for now, the solution
is «don’t do that.»)

@geindex Py_INCREF (C function)
@geindex Py_DECREF (C function)

Reference counts are always manipulated explicitly.  The normal way is
to use the macro @ref{612,,Py_INCREF()} to take a new reference to an
object (i.e. increment its reference count by one),
and @ref{613,,Py_DECREF()} to release that reference (i.e. decrement the
reference count by one).  The @ref{613,,Py_DECREF()} macro
is considerably more complex than the incref one, since it must check whether
the reference count becomes zero and then cause the object’s deallocator to be
called.  The deallocator is a function pointer contained in the object’s type
structure.  The type-specific deallocator takes care of releasing references
for other objects contained in the object if this is a compound
object type, such as a list, as well as performing any additional finalization
that’s needed.  There’s no chance that the reference count can overflow; at
least as many bits are used to hold the reference count as there are distinct
memory locations in virtual memory (assuming @code{sizeof(Py_ssize_t) >= sizeof(void*)}).
Thus, the reference count increment is a simple operation.

It is not necessary to hold a @ref{431,,strong reference} (i.e. increment
the reference count) for every local variable that contains a pointer
to an object.  In theory, the  object’s
reference count goes up by one when the variable is made to  point to it and it
goes down by one when the variable goes out of  scope.  However, these two
cancel each other out, so at the end the  reference count hasn’t changed.  The
only real reason to use the  reference count is to prevent the object from being
deallocated as  long as our variable is pointing to it.  If we know that there
is at  least one other reference to the object that lives at least as long as
our variable, there is no need to take a new @ref{431,,strong reference}
(i.e. increment the reference count) temporarily.
An important situation where this arises is in objects  that are passed as
arguments to C functions in an extension module  that are called from Python;
the call mechanism guarantees to hold a  reference to every argument for the
duration of the call.

However, a common pitfall is to extract an object from a list and hold on to it
for a while without taking a new reference.  Some other operation might
conceivably remove the object from the list, releasing that reference,
and possibly deallocating it. The real danger is that innocent-looking
operations may invoke arbitrary Python code which could do this; there is a code
path which allows control to flow back to the user from a @ref{613,,Py_DECREF()}, so
almost any operation is potentially dangerous.

A safe approach is to always use the generic operations (functions  whose name
begins with @code{PyObject_}, @code{PyNumber_}, @code{PySequence_} or @code{PyMapping_}).
These operations always create a new @ref{431,,strong reference}
(i.e. increment the reference count) of the object they return.
This leaves the caller with the responsibility to call @ref{613,,Py_DECREF()} when
they are done with the result; this soon becomes second nature.

@menu
* Detalles del conteo de referencia:: 

@end menu

@node Detalles del conteo de referencia,,,Conteo de Referencias
@anchor{c-api/intro api-refcountdetails}@anchor{48bd}@anchor{c-api/intro reference-count-details}@anchor{48be}
@subsubsection Detalles del conteo de referencia


The reference count behavior of functions in the Python/C API is best  explained
in terms of `ownership of references'.  Ownership pertains to references, never
to objects (objects are not owned: they are always shared).  «Owning a
reference» means being responsible for calling Py_DECREF on it when the
reference is no longer needed.  Ownership can also be transferred, meaning that
the code that receives ownership of the reference then becomes responsible for
eventually releasing it by calling @ref{613,,Py_DECREF()} or @ref{828,,Py_XDECREF()}
when it’s no longer needed—or passing on this responsibility (usually to its
caller). When a function passes ownership of a reference on to its caller, the
caller is said to receive a `new' reference.  When no ownership is transferred,
the caller is said to `borrow' the reference. Nothing needs to be done for a
@ref{432,,borrowed reference}.

Por el contrario, cuando una función de llamada pasa una referencia a un objeto, hay dos posibilidades: la función `roba' una referencia al objeto, o no lo hace. `Robar una referencia' significa que cuando pasa una referencia a una función, esa función asume que ahora posee esa referencia, y usted ya no es responsable de ella.

@geindex PyList_SetItem (C function)
@geindex PyTuple_SetItem (C function)

Pocas funciones roban referencias; las dos excepciones notables son @ref{484a,,PyList_SetItem()} y @ref{4849,,PyTuple_SetItem()}, que roban una referencia al elemento (¡pero no a la tupla o lista en la que se coloca el elemento!). Estas funciones fueron diseñadas para robar una referencia debido a un idioma común para poblar una tupla o lista con objetos recién creados; por ejemplo, el código para crear la tupla @code{(1, 2, "tres")} podría verse así (olvidando el manejo de errores por el momento; una mejor manera de codificar esto se muestra a continuación):

@example
PyObject *t;

t = PyTuple_New(3);
PyTuple_SetItem(t, 0, PyLong_FromLong(1L));
PyTuple_SetItem(t, 1, PyLong_FromLong(2L));
PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));
@end example

Aquí @ref{1840,,PyLong_FromLong()} retorna una nueva referencia que es inmediatamente robada por @ref{4849,,PyTuple_SetItem()}. Cuando quiera seguir usando un objeto aunque se le robe la referencia, use @ref{612,,Py_INCREF()} para tomar otra referencia antes de llamar a la función de robo de referencias.

Por cierto, @ref{4849,,PyTuple_SetItem()} es la `única' forma de establecer elementos de tupla; @ref{1a5b,,PySequence_SetItem()} y @ref{48bf,,PyObject_SetItem()} se niegan a hacer esto ya que las tuplas son un tipo de datos inmutable. Solo debe usar @ref{4849,,PyTuple_SetItem()} para las tuplas que está creando usted mismo.

El código equivalente para llenar una lista se puede escribir usando @ref{48c0,,PyList_New()} y @ref{484a,,PyList_SetItem()}.

Sin embargo, en la práctica, rara vez utilizará estas formas de crear y completar una tupla o lista. Hay una función genérica, @ref{940,,Py_BuildValue()}, que puede crear los objetos más comunes a partir de valores C, dirigidos por un una cadena de caracteres de formato (`format string'). Por ejemplo, los dos bloques de código anteriores podrían reemplazarse por lo siguiente (que también se ocupa de la comprobación de errores):

@example
PyObject *tuple, *list;

tuple = Py_BuildValue("(iis)", 1, 2, "three");
list = Py_BuildValue("[iis]", 1, 2, "three");
@end example

It is much more common to use @ref{48bf,,PyObject_SetItem()} and friends with items
whose references you are only borrowing, like arguments that were passed in to
the function you are writing.  In that case, their behaviour regarding references
is much saner, since you don’t have to take a new reference just so you
can give that reference away («have it be stolen»).  For example, this function
sets all items of a list (actually, any mutable sequence) to a given item:

@example
int
set_all(PyObject *target, PyObject *item)
@{
    Py_ssize_t i, n;

    n = PyObject_Length(target);
    if (n < 0)
        return -1;
    for (i = 0; i < n; i++) @{
        PyObject *index = PyLong_FromSsize_t(i);
        if (!index)
            return -1;
        if (PyObject_SetItem(target, index, item) < 0) @{
            Py_DECREF(index);
            return -1;
        @}
        Py_DECREF(index);
    @}
    return 0;
@}
@end example

@geindex set_all()

La situación es ligeramente diferente para los valores de retorno de la función. Si bien pasar una referencia a la mayoría de las funciones no cambia sus responsabilidades de propiedad para esa referencia, muchas funciones que retornan una referencia a un objeto le otorgan la propiedad de la referencia. La razón es simple: en muchos casos, el objeto retornado se crea sobre la marcha, y la referencia que obtiene es la única referencia al objeto. Por lo tanto, las funciones genéricas que retornan referencias de objeto, como @ref{43b,,PyObject_GetItem()} y @ref{1a5a,,PySequence_GetItem()}, siempre retornan una nueva referencia (la entidad que llama se convierte en el propietario de la referencia).

Es importante darse cuenta de que si posee una referencia retornada por una función depende de a qué función llame únicamente — `el plumaje' (el tipo del objeto pasado como argumento a la función) `no entra en él!' Por lo tanto, si extrae un elemento de una lista usando @ref{450,,PyList_GetItem()}, no posee la referencia — pero si obtiene el mismo elemento de la misma lista usando @ref{1a5a,,PySequence_GetItem()} (que toma exactamente los mismos argumentos), usted posee una referencia al objeto retornado.

@geindex PyList_GetItem (C function)
@geindex PySequence_GetItem (C function)

Aquí hay un ejemplo de cómo podría escribir una función que calcule la suma de los elementos en una lista de enteros; una vez usando @ref{450,,PyList_GetItem()}, y una vez usando @ref{1a5a,,PySequence_GetItem()}.

@example
long
sum_list(PyObject *list)
@{
    Py_ssize_t i, n;
    long total = 0, value;
    PyObject *item;

    n = PyList_Size(list);
    if (n < 0)
        return -1; /* Not a list */
    for (i = 0; i < n; i++) @{
        item = PyList_GetItem(list, i); /* Can't fail */
        if (!PyLong_Check(item)) continue; /* Skip non-integers */
        value = PyLong_AsLong(item);
        if (value == -1 && PyErr_Occurred())
            /* Integer too big to fit in a C long, bail out */
            return -1;
        total += value;
    @}
    return total;
@}
@end example

@geindex sum_list()

@example
long
sum_sequence(PyObject *sequence)
@{
    Py_ssize_t i, n;
    long total = 0, value;
    PyObject *item;
    n = PySequence_Length(sequence);
    if (n < 0)
        return -1; /* Has no length */
    for (i = 0; i < n; i++) @{
        item = PySequence_GetItem(sequence, i);
        if (item == NULL)
            return -1; /* Not a sequence, or other failure */
        if (PyLong_Check(item)) @{
            value = PyLong_AsLong(item);
            Py_DECREF(item);
            if (value == -1 && PyErr_Occurred())
                /* Integer too big to fit in a C long, bail out */
                return -1;
            total += value;
        @}
        else @{
            Py_DECREF(item); /* Discard reference ownership */
        @}
    @}
    return total;
@}
@end example

@geindex sum_sequence()

@node Tipos,,Conteo de Referencias,Objetos tipos y conteos de referencias
@anchor{c-api/intro api-types}@anchor{48c1}@anchor{c-api/intro types}@anchor{48c2}
@subsubsection Tipos


There are few other data types that play a significant role in  the Python/C
API; most are simple C types such as int,  long,
double and char*.  A few structure types  are used to
describe static tables used to list the functions exported  by a module or the
data attributes of a new object type, and another is used to describe the value
of a complex number.  These will  be discussed together with the functions that
use them.

@geindex Py_ssize_t (C type)
@anchor{c-api/intro c Py_ssize_t}@anchor{af0}
@deffn {C Tipo} type Py_ssize_t
` Part of the @ref{5f6,,Stable ABI}.'
Un tipo integral con signo tal que @code{sizeof(Py_ssize_t) == sizeof(size_t)}. C99 no define directamente tal cosa (size_t es un tipo integral sin signo). Vea 
@geindex Python Enhancement Proposals; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} para más detalles. @code{PY_SSIZE_T_MAX} es el valor positivo más grande del tipo @ref{af0,,Py_ssize_t}.
@end deffn

@node Excepciones<20>,Integración de Python,Objetos tipos y conteos de referencias,Introducción<11>
@anchor{c-api/intro api-exceptions}@anchor{48c3}@anchor{c-api/intro exceptions}@anchor{48c4}
@subsection Excepciones


El programador de Python solo necesita lidiar con excepciones si se requiere un manejo específico de errores; las excepciones no manejadas se propagan automáticamente a la persona que llama, luego a la persona que llama, y así sucesivamente, hasta que llegan al intérprete de nivel superior, donde se informan al usuario acompañado de un seguimiento de pila (`stack traceback').

@geindex PyErr_Occurred (C function)

Para los programadores de C, sin embargo, la comprobación de errores siempre tiene que ser explícita. Todas las funciones en la API Python/C pueden generar excepciones, a menos que se señale explícitamente en la documentación de una función. En general, cuando una función encuentra un error, establece una excepción, descarta cualquier referencia de objeto que posea y retorna un indicador de error. Si no se documenta lo contrario, este indicador es @code{NULL} o @code{-1}, dependiendo del tipo de retorno de la función. Algunas funciones retornan un resultado booleano verdadero/falso, con falso que indica un error. Muy pocas funciones no retornan ningún indicador de error explícito o tienen un valor de retorno ambiguo, y requieren pruebas explícitas de errores con @ref{18fa,,PyErr_Occurred()}. Estas excepciones siempre se documentan explícitamente.

@geindex PyErr_SetString (C function)
@geindex PyErr_Clear (C function)

El estado de excepción se mantiene en el almacenamiento por subproceso (esto es equivalente a usar el almacenamiento global en una aplicación sin subprocesos). Un subproceso puede estar en uno de dos estados: se ha producido una excepción o no. La función @ref{18fa,,PyErr_Occurred()} puede usarse para verificar esto: retorna una referencia prestada al objeto de tipo de excepción cuando se produce una excepción, y @code{NULL} de lo contrario. Hay una serie de funciones para establecer el estado de excepción: @ref{620,,PyErr_SetString()} es la función más común (aunque no la más general) para establecer el estado de excepción, y @ref{10ad,,PyErr_Clear()} borra la excepción estado.

El estado de excepción completo consta de tres objetos (todos los cuales pueden ser @code{NULL}): el tipo de excepción, el valor de excepción correspondiente y el rastreo. Estos tienen los mismos significados que el resultado de Python de @code{sys.exc_info()}; sin embargo, no son lo mismo: los objetos Python representan la última excepción manejada por una declaración de Python @ref{789,,try} … @ref{2f6,,except}, mientras que el estado de excepción de nivel C solo existe mientras se está pasando una excepción entre las funciones de C hasta que llega al bucle principal del intérprete de código de bytes (`bytecode') de Python, que se encarga de transferirlo a @code{sys.exc_info()} y amigos.

@geindex exc_info (in module sys)

Tenga en cuenta que a partir de Python 1.5, la forma preferida y segura de subprocesos para acceder al estado de excepción desde el código de Python es llamar a la función @ref{72b,,sys.exc_info()}, que retorna el estado de excepción por subproceso para el código de Python. Además, la semántica de ambas formas de acceder al estado de excepción ha cambiado de modo que una función que detecta una excepción guardará y restaurará el estado de excepción de su hilo para preservar el estado de excepción de su llamador. Esto evita errores comunes en el código de manejo de excepciones causado por una función de aspecto inocente que sobrescribe la excepción que se maneja; También reduce la extensión de vida útil a menudo no deseada para los objetos a los que hacen referencia los marcos de pila en el rastreo.

Como principio general, una función que llama a otra función para realizar alguna tarea debe verificar si la función llamada generó una excepción y, de ser así, pasar el estado de excepción a quien la llama (`caller'). Debe descartar cualquier referencia de objeto que posea y retornar un indicador de error, pero `no' debe establecer otra excepción — que sobrescribirá la excepción que se acaba de generar y perderá información importante sobre la causa exacta del error.

@geindex sum_sequence()

A simple example of detecting exceptions and passing them on is shown in the
@code{sum_sequence()} example above.  It so happens that this example doesn’t
need to clean up any owned references when it detects an error.  The following
example function shows some error cleanup.  First, to remind you why you like
Python, we show the equivalent Python code:

@example
def incr_item(dict, key):
    try:
        item = dict[key]
    except KeyError:
        item = 0
    dict[key] = item + 1
@end example

@geindex incr_item()

Aquí está el código C correspondiente, en todo su esplendor:

@example
int
incr_item(PyObject *dict, PyObject *key)
@{
    /* Objects all initialized to NULL for Py_XDECREF */
    PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
    int rv = -1; /* Return value initialized to -1 (failure) */

    item = PyObject_GetItem(dict, key);
    if (item == NULL) @{
        /* Handle KeyError only: */
        if (!PyErr_ExceptionMatches(PyExc_KeyError))
            goto error;

        /* Clear the error and use zero: */
        PyErr_Clear();
        item = PyLong_FromLong(0L);
        if (item == NULL)
            goto error;
    @}
    const_one = PyLong_FromLong(1L);
    if (const_one == NULL)
        goto error;

    incremented_item = PyNumber_Add(item, const_one);
    if (incremented_item == NULL)
        goto error;

    if (PyObject_SetItem(dict, key, incremented_item) < 0)
        goto error;
    rv = 0; /* Success */
    /* Continue with cleanup code */

 error:
    /* Cleanup code, shared by success and failure path */

    /* Use Py_XDECREF() to ignore NULL references */
    Py_XDECREF(item);
    Py_XDECREF(const_one);
    Py_XDECREF(incremented_item);

    return rv; /* -1 for error, 0 for success */
@}
@end example

@geindex incr_item()

@geindex PyErr_ExceptionMatches (C function)
@geindex PyErr_Clear (C function)
@geindex Py_XDECREF (C function)

Este ejemplo representa un uso aprobado de la declaración @code{goto} en C! Ilustra el uso de @ref{48c5,,PyErr_ExceptionMatches()} y @ref{10ad,,PyErr_Clear()} para manejar excepciones específicas, y el uso de @ref{828,,Py_XDECREF()} para eliminar referencias propias que pueden ser @code{NULL} (tenga en cuenta la @code{'X'}” en el nombre; @ref{613,,Py_DECREF()} se bloqueará cuando se enfrente con una referencia @code{NULL}). Es importante que las variables utilizadas para contener referencias propias se inicialicen en @code{NULL} para que esto funcione; Del mismo modo, el valor de retorno propuesto se inicializa a @code{-1} (falla) y solo se establece en éxito después de que la última llamada realizada sea exitosa.

@node Integración de Python,Depuración de compilaciones,Excepciones<20>,Introducción<11>
@anchor{c-api/intro api-embedding}@anchor{48c6}@anchor{c-api/intro embedding-python}@anchor{48c7}
@subsection Integración de Python


La única tarea importante de la que solo tienen que preocuparse los integradores (a diferencia de los escritores de extensión) del intérprete de Python es la inicialización, y posiblemente la finalización, del intérprete de Python. La mayor parte de la funcionalidad del intérprete solo se puede usar después de que el intérprete se haya inicializado.

@geindex Py_Initialize (C function)
@geindex module;builtins
@geindex module;__main__
@geindex module;sys
@geindex module;search;path
@geindex path (in module sys)

La función básica de inicialización es @ref{247,,Py_Initialize()}. Esto inicializa la tabla de módulos cargados y crea los módulos fundamentales @ref{13,,builtins}, @ref{1,,__main__}, y @ref{d9,,sys}. También inicializa la ruta de búsqueda del módulo (@code{sys.path}).

@ref{247,,Py_Initialize()} no establece la «lista de argumentos de script» (@code{sys.argv}). Si esta variable es necesaria por el código Python que se ejecutará más tarde, debe establecerse @ref{4a4,,PyConfig.argv} y @ref{1932,,PyConfig.parse_argv}: consulte @ref{49a,,Python Initialization Configuration}.

En la mayoría de los sistemas (en particular, en Unix y Windows, aunque los detalles son ligeramente diferentes), @ref{247,,Py_Initialize()} calcula la ruta de búsqueda del módulo basándose en su mejor estimación de la ubicación del ejecutable del intérprete de Python estándar, suponiendo que la biblioteca de Python se encuentra en una ubicación fija en relación con el ejecutable del intérprete de Python. En particular, busca un directorio llamado @code{lib/python`X.Y'} relativo al directorio padre donde se encuentra el ejecutable llamado @code{python} en la ruta de búsqueda del comando `shell' (la variable de entorno 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}).

Por ejemplo, si el ejecutable de Python se encuentra en @code{/usr/local/bin/python}, se supondrá que las bibliotecas están en @code{/usr/local/lib/python`X.Y'}. (De hecho, esta ruta particular también es la ubicación «alternativa», utilizada cuando no se encuentra un archivo ejecutable llamado @code{python} junto con 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH}.) El usuario puede anular este comportamiento configurando la variable de entorno 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}, o inserte directorios adicionales delante de la ruta estándar estableciendo 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}.

@geindex Py_GetPath (C function)
@geindex Py_GetPrefix (C function)
@geindex Py_GetExecPrefix (C function)
@geindex Py_GetProgramFullPath (C function)

The embedding application can steer the search by setting
@ref{4a5,,PyConfig.program_name} `before' calling
@ref{4a6,,Py_InitializeFromConfig()}. Note that
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} still overrides this and 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} is still
inserted in front of the standard path.  An application that requires total
control has to provide its own implementation of @ref{27d,,Py_GetPath()},
@ref{27f,,Py_GetPrefix()}, @ref{27a,,Py_GetExecPrefix()}, and
@ref{282,,Py_GetProgramFullPath()} (all defined in @code{Modules/getpath.c}).

@geindex Py_IsInitialized (C function)

A veces, es deseable «no inicializar» Python. Por ejemplo, la aplicación puede querer comenzar de nuevo (hacer otra llamada a @ref{247,,Py_Initialize()}) o la aplicación simplemente se hace con el uso de Python y quiere liberar memoria asignada por Python. Esto se puede lograr llamando a @ref{d9c,,Py_FinalizeEx()}. La función @ref{48c8,,Py_IsInitialized()} retorna verdadero si Python se encuentra actualmente en el estado inicializado. Se proporciona más información sobre estas funciones en un capítulo posterior. Tenga en cuenta que @ref{d9c,,Py_FinalizeEx()} `no' libera toda la memoria asignada por el intérprete de Python, por ejemplo, la memoria asignada por los módulos de extensión actualmente no se puede liberar.

@node Depuración de compilaciones,,Integración de Python,Introducción<11>
@anchor{c-api/intro api-debugging}@anchor{48c9}@anchor{c-api/intro debugging-builds}@anchor{48ca}
@subsection Depuración de compilaciones


Python se puede construir con varios macros para permitir verificaciones adicionales del intérprete y los módulos de extensión. Estas comprobaciones tienden a agregar una gran cantidad de sobrecarga al tiempo de ejecución, por lo que no están habilitadas de forma predeterminada.

A full list of the various types of debugging builds is in the file
@code{Misc/SpecialBuilds.txt} in the Python source distribution. Builds are
available that support tracing of reference counts, debugging the memory
allocator, or low-level profiling of the main interpreter loop.  Only the most
frequently used builds will be described in the remainder of this section.

@geindex Py_DEBUG (C macro)
@anchor{c-api/intro c Py_DEBUG}@anchor{4060}
@deffn {C Macro} Py_DEBUG
@end deffn

Compiling the interpreter with the @code{Py_DEBUG} macro defined produces
what is generally meant by @ref{357,,a debug build of Python}.
@code{Py_DEBUG} is enabled in the Unix build by adding
@ref{4e0,,--with-pydebug} to the @code{./configure} command.
It is also implied by the presence of the
not-Python-specific @code{_DEBUG} macro.  When @code{Py_DEBUG} is enabled
in the Unix build, compiler optimization is disabled.

Además de la depuración del recuento de referencia que se describe a continuación, se realizan verificaciones adicionales, véase @ref{357,,compilaciones de depuración}.

Definiendo @code{Py_TRACE_REFS} habilita el rastreo de referencias (véase la opción @ref{487,,configure --with-trace-refs}). Cuando se define, se mantiene una lista circular doblemente vinculada de objetos activos al agregar dos campos adicionales a cada @ref{42d,,PyObject}. También se realiza un seguimiento de las asignaciones totales. Al salir, se imprimen todas las referencias existentes. (En modo interactivo, esto sucede después de cada declaración ejecutada por el intérprete).

Consulte @code{Misc/SpecialBuilds.txt} en la distribución fuente de Python para obtener información más detallada.

@node Estabilidad de la API en C,La capa de muy alto nivel,Introducción<11>,Manual de referencia de la API en C de Python
@anchor{c-api/stable doc}@anchor{48cb}@anchor{c-api/stable c-api-stability}@anchor{48cc}@anchor{c-api/stable stable}@anchor{5f6}
@section Estabilidad de la API en C


Unless documented otherwise, Python’s C API is covered by the Backwards
Compatibility Policy, 
@geindex Python Enhancement Proposals; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}.
Most changes to it are source-compatible (typically by only adding new API).
Changing existing API or removing API is only done after a deprecation period
or to fix serious issues.

CPython’s Application Binary Interface (ABI) is forward- and
backwards-compatible across a minor release (if these are compiled the same
way; see @ref{48cd,,Consideraciones de la plataforma} below).
So, code compiled for Python 3.10.0 will work on 3.10.8 and vice versa,
but will need to be compiled separately for 3.9.x and 3.11.x.

There are two tiers of C API with different stability expectations:


@itemize -

@item 
@ref{5ea,,Unstable API}, may change in minor versions without
a deprecation period. It is marked by the @code{PyUnstable} prefix in names.

@item 
@ref{488,,Limited API}, is compatible across several minor releases.
When @ref{4dc,,Py_LIMITED_API} is defined, only this subset is exposed
from @code{Python.h}.
@end itemize

These are discussed in more detail below.

Names prefixed by an underscore, such as @code{_Py_InternalState},
are private API that can change without notice even in patch releases.
If you need to use this API, consider reaching out to
CPython developers@footnote{https://discuss.python.org/c/core-dev/c-api/30}
to discuss adding public API for your use case.

@menu
* Unstable C API:: 
* Interfaz binaria de aplicación estable:: 
* Consideraciones de la plataforma:: 
* Contenido de la API limitada:: 

@end menu

@node Unstable C API,Interfaz binaria de aplicación estable,,Estabilidad de la API en C
@anchor{c-api/stable id1}@anchor{48ce}@anchor{c-api/stable unstable-c-api}@anchor{5ea}
@subsection Unstable C API


@geindex PyUnstable

Any API named with the @code{PyUnstable} prefix exposes CPython implementation
details, and may change in every minor release (e.g. from 3.9 to 3.10) without
any deprecation warnings.
However, it will not change in a bugfix release (e.g. from 3.10.0 to 3.10.1).

It is generally intended for specialized, low-level tools like debuggers.

Projects that use this API are expected to follow
CPython development and spend extra effort adjusting to changes.

@node Interfaz binaria de aplicación estable,Consideraciones de la plataforma,Unstable C API,Estabilidad de la API en C
@anchor{c-api/stable stable-application-binary-interface}@anchor{48cf}
@subsection Interfaz binaria de aplicación estable


For simplicity, this document talks about `extensions', but the Limited API
and Stable ABI work the same way for all uses of the API – for example,
embedding Python.

@menu
* Limited C API:: 
* Stable ABI:: 
* Alcance y rendimiento de la API limitada:: 
* Advertencias de la API limitada:: 

@end menu

@node Limited C API,Stable ABI,,Interfaz binaria de aplicación estable
@anchor{c-api/stable id2}@anchor{48d0}@anchor{c-api/stable limited-c-api}@anchor{488}
@subsubsection Limited C API


Python 3.2 introduced the `Limited API', a subset of Python’s C API.
Extensions that only use the Limited API can be
compiled once and work with multiple versions of Python.
Contents of the Limited API are @ref{833,,listed below}.

@geindex Py_LIMITED_API (C macro)
@anchor{c-api/stable c Py_LIMITED_API}@anchor{4dc}
@deffn {C Macro} Py_LIMITED_API

Se define esta macro antes de incluir @code{Python.h} para optar por usar sólo la API limitada y para seleccionar la versión de la API limitada.

Define @code{Py_LIMITED_API} to the value of @ref{7f1,,PY_VERSION_HEX}
corresponding to the lowest Python version your extension supports.
The extension will work without recompilation with all Python 3 releases
from the specified one onward, and can use Limited API introduced up to that
version.

En lugar de utilizar directamente la macro @code{PY_VERSION_HEX}, se codifica una versión menor mínima (por ejemplo, @code{0x030A0000} para Python 3.10) para tener estabilidad cuando se compila con futuras versiones de Python.

También se puede definir @code{Py_LIMITED_API} con @code{3}. Esto funciona igual que @code{0x03020000} (Python 3.2, la función que introdujo la API limitada).
@end deffn

@node Stable ABI,Alcance y rendimiento de la API limitada,Limited C API,Interfaz binaria de aplicación estable
@anchor{c-api/stable id3}@anchor{48d1}@anchor{c-api/stable stable-abi}@anchor{48d2}
@subsubsection Stable ABI


To enable this, Python provides a `Stable ABI': a set of symbols that will
remain compatible across Python 3.x versions.

The Stable ABI contains symbols exposed in the @ref{488,,Limited API}, but also other ones – for example, functions necessary to
support older versions of the Limited API.

En Windows, las extensiones que usan la ABI estable deben estar vinculadas con @code{python3.dll} en lugar de una biblioteca específica de la versión como @code{python39.dll}.

En algunas plataformas, Python buscará y cargará archivos de bibliotecas compartidas con el nombre de la etiqueta @code{abi3} (por ejemplo, @code{mymodule.abi3.so}). No comprueba si tales extensiones se ajustan a una ABI estable. El usuario (o sus herramientas de empaquetado) necesitan asegurarse que, por ejemplo, las extensiones que se crean con la API limitada 3.10+ no estén instaladas para versiones inferiores de Python.

Todas las funciones de la ABI estable se presentan como funciones en la biblioteca compartida de Python, no sólo como macros. Esto las hace utilizables desde lenguajes que no usan el preprocesador de C.

@node Alcance y rendimiento de la API limitada,Advertencias de la API limitada,Stable ABI,Interfaz binaria de aplicación estable
@anchor{c-api/stable limited-api-scope-and-performance}@anchor{48d3}
@subsubsection Alcance y rendimiento de la API limitada


El objetivo de la API limitada es permitir todo lo que es posible con la API completa en C, pero posiblemente con una penalización de rendimiento.

Por ejemplo, mientras @ref{450,,PyList_GetItem()} está disponible, su variante macro “insegura” @ref{48d4,,PyList_GET_ITEM()} no lo está. La macro puede ser más rápida porque puede confiar en los detalles de implementación específicos de la versión del objeto de lista.

Sin definirse @code{Py_LIMITED_API}, algunas funciones de la API en C están integradas o reemplazadas por macros. Definir @code{Py_LIMITED_API} desactiva esta integración, permitiendo estabilidad mientras que se mejoren las estructuras de datos de Python, pero posiblemente reduzca el rendimiento.

Al dejar fuera la definición de @code{Py_LIMITED_API}, es posible compilar una extensión de la API limitada con una ABI específica de la versión. Esto puede mejorar el rendimiento para esa versión de Python, pero limitará la compatibilidad. Compilar con @code{Py_LIMITED_API} producirá una extensión que se puede distribuir donde una versión específica no esté disponible - por ejemplo, para los prelanzamientos de una versión próxima de Python.

@node Advertencias de la API limitada,,Alcance y rendimiento de la API limitada,Interfaz binaria de aplicación estable
@anchor{c-api/stable limited-api-caveats}@anchor{48d5}
@subsubsection Advertencias de la API limitada


Note that compiling with @code{Py_LIMITED_API} is `not' a complete guarantee that
code conforms to the @ref{488,,Limited API} or the @ref{48d2,,Stable ABI}. @code{Py_LIMITED_API} only covers definitions, but an API also
includes other issues, such as expected semantics.

Un problema contra el que @code{Py_LIMITED_API} no protege es llamar una función con argumentos que son inválidos en una versión inferior de Python. Por ejemplo, se considera una función que empieza a aceptar @code{NULL} como un argumento. Ahora en Python 3.9, @code{NULL} selecciona un comportamiento predeterminado, pero en Python 3.8, el argumento se usará directamente, causando una desreferencia @code{NULL} y se detendrá. Un argumento similar funciona para campos de estructuras.

Otro problema es que algunos campos de estructura no se ocultan actualmente cuando se define @code{Py_LIMITED_API}, aunque son parte de la API limitada.

Por estas razones, recomendamos probar una extensión con `todas' las versiones menores de Python que soporte, y preferiblemente compilar con la versión `más baja'.

También recomendamos revisar la documentación de todas las API usadas para verificar si es parte explícitamente de la API limitada. Aunque se defina @code{Py_LIMITED_API}, algunas declaraciones privadas se exponen por razones técnicas (o incluso involuntariamente, como errores).

También tome en cuenta que la API limitada no necesariamente es estable: compilar con @code{Py_LIMITED_API} con Python 3.8 significa que la extensión se ejecutará con Python 3.12, pero no necesariamente `compilará' con Python 3.12. En particular, las partes de la API limitada se pueden quedar obsoletas y eliminarse, siempre que la ABI estable permanezca estable.

@node Consideraciones de la plataforma,Contenido de la API limitada,Interfaz binaria de aplicación estable,Estabilidad de la API en C
@anchor{c-api/stable platform-considerations}@anchor{48d6}@anchor{c-api/stable stable-abi-platform}@anchor{48cd}
@subsection Consideraciones de la plataforma


ABI stability depends not only on Python, but also on the compiler used,
lower-level libraries and compiler options. For the purposes of
the @ref{48d2,,Stable ABI}, these details define a “platform”. They
usually depend on the OS type and processor architecture

Es la responsabilidad de cada distribuidor particular de Python de asegurarse de que todas las versiones de Python en una plataforma particular se compilen de una forma que no rompa la ABI estable. Este es el caso de las versiones de Windows y macOS de @code{python.org} y muchos distribuidores de terceros.

@node Contenido de la API limitada,,Consideraciones de la plataforma,Estabilidad de la API en C
@anchor{c-api/stable contents-of-limited-api}@anchor{48d7}@anchor{c-api/stable limited-api-list}@anchor{833}
@subsection Contenido de la API limitada


Currently, the @ref{488,,Limited API} includes the following items:



@itemize *

@item 
@ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET}

@item 
@ref{48d8,,PyAIter_Check()}

@item 
@ref{19ed,,PyArg_Parse()}

@item 
@ref{615,,PyArg_ParseTuple()}

@item 
@ref{475,,PyArg_ParseTupleAndKeywords()}

@item 
@ref{1548,,PyArg_UnpackTuple()}

@item 
@ref{48d9,,PyArg_VaParse()}

@item 
@ref{476,,PyArg_VaParseTupleAndKeywords()}

@item 
@ref{48da,,PyArg_ValidateKeywordArguments()}

@item 
@code{PyBaseObject_Type}

@item 
@ref{48db,,PyBool_FromLong()}

@item 
@ref{48dc,,PyBool_Type}

@item 
@ref{7f9,,PyBuffer_FillContiguousStrides()}

@item 
@ref{7fa,,PyBuffer_FillInfo()}

@item 
@ref{7f6,,PyBuffer_FromContiguous()}

@item 
@ref{7f3,,PyBuffer_GetPointer()}

@item 
@ref{7f8,,PyBuffer_IsContiguous()}

@item 
@ref{48d,,PyBuffer_Release()}

@item 
@ref{7f4,,PyBuffer_SizeFromFormat()}

@item 
@ref{7f5,,PyBuffer_ToContiguous()}

@item 
@code{PyByteArrayIter_Type}

@item 
@ref{48dd,,PyByteArray_AsString()}

@item 
@ref{48de,,PyByteArray_Concat()}

@item 
@ref{13f6,,PyByteArray_FromObject()}

@item 
@ref{13f7,,PyByteArray_FromStringAndSize()}

@item 
@ref{48df,,PyByteArray_Resize()}

@item 
@ref{48e0,,PyByteArray_Size()}

@item 
@ref{48e1,,PyByteArray_Type}

@item 
@code{PyBytesIter_Type}

@item 
@ref{91f,,PyBytes_AsString()}

@item 
@ref{48e2,,PyBytes_AsStringAndSize()}

@item 
@ref{48e3,,PyBytes_Concat()}

@item 
@ref{48e4,,PyBytes_ConcatAndDel()}

@item 
@code{PyBytes_DecodeEscape()}

@item 
@ref{1a30,,PyBytes_FromFormat()}

@item 
@ref{48e5,,PyBytes_FromFormatV()}

@item 
@ref{48e6,,PyBytes_FromObject()}

@item 
@ref{48e7,,PyBytes_FromString()}

@item 
@ref{13f5,,PyBytes_FromStringAndSize()}

@item 
@code{PyBytes_Repr()}

@item 
@ref{48e8,,PyBytes_Size()}

@item 
@ref{48e9,,PyBytes_Type}

@item 
@ref{14b3,,PyCFunction}

@item 
@ref{48ea,,PyCFunctionFast}

@item 
@ref{48eb,,PyCFunctionFastWithKeywords}

@item 
@ref{48ec,,PyCFunctionWithKeywords}

@item 
@code{PyCFunction_GetFlags()}

@item 
@code{PyCFunction_GetFunction()}

@item 
@code{PyCFunction_GetSelf()}

@item 
@ref{18fc,,PyCFunction_New()}

@item 
@ref{1996,,PyCFunction_NewEx()}

@item 
@code{PyCFunction_Type}

@item 
@ref{18f6,,PyCMethod_New()}

@item 
@ref{48ed,,PyCallIter_New()}

@item 
@ref{48ee,,PyCallIter_Type}

@item 
@ref{48ef,,PyCallable_Check()}

@item 
@ref{48f0,,PyCapsule_Destructor}

@item 
@ref{48f1,,PyCapsule_GetContext()}

@item 
@ref{48f2,,PyCapsule_GetDestructor()}

@item 
@ref{48f3,,PyCapsule_GetName()}

@item 
@ref{48f4,,PyCapsule_GetPointer()}

@item 
@ref{1875,,PyCapsule_Import()}

@item 
@ref{13bc,,PyCapsule_IsValid()}

@item 
@ref{4854,,PyCapsule_New()}

@item 
@ref{48f5,,PyCapsule_SetContext()}

@item 
@ref{48f6,,PyCapsule_SetDestructor()}

@item 
@ref{48f7,,PyCapsule_SetName()}

@item 
@ref{48f8,,PyCapsule_SetPointer()}

@item 
@code{PyCapsule_Type}

@item 
@code{PyClassMethodDescr_Type}

@item 
@ref{48f9,,PyCodec_BackslashReplaceErrors()}

@item 
@ref{296,,PyCodec_Decode()}

@item 
@ref{48fa,,PyCodec_Decoder()}

@item 
@ref{297,,PyCodec_Encode()}

@item 
@ref{48fb,,PyCodec_Encoder()}

@item 
@ref{48fc,,PyCodec_IgnoreErrors()}

@item 
@ref{48fd,,PyCodec_IncrementalDecoder()}

@item 
@ref{48fe,,PyCodec_IncrementalEncoder()}

@item 
@ref{48ff,,PyCodec_KnownEncoding()}

@item 
@ref{4900,,PyCodec_LookupError()}

@item 
@ref{f30,,PyCodec_NameReplaceErrors()}

@item 
@ref{4901,,PyCodec_Register()}

@item 
@ref{4902,,PyCodec_RegisterError()}

@item 
@ref{4903,,PyCodec_ReplaceErrors()}

@item 
@ref{4904,,PyCodec_StreamReader()}

@item 
@ref{4905,,PyCodec_StreamWriter()}

@item 
@ref{4906,,PyCodec_StrictErrors()}

@item 
@ref{92f,,PyCodec_Unregister()}

@item 
@ref{4907,,PyCodec_XMLCharRefReplaceErrors()}

@item 
@ref{4908,,PyComplex_FromDoubles()}

@item 
@ref{16a2,,PyComplex_ImagAsDouble()}

@item 
@ref{16a1,,PyComplex_RealAsDouble()}

@item 
@ref{4909,,PyComplex_Type}

@item 
@ref{490a,,PyDescr_NewClassMethod()}

@item 
@ref{490b,,PyDescr_NewGetSet()}

@item 
@ref{490c,,PyDescr_NewMember()}

@item 
@ref{1995,,PyDescr_NewMethod()}

@item 
@code{PyDictItems_Type}

@item 
@code{PyDictIterItem_Type}

@item 
@code{PyDictIterKey_Type}

@item 
@code{PyDictIterValue_Type}

@item 
@code{PyDictKeys_Type}

@item 
@ref{490d,,PyDictProxy_New()}

@item 
@code{PyDictProxy_Type}

@item 
@code{PyDictRevIterItem_Type}

@item 
@code{PyDictRevIterKey_Type}

@item 
@code{PyDictRevIterValue_Type}

@item 
@code{PyDictValues_Type}

@item 
@ref{490e,,PyDict_Clear()}

@item 
@ref{42c,,PyDict_Contains()}

@item 
@ref{4de,,PyDict_Copy()}

@item 
@ref{490f,,PyDict_DelItem()}

@item 
@ref{4910,,PyDict_DelItemString()}

@item 
@ref{479,,PyDict_GetItem()}

@item 
@ref{42e,,PyDict_GetItemRef()}

@item 
@ref{47a,,PyDict_GetItemString()}

@item 
@ref{42f,,PyDict_GetItemStringRef()}

@item 
@ref{430,,PyDict_GetItemWithError()}

@item 
@ref{4911,,PyDict_Items()}

@item 
@ref{4912,,PyDict_Keys()}

@item 
@ref{4913,,PyDict_Merge()}

@item 
@ref{4914,,PyDict_MergeFromSeq2()}

@item 
@ref{4915,,PyDict_New()}

@item 
@ref{1626,,PyDict_Next()}

@item 
@ref{484b,,PyDict_SetItem()}

@item 
@ref{1623,,PyDict_SetItemString()}

@item 
@ref{4916,,PyDict_Size()}

@item 
@ref{4917,,PyDict_Type}

@item 
@ref{4918,,PyDict_Update()}

@item 
@ref{4919,,PyDict_Values()}

@item 
@code{PyEllipsis_Type}

@item 
@code{PyEnum_Type}

@item 
@ref{491a,,PyErr_BadArgument()}

@item 
@ref{491b,,PyErr_BadInternalCall()}

@item 
@ref{512,,PyErr_CheckSignals()}

@item 
@ref{10ad,,PyErr_Clear()}

@item 
@code{PyErr_Display()}

@item 
@ref{299,,PyErr_DisplayException()}

@item 
@ref{48c5,,PyErr_ExceptionMatches()}

@item 
@ref{28a,,PyErr_Fetch()}

@item 
@ref{f32,,PyErr_Format()}

@item 
@ref{f31,,PyErr_FormatV()}

@item 
@ref{80c,,PyErr_GetExcInfo()}

@item 
@ref{809,,PyErr_GetHandledException()}

@item 
@ref{28b,,PyErr_GetRaisedException()}

@item 
@ref{491c,,PyErr_GivenExceptionMatches()}

@item 
@ref{12d7,,PyErr_NewException()}

@item 
@ref{12d6,,PyErr_NewExceptionWithDoc()}

@item 
@ref{482e,,PyErr_NoMemory()}

@item 
@ref{28c,,PyErr_NormalizeException()}

@item 
@ref{18fa,,PyErr_Occurred()}

@item 
@ref{194f,,PyErr_Print()}

@item 
@ref{491d,,PyErr_PrintEx()}

@item 
@code{PyErr_ProgramText()}

@item 
@ref{d9e,,PyErr_ResourceWarning()}

@item 
@ref{28d,,PyErr_Restore()}

@item 
@ref{491e,,PyErr_SetExcFromWindowsErr()}

@item 
@ref{171e,,PyErr_SetExcFromWindowsErrWithFilename()}

@item 
@ref{491f,,PyErr_SetExcFromWindowsErrWithFilenameObject()}

@item 
@ref{4920,,PyErr_SetExcFromWindowsErrWithFilenameObjects()}

@item 
@ref{80b,,PyErr_SetExcInfo()}

@item 
@ref{482d,,PyErr_SetFromErrno()}

@item 
@ref{171d,,PyErr_SetFromErrnoWithFilename()}

@item 
@ref{4921,,PyErr_SetFromErrnoWithFilenameObject()}

@item 
@ref{4922,,PyErr_SetFromErrnoWithFilenameObjects()}

@item 
@ref{4923,,PyErr_SetFromWindowsErr()}

@item 
@ref{171f,,PyErr_SetFromWindowsErrWithFilename()}

@item 
@ref{80a,,PyErr_SetHandledException()}

@item 
@ref{dc5,,PyErr_SetImportError()}

@item 
@ref{d9d,,PyErr_SetImportErrorSubclass()}

@item 
@ref{4924,,PyErr_SetInterrupt()}

@item 
@ref{936,,PyErr_SetInterruptEx()}

@item 
@ref{4925,,PyErr_SetNone()}

@item 
@ref{61f,,PyErr_SetObject()}

@item 
@ref{28e,,PyErr_SetRaisedException()}

@item 
@ref{620,,PyErr_SetString()}

@item 
@ref{4926,,PyErr_SyntaxLocation()}

@item 
@ref{4927,,PyErr_SyntaxLocationEx()}

@item 
@ref{148a,,PyErr_WarnEx()}

@item 
@ref{1726,,PyErr_WarnExplicit()}

@item 
@ref{4928,,PyErr_WarnFormat()}

@item 
@ref{443,,PyErr_WriteUnraisable()}

@item 
@ref{49d,,PyEval_AcquireThread()}

@item 
@ref{91e,,PyEval_EvalCode()}

@item 
@ref{1771,,PyEval_EvalCodeEx()}

@item 
@ref{4929,,PyEval_EvalFrame()}

@item 
@ref{10aa,,PyEval_EvalFrameEx()}

@item 
@ref{445,,PyEval_GetBuiltins()}

@item 
@ref{17c4,,PyEval_GetFrame()}

@item 
@ref{444,,PyEval_GetFrameBuiltins()}

@item 
@ref{446,,PyEval_GetFrameGlobals()}

@item 
@ref{448,,PyEval_GetFrameLocals()}

@item 
@ref{492a,,PyEval_GetFuncDesc()}

@item 
@ref{492b,,PyEval_GetFuncName()}

@item 
@ref{447,,PyEval_GetGlobals()}

@item 
@ref{449,,PyEval_GetLocals()}

@item 
@ref{164d,,PyEval_InitThreads()}

@item 
@ref{492c,,PyEval_ReleaseThread()}

@item 
@ref{49c,,PyEval_RestoreThread()}

@item 
@ref{49b,,PyEval_SaveThread()}

@item 
@code{PyExc_ArithmeticError}

@item 
@code{PyExc_AssertionError}

@item 
@code{PyExc_AttributeError}

@item 
@code{PyExc_BaseException}

@item 
@code{PyExc_BaseExceptionGroup}

@item 
@code{PyExc_BlockingIOError}

@item 
@code{PyExc_BrokenPipeError}

@item 
@code{PyExc_BufferError}

@item 
@code{PyExc_BytesWarning}

@item 
@code{PyExc_ChildProcessError}

@item 
@code{PyExc_ConnectionAbortedError}

@item 
@code{PyExc_ConnectionError}

@item 
@code{PyExc_ConnectionRefusedError}

@item 
@code{PyExc_ConnectionResetError}

@item 
@code{PyExc_DeprecationWarning}

@item 
@code{PyExc_EOFError}

@item 
@code{PyExc_EncodingWarning}

@item 
@code{PyExc_EnvironmentError}

@item 
@code{PyExc_Exception}

@item 
@code{PyExc_FileExistsError}

@item 
@code{PyExc_FileNotFoundError}

@item 
@code{PyExc_FloatingPointError}

@item 
@code{PyExc_FutureWarning}

@item 
@code{PyExc_GeneratorExit}

@item 
@code{PyExc_IOError}

@item 
@code{PyExc_ImportError}

@item 
@code{PyExc_ImportWarning}

@item 
@code{PyExc_IndentationError}

@item 
@code{PyExc_IndexError}

@item 
@code{PyExc_InterruptedError}

@item 
@code{PyExc_IsADirectoryError}

@item 
@code{PyExc_KeyError}

@item 
@code{PyExc_KeyboardInterrupt}

@item 
@code{PyExc_LookupError}

@item 
@code{PyExc_MemoryError}

@item 
@code{PyExc_ModuleNotFoundError}

@item 
@code{PyExc_NameError}

@item 
@code{PyExc_NotADirectoryError}

@item 
@code{PyExc_NotImplementedError}

@item 
@code{PyExc_OSError}

@item 
@code{PyExc_OverflowError}

@item 
@code{PyExc_PendingDeprecationWarning}

@item 
@code{PyExc_PermissionError}

@item 
@code{PyExc_ProcessLookupError}

@item 
@code{PyExc_RecursionError}

@item 
@code{PyExc_ReferenceError}

@item 
@code{PyExc_ResourceWarning}

@item 
@code{PyExc_RuntimeError}

@item 
@code{PyExc_RuntimeWarning}

@item 
@code{PyExc_StopAsyncIteration}

@item 
@code{PyExc_StopIteration}

@item 
@code{PyExc_SyntaxError}

@item 
@code{PyExc_SyntaxWarning}

@item 
@code{PyExc_SystemError}

@item 
@code{PyExc_SystemExit}

@item 
@code{PyExc_TabError}

@item 
@code{PyExc_TimeoutError}

@item 
@code{PyExc_TypeError}

@item 
@code{PyExc_UnboundLocalError}

@item 
@code{PyExc_UnicodeDecodeError}

@item 
@code{PyExc_UnicodeEncodeError}

@item 
@code{PyExc_UnicodeError}

@item 
@code{PyExc_UnicodeTranslateError}

@item 
@code{PyExc_UnicodeWarning}

@item 
@code{PyExc_UserWarning}

@item 
@code{PyExc_ValueError}

@item 
@code{PyExc_Warning}

@item 
@code{PyExc_WindowsError}

@item 
@code{PyExc_ZeroDivisionError}

@item 
@code{PyExceptionClass_Name()}

@item 
@ref{60e,,PyException_GetArgs()}

@item 
@ref{492d,,PyException_GetCause()}

@item 
@ref{492e,,PyException_GetContext()}

@item 
@ref{492f,,PyException_GetTraceback()}

@item 
@ref{60f,,PyException_SetArgs()}

@item 
@ref{4930,,PyException_SetCause()}

@item 
@ref{4931,,PyException_SetContext()}

@item 
@ref{19f3,,PyException_SetTraceback()}

@item 
@ref{4932,,PyFile_FromFd()}

@item 
@ref{4933,,PyFile_GetLine()}

@item 
@ref{4934,,PyFile_WriteObject()}

@item 
@ref{4935,,PyFile_WriteString()}

@item 
@code{PyFilter_Type}

@item 
@ref{af9,,PyFloat_AsDouble()}

@item 
@ref{4936,,PyFloat_FromDouble()}

@item 
@ref{4937,,PyFloat_FromString()}

@item 
@ref{1430,,PyFloat_GetInfo()}

@item 
@ref{142e,,PyFloat_GetMax()}

@item 
@ref{142f,,PyFloat_GetMin()}

@item 
@ref{4938,,PyFloat_Type}

@item 
@ref{822,,PyFrameObject}

@item 
@ref{823,,PyFrame_GetCode()}

@item 
@ref{824,,PyFrame_GetLineNumber()}

@item 
@ref{1485,,PyFrozenSet_New()}

@item 
@ref{4939,,PyFrozenSet_Type}

@item 
@ref{a20,,PyGC_Collect()}

@item 
@ref{93d,,PyGC_Disable()}

@item 
@ref{93c,,PyGC_Enable()}

@item 
@ref{93e,,PyGC_IsEnabled()}

@item 
@ref{49e,,PyGILState_Ensure()}

@item 
@ref{493a,,PyGILState_GetThisThreadState()}

@item 
@ref{49f,,PyGILState_Release()}

@item 
@code{PyGILState_STATE}

@item 
@ref{c40,,PyGetSetDef}

@item 
@code{PyGetSetDescr_Type}

@item 
@ref{44d,,PyImport_AddModule()}

@item 
@ref{493b,,PyImport_AddModuleObject()}

@item 
@ref{44c,,PyImport_AddModuleRef()}

@item 
@ref{17ab,,PyImport_AppendInittab()}

@item 
@ref{493c,,PyImport_ExecCodeModule()}

@item 
@ref{493d,,PyImport_ExecCodeModuleEx()}

@item 
@ref{493e,,PyImport_ExecCodeModuleObject()}

@item 
@ref{493f,,PyImport_ExecCodeModuleWithPathnames()}

@item 
@ref{171c,,PyImport_GetImporter()}

@item 
@ref{1212,,PyImport_GetMagicNumber()}

@item 
@ref{4940,,PyImport_GetMagicTag()}

@item 
@ref{c3b,,PyImport_GetModule()}

@item 
@ref{4941,,PyImport_GetModuleDict()}

@item 
@ref{143c,,PyImport_Import()}

@item 
@ref{4942,,PyImport_ImportFrozenModule()}

@item 
@ref{4943,,PyImport_ImportFrozenModuleObject()}

@item 
@ref{273,,PyImport_ImportModule()}

@item 
@ref{1213,,PyImport_ImportModuleLevel()}

@item 
@ref{4944,,PyImport_ImportModuleLevelObject()}

@item 
@ref{272,,PyImport_ImportModuleNoBlock()}

@item 
@ref{4945,,PyImport_ReloadModule()}

@item 
@ref{a1c,,PyIndex_Check()}

@item 
@ref{954,,PyInterpreterState}

@item 
@ref{4105,,PyInterpreterState_Clear()}

@item 
@ref{4946,,PyInterpreterState_Delete()}

@item 
@ref{4a0,,PyInterpreterState_Get()}

@item 
@ref{4947,,PyInterpreterState_GetDict()}

@item 
@ref{c4e,,PyInterpreterState_GetID()}

@item 
@ref{4106,,PyInterpreterState_New()}

@item 
@ref{18fd,,PyIter_Check()}

@item 
@ref{245,,PyIter_Next()}

@item 
@ref{244,,PyIter_NextItem()}

@item 
@ref{930,,PyIter_Send()}

@item 
@code{PyListIter_Type}

@item 
@code{PyListRevIter_Type}

@item 
@ref{4948,,PyList_Append()}

@item 
@ref{4949,,PyList_AsTuple()}

@item 
@ref{450,,PyList_GetItem()}

@item 
@ref{44f,,PyList_GetItemRef()}

@item 
@ref{494a,,PyList_GetSlice()}

@item 
@ref{494b,,PyList_Insert()}

@item 
@ref{48c0,,PyList_New()}

@item 
@ref{494c,,PyList_Reverse()}

@item 
@ref{484a,,PyList_SetItem()}

@item 
@ref{494d,,PyList_SetSlice()}

@item 
@ref{1459,,PyList_Size()}

@item 
@ref{494e,,PyList_Sort()}

@item 
@ref{486c,,PyList_Type}

@item 
@ref{24b,,PyLongObject}

@item 
@code{PyLongRangeIter_Type}

@item 
@ref{1613,,PyLong_AsDouble()}

@item 
@ref{453,,PyLong_AsInt()}

@item 
@ref{24c,,PyLong_AsInt32()}

@item 
@ref{24d,,PyLong_AsInt64()}

@item 
@ref{454,,PyLong_AsLong()}

@item 
@ref{12d4,,PyLong_AsLongAndOverflow()}

@item 
@ref{494f,,PyLong_AsLongLong()}

@item 
@ref{12d3,,PyLong_AsLongLongAndOverflow()}

@item 
@ref{4950,,PyLong_AsSize_t()}

@item 
@ref{4951,,PyLong_AsSsize_t()}

@item 
@ref{24e,,PyLong_AsUInt32()}

@item 
@ref{24f,,PyLong_AsUInt64()}

@item 
@ref{4952,,PyLong_AsUnsignedLong()}

@item 
@ref{1301,,PyLong_AsUnsignedLongLong()}

@item 
@ref{19ef,,PyLong_AsUnsignedLongLongMask()}

@item 
@ref{4953,,PyLong_AsUnsignedLongMask()}

@item 
@ref{4954,,PyLong_AsVoidPtr()}

@item 
@ref{9d5,,PyLong_FromDouble()}

@item 
@ref{250,,PyLong_FromInt32()}

@item 
@ref{251,,PyLong_FromInt64()}

@item 
@ref{1840,,PyLong_FromLong()}

@item 
@ref{1841,,PyLong_FromLongLong()}

@item 
@ref{19cc,,PyLong_FromSize_t()}

@item 
@ref{4955,,PyLong_FromSsize_t()}

@item 
@ref{4956,,PyLong_FromString()}

@item 
@ref{252,,PyLong_FromUInt32()}

@item 
@ref{253,,PyLong_FromUInt64()}

@item 
@ref{19ca,,PyLong_FromUnsignedLong()}

@item 
@ref{19cb,,PyLong_FromUnsignedLongLong()}

@item 
@ref{4957,,PyLong_FromVoidPtr()}

@item 
@ref{4958,,PyLong_GetInfo()}

@item 
@ref{4959,,PyLong_Type}

@item 
@code{PyMap_Type}

@item 
@ref{495a,,PyMapping_Check()}

@item 
@ref{43c,,PyMapping_GetItemString()}

@item 
@ref{439,,PyMapping_GetOptionalItem()}

@item 
@ref{43a,,PyMapping_GetOptionalItemString()}

@item 
@ref{471,,PyMapping_HasKey()}

@item 
@ref{473,,PyMapping_HasKeyString()}

@item 
@ref{472,,PyMapping_HasKeyStringWithError()}

@item 
@ref{470,,PyMapping_HasKeyWithError()}

@item 
@ref{c46,,PyMapping_Items()}

@item 
@ref{c44,,PyMapping_Keys()}

@item 
@ref{495b,,PyMapping_Length()}

@item 
@ref{495c,,PyMapping_SetItemString()}

@item 
@ref{1a5d,,PyMapping_Size()}

@item 
@ref{c45,,PyMapping_Values()}

@item 
@ref{f2e,,PyMem_Calloc()}

@item 
@ref{1482,,PyMem_Free()}

@item 
@ref{cee,,PyMem_Malloc()}

@item 
@ref{483,,PyMem_RawCalloc()}

@item 
@ref{485,,PyMem_RawFree()}

@item 
@ref{482,,PyMem_RawMalloc()}

@item 
@ref{484,,PyMem_RawRealloc()}

@item 
@ref{10ae,,PyMem_Realloc()}

@item 
@ref{5f2,,PyMemberDef}

@item 
@code{PyMemberDescr_Type}

@item 
@ref{630,,PyMember_GetOne()}

@item 
@ref{631,,PyMember_SetOne()}

@item 
@ref{7fb,,PyMemoryView_FromBuffer()}

@item 
@ref{11e1,,PyMemoryView_FromMemory()}

@item 
@ref{495d,,PyMemoryView_FromObject()}

@item 
@ref{495e,,PyMemoryView_GetContiguous()}

@item 
@code{PyMemoryView_Type}

@item 
@ref{1517,,PyMethodDef}

@item 
@code{PyMethodDescr_Type}

@item 
@ref{a0f,,PyModuleDef}

@item 
@code{PyModuleDef_Base}

@item 
@ref{495f,,PyModuleDef_Init()}

@item 
@code{PyModuleDef_Type}

@item 
@ref{458,,PyModule_Add()}

@item 
@ref{4960,,PyModule_AddFunctions()}

@item 
@ref{157c,,PyModule_AddIntConstant()}

@item 
@ref{45a,,PyModule_AddObject()}

@item 
@ref{459,,PyModule_AddObjectRef()}

@item 
@ref{157d,,PyModule_AddStringConstant()}

@item 
@ref{a07,,PyModule_AddType()}

@item 
@ref{4961,,PyModule_Create2()}

@item 
@ref{f35,,PyModule_ExecDef()}

@item 
@ref{f34,,PyModule_FromDefAndSpec2()}

@item 
@ref{4962,,PyModule_GetDef()}

@item 
@ref{4963,,PyModule_GetDict()}

@item 
@ref{28f,,PyModule_GetFilename()}

@item 
@ref{290,,PyModule_GetFilenameObject()}

@item 
@ref{4964,,PyModule_GetName()}

@item 
@ref{4965,,PyModule_GetNameObject()}

@item 
@ref{a12,,PyModule_GetState()}

@item 
@ref{4966,,PyModule_New()}

@item 
@ref{4967,,PyModule_NewObject()}

@item 
@ref{4968,,PyModule_SetDocString()}

@item 
@ref{4969,,PyModule_Type}

@item 
@ref{496a,,PyNumber_Absolute()}

@item 
@ref{496b,,PyNumber_Add()}

@item 
@ref{496c,,PyNumber_And()}

@item 
@ref{496d,,PyNumber_AsSsize_t()}

@item 
@ref{af6,,PyNumber_Check()}

@item 
@ref{496e,,PyNumber_Divmod()}

@item 
@ref{af8,,PyNumber_Float()}

@item 
@ref{496f,,PyNumber_FloorDivide()}

@item 
@ref{4970,,PyNumber_InPlaceAdd()}

@item 
@ref{4971,,PyNumber_InPlaceAnd()}

@item 
@ref{4972,,PyNumber_InPlaceFloorDivide()}

@item 
@ref{4973,,PyNumber_InPlaceLshift()}

@item 
@ref{f37,,PyNumber_InPlaceMatrixMultiply()}

@item 
@ref{4974,,PyNumber_InPlaceMultiply()}

@item 
@ref{4975,,PyNumber_InPlaceOr()}

@item 
@ref{4976,,PyNumber_InPlacePower()}

@item 
@ref{4977,,PyNumber_InPlaceRemainder()}

@item 
@ref{4978,,PyNumber_InPlaceRshift()}

@item 
@ref{4979,,PyNumber_InPlaceSubtract()}

@item 
@ref{497a,,PyNumber_InPlaceTrueDivide()}

@item 
@ref{497b,,PyNumber_InPlaceXor()}

@item 
@ref{92b,,PyNumber_Index()}

@item 
@ref{497c,,PyNumber_Invert()}

@item 
@ref{af7,,PyNumber_Long()}

@item 
@ref{497d,,PyNumber_Lshift()}

@item 
@ref{f36,,PyNumber_MatrixMultiply()}

@item 
@ref{497e,,PyNumber_Multiply()}

@item 
@ref{497f,,PyNumber_Negative()}

@item 
@ref{4980,,PyNumber_Or()}

@item 
@ref{4981,,PyNumber_Positive()}

@item 
@ref{4982,,PyNumber_Power()}

@item 
@ref{4983,,PyNumber_Remainder()}

@item 
@ref{4984,,PyNumber_Rshift()}

@item 
@ref{4985,,PyNumber_Subtract()}

@item 
@ref{17f1,,PyNumber_ToBase()}

@item 
@ref{4986,,PyNumber_TrueDivide()}

@item 
@ref{4987,,PyNumber_Xor()}

@item 
@ref{291,,PyOS_AfterFork()}

@item 
@ref{292,,PyOS_AfterFork_Child()}

@item 
@ref{c48,,PyOS_AfterFork_Parent()}

@item 
@ref{c47,,PyOS_BeforeFork()}

@item 
@ref{181d,,PyOS_CheckStack()}

@item 
@ref{d9f,,PyOS_FSPath()}

@item 
@ref{629,,PyOS_InputHook}

@item 
@code{PyOS_InterruptOccurred()}

@item 
@ref{4988,,PyOS_double_to_string()}

@item 
@ref{157e,,PyOS_getsig()}

@item 
@code{PyOS_mystricmp()}

@item 
@code{PyOS_mystrnicmp()}

@item 
@ref{157f,,PyOS_setsig()}

@item 
@ref{4989,,PyOS_sighandler_t}

@item 
@ref{154b,,PyOS_snprintf()}

@item 
@ref{1302,,PyOS_string_to_double()}

@item 
@ref{498a,,PyOS_strtol()}

@item 
@ref{498b,,PyOS_strtoul()}

@item 
@ref{154c,,PyOS_vsnprintf()}

@item 
@ref{42d,,PyObject}

@item 
@ref{937,,PyObject.ob_refcnt}

@item 
@ref{485d,,PyObject.ob_type}

@item 
@ref{498c,,PyObject_ASCII()}

@item 
@ref{498d,,PyObject_AsFileDescriptor()}

@item 
@ref{498e,,PyObject_Bytes()}

@item 
@ref{48f,,PyObject_Call()}

@item 
@ref{491,,PyObject_CallFunction()}

@item 
@ref{498f,,PyObject_CallFunctionObjArgs()}

@item 
@ref{492,,PyObject_CallMethod()}

@item 
@ref{1a05,,PyObject_CallMethodObjArgs()}

@item 
@ref{48e,,PyObject_CallNoArgs()}

@item 
@ref{483d,,PyObject_CallObject()}

@item 
@ref{f2f,,PyObject_Calloc()}

@item 
@ref{48b,,PyObject_CheckBuffer()}

@item 
@ref{61a,,PyObject_ClearWeakRefs()}

@item 
@ref{7f7,,PyObject_CopyData()}

@item 
@ref{1723,,PyObject_DelAttr()}

@item 
@ref{1625,,PyObject_DelAttrString()}

@item 
@ref{4990,,PyObject_DelItem()}

@item 
@code{PyObject_DelItemString()}

@item 
@ref{4991,,PyObject_Dir()}

@item 
@ref{4992,,PyObject_Format()}

@item 
@ref{ced,,PyObject_Free()}

@item 
@ref{1545,,PyObject_GC_Del()}

@item 
@ref{a09,,PyObject_GC_IsFinalized()}

@item 
@ref{a08,,PyObject_GC_IsTracked()}

@item 
@ref{1546,,PyObject_GC_Track()}

@item 
@ref{1547,,PyObject_GC_UnTrack()}

@item 
@ref{4993,,PyObject_GenericGetAttr()}

@item 
@ref{1943,,PyObject_GenericGetDict()}

@item 
@ref{4994,,PyObject_GenericSetAttr()}

@item 
@ref{4995,,PyObject_GenericSetDict()}

@item 
@ref{4996,,PyObject_GetAIter()}

@item 
@ref{43f,,PyObject_GetAttr()}

@item 
@ref{440,,PyObject_GetAttrString()}

@item 
@ref{48c,,PyObject_GetBuffer()}

@item 
@ref{43b,,PyObject_GetItem()}

@item 
@ref{4997,,PyObject_GetIter()}

@item 
@ref{43d,,PyObject_GetOptionalAttr()}

@item 
@ref{43e,,PyObject_GetOptionalAttrString()}

@item 
@ref{5ec,,PyObject_GetTypeData()}

@item 
@ref{46d,,PyObject_HasAttr()}

@item 
@ref{46f,,PyObject_HasAttrString()}

@item 
@ref{46e,,PyObject_HasAttrStringWithError()}

@item 
@ref{46c,,PyObject_HasAttrWithError()}

@item 
@ref{29a,,PyObject_Hash()}

@item 
@ref{1406,,PyObject_HashNotImplemented()}

@item 
@ref{afa,,PyObject_Init()}

@item 
@ref{195f,,PyObject_InitVar()}

@item 
@ref{f27,,PyObject_IsInstance()}

@item 
@ref{f28,,PyObject_IsSubclass()}

@item 
@ref{4998,,PyObject_IsTrue()}

@item 
@ref{4999,,PyObject_Length()}

@item 
@ref{cf0,,PyObject_Malloc()}

@item 
@ref{499a,,PyObject_Not()}

@item 
@ref{1483,,PyObject_Realloc()}

@item 
@ref{10ab,,PyObject_Repr()}

@item 
@ref{4881,,PyObject_RichCompare()}

@item 
@ref{19ac,,PyObject_RichCompareBool()}

@item 
@code{PyObject_SelfIter()}

@item 
@ref{499b,,PyObject_SetAttr()}

@item 
@ref{1624,,PyObject_SetAttrString()}

@item 
@ref{48bf,,PyObject_SetItem()}

@item 
@ref{499c,,PyObject_Size()}

@item 
@ref{10ac,,PyObject_Str()}

@item 
@ref{499d,,PyObject_Type()}

@item 
@ref{5ff,,PyObject_Vectorcall()}

@item 
@ref{600,,PyObject_VectorcallMethod()}

@item 
@ref{499e,,PyProperty_Type}

@item 
@code{PyRangeIter_Type}

@item 
@code{PyRange_Type}

@item 
@code{PyReversed_Type}

@item 
@ref{499f,,PySeqIter_New()}

@item 
@ref{49a0,,PySeqIter_Type}

@item 
@ref{49a1,,PySequence_Check()}

@item 
@ref{49a2,,PySequence_Concat()}

@item 
@ref{49a3,,PySequence_Contains()}

@item 
@ref{49a4,,PySequence_Count()}

@item 
@ref{1a5c,,PySequence_DelItem()}

@item 
@ref{49a5,,PySequence_DelSlice()}

@item 
@ref{49a6,,PySequence_Fast()}

@item 
@ref{1a5a,,PySequence_GetItem()}

@item 
@ref{49a7,,PySequence_GetSlice()}

@item 
@code{PySequence_In()}

@item 
@ref{49a8,,PySequence_InPlaceConcat()}

@item 
@ref{49a9,,PySequence_InPlaceRepeat()}

@item 
@ref{49aa,,PySequence_Index()}

@item 
@ref{49ab,,PySequence_Length()}

@item 
@ref{49ac,,PySequence_List()}

@item 
@ref{49ad,,PySequence_Repeat()}

@item 
@ref{1a5b,,PySequence_SetItem()}

@item 
@ref{49ae,,PySequence_SetSlice()}

@item 
@ref{1a59,,PySequence_Size()}

@item 
@ref{49af,,PySequence_Tuple()}

@item 
@code{PySetIter_Type}

@item 
@ref{1486,,PySet_Add()}

@item 
@ref{49b0,,PySet_Clear()}

@item 
@ref{1488,,PySet_Contains()}

@item 
@ref{1487,,PySet_Discard()}

@item 
@ref{1484,,PySet_New()}

@item 
@ref{49b1,,PySet_Pop()}

@item 
@ref{1489,,PySet_Size()}

@item 
@ref{49b2,,PySet_Type}

@item 
@ref{295,,PySlice_AdjustIndices()}

@item 
@ref{49b3,,PySlice_GetIndices()}

@item 
@ref{293,,PySlice_GetIndicesEx()}

@item 
@ref{49b4,,PySlice_New()}

@item 
@ref{49b5,,PySlice_Type}

@item 
@ref{294,,PySlice_Unpack()}

@item 
@ref{49b6,,PyState_AddModule()}

@item 
@ref{49b7,,PyState_FindModule()}

@item 
@ref{49b8,,PyState_RemoveModule()}

@item 
@ref{c42,,PyStructSequence_Desc}

@item 
@ref{c41,,PyStructSequence_Field}

@item 
@ref{49b9,,PyStructSequence_GetItem()}

@item 
@ref{49ba,,PyStructSequence_New()}

@item 
@ref{49bb,,PyStructSequence_NewType()}

@item 
@ref{49bc,,PyStructSequence_SetItem()}

@item 
@ref{a14,,PyStructSequence_UnnamedField}

@item 
@code{PySuper_Type}

@item 
@ref{463,,PySys_Audit()}

@item 
@ref{462,,PySys_AuditTuple()}

@item 
@ref{49bd,,PySys_FormatStderr()}

@item 
@ref{49be,,PySys_FormatStdout()}

@item 
@ref{47b,,PySys_GetObject()}

@item 
@ref{49bf,,PySys_GetXOptions()}

@item 
@ref{278,,PySys_ResetWarnOptions()}

@item 
@ref{164c,,PySys_SetArgv()}

@item 
@ref{164b,,PySys_SetArgvEx()}

@item 
@ref{49c0,,PySys_SetObject()}

@item 
@ref{49c1,,PySys_WriteStderr()}

@item 
@ref{49c2,,PySys_WriteStdout()}

@item 
@ref{826,,PyThreadState}

@item 
@ref{1628,,PyThreadState_Clear()}

@item 
@ref{19a9,,PyThreadState_Delete()}

@item 
@ref{466,,PyThreadState_Get()}

@item 
@ref{49c3,,PyThreadState_GetDict()}

@item 
@ref{827,,PyThreadState_GetFrame()}

@item 
@ref{a04,,PyThreadState_GetID()}

@item 
@ref{a03,,PyThreadState_GetInterpreter()}

@item 
@ref{49c4,,PyThreadState_New()}

@item 
@ref{c4c,,PyThreadState_SetAsyncExc()}

@item 
@ref{49c5,,PyThreadState_Swap()}

@item 
@code{PyThread_GetInfo()}

@item 
@ref{2a5,,PyThread_ReInitTLS()}

@item 
@code{PyThread_acquire_lock()}

@item 
@code{PyThread_acquire_lock_timed()}

@item 
@code{PyThread_allocate_lock()}

@item 
@ref{29b,,PyThread_create_key()}

@item 
@ref{29d,,PyThread_delete_key()}

@item 
@ref{2a3,,PyThread_delete_key_value()}

@item 
@code{PyThread_exit_thread()}

@item 
@code{PyThread_free_lock()}

@item 
@ref{2a1,,PyThread_get_key_value()}

@item 
@code{PyThread_get_stacksize()}

@item 
@code{PyThread_get_thread_ident()}

@item 
@code{PyThread_get_thread_native_id()}

@item 
@code{PyThread_init_thread()}

@item 
@code{PyThread_release_lock()}

@item 
@ref{29f,,PyThread_set_key_value()}

@item 
@code{PyThread_set_stacksize()}

@item 
@code{PyThread_start_new_thread()}

@item 
@ref{29c,,PyThread_tss_alloc()}

@item 
@ref{49c6,,PyThread_tss_create()}

@item 
@ref{2a4,,PyThread_tss_delete()}

@item 
@ref{29e,,PyThread_tss_free()}

@item 
@ref{2a2,,PyThread_tss_get()}

@item 
@ref{49c7,,PyThread_tss_is_created()}

@item 
@ref{2a0,,PyThread_tss_set()}

@item 
@code{PyTraceBack_Here()}

@item 
@code{PyTraceBack_Print()}

@item 
@code{PyTraceBack_Type}

@item 
@code{PyTupleIter_Type}

@item 
@ref{4848,,PyTuple_GetItem()}

@item 
@ref{49c8,,PyTuple_GetSlice()}

@item 
@ref{490,,PyTuple_New()}

@item 
@ref{49c9,,PyTuple_Pack()}

@item 
@ref{4849,,PyTuple_SetItem()}

@item 
@ref{49ca,,PyTuple_Size()}

@item 
@ref{49cb,,PyTuple_Type}

@item 
@ref{b30,,PyTypeObject}

@item 
@ref{49cc,,PyType_ClearCache()}

@item 
@ref{26b,,PyType_Freeze()}

@item 
@ref{5f3,,PyType_FromMetaclass()}

@item 
@ref{5f4,,PyType_FromModuleAndSpec()}

@item 
@ref{621,,PyType_FromSpec()}

@item 
@ref{622,,PyType_FromSpecWithBases()}

@item 
@ref{afb,,PyType_GenericAlloc()}

@item 
@ref{485c,,PyType_GenericNew()}

@item 
@ref{268,,PyType_GetBaseByToken()}

@item 
@ref{195e,,PyType_GetFlags()}

@item 
@ref{467,,PyType_GetFullyQualifiedName()}

@item 
@ref{a00,,PyType_GetModule()}

@item 
@ref{486,,PyType_GetModuleByDef()}

@item 
@ref{469,,PyType_GetModuleName()}

@item 
@ref{a01,,PyType_GetModuleState()}

@item 
@ref{7ec,,PyType_GetName()}

@item 
@ref{7ed,,PyType_GetQualName()}

@item 
@ref{934,,PyType_GetSlot()}

@item 
@ref{5ed,,PyType_GetTypeDataSize()}

@item 
@ref{49cd,,PyType_IsSubtype()}

@item 
@ref{17f9,,PyType_Modified()}

@item 
@ref{816,,PyType_Ready()}

@item 
@ref{49ce,,PyType_Slot}

@item 
@ref{1721,,PyType_Spec}

@item 
@ref{5f0,,PyType_Type}

@item 
@ref{49cf,,PyUnicodeDecodeError_Create()}

@item 
@ref{49d0,,PyUnicodeDecodeError_GetEncoding()}

@item 
@ref{49d1,,PyUnicodeDecodeError_GetEnd()}

@item 
@ref{49d2,,PyUnicodeDecodeError_GetObject()}

@item 
@ref{49d3,,PyUnicodeDecodeError_GetReason()}

@item 
@ref{49d4,,PyUnicodeDecodeError_GetStart()}

@item 
@ref{49d5,,PyUnicodeDecodeError_SetEnd()}

@item 
@ref{49d6,,PyUnicodeDecodeError_SetReason()}

@item 
@ref{49d7,,PyUnicodeDecodeError_SetStart()}

@item 
@ref{49d8,,PyUnicodeEncodeError_GetEncoding()}

@item 
@ref{49d9,,PyUnicodeEncodeError_GetEnd()}

@item 
@ref{49da,,PyUnicodeEncodeError_GetObject()}

@item 
@ref{49db,,PyUnicodeEncodeError_GetReason()}

@item 
@ref{49dc,,PyUnicodeEncodeError_GetStart()}

@item 
@ref{49dd,,PyUnicodeEncodeError_SetEnd()}

@item 
@ref{49de,,PyUnicodeEncodeError_SetReason()}

@item 
@ref{49df,,PyUnicodeEncodeError_SetStart()}

@item 
@code{PyUnicodeIter_Type}

@item 
@ref{49e0,,PyUnicodeTranslateError_GetEnd()}

@item 
@ref{49e1,,PyUnicodeTranslateError_GetObject()}

@item 
@ref{49e2,,PyUnicodeTranslateError_GetReason()}

@item 
@ref{49e3,,PyUnicodeTranslateError_GetStart()}

@item 
@ref{49e4,,PyUnicodeTranslateError_SetEnd()}

@item 
@ref{49e5,,PyUnicodeTranslateError_SetReason()}

@item 
@ref{49e6,,PyUnicodeTranslateError_SetStart()}

@item 
@code{PyUnicode_Append()}

@item 
@code{PyUnicode_AppendAndDel()}

@item 
@ref{1203,,PyUnicode_AsASCIIString()}

@item 
@ref{49e7,,PyUnicode_AsCharmapString()}

@item 
@code{PyUnicode_AsDecodedObject()}

@item 
@code{PyUnicode_AsDecodedUnicode()}

@item 
@code{PyUnicode_AsEncodedObject()}

@item 
@ref{49e8,,PyUnicode_AsEncodedString()}

@item 
@code{PyUnicode_AsEncodedUnicode()}

@item 
@ref{1202,,PyUnicode_AsLatin1String()}

@item 
@ref{1204,,PyUnicode_AsMBCSString()}

@item 
@ref{1201,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@ref{11e9,,PyUnicode_AsUCS4()}

@item 
@ref{952,,PyUnicode_AsUCS4Copy()}

@item 
@ref{49e9,,PyUnicode_AsUTF16String()}

@item 
@ref{49ea,,PyUnicode_AsUTF32String()}

@item 
@ref{931,,PyUnicode_AsUTF8AndSize()}

@item 
@ref{11ff,,PyUnicode_AsUTF8String()}

@item 
@ref{1200,,PyUnicode_AsUnicodeEscapeString()}

@item 
@ref{1a5e,,PyUnicode_AsWideChar()}

@item 
@ref{953,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_BuildEncodingMap()}

@item 
@ref{94e,,PyUnicode_Compare()}

@item 
@ref{12d5,,PyUnicode_CompareWithASCIIString()}

@item 
@ref{1210,,PyUnicode_Concat()}

@item 
@ref{49eb,,PyUnicode_Contains()}

@item 
@ref{49ec,,PyUnicode_Count()}

@item 
@ref{19eb,,PyUnicode_Decode()}

@item 
@ref{49ed,,PyUnicode_DecodeASCII()}

@item 
@ref{49ee,,PyUnicode_DecodeCharmap()}

@item 
@code{PyUnicode_DecodeCodePageStateful()}

@item 
@ref{1720,,PyUnicode_DecodeFSDefault()}

@item 
@ref{49ef,,PyUnicode_DecodeFSDefaultAndSize()}

@item 
@ref{49f0,,PyUnicode_DecodeLatin1()}

@item 
@ref{49f1,,PyUnicode_DecodeLocale()}

@item 
@ref{c51,,PyUnicode_DecodeLocaleAndSize()}

@item 
@ref{49f2,,PyUnicode_DecodeMBCS()}

@item 
@ref{49f3,,PyUnicode_DecodeMBCSStateful()}

@item 
@ref{49f4,,PyUnicode_DecodeRawUnicodeEscape()}

@item 
@ref{49f5,,PyUnicode_DecodeUTF16()}

@item 
@ref{49f6,,PyUnicode_DecodeUTF16Stateful()}

@item 
@ref{49f7,,PyUnicode_DecodeUTF32()}

@item 
@ref{49f8,,PyUnicode_DecodeUTF32Stateful()}

@item 
@ref{49f9,,PyUnicode_DecodeUTF7()}

@item 
@ref{49fa,,PyUnicode_DecodeUTF7Stateful()}

@item 
@ref{49fb,,PyUnicode_DecodeUTF8()}

@item 
@ref{17a7,,PyUnicode_DecodeUTF8Stateful()}

@item 
@ref{49fc,,PyUnicode_DecodeUnicodeEscape()}

@item 
@ref{1205,,PyUnicode_EncodeCodePage()}

@item 
@ref{1a58,,PyUnicode_EncodeFSDefault()}

@item 
@ref{c52,,PyUnicode_EncodeLocale()}

@item 
@ref{26a,,PyUnicode_Equal()}

@item 
@ref{46b,,PyUnicode_EqualToUTF8()}

@item 
@ref{46a,,PyUnicode_EqualToUTF8AndSize()}

@item 
@ref{da0,,PyUnicode_FSConverter()}

@item 
@ref{61b,,PyUnicode_FSDecoder()}

@item 
@ref{49fd,,PyUnicode_Find()}

@item 
@ref{950,,PyUnicode_FindChar()}

@item 
@ref{49fe,,PyUnicode_Format()}

@item 
@ref{49ff,,PyUnicode_FromEncodedObject()}

@item 
@ref{47c,,PyUnicode_FromFormat()}

@item 
@ref{618,,PyUnicode_FromFormatV()}

@item 
@ref{4a00,,PyUnicode_FromObject()}

@item 
@code{PyUnicode_FromOrdinal()}

@item 
@ref{48a3,,PyUnicode_FromString()}

@item 
@ref{4a01,,PyUnicode_FromStringAndSize()}

@item 
@ref{11fd,,PyUnicode_FromWideChar()}

@item 
@code{PyUnicode_GetDefaultEncoding()}

@item 
@ref{94a,,PyUnicode_GetLength()}

@item 
@ref{1622,,PyUnicode_InternFromString()}

@item 
@ref{948,,PyUnicode_InternInPlace()}

@item 
@ref{19a6,,PyUnicode_IsIdentifier()}

@item 
@ref{1211,,PyUnicode_Join()}

@item 
@code{PyUnicode_Partition()}

@item 
@code{PyUnicode_RPartition()}

@item 
@code{PyUnicode_RSplit()}

@item 
@ref{11e2,,PyUnicode_ReadChar()}

@item 
@ref{4a02,,PyUnicode_Replace()}

@item 
@code{PyUnicode_Resize()}

@item 
@ref{4a03,,PyUnicode_RichCompare()}

@item 
@ref{4a04,,PyUnicode_Split()}

@item 
@ref{4a05,,PyUnicode_Splitlines()}

@item 
@ref{94d,,PyUnicode_Substring()}

@item 
@ref{94f,,PyUnicode_Tailmatch()}

@item 
@ref{4a06,,PyUnicode_Translate()}

@item 
@ref{4a07,,PyUnicode_Type}

@item 
@ref{11e3,,PyUnicode_WriteChar()}

@item 
@ref{408a,,PyVarObject}

@item 
@code{PyVarObject.ob_base}

@item 
@ref{4a08,,PyVarObject.ob_size}

@item 
@ref{5f9,,PyVectorcall_Call()}

@item 
@ref{5f8,,PyVectorcall_NARGS()}

@item 
@code{PyWeakReference}

@item 
@ref{274,,PyWeakref_GetObject()}

@item 
@ref{276,,PyWeakref_GetRef()}

@item 
@ref{4a09,,PyWeakref_NewProxy()}

@item 
@ref{1856,,PyWeakref_NewRef()}

@item 
@code{PyWrapperDescr_Type}

@item 
@ref{4a0a,,PyWrapper_New()}

@item 
@code{PyZip_Type}

@item 
@ref{a13,,Py_AddPendingCall()}

@item 
@ref{4a0b,,Py_AtExit()}

@item 
@ref{484e,,Py_BEGIN_ALLOW_THREADS}

@item 
@ref{4a0c,,Py_BLOCK_THREADS}

@item 
@ref{940,,Py_BuildValue()}

@item 
@ref{a53,,Py_BytesMain()}

@item 
@ref{91d,,Py_CompileString()}

@item 
@ref{4a0d,,Py_DecRef()}

@item 
@ref{c4f,,Py_DecodeLocale()}

@item 
@ref{b1a,,Py_END_ALLOW_THREADS}

@item 
@ref{c50,,Py_EncodeLocale()}

@item 
@ref{1867,,Py_EndInterpreter()}

@item 
@ref{a05,,Py_EnterRecursiveCall()}

@item 
@ref{dd5,,Py_Exit()}

@item 
@ref{a15,,Py_FatalError()}

@item 
@code{Py_FileSystemDefaultEncodeErrors}

@item 
@code{Py_FileSystemDefaultEncoding}

@item 
@ref{246,,Py_Finalize()}

@item 
@ref{d9c,,Py_FinalizeEx()}

@item 
@ref{4a0e,,Py_GenericAlias()}

@item 
@ref{4a0f,,Py_GenericAliasType}

@item 
@ref{1471,,Py_GetBuildInfo()}

@item 
@ref{4a10,,Py_GetCompiler()}

@item 
@ref{44a,,Py_GetConstant()}

@item 
@ref{44b,,Py_GetConstantBorrowed()}

@item 
@ref{4a11,,Py_GetCopyright()}

@item 
@ref{27a,,Py_GetExecPrefix()}

@item 
@ref{27d,,Py_GetPath()}

@item 
@ref{4a12,,Py_GetPlatform()}

@item 
@ref{27f,,Py_GetPrefix()}

@item 
@ref{282,,Py_GetProgramFullPath()}

@item 
@ref{284,,Py_GetProgramName()}

@item 
@ref{285,,Py_GetPythonHome()}

@item 
@code{Py_GetRecursionLimit()}

@item 
@ref{4a13,,Py_GetVersion()}

@item 
@code{Py_HasFileSystemDefaultEncoding}

@item 
@ref{4a14,,Py_IncRef()}

@item 
@ref{247,,Py_Initialize()}

@item 
@ref{4a15,,Py_InitializeEx()}

@item 
@ref{938,,Py_Is()}

@item 
@ref{93b,,Py_IsFalse()}

@item 
@ref{44e,,Py_IsFinalizing()}

@item 
@ref{48c8,,Py_IsInitialized()}

@item 
@ref{939,,Py_IsNone()}

@item 
@ref{93a,,Py_IsTrue()}

@item 
@ref{a06,,Py_LeaveRecursiveCall()}

@item 
@ref{cad,,Py_Main()}

@item 
@code{Py_MakePendingCalls()}

@item 
@ref{17be,,Py_NewInterpreter()}

@item 
@ref{932,,Py_NewRef()}

@item 
@ref{26f,,Py_REFCNT()}

@item 
@ref{4a16,,Py_ReprEnter()}

@item 
@ref{4a17,,Py_ReprLeave()}

@item 
@ref{164a,,Py_SetProgramName()}

@item 
@ref{1649,,Py_SetPythonHome()}

@item 
@code{Py_SetRecursionLimit()}

@item 
@ref{26e,,Py_TYPE()}

@item 
@ref{1e4,,Py_UCS4}

@item 
@ref{4a18,,Py_UNBLOCK_THREADS}

@item 
@code{Py_UTF8Mode}

@item 
@ref{4a19,,Py_VaBuildValue()}

@item 
@ref{7f0,,Py_Version}

@item 
@ref{933,,Py_XNewRef()}

@item 
@ref{7f2,,Py_buffer}

@item 
@code{Py_intptr_t}

@item 
@ref{af0,,Py_ssize_t}

@item 
@code{Py_uintptr_t}

@item 
@ref{4a1a,,allocfunc}

@item 
@ref{4a1b,,binaryfunc}

@item 
@ref{4a1c,,descrgetfunc}

@item 
@ref{4a1d,,descrsetfunc}

@item 
@ref{4a1e,,destructor}

@item 
@ref{4a1f,,getattrfunc}

@item 
@ref{4a20,,getattrofunc}

@item 
@ref{4a21,,getbufferproc}

@item 
@ref{4a22,,getiterfunc}

@item 
@ref{4a23,,getter}

@item 
@ref{4a24,,hashfunc}

@item 
@ref{4a25,,initproc}

@item 
@ref{4a26,,inquiry}

@item 
@ref{4a27,,iternextfunc}

@item 
@ref{4a28,,lenfunc}

@item 
@ref{4a29,,newfunc}

@item 
@ref{4a2a,,objobjargproc}

@item 
@ref{4a2b,,objobjproc}

@item 
@ref{4a2c,,releasebufferproc}

@item 
@ref{4a2d,,reprfunc}

@item 
@ref{4a2e,,richcmpfunc}

@item 
@ref{4a2f,,setattrfunc}

@item 
@ref{4a30,,setattrofunc}

@item 
@ref{4a31,,setter}

@item 
@ref{4a32,,ssizeargfunc}

@item 
@ref{4a33,,ssizeobjargproc}

@item 
@code{ssizessizeargfunc}

@item 
@code{ssizessizeobjargproc}

@item 
@code{symtable}

@item 
@ref{4a34,,ternaryfunc}

@item 
@ref{4a35,,traverseproc}

@item 
@ref{4a36,,unaryfunc}

@item 
@ref{5fa,,vectorcallfunc}

@item 
@ref{4a37,,visitproc}
@end itemize


@node La capa de muy alto nivel,Conteo de referencias<2>,Estabilidad de la API en C,Manual de referencia de la API en C de Python
@anchor{c-api/veryhigh doc}@anchor{4a38}@anchor{c-api/veryhigh the-very-high-level-layer}@anchor{4a39}@anchor{c-api/veryhigh veryhigh}@anchor{4a3a}
@section La capa de muy alto nivel


Las funciones en este capítulo te permitirán ejecutar código fuente de Python desde un archivo o un búfer, pero no te permitirán interactuar de una manera detallada con el intérprete.

Several of these functions accept a start symbol from the grammar as a
parameter.  The available start symbols are @ref{4a3b,,Py_eval_input},
@ref{4a3c,,Py_file_input}, and @ref{4a3d,,Py_single_input}.  These are described
following the functions which accept them as parameters.

Note also that several of these functions take FILE* parameters.  One
particular issue which needs to be handled carefully is that the @code{FILE}
structure for different C libraries can be different and incompatible.  Under
Windows (at least), it is possible for dynamically linked extensions to actually
use different libraries, so care should be taken that FILE* parameters
are only passed to these functions if it is certain that they were created by
the same library that the Python runtime is using.

@geindex PyRun_AnyFile (C function)
@anchor{c-api/veryhigh c PyRun_AnyFile}@anchor{4a3e}
@deffn {C Función} int PyRun_AnyFile (FILE *fp, const char *filename)

Esta es una interfaz simplificada para @ref{4a3f,,PyRun_AnyFileExFlags()} más abajo, dejando `closeit' establecido a @code{0} y `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_AnyFileFlags (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileFlags}@anchor{4a40}
@deffn {C Función} int PyRun_AnyFileFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Esta es una interfaz simplificada para @ref{4a3f,,PyRun_AnyFileExFlags()} más abajo, dejando `closeit' establecido a @code{0}.
@end deffn

@geindex PyRun_AnyFileEx (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileEx}@anchor{4a41}
@deffn {C Función} int PyRun_AnyFileEx (FILE *fp, const char *filename, int closeit)

Esta es una interfaz simplificada para @ref{4a3f,,PyRun_AnyFileExFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_AnyFileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileExFlags}@anchor{4a3f}
@deffn {C Función} int PyRun_AnyFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

If `fp' refers to a file associated with an interactive device (console or
terminal input or Unix pseudo-terminal), return the value of
@ref{4a42,,PyRun_InteractiveLoop()}, otherwise return the result of
@ref{489b,,PyRun_SimpleFile()}.  `filename' is decoded from the filesystem
encoding (@ref{ce1,,sys.getfilesystemencoding()}).  If `filename' is @code{NULL}, this
function uses @code{"???"} as the filename.
If `closeit' is true, the file is closed before
@code{PyRun_SimpleFileExFlags()} returns.
@end deffn

@geindex PyRun_SimpleString (C function)
@anchor{c-api/veryhigh c PyRun_SimpleString}@anchor{489a}
@deffn {C Función} int PyRun_SimpleString (const char *command)

This is a simplified interface to @ref{4a43,,PyRun_SimpleStringFlags()} below,
leaving the @ref{b2c,,PyCompilerFlags}* argument set to @code{NULL}.
@end deffn

@geindex PyRun_SimpleStringFlags (C function)
@anchor{c-api/veryhigh c PyRun_SimpleStringFlags}@anchor{4a43}
@deffn {C Función} int PyRun_SimpleStringFlags (const char *command, PyCompilerFlags *flags)

Ejecuta el código fuente de Python desde `command' en el módulo @ref{1,,__main__} de acuerdo con el argumento `flags'. Si @ref{1,,__main__} aún no existe, se crea. Retorna @code{0} en caso de éxito o @code{-1} si se produjo una excepción. Si hubo un error, no hay forma de obtener la información de excepción. Para el significado de `flags', ver abajo.

Note that if an otherwise unhandled @ref{dc7,,SystemExit} is raised, this
function will not return @code{-1}, but exit the process, as long as
@ref{4b0,,PyConfig.inspect} is zero.
@end deffn

@geindex PyRun_SimpleFile (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFile}@anchor{489b}
@deffn {C Función} int PyRun_SimpleFile (FILE *fp, const char *filename)

Esta es una interfaz simplificada para @ref{4a43,,PyRun_SimpleStringFlags()} más abajo, dejando `closeit' establecido a @code{0} y `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_SimpleFileEx (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFileEx}@anchor{4a44}
@deffn {C Función} int PyRun_SimpleFileEx (FILE *fp, const char *filename, int closeit)

Esta es una interfaz simplificada para @ref{4a43,,PyRun_SimpleStringFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_SimpleFileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFileExFlags}@anchor{1911}
@deffn {C Función} int PyRun_SimpleFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

Similar a @ref{4a43,,PyRun_SimpleStringFlags()}, pero el código fuente de Python se lee desde `fp' en lugar de una cadena de caracteres en memoria. `filename' debe ser el nombre del fichero, se decodifica desde @ref{5dd,,filesystem encoding and error handler}. Si `closeit' es verdadero, el fichero se cierra antes de que @code{PyRun_SimpleFileExFlags()} retorne.

@cartouche
@quotation Nota 
En Windows, `fp' debe abrirse en modo binario (por ejemplo, @code{fopen(filename, "rb")}. De lo contrario, Python puede no manejar correctamente el archivo de script con la terminación de línea LF.
@end quotation
@end cartouche
@end deffn

@geindex PyRun_InteractiveOne (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveOne}@anchor{4a45}
@deffn {C Función} int PyRun_InteractiveOne (FILE *fp, const char *filename)

Esta es una interfaz simplificada para @ref{4a46,,PyRun_InteractiveOneFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_InteractiveOneFlags (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveOneFlags}@anchor{4a46}
@deffn {C Función} int PyRun_InteractiveOneFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Lee y ejecuta declaraciones de un archivo asociado con un dispositivo interactivo de acuerdo al argumento `flags'. Se le solicitará al usuario usando @code{sys.ps1} y @code{sys.ps2}. `filename' se decodifica a partir del @ref{5dd,,manejador de codificación y errores del sistema de archivos}.

Retorna @code{0} cuando la entrada se ejecuta con éxito, @code{-1} si hubo una excepción, o un código de error del archivo @code{errcode.h} distribuido como parte de Python si hubo un error de análisis gramatical. (Tenga en cuenta que @code{errcode.h} no está incluido en @code{Python.h}, por lo que debe incluirse específicamente si es necesario).
@end deffn

@geindex PyRun_InteractiveLoop (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveLoop}@anchor{4a42}
@deffn {C Función} int PyRun_InteractiveLoop (FILE *fp, const char *filename)

Esta es una interfaz simplificada para @ref{4a47,,PyRun_InteractiveLoopFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_InteractiveLoopFlags (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveLoopFlags}@anchor{4a47}
@deffn {C Función} int PyRun_InteractiveLoopFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Lee y ejecuta declaraciones de un archivo asociado con un dispositivo interactivo hasta llegar al EOF. Se le solicitará al usuario usando @code{sys.ps1} y @code{sys.ps2}.*filename* se decodifica a partir del @ref{5dd,,manejador de codificación y errores del sistema de archivos}. Retorna @code{0} en EOF o un número negativo en caso de falla.
@end deffn

@geindex PyOS_InputHook (C var)
@anchor{c-api/veryhigh c PyOS_InputHook}@anchor{629}
@deffn {C Variable} int (*PyOS_InputHook)(void)
` Part of the @ref{5f6,,Stable ABI}.'
Se puede configurar para que apunte a una función con el prototipo @code{int func(void)}. Se llamará a la función cuando el indicador del intérprete de Python esté a punto de estar inactivo y espere la entrada del usuario desde el terminal. El valor de retorno es ignorado. Sobrescribiendo este enlace se puede utilizar para integrar la solicitud del intérprete con otros bucles de eventos, como se hace en @code{Modules/_tkinter.c} en el código fuente de Python.


Distinto en la versión 3.12: This function is only called from the
@ref{62b,,main interpreter}.

@end deffn

@geindex PyOS_ReadlineFunctionPointer (C var)
@anchor{c-api/veryhigh c PyOS_ReadlineFunctionPointer}@anchor{62a}
@deffn {C Variable} char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)

Se puede configurar para que apunte a una función con el prototipo @code{char *func (FILE *stdin, FILE *stdout, char *prompt)}, sobrescribiendo la función predeterminada utilizada para leer una sola línea de entrada desde el intérprete. Se espera que la función genere la cadena de caracteres `prompt' si no es @code{NULL}, y luego lea una línea de entrada del archivo de entrada estándar proporcionado, retornando la cadena de caracteres resultante. Por ejemplo, el módulo @ref{ba,,readline} establece este enlace para proporcionar funciones de edición de línea y finalización de tabulación.

El resultado debe ser una cadena de caracteres alocado por @ref{482,,PyMem_RawMalloc()} o @ref{484,,PyMem_RawRealloc()}, o @code{NULL} si ocurre un error.


Distinto en la versión 3.4: El resultado debe ser alocado por @ref{482,,PyMem_RawMalloc()} o @ref{484,,PyMem_RawRealloc()}, en vez de ser alocado por @ref{cee,,PyMem_Malloc()} o @ref{10ae,,PyMem_Realloc()}.



Distinto en la versión 3.12: This function is only called from the
@ref{62b,,main interpreter}.

@end deffn

@geindex PyRun_String (C function)
@anchor{c-api/veryhigh c PyRun_String}@anchor{19e4}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_String (const char *str, int start, PyObject *globals, PyObject *locals)
`Return value: New reference.'
Esta es una interfaz simplificada para @ref{4a48,,PyRun_StringFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_StringFlags (C function)
@anchor{c-api/veryhigh c PyRun_StringFlags}@anchor{4a48}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_StringFlags (const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`Return value: New reference.'
Ejecuta el código fuente de Python desde `str' en el contexto especificado por los objetos `globals' y `locals' con los indicadores del compilador especificados por `flags'. `globals' debe ser un diccionario; `locals' puede ser cualquier objeto que implemente el protocolo de mapeo. El parámetro `start' especifica el token de inicio que se debe usar para analizar el código fuente.

Retorna el resultado de ejecutar el código como un objeto Python, o @code{NULL}” si se produjo una excepción.
@end deffn

@geindex PyRun_File (C function)
@anchor{c-api/veryhigh c PyRun_File}@anchor{4a49}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_File (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
`Return value: New reference.'
Esta es una interfaz simplificada para @ref{4a4a,,PyRun_FileExFlags()} más abajo, dejando `closeit' establecido a @code{0} y `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_FileEx (C function)
@anchor{c-api/veryhigh c PyRun_FileEx}@anchor{4a4b}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_FileEx (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)
`Return value: New reference.'
Esta es una interfaz simplificada para @ref{4a4a,,PyRun_FileExFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex PyRun_FileFlags (C function)
@anchor{c-api/veryhigh c PyRun_FileFlags}@anchor{4a4c}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_FileFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`Return value: New reference.'
Esta es una interfaz simplificada para @ref{4a4a,,PyRun_FileExFlags()} más abajo, dejando `closeit' establecido a @code{0}.
@end deffn

@geindex PyRun_FileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_FileExFlags}@anchor{4a4a}
@deffn {C Función} @ref{42d,,PyObject} *PyRun_FileExFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)
`Return value: New reference.'
Similar a @ref{4a48,,PyRun_StringFlags()}, pero el código fuente de Python se lee de `fp' en lugar de una cadena de caracteres en memoria. `filename' debe ser el nombre del fichero, es decodificado desde el @ref{5dd,,filesystem encoding and error handler}. Si `closeit' es verdadero, el fichero se cierra antes de que @ref{4a4a,,PyRun_FileExFlags()} retorne.
@end deffn

@geindex Py_CompileString (C function)
@anchor{c-api/veryhigh c Py_CompileString}@anchor{91d}
@deffn {C Función} @ref{42d,,PyObject} *Py_CompileString (const char *str, const char *filename, int start)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta es una interfaz simplificada para @ref{4a4d,,Py_CompileStringFlags()} más abajo, dejando `flags' establecido a @code{NULL}.
@end deffn

@geindex Py_CompileStringFlags (C function)
@anchor{c-api/veryhigh c Py_CompileStringFlags}@anchor{4a4d}
@deffn {C Función} @ref{42d,,PyObject} *Py_CompileStringFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags)
`Return value: New reference.'
Esta es una interfaz simplificada para @ref{4a4e,,Py_CompileStringExFlags()} más abajo, con `optimize' establecido a @code{-1}.
@end deffn

@geindex Py_CompileStringObject (C function)
@anchor{c-api/veryhigh c Py_CompileStringObject}@anchor{4a4f}
@deffn {C Función} @ref{42d,,PyObject} *Py_CompileStringObject (const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)
`Return value: New reference.'
Parse and compile the Python source code in `str', returning the resulting code
object.  The start token is given by `start'; this can be used to constrain the
code which can be compiled and should be @ref{4a3b,,Py_eval_input},
@ref{4a3c,,Py_file_input}, or @ref{4a3d,,Py_single_input}.  The filename specified by
`filename' is used to construct the code object and may appear in tracebacks or
@ref{150,,SyntaxError} exception messages.  This returns @code{NULL} if the code
cannot be parsed or compiled.

El número entero `optimize' especifica el nivel de optimización del compilador; un valor de @code{-1} selecciona el nivel de optimización del intérprete como se indica en las opciones @ref{14f,,-O}. Los niveles explícitos son @code{0} (sin optimización; @code{__debug__} es verdadero), @code{1} (los `asserts' se eliminan, @code{__debug__} es falso) o @code{2} (los docstrings también se eliminan) )


Added in version 3.4.

@end deffn

@geindex Py_CompileStringExFlags (C function)
@anchor{c-api/veryhigh c Py_CompileStringExFlags}@anchor{4a4e}
@deffn {C Función} @ref{42d,,PyObject} *Py_CompileStringExFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)
`Return value: New reference.'
Como @ref{4a4f,,Py_CompileStringObject()}, pero `filename' es una cadena de bytes decodificada a partir del @ref{5dd,,manejador de codificación y errores del sistema de archivos}.


Added in version 3.2.

@end deffn

@geindex PyEval_EvalCode (C function)
@anchor{c-api/veryhigh c PyEval_EvalCode}@anchor{91e}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_EvalCode (PyObject *co, PyObject *globals, PyObject *locals)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta es una interfaz simplificada para @ref{1771,,PyEval_EvalCodeEx()}, con solo el objeto de código y las variables globales y locales. Los otros argumentos están establecidos en @code{NULL}.
@end deffn

@geindex PyEval_EvalCodeEx (C function)
@anchor{c-api/veryhigh c PyEval_EvalCodeEx}@anchor{1771}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_EvalCodeEx (PyObject *co, PyObject *globals, PyObject *locals, PyObject *const *args, int argcount, PyObject *const *kws, int kwcount, PyObject *const *defs, int defcount, PyObject *kwdefs, PyObject *closure)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Evaluar un objeto de código precompilado, dado un entorno particular para su evaluación. Este entorno consta de un diccionario de variables globales, un objeto de mapeo de variables locales, arreglos de argumentos, palabras clave y valores predeterminados, un diccionario de valores predeterminados para argumentos @ref{3f4,,keyword-only} y  una tupla de cierre de células.
@end deffn

@geindex PyEval_EvalFrame (C function)
@anchor{c-api/veryhigh c PyEval_EvalFrame}@anchor{4929}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_EvalFrame (PyFrameObject *f)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Evaluar un marco de ejecución. Esta es una interfaz simplificada para @ref{10aa,,PyEval_EvalFrameEx()}, para compatibilidad con versiones anteriores.
@end deffn

@geindex PyEval_EvalFrameEx (C function)
@anchor{c-api/veryhigh c PyEval_EvalFrameEx}@anchor{10aa}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_EvalFrameEx (PyFrameObject *f, int throwflag)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta es la función principal sin barnizar de la interpretación de Python. El objeto de código asociado con el marco de ejecución del marco `f' se ejecuta, interpretando el código de bytes y ejecutando llamadas según sea necesario. El parámetro adicional `throwflag' se puede ignorar por lo general; si es verdadero, entonces se lanza una excepción de inmediato; esto se usa para los métodos @ref{59d,,throw()} de objetos generadores.


Distinto en la versión 3.4: Esta función ahora incluye una afirmación de depuración para ayudar a garantizar que no descarte silenciosamente una excepción activa.

@end deffn

@geindex PyEval_MergeCompilerFlags (C function)
@anchor{c-api/veryhigh c PyEval_MergeCompilerFlags}@anchor{4a50}
@deffn {C Función} int PyEval_MergeCompilerFlags (PyCompilerFlags *cf)

Esta función cambia los flags del marco de evaluación actual, y retorna verdad (`true') en caso de éxito, falso (`false') en caso de fallo.
@end deffn

@geindex Py_eval_input (C var)
@anchor{c-api/veryhigh c Py_eval_input}@anchor{4a3b}
@deffn {C Variable} int Py_eval_input

@geindex Py_CompileString (C function)

El símbolo de inicio de la gramática de Python para expresiones aisladas; para usar con @ref{91d,,Py_CompileString()}.
@end deffn

@geindex Py_file_input (C var)
@anchor{c-api/veryhigh c Py_file_input}@anchor{4a3c}
@deffn {C Variable} int Py_file_input

@geindex Py_CompileString (C function)

El símbolo de inicio de la gramática de Python para secuencias de declaración leídos desde un archivo u otra fuente; para usar con @ref{91d,,Py_CompileString()}. Este es el símbolo usado cuando se compile un código fuente en Python arbitrariamente largo.
@end deffn

@geindex Py_single_input (C var)
@anchor{c-api/veryhigh c Py_single_input}@anchor{4a3d}
@deffn {C Variable} int Py_single_input

@geindex Py_CompileString (C function)

El símbolo de inicio de la gramática de Python para una declaración única; para usar con @ref{91d,,Py_CompileString()}. Este es el símbolo usado para el bucle interactivo del intérprete.
@end deffn

@geindex PyCompilerFlags (C struct)
@anchor{c-api/veryhigh c PyCompilerFlags}@anchor{b2c}
@deffn {C Estructura} struct PyCompilerFlags

Esta es la estructura usada para contener los flags del compilador.  En casos donde el código es sólo compilado, es pasado como @code{int flags}, y en casos donde el código es ejecutado, es pasado como @code{PyCompilerFlags *flags}.  En este caso,  @code{from __future__ import} puede modificar los `flags'.

Whenever @code{PyCompilerFlags *flags} is @code{NULL}, @ref{4a51,,cf_flags} is treated as
equal to @code{0}, and any modification due to @code{from __future__ import} is
discarded.

@geindex PyCompilerFlags.cf_flags (C member)
@anchor{c-api/veryhigh c PyCompilerFlags cf_flags}@anchor{4a51}
@deffn {C Miembro} int cf_flags

Flags del compilador.
@end deffn

@geindex PyCompilerFlags.cf_feature_version (C member)
@anchor{c-api/veryhigh c PyCompilerFlags cf_feature_version}@anchor{4a52}
@deffn {C Miembro} int cf_feature_version

`cf_feature_version' es la versión menor de Python. Debe ser inicializado a @code{PY_MINOR_VERSION}.

The field is ignored by default, it is used if and only if
@code{PyCF_ONLY_AST} flag is set in @ref{4a51,,cf_flags}.
@end deffn


Distinto en la versión 3.8: Agregado el campo `cf_feature_version'.

@end deffn

@geindex CO_FUTURE_DIVISION (C var)
@anchor{c-api/veryhigh c CO_FUTURE_DIVISION}@anchor{4a53}
@deffn {C Variable} int CO_FUTURE_DIVISION

Este bit puede ser configurado en `flags' para causar que un operador de división @code{/} sea interpretado como una «división real» de acuerdo a 
@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}.
@end deffn

@node Conteo de referencias<2>,Manejo de excepciones,La capa de muy alto nivel,Manual de referencia de la API en C de Python
@anchor{c-api/refcounting doc}@anchor{4a54}@anchor{c-api/refcounting countingrefs}@anchor{4a55}@anchor{c-api/refcounting reference-counting}@anchor{4a56}
@section Conteo de referencias


The functions and macros in this section are used for managing reference counts
of Python objects.

@geindex Py_REFCNT (C function)
@anchor{c-api/refcounting c Py_REFCNT}@anchor{26f}
@deffn {C Función} @ref{af0,,Py_ssize_t} Py_REFCNT (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Get the reference count of the Python object `o'.

Note that the returned value may not actually reflect how many
references to the object are actually held.  For example, some
objects are @ref{429d,,immortal} and have a very high refcount that does not
reflect the actual number of references.  Consequently, do not rely
on the returned value to be accurate, other than a value of 0 or 1.

Use the @ref{942,,Py_SET_REFCNT()} function to set an object reference count.


Distinto en la versión 3.10: @ref{26f,,Py_REFCNT()} is changed to the inline static function.



Distinto en la versión 3.11: The parameter type is no longer const @ref{42d,,PyObject}*.

@end deffn

@geindex Py_SET_REFCNT (C function)
@anchor{c-api/refcounting c Py_SET_REFCNT}@anchor{942}
@deffn {C Función} void Py_SET_REFCNT (PyObject *o, Py_ssize_t refcnt)

Set the object `o' reference counter to `refcnt'.

On @ref{1d7e,,Python build with Free Threading}, if
`refcnt' is larger than @code{UINT32_MAX}, the object is made @ref{429d,,immortal}.

This function has no effect on @ref{429d,,immortal} objects.


Added in version 3.9.



Distinto en la versión 3.12: Immortal objects are not modified.

@end deffn

@geindex Py_INCREF (C function)
@anchor{c-api/refcounting c Py_INCREF}@anchor{612}
@deffn {C Función} void Py_INCREF (PyObject *o)

Indicate taking a new @ref{431,,strong reference} to object `o',
indicating it is in use and should not be destroyed.

This function has no effect on @ref{429d,,immortal} objects.

Esta función se usa generalmente para convertir un @ref{432,,borrowed reference} en un @ref{431,,strong reference} en su lugar. La función @ref{932,,Py_NewRef()} se puede utilizar para crear un nuevo @ref{431,,strong reference}.

When done using the object, release is by calling @ref{613,,Py_DECREF()}.

El objeto no debe ser @code{NULL}; si no está seguro de que no sea @code{NULL}, use @ref{af5,,Py_XINCREF()}.

Do not expect this function to actually modify `o' in any way.
For at least 
@geindex Python Enhancement Proposals; PEP 0683
some objects@footnote{https://peps.python.org/pep-0683/},
this function has no effect.


Distinto en la versión 3.12: Immortal objects are not modified.

@end deffn

@geindex Py_XINCREF (C function)
@anchor{c-api/refcounting c Py_XINCREF}@anchor{af5}
@deffn {C Función} void Py_XINCREF (PyObject *o)

Similar to @ref{612,,Py_INCREF()}, but the object `o' can be @code{NULL},
in which case this has no effect.

Ver también @ref{933,,Py_XNewRef()}.
@end deffn

@geindex Py_NewRef (C function)
@anchor{c-api/refcounting c Py_NewRef}@anchor{932}
@deffn {C Función} @ref{42d,,PyObject} *Py_NewRef (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Create a new @ref{431,,strong reference} to an object:
call @ref{612,,Py_INCREF()} on `o' and return the object `o'.

When the @ref{431,,strong reference} is no longer needed, @ref{613,,Py_DECREF()}
should be called on it to release the reference.

El objeto `o' no debe ser @code{NULL}; use @ref{933,,Py_XNewRef()} si `o' puede ser @code{NULL}.

Por ejemplo:

@example
Py_INCREF(obj);
self->attr = obj;
@end example

puede ser escrito como:

@example
self->attr = Py_NewRef(obj);
@end example

Ver también @ref{612,,Py_INCREF()}.


Added in version 3.10.

@end deffn

@geindex Py_XNewRef (C function)
@anchor{c-api/refcounting c Py_XNewRef}@anchor{933}
@deffn {C Función} @ref{42d,,PyObject} *Py_XNewRef (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Similar a @ref{932,,Py_NewRef()}, pero el objeto `o' puede ser NULL.

Si el objeto `o' es @code{NULL}, la función solo retorna @code{NULL}.


Added in version 3.10.

@end deffn

@geindex Py_DECREF (C function)
@anchor{c-api/refcounting c Py_DECREF}@anchor{613}
@deffn {C Función} void Py_DECREF (PyObject *o)

Release a @ref{431,,strong reference} to object `o', indicating the
reference is no longer used.

This function has no effect on @ref{429d,,immortal} objects.

Once the last @ref{431,,strong reference} is released
(i.e. the object’s reference count reaches 0),
the object’s type’s deallocation
function (which must not be @code{NULL}) is invoked.

Esta función se usa generalmente para eliminar un @ref{431,,strong reference} antes de salir de su alcance.

El objeto no debe ser @code{NULL}; si no está seguro de que no sea @code{NULL}, use @ref{af5,,Py_XINCREF()}.

Do not expect this function to actually modify `o' in any way.
For at least 
@geindex Python Enhancement Proposals; PEP 683
some objects@footnote{https://peps.python.org/pep-0683/},
this function has no effect.

@cartouche
@quotation Advertencia 
The deallocation function can cause arbitrary Python code to be invoked (e.g.
when a class instance with a @ref{1f60,,__del__()} method is deallocated).  While
exceptions in such code are not propagated, the executed code has free access to
all Python global variables.  This means that any object that is reachable from
a global variable should be in a consistent state before @ref{613,,Py_DECREF()} is
invoked.  For example, code to delete an object from a list should copy a
reference to the deleted object in a temporary variable, update the list data
structure, and then call @ref{613,,Py_DECREF()} for the temporary variable.
@end quotation
@end cartouche


Distinto en la versión 3.12: Immortal objects are not modified.

@end deffn

@geindex Py_XDECREF (C function)
@anchor{c-api/refcounting c Py_XDECREF}@anchor{828}
@deffn {C Función} void Py_XDECREF (PyObject *o)

Similar to @ref{613,,Py_DECREF()}, but the object `o' can be @code{NULL},
in which case this has no effect.
The same warning from @ref{613,,Py_DECREF()} applies here as well.
@end deffn

@geindex Py_CLEAR (C function)
@anchor{c-api/refcounting c Py_CLEAR}@anchor{61c}
@deffn {C Función} void Py_CLEAR (PyObject *o)

Release a @ref{431,,strong reference} for object `o'.
The object may be @code{NULL}, in
which case the macro has no effect; otherwise the effect is the same as for
@ref{613,,Py_DECREF()}, except that the argument is also set to @code{NULL}.  The warning
for @ref{613,,Py_DECREF()} does not apply with respect to the object passed because
the macro carefully uses a temporary variable and sets the argument to @code{NULL}
before releasing the reference.

It is a good idea to use this macro whenever releasing a reference
to an object that might be traversed during garbage collection.


Distinto en la versión 3.12: The macro argument is now only evaluated once. If the argument has side
effects, these are no longer duplicated.

@end deffn

@geindex Py_IncRef (C function)
@anchor{c-api/refcounting c Py_IncRef}@anchor{4a14}
@deffn {C Función} void Py_IncRef (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Indicate taking a new @ref{431,,strong reference} to object `o'.
A function version of @ref{af5,,Py_XINCREF()}.
It can be used for runtime dynamic embedding of Python.
@end deffn

@geindex Py_DecRef (C function)
@anchor{c-api/refcounting c Py_DecRef}@anchor{4a0d}
@deffn {C Función} void Py_DecRef (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Release a @ref{431,,strong reference} to object `o'.
A function version of @ref{828,,Py_XDECREF()}.
It can be used for runtime dynamic embedding of Python.
@end deffn

@geindex Py_SETREF (C macro)
@anchor{c-api/refcounting c Py_SETREF}@anchor{61d}
@deffn {C Macro} Py_SETREF (dst, src)

Macro safely releasing a @ref{431,,strong reference} to object `dst'
and setting `dst' to `src'.

As in case of @ref{61c,,Py_CLEAR()}, «the obvious» code can be deadly:

@example
Py_DECREF(dst);
dst = src;
@end example

The safe way is:

@example
Py_SETREF(dst, src);
@end example

That arranges to set `dst' to `src' _before_ releasing the reference
to the old value of `dst', so that any code triggered as a side-effect
of `dst' getting torn down no longer believes `dst' points
to a valid object.


Added in version 3.6.



Distinto en la versión 3.12: The macro arguments are now only evaluated once. If an argument has side
effects, these are no longer duplicated.

@end deffn

@geindex Py_XSETREF (C macro)
@anchor{c-api/refcounting c Py_XSETREF}@anchor{61e}
@deffn {C Macro} Py_XSETREF (dst, src)

Variant of @ref{61d,,Py_SETREF} macro that uses @ref{828,,Py_XDECREF()} instead
of @ref{613,,Py_DECREF()}.


Added in version 3.6.



Distinto en la versión 3.12: The macro arguments are now only evaluated once. If an argument has side
effects, these are no longer duplicated.

@end deffn

@node Manejo de excepciones,Utilidades<2>,Conteo de referencias<2>,Manual de referencia de la API en C de Python
@anchor{c-api/exceptions doc}@anchor{4a57}@anchor{c-api/exceptions exception-handling}@anchor{4a58}@anchor{c-api/exceptions exceptionhandling}@anchor{4306}
@section Manejo de excepciones


Las funciones descritas en este capítulo le permitirán manejar y lanzar excepciones de Python.  Es importante comprender algunos de los conceptos básicos del manejo de excepciones de Python.  Funciona de manera similar a la variable POSIX @code{errno}: hay un indicador global (por hilo) del último error que ocurrió.  La mayoría de las funciones de C API no borran esto en caso de éxito, pero lo configurarán para indicar la causa del error en caso de falla. La mayoría de las funciones de C API también retornan un indicador de error, generalmente @code{NULL} si se supone que retornan un puntero, o @code{-1} si retornan un número entero (excepción: las funciones @code{PyArg_*} retornan @code{1} para el éxito y @code{0} para el fracaso).

Concretamente, el indicador de error consta de tres punteros de objeto: el tipo de excepción, el valor de la excepción y el objeto de rastreo. Cualquiera de esos punteros puede ser @code{NULL} si no está configurado (aunque algunas combinaciones están prohibidas, por ejemplo, no puede tener un rastreo no @code{NULL} si el tipo de excepción es @code{NULL}).

Cuando una función debe fallar porque alguna función que llamó falló, generalmente no establece el indicador de error; la función que llamó ya lo configuró. Es responsable de manejar el error y borrar la excepción o regresar después de limpiar cualquier recurso que tenga (como referencias de objetos o asignaciones de memoria); debería `no' continuar normalmente si no está preparado para manejar el error. Si regresa debido a un error, es importante indicarle a la persona que llama que se ha establecido un error. Si el error no se maneja o se propaga cuidadosamente, es posible que las llamadas adicionales a la API de Python/C no se comporten como se espera y pueden fallar de manera misteriosa.

@cartouche
@quotation Nota 
The error indicator is `not' the result of @ref{72b,,sys.exc_info()}.
The former corresponds to an exception that is not yet caught (and is
therefore still propagating), while the latter returns an exception after
it is caught (and has therefore stopped propagating).
@end quotation
@end cartouche

@menu
* Impresión y limpieza:: 
* Lanzando excepciones: Lanzando excepciones<2>. 
* Emitir advertencias:: 
* Consultando el indicador de error:: 
* Manejo de señal:: 
* Clases de excepción:: 
* Objetos excepción:: 
* Objetos unicode de excepción:: 
* Control de recursión:: 
* Excepciones estándar:: 
* Categorías de advertencia estándar:: 

@end menu

@node Impresión y limpieza,Lanzando excepciones<2>,,Manejo de excepciones
@anchor{c-api/exceptions printing-and-clearing}@anchor{4a59}
@subsection Impresión y limpieza


@geindex PyErr_Clear (C function)
@anchor{c-api/exceptions c PyErr_Clear}@anchor{10ad}
@deffn {C Función} void PyErr_Clear ()
` Part of the @ref{5f6,,Stable ABI}.'
Borra el indicador de error. Si el indicador de error no está configurado, no hay efecto.
@end deffn

@geindex PyErr_PrintEx (C function)
@anchor{c-api/exceptions c PyErr_PrintEx}@anchor{491d}
@deffn {C Función} void PyErr_PrintEx (int set_sys_last_vars)
` Part of the @ref{5f6,,Stable ABI}.'
Imprime un rastreo estándar en @code{sys.stderr} y borra el indicador de error. `A menos que' el error sea un @code{Salida del sistema}, en ese caso no se imprime ningún rastreo y el proceso de Python se cerrará con el código de error especificado por la instancia de @code{Salida del sistema}.

Llame a esta función `solo' cuando el indicador de error está configurado. De lo contrario, provocará un error fatal!

If `set_sys_last_vars' is nonzero, the variable @ref{565,,sys.last_exc} is
set to the printed exception. For backwards compatibility, the
deprecated variables @ref{566,,sys.last_type}, @ref{567,,sys.last_value} and
@ref{568,,sys.last_traceback} are also set to the type, value and traceback
of this exception, respectively.


Distinto en la versión 3.12: The setting of @ref{565,,sys.last_exc} was added.

@end deffn

@geindex PyErr_Print (C function)
@anchor{c-api/exceptions c PyErr_Print}@anchor{194f}
@deffn {C Función} void PyErr_Print ()
` Part of the @ref{5f6,,Stable ABI}.'
Alias para @code{PyErr_PrintEx(1)}.
@end deffn

@geindex PyErr_WriteUnraisable (C function)
@anchor{c-api/exceptions c PyErr_WriteUnraisable}@anchor{443}
@deffn {C Función} void PyErr_WriteUnraisable (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI}.'
Llama @ref{355,,sys.unraisablehook()} utilizando la excepción actual y el argumento `obj'.

This utility function prints a warning message to @code{sys.stderr} when an
exception has been set but it is impossible for the interpreter to actually
raise the exception.  It is used, for example, when an exception occurs in an
@ref{1f60,,__del__()} method.

The function is called with a single argument `obj' that identifies the context
in which the unraisable exception occurred. If possible,
the repr of `obj' will be printed in the warning message.
If `obj' is @code{NULL}, only the traceback is printed.

Se debe establecer una excepción al llamar a esta función.


Distinto en la versión 3.4: Print a traceback. Print only traceback if `obj' is @code{NULL}.



Distinto en la versión 3.8: Use @ref{355,,sys.unraisablehook()}.

@end deffn

@geindex PyErr_FormatUnraisable (C function)
@anchor{c-api/exceptions c PyErr_FormatUnraisable}@anchor{442}
@deffn {C Función} void PyErr_FormatUnraisable (const char *format, ...)

Similar to @ref{443,,PyErr_WriteUnraisable()}, but the `format' and subsequent
parameters help format the warning message; they have the same meaning and
values as in @ref{47c,,PyUnicode_FromFormat()}.
@code{PyErr_WriteUnraisable(obj)} is roughly equivalent to
@code{PyErr_FormatUnraisable("Exception ignored in: %R", obj)}.
If `format' is @code{NULL}, only the traceback is printed.


Added in version 3.13.

@end deffn

@geindex PyErr_DisplayException (C function)
@anchor{c-api/exceptions c PyErr_DisplayException}@anchor{299}
@deffn {C Función} void PyErr_DisplayException (PyObject *exc)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Print the standard traceback display of @code{exc} to @code{sys.stderr}, including
chained exceptions and notes.


Added in version 3.12.

@end deffn

@node Lanzando excepciones<2>,Emitir advertencias,Impresión y limpieza,Manejo de excepciones
@anchor{c-api/exceptions raising-exceptions}@anchor{4a5a}
@subsection Lanzando excepciones


Estas funciones lo ayudan a configurar el indicador de error del hilo actual. Por conveniencia, algunas de estas funciones siempre retornarán un puntero @code{NULL} para usar en una declaración @code{return}.

@geindex PyErr_SetString (C function)
@anchor{c-api/exceptions c PyErr_SetString}@anchor{620}
@deffn {C Función} void PyErr_SetString (PyObject *type, const char *message)
` Part of the @ref{5f6,,Stable ABI}.'
This is the most common way to set the error indicator.  The first argument
specifies the exception type; it is normally one of the standard exceptions,
e.g. @code{PyExc_RuntimeError}.  You need not create a new
@ref{431,,strong reference} to it (e.g. with @ref{612,,Py_INCREF()}).
The second argument is an error message; it is decoded from @code{'utf-8'}.
@end deffn

@geindex PyErr_SetObject (C function)
@anchor{c-api/exceptions c PyErr_SetObject}@anchor{61f}
@deffn {C Función} void PyErr_SetObject (PyObject *type, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Esta función es similar a @ref{620,,PyErr_SetString()} pero le permite especificar un objeto Python arbitrario para el «valor» de la excepción.
@end deffn

@geindex PyErr_Format (C function)
@anchor{c-api/exceptions c PyErr_Format}@anchor{f32}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_Format (PyObject *exception, const char *format, ...)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
Esta función establece el indicador de error y retorna @code{NULL}. `exception' debe ser una clase de excepción Python. El `format' y los parámetros posteriores ayudan a formatear el mensaje de error; tienen el mismo significado y valores que en @ref{47c,,PyUnicode_FromFormat()}. `format' es una cadena de caracteres codificada en ASCII.
@end deffn

@geindex PyErr_FormatV (C function)
@anchor{c-api/exceptions c PyErr_FormatV}@anchor{f31}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_FormatV (PyObject *exception, const char *format, va_list vargs)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} since version 3.5.'
Igual que @ref{f32,,PyErr_Format()}, pero tomando un argumento @code{va_list} en lugar de un número variable de argumentos.


Added in version 3.5.

@end deffn

@geindex PyErr_SetNone (C function)
@anchor{c-api/exceptions c PyErr_SetNone}@anchor{4925}
@deffn {C Función} void PyErr_SetNone (PyObject *type)
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una abreviatura de @code{PyErr_SetObject(type, Py_None)}.
@end deffn

@geindex PyErr_BadArgument (C function)
@anchor{c-api/exceptions c PyErr_BadArgument}@anchor{491a}
@deffn {C Función} int PyErr_BadArgument ()
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una abreviatura de @code{PyErr_SetString(PyExc_TypeError, message)}, donde `message' indica que se invocó una operación incorporada con un argumento ilegal. Es principalmente para uso interno.
@end deffn

@geindex PyErr_NoMemory (C function)
@anchor{c-api/exceptions c PyErr_NoMemory}@anchor{482e}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_NoMemory ()
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
Esta es una abreviatura de @code{PyErr_SetNone(PyExc_MemoryError)}; retorna @code{NULL} para que una función de asignación de objetos pueda escribir @code{return PyErr_NoMemory();} cuando se queda sin memoria.
@end deffn

@geindex PyErr_SetFromErrno (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrno}@anchor{482d}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromErrno (PyObject *type)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex strerror (C function)

This is a convenience function to raise an exception when a C library function
has returned an error and set the C variable @code{errno}.  It constructs a
tuple object whose first item is the integer @code{errno} value and whose
second item is the corresponding error message (gotten from @code{strerror()}),
and then calls @code{PyErr_SetObject(type, object)}.  On Unix, when the
@code{errno} value is @code{EINTR}, indicating an interrupted system call,
this calls @ref{512,,PyErr_CheckSignals()}, and if that set the error indicator,
leaves it set to that.  The function always returns @code{NULL}, so a wrapper
function around a system call can write @code{return PyErr_SetFromErrno(type);}
when the system call returns an error.
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObject (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObject}@anchor{4921}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromErrnoWithFilenameObject (PyObject *type, PyObject *filenameObject)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
Similar to @ref{482d,,PyErr_SetFromErrno()}, with the additional behavior that if
`filenameObject' is not @code{NULL}, it is passed to the constructor of `type' as
a third parameter.  In the case of @ref{4d5,,OSError} exception,
this is used to define the @code{filename} attribute of the
exception instance.
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObjects (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObjects}@anchor{4922}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromErrnoWithFilenameObjects (PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Similar a @ref{4921,,PyErr_SetFromErrnoWithFilenameObject()}, pero toma un segundo objeto de nombre de archivo, para lanzar errores cuando falla una función que toma dos nombres de archivo.


Added in version 3.4.

@end deffn

@geindex PyErr_SetFromErrnoWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilename}@anchor{171d}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromErrnoWithFilename (PyObject *type, const char *filename)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4921,,PyErr_SetFromErrnoWithFilenameObject()}, pero el nombre del archivo se da como una cadena de caracteres de C. `filename' se decodifica a partir de la codificación de @ref{5dd,,filesystem encoding and error handler}.
@end deffn

@geindex PyErr_SetFromWindowsErr (C function)
@anchor{c-api/exceptions c PyErr_SetFromWindowsErr}@anchor{4923}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromWindowsErr (int ierr)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
This is a convenience function to raise @ref{4d5,,OSError}. If called with
`ierr' of @code{0}, the error code returned by a call to @code{GetLastError()}
is used instead.  It calls the Win32 function @code{FormatMessage()} to retrieve
the Windows description of error code given by `ierr' or @code{GetLastError()},
then it constructs a @ref{4d5,,OSError} object with the @ref{2291,,winerror}
attribute set to the error code, the @ref{2292,,strerror} attribute
set to the corresponding error message (gotten from
@code{FormatMessage()}), and then calls @code{PyErr_SetObject(PyExc_OSError,
object)}. This function always returns @code{NULL}.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErr (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErr}@anchor{491e}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetExcFromWindowsErr (PyObject *type, int ierr)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Similar a @ref{4923,,PyErr_SetFromWindowsErr()}, con un parámetro adicional que especifica el tipo de excepción que se lanzará.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex PyErr_SetFromWindowsErrWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetFromWindowsErrWithFilename}@anchor{171f}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetFromWindowsErrWithFilename (int ierr, const char *filename)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Similar to @ref{4923,,PyErr_SetFromWindowsErr()}, with the additional behavior
that if `filename' is not @code{NULL}, it is decoded from the filesystem
encoding (@ref{cdc,,os.fsdecode()}) and passed to the constructor of
@ref{4d5,,OSError} as a third parameter to be used to define the
@code{filename} attribute of the exception instance.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObject (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObject}@anchor{491f}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObject (PyObject *type, int ierr, PyObject *filename)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Similar to @ref{491e,,PyErr_SetExcFromWindowsErr()}, with the additional behavior
that if `filename' is not @code{NULL}, it is passed to the constructor of
@ref{4d5,,OSError} as a third parameter to be used to define the
@code{filename} attribute of the exception instance.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObjects (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObjects}@anchor{4920}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObjects (PyObject *type, int ierr, PyObject *filename, PyObject *filename2)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Similar a @ref{491f,,PyErr_SetExcFromWindowsErrWithFilenameObject()}, pero acepta un segundo objeto de nombre de archivo.

@ref{1d5a,,Availability}: Windows.


Added in version 3.4.

@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilename}@anchor{171e}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetExcFromWindowsErrWithFilename (PyObject *type, int ierr, const char *filename)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Similar a @ref{171f,,PyErr_SetFromWindowsErrWithFilename()}, con un parámetro adicional que especifica el tipo de excepción que se lanzará.

@ref{1d5a,,Availability}: Windows.
@end deffn

@geindex PyErr_SetImportError (C function)
@anchor{c-api/exceptions c PyErr_SetImportError}@anchor{dc5}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetImportError (PyObject *msg, PyObject *name, PyObject *path)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Esta es una función conveniente para subir @ref{4d7,,ImportError}. `msg' se establecerá como la cadena de mensaje de la excepción. `name' y `path', que pueden ser @code{NULL}, se establecerán como atributos respectivos @code{name} y @code{path} de @ref{4d7,,ImportError}.


Added in version 3.3.

@end deffn

@geindex PyErr_SetImportErrorSubclass (C function)
@anchor{c-api/exceptions c PyErr_SetImportErrorSubclass}@anchor{d9d}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_SetImportErrorSubclass (PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI} since version 3.6.'
Al igual que @ref{dc5,,PyErr_SetImportError()} pero esta función permite especificar una subclase de @ref{4d7,,ImportError} para aumentar.


Added in version 3.6.

@end deffn

@geindex PyErr_SyntaxLocationObject (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocationObject}@anchor{4a5b}
@deffn {C Función} void PyErr_SyntaxLocationObject (PyObject *filename, int lineno, int col_offset)

Establece información de archivo, línea y desplazamiento para la excepción actual. Si la excepción actual no es un @ref{150,,SyntaxError}, establece atributos adicionales, lo que hace que el sub sistema de impresión de excepciones piense que la excepción es @ref{150,,SyntaxError}.


Added in version 3.4.

@end deffn

@geindex PyErr_SyntaxLocationEx (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocationEx}@anchor{4927}
@deffn {C Función} void PyErr_SyntaxLocationEx (const char *filename, int lineno, int col_offset)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Como @ref{4a5b,,PyErr_SyntaxLocationObject()}, pero `filename' es una cadena de bytes decodificada a partir de @ref{5dd,,filesystem encoding and error handler}.


Added in version 3.2.

@end deffn

@geindex PyErr_SyntaxLocation (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocation}@anchor{4926}
@deffn {C Función} void PyErr_SyntaxLocation (const char *filename, int lineno)
` Part of the @ref{5f6,,Stable ABI}.'
Como @ref{4927,,PyErr_SyntaxLocationEx()}, pero se omite el parámetro `col_offset'.
@end deffn

@geindex PyErr_BadInternalCall (C function)
@anchor{c-api/exceptions c PyErr_BadInternalCall}@anchor{491b}
@deffn {C Función} void PyErr_BadInternalCall ()
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una abreviatura de @code{PyErr_SetString(PyExc_SystemError, message)}, donde `message' indica que se invocó una operación interna (por ejemplo, una función de Python/C API) con un argumento ilegal. Es principalmente para uso interno.
@end deffn

@node Emitir advertencias,Consultando el indicador de error,Lanzando excepciones<2>,Manejo de excepciones
@anchor{c-api/exceptions issuing-warnings}@anchor{4a5c}
@subsection Emitir advertencias


Use estas funciones para emitir advertencias desde el código C. Reflejan funciones similares exportadas por el módulo Python @ref{112,,warnings}. Normalmente imprimen un mensaje de advertencia a `sys.stderr'; sin embargo, también es posible que el usuario haya especificado que las advertencias se conviertan en errores, y en ese caso lanzarán una excepción. También es posible que las funciones generen una excepción debido a un problema con la maquinaria de advertencia. El valor de retorno es @code{0} si no se lanza una excepción, o @code{-1} si se lanza una excepción. (No es posible determinar si realmente se imprime un mensaje de advertencia, ni cuál es el motivo de la excepción; esto es intencional). Si se produce una excepción, la persona que llama debe hacer su manejo normal de excepciones (por ejemplo, referencias propiedad de @ref{613,,Py_DECREF()} y retornan un valor de error).

@geindex PyErr_WarnEx (C function)
@anchor{c-api/exceptions c PyErr_WarnEx}@anchor{148a}
@deffn {C Función} int PyErr_WarnEx (PyObject *category, const char *message, Py_ssize_t stack_level)
` Part of the @ref{5f6,,Stable ABI}.'
Emite un mensaje de advertencia. El argumento `category' es una categoría de advertencia (ver más abajo) o @code{NULL}; el argumento `message' es una cadena de caracteres codificada en UTF-8. `stack_level' es un número positivo que proporciona una cantidad de marcos de pila; la advertencia se emitirá desde la línea de código que se está ejecutando actualmente en ese marco de pila. Un `stack_level' de 1 es la función que llama @ref{148a,,PyErr_WarnEx()}, 2 es la función por encima de eso, y así sucesivamente.

Las categorías de advertencia deben ser subclases de @code{PyExc_Warning}; @code{PyExc_Warning} es una subclase de @code{PyExc_Exception}; la categoría de advertencia predeterminada es @code{PyExc_RuntimeWarning}. Las categorías de advertencia estándar de Python están disponibles como variables globales cuyos nombres se enumeran en @ref{4a5d,,Categorías de advertencia estándar}.

Para obtener información sobre el control de advertencia, consulte la documentación del módulo @ref{112,,warnings} y la opción @ref{95e,,-W} en la documentación de la línea de comandos. No hay API de C para el control de advertencia.
@end deffn

@geindex PyErr_WarnExplicitObject (C function)
@anchor{c-api/exceptions c PyErr_WarnExplicitObject}@anchor{4a5e}
@deffn {C Función} int PyErr_WarnExplicitObject (PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)

Emite un mensaje de advertencia con control explícito sobre todos los atributos de advertencia.  Este es un contenedor sencillo alrededor de la función Python @ref{d87,,warnings.warn_explicit()}; consulte allí para obtener más información.  Los argumentos `module' y `registry' pueden establecerse en @code{NULL} para obtener el efecto predeterminado que se describe allí.


Added in version 3.4.

@end deffn

@geindex PyErr_WarnExplicit (C function)
@anchor{c-api/exceptions c PyErr_WarnExplicit}@anchor{1726}
@deffn {C Función} int PyErr_WarnExplicit (PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)
` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4a5e,,PyErr_WarnExplicitObject()} excepto que `message' y `module' son cadenas codificadas UTF-8, y `filename' se decodifica de @ref{5dd,,filesystem encoding and error handler}.
@end deffn

@geindex PyErr_WarnFormat (C function)
@anchor{c-api/exceptions c PyErr_WarnFormat}@anchor{4928}
@deffn {C Función} int PyErr_WarnFormat (PyObject *category, Py_ssize_t stack_level, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Función similar a @ref{148a,,PyErr_WarnEx()}, pero usa @ref{47c,,PyUnicode_FromFormat()} para formatear el mensaje de advertencia. `format' es una cadena de caracteres codificada en ASCII.


Added in version 3.2.

@end deffn

@geindex PyErr_ResourceWarning (C function)
@anchor{c-api/exceptions c PyErr_ResourceWarning}@anchor{d9e}
@deffn {C Función} int PyErr_ResourceWarning (PyObject *source, Py_ssize_t stack_level, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI} since version 3.6.'
Function similar to @ref{4928,,PyErr_WarnFormat()}, but `category' is
@ref{39d,,ResourceWarning} and it passes `source' to @code{warnings.WarningMessage}.


Added in version 3.6.

@end deffn

@node Consultando el indicador de error,Manejo de señal,Emitir advertencias,Manejo de excepciones
@anchor{c-api/exceptions querying-the-error-indicator}@anchor{4a5f}
@subsection Consultando el indicador de error


@geindex PyErr_Occurred (C function)
@anchor{c-api/exceptions c PyErr_Occurred}@anchor{18fa}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_Occurred ()
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Prueba si el indicador de error está configurado.  Si se establece, retorna la excepción `type' (el primer argumento de la última llamada a una de las funciones @code{PyErr_Set*} o @ref{28d,,PyErr_Restore()}).  Si no está configurado, retorna @code{NULL}.  No posee una referencia al valor de retorno, por lo que no necesita usar @ref{613,,Py_DECREF()}.

La persona que llama debe retener el GIL.

@cartouche
@quotation Nota 
No compare el valor de retorno con una excepción específica; use @ref{48c5,,PyErr_ExceptionMatches()} en su lugar, como se muestra a continuación. (La comparación podría fallar fácilmente ya que la excepción puede ser una instancia en lugar de una clase, en el caso de una excepción de clase, o puede ser una subclase de la excepción esperada).
@end quotation
@end cartouche
@end deffn

@geindex PyErr_ExceptionMatches (C function)
@anchor{c-api/exceptions c PyErr_ExceptionMatches}@anchor{48c5}
@deffn {C Función} int PyErr_ExceptionMatches (PyObject *exc)
` Part of the @ref{5f6,,Stable ABI}.'
Equivalente a @code{PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)}. Esto solo debería llamarse cuando se establece una excepción; se producirá una infracción de acceso a la memoria si no se ha producido ninguna excepción.
@end deffn

@geindex PyErr_GivenExceptionMatches (C function)
@anchor{c-api/exceptions c PyErr_GivenExceptionMatches}@anchor{491c}
@deffn {C Función} int PyErr_GivenExceptionMatches (PyObject *given, PyObject *exc)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna verdadero si la excepción `dada' coincide con el tipo de excepción en `exc'. Si `exc' es un objeto de clase, esto también retorna verdadero cuando `dado' es una instancia de una subclase. Si `exc' es una tupla, se busca una coincidencia en todos los tipos de excepción en la tupla (y recursivamente en sub tuplas).
@end deffn

@geindex PyErr_GetRaisedException (C function)
@anchor{c-api/exceptions c PyErr_GetRaisedException}@anchor{28b}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_GetRaisedException (void)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Return the exception currently being raised, clearing the error indicator at
the same time. Return @code{NULL} if the error indicator is not set.

This function is used by code that needs to catch exceptions,
or code that needs to save and restore the error indicator temporarily.

For example:

@example
@{
   PyObject *exc = PyErr_GetRaisedException();

   /* ... code that might produce other errors ... */

   PyErr_SetRaisedException(exc);
@}
@end example


@subsubheading Ver también


@ref{809,,PyErr_GetHandledException()},
to save the exception currently being handled.



Added in version 3.12.

@end deffn

@geindex PyErr_SetRaisedException (C function)
@anchor{c-api/exceptions c PyErr_SetRaisedException}@anchor{28e}
@deffn {C Función} void PyErr_SetRaisedException (PyObject *exc)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Set `exc' as the exception currently being raised,
clearing the existing exception if one is set.

@cartouche
@quotation Advertencia 
This call steals a reference to `exc', which must be a valid exception.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex PyErr_Fetch (C function)
@anchor{c-api/exceptions c PyErr_Fetch}@anchor{28a}
@deffn {C Función} void PyErr_Fetch (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.12: Use @ref{28b,,PyErr_GetRaisedException()} instead.


Recupera el indicador de error en tres variables cuyas direcciones se pasan. Si el indicador de error no está configurado, configure las tres variables en @code{NULL}.  Si está configurado, se borrará y usted tendrá una referencia a cada objeto recuperado. El objeto de valor y rastreo puede ser @code{NULL} incluso cuando el objeto de tipo no lo es.

@cartouche
@quotation Nota 
This function is normally only used by legacy code that needs to catch
exceptions or save and restore the error indicator temporarily.

For example:

@example
@{
   PyObject *type, *value, *traceback;
   PyErr_Fetch(&type, &value, &traceback);

   /* ... code that might produce other errors ... */

   PyErr_Restore(type, value, traceback);
@}
@end example
@end quotation
@end cartouche
@end deffn

@geindex PyErr_Restore (C function)
@anchor{c-api/exceptions c PyErr_Restore}@anchor{28d}
@deffn {C Función} void PyErr_Restore (PyObject *type, PyObject *value, PyObject *traceback)
` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.12: Use @ref{28e,,PyErr_SetRaisedException()} instead.


Set the error indicator from the three objects,
`type', `value', and `traceback',
clearing the existing exception if one is set.
If the objects are @code{NULL}, the error
indicator is cleared.  Do not pass a @code{NULL} type and non-@code{NULL} value or
traceback.  The exception type should be a class.  Do not pass an invalid
exception type or value. (Violating these rules will cause subtle problems
later.)  This call takes away a reference to each object: you must own a
reference to each object before the call and after the call you no longer own
these references.  (If you don’t understand this, don’t use this function.  I
warned you.)

@cartouche
@quotation Nota 
This function is normally only used by legacy code that needs to
save and restore the error indicator temporarily.
Use @ref{28a,,PyErr_Fetch()} to save the current error indicator.
@end quotation
@end cartouche
@end deffn

@geindex PyErr_NormalizeException (C function)
@anchor{c-api/exceptions c PyErr_NormalizeException}@anchor{28c}
@deffn {C Función} void PyErr_NormalizeException (PyObject **exc, PyObject **val, PyObject **tb)
` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.12: Use @ref{28b,,PyErr_GetRaisedException()} instead,
to avoid any possible de-normalization.


Bajo ciertas circunstancias, los valores retornados por @ref{28a,,PyErr_Fetch()} a continuación pueden ser «no normalizados», lo que significa que @code{*exc} es un objeto de clase pero @code{*val} no es una instancia de la misma clase . Esta función se puede utilizar para crear instancias de la clase en ese caso. Si los valores ya están normalizados, no pasa nada. La normalización retrasada se implementa para mejorar el rendimiento.

@cartouche
@quotation Nota 
This function `does not' implicitly set the
@ref{1330,,__traceback__}
attribute on the exception value. If setting the traceback
appropriately is desired, the following additional snippet is needed:

@example
if (tb != NULL) @{
  PyException_SetTraceback(val, tb);
@}
@end example
@end quotation
@end cartouche
@end deffn

@geindex PyErr_GetHandledException (C function)
@anchor{c-api/exceptions c PyErr_GetHandledException}@anchor{809}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_GetHandledException (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Recupera la instancia de excepción activa, como la que devolvería @ref{72c,,sys.exception()}. Esto se refiere a una excepción que `ya fue capturada', no a una excepción recién lanzada. Retorna una nueva referencia a la excepción o @code{NULL}. No modifica el estado de excepción del intérprete.

@cartouche
@quotation Nota 
Esta función normalmente no es utilizada por el código que quiere manejar excepciones. En cambio, se puede usar cuando el código necesita guardar y restaurar el estado de excepción temporalmente.   Use @ref{80a,,PyErr_SetHandledException()} para restaurar o borrar el estado de excepción.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex PyErr_SetHandledException (C function)
@anchor{c-api/exceptions c PyErr_SetHandledException}@anchor{80a}
@deffn {C Función} void PyErr_SetHandledException (PyObject *exc)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Establece la excepción activa, como se conoce de @code{sys.exception()}.  Esto se refiere a la excepción que `ya fue capturada', no a una excepción que fue lanzada recientemente. Para borrar el estado de la excepción, pasa @code{NULL}.

@cartouche
@quotation Nota 
Esta función normalmente no es utilizada por el código que quiere manejar excepciones. En cambio, se puede usar cuando el código necesita guardar y restaurar el estado de excepción temporalmente. Use @ref{809,,PyErr_GetHandledException()} para leer el estado de excepción.
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex PyErr_GetExcInfo (C function)
@anchor{c-api/exceptions c PyErr_GetExcInfo}@anchor{80c}
@deffn {C Función} void PyErr_GetExcInfo (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Recupera la información de excepción, como se conoce de @ref{72b,,sys.exc_info()}.  Esto se refiere a una excepción que `ya fue capturada', no a una excepción que fue lanzada recientemente.  Retorna nuevas referencias para los tres objetos, cualquiera de los cuales puede ser @code{NULL}.  No modifica el estado de información de excepción.  Esta función se mantiene por retro-compatibilidad. Es preferible usar @ref{809,,PyErr_GetHandledException()}.

@cartouche
@quotation Nota 
Esta función normalmente no es utilizada por el código que quiere manejar excepciones. En cambio, se puede usar cuando el código necesita guardar y restaurar el estado de excepción temporalmente. Use @ref{80b,,PyErr_SetExcInfo()} para restaurar o borrar el estado de excepción.
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex PyErr_SetExcInfo (C function)
@anchor{c-api/exceptions c PyErr_SetExcInfo}@anchor{80b}
@deffn {C Función} void PyErr_SetExcInfo (PyObject *type, PyObject *value, PyObject *traceback)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Establece la información de excepción, como se conoce de @code{sys.exc_info()}.  Esto se refiere a una excepción que `ya fue capturada', no a una excepción que fue lanzada recientemente.  Esta función roba las referencias de los argumentos. Para borrar el estado de excepción, pase @code{NULL} para los tres argumentos. Para ver las reglas generales sobre los tres argumentos, consulte @ref{80a,,PyErr_SetHandledException()}.

@cartouche
@quotation Nota 
Esta función normalmente no es utilizada por el código que quiere manejar excepciones. En cambio, se puede usar cuando el código necesita guardar y restaurar el estado de excepción temporalmente. Use @ref{80c,,PyErr_GetExcInfo()} para leer el estado de excepción.
@end quotation
@end cartouche


Added in version 3.3.



Distinto en la versión 3.11: Los argumentos @code{type} y @code{traceback} ya no se utilizan y pueden ser NULL. El intérprete los deriva ahora de la instancia de la excepción (el argumento @code{value}). La función sigue robando referencias de los tres argumentos.

@end deffn

@node Manejo de señal,Clases de excepción,Consultando el indicador de error,Manejo de excepciones
@anchor{c-api/exceptions signal-handling}@anchor{4a60}
@subsection Manejo de señal


@geindex PyErr_CheckSignals (C function)
@anchor{c-api/exceptions c PyErr_CheckSignals}@anchor{512}
@deffn {C Función} int PyErr_CheckSignals ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex module;signal
@geindex SIGINT (C macro)
@geindex KeyboardInterrupt (built-in exception)

Esta función interactúa con el manejo de señales de Python.

Si la función se llama desde el hilo principal y bajo el intérprete principal de Python, verifica si se ha enviado una señal a los procesos y, de ser así, invoca el manejador de señales correspondiente. Si el módulo @ref{c6,,signal} es compatible, esto puede invocar un manejador de señales escrito en Python.

La función intenta manejar todas las señales pendientes y luego devuelve @code{0}. Sin embargo, si un manejador de señales de Python lanza una excepción, el indicador de error se establece y la función devuelve @code{-1} inmediatamente (de modo que es posible que otras señales pendientes no se hayan manejado todavía: estarán en la siguiente invocación de @ref{512,,PyErr_CheckSignals()}).

Si la función se llama desde un hilo no principal, o bajo un intérprete de Python no principal, no hace nada y devuelve @code{0}.

Esta función se puede llamar mediante un código C de ejecución prolongada que quiere ser interrumpible por las peticiones del usuario (como presionar Ctrl-C).

@cartouche
@quotation Nota 
The default Python signal handler for @code{SIGINT} raises the
@ref{a63,,KeyboardInterrupt} exception.
@end quotation
@end cartouche
@end deffn

@geindex PyErr_SetInterrupt (C function)
@anchor{c-api/exceptions c PyErr_SetInterrupt}@anchor{4924}
@deffn {C Función} void PyErr_SetInterrupt ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex module;signal
@geindex SIGINT (C macro)
@geindex KeyboardInterrupt (built-in exception)

Simulate the effect of a @code{SIGINT} signal arriving.
This is equivalent to @code{PyErr_SetInterruptEx(SIGINT)}.

@cartouche
@quotation Nota 
Esta función es segura para señales asíncronas. Se puede llamar sin el @ref{2c5,,GIL} y desde un manejador de señales de C.
@end quotation
@end cartouche
@end deffn

@geindex PyErr_SetInterruptEx (C function)
@anchor{c-api/exceptions c PyErr_SetInterruptEx}@anchor{936}
@deffn {C Función} int PyErr_SetInterruptEx (int signum)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
@geindex module;signal
@geindex KeyboardInterrupt (built-in exception)

Simula el efecto de la llegada de una señal. La próxima vez que sea llamado @ref{512,,PyErr_CheckSignals()}, se llamará al manejador de señal de Python para el número de señal dado.

Esta función puede ser llamada por código C que configura su propio manejo de señales y quiere que los manejadores de señales de Python sean invocados como se espera cuando se solicita una interrupción (por ejemplo, cuando el usuario presiona Ctrl-C para interrumpir una operación).

If the given signal isn’t handled by Python (it was set to
@ref{1828,,signal.SIG_DFL} or @ref{1827,,signal.SIG_IGN}), it will be ignored.

Si `signum' está fuera del rango permitido de números de señal, se devuelve @code{-1}. De lo contrario, se devuelve @code{0}. Esta función nunca cambia el indicador de error.

@cartouche
@quotation Nota 
Esta función es segura para señales asíncronas. Se puede llamar sin el @ref{2c5,,GIL} y desde un manejador de señales de C.
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@geindex PySignal_SetWakeupFd (C function)
@anchor{c-api/exceptions c PySignal_SetWakeupFd}@anchor{141b}
@deffn {C Función} int PySignal_SetWakeupFd (int fd)

Esta función de utilidad especifica un descriptor de archivo en el que el número de señal se escribe como un solo byte cada vez que se recibe una señal. `fd' debe ser sin bloqueo. retorna el descriptor de archivo anterior.

El valor @code{-1} desactiva la función; Este es el estado inicial. Esto es equivalente a @ref{bf8,,signal.set_wakeup_fd()} en Python, pero sin verificación de errores. `fd' debe ser un descriptor de archivo válido. La función solo debe llamarse desde el hilo principal.


Distinto en la versión 3.5: En Windows, la función ahora también admite controladores de socket.

@end deffn

@node Clases de excepción,Objetos excepción,Manejo de señal,Manejo de excepciones
@anchor{c-api/exceptions exception-classes}@anchor{4a61}
@subsection Clases de excepción


@geindex PyErr_NewException (C function)
@anchor{c-api/exceptions c PyErr_NewException}@anchor{12d7}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_NewException (const char *name, PyObject *base, PyObject *dict)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta función de utilidad crea y retorna una nueva clase de excepción. El argumento `name' debe ser el nombre de la nueva excepción, una cadena de caracteres en C de la forma @code{module.classname}. Los argumentos `base' y `dict' son normalmente @code{NULL}. Esto crea un objeto de clase derivado de @ref{a6b,,Exception} (accesible en C como @code{PyExc_Exception}).

The @ref{468,,__module__} attribute of the new class is set to the first part (up
to the last dot) of the `name' argument, and the class name is set to the last
part (after the last dot).  The `base' argument can be used to specify alternate
base classes; it can either be only one class or a tuple of classes. The `dict'
argument can be used to specify a dictionary of class variables and methods.
@end deffn

@geindex PyErr_NewExceptionWithDoc (C function)
@anchor{c-api/exceptions c PyErr_NewExceptionWithDoc}@anchor{12d6}
@deffn {C Función} @ref{42d,,PyObject} *PyErr_NewExceptionWithDoc (const char *name, const char *doc, PyObject *base, PyObject *dict)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Igual que @ref{12d7,,PyErr_NewException()}, excepto que la nueva clase de excepción puede recibir fácilmente una cadena de documentación: si `doc' no es @code{NULL}, se utilizará como la cadena de documentación para la clase de excepción.


Added in version 3.2.

@end deffn

@node Objetos excepción,Objetos unicode de excepción,Clases de excepción,Manejo de excepciones
@anchor{c-api/exceptions exception-objects}@anchor{4a62}
@subsection Objetos excepción


@geindex PyException_GetTraceback (C function)
@anchor{c-api/exceptions c PyException_GetTraceback}@anchor{492f}
@deffn {C Función} @ref{42d,,PyObject} *PyException_GetTraceback (PyObject *ex)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return the traceback associated with the exception as a new reference, as
accessible from Python through the @ref{1330,,__traceback__}
attribute. If there is no
traceback associated, this returns @code{NULL}.
@end deffn

@geindex PyException_SetTraceback (C function)
@anchor{c-api/exceptions c PyException_SetTraceback}@anchor{19f3}
@deffn {C Función} int PyException_SetTraceback (PyObject *ex, PyObject *tb)
` Part of the @ref{5f6,,Stable ABI}.'
Establezca el rastreo asociado con la excepción a `tb'. Use @code{Py_None} para borrarlo.
@end deffn

@geindex PyException_GetContext (C function)
@anchor{c-api/exceptions c PyException_GetContext}@anchor{492e}
@deffn {C Función} @ref{42d,,PyObject} *PyException_GetContext (PyObject *ex)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return the context (another exception instance during whose handling `ex' was
raised) associated with the exception as a new reference, as accessible from
Python through the @ref{1331,,__context__} attribute.
If there is no context associated, this returns @code{NULL}.
@end deffn

@geindex PyException_SetContext (C function)
@anchor{c-api/exceptions c PyException_SetContext}@anchor{4931}
@deffn {C Función} void PyException_SetContext (PyObject *ex, PyObject *ctx)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el contexto asociado con la excepción a `ctx'. Use @code{NULL} para borrarlo. No hay verificación de tipo para asegurarse de que `ctx' es una instancia de excepción. Esto roba una referencia a `ctx'.
@end deffn

@geindex PyException_GetCause (C function)
@anchor{c-api/exceptions c PyException_GetCause}@anchor{492d}
@deffn {C Función} @ref{42d,,PyObject} *PyException_GetCause (PyObject *ex)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return the cause (either an exception instance, or @code{None},
set by @code{raise ... from ...}) associated with the exception as a new
reference, as accessible from Python through the
@ref{1332,,__cause__} attribute.
@end deffn

@geindex PyException_SetCause (C function)
@anchor{c-api/exceptions c PyException_SetCause}@anchor{4930}
@deffn {C Función} void PyException_SetCause (PyObject *ex, PyObject *cause)
` Part of the @ref{5f6,,Stable ABI}.'
Set the cause associated with the exception to `cause'.  Use @code{NULL} to clear
it.  There is no type check to make sure that `cause' is either an exception
instance or @code{None}.  This steals a reference to `cause'.

The @ref{20b3,,__suppress_context__} attribute is implicitly set
to @code{True} by this function.
@end deffn

@geindex PyException_GetArgs (C function)
@anchor{c-api/exceptions c PyException_GetArgs}@anchor{60e}
@deffn {C Función} @ref{42d,,PyObject} *PyException_GetArgs (PyObject *ex)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Return @ref{610,,args} of exception `ex'.
@end deffn

@geindex PyException_SetArgs (C function)
@anchor{c-api/exceptions c PyException_SetArgs}@anchor{60f}
@deffn {C Función} void PyException_SetArgs (PyObject *ex, PyObject *args)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Set @ref{610,,args} of exception `ex' to `args'.
@end deffn

@geindex PyUnstable_Exc_PrepReraiseStar (C function)
@anchor{c-api/exceptions c PyUnstable_Exc_PrepReraiseStar}@anchor{4a63}
@deffn {C Función} @ref{42d,,PyObject} *PyUnstable_Exc_PrepReraiseStar (PyObject *orig, PyObject *excs)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Implement part of the interpreter’s implementation of @code{except*}.
`orig' is the original exception that was caught, and `excs' is the list of
the exceptions that need to be raised. This list contains the unhandled
part of `orig', if any, as well as the exceptions that were raised from the
@code{except*} clauses (so they have a different traceback from `orig') and
those that were reraised (and have the same traceback as `orig').
Return the @ref{31d,,ExceptionGroup} that needs to be reraised in the end, or
@code{None} if there is nothing to reraise.


Added in version 3.12.

@end deffn

@node Objetos unicode de excepción,Control de recursión,Objetos excepción,Manejo de excepciones
@anchor{c-api/exceptions unicode-exception-objects}@anchor{4a64}@anchor{c-api/exceptions unicodeexceptions}@anchor{4a65}
@subsection Objetos unicode de excepción


Las siguientes funciones se utilizan para crear y modificar excepciones Unicode de C.

@geindex PyUnicodeDecodeError_Create (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_Create}@anchor{49cf}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicodeDecodeError_Create (const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto @ref{aa5,,UnicodeDecodeError} con los atributos `encoding', `object', `length', `start', `end' y `reason'. `encoding' y `reason' son cadenas codificadas UTF-8.
@end deffn

@geindex PyUnicodeDecodeError_GetEncoding (C function)
@geindex PyUnicodeEncodeError_GetEncoding (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetEncoding}@anchor{49d0}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicodeDecodeError_GetEncoding (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEncoding}@anchor{49d8}
@deffnx {C Función} @ref{42d,,PyObject} *PyUnicodeEncodeError_GetEncoding (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el atributo `encoding' del objeto de excepción dado.
@end deffn

@geindex PyUnicodeDecodeError_GetObject (C function)
@geindex PyUnicodeEncodeError_GetObject (C function)
@geindex PyUnicodeTranslateError_GetObject (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetObject}@anchor{49d2}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicodeDecodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetObject}@anchor{49da}
@deffnx {C Función} @ref{42d,,PyObject} *PyUnicodeEncodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetObject}@anchor{49e1}
@deffnx {C Función} @ref{42d,,PyObject} *PyUnicodeTranslateError_GetObject (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el atributo `object' del objeto de excepción dado.
@end deffn

@geindex PyUnicodeDecodeError_GetStart (C function)
@geindex PyUnicodeEncodeError_GetStart (C function)
@geindex PyUnicodeTranslateError_GetStart (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetStart}@anchor{49d4}
@deffn {C Función} int PyUnicodeDecodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetStart}@anchor{49dc}
@deffnx {C Función} int PyUnicodeEncodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetStart}@anchor{49e3}
@deffnx {C Función} int PyUnicodeTranslateError_GetStart (PyObject *exc, Py_ssize_t *start)
` Part of the @ref{5f6,,Stable ABI}.'
Obtiene el atributo `start' del objeto de excepción dado y lo coloca en `*start'. `start' no debe ser @code{NULL}. retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyUnicodeDecodeError_SetStart (C function)
@geindex PyUnicodeEncodeError_SetStart (C function)
@geindex PyUnicodeTranslateError_SetStart (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetStart}@anchor{49d7}
@deffn {C Función} int PyUnicodeDecodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetStart}@anchor{49df}
@deffnx {C Función} int PyUnicodeEncodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetStart}@anchor{49e6}
@deffnx {C Función} int PyUnicodeTranslateError_SetStart (PyObject *exc, Py_ssize_t start)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el atributo `start' del objeto de excepción dado en `start'. Retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyUnicodeDecodeError_GetEnd (C function)
@geindex PyUnicodeEncodeError_GetEnd (C function)
@geindex PyUnicodeTranslateError_GetEnd (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetEnd}@anchor{49d1}
@deffn {C Función} int PyUnicodeDecodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEnd}@anchor{49d9}
@deffnx {C Función} int PyUnicodeEncodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetEnd}@anchor{49e0}
@deffnx {C Función} int PyUnicodeTranslateError_GetEnd (PyObject *exc, Py_ssize_t *end)
` Part of the @ref{5f6,,Stable ABI}.'
Obtiene el atributo `end' del objeto de excepción dado y lo coloca en `*end'. `end' no debe ser @code{NULL}. retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyUnicodeDecodeError_SetEnd (C function)
@geindex PyUnicodeEncodeError_SetEnd (C function)
@geindex PyUnicodeTranslateError_SetEnd (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetEnd}@anchor{49d5}
@deffn {C Función} int PyUnicodeDecodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetEnd}@anchor{49dd}
@deffnx {C Función} int PyUnicodeEncodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetEnd}@anchor{49e4}
@deffnx {C Función} int PyUnicodeTranslateError_SetEnd (PyObject *exc, Py_ssize_t end)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el atributo `end' del objeto de excepción dado en `end'. Retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyUnicodeDecodeError_GetReason (C function)
@geindex PyUnicodeEncodeError_GetReason (C function)
@geindex PyUnicodeTranslateError_GetReason (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetReason}@anchor{49d3}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicodeDecodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetReason}@anchor{49db}
@deffnx {C Función} @ref{42d,,PyObject} *PyUnicodeEncodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetReason}@anchor{49e2}
@deffnx {C Función} @ref{42d,,PyObject} *PyUnicodeTranslateError_GetReason (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el atributo `reason' del objeto de excepción dado.
@end deffn

@geindex PyUnicodeDecodeError_SetReason (C function)
@geindex PyUnicodeEncodeError_SetReason (C function)
@geindex PyUnicodeTranslateError_SetReason (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetReason}@anchor{49d6}
@deffn {C Función} int PyUnicodeDecodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetReason}@anchor{49de}
@deffnx {C Función} int PyUnicodeEncodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetReason}@anchor{49e5}
@deffnx {C Función} int PyUnicodeTranslateError_SetReason (PyObject *exc, const char *reason)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el atributo `reason' del objeto de excepción dado en `reason'. Retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@node Control de recursión,Excepciones estándar,Objetos unicode de excepción,Manejo de excepciones
@anchor{c-api/exceptions recursion}@anchor{4a66}@anchor{c-api/exceptions recursion-control}@anchor{4a67}
@subsection Control de recursión


Estas dos funciones proporcionan una forma de realizar llamadas recursivas seguras en el nivel C, tanto en el núcleo como en los módulos de extensión. Son necesarios si el código recursivo no invoca necesariamente el código Python (que rastrea su profundidad de recursión automáticamente). Tampoco son necesarios para las implementaciones de `tp_call' porque @ref{627,,call protocol} se encarga del manejo de la recursividad.

@geindex Py_EnterRecursiveCall (C function)
@anchor{c-api/exceptions c Py_EnterRecursiveCall}@anchor{a05}
@deffn {C Función} int Py_EnterRecursiveCall (const char *where)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Marca un punto donde una llamada recursiva de nivel C está a punto de realizarse.

If @code{USE_STACKCHECK} is defined, this function checks if the OS
stack overflowed using @ref{181d,,PyOS_CheckStack()}.  If this is the case, it
sets a @ref{16cb,,MemoryError} and returns a nonzero value.

La función verifica si se alcanza el límite de recursión. Si este es el caso, se establece a @ref{df1,,RecursionError} y se retorna un valor distinto de cero. De lo contrario, se retorna cero.

`where' debería ser una cadena de caracteres codificada en UTF-8 como @code{"en la comprobación de instancia"} para concatenarse con el mensaje @ref{df1,,RecursionError} causado por el límite de profundidad de recursión.


Distinto en la versión 3.9: This function is now also available in the @ref{488,,limited API}.

@end deffn

@geindex Py_LeaveRecursiveCall (C function)
@anchor{c-api/exceptions c Py_LeaveRecursiveCall}@anchor{a06}
@deffn {C Función} void Py_LeaveRecursiveCall (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Termina una @ref{a05,,Py_EnterRecursiveCall()}. Se debe llamar una vez por cada invocación `exitosa' de @ref{a05,,Py_EnterRecursiveCall()}.


Distinto en la versión 3.9: This function is now also available in the @ref{488,,limited API}.

@end deffn

La implementación adecuada de @ref{4874,,tp_repr} para los tipos de contenedor requiere un manejo de recursión especial. Además de proteger la pila, @ref{4874,,tp_repr} también necesita rastrear objetos para evitar ciclos. Las siguientes dos funciones facilitan esta funcionalidad. Efectivamente, estos son los C equivalentes a @ref{1260,,reprlib.recursive_repr()}.

@geindex Py_ReprEnter (C function)
@anchor{c-api/exceptions c Py_ReprEnter}@anchor{4a16}
@deffn {C Función} int Py_ReprEnter (PyObject *object)
` Part of the @ref{5f6,,Stable ABI}.'
Llamado al comienzo de la implementación @ref{4874,,tp_repr} para detectar ciclos.

Si el objeto ya ha sido procesado, la función retorna un entero positivo. En ese caso, la implementación @ref{4874,,tp_repr} debería retornar un objeto de cadena que indique un ciclo. Como ejemplos, los objetos @ref{190,,dict} retornan @code{@{...@}} y los objetos @ref{18e,,list} retornan @code{[...]}.

La función retornará un entero negativo si se alcanza el límite de recursión. En ese caso, la implementación @ref{4874,,tp_repr} normalmente debería retornar @code{NULL}.

De lo contrario, la función retorna cero y la implementación @ref{4874,,tp_repr} puede continuar normalmente.
@end deffn

@geindex Py_ReprLeave (C function)
@anchor{c-api/exceptions c Py_ReprLeave}@anchor{4a17}
@deffn {C Función} void Py_ReprLeave (PyObject *object)
` Part of the @ref{5f6,,Stable ABI}.'
Termina a @ref{4a16,,Py_ReprEnter()}. Se debe llamar una vez por cada invocación de @ref{4a16,,Py_ReprEnter()} que retorna cero.
@end deffn

@node Excepciones estándar,Categorías de advertencia estándar,Control de recursión,Manejo de excepciones
@anchor{c-api/exceptions standard-exceptions}@anchor{4a68}@anchor{c-api/exceptions standardexceptions}@anchor{4a69}
@subsection Excepciones estándar


Todas las excepciones estándar de Python están disponibles como variables globales cuyos nombres son @code{PyExc_} seguidos del nombre de excepción de Python.  Estos tienen el tipo @ref{42d,,PyObject}*; todos son objetos de clase.  Para completar, aquí están todas las variables:

@geindex PyExc_BaseException (C var)
@geindex PyExc_Exception (C var)
@geindex PyExc_ArithmeticError (C var)
@geindex PyExc_AssertionError (C var)
@geindex PyExc_AttributeError (C var)
@geindex PyExc_BlockingIOError (C var)
@geindex PyExc_BrokenPipeError (C var)
@geindex PyExc_BufferError (C var)
@geindex PyExc_ChildProcessError (C var)
@geindex PyExc_ConnectionAbortedError (C var)
@geindex PyExc_ConnectionError (C var)
@geindex PyExc_ConnectionRefusedError (C var)
@geindex PyExc_ConnectionResetError (C var)
@geindex PyExc_EOFError (C var)
@geindex PyExc_FileExistsError (C var)
@geindex PyExc_FileNotFoundError (C var)
@geindex PyExc_FloatingPointError (C var)
@geindex PyExc_GeneratorExit (C var)
@geindex PyExc_ImportError (C var)
@geindex PyExc_IndentationError (C var)
@geindex PyExc_IndexError (C var)
@geindex PyExc_InterruptedError (C var)
@geindex PyExc_IsADirectoryError (C var)
@geindex PyExc_KeyError (C var)
@geindex PyExc_KeyboardInterrupt (C var)
@geindex PyExc_LookupError (C var)
@geindex PyExc_MemoryError (C var)
@geindex PyExc_ModuleNotFoundError (C var)
@geindex PyExc_NameError (C var)
@geindex PyExc_NotADirectoryError (C var)
@geindex PyExc_NotImplementedError (C var)
@geindex PyExc_OSError (C var)
@geindex PyExc_OverflowError (C var)
@geindex PyExc_PermissionError (C var)
@geindex PyExc_ProcessLookupError (C var)
@geindex PyExc_PythonFinalizationError (C var)
@geindex PyExc_RecursionError (C var)
@geindex PyExc_ReferenceError (C var)
@geindex PyExc_RuntimeError (C var)
@geindex PyExc_StopAsyncIteration (C var)
@geindex PyExc_StopIteration (C var)
@geindex PyExc_SyntaxError (C var)
@geindex PyExc_SystemError (C var)
@geindex PyExc_SystemExit (C var)
@geindex PyExc_TabError (C var)
@geindex PyExc_TimeoutError (C var)
@geindex PyExc_TypeError (C var)
@geindex PyExc_UnboundLocalError (C var)
@geindex PyExc_UnicodeDecodeError (C var)
@geindex PyExc_UnicodeEncodeError (C var)
@geindex PyExc_UnicodeError (C var)
@geindex PyExc_UnicodeTranslateError (C var)
@geindex PyExc_ValueError (C var)
@geindex PyExc_ZeroDivisionError (C var)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Nombre en C

@tab

Nombre en Python

@tab

Notas

@item

@code{PyExc_BaseException}

@tab

@ref{65c,,BaseException}

@tab

@footnote{
Esta es una clase base para otras excepciones estándar.
}

@item

@code{PyExc_Exception}

@tab

@ref{a6b,,Exception}

@tab

@footnote{
Esta es una clase base para otras excepciones estándar.
}

@item

@code{PyExc_ArithmeticError}

@tab

@ref{2289,,ArithmeticError}

@tab

@footnote{
Esta es una clase base para otras excepciones estándar.
}

@item

@code{PyExc_AssertionError}

@tab

@ref{74a,,AssertionError}

@tab

@item

@code{PyExc_AttributeError}

@tab

@ref{441,,AttributeError}

@tab

@item

@code{PyExc_BlockingIOError}

@tab

@ref{10d3,,BlockingIOError}

@tab

@item

@code{PyExc_BrokenPipeError}

@tab

@ref{10d8,,BrokenPipeError}

@tab

@item

@code{PyExc_BufferError}

@tab

@ref{182b,,BufferError}

@tab

@item

@code{PyExc_ChildProcessError}

@tab

@ref{10d4,,ChildProcessError}

@tab

@item

@code{PyExc_ConnectionAbortedError}

@tab

@ref{10d9,,ConnectionAbortedError}

@tab

@item

@code{PyExc_ConnectionError}

@tab

@ref{e8f,,ConnectionError}

@tab

@item

@code{PyExc_ConnectionRefusedError}

@tab

@ref{10da,,ConnectionRefusedError}

@tab

@item

@code{PyExc_ConnectionResetError}

@tab

@ref{10db,,ConnectionResetError}

@tab

@item

@code{PyExc_EOFError}

@tab

@ref{1341,,EOFError}

@tab

@item

@code{PyExc_FileExistsError}

@tab

@ref{109c,,FileExistsError}

@tab

@item

@code{PyExc_FileNotFoundError}

@tab

@ref{f46,,FileNotFoundError}

@tab

@item

@code{PyExc_FloatingPointError}

@tab

@ref{228a,,FloatingPointError}

@tab

@item

@code{PyExc_GeneratorExit}

@tab

@ref{1407,,GeneratorExit}

@tab

@item

@code{PyExc_ImportError}

@tab

@ref{4d7,,ImportError}

@tab

@item

@code{PyExc_IndentationError}

@tab

@ref{841,,IndentationError}

@tab

@item

@code{PyExc_IndexError}

@tab

@ref{1575,,IndexError}

@tab

@item

@code{PyExc_InterruptedError}

@tab

@ref{e0e,,InterruptedError}

@tab

@item

@code{PyExc_IsADirectoryError}

@tab

@ref{10d5,,IsADirectoryError}

@tab

@item

@code{PyExc_KeyError}

@tab

@ref{438,,KeyError}

@tab

@item

@code{PyExc_KeyboardInterrupt}

@tab

@ref{a63,,KeyboardInterrupt}

@tab

@item

@code{PyExc_LookupError}

@tab

@ref{21d5,,LookupError}

@tab

@footnote{
Esta es una clase base para otras excepciones estándar.
}

@item

@code{PyExc_MemoryError}

@tab

@ref{16cb,,MemoryError}

@tab

@item

@code{PyExc_ModuleNotFoundError}

@tab

@ref{bcf,,ModuleNotFoundError}

@tab

@item

@code{PyExc_NameError}

@tab

@ref{4ec,,NameError}

@tab

@item

@code{PyExc_NotADirectoryError}

@tab

@ref{10d6,,NotADirectoryError}

@tab

@item

@code{PyExc_NotImplementedError}

@tab

@ref{384,,NotImplementedError}

@tab

@item

@code{PyExc_OSError}

@tab

@ref{4d5,,OSError}

@tab

@footnote{
Esta es una clase base para otras excepciones estándar.
}

@item

@code{PyExc_OverflowError}

@tab

@ref{919,,OverflowError}

@tab

@item

@code{PyExc_PermissionError}

@tab

@ref{dc9,,PermissionError}

@tab

@item

@code{PyExc_ProcessLookupError}

@tab

@ref{10d7,,ProcessLookupError}

@tab

@item

@code{PyExc_PythonFinalizationError}

@tab

@ref{2ba,,PythonFinalizationError}

@tab

@item

@code{PyExc_RecursionError}

@tab

@ref{df1,,RecursionError}

@tab

@item

@code{PyExc_ReferenceError}

@tab

@ref{154f,,ReferenceError}

@tab

@item

@code{PyExc_RuntimeError}

@tab

@ref{1e5,,RuntimeError}

@tab

@item

@code{PyExc_StopAsyncIteration}

@tab

@ref{1a34,,StopAsyncIteration}

@tab

@item

@code{PyExc_StopIteration}

@tab

@ref{c82,,StopIteration}

@tab

@item

@code{PyExc_SyntaxError}

@tab

@ref{150,,SyntaxError}

@tab

@item

@code{PyExc_SystemError}

@tab

@ref{619,,SystemError}

@tab

@item

@code{PyExc_SystemExit}

@tab

@ref{dc7,,SystemExit}

@tab

@item

@code{PyExc_TabError}

@tab

@ref{5e6,,TabError}

@tab

@item

@code{PyExc_TimeoutError}

@tab

@ref{8cc,,TimeoutError}

@tab

@item

@code{PyExc_TypeError}

@tab

@ref{228,,TypeError}

@tab

@item

@code{PyExc_UnboundLocalError}

@tab

@ref{1576,,UnboundLocalError}

@tab

@item

@code{PyExc_UnicodeDecodeError}

@tab

@ref{aa5,,UnicodeDecodeError}

@tab

@item

@code{PyExc_UnicodeEncodeError}

@tab

@ref{718,,UnicodeEncodeError}

@tab

@item

@code{PyExc_UnicodeError}

@tab

@ref{130f,,UnicodeError}

@tab

@item

@code{PyExc_UnicodeTranslateError}

@tab

@ref{22a0,,UnicodeTranslateError}

@tab

@item

@code{PyExc_ValueError}

@tab

@ref{360,,ValueError}

@tab

@item

@code{PyExc_ZeroDivisionError}

@tab

@ref{9d8,,ZeroDivisionError}

@tab

@end multitable



Added in version 3.3: @code{PyExc_BlockingIOError}, @code{PyExc_BrokenPipeError}, @code{PyExc_ChildProcessError}, @code{PyExc_ConnectionError}, @code{PyExc_ConnectionAbortedError}, @code{PyExc_ConnectionRefusedError}, @code{PyExc_ConnectionResetError}, @code{PyExc_FileExistsError}, @code{PyExc_FileNotFoundError}, @code{PyExc_InterruptedError}, @code{PyExc_IsADirectoryError}, @code{PyExc_NotADirectoryError}, @code{PyExc_PermissionError}, @code{PyExc_ProcessLookupError} y @code{PyExc_TimeoutError} fueron introducidos luego de 
@geindex Python Enhancement Proposals; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}.



Added in version 3.5: @code{PyExc_StopAsyncIteration} y @code{PyExc_RecursionError}.



Added in version 3.6: @code{PyExc_ModuleNotFoundError}.


Estos son alias de compatibilidad para @code{PyExc_OSError}:

@geindex PyExc_EnvironmentError (C var)
@geindex PyExc_IOError (C var)
@geindex PyExc_WindowsError (C var)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Nombre en C

@tab

Notas

@item

@code{PyExc_EnvironmentError}

@tab

@item

@code{PyExc_IOError}

@tab

@item

@code{PyExc_WindowsError}

@tab

@footnote{
Solo se define en Windows; proteja el código que usa esto probando que la macro del preprocesador @code{MS_WINDOWS} está definida.
}

@end multitable



Distinto en la versión 3.3: Estos alias solían ser tipos de excepción separados.


Notas:

@node Categorías de advertencia estándar,,Excepciones estándar,Manejo de excepciones
@anchor{c-api/exceptions standard-warning-categories}@anchor{4a6a}@anchor{c-api/exceptions standardwarningcategories}@anchor{4a5d}
@subsection Categorías de advertencia estándar


Todas las categorías de advertencia estándar de Python están disponibles como variables globales cuyos nombres son @code{PyExc_} seguidos del nombre de excepción de Python. Estos tienen el tipo @ref{42d,,PyObject}*; todos son objetos de clase. Para completar, aquí están todas las variables:

@geindex PyExc_Warning (C var)
@geindex PyExc_BytesWarning (C var)
@geindex PyExc_DeprecationWarning (C var)
@geindex PyExc_FutureWarning (C var)
@geindex PyExc_ImportWarning (C var)
@geindex PyExc_PendingDeprecationWarning (C var)
@geindex PyExc_ResourceWarning (C var)
@geindex PyExc_RuntimeWarning (C var)
@geindex PyExc_SyntaxWarning (C var)
@geindex PyExc_UnicodeWarning (C var)
@geindex PyExc_UserWarning (C var)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Nombre en C

@tab

Nombre en Python

@tab

Notas

@item

@code{PyExc_Warning}

@tab

@ref{22b6,,Warning}

@tab

@footnote{
Esta es una clase base para otras categorías de advertencia estándar.
}

@item

@code{PyExc_BytesWarning}

@tab

@ref{cab,,BytesWarning}

@tab

@item

@code{PyExc_DeprecationWarning}

@tab

@ref{1da,,DeprecationWarning}

@tab

@item

@code{PyExc_FutureWarning}

@tab

@ref{4d4,,FutureWarning}

@tab

@item

@code{PyExc_ImportWarning}

@tab

@ref{59f,,ImportWarning}

@tab

@item

@code{PyExc_PendingDeprecationWarning}

@tab

@ref{95f,,PendingDeprecationWarning}

@tab

@item

@code{PyExc_ResourceWarning}

@tab

@ref{39d,,ResourceWarning}

@tab

@item

@code{PyExc_RuntimeWarning}

@tab

@ref{323,,RuntimeWarning}

@tab

@item

@code{PyExc_SyntaxWarning}

@tab

@ref{511,,SyntaxWarning}

@tab

@item

@code{PyExc_UnicodeWarning}

@tab

@ref{1463,,UnicodeWarning}

@tab

@item

@code{PyExc_UserWarning}

@tab

@ref{22b7,,UserWarning}

@tab

@end multitable



Added in version 3.2: @code{PyExc_ResourceWarning}.


Notas:

@node Utilidades<2>,Capa de objetos abstractos,Manejo de excepciones,Manual de referencia de la API en C de Python
@anchor{c-api/utilities doc}@anchor{4a6b}@anchor{c-api/utilities id1}@anchor{4a6c}@anchor{c-api/utilities utilities}@anchor{4a6d}
@section Utilidades


Las funciones de este capítulo realizan varias tareas de utilidad, que van desde ayudar a que el código C sea más portátil en todas las plataformas, usar módulos Python desde C y analizar argumentos de funciones y construir valores Python a partir de valores C.

@menu
* Utilidades del sistema operativo:: 
* Funciones del Sistema:: 
* Control de procesos:: 
* Importando módulos: Importando módulos<2>. 
* Soporte de empaquetado (marshalling) de datos: Soporte de empaquetado marshalling de datos. 
* Analizando argumentos y construyendo valores:: 
* Conversión y formato de cadenas de caracteres:: 
* PyHash API:: 
* Reflexión:: 
* Registro de códec y funciones de soporte:: 
* PyTime C API:: 
* Support for Perf Maps:: 

@end menu

@node Utilidades del sistema operativo,Funciones del Sistema,,Utilidades<2>
@anchor{c-api/sys doc}@anchor{4a6e}@anchor{c-api/sys operating-system-utilities}@anchor{4a6f}@anchor{c-api/sys os}@anchor{4a70}
@subsection Utilidades del sistema operativo


@geindex PyOS_FSPath (C function)
@anchor{c-api/sys c PyOS_FSPath}@anchor{d9f}
@deffn {C Función} @ref{42d,,PyObject} *PyOS_FSPath (PyObject *path)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.6.'
Return the file system representation for `path'. If the object is a
@ref{237,,str} or @ref{325,,bytes} object, then a new
@ref{431,,strong reference} is returned.
If the object implements the @ref{cd9,,os.PathLike} interface,
then @ref{cda,,__fspath__()} is returned as long as it is a
@ref{237,,str} or @ref{325,,bytes} object. Otherwise @ref{228,,TypeError} is raised
and @code{NULL} is returned.


Added in version 3.6.

@end deffn

@geindex Py_FdIsInteractive (C function)
@anchor{c-api/sys c Py_FdIsInteractive}@anchor{4a71}
@deffn {C Función} int Py_FdIsInteractive (FILE *fp, const char *filename)

Return true (nonzero) if the standard I/O file `fp' with name `filename' is
deemed interactive.  This is the case for files for which @code{isatty(fileno(fp))}
is true.  If the @ref{4ae,,PyConfig.interactive} is non-zero, this function
also returns true if the `filename' pointer is @code{NULL} or if the name is equal to
one of the strings @code{'<stdin>'} or @code{'???'}.

This function must not be called before Python is initialized.
@end deffn

@geindex PyOS_BeforeFork (C function)
@anchor{c-api/sys c PyOS_BeforeFork}@anchor{c47}
@deffn {C Función} void PyOS_BeforeFork ()
` Part of the @ref{5f6,,Stable ABI} on platforms with fork() since version 3.7.'
Función para preparar algún estado interno antes de una bifurcación de proceso (`process fork'). Esto debería llamarse antes de llamar a @code{fork()} o cualquier función similar que clone el proceso actual. Solo disponible en sistemas donde @code{fork()} está definido.

@cartouche
@quotation Advertencia 
La llamada C @code{fork()} solo debe hacerse desde @ref{4a72,,hilo «principal»} (del intérprete @ref{62b,,«principal»}). Lo mismo es cierto para @code{PyOS_BeforeFork()}.
@end quotation
@end cartouche


Added in version 3.7.

@end deffn

@geindex PyOS_AfterFork_Parent (C function)
@anchor{c-api/sys c PyOS_AfterFork_Parent}@anchor{c48}
@deffn {C Función} void PyOS_AfterFork_Parent ()
` Part of the @ref{5f6,,Stable ABI} on platforms with fork() since version 3.7.'
Función para actualizar algún estado interno después de una bifurcación de proceso. Se debe invocar desde el proceso principal después de llamar a @code{fork()} o cualquier función similar que clone el proceso actual, independientemente de si la clonación del proceso fue exitosa. Solo disponible en sistemas donde @code{fork()} está definido.

@cartouche
@quotation Advertencia 
La llamada C @code{fork()} solo debe hacerse desde @ref{4a72,,hilo «principal»} (del intérprete @ref{62b,,«principal»}). Lo mismo es cierto para @code{PyOS_AfterFork_Parent()}.
@end quotation
@end cartouche


Added in version 3.7.

@end deffn

@geindex PyOS_AfterFork_Child (C function)
@anchor{c-api/sys c PyOS_AfterFork_Child}@anchor{292}
@deffn {C Función} void PyOS_AfterFork_Child ()
` Part of the @ref{5f6,,Stable ABI} on platforms with fork() since version 3.7.'
Función para actualizar el estado del intérprete interno después de una bifurcación de proceso (`process fork'). Debe llamarse desde el proceso secundario después de llamar a @code{fork()}, o cualquier función similar que clone el proceso actual, si existe alguna posibilidad de que el proceso vuelva a llamar al intérprete de Python. Solo disponible en sistemas donde @code{fork()} está definido.

@cartouche
@quotation Advertencia 
La llamada C @code{fork()} solo debe hacerse desde @ref{4a72,,hilo «principal»} (del intérprete @ref{62b,,«principal»}). Lo mismo es cierto para @code{PyOS_AfterFork_Child()}.
@end quotation
@end cartouche


Added in version 3.7.



@subsubheading Ver también


@ref{1f8,,os.register_at_fork()} permite registrar funciones personalizadas de Python a las que puede llamar @ref{c47,,PyOS_BeforeFork()}, @ref{c48,,PyOS_AfterFork_Parent()} y @ref{292,,PyOS_AfterFork_Child()}.

@end deffn

@geindex PyOS_AfterFork (C function)
@anchor{c-api/sys c PyOS_AfterFork}@anchor{291}
@deffn {C Función} void PyOS_AfterFork ()
` Part of the @ref{5f6,,Stable ABI} on platforms with fork().'
Función para actualizar algún estado interno después de una bifurcación de proceso (`process fork'); Esto debería llamarse en el nuevo proceso si el intérprete de Python continuará siendo utilizado. Si se carga un nuevo ejecutable en el nuevo proceso, no es necesario llamar a esta función.


Obsoleto desde la versión 3.7: Esta función es reemplazada por @ref{292,,PyOS_AfterFork_Child()}.

@end deffn

@geindex PyOS_CheckStack (C function)
@anchor{c-api/sys c PyOS_CheckStack}@anchor{181d}
@deffn {C Función} int PyOS_CheckStack ()
` Part of the @ref{5f6,,Stable ABI} on platforms with USE_STACKCHECK since version 3.7.'
@geindex USE_STACKCHECK (C macro)

Return true when the interpreter runs out of stack space.  This is a reliable
check, but is only available when @code{USE_STACKCHECK} is defined (currently
on certain versions of Windows using the Microsoft Visual C++ compiler).
@code{USE_STACKCHECK} will be defined automatically; you should never
change the definition in your own code.
@end deffn

@geindex PyOS_sighandler_t (C type)
@anchor{c-api/sys c PyOS_sighandler_t}@anchor{4989}
@deffn {C Tipo} typedef void (*PyOS_sighandler_t)(int)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyOS_getsig (C function)
@anchor{c-api/sys c PyOS_getsig}@anchor{157e}
@deffn {C Función} @ref{4989,,PyOS_sighandler_t} PyOS_getsig (int i)
` Part of the @ref{5f6,,Stable ABI}.'
Return the current signal handler for signal `i'.  This is a thin wrapper around
either @code{sigaction()} or @code{signal()}.  Do not call those functions
directly!
@end deffn

@geindex PyOS_setsig (C function)
@anchor{c-api/sys c PyOS_setsig}@anchor{157f}
@deffn {C Función} @ref{4989,,PyOS_sighandler_t} PyOS_setsig (int i, PyOS_sighandler_t h)
` Part of the @ref{5f6,,Stable ABI}.'
Set the signal handler for signal `i' to be `h'; return the old signal handler.
This is a thin wrapper around either @code{sigaction()} or @code{signal()}.  Do
not call those functions directly!
@end deffn

@geindex Py_DecodeLocale (C function)
@anchor{c-api/sys c Py_DecodeLocale}@anchor{c4f}
@deffn {C Función} wchar_t *Py_DecodeLocale (const char *arg, size_t *size)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
@cartouche
@quotation Advertencia 
Esta función no debe llamarse directamente: utilice la API @ref{499,,PyConfig} con la función @ref{a46,,PyConfig_SetBytesString()} que asegura que @ref{3c68,,Python está preinicializado}.

Esta función no debe llamarse antes de que @ref{3c68,,Python esté preinicializado} y para que la configuración local LC_CTYPE esté correctamente configurada: véase la función @ref{4cc,,Py_PreInitialize()}.
@end quotation
@end cartouche

Decodifica una cadena de bytes a partir del @ref{5dd,,manejador de codificación y errores del sistema de archivos}. Si el controlador de error es el @ref{23e6,,controlador de error surrogateescape}, los bytes no codificables se decodifican como caracteres en el rango U+DC80..U+DCFF; y si una secuencia de bytes se puede decodificar como un carácter sustituto, escape los bytes usando el controlador de error surrogateescape en lugar de decodificarlos.

Retorna un puntero a una cadena de caracteres anchos recientemente asignada, use @ref{485,,PyMem_RawFree()} para liberar la memoria. Si el tamaño no es @code{NULL}, escribe el número de caracteres anchos excluyendo el carácter nulo en @code{*size}

Retorna @code{NULL} en caso de error de decodificación o error de asignación de memoria. Si `size' no es @code{NULL}, @code{*size} se establece en @code{(size_t) -1} en caso de error de memoria o en @code{(size_t) -2} en caso de error de decodificación.

El @ref{5dd,,filesystem encoding and error handler} son seleccionados por @ref{829,,PyConfig_Read()}: ver @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} que pertenecen a @ref{499,,PyConfig}.

Los errores de decodificación nunca deberían ocurrir, a menos que haya un error en la biblioteca C.

Utilice la función @ref{c50,,Py_EncodeLocale()} para codificar la cadena de caracteres en una cadena de bytes.


@subsubheading Ver también


Las funciones @ref{49ef,,PyUnicode_DecodeFSDefaultAndSize()} y @ref{c51,,PyUnicode_DecodeLocaleAndSize()}.



Added in version 3.5.



Distinto en la versión 3.7: La función ahora utiliza la codificación UTF-8 en el @ref{6f7,,Modo Python UTF-8}.



Distinto en la versión 3.8: The function now uses the UTF-8 encoding on Windows if
@ref{4c7,,PyPreConfig.legacy_windows_fs_encoding} is zero;

@end deffn

@geindex Py_EncodeLocale (C function)
@anchor{c-api/sys c Py_EncodeLocale}@anchor{c50}
@deffn {C Función} char *Py_EncodeLocale (const wchar_t *text, size_t *error_pos)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Codifica una cadena de caracteres amplios según el término @ref{5dd,,filesystem encoding and error handler}. Si el gestor de errores es @ref{23e6,,surrogateescape error handler}, los caracteres sustituidos en el rango U+DC80..U+DCFF se convierten en bytes 0x80..0xFF.

Retorna un puntero a una cadena de bytes recién asignada, usa @ref{1482,,PyMem_Free()} para liberar la memoria. Retorna @code{NULL} si se genera un error de codificación o error de asignación de memoria.

Si `error_pos' no es @code{NULL}, @code{*error_pos} se establece en @code{(size_t)-1} en caso de éxito, o se establece en el índice del carácter no válido en el error de codificación.

El @ref{5dd,,filesystem encoding and error handler} son seleccionados por @ref{829,,PyConfig_Read()}: ver @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} que pertenecen a @ref{499,,PyConfig}.

Use la función @ref{c4f,,Py_DecodeLocale()} para decodificar la cadena de bytes en una cadena de caracteres anchos.

@cartouche
@quotation Advertencia 
Esta función no debe llamarse antes de que @ref{3c68,,Python esté preinicializado} y para que la configuración local LC_CTYPE esté correctamente configurada: véase la función @ref{4cc,,Py_PreInitialize()}.
@end quotation
@end cartouche


@subsubheading Ver también


Las funciones @ref{1a58,,PyUnicode_EncodeFSDefault()} y @ref{c52,,PyUnicode_EncodeLocale()}.



Added in version 3.5.



Distinto en la versión 3.7: La función ahora utiliza la codificación UTF-8 en el @ref{6f7,,Modo Python UTF-8}.



Distinto en la versión 3.8: The function now uses the UTF-8 encoding on Windows if
@ref{4c7,,PyPreConfig.legacy_windows_fs_encoding} is zero.

@end deffn

@node Funciones del Sistema,Control de procesos,Utilidades del sistema operativo,Utilidades<2>
@anchor{c-api/sys system-functions}@anchor{4a73}@anchor{c-api/sys systemfunctions}@anchor{4a74}
@subsection Funciones del Sistema


Estas son funciones de utilidad que hacen que la funcionalidad del módulo @ref{d9,,sys} sea accesible para el código C. Todos funcionan con el diccionario del módulo @ref{d9,,sys} del subproceso actual del intérprete, que está contenido en la estructura interna del estado del subproceso.

@geindex PySys_GetObject (C function)
@anchor{c-api/sys c PySys_GetObject}@anchor{47b}
@deffn {C Función} @ref{42d,,PyObject} *PySys_GetObject (const char *name)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el objeto `name' del módulo @ref{d9,,sys} o @code{NULL} si no existe, sin establecer una excepción.
@end deffn

@geindex PySys_SetObject (C function)
@anchor{c-api/sys c PySys_SetObject}@anchor{49c0}
@deffn {C Función} int PySys_SetObject (const char *name, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
Establece `name' en el módulo @ref{d9,,sys} en `v' a menos que `v' sea @code{NULL}, en cuyo caso `name' se elimina del módulo `sys'. Retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PySys_ResetWarnOptions (C function)
@anchor{c-api/sys c PySys_ResetWarnOptions}@anchor{278}
@deffn {C Función} void PySys_ResetWarnOptions ()
` Part of the @ref{5f6,,Stable ABI}.'
Restablece @ref{279,,sys.warnoptions} a una lista vacía. Esta función puede llamarse antes de @ref{247,,Py_Initialize()}.


Deprecated since version 3.13, will be removed in version 3.15: Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@end deffn

@geindex PySys_WriteStdout (C function)
@anchor{c-api/sys c PySys_WriteStdout}@anchor{49c2}
@deffn {C Función} void PySys_WriteStdout (const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Escribe la cadena de caracteres de salida descrita por `format' en @ref{b61,,sys.stdout}. No se lanzan excepciones, incluso si se produce el truncamiento (ver más abajo).

`format' debe limitar el tamaño total de la cadena de caracteres de salida formateada a 1000 bytes o menos; después de 1000 bytes, la cadena de caracteres de salida se trunca. En particular, esto significa que no deben existir formatos «%s» sin restricciones; estos deben limitarse usando «%.<N>s» donde <N> es un número decimal calculado de modo que <N> más el tamaño máximo de otro texto formateado no exceda los 1000 bytes. También tenga cuidado con «%f», que puede imprimir cientos de dígitos para números muy grandes.

Si ocurre un problema, o @ref{b61,,sys.stdout} no está configurado, el mensaje formateado se escribe en el real (nivel C) `stdout'.
@end deffn

@geindex PySys_WriteStderr (C function)
@anchor{c-api/sys c PySys_WriteStderr}@anchor{49c1}
@deffn {C Función} void PySys_WriteStderr (const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Como @ref{49c2,,PySys_WriteStdout()}, pero escribe a @ref{9cc,,sys.stderr} o `stderr' en su lugar.
@end deffn

@geindex PySys_FormatStdout (C function)
@anchor{c-api/sys c PySys_FormatStdout}@anchor{49be}
@deffn {C Función} void PySys_FormatStdout (const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Función similar a @code{PySys_WriteStdout()} pero formatea el mensaje usando @ref{618,,PyUnicode_FromFormatV()} y no trunca el mensaje a una longitud arbitraria.


Added in version 3.2.

@end deffn

@geindex PySys_FormatStderr (C function)
@anchor{c-api/sys c PySys_FormatStderr}@anchor{49bd}
@deffn {C Función} void PySys_FormatStderr (const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Como @ref{49be,,PySys_FormatStdout()}, pero escribe a @ref{9cc,,sys.stderr} o `stderr' en su lugar.


Added in version 3.2.

@end deffn

@geindex PySys_GetXOptions (C function)
@anchor{c-api/sys c PySys_GetXOptions}@anchor{49bf}
@deffn {C Función} @ref{42d,,PyObject} *PySys_GetXOptions ()
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna el diccionario actual de opciones @ref{2e2,,-X}, de manera similar a @ref{1d45,,sys._xoptions}. En caso de error, se retorna @code{NULL} y se establece una excepción.


Added in version 3.2.

@end deffn

@geindex PySys_Audit (C function)
@anchor{c-api/sys c PySys_Audit}@anchor{463}
@deffn {C Función} int PySys_Audit (const char *event, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Lanza un evento de auditoría con cualquier gancho activo. Retorna cero para el éxito y no cero con una excepción establecida en caso de error.

The `event' string argument must not be `NULL'.

If any hooks have been added, `format' and other arguments will be used
to construct a tuple to pass. Apart from @code{N}, the same format characters
as used in @ref{940,,Py_BuildValue()} are available. If the built value is not
a tuple, it will be added into a single-element tuple.

The @code{N} format option must not be used. It consumes a reference, but since
there is no way to know whether arguments to this function will be consumed,
using it may cause reference leaks.

Tenga en cuenta que los caracteres de formato @code{#} deben tratarse como @ref{af0,,Py_ssize_t}, independientemente de si se definió @code{PY_SSIZE_T_CLEAN}.

@ref{15af,,sys.audit()} realiza la misma función del código Python.

See also @ref{462,,PySys_AuditTuple()}.


Added in version 3.8.



Distinto en la versión 3.8.2: Requiere @ref{af0,,Py_ssize_t} para los caracteres de formato @code{#}. Anteriormente, se lanzaba una advertencia de deprecación inevitable.

@end deffn

@geindex PySys_AuditTuple (C function)
@anchor{c-api/sys c PySys_AuditTuple}@anchor{462}
@deffn {C Función} int PySys_AuditTuple (const char *event, PyObject *args)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{463,,PySys_Audit()}, but pass arguments as a Python object.
`args' must be a @ref{464,,tuple}. To pass no arguments, `args' can be `NULL'.


Added in version 3.13.

@end deffn

@geindex PySys_AddAuditHook (C function)
@anchor{c-api/sys c PySys_AddAuditHook}@anchor{4103}
@deffn {C Función} int PySys_AddAuditHook (Py_AuditHookFunction hook, void *userData)

Agrega el `hook' invocable a la lista de hooks de auditoría activos. Retorna cero para el éxito y no cero en caso de error. Si el tiempo de ejecución se ha inicializado, también configura un error en caso de fallo. Los hooks agregados a través de esta API se llaman para todos los intérpretes creados por el tiempo de ejecución.

El puntero `userData' se pasa a la función gancho. Dado que las funciones de enlace pueden llamarse desde diferentes tiempos de ejecución, este puntero no debe referirse directamente al estado de Python.

Es seguro llamar a esta función antes de @ref{247,,Py_Initialize()}. Cuando se llama después de la inicialización del tiempo de ejecución, se notifican los enlaces de auditoría existentes y pueden anular silenciosamente la operación al generar un error subclasificado de @code{Excepción} (otros errores no se silenciarán).

The hook function is always called with the GIL held by the Python
interpreter that raised the event.

Ver 
@geindex Python Enhancement Proposals; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para una descripción detallada de la auditoría. Las funciones en el tiempo de ejecución y la biblioteca estándar que generan eventos se enumeran en @ref{1878,,table de eventos de auditoria}. Los detalles se encuentran en la documentación de cada función.


If the interpreter is initialized, this function raises an auditing event
@code{sys.addaudithook} with no arguments. If any existing hooks raise an
exception derived from @ref{a6b,,Exception}, the new hook will not be
added and the exception is cleared. As a result, callers cannot assume
that their hook has been added unless they control all existing hooks.


@geindex Py_AuditHookFunction (C type)
@anchor{c-api/sys c Py_AuditHookFunction}@anchor{4a75}
@deffn {C Tipo} typedef int (*Py_AuditHookFunction)(const char *event, @ref{42d,,PyObject} *args, void *userData)

The type of the hook function.
`event' is the C string event argument passed to @ref{463,,PySys_Audit()} or
@ref{462,,PySys_AuditTuple()}.
`args' is guaranteed to be a @ref{4a76,,PyTupleObject}.
`userData' is the argument passed to PySys_AddAuditHook().
@end deffn


Added in version 3.8.

@end deffn

@node Control de procesos,Importando módulos<2>,Funciones del Sistema,Utilidades<2>
@anchor{c-api/sys process-control}@anchor{4a77}@anchor{c-api/sys processcontrol}@anchor{4a78}
@subsection Control de procesos


@geindex Py_FatalError (C function)
@anchor{c-api/sys c Py_FatalError}@anchor{a15}
@deffn {C Función} void Py_FatalError (const char *message)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex abort (C function)

Print a fatal error message and kill the process.  No cleanup is performed.
This function should only be invoked when a condition is detected that would
make it dangerous to continue using the Python interpreter; e.g., when the
object administration appears to be corrupted.  On Unix, the standard C library
function @code{abort()} is called which will attempt to produce a @code{core}
file.

La función @code{Py_FatalError()} se reemplaza con una macro que registra automáticamente el nombre de la función actual, a menos que se defina la macro @code{Py_LIMITED_API}.


Distinto en la versión 3.9: Registra el nombre de la función automáticamente.

@end deffn

@geindex Py_Exit (C function)
@anchor{c-api/sys c Py_Exit}@anchor{dd5}
@deffn {C Función} void Py_Exit (int status)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex Py_FinalizeEx (C function)
@geindex exit (C function)

Sale del proceso actual. Esto llama @ref{d9c,,Py_FinalizeEx()} y luego llama a la función estándar de la biblioteca C @code{exit(status)}. Si @ref{d9c,,Py_FinalizeEx()} indica un error, el estado de salida se establece en 120.


Distinto en la versión 3.6: Los errores de finalización ya no se ignoran.

@end deffn

@geindex Py_AtExit (C function)
@anchor{c-api/sys c Py_AtExit}@anchor{4a0b}
@deffn {C Función} int Py_AtExit (void (*func)())
` Part of the @ref{5f6,,Stable ABI}.'
@geindex Py_FinalizeEx (C function)
@geindex cleanup functions

Registra una función de limpieza a la que llamará @ref{d9c,,Py_FinalizeEx()}. Se llamará a la función de limpieza sin argumentos y no debería retornar ningún valor. Como máximo se pueden registrar 32 funciones de limpieza. Cuando el registro es exitoso, @ref{4a0b,,Py_AtExit()} retorna @code{0}; en caso de error, retorna @code{-1}. La última función de limpieza registrada se llama primero. Cada función de limpieza se llamará como máximo una vez. Dado que la finalización interna de Python se habrá completado antes de la función de limpieza, `func' no debería llamar a las API de Python.
@end deffn

@node Importando módulos<2>,Soporte de empaquetado marshalling de datos,Control de procesos,Utilidades<2>
@anchor{c-api/import doc}@anchor{4a79}@anchor{c-api/import importing}@anchor{4a7a}@anchor{c-api/import importing-modules}@anchor{4a7b}
@subsection Importando módulos


@geindex PyImport_ImportModule (C function)
@anchor{c-api/import c PyImport_ImportModule}@anchor{273}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ImportModule (const char *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex package variable;__all__
@geindex __all__ (package variable)
@geindex modules (in module sys)

This is a wrapper around @ref{143c,,PyImport_Import()} which takes a
const char* as an argument instead of a @ref{42d,,PyObject}*.
@end deffn

@geindex PyImport_ImportModuleNoBlock (C function)
@anchor{c-api/import c PyImport_ImportModuleNoBlock}@anchor{272}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ImportModuleNoBlock (const char *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta función es un alias obsoleto de @ref{273,,PyImport_ImportModule()}.


Distinto en la versión 3.3: Esta función solía fallar inmediatamente cuando el bloqueo de importación era retenido por otro hilo. Sin embargo, en Python 3.3, el esquema de bloqueo cambió a bloqueos por módulo para la mayoría de los propósitos, por lo que el comportamiento especial de esta función ya no es necesario.



Deprecated since version 3.13, will be removed in version 3.15: Use @ref{273,,PyImport_ImportModule()} instead.

@end deffn

@geindex PyImport_ImportModuleEx (C function)
@anchor{c-api/import c PyImport_ImportModuleEx}@anchor{1214}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ImportModuleEx (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
`Return value: New reference.'
@geindex built-in function;__import__

Importa un módulo. Esto se describe mejor haciendo referencia a la función Python incorporada @ref{96b,,__import__()}.

El valor de retorno es una nueva referencia al módulo importado o paquete de nivel superior, o @code{NULL} con una excepción establecida en caso de error. Al igual que para @ref{96b,,__import__()}, el valor de retorno cuando se solicitó un submódulo de un paquete normalmente es el paquete de nivel superior, a menos que se proporcione un `fromlist' no vacío.

Las importaciones que fallan eliminan objetos de módulo incompletos, como con @ref{273,,PyImport_ImportModule()}.
@end deffn

@geindex PyImport_ImportModuleLevelObject (C function)
@anchor{c-api/import c PyImport_ImportModuleLevelObject}@anchor{4944}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ImportModuleLevelObject (PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Importa un módulo. Esto se describe mejor haciendo referencia a la función Python incorporada @ref{96b,,__import__()}, ya que la función estándar @ref{96b,,__import__()} llama a esta función directamente.

El valor de retorno es una nueva referencia al módulo importado o paquete de nivel superior, o @code{NULL} con una excepción establecida en caso de error. Al igual que para @ref{96b,,__import__()}, el valor de retorno cuando se solicitó un submódulo de un paquete normalmente es el paquete de nivel superior, a menos que se proporcione un `fromlist' no vacío.


Added in version 3.3.

@end deffn

@geindex PyImport_ImportModuleLevel (C function)
@anchor{c-api/import c PyImport_ImportModuleLevel}@anchor{1213}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ImportModuleLevel (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4944,,PyImport_ImportModuleLevelObject()}, pero el nombre es una cadena de caracteres codificada UTF-8 en lugar de un objeto Unicode.


Distinto en la versión 3.3: Los valores negativos para `level' ya no se aceptan.

@end deffn

@geindex PyImport_Import (C function)
@anchor{c-api/import c PyImport_Import}@anchor{143c}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_Import (PyObject *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esta es una interfaz de nivel superior que llama a la «función de enlace de importación» actual (con un nivel explícito de 0, que significa importación absoluta). Invoca la función @ref{96b,,__import__()} de las @code{__builtins__} de los globales (`globals') actuales. Esto significa que la importación se realiza utilizando los ganchos de importación instalados en el entorno actual.

Esta función siempre usa importaciones absolutas.
@end deffn

@geindex PyImport_ReloadModule (C function)
@anchor{c-api/import c PyImport_ReloadModule}@anchor{4945}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ReloadModule (PyObject *m)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Recarga un módulo. Retorna una nueva referencia al módulo recargado, o @code{NULL} con una excepción establecida en caso de error (el módulo todavía existe en este caso).
@end deffn

@geindex PyImport_AddModuleRef (C function)
@anchor{c-api/import c PyImport_AddModuleRef}@anchor{44c}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_AddModuleRef (const char *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return the module object corresponding to a module name.

The `name' argument may be of the form @code{package.module}. First check the
modules dictionary if there’s one there, and if not, create a new one and
insert it in the modules dictionary.

Return a @ref{431,,strong reference} to the module on success. Return @code{NULL}
with an exception set on failure.

The module name `name' is decoded from UTF-8.

This function does not load or import the module; if the module wasn’t
already loaded, you will get an empty module object. Use
@ref{273,,PyImport_ImportModule()} or one of its variants to import a module.
Package structures implied by a dotted name for `name' are not created if
not already present.


Added in version 3.13.

@end deffn

@geindex PyImport_AddModuleObject (C function)
@anchor{c-api/import c PyImport_AddModuleObject}@anchor{493b}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_AddModuleObject (PyObject *name)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Similar to @ref{44c,,PyImport_AddModuleRef()}, but return a @ref{432,,borrowed reference} and `name' is a Python @ref{237,,str} object.


Added in version 3.3.

@end deffn

@geindex PyImport_AddModule (C function)
@anchor{c-api/import c PyImport_AddModule}@anchor{44d}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_AddModule (const char *name)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Similar to @ref{44c,,PyImport_AddModuleRef()}, but return a @ref{432,,borrowed reference}.
@end deffn

@geindex PyImport_ExecCodeModule (C function)
@anchor{c-api/import c PyImport_ExecCodeModule}@anchor{493c}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ExecCodeModule (const char *name, PyObject *co)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;compile

Given a module name (possibly of the form @code{package.module}) and a code object
read from a Python bytecode file or obtained from the built-in function
@ref{2fb,,compile()}, load the module.  Return a new reference to the module object,
or @code{NULL} with an exception set if an error occurred.  `name'
is removed from @ref{1976,,sys.modules} in error cases, even if `name' was already
in @ref{1976,,sys.modules} on entry to @ref{493c,,PyImport_ExecCodeModule()}.  Leaving
incompletely initialized modules in @ref{1976,,sys.modules} is dangerous, as imports of
such modules have no way to know that the module object is an unknown (and
probably damaged with respect to the module author’s intents) state.

The module’s @ref{1f16,,__spec__} and @ref{1e2,,__loader__} will be
set, if not set already, with the appropriate values.  The spec’s loader
will be set to the module’s @code{__loader__} (if set) and to an instance
of @ref{10f0,,SourceFileLoader} otherwise.

The module’s @ref{1f1b,,__file__} attribute will be set to the code
object’s @ref{13cd,,co_filename}.  If applicable,
@ref{1cb,,__cached__} will also be set.

Esta función volverá a cargar el módulo si ya se importó. Consulte @ref{4945,,PyImport_ReloadModule()} para conocer la forma prevista de volver a cargar un módulo.

Si `name' apunta a un nombre punteado de la forma @code{package.module}, cualquier estructura de paquete que no se haya creado aún no se creará.

Ver también @ref{493d,,PyImport_ExecCodeModuleEx()} y @ref{493f,,PyImport_ExecCodeModuleWithPathnames()}.


Distinto en la versión 3.12: The setting of @ref{1cb,,__cached__} and @ref{1e2,,__loader__}
is deprecated. See @ref{1e69,,ModuleSpec} for
alternatives.

@end deffn

@geindex PyImport_ExecCodeModuleEx (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleEx}@anchor{493d}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ExecCodeModuleEx (const char *name, PyObject *co, const char *pathname)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Like @ref{493c,,PyImport_ExecCodeModule()}, but the @ref{1f1b,,__file__}
attribute of the module object is set to `pathname' if it is non-@code{NULL}.

Ver también @ref{493f,,PyImport_ExecCodeModuleWithPathnames()}.
@end deffn

@geindex PyImport_ExecCodeModuleObject (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleObject}@anchor{493e}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ExecCodeModuleObject (PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Like @ref{493d,,PyImport_ExecCodeModuleEx()}, but the @ref{1cb,,__cached__}
attribute of the module object is set to `cpathname' if it is
non-@code{NULL}.  Of the three functions, this is the preferred one to use.


Added in version 3.3.



Distinto en la versión 3.12: Setting @ref{1cb,,__cached__} is deprecated. See
@ref{1e69,,ModuleSpec} for alternatives.

@end deffn

@geindex PyImport_ExecCodeModuleWithPathnames (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleWithPathnames}@anchor{493f}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_ExecCodeModuleWithPathnames (const char *name, PyObject *co, const char *pathname, const char *cpathname)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Como @ref{493e,,PyImport_ExecCodeModuleObject()}, pero `name', `pathname' y `cpathname' son cadenas de caracteres codificadas UTF-8. También se intenta averiguar cuál debe ser el valor de `pathname' de `cpathname' si el primero se establece en @code{NULL}.


Added in version 3.2.



Distinto en la versión 3.3: Uses @code{imp.source_from_cache()} in calculating the source path if
only the bytecode path is provided.



Distinto en la versión 3.12: No longer uses the removed @code{imp} module.

@end deffn

@geindex PyImport_GetMagicNumber (C function)
@anchor{c-api/import c PyImport_GetMagicNumber}@anchor{1212}
@deffn {C Función} long PyImport_GetMagicNumber ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el número mágico para los archivos de `bytecode' de Python (también conocido como archivos @code{.pyc}). El número mágico debe estar presente en los primeros cuatro bytes del archivo de código de bytes, en orden de bytes `little-endian'. Retorna @code{-1} en caso de error.


Distinto en la versión 3.3: Retorna un valor de @code{-1} en caso de error.

@end deffn

@geindex PyImport_GetMagicTag (C function)
@anchor{c-api/import c PyImport_GetMagicTag}@anchor{4940}
@deffn {C Función} const char *PyImport_GetMagicTag ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna la cadena de caracteres de etiqueta mágica para nombres de archivo de código de bytes Python en formato 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}. Tenga en cuenta que el valor en @code{sys.implementation.cache_tag} es autoritario y debe usarse en lugar de esta función.


Added in version 3.2.

@end deffn

@geindex PyImport_GetModuleDict (C function)
@anchor{c-api/import c PyImport_GetModuleDict}@anchor{4941}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_GetModuleDict ()
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el diccionario utilizado para la administración del módulo (también conocido como @code{sys.modules}). Tenga en cuenta que esta es una variable por intérprete.
@end deffn

@geindex PyImport_GetModule (C function)
@anchor{c-api/import c PyImport_GetModule}@anchor{c3b}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_GetModule (PyObject *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.8.'
Retorna el módulo ya importado con el nombre dado. Si el módulo aún no se ha importado, retorna @code{NULL} pero no establece un error. Retorna @code{NULL} y establece un error si falla la búsqueda.


Added in version 3.7.

@end deffn

@geindex PyImport_GetImporter (C function)
@anchor{c-api/import c PyImport_GetImporter}@anchor{171c}
@deffn {C Función} @ref{42d,,PyObject} *PyImport_GetImporter (PyObject *path)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a finder object for a @ref{27e,,sys.path}/@code{pkg.__path__} item
`path', possibly by fetching it from the @ref{684,,sys.path_importer_cache}
dict.  If it wasn’t yet cached, traverse @ref{10a0,,sys.path_hooks} until a hook
is found that can handle the path item.  Return @code{None} if no hook could;
this tells our caller that the @ref{1ff9,,path based finder} could not find a
finder for this path item. Cache the result in @ref{684,,sys.path_importer_cache}.
Return a new reference to the finder object.
@end deffn

@geindex PyImport_ImportFrozenModuleObject (C function)
@anchor{c-api/import c PyImport_ImportFrozenModuleObject}@anchor{4943}
@deffn {C Función} int PyImport_ImportFrozenModuleObject (PyObject *name)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Carga un módulo congelado llamado `name'. Retorna @code{1} para el éxito, @code{0} si no se encuentra el módulo y @code{-1} con una excepción establecida si falla la inicialización. Para acceder al módulo importado con una carga exitosa, use @ref{273,,PyImport_ImportModule()}. (Tenga en cuenta el nombre inapropiado — esta función volvería a cargar el módulo si ya se importó).


Added in version 3.3.



Distinto en la versión 3.4: El atributo @code{__file__} ya no está establecido en el módulo.

@end deffn

@geindex PyImport_ImportFrozenModule (C function)
@anchor{c-api/import c PyImport_ImportFrozenModule}@anchor{4942}
@deffn {C Función} int PyImport_ImportFrozenModule (const char *name)
` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4943,,PyImport_ImportFrozenModuleObject()}, pero el nombre es una cadena de caracteres codificada UTF-8 en lugar de un objeto Unicode.
@end deffn

@geindex _frozen (C struct)
@anchor{c-api/import c _frozen}@anchor{80f}
@deffn {C Estructura} struct _frozen

@geindex freeze utility

Esta es la definición del tipo de estructura para los descriptores de módulos congelados, según lo generado con la herramienta @code{freeze} (ver @code{Tools/freeze} en la distribución de código fuente de Python). Su definición, que se encuentra en @code{Include/import.h}, es:

@example
struct _frozen @{
    const char *name;
    const unsigned char *code;
    int size;
    bool is_package;
@};
@end example


Distinto en la versión 3.11: El nuevo campo @code{is_package} indica si el módulo es un paquete o no. Esto sustituye a la configuración del campo @code{size} con un valor negativo.

@end deffn

@geindex PyImport_FrozenModules (C var)
@anchor{c-api/import c PyImport_FrozenModules}@anchor{3003}
@deffn {C Variable} const struct @ref{80f,,_frozen} *PyImport_FrozenModules

Este puntero se inicializa para apuntar a un arreglo de registros @ref{80f,,_frozen}, terminado por uno cuyos registros son todos @code{NULL} o cero. Cuando se importa un módulo congelado, se busca en esta tabla. El código de terceros podría jugar con esto para proporcionar una colección de módulos congelados creada dinámicamente.
@end deffn

@geindex PyImport_AppendInittab (C function)
@anchor{c-api/import c PyImport_AppendInittab}@anchor{17ab}
@deffn {C Función} int PyImport_AppendInittab (const char *name, PyObject *(*initfunc)(void))
` Part of the @ref{5f6,,Stable ABI}.'
Agrega un solo módulo a la tabla existente de módulos incorporados. Este es un contenedor conveniente @ref{17ac,,PyImport_ExtendInittab()}, que retorna @code{-1} si la tabla no se puede extender. El nuevo módulo se puede importar con el nombre `name', y utiliza la función `initfunc' como la función de inicialización llamada en el primer intento de importación. Esto debería llamarse antes de @ref{247,,Py_Initialize()}.
@end deffn

@geindex _inittab (C struct)
@anchor{c-api/import c _inittab}@anchor{4a7c}
@deffn {C Estructura} struct _inittab

Structure describing a single entry in the list of built-in modules.
Programs which
embed Python may use an array of these structures in conjunction with
@ref{17ac,,PyImport_ExtendInittab()} to provide additional built-in modules.
The structure consists of two members:

@geindex _inittab.name (C member)
@anchor{c-api/import c _inittab name}@anchor{4a7d}
@deffn {C Miembro} const char *name

The module name, as an ASCII encoded string.
@end deffn

@geindex _inittab.initfunc (C member)
@anchor{c-api/import c _inittab initfunc}@anchor{4a7e}
@deffn {C Miembro} @ref{42d,,PyObject} *(*initfunc)(void)

Initialization function for a module built into the interpreter.
@end deffn
@end deffn

@geindex PyImport_ExtendInittab (C function)
@anchor{c-api/import c PyImport_ExtendInittab}@anchor{17ac}
@deffn {C Función} int PyImport_ExtendInittab (struct _inittab *newtab)

Add a collection of modules to the table of built-in modules.  The `newtab'
array must end with a sentinel entry which contains @code{NULL} for the @ref{4a7d,,name}
field; failure to provide the sentinel value can result in a memory fault.
Returns @code{0} on success or @code{-1} if insufficient memory could be allocated to
extend the internal table.  In the event of failure, no modules are added to the
internal table.  This must be called before @ref{247,,Py_Initialize()}.

Si Python es inicializado múltiples veces, se debe llamar @ref{17ab,,PyImport_AppendInittab()} o @ref{17ac,,PyImport_ExtendInittab()} antes de cada inicialización de Python.
@end deffn

@node Soporte de empaquetado marshalling de datos,Analizando argumentos y construyendo valores,Importando módulos<2>,Utilidades<2>
@anchor{c-api/marshal doc}@anchor{4a7f}@anchor{c-api/marshal data-marshalling-support}@anchor{4a80}@anchor{c-api/marshal marshalling-utils}@anchor{4a81}
@subsection Soporte de empaquetado (`marshalling') de datos


Estas rutinas permiten que el código C funcione con objetos serializados utilizando el mismo formato de datos que el módulo @ref{8d,,marshal}. Hay funciones para escribir datos en el formato de serialización y funciones adicionales que se pueden usar para volver a leer los datos. Los archivos utilizados para almacenar datos ordenados deben abrirse en modo binario.

Los valores numéricos se almacenan con el byte menos significativo primero.

The module supports several versions of the data format; see
the @ref{8d,,Python module documentation} for details.

@geindex Py_MARSHAL_VERSION (C macro)
@anchor{c-api/marshal c Py_MARSHAL_VERSION}@anchor{4a82}
@deffn {C Macro} Py_MARSHAL_VERSION

The current format version. See @ref{28b4,,marshal.version}.
@end deffn

@geindex PyMarshal_WriteLongToFile (C function)
@anchor{c-api/marshal c PyMarshal_WriteLongToFile}@anchor{82f}
@deffn {C Función} void PyMarshal_WriteLongToFile (long value, FILE *file, int version)

Empaqueta (`marshal') un entero `value' long a un archivo `file'. Esto solo escribirá los 32 bits menos significativos de `value'; sin importar el tamaño del tipo long nativo. `version' indica el formato del archivo.

Esta función puede fallar, en cuyo caso establece el indicador de error. Utiliza @ref{18fa,,PyErr_Occurred()} para comprobarlo.
@end deffn

@geindex PyMarshal_WriteObjectToFile (C function)
@anchor{c-api/marshal c PyMarshal_WriteObjectToFile}@anchor{830}
@deffn {C Función} void PyMarshal_WriteObjectToFile (PyObject *value, FILE *file, int version)

Empaqueta (`marshal') un objeto Python, `value', a un archivo `file'. `version' indica el formato del archivo.

Esta función puede fallar, en cuyo caso establece el indicador de error. Utiliza @ref{18fa,,PyErr_Occurred()} para comprobarlo.
@end deffn

@geindex PyMarshal_WriteObjectToString (C function)
@anchor{c-api/marshal c PyMarshal_WriteObjectToString}@anchor{832}
@deffn {C Función} @ref{42d,,PyObject} *PyMarshal_WriteObjectToString (PyObject *value, int version)
`Return value: New reference.'
Retorna un objeto de bytes que contiene la representación empaquetada (`marshalled') de `value'. `version' indica el formato del archivo.
@end deffn

Las siguientes funciones permiten volver a leer los valores empaquetados (`marshalled').

@geindex PyMarshal_ReadLongFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadLongFromFile}@anchor{4a83}
@deffn {C Función} long PyMarshal_ReadLongFromFile (FILE *file)

Retorna un entero long de C desde el flujo de datos FILE* abierto para lectura. Solo se puede leer un valor de 32 bits con esta función, independientemente del tamaño nativo del tipo long.

En caso de error, establece la excepción apropiada (@ref{1341,,EOFError}) y retorna @code{-1}.
@end deffn

@geindex PyMarshal_ReadShortFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadShortFromFile}@anchor{4a84}
@deffn {C Función} int PyMarshal_ReadShortFromFile (FILE *file)

Retorna un entero short de C desde el flujo de datos FILE* abierto para lectura. Solo se puede leer un valor de 16 bits con esta función, independientemente del tamaño nativo del tipo short.

En caso de error, establece la excepción apropiada (@ref{1341,,EOFError}) y retorna @code{-1}.
@end deffn

@geindex PyMarshal_ReadObjectFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadObjectFromFile}@anchor{4a85}
@deffn {C Función} @ref{42d,,PyObject} *PyMarshal_ReadObjectFromFile (FILE *file)
`Return value: New reference.'
Retorna un objeto Python del flujo de datos FILE* abierto para lectura.

En caso de error, establece la excepción apropiada (@ref{1341,,EOFError}, @ref{360,,ValueError} o @ref{228,,TypeError}) y retorna @code{NULL}.
@end deffn

@geindex PyMarshal_ReadLastObjectFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadLastObjectFromFile}@anchor{4a86}
@deffn {C Función} @ref{42d,,PyObject} *PyMarshal_ReadLastObjectFromFile (FILE *file)
`Return value: New reference.'
Retorna un objeto Python del flujo de datos FILE* abierto para lectura.
A diferencia de @ref{4a85,,PyMarshal_ReadObjectFromFile()}, esta función asume que no se leerán más objetos del archivo, lo que le permite cargar agresivamente los datos del archivo en la memoria para que la deserialización pueda operar desde dichos datos en lugar de leer un byte a la vez desde el archivo. Solo use esta variante si está seguro de que no leerá nada más del archivo.

En caso de error, establece la excepción apropiada (@ref{1341,,EOFError}, @ref{360,,ValueError} o @ref{228,,TypeError}) y retorna @code{NULL}.
@end deffn

@geindex PyMarshal_ReadObjectFromString (C function)
@anchor{c-api/marshal c PyMarshal_ReadObjectFromString}@anchor{831}
@deffn {C Función} @ref{42d,,PyObject} *PyMarshal_ReadObjectFromString (const char *data, Py_ssize_t len)
`Return value: New reference.'
Retorna un objeto Python del flujo de datos en un búfer de bytes que contiene `len' bytes a los que apunta `data'.

En caso de error, establece la excepción apropiada (@ref{1341,,EOFError}, @ref{360,,ValueError} o @ref{228,,TypeError}) y retorna @code{NULL}.
@end deffn

@node Analizando argumentos y construyendo valores,Conversión y formato de cadenas de caracteres,Soporte de empaquetado marshalling de datos,Utilidades<2>
@anchor{c-api/arg doc}@anchor{4a87}@anchor{c-api/arg arg-parsing}@anchor{941}@anchor{c-api/arg parsing-arguments-and-building-values}@anchor{4a88}
@subsection Analizando argumentos y construyendo valores


Estas funciones son útiles al crear sus propias funciones y métodos de extensiones. Información y ejemplos adicionales están disponibles en @ref{1be2,,Ampliación e incrustación del intérprete de Python}.

Las tres primeras de estas funciones descritas, @ref{615,,PyArg_ParseTuple()}, @ref{475,,PyArg_ParseTupleAndKeywords()}, y @ref{19ed,,PyArg_Parse()}, todas usan `cadenas de caracteres de formato' que se utilizan para contarle a la función sobre los argumentos esperados. Las cadenas de caracteres de formato utilizan la misma sintaxis para cada una de estas funciones.

@menu
* Analizando argumentos:: 
* Construyendo valores:: 

@end menu

@node Analizando argumentos,Construyendo valores,,Analizando argumentos y construyendo valores
@anchor{c-api/arg parsing-arguments}@anchor{4a89}
@subsubsection Analizando argumentos


Una cadena de formato consta de cero o más «unidades de formato.» Una unidad de formato describe un objeto Python; por lo general es un solo carácter o una secuencia de unidades formato entre paréntesis. Con unas pocas excepciones, una unidad de formato que no es una secuencia entre paréntesis normalmente corresponde a un único argumento de dirección de estas funciones. En la siguiente descripción, la forma citada es la unidad de formato; la entrada en paréntesis (redondos) es el tipo de objeto Python que coincida con la unidad de formato; y la entrada entre corchetes [cuadrados] es el tipo de la variable(s) C cuya dirección debe ser pasada.

@menu
* Cadena de caracteres y búferes:: 
* Números: Números<2>. 
* Otros objetos:: 
* Funciones API:: 

@end menu

@node Cadena de caracteres y búferes,Números<2>,,Analizando argumentos
@anchor{c-api/arg arg-parsing-string-and-buffers}@anchor{47d}@anchor{c-api/arg strings-and-buffers}@anchor{4a8a}
@subsubsection Cadena de caracteres y búferes


@cartouche
@quotation Nota 
On Python 3.12 and older, the macro @code{PY_SSIZE_T_CLEAN} must be
defined before including @code{Python.h} to use all @code{#} variants of
formats (@code{s#}, @code{y#}, etc.) explained below.
This is not necessary on Python 3.13 and later.
@end quotation
@end cartouche

Estos formatos permiten acceder a un objeto como un bloque contiguo de memoria. Usted no tiene que proporcionar almacenamiento en bruto para el Unicode o área de bytes retornada.

A menos que se indique lo contrario, los búferes no son terminados en NULL (`NUL-terminated').

There are three ways strings and buffers can be converted to C:


@itemize *

@item 
Formats such as @code{y*} and @code{s*} fill a @ref{7f2,,Py_buffer} structure.
This locks the underlying buffer so that the caller can subsequently use
the buffer even inside a @ref{484e,,Py_BEGIN_ALLOW_THREADS}
block without the risk of mutable data being resized or destroyed.
As a result, `you have to call' @ref{48d,,PyBuffer_Release()} after you have
finished processing the data (or in any early abort case).

@item 
The @code{es}, @code{es#}, @code{et} and @code{et#} formats allocate the result buffer.
`You have to call' @ref{1482,,PyMem_Free()} after you have finished
processing the data (or in any early abort case).

@item @anchor{c-api/arg c-arg-borrowed-buffer}@anchor{4a8b}
Other formats take a @ref{237,,str} or a read-only @ref{db4,,bytes-like object},
such as @ref{325,,bytes}, and provide a @code{const char *} pointer to
its buffer.
In this case the buffer is «borrowed»: it is managed by the corresponding
Python object, and shares the lifetime of this object.
You won’t have to release any memory yourself.

To ensure that the underlying buffer may be safely borrowed, the object’s
@ref{7fd,,PyBufferProcs.bf_releasebuffer} field must be @code{NULL}.
This disallows common mutable objects such as @ref{5e0,,bytearray},
but also some read-only objects such as @ref{156,,memoryview} of
@ref{325,,bytes}.

Besides this @code{bf_releasebuffer} requirement, there is no check to verify
whether the input object is immutable (e.g. whether it would honor a request
for a writable buffer, or whether another thread can mutate the data).
@end itemize


@table @asis

@item @code{s} (@ref{237,,str}) [const char *]

Convierte un objeto Unicode a un puntero C a una cadena de caracteres. Un puntero a una cadena de caracteres existente se almacena en la variable puntero del carácter cuya dirección se pasa. La cadena de caracteres en C es terminada en NULL. La cadena de caracteres de Python no debe contener puntos de código incrustado nulos; si lo hace, se lanza una excepción @ref{360,,ValueError}. Los objetos Unicode se convierten en cadenas de caracteres de C utilizando codificación @code{'utf-8'}. Si esta conversión fallase lanza un @ref{130f,,UnicodeError}.

@cartouche
@quotation Nota 
Este formato no acepta @ref{db4,,objetos de tipo bytes}. Si desea aceptar los caminos del sistema de archivos y convertirlos en cadenas de caracteres C, es preferible utilizar el formato @code{O&} con @code{PyUnicode_FSConverter()} como convertidor.
@end quotation
@end cartouche


Distinto en la versión 3.5: Anteriormente, @ref{228,,TypeError} se lanzó cuando se encontraron puntos de código nulos incrustados en la cadena de caracteres de Python.


@item @code{s*} (@ref{237,,str} o @ref{db4,,bytes-like object}) [Py_buffer]

Este formato acepta objetos Unicode, así como objetos de tipo bytes. Llena una estructura  @ref{7f2,,Py_buffer} proporcionada por la persona que llama. En este caso la cadena de caracteres de C resultante puede contener bytes NUL embebidos. Los objetos Unicode se convierten en cadenas de caracteres C utilizando codificación @code{'utf-8'}.

@item @code{s#} (@ref{237,,str}, @ref{db4,,bytes-like object} de sólo lectura) [const char *, @ref{af0,,Py_ssize_t}]

Like @code{s*}, except that it provides a @ref{4a8b,,borrowed buffer}.
The result is stored into two C variables,
the first one a pointer to a C string, the second one its length.
The string may contain embedded null bytes. Unicode objects are converted
to C strings using @code{'utf-8'} encoding.

@item @code{z} (@ref{237,,str} o @code{None}) [const char *]

Como @code{s}, pero el objeto Python también puede ser @code{None}, en cuyo caso el puntero C se establece en @code{NULL}.

@item @code{z*} (@ref{237,,str}, @ref{db4,,bytes-like object} o @code{None}) [Py_buffer]

Como @code{s*}, pero el objeto Python también puede ser @code{None}, en cuyo caso el miembro de @code{buf} de la estructura @ref{7f2,,Py_buffer} se establece en @code{NULL}.

@item @code{z#} (@ref{237,,str}, @ref{db4,,bytes-like object} de sólo lectura o @code{None}) [const char *, @ref{af0,,Py_ssize_t}]

Como @code{s#}, pero el objeto Python también puede ser @code{None}, en cuyo caso el puntero C se establece en @code{NULL}.

@item @code{y} (@ref{db4,,bytes-like object} de sólo lectura) [const char *]

This format converts a bytes-like object to a C pointer to a
@ref{4a8b,,borrowed} character string;
it does not accept Unicode objects.  The bytes buffer must not
contain embedded null bytes; if it does, a @ref{360,,ValueError}
exception is raised.


Distinto en la versión 3.5: Anteriormente, @ref{228,,TypeError} se lanzó cuando bytes nulos incrustados se encontraron en el buffer de bytes.


@item @code{y*} (@ref{db4,,bytes-like object}) [Py_buffer]

Esta variante de @code{s*} no acepta objetos Unicode, solamente los objetos de tipo bytes. `Esta es la forma recomendada para aceptar datos binarios.'

@item @code{y#} (@ref{db4,,bytes-like object} de sólo lectura) [const char *, @ref{af0,,Py_ssize_t}]

Esta variante en @code{s#} no acepta objetos Unicode, solo objetos similares a bytes.

@item @code{S} (@ref{325,,bytes}) [PyBytesObject *]

Requires that the Python object is a @ref{325,,bytes} object, without
attempting any conversion.  Raises @ref{228,,TypeError} if the object is not
a bytes object.  The C variable may also be declared as @ref{42d,,PyObject}*.

@item @code{Y} (@ref{5e0,,bytearray}) [PyByteArrayObject *]

Requires that the Python object is a @ref{5e0,,bytearray} object, without
attempting any conversion.  Raises @ref{228,,TypeError} if the object is not
a @ref{5e0,,bytearray} object. The C variable may also be declared as @ref{42d,,PyObject}*.

@item @code{U} (@ref{237,,str}) [PyObject *]

Requires that the Python object is a Unicode object, without attempting
any conversion.  Raises @ref{228,,TypeError} if the object is not a Unicode
object.  The C variable may also be declared as @ref{42d,,PyObject}*.

@item @code{w*} (@ref{db4,,bytes-like object} de lectura y escritura) [Py_buffer]

Este formato acepta cualquier objeto que implemente la interfaz del búfer de lectura-escritura. Llena la estructura @ref{7f2,,Py_buffer} proporcionada por quien llama. El búfer puede contener bytes nulos incrustados. Quien llama tiene que llamar @ref{48d,,PyBuffer_Release()} cuando termina con el búfer.

@item @code{es} (@ref{237,,str}) [const char *encoding, char **buffer]

Esta variante en @code{s} se usa para codificar Unicode en un búfer de caracteres. Solo funciona para datos codificados sin bytes NUL integrados.

This format requires two arguments.  The first is only used as input, and
must be a const char* which points to the name of an encoding as a
NUL-terminated string, or @code{NULL}, in which case @code{'utf-8'} encoding is used.
An exception is raised if the named encoding is not known to Python.  The
second argument must be a char**; the value of the pointer it
references will be set to a buffer with the contents of the argument text.
The text will be encoded in the encoding specified by the first argument.

@ref{615,,PyArg_ParseTuple()} asignará un búfer del tamaño necesitado, copiará los datos codificados en este búfer y ajustará `*buffer' para referenciar el nuevo almacenamiento asignado. Quien llama es responsable para llamar @ref{1482,,PyMem_Free()} para liberar el búfer asignado después de su uso.

@item @code{et} (@ref{237,,str}, @ref{325,,bytes} o @ref{5e0,,bytearray}) [const char *encoding, char **buffer]

Igual que @code{es}, excepto que los objetos de cadena de caracteres de bytes se pasan sin recodificarlos. En cambio, la implementación supone que el objeto de cadena de caracteres de bytes utiliza la codificación que se pasa como parámetro.

@item @code{es#} (@ref{237,,str}) [const char *encoding, char **buffer, @ref{af0,,Py_ssize_t} *buffer_length]

Esta variante en @code{s#} se usa para codificar Unicode en un búfer de caracteres. A diferencia del formato @code{es}, esta variante permite datos de entrada que contienen caracteres NUL.

It requires three arguments.  The first is only used as input, and must be a
const char* which points to the name of an encoding as a
NUL-terminated string, or @code{NULL}, in which case @code{'utf-8'} encoding is used.
An exception is raised if the named encoding is not known to Python.  The
second argument must be a char**; the value of the pointer it
references will be set to a buffer with the contents of the argument text.
The text will be encoded in the encoding specified by the first argument.
The third argument must be a pointer to an integer; the referenced integer
will be set to the number of bytes in the output buffer.

Hay dos modos de operación:

Si `*buffer' señala un puntero @code{NULL}, la función asignará un búfer del tamaño necesario, copiará los datos codificados en este búfer y configurará `*buffer' para hacer referencia al almacenamiento recién asignado. Quien llama es responsable de llamar a @ref{1482,,PyMem_Free()} para liberar el búfer asignado después del uso.

Si `*buffer' apunta a un puntero no @code{NULL} (un búfer ya asignado), @ref{615,,PyArg_ParseTuple()} usará esta ubicación como el búfer e interpretará el valor inicial de `*buffer_length' como el tamaño del búfer. Luego copiará los datos codificados en el búfer y los terminará en NUL. Si el búfer no es lo suficientemente grande, se establecerá a @ref{360,,ValueError}.

En ambos casos, `*buffer_length' se establece a la longitud de los datos codificados sin el byte NUL final.

@item @code{et#} (@ref{237,,str}, @ref{325,,bytes} o @ref{5e0,,bytearray}) [const char *encoding, char **buffer, @ref{af0,,Py_ssize_t} *buffer_length]

Igual que @code{es#}, excepto que los objetos de cadena de caracteres de bytes se pasan sin recodificarlos. En cambio, la implementación supone que el objeto de cadena de caracteres de bytes utiliza la codificación que se pasa como parámetro.
@end table


Distinto en la versión 3.12: @code{u}, @code{u#}, @code{Z}, and @code{Z#} are removed because they used a legacy
@code{Py_UNICODE*} representation.


@node Números<2>,Otros objetos,Cadena de caracteres y búferes,Analizando argumentos
@anchor{c-api/arg numbers}@anchor{4a8c}
@subsubsection Números



@table @asis

@item @code{b} (@ref{1f0,,int}) [unsigned char]

Convert a nonnegative Python integer to an unsigned tiny int, stored in a C
unsigned char.

@item @code{B} (@ref{1f0,,int}) [unsigned char]

Convert a Python integer to a tiny int without overflow checking, stored in a C
unsigned char.

@item @code{h} (@ref{1f0,,int}) [short int]

Convert a Python integer to a C short int.

@item @code{H} (@ref{1f0,,int}) [unsigned short int]

Convert a Python integer to a C unsigned short int, without overflow
checking.

@item @code{i} (@ref{1f0,,int}) [int]

Convert a Python integer to a plain C int.

@item @code{I} (@ref{1f0,,int}) [unsigned int]

Convert a Python integer to a C unsigned int, without overflow
checking.

@item @code{l} (@ref{1f0,,int}) [long int]

Convert a Python integer to a C long int.

@item @code{k} (@ref{1f0,,int}) [unsigned long]

Convert a Python integer to a C unsigned long without
overflow checking.

@item @code{L} (@ref{1f0,,int}) [long long]

Convert a Python integer to a C long long.

@item @code{K} (@ref{1f0,,int}) [unsigned long long]

Convert a Python integer to a C unsigned long long
without overflow checking.

@item @code{n} (@ref{1f0,,int}) [@ref{af0,,Py_ssize_t}]

Convierte un entero de Python a un @ref{af0,,Py_ssize_t} de C.

@item @code{c} (@ref{325,,bytes} o @ref{5e0,,bytearray} de largo 1) [char]

Convert a Python byte, represented as a @ref{325,,bytes} or
@ref{5e0,,bytearray} object of length 1, to a C char.


Distinto en la versión 3.3: Permite objetos @ref{5e0,,bytearray}.


@item @code{C} (@ref{237,,str} de largo 1) [int]

Convert a Python character, represented as a @ref{237,,str} object of
length 1, to a C int.

@item @code{f} (@ref{153,,float}) [float]

Convert a Python floating-point number to a C float.

@item @code{d} (@ref{153,,float}) [double]

Convert a Python floating-point number to a C double.

@item @code{D} (@ref{154,,complex}) [Py_complex]

Convierte un número complejo de Python en una estructura @ref{4a8d,,Py_complex} de C.
@end table

@node Otros objetos,Funciones API,Números<2>,Analizando argumentos
@anchor{c-api/arg other-objects}@anchor{4a8e}
@subsubsection Otros objetos



@table @asis

@item @code{O} (object) [PyObject *]

Store a Python object (without any conversion) in a C object pointer.  The C
program thus receives the actual object that was passed.  A new
@ref{431,,strong reference} to the object is not created
(i.e. its reference count is not increased).
The pointer stored is not @code{NULL}.

@item @code{O!} (object) [`typeobject', PyObject *]

Store a Python object in a C object pointer.  This is similar to @code{O}, but
takes two C arguments: the first is the address of a Python type object, the
second is the address of the C variable (of type @ref{42d,,PyObject}*) into which
the object pointer is stored.  If the Python object does not have the required
type, @ref{228,,TypeError} is raised.
@end table
@anchor{c-api/arg o-ampersand}@anchor{4a8f}

@table @asis

@item @code{O&} (object) [`converter', `anything']

Convert a Python object to a C variable through a `converter' function.  This
takes two arguments: the first is a function, the second is the address of a C
variable (of arbitrary type), converted to void*.  The `converter'
function in turn is called as follows:

@example
status = converter(object, address);
@end example

where `object' is the Python object to be converted and `address' is the
void* argument that was passed to the @code{PyArg_Parse*} function.
The returned `status' should be @code{1} for a successful conversion and @code{0} if
the conversion has failed.  When the conversion fails, the `converter' function
should raise an exception and leave the content of `address' unmodified.

Si el `converter' retorna @code{Py_CLEANUP_SUPPORTED}, se puede llamar por segunda vez si el análisis del argumento finalmente falla, dando al convertidor la oportunidad de liberar cualquier memoria que ya haya asignado. En esta segunda llamada, el parámetro `object' será @code{NULL}; `address' tendrá el mismo valor que en la llamada original.


Distinto en la versión 3.1: @code{Py_CLEANUP_SUPPORTED} fue agregada.


@item @code{p} (@ref{513,,bool}) [int]

Prueba el valor pasado por verdad (un booleano predicado `p') y convierte el resultado a su valor entero C verdadero/falso entero equivalente. Establece int en @code{1} si la expresión era verdadera y @code{0} si era falsa. Esto acepta cualquier valor válido de Python. Consulte @ref{2162,,Evaluar como valor verdadero/falso} para obtener más información sobre cómo Python prueba los valores por verdad.


Added in version 3.3.


@item @code{(items)} (@ref{464,,tuple}) [`matching-items']

El objeto debe ser una secuencia de Python cuya longitud es el número de unidades de formato en `items'. Los argumentos C deben corresponder a las unidades de formato individuales en `items'. Las unidades de formato para secuencias pueden estar anidadas.
@end table

It is possible to pass «long» integers (integers whose value exceeds the
platform’s @code{LONG_MAX}) however no proper range checking is done — the
most significant bits are silently truncated when the receiving field is too
small to receive the value (actually, the semantics are inherited from downcasts
in C — your mileage may vary).

Algunos otros caracteres tienen un significado en una cadena de formato. Esto puede no ocurrir dentro de paréntesis anidados. Son:


@table @asis

@item @code{|}

Indica que los argumentos restantes en la lista de argumentos de Python son opcionales. Las variables C correspondientes a argumentos opcionales deben inicializarse a su valor predeterminado — cuando no se especifica un argumento opcional, @ref{615,,PyArg_ParseTuple()} no toca el contenido de las variables C correspondientes.

@item @code{$}

@ref{475,,PyArg_ParseTupleAndKeywords()} solamente: indica que los argumentos restantes en la lista de argumentos de Python son solo palabras clave. Actualmente, todos los argumentos de solo palabras clave también deben ser argumentos opcionales, por lo que @code{|} siempre debe especificarse antes de @code{$} en la cadena de formato.


Added in version 3.3.


@item @code{:}

La lista de unidades de formato termina aquí; la cadena después de los dos puntos se usa como el nombre de la función en los mensajes de error (el «valor asociado» de la excepción que @ref{615,,PyArg_ParseTuple()} lanza).

@item @code{;}

La lista de unidades de formato termina aquí; la cadena después del punto y coma se usa como mensaje de error `en lugar de' del mensaje de error predeterminado. @code{:} y @code{;} se excluyen mutuamente.
@end table

Note that any Python object references which are provided to the caller are
`borrowed' references; do not release them
(i.e. do not decrement their reference count)!

Los argumentos adicionales pasados a estas funciones deben ser direcciones de variables cuyo tipo está determinado por la cadena de formato; Estos se utilizan para almacenar valores de la tupla de entrada. Hay algunos casos, como se describe en la lista de unidades de formato anterior, donde estos parámetros se utilizan como valores de entrada; deben coincidir con lo especificado para la unidad de formato correspondiente en ese caso.

For the conversion to succeed, the `arg' object must match the format
and the format must be exhausted.  On success, the
@code{PyArg_Parse*} functions return true, otherwise they return
false and raise an appropriate exception. When the
@code{PyArg_Parse*} functions fail due to conversion failure in one
of the format units, the variables at the addresses corresponding to that
and the following format units are left untouched.

@node Funciones API,,Otros objetos,Analizando argumentos
@anchor{c-api/arg api-functions}@anchor{4a90}
@subsubsection Funciones API


@geindex PyArg_ParseTuple (C function)
@anchor{c-api/arg c PyArg_ParseTuple}@anchor{615}
@deffn {C Función} int PyArg_ParseTuple (PyObject *args, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Analiza los parámetros de una función que solo toma parámetros posicionales en variables locales. Retorna verdadero en el éxito; en caso de fallo, retorna falso y lanza la excepción apropiada.
@end deffn

@geindex PyArg_VaParse (C function)
@anchor{c-api/arg c PyArg_VaParse}@anchor{48d9}
@deffn {C Función} int PyArg_VaParse (PyObject *args, const char *format, va_list vargs)
` Part of the @ref{5f6,,Stable ABI}.'
Idéntico a @ref{615,,PyArg_ParseTuple()}, excepto que acepta una `va_list' en lugar de un número variable de argumentos .
@end deffn

@geindex PyArg_ParseTupleAndKeywords (C function)
@anchor{c-api/arg c PyArg_ParseTupleAndKeywords}@anchor{475}
@deffn {C Función} int PyArg_ParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Parse the parameters of a function that takes both positional and keyword
parameters into local variables.
The `keywords' argument is a @code{NULL}-terminated array of keyword parameter
names specified as null-terminated ASCII or UTF-8 encoded C strings.
Empty names denote
@ref{b12,,positional-only parameters}.
Returns true on success; on failure, it returns false and raises the
appropriate exception.

@cartouche
@quotation Nota 
The `keywords' parameter declaration is char *const* in C and
const char *const* in C++.
This can be overridden with the @ref{477,,PY_CXX_CONST} macro.
@end quotation
@end cartouche


Distinto en la versión 3.6: Soporte agregado para @ref{b12,,sólo parámetros posicionales}.



Distinto en la versión 3.13: The `keywords' parameter has now type char *const* in C and
const char *const* in C++, instead of char**.
Added support for non-ASCII keyword parameter names.

@end deffn

@geindex PyArg_VaParseTupleAndKeywords (C function)
@anchor{c-api/arg c PyArg_VaParseTupleAndKeywords}@anchor{476}
@deffn {C Función} int PyArg_VaParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, va_list vargs)
` Part of the @ref{5f6,,Stable ABI}.'
Idéntico a @ref{475,,PyArg_ParseTupleAndKeywords()}, excepto que acepta una `va_list' en lugar de un número variable de argumentos.
@end deffn

@geindex PyArg_ValidateKeywordArguments (C function)
@anchor{c-api/arg c PyArg_ValidateKeywordArguments}@anchor{48da}
@deffn {C Función} int PyArg_ValidateKeywordArguments (PyObject*)
` Part of the @ref{5f6,,Stable ABI}.'
Asegúrese de que las claves en el diccionario de argumentos de palabras clave son cadenas. Esto solo es necesario si @ref{475,,PyArg_ParseTupleAndKeywords()} no se utiliza, ya que este último ya hace esta comprobación.


Added in version 3.2.

@end deffn

@geindex PyArg_Parse (C function)
@anchor{c-api/arg c PyArg_Parse}@anchor{19ed}
@deffn {C Función} int PyArg_Parse (PyObject *args, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Parse the parameter of a function that takes a single positional parameter
into a local variable.  Returns true on success; on failure, it returns
false and raises the appropriate exception.

Example:

@example
// Function using METH_O calling convention
static PyObject*
my_function(PyObject *module, PyObject *arg)
@{
    int value;
    if (!PyArg_Parse(arg, "i:my_function", &value)) @{
        return NULL;
    @}
    // ... use value ...
@}
@end example
@end deffn

@geindex PyArg_UnpackTuple (C function)
@anchor{c-api/arg c PyArg_UnpackTuple}@anchor{1548}
@deffn {C Función} int PyArg_UnpackTuple (PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
` Part of the @ref{5f6,,Stable ABI}.'
A simpler form of parameter retrieval which does not use a format string to
specify the types of the arguments.  Functions which use this method to retrieve
their parameters should be declared as @ref{154a,,METH_VARARGS} in function or
method tables.  The tuple containing the actual parameters should be passed as
`args'; it must actually be a tuple.  The length of the tuple must be at least
`min' and no more than `max'; `min' and `max' may be equal.  Additional
arguments must be passed to the function, each of which should be a pointer to a
@ref{42d,,PyObject}* variable; these will be filled in with the values from
`args'; they will contain @ref{432,,borrowed references}.
The variables which correspond
to optional parameters not given by `args' will not be filled in; these should
be initialized by the caller. This function returns true on success and false if
`args' is not a tuple or contains the wrong number of elements; an exception
will be set if there was a failure.

This is an example of the use of this function, taken from the sources for the
@code{_weakref} helper module for weak references:

@example
static PyObject *
weakref_ref(PyObject *self, PyObject *args)
@{
    PyObject *object;
    PyObject *callback = NULL;
    PyObject *result = NULL;

    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) @{
        result = PyWeakref_NewRef(object, callback);
    @}
    return result;
@}
@end example

La llamada a @ref{1548,,PyArg_UnpackTuple()} en este ejemplo es completamente equivalente a esta llamada a @ref{615,,PyArg_ParseTuple()}:

@example
PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
@end example
@end deffn

@geindex PY_CXX_CONST (C macro)
@anchor{c-api/arg c PY_CXX_CONST}@anchor{477}
@deffn {C Macro} PY_CXX_CONST

The value to be inserted, if any, before char *const*
in the `keywords' parameter declaration of
@ref{475,,PyArg_ParseTupleAndKeywords()} and
@ref{476,,PyArg_VaParseTupleAndKeywords()}.
Default empty for C and @code{const} for C++
(const char *const*).
To override, define it to the desired value before including
@code{Python.h}.


Added in version 3.13.

@end deffn

@node Construyendo valores,,Analizando argumentos,Analizando argumentos y construyendo valores
@anchor{c-api/arg building-values}@anchor{4a91}
@subsubsection Construyendo valores


@geindex Py_BuildValue (C function)
@anchor{c-api/arg c Py_BuildValue}@anchor{940}
@deffn {C Función} @ref{42d,,PyObject} *Py_BuildValue (const char *format, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a new value based on a format string similar to those accepted by the
@code{PyArg_Parse*} family of functions and a sequence of values.  Returns
the value or @code{NULL} in the case of an error; an exception will be raised if
@code{NULL} is returned.

@ref{940,,Py_BuildValue()} no siempre genera una tupla. Construye una tupla solo si su cadena de formato contiene dos o más unidades de formato. Si la cadena de formato está vacía, retorna @code{None}; si contiene exactamente una unidad de formato, retorna el objeto que describa esa unidad de formato. Para forzarlo a retornar una tupla de tamaño 0 o uno, paréntesis la cadena de formato.

Cuando los búfer de memoria se pasan como parámetros para suministrar datos para construir objetos, como para los formatos @code{s} y @code{s#}, los datos requeridos se copian. Las memorias intermedias proporcionadas por quien llama nunca son referenciadas por los objetos creados por @ref{940,,Py_BuildValue()}. En otras palabras, si su código invoca @code{malloc()} y pasa la memoria asignada a @ref{940,,Py_BuildValue()}, su código es responsable de llamar a @code{free()} para esa memoria una vez retorna @ref{940,,Py_BuildValue()}.

En la siguiente descripción, la cadena de caracteres entre comillas, @cite{así}, es la unidad de formato; la entrada entre paréntesis (redondos) es el tipo de objeto Python que retornará la unidad de formato; y la entrada entre corchetes [cuadrados] es el tipo de los valores C que se pasarán.

Los caracteres espacio, tabulación, dos puntos y coma se ignoran en las cadenas de formato (pero no dentro de las unidades de formato como @code{s#}). Esto se puede usar para hacer que las cadenas de formato largo sean un poco más legibles.


@table @asis

@item @code{s} (@ref{237,,str} o @code{None}) [const char *]

Convierte una cadena de caracteres C terminada en nulo en un objeto Python @ref{237,,str} usando la codificación @code{'utf-8'}. Si el puntero de la cadena de caracteres C es @code{NULL}, se usa @code{None}.

@item @code{s#} (@ref{237,,str} o @code{None}) [const char *, @ref{af0,,Py_ssize_t}]

Convierte una cadena de caracteres de C y su longitud en un objeto Python @ref{237,,str} utilizando la codificación @code{'utf-8'}. Si el puntero de la cadena de caracteres de C es @code{NULL}, la longitud se ignora y se retorna @code{None}.

@item @code{y} (@ref{325,,bytes}) [const char *]

Esto convierte una cadena de caracteres de C en un objeto Python @ref{325,,bytes}. Si el puntero de la cadena de caracteres de C es @code{NULL}, se retorna @code{None}.

@item @code{y#} (@ref{325,,bytes}) [const char *, @ref{af0,,Py_ssize_t}]

Esto convierte una cadena de caracteres de C y sus longitudes en un objeto Python. Si el puntero de la cadena de caracteres de C es @code{NULL}, se retorna @code{None}.

@item @code{z} (@ref{237,,str} o @code{None}) [const char *]

Igual que @code{s}.

@item @code{z#} (@ref{237,,str} o @code{None}) [const char *, @ref{af0,,Py_ssize_t}]

Igual que @code{s#}.

@item @code{u} (@ref{237,,str}) [const wchar_t *]

Convert a null-terminated @code{wchar_t} buffer of Unicode (UTF-16 or UCS-4)
data to a Python Unicode object.  If the Unicode buffer pointer is @code{NULL},
@code{None} is returned.

@item @code{u#} (@ref{237,,str}) [const wchar_t *, @ref{af0,,Py_ssize_t}]

Convierte un búfer de datos Unicode (UTF-16 o UCS-4) y su longitud en un objeto Python Unicode. Si el puntero del búfer Unicode es @code{NULL}, la longitud se ignora y se retorna @code{None}.

@item @code{U} (@ref{237,,str} o @code{None}) [const char *]

Igual que @code{s}.

@item @code{z#} (@ref{237,,str} o @code{None}) [const char *, @ref{af0,,Py_ssize_t}]

Igual que @code{s#}.

@item @code{i} (@ref{1f0,,int}) [int]

Convert a plain C int to a Python integer object.

@item @code{b} (@ref{1f0,,int}) [char]

Convert a plain C char to a Python integer object.

@item @code{h} (@ref{1f0,,int}) [short int]

Convert a plain C short int to a Python integer object.

@item @code{l} (@ref{1f0,,int}) [long int]

Convert a C long int to a Python integer object.

@item @code{B} (@ref{1f0,,int}) [unsigned char]

Convert a C unsigned char to a Python integer object.

@item @code{H} (@ref{1f0,,int}) [unsigned short int]

Convert a C unsigned short int to a Python integer object.

@item @code{I} (@ref{1f0,,int}) [unsigned int]

Convert a C unsigned int to a Python integer object.

@item @code{k} (@ref{1f0,,int}) [unsigned long]

Convert a C unsigned long to a Python integer object.

@item @code{L} (@ref{1f0,,int}) [long long]

Convert a C long long to a Python integer object.

@item @code{K} (@ref{1f0,,int}) [unsigned long long]

Convert a C unsigned long long to a Python integer object.

@item @code{n} (@ref{1f0,,int}) [@ref{af0,,Py_ssize_t}]

Convierte un @ref{af0,,Py_ssize_t} de C a un entero de Python.

@item @code{c} (@ref{325,,bytes} de largo 1) [char]

Convert a C int representing a byte to a Python @ref{325,,bytes} object of
length 1.

@item @code{C} (@ref{237,,str} de largo 1) [int]

Convert a C int representing a character to Python @ref{237,,str}
object of length 1.

@item @code{d} (@ref{153,,float}) [double]

Convert a C double to a Python floating-point number.

@item @code{f} (@ref{153,,float}) [float]

Convert a C float to a Python floating-point number.

@item @code{D} (@ref{154,,complex}) [Py_complex *]

Convierte una estructura @ref{4a8d,,Py_complex} de C en un número complejo de Python.

@item @code{O} (object) [PyObject *]

Pass a Python object untouched but create a new
@ref{431,,strong reference} to it
(i.e. its reference count is incremented by one).
If the object passed in is a @code{NULL} pointer, it is assumed
that this was caused because the call producing the argument found an error and
set an exception. Therefore, @ref{940,,Py_BuildValue()} will return @code{NULL} but won’t
raise an exception.  If no exception has been raised yet, @ref{619,,SystemError} is
set.

@item @code{S} (object) [PyObject *]

Igual que @code{O}.

@item @code{N} (object) [PyObject *]

Same as @code{O}, except it doesn’t create a new @ref{431,,strong reference}.
Useful when the object is created by a call to an object constructor in the
argument list.

@item @code{O&} (object) [`converter', `anything']

Convert `anything' to a Python object through a `converter' function.  The
function is called with `anything' (which should be compatible with void*)
as its argument and should return a «new» Python object, or @code{NULL} if an
error occurred.

@item @code{(items)} (@ref{464,,tuple}) [`matching-items']

Convierta una secuencia de valores C en una tupla de Python con el mismo número de elementos.

@item @code{[items]} (@ref{18e,,list}) [`matching-items']

Convierte una secuencia de valores C en una lista de Python con el mismo número de elementos.

@item @code{@{items@}} (@ref{190,,dict}) [`matching-items']

Convierte una secuencia de valores C en un diccionario Python. Cada par de valores C consecutivos agrega un elemento al diccionario, que sirve como clave y valor, respectivamente.
@end table

Si hay un error en la cadena de formato, se establece la excepción @ref{619,,SystemError} y se retorna @code{NULL}.
@end deffn

@geindex Py_VaBuildValue (C function)
@anchor{c-api/arg c Py_VaBuildValue}@anchor{4a19}
@deffn {C Función} @ref{42d,,PyObject} *Py_VaBuildValue (const char *format, va_list vargs)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Idéntico a @ref{940,,Py_BuildValue()}, excepto que acepta una `va_list' en lugar de un número variable de argumentos.
@end deffn

@node Conversión y formato de cadenas de caracteres,PyHash API,Analizando argumentos y construyendo valores,Utilidades<2>
@anchor{c-api/conversion doc}@anchor{4a92}@anchor{c-api/conversion string-conversion}@anchor{4a93}@anchor{c-api/conversion string-conversion-and-formatting}@anchor{4a94}
@subsection Conversión y formato de cadenas de caracteres


Funciones para conversión de números y salida de cadena de caracteres formateadas.

@geindex PyOS_snprintf (C function)
@anchor{c-api/conversion c PyOS_snprintf}@anchor{154b}
@deffn {C Función} int PyOS_snprintf (char *str, size_t size, const char *format, ...)
` Part of the @ref{5f6,,Stable ABI}.'
Salida de no más de `size' bytes a `str' según la cadena de caracteres de formato `format' y los argumentos adicionales. Consulte la página de manual de Unix @code{snprintf(3)@footnote{https://manpages.debian.org/snprintf(3)}}.
@end deffn

@geindex PyOS_vsnprintf (C function)
@anchor{c-api/conversion c PyOS_vsnprintf}@anchor{154c}
@deffn {C Función} int PyOS_vsnprintf (char *str, size_t size, const char *format, va_list va)
` Part of the @ref{5f6,,Stable ABI}.'
Salida de no más de `size' bytes a `str' según la cadena de caracteres de formato `format' y la lista de argumentos variables `va'. Página de manual de Unix @code{vsnprintf(3)@footnote{https://manpages.debian.org/vsnprintf(3)}}.
@end deffn

@ref{154b,,PyOS_snprintf()} y @ref{154c,,PyOS_vsnprintf()} envuelven las funciones estándar de la biblioteca C @code{snprintf()} y @code{vsnprintf()}. Su propósito es garantizar un comportamiento consistente en casos de esquina (`corner cases'), que las funciones del Estándar C no hacen.

The wrappers ensure that @code{str[size-1]} is always @code{'\0'} upon return. They
never write more than `size' bytes (including the trailing @code{'\0'}) into str.
Both functions require that @code{str != NULL}, @code{size > 0}, @code{format != NULL}
and @code{size < INT_MAX}. Note that this means there is no equivalent to the C99
@code{n = snprintf(NULL, 0, ...)} which would determine the necessary buffer size.

El valor de retorno (`rv') para estas funciones debe interpretarse de la siguiente manera:


@itemize *

@item 
Cuando @code{0 <= rv < size}, la conversión de salida fue exitosa y los caracteres `rv' se escribieron en `str' (excluyendo el byte @code{'\0'} final en @code{str[rv]}).

@item 
Cuando @code{rv >= size}, la conversión de salida se truncó y se habría necesitado un búfer con @code{rv + 1} bytes para tener éxito. @code{str[size-1]} es @code{'\0'} en este caso.

@item 
Cuando @code{rv < 0}, «sucedió algo malo». @code{str[size-1]} es @code{'\0'} en este caso también, pero el resto de `str' no está definido. La causa exacta del error depende de la plataforma subyacente.
@end itemize

Las siguientes funciones proporcionan cadenas de caracteres independientes de la configuración regional para numerar las conversiones.

@geindex PyOS_strtoul (C function)
@anchor{c-api/conversion c PyOS_strtoul}@anchor{498b}
@deffn {C Función} unsigned long PyOS_strtoul (const char *str, char **ptr, int base)
` Part of the @ref{5f6,,Stable ABI}.'
Convert the initial part of the string in @code{str} to an unsigned long value according to the given @code{base}, which must be between @code{2} and
@code{36} inclusive, or be the special value @code{0}.

Leading white space and case of characters are ignored.  If @code{base} is zero
it looks for a leading @code{0b}, @code{0o} or @code{0x} to tell which base.  If
these are absent it defaults to @code{10}.  Base must be 0 or between 2 and 36
(inclusive).  If @code{ptr} is non-@code{NULL} it will contain a pointer to the
end of the scan.

If the converted value falls out of range of corresponding return type,
range error occurs (@code{errno} is set to @code{ERANGE}) and
@code{ULONG_MAX} is returned.  If no conversion can be performed, @code{0}
is returned.

See also the Unix man page @code{strtoul(3)@footnote{https://manpages.debian.org/strtoul(3)}}.


Added in version 3.2.

@end deffn

@geindex PyOS_strtol (C function)
@anchor{c-api/conversion c PyOS_strtol}@anchor{498a}
@deffn {C Función} long PyOS_strtol (const char *str, char **ptr, int base)
` Part of the @ref{5f6,,Stable ABI}.'
Convert the initial part of the string in @code{str} to an long value
according to the given @code{base}, which must be between @code{2} and @code{36}
inclusive, or be the special value @code{0}.

Same as @ref{498b,,PyOS_strtoul()}, but return a long value instead
and @code{LONG_MAX} on overflows.

See also the Unix man page @code{strtol(3)@footnote{https://manpages.debian.org/strtol(3)}}.


Added in version 3.2.

@end deffn

@geindex PyOS_string_to_double (C function)
@anchor{c-api/conversion c PyOS_string_to_double}@anchor{1302}
@deffn {C Función} double PyOS_string_to_double (const char *s, char **endptr, PyObject *overflow_exception)
` Part of the @ref{5f6,,Stable ABI}.'
Convert a string @code{s} to a double, raising a Python
exception on failure.  The set of accepted strings corresponds to
the set of strings accepted by Python’s @ref{153,,float()} constructor,
except that @code{s} must not have leading or trailing whitespace.
The conversion is independent of the current locale.

Si @code{endptr} es @code{NULL}, convierte toda la cadena de caracteres. Lanza @ref{360,,ValueError} y retorna @code{-1.0} si la cadena de caracteres no es una representación válida de un número de punto flotante.

Si `endptr' no es @code{NULL}, convierte la mayor cantidad posible de la cadena de caracteres y configura @code{*endptr} para que apunte al primer carácter no convertido. Si ningún segmento inicial de la cadena de caracteres es la representación válida de un número de punto flotante, configura @code{*endptr} para que apunte al comienzo de la cadena de caracteres, lanza ValueError y retorna @code{-1.0}.

If @code{s} represents a value that is too large to store in a float
(for example, @code{"1e500"} is such a string on many platforms) then
if @code{overflow_exception} is @code{NULL} return @code{Py_INFINITY} (with
an appropriate sign) and don’t set any exception.  Otherwise,
@code{overflow_exception} must point to a Python exception object;
raise that exception and return @code{-1.0}.  In both cases, set
@code{*endptr} to point to the first character after the converted value.

Si se produce algún otro error durante la conversión (por ejemplo, un error de falta de memoria), establece la excepción Python adecuada y retorna @code{-1.0}.


Added in version 3.1.

@end deffn

@geindex PyOS_double_to_string (C function)
@anchor{c-api/conversion c PyOS_double_to_string}@anchor{4988}
@deffn {C Función} char *PyOS_double_to_string (double val, char format_code, int precision, int flags, int *ptype)
` Part of the @ref{5f6,,Stable ABI}.'
Convert a double `val' to a string using supplied
`format_code', `precision', and `flags'.

`format_code'  debe ser uno de @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} or @code{'r'}.  Para @code{'r'}, la `precision' suministrada debe ser 0 y se ignora.  El código de formato @code{'r'} especifica el formato estándar @ref{894,,repr()}.

`flags' puede ser cero o más de los valores @code{Py_DTSF_SIGN}, @code{Py_DTSF_ADD_DOT_0}, o @code{Py_DTSF_ALT}, unidos por `or' (`or-ed') juntos:


@itemize *

@item 
@code{Py_DTSF_SIGN} significa preceder siempre a la cadena de caracteres retornada con un carácter de signo, incluso si `val' no es negativo.

@item 
@code{Py_DTSF_ADD_DOT_0} significa asegurarse de que la cadena de caracteres retornada no se verá como un número entero.

@item 
@code{Py_DTSF_ALT} significa aplicar reglas de formato «alternativas». Consulte la documentación del especificador @ref{154b,,PyOS_snprintf()} @code{'#'} para obtener más detalles.
@end itemize

Si `ptype' no es @code{NULL}, el valor al que apunta se establecerá en uno de @code{Py_DTST_FINITE}, @code{Py_DTST_INFINITE} o @code{Py_DTST_NAN}, lo que significa que `val' es un número finito, un número infinito o no es un número, respectivamente.

El valor de retorno es un puntero a `buffer' con la cadena de caracteres convertida o @code{NULL} si la conversión falla. La persona que llama es responsable de liberar la cadena de caracteres retornada llamando a @ref{1482,,PyMem_Free()}.


Added in version 3.1.

@end deffn

@geindex PyOS_stricmp (C function)
@anchor{c-api/conversion c PyOS_stricmp}@anchor{4a95}
@deffn {C Función} int PyOS_stricmp (const char *s1, const char *s2)

Case insensitive comparison of strings. The function works almost
identically to @code{strcmp()} except that it ignores the case.
@end deffn

@geindex PyOS_strnicmp (C function)
@anchor{c-api/conversion c PyOS_strnicmp}@anchor{4a96}
@deffn {C Función} int PyOS_strnicmp (const char *s1, const char *s2, Py_ssize_t size)

Case insensitive comparison of strings. The function works almost
identically to @code{strncmp()} except that it ignores the case.
@end deffn

@node PyHash API,Reflexión,Conversión y formato de cadenas de caracteres,Utilidades<2>
@anchor{c-api/hash doc}@anchor{4a97}@anchor{c-api/hash pyhash-api}@anchor{4a98}
@subsection PyHash API


See also the @ref{4886,,PyTypeObject.tp_hash} member and @ref{21aa,,Calculo del hash de tipos numéricos}.

@geindex Py_hash_t (C type)
@anchor{c-api/hash c Py_hash_t}@anchor{12d1}
@deffn {C Tipo} type Py_hash_t

Hash value type: signed integer.


Added in version 3.2.

@end deffn

@geindex Py_uhash_t (C type)
@anchor{c-api/hash c Py_uhash_t}@anchor{4a99}
@deffn {C Tipo} type Py_uhash_t

Hash value type: unsigned integer.


Added in version 3.2.

@end deffn

@geindex PyHASH_MODULUS (C macro)
@anchor{c-api/hash c PyHASH_MODULUS}@anchor{1674}
@deffn {C Macro} PyHASH_MODULUS

The Mersenne prime@footnote{https://en.wikipedia.org/wiki/Mersenne_prime} @code{P = 2**n -1}, used for numeric hash scheme.


Added in version 3.13.

@end deffn

@geindex PyHASH_BITS (C macro)
@anchor{c-api/hash c PyHASH_BITS}@anchor{1675}
@deffn {C Macro} PyHASH_BITS

The exponent @code{n} of @code{P} in @ref{1674,,PyHASH_MODULUS}.


Added in version 3.13.

@end deffn

@geindex PyHASH_MULTIPLIER (C macro)
@anchor{c-api/hash c PyHASH_MULTIPLIER}@anchor{162b}
@deffn {C Macro} PyHASH_MULTIPLIER

Prime multiplier used in string and various other hashes.


Added in version 3.13.

@end deffn

@geindex PyHASH_INF (C macro)
@anchor{c-api/hash c PyHASH_INF}@anchor{1676}
@deffn {C Macro} PyHASH_INF

The hash value returned for a positive infinity.


Added in version 3.13.

@end deffn

@geindex PyHASH_IMAG (C macro)
@anchor{c-api/hash c PyHASH_IMAG}@anchor{1677}
@deffn {C Macro} PyHASH_IMAG

The multiplier used for the imaginary part of a complex number.


Added in version 3.13.

@end deffn

@geindex PyHash_FuncDef (C type)
@anchor{c-api/hash c PyHash_FuncDef}@anchor{4a9a}
@deffn {C Tipo} type PyHash_FuncDef

Hash function definition used by @ref{4a9b,,PyHash_GetFuncDef()}.

@c c::member:: Py_hash_t (*const hash)(const void *, Py_ssize_t)
@c 
@c Hash function.

@geindex PyHash_FuncDef.name (C member)
@anchor{c-api/hash c PyHash_FuncDef name}@anchor{4a9c}
@deffn {C Miembro} const char *name

Hash function name (UTF-8 encoded string).
@end deffn

@geindex PyHash_FuncDef.hash_bits (C member)
@anchor{c-api/hash c PyHash_FuncDef hash_bits}@anchor{4a9d}
@deffn {C Miembro} const int hash_bits

Internal size of the hash value in bits.
@end deffn

@geindex PyHash_FuncDef.seed_bits (C member)
@anchor{c-api/hash c PyHash_FuncDef seed_bits}@anchor{4a9e}
@deffn {C Miembro} const int seed_bits

Size of seed input in bits.
@end deffn


Added in version 3.4.

@end deffn

@geindex PyHash_GetFuncDef (C function)
@anchor{c-api/hash c PyHash_GetFuncDef}@anchor{4a9b}
@deffn {C Función} @ref{4a9a,,PyHash_FuncDef} *PyHash_GetFuncDef (void)

Get the hash function definition.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} «Secure and interchangeable hash algorithm».



Added in version 3.4.

@end deffn

@geindex Py_HashPointer (C function)
@anchor{c-api/hash c Py_HashPointer}@anchor{45c}
@deffn {C Función} @ref{12d1,,Py_hash_t} Py_HashPointer (const void *ptr)

Hash a pointer value: process the pointer value as an integer (cast it to
@code{uintptr_t} internally). The pointer is not dereferenced.

The function cannot fail: it cannot return @code{-1}.


Added in version 3.13.

@end deffn

@geindex Py_HashBuffer (C function)
@anchor{c-api/hash c Py_HashBuffer}@anchor{255}
@deffn {C Función} @ref{12d1,,Py_hash_t} Py_HashBuffer (const void *ptr, Py_ssize_t len)

Compute and return the hash value of a buffer of `len' bytes
starting at address `ptr'. The hash is guaranteed to match that of
@ref{325,,bytes}, @ref{156,,memoryview}, and other built-in objects
that implement the @ref{48a,,buffer protocol}.

Use this function to implement hashing for immutable objects whose
@ref{4880,,tp_richcompare} function compares to another
object’s buffer.

`len' must be greater than or equal to @code{0}.

This function always succeeds.


Added in version 3.14.

@end deffn

@geindex PyObject_GenericHash (C function)
@anchor{c-api/hash c PyObject_GenericHash}@anchor{45b}
@deffn {C Función} @ref{12d1,,Py_hash_t} PyObject_GenericHash (PyObject *obj)

Generic hashing function that is meant to be put into a type
object’s @code{tp_hash} slot.
Its result only depends on the object’s identity.

`Detalles de implementación de CPython:' In CPython, it is equivalent to @ref{45c,,Py_HashPointer()}.


Added in version 3.13.

@end deffn

@node Reflexión,Registro de códec y funciones de soporte,PyHash API,Utilidades<2>
@anchor{c-api/reflection doc}@anchor{4a9f}@anchor{c-api/reflection id1}@anchor{4aa0}@anchor{c-api/reflection reflection}@anchor{4aa1}
@subsection Reflexión


@geindex PyEval_GetBuiltins (C function)
@anchor{c-api/reflection c PyEval_GetBuiltins}@anchor{445}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetBuiltins (void)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.13: Use @ref{444,,PyEval_GetFrameBuiltins()} instead.


Retorna un diccionario de las construcciones en el marco de ejecución actual, o el intérprete del estado del hilo si no se está ejecutando ningún marco actualmente.
@end deffn

@geindex PyEval_GetLocals (C function)
@anchor{c-api/reflection c PyEval_GetLocals}@anchor{449}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetLocals (void)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.13: Use either @ref{448,,PyEval_GetFrameLocals()} to obtain the same behaviour as calling
@ref{2ae,,locals()} in Python code, or else call @ref{4dd,,PyFrame_GetLocals()} on the result
of @ref{17c4,,PyEval_GetFrame()} to access the @ref{2ed,,f_locals} attribute of the
currently executing frame.


Return a mapping providing access to the local variables in the current execution frame,
or @code{NULL} if no frame is currently executing.

Refer to @ref{2ae,,locals()} for details of the mapping returned at different scopes.

As this function returns a @ref{432,,borrowed reference}, the dictionary returned for
@ref{2e9,,optimized scopes} is cached on the frame object and will remain
alive as long as the frame object does. Unlike @ref{448,,PyEval_GetFrameLocals()} and
@ref{2ae,,locals()}, subsequent calls to this function in the same frame will update the
contents of the cached dictionary to reflect changes in the state of the local variables
rather than returning a new snapshot.


Distinto en la versión 3.13: As part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, @ref{4dd,,PyFrame_GetLocals()}, @ref{2ae,,locals()}, and
@ref{2ed,,FrameType.f_locals} no longer make use of the shared cache
dictionary. Refer to the @ref{2af,,What’s New entry} for
additional details.

@end deffn

@geindex PyEval_GetGlobals (C function)
@anchor{c-api/reflection c PyEval_GetGlobals}@anchor{447}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetGlobals (void)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'

Obsoleto desde la versión 3.13: Use @ref{446,,PyEval_GetFrameGlobals()} instead.


Retorna un diccionario de las variables globales en el marco de ejecución actual, o @code{NULL} si actualmente no se está ejecutando ningún marco.
@end deffn

@geindex PyEval_GetFrame (C function)
@anchor{c-api/reflection c PyEval_GetFrame}@anchor{17c4}
@deffn {C Función} @ref{822,,PyFrameObject} *PyEval_GetFrame (void)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el marco del estado del hilo actual, que es @code{NULL} si actualmente no se está ejecutando ningún marco.

Vea también @ref{827,,PyThreadState_GetFrame()}.
@end deffn

@geindex PyEval_GetFrameBuiltins (C function)
@anchor{c-api/reflection c PyEval_GetFrameBuiltins}@anchor{444}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetFrameBuiltins (void)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Retorna un diccionario de las construcciones en el marco de ejecución actual, o el intérprete del estado del hilo si no se está ejecutando ningún marco actualmente.


Added in version 3.13.

@end deffn

@geindex PyEval_GetFrameLocals (C function)
@anchor{c-api/reflection c PyEval_GetFrameLocals}@anchor{448}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetFrameLocals (void)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return a dictionary of the local variables in the current execution frame,
or @code{NULL} if no frame is currently executing. Equivalent to calling
@ref{2ae,,locals()} in Python code.

To access @ref{2ed,,f_locals} on the current frame without making an independent
snapshot in @ref{2e9,,optimized scopes}, call @ref{4dd,,PyFrame_GetLocals()}
on the result of @ref{17c4,,PyEval_GetFrame()}.


Added in version 3.13.

@end deffn

@geindex PyEval_GetFrameGlobals (C function)
@anchor{c-api/reflection c PyEval_GetFrameGlobals}@anchor{446}
@deffn {C Función} @ref{42d,,PyObject} *PyEval_GetFrameGlobals (void)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return a dictionary of the global variables in the current execution frame,
or @code{NULL} if no frame is currently executing. Equivalent to calling
@ref{186f,,globals()} in Python code.


Added in version 3.13.

@end deffn

@geindex PyEval_GetFuncName (C function)
@anchor{c-api/reflection c PyEval_GetFuncName}@anchor{492b}
@deffn {C Función} const char *PyEval_GetFuncName (PyObject *func)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el nombre de `func' si es una función, clase u objeto de instancia; de lo contrario, el nombre del tipo `func's.
@end deffn

@geindex PyEval_GetFuncDesc (C function)
@anchor{c-api/reflection c PyEval_GetFuncDesc}@anchor{492a}
@deffn {C Función} const char *PyEval_GetFuncDesc (PyObject *func)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna una cadena de caracteres de descripción, según el tipo de `func'. Los valores de retorno incluyen «()» para funciones y métodos, «constructor», «instancia» y «objeto». Concatenado con el resultado de @ref{492b,,PyEval_GetFuncName()}, el resultado será una descripción de `func'.
@end deffn

@node Registro de códec y funciones de soporte,PyTime C API,Reflexión,Utilidades<2>
@anchor{c-api/codec doc}@anchor{4aa2}@anchor{c-api/codec codec-registry}@anchor{dbc}@anchor{c-api/codec codec-registry-and-support-functions}@anchor{4aa3}
@subsection Registro de códec y funciones de soporte


@geindex PyCodec_Register (C function)
@anchor{c-api/codec c PyCodec_Register}@anchor{4901}
@deffn {C Función} int PyCodec_Register (PyObject *search_function)
` Part of the @ref{5f6,,Stable ABI}.'
Registra una nueva función de búsqueda de códec.

As side effect, this tries to load the @code{encodings} package, if not yet
done, to make sure that it is always first in the list of search functions.
@end deffn

@geindex PyCodec_Unregister (C function)
@anchor{c-api/codec c PyCodec_Unregister}@anchor{92f}
@deffn {C Función} int PyCodec_Unregister (PyObject *search_function)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Anula el registro de una función de búsqueda de códecs y borra el caché del registro. Si la función de búsqueda no está registrada, no hace nada. Retorna 0 en caso de éxito. Lanza una excepción y devuelva -1 en caso de error.


Added in version 3.10.

@end deffn

@geindex PyCodec_KnownEncoding (C function)
@anchor{c-api/codec c PyCodec_KnownEncoding}@anchor{48ff}
@deffn {C Función} int PyCodec_KnownEncoding (const char *encoding)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} o @code{0} dependiendo de si hay un códec registrado para el `encoding' dado. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyCodec_Encode (C function)
@anchor{c-api/codec c PyCodec_Encode}@anchor{297}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_Encode (PyObject *object, const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
API de codificación genérica basada en códec.

`object' se pasa a través de la función de codificador encontrada por el `encoding' dado usando el método de manejo de errores definido por `errors'. `errors' pueden ser @code{NULL} para usar el método predeterminado definido para el códec. Lanza un @ref{21d5,,LookupError} si no se puede encontrar el codificador.
@end deffn

@geindex PyCodec_Decode (C function)
@anchor{c-api/codec c PyCodec_Decode}@anchor{296}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_Decode (PyObject *object, const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
API de decodificación basada en códec genérico.

`object' se pasa a través de la función de decodificador encontrada por el `encoding' dado usando el método de manejo de errores definido por `errors'. `errors' puede ser @code{NULL} para usar el método predeterminado definido para el códec. Lanza un @ref{21d5,,LookupError} si no se puede encontrar el codificador.
@end deffn

@menu
* API de búsqueda de códec:: 
* API de registro para controladores de errores de codificación Unicode:: 

@end menu

@node API de búsqueda de códec,API de registro para controladores de errores de codificación Unicode,,Registro de códec y funciones de soporte
@anchor{c-api/codec codec-lookup-api}@anchor{4aa4}
@subsubsection API de búsqueda de códec


En las siguientes funciones, la cadena de caracteres `encoding' se busca convertida a todos los caracteres en minúscula, lo que hace que las codificaciones se busquen a través de este mecanismo sin distinción entre mayúsculas y minúsculas. Si no se encuentra ningún códec, se establece un @ref{438,,KeyError} y se retorna @code{NULL}.

@geindex PyCodec_Encoder (C function)
@anchor{c-api/codec c PyCodec_Encoder}@anchor{48fb}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_Encoder (const char *encoding)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene una función de codificador para el `encoding' dado.
@end deffn

@geindex PyCodec_Decoder (C function)
@anchor{c-api/codec c PyCodec_Decoder}@anchor{48fa}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_Decoder (const char *encoding)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene una función de decodificador para el `encoding' dado.
@end deffn

@geindex PyCodec_IncrementalEncoder (C function)
@anchor{c-api/codec c PyCodec_IncrementalEncoder}@anchor{48fe}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_IncrementalEncoder (const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene un objeto @ref{23ca,,IncrementalEncoder} para el `encoding' dada.
@end deffn

@geindex PyCodec_IncrementalDecoder (C function)
@anchor{c-api/codec c PyCodec_IncrementalDecoder}@anchor{48fd}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_IncrementalDecoder (const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene un objeto @ref{23cb,,IncrementalDecoder} para el `encoding' dado.
@end deffn

@geindex PyCodec_StreamReader (C function)
@anchor{c-api/codec c PyCodec_StreamReader}@anchor{4904}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_StreamReader (const char *encoding, PyObject *stream, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene una función de fábrica @ref{23cf,,StreamReader} para el `encoding' dado.
@end deffn

@geindex PyCodec_StreamWriter (C function)
@anchor{c-api/codec c PyCodec_StreamWriter}@anchor{4905}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_StreamWriter (const char *encoding, PyObject *stream, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Obtiene una función de fábrica @ref{23ce,,StreamWriter} por el `encoding' dado.
@end deffn

@node API de registro para controladores de errores de codificación Unicode,,API de búsqueda de códec,Registro de códec y funciones de soporte
@anchor{c-api/codec registry-api-for-unicode-encoding-error-handlers}@anchor{4aa5}
@subsubsection API de registro para controladores de errores de codificación Unicode


@geindex PyCodec_RegisterError (C function)
@anchor{c-api/codec c PyCodec_RegisterError}@anchor{4902}
@deffn {C Función} int PyCodec_RegisterError (const char *name, PyObject *error)
` Part of the @ref{5f6,,Stable ABI}.'
Registra la función de devolución de llamada de manejo de errores `error' bajo el nombre `name' dado. Esta función de devolución de llamada será llamada por un códec cuando encuentre caracteres no codificables / bytes no codificables y `name' se especifica como parámetro de error en la llamada a la función de codificación / decodificación.

La devolución de llamada obtiene un único argumento, una instancia de @ref{718,,UnicodeEncodeError}, @ref{aa5,,UnicodeDecodeError} o @ref{22a0,,UnicodeTranslateError} que contiene información sobre la secuencia problemática de caracteres o bytes y su desplazamiento en la cadena original (consulte @ref{4a65,,Objetos unicode de excepción} para funciones para extraer esta información). La devolución de llamada debe lanzar la excepción dada o retornar una tupla de dos elementos que contiene el reemplazo de la secuencia problemática, y un número entero que proporciona el desplazamiento en la cadena original en la que se debe reanudar la codificación / decodificación.

Retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyCodec_LookupError (C function)
@anchor{c-api/codec c PyCodec_LookupError}@anchor{4900}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_LookupError (const char *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Busca la función de devolución de llamada de manejo de errores registrada con `name'. Como caso especial se puede pasar @code{NULL}, en cuyo caso se retornará la devolución de llamada de manejo de errores para «estricto».
@end deffn

@geindex PyCodec_StrictErrors (C function)
@anchor{c-api/codec c PyCodec_StrictErrors}@anchor{4906}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_StrictErrors (PyObject *exc)
`Return value: Always NULL.'` Part of the @ref{5f6,,Stable ABI}.'
Lanza `exc' como una excepción.
@end deffn

@geindex PyCodec_IgnoreErrors (C function)
@anchor{c-api/codec c PyCodec_IgnoreErrors}@anchor{48fc}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_IgnoreErrors (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Ignora el error Unicode, omitiendo la entrada defectuosa.
@end deffn

@geindex PyCodec_ReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_ReplaceErrors}@anchor{4903}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_ReplaceErrors (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Reemplaza el error de codificación Unicode con @code{?} o @code{U+FFFD}.
@end deffn

@geindex PyCodec_XMLCharRefReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_XMLCharRefReplaceErrors}@anchor{4907}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_XMLCharRefReplaceErrors (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Reemplaza el error de codificación Unicode con referencias de caracteres XML.
@end deffn

@geindex PyCodec_BackslashReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_BackslashReplaceErrors}@anchor{48f9}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_BackslashReplaceErrors (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Reemplaza el error de codificación Unicode con escapes de barra invertida (@code{\x}, @code{\u} y @code{\U}).
@end deffn

@geindex PyCodec_NameReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_NameReplaceErrors}@anchor{f30}
@deffn {C Función} @ref{42d,,PyObject} *PyCodec_NameReplaceErrors (PyObject *exc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Reemplaza el error de codificación Unicode con escapes @code{\N@{...@}}.


Added in version 3.5.

@end deffn

@node PyTime C API,Support for Perf Maps,Registro de códec y funciones de soporte,Utilidades<2>
@anchor{c-api/time doc}@anchor{2c6}@anchor{c-api/time c-api-time}@anchor{420}@anchor{c-api/time pytime-c-api}@anchor{4aa6}
@subsection PyTime C API



Added in version 3.13.


The clock C API provides access to system clocks.
It is similar to the Python @ref{ee,,time} module.

For C API related to the @ref{31,,datetime} module, see @ref{4aa7,,Objetos DateTime}.

@menu
* Types:: 
* Clock Functions:: 
* Raw Clock Functions:: 
* Conversion functions:: 

@end menu

@node Types,Clock Functions,,PyTime C API
@anchor{c-api/time types}@anchor{4aa8}
@subsubsection Types


@geindex PyTime_t (C type)
@anchor{c-api/time c PyTime_t}@anchor{421}
@deffn {C Tipo} type PyTime_t

A timestamp or duration in nanoseconds, represented as a signed 64-bit
integer.

The reference point for timestamps depends on the clock used. For example,
@ref{429,,PyTime_Time()} returns timestamps relative to the UNIX epoch.

The supported range is around [-292.3 years; +292.3 years].
Using the Unix epoch (January 1st, 1970) as reference, the supported date
range is around [1677-09-21; 2262-04-11].
The exact limits are exposed as constants:
@end deffn

@geindex PyTime_MIN (C var)
@anchor{c-api/time c PyTime_MIN}@anchor{422}
@deffn {C Variable} @ref{421,,PyTime_t} PyTime_MIN

Minimum value of @ref{421,,PyTime_t}.
@end deffn

@geindex PyTime_MAX (C var)
@anchor{c-api/time c PyTime_MAX}@anchor{423}
@deffn {C Variable} @ref{421,,PyTime_t} PyTime_MAX

Maximum value of @ref{421,,PyTime_t}.
@end deffn

@node Clock Functions,Raw Clock Functions,Types,PyTime C API
@anchor{c-api/time clock-functions}@anchor{4aa9}
@subsubsection Clock Functions


The following functions take a pointer to a @ref{421,,PyTime_t} that they
set to the value of a particular clock.
Details of each clock are given in the documentation of the corresponding
Python function.

The functions return @code{0} on success, or @code{-1} (with an exception set)
on failure.

On integer overflow, they set the @code{PyExc_OverflowError} exception and
set @code{*result} to the value clamped to the @code{[PyTime_MIN; PyTime_MAX]}
range.
(On current systems, integer overflows are likely caused by misconfigured
system time.)

As any other C API (unless otherwise specified), the functions must be called
with the @ref{2c5,,GIL} held.

@geindex PyTime_Monotonic (C function)
@anchor{c-api/time c PyTime_Monotonic}@anchor{425}
@deffn {C Función} int PyTime_Monotonic (PyTime_t *result)

Read the monotonic clock.
See @ref{3ac,,time.monotonic()} for important details on this clock.
@end deffn

@geindex PyTime_PerfCounter (C function)
@anchor{c-api/time c PyTime_PerfCounter}@anchor{427}
@deffn {C Función} int PyTime_PerfCounter (PyTime_t *result)

Read the performance counter.
See @ref{b14,,time.perf_counter()} for important details on this clock.
@end deffn

@geindex PyTime_Time (C function)
@anchor{c-api/time c PyTime_Time}@anchor{429}
@deffn {C Función} int PyTime_Time (PyTime_t *result)

Read the “wall clock” time.
See @ref{3ad,,time.time()} for details important on this clock.
@end deffn

@node Raw Clock Functions,Conversion functions,Clock Functions,PyTime C API
@anchor{c-api/time raw-clock-functions}@anchor{4aaa}
@subsubsection Raw Clock Functions


Similar to clock functions, but don’t set an exception on error and don’t
require the caller to hold the GIL.

On success, the functions return @code{0}.

On failure, they set @code{*result} to @code{0} and return @code{-1}, `without' setting
an exception. To get the cause of the error, acquire the GIL and call the
regular (non-@code{Raw}) function. Note that the regular function may succeed after
the @code{Raw} one failed.

@geindex PyTime_MonotonicRaw (C function)
@anchor{c-api/time c PyTime_MonotonicRaw}@anchor{426}
@deffn {C Función} int PyTime_MonotonicRaw (PyTime_t *result)

Similar to @ref{425,,PyTime_Monotonic()},
but don’t set an exception on error and don’t require holding the GIL.
@end deffn

@geindex PyTime_PerfCounterRaw (C function)
@anchor{c-api/time c PyTime_PerfCounterRaw}@anchor{428}
@deffn {C Función} int PyTime_PerfCounterRaw (PyTime_t *result)

Similar to @ref{427,,PyTime_PerfCounter()},
but don’t set an exception on error and don’t require holding the GIL.
@end deffn

@geindex PyTime_TimeRaw (C function)
@anchor{c-api/time c PyTime_TimeRaw}@anchor{42a}
@deffn {C Función} int PyTime_TimeRaw (PyTime_t *result)

Similar to @ref{429,,PyTime_Time()},
but don’t set an exception on error and don’t require holding the GIL.
@end deffn

@node Conversion functions,,Raw Clock Functions,PyTime C API
@anchor{c-api/time conversion-functions}@anchor{4aab}
@subsubsection Conversion functions


@geindex PyTime_AsSecondsDouble (C function)
@anchor{c-api/time c PyTime_AsSecondsDouble}@anchor{424}
@deffn {C Función} double PyTime_AsSecondsDouble (PyTime_t t)

Convert a timestamp to a number of seconds as a C double.

The function cannot fail, but note that double has limited
accuracy for large values.
@end deffn

@node Support for Perf Maps,,PyTime C API,Utilidades<2>
@anchor{c-api/perfmaps doc}@anchor{4aac}@anchor{c-api/perfmaps perfmaps}@anchor{4aad}@anchor{c-api/perfmaps support-for-perf-maps}@anchor{4aae}
@subsection Support for Perf Maps


On supported platforms (as of this writing, only Linux), the runtime can take
advantage of `perf map files' to make Python functions visible to an external
profiling tool (such as perf@footnote{https://perf.wiki.kernel.org/index.php/Main_Page}).
A running process may create a file in the @code{/tmp} directory, which contains entries
that can map a section of executable code to a name. This interface is described in the
documentation of the Linux Perf tool@footnote{https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/Documentation/jit-interface.txt}.

In Python, these helper APIs can be used by libraries and features that rely
on generating machine code on the fly.

Note that holding the Global Interpreter Lock (GIL) is not required for these APIs.

@geindex PyUnstable_PerfMapState_Init (C function)
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Init}@anchor{1741}
@deffn {C Función} int PyUnstable_PerfMapState_Init (void)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Open the @code{/tmp/perf-$pid.map} file, unless it’s already opened, and create
a lock to ensure thread-safe writes to the file (provided the writes are
done through @ref{1740,,PyUnstable_WritePerfMapEntry()}). Normally, there’s no need
to call this explicitly; just use @ref{1740,,PyUnstable_WritePerfMapEntry()}
and it will initialize the state on first call.

Returns @code{0} on success, @code{-1} on failure to create/open the perf map file,
or @code{-2} on failure to create a lock. Check @code{errno} for more information
about the cause of a failure.
@end deffn

@geindex PyUnstable_WritePerfMapEntry (C function)
@anchor{c-api/perfmaps c PyUnstable_WritePerfMapEntry}@anchor{1740}
@deffn {C Función} int PyUnstable_WritePerfMapEntry (const void *code_addr, unsigned int code_size, const char *entry_name)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Write one single entry to the @code{/tmp/perf-$pid.map} file. This function is
thread safe. Here is what an example entry looks like:

@example
# address      size  name
7f3529fcf759 b     py::bar:/run/t.py
@end example

Will call @ref{1741,,PyUnstable_PerfMapState_Init()} before writing the entry, if
the perf map file is not already opened. Returns @code{0} on success, or the
same error codes as @ref{1741,,PyUnstable_PerfMapState_Init()} on failure.
@end deffn

@geindex PyUnstable_PerfMapState_Fini (C function)
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Fini}@anchor{1742}
@deffn {C Función} void PyUnstable_PerfMapState_Fini (void)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Close the perf map file opened by @ref{1741,,PyUnstable_PerfMapState_Init()}.
This is called by the runtime itself during interpreter shut-down. In
general, there shouldn’t be a reason to explicitly call this, except to
handle specific scenarios such as forking.
@end deffn

@node Capa de objetos abstractos,Capa de objetos concretos,Utilidades<2>,Manual de referencia de la API en C de Python
@anchor{c-api/abstract doc}@anchor{4aaf}@anchor{c-api/abstract abstract}@anchor{4883}@anchor{c-api/abstract abstract-objects-layer}@anchor{4ab0}
@section Capa de objetos abstractos


Las funciones de este capítulo interactúan con los objetos de Python independientemente de su tipo, o con amplias clases de tipos de objetos (por ejemplo, todos los tipos numéricos o todos los tipos de secuencia). Cuando se usan en tipos de objetos para los que no se aplican, lanzarán una excepción de Python.

No es posible utilizar estas funciones en objetos que no se inicializan correctamente, como un objeto de lista que ha sido creado por @ref{48c0,,PyList_New()}, pero cuyos elementos no se han establecido en algunos valores no-@code{NULL} aún.

@menu
* Protocolo de objeto:: 
* Protocolo de llamada:: 
* Protocolo de números:: 
* Protocolo de secuencia:: 
* Protocolo de mapeo:: 
* Protocolo iterador:: 
* Protocolo búfer:: 

@end menu

@node Protocolo de objeto,Protocolo de llamada,,Capa de objetos abstractos
@anchor{c-api/object doc}@anchor{4ab1}@anchor{c-api/object object}@anchor{4ab2}@anchor{c-api/object object-protocol}@anchor{4ab3}
@subsection Protocolo de objeto


@geindex Py_GetConstant (C function)
@anchor{c-api/object c Py_GetConstant}@anchor{44a}
@deffn {C Función} @ref{42d,,PyObject} *Py_GetConstant (unsigned int constant_id)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Get a @ref{431,,strong reference} to a constant.

Set an exception and return @code{NULL} if `constant_id' is invalid.

`constant_id' must be one of these constant identifiers:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constant Identifier

@tab

Value

@tab

Returned object

@item

@geindex Py_CONSTANT_NONE (C macro)
@anchor{c-api/object c Py_CONSTANT_NONE}@anchor{4ab4}
@deffn {C Macro} Py_CONSTANT_NONE
@end deffn

@tab

@code{0}

@tab

@ref{716,,None}

@item

@geindex Py_CONSTANT_FALSE (C macro)
@anchor{c-api/object c Py_CONSTANT_FALSE}@anchor{4ab5}
@deffn {C Macro} Py_CONSTANT_FALSE
@end deffn

@tab

@code{1}

@tab

@ref{bbf,,False}

@item

@geindex Py_CONSTANT_TRUE (C macro)
@anchor{c-api/object c Py_CONSTANT_TRUE}@anchor{4ab6}
@deffn {C Macro} Py_CONSTANT_TRUE
@end deffn

@tab

@code{2}

@tab

@ref{c95,,True}

@item

@geindex Py_CONSTANT_ELLIPSIS (C macro)
@anchor{c-api/object c Py_CONSTANT_ELLIPSIS}@anchor{4ab7}
@deffn {C Macro} Py_CONSTANT_ELLIPSIS
@end deffn

@tab

@code{3}

@tab

@ref{218d,,Ellipsis}

@item

@geindex Py_CONSTANT_NOT_IMPLEMENTED (C macro)
@anchor{c-api/object c Py_CONSTANT_NOT_IMPLEMENTED}@anchor{4ab8}
@deffn {C Macro} Py_CONSTANT_NOT_IMPLEMENTED
@end deffn

@tab

@code{4}

@tab

@ref{227,,NotImplemented}

@item

@geindex Py_CONSTANT_ZERO (C macro)
@anchor{c-api/object c Py_CONSTANT_ZERO}@anchor{4ab9}
@deffn {C Macro} Py_CONSTANT_ZERO
@end deffn

@tab

@code{5}

@tab

@code{0}

@item

@geindex Py_CONSTANT_ONE (C macro)
@anchor{c-api/object c Py_CONSTANT_ONE}@anchor{4aba}
@deffn {C Macro} Py_CONSTANT_ONE
@end deffn

@tab

@code{6}

@tab

@code{1}

@item

@geindex Py_CONSTANT_EMPTY_STR (C macro)
@anchor{c-api/object c Py_CONSTANT_EMPTY_STR}@anchor{4abb}
@deffn {C Macro} Py_CONSTANT_EMPTY_STR
@end deffn

@tab

@code{7}

@tab

@code{'@w{'}}

@item

@geindex Py_CONSTANT_EMPTY_BYTES (C macro)
@anchor{c-api/object c Py_CONSTANT_EMPTY_BYTES}@anchor{4abc}
@deffn {C Macro} Py_CONSTANT_EMPTY_BYTES
@end deffn

@tab

@code{8}

@tab

@code{b'@w{'}}

@item

@geindex Py_CONSTANT_EMPTY_TUPLE (C macro)
@anchor{c-api/object c Py_CONSTANT_EMPTY_TUPLE}@anchor{4abd}
@deffn {C Macro} Py_CONSTANT_EMPTY_TUPLE
@end deffn

@tab

@code{9}

@tab

@code{()}

@end multitable


Numeric values are only given for projects which cannot use the constant
identifiers.


Added in version 3.13.


`Detalles de implementación de CPython:' In CPython, all of these constants are @ref{429d,,immortal}.
@end deffn

@geindex Py_GetConstantBorrowed (C function)
@anchor{c-api/object c Py_GetConstantBorrowed}@anchor{44b}
@deffn {C Función} @ref{42d,,PyObject} *Py_GetConstantBorrowed (unsigned int constant_id)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{44a,,Py_GetConstant()}, but return a @ref{432,,borrowed reference}.

This function is primarily intended for backwards compatibility:
using @ref{44a,,Py_GetConstant()} is recommended for new code.

The reference is borrowed from the interpreter, and is valid until the
interpreter finalization.


Added in version 3.13.

@end deffn

@geindex Py_NotImplemented (C var)
@anchor{c-api/object c Py_NotImplemented}@anchor{4abe}
@deffn {C Variable} @ref{42d,,PyObject} *Py_NotImplemented

El singleton @code{NotImplemented}, se usa para indicar que una operación no está implementada para la combinación de tipos dada.
@end deffn

@geindex Py_RETURN_NOTIMPLEMENTED (C macro)
@anchor{c-api/object c Py_RETURN_NOTIMPLEMENTED}@anchor{4abf}
@deffn {C Macro} Py_RETURN_NOTIMPLEMENTED

Properly handle returning @ref{4abe,,Py_NotImplemented} from within a C
function (that is, create a new @ref{431,,strong reference}
to @ref{227,,NotImplemented} and return it).
@end deffn

@geindex Py_PRINT_RAW (C macro)
@anchor{c-api/object c Py_PRINT_RAW}@anchor{4ac0}
@deffn {C Macro} Py_PRINT_RAW

Flag to be used with multiple functions that print the object (like
@ref{1621,,PyObject_Print()} and @ref{4934,,PyFile_WriteObject()}).
If passed, these function would use the @ref{237,,str()} of the object
instead of the @ref{894,,repr()}.
@end deffn

@geindex PyObject_Print (C function)
@anchor{c-api/object c PyObject_Print}@anchor{1621}
@deffn {C Función} int PyObject_Print (PyObject *o, FILE *fp, int flags)

Print an object `o', on file `fp'.  Returns @code{-1} on error.  The flags argument
is used to enable certain printing options.  The only option currently supported
is @ref{4ac0,,Py_PRINT_RAW}; if given, the @ref{237,,str()} of the object is written
instead of the @ref{894,,repr()}.
@end deffn

@geindex PyObject_HasAttrWithError (C function)
@anchor{c-api/object c PyObject_HasAttrWithError}@anchor{46c}
@deffn {C Función} int PyObject_HasAttrWithError (PyObject *o, const char *attr_name)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Returns @code{1} if `o' has the attribute `attr_name', and @code{0} otherwise.
This is equivalent to the Python expression @code{hasattr(o, attr_name)}.
On failure, return @code{-1}.


Added in version 3.13.

@end deffn

@geindex PyObject_HasAttrStringWithError (C function)
@anchor{c-api/object c PyObject_HasAttrStringWithError}@anchor{46e}
@deffn {C Función} int PyObject_HasAttrStringWithError (PyObject *o, const char *attr_name)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
This is the same as @ref{46c,,PyObject_HasAttrWithError()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyObject_HasAttr (C function)
@anchor{c-api/object c PyObject_HasAttr}@anchor{46d}
@deffn {C Función} int PyObject_HasAttr (PyObject *o, PyObject *attr_name)
` Part of the @ref{5f6,,Stable ABI}.'
Returns @code{1} if `o' has the attribute `attr_name', and @code{0} otherwise.
This function always succeeds.

@cartouche
@quotation Nota 
Exceptions that occur when this calls @ref{57a,,__getattr__()} and
@ref{c5a,,__getattribute__()} methods are silently ignored.
For proper error handling, use @ref{46c,,PyObject_HasAttrWithError()},
@ref{43d,,PyObject_GetOptionalAttr()} or @ref{43f,,PyObject_GetAttr()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyObject_HasAttrString (C function)
@anchor{c-api/object c PyObject_HasAttrString}@anchor{46f}
@deffn {C Función} int PyObject_HasAttrString (PyObject *o, const char *attr_name)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{46d,,PyObject_HasAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.

@cartouche
@quotation Nota 
Exceptions that occur when this calls @ref{57a,,__getattr__()} and
@ref{c5a,,__getattribute__()} methods or while creating the temporary
@ref{237,,str} object are silently ignored.
For proper error handling, use @ref{46e,,PyObject_HasAttrStringWithError()},
@ref{43e,,PyObject_GetOptionalAttrString()}
or @ref{440,,PyObject_GetAttrString()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyObject_GetAttr (C function)
@anchor{c-api/object c PyObject_GetAttr}@anchor{43f}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GetAttr (PyObject *o, PyObject *attr_name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Recupera un atributo llamado `attr_name' del objeto `o'. Retorna el valor del atributo en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o.attr_name}.

If the missing attribute should not be treated as a failure, you can use
@ref{43d,,PyObject_GetOptionalAttr()} instead.
@end deffn

@geindex PyObject_GetAttrString (C function)
@anchor{c-api/object c PyObject_GetAttrString}@anchor{440}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GetAttrString (PyObject *o, const char *attr_name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{43f,,PyObject_GetAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.

If the missing attribute should not be treated as a failure, you can use
@ref{43e,,PyObject_GetOptionalAttrString()} instead.
@end deffn

@geindex PyObject_GetOptionalAttr (C function)
@anchor{c-api/object c PyObject_GetOptionalAttr}@anchor{43d}
@deffn {C Función} int PyObject_GetOptionalAttr (PyObject *obj, PyObject *attr_name, PyObject **result);
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Variant of @ref{43f,,PyObject_GetAttr()} which doesn’t raise
@ref{441,,AttributeError} if the attribute is not found.

If the attribute is found, return @code{1} and set `*result' to a new
@ref{431,,strong reference} to the attribute.
If the attribute is not found, return @code{0} and set `*result' to @code{NULL};
the @ref{441,,AttributeError} is silenced.
If an error other than @ref{441,,AttributeError} is raised, return @code{-1} and
set `*result' to @code{NULL}.


Added in version 3.13.

@end deffn

@geindex PyObject_GetOptionalAttrString (C function)
@anchor{c-api/object c PyObject_GetOptionalAttrString}@anchor{43e}
@deffn {C Función} int PyObject_GetOptionalAttrString (PyObject *obj, const char *attr_name, PyObject **result);
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
This is the same as @ref{43d,,PyObject_GetOptionalAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyObject_GenericGetAttr (C function)
@anchor{c-api/object c PyObject_GenericGetAttr}@anchor{4993}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GenericGetAttr (PyObject *o, PyObject *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Función `getter' de atributo genérico que debe colocarse en la ranura @code{tp_getattro} de un objeto tipo. Busca un descriptor en el diccionario de clases en el MRO del objeto, así como un atributo en el objeto @code{__ dict__} (si está presente). Como se describe en @ref{cd7,,Implementando descriptores}, los descriptores de datos tienen preferencia sobre los atributos de instancia, mientras que los descriptores que no son de datos no lo hacen. De lo contrario, se lanza un @ref{441,,AttributeError}.
@end deffn

@geindex PyObject_SetAttr (C function)
@anchor{c-api/object c PyObject_SetAttr}@anchor{499b}
@deffn {C Función} int PyObject_SetAttr (PyObject *o, PyObject *attr_name, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el valor del atributo llamado `attr_name', para el objeto `o', en el valor `v'. Lanza una excepción y retorna @code{-1} en caso de falla; retorna @code{0} en caso de éxito. Este es el equivalente de la declaración de Python @code{o.attr_name = v}.

Si `v' es @code{NULL}, el atributo se elimina. Este comportamiento está deprecado en favor de usar @ref{1723,,PyObject_DelAttr()}, pero por el momento no hay planes de quitarlo.
@end deffn

@geindex PyObject_SetAttrString (C function)
@anchor{c-api/object c PyObject_SetAttrString}@anchor{1624}
@deffn {C Función} int PyObject_SetAttrString (PyObject *o, const char *attr_name, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{499b,,PyObject_SetAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.

Si `v' es @code{NULL}, el atributo se elimina, sin embargo, esta característica está deprecada en favor de usar @ref{1625,,PyObject_DelAttrString()}.

The number of different attribute names passed to this function
should be kept small, usually by using a statically allocated string
as `attr_name'.
For attribute names that aren’t known at compile time, prefer calling
@ref{48a3,,PyUnicode_FromString()} and @ref{499b,,PyObject_SetAttr()} directly.
For more details, see @ref{1622,,PyUnicode_InternFromString()}, which may be
used internally to create a key object.
@end deffn

@geindex PyObject_GenericSetAttr (C function)
@anchor{c-api/object c PyObject_GenericSetAttr}@anchor{4994}
@deffn {C Función} int PyObject_GenericSetAttr (PyObject *o, PyObject *name, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Establecimiento de atributo genérico y función de eliminación que está destinada a colocarse en la ranura de un objeto tipo @ref{4878,,tp_setattro}. Busca un descriptor de datos en el diccionario de clases en el MRO del objeto y, si se encuentra, tiene preferencia sobre la configuración o eliminación del atributo en el diccionario de instancias. De lo contrario, el atributo se establece o elimina en el objeto @ref{5fe,,__dict__} (si está presente). En caso de éxito, se retorna @code{0}; de lo contrario, se lanza un @ref{441,,AttributeError} y se retorna @code{-1}.
@end deffn

@geindex PyObject_DelAttr (C function)
@anchor{c-api/object c PyObject_DelAttr}@anchor{1723}
@deffn {C Función} int PyObject_DelAttr (PyObject *o, PyObject *attr_name)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Elimina el atributo llamado `attr_name', para el objeto `o'. Retorna @code{-1} en caso de falla. Este es el equivalente de la declaración de Python @code{del o.attr_name}.
@end deffn

@geindex PyObject_DelAttrString (C function)
@anchor{c-api/object c PyObject_DelAttrString}@anchor{1625}
@deffn {C Función} int PyObject_DelAttrString (PyObject *o, const char *attr_name)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
This is the same as @ref{1723,,PyObject_DelAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.

The number of different attribute names passed to this function
should be kept small, usually by using a statically allocated string
as `attr_name'.
For attribute names that aren’t known at compile time, prefer calling
@ref{48a3,,PyUnicode_FromString()} and @ref{1723,,PyObject_DelAttr()} directly.
For more details, see @ref{1622,,PyUnicode_InternFromString()}, which may be
used internally to create a key object for lookup.
@end deffn

@geindex PyObject_GenericGetDict (C function)
@anchor{c-api/object c PyObject_GenericGetDict}@anchor{1943}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GenericGetDict (PyObject *o, void *context)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Una implementación genérica para obtener un descriptor @code{__dict__}. Crea el diccionario si es necesario.

Esta función también puede ser llamada para obtener el @ref{5fe,,__dict__} del objeto `o'. Se pasa `context' igual a @code{NULL} cuando se lo llama. Dado que esta función puede necesitar asignar memoria para el diccionario, puede ser más eficiente llamar a @ref{43f,,PyObject_GetAttr()} para acceder a un atributo del objeto.

En caso de fallo, retorna @code{NULL} con una excepción establecida.


Added in version 3.3.

@end deffn

@geindex PyObject_GenericSetDict (C function)
@anchor{c-api/object c PyObject_GenericSetDict}@anchor{4995}
@deffn {C Función} int PyObject_GenericSetDict (PyObject *o, PyObject *value, void *context)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Una implementación genérica para el creador de un descriptor @code{__dict__}. Esta implementación no permite que se elimine el diccionario.


Added in version 3.3.

@end deffn

@geindex _PyObject_GetDictPtr (C function)
@anchor{c-api/object c _PyObject_GetDictPtr}@anchor{4ac1}
@deffn {C Función} @ref{42d,,PyObject} **_PyObject_GetDictPtr (PyObject *obj)

Retorna un puntero al @ref{5fe,,__dict__} del objeto `obj'. Si no hay @code{__dict__}, retorna @code{NULL} sin establecer una excepción.

Esta función puede necesitar asignar memoria para el diccionario, por lo que puede ser más eficiente llamar a @ref{43f,,PyObject_GetAttr()} para acceder a un atributo del objeto.
@end deffn

@geindex PyObject_RichCompare (C function)
@anchor{c-api/object c PyObject_RichCompare}@anchor{4881}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_RichCompare (PyObject *o1, PyObject *o2, int opid)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Compare the values of `o1' and `o2' using the operation specified by `opid',
which must be one of @ref{4ac2,,Py_LT}, @ref{4ac3,,Py_LE}, @ref{4ac4,,Py_EQ},
@ref{4ac5,,Py_NE}, @ref{4ac6,,Py_GT}, or @ref{4ac7,,Py_GE}, corresponding to @code{<},
@code{<=}, @code{==}, @code{!=}, @code{>}, or @code{>=} respectively. This is the equivalent of
the Python expression @code{o1 op o2}, where @code{op} is the operator corresponding
to `opid'. Returns the value of the comparison on success, or @code{NULL} on failure.
@end deffn

@geindex PyObject_RichCompareBool (C function)
@anchor{c-api/object c PyObject_RichCompareBool}@anchor{19ac}
@deffn {C Función} int PyObject_RichCompareBool (PyObject *o1, PyObject *o2, int opid)
` Part of the @ref{5f6,,Stable ABI}.'
Compare the values of `o1' and `o2' using the operation specified by `opid',
like @ref{4881,,PyObject_RichCompare()}, but returns @code{-1} on error, @code{0} if
the result is false, @code{1} otherwise.
@end deffn

@cartouche
@quotation Nota 
If `o1' and `o2' are the same object, @ref{19ac,,PyObject_RichCompareBool()}
will always return @code{1} for @ref{4ac4,,Py_EQ} and @code{0} for @ref{4ac5,,Py_NE}.
@end quotation
@end cartouche

@geindex PyObject_Format (C function)
@anchor{c-api/object c PyObject_Format}@anchor{4992}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Format (PyObject *obj, PyObject *format_spec)
` Part of the @ref{5f6,,Stable ABI}.'
Format `obj' using `format_spec'. This is equivalent to the Python
expression @code{format(obj, format_spec)}.

`format_spec' may be @code{NULL}. In this case the call is equivalent
to @code{format(obj)}.
Returns the formatted string on success, @code{NULL} on failure.
@end deffn

@geindex PyObject_Repr (C function)
@anchor{c-api/object c PyObject_Repr}@anchor{10ab}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Repr (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;repr

Calcula una representación de cadena de caracteres del objeto `o'. Retorna la representación de cadena de caracteres en caso de éxito, @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{repr(o)}. Llamado por la función incorporada @ref{894,,repr()}.


Distinto en la versión 3.4: Esta función ahora incluye una afirmación de depuración para ayudar a garantizar que no descarte silenciosamente una excepción activa.

@end deffn

@geindex PyObject_ASCII (C function)
@anchor{c-api/object c PyObject_ASCII}@anchor{498c}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_ASCII (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;ascii

Como @ref{10ab,,PyObject_Repr()}, calcula una representación de cadena de caracteres del objeto `o', pero escapa los caracteres no ASCII en la cadena de caracteres retornada por @ref{10ab,,PyObject_Repr()} con @code{\x}, @code{\u} o @code{\U} escapa. Esto genera una cadena de caracteres similar a la que retorna @ref{10ab,,PyObject_Repr()} en Python 2. Llamado por la función incorporada @ref{1426,,ascii()}.

@geindex string;PyObject_Str (C function)
@end deffn

@geindex PyObject_Str (C function)
@anchor{c-api/object c PyObject_Str}@anchor{10ac}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Str (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Calcula una representación de cadena de caracteres del objeto `o'. Retorna la representación de cadena de caracteres en caso de éxito, @code{NULL} en caso de error. Llamado por la función incorporada @ref{237,,str()} y, por lo tanto, por la función @ref{ff4,,print()}.


Distinto en la versión 3.4: Esta función ahora incluye una afirmación de depuración para ayudar a garantizar que no descarte silenciosamente una excepción activa.

@end deffn

@geindex PyObject_Bytes (C function)
@anchor{c-api/object c PyObject_Bytes}@anchor{498e}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Bytes (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;bytes

Calcula una representación de bytes del objeto `o'. @code{NULL} se retorna en caso de error y un objeto de bytes en caso de éxito. Esto es equivalente a la expresión de Python @code{bytes(o)}, cuando `o' no es un número entero. A diferencia de @code{bytes(o)}, se lanza un TypeError cuando `o' es un entero en lugar de un objeto de bytes con inicialización cero.
@end deffn

@geindex PyObject_IsSubclass (C function)
@anchor{c-api/object c PyObject_IsSubclass}@anchor{f28}
@deffn {C Función} int PyObject_IsSubclass (PyObject *derived, PyObject *cls)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si la clase `derived' es idéntica o derivada de la clase `cls'; de lo contrario, retorna @code{0}. En caso de error, retorna @code{-1}.

Si `cls' es una tupla, la verificación se realizará con cada entrada en `cls'. El resultado será @code{1} cuando al menos una de las verificaciones retorne @code{1}, de lo contrario será @code{0}.

If `cls' has a @ref{1f7d,,__subclasscheck__()} method, it will be called to
determine the subclass status as described in 
@geindex Python Enhancement Proposals; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}.  Otherwise,
`derived' is a subclass of `cls' if it is a direct or indirect subclass,
i.e. contained in @ref{1f2a,,cls.__mro__}.

Normally only class objects, i.e. instances of @ref{dcf,,type} or a derived
class, are considered classes.  However, objects can override this by having
a @ref{14e8,,__bases__} attribute (which must be a tuple of base classes).
@end deffn

@geindex PyObject_IsInstance (C function)
@anchor{c-api/object c PyObject_IsInstance}@anchor{f27}
@deffn {C Función} int PyObject_IsInstance (PyObject *inst, PyObject *cls)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si `inst' es una instancia de la clase `cls' o una subclase de `cls', o @code{0} si no. En caso de error, retorna @code{-1} y establece una excepción.

Si `cls' es una tupla, la verificación se realizará con cada entrada en `cls'. El resultado será @code{1} cuando al menos una de las verificaciones retorne @code{1}, de lo contrario será @code{0}.

If `cls' has a @ref{1f7c,,__instancecheck__()} method, it will be called to
determine the subclass status as described in 
@geindex Python Enhancement Proposals; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}.  Otherwise, `inst'
is an instance of `cls' if its class is a subclass of `cls'.

An instance `inst' can override what is considered its class by having a
@ref{14e9,,__class__} attribute.

An object `cls' can override if it is considered a class, and what its base
classes are, by having a @ref{14e8,,__bases__} attribute (which must be a tuple
of base classes).
@end deffn

@geindex PyObject_Hash (C function)
@anchor{c-api/object c PyObject_Hash}@anchor{29a}
@deffn {C Función} @ref{12d1,,Py_hash_t} PyObject_Hash (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;hash

Calcula y retorna el valor hash de un objeto `o'. En caso de fallo, retorna @code{-1}. Este es el equivalente de la expresión de Python @code{hash(o)}.


Distinto en la versión 3.2: El tipo de retorno ahora es `Py_hash_t'. Este es un entero con signo del mismo tamaño que @ref{af0,,Py_ssize_t}.

@end deffn

@geindex PyObject_HashNotImplemented (C function)
@anchor{c-api/object c PyObject_HashNotImplemented}@anchor{1406}
@deffn {C Función} @ref{12d1,,Py_hash_t} PyObject_HashNotImplemented (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Set a @ref{228,,TypeError} indicating that @code{type(o)} is not @ref{6b1,,hashable} and return @code{-1}.
This function receives special treatment when stored in a @code{tp_hash} slot,
allowing a type to explicitly indicate to the interpreter that it is not
hashable.
@end deffn

@geindex PyObject_IsTrue (C function)
@anchor{c-api/object c PyObject_IsTrue}@anchor{4998}
@deffn {C Función} int PyObject_IsTrue (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si el objeto `o' se considera verdadero y @code{0} en caso contrario. Esto es equivalente a la expresión de Python @code{not not o}. En caso de error, retorna @code{-1}.
@end deffn

@geindex PyObject_Not (C function)
@anchor{c-api/object c PyObject_Not}@anchor{499a}
@deffn {C Función} int PyObject_Not (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{0} si el objeto `o' se considera verdadero, y @code{1} de lo contrario. Esto es equivalente a la expresión de Python @code{not o}. En caso de error, retorna @code{-1}.
@end deffn

@geindex PyObject_Type (C function)
@anchor{c-api/object c PyObject_Type}@anchor{499d}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Type (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;type

When `o' is non-@code{NULL}, returns a type object corresponding to the object type
of object `o'. On failure, raises @ref{619,,SystemError} and returns @code{NULL}.  This
is equivalent to the Python expression @code{type(o)}.
This function creates a new @ref{431,,strong reference} to the return value.
There’s really no reason to use this
function instead of the @ref{26e,,Py_TYPE()} function, which returns a
pointer of type @ref{b30,,PyTypeObject}*, except when a new
@ref{431,,strong reference} is needed.
@end deffn

@geindex PyObject_TypeCheck (C function)
@anchor{c-api/object c PyObject_TypeCheck}@anchor{1900}
@deffn {C Función} int PyObject_TypeCheck (PyObject *o, PyTypeObject *type)

Retorna un valor no-nulo si el objeto `o' es de tipo `type' o un subtipo de `type', y @code{0} en cualquier otro caso. Ninguno de los dos parámetros debe ser @code{NULL}.
@end deffn

@geindex PyObject_Size (C function)
@geindex PyObject_Length (C function)
@anchor{c-api/object c PyObject_Size}@anchor{499c}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyObject_Size (PyObject *o)
@anchor{c-api/object c PyObject_Length}@anchor{4999}
@deffnx {C Función} @ref{af0,,Py_ssize_t} PyObject_Length (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Retorna la longitud del objeto `o'. Si el objeto `o' proporciona los protocolos de secuencia y mapeo, se retorna la longitud de la secuencia. En caso de error, se retorna @code{-1}. Este es el equivalente a la expresión de Python @code{len(o)}.
@end deffn

@geindex PyObject_LengthHint (C function)
@anchor{c-api/object c PyObject_LengthHint}@anchor{1080}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyObject_LengthHint (PyObject *o, Py_ssize_t defaultvalue)

Retorna una longitud estimada para el objeto `o'. Primero intenta retornar su longitud real, luego una estimación usando @ref{f8e,,__length_hint__()}, y finalmente retorna el valor predeterminado. En caso de error, retorna @code{-1}. Este es el equivalente a la expresión de Python @code{operator.length_hint(o, defaultvalue)}.


Added in version 3.4.

@end deffn

@geindex PyObject_GetItem (C function)
@anchor{c-api/object c PyObject_GetItem}@anchor{43b}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GetItem (PyObject *o, PyObject *key)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el elemento de `o' correspondiente a la clave `key' del objeto o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o[key]}.
@end deffn

@geindex PyObject_SetItem (C function)
@anchor{c-api/object c PyObject_SetItem}@anchor{48bf}
@deffn {C Función} int PyObject_SetItem (PyObject *o, PyObject *key, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
Asigna el objeto `key' al valor `v'. Lanza una excepción y retorna @code{-1} en caso de error; retorna @code{0} en caso de éxito. Este es el equivalente de la declaración de Python @code{o[key] = v}. Esta función `no' roba una referencia a `v'.
@end deffn

@geindex PyObject_DelItem (C function)
@anchor{c-api/object c PyObject_DelItem}@anchor{4990}
@deffn {C Función} int PyObject_DelItem (PyObject *o, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Elimina la asignación para el objeto `key' del objeto `o'. Retorna @code{-1} en caso de falla. Esto es equivalente a la declaración de Python @code{del o[key]}.
@end deffn

@geindex PyObject_Dir (C function)
@anchor{c-api/object c PyObject_Dir}@anchor{4991}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Dir (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esto es equivalente a la expresión de Python @code{dir(o)}, que retorna una lista (posiblemente vacía) de cadenas de caracteres apropiadas para el argumento del objeto, o @code{NULL} si hubo un error. Si el argumento es @code{NULL}, es como el Python @code{dir()}, que retorna los nombres de los locales actuales; en este caso, si no hay un marco de ejecución activo, se retorna @code{NULL} pero @ref{18fa,,PyErr_Occurred()} retornará falso.
@end deffn

@geindex PyObject_GetIter (C function)
@anchor{c-api/object c PyObject_GetIter}@anchor{4997}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GetIter (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esto es equivalente a la expresión de Python @code{iter(o)}. Retorna un nuevo iterador para el argumento del objeto, o el propio objeto si el objeto ya es un iterador. Lanza @ref{228,,TypeError} y retorna @code{NULL} si el objeto no puede iterarse.
@end deffn

@geindex PyObject_GetAIter (C function)
@anchor{c-api/object c PyObject_GetAIter}@anchor{4996}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_GetAIter (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Esto es equivalente a la expresión de Python @code{aiter(o)}. Toma un objeto @code{AsyncIterable} y retorna @code{AsyncIterator}. Este es típicamente un nuevo iterador, pero si el argumento es @code{AsyncIterator}, se retornará a sí mismo. Lanza @ref{228,,TypeError} y retorna @code{NULL} si el objeto no puede ser iterado.


Added in version 3.10.

@end deffn

@geindex PyObject_GetTypeData (C function)
@anchor{c-api/object c PyObject_GetTypeData}@anchor{5ec}
@deffn {C Función} void *PyObject_GetTypeData (PyObject *o, PyTypeObject *cls)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Get a pointer to subclass-specific data reserved for `cls'.

The object `o' must be an instance of `cls', and `cls' must have been
created using negative @ref{5eb,,PyType_Spec.basicsize}.
Python does not check this.

On error, set an exception and return @code{NULL}.


Added in version 3.12.

@end deffn

@geindex PyType_GetTypeDataSize (C function)
@anchor{c-api/object c PyType_GetTypeDataSize}@anchor{5ed}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyType_GetTypeDataSize (PyTypeObject *cls)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Return the size of the instance memory space reserved for `cls', i.e. the size of the
memory @ref{5ec,,PyObject_GetTypeData()} returns.

This may be larger than requested using @ref{5eb,,-PyType_Spec.basicsize};
it is safe to use this larger size (e.g. with @code{memset()}).

The type `cls' `must' have been created using
negative @ref{5eb,,PyType_Spec.basicsize}.
Python does not check this.

On error, set an exception and return a negative value.


Added in version 3.12.

@end deffn

@geindex PyObject_GetItemData (C function)
@anchor{c-api/object c PyObject_GetItemData}@anchor{5ef}
@deffn {C Función} void *PyObject_GetItemData (PyObject *o)

Get a pointer to per-item data for a class with
@ref{5ee,,Py_TPFLAGS_ITEMS_AT_END}.

On error, set an exception and return @code{NULL}.
@ref{228,,TypeError} is raised if `o' does not have
@ref{5ee,,Py_TPFLAGS_ITEMS_AT_END} set.


Added in version 3.12.

@end deffn

@geindex PyObject_VisitManagedDict (C function)
@anchor{c-api/object c PyObject_VisitManagedDict}@anchor{45d}
@deffn {C Función} int PyObject_VisitManagedDict (PyObject *obj, visitproc visit, void *arg)

Visit the managed dictionary of `obj'.

This function must only be called in a traverse function of the type which
has the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} flag set.


Added in version 3.13.

@end deffn

@geindex PyObject_ClearManagedDict (C function)
@anchor{c-api/object c PyObject_ClearManagedDict}@anchor{45e}
@deffn {C Función} void PyObject_ClearManagedDict (PyObject *obj)

Clear the managed dictionary of `obj'.

This function must only be called in a traverse function of the type which
has the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} flag set.


Added in version 3.13.

@end deffn

@geindex PyUnstable_Object_EnableDeferredRefcount (C function)
@anchor{c-api/object c PyUnstable_Object_EnableDeferredRefcount}@anchor{26c}
@deffn {C Función} int PyUnstable_Object_EnableDeferredRefcount (PyObject *obj)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Enable deferred reference counting@footnote{https://peps.python.org/pep-0703/#deferred-reference-counting} on `obj',
if supported by the runtime.  In the @ref{43ec,,free-threaded} build,
this allows the interpreter to avoid reference count adjustments to `obj',
which may improve multi-threaded performance.  The tradeoff is
that `obj' will only be deallocated by the tracing garbage collector.

This function returns @code{1} if deferred reference counting is enabled on `obj'
(including when it was enabled before the call),
and @code{0} if deferred reference counting is not supported or if the hint was
ignored by the runtime. This function is thread-safe, and cannot fail.

This function does nothing on builds with the @ref{2c5,,GIL} enabled, which do
not support deferred reference counting. This also does nothing if `obj' is not
an object tracked by the garbage collector (see @ref{1376,,gc.is_tracked()} and
@ref{a08,,PyObject_GC_IsTracked()}).

This function is intended to be used soon after `obj' is created,
by the code that creates it.


Added in version 3.14.0a1 (unreleased).

@end deffn

@node Protocolo de llamada,Protocolo de números,Protocolo de objeto,Capa de objetos abstractos
@anchor{c-api/call doc}@anchor{4ac8}@anchor{c-api/call call}@anchor{627}@anchor{c-api/call call-protocol}@anchor{4ac9}
@subsection Protocolo de llamada


CPython admite dos protocolos de llamada diferentes: `tp_call' y vectorcall.

@menu
* El protocolo tp_call:: 
* El protocolo vectorcall:: 
* API para invocar objetos:: 
* API de soporte de llamadas:: 

@end menu

@node El protocolo tp_call,El protocolo vectorcall,,Protocolo de llamada
@anchor{c-api/call the-tp-call-protocol}@anchor{4aca}
@subsubsection El protocolo `tp_call'


Las instancias de clases que establecen @ref{5fc,,tp_call} son invocables. La firma del slot es:

@example
PyObject *tp_call(PyObject *callable, PyObject *args, PyObject *kwargs);
@end example

Se realiza una llamada usando una tupla para los argumentos posicionales y un dict para los argumentos de palabras clave, de manera similar a @code{callable(*args, **kwargs)} en el código Python. `args' debe ser no NULL (use una tupla vacía si no hay argumentos) pero `kwargs' puede ser `NULL' si no hay argumentos de palabra clave.

Esta convención no solo es utilizada por `tp_call': @ref{623,,tp_new} y @ref{625,,tp_init} también pasan argumentos de esta manera.

To call an object, use @ref{48f,,PyObject_Call()} or another
@ref{4acb,,call API}.

@node El protocolo vectorcall,API para invocar objetos,El protocolo tp_call,Protocolo de llamada
@anchor{c-api/call the-vectorcall-protocol}@anchor{4acc}@anchor{c-api/call vectorcall}@anchor{5f5}
@subsubsection El protocolo vectorcall



Added in version 3.9.


El protocolo vectorcall se introdujo en 
@geindex Python Enhancement Proposals; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} como un protocolo adicional para hacer que las llamadas sean más eficientes.

Como regla general, CPython preferirá el vectorcall para llamadas internas si el invocable lo admite. Sin embargo, esta no es una regla estricta. Además, algunas extensiones de terceros usan `tp_call' directamente (en lugar de usar @ref{48f,,PyObject_Call()}). Por lo tanto, una clase que admita vectorcall también debe implementar @ref{5fc,,tp_call}. Además, el invocable debe comportarse de la misma manera independientemente del protocolo que se utilice. La forma recomendada de lograr esto es configurando @ref{5fc,,tp_call} en @ref{5f9,,PyVectorcall_Call()}. Vale la pena repetirlo:

@cartouche
@quotation Advertencia 
Una clase que admita vectorcall `debe' también implementar @ref{5fc,,tp_call} con la misma semántica.
@end quotation
@end cartouche


Distinto en la versión 3.12: The @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag is now removed from a class
when the class’s @ref{5fb,,__call__()} method is reassigned.
(This internally sets @ref{5fc,,tp_call} only, and thus
may make it behave differently than the vectorcall function.)
In earlier Python versions, vectorcall should only be used with
@ref{2a7,,immutable} or static types.


Una clase no debería implementar vectorcall si eso fuera más lento que `tp_call'. Por ejemplo, si el destinatario de la llamada necesita convertir los argumentos a una tupla args y un dict kwargs de todos modos, entonces no tiene sentido implementar vectorcall.

Classes can implement the vectorcall protocol by enabling the
@ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag and setting
@ref{4acd,,tp_vectorcall_offset} to the offset inside the
object structure where a `vectorcallfunc' appears.
This is a pointer to a function with the following signature:

@geindex vectorcallfunc (C type)
@anchor{c-api/call c vectorcallfunc}@anchor{5fa}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*vectorcallfunc)(@ref{42d,,PyObject} *callable, @ref{42d,,PyObject} *const *args, size_t nargsf, @ref{42d,,PyObject} *kwnames)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
@end deffn


@itemize -

@item 
`callable' es el objeto siendo invocado.

@item 

@table @asis

@item `args' es un arreglo en C que consta de los argumentos posicionales seguidos por el

valores de los argumentos de la palabra clave. Puede ser `NULL' si no hay argumentos.
@end table

@item 

@table @asis

@item `nargsf' es el número de argumentos posicionales más posiblemente el

@ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET} flag.
To get the actual number of positional arguments from `nargsf',
use @ref{5f8,,PyVectorcall_NARGS()}.
@end table

@item 

@table @asis

@item `kwnames' es una tupla que contiene los nombres de los argumentos de la palabra clave;

en otras palabras, las claves del diccionario kwargs. Estos nombres deben ser cadenas (instancias de @code{str} o una subclase) y deben ser únicos. Si no hay argumentos de palabras clave, entonces `kwnames' puede ser `NULL'.
@end table
@end itemize

@geindex PY_VECTORCALL_ARGUMENTS_OFFSET (C macro)
@anchor{c-api/call c PY_VECTORCALL_ARGUMENTS_OFFSET}@anchor{601}
@deffn {C Macro} PY_VECTORCALL_ARGUMENTS_OFFSET
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Si este flag se establece en un argumento vectorcall `nargsf', el destinatario de la llamada puede cambiar temporalmente @code{args[-1]}. En otras palabras, `args' apunta al argumento 1 (no 0) en el vector asignado. El destinatario de la llamada debe restaurar el valor de @code{args[-1]} antes de regresar.

Para @ref{600,,PyObject_VectorcallMethod()}, este flag significa en cambio que @code{args[0]} puede cambiarse.

Whenever they can do so cheaply (without additional allocation), callers
are encouraged to use @ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET}.
Doing so will allow callables such as bound methods to make their onward
calls (which include a prepended `self' argument) very efficiently.


Added in version 3.8.

@end deffn

Para llamar a un objeto que implementa vectorcall, use una función @ref{4acb,,call API} como con cualquier otro invocable. @ref{5ff,,PyObject_Vectorcall()} normalmente será más eficiente.

@menu
* Control de recursión: Control de recursión<2>. 
* API de soporte para vectorcall:: 

@end menu

@node Control de recursión<2>,API de soporte para vectorcall,,El protocolo vectorcall
@anchor{c-api/call recursion-control}@anchor{4ace}
@subsubsection Control de recursión


Cuando se usa `tp_call', los destinatarios no necesitan preocuparse por @ref{4a66,,recursividad}: CPython usa @ref{a05,,Py_EnterRecursiveCall()} y @ref{a06,,Py_LeaveRecursiveCall()} para llamadas realizadas usando `tp_call'.

Por eficiencia, este no es el caso de las llamadas realizadas mediante vectorcall: el destinatario de la llamada debe utilizar `Py_EnterRecursiveCall' y `Py_LeaveRecursiveCall' si es necesario.

@node API de soporte para vectorcall,,Control de recursión<2>,El protocolo vectorcall
@anchor{c-api/call vectorcall-support-api}@anchor{4acf}
@subsubsection API de soporte para vectorcall


@geindex PyVectorcall_NARGS (C function)
@anchor{c-api/call c PyVectorcall_NARGS}@anchor{5f8}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyVectorcall_NARGS (size_t nargsf)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Dado un argumento vectorcall `nargsf', retorna el número real de argumentos. Actualmente equivalente a:

@example
(Py_ssize_t)(nargsf & ~PY_VECTORCALL_ARGUMENTS_OFFSET)
@end example

Sin embargo, la función @code{PyVectorcall_NARGS} debe usarse para permitir futuras extensiones.


Added in version 3.8.

@end deffn

@geindex PyVectorcall_Function (C function)
@anchor{c-api/call c PyVectorcall_Function}@anchor{4ad0}
@deffn {C Función} @ref{5fa,,vectorcallfunc} PyVectorcall_Function (PyObject *op)

Si `op' no admite el protocolo vectorcall (ya sea porque el tipo no lo hace o porque la instancia específica no lo hace), retorna `NULL'. De lo contrario, retorna el puntero de la función vectorcall almacenado en `op'. Esta función nunca lanza una excepción.

Esto es principalmente útil para verificar si `op' admite vectorcall, lo cual se puede hacer marcando @code{PyVectorcall_Function(op) != NULL}.


Added in version 3.9.

@end deffn

@geindex PyVectorcall_Call (C function)
@anchor{c-api/call c PyVectorcall_Call}@anchor{5f9}
@deffn {C Función} @ref{42d,,PyObject} *PyVectorcall_Call (PyObject *callable, PyObject *tuple, PyObject *dict)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Llama a la @ref{5fa,,vectorcallfunc} de `callable' con argumentos posicionales y de palabras clave dados en una tupla y dict, respectivamente.

This is a specialized function, intended to be put in the
@ref{5fc,,tp_call} slot or be used in an implementation of @code{tp_call}.
It does not check the @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag
and it does not fall back to @code{tp_call}.


Added in version 3.8.

@end deffn

@node API para invocar objetos,API de soporte de llamadas,El protocolo vectorcall,Protocolo de llamada
@anchor{c-api/call capi-call}@anchor{4acb}@anchor{c-api/call object-calling-api}@anchor{4ad1}
@subsubsection API para invocar objetos


Hay varias funciones disponibles para llamar a un objeto Python. Cada una convierte sus argumentos a una convención respaldada por el objeto llamado, ya sea `tp_call' o vectorcall. Para realizar la menor conversión posible, elija la que mejor se adapte al formato de datos que tiene disponible.

La siguiente tabla resume las funciones disponibles; consulte la documentación individual para obtener más detalles.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Función

@tab

invocable

@tab

args

@tab

kwargs

@item

@ref{48f,,PyObject_Call()}

@tab

@code{PyObject *}

@tab

tupla

@tab

dict/@code{NULL}

@item

@ref{48e,,PyObject_CallNoArgs()}

@tab

@code{PyObject *}

@tab

—

@tab

—

@item

@ref{a0a,,PyObject_CallOneArg()}

@tab

@code{PyObject *}

@tab

1 objeto

@tab

—

@item

@ref{483d,,PyObject_CallObject()}

@tab

@code{PyObject *}

@tab

tuple/@code{NULL}

@tab

—

@item

@ref{491,,PyObject_CallFunction()}

@tab

@code{PyObject *}

@tab

formato

@tab

—

@item

@ref{492,,PyObject_CallMethod()}

@tab

obj + @code{char*}

@tab

formato

@tab

—

@item

@ref{498f,,PyObject_CallFunctionObjArgs()}

@tab

@code{PyObject *}

@tab

variadica

@tab

—

@item

@ref{1a05,,PyObject_CallMethodObjArgs()}

@tab

obj + nombre

@tab

variadica

@tab

—

@item

@ref{4ad2,,PyObject_CallMethodNoArgs()}

@tab

obj + nombre

@tab

—

@tab

—

@item

@ref{4ad3,,PyObject_CallMethodOneArg()}

@tab

obj + nombre

@tab

1 objeto

@tab

—

@item

@ref{5ff,,PyObject_Vectorcall()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

vectorcall

@item

@ref{4ad4,,PyObject_VectorcallDict()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

dict/@code{NULL}

@item

@ref{600,,PyObject_VectorcallMethod()}

@tab

arg + nombre

@tab

vectorcall

@tab

vectorcall

@end multitable


@geindex PyObject_Call (C function)
@anchor{c-api/call c PyObject_Call}@anchor{48f}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Call (PyObject *callable, PyObject *args, PyObject *kwargs)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Llama a un objeto de Python invocable `callable', con argumentos dados por la tupla `args', y argumentos con nombre dados por el diccionario `kwargs'.

`args' no debe ser `NULL'; use una tupla vacía si no se necesitan argumentos. Si no se necesitan argumentos con nombre, `kwargs' puede ser `NULL'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.

Este es el equivalente de la expresión de Python: @code{callable(*args, **kwargs)}.
@end deffn

@geindex PyObject_CallNoArgs (C function)
@anchor{c-api/call c PyObject_CallNoArgs}@anchor{48e}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallNoArgs (PyObject *callable)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Llama a un objeto de Python invocable `callable' sin ningún argumento. Es la forma más eficiente de llamar a un objeto Python invocable sin ningún argumento.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@geindex PyObject_CallOneArg (C function)
@anchor{c-api/call c PyObject_CallOneArg}@anchor{a0a}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallOneArg (PyObject *callable, PyObject *arg)
`Return value: New reference.'
Llama a un objeto de Python invocable `callable' con exactamente 1 argumento posicional `arg' y sin argumentos de palabra clave.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@geindex PyObject_CallObject (C function)
@anchor{c-api/call c PyObject_CallObject}@anchor{483d}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallObject (PyObject *callable, PyObject *args)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Llama a un objeto de Python invocable `callable', con argumentos dados por la tupla `args'. Si no se necesitan argumentos, entonces `args' puede ser `NULL'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.

Este es el equivalente de la expresión de Python: @code{callable(*args)}.
@end deffn

@geindex PyObject_CallFunction (C function)
@anchor{c-api/call c PyObject_CallFunction}@anchor{491}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallFunction (PyObject *callable, const char *format, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Llama a un objeto de Python invocable `callable', con un número variable de argumentos C. Los argumentos de C se describen usando una cadena de caracteres de formato de estilo @ref{940,,Py_BuildValue()}. El formato puede ser `NULL', lo que indica que no se proporcionan argumentos.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.

Este es el equivalente de la expresión de Python: @code{callable(*args)}.

Note that if you only pass @ref{42d,,PyObject}* args,
@ref{498f,,PyObject_CallFunctionObjArgs()} is a faster alternative.


Distinto en la versión 3.4: El tipo de `format' se cambió desde @code{char *}.

@end deffn

@geindex PyObject_CallMethod (C function)
@anchor{c-api/call c PyObject_CallMethod}@anchor{492}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallMethod (PyObject *obj, const char *name, const char *format, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Llama al método llamado `name' del objeto `obj' con un número variable de argumentos en C. Los argumentos de C se describen mediante una cadena de formato @ref{940,,Py_BuildValue()} que debería producir una tupla.

El formato puede ser `NULL', lo que indica que no se proporcionan argumentos.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.

Este es el equivalente de la expresión de Python: @code{obj.name(arg1, arg2, ...)}.

Note that if you only pass @ref{42d,,PyObject}* args,
@ref{1a05,,PyObject_CallMethodObjArgs()} is a faster alternative.


Distinto en la versión 3.4: Los tipos de `name' y `format' se cambiaron desde @code{char *}.

@end deffn

@geindex PyObject_CallFunctionObjArgs (C function)
@anchor{c-api/call c PyObject_CallFunctionObjArgs}@anchor{498f}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallFunctionObjArgs (PyObject *callable, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Call a callable Python object `callable', with a variable number of
@ref{42d,,PyObject}* arguments.  The arguments are provided as a variable number
of parameters followed by `NULL'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.

Este es el equivalente de la expresión de Python: @code{callable(arg1, arg2, ...)}.
@end deffn

@geindex PyObject_CallMethodObjArgs (C function)
@anchor{c-api/call c PyObject_CallMethodObjArgs}@anchor{1a05}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallMethodObjArgs (PyObject *obj, PyObject *name, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Call a method of the Python object `obj', where the name of the method is given as a
Python string object in `name'.  It is called with a variable number of
@ref{42d,,PyObject}* arguments.  The arguments are provided as a variable number
of parameters followed by `NULL'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.
@end deffn

@geindex PyObject_CallMethodNoArgs (C function)
@anchor{c-api/call c PyObject_CallMethodNoArgs}@anchor{4ad2}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallMethodNoArgs (PyObject *obj, PyObject *name)

Llama a un método del objeto de Python `obj' sin argumentos, donde el nombre del método se da como un objeto de cadena de caracteres de Python en `name'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@geindex PyObject_CallMethodOneArg (C function)
@anchor{c-api/call c PyObject_CallMethodOneArg}@anchor{4ad3}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_CallMethodOneArg (PyObject *obj, PyObject *name, PyObject *arg)

Llame a un método del objeto de Python `obj' con un único argumento posicional `arg', donde el nombre del método se proporciona como un objeto de cadena de caracteres de Python en `name'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@geindex PyObject_Vectorcall (C function)
@anchor{c-api/call c PyObject_Vectorcall}@anchor{5ff}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Vectorcall (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Llama a un objeto de Python invocable `callable'. Los argumentos son los mismos que para @ref{5fa,,vectorcallfunc}. Si `callable' admite @ref{5f5,,vectorcall}, esto llama directamente a la función vectorcall almacenada en `callable'.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@geindex PyObject_VectorcallDict (C function)
@anchor{c-api/call c PyObject_VectorcallDict}@anchor{4ad4}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_VectorcallDict (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)

Llamada `invocable' con argumentos posicionales pasados exactamente como en el protocolo @ref{5f5,,vectorcall}, pero con argumentos de palabras clave pasados como un diccionario `kwdict'. El arreglo `args' contiene solo los argumentos posicionales.

Independientemente del protocolo que se utilice internamente, es necesario realizar una conversión de argumentos. Por lo tanto, esta función solo debe usarse si la persona que llama ya tiene un diccionario listo para usar para los argumentos de palabras clave, pero no una tupla para los argumentos posicionales.


Added in version 3.9.

@end deffn

@geindex PyObject_VectorcallMethod (C function)
@anchor{c-api/call c PyObject_VectorcallMethod}@anchor{600}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_VectorcallMethod (PyObject *name, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Call a method using the vectorcall calling convention. The name of the method
is given as a Python string `name'. The object whose method is called is
`args[0]', and the `args' array starting at `args[1]' represents the arguments
of the call. There must be at least one positional argument.
`nargsf' is the number of positional arguments including `args[0]',
plus @ref{601,,PY_VECTORCALL_ARGUMENTS_OFFSET} if the value of @code{args[0]} may
temporarily be changed. Keyword arguments can be passed just like in
@ref{5ff,,PyObject_Vectorcall()}.

If the object has the @ref{4ad5,,Py_TPFLAGS_METHOD_DESCRIPTOR} feature,
this will call the unbound method object with the full
`args' vector as arguments.

Retorna el resultado de la llamada en caso de éxito o lanza una excepción y retorna `NULL' en caso de error.


Added in version 3.9.

@end deffn

@node API de soporte de llamadas,,API para invocar objetos,Protocolo de llamada
@anchor{c-api/call call-support-api}@anchor{4ad6}
@subsubsection API de soporte de llamadas


@geindex PyCallable_Check (C function)
@anchor{c-api/call c PyCallable_Check}@anchor{48ef}
@deffn {C Función} int PyCallable_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Determina si el objeto `o' es invocable. Retorna @code{1} si el objeto es invocable y @code{0} en caso contrario. Esta función siempre finaliza con éxito.
@end deffn

@node Protocolo de números,Protocolo de secuencia,Protocolo de llamada,Capa de objetos abstractos
@anchor{c-api/number doc}@anchor{4ad7}@anchor{c-api/number number}@anchor{4ad8}@anchor{c-api/number number-protocol}@anchor{4ad9}
@subsection Protocolo de números


@geindex PyNumber_Check (C function)
@anchor{c-api/number c PyNumber_Check}@anchor{af6}
@deffn {C Función} int PyNumber_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si el objeto `o' proporciona protocolos numéricos, y falso en caso contrario. Esta función siempre finaliza con éxito.


Distinto en la versión 3.8: Retorna @code{1} si `o' es un índice entero.

@end deffn

@geindex PyNumber_Add (C function)
@anchor{c-api/number c PyNumber_Add}@anchor{496b}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Add (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de agregar `o1' y `o2', o @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{o1 + o2}.
@end deffn

@geindex PyNumber_Subtract (C function)
@anchor{c-api/number c PyNumber_Subtract}@anchor{4985}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Subtract (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de restar `o2' de `o1', o @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{o1 - o2}.
@end deffn

@geindex PyNumber_Multiply (C function)
@anchor{c-api/number c PyNumber_Multiply}@anchor{497e}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Multiply (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de multiplicar `o1' y `o2', o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 * o2}.
@end deffn

@geindex PyNumber_MatrixMultiply (C function)
@anchor{c-api/number c PyNumber_MatrixMultiply}@anchor{f36}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_MatrixMultiply (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna el resultado de la multiplicación de matrices en `o1' y `o2', o @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{o1 @@ o2}.


Added in version 3.5.

@end deffn

@geindex PyNumber_FloorDivide (C function)
@anchor{c-api/number c PyNumber_FloorDivide}@anchor{496f}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_FloorDivide (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el cociente de la división entera a la baja entre `o1' y `o2', o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 // o2}.
@end deffn

@geindex PyNumber_TrueDivide (C function)
@anchor{c-api/number c PyNumber_TrueDivide}@anchor{4986}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_TrueDivide (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a reasonable approximation for the mathematical value of `o1' divided by
`o2', or @code{NULL} on failure.  The return value is «approximate» because binary
floating-point numbers are approximate; it is not possible to represent all real
numbers in base two.  This function can return a floating-point value when
passed two integers.  This is the equivalent of the Python expression @code{o1 / o2}.
@end deffn

@geindex PyNumber_Remainder (C function)
@anchor{c-api/number c PyNumber_Remainder}@anchor{4983}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Remainder (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resto de la división entera a la baja entre `o1' y `o2', o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 % o2}.
@end deffn

@geindex PyNumber_Divmod (C function)
@anchor{c-api/number c PyNumber_Divmod}@anchor{496e}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Divmod (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;divmod

Vea la función incorporada @ref{a33,,divmod()}. Retorna @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{divmod (o1, o2)}.
@end deffn

@geindex PyNumber_Power (C function)
@anchor{c-api/number c PyNumber_Power}@anchor{4982}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Power (PyObject *o1, PyObject *o2, PyObject *o3)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;pow

Consulte la función incorporada @ref{a64,,pow()}. Retorna @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{pow(o1, o2, o3)}, donde `o3' es opcional. Si se ignora `o3', pase @ref{4831,,Py_None} en su lugar (pasar @code{NULL} por `o3' provocaría un acceso ilegal a la memoria).
@end deffn

@geindex PyNumber_Negative (C function)
@anchor{c-api/number c PyNumber_Negative}@anchor{497f}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Negative (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la negación de `o' en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{-o}.
@end deffn

@geindex PyNumber_Positive (C function)
@anchor{c-api/number c PyNumber_Positive}@anchor{4981}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Positive (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna `o' en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{+o}.
@end deffn

@geindex PyNumber_Absolute (C function)
@anchor{c-api/number c PyNumber_Absolute}@anchor{496a}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Absolute (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;abs

Retorna el valor absoluto de `o' o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{abs(o)}.
@end deffn

@geindex PyNumber_Invert (C function)
@anchor{c-api/number c PyNumber_Invert}@anchor{497c}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Invert (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la negación bit a bit de `o' en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{~o}.
@end deffn

@geindex PyNumber_Lshift (C function)
@anchor{c-api/number c PyNumber_Lshift}@anchor{497d}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Lshift (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado del desplazamiento a la izquierda `o1' por `o2' en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 << o2}.
@end deffn

@geindex PyNumber_Rshift (C function)
@anchor{c-api/number c PyNumber_Rshift}@anchor{4984}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Rshift (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado del desplazamiento a la derecha `o1' por `o2' en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 >> o2}.
@end deffn

@geindex PyNumber_And (C function)
@anchor{c-api/number c PyNumber_And}@anchor{496c}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_And (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit y» (`bitwise and') de `o1' y `o2' en caso de éxito y @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 & o2}.
@end deffn

@geindex PyNumber_Xor (C function)
@anchor{c-api/number c PyNumber_Xor}@anchor{4987}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Xor (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit o exclusivo» (`bitwise exclusive or') de `o1' por `o2' en caso de éxito, o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 ^ o2}.
@end deffn

@geindex PyNumber_Or (C function)
@anchor{c-api/number c PyNumber_Or}@anchor{4980}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Or (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit o» (`bitwise or') de `o1' y `o2' en caso de éxito, o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1 | o2}.
@end deffn

@geindex PyNumber_InPlaceAdd (C function)
@anchor{c-api/number c PyNumber_InPlaceAdd}@anchor{4970}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceAdd (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de agregar `o1' y `o2', o @code{NULL} en caso de falla. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 += o2}.
@end deffn

@geindex PyNumber_InPlaceSubtract (C function)
@anchor{c-api/number c PyNumber_InPlaceSubtract}@anchor{4979}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceSubtract (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de restar `o2' de `o1', o @code{NULL} en caso de falla. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 -= o2}.
@end deffn

@geindex PyNumber_InPlaceMultiply (C function)
@anchor{c-api/number c PyNumber_InPlaceMultiply}@anchor{4974}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceMultiply (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de multiplicar `o1' y `o2', o @code{NULL} en caso de error. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 *= o2}.
@end deffn

@geindex PyNumber_InPlaceMatrixMultiply (C function)
@anchor{c-api/number c PyNumber_InPlaceMatrixMultiply}@anchor{f37}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceMatrixMultiply (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna el resultado de la multiplicación de matrices en `o1' y `o2', o @code{NULL} en caso de falla. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 @@= o2}.


Added in version 3.5.

@end deffn

@geindex PyNumber_InPlaceFloorDivide (C function)
@anchor{c-api/number c PyNumber_InPlaceFloorDivide}@anchor{4972}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceFloorDivide (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el cociente de la división entera a la baja entre `o1' y `o2', o @code{NULL} en caso de error. La operación se realiza in situ (`in-place') cuando `o1' lo admite. Es el equivalente de la sentencia de Python @code{o1 //= o2}.
@end deffn

@geindex PyNumber_InPlaceTrueDivide (C function)
@anchor{c-api/number c PyNumber_InPlaceTrueDivide}@anchor{497a}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceTrueDivide (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a reasonable approximation for the mathematical value of `o1' divided by
`o2', or @code{NULL} on failure.  The return value is «approximate» because binary
floating-point numbers are approximate; it is not possible to represent all real
numbers in base two.  This function can return a floating-point value when
passed two integers.  The operation is done `in-place' when `o1' supports it.
This is the equivalent of the Python statement @code{o1 /= o2}.
@end deffn

@geindex PyNumber_InPlaceRemainder (C function)
@anchor{c-api/number c PyNumber_InPlaceRemainder}@anchor{4977}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceRemainder (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resto de dividir `o1' entre `o2' o @code{NULL} en caso de error. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1%= o2}.
@end deffn

@geindex PyNumber_InPlacePower (C function)
@anchor{c-api/number c PyNumber_InPlacePower}@anchor{4976}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlacePower (PyObject *o1, PyObject *o2, PyObject *o3)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;pow

Consulte la función incorporada @ref{a64,,pow()}. Retorna @code{NULL} en caso de falla. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 **= o2} cuando `o3' es @ref{4831,,Py_None}, o una variante en su lugar (`in-place') de @code{pow (o1, o2, o3)} de lo contrario. Si se ignora `o3', pase @ref{4831,,Py_None} en su lugar (pasar @code{NULL} para `o3' provocaría un acceso ilegal a la memoria).
@end deffn

@geindex PyNumber_InPlaceLshift (C function)
@anchor{c-api/number c PyNumber_InPlaceLshift}@anchor{4973}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceLshift (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado del desplazamiento a la izquierda `o1' por `o2' en caso de éxito o @code{NULL} en caso de error. La operación se realiza en su sitio (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 <<= o2}.
@end deffn

@geindex PyNumber_InPlaceRshift (C function)
@anchor{c-api/number c PyNumber_InPlaceRshift}@anchor{4978}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceRshift (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado del desplazamiento a la derecha `o1' por `o2' en caso de éxito o @code{NULL} en caso de error. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 >>= o2}.
@end deffn

@geindex PyNumber_InPlaceAnd (C function)
@anchor{c-api/number c PyNumber_InPlaceAnd}@anchor{4971}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceAnd (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit y» (`bitwise and') de `o1' y `o2' en caso de éxito y @code{NULL} en caso de error. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 &= o2}.
@end deffn

@geindex PyNumber_InPlaceXor (C function)
@anchor{c-api/number c PyNumber_InPlaceXor}@anchor{497b}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceXor (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit o exclusivo» (`bitwise exclusive or') de `o1' por `o2' en caso de éxito, o @code{NULL} en caso de error. La operación se realiza en su lugar (`in-place') cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 ^= o2}.
@end deffn

@geindex PyNumber_InPlaceOr (C function)
@anchor{c-api/number c PyNumber_InPlaceOr}@anchor{4975}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_InPlaceOr (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «bit a bit o» (`bitwise or') de `o1' y `o2' en caso de éxito, o @code{NULL} en caso de error. La operación se realiza en su lugar `in-place' cuando `o1' lo admite. Este es el equivalente de la declaración de Python @code{o1 |= o2}.
@end deffn

@geindex PyNumber_Long (C function)
@anchor{c-api/number c PyNumber_Long}@anchor{af7}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Long (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;int

Retorna el `o' convertido a un objeto entero en caso de éxito, o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{int(o)}.
@end deffn

@geindex PyNumber_Float (C function)
@anchor{c-api/number c PyNumber_Float}@anchor{af8}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Float (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;float

Retorna el `o' convertido a un objeto flotante en caso de éxito o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{float(o)}.
@end deffn

@geindex PyNumber_Index (C function)
@anchor{c-api/number c PyNumber_Index}@anchor{92b}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_Index (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el `o' convertido aun entero de Python (`int') en caso de éxito o @code{NULL} con una excepción @ref{228,,TypeError} lanzada en caso de error.


Distinto en la versión 3.10: El resultado siempre tiene el tipo exacto @ref{1f0,,int}. Anteriormente, el resultado podía ser una instancia de una subclase de @code{int}.

@end deffn

@geindex PyNumber_ToBase (C function)
@anchor{c-api/number c PyNumber_ToBase}@anchor{17f1}
@deffn {C Función} @ref{42d,,PyObject} *PyNumber_ToBase (PyObject *n, int base)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el entero `n' convertido a base `base' como una cadena de caracteres. El argumento `base' debe ser uno de 2, 8, 10 o 16. Para la base 2, 8 o 16, la cadena retornada está prefijada con un marcador base de @code{'0b'}”, @code{'0o'} o @code{'0x'}, respectivamente. Si `n' no es un entero (`int') Python, primero se convierte con @ref{92b,,PyNumber_Index()}.
@end deffn

@geindex PyNumber_AsSsize_t (C function)
@anchor{c-api/number c PyNumber_AsSsize_t}@anchor{496d}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyNumber_AsSsize_t (PyObject *o, PyObject *exc)
` Part of the @ref{5f6,,Stable ABI}.'
Returns `o' converted to a @ref{af0,,Py_ssize_t} value if `o' can be interpreted as an
integer.  If the call fails, an exception is raised and @code{-1} is returned.

If `o' can be converted to a Python int but the attempt to
convert to a @ref{af0,,Py_ssize_t} value would raise an @ref{919,,OverflowError}, then the
`exc' argument is the type of exception that will be raised (usually
@ref{1575,,IndexError} or @ref{919,,OverflowError}).  If `exc' is @code{NULL}, then the
exception is cleared and the value is clipped to @code{PY_SSIZE_T_MIN} for a negative
integer or @code{PY_SSIZE_T_MAX} for a positive integer.
@end deffn

@geindex PyIndex_Check (C function)
@anchor{c-api/number c PyIndex_Check}@anchor{a1c}
@deffn {C Función} int PyIndex_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.8.'
Returns @code{1} if `o' is an index integer (has the @code{nb_index} slot of the
@code{tp_as_number} structure filled in), and @code{0} otherwise.
This function always succeeds.
@end deffn

@node Protocolo de secuencia,Protocolo de mapeo,Protocolo de números,Capa de objetos abstractos
@anchor{c-api/sequence doc}@anchor{4ada}@anchor{c-api/sequence sequence}@anchor{4adb}@anchor{c-api/sequence sequence-protocol}@anchor{4adc}
@subsection Protocolo de secuencia


@geindex PySequence_Check (C function)
@anchor{c-api/sequence c PySequence_Check}@anchor{49a1}
@deffn {C Función} int PySequence_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Return @code{1} if the object provides the sequence protocol, and @code{0} otherwise.
Note that it returns @code{1} for Python classes with a @ref{3d8,,__getitem__()}
method, unless they are @ref{190,,dict} subclasses, since in general it
is impossible to determine what type of keys the class supports.  This
function always succeeds.
@end deffn

@geindex PySequence_Size (C function)
@geindex PySequence_Length (C function)
@anchor{c-api/sequence c PySequence_Size}@anchor{1a59}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySequence_Size (PyObject *o)
@anchor{c-api/sequence c PySequence_Length}@anchor{49ab}
@deffnx {C Función} @ref{af0,,Py_ssize_t} PySequence_Length (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Retorna el número de objetos en secuencia `o' en caso de éxito y @code{-1} en caso de error. Esto es equivalente a la expresión de Python @code{len(o)}.
@end deffn

@geindex PySequence_Concat (C function)
@anchor{c-api/sequence c PySequence_Concat}@anchor{49a2}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_Concat (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la concatenación de `o1' y `o2' en caso de éxito, y @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o1+o2}.
@end deffn

@geindex PySequence_Repeat (C function)
@anchor{c-api/sequence c PySequence_Repeat}@anchor{49ad}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_Repeat (PyObject *o, Py_ssize_t count)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de repetir el objeto de secuencia `o' `count' veces, o @code{NULL} en caso de falla. Este es el equivalente de la expresión de Python @code{o*count}.
@end deffn

@geindex PySequence_InPlaceConcat (C function)
@anchor{c-api/sequence c PySequence_InPlaceConcat}@anchor{49a8}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_InPlaceConcat (PyObject *o1, PyObject *o2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la concatenación de `o1' y `o2' en caso de éxito, y @code{NULL} en caso de error. La operación se realiza en su lugar `in-place' cuando `o1' lo admite. Este es el equivalente de la expresión de Python @code{o1+=o2}.
@end deffn

@geindex PySequence_InPlaceRepeat (C function)
@anchor{c-api/sequence c PySequence_InPlaceRepeat}@anchor{49a9}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_InPlaceRepeat (PyObject *o, Py_ssize_t count)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el resultado de repetir el objeto de secuencia `o' `count' veces, o @code{NULL} en caso de falla. La operación se realiza en su lugar (`in-place') cuando `o' lo admite. Este es el equivalente de la expresión de Python @code{o*=count}.
@end deffn

@geindex PySequence_GetItem (C function)
@anchor{c-api/sequence c PySequence_GetItem}@anchor{1a5a}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_GetItem (PyObject *o, Py_ssize_t i)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el elemento `i'-ésimo de `o' o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o[i]}.
@end deffn

@geindex PySequence_GetSlice (C function)
@anchor{c-api/sequence c PySequence_GetSlice}@anchor{49a7}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_GetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la rebanada del objeto secuencia `o' entre `i1' y `i2', o @code{NULL} en caso de error. Este es el equivalente de la expresión de Python @code{o[i1:i2]}.
@end deffn

@geindex PySequence_SetItem (C function)
@anchor{c-api/sequence c PySequence_SetItem}@anchor{1a5b}
@deffn {C Función} int PySequence_SetItem (PyObject *o, Py_ssize_t i, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
Asigna el objeto `v' al elemento `i'-ésimo de `o'. Lanza una excepción y retorna @code{-1} en caso de falla; retorna @code{0} en caso de éxito. Este es el equivalente de la declaración de Python @code{o[i]=v}. Esta función `no' roba una referencia a `v'.

If `v' is @code{NULL}, the element is deleted, but this feature is
deprecated in favour of using @ref{1a5c,,PySequence_DelItem()}.
@end deffn

@geindex PySequence_DelItem (C function)
@anchor{c-api/sequence c PySequence_DelItem}@anchor{1a5c}
@deffn {C Función} int PySequence_DelItem (PyObject *o, Py_ssize_t i)
` Part of the @ref{5f6,,Stable ABI}.'
Elimina el elemento `i'-ésimo del objeto `o'. Retorna @code{-1} en caso de falla. Este es el equivalente de la declaración de Python @code{del o[i]}.
@end deffn

@geindex PySequence_SetSlice (C function)
@anchor{c-api/sequence c PySequence_SetSlice}@anchor{49ae}
@deffn {C Función} int PySequence_SetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
Asigna el objeto secuencia `v' al segmento en el objeto secuencia `o' de `i1' a `i2'. Este es el equivalente de la declaración de Python @code{o[i1:i2]=v}.
@end deffn

@geindex PySequence_DelSlice (C function)
@anchor{c-api/sequence c PySequence_DelSlice}@anchor{49a5}
@deffn {C Función} int PySequence_DelSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
` Part of the @ref{5f6,,Stable ABI}.'
Elimina el segmento en el objeto secuencia `o' de `i1' a `i2'. Retorna @code{-1} en caso de falla. Este es el equivalente de la declaración de Python @code{del o[i1:i2]}.
@end deffn

@geindex PySequence_Count (C function)
@anchor{c-api/sequence c PySequence_Count}@anchor{49a4}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySequence_Count (PyObject *o, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el número de apariciones de `value' en `o', es decir, retorna el número de claves para las que @code{o[clave]==value}. En caso de fallo, retorna @code{-1}. Esto es equivalente a la expresión de Python @code{o.count(value)}.
@end deffn

@geindex PySequence_Contains (C function)
@anchor{c-api/sequence c PySequence_Contains}@anchor{49a3}
@deffn {C Función} int PySequence_Contains (PyObject *o, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Determine si `o' contiene `valor'. Si un elemento en `o' es igual a `value', retorna @code{1}; de lo contrario, retorna @code{0}. En caso de error, retorna @code{-1}. Esto es equivalente a la expresión de Python @code{value in o}.
@end deffn

@geindex PySequence_Index (C function)
@anchor{c-api/sequence c PySequence_Index}@anchor{49aa}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySequence_Index (PyObject *o, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el primer índice `i' para el que @code{o[i]==value}. En caso de error, retorna @code{-1}. Esto es equivalente a la expresión de Python @code{o.index(value)}.
@end deffn

@geindex PySequence_List (C function)
@anchor{c-api/sequence c PySequence_List}@anchor{49ac}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_List (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un objeto lista con el mismo contenido que la secuencia o iterable `o', o @code{NULL} en caso de error. La lista retornada está garantizada como nueva. Esto es equivalente a la expresión de Python @code{list(o)}.
@end deffn

@geindex PySequence_Tuple (C function)
@anchor{c-api/sequence c PySequence_Tuple}@anchor{49af}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_Tuple (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;tuple

Retorna un objeto tupla con el mismo contenido que la secuencia o iterable `o', o @code{NULL} en caso de error. Si `o' es una tupla, se retornará una nueva referencia; de lo contrario, se construirá una tupla con el contenido apropiado. Esto es equivalente a la expresión de Python @code{tupla(o)}.
@end deffn

@geindex PySequence_Fast (C function)
@anchor{c-api/sequence c PySequence_Fast}@anchor{49a6}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_Fast (PyObject *o, const char *m)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la secuencia o iterable `o' como un objeto utilizable por la otra familia de funciones @code{PySequence_Fast*}. Si el objeto no es una secuencia o no es iterable, lanza @ref{228,,TypeError} con `m' como texto del mensaje. Retorna @code{NULL} en caso de falla.

Las funciones @code{PySequence_Fast*} se denominan así porque suponen que `o' es un @ref{4a76,,PyTupleObject} o un @ref{4add,,PyListObject} y acceden a los campos de datos de `o' directamente.

Como detalle de implementación de CPython, si `o' ya es una secuencia o lista, se retornará.
@end deffn

@geindex PySequence_Fast_GET_SIZE (C function)
@anchor{c-api/sequence c PySequence_Fast_GET_SIZE}@anchor{4ade}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySequence_Fast_GET_SIZE (PyObject *o)

Returns the length of `o', assuming that `o' was returned by
@ref{49a6,,PySequence_Fast()} and that `o' is not @code{NULL}.  The size can also be
retrieved by calling @ref{1a59,,PySequence_Size()} on `o', but
@ref{4ade,,PySequence_Fast_GET_SIZE()} is faster because it can assume `o' is a
list or tuple.
@end deffn

@geindex PySequence_Fast_GET_ITEM (C function)
@anchor{c-api/sequence c PySequence_Fast_GET_ITEM}@anchor{4adf}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_Fast_GET_ITEM (PyObject *o, Py_ssize_t i)
`Return value: Borrowed reference.'
Retorna el elemento `i'-ésimo de `o', suponiendo que `o' haya sido retornado por @ref{49a6,,PySequence_Fast()}, `o' no es @code{NULL} y que `i' está dentro de los límites.
@end deffn

@geindex PySequence_Fast_ITEMS (C function)
@anchor{c-api/sequence c PySequence_Fast_ITEMS}@anchor{4ae0}
@deffn {C Función} @ref{42d,,PyObject} **PySequence_Fast_ITEMS (PyObject *o)

Retorna el arreglo subyacente de punteros @cite{PyObject}. Asume que `o' fue retornado por @ref{49a6,,PySequence_Fast()} y `o' no es @code{NULL}.

Tenga en cuenta que si una lista cambia de tamaño, la reasignación puede reubicar el arreglo de elementos. Por lo tanto, solo use el puntero de arreglo subyacente en contextos donde la secuencia no puede cambiar.
@end deffn

@geindex PySequence_ITEM (C function)
@anchor{c-api/sequence c PySequence_ITEM}@anchor{4ae1}
@deffn {C Función} @ref{42d,,PyObject} *PySequence_ITEM (PyObject *o, Py_ssize_t i)
`Return value: New reference.'
Retorna el elemento `i'-ésimo de `o' o @code{NULL} en caso de error. Es la forma más rápida de @ref{1a5a,,PySequence_GetItem()} pero sin verificar que @ref{49a1,,PySequence_Check()} en `o' es verdadero y sin ajuste para índices negativos.
@end deffn

@node Protocolo de mapeo,Protocolo iterador,Protocolo de secuencia,Capa de objetos abstractos
@anchor{c-api/mapping doc}@anchor{4ae2}@anchor{c-api/mapping mapping}@anchor{4ae3}@anchor{c-api/mapping mapping-protocol}@anchor{4ae4}
@subsection Protocolo de mapeo


Consulte también @ref{43b,,PyObject_GetItem()}, @ref{48bf,,PyObject_SetItem()} y @ref{4990,,PyObject_DelItem()}.

@geindex PyMapping_Check (C function)
@anchor{c-api/mapping c PyMapping_Check}@anchor{495a}
@deffn {C Función} int PyMapping_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Return @code{1} if the object provides the mapping protocol or supports slicing,
and @code{0} otherwise.  Note that it returns @code{1} for Python classes with
a @ref{3d8,,__getitem__()} method, since in general it is impossible to
determine what type of keys the class supports. This function always succeeds.
@end deffn

@geindex PyMapping_Size (C function)
@geindex PyMapping_Length (C function)
@anchor{c-api/mapping c PyMapping_Size}@anchor{1a5d}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyMapping_Size (PyObject *o)
@anchor{c-api/mapping c PyMapping_Length}@anchor{495b}
@deffnx {C Función} @ref{af0,,Py_ssize_t} PyMapping_Length (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Retorna el número de claves en el objeto `o' en caso de éxito, y @code{-1} en caso de error. Esto es equivalente a la expresión de Python @code{len(o)}.
@end deffn

@geindex PyMapping_GetItemString (C function)
@anchor{c-api/mapping c PyMapping_GetItemString}@anchor{43c}
@deffn {C Función} @ref{42d,,PyObject} *PyMapping_GetItemString (PyObject *o, const char *key)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{43b,,PyObject_GetItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
@end deffn

@geindex PyMapping_GetOptionalItem (C function)
@anchor{c-api/mapping c PyMapping_GetOptionalItem}@anchor{439}
@deffn {C Función} int PyMapping_GetOptionalItem (PyObject *obj, PyObject *key, PyObject **result)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Variant of @ref{43b,,PyObject_GetItem()} which doesn’t raise
@ref{438,,KeyError} if the key is not found.

If the key is found, return @code{1} and set `*result' to a new
@ref{431,,strong reference} to the corresponding value.
If the key is not found, return @code{0} and set `*result' to @code{NULL};
the @ref{438,,KeyError} is silenced.
If an error other than @ref{438,,KeyError} is raised, return @code{-1} and
set `*result' to @code{NULL}.


Added in version 3.13.

@end deffn

@geindex PyMapping_GetOptionalItemString (C function)
@anchor{c-api/mapping c PyMapping_GetOptionalItemString}@anchor{43a}
@deffn {C Función} int PyMapping_GetOptionalItemString (PyObject *obj, const char *key, PyObject **result)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
This is the same as @ref{439,,PyMapping_GetOptionalItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyMapping_SetItemString (C function)
@anchor{c-api/mapping c PyMapping_SetItemString}@anchor{495c}
@deffn {C Función} int PyMapping_SetItemString (PyObject *o, const char *key, PyObject *v)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{48bf,,PyObject_SetItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
@end deffn

@geindex PyMapping_DelItem (C function)
@anchor{c-api/mapping c PyMapping_DelItem}@anchor{4ae5}
@deffn {C Función} int PyMapping_DelItem (PyObject *o, PyObject *key)

This is an alias of @ref{4990,,PyObject_DelItem()}.
@end deffn

@geindex PyMapping_DelItemString (C function)
@anchor{c-api/mapping c PyMapping_DelItemString}@anchor{4ae6}
@deffn {C Función} int PyMapping_DelItemString (PyObject *o, const char *key)

This is the same as @ref{4990,,PyObject_DelItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
@end deffn

@geindex PyMapping_HasKeyWithError (C function)
@anchor{c-api/mapping c PyMapping_HasKeyWithError}@anchor{470}
@deffn {C Función} int PyMapping_HasKeyWithError (PyObject *o, PyObject *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return @code{1} if the mapping object has the key `key' and @code{0} otherwise.
This is equivalent to the Python expression @code{key in o}.
On failure, return @code{-1}.


Added in version 3.13.

@end deffn

@geindex PyMapping_HasKeyStringWithError (C function)
@anchor{c-api/mapping c PyMapping_HasKeyStringWithError}@anchor{472}
@deffn {C Función} int PyMapping_HasKeyStringWithError (PyObject *o, const char *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
This is the same as @ref{470,,PyMapping_HasKeyWithError()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyMapping_HasKey (C function)
@anchor{c-api/mapping c PyMapping_HasKey}@anchor{471}
@deffn {C Función} int PyMapping_HasKey (PyObject *o, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si el objeto de mapeo tiene la clave `key' y @code{0} de lo contrario. Esto es equivalente a la expresión de Python @code{key in o}. Esta función siempre finaliza con éxito.

@cartouche
@quotation Nota 
Exceptions which occur when this calls @ref{3d8,,__getitem__()}
method are silently ignored.
For proper error handling, use @ref{470,,PyMapping_HasKeyWithError()},
@ref{439,,PyMapping_GetOptionalItem()} or @ref{43b,,PyObject_GetItem()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_HasKeyString (C function)
@anchor{c-api/mapping c PyMapping_HasKeyString}@anchor{473}
@deffn {C Función} int PyMapping_HasKeyString (PyObject *o, const char *key)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{471,,PyMapping_HasKey()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.

@cartouche
@quotation Nota 
Exceptions that occur when this calls @ref{3d8,,__getitem__()}
method or while creating the temporary @ref{237,,str}
object are silently ignored.
For proper error handling, use @ref{472,,PyMapping_HasKeyStringWithError()},
@ref{43a,,PyMapping_GetOptionalItemString()} or
@ref{43c,,PyMapping_GetItemString()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_Keys (C function)
@anchor{c-api/mapping c PyMapping_Keys}@anchor{c44}
@deffn {C Función} @ref{42d,,PyObject} *PyMapping_Keys (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
En caso de éxito, retorna una lista de las claves en el objeto `o'. En caso de fallo, retorna @code{NULL}.


Distinto en la versión 3.7: Anteriormente, la función retornaba una lista o una tupla.

@end deffn

@geindex PyMapping_Values (C function)
@anchor{c-api/mapping c PyMapping_Values}@anchor{c45}
@deffn {C Función} @ref{42d,,PyObject} *PyMapping_Values (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
En caso de éxito, retorna una lista de los valores en el objeto `o'. En caso de fallo, retorna @code{NULL}.


Distinto en la versión 3.7: Anteriormente, la función retornaba una lista o una tupla.

@end deffn

@geindex PyMapping_Items (C function)
@anchor{c-api/mapping c PyMapping_Items}@anchor{c46}
@deffn {C Función} @ref{42d,,PyObject} *PyMapping_Items (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
En caso de éxito, retorna una lista de los elementos en el objeto `o', donde cada elemento es una tupla que contiene un par clave-valor (`key-value'). En caso de fallo, retorna @code{NULL}.


Distinto en la versión 3.7: Anteriormente, la función retornaba una lista o una tupla.

@end deffn

@node Protocolo iterador,Protocolo búfer,Protocolo de mapeo,Capa de objetos abstractos
@anchor{c-api/iter doc}@anchor{4ae7}@anchor{c-api/iter iterator}@anchor{4ae8}@anchor{c-api/iter iterator-protocol}@anchor{4ae9}
@subsection Protocolo iterador


Hay dos funciones específicas para trabajar con iteradores.

@geindex PyIter_Check (C function)
@anchor{c-api/iter c PyIter_Check}@anchor{18fd}
@deffn {C Función} int PyIter_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.8.'
Return non-zero if the object `o' can be safely passed to
@ref{244,,PyIter_NextItem()} and @code{0} otherwise.
This function always succeeds.
@end deffn

@geindex PyAIter_Check (C function)
@anchor{c-api/iter c PyAIter_Check}@anchor{48d8}
@deffn {C Función} int PyAIter_Check (PyObject *o)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Return non-zero if the object `o' provides the @code{AsyncIterator}
protocol, and @code{0} otherwise.  This function always succeeds.


Added in version 3.10.

@end deffn

@geindex PyIter_NextItem (C function)
@anchor{c-api/iter c PyIter_NextItem}@anchor{244}
@deffn {C Función} int PyIter_NextItem (PyObject *iter, PyObject **item)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Return @code{1} and set `item' to a @ref{431,,strong reference} of the
next value of the iterator `iter' on success.
Return @code{0} and set `item' to @code{NULL} if there are no remaining values.
Return @code{-1}, set `item' to @code{NULL} and set an exception on error.


Added in version 3.14.

@end deffn

@geindex PyIter_Next (C function)
@anchor{c-api/iter c PyIter_Next}@anchor{245}
@deffn {C Función} @ref{42d,,PyObject} *PyIter_Next (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
This is an older version of @code{PyIter_NextItem()},
which is retained for backwards compatibility.
Prefer @ref{244,,PyIter_NextItem()}.

Return the next value from the iterator `o'.  The object must be an iterator
according to @ref{18fd,,PyIter_Check()} (it is up to the caller to check this).
If there are no remaining values, returns @code{NULL} with no exception set.
If an error occurs while retrieving the item, returns @code{NULL} and passes
along the exception.
@end deffn

@geindex PySendResult (C type)
@anchor{c-api/iter c PySendResult}@anchor{4aea}
@deffn {C Tipo} type PySendResult

El valor de enumeración utilizado para representar diferentes resultados de @ref{930,,PyIter_Send()}.


Added in version 3.10.

@end deffn

@geindex PyIter_Send (C function)
@anchor{c-api/iter c PyIter_Send}@anchor{930}
@deffn {C Función} @ref{4aea,,PySendResult} PyIter_Send (PyObject *iter, PyObject *arg, PyObject **presult)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Envía el valor `arg' al iterador `iter'. Retorna:


@itemize -

@item 
@code{PYGEN_RETURN} si el iterador regresa. El valor de retorno se retorna a través de `presult'.

@item 
@code{PYGEN_NEXT} si el iterador cede. El valor cedido se retorna a través de `presult'.

@item 
@code{PYGEN_ERROR} si el iterador ha lanzado una excepción. `presult' se establece en @code{NULL}.
@end itemize


Added in version 3.10.

@end deffn

@geindex buffer protocol
@geindex buffer interface;(see buffer protocol)
@geindex buffer object;(see buffer protocol)

@node Protocolo búfer,,Protocolo iterador,Capa de objetos abstractos
@anchor{c-api/buffer doc}@anchor{4aeb}@anchor{c-api/buffer buffer-protocol}@anchor{4aec}@anchor{c-api/buffer bufferobjects}@anchor{48a}
@subsection Protocolo búfer


Ciertos objetos disponibles en Python ajustan el acceso a un arreglo de memoria subyacente o `buffer'. Dichos objetos incluyen el incorporado @ref{325,,bytes} y @ref{5e0,,bytearray}, y algunos tipos de extensión como @ref{308,,array.array}. Las bibliotecas de terceros pueden definir sus propios tipos para fines especiales, como el procesamiento de imágenes o el análisis numérico.

Si bien cada uno de estos tipos tiene su propia semántica, comparten la característica común de estar respaldados por un búfer de memoria posiblemente grande. Es deseable, en algunas situaciones, acceder a ese búfer directamente y sin copia intermedia.

Python proporciona una instalación de este tipo en el nivel C en la forma de @ref{48a,,protocolo búfer}. Este protocolo tiene dos lados:

@geindex PyBufferProcs (C type)


@itemize -

@item 
en el lado del productor, un tipo puede exportar una «interfaz de búfer» que permite a los objetos de ese tipo exponer información sobre su búfer subyacente. Esta interfaz se describe en la sección @ref{4aed,,Estructuras de objetos búfer};

@item 
en el lado del consumidor, hay varios medios disponibles para obtener un puntero a los datos subyacentes sin procesar de un objeto (por ejemplo, un parámetro de método).
@end itemize

Los objetos simples como @ref{325,,bytes} y @ref{5e0,,bytearray} exponen su búfer subyacente en forma orientada a bytes. Otras formas son posibles; por ejemplo, los elementos expuestos por un @ref{308,,array.array} pueden ser valores de varios bytes.

An example consumer of the buffer interface is the @ref{d62,,write()}
method of file objects: any object that can export a series of bytes through
the buffer interface can be written to a file.  While @code{write()} only
needs read-only access to the internal contents of the object passed to it,
other methods such as @ref{2c21,,readinto()} need write access
to the contents of their argument.  The buffer interface allows objects to
selectively allow or reject exporting of read-write and read-only buffers.

Hay dos formas para que un consumidor de la interfaz del búfer adquiera un búfer sobre un objeto de destino:


@itemize *

@item 
llamar @ref{48c,,PyObject_GetBuffer()} con los parámetros correctos;

@item 
llamar @ref{615,,PyArg_ParseTuple()} (o uno de sus hermanos) con uno de los @code{y*}, @code{w*} o @code{s*} @ref{941,,códigos de formato}.
@end itemize

En ambos casos, se debe llamar a @ref{48d,,PyBuffer_Release()} cuando ya no se necesita el búfer. De lo contrario, podrían surgir varios problemas, como pérdidas de recursos.

@menu
* Estructura de búfer:: 
* Tipos de solicitud búfer:: 
* Arreglos complejos:: 
* Funciones relacionadas a búfer:: 

@end menu

@node Estructura de búfer,Tipos de solicitud búfer,,Protocolo búfer
@anchor{c-api/buffer buffer-structure}@anchor{4aee}@anchor{c-api/buffer id1}@anchor{4aef}
@subsubsection Estructura de búfer


Las estructuras de búfer (o simplemente «búferes») son útiles como una forma de exponer los datos binarios de otro objeto al programador de Python. También se pueden usar como un mecanismo de corte de copia cero. Usando su capacidad para hacer referencia a un bloque de memoria, es posible exponer cualquier información al programador Python con bastante facilidad. La memoria podría ser una matriz grande y constante en una extensión C, podría ser un bloque de memoria sin procesar para su manipulación antes de pasar a una biblioteca del sistema operativo, o podría usarse para pasar datos estructurados en su formato nativo en memoria .

Contrariamente a la mayoría de los tipos de datos expuestos por el intérprete de Python, los búferes no son punteros @ref{42d,,PyObject} sino estructuras C simples. Esto les permite ser creados y copiados de manera muy simple. Cuando se necesita un contenedor genérico alrededor de un búfer, un objeto @ref{4af0,,memoryview} puede ser creado.

Para obtener instrucciones breves sobre cómo escribir un objeto de exportación, consulte @ref{4aed,,Estructuras de objetos búfer}. Para obtener un búfer, consulte @ref{48c,,PyObject_GetBuffer()}.

@geindex Py_buffer (C type)
@anchor{c-api/buffer c Py_buffer}@anchor{7f2}
@deffn {C Tipo} type Py_buffer
` Part of the @ref{5f6,,Stable ABI} (including all members) since version 3.11.'
@geindex Py_buffer.buf (C member)
@anchor{c-api/buffer c Py_buffer buf}@anchor{4af1}
@deffn {C Miembro} void *buf

Un puntero al inicio de la estructura lógica descrita por los campos del búfer. Puede ser cualquier ubicación dentro del bloque de memoria física subyacente del exportador. Por ejemplo, con negativo @ref{4af2,,strides} el valor puede apuntar al final del bloque de memoria.

Para arreglos @ref{222d,,contiguous}, el valor apunta al comienzo del bloque de memoria.
@end deffn

@geindex Py_buffer.obj (C member)
@anchor{c-api/buffer c Py_buffer obj}@anchor{4af3}
@deffn {C Miembro} @ref{42d,,PyObject} *obj

A new reference to the exporting object. The reference is owned by
the consumer and automatically released
(i.e. reference count decremented)
and set to @code{NULL} by
@ref{48d,,PyBuffer_Release()}. The field is the equivalent of the return
value of any standard C-API function.

Como un caso especial, para los búferes `temporary' que están envueltos por @ref{7fb,,PyMemoryView_FromBuffer()} o @ref{7fa,,PyBuffer_FillInfo()} este campo es @code{NULL}. En general, los objetos de exportación NO DEBEN usar este esquema.
@end deffn

@geindex Py_buffer.len (C member)
@anchor{c-api/buffer c Py_buffer len}@anchor{4af4}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} len

@code{product(shape) * itemize}. Para arreglos contiguos, esta es la longitud del bloque de memoria subyacente. Para arreglos no contiguos, es la longitud que tendría la estructura lógica si se copiara en una representación contigua.

Accede a @code{((char *)buf)[0] hasta ((char *)buf)[len-1]} solo es válido si el búfer se ha obtenido mediante una solicitud que garantiza la contigüidad. En la mayoría de los casos, dicha solicitud será @ref{4af5,,PyBUF_SIMPLE} o @ref{13fa,,PyBUF_WRITABLE}.
@end deffn

@geindex Py_buffer.readonly (C member)
@anchor{c-api/buffer c Py_buffer readonly}@anchor{4af6}
@deffn {C Miembro} int readonly

Un indicador de si el búfer es de solo lectura. Este campo está controlado por el indicador @ref{13fa,,PyBUF_WRITABLE}.
@end deffn

@geindex Py_buffer.itemsize (C member)
@anchor{c-api/buffer c Py_buffer itemsize}@anchor{4af7}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} itemsize

Tamaño del elemento en bytes de un solo elemento. Igual que el valor de @ref{19cd,,struct.calcsize()} invocado en valores no @code{NULL} @ref{4af8,,format}.

Excepción importante: si un consumidor solicita un búfer sin el indicador @ref{4af9,,PyBUF_FORMAT}, @ref{4af8,,format} se establecerá en @code{NULL}, pero @ref{4af7,,itemsize} todavía tiene el valor para el formato original.

Si @ref{4afa,,shape} está presente, la igualdad @code{product(shape) * itemsize == len} aún se mantiene y el consumidor puede usar @ref{4af7,,itemsize} para navegar el búfer.

Si @ref{4afa,,shape} es @code{NULL} como resultado de un @ref{4af5,,PyBUF_SIMPLE} o un @ref{13fa,,PyBUF_WRITABLE}, el consumidor debe ignorar @ref{4af7,,itemsize} y asume @code{itemsize == 1}.
@end deffn

@geindex Py_buffer.format (C member)
@anchor{c-api/buffer c Py_buffer format}@anchor{4af8}
@deffn {C Miembro} char *format

A `NULL' terminated string in @ref{d5,,struct} module style syntax describing
the contents of a single item. If this is @code{NULL}, @code{"B"} (unsigned bytes)
is assumed.

Este campo está controlado por el indicador @ref{4af9,,PyBUF_FORMAT}.
@end deffn

@geindex Py_buffer.ndim (C member)
@anchor{c-api/buffer c Py_buffer ndim}@anchor{4afb}
@deffn {C Miembro} int ndim

The number of dimensions the memory represents as an n-dimensional array.
If it is @code{0}, @ref{4af1,,buf} points to a single item representing
a scalar. In this case, @ref{4afa,,shape}, @ref{4af2,,strides}
and @ref{4afc,,suboffsets} MUST be @code{NULL}.
The maximum number of dimensions is given by @ref{4afd,,PyBUF_MAX_NDIM}.
@end deffn

@geindex Py_buffer.shape (C member)
@anchor{c-api/buffer c Py_buffer shape}@anchor{4afa}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} *shape

Un arreglo de @ref{af0,,Py_ssize_t} de longitud @ref{4afb,,ndim} que indica la forma de la memoria como un arreglo n-dimensional. Tenga en cuenta que @code{shape[0] * ... * shape[ndim-1] * itemsize} DEBE ser igual a @ref{4af4,,len}.

Los valores de forma están restringidos a @code{shape[n] >= 0}. El caso @code{shape[n] == 0} requiere atención especial. Vea arreglos complejos (@ref{4afe,,complex arrays}) para más información.

El arreglo de formas es de sólo lectura para el consumidor.
@end deffn

@geindex Py_buffer.strides (C member)
@anchor{c-api/buffer c Py_buffer strides}@anchor{4af2}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} *strides

Un arreglo de @ref{af0,,Py_ssize_t} de longitud @ref{4afb,,ndim} que proporciona el número de bytes que se omiten para llegar a un nuevo elemento en cada dimensión.

Los valores de `stride' pueden ser cualquier número entero. Para los arreglos regulares, los pasos son generalmente positivos, pero un consumidor DEBE ser capaz de manejar el caso @code{strides[n] <= 0}. Ver @ref{4afe,,complex arrays} para más información.

El arreglo `strides' es de sólo lectura para el consumidor.
@end deffn

@geindex Py_buffer.suboffsets (C member)
@anchor{c-api/buffer c Py_buffer suboffsets}@anchor{4afc}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} *suboffsets

Un arreglo de @ref{af0,,Py_ssize_t} de longitud @ref{4afb,,ndim}. Si @code{suboffsets[n] >= 0}, los valores almacenados a lo largo de la enésima dimensión son punteros y el valor del `suboffsets' dicta cuántos bytes agregar a cada puntero después de desreferenciarlos. Un valor de `suboffsets' negativo indica que no debe producirse una desreferenciación (`striding' en un bloque de memoria contiguo).

Si todos los `suboffsets' son negativos (es decir, no se necesita desreferenciar), entonces este campo debe ser @code{NULL} (el valor predeterminado).

`Python Imaging Library (PIL)' utiliza este tipo de representación de arreglos. Consulte @ref{4afe,,complex arrays} para obtener más información sobre cómo acceder a los elementos de dicho arreglo.

El arreglo de `suboffsets' es de sólo lectura para el consumidor.
@end deffn

@geindex Py_buffer.internal (C member)
@anchor{c-api/buffer c Py_buffer internal}@anchor{4aff}
@deffn {C Miembro} void *internal

Esto es para uso interno del objeto exportador. Por ejemplo, el exportador podría volver a emitirlo como un número entero y utilizarlo para almacenar indicadores sobre si las matrices de forma, `strides' y `suboffsets' deben liberarse cuando se libera el búfer. El consumidor NO DEBE alterar este valor.
@end deffn
@end deffn

Constants:

@geindex PyBUF_MAX_NDIM (C macro)
@anchor{c-api/buffer c PyBUF_MAX_NDIM}@anchor{4afd}
@deffn {C Macro} PyBUF_MAX_NDIM

The maximum number of dimensions the memory represents.
Exporters MUST respect this limit, consumers of multi-dimensional
buffers SHOULD be able to handle up to @code{PyBUF_MAX_NDIM} dimensions.
Currently set to 64.
@end deffn

@node Tipos de solicitud búfer,Arreglos complejos,Estructura de búfer,Protocolo búfer
@anchor{c-api/buffer buffer-request-types}@anchor{43cb}@anchor{c-api/buffer id2}@anchor{4b00}
@subsubsection Tipos de solicitud búfer


Los búferes obtienen generalmente enviando una solicitud de búfer a un objeto de exportación a través de @ref{48c,,PyObject_GetBuffer()}. Dado que la complejidad de la estructura lógica de la memoria puede variar drásticamente, el consumidor usa el argumento `flags' para especificar el tipo de búfer exacto que puede manejar.

All @ref{7f2,,Py_buffer} fields are unambiguously defined by the request
type.

@menu
* campos independientes de solicitud:: 
* formato de sólo lectura:: 
* formas@comma{} strides@comma{} suboffsets: formas strides suboffsets. 
* solicitudes de contigüidad:: 
* solicitudes compuestas:: 

@end menu

@node campos independientes de solicitud,formato de sólo lectura,,Tipos de solicitud búfer
@anchor{c-api/buffer request-independent-fields}@anchor{4b01}
@subsubsection campos independientes de solicitud


Los siguientes campos no están influenciados por `flags' y siempre deben completarse con los valores correctos: @ref{4af3,,obj}, @ref{4af1,,buf}, @ref{4af4,,len}, @ref{4af7,,itemsize}, @ref{4afb,,ndim}.

@node formato de sólo lectura,formas strides suboffsets,campos independientes de solicitud,Tipos de solicitud búfer
@anchor{c-api/buffer readonly-format}@anchor{4b02}
@subsubsection formato de sólo lectura


@quotation

@geindex PyBUF_WRITABLE (C macro)
@anchor{c-api/buffer c PyBUF_WRITABLE}@anchor{13fa}
@deffn {C Macro} PyBUF_WRITABLE

Controls the @ref{4af6,,readonly} field. If set, the exporter
MUST provide a writable buffer or else report failure. Otherwise, the
exporter MAY provide either a read-only or writable buffer, but the choice
MUST be consistent for all consumers. For example, @ref{4af5,,PyBUF_SIMPLE} | @ref{13fa,,PyBUF_WRITABLE}
can be used to request a simple writable buffer.
@end deffn

@geindex PyBUF_FORMAT (C macro)
@anchor{c-api/buffer c PyBUF_FORMAT}@anchor{4af9}
@deffn {C Macro} PyBUF_FORMAT

Controla el campo @ref{4af8,,format}. Si se establece, este campo DEBE completarse correctamente. De lo contrario, este campo DEBE ser @code{NULL}.
@end deffn
@end quotation

@ref{13fa,,PyBUF_WRITABLE} puede ser |”d a cualquiera de las banderas en la siguiente sección. Dado que @ref{4af5,,PyBUF_SIMPLE} se define como 0, @ref{13fa,,PyBUF_WRITABLE} puede usarse como un indicador independiente para solicitar un búfer de escritura simple.

@ref{4af9,,PyBUF_FORMAT} must be |”d to any of the flags except @ref{4af5,,PyBUF_SIMPLE}, because
the latter already implies format @code{B} (unsigned bytes). @code{PyBUF_FORMAT} cannot be
used on its own.

@node formas strides suboffsets,solicitudes de contigüidad,formato de sólo lectura,Tipos de solicitud búfer
@anchor{c-api/buffer shape-strides-suboffsets}@anchor{4b03}
@subsubsection formas, `strides', `suboffsets'


Las banderas que controlan la estructura lógica de la memoria se enumeran en orden decreciente de complejidad. Tenga en cuenta que cada bandera contiene todos los bits de las banderas debajo de ella.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Solicitud

@tab

forma

@tab

`strides'

@tab

`suboffsets'

@item

@geindex PyBUF_INDIRECT (C macro)
@anchor{c-api/buffer c PyBUF_INDIRECT}@anchor{4b04}
@deffn {C Macro} PyBUF_INDIRECT
@end deffn

@tab

sí

@tab

sí

@tab

si es necesario

@item

@geindex PyBUF_STRIDES (C macro)
@anchor{c-api/buffer c PyBUF_STRIDES}@anchor{4b05}
@deffn {C Macro} PyBUF_STRIDES
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@item

@geindex PyBUF_ND (C macro)
@anchor{c-api/buffer c PyBUF_ND}@anchor{4b06}
@deffn {C Macro} PyBUF_ND
@end deffn

@tab

sí

@tab

NULL

@tab

NULL

@item

@geindex PyBUF_SIMPLE (C macro)
@anchor{c-api/buffer c PyBUF_SIMPLE}@anchor{4af5}
@deffn {C Macro} PyBUF_SIMPLE
@end deffn

@tab

NULL

@tab

NULL

@tab

NULL

@end multitable


@geindex contiguous
@geindex C-contiguous
@geindex Fortran contiguous

@node solicitudes de contigüidad,solicitudes compuestas,formas strides suboffsets,Tipos de solicitud búfer
@anchor{c-api/buffer contiguity-requests}@anchor{4b07}
@subsubsection solicitudes de contigüidad


La @ref{222d,,contigüidad} C o Fortran se puede solicitar explícitamente, con y sin información de paso. Sin información de paso, el búfer debe ser C-contiguo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

Solicitud

@tab

forma

@tab

`strides'

@tab

`suboffsets'

@tab

contig

@item

@geindex PyBUF_C_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_C_CONTIGUOUS}@anchor{13fb}
@deffn {C Macro} PyBUF_C_CONTIGUOUS
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

C

@item

@geindex PyBUF_F_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_F_CONTIGUOUS}@anchor{13fc}
@deffn {C Macro} PyBUF_F_CONTIGUOUS
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

F

@item

@geindex PyBUF_ANY_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_ANY_CONTIGUOUS}@anchor{4b08}
@deffn {C Macro} PyBUF_ANY_CONTIGUOUS
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

C o F

@item

@ref{4b06,,PyBUF_ND}

@tab

sí

@tab

NULL

@tab

NULL

@tab

C

@end multitable


@node solicitudes compuestas,,solicitudes de contigüidad,Tipos de solicitud búfer
@anchor{c-api/buffer compound-requests}@anchor{4b09}
@subsubsection solicitudes compuestas


Todas las solicitudes posibles están completamente definidas por alguna combinación de las banderas en la sección anterior. Por conveniencia, el protocolo de memoria intermedia proporciona combinaciones de uso frecuente como indicadores únicos.

En la siguiente tabla `U' significa contigüidad indefinida. El consumidor tendría que llamar a @ref{7f8,,PyBuffer_IsContiguous()} para determinar la contigüidad.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

Solicitud

@tab

forma

@tab

`strides'

@tab

`suboffsets'

@tab

contig

@tab

sólo lectura

@tab

formato

@item

@geindex PyBUF_FULL (C macro)
@anchor{c-api/buffer c PyBUF_FULL}@anchor{4b0a}
@deffn {C Macro} PyBUF_FULL
@end deffn

@tab

sí

@tab

sí

@tab

si es necesario

@tab

U

@tab

0

@tab

sí

@item

@geindex PyBUF_FULL_RO (C macro)
@anchor{c-api/buffer c PyBUF_FULL_RO}@anchor{4b0b}
@deffn {C Macro} PyBUF_FULL_RO
@end deffn

@tab

sí

@tab

sí

@tab

si es necesario

@tab

U

@tab

1 o 0

@tab

sí

@item

@geindex PyBUF_RECORDS (C macro)
@anchor{c-api/buffer c PyBUF_RECORDS}@anchor{4b0c}
@deffn {C Macro} PyBUF_RECORDS
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

U

@tab

0

@tab

sí

@item

@geindex PyBUF_RECORDS_RO (C macro)
@anchor{c-api/buffer c PyBUF_RECORDS_RO}@anchor{4b0d}
@deffn {C Macro} PyBUF_RECORDS_RO
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

U

@tab

1 o 0

@tab

sí

@item

@geindex PyBUF_STRIDED (C macro)
@anchor{c-api/buffer c PyBUF_STRIDED}@anchor{4b0e}
@deffn {C Macro} PyBUF_STRIDED
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

U

@tab

0

@tab

NULL

@item

@geindex PyBUF_STRIDED_RO (C macro)
@anchor{c-api/buffer c PyBUF_STRIDED_RO}@anchor{4b0f}
@deffn {C Macro} PyBUF_STRIDED_RO
@end deffn

@tab

sí

@tab

sí

@tab

NULL

@tab

U

@tab

1 o 0

@tab

NULL

@item

@geindex PyBUF_CONTIG (C macro)
@anchor{c-api/buffer c PyBUF_CONTIG}@anchor{4b10}
@deffn {C Macro} PyBUF_CONTIG
@end deffn

@tab

sí

@tab

NULL

@tab

NULL

@tab

C

@tab

0

@tab

NULL

@item

@geindex PyBUF_CONTIG_RO (C macro)
@anchor{c-api/buffer c PyBUF_CONTIG_RO}@anchor{4b11}
@deffn {C Macro} PyBUF_CONTIG_RO
@end deffn

@tab

sí

@tab

NULL

@tab

NULL

@tab

C

@tab

1 o 0

@tab

NULL

@end multitable


@node Arreglos complejos,Funciones relacionadas a búfer,Tipos de solicitud búfer,Protocolo búfer
@anchor{c-api/buffer complex-arrays}@anchor{4afe}
@subsubsection Arreglos complejos


@menu
* Estilo NumPy; forma y strides: Estilo NumPy forma y strides. 
* Estilo PIL; forma@comma{} strides y suboffsets: Estilo PIL forma strides y suboffsets. 

@end menu

@node Estilo NumPy forma y strides,Estilo PIL forma strides y suboffsets,,Arreglos complejos
@anchor{c-api/buffer numpy-style-shape-and-strides}@anchor{4b12}
@subsubsection Estilo NumPy: forma y `strides'


La estructura lógica de las matrices de estilo NumPy está definida por @ref{4af7,,itemsize}, @ref{4afb,,ndim}, @ref{4afa,,shape} y @ref{4af2,,strides}.

Si @code{ndim == 0}, la ubicación de memoria señalada por @ref{4af1,,buf} se interpreta como un escalar de tamaño @ref{4af7,,itemsize}. En ese caso, tanto @ref{4afa,,shape} como @ref{4af2,,strides} son @code{NULL}.

Si @ref{4af2,,strides} es @code{NULL}, el arreglo se interpreta como un arreglo C n-dimensional estándar. De lo contrario, el consumidor debe acceder a un arreglo n-dimensional de la siguiente manera:

@example
ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1];
item = *((typeof(item) *)ptr);
@end example

Como se señaló anteriormente, @ref{4af1,,buf} puede apuntar a cualquier ubicación dentro del bloque de memoria real. Un exportador puede verificar la validez de un búfer con esta función:

@example
def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    """Verify that the parameters represent a valid array within
       the bounds of the allocated memory:
           char *mem: start of the physical memory block
           memlen: length of the physical memory block
           offset: (char *)buf - mem
    """
    if offset % itemsize:
        return False
    if offset < 0 or offset+itemsize > memlen:
        return False
    if any(v % itemsize for v in strides):
        return False

    if ndim <= 0:
        return ndim == 0 and not shape and not strides
    if 0 in shape:
        return True

    imin = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] <= 0)
    imax = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] > 0)

    return 0 <= offset+imin and offset+imax+itemsize <= memlen
@end example

@node Estilo PIL forma strides y suboffsets,,Estilo NumPy forma y strides,Arreglos complejos
@anchor{c-api/buffer pil-style-shape-strides-and-suboffsets}@anchor{4b13}
@subsubsection Estilo PIL: forma, `strides' y `suboffsets'


Además de los elementos normales, los arreglos de estilo PIL pueden contener punteros que deben seguirse para llegar al siguiente elemento en una dimensión. Por ejemplo, el arreglo C tridimensional regular @code{char v[2][2][3]} también se puede ver como un arreglo de 2 punteros a 2 arreglos bidimensionales: @code{char (*v[2])[2][3]}. En la representación de `suboffsets', esos dos punteros pueden incrustarse al comienzo de @ref{4af1,,buf}, apuntando a dos matrices @code{char x[2][3]} que pueden ubicarse en cualquier lugar de la memoria.

Aquí hay una función que retorna un puntero al elemento en un arreglo N-D a la que apunta un índice N-dimensional cuando hay `strides' y `suboffsets' no @code{NULL}:

@example
void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides,
                       Py_ssize_t *suboffsets, Py_ssize_t *indices) @{
    char *pointer = (char*)buf;
    int i;
    for (i = 0; i < ndim; i++) @{
        pointer += strides[i] * indices[i];
        if (suboffsets[i] >=0 ) @{
            pointer = *((char**)pointer) + suboffsets[i];
        @}
    @}
    return (void*)pointer;
@}
@end example

@node Funciones relacionadas a búfer,,Arreglos complejos,Protocolo búfer
@anchor{c-api/buffer buffer-related-functions}@anchor{4b14}
@subsubsection Funciones relacionadas a búfer


@geindex PyObject_CheckBuffer (C function)
@anchor{c-api/buffer c PyObject_CheckBuffer}@anchor{48b}
@deffn {C Función} int PyObject_CheckBuffer (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Retorna @code{1} si `obj' admite la interfaz de búfer; de lo contrario, @code{0} cuando se retorna @code{1}, no garantiza que @ref{48c,,PyObject_GetBuffer()} tenga éxito. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyObject_GetBuffer (C function)
@anchor{c-api/buffer c PyObject_GetBuffer}@anchor{48c}
@deffn {C Función} int PyObject_GetBuffer (PyObject *exporter, Py_buffer *view, int flags)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Send a request to `exporter' to fill in `view' as specified by  `flags'.
If the exporter cannot provide a buffer of the exact type, it MUST raise
@ref{182b,,BufferError}, set @code{view->obj} to @code{NULL} and
return @code{-1}.

Si tiene éxito, completa `view', establece @code{view->obj} en una nueva referencia a `exporter' y retorna 0. En el caso de proveedores de búfer encadenados que redirigen las solicitudes a un solo objeto, @code{view->obj} PUEDE referirse a este objeto en lugar de `exporter' (Ver @ref{4aed,,Estructuras de objetos de búfer}).

Las llamadas exitosas a @ref{48c,,PyObject_GetBuffer()} deben combinarse con las llamadas a @ref{48d,,PyBuffer_Release()}, similar a @code{malloc()} y @code{free()}. Por lo tanto, después de que el consumidor haya terminado con el búfer, @ref{48d,,PyBuffer_Release()} debe llamarse exactamente una vez.
@end deffn

@geindex PyBuffer_Release (C function)
@anchor{c-api/buffer c PyBuffer_Release}@anchor{48d}
@deffn {C Función} void PyBuffer_Release (Py_buffer *view)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Release the buffer `view' and release the @ref{431,,strong reference}
(i.e. decrement the reference count) to the view’s supporting object,
@code{view->obj}. This function MUST be called when the buffer
is no longer being used, otherwise reference leaks may occur.

Es un error llamar a esta función en un búfer que no se obtuvo a través de @ref{48c,,PyObject_GetBuffer()}.
@end deffn

@geindex PyBuffer_SizeFromFormat (C function)
@anchor{c-api/buffer c PyBuffer_SizeFromFormat}@anchor{7f4}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyBuffer_SizeFromFormat (const char *format)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Return the implied @ref{4af7,,itemsize} from @ref{4af8,,format}.
On error, raise an exception and return -1.


Added in version 3.9.

@end deffn

@geindex PyBuffer_IsContiguous (C function)
@anchor{c-api/buffer c PyBuffer_IsContiguous}@anchor{7f8}
@deffn {C Función} int PyBuffer_IsContiguous (const Py_buffer *view, char order)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Retorna @code{1} si la memoria definida por `view' es de estilo C (`order' es @code{'C'}) o de estilo Fortran (`order' es @code{'F'}) @ref{222d,,contiguous} o uno cualquiera (`order' es @code{'A'}). Retorna @code{0} de lo contrario. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyBuffer_GetPointer (C function)
@anchor{c-api/buffer c PyBuffer_GetPointer}@anchor{7f3}
@deffn {C Función} void *PyBuffer_GetPointer (const Py_buffer *view, const Py_ssize_t *indices)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Obtiene el área de memoria señalada por los `indices' dentro del `view' dado. `indices' deben apuntar a un arreglo de índices @code{view->ndim}.
@end deffn

@geindex PyBuffer_FromContiguous (C function)
@anchor{c-api/buffer c PyBuffer_FromContiguous}@anchor{7f6}
@deffn {C Función} int PyBuffer_FromContiguous (const Py_buffer *view, const void *buf, Py_ssize_t len, char fort)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Copia `len' bytes contiguos de `buf' a `view'. `fort' puede ser @code{'C'} o @code{'F'} (para pedidos al estilo C o al estilo Fortran). @code{0} se retorna en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyBuffer_ToContiguous (C function)
@anchor{c-api/buffer c PyBuffer_ToContiguous}@anchor{7f5}
@deffn {C Función} int PyBuffer_ToContiguous (void *buf, const Py_buffer *src, Py_ssize_t len, char order)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Copia `len' bytes de `src' a su representación contigua en `buf'. `order' puede ser @code{'C'} o @code{'F'} o @code{'@w{'}A'} (para pedidos al estilo C o al estilo Fortran o cualquiera) @code{0} se retorna en caso de éxito, @code{-1} en caso de error.

Esta función falla si `len' != `src->len'.
@end deffn

@geindex PyObject_CopyData (C function)
@anchor{c-api/buffer c PyObject_CopyData}@anchor{7f7}
@deffn {C Función} int PyObject_CopyData (PyObject *dest, PyObject *src)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Copiar datos del búfer `src' al `dest'. Puede convertir entre búferes de estilo C o Fortran.

Se retorna @code{0} en caso de éxito, @code{-1} en caso de error.
@end deffn

@geindex PyBuffer_FillContiguousStrides (C function)
@anchor{c-api/buffer c PyBuffer_FillContiguousStrides}@anchor{7f9}
@deffn {C Función} void PyBuffer_FillContiguousStrides (int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Rellena el arreglo `strides' con bytes de paso de un @ref{222d,,contiguous} (estilo C si `order' es @code{'C'} o estilo Fortran si `order' es @code{'F '} ) arreglo de la forma dada con el número dado de bytes por elemento.
@end deffn

@geindex PyBuffer_FillInfo (C function)
@anchor{c-api/buffer c PyBuffer_FillInfo}@anchor{7fa}
@deffn {C Función} int PyBuffer_FillInfo (Py_buffer *view, PyObject *exporter, void *buf, Py_ssize_t len, int readonly, int flags)
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Maneje las solicitudes de búfer para un exportador que quiera exponer `buf' de tamaño `len' con capacidad de escritura establecida de acuerdo con `readonly'. `buf' se interpreta como una secuencia de bytes sin signo.

El argumento `flags' indica el tipo de solicitud. Esta función siempre llena `view' según lo especificado por `flags', a menos que `buf' haya sido designado como solo lectura y @ref{13fa,,PyBUF_WRITABLE} esté configurado en `flags'.

On success, set @code{view->obj} to a new reference to `exporter' and
return 0. Otherwise, raise @ref{182b,,BufferError}, set
@code{view->obj} to @code{NULL} and return @code{-1};

Si esta función se usa como parte de a @ref{4aed,,getbufferproc}, `exporter' DEBE establecerse en el objeto exportador y `flags' deben pasarse sin modificaciones. De lo contrario, `exporter' DEBE ser @code{NULL}.
@end deffn

@node Capa de objetos concretos,Inicialización finalización e hilos,Capa de objetos abstractos,Manual de referencia de la API en C de Python
@anchor{c-api/concrete doc}@anchor{4b15}@anchor{c-api/concrete concrete}@anchor{4b16}@anchor{c-api/concrete concrete-objects-layer}@anchor{4b17}
@section Capa de objetos concretos


Las funciones de este capítulo son específicas de ciertos tipos de objetos de Python. Pasarles un objeto del tipo incorrecto no es una buena idea; si recibe un objeto de un programa Python y no está seguro de que tenga el tipo correcto, primero debe realizar una verificación de tipo; por ejemplo, para verificar que un objeto es un diccionario, utilice @ref{4b18,,PyDict_Check()}. El capítulo está estructurado como el «árbol genealógico» de los tipos de objetos Python.

@cartouche
@quotation Advertencia 
Si bien las funciones descritas en este capítulo verifican cuidadosamente el tipo de objetos que se pasan, muchos de ellos no verifican si se pasa @code{NULL} en lugar de un objeto válido. Permitir que se pase @code{NULL} puede causar violaciones de acceso a la memoria y la terminación inmediata del intérprete.
@end quotation
@end cartouche

@menu
* Objetos fundamentales:: 
* Objetos numéricos:: 
* Objetos de secuencia:: 
* Objetos contenedor:: 
* Objetos de función:: 
* Otros objetos: Otros objetos<2>. 

@end menu

@node Objetos fundamentales,Objetos numéricos,,Capa de objetos concretos
@anchor{c-api/concrete fundamental}@anchor{4b19}@anchor{c-api/concrete fundamental-objects}@anchor{4b1a}
@subsection Objetos fundamentales


Esta sección describe los objetos de tipo Python y el objeto singleton @code{None}.

@menu
* Objetos tipo:: 
* El objeto None:: 

@end menu

@node Objetos tipo,El objeto None,,Objetos fundamentales
@anchor{c-api/type doc}@anchor{4b1b}@anchor{c-api/type type-objects}@anchor{4b1c}@anchor{c-api/type typeobjects}@anchor{4b1d}
@subsubsection Objetos tipo


@geindex object;type

@geindex PyTypeObject (C type)
@anchor{c-api/type c PyTypeObject}@anchor{b30}
@deffn {C Tipo} type PyTypeObject
` Part of the @ref{5f6,,Limited API} (as an opaque struct).'
La estructura C de los objetos utilizados para describir los tipos incorporados.
@end deffn

@geindex PyType_Type (C var)
@anchor{c-api/type c PyType_Type}@anchor{5f0}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyType_Type
` Part of the @ref{5f6,,Stable ABI}.'
Este es el objeto tipo para objetos tipo; es el mismo objeto que @ref{dcf,,type} en la capa Python.
@end deffn

@geindex PyType_Check (C function)
@anchor{c-api/type c PyType_Check}@anchor{19a7}
@deffn {C Función} int PyType_Check (PyObject *o)

Retorna un valor distinto de cero si el objeto `o' es un objeto tipo, incluidas las instancias de tipos derivados del objeto de tipo estándar. Retorna 0 en todos los demás casos. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyType_CheckExact (C function)
@anchor{c-api/type c PyType_CheckExact}@anchor{19a8}
@deffn {C Función} int PyType_CheckExact (PyObject *o)

Retorna un valor distinto de cero si el objeto `o' es un objeto tipo, pero no un subtipo del objeto tipo estándar. Retorna 0 en todos los demás casos. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyType_ClearCache (C function)
@anchor{c-api/type c PyType_ClearCache}@anchor{49cc}
@deffn {C Función} unsigned int PyType_ClearCache ()
` Part of the @ref{5f6,,Stable ABI}.'
Borra la caché de búsqueda interna. Retorna la etiqueta (`tag') de la versión actual.
@end deffn

@geindex PyType_GetFlags (C function)
@anchor{c-api/type c PyType_GetFlags}@anchor{195e}
@deffn {C Función} unsigned long PyType_GetFlags (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI}.'
Return the @ref{18c6,,tp_flags} member of `type'. This function is primarily
meant for use with @code{Py_LIMITED_API}; the individual flag bits are
guaranteed to be stable across Python releases, but access to
@ref{18c6,,tp_flags} itself is not part of the @ref{488,,limited API}.


Added in version 3.2.



Distinto en la versión 3.4: El tipo de retorno es ahora @code{unsigned long} en vez de @code{long}.

@end deffn

@geindex PyType_GetDict (C function)
@anchor{c-api/type c PyType_GetDict}@anchor{1724}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetDict (PyTypeObject *type)

Return the type object’s internal namespace, which is otherwise only
exposed via a read-only proxy (@ref{ce5,,cls.__dict__}).
This is a
replacement for accessing @ref{1725,,tp_dict} directly.
The returned dictionary must be treated as read-only.

This function is meant for specific embedding and language-binding cases,
where direct access to the dict is necessary and indirect access
(e.g. via the proxy or @ref{43f,,PyObject_GetAttr()}) isn’t adequate.

Extension modules should continue to use @code{tp_dict},
directly or indirectly, when setting up their own types.


Added in version 3.12.

@end deffn

@geindex PyType_Modified (C function)
@anchor{c-api/type c PyType_Modified}@anchor{17f9}
@deffn {C Función} void PyType_Modified (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI}.'
Invalida la memoria caché de búsqueda interna para el tipo y todos sus subtipos. Esta función debe llamarse después de cualquier modificación manual de los atributos o clases base del tipo.
@end deffn

@geindex PyType_AddWatcher (C function)
@anchor{c-api/type c PyType_AddWatcher}@anchor{608}
@deffn {C Función} int PyType_AddWatcher (PyType_WatchCallback callback)

Register `callback' as a type watcher. Return a non-negative integer ID
which must be passed to future calls to @ref{609,,PyType_Watch()}. In case of
error (e.g. no more watcher IDs available), return @code{-1} and set an
exception.


Added in version 3.12.

@end deffn

@geindex PyType_ClearWatcher (C function)
@anchor{c-api/type c PyType_ClearWatcher}@anchor{4b1e}
@deffn {C Función} int PyType_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' (previously returned from
@ref{608,,PyType_AddWatcher()}). Return @code{0} on success, @code{-1} on error (e.g.
if `watcher_id' was never registered.)

An extension should never call @code{PyType_ClearWatcher} with a `watcher_id'
that was not returned to it by a previous call to
@ref{608,,PyType_AddWatcher()}.


Added in version 3.12.

@end deffn

@geindex PyType_Watch (C function)
@anchor{c-api/type c PyType_Watch}@anchor{609}
@deffn {C Función} int PyType_Watch (int watcher_id, PyObject *type)

Mark `type' as watched. The callback granted `watcher_id' by
@ref{608,,PyType_AddWatcher()} will be called whenever
@ref{17f9,,PyType_Modified()} reports a change to `type'. (The callback may be
called only once for a series of consecutive modifications to `type', if
@code{_PyType_Lookup()} is not called on `type' between the modifications;
this is an implementation detail and subject to change.)

An extension should never call @code{PyType_Watch} with a `watcher_id' that was
not returned to it by a previous call to @ref{608,,PyType_AddWatcher()}.


Added in version 3.12.

@end deffn

@geindex PyType_WatchCallback (C type)
@anchor{c-api/type c PyType_WatchCallback}@anchor{4b1f}
@deffn {C Tipo} typedef int (*PyType_WatchCallback)(@ref{42d,,PyObject} *type)

Type of a type-watcher callback function.

The callback must not modify `type' or cause @ref{17f9,,PyType_Modified()} to be
called on `type' or any type in its MRO; violating this rule could cause
infinite recursion.


Added in version 3.12.

@end deffn

@geindex PyType_HasFeature (C function)
@anchor{c-api/type c PyType_HasFeature}@anchor{195d}
@deffn {C Función} int PyType_HasFeature (PyTypeObject *o, int feature)

Retorna un valor distinto de cero si el tipo objeto `o' establece la característica `feature'. Las características de tipo se indican mediante flags de un solo bit.
@end deffn

@geindex PyType_IS_GC (C function)
@anchor{c-api/type c PyType_IS_GC}@anchor{4b20}
@deffn {C Función} int PyType_IS_GC (PyTypeObject *o)

Return true if the type object includes support for the cycle detector; this
tests the type flag @ref{817,,Py_TPFLAGS_HAVE_GC}.
@end deffn

@geindex PyType_IsSubtype (C function)
@anchor{c-api/type c PyType_IsSubtype}@anchor{49cd}
@deffn {C Función} int PyType_IsSubtype (PyTypeObject *a, PyTypeObject *b)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna verdadero si `a' es un subtipo de `b'.

This function only checks for actual subtypes, which means that
@ref{1f7d,,__subclasscheck__()} is not called on `b'.  Call
@ref{f28,,PyObject_IsSubclass()} to do the same check that @ref{85a,,issubclass()}
would do.
@end deffn

@geindex PyType_GenericAlloc (C function)
@anchor{c-api/type c PyType_GenericAlloc}@anchor{afb}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GenericAlloc (PyTypeObject *type, Py_ssize_t nitems)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Controlador genérico para la ranura @ref{4861,,tp_alloc} de un objeto tipo. Usa el mecanismo de asignación de memoria predeterminado de Python para asignar una nueva instancia e inicializar todo su contenido a @code{NULL}.
@end deffn

@geindex PyType_GenericNew (C function)
@anchor{c-api/type c PyType_GenericNew}@anchor{485c}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GenericNew (PyTypeObject *type, PyObject *args, PyObject *kwds)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Controlador genérico para la ranura @ref{623,,tp_new} de un objeto tipo. Crea una nueva instancia utilizando la ranura del tipo @ref{4861,,tp_alloc}.
@end deffn

@geindex PyType_Ready (C function)
@anchor{c-api/type c PyType_Ready}@anchor{816}
@deffn {C Función} int PyType_Ready (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI}.'
Finalizar un objeto tipo. Se debe llamar a todos los objetos tipo para finalizar su inicialización. Esta función es responsable de agregar ranuras heredadas de la clase base de un tipo. Retorna @code{0} en caso de éxito o retorna @code{-1} y establece una excepción en caso de error.

@cartouche
@quotation Nota 
If some of the base classes implements the GC protocol and the provided
type does not include the @ref{817,,Py_TPFLAGS_HAVE_GC} in its flags, then
the GC protocol will be automatically implemented from its parents. On
the contrary, if the type being created does include
@ref{817,,Py_TPFLAGS_HAVE_GC} in its flags then it `must' implement the
GC protocol itself by at least implementing the
@ref{818,,tp_traverse} handle.
@end quotation
@end cartouche
@end deffn

@geindex PyType_GetName (C function)
@anchor{c-api/type c PyType_GetName}@anchor{7ec}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetName (PyTypeObject *type)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Return the type’s name. Equivalent to getting the type’s
@ref{14e7,,__name__} attribute.


Added in version 3.11.

@end deffn

@geindex PyType_GetQualName (C function)
@anchor{c-api/type c PyType_GetQualName}@anchor{7ed}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetQualName (PyTypeObject *type)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Return the type’s qualified name. Equivalent to getting the
type’s @ref{1f25,,__qualname__} attribute.


Added in version 3.11.

@end deffn

@geindex PyType_GetFullyQualifiedName (C function)
@anchor{c-api/type c PyType_GetFullyQualifiedName}@anchor{467}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetFullyQualifiedName (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return the type’s fully qualified name. Equivalent to
@code{f"@{type.__module__@}.@{type.__qualname__@}"}, or @ref{1f25,,type.__qualname__}
if @ref{468,,type.__module__} is not a string or is equal to @code{"builtins"}.


Added in version 3.13.

@end deffn

@geindex PyType_GetModuleName (C function)
@anchor{c-api/type c PyType_GetModuleName}@anchor{469}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetModuleName (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return the type’s module name. Equivalent to getting the
@ref{468,,type.__module__} attribute.


Added in version 3.13.

@end deffn

@geindex PyType_GetSlot (C function)
@anchor{c-api/type c PyType_GetSlot}@anchor{934}
@deffn {C Función} void *PyType_GetSlot (PyTypeObject *type, int slot)
` Part of the @ref{5f6,,Stable ABI} since version 3.4.'
Retorna el puntero de función almacenado en la ranura dada. Si el resultado es @code{NULL}, esto indica que la ranura es @code{NULL} o que la función se llamó con parámetros no válidos. Las personas que llaman suelen convertir el puntero de resultado en el tipo de función apropiado.

Consulte @ref{4b21,,PyType_Slot.slot} para conocer los posibles valores del argumento `slot'.


Added in version 3.4.



Distinto en la versión 3.10: @ref{934,,PyType_GetSlot()} ahora puede aceptar todos los tipos. Anteriormente, estaba limitado a @ref{9f8,,heap types}.

@end deffn

@geindex PyType_GetModule (C function)
@anchor{c-api/type c PyType_GetModule}@anchor{a00}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetModule (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Retorna el objeto módulo asociado con el tipo dado cuando se creó el tipo usando @ref{5f4,,PyType_FromModuleAndSpec()}.

Si no hay ningún módulo asociado con el tipo dado, establece @ref{228,,TypeError} y retorna @code{NULL}.

This function is usually used to get the module in which a method is defined.
Note that in such a method, @code{PyType_GetModule(Py_TYPE(self))}
may not return the intended result.
@code{Py_TYPE(self)} may be a `subclass' of the intended class, and subclasses
are not necessarily defined in the same module as their superclass.
See @ref{7fe,,PyCMethod} to get the class that defines the method.
See @ref{486,,PyType_GetModuleByDef()} for cases when @code{PyCMethod} cannot
be used.


Added in version 3.9.

@end deffn

@geindex PyType_GetModuleState (C function)
@anchor{c-api/type c PyType_GetModuleState}@anchor{a01}
@deffn {C Función} void *PyType_GetModuleState (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Retorna el estado del objeto de módulo asociado con el tipo dado. Este es un atajo para llamar @ref{a12,,PyModule_GetState()} en el resultado de @ref{a00,,PyType_GetModule()}.

Si no hay ningún módulo asociado con el tipo dado, establece @ref{228,,TypeError} y retorna @code{NULL}.

Si el tipo `type' tiene un módulo asociado pero su estado es @code{NULL}, retorna @code{NULL} sin establecer una excepción.


Added in version 3.9.

@end deffn

@geindex PyType_GetModuleByDef (C function)
@anchor{c-api/type c PyType_GetModuleByDef}@anchor{486}
@deffn {C Función} @ref{42d,,PyObject} *PyType_GetModuleByDef (PyTypeObject *type, struct PyModuleDef *def)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Encuentra la primer superclase cuyo módulo fue creado a partir del @ref{a0f,,PyModuleDef} `def' dado, y retorna ese módulo.

Si no se encuentra ningún módulo, lanza @ref{228,,TypeError} y retorna @code{NULL}.

Esta función está pensada para ser utilizada junto con @ref{a12,,PyModule_GetState()} para obtener el estado del módulo de los métodos de ranura (como @ref{625,,tp_init} o @ref{4b22,,nb_add}) y en otros lugares donde la clase que define a un método no se puede pasar utilizando la convención de llamada @ref{7fe,,PyCMethod}.


Added in version 3.11.

@end deffn

@geindex PyType_GetBaseByToken (C function)
@anchor{c-api/type c PyType_GetBaseByToken}@anchor{268}
@deffn {C Función} int PyType_GetBaseByToken (PyTypeObject *type, void *token, PyTypeObject **result)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Find the first superclass in `type'’s @ref{2188,,method resolution order} whose
@ref{269,,Py_tp_token} token is equal to the given one.


@itemize *

@item 
If found, set `*result' to a new @ref{431,,strong reference}
to it and return @code{1}.

@item 
If not found, set `*result' to @code{NULL} and return @code{0}.

@item 
On error, set `*result' to @code{NULL} and return @code{-1} with an
exception set.
@end itemize

The `result' argument may be @code{NULL}, in which case `*result' is not set.
Use this if you need only the return value.

The `token' argument may not be @code{NULL}.


Added in version 3.14.

@end deffn

@geindex PyUnstable_Type_AssignVersionTag (C function)
@anchor{c-api/type c PyUnstable_Type_AssignVersionTag}@anchor{4b23}
@deffn {C Función} int PyUnstable_Type_AssignVersionTag (PyTypeObject *type)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Attempt to assign a version tag to the given type.

Returns 1 if the type already had a valid version tag or a new one was
assigned, or 0 if a new tag could not be assigned.


Added in version 3.12.

@end deffn

@menu
* Crear tipos asignados en montículo (heap): Crear tipos asignados en montículo heap. 

@end menu

@node Crear tipos asignados en montículo heap,,,Objetos tipo
@anchor{c-api/type creating-heap-allocated-types}@anchor{4b24}
@subsubsection Crear tipos asignados en montículo (`heap')


Las siguientes funciones y estructuras se utilizan para crear @ref{9f8,,heap types}.

@geindex PyType_FromMetaclass (C function)
@anchor{c-api/type c PyType_FromMetaclass}@anchor{5f3}
@deffn {C Función} @ref{42d,,PyObject} *PyType_FromMetaclass (PyTypeObject *metaclass, PyObject *module, PyType_Spec *spec, PyObject *bases)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
Create and return a @ref{9f8,,heap type} from the `spec'
(see @ref{946,,Py_TPFLAGS_HEAPTYPE}).

The metaclass `metaclass' is used to construct the resulting type object.
When `metaclass' is @code{NULL}, the metaclass is derived from `bases'
(or `Py_tp_base[s]' slots if `bases' is @code{NULL}, see below).

Metaclasses that override @ref{623,,tp_new} are not
supported, except if @code{tp_new} is @code{NULL}.
(For backwards compatibility, other @code{PyType_From*} functions allow
such metaclasses. They ignore @code{tp_new}, which may result in incomplete
initialization. This is deprecated and in Python 3.14+ such metaclasses will
not be supported.)

El argumento `bases' se puede utilizar para especificar clases base; puede ser solo una clase o una tupla de clases. Si `bases' es @code{NULL}, en su lugar se utiliza la ranura `Py_tp_bases'. Si esa también es @code{NULL}, se usa la ranura `Py_tp_base' en su lugar. Si también es @code{NULL}, el nuevo tipo se deriva de @ref{b18,,object}.

El argumento `module' se puede utilizar para registrar el módulo en el que se define la nueva clase. Debe ser un objeto de módulo o @code{NULL}. Si no es @code{NULL}, el módulo se asocia con el nuevo tipo y luego se puede recuperar con @ref{a00,,PyType_GetModule()}. El módulo asociado no es heredado por subclases; debe especificarse para cada clase individualmente.

Esta función llama @ref{816,,PyType_Ready()} en el tipo nuevo.

Note that this function does `not' fully match the behavior of
calling @ref{dcf,,type()} or using the @ref{133f,,class} statement.
With user-provided base types or metaclasses, prefer
@ref{4acb,,calling} @ref{dcf,,type} (or the metaclass)
over @code{PyType_From*} functions.
Specifically:


@itemize *

@item 
@ref{624,,__new__()} is not called on the new class
(and it must be set to @code{type.__new__}).

@item 
@ref{751,,__init__()} is not called on the new class.

@item 
@ref{6d2,,__init_subclass__()} is not called on any bases.

@item 
@ref{cd6,,__set_name__()} is not called on new descriptors.
@end itemize


Added in version 3.12.

@end deffn

@geindex PyType_FromModuleAndSpec (C function)
@anchor{c-api/type c PyType_FromModuleAndSpec}@anchor{5f4}
@deffn {C Función} @ref{42d,,PyObject} *PyType_FromModuleAndSpec (PyObject *module, PyType_Spec *spec, PyObject *bases)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Equivalent to @code{PyType_FromMetaclass(NULL, module, spec, bases)}.


Added in version 3.9.



Distinto en la versión 3.10: La función ahora acepta una sola clase como argumento `bases' y @code{NULL} como ranura @code{tp_doc}.



Distinto en la versión 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes.  Previously, only @ref{dcf,,type} instances were returned.

The @ref{623,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{623,,tp_new} is deprecated.



Distinto en la versión 3.14: Creating classes whose metaclass overrides
@ref{623,,tp_new} is no longer allowed.

@end deffn

@geindex PyType_FromSpecWithBases (C function)
@anchor{c-api/type c PyType_FromSpecWithBases}@anchor{622}
@deffn {C Función} @ref{42d,,PyObject} *PyType_FromSpecWithBases (PyType_Spec *spec, PyObject *bases)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.3.'
Equivalent to @code{PyType_FromMetaclass(NULL, NULL, spec, bases)}.


Added in version 3.3.



Distinto en la versión 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes.  Previously, only @ref{dcf,,type} instances were returned.

The @ref{623,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{623,,tp_new} is deprecated.



Distinto en la versión 3.14: Creating classes whose metaclass overrides
@ref{623,,tp_new} is no longer allowed.

@end deffn

@geindex PyType_FromSpec (C function)
@anchor{c-api/type c PyType_FromSpec}@anchor{621}
@deffn {C Función} @ref{42d,,PyObject} *PyType_FromSpec (PyType_Spec *spec)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Equivalent to @code{PyType_FromMetaclass(NULL, NULL, spec, NULL)}.


Distinto en la versión 3.12: The function now finds and uses a metaclass corresponding to the
base classes provided in `Py_tp_base[s]' slots.
Previously, only @ref{dcf,,type} instances were returned.

The @ref{623,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{623,,tp_new} is deprecated.



Distinto en la versión 3.14: Creating classes whose metaclass overrides
@ref{623,,tp_new} is no longer allowed.

@end deffn

@geindex PyType_Freeze (C function)
@anchor{c-api/type c PyType_Freeze}@anchor{26b}
@deffn {C Función} int PyType_Freeze (PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Make a type immutable: set the @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} flag.

All base classes of `type' must be immutable.

On success, return @code{0}.
On error, set an exception and return @code{-1}.

The type must not be used before it’s made immutable. For example, type
instances must not be created before the type is made immutable.


Added in version 3.14.

@end deffn

@geindex PyType_Spec (C type)
@anchor{c-api/type c PyType_Spec}@anchor{1721}
@deffn {C Tipo} type PyType_Spec
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Estructura que define el comportamiento de un tipo.

@geindex PyType_Spec.name (C member)
@anchor{c-api/type c PyType_Spec name}@anchor{4b25}
@deffn {C Miembro} const char *name

Nombre del tipo, utilizado para establecer @ref{18fb,,PyTypeObject.tp_name}.
@end deffn

@geindex PyType_Spec.basicsize (C member)
@anchor{c-api/type c PyType_Spec basicsize}@anchor{5eb}
@deffn {C Miembro} int basicsize

If positive, specifies the size of the instance in bytes.
It is used to set @ref{a19,,PyTypeObject.tp_basicsize}.

If zero, specifies that @ref{a19,,tp_basicsize}
should be inherited.

If negative, the absolute value specifies how much space instances of the
class need `in addition' to the superclass.
Use @ref{5ec,,PyObject_GetTypeData()} to get a pointer to subclass-specific
memory reserved this way.


Distinto en la versión 3.12: Previously, this field could not be negative.

@end deffn

@geindex PyType_Spec.itemsize (C member)
@anchor{c-api/type c PyType_Spec itemsize}@anchor{4b26}
@deffn {C Miembro} int itemsize

Size of one element of a variable-size type, in bytes.
Used to set @ref{1f6f,,PyTypeObject.tp_itemsize}.
See @code{tp_itemsize} documentation for caveats.

If zero, @ref{1f6f,,tp_itemsize} is inherited.
Extending arbitrary variable-sized classes is dangerous,
since some types use a fixed offset for variable-sized memory,
which can then overlap fixed-sized memory used by a subclass.
To help prevent mistakes, inheriting @code{itemsize} is only possible
in the following situations:


@itemize -

@item 
The base is not variable-sized (its
@ref{1f6f,,tp_itemsize}).

@item 
The requested @ref{5eb,,PyType_Spec.basicsize} is positive,
suggesting that the memory layout of the base class is known.

@item 
The requested @ref{5eb,,PyType_Spec.basicsize} is zero,
suggesting that the subclass does not access the instance’s memory
directly.

@item 
With the @ref{5ee,,Py_TPFLAGS_ITEMS_AT_END} flag.
@end itemize
@end deffn

@geindex PyType_Spec.flags (C member)
@anchor{c-api/type c PyType_Spec flags}@anchor{4b27}
@deffn {C Miembro} unsigned int flags

Banderas (`flags') del tipo, que se usan para establecer @ref{18c6,,PyTypeObject.tp_flags}.

Si el indicador @code{Py_TPFLAGS_HEAPTYPE} no está establecido, @ref{622,,PyType_FromSpecWithBases()} lo establece automáticamente.
@end deffn

@geindex PyType_Spec.slots (C member)
@anchor{c-api/type c PyType_Spec slots}@anchor{4b28}
@deffn {C Miembro} @ref{49ce,,PyType_Slot} *slots

Arreglo de estructuras @ref{49ce,,PyType_Slot}. Terminado por el valor de ranura especial @code{@{0, NULL@}}.

Each slot ID should be specified at most once.
@end deffn
@end deffn

@geindex PyType_Slot (C type)
@anchor{c-api/type c PyType_Slot}@anchor{49ce}
@deffn {C Tipo} type PyType_Slot
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Estructura que define la funcionalidad opcional de un tipo, que contiene una ranura ID y un puntero de valor.

@geindex PyType_Slot.slot (C member)
@anchor{c-api/type c PyType_Slot slot}@anchor{4b21}
@deffn {C Miembro} int slot

@quotation

Una ranura ID.

Las ranuras IDs se nombran como los nombres de campo de las estructuras @ref{b30,,PyTypeObject}, @ref{145d,,PyNumberMethods}, @ref{4884,,PySequenceMethods}, @ref{4885,,PyMappingMethods} y @ref{4b29,,PyAsyncMethods} con un prefijo @code{Py_} agregado. Por ejemplo, use:


@itemize *

@item 
@code{Py_tp_dealloc} para establecer @ref{485f,,PyTypeObject.tp_dealloc}

@item 
@code{Py_nb_add} para establecer @ref{4b22,,PyNumberMethods.nb_add}

@item 
@code{Py_sq_length} para establecer @ref{4b2a,,PySequenceMethods.sq_length}
@end itemize

An additional slot is supported that does not correspond to a
@code{PyTypeObject} struct field:


@itemize *

@item 
@ref{269,,Py_tp_token}
@end itemize

The following “offset” fields cannot be set using @ref{49ce,,PyType_Slot}:

@quotation


@itemize *

@item 
@ref{a1a,,tp_weaklistoffset}
(use @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} instead if possible)

@item 
@ref{4b2b,,tp_dictoffset}
(use @ref{45f,,Py_TPFLAGS_MANAGED_DICT} instead if possible)

@item 
@ref{4acd,,tp_vectorcall_offset}
(use @code{"__vectorcalloffset__"} in
@ref{4b2c,,PyMemberDef})
@end itemize

If it is not possible to switch to a @code{MANAGED} flag (for example,
for vectorcall or to support Python older than 3.12), specify the
offset in @ref{4862,,Py_tp_members}.
See @ref{4b2c,,PyMemberDef documentation}
for details.
@end quotation

The following internal fields cannot be set at all when creating a heap
type:


@itemize *

@item 
@ref{1725,,tp_dict},
@ref{4b2d,,tp_mro},
@ref{4b2e,,tp_cache},
@ref{616,,tp_subclasses}, and
@ref{4b2f,,tp_weaklist}.
@end itemize

Setting @code{Py_tp_bases} or @code{Py_tp_base} may be
problematic on some platforms.
To avoid issues, use the `bases' argument of
@ref{622,,PyType_FromSpecWithBases()} instead.
@end quotation


Distinto en la versión 3.9: Las ranuras en @ref{4b30,,PyBufferProcs} se pueden configurar en la API ilimitada.



Distinto en la versión 3.11: @ref{7fc,,bf_getbuffer} and
@ref{7fd,,bf_releasebuffer} are now available
under the @ref{488,,limited API}.



Distinto en la versión 3.14: The field @ref{1620,,tp_vectorcall} can now set
using @code{Py_tp_vectorcall}.  See the field’s documentation
for details.

@end deffn

@geindex PyType_Slot.pfunc (C member)
@anchor{c-api/type c PyType_Slot pfunc}@anchor{4b31}
@deffn {C Miembro} void *pfunc

El valor deseado de la ranura. En la mayoría de los casos, este es un puntero a una función.

`pfunc' values may not be @code{NULL}, except for the following slots:


@itemize *

@item 
@code{Py_tp_doc}

@item 
@ref{269,,Py_tp_token} (for clarity, prefer @ref{4b32,,Py_TP_USE_SPEC}
rather than @code{NULL})
@end itemize
@end deffn
@end deffn

@geindex Py_tp_token (C macro)
@anchor{c-api/type c Py_tp_token}@anchor{269}
@deffn {C Macro} Py_tp_token

A @ref{4b21,,slot} that records a static memory layout ID
for a class.

If the @ref{1721,,PyType_Spec} of the class is statically
allocated, the token can be set to the spec using the special value
@ref{4b32,,Py_TP_USE_SPEC}:

@example
static PyType_Slot foo_slots[] = @{
   @{Py_tp_token, Py_TP_USE_SPEC@},
@end example

It can also be set to an arbitrary pointer, but you must ensure that:


@itemize *

@item 
The pointer outlives the class, so it’s not reused for something else
while the class exists.

@item 
It «belongs» to the extension module where the class lives, so it will not
clash with other extensions.
@end itemize

Use @ref{268,,PyType_GetBaseByToken()} to check if a class’s superclass has
a given token – that is, check whether the memory layout is compatible.

To get the token for a given class (without considering superclasses),
use @ref{934,,PyType_GetSlot()} with @code{Py_tp_token}.


Added in version 3.14.


@geindex Py_TP_USE_SPEC (C macro)
@anchor{c-api/type c Py_TP_USE_SPEC}@anchor{4b32}
@deffn {C Macro} Py_TP_USE_SPEC

Used as a value with @ref{269,,Py_tp_token} to set the token to the
class’s @ref{1721,,PyType_Spec}.
Expands to @code{NULL}.


Added in version 3.14.

@end deffn
@end deffn

@node El objeto None,,Objetos tipo,Objetos fundamentales
@anchor{c-api/none doc}@anchor{4b33}@anchor{c-api/none noneobject}@anchor{4b34}@anchor{c-api/none the-none-object}@anchor{4b35}
@subsubsection El objeto @code{None}


@geindex object;None

Note that the @ref{b30,,PyTypeObject} for @code{None} is not directly exposed in the
Python/C API.  Since @code{None} is a singleton, testing for object identity (using
@code{==} in C) is sufficient. There is no @code{PyNone_Check()} function for the
same reason.

@geindex Py_None (C var)
@anchor{c-api/none c Py_None}@anchor{4831}
@deffn {C Variable} @ref{42d,,PyObject} *Py_None

The Python @code{None} object, denoting lack of value.  This object has no methods
and is @ref{429d,,immortal}.


Distinto en la versión 3.12: @ref{4831,,Py_None} is @ref{429d,,immortal}.

@end deffn

@geindex Py_RETURN_NONE (C macro)
@anchor{c-api/none c Py_RETURN_NONE}@anchor{14b0}
@deffn {C Macro} Py_RETURN_NONE

Return @ref{4831,,Py_None} from a function.
@end deffn

@node Objetos numéricos,Objetos de secuencia,Objetos fundamentales,Capa de objetos concretos
@anchor{c-api/concrete numeric-objects}@anchor{4b36}@anchor{c-api/concrete numericobjects}@anchor{4b37}
@subsection Objetos numéricos


@geindex object;numeric

@menu
* Objetos enteros:: 
* Objetos booleanos:: 
* Floating-Point Objects:: 
* Objetos de números complejos:: 

@end menu

@node Objetos enteros,Objetos booleanos,,Objetos numéricos
@anchor{c-api/long doc}@anchor{4b38}@anchor{c-api/long integer-objects}@anchor{4b39}@anchor{c-api/long longobjects}@anchor{4b3a}
@subsubsection Objetos enteros


@geindex object;long integer
@geindex object;integer

Todos los enteros se implementan como objetos enteros «largos» (`long') de tamaño arbitrario.

En caso de error, la mayoría de las API @code{PyLong_As*} retornan @code{(tipo de retorno) -1} que no se puede distinguir de un número. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.

@geindex PyLongObject (C type)
@anchor{c-api/long c PyLongObject}@anchor{24b}
@deffn {C Tipo} type PyLongObject
` Part of the @ref{5f6,,Limited API} (as an opaque struct).'
Este subtipo de @ref{42d,,PyObject} representa un objeto entero de Python.
@end deffn

@geindex PyLong_Type (C var)
@anchor{c-api/long c PyLong_Type}@anchor{4959}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyLong_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo entero de Python. Este es el mismo objeto que @ref{1f0,,int} en la capa de Python.
@end deffn

@geindex PyLong_Check (C function)
@anchor{c-api/long c PyLong_Check}@anchor{4b3b}
@deffn {C Función} int PyLong_Check (PyObject *p)

Retorna verdadero si su argumento es un @ref{24b,,PyLongObject} o un subtipo de @ref{24b,,PyLongObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyLong_CheckExact (C function)
@anchor{c-api/long c PyLong_CheckExact}@anchor{4b3c}
@deffn {C Función} int PyLong_CheckExact (PyObject *p)

Retorna verdadero si su argumento es un @ref{24b,,PyLongObject}, pero no un subtipo de @ref{24b,,PyLongObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyLong_FromLong (C function)
@anchor{c-api/long c PyLong_FromLong}@anchor{1840}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromLong (long v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un objeto @ref{24b,,PyLongObject} nuevo desde `v', o @code{NULL} en caso de error.

The current implementation keeps an array of integer objects for all integers
between @code{-5} and @code{256}. When you create an int in that range you actually
just get back a reference to the existing object.
@end deffn

@geindex PyLong_FromUnsignedLong (C function)
@anchor{c-api/long c PyLong_FromUnsignedLong}@anchor{19ca}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromUnsignedLong (unsigned long v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new @ref{24b,,PyLongObject} object from a C unsigned long, or
@code{NULL} on failure.
@end deffn

@geindex PyLong_FromSsize_t (C function)
@anchor{c-api/long c PyLong_FromSsize_t}@anchor{4955}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromSsize_t (Py_ssize_t v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un objeto @ref{24b,,PyLongObject} nuevo desde un C @ref{af0,,Py_ssize_t}, o @code{NULL} en caso de error.
@end deffn

@geindex PyLong_FromSize_t (C function)
@anchor{c-api/long c PyLong_FromSize_t}@anchor{19cc}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromSize_t (size_t v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un objeto @ref{24b,,PyLongObject} nuevo desde un C @code{size_t}, o @code{NULL} en caso de error.
@end deffn

@geindex PyLong_FromLongLong (C function)
@anchor{c-api/long c PyLong_FromLongLong}@anchor{1841}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromLongLong (long long v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new @ref{24b,,PyLongObject} object from a C long long, or @code{NULL}
on failure.
@end deffn

@geindex PyLong_FromInt32 (C function)
@geindex PyLong_FromInt64 (C function)
@anchor{c-api/long c PyLong_FromInt32}@anchor{250}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromInt32 (int32_t value)
@anchor{c-api/long c PyLong_FromInt64}@anchor{251}
@deffnx {C Función} @ref{42d,,PyObject} *PyLong_FromInt64 (int64_t value)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Return a new @ref{24b,,PyLongObject} object from a signed C
int32_t or int64_t, or @code{NULL}
with an exception set on failure.


Added in version 3.14.

@end deffn

@geindex PyLong_FromUnsignedLongLong (C function)
@anchor{c-api/long c PyLong_FromUnsignedLongLong}@anchor{19cb}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromUnsignedLongLong (unsigned long long v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new @ref{24b,,PyLongObject} object from a C unsigned long long,
or @code{NULL} on failure.
@end deffn

@geindex PyLong_FromUInt32 (C function)
@geindex PyLong_FromUInt64 (C function)
@anchor{c-api/long c PyLong_FromUInt32}@anchor{252}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromUInt32 (uint32_t value)
@anchor{c-api/long c PyLong_FromUInt64}@anchor{253}
@deffnx {C Función} @ref{42d,,PyObject} *PyLong_FromUInt64 (uint64_t value)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Return a new @ref{24b,,PyLongObject} object from an unsigned C
uint32_t or uint64_t, or @code{NULL}
with an exception set on failure.


Added in version 3.14.

@end deffn

@geindex PyLong_FromDouble (C function)
@anchor{c-api/long c PyLong_FromDouble}@anchor{9d5}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromDouble (double v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo objeto @ref{24b,,PyLongObject} de la parte entera de `v', o @code{NULL} en caso de error.
@end deffn

@geindex PyLong_FromString (C function)
@anchor{c-api/long c PyLong_FromString}@anchor{4956}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromString (const char *str, char **pend, int base)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new @ref{24b,,PyLongObject} based on the string value in `str', which
is interpreted according to the radix in `base', or @code{NULL} on failure.  If
`pend' is non-@code{NULL}, `*pend' will point to the end of `str' on success or
to the first character that could not be processed on error.  If `base' is @code{0},
`str' is interpreted using the @ref{1ec5,,Literales enteros} definition; in this case, leading
zeros in a non-zero decimal number raises a @ref{360,,ValueError}.  If `base' is not
@code{0}, it must be between @code{2} and @code{36}, inclusive.  Leading and trailing
whitespace and single underscores after a base specifier and between digits are
ignored.  If there are no digits or `str' is not NULL-terminated following the
digits and trailing whitespace, @ref{360,,ValueError} will be raised.


@subsubheading Ver también


@ref{455,,PyLong_AsNativeBytes()} and
@ref{456,,PyLong_FromNativeBytes()} functions can be used to convert
a @ref{24b,,PyLongObject} to/from an array of bytes in base @code{256}.

@end deffn

@geindex PyLong_FromUnicodeObject (C function)
@anchor{c-api/long c PyLong_FromUnicodeObject}@anchor{951}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromUnicodeObject (PyObject *u, int base)
`Return value: New reference.'
Convierte una secuencia de dígitos Unicode en la cadena de caracteres `u' en un valor entero de Python.


Added in version 3.3.

@end deffn

@geindex PyLong_FromVoidPtr (C function)
@anchor{c-api/long c PyLong_FromVoidPtr}@anchor{4957}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromVoidPtr (void *p)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un entero de Python desde el puntero `p'. El valor del puntero se puede recuperar del valor resultante usando @ref{4954,,PyLong_AsVoidPtr()}.
@end deffn

@geindex PyLong_FromNativeBytes (C function)
@anchor{c-api/long c PyLong_FromNativeBytes}@anchor{456}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromNativeBytes (const void *buffer, size_t n_bytes, int flags)

Create a Python integer from the value contained in the first `n_bytes' of
`buffer', interpreted as a two’s-complement signed number.

`flags' are as for @ref{455,,PyLong_AsNativeBytes()}. Passing @code{-1} will select
the native endian that CPython was compiled with and assume that the
most-significant bit is a sign bit. Passing
@code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER} will produce the same result as calling
@ref{457,,PyLong_FromUnsignedNativeBytes()}. Other flags are ignored.


Added in version 3.13.

@end deffn

@geindex PyLong_FromUnsignedNativeBytes (C function)
@anchor{c-api/long c PyLong_FromUnsignedNativeBytes}@anchor{457}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_FromUnsignedNativeBytes (const void *buffer, size_t n_bytes, int flags)

Create a Python integer from the value contained in the first `n_bytes' of
`buffer', interpreted as an unsigned number.

`flags' are as for @ref{455,,PyLong_AsNativeBytes()}. Passing @code{-1} will select
the native endian that CPython was compiled with and assume that the
most-significant bit is not a sign bit. Flags other than endian are ignored.


Added in version 3.13.

@end deffn

@geindex PyLong_AsLong (C function)
@anchor{c-api/long c PyLong_AsLong}@anchor{454}
@deffn {C Función} long PyLong_AsLong (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex LONG_MAX (C macro)
@geindex OverflowError (built-in exception)

Return a C long representation of `obj'.  If `obj' is not an
instance of @ref{24b,,PyLongObject}, first call its @ref{22b,,__index__()} method
(if present) to convert it to a @ref{24b,,PyLongObject}.

Raise @ref{919,,OverflowError} if the value of `obj' is out of range for a
long.

Retorna @code{-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.


@geindex PyLong_AS_LONG (C function)
@anchor{c-api/long c PyLong_AS_LONG}@anchor{4b3d}
@deffn {C Función} long PyLong_AS_LONG (PyObject *obj)

A @ref{1c4,,soft deprecated} alias.
Exactly equivalent to the preferred @code{PyLong_AsLong}. In particular,
it can fail with @ref{919,,OverflowError} or another exception.


Obsoleto desde la versión 3.14: The function is soft deprecated.

@end deffn
@end deffn

@geindex PyLong_AsInt (C function)
@anchor{c-api/long c PyLong_AsInt}@anchor{453}
@deffn {C Función} int PyLong_AsInt (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{454,,PyLong_AsLong()}, but store the result in a C
int instead of a C long.


Added in version 3.13.

@end deffn

@geindex PyLong_AsLongAndOverflow (C function)
@anchor{c-api/long c PyLong_AsLongAndOverflow}@anchor{12d4}
@deffn {C Función} long PyLong_AsLongAndOverflow (PyObject *obj, int *overflow)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C long representation of `obj'.  If `obj' is not an
instance of @ref{24b,,PyLongObject}, first call its @ref{22b,,__index__()}
method (if present) to convert it to a @ref{24b,,PyLongObject}.

If the value of `obj' is greater than @code{LONG_MAX} or less than
@code{LONG_MIN}, set `*overflow' to @code{1} or @code{-1}, respectively, and
return @code{-1}; otherwise, set `*overflow' to @code{0}.  If any other exception
occurs set `*overflow' to @code{0} and return @code{-1} as usual.

Retorna @code{-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.

@end deffn

@geindex PyLong_AsLongLong (C function)
@anchor{c-api/long c PyLong_AsLongLong}@anchor{494f}
@deffn {C Función} long long PyLong_AsLongLong (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex OverflowError (built-in exception)

Return a C long long representation of `obj'.  If `obj' is not an
instance of @ref{24b,,PyLongObject}, first call its @ref{22b,,__index__()} method
(if present) to convert it to a @ref{24b,,PyLongObject}.

Raise @ref{919,,OverflowError} if the value of `obj' is out of range for a
long long.

Retorna @code{-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.

@end deffn

@geindex PyLong_AsLongLongAndOverflow (C function)
@anchor{c-api/long c PyLong_AsLongLongAndOverflow}@anchor{12d3}
@deffn {C Función} long long PyLong_AsLongLongAndOverflow (PyObject *obj, int *overflow)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C long long representation of `obj'.  If `obj' is not an
instance of @ref{24b,,PyLongObject}, first call its @ref{22b,,__index__()} method
(if present) to convert it to a @ref{24b,,PyLongObject}.

If the value of `obj' is greater than @code{LLONG_MAX} or less than
@code{LLONG_MIN}, set `*overflow' to @code{1} or @code{-1}, respectively,
and return @code{-1}; otherwise, set `*overflow' to @code{0}.  If any other
exception occurs set `*overflow' to @code{0} and return @code{-1} as usual.

Retorna @code{-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Added in version 3.2.



Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.

@end deffn

@geindex PyLong_AsSsize_t (C function)
@anchor{c-api/long c PyLong_AsSsize_t}@anchor{4951}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyLong_AsSsize_t (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex PY_SSIZE_T_MAX (C macro)
@geindex OverflowError (built-in exception)

Retorna una representación de C @ref{af0,,Py_ssize_t} de `pylong'. `pylong' debe ser una instancia de @ref{24b,,PyLongObject}.

Lanza @ref{919,,OverflowError} si el valor de `pylong' está fuera de rango para un @ref{af0,,Py_ssize_t}.

Retorna @code{-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsUnsignedLong (C function)
@anchor{c-api/long c PyLong_AsUnsignedLong}@anchor{4952}
@deffn {C Función} unsigned long PyLong_AsUnsignedLong (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex ULONG_MAX (C macro)
@geindex OverflowError (built-in exception)

Return a C unsigned long representation of `pylong'.  `pylong'
must be an instance of @ref{24b,,PyLongObject}.

Raise @ref{919,,OverflowError} if the value of `pylong' is out of range for a
unsigned long.

Retorna @code{(unsigned long)-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsSize_t (C function)
@anchor{c-api/long c PyLong_AsSize_t}@anchor{4950}
@deffn {C Función} size_t PyLong_AsSize_t (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex SIZE_MAX (C macro)
@geindex OverflowError (built-in exception)

Retorna una representación de C @code{size_t} de `pylong'. `pylong' debe ser una instancia de @ref{24b,,PyLongObject}.

Lanza @ref{919,,OverflowError} si el valor de `pylong' está fuera de rango para un @code{size_t}.

Retorna @code{(size_t) -1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsUnsignedLongLong (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongLong}@anchor{1301}
@deffn {C Función} unsigned long long PyLong_AsUnsignedLongLong (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex OverflowError (built-in exception)

Return a C unsigned long long representation of `pylong'.  `pylong'
must be an instance of @ref{24b,,PyLongObject}.

Raise @ref{919,,OverflowError} if the value of `pylong' is out of range for an
unsigned long long.

Retorna @code{(unsigned long long) -1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.1: Ahora un `pylong' negativo lanza un @ref{919,,OverflowError}, no @ref{228,,TypeError}.

@end deffn

@geindex PyLong_AsUnsignedLongMask (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongMask}@anchor{4953}
@deffn {C Función} unsigned long PyLong_AsUnsignedLongMask (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C unsigned long representation of `obj'.  If `obj' is not
an instance of @ref{24b,,PyLongObject}, first call its @ref{22b,,__index__()}
method (if present) to convert it to a @ref{24b,,PyLongObject}.

If the value of `obj' is out of range for an unsigned long,
return the reduction of that value modulo @code{ULONG_MAX + 1}.

Retorna @code{(unsigned long)-1} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.

@end deffn

@geindex PyLong_AsUnsignedLongLongMask (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongLongMask}@anchor{19ef}
@deffn {C Función} unsigned long long PyLong_AsUnsignedLongLongMask (PyObject *obj)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C unsigned long long representation of `obj'.  If `obj'
is not an instance of @ref{24b,,PyLongObject}, first call its
@ref{22b,,__index__()} method (if present) to convert it to a
@ref{24b,,PyLongObject}.

If the value of `obj' is out of range for an unsigned long long,
return the reduction of that value modulo @code{ULLONG_MAX + 1}.

Retorna @code{(unsigned long long) -1} por error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.



Distinto en la versión 3.10: This function will no longer use @ref{22a,,__int__()}.

@end deffn

@geindex PyLong_AsInt32 (C function)
@geindex PyLong_AsInt64 (C function)
@anchor{c-api/long c PyLong_AsInt32}@anchor{24c}
@deffn {C Función} int PyLong_AsInt32 (PyObject *obj, int32_t *value)
@anchor{c-api/long c PyLong_AsInt64}@anchor{24d}
@deffnx {C Función} int PyLong_AsInt64 (PyObject *obj, int64_t *value)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Set `*value' to a signed C int32_t or int64_t
representation of `obj'.

If the `obj' value is out of range, raise an @ref{919,,OverflowError}.

Set `*value' and return @code{0} on success.
Set an exception and return @code{-1} on error.

`value' must not be @code{NULL}.


Added in version 3.14.

@end deffn

@geindex PyLong_AsUInt32 (C function)
@geindex PyLong_AsUInt64 (C function)
@anchor{c-api/long c PyLong_AsUInt32}@anchor{24e}
@deffn {C Función} int PyLong_AsUInt32 (PyObject *obj, uint32_t *value)
@anchor{c-api/long c PyLong_AsUInt64}@anchor{24f}
@deffnx {C Función} int PyLong_AsUInt64 (PyObject *obj, uint64_t *value)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Set `*value' to an unsigned C uint32_t or uint64_t
representation of `obj'.

If `obj' is not an instance of @ref{24b,,PyLongObject}, first call its
@ref{22b,,__index__()} method (if present) to convert it to a
@ref{24b,,PyLongObject}.


@itemize *

@item 
If `obj' is negative, raise a @ref{360,,ValueError}.

@item 
If the `obj' value is out of range, raise an @ref{919,,OverflowError}.
@end itemize

Set `*value' and return @code{0} on success.
Set an exception and return @code{-1} on error.

`value' must not be @code{NULL}.


Added in version 3.14.

@end deffn

@geindex PyLong_AsDouble (C function)
@anchor{c-api/long c PyLong_AsDouble}@anchor{1613}
@deffn {C Función} double PyLong_AsDouble (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C double representation of `pylong'.  `pylong' must be
an instance of @ref{24b,,PyLongObject}.

Raise @ref{919,,OverflowError} if the value of `pylong' is out of range for a
double.

Retorna @code{-1.0} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsVoidPtr (C function)
@anchor{c-api/long c PyLong_AsVoidPtr}@anchor{4954}
@deffn {C Función} void *PyLong_AsVoidPtr (PyObject *pylong)
` Part of the @ref{5f6,,Stable ABI}.'
Convert a Python integer `pylong' to a C void pointer.
If `pylong' cannot be converted, an @ref{919,,OverflowError} will be raised.  This
is only assured to produce a usable void pointer for values created
with @ref{4957,,PyLong_FromVoidPtr()}.

Retorna @code{NULL} en caso de error. Use @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsNativeBytes (C function)
@anchor{c-api/long c PyLong_AsNativeBytes}@anchor{455}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyLong_AsNativeBytes (PyObject *pylong, void *buffer, Py_ssize_t n_bytes, int flags)

Copy the Python integer value `pylong' to a native `buffer' of size
`n_bytes'. The `flags' can be set to @code{-1} to behave similarly to a C cast,
or to values documented below to control the behavior.

Returns @code{-1} with an exception raised on error.  This may happen if
`pylong' cannot be interpreted as an integer, or if `pylong' was negative
and the @code{Py_ASNATIVEBYTES_REJECT_NEGATIVE} flag was set.

Otherwise, returns the number of bytes required to store the value.
If this is equal to or less than `n_bytes', the entire value was copied.
All `n_bytes' of the buffer are written: large buffers are padded with
zeroes.

If the returned value is greater than than `n_bytes', the value was
truncated: as many of the lowest bits of the value as could fit are written,
and the higher bits are ignored. This matches the typical behavior
of a C-style downcast.

@cartouche
@quotation Nota 
Overflow is not considered an error. If the returned value
is larger than `n_bytes', most significant bits were discarded.
@end quotation
@end cartouche

@code{0} will never be returned.

Values are always copied as two’s-complement.

Usage example:

@example
int32_t value;
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, &value, sizeof(value), -1);
if (bytes < 0) @{
    // Failed. A Python exception was set with the reason.
    return NULL;
@}
else if (bytes <= (Py_ssize_t)sizeof(value)) @{
    // Success!
@}
else @{
    // Overflow occurred, but 'value' contains the truncated
    // lowest bits of pylong.
@}
@end example

Passing zero to `n_bytes' will return the size of a buffer that would
be large enough to hold the value. This may be larger than technically
necessary, but not unreasonably so. If `n_bytes=0', `buffer' may be
@code{NULL}.

@cartouche
@quotation Nota 
Passing `n_bytes=0' to this function is not an accurate way to determine
the bit length of the value.
@end quotation
@end cartouche

To get at the entire Python value of an unknown size, the function can be
called twice: first to determine the buffer size, then to fill it:

@example
// Ask how much space we need.
Py_ssize_t expected = PyLong_AsNativeBytes(pylong, NULL, 0, -1);
if (expected < 0) @{
    // Failed. A Python exception was set with the reason.
    return NULL;
@}
assert(expected != 0);  // Impossible per the API definition.
uint8_t *bignum = malloc(expected);
if (!bignum) @{
    PyErr_SetString(PyExc_MemoryError, "bignum malloc failed.");
    return NULL;
@}
// Safely get the entire value.
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, bignum, expected, -1);
if (bytes < 0) @{  // Exception has been set.
    free(bignum);
    return NULL;
@}
else if (bytes > expected) @{  // This should not be possible.
    PyErr_SetString(PyExc_RuntimeError,
        "Unexpected bignum truncation after a size check.");
    free(bignum);
    return NULL;
@}
// The expected success given the above pre-check.
// ... use bignum ...
free(bignum);
@end example

`flags' is either @code{-1} (@code{Py_ASNATIVEBYTES_DEFAULTS}) to select defaults
that behave most like a C cast, or a combination of the other flags in
the table below.
Note that @code{-1} cannot be combined with other flags.

Currently, @code{-1} corresponds to
@code{Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxx} 
@headitem

Flag

@tab

Value

@item

@geindex Py_ASNATIVEBYTES_DEFAULTS (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_DEFAULTS}@anchor{4b3e}
@deffn {C Macro} Py_ASNATIVEBYTES_DEFAULTS
@end deffn

@tab

@code{-1}

@item

@geindex Py_ASNATIVEBYTES_BIG_ENDIAN (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_BIG_ENDIAN}@anchor{4b3f}
@deffn {C Macro} Py_ASNATIVEBYTES_BIG_ENDIAN
@end deffn

@tab

@code{0}

@item

@geindex Py_ASNATIVEBYTES_LITTLE_ENDIAN (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_LITTLE_ENDIAN}@anchor{4b40}
@deffn {C Macro} Py_ASNATIVEBYTES_LITTLE_ENDIAN
@end deffn

@tab

@code{1}

@item

@geindex Py_ASNATIVEBYTES_NATIVE_ENDIAN (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_NATIVE_ENDIAN}@anchor{4b41}
@deffn {C Macro} Py_ASNATIVEBYTES_NATIVE_ENDIAN
@end deffn

@tab

@code{3}

@item

@geindex Py_ASNATIVEBYTES_UNSIGNED_BUFFER (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_UNSIGNED_BUFFER}@anchor{4b42}
@deffn {C Macro} Py_ASNATIVEBYTES_UNSIGNED_BUFFER
@end deffn

@tab

@code{4}

@item

@geindex Py_ASNATIVEBYTES_REJECT_NEGATIVE (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_REJECT_NEGATIVE}@anchor{4b43}
@deffn {C Macro} Py_ASNATIVEBYTES_REJECT_NEGATIVE
@end deffn

@tab

@code{8}

@item

@geindex Py_ASNATIVEBYTES_ALLOW_INDEX (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_ALLOW_INDEX}@anchor{4b44}
@deffn {C Macro} Py_ASNATIVEBYTES_ALLOW_INDEX
@end deffn

@tab

@code{16}

@end multitable


Specifying @code{Py_ASNATIVEBYTES_NATIVE_ENDIAN} will override any other endian
flags. Passing @code{2} is reserved.

By default, sufficient buffer will be requested to include a sign bit.
For example, when converting 128 with `n_bytes=1', the function will return
2 (or more) in order to store a zero sign bit.

If @code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER} is specified, a zero sign bit
will be omitted from size calculations. This allows, for example, 128 to fit
in a single-byte buffer. If the destination buffer is later treated as
signed, a positive input value may become negative.
Note that the flag does not affect handling of negative values: for those,
space for a sign bit is always requested.

Specifying @code{Py_ASNATIVEBYTES_REJECT_NEGATIVE} causes an exception to be set
if `pylong' is negative. Without this flag, negative values will be copied
provided there is enough space for at least one sign bit, regardless of
whether @code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER} was specified.

If @code{Py_ASNATIVEBYTES_ALLOW_INDEX} is specified and a non-integer value is
passed, its @ref{22b,,__index__()} method will be called first. This may
result in Python code executing and other threads being allowed to run, which
could cause changes to other objects or values in use. When `flags' is
@code{-1}, this option is not set, and non-integer values will raise
@ref{228,,TypeError}.

@cartouche
@quotation Nota 
With the default `flags' (@code{-1}, or `UNSIGNED_BUFFER'  without
`REJECT_NEGATIVE'), multiple Python integers can map to a single value
without overflow. For example, both @code{255} and @code{-1} fit a single-byte
buffer and set all its bits.
This matches typical C cast behavior.
@end quotation
@end cartouche


Added in version 3.13.

@end deffn

@geindex PyLong_GetSign (C function)
@anchor{c-api/long c PyLong_GetSign}@anchor{235}
@deffn {C Función} int PyLong_GetSign (PyObject *obj, int *sign)

Get the sign of the integer object `obj'.

On success, set `*sign' to the integer sign  (0, -1 or +1 for zero, negative or
positive integer, respectively) and return 0.

On failure, return -1 with an exception set.  This function always succeeds
if `obj' is a @ref{24b,,PyLongObject} or its subtype.


Added in version 3.14.

@end deffn

@geindex PyLong_IsPositive (C function)
@anchor{c-api/long c PyLong_IsPositive}@anchor{248}
@deffn {C Función} int PyLong_IsPositive (PyObject *obj)

Check if the integer object `obj' is positive (@code{obj > 0}).

If `obj' is an instance of @ref{24b,,PyLongObject} or its subtype,
return @code{1} when it’s positive and @code{0} otherwise.  Else set an
exception and return @code{-1}.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex PyLong_IsNegative (C function)
@anchor{c-api/long c PyLong_IsNegative}@anchor{249}
@deffn {C Función} int PyLong_IsNegative (PyObject *obj)

Check if the integer object `obj' is negative (@code{obj < 0}).

If `obj' is an instance of @ref{24b,,PyLongObject} or its subtype,
return @code{1} when it’s negative and @code{0} otherwise.  Else set an
exception and return @code{-1}.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex PyLong_IsZero (C function)
@anchor{c-api/long c PyLong_IsZero}@anchor{24a}
@deffn {C Función} int PyLong_IsZero (PyObject *obj)

Check if the integer object `obj' is zero.

If `obj' is an instance of @ref{24b,,PyLongObject} or its subtype,
return @code{1} when it’s zero and @code{0} otherwise.  Else set an
exception and return @code{-1}.


Added in version 3.14.0a1 (unreleased).

@end deffn

@geindex PyLong_GetInfo (C function)
@anchor{c-api/long c PyLong_GetInfo}@anchor{4958}
@deffn {C Función} @ref{42d,,PyObject} *PyLong_GetInfo (void)
` Part of the @ref{5f6,,Stable ABI}.'
On success, return a read only @ref{6ef,,named tuple}, that holds
information about Python’s internal representation of integers.
See @ref{1300,,sys.int_info} for description of individual fields.

On failure, return @code{NULL} with an exception set.


Added in version 3.1.

@end deffn

@geindex PyUnstable_Long_IsCompact (C function)
@anchor{c-api/long c PyUnstable_Long_IsCompact}@anchor{62c}
@deffn {C Función} int PyUnstable_Long_IsCompact (const PyLongObject *op)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return 1 if `op' is compact, 0 otherwise.

This function makes it possible for performance-critical code to implement
a “fast path” for small integers. For compact values use
@ref{62d,,PyUnstable_Long_CompactValue()}; for others fall back to a
@ref{4950,,PyLong_As*} function or
@ref{455,,PyLong_AsNativeBytes()}.

The speedup is expected to be negligible for most users.

Exactly what values are considered compact is an implementation detail
and is subject to change.


Added in version 3.12.

@end deffn

@geindex PyUnstable_Long_CompactValue (C function)
@anchor{c-api/long c PyUnstable_Long_CompactValue}@anchor{62d}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnstable_Long_CompactValue (const PyLongObject *op)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

If `op' is compact, as determined by @ref{62c,,PyUnstable_Long_IsCompact()},
return its value.

Otherwise, the return value is undefined.


Added in version 3.12.

@end deffn

@node Objetos booleanos,Floating-Point Objects,Objetos enteros,Objetos numéricos
@anchor{c-api/bool doc}@anchor{4b45}@anchor{c-api/bool boolean-objects}@anchor{4b46}@anchor{c-api/bool boolobjects}@anchor{4b47}
@subsubsection Objetos booleanos


Booleans in Python are implemented as a subclass of integers.  There are only
two booleans, @ref{4b48,,Py_False} and @ref{4b49,,Py_True}.  As such, the normal
creation and deletion functions don’t apply to booleans.  The following macros
are available, however.

@geindex PyBool_Type (C var)
@anchor{c-api/bool c PyBool_Type}@anchor{48dc}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyBool_Type
` Part of the @ref{5f6,,Stable ABI}.'
This instance of @ref{b30,,PyTypeObject} represents the Python boolean type; it
is the same object as @ref{513,,bool} in the Python layer.
@end deffn

@geindex PyBool_Check (C function)
@anchor{c-api/bool c PyBool_Check}@anchor{4b4a}
@deffn {C Función} int PyBool_Check (PyObject *o)

Retorna verdadero si `o' es de tipo @ref{48dc,,PyBool_Type}. Esta función siempre finaliza con éxito.
@end deffn

@geindex Py_False (C var)
@anchor{c-api/bool c Py_False}@anchor{4b48}
@deffn {C Variable} @ref{42d,,PyObject} *Py_False

The Python @code{False} object.  This object has no methods and is
@ref{429d,,immortal}.


Distinto en la versión 3.12: @ref{4b48,,Py_False} is @ref{429d,,immortal}.

@end deffn

@geindex Py_True (C var)
@anchor{c-api/bool c Py_True}@anchor{4b49}
@deffn {C Variable} @ref{42d,,PyObject} *Py_True

The Python @code{True} object.  This object has no methods and is
@ref{429d,,immortal}.


Distinto en la versión 3.12: @ref{4b49,,Py_True} is @ref{429d,,immortal}.

@end deffn

@geindex Py_RETURN_FALSE (C macro)
@anchor{c-api/bool c Py_RETURN_FALSE}@anchor{14b2}
@deffn {C Macro} Py_RETURN_FALSE

Return @ref{4b48,,Py_False} from a function.
@end deffn

@geindex Py_RETURN_TRUE (C macro)
@anchor{c-api/bool c Py_RETURN_TRUE}@anchor{14b1}
@deffn {C Macro} Py_RETURN_TRUE

Return @ref{4b49,,Py_True} from a function.
@end deffn

@geindex PyBool_FromLong (C function)
@anchor{c-api/bool c PyBool_FromLong}@anchor{48db}
@deffn {C Función} @ref{42d,,PyObject} *PyBool_FromLong (long v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return @ref{4b49,,Py_True} or @ref{4b48,,Py_False}, depending on the truth value of `v'.
@end deffn

@node Floating-Point Objects,Objetos de números complejos,Objetos booleanos,Objetos numéricos
@anchor{c-api/float doc}@anchor{4b4b}@anchor{c-api/float floating-point-objects}@anchor{4b4c}@anchor{c-api/float floatobjects}@anchor{4b4d}
@subsubsection Floating-Point Objects


@geindex object;floating-point

@geindex PyFloatObject (C type)
@anchor{c-api/float c PyFloatObject}@anchor{4b4e}
@deffn {C Tipo} type PyFloatObject

This subtype of @ref{42d,,PyObject} represents a Python floating-point object.
@end deffn

@geindex PyFloat_Type (C var)
@anchor{c-api/float c PyFloat_Type}@anchor{4938}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyFloat_Type
` Part of the @ref{5f6,,Stable ABI}.'
This instance of @ref{b30,,PyTypeObject} represents the Python floating-point
type.  This is the same object as @ref{153,,float} in the Python layer.
@end deffn

@geindex PyFloat_Check (C function)
@anchor{c-api/float c PyFloat_Check}@anchor{4b4f}
@deffn {C Función} int PyFloat_Check (PyObject *p)

Retorna verdadero si su argumento es un @ref{4b4e,,PyFloatObject} o un subtipo de @ref{4b4e,,PyFloatObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyFloat_CheckExact (C function)
@anchor{c-api/float c PyFloat_CheckExact}@anchor{4b50}
@deffn {C Función} int PyFloat_CheckExact (PyObject *p)

Retorna verdadero si su argumento es un @ref{4b4e,,PyFloatObject}, pero no un subtipo de @ref{4b4e,,PyFloatObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyFloat_FromString (C function)
@anchor{c-api/float c PyFloat_FromString}@anchor{4937}
@deffn {C Función} @ref{42d,,PyObject} *PyFloat_FromString (PyObject *str)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto @ref{4b4e,,PyFloatObject} basado en la cadena de caracteres en `str', o @code{NULL} en caso de error.
@end deffn

@geindex PyFloat_FromDouble (C function)
@anchor{c-api/float c PyFloat_FromDouble}@anchor{4936}
@deffn {C Función} @ref{42d,,PyObject} *PyFloat_FromDouble (double v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto @ref{4b4e,,PyFloatObject} a partir de `v', o @code{NULL} en caso de error.
@end deffn

@geindex PyFloat_AsDouble (C function)
@anchor{c-api/float c PyFloat_AsDouble}@anchor{af9}
@deffn {C Función} double PyFloat_AsDouble (PyObject *pyfloat)
` Part of the @ref{5f6,,Stable ABI}.'
Return a C double representation of the contents of `pyfloat'.  If
`pyfloat' is not a Python floating-point object but has a @ref{a5e,,__float__()}
method, this method will first be called to convert `pyfloat' into a float.
If @code{__float__()} is not defined then it falls back to @ref{22b,,__index__()}.
This method returns @code{-1.0} upon failure, so one should call
@ref{18fa,,PyErr_Occurred()} to check for errors.


Distinto en la versión 3.8: Utilice @ref{22b,,__index__()} si está disponible.

@end deffn

@geindex PyFloat_AS_DOUBLE (C function)
@anchor{c-api/float c PyFloat_AS_DOUBLE}@anchor{4b51}
@deffn {C Función} double PyFloat_AS_DOUBLE (PyObject *pyfloat)

Retorna una representación C double de los contenidos de `pyfloat', pero sin verificación de errores.
@end deffn

@geindex PyFloat_GetInfo (C function)
@anchor{c-api/float c PyFloat_GetInfo}@anchor{1430}
@deffn {C Función} @ref{42d,,PyObject} *PyFloat_GetInfo (void)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna una instancia de `structseq' que contiene información sobre la precisión, los valores mínimos y máximos de un flotante. Es un contenedor reducido alrededor del archivo de encabezado @code{float.h}.
@end deffn

@geindex PyFloat_GetMax (C function)
@anchor{c-api/float c PyFloat_GetMax}@anchor{142e}
@deffn {C Función} double PyFloat_GetMax ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el máximo flotante finito representable `DBL_MAX' como C double.
@end deffn

@geindex PyFloat_GetMin (C function)
@anchor{c-api/float c PyFloat_GetMin}@anchor{142f}
@deffn {C Función} double PyFloat_GetMin ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el flotante positivo normalizado mínimo `DBL_MIN' como C double.
@end deffn

@menu
* Funciones de empaquetado y desempaquetado:: 

@end menu

@node Funciones de empaquetado y desempaquetado,,,Floating-Point Objects
@anchor{c-api/float pack-and-unpack-functions}@anchor{4b52}
@subsubsection Funciones de empaquetado y desempaquetado


Las funciones de empaquetar y desempaquetar proporcionan una manera eficiente e independiente de la plataforma para almacenar valores de coma flotante como cadenas de bytes. Las rutinas Pack producen una cadena de bytes a partir de un C double, y las rutinas Desempaquetar producen un C double a partir de dicha cadena de bytes. El sufijo (2, 4 u 8) especifica el número de bytes en la cadena de bytes.

En plataformas que parecen usar formatos IEEE 754, estas funciones actúan copiando los bits. En otras plataformas, el formato 2-byte es idéntico al formato de media precision IEEE 754 binary16, el formato de 4-byte (32 bits) es idéntico al formato de precisión simple binario IEEE 754 binary32, y el formato de 8-byte al formato de doble precisión binario IEEE 754 binary64, aunque el empaquetado de INFs y NaNs (si existen en la plataforma) no se maneja correctamente, mientras que intentar desempaquetar una cadena de bytes que contenga un IEEE INF o NaN generará una excepción.

En plataformas que no son IEEE con más precisión, o mayor rango dinámico, que el IEEE 754 admite, no se pueden empaquetar todos los valores; en plataformas que no son IEEE con menos precisión o con un rango dinámico más pequeño, no se pueden desempaquetar todos los valores. Lo que sucede en tales casos es en parte accidental (desafortunadamente).


Added in version 3.11.


@menu
* Funciones de Empaquetado:: 
* Funciones de Desempaquetado:: 

@end menu

@node Funciones de Empaquetado,Funciones de Desempaquetado,,Funciones de empaquetado y desempaquetado
@anchor{c-api/float pack-functions}@anchor{4b53}
@subsubsection Funciones de Empaquetado


Las rutinas de empaquetado escriben 2, 4 o 8 bytes, comenzando en `p'. `le' es un argumento int, distinto de cero si desea que la cadena de bytes esté en formato little-endian (exponente al final, en @code{p+1}, @code{p+3}, o @code{p+6} @code{p+7}), y cero si desea el formato big-endian (exponente primero, en `p'). La constante @code{PY_BIG_ENDIAN} se puede usar para emplear el endian nativo: es igual a @code{1} en el procesador big-endian, o @code{0} en el procesador little-endian.

Valor retornado: @code{0} si todo está bien, @code{-1} si hay error (y se establece una excepción, probablemente @ref{919,,OverflowError}).

Hay dos problemas en plataformas que no son IEEE:


@itemize *

@item 
Lo que esto hace es indefinido si `x' es un NaN o infinito.

@item 
@code{-0.0} and @code{+0.0} produce la misma cadena de bytes.
@end itemize

@geindex PyFloat_Pack2 (C function)
@anchor{c-api/float c PyFloat_Pack2}@anchor{7ff}
@deffn {C Función} int PyFloat_Pack2 (double x, unsigned char *p, int le)

Empaquete un C doble como el formato de media precisión IEEE 754 binary16.
@end deffn

@geindex PyFloat_Pack4 (C function)
@anchor{c-api/float c PyFloat_Pack4}@anchor{800}
@deffn {C Función} int PyFloat_Pack4 (double x, unsigned char *p, int le)

Empaque un C doble como el formato de precisión simple IEEE 754 binary32.
@end deffn

@geindex PyFloat_Pack8 (C function)
@anchor{c-api/float c PyFloat_Pack8}@anchor{801}
@deffn {C Función} int PyFloat_Pack8 (double x, unsigned char *p, int le)

Empaque un C doble como el formato de doble precisión IEEE 754 binary64.
@end deffn

@node Funciones de Desempaquetado,,Funciones de Empaquetado,Funciones de empaquetado y desempaquetado
@anchor{c-api/float unpack-functions}@anchor{4b54}
@subsubsection Funciones de Desempaquetado


Las rutinas de desempaquetado leen 2, 4 u 8 bytes, comenzando en `p'. `le' es un argumento int , distinto de cero si la cadena bytes está en formato little-endian (exponente al final, en @code{p+1}, @code{p+3} o @code{p+6} y @code{p+7}), cero si está en formato big-endian (exponente primero, en `p'). La constante @code{PY_BIG_ENDIAN} se puede usar para utilizar el endian nativo: es igual a @code{1} en un procesador big endian, o @code{0} en un procesador little-endian.

Valor retornado: Doble desempaquetado. Si hay error, @code{-1.0} y @ref{18fa,,PyErr_Occurred()} es verdadero (y se establece una excepción, probablemente @ref{919,,OverflowError}).

Hay que tener en cuenta que en una plataforma que no sea IEEE, esto se negará a desempaquetar una cadena de bytes que representa un NaN o infinito.

@geindex PyFloat_Unpack2 (C function)
@anchor{c-api/float c PyFloat_Unpack2}@anchor{802}
@deffn {C Función} double PyFloat_Unpack2 (const unsigned char *p, int le)

Descomprima el formato de media precisión IEEE 754 binary16 como un doble C.
@end deffn

@geindex PyFloat_Unpack4 (C function)
@anchor{c-api/float c PyFloat_Unpack4}@anchor{803}
@deffn {C Función} double PyFloat_Unpack4 (const unsigned char *p, int le)

Descomprima el formato de precisión simple IEEE 754 binary32 como un doble C.
@end deffn

@geindex PyFloat_Unpack8 (C function)
@anchor{c-api/float c PyFloat_Unpack8}@anchor{804}
@deffn {C Función} double PyFloat_Unpack8 (const unsigned char *p, int le)

Descomprima el formato de doble precisión IEEE 754 binary64 como un doble C.
@end deffn

@node Objetos de números complejos,,Floating-Point Objects,Objetos numéricos
@anchor{c-api/complex doc}@anchor{4b55}@anchor{c-api/complex complex-number-objects}@anchor{4b56}@anchor{c-api/complex complexobjects}@anchor{4b57}
@subsubsection Objetos de números complejos


@geindex object;complex number

Los objetos de números complejos de Python se implementan como dos tipos distintos cuando se ven desde la API de C: uno es el objeto de Python expuesto a los programas de Python, y el otro es una estructura en C que representa el valor de número complejo real. La API proporciona funciones para trabajar con ambos.

@menu
* Números complejos como estructuras C:: 
* Números complejos como objetos de Python:: 

@end menu

@node Números complejos como estructuras C,Números complejos como objetos de Python,,Objetos de números complejos
@anchor{c-api/complex complex-numbers-as-c-structures}@anchor{4b58}
@subsubsection Números complejos como estructuras C


Tenga en cuenta que las funciones que aceptan estas estructuras como parámetros y las retornan como resultados lo hacen `por valor' en lugar de desreferenciarlas a través de punteros. Esto es consistente en toda la API.

@geindex Py_complex (C type)
@anchor{c-api/complex c Py_complex}@anchor{4a8d}
@deffn {C Tipo} type Py_complex

The C structure which corresponds to the value portion of a Python complex
number object.  Most of the functions for dealing with complex number objects
use structures of this type as input or output values, as appropriate.

@geindex Py_complex.real (C member)
@geindex Py_complex.imag (C member)
@anchor{c-api/complex c Py_complex real}@anchor{4b59}
@deffn {C Miembro} double real
@anchor{c-api/complex c Py_complex imag}@anchor{4b5a}
@deffnx {C Miembro} double imag
@end deffn

The structure is defined as:

@example
typedef struct @{
    double real;
    double imag;
@} Py_complex;
@end example
@end deffn

@geindex _Py_c_sum (C function)
@anchor{c-api/complex c _Py_c_sum}@anchor{4b5b}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_sum (Py_complex left, Py_complex right)

Retorna la suma de dos números complejos, utilizando la representación C @ref{4a8d,,Py_complex}.
@end deffn

@geindex _Py_c_diff (C function)
@anchor{c-api/complex c _Py_c_diff}@anchor{4b5c}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_diff (Py_complex left, Py_complex right)

Retorna la diferencia entre dos números complejos, usando la representación C @ref{4a8d,,Py_complex}.
@end deffn

@geindex _Py_c_neg (C function)
@anchor{c-api/complex c _Py_c_neg}@anchor{4b5d}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_neg (Py_complex num)

Retorna la negación del número complejo `num', utilizando la representación C @ref{4a8d,,Py_complex}.
@end deffn

@geindex _Py_c_prod (C function)
@anchor{c-api/complex c _Py_c_prod}@anchor{4b5e}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_prod (Py_complex left, Py_complex right)

Retorna el producto de dos números complejos, usando la representación C @ref{4a8d,,Py_complex}.
@end deffn

@geindex _Py_c_quot (C function)
@anchor{c-api/complex c _Py_c_quot}@anchor{4b5f}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_quot (Py_complex dividend, Py_complex divisor)

Retorna el cociente de dos números complejos, utilizando la representación C @ref{4a8d,,Py_complex}.

If `divisor' is null, this method returns zero and sets
@code{errno} to @code{EDOM}.
@end deffn

@geindex _Py_c_pow (C function)
@anchor{c-api/complex c _Py_c_pow}@anchor{1627}
@deffn {C Función} @ref{4a8d,,Py_complex} _Py_c_pow (Py_complex num, Py_complex exp)

Retorna la exponenciación de `num' por `exp', utilizando la representación C @ref{4a8d,,Py_complex}.

If `num' is null and `exp' is not a positive real number,
this method returns zero and sets @code{errno} to @code{EDOM}.

Set @code{errno} to @code{ERANGE} on overflows.
@end deffn

@node Números complejos como objetos de Python,,Números complejos como estructuras C,Objetos de números complejos
@anchor{c-api/complex complex-numbers-as-python-objects}@anchor{4b60}
@subsubsection Números complejos como objetos de Python


@geindex PyComplexObject (C type)
@anchor{c-api/complex c PyComplexObject}@anchor{4b61}
@deffn {C Tipo} type PyComplexObject

Este subtipo de @ref{42d,,PyObject} representa un objeto de número complejo de Python.
@end deffn

@geindex PyComplex_Type (C var)
@anchor{c-api/complex c PyComplex_Type}@anchor{4909}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyComplex_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo de número complejo de Python. Es el mismo objeto que @ref{154,,complex} en la capa de Python.
@end deffn

@geindex PyComplex_Check (C function)
@anchor{c-api/complex c PyComplex_Check}@anchor{4b62}
@deffn {C Función} int PyComplex_Check (PyObject *p)

Retorna verdadero si su argumento es un @ref{4b61,,PyComplexObject} o un subtipo de @ref{4b61,,PyComplexObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyComplex_CheckExact (C function)
@anchor{c-api/complex c PyComplex_CheckExact}@anchor{4b63}
@deffn {C Función} int PyComplex_CheckExact (PyObject *p)

Retorna verdadero si su argumento es un @ref{4b61,,PyComplexObject}, pero no un subtipo de @ref{4b61,,PyComplexObject}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyComplex_FromCComplex (C function)
@anchor{c-api/complex c PyComplex_FromCComplex}@anchor{4b64}
@deffn {C Función} @ref{42d,,PyObject} *PyComplex_FromCComplex (Py_complex v)
`Return value: New reference.'
Create a new Python complex number object from a C @ref{4a8d,,Py_complex} value.
Return @code{NULL} with an exception set on error.
@end deffn

@geindex PyComplex_FromDoubles (C function)
@anchor{c-api/complex c PyComplex_FromDoubles}@anchor{4908}
@deffn {C Función} @ref{42d,,PyObject} *PyComplex_FromDoubles (double real, double imag)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new @ref{4b61,,PyComplexObject} object from `real' and `imag'.
Return @code{NULL} with an exception set on error.
@end deffn

@geindex PyComplex_RealAsDouble (C function)
@anchor{c-api/complex c PyComplex_RealAsDouble}@anchor{16a1}
@deffn {C Función} double PyComplex_RealAsDouble (PyObject *op)
` Part of the @ref{5f6,,Stable ABI}.'
Return the real part of `op' as a C double.

If `op' is not a Python complex number object but has a
@ref{687,,__complex__()} method, this method will first be called to
convert `op' to a Python complex number object.  If @code{__complex__()} is
not defined then it falls back to call @ref{af9,,PyFloat_AsDouble()} and
returns its result.

Upon failure, this method returns @code{-1.0} with an exception set, so one
should call @ref{18fa,,PyErr_Occurred()} to check for errors.


Distinto en la versión 3.13: Use @ref{687,,__complex__()} if available.

@end deffn

@geindex PyComplex_ImagAsDouble (C function)
@anchor{c-api/complex c PyComplex_ImagAsDouble}@anchor{16a2}
@deffn {C Función} double PyComplex_ImagAsDouble (PyObject *op)
` Part of the @ref{5f6,,Stable ABI}.'
Return the imaginary part of `op' as a C double.

If `op' is not a Python complex number object but has a
@ref{687,,__complex__()} method, this method will first be called to
convert `op' to a Python complex number object.  If @code{__complex__()} is
not defined then it falls back to call @ref{af9,,PyFloat_AsDouble()} and
returns @code{0.0} on success.

Upon failure, this method returns @code{-1.0} with an exception set, so one
should call @ref{18fa,,PyErr_Occurred()} to check for errors.


Distinto en la versión 3.13: Use @ref{687,,__complex__()} if available.

@end deffn

@geindex PyComplex_AsCComplex (C function)
@anchor{c-api/complex c PyComplex_AsCComplex}@anchor{1431}
@deffn {C Función} @ref{4a8d,,Py_complex} PyComplex_AsCComplex (PyObject *op)

Retorna el valor @ref{4a8d,,Py_complex} del número complejo `op'.

If `op' is not a Python complex number object but has a @ref{687,,__complex__()}
method, this method will first be called to convert `op' to a Python complex
number object.  If @code{__complex__()} is not defined then it falls back to
@ref{a5e,,__float__()}.  If @code{__float__()} is not defined then it falls back
to @ref{22b,,__index__()}.

Upon failure, this method returns @ref{4a8d,,Py_complex}
with @ref{4b59,,real} set to @code{-1.0} and with an exception set, so one
should call @ref{18fa,,PyErr_Occurred()} to check for errors.


Distinto en la versión 3.8: Use @ref{22b,,__index__()} if available.

@end deffn

@node Objetos de secuencia,Objetos contenedor,Objetos numéricos,Capa de objetos concretos
@anchor{c-api/concrete sequence-objects}@anchor{4b65}@anchor{c-api/concrete sequenceobjects}@anchor{4b66}
@subsection Objetos de secuencia


@geindex object;sequence

Las operaciones genéricas en los objetos de secuencia se discutieron en el capítulo anterior; Esta sección trata sobre los tipos específicos de objetos de secuencia que son intrínsecos al lenguaje Python.

@c XXX sort out unicode, str, bytes and bytearray

@menu
* Objetos bytes:: 
* Objetos de arreglos de bytes (bytearrays): Objetos de arreglos de bytes bytearrays. 
* Objetos y códecs unicode:: 
* Objetos tupla:: 
* Objetos de secuencia de estructura:: 
* Objetos lista:: 

@end menu

@node Objetos bytes,Objetos de arreglos de bytes bytearrays,,Objetos de secuencia
@anchor{c-api/bytes doc}@anchor{4b67}@anchor{c-api/bytes bytes-objects}@anchor{4b68}@anchor{c-api/bytes bytesobjects}@anchor{4b69}
@subsubsection Objetos bytes


Estas funciones lanzan @ref{228,,TypeError} cuando se espera un parámetro de bytes y se llama con un parámetro que no es bytes.

@geindex object;bytes

@geindex PyBytesObject (C type)
@anchor{c-api/bytes c PyBytesObject}@anchor{82b}
@deffn {C Tipo} type PyBytesObject

Este subtipo de @ref{42d,,PyObject} representa un objeto bytes de Python.
@end deffn

@geindex PyBytes_Type (C var)
@anchor{c-api/bytes c PyBytes_Type}@anchor{48e9}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyBytes_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo bytes de Python; es el mismo objeto que @ref{325,,bytes} en la capa de Python.
@end deffn

@geindex PyBytes_Check (C function)
@anchor{c-api/bytes c PyBytes_Check}@anchor{13f4}
@deffn {C Función} int PyBytes_Check (PyObject *o)

Retorna verdadero si el objeto `o' es un objeto bytes o una instancia de un subtipo del tipo bytes. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyBytes_CheckExact (C function)
@anchor{c-api/bytes c PyBytes_CheckExact}@anchor{4b6a}
@deffn {C Función} int PyBytes_CheckExact (PyObject *o)

Retorna verdadero si el objeto `o' es un objeto bytes, pero no una instancia de un subtipo del tipo bytes. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyBytes_FromString (C function)
@anchor{c-api/bytes c PyBytes_FromString}@anchor{48e7}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_FromString (const char *v)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo objeto bytes con una copia de la cadena de caracteres `v' como valor en caso de éxito y @code{NULL} en caso de error. El parámetro `v' no debe ser @code{NULL}; no se comprobará.
@end deffn

@geindex PyBytes_FromStringAndSize (C function)
@anchor{c-api/bytes c PyBytes_FromStringAndSize}@anchor{13f5}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_FromStringAndSize (const char *v, Py_ssize_t len)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo objeto bytes con una copia de la cadena de caracteres `v' como valor y longitud `len' en caso de éxito y @code{NULL} en caso de error. Si `v' es @code{NULL}, el contenido del objeto bytes no se inicializa.
@end deffn

@geindex PyBytes_FromFormat (C function)
@anchor{c-api/bytes c PyBytes_FromFormat}@anchor{1a30}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_FromFormat (const char *format, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Toma una cadena de caracteres `format' del estilo C @code{printf()} y un número variable de argumentos, calcula el tamaño del objeto bytes Python resultante y retorna un objeto bytes con los valores formateados. Los argumentos variables deben ser tipos C y deben corresponder exactamente a los caracteres de formato en la cadena de caracteres `format'. Se permiten los siguientes caracteres de formato:

@c % XXX: This should be exactly the same as the table in PyErr_Format.

@c % One should just refer to the other.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caracteres de formato

@tab

Tipo

@tab

Comentario

@item

@code{%%}

@tab

`n/a'

@tab

El carácter literal `%'.

@item

@code{%c}

@tab

int

@tab

Un solo byte, representado como un C int.

@item

@code{%d}

@tab

int

@tab

Equivalente a @code{printf("%d")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%u}

@tab

unsigned int

@tab

Equivalente a @code{printf("%u")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%ld}

@tab

long

@tab

Equivalente a @code{printf("%ld")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%lu}

@tab

unsigned long

@tab

Equivalente a @code{printf("%lu")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%zd}

@tab

@ref{af0,,Py_ssize_t}

@tab

Equivalente a @code{printf("%zd")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%zu}

@tab

size_t

@tab

Equivalente a @code{printf("%zu")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%i}

@tab

int

@tab

Equivalente a @code{printf("%i")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%x}

@tab

int

@tab

Equivalente a @code{printf("%x")}. @footnote{
Para especificadores de enteros `(d, u, ld, lu, zd, zu, i, x)': el indicador de conversión 0 tiene efecto incluso cuando se proporciona una precisión.
}

@item

@code{%s}

@tab

const char*

@tab

Un arreglo de caracteres C terminados en nulo.

@item

@code{%p}

@tab

const void*

@tab

La representación hexadecimal de un puntero en C. Principalmente equivalente a @code{printf("%p")} excepto que se garantiza que comience con el literal @code{0x}, independientemente de lo que produzca el @code{printf} de la plataforma.

@end multitable


Un carácter de formato no reconocido hace que todo el resto de la cadena de caracteres de formato se copie como está en el objeto de resultado y se descartan los argumentos adicionales.
@end deffn

@geindex PyBytes_FromFormatV (C function)
@anchor{c-api/bytes c PyBytes_FromFormatV}@anchor{48e5}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_FromFormatV (const char *format, va_list vargs)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Idéntica a @ref{1a30,,PyBytes_FromFormat()} excepto que toma exactamente dos argumentos.
@end deffn

@geindex PyBytes_FromObject (C function)
@anchor{c-api/bytes c PyBytes_FromObject}@anchor{48e6}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_FromObject (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna la representación en bytes del objeto `o' que implementa el protocolo de búfer.
@end deffn

@geindex PyBytes_Size (C function)
@anchor{c-api/bytes c PyBytes_Size}@anchor{48e8}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyBytes_Size (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna la longitud de los bytes en el objeto bytes `o'.
@end deffn

@geindex PyBytes_GET_SIZE (C function)
@anchor{c-api/bytes c PyBytes_GET_SIZE}@anchor{4b6b}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyBytes_GET_SIZE (PyObject *o)

Forma macro de @ref{48e8,,PyBytes_Size()} pero sin verificación de errores.
@end deffn

@geindex PyBytes_AsString (C function)
@anchor{c-api/bytes c PyBytes_AsString}@anchor{91f}
@deffn {C Función} char *PyBytes_AsString (PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna un puntero al contenido de `o'. El puntero se refiere al búfer interno de `o', que consiste en @code{len(o) + 1} bytes. El último byte en el búfer siempre es nulo, independientemente de si hay otros bytes nulos. Los datos no deben modificarse de ninguna manera, a menos que el objeto se haya creado usando @code{PyBytes_FromStringAndSize(NULL, size)}. No debe ser desasignado. Si `o' no es un objeto de bytes en absoluto, @ref{91f,,PyBytes_AsString()} retorna @code{NULL} y lanza un @ref{228,,TypeError}.
@end deffn

@geindex PyBytes_AS_STRING (C function)
@anchor{c-api/bytes c PyBytes_AS_STRING}@anchor{4b6c}
@deffn {C Función} char *PyBytes_AS_STRING (PyObject *string)

Forma macro de @ref{91f,,PyBytes_AsString()} pero sin verificación de errores.
@end deffn

@geindex PyBytes_AsStringAndSize (C function)
@anchor{c-api/bytes c PyBytes_AsStringAndSize}@anchor{48e2}
@deffn {C Función} int PyBytes_AsStringAndSize (PyObject *obj, char **buffer, Py_ssize_t *length)
` Part of the @ref{5f6,,Stable ABI}.'
Return the null-terminated contents of the object `obj'
through the output variables `buffer' and `length'.
Returns @code{0} on success.

Si `length' es @code{NULL}, el objeto bytes no puede contener bytes nulos incrustados; en caso contrario, la función retorna @code{-1} y se lanza un @ref{360,,ValueError}.

El búfer se refiere a un búfer interno de `obj', que incluye un byte nulo adicional al final (no está considerado en `length'). Los datos no deben modificarse de ninguna manera, a menos que el objeto se haya creado usando @code{PyBytes_FromStringAndSize(NULL, size)}. No debe ser desasignado. Si `obj' no es un objeto bytes en absoluto, @ref{48e2,,PyBytes_AsStringAndSize()} retorna @code{-1} y lanza @ref{228,,TypeError}.


Distinto en la versión 3.5: Anteriormente, @ref{228,,TypeError} se lanzaba cuando se encontraban bytes nulos incrustados en el objeto bytes.

@end deffn

@geindex PyBytes_Concat (C function)
@anchor{c-api/bytes c PyBytes_Concat}@anchor{48e3}
@deffn {C Función} void PyBytes_Concat (PyObject **bytes, PyObject *newpart)
` Part of the @ref{5f6,,Stable ABI}.'
Crea un nuevo objeto de bytes en `*bytes' que contiene el contenido de `newpart' agregado a `bytes'; la persona que llama poseerá la nueva referencia. La referencia al valor anterior de `bytes' será robada. Si no se puede crear el nuevo objeto, la referencia anterior a `bytes' se seguirá descartando y el valor de `*bytes' se establecerá en @code{NULL}; se establecerá la excepción apropiada.
@end deffn

@geindex PyBytes_ConcatAndDel (C function)
@anchor{c-api/bytes c PyBytes_ConcatAndDel}@anchor{48e4}
@deffn {C Función} void PyBytes_ConcatAndDel (PyObject **bytes, PyObject *newpart)
` Part of the @ref{5f6,,Stable ABI}.'
Create a new bytes object in `*bytes' containing the contents of `newpart'
appended to `bytes'.  This version releases the @ref{431,,strong reference}
to `newpart' (i.e. decrements its reference count).
@end deffn

@geindex PyBytes_Join (C function)
@anchor{c-api/bytes c PyBytes_Join}@anchor{254}
@deffn {C Función} @ref{42d,,PyObject} *PyBytes_Join (PyObject *sep, PyObject *iterable)

Similar to @code{sep.join(iterable)} in Python.

`sep' must be Python @ref{325,,bytes} object.
(Note that @ref{1211,,PyUnicode_Join()} accepts @code{NULL} separator and treats
it as a space, whereas @ref{254,,PyBytes_Join()} doesn’t accept @code{NULL}
separator.)

`iterable' must be an iterable object yielding objects that implement the
@ref{48a,,buffer protocol}.

On success, return a new @ref{325,,bytes} object.
On error, set an exception and return @code{NULL}.


Added in version 3.14.

@end deffn

@geindex _PyBytes_Resize (C function)
@anchor{c-api/bytes c _PyBytes_Resize}@anchor{165f}
@deffn {C Función} int _PyBytes_Resize (PyObject **bytes, Py_ssize_t newsize)

Resize a bytes object. `newsize' will be the new length of the bytes object.
You can think of it as creating a new bytes object and destroying the old
one, only more efficiently.
Pass the address of an
existing bytes object as an lvalue (it may be written into), and the new size
desired.  On success, `*bytes' holds the resized bytes object and @code{0} is
returned; the address in `*bytes' may differ from its input value.  If the
reallocation fails, the original bytes object at `*bytes' is deallocated,
`*bytes' is set to @code{NULL}, @ref{16cb,,MemoryError} is set, and @code{-1} is
returned.
@end deffn

@node Objetos de arreglos de bytes bytearrays,Objetos y códecs unicode,Objetos bytes,Objetos de secuencia
@anchor{c-api/bytearray doc}@anchor{4b6d}@anchor{c-api/bytearray byte-array-objects}@anchor{4b6e}@anchor{c-api/bytearray bytearrayobjects}@anchor{4b6f}
@subsubsection Objetos de arreglos de bytes (`bytearrays')


@geindex object;bytearray

@geindex PyByteArrayObject (C type)
@anchor{c-api/bytearray c PyByteArrayObject}@anchor{4b70}
@deffn {C Tipo} type PyByteArrayObject

Este subtipo de @ref{42d,,PyObject} representa un objeto arreglo de bytes de Python.
@end deffn

@geindex PyByteArray_Type (C var)
@anchor{c-api/bytearray c PyByteArray_Type}@anchor{48e1}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyByteArray_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo arreglo de bytes de Python; es el mismo objeto que @ref{5e0,,bytearray} en la capa de Python.
@end deffn

@menu
* Macros de verificación de tipos:: 
* Funciones API directas:: 
* Macros:: 

@end menu

@node Macros de verificación de tipos,Funciones API directas,,Objetos de arreglos de bytes bytearrays
@anchor{c-api/bytearray type-check-macros}@anchor{4b71}
@subsubsection Macros de verificación de tipos


@geindex PyByteArray_Check (C function)
@anchor{c-api/bytearray c PyByteArray_Check}@anchor{4b72}
@deffn {C Función} int PyByteArray_Check (PyObject *o)

Retorna verdadero si el objeto `o' es un objeto de arreglo de bytes o una instancia de un subtipo del tipo arreglo de bytes. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyByteArray_CheckExact (C function)
@anchor{c-api/bytearray c PyByteArray_CheckExact}@anchor{4b73}
@deffn {C Función} int PyByteArray_CheckExact (PyObject *o)

Retorna verdadero si el objeto `o' es un objeto de arreglo de bytes, pero no una instancia de un subtipo del tipo arreglo de bytes. Esta función siempre finaliza con éxito.
@end deffn

@node Funciones API directas,Macros,Macros de verificación de tipos,Objetos de arreglos de bytes bytearrays
@anchor{c-api/bytearray direct-api-functions}@anchor{4b74}
@subsubsection Funciones API directas


@geindex PyByteArray_FromObject (C function)
@anchor{c-api/bytearray c PyByteArray_FromObject}@anchor{13f6}
@deffn {C Función} @ref{42d,,PyObject} *PyByteArray_FromObject (PyObject *o)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo objeto de arreglo de bytes de cualquier objeto, `o', que implementa el @ref{48a,,buffer protocol}.

On failure, return @code{NULL} with an exception set.
@end deffn

@geindex PyByteArray_FromStringAndSize (C function)
@anchor{c-api/bytearray c PyByteArray_FromStringAndSize}@anchor{13f7}
@deffn {C Función} @ref{42d,,PyObject} *PyByteArray_FromStringAndSize (const char *string, Py_ssize_t len)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a new bytearray object from `string' and its length, `len'.

On failure, return @code{NULL} with an exception set.
@end deffn

@geindex PyByteArray_Concat (C function)
@anchor{c-api/bytearray c PyByteArray_Concat}@anchor{48de}
@deffn {C Función} @ref{42d,,PyObject} *PyByteArray_Concat (PyObject *a, PyObject *b)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Une los arreglos de bytes (`bytearrays') `a' y `b' y retorna un nuevo arreglo de bytes (`bytearray') con el resultado.

On failure, return @code{NULL} with an exception set.
@end deffn

@geindex PyByteArray_Size (C function)
@anchor{c-api/bytearray c PyByteArray_Size}@anchor{48e0}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyByteArray_Size (PyObject *bytearray)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el tamaño de `bytearray' después de buscar un puntero @code{NULL}.
@end deffn

@geindex PyByteArray_AsString (C function)
@anchor{c-api/bytearray c PyByteArray_AsString}@anchor{48dd}
@deffn {C Función} char *PyByteArray_AsString (PyObject *bytearray)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el contenido de `bytearray' como un arreglo de caracteres después de verificar un puntero @code{NULL}. La arreglo retornado siempre tiene un byte nulo adicional agregado.
@end deffn

@geindex PyByteArray_Resize (C function)
@anchor{c-api/bytearray c PyByteArray_Resize}@anchor{48df}
@deffn {C Función} int PyByteArray_Resize (PyObject *bytearray, Py_ssize_t len)
` Part of the @ref{5f6,,Stable ABI}.'
Cambia el tamaño del búfer interno de `bytearray' a `len'.
@end deffn

@node Macros,,Funciones API directas,Objetos de arreglos de bytes bytearrays
@anchor{c-api/bytearray macros}@anchor{4b75}
@subsubsection Macros


Estos macros intercambian seguridad por velocidad y no comprueban punteros.

@geindex PyByteArray_AS_STRING (C function)
@anchor{c-api/bytearray c PyByteArray_AS_STRING}@anchor{4b76}
@deffn {C Función} char *PyByteArray_AS_STRING (PyObject *bytearray)

Similar a @ref{48dd,,PyByteArray_AsString()}, pero sin comprobación de errores.
@end deffn

@geindex PyByteArray_GET_SIZE (C function)
@anchor{c-api/bytearray c PyByteArray_GET_SIZE}@anchor{4b77}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyByteArray_GET_SIZE (PyObject *bytearray)

Similar a @ref{48e0,,PyByteArray_Size()}, pero sin comprobación de errores.
@end deffn

@node Objetos y códecs unicode,Objetos tupla,Objetos de arreglos de bytes bytearrays,Objetos de secuencia
@anchor{c-api/unicode doc}@anchor{120f}@anchor{c-api/unicode unicode-objects-and-codecs}@anchor{4b78}@anchor{c-api/unicode unicodeobjects}@anchor{4b79}
@subsubsection Objetos y códecs unicode


@menu
* Objetos unicode:: 
* Códecs incorporados:: 
* Métodos y funciones de ranura (Slot): Métodos y funciones de ranura Slot. 
* PyUnicodeWriter:: 

@end menu

@node Objetos unicode,Códecs incorporados,,Objetos y códecs unicode
@anchor{c-api/unicode unicode-objects}@anchor{4b7a}
@subsubsection Objetos unicode


Desde la implementación del 
@geindex Python Enhancement Proposals; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 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).

UTF-8 representation is created on demand and cached in the Unicode object.

@cartouche
@quotation Nota 
The @ref{277,,Py_UNICODE} representation has been removed since Python 3.12
with deprecated APIs.
See 
@geindex Python Enhancement Proposals; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} for more information.
@end quotation
@end cartouche

@menu
* Tipo unicode:: 
* Propiedades de caracteres Unicode:: 
* Creando y accediendo a cadenas de caracteres Unicode:: 
* Codificación regional:: 
* Codificación del sistema de archivos:: 
* soporte wchar_t:: 

@end menu

@node Tipo unicode,Propiedades de caracteres Unicode,,Objetos unicode
@anchor{c-api/unicode unicode-type}@anchor{4b7b}
@subsubsection Tipo unicode


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

@geindex Py_UCS4 (C type)
@geindex Py_UCS2 (C type)
@geindex Py_UCS1 (C type)
@anchor{c-api/unicode c Py_UCS4}@anchor{1e4}
@deffn {C Tipo} type Py_UCS4
@anchor{c-api/unicode c Py_UCS2}@anchor{11e5}
@deffnx {C Tipo} type Py_UCS2
@anchor{c-api/unicode c Py_UCS1}@anchor{11e4}
@deffnx {C Tipo} type Py_UCS1
` Part of the @ref{5f6,,Stable ABI}.'
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 @ref{1e4,,Py_UCS4}.


Added in version 3.3.

@end deffn

@geindex Py_UNICODE (C type)
@anchor{c-api/unicode c Py_UNICODE}@anchor{277}
@deffn {C Tipo} type Py_UNICODE

This is a typedef of @code{wchar_t}, which is a 16-bit type or 32-bit type
depending on the platform.


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.



Deprecated since version 3.13, will be removed in version 3.15.

@end deffn

@geindex PyASCIIObject (C type)
@geindex PyCompactUnicodeObject (C type)
@geindex PyUnicodeObject (C type)
@anchor{c-api/unicode c PyASCIIObject}@anchor{11e6}
@deffn {C Tipo} type PyASCIIObject
@anchor{c-api/unicode c PyCompactUnicodeObject}@anchor{11e7}
@deffnx {C Tipo} type PyCompactUnicodeObject
@anchor{c-api/unicode c PyUnicodeObject}@anchor{82d}
@deffnx {C Tipo} type PyUnicodeObject

Estos subtipos de @ref{42d,,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 @ref{42d,,PyObject}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_Type (C var)
@anchor{c-api/unicode c PyUnicode_Type}@anchor{4a07}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyUnicode_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo Python Unicode. Está expuesto al código de Python como @code{str}.
@end deffn

The following APIs are C macros and static inlined functions for fast checks and
access to internal read-only data of Unicode objects:

@geindex PyUnicode_Check (C function)
@anchor{c-api/unicode c PyUnicode_Check}@anchor{4b7c}
@deffn {C Función} int PyUnicode_Check (PyObject *obj)

Return true if the object `obj' is a Unicode object or an instance of a Unicode
subtype.  This function always succeeds.
@end deffn

@geindex PyUnicode_CheckExact (C function)
@anchor{c-api/unicode c PyUnicode_CheckExact}@anchor{4b7d}
@deffn {C Función} int PyUnicode_CheckExact (PyObject *obj)

Return true if the object `obj' is a Unicode object, but not an instance of a
subtype.  This function always succeeds.
@end deffn

@geindex PyUnicode_READY (C function)
@anchor{c-api/unicode c PyUnicode_READY}@anchor{298}
@deffn {C Función} int PyUnicode_READY (PyObject *unicode)

Returns @code{0}. This API is kept only for backward compatibility.


Added in version 3.3.



Obsoleto desde la versión 3.10: This API does nothing since Python 3.12.

@end deffn

@geindex PyUnicode_GET_LENGTH (C function)
@anchor{c-api/unicode c PyUnicode_GET_LENGTH}@anchor{94b}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_GET_LENGTH (PyObject *unicode)

Return the length of the Unicode string, in code points.  `unicode' has to be a
Unicode object in the «canonical» representation (not checked).


Added in version 3.3.

@end deffn

@geindex PyUnicode_1BYTE_DATA (C function)
@geindex PyUnicode_2BYTE_DATA (C function)
@geindex PyUnicode_4BYTE_DATA (C function)
@anchor{c-api/unicode c PyUnicode_1BYTE_DATA}@anchor{11eb}
@deffn {C Función} @ref{11e4,,Py_UCS1} *PyUnicode_1BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_2BYTE_DATA}@anchor{11ec}
@deffnx {C Función} @ref{11e5,,Py_UCS2} *PyUnicode_2BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_4BYTE_DATA}@anchor{11ed}
@deffnx {C Función} @ref{1e4,,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
@ref{11ee,,PyUnicode_KIND()} to select the right function.


Added in version 3.3.

@end deffn

@geindex PyUnicode_1BYTE_KIND (C macro)
@geindex PyUnicode_2BYTE_KIND (C macro)
@geindex PyUnicode_4BYTE_KIND (C macro)
@anchor{c-api/unicode c PyUnicode_1BYTE_KIND}@anchor{11ef}
@deffn {C Macro} PyUnicode_1BYTE_KIND
@anchor{c-api/unicode c PyUnicode_2BYTE_KIND}@anchor{11f0}
@deffnx {C Macro} PyUnicode_2BYTE_KIND
@anchor{c-api/unicode c PyUnicode_4BYTE_KIND}@anchor{11f1}
@deffnx {C Macro} PyUnicode_4BYTE_KIND

Retorna los valores de la macro @ref{11ee,,PyUnicode_KIND()}.


Added in version 3.3.



Distinto en la versión 3.12: @code{PyUnicode_WCHAR_KIND} has been removed.

@end deffn

@geindex PyUnicode_KIND (C function)
@anchor{c-api/unicode c PyUnicode_KIND}@anchor{11ee}
@deffn {C Función} int PyUnicode_KIND (PyObject *unicode)

Return one of the PyUnicode kind constants (see above) that indicate how many
bytes per character this Unicode object uses to store its data.  `unicode' has to
be a Unicode object in the «canonical» representation (not checked).


Added in version 3.3.

@end deffn

@geindex PyUnicode_DATA (C function)
@anchor{c-api/unicode c PyUnicode_DATA}@anchor{11ea}
@deffn {C Función} void *PyUnicode_DATA (PyObject *unicode)

Return a void pointer to the raw Unicode buffer.  `unicode' has to be a Unicode
object in the «canonical» representation (not checked).


Added in version 3.3.

@end deffn

@geindex PyUnicode_WRITE (C function)
@anchor{c-api/unicode c PyUnicode_WRITE}@anchor{11f4}
@deffn {C Función} void PyUnicode_WRITE (int kind, void *data, Py_ssize_t index, Py_UCS4 value)

Write into a canonical representation `data' (as obtained with
@ref{11ea,,PyUnicode_DATA()}).  This function performs no sanity checks, and is
intended for usage in loops.  The caller should cache the `kind' value and
`data' pointer as obtained from other calls.  `index' is the index in
the string (starts at 0) and `value' is the new code point value which should
be written to that location.


Added in version 3.3.

@end deffn

@geindex PyUnicode_READ (C function)
@anchor{c-api/unicode c PyUnicode_READ}@anchor{11f2}
@deffn {C Función} @ref{1e4,,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 @ref{11ea,,PyUnicode_DATA()}). No se realizan verificaciones ni llamadas preparadas.


Added in version 3.3.

@end deffn

@geindex PyUnicode_READ_CHAR (C function)
@anchor{c-api/unicode c PyUnicode_READ_CHAR}@anchor{11f3}
@deffn {C Función} @ref{1e4,,Py_UCS4} PyUnicode_READ_CHAR (PyObject *unicode, Py_ssize_t index)

Read a character from a Unicode object `unicode', which must be in the «canonical»
representation.  This is less efficient than @ref{11f2,,PyUnicode_READ()} if you
do multiple consecutive reads.


Added in version 3.3.

@end deffn

@geindex PyUnicode_MAX_CHAR_VALUE (C function)
@anchor{c-api/unicode c PyUnicode_MAX_CHAR_VALUE}@anchor{11f5}
@deffn {C Función} @ref{1e4,,Py_UCS4} PyUnicode_MAX_CHAR_VALUE (PyObject *unicode)

Return the maximum code point that is suitable for creating another string
based on `unicode', which must be in the «canonical» representation.  This is
always an approximation but more efficient than iterating over the string.


Added in version 3.3.

@end deffn

@geindex PyUnicode_IsIdentifier (C function)
@anchor{c-api/unicode c PyUnicode_IsIdentifier}@anchor{19a6}
@deffn {C Función} int PyUnicode_IsIdentifier (PyObject *unicode)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna @code{1} si la cadena de caracteres es un identificador válido de acuerdo con la definición del lenguaje, sección @ref{1e94,,Identificadores y palabras clave}. Retorna @code{0} de lo contrario.


Distinto en la versión 3.9: La función ya no llama a @ref{a15,,Py_FatalError()} si la cadena de caracteres no está lista.

@end deffn

@node Propiedades de caracteres Unicode,Creando y accediendo a cadenas de caracteres Unicode,Tipo unicode,Objetos unicode
@anchor{c-api/unicode unicode-character-properties}@anchor{4b7e}
@subsubsection 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.

@geindex Py_UNICODE_ISSPACE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISSPACE}@anchor{190e}
@deffn {C Función} int Py_UNICODE_ISSPACE (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter de espacio en blanco.
@end deffn

@geindex Py_UNICODE_ISLOWER (C function)
@anchor{c-api/unicode c Py_UNICODE_ISLOWER}@anchor{4b7f}
@deffn {C Función} int Py_UNICODE_ISLOWER (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter en minúscula.
@end deffn

@geindex Py_UNICODE_ISUPPER (C function)
@anchor{c-api/unicode c Py_UNICODE_ISUPPER}@anchor{4b80}
@deffn {C Función} int Py_UNICODE_ISUPPER (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter en mayúscula.
@end deffn

@geindex Py_UNICODE_ISTITLE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISTITLE}@anchor{4b81}
@deffn {C Función} int Py_UNICODE_ISTITLE (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter en caso de título (`titlecase').
@end deffn

@geindex Py_UNICODE_ISLINEBREAK (C function)
@anchor{c-api/unicode c Py_UNICODE_ISLINEBREAK}@anchor{4b82}
@deffn {C Función} int Py_UNICODE_ISLINEBREAK (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter de salto de línea.
@end deffn

@geindex Py_UNICODE_ISDECIMAL (C function)
@anchor{c-api/unicode c Py_UNICODE_ISDECIMAL}@anchor{4b83}
@deffn {C Función} int Py_UNICODE_ISDECIMAL (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter decimal o no.
@end deffn

@geindex Py_UNICODE_ISDIGIT (C function)
@anchor{c-api/unicode c Py_UNICODE_ISDIGIT}@anchor{4b84}
@deffn {C Función} int Py_UNICODE_ISDIGIT (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter de dígitos.
@end deffn

@geindex Py_UNICODE_ISNUMERIC (C function)
@anchor{c-api/unicode c Py_UNICODE_ISNUMERIC}@anchor{4b85}
@deffn {C Función} int Py_UNICODE_ISNUMERIC (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter numérico.
@end deffn

@geindex Py_UNICODE_ISALPHA (C function)
@anchor{c-api/unicode c Py_UNICODE_ISALPHA}@anchor{4b86}
@deffn {C Función} int Py_UNICODE_ISALPHA (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter alfabético.
@end deffn

@geindex Py_UNICODE_ISALNUM (C function)
@anchor{c-api/unicode c Py_UNICODE_ISALNUM}@anchor{4b87}
@deffn {C Función} int Py_UNICODE_ISALNUM (Py_UCS4 ch)

Retorna @code{1} o @code{0} dependiendo de si `ch' es un carácter alfanumérico.
@end deffn

@geindex Py_UNICODE_ISPRINTABLE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISPRINTABLE}@anchor{4b88}
@deffn {C Función} int Py_UNICODE_ISPRINTABLE (Py_UCS4 ch)

Retorna @code{1} o @code{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 @ref{894,,repr()} se invoca en una cadena de caracteres. No tiene relación con el manejo de cadenas de caracteres escritas en @ref{b61,,sys.stdout} o @ref{9cc,,sys.stderr}.)
@end deffn

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

@geindex Py_UNICODE_TOLOWER (C function)
@anchor{c-api/unicode c Py_UNICODE_TOLOWER}@anchor{4b89}
@deffn {C Función} @ref{1e4,,Py_UCS4} Py_UNICODE_TOLOWER (Py_UCS4 ch)

Retorna el carácter `ch' convertido a minúsculas.
@end deffn

@geindex Py_UNICODE_TOUPPER (C function)
@anchor{c-api/unicode c Py_UNICODE_TOUPPER}@anchor{4b8a}
@deffn {C Función} @ref{1e4,,Py_UCS4} Py_UNICODE_TOUPPER (Py_UCS4 ch)

Retorna el carácter `ch' convertido a mayúsculas.
@end deffn

@geindex Py_UNICODE_TOTITLE (C function)
@anchor{c-api/unicode c Py_UNICODE_TOTITLE}@anchor{4b8b}
@deffn {C Función} @ref{1e4,,Py_UCS4} Py_UNICODE_TOTITLE (Py_UCS4 ch)

Retorna el carácter `ch' convertido a formato de título (`titlecase').
@end deffn

@geindex Py_UNICODE_TODECIMAL (C function)
@anchor{c-api/unicode c Py_UNICODE_TODECIMAL}@anchor{4b8c}
@deffn {C Función} int Py_UNICODE_TODECIMAL (Py_UCS4 ch)

Return the character `ch' converted to a decimal positive integer.  Return
@code{-1} if this is not possible.  This function does not raise exceptions.
@end deffn

@geindex Py_UNICODE_TODIGIT (C function)
@anchor{c-api/unicode c Py_UNICODE_TODIGIT}@anchor{4b8d}
@deffn {C Función} int Py_UNICODE_TODIGIT (Py_UCS4 ch)

Return the character `ch' converted to a single digit integer. Return @code{-1} if
this is not possible.  This function does not raise exceptions.
@end deffn

@geindex Py_UNICODE_TONUMERIC (C function)
@anchor{c-api/unicode c Py_UNICODE_TONUMERIC}@anchor{4b8e}
@deffn {C Función} double Py_UNICODE_TONUMERIC (Py_UCS4 ch)

Return the character `ch' converted to a double. Return @code{-1.0} if this is not
possible.  This function does not raise exceptions.
@end deffn

Estas API se pueden usar para trabajar con sustitutos:

@geindex Py_UNICODE_IS_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_IS_SURROGATE}@anchor{4b8f}
@deffn {C Función} int Py_UNICODE_IS_SURROGATE (Py_UCS4 ch)

Comprueba si `ch' es un sustituto (@code{0xD800 <= ch <= 0xDFFF}).
@end deffn

@geindex Py_UNICODE_IS_HIGH_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_IS_HIGH_SURROGATE}@anchor{4b90}
@deffn {C Función} int Py_UNICODE_IS_HIGH_SURROGATE (Py_UCS4 ch)

Comprueba si `ch' es un sustituto alto (@code{0xD800 <= ch <= 0xDFFF}).
@end deffn

@geindex Py_UNICODE_IS_LOW_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_IS_LOW_SURROGATE}@anchor{4b91}
@deffn {C Función} int Py_UNICODE_IS_LOW_SURROGATE (Py_UCS4 ch)

Comprueba si `ch' es un sustituto bajo (@code{0xD800 <= ch <= 0xDFFF}).
@end deffn

@geindex Py_UNICODE_JOIN_SURROGATES (C function)
@anchor{c-api/unicode c Py_UNICODE_JOIN_SURROGATES}@anchor{4b92}
@deffn {C Función} @ref{1e4,,Py_UCS4} Py_UNICODE_JOIN_SURROGATES (Py_UCS4 high, Py_UCS4 low)

Join two surrogate code points and return a single @ref{1e4,,Py_UCS4} value.
`high' and `low' are respectively the leading and trailing surrogates in a
surrogate pair. `high' must be in the range [0xD800; 0xDBFF] and `low' must
be in the range [0xDC00; 0xDFFF].
@end deffn

@node Creando y accediendo a cadenas de caracteres Unicode,Codificación regional,Propiedades de caracteres Unicode,Objetos unicode
@anchor{c-api/unicode creating-and-accessing-unicode-strings}@anchor{4b93}
@subsubsection Creando y accediendo a cadenas de caracteres Unicode


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

@geindex PyUnicode_New (C function)
@anchor{c-api/unicode c PyUnicode_New}@anchor{943}
@deffn {C Función} @ref{42d,,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.

On error, set an exception and return @code{NULL}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_FromKindAndData (C function)
@anchor{c-api/unicode c PyUnicode_FromKindAndData}@anchor{11e8}
@deffn {C Función} @ref{42d,,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 @ref{11ef,,PyUnicode_1BYTE_KIND} etc., según lo retornado por @ref{11ee,,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.

Si es necesario, la entrada `buffer' se copia y se transforma en la representación canónica. Por ejemplo, si el `buffer' es una cadena de caracteres UCS4 (@ref{11f1,,PyUnicode_4BYTE_KIND}) y consta solo de puntos de código en el rango UCS1, se transformará en UCS1 (@ref{11ef,,PyUnicode_1BYTE_KIND}).


Added in version 3.3.

@end deffn

@geindex PyUnicode_FromStringAndSize (C function)
@anchor{c-api/unicode c PyUnicode_FromStringAndSize}@anchor{4a01}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromStringAndSize (const char *str, Py_ssize_t size)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object from the char buffer `str'.  The bytes will be
interpreted as being UTF-8 encoded.  The buffer is copied into the new
object.
The return value might be a shared object, i.e. modification of the data is
not allowed.

This function raises @ref{619,,SystemError} when:


@itemize *

@item 
`size' < 0,

@item 
`str' is @code{NULL} and `size' > 0
@end itemize


Distinto en la versión 3.12: `str' == @code{NULL} with `size' > 0 is not allowed anymore.

@end deffn

@geindex PyUnicode_FromString (C function)
@anchor{c-api/unicode c PyUnicode_FromString}@anchor{48a3}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromString (const char *str)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object from a UTF-8 encoded null-terminated char buffer
`str'.
@end deffn

@geindex PyUnicode_FromFormat (C function)
@anchor{c-api/unicode c PyUnicode_FromFormat}@anchor{47c}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromFormat (const char *format, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Take a C @code{printf()}-style `format' string and a variable number of
arguments, calculate the size of the resulting Python Unicode string and return
a string with the values formatted into it.  The variable arguments must be C
types and must correspond exactly to the format characters in the `format'
ASCII-encoded string.

A conversion specifier contains two or more characters and has the following
components, which must occur in this order:


@enumerate 

@item 
The @code{'%'} character, which marks the start of the specifier.

@item 
Conversion flags (optional), which affect the result of some conversion
types.

@item 
Minimum field width (optional).
If specified as an @code{'*'} (asterisk), the actual width is given in the
next argument, which must be of type int, and the object to
convert comes after the minimum field width and optional precision.

@item 
Precision (optional), given as a @code{'.'} (dot) followed by the precision.
If specified as @code{'*'} (an asterisk), the actual precision is given in
the next argument, which must be of type int, and the value to
convert comes after the precision.

@item 
Length modifier (optional).

@item 
Conversion type.
@end enumerate

The conversion flag characters are:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Meaning

@item

@code{0}

@tab

The conversion will be zero padded for numeric values.

@item

@code{-}

@tab

The converted value is left adjusted (overrides the @code{0}
flag if both are given).

@end multitable


The length modifiers for following integer conversions (@code{d}, @code{i},
@code{o}, @code{u}, @code{x}, or @code{X}) specify the type of the argument
(int by default):


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modifier

@tab

Types

@item

@code{l}

@tab

long or unsigned long

@item

@code{ll}

@tab

long long or unsigned long long

@item

@code{j}

@tab

@code{intmax_t} or @code{uintmax_t}

@item

@code{z}

@tab

@code{size_t} or @code{ssize_t}

@item

@code{t}

@tab

@code{ptrdiff_t}

@end multitable


The length modifier @code{l} for following conversions @code{s} or @code{V} specify
that the type of the argument is const wchar_t*.

The conversion specifiers are:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Conversion Specifier

@tab

Tipo

@tab

Comentario

@item

@code{%}

@tab

`n/a'

@tab

The literal @code{%} character.

@item

@code{d}, @code{i}

@tab

Specified by the length modifier

@tab

The decimal representation of a signed C integer.

@item

@code{u}

@tab

Specified by the length modifier

@tab

The decimal representation of an unsigned C integer.

@item

@code{o}

@tab

Specified by the length modifier

@tab

The octal representation of an unsigned C integer.

@item

@code{x}

@tab

Specified by the length modifier

@tab

The hexadecimal representation of an unsigned C integer (lowercase).

@item

@code{X}

@tab

Specified by the length modifier

@tab

The hexadecimal representation of an unsigned C integer (uppercase).

@item

@code{c}

@tab

int

@tab

A single character.

@item

@code{s}

@tab

const char* or const wchar_t*

@tab

Un arreglo de caracteres de C terminada en nulo.

@item

@code{p}

@tab

const void*

@tab

The hex representation of a C  pointer.
Mostly equivalent to @code{printf("%p")} except that it is guaranteed to
start with the literal @code{0x} regardless of what the platform’s
@code{printf} yields.

@item

@code{A}

@tab

@ref{42d,,PyObject}*

@tab

El resultado de llamar @ref{1426,,ascii()}.

@item

@code{U}

@tab

@ref{42d,,PyObject}*

@tab

Un objeto unicode.

@item

@code{V}

@tab

@ref{42d,,PyObject}*, const char* or const wchar_t*

@tab

Un objeto Unicode (que puede ser @code{NULL}) y un arreglo de caracteres de C terminada en nulo como segundo parámetro (que se utilizará, si el primer parámetro es @code{NULL}).

@item

@code{S}

@tab

@ref{42d,,PyObject}*

@tab

El resultado de llamar @ref{10ac,,PyObject_Str()}.

@item

@code{R}

@tab

@ref{42d,,PyObject}*

@tab

El resultado de llamar @ref{10ab,,PyObject_Repr()}.

@item

@code{T}

@tab

@ref{42d,,PyObject}*

@tab

Get the fully qualified name of an object type;
call @ref{467,,PyType_GetFullyQualifiedName()}.

@item

@code{#T}

@tab

@ref{42d,,PyObject}*

@tab

Similar to @code{T} format, but use a colon (@code{:}) as separator between
the module name and the qualified name.

@item

@code{N}

@tab

@ref{b30,,PyTypeObject}*

@tab

Get the fully qualified name of a type;
call @ref{467,,PyType_GetFullyQualifiedName()}.

@item

@code{#N}

@tab

@ref{b30,,PyTypeObject}*

@tab

Similar to @code{N} format, but use a colon (@code{:}) as separator between
the module name and the qualified name.

@end multitable


@cartouche
@quotation Nota 
The width formatter unit is number of characters rather than bytes.
The precision formatter unit is number of bytes or @code{wchar_t}
items (if the length modifier @code{l} is used) for @code{"%s"} and
@code{"%V"} (if the @code{PyObject*} argument is @code{NULL}), and a number of
characters for @code{"%A"}, @code{"%U"}, @code{"%S"}, @code{"%R"} and @code{"%V"}
(if the @code{PyObject*} argument is not @code{NULL}).
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Unlike to C @code{printf()} the @code{0} flag has effect even when
a precision is given for integer conversions (@code{d}, @code{i}, @code{u}, @code{o},
@code{x}, or @code{X}).
@end quotation
@end cartouche


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



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



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



Distinto en la versión 3.12: Support for conversion specifiers @code{o} and @code{X}.
Support for length modifiers @code{j} and @code{t}.
Length modifiers are now applied to all integer conversions.
Length modifier @code{l} is now applied to conversion specifiers @code{s} and @code{V}.
Support for variable width and precision @code{*}.
Support for flag @code{-}.

An unrecognized format character now sets a @ref{619,,SystemError}.
In previous versions it caused all the rest of the format string to be
copied as-is to the result string, and any extra arguments discarded.



Distinto en la versión 3.13: Support for @code{%T}, @code{%#T}, @code{%N} and @code{%#N} formats added.

@end deffn

@geindex PyUnicode_FromFormatV (C function)
@anchor{c-api/unicode c PyUnicode_FromFormatV}@anchor{618}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromFormatV (const char *format, va_list vargs)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Idéntico a @ref{47c,,PyUnicode_FromFormat()} excepto que toma exactamente dos argumentos.
@end deffn

@geindex PyUnicode_FromObject (C function)
@anchor{c-api/unicode c PyUnicode_FromObject}@anchor{4a00}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromObject (PyObject *obj)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Copy an instance of a Unicode subtype to a new true Unicode object if
necessary. If `obj' is already a true Unicode object (not a subtype),
return a new @ref{431,,strong reference} to the object.

Los objetos que no sean Unicode o sus subtipos causarán un @ref{228,,TypeError}.
@end deffn

@geindex PyUnicode_FromEncodedObject (C function)
@anchor{c-api/unicode c PyUnicode_FromEncodedObject}@anchor{49ff}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromEncodedObject (PyObject *obj, const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Decodifica un objeto codificado `obj' en un objeto Unicode.

@ref{325,,bytes}, @ref{5e0,,bytearray} y otros @ref{db4,,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 @code{NULL} para que la interfaz use los valores predeterminados (ver @ref{4b94,,Códecs incorporados} para más detalles).

Todos los demás objetos, incluidos los objetos Unicode, hacen que se establezca un @ref{228,,TypeError}.

La API retorna @code{NULL} si hubo un error. La entidad que hace la llamadas es la responsable de desreferenciar los objetos retornados.
@end deffn

@geindex PyUnicode_GetLength (C function)
@anchor{c-api/unicode c PyUnicode_GetLength}@anchor{94a}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_GetLength (PyObject *unicode)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna la longitud del objeto Unicode, en puntos de código.

On error, set an exception and return @code{-1}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_CopyCharacters (C function)
@anchor{c-api/unicode c PyUnicode_CopyCharacters}@anchor{94c}
@deffn {C Función} @ref{af0,,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 @code{memcpy()} if
possible.  Returns @code{-1} and sets an exception on error, otherwise returns
the number of copied characters.


Added in version 3.3.

@end deffn

@geindex PyUnicode_Fill (C function)
@anchor{c-api/unicode c PyUnicode_Fill}@anchor{11fe}
@deffn {C Función} @ref{af0,,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 @code{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 @code{-1} y lanza una excepción en caso de error.


Added in version 3.3.

@end deffn

@geindex PyUnicode_WriteChar (C function)
@anchor{c-api/unicode c PyUnicode_WriteChar}@anchor{11e3}
@deffn {C Función} int PyUnicode_WriteChar (PyObject *unicode, Py_ssize_t index, Py_UCS4 character)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Escribe un carácter en una cadena de caracteres. La cadena debe haberse creado a través de @ref{943,,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).

Return @code{0} on success, @code{-1} on error with an exception set.


Added in version 3.3.

@end deffn

@geindex PyUnicode_ReadChar (C function)
@anchor{c-api/unicode c PyUnicode_ReadChar}@anchor{11e2}
@deffn {C Función} @ref{1e4,,Py_UCS4} PyUnicode_ReadChar (PyObject *unicode, Py_ssize_t index)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Read a character from a string.  This function checks that `unicode' is a
Unicode object and the index is not out of bounds, in contrast to
@ref{11f3,,PyUnicode_READ_CHAR()}, which performs no error checking.

Return character on success, @code{-1} on error with an exception set.


Added in version 3.3.

@end deffn

@geindex PyUnicode_Substring (C function)
@anchor{c-api/unicode c PyUnicode_Substring}@anchor{94d}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Substring (PyObject *unicode, Py_ssize_t start, Py_ssize_t end)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Return a substring of `unicode', from character index `start' (included) to
character index `end' (excluded).  Negative indices are not supported.
On error, set an exception and return @code{NULL}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_AsUCS4 (C function)
@anchor{c-api/unicode c PyUnicode_AsUCS4}@anchor{11e9}
@deffn {C Función} @ref{1e4,,Py_UCS4} *PyUnicode_AsUCS4 (PyObject *unicode, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Copy the string `unicode' into a UCS4 buffer, including a null character, if
`copy_null' is set.  Returns @code{NULL} and sets an exception on error (in
particular, a @ref{619,,SystemError} if `buflen' is smaller than the length of
`unicode').  `buffer' is returned on success.


Added in version 3.3.

@end deffn

@geindex PyUnicode_AsUCS4Copy (C function)
@anchor{c-api/unicode c PyUnicode_AsUCS4Copy}@anchor{952}
@deffn {C Función} @ref{1e4,,Py_UCS4} *PyUnicode_AsUCS4Copy (PyObject *unicode)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Copy the string `unicode' into a new UCS4 buffer that is allocated using
@ref{cee,,PyMem_Malloc()}.  If this fails, @code{NULL} is returned with a
@ref{16cb,,MemoryError} set.  The returned buffer always has an extra
null code point appended.


Added in version 3.3.

@end deffn

@node Codificación regional,Codificación del sistema de archivos,Creando y accediendo a cadenas de caracteres Unicode,Objetos unicode
@anchor{c-api/unicode locale-encoding}@anchor{4b95}
@subsubsection Codificación regional


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

@geindex PyUnicode_DecodeLocaleAndSize (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLocaleAndSize}@anchor{c51}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeLocaleAndSize (const char *str, Py_ssize_t length, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
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 @code{"estricto"} y @code{"subrogateescape"} (
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). El decodificador usa el controlador de errores @code{"estricto"} si `errors' es @code{NULL}. `str' debe terminar con un carácter nulo pero no puede contener caracteres nulos incrustados.

Use @ref{49ef,,PyUnicode_DecodeFSDefaultAndSize()} to decode a string from
the @ref{5dd,,filesystem encoding and error handler}.

Esta función ignora el @ref{6f7,,modo Python UTF-8}.


@subsubheading Ver también


La función @ref{c4f,,Py_DecodeLocale()}.



Added in version 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 @code{subrogateescape}, excepto en Android. Anteriormente, @ref{c4f,,Py_DecodeLocale()} se usaba para el @code{subrogateescape}, y la codificación local actual se usaba para @code{estricto}.

@end deffn

@geindex PyUnicode_DecodeLocale (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLocale}@anchor{49f1}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeLocale (const char *str, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Similar to @ref{c51,,PyUnicode_DecodeLocaleAndSize()}, but compute the string
length using @code{strlen()}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_EncodeLocale (C function)
@anchor{c-api/unicode c PyUnicode_EncodeLocale}@anchor{c52}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_EncodeLocale (PyObject *unicode, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
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 @code{"estricto"} y @code{"subrogateescape"} (
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). El codificador utiliza el controlador de errores @code{"estricto"} si `errors' es @code{NULL}. Retorna un objeto @ref{325,,bytes}. `unicode' no puede contener caracteres nulos incrustados.

Use @ref{1a58,,PyUnicode_EncodeFSDefault()} to encode a string to the
@ref{5dd,,filesystem encoding and error handler}.

Esta función ignora el @ref{6f7,,modo Python UTF-8}.


@subsubheading Ver también


La función @ref{c50,,Py_EncodeLocale()}.



Added in version 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 @code{subrogateescape}, excepto en Android. Anteriormente, @ref{c50,,Py_EncodeLocale()} se usaba para el @code{subrogateescape}, y la codificación local actual se usaba para @code{estricto}.

@end deffn

@node Codificación del sistema de archivos,soporte wchar_t,Codificación regional,Objetos unicode
@anchor{c-api/unicode file-system-encoding}@anchor{4b96}
@subsubsection Codificación del sistema de archivos


Functions encoding to and decoding from the @ref{5dd,,filesystem encoding and error handler} (
@geindex Python Enhancement Proposals; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} and 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}).

To encode file names to @ref{325,,bytes} during argument parsing, the @code{"O&"}
converter should be used, passing @ref{da0,,PyUnicode_FSConverter()} as the
conversion function:

@geindex PyUnicode_FSConverter (C function)
@anchor{c-api/unicode c PyUnicode_FSConverter}@anchor{da0}
@deffn {C Función} int PyUnicode_FSConverter (PyObject *obj, void *result)
` Part of the @ref{5f6,,Stable ABI}.'
ParseTuple converter: encode @ref{237,,str} objects – obtained directly or
through the @ref{cd9,,os.PathLike} interface – to @ref{325,,bytes} using
@ref{1a58,,PyUnicode_EncodeFSDefault()}; @ref{325,,bytes} objects are output as-is.
`result' must be a @ref{82b,,PyBytesObject}* which must be released when it is
no longer used.


Added in version 3.1.



Distinto en la versión 3.6: Acepta un objeto similar a una ruta (@ref{3f0,,path-like object}).

@end deffn

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

@geindex PyUnicode_FSDecoder (C function)
@anchor{c-api/unicode c PyUnicode_FSDecoder}@anchor{61b}
@deffn {C Función} int PyUnicode_FSDecoder (PyObject *obj, void *result)
` Part of the @ref{5f6,,Stable ABI}.'
ParseTuple converter: decode @ref{325,,bytes} objects – obtained either
directly or indirectly through the @ref{cd9,,os.PathLike} interface – to
@ref{237,,str} using @ref{49ef,,PyUnicode_DecodeFSDefaultAndSize()}; @ref{237,,str}
objects are output as-is. `result' must be a @ref{82d,,PyUnicodeObject}* which
must be released when it is no longer used.


Added in version 3.2.



Distinto en la versión 3.6: Acepta un objeto similar a una ruta (@ref{3f0,,path-like object}).

@end deffn

@geindex PyUnicode_DecodeFSDefaultAndSize (C function)
@anchor{c-api/unicode c PyUnicode_DecodeFSDefaultAndSize}@anchor{49ef}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeFSDefaultAndSize (const char *str, Py_ssize_t size)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Decodifica una cadena desde el @ref{5dd,,codificador de sistema de archivos y gestor de errores}.

If you need to decode a string from the current locale encoding, use
@ref{c51,,PyUnicode_DecodeLocaleAndSize()}.


@subsubheading Ver también


La función @ref{c4f,,Py_DecodeLocale()}.



Distinto en la versión 3.6: The @ref{5dd,,filesystem error handler} is now used.

@end deffn

@geindex PyUnicode_DecodeFSDefault (C function)
@anchor{c-api/unicode c PyUnicode_DecodeFSDefault}@anchor{1720}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeFSDefault (const char *str)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Decodifica una cadena terminada en nulo desde el @ref{5dd,,codificador de sistema de archivos y gestor de errores}.

If the string length is known, use
@ref{49ef,,PyUnicode_DecodeFSDefaultAndSize()}.


Distinto en la versión 3.6: The @ref{5dd,,filesystem error handler} is now used.

@end deffn

@geindex PyUnicode_EncodeFSDefault (C function)
@anchor{c-api/unicode c PyUnicode_EncodeFSDefault}@anchor{1a58}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_EncodeFSDefault (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Encode a Unicode object to the @ref{5dd,,filesystem encoding and error handler}, and return @ref{325,,bytes}. Note that the resulting @ref{325,,bytes}
object can contain null bytes.

If you need to encode a string to the current locale encoding, use
@ref{c52,,PyUnicode_EncodeLocale()}.


@subsubheading Ver también


La función @ref{c50,,Py_EncodeLocale()}.



Added in version 3.2.



Distinto en la versión 3.6: The @ref{5dd,,filesystem error handler} is now used.

@end deffn

@node soporte wchar_t,,Codificación del sistema de archivos,Objetos unicode
@anchor{c-api/unicode wchar-t-support}@anchor{4b97}
@subsubsection soporte wchar_t


@code{wchar_t} support for platforms which support it:

@geindex PyUnicode_FromWideChar (C function)
@anchor{c-api/unicode c PyUnicode_FromWideChar}@anchor{11fd}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_FromWideChar (const wchar_t *wstr, Py_ssize_t size)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object from the @code{wchar_t} buffer `wstr' of the given `size'.
Passing @code{-1} as the `size' indicates that the function must itself compute the length,
using @code{wcslen()}.
Return @code{NULL} on failure.
@end deffn

@geindex PyUnicode_AsWideChar (C function)
@anchor{c-api/unicode c PyUnicode_AsWideChar}@anchor{1a5e}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_AsWideChar (PyObject *unicode, wchar_t *wstr, Py_ssize_t size)
` Part of the @ref{5f6,,Stable ABI}.'
Copy the Unicode object contents into the @code{wchar_t} buffer `wstr'.  At most
`size' @code{wchar_t} characters are copied (excluding a possibly trailing
null termination character).  Return the number of @code{wchar_t} characters
copied or @code{-1} in case of an error.

When `wstr' is @code{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.
@end deffn

@geindex PyUnicode_AsWideCharString (C function)
@anchor{c-api/unicode c PyUnicode_AsWideCharString}@anchor{953}
@deffn {C Función} wchar_t *PyUnicode_AsWideCharString (PyObject *unicode, Py_ssize_t *size)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Convert the Unicode object to a wide character string. The output string
always ends with a null character. If `size' is not @code{NULL}, write the number
of wide characters (excluding the trailing null termination character) into
`*size'. Note that the resulting @code{wchar_t} string might contain
null characters, which would cause the string to be truncated when used with
most C functions. If `size' is @code{NULL} and the wchar_t* string
contains null characters a @ref{360,,ValueError} is raised.

Returns a buffer allocated by @ref{1565,,PyMem_New} (use
@ref{1482,,PyMem_Free()} to free it) on success. On error, returns @code{NULL}
and `*size' is undefined. Raises a @ref{16cb,,MemoryError} if memory allocation
is failed.


Added in version 3.2.



Distinto en la versión 3.7: Raises a @ref{360,,ValueError} if `size' is @code{NULL} and the wchar_t*
string contains null characters.

@end deffn

@node Códecs incorporados,Métodos y funciones de ranura Slot,Objetos unicode,Objetos y códecs unicode
@anchor{c-api/unicode built-in-codecs}@anchor{4b98}@anchor{c-api/unicode builtincodecs}@anchor{4b94}
@subsubsection 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 @ref{237,,str()}.

Setting encoding to @code{NULL} causes the default encoding to be used
which is UTF-8.  The file system calls should use
@ref{da0,,PyUnicode_FSConverter()} for encoding file names. This uses the
@ref{5dd,,filesystem encoding and error handler} internally.

El manejo de errores se establece mediante `errors' que también pueden establecerse en @code{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 @ref{360,,ValueError}).

The codecs all use a similar interface.  Only deviations from the following
generic ones are documented for simplicity.

@menu
* Códecs genéricos:: 
* Códecs UTF-8:: 
* Códecs UTF-32:: 
* Códecs UTF-16:: 
* Códecs UTF-7:: 
* Códecs Unicode escapado:: 
* Códecs para Unicode escapado en bruto:: 
* Códecs Latin-1:: 
* Códecs ASCII:: 
* Códecs de mapa de caracteres:: 
* Códecs MBCS para Windows:: 
* Métodos & Ranuras (Slots): Métodos & Ranuras Slots. 

@end menu

@node Códecs genéricos,Códecs UTF-8,,Códecs incorporados
@anchor{c-api/unicode generic-codecs}@anchor{4b99}
@subsubsection Códecs genéricos


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

@geindex PyUnicode_Decode (C function)
@anchor{c-api/unicode c PyUnicode_Decode}@anchor{19eb}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Decode (const char *str, Py_ssize_t size, const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the encoded string `str'.
`encoding' and `errors' have the same meaning as the parameters of the same name
in the @ref{237,,str()} built-in function.  The codec to be used is looked up
using the Python codec registry.  Return @code{NULL} if an exception was raised by
the codec.
@end deffn

@geindex PyUnicode_AsEncodedString (C function)
@anchor{c-api/unicode c PyUnicode_AsEncodedString}@anchor{49e8}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsEncodedString (PyObject *unicode, const char *encoding, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @ref{96c,,encode()}. El códec que se utilizará se busca utilizando el registro de códec Python. Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs UTF-8,Códecs UTF-32,Códecs genéricos,Códecs incorporados
@anchor{c-api/unicode utf-8-codecs}@anchor{4b9a}
@subsubsection Códecs UTF-8


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

@geindex PyUnicode_DecodeUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF8}@anchor{49fb}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF8 (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the UTF-8 encoded string
`str'. Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_DecodeUTF8Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF8Stateful}@anchor{17a7}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF8Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Si `consumed' es @code{NULL}, se comporta como @ref{49fb,,PyUnicode_DecodeUTF8()}. Si `consumed' no es @code{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'.
@end deffn

@geindex PyUnicode_AsUTF8String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF8String}@anchor{11ff}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsUTF8String (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{NULL} si el códec provocó una excepción.

The function fails if the string contains surrogate code points
(@code{U+D800} - @code{U+DFFF}).
@end deffn

@geindex PyUnicode_AsUTF8AndSize (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF8AndSize}@anchor{931}
@deffn {C Función} const char *PyUnicode_AsUTF8AndSize (PyObject *unicode, Py_ssize_t *size)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
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 @code{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.

On error, set an exception, set `size' to @code{-1} (if it’s not NULL) and
return @code{NULL}.

The function fails if the string contains surrogate code points
(@code{U+D800} - @code{U+DFFF}).

This caches the UTF-8 representation of the string in the Unicode object, and
subsequent calls will return a pointer to the same buffer.  The caller is not
responsible for deallocating the buffer. The buffer is deallocated and
pointers to it become invalid when the Unicode object is garbage collected.


Added in version 3.3.



Distinto en la versión 3.7: El tipo de retorno ahora es @code{const char *} en lugar de @code{char *}.



Distinto en la versión 3.10: This function is a part of the @ref{488,,limited API}.

@end deffn

@geindex PyUnicode_AsUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF8}@anchor{c43}
@deffn {C Función} const char *PyUnicode_AsUTF8 (PyObject *unicode)

Como @ref{931,,PyUnicode_AsUTF8AndSize()}, pero no almacena el tamaño.


Added in version 3.3.



Distinto en la versión 3.7: El tipo de retorno ahora es @code{const char *} en lugar de @code{char *}.

@end deffn

@node Códecs UTF-32,Códecs UTF-16,Códecs UTF-8,Códecs incorporados
@anchor{c-api/unicode utf-32-codecs}@anchor{4b9b}
@subsubsection Códecs UTF-32


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

@geindex PyUnicode_DecodeUTF32 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF32}@anchor{49f7}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF32 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Decodifica `size' bytes de una cadena de búfer codificada UTF-32 y retorna el objeto Unicode correspondiente. `errors' (si no es @code{NULL}) define el manejo de errores. Su valor predeterminado es «estricto».

Si `byteorder' no es @code{NULL}, el decodificador comienza a decodificar utilizando el orden de bytes dado:

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

Si @code{*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 @code{*byteorder} es @code{-1} o @code{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 @code{NULL}, el códec se inicia en modo de orden nativo.

Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@geindex PyUnicode_DecodeUTF32Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF32Stateful}@anchor{49f8}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF32Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Si `consumed' es @code{NULL}, se comporta como @ref{49f7,,PyUnicode_DecodeUTF32()}. Si `consumed' no es @code{NULL}, @ref{49f8,,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'.
@end deffn

@geindex PyUnicode_AsUTF32String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF32String}@anchor{49ea}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsUTF32String (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs UTF-16,Códecs UTF-7,Códecs UTF-32,Códecs incorporados
@anchor{c-api/unicode utf-16-codecs}@anchor{4b9c}
@subsubsection Códecs UTF-16


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

@geindex PyUnicode_DecodeUTF16 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF16}@anchor{49f5}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF16 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Decodifica `size' bytes de una cadena de caracteres de búfer codificada UTF-16 y retorna el objeto Unicode correspondiente. `errors' (si no es @code{NULL}) define el manejo de errores. Su valor predeterminado es «estricto».

Si `byteorder' no es @code{NULL}, el decodificador comienza a decodificar utilizando el orden de bytes dado:

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

Si @code{*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 @code{*byteorder} es @code{-1} o @code{1}, cualquier marca de orden de bytes se copia en la salida (donde dará como resultado un @code{\ufeff} o un carácter @code{\ufffe}).

After completion, @code{*byteorder} is set to the current byte order at the end
of input data.

Si `byteorder' es @code{NULL}, el códec se inicia en modo de orden nativo.

Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@geindex PyUnicode_DecodeUTF16Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF16Stateful}@anchor{49f6}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF16Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Si `consumed' es @code{NULL}, se comporta como @ref{49f5,,PyUnicode_DecodeUTF16()}. Si `consumed' no es @code{NULL}, @ref{49f6,,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'.
@end deffn

@geindex PyUnicode_AsUTF16String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF16String}@anchor{49e9}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsUTF16String (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs UTF-7,Códecs Unicode escapado,Códecs UTF-16,Códecs incorporados
@anchor{c-api/unicode utf-7-codecs}@anchor{4b9d}
@subsubsection Códecs UTF-7


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

@geindex PyUnicode_DecodeUTF7 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF7}@anchor{49f9}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF7 (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the UTF-7 encoded string
`str'.  Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_DecodeUTF7Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF7Stateful}@anchor{49fa}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUTF7Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Si `consumed' es @code{NULL}, se comporta como @ref{49f9,,PyUnicode_DecodeUTF7()}. Si `consumed' no es @code{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'.
@end deffn

@node Códecs Unicode escapado,Códecs para Unicode escapado en bruto,Códecs UTF-7,Códecs incorporados
@anchor{c-api/unicode unicode-escape-codecs}@anchor{4b9e}
@subsubsection Códecs Unicode escapado


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

@geindex PyUnicode_DecodeUnicodeEscape (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUnicodeEscape}@anchor{49fc}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the Unicode-Escape encoded
string `str'.  Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_AsUnicodeEscapeString (C function)
@anchor{c-api/unicode c PyUnicode_AsUnicodeEscapeString}@anchor{1200}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsUnicodeEscapeString (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs para Unicode escapado en bruto,Códecs Latin-1,Códecs Unicode escapado,Códecs incorporados
@anchor{c-api/unicode raw-unicode-escape-codecs}@anchor{4b9f}
@subsubsection Códecs para Unicode escapado en bruto


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

@geindex PyUnicode_DecodeRawUnicodeEscape (C function)
@anchor{c-api/unicode c PyUnicode_DecodeRawUnicodeEscape}@anchor{49f4}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeRawUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the Raw-Unicode-Escape
encoded string `str'.  Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_AsRawUnicodeEscapeString (C function)
@anchor{c-api/unicode c PyUnicode_AsRawUnicodeEscapeString}@anchor{1201}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsRawUnicodeEscapeString (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs Latin-1,Códecs ASCII,Códecs para Unicode escapado en bruto,Códecs incorporados
@anchor{c-api/unicode latin-1-codecs}@anchor{4ba0}
@subsubsection 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.

@geindex PyUnicode_DecodeLatin1 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLatin1}@anchor{49f0}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeLatin1 (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the Latin-1 encoded string
`str'.  Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_AsLatin1String (C function)
@anchor{c-api/unicode c PyUnicode_AsLatin1String}@anchor{1202}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsLatin1String (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Codifica un objeto Unicode usando Latin-1 y retorna el resultado como un objeto de bytes Python. El manejo de errores es «estricto». Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs ASCII,Códecs de mapa de caracteres,Códecs Latin-1,Códecs incorporados
@anchor{c-api/unicode ascii-codecs}@anchor{4ba1}
@subsubsection 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.

@geindex PyUnicode_DecodeASCII (C function)
@anchor{c-api/unicode c PyUnicode_DecodeASCII}@anchor{49ed}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeASCII (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the ASCII encoded string
`str'.  Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_AsASCIIString (C function)
@anchor{c-api/unicode c PyUnicode_AsASCIIString}@anchor{1203}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsASCIIString (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Codifica un objeto Unicode usando ASCII y retorna el resultado como un objeto de bytes de Python. El manejo de errores es «estricto». Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@node Códecs de mapa de caracteres,Códecs MBCS para Windows,Códecs ASCII,Códecs incorporados
@anchor{c-api/unicode character-map-codecs}@anchor{4ba2}
@subsubsection Códecs de mapa de caracteres


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 @code{encodings} package). The codec uses mappings to encode and
decode characters.  The mapping objects provided must support the
@ref{3d8,,__getitem__()} mapping interface; dictionaries and sequences work well.

Estos son las API de códec de mapeo:

@geindex PyUnicode_DecodeCharmap (C function)
@anchor{c-api/unicode c PyUnicode_DecodeCharmap}@anchor{49ee}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeCharmap (const char *str, Py_ssize_t length, PyObject *mapping, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Create a Unicode object by decoding `size' bytes of the encoded string `str'
using the given `mapping' object.  Return @code{NULL} if an exception was raised
by the codec.

Si `mapping' es @code{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 @code{None}. Los bytes de datos sin asignar - los que causan un @ref{21d5,,LookupError}, así como los que se asignan a @code{None}, @code{0xFFFE} o @code{'\ ufffe'}, se tratan como asignaciones indefinidas y causan un error.
@end deffn

@geindex PyUnicode_AsCharmapString (C function)
@anchor{c-api/unicode c PyUnicode_AsCharmapString}@anchor{49e7}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsCharmapString (PyObject *unicode, PyObject *mapping)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
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 @code{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 @code{None}. Los ordinales de caracteres no asignados (los que causan un @ref{21d5,,LookupError}), así como los asignados a @code{Ninguno}, se tratan como «mapeo indefinido» y causan un error.
@end deffn

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

@geindex PyUnicode_Translate (C function)
@anchor{c-api/unicode c PyUnicode_Translate}@anchor{4a06}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Translate (PyObject *unicode, PyObject *table, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Traduce una cadena de caracteres aplicando una tabla de mapeo y retornando  el objeto Unicode resultante. Retorna @code{NULL} cuando el códec provocó una excepción.

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

Mapping tables need only provide the @ref{3d8,,__getitem__()} interface; dictionaries
and sequences work well.  Unmapped character ordinals (ones which cause a
@ref{21d5,,LookupError}) are left untouched and are copied as-is.

`errors' tiene el significado habitual para los códecs. Puede ser @code{NULL}, lo que indica que debe usar el manejo de errores predeterminado.
@end deffn

@node Códecs MBCS para Windows,Métodos & Ranuras Slots,Códecs de mapa de caracteres,Códecs incorporados
@anchor{c-api/unicode mbcs-codecs-for-windows}@anchor{4ba3}
@subsubsection 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.

@geindex PyUnicode_DecodeMBCS (C function)
@anchor{c-api/unicode c PyUnicode_DecodeMBCS}@anchor{49f2}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeMBCS (const char *str, Py_ssize_t size, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Create a Unicode object by decoding `size' bytes of the MBCS encoded string `str'.
Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_DecodeMBCSStateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeMBCSStateful}@anchor{49f3}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_DecodeMBCSStateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Si `consumed' es @code{NULL}, se comporta como @ref{49f2,,PyUnicode_DecodeMBCS()}. Si `consumed' no es @code{NULL}, @ref{49f3,,PyUnicode_DecodeMBCSStateful()} no decodificará el byte inicial y el número de bytes que se han decodificado se almacenará en `consumed'.
@end deffn

@geindex PyUnicode_AsMBCSString (C function)
@anchor{c-api/unicode c PyUnicode_AsMBCSString}@anchor{1204}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_AsMBCSString (PyObject *unicode)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Codifica un objeto Unicode usando MBCS y retorna el resultado como un objeto de bytes de Python. El manejo de errores es «estricto». Retorna @code{NULL} si el códec provocó una excepción.
@end deffn

@geindex PyUnicode_EncodeCodePage (C function)
@anchor{c-api/unicode c PyUnicode_EncodeCodePage}@anchor{1205}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_EncodeCodePage (int code_page, PyObject *unicode, const char *errors)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} on Windows since version 3.7.'
Encode the Unicode object using the specified code page and return a Python
bytes object.  Return @code{NULL} if an exception was raised by the codec. Use
@code{CP_ACP} code page to get the MBCS encoder.


Added in version 3.3.

@end deffn

@node Métodos & Ranuras Slots,,Códecs MBCS para Windows,Códecs incorporados
@anchor{c-api/unicode methods-slots}@anchor{4ba4}
@subsubsection Métodos & Ranuras (`Slots')


@node Métodos y funciones de ranura Slot,PyUnicodeWriter,Códecs incorporados,Objetos y códecs unicode
@anchor{c-api/unicode methods-and-slot-functions}@anchor{4ba5}@anchor{c-api/unicode unicodemethodsandslots}@anchor{4ba6}
@subsubsection 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 @code{NULL} o @code{-1} si ocurre una excepción.

@geindex PyUnicode_Concat (C function)
@anchor{c-api/unicode c PyUnicode_Concat}@anchor{1210}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Concat (PyObject *left, PyObject *right)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Une dos cadenas de caracteres que dan una nueva cadena de caracteres Unicode.
@end deffn

@geindex PyUnicode_Split (C function)
@anchor{c-api/unicode c PyUnicode_Split}@anchor{4a04}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Split (PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Divide una cadena de caracteres dando una lista de cadenas de caracteres Unicode. Si `sep' es @code{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.
@end deffn

@geindex PyUnicode_Splitlines (C function)
@anchor{c-api/unicode c PyUnicode_Splitlines}@anchor{4a05}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Splitlines (PyObject *unicode, int keepends)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Split a Unicode string at line breaks, returning a list of Unicode strings.
CRLF is considered to be one line break.  If `keepends' is @code{0}, the Line break
characters are not included in the resulting strings.
@end deffn

@geindex PyUnicode_Join (C function)
@anchor{c-api/unicode c PyUnicode_Join}@anchor{1211}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Join (PyObject *separator, PyObject *seq)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Une una secuencia de cadenas de caracteres usando el `separator' dado y retorna la cadena de caracteres Unicode resultante.
@end deffn

@geindex PyUnicode_Tailmatch (C function)
@anchor{c-api/unicode c PyUnicode_Tailmatch}@anchor{94f}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_Tailmatch (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` Part of the @ref{5f6,,Stable ABI}.'
Return @code{1} if `substr' matches @code{unicode[start:end]} at the given tail end
(`direction' == @code{-1} means to do a prefix match, `direction' == @code{1} a suffix match),
@code{0} otherwise. Return @code{-1} if an error occurred.
@end deffn

@geindex PyUnicode_Find (C function)
@anchor{c-api/unicode c PyUnicode_Find}@anchor{49fd}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_Find (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` Part of the @ref{5f6,,Stable ABI}.'
Return the first position of `substr' in @code{unicode[start:end]} using the given
`direction' (`direction' == @code{1} means to do a forward search, `direction' == @code{-1} a
backward search).  The return value is the index of the first match; a value of
@code{-1} indicates that no match was found, and @code{-2} indicates that an error
occurred and an exception has been set.
@end deffn

@geindex PyUnicode_FindChar (C function)
@anchor{c-api/unicode c PyUnicode_FindChar}@anchor{950}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_FindChar (PyObject *unicode, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Return the first position of the character `ch' in @code{unicode[start:end]} using
the given `direction' (`direction' == @code{1} means to do a forward search,
`direction' == @code{-1} a backward search).  The return value is the index of the
first match; a value of @code{-1} indicates that no match was found, and @code{-2}
indicates that an error occurred and an exception has been set.


Added in version 3.3.



Distinto en la versión 3.7: `start' and `end' are now adjusted to behave like @code{unicode[start:end]}.

@end deffn

@geindex PyUnicode_Count (C function)
@anchor{c-api/unicode c PyUnicode_Count}@anchor{49ec}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnicode_Count (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end)
` Part of the @ref{5f6,,Stable ABI}.'
Return the number of non-overlapping occurrences of `substr' in
@code{unicode[start:end]}.  Return @code{-1} if an error occurred.
@end deffn

@geindex PyUnicode_Replace (C function)
@anchor{c-api/unicode c PyUnicode_Replace}@anchor{4a02}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Replace (PyObject *unicode, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Replace at most `maxcount' occurrences of `substr' in `unicode' with `replstr' and
return the resulting Unicode object. `maxcount' == @code{-1} means replace all
occurrences.
@end deffn

@geindex PyUnicode_Compare (C function)
@anchor{c-api/unicode c PyUnicode_Compare}@anchor{94e}
@deffn {C Función} int PyUnicode_Compare (PyObject *left, PyObject *right)
` Part of the @ref{5f6,,Stable ABI}.'
Compara dos cadenas de caracteres y retorna @code{-1}, @code{0}, @code{1} para menor que, igual y mayor que, respectivamente.

Esta función retorna @code{-1} en caso de falla, por lo que se debe llamar a @ref{18fa,,PyErr_Occurred()} para verificar si hay errores.


@subsubheading Ver también


The @ref{26a,,PyUnicode_Equal()} function.

@end deffn

@geindex PyUnicode_Equal (C function)
@anchor{c-api/unicode c PyUnicode_Equal}@anchor{26a}
@deffn {C Función} int PyUnicode_Equal (PyObject *a, PyObject *b)
` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Test if two strings are equal:


@itemize *

@item 
Return @code{1} if `a' is equal to `b'.

@item 
Return @code{0} if `a' is not equal to `b'.

@item 
Set a @ref{228,,TypeError} exception and return @code{-1} if `a' or `b' is not a
@ref{237,,str} object.
@end itemize

The function always succeeds if `a' and `b' are @ref{237,,str} objects.

The function works for @ref{237,,str} subclasses, but does not honor custom
@code{__eq__()} method.


@subsubheading Ver también


The @ref{94e,,PyUnicode_Compare()} function.



Added in version 3.14.

@end deffn

@geindex PyUnicode_EqualToUTF8AndSize (C function)
@anchor{c-api/unicode c PyUnicode_EqualToUTF8AndSize}@anchor{46a}
@deffn {C Función} int PyUnicode_EqualToUTF8AndSize (PyObject *unicode, const char *string, Py_ssize_t size)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Compare a Unicode object with a char buffer which is interpreted as
being UTF-8 or ASCII encoded and return true (@code{1}) if they are equal,
or false (@code{0}) otherwise.
If the Unicode object contains surrogate code points
(@code{U+D800} - @code{U+DFFF}) or the C string is not valid UTF-8,
false (@code{0}) is returned.

Esta función no lanza excepciones.


Added in version 3.13.

@end deffn

@geindex PyUnicode_EqualToUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_EqualToUTF8}@anchor{46b}
@deffn {C Función} int PyUnicode_EqualToUTF8 (PyObject *unicode, const char *string)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{46a,,PyUnicode_EqualToUTF8AndSize()}, but compute `string'
length using @code{strlen()}.
If the Unicode object contains null characters, false (@code{0}) is returned.


Added in version 3.13.

@end deffn

@geindex PyUnicode_CompareWithASCIIString (C function)
@anchor{c-api/unicode c PyUnicode_CompareWithASCIIString}@anchor{12d5}
@deffn {C Función} int PyUnicode_CompareWithASCIIString (PyObject *unicode, const char *string)
` Part of the @ref{5f6,,Stable ABI}.'
Compare a Unicode object, `unicode', with `string' and return @code{-1}, @code{0}, @code{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.

Esta función no lanza excepciones.
@end deffn

@geindex PyUnicode_RichCompare (C function)
@anchor{c-api/unicode c PyUnicode_RichCompare}@anchor{4a03}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_RichCompare (PyObject *left, PyObject *right, int op)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Comparación enriquecida de dos cadenas de caracteres Unicode y retorna uno de los siguientes:


@itemize *

@item 
@code{NULL} en caso de que se produzca una excepción

@item 
@ref{4b49,,Py_True} or @ref{4b48,,Py_False} for successful comparisons

@item 
@ref{4abe,,Py_NotImplemented} in case the type combination is unknown
@end itemize

Possible values for `op' are @ref{4ac6,,Py_GT}, @ref{4ac7,,Py_GE}, @ref{4ac4,,Py_EQ},
@ref{4ac5,,Py_NE}, @ref{4ac2,,Py_LT}, and @ref{4ac3,,Py_LE}.
@end deffn

@geindex PyUnicode_Format (C function)
@anchor{c-api/unicode c PyUnicode_Format}@anchor{49fe}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_Format (PyObject *format, PyObject *args)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo objeto de cadena de caracteres desde `format' y `args'; esto es análogo al @code{format % args}.
@end deffn

@geindex PyUnicode_Contains (C function)
@anchor{c-api/unicode c PyUnicode_Contains}@anchor{49eb}
@deffn {C Función} int PyUnicode_Contains (PyObject *unicode, PyObject *substr)
` Part of the @ref{5f6,,Stable ABI}.'
Check whether `substr' is contained in `unicode' and return true or false
accordingly.

`substr' has to coerce to a one element Unicode string. @code{-1} is returned
if there was an error.
@end deffn

@geindex PyUnicode_InternInPlace (C function)
@anchor{c-api/unicode c PyUnicode_InternInPlace}@anchor{948}
@deffn {C Función} void PyUnicode_InternInPlace (PyObject **p_unicode)
` Part of the @ref{5f6,,Stable ABI}.'
Intern the argument *@ref{948,,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 *@ref{948,,p_unicode}, it sets *@ref{948,,p_unicode} to
it (releasing the reference to the old string object and creating a new
@ref{431,,strong reference} to the interned string object), otherwise it leaves
*@ref{948,,p_unicode} alone and interns it.

(Clarification: even though there is a lot of talk about references, think
of this function as reference-neutral. You must own the object you pass in;
after the call you no longer own the passed-in reference, but you newly own
the result.)

This function never raises an exception.
On error, it leaves its argument unchanged without interning it.

Instances of subclasses of @ref{237,,str} may not be interned, that is,
@ref{4b7d,,PyUnicode_CheckExact}(*@ref{948,,p_unicode}) must be true. If it is not,
then – as with any other error – the argument is left unchanged.

Note that interned strings are not “immortal”.
You must keep a reference to the result to benefit from interning.
@end deffn

@geindex PyUnicode_InternFromString (C function)
@anchor{c-api/unicode c PyUnicode_InternFromString}@anchor{1622}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicode_InternFromString (const char *str)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
A combination of @ref{48a3,,PyUnicode_FromString()} and
@ref{948,,PyUnicode_InternInPlace()}, meant for statically allocated strings.

Return a new («owned») reference to either a new Unicode string object
that has been interned, or an earlier interned string object with the
same value.

Python may keep a reference to the result, or make it @ref{429d,,immortal},
preventing it from being garbage-collected promptly.
For interning an unbounded number of different strings, such as ones coming
from user input, prefer calling @ref{48a3,,PyUnicode_FromString()} and
@ref{948,,PyUnicode_InternInPlace()} directly.

`Detalles de implementación de CPython:' Strings interned this way are made @ref{429d,,immortal}.
@end deffn

@node PyUnicodeWriter,,Métodos y funciones de ranura Slot,Objetos y códecs unicode
@anchor{c-api/unicode pyunicodewriter}@anchor{4ba7}
@subsubsection PyUnicodeWriter


The @ref{236,,PyUnicodeWriter} API can be used to create a Python @ref{237,,str}
object.


Added in version 3.14.


@geindex PyUnicodeWriter (C type)
@anchor{c-api/unicode c PyUnicodeWriter}@anchor{236}
@deffn {C Tipo} type PyUnicodeWriter

A Unicode writer instance.

The instance must be destroyed by @ref{23b,,PyUnicodeWriter_Finish()} on
success, or @ref{23a,,PyUnicodeWriter_Discard()} on error.
@end deffn

@geindex PyUnicodeWriter_Create (C function)
@anchor{c-api/unicode c PyUnicodeWriter_Create}@anchor{238}
@deffn {C Función} @ref{236,,PyUnicodeWriter} *PyUnicodeWriter_Create (Py_ssize_t length)

Create a Unicode writer instance.

Set an exception and return @code{NULL} on error.
@end deffn

@geindex PyUnicodeWriter_Finish (C function)
@anchor{c-api/unicode c PyUnicodeWriter_Finish}@anchor{23b}
@deffn {C Función} @ref{42d,,PyObject} *PyUnicodeWriter_Finish (PyUnicodeWriter *writer)

Return the final Python @ref{237,,str} object and destroy the writer instance.

Set an exception and return @code{NULL} on error.
@end deffn

@geindex PyUnicodeWriter_Discard (C function)
@anchor{c-api/unicode c PyUnicodeWriter_Discard}@anchor{23a}
@deffn {C Función} void PyUnicodeWriter_Discard (PyUnicodeWriter *writer)

Discard the internal Unicode buffer and destroy the writer instance.

If `writer' is @code{NULL}, no operation is performed.
@end deffn

@geindex PyUnicodeWriter_WriteChar (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteChar}@anchor{23d}
@deffn {C Función} int PyUnicodeWriter_WriteChar (PyUnicodeWriter *writer, Py_UCS4 ch)

Write the single Unicode character `ch' into `writer'.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_WriteUTF8 (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteUTF8}@anchor{242}
@deffn {C Función} int PyUnicodeWriter_WriteUTF8 (PyUnicodeWriter *writer, const char *str, Py_ssize_t size)

Decode the string `str' from UTF-8 in strict mode and write the output into `writer'.

`size' is the string length in bytes. If `size' is equal to @code{-1}, call
@code{strlen(str)} to get the string length.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.

See also @ref{239,,PyUnicodeWriter_DecodeUTF8Stateful()}.
@end deffn

@geindex PyUnicodeWriter_WriteWideChar (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteWideChar}@anchor{243}
@deffn {C Función} int PyUnicodeWriter_WriteWideChar (PyUnicodeWriter *writer, const wchar_t *str, Py_ssize_t size)

Writer the wide string `str' into `writer'.

`size' is a number of wide characters. If `size' is equal to @code{-1}, call
@code{wcslen(str)} to get the string length.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_WriteUCS4 (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteUCS4}@anchor{241}
@deffn {C Función} int PyUnicodeWriter_WriteUCS4 (PyUnicodeWriter *writer, Py_UCS4 *str, Py_ssize_t size)

Writer the UCS4 string `str' into `writer'.

`size' is a number of UCS4 characters.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_WriteStr (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteStr}@anchor{23f}
@deffn {C Función} int PyUnicodeWriter_WriteStr (PyUnicodeWriter *writer, PyObject *obj)

Call @ref{10ac,,PyObject_Str()} on `obj' and write the output into `writer'.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_WriteRepr (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteRepr}@anchor{23e}
@deffn {C Función} int PyUnicodeWriter_WriteRepr (PyUnicodeWriter *writer, PyObject *obj)

Call @ref{10ab,,PyObject_Repr()} on `obj' and write the output into `writer'.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_WriteSubstring (C function)
@anchor{c-api/unicode c PyUnicodeWriter_WriteSubstring}@anchor{240}
@deffn {C Función} int PyUnicodeWriter_WriteSubstring (PyUnicodeWriter *writer, PyObject *str, Py_ssize_t start, Py_ssize_t end)

Write the substring @code{str[start:end]} into `writer'.

`str' must be Python @ref{237,,str} object. `start' must be greater than or
equal to 0, and less than or equal to `end'. `end' must be less than or
equal to `str' length.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_Format (C function)
@anchor{c-api/unicode c PyUnicodeWriter_Format}@anchor{23c}
@deffn {C Función} int PyUnicodeWriter_Format (PyUnicodeWriter *writer, const char *format, ...)

Similar to @ref{47c,,PyUnicode_FromFormat()}, but write the output directly into `writer'.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.
@end deffn

@geindex PyUnicodeWriter_DecodeUTF8Stateful (C function)
@anchor{c-api/unicode c PyUnicodeWriter_DecodeUTF8Stateful}@anchor{239}
@deffn {C Función} int PyUnicodeWriter_DecodeUTF8Stateful (PyUnicodeWriter *writer, const char *string, Py_ssize_t length, const char *errors, Py_ssize_t *consumed)

Decode the string `str' from UTF-8 with `errors' error handler and write the
output into `writer'.

`size' is the string length in bytes. If `size' is equal to @code{-1}, call
@code{strlen(str)} to get the string length.

`errors' is an error handler name, such as @code{"replace"}. If `errors' is
@code{NULL}, use the strict error handler.

If `consumed' is not @code{NULL}, set `*consumed' to the number of decoded
bytes on success.
If `consumed' is @code{NULL}, treat trailing incomplete UTF-8 byte sequences
as an error.

On success, return @code{0}.
On error, set an exception, leave the writer unchanged, and return @code{-1}.

See also @ref{242,,PyUnicodeWriter_WriteUTF8()}.
@end deffn

@node Objetos tupla,Objetos de secuencia de estructura,Objetos y códecs unicode,Objetos de secuencia
@anchor{c-api/tuple doc}@anchor{4ba8}@anchor{c-api/tuple tuple-objects}@anchor{4ba9}@anchor{c-api/tuple tupleobjects}@anchor{4baa}
@subsubsection Objetos tupla


@geindex object;tuple

@geindex PyTupleObject (C type)
@anchor{c-api/tuple c PyTupleObject}@anchor{4a76}
@deffn {C Tipo} type PyTupleObject

Este subtipo de @ref{42d,,PyObject} representa un objeto tupla de Python.
@end deffn

@geindex PyTuple_Type (C var)
@anchor{c-api/tuple c PyTuple_Type}@anchor{49cb}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyTuple_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo tupla de Python; es el mismo objeto que @ref{464,,tuple} en la capa de Python.
@end deffn

@geindex PyTuple_Check (C function)
@anchor{c-api/tuple c PyTuple_Check}@anchor{4bab}
@deffn {C Función} int PyTuple_Check (PyObject *p)

Retorna verdadero si `p' es un objeto tupla o una instancia de un subtipo del tipo tupla. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyTuple_CheckExact (C function)
@anchor{c-api/tuple c PyTuple_CheckExact}@anchor{4bac}
@deffn {C Función} int PyTuple_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto tupla pero no una instancia de un subtipo del tipo tupla. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyTuple_New (C function)
@anchor{c-api/tuple c PyTuple_New}@anchor{490}
@deffn {C Función} @ref{42d,,PyObject} *PyTuple_New (Py_ssize_t len)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new tuple object of size `len',
or @code{NULL} with an exception set on failure.
@end deffn

@geindex PyTuple_Pack (C function)
@anchor{c-api/tuple c PyTuple_Pack}@anchor{49c9}
@deffn {C Función} @ref{42d,,PyObject} *PyTuple_Pack (Py_ssize_t n, ...)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new tuple object of size `n',
or @code{NULL} with an exception set on failure. The tuple values
are initialized to the subsequent `n' C arguments pointing to Python objects.
@code{PyTuple_Pack(2, a, b)} is equivalent to @code{Py_BuildValue("(OO)", a, b)}.
@end deffn

@geindex PyTuple_Size (C function)
@anchor{c-api/tuple c PyTuple_Size}@anchor{49ca}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyTuple_Size (PyObject *p)
` Part of the @ref{5f6,,Stable ABI}.'
Take a pointer to a tuple object, and return the size of that tuple.
On error, return @code{-1} and with an exception set.
@end deffn

@geindex PyTuple_GET_SIZE (C function)
@anchor{c-api/tuple c PyTuple_GET_SIZE}@anchor{4bad}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyTuple_GET_SIZE (PyObject *p)

Like @ref{49ca,,PyTuple_Size()}, but without error checking.
@end deffn

@geindex PyTuple_GetItem (C function)
@anchor{c-api/tuple c PyTuple_GetItem}@anchor{4848}
@deffn {C Función} @ref{42d,,PyObject} *PyTuple_GetItem (PyObject *p, Py_ssize_t pos)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el objeto en la posición `pos' en la tupla señalada por `p'. Si `pos' es negativo o está fuera de los límites, retorna @code{NULL} y establece una excepción @ref{1575,,IndexError}.

The returned reference is borrowed from the tuple `p'
(that is: it is only valid as long as you hold a reference to `p').
To get a @ref{431,,strong reference}, use
@ref{932,,Py_NewRef(PyTuple_GetItem(...))}
or @ref{1a5a,,PySequence_GetItem()}.
@end deffn

@geindex PyTuple_GET_ITEM (C function)
@anchor{c-api/tuple c PyTuple_GET_ITEM}@anchor{4bae}
@deffn {C Función} @ref{42d,,PyObject} *PyTuple_GET_ITEM (PyObject *p, Py_ssize_t pos)
`Return value: Borrowed reference.'
Como @ref{4848,,PyTuple_GetItem()}, pero no verifica sus argumentos.
@end deffn

@geindex PyTuple_GetSlice (C function)
@anchor{c-api/tuple c PyTuple_GetSlice}@anchor{49c8}
@deffn {C Función} @ref{42d,,PyObject} *PyTuple_GetSlice (PyObject *p, Py_ssize_t low, Py_ssize_t high)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return the slice of the tuple pointed to by `p' between `low' and `high',
or @code{NULL} with an exception set on failure.

This is the equivalent of the Python expression @code{p[low:high]}.
Indexing from the end of the tuple is not supported.
@end deffn

@geindex PyTuple_SetItem (C function)
@anchor{c-api/tuple c PyTuple_SetItem}@anchor{4849}
@deffn {C Función} int PyTuple_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Inserta una referencia al objeto `o' en la posición `pos' de la tupla señalada por `p'. Retorna @code{0} en caso de éxito. Si `pos' está fuera de límites, retorna @code{-1} y establece una excepción @ref{1575,,IndexError}.

@cartouche
@quotation Nota 
Esta función «roba» una referencia a `o' y descarta una referencia a un elemento que ya está en la tupla en la posición afectada.
@end quotation
@end cartouche
@end deffn

@geindex PyTuple_SET_ITEM (C function)
@anchor{c-api/tuple c PyTuple_SET_ITEM}@anchor{47f}
@deffn {C Función} void PyTuple_SET_ITEM (PyObject *p, Py_ssize_t pos, PyObject *o)

Al igual que @ref{4849,,PyTuple_SetItem()}, pero no realiza ninguna comprobación de errores, y debe `solo' usarse para completar tuplas nuevas.

Bounds checking is performed as an assertion if Python is built in
@ref{357,,debug mode} or @ref{47e,,with assertions}.

@cartouche
@quotation Nota 
Esta función «roba» una referencia a `o' y, a diferencia de @ref{4849,,PyTuple_SetItem()}, `no' descarta una referencia a ningún elemento que se está reemplazando; cualquier referencia en la tupla en la posición `pos' se filtrará.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
This macro should `only' be used on tuples that are newly created.
Using this macro on a tuple that is already in use (or in other words, has
a refcount > 1) could lead to undefined behavior.
@end quotation
@end cartouche
@end deffn

@geindex _PyTuple_Resize (C function)
@anchor{c-api/tuple c _PyTuple_Resize}@anchor{154d}
@deffn {C Función} int _PyTuple_Resize (PyObject **p, Py_ssize_t newsize)

Se puede usar para cambiar el tamaño de una tupla. `newsize' será el nuevo tamaño de la tupla. Debido a que se `supone' que las tuplas son inmutables, esto solo debe usarse si solo hay una referencia al objeto. `No' use esto si la tupla ya puede ser conocida por alguna otra parte del código. La tupla siempre crecerá o disminuirá al final. Piense en esto como destruir la antigua tupla y crear una nueva, solo que de manera más eficiente. Retorna @code{0} en caso de éxito. El código del cliente nunca debe suponer que el valor resultante de @code{*p} será el mismo que antes de llamar a esta función. Si se reemplaza el objeto referenciado por @code{*p}, se destruye el original @code{*p}. En caso de fallo, retorna @code{-1} y establece @code{*p} en @code{NULL}, y lanza @ref{16cb,,MemoryError} o @ref{619,,SystemError}.
@end deffn

@node Objetos de secuencia de estructura,Objetos lista,Objetos tupla,Objetos de secuencia
@anchor{c-api/tuple id1}@anchor{4baf}@anchor{c-api/tuple struct-sequence-objects}@anchor{122c}
@subsubsection Objetos de secuencia de estructura


Los objetos de secuencia de estructura son el equivalente en C de los objetos @ref{32d,,namedtuple()}, es decir, una secuencia a cuyos elementos también se puede acceder a través de atributos. Para crear una secuencia de estructura, primero debe crear un tipo de secuencia de estructura específico.

@geindex PyStructSequence_NewType (C function)
@anchor{c-api/tuple c PyStructSequence_NewType}@anchor{49bb}
@deffn {C Función} @ref{b30,,PyTypeObject} *PyStructSequence_NewType (PyStructSequence_Desc *desc)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un nuevo tipo de secuencia de estructura a partir de los datos en `desc', que se describen a continuación. Las instancias del tipo resultante se pueden crear con @ref{49ba,,PyStructSequence_New()}.

Return @code{NULL} with an exception set on failure.
@end deffn

@geindex PyStructSequence_InitType (C function)
@anchor{c-api/tuple c PyStructSequence_InitType}@anchor{107f}
@deffn {C Función} void PyStructSequence_InitType (PyTypeObject *type, PyStructSequence_Desc *desc)

Inicializa una secuencia de estructura tipo `type' desde `desc' en su lugar.
@end deffn

@geindex PyStructSequence_InitType2 (C function)
@anchor{c-api/tuple c PyStructSequence_InitType2}@anchor{107e}
@deffn {C Función} int PyStructSequence_InitType2 (PyTypeObject *type, PyStructSequence_Desc *desc)

Like @ref{107f,,PyStructSequence_InitType()}, but returns @code{0} on success
and @code{-1} with an exception set on failure.


Added in version 3.4.

@end deffn

@geindex PyStructSequence_Desc (C type)
@anchor{c-api/tuple c PyStructSequence_Desc}@anchor{c42}
@deffn {C Tipo} type PyStructSequence_Desc
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Contiene la meta información de un tipo de secuencia de estructura para crear.

@geindex PyStructSequence_Desc.name (C member)
@anchor{c-api/tuple c PyStructSequence_Desc name}@anchor{4bb0}
@deffn {C Miembro} const char *name

Fully qualified name of the type; null-terminated UTF-8 encoded.
The name must contain the module name.
@end deffn

@geindex PyStructSequence_Desc.doc (C member)
@anchor{c-api/tuple c PyStructSequence_Desc doc}@anchor{4bb1}
@deffn {C Miembro} const char *doc

Puntero al `docstring' para el tipo o @code{NULL} para omitir
@end deffn

@geindex PyStructSequence_Desc.fields (C member)
@anchor{c-api/tuple c PyStructSequence_Desc fields}@anchor{4bb2}
@deffn {C Miembro} @ref{c41,,PyStructSequence_Field} *fields

Puntero al arreglo terminado en @code{NULL} con nombres de campo del nuevo tipo
@end deffn

@geindex PyStructSequence_Desc.n_in_sequence (C member)
@anchor{c-api/tuple c PyStructSequence_Desc n_in_sequence}@anchor{4bb3}
@deffn {C Miembro} int n_in_sequence

Cantidad de campos visibles para el lado de Python (si se usa como tupla)
@end deffn
@end deffn

@geindex PyStructSequence_Field (C type)
@anchor{c-api/tuple c PyStructSequence_Field}@anchor{c41}
@deffn {C Tipo} type PyStructSequence_Field
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Describe un campo de una secuencia de estructura. Como una secuencia de estructura se modela como una tupla, todos los campos se escriben como @ref{42d,,PyObject}*. El índice en el arreglo @ref{4bb2,,fields} de @ref{c42,,PyStructSequence_Desc} determina qué campo de la secuencia de estructura se describe.

@geindex PyStructSequence_Field.name (C member)
@anchor{c-api/tuple c PyStructSequence_Field name}@anchor{4bb4}
@deffn {C Miembro} const char *name

Nombre para el campo o @code{NULL} para finalizar la lista de campos con nombre, establece en @ref{a14,,PyStructSequence_UnnamedField} para dejar sin nombre
@end deffn

@geindex PyStructSequence_Field.doc (C member)
@anchor{c-api/tuple c PyStructSequence_Field doc}@anchor{4bb5}
@deffn {C Miembro} const char *doc

Campo `docstring' o @code{NULL} para omitir
@end deffn
@end deffn

@geindex PyStructSequence_UnnamedField (C var)
@anchor{c-api/tuple c PyStructSequence_UnnamedField}@anchor{a14}
@deffn {C Variable} const char *const PyStructSequence_UnnamedField
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Valor especial para un nombre de campo para dejarlo sin nombre.


Distinto en la versión 3.9: El tipo se cambió de @code{char *}.

@end deffn

@geindex PyStructSequence_New (C function)
@anchor{c-api/tuple c PyStructSequence_New}@anchor{49ba}
@deffn {C Función} @ref{42d,,PyObject} *PyStructSequence_New (PyTypeObject *type)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea una instancia de `type', que debe haberse creado con @ref{49bb,,PyStructSequence_NewType()}.

Return @code{NULL} with an exception set on failure.
@end deffn

@geindex PyStructSequence_GetItem (C function)
@anchor{c-api/tuple c PyStructSequence_GetItem}@anchor{49b9}
@deffn {C Función} @ref{42d,,PyObject} *PyStructSequence_GetItem (PyObject *p, Py_ssize_t pos)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return the object at position `pos' in the struct sequence pointed to by `p'.

Bounds checking is performed as an assertion if Python is built in
@ref{357,,debug mode} or @ref{47e,,with assertions}.
@end deffn

@geindex PyStructSequence_GET_ITEM (C function)
@anchor{c-api/tuple c PyStructSequence_GET_ITEM}@anchor{4bb6}
@deffn {C Función} @ref{42d,,PyObject} *PyStructSequence_GET_ITEM (PyObject *p, Py_ssize_t pos)
`Return value: Borrowed reference.'
Alias to @ref{49b9,,PyStructSequence_GetItem()}.


Distinto en la versión 3.13: Now implemented as an alias to @ref{49b9,,PyStructSequence_GetItem()}.

@end deffn

@geindex PyStructSequence_SetItem (C function)
@anchor{c-api/tuple c PyStructSequence_SetItem}@anchor{49bc}
@deffn {C Función} void PyStructSequence_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el campo en el índice `pos' de la secuencia de estructura `p' en el valor `o'. Como @ref{47f,,PyTuple_SET_ITEM()}, esto solo debe usarse para completar instancias nuevas.

Bounds checking is performed as an assertion if Python is built in
@ref{357,,debug mode} or @ref{47e,,with assertions}.

@cartouche
@quotation Nota 
Esta función «roba» una referencia a `o'.
@end quotation
@end cartouche
@end deffn

@geindex PyStructSequence_SET_ITEM (C function)
@anchor{c-api/tuple c PyStructSequence_SET_ITEM}@anchor{4bb7}
@deffn {C Función} void PyStructSequence_SET_ITEM (PyObject *p, Py_ssize_t *pos, PyObject *o)

Alias to @ref{49bc,,PyStructSequence_SetItem()}.


Distinto en la versión 3.13: Now implemented as an alias to @ref{49bc,,PyStructSequence_SetItem()}.

@end deffn

@node Objetos lista,,Objetos de secuencia de estructura,Objetos de secuencia
@anchor{c-api/list doc}@anchor{4bb8}@anchor{c-api/list list-objects}@anchor{4bb9}@anchor{c-api/list listobjects}@anchor{4bba}
@subsubsection Objetos lista


@geindex object;list

@geindex PyListObject (C type)
@anchor{c-api/list c PyListObject}@anchor{4add}
@deffn {C Tipo} type PyListObject

Este subtipo de @ref{42d,,PyObject} representa un objeto lista de Python.
@end deffn

@geindex PyList_Type (C var)
@anchor{c-api/list c PyList_Type}@anchor{486c}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyList_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo de lista de Python. Este es el mismo objeto que @ref{18e,,list} en la capa de Python.
@end deffn

@geindex PyList_Check (C function)
@anchor{c-api/list c PyList_Check}@anchor{4bbb}
@deffn {C Función} int PyList_Check (PyObject *p)

Retorna verdadero si `p' es un objeto de lista o una instancia de un subtipo del tipo lista. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyList_CheckExact (C function)
@anchor{c-api/list c PyList_CheckExact}@anchor{4bbc}
@deffn {C Función} int PyList_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto lista, pero no una instancia de un subtipo del tipo lista. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyList_New (C function)
@anchor{c-api/list c PyList_New}@anchor{48c0}
@deffn {C Función} @ref{42d,,PyObject} *PyList_New (Py_ssize_t len)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna una nueva lista de longitud `len' en caso de éxito o @code{NULL} en caso de error.

@cartouche
@quotation Nota 
If `len' is greater than zero, the returned list object’s items are
set to @code{NULL}. Thus you cannot use abstract API functions such as
@ref{1a5b,,PySequence_SetItem()} or expose the object to Python code before
setting all items to a real object with @ref{484a,,PyList_SetItem()} or
@ref{480,,PyList_SET_ITEM()}. The following APIs are safe APIs before
the list is fully initialized: @ref{484a,,PyList_SetItem()} and @ref{480,,PyList_SET_ITEM()}.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Size (C function)
@anchor{c-api/list c PyList_Size}@anchor{1459}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyList_Size (PyObject *list)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Retorna la longitud del objeto lista en `list'; esto es equivalente a @code{len(list)} en un objeto lista.
@end deffn

@geindex PyList_GET_SIZE (C function)
@anchor{c-api/list c PyList_GET_SIZE}@anchor{4bbd}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyList_GET_SIZE (PyObject *list)

Similar to @ref{1459,,PyList_Size()}, but without error checking.
@end deffn

@geindex PyList_GetItemRef (C function)
@anchor{c-api/list c PyList_GetItemRef}@anchor{44f}
@deffn {C Función} @ref{42d,,PyObject} *PyList_GetItemRef (PyObject *list, Py_ssize_t index)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return the object at position `index' in the list pointed to by `list'.  The
position must be non-negative; indexing from the end of the list is not
supported.  If `index' is out of bounds (@code{<0 or >=len(list)}),
return @code{NULL} and set an @ref{1575,,IndexError} exception.


Added in version 3.13.

@end deffn

@geindex PyList_GetItem (C function)
@anchor{c-api/list c PyList_GetItem}@anchor{450}
@deffn {C Función} @ref{42d,,PyObject} *PyList_GetItem (PyObject *list, Py_ssize_t index)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Like @ref{44f,,PyList_GetItemRef()}, but returns a
@ref{432,,borrowed reference} instead of a @ref{431,,strong reference}.
@end deffn

@geindex PyList_GET_ITEM (C function)
@anchor{c-api/list c PyList_GET_ITEM}@anchor{48d4}
@deffn {C Función} @ref{42d,,PyObject} *PyList_GET_ITEM (PyObject *list, Py_ssize_t i)
`Return value: Borrowed reference.'
Similar to @ref{450,,PyList_GetItem()}, but without error checking.
@end deffn

@geindex PyList_SetItem (C function)
@anchor{c-api/list c PyList_SetItem}@anchor{484a}
@deffn {C Función} int PyList_SetItem (PyObject *list, Py_ssize_t index, PyObject *item)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el elemento en el índice `index' en la lista a `item'. Retorna @code{0} en caso de éxito. Si `index' está fuera de límites, retorna @code{-1} y establece una excepción @ref{1575,,IndexError}.

@cartouche
@quotation Nota 
Esta función «roba» una referencia a `item' y descarta una referencia a un elemento que ya está en la lista en la posición afectada.
@end quotation
@end cartouche
@end deffn

@geindex PyList_SET_ITEM (C function)
@anchor{c-api/list c PyList_SET_ITEM}@anchor{480}
@deffn {C Función} void PyList_SET_ITEM (PyObject *list, Py_ssize_t i, PyObject *o)

Forma macro de @ref{484a,,PyList_SetItem()} sin comprobación de errores. Esto normalmente solo se usa para completar nuevas listas donde no hay contenido anterior.

Bounds checking is performed as an assertion if Python is built in
@ref{357,,debug mode} or @ref{47e,,with assertions}.

@cartouche
@quotation Nota 
Este macro «roba» una referencia a `item' y, a diferencia de @ref{484a,,PyList_SetItem()}, `no descarta' una referencia a ningún elemento que se está reemplazando; cualquier referencia en `list' en la posición `i' se filtrará.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Insert (C function)
@anchor{c-api/list c PyList_Insert}@anchor{494b}
@deffn {C Función} int PyList_Insert (PyObject *list, Py_ssize_t index, PyObject *item)
` Part of the @ref{5f6,,Stable ABI}.'
Inserta el elemento `item' en la lista `list' delante del índice `index'. Retorna @code{0} si tiene éxito; retorna @code{-1} y establece una excepción si no tiene éxito. Análogo a @code{list.insert(index, item)}.
@end deffn

@geindex PyList_Append (C function)
@anchor{c-api/list c PyList_Append}@anchor{4948}
@deffn {C Función} int PyList_Append (PyObject *list, PyObject *item)
` Part of the @ref{5f6,,Stable ABI}.'
Agrega el objeto `item' al final de la lista `list'. Retorna @code{0} si tiene éxito; retorna @code{-1} y establece una excepción si no tiene éxito. Análogo a @code{list.append(item)}.
@end deffn

@geindex PyList_GetSlice (C function)
@anchor{c-api/list c PyList_GetSlice}@anchor{494a}
@deffn {C Función} @ref{42d,,PyObject} *PyList_GetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna una lista de los objetos en `list' que contiene los objetos `between', `low' y `high'. Retorna @code{NULL} y establece una excepción si no tiene éxito. Análogo a @code{list[low:high]}. La indexación desde el final de la lista no es compatible.
@end deffn

@geindex PyList_SetSlice (C function)
@anchor{c-api/list c PyList_SetSlice}@anchor{494d}
@deffn {C Función} int PyList_SetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el segmento de `list' entre `low' y `high' para el contenido de `itemlist'. Análogo a @code{list[low:high] = itemlist}. La lista `itemlist' puede ser @code{NULL}, lo que indica la asignación de una lista vacía (eliminación de segmentos). Retorna @code{0} en caso de éxito, @code{-1} en caso de error. La indexación desde el final de la lista no es compatible.
@end deffn

@geindex PyList_Extend (C function)
@anchor{c-api/list c PyList_Extend}@anchor{451}
@deffn {C Función} int PyList_Extend (PyObject *list, PyObject *iterable)

Extend `list' with the contents of `iterable'.  This is the same as
@code{PyList_SetSlice(list, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, iterable)}
and analogous to @code{list.extend(iterable)} or @code{list += iterable}.

Raise an exception and return @code{-1} if `list' is not a @ref{18e,,list}
object. Return 0 on success.


Added in version 3.13.

@end deffn

@geindex PyList_Clear (C function)
@anchor{c-api/list c PyList_Clear}@anchor{452}
@deffn {C Función} int PyList_Clear (PyObject *list)

Remove all items from `list'.  This is the same as
@code{PyList_SetSlice(list, 0, PY_SSIZE_T_MAX, NULL)} and analogous to
@code{list.clear()} or @code{del list[:]}.

Raise an exception and return @code{-1} if `list' is not a @ref{18e,,list}
object.  Return 0 on success.


Added in version 3.13.

@end deffn

@geindex PyList_Sort (C function)
@anchor{c-api/list c PyList_Sort}@anchor{494e}
@deffn {C Función} int PyList_Sort (PyObject *list)
` Part of the @ref{5f6,,Stable ABI}.'
Ordena los elementos de `list' en su lugar. Retorna @code{0} en caso de éxito, @code{-1} en caso de error. Esto es equivalente a @code{list.sort()}.
@end deffn

@geindex PyList_Reverse (C function)
@anchor{c-api/list c PyList_Reverse}@anchor{494c}
@deffn {C Función} int PyList_Reverse (PyObject *list)
` Part of the @ref{5f6,,Stable ABI}.'
Invierte los elementos de la lista `list' en su lugar. Retorna @code{0} en caso de éxito, @code{-1} en caso de error. Este es el equivalente de @code{list.reverse()}.
@end deffn

@geindex PyList_AsTuple (C function)
@anchor{c-api/list c PyList_AsTuple}@anchor{4949}
@deffn {C Función} @ref{42d,,PyObject} *PyList_AsTuple (PyObject *list)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;tuple

Retorna un nuevo objeto tupla que contiene el contenido de `list'; equivalente a @code{tuple(list)}.
@end deffn

@node Objetos contenedor,Objetos de función,Objetos de secuencia,Capa de objetos concretos
@anchor{c-api/concrete container-objects}@anchor{4bbe}@anchor{c-api/concrete mapobjects}@anchor{4bbf}
@subsection Objetos contenedor


@geindex object;mapping

@menu
* Objetos diccionario:: 
* Objetos conjunto:: 

@end menu

@node Objetos diccionario,Objetos conjunto,,Objetos contenedor
@anchor{c-api/dict doc}@anchor{4bc0}@anchor{c-api/dict dictionary-objects}@anchor{4bc1}@anchor{c-api/dict dictobjects}@anchor{4bc2}
@subsubsection Objetos diccionario


@geindex object;dictionary

@geindex PyDictObject (C type)
@anchor{c-api/dict c PyDictObject}@anchor{4a3}
@deffn {C Tipo} type PyDictObject

Este subtipo de @ref{42d,,PyObject} representa un objeto diccionario de Python.
@end deffn

@geindex PyDict_Type (C var)
@anchor{c-api/dict c PyDict_Type}@anchor{4917}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDict_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta instancia de @ref{b30,,PyTypeObject} representa el tipo diccionario de Python. Este es el mismo objeto que @ref{190,,dict} en la capa de Python.
@end deffn

@geindex PyDict_Check (C function)
@anchor{c-api/dict c PyDict_Check}@anchor{4b18}
@deffn {C Función} int PyDict_Check (PyObject *p)

Retorna verdadero si `p' es un objeto @code{dict} o una instancia de un subtipo del tipo @code{dict}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyDict_CheckExact (C function)
@anchor{c-api/dict c PyDict_CheckExact}@anchor{4bc3}
@deffn {C Función} int PyDict_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto @code{dict}, pero no una instancia de un subtipo del tipo @code{dict}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyDict_New (C function)
@anchor{c-api/dict c PyDict_New}@anchor{4915}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_New ()
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo diccionario vacío, o @code{NULL} en caso de falla.
@end deffn

@geindex PyDictProxy_New (C function)
@anchor{c-api/dict c PyDictProxy_New}@anchor{490d}
@deffn {C Función} @ref{42d,,PyObject} *PyDictProxy_New (PyObject *mapping)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un objeto a @ref{518,,types.MappingProxyType} para una asignación que imponga un comportamiento de solo lectura. Esto normalmente se usa para crear una vista para evitar la modificación del diccionario para los tipos de clase no dinámicos.
@end deffn

@geindex PyDict_Clear (C function)
@anchor{c-api/dict c PyDict_Clear}@anchor{490e}
@deffn {C Función} void PyDict_Clear (PyObject *p)
` Part of the @ref{5f6,,Stable ABI}.'
Vacía un diccionario existente de todos los pares clave-valor (`key-value').
@end deffn

@geindex PyDict_Contains (C function)
@anchor{c-api/dict c PyDict_Contains}@anchor{42c}
@deffn {C Función} int PyDict_Contains (PyObject *p, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Determine si el diccionario `p' contiene `key'. Si un elemento en `p' coincide con la clave `key', retorna @code{1}; de lo contrario, retorna @code{0}. En caso de error, retorna @code{-1}. Esto es equivalente a la expresión de Python @code{key in p}.
@end deffn

@geindex PyDict_ContainsString (C function)
@anchor{c-api/dict c PyDict_ContainsString}@anchor{42b}
@deffn {C Función} int PyDict_ContainsString (PyObject *p, const char *key)

This is the same as @ref{42c,,PyDict_Contains()}, but `key' is specified as a
const char* UTF-8 encoded bytes string, rather than a
@ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyDict_Copy (C function)
@anchor{c-api/dict c PyDict_Copy}@anchor{4de}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_Copy (PyObject *p)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo diccionario que contiene los mismos pares clave-valor (`key-value') que `p'.
@end deffn

@geindex PyDict_SetItem (C function)
@anchor{c-api/dict c PyDict_SetItem}@anchor{484b}
@deffn {C Función} int PyDict_SetItem (PyObject *p, PyObject *key, PyObject *val)
` Part of the @ref{5f6,,Stable ABI}.'
Inserta `val' en el diccionario `p' con una clave `key'. `key' debe ser @ref{6b1,,hashable}; si no lo es, se lanzará @ref{228,,TypeError}. Retorna @code{0} en caso de éxito o @code{-1} en caso de error. Esta función `no' roba una referencia a `val'.
@end deffn

@geindex PyDict_SetItemString (C function)
@anchor{c-api/dict c PyDict_SetItemString}@anchor{1623}
@deffn {C Función} int PyDict_SetItemString (PyObject *p, const char *key, PyObject *val)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{484b,,PyDict_SetItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
@end deffn

@geindex PyDict_DelItem (C function)
@anchor{c-api/dict c PyDict_DelItem}@anchor{490f}
@deffn {C Función} int PyDict_DelItem (PyObject *p, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Remove the entry in dictionary `p' with key `key'. `key' must be @ref{6b1,,hashable};
if it isn’t, @ref{228,,TypeError} is raised.
If `key' is not in the dictionary, @ref{438,,KeyError} is raised.
Return @code{0} on success or @code{-1} on failure.
@end deffn

@geindex PyDict_DelItemString (C function)
@anchor{c-api/dict c PyDict_DelItemString}@anchor{4910}
@deffn {C Función} int PyDict_DelItemString (PyObject *p, const char *key)
` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{490f,,PyDict_DelItem()}, but `key' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{42d,,PyObject}*.
@end deffn

@geindex PyDict_GetItemRef (C function)
@anchor{c-api/dict c PyDict_GetItemRef}@anchor{42e}
@deffn {C Función} int PyDict_GetItemRef (PyObject *p, PyObject *key, PyObject **result)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return a new @ref{431,,strong reference} to the object from dictionary `p'
which has a key `key':


@itemize *

@item 
If the key is present, set `*result' to a new @ref{431,,strong reference}
to the value and return @code{1}.

@item 
If the key is missing, set `*result' to @code{NULL} and return @code{0}.

@item 
On error, raise an exception and return @code{-1}.
@end itemize


Added in version 3.13.


See also the @ref{43b,,PyObject_GetItem()} function.
@end deffn

@geindex PyDict_GetItem (C function)
@anchor{c-api/dict c PyDict_GetItem}@anchor{479}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_GetItem (PyObject *p, PyObject *key)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a @ref{432,,borrowed reference} to the object from dictionary `p' which
has a key `key'.  Return @code{NULL} if the key `key' is missing `without'
setting an exception.

@cartouche
@quotation Nota 
Exceptions that occur while this calls @ref{b86,,__hash__()} and
@ref{b85,,__eq__()} methods are silently ignored.
Prefer the @ref{430,,PyDict_GetItemWithError()} function instead.
@end quotation
@end cartouche


Distinto en la versión 3.10: Llamar a esta API sin retener el @ref{2c5,,GIL} había sido permitido por motivos históricos.Ya no está permitido.

@end deffn

@geindex PyDict_GetItemWithError (C function)
@anchor{c-api/dict c PyDict_GetItemWithError}@anchor{430}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_GetItemWithError (PyObject *p, PyObject *key)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Variante de @ref{479,,PyDict_GetItem()} que no suprime las excepciones. Retorna @code{NULL} `con' una excepción establecida si se produjo una excepción. Retorna @code{NULL} `sin' una excepción establecida si la clave no estaba presente.
@end deffn

@geindex PyDict_GetItemString (C function)
@anchor{c-api/dict c PyDict_GetItemString}@anchor{47a}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_GetItemString (PyObject *p, const char *key)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
This is the same as @ref{479,,PyDict_GetItem()}, but `key' is specified as a
const char* UTF-8 encoded bytes string, rather than a
@ref{42d,,PyObject}*.

@cartouche
@quotation Nota 
Exceptions that occur while this calls @ref{b86,,__hash__()} and
@ref{b85,,__eq__()} methods or while creating the temporary @ref{237,,str}
object are silently ignored.
Prefer using the @ref{430,,PyDict_GetItemWithError()} function with your own
@ref{48a3,,PyUnicode_FromString()} `key' instead.
@end quotation
@end cartouche
@end deffn

@geindex PyDict_GetItemStringRef (C function)
@anchor{c-api/dict c PyDict_GetItemStringRef}@anchor{42f}
@deffn {C Función} int PyDict_GetItemStringRef (PyObject *p, const char *key, PyObject **result)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{42e,,PyDict_GetItemRef()}, but `key' is specified as a
const char* UTF-8 encoded bytes string, rather than a
@ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyDict_SetDefault (C function)
@anchor{c-api/dict c PyDict_SetDefault}@anchor{434}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_SetDefault (PyObject *p, PyObject *key, PyObject *defaultobj)
`Return value: Borrowed reference.'
Esto es lo mismo al nivel de Python @ref{10f5,,dict.setdefault()}. Si está presente, retorna el valor correspondiente a `key' del diccionario `p'. Si la clave no está en el @code{dict}, se inserta con el valor `defaultobj' y se retorna `defaultobj'. Esta función evalúa la función `hash' de `key' solo una vez, en lugar de evaluarla independientemente para la búsqueda y la inserción.


Added in version 3.4.

@end deffn

@geindex PyDict_SetDefaultRef (C function)
@anchor{c-api/dict c PyDict_SetDefaultRef}@anchor{433}
@deffn {C Función} int PyDict_SetDefaultRef (PyObject *p, PyObject *key, PyObject *default_value, PyObject **result)

Inserts `default_value' into the dictionary `p' with a key of `key' if the
key is not already present in the dictionary. If `result' is not @code{NULL},
then `*result' is set to a @ref{431,,strong reference} to either
`default_value', if the key was not present, or the existing value, if `key'
was already present in the dictionary.
Returns @code{1} if the key was present and `default_value' was not inserted,
or @code{0} if the key was not present and `default_value' was inserted.
On failure, returns @code{-1}, sets an exception, and sets @code{*result}
to @code{NULL}.

For clarity: if you have a strong reference to `default_value' before
calling this function, then after it returns, you hold a strong reference
to both `default_value' and `*result' (if it’s not @code{NULL}).
These may refer to the same object: in that case you hold two separate
references to it.


Added in version 3.13.

@end deffn

@geindex PyDict_Pop (C function)
@anchor{c-api/dict c PyDict_Pop}@anchor{435}
@deffn {C Función} int PyDict_Pop (PyObject *p, PyObject *key, PyObject **result)

Remove `key' from dictionary `p' and optionally return the removed value.
Do not raise @ref{438,,KeyError} if the key missing.


@itemize -

@item 
If the key is present, set `*result' to a new reference to the removed
value if `result' is not @code{NULL}, and return @code{1}.

@item 
If the key is missing, set `*result' to @code{NULL} if `result' is not
@code{NULL}, and return @code{0}.

@item 
On error, raise an exception and return @code{-1}.
@end itemize

Similar to @ref{437,,dict.pop()}, but without the default value and
not raising @ref{438,,KeyError} if the key missing.


Added in version 3.13.

@end deffn

@geindex PyDict_PopString (C function)
@anchor{c-api/dict c PyDict_PopString}@anchor{436}
@deffn {C Función} int PyDict_PopString (PyObject *p, const char *key, PyObject **result)

Similar to @ref{435,,PyDict_Pop()}, but `key' is specified as a
const char* UTF-8 encoded bytes string, rather than a
@ref{42d,,PyObject}*.


Added in version 3.13.

@end deffn

@geindex PyDict_Items (C function)
@anchor{c-api/dict c PyDict_Items}@anchor{4911}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_Items (PyObject *p)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un @ref{4add,,PyListObject} que contiene todos los elementos del diccionario.
@end deffn

@geindex PyDict_Keys (C function)
@anchor{c-api/dict c PyDict_Keys}@anchor{4912}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_Keys (PyObject *p)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un @ref{4add,,PyListObject} que contiene todas las claves del diccionario.
@end deffn

@geindex PyDict_Values (C function)
@anchor{c-api/dict c PyDict_Values}@anchor{4919}
@deffn {C Función} @ref{42d,,PyObject} *PyDict_Values (PyObject *p)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un @ref{4add,,PyListObject} que contiene todos los valores del diccionario `p'.
@end deffn

@geindex PyDict_Size (C function)
@anchor{c-api/dict c PyDict_Size}@anchor{4916}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyDict_Size (PyObject *p)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Retorna el número de elementos en el diccionario. Esto es equivalente a @code{len(p)} en un diccionario.
@end deffn

@geindex PyDict_Next (C function)
@anchor{c-api/dict c PyDict_Next}@anchor{1626}
@deffn {C Función} int PyDict_Next (PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)
` Part of the @ref{5f6,,Stable ABI}.'
Iterate over all key-value pairs in the dictionary `p'.  The
@ref{af0,,Py_ssize_t} referred to by `ppos' must be initialized to @code{0}
prior to the first call to this function to start the iteration; the
function returns true for each pair in the dictionary, and false once all
pairs have been reported.  The parameters `pkey' and `pvalue' should either
point to @ref{42d,,PyObject}* variables that will be filled in with each key
and value, respectively, or may be @code{NULL}.  Any references returned through
them are borrowed.  `ppos' should not be altered during iteration. Its
value represents offsets within the internal dictionary structure, and
since the structure is sparse, the offsets are not consecutive.

Por ejemplo:

@example
PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    /* do something interesting with the values... */
    ...
@}
@end example

El diccionario `p' no debe mutarse durante la iteración. Es seguro modificar los valores de las claves a medida que recorre el diccionario, pero solo mientras el conjunto de claves no cambie. Por ejemplo:

@example
PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    long i = PyLong_AsLong(value);
    if (i == -1 && PyErr_Occurred()) @{
        return -1;
    @}
    PyObject *o = PyLong_FromLong(i + 1);
    if (o == NULL)
        return -1;
    if (PyDict_SetItem(self->dict, key, o) < 0) @{
        Py_DECREF(o);
        return -1;
    @}
    Py_DECREF(o);
@}
@end example

The function is not thread-safe in the @ref{43ec,,free-threaded}
build without external synchronization.  You can use
@ref{4bc4,,Py_BEGIN_CRITICAL_SECTION} to lock the dictionary while iterating
over it:

@example
Py_BEGIN_CRITICAL_SECTION(self->dict);
while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    ...
@}
Py_END_CRITICAL_SECTION();
@end example
@end deffn

@geindex PyDict_Merge (C function)
@anchor{c-api/dict c PyDict_Merge}@anchor{4913}
@deffn {C Función} int PyDict_Merge (PyObject *a, PyObject *b, int override)
` Part of the @ref{5f6,,Stable ABI}.'
Itera sobre el objeto de mapeo `b' agregando pares clave-valor al diccionario `a'. `b' puede ser un diccionario o cualquier objeto que soporte @ref{c44,,PyMapping_Keys()} y @ref{43b,,PyObject_GetItem()}. Si `override' es verdadero, los pares existentes en `a' se reemplazarán si se encuentra una clave coincidente en `b', de lo contrario, los pares solo se agregarán si no hay una clave coincidente en `a'. Retorna @code{0} en caso de éxito o @code{-1} si se lanza una excepción.
@end deffn

@geindex PyDict_Update (C function)
@anchor{c-api/dict c PyDict_Update}@anchor{4918}
@deffn {C Función} int PyDict_Update (PyObject *a, PyObject *b)
` Part of the @ref{5f6,,Stable ABI}.'
Esto es lo mismo que @code{PyDict_Merge(a, b, 1)} en C, y es similar a @code{a.update(b)} en Python excepto que @ref{4918,,PyDict_Update()} no vuelve a la iteración sobre una secuencia de pares de valores clave si el segundo argumento no tiene el atributo «claves». Retorna @code{0} en caso de éxito o @code{-1} si se produjo una excepción.
@end deffn

@geindex PyDict_MergeFromSeq2 (C function)
@anchor{c-api/dict c PyDict_MergeFromSeq2}@anchor{4914}
@deffn {C Función} int PyDict_MergeFromSeq2 (PyObject *a, PyObject *seq2, int override)
` Part of the @ref{5f6,,Stable ABI}.'
Actualiza o combina en el diccionario `a', desde los pares clave-valor en `seq2'. `seq2' debe ser un objeto iterable que produzca objetos iterables de longitud 2, vistos como pares clave-valor. En el caso de claves duplicadas, el último gana si `override' es verdadero, de lo contrario, el primero gana. Retorna @code{0} en caso de éxito o @code{-1} si se produjo una excepción. El equivalente en Python (excepto el valor de retorno)

@example
def PyDict_MergeFromSeq2(a, seq2, override):
    for key, value in seq2:
        if override or key not in a:
            a[key] = value
@end example
@end deffn

@geindex PyDict_AddWatcher (C function)
@anchor{c-api/dict c PyDict_AddWatcher}@anchor{606}
@deffn {C Función} int PyDict_AddWatcher (PyDict_WatchCallback callback)

Register `callback' as a dictionary watcher. Return a non-negative integer
id which must be passed to future calls to @ref{607,,PyDict_Watch()}. In case
of error (e.g. no more watcher IDs available), return @code{-1} and set an
exception.


Added in version 3.12.

@end deffn

@geindex PyDict_ClearWatcher (C function)
@anchor{c-api/dict c PyDict_ClearWatcher}@anchor{4bc5}
@deffn {C Función} int PyDict_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' previously returned from
@ref{606,,PyDict_AddWatcher()}. Return @code{0} on success, @code{-1} on error (e.g.
if the given `watcher_id' was never registered.)


Added in version 3.12.

@end deffn

@geindex PyDict_Watch (C function)
@anchor{c-api/dict c PyDict_Watch}@anchor{607}
@deffn {C Función} int PyDict_Watch (int watcher_id, PyObject *dict)

Mark dictionary `dict' as watched. The callback granted `watcher_id' by
@ref{606,,PyDict_AddWatcher()} will be called when `dict' is modified or
deallocated. Return @code{0} on success or @code{-1} on error.


Added in version 3.12.

@end deffn

@geindex PyDict_Unwatch (C function)
@anchor{c-api/dict c PyDict_Unwatch}@anchor{4bc6}
@deffn {C Función} int PyDict_Unwatch (int watcher_id, PyObject *dict)

Mark dictionary `dict' as no longer watched. The callback granted
`watcher_id' by @ref{606,,PyDict_AddWatcher()} will no longer be called when
`dict' is modified or deallocated. The dict must previously have been
watched by this watcher. Return @code{0} on success or @code{-1} on error.


Added in version 3.12.

@end deffn

@geindex PyDict_WatchEvent (C type)
@anchor{c-api/dict c PyDict_WatchEvent}@anchor{4bc7}
@deffn {C Tipo} type PyDict_WatchEvent

Enumeration of possible dictionary watcher events: @code{PyDict_EVENT_ADDED},
@code{PyDict_EVENT_MODIFIED}, @code{PyDict_EVENT_DELETED}, @code{PyDict_EVENT_CLONED},
@code{PyDict_EVENT_CLEARED}, or @code{PyDict_EVENT_DEALLOCATED}.


Added in version 3.12.

@end deffn

@geindex PyDict_WatchCallback (C type)
@anchor{c-api/dict c PyDict_WatchCallback}@anchor{4bc8}
@deffn {C Tipo} typedef int (*PyDict_WatchCallback)(@ref{4bc7,,PyDict_WatchEvent} event, @ref{42d,,PyObject} *dict, @ref{42d,,PyObject} *key, @ref{42d,,PyObject} *new_value)

Type of a dict watcher callback function.

If `event' is @code{PyDict_EVENT_CLEARED} or @code{PyDict_EVENT_DEALLOCATED}, both
`key' and `new_value' will be @code{NULL}. If `event' is @code{PyDict_EVENT_ADDED}
or @code{PyDict_EVENT_MODIFIED}, `new_value' will be the new value for `key'.
If `event' is @code{PyDict_EVENT_DELETED}, `key' is being deleted from the
dictionary and `new_value' will be @code{NULL}.

@code{PyDict_EVENT_CLONED} occurs when `dict' was previously empty and another
dict is merged into it. To maintain efficiency of this operation, per-key
@code{PyDict_EVENT_ADDED} events are not issued in this case; instead a
single @code{PyDict_EVENT_CLONED} is issued, and `key' will be the source
dictionary.

The callback may inspect but must not modify `dict'; doing so could have
unpredictable effects, including infinite recursion. Do not trigger Python
code execution in the callback, as it could modify the dict as a side effect.

If `event' is @code{PyDict_EVENT_DEALLOCATED}, taking a new reference in the
callback to the about-to-be-destroyed dictionary will resurrect it and
prevent it from being freed at this time. When the resurrected object is
destroyed later, any watcher callbacks active at that time will be called
again.

Callbacks occur before the notified modification to `dict' takes place, so
the prior state of `dict' can be inspected.

If the callback sets an exception, it must return @code{-1}; this exception will
be printed as an unraisable exception using @ref{443,,PyErr_WriteUnraisable()}.
Otherwise it should return @code{0}.

There may already be a pending exception set on entry to the callback. In
this case, the callback should return @code{0} with the same exception still
set. This means the callback may not call any other API that can set an
exception unless it saves and clears the exception state first, and restores
it before returning.


Added in version 3.12.

@end deffn

@node Objetos conjunto,,Objetos diccionario,Objetos contenedor
@anchor{c-api/set doc}@anchor{4bc9}@anchor{c-api/set set-objects}@anchor{4bca}@anchor{c-api/set setobjects}@anchor{4bcb}
@subsubsection Objetos conjunto


@geindex object;set
@geindex object;frozenset

Esta sección detalla la API pública de los objetos @ref{67a,,set} y @ref{67b,,frozenset}.  Cualquier funcionalidad que no esté listada a continuación se accede mejor utilizando el protocolo abstracto de objetos (incluyendo @ref{492,,PyObject_CallMethod()}, @ref{19ac,,PyObject_RichCompareBool()}, @ref{29a,,PyObject_Hash()}, @ref{10ab,,PyObject_Repr()}, @ref{4998,,PyObject_IsTrue()}, @ref{1621,,PyObject_Print()}, y @ref{4997,,PyObject_GetIter()}) o el protocolo numérico abstracto (incluyendo @ref{496c,,PyNumber_And()}, @ref{4985,,PyNumber_Subtract()}, @ref{4980,,PyNumber_Or()}, @ref{4987,,PyNumber_Xor()}, @ref{4971,,PyNumber_InPlaceAnd()}, @ref{4979,,PyNumber_InPlaceSubtract()}, @ref{4975,,PyNumber_InPlaceOr()}, y @ref{497b,,PyNumber_InPlaceXor()}).

@geindex PySetObject (C type)
@anchor{c-api/set c PySetObject}@anchor{4bcc}
@deffn {C Tipo} type PySetObject

Este subtipo de @ref{42d,,PyObject} se utiliza para mantener los datos internos de los objetos @ref{67a,,set} y @ref{67b,,frozenset}.  Es como un @ref{4a3,,PyDictObject} en el sentido de que tiene un tamaño fijo para los conjuntos pequeños (muy parecido al almacenamiento de tuplas) y apuntará a un bloque de memoria separado y de tamaño variable para los conjuntos de tamaño medio y grande (muy parecido al almacenamiento de listas). Ninguno de los campos de esta estructura debe considerarse público y todos están sujetos a cambios.  Todo el acceso debe hacerse a través de la API documentada en lugar de manipular los valores de la estructura.
@end deffn

@geindex PySet_Type (C var)
@anchor{c-api/set c PySet_Type}@anchor{49b2}
@deffn {C Variable} @ref{b30,,PyTypeObject} PySet_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una instancia de @ref{b30,,PyTypeObject} que representa el tipo Python @ref{67a,,set}.
@end deffn

@geindex PyFrozenSet_Type (C var)
@anchor{c-api/set c PyFrozenSet_Type}@anchor{4939}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyFrozenSet_Type
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una instancia de @ref{b30,,PyTypeObject} que representa el tipo Python @ref{67b,,frozenset}.
@end deffn

Los siguientes macros de comprobación de tipos funcionan en punteros a cualquier objeto de Python. Del mismo modo, las funciones del constructor funcionan con cualquier objeto Python iterable.

@geindex PySet_Check (C function)
@anchor{c-api/set c PySet_Check}@anchor{4bcd}
@deffn {C Función} int PySet_Check (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67a,,set} o una instancia de un subtipo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyFrozenSet_Check (C function)
@anchor{c-api/set c PyFrozenSet_Check}@anchor{4bce}
@deffn {C Función} int PyFrozenSet_Check (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67b,,frozenset} o una instancia de un subtipo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyAnySet_Check (C function)
@anchor{c-api/set c PyAnySet_Check}@anchor{4bcf}
@deffn {C Función} int PyAnySet_Check (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67a,,set}, un objeto @ref{67b,,frozenset}, o una instancia de un subtipo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PySet_CheckExact (C function)
@anchor{c-api/set c PySet_CheckExact}@anchor{935}
@deffn {C Función} int PySet_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67a,,set} pero no una instancia de un subtipo. Esta función siempre finaliza con éxito.


Added in version 3.10.

@end deffn

@geindex PyAnySet_CheckExact (C function)
@anchor{c-api/set c PyAnySet_CheckExact}@anchor{4bd0}
@deffn {C Función} int PyAnySet_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67a,,set} o un objeto @ref{67b,,frozenset} pero no una instancia de un subtipo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyFrozenSet_CheckExact (C function)
@anchor{c-api/set c PyFrozenSet_CheckExact}@anchor{4bd1}
@deffn {C Función} int PyFrozenSet_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto @ref{67b,,frozenset} pero no una instancia de un subtipo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PySet_New (C function)
@anchor{c-api/set c PySet_New}@anchor{1484}
@deffn {C Función} @ref{42d,,PyObject} *PySet_New (PyObject *iterable)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo @ref{67a,,set} que contiene objetos retornados por `iterable'. El `iterable' puede ser @code{NULL} para crear un nuevo conjunto vacío. Retorna el nuevo conjunto en caso de éxito o @code{NULL} en caso de error. Lanza @ref{228,,TypeError} si `iterable' no es realmente iterable. El constructor también es útil para copiar un conjunto (@code{c=set(s)}).
@end deffn

@geindex PyFrozenSet_New (C function)
@anchor{c-api/set c PyFrozenSet_New}@anchor{1485}
@deffn {C Función} @ref{42d,,PyObject} *PyFrozenSet_New (PyObject *iterable)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo @ref{67b,,frozenset} que contiene objetos retornados por `iterable'. El `iterable' puede ser @code{NULL} para crear un nuevo conjunto congelado vacío. Retorna el nuevo conjunto en caso de éxito o @code{NULL} en caso de error. Lanza @ref{228,,TypeError} si `iterable' no es realmente iterable.
@end deffn

Las siguientes funciones y macros están disponibles para instancias de @ref{67a,,set} o @ref{67b,,frozenset} o instancias de sus subtipos.

@geindex PySet_Size (C function)
@anchor{c-api/set c PySet_Size}@anchor{1489}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySet_Size (PyObject *anyset)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex built-in function;len

Return the length of a @ref{67a,,set} or @ref{67b,,frozenset} object. Equivalent to
@code{len(anyset)}.  Raises a @ref{619,,SystemError} if `anyset' is not a
@ref{67a,,set}, @ref{67b,,frozenset}, or an instance of a subtype.
@end deffn

@geindex PySet_GET_SIZE (C function)
@anchor{c-api/set c PySet_GET_SIZE}@anchor{4bd2}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySet_GET_SIZE (PyObject *anyset)

Forma macro de @ref{1489,,PySet_Size()} sin comprobación de errores.
@end deffn

@geindex PySet_Contains (C function)
@anchor{c-api/set c PySet_Contains}@anchor{1488}
@deffn {C Función} int PySet_Contains (PyObject *anyset, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Return @code{1} if found, @code{0} if not found, and @code{-1} if an error is encountered.  Unlike
the Python @ref{1f5d,,__contains__()} method, this function does not automatically
convert unhashable sets into temporary frozensets.  Raise a @ref{228,,TypeError} if
the `key' is unhashable. Raise @ref{619,,SystemError} if `anyset' is not a
@ref{67a,,set}, @ref{67b,,frozenset}, or an instance of a subtype.
@end deffn

@geindex PySet_Add (C function)
@anchor{c-api/set c PySet_Add}@anchor{1486}
@deffn {C Función} int PySet_Add (PyObject *set, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Añade `key' a una instancia @ref{67a,,set}.  También funciona con instancias de @ref{67b,,frozenset} (al igual que @ref{4849,,PyTuple_SetItem()} puede usarse para rellenar los valores de nuevos frozensets antes de que sean expuestos a otro código).  Retorna @code{0} en caso de éxito o @code{-1} en caso de fallo. Lanza un error @ref{228,,TypeError} si la `key' no se puede intercambiar. Lanza un @ref{16cb,,MemoryError} si no hay espacio para crecer.  Lanza un @ref{619,,SystemError} si `set' no es una instancia de @ref{67a,,set} o su subtipo.
@end deffn

Las siguientes funciones están disponibles para instancias de @ref{67a,,set} o sus subtipos, pero no para instancias de @ref{67b,,frozenset} o sus subtipos.

@geindex PySet_Discard (C function)
@anchor{c-api/set c PySet_Discard}@anchor{1487}
@deffn {C Función} int PySet_Discard (PyObject *set, PyObject *key)
` Part of the @ref{5f6,,Stable ABI}.'
Return @code{1} if found and removed, @code{0} if not found (no action taken), and @code{-1} if an
error is encountered.  Does not raise @ref{438,,KeyError} for missing keys.  Raise a
@ref{228,,TypeError} if the `key' is unhashable.  Unlike the Python @ref{2243,,discard()}
method, this function does not automatically convert unhashable sets into
temporary frozensets. Raise @ref{619,,SystemError} if `set' is not an
instance of @ref{67a,,set} or its subtype.
@end deffn

@geindex PySet_Pop (C function)
@anchor{c-api/set c PySet_Pop}@anchor{49b1}
@deffn {C Función} @ref{42d,,PyObject} *PySet_Pop (PyObject *set)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna una nueva referencia a un objeto arbitrario en el `set' y elimina el objeto del `set'. Retorna @code{NULL} en caso de falla. Lanza @ref{438,,KeyError} si el conjunto está vacío. Lanza a @ref{619,,SystemError} si `set' no es una instancia de @ref{67a,,set} o su subtipo.
@end deffn

@geindex PySet_Clear (C function)
@anchor{c-api/set c PySet_Clear}@anchor{49b0}
@deffn {C Función} int PySet_Clear (PyObject *set)
` Part of the @ref{5f6,,Stable ABI}.'
Empty an existing set of all elements. Return @code{0} on
success. Return @code{-1} and raise @ref{619,,SystemError} if `set' is not an instance of
@ref{67a,,set} or its subtype.
@end deffn

@node Objetos de función,Otros objetos<2>,Objetos contenedor,Capa de objetos concretos
@anchor{c-api/concrete function-objects}@anchor{4bd3}@anchor{c-api/concrete otherobjects}@anchor{4bd4}
@subsection Objetos de función


@menu
* Objetos función:: 
* Objetos de método de instancia:: 
* Objetos método: Objetos método<2>. 
* Objetos celda:: 
* Objetos código: Objetos código<2>. 
* Extra information:: 

@end menu

@node Objetos función,Objetos de método de instancia,,Objetos de función
@anchor{c-api/function doc}@anchor{4bd5}@anchor{c-api/function function-objects}@anchor{4bd6}@anchor{c-api/function id1}@anchor{4bd7}
@subsubsection Objetos función


@geindex object;function

Hay algunas funciones específicas para las funciones de Python.

@geindex PyFunctionObject (C type)
@anchor{c-api/function c PyFunctionObject}@anchor{605}
@deffn {C Tipo} type PyFunctionObject

La estructura C utilizada para las funciones.
@end deffn

@geindex PyFunction_Type (C var)
@anchor{c-api/function c PyFunction_Type}@anchor{4bd8}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyFunction_Type

@geindex MethodType (in module types)

Esta es una instancia de @ref{b30,,PyTypeObject} y representa el tipo función de Python. Está expuesto a los programadores de Python como @code{types.FunctionType}.
@end deffn

@geindex PyFunction_Check (C function)
@anchor{c-api/function c PyFunction_Check}@anchor{4bd9}
@deffn {C Función} int PyFunction_Check (PyObject *o)

Retorna verdadero si `o' es un objeto función (tiene tipo @ref{4bd8,,PyFunction_Type}). El parámetro no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyFunction_New (C function)
@anchor{c-api/function c PyFunction_New}@anchor{4bda}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_New (PyObject *code, PyObject *globals)
`Return value: New reference.'
Retorna un nuevo objeto función asociado con el objeto código `code'. `globals' debe ser un diccionario con las variables globales accesibles para la función.

The function’s docstring and name are retrieved from the code object.
@ref{1efb,,__module__}
is retrieved from `globals'. The argument defaults, annotations and closure are
set to @code{NULL}. @ref{1efa,,__qualname__} is set to the same value as
the code object’s @ref{1f38,,co_qualname} field.
@end deffn

@geindex PyFunction_NewWithQualName (C function)
@anchor{c-api/function c PyFunction_NewWithQualName}@anchor{4bdb}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_NewWithQualName (PyObject *code, PyObject *globals, PyObject *qualname)
`Return value: New reference.'
As @ref{4bda,,PyFunction_New()}, but also allows setting the function object’s
@ref{1efa,,__qualname__} attribute.
`qualname' should be a unicode object or @code{NULL};
if @code{NULL}, the @code{__qualname__} attribute is set to the same value as
the code object’s @ref{1f38,,co_qualname} field.


Added in version 3.3.

@end deffn

@geindex PyFunction_GetCode (C function)
@anchor{c-api/function c PyFunction_GetCode}@anchor{4bdc}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetCode (PyObject *op)
`Return value: Borrowed reference.'
Retorna el objeto código asociado con el objeto función `op'.
@end deffn

@geindex PyFunction_GetGlobals (C function)
@anchor{c-api/function c PyFunction_GetGlobals}@anchor{4bdd}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetGlobals (PyObject *op)
`Return value: Borrowed reference.'
Retorna el diccionario global asociado con el objeto función `op'.
@end deffn

@geindex PyFunction_GetModule (C function)
@anchor{c-api/function c PyFunction_GetModule}@anchor{4bde}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetModule (PyObject *op)
`Return value: Borrowed reference.'
Return a @ref{432,,borrowed reference} to the @ref{1efb,,__module__}
attribute of the @ref{3eb,,function object} `op'.
It can be `NULL'.

This is normally a @ref{237,,string} containing the module name,
but can be set to any other object by Python code.
@end deffn

@geindex PyFunction_GetDefaults (C function)
@anchor{c-api/function c PyFunction_GetDefaults}@anchor{4bdf}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetDefaults (PyObject *op)
`Return value: Borrowed reference.'
Retorna los valores predeterminados del argumento del objeto función `op'. Esto puede ser una tupla de argumentos o @code{NULL}.
@end deffn

@geindex PyFunction_SetDefaults (C function)
@anchor{c-api/function c PyFunction_SetDefaults}@anchor{4be0}
@deffn {C Función} int PyFunction_SetDefaults (PyObject *op, PyObject *defaults)

Establece los valores predeterminados del argumento para el objeto función `op'. `defaults' deben ser @code{Py_None} o una tupla.

Lanza @ref{619,,SystemError} y retorna @code{-1} en caso de error.
@end deffn

@geindex PyFunction_SetVectorcall (C function)
@anchor{c-api/function c PyFunction_SetVectorcall}@anchor{604}
@deffn {C Función} void PyFunction_SetVectorcall (PyFunctionObject *func, vectorcallfunc vectorcall)

Set the vectorcall field of a given function object `func'.

Warning: extensions using this API must preserve the behavior
of the unaltered (default) vectorcall function!


Added in version 3.12.

@end deffn

@geindex PyFunction_GetClosure (C function)
@anchor{c-api/function c PyFunction_GetClosure}@anchor{4be1}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetClosure (PyObject *op)
`Return value: Borrowed reference.'
Retorna el cierre asociado con el objeto función `op'. Esto puede ser @code{NULL} o una tupla de objetos celda.
@end deffn

@geindex PyFunction_SetClosure (C function)
@anchor{c-api/function c PyFunction_SetClosure}@anchor{4be2}
@deffn {C Función} int PyFunction_SetClosure (PyObject *op, PyObject *closure)

Establece el cierre asociado con el objeto función `op'. `cierre' debe ser @code{Py_None} o una tupla de objetos celda.

Lanza @ref{619,,SystemError} y retorna @code{-1} en caso de error.
@end deffn

@geindex PyFunction_GetAnnotations (C function)
@anchor{c-api/function c PyFunction_GetAnnotations}@anchor{17c2}
@deffn {C Función} @ref{42d,,PyObject} *PyFunction_GetAnnotations (PyObject *op)
`Return value: Borrowed reference.'
Retorna las anotaciones del objeto función `op'. Este puede ser un diccionario mutable o @code{NULL}.
@end deffn

@geindex PyFunction_SetAnnotations (C function)
@anchor{c-api/function c PyFunction_SetAnnotations}@anchor{4be3}
@deffn {C Función} int PyFunction_SetAnnotations (PyObject *op, PyObject *annotations)

Establece las anotaciones para el objeto función `op'. `annotations' debe ser un diccionario o @code{Py_None}.

Lanza @ref{619,,SystemError} y retorna @code{-1} en caso de error.
@end deffn

@geindex PyFunction_AddWatcher (C function)
@anchor{c-api/function c PyFunction_AddWatcher}@anchor{4be4}
@deffn {C Función} int PyFunction_AddWatcher (PyFunction_WatchCallback callback)

Register `callback' as a function watcher for the current interpreter.
Return an ID which may be passed to @ref{4be5,,PyFunction_ClearWatcher()}.
In case of error (e.g. no more watcher IDs available),
return @code{-1} and set an exception.


Added in version 3.12.

@end deffn

@geindex PyFunction_ClearWatcher (C function)
@anchor{c-api/function c PyFunction_ClearWatcher}@anchor{4be5}
@deffn {C Función} int PyFunction_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' previously returned from
@ref{4be4,,PyFunction_AddWatcher()} for the current interpreter.
Return @code{0} on success, or @code{-1} and set an exception on error
(e.g.  if the given `watcher_id' was never registered.)


Added in version 3.12.

@end deffn

@geindex PyFunction_WatchEvent (C type)
@anchor{c-api/function c PyFunction_WatchEvent}@anchor{4be6}
@deffn {C Tipo} type PyFunction_WatchEvent

Enumeration of possible function watcher events:
- @code{PyFunction_EVENT_CREATE}
- @code{PyFunction_EVENT_DESTROY}
- @code{PyFunction_EVENT_MODIFY_CODE}
- @code{PyFunction_EVENT_MODIFY_DEFAULTS}
- @code{PyFunction_EVENT_MODIFY_KWDEFAULTS}


Added in version 3.12.

@end deffn

@geindex PyFunction_WatchCallback (C type)
@anchor{c-api/function c PyFunction_WatchCallback}@anchor{4be7}
@deffn {C Tipo} typedef int (*PyFunction_WatchCallback)(@ref{4be6,,PyFunction_WatchEvent} event, @ref{605,,PyFunctionObject} *func, @ref{42d,,PyObject} *new_value)

Type of a function watcher callback function.

If `event' is @code{PyFunction_EVENT_CREATE} or @code{PyFunction_EVENT_DESTROY}
then `new_value' will be @code{NULL}. Otherwise, `new_value' will hold a
@ref{432,,borrowed reference} to the new value that is about to be stored in
`func' for the attribute that is being modified.

The callback may inspect but must not modify `func'; doing so could have
unpredictable effects, including infinite recursion.

If `event' is @code{PyFunction_EVENT_CREATE}, then the callback is invoked
after @cite{func} has been fully initialized. Otherwise, the callback is invoked
before the modification to `func' takes place, so the prior state of `func'
can be inspected. The runtime is permitted to optimize away the creation of
function objects when possible. In such cases no event will be emitted.
Although this creates the possibility of an observable difference of
runtime behavior depending on optimization decisions, it does not change
the semantics of the Python code being executed.

If `event' is @code{PyFunction_EVENT_DESTROY},  Taking a reference in the
callback to the about-to-be-destroyed function will resurrect it, preventing
it from being freed at this time. When the resurrected object is destroyed
later, any watcher callbacks active at that time will be called again.

If the callback sets an exception, it must return @code{-1}; this exception will
be printed as an unraisable exception using @ref{443,,PyErr_WriteUnraisable()}.
Otherwise it should return @code{0}.

There may already be a pending exception set on entry to the callback. In
this case, the callback should return @code{0} with the same exception still
set. This means the callback may not call any other API that can set an
exception unless it saves and clears the exception state first, and restores
it before returning.


Added in version 3.12.

@end deffn

@node Objetos de método de instancia,Objetos método<2>,Objetos función,Objetos de función
@anchor{c-api/method doc}@anchor{4be8}@anchor{c-api/method instance-method-objects}@anchor{4be9}@anchor{c-api/method instancemethod-objects}@anchor{4bea}
@subsubsection Objetos de método de instancia


@geindex object;instancemethod

An instance method is a wrapper for a @ref{14b3,,PyCFunction} and the new way
to bind a @ref{14b3,,PyCFunction} to a class object. It replaces the former call
@code{PyMethod_New(func, NULL, class)}.

@geindex PyInstanceMethod_Type (C var)
@anchor{c-api/method c PyInstanceMethod_Type}@anchor{4beb}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyInstanceMethod_Type

Esta instancia de @ref{b30,,PyTypeObject} representa el tipo de método de instancia de Python. No está expuesto a los programas de Python.
@end deffn

@geindex PyInstanceMethod_Check (C function)
@anchor{c-api/method c PyInstanceMethod_Check}@anchor{4bec}
@deffn {C Función} int PyInstanceMethod_Check (PyObject *o)

Retorna verdadero si `o' es un objeto de método de instancia (tiene tipo @ref{4beb,,PyInstanceMethod_Type}). El parámetro no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyInstanceMethod_New (C function)
@anchor{c-api/method c PyInstanceMethod_New}@anchor{4bed}
@deffn {C Función} @ref{42d,,PyObject} *PyInstanceMethod_New (PyObject *func)
`Return value: New reference.'
Return a new instance method object, with `func' being any callable object.
`func' is the function that will be called when the instance method is
called.
@end deffn

@geindex PyInstanceMethod_Function (C function)
@anchor{c-api/method c PyInstanceMethod_Function}@anchor{4bee}
@deffn {C Función} @ref{42d,,PyObject} *PyInstanceMethod_Function (PyObject *im)
`Return value: Borrowed reference.'
Retorna el objeto de función asociado con el método de instancia `im'.
@end deffn

@geindex PyInstanceMethod_GET_FUNCTION (C function)
@anchor{c-api/method c PyInstanceMethod_GET_FUNCTION}@anchor{4bef}
@deffn {C Función} @ref{42d,,PyObject} *PyInstanceMethod_GET_FUNCTION (PyObject *im)
`Return value: Borrowed reference.'
Versión macro de @ref{4bee,,PyInstanceMethod_Function()} que evita la comprobación de errores.
@end deffn

@node Objetos método<2>,Objetos celda,Objetos de método de instancia,Objetos de función
@anchor{c-api/method id1}@anchor{4bf0}@anchor{c-api/method method-objects}@anchor{4bf1}
@subsubsection Objetos método


@geindex object;method

Los métodos son objetos de función enlazados. Los métodos siempre están vinculados a una instancia de una clase definida por el usuario. Los métodos no vinculados (métodos vinculados a un objeto de clase) ya no están disponibles.

@geindex PyMethod_Type (C var)
@anchor{c-api/method c PyMethod_Type}@anchor{4bf2}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyMethod_Type

@geindex MethodType (in module types)

Esta instancia de @ref{b30,,PyTypeObject} representa el tipo de método Python. Esto está expuesto a los programas de Python como @code{types.MethodType}.
@end deffn

@geindex PyMethod_Check (C function)
@anchor{c-api/method c PyMethod_Check}@anchor{4bf3}
@deffn {C Función} int PyMethod_Check (PyObject *o)

Retorna verdadero si `o' es un objeto de método (tiene tipo @ref{4bf2,,PyMethod_Type}). El parámetro no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyMethod_New (C function)
@anchor{c-api/method c PyMethod_New}@anchor{4bf4}
@deffn {C Función} @ref{42d,,PyObject} *PyMethod_New (PyObject *func, PyObject *self)
`Return value: New reference.'
Retorna un nuevo objeto de método, con `func' como cualquier objeto invocable y `self' la instancia en la que se debe vincular el método. `func' es la función que se llamará cuando se llame al método. `self' no debe ser @code{NULL}.
@end deffn

@geindex PyMethod_Function (C function)
@anchor{c-api/method c PyMethod_Function}@anchor{4bf5}
@deffn {C Función} @ref{42d,,PyObject} *PyMethod_Function (PyObject *meth)
`Return value: Borrowed reference.'
Retorna el objeto de función asociado con el método `meth'.
@end deffn

@geindex PyMethod_GET_FUNCTION (C function)
@anchor{c-api/method c PyMethod_GET_FUNCTION}@anchor{4bf6}
@deffn {C Función} @ref{42d,,PyObject} *PyMethod_GET_FUNCTION (PyObject *meth)
`Return value: Borrowed reference.'
Versión macro de @ref{4bf5,,PyMethod_Function()} que evita la comprobación de errores.
@end deffn

@geindex PyMethod_Self (C function)
@anchor{c-api/method c PyMethod_Self}@anchor{4bf7}
@deffn {C Función} @ref{42d,,PyObject} *PyMethod_Self (PyObject *meth)
`Return value: Borrowed reference.'
Retorna la instancia asociada con el método `meth'.
@end deffn

@geindex PyMethod_GET_SELF (C function)
@anchor{c-api/method c PyMethod_GET_SELF}@anchor{4bf8}
@deffn {C Función} @ref{42d,,PyObject} *PyMethod_GET_SELF (PyObject *meth)
`Return value: Borrowed reference.'
Versión macro de @ref{4bf7,,PyMethod_Self()} que evita la comprobación de errores.
@end deffn

@node Objetos celda,Objetos código<2>,Objetos método<2>,Objetos de función
@anchor{c-api/cell doc}@anchor{4bf9}@anchor{c-api/cell cell-objects}@anchor{7a1}@anchor{c-api/cell id1}@anchor{4bfa}
@subsubsection Objetos celda


Los objetos celda (`cell') se utilizan para implementar variables a las que hacen referencia varios ámbitos. Para cada variable, se crea un objeto de celda para almacenar el valor; Las variables locales de cada marco de pila que hace referencia al valor contienen una referencia a las celdas de ámbitos externos que también usan esa variable. Cuando se accede al valor, se utiliza el valor contenido en la celda en lugar del objeto de la celda en sí. Esta desreferenciación del objeto de celda requiere soporte del código de bytes generado; estos no se eliminan automáticamente cuando se accede a ellos. No es probable que los objetos celda sean útiles en otros lugares.

@geindex PyCellObject (C type)
@anchor{c-api/cell c PyCellObject}@anchor{4bfb}
@deffn {C Tipo} type PyCellObject

La estructura C utilizada para objetos celda.
@end deffn

@geindex PyCell_Type (C var)
@anchor{c-api/cell c PyCell_Type}@anchor{4bfc}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyCell_Type

El objeto tipo correspondiente a los objetos celda.
@end deffn

@geindex PyCell_Check (C function)
@anchor{c-api/cell c PyCell_Check}@anchor{4bfd}
@deffn {C Función} int PyCell_Check (PyObject *ob)

Retorna verdadero si `ob' es un objeto de celda; `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyCell_New (C function)
@anchor{c-api/cell c PyCell_New}@anchor{4bfe}
@deffn {C Función} @ref{42d,,PyObject} *PyCell_New (PyObject *ob)
`Return value: New reference.'
Crea y retorna un nuevo objeto de celda que contiene el valor `ob'. El parámetro puede ser @code{NULL}.
@end deffn

@geindex PyCell_Get (C function)
@anchor{c-api/cell c PyCell_Get}@anchor{4bff}
@deffn {C Función} @ref{42d,,PyObject} *PyCell_Get (PyObject *cell)
`Return value: New reference.'
Return the contents of the cell `cell', which can be @code{NULL}.
If `cell' is not a cell object, returns @code{NULL} with an exception set.
@end deffn

@geindex PyCell_GET (C function)
@anchor{c-api/cell c PyCell_GET}@anchor{4c00}
@deffn {C Función} @ref{42d,,PyObject} *PyCell_GET (PyObject *cell)
`Return value: Borrowed reference.'
Retorna el contenido de la celda `cell', pero sin verificar que `cell' no sea @code{NULL} y que sea un objeto de celda.
@end deffn

@geindex PyCell_Set (C function)
@anchor{c-api/cell c PyCell_Set}@anchor{4c01}
@deffn {C Función} int PyCell_Set (PyObject *cell, PyObject *value)

Set the contents of the cell object `cell' to `value'.  This releases the
reference to any current content of the cell. `value' may be @code{NULL}.  `cell'
must be non-@code{NULL}.

On success, return @code{0}.
If `cell' is not a cell object, set an exception and return @code{-1}.
@end deffn

@geindex PyCell_SET (C function)
@anchor{c-api/cell c PyCell_SET}@anchor{945}
@deffn {C Función} void PyCell_SET (PyObject *cell, PyObject *value)

Establece el valor del objeto de celda `cell' en el valor `value'. No se ajustan los recuentos de referencia y no se realizan verificaciones de seguridad; `cell' no debe ser @code{NULL} y debe ser un objeto de celda.
@end deffn

@geindex object;code
@geindex code object

@node Objetos código<2>,Extra information,Objetos celda,Objetos de función
@anchor{c-api/code doc}@anchor{4c02}@anchor{c-api/code code-objects}@anchor{4c03}@anchor{c-api/code codeobjects}@anchor{656}
@subsubsection Objetos código


Los objetos código son un detalle de bajo nivel de la implementación de CPython. Cada uno representa un fragmento de código ejecutable que aún no se ha vinculado a una función.

@geindex PyCodeObject (C type)
@anchor{c-api/code c PyCodeObject}@anchor{811}
@deffn {C Tipo} type PyCodeObject

La estructura en C de los objetos utilizados para describir objetos código. Los campos de este tipo están sujetos a cambios en cualquier momento.
@end deffn

@geindex PyCode_Type (C var)
@anchor{c-api/code c PyCode_Type}@anchor{4c04}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyCode_Type

This is an instance of @ref{b30,,PyTypeObject} representing the Python
@ref{335,,code object}.
@end deffn

@geindex PyCode_Check (C function)
@anchor{c-api/code c PyCode_Check}@anchor{4c05}
@deffn {C Función} int PyCode_Check (PyObject *co)

Return true if `co' is a @ref{335,,code object}.
This function always succeeds.
@end deffn

@geindex PyCode_GetNumFree (C function)
@anchor{c-api/code c PyCode_GetNumFree}@anchor{4c06}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyCode_GetNumFree (PyCodeObject *co)

Return the number of @ref{1f40,,free (closure) variables}
in a code object.
@end deffn

@geindex PyUnstable_Code_GetFirstFree (C function)
@anchor{c-api/code c PyUnstable_Code_GetFirstFree}@anchor{478}
@deffn {C Función} int PyUnstable_Code_GetFirstFree (PyCodeObject *co)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return the position of the first @ref{1f40,,free (closure) variable}
in a code object.


Distinto en la versión 3.13: Renamed from @code{PyCode_GetFirstFree} as part of @ref{5ea,,Unstable C API}.
The old name is deprecated, but will remain available until the
signature changes again.

@end deffn

@geindex PyUnstable_Code_New (C function)
@anchor{c-api/code c PyUnstable_Code_New}@anchor{4c07}
@deffn {C Función} @ref{811,,PyCodeObject} *PyUnstable_Code_New (int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return a new code object.  If you need a dummy code object to create a frame,
use @ref{13b9,,PyCode_NewEmpty()} instead.

Since the definition of the bytecode changes often, calling
@ref{4c07,,PyUnstable_Code_New()} directly can bind you to a precise Python version.

The many arguments of this function are inter-dependent in complex
ways, meaning that subtle changes to values are likely to result in incorrect
execution or VM crashes. Use this function only with extreme care.


Distinto en la versión 3.11: Added @code{qualname} and @code{exceptiontable} parameters.


@geindex PyCode_New (C function)


Distinto en la versión 3.12: Renamed from @code{PyCode_New} as part of @ref{5ea,,Unstable C API}.
The old name is deprecated, but will remain available until the
signature changes again.

@end deffn

@geindex PyUnstable_Code_NewWithPosOnlyArgs (C function)
@anchor{c-api/code c PyUnstable_Code_NewWithPosOnlyArgs}@anchor{4c08}
@deffn {C Función} @ref{811,,PyCodeObject} *PyUnstable_Code_NewWithPosOnlyArgs (int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Similar to @ref{4c07,,PyUnstable_Code_New()}, but with an extra «posonlyargcount» for positional-only arguments.
The same caveats that apply to @code{PyUnstable_Code_New} also apply to this function.

@geindex PyCode_NewWithPosOnlyArgs (C function)


Added in version 3.8: as @code{PyCode_NewWithPosOnlyArgs}



Distinto en la versión 3.11: Added @code{qualname} and  @code{exceptiontable} parameters.



Distinto en la versión 3.12: Renamed to @code{PyUnstable_Code_NewWithPosOnlyArgs}.
The old name is deprecated, but will remain available until the
signature changes again.

@end deffn

@geindex PyCode_NewEmpty (C function)
@anchor{c-api/code c PyCode_NewEmpty}@anchor{13b9}
@deffn {C Función} @ref{811,,PyCodeObject} *PyCode_NewEmpty (const char *filename, const char *funcname, int firstlineno)
`Return value: New reference.'
Retorna un nuevo objeto de código vacío con el nombre de archivo especificado, el nombre de la función y el número de la primera línea. Si el objeto código resultante es ejecutado, lanzará una @code{Exception}.
@end deffn

@geindex PyCode_Addr2Line (C function)
@anchor{c-api/code c PyCode_Addr2Line}@anchor{921}
@deffn {C Función} int PyCode_Addr2Line (PyCodeObject *co, int byte_offset)

Retorna el número de línea de la instrucción que se produce en o antes de @code{byte_offset} y finaliza después. Si solo necesita el número de línea de un marco, use @ref{824,,PyFrame_GetLineNumber()} en su lugar.

For efficiently iterating over the line numbers in a code object, use 
@geindex Python Enhancement Proposals; PEP 0626#out-of-process-debuggers-and-profilers
the API described in PEP 626@footnote{https://peps.python.org/pep-0626/#out-of-process-debuggers-and-profilers}.
@end deffn

@geindex PyCode_Addr2Location (C function)
@anchor{c-api/code c PyCode_Addr2Location}@anchor{655}
@deffn {C Función} int PyCode_Addr2Location (PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column)

Establece los punteros @code{int} pasados en los números de línea y columna del código fuente para las instrucciones en @code{byte_offset}. Establece el valor en @code{0} cuando la información no está disponible para algún elemento en particular.

Retorna @code{1} si la función fue exitosa y @code{0} de lo contrario.


Added in version 3.11.

@end deffn

@geindex PyCode_GetCode (C function)
@anchor{c-api/code c PyCode_GetCode}@anchor{812}
@deffn {C Función} @ref{42d,,PyObject} *PyCode_GetCode (PyCodeObject *co)

Equivalente al código Python @code{getattr(co, 'co_code')}. Retorna una referencia fuerte a un @ref{82b,,PyBytesObject} representando el bytecode en un objecto código. En caso de error se retorna @code{NULL} y se lanza una excepción.

Este @code{PyBytesObject} puede ser creado a pedido del intérprete y no necesariamente representa el bytecode que es realmente ejecutado por CPython. Los casos de uso principales para esta función son depuradores y perfiladores.


Added in version 3.11.

@end deffn

@geindex PyCode_GetVarnames (C function)
@anchor{c-api/code c PyCode_GetVarnames}@anchor{813}
@deffn {C Función} @ref{42d,,PyObject} *PyCode_GetVarnames (PyCodeObject *co)

Equivalente al código Python @code{getattr(co, 'co_varnames')}. Retorna una nueva referencia a un @ref{4a76,,PyTupleObject} que contiene los nombres de las variables locales. En caso de error, retorna @code{NULL} y lanza una excepción.


Added in version 3.11.

@end deffn

@geindex PyCode_GetCellvars (C function)
@anchor{c-api/code c PyCode_GetCellvars}@anchor{814}
@deffn {C Función} @ref{42d,,PyObject} *PyCode_GetCellvars (PyCodeObject *co)

Equivalente al código Python @code{getattr(co, 'co_cellvars')}. Retorna una nueva referencia a un @ref{4a76,,PyTupleObject} que contiene los nombres de las variables locales referenciadas por funciones anidadas. En caso de error, retorna @code{NULL} y lanza una excepción.


Added in version 3.11.

@end deffn

@geindex PyCode_GetFreevars (C function)
@anchor{c-api/code c PyCode_GetFreevars}@anchor{815}
@deffn {C Función} @ref{42d,,PyObject} *PyCode_GetFreevars (PyCodeObject *co)

Equivalent to the Python code @code{getattr(co, 'co_freevars')}.
Returns a new reference to a @ref{4a76,,PyTupleObject} containing the names of
the @ref{1f40,,free (closure) variables}. On error, @code{NULL} is returned
and an exception is raised.


Added in version 3.11.

@end deffn

@geindex PyCode_AddWatcher (C function)
@anchor{c-api/code c PyCode_AddWatcher}@anchor{60a}
@deffn {C Función} int PyCode_AddWatcher (PyCode_WatchCallback callback)

Register `callback' as a code object watcher for the current interpreter.
Return an ID which may be passed to @ref{60b,,PyCode_ClearWatcher()}.
In case of error (e.g. no more watcher IDs available),
return @code{-1} and set an exception.


Added in version 3.12.

@end deffn

@geindex PyCode_ClearWatcher (C function)
@anchor{c-api/code c PyCode_ClearWatcher}@anchor{60b}
@deffn {C Función} int PyCode_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' previously returned from
@ref{60a,,PyCode_AddWatcher()} for the current interpreter.
Return @code{0} on success, or @code{-1} and set an exception on error
(e.g. if the given `watcher_id' was never registered.)


Added in version 3.12.

@end deffn

@geindex PyCodeEvent (C type)
@anchor{c-api/code c PyCodeEvent}@anchor{4c09}
@deffn {C Tipo} type PyCodeEvent

Enumeration of possible code object watcher events:
- @code{PY_CODE_EVENT_CREATE}
- @code{PY_CODE_EVENT_DESTROY}


Added in version 3.12.

@end deffn

@geindex PyCode_WatchCallback (C type)
@anchor{c-api/code c PyCode_WatchCallback}@anchor{4c0a}
@deffn {C Tipo} typedef int (*PyCode_WatchCallback)(@ref{4c09,,PyCodeEvent} event, @ref{811,,PyCodeObject} *co)

Type of a code object watcher callback function.

If `event' is @code{PY_CODE_EVENT_CREATE}, then the callback is invoked
after @cite{co} has been fully initialized. Otherwise, the callback is invoked
before the destruction of `co' takes place, so the prior state of `co'
can be inspected.

If `event' is @code{PY_CODE_EVENT_DESTROY}, taking a reference in the callback
to the about-to-be-destroyed code object will resurrect it and prevent it
from being freed at this time. When the resurrected object is destroyed
later, any watcher callbacks active at that time will be called again.

Users of this API should not rely on internal runtime implementation
details. Such details may include, but are not limited to, the exact
order and timing of creation and destruction of code objects. While
changes in these details may result in differences observable by watchers
(including whether a callback is invoked or not), it does not change
the semantics of the Python code being executed.

If the callback sets an exception, it must return @code{-1}; this exception will
be printed as an unraisable exception using @ref{443,,PyErr_WriteUnraisable()}.
Otherwise it should return @code{0}.

There may already be a pending exception set on entry to the callback. In
this case, the callback should return @code{0} with the same exception still
set. This means the callback may not call any other API that can set an
exception unless it saves and clears the exception state first, and restores
it before returning.


Added in version 3.12.

@end deffn

@node Extra information,,Objetos código<2>,Objetos de función
@anchor{c-api/code extra-information}@anchor{4c0b}
@subsubsection Extra information


To support low-level extensions to frame evaluation, such as external
just-in-time compilers, it is possible to attach arbitrary extra data to
code objects.

These functions are part of the unstable C API tier:
this functionality is a CPython implementation detail, and the API
may change without deprecation warnings.

@geindex PyUnstable_Eval_RequestCodeExtraIndex (C function)
@anchor{c-api/code c PyUnstable_Eval_RequestCodeExtraIndex}@anchor{4c0c}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyUnstable_Eval_RequestCodeExtraIndex (freefunc free)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return a new an opaque index value used to adding data to code objects.

You generally call this function once (per interpreter) and use the result
with @code{PyCode_GetExtra} and @code{PyCode_SetExtra} to manipulate
data on individual code objects.

If `free' is not @code{NULL}: when a code object is deallocated,
`free' will be called on non-@code{NULL} data stored under the new index.
Use @ref{4a0d,,Py_DecRef()} when storing @ref{42d,,PyObject}.

@geindex _PyEval_RequestCodeExtraIndex (C function)


Added in version 3.6: as @code{_PyEval_RequestCodeExtraIndex}



Distinto en la versión 3.12: Renamed to @code{PyUnstable_Eval_RequestCodeExtraIndex}.
The old private name is deprecated, but will be available until the API
changes.

@end deffn

@geindex PyUnstable_Code_GetExtra (C function)
@anchor{c-api/code c PyUnstable_Code_GetExtra}@anchor{4c0d}
@deffn {C Función} int PyUnstable_Code_GetExtra (PyObject *code, Py_ssize_t index, void **extra)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Set `extra' to the extra data stored under the given index.
Return 0 on success. Set an exception and return -1 on failure.

If no data was set under the index, set `extra' to @code{NULL} and return
0 without setting an exception.

@geindex _PyCode_GetExtra (C function)


Added in version 3.6: as @code{_PyCode_GetExtra}



Distinto en la versión 3.12: Renamed to @code{PyUnstable_Code_GetExtra}.
The old private name is deprecated, but will be available until the API
changes.

@end deffn

@geindex PyUnstable_Code_SetExtra (C function)
@anchor{c-api/code c PyUnstable_Code_SetExtra}@anchor{4c0e}
@deffn {C Función} int PyUnstable_Code_SetExtra (PyObject *code, Py_ssize_t index, void *extra)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Set the extra data stored under the given index to `extra'.
Return 0 on success. Set an exception and return -1 on failure.

@geindex _PyCode_SetExtra (C function)


Added in version 3.6: as @code{_PyCode_SetExtra}



Distinto en la versión 3.12: Renamed to @code{PyUnstable_Code_SetExtra}.
The old private name is deprecated, but will be available until the API
changes.

@end deffn

@node Otros objetos<2>,,Objetos de función,Capa de objetos concretos
@anchor{c-api/concrete other-objects}@anchor{4c0f}
@subsection Otros objetos


@menu
* Objetos archivo:: 
* Objetos módulo:: 
* Objetos iteradores:: 
* Objetos descriptores:: 
* Objetos rebanada (slice): Objetos rebanada slice. 
* Objetos de vista de memoria (MemoryView): Objetos de vista de memoria MemoryView. 
* Objetos de referencia débil:: 
* Cápsulas: Cápsulas<2>. 
* Objetos frame:: 
* Objetos generadores:: 
* Objetos corrutina:: 
* Objetos de variables de contexto:: 
* Objetos DateTime: Objetos DateTime<2>. 
* Objetos para indicaciones de tipado:: 

@end menu

@node Objetos archivo,Objetos módulo,,Otros objetos<2>
@anchor{c-api/file doc}@anchor{4c10}@anchor{c-api/file file-objects}@anchor{4c11}@anchor{c-api/file fileobjects}@anchor{4c12}
@subsubsection Objetos archivo


@geindex object;file

These APIs are a minimal emulation of the Python 2 C API for built-in file
objects, which used to rely on the buffered I/O (FILE*) support
from the C standard library.  In Python 3, files and streams use the new
@ref{7f,,io} module, which defines several layers over the low-level unbuffered
I/O of the operating system.  The functions described below are
convenience C wrappers over these new APIs, and meant mostly for internal
error reporting in the interpreter; third-party code is advised to access
the @ref{7f,,io} APIs instead.

@geindex PyFile_FromFd (C function)
@anchor{c-api/file c PyFile_FromFd}@anchor{4932}
@deffn {C Función} @ref{42d,,PyObject} *PyFile_FromFd (int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto archivo Python a partir del descriptor de archivo de un archivo ya abierto `fd'. Los argumentos `name', `encoding', `errors' y `newline' pueden ser @code{NULL} para usar los valores predeterminados; `buffering' puede ser `-1' para usar el valor predeterminado. `name' se ignora y se mantiene por compatibilidad con versiones anteriores. Retorna @code{NULL} en caso de error. Para obtener una descripción más completa de los argumentos, consulte la documentación de la función @ref{5c0,,io.open()}.

@cartouche
@quotation Advertencia 
Dado que las transmisiones (`streams') de Python tienen su propia capa de almacenamiento en búfer, combinarlas con descriptores de archivos a nivel del sistema operativo puede producir varios problemas (como un pedido inesperado de datos).
@end quotation
@end cartouche


Distinto en la versión 3.2: Ignora el atributo `name'.

@end deffn

@geindex PyObject_AsFileDescriptor (C function)
@anchor{c-api/file c PyObject_AsFileDescriptor}@anchor{498d}
@deffn {C Función} int PyObject_AsFileDescriptor (PyObject *p)
` Part of the @ref{5f6,,Stable ABI}.'
Return the file descriptor associated with `p' as an int.  If the
object is an integer, its value is returned.  If not, the
object’s @ref{2848,,fileno()} method is called if it exists; the
method must return an integer, which is returned as the file descriptor
value.  Sets an exception and returns @code{-1} on failure.
@end deffn

@geindex PyFile_GetLine (C function)
@anchor{c-api/file c PyFile_GetLine}@anchor{4933}
@deffn {C Función} @ref{42d,,PyObject} *PyFile_GetLine (PyObject *p, int n)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex EOFError (built-in exception)

Equivalente a @code{p.readline([n])}, esta función lee una línea del objeto `p'. `p' puede ser un objeto archivo o cualquier objeto con un método @ref{1391,,readline()}. Si `n' es @code{0}, se lee exactamente una línea, independientemente de la longitud de la línea. Si `n' es mayor que @code{0}, no se leerán más de `n' bytes del archivo; se puede retornar una línea parcial. En ambos casos, se retorna una cadena de caracteres vacía si se llega al final del archivo de inmediato. Si `n' es menor que @code{0}, sin embargo, se lee una línea independientemente de la longitud, pero @ref{1341,,EOFError} se lanza si se llega al final del archivo de inmediato.
@end deffn

@geindex PyFile_SetOpenCodeHook (C function)
@anchor{c-api/file c PyFile_SetOpenCodeHook}@anchor{1730}
@deffn {C Función} int PyFile_SetOpenCodeHook (Py_OpenCodeHookFunction handler)

Sobrescribe el comportamiento normal de @ref{172e,,io.open_code()} para pasar su parámetro a través del controlador proporcionado.

The `handler' is a function of type:

@geindex Py_OpenCodeHookFunction (C type)
@anchor{c-api/file c Py_OpenCodeHookFunction}@anchor{4c13}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*Py_OpenCodeHookFunction)(@ref{42d,,PyObject}*, void*)

Equivalent of @ref{42d,,PyObject} *(*)(@ref{42d,,PyObject} *path, void *userData), where `path' is guaranteed to be
@ref{82d,,PyUnicodeObject}.
@end deffn

El puntero `userData' se pasa a la función de enlace. Dado que las funciones de enlace pueden llamarse desde diferentes tiempos de ejecución, este puntero no debe referirse directamente al estado de Python.

Como este `hook' se usa intencionalmente durante la importación, evite importar nuevos módulos durante su ejecución a menos que se sepa que están congelados o disponibles en @code{sys.modules}.

Una vez que se ha establecido un `hook', no se puede quitar ni reemplazar, y luego llamadas a @ref{1730,,PyFile_SetOpenCodeHook()} fallarán. En caso de error, la función retorna -1 y establece una excepción si el intérprete se ha inicializado.

Es seguro llamar a esta función antes de @ref{247,,Py_Initialize()}.

Genera un @ref{18c3,,evento de auditoría} @code{setopencodehook} sin argumentos.


Added in version 3.8.

@end deffn

@geindex PyFile_WriteObject (C function)
@anchor{c-api/file c PyFile_WriteObject}@anchor{4934}
@deffn {C Función} int PyFile_WriteObject (PyObject *obj, PyObject *p, int flags)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex Py_PRINT_RAW (C macro)

Write object `obj' to file object `p'.  The only supported flag for `flags' is
@ref{4ac0,,Py_PRINT_RAW}; if given, the @ref{237,,str()} of the object is written
instead of the @ref{894,,repr()}.  Return @code{0} on success or @code{-1} on failure; the
appropriate exception will be set.
@end deffn

@geindex PyFile_WriteString (C function)
@anchor{c-api/file c PyFile_WriteString}@anchor{4935}
@deffn {C Función} int PyFile_WriteString (const char *s, PyObject *p)
` Part of the @ref{5f6,,Stable ABI}.'
Escribe la cadena `s' en el objeto archivo `p'. Retorna @code{0} en caso de éxito o @code{-1} en caso de error; se establecerá la excepción apropiada.
@end deffn

@node Objetos módulo,Objetos iteradores,Objetos archivo,Otros objetos<2>
@anchor{c-api/module doc}@anchor{4c14}@anchor{c-api/module module-objects}@anchor{4c15}@anchor{c-api/module moduleobjects}@anchor{4c16}
@subsubsection Objetos módulo


@geindex object;module

@geindex PyModule_Type (C var)
@anchor{c-api/module c PyModule_Type}@anchor{4969}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyModule_Type
` Part of the @ref{5f6,,Stable ABI}.'
@geindex ModuleType (in module types)

Esta instancia de @ref{b30,,PyTypeObject} representa el tipo de módulo Python. Esto está expuesto a los programas de Python como @code{types.ModuleType}.
@end deffn

@geindex PyModule_Check (C function)
@anchor{c-api/module c PyModule_Check}@anchor{4c17}
@deffn {C Función} int PyModule_Check (PyObject *p)

Retorna verdadero si `p' es un objeto de módulo o un subtipo de un objeto de módulo. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyModule_CheckExact (C function)
@anchor{c-api/module c PyModule_CheckExact}@anchor{4c18}
@deffn {C Función} int PyModule_CheckExact (PyObject *p)

Retorna verdadero si `p' es un objeto módulo, pero no un subtipo de @ref{4969,,PyModule_Type}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyModule_NewObject (C function)
@anchor{c-api/module c PyModule_NewObject}@anchor{4967}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_NewObject (PyObject *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
@geindex __name__ (module attribute)
@geindex __doc__ (module attribute)
@geindex __file__ (module attribute)
@geindex __package__ (module attribute)
@geindex __loader__ (module attribute)

Return a new module object with @ref{13e8,,module.__name__} set to `name'.
The module’s @code{__name__}, @ref{185a,,__doc__},
@ref{1cd,,__package__} and @ref{1e2,,__loader__} attributes are
filled in (all but @code{__name__} are set to @code{None}). The caller is
responsible for setting a @ref{1f1b,,__file__} attribute.

Return @code{NULL} with an exception set on error.


Added in version 3.3.



Distinto en la versión 3.4: @ref{1cd,,__package__} and @ref{1e2,,__loader__} are now set to
@code{None}.

@end deffn

@geindex PyModule_New (C function)
@anchor{c-api/module c PyModule_New}@anchor{4966}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_New (const char *name)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4967,,PyModule_NewObject()}, pero el nombre es una cadena de caracteres codificada UTF-8 en lugar de un objeto Unicode.
@end deffn

@geindex PyModule_GetDict (C function)
@anchor{c-api/module c PyModule_GetDict}@anchor{4963}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_GetDict (PyObject *module)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex __dict__ (module attribute)

Retorna el objeto del diccionario que implementa el espacio de nombres de `module'; este objeto es el mismo que el atributo @ref{5fe,,__dict__} del objeto módulo. Si `module' no es un objeto módulo (o un subtipo de un objeto de módulo), se lanza @ref{619,,SystemError} y se retorna @code{NULL}.

It is recommended extensions use other @code{PyModule_*} and
@code{PyObject_*} functions rather than directly manipulate a module’s
@ref{5fe,,__dict__}.
@end deffn

@geindex PyModule_GetNameObject (C function)
@anchor{c-api/module c PyModule_GetNameObject}@anchor{4965}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_GetNameObject (PyObject *module)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
@geindex __name__ (module attribute)
@geindex SystemError (built-in exception)

Return `module'’s @ref{13e8,,__name__} value.  If the module does not
provide one, or if it is not a string, @ref{619,,SystemError} is raised and
@code{NULL} is returned.


Added in version 3.3.

@end deffn

@geindex PyModule_GetName (C function)
@anchor{c-api/module c PyModule_GetName}@anchor{4964}
@deffn {C Función} const char *PyModule_GetName (PyObject *module)
` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{4965,,PyModule_GetNameObject()} pero retorna el nombre codificado a @code{'utf-8'}.
@end deffn

@geindex PyModule_GetState (C function)
@anchor{c-api/module c PyModule_GetState}@anchor{a12}
@deffn {C Función} void *PyModule_GetState (PyObject *module)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el «estado» del módulo, es decir, un puntero al bloque de memoria asignado en el momento de la creación del módulo, o @code{NULL}. Ver @ref{a11,,PyModuleDef.m_size}.
@end deffn

@geindex PyModule_GetDef (C function)
@anchor{c-api/module c PyModule_GetDef}@anchor{4962}
@deffn {C Función} @ref{a0f,,PyModuleDef} *PyModule_GetDef (PyObject *module)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna un puntero a la estructura @ref{a0f,,PyModuleDef} a partir de la cual se creó el módulo, o @code{NULL} si el módulo no se creó a partir de una definición.
@end deffn

@geindex PyModule_GetFilenameObject (C function)
@anchor{c-api/module c PyModule_GetFilenameObject}@anchor{290}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_GetFilenameObject (PyObject *module)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@geindex __file__ (module attribute)
@geindex SystemError (built-in exception)

Return the name of the file from which `module' was loaded using `module'’s
@ref{1f1b,,__file__} attribute.  If this is not defined, or if it is not a
string, raise @ref{619,,SystemError} and return @code{NULL}; otherwise return
a reference to a Unicode object.


Added in version 3.2.

@end deffn

@geindex PyModule_GetFilename (C function)
@anchor{c-api/module c PyModule_GetFilename}@anchor{28f}
@deffn {C Función} const char *PyModule_GetFilename (PyObject *module)
` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{290,,PyModule_GetFilenameObject()} pero retorna el nombre de archivo codificado a “utf-8”.


Obsoleto desde la versión 3.2: @ref{28f,,PyModule_GetFilename()} raises @ref{718,,UnicodeEncodeError} on
unencodable filenames, use @ref{290,,PyModule_GetFilenameObject()} instead.

@end deffn

@menu
* Inicializando módulos en C:: 
* Búsqueda de módulos:: 

@end menu

@node Inicializando módulos en C,Búsqueda de módulos,,Objetos módulo
@anchor{c-api/module initializing-c-modules}@anchor{4c19}@anchor{c-api/module initializing-modules}@anchor{488c}
@subsubsection Inicializando módulos en C


Los objetos módulos generalmente se crean a partir de módulos de extensión (bibliotecas compartidas que exportan una función de inicialización) o módulos compilados (donde la función de inicialización se agrega usando @ref{17ab,,PyImport_AppendInittab()}). Consulte @ref{4838,,Construyendo extensiones C y C++} o @ref{48a5,,extendiendo con incrustación} para más detalles.

La función de inicialización puede pasar una instancia de definición de módulo a @ref{4835,,PyModule_Create()}, y retornar el objeto módulo resultante, o solicitar una «inicialización de múltiples fases» retornando la estructura de definición.

@geindex PyModuleDef (C type)
@anchor{c-api/module c PyModuleDef}@anchor{a0f}
@deffn {C Tipo} type PyModuleDef
` Part of the @ref{5f6,,Stable ABI} (including all members).'
La estructura de definición de módulo, que contiene toda la información necesaria para crear un objeto módulo. Por lo general, solo hay una variable estáticamente inicializada de este tipo para cada módulo.

@geindex PyModuleDef.m_base (C member)
@anchor{c-api/module c PyModuleDef m_base}@anchor{4c1a}
@deffn {C Miembro} PyModuleDef_Base m_base

Always initialize this member to @code{PyModuleDef_HEAD_INIT}.
@end deffn

@geindex PyModuleDef.m_name (C member)
@anchor{c-api/module c PyModuleDef m_name}@anchor{4c1b}
@deffn {C Miembro} const char *m_name

Nombre para el nuevo módulo.
@end deffn

@geindex PyModuleDef.m_doc (C member)
@anchor{c-api/module c PyModuleDef m_doc}@anchor{4c1c}
@deffn {C Miembro} const char *m_doc

Docstring para el módulo; por lo general, se usa una variable docstring creada con @ref{197b,,PyDoc_STRVAR}.
@end deffn

@geindex PyModuleDef.m_size (C member)
@anchor{c-api/module c PyModuleDef m_size}@anchor{a11}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} m_size

El estado del módulo se puede mantener en un área de memoria por módulo que se puede recuperar con @ref{a12,,PyModule_GetState()}, en lugar de en globales estáticos. Esto hace que los módulos sean seguros para su uso en múltiples sub-interpretadores.

This memory area is allocated based on `m_size' on module creation,
and freed when the module object is deallocated, after the
@ref{a0e,,m_free} function has been called, if present.

Establecer @code{m_size} en @code{-1} significa que el módulo no admite sub-interpretadores, porque tiene un estado global.

Establecerlo en un valor no negativo significa que el módulo se puede reinicializar y especifica la cantidad adicional de memoria que requiere para su estado. Se requiere @code{m_size} no negativo para la inicialización de múltiples fases.

Ver 
@geindex Python Enhancement Proposals; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/} para más detalles.
@end deffn

@geindex PyModuleDef.m_methods (C member)
@anchor{c-api/module c PyModuleDef m_methods}@anchor{4c1d}
@deffn {C Miembro} @ref{1517,,PyMethodDef} *m_methods

Un puntero a una tabla de funciones de nivel de módulo, descrito por valores @ref{1517,,PyMethodDef}. Puede ser @code{NULL} si no hay funciones presentes.
@end deffn

@geindex PyModuleDef.m_slots (C member)
@anchor{c-api/module c PyModuleDef m_slots}@anchor{4c1e}
@deffn {C Miembro} @ref{4c1f,,PyModuleDef_Slot} *m_slots

Un conjunto de definiciones de ranura para la inicialización de múltiples fases, terminadas por una entrada @code{@{0, NULL@}}. Cuando se utiliza la inicialización monofásica, `m_slots' debe ser @code{NULL}.


Distinto en la versión 3.5: Antes de la versión 3.5, este miembro siempre estaba configurado en @code{NULL} y se definía como:

@quotation

@geindex PyModuleDef.m_slots.m_reload (C member)
@anchor{c-api/module c PyModuleDef m_slots m_reload}@anchor{4c20}
@deffn {C Miembro} @ref{4a26,,inquiry} m_reload
@end deffn
@end quotation

@end deffn

@geindex PyModuleDef.m_traverse (C member)
@anchor{c-api/module c PyModuleDef m_traverse}@anchor{a0c}
@deffn {C Miembro} @ref{4a35,,traverseproc} m_traverse

Una función transversal para llamar durante el recorrido GC del objeto del módulo, o @code{NULL} si no es necesario.

This function is not called if the module state was requested but is not
allocated yet. This is the case immediately after the module is created
and before the module is executed (@ref{a10,,Py_mod_exec} function). More
precisely, this function is not called if @ref{a11,,m_size} is greater
than 0 and the module state (as returned by @ref{a12,,PyModule_GetState()})
is @code{NULL}.


Distinto en la versión 3.9: Ya no se llama antes de que se asigne el estado del módulo.

@end deffn

@geindex PyModuleDef.m_clear (C member)
@anchor{c-api/module c PyModuleDef m_clear}@anchor{a0d}
@deffn {C Miembro} @ref{4a26,,inquiry} m_clear

Una función clara para llamar durante la limpieza GC del objeto del módulo, o @code{NULL} si no es necesario.

This function is not called if the module state was requested but is not
allocated yet. This is the case immediately after the module is created
and before the module is executed (@ref{a10,,Py_mod_exec} function). More
precisely, this function is not called if @ref{a11,,m_size} is greater
than 0 and the module state (as returned by @ref{a12,,PyModule_GetState()})
is @code{NULL}.

Tal como @ref{4872,,PyTypeObject.tp_clear}, esta función no `siempre' es llamada antes de la designación de un módulo. Por ejemplo, cuando el recuento de referencias está  listo para determinar que un objeto no se usa más, la recolección de basura cíclica no se involucra y se llama a @ref{a0e,,m_free} directamente.


Distinto en la versión 3.9: Ya no se llama antes de que se asigne el estado del módulo.

@end deffn

@geindex PyModuleDef.m_free (C member)
@anchor{c-api/module c PyModuleDef m_free}@anchor{a0e}
@deffn {C Miembro} @ref{4c21,,freefunc} m_free

Una función para llamar durante la desasignación del objeto del módulo, o @code{NULL} si no es necesario.

This function is not called if the module state was requested but is not
allocated yet. This is the case immediately after the module is created
and before the module is executed (@ref{a10,,Py_mod_exec} function). More
precisely, this function is not called if @ref{a11,,m_size} is greater
than 0 and the module state (as returned by @ref{a12,,PyModule_GetState()})
is @code{NULL}.


Distinto en la versión 3.9: Ya no se llama antes de que se asigne el estado del módulo.

@end deffn
@end deffn

@menu
* Inicialización monofásica:: 
* Inicialización multifase:: 
* Funciones de creación de módulos de bajo nivel:: 
* Funciones de soporte:: 

@end menu

@node Inicialización monofásica,Inicialización multifase,,Inicializando módulos en C
@anchor{c-api/module single-phase-initialization}@anchor{4c22}
@subsubsection Inicialización monofásica


La función de inicialización del módulo puede crear y retornar el objeto módulo directamente. Esto se conoce como «inicialización monofásica» y utiliza una de las siguientes funciones de creación de dos módulos:

@geindex PyModule_Create (C function)
@anchor{c-api/module c PyModule_Create}@anchor{4835}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_Create (PyModuleDef *def)
`Return value: New reference.'
Create a new module object, given the definition in `def'.  This behaves
like @ref{4961,,PyModule_Create2()} with `module_api_version' set to
@code{PYTHON_API_VERSION}.
@end deffn

@geindex PyModule_Create2 (C function)
@anchor{c-api/module c PyModule_Create2}@anchor{4961}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_Create2 (PyModuleDef *def, int module_api_version)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un nuevo objeto de módulo, dada la definición en `def', asumiendo la versión de API `module_api_version'. Si esa versión no coincide con la versión del intérprete en ejecución, se emite un @ref{323,,RuntimeWarning}.

Return @code{NULL} with an exception set on error.

@cartouche
@quotation Nota 
La mayoría de los usos de esta función deberían usar @ref{4835,,PyModule_Create()} en su lugar; solo use esto si está seguro de que lo necesita.
@end quotation
@end cartouche
@end deffn

Antes de que se retorne desde la función de inicialización, el objeto del módulo resultante normalmente se llena utilizando funciones como @ref{459,,PyModule_AddObjectRef()}.

@node Inicialización multifase,Funciones de creación de módulos de bajo nivel,Inicialización monofásica,Inicializando módulos en C
@anchor{c-api/module id1}@anchor{4c23}@anchor{c-api/module multi-phase-initialization}@anchor{488d}
@subsubsection Inicialización multifase


An alternate way to specify extensions is to request «multi-phase initialization».
Extension modules created this way behave more like Python modules: the
initialization is split between the `creation phase', when the module object
is created, and the `execution phase', when it is populated.
The distinction is similar to the @code{__new__()} and @code{__init__()} methods
of classes.

Unlike modules created using single-phase initialization, these modules are not
singletons: if the `sys.modules' entry is removed and the module is re-imported,
a new module object is created, and the old module is subject to normal garbage
collection – as with Python modules.
By default, multiple modules created from the same definition should be
independent: changes to one should not affect the others.
This means that all state should be specific to the module object (using e.g.
using @ref{a12,,PyModule_GetState()}), or its contents (such as the module’s
@ref{5fe,,__dict__} or individual classes created with @ref{621,,PyType_FromSpec()}).

Se espera que todos los módulos creados mediante la inicialización de múltiples fases admitan @ref{62b,,sub-interpretadores}. Asegurándose de que varios módulos sean independientes suele ser suficiente para lograr esto.

Para solicitar la inicialización de múltiples fases, la función de inicialización (`PyInit_modulename') retorna una instancia de @ref{a0f,,PyModuleDef} con un @ref{4c1e,,m_slots} no vacío. Antes de que se retorna, la instancia @code{PyModuleDef} debe inicializarse con la siguiente función:

@geindex PyModuleDef_Init (C function)
@anchor{c-api/module c PyModuleDef_Init}@anchor{495f}
@deffn {C Función} @ref{42d,,PyObject} *PyModuleDef_Init (PyModuleDef *def)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.5.'
Asegura que la definición de un módulo sea un objeto Python correctamente inicializado que informe correctamente su tipo y conteo de referencias.

Retorna `def' convertido a @code{PyObject*} o @code{NULL} si se produjo un error.


Added in version 3.5.

@end deffn

El miembro `m_slots' de la definición del módulo debe apuntar a un arreglo de estructuras @code{PyModuleDef_Slot}:

@geindex PyModuleDef_Slot (C type)
@anchor{c-api/module c PyModuleDef_Slot}@anchor{4c1f}
@deffn {C Tipo} type PyModuleDef_Slot

@geindex PyModuleDef_Slot.slot (C member)
@anchor{c-api/module c PyModuleDef_Slot slot}@anchor{4c24}
@deffn {C Miembro} int slot

Una ranura ID, elegida entre los valores disponibles que se explican a continuación.
@end deffn

@geindex PyModuleDef_Slot.value (C member)
@anchor{c-api/module c PyModuleDef_Slot value}@anchor{4c25}
@deffn {C Miembro} void *value

Valor de la ranura, cuyo significado depende de la ID de la ranura.
@end deffn


Added in version 3.5.

@end deffn

El arreglo `m_slots' debe estar terminada por una ranura con id 0.

Los tipos de ranura disponibles son:

@geindex Py_mod_create (C macro)
@anchor{c-api/module c Py_mod_create}@anchor{4c26}
@deffn {C Macro} Py_mod_create

Especifica una función que se llama para crear el objeto del módulo en sí. El puntero `value' de este espacio debe apuntar a una función de la firma:

@anchor{c-api/module c Py_mod_create create_module}@anchor{4c27}
@deffn {C Función} @ref{42d,,PyObject} *create_module (PyObject *spec, PyModuleDef *def)
@end deffn

La función recibe una instancia de @ref{1e69,,ModuleSpec}, como se define en 
@geindex Python Enhancement Proposals; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}, y la definición del módulo. Debería retornar un nuevo objeto de módulo, o establecer un error y retornar @code{NULL}.

Esta función debe mantenerse mínima. En particular, no debería llamar a código arbitrario de Python, ya que intentar importar el mismo módulo nuevamente puede dar como resultado un bucle infinito.

Múltiples ranuras @code{Py_mod_create} no pueden especificarse en una definición de módulo.

Si no se especifica @code{Py_mod_create}, la maquinaria de importación creará un objeto de módulo normal usando @ref{4966,,PyModule_New()}. El nombre se toma de `spec', no de la definición, para permitir que los módulos de extensión se ajusten dinámicamente a su lugar en la jerarquía de módulos y se importen bajo diferentes nombres a través de enlaces simbólicos, todo mientras se comparte una definición de módulo único.

No es necesario que el objeto retornado sea una instancia de @ref{4969,,PyModule_Type}. Se puede usar cualquier tipo, siempre que admita la configuración y la obtención de atributos relacionados con la importación. Sin embargo, solo se pueden retornar instancias @code{PyModule_Type} si el @code{PyModuleDef} no tiene @code{NULL} @code{m_traverse}, @code{m_clear}, @code{m_free}; @code{m_size} distinto de cero; o ranuras que no sean @code{Py_mod_create}.
@end deffn

@geindex Py_mod_exec (C macro)
@anchor{c-api/module c Py_mod_exec}@anchor{a10}
@deffn {C Macro} Py_mod_exec

Especifica una función que se llama para ejecutar (`execute') el módulo. Esto es equivalente a ejecutar el código de un módulo Python: por lo general, esta función agrega clases y constantes al módulo. La firma de la función es:

@anchor{c-api/module c Py_mod_exec exec_module}@anchor{4c28}
@deffn {C Función} int exec_module (PyObject *module)
@end deffn

Si se especifican varias ranuras @code{Py_mod_exec}, se procesan en el orden en que aparecen en el arreglo `m_slots'.
@end deffn

@geindex Py_mod_multiple_interpreters (C macro)
@anchor{c-api/module c Py_mod_multiple_interpreters}@anchor{4c29}
@deffn {C Macro} Py_mod_multiple_interpreters

Specifies one of the following values:

@geindex Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED (C macro)
@anchor{c-api/module c Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED}@anchor{4c2a}
@deffn {C Macro} Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED

The module does not support being imported in subinterpreters.
@end deffn

@geindex Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED (C macro)
@anchor{c-api/module c Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED}@anchor{4c2b}
@deffn {C Macro} Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED

The module supports being imported in subinterpreters,
but only when they share the main interpreter’s GIL.
(See @ref{4c2c,,Aislamiento de módulos de extensión}.)
@end deffn

@geindex Py_MOD_PER_INTERPRETER_GIL_SUPPORTED (C macro)
@anchor{c-api/module c Py_MOD_PER_INTERPRETER_GIL_SUPPORTED}@anchor{4c2d}
@deffn {C Macro} Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

The module supports being imported in subinterpreters,
even when they have their own GIL.
(See @ref{4c2c,,Aislamiento de módulos de extensión}.)
@end deffn

This slot determines whether or not importing this module
in a subinterpreter will fail.

Multiple @code{Py_mod_multiple_interpreters} slots may not be specified
in one module definition.

If @code{Py_mod_multiple_interpreters} is not specified, the import
machinery defaults to @code{Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED}.


Added in version 3.12.

@end deffn

@geindex Py_mod_gil (C macro)
@anchor{c-api/module c Py_mod_gil}@anchor{2c4}
@deffn {C Macro} Py_mod_gil

Specifies one of the following values:

@geindex Py_MOD_GIL_USED (C macro)
@anchor{c-api/module c Py_MOD_GIL_USED}@anchor{4c2e}
@deffn {C Macro} Py_MOD_GIL_USED

The module depends on the presence of the global interpreter lock (GIL),
and may access global state without synchronization.
@end deffn

@geindex Py_MOD_GIL_NOT_USED (C macro)
@anchor{c-api/module c Py_MOD_GIL_NOT_USED}@anchor{4c2f}
@deffn {C Macro} Py_MOD_GIL_NOT_USED

The module is safe to run without an active GIL.
@end deffn

This slot is ignored by Python builds not configured with
@ref{2e0,,--disable-gil}.  Otherwise, it determines whether or not importing
this module will cause the GIL to be automatically enabled. See
@ref{2ac,,Free-threaded CPython} for more detail.

Multiple @code{Py_mod_gil} slots may not be specified in one module definition.

If @code{Py_mod_gil} is not specified, the import machinery defaults to
@code{Py_MOD_GIL_USED}.


Added in version 3.13.

@end deffn

Ver 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} para más detalles sobre la inicialización de múltiples fases.

@node Funciones de creación de módulos de bajo nivel,Funciones de soporte,Inicialización multifase,Inicializando módulos en C
@anchor{c-api/module low-level-module-creation-functions}@anchor{4c30}
@subsubsection Funciones de creación de módulos de bajo nivel


Las siguientes funciones se invocan en segundo plano cuando se utiliza la inicialización de múltiples fases. Se pueden usar directamente, por ejemplo, al crear objetos de módulo de forma dinámica. Tenga en cuenta que tanto @code{PyModule_FromDefAndSpec} como @code{PyModule_ExecDef} deben llamarse para inicializar completamente un módulo.

@geindex PyModule_FromDefAndSpec (C function)
@anchor{c-api/module c PyModule_FromDefAndSpec}@anchor{f33}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_FromDefAndSpec (PyModuleDef *def, PyObject *spec)
`Return value: New reference.'
Create a new module object, given the definition in `def' and the
ModuleSpec `spec'.  This behaves like @ref{f34,,PyModule_FromDefAndSpec2()}
with `module_api_version' set to @code{PYTHON_API_VERSION}.


Added in version 3.5.

@end deffn

@geindex PyModule_FromDefAndSpec2 (C function)
@anchor{c-api/module c PyModule_FromDefAndSpec2}@anchor{f34}
@deffn {C Función} @ref{42d,,PyObject} *PyModule_FromDefAndSpec2 (PyModuleDef *def, PyObject *spec, int module_api_version)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Create a new module object, given the definition in `def' and the
ModuleSpec `spec', assuming the API version `module_api_version'.
If that version does not match the version of the running interpreter,
a @ref{323,,RuntimeWarning} is emitted.

Return @code{NULL} with an exception set on error.

@cartouche
@quotation Nota 
La mayoría de los usos de esta función deberían usar @ref{f33,,PyModule_FromDefAndSpec()} en su lugar; solo use esto si está seguro de que lo necesita.
@end quotation
@end cartouche


Added in version 3.5.

@end deffn

@geindex PyModule_ExecDef (C function)
@anchor{c-api/module c PyModule_ExecDef}@anchor{f35}
@deffn {C Función} int PyModule_ExecDef (PyObject *module, PyModuleDef *def)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Procesa cualquier ranura de ejecución (@ref{a10,,Py_mod_exec}) dado en `def'.


Added in version 3.5.

@end deffn

@geindex PyModule_SetDocString (C function)
@anchor{c-api/module c PyModule_SetDocString}@anchor{4968}
@deffn {C Función} int PyModule_SetDocString (PyObject *module, const char *docstring)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Establece la cadena de caracteres de documentación para `module' en `docstring'. Esta función se llama automáticamente cuando se crea un módulo desde @code{PyModuleDef}, usando @code{PyModule_Create} o @code{PyModule_FromDefAndSpec}.


Added in version 3.5.

@end deffn

@geindex PyModule_AddFunctions (C function)
@anchor{c-api/module c PyModule_AddFunctions}@anchor{4960}
@deffn {C Función} int PyModule_AddFunctions (PyObject *module, PyMethodDef *functions)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Agrega las funciones del arreglo `functions' terminadas en @code{NULL} a `module'. Consulte la documentación de @ref{1517,,PyMethodDef} para obtener detalles sobre entradas individuales (debido a la falta de un espacio de nombres de módulo compartido, las «funciones» de nivel de módulo implementadas en C generalmente reciben el módulo como su primer parámetro, haciéndolos similares a la instancia métodos en clases de Python). Esta función se llama automáticamente cuando se crea un módulo desde @code{PyModuleDef}, usando @code{PyModule_Create} o @code{PyModule_FromDefAndSpec}.


Added in version 3.5.

@end deffn

@node Funciones de soporte,,Funciones de creación de módulos de bajo nivel,Inicializando módulos en C
@anchor{c-api/module support-functions}@anchor{4c31}
@subsubsection Funciones de soporte


La función de inicialización del módulo (si usa la inicialización de fase única) o una función llamada desde un intervalo de ejecución del módulo (si usa la inicialización de múltiples fases), puede usar las siguientes funciones para ayudar a inicializar el estado del módulo:

@geindex PyModule_AddObjectRef (C function)
@anchor{c-api/module c PyModule_AddObjectRef}@anchor{459}
@deffn {C Función} int PyModule_AddObjectRef (PyObject *module, const char *name, PyObject *value)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Agrega un objeto a `module' como `name'. Esta es una función de conveniencia que se puede usar desde la función de inicialización del módulo.

En caso de éxito, retorna @code{0}. En caso de error, lanza una excepción y retorna @code{-1}.

Return @code{-1} if `value' is @code{NULL}. It must be called with an exception
raised in this case.

Ejemplo de uso

@example
static int
add_spam(PyObject *module, int value)
@{
    PyObject *obj = PyLong_FromLong(value);
    if (obj == NULL) @{
        return -1;
    @}
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_DECREF(obj);
    return res;
 @}
@end example

El ejemplo puede también ser escrito sin verificar explicitamente si `obj' es @code{NULL}:

@example
static int
add_spam(PyObject *module, int value)
@{
    PyObject *obj = PyLong_FromLong(value);
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_XDECREF(obj);
    return res;
 @}
@end example

Note que @code{Py_XDECREF()} debería ser usado en vez de @code{Py_DECREF()} en este caso, ya que `obj' puede ser @code{NULL}.

The number of different `name' strings passed to this function
should be kept small, usually by only using statically allocated strings
as `name'.
For names that aren’t known at compile time, prefer calling
@ref{48a3,,PyUnicode_FromString()} and @ref{499b,,PyObject_SetAttr()} directly.
For more details, see @ref{1622,,PyUnicode_InternFromString()}, which may be
used internally to create a key object.


Added in version 3.10.

@end deffn

@geindex PyModule_Add (C function)
@anchor{c-api/module c PyModule_Add}@anchor{458}
@deffn {C Función} int PyModule_Add (PyObject *module, const char *name, PyObject *value)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Similar to @ref{459,,PyModule_AddObjectRef()}, but «steals» a reference
to `value'.
It can be called with a result of function that returns a new reference
without bothering to check its result or even saving it to a variable.

Ejemplo de uso

@example
if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) @{
    goto error;
@}
@end example


Added in version 3.13.

@end deffn

@geindex PyModule_AddObject (C function)
@anchor{c-api/module c PyModule_AddObject}@anchor{45a}
@deffn {C Función} int PyModule_AddObject (PyObject *module, const char *name, PyObject *value)
` Part of the @ref{5f6,,Stable ABI}.'
Similar a @ref{459,,PyModule_AddObjectRef()}, pero roba una referencia a `value' en caso de éxito (en este caso retorna @code{0}).

The new @ref{458,,PyModule_Add()} or @ref{459,,PyModule_AddObjectRef()}
functions are recommended, since it is
easy to introduce reference leaks by misusing the
@ref{45a,,PyModule_AddObject()} function.

@cartouche
@quotation Nota 
Unlike other functions that steal references, @code{PyModule_AddObject()}
only releases the reference to `value' `on success'.

This means that its return value must be checked, and calling code must
@ref{828,,Py_XDECREF()} `value' manually on error.
@end quotation
@end cartouche

Ejemplo de uso

@example
PyObject *obj = PyBytes_FromString(value);
if (PyModule_AddObject(module, "spam", obj) < 0) @{
    // If 'obj' is not NULL and PyModule_AddObject() failed,
    // 'obj' strong reference must be deleted with Py_XDECREF().
    // If 'obj' is NULL, Py_XDECREF() does nothing.
    Py_XDECREF(obj);
    goto error;
@}
// PyModule_AddObject() stole a reference to obj:
// Py_XDECREF(obj) is not needed here.
@end example


Obsoleto desde la versión 3.13: @ref{45a,,PyModule_AddObject()} is @ref{1c4,,soft deprecated}.

@end deffn

@geindex PyModule_AddIntConstant (C function)
@anchor{c-api/module c PyModule_AddIntConstant}@anchor{157c}
@deffn {C Función} int PyModule_AddIntConstant (PyObject *module, const char *name, long value)
` Part of the @ref{5f6,,Stable ABI}.'
Add an integer constant to `module' as `name'.  This convenience function can be
used from the module’s initialization function.
Return @code{-1} with an exception set on error, @code{0} on success.

This is a convenience function that calls @ref{1840,,PyLong_FromLong()} and
@ref{459,,PyModule_AddObjectRef()}; see their documentation for details.
@end deffn

@geindex PyModule_AddStringConstant (C function)
@anchor{c-api/module c PyModule_AddStringConstant}@anchor{157d}
@deffn {C Función} int PyModule_AddStringConstant (PyObject *module, const char *name, const char *value)
` Part of the @ref{5f6,,Stable ABI}.'
Add a string constant to `module' as `name'.  This convenience function can be
used from the module’s initialization function.  The string `value' must be
@code{NULL}-terminated.
Return @code{-1} with an exception set on error, @code{0} on success.

This is a convenience function that calls
@ref{1622,,PyUnicode_InternFromString()} and @ref{459,,PyModule_AddObjectRef()};
see their documentation for details.
@end deffn

@geindex PyModule_AddIntMacro (C macro)
@anchor{c-api/module c PyModule_AddIntMacro}@anchor{1433}
@deffn {C Macro} PyModule_AddIntMacro (module, macro)

Add an int constant to `module'. The name and the value are taken from
`macro'. For example @code{PyModule_AddIntMacro(module, AF_INET)} adds the int
constant `AF_INET' with the value of `AF_INET' to `module'.
Return @code{-1} with an exception set on error, @code{0} on success.
@end deffn

@geindex PyModule_AddStringMacro (C macro)
@anchor{c-api/module c PyModule_AddStringMacro}@anchor{1432}
@deffn {C Macro} PyModule_AddStringMacro (module, macro)

Agrega una constante de cadena de caracteres a `module'.
@end deffn

@geindex PyModule_AddType (C function)
@anchor{c-api/module c PyModule_AddType}@anchor{a07}
@deffn {C Función} int PyModule_AddType (PyObject *module, PyTypeObject *type)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Add a type object to `module'.
The type object is finalized by calling internally @ref{816,,PyType_Ready()}.
The name of the type object is taken from the last component of
@ref{18fb,,tp_name} after dot.
Return @code{-1} with an exception set on error, @code{0} on success.


Added in version 3.9.

@end deffn

@geindex PyUnstable_Module_SetGIL (C function)
@anchor{c-api/module c PyUnstable_Module_SetGIL}@anchor{2e5}
@deffn {C Función} int PyUnstable_Module_SetGIL (PyObject *module, void *gil)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Indicate that `module' does or does not support running without the global
interpreter lock (GIL), using one of the values from
@ref{2c4,,Py_mod_gil}. It must be called during `module'’s initialization
function. If this function is not called during module initialization, the
import machinery assumes the module does not support running without the
GIL. This function is only available in Python builds configured with
@ref{2e0,,--disable-gil}.
Return @code{-1} with an exception set on error, @code{0} on success.


Added in version 3.13.

@end deffn

@node Búsqueda de módulos,,Inicializando módulos en C,Objetos módulo
@anchor{c-api/module module-lookup}@anchor{4c32}
@subsubsection Búsqueda de módulos


La inicialización monofásica crea módulos singleton que se pueden buscar en el contexto del intérprete actual. Esto permite que el objeto módulo se recupere más tarde con solo una referencia a la definición del módulo.

Estas funciones no funcionarán en módulos creados mediante la inicialización de múltiples fases, ya que se pueden crear múltiples módulos de este tipo desde una sola definición.

@geindex PyState_FindModule (C function)
@anchor{c-api/module c PyState_FindModule}@anchor{49b7}
@deffn {C Función} @ref{42d,,PyObject} *PyState_FindModule (PyModuleDef *def)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna el objeto módulo que se creó a partir de `def' para el intérprete actual. Este método requiere que el objeto módulo se haya adjuntado al estado del intérprete con @ref{49b6,,PyState_AddModule()} de antemano. En caso de que el objeto módulo correspondiente no se encuentre o no se haya adjuntado al estado del intérprete, retornará @code{NULL}.
@end deffn

@geindex PyState_AddModule (C function)
@anchor{c-api/module c PyState_AddModule}@anchor{49b6}
@deffn {C Función} int PyState_AddModule (PyObject *module, PyModuleDef *def)
` Part of the @ref{5f6,,Stable ABI} since version 3.3.'
Adjunta el objeto del módulo pasado a la función al estado del intérprete. Esto permite que se pueda acceder al objeto del módulo a través de @ref{49b7,,PyState_FindModule()}.

Solo es efectivo en módulos creados con la inicialización monofásica.

Python llama a @code{PyState_AddModule} automáticamente después de importar un módulo, por lo que es innecesario (pero inofensivo) llamarlo desde el código de inicialización del módulo. Solo se necesita una llamada explícita si el propio código de inicio del módulo llama posteriormente @code{PyState_FindModule}. La función está destinada principalmente a implementar mecanismos de importación alternativos (ya sea llamándolo directamente o refiriéndose a su implementación para obtener detalles de las actualizaciones de estado requeridas).

La persona que llama debe retener el GIL.

Return @code{-1} with an exception set on error, @code{0} on success.


Added in version 3.3.

@end deffn

@geindex PyState_RemoveModule (C function)
@anchor{c-api/module c PyState_RemoveModule}@anchor{49b8}
@deffn {C Función} int PyState_RemoveModule (PyModuleDef *def)
` Part of the @ref{5f6,,Stable ABI} since version 3.3.'
Removes the module object created from `def' from the interpreter state.
Return @code{-1} with an exception set on error, @code{0} on success.

La persona que llama debe retener el GIL.


Added in version 3.3.

@end deffn

@node Objetos iteradores,Objetos descriptores,Objetos módulo,Otros objetos<2>
@anchor{c-api/iterator doc}@anchor{4c33}@anchor{c-api/iterator id1}@anchor{4c34}@anchor{c-api/iterator iterator-objects}@anchor{4c35}
@subsubsection Objetos iteradores


Python provides two general-purpose iterator objects.  The first, a sequence
iterator, works with an arbitrary sequence supporting the @ref{3d8,,__getitem__()}
method.  The second works with a callable object and a sentinel value, calling
the callable for each item in the sequence, and ending the iteration when the
sentinel value is returned.

@geindex PySeqIter_Type (C var)
@anchor{c-api/iterator c PySeqIter_Type}@anchor{49a0}
@deffn {C Variable} @ref{b30,,PyTypeObject} PySeqIter_Type
` Part of the @ref{5f6,,Stable ABI}.'
Objeto tipo para objetos iteradores retornados por @ref{499f,,PySeqIter_New()} y la forma de un argumento de la función incorporada @ref{86e,,iter()} para los tipos de secuencia incorporados.
@end deffn

@geindex PySeqIter_Check (C function)
@anchor{c-api/iterator c PySeqIter_Check}@anchor{4c36}
@deffn {C Función} int PySeqIter_Check (PyObject *op)

Retorna verdadero si el tipo de `op' es @ref{49a0,,PySeqIter_Type}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PySeqIter_New (C function)
@anchor{c-api/iterator c PySeqIter_New}@anchor{499f}
@deffn {C Función} @ref{42d,,PyObject} *PySeqIter_New (PyObject *seq)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un iterador que funciona con un objeto de secuencia general, `seq'. La iteración termina cuando la secuencia lanza @ref{1575,,IndexError} para la operación de suscripción.
@end deffn

@geindex PyCallIter_Type (C var)
@anchor{c-api/iterator c PyCallIter_Type}@anchor{48ee}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyCallIter_Type
` Part of the @ref{5f6,,Stable ABI}.'
Objeto tipo para los objetos iteradores retornados por @ref{48ed,,PyCallIter_New()} y la forma de dos argumentos de la función incorporada @ref{86e,,iter()}.
@end deffn

@geindex PyCallIter_Check (C function)
@anchor{c-api/iterator c PyCallIter_Check}@anchor{4c37}
@deffn {C Función} int PyCallIter_Check (PyObject *op)

Retorna verdadero si el tipo de `op' es @ref{48ee,,PyCallIter_Type}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyCallIter_New (C function)
@anchor{c-api/iterator c PyCallIter_New}@anchor{48ed}
@deffn {C Función} @ref{42d,,PyObject} *PyCallIter_New (PyObject *callable, PyObject *sentinel)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un nuevo iterador. El primer parámetro, `callable', puede ser cualquier objeto invocable de Python que se pueda invocar sin parámetros; cada llamada debe retornar el siguiente elemento en la iteración. Cuando `callable' retorna un valor igual a `sentinel', la iteración finalizará.
@end deffn

@node Objetos descriptores,Objetos rebanada slice,Objetos iteradores,Otros objetos<2>
@anchor{c-api/descriptor doc}@anchor{4c38}@anchor{c-api/descriptor descriptor-objects}@anchor{4c39}@anchor{c-api/descriptor id1}@anchor{4c3a}
@subsubsection Objetos descriptores


Los «descriptores» son objetos que describen algún atributo de un objeto. Se encuentran en el diccionario de objetos tipo.

@c XXX document these!

@geindex PyProperty_Type (C var)
@anchor{c-api/descriptor c PyProperty_Type}@anchor{499e}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyProperty_Type
` Part of the @ref{5f6,,Stable ABI}.'
El objeto de tipo para los tipos de descriptor incorporado.
@end deffn

@geindex PyDescr_NewGetSet (C function)
@anchor{c-api/descriptor c PyDescr_NewGetSet}@anchor{490b}
@deffn {C Función} @ref{42d,,PyObject} *PyDescr_NewGetSet (PyTypeObject *type, struct PyGetSetDef *getset)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyDescr_NewMember (C function)
@anchor{c-api/descriptor c PyDescr_NewMember}@anchor{490c}
@deffn {C Función} @ref{42d,,PyObject} *PyDescr_NewMember (PyTypeObject *type, struct PyMemberDef *meth)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyDescr_NewMethod (C function)
@anchor{c-api/descriptor c PyDescr_NewMethod}@anchor{1995}
@deffn {C Función} @ref{42d,,PyObject} *PyDescr_NewMethod (PyTypeObject *type, struct PyMethodDef *meth)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyDescr_NewWrapper (C function)
@anchor{c-api/descriptor c PyDescr_NewWrapper}@anchor{4c3b}
@deffn {C Función} @ref{42d,,PyObject} *PyDescr_NewWrapper (PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
`Return value: New reference.'
@end deffn

@geindex PyDescr_NewClassMethod (C function)
@anchor{c-api/descriptor c PyDescr_NewClassMethod}@anchor{490a}
@deffn {C Función} @ref{42d,,PyObject} *PyDescr_NewClassMethod (PyTypeObject *type, PyMethodDef *method)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyDescr_IsData (C function)
@anchor{c-api/descriptor c PyDescr_IsData}@anchor{18fe}
@deffn {C Función} int PyDescr_IsData (PyObject *descr)

Retorna distinto de cero si el descriptor objetos `descr' describe un atributo de datos, o @code{0} si describe un método. `descr' debe ser un objeto descriptor; no hay comprobación de errores.
@end deffn

@geindex PyWrapper_New (C function)
@anchor{c-api/descriptor c PyWrapper_New}@anchor{4a0a}
@deffn {C Función} @ref{42d,,PyObject} *PyWrapper_New (PyObject*, PyObject*)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@node Objetos rebanada slice,Objetos de vista de memoria MemoryView,Objetos descriptores,Otros objetos<2>
@anchor{c-api/slice doc}@anchor{4c3c}@anchor{c-api/slice id1}@anchor{4c3d}@anchor{c-api/slice slice-objects}@anchor{4c3e}
@subsubsection Objetos rebanada (`slice')


@geindex PySlice_Type (C var)
@anchor{c-api/slice c PySlice_Type}@anchor{49b5}
@deffn {C Variable} @ref{b30,,PyTypeObject} PySlice_Type
` Part of the @ref{5f6,,Stable ABI}.'
El objeto tipo para objetos rebanadas. Esto es lo mismo que @ref{514,,slice} en la capa de Python.
@end deffn

@geindex PySlice_Check (C function)
@anchor{c-api/slice c PySlice_Check}@anchor{4c3f}
@deffn {C Función} int PySlice_Check (PyObject *ob)

Retorna verdadero si `ob' es un objeto rebanada; `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PySlice_New (C function)
@anchor{c-api/slice c PySlice_New}@anchor{49b4}
@deffn {C Función} @ref{42d,,PyObject} *PySlice_New (PyObject *start, PyObject *stop, PyObject *step)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a new slice object with the given values.  The `start', `stop', and
`step' parameters are used as the values of the slice object attributes of
the same names.  Any of the values may be @code{NULL}, in which case the
@code{None} will be used for the corresponding attribute.

Return @code{NULL} with an exception set if
the new object could not be allocated.
@end deffn

@geindex PySlice_GetIndices (C function)
@anchor{c-api/slice c PySlice_GetIndices}@anchor{49b3}
@deffn {C Función} int PySlice_GetIndices (PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` Part of the @ref{5f6,,Stable ABI}.'
Recupera los índices `start', `stop' y `step' del objeto rebanada `slice', suponiendo una secuencia de longitud `length'. Trata los índices mayores que `length' como errores.

Retorna @code{0} en caso de éxito y @code{-1} en caso de error sin excepción establecida (a menos que uno de los índices no sea @code{None} y no se haya convertido a un entero, en cuyo caso @code{- 1} se retorna con una excepción establecida).

Probablemente no quiera usar esta función.


Distinto en la versión 3.2: El tipo de parámetro para el parámetro `slice' era @code{PySliceObject*} antes.

@end deffn

@geindex PySlice_GetIndicesEx (C function)
@anchor{c-api/slice c PySlice_GetIndicesEx}@anchor{293}
@deffn {C Función} int PySlice_GetIndicesEx (PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)
` Part of the @ref{5f6,,Stable ABI}.'
Reemplazo utilizable para @ref{49b3,,PySlice_GetIndices()}. Recupera los índices de `start', `stop', y `step' del objeto rebanada `slice' asumiendo una secuencia de longitud `length', y almacena la longitud de la rebanada en `slicelength'. Los índices fuera de los límites se recortan de manera coherente con el manejo de sectores normales.

Return @code{0} on success and @code{-1} on error with an exception set.

@cartouche
@quotation Nota 
Esta función se considera no segura para secuencias redimensionables. Su invocación debe ser reemplazada por una combinación de @ref{294,,PySlice_Unpack()} y @ref{295,,PySlice_AdjustIndices()} donde:

@example
if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) @{
    // return error
@}
@end example

es reemplazado por:

@example
if (PySlice_Unpack(slice, &start, &stop, &step) < 0) @{
    // return error
@}
slicelength = PySlice_AdjustIndices(length, &start, &stop, step);
@end example
@end quotation
@end cartouche


Distinto en la versión 3.2: El tipo de parámetro para el parámetro `slice' era @code{PySliceObject*} antes.



Distinto en la versión 3.6.1: Si @code{Py_LIMITED_API} no se establece o establece el valor entre @code{0x03050400} y @code{0x03060000} (sin incluir) o @code{0x03060100} o un superior @code{PySlice_GetIndicesEx()} se implementa como un macro usando @code{ PySlice_Unpack()} y @code{PySlice_AdjustIndices()}. Los argumentos `start', `stop' y `step' se evalúan más de una vez.



Obsoleto desde la versión 3.6.1: Si @code{Py_LIMITED_API} se establece en un valor menor que @code{0x03050400} o entre @code{0x03060000} y @code{0x03060100} (sin incluir) @code{PySlice_GetIndicesEx()} es una función obsoleta.

@end deffn

@geindex PySlice_Unpack (C function)
@anchor{c-api/slice c PySlice_Unpack}@anchor{294}
@deffn {C Función} int PySlice_Unpack (PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Extrae los miembros de datos `start', `stop', y `step' de un objeto rebanada como enteros en C. Reduce silenciosamente los valores mayores que @code{PY_SSIZE_T_MAX} a @code{PY_SSIZE_T_MAX}, aumenta silenciosamente los valores `start' y `stop' inferiores a @code{PY_SSIZE_T_MIN} a @code{PY_SSIZE_T_MIN}, y silenciosamente aumenta los valores de `step' a menos de @code{-PY_SSE} a @code{-PY_SSIZE_T_MAX}.

Return @code{-1} with an exception set on error, @code{0} on success.


Added in version 3.6.1.

@end deffn

@geindex PySlice_AdjustIndices (C function)
@anchor{c-api/slice c PySlice_AdjustIndices}@anchor{295}
@deffn {C Función} @ref{af0,,Py_ssize_t} PySlice_AdjustIndices (Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Ajusta los índices de corte de inicio/fin asumiendo una secuencia de la longitud especificada. Los índices fuera de los límites se recortan de manera coherente con el manejo de sectores normales.

Retorna la longitud de la rebanada. Siempre exitoso. No llama al código de Python.


Added in version 3.6.1.

@end deffn

@menu
* Objeto elipsis:: 

@end menu

@node Objeto elipsis,,,Objetos rebanada slice
@anchor{c-api/slice ellipsis-object}@anchor{4c40}
@subsubsection Objeto elipsis


@geindex Py_Ellipsis (C var)
@anchor{c-api/slice c Py_Ellipsis}@anchor{4c41}
@deffn {C Variable} @ref{42d,,PyObject} *Py_Ellipsis

The Python @code{Ellipsis} object.  This object has no methods.  Like
@ref{4831,,Py_None}, it is an @ref{429d,,immortal} singleton object.


Distinto en la versión 3.12: @ref{4c41,,Py_Ellipsis} es inmortal.

@end deffn

@geindex object;memoryview
@anchor{c-api/memoryview memoryview-objects}@anchor{4af0}
@node Objetos de vista de memoria MemoryView,Objetos de referencia débil,Objetos rebanada slice,Otros objetos<2>
@anchor{c-api/memoryview doc}@anchor{4c42}@anchor{c-api/memoryview id1}@anchor{4c43}
@subsubsection Objetos de vista de memoria (`MemoryView')


Un objeto @ref{156,,memoryview} expone la @ref{48a,,interfaz de búfer} a nivel de C como un objeto Python que luego puede pasarse como cualquier otro objeto.

@geindex PyMemoryView_FromObject (C function)
@anchor{c-api/memoryview c PyMemoryView_FromObject}@anchor{495d}
@deffn {C Función} @ref{42d,,PyObject} *PyMemoryView_FromObject (PyObject *obj)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto de vista de memoria `memoryview' a partir de un objeto que proporciona la interfaz del búfer. Si `obj' admite exportaciones de búfer de escritura, el objeto de vista de memoria será de lectura/escritura, de lo contrario puede ser de solo lectura o de lectura/escritura a discreción del exportador.
@end deffn

@geindex PyBUF_READ (C macro)
@anchor{c-api/memoryview c PyBUF_READ}@anchor{169a}
@deffn {C Macro} PyBUF_READ

Flag to request a readonly buffer.
@end deffn

@geindex PyBUF_WRITE (C macro)
@anchor{c-api/memoryview c PyBUF_WRITE}@anchor{169b}
@deffn {C Macro} PyBUF_WRITE

Flag to request a writable buffer.
@end deffn

@geindex PyMemoryView_FromMemory (C function)
@anchor{c-api/memoryview c PyMemoryView_FromMemory}@anchor{11e1}
@deffn {C Función} @ref{42d,,PyObject} *PyMemoryView_FromMemory (char *mem, Py_ssize_t size, int flags)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Crea un objeto de vista de memoria usando `mem' como el búfer subyacente. `flags' pueden ser uno de @ref{169a,,PyBUF_READ} o @ref{169b,,PyBUF_WRITE}.


Added in version 3.3.

@end deffn

@geindex PyMemoryView_FromBuffer (C function)
@anchor{c-api/memoryview c PyMemoryView_FromBuffer}@anchor{7fb}
@deffn {C Función} @ref{42d,,PyObject} *PyMemoryView_FromBuffer (const Py_buffer *view)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
Crea un objeto de vista de memoria que ajuste la estructura de búfer dada `view'. Para memorias intermedias de bytes simples, @ref{11e1,,PyMemoryView_FromMemory()} es la función preferida.
@end deffn

@geindex PyMemoryView_GetContiguous (C function)
@anchor{c-api/memoryview c PyMemoryView_GetContiguous}@anchor{495e}
@deffn {C Función} @ref{42d,,PyObject} *PyMemoryView_GetContiguous (PyObject *obj, int buffertype, char order)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un objeto de vista de memoria `memoryview' para un fragmento de memoria contiguo (@ref{222d,,contiguous}, en `order' “C” o “F” de Fortran) desde un objeto que define la interfaz del búfer. Si la memoria es contigua, el objeto de vista de memoria apunta a la memoria original. De lo contrario, se realiza una copia y la vista de memoria apunta a un nuevo objeto de bytes.

`buffertype' can be one of @ref{169a,,PyBUF_READ} or @ref{169b,,PyBUF_WRITE}.
@end deffn

@geindex PyMemoryView_Check (C function)
@anchor{c-api/memoryview c PyMemoryView_Check}@anchor{4c44}
@deffn {C Función} int PyMemoryView_Check (PyObject *obj)

Retorna verdadero si el objeto `obj' es un objeto de vista de memoria. Actualmente no está permitido crear subclases de @ref{156,,memoryview}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyMemoryView_GET_BUFFER (C function)
@anchor{c-api/memoryview c PyMemoryView_GET_BUFFER}@anchor{4c45}
@deffn {C Función} @ref{7f2,,Py_buffer} *PyMemoryView_GET_BUFFER (PyObject *mview)

Retorna un puntero a la copia privada de la vista de memoria del búfer del exportador. `mview' `debe' ser una instancia de `memoryview'; este macro no verifica su tipo, debe hacerlo usted mismo o correrá el riesgo de fallas.
@end deffn

@geindex PyMemoryView_GET_BASE (C function)
@anchor{c-api/memoryview c PyMemoryView_GET_BASE}@anchor{4c46}
@deffn {C Función} @ref{42d,,PyObject} *PyMemoryView_GET_BASE (PyObject *mview)

Retorna un puntero al objeto de exportación en el que se basa la vista de memoria o @code{NULL} si la vista de memoria ha sido creada por una de las funciones @ref{11e1,,PyMemoryView_FromMemory()} o @ref{7fb,,PyMemoryView_FromBuffer()}. `mview' `debe' ser una instancia de `memoryview'.
@end deffn

@node Objetos de referencia débil,Cápsulas<2>,Objetos de vista de memoria MemoryView,Otros objetos<2>
@anchor{c-api/weakref doc}@anchor{4c47}@anchor{c-api/weakref weak-reference-objects}@anchor{4c48}@anchor{c-api/weakref weakrefobjects}@anchor{4c49}
@subsubsection Objetos de referencia débil


Python soporta `referencias débiles' como objetos de primera clase. Hay dos tipos de objetos específicos que implementan directamente referencias débiles. El primero es un objeto con referencia simple, y el segundo actúa como un proxy del objeto original tanto como pueda.

@geindex PyWeakref_Check (C function)
@anchor{c-api/weakref c PyWeakref_Check}@anchor{4c4a}
@deffn {C Función} int PyWeakref_Check (PyObject *ob)

Return non-zero if `ob' is either a reference or proxy object.  This function
always succeeds.
@end deffn

@geindex PyWeakref_CheckRef (C function)
@anchor{c-api/weakref c PyWeakref_CheckRef}@anchor{4c4b}
@deffn {C Función} int PyWeakref_CheckRef (PyObject *ob)

Return non-zero if `ob' is a reference object.  This function always succeeds.
@end deffn

@geindex PyWeakref_CheckProxy (C function)
@anchor{c-api/weakref c PyWeakref_CheckProxy}@anchor{4c4c}
@deffn {C Función} int PyWeakref_CheckProxy (PyObject *ob)

Return non-zero if `ob' is a proxy object.  This function always succeeds.
@end deffn

@geindex PyWeakref_NewRef (C function)
@anchor{c-api/weakref c PyWeakref_NewRef}@anchor{1856}
@deffn {C Función} @ref{42d,,PyObject} *PyWeakref_NewRef (PyObject *ob, PyObject *callback)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a weak reference object for the object `ob'.  This will always return
a new reference, but is not guaranteed to create a new object; an existing
reference object may be returned.  The second parameter, `callback', can be a
callable object that receives notification when `ob' is garbage collected; it
should accept a single parameter, which will be the weak reference object
itself. `callback' may also be @code{None} or @code{NULL}.  If `ob' is not a
weakly referenceable object, or if `callback' is not callable, @code{None}, or
@code{NULL}, this will return @code{NULL} and raise @ref{228,,TypeError}.
@end deffn

@geindex PyWeakref_NewProxy (C function)
@anchor{c-api/weakref c PyWeakref_NewProxy}@anchor{4a09}
@deffn {C Función} @ref{42d,,PyObject} *PyWeakref_NewProxy (PyObject *ob, PyObject *callback)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a weak reference proxy object for the object `ob'.  This will always
return a new reference, but is not guaranteed to create a new object; an
existing proxy object may be returned.  The second parameter, `callback', can
be a callable object that receives notification when `ob' is garbage
collected; it should accept a single parameter, which will be the weak
reference object itself. `callback' may also be @code{None} or @code{NULL}.  If `ob'
is not a weakly referenceable object, or if `callback' is not callable,
@code{None}, or @code{NULL}, this will return @code{NULL} and raise @ref{228,,TypeError}.
@end deffn

@geindex PyWeakref_GetRef (C function)
@anchor{c-api/weakref c PyWeakref_GetRef}@anchor{276}
@deffn {C Función} int PyWeakref_GetRef (PyObject *ref, PyObject **pobj)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Get a @ref{431,,strong reference} to the referenced object from a weak
reference, `ref', into `*pobj'.


@itemize *

@item 
On success, set `*pobj' to a new @ref{431,,strong reference} to the
referenced object and return 1.

@item 
If the reference is dead, set `*pobj' to @code{NULL} and return 0.

@item 
On error, raise an exception and return -1.
@end itemize


Added in version 3.13.

@end deffn

@geindex PyWeakref_GetObject (C function)
@anchor{c-api/weakref c PyWeakref_GetObject}@anchor{274}
@deffn {C Función} @ref{42d,,PyObject} *PyWeakref_GetObject (PyObject *ref)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Return a @ref{432,,borrowed reference} to the referenced object from a weak
reference, `ref'.  If the referent is no longer live, returns @code{Py_None}.

@cartouche
@quotation Nota 
Esta función retorna una referencia @ref{432,,borrowed reference} al objeto referenciado. Esto significa que siempre debe llamar a @ref{612,,Py_INCREF()} sobre el objeto, excepto cuando no pueda ser destruido antes del último uso de la referencia prestada.
@end quotation
@end cartouche


Deprecated since version 3.13, will be removed in version 3.15: Use @ref{276,,PyWeakref_GetRef()} instead.

@end deffn

@geindex PyWeakref_GET_OBJECT (C function)
@anchor{c-api/weakref c PyWeakref_GET_OBJECT}@anchor{275}
@deffn {C Función} @ref{42d,,PyObject} *PyWeakref_GET_OBJECT (PyObject *ref)
`Return value: Borrowed reference.'
Similar to @ref{274,,PyWeakref_GetObject()}, but does no error checking.


Deprecated since version 3.13, will be removed in version 3.15: Use @ref{276,,PyWeakref_GetRef()} instead.

@end deffn

@geindex PyObject_ClearWeakRefs (C function)
@anchor{c-api/weakref c PyObject_ClearWeakRefs}@anchor{61a}
@deffn {C Función} void PyObject_ClearWeakRefs (PyObject *object)
` Part of the @ref{5f6,,Stable ABI}.'
This function is called by the @ref{485f,,tp_dealloc} handler
to clear weak references.

This iterates through the weak references for `object' and calls callbacks
for those references which have one. It returns when all callbacks have
been attempted.
@end deffn

@geindex PyUnstable_Object_ClearWeakRefsNoCallbacks (C function)
@anchor{c-api/weakref c PyUnstable_Object_ClearWeakRefsNoCallbacks}@anchor{162c}
@deffn {C Función} void PyUnstable_Object_ClearWeakRefsNoCallbacks (PyObject *object)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Clears the weakrefs for `object' without calling the callbacks.

This function is called by the @ref{485f,,tp_dealloc} handler
for types with finalizers (i.e., @ref{1f60,,__del__()}).  The handler for
those objects first calls @ref{61a,,PyObject_ClearWeakRefs()} to clear weakrefs
and call their callbacks, then the finalizer, and finally this function to
clear any weakrefs that may have been created by the finalizer.

In most circumstances, it’s more appropriate to use
@ref{61a,,PyObject_ClearWeakRefs()} to clear weakrefs instead of this function.


Added in version 3.13.

@end deffn

@node Cápsulas<2>,Objetos frame,Objetos de referencia débil,Otros objetos<2>
@anchor{c-api/capsule doc}@anchor{4c4d}@anchor{c-api/capsule capsules}@anchor{257a}@anchor{c-api/capsule id1}@anchor{4c4e}
@subsubsection Cápsulas


@geindex object;Capsule

Consulta @ref{13bd,,Proporcionar una API C para un módulo de extensión} para obtener más información sobre el uso de estos objetos.


Added in version 3.1.


@geindex PyCapsule (C type)
@anchor{c-api/capsule c PyCapsule}@anchor{12e0}
@deffn {C Tipo} type PyCapsule

Este subtipo de @ref{42d,,PyObject} representa un valor opaco, útil para los módulos de extensión C que necesitan pasar un valor opaco (como un puntero void*) a través del código Python a otro código C . A menudo se usa para hacer que un puntero de función C definido en un módulo esté disponible para otros módulos, por lo que el mecanismo de importación regular se puede usar para acceder a las API C definidas en módulos cargados dinámicamente.
@end deffn

@geindex PyCapsule_Destructor (C type)
@anchor{c-api/capsule c PyCapsule_Destructor}@anchor{48f0}
@deffn {C Tipo} type PyCapsule_Destructor
` Part of the @ref{5f6,,Stable ABI}.'
El tipo de devolución de llamada de un destructor para una cápsula. Definido como:

@example
typedef void (*PyCapsule_Destructor)(PyObject *);
@end example

Consulte @ref{4854,,PyCapsule_New()} para conocer la semántica de las devoluciones de llamada de @cite{PyCapsule_Destructor}.
@end deffn

@geindex PyCapsule_CheckExact (C function)
@anchor{c-api/capsule c PyCapsule_CheckExact}@anchor{4c4f}
@deffn {C Función} int PyCapsule_CheckExact (PyObject *p)

Retorna verdadero si su argumento es a @ref{12e0,,PyCapsule}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyCapsule_New (C function)
@anchor{c-api/capsule c PyCapsule_New}@anchor{4854}
@deffn {C Función} @ref{42d,,PyObject} *PyCapsule_New (void *pointer, const char *name, PyCapsule_Destructor destructor)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Crea un @ref{12e0,,PyCapsule} encapsulando el `pointer'. El argumento `pointer' puede no ser @code{NULL}.

En caso de falla, establece una excepción y retorna @code{NULL}.

La cadena de caracteres `name' puede ser @code{NULL} o un puntero a una cadena C válida. Si no es @code{NULL}, esta cadena de caracteres debe sobrevivir a la cápsula. (Aunque está permitido liberarlo dentro del `destructor').

Si el argumento `destructor' no es @code{NULL}, se llamará con la cápsula como argumento cuando se destruya.

Si esta cápsula se almacenará como un atributo de un módulo, el nombre `name' debe especificarse como @code{modulename.attributename}. Esto permitirá que otros módulos importen la cápsula usando @ref{1875,,PyCapsule_Import()}.
@end deffn

@geindex PyCapsule_GetPointer (C function)
@anchor{c-api/capsule c PyCapsule_GetPointer}@anchor{48f4}
@deffn {C Función} void *PyCapsule_GetPointer (PyObject *capsule, const char *name)
` Part of the @ref{5f6,,Stable ABI}.'
Recupera el `pointer' almacenado en la cápsula. En caso de falla, establece una excepción y retorna  @code{NULL}.

The `name' parameter must compare exactly to the name stored in the capsule.
If the name stored in the capsule is @code{NULL}, the `name' passed in must also
be @code{NULL}.  Python uses the C function @code{strcmp()} to compare capsule
names.
@end deffn

@geindex PyCapsule_GetDestructor (C function)
@anchor{c-api/capsule c PyCapsule_GetDestructor}@anchor{48f2}
@deffn {C Función} @ref{48f0,,PyCapsule_Destructor} PyCapsule_GetDestructor (PyObject *capsule)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el destructor actual almacenado en la cápsula. En caso de falla, establece una excepción y retorna @code{NULL}.

Es legal que una cápsula tenga un destructor @code{NULL}. Esto hace que un código de retorno @code{NULL} sea algo ambiguo; use @ref{13bc,,PyCapsule_IsValid()} o @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_GetContext (C function)
@anchor{c-api/capsule c PyCapsule_GetContext}@anchor{48f1}
@deffn {C Función} void *PyCapsule_GetContext (PyObject *capsule)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el contexto actual almacenado en la cápsula. En caso de falla, establece una excepción y retorna @code{NULL}.

Es legal que una cápsula tenga un contexto @code{NULL}. Esto hace que un código de retorno @code{NULL} sea algo ambiguo; use @ref{13bc,,PyCapsule_IsValid()} o @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_GetName (C function)
@anchor{c-api/capsule c PyCapsule_GetName}@anchor{48f3}
@deffn {C Función} const char *PyCapsule_GetName (PyObject *capsule)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el nombre actual almacenado en la cápsula. En caso de falla, establece una excepción y retorna @code{NULL}.

Es legal que una cápsula tenga un nombre @code{NULL}. Esto hace que un código de retorno @code{NULL} sea algo ambiguo; use @ref{13bc,,PyCapsule_IsValid()} o @ref{18fa,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_Import (C function)
@anchor{c-api/capsule c PyCapsule_Import}@anchor{1875}
@deffn {C Función} void *PyCapsule_Import (const char *name, int no_block)
` Part of the @ref{5f6,,Stable ABI}.'
Importa un puntero a un objeto C desde un atributo cápsula en un módulo. El parámetro `name' debe especificar el nombre completo del atributo, como en @code{module.attribute}. El nombre `name' almacenado en la cápsula debe coincidir exactamente con esta cadena de caracteres.

Retorna el puntero `pointer' interno de la cápsula en caso de éxito. En caso de falla, establece una excepción y retorna @code{NULL}.


Distinto en la versión 3.3: `no_block' ya no tiene efecto.

@end deffn

@geindex PyCapsule_IsValid (C function)
@anchor{c-api/capsule c PyCapsule_IsValid}@anchor{13bc}
@deffn {C Función} int PyCapsule_IsValid (PyObject *capsule, const char *name)
` Part of the @ref{5f6,,Stable ABI}.'
Determina si `capsule' es o no una cápsula válida. Una cápsula válida no es @code{NULL}, pasa @ref{4c4f,,PyCapsule_CheckExact()}, tiene un puntero no @code{NULL} almacenado y su nombre interno coincide con el parámetro `name'. (Consulte @ref{48f4,,PyCapsule_GetPointer()} para obtener información sobre cómo se comparan los nombres de las cápsulas).

In other words, if @ref{13bc,,PyCapsule_IsValid()} returns a true value, calls to
any of the accessors (any function starting with @code{PyCapsule_Get}) are
guaranteed to succeed.

Retorna un valor distinto de cero si el objeto es válido y coincide con el nombre pasado. Retorna @code{0} de lo contrario. Esta función no fallará.
@end deffn

@geindex PyCapsule_SetContext (C function)
@anchor{c-api/capsule c PyCapsule_SetContext}@anchor{48f5}
@deffn {C Función} int PyCapsule_SetContext (PyObject *capsule, void *context)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el puntero de contexto dentro de `capsule' a `context'.

Retorna @code{0} en caso de éxito. Retorna distinto de cero y establece una excepción en caso de error.
@end deffn

@geindex PyCapsule_SetDestructor (C function)
@anchor{c-api/capsule c PyCapsule_SetDestructor}@anchor{48f6}
@deffn {C Función} int PyCapsule_SetDestructor (PyObject *capsule, PyCapsule_Destructor destructor)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el destructor dentro de `capsule' en `destructor'.

Retorna @code{0} en caso de éxito. Retorna distinto de cero y establece una excepción en caso de error.
@end deffn

@geindex PyCapsule_SetName (C function)
@anchor{c-api/capsule c PyCapsule_SetName}@anchor{48f7}
@deffn {C Función} int PyCapsule_SetName (PyObject *capsule, const char *name)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el nombre dentro de `capsule' a `name'. Si no es @code{NULL}, el nombre debe sobrevivir a la cápsula. Si el `name' anterior almacenado en la cápsula no era @code{NULL}, no se intenta liberarlo.

Retorna @code{0} en caso de éxito. Retorna distinto de cero y establece una excepción en caso de error.
@end deffn

@geindex PyCapsule_SetPointer (C function)
@anchor{c-api/capsule c PyCapsule_SetPointer}@anchor{48f8}
@deffn {C Función} int PyCapsule_SetPointer (PyObject *capsule, void *pointer)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el puntero vacío dentro de `capsule' a `pointer'. El puntero puede no ser @code{NULL}.

Retorna @code{0} en caso de éxito. Retorna distinto de cero y establece una excepción en caso de error.
@end deffn

@node Objetos frame,Objetos generadores,Cápsulas<2>,Otros objetos<2>
@anchor{c-api/frame doc}@anchor{4c50}@anchor{c-api/frame frame-objects}@anchor{4c51}
@subsubsection Objetos frame


@geindex PyFrameObject (C type)
@anchor{c-api/frame c PyFrameObject}@anchor{822}
@deffn {C Tipo} type PyFrameObject
` Part of the @ref{5f6,,Limited API} (as an opaque struct).'
La estructura C de los objetos utilizados para describir los objetos del frame.

No hay miembros públicos en esta estructura.


Distinto en la versión 3.11: Los miembros de esta estructura se han eliminado de la API pública de C. Consulte la entrada @ref{821,,Novedades} para más detalles.

@end deffn

Las funciones @ref{17c4,,PyEval_GetFrame()} y @ref{827,,PyThreadState_GetFrame()} pueden utilizarse para obtener un objeto frame.

Véase también @ref{4aa1,,Reflexión}.

@geindex PyFrame_Type (C var)
@anchor{c-api/frame c PyFrame_Type}@anchor{820}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyFrame_Type

The type of frame objects.
It is the same object as @ref{1859,,types.FrameType} in the Python layer.


Distinto en la versión 3.11: Previously, this type was only available after including
@code{<frameobject.h>}.

@end deffn

@geindex PyFrame_Check (C function)
@anchor{c-api/frame c PyFrame_Check}@anchor{81e}
@deffn {C Función} int PyFrame_Check (PyObject *obj)

Return non-zero if `obj' is a frame object.


Distinto en la versión 3.11: Previously, this function was only available after including
@code{<frameobject.h>}.

@end deffn

@geindex PyFrame_GetBack (C function)
@anchor{c-api/frame c PyFrame_GetBack}@anchor{81f}
@deffn {C Función} @ref{822,,PyFrameObject} *PyFrame_GetBack (PyFrameObject *frame)
`Return value: New reference.'
Obtiene el `frame' exterior siguiente.

Retorna una @ref{431,,strong reference}, o @code{NULL} si `frame' no tiene frame exterior.


Added in version 3.9.

@end deffn

@geindex PyFrame_GetBuiltins (C function)
@anchor{c-api/frame c PyFrame_GetBuiltins}@anchor{805}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetBuiltins (PyFrameObject *frame)
`Return value: New reference.'
Get the `frame'’s @ref{1f4c,,f_builtins} attribute.

Retorna una @ref{431,,strong reference}, o @code{NULL} si `frame' no tiene frame exterior.


Added in version 3.11.

@end deffn

@geindex PyFrame_GetCode (C function)
@anchor{c-api/frame c PyFrame_GetCode}@anchor{823}
@deffn {C Función} @ref{811,,PyCodeObject} *PyFrame_GetCode (PyFrameObject *frame)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Obtenga el código `frame'.

Retorna un @ref{431,,strong reference}.

El resultado (frame code) no puede ser @code{NULL}.


Added in version 3.9.

@end deffn

@geindex PyFrame_GetGenerator (C function)
@anchor{c-api/frame c PyFrame_GetGenerator}@anchor{806}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetGenerator (PyFrameObject *frame)
`Return value: New reference.'
Obtiene el generador, rutina o generador asíncrono al que pertenece este frame, o @code{NULL} si este frame no es propiedad de un generador. No lanza una excepción, incluso si el valor de retorno es @code{NULL}.

Retorna un @ref{431,,strong reference}, o @code{NULL}.


Added in version 3.11.

@end deffn

@geindex PyFrame_GetGlobals (C function)
@anchor{c-api/frame c PyFrame_GetGlobals}@anchor{807}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetGlobals (PyFrameObject *frame)
`Return value: New reference.'
Get the `frame'’s @ref{1f4b,,f_globals} attribute.

Retorna una @ref{431,,strong reference}, o @code{NULL} si `frame' no tiene frame exterior.


Added in version 3.11.

@end deffn

@geindex PyFrame_GetLasti (C function)
@anchor{c-api/frame c PyFrame_GetLasti}@anchor{808}
@deffn {C Función} int PyFrame_GetLasti (PyFrameObject *frame)

Get the `frame'’s @ref{920,,f_lasti} attribute.

Retorna -1 si @code{frame.f_lasti} es @code{None}.


Added in version 3.11.

@end deffn

@geindex PyFrame_GetVar (C function)
@anchor{c-api/frame c PyFrame_GetVar}@anchor{60c}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetVar (PyFrameObject *frame, PyObject *name)
`Return value: New reference.'
Get the variable `name' of `frame'.


@itemize *

@item 
Return a @ref{431,,strong reference} to the variable value on success.

@item 
Raise @ref{4ec,,NameError} and return @code{NULL} if the variable does not exist.

@item 
Raise an exception and return @code{NULL} on error.
@end itemize

`name' type must be a @ref{237,,str}.


Added in version 3.12.

@end deffn

@geindex PyFrame_GetVarString (C function)
@anchor{c-api/frame c PyFrame_GetVarString}@anchor{60d}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetVarString (PyFrameObject *frame, const char *name)
`Return value: New reference.'
Similar to @ref{60c,,PyFrame_GetVar()}, but the variable name is a C string
encoded in UTF-8.


Added in version 3.12.

@end deffn

@geindex PyFrame_GetLocals (C function)
@anchor{c-api/frame c PyFrame_GetLocals}@anchor{4dd}
@deffn {C Función} @ref{42d,,PyObject} *PyFrame_GetLocals (PyFrameObject *frame)
`Return value: New reference.'
Get the `frame'’s @ref{2ed,,f_locals} attribute.
If the frame refers to an @ref{2e9,,optimized scope}, this returns a
write-through proxy object that allows modifying the locals.
In all other cases (classes, modules, @ref{2ea,,exec()}, @ref{2eb,,eval()}) it returns
the mapping representing the frame locals directly (as described for
@ref{2ae,,locals()}).

Retorna un @ref{431,,strong reference}.


Added in version 3.11.



Distinto en la versión 3.13: As part of 
@geindex Python Enhancement Proposals; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, return a proxy object for optimized scopes.

@end deffn

@geindex PyFrame_GetLineNumber (C function)
@anchor{c-api/frame c PyFrame_GetLineNumber}@anchor{824}
@deffn {C Función} int PyFrame_GetLineNumber (PyFrameObject *frame)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Retorna el número de línea en la que se está ejecutando el `frame'.
@end deffn

@menu
* Internal Frames:: 

@end menu

@node Internal Frames,,,Objetos frame
@anchor{c-api/frame internal-frames}@anchor{4c52}
@subsubsection Internal Frames


Unless using 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}, you will not need this.

@geindex _PyInterpreterFrame (C struct)
@anchor{c-api/frame c _PyInterpreterFrame}@anchor{160d}
@deffn {C Estructura} struct _PyInterpreterFrame

The interpreter’s internal frame representation.


Added in version 3.11.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetCode (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetCode}@anchor{4c53}
@deffn {C Función} @ref{42d,,PyObject} *PyUnstable_InterpreterFrame_GetCode (struct _PyInterpreterFrame *frame);

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

@quotation

Return a @ref{431,,strong reference} to the code object for the frame.
@end quotation


Added in version 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLasti (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLasti}@anchor{4c54}
@deffn {C Función} int PyUnstable_InterpreterFrame_GetLasti (struct _PyInterpreterFrame *frame);

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return the byte offset into the last executed instruction.


Added in version 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLine (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLine}@anchor{4c55}
@deffn {C Función} int PyUnstable_InterpreterFrame_GetLine (struct _PyInterpreterFrame *frame);

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Return the currently executing line number, or -1 if there is no line number.


Added in version 3.12.

@end deffn

@node Objetos generadores,Objetos corrutina,Objetos frame,Otros objetos<2>
@anchor{c-api/gen doc}@anchor{4c56}@anchor{c-api/gen gen-objects}@anchor{4c57}@anchor{c-api/gen generator-objects}@anchor{4c58}
@subsubsection Objetos generadores


Los objetos generadores son lo que Python usa para implementar iteradores generadores. Normalmente se crean iterando sobre una función que produce valores, en lugar de llamar explícitamente @ref{4c59,,PyGen_New()} o @ref{4c5a,,PyGen_NewWithQualName()}.

@geindex PyGenObject (C type)
@anchor{c-api/gen c PyGenObject}@anchor{4c5b}
@deffn {C Tipo} type PyGenObject

La estructura en C utilizada para los objetos generadores.
@end deffn

@geindex PyGen_Type (C var)
@anchor{c-api/gen c PyGen_Type}@anchor{4c5c}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyGen_Type

El objeto tipo correspondiente a los objetos generadores.
@end deffn

@geindex PyGen_Check (C function)
@anchor{c-api/gen c PyGen_Check}@anchor{4c5d}
@deffn {C Función} int PyGen_Check (PyObject *ob)

Retorna verdadero si `ob' es un objeto generador; `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyGen_CheckExact (C function)
@anchor{c-api/gen c PyGen_CheckExact}@anchor{4c5e}
@deffn {C Función} int PyGen_CheckExact (PyObject *ob)

Retorna verdadero si el tipo de `ob' es @ref{4c5c,,PyGen_Type}; `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyGen_New (C function)
@anchor{c-api/gen c PyGen_New}@anchor{4c59}
@deffn {C Función} @ref{42d,,PyObject} *PyGen_New (PyFrameObject *frame)
`Return value: New reference.'
Crea y retorna un nuevo objeto generador basado en el objeto `frame'. Una referencia a `frame' es robada por esta función. El argumento no debe ser @code{NULL}.
@end deffn

@geindex PyGen_NewWithQualName (C function)
@anchor{c-api/gen c PyGen_NewWithQualName}@anchor{4c5a}
@deffn {C Función} @ref{42d,,PyObject} *PyGen_NewWithQualName (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`Return value: New reference.'
Crea y retorna un nuevo objeto generador basado en el objeto `frame', con @code{__name__} y @code{__qualname__} establecido en `name' y `qualname'. Una referencia a `frame' es robada por esta función. El argumento `frame' no debe ser @code{NULL}.
@end deffn

@node Objetos corrutina,Objetos de variables de contexto,Objetos generadores,Otros objetos<2>
@anchor{c-api/coro doc}@anchor{4c5f}@anchor{c-api/coro coro-objects}@anchor{f51}@anchor{c-api/coro coroutine-objects}@anchor{4c60}
@subsubsection Objetos corrutina



Added in version 3.5.


Los objetos de corrutina son las funciones declaradas con un retorno de palabra clave @code{async}.

@geindex PyCoroObject (C type)
@anchor{c-api/coro c PyCoroObject}@anchor{4c61}
@deffn {C Tipo} type PyCoroObject

La estructura en C utilizada para objeto corrutina.
@end deffn

@geindex PyCoro_Type (C var)
@anchor{c-api/coro c PyCoro_Type}@anchor{4c62}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyCoro_Type

El tipo de objeto correspondiente a los objetos corrutina.
@end deffn

@geindex PyCoro_CheckExact (C function)
@anchor{c-api/coro c PyCoro_CheckExact}@anchor{4c63}
@deffn {C Función} int PyCoro_CheckExact (PyObject *ob)

Retorna verdadero si el tipo de `ob' es @ref{4c62,,PyCoro_Type}; `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyCoro_New (C function)
@anchor{c-api/coro c PyCoro_New}@anchor{4c64}
@deffn {C Función} @ref{42d,,PyObject} *PyCoro_New (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`Return value: New reference.'
Crea y retorna un nuevo objeto corrutina basado en el objeto `frame', con @code{__name__} y @code{__qualname__} establecido en `name' y `qualname'. Una referencia a `frame' es robada por esta función. El argumento `frame' no debe ser @code{NULL}.
@end deffn

@node Objetos de variables de contexto,Objetos DateTime<2>,Objetos corrutina,Otros objetos<2>
@anchor{c-api/contextvars doc}@anchor{4c65}@anchor{c-api/contextvars context-variables-objects}@anchor{4c66}@anchor{c-api/contextvars contextvarsobjects}@anchor{b83}
@subsubsection Objetos de variables de contexto

@anchor{c-api/contextvars contextvarsobjects-pointertype-change}@anchor{cae}

Added in version 3.7.



Distinto en la versión 3.7.1: 

@cartouche
@quotation Nota 
En Python 3.7.1, las firmas de todas las variables de contexto C APIs fueron `cambiadas' para usar punteros @ref{42d,,PyObject} en lugar de @ref{4c67,,PyContext}, @ref{4c68,,PyContextVar}, y @ref{4c69,,PyContextToken}, por ejemplo:

@example
// in 3.7.0:
PyContext *PyContext_New(void);

// in 3.7.1+:
PyObject *PyContext_New(void);
@end example

Ver bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762} para más detalles.
@end quotation
@end cartouche


Esta sección detalla la API pública de C para el módulo @ref{25,,contextvars}.

@geindex PyContext (C type)
@anchor{c-api/contextvars c PyContext}@anchor{4c67}
@deffn {C Tipo} type PyContext

La estructura C utilizada para representar un objeto @ref{15a0,,contextvars.Context}.
@end deffn

@geindex PyContextVar (C type)
@anchor{c-api/contextvars c PyContextVar}@anchor{4c68}
@deffn {C Tipo} type PyContextVar

La estructura C utilizada para representar un objeto @ref{31a0,,contextvars.ContextVar}.
@end deffn

@geindex PyContextToken (C type)
@anchor{c-api/contextvars c PyContextToken}@anchor{4c69}
@deffn {C Tipo} type PyContextToken

La estructura C solía representar un objeto @ref{31a6,,contextvars.Token}.
@end deffn

@geindex PyContext_Type (C var)
@anchor{c-api/contextvars c PyContext_Type}@anchor{4c6a}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyContext_Type

El objeto de tipo que representa el tipo `context'.
@end deffn

@geindex PyContextVar_Type (C var)
@anchor{c-api/contextvars c PyContextVar_Type}@anchor{4c6b}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyContextVar_Type

El objeto tipo que representa el tipo `variable de contexto'.
@end deffn

@geindex PyContextToken_Type (C var)
@anchor{c-api/contextvars c PyContextToken_Type}@anchor{4c6c}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyContextToken_Type

El tipo objeto que representa el tipo `token de variable de contexto'.
@end deffn

Macros de verificación de tipo:

@geindex PyContext_CheckExact (C function)
@anchor{c-api/contextvars c PyContext_CheckExact}@anchor{4c6d}
@deffn {C Función} int PyContext_CheckExact (PyObject *o)

Retorna verdadero si `o' es de tipo @ref{4c6a,,PyContext_Type}. `o' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyContextVar_CheckExact (C function)
@anchor{c-api/contextvars c PyContextVar_CheckExact}@anchor{4c6e}
@deffn {C Función} int PyContextVar_CheckExact (PyObject *o)

Retorna verdadero si `o' es de tipo @ref{4c6b,,PyContextVar_Type}. `o' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyContextToken_CheckExact (C function)
@anchor{c-api/contextvars c PyContextToken_CheckExact}@anchor{4c6f}
@deffn {C Función} int PyContextToken_CheckExact (PyObject *o)

Retorna verdadero si `o' es de tipo @ref{4c6c,,PyContextToken_Type}. `o' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

Funciones de gestión de objetos de contexto:

@geindex PyContext_New (C function)
@anchor{c-api/contextvars c PyContext_New}@anchor{4c70}
@deffn {C Función} @ref{42d,,PyObject} *PyContext_New (void)
`Return value: New reference.'
Crea un nuevo objeto de contexto vacío. Retorna @code{NULL} si se ha producido un error.
@end deffn

@geindex PyContext_Copy (C function)
@anchor{c-api/contextvars c PyContext_Copy}@anchor{4c71}
@deffn {C Función} @ref{42d,,PyObject} *PyContext_Copy (PyObject *ctx)
`Return value: New reference.'
Crea una copia superficial del objeto de contexto `ctx' pasado. Retorna @code{NULL} si se ha producido un error.
@end deffn

@geindex PyContext_CopyCurrent (C function)
@anchor{c-api/contextvars c PyContext_CopyCurrent}@anchor{4c72}
@deffn {C Función} @ref{42d,,PyObject} *PyContext_CopyCurrent (void)
`Return value: New reference.'
Crea una copia superficial del contexto actual del hilo. Retorna @code{NULL} si se ha producido un error.
@end deffn

@geindex PyContext_Enter (C function)
@anchor{c-api/contextvars c PyContext_Enter}@anchor{4c73}
@deffn {C Función} int PyContext_Enter (PyObject *ctx)

Establece `ctx' como el contexto actual para el hilo actual. Retorna @code{0} en caso de éxito y @code{-1} en caso de error.
@end deffn

@geindex PyContext_Exit (C function)
@anchor{c-api/contextvars c PyContext_Exit}@anchor{4c74}
@deffn {C Función} int PyContext_Exit (PyObject *ctx)

Desactiva el contexto `ctx' y restaura el contexto anterior como el contexto actual para el hilo actual. Retorna @code{0} en caso de éxito y @code{-1} en caso de error.
@end deffn

@geindex PyContext_AddWatcher (C function)
@anchor{c-api/contextvars c PyContext_AddWatcher}@anchor{1629}
@deffn {C Función} int PyContext_AddWatcher (PyContext_WatchCallback callback)

Register `callback' as a context object watcher for the current interpreter.
Return an ID which may be passed to @ref{162a,,PyContext_ClearWatcher()}.
In case of error (e.g. no more watcher IDs available),
return @code{-1} and set an exception.


Added in version 3.14.

@end deffn

@geindex PyContext_ClearWatcher (C function)
@anchor{c-api/contextvars c PyContext_ClearWatcher}@anchor{162a}
@deffn {C Función} int PyContext_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' previously returned from
@ref{1629,,PyContext_AddWatcher()} for the current interpreter.
Return @code{0} on success, or @code{-1} and set an exception on error
(e.g. if the given `watcher_id' was never registered.)


Added in version 3.14.

@end deffn

@geindex PyContextEvent (C type)
@anchor{c-api/contextvars c PyContextEvent}@anchor{4c75}
@deffn {C Tipo} type PyContextEvent

Enumeration of possible context object watcher events:


@itemize -

@item 
@code{Py_CONTEXT_SWITCHED}: The @ref{1602,,current context} has switched to a
different context.  The object passed to the watch callback is the
now-current @ref{15a0,,contextvars.Context} object, or None if no context is
current.
@end itemize


Added in version 3.14.

@end deffn

@geindex PyContext_WatchCallback (C type)
@anchor{c-api/contextvars c PyContext_WatchCallback}@anchor{4c76}
@deffn {C Tipo} typedef int (*PyContext_WatchCallback)(@ref{4c75,,PyContextEvent} event, @ref{42d,,PyObject} *obj)

Context object watcher callback function.  The object passed to the callback
is event-specific; see @ref{4c75,,PyContextEvent} for details.

If the callback returns with an exception set, it must return @code{-1}; this
exception will be printed as an unraisable exception using
@ref{442,,PyErr_FormatUnraisable()}. Otherwise it should return @code{0}.

There may already be a pending exception set on entry to the callback. In
this case, the callback should return @code{0} with the same exception still
set. This means the callback may not call any other API that can set an
exception unless it saves and clears the exception state first, and restores
it before returning.


Added in version 3.14.

@end deffn

Funciones variables de contexto:

@geindex PyContextVar_New (C function)
@anchor{c-api/contextvars c PyContextVar_New}@anchor{4c77}
@deffn {C Función} @ref{42d,,PyObject} *PyContextVar_New (const char *name, PyObject *def)
`Return value: New reference.'
Crea un nuevo objeto @code{ContextVar}. El parámetro `name' se usa para propósitos de introspección y depuración. El parámetro `def' especifica el valor predeterminado para la variable de contexto, o @code{NULL} para no especificar un valor predeterminado. Si se ha producido un error, esta función retorna @code{NULL}.
@end deffn

@geindex PyContextVar_Get (C function)
@anchor{c-api/contextvars c PyContextVar_Get}@anchor{4c78}
@deffn {C Función} int PyContextVar_Get (PyObject *var, PyObject *default_value, PyObject **value)

Obtiene el valor de una variable de contexto. Retorna @code{-1} si se produjo un error durante la búsqueda y @code{0} si no se produjo ningún error, se haya encontrado o no un valor.

Si se encontró la variable de contexto, `value' será un puntero a ella. Si la variable de contexto `not' se encontró, `value' apuntará a:


@itemize -

@item 
`default_value', si no es @code{NULL};

@item 
el valor predeterminado de `var', si no es @code{NULL};

@item 
@code{NULL}
@end itemize

A excepción de @code{NULL}, la función retorna una nueva referencia.
@end deffn

@geindex PyContextVar_Set (C function)
@anchor{c-api/contextvars c PyContextVar_Set}@anchor{4c79}
@deffn {C Función} @ref{42d,,PyObject} *PyContextVar_Set (PyObject *var, PyObject *value)
`Return value: New reference.'
Establece el valor de `var' en `value' en el contexto actual. Retorna un nuevo objeto token para este cambio, o @code{NULL} si se ha producido un error.
@end deffn

@geindex PyContextVar_Reset (C function)
@anchor{c-api/contextvars c PyContextVar_Reset}@anchor{4c7a}
@deffn {C Función} int PyContextVar_Reset (PyObject *var, PyObject *token)

Restablece el estado de la variable de contexto `var' a la que estaba antes @ref{4c79,,PyContextVar_Set()} que retornó el `token' fue llamado. Esta función retorna @code{0} en caso de éxito y @code{-1} en caso de error.
@end deffn

@node Objetos DateTime<2>,Objetos para indicaciones de tipado,Objetos de variables de contexto,Otros objetos<2>
@anchor{c-api/datetime doc}@anchor{4c7b}@anchor{c-api/datetime datetime-objects}@anchor{4c7c}@anchor{c-api/datetime datetimeobjects}@anchor{4aa7}
@subsubsection Objetos `DateTime'


Various date and time objects are supplied by the @ref{31,,datetime} module.
Before using any of these functions, the header file @code{datetime.h} must be
included in your source (note that this is not included by @code{Python.h}),
and the macro @code{PyDateTime_IMPORT} must be invoked, usually as part of
the module initialisation function.  The macro puts a pointer to a C structure
into a static variable, @code{PyDateTimeAPI}, that is used by the following
macros.

@geindex PyDateTime_Date (C type)
@anchor{c-api/datetime c PyDateTime_Date}@anchor{4c7d}
@deffn {C Tipo} type PyDateTime_Date

This subtype of @ref{42d,,PyObject} represents a Python date object.
@end deffn

@geindex PyDateTime_DateTime (C type)
@anchor{c-api/datetime c PyDateTime_DateTime}@anchor{4c7e}
@deffn {C Tipo} type PyDateTime_DateTime

This subtype of @ref{42d,,PyObject} represents a Python datetime object.
@end deffn

@geindex PyDateTime_Time (C type)
@anchor{c-api/datetime c PyDateTime_Time}@anchor{4c7f}
@deffn {C Tipo} type PyDateTime_Time

This subtype of @ref{42d,,PyObject} represents a Python time object.
@end deffn

@geindex PyDateTime_Delta (C type)
@anchor{c-api/datetime c PyDateTime_Delta}@anchor{4c80}
@deffn {C Tipo} type PyDateTime_Delta

This subtype of @ref{42d,,PyObject} represents the difference between two datetime values.
@end deffn

@geindex PyDateTime_DateType (C var)
@anchor{c-api/datetime c PyDateTime_DateType}@anchor{4c81}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDateTime_DateType

This instance of @ref{b30,,PyTypeObject} represents the Python date type;
it is the same object as @ref{330,,datetime.date} in the Python layer.
@end deffn

@geindex PyDateTime_DateTimeType (C var)
@anchor{c-api/datetime c PyDateTime_DateTimeType}@anchor{4c82}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDateTime_DateTimeType

This instance of @ref{b30,,PyTypeObject} represents the Python datetime type;
it is the same object as @ref{32f,,datetime.datetime} in the Python layer.
@end deffn

@geindex PyDateTime_TimeType (C var)
@anchor{c-api/datetime c PyDateTime_TimeType}@anchor{4c83}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDateTime_TimeType

This instance of @ref{b30,,PyTypeObject} represents the Python time type;
it is the same object as @ref{331,,datetime.time} in the Python layer.
@end deffn

@geindex PyDateTime_DeltaType (C var)
@anchor{c-api/datetime c PyDateTime_DeltaType}@anchor{4c84}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDateTime_DeltaType

This instance of @ref{b30,,PyTypeObject} represents Python type for
the difference between two datetime values;
it is the same object as @ref{a61,,datetime.timedelta} in the Python layer.
@end deffn

@geindex PyDateTime_TZInfoType (C var)
@anchor{c-api/datetime c PyDateTime_TZInfoType}@anchor{4c85}
@deffn {C Variable} @ref{b30,,PyTypeObject} PyDateTime_TZInfoType

This instance of @ref{b30,,PyTypeObject} represents the Python time zone info type;
it is the same object as @ref{67f,,datetime.tzinfo} in the Python layer.
@end deffn

Macro para acceder al singleton UTC:

@geindex PyDateTime_TimeZone_UTC (C var)
@anchor{c-api/datetime c PyDateTime_TimeZone_UTC}@anchor{c4b}
@deffn {C Variable} @ref{42d,,PyObject} *PyDateTime_TimeZone_UTC

Retorna la zona horaria singleton que representa UTC, el mismo objeto que @ref{6b4,,datetime.timezone.utc}.


Added in version 3.7.

@end deffn

Macros de verificación de tipo:

@geindex PyDate_Check (C function)
@anchor{c-api/datetime c PyDate_Check}@anchor{4c86}
@deffn {C Función} int PyDate_Check (PyObject *ob)

Return true if `ob' is of type @ref{4c81,,PyDateTime_DateType} or a subtype of
@code{PyDateTime_DateType}.  `ob' must not be @code{NULL}.  This function always
succeeds.
@end deffn

@geindex PyDate_CheckExact (C function)
@anchor{c-api/datetime c PyDate_CheckExact}@anchor{4c87}
@deffn {C Función} int PyDate_CheckExact (PyObject *ob)

Retorna verdadero si `ob' es de tipo @ref{4c81,,PyDateTime_DateType}. `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyDateTime_Check (C function)
@anchor{c-api/datetime c PyDateTime_Check}@anchor{4c88}
@deffn {C Función} int PyDateTime_Check (PyObject *ob)

Return true if `ob' is of type @ref{4c82,,PyDateTime_DateTimeType} or a subtype of
@code{PyDateTime_DateTimeType}.  `ob' must not be @code{NULL}.  This function always
succeeds.
@end deffn

@geindex PyDateTime_CheckExact (C function)
@anchor{c-api/datetime c PyDateTime_CheckExact}@anchor{4c89}
@deffn {C Función} int PyDateTime_CheckExact (PyObject *ob)

Retorna verdadero si `ob' es de tipo @ref{4c82,,PyDateTime_DateTimeType}. `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyTime_Check (C function)
@anchor{c-api/datetime c PyTime_Check}@anchor{4c8a}
@deffn {C Función} int PyTime_Check (PyObject *ob)

Return true if `ob' is of type @ref{4c83,,PyDateTime_TimeType} or a subtype of
@code{PyDateTime_TimeType}.  `ob' must not be @code{NULL}.  This function always
succeeds.
@end deffn

@geindex PyTime_CheckExact (C function)
@anchor{c-api/datetime c PyTime_CheckExact}@anchor{4c8b}
@deffn {C Función} int PyTime_CheckExact (PyObject *ob)

Retorna verdadero si `ob' es de tipo @ref{4c83,,PyDateTime_TimeType}. `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyDelta_Check (C function)
@anchor{c-api/datetime c PyDelta_Check}@anchor{4c8c}
@deffn {C Función} int PyDelta_Check (PyObject *ob)

Return true if `ob' is of type @ref{4c84,,PyDateTime_DeltaType} or a subtype of
@code{PyDateTime_DeltaType}.  `ob' must not be @code{NULL}.  This function always
succeeds.
@end deffn

@geindex PyDelta_CheckExact (C function)
@anchor{c-api/datetime c PyDelta_CheckExact}@anchor{4c8d}
@deffn {C Función} int PyDelta_CheckExact (PyObject *ob)

Retorna verdadero si `ob' es de tipo @ref{4c84,,PyDateTime_DeltaType}. `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

@geindex PyTZInfo_Check (C function)
@anchor{c-api/datetime c PyTZInfo_Check}@anchor{4c8e}
@deffn {C Función} int PyTZInfo_Check (PyObject *ob)

Return true if `ob' is of type @ref{4c85,,PyDateTime_TZInfoType} or a subtype of
@code{PyDateTime_TZInfoType}.  `ob' must not be @code{NULL}.  This function always
succeeds.
@end deffn

@geindex PyTZInfo_CheckExact (C function)
@anchor{c-api/datetime c PyTZInfo_CheckExact}@anchor{4c8f}
@deffn {C Función} int PyTZInfo_CheckExact (PyObject *ob)

Retorna verdadero si `ob' es de tipo @ref{4c85,,PyDateTime_TZInfoType}. `ob' no debe ser @code{NULL}. Esta función siempre finaliza con éxito.
@end deffn

Macros para crear objetos:

@geindex PyDate_FromDate (C function)
@anchor{c-api/datetime c PyDate_FromDate}@anchor{4c90}
@deffn {C Función} @ref{42d,,PyObject} *PyDate_FromDate (int year, int month, int day)
`Return value: New reference.'
Retorna un objeto @ref{330,,datetime.date} con el año, mes y día especificados.
@end deffn

@geindex PyDateTime_FromDateAndTime (C function)
@anchor{c-api/datetime c PyDateTime_FromDateAndTime}@anchor{4c91}
@deffn {C Función} @ref{42d,,PyObject} *PyDateTime_FromDateAndTime (int year, int month, int day, int hour, int minute, int second, int usecond)
`Return value: New reference.'
Retorna un objeto @ref{32f,,datetime.datetime} con el año, mes, día, hora, minuto, segundo y micro segundo especificados.
@end deffn

@geindex PyDateTime_FromDateAndTimeAndFold (C function)
@anchor{c-api/datetime c PyDateTime_FromDateAndTimeAndFold}@anchor{4c92}
@deffn {C Función} @ref{42d,,PyObject} *PyDateTime_FromDateAndTimeAndFold (int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
`Return value: New reference.'
Retorna un objeto @ref{32f,,datetime.datetime} con el año, mes, día, hora, minuto, segundo, micro segundo y doblez especificados.


Added in version 3.6.

@end deffn

@geindex PyTime_FromTime (C function)
@anchor{c-api/datetime c PyTime_FromTime}@anchor{4c93}
@deffn {C Función} @ref{42d,,PyObject} *PyTime_FromTime (int hour, int minute, int second, int usecond)
`Return value: New reference.'
Retorna un objeto @ref{331,,datetime.time} con la hora, minuto, segundo y micro segundo especificados.
@end deffn

@geindex PyTime_FromTimeAndFold (C function)
@anchor{c-api/datetime c PyTime_FromTimeAndFold}@anchor{4c94}
@deffn {C Función} @ref{42d,,PyObject} *PyTime_FromTimeAndFold (int hour, int minute, int second, int usecond, int fold)
`Return value: New reference.'
Retorna un objeto @ref{331,,datetime.time} con la hora, minuto, segundo, micro segundo y doblez especificados.


Added in version 3.6.

@end deffn

@geindex PyDelta_FromDSU (C function)
@anchor{c-api/datetime c PyDelta_FromDSU}@anchor{4c95}
@deffn {C Función} @ref{42d,,PyObject} *PyDelta_FromDSU (int days, int seconds, int useconds)
`Return value: New reference.'
Retorna un objeto @ref{a61,,datetime.timedelta} que representa el número dado de días, segundos y micro segundos. La normalización se realiza de modo que el número resultante de micro segundos y segundos se encuentre en los rangos documentados para los objetos @ref{a61,,datetime.timedelta}.
@end deffn

@geindex PyTimeZone_FromOffset (C function)
@anchor{c-api/datetime c PyTimeZone_FromOffset}@anchor{c49}
@deffn {C Función} @ref{42d,,PyObject} *PyTimeZone_FromOffset (PyObject *offset)
`Return value: New reference.'
Retorna un objeto @ref{1134,,datetime.timezone} con un desplazamiento fijo sin nombre representado por el argumento `offset'.


Added in version 3.7.

@end deffn

@geindex PyTimeZone_FromOffsetAndName (C function)
@anchor{c-api/datetime c PyTimeZone_FromOffsetAndName}@anchor{c4a}
@deffn {C Función} @ref{42d,,PyObject} *PyTimeZone_FromOffsetAndName (PyObject *offset, PyObject *name)
`Return value: New reference.'
Retorna un objeto @ref{1134,,datetime.timezone} con un desplazamiento fijo representado por el argumento `offset' y con tzname `name'.


Added in version 3.7.

@end deffn

Macros to extract fields from date objects.  The argument must be an instance of
@ref{4c7d,,PyDateTime_Date}, including subclasses (such as
@ref{4c7e,,PyDateTime_DateTime}).  The argument must not be @code{NULL}, and the type is
not checked:

@geindex PyDateTime_GET_YEAR (C function)
@anchor{c-api/datetime c PyDateTime_GET_YEAR}@anchor{4c96}
@deffn {C Función} int PyDateTime_GET_YEAR (PyDateTime_Date *o)

Regrese el año, como un int positivo.
@end deffn

@geindex PyDateTime_GET_MONTH (C function)
@anchor{c-api/datetime c PyDateTime_GET_MONTH}@anchor{4c97}
@deffn {C Función} int PyDateTime_GET_MONTH (PyDateTime_Date *o)

Regresa el mes, como int del 1 al 12.
@end deffn

@geindex PyDateTime_GET_DAY (C function)
@anchor{c-api/datetime c PyDateTime_GET_DAY}@anchor{4c98}
@deffn {C Función} int PyDateTime_GET_DAY (PyDateTime_Date *o)

Retorna el día, como int del 1 al 31.
@end deffn

Macros to extract fields from datetime objects.  The argument must be an
instance of @ref{4c7e,,PyDateTime_DateTime}, including subclasses. The argument
must not be @code{NULL}, and the type is not checked:

@geindex PyDateTime_DATE_GET_HOUR (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_HOUR}@anchor{4c99}
@deffn {C Función} int PyDateTime_DATE_GET_HOUR (PyDateTime_DateTime *o)

Retorna la hora, como un int de 0 hasta 23.
@end deffn

@geindex PyDateTime_DATE_GET_MINUTE (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_MINUTE}@anchor{4c9a}
@deffn {C Función} int PyDateTime_DATE_GET_MINUTE (PyDateTime_DateTime *o)

Retorna el minuto, como un int de 0 hasta 59.
@end deffn

@geindex PyDateTime_DATE_GET_SECOND (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_SECOND}@anchor{4c9b}
@deffn {C Función} int PyDateTime_DATE_GET_SECOND (PyDateTime_DateTime *o)

Retorna el segundo, como un int de 0 hasta 59.
@end deffn

@geindex PyDateTime_DATE_GET_MICROSECOND (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_MICROSECOND}@anchor{4c9c}
@deffn {C Función} int PyDateTime_DATE_GET_MICROSECOND (PyDateTime_DateTime *o)

Retorna el micro segundo, como un int de 0 hasta 999999.
@end deffn

@geindex PyDateTime_DATE_GET_FOLD (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_FOLD}@anchor{4c9d}
@deffn {C Función} int PyDateTime_DATE_GET_FOLD (PyDateTime_DateTime *o)

Return the fold, as an int from 0 through 1.


Added in version 3.6.

@end deffn

@geindex PyDateTime_DATE_GET_TZINFO (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_TZINFO}@anchor{92d}
@deffn {C Función} @ref{42d,,PyObject} *PyDateTime_DATE_GET_TZINFO (PyDateTime_DateTime *o)

Retorna el tzinfo (que puede ser @code{None}).


Added in version 3.10.

@end deffn

Macros to extract fields from time objects.  The argument must be an instance of
@ref{4c7f,,PyDateTime_Time}, including subclasses. The argument must not be @code{NULL},
and the type is not checked:

@geindex PyDateTime_TIME_GET_HOUR (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_HOUR}@anchor{4c9e}
@deffn {C Función} int PyDateTime_TIME_GET_HOUR (PyDateTime_Time *o)

Retorna la hora, como un int de 0 hasta 23.
@end deffn

@geindex PyDateTime_TIME_GET_MINUTE (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_MINUTE}@anchor{4c9f}
@deffn {C Función} int PyDateTime_TIME_GET_MINUTE (PyDateTime_Time *o)

Retorna el minuto, como un int de 0 hasta 59.
@end deffn

@geindex PyDateTime_TIME_GET_SECOND (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_SECOND}@anchor{4ca0}
@deffn {C Función} int PyDateTime_TIME_GET_SECOND (PyDateTime_Time *o)

Retorna el segundo, como un int de 0 hasta 59.
@end deffn

@geindex PyDateTime_TIME_GET_MICROSECOND (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_MICROSECOND}@anchor{4ca1}
@deffn {C Función} int PyDateTime_TIME_GET_MICROSECOND (PyDateTime_Time *o)

Retorna el micro segundo, como un int de 0 hasta 999999.
@end deffn

@geindex PyDateTime_TIME_GET_FOLD (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_FOLD}@anchor{4ca2}
@deffn {C Función} int PyDateTime_TIME_GET_FOLD (PyDateTime_Time *o)

Return the fold, as an int from 0 through 1.


Added in version 3.6.

@end deffn

@geindex PyDateTime_TIME_GET_TZINFO (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_TZINFO}@anchor{92e}
@deffn {C Función} @ref{42d,,PyObject} *PyDateTime_TIME_GET_TZINFO (PyDateTime_Time *o)

Retorna el tzinfo (que puede ser @code{None}).


Added in version 3.10.

@end deffn

Macros to extract fields from time delta objects.  The argument must be an
instance of @ref{4c80,,PyDateTime_Delta}, including subclasses. The argument must
not be @code{NULL}, and the type is not checked:

@geindex PyDateTime_DELTA_GET_DAYS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_DAYS}@anchor{4ca3}
@deffn {C Función} int PyDateTime_DELTA_GET_DAYS (PyDateTime_Delta *o)

Retorna el número de días, como un int desde -999999999 a 999999999.


Added in version 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_SECONDS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_SECONDS}@anchor{4ca4}
@deffn {C Función} int PyDateTime_DELTA_GET_SECONDS (PyDateTime_Delta *o)

Retorna el número de segundos, como un int de 0 a 86399.


Added in version 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_MICROSECONDS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_MICROSECONDS}@anchor{4ca5}
@deffn {C Función} int PyDateTime_DELTA_GET_MICROSECONDS (PyDateTime_Delta *o)

Retorna el número de micro segundos, como un int de 0 a 999999.


Added in version 3.3.

@end deffn

Macros para la conveniencia de módulos que implementan la API DB:

@geindex PyDateTime_FromTimestamp (C function)
@anchor{c-api/datetime c PyDateTime_FromTimestamp}@anchor{4ca6}
@deffn {C Función} @ref{42d,,PyObject} *PyDateTime_FromTimestamp (PyObject *args)
`Return value: New reference.'
Create and return a new @ref{32f,,datetime.datetime} object given an argument
tuple suitable for passing to @ref{593,,datetime.datetime.fromtimestamp()}.
@end deffn

@geindex PyDate_FromTimestamp (C function)
@anchor{c-api/datetime c PyDate_FromTimestamp}@anchor{1a16}
@deffn {C Función} @ref{42d,,PyObject} *PyDate_FromTimestamp (PyObject *args)
`Return value: New reference.'
Create and return a new @ref{330,,datetime.date} object given an argument
tuple suitable for passing to @ref{15cc,,datetime.date.fromtimestamp()}.
@end deffn

@node Objetos para indicaciones de tipado,,Objetos DateTime<2>,Otros objetos<2>
@anchor{c-api/typehints doc}@anchor{4ca7}@anchor{c-api/typehints objects-for-type-hinting}@anchor{4ca8}@anchor{c-api/typehints typehintobjects}@anchor{4ca9}
@subsubsection Objetos para indicaciones de tipado


Se proporcionan varios tipos incorporados para indicaciones de tipado. Actualmente existen dos tipos – @ref{753,,GenericAlias} y @ref{85b,,Union}. Solo @code{GenericAlias} es expuesto a C.

@geindex Py_GenericAlias (C function)
@anchor{c-api/typehints c Py_GenericAlias}@anchor{4a0e}
@deffn {C Función} @ref{42d,,PyObject} *Py_GenericAlias (PyObject *origin, PyObject *args)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Create a @ref{753,,GenericAlias} object.
Equivalent to calling the Python class
@ref{882,,types.GenericAlias}.  The `origin' and `args' arguments set the
@code{GenericAlias}“s @code{__origin__} and @code{__args__} attributes respectively.
`origin' should be a @ref{b30,,PyTypeObject}*, and `args' can be a
@ref{4a76,,PyTupleObject}* or any @code{PyObject*}.  If `args' passed is
not a tuple, a 1-tuple is automatically constructed and @code{__args__} is set
to @code{(args,)}.
Minimal checking is done for the arguments, so the function will succeed even
if `origin' is not a type.
The @code{GenericAlias}“s @code{__parameters__} attribute is constructed lazily
from @code{__args__}.  On failure, an exception is raised and @code{NULL} is
returned.

Aquí hay un ejemplo sobre cómo hacer un tipo de extensión genérica:

@example
...
static PyMethodDef my_obj_methods[] = @{
    // Other methods.
    ...
    @{"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS, "See PEP 585"@}
    ...
@}
@end example


@subsubheading Ver también


The data model method @ref{7d6,,__class_getitem__()}.



Added in version 3.9.

@end deffn

@geindex Py_GenericAliasType (C var)
@anchor{c-api/typehints c Py_GenericAliasType}@anchor{4a0f}
@deffn {C Variable} @ref{b30,,PyTypeObject} Py_GenericAliasType
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
El tipo en C del objeto retornado por @ref{4a0e,,Py_GenericAlias()}. Equivalente a @ref{882,,types.GenericAlias} en Python.


Added in version 3.9.

@end deffn

@node Inicialización finalización e hilos,Configuración de inicialización de Python,Capa de objetos concretos,Manual de referencia de la API en C de Python
@anchor{c-api/init doc}@anchor{4caa}@anchor{c-api/init initialization}@anchor{4cab}@anchor{c-api/init initialization-finalization-and-threads}@anchor{4cac}
@section Inicialización, finalización e hilos


See @ref{49a,,Python Initialization Configuration} for details
on how to configure the interpreter prior to initialization.

@menu
* Antes de la inicialización de Python:: 
* Variables de configuración global:: 
* Inicializando y finalizando el intérprete:: 
* Parámetros de todo el proceso:: 
* Estado del hilo y el bloqueo global del intérprete:: 
* Soporte de subinterprete:: 
* Notificaciones asincrónicas:: 
* Perfilado y Rastreo:: 
* Reference tracing:: 
* Soporte avanzado del depurador:: 
* Soporte de almacenamiento local de hilo:: 
* Synchronization Primitives:: 

@end menu

@node Antes de la inicialización de Python,Variables de configuración global,,Inicialización finalización e hilos
@anchor{c-api/init before-python-initialization}@anchor{4cad}@anchor{c-api/init pre-init-safe}@anchor{c4d}
@subsection Antes de la inicialización de Python


En una aplicación que incorpora Python, se debe llamar a la función @ref{247,,Py_Initialize()} antes de usar cualquier otra función de API Python/C; con la excepción de algunas funciones y @ref{4cae,,variables de configuración global}.

Las siguientes funciones se pueden invocar de forma segura antes de que se inicializa Python:


@itemize *

@item 
Functions that initialize the interpreter:


@itemize *

@item 
@ref{247,,Py_Initialize()}

@item 
@ref{4a15,,Py_InitializeEx()}

@item 
@ref{4a6,,Py_InitializeFromConfig()}

@item 
@ref{a53,,Py_BytesMain()}

@item 
@ref{cad,,Py_Main()}

@item 
the runtime pre-initialization functions covered in @ref{49a,,Configuración de inicialización de Python}
@end itemize

@item 
Funciones de configuración:


@itemize *

@item 
@ref{17ab,,PyImport_AppendInittab()}

@item 
@ref{17ac,,PyImport_ExtendInittab()}

@item 
@code{PyInitFrozenExtensions()}

@item 
@ref{62e,,PyMem_SetAllocator()}

@item 
@ref{cf2,,PyMem_SetupDebugHooks()}

@item 
@ref{4caf,,PyObject_SetArenaAllocator()}

@item 
@ref{164a,,Py_SetProgramName()}

@item 
@ref{1649,,Py_SetPythonHome()}

@item 
@ref{278,,PySys_ResetWarnOptions()}

@item 
the configuration functions covered in @ref{49a,,Configuración de inicialización de Python}
@end itemize

@item 
Funciones informativas:


@itemize *

@item 
@ref{48c8,,Py_IsInitialized()}

@item 
@ref{4cb0,,PyMem_GetAllocator()}

@item 
@ref{4cb1,,PyObject_GetArenaAllocator()}

@item 
@ref{1471,,Py_GetBuildInfo()}

@item 
@ref{4a10,,Py_GetCompiler()}

@item 
@ref{4a11,,Py_GetCopyright()}

@item 
@ref{4a12,,Py_GetPlatform()}

@item 
@ref{4a13,,Py_GetVersion()}

@item 
@ref{48c8,,Py_IsInitialized()}
@end itemize

@item 
Utilidades:


@itemize *

@item 
@ref{c4f,,Py_DecodeLocale()}

@item 
the status reporting and utility functions covered in @ref{49a,,Configuración de inicialización de Python}
@end itemize

@item 
Asignadores de memoria:


@itemize *

@item 
@ref{482,,PyMem_RawMalloc()}

@item 
@ref{484,,PyMem_RawRealloc()}

@item 
@ref{483,,PyMem_RawCalloc()}

@item 
@ref{485,,PyMem_RawFree()}
@end itemize

@item 
Synchronization:


@itemize *

@item 
@ref{41e,,PyMutex_Lock()}

@item 
@ref{41f,,PyMutex_Unlock()}
@end itemize
@end itemize

@cartouche
@quotation Nota 
Despite their apparent similarity to some of the functions listed above,
the following functions `should not be called' before the interpreter has
been initialized: @ref{c50,,Py_EncodeLocale()}, @ref{27d,,Py_GetPath()},
@ref{27f,,Py_GetPrefix()}, @ref{27a,,Py_GetExecPrefix()},
@ref{282,,Py_GetProgramFullPath()}, @ref{285,,Py_GetPythonHome()},
@ref{284,,Py_GetProgramName()}, @ref{164d,,PyEval_InitThreads()}, and
@ref{a57,,Py_RunMain()}.
@end quotation
@end cartouche

@node Variables de configuración global,Inicializando y finalizando el intérprete,Antes de la inicialización de Python,Inicialización finalización e hilos
@anchor{c-api/init global-conf-vars}@anchor{4cae}@anchor{c-api/init global-configuration-variables}@anchor{4cb2}
@subsection Variables de configuración global


Python tiene variables para la configuración global para controlar diferentes características y opciones. De forma predeterminada, estos indicadores están controlados por @ref{1d2f,,opciones de línea de comando}.

Cuando una opción establece un indicador, el valor del indicador es la cantidad de veces que se configuró la opción. Por ejemplo, @code{-b} establece @ref{4b5,,Py_BytesWarningFlag} en 1 y @code{-bb} establece @ref{4b5,,Py_BytesWarningFlag} en 2.

@geindex Py_BytesWarningFlag (C var)
@anchor{c-api/init c Py_BytesWarningFlag}@anchor{4b5}
@deffn {C Variable} int Py_BytesWarningFlag

This API is kept for backward compatibility: setting
@ref{4b6,,PyConfig.bytes_warning} should be used instead, see @ref{49a,,Python Initialization Configuration}.

Emite una advertencia al comparar @ref{325,,bytes} o @ref{5e0,,bytearray} con @ref{237,,str} o @ref{325,,bytes} con @ref{1f0,,int}. Emite un error si es mayor o igual a @code{2}.

Establecido por la opción @ref{683,,-b}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_DebugFlag (C var)
@anchor{c-api/init c Py_DebugFlag}@anchor{4a7}
@deffn {C Variable} int Py_DebugFlag

This API is kept for backward compatibility: setting
@ref{4a8,,PyConfig.parser_debug} should be used instead, see @ref{49a,,Python Initialization Configuration}.

Activa la salida de depuración del analizador (solo para expertos, según las opciones de compilación).

Establecido por la opción @ref{1d37,,-d} y la variable de entorno 
@geindex PYTHONDEBUG
@geindex variables de entorno; PYTHONDEBUG
@ref{1d38,,PYTHONDEBUG}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_DontWriteBytecodeFlag (C var)
@anchor{c-api/init c Py_DontWriteBytecodeFlag}@anchor{4bb}
@deffn {C Variable} int Py_DontWriteBytecodeFlag

This API is kept for backward compatibility: setting
@ref{4bc,,PyConfig.write_bytecode} should be used instead, see @ref{49a,,Python Initialization Configuration}.

Si se establece en un valor distinto de cero, Python no intentará escribir archivos @code{.pyc} en la importación de módulos fuente.

Establecido por la opción @ref{140d,,-B} y la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_FrozenFlag (C var)
@anchor{c-api/init c Py_FrozenFlag}@anchor{4b7}
@deffn {C Variable} int Py_FrozenFlag

This API is kept for backward compatibility: setting
@ref{4b8,,PyConfig.pathconfig_warnings} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Suprime los mensajes de error al calcular la ruta de búsqueda del módulo en @ref{27d,,Py_GetPath()}.

Indicador privado utilizado por los programas @code{_freeze_module} y @code{frozenmain}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_HashRandomizationFlag (C var)
@anchor{c-api/init c Py_HashRandomizationFlag}@anchor{4c1}
@deffn {C Variable} int Py_HashRandomizationFlag

This API is kept for backward compatibility: setting
@ref{4c3,,PyConfig.hash_seed} and @ref{4c2,,PyConfig.use_hash_seed} should
be used instead, see @ref{49a,,Python Initialization Configuration}.

Se establece en @code{1} si la variable de entorno 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} se establece en una cadena de caracteres no vacía.

Si el indicador no es cero, lee la variable de entorno 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED} para inicializar la semilla de `hash' secreta.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_IgnoreEnvironmentFlag (C var)
@anchor{c-api/init c Py_IgnoreEnvironmentFlag}@anchor{4b9}
@deffn {C Variable} int Py_IgnoreEnvironmentFlag

This API is kept for backward compatibility: setting
@ref{4ba,,PyConfig.use_environment} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Ignore all @code{PYTHON*} environment variables, e.g.
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH} and 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}, that might be set.

Establecido por las opciones @ref{9f0,,-E} y @ref{9f1,,-I}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_InspectFlag (C var)
@anchor{c-api/init c Py_InspectFlag}@anchor{4af}
@deffn {C Variable} int Py_InspectFlag

This API is kept for backward compatibility: setting
@ref{4b0,,PyConfig.inspect} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Cuando se pasa una secuencia de comandos (`script') como primer argumento o se usa la opción @ref{681,,-c}, ingresa al modo interactivo después de ejecutar la secuencia de comandos o el comando, incluso cuando @ref{5df,,sys.stdin} no parece ser un terminal.

Establecido por la opción @ref{151b,,-i} y la variable de entorno 
@geindex PYTHONINSPECT
@geindex variables de entorno; PYTHONINSPECT
@ref{151a,,PYTHONINSPECT}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_InteractiveFlag (C var)
@anchor{c-api/init c Py_InteractiveFlag}@anchor{4ad}
@deffn {C Variable} int Py_InteractiveFlag

This API is kept for backward compatibility: setting
@ref{4ae,,PyConfig.interactive} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Establecido por la opción @ref{151b,,-i}.


Obsoleto desde la versión 3.12.

@end deffn

@geindex Py_IsolatedFlag (C var)
@anchor{c-api/init c Py_IsolatedFlag}@anchor{4c4}
@deffn {C Variable} int Py_IsolatedFlag

This API is kept for backward compatibility: setting
@ref{4c5,,PyConfig.isolated} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Ejecuta Python en modo aislado. En modo aislado @ref{27e,,sys.path} no contiene ni el directorio de la secuencia de comandos (`script') ni el directorio de paquetes del sitio del usuario (`site-pacages').

Establecido por la opción @ref{9f1,,-I}.


Added in version 3.4.



Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_LegacyWindowsFSEncodingFlag (C var)
@anchor{c-api/init c Py_LegacyWindowsFSEncodingFlag}@anchor{4c6}
@deffn {C Variable} int Py_LegacyWindowsFSEncodingFlag

This API is kept for backward compatibility: setting
@ref{4c7,,PyPreConfig.legacy_windows_fs_encoding} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Si la bandera no es cero, utilice la codificación @code{mbcs} con el gestor de errores @code{replace} en lugar de la codificación UTF-8 con el gestor de error @code{surrogatepass}, para la @ref{5dd,,filesystem encoding and error handler} (codificación del sistema de archivos y gestor de errores).

Establece en @code{1} si la variable de entorno 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} está configurada en una cadena de caracteres no vacía.

Ver 
@geindex Python Enhancement Proposals; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para más detalles.

@ref{1d5a,,Availability}: Windows.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_LegacyWindowsStdioFlag (C var)
@anchor{c-api/init c Py_LegacyWindowsStdioFlag}@anchor{4c8}
@deffn {C Variable} int Py_LegacyWindowsStdioFlag

This API is kept for backward compatibility: setting
@ref{497,,PyConfig.legacy_windows_stdio} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

If the flag is non-zero, use @ref{1378,,io.FileIO} instead of
@code{io._WindowsConsoleIO} for @ref{d9,,sys} standard streams.

Establece en @code{1} si la variable de entorno 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@ref{ce3,,PYTHONLEGACYWINDOWSSTDIO} está configurada en una cadena de caracteres no vacía.

Ver 
@geindex Python Enhancement Proposals; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} para más detalles.

@ref{1d5a,,Availability}: Windows.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_NoSiteFlag (C var)
@anchor{c-api/init c Py_NoSiteFlag}@anchor{4b3}
@deffn {C Variable} int Py_NoSiteFlag

This API is kept for backward compatibility: setting
@ref{4b4,,PyConfig.site_import} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Deshabilita la importación del módulo @ref{c7,,site} y las manipulaciones dependientes del sitio de @ref{27e,,sys.path} que conlleva. También deshabilita estas manipulaciones si @ref{c7,,site} se importa explícitamente más tarde (llama a @ref{1d3c,,site.main()} si desea que se activen).

Establecido por la opción @ref{1217,,-S}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_NoUserSiteDirectory (C var)
@anchor{c-api/init c Py_NoUserSiteDirectory}@anchor{4bd}
@deffn {C Variable} int Py_NoUserSiteDirectory

This API is kept for backward compatibility: setting
@ref{4be,,PyConfig.user_site_directory} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

No agregue el @ref{1d3b,,directorio de paquetes de sitio del usuario} (`site-packages') a @ref{27e,,sys.path}.

Establecido por las opciones @ref{13eb,,-s} y @ref{9f1,,-I}, y la variable de entorno 
@geindex PYTHONNOUSERSITE
@geindex variables de entorno; PYTHONNOUSERSITE
@ref{13ec,,PYTHONNOUSERSITE}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_OptimizeFlag (C var)
@anchor{c-api/init c Py_OptimizeFlag}@anchor{4b1}
@deffn {C Variable} int Py_OptimizeFlag

This API is kept for backward compatibility: setting
@ref{4b2,,PyConfig.optimization_level} should be used instead, see
@ref{49a,,Python Initialization Configuration}.

Establecido por la opción @ref{14f,,-O} y la variable de entorno 
@geindex PYTHONOPTIMIZE
@geindex variables de entorno; PYTHONOPTIMIZE
@ref{1d39,,PYTHONOPTIMIZE}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_QuietFlag (C var)
@anchor{c-api/init c Py_QuietFlag}@anchor{4ab}
@deffn {C Variable} int Py_QuietFlag

This API is kept for backward compatibility: setting
@ref{4ac,,PyConfig.quiet} should be used instead, see @ref{49a,,Python Initialization Configuration}.

No muestre los mensajes de `copyright' y de versión incluso en modo interactivo.

Establecido por la opción @ref{1d3a,,-q}.


Added in version 3.2.



Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_UnbufferedStdioFlag (C var)
@anchor{c-api/init c Py_UnbufferedStdioFlag}@anchor{4bf}
@deffn {C Variable} int Py_UnbufferedStdioFlag

This API is kept for backward compatibility: setting
@ref{4c0,,PyConfig.buffered_stdio} should be used instead, see @ref{49a,,Python Initialization Configuration}.

Obliga a las secuencias `stdout' y `stderr' a que no tengan búfer.

Establecido por la opción @ref{19ad,,-u} y la variable de entorno 
@geindex PYTHONUNBUFFERED
@geindex variables de entorno; PYTHONUNBUFFERED
@ref{19ae,,PYTHONUNBUFFERED}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@geindex Py_VerboseFlag (C var)
@anchor{c-api/init c Py_VerboseFlag}@anchor{4a9}
@deffn {C Variable} int Py_VerboseFlag

This API is kept for backward compatibility: setting
@ref{4aa,,PyConfig.verbose} should be used instead, see @ref{49a,,Python Initialization Configuration}.

Imprime un mensaje cada vez que se inicializa un módulo, mostrando el lugar (nombre de archivo o módulo incorporado) desde el que se carga. Si es mayor o igual a @code{2}, imprime un mensaje para cada archivo que se verifica al buscar un módulo. También proporciona información sobre la limpieza del módulo a la salida.

Establecido por la opción @ref{1464,,-v} y la variable de entorno 
@geindex PYTHONVERBOSE
@geindex variables de entorno; PYTHONVERBOSE
@ref{1d3d,,PYTHONVERBOSE}.


Deprecated since version 3.12, removed in version 3.14.

@end deffn

@node Inicializando y finalizando el intérprete,Parámetros de todo el proceso,Variables de configuración global,Inicialización finalización e hilos
@anchor{c-api/init initializing-and-finalizing-the-interpreter}@anchor{4cb3}
@subsection Inicializando y finalizando el intérprete


@geindex Py_Initialize (C function)
@anchor{c-api/init c Py_Initialize}@anchor{247}
@deffn {C Función} void Py_Initialize ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex PyEval_InitThreads()
@geindex modules (in module sys)
@geindex path (in module sys)
@geindex module;builtins
@geindex module;__main__
@geindex module;sys
@geindex module;search;path
@geindex Py_FinalizeEx (C function)

Inicializa el intérprete de Python. En una aplicación que incorpora Python, se debe llamar antes de usar cualquier otra función de API Python/C; vea @ref{c4d,,Antes de la inicialización de Python} para ver algunas excepciones.

This initializes the table of loaded modules (@code{sys.modules}), and creates
the fundamental modules @ref{13,,builtins}, @ref{1,,__main__} and @ref{d9,,sys}.
It also initializes the module search path (@code{sys.path}). It does not set
@code{sys.argv}; use the @ref{49a,,Python Initialization Configuration}
API for that. This is a no-op when called for a second time (without calling
@ref{d9c,,Py_FinalizeEx()} first).  There is no return value; it is a fatal
error if the initialization fails.

Use @ref{4a6,,Py_InitializeFromConfig()} to customize the
@ref{49a,,Python Initialization Configuration}.

@cartouche
@quotation Nota 
En Windows, cambia el modo de consola de @code{O_TEXT} a @code{O_BINARY}, lo que también afectará los usos de la consola que no sean de Python utilizando C `Runtime'.
@end quotation
@end cartouche
@end deffn

@geindex Py_InitializeEx (C function)
@anchor{c-api/init c Py_InitializeEx}@anchor{4a15}
@deffn {C Función} void Py_InitializeEx (int initsigs)
` Part of the @ref{5f6,,Stable ABI}.'
This function works like @ref{247,,Py_Initialize()} if `initsigs' is @code{1}. If
`initsigs' is @code{0}, it skips initialization registration of signal handlers,
which may be useful when CPython is embedded as part of a larger application.

Use @ref{4a6,,Py_InitializeFromConfig()} to customize the
@ref{49a,,Python Initialization Configuration}.
@end deffn

@geindex Py_InitializeFromConfig (C function)
@anchor{c-api/init c Py_InitializeFromConfig}@anchor{4a6}
@deffn {C Función} @ref{a3f,,PyStatus} Py_InitializeFromConfig (const PyConfig *config)

Initialize Python from `config' configuration, as described in
@ref{4cb4,,Inicialización con PyConfig}.

See the @ref{49a,,Configuración de inicialización de Python} section for details on pre-initializing the
interpreter, populating the runtime configuration structure, and querying
the returned status structure.
@end deffn

@geindex Py_IsInitialized (C function)
@anchor{c-api/init c Py_IsInitialized}@anchor{48c8}
@deffn {C Función} int Py_IsInitialized ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna verdadero (distinto de cero) cuando el intérprete de Python se ha inicializado, falso (cero) si no. Después de que se llama a @ref{d9c,,Py_FinalizeEx()}, esto retorna falso hasta que @ref{247,,Py_Initialize()} se llama de nuevo.
@end deffn

@geindex Py_IsFinalizing (C function)
@anchor{c-api/init c Py_IsFinalizing}@anchor{44e}
@deffn {C Función} int Py_IsFinalizing ()
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Return true (non-zero) if the main Python interpreter is
@ref{2bb,,shutting down}. Return false (zero) otherwise.


Added in version 3.13.

@end deffn

@geindex Py_FinalizeEx (C function)
@anchor{c-api/init c Py_FinalizeEx}@anchor{d9c}
@deffn {C Función} int Py_FinalizeEx ()
` Part of the @ref{5f6,,Stable ABI} since version 3.6.'
Undo all initializations made by @ref{247,,Py_Initialize()} and subsequent use of
Python/C API functions, and destroy all sub-interpreters (see
@ref{17be,,Py_NewInterpreter()} below) that were created and not yet destroyed since
the last call to @ref{247,,Py_Initialize()}.  This is a no-op when called for a second
time (without calling @ref{247,,Py_Initialize()} again first).

Since this is the reverse of @ref{247,,Py_Initialize()}, it should be called
in the same thread with the same interpreter active.  That means
the main thread and the main interpreter.
This should never be called while @ref{a57,,Py_RunMain()} is running.

Normally the return value is @code{0}.
If there were errors during finalization (flushing buffered data),
@code{-1} is returned.

Note that Python will do a best effort at freeing all memory allocated by the Python
interpreter.  Therefore, any C-Extension should make sure to correctly clean up all
of the preveiously allocated PyObjects before using them in subsequent calls to
@ref{247,,Py_Initialize()}.  Otherwise it could introduce vulnerabilities and incorrect
behavior.

Esta función se proporciona por varias razones. Una aplicación de incrustación puede querer reiniciar Python sin tener que reiniciar la aplicación misma. Una aplicación que ha cargado el intérprete de Python desde una biblioteca cargable dinámicamente (o DLL) puede querer liberar toda la memoria asignada por Python antes de descargar la DLL. Durante una búsqueda de pérdidas de memoria en una aplicación, un desarrollador puede querer liberar toda la memoria asignada por Python antes de salir de la aplicación.

`Bugs and caveats:' The destruction of modules and objects in modules is done
in random order; this may cause destructors (@ref{1f60,,__del__()} methods) to fail
when they depend on other objects (even functions) or modules.  Dynamically
loaded extension modules loaded by Python are not unloaded.  Small amounts of
memory allocated by the Python interpreter may not be freed (if you find a leak,
please report it).  Memory tied up in circular references between objects is not
freed.  Interned strings will all be deallocated regardless of their reference count.
Some memory allocated by extension modules may not be freed.  Some extensions may not
work properly if their initialization routine is called more than once; this can
happen if an application calls @ref{247,,Py_Initialize()} and @ref{d9c,,Py_FinalizeEx()}
more than once.  @ref{d9c,,Py_FinalizeEx()} must not be called recursively from
within itself.  Therefore, it must not be called by any code that may be run
as part of the interpreter shutdown process, such as @ref{d,,atexit}
handlers, object finalizers, or any code that may be run while flushing the
stdout and stderr files.

Genera un @ref{18c3,,evento de auditoría} @code{cpython._PySys_ClearAuditHooks} sin argumentos.


Added in version 3.6.

@end deffn

@geindex Py_Finalize (C function)
@anchor{c-api/init c Py_Finalize}@anchor{246}
@deffn {C Función} void Py_Finalize ()
` Part of the @ref{5f6,,Stable ABI}.'
Esta es una versión compatible con versiones anteriores de @ref{d9c,,Py_FinalizeEx()} que ignora el valor de retorno.
@end deffn

@geindex Py_BytesMain (C function)
@anchor{c-api/init c Py_BytesMain}@anchor{a53}
@deffn {C Función} int Py_BytesMain (int argc, char **argv)
` Part of the @ref{5f6,,Stable ABI} since version 3.8.'
Similar to @ref{cad,,Py_Main()} but `argv' is an array of bytes strings,
allowing the calling application to delegate the text decoding step to
the CPython runtime.


Added in version 3.8.

@end deffn

@geindex Py_Main (C function)
@anchor{c-api/init c Py_Main}@anchor{cad}
@deffn {C Función} int Py_Main (int argc, wchar_t **argv)
` Part of the @ref{5f6,,Stable ABI}.'
The main program for the standard interpreter, encapsulating a full
initialization/finalization cycle, as well as additional
behaviour to implement reading configurations settings from the environment
and command line, and then executing @code{__main__} in accordance with
@ref{1083,,Línea de comando}.

This is made available for programs which wish to support the full CPython
command line interface, rather than just embedding a Python runtime in a
larger application.

The `argc' and `argv' parameters are similar to those which are passed to a
C program’s @code{main()} function, except that the `argv' entries are first
converted to @code{wchar_t} using @ref{c4f,,Py_DecodeLocale()}. It is also
important to note that the argument list entries may be modified to point to
strings other than those passed in (however, the contents of the strings
pointed to by the argument list are not modified).

The return value will be @code{0} if the interpreter exits normally (i.e.,
without an exception), @code{1} if the interpreter exits due to an exception,
or @code{2} if the argument list does not represent a valid Python command
line.

Note that if an otherwise unhandled @ref{dc7,,SystemExit} is raised, this
function will not return @code{1}, but exit the process, as long as
@code{Py_InspectFlag} is not set. If @code{Py_InspectFlag} is set, execution will
drop into the interactive Python prompt, at which point a second otherwise
unhandled @ref{dc7,,SystemExit} will still exit the process, while any other
means of exiting will set the return value as described above.

In terms of the CPython runtime configuration APIs documented in the
@ref{49a,,runtime configuration} section (and without accounting
for error handling), @code{Py_Main} is approximately equivalent to:

@example
PyConfig config;
PyConfig_InitPythonConfig(&config);
PyConfig_SetArgv(&config, argc, argv);
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);

Py_RunMain();
@end example

In normal usage, an embedding application will call this function
`instead' of calling @ref{247,,Py_Initialize()}, @ref{4a15,,Py_InitializeEx()} or
@ref{4a6,,Py_InitializeFromConfig()} directly, and all settings will be applied
as described elsewhere in this documentation. If this function is instead
called `after' a preceding runtime initialization API call, then exactly
which environmental and command line configuration settings will be updated
is version dependent (as it depends on which settings correctly support
being modified after they have already been set once when the runtime was
first initialized).
@end deffn

@geindex Py_RunMain (C function)
@anchor{c-api/init c Py_RunMain}@anchor{a57}
@deffn {C Función} int Py_RunMain (void)

Executes the main module in a fully configured CPython runtime.

Executes the command (@ref{4cb5,,PyConfig.run_command}), the script
(@ref{4cb6,,PyConfig.run_filename}) or the module
(@ref{4cb7,,PyConfig.run_module}) specified on the command line or in the
configuration. If none of these values are set, runs the interactive Python
prompt (REPL) using the @code{__main__} module’s global namespace.

If @ref{4b0,,PyConfig.inspect} is not set (the default), the return value
will be @code{0} if the interpreter exits normally (that is, without raising
an exception), or @code{1} if the interpreter exits due to an exception. If an
otherwise unhandled @ref{dc7,,SystemExit} is raised, the function will immediately
exit the process instead of returning @code{1}.

If @ref{4b0,,PyConfig.inspect} is set (such as when the @ref{151b,,-i} option
is used), rather than returning when the interpreter exits, execution will
instead resume in an interactive Python prompt (REPL) using the @code{__main__}
module’s global namespace. If the interpreter exited with an exception, it
is immediately raised in the REPL session. The function return value is
then determined by the way the `REPL session' terminates: returning @code{0}
if the session terminates without raising an unhandled exception, exiting
immediately for an unhandled @ref{dc7,,SystemExit}, and returning @code{1} for
any other unhandled exception.

This function always finalizes the Python interpreter regardless of whether
it returns a value or immediately exits the process due to an unhandled
@ref{dc7,,SystemExit} exception.

See @ref{4cb8,,Python Configuration} for an example of a
customized Python that always runs in isolated mode using
@ref{a57,,Py_RunMain()}.
@end deffn

@node Parámetros de todo el proceso,Estado del hilo y el bloqueo global del intérprete,Inicializando y finalizando el intérprete,Inicialización finalización e hilos
@anchor{c-api/init process-wide-parameters}@anchor{4cb9}
@subsection Parámetros de todo el proceso


@geindex Py_SetProgramName (C function)
@anchor{c-api/init c Py_SetProgramName}@anchor{164a}
@deffn {C Función} void Py_SetProgramName (const wchar_t *name)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex Py_Initialize()
@geindex main()
@geindex Py_GetPath()

Esta API se mantiene para la compatibilidad con versiones anteriores: en su lugar, se debe usar la configuración de @ref{4a5,,PyConfig.program_name}, consulta @ref{49a,,Configuración de inicialización de Python}.

Esta función debería llamarse antes @ref{247,,Py_Initialize()} se llama por primera vez, si es que se llama. Le dice al intérprete el valor del argumento @code{argv[0]} para la función @code{main()} del programa (convertido a caracteres anchos). Esto es utilizado por @ref{27d,,Py_GetPath()} y algunas otras funciones a continuación para encontrar las bibliotecas de tiempo de ejecución de Python relativas al ejecutable del intérprete. El valor predeterminado es @code{'python'}. El argumento debe apuntar a una cadena de caracteres anchos terminada en cero en almacenamiento estático cuyo contenido no cambiará mientras dure la ejecución del programa. Ningún código en el intérprete de Python cambiará el contenido de este almacenamiento.

Utilice @ref{c4f,,Py_DecodeLocale()} para decodificar una cadena de bytes para obtener una cadena de tipo wchar_*.


Obsoleto desde la versión 3.11.

@end deffn

@geindex Py_GetProgramName (C function)
@anchor{c-api/init c Py_GetProgramName}@anchor{284}
@deffn {C Función} wchar_t *Py_GetProgramName ()
` Part of the @ref{5f6,,Stable ABI}.'
Return the program name set with @ref{4a5,,PyConfig.program_name}, or the default.
The returned string points into static storage; the caller should not modify its
value.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{283,,sys.executable} instead.

@end deffn

@geindex Py_GetPrefix (C function)
@anchor{c-api/init c Py_GetPrefix}@anchor{27f}
@deffn {C Función} wchar_t *Py_GetPrefix ()
` Part of the @ref{5f6,,Stable ABI}.'
Return the `prefix' for installed platform-independent files. This is derived
through a number of complicated rules from the program name set with
@ref{4a5,,PyConfig.program_name} and some environment variables; for example, if the
program name is @code{'/usr/local/bin/python'}, the prefix is @code{'/usr/local'}. The
returned string points into static storage; the caller should not modify its
value.  This corresponds to the @code{prefix} variable in the top-level
@code{Makefile} and the @ref{1d66,,--prefix} argument to the @code{configure}
script at build time.  The value is available to Python code as @code{sys.base_prefix}.
It is only useful on Unix.  See also the next function.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{280,,sys.base_prefix} instead, or @ref{281,,sys.prefix} if
@ref{4245,,virtual environments} need to be handled.

@end deffn

@geindex Py_GetExecPrefix (C function)
@anchor{c-api/init c Py_GetExecPrefix}@anchor{27a}
@deffn {C Función} wchar_t *Py_GetExecPrefix ()
` Part of the @ref{5f6,,Stable ABI}.'
Return the `exec-prefix' for installed platform-`dependent' files.  This is
derived through a number of complicated rules from the program name set with
@ref{4a5,,PyConfig.program_name} and some environment variables; for example, if the
program name is @code{'/usr/local/bin/python'}, the exec-prefix is
@code{'/usr/local'}.  The returned string points into static storage; the caller
should not modify its value.  This corresponds to the @code{exec_prefix}
variable in the top-level @code{Makefile} and the @code{--exec-prefix}
argument to the @code{configure} script at build  time.  The value is
available to Python code as @code{sys.base_exec_prefix}.  It is only useful on
Unix.

Antecedentes: el prefijo `exec' difiere del prefijo cuando los archivos dependientes de la plataforma (como ejecutables y bibliotecas compartidas) se instalan en un árbol de directorios diferente. En una instalación típica, los archivos dependientes de la plataforma pueden instalarse en el subárbol @code{/usr/local/plat} mientras que la plataforma independiente puede instalarse en @code{/usr/local}.

En términos generales, una plataforma es una combinación de familias de hardware y software, por ejemplo, las máquinas Sparc que ejecutan el sistema operativo Solaris 2.x se consideran la misma plataforma, pero las máquinas Intel que ejecutan Solaris 2.x son otra plataforma, y las máquinas Intel que ejecutan Linux son otra plataforma más. Las diferentes revisiones importantes del mismo sistema operativo generalmente también forman plataformas diferentes. Los sistemas operativos que no son Unix son una historia diferente; Las estrategias de instalación en esos sistemas son tan diferentes que el prefijo y el prefijo @code{exec} no tienen sentido y se configuran en la cadena vacía. Tenga en cuenta que los archivos de bytecode compilados de Python son independientes de la plataforma (¡pero no independientes de la versión de Python con la que fueron compilados!).

Los administradores de sistemas sabrán cómo configurar los programas @code{mount} o @code{automount} para compartir @code{/usr/local} entre plataformas mientras que @code{/usr/local/plat} sea un sistema de archivos diferente para cada plataforma.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{27b,,sys.base_exec_prefix} instead, or @ref{27c,,sys.exec_prefix} if
@ref{4245,,virtual environments} need to be handled.

@end deffn

@geindex Py_GetProgramFullPath (C function)
@anchor{c-api/init c Py_GetProgramFullPath}@anchor{282}
@deffn {C Función} wchar_t *Py_GetProgramFullPath ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex executable (in module sys)

Return the full program name of the Python executable; this is  computed as a
side-effect of deriving the default module search path  from the program name
(set by @ref{4a5,,PyConfig.program_name}). The returned string points into
static storage; the caller should not modify its value.  The value is available
to Python code as @code{sys.executable}.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{283,,sys.executable} instead.

@end deffn

@geindex Py_GetPath (C function)
@anchor{c-api/init c Py_GetPath}@anchor{27d}
@deffn {C Función} wchar_t *Py_GetPath ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex module;search;path
@geindex path (in module sys)

Return the default module search path; this is computed from the program name
(set by @ref{4a5,,PyConfig.program_name}) and some environment variables.
The returned string consists of a series of directory names separated by a
platform dependent delimiter character.  The delimiter character is @code{':'}
on Unix and macOS, @code{';'} on Windows.  The returned string points into
static storage; the caller should not modify its value.  The list
@ref{27e,,sys.path} is initialized with this value on interpreter startup; it
can be (and usually is) modified later to change the search path for loading
modules.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.

@c XXX should give the exact rules


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{27e,,sys.path} instead.

@end deffn

@geindex Py_GetVersion (C function)
@anchor{c-api/init c Py_GetVersion}@anchor{4a13}
@deffn {C Función} const char *Py_GetVersion ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna la versión de este intérprete de Python. Esta es una cadena de caracteres que se parece a

@example
"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"
@end example

@geindex version (in module sys)

La primera palabra (hasta el primer carácter de espacio) es la versión actual de Python; los primeros tres caracteres son la versión mayor y menor separados por un punto. La cadena de caracteres retornada apunta al almacenamiento estático; la persona que llama no debe modificar su valor. El valor está disponible para el código Python como @ref{2e4,,sys.version}.

Consulta también la constante @ref{7f0,,Py_Version}.
@end deffn

@geindex Py_GetPlatform (C function)
@anchor{c-api/init c Py_GetPlatform}@anchor{4a12}
@deffn {C Función} const char *Py_GetPlatform ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex platform (in module sys)

Retorna el identificador de plataforma para la plataforma actual. En Unix, esto se forma a partir del nombre «oficial» del sistema operativo, convertido a minúsculas, seguido del número de revisión principal; por ejemplo, para Solaris 2.x, que también se conoce como SunOS 5.x, el valor es @code{'sunos5'}. En macOS, es @code{'darwin'}. En Windows, es @code{'win'}. La cadena de caracteres retornada apunta al almacenamiento estático; la persona que llama no debe modificar su valor. El valor está disponible para el código de Python como @code{sys.platform}.
@end deffn

@geindex Py_GetCopyright (C function)
@anchor{c-api/init c Py_GetCopyright}@anchor{4a11}
@deffn {C Función} const char *Py_GetCopyright ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna la cadena de caracteres de copyright oficial para la versión actual de Python, por ejemplo

@code{'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'}

@geindex copyright (in module sys)

La cadena de caracteres retornada apunta al almacenamiento estático; la persona que llama no debe modificar su valor. El valor está disponible para el código de Python como @code{sys.copyright}.
@end deffn

@geindex Py_GetCompiler (C function)
@anchor{c-api/init c Py_GetCompiler}@anchor{4a10}
@deffn {C Función} const char *Py_GetCompiler ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna una indicación del compilador utilizado para construir la versión actual de Python, entre corchetes, por ejemplo:

@example
"[GCC 2.7.2.2]"
@end example

@geindex version (in module sys)

La cadena de caracteres retornada apunta al almacenamiento estático; la persona que llama no debe modificar su valor. El valor está disponible para el código Python como parte de la variable @code{sys.version}.
@end deffn

@geindex Py_GetBuildInfo (C function)
@anchor{c-api/init c Py_GetBuildInfo}@anchor{1471}
@deffn {C Función} const char *Py_GetBuildInfo ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna información sobre el número de secuencia y la fecha y hora de compilación de la instancia actual de intérprete de Python, por ejemplo:

@example
"#67, Aug  1 1997, 22:34:28"
@end example

@geindex version (in module sys)

La cadena de caracteres retornada apunta al almacenamiento estático; la persona que llama no debe modificar su valor. El valor está disponible para el código Python como parte de la variable @code{sys.version}.
@end deffn

@geindex PySys_SetArgvEx (C function)
@anchor{c-api/init c PySys_SetArgvEx}@anchor{164b}
@deffn {C Función} void PySys_SetArgvEx (int argc, wchar_t **argv, int updatepath)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex main()
@geindex Py_FatalError()
@geindex argv (in module sys)

Esta API se mantiene para la compatibilidad con versiones anteriores: en su lugar, se debe usar la configuración de @ref{4a4,,PyConfig.argv}, @ref{1932,,PyConfig.parse_argv} y @ref{80d,,PyConfig.safe_path}, consulta @ref{49a,,Configuración de inicialización de Python}.

Establece @ref{12d2,,sys.argv} basado en `argc' y `argv'. Estos parámetros son similares a los pasados a la función del programa @code{main()} con la diferencia de que la primera entrada debe referirse al archivo de la secuencia de comandos (`script') que se ejecutará en lugar del ejecutable que aloja el intérprete de Python. Si no se ejecuta una secuencia de comandos (`script'), la primera entrada en `argv' puede ser una cadena de caracteres vacía. Si esta función no puede inicializar @ref{12d2,,sys.argv}, una condición fatal se señala usando @ref{a15,,Py_FatalError()}.

Si `updatepath' es cero, esto es todo lo que hace la función. Si `updatepath' no es cero, la función también modifica @ref{27e,,sys.path} de acuerdo con el siguiente algoritmo:


@itemize -

@item 
Si el nombre de una secuencia de comandos (`script') existente se pasa en @code{argv[0]}, la ruta absoluta del directorio donde se encuentra el `script' se antepone a @ref{27e,,sys.path}.

@item 
De lo contrario (es decir, si `argc' es @code{0} o @code{argv[0]} no apunta a un nombre de archivo existente), una cadena de caracteres vacía se antepone a @ref{27e,,sys.path}, que es lo mismo que anteponer el directorio de trabajo actual (@code{"."}).
@end itemize

Utilice @ref{c4f,,Py_DecodeLocale()} para decodificar una cadena de bytes para obtener una cadena de tipo wchar_*.

Consulta también los miembros de @ref{92c,,PyConfig.orig_argv} y @ref{4a4,,PyConfig.argv} de @ref{49a,,Python Initialization Configuration}.

@cartouche
@quotation Nota 
It is recommended that applications embedding the Python interpreter
for purposes other than executing a single script pass @code{0} as `updatepath',
and update @ref{27e,,sys.path} themselves if desired.
See 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}.

En las versiones anteriores a 3.1.3, puede lograr el mismo efecto quitando manualmente el primer elemento (`popping') @ref{27e,,sys.path} después de haber llamado @ref{164c,,PySys_SetArgv()}, por ejemplo usando

@example
PyRun_SimpleString("import sys; sys.path.pop(0)\n");
@end example
@end quotation
@end cartouche


Added in version 3.1.3.


@c XXX impl. doesn't seem consistent in allowing ``0``/``NULL`` for the params;
@c check w/ Guido.


Obsoleto desde la versión 3.11.

@end deffn

@geindex PySys_SetArgv (C function)
@anchor{c-api/init c PySys_SetArgv}@anchor{164c}
@deffn {C Función} void PySys_SetArgv (int argc, wchar_t **argv)
` Part of the @ref{5f6,,Stable ABI}.'
Esta API se mantiene para la compatibilidad con versiones anteriores: en su lugar, se debe usar la configuración de @ref{4a4,,PyConfig.argv} y @ref{1932,,PyConfig.parse_argv}, consulta @ref{49a,,Configuración de inicialización de Python}.

Esta función funciona como @ref{164b,,PySys_SetArgvEx()} con `updatepath' establecido en @code{1} a menos que el intérprete @code{python} se haya iniciado con la opción @ref{9f1,,-I}.

Utilice @ref{c4f,,Py_DecodeLocale()} para decodificar una cadena de bytes para obtener una cadena de tipo wchar_*.

Consulta también los miembros de @ref{92c,,PyConfig.orig_argv} y @ref{4a4,,PyConfig.argv} de @ref{49a,,Python Initialization Configuration}.


Distinto en la versión 3.4: El valor `updatepath' depende de la opción @ref{9f1,,-I}.



Obsoleto desde la versión 3.11.

@end deffn

@geindex Py_SetPythonHome (C function)
@anchor{c-api/init c Py_SetPythonHome}@anchor{1649}
@deffn {C Función} void Py_SetPythonHome (const wchar_t *home)
` Part of the @ref{5f6,,Stable ABI}.'
Esta API se mantiene para la compatibilidad con versiones anteriores: en su lugar, se debe usar la configuración de @ref{286,,PyConfig.home}, consulta @ref{49a,,Configuración de inicialización de Python}.

Establece el directorio «inicio» (`«home»') predeterminado, es decir, la ubicación de las bibliotecas estándar de Python. Ver 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} para el significado de la cadena de caracteres de argumento.

El argumento debe apuntar a una cadena de caracteres terminada en cero en el almacenamiento estático cuyo contenido no cambiará mientras dure la ejecución del programa. Ningún código en el intérprete de Python cambiará el contenido de este almacenamiento.

Utilice @ref{c4f,,Py_DecodeLocale()} para decodificar una cadena de bytes para obtener una cadena de tipo wchar_*.


Obsoleto desde la versión 3.11.

@end deffn

@geindex Py_GetPythonHome (C function)
@anchor{c-api/init c Py_GetPythonHome}@anchor{285}
@deffn {C Función} wchar_t *Py_GetPythonHome ()
` Part of the @ref{5f6,,Stable ABI}.'
Return the default «home», that is, the value set by
@ref{286,,PyConfig.home}, or the value of the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}
environment variable if it is set.

Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}, de otra forma retornará @code{NULL}.


Distinto en la versión 3.10: Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}, de lo contrario retornará @code{NULL}.



Deprecated since version 3.13, will be removed in version 3.15: Get @ref{286,,PyConfig.home} or 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment
variable instead.

@end deffn

@node Estado del hilo y el bloqueo global del intérprete,Soporte de subinterprete,Parámetros de todo el proceso,Inicialización finalización e hilos
@anchor{c-api/init thread-state-and-the-global-interpreter-lock}@anchor{4cba}@anchor{c-api/init threads}@anchor{4cbb}
@subsection Estado del hilo y el bloqueo global del intérprete


@geindex global interpreter lock
@geindex interpreter lock
@geindex lock@comma{} interpreter

El intérprete de Python no es completamente seguro para hilos (`thread-safe'). Para admitir programas Python multiproceso, hay un bloqueo global, denominado @ref{2b5,,global interpreter lock} o @ref{2c5,,GIL}, que debe mantener el hilo actual antes de que pueda acceder de forma segura a los objetos Python. Sin el bloqueo, incluso las operaciones más simples podrían causar problemas en un programa de hilos múltiples: por ejemplo, cuando dos hilos incrementan simultáneamente el conteo de referencias del mismo objeto, el conteo de referencias podría terminar incrementándose solo una vez en lugar de dos veces.

@geindex setswitchinterval (in module sys)

Por lo tanto, existe la regla de que solo el hilo que ha adquirido @ref{2c5,,GIL} puede operar en objetos Python o llamar a funciones API Python/C. Para emular la concurrencia de ejecución, el intérprete regularmente intenta cambiar los hilos (ver @ref{9dd,,sys.setswitchinterval()}). El bloqueo también se libera para bloquear potencialmente las operaciones de E/S, como leer o escribir un archivo, para que otros hilos de Python puedan ejecutarse mientras tanto.

@geindex PyThreadState (C type)

El intérprete de Python mantiene cierta información de contabilidad específica de hilos dentro de una estructura de datos llamada @ref{826,,PyThreadState}. También hay una variable global que apunta a la actual @ref{826,,PyThreadState}: se puede recuperar usando @ref{466,,PyThreadState_Get()}.

@menu
* Liberando el GIL del código de extensión:: 
* Hilos creados sin Python:: 
* Precauciones sobre fork(): Precauciones sobre fork. 
* Cautions regarding runtime finalization:: 
* API de alto nivel:: 
* API de bajo nivel:: 

@end menu

@node Liberando el GIL del código de extensión,Hilos creados sin Python,,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init releasing-the-gil-from-extension-code}@anchor{4cbc}
@subsubsection Liberando el GIL del código de extensión


La mayoría del código de extensión que manipula el @ref{2c5,,GIL} tiene la siguiente estructura simple

@example
Save the thread state in a local variable.
Release the global interpreter lock.
... Do some blocking I/O operation ...
Reacquire the global interpreter lock.
Restore the thread state from the local variable.
@end example

Esto es tan común que existen un par de macros para simplificarlo:

@example
Py_BEGIN_ALLOW_THREADS
... Do some blocking I/O operation ...
Py_END_ALLOW_THREADS
@end example

@geindex Py_BEGIN_ALLOW_THREADS (C macro)
@geindex Py_END_ALLOW_THREADS (C macro)

La macro @ref{484e,,Py_BEGIN_ALLOW_THREADS} abre un nuevo bloque y declara una variable local oculta; la macro @ref{b1a,,Py_END_ALLOW_THREADS} cierra el bloque.

El bloque anterior se expande al siguiente código:

@example
PyThreadState *_save;

_save = PyEval_SaveThread();
... Do some blocking I/O operation ...
PyEval_RestoreThread(_save);
@end example

@geindex PyEval_RestoreThread (C function)
@geindex PyEval_SaveThread (C function)

Así es como funcionan estas funciones: el bloqueo global del intérprete se usa para proteger el puntero al estado actual del hilo. Al liberar el bloqueo y guardar el estado del hilo, el puntero del estado del hilo actual debe recuperarse antes de que se libere el bloqueo (ya que otro hilo podría adquirir inmediatamente el bloqueo y almacenar su propio estado de hilo en la variable global). Por el contrario, al adquirir el bloqueo y restaurar el estado del hilo, el bloqueo debe adquirirse antes de almacenar el puntero del estado del hilo.

@cartouche
@quotation Nota 
Llamar a las funciones de E/S del sistema es el caso de uso más común para liberar el GIL, pero también puede ser útil antes de llamar a cálculos de larga duración que no necesitan acceso a objetos de Python, como las funciones de compresión o criptográficas que operan sobre memorias intermedias. Por ejemplo, los módulos estándar @ref{132,,zlib} y @ref{68,,hashlib} liberan el GIL al comprimir o mezclar datos.
@end quotation
@end cartouche

@node Hilos creados sin Python,Precauciones sobre fork,Liberando el GIL del código de extensión,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init gilstate}@anchor{4cbd}@anchor{c-api/init non-python-created-threads}@anchor{4cbe}
@subsubsection Hilos creados sin Python


Cuando se crean hilos utilizando las API dedicadas de Python (como el módulo @ref{ed,,threading}), se les asocia automáticamente un estado del hilo y, por lo tanto, el código que se muestra arriba es correcto. Sin embargo, cuando los hilos se crean desde C (por ejemplo, por una biblioteca de terceros con su propia administración de hilos), no contienen el GIL, ni existe una estructura de estado de hilos para ellos.

Si necesita llamar al código Python desde estos subprocesos (a menudo esto será parte de una API de devolución de llamada proporcionada por la biblioteca de terceros mencionada anteriormente), primero debe registrar estos subprocesos con el intérprete creando una estructura de datos de estado del subproceso, luego adquiriendo el GIL, y finalmente almacenando su puntero de estado de hilo, antes de que pueda comenzar a usar la API Python/C Cuando haya terminado, debe restablecer el puntero del estado del hilo, liberar el GIL y finalmente liberar la estructura de datos del estado del hilo.

Las funciones @ref{49e,,PyGILState_Ensure()} y @ref{49f,,PyGILState_Release()} hacen todo lo anterior automáticamente. El idioma típico para llamar a Python desde un hilo C es:

@example
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();

/* Perform Python actions here. */
result = CallSomeFunction();
/* evaluate result or handle exception */

/* Release the thread. No Python API allowed beyond this point. */
PyGILState_Release(gstate);
@end example

Tenga en cuenta que las funciones @code{PyGILState_*}  asumen que solo hay un intérprete global (creado automáticamente por @ref{247,,Py_Initialize()}). Python admite la creación de intérpretes adicionales (usando @ref{17be,,Py_NewInterpreter()}), pero la mezcla de varios intérpretes y la API @code{PyGILState_*} no está soportada.

@node Precauciones sobre fork,Cautions regarding runtime finalization,Hilos creados sin Python,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init cautions-about-fork}@anchor{4cbf}@anchor{c-api/init fork-and-threads}@anchor{4a72}
@subsubsection Precauciones sobre @code{fork()}


Otra cosa importante a tener en cuenta sobre los hilos es su comportamiento frente a la llamada C @code{fork()}. En la mayoría de los sistemas con @code{fork()}, después de que un proceso se bifurca, solo existirá el hilo que emitió el `fork'. Esto tiene un impacto concreto tanto en cómo se deben manejar las cerraduras como en todo el estado almacenado en el tiempo de ejecución de CPython.

The fact that only the «current» thread remains
means any locks held by other threads will never be released. Python solves
this for @ref{2ff,,os.fork()} by acquiring the locks it uses internally before
the fork, and releasing them afterwards. In addition, it resets any
@ref{3059,,Objetos tipo lock} in the child. When extending or embedding Python, there
is no way to inform Python of additional (non-Python) locks that need to be
acquired before or reset after a fork. OS facilities such as
@code{pthread_atfork()} would need to be used to accomplish the same thing.
Additionally, when extending or embedding Python, calling @code{fork()}
directly rather than through @ref{2ff,,os.fork()} (and returning to or calling
into Python) may result in a deadlock by one of Python’s internal locks
being held by a thread that is defunct after the fork.
@ref{292,,PyOS_AfterFork_Child()} tries to reset the necessary locks, but is not
always able to.

El hecho de que todos los otros hilos desaparezcan también significa que el estado de ejecución de CPython debe limpiarse correctamente, lo que @ref{2ff,,os.fork()} lo hace. Esto significa finalizar todos los demás objetos @ref{826,,PyThreadState} que pertenecen al intérprete actual y todos los demás objetos @ref{954,,PyInterpreterState}. Debido a esto y a la naturaleza especial del @ref{62b,,intérprete «principal»}, @code{fork()} solo debería llamarse en el hilo «principal» de ese intérprete, donde el CPython global el tiempo de ejecución se inicializó originalmente. La única excepción es si @code{exec()} se llamará inmediatamente después.

@node Cautions regarding runtime finalization,API de alto nivel,Precauciones sobre fork,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init cautions-regarding-runtime-finalization}@anchor{4cc0}@anchor{c-api/init id1}@anchor{4cc1}
@subsubsection Cautions regarding runtime finalization


In the late stage of @ref{2bb,,interpreter shutdown}, after attempting to wait for
non-daemon threads to exit (though this can be interrupted by
@ref{a63,,KeyboardInterrupt}) and running the @ref{d,,atexit} functions, the runtime
is marked as `finalizing': @code{_Py_IsFinalizing()} and
@ref{ef5,,sys.is_finalizing()} return true.  At this point, only the `finalization
thread' that initiated finalization (typically the main thread) is allowed to
acquire the @ref{2c5,,GIL}.

If any thread, other than the finalization thread, attempts to acquire the GIL
during finalization, either explicitly via @ref{49e,,PyGILState_Ensure()},
@ref{b1a,,Py_END_ALLOW_THREADS}, @ref{49d,,PyEval_AcquireThread()}, or
@code{PyEval_AcquireLock()}, or implicitly when the interpreter attempts to
reacquire it after having yielded it, the thread enters `a permanently blocked
state' where it remains until the program exits.  In most cases this is
harmless, but this can result in deadlock if a later stage of finalization
attempts to acquire a lock owned by the blocked thread, or otherwise waits on
the blocked thread.

Gross? Yes. This prevents random crashes and/or unexpectedly skipped C++
finalizations further up the call stack when such threads were forcibly exited
here in CPython 3.13 and earlier. The CPython runtime GIL acquiring C APIs
have never had any error reporting or handling expectations at GIL acquisition
time that would’ve allowed for graceful exit from this situation. Changing that
would require new stable C APIs and rewriting the majority of C code in the
CPython ecosystem to use those with error handling.

@node API de alto nivel,API de bajo nivel,Cautions regarding runtime finalization,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init high-level-api}@anchor{4cc2}
@subsubsection API de alto nivel


Estos son los tipos y funciones más utilizados al escribir código de extensión C o al incrustar el intérprete de Python:

@geindex PyInterpreterState (C type)
@anchor{c-api/init c PyInterpreterState}@anchor{954}
@deffn {C Tipo} type PyInterpreterState
` Part of the @ref{5f6,,Limited API} (as an opaque struct).'
Esta estructura de datos representa el estado compartido por varios subprocesos cooperantes. Los hilos que pertenecen al mismo intérprete comparten la administración de su módulo y algunos otros elementos internos. No hay miembros públicos en esta estructura.

Los hilos que pertenecen a diferentes intérpretes inicialmente no comparten nada, excepto el estado del proceso como memoria disponible, descriptores de archivos abiertos y demás. El bloqueo global del intérprete también es compartido por todos los hilos, independientemente de a qué intérprete pertenezcan.
@end deffn

@geindex PyThreadState (C type)
@anchor{c-api/init c PyThreadState}@anchor{826}
@deffn {C Tipo} type PyThreadState
` Part of the @ref{5f6,,Limited API} (as an opaque struct).'
This data structure represents the state of a single thread.  The only public
data member is:

@geindex PyThreadState.interp (C member)
@anchor{c-api/init c PyThreadState interp}@anchor{4cc3}
@deffn {C Miembro} @ref{954,,PyInterpreterState} *interp

This thread’s interpreter state.
@end deffn
@end deffn

@geindex PyEval_InitThreads (C function)
@anchor{c-api/init c PyEval_InitThreads}@anchor{164d}
@deffn {C Función} void PyEval_InitThreads ()
` Part of the @ref{5f6,,Stable ABI}.'
@geindex PyEval_AcquireThread()
@geindex PyEval_ReleaseThread()
@geindex PyEval_SaveThread()
@geindex PyEval_RestoreThread()

Función deprecada que no hace nada.

En Python 3.6 y versiones anteriores, esta función creaba el GIL si no existía.


Distinto en la versión 3.9: La función ahora no hace nada.



Distinto en la versión 3.7: Esta función ahora es llamada por @ref{247,,Py_Initialize()}, por lo que ya no tiene que llamarla usted mismo.



Distinto en la versión 3.2: Esta función ya no se puede llamar antes de @ref{247,,Py_Initialize()}.



Obsoleto desde la versión 3.9.


@geindex module;_thread
@end deffn

@geindex PyEval_SaveThread (C function)
@anchor{c-api/init c PyEval_SaveThread}@anchor{49b}
@deffn {C Función} @ref{826,,PyThreadState} *PyEval_SaveThread ()
` Part of the @ref{5f6,,Stable ABI}.'
Libere el bloqueo global del intérprete (si se ha creado) y restablezca el estado del hilo a @code{NULL}, retornando el estado del hilo anterior (que no es @code{NULL}). Si se ha creado el bloqueo, el hilo actual debe haberlo adquirido.
@end deffn

@geindex PyEval_RestoreThread (C function)
@anchor{c-api/init c PyEval_RestoreThread}@anchor{49c}
@deffn {C Función} void PyEval_RestoreThread (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Adquiera el bloqueo global del intérprete (si se ha creado) y establezca el estado del hilo en `tstate', que no debe ser @code{NULL}. Si se ha creado el bloqueo, el hilo actual no debe haberlo adquirido, de lo contrario se produce un `deadlock'.

@cartouche
@quotation Nota 
Calling this function from a thread when the runtime is finalizing will
hang the thread until the program exits, even if the thread was not
created by Python.  Refer to
@ref{4cc0,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Distinto en la versión 3.14: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.

@end deffn

@geindex PyThreadState_Get (C function)
@anchor{c-api/init c PyThreadState_Get}@anchor{466}
@deffn {C Función} @ref{826,,PyThreadState} *PyThreadState_Get ()
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el estado actual del hilo. Se debe mantener el bloqueo global del intérprete. Cuando el estado actual del hilo es @code{NULL}, esto genera un error fatal (por lo que la persona que llama no necesita verificar @code{NULL}).

See also @ref{465,,PyThreadState_GetUnchecked()}.
@end deffn

@geindex PyThreadState_GetUnchecked (C function)
@anchor{c-api/init c PyThreadState_GetUnchecked}@anchor{465}
@deffn {C Función} @ref{826,,PyThreadState} *PyThreadState_GetUnchecked ()

Similar to @ref{466,,PyThreadState_Get()}, but don’t kill the process with a
fatal error if it is NULL. The caller is responsible to check if the result
is NULL.


Added in version 3.13: In Python 3.5 to 3.12, the function was private and known as
@code{_PyThreadState_UncheckedGet()}.

@end deffn

@geindex PyThreadState_Swap (C function)
@anchor{c-api/init c PyThreadState_Swap}@anchor{49c5}
@deffn {C Función} @ref{826,,PyThreadState} *PyThreadState_Swap (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Cambia el estado del hilo actual con el estado del hilo dado por el argumento `tstate', que puede ser @code{NULL}. El bloqueo global del intérprete debe mantenerse y no se libera.
@end deffn

Las siguientes funciones utilizan almacenamiento local de hilos y no son compatibles con subinterpretes:

@geindex PyGILState_Ensure (C function)
@anchor{c-api/init c PyGILState_Ensure}@anchor{49e}
@deffn {C Función} PyGILState_STATE PyGILState_Ensure ()
` Part of the @ref{5f6,,Stable ABI}.'
Asegúrese de que el subproceso actual esté listo para llamar a la API de Python C, independientemente del estado actual de Python o del bloqueo global del intérprete. Esto se puede invocar tantas veces como lo desee un subproceso siempre que cada llamada coincida con una llamada a @ref{49f,,PyGILState_Release()}. En general, se pueden usar otras API relacionadas con subprocesos entre @ref{49e,,PyGILState_Ensure()} y @ref{49f,,PyGILState_Release()} invoca siempre que el estado del subproceso se restablezca a su estado anterior antes del `Release()'. Por ejemplo, el uso normal de las macros @ref{484e,,Py_BEGIN_ALLOW_THREADS} y @ref{b1a,,Py_END_ALLOW_THREADS} es aceptable.

El valor de retorno es un «identificador» opaco al estado del hilo cuando @ref{49e,,PyGILState_Ensure()} fue llamado, y debe pasarse a @ref{49f,,PyGILState_Release()} para asegurar que Python se deje en el mismo estado. Aunque las llamadas recursivas están permitidas, estos identificadores `no' pueden compartirse; cada llamada única a @ref{49e,,PyGILState_Ensure()} debe guardar el identificador para su llamada a @ref{49f,,PyGILState_Release()}.

Cuando la función regrese, el hilo actual contendrá el GIL y podrá llamar a código arbitrario de Python. El fracaso es un error fatal.

@cartouche
@quotation Nota 
Calling this function from a thread when the runtime is finalizing will
hang the thread until the program exits, even if the thread was not
created by Python.  Refer to
@ref{4cc0,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Distinto en la versión 3.14: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.

@end deffn

@geindex PyGILState_Release (C function)
@anchor{c-api/init c PyGILState_Release}@anchor{49f}
@deffn {C Función} void PyGILState_Release (PyGILState_STATE)
` Part of the @ref{5f6,,Stable ABI}.'
Libera cualquier recurso previamente adquirido. Después de esta llamada, el estado de Python será el mismo que antes de la llamada correspondiente @ref{49e,,PyGILState_Ensure()} (pero en general este estado será desconocido para la persona que llama, de ahí el uso de la API @code{GILState}).

Cada llamada a @ref{49e,,PyGILState_Ensure()} debe coincidir con una llamada a @ref{49f,,PyGILState_Release()} en el mismo hilo.
@end deffn

@geindex PyGILState_GetThisThreadState (C function)
@anchor{c-api/init c PyGILState_GetThisThreadState}@anchor{493a}
@deffn {C Función} @ref{826,,PyThreadState} *PyGILState_GetThisThreadState ()
` Part of the @ref{5f6,,Stable ABI}.'
Obtenga el estado actual del hilo para este hilo. Puede retornar @code{NULL} si no se ha utilizado la API @code{GILState} en el hilo actual. Tenga en cuenta que el subproceso principal siempre tiene dicho estado de subproceso, incluso si no se ha realizado una llamada de estado de subproceso automático en el subproceso principal. Esta es principalmente una función auxiliar y de diagnóstico.
@end deffn

@geindex PyGILState_Check (C function)
@anchor{c-api/init c PyGILState_Check}@anchor{4cc4}
@deffn {C Función} int PyGILState_Check ()

Retorna @code{1} si el hilo actual mantiene el GIL y @code{0} de lo contrario. Esta función se puede llamar desde cualquier hilo en cualquier momento. Solo si se ha inicializado el hilo de Python y actualmente mantiene el GIL, retornará @code{1}. Esta es principalmente una función auxiliar y de diagnóstico. Puede ser útil, por ejemplo, en contextos de devolución de llamada o funciones de asignación de memoria cuando saber que el GIL está bloqueado puede permitir que la persona que llama realice acciones confidenciales o se comporte de otra manera de manera diferente.


Added in version 3.4.

@end deffn

Las siguientes macros se usan normalmente sin punto y coma final; busque, por ejemplo, el uso en la distribución fuente de Python.

@geindex Py_BEGIN_ALLOW_THREADS (C macro)
@anchor{c-api/init c Py_BEGIN_ALLOW_THREADS}@anchor{484e}
@deffn {C Macro} Py_BEGIN_ALLOW_THREADS
` Part of the @ref{5f6,,Stable ABI}.'
Esta macro se expande a @code{@{PyThreadState *_save; _save = PyEval_SaveThread();}. Tenga en cuenta que contiene una llave de apertura; debe coincidir con la siguiente macro @ref{b1a,,Py_END_ALLOW_THREADS}. Ver arriba para una discusión más detallada de esta macro.
@end deffn

@geindex Py_END_ALLOW_THREADS (C macro)
@anchor{c-api/init c Py_END_ALLOW_THREADS}@anchor{b1a}
@deffn {C Macro} Py_END_ALLOW_THREADS
` Part of the @ref{5f6,,Stable ABI}.'
Esta macro se expande a @code{PyEval_RestoreThread(_save); @}}. Tenga en cuenta que contiene una llave de cierre; debe coincidir con una macro anterior @ref{484e,,Py_BEGIN_ALLOW_THREADS}. Ver arriba para una discusión más detallada de esta macro.
@end deffn

@geindex Py_BLOCK_THREADS (C macro)
@anchor{c-api/init c Py_BLOCK_THREADS}@anchor{4a0c}
@deffn {C Macro} Py_BLOCK_THREADS
` Part of the @ref{5f6,,Stable ABI}.'
Esta macro se expande a @code{PyEval_RestoreThread(_save);}: es equivalente a @ref{b1a,,Py_END_ALLOW_THREADS} sin la llave de cierre.
@end deffn

@geindex Py_UNBLOCK_THREADS (C macro)
@anchor{c-api/init c Py_UNBLOCK_THREADS}@anchor{4a18}
@deffn {C Macro} Py_UNBLOCK_THREADS
` Part of the @ref{5f6,,Stable ABI}.'
Esta macro se expande a @code{_save = PyEval_SaveThread();}: es equivalente a @ref{484e,,Py_BEGIN_ALLOW_THREADS} sin la llave de apertura y la declaración de variable.
@end deffn

@node API de bajo nivel,,API de alto nivel,Estado del hilo y el bloqueo global del intérprete
@anchor{c-api/init low-level-api}@anchor{4cc5}
@subsubsection API de bajo nivel


Todas las siguientes funciones deben llamarse después de @ref{247,,Py_Initialize()}.


Distinto en la versión 3.7: @ref{247,,Py_Initialize()} ahora inicializa el @ref{2c5,,GIL}.


@geindex PyInterpreterState_New (C function)
@anchor{c-api/init c PyInterpreterState_New}@anchor{4106}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyInterpreterState_New ()
` Part of the @ref{5f6,,Stable ABI}.'
Crea un nuevo objeto de estado de intérprete. No es necesario retener el bloqueo global del intérprete, pero se puede retener si es necesario para serializar llamadas a esta función.

Genera un @ref{18c3,,evento de auditoría} @code{python.PyInterpreterState_New} sin argumentos.
@end deffn

@geindex PyInterpreterState_Clear (C function)
@anchor{c-api/init c PyInterpreterState_Clear}@anchor{4105}
@deffn {C Función} void PyInterpreterState_Clear (PyInterpreterState *interp)
` Part of the @ref{5f6,,Stable ABI}.'
Restablece toda la información en un objeto de estado de intérprete. Se debe mantener el bloqueo global del intérprete.

Lanza una @ref{18c3,,eventos de auditoría} @code{python.PyInterpreterState Clear} sin argumentos.
@end deffn

@geindex PyInterpreterState_Delete (C function)
@anchor{c-api/init c PyInterpreterState_Delete}@anchor{4946}
@deffn {C Función} void PyInterpreterState_Delete (PyInterpreterState *interp)
` Part of the @ref{5f6,,Stable ABI}.'
Destruye un objeto de estado de intérprete. No es necesario mantener el bloqueo global del intérprete. El estado del intérprete debe haberse restablecido con una llamada previa a @ref{4105,,PyInterpreterState_Clear()}.
@end deffn

@geindex PyThreadState_New (C function)
@anchor{c-api/init c PyThreadState_New}@anchor{49c4}
@deffn {C Función} @ref{826,,PyThreadState} *PyThreadState_New (PyInterpreterState *interp)
` Part of the @ref{5f6,,Stable ABI}.'
Crea un nuevo objeto de estado de hilo que pertenece al objeto de intérprete dado. No es necesario retener el bloqueo global del intérprete, pero se puede retener si es necesario para serializar llamadas a esta función.
@end deffn

@geindex PyThreadState_Clear (C function)
@anchor{c-api/init c PyThreadState_Clear}@anchor{1628}
@deffn {C Función} void PyThreadState_Clear (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Restablece toda la información en un objeto de estado de hilo. Se debe mantener el bloqueo global del intérprete.


Distinto en la versión 3.9: Esta función ahora llama a la retrollamada @code{PyThreadState.on_delete}. Anteriormente, eso sucedía en @ref{19a9,,PyThreadState_Delete()}.

@end deffn

@geindex PyThreadState_Delete (C function)
@anchor{c-api/init c PyThreadState_Delete}@anchor{19a9}
@deffn {C Función} void PyThreadState_Delete (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Destruye un objeto de estado de hilo. No es necesario mantener el bloqueo global del intérprete. El estado del hilo debe haberse restablecido con una llamada previa a @ref{1628,,PyThreadState_Clear()}.
@end deffn

@geindex PyThreadState_DeleteCurrent (C function)
@anchor{c-api/init c PyThreadState_DeleteCurrent}@anchor{19dc}
@deffn {C Función} void PyThreadState_DeleteCurrent (void)

Destroy the current thread state and release the global interpreter lock.
Like @ref{19a9,,PyThreadState_Delete()}, the global interpreter lock must
be held. The thread state must have been reset with a previous call
to @ref{1628,,PyThreadState_Clear()}.
@end deffn

@geindex PyThreadState_GetFrame (C function)
@anchor{c-api/init c PyThreadState_GetFrame}@anchor{827}
@deffn {C Función} @ref{822,,PyFrameObject} *PyThreadState_GetFrame (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Obtiene el marco actual del estado del hilo de Python `tstate'.

Retorna una @ref{431,,strong reference} (referencia sólida). Retorna @code{NULL} si no se está ejecutando ningún cuadro.

Vea también @ref{17c4,,PyEval_GetFrame()}.

`tstate' no debe ser @code{NULL}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_GetID (C function)
@anchor{c-api/init c PyThreadState_GetID}@anchor{a04}
@deffn {C Función} uint64_t PyThreadState_GetID (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Obtiene el identificador de estado de subproceso único del estado del hilo de Python `tstate'.

`tstate' no debe ser @code{NULL}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_GetInterpreter (C function)
@anchor{c-api/init c PyThreadState_GetInterpreter}@anchor{a03}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyThreadState_GetInterpreter (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Obtiene el intérprete del estado del hilo de Python `tstate'.

`tstate' no debe ser @code{NULL}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_EnterTracing (C function)
@anchor{c-api/init c PyThreadState_EnterTracing}@anchor{7ee}
@deffn {C Función} void PyThreadState_EnterTracing (PyThreadState *tstate)

Suspender el seguimiento y el perfilado en el estado del hilo de Python `tstate'.

Reanudelos usando la función @ref{7ef,,PyThreadState_LeaveTracing()}.


Added in version 3.11.

@end deffn

@geindex PyThreadState_LeaveTracing (C function)
@anchor{c-api/init c PyThreadState_LeaveTracing}@anchor{7ef}
@deffn {C Función} void PyThreadState_LeaveTracing (PyThreadState *tstate)

Reanudar el seguimiento y el perfilado en el estado del hilo de Python `tstate' suspendido por la función @ref{7ee,,PyThreadState_EnterTracing()}.

Consulte también las funciones @ref{153e,,PyEval_SetTrace()} y @ref{153d,,PyEval_SetProfile()}.


Added in version 3.11.

@end deffn

@geindex PyInterpreterState_Get (C function)
@anchor{c-api/init c PyInterpreterState_Get}@anchor{4a0}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyInterpreterState_Get (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Obtiene el intérprete actual.

Emite un error fatal si no hay un estado actual del hilo de Python o no hay un intérprete actual. No puede retornar NULL.

La persona que llama debe retener el GIL.


Added in version 3.9.

@end deffn

@geindex PyInterpreterState_GetID (C function)
@anchor{c-api/init c PyInterpreterState_GetID}@anchor{c4e}
@deffn {C Función} int64_t PyInterpreterState_GetID (PyInterpreterState *interp)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna la identificación única del intérprete. Si hubo algún error al hacerlo, entonces se retorna @code{-1} y se establece un error.

La persona que llama debe retener el GIL.


Added in version 3.7.

@end deffn

@geindex PyInterpreterState_GetDict (C function)
@anchor{c-api/init c PyInterpreterState_GetDict}@anchor{4947}
@deffn {C Función} @ref{42d,,PyObject} *PyInterpreterState_GetDict (PyInterpreterState *interp)
` Part of the @ref{5f6,,Stable ABI} since version 3.8.'
Retorna un diccionario en el que se pueden almacenar datos específicos del intérprete. Si esta función retorna @code{NULL}, no se ha producido ninguna excepción y la persona que llama debe suponer que no hay disponible una instrucción específica del intérprete.

Esto no reemplaza a @ref{a12,,PyModule_GetState()}, que las extensiones deben usar para almacenar información de estado específica del intérprete.


Added in version 3.8.

@end deffn

@geindex _PyFrameEvalFunction (C type)
@anchor{c-api/init c _PyFrameEvalFunction}@anchor{810}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*_PyFrameEvalFunction)(@ref{826,,PyThreadState} *tstate, @ref{160d,,_PyInterpreterFrame} *frame, int throwflag)

Tipo de función de evaluación de marcos.

El parámetro `throwflag' es usado por el método de generadores @code{throw()}: si no es cero, maneja la excepción actual.


Distinto en la versión 3.9: La función ahora recibe un parámetro `tstate'.



Distinto en la versión 3.11: El parámetro `frame' cambió de @code{PyFrameObject*} a @code{_PyInterpreterFrame*}.

@end deffn

@geindex _PyInterpreterState_GetEvalFrameFunc (C function)
@anchor{c-api/init c _PyInterpreterState_GetEvalFrameFunc}@anchor{1997}
@deffn {C Función} @ref{810,,_PyFrameEvalFunction} _PyInterpreterState_GetEvalFrameFunc (PyInterpreterState *interp)

Obtiene la función de evaluación de marcos.

Consulte 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} «Adición de una API de evaluación de marcos a CPython».


Added in version 3.9.

@end deffn

@geindex _PyInterpreterState_SetEvalFrameFunc (C function)
@anchor{c-api/init c _PyInterpreterState_SetEvalFrameFunc}@anchor{1998}
@deffn {C Función} void _PyInterpreterState_SetEvalFrameFunc (PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)

Configura la función de evaluación del marco.

Consulte 
@geindex Python Enhancement Proposals; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} «Adición de una API de evaluación de marcos a CPython».


Added in version 3.9.

@end deffn

@geindex PyThreadState_GetDict (C function)
@anchor{c-api/init c PyThreadState_GetDict}@anchor{49c3}
@deffn {C Función} @ref{42d,,PyObject} *PyThreadState_GetDict ()
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Retorna un diccionario en el que las extensiones pueden almacenar información de estado específica del hilo. Cada extensión debe usar una clave única para almacenar el estado en el diccionario. Está bien llamar a esta función cuando no hay un estado del hilo actual disponible. Si esta función retorna @code{NULL}, no se ha producido ninguna excepción y la persona que llama debe asumir que no hay disponible ningún estado del hilo actual.
@end deffn

@geindex PyThreadState_SetAsyncExc (C function)
@anchor{c-api/init c PyThreadState_SetAsyncExc}@anchor{c4c}
@deffn {C Función} int PyThreadState_SetAsyncExc (unsigned long id, PyObject *exc)
` Part of the @ref{5f6,,Stable ABI}.'
Asynchronously raise an exception in a thread. The `id' argument is the thread
id of the target thread; `exc' is the exception object to be raised. This
function does not steal any references to `exc'. To prevent naive misuse, you
must write your own C extension to call this.  Must be called with the GIL held.
Returns the number of thread states modified; this is normally one, but will be
zero if the thread id isn’t found.  If `exc' is @code{NULL}, the pending
exception (if any) for the thread is cleared. This raises no exceptions.


Distinto en la versión 3.7: El tipo del parámetro `id' cambia de long a unsigned long.

@end deffn

@geindex PyEval_AcquireThread (C function)
@anchor{c-api/init c PyEval_AcquireThread}@anchor{49d}
@deffn {C Función} void PyEval_AcquireThread (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Adquiere el bloqueo global del intérprete y establece el estado actual del hilo en `tstate', que no debe ser @code{NULL}. El bloqueo debe haber sido creado anteriormente. Si este hilo ya tiene el bloqueo, se produce un deadlock.

@cartouche
@quotation Nota 
Calling this function from a thread when the runtime is finalizing will
hang the thread until the program exits, even if the thread was not
created by Python.  Refer to
@ref{4cc0,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Distinto en la versión 3.8: Actualiza para ser coherente con @ref{49c,,PyEval_RestoreThread()}, @ref{b1a,,Py_END_ALLOW_THREADS()}, y @ref{49e,,PyGILState_Ensure()}, y termina el hilo actual si se llama mientras el intérprete está finalizando.



Distinto en la versión 3.14: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.


@ref{49c,,PyEval_RestoreThread()} es una función de nivel superior que siempre está disponible (incluso cuando los subprocesos no se han inicializado).
@end deffn

@geindex PyEval_ReleaseThread (C function)
@anchor{c-api/init c PyEval_ReleaseThread}@anchor{492c}
@deffn {C Función} void PyEval_ReleaseThread (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
Restablece el estado actual del hilo a @code{NULL} y libera el bloqueo global del intérprete. El bloqueo debe haberse creado antes y debe estar retenido por el hilo actual. El argumento `tstate', que no debe ser @code{NULL}, solo se usa para verificar que representa el estado actual del hilo — si no lo es, se informa un error fatal.

@ref{49b,,PyEval_SaveThread()} es una función de nivel superior que siempre está disponible (incluso cuando los hilos no se han inicializado).
@end deffn

@node Soporte de subinterprete,Notificaciones asincrónicas,Estado del hilo y el bloqueo global del intérprete,Inicialización finalización e hilos
@anchor{c-api/init id2}@anchor{4cc6}@anchor{c-api/init sub-interpreter-support}@anchor{62b}
@subsection Soporte de subinterprete


Si bien en la mayoría de los usos, solo incrustará un solo intérprete de Python, hay casos en los que necesita crear varios intérpretes independientes en el mismo proceso y tal vez incluso en el mismo hilo. Los subinterpretes le permiten hacer eso.

El intérprete «principal» es el primero creado cuando se inicializa el tiempo de ejecución. Suele ser el único intérprete de Python en un proceso. A diferencia de los subinterpretes, el intérprete principal tiene responsabilidades globales de proceso únicas, como el manejo de señales. También es responsable de la ejecución durante la inicialización del tiempo de ejecución y generalmente es el intérprete activo durante la finalización del tiempo de ejecución. La función @ref{4cc7,,PyInterpreterState_Main()} retorna un puntero a su estado.

Puede cambiar entre subinterpretes utilizando la función @ref{49c5,,PyThreadState_Swap()}. Puede crearlos y destruirlos utilizando las siguientes funciones:

@geindex PyInterpreterConfig (C type)
@anchor{c-api/init c PyInterpreterConfig}@anchor{611}
@deffn {C Tipo} type PyInterpreterConfig

Structure containing most parameters to configure a sub-interpreter.
Its values are used only in @ref{507,,Py_NewInterpreterFromConfig()} and
never modified by the runtime.


Added in version 3.12.


Structure fields:

@geindex PyInterpreterConfig.use_main_obmalloc (C member)
@anchor{c-api/init c PyInterpreterConfig use_main_obmalloc}@anchor{429e}
@deffn {C Miembro} int use_main_obmalloc

If this is @code{0} then the sub-interpreter will use its own
«object» allocator state.
Otherwise it will use (share) the main interpreter’s.

If this is @code{0} then
@ref{4cc8,,check_multi_interp_extensions}
must be @code{1} (non-zero).
If this is @code{1} then @ref{4cc9,,gil}
must not be @ref{4cca,,PyInterpreterConfig_OWN_GIL}.
@end deffn

@geindex PyInterpreterConfig.allow_fork (C member)
@anchor{c-api/init c PyInterpreterConfig allow_fork}@anchor{4ccb}
@deffn {C Miembro} int allow_fork

If this is @code{0} then the runtime will not support forking the
process in any thread where the sub-interpreter is currently active.
Otherwise fork is unrestricted.

Note that the @ref{d6,,subprocess} module still works
when fork is disallowed.
@end deffn

@geindex PyInterpreterConfig.allow_exec (C member)
@anchor{c-api/init c PyInterpreterConfig allow_exec}@anchor{4ccc}
@deffn {C Miembro} int allow_exec

If this is @code{0} then the runtime will not support replacing the
current process via exec (e.g. @ref{2b1d,,os.execv()}) in any thread
where the sub-interpreter is currently active.
Otherwise exec is unrestricted.

Note that the @ref{d6,,subprocess} module still works
when exec is disallowed.
@end deffn

@geindex PyInterpreterConfig.allow_threads (C member)
@anchor{c-api/init c PyInterpreterConfig allow_threads}@anchor{4ccd}
@deffn {C Miembro} int allow_threads

If this is @code{0} then the sub-interpreter’s @ref{ed,,threading} module
won’t create threads.
Otherwise threads are allowed.
@end deffn

@geindex PyInterpreterConfig.allow_daemon_threads (C member)
@anchor{c-api/init c PyInterpreterConfig allow_daemon_threads}@anchor{4cce}
@deffn {C Miembro} int allow_daemon_threads

If this is @code{0} then the sub-interpreter’s @ref{ed,,threading} module
won’t create daemon threads.
Otherwise daemon threads are allowed (as long as
@ref{4ccd,,allow_threads} is non-zero).
@end deffn

@geindex PyInterpreterConfig.check_multi_interp_extensions (C member)
@anchor{c-api/init c PyInterpreterConfig check_multi_interp_extensions}@anchor{4cc8}
@deffn {C Miembro} int check_multi_interp_extensions

If this is @code{0} then all extension modules may be imported,
including legacy (single-phase init) modules,
in any thread where the sub-interpreter is currently active.
Otherwise only multi-phase init extension modules
(see 
@geindex Python Enhancement Proposals; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) may be imported.
(Also see @ref{4c29,,Py_mod_multiple_interpreters}.)

This must be @code{1} (non-zero) if
@ref{429e,,use_main_obmalloc} is @code{0}.
@end deffn

@geindex PyInterpreterConfig.gil (C member)
@anchor{c-api/init c PyInterpreterConfig gil}@anchor{4cc9}
@deffn {C Miembro} int gil

This determines the operation of the GIL for the sub-interpreter.
It may be one of the following:

@geindex PyInterpreterConfig_DEFAULT_GIL (C macro)
@anchor{c-api/init c PyInterpreterConfig_DEFAULT_GIL}@anchor{4ccf}
@deffn {C Macro} PyInterpreterConfig_DEFAULT_GIL

Use the default selection (@ref{4cd0,,PyInterpreterConfig_SHARED_GIL}).
@end deffn

@geindex PyInterpreterConfig_SHARED_GIL (C macro)
@anchor{c-api/init c PyInterpreterConfig_SHARED_GIL}@anchor{4cd0}
@deffn {C Macro} PyInterpreterConfig_SHARED_GIL

Use (share) the main interpreter’s GIL.
@end deffn

@geindex PyInterpreterConfig_OWN_GIL (C macro)
@anchor{c-api/init c PyInterpreterConfig_OWN_GIL}@anchor{4cca}
@deffn {C Macro} PyInterpreterConfig_OWN_GIL

Use the sub-interpreter’s own GIL.
@end deffn

If this is @ref{4cca,,PyInterpreterConfig_OWN_GIL} then
@ref{429e,,PyInterpreterConfig.use_main_obmalloc} must be @code{0}.
@end deffn
@end deffn

@geindex Py_NewInterpreterFromConfig (C function)
@anchor{c-api/init c Py_NewInterpreterFromConfig}@anchor{507}
@deffn {C Función} @ref{a3f,,PyStatus} Py_NewInterpreterFromConfig (PyThreadState **tstate_p, const PyInterpreterConfig *config)

@geindex module;builtins
@geindex module;__main__
@geindex module;sys
@geindex stdout (in module sys)
@geindex stderr (in module sys)
@geindex stdin (in module sys)

Crea un nuevo subinterprete. Este es un entorno (casi) totalmente separado para la ejecución de código Python. En particular, el nuevo intérprete tiene versiones separadas e independientes de todos los módulos importados, incluidos los módulos fundamentales @ref{13,,builtins}, @ref{1,,__main__} y @ref{d9,,sys}. La tabla de módulos cargados (@code{sys.modules}) y la ruta de búsqueda del módulo (@code{sys.path}) también están separados. El nuevo entorno no tiene variable @code{sys.argv}. Tiene nuevos objetos de archivo de flujo de E/S estándar @code{sys.stdin}, @code{sys.stdout} y @code{sys.stderr} (sin embargo, estos se refieren a los mismos descriptores de archivo subyacentes).

The given `config' controls the options with which the interpreter
is initialized.

Upon success, `tstate_p' will be set to the first thread state
created in the new
sub-interpreter.  This thread state is made in the current thread state.
Note that no actual thread is created; see the discussion of thread states
below.  If creation of the new interpreter is unsuccessful,
`tstate_p' is set to @code{NULL};
no exception is set since the exception state is stored in the
current thread state and there may not be a current thread state.

Like all other Python/C API functions, the global interpreter lock
must be held before calling this function and is still held when it
returns.  Likewise a current thread state must be set on entry.  On
success, the returned thread state will be set as current.  If the
sub-interpreter is created with its own GIL then the GIL of the
calling interpreter will be released.  When the function returns,
the new interpreter’s GIL will be held by the current thread and
the previously interpreter’s GIL will remain released here.


Added in version 3.12.


Sub-interpreters are most effective when isolated from each other,
with certain functionality restricted:

@example
PyInterpreterConfig config = @{
    .use_main_obmalloc = 0,
    .allow_fork = 0,
    .allow_exec = 0,
    .allow_threads = 1,
    .allow_daemon_threads = 0,
    .check_multi_interp_extensions = 1,
    .gil = PyInterpreterConfig_OWN_GIL,
@};
PyThreadState *tstate = Py_NewInterpreterFromConfig(&config);
@end example

Note that the config is used only briefly and does not get modified.
During initialization the config’s values are converted into various
@ref{954,,PyInterpreterState} values.  A read-only copy of the config
may be stored internally on the @ref{954,,PyInterpreterState}.

@geindex Py_FinalizeEx (C function)
@geindex Py_Initialize (C function)

Los módulos de extensión se comparten entre (sub) intérpretes de la siguiente manera:


@itemize *

@item 
Para módulos que usan inicialización multifase, por ejemplo @ref{f33,,PyModule_FromDefAndSpec()}, se crea e inicializa un objeto de módulo separado para cada intérprete. Solo las variables estáticas y globales de nivel C se comparten entre estos objetos de módulo.

@item 
Para módulos que utilizan inicialización monofásica, por ejemplo @ref{4835,,PyModule_Create()}, la primera vez que se importa una extensión en particular, se inicializa normalmente y una copia (superficial) del diccionario de su módulo se guarda. Cuando otro (sub) intérprete importa la misma extensión, se inicializa un nuevo módulo y se llena con el contenido de esta copia; no se llama a la función @code{init} de la extensión. Los objetos en el diccionario del módulo terminan compartidos entre (sub) intérpretes, lo que puede causar un comportamiento no deseado (ver Errores y advertencias (@ref{4cd1,,Bugs and caveats}) a continuación).

Tenga en cuenta que esto es diferente de lo que sucede cuando se importa una extensión después de que el intérprete se haya reiniciado por completo llamando a @ref{d9c,,Py_FinalizeEx()} y @ref{247,,Py_Initialize()}; en ese caso, la función @code{initmodule} de la extensión `es' llamada nuevamente. Al igual que con la inicialización de múltiples fases, esto significa que solo se comparten variables estáticas y globales de nivel C entre estos módulos.
@end itemize

@geindex close (in module os)
@end deffn

@geindex Py_NewInterpreter (C function)
@anchor{c-api/init c Py_NewInterpreter}@anchor{17be}
@deffn {C Función} @ref{826,,PyThreadState} *Py_NewInterpreter (void)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex module;builtins
@geindex module;__main__
@geindex module;sys
@geindex stdout (in module sys)
@geindex stderr (in module sys)
@geindex stdin (in module sys)

Create a new sub-interpreter.  This is essentially just a wrapper
around @ref{507,,Py_NewInterpreterFromConfig()} with a config that
preserves the existing behavior.  The result is an unisolated
sub-interpreter that shares the main interpreter’s GIL, allows
fork/exec, allows daemon threads, and allows single-phase init
modules.
@end deffn

@geindex Py_EndInterpreter (C function)
@anchor{c-api/init c Py_EndInterpreter}@anchor{1867}
@deffn {C Función} void Py_EndInterpreter (PyThreadState *tstate)
` Part of the @ref{5f6,,Stable ABI}.'
@geindex Py_FinalizeEx (C function)

Destroy the (sub-)interpreter represented by the given thread state.
The given thread state must be the current thread state.  See the
discussion of thread states below.  When the call returns,
the current thread state is @code{NULL}.  All thread states associated
with this interpreter are destroyed.  The global interpreter lock
used by the target interpreter must be held before calling this
function.  No GIL is held when it returns.

@ref{d9c,,Py_FinalizeEx()} will destroy all sub-interpreters that
haven’t been explicitly destroyed at that point.
@end deffn

@menu
* A Per-Interpreter GIL:: 
* Errores y advertencias:: 

@end menu

@node A Per-Interpreter GIL,Errores y advertencias,,Soporte de subinterprete
@anchor{c-api/init a-per-interpreter-gil}@anchor{4cd2}
@subsubsection A Per-Interpreter GIL


Using @ref{507,,Py_NewInterpreterFromConfig()} you can create
a sub-interpreter that is completely isolated from other interpreters,
including having its own GIL.  The most important benefit of this
isolation is that such an interpreter can execute Python code without
being blocked by other interpreters or blocking any others.  Thus a
single Python process can truly take advantage of multiple CPU cores
when running Python code.  The isolation also encourages a different
approach to concurrency than that of just using threads.
(See 
@geindex Python Enhancement Proposals; PEP 554
PEP 554@footnote{https://peps.python.org/pep-0554/}.)

Using an isolated interpreter requires vigilance in preserving that
isolation.  That especially means not sharing any objects or mutable
state without guarantees about thread-safety.  Even objects that are
otherwise immutable (e.g. @code{None}, @code{(1, 5)}) can’t normally be shared
because of the refcount.  One simple but less-efficient approach around
this is to use a global lock around all use of some state (or object).
Alternately, effectively immutable objects (like integers or strings)
can be made safe in spite of their refcounts by making them @ref{429d,,immortal}.
In fact, this has been done for the builtin singletons, small integers,
and a number of other builtin objects.

If you preserve isolation then you will have access to proper multi-core
computing without the complications that come with free-threading.
Failure to preserve isolation will expose you to the full consequences
of free-threading, including races and hard-to-debug crashes.

Aside from that, one of the main challenges of using multiple isolated
interpreters is how to communicate between them safely (not break
isolation) and efficiently.  The runtime and stdlib do not provide
any standard approach to this yet.  A future stdlib module would help
mitigate the effort of preserving isolation and expose effective tools
for communicating (and sharing) data between interpreters.


Added in version 3.12.


@node Errores y advertencias,,A Per-Interpreter GIL,Soporte de subinterprete
@anchor{c-api/init bugs-and-caveats}@anchor{4cd1}
@subsubsection Errores y advertencias


Debido a que los subinterpretes (y el intérprete principal) son parte del mismo proceso, el aislamiento entre ellos no es perfecto — por ejemplo, usando operaciones de archivos de bajo nivel como @ref{bfc,,os.close()} pueden (accidentalmente o maliciosamente) afectar los archivos abiertos del otro. Debido a la forma en que las extensiones se comparten entre (sub) intérpretes, algunas extensiones pueden no funcionar correctamente; esto es especialmente probable cuando se utiliza la inicialización monofásica o las variables globales (estáticas). Es posible insertar objetos creados en un subinterprete en un espacio de nombres de otro (sub) intérprete; Esto debe evitarse si es posible.

Se debe tener especial cuidado para evitar compartir funciones, métodos, instancias o clases definidas por el usuario entre los subinterpretes, ya que las operaciones de importación ejecutadas por dichos objetos pueden afectar el diccionario (sub-) intérprete incorrecto de los módulos cargados. Es igualmente importante evitar compartir objetos desde los que se pueda acceder a lo anterior.

También tenga en cuenta que la combinación de esta funcionalidad con @code{PyGILState_*} APIs es delicada, porque estas APIs suponen una biyección entre los estados de hilo de Python e hilos a nivel del sistema operativo, una suposición rota por la presencia de subinterpretes. Se recomienda encarecidamente que no cambie los subinterpretes entre un par de llamadas coincidentes @ref{49e,,PyGILState_Ensure()} y @ref{49f,,PyGILState_Release()}. Además, las extensiones (como @ref{2b,,ctypes}) que usan estas APIs para permitir la llamada de código Python desde hilos no creados por Python probablemente se rompan cuando se usan subinterpretes.

@node Notificaciones asincrónicas,Perfilado y Rastreo,Soporte de subinterprete,Inicialización finalización e hilos
@anchor{c-api/init asynchronous-notifications}@anchor{4cd3}
@subsection Notificaciones asincrónicas


Se proporciona un mecanismo para hacer notificaciones asincrónicas al hilo principal del intérprete. Estas notificaciones toman la forma de un puntero de función y un argumento de puntero nulo.

@geindex Py_AddPendingCall (C function)
@anchor{c-api/init c Py_AddPendingCall}@anchor{a13}
@deffn {C Función} int Py_AddPendingCall (int (*func)(void*), void *arg)
` Part of the @ref{5f6,,Stable ABI}.'
Programa una función para que se llame desde el hilo principal del intérprete. En caso de éxito, se retorna @code{0} y se pone en cola `func' para ser llamado en el hilo principal. En caso de fallo, se retorna @code{-1} sin establecer ninguna excepción.

Cuando se puso en cola con éxito, `func' será `eventualmente' invocado desde el hilo principal del intérprete con el argumento `arg'. Se llamará de forma asincrónica con respecto al código Python que se ejecuta normalmente, pero con ambas condiciones cumplidas:


@itemize *

@item 
en un límite @ref{2f2,,bytecode};

@item 
con el hilo principal que contiene el @ref{2b5,,global interpreter lock} (`func', por lo tanto, puede usar la API C completa).
@end itemize

`func' debe retornar @code{0} en caso de éxito o @code{-1} en caso de error con una excepción establecida. `func' no se interrumpirá para realizar otra notificación asíncrona de forma recursiva, pero aún se puede interrumpir para cambiar hilos si se libera el bloqueo global del intérprete.

Esta función no necesita un estado de hilo actual para ejecutarse y no necesita el bloqueo global del intérprete.

Para llamar a esta función en un subinterprete, quien llama debe mantener el GIL. De lo contrario, la función `func' se puede programar para que se llame desde el intérprete incorrecto.

@cartouche
@quotation Advertencia 
Esta es una función de bajo nivel, solo útil para casos muy especiales. No hay garantía de que `func' se llame lo más rápido posible. Si el hilo principal está ocupado ejecutando una llamada al sistema, no se llamará `func' antes de que vuelva la llamada del sistema. Esta función generalmente `no' es adecuada para llamar a código Python desde hilos C arbitrarios. En su lugar, use @ref{4cbd,,PyGILState API}.
@end quotation
@end cartouche


Added in version 3.1.



Distinto en la versión 3.9: Si esta función se llama en un subinterprete, la función `func' ahora está programada para ser llamada desde el subinterprete, en lugar de ser llamada desde el intérprete principal. Cada subinterprete ahora tiene su propia lista de llamadas programadas.

@end deffn

@node Perfilado y Rastreo,Reference tracing,Notificaciones asincrónicas,Inicialización finalización e hilos
@anchor{c-api/init profiling}@anchor{4cd4}@anchor{c-api/init profiling-and-tracing}@anchor{4cd5}
@subsection Perfilado y Rastreo


El intérprete de Python proporciona soporte de bajo nivel para adjuntar funciones de creación de perfiles y seguimiento de ejecución. Estos se utilizan para herramientas de análisis de perfiles, depuración y cobertura.

Esta interfaz C permite que el código de perfilado o rastreo evite la sobrecarga de llamar a través de objetos invocables a nivel de Python, haciendo una llamada directa a la función C en su lugar. Los atributos esenciales de la instalación no han cambiado; la interfaz permite instalar funciones de rastreo por hilos, y los eventos básicos informados a la función de rastreo son los mismos que se informaron a las funciones de rastreo a nivel de Python en versiones anteriores.

@geindex Py_tracefunc (C type)
@anchor{c-api/init c Py_tracefunc}@anchor{4cd6}
@deffn {C Tipo} typedef int (*Py_tracefunc)(@ref{42d,,PyObject} *obj, @ref{822,,PyFrameObject} *frame, int what, @ref{42d,,PyObject} *arg)

The type of the trace function registered using @ref{153d,,PyEval_SetProfile()} and
@ref{153e,,PyEval_SetTrace()}. The first parameter is the object passed to the
registration function as `obj', `frame' is the frame object to which the event
pertains, `what' is one of the constants @ref{4cd7,,PyTrace_CALL},
@ref{4cd8,,PyTrace_EXCEPTION}, @ref{4cd9,,PyTrace_LINE}, @ref{4cda,,PyTrace_RETURN},
@ref{4cdb,,PyTrace_C_CALL}, @ref{4cdc,,PyTrace_C_EXCEPTION}, @ref{4cdd,,PyTrace_C_RETURN},
or @ref{4cde,,PyTrace_OPCODE}, and `arg' depends on the value of `what':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor de `what'

@tab

Significado de `arg'

@item

@ref{4cd7,,PyTrace_CALL}

@tab

Siempre @ref{4831,,Py_None}.

@item

@ref{4cd8,,PyTrace_EXCEPTION}

@tab

Información de excepción retornada por @ref{72b,,sys.exc_info()}.

@item

@ref{4cd9,,PyTrace_LINE}

@tab

Siempre @ref{4831,,Py_None}.

@item

@ref{4cda,,PyTrace_RETURN}

@tab

Valor retornado al que llama, o @code{NULL} si es causado por una excepción.

@item

@ref{4cdb,,PyTrace_C_CALL}

@tab

Objeto función que se llaman.

@item

@ref{4cdc,,PyTrace_C_EXCEPTION}

@tab

Objeto función que se llaman.

@item

@ref{4cdd,,PyTrace_C_RETURN}

@tab

Objeto función que se llaman.

@item

@ref{4cde,,PyTrace_OPCODE}

@tab

Siempre @ref{4831,,Py_None}.

@end multitable

@end deffn

@geindex PyTrace_CALL (C var)
@anchor{c-api/init c PyTrace_CALL}@anchor{4cd7}
@deffn {C Variable} int PyTrace_CALL

El valor del parámetro `what' para una función @ref{4cd6,,Py_tracefunc} cuando se informa una nueva llamada a una función o método, o una nueva entrada en un generador. Tenga en cuenta que la creación del iterador para una función de generador no se informa ya que no hay transferencia de control al código de bytes de Python en la marco correspondiente.
@end deffn

@geindex PyTrace_EXCEPTION (C var)
@anchor{c-api/init c PyTrace_EXCEPTION}@anchor{4cd8}
@deffn {C Variable} int PyTrace_EXCEPTION

El valor del parámetro `what' para una función @ref{4cd6,,Py_tracefunc} cuando se ha producido una excepción. La función de devolución de llamada se llama con este valor para `what' cuando después de que se procese cualquier bytecode, después de lo cual la excepción se establece dentro del marco que se está ejecutando. El efecto de esto es que a medida que la propagación de la excepción hace que la pila de Python se desenrolle, el retorno de llamada se llama al retornar a cada marco a medida que se propaga la excepción. Solo las funciones de rastreo reciben estos eventos; el perfilador (`profiler') no los necesita.
@end deffn

@geindex PyTrace_LINE (C var)
@anchor{c-api/init c PyTrace_LINE}@anchor{4cd9}
@deffn {C Variable} int PyTrace_LINE

The value passed as the `what' parameter to a @ref{4cd6,,Py_tracefunc} function
(but not a profiling function) when a line-number event is being reported.
It may be disabled for a frame by setting @ref{c63,,f_trace_lines} to
`0' on that frame.
@end deffn

@geindex PyTrace_RETURN (C var)
@anchor{c-api/init c PyTrace_RETURN}@anchor{4cda}
@deffn {C Variable} int PyTrace_RETURN

El valor para el parámetro `what' para @ref{4cd6,,Py_tracefunc} funciona cuando una llamada está por regresar.
@end deffn

@geindex PyTrace_C_CALL (C var)
@anchor{c-api/init c PyTrace_C_CALL}@anchor{4cdb}
@deffn {C Variable} int PyTrace_C_CALL

El valor del parámetro `what' para @ref{4cd6,,Py_tracefunc} funciona cuando una función C está a punto de ser invocada.
@end deffn

@geindex PyTrace_C_EXCEPTION (C var)
@anchor{c-api/init c PyTrace_C_EXCEPTION}@anchor{4cdc}
@deffn {C Variable} int PyTrace_C_EXCEPTION

El valor del parámetro `what' para funciones @ref{4cd6,,Py_tracefunc} cuando una función C ha lanzado una excepción.
@end deffn

@geindex PyTrace_C_RETURN (C var)
@anchor{c-api/init c PyTrace_C_RETURN}@anchor{4cdd}
@deffn {C Variable} int PyTrace_C_RETURN

El valor del parámetro `what' para @ref{4cd6,,Py_tracefunc} funciona cuando una función C ha retornado.
@end deffn

@geindex PyTrace_OPCODE (C var)
@anchor{c-api/init c PyTrace_OPCODE}@anchor{4cde}
@deffn {C Variable} int PyTrace_OPCODE

The value for the `what' parameter to @ref{4cd6,,Py_tracefunc} functions (but not
profiling functions) when a new opcode is about to be executed.  This event is
not emitted by default: it must be explicitly requested by setting
@ref{c64,,f_trace_opcodes} to `1' on the frame.
@end deffn

@geindex PyEval_SetProfile (C function)
@anchor{c-api/init c PyEval_SetProfile}@anchor{153d}
@deffn {C Función} void PyEval_SetProfile (Py_tracefunc func, PyObject *obj)

Set the profiler function to `func'.  The `obj' parameter is passed to the
function as its first parameter, and may be any Python object, or @code{NULL}.  If
the profile function needs to maintain state, using a different value for `obj'
for each thread provides a convenient and thread-safe place to store it.  The
profile function is called for all monitored events except @ref{4cd9,,PyTrace_LINE}
@ref{4cde,,PyTrace_OPCODE} and @ref{4cd8,,PyTrace_EXCEPTION}.

Consulte también la función @ref{153f,,sys.setprofile()}.

La persona que llama debe mantener el @ref{2c5,,GIL}.
@end deffn

@geindex PyEval_SetProfileAllThreads (C function)
@anchor{c-api/init c PyEval_SetProfileAllThreads}@anchor{602}
@deffn {C Función} void PyEval_SetProfileAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{153d,,PyEval_SetProfile()} but sets the profile function in all running threads
belonging to the current interpreter instead of the setting it only on the current thread.

La persona que llama debe mantener el @ref{2c5,,GIL}.

As @ref{153d,,PyEval_SetProfile()}, this function ignores any exceptions raised while
setting the profile functions in all threads.
@end deffn


Added in version 3.12.


@geindex PyEval_SetTrace (C function)
@anchor{c-api/init c PyEval_SetTrace}@anchor{153e}
@deffn {C Función} void PyEval_SetTrace (Py_tracefunc func, PyObject *obj)

Set the tracing function to `func'.  This is similar to
@ref{153d,,PyEval_SetProfile()}, except the tracing function does receive line-number
events and per-opcode events, but does not receive any event related to C function
objects being called.  Any trace function registered using @ref{153e,,PyEval_SetTrace()}
will not receive @ref{4cdb,,PyTrace_C_CALL}, @ref{4cdc,,PyTrace_C_EXCEPTION} or
@ref{4cdd,,PyTrace_C_RETURN} as a value for the `what' parameter.

Consulte también la función @ref{1540,,sys.settrace()}.

La persona que llama debe mantener el @ref{2c5,,GIL}.
@end deffn

@geindex PyEval_SetTraceAllThreads (C function)
@anchor{c-api/init c PyEval_SetTraceAllThreads}@anchor{603}
@deffn {C Función} void PyEval_SetTraceAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{153e,,PyEval_SetTrace()} but sets the tracing function in all running threads
belonging to the current interpreter instead of the setting it only on the current thread.

La persona que llama debe mantener el @ref{2c5,,GIL}.

As @ref{153e,,PyEval_SetTrace()}, this function ignores any exceptions raised while
setting the trace functions in all threads.
@end deffn


Added in version 3.12.


@node Reference tracing,Soporte avanzado del depurador,Perfilado y Rastreo,Inicialización finalización e hilos
@anchor{c-api/init reference-tracing}@anchor{4cdf}
@subsection Reference tracing



Added in version 3.13.


@geindex PyRefTracer (C type)
@anchor{c-api/init c PyRefTracer}@anchor{4ce0}
@deffn {C Tipo} typedef int (*PyRefTracer)(@ref{42d,,PyObject}*, int event, void *data)

The type of the trace function registered using @ref{460,,PyRefTracer_SetTracer()}.
The first parameter is a Python object that has been just created (when `event'
is set to @ref{4ce1,,PyRefTracer_CREATE}) or about to be destroyed (when `event'
is set to @ref{4ce2,,PyRefTracer_DESTROY}). The `data' argument is the opaque pointer
that was provided when @ref{460,,PyRefTracer_SetTracer()} was called.
@end deffn


Added in version 3.13.


@geindex PyRefTracer_CREATE (C var)
@anchor{c-api/init c PyRefTracer_CREATE}@anchor{4ce1}
@deffn {C Variable} int PyRefTracer_CREATE

The value for the `event' parameter to @ref{4ce0,,PyRefTracer} functions when a Python
object has been created.
@end deffn

@geindex PyRefTracer_DESTROY (C var)
@anchor{c-api/init c PyRefTracer_DESTROY}@anchor{4ce2}
@deffn {C Variable} int PyRefTracer_DESTROY

The value for the `event' parameter to @ref{4ce0,,PyRefTracer} functions when a Python
object has been destroyed.
@end deffn

@geindex PyRefTracer_SetTracer (C function)
@anchor{c-api/init c PyRefTracer_SetTracer}@anchor{460}
@deffn {C Función} int PyRefTracer_SetTracer (PyRefTracer tracer, void *data)

Register a reference tracer function. The function will be called when a new
Python has been created or when an object is going to be destroyed. If
`data' is provided it must be an opaque pointer that will be provided when
the tracer function is called. Return @code{0} on success. Set an exception and
return @code{-1} on error.

Not that tracer functions `must not' create Python objects inside or
otherwise the call will be re-entrant. The tracer also `must not' clear
any existing exception or set an exception.  The GIL will be held every time
the tracer function is called.

The GIL must be held when calling this function.
@end deffn


Added in version 3.13.


@geindex PyRefTracer_GetTracer (C function)
@anchor{c-api/init c PyRefTracer_GetTracer}@anchor{461}
@deffn {C Función} @ref{4ce0,,PyRefTracer} PyRefTracer_GetTracer (void **data)

Get the registered reference tracer function and the value of the opaque data
pointer that was registered when @ref{460,,PyRefTracer_SetTracer()} was called.
If no tracer was registered this function will return NULL and will set the
`data' pointer to NULL.

The GIL must be held when calling this function.
@end deffn


Added in version 3.13.


@node Soporte avanzado del depurador,Soporte de almacenamiento local de hilo,Reference tracing,Inicialización finalización e hilos
@anchor{c-api/init advanced-debugger-support}@anchor{4ce3}@anchor{c-api/init advanced-debugging}@anchor{4ce4}
@subsection Soporte avanzado del depurador


Estas funciones solo están destinadas a ser utilizadas por herramientas de depuración avanzadas.

@geindex PyInterpreterState_Head (C function)
@anchor{c-api/init c PyInterpreterState_Head}@anchor{1541}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyInterpreterState_Head ()

Retorna el objeto de estado del intérprete al principio de la lista de todos esos objetos.
@end deffn

@geindex PyInterpreterState_Main (C function)
@anchor{c-api/init c PyInterpreterState_Main}@anchor{4cc7}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyInterpreterState_Main ()

Retorna el objeto de estado del intérprete principal.
@end deffn

@geindex PyInterpreterState_Next (C function)
@anchor{c-api/init c PyInterpreterState_Next}@anchor{1542}
@deffn {C Función} @ref{954,,PyInterpreterState} *PyInterpreterState_Next (PyInterpreterState *interp)

Retorna el siguiente objeto de estado de intérprete después de `interp' de la lista de todos esos objetos.
@end deffn

@geindex PyInterpreterState_ThreadHead (C function)
@anchor{c-api/init c PyInterpreterState_ThreadHead}@anchor{1543}
@deffn {C Función} @ref{826,,PyThreadState} *PyInterpreterState_ThreadHead (PyInterpreterState *interp)

Retorna el puntero al primer objeto @ref{826,,PyThreadState} en la lista de hilos asociados con el intérprete `interp'.
@end deffn

@geindex PyThreadState_Next (C function)
@anchor{c-api/init c PyThreadState_Next}@anchor{1544}
@deffn {C Función} @ref{826,,PyThreadState} *PyThreadState_Next (PyThreadState *tstate)

Retorna el siguiente objeto de estado del hilo después de `tstate' de la lista de todos los objetos que pertenecen al mismo objeto @ref{954,,PyInterpreterState}.
@end deffn

@node Soporte de almacenamiento local de hilo,Synchronization Primitives,Soporte avanzado del depurador,Inicialización finalización e hilos
@anchor{c-api/init thread-local-storage}@anchor{4ce5}@anchor{c-api/init thread-local-storage-support}@anchor{4ce6}
@subsection Soporte de almacenamiento local de hilo


El intérprete de Python proporciona soporte de bajo nivel para el almacenamiento local de hilos (TLS) que envuelve la implementación de TLS nativa subyacente para admitir la API de almacenamiento local de hilos de nivel Python (@ref{1773,,threading.local}). Las APIs de nivel CPython C son similares a las ofrecidas por pthreads y Windows: use una clave de hilo y funciones para asociar un valor de void* por hilo.

El GIL `no' necesita ser retenido al llamar a estas funciones; proporcionan su propio bloqueo.

Tenga en cuenta que @code{Python.h} no incluye la declaración de las API de TLS, debe incluir @code{pythread.h} para usar el almacenamiento local de hilos.

@cartouche
@quotation Nota 
Ninguna de estas funciones API maneja la administración de memoria en nombre de los valores void*. Debe asignarlos y desasignarlos usted mismo. Si los valores void* son @ref{42d,,PyObject}*, estas funciones tampoco realizan operaciones de conteo de referencias en ellos.
@end quotation
@end cartouche

@menu
* API de almacenamiento específico de hilo (TSS@comma{} Thread Specific Storage): API de almacenamiento específico de hilo TSS Thread Specific Storage. 
* API de almacenamiento local de hilos (TLS@comma{} Thread Local Storage): API de almacenamiento local de hilos TLS Thread Local Storage. 

@end menu

@node API de almacenamiento específico de hilo TSS Thread Specific Storage,API de almacenamiento local de hilos TLS Thread Local Storage,,Soporte de almacenamiento local de hilo
@anchor{c-api/init thread-specific-storage-api}@anchor{b69}@anchor{c-api/init thread-specific-storage-tss-api}@anchor{4ce7}
@subsubsection API de almacenamiento específico de hilo (TSS, `Thread Specific Storage')


La API de TSS se introduce para reemplazar el uso de la API TLS existente dentro del intérprete de CPython. Esta API utiliza un nuevo tipo @ref{b6a,,Py_tss_t} en lugar de int para representar las claves del hilo.


Added in version 3.7.



@subsubheading Ver también


«Una nueva C-API para `Thread-Local Storage' en CPython» (
@geindex Python Enhancement Proposals; PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/})


@geindex Py_tss_t (C type)
@anchor{c-api/init c Py_tss_t}@anchor{b6a}
@deffn {C Tipo} type Py_tss_t

Esta estructura de datos representa el estado de una clave del hilo, cuya definición puede depender de la implementación de TLS subyacente, y tiene un campo interno que representa el estado de inicialización de la clave. No hay miembros públicos en esta estructura.

Cuando @ref{5f6,,Py_LIMITED_API} no está definido, la asignación estática de este tipo por @ref{4ce8,,Py_tss_NEEDS_INIT} está permitida.
@end deffn

@geindex Py_tss_NEEDS_INIT (C macro)
@anchor{c-api/init c Py_tss_NEEDS_INIT}@anchor{4ce8}
@deffn {C Macro} Py_tss_NEEDS_INIT

Esta macro se expande al inicializador para variables @ref{b6a,,Py_tss_t}. Tenga en cuenta que esta macro no se definirá con @ref{5f6,,Py_LIMITED_API}.
@end deffn

@menu
* Asignación dinámica:: 
* Métodos: Métodos<2>. 

@end menu

@node Asignación dinámica,Métodos<2>,,API de almacenamiento específico de hilo TSS Thread Specific Storage
@anchor{c-api/init dynamic-allocation}@anchor{4ce9}
@subsubsection Asignación dinámica


Asignación dinámica de @ref{b6a,,Py_tss_t}, requerida en los módulos de extensión construidos con @ref{5f6,,Py_LIMITED_API}, donde la asignación estática de este tipo no es posible debido a que su implementación es opaca en el momento de la compilación.

@geindex PyThread_tss_alloc (C function)
@anchor{c-api/init c PyThread_tss_alloc}@anchor{29c}
@deffn {C Función} @ref{b6a,,Py_tss_t} *PyThread_tss_alloc ()
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna un valor que es el mismo estado que un valor inicializado con @ref{4ce8,,Py_tss_NEEDS_INIT}, o @code{NULL} en caso de falla de asignación dinámica.
@end deffn

@geindex PyThread_tss_free (C function)
@anchor{c-api/init c PyThread_tss_free}@anchor{29e}
@deffn {C Función} void PyThread_tss_free (Py_tss_t *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Libera la `clave' asignada por @ref{29c,,PyThread_tss_alloc()}, después de llamar por primera vez @ref{2a4,,PyThread_tss_delete()} para asegurarse de que los hilos locales asociados no hayan sido asignados. Esto es un no-op si el argumento `clave' es @code{NULL}.

@cartouche
@quotation Nota 
Una clave liberada se convierte en un puntero colgante. Debería restablecer la clave a @code{NULL}.
@end quotation
@end cartouche
@end deffn

@node Métodos<2>,,Asignación dinámica,API de almacenamiento específico de hilo TSS Thread Specific Storage
@anchor{c-api/init methods}@anchor{4cea}
@subsubsection Métodos


El parámetro `key' de estas funciones no debe ser @code{NULL}. Además, los comportamientos de @ref{2a0,,PyThread_tss_set()} y @ref{2a2,,PyThread_tss_get()} no están definidos si el @ref{b6a,,Py_tss_t} dado no ha sido inicializado por @ref{49c6,,PyThread_tss_create()}.

@geindex PyThread_tss_is_created (C function)
@anchor{c-api/init c PyThread_tss_is_created}@anchor{49c7}
@deffn {C Función} int PyThread_tss_is_created (Py_tss_t *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna un valor distinto de cero si @ref{b6a,,Py_tss_t} ha sido inicializado por @ref{49c6,,PyThread_tss_create()}.
@end deffn

@geindex PyThread_tss_create (C function)
@anchor{c-api/init c PyThread_tss_create}@anchor{49c6}
@deffn {C Función} int PyThread_tss_create (Py_tss_t *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna un valor cero en la inicialización exitosa de una clave TSS. El comportamiento no está definido si el valor señalado por el argumento `key' no se inicializa con @ref{4ce8,,Py_tss_NEEDS_INIT}. Esta función se puede invocar repetidamente en la misma tecla: llamarla a una tecla ya inicializada es un `no-op' e inmediatamente retorna el éxito.
@end deffn

@geindex PyThread_tss_delete (C function)
@anchor{c-api/init c PyThread_tss_delete}@anchor{2a4}
@deffn {C Función} void PyThread_tss_delete (Py_tss_t *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Destruye una clave TSS para olvidar los valores asociados con la clave en todos los hilos y cambie el estado de inicialización de la clave a no inicializado. Una clave destruida se puede inicializar nuevamente mediante @ref{49c6,,PyThread_tss_create()}. Esta función se puede invocar repetidamente en la misma llave; llamarla en una llave ya destruida es un `no-op'.
@end deffn

@geindex PyThread_tss_set (C function)
@anchor{c-api/init c PyThread_tss_set}@anchor{2a0}
@deffn {C Función} int PyThread_tss_set (Py_tss_t *key, void *value)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna un valor cero para indicar la asociación exitosa de un valor a void* con una clave TSS en el hilo actual. Cada hilo tiene un mapeo distinto de la clave a un valor void*.
@end deffn

@geindex PyThread_tss_get (C function)
@anchor{c-api/init c PyThread_tss_get}@anchor{2a2}
@deffn {C Función} void *PyThread_tss_get (Py_tss_t *key)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Retorna el valor void* asociado con una clave TSS en el hilo actual. Esto retorna @code{NULL} si no hay ningún valor asociado con la clave en el hilo actual.
@end deffn

@node API de almacenamiento local de hilos TLS Thread Local Storage,,API de almacenamiento específico de hilo TSS Thread Specific Storage,Soporte de almacenamiento local de hilo
@anchor{c-api/init thread-local-storage-api}@anchor{b68}@anchor{c-api/init thread-local-storage-tls-api}@anchor{4ceb}
@subsubsection API de almacenamiento local de hilos (TLS, `Thread Local Storage')



Obsoleto desde la versión 3.7: Esta API es reemplazada por @ref{b69,,API de Almacenamiento Específico de Hilos (TSS@comma{} por sus significado en inglés *Thread Specific Storage*)}.


@cartouche
@quotation Nota 
Esta versión de la API no es compatible con plataformas donde la clave TLS nativa se define de una manera que no se puede transmitir de forma segura a @code{int}. En tales plataformas, @ref{29b,,PyThread_create_key()} regresará inmediatamente con un estado de falla, y las otras funciones TLS serán no operativas en tales plataformas.
@end quotation
@end cartouche

Debido al problema de compatibilidad mencionado anteriormente, esta versión de la API no debe usarse en código nuevo.

@geindex PyThread_create_key (C function)
@anchor{c-api/init c PyThread_create_key}@anchor{29b}
@deffn {C Función} int PyThread_create_key ()
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyThread_delete_key (C function)
@anchor{c-api/init c PyThread_delete_key}@anchor{29d}
@deffn {C Función} void PyThread_delete_key (int key)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyThread_set_key_value (C function)
@anchor{c-api/init c PyThread_set_key_value}@anchor{29f}
@deffn {C Función} int PyThread_set_key_value (int key, void *value)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyThread_get_key_value (C function)
@anchor{c-api/init c PyThread_get_key_value}@anchor{2a1}
@deffn {C Función} void *PyThread_get_key_value (int key)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyThread_delete_key_value (C function)
@anchor{c-api/init c PyThread_delete_key_value}@anchor{2a3}
@deffn {C Función} void PyThread_delete_key_value (int key)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex PyThread_ReInitTLS (C function)
@anchor{c-api/init c PyThread_ReInitTLS}@anchor{2a5}
@deffn {C Función} void PyThread_ReInitTLS ()
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@node Synchronization Primitives,,Soporte de almacenamiento local de hilo,Inicialización finalización e hilos
@anchor{c-api/init synchronization-primitives}@anchor{4cec}
@subsection Synchronization Primitives


The C-API provides a basic mutual exclusion lock.

@geindex PyMutex (C type)
@anchor{c-api/init c PyMutex}@anchor{2c7}
@deffn {C Tipo} type PyMutex

A mutual exclusion lock.  The @code{PyMutex} should be initialized to
zero to represent the unlocked state.  For example:

@example
PyMutex mutex = @{0@};
@end example

Instances of @code{PyMutex} should not be copied or moved.  Both the
contents and address of a @code{PyMutex} are meaningful, and it must
remain at a fixed, writable location in memory.

@cartouche
@quotation Nota 
A @code{PyMutex} currently occupies one byte, but the size should be
considered unstable.  The size may change in future Python releases
without a deprecation period.
@end quotation
@end cartouche


Added in version 3.13.

@end deffn

@geindex PyMutex_Lock (C function)
@anchor{c-api/init c PyMutex_Lock}@anchor{41e}
@deffn {C Función} void PyMutex_Lock (PyMutex *m)

Lock mutex `m'.  If another thread has already locked it, the calling
thread will block until the mutex is unlocked.  While blocked, the thread
will temporarily release the @ref{2c5,,GIL} if it is held.


Added in version 3.13.

@end deffn

@geindex PyMutex_Unlock (C function)
@anchor{c-api/init c PyMutex_Unlock}@anchor{41f}
@deffn {C Función} void PyMutex_Unlock (PyMutex *m)

Unlock mutex `m'. The mutex must be locked — otherwise, the function will
issue a fatal error.


Added in version 3.13.

@end deffn

@menu
* Python Critical Section API:: 

@end menu

@node Python Critical Section API,,,Synchronization Primitives
@anchor{c-api/init id3}@anchor{4ced}@anchor{c-api/init python-critical-section-api}@anchor{4cee}
@subsubsection Python Critical Section API


The critical section API provides a deadlock avoidance layer on top of
per-object locks for @ref{43ec,,free-threaded} CPython.  They are
intended to replace reliance on the @ref{2b5,,global interpreter lock}, and are
no-ops in versions of Python with the global interpreter lock.

Critical sections avoid deadlocks by implicitly suspending active critical
sections and releasing the locks during calls to @ref{49b,,PyEval_SaveThread()}.
When @ref{49c,,PyEval_RestoreThread()} is called, the most recent critical section
is resumed, and its locks reacquired.  This means the critical section API
provides weaker guarantees than traditional locks – they are useful because
their behavior is similar to the @ref{2c5,,GIL}.

The functions and structs used by the macros are exposed for cases
where C macros are not available. They should only be used as in the
given macro expansions. Note that the sizes and contents of the structures may
change in future Python versions.

@cartouche
@quotation Nota 
Operations that need to lock two objects at once must use
@ref{4cef,,Py_BEGIN_CRITICAL_SECTION2}.  You `cannot' use nested critical
sections to lock more than one object at once, because the inner critical
section may suspend the outer critical sections.  This API does not provide
a way to lock more than two objects at once.
@end quotation
@end cartouche

Example usage:

@example
static PyObject *
set_field(MyObject *self, PyObject *value)
@{
   Py_BEGIN_CRITICAL_SECTION(self);
   Py_SETREF(self->field, Py_XNewRef(value));
   Py_END_CRITICAL_SECTION();
   Py_RETURN_NONE;
@}
@end example

In the above example, @ref{61d,,Py_SETREF} calls @ref{613,,Py_DECREF}, which
can call arbitrary code through an object’s deallocation function.  The critical
section API avoids potential deadlocks due to reentrancy and lock ordering
by allowing the runtime to temporarily suspend the critical section if the
code triggered by the finalizer blocks and calls @ref{49b,,PyEval_SaveThread()}.

@geindex Py_BEGIN_CRITICAL_SECTION (C macro)
@anchor{c-api/init c Py_BEGIN_CRITICAL_SECTION}@anchor{4bc4}
@deffn {C Macro} Py_BEGIN_CRITICAL_SECTION (op)

Acquires the per-object lock for the object `op' and begins a
critical section.

In the free-threaded build, this macro expands to:

@example
@{
    PyCriticalSection _py_cs;
    PyCriticalSection_Begin(&_py_cs, (PyObject*)(op))
@end example

In the default build, this macro expands to @code{@{}.


Added in version 3.13.

@end deffn

@geindex Py_END_CRITICAL_SECTION (C macro)
@anchor{c-api/init c Py_END_CRITICAL_SECTION}@anchor{4cf0}
@deffn {C Macro} Py_END_CRITICAL_SECTION ()

Ends the critical section and releases the per-object lock.

In the free-threaded build, this macro expands to:

@example
    PyCriticalSection_End(&_py_cs);
@}
@end example

In the default build, this macro expands to @code{@}}.


Added in version 3.13.

@end deffn

@geindex Py_BEGIN_CRITICAL_SECTION2 (C macro)
@anchor{c-api/init c Py_BEGIN_CRITICAL_SECTION2}@anchor{4cef}
@deffn {C Macro} Py_BEGIN_CRITICAL_SECTION2 (a, b)

Acquires the per-objects locks for the objects `a' and `b' and begins a
critical section.  The locks are acquired in a consistent order (lowest
address first) to avoid lock ordering deadlocks.

In the free-threaded build, this macro expands to:

@example
@{
    PyCriticalSection2 _py_cs2;
    PyCriticalSection_Begin2(&_py_cs2, (PyObject*)(a), (PyObject*)(b))
@end example

In the default build, this macro expands to @code{@{}.


Added in version 3.13.

@end deffn

@geindex Py_END_CRITICAL_SECTION2 (C macro)
@anchor{c-api/init c Py_END_CRITICAL_SECTION2}@anchor{4cf1}
@deffn {C Macro} Py_END_CRITICAL_SECTION2 ()

Ends the critical section and releases the per-object locks.

In the free-threaded build, this macro expands to:

@example
    PyCriticalSection_End2(&_py_cs2);
@}
@end example

In the default build, this macro expands to @code{@}}.


Added in version 3.13.

@end deffn

@node Configuración de inicialización de Python,Gestión de la memoria,Inicialización finalización e hilos,Manual de referencia de la API en C de Python
@anchor{c-api/init_config doc}@anchor{4cf2}@anchor{c-api/init_config init-config}@anchor{49a}@anchor{c-api/init_config python-initialization-configuration}@anchor{4cf3}
@section Configuración de inicialización de Python


@menu
* PyConfig C API:: 
* PyInitConfig C API:: 
* Runtime Python configuration API:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* API Provisional Privada de Inicialización Multifásica:: 

@end menu

@node PyConfig C API,PyInitConfig C API,,Configuración de inicialización de Python
@anchor{c-api/init_config pyconfig-c-api}@anchor{4cf4}
@subsection PyConfig C API



Added in version 3.8.


Python se puede inicializar con @ref{4a6,,Py_InitializeFromConfig()} y la estructura @ref{499,,PyConfig}. Se puede preinicializar con @ref{4cc,,Py_PreInitialize()} y la estructura @ref{a3e,,PyPreConfig}.

Hay dos tipos de configuración:


@itemize *

@item 
The @ref{4cb8,,Python Configuration} can be used to build a
customized Python which behaves as the regular Python. For example,
environment variables and command line arguments are used to configure
Python.

@item 
The @ref{4cf5,,Isolated Configuration} can be used to embed
Python into an application. It isolates Python from the system. For example,
environment variables are ignored, the LC_CTYPE locale is left unchanged and
no signal handler is registered.
@end itemize

La función @ref{a57,,Py_RunMain()} se puede utilizar para escribir un programa Python personalizado.

Consulte también @ref{4cab,,Inicialización@comma{} finalización y subprocesos}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} «Configuración de inicialización de Python».


@menu
* Ejemplo: Ejemplo<16>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* Preinicialización de Python con PyPreConfig:: 
* PyConfig:: 
* Inicialización con PyConfig:: 
* Configuración aislada:: 
* Configuración de Python: Configuración de Python<2>. 
* Configuración de la ruta de Python:: 

@end menu

@node Ejemplo<16>,PyWideStringList,,PyConfig C API
@anchor{c-api/init_config example}@anchor{4cf6}
@subsubsection Ejemplo


Ejemplo de Python personalizado que siempre se ejecuta en modo aislado:

@example
int main(int argc, char **argv)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);
    config.isolated = 1;

    /* Decode command line arguments.
       Implicitly preinitialize Python (in isolated mode). */
    status = PyConfig_SetBytesArgv(&config, argc, argv);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    return Py_RunMain();

exception:
    PyConfig_Clear(&config);
    if (PyStatus_IsExit(status)) @{
        return status.exitcode;
    @}
    /* Display the error message and exit the process with
       non-zero exit code */
    Py_ExitStatusException(status);
@}
@end example

@node PyWideStringList,PyStatus,Ejemplo<16>,PyConfig C API
@anchor{c-api/init_config pywidestringlist}@anchor{4cf7}
@subsubsection PyWideStringList


@geindex PyWideStringList (C type)
@anchor{c-api/init_config c PyWideStringList}@anchor{a40}
@deffn {C Tipo} type PyWideStringList

Lista de cadenas de caracteres @code{wchar_t*}.

Si `length' no es cero, `items' no deben ser @code{NULL} y todas las cadenas de caracteres deben ser no @code{NULL}.

Métodos:

@geindex PyWideStringList_Append (C function)
@anchor{c-api/init_config c PyWideStringList_Append}@anchor{a51}
@deffn {C Función} @ref{a3f,,PyStatus} PyWideStringList_Append (PyWideStringList *list, const wchar_t *item)

Agregar `item' a `list'.

Python debe estar preinicializado para llamar a esta función.
@end deffn

@geindex PyWideStringList_Insert (C function)
@anchor{c-api/init_config c PyWideStringList_Insert}@anchor{a52}
@deffn {C Función} @ref{a3f,,PyStatus} PyWideStringList_Insert (PyWideStringList *list, Py_ssize_t index, const wchar_t *item)

Inserta `item' en `list' en `index'.

Si `index' es mayor o igual que el largo de `list', agrega `item' a `list'.

`index' must be greater than or equal to @code{0}.

Python debe estar preinicializado para llamar a esta función.
@end deffn

Campos de estructura:

@geindex PyWideStringList.length (C member)
@anchor{c-api/init_config c PyWideStringList length}@anchor{4cf8}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} length

Longitud de la lista.
@end deffn

@geindex PyWideStringList.items (C member)
@anchor{c-api/init_config c PyWideStringList items}@anchor{4cf9}
@deffn {C Miembro} wchar_t **items

Elementos de la lista.
@end deffn
@end deffn

@node PyStatus,PyPreConfig,PyWideStringList,PyConfig C API
@anchor{c-api/init_config pystatus}@anchor{4cfa}
@subsubsection PyStatus


@geindex PyStatus (C type)
@anchor{c-api/init_config c PyStatus}@anchor{a3f}
@deffn {C Tipo} type PyStatus

Estructura para almacenar el estado de una función de inicialización: éxito, error o salida.

Para un error, puede almacenar el nombre de la función C que creó el error.

Campos de estructura:

@geindex PyStatus.exitcode (C member)
@anchor{c-api/init_config c PyStatus exitcode}@anchor{4cfb}
@deffn {C Miembro} int exitcode

Código de salida El argumento pasó a @code{exit()}.
@end deffn

@geindex PyStatus.err_msg (C member)
@anchor{c-api/init_config c PyStatus err_msg}@anchor{4cfc}
@deffn {C Miembro} const char *err_msg

Mensaje de error.
@end deffn

@geindex PyStatus.func (C member)
@anchor{c-api/init_config c PyStatus func}@anchor{4cfd}
@deffn {C Miembro} const char *func

El nombre de la función que creó un error puede ser @code{NULL}.
@end deffn

Funciones para crear un estado:

@geindex PyStatus_Ok (C function)
@anchor{c-api/init_config c PyStatus_Ok}@anchor{a50}
@deffn {C Función} @ref{a3f,,PyStatus} PyStatus_Ok (void)

Éxito.
@end deffn

@geindex PyStatus_Error (C function)
@anchor{c-api/init_config c PyStatus_Error}@anchor{a4a}
@deffn {C Función} @ref{a3f,,PyStatus} PyStatus_Error (const char *err_msg)

Error de inicialización con un mensaje.

`err_msg' no debe ser @code{NULL}.
@end deffn

@geindex PyStatus_NoMemory (C function)
@anchor{c-api/init_config c PyStatus_NoMemory}@anchor{a4f}
@deffn {C Función} @ref{a3f,,PyStatus} PyStatus_NoMemory (void)

Error de asignación de memoria (sin memoria).
@end deffn

@geindex PyStatus_Exit (C function)
@anchor{c-api/init_config c PyStatus_Exit}@anchor{a4c}
@deffn {C Función} @ref{a3f,,PyStatus} PyStatus_Exit (int exitcode)

Sale de Python con el código de salida especificado.
@end deffn

Funciones para manejar un estado:

@geindex PyStatus_Exception (C function)
@anchor{c-api/init_config c PyStatus_Exception}@anchor{a4b}
@deffn {C Función} int PyStatus_Exception (PyStatus status)

¿Es el estado un error o una salida? Si es verdadero, la excepción debe ser manejada; por ejemplo llamando a @ref{a54,,Py_ExitStatusException()}.
@end deffn

@geindex PyStatus_IsError (C function)
@anchor{c-api/init_config c PyStatus_IsError}@anchor{a4d}
@deffn {C Función} int PyStatus_IsError (PyStatus status)

¿Es el resultado un error?
@end deffn

@geindex PyStatus_IsExit (C function)
@anchor{c-api/init_config c PyStatus_IsExit}@anchor{a4e}
@deffn {C Función} int PyStatus_IsExit (PyStatus status)

¿El resultado es una salida?
@end deffn

@geindex Py_ExitStatusException (C function)
@anchor{c-api/init_config c Py_ExitStatusException}@anchor{a54}
@deffn {C Función} void Py_ExitStatusException (PyStatus status)

Llama a @code{exit(exitcode)} si `status' es una salida. Imprime el mensaje de error y sale con un código de salida distinto de cero si `status' es un error. Solo se debe llamar si @code{PyStatus_Exception(status)} no es cero.
@end deffn
@end deffn

@cartouche
@quotation Nota 
Internamente, Python usa macros que establecen @code{PyStatus.func}, mientras que las funciones para crear un estado establecen @code{func} en @code{NULL}.
@end quotation
@end cartouche

Ejemplo:

@example
PyStatus alloc(void **ptr, size_t size)
@{
    *ptr = PyMem_RawMalloc(size);
    if (*ptr == NULL) @{
        return PyStatus_NoMemory();
    @}
    return PyStatus_Ok();
@}

int main(int argc, char **argv)
@{
    void *ptr;
    PyStatus status = alloc(&ptr, 16);
    if (PyStatus_Exception(status)) @{
        Py_ExitStatusException(status);
    @}
    PyMem_Free(ptr);
    return 0;
@}
@end example

@node PyPreConfig,Preinicialización de Python con PyPreConfig,PyStatus,PyConfig C API
@anchor{c-api/init_config pypreconfig}@anchor{4cfe}
@subsubsection PyPreConfig


@geindex PyPreConfig (C type)
@anchor{c-api/init_config c PyPreConfig}@anchor{a3e}
@deffn {C Tipo} type PyPreConfig

Estructura utilizada para preinicializar Python.

Función para inicializar una preconfiguración:

@geindex PyPreConfig_InitPythonConfig (C function)
@anchor{c-api/init_config c PyPreConfig_InitPythonConfig}@anchor{a49}
@deffn {C Función} void PyPreConfig_InitPythonConfig (PyPreConfig *preconfig)

Inicializa la preconfiguración con @ref{4cb8,,Configuración de Python}.
@end deffn

@geindex PyPreConfig_InitIsolatedConfig (C function)
@anchor{c-api/init_config c PyPreConfig_InitIsolatedConfig}@anchor{a48}
@deffn {C Función} void PyPreConfig_InitIsolatedConfig (PyPreConfig *preconfig)

Inicializa la preconfiguración con @ref{4cf5,,Configuración aislada}.
@end deffn

Campos de estructura:

@geindex PyPreConfig.allocator (C member)
@anchor{c-api/init_config c PyPreConfig allocator}@anchor{4cff}
@deffn {C Miembro} int allocator

Nombre de los asignadores de memoria de Python:


@itemize *

@item 
@code{PYMEM_ALLOCATOR_NOT_SET} (@code{0}): no cambia asignadores de memoria (usa los valores predeterminados)

@item 
@code{PYMEM_ALLOCATOR_DEFAULT} (@code{1}): @ref{1d56,,asignadores de memoria predeterminados}.

@item 
@code{PYMEM_ALLOCATOR_DEBUG} (@code{2}): @ref{1d56,,asignadores de memoria predeterminados} con @ref{1d59,,ganchos de depuración}.

@item 
@code{PYMEM_ALLOCATOR_MALLOC} (@code{3}): usa @code{malloc()} de la biblioteca C.

@item 
@code{PYMEM_ALLOCATOR_MALLOC_DEBUG} (@code{4}): fuerza el uso de @code{malloc()} con @ref{1d59,,ganchos de depuración}.

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC} (@code{5}): @ref{d96,,asignador de memoria pymalloc de Python}

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} (@code{6}): @ref{d96,,asignador de memoria pymalloc de Python} con @ref{1d59,,ganchos de depuración}.

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC} (@code{6}): use @code{mimalloc}, a fast
malloc replacement.

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} (@code{7}): use @code{mimalloc}, a fast
malloc replacement with @ref{1d59,,debug hooks}.
@end itemize

@code{PYMEM_ALLOCATOR_PYMALLOC} y @code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} no son compatibles si Python es @ref{1db3,,configurado usando --without-pymalloc}.

@code{PYMEM_ALLOCATOR_MIMALLOC} and @code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} are
not supported if Python is @ref{1db2,,configured using --without-mimalloc} or if the underlying atomic support isn’t
available.

Ver @ref{4d00,,Administración de memorias}.

Predeterminado: @code{PYMEM_ALLOCATOR_NOT_SET}.
@end deffn

@geindex PyPreConfig.configure_locale (C member)
@anchor{c-api/init_config c PyPreConfig configure_locale}@anchor{4d01}
@deffn {C Miembro} int configure_locale

Set the LC_CTYPE locale to the user preferred locale.

If equals to @code{0}, set @ref{4d02,,coerce_c_locale} and
@ref{4d03,,coerce_c_locale_warn} members to @code{0}.

Vea el @ref{39b,,locale encoding}.

Predeterminado: @code{1} en la configuración de Python, @code{0} en la configuración aislada.
@end deffn

@geindex PyPreConfig.coerce_c_locale (C member)
@anchor{c-api/init_config c PyPreConfig coerce_c_locale}@anchor{4d02}
@deffn {C Miembro} int coerce_c_locale

If equals to @code{2}, coerce the C locale.

If equals to @code{1}, read the LC_CTYPE locale to decide if it should be
coerced.

Vea el @ref{39b,,locale encoding}.

Predeterminado: @code{-1} en la configuración de Python, @code{0} en la configuración aislada.
@end deffn

@geindex PyPreConfig.coerce_c_locale_warn (C member)
@anchor{c-api/init_config c PyPreConfig coerce_c_locale_warn}@anchor{4d03}
@deffn {C Miembro} int coerce_c_locale_warn

Si no es cero, emita una advertencia si la configuración regional C está coaccionada.

Predeterminado: @code{-1} en la configuración de Python, @code{0} en la configuración aislada.
@end deffn

@geindex PyPreConfig.dev_mode (C member)
@anchor{c-api/init_config c PyPreConfig dev_mode}@anchor{4d04}
@deffn {C Miembro} int dev_mode

@ref{356,,Python Development Mode}: see
@ref{4d05,,PyConfig.dev_mode}.

Por defecto: @code{-1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyPreConfig.isolated (C member)
@anchor{c-api/init_config c PyPreConfig isolated}@anchor{4d06}
@deffn {C Miembro} int isolated

Modo aislado: consulte @ref{4c5,,PyConfig.isolated}.

Por defecto: @code{0} en modo Python, @code{1} en modo aislado.
@end deffn

@geindex PyPreConfig.legacy_windows_fs_encoding (C member)
@anchor{c-api/init_config c PyPreConfig legacy_windows_fs_encoding}@anchor{4c7}
@deffn {C Miembro} int legacy_windows_fs_encoding

Si no es cero:


@itemize *

@item 
Establezca @ref{4cb,,PyPreConfig.utf8_mode} en @code{0},

@item 
Establezca @ref{4c9,,PyConfig.filesystem_encoding} en @code{"mbcs"},

@item 
Establezca @ref{4ca,,PyConfig.filesystem_errors} en @code{"replace"}.
@end itemize

Initialized from the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment
variable value.

Solo disponible en Windows. La macro @code{#ifdef MS_WINDOWS} se puede usar para el código específico de Windows.

Predeterminado: @code{0}.
@end deffn

@geindex PyPreConfig.parse_argv (C member)
@anchor{c-api/init_config c PyPreConfig parse_argv}@anchor{4d07}
@deffn {C Miembro} int parse_argv

Si no es cero, @ref{a55,,Py_PreInitializeFromArgs()} y @ref{a56,,Py_PreInitializeFromBytesArgs()} analizan su argumento @code{argv} de la misma manera que Python analiza los argumentos de la línea de comandos: ver @ref{1083,,Argumentos de línea de comandos}.

Predeterminado: @code{1} en la configuración de Python, @code{0} en la configuración aislada.
@end deffn

@geindex PyPreConfig.use_environment (C member)
@anchor{c-api/init_config c PyPreConfig use_environment}@anchor{4d08}
@deffn {C Miembro} int use_environment

¿Utiliza @ref{691,,variables de entorno}? Consulte @ref{4ba,,PyConfig.use_environment}.

Predeterminado: @code{1} en la configuración de Python y @code{0} en la configuración aislada.
@end deffn

@geindex PyPreConfig.utf8_mode (C member)
@anchor{c-api/init_config c PyPreConfig utf8_mode}@anchor{4cb}
@deffn {C Miembro} int utf8_mode

Si es distinto de cero, habilite @ref{6f7,,Python UTF-8 Mode}.

Set to @code{0} or @code{1} by the @ref{2e2,,-X utf8} command line option
and the 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} environment variable.

También se pone a @code{1} si la configuración regional @code{LC_CTYPE} es @code{C} o @code{POSIX}.

Predeterminado: @code{-1} en la configuración de Python y @code{0} en la configuración aislada.
@end deffn
@end deffn

@node Preinicialización de Python con PyPreConfig,PyConfig,PyPreConfig,PyConfig C API
@anchor{c-api/init_config c-preinit}@anchor{3c68}@anchor{c-api/init_config preinitialize-python-with-pypreconfig}@anchor{4d09}
@subsubsection Preinicialización de Python con PyPreConfig


La preinicialización de Python:


@itemize *

@item 
Establecer los asignadores de memoria de Python (@ref{4cff,,PyPreConfig.allocator})

@item 
Configurar la configuración regional LC_CTYPE (@ref{39b,,locale encoding})

@item 
Establecer el @ref{6f7,,Python UTF-8 Mode} (@ref{4cb,,PyPreConfig.utf8_mode})
@end itemize

La preconfiguración actual (tipo @code{PyPreConfig}) se almacena en @code{_PyRuntime.preconfig}.

Funciones para preinicializar Python:

@geindex Py_PreInitialize (C function)
@anchor{c-api/init_config c Py_PreInitialize}@anchor{4cc}
@deffn {C Función} @ref{a3f,,PyStatus} Py_PreInitialize (const PyPreConfig *preconfig)

Preinicializa Python desde la preconfiguración `preconfig'.

`preconfig' no debe ser @code{NULL}.
@end deffn

@geindex Py_PreInitializeFromBytesArgs (C function)
@anchor{c-api/init_config c Py_PreInitializeFromBytesArgs}@anchor{a56}
@deffn {C Función} @ref{a3f,,PyStatus} Py_PreInitializeFromBytesArgs (const PyPreConfig *preconfig, int argc, char *const *argv)

Preinicializa Python desde la preconfiguración `preconfig'.

Analice los argumentos de la línea de comando `argv' (cadenas de bytes) si @ref{4d07,,parse_argv} de `preconfig' no es cero.

`preconfig' no debe ser @code{NULL}.
@end deffn

@geindex Py_PreInitializeFromArgs (C function)
@anchor{c-api/init_config c Py_PreInitializeFromArgs}@anchor{a55}
@deffn {C Función} @ref{a3f,,PyStatus} Py_PreInitializeFromArgs (const PyPreConfig *preconfig, int argc, wchar_t *const *argv)

Preinicializa Python desde la preconfiguración `preconfig'.

Analice los argumentos de la línea de comando `argv' (cadenas anchas) si @ref{4d07,,parse_argv} de `preconfig' no es cero.

`preconfig' no debe ser @code{NULL}.
@end deffn

La persona que llama es responsable de manejar las excepciones (error o salida) usando @ref{a4b,,PyStatus_Exception()} y @ref{a54,,Py_ExitStatusException()}.

Para @ref{4cb8,,Configuración de Python} (@ref{a49,,PyPreConfig_InitPythonConfig()}), si Python se inicializa con argumentos de línea de comando, los argumentos de la línea de comando también deben pasarse para preinicializar Python, ya que tienen un efecto en la preconfiguración como codificaciones. Por ejemplo, la opción de línea de comando @ref{2e2,,-X utf8} habilita el @ref{6f7,,Python UTF-8 Mode}.

@code{PyMem_SetAllocator()} se puede llamar después de @ref{4cc,,Py_PreInitialize()} y antes @ref{4a6,,Py_InitializeFromConfig()} para instalar un asignador de memoria personalizado. Se puede llamar antes @ref{4cc,,Py_PreInitialize()} si @ref{4cff,,PyPreConfig.allocator} está configurado en @code{PYMEM_ALLOCATOR_NOT_SET}.

Las funciones de asignación de memoria de Python como @ref{482,,PyMem_RawMalloc()} no deben usarse antes de la preinicialización de Python, mientras que llamar directamente a @code{malloc()} y @code{free()} siempre es seguro. No se debe llamar a @ref{c4f,,Py_DecodeLocale()} antes de la preinicialización de Python.

Ejemplo usando la preinicialización para habilitar el @ref{6f7,,Python UTF-8 Mode}

@example
PyStatus status;
PyPreConfig preconfig;
PyPreConfig_InitPythonConfig(&preconfig);

preconfig.utf8_mode = 1;

status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) @{
    Py_ExitStatusException(status);
@}

/* at this point, Python speaks UTF-8 */

Py_Initialize();
/* ... use Python API here ... */
Py_Finalize();
@end example

@node PyConfig,Inicialización con PyConfig,Preinicialización de Python con PyPreConfig,PyConfig C API
@anchor{c-api/init_config pyconfig}@anchor{4d0a}
@subsubsection PyConfig


@geindex PyConfig (C type)
@anchor{c-api/init_config c PyConfig}@anchor{499}
@deffn {C Tipo} type PyConfig

Estructura que contiene la mayoría de los parámetros para configurar Python.

Cuando termine, se debe utilizar la función @ref{a41,,PyConfig_Clear()} para liberar la memoria de configuración.

Métodos de estructura:

@geindex PyConfig_InitPythonConfig (C function)
@anchor{c-api/init_config c PyConfig_InitPythonConfig}@anchor{a43}
@deffn {C Función} void PyConfig_InitPythonConfig (PyConfig *config)

Inicialice la configuración con la @ref{4cb8,,Configuración de Python}.
@end deffn

@geindex PyConfig_InitIsolatedConfig (C function)
@anchor{c-api/init_config c PyConfig_InitIsolatedConfig}@anchor{a42}
@deffn {C Función} void PyConfig_InitIsolatedConfig (PyConfig *config)

Inicialice la configuración con la @ref{4cf5,,Configuración Aislada}.
@end deffn

@geindex PyConfig_SetString (C function)
@anchor{c-api/init_config c PyConfig_SetString}@anchor{a47}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_SetString (PyConfig *config, wchar_t *const *config_str, const wchar_t *str)

Copia la cadena de caracteres anchos `str' en @code{*config_str}.

@ref{3c68,,Preinicializa Python} si es necesario.
@end deffn

@geindex PyConfig_SetBytesString (C function)
@anchor{c-api/init_config c PyConfig_SetBytesString}@anchor{a46}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_SetBytesString (PyConfig *config, wchar_t *const *config_str, const char *str)

Decodifique `str' usando @ref{c4f,,Py_DecodeLocale()} y establezca el resultado en @code{*config_str}.

@ref{3c68,,Preinicializa Python} si es necesario.
@end deffn

@geindex PyConfig_SetArgv (C function)
@anchor{c-api/init_config c PyConfig_SetArgv}@anchor{a44}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_SetArgv (PyConfig *config, int argc, wchar_t *const *argv)

Configure los argumentos de la línea de comando (miembro @ref{4a4,,argv} de `config') de la lista `argv' de cadenas de caracteres anchas.

@ref{3c68,,Preinicializa Python} si es necesario.
@end deffn

@geindex PyConfig_SetBytesArgv (C function)
@anchor{c-api/init_config c PyConfig_SetBytesArgv}@anchor{a45}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_SetBytesArgv (PyConfig *config, int argc, char *const *argv)

Establezca argumentos de línea de comando (miembro @ref{4a4,,argv} de `config') de la lista `argv' de cadenas de bytes. Decodifica bytes usando @ref{c4f,,Py_DecodeLocale()}.

@ref{3c68,,Preinicializa Python} si es necesario.
@end deffn

@geindex PyConfig_SetWideStringList (C function)
@anchor{c-api/init_config c PyConfig_SetWideStringList}@anchor{19ee}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_SetWideStringList (PyConfig *config, PyWideStringList *list, Py_ssize_t length, wchar_t **items)

Establece la lista de cadenas de caracteres anchas `list' a `length' y `items'.

@ref{3c68,,Preinicializa Python} si es necesario.
@end deffn

@geindex PyConfig_Read (C function)
@anchor{c-api/init_config c PyConfig_Read}@anchor{829}
@deffn {C Función} @ref{a3f,,PyStatus} PyConfig_Read (PyConfig *config)

Lee toda la configuración de Python.

Los campos que ya están inicializados no se modifican.

Los campos para la @ref{944,,configuración de ruta} ya no se calculan ni modifican al llamar a esta función, a partir de Python 3.11.

The @ref{829,,PyConfig_Read()} function only parses
@ref{4a4,,PyConfig.argv} arguments once: @ref{1932,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
stripped from @ref{4a4,,PyConfig.argv}, parsing arguments twice would
parse the application options as Python options.

@ref{3c68,,Preinicializa Python} si es necesario.


Distinto en la versión 3.10: Los argumentos @ref{4a4,,PyConfig.argv} ahora solo se analizan una vez, @ref{1932,,PyConfig.parse_argv} se establece en @code{2} después de analizar los argumentos y los argumentos solo se analizan si @ref{1932,,PyConfig.parse_argv} es igual a @code{1}.



Distinto en la versión 3.11: @ref{829,,PyConfig_Read()} ya no calcula todas las rutas, por lo que los campos listados en @ref{944,,Python Path Configuration} ya no pueden ser actualizados hasta que se llame a @ref{4a6,,Py_InitializeFromConfig()}.

@end deffn

@geindex PyConfig_Clear (C function)
@anchor{c-api/init_config c PyConfig_Clear}@anchor{a41}
@deffn {C Función} void PyConfig_Clear (PyConfig *config)

Libera memoria de configuración.
@end deffn

La mayoría de los método @code{PyConfig} @ref{3c68,,preinitializan Python} si es necesario. En ese caso, la configuración de preinicialización de Python (@ref{a3e,,PyPreConfig}) se basa en @ref{499,,PyConfig}. Si se ajustan los campos de configuración que son comunes con @ref{a3e,,PyPreConfig}, deben establecerse antes de llamar a un método @ref{499,,PyConfig}:


@itemize *

@item 
@ref{4d05,,PyConfig.dev_mode}

@item 
@ref{4c5,,PyConfig.isolated}

@item 
@ref{1932,,PyConfig.parse_argv}

@item 
@ref{4ba,,PyConfig.use_environment}
@end itemize

Moreover, if @ref{a44,,PyConfig_SetArgv()} or @ref{a45,,PyConfig_SetBytesArgv()}
is used, this method must be called before other methods, since the
preinitialization configuration depends on command line arguments (if
@ref{1932,,parse_argv} is non-zero).

Quien llama de estos métodos es responsable de manejar las excepciones (error o salida) usando @code{PyStatus_Exception()} y @code{Py_ExitStatusException()}.

Campos de estructura:

@geindex PyConfig.argv (C member)
@anchor{c-api/init_config c PyConfig argv}@anchor{4a4}
@deffn {C Miembro} @ref{a40,,PyWideStringList} argv

@geindex main()
@geindex argv (in module sys)

Set @ref{12d2,,sys.argv} command line arguments based on
@ref{4a4,,argv}.  These parameters are similar to those passed
to the program’s @code{main()} function with the difference that the
first entry should refer to the script file to be executed rather than
the executable hosting the Python interpreter.  If there isn’t a script
that will be run, the first entry in @ref{4a4,,argv} can be an
empty string.

Configure @ref{1932,,parse_argv} en @code{1} para analizar @ref{4a4,,argv} de la misma manera que Python normal analiza los argumentos de la línea de comandos de Python y luego quita los argumentos de Python de @ref{4a4,,argv}.

Si @ref{4a4,,argv} está vacío, se agrega una cadena vacía para garantizar que @ref{12d2,,sys.argv} siempre exista y nunca esté vacío.

Valor predeterminado: @code{NULL}.

Consulte también el miembro @ref{92c,,orig_argv}.
@end deffn

@geindex PyConfig.safe_path (C member)
@anchor{c-api/init_config c PyConfig safe_path}@anchor{80d}
@deffn {C Miembro} int safe_path

Si es igual a cero, @code{Py_RunMain()} agrega una ruta potencialmente insegura a @ref{27e,,sys.path} al inicio:


@itemize *

@item 
Si @ref{4a4,,argv[0]} es igual a @code{L"-m"} (@code{python -m module}), añade el directorio de trabajo actual.

@item 
If running a script (@code{python script.py}), prepend the script’s
directory.  If it’s a symbolic link, resolve symbolic links.

@item 
En caso contrario (@code{python -c code} and @code{python}), añade una cadena vacía, que significa el directorio de trabajo actual.
@end itemize

Set to @code{1} by the @ref{645,,-P} command line option and the
@geindex PYTHONSAFEPATH
@geindex variables de entorno; PYTHONSAFEPATH
@ref{646,,PYTHONSAFEPATH} environment variable.

Default: @code{0} in Python config, @code{1} in isolated config.


Added in version 3.11.

@end deffn

@geindex PyConfig.base_exec_prefix (C member)
@anchor{c-api/init_config c PyConfig base_exec_prefix}@anchor{4d0b}
@deffn {C Miembro} wchar_t *base_exec_prefix

@ref{27b,,sys.base_exec_prefix}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{4d0c,,PyConfig.exec_prefix}.
@end deffn

@geindex PyConfig.base_executable (C member)
@anchor{c-api/init_config c PyConfig base_executable}@anchor{4d0d}
@deffn {C Miembro} wchar_t *base_executable

Ejecutable base de Python: @code{sys._base_executable}.

Establecido por la variable de entorno 
@geindex __PYVENV_LAUNCHER__
@geindex variables de entorno; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__}.

Establecido desde @ref{498,,PyConfig.executable} si @code{NULL}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{498,,PyConfig.executable}.
@end deffn

@geindex PyConfig.base_prefix (C member)
@anchor{c-api/init_config c PyConfig base_prefix}@anchor{4d0e}
@deffn {C Miembro} wchar_t *base_prefix

@ref{280,,sys.base_prefix}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{4d0f,,PyConfig.prefix}.
@end deffn

@geindex PyConfig.buffered_stdio (C member)
@anchor{c-api/init_config c PyConfig buffered_stdio}@anchor{4c0}
@deffn {C Miembro} int buffered_stdio

If equals to @code{0} and @ref{4d10,,configure_c_stdio} is non-zero,
disable buffering on the C streams stdout and stderr.

Set to @code{0} by the @ref{19ad,,-u} command line option and the
@geindex PYTHONUNBUFFERED
@geindex variables de entorno; PYTHONUNBUFFERED
@ref{19ae,,PYTHONUNBUFFERED} environment variable.

stdin siempre se abre en modo de búfer.

Predeterminado: @code{1}.
@end deffn

@geindex PyConfig.bytes_warning (C member)
@anchor{c-api/init_config c PyConfig bytes_warning}@anchor{4b6}
@deffn {C Miembro} int bytes_warning

If equals to @code{1}, issue a warning when comparing @ref{325,,bytes} or
@ref{5e0,,bytearray} with @ref{237,,str}, or comparing @ref{325,,bytes} with
@ref{1f0,,int}.

If equal or greater to @code{2}, raise a @ref{cab,,BytesWarning} exception in these
cases.

Incrementado por la opción de línea de comando @ref{683,,-b}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.warn_default_encoding (C member)
@anchor{c-api/init_config c PyConfig warn_default_encoding}@anchor{4d11}
@deffn {C Miembro} int warn_default_encoding

Si no es cero, emite una advertencia @ref{1d43,,EncodingWarning} cuando @ref{854,,io.TextIOWrapper} usa su codificación predeterminada. Consulte @ref{1d5b,,EncodingWarning opcional} para obtener más detalles.

Predeterminado: @code{0}.


Added in version 3.10.

@end deffn

@geindex PyConfig.code_debug_ranges (C member)
@anchor{c-api/init_config c PyConfig code_debug_ranges}@anchor{4d12}
@deffn {C Miembro} int code_debug_ranges

If equals to @code{0}, disables the inclusion of the end line and column
mappings in code objects. Also disables traceback printing carets to
specific error locations.

Set to @code{0} by the 
@geindex PYTHONNODEBUGRANGES
@geindex variables de entorno; PYTHONNODEBUGRANGES
@ref{657,,PYTHONNODEBUGRANGES} environment variable
and by the @ref{2e2,,-X no_debug_ranges} command line option.

Predeterminado: @code{1}.


Added in version 3.11.

@end deffn

@geindex PyConfig.check_hash_pycs_mode (C member)
@anchor{c-api/init_config c PyConfig check_hash_pycs_mode}@anchor{4d13}
@deffn {C Miembro} wchar_t *check_hash_pycs_mode

Controla el comportamiento de validación de archivos @code{.pyc} basados en hash: valor de la opción de línea de comando @ref{1d36,,--check-hash-based-pycs}.

Valores válidos:


@itemize -

@item 
@code{L"always"}: Calcula el hash el archivo fuente para invalidación independientemente del valor de la marca “check_source”.

@item 
@code{L"never"}: suponga que los pycs basados en hash siempre son válidos.

@item 
@code{L"default"}: El indicador “check_source” en pycs basados en hash determina la invalidación.
@end itemize

Predeterminado: @code{L"default"}.

Consulte también 
@geindex Python Enhancement Proposals; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} «Pycs deterministas».
@end deffn

@geindex PyConfig.configure_c_stdio (C member)
@anchor{c-api/init_config c PyConfig configure_c_stdio}@anchor{4d10}
@deffn {C Miembro} int configure_c_stdio

Si es distinto de cero, configure los flujos estándar de C:


@itemize *

@item 
En Windows, configure el modo binario (@code{O_BINARY}) en stdin, stdout y stderr.

@item 
Si @ref{4c0,,buffered_stdio} es igual a cero, deshabilite el almacenamiento en búfer de los flujos stdin, stdout y stderr.

@item 
Si @ref{4ae,,interactive} no es cero, habilite el almacenamiento en búfer de flujo en stdin y stdout (solo stdout en Windows).
@end itemize

Predeterminado: @code{1} en la configuración de Python, @code{0} en la configuración aislada.
@end deffn

@geindex PyConfig.dev_mode (C member)
@anchor{c-api/init_config c PyConfig dev_mode}@anchor{4d05}
@deffn {C Miembro} int dev_mode

Si es distinto de cero, habilita @ref{356,,Modo de desarrollo de Python}.

Set to @code{1} by the @ref{2e2,,-X dev} option and the
@geindex PYTHONDEVMODE
@geindex variables de entorno; PYTHONDEVMODE
@ref{b78,,PYTHONDEVMODE} environment variable.

Por defecto: @code{-1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.dump_refs (C member)
@anchor{c-api/init_config c PyConfig dump_refs}@anchor{4d14}
@deffn {C Miembro} int dump_refs

Dump Python references?

Si no es cero, volcar todos los objetos que aún están vivos en la salida.

Establecido en @code{1} por la variable de entorno 
@geindex PYTHONDUMPREFS
@geindex variables de entorno; PYTHONDUMPREFS
@ref{a38,,PYTHONDUMPREFS}.

Needs a special build of Python with the @code{Py_TRACE_REFS} macro defined:
see the @ref{487,,configure --with-trace-refs option}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.exec_prefix (C member)
@anchor{c-api/init_config c PyConfig exec_prefix}@anchor{4d0c}
@deffn {C Miembro} wchar_t *exec_prefix

El prefijo de directorio específico del sitio donde se instalan los archivos Python dependientes de la plataforma: @ref{27c,,sys.exec_prefix}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{4d0b,,PyConfig.base_exec_prefix}.
@end deffn

@geindex PyConfig.executable (C member)
@anchor{c-api/init_config c PyConfig executable}@anchor{498}
@deffn {C Miembro} wchar_t *executable

La ruta absoluta del binario ejecutable para el intérprete de Python: @ref{283,,sys.executable}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{4d0d,,PyConfig.base_executable}.
@end deffn

@geindex PyConfig.faulthandler (C member)
@anchor{c-api/init_config c PyConfig faulthandler}@anchor{4d15}
@deffn {C Miembro} int faulthandler

¿Habilitar administrador de fallas?

Si no es cero, llama a @ref{d27,,faulthandler.enable()} al inicio.

Establecido en @code{1} por @ref{2e2,,-X faulthandler} y la variable de entorno 
@geindex PYTHONFAULTHANDLER
@geindex variables de entorno; PYTHONFAULTHANDLER
@ref{10fc,,PYTHONFAULTHANDLER}.

Por defecto: @code{-1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.filesystem_encoding (C member)
@anchor{c-api/init_config c PyConfig filesystem_encoding}@anchor{4c9}
@deffn {C Miembro} wchar_t *filesystem_encoding

@ref{5dd,,Codificación del sistema de archvios}: @ref{ce1,,sys.getfilesystemencoding()}.

En macOS, Android y VxWorks: use @code{"utf-8"} de forma predeterminada.

En Windows: utilice @code{"utf-8"} de forma predeterminada o @code{"mbcs"} si @ref{4c7,,legacy_windows_fs_encoding} de @ref{a3e,,PyPreConfig} no es cero.

Codificación predeterminada en otras plataformas:


@itemize *

@item 
@code{"utf-8"} si @ref{4cb,,PyPreConfig.utf8_mode} es distinto de cero.

@item 
@code{"ascii"} if Python detects that @code{nl_langinfo(CODESET)} announces
the ASCII encoding, whereas the @code{mbstowcs()} function
decodes from a different encoding (usually Latin1).

@item 
@code{"utf-8"} si @code{nl_langinfo(CODESET)} retorna una cadena vacía.

@item 
De lo contrario, utilice el resultado @ref{39b,,locale encoding}: @code{nl_langinfo(CODESET)}.
@end itemize

Al inicio de Python, el nombre de codificación se normaliza al nombre del códec de Python. Por ejemplo, @code{"ANSI_X3.4-1968"} se reemplaza por @code{"ascii"}.

Consulte también el miembro @ref{4ca,,filesystem_errors}.
@end deffn

@geindex PyConfig.filesystem_errors (C member)
@anchor{c-api/init_config c PyConfig filesystem_errors}@anchor{4ca}
@deffn {C Miembro} wchar_t *filesystem_errors

@ref{5dd,,Manejador de errores del sistema de archivos}: @ref{d6d,,sys.getfilesystemencodeerrors()}.

En Windows: utilice @code{"surrogatepass"} de forma predeterminada o @code{"replace"} si @ref{4c7,,legacy_windows_fs_encoding} de @ref{a3e,,PyPreConfig} no es cero.

En otras plataformas: utilice @code{"surrogateescape"} de forma predeterminada.

Controladores de errores admitidos:


@itemize *

@item 
@code{"strict"}

@item 
@code{"surrogateescape"}

@item 
@code{"surrogatepass"} (solo compatible con la codificación UTF-8)
@end itemize

Consulte también el miembro @ref{4c9,,filesystem_encoding}.
@end deffn

@geindex PyConfig.hash_seed (C member)
@anchor{c-api/init_config c PyConfig hash_seed}@anchor{4c3}
@deffn {C Miembro} unsigned long hash_seed
@end deffn

@geindex PyConfig.use_hash_seed (C member)
@anchor{c-api/init_config c PyConfig use_hash_seed}@anchor{4c2}
@deffn {C Miembro} int use_hash_seed

Funciones de semillas aleatorias hash.

Si @ref{4c2,,use_hash_seed} es cero, se elige una semilla al azar en el inicio de Python y se ignora @ref{4c3,,hash_seed}.

Establecido por la variable de entorno 
@geindex PYTHONHASHSEED
@geindex variables de entorno; PYTHONHASHSEED
@ref{10f9,,PYTHONHASHSEED}.

Valor predeterminado de `use_hash_seed': @code{-1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.home (C member)
@anchor{c-api/init_config c PyConfig home}@anchor{286}
@deffn {C Miembro} wchar_t *home

Set the default Python «home» directory, that is, the location of the
standard Python libraries (see 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}).

Establecido por la variable de entorno 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME}.

Valor predeterminado: @code{NULL}.

Parte de la entrada @ref{944,,Python Path Configuration}.
@end deffn

@geindex PyConfig.import_time (C member)
@anchor{c-api/init_config c PyConfig import_time}@anchor{4d16}
@deffn {C Miembro} int import_time

Si no es cero, el tiempo de importación del perfil.

Configure el @code{1} mediante la opción @ref{2e2,,-X importtime} y la variable de entorno 
@geindex PYTHONPROFILEIMPORTTIME
@geindex variables de entorno; PYTHONPROFILEIMPORTTIME
@ref{b80,,PYTHONPROFILEIMPORTTIME}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.inspect (C member)
@anchor{c-api/init_config c PyConfig inspect}@anchor{4b0}
@deffn {C Miembro} int inspect

Ingresa al modo interactivo después de ejecutar un script o un comando.

If greater than @code{0}, enable inspect: when a script is passed as first
argument or the -c option is used, enter interactive mode after executing
the script or the command, even when @ref{5df,,sys.stdin} does not appear to
be a terminal.

Incrementado por la opción de línea de comando @ref{151b,,-i}. Establecido en @code{1} si la variable de entorno 
@geindex PYTHONINSPECT
@geindex variables de entorno; PYTHONINSPECT
@ref{151a,,PYTHONINSPECT} no está vacía.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.install_signal_handlers (C member)
@anchor{c-api/init_config c PyConfig install_signal_handlers}@anchor{955}
@deffn {C Miembro} int install_signal_handlers

¿Instalar controladores de señales de Python?

Por defecto: @code{1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.interactive (C member)
@anchor{c-api/init_config c PyConfig interactive}@anchor{4ae}
@deffn {C Miembro} int interactive

If greater than @code{0}, enable the interactive mode (REPL).

Incrementado por la opción de línea de comando @ref{151b,,-i}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.int_max_str_digits (C member)
@anchor{c-api/init_config c PyConfig int_max_str_digits}@anchor{4d17}
@deffn {C Miembro} int int_max_str_digits

Configures the @ref{695,,integer string conversion length limitation}.  An initial value of @code{-1} means the value will
be taken from the command line or environment or otherwise default to
4300 (@ref{2280,,sys.int_info.default_max_str_digits}).  A value of @code{0}
disables the limitation.  Values greater than zero but less than 640
(@ref{42ab,,sys.int_info.str_digits_check_threshold}) are unsupported and
will produce an error.

Configured by the @ref{2e2,,-X int_max_str_digits} command line
flag or the 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variables de entorno; PYTHONINTMAXSTRDIGITS
@ref{17c5,,PYTHONINTMAXSTRDIGITS} environment variable.

Default: @code{-1} in Python mode.  4300
(@ref{2280,,sys.int_info.default_max_str_digits}) in isolated mode.


Added in version 3.12.

@end deffn

@geindex PyConfig.cpu_count (C member)
@anchor{c-api/init_config c PyConfig cpu_count}@anchor{4d18}
@deffn {C Miembro} int cpu_count

If the value of @ref{4d18,,cpu_count} is not @code{-1} then it will
override the return values of @ref{328,,os.cpu_count()},
@ref{327,,os.process_cpu_count()}, and @ref{fee,,multiprocessing.cpu_count()}.

Configured by the @code{-X cpu_count=@var{n|default}} command line
flag or the 
@geindex PYTHON_CPU_COUNT
@geindex variables de entorno; PYTHON_CPU_COUNT
@ref{36d,,PYTHON_CPU_COUNT} environment variable.

Default: @code{-1}.


Added in version 3.13.

@end deffn

@geindex PyConfig.isolated (C member)
@anchor{c-api/init_config c PyConfig isolated}@anchor{4c5}
@deffn {C Miembro} int isolated

If greater than @code{0}, enable isolated mode:


@itemize *

@item 
Set @ref{80d,,safe_path} to @code{1}:
don’t prepend a potentially unsafe path to @ref{27e,,sys.path} at Python
startup, such as the current directory, the script’s directory or an
empty string.

@item 
Set @ref{4ba,,use_environment} to @code{0}: ignore @code{PYTHON}
environment variables.

@item 
Set @ref{4be,,user_site_directory} to @code{0}: don’t add the user
site directory to @ref{27e,,sys.path}.

@item 
Python REPL no importa @ref{ba,,readline} ni habilita la configuración predeterminada de readline en mensajes interactivos.
@end itemize

Set to @code{1} by the @ref{9f1,,-I} command line option.

Por defecto: @code{0} en modo Python, @code{1} en modo aislado.

See also the @ref{4cf5,,Isolated Configuration} and
@ref{4d06,,PyPreConfig.isolated}.
@end deffn

@geindex PyConfig.legacy_windows_stdio (C member)
@anchor{c-api/init_config c PyConfig legacy_windows_stdio}@anchor{497}
@deffn {C Miembro} int legacy_windows_stdio

If non-zero, use @ref{1378,,io.FileIO} instead of
@code{io._WindowsConsoleIO} for @ref{5df,,sys.stdin}, @ref{b61,,sys.stdout}
and @ref{9cc,,sys.stderr}.

Establecido en @code{1} si la variable de entorno 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variables de entorno; PYTHONLEGACYWINDOWSSTDIO
@ref{ce3,,PYTHONLEGACYWINDOWSSTDIO} está establecida en una cadena no vacía.

Solo disponible en Windows. La macro @code{#ifdef MS_WINDOWS} se puede usar para el código específico de Windows.

Predeterminado: @code{0}.

Consulte también 
@geindex Python Enhancement Proposals; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} (Cambiar la codificación de la consola de Windows a UTF-8).
@end deffn

@geindex PyConfig.malloc_stats (C member)
@anchor{c-api/init_config c PyConfig malloc_stats}@anchor{4d19}
@deffn {C Miembro} int malloc_stats

Si no es cero, volcar las estadísticas en @ref{d96,,Asignador de memoria Python pymalloc} en la salida.

Establecido en @code{1} por la variable de entorno 
@geindex PYTHONMALLOCSTATS
@geindex variables de entorno; PYTHONMALLOCSTATS
@ref{1b5d,,PYTHONMALLOCSTATS}.

La opción se ignora si Python es @ref{1db3,,configurado usando la opción --without-pymalloc}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.platlibdir (C member)
@anchor{c-api/init_config c PyConfig platlibdir}@anchor{1947}
@deffn {C Miembro} wchar_t *platlibdir

Nombre del directorio de la biblioteca de la plataforma: @ref{9cb,,sys.platlibdir}.

Establecido por la variable de entorno 
@geindex PYTHONPLATLIBDIR
@geindex variables de entorno; PYTHONPLATLIBDIR
@ref{1949,,PYTHONPLATLIBDIR}.

Default: value of the @code{PLATLIBDIR} macro which is set by the
@ref{1d7c,,configure --with-platlibdir option}
(default: @code{"lib"}, or @code{"DLLs"} on Windows).

Parte de la entrada @ref{944,,Python Path Configuration}.


Added in version 3.9.



Distinto en la versión 3.11: Esta macro se utiliza ahora en Windows para localizar los módulos de extensión de la biblioteca estándar, normalmente en @code{DLLs}. Sin embargo, por compatibilidad, tenga en cuenta que este valor se ignora para cualquier disposición no estándar, incluyendo las construcciones dentro del árbol y los entornos virtuales.

@end deffn

@geindex PyConfig.pythonpath_env (C member)
@anchor{c-api/init_config c PyConfig pythonpath_env}@anchor{4d1a}
@deffn {C Miembro} wchar_t *pythonpath_env

Module search paths (@ref{27e,,sys.path}) as a string separated by @code{DELIM}
(@ref{1d4a,,os.pathsep}).

Establecido por la variable de entorno 
@geindex PYTHONPATH
@geindex variables de entorno; PYTHONPATH
@ref{1099,,PYTHONPATH}.

Valor predeterminado: @code{NULL}.

Parte de la entrada @ref{944,,Python Path Configuration}.
@end deffn

@geindex PyConfig.module_search_paths (C member)
@anchor{c-api/init_config c PyConfig module_search_paths}@anchor{495}
@deffn {C Miembro} @ref{a40,,PyWideStringList} module_search_paths
@end deffn

@geindex PyConfig.module_search_paths_set (C member)
@anchor{c-api/init_config c PyConfig module_search_paths_set}@anchor{68f}
@deffn {C Miembro} int module_search_paths_set

Rutas de búsqueda del módulo: @ref{27e,,sys.path}.

If @ref{68f,,module_search_paths_set} is equal to @code{0},
@ref{4a6,,Py_InitializeFromConfig()} will replace
@ref{495,,module_search_paths} and sets
@ref{68f,,module_search_paths_set} to @code{1}.

Por defecto: lista vacía (@code{module_search_paths}) y @code{0} (@code{module_search_paths_set}).

Parte de la salida @ref{944,,Python Path Configuration}.
@end deffn

@geindex PyConfig.optimization_level (C member)
@anchor{c-api/init_config c PyConfig optimization_level}@anchor{4b2}
@deffn {C Miembro} int optimization_level

Nivel de optimización de compilación:


@itemize *

@item 
@code{0}: Optimizador de mirilla, configure @code{__debug__} en @code{True}.

@item 
@code{1}: Nivel 0, elimina las aserciones, establece @code{__debug__} en @code{False}.

@item 
@code{2}: Nivel 1, elimina docstrings.
@end itemize

Incrementado por la opción de línea de comando @ref{14f,,-O}. Establecido en el valor de la variable de entorno 
@geindex PYTHONOPTIMIZE
@geindex variables de entorno; PYTHONOPTIMIZE
@ref{1d39,,PYTHONOPTIMIZE}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.orig_argv (C member)
@anchor{c-api/init_config c PyConfig orig_argv}@anchor{92c}
@deffn {C Miembro} @ref{a40,,PyWideStringList} orig_argv

La lista de los argumentos originales de la línea de comandos pasados al ejecutable de Python: @ref{8d7,,sys.orig_argv}.

Si la lista @ref{92c,,orig_argv} está vacía y @ref{4a4,,argv} no es una lista que solo contiene una cadena vacía, @ref{829,,PyConfig_Read()} copia @ref{4a4,,argv} en @ref{92c,,orig_argv} antes de modificar @ref{4a4,,argv} (si @ref{1932,,parse_argv} no es cero).

Consulte también el miembro @ref{4a4,,argv} y la función @ref{1960,,Py_GetArgcArgv()}.

Predeterminado: lista vacía.


Added in version 3.10.

@end deffn

@geindex PyConfig.parse_argv (C member)
@anchor{c-api/init_config c PyConfig parse_argv}@anchor{1932}
@deffn {C Miembro} int parse_argv

¿Analizar los argumentos de la línea de comando?

Si es igual a @code{1}, analiza @ref{4a4,,argv} de la misma forma que Python normal analiza @ref{1083,,argumentos de línea de comando} y elimina los argumentos de Python de @ref{4a4,,argv}.

The @ref{829,,PyConfig_Read()} function only parses
@ref{4a4,,PyConfig.argv} arguments once: @ref{1932,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
stripped from @ref{4a4,,PyConfig.argv}, parsing arguments twice would
parse the application options as Python options.

Por defecto: @code{1} en modo Python, @code{0} en modo aislado.


Distinto en la versión 3.10: Los argumentos @ref{4a4,,PyConfig.argv} ahora solo se analizan si @ref{1932,,PyConfig.parse_argv} es igual a @code{1}.

@end deffn

@geindex PyConfig.parser_debug (C member)
@anchor{c-api/init_config c PyConfig parser_debug}@anchor{4a8}
@deffn {C Miembro} int parser_debug

Parser debug mode. If greater than @code{0}, turn on parser debugging output (for expert only, depending
on compilation options).

Incrementado por la opción de línea de comando @ref{1d37,,-d}. Establecido en el valor de la variable de entorno 
@geindex PYTHONDEBUG
@geindex variables de entorno; PYTHONDEBUG
@ref{1d38,,PYTHONDEBUG}.

Needs a @ref{357,,debug build of Python} (the @code{Py_DEBUG} macro
must be defined).

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.pathconfig_warnings (C member)
@anchor{c-api/init_config c PyConfig pathconfig_warnings}@anchor{4b8}
@deffn {C Miembro} int pathconfig_warnings

If non-zero, calculation of path configuration is allowed to log
warnings into @code{stderr}. If equals to @code{0}, suppress these warnings.

Por defecto: @code{1} en modo Python, @code{0} en modo aislado.

Parte de la entrada @ref{944,,Python Path Configuration}.


Distinto en la versión 3.11: Ahora también se aplica en Windows.

@end deffn

@geindex PyConfig.prefix (C member)
@anchor{c-api/init_config c PyConfig prefix}@anchor{4d0f}
@deffn {C Miembro} wchar_t *prefix

El prefijo de directorio específico del sitio donde se instalan los archivos Python independientes de la plataforma: @ref{281,,sys.prefix}.

Valor predeterminado: @code{NULL}.

Parte de la salida @ref{944,,Python Path Configuration}.

See also @ref{4d0e,,PyConfig.base_prefix}.
@end deffn

@geindex PyConfig.program_name (C member)
@anchor{c-api/init_config c PyConfig program_name}@anchor{4a5}
@deffn {C Miembro} wchar_t *program_name

Nombre del programa utilizado para inicializar @ref{498,,executable} y en los primeros mensajes de error durante la inicialización de Python.


@itemize *

@item 
En macOS, usa la variable de entorno 
@geindex PYTHONEXECUTABLE
@geindex variables de entorno; PYTHONEXECUTABLE
@ref{1d4e,,PYTHONEXECUTABLE} si está configurada.

@item 
Si se define la macro @code{WITH_NEXT_FRAMEWORK}, utiliza la variable de entorno 
@geindex __PYVENV_LAUNCHER__
@geindex variables de entorno; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__} si está configurada.

@item 
Utiliza @code{argv[0]} de @ref{4a4,,argv} si está disponible y no está vacío.

@item 
De lo contrario, utiliza @code{L"python"} en Windows o @code{L"python3"} en otras plataformas.
@end itemize

Valor predeterminado: @code{NULL}.

Parte de la entrada @ref{944,,Python Path Configuration}.
@end deffn

@geindex PyConfig.pycache_prefix (C member)
@anchor{c-api/init_config c PyConfig pycache_prefix}@anchor{4d1b}
@deffn {C Miembro} wchar_t *pycache_prefix

Directorio donde se escriben los archivos @code{.pyc} almacenados en caché: @ref{a36,,sys.pycache_prefix}.

Set by the @ref{2e2,,-X pycache_prefix=PATH} command line option and
the 
@geindex PYTHONPYCACHEPREFIX
@geindex variables de entorno; PYTHONPYCACHEPREFIX
@ref{a35,,PYTHONPYCACHEPREFIX} environment variable.
The command-line option takes precedence.

Si @code{NULL}, @ref{a36,,sys.pycache_prefix} es establecido a @code{None}.

Valor predeterminado: @code{NULL}.
@end deffn

@geindex PyConfig.quiet (C member)
@anchor{c-api/init_config c PyConfig quiet}@anchor{4ac}
@deffn {C Miembro} int quiet

Quiet mode. If greater than @code{0}, don’t display the copyright and version at
Python startup in interactive mode.

Incrementado por la opción de línea de comando @ref{1d3a,,-q}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.run_command (C member)
@anchor{c-api/init_config c PyConfig run_command}@anchor{4cb5}
@deffn {C Miembro} wchar_t *run_command

Valor de la opción de línea de comando @ref{681,,-c}.

Usado por @ref{a57,,Py_RunMain()}.

Valor predeterminado: @code{NULL}.
@end deffn

@geindex PyConfig.run_filename (C member)
@anchor{c-api/init_config c PyConfig run_filename}@anchor{4cb6}
@deffn {C Miembro} wchar_t *run_filename

Filename passed on the command line: trailing command line argument
without @ref{681,,-c} or @ref{187,,-m}. It is used by the
@ref{a57,,Py_RunMain()} function.

For example, it is set to @code{script.py} by the @code{python3 script.py arg}
command line.

See also the @ref{4d1c,,PyConfig.skip_source_first_line} option.

Valor predeterminado: @code{NULL}.
@end deffn

@geindex PyConfig.run_module (C member)
@anchor{c-api/init_config c PyConfig run_module}@anchor{4cb7}
@deffn {C Miembro} wchar_t *run_module

Valor de la opción de línea de comando @ref{187,,-m}.

Usado por @ref{a57,,Py_RunMain()}.

Valor predeterminado: @code{NULL}.
@end deffn

@geindex PyConfig.run_presite (C member)
@anchor{c-api/init_config c PyConfig run_presite}@anchor{4d1d}
@deffn {C Miembro} wchar_t *run_presite

@code{package.module} path to module that should be imported before
@code{site.py} is run.

Set by the @ref{2e2,,-X presite=package.module} command-line
option and the 
@geindex PYTHON_PRESITE
@geindex variables de entorno; PYTHON_PRESITE
@ref{1d44,,PYTHON_PRESITE} environment variable.
The command-line option takes precedence.

Needs a @ref{357,,debug build of Python} (the @code{Py_DEBUG} macro
must be defined).

Valor predeterminado: @code{NULL}.
@end deffn

@geindex PyConfig.show_ref_count (C member)
@anchor{c-api/init_config c PyConfig show_ref_count}@anchor{4d1e}
@deffn {C Miembro} int show_ref_count

Show total reference count at exit (excluding @ref{429d,,immortal} objects)?

Set to @code{1} by @ref{2e2,,-X showrefcount} command line option.

Needs a @ref{357,,debug build of Python} (the @code{Py_REF_DEBUG}
macro must be defined).

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.site_import (C member)
@anchor{c-api/init_config c PyConfig site_import}@anchor{4b4}
@deffn {C Miembro} int site_import

¿Importar el módulo @ref{c7,,site} al inicio?

Si es igual a cero, desactive la importación del sitio del módulo y las manipulaciones dependientes del sitio de @ref{27e,,sys.path} que conlleva.

También deshabilite estas manipulaciones si el módulo @ref{c7,,site} se importa explícitamente más tarde (llame a @ref{1d3c,,site.main()} si desea que se activen).

Establecido en @code{0} mediante la opción de línea de comando @ref{1217,,-S}.

@ref{72d,,sys.flags.no_site} is set to the inverted value of
@ref{4b4,,site_import}.

Predeterminado: @code{1}.
@end deffn

@geindex PyConfig.skip_source_first_line (C member)
@anchor{c-api/init_config c PyConfig skip_source_first_line}@anchor{4d1c}
@deffn {C Miembro} int skip_source_first_line

Si no es cero, omita la primera línea de la fuente @ref{4cb6,,PyConfig.run_filename}.

Permite el uso de formas de @code{#!cmd} que no son Unix. Esto está destinado únicamente a un truco específico de DOS.

Establecido en @code{1} mediante la opción de línea de comando @ref{1d40,,-x}.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.stdio_encoding (C member)
@anchor{c-api/init_config c PyConfig stdio_encoding}@anchor{496}
@deffn {C Miembro} wchar_t *stdio_encoding
@end deffn

@geindex PyConfig.stdio_errors (C member)
@anchor{c-api/init_config c PyConfig stdio_errors}@anchor{42ad}
@deffn {C Miembro} wchar_t *stdio_errors

Codificación y errores de codificación de @ref{5df,,sys.stdin}, @ref{b61,,sys.stdout} y @ref{9cc,,sys.stderr} (pero @ref{9cc,,sys.stderr} siempre usa el controlador de errores @code{"backslashreplace"}).

Utilice la variable de entorno 
@geindex PYTHONIOENCODING
@geindex variables de entorno; PYTHONIOENCODING
@ref{1086,,PYTHONIOENCODING} si no está vacía.

Codificación predeterminada:


@itemize *

@item 
@code{"UTF-8"} si @ref{4cb,,PyPreConfig.utf8_mode} es distinto de cero.

@item 
De lo contrario, usa el @ref{39b,,locale encoding}.
@end itemize

Manejador de errores predeterminado:


@itemize *

@item 
En Windows: use @code{"surrogateescape"}.

@item 
@code{"surrogateescape"} si @ref{4cb,,PyPreConfig.utf8_mode} no es cero o si la configuración regional LC_CTYPE es «C» o «POSIX».

@item 
@code{"strict"} de lo contrario.
@end itemize

See also @ref{497,,PyConfig.legacy_windows_stdio}.
@end deffn

@geindex PyConfig.tracemalloc (C member)
@anchor{c-api/init_config c PyConfig tracemalloc}@anchor{4d1f}
@deffn {C Miembro} int tracemalloc

¿Habilitar tracemalloc?

Si no es cero, llama a @ref{1d41,,tracemalloc.start()} al inicio.

Establecido por la opción de línea de comando @ref{2e2,,-X tracemalloc=N} y por la variable de entorno 
@geindex PYTHONTRACEMALLOC
@geindex variables de entorno; PYTHONTRACEMALLOC
@ref{1d42,,PYTHONTRACEMALLOC}.

Por defecto: @code{-1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.perf_profiling (C member)
@anchor{c-api/init_config c PyConfig perf_profiling}@anchor{4d20}
@deffn {C Miembro} int perf_profiling

Enable the Linux @code{perf} profiler support?

If equals to @code{1}, enable support for the Linux @code{perf} profiler.

If equals to @code{2}, enable support for the Linux @code{perf} profiler with
DWARF JIT support.

Set to @code{1} by @ref{2e2,,-X perf} command-line option and the
@geindex PYTHONPERFSUPPORT
@geindex variables de entorno; PYTHONPERFSUPPORT
@ref{519,,PYTHONPERFSUPPORT} environment variable.

Set to @code{2} by the @ref{2e2,,-X perf_jit} command-line option and
the 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variables de entorno; PYTHON_PERF_JIT_SUPPORT
@ref{2f9,,PYTHON_PERF_JIT_SUPPORT} environment variable.

Default: @code{-1}.


@subsubheading Ver también


See @ref{2f8,,Soporte de Python para el perfilador perf de Linux} for more information.



Added in version 3.12.

@end deffn

@geindex PyConfig.use_environment (C member)
@anchor{c-api/init_config c PyConfig use_environment}@anchor{4ba}
@deffn {C Miembro} int use_environment

¿Utiliza @ref{691,,variables de entorno}?

Si es igual a cero, ignora las @ref{691,,variables de entorno}.

Set to @code{0} by the @ref{9f0,,-E} environment variable.

Predeterminado: @code{1} en la configuración de Python y @code{0} en la configuración aislada.
@end deffn

@geindex PyConfig.user_site_directory (C member)
@anchor{c-api/init_config c PyConfig user_site_directory}@anchor{4be}
@deffn {C Miembro} int user_site_directory

Si es distinto de cero, agregue el directorio del sitio del usuario a @ref{27e,,sys.path}.

Establecido en @code{0} por las opciones de línea de comando @ref{13eb,,-s} y @ref{9f1,,-I}.

Establecido en @code{0} por la variable de entorno 
@geindex PYTHONNOUSERSITE
@geindex variables de entorno; PYTHONNOUSERSITE
@ref{13ec,,PYTHONNOUSERSITE}.

Por defecto: @code{1} en modo Python, @code{0} en modo aislado.
@end deffn

@geindex PyConfig.verbose (C member)
@anchor{c-api/init_config c PyConfig verbose}@anchor{4aa}
@deffn {C Miembro} int verbose

Verbose mode. If greater than @code{0}, print a message each time a module is
imported, showing the place (filename or built-in module) from which
it is loaded.

If greater than or equal to @code{2}, print a message for each file that is
checked for when searching for a module. Also provides information on
module cleanup at exit.

Incrementado por la opción de línea de comando @ref{1464,,-v}.

Set by the 
@geindex PYTHONVERBOSE
@geindex variables de entorno; PYTHONVERBOSE
@ref{1d3d,,PYTHONVERBOSE} environment variable value.

Predeterminado: @code{0}.
@end deffn

@geindex PyConfig.warnoptions (C member)
@anchor{c-api/init_config c PyConfig warnoptions}@anchor{493}
@deffn {C Miembro} @ref{a40,,PyWideStringList} warnoptions

Opciones del módulo @ref{112,,warnings} para crear filtros de advertencias, de menor a mayor prioridad: @ref{279,,sys.warnoptions}.

El módulo @ref{112,,warnings} agrega @ref{279,,sys.warnoptions} en el orden inverso: el último elemento @ref{493,,PyConfig.warnoptions} se convierte en el primer elemento de @code{warnings.filters} que es verificado primero (máxima prioridad).

Las opciones de la línea de comando @ref{95e,,-W} agregan su valor a @ref{493,,warnoptions}, se puede usar varias veces.

La variable de entorno 
@geindex PYTHONWARNINGS
@geindex variables de entorno; PYTHONWARNINGS
@ref{c32,,PYTHONWARNINGS} también se puede utilizar para agregar opciones de advertencia. Se pueden especificar varias opciones, separadas por comas (@code{,}).

Predeterminado: lista vacía.
@end deffn

@geindex PyConfig.write_bytecode (C member)
@anchor{c-api/init_config c PyConfig write_bytecode}@anchor{4bc}
@deffn {C Miembro} int write_bytecode

If equal to @code{0}, Python won’t try to write @code{.pyc} files on the import of
source modules.

Establecido en @code{0} por la opción de línea de comando @ref{140d,,-B} y la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE}.

@ref{4276,,sys.dont_write_bytecode} se inicializa al valor invertido de @ref{4bc,,write_bytecode}.

Predeterminado: @code{1}.
@end deffn

@geindex PyConfig.xoptions (C member)
@anchor{c-api/init_config c PyConfig xoptions}@anchor{494}
@deffn {C Miembro} @ref{a40,,PyWideStringList} xoptions

Valores de las opciones de la línea de comando @ref{2e2,,-X}: @ref{1d45,,sys._xoptions}.

Predeterminado: lista vacía.
@end deffn
@end deffn

Si @ref{1932,,parse_argv} no es cero, los argumentos de @ref{4a4,,argv} se analizan de la misma forma que Python normal analiza @ref{1083,,argumentos de línea de comando}, y los argumentos de Python se eliminan de @ref{4a4,,argv}.

Las opciones de @ref{494,,xoptions} se analizan para establecer otras opciones: consulte la opción de línea de comando @ref{2e2,,-X}.


Distinto en la versión 3.9: El campo @code{show_alloc_count} fue removido.


@node Inicialización con PyConfig,Configuración aislada,PyConfig,PyConfig C API
@anchor{c-api/init_config init-from-config}@anchor{4cb4}@anchor{c-api/init_config initialization-with-pyconfig}@anchor{4d21}
@subsubsection Inicialización con PyConfig


Initializing the interpreter from a populated configuration struct is handled
by calling @ref{4a6,,Py_InitializeFromConfig()}.

La persona que llama es responsable de manejar las excepciones (error o salida) usando @ref{a4b,,PyStatus_Exception()} y @ref{a54,,Py_ExitStatusException()}.

Si se utilizan @ref{3003,,PyImport_FrozenModules()}, @ref{17ab,,PyImport_AppendInittab()} o @ref{17ac,,PyImport_ExtendInittab()}, deben establecerse o llamarse después de la preinicialización de Python y antes de la inicialización de Python. Si Python se inicializa varias veces, se debe llamar a @ref{17ab,,PyImport_AppendInittab()} o @ref{17ac,,PyImport_ExtendInittab()} antes de cada inicialización de Python.

La configuración actual (tipo @code{PyConfig}) se almacena en @code{PyInterpreterState.config}.

Ejemplo de configuración del nombre del programa:

@example
void init_python(void)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* Set the program name. Implicitly preinitialize Python. */
    status = PyConfig_SetString(&config, &config.program_name,
                                L"/path/to/my_program");
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);
    return;

exception:
    PyConfig_Clear(&config);
    Py_ExitStatusException(status);
@}
@end example

More complete example modifying the default configuration, read the
configuration, and then override some parameters. Note that since
3.11, many parameters are not calculated until initialization, and
so values cannot be read from the configuration structure. Any values
set before initialize is called will be left unchanged by
initialization:

@example
PyStatus init_python(const char *program_name)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* Set the program name before reading the configuration
       (decode byte string from the locale encoding).

       Implicitly preinitialize Python. */
    status = PyConfig_SetBytesString(&config, &config.program_name,
                                     program_name);
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* Read all configuration at once */
    status = PyConfig_Read(&config);
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* Specify sys.path explicitly */
    /* If you want to modify the default set of paths, finish
       initialization first and then use PySys_GetObject("path") */
    config.module_search_paths_set = 1;
    status = PyWideStringList_Append(&config.module_search_paths,
                                     L"/path/to/stdlib");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}
    status = PyWideStringList_Append(&config.module_search_paths,
                                     L"/path/to/more/modules");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* Override executable computed by PyConfig_Read() */
    status = PyConfig_SetString(&config, &config.executable,
                                L"/path/to/my_executable");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    status = Py_InitializeFromConfig(&config);

done:
    PyConfig_Clear(&config);
    return status;
@}
@end example

@node Configuración aislada,Configuración de Python<2>,Inicialización con PyConfig,PyConfig C API
@anchor{c-api/init_config init-isolated-conf}@anchor{4cf5}@anchor{c-api/init_config isolated-configuration}@anchor{4d22}
@subsubsection Configuración aislada


@ref{a48,,PyPreConfig_InitIsolatedConfig()} y las funciones @ref{a42,,PyConfig_InitIsolatedConfig()} crean una configuración para aislar Python del sistema. Por ejemplo, para incrustar Python en una aplicación.

This configuration ignores global configuration variables, environment
variables, command line arguments (@ref{4a4,,PyConfig.argv} is not parsed)
and user site directory. The C standard streams (ex: @code{stdout}) and the
LC_CTYPE locale are left unchanged. Signal handlers are not installed.

Los archivos de configuración se siguen utilizando con esta configuración para determinar las rutas que no se especifican. Asegúrese de que se especifica @ref{286,,PyConfig.home} para evitar que se calcule la configuración de la ruta por defecto.

@node Configuración de Python<2>,Configuración de la ruta de Python,Configuración aislada,PyConfig C API
@anchor{c-api/init_config init-python-config}@anchor{4cb8}@anchor{c-api/init_config python-configuration}@anchor{4d23}
@subsubsection Configuración de Python


@ref{a49,,PyPreConfig_InitPythonConfig()} y las funciones @ref{a43,,PyConfig_InitPythonConfig()} crean una configuración para construir un Python personalizado que se comporta como el Python normal.

Las variables de entorno y los argumentos de la línea de comandos se utilizan para configurar Python, mientras que las variables de configuración global se ignoran.

Esta función habilita la coerción de configuración regional C (
@geindex Python Enhancement Proposals; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}) y @ref{6f7,,Python UTF-8 Mode} (
@geindex Python Enhancement Proposals; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/}) según la configuración regional LC_CTYPE, las variables de entorno 
@geindex PYTHONUTF8
@geindex variables de entorno; PYTHONUTF8
@ref{b63,,PYTHONUTF8} y 
@geindex PYTHONCOERCECLOCALE
@geindex variables de entorno; PYTHONCOERCECLOCALE
@ref{b60,,PYTHONCOERCECLOCALE}.

@node Configuración de la ruta de Python,,Configuración de Python<2>,PyConfig C API
@anchor{c-api/init_config init-path-config}@anchor{944}@anchor{c-api/init_config python-path-configuration}@anchor{4d24}
@subsubsection Configuración de la ruta de Python


@ref{499,,PyConfig} contiene múltiples campos para la configuración de ruta:


@itemize *

@item 
Entradas de configuración de ruta:


@itemize *

@item 
@ref{286,,PyConfig.home}

@item 
@ref{1947,,PyConfig.platlibdir}

@item 
@ref{4b8,,PyConfig.pathconfig_warnings}

@item 
@ref{4a5,,PyConfig.program_name}

@item 
@ref{4d1a,,PyConfig.pythonpath_env}

@item 
directorio de trabajo actual: para obtener rutas absolutas

@item 
Variable de entorno @code{PATH} para obtener la ruta completa del programa (de @ref{4a5,,PyConfig.program_name})

@item 
Variable de entorno @code{__PYVENV_LAUNCHER__}

@item 
(Solo Windows) Rutas de aplicación en el registro en «SoftwarePythonPythonCoreX.YPythonPath» de HKEY_CURRENT_USER y HKEY_LOCAL_MACHINE (donde X.Y es la versión de Python).
@end itemize

@item 
Campos de salida de configuración de ruta:


@itemize *

@item 
@ref{4d0b,,PyConfig.base_exec_prefix}

@item 
@ref{4d0d,,PyConfig.base_executable}

@item 
@ref{4d0e,,PyConfig.base_prefix}

@item 
@ref{4d0c,,PyConfig.exec_prefix}

@item 
@ref{498,,PyConfig.executable}

@item 
@ref{68f,,PyConfig.module_search_paths_set},
@ref{495,,PyConfig.module_search_paths}

@item 
@ref{4d0f,,PyConfig.prefix}
@end itemize
@end itemize

Si al menos un «campo de salida» no está establecido, Python calcula la configuración de la ruta para rellenar los campos no establecidos. Si @ref{68f,,module_search_paths_set} es igual a @code{0}, @ref{495,,module_search_paths} se anula y @ref{68f,,module_search_paths_set} se establece en @code{1}.

It is possible to completely ignore the function calculating the default
path configuration by setting explicitly all path configuration output
fields listed above. A string is considered as set even if it is non-empty.
@code{module_search_paths} is considered as set if
@code{module_search_paths_set} is set to @code{1}. In this case,
@code{module_search_paths} will be used without modification.

Set @ref{4b8,,pathconfig_warnings} to @code{0} to suppress warnings when
calculating the path configuration (Unix only, Windows does not log any warning).

Si @ref{4d0e,,base_prefix} o los campos @ref{4d0b,,base_exec_prefix} no están establecidos, heredan su valor de @ref{4d0f,,prefix} y @ref{4d0c,,exec_prefix} respectivamente.

@ref{a57,,Py_RunMain()} y @ref{cad,,Py_Main()} modifican @ref{27e,,sys.path}:


@itemize *

@item 
Si @ref{4cb6,,run_filename} está configurado y es un directorio que contiene un script @code{__main__.py}, anteponga @ref{4cb6,,run_filename} a @ref{27e,,sys.path}.

@item 
Si @ref{4c5,,isolated} es cero:


@itemize *

@item 
Si @ref{4cb7,,run_module} está configurado, anteponga el directorio actual a @ref{27e,,sys.path}. No haga nada si el directorio actual no se puede leer.

@item 
Si @ref{4cb6,,run_filename} está configurado, anteponga el directorio del nombre del archivo a @ref{27e,,sys.path}.

@item 
De lo contrario, anteponga una cadena de caracteres vacía a @ref{27e,,sys.path}.
@end itemize
@end itemize

Si @ref{4b4,,site_import} no es cero, @ref{27e,,sys.path} puede ser modificado por el módulo @ref{c7,,site}. Si @ref{4be,,user_site_directory} no es cero y el directorio del paquete del sitio del usuario existe, el módulo @ref{c7,,site} agrega el directorio del paquete del sitio del usuario a @ref{27e,,sys.path}.

La configuración de ruta utiliza los siguientes archivos de configuración:


@itemize *

@item 
@code{pyvenv.cfg}

@item 
archivo @code{._pth} (ej: @code{python._pth})

@item 
@code{pybuilddir.txt} (sólo Unix)
@end itemize

Si un archivo @code{._pth} está presente:


@itemize *

@item 
Set @ref{4c5,,isolated} to @code{1}.

@item 
Set @ref{4ba,,use_environment} to @code{0}.

@item 
Set @ref{4b4,,site_import} to @code{0}.

@item 
Set @ref{80d,,safe_path} to @code{1}.
@end itemize

The @code{__PYVENV_LAUNCHER__} environment variable is used to set
@ref{4d0d,,PyConfig.base_executable}.

@node PyInitConfig C API,Runtime Python configuration API,PyConfig C API,Configuración de inicialización de Python
@anchor{c-api/init_config pyinitconfig-c-api}@anchor{4d25}
@subsection PyInitConfig C API


C API to configure the Python initialization (
@geindex Python Enhancement Proposals; PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}).


Added in version 3.14.


@menu
* Create Config:: 
* Error Handling:: 
* Get Options:: 
* Set Options:: 
* Module:: 
* Initialize Python:: 
* Ejemplo: Ejemplo<17>. 

@end menu

@node Create Config,Error Handling,,PyInitConfig C API
@anchor{c-api/init_config create-config}@anchor{4d26}
@subsubsection Create Config


@geindex PyInitConfig (C struct)
@anchor{c-api/init_config c PyInitConfig}@anchor{4d27}
@deffn {C Estructura} struct PyInitConfig

Opaque structure to configure the Python initialization.
@end deffn

@geindex PyInitConfig_Create (C function)
@anchor{c-api/init_config c PyInitConfig_Create}@anchor{25c}
@deffn {C Función} @ref{4d27,,PyInitConfig} *PyInitConfig_Create (void)

Create a new initialization configuration using @ref{4cf5,,Isolated Configuration} default values.

It must be freed by @ref{25d,,PyInitConfig_Free()}.

Return @code{NULL} on memory allocation failure.
@end deffn

@geindex PyInitConfig_Free (C function)
@anchor{c-api/init_config c PyInitConfig_Free}@anchor{25d}
@deffn {C Función} void PyInitConfig_Free (PyInitConfig *config)

Free memory of the initialization configuration `config'.

If `config' is @code{NULL}, no operation is performed.
@end deffn

@node Error Handling,Get Options,Create Config,PyInitConfig C API
@anchor{c-api/init_config error-handling}@anchor{4d28}
@subsubsection Error Handling


@geindex PyInitConfig_GetError (C function)
@anchor{c-api/init_config c PyInitConfig_GetError}@anchor{25f}
@deffn {C Función} int PyInitConfig_GetError (PyInitConfig *config, const char **err_msg)

Get the `config' error message.


@itemize *

@item 
Set `*err_msg' and return @code{1} if an error is set.

@item 
Set `*err_msg' to @code{NULL} and return @code{0} otherwise.
@end itemize

An error message is an UTF-8 encoded string.

If `config' has an exit code, format the exit code as an error
message.

The error message remains valid until another @code{PyInitConfig}
function is called with `config'. The caller doesn’t have to free the
error message.
@end deffn

@geindex PyInitConfig_GetExitCode (C function)
@anchor{c-api/init_config c PyInitConfig_GetExitCode}@anchor{260}
@deffn {C Función} int PyInitConfig_GetExitCode (PyInitConfig *config, int *exitcode)

Get the `config' exit code.


@itemize *

@item 
Set `*exitcode' and return @code{1} if `config' has an exit code set.

@item 
Return @code{0} if `config' has no exit code set.
@end itemize

Only the @code{Py_InitializeFromInitConfig()} function can set an exit
code if the @code{parse_argv} option is non-zero.

An exit code can be set when parsing the command line failed (exit
code @code{2}) or when a command line option asks to display the command
line help (exit code @code{0}).
@end deffn

@node Get Options,Set Options,Error Handling,PyInitConfig C API
@anchor{c-api/init_config get-options}@anchor{4d29}
@subsubsection Get Options


The configuration option `name' parameter must be a non-NULL
null-terminated UTF-8 encoded string.

@geindex PyInitConfig_HasOption (C function)
@anchor{c-api/init_config c PyInitConfig_HasOption}@anchor{264}
@deffn {C Función} int PyInitConfig_HasOption (PyInitConfig *config, const char *name)

Test if the configuration has an option called `name'.

Return @code{1} if the option exists, or return @code{0} otherwise.
@end deffn

@geindex PyInitConfig_GetInt (C function)
@anchor{c-api/init_config c PyInitConfig_GetInt}@anchor{261}
@deffn {C Función} int PyInitConfig_GetInt (PyInitConfig *config, const char *name, int64_t *value)

Get an integer configuration option.


@itemize *

@item 
Set `*value', and return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize
@end deffn

@geindex PyInitConfig_GetStr (C function)
@anchor{c-api/init_config c PyInitConfig_GetStr}@anchor{262}
@deffn {C Función} int PyInitConfig_GetStr (PyInitConfig *config, const char *name, char **value)

Get a string configuration option as a null-terminated UTF-8
encoded string.


@itemize *

@item 
Set `*value', and return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize

`*value' can be set to @code{NULL} if the option is an optional string and the
option is unset.

On success, the string must be released with @code{free(value)} if it’s not
@code{NULL}.
@end deffn

@geindex PyInitConfig_GetStrList (C function)
@anchor{c-api/init_config c PyInitConfig_GetStrList}@anchor{263}
@deffn {C Función} int PyInitConfig_GetStrList (PyInitConfig *config, const char *name, size_t *length, char ***items)

Get a string list configuration option as an array of
null-terminated UTF-8 encoded strings.


@itemize *

@item 
Set `*length' and `*value', and return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize

On success, the string list must be released with
@code{PyInitConfig_FreeStrList(length, items)}.
@end deffn

@geindex PyInitConfig_FreeStrList (C function)
@anchor{c-api/init_config c PyInitConfig_FreeStrList}@anchor{25e}
@deffn {C Función} void PyInitConfig_FreeStrList (size_t length, char **items)

Free memory of a string list created by
@code{PyInitConfig_GetStrList()}.
@end deffn

@node Set Options,Module,Get Options,PyInitConfig C API
@anchor{c-api/init_config set-options}@anchor{4d2a}
@subsubsection Set Options


The configuration option `name' parameter must be a non-NULL null-terminated
UTF-8 encoded string.

Some configuration options have side effects on other options. This logic is
only implemented when @code{Py_InitializeFromInitConfig()} is called, not by the
«Set» functions below. For example, setting @code{dev_mode} to @code{1} does not set
@code{faulthandler} to @code{1}.

@geindex PyInitConfig_SetInt (C function)
@anchor{c-api/init_config c PyInitConfig_SetInt}@anchor{265}
@deffn {C Función} int PyInitConfig_SetInt (PyInitConfig *config, const char *name, int64_t value)

Set an integer configuration option.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize
@end deffn

@geindex PyInitConfig_SetStr (C function)
@anchor{c-api/init_config c PyInitConfig_SetStr}@anchor{266}
@deffn {C Función} int PyInitConfig_SetStr (PyInitConfig *config, const char *name, const char *value)

Set a string configuration option from a null-terminated UTF-8
encoded string. The string is copied.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize
@end deffn

@geindex PyInitConfig_SetStrList (C function)
@anchor{c-api/init_config c PyInitConfig_SetStrList}@anchor{267}
@deffn {C Función} int PyInitConfig_SetStrList (PyInitConfig *config, const char *name, size_t length, char *const *items)

Set a string list configuration option from an array of
null-terminated UTF-8 encoded strings. The string list is copied.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize
@end deffn

@node Module,Initialize Python,Set Options,PyInitConfig C API
@anchor{c-api/init_config module}@anchor{4d2b}
@subsubsection Module


@geindex PyInitConfig_AddModule (C function)
@anchor{c-api/init_config c PyInitConfig_AddModule}@anchor{25b}
@deffn {C Función} int PyInitConfig_AddModule (PyInitConfig *config, const char *name, PyObject *(*initfunc)(void))

Add a built-in extension module to the table of built-in modules.

The new module can be imported by the name `name', and uses the function
`initfunc' as the initialization function called on the first attempted
import.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.
@end itemize

If Python is initialized multiple times, @code{PyInitConfig_AddModule()} must
be called at each Python initialization.

Similar to the @ref{17ab,,PyImport_AppendInittab()} function.
@end deffn

@node Initialize Python,Ejemplo<17>,Module,PyInitConfig C API
@anchor{c-api/init_config initialize-python}@anchor{4d2c}
@subsubsection Initialize Python


@geindex Py_InitializeFromInitConfig (C function)
@anchor{c-api/init_config c Py_InitializeFromInitConfig}@anchor{25a}
@deffn {C Función} int Py_InitializeFromInitConfig (PyInitConfig *config)

Initialize Python from the initialization configuration.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an error in `config' and return @code{-1} on error.

@item 
Set an exit code in `config' and return @code{-1} if Python wants to
exit.
@end itemize

See @code{PyInitConfig_GetExitcode()} for the exit code case.
@end deffn

@node Ejemplo<17>,,Initialize Python,PyInitConfig C API
@anchor{c-api/init_config id1}@anchor{4d2d}
@subsubsection Ejemplo


Example initializing Python, set configuration options of various types,
return @code{-1} on error:

@example
int init_python(void)
@{
    PyInitConfig *config = PyInitConfig_Create();
    if (config == NULL) @{
        printf("PYTHON INIT ERROR: memory allocation failed\n");
        return -1;
    @}

    // Set an integer (dev mode)
    if (PyInitConfig_SetInt(config, "dev_mode", 1) < 0) @{
        goto error;
    @}

    // Set a list of UTF-8 strings (argv)
    char *argv[] = @{"my_program", "-c", "pass"@};
    if (PyInitConfig_SetStrList(config, "argv",
                                 Py_ARRAY_LENGTH(argv), argv) < 0) @{
        goto error;
    @}

    // Set a UTF-8 string (program name)
    if (PyInitConfig_SetStr(config, "program_name", L"my_program") < 0) @{
        goto error;
    @}

    // Initialize Python with the configuration
    if (Py_InitializeFromInitConfig(config) < 0) @{
        goto error;
    @}
    PyInitConfig_Free(config);
    return 0;

error:
    @{
        // Display the error message
        // This uncommon braces style is used, because you cannot make
        // goto targets point to variable declarations.
        const char *err_msg;
        (void)PyInitConfig_GetError(config, &err_msg);
        printf("PYTHON INIT ERROR: %s\n", err_msg);
        PyInitConfig_Free(config);

        return -1;
    @}
@}
@end example

@node Runtime Python configuration API,Py_GetArgcArgv,PyInitConfig C API,Configuración de inicialización de Python
@anchor{c-api/init_config runtime-python-configuration-api}@anchor{4d2e}
@subsection Runtime Python configuration API


The configuration option `name' parameter must be a non-NULL null-terminated
UTF-8 encoded string.

Some options are read from the @ref{d9,,sys} attributes. For example, the option
@code{"argv"} is read from @ref{12d2,,sys.argv}.

@geindex PyConfig_Get (C function)
@anchor{c-api/init_config c PyConfig_Get}@anchor{256}
@deffn {C Función} @ref{42d,,PyObject} *PyConfig_Get (const char *name)

Get the current runtime value of a configuration option as a Python object.


@itemize *

@item 
Return a new reference on success.

@item 
Set an exception and return @code{NULL} on error.
@end itemize

The object type depends on the configuration option. It can be:


@itemize *

@item 
@code{bool}

@item 
@code{int}

@item 
@code{str}

@item 
@code{list[str]}

@item 
@code{dict[str, str]}
@end itemize

The caller must hold the GIL. The function cannot be called before
Python initialization nor after Python finalization.


Added in version 3.14.

@end deffn

@geindex PyConfig_GetInt (C function)
@anchor{c-api/init_config c PyConfig_GetInt}@anchor{257}
@deffn {C Función} int PyConfig_GetInt (const char *name, int *value)

Similar to @ref{256,,PyConfig_Get()}, but get the value as a C int.


@itemize *

@item 
Return @code{0} on success.

@item 
Set an exception and return @code{-1} on error.
@end itemize


Added in version 3.14.

@end deffn

@geindex PyConfig_Names (C function)
@anchor{c-api/init_config c PyConfig_Names}@anchor{259}
@deffn {C Función} @ref{42d,,PyObject} *PyConfig_Names (void)

Get all configuration option names as a @code{frozenset}.


@itemize *

@item 
Return a new reference on success.

@item 
Set an exception and return @code{NULL} on error.
@end itemize

The caller must hold the GIL. The function cannot be called before
Python initialization nor after Python finalization.


Added in version 3.14.

@end deffn

@geindex PyConfig_Set (C function)
@anchor{c-api/init_config c PyConfig_Set}@anchor{258}
@deffn {C Función} int PyConfig_Set (const char *name, PyObject *value)

Set the current runtime value of a configuration option.


@itemize *

@item 
Raise a @ref{360,,ValueError} if there is no option `name'.

@item 
Raise a @ref{360,,ValueError} if `value' is an invalid value.

@item 
Raise a @ref{360,,ValueError} if the option is read-only (cannot be set).

@item 
Raise a @ref{228,,TypeError} if `value' has not the proper type.
@end itemize

The caller must hold the GIL. The function cannot be called before
Python initialization nor after Python finalization.


Added in version 3.14.

@end deffn

@node Py_GetArgcArgv,API Provisional Privada de Inicialización Multifásica,Runtime Python configuration API,Configuración de inicialización de Python
@anchor{c-api/init_config py-getargcargv}@anchor{4d2f}
@subsection Py_GetArgcArgv()


@geindex Py_GetArgcArgv (C function)
@anchor{c-api/init_config c Py_GetArgcArgv}@anchor{1960}
@deffn {C Función} void Py_GetArgcArgv (int *argc, wchar_t ***argv)

Obtiene los argumentos originales de la línea de comandos, antes de que Python los modificara.

Ver también el miembro @ref{92c,,PyConfig.orig_argv}.
@end deffn

@node API Provisional Privada de Inicialización Multifásica,,Py_GetArgcArgv,Configuración de inicialización de Python
@anchor{c-api/init_config multi-phase-initialization-private-provisional-api}@anchor{4d30}
@subsection API Provisional Privada de Inicialización Multifásica


This section is a private provisional API introducing multi-phase
initialization, the core feature of 
@geindex Python Enhancement Proposals; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/}:


@itemize *

@item 
Fase de inicialización «Core», «Python mínimo»:


@itemize *

@item 
Tipos incorporados;

@item 
Excepciones incorporadas;

@item 
Módulos incorporados y congelados;

@item 
El módulo @ref{d9,,sys} solo se inicializa parcialmente (por ejemplo @ref{27e,,sys.path} aún no existe).
@end itemize

@item 
Fase de inicialización «principal», Python está completamente inicializado:


@itemize *

@item 
Instala y configura @ref{77,,importlib};

@item 
Aplique la @ref{944,,Configuración de ruta};

@item 
Instala manejadores de señal;

@item 
Finaliza la inicialización del módulo @ref{d9,,sys} (por ejemplo: crea @ref{b61,,sys.stdout} y @ref{27e,,sys.path});

@item 
Habilita características opcionales como @ref{58,,faulthandler} y @ref{ff,,tracemalloc};

@item 
Importe el módulo @ref{c7,,site};

@item 
etc.
@end itemize
@end itemize

API provisional privada:


@itemize *

@item 
@code{PyConfig._init_main}: if set to @code{0},
@ref{4a6,,Py_InitializeFromConfig()} stops at the «Core» initialization phase.
@end itemize

@geindex _Py_InitializeMain (C function)
@anchor{c-api/init_config c _Py_InitializeMain}@anchor{4d31}
@deffn {C Función} @ref{a3f,,PyStatus} _Py_InitializeMain (void)

Vaya a la fase de inicialización «Principal», finalice la inicialización de Python.
@end deffn

No se importa ningún módulo durante la fase «Core» y el módulo @code{importlib} no está configurado: la @ref{944,,Configuración de ruta} solo se aplica durante la fase «Principal». Puede permitir personalizar Python en Python para anular o ajustar @ref{944,,Configuración de ruta}, tal vez instale un importador personalizado @ref{db2,,sys.meta_path} o un enlace de importación, etc.

It may become possible to calculate the @ref{944,,Path Configuration} in Python, after the Core phase and before the Main phase,
which is one of the 
@geindex Python Enhancement Proposals; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/} motivation.

La fase «Núcleo» no está definida correctamente: lo que debería estar y lo que no debería estar disponible en esta fase aún no se ha especificado. La API está marcada como privada y provisional: la API se puede modificar o incluso eliminar en cualquier momento hasta que se diseñe una API pública adecuada.

Ejemplo de ejecución de código Python entre las fases de inicialización «Core» y «Main»:

@example
void init_python(void)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);
    config._init_main = 0;

    /* ... customize 'config' configuration ... */

    status = Py_InitializeFromConfig(&config);
    PyConfig_Clear(&config);
    if (PyStatus_Exception(status)) @{
        Py_ExitStatusException(status);
    @}

    /* Use sys.stderr because sys.stdout is only created
       by _Py_InitializeMain() */
    int res = PyRun_SimpleString(
        "import sys; "
        "print('Run Python code before _Py_InitializeMain', "
               "file=sys.stderr)");
    if (res < 0) @{
        exit(1);
    @}

    /* ... put more configuration code here ... */

    status = _Py_InitializeMain();
    if (PyStatus_Exception(status)) @{
        Py_ExitStatusException(status);
    @}
@}
@end example

@node Gestión de la memoria,Soporte de implementación de objetos,Configuración de inicialización de Python,Manual de referencia de la API en C de Python
@anchor{c-api/memory doc}@anchor{4d32}@anchor{c-api/memory memory}@anchor{4d00}@anchor{c-api/memory memory-management}@anchor{4d33}
@section Gestión de la memoria


@menu
* Visión general:: 
* Dominios del asignador:: 
* Interfaz de memoria sin procesar:: 
* Interfaz de memoria:: 
* Asignadores de objetos:: 
* Asignadores de memoria predeterminados:: 
* Personalizar asignadores de memoria:: 
* Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python:: 
* El asignador pymalloc:: 
* The mimalloc allocator:: 
* tracemalloc C API:: 
* Ejemplos: Ejemplos<35>. 

@end menu

@node Visión general,Dominios del asignador,,Gestión de la memoria
@anchor{c-api/memory memoryoverview}@anchor{4d34}@anchor{c-api/memory overview}@anchor{4d35}
@subsection Visión general


La gestión de memoria en Python implica un montón privado que contiene todos los objetos de Python y estructuras de datos. El `administrador de memoria de Python' garantiza internamente la gestión de este montón privado. El administrador de memoria de Python tiene diferentes componentes que se ocupan de varios aspectos de la gestión dinámica del almacenamiento, como compartir, segmentación, asignación previa o almacenamiento en caché.

En el nivel más bajo, un asignador de memoria sin procesar asegura que haya suficiente espacio en el montón privado para almacenar todos los datos relacionados con Python al interactuar con el administrador de memoria del sistema operativo. Además del asignador de memoria sin procesar, varios asignadores específicos de objeto operan en el mismo montón e implementan políticas de administración de memoria distintas adaptadas a las peculiaridades de cada tipo de objeto. Por ejemplo, los objetos enteros se administran de manera diferente dentro del montón que las cadenas, tuplas o diccionarios porque los enteros implican diferentes requisitos de almacenamiento y compensaciones de velocidad / espacio. El administrador de memoria de Python delega parte del trabajo a los asignadores específicos de objeto, pero asegura que este último opere dentro de los límites del montón privado.

Es importante comprender que la gestión del montón de Python la realiza el propio intérprete y que el usuario no tiene control sobre él, incluso si manipulan regularmente punteros de objetos a bloques de memoria dentro de ese montón. El administrador de memoria de Python realiza la asignación de espacio de almacenamiento dinámico para los objetos de Python y otros búferes internos a pedido a través de las funciones de API de Python/C enumeradas en este documento.

@geindex malloc (C function)
@geindex calloc (C function)
@geindex realloc (C function)
@geindex free (C function)

Para evitar daños en la memoria, los escritores de extensiones nunca deberían intentar operar en objetos Python con las funciones exportadas por la biblioteca C: @code{malloc()}, @code{calloc()}, @code{realloc()} y @code{free()}. Esto dará como resultado llamadas mixtas entre el asignador de C y el administrador de memoria de Python con consecuencias fatales, ya que implementan diferentes algoritmos y operan en diferentes montones. Sin embargo, uno puede asignar y liberar de forma segura bloques de memoria con el asignador de la biblioteca C para fines individuales, como se muestra en el siguiente ejemplo:

@example
PyObject *res;
char *buf = (char *) malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
...Do some I/O operation involving buf...
res = PyBytes_FromString(buf);
free(buf); /* malloc'ed */
return res;
@end example

En este ejemplo, la solicitud de memoria para el búfer de E/S es manejada por el asignador de la biblioteca C. El administrador de memoria de Python solo participa en la asignación del objeto de bytes retornado como resultado.

Sin embargo, en la mayoría de las situaciones, se recomienda asignar memoria del montón de Python específicamente porque este último está bajo el control del administrador de memoria de Python. Por ejemplo, esto es necesario cuando el intérprete se amplía con nuevos tipos de objetos escritos en C. Otra razón para usar el montón de Python es el deseo de `informar' al administrador de memoria de Python sobre las necesidades de memoria del módulo de extensión. Incluso cuando la memoria solicitada se usa exclusivamente para fines internos y altamente específicos, delegar todas las solicitudes de memoria al administrador de memoria de Python hace que el intérprete tenga una imagen más precisa de su huella de memoria en su conjunto. En consecuencia, bajo ciertas circunstancias, el administrador de memoria de Python puede o no desencadenar acciones apropiadas, como recolección de basura, compactación de memoria u otros procedimientos preventivos. Tenga en cuenta que al usar el asignador de la biblioteca C como se muestra en el ejemplo anterior, la memoria asignada para el búfer de E/S escapa completamente al administrador de memoria Python.


@subsubheading Ver también


La variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} puede usarse para configurar los asignadores de memoria utilizados por Python.

La variable de entorno 
@geindex PYTHONMALLOCSTATS
@geindex variables de entorno; PYTHONMALLOCSTATS
@ref{1b5d,,PYTHONMALLOCSTATS} se puede utilizar para imprimir estadísticas de @ref{d96,,asignador de memoria pymalloc} cada vez que se crea un nuevo escenario de objetos pymalloc, y en el apagado.


@node Dominios del asignador,Interfaz de memoria sin procesar,Visión general,Gestión de la memoria
@anchor{c-api/memory allocator-domains}@anchor{4d36}
@subsection Dominios del asignador

@anchor{c-api/memory id1}@anchor{4d37}
All allocating functions belong to one of three different «domains» (see also
@ref{4d38,,PyMemAllocatorDomain}). These domains represent different allocation
strategies and are optimized for different purposes. The specific details on
how every domain allocates memory or what internal functions each domain calls
is considered an implementation detail, but for debugging purposes a simplified
table can be found at @ref{1d56,,here}.
The APIs used to allocate and free a block of memory must be from the same domain.
For example, @ref{1482,,PyMem_Free()} must be used to free memory allocated using @ref{cee,,PyMem_Malloc()}.

Los tres dominios de asignación son:


@itemize *

@item 
Raw domain: intended for allocating memory for general-purpose memory
buffers where the allocation `must' go to the system allocator or where the
allocator can operate without the @ref{2c5,,GIL}. The memory is requested directly
from the system. See @ref{4d39,,Raw Memory Interface}.

@item 
«Mem» domain: intended for allocating memory for Python buffers and
general-purpose memory buffers where the allocation must be performed with
the @ref{2c5,,GIL} held. The memory is taken from the Python private heap.
See @ref{4d3a,,Memory Interface}.

@item 
Object domain: intended for allocating memory for Python objects. The
memory is taken from the Python private heap. See @ref{4d3b,,Object allocators}.
@end itemize

@cartouche
@quotation Nota 
The @ref{43ec,,free-threaded} build requires that only Python objects are allocated using the «object» domain
and that all Python objects are allocated using that domain. This differs from the prior Python versions,
where this was only a best practice and not a hard requirement.

For example, buffers (non-Python objects) should be allocated using @ref{cee,,PyMem_Malloc()},
@ref{482,,PyMem_RawMalloc()}, or @code{malloc()}, but not @ref{cf0,,PyObject_Malloc()}.

See @ref{4d3c,,Memory Allocation APIs}.
@end quotation
@end cartouche

@node Interfaz de memoria sin procesar,Interfaz de memoria,Dominios del asignador,Gestión de la memoria
@anchor{c-api/memory raw-memory-interface}@anchor{4d3d}@anchor{c-api/memory raw-memoryinterface}@anchor{4d39}
@subsection Interfaz de memoria sin procesar


Los siguientes conjuntos de funciones son envoltorios para el asignador del sistema. Estas funciones son seguras para subprocesos, no es necesario mantener el @ref{2b5,,GIL}.

The @ref{1d56,,default raw memory allocator} uses
the following functions: @code{malloc()}, @code{calloc()}, @code{realloc()}
and @code{free()}; call @code{malloc(1)} (or @code{calloc(1, 1)}) when requesting
zero bytes.


Added in version 3.4.


@geindex PyMem_RawMalloc (C function)
@anchor{c-api/memory c PyMem_RawMalloc}@anchor{482}
@deffn {C Función} void *PyMem_RawMalloc (size_t n)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Asigna `n' bytes y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla.

Solicitar cero bytes retorna un puntero distinto que no sea @code{NULL} si es posible, como si en su lugar se hubiera llamado a @code{PyMem_RawMalloc(1)}. La memoria no se habrá inicializado de ninguna manera.
@end deffn

@geindex PyMem_RawCalloc (C function)
@anchor{c-api/memory c PyMem_RawCalloc}@anchor{483}
@deffn {C Función} void *PyMem_RawCalloc (size_t nelem, size_t elsize)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Asigna `nelem' elementos cada uno cuyo tamaño en bytes es `elsize' y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla. La memoria se inicializa a ceros.

Solicitar elementos cero o elementos de tamaño cero bytes retorna un puntero distinto @code{NULL} si es posible, como si en su lugar se hubiera llamado @code{PyMem_RawCalloc(1, 1)}.


Added in version 3.5.

@end deffn

@geindex PyMem_RawRealloc (C function)
@anchor{c-api/memory c PyMem_RawRealloc}@anchor{484}
@deffn {C Función} void *PyMem_RawRealloc (void *p, size_t n)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Cambia el tamaño del bloque de memoria señalado por `p' a `n' bytes. Los contenidos no se modificarán al mínimo de los tamaños antiguo y nuevo.

Si `p' es @code{NULL}, la llamada es equivalente a @code{PyMem_RawMalloc(n)}; de lo contrario, si `n' es igual a cero, el bloque de memoria cambia de tamaño pero no se libera, y el puntero retornado no es @code{NULL}.

A menos que `p' sea @code{NULL}, debe haber sido retornado por una llamada previa a @ref{482,,PyMem_RawMalloc()}, @ref{484,,PyMem_RawRealloc()} o @ref{483,,PyMem_RawCalloc()}.

Si la solicitud falla, @ref{484,,PyMem_RawRealloc()} retorna @code{NULL} y `p' sigue siendo un puntero válido al área de memoria anterior.
@end deffn

@geindex PyMem_RawFree (C function)
@anchor{c-api/memory c PyMem_RawFree}@anchor{485}
@deffn {C Función} void PyMem_RawFree (void *p)
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Libera el bloque de memoria al que apunta `p', que debe haber sido retornado por una llamada anterior a @ref{482,,PyMem_RawMalloc()}, @ref{484,,PyMem_RawRealloc()} o @ref{483,,PyMem_RawCalloc()}. De lo contrario, o si se ha llamado antes a @code{PyMem_RawFree(p)}, se produce un comportamiento indefinido.

Si `p' es @code{NULL}, no se realiza ninguna operación.
@end deffn

@node Interfaz de memoria,Asignadores de objetos,Interfaz de memoria sin procesar,Gestión de la memoria
@anchor{c-api/memory memory-interface}@anchor{4d3e}@anchor{c-api/memory memoryinterface}@anchor{4d3a}
@subsection Interfaz de memoria


Los siguientes conjuntos de funciones, modelados según el estándar ANSI C, pero que especifican el comportamiento cuando se solicitan cero bytes, están disponibles para asignar y liberar memoria del montón de Python.

El @ref{1d56,,asignador de memoria predeterminado} usa el @ref{d96,,asignador de memorya pymalloc}.

@cartouche
@quotation Advertencia 
El @ref{2b5,,GIL} debe mantenerse cuando se utilizan estas funciones.
@end quotation
@end cartouche


Distinto en la versión 3.6: El asignador predeterminado ahora es pymalloc en lugar del @code{malloc()} del sistema.


@geindex PyMem_Malloc (C function)
@anchor{c-api/memory c PyMem_Malloc}@anchor{cee}
@deffn {C Función} void *PyMem_Malloc (size_t n)
` Part of the @ref{5f6,,Stable ABI}.'
Asigna `n' bytes y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla.

Solicitar cero bytes retorna un puntero distinto que no sea @code{NULL} si es posible, como si en su lugar se hubiera llamado a @code{PyMem_Malloc(1)}. La memoria no se habrá inicializado de ninguna manera.
@end deffn

@geindex PyMem_Calloc (C function)
@anchor{c-api/memory c PyMem_Calloc}@anchor{f2e}
@deffn {C Función} void *PyMem_Calloc (size_t nelem, size_t elsize)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Asigna `nelem' elementos cada uno cuyo tamaño en bytes es `elsize' y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla. La memoria se inicializa a ceros.

Solicitar elementos cero o elementos de tamaño cero bytes retorna un puntero distinto @code{NULL} si es posible, como si en su lugar se hubiera llamado @code{PyMem_Calloc(1, 1)}.


Added in version 3.5.

@end deffn

@geindex PyMem_Realloc (C function)
@anchor{c-api/memory c PyMem_Realloc}@anchor{10ae}
@deffn {C Función} void *PyMem_Realloc (void *p, size_t n)
` Part of the @ref{5f6,,Stable ABI}.'
Cambia el tamaño del bloque de memoria señalado por `p' a `n' bytes. Los contenidos no se modificarán al mínimo de los tamaños antiguo y nuevo.

Si `p' es @code{NULL}, la llamada es equivalente a @code{PyMem_Malloc(n)}; de lo contrario, si `n' es igual a cero, el bloque de memoria cambia de tamaño pero no se libera, y el puntero retornado no es @code{NULL}.

A menos que `p' sea @code{NULL}, debe haber sido retornado por una llamada previa a @ref{cee,,PyMem_Malloc()}, @ref{10ae,,PyMem_Realloc()} o @ref{f2e,,PyMem_Calloc()}.

Si la solicitud falla, @ref{10ae,,PyMem_Realloc()} retorna @code{NULL} y `p' sigue siendo un puntero válido al área de memoria anterior.
@end deffn

@geindex PyMem_Free (C function)
@anchor{c-api/memory c PyMem_Free}@anchor{1482}
@deffn {C Función} void PyMem_Free (void *p)
` Part of the @ref{5f6,,Stable ABI}.'
Libera el bloque de memoria señalado por `p', que debe haber sido retornado por una llamada anterior a @ref{cee,,PyMem_Malloc()}, @ref{10ae,,PyMem_Realloc()} o @ref{f2e,,PyMem_Calloc()}. De lo contrario, o si se ha llamado antes a @code{PyMem_Free(p)}, se produce un comportamiento indefinido.

Si `p' es @code{NULL}, no se realiza ninguna operación.
@end deffn

Las siguientes macros orientadas a tipos se proporcionan por conveniencia. Tenga en cuenta que `TYPE' se refiere a cualquier tipo de C.

@geindex PyMem_New (C macro)
@anchor{c-api/memory c PyMem_New}@anchor{1565}
@deffn {C Macro} PyMem_New (TYPE, n)

Same as @ref{cee,,PyMem_Malloc()}, but allocates @code{(n * sizeof(TYPE))} bytes of
memory.  Returns a pointer cast to @code{TYPE*}.  The memory will not have
been initialized in any way.
@end deffn

@geindex PyMem_Resize (C macro)
@anchor{c-api/memory c PyMem_Resize}@anchor{4d3f}
@deffn {C Macro} PyMem_Resize (p, TYPE, n)

Same as @ref{10ae,,PyMem_Realloc()}, but the memory block is resized to @code{(n *
sizeof(TYPE))} bytes.  Returns a pointer cast to @code{TYPE*}. On return,
`p' will be a pointer to the new memory area, or @code{NULL} in the event of
failure.

Esta es una macro de preprocesador C; `p' siempre se reasigna. Guarde el valor original de `p' para evitar perder memoria al manejar errores.
@end deffn

@geindex PyMem_Del (C function)
@anchor{c-api/memory c PyMem_Del}@anchor{1566}
@deffn {C Función} void PyMem_Del (void *p)

La misma que @ref{1482,,PyMem_Free()}.
@end deffn

Además, se proporcionan los siguientes conjuntos de macros para llamar al asignador de memoria de Python directamente, sin involucrar las funciones de API de C mencionadas anteriormente. Sin embargo, tenga en cuenta que su uso no conserva la compatibilidad binaria entre las versiones de Python y, por lo tanto, está en desuso en los módulos de extensión.


@itemize *

@item 
@code{PyMem_MALLOC(size)}

@item 
@code{PyMem_NEW(type, size)}

@item 
@code{PyMem_REALLOC(ptr, size)}

@item 
@code{PyMem_RESIZE(ptr, type, size)}

@item 
@code{PyMem_FREE(ptr)}

@item 
@code{PyMem_DEL(ptr)}
@end itemize

@node Asignadores de objetos,Asignadores de memoria predeterminados,Interfaz de memoria,Gestión de la memoria
@anchor{c-api/memory object-allocators}@anchor{4d40}@anchor{c-api/memory objectinterface}@anchor{4d3b}
@subsection Asignadores de objetos


Los siguientes conjuntos de funciones, modelados según el estándar ANSI C, pero que especifican el comportamiento cuando se solicitan cero bytes, están disponibles para asignar y liberar memoria del montón de Python.

@cartouche
@quotation Nota 
No hay garantía de que la memoria retornada por estos asignadores se pueda convertir con éxito en un objeto Python al interceptar las funciones de asignación en este dominio mediante los métodos descritos en la sección @ref{4d41,,Personalizar Asignadores de Memoria}.
@end quotation
@end cartouche

El @ref{1d56,,asignador predeterminado de objetos} usa el @ref{d96,,asignador de memoria pymalloc}.

@cartouche
@quotation Advertencia 
El @ref{2b5,,GIL} debe mantenerse cuando se utilizan estas funciones.
@end quotation
@end cartouche

@geindex PyObject_Malloc (C function)
@anchor{c-api/memory c PyObject_Malloc}@anchor{cf0}
@deffn {C Función} void *PyObject_Malloc (size_t n)
` Part of the @ref{5f6,,Stable ABI}.'
Asigna `n' bytes y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla.

Solicitar cero bytes retorna un puntero distinto que no sea @code{NULL} si es posible, como si en su lugar se hubiera llamado a @code{PyObject_Malloc(1)}. La memoria no se habrá inicializado de ninguna manera.
@end deffn

@geindex PyObject_Calloc (C function)
@anchor{c-api/memory c PyObject_Calloc}@anchor{f2f}
@deffn {C Función} void *PyObject_Calloc (size_t nelem, size_t elsize)
` Part of the @ref{5f6,,Stable ABI} since version 3.7.'
Asigna `nelem' elementos cada uno cuyo tamaño en bytes es `elsize' y retorna un puntero de tipo void* a la memoria asignada, o @code{NULL} si la solicitud falla. La memoria se inicializa a ceros.

Solicitar elementos cero o elementos de tamaño cero bytes retorna un puntero distinto @code{NULL} si es posible, como si en su lugar se hubiera llamado @code{PyObject_Calloc(1, 1)}.


Added in version 3.5.

@end deffn

@geindex PyObject_Realloc (C function)
@anchor{c-api/memory c PyObject_Realloc}@anchor{1483}
@deffn {C Función} void *PyObject_Realloc (void *p, size_t n)
` Part of the @ref{5f6,,Stable ABI}.'
Cambia el tamaño del bloque de memoria señalado por `p' a `n' bytes. Los contenidos no se modificarán al mínimo de los tamaños antiguo y nuevo.

Si `p' es @code{NULL}, la llamada es equivalente a @code{PyObject_Malloc(n)}; de lo contrario, si `n' es igual a cero, el bloque de memoria cambia de tamaño pero no se libera, y el puntero retornado no es @code{NULL}.

A menos que `p' sea @code{NULL}, debe haber sido retornado por una llamada previa a @ref{cf0,,PyObject_Malloc()}, @ref{1483,,PyObject_Realloc()} o @ref{f2f,,PyObject_Calloc()}.

Si la solicitud falla, @ref{1483,,PyObject_Realloc()} retorna @code{NULL} y `p' sigue siendo un puntero válido al área de memoria anterior.
@end deffn

@geindex PyObject_Free (C function)
@anchor{c-api/memory c PyObject_Free}@anchor{ced}
@deffn {C Función} void PyObject_Free (void *p)
` Part of the @ref{5f6,,Stable ABI}.'
Libera el bloque de memoria al que apunta `p', que debe haber sido retornado por una llamada anterior a @ref{cf0,,PyObject_Malloc()}, @ref{1483,,PyObject_Realloc()} o @ref{f2f,,PyObject_Calloc()}. De lo contrario, o si se ha llamado antes a @code{PyObject_Free(p)}, se produce un comportamiento indefinido.

Si `p' es @code{NULL}, no se realiza ninguna operación.
@end deffn

@node Asignadores de memoria predeterminados,Personalizar asignadores de memoria,Asignadores de objetos,Gestión de la memoria
@anchor{c-api/memory default-memory-allocators}@anchor{1d56}@anchor{c-api/memory id2}@anchor{4d42}
@subsection Asignadores de memoria predeterminados


Asignadores de memoria predeterminados:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Configuración

@tab

Nombre

@tab

PyMem_RawMalloc

@tab

PyMem_Malloc

@tab

PyObject_Malloc

@item

Lanzamiento de compilación

@tab

@code{"pymalloc"}

@tab

@code{malloc}

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@item

Compilación de depuración

@tab

@code{"pymalloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{pymalloc} + debug

@tab

@code{pymalloc} + debug

@item

Lanzamiento de compilación, sin pymalloc

@tab

@code{"malloc"}

@tab

@code{malloc}

@tab

@code{malloc}

@tab

@code{malloc}

@item

Compilación de depuración, sin pymalloc

@tab

@code{"malloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@end multitable


Leyenda:


@itemize *

@item 
Nombre: valor para variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC}.

@item 
@code{malloc}: asignadores del sistema de la biblioteca C estándar, funciones C: @code{malloc()}, @code{calloc()}, @code{realloc()} y @code{free()}.

@item 
@code{pymalloc}: @ref{d96,,asignador de memoria pymalloc}.

@item 
@code{mimalloc}: @ref{1d58,,mimalloc memory allocator}.  The pymalloc
allocator will be used if mimalloc support isn’t available.

@item 
«+ debug»: con @ref{1d59,,enlaces de depuración en los asignadores de memoria de Python}.

@item 
«Debug build»: @ref{357,,Compilación de Python en modo de depuración}.
@end itemize

@node Personalizar asignadores de memoria,Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python,Asignadores de memoria predeterminados,Gestión de la memoria
@anchor{c-api/memory customize-memory-allocators}@anchor{4d41}@anchor{c-api/memory id3}@anchor{4d43}
@subsection Personalizar asignadores de memoria



Added in version 3.4.


@geindex PyMemAllocatorEx (C type)
@anchor{c-api/memory c PyMemAllocatorEx}@anchor{f4f}
@deffn {C Tipo} type PyMemAllocatorEx

Estructura utilizada para describir un asignador de bloque de memoria. La estructura tiene cuatro campos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Campo

@tab

Significado

@item

@code{void *ctx}

@tab

contexto de usuario pasado como primer argumento

@item

@code{void* malloc(void *ctx, size_t size)}

@tab

asignar un bloque de memoria

@item

@code{void* calloc(void *ctx, size_t nelem, size_t elsize)}

@tab

asignar un bloque de memoria inicializado con ceros

@item

@code{void* realloc(void *ctx, void *ptr, size_t new_size)}

@tab

asignar o cambiar el tamaño de un bloque de memoria

@item

@code{void free(void *ctx, void *ptr)}

@tab

liberar un bloque de memoria

@end multitable



Distinto en la versión 3.5: The @code{PyMemAllocator} structure was renamed to
@ref{f4f,,PyMemAllocatorEx} and a new @code{calloc} field was added.

@end deffn

@geindex PyMemAllocatorDomain (C type)
@anchor{c-api/memory c PyMemAllocatorDomain}@anchor{4d38}
@deffn {C Tipo} type PyMemAllocatorDomain

Enum se utiliza para identificar un dominio asignador. Dominios:

@geindex PYMEM_DOMAIN_RAW (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_RAW}@anchor{1d57}
@deffn {C Macro} PYMEM_DOMAIN_RAW

Funciones:


@itemize *

@item 
@ref{482,,PyMem_RawMalloc()}

@item 
@ref{484,,PyMem_RawRealloc()}

@item 
@ref{483,,PyMem_RawCalloc()}

@item 
@ref{485,,PyMem_RawFree()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_MEM (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_MEM}@anchor{cf1}
@deffn {C Macro} PYMEM_DOMAIN_MEM

Funciones:


@itemize *

@item 
@ref{cee,,PyMem_Malloc()},

@item 
@ref{10ae,,PyMem_Realloc()}

@item 
@ref{f2e,,PyMem_Calloc()}

@item 
@ref{1482,,PyMem_Free()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_OBJ (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_OBJ}@anchor{cef}
@deffn {C Macro} PYMEM_DOMAIN_OBJ

Funciones:


@itemize *

@item 
@ref{cf0,,PyObject_Malloc()}

@item 
@ref{1483,,PyObject_Realloc()}

@item 
@ref{f2f,,PyObject_Calloc()}

@item 
@ref{ced,,PyObject_Free()}
@end itemize
@end deffn
@end deffn

@geindex PyMem_GetAllocator (C function)
@anchor{c-api/memory c PyMem_GetAllocator}@anchor{4cb0}
@deffn {C Función} void PyMem_GetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

Obtenga el asignador de bloque de memoria del dominio especificado.
@end deffn

@geindex PyMem_SetAllocator (C function)
@anchor{c-api/memory c PyMem_SetAllocator}@anchor{62e}
@deffn {C Función} void PyMem_SetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

Establece el asignador de bloque de memoria del dominio especificado.

El nuevo asignador debe retornar un puntero distinto @code{NULL} al solicitar cero bytes.

For the @ref{1d57,,PYMEM_DOMAIN_RAW} domain, the allocator must be
thread-safe: the @ref{2b5,,GIL} is not held when the
allocator is called.

For the remaining domains, the allocator must also be thread-safe:
the allocator may be called in different interpreters that do not
share a @code{GIL}.

Si el nuevo asignador no es un enlace (no llama al asignador anterior), se debe llamar a la función @ref{cf2,,PyMem_SetupDebugHooks()} para reinstalar los enlaces de depuración en la parte superior del nuevo asignador.

Vea también @ref{4cff,,PyPreConfig.allocator} y @ref{3c68,,Preinicialización de Python con PyPreConfig}.

@cartouche
@quotation Advertencia 
@ref{62e,,PyMem_SetAllocator()} does have the following contract:


@itemize *

@item 
It can be called after @ref{4cc,,Py_PreInitialize()} and before
@ref{4a6,,Py_InitializeFromConfig()} to install a custom memory
allocator. There are no restrictions over the installed allocator
other than the ones imposed by the domain (for instance, the Raw
Domain allows the allocator to be called without the GIL held). See
@ref{4d37,,the section on allocator domains} for more
information.

@item 
If called after Python has finish initializing (after
@ref{4a6,,Py_InitializeFromConfig()} has been called) the allocator
`must' wrap the existing allocator. Substituting the current
allocator for some other arbitrary one is `not supported'.
@end itemize
@end quotation
@end cartouche


Distinto en la versión 3.12: All allocators must be thread-safe.

@end deffn

@geindex PyMem_SetupDebugHooks (C function)
@anchor{c-api/memory c PyMem_SetupDebugHooks}@anchor{cf2}
@deffn {C Función} void PyMem_SetupDebugHooks (void)

Configurar @ref{1d59,,enlaces de depuración en los asignadores de memoria de Python} para detectar errores de memoria.
@end deffn

@node Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python,El asignador pymalloc,Personalizar asignadores de memoria,Gestión de la memoria
@anchor{c-api/memory debug-hooks-on-the-python-memory-allocators}@anchor{4d44}@anchor{c-api/memory pymem-debug-hooks}@anchor{1d59}
@subsection Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python


Cuando @ref{357,,Python está construido en modo de depuración}, la función @ref{cf2,,PyMem_SetupDebugHooks()} se llama en @ref{3c68,,Preinicialización de Python} para configurar los enlaces de depuración en Python asignadores de memoria para detectar errores de memoria.

La variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} se puede utilizar para instalar enlaces de depuración en un Python compilado en modo de lanzamiento (por ejemplo: @code{PYTHONMALLOC=debug}).

La función @ref{cf2,,PyMem_SetupDebugHooks()} se puede utilizar para establecer enlaces de depuración después de llamar a @ref{62e,,PyMem_SetAllocator()}.

Estos enlaces de depuración llenan bloques de memoria asignados dinámicamente con patrones de bits especiales y reconocibles. La memoria recién asignada se llena con el byte @code{0xCD} (@code{PYMEM_CLEANBYTE}), la memoria liberada se llena con el byte @code{0xDD} (@code{PYMEM_DEADBYTE}). Los bloques de memoria están rodeados por «bytes prohibidos» rellenos con el byte @code{0xFD} (@code{PYMEM_FORBIDDENBYTE}). Es poco probable que las cadenas de estos bytes sean direcciones válidas, flotantes o cadenas ASCII.

Verificaciones de tiempo de ejecución:


@itemize -

@item 
Detecte violaciones de API, por ejemplo: @ref{ced,,PyObject_Free()} llamado en un búfer asignado por @ref{cee,,PyMem_Malloc()}.

@item 
Detectar escritura antes del inicio del búfer (desbordamiento del búfer)

@item 
Detectar escritura después del final del búfer (desbordamiento del búfer)

@item 
Check that the @ref{2b5,,GIL} is held when
allocator functions of @ref{cef,,PYMEM_DOMAIN_OBJ} (ex:
@ref{cf0,,PyObject_Malloc()}) and @ref{cf1,,PYMEM_DOMAIN_MEM} (ex:
@ref{cee,,PyMem_Malloc()}) domains are called.
@end itemize

En caso de error, los enlaces de depuración usan el módulo @ref{ff,,tracemalloc} para obtener el rastreo donde se asignó un bloque de memoria. El rastreo solo se muestra si @ref{ff,,tracemalloc} rastrea las asignaciones de memoria de Python y se rastrea el bloque de memoria.

Sea `S' = @code{sizeof(size_t)}. Se agregan @code{2*S} bytes en cada extremo de cada bloque de `N' bytes solicitados. El diseño de la memoria es así, donde p representa la dirección retornada por una función similar a malloc o realloc (@code{p[i:j]} significa el segmento de bytes de @code{*(p+i)} inclusive hasta @code{*(p+j)} exclusivo; tenga en cuenta que el tratamiento de los índices negativos difiere de un segmento de Python):


@table @asis

@item @code{p[-2*S:-S]}

Número de bytes solicitados originalmente. Este es un size_t, big-endian (más fácil de leer en un volcado de memoria).

@item @code{p[-S]}

Identificador de API (carácter ASCII):


@itemize *

@item 
@code{'r'} for @ref{1d57,,PYMEM_DOMAIN_RAW}.

@item 
@code{'m'} for @ref{cf1,,PYMEM_DOMAIN_MEM}.

@item 
@code{'o'} for @ref{cef,,PYMEM_DOMAIN_OBJ}.
@end itemize

@item @code{p[-S+1:0]}

Copias de PYMEM_FORBIDDENBYTE. Se utiliza para detectar suscripciones y lecturas.

@item @code{p[0:N]}

La memoria solicitada, llena de copias de PYMEM_CLEANBYTE, utilizada para capturar la referencia a la memoria no inicializada. Cuando se llama a una función similar a realloc solicitando un bloque de memoria más grande, los nuevos bytes en exceso también se llenan con PYMEM_CLEANBYTE. Cuando se llama a una función de tipo free, se sobrescriben con PYMEM_DEADBYTE, para captar la referencia a la memoria liberada. Cuando se llama a una función similar a la realloc solicitando un bloque de memoria más pequeño, los bytes antiguos sobrantes también se llenan con PYMEM_DEADBYTE.

@item @code{p[N:N+S]}

Copias de PYMEM_FORBIDDENBYTE. Se utiliza para detectar sobrescrituras y lecturas.

@item @code{p[N+S:N+2*S]}

Solo se utiliza si la macro @code{PYMEM_DEBUG_SERIALNO} está definida (no definida por defecto).

A serial number, incremented by 1 on each call to a malloc-like or
realloc-like function.  Big-endian @code{size_t}.  If «bad memory» is detected
later, the serial number gives an excellent way to set a breakpoint on the
next run, to capture the instant at which this block was passed out.  The
static function bumpserialno() in obmalloc.c is the only place the serial
number is incremented, and exists so you can set such a breakpoint easily.
@end table

Una función de tipo realloc o de tipo free primero verifica que los bytes PYMEM_FORBIDDENBYTE en cada extremo estén intactos. Si se han modificado, la salida de diagnóstico se escribe en stderr y el programa se aborta mediante Py_FatalError(). El otro modo de falla principal es provocar un error de memoria cuando un programa lee uno de los patrones de bits especiales e intenta usarlo como una dirección. Si ingresa a un depurador y observa el objeto, es probable que vea que está completamente lleno de PYMEM_DEADBYTE (lo que significa que se está usando la memoria liberada) o PYMEM_CLEANBYTE (que significa que se está usando la memoria no inicializada).


Distinto en la versión 3.6: The @ref{cf2,,PyMem_SetupDebugHooks()} function now also works on Python
compiled in release mode.  On error, the debug hooks now use
@ref{ff,,tracemalloc} to get the traceback where a memory block was allocated.
The debug hooks now also check if the GIL is held when functions of
@ref{cef,,PYMEM_DOMAIN_OBJ} and @ref{cf1,,PYMEM_DOMAIN_MEM} domains are
called.



Distinto en la versión 3.8: Los patrones de bytes @code{0xCB} (@code{PYMEM_CLEANBYTE}), @code{0xDB} (@code{PYMEM_DEADBYTE}) y @code{0xFB} (@code{PYMEM_FORBIDDENBYTE}) se han reemplazado por @code{0xCD}, @code{0xDD} y @code{0xFD} para usar los mismos valores que la depuración de Windows CRT @code{malloc()} y @code{free()}.


@node El asignador pymalloc,The mimalloc allocator,Configurar enlaces para detectar errores en las funciones del asignador de memoria de Python,Gestión de la memoria
@anchor{c-api/memory pymalloc}@anchor{d96}@anchor{c-api/memory the-pymalloc-allocator}@anchor{4d45}
@subsection El asignador pymalloc


Python has a `pymalloc' allocator optimized for small objects (smaller or equal
to 512 bytes) with a short lifetime. It uses memory mappings called «arenas»
with a fixed size of either 256 KiB on 32-bit platforms or 1 MiB on 64-bit
platforms. It falls back to @ref{482,,PyMem_RawMalloc()} and
@ref{484,,PyMem_RawRealloc()} for allocations larger than 512 bytes.

`pymalloc' is the @ref{1d56,,default allocator} of the
@ref{cf1,,PYMEM_DOMAIN_MEM} (ex: @ref{cee,,PyMem_Malloc()}) and
@ref{cef,,PYMEM_DOMAIN_OBJ} (ex: @ref{cf0,,PyObject_Malloc()}) domains.

El asignador de arena utiliza las siguientes funciones:


@itemize *

@item 
@code{VirtualAlloc()} and @code{VirtualFree()} on Windows,

@item 
@code{mmap()} and @code{munmap()} if available,

@item 
@code{malloc()} y @code{free()} en caso contrario.
@end itemize

Este asignador está deshabilitado si Python está configurado con la opción @ref{1db3,,--without-pymalloc}. También se puede deshabilitar en tiempo de ejecución usando la variable de entorno 
@geindex PYTHONMALLOC
@geindex variables de entorno; PYTHONMALLOC
@ref{cec,,PYTHONMALLOC} (por ejemplo: @code{PYTHONMALLOC=malloc}).

@menu
* Personalizar asignador de arena de pymalloc:: 

@end menu

@node Personalizar asignador de arena de pymalloc,,,El asignador pymalloc
@anchor{c-api/memory customize-pymalloc-arena-allocator}@anchor{4d46}
@subsubsection Personalizar asignador de arena de pymalloc



Added in version 3.4.


@geindex PyObjectArenaAllocator (C type)
@anchor{c-api/memory c PyObjectArenaAllocator}@anchor{4d47}
@deffn {C Tipo} type PyObjectArenaAllocator

Estructura utilizada para describir un asignador de arena. La estructura tiene tres campos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Campo

@tab

Significado

@item

@code{void *ctx}

@tab

contexto de usuario pasado como primer argumento

@item

@code{void* alloc(void *ctx, size_t size)}

@tab

asignar una arena de bytes de tamaño

@item

@code{void free(void *ctx, void *ptr, size_t size)}

@tab

liberar la arena

@end multitable

@end deffn

@geindex PyObject_GetArenaAllocator (C function)
@anchor{c-api/memory c PyObject_GetArenaAllocator}@anchor{4cb1}
@deffn {C Función} void PyObject_GetArenaAllocator (PyObjectArenaAllocator *allocator)

Consigue el asignador de arena.
@end deffn

@geindex PyObject_SetArenaAllocator (C function)
@anchor{c-api/memory c PyObject_SetArenaAllocator}@anchor{4caf}
@deffn {C Función} void PyObject_SetArenaAllocator (PyObjectArenaAllocator *allocator)

Establecer el asignador de arena.
@end deffn

@node The mimalloc allocator,tracemalloc C API,El asignador pymalloc,Gestión de la memoria
@anchor{c-api/memory mimalloc}@anchor{1d58}@anchor{c-api/memory the-mimalloc-allocator}@anchor{4d48}
@subsection The mimalloc allocator



Added in version 3.13.


Python supports the mimalloc allocator when the underlying platform support is available.
mimalloc «is a general purpose allocator with excellent performance characteristics.
Initially developed by Daan Leijen for the runtime systems of the Koka and Lean languages.»

@node tracemalloc C API,Ejemplos<35>,The mimalloc allocator,Gestión de la memoria
@anchor{c-api/memory tracemalloc-c-api}@anchor{4d49}
@subsection tracemalloc C API



Added in version 3.7.


@geindex PyTraceMalloc_Track (C function)
@anchor{c-api/memory c PyTraceMalloc_Track}@anchor{c3e}
@deffn {C Función} int PyTraceMalloc_Track (unsigned int domain, uintptr_t ptr, size_t size)

Rastree un bloque de memoria asignado en el módulo @ref{ff,,tracemalloc}.

Retorna @code{0} en caso de éxito, retorna @code{-1} en caso de error (no se pudo asignar memoria para almacenar la traza). Retorna @code{-2} si tracemalloc está deshabilitado.

Si el bloque de memoria ya está rastreado, actualice el rastreo existente.
@end deffn

@geindex PyTraceMalloc_Untrack (C function)
@anchor{c-api/memory c PyTraceMalloc_Untrack}@anchor{c3f}
@deffn {C Función} int PyTraceMalloc_Untrack (unsigned int domain, uintptr_t ptr)

Descomprima un bloque de memoria asignado en el módulo @ref{ff,,tracemalloc}. No haga nada si el bloque no fue rastreado.

Retorna @code{-2} si tracemalloc está deshabilitado; de lo contrario, retorna @code{0}.
@end deffn

@node Ejemplos<35>,,tracemalloc C API,Gestión de la memoria
@anchor{c-api/memory examples}@anchor{4d4a}@anchor{c-api/memory memoryexamples}@anchor{4d4b}
@subsection Ejemplos


Aquí está el ejemplo de la sección @ref{4d34,,Visión general}, reescrito para que el búfer de E/S se asigne desde el montón de Python utilizando el primer conjunto de funciones:

@example
PyObject *res;
char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Do some I/O operation involving buf... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* allocated with PyMem_Malloc */
return res;
@end example

El mismo código que utiliza el conjunto de funciones orientado a tipos:

@example
PyObject *res;
char *buf = PyMem_New(char, BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...Do some I/O operation involving buf... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* allocated with PyMem_New */
return res;
@end example

Tenga en cuenta que en los dos ejemplos anteriores, el búfer siempre se manipula a través de funciones que pertenecen al mismo conjunto. De hecho, es necesario usar la misma familia de API de memoria para un bloque de memoria dado, de modo que el riesgo de mezclar diferentes asignadores se reduzca al mínimo. La siguiente secuencia de código contiene dos errores, uno de los cuales está etiquetado como `fatal' porque mezcla dos asignadores diferentes que operan en montones diferentes.:

@example
char *buf1 = PyMem_New(char, BUFSIZ);
char *buf2 = (char *) malloc(BUFSIZ);
char *buf3 = (char *) PyMem_Malloc(BUFSIZ);
...
PyMem_Del(buf3);  /* Wrong -- should be PyMem_Free() */
free(buf2);       /* Right -- allocated via malloc() */
free(buf1);       /* Fatal -- should be PyMem_Free()  */
@end example

In addition to the functions aimed at handling raw memory blocks from the Python
heap, objects in Python are allocated and released with @ref{a17,,PyObject_New},
@ref{a18,,PyObject_NewVar} and @ref{ced,,PyObject_Free()}.

Esto se explicará en el próximo capítulo sobre cómo definir e implementar nuevos tipos de objetos en C.

@node Soporte de implementación de objetos,Versiones de API y ABI,Gestión de la memoria,Manual de referencia de la API en C de Python
@anchor{c-api/objimpl doc}@anchor{4d4c}@anchor{c-api/objimpl newtypes}@anchor{4d4d}@anchor{c-api/objimpl object-implementation-support}@anchor{4d4e}
@section Soporte de implementación de objetos


Este capítulo describe las funciones, los tipos y las macros utilizados al definir nuevos tipos de objetos.

@menu
* Asignación de objetos en el montículo:: 
* Estructuras de objetos comunes:: 
* Objetos tipo: Objetos tipo<2>. 
* Apoyo a la recolección de basura cíclica: Apoyo a la recolección de basura cíclica<2>. 

@end menu

@node Asignación de objetos en el montículo,Estructuras de objetos comunes,,Soporte de implementación de objetos
@anchor{c-api/allocation doc}@anchor{4d4f}@anchor{c-api/allocation allocating-objects}@anchor{4d50}@anchor{c-api/allocation allocating-objects-on-the-heap}@anchor{4d51}
@subsection Asignación de objetos en el montículo


@geindex _PyObject_New (C function)
@anchor{c-api/allocation c _PyObject_New}@anchor{4d52}
@deffn {C Función} @ref{42d,,PyObject} *_PyObject_New (PyTypeObject *type)
`Return value: New reference.'
@end deffn

@geindex _PyObject_NewVar (C function)
@anchor{c-api/allocation c _PyObject_NewVar}@anchor{4d53}
@deffn {C Función} @ref{408a,,PyVarObject} *_PyObject_NewVar (PyTypeObject *type, Py_ssize_t size)
`Return value: New reference.'
@end deffn

@geindex PyObject_Init (C function)
@anchor{c-api/allocation c PyObject_Init}@anchor{afa}
@deffn {C Función} @ref{42d,,PyObject} *PyObject_Init (PyObject *op, PyTypeObject *type)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Initialize a newly allocated object `op' with its type and initial
reference.  Returns the initialized object.  Other fields of the object are
not affected.
@end deffn

@geindex PyObject_InitVar (C function)
@anchor{c-api/allocation c PyObject_InitVar}@anchor{195f}
@deffn {C Función} @ref{408a,,PyVarObject} *PyObject_InitVar (PyVarObject *op, PyTypeObject *type, Py_ssize_t size)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI}.'
Esto hace todo lo que @ref{afa,,PyObject_Init()} hace, y también inicializa la información de longitud para un objeto de tamaño variable.
@end deffn

@geindex PyObject_New (C macro)
@anchor{c-api/allocation c PyObject_New}@anchor{a17}
@deffn {C Macro} PyObject_New (TYPE, typeobj)

Allocate a new Python object using the C structure type `TYPE'
and the Python type object `typeobj' (@code{PyTypeObject*}).
Fields not defined by the Python object header are not initialized.
The caller will own the only reference to the object
(i.e. its reference count will be one).
The size of the memory allocation is determined from the
@ref{a19,,tp_basicsize} field of the type object.
@end deffn

@geindex PyObject_NewVar (C macro)
@anchor{c-api/allocation c PyObject_NewVar}@anchor{a18}
@deffn {C Macro} PyObject_NewVar (TYPE, typeobj, size)

Allocate a new Python object using the C structure type `TYPE' and the
Python type object `typeobj' (@code{PyTypeObject*}).
Fields not defined by the Python object header
are not initialized.  The allocated memory allows for the `TYPE' structure
plus `size' (@code{Py_ssize_t}) fields of the size
given by the @ref{1f6f,,tp_itemsize} field of
`typeobj'.  This is useful for implementing objects like tuples, which are
able to determine their size at construction time.  Embedding the array of
fields into the same allocation decreases the number of allocations,
improving the memory management efficiency.
@end deffn

@geindex PyObject_Del (C function)
@anchor{c-api/allocation c PyObject_Del}@anchor{1511}
@deffn {C Función} void PyObject_Del (void *op)

Same as @ref{ced,,PyObject_Free()}.
@end deffn

@geindex _Py_NoneStruct (C var)
@anchor{c-api/allocation c _Py_NoneStruct}@anchor{4d54}
@deffn {C Variable} @ref{42d,,PyObject} _Py_NoneStruct

Objeto que es visible en Python como @code{None}. Esto solo se debe acceder utilizando el macro @ref{4831,,Py_None}, que se evalúa como un puntero a este objeto.
@end deffn


@subsubheading Ver también



@table @asis

@item @ref{4835,,PyModule_Create()}

Para asignar y crear módulos de extensión.
@end table


@node Estructuras de objetos comunes,Objetos tipo<2>,Asignación de objetos en el montículo,Soporte de implementación de objetos
@anchor{c-api/structures doc}@anchor{4d55}@anchor{c-api/structures common-object-structures}@anchor{4d56}@anchor{c-api/structures common-structs}@anchor{4d57}
@subsection Estructuras de objetos comunes


Hay un gran número de estructuras que se utilizan en la definición de los tipos de objetos de Python. Esta sección describe estas estructuras y la forma en que se utilizan.

@menu
* Tipos objeto base y macros:: 
* Implementando funciones y métodos:: 
* Acceder a atributos de tipos de extensión:: 

@end menu

@node Tipos objeto base y macros,Implementando funciones y métodos,,Estructuras de objetos comunes
@anchor{c-api/structures base-object-types-and-macros}@anchor{4d58}
@subsubsection Tipos objeto base y macros


All Python objects ultimately share a small number of fields at the beginning
of the object’s representation in memory.  These are represented by the
@ref{42d,,PyObject} and @ref{408a,,PyVarObject} types, which are defined, in turn,
by the expansions of some macros also used, whether directly or indirectly, in
the definition of all other Python objects.  Additional macros can be found
under @ref{4a55,,reference counting}.

@geindex PyObject (C type)
@anchor{c-api/structures c PyObject}@anchor{42d}
@deffn {C Tipo} type PyObject
` Part of the @ref{5f6,,Limited API}. (Only some members are part of the stable ABI.)'
All object types are extensions of this type.  This is a type which
contains the information Python needs to treat a pointer to an object as an
object.  In a normal «release» build, it contains only the object’s
reference count and a pointer to the corresponding type object.
Nothing is actually declared to be a @ref{42d,,PyObject}, but every pointer
to a Python object can be cast to a @ref{42d,,PyObject}*.  Access to the
members must be done by using the macros @ref{26f,,Py_REFCNT} and
@ref{26e,,Py_TYPE}.
@end deffn

@geindex PyVarObject (C type)
@anchor{c-api/structures c PyVarObject}@anchor{408a}
@deffn {C Tipo} type PyVarObject
` Part of the @ref{5f6,,Limited API}. (Only some members are part of the stable ABI.)'
This is an extension of @ref{42d,,PyObject} that adds the @ref{4a08,,ob_size}
field.  This is only used for objects that have some notion of `length'.
This type does not often appear in the Python/C API.
Access to the members must be done by using the macros
@ref{26f,,Py_REFCNT}, @ref{26e,,Py_TYPE}, and @ref{81b,,Py_SIZE}.
@end deffn

@geindex PyObject_HEAD (C macro)
@anchor{c-api/structures c PyObject_HEAD}@anchor{1345}
@deffn {C Macro} PyObject_HEAD

Esta es una macro utilizado cuando se declara nuevos tipos que representan objetos sin una longitud variable. La macro PyObject_HEAD se expande a:

@example
PyObject ob_base;
@end example

Consulte la documentación de @ref{42d,,PyObject} en secciones anteriores.
@end deffn

@geindex PyObject_VAR_HEAD (C macro)
@anchor{c-api/structures c PyObject_VAR_HEAD}@anchor{4d59}
@deffn {C Macro} PyObject_VAR_HEAD

Esta es una macro utilizado cuando se declara nuevos tipos que representan objetos con una longitud que varía de una instancia a otra instancia. La macro PyObject_VAR_HEAD se expande a:

@example
PyVarObject ob_base;
@end example

Consulte la documentación de @ref{408a,,PyVarObject} anteriormente.
@end deffn

@geindex Py_Is (C function)
@anchor{c-api/structures c Py_Is}@anchor{938}
@deffn {C Función} int Py_Is (PyObject *x, PyObject *y)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Prueba si el objeto `x' es el objeto `y', lo mismo que @code{x is y} en Python.


Added in version 3.10.

@end deffn

@geindex Py_IsNone (C function)
@anchor{c-api/structures c Py_IsNone}@anchor{939}
@deffn {C Función} int Py_IsNone (PyObject *x)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Prueba si un objeto es la instancia única @code{None}, lo mismo que @code{x is None} en Python.


Added in version 3.10.

@end deffn

@geindex Py_IsTrue (C function)
@anchor{c-api/structures c Py_IsTrue}@anchor{93a}
@deffn {C Función} int Py_IsTrue (PyObject *x)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Prueba si un objeto es la instancia única @code{True}, lo mismo que @code{x is True} en Python.


Added in version 3.10.

@end deffn

@geindex Py_IsFalse (C function)
@anchor{c-api/structures c Py_IsFalse}@anchor{93b}
@deffn {C Función} int Py_IsFalse (PyObject *x)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Prueba si un objeto es la instancia única @code{False}, lo mismo que @code{x is False} en Python.


Added in version 3.10.

@end deffn

@geindex Py_TYPE (C function)
@anchor{c-api/structures c Py_TYPE}@anchor{26e}
@deffn {C Función} @ref{b30,,PyTypeObject} *Py_TYPE (PyObject *o)
`Return value: Borrowed reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.14.'
Obtiene el tipo de objeto Python `o'.

Retorna una referencia prestada (@ref{432,,borrowed reference}).

Use the @ref{81a,,Py_SET_TYPE()} function to set an object type.


Distinto en la versión 3.11: @ref{26e,,Py_TYPE()} se cambia a una función estática inline. El tipo de parámetro ya no es const @ref{42d,,PyObject}*.

@end deffn

@geindex Py_IS_TYPE (C function)
@anchor{c-api/structures c Py_IS_TYPE}@anchor{181c}
@deffn {C Función} int Py_IS_TYPE (PyObject *o, PyTypeObject *type)

Retorna un valor distinto de cero si el objeto `o' tipo es `type'. Retorna cero en caso contrario. Equivalente a: @code{Py_TYPE(o) == type}.


Added in version 3.9.

@end deffn

@geindex Py_SET_TYPE (C function)
@anchor{c-api/structures c Py_SET_TYPE}@anchor{81a}
@deffn {C Función} void Py_SET_TYPE (PyObject *o, PyTypeObject *type)

Establece el tipo del objeto `o' a `type'.


Added in version 3.9.

@end deffn

@geindex Py_SIZE (C function)
@anchor{c-api/structures c Py_SIZE}@anchor{81b}
@deffn {C Función} @ref{af0,,Py_ssize_t} Py_SIZE (PyVarObject *o)

Obtiene el tamaño del objeto Python `o'.

Use the @ref{81c,,Py_SET_SIZE()} function to set an object size.


Distinto en la versión 3.11: @ref{81b,,Py_SIZE()} se cambia a una función estática inline. El tipo de parámetro ya no es const @ref{408a,,PyVarObject}*.

@end deffn

@geindex Py_SET_SIZE (C function)
@anchor{c-api/structures c Py_SET_SIZE}@anchor{81c}
@deffn {C Función} void Py_SET_SIZE (PyVarObject *o, Py_ssize_t size)

Establece el tamaño del objeto `o' a `size'.


Added in version 3.9.

@end deffn

@geindex PyObject_HEAD_INIT (C macro)
@anchor{c-api/structures c PyObject_HEAD_INIT}@anchor{4d5a}
@deffn {C Macro} PyObject_HEAD_INIT (type)

Esta es una macro que se expande para valores de inicialización para un nuevo tipo @ref{42d,,PyObject}. Esta macro expande:

@example
_PyObject_EXTRA_INIT
1, type,
@end example
@end deffn

@geindex PyVarObject_HEAD_INIT (C macro)
@anchor{c-api/structures c PyVarObject_HEAD_INIT}@anchor{4d5b}
@deffn {C Macro} PyVarObject_HEAD_INIT (type, size)

This is a macro which expands to initialization values for a new
@ref{408a,,PyVarObject} type, including the @ref{4a08,,ob_size} field.
This macro expands to:

@example
_PyObject_EXTRA_INIT
1, type, size,
@end example
@end deffn

@node Implementando funciones y métodos,Acceder a atributos de tipos de extensión,Tipos objeto base y macros,Estructuras de objetos comunes
@anchor{c-api/structures implementing-functions-and-methods}@anchor{4d5c}
@subsubsection Implementando funciones y métodos


@geindex PyCFunction (C type)
@anchor{c-api/structures c PyCFunction}@anchor{14b3}
@deffn {C Tipo} type PyCFunction
` Part of the @ref{5f6,,Stable ABI}.'
Type of the functions used to implement most Python callables in C.
Functions of this type take two @ref{42d,,PyObject}* parameters and return
one such value.  If the return value is @code{NULL}, an exception shall have
been set.  If not @code{NULL}, the return value is interpreted as the return
value of the function as exposed in Python.  The function must return a new
reference.

La firma de la función es:

@example
PyObject *PyCFunction(PyObject *self,
                      PyObject *args);
@end example
@end deffn

@geindex PyCFunctionWithKeywords (C type)
@anchor{c-api/structures c PyCFunctionWithKeywords}@anchor{48ec}
@deffn {C Tipo} type PyCFunctionWithKeywords
` Part of the @ref{5f6,,Stable ABI}.'
Type of the functions used to implement Python callables in C
with signature @ref{4d5d,,METH_VARARGS | METH_KEYWORDS}.
The function signature is:

@example
PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);
@end example
@end deffn

@geindex PyCFunctionFast (C type)
@anchor{c-api/structures c PyCFunctionFast}@anchor{48ea}
@deffn {C Tipo} type PyCFunctionFast
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Type of the functions used to implement Python callables in C
with signature @ref{1633,,METH_FASTCALL}.
The function signature is:

@example
PyObject *PyCFunctionFast(PyObject *self,
                          PyObject *const *args,
                          Py_ssize_t nargs);
@end example
@end deffn

@geindex PyCFunctionFastWithKeywords (C type)
@anchor{c-api/structures c PyCFunctionFastWithKeywords}@anchor{48eb}
@deffn {C Tipo} type PyCFunctionFastWithKeywords
` Part of the @ref{5f6,,Stable ABI} since version 3.13.'
Type of the functions used to implement Python callables in C
with signature @ref{4d5e,,METH_FASTCALL | METH_KEYWORDS}.
The function signature is:

@example
PyObject *PyCFunctionFastWithKeywords(PyObject *self,
                                      PyObject *const *args,
                                      Py_ssize_t nargs,
                                      PyObject *kwnames);
@end example
@end deffn

@geindex PyCMethod (C type)
@anchor{c-api/structures c PyCMethod}@anchor{7fe}
@deffn {C Tipo} type PyCMethod

Type of the functions used to implement Python callables in C
with signature @ref{1698,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
The function signature is:

@example
PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)
@end example


Added in version 3.9.

@end deffn

@geindex PyMethodDef (C type)
@anchor{c-api/structures c PyMethodDef}@anchor{1517}
@deffn {C Tipo} type PyMethodDef
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Estructura utiliza para describir un método de un tipo de extensión. Esta estructura tiene cuatro campos:

@geindex PyMethodDef.ml_name (C member)
@anchor{c-api/structures c PyMethodDef ml_name}@anchor{4879}
@deffn {C Miembro} const char *ml_name

Name of the method.
@end deffn

@geindex PyMethodDef.ml_meth (C member)
@anchor{c-api/structures c PyMethodDef ml_meth}@anchor{4d5f}
@deffn {C Miembro} @ref{14b3,,PyCFunction} ml_meth

Pointer to the C implementation.
@end deffn

@geindex PyMethodDef.ml_flags (C member)
@anchor{c-api/structures c PyMethodDef ml_flags}@anchor{4d60}
@deffn {C Miembro} int ml_flags

Flags bits indicating how the call should be constructed.
@end deffn

@geindex PyMethodDef.ml_doc (C member)
@anchor{c-api/structures c PyMethodDef ml_doc}@anchor{4d61}
@deffn {C Miembro} const char *ml_doc

Points to the contents of the docstring.
@end deffn
@end deffn

The @ref{4d5f,,ml_meth} is a C function pointer.
The functions may be of different
types, but they always return @ref{42d,,PyObject}*.  If the function is not of
the @ref{14b3,,PyCFunction}, the compiler will require a cast in the method table.
Even though @ref{14b3,,PyCFunction} defines the first parameter as
@ref{42d,,PyObject}*, it is common that the method implementation uses the
specific C type of the `self' object.

The @ref{4d60,,ml_flags} field is a bitfield which can include
the following flags.
The individual flags indicate either a calling convention or a binding
convention.

Existen estas convenciones de llamada:

@geindex METH_VARARGS (C macro)
@anchor{c-api/structures c METH_VARARGS}@anchor{154a}
@deffn {C Macro} METH_VARARGS

This is the typical calling convention, where the methods have the type
@ref{14b3,,PyCFunction}. The function expects two @ref{42d,,PyObject}* values.
The first one is the `self' object for methods; for module functions, it is
the module object.  The second parameter (often called `args') is a tuple
object representing all arguments. This parameter is typically processed
using @ref{615,,PyArg_ParseTuple()} or @ref{1548,,PyArg_UnpackTuple()}.
@end deffn

@geindex METH_KEYWORDS (C macro)
@anchor{c-api/structures c METH_KEYWORDS}@anchor{4834}
@deffn {C Macro} METH_KEYWORDS

Can only be used in certain combinations with other flags:
@ref{4d5d,,METH_VARARGS | METH_KEYWORDS},
@ref{4d5e,,METH_FASTCALL | METH_KEYWORDS} and
@ref{1698,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-varargs-meth-keywords}@anchor{4d5d}

@table @asis

@item @ref{154a,,METH_VARARGS} | @ref{4834,,METH_KEYWORDS}

Los métodos con estas `flags' deben ser del tipo @ref{48ec,,PyCFunctionWithKeywords}. La función espera tres parámetros: `self', `args', `kwargs' donde `kwargs' es un diccionario de todos los argumentos de palabras clave o, posiblemente, @code{NULL} si no hay argumentos de palabra clave. Los parámetros se procesan típicamente usando @ref{475,,PyArg_ParseTupleAndKeywords()}.
@end table

@geindex METH_FASTCALL (C macro)
@anchor{c-api/structures c METH_FASTCALL}@anchor{1633}
@deffn {C Macro} METH_FASTCALL

Fast calling convention supporting only positional arguments.
The methods have the type @ref{48ea,,PyCFunctionFast}.
The first parameter is `self', the second parameter is a C array
of @ref{42d,,PyObject}* values indicating the arguments and the third
parameter is the number of arguments (the length of the array).


Added in version 3.7.



Distinto en la versión 3.10: @code{METH_FASTCALL} is now part of the @ref{48d2,,stable ABI}.

@end deffn
@anchor{c-api/structures meth-fastcall-meth-keywords}@anchor{4d5e}

@table @asis

@item @ref{1633,,METH_FASTCALL} | @ref{4834,,METH_KEYWORDS}

Extension of @ref{1633,,METH_FASTCALL} supporting also keyword arguments,
with methods of type @ref{48eb,,PyCFunctionFastWithKeywords}.
Keyword arguments are passed the same way as in the
@ref{5f5,,vectorcall protocol}:
there is an additional fourth @ref{42d,,PyObject}* parameter
which is a tuple representing the names of the keyword arguments
(which are guaranteed to be strings)
or possibly @code{NULL} if there are no keywords.  The values of the keyword
arguments are stored in the `args' array, after the positional arguments.


Added in version 3.7.

@end table

@geindex METH_METHOD (C macro)
@anchor{c-api/structures c METH_METHOD}@anchor{a02}
@deffn {C Macro} METH_METHOD

Can only be used in the combination with other flags:
@ref{1698,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-method-meth-fastcall-meth-keywords}@anchor{1698}

@table @asis

@item @ref{a02,,METH_METHOD} | @ref{1633,,METH_FASTCALL} | @ref{4834,,METH_KEYWORDS}

Extension of @ref{4d5e,,METH_FASTCALL | METH_KEYWORDS}
supporting the `defining class', that is,
the class that contains the method in question.
The defining class might be a superclass of @code{Py_TYPE(self)}.

El método debe ser de tipo @ref{7fe,,PyCMethod}, lo mismo que para @code{METH_FASTCALL | METH_KEYWORDS} con el argumento @code{defining_clase} añadido después de @code{self}.


Added in version 3.9.

@end table

@geindex METH_NOARGS (C macro)
@anchor{c-api/structures c METH_NOARGS}@anchor{1514}
@deffn {C Macro} METH_NOARGS

Methods without parameters don’t need to check whether arguments are given if
they are listed with the @ref{1514,,METH_NOARGS} flag.  They need to be of type
@ref{14b3,,PyCFunction}.  The first parameter is typically named `self' and will
hold a reference to the module or object instance.  In all cases the second
parameter will be @code{NULL}.

La función debe tener 2 parámetros. Dado que el segundo parámetro no se usa, @ref{1722,,Py_UNUSED} se puede usar para evitar una advertencia del compilador.
@end deffn

@geindex METH_O (C macro)
@anchor{c-api/structures c METH_O}@anchor{1549}
@deffn {C Macro} METH_O

Methods with a single object argument can be listed with the @ref{1549,,METH_O}
flag, instead of invoking @ref{615,,PyArg_ParseTuple()} with a @code{"O"} argument.
They have the type @ref{14b3,,PyCFunction}, with the `self' parameter, and a
@ref{42d,,PyObject}* parameter representing the single argument.
@end deffn

Estas dos constantes no se utilizan para indicar la convención de llamada si no la vinculación cuando su usan con métodos de las clases. Estos no se pueden usar para funciones definidas para módulos. A lo sumo uno de estos `flags' puede establecerse en un método dado.

@geindex METH_CLASS (C macro)
@anchor{c-api/structures c METH_CLASS}@anchor{1515}
@deffn {C Macro} METH_CLASS

@geindex built-in function;classmethod

Al método se le pasará el objeto tipo como primer parámetro, en lugar de una instancia del tipo. Esto se utiliza para crear métodos de clase (`class methods'), similar a lo que se crea cuando se utiliza la función @ref{2d2,,classmethod()} incorporada.
@end deffn

@geindex METH_STATIC (C macro)
@anchor{c-api/structures c METH_STATIC}@anchor{1516}
@deffn {C Macro} METH_STATIC

@geindex built-in function;staticmethod

El método pasará @code{NULL} como el primer parámetro en lugar de una instancia del tipo. Esto se utiliza para crear métodos estáticos (`static methods'), similar a lo que se crea cuando se utiliza la función @ref{22e,,staticmethod()} incorporada.
@end deffn

En otros controles constantes dependiendo si se carga un método en su lugar (`in place') de otra definición con el mismo nombre del método.

@geindex METH_COEXIST (C macro)
@anchor{c-api/structures c METH_COEXIST}@anchor{4d62}
@deffn {C Macro} METH_COEXIST

The method will be loaded in place of existing definitions.  Without
`METH_COEXIST', the default is to skip repeated definitions.  Since slot
wrappers are loaded before the method table, the existence of a
`sq_contains' slot, for example, would generate a wrapped method named
@ref{1f5d,,__contains__()} and preclude the loading of a corresponding
PyCFunction with the same name.  With the flag defined, the PyCFunction
will be loaded in place of the wrapper object and will co-exist with the
slot.  This is helpful because calls to PyCFunctions are optimized more
than wrapper object calls.
@end deffn

@geindex PyCMethod_New (C function)
@anchor{c-api/structures c PyCMethod_New}@anchor{18f6}
@deffn {C Función} @ref{42d,,PyObject} *PyCMethod_New (PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Turn `ml' into a Python @ref{28ea,,callable} object.
The caller must ensure that `ml' outlives the @ref{28ea,,callable}.
Typically, `ml' is defined as a static variable.

The `self' parameter will be passed as the `self' argument
to the C function in @code{ml->ml_meth} when invoked.
`self' can be @code{NULL}.

The @ref{28ea,,callable} object’s @code{__module__} attribute
can be set from the given `module' argument.
`module' should be a Python string,
which will be used as name of the module the function is defined in.
If unavailable, it can be set to @ref{716,,None} or @code{NULL}.


@subsubheading Ver también


@ref{1efb,,function.__module__}


The `cls' parameter will be passed as the `defining_class'
argument to the C function.
Must be set if @ref{a02,,METH_METHOD} is set on @code{ml->ml_flags}.


Added in version 3.9.

@end deffn

@geindex PyCFunction_NewEx (C function)
@anchor{c-api/structures c PyCFunction_NewEx}@anchor{1996}
@deffn {C Función} @ref{42d,,PyObject} *PyCFunction_NewEx (PyMethodDef *ml, PyObject *self, PyObject *module)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI}.'
Equivalent to @code{PyCMethod_New(ml, self, module, NULL)}.
@end deffn

@geindex PyCFunction_New (C function)
@anchor{c-api/structures c PyCFunction_New}@anchor{18fc}
@deffn {C Función} @ref{42d,,PyObject} *PyCFunction_New (PyMethodDef *ml, PyObject *self)
`Return value: New reference.'` Part of the @ref{5f6,,Stable ABI} since version 3.4.'
Equivalent to @code{PyCMethod_New(ml, self, NULL, NULL)}.
@end deffn

@node Acceder a atributos de tipos de extensión,,Implementando funciones y métodos,Estructuras de objetos comunes
@anchor{c-api/structures accessing-attributes-of-extension-types}@anchor{4d63}
@subsubsection Acceder a atributos de tipos de extensión


@geindex PyMemberDef (C type)
@anchor{c-api/structures c PyMemberDef}@anchor{5f2}
@deffn {C Tipo} type PyMemberDef
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Structure which describes an attribute of a type which corresponds to a C
struct member.
When defining a class, put a NULL-terminated array of these
structures in the @ref{4862,,tp_members} slot.

Its fields are, in order:

@geindex PyMemberDef.name (C member)
@anchor{c-api/structures c PyMemberDef name}@anchor{4d64}
@deffn {C Miembro} const char *name

Name of the member.
A NULL value marks the end of a @code{PyMemberDef[]} array.

The string should be static, no copy is made of it.
@end deffn

@geindex PyMemberDef.type (C member)
@anchor{c-api/structures c PyMemberDef type}@anchor{487a}
@deffn {C Miembro} int type

The type of the member in the C struct.
See @ref{167e,,Member types} for the possible values.
@end deffn

@geindex PyMemberDef.offset (C member)
@anchor{c-api/structures c PyMemberDef offset}@anchor{4d65}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} offset

The offset in bytes that the member is located on the type’s object struct.
@end deffn

@geindex PyMemberDef.flags (C member)
@anchor{c-api/structures c PyMemberDef flags}@anchor{487b}
@deffn {C Miembro} int flags

Zero or more of the @ref{4d66,,Member flags}, combined using bitwise OR.
@end deffn

@geindex PyMemberDef.doc (C member)
@anchor{c-api/structures c PyMemberDef doc}@anchor{4d67}
@deffn {C Miembro} const char *doc

The docstring, or NULL.
The string should be static, no copy is made of it.
Typically, it is defined using @ref{1812,,PyDoc_STR}.
@end deffn

By default (when @ref{487b,,flags} is @code{0}), members allow
both read and write access.
Use the @ref{634,,Py_READONLY} flag for read-only access.
Certain types, like @ref{4d68,,Py_T_STRING}, imply @ref{634,,Py_READONLY}.
Only @ref{637,,Py_T_OBJECT_EX} (and legacy @ref{636,,T_OBJECT}) members can
be deleted.
@anchor{c-api/structures pymemberdef-offsets}@anchor{4b2c}
For heap-allocated types (created using @ref{621,,PyType_FromSpec()} or similar),
@code{PyMemberDef} may contain a definition for the special member
@code{"__vectorcalloffset__"}, corresponding to
@ref{4acd,,tp_vectorcall_offset} in type objects.
This member must be defined with @code{Py_T_PYSSIZET}, and either
@code{Py_READONLY} or @code{Py_READONLY | Py_RELATIVE_OFFSET}. For example:

@example
static PyMemberDef spam_type_members[] = @{
    @{"__vectorcalloffset__", Py_T_PYSSIZET,
     offsetof(Spam_object, vectorcall), Py_READONLY@},
    @{NULL@}  /* Sentinel */
@};
@end example

(You may need to @code{#include <stddef.h>} for @code{offsetof()}.)

The legacy offsets @ref{4b2b,,tp_dictoffset} and
@ref{a1a,,tp_weaklistoffset} can be defined similarly using
@code{"__dictoffset__"} and @code{"__weaklistoffset__"} members, but extensions
are strongly encouraged to use @ref{45f,,Py_TPFLAGS_MANAGED_DICT} and
@ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} instead.


Distinto en la versión 3.12: @code{PyMemberDef} is always available.
Previously, it required including @code{"structmember.h"}.



Distinto en la versión 3.14: @ref{5f1,,Py_RELATIVE_OFFSET} is now allowed for
@code{"__vectorcalloffset__"}, @code{"__dictoffset__"} and
@code{"__weaklistoffset__"}.

@end deffn

@geindex PyMember_GetOne (C function)
@anchor{c-api/structures c PyMember_GetOne}@anchor{630}
@deffn {C Función} @ref{42d,,PyObject} *PyMember_GetOne (const char *obj_addr, struct PyMemberDef *m)
` Part of the @ref{5f6,,Stable ABI}.'
Obtiene un atributo que pertenece al objeto en la dirección `obj_addr'. El atributo se describe por @code{PyMemberDef} `m'. Retorna @code{NULL} en caso de error.


Distinto en la versión 3.12: @code{PyMember_GetOne} is always available.
Previously, it required including @code{"structmember.h"}.

@end deffn

@geindex PyMember_SetOne (C function)
@anchor{c-api/structures c PyMember_SetOne}@anchor{631}
@deffn {C Función} int PyMember_SetOne (char *obj_addr, struct PyMemberDef *m, PyObject *o)
` Part of the @ref{5f6,,Stable ABI}.'
Establece un atributo que pertenece al objeto en la dirección `obj_addr' al objeto `o'. El atributo a establecer se describe por @code{PyMemberDef} `m'. Retorna @code{0} si tiene éxito y un valor negativo si falla.


Distinto en la versión 3.12: @code{PyMember_SetOne} is always available.
Previously, it required including @code{"structmember.h"}.

@end deffn

@menu
* Member flags:: 
* Member types:: 
* Defining Getters and Setters:: 

@end menu

@node Member flags,Member types,,Acceder a atributos de tipos de extensión
@anchor{c-api/structures member-flags}@anchor{4d69}@anchor{c-api/structures pymemberdef-flags}@anchor{4d66}
@subsubsection Member flags


The following flags can be used with @ref{487b,,PyMemberDef.flags}:

@geindex Py_READONLY (C macro)
@anchor{c-api/structures c Py_READONLY}@anchor{634}
@deffn {C Macro} Py_READONLY

Not writable.
@end deffn

@geindex Py_AUDIT_READ (C macro)
@anchor{c-api/structures c Py_AUDIT_READ}@anchor{635}
@deffn {C Macro} Py_AUDIT_READ

Emit an @code{object.__getattr__} @ref{1878,,audit event}
before reading.
@end deffn

@geindex Py_RELATIVE_OFFSET (C macro)
@anchor{c-api/structures c Py_RELATIVE_OFFSET}@anchor{5f1}
@deffn {C Macro} Py_RELATIVE_OFFSET

Indicates that the @ref{4d65,,offset} of this @code{PyMemberDef}
entry indicates an offset from the subclass-specific data, rather than
from @code{PyObject}.

Can only be used as part of @ref{4862,,Py_tp_members}
@ref{49ce,,slot} when creating a class using negative
@ref{5eb,,basicsize}.
It is mandatory in that case.

This flag is only used in @ref{49ce,,PyType_Slot}.
When setting @ref{4862,,tp_members} during
class creation, Python clears it and sets
@ref{4d65,,PyMemberDef.offset} to the offset from the @code{PyObject} struct.
@end deffn

@geindex READ_RESTRICTED (C macro)
@geindex WRITE_RESTRICTED (C macro)
@geindex RESTRICTED (C macro)


Distinto en la versión 3.10: The @code{RESTRICTED}, @code{READ_RESTRICTED} and
@code{WRITE_RESTRICTED} macros available with
@code{#include "structmember.h"} are deprecated.
@code{READ_RESTRICTED} and @code{RESTRICTED} are equivalent to
@ref{635,,Py_AUDIT_READ}; @code{WRITE_RESTRICTED} does nothing.


@geindex READONLY (C macro)


Distinto en la versión 3.12: The @code{READONLY} macro was renamed to @ref{634,,Py_READONLY}.
The @code{PY_AUDIT_READ} macro was renamed with the @code{Py_} prefix.
The new names are now always available.
Previously, these required @code{#include "structmember.h"}.
The header is still available and it provides the old names.


@node Member types,Defining Getters and Setters,Member flags,Acceder a atributos de tipos de extensión
@anchor{c-api/structures member-types}@anchor{4d6a}@anchor{c-api/structures pymemberdef-types}@anchor{167e}
@subsubsection Member types


@ref{487a,,PyMemberDef.type} can be one of the following macros corresponding
to various C types.
When the member is accessed in Python, it will be converted to the
equivalent Python type.
When it is set from Python, it will be converted back to the C type.
If that is not possible, an exception such as @ref{228,,TypeError} or
@ref{360,,ValueError} is raised.

Unless marked (D), attributes defined this way cannot be deleted
using e.g. @ref{17ae,,del} or @ref{2158,,delattr()}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nombre de la macro

@tab

Tipo C

@tab

Python type

@item

@geindex Py_T_BYTE (C macro)
@anchor{c-api/structures c Py_T_BYTE}@anchor{4d6b}
@deffn {C Macro} Py_T_BYTE
@end deffn

@tab

char

@tab

@ref{1f0,,int}

@item

@geindex Py_T_SHORT (C macro)
@anchor{c-api/structures c Py_T_SHORT}@anchor{4d6c}
@deffn {C Macro} Py_T_SHORT
@end deffn

@tab

short

@tab

@ref{1f0,,int}

@item

@geindex Py_T_INT (C macro)
@anchor{c-api/structures c Py_T_INT}@anchor{632}
@deffn {C Macro} Py_T_INT
@end deffn

@tab

int

@tab

@ref{1f0,,int}

@item

@geindex Py_T_LONG (C macro)
@anchor{c-api/structures c Py_T_LONG}@anchor{4d6d}
@deffn {C Macro} Py_T_LONG
@end deffn

@tab

long

@tab

@ref{1f0,,int}

@item

@geindex Py_T_LONGLONG (C macro)
@anchor{c-api/structures c Py_T_LONGLONG}@anchor{4d6e}
@deffn {C Macro} Py_T_LONGLONG
@end deffn

@tab

long long

@tab

@ref{1f0,,int}

@item

@geindex Py_T_UBYTE (C macro)
@anchor{c-api/structures c Py_T_UBYTE}@anchor{4d6f}
@deffn {C Macro} Py_T_UBYTE
@end deffn

@tab

unsigned char

@tab

@ref{1f0,,int}

@item

@geindex Py_T_UINT (C macro)
@anchor{c-api/structures c Py_T_UINT}@anchor{4d70}
@deffn {C Macro} Py_T_UINT
@end deffn

@tab

unsigned int

@tab

@ref{1f0,,int}

@item

@geindex Py_T_USHORT (C macro)
@anchor{c-api/structures c Py_T_USHORT}@anchor{4d71}
@deffn {C Macro} Py_T_USHORT
@end deffn

@tab

unsigned short

@tab

@ref{1f0,,int}

@item

@geindex Py_T_ULONG (C macro)
@anchor{c-api/structures c Py_T_ULONG}@anchor{4d72}
@deffn {C Macro} Py_T_ULONG
@end deffn

@tab

unsigned long

@tab

@ref{1f0,,int}

@item

@geindex Py_T_ULONGLONG (C macro)
@anchor{c-api/structures c Py_T_ULONGLONG}@anchor{4d73}
@deffn {C Macro} Py_T_ULONGLONG
@end deffn

@tab

unsigned long long

@tab

@ref{1f0,,int}

@item

@geindex Py_T_PYSSIZET (C macro)
@anchor{c-api/structures c Py_T_PYSSIZET}@anchor{4d74}
@deffn {C Macro} Py_T_PYSSIZET
@end deffn

@tab

@ref{af0,,Py_ssize_t}

@tab

@ref{1f0,,int}

@item

@geindex Py_T_FLOAT (C macro)
@anchor{c-api/structures c Py_T_FLOAT}@anchor{4d75}
@deffn {C Macro} Py_T_FLOAT
@end deffn

@tab

float

@tab

@ref{153,,float}

@item

@geindex Py_T_DOUBLE (C macro)
@anchor{c-api/structures c Py_T_DOUBLE}@anchor{633}
@deffn {C Macro} Py_T_DOUBLE
@end deffn

@tab

double

@tab

@ref{153,,float}

@item

@geindex Py_T_BOOL (C macro)
@anchor{c-api/structures c Py_T_BOOL}@anchor{4d76}
@deffn {C Macro} Py_T_BOOL
@end deffn

@tab

char
(written as 0 or 1)

@tab

@ref{513,,bool}

@item

@geindex Py_T_STRING (C macro)
@anchor{c-api/structures c Py_T_STRING}@anchor{4d68}
@deffn {C Macro} Py_T_STRING
@end deffn

@tab

const char* (*)

@tab

@ref{237,,str} (RO)

@item

@geindex Py_T_STRING_INPLACE (C macro)
@anchor{c-api/structures c Py_T_STRING_INPLACE}@anchor{4d77}
@deffn {C Macro} Py_T_STRING_INPLACE
@end deffn

@tab

const char[] (*)

@tab

@ref{237,,str} (RO)

@item

@geindex Py_T_CHAR (C macro)
@anchor{c-api/structures c Py_T_CHAR}@anchor{4d78}
@deffn {C Macro} Py_T_CHAR
@end deffn

@tab

char (0-127)

@tab

@ref{237,,str} (**)

@item

@geindex Py_T_OBJECT_EX (C macro)
@anchor{c-api/structures c Py_T_OBJECT_EX}@anchor{637}
@deffn {C Macro} Py_T_OBJECT_EX
@end deffn

@tab

@ref{42d,,PyObject}*

@tab

@ref{b18,,object} (D)

@end multitable


@quotation

(*): Zero-terminated, UTF8-encoded C string.
With @code{Py_T_STRING} the C representation is a pointer;
with @code{Py_T_STRING_INPLACE} the string is stored directly
in the structure.

(**): String of length 1. Only ASCII is accepted.

(RO): Implies @ref{634,,Py_READONLY}.

(D): Can be deleted, in which case the pointer is set to @code{NULL}.
Reading a @code{NULL} pointer raises @ref{441,,AttributeError}.
@end quotation

@geindex T_BYTE (C macro)
@geindex T_SHORT (C macro)
@geindex T_INT (C macro)
@geindex T_LONG (C macro)
@geindex T_LONGLONG (C macro)
@geindex T_UBYTE (C macro)
@geindex T_USHORT (C macro)
@geindex T_UINT (C macro)
@geindex T_ULONG (C macro)
@geindex T_ULONGULONG (C macro)
@geindex T_PYSSIZET (C macro)
@geindex T_FLOAT (C macro)
@geindex T_DOUBLE (C macro)
@geindex T_BOOL (C macro)
@geindex T_CHAR (C macro)
@geindex T_STRING (C macro)
@geindex T_STRING_INPLACE (C macro)
@geindex T_OBJECT_EX (C macro)
@geindex structmember.h


Added in version 3.12: In previous versions, the macros were only available with
@code{#include "structmember.h"} and were named without the @code{Py_} prefix
(e.g. as @code{T_INT}).
The header is still available and contains the old names, along with
the following deprecated types:

@geindex T_OBJECT (C macro)
@anchor{c-api/structures c T_OBJECT}@anchor{636}
@deffn {C Macro} T_OBJECT

Like @code{Py_T_OBJECT_EX}, but @code{NULL} is converted to @code{None}.
This results in surprising behavior in Python: deleting the attribute
effectively sets it to @code{None}.
@end deffn

@geindex T_NONE (C macro)
@anchor{c-api/structures c T_NONE}@anchor{638}
@deffn {C Macro} T_NONE

Always @code{None}. Must be used with @ref{634,,Py_READONLY}.
@end deffn


@node Defining Getters and Setters,,Member types,Acceder a atributos de tipos de extensión
@anchor{c-api/structures defining-getters-and-setters}@anchor{4d79}
@subsubsection Defining Getters and Setters


@geindex PyGetSetDef (C type)
@anchor{c-api/structures c PyGetSetDef}@anchor{c40}
@deffn {C Tipo} type PyGetSetDef
` Part of the @ref{5f6,,Stable ABI} (including all members).'
Estructura para definir el acceso para un tipo como el de una propiedad. Véase también la descripción de la ranura @ref{4867,,PyTypeObject.tp_getset}.

@geindex PyGetSetDef.name (C member)
@anchor{c-api/structures c PyGetSetDef name}@anchor{4d7a}
@deffn {C Miembro} const char *name

nombre del atributo
@end deffn

@geindex PyGetSetDef.get (C member)
@anchor{c-api/structures c PyGetSetDef get}@anchor{4d7b}
@deffn {C Miembro} @ref{4a23,,getter} get

C function to get the attribute.
@end deffn

@geindex PyGetSetDef.set (C member)
@anchor{c-api/structures c PyGetSetDef set}@anchor{4d7c}
@deffn {C Miembro} @ref{4a31,,setter} set

Optional C function to set or delete the attribute.
If @code{NULL}, the attribute is read-only.
@end deffn

@geindex PyGetSetDef.doc (C member)
@anchor{c-api/structures c PyGetSetDef doc}@anchor{4d7d}
@deffn {C Miembro} const char *doc

docstring opcional
@end deffn

@geindex PyGetSetDef.closure (C member)
@anchor{c-api/structures c PyGetSetDef closure}@anchor{4d7e}
@deffn {C Miembro} void *closure

Optional user data pointer, providing additional data for getter and setter.
@end deffn
@end deffn

@geindex getter (C type)
@anchor{c-api/structures c getter}@anchor{4a23}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*getter)(@ref{42d,,PyObject}*, void*)
` Part of the @ref{5f6,,Stable ABI}.'
The @code{get} function takes one @ref{42d,,PyObject}* parameter (the
instance) and a user data pointer (the associated @code{closure}):

Debe retornar una nueva referencia en caso de éxito o @code{NULL} con una excepción establecida en caso de error.
@end deffn

@geindex setter (C type)
@anchor{c-api/structures c setter}@anchor{4a31}
@deffn {C Tipo} typedef int (*setter)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, void*)
` Part of the @ref{5f6,,Stable ABI}.'
@code{set} functions take two @ref{42d,,PyObject}* parameters (the instance and
the value to be set) and a user data pointer (the associated @code{closure}):

En caso de que el atributo deba suprimirse el segundo parámetro es @code{NULL}. Debe retornar @code{0} en caso de éxito o @code{-1} con una excepción explícita en caso de fallo.
@end deffn

@node Objetos tipo<2>,Apoyo a la recolección de basura cíclica<2>,Estructuras de objetos comunes,Soporte de implementación de objetos
@anchor{c-api/typeobj doc}@anchor{4d7f}@anchor{c-api/typeobj type-objects}@anchor{4d80}@anchor{c-api/typeobj type-structs}@anchor{a1f}
@subsection Objetos tipo


Perhaps one of the most important structures of the Python object system is the
structure that defines a new type: the @ref{b30,,PyTypeObject} structure.  Type
objects can be handled using any of the @code{PyObject_*} or
@code{PyType_*} functions, but do not offer much that’s interesting to most
Python applications. These objects are fundamental to how objects behave, so
they are very important to the interpreter itself and to any extension module
that implements new types.

Los objetos de tipo son bastante grandes en comparación con la mayoría de los tipos estándar. La razón del tamaño es que cada objeto de tipo almacena una gran cantidad de valores, principalmente punteros de función C, cada uno de los cuales implementa una pequeña parte de la funcionalidad del tipo. Los campos del objeto tipo se examinan en detalle en esta sección. Los campos se describirán en el orden en que aparecen en la estructura.

Además de la siguiente referencia rápida, la sección @ref{4d81,,Ejemplos} proporciona una visión rápida del significado y uso de @ref{b30,,PyTypeObject}.

@menu
* Referencia rápida:: 
* Definición de PyTypeObject:: 
* Ranuras (Slots) PyObject: Ranuras Slots PyObject. 
* Ranuras PyVarObject:: 
* Ranuras PyTypeObject:: 
* Tipos estáticos:: 
* Tipos Heap:: 
* Estructuras de objetos de números:: 
* Estructuras de objetos mapeo:: 
* Estructuras de objetos secuencia:: 
* Estructuras de objetos búfer:: 
* Estructuras de objetos asíncronos:: 
* Tipo Ranura typedefs:: 
* Ejemplos: Ejemplos<36>. 

@end menu

@node Referencia rápida,Definición de PyTypeObject,,Objetos tipo<2>
@anchor{c-api/typeobj quick-reference}@anchor{4d82}
@subsubsection Referencia rápida


@menu
* «ranuras tp» (tp slots): «ranuras tp» tp slots. 
* sub-ranuras (sub-slots): sub-ranuras sub-slots. 
* ranura de typedefs:: 

@end menu

@node «ranuras tp» tp slots,sub-ranuras sub-slots,,Referencia rápida
@anchor{c-api/typeobj tp-slots}@anchor{4d83}@anchor{c-api/typeobj tp-slots-table}@anchor{4d84}
@subsubsection «ranuras `tp'» (`tp slots')



@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxx} {xxx} {xxx} {xxx} 
@headitem

Ranura @code{PyTypeObject} @footnote{
`()': A slot name in parentheses indicates it is (effectively) deprecated.

`<>': Names in angle brackets should be initially set to @code{NULL} and
treated as read-only.

`[]': Names in square brackets are for internal use only.

`<R>' (as a prefix) means the field is required (must be non-@code{NULL}).
}

@tab

@ref{4d85,,Type}

@tab

métodos/atributos especiales

@tab

Información @footnote{
Columnas:

`«O»':  set on @code{PyBaseObject_Type}

`«T»':  set on @ref{5f0,,PyType_Type}

`«D»':  por defecto (si la ranura está establecida como @code{NULL})

@example
X - PyType_Ready sets this value if it is NULL
~ - PyType_Ready always sets this value (it should be NULL)
? - PyType_Ready may set this value depending on other slots

Also see the inheritance column ("I").
@end example

`«I»':  herencia

@example
X - type slot is inherited via *PyType_Ready* if defined with a *NULL* value
% - the slots of the sub-struct are inherited individually
G - inherited, but only in combination with other slots; see the slot's description
? - it's complicated; see the slot's description
@end example

Tenga en cuenta que algunos espacios se heredan efectivamente a través de la cadena de búsqueda de atributos normal.
}

@tab

@tab

@tab

@item

O

@tab

T

@tab

D

@tab

I

@item

<R> @ref{18fb,,tp_name}

@tab

const char *

@tab

__name__

@tab

X

@tab

X

@tab

@tab

@item

@ref{a19,,tp_basicsize}

@tab

@ref{af0,,Py_ssize_t}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{1f6f,,tp_itemsize}

@tab

@ref{af0,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

@ref{485f,,tp_dealloc}

@tab

@ref{4a1e,,destructor}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{4acd,,tp_vectorcall_offset}

@tab

@ref{af0,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

(@ref{487d,,tp_getattr})

@tab

@ref{4a1f,,getattrfunc}

@tab

__getattribute__,
__getattr__

@tab

@tab

@tab

@tab

G

@item

(@ref{487e,,tp_setattr})

@tab

@ref{4a2f,,setattrfunc}

@tab

__setattr__,
__delattr__

@tab

@tab

@tab

@tab

G

@item

@ref{f50,,tp_as_async}

@tab

@ref{4b29,,PyAsyncMethods} *

@tab

@ref{4d86,,sub-ranuras (sub-slots)}

@tab

@tab

@tab

@tab

%

@item

@ref{4874,,tp_repr}

@tab

@ref{4a2d,,reprfunc}

@tab

__repr__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{a1d,,tp_as_number}

@tab

@ref{145d,,PyNumberMethods} *

@tab

@ref{4d86,,sub-ranuras (sub-slots)}

@tab

@tab

@tab

@tab

%

@item

@ref{4d87,,tp_as_sequence}

@tab

@ref{4884,,PySequenceMethods} *

@tab

@ref{4d86,,sub-ranuras (sub-slots)}

@tab

@tab

@tab

@tab

%

@item

@ref{4d88,,tp_as_mapping}

@tab

@ref{4885,,PyMappingMethods} *

@tab

@ref{4d86,,sub-ranuras (sub-slots)}

@tab

@tab

@tab

@tab

%

@item

@ref{4886,,tp_hash}

@tab

@ref{4a24,,hashfunc}

@tab

__hash__

@tab

X

@tab

@tab

@tab

G

@item

@ref{5fc,,tp_call}

@tab

@ref{4a34,,ternaryfunc}

@tab

__call__

@tab

@tab

X

@tab

@tab

X

@item

@ref{4875,,tp_str}

@tab

@ref{4a2d,,reprfunc}

@tab

__str__

@tab

X

@tab

@tab

@tab

X

@item

@ref{16f8,,tp_getattro}

@tab

@ref{4a20,,getattrofunc}

@tab

__getattribute__,
__getattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{4878,,tp_setattro}

@tab

@ref{4a30,,setattrofunc}

@tab

__setattr__,
__delattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{a1b,,tp_as_buffer}

@tab

@ref{4b30,,PyBufferProcs} *

@tab

@tab

@tab

@tab

@tab

%

@item

@ref{18c6,,tp_flags}

@tab

unsigned long

@tab

@tab

X

@tab

X

@tab

@tab

?

@item

@ref{485b,,tp_doc}

@tab

const char *

@tab

__doc__

@tab

X

@tab

X

@tab

@tab

@item

@ref{818,,tp_traverse}

@tab

@ref{4a35,,traverseproc}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4872,,tp_clear}

@tab

@ref{4a26,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4880,,tp_richcompare}

@tab

@ref{4a2e,,richcmpfunc}

@tab

__lt__,
__le__,
__eq__,
__ne__,
__gt__,
__ge__

@tab

X

@tab

@tab

@tab

G

@item

(@ref{a1a,,tp_weaklistoffset})

@tab

@ref{af0,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{152e,,tp_iter}

@tab

@ref{4a22,,getiterfunc}

@tab

__iter__

@tab

@tab

@tab

@tab

X

@item

@ref{152f,,tp_iternext}

@tab

@ref{4a27,,iternextfunc}

@tab

__next__

@tab

@tab

@tab

@tab

X

@item

@ref{4864,,tp_methods}

@tab

@ref{1517,,PyMethodDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{4862,,tp_members}

@tab

@ref{5f2,,PyMemberDef} []

@tab

@tab

@tab

X

@tab

@tab

@item

@ref{4867,,tp_getset}

@tab

@ref{c40,,PyGetSetDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{486b,,tp_base}

@tab

@ref{b30,,PyTypeObject} *

@tab

__base__

@tab

@tab

@tab

X

@tab

@item

@ref{1725,,tp_dict}

@tab

@ref{42d,,PyObject} *

@tab

__dict__

@tab

@tab

@tab

?

@tab

@item

@ref{4d89,,tp_descr_get}

@tab

@ref{4a1c,,descrgetfunc}

@tab

__get__

@tab

@tab

@tab

@tab

X

@item

@ref{18ff,,tp_descr_set}

@tab

@ref{4a1d,,descrsetfunc}

@tab

__set__,
__delete__

@tab

@tab

@tab

@tab

X

@item

(@ref{4b2b,,tp_dictoffset})

@tab

@ref{af0,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{625,,tp_init}

@tab

@ref{4a25,,initproc}

@tab

__init__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{4861,,tp_alloc}

@tab

@ref{4a1a,,allocfunc}

@tab

@tab

X

@tab

@tab

?

@tab

?

@item

@ref{623,,tp_new}

@tab

@ref{4a29,,newfunc}

@tab

__new__

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{4860,,tp_free}

@tab

@ref{4c21,,freefunc}

@tab

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{4d8a,,tp_is_gc}

@tab

@ref{4a26,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

X

@item

<@ref{4d8b,,tp_bases}>

@tab

@ref{42d,,PyObject} *

@tab

__bases__

@tab

@tab

@tab

~

@tab

@item

<@ref{4b2d,,tp_mro}>

@tab

@ref{42d,,PyObject} *

@tab

__mro__

@tab

@tab

@tab

~

@tab

@item

[@ref{4b2e,,tp_cache}]

@tab

@ref{42d,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

[@ref{616,,tp_subclasses}]

@tab

void *

@tab

__subclasses__

@tab

@tab

@tab

@tab

@item

[@ref{4b2f,,tp_weaklist}]

@tab

@ref{42d,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

(@ref{4d8c,,tp_del})

@tab

@ref{4a1e,,destructor}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{4d8d,,tp_version_tag}]

@tab

unsigned int

@tab

@tab

@tab

@tab

@tab

@item

@ref{b31,,tp_finalize}

@tab

@ref{4a1e,,destructor}

@tab

__del__

@tab

@tab

@tab

@tab

X

@item

@ref{1620,,tp_vectorcall}

@tab

@ref{5fa,,vectorcallfunc}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{4d8e,,tp_watched}]

@tab

unsigned char

@tab

@tab

@tab

@tab

@tab

@end multitable


@node sub-ranuras sub-slots,ranura de typedefs,«ranuras tp» tp slots,Referencia rápida
@anchor{c-api/typeobj id3}@anchor{4d8f}@anchor{c-api/typeobj sub-slots}@anchor{4d86}
@subsubsection sub-ranuras (`sub-slots')



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Ranuras (`Slot')

@tab

@ref{4d85,,Type}

@tab

métodos especiales

@item

@ref{4d90,,am_await}

@tab

@ref{4a36,,unaryfunc}

@tab

__await__

@item

@ref{4d91,,am_aiter}

@tab

@ref{4a36,,unaryfunc}

@tab

__aiter__

@item

@ref{4d92,,am_anext}

@tab

@ref{4a36,,unaryfunc}

@tab

__anext__

@item

@ref{4d93,,am_send}

@tab

@ref{4d94,,sendfunc}

@tab

@item

@tab

@tab

@item

@ref{4b22,,nb_add}

@tab

@ref{4a1b,,binaryfunc}

@tab

__add__
__radd__

@item

@ref{4d95,,nb_inplace_add}

@tab

@ref{4a1b,,binaryfunc}

@tab

__iadd__

@item

@ref{4d96,,nb_subtract}

@tab

@ref{4a1b,,binaryfunc}

@tab

__sub__
__rsub__

@item

@ref{4d97,,nb_inplace_subtract}

@tab

@ref{4a1b,,binaryfunc}

@tab

__isub__

@item

@ref{4d98,,nb_multiply}

@tab

@ref{4a1b,,binaryfunc}

@tab

__mul__
__rmul__

@item

@ref{4d99,,nb_inplace_multiply}

@tab

@ref{4a1b,,binaryfunc}

@tab

__imul__

@item

@ref{4d9a,,nb_remainder}

@tab

@ref{4a1b,,binaryfunc}

@tab

__mod__
__rmod__

@item

@ref{4d9b,,nb_inplace_remainder}

@tab

@ref{4a1b,,binaryfunc}

@tab

__imod__

@item

@ref{4d9c,,nb_divmod}

@tab

@ref{4a1b,,binaryfunc}

@tab

__divmod__
__rdivmod__

@item

@ref{4d9d,,nb_power}

@tab

@ref{4a34,,ternaryfunc}

@tab

__pow__
__rpow__

@item

@ref{4d9e,,nb_inplace_power}

@tab

@ref{4a34,,ternaryfunc}

@tab

__ipow__

@item

@ref{4d9f,,nb_negative}

@tab

@ref{4a36,,unaryfunc}

@tab

__neg__

@item

@ref{4da0,,nb_positive}

@tab

@ref{4a36,,unaryfunc}

@tab

__pos__

@item

@ref{4da1,,nb_absolute}

@tab

@ref{4a36,,unaryfunc}

@tab

__abs__

@item

@ref{4da2,,nb_bool}

@tab

@ref{4a26,,inquiry}

@tab

__bool__

@item

@ref{4da3,,nb_invert}

@tab

@ref{4a36,,unaryfunc}

@tab

__invert__

@item

@ref{4da4,,nb_lshift}

@tab

@ref{4a1b,,binaryfunc}

@tab

__lshift__
__rlshift__

@item

@ref{4da5,,nb_inplace_lshift}

@tab

@ref{4a1b,,binaryfunc}

@tab

__ilshift__

@item

@ref{4da6,,nb_rshift}

@tab

@ref{4a1b,,binaryfunc}

@tab

__rshift__
__rrshift__

@item

@ref{4da7,,nb_inplace_rshift}

@tab

@ref{4a1b,,binaryfunc}

@tab

__irshift__

@item

@ref{4da8,,nb_and}

@tab

@ref{4a1b,,binaryfunc}

@tab

__and__
__rand__

@item

@ref{4da9,,nb_inplace_and}

@tab

@ref{4a1b,,binaryfunc}

@tab

__iand__

@item

@ref{4daa,,nb_xor}

@tab

@ref{4a1b,,binaryfunc}

@tab

__xor__
__rxor__

@item

@ref{4dab,,nb_inplace_xor}

@tab

@ref{4a1b,,binaryfunc}

@tab

__ixor__

@item

@ref{4dac,,nb_or}

@tab

@ref{4a1b,,binaryfunc}

@tab

__or__
__ror__

@item

@ref{4dad,,nb_inplace_or}

@tab

@ref{4a1b,,binaryfunc}

@tab

__ior__

@item

@ref{4dae,,nb_int}

@tab

@ref{4a36,,unaryfunc}

@tab

__int__

@item

@ref{4daf,,nb_reserved}

@tab

void *

@tab

@item

@ref{4db0,,nb_float}

@tab

@ref{4a36,,unaryfunc}

@tab

__float__

@item

@ref{4db1,,nb_floor_divide}

@tab

@ref{4a1b,,binaryfunc}

@tab

__floordiv__

@item

@ref{4db2,,nb_inplace_floor_divide}

@tab

@ref{4a1b,,binaryfunc}

@tab

__ifloordiv__

@item

@ref{4db3,,nb_true_divide}

@tab

@ref{4a1b,,binaryfunc}

@tab

__truediv__

@item

@ref{4db4,,nb_inplace_true_divide}

@tab

@ref{4a1b,,binaryfunc}

@tab

__itruediv__

@item

@ref{145c,,nb_index}

@tab

@ref{4a36,,unaryfunc}

@tab

__index__

@item

@ref{4db5,,nb_matrix_multiply}

@tab

@ref{4a1b,,binaryfunc}

@tab

__matmul__
__rmatmul__

@item

@ref{4db6,,nb_inplace_matrix_multiply}

@tab

@ref{4a1b,,binaryfunc}

@tab

__imatmul__

@item

@tab

@tab

@item

@ref{4db7,,mp_length}

@tab

@ref{4a28,,lenfunc}

@tab

__len__

@item

@ref{1937,,mp_subscript}

@tab

@ref{4a1b,,binaryfunc}

@tab

__getitem__

@item

@ref{4db8,,mp_ass_subscript}

@tab

@ref{4a2a,,objobjargproc}

@tab

__setitem__,
__delitem__

@item

@tab

@tab

@item

@ref{4b2a,,sq_length}

@tab

@ref{4a28,,lenfunc}

@tab

__len__

@item

@ref{4db9,,sq_concat}

@tab

@ref{4a1b,,binaryfunc}

@tab

__add__

@item

@ref{4dba,,sq_repeat}

@tab

@ref{4a32,,ssizeargfunc}

@tab

__mul__

@item

@ref{1936,,sq_item}

@tab

@ref{4a32,,ssizeargfunc}

@tab

__getitem__

@item

@ref{4dbb,,sq_ass_item}

@tab

@ref{4a33,,ssizeobjargproc}

@tab

__setitem__
__delitem__

@item

@ref{4dbc,,sq_contains}

@tab

@ref{4a2b,,objobjproc}

@tab

__contains__

@item

@ref{4dbd,,sq_inplace_concat}

@tab

@ref{4a1b,,binaryfunc}

@tab

__iadd__

@item

@ref{4dbe,,sq_inplace_repeat}

@tab

@ref{4a32,,ssizeargfunc}

@tab

__imul__

@item

@tab

@tab

@item

@ref{7fc,,bf_getbuffer}

@tab

@ref{4a21,,getbufferproc()}

@tab

@item

@ref{7fd,,bf_releasebuffer}

@tab

@ref{4a2c,,releasebufferproc()}

@tab

@end multitable


@node ranura de typedefs,,sub-ranuras sub-slots,Referencia rápida
@anchor{c-api/typeobj slot-typedefs}@anchor{4dbf}@anchor{c-api/typeobj slot-typedefs-table}@anchor{4d85}
@subsubsection ranura de `typedefs'



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

typedef

@tab

Tipos parámetros

@tab

Tipo de retorno

@item

@ref{4a1a,,allocfunc}

@tab


@display
@ref{b30,,PyTypeObject} *@w{ }
@ref{af0,,Py_ssize_t}@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a1e,,destructor}

@tab

@ref{42d,,PyObject} *

@tab

void

@item

@ref{4c21,,freefunc}

@tab

void *

@tab

void

@item

@ref{4a35,,traverseproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{4a37,,visitproc}@w{ }
void *@w{ }
@end display



@tab

int

@item

@ref{4a29,,newfunc}

@tab


@display
@ref{b30,,PyTypeObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a25,,initproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a2d,,reprfunc}

@tab

@ref{42d,,PyObject} *

@tab

@ref{42d,,PyObject} *

@item

@ref{4a1f,,getattrfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
const char *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a2f,,setattrfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
const char *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a20,,getattrofunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a30,,setattrofunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a1c,,descrgetfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a1d,,descrsetfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a24,,hashfunc}

@tab

@ref{42d,,PyObject} *

@tab

Py_hash_t

@item

@ref{4a2e,,richcmpfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
int@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a22,,getiterfunc}

@tab

@ref{42d,,PyObject} *

@tab

@ref{42d,,PyObject} *

@item

@ref{4a27,,iternextfunc}

@tab

@ref{42d,,PyObject} *

@tab

@ref{42d,,PyObject} *

@item

@ref{4a28,,lenfunc}

@tab

@ref{42d,,PyObject} *

@tab

@ref{af0,,Py_ssize_t}

@item

@ref{4a21,,getbufferproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{7f2,,Py_buffer} *@w{ }
int@w{ }
@end display



@tab

int

@item

@ref{4a2c,,releasebufferproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{7f2,,Py_buffer} *@w{ }
@end display



@tab

void

@item

@ref{4a26,,inquiry}

@tab

@ref{42d,,PyObject} *

@tab

int

@item

@ref{4a36,,unaryfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a1b,,binaryfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a34,,ternaryfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a32,,ssizeargfunc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{af0,,Py_ssize_t}@w{ }
@end display



@tab

@ref{42d,,PyObject} *

@item

@ref{4a33,,ssizeobjargproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{af0,,Py_ssize_t}@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a2b,,objobjproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4a2a,,objobjargproc}

@tab


@display
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@ref{42d,,PyObject} *@w{ }
@end display



@tab

int

@end multitable


Vea @ref{4dc0,,Tipo Ranura typedefs} abajo para más detalles.

@node Definición de PyTypeObject,Ranuras Slots PyObject,Referencia rápida,Objetos tipo<2>
@anchor{c-api/typeobj pytypeobject-definition}@anchor{4dc1}
@subsubsection Definición de @code{PyTypeObject}


La definición de estructura para @ref{b30,,PyTypeObject} se puede encontrar en @code{Include/object.h}. Por conveniencia de referencia, esto repite la definición encontrada allí:

@c XXX Drop this?

@example
typedef struct _typeobject @{
    PyObject_VAR_HEAD
    const char *tp_name; /* For printing, in format "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

    /* Methods to implement standard operations */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
                                    or tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* Method suites for standard classes */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* More standard operations (here for binary compatibility) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* Functions to access object as input/output buffer */
    PyBufferProcs *tp_as_buffer;

    /* Flags to define presence of optional/expanded features */
    unsigned long tp_flags;

    const char *tp_doc; /* Documentation string */

    /* Assigned meaning in release 2.0 */
    /* call function for all accessible objects */
    traverseproc tp_traverse;

    /* delete references to contained objects */
    inquiry tp_clear;

    /* Assigned meaning in release 2.1 */
    /* rich comparisons */
    richcmpfunc tp_richcompare;

    /* weak reference enabler */
    Py_ssize_t tp_weaklistoffset;

    /* Iterators */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* Attribute descriptor and subclassing stuff */
    struct PyMethodDef *tp_methods;
    struct PyMemberDef *tp_members;
    struct PyGetSetDef *tp_getset;
    // Strong reference on a heap type, borrowed reference on a static type
    struct _typeobject *tp_base;
    PyObject *tp_dict;
    descrgetfunc tp_descr_get;
    descrsetfunc tp_descr_set;
    Py_ssize_t tp_dictoffset;
    initproc tp_init;
    allocfunc tp_alloc;
    newfunc tp_new;
    freefunc tp_free; /* Low-level free-memory routine */
    inquiry tp_is_gc; /* For PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* method resolution order */
    PyObject *tp_cache;
    PyObject *tp_subclasses;
    PyObject *tp_weaklist;
    destructor tp_del;

    /* Type attribute cache version tag. Added in version 2.6 */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;

    /* bitset of which type-watchers care about this type */
    unsigned char tp_watched;
@} PyTypeObject;
@end example

@node Ranuras Slots PyObject,Ranuras PyVarObject,Definición de PyTypeObject,Objetos tipo<2>
@anchor{c-api/typeobj pyobject-slots}@anchor{4dc2}
@subsubsection Ranuras (`Slots') @code{PyObject}


The type object structure extends the @ref{408a,,PyVarObject} structure. The
@ref{4a08,,ob_size} field is used for dynamic types (created by @code{type_new()},
usually called from a class statement). Note that @ref{5f0,,PyType_Type} (the
metatype) initializes @ref{1f6f,,tp_itemsize}, which means that its instances (i.e.
type objects) `must' have the @ref{4a08,,ob_size} field.

@geindex PyObject.ob_refcnt (C member)
@anchor{c-api/typeobj c PyObject ob_refcnt}@anchor{937}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{42d,,PyObject}.ob_refcnt
` Part of the @ref{5f6,,Stable ABI}.'
This is the type object’s reference count, initialized to @code{1} by the
@code{PyObject_HEAD_INIT} macro.  Note that for @ref{819,,statically allocated type objects}, the type’s instances (objects whose @ref{485d,,ob_type}
points back to the type) do `not' count as references.  But for
@ref{9f8,,dynamically allocated type objects}, the instances `do'
count as references.

`Herencia:'

Este campo no es heredado por los subtipos.
@end deffn

@geindex PyObject.ob_type (C member)
@anchor{c-api/typeobj c PyObject ob_type}@anchor{485d}
@deffn {C Miembro} @ref{b30,,PyTypeObject} *@ref{42d,,PyObject}.ob_type
` Part of the @ref{5f6,,Stable ABI}.'
Este es el tipo del tipo, en otras palabras, su metatipo. Se inicializa mediante el argumento de la macro @code{PyObject_HEAD_INIT}, y su valor normalmente debería ser @code{&PyType_Type}. Sin embargo, para los módulos de extensión cargables dinámicamente que deben ser utilizables en Windows (al menos), el compilador se queja de que este no es un inicializador válido. Por lo tanto, la convención es pasar @code{NULL} al macro @code{PyObject_HEAD_INIT} e inicializar este campo explícitamente al comienzo de la función de inicialización del módulo, antes de hacer cualquier otra cosa. Esto normalmente se hace así:

@example
Foo_Type.ob_type = &PyType_Type;
@end example

This should be done before any instances of the type are created.
@ref{816,,PyType_Ready()} checks if @ref{485d,,ob_type} is @code{NULL}, and if so,
initializes it to the @ref{485d,,ob_type} field of the base class.
@ref{816,,PyType_Ready()} will not change this field if it is non-zero.

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@node Ranuras PyVarObject,Ranuras PyTypeObject,Ranuras Slots PyObject,Objetos tipo<2>
@anchor{c-api/typeobj pyvarobject-slots}@anchor{4dc3}
@subsubsection Ranuras @code{PyVarObject}


@geindex PyVarObject.ob_size (C member)
@anchor{c-api/typeobj c PyVarObject ob_size}@anchor{4a08}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{408a,,PyVarObject}.ob_size
` Part of the @ref{5f6,,Stable ABI}.'
Para @ref{819,,objetos de tipo estáticamente asignados}, debe inicializarse a cero. Para @ref{9f8,,objetos de tipo dinámicamente asignados}, este campo tiene un significado interno especial.

`Herencia:'

Este campo no es heredado por los subtipos.
@end deffn

@node Ranuras PyTypeObject,Tipos estáticos,Ranuras PyVarObject,Objetos tipo<2>
@anchor{c-api/typeobj pytypeobject-slots}@anchor{4dc4}
@subsubsection Ranuras @code{PyTypeObject}


Each slot has a section describing inheritance.  If @ref{816,,PyType_Ready()}
may set a value when the field is set to @code{NULL} then there will also be
a «Default» section.  (Note that many fields set on @code{PyBaseObject_Type}
and @ref{5f0,,PyType_Type} effectively act as defaults.)

@geindex PyTypeObject.tp_name (C member)
@anchor{c-api/typeobj c PyTypeObject tp_name}@anchor{18fb}
@deffn {C Miembro} const char *@ref{b30,,PyTypeObject}.tp_name

Pointer to a NUL-terminated string containing the name of the type. For types
that are accessible as module globals, the string should be the full module
name, followed by a dot, followed by the type name; for built-in types, it
should be just the type name.  If the module is a submodule of a package, the
full package name is part of the full module name.  For example, a type named
@code{T} defined in module @code{M} in subpackage @code{Q} in package @code{P}
should have the @ref{18fb,,tp_name} initializer @code{"P.Q.M.T"}.

Para @ref{9f8,,objetos de tipo dinámicamente asignados}, éste debe ser sólo el nombre del tipo, y el nombre del módulo almacenado explícitamente en el dict tipo que el valor de @code{'__module__'} clave.

For @ref{819,,statically allocated type objects},
the `tp_name' field should contain a dot.
Everything before the last dot is made accessible as the @ref{468,,__module__}
attribute, and everything after the last dot is made accessible as the
@ref{14e7,,__name__} attribute.

If no dot is present, the entire @ref{18fb,,tp_name} field is made accessible as the
@ref{14e7,,__name__} attribute, and the @ref{468,,__module__} attribute is undefined
(unless explicitly set in the dictionary, as explained above).  This means your
type will be impossible to pickle.  Additionally, it will not be listed in
module documentations created with pydoc.

Este campo no debe ser @code{NULL}. Es el único campo obligatorio en @ref{b30,,PyTypeObject()} (que no sea potencialmente @ref{1f6f,,tp_itemsize}).

`Herencia:'

Este campo no es heredado por los subtipos.
@end deffn

@geindex PyTypeObject.tp_basicsize (C member)
@geindex PyTypeObject.tp_itemsize (C member)
@anchor{c-api/typeobj c PyTypeObject tp_basicsize}@anchor{a19}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{b30,,PyTypeObject}.tp_basicsize
@anchor{c-api/typeobj c PyTypeObject tp_itemsize}@anchor{1f6f}
@deffnx {C Miembro} @ref{af0,,Py_ssize_t} @ref{b30,,PyTypeObject}.tp_itemsize

Estos campos permiten calcular el tamaño en bytes de instancias del tipo.

Hay dos tipos de tipos: los tipos con instancias de longitud fija tienen un campo cero @ref{1f6f,,tp_itemsize}, los tipos con instancias de longitud variable tienen un campo distinto de cero @ref{1f6f,,tp_itemsize}. Para un tipo con instancias de longitud fija, todas las instancias tienen el mismo tamaño, dado en @ref{a19,,tp_basicsize}.

For a type with variable-length instances, the instances must have an
@ref{4a08,,ob_size} field, and the instance size is @ref{a19,,tp_basicsize} plus N
times @ref{1f6f,,tp_itemsize}, where N is the «length» of the object.  The value of
N is typically stored in the instance’s @ref{4a08,,ob_size} field.  There are
exceptions:  for example, ints use a negative @ref{4a08,,ob_size} to indicate a
negative number, and N is @code{abs(ob_size)} there.  Also, the presence of an
@ref{4a08,,ob_size} field in the instance layout doesn’t mean that the instance
structure is variable-length (for example, the structure for the list type has
fixed-length instances, yet those instances have a meaningful @ref{4a08,,ob_size}
field).

The basic size includes the fields in the instance declared by the macro
@ref{1345,,PyObject_HEAD} or @ref{4d59,,PyObject_VAR_HEAD} (whichever is used to
declare the instance struct) and this in turn includes the  @code{_ob_prev} and
@code{_ob_next} fields if they are present.  This means that the only correct
way to get an initializer for the @ref{a19,,tp_basicsize} is to use the
@code{sizeof} operator on the struct used to declare the instance layout.
The basic size does not include the GC header size.

Una nota sobre la alineación: si los elementos variables requieren una alineación particular, esto debe ser atendido por el valor de @ref{a19,,tp_basicsize}. Ejemplo: supongamos que un tipo implementa un arreglo de dobles (@code{double}). @ref{1f6f,,tp_itemsize} es @code{sizeof(double)}. Es responsabilidad del programador que @ref{a19,,tp_basicsize} es un múltiplo de @code{sizeof(double)} (suponiendo que este sea el requisito de alineación para @code{double}).

Para cualquier tipo con instancias de longitud variable, este campo no debe ser @code{NULL}.

`Herencia:'

Estos campos se heredan por separado por subtipos. Si el tipo base tiene un miembro distinto de cero @ref{1f6f,,tp_itemsize}, generalmente no es seguro establecer @ref{1f6f,,tp_itemsize} en un valor diferente de cero en un subtipo ( aunque esto depende de la implementación del tipo base).
@end deffn

@geindex PyTypeObject.tp_dealloc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dealloc}@anchor{485f}
@deffn {C Miembro} @ref{4a1e,,destructor} @ref{b30,,PyTypeObject}.tp_dealloc

Un puntero a la función destructor de instancias. Esta función debe definirse a menos que el tipo garantice que sus instancias nunca se desasignarán (como es el caso de los singletons @code{None} y @code{Ellipsis}). La firma de la función es:

@example
void tp_dealloc(PyObject *self);
@end example

The destructor function is called by the @ref{613,,Py_DECREF()} and
@ref{828,,Py_XDECREF()} macros when the new reference count is zero.  At this point,
the instance is still in existence, but there are no references to it.  The
destructor function should free all references which the instance owns, free all
memory buffers owned by the instance (using the freeing function corresponding
to the allocation function used to allocate the buffer), and call the type’s
@ref{4860,,tp_free} function.  If the type is not subtypable
(doesn’t have the @ref{4865,,Py_TPFLAGS_BASETYPE} flag bit set), it is
permissible to call the object deallocator directly instead of via
@ref{4860,,tp_free}.  The object deallocator should be the one used to allocate the
instance; this is normally @ref{ced,,PyObject_Free()} if the instance was allocated
using @ref{a17,,PyObject_New} or @ref{a18,,PyObject_NewVar}, or
@ref{1545,,PyObject_GC_Del()} if the instance was allocated using
@ref{b2d,,PyObject_GC_New} or @ref{b2e,,PyObject_GC_NewVar}.

If the type supports garbage collection (has the @ref{817,,Py_TPFLAGS_HAVE_GC}
flag bit set), the destructor should call @ref{1547,,PyObject_GC_UnTrack()}
before clearing any member fields.

@example
static void foo_dealloc(foo_object *self) @{
    PyObject_GC_UnTrack(self);
    Py_CLEAR(self->ref);
    Py_TYPE(self)->tp_free((PyObject *)self);
@}
@end example

Finally, if the type is heap allocated (@ref{946,,Py_TPFLAGS_HEAPTYPE}), the
deallocator should release the owned reference to its type object
(via @ref{613,,Py_DECREF()})  after
calling the type deallocator. In order to avoid dangling pointers, the
recommended way to achieve this is:

@example
static void foo_dealloc(foo_object *self) @{
    PyTypeObject *tp = Py_TYPE(self);
    // free references and buffers here
    tp->tp_free(self);
    Py_DECREF(tp);
@}
@end example

@cartouche
@quotation Advertencia 
In a garbage collected Python, @code{tp_dealloc} may be called from
any Python thread, not just the thread which created the object (if the
object becomes part of a refcount cycle, that cycle might be collected by
a garbage collection on any thread).  This is not a problem for Python
API calls, since the thread on which @code{tp_dealloc} is called
will own the Global Interpreter Lock (GIL).  However, if the object being
destroyed in turn destroys objects from some other C or C++ library, care
should be taken to ensure that destroying those objects on the thread
which called @code{tp_dealloc} will not violate any assumptions of
the library.
@end quotation
@end cartouche

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_vectorcall_offset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_vectorcall_offset}@anchor{4acd}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{b30,,PyTypeObject}.tp_vectorcall_offset

Un desplazamiento opcional a una función por instancia que implementa la llamada al objeto usando @ref{5f5,,vectorcall protocol}, una alternativa más eficiente del simple @ref{5fc,,tp_call}.

This field is only used if the flag @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL}
is set. If so, this must be a positive integer containing the offset in the
instance of a @ref{5fa,,vectorcallfunc} pointer.

The `vectorcallfunc' pointer may be @code{NULL}, in which case the instance behaves
as if @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} was not set: calling the instance
falls back to @ref{5fc,,tp_call}.

Cualquier clase que establezca @code{_Py_TPFLAGS_HAVE_VECTORCALL} también debe establecer @ref{5fc,,tp_call} y asegurarse de que su comportamiento sea coherente con la función `vectorcallfunc'. Esto se puede hacer configurando `tp_call' en @ref{5f9,,PyVectorcall_Call()}.


Distinto en la versión 3.8: Antes de la versión 3.8, este slot se llamaba @code{tp_print}. En Python 2.x, se usó para imprimir en un archivo. En Python 3.0 a 3.7, no se usó.



Distinto en la versión 3.12: Before version 3.12, it was not recommended for
@ref{9f8,,mutable heap types} to implement the vectorcall
protocol.
When a user sets @ref{5fb,,__call__} in Python code, only `tp_call' is
updated, likely making it inconsistent with the vectorcall function.
Since 3.12, setting @code{__call__} will disable vectorcall optimization
by clearing the @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag.


`Herencia:'

This field is always inherited.
However, the @ref{5f7,,Py_TPFLAGS_HAVE_VECTORCALL} flag is not
always inherited. If it’s not set, then the subclass won’t use
@ref{5f5,,vectorcall}, except when
@ref{5f9,,PyVectorcall_Call()} is explicitly called.
@end deffn

@geindex PyTypeObject.tp_getattr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getattr}@anchor{487d}
@deffn {C Miembro} @ref{4a1f,,getattrfunc} @ref{b30,,PyTypeObject}.tp_getattr

Un puntero opcional a la función «obtener atributo cadena de caracteres» (`get-attribute-string').

Este campo está en desuso. Cuando se define, debe apuntar a una función que actúe igual que la función @ref{16f8,,tp_getattro}, pero tomando una cadena de caracteres C en lugar de un objeto de cadena Python para dar el nombre del atributo.

`Herencia:'

Group: @ref{487d,,tp_getattr}, @ref{16f8,,tp_getattro}

Este campo es heredado por los subtipos junto con @ref{16f8,,tp_getattro}: un subtipo hereda ambos @ref{487d,,tp_getattr} y @ref{16f8,,tp_getattro} de su base escriba cuando los subtipos @ref{487d,,tp_getattr} y @ref{16f8,,tp_getattro} son ambos @code{NULL}.
@end deffn

@geindex PyTypeObject.tp_setattr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_setattr}@anchor{487e}
@deffn {C Miembro} @ref{4a2f,,setattrfunc} @ref{b30,,PyTypeObject}.tp_setattr

Un puntero opcional a la función para configurar y eliminar atributos.

Este campo está en desuso. Cuando se define, debe apuntar a una función que actúe igual que la función @ref{4878,,tp_setattro}, pero tomando una cadena de caracteres C en lugar de un objeto de cadena Python para dar el nombre del atributo.

`Herencia:'

Group: @ref{487e,,tp_setattr}, @ref{4878,,tp_setattro}

Este campo es heredado por los subtipos junto con @ref{4878,,tp_setattro}: un subtipo hereda ambos @ref{487e,,tp_setattr} y @ref{4878,,tp_setattro} de su base escriba cuando los subtipos @ref{487e,,tp_setattr} y @ref{4878,,tp_setattro} son ambos @code{NULL}.
@end deffn

@geindex PyTypeObject.tp_as_async (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_async}@anchor{f50}
@deffn {C Miembro} @ref{4b29,,PyAsyncMethods} *@ref{b30,,PyTypeObject}.tp_as_async

Puntero a una estructura adicional que contiene campos relevantes solo para los objetos que implementan los protocolos «esperable» (@ref{314,,awaitable}) y «iterador asíncrono» (@ref{312,,asynchronous iterator}) en el nivel C. Ver @ref{4dc5,,Estructuras de objetos asíncronos} para más detalles.


Added in version 3.5: Anteriormente conocidos como @code{tp_compare} y @code{tp_reserved}.


`Herencia:'

El campo @ref{f50,,tp_as_async} no se hereda, pero los campos contenidos se heredan individualmente.
@end deffn

@geindex PyTypeObject.tp_repr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_repr}@anchor{4874}
@deffn {C Miembro} @ref{4a2d,,reprfunc} @ref{b30,,PyTypeObject}.tp_repr

@geindex built-in function;repr

Un puntero opcional a una función que implementa la función incorporada @ref{894,,repr()}.

La firma es la misma que para @ref{10ab,,PyObject_Repr()}:

@example
PyObject *tp_repr(PyObject *self);
@end example

La función debe retornar una cadena de caracteres o un objeto Unicode. Idealmente, esta función debería retornar una cadena que, cuando se pasa a @ref{2eb,,eval()}, dado un entorno adecuado, retorna un objeto con el mismo valor. Si esto no es factible, debe retornar una cadena que comience con @code{'<'} y termine con @code{'>'} desde la cual se puede deducir tanto el tipo como el valor del objeto.

`Herencia:'

Este campo es heredado por subtipos.

`Por defecto:'

Cuando este campo no está configurado, se retorna una cadena de caracteres de la forma @code{<%s object at %p>}, donde @code{%s} se reemplaza por el nombre del tipo y @code{%p} por dirección de memoria del objeto.
@end deffn

@geindex PyTypeObject.tp_as_number (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_number}@anchor{a1d}
@deffn {C Miembro} @ref{145d,,PyNumberMethods} *@ref{b30,,PyTypeObject}.tp_as_number

Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo numérico. Estos campos están documentados en @ref{4dc6,,Estructuras de objetos de números}.

`Herencia:'

El campo @ref{a1d,,tp_as_number} no se hereda, pero los campos contenidos se heredan individualmente.
@end deffn

@geindex PyTypeObject.tp_as_sequence (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_sequence}@anchor{4d87}
@deffn {C Miembro} @ref{4884,,PySequenceMethods} *@ref{b30,,PyTypeObject}.tp_as_sequence

Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo de secuencia. Estos campos están documentados en @ref{4dc7,,estructuras de secuencia}.

`Herencia:'

El campo @ref{4d87,,tp_as_sequence} no se hereda, pero los campos contenidos se heredan individualmente.
@end deffn

@geindex PyTypeObject.tp_as_mapping (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_mapping}@anchor{4d88}
@deffn {C Miembro} @ref{4885,,PyMappingMethods} *@ref{b30,,PyTypeObject}.tp_as_mapping

Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo de mapeo. Estos campos están documentados en @ref{4dc8,,Estructuras de objetos mapeo}.

`Herencia:'

El campo @ref{4d88,,tp_as_mapping} no se hereda, pero los campos contenidos se heredan individualmente.
@end deffn

@geindex PyTypeObject.tp_hash (C member)
@anchor{c-api/typeobj c PyTypeObject tp_hash}@anchor{4886}
@deffn {C Miembro} @ref{4a24,,hashfunc} @ref{b30,,PyTypeObject}.tp_hash

@geindex built-in function;hash

Un puntero opcional a una función que implementa la función incorporada @ref{68b,,hash()}.

La firma es la misma que para @ref{29a,,PyObject_Hash()}:

@example
Py_hash_t tp_hash(PyObject *);
@end example

El valor @code{-1} no debe retornarse como un valor de retorno normal; Cuando se produce un error durante el cálculo del valor `hash', la función debe establecer una excepción y retornar @code{-1}.

When this field is not set (`and' @ref{4880,,tp_richcompare} is not set),
an attempt to take the hash of the object raises @ref{228,,TypeError}.
This is the same as setting it to @ref{1406,,PyObject_HashNotImplemented()}.

Este campo se puede establecer explícitamente en @ref{1406,,PyObject_HashNotImplemented()} para bloquear la herencia del método `hash' de un tipo primario. Esto se interpreta como el equivalente de @code{__hash__ = None} en el nivel de Python, lo que hace que @code{isinstance(o, collections.Hashable)} retorne correctamente @code{False}. Tenga en cuenta que lo contrario también es cierto: establecer @code{__hash__ = None} en una clase en el nivel de Python dará como resultado que la ranura @code{tp_hash} se establezca en @ref{1406,,PyObject_HashNotImplemented()}.

`Herencia:'

Group: @ref{4886,,tp_hash}, @ref{4880,,tp_richcompare}

Este campo es heredado por subtipos junto con @ref{4880,,tp_richcompare}: un subtipo hereda ambos @ref{4880,,tp_richcompare} y @ref{4886,,tp_hash}, cuando los subtipos @ref{4880,,tp_richcompare} y @ref{4886,,tp_hash} son ambos @code{NULL}.

`Por defecto:'

@code{PyBaseObject_Type} uses @ref{45b,,PyObject_GenericHash()}.
@end deffn

@geindex PyTypeObject.tp_call (C member)
@anchor{c-api/typeobj c PyTypeObject tp_call}@anchor{5fc}
@deffn {C Miembro} @ref{4a34,,ternaryfunc} @ref{b30,,PyTypeObject}.tp_call

Un puntero opcional a una función que implementa la llamada al objeto. Esto debería ser @code{NULL} si el objeto no es invocable. La firma es la misma que para @ref{48f,,PyObject_Call()}:

@example
PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);
@end example

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_str (C member)
@anchor{c-api/typeobj c PyTypeObject tp_str}@anchor{4875}
@deffn {C Miembro} @ref{4a2d,,reprfunc} @ref{b30,,PyTypeObject}.tp_str

Un puntero opcional a una función que implementa la operación integrada @ref{237,,str()}. (Tenga en cuenta que @ref{237,,str} es un tipo ahora, y @ref{237,,str()} llama al constructor para ese tipo. Este constructor llama a @ref{10ac,,PyObject_Str()} para hacer el trabajo real, y @ref{10ac,,PyObject_Str()} llamará a este controlador.)

La firma es la misma que para @ref{10ac,,PyObject_Str()}:

@example
PyObject *tp_str(PyObject *self);
@end example

La función debe retornar una cadena de caracteres o un objeto Unicode. Debe ser una representación de cadena «amigable» del objeto, ya que esta es la representación que será utilizada, entre otras cosas, por la función @ref{ff4,,print()}.

`Herencia:'

Este campo es heredado por subtipos.

`Por defecto:'

Cuando este campo no está configurado, se llama a @ref{10ab,,PyObject_Repr()} para retornar una representación de cadena de caracteres.
@end deffn

@geindex PyTypeObject.tp_getattro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getattro}@anchor{16f8}
@deffn {C Miembro} @ref{4a20,,getattrofunc} @ref{b30,,PyTypeObject}.tp_getattro

Un puntero opcional a la función «obtener atributo» (`get-attribute').

La firma es la misma que para @ref{43f,,PyObject_GetAttr()}:

@example
PyObject *tp_getattro(PyObject *self, PyObject *attr);
@end example

Por lo general, es conveniente establecer este campo en @ref{4993,,PyObject_GenericGetAttr()}, que implementa la forma normal de buscar atributos de objeto.

`Herencia:'

Group: @ref{487d,,tp_getattr}, @ref{16f8,,tp_getattro}

Este campo es heredado por los subtipos junto con @ref{487d,,tp_getattr}: un subtipo hereda ambos @ref{487d,,tp_getattr} y @ref{16f8,,tp_getattro} de su base escriba cuando los subtipos @ref{487d,,tp_getattr} y @ref{16f8,,tp_getattro} son ambos @code{NULL}.

`Por defecto:'

@code{PyBaseObject_Type} uses @ref{4993,,PyObject_GenericGetAttr()}.
@end deffn

@geindex PyTypeObject.tp_setattro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_setattro}@anchor{4878}
@deffn {C Miembro} @ref{4a30,,setattrofunc} @ref{b30,,PyTypeObject}.tp_setattro

Un puntero opcional a la función para configurar y eliminar atributos.

La firma es la misma que para @ref{499b,,PyObject_SetAttr()}:

@example
int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);
@end example

Además, se debe admitir la configuración de `value' en @code{NULL} para eliminar un atributo. Por lo general, es conveniente establecer este campo en @ref{4994,,PyObject_GenericSetAttr()}, que implementa la forma normal de establecer los atributos del objeto.

`Herencia:'

Group: @ref{487e,,tp_setattr}, @ref{4878,,tp_setattro}

Los subtipos heredan este campo junto con @ref{487e,,tp_setattr}: un subtipo hereda ambos @ref{487e,,tp_setattr} y @ref{4878,,tp_setattro} de su base escriba cuando los subtipos @ref{487e,,tp_setattr} y @ref{4878,,tp_setattro} son ambos @code{NULL}.

`Por defecto:'

@code{PyBaseObject_Type} uses @ref{4994,,PyObject_GenericSetAttr()}.
@end deffn

@geindex PyTypeObject.tp_as_buffer (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_buffer}@anchor{a1b}
@deffn {C Miembro} @ref{4b30,,PyBufferProcs} *@ref{b30,,PyTypeObject}.tp_as_buffer

Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan la interfaz del búfer. Estos campos están documentados en @ref{4aed,,Estructuras de objetos búfer}.

`Herencia:'

El campo @ref{a1b,,tp_as_buffer} no se hereda, pero los campos contenidos se heredan individualmente.
@end deffn

@geindex PyTypeObject.tp_flags (C member)
@anchor{c-api/typeobj c PyTypeObject tp_flags}@anchor{18c6}
@deffn {C Miembro} unsigned long @ref{b30,,PyTypeObject}.tp_flags

Este campo es una máscara de bits de varias banderas. Algunas banderas indican semántica variante para ciertas situaciones; otros se utilizan para indicar que ciertos campos en el tipo de objeto (o en las estructuras de extensión a las que se hace referencia a través de @ref{a1d,,tp_as_number}, @ref{4d87,,tp_as_sequence}, @ref{4d88,,tp_as_mapping}, y @ref{a1b,,tp_as_buffer}) que históricamente no siempre estuvieron presentes son válidos; si dicho bit de bandera está claro, no se debe acceder a los campos de tipo que protege y se debe considerar que tienen un valor cero o @code{NULL}.

`Herencia:'

Inheritance of this field is complicated.  Most flag bits are inherited
individually, i.e. if the base type has a flag bit set, the subtype inherits
this flag bit.  The flag bits that pertain to extension structures are strictly
inherited if the extension structure is inherited, i.e. the base type’s value of
the flag bit is copied into the subtype together with a pointer to the extension
structure.  The @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is inherited together with
the @ref{818,,tp_traverse} and @ref{4872,,tp_clear} fields, i.e. if the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is clear in the subtype and the
@ref{818,,tp_traverse} and @ref{4872,,tp_clear} fields in the subtype exist and have
@code{NULL} values.
.. XXX are most flag bits `really' inherited individually?

`Por defecto:'

@code{PyBaseObject_Type} uses
@code{Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE}.

`Máscaras de bits:'

Las siguientes máscaras de bits están definidas actualmente; estos se pueden unidos por `OR' usando el operador @code{|} para formar el valor del campo @ref{18c6,,tp_flags}. El macro @ref{195d,,PyType_HasFeature()} toma un tipo y un valor de banderas, `tp' y `f', y comprueba si @code{tp->tp_flags & f} no es cero.

@geindex Py_TPFLAGS_HEAPTYPE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HEAPTYPE}@anchor{946}
@deffn {C Macro} Py_TPFLAGS_HEAPTYPE

This bit is set when the type object itself is allocated on the heap, for
example, types created dynamically using @ref{621,,PyType_FromSpec()}.  In this
case, the @ref{485d,,ob_type} field of its instances is considered a reference to
the type, and the type object is INCREF’ed when a new instance is created, and
DECREF’ed when an instance is destroyed (this does not apply to instances of
subtypes; only the type referenced by the instance’s ob_type gets INCREF’ed or
DECREF’ed). Heap types should also @ref{4dc9,,support garbage collection}
as they can form a reference cycle with their own module object.

`Herencia:'

???
@end deffn

@geindex Py_TPFLAGS_BASETYPE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_BASETYPE}@anchor{4865}
@deffn {C Macro} Py_TPFLAGS_BASETYPE

Este bit se establece cuando el tipo se puede usar como el tipo base de otro tipo. Si este bit es claro, el tipo no puede subtiparse (similar a una clase «final» en Java).

`Herencia:'

???
@end deffn

@geindex Py_TPFLAGS_READY (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_READY}@anchor{4dca}
@deffn {C Macro} Py_TPFLAGS_READY

Este bit se establece cuando el objeto tipo ha sido completamente inicializado por @ref{816,,PyType_Ready()}.

`Herencia:'

???
@end deffn

@geindex Py_TPFLAGS_READYING (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_READYING}@anchor{4dcb}
@deffn {C Macro} Py_TPFLAGS_READYING

Este bit se establece mientras @ref{816,,PyType_Ready()} está en el proceso de inicialización del objeto tipo.

`Herencia:'

???
@end deffn

@geindex Py_TPFLAGS_HAVE_GC (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_GC}@anchor{817}
@deffn {C Macro} Py_TPFLAGS_HAVE_GC

This bit is set when the object supports garbage collection.  If this bit
is set, instances must be created using @ref{b2d,,PyObject_GC_New} and
destroyed using @ref{1545,,PyObject_GC_Del()}.  More information in section
@ref{4dc9,,Apoyo a la recolección de basura cíclica}.  This bit also implies that the
GC-related fields @ref{818,,tp_traverse} and @ref{4872,,tp_clear} are present in
the type object.

`Herencia:'

Group: @ref{817,,Py_TPFLAGS_HAVE_GC}, @ref{818,,tp_traverse}, @ref{4872,,tp_clear}

The @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is inherited
together with the @ref{818,,tp_traverse} and @ref{4872,,tp_clear}
fields, i.e.  if the @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is
clear in the subtype and the @ref{818,,tp_traverse} and
@ref{4872,,tp_clear} fields in the subtype exist and have @code{NULL}
values.
@end deffn

@geindex Py_TPFLAGS_DEFAULT (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_DEFAULT}@anchor{485a}
@deffn {C Macro} Py_TPFLAGS_DEFAULT

This is a bitmask of all the bits that pertain to the existence of certain
fields in the type object and its extension structures. Currently, it includes
the following bits: @code{Py_TPFLAGS_HAVE_STACKLESS_EXTENSION}.

`Herencia:'

???
@end deffn

@geindex Py_TPFLAGS_METHOD_DESCRIPTOR (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_METHOD_DESCRIPTOR}@anchor{4ad5}
@deffn {C Macro} Py_TPFLAGS_METHOD_DESCRIPTOR

Este bit indica que los objetos se comportan como métodos independientes.

Si este indicador está configurado para @code{type(meth)}, entonces:


@itemize -

@item 
@code{meth.__get__(obj, cls)(*args, **kwds)} (con @code{obj} no @code{None}) debe ser equivalente a @code{meth(obj, *args, **kwds)}.

@item 
@code{meth.__get__(None, cls)(*args, **kwds)} debe ser equivalente a @code{meth(*args, **kwds)}.
@end itemize

Este indicador (`flag') permite una optimización para llamadas a métodos típicos como @code{obj.meth()}: evita crear un objeto temporal de «método vinculado» para @code{obj.meth}.


Added in version 3.8.


`Herencia:'

This flag is never inherited by types without the
@ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} flag set.  For extension types, it is
inherited whenever @ref{4d89,,tp_descr_get} is inherited.
@end deffn

@geindex Py_TPFLAGS_MANAGED_DICT (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_MANAGED_DICT}@anchor{45f}
@deffn {C Macro} Py_TPFLAGS_MANAGED_DICT

This bit indicates that instances of the class have a @cite{~object.__dict__}
attribute, and that the space for the dictionary is managed by the VM.

If this flag is set, @ref{817,,Py_TPFLAGS_HAVE_GC} should also be set.

The type traverse function must call @ref{45d,,PyObject_VisitManagedDict()}
and its clear function must call @ref{45e,,PyObject_ClearManagedDict()}.


Added in version 3.12.


`Herencia:'

This flag is inherited unless the
@ref{4b2b,,tp_dictoffset} field is set in a superclass.
@end deffn

@geindex Py_TPFLAGS_MANAGED_WEAKREF (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_MANAGED_WEAKREF}@anchor{5fd}
@deffn {C Macro} Py_TPFLAGS_MANAGED_WEAKREF

This bit indicates that instances of the class should be weakly
referenceable.


Added in version 3.12.


`Herencia:'

This flag is inherited unless the
@ref{a1a,,tp_weaklistoffset} field is set in a superclass.
@end deffn

@geindex Py_TPFLAGS_ITEMS_AT_END (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_ITEMS_AT_END}@anchor{5ee}
@deffn {C Macro} Py_TPFLAGS_ITEMS_AT_END

Only usable with variable-size types, i.e. ones with non-zero
@ref{1f6f,,tp_itemsize}.

Indicates that the variable-sized portion of an instance of this type is
at the end of the instance’s memory area, at an offset of
@code{Py_TYPE(obj)->tp_basicsize} (which may be different in each
subclass).

When setting this flag, be sure that all superclasses either
use this memory layout, or are not variable-sized.
Python does not check this.


Added in version 3.12.


`Herencia:'

This flag is inherited.
@end deffn

@c XXX Document more flags here?

@geindex Py_TPFLAGS_LONG_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_LONG_SUBCLASS}@anchor{4dcc}
@deffn {C Macro} Py_TPFLAGS_LONG_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_LIST_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_LIST_SUBCLASS}@anchor{4dcd}
@deffn {C Macro} Py_TPFLAGS_LIST_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_TUPLE_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_TUPLE_SUBCLASS}@anchor{4dce}
@deffn {C Macro} Py_TPFLAGS_TUPLE_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_BYTES_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_BYTES_SUBCLASS}@anchor{4dcf}
@deffn {C Macro} Py_TPFLAGS_BYTES_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_UNICODE_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_UNICODE_SUBCLASS}@anchor{4dd0}
@deffn {C Macro} Py_TPFLAGS_UNICODE_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_DICT_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_DICT_SUBCLASS}@anchor{4dd1}
@deffn {C Macro} Py_TPFLAGS_DICT_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_BASE_EXC_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_BASE_EXC_SUBCLASS}@anchor{4dd2}
@deffn {C Macro} Py_TPFLAGS_BASE_EXC_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_TYPE_SUBCLASS (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_TYPE_SUBCLASS}@anchor{4dd3}
@deffn {C Macro} Py_TPFLAGS_TYPE_SUBCLASS

Estas marcas son utilizadas por funciones como @ref{4b3b,,PyLong_Check()} para determinar rápidamente si un tipo es una subclase de un tipo incorporado; dichos controles específicos son más rápidos que un control genérico, como @ref{f27,,PyObject_IsInstance()}. Los tipos personalizados que heredan de los elementos integrados deben tener su @ref{18c6,,tp_flags} configurado correctamente, o el código que interactúa con dichos tipos se comportará de manera diferente dependiendo del tipo de verificación que se use.
@end deffn

@geindex Py_TPFLAGS_HAVE_FINALIZE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_FINALIZE}@anchor{289}
@deffn {C Macro} Py_TPFLAGS_HAVE_FINALIZE

Este bit se establece cuando la ranura @ref{b31,,tp_finalize} está presente en la estructura de tipo.


Added in version 3.4.



Obsoleto desde la versión 3.8: Este indicador ya no es necesario, ya que el intérprete asume que: el espacio @ref{b31,,tp_finalize} siempre está presente en la estructura de tipos.

@end deffn

@geindex Py_TPFLAGS_HAVE_VECTORCALL (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_VECTORCALL}@anchor{5f7}
@deffn {C Macro} Py_TPFLAGS_HAVE_VECTORCALL

Este bit se establece cuando la clase implementa @ref{5f5,,protocolo vectorcall}. Consulte @ref{4acd,,tp_vectorcall_offset} para obtener más detalles.

`Herencia:'

This bit is inherited if @ref{5fc,,tp_call} is also
inherited.


Added in version 3.9.



Distinto en la versión 3.12: This flag is now removed from a class when the class’s
@ref{5fb,,__call__()} method is reassigned.

This flag can now be inherited by mutable classes.

@end deffn

@geindex Py_TPFLAGS_IMMUTABLETYPE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_IMMUTABLETYPE}@anchor{2a7}
@deffn {C Macro} Py_TPFLAGS_IMMUTABLETYPE

Este bit se establece para objetos de tipo que son inmutables: los atributos de tipo no se pueden establecer ni eliminar.

@ref{816,,PyType_Ready()} aplica automáticamente este indicador a @ref{819,,static types}.

`Herencia:'

Este flag no se hereda.


Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_DISALLOW_INSTANTIATION (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_DISALLOW_INSTANTIATION}@anchor{626}
@deffn {C Macro} Py_TPFLAGS_DISALLOW_INSTANTIATION

No permita la creación de instancias del tipo: establezca @ref{623,,tp_new} en NULL y no cree la clave @code{__new__} en el diccionario de tipos.

La bandera debe establecerse antes de crear el tipo, no después. Por ejemplo, debe establecerse antes de que se llame a @ref{816,,PyType_Ready()} en el tipo.

La bandera se establece automáticamente en @ref{819,,static types} si @ref{486b,,tp_base} es NULL o @code{&PyBaseObject_Type} y @ref{623,,tp_new} es NULL.

`Herencia:'

This flag is not inherited.
However, subclasses will not be instantiable unless they provide a
non-NULL @ref{623,,tp_new} (which is only possible
via the C API).

@cartouche
@quotation Nota 
To disallow instantiating a class directly but allow instantiating
its subclasses (e.g. for an @ref{1224,,abstract base class}),
do not use this flag.
Instead, make @ref{623,,tp_new} only succeed for
subclasses.
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_MAPPING (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_MAPPING}@anchor{18ac}
@deffn {C Macro} Py_TPFLAGS_MAPPING

Este bit indica que las instancias de la clase pueden coincidir con los patrones de correspondencia cuando se utilizan como sujeto de un bloque @ref{8a4,,match}. Se configura automáticamente al registrar o subclasificar @ref{961,,collections.abc.Mapping}, y se desarma al registrar @ref{1231,,collections.abc.Sequence}.

@cartouche
@quotation Nota 
@ref{18ac,,Py_TPFLAGS_MAPPING} and @ref{18ad,,Py_TPFLAGS_SEQUENCE} are
mutually exclusive; it is an error to enable both flags simultaneously.
@end quotation
@end cartouche

`Herencia:'

This flag is inherited by types that do not already set
@ref{18ad,,Py_TPFLAGS_SEQUENCE}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} - Coincidencia de patrones estructurales: especificación



Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_SEQUENCE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_SEQUENCE}@anchor{18ad}
@deffn {C Macro} Py_TPFLAGS_SEQUENCE

Este bit indica que las instancias de la clase pueden coincidir con los patrones de secuencia cuando se utilizan como sujeto de un bloque @ref{8a4,,match}. Se configura automáticamente al registrar o subclasificar @ref{1231,,collections.abc.Sequence}, y se desarma al registrar @ref{961,,collections.abc.Mapping}.

@cartouche
@quotation Nota 
@ref{18ac,,Py_TPFLAGS_MAPPING} and @ref{18ad,,Py_TPFLAGS_SEQUENCE} are
mutually exclusive; it is an error to enable both flags simultaneously.
@end quotation
@end cartouche

`Herencia:'

This flag is inherited by types that do not already set
@ref{18ac,,Py_TPFLAGS_MAPPING}.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} - Coincidencia de patrones estructurales: especificación



Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_VALID_VERSION_TAG (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_VALID_VERSION_TAG}@anchor{4dd4}
@deffn {C Macro} Py_TPFLAGS_VALID_VERSION_TAG

Internal. Do not set or unset this flag.
To indicate that a class has changed call @ref{17f9,,PyType_Modified()}

@cartouche
@quotation Advertencia 
This flag is present in header files, but is not be used.
It will be removed in a future version of CPython
@end quotation
@end cartouche
@end deffn
@end deffn

@geindex PyTypeObject.tp_doc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_doc}@anchor{485b}
@deffn {C Miembro} const char *@ref{b30,,PyTypeObject}.tp_doc

An optional pointer to a NUL-terminated C string giving the docstring for this
type object.  This is exposed as the @ref{1cb3,,__doc__} attribute on the
type and instances of the type.

`Herencia:'

Este campo es `no' heredado por los subtipos.
@end deffn

@geindex PyTypeObject.tp_traverse (C member)
@anchor{c-api/typeobj c PyTypeObject tp_traverse}@anchor{818}
@deffn {C Miembro} @ref{4a35,,traverseproc} @ref{b30,,PyTypeObject}.tp_traverse

An optional pointer to a traversal function for the garbage collector.  This is
only used if the @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is set.  The signature is:

@example
int tp_traverse(PyObject *self, visitproc visit, void *arg);
@end example

Se puede encontrar más información sobre el esquema de recolección de basura de Python en la sección @ref{4dc9,,Apoyo a la recolección de basura cíclica}.

The @ref{818,,tp_traverse} pointer is used by the garbage collector to detect
reference cycles. A typical implementation of a @ref{818,,tp_traverse} function
simply calls @ref{4869,,Py_VISIT()} on each of the instance’s members that are Python
objects that the instance owns. For example, this is function @code{local_traverse()} from the
@code{_thread} extension module:

@example
static int
local_traverse(localobject *self, visitproc visit, void *arg)
@{
    Py_VISIT(self->args);
    Py_VISIT(self->kw);
    Py_VISIT(self->dict);
    return 0;
@}
@end example

Tenga en cuenta que @ref{4869,,Py_VISIT()} solo se llama a aquellos miembros que pueden participar en los ciclos de referencia. Aunque también hay un miembro @code{self->key}, solo puede ser @code{NULL} o una cadena de caracteres de Python y, por lo tanto, no puede ser parte de un ciclo de referencia.

Por otro lado, incluso si sabe que un miembro nunca puede ser parte de un ciclo, como ayuda para la depuración puede visitarlo de todos modos solo para que la función @ref{89c,,get_referents()} del módulo @ref{60,,gc} lo incluirá.

Heap types (@ref{946,,Py_TPFLAGS_HEAPTYPE}) must visit their type with:

@example
Py_VISIT(Py_TYPE(self));
@end example

It is only needed since Python 3.9. To support Python 3.8 and older, this
line must be conditional:

@example
#if PY_VERSION_HEX >= 0x03090000
    Py_VISIT(Py_TYPE(self));
#endif
@end example

If the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{18c6,,tp_flags} field, the traverse function must call
@ref{45d,,PyObject_VisitManagedDict()} like this:

@example
PyObject_VisitManagedDict((PyObject*)self, visit, arg);
@end example

@cartouche
@quotation Advertencia 
Al implementar @ref{818,,tp_traverse}, solo se deben visitar los miembros que tienen la instancia `owns' (por tener @ref{431,,referencias fuertes}). Por ejemplo, si un objeto admite referencias débiles a través de la ranura @ref{4b2f,,tp_weaklist}, el puntero que respalda la lista vinculada (a lo que apunta `tp_weaklist') `no' debe visitarse ya que la instancia no posee directamente las referencias débiles a sí misma (la lista de referencias débiles está ahí para respaldar la maquinaria de referencia débil, pero la instancia no tiene una fuerte referencia a los elementos dentro de ella, ya que pueden eliminarse incluso si la instancia todavía está viva).
@end quotation
@end cartouche

Note that @ref{4869,,Py_VISIT()} requires the `visit' and `arg' parameters to
@code{local_traverse()} to have these specific names; don’t name them just
anything.

Las instancias de @ref{9f8,,heap-allocated types} contienen una referencia a su tipo. Por lo tanto, su función transversal debe visitar @ref{26e,,Py_TYPE(self)} o delegar esta responsabilidad llamando a @code{tp_traverse} de otro tipo asignado al heap (como una superclase asignada al heap). Si no es así, es posible que el objeto de tipo no se recolecte como basura.


Distinto en la versión 3.9: Se espera que los tipos asignados al heap visiten @code{Py_TYPE(self)} en @code{tp_traverse}. En versiones anteriores de Python, debido al bug 40217@footnote{https://bugs.python.org/issue40217}, hacer esto puede provocar fallas en las subclases.


`Herencia:'

Group: @ref{817,,Py_TPFLAGS_HAVE_GC}, @ref{818,,tp_traverse}, @ref{4872,,tp_clear}

This field is inherited by subtypes together with @ref{4872,,tp_clear} and the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag bit: the flag bit, @ref{818,,tp_traverse}, and
@ref{4872,,tp_clear} are all inherited from the base type if they are all zero in
the subtype.
@end deffn

@geindex PyTypeObject.tp_clear (C member)
@anchor{c-api/typeobj c PyTypeObject tp_clear}@anchor{4872}
@deffn {C Miembro} @ref{4a26,,inquiry} @ref{b30,,PyTypeObject}.tp_clear

An optional pointer to a clear function for the garbage collector. This is only
used if the @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit is set.  The signature is:

@example
int tp_clear(PyObject *);
@end example

La función miembro @ref{4872,,tp_clear} se usa para romper los ciclos de referencia en la basura cíclica detectada por el recolector de basura. En conjunto, todas las funciones @ref{4872,,tp_clear} en el sistema deben combinarse para romper todos los ciclos de referencia. Esto es sutil y, en caso de duda, proporcione una función @ref{4872,,tp_clear}. Por ejemplo, el tipo de tupla no implementa una función @ref{4872,,tp_clear}, porque es posible demostrar que ningún ciclo de referencia puede estar compuesto completamente de tuplas. Por lo tanto, las funciones @ref{4872,,tp_clear} de otros tipos deben ser suficientes para romper cualquier ciclo que contenga una tupla. Esto no es inmediatamente obvio, y rara vez hay una buena razón para evitar la implementación de @ref{4872,,tp_clear}.

Las implementaciones de @ref{4872,,tp_clear} deberían descartar las referencias de la instancia a las de sus miembros que pueden ser objetos de Python, y establecer sus punteros a esos miembros en @code{NULL}, como en el siguiente ejemplo:

@example
static int
local_clear(localobject *self)
@{
    Py_CLEAR(self->key);
    Py_CLEAR(self->args);
    Py_CLEAR(self->kw);
    Py_CLEAR(self->dict);
    return 0;
@}
@end example

The @ref{61c,,Py_CLEAR()} macro should be used, because clearing references is
delicate:  the reference to the contained object must not be released
(via @ref{613,,Py_DECREF()}) until
after the pointer to the contained object is set to @code{NULL}.  This is because
releasing the reference may cause the contained object to become trash,
triggering a chain of reclamation activity that may include invoking arbitrary
Python code (due to finalizers, or weakref callbacks, associated with the
contained object). If it’s possible for such code to reference `self' again,
it’s important that the pointer to the contained object be @code{NULL} at that time,
so that `self' knows the contained object can no longer be used.  The
@ref{61c,,Py_CLEAR()} macro performs the operations in a safe order.

If the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{18c6,,tp_flags} field, the traverse function must call
@ref{45e,,PyObject_ClearManagedDict()} like this:

@example
PyObject_ClearManagedDict((PyObject*)self);
@end example

Tenga en cuenta que @ref{4872,,tp_clear} no se llama `siempre' antes de que se desasigne una instancia. Por ejemplo, cuando el recuento de referencias es suficiente para determinar que un objeto ya no se utiliza, el recolector de basura cíclico no está involucrado y se llama directamente a @ref{485f,,tp_dealloc}.

Debido a que el objetivo de @ref{4872,,tp_clear} es romper los ciclos de referencia, no es necesario borrar objetos contenidos como cadenas de caracteres de Python o enteros de Python, que no pueden participar en los ciclos de referencia. Por otro lado, puede ser conveniente borrar todos los objetos Python contenidos y escribir la función @ref{485f,,tp_dealloc} para invocar @ref{4872,,tp_clear}.

Se puede encontrar más información sobre el esquema de recolección de basura de Python en la sección @ref{4dc9,,Apoyo a la recolección de basura cíclica}.

`Herencia:'

Group: @ref{817,,Py_TPFLAGS_HAVE_GC}, @ref{818,,tp_traverse}, @ref{4872,,tp_clear}

This field is inherited by subtypes together with @ref{818,,tp_traverse} and the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag bit: the flag bit, @ref{818,,tp_traverse}, and
@ref{4872,,tp_clear} are all inherited from the base type if they are all zero in
the subtype.
@end deffn

@geindex PyTypeObject.tp_richcompare (C member)
@anchor{c-api/typeobj c PyTypeObject tp_richcompare}@anchor{4880}
@deffn {C Miembro} @ref{4a2e,,richcmpfunc} @ref{b30,,PyTypeObject}.tp_richcompare

Un puntero opcional a la función de comparación enriquecida, cuya firma es:

@example
PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);
@end example

Se garantiza que el primer parámetro será una instancia del tipo definido por @ref{b30,,PyTypeObject}.

La función debería retornar el resultado de la comparación (generalmente @code{Py_True} o @code{Py_False}). Si la comparación no está definida, debe retornar @code{Py_NotImplemented}, si se produce otro error, debe retornar @code{NULL} y establecer una condición de excepción.

Las siguientes constantes se definen para ser utilizadas como el tercer argumento para @ref{4880,,tp_richcompare} y para @ref{4881,,PyObject_RichCompare()}:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Comparación

@item

@geindex Py_LT (C macro)
@anchor{c-api/typeobj c Py_LT}@anchor{4ac2}
@deffn {C Macro} Py_LT
@end deffn

@tab

@code{<}

@item

@geindex Py_LE (C macro)
@anchor{c-api/typeobj c Py_LE}@anchor{4ac3}
@deffn {C Macro} Py_LE
@end deffn

@tab

@code{<=}

@item

@geindex Py_EQ (C macro)
@anchor{c-api/typeobj c Py_EQ}@anchor{4ac4}
@deffn {C Macro} Py_EQ
@end deffn

@tab

@code{==}

@item

@geindex Py_NE (C macro)
@anchor{c-api/typeobj c Py_NE}@anchor{4ac5}
@deffn {C Macro} Py_NE
@end deffn

@tab

@code{!=}

@item

@geindex Py_GT (C macro)
@anchor{c-api/typeobj c Py_GT}@anchor{4ac6}
@deffn {C Macro} Py_GT
@end deffn

@tab

@code{>}

@item

@geindex Py_GE (C macro)
@anchor{c-api/typeobj c Py_GE}@anchor{4ac7}
@deffn {C Macro} Py_GE
@end deffn

@tab

@code{>=}

@end multitable


El siguiente macro está definido para facilitar la escritura de funciones de comparación enriquecidas:

@geindex Py_RETURN_RICHCOMPARE (C macro)
@anchor{c-api/typeobj c Py_RETURN_RICHCOMPARE}@anchor{c3c}
@deffn {C Macro} Py_RETURN_RICHCOMPARE (VAL_A, VAL_B, op)

Retorna @code{Py_True} o @code{Py_False} de la función, según el resultado de una comparación. @code{VAL_A} y @code{VAL_B} deben ser ordenados por operadores de comparación C (por ejemplo, pueden ser enteros o punto flotantes de C). El tercer argumento especifica la operación solicitada, como por ejemplo @ref{4881,,PyObject_RichCompare()}.

The returned value is a new @ref{431,,strong reference}.

En caso de error, establece una excepción y retorna @code{NULL} de la función.


Added in version 3.7.

@end deffn

`Herencia:'

Group: @ref{4886,,tp_hash}, @ref{4880,,tp_richcompare}

Este campo es heredado por subtipos junto con @ref{4886,,tp_hash}: un subtipo hereda @ref{4880,,tp_richcompare} y @ref{4886,,tp_hash} cuando el subtipo @ref{4880,,tp_richcompare} y @ref{4886,,tp_hash} son ambos @code{NULL}.

`Por defecto:'

@code{PyBaseObject_Type} provides a @ref{4880,,tp_richcompare}
implementation, which may be inherited.  However, if only
@ref{4886,,tp_hash} is defined, not even the inherited function is used
and instances of the type will not be able to participate in any
comparisons.
@end deffn

@geindex PyTypeObject.tp_weaklistoffset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_weaklistoffset}@anchor{a1a}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{b30,,PyTypeObject}.tp_weaklistoffset

While this field is still supported, @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF}
should be used instead, if at all possible.

If the instances of this type are weakly referenceable, this field is greater
than zero and contains the offset in the instance structure of the weak
reference list head (ignoring the GC header, if present); this offset is used by
@ref{61a,,PyObject_ClearWeakRefs()} and the @code{PyWeakref_*} functions.  The
instance structure needs to include a field of type @ref{42d,,PyObject}* which is
initialized to @code{NULL}.

No confunda este campo con @ref{4b2f,,tp_weaklist}; ese es el encabezado de la lista para referencias débiles al objeto de tipo en sí.

It is an error to set both the @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} bit and
@ref{a1a,,tp_weaklistoffset}.

`Herencia:'

Este campo es heredado por subtipos, pero consulte las reglas que se enumeran a continuación. Un subtipo puede anular este desplazamiento; Esto significa que el subtipo utiliza un encabezado de lista de referencia débil diferente que el tipo base. Dado que el encabezado de la lista siempre se encuentra a través de @ref{a1a,,tp_weaklistoffset}, esto no debería ser un problema.

`Por defecto:'

If the @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} bit is set in the
@ref{18c6,,tp_flags} field, then
@ref{a1a,,tp_weaklistoffset} will be set to a negative value,
to indicate that it is unsafe to use this field.
@end deffn

@geindex PyTypeObject.tp_iter (C member)
@anchor{c-api/typeobj c PyTypeObject tp_iter}@anchor{152e}
@deffn {C Miembro} @ref{4a22,,getiterfunc} @ref{b30,,PyTypeObject}.tp_iter

An optional pointer to a function that returns an @ref{313,,iterator} for the
object.  Its presence normally signals that the instances of this type are
@ref{1294,,iterable} (although sequences may be iterable without this function).

Esta función tiene la misma firma que @ref{4997,,PyObject_GetIter()}:

@example
PyObject *tp_iter(PyObject *self);
@end example

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_iternext (C member)
@anchor{c-api/typeobj c PyTypeObject tp_iternext}@anchor{152f}
@deffn {C Miembro} @ref{4a27,,iternextfunc} @ref{b30,,PyTypeObject}.tp_iternext

An optional pointer to a function that returns the next item in an
@ref{313,,iterator}. The signature is:

@example
PyObject *tp_iternext(PyObject *self);
@end example

Cuando el iterador está agotado, debe retornar @code{NULL}; a la excepción @ref{c82,,StopIteration} puede o no establecerse. Cuando se produce otro error, también debe retornar @code{NULL}. Su presencia indica que las instancias de este tipo son iteradores.

Los tipos de iterador también deberían definir la función @ref{152e,,tp_iter}, y esa función debería retornar la instancia de iterador en sí (no una nueva instancia de iterador).

Esta función tiene la misma firma que @ref{245,,PyIter_Next()}.

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_methods (C member)
@anchor{c-api/typeobj c PyTypeObject tp_methods}@anchor{4864}
@deffn {C Miembro} struct @ref{1517,,PyMethodDef} *@ref{b30,,PyTypeObject}.tp_methods

Un puntero opcional a un arreglo estático terminado en @code{NULL} de estructuras @ref{1517,,PyMethodDef}, declarando métodos regulares de este tipo.

Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver @ref{1725,,tp_dict} a continuación) que contiene un descriptor `method'.

`Herencia:'

Los subtipos no heredan este campo (los métodos se heredan mediante un mecanismo diferente).
@end deffn

@geindex PyTypeObject.tp_members (C member)
@anchor{c-api/typeobj c PyTypeObject tp_members}@anchor{4862}
@deffn {C Miembro} struct @ref{5f2,,PyMemberDef} *@ref{b30,,PyTypeObject}.tp_members

Un puntero opcional a un arreglo estático terminado en @code{NULL} de estructuras @ref{5f2,,PyMemberDef}, declarando miembros de datos regulares (campos o ranuras) de instancias de este tipo.

Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver @ref{1725,,tp_dict} a continuación) que contiene un descriptor `member'.

`Herencia:'

Los subtipos no heredan este campo (los miembros se heredan mediante un mecanismo diferente).
@end deffn

@geindex PyTypeObject.tp_getset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getset}@anchor{4867}
@deffn {C Miembro} struct @ref{c40,,PyGetSetDef} *@ref{b30,,PyTypeObject}.tp_getset

Un puntero opcional a un arreglo estático terminado en @code{NULL} de estructuras @ref{c40,,PyGetSetDef}, declarando atributos calculados de instancias de este tipo.

Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver @ref{1725,,tp_dict} a continuación) que contiene un descriptor `getset'.

`Herencia:'

Este campo no es heredado por los subtipos (los atributos computados se heredan a través de un mecanismo diferente).
@end deffn

@geindex PyTypeObject.tp_base (C member)
@anchor{c-api/typeobj c PyTypeObject tp_base}@anchor{486b}
@deffn {C Miembro} @ref{b30,,PyTypeObject} *@ref{b30,,PyTypeObject}.tp_base

Un puntero opcional a un tipo base del que se heredan las propiedades de tipo. En este nivel, solo se admite una herencia única; La herencia múltiple requiere la creación dinámica de un objeto tipo llamando al metatipo.

@cartouche
@quotation Nota 
@c from Modules/xxmodule.c

La inicialización de ranuras está sujeta a las reglas de inicialización de globales. C99 requiere que los inicializadores sean «constantes de dirección». Los designadores de funciones como @ref{485c,,PyType_GenericNew()}, con conversión implícita a un puntero, son constantes de dirección C99 válidas.

However, the unary “&” operator applied to a non-static variable
like @code{PyBaseObject_Type} is not required to produce an address
constant.  Compilers may support this (gcc does), MSVC does not.
Both compilers are strictly standard conforming in this particular
behavior.

En consecuencia, @ref{486b,,tp_base} debe establecerse en la función `init' del módulo de extensión.
@end quotation
@end cartouche

`Herencia:'

Este campo no es heredado por los subtipos (obviamente).

`Por defecto:'

Este campo predeterminado es @code{&PyBaseObject_Type} (que para los programadores de Python se conoce como el tipo @code{objeto}).
@end deffn

@geindex PyTypeObject.tp_dict (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dict}@anchor{1725}
@deffn {C Miembro} @ref{42d,,PyObject} *@ref{b30,,PyTypeObject}.tp_dict

El diccionario del tipo se almacena aquí por @ref{816,,PyType_Ready()}.

This field should normally be initialized to @code{NULL} before PyType_Ready is
called; it may also be initialized to a dictionary containing initial attributes
for the type.  Once @ref{816,,PyType_Ready()} has initialized the type, extra
attributes for the type may be added to this dictionary only if they don’t
correspond to overloaded operations (like @ref{1f8c,,__add__()}).  Once
initialization for the type has finished, this field should be
treated as read-only.

Some types may not store their dictionary in this slot.
Use @ref{1724,,PyType_GetDict()} to retrieve the dictionary for an arbitrary
type.


Distinto en la versión 3.12: Internals detail: For static builtin types, this is always @code{NULL}.
Instead, the dict for such types is stored on @code{PyInterpreterState}.
Use @ref{1724,,PyType_GetDict()} to get the dict for an arbitrary type.


`Herencia:'

Este campo no es heredado por los subtipos (aunque los atributos definidos aquí se heredan a través de un mecanismo diferente).

`Por defecto:'

Si este campo es @code{NULL}, @ref{816,,PyType_Ready()} le asignará un nuevo diccionario.

@cartouche
@quotation Advertencia 
No es seguro usar @ref{484b,,PyDict_SetItem()} en o modificar de otra manera a @ref{1725,,tp_dict} con el diccionario C-API.
@end quotation
@end cartouche
@end deffn

@geindex PyTypeObject.tp_descr_get (C member)
@anchor{c-api/typeobj c PyTypeObject tp_descr_get}@anchor{4d89}
@deffn {C Miembro} @ref{4a1c,,descrgetfunc} @ref{b30,,PyTypeObject}.tp_descr_get

Un puntero opcional a una función «obtener descriptor» (`descriptor ger').

La firma de la función es:

@example
PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
@end example

@c XXX explain more?

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_descr_set (C member)
@anchor{c-api/typeobj c PyTypeObject tp_descr_set}@anchor{18ff}
@deffn {C Miembro} @ref{4a1d,,descrsetfunc} @ref{b30,,PyTypeObject}.tp_descr_set

Un puntero opcional a una función para configurar y eliminar el valor de un descriptor.

La firma de la función es:

@example
int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);
@end example

El argumento `value' se establece a @code{NULL} para borrar el valor.

@c XXX explain more?

`Herencia:'

Este campo es heredado por subtipos.
@end deffn

@geindex PyTypeObject.tp_dictoffset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dictoffset}@anchor{4b2b}
@deffn {C Miembro} @ref{af0,,Py_ssize_t} @ref{b30,,PyTypeObject}.tp_dictoffset

While this field is still supported, @ref{45f,,Py_TPFLAGS_MANAGED_DICT} should be
used instead, if at all possible.

Si las instancias de este tipo tienen un diccionario que contiene variables de instancia, este campo no es cero y contiene el desplazamiento en las instancias del tipo del diccionario de variables de instancia; este desplazamiento es utilizado por @ref{4993,,PyObject_GenericGetAttr()}.

No confunda este campo con @ref{1725,,tp_dict}; ese es el diccionario para los atributos del tipo de objeto en sí.

The value specifies the offset of the dictionary from the start of the instance structure.

El @ref{4b2b,,tp_dictoffset} debe considerarse como de solo escritura. Para obtener el puntero al diccionario, llame a @ref{1943,,PyObject_GenericGetDict()}. Llamar a @ref{1943,,PyObject_GenericGetDict()} puede necesitar asignar memoria para el diccionario, por lo que puede ser más eficiente llamar a @ref{43f,,PyObject_GetAttr()} cuando se accede a un atributo en el objeto.

It is an error to set both the @ref{5fd,,Py_TPFLAGS_MANAGED_WEAKREF} bit and
@ref{4b2b,,tp_dictoffset}.

`Herencia:'

This field is inherited by subtypes. A subtype should not override this offset;
doing so could be unsafe, if C code tries to access the dictionary at the
previous offset.
To properly support inheritance, use @ref{45f,,Py_TPFLAGS_MANAGED_DICT}.

`Por defecto:'

This slot has no default.  For @ref{819,,static types}, if the
field is @code{NULL} then no @ref{5fe,,__dict__} gets created for instances.

If the @ref{45f,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{18c6,,tp_flags} field, then
@ref{4b2b,,tp_dictoffset} will be set to @code{-1}, to indicate
that it is unsafe to use this field.
@end deffn

@geindex PyTypeObject.tp_init (C member)
@anchor{c-api/typeobj c PyTypeObject tp_init}@anchor{625}
@deffn {C Miembro} @ref{4a25,,initproc} @ref{b30,,PyTypeObject}.tp_init

Un puntero opcional a una función de inicialización de instancia.

This function corresponds to the @ref{751,,__init__()} method of classes.  Like
@code{__init__()}, it is possible to create an instance without calling
@code{__init__()}, and it is possible to reinitialize an instance by calling its
@code{__init__()} method again.

La firma de la función es:

@example
int tp_init(PyObject *self, PyObject *args, PyObject *kwds);
@end example

The self argument is the instance to be initialized; the `args' and `kwds'
arguments represent positional and keyword arguments of the call to
@ref{751,,__init__()}.

La función @ref{625,,tp_init}, si no es @code{NULL}, se llama cuando una instancia se crea normalmente llamando a su tipo, después de la función @ref{623,,tp_new} del tipo ha retornado una instancia del tipo. Si la función @ref{623,,tp_new} retorna una instancia de otro tipo que no es un subtipo del tipo original, no se llama la función @ref{625,,tp_init}; if @ref{623,,tp_new} retorna una instancia de un subtipo del tipo original, se llama al subtipo @ref{625,,tp_init}.

Retorna @code{0} en caso de éxito, @code{-1} y establece una excepción en caso de error.

`Herencia:'

Este campo es heredado por subtipos.

`Por defecto:'

Para @ref{819,,tipos estáticos}, este campo no tiene un valor predeterminado.
@end deffn

@geindex PyTypeObject.tp_alloc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_alloc}@anchor{4861}
@deffn {C Miembro} @ref{4a1a,,allocfunc} @ref{b30,,PyTypeObject}.tp_alloc

Un puntero opcional a una función de asignación de instancia.

La firma de la función es:

@example
PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);
@end example

`Herencia:'

Este campo es heredado por subtipos estáticos, pero no por subtipos dinámicos (subtipos creados por una declaración de clase).

`Por defecto:'

Para subtipos dinámicos, este campo siempre se establece en @ref{afb,,PyType_GenericAlloc()}, para forzar una estrategia de asignación de heap estándar.

For static subtypes, @code{PyBaseObject_Type} uses
@ref{afb,,PyType_GenericAlloc()}.  That is the recommended value
for all statically defined types.
@end deffn

@geindex PyTypeObject.tp_new (C member)
@anchor{c-api/typeobj c PyTypeObject tp_new}@anchor{623}
@deffn {C Miembro} @ref{4a29,,newfunc} @ref{b30,,PyTypeObject}.tp_new

Un puntero opcional a una función de creación de instancias.

La firma de la función es:

@example
PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);
@end example

El argumento `subtype' es el tipo de objeto que se está creando; los argumentos `args' y `kwds' representan argumentos posicionales y de palabras clave de la llamada al tipo. Tenga en cuenta que `subtype' no tiene que ser igual al tipo cuya función @ref{623,,tp_new} es llamada; puede ser un subtipo de ese tipo (pero no un tipo no relacionado).

La función @ref{623,,tp_new} debería llamar a @code{subtype->tp_alloc(subtype, nitems)} para asignar espacio para el objeto, y luego hacer solo la inicialización adicional que sea absolutamente necesaria. La inicialización que se puede ignorar o repetir de forma segura debe colocarse en el controlador @ref{625,,tp_init}. Una buena regla general es que para los tipos inmutables, toda la inicialización debe tener lugar en @ref{623,,tp_new}, mientras que para los tipos mutables, la mayoría de las inicializaciones se deben diferir a @ref{625,,tp_init}.

Set the @ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION} flag to disallow creating
instances of the type in Python.

`Herencia:'

Este campo se hereda por subtipos, excepto que no lo heredan @ref{819,,tipos estáticos} cuyo @ref{486b,,tp_base} es @code{NULL} o @code{&PyBaseObject_Type}.

`Por defecto:'

Para @ref{819,,tipos estáticos}, este campo no tiene ningún valor predeterminado. Esto significa que si la ranura se define como @code{NULL}, no se puede llamar al tipo para crear nuevas instancias; presumiblemente hay alguna otra forma de crear instancias, como una función de fábrica.
@end deffn

@geindex PyTypeObject.tp_free (C member)
@anchor{c-api/typeobj c PyTypeObject tp_free}@anchor{4860}
@deffn {C Miembro} @ref{4c21,,freefunc} @ref{b30,,PyTypeObject}.tp_free

Un puntero opcional a una función de desasignación de instancia. Su firma es:

@example
void tp_free(void *self);
@end example

Un inicializador que es compatible con esta firma es @ref{ced,,PyObject_Free()}.

`Herencia:'

Este campo es heredado por subtipos estáticos, pero no por subtipos dinámicos (subtipos creados por una declaración de clase)

`Por defecto:'

In dynamic subtypes, this field is set to a deallocator suitable to
match @ref{afb,,PyType_GenericAlloc()} and the value of the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag bit.

For static subtypes, @code{PyBaseObject_Type} uses @ref{ced,,PyObject_Free()}.
@end deffn

@geindex PyTypeObject.tp_is_gc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_is_gc}@anchor{4d8a}
@deffn {C Miembro} @ref{4a26,,inquiry} @ref{b30,,PyTypeObject}.tp_is_gc

Un puntero opcional a una función llamada por el recolector de basura.

The garbage collector needs to know whether a particular object is collectible
or not.  Normally, it is sufficient to look at the object’s type’s
@ref{18c6,,tp_flags} field, and check the @ref{817,,Py_TPFLAGS_HAVE_GC} flag bit.  But
some types have a mixture of statically and dynamically allocated instances, and
the statically allocated instances are not collectible.  Such types should
define this function; it should return @code{1} for a collectible instance, and
@code{0} for a non-collectible instance. The signature is:

@example
int tp_is_gc(PyObject *self);
@end example

(El único ejemplo de esto son los tipos en sí. El metatipo, @ref{5f0,,PyType_Type}, define esta función para distinguir entre tipos estática y @ref{9f8,,dinámicamente asignados}.)

`Herencia:'

Este campo es heredado por subtipos.

`Por defecto:'

This slot has no default.  If this field is @code{NULL},
@ref{817,,Py_TPFLAGS_HAVE_GC} is used as the functional equivalent.
@end deffn

@geindex PyTypeObject.tp_bases (C member)
@anchor{c-api/typeobj c PyTypeObject tp_bases}@anchor{4d8b}
@deffn {C Miembro} @ref{42d,,PyObject} *@ref{b30,,PyTypeObject}.tp_bases

Tupla de tipos base.

This field should be set to @code{NULL} and treated as read-only.
Python will fill it in when the type is @ref{816,,initialized}.

For dynamically created classes, the @code{Py_tp_bases}
@ref{49ce,,slot} can be used instead of the `bases' argument
of @ref{622,,PyType_FromSpecWithBases()}.
The argument form is preferred.

@cartouche
@quotation Advertencia 
Multiple inheritance does not work well for statically defined types.
If you set @code{tp_bases} to a tuple, Python will not raise an error,
but some slots will only be inherited from the first base.
@end quotation
@end cartouche

`Herencia:'

Este campo no se hereda.
@end deffn

@geindex PyTypeObject.tp_mro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_mro}@anchor{4b2d}
@deffn {C Miembro} @ref{42d,,PyObject} *@ref{b30,,PyTypeObject}.tp_mro

Tupla que contiene el conjunto expandido de tipos base, comenzando con el tipo en sí y terminando con @ref{b18,,object}, en orden de resolución de método.

This field should be set to @code{NULL} and treated as read-only.
Python will fill it in when the type is @ref{816,,initialized}.

`Herencia:'

Este campo no se hereda; se calcula fresco por @ref{816,,PyType_Ready()}.
@end deffn

@geindex PyTypeObject.tp_cache (C member)
@anchor{c-api/typeobj c PyTypeObject tp_cache}@anchor{4b2e}
@deffn {C Miembro} @ref{42d,,PyObject} *@ref{b30,,PyTypeObject}.tp_cache

No usado. Solo para uso interno.

`Herencia:'

Este campo no se hereda.
@end deffn

@geindex PyTypeObject.tp_subclasses (C member)
@anchor{c-api/typeobj c PyTypeObject tp_subclasses}@anchor{616}
@deffn {C Miembro} void *@ref{b30,,PyTypeObject}.tp_subclasses

A collection of subclasses.  Internal use only.  May be an invalid pointer.

To get a list of subclasses, call the Python method
@ref{617,,__subclasses__()}.


Distinto en la versión 3.12: For some types, this field does not hold a valid @ref{42d,,PyObject}*.
The type was changed to void* to indicate this.


`Herencia:'

Este campo no se hereda.
@end deffn

@geindex PyTypeObject.tp_weaklist (C member)
@anchor{c-api/typeobj c PyTypeObject tp_weaklist}@anchor{4b2f}
@deffn {C Miembro} @ref{42d,,PyObject} *@ref{b30,,PyTypeObject}.tp_weaklist

Cabecera de lista de referencia débil, para referencias débiles a este tipo de objeto. No heredado Solo para uso interno.


Distinto en la versión 3.12: Internals detail: For the static builtin types this is always @code{NULL},
even if weakrefs are added.  Instead, the weakrefs for each are stored
on @code{PyInterpreterState}.  Use the public C-API or the internal
@code{_PyObject_GET_WEAKREFS_LISTPTR()} macro to avoid the distinction.


`Herencia:'

Este campo no se hereda.
@end deffn

@geindex PyTypeObject.tp_del (C member)
@anchor{c-api/typeobj c PyTypeObject tp_del}@anchor{4d8c}
@deffn {C Miembro} @ref{4a1e,,destructor} @ref{b30,,PyTypeObject}.tp_del

Este campo está en desuso. Use @ref{b31,,tp_finalize} en su lugar.
@end deffn

@geindex PyTypeObject.tp_version_tag (C member)
@anchor{c-api/typeobj c PyTypeObject tp_version_tag}@anchor{4d8d}
@deffn {C Miembro} unsigned int @ref{b30,,PyTypeObject}.tp_version_tag

Se usa para indexar en el caché de métodos. Solo para uso interno.

`Herencia:'

Este campo no se hereda.
@end deffn

@geindex PyTypeObject.tp_finalize (C member)
@anchor{c-api/typeobj c PyTypeObject tp_finalize}@anchor{b31}
@deffn {C Miembro} @ref{4a1e,,destructor} @ref{b30,,PyTypeObject}.tp_finalize

Un puntero opcional a una función de finalización de instancia. Su firma es:

@example
void tp_finalize(PyObject *self);
@end example

Si @ref{b31,,tp_finalize} está configurado, el intérprete lo llama una vez cuando finaliza una instancia. Se llama desde el recolector de basura (si la instancia es parte de un ciclo de referencia aislado) o justo antes de que el objeto se desasigne. De cualquier manera, se garantiza que se invocará antes de intentar romper los ciclos de referencia, asegurando que encuentre el objeto en un estado sano.

@ref{b31,,tp_finalize} no debe mutar el estado de excepción actual; por lo tanto, una forma recomendada de escribir un finalizador no trivial es:

@example
static void
local_finalize(PyObject *self)
@{
    PyObject *error_type, *error_value, *error_traceback;

    /* Save the current exception, if any. */
    PyErr_Fetch(&error_type, &error_value, &error_traceback);

    /* ... */

    /* Restore the saved exception. */
    PyErr_Restore(error_type, error_value, error_traceback);
@}
@end example

`Herencia:'

Este campo es heredado por subtipos.


Added in version 3.4.



Distinto en la versión 3.8: Before version 3.8 it was necessary to set the
@ref{289,,Py_TPFLAGS_HAVE_FINALIZE} flags bit in order for this field to be
used.  This is no longer required.



@subsubheading Ver también


«Finalización segura de objetos» (
@geindex Python Enhancement Proposals; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/})

@end deffn

@geindex PyTypeObject.tp_vectorcall (C member)
@anchor{c-api/typeobj c PyTypeObject tp_vectorcall}@anchor{1620}
@deffn {C Miembro} @ref{5fa,,vectorcallfunc} @ref{b30,,PyTypeObject}.tp_vectorcall

A @ref{5f5,,vectorcall function} to use for calls of this type
object (rather than instances).
In other words, @code{tp_vectorcall} can be used to optimize @code{type.__call__},
which typically returns a new instance of `type'.

As with any vectorcall function, if @code{tp_vectorcall} is @code{NULL},
the `tp_call' protocol (@code{Py_TYPE(type)->tp_call}) is used instead.

@cartouche
@quotation Nota 
The @ref{5f5,,vectorcall protocol} requires that the vectorcall
function has the same behavior as the corresponding @code{tp_call}.
This means that @code{type->tp_vectorcall} must match the behavior of
@code{Py_TYPE(type)->tp_call}.

Specifically, if `type' uses the default metaclass,
@code{type->tp_vectorcall} must behave the same as
@ref{5f0,,PyType_Type}->tp_call, which:


@itemize -

@item 
calls @code{type->tp_new},

@item 
if the result is a subclass of `type', calls @code{type->tp_init}
on the result of @code{tp_new}, and

@item 
returns the result of @code{tp_new}.
@end itemize

Typically, @code{tp_vectorcall} is overridden to optimize this process
for specific @ref{623,,tp_new} and
@ref{625,,tp_init}.
When doing this for user-subclassable types, note that both can be
overridden (using @ref{624,,__new__()} and
@ref{751,,__init__()}, respectively).
@end quotation
@end cartouche

`Herencia:'

Este campo nunca se hereda.


Added in version 3.9: (el campo existe desde 3.8 pero solo se usa desde 3.9)

@end deffn

@geindex PyTypeObject.tp_watched (C member)
@anchor{c-api/typeobj c PyTypeObject tp_watched}@anchor{4d8e}
@deffn {C Miembro} unsigned char @ref{b30,,PyTypeObject}.tp_watched

Internal. Do not use.


Added in version 3.12.

@end deffn

@node Tipos estáticos,Tipos Heap,Ranuras PyTypeObject,Objetos tipo<2>
@anchor{c-api/typeobj id4}@anchor{4dd5}@anchor{c-api/typeobj static-types}@anchor{819}
@subsubsection Tipos estáticos


Tradicionalmente, los tipos definidos en el código C son `static', es decir, una estructura estática @ref{b30,,PyTypeObject} se define directamente en el código y se inicializa usando @ref{816,,PyType_Ready()}.

Esto da como resultado tipos que están limitados en relación con los tipos definidos en Python:


@itemize *

@item 
Los tipos estáticos están limitados a una base, es decir, no pueden usar herencia múltiple.

@item 
Los objetos de tipo estático (pero no necesariamente sus instancias) son inmutables. No es posible agregar o modificar los atributos del objeto tipo desde Python.

@item 
Los objetos de tipo estático se comparten en @ref{62b,,sub intérpretes}, por lo que no deben incluir ningún estado específico del sub interpretador.
@end itemize

Also, since @ref{b30,,PyTypeObject} is only part of the @ref{488,,Limited API} as an opaque struct, any extension modules using static types must be
compiled for a specific Python minor version.

@node Tipos Heap,Estructuras de objetos de números,Tipos estáticos,Objetos tipo<2>
@anchor{c-api/typeobj heap-types}@anchor{9f8}@anchor{c-api/typeobj id5}@anchor{4dd6}
@subsubsection Tipos Heap


An alternative to @ref{819,,static types} is `heap-allocated types',
or `heap types' for short, which correspond closely to classes created by
Python’s @code{class} statement. Heap types have the @ref{946,,Py_TPFLAGS_HEAPTYPE}
flag set.

This is done by filling a @ref{1721,,PyType_Spec} structure and calling
@ref{621,,PyType_FromSpec()}, @ref{622,,PyType_FromSpecWithBases()},
@ref{5f4,,PyType_FromModuleAndSpec()}, or @ref{5f3,,PyType_FromMetaclass()}.

@node Estructuras de objetos de números,Estructuras de objetos mapeo,Tipos Heap,Objetos tipo<2>
@anchor{c-api/typeobj number-object-structures}@anchor{4dd7}@anchor{c-api/typeobj number-structs}@anchor{4dc6}
@subsubsection Estructuras de objetos de números


@geindex PyNumberMethods (C type)
@anchor{c-api/typeobj c PyNumberMethods}@anchor{145d}
@deffn {C Tipo} type PyNumberMethods

Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo numérico. Cada función es utilizada por la función de un nombre similar documentado en la sección @ref{4ad8,,Protocolo de números}.

@c XXX Drop the definition?

Aquí está la definición de la estructura:

@example
typedef struct @{
     binaryfunc nb_add;
     binaryfunc nb_subtract;
     binaryfunc nb_multiply;
     binaryfunc nb_remainder;
     binaryfunc nb_divmod;
     ternaryfunc nb_power;
     unaryfunc nb_negative;
     unaryfunc nb_positive;
     unaryfunc nb_absolute;
     inquiry nb_bool;
     unaryfunc nb_invert;
     binaryfunc nb_lshift;
     binaryfunc nb_rshift;
     binaryfunc nb_and;
     binaryfunc nb_xor;
     binaryfunc nb_or;
     unaryfunc nb_int;
     void *nb_reserved;
     unaryfunc nb_float;

     binaryfunc nb_inplace_add;
     binaryfunc nb_inplace_subtract;
     binaryfunc nb_inplace_multiply;
     binaryfunc nb_inplace_remainder;
     ternaryfunc nb_inplace_power;
     binaryfunc nb_inplace_lshift;
     binaryfunc nb_inplace_rshift;
     binaryfunc nb_inplace_and;
     binaryfunc nb_inplace_xor;
     binaryfunc nb_inplace_or;

     binaryfunc nb_floor_divide;
     binaryfunc nb_true_divide;
     binaryfunc nb_inplace_floor_divide;
     binaryfunc nb_inplace_true_divide;

     unaryfunc nb_index;

     binaryfunc nb_matrix_multiply;
     binaryfunc nb_inplace_matrix_multiply;
@} PyNumberMethods;
@end example

@cartouche
@quotation Nota 
Las funciones binarias y ternarias deben verificar el tipo de todos sus operandos e implementar las conversiones necesarias (al menos uno de los operandos es una instancia del tipo definido). Si la operación no está definida para los operandos dados, las funciones binarias y ternarias deben retornar @code{Py_NotImplemented}, si se produce otro error, deben retornar @code{NULL} y establecer una excepción.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
The @ref{4daf,,nb_reserved} field should always be @code{NULL}.  It
was previously called @code{nb_long}, and was renamed in
Python 3.0.1.
@end quotation
@end cartouche
@end deffn

@geindex PyNumberMethods.nb_add (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_add}@anchor{4b22}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_add
@end deffn

@geindex PyNumberMethods.nb_subtract (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_subtract}@anchor{4d96}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_subtract
@end deffn

@geindex PyNumberMethods.nb_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_multiply}@anchor{4d98}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_multiply
@end deffn

@geindex PyNumberMethods.nb_remainder (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_remainder}@anchor{4d9a}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_remainder
@end deffn

@geindex PyNumberMethods.nb_divmod (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_divmod}@anchor{4d9c}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_divmod
@end deffn

@geindex PyNumberMethods.nb_power (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_power}@anchor{4d9d}
@deffn {C Miembro} @ref{4a34,,ternaryfunc} @ref{145d,,PyNumberMethods}.nb_power
@end deffn

@geindex PyNumberMethods.nb_negative (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_negative}@anchor{4d9f}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_negative
@end deffn

@geindex PyNumberMethods.nb_positive (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_positive}@anchor{4da0}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_positive
@end deffn

@geindex PyNumberMethods.nb_absolute (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_absolute}@anchor{4da1}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_absolute
@end deffn

@geindex PyNumberMethods.nb_bool (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_bool}@anchor{4da2}
@deffn {C Miembro} @ref{4a26,,inquiry} @ref{145d,,PyNumberMethods}.nb_bool
@end deffn

@geindex PyNumberMethods.nb_invert (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_invert}@anchor{4da3}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_invert
@end deffn

@geindex PyNumberMethods.nb_lshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_lshift}@anchor{4da4}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_lshift
@end deffn

@geindex PyNumberMethods.nb_rshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_rshift}@anchor{4da6}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_rshift
@end deffn

@geindex PyNumberMethods.nb_and (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_and}@anchor{4da8}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_and
@end deffn

@geindex PyNumberMethods.nb_xor (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_xor}@anchor{4daa}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_xor
@end deffn

@geindex PyNumberMethods.nb_or (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_or}@anchor{4dac}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_or
@end deffn

@geindex PyNumberMethods.nb_int (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_int}@anchor{4dae}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_int
@end deffn

@geindex PyNumberMethods.nb_reserved (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_reserved}@anchor{4daf}
@deffn {C Miembro} void *@ref{145d,,PyNumberMethods}.nb_reserved
@end deffn

@geindex PyNumberMethods.nb_float (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_float}@anchor{4db0}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_float
@end deffn

@geindex PyNumberMethods.nb_inplace_add (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_add}@anchor{4d95}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_add
@end deffn

@geindex PyNumberMethods.nb_inplace_subtract (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_subtract}@anchor{4d97}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_subtract
@end deffn

@geindex PyNumberMethods.nb_inplace_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_multiply}@anchor{4d99}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_multiply
@end deffn

@geindex PyNumberMethods.nb_inplace_remainder (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_remainder}@anchor{4d9b}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_remainder
@end deffn

@geindex PyNumberMethods.nb_inplace_power (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_power}@anchor{4d9e}
@deffn {C Miembro} @ref{4a34,,ternaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_power
@end deffn

@geindex PyNumberMethods.nb_inplace_lshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_lshift}@anchor{4da5}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_lshift
@end deffn

@geindex PyNumberMethods.nb_inplace_rshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_rshift}@anchor{4da7}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_rshift
@end deffn

@geindex PyNumberMethods.nb_inplace_and (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_and}@anchor{4da9}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_and
@end deffn

@geindex PyNumberMethods.nb_inplace_xor (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_xor}@anchor{4dab}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_xor
@end deffn

@geindex PyNumberMethods.nb_inplace_or (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_or}@anchor{4dad}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_or
@end deffn

@geindex PyNumberMethods.nb_floor_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_floor_divide}@anchor{4db1}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_floor_divide
@end deffn

@geindex PyNumberMethods.nb_true_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_true_divide}@anchor{4db3}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_true_divide
@end deffn

@geindex PyNumberMethods.nb_inplace_floor_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_floor_divide}@anchor{4db2}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_floor_divide
@end deffn

@geindex PyNumberMethods.nb_inplace_true_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_true_divide}@anchor{4db4}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_true_divide
@end deffn

@geindex PyNumberMethods.nb_index (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_index}@anchor{145c}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{145d,,PyNumberMethods}.nb_index
@end deffn

@geindex PyNumberMethods.nb_matrix_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_matrix_multiply}@anchor{4db5}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_matrix_multiply
@end deffn

@geindex PyNumberMethods.nb_inplace_matrix_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_matrix_multiply}@anchor{4db6}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{145d,,PyNumberMethods}.nb_inplace_matrix_multiply
@end deffn

@node Estructuras de objetos mapeo,Estructuras de objetos secuencia,Estructuras de objetos de números,Objetos tipo<2>
@anchor{c-api/typeobj mapping-object-structures}@anchor{4dd8}@anchor{c-api/typeobj mapping-structs}@anchor{4dc8}
@subsubsection Estructuras de objetos mapeo


@geindex PyMappingMethods (C type)
@anchor{c-api/typeobj c PyMappingMethods}@anchor{4885}
@deffn {C Tipo} type PyMappingMethods

Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo de mapeo. Tiene tres miembros:
@end deffn

@geindex PyMappingMethods.mp_length (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_length}@anchor{4db7}
@deffn {C Miembro} @ref{4a28,,lenfunc} @ref{4885,,PyMappingMethods}.mp_length

Esta función es utilizada por @ref{1a5d,,PyMapping_Size()} y @ref{499c,,PyObject_Size()}, y tiene la misma firma. Esta ranura puede establecerse en @code{NULL} si el objeto no tiene una longitud definida.
@end deffn

@geindex PyMappingMethods.mp_subscript (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_subscript}@anchor{1937}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{4885,,PyMappingMethods}.mp_subscript

Esta función es utilizada por @ref{43b,,PyObject_GetItem()} y @ref{49a7,,PySequence_GetSlice()}, y tiene la misma firma que @code{PyObject_GetItem()}. Este espacio debe llenarse para que la función @ref{495a,,PyMapping_Check()} retorna @code{1}, de lo contrario puede ser @code{NULL}.
@end deffn

@geindex PyMappingMethods.mp_ass_subscript (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_ass_subscript}@anchor{4db8}
@deffn {C Miembro} @ref{4a2a,,objobjargproc} @ref{4885,,PyMappingMethods}.mp_ass_subscript

This function is used by @ref{48bf,,PyObject_SetItem()},
@ref{4990,,PyObject_DelItem()}, @ref{49ae,,PySequence_SetSlice()} and
@ref{49a5,,PySequence_DelSlice()}.  It has the same signature as
@code{PyObject_SetItem()}, but `v' can also be set to @code{NULL} to delete
an item.  If this slot is @code{NULL}, the object does not support item
assignment and deletion.
@end deffn

@node Estructuras de objetos secuencia,Estructuras de objetos búfer,Estructuras de objetos mapeo,Objetos tipo<2>
@anchor{c-api/typeobj sequence-object-structures}@anchor{4dd9}@anchor{c-api/typeobj sequence-structs}@anchor{4dc7}
@subsubsection Estructuras de objetos secuencia


@geindex PySequenceMethods (C type)
@anchor{c-api/typeobj c PySequenceMethods}@anchor{4884}
@deffn {C Tipo} type PySequenceMethods

Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo de secuencia.
@end deffn

@geindex PySequenceMethods.sq_length (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_length}@anchor{4b2a}
@deffn {C Miembro} @ref{4a28,,lenfunc} @ref{4884,,PySequenceMethods}.sq_length

Esta función es utilizada por @ref{1a59,,PySequence_Size()} y @ref{499c,,PyObject_Size()}, y tiene la misma firma. También se usa para manejar índices negativos a través de los espacios @ref{1936,,sq_item} y @ref{4dbb,,sq_ass_item}.
@end deffn

@geindex PySequenceMethods.sq_concat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_concat}@anchor{4db9}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{4884,,PySequenceMethods}.sq_concat

Esta función es utilizada por @ref{49a2,,PySequence_Concat()} y tiene la misma firma. También es utilizado por el operador @code{+}, después de intentar la suma numérica a través de la ranura @ref{4b22,,nb_add}.
@end deffn

@geindex PySequenceMethods.sq_repeat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_repeat}@anchor{4dba}
@deffn {C Miembro} @ref{4a32,,ssizeargfunc} @ref{4884,,PySequenceMethods}.sq_repeat

Esta función es utilizada por @ref{49ad,,PySequence_Repeat()} y tiene la misma firma. También es utilizado por el operador @code{*}, después de intentar la multiplicación numérica a través de la ranura @ref{4d98,,nb_multiply}.
@end deffn

@geindex PySequenceMethods.sq_item (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_item}@anchor{1936}
@deffn {C Miembro} @ref{4a32,,ssizeargfunc} @ref{4884,,PySequenceMethods}.sq_item

Esta función es utilizada por @ref{1a5a,,PySequence_GetItem()} y tiene la misma firma. También es utilizado por @ref{43b,,PyObject_GetItem()}, después de intentar la suscripción a través de la ranura @ref{1937,,mp_subscript}. Este espacio debe llenarse para que la función @ref{49a1,,PySequence_Check()} retorna @code{1}, de lo contrario puede ser @code{NULL}.

Negative indexes are handled as follows: if the @ref{4b2a,,sq_length} slot is
filled, it is called and the sequence length is used to compute a positive
index which is passed to  @ref{1936,,sq_item}.  If @code{sq_length} is @code{NULL},
the index is passed as is to the function.
@end deffn

@geindex PySequenceMethods.sq_ass_item (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_ass_item}@anchor{4dbb}
@deffn {C Miembro} @ref{4a33,,ssizeobjargproc} @ref{4884,,PySequenceMethods}.sq_ass_item

Esta función es utilizada por @ref{1a5b,,PySequence_SetItem()} y tiene la misma firma. También lo usan @ref{48bf,,PyObject_SetItem()} y @ref{4990,,PyObject_DelItem()}, después de intentar la asignación y eliminación del elemento a través de la ranura @ref{4db8,,mp_ass_subscript}. Este espacio puede dejarse en @code{NULL} si el objeto no admite la asignación y eliminación de elementos.
@end deffn

@geindex PySequenceMethods.sq_contains (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_contains}@anchor{4dbc}
@deffn {C Miembro} @ref{4a2b,,objobjproc} @ref{4884,,PySequenceMethods}.sq_contains

Esta función puede ser utilizada por @ref{49a3,,PySequence_Contains()} y tiene la misma firma. Este espacio puede dejarse en @code{NULL}, en este caso @code{PySequence_Contains()} simplemente atraviesa la secuencia hasta que encuentra una coincidencia.
@end deffn

@geindex PySequenceMethods.sq_inplace_concat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_concat}@anchor{4dbd}
@deffn {C Miembro} @ref{4a1b,,binaryfunc} @ref{4884,,PySequenceMethods}.sq_inplace_concat

Esta función es utilizada por @ref{49a8,,PySequence_InPlaceConcat()} y tiene la misma firma. Debería modificar su primer operando y retornarlo. Este espacio puede dejarse en @code{NULL}, en este caso @code{PySequence_InPlaceConcat()} volverá a @ref{49a2,,PySequence_Concat()}. También es utilizado por la asignación aumentada @code{+=}, después de intentar la suma numérica en el lugar a través de la ranura @ref{4d95,,nb_inplace_add}.
@end deffn

@geindex PySequenceMethods.sq_inplace_repeat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_repeat}@anchor{4dbe}
@deffn {C Miembro} @ref{4a32,,ssizeargfunc} @ref{4884,,PySequenceMethods}.sq_inplace_repeat

Esta función es utilizada por @ref{49a9,,PySequence_InPlaceRepeat()} y tiene la misma firma. Debería modificar su primer operando y retornarlo. Este espacio puede dejarse en @code{NULL}, en este caso @code{PySequence_InPlaceRepeat()} volverá a @ref{49ad,,PySequence_Repeat()}. También es utilizado por la asignación aumentada @code{*=}, después de intentar la multiplicación numérica en el lugar a través de la ranura @ref{4d99,,nb_inplace_multiply}.
@end deffn

@node Estructuras de objetos búfer,Estructuras de objetos asíncronos,Estructuras de objetos secuencia,Objetos tipo<2>
@anchor{c-api/typeobj buffer-object-structures}@anchor{4dda}@anchor{c-api/typeobj buffer-structs}@anchor{4aed}
@subsubsection Estructuras de objetos búfer


@geindex PyBufferProcs (C type)
@anchor{c-api/typeobj c PyBufferProcs}@anchor{4b30}
@deffn {C Tipo} type PyBufferProcs

Esta estructura contiene punteros a las funciones requeridas por @ref{48a,,Buffer protocol}. El protocolo define cómo un objeto exportador puede exponer sus datos internos a objetos de consumo.
@end deffn

@geindex PyBufferProcs.bf_getbuffer (C member)
@anchor{c-api/typeobj c PyBufferProcs bf_getbuffer}@anchor{7fc}
@deffn {C Miembro} @ref{4a21,,getbufferproc} @ref{4b30,,PyBufferProcs}.bf_getbuffer

La firma de esta función es:

@example
int (PyObject *exporter, Py_buffer *view, int flags);
@end example

Maneja una solicitud a `exporter' para completar `view' según lo especificado por `flags'. Excepto por el punto (3), una implementación de esta función DEBE seguir estos pasos:


@enumerate 

@item 
Check if the request can be met. If not, raise @ref{182b,,BufferError},
set view->obj to @code{NULL} and return @code{-1}.

@item 
Rellene los campos solicitados.

@item 
Incrementa un contador interno para el número de exportaciones (`exports').

@item 
Set view->obj to `exporter' and increment view->obj.

@item 
Retorna @code{0}.
@end enumerate

Si `exporter' es parte de una cadena o árbol de proveedores de búfer, se pueden usar dos esquemas principales:


@itemize *

@item 
Re-export: Each member of the tree acts as the exporting object and
sets view->obj to a new reference to itself.

@item 
Redirect: The buffer request is redirected to the root object of the
tree. Here, view->obj will be a new reference to the root
object.
@end itemize

Los campos individuales de `view' se describen en la sección @ref{4aee,,Estructura de búfer}, las reglas sobre cómo debe reaccionar un exportador a solicitudes específicas se encuentran en la sección @ref{43cb,,Tipos de solicitud de búfer}.

Toda la memoria señalada en la estructura @ref{7f2,,Py_buffer} pertenece al exportador y debe permanecer válida hasta que no queden consumidores. @ref{4af8,,format}, @ref{4afa,,shape}, @ref{4af2,,strides}, @ref{4afc,,suboffsets} y @ref{4aff,,internal} son de solo lectura para el consumidor.

@ref{7fa,,PyBuffer_FillInfo()} proporciona una manera fácil de exponer un búfer de bytes simple mientras se trata correctamente con todos los tipos de solicitud.

@ref{48c,,PyObject_GetBuffer()} es la interfaz para el consumidor que envuelve esta función.
@end deffn

@geindex PyBufferProcs.bf_releasebuffer (C member)
@anchor{c-api/typeobj c PyBufferProcs bf_releasebuffer}@anchor{7fd}
@deffn {C Miembro} @ref{4a2c,,releasebufferproc} @ref{4b30,,PyBufferProcs}.bf_releasebuffer

La firma de esta función es:

@example
void (PyObject *exporter, Py_buffer *view);
@end example

Maneja una solicitud para liberar los recursos del búfer. Si no es necesario liberar recursos, @ref{7fd,,PyBufferProcs.bf_releasebuffer} puede ser @code{NULL}. De lo contrario, una implementación estándar de esta función tomará estos pasos opcionales:


@enumerate 

@item 
Disminuir un contador interno para el número de exportaciones.

@item 
Si el contador es @code{0}, libera toda la memoria asociada con `view'.
@end enumerate

El exportador DEBE utilizar el campo @ref{4aff,,internal} para realizar un seguimiento de los recursos específicos del búfer. Se garantiza que este campo permanecerá constante, mientras que un consumidor PUEDE pasar una copia del búfer original como argumento `view'.

This function MUST NOT decrement view->obj, since that is
done automatically in @ref{48d,,PyBuffer_Release()} (this scheme is
useful for breaking reference cycles).

@ref{48d,,PyBuffer_Release()} es la interfaz para el consumidor que envuelve esta función.
@end deffn

@node Estructuras de objetos asíncronos,Tipo Ranura typedefs,Estructuras de objetos búfer,Objetos tipo<2>
@anchor{c-api/typeobj async-object-structures}@anchor{4ddb}@anchor{c-api/typeobj async-structs}@anchor{4dc5}
@subsubsection Estructuras de objetos asíncronos



Added in version 3.5.


@geindex PyAsyncMethods (C type)
@anchor{c-api/typeobj c PyAsyncMethods}@anchor{4b29}
@deffn {C Tipo} type PyAsyncMethods

Esta estructura contiene punteros a las funciones requeridas para implementar objetos «esperable» (@ref{314,,awaitable}) y «iterador asincrónico» (@ref{312,,asynchronous iterator}).

Aquí está la definición de la estructura:

@example
typedef struct @{
    unaryfunc am_await;
    unaryfunc am_aiter;
    unaryfunc am_anext;
    sendfunc am_send;
@} PyAsyncMethods;
@end example
@end deffn

@geindex PyAsyncMethods.am_await (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_await}@anchor{4d90}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{4b29,,PyAsyncMethods}.am_await

La firma de esta función es:

@example
PyObject *am_await(PyObject *self);
@end example

The returned object must be an @ref{313,,iterator}, i.e. @ref{18fd,,PyIter_Check()}
must return @code{1} for it.

Este espacio puede establecerse en @code{NULL} si un objeto no es @ref{314,,awaitable}.
@end deffn

@geindex PyAsyncMethods.am_aiter (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_aiter}@anchor{4d91}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{4b29,,PyAsyncMethods}.am_aiter

La firma de esta función es:

@example
PyObject *am_aiter(PyObject *self);
@end example

Must return an @ref{312,,asynchronous iterator} object.
See @ref{1f09,,__anext__()} for details.

Este espacio puede establecerse en @code{NULL} si un objeto no implementa el protocolo de iteración asincrónica.
@end deffn

@geindex PyAsyncMethods.am_anext (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_anext}@anchor{4d92}
@deffn {C Miembro} @ref{4a36,,unaryfunc} @ref{4b29,,PyAsyncMethods}.am_anext

La firma de esta función es:

@example
PyObject *am_anext(PyObject *self);
@end example

Must return an @ref{314,,awaitable} object.
See @ref{1f09,,__anext__()} for details.
This slot may be set to @code{NULL}.
@end deffn

@geindex PyAsyncMethods.am_send (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_send}@anchor{4d93}
@deffn {C Miembro} @ref{4d94,,sendfunc} @ref{4b29,,PyAsyncMethods}.am_send

La firma de esta función es:

@example
PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);
@end example

Consulte @ref{930,,PyIter_Send()} para obtener más detalles. Esta ranura se puede establecer en @code{NULL}.


Added in version 3.10.

@end deffn

@node Tipo Ranura typedefs,Ejemplos<36>,Estructuras de objetos asíncronos,Objetos tipo<2>
@anchor{c-api/typeobj id6}@anchor{4dc0}@anchor{c-api/typeobj slot-type-typedefs}@anchor{4ddc}
@subsubsection Tipo Ranura `typedefs'


@geindex allocfunc (C type)
@anchor{c-api/typeobj c allocfunc}@anchor{4a1a}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*allocfunc)(@ref{b30,,PyTypeObject} *cls, @ref{af0,,Py_ssize_t} nitems)
` Part of the @ref{5f6,,Stable ABI}.'
The purpose of this function is to separate memory allocation from memory
initialization.  It should return a pointer to a block of memory of adequate
length for the instance, suitably aligned, and initialized to zeros, but with
@ref{937,,ob_refcnt} set to @code{1} and @ref{485d,,ob_type} set to the type argument.  If
the type’s @ref{1f6f,,tp_itemsize} is non-zero, the object’s @ref{4a08,,ob_size} field
should be initialized to `nitems' and the length of the allocated memory block
should be @code{tp_basicsize + nitems*tp_itemsize}, rounded up to a multiple of
@code{sizeof(void*)}; otherwise, `nitems' is not used and the length of the block
should be @ref{a19,,tp_basicsize}.

Esta función no debe hacer ninguna otra instancia de inicialización, ni siquiera para asignar memoria adicional; eso debe ser realizado por @ref{623,,tp_new}.
@end deffn

@geindex destructor (C type)
@anchor{c-api/typeobj c destructor}@anchor{4a1e}
@deffn {C Tipo} typedef void (*destructor)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex freefunc (C type)
@anchor{c-api/typeobj c freefunc}@anchor{4c21}
@deffn {C Tipo} typedef void (*freefunc)(void*)

Consulte @ref{4860,,tp_free}.
@end deffn

@geindex newfunc (C type)
@anchor{c-api/typeobj c newfunc}@anchor{4a29}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*newfunc)(@ref{b30,,PyTypeObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{623,,tp_new}.
@end deffn

@geindex initproc (C type)
@anchor{c-api/typeobj c initproc}@anchor{4a25}
@deffn {C Tipo} typedef int (*initproc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{625,,tp_init}.
@end deffn

@geindex reprfunc (C type)
@anchor{c-api/typeobj c reprfunc}@anchor{4a2d}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*reprfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{4874,,tp_repr}.
@end deffn

@geindex getattrfunc (C type)
@anchor{c-api/typeobj c getattrfunc}@anchor{4a1f}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*getattrfunc)(@ref{42d,,PyObject} *self, char *attr)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el valor del atributo nombrado para el objeto.
@end deffn

@geindex setattrfunc (C type)
@anchor{c-api/typeobj c setattrfunc}@anchor{4a2f}
@deffn {C Tipo} typedef int (*setattrfunc)(@ref{42d,,PyObject} *self, char *attr, @ref{42d,,PyObject} *value)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el valor del atributo nombrado para el objeto. El argumento del valor se establece en @code{NULL} para eliminar el atributo.
@end deffn

@geindex getattrofunc (C type)
@anchor{c-api/typeobj c getattrofunc}@anchor{4a20}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*getattrofunc)(@ref{42d,,PyObject} *self, @ref{42d,,PyObject} *attr)
` Part of the @ref{5f6,,Stable ABI}.'
Retorna el valor del atributo nombrado para el objeto.

Consulte @ref{16f8,,tp_getattro}.
@end deffn

@geindex setattrofunc (C type)
@anchor{c-api/typeobj c setattrofunc}@anchor{4a30}
@deffn {C Tipo} typedef int (*setattrofunc)(@ref{42d,,PyObject} *self, @ref{42d,,PyObject} *attr, @ref{42d,,PyObject} *value)
` Part of the @ref{5f6,,Stable ABI}.'
Establece el valor del atributo nombrado para el objeto. El argumento del valor se establece en @code{NULL} para eliminar el atributo.

Consulte @ref{4878,,tp_setattro}.
@end deffn

@geindex descrgetfunc (C type)
@anchor{c-api/typeobj c descrgetfunc}@anchor{4a1c}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*descrgetfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
See @ref{4d89,,tp_descr_get}.
@end deffn

@geindex descrsetfunc (C type)
@anchor{c-api/typeobj c descrsetfunc}@anchor{4a1d}
@deffn {C Tipo} typedef int (*descrsetfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
See @ref{18ff,,tp_descr_set}.
@end deffn

@geindex hashfunc (C type)
@anchor{c-api/typeobj c hashfunc}@anchor{4a24}
@deffn {C Tipo} typedef @ref{12d1,,Py_hash_t} (*hashfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{4886,,tp_hash}.
@end deffn

@geindex richcmpfunc (C type)
@anchor{c-api/typeobj c richcmpfunc}@anchor{4a2e}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*richcmpfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, int)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{4880,,tp_richcompare}.
@end deffn

@geindex getiterfunc (C type)
@anchor{c-api/typeobj c getiterfunc}@anchor{4a22}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*getiterfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{152e,,tp_iter}.
@end deffn

@geindex iternextfunc (C type)
@anchor{c-api/typeobj c iternextfunc}@anchor{4a27}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*iternextfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
Consulte @ref{152f,,tp_iternext}.
@end deffn

@geindex lenfunc (C type)
@anchor{c-api/typeobj c lenfunc}@anchor{4a28}
@deffn {C Tipo} typedef @ref{af0,,Py_ssize_t} (*lenfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex getbufferproc (C type)
@anchor{c-api/typeobj c getbufferproc}@anchor{4a21}
@deffn {C Tipo} typedef int (*getbufferproc)(@ref{42d,,PyObject}*, @ref{7f2,,Py_buffer}*, int)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
@end deffn

@geindex releasebufferproc (C type)
@anchor{c-api/typeobj c releasebufferproc}@anchor{4a2c}
@deffn {C Tipo} typedef void (*releasebufferproc)(@ref{42d,,PyObject}*, @ref{7f2,,Py_buffer}*)
` Part of the @ref{5f6,,Stable ABI} since version 3.12.'
@end deffn

@geindex unaryfunc (C type)
@anchor{c-api/typeobj c unaryfunc}@anchor{4a36}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*unaryfunc)(@ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex binaryfunc (C type)
@anchor{c-api/typeobj c binaryfunc}@anchor{4a1b}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*binaryfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex sendfunc (C type)
@anchor{c-api/typeobj c sendfunc}@anchor{4d94}
@deffn {C Tipo} typedef @ref{4aea,,PySendResult} (*sendfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}**)

Consulte @ref{4d93,,am_send}.
@end deffn

@geindex ternaryfunc (C type)
@anchor{c-api/typeobj c ternaryfunc}@anchor{4a34}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*ternaryfunc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex ssizeargfunc (C type)
@anchor{c-api/typeobj c ssizeargfunc}@anchor{4a32}
@deffn {C Tipo} typedef @ref{42d,,PyObject} *(*ssizeargfunc)(@ref{42d,,PyObject}*, @ref{af0,,Py_ssize_t})
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex ssizeobjargproc (C type)
@anchor{c-api/typeobj c ssizeobjargproc}@anchor{4a33}
@deffn {C Tipo} typedef int (*ssizeobjargproc)(@ref{42d,,PyObject}*, @ref{af0,,Py_ssize_t}, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex objobjproc (C type)
@anchor{c-api/typeobj c objobjproc}@anchor{4a2b}
@deffn {C Tipo} typedef int (*objobjproc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@geindex objobjargproc (C type)
@anchor{c-api/typeobj c objobjargproc}@anchor{4a2a}
@deffn {C Tipo} typedef int (*objobjargproc)(@ref{42d,,PyObject}*, @ref{42d,,PyObject}*, @ref{42d,,PyObject}*)
` Part of the @ref{5f6,,Stable ABI}.'
@end deffn

@node Ejemplos<36>,,Tipo Ranura typedefs,Objetos tipo<2>
@anchor{c-api/typeobj examples}@anchor{4ddd}@anchor{c-api/typeobj typedef-examples}@anchor{4d81}
@subsubsection Ejemplos


Los siguientes son ejemplos simples de definiciones de tipo Python. Incluyen el uso común que puede encontrar. Algunos demuestran casos difíciles de esquina (`corner cases'). Para obtener más ejemplos, información práctica y un tutorial, consulte «definiendo nuevos tipos» (@ref{4856,,Definición de tipos de extensión; Tutorial}) y «tópicos de nuevos tipos (@ref{486f,,Definición de tipos de extensión; temas variados}).

Un @ref{819,,tipo estático} básico:

@example
typedef struct @{
    PyObject_HEAD
    const char *data;
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject),
    .tp_doc = PyDoc_STR("My objects"),
    .tp_new = myobj_new,
    .tp_dealloc = (destructor)myobj_dealloc,
    .tp_repr = (reprfunc)myobj_repr,
@};
@end example

También puede encontrar código más antiguo (especialmente en la base de código CPython) con un inicializador más detallado:

@example
static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    "mymod.MyObject",               /* tp_name */
    sizeof(MyObject),               /* tp_basicsize */
    0,                              /* tp_itemsize */
    (destructor)myobj_dealloc,      /* tp_dealloc */
    0,                              /* tp_vectorcall_offset */
    0,                              /* tp_getattr */
    0,                              /* tp_setattr */
    0,                              /* tp_as_async */
    (reprfunc)myobj_repr,           /* tp_repr */
    0,                              /* tp_as_number */
    0,                              /* tp_as_sequence */
    0,                              /* tp_as_mapping */
    0,                              /* tp_hash */
    0,                              /* tp_call */
    0,                              /* tp_str */
    0,                              /* tp_getattro */
    0,                              /* tp_setattro */
    0,                              /* tp_as_buffer */
    0,                              /* tp_flags */
    PyDoc_STR("My objects"),        /* tp_doc */
    0,                              /* tp_traverse */
    0,                              /* tp_clear */
    0,                              /* tp_richcompare */
    0,                              /* tp_weaklistoffset */
    0,                              /* tp_iter */
    0,                              /* tp_iternext */
    0,                              /* tp_methods */
    0,                              /* tp_members */
    0,                              /* tp_getset */
    0,                              /* tp_base */
    0,                              /* tp_dict */
    0,                              /* tp_descr_get */
    0,                              /* tp_descr_set */
    0,                              /* tp_dictoffset */
    0,                              /* tp_init */
    0,                              /* tp_alloc */
    myobj_new,                      /* tp_new */
@};
@end example

Un tipo que admite referencias débiles, instancias de diccionarios (`dicts') y `hashing':

@example
typedef struct @{
    PyObject_HEAD
    const char *data;
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject),
    .tp_doc = PyDoc_STR("My objects"),
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
         Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_MANAGED_DICT |
         Py_TPFLAGS_MANAGED_WEAKREF,
    .tp_new = myobj_new,
    .tp_traverse = (traverseproc)myobj_traverse,
    .tp_clear = (inquiry)myobj_clear,
    .tp_alloc = PyType_GenericNew,
    .tp_dealloc = (destructor)myobj_dealloc,
    .tp_repr = (reprfunc)myobj_repr,
    .tp_hash = (hashfunc)myobj_hash,
    .tp_richcompare = PyBaseObject_Type.tp_richcompare,
@};
@end example

A str subclass that cannot be subclassed and cannot be called
to create instances (e.g. uses a separate factory func) using
@ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION} flag:

@example
typedef struct @{
    PyUnicodeObject raw;
    char *extra;
@} MyStr;

static PyTypeObject MyStr_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyStr",
    .tp_basicsize = sizeof(MyStr),
    .tp_base = NULL,  // set to &PyUnicode_Type in module init
    .tp_doc = PyDoc_STR("my custom str"),
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION,
    .tp_repr = (reprfunc)myobj_repr,
@};
@end example

El @ref{819,,tipo estático} más simple con instancias de longitud fija:

@example
typedef struct @{
    PyObject_HEAD
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
@};
@end example

El @ref{819,,tipo estático} más simple con instancias de longitud variable:

@example
typedef struct @{
    PyObject_VAR_HEAD
    const char *data[1];
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject) - sizeof(char *),
    .tp_itemsize = sizeof(char *),
@};
@end example

@node Apoyo a la recolección de basura cíclica<2>,,Objetos tipo<2>,Soporte de implementación de objetos
@anchor{c-api/gcsupport doc}@anchor{4dde}@anchor{c-api/gcsupport supporting-cycle-detection}@anchor{4dc9}@anchor{c-api/gcsupport supporting-cyclic-garbage-collection}@anchor{4ddf}
@subsection Apoyo a la recolección de basura cíclica


El soporte de Python para detectar y recolectar basura que involucra referencias circulares requiere el soporte de tipos de objetos que son «contenedores» para otros objetos que también pueden ser contenedores. Los tipos que no almacenan referencias a otros objetos, o que solo almacenan referencias a tipos atómicos (como números o cadenas), no necesitan proporcionar ningún soporte explícito para la recolección de basura.

To create a container type, the @ref{18c6,,tp_flags} field of the type object must
include the @ref{817,,Py_TPFLAGS_HAVE_GC} and provide an implementation of the
@ref{818,,tp_traverse} handler.  If instances of the type are mutable, a
@ref{4872,,tp_clear} implementation must also be provided.


@table @asis

@item @ref{817,,Py_TPFLAGS_HAVE_GC}

Los objetos con un tipo con este indicador establecido deben cumplir con las reglas documentadas aquí. Por conveniencia, estos objetos se denominarán objetos contenedor.
@end table

Los constructores para tipos de contenedores deben cumplir con dos reglas:


@enumerate 

@item 
The memory for the object must be allocated using @ref{b2d,,PyObject_GC_New}
or @ref{b2e,,PyObject_GC_NewVar}.

@item 
Una vez que se inicializan todos los campos que pueden contener referencias a otros contenedores, debe llamar a @ref{1546,,PyObject_GC_Track()}.
@end enumerate

Del mismo modo, el desasignador (`deallocator') para el objeto debe cumplir con un par similar de reglas:


@enumerate 

@item 
Antes de invalidar los campos que se refieren a otros contenedores, debe llamarse @ref{1547,,PyObject_GC_UnTrack()}.

@item 
La memoria del objeto debe ser desasignada (`deallocated') usando @ref{1545,,PyObject_GC_Del()}.

@cartouche
@quotation Advertencia 
Si un tipo añade el Py_TPFLAGS_HAVE_GC, entonces `must' implementar al menos un manejado @ref{818,,tp_traverse} o usar explícitamente uno de su subclase o subclases.

When calling @ref{816,,PyType_Ready()} or some of the APIs that indirectly
call it like @ref{622,,PyType_FromSpecWithBases()} or
@ref{621,,PyType_FromSpec()} the interpreter will automatically populate the
@ref{18c6,,tp_flags}, @ref{818,,tp_traverse}
and @ref{4872,,tp_clear} fields if the type inherits from a
class that implements the garbage collector protocol and the child class
does `not' include the @ref{817,,Py_TPFLAGS_HAVE_GC} flag.
@end quotation
@end cartouche
@end enumerate

@geindex PyObject_GC_New (C macro)
@anchor{c-api/gcsupport c PyObject_GC_New}@anchor{b2d}
@deffn {C Macro} PyObject_GC_New (TYPE, typeobj)

Analogous to @ref{a17,,PyObject_New} but for container objects with the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag set.
@end deffn

@geindex PyObject_GC_NewVar (C macro)
@anchor{c-api/gcsupport c PyObject_GC_NewVar}@anchor{b2e}
@deffn {C Macro} PyObject_GC_NewVar (TYPE, typeobj, size)

Analogous to @ref{a18,,PyObject_NewVar} but for container objects with the
@ref{817,,Py_TPFLAGS_HAVE_GC} flag set.
@end deffn

@geindex PyUnstable_Object_GC_NewWithExtraData (C function)
@anchor{c-api/gcsupport c PyUnstable_Object_GC_NewWithExtraData}@anchor{173f}
@deffn {C Función} @ref{42d,,PyObject} *PyUnstable_Object_GC_NewWithExtraData (PyTypeObject *type, size_t extra_size)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Analogous to @ref{b2d,,PyObject_GC_New} but allocates `extra_size'
bytes at the end of the object (at offset
@ref{a19,,tp_basicsize}).
The allocated memory is initialized to zeros,
except for the @ref{42d,,Python object header}.

The extra data will be deallocated with the object, but otherwise it is
not managed by Python.

@cartouche
@quotation Advertencia 
The function is marked as unstable because the final mechanism
for reserving extra data after an instance is not yet decided.
For allocating a variable number of fields, prefer using
@ref{408a,,PyVarObject} and @ref{1f6f,,tp_itemsize}
instead.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex PyObject_GC_Resize (C macro)
@anchor{c-api/gcsupport c PyObject_GC_Resize}@anchor{1744}
@deffn {C Macro} PyObject_GC_Resize (TYPE, op, newsize)

Resize an object allocated by @ref{a18,,PyObject_NewVar}.
Returns the resized object of type @code{TYPE*} (refers to any C type)
or @code{NULL} on failure.

`op' must be of type @ref{408a,,PyVarObject}*
and must not be tracked by the collector yet.
`newsize' must be of type @ref{af0,,Py_ssize_t}.
@end deffn

@geindex PyObject_GC_Track (C function)
@anchor{c-api/gcsupport c PyObject_GC_Track}@anchor{1546}
@deffn {C Función} void PyObject_GC_Track (PyObject *op)
` Part of the @ref{5f6,,Stable ABI}.'
Agrega el objeto `op' al conjunto de objetos contenedor seguidos por el recolector de basura. El recolector puede ejecutarse en momentos inesperados, por lo que los objetos deben ser válidos durante el seguimiento. Esto debería llamarse una vez que todos los campos seguidos por @ref{818,,tp_traverse} se vuelven válidos, generalmente cerca del final del constructor.
@end deffn

@geindex PyObject_IS_GC (C function)
@anchor{c-api/gcsupport c PyObject_IS_GC}@anchor{a16}
@deffn {C Función} int PyObject_IS_GC (PyObject *obj)

Retorna un valor distinto de cero si el objeto implementa el protocolo del recolector de basura; de lo contrario, retorna 0.

El recolector de basura no puede rastrear el objeto si esta función retorna 0.
@end deffn

@geindex PyObject_GC_IsTracked (C function)
@anchor{c-api/gcsupport c PyObject_GC_IsTracked}@anchor{a08}
@deffn {C Función} int PyObject_GC_IsTracked (PyObject *op)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Retorna 1 si el tipo de objeto de `op' implementa el protocolo GC y el recolector de basura está rastreando `op' y 0 en caso contrario.

Esto es análogo a la función de Python @ref{1376,,gc.is_tracked()}.


Added in version 3.9.

@end deffn

@geindex PyObject_GC_IsFinalized (C function)
@anchor{c-api/gcsupport c PyObject_GC_IsFinalized}@anchor{a09}
@deffn {C Función} int PyObject_GC_IsFinalized (PyObject *op)
` Part of the @ref{5f6,,Stable ABI} since version 3.9.'
Retorna 1 si el tipo de objeto de `op' implementa el protocolo GC y `op' ya ha sido finalizado por el recolector de basura y 0 en caso contrario.

Esto es análogo a la función de Python @ref{993,,gc.is_finalized()}.


Added in version 3.9.

@end deffn

@geindex PyObject_GC_Del (C function)
@anchor{c-api/gcsupport c PyObject_GC_Del}@anchor{1545}
@deffn {C Función} void PyObject_GC_Del (void *op)
` Part of the @ref{5f6,,Stable ABI}.'
Releases memory allocated to an object using @ref{b2d,,PyObject_GC_New} or
@ref{b2e,,PyObject_GC_NewVar}.
@end deffn

@geindex PyObject_GC_UnTrack (C function)
@anchor{c-api/gcsupport c PyObject_GC_UnTrack}@anchor{1547}
@deffn {C Función} void PyObject_GC_UnTrack (void *op)
` Part of the @ref{5f6,,Stable ABI}.'
Elimina el objeto `op' del conjunto de objetos contenedor rastreados por el recolector de basura. Tenga en cuenta que @ref{1546,,PyObject_GC_Track()} puede ser llamado nuevamente en este objeto para agregarlo nuevamente al conjunto de objetos rastreados. El desasignador (el manejador @ref{485f,,tp_dealloc}) debería llamarlo para el objeto antes de que cualquiera de los campos utilizados por el manejador @ref{818,,tp_traverse} no sea válido.
@end deffn


Distinto en la versión 3.8: The @code{_PyObject_GC_TRACK()} and @code{_PyObject_GC_UNTRACK()} macros
have been removed from the public C API.


El manejador @ref{818,,tp_traverse} acepta un parámetro de función de este tipo:

@geindex visitproc (C type)
@anchor{c-api/gcsupport c visitproc}@anchor{4a37}
@deffn {C Tipo} typedef int (*visitproc)(@ref{42d,,PyObject} *object, void *arg)
` Part of the @ref{5f6,,Stable ABI}.'
Tipo de la función visitante que se pasa al manejador @ref{818,,tp_traverse}. La función debe llamarse con un objeto para atravesar como `object' y el tercer parámetro para el manejador @ref{818,,tp_traverse} como `arg'. El núcleo de Python utiliza varias funciones visitantes para implementar la detección de basura cíclica; No se espera que los usuarios necesiten escribir sus propias funciones visitante.
@end deffn

El manejador @ref{818,,tp_traverse} debe tener el siguiente tipo:

@geindex traverseproc (C type)
@anchor{c-api/gcsupport c traverseproc}@anchor{4a35}
@deffn {C Tipo} typedef int (*traverseproc)(@ref{42d,,PyObject} *self, @ref{4a37,,visitproc} visit, void *arg)
` Part of the @ref{5f6,,Stable ABI}.'
Función transversal para un objeto contenedor. Las implementaciones deben llamar a la función `visit' para cada objeto directamente contenido por `self', siendo los parámetros a `visit' el objeto contenido y el valor `arg' pasado al controlador. La función `visit' no debe llamarse con un argumento de objeto @code{NULL}. Si `visit' retorna un valor distinto de cero, ese valor debe retornarse inmediatamente.
@end deffn

Para simplificar la escritura de los manejadores @ref{818,,tp_traverse}, se proporciona un macro a @ref{4869,,Py_VISIT()}. Para usar este macro, la implementación @ref{818,,tp_traverse} debe nombrar sus argumentos exactamente `visit' y `arg':

@geindex Py_VISIT (C function)
@anchor{c-api/gcsupport c Py_VISIT}@anchor{4869}
@deffn {C Función} void Py_VISIT (PyObject *o)

Si `o' no es @code{NULL}, llama a la devolución de llamada (`callback') `visit', con argumentos `o' y `arg'. Si `visit' retorna un valor distinto de cero, lo retorna. Usando este macro, los manejadores @ref{818,,tp_traverse} tienen el siguiente aspecto:

@example
static int
my_traverse(Noddy *self, visitproc visit, void *arg)
@{
    Py_VISIT(self->foo);
    Py_VISIT(self->bar);
    return 0;
@}
@end example
@end deffn

El manejador @ref{4872,,tp_clear} debe ser del tipo @code{query}, o @code{NULL} si el objeto es inmutable.

@geindex inquiry (C type)
@anchor{c-api/gcsupport c inquiry}@anchor{4a26}
@deffn {C Tipo} typedef int (*inquiry)(@ref{42d,,PyObject} *self)
` Part of the @ref{5f6,,Stable ABI}.'
Descarta referencias que pueden haber creado ciclos de referencia. Los objetos inmutables no tienen que definir este método ya que nunca pueden crear directamente ciclos de referencia. Tenga en cuenta que el objeto aún debe ser válido después de llamar a este método (no solo llame a @ref{613,,Py_DECREF()} en una referencia). El recolector de basura llamará a este método si detecta que este objeto está involucrado en un ciclo de referencia.
@end deffn

@menu
* Controlar el estado del recolector de basura:: 
* Querying Garbage Collector State:: 

@end menu

@node Controlar el estado del recolector de basura,Querying Garbage Collector State,,Apoyo a la recolección de basura cíclica<2>
@anchor{c-api/gcsupport controlling-the-garbage-collector-state}@anchor{4de0}
@subsubsection Controlar el estado del recolector de basura


La C-API proporciona las siguientes funciones para controlar las ejecuciones de recolección de basura.

@geindex PyGC_Collect (C function)
@anchor{c-api/gcsupport c PyGC_Collect}@anchor{a20}
@deffn {C Función} @ref{af0,,Py_ssize_t} PyGC_Collect (void)
` Part of the @ref{5f6,,Stable ABI}.'
Realiza una recolección de basura completa, si el recolector de basura está habilitado. (Tenga en cuenta que @ref{acc,,gc.collect()} lo ejecuta incondicionalmente).

Retorna el número de objetos recolectados e inalcanzables que no se pueden recolectar. Si el recolector de basura está deshabilitado o ya está recolectando, retorna @code{0} inmediatamente. Los errores durante la recolección de basura se pasan a @ref{355,,sys.unraisablehook}. Esta función no genera excepciones.
@end deffn

@geindex PyGC_Enable (C function)
@anchor{c-api/gcsupport c PyGC_Enable}@anchor{93c}
@deffn {C Función} int PyGC_Enable (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Habilita el recolector de basura: similar a @ref{4378,,gc.enable()}. Retorna el estado anterior, 0 para deshabilitado y 1 para habilitado.


Added in version 3.10.

@end deffn

@geindex PyGC_Disable (C function)
@anchor{c-api/gcsupport c PyGC_Disable}@anchor{93d}
@deffn {C Función} int PyGC_Disable (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Deshabilita el recolector de basura: similar a @ref{4379,,gc.disable()}. Retorna el estado anterior, 0 para deshabilitado y 1 para habilitado.


Added in version 3.10.

@end deffn

@geindex PyGC_IsEnabled (C function)
@anchor{c-api/gcsupport c PyGC_IsEnabled}@anchor{93e}
@deffn {C Función} int PyGC_IsEnabled (void)
` Part of the @ref{5f6,,Stable ABI} since version 3.10.'
Consulta el estado del recolector de basura: similar a @ref{437a,,gc.isenabled()}. Retorna el estado actual, 0 para deshabilitado y 1 para habilitado.


Added in version 3.10.

@end deffn

@node Querying Garbage Collector State,,Controlar el estado del recolector de basura,Apoyo a la recolección de basura cíclica<2>
@anchor{c-api/gcsupport querying-garbage-collector-state}@anchor{4de1}
@subsubsection Querying Garbage Collector State


The C-API provides the following interface for querying information about
the garbage collector.

@geindex PyUnstable_GC_VisitObjects (C function)
@anchor{c-api/gcsupport c PyUnstable_GC_VisitObjects}@anchor{4de2}
@deffn {C Función} void PyUnstable_GC_VisitObjects (gcvisitobjects_t callback, void *arg)

@cartouche
@quotation This is Unstable API. It may change without warning in minor releases. `This is @ref{5ea,,Unstable API}. It may change without warning in minor releases.'
@end quotation
@end cartouche

Run supplied `callback' on all live GC-capable objects. `arg' is passed through to
all invocations of `callback'.

@cartouche
@quotation Advertencia 
If new objects are (de)allocated by the callback it is undefined if they
will be visited.

Garbage collection is disabled during operation. Explicitly running a collection
in the callback may lead to undefined behaviour e.g. visiting the same objects
multiple times or not at all.
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex gcvisitobjects_t (C type)
@anchor{c-api/gcsupport c gcvisitobjects_t}@anchor{4de3}
@deffn {C Tipo} typedef int (*gcvisitobjects_t)(@ref{42d,,PyObject} *object, void *arg)

Type of the visitor function to be passed to @ref{4de2,,PyUnstable_GC_VisitObjects()}.
`arg' is the same as the `arg' passed to @code{PyUnstable_GC_VisitObjects}.
Return @code{0} to continue iteration, return @code{1} to stop iteration. Other return
values are reserved for now so behavior on returning anything else is undefined.


Added in version 3.12.

@end deffn

@node Versiones de API y ABI,Monitoring C API,Soporte de implementación de objetos,Manual de referencia de la API en C de Python
@anchor{c-api/apiabiversion doc}@anchor{4de4}@anchor{c-api/apiabiversion api-and-abi-versioning}@anchor{4de5}@anchor{c-api/apiabiversion apiabiversion}@anchor{42a8}
@section Versiones de API y ABI


CPython expone su número de versión en las siguientes macros. Tenga en cuenta que estos corresponden a la versión con la que se `construye' el código, no necesariamente la versión utilizada en `tiempo de ejecución'.

Consulte @ref{5f6,,Estabilidad de la API en C} para obtener una discusión sobre la estabilidad de API y ABI en todas las versiones.

@geindex PY_MAJOR_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MAJOR_VERSION}@anchor{4de6}
@deffn {C Macro} PY_MAJOR_VERSION

El @code{3} en @code{3.4.1a2}.
@end deffn

@geindex PY_MINOR_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MINOR_VERSION}@anchor{4de7}
@deffn {C Macro} PY_MINOR_VERSION

El @code{4} en @code{3.4.1a2}.
@end deffn

@geindex PY_MICRO_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MICRO_VERSION}@anchor{4de8}
@deffn {C Macro} PY_MICRO_VERSION

El @code{1} en @code{3.4.1a2}.
@end deffn

@geindex PY_RELEASE_LEVEL (C macro)
@anchor{c-api/apiabiversion c PY_RELEASE_LEVEL}@anchor{4de9}
@deffn {C Macro} PY_RELEASE_LEVEL

La @code{a} en @code{3.4.1a2}. Puede ser @code{0xA} para la versión alfa, @code{0xB} para la versión beta, @code{0xC} para la versión candidata o @code{0xF} para la versión final.
@end deffn

@geindex PY_RELEASE_SERIAL (C macro)
@anchor{c-api/apiabiversion c PY_RELEASE_SERIAL}@anchor{4dea}
@deffn {C Macro} PY_RELEASE_SERIAL

El @code{2} en @code{3.4.1a2}, cero para lanzamientos finales.
@end deffn

@geindex PY_VERSION_HEX (C macro)
@anchor{c-api/apiabiversion c PY_VERSION_HEX}@anchor{7f1}
@deffn {C Macro} PY_VERSION_HEX

El número de versión de Python codificado en un solo entero.

La información de la versión subyacente se puede encontrar tratándola como un número de 32 bits de la siguiente manera:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Bytes

@tab

Bits (orden `big-endian')

@tab

Significado

@tab

Valor para @code{3.4.1a2}

@item

1

@tab

1-8

@tab

@code{PY_MAJOR_VERSION}

@tab

@code{0x03}

@item

2

@tab

9-16

@tab

@code{PY_MINOR_VERSION}

@tab

@code{0x04}

@item

3

@tab

17-24

@tab

@code{PY_MICRO_VERSION}

@tab

@code{0x01}

@item

4

@tab

25-28

@tab

@code{PY_RELEASE_LEVEL}

@tab

@code{0xA}

@item

29-32

@tab

@code{PY_RELEASE_SERIAL}

@tab

@code{0x2}

@end multitable


Así, @code{3.4.1a2} es la hexadecimal @code{0x030401a2} y @code{3.10.0} es la hexadecimal @code{0x030a00f0}.

Use esto para comparaciones numéricas, por ejemplo @code{#if PY_VERSION_HEX >= ...}.

Esta versión también está disponible a través del símbolo @ref{7f0,,Py_Version}.
@end deffn

@geindex Py_Version (C var)
@anchor{c-api/apiabiversion c Py_Version}@anchor{7f0}
@deffn {C Variable} const unsigned long Py_Version
` Part of the @ref{5f6,,Stable ABI} since version 3.11.'
El número de versión de Python en tiempo de ejecución codificado en un único entero constante, con el mismo formato que la macro @ref{7f1,,PY_VERSION_HEX}. Contiene la versión de Python utilizada en tiempo de ejecución.


Added in version 3.11.

@end deffn

Todas las macros dadas se definen en Include/patchlevel.h@footnote{https://github.com/python/cpython/tree/main/Include/patchlevel.h}.

@node Monitoring C API,Generating Execution Events,Versiones de API y ABI,Manual de referencia de la API en C de Python
@anchor{c-api/monitoring doc}@anchor{4deb}@anchor{c-api/monitoring c-api-monitoring}@anchor{2c8}@anchor{c-api/monitoring monitoring-c-api}@anchor{4dec}
@section Monitoring C API


Added in version 3.13.

An extension may need to interact with the event monitoring system. Subscribing
to events and registering callbacks can be done via the Python API exposed in
@ref{da,,sys.monitoring}.

@node Generating Execution Events,,Monitoring C API,Manual de referencia de la API en C de Python
@anchor{c-api/monitoring generating-execution-events}@anchor{4ded}
@section Generating Execution Events


The functions below make it possible for an extension to fire monitoring
events as it emulates the execution of Python code. Each of these functions
accepts a @code{PyMonitoringState} struct which contains concise information
about the activation state of events, as well as the event arguments, which
include a @code{PyObject*} representing the code object, the instruction offset
and sometimes additional, event-specific arguments (see @ref{da,,sys.monitoring}
for details about the signatures of the different event callbacks).
The @code{codelike} argument should be an instance of @ref{1d8,,types.CodeType}
or of a type that emulates it.

The VM disables tracing when firing an event, so there is no need for user
code to do that.

Monitoring functions should not be called with an exception set,
except those listed below as working with the current exception.

@geindex PyMonitoringState (C type)
@anchor{c-api/monitoring c PyMonitoringState}@anchor{40b}
@deffn {C Tipo} type PyMonitoringState

Representation of the state of an event type. It is allocated by the user
while its contents are maintained by the monitoring API functions described below.
@end deffn

All of the functions below return 0 on success and -1 (with an exception set) on error.

See @ref{da,,sys.monitoring} for descriptions of the events.

@geindex PyMonitoring_FirePyStartEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyStartEvent}@anchor{40c}
@deffn {C Función} int PyMonitoring_FirePyStartEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{PY_START} event.
@end deffn

@geindex PyMonitoring_FirePyResumeEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyResumeEvent}@anchor{40d}
@deffn {C Función} int PyMonitoring_FirePyResumeEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{PY_RESUME} event.
@end deffn

@geindex PyMonitoring_FirePyReturnEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyReturnEvent}@anchor{40e}
@deffn {C Función} int PyMonitoring_FirePyReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Fire a @code{PY_RETURN} event.
@end deffn

@geindex PyMonitoring_FirePyYieldEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyYieldEvent}@anchor{40f}
@deffn {C Función} int PyMonitoring_FirePyYieldEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Fire a @code{PY_YIELD} event.
@end deffn

@geindex PyMonitoring_FireCallEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCallEvent}@anchor{410}
@deffn {C Función} int PyMonitoring_FireCallEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *callable, PyObject *arg0)

Fire a @code{CALL} event.
@end deffn

@geindex PyMonitoring_FireLineEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireLineEvent}@anchor{411}
@deffn {C Función} int PyMonitoring_FireLineEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, int lineno)

Fire a @code{LINE} event.
@end deffn

@geindex PyMonitoring_FireJumpEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireJumpEvent}@anchor{412}
@deffn {C Función} int PyMonitoring_FireJumpEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

Fire a @code{JUMP} event.
@end deffn

@geindex PyMonitoring_FireBranchEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireBranchEvent}@anchor{413}
@deffn {C Función} int PyMonitoring_FireBranchEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

Fire a @code{BRANCH} event.
@end deffn

@geindex PyMonitoring_FireCReturnEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCReturnEvent}@anchor{414}
@deffn {C Función} int PyMonitoring_FireCReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Fire a @code{C_RETURN} event.
@end deffn

@geindex PyMonitoring_FirePyThrowEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyThrowEvent}@anchor{415}
@deffn {C Función} int PyMonitoring_FirePyThrowEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{PY_THROW} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireRaiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireRaiseEvent}@anchor{416}
@deffn {C Función} int PyMonitoring_FireRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{RAISE} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireCRaiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCRaiseEvent}@anchor{417}
@deffn {C Función} int PyMonitoring_FireCRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{C_RAISE} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireReraiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireReraiseEvent}@anchor{418}
@deffn {C Función} int PyMonitoring_FireReraiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{RERAISE} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireExceptionHandledEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireExceptionHandledEvent}@anchor{419}
@deffn {C Función} int PyMonitoring_FireExceptionHandledEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire an @code{EXCEPTION_HANDLED} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FirePyUnwindEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyUnwindEvent}@anchor{41a}
@deffn {C Función} int PyMonitoring_FirePyUnwindEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Fire a @code{PY_UNWIND} event with the current exception (as returned by
@ref{28b,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireStopIterationEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireStopIterationEvent}@anchor{41b}
@deffn {C Función} int PyMonitoring_FireStopIterationEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *value)

Fire a @code{STOP_ITERATION} event. If @code{value} is an instance of @ref{c82,,StopIteration}, it is used. Otherwise,
a new @ref{c82,,StopIteration} instance is created with @code{value} as its argument.
@end deffn

@menu
* Managing the Monitoring State:: 

@end menu

@node Managing the Monitoring State,,,Generating Execution Events
@anchor{c-api/monitoring managing-the-monitoring-state}@anchor{4dee}
@subsection Managing the Monitoring State


Monitoring states can be managed with the help of monitoring scopes. A scope
would typically correspond to a python function.

@geindex PyMonitoring_EnterScope (C function)
@anchor{c-api/monitoring c PyMonitoring_EnterScope}@anchor{41c}
@deffn {C Función} int PyMonitoring_EnterScope (PyMonitoringState *state_array, uint64_t *version, const uint8_t *event_types, Py_ssize_t length)

Enter a monitored scope. @code{event_types} is an array of the event IDs for
events that may be fired from the scope. For example, the ID of a @code{PY_START}
event is the value @code{PY_MONITORING_EVENT_PY_START}, which is numerically equal
to the base-2 logarithm of @code{sys.monitoring.events.PY_START}.
@code{state_array} is an array with a monitoring state entry for each event in
@code{event_types}, it is allocated by the user but populated by
@code{PyMonitoring_EnterScope()} with information about the activation state of
the event. The size of @code{event_types} (and hence also of @code{state_array})
is given in @code{length}.

The @code{version} argument is a pointer to a value which should be allocated
by the user together with @code{state_array} and initialized to 0,
and then set only by @code{PyMonitoring_EnterScope()} itself. It allows this
function to determine whether event states have changed since the previous call,
and to return quickly if they have not.

The scopes referred to here are lexical scopes: a function, class or method.
@code{PyMonitoring_EnterScope()} should be called whenever the lexical scope is
entered. Scopes can be reentered, reusing the same `state_array' and `version',
in situations like when emulating a recursive Python function. When a code-like’s
execution is paused, such as when emulating a generator, the scope needs to
be exited and re-entered.

The macros for `event_types' are:

@c The table is here to make the docs searchable, and to allow automatic
@c links to the identifiers.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Macro

@tab

Event

@item

@geindex PY_MONITORING_EVENT_BRANCH (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_BRANCH}@anchor{4def}
@deffn {C Macro} PY_MONITORING_EVENT_BRANCH
@end deffn

@tab

@ref{42bd,,BRANCH}

@item

@geindex PY_MONITORING_EVENT_CALL (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_CALL}@anchor{4df0}
@deffn {C Macro} PY_MONITORING_EVENT_CALL
@end deffn

@tab

@ref{1651,,CALL}

@item

@geindex PY_MONITORING_EVENT_C_RAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RAISE}@anchor{4df1}
@deffn {C Macro} PY_MONITORING_EVENT_C_RAISE
@end deffn

@tab

@ref{42be,,C_RAISE}

@item

@geindex PY_MONITORING_EVENT_C_RETURN (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RETURN}@anchor{4df2}
@deffn {C Macro} PY_MONITORING_EVENT_C_RETURN
@end deffn

@tab

@ref{42bf,,C_RETURN}

@item

@geindex PY_MONITORING_EVENT_EXCEPTION_HANDLED (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_EXCEPTION_HANDLED}@anchor{4df3}
@deffn {C Macro} PY_MONITORING_EVENT_EXCEPTION_HANDLED
@end deffn

@tab

@ref{42c0,,EXCEPTION_HANDLED}

@item

@geindex PY_MONITORING_EVENT_INSTRUCTION (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_INSTRUCTION}@anchor{4df4}
@deffn {C Macro} PY_MONITORING_EVENT_INSTRUCTION
@end deffn

@tab

@ref{42c1,,INSTRUCTION}

@item

@geindex PY_MONITORING_EVENT_JUMP (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_JUMP}@anchor{4df5}
@deffn {C Macro} PY_MONITORING_EVENT_JUMP
@end deffn

@tab

@ref{42c2,,JUMP}

@item

@geindex PY_MONITORING_EVENT_LINE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_LINE}@anchor{4df6}
@deffn {C Macro} PY_MONITORING_EVENT_LINE
@end deffn

@tab

@ref{42c3,,LINE}

@item

@geindex PY_MONITORING_EVENT_PY_RESUME (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RESUME}@anchor{4df7}
@deffn {C Macro} PY_MONITORING_EVENT_PY_RESUME
@end deffn

@tab

@ref{42c4,,PY_RESUME}

@item

@geindex PY_MONITORING_EVENT_PY_RETURN (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RETURN}@anchor{4df8}
@deffn {C Macro} PY_MONITORING_EVENT_PY_RETURN
@end deffn

@tab

@ref{42c5,,PY_RETURN}

@item

@geindex PY_MONITORING_EVENT_PY_START (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_START}@anchor{4df9}
@deffn {C Macro} PY_MONITORING_EVENT_PY_START
@end deffn

@tab

@ref{42c6,,PY_START}

@item

@geindex PY_MONITORING_EVENT_PY_THROW (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_THROW}@anchor{4dfa}
@deffn {C Macro} PY_MONITORING_EVENT_PY_THROW
@end deffn

@tab

@ref{42c7,,PY_THROW}

@item

@geindex PY_MONITORING_EVENT_PY_UNWIND (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_UNWIND}@anchor{4dfb}
@deffn {C Macro} PY_MONITORING_EVENT_PY_UNWIND
@end deffn

@tab

@ref{42c8,,PY_UNWIND}

@item

@geindex PY_MONITORING_EVENT_PY_YIELD (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_YIELD}@anchor{4dfc}
@deffn {C Macro} PY_MONITORING_EVENT_PY_YIELD
@end deffn

@tab

@ref{42c9,,PY_YIELD}

@item

@geindex PY_MONITORING_EVENT_RAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RAISE}@anchor{4dfd}
@deffn {C Macro} PY_MONITORING_EVENT_RAISE
@end deffn

@tab

@ref{1612,,RAISE}

@item

@geindex PY_MONITORING_EVENT_RERAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RERAISE}@anchor{4dfe}
@deffn {C Macro} PY_MONITORING_EVENT_RERAISE
@end deffn

@tab

@ref{42cb,,RERAISE}

@item

@geindex PY_MONITORING_EVENT_STOP_ITERATION (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_STOP_ITERATION}@anchor{4dff}
@deffn {C Macro} PY_MONITORING_EVENT_STOP_ITERATION
@end deffn

@tab

@ref{42ca,,STOP_ITERATION}

@end multitable

@end deffn

@geindex PyMonitoring_ExitScope (C function)
@anchor{c-api/monitoring c PyMonitoring_ExitScope}@anchor{41d}
@deffn {C Función} int PyMonitoring_ExitScope (void)

Exit the last scope that was entered with @code{PyMonitoring_EnterScope()}.
@end deffn

@node Instalando módulos de Python,Comos HOWTOs de Python,Manual de referencia de la API en C de Python,Top
@anchor{installing/index doc}@anchor{4e00}@anchor{installing/index installing-index}@anchor{f78}@anchor{installing/index installing-python-modules}@anchor{4e01}
@chapter Instalando módulos de Python


@*Correo electrónico: 
@email{distutils-sig@@python.org}


Como un proyecto popular de desarrollo de código abierto, Python tiene una comunidad activa de soporte de contribuyentes y usuarios que también hacen que su software esté disponible para que otros desarrolladores de Python lo usen bajo términos de licencia de código abierto.

Esto permite a los usuarios de Python compartir y colaborar de manera efectiva, beneficiándose de las soluciones que otros ya han creado para problemas comunes (¡y a veces incluso raros!), además de contribuir potencialmente con sus propias soluciones al grupo común.

This guide covers the installation part of the process. For a guide to
creating and sharing your own Python projects, refer to the
Python packaging user guide@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}.

@cartouche
@quotation Nota 
Para los usuarios corporativos y otros usuarios institucionales, se debe tener en cuenta que muchas organizaciones tienen sus propias políticas sobre el uso y la contribución al software de código abierto. Se deben tener en cuenta dichas políticas al utilizar las herramientas de distribución e instalación proporcionadas con Python.
@end quotation
@end cartouche

@menu
* Palabras clave: Palabras clave<2>. 
* Uso básico: Uso básico<3>. 
* ¿Cómo…:: 
* Problemas de instalación comunes:: 

@end menu

@node Palabras clave<2>,Uso básico<3>,,Instalando módulos de Python
@anchor{installing/index key-terms}@anchor{4e02}
@section Palabras clave



@itemize *

@item 
@code{pip} es el programa de instalación preferido. Desde Python 3.4 viene incluido por defecto con los instaladores binarios de Python.

@item 
Un `entorno virtual' es un entorno de Python parcialmente aislado que permite instalar paquetes para que los use una aplicación en particular, en lugar de instalarlos en todo el sistema.

@item 
@code{venv} es la herramienta estándar para crear entornos virtuales, y ha sido parte de Python desde Python 3.3. A partir de Python 3.4, instala @code{pip} en todos los entornos virtuales que se crean.

@item 
@code{virtualenv} es una alternativa de terceros (y predecesora) a @code{venv}. Permite usar entornos virtuales en versiones de Python anteriores a la 3.4, ya que, o no incluyen @code{venv} en absoluto o no pueden instalar automáticamente @code{pip} en los entornos recién creados.

@item 
El Índice de Paquetes de Python@footnote{https://pypi.org} es un repositorio público de paquetes bajo licencias de código abierto disponibles para otros usuarios de Python.

@item 
the Python Packaging Authority@footnote{https://www.pypa.io/} is the group of
developers and documentation authors responsible for the maintenance and
evolution of the standard packaging tools and the associated metadata and
file format standards. They maintain a variety of tools, documentation,
and issue trackers on GitHub@footnote{https://github.com/pypa}.

@item 
@code{distutils} es el sistema original de compilación y distribución que se agregó por primera vez a la biblioteca estándar de Python en 1998. Si bien el uso directo de @code{distutils} se está eliminando gradualmente, sentó las bases para la infraestructura actual de empaquetado y distribución, y no solo sigue siendo parte de la biblioteca estándar, sino que su nombre sigue vivo de otras maneras (como el nombre de la lista de correo utilizada para coordinar el desarrollo de estándares de empaquetado de Python).
@end itemize


Distinto en la versión 3.5: Ahora se recomienda el uso de @code{venv} para crear entornos virtuales.



@subsubheading Ver también


Guía de usuario de empaquetado de Python: Crear y usar entornos virtuales@footnote{https://packaging.python.org/installing/#creating-virtual-environments}


@node Uso básico<3>,¿Cómo…,Palabras clave<2>,Instalando módulos de Python
@anchor{installing/index basic-usage}@anchor{4e03}
@section Uso básico


Las herramientas estándar de empaquetado están diseñadas para que se usen desde la línea de comandos.

El siguiente comando instalará la última versión de un módulo y sus dependencias desde el Índice de Paquetes de Python:

@example
python -m pip install SomePackage
@end example

@cartouche
@quotation Nota 
Para usuarios POSIX (incluyendo los usuarios de macOS y Linux), los ejemplos en esta guía asumen que se está usando un @ref{1d08,,virtual environment}.

Para los usuarios de Windows, los ejemplos en esta guía asumen que se seleccionó la opción de ajustar la variable de entorno PATH del sistema al instalar Python.
@end quotation
@end cartouche

Es posible especificar una versión exacta o mínima directamente en la linea de comandos. Cuando se use un operando comparador como @code{>}, @code{<} o cualquier otro carácter especial que puede ser interpretado por el intérprete de comandos, el nombre del paquete y la versión deben ir entre comillas dobles:

@example
python -m pip install SomePackage==1.0.4    # specific version
python -m pip install "SomePackage>=1.0.4"  # minimum version
@end example

Normalmente, si ya hay instalado un módulo adecuado, intentar instalarlo otra vez no tendrá efecto alguno. Actualizar módulos existentes requiere que se solicite explícitamente:

@example
python -m pip install --upgrade SomePackage
@end example

Se puede encontrar más información y recursos acerca de @code{pip} y sus capacidades en la Guía de usuario de empaquetado de Python@footnote{https://packaging.python.org}.

La creación de entornos virtuales se realiza a través de el módulo @ref{111,,venv}. Instalar paquetes en un entorno virtual activo usa los comandos mostrados arriba.


@subsubheading Ver también


Guía de usuario de empaquetado de Python: Instalando paquetes de distribución de Python@footnote{https://packaging.python.org/installing/}


@node ¿Cómo…,Problemas de instalación comunes,Uso básico<3>,Instalando módulos de Python
@anchor{installing/index how-do-i}@anchor{4e04}
@section ¿Cómo…


Respuestas rápidas o enlaces para algunas tareas comunes.

@menu
* … instalo pip en versiones de Python anteriores a Python 3.4?: … instalo pip en versiones de Python anteriores a Python 3 4?. 
* … instalo paquetes solamente para el usuario actual?:: 
* … instalo paquetes científicos de Python?:: 
* … trabajo con múltiples versiones de Python instaladas en paralelo?:: 

@end menu

@node … instalo pip en versiones de Python anteriores a Python 3 4?,… instalo paquetes solamente para el usuario actual?,,¿Cómo…
@anchor{installing/index install-pip-in-versions-of-python-prior-to-python-3-4}@anchor{4e05}
@subsection … instalo @code{pip} en versiones de Python anteriores a Python 3.4?


Se empezó a incluir @code{pip} en Python con la versión de Python 3.4. Para versiones anteriores, @code{pip} tiene que ser instalado tal y como se describe en la Guía de usuario de empaquetado de Python.


@subsubheading Ver también


Guía de usuario de empaquetado de Python: Requisitos para instalar paquetes@footnote{https://packaging.python.org/installing/#requirements-for-installing-packages}


@c installing-per-user-installation:

@node … instalo paquetes solamente para el usuario actual?,… instalo paquetes científicos de Python?,… instalo pip en versiones de Python anteriores a Python 3 4?,¿Cómo…
@anchor{installing/index install-packages-just-for-the-current-user}@anchor{4e06}
@subsection … instalo paquetes solamente para el usuario actual?


Pasando la opción @code{--user} a @code{python -m pip install} instalará el paquete únicamente para el usuario actual, en lugar de hacerlo para todos los usuarios del sistema.

@node … instalo paquetes científicos de Python?,… trabajo con múltiples versiones de Python instaladas en paralelo?,… instalo paquetes solamente para el usuario actual?,¿Cómo…
@anchor{installing/index install-scientific-python-packages}@anchor{4e07}
@subsection … instalo paquetes científicos de Python?


Varios paquetes científicos de Python tienen dependencias binarias complejas y no se pueden instalar fácilmente usando @code{pip} directamente. En este momento, a menudo será más fácil para los usuarios instalar estos paquetes por otros medios@footnote{https://packaging.python.org/science/} en lugar de intentar instalarlos usando @code{pip}.


@subsubheading Ver también


Guía de usuario de empaquetado de Python: Instalando paquetes científicos@footnote{https://packaging.python.org/science/}


@node … trabajo con múltiples versiones de Python instaladas en paralelo?,,… instalo paquetes científicos de Python?,¿Cómo…
@anchor{installing/index work-with-multiple-versions-of-python-installed-in-parallel}@anchor{4e08}
@subsection … trabajo con múltiples versiones de Python instaladas en paralelo?


En Linux, macOS y otros sistemas POSIX, usa los comandos versionados de Python en combinación con la opción @code{-m} para ejecutar la copia apropiada de @code{pip}

@example
python2   -m pip install SomePackage  # default Python 2
python2.7 -m pip install SomePackage  # specifically Python 2.7
python3   -m pip install SomePackage  # default Python 3
python3.4 -m pip install SomePackage  # specifically Python 3.4
@end example

Los comandos @code{pip} adecuadamente versionados también pueden estar disponibles.

En Windows, use el lanzador de Python @code{py} en combinación con el interruptor @code{-m}

@example
py -2   -m pip install SomePackage  # default Python 2
py -2.7 -m pip install SomePackage  # specifically Python 2.7
py -3   -m pip install SomePackage  # default Python 3
py -3.4 -m pip install SomePackage  # specifically Python 3.4
@end example

@c other questions:
@c 
@c Once the Development & Deployment part of PPUG is fleshed out, some of
@c those sections should be linked from new questions here (most notably,
@c we should have a question about avoiding depending on PyPI that links to
@c https://packaging.python.org/en/latest/mirrors/)

@node Problemas de instalación comunes,,¿Cómo…,Instalando módulos de Python
@anchor{installing/index common-installation-issues}@anchor{4e09}
@section Problemas de instalación comunes


@menu
* Instalando en el Python del sistema bajo Linux:: 
* Pip no está instalado:: 
* Instalando extensiones binarias:: 

@end menu

@node Instalando en el Python del sistema bajo Linux,Pip no está instalado,,Problemas de instalación comunes
@anchor{installing/index installing-into-the-system-python-on-linux}@anchor{4e0a}
@subsection Instalando en el Python del sistema bajo Linux


En sistemas Linux, una instalación de Python se incluye como parte de la distribución. Instalar en esta instalación de Python requiere permisos de administrador de sistema y si algún componente se actualiza usando @code{pip} esto puede interferir con en uso del gestor de paquetes del sistema u otros componentes.

En estos sistemas, es generalmente mejor usar un entorno virtual o una instalación por usuario cuando se instalen paquetes con @code{pip}.

@node Pip no está instalado,Instalando extensiones binarias,Instalando en el Python del sistema bajo Linux,Problemas de instalación comunes
@anchor{installing/index pip-not-installed}@anchor{4e0b}
@subsection Pip no está instalado


Es posible que @code{pip} no se instale por defecto. Una posible solución es:

@example
python -m ensurepip --default-pip
@end example

También hay recursos adicionales para installing pip.@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/#ensure-pip-setuptools-and-wheel-are-up-to-date}

@node Instalando extensiones binarias,,Pip no está instalado,Problemas de instalación comunes
@anchor{installing/index installing-binary-extensions}@anchor{4e0c}
@subsection Instalando extensiones binarias


Python generalmente se ha basado en gran medida en la distribución basada en el código fuente, y se espera que los usuarios finales compilen módulos de extensión desde la fuente como parte del proceso de instalación.

Con la introducción del soporte para el formato binario @code{wheel}, y la posibilidad de publicar paquetes en formato @code{wheel} por lo menos para Windows y macOS a través del Índice de Paquetes de Python, se espera que este problema se atenúe con el tiempo, ya que los usuarios pueden, con mayor regularidad, instalar extensiones precompiladas en lugar de tener que compilarlas.

Algunas de las soluciones para instalar software científico@footnote{https://packaging.python.org/science/} aún no disponible como archivo @code{wheel} precompilado pueden ser de ayuda para obtener otras extensiones binarias sin tener que compilarlas localmente.


@subsubheading Ver también


Guía de usuario de empaquetado de Python: Extensiones binarias@footnote{https://packaging.python.org/extensions/}


@node Comos HOWTOs de Python,Preguntas más frecuentes de Python,Instalando módulos de Python,Top
@anchor{howto/index doc}@anchor{4e0d}@anchor{howto/index python-howtos}@anchor{4e0e}
@chapter Comos (`HOWTOs') de Python


Python HOWTOs are documents that cover a specific topic in-depth.
Modeled on the Linux Documentation Project’s HOWTO collection, this collection is an
effort to foster documentation that’s more detailed than the
Python Library Reference.

@menu
* Portar módulos de extensión a Python 3:: 
* Programación de curses con Python:: 
* Descriptor Guide:: 
* Debugging C API extensions and CPython Internals with GDB:: 
* HOWTO - Enum:: 
* HOWTO - Programación funcional:: 
* HOWTO hacer registros (Logging): HOWTO hacer registros Logging. 
* Libro de recetas de Logging:: 
* Expresiones regulares COMOS (HOWTO): Expresiones regulares COMOS HOWTO. 
* HOW TO - Programación con sockets:: 
* Sorting Techniques:: 
* CÓMO (HOWTO) Unicode: CÓMO HOWTO Unicode. 
* HOWTO - Cómo obtener recursos de Internet con el paquete urllib:: 
* Introducción al modulo ipaddress:: 
* Instrumentación de CPython con DTrace y SystemTap:: 
* Soporte de Python para el perfilador perf de Linux:: 
* Prácticas recomendadas para las anotaciones:: 
* Aislamiento de módulos de extensión:: 
* timer file descriptor HOWTO:: 
* The Python 2.3 Method Resolution Order: The Python 2 3 Method Resolution Order. 
* Python experimental support for free threading:: 
* C API Extension Support for Free Threading:: 

@end menu

@node Portar módulos de extensión a Python 3,Programación de curses con Python,,Comos HOWTOs de Python
@anchor{howto/cporting doc}@anchor{4e0f}@anchor{howto/cporting cporting-howto}@anchor{1348}@anchor{howto/cporting porting-extension-modules-to-python-3}@anchor{4e10}
@section Portar módulos de extensión a Python 3


Recomendamos los siguientes recursos para portar módulos de extensiones a Python 3:


@itemize *

@item 
El capítulo Migrating C extensions@footnote{http://python3porting.com/cextensions.html} de `Support Python 3: An in-depth guide', un libro sobre migrar de Python 2 a Python 3 en general, guía al lector a través cómo portar un módulo de extensión.

@item 
La Porting guide@footnote{https://py3c.readthedocs.io/en/latest/guide.html} de el proyecto `py3c' provee sugerencias dogmáticas con código de ejemplo.

@item 
Las bibliotecas Cython@footnote{https://cython.org/} y CFFI@footnote{https://cffi.readthedocs.io/en/latest/} ofrecen abstracciones sobre la API C de Python. Generalmente, las extensiones necesitan ser re-escritas para usar uno de ellos, pero la biblioteca luego gestiona las diferencias entre las diferentes versiones de Python y sus implementaciones.
@end itemize

@node Programación de curses con Python,Descriptor Guide,Portar módulos de extensión a Python 3,Comos HOWTOs de Python
@anchor{howto/curses doc}@anchor{4e11}@anchor{howto/curses curses-howto}@anchor{2da2}@anchor{howto/curses curses-programming-with-python}@anchor{4e12}
@section Programación de curses con Python


@*Autor: 
A.M. Kuchling, Eric S. Raymond


@*Versión: 
2.04


@subsubheading Resumen



Este documento describe cómo usar el módulo de extensión @ref{2c,,curses} para controlar las pantallas en modo texto.

@menu
* ¿Qué es curses?:: 
* Iniciar y finalizar una aplicación de curses:: 
* Ventanas y pads:: 
* Mostrando el texto:: 
* Input del usuario:: 
* Para más información:: 

@end menu

@node ¿Qué es curses?,Iniciar y finalizar una aplicación de curses,,Programación de curses con Python
@anchor{howto/curses what-is-curses}@anchor{4e13}
@subsection ¿Qué es curses?


La biblioteca curses proporciona una instalación independiente del terminal para manejo de teclado e impresión de pantalla en terminales basados en texto; tales terminales incluyen VT100, la consola de Linux y el terminal simulado proporcionado por varios programas. Los terminales de pantalla admiten varios códigos de control para realizar operaciones comunes, como mover el cursor, desplazar la pantalla y borrar áreas. Diferentes terminales utilizan códigos muy diferentes y, a menudo, tienen sus propias peculiaridades menores.

En un mundo de pantallas gráficas, uno podría preguntarse « ¿por qué molestarse »? Es cierto que los terminales de pantalla de celdas de caracteres son una tecnología obsoleta, pero hay nichos en los que poder hacer cosas elegantes con ellos sigue siendo valioso. Un nicho está en pequeños `Unix' incrustados o pequeñas marcas que no ejecutan un servidor X. Por otro lado herramientas como los instaladores del sistema operativo y los configuradores de kernel que pueden tener que ejecutarse antes de que haya soporte gráfico disponible.

The curses library provides fairly basic functionality, providing the
programmer with an abstraction of a display containing multiple
non-overlapping windows of text.  The contents of a window can be
changed in various ways—adding text, erasing it, changing its
appearance—and the curses library will figure out what control codes
need to be sent to the terminal to produce the right output.  curses
doesn’t provide many user-interface concepts such as buttons, checkboxes,
or dialogs; if you need such features, consider a user interface library such as
Urwid@footnote{https://pypi.org/project/Urwid/}.

La biblioteca curses se escribió originalmente para BSD Unix; Las versiones posteriores de Unix de `System V' de AT&T agregaron muchas mejoras y nuevas funciones. BSD curses ya no se mantiene, ya que ha sido reemplazado por ncurses, que es una implementación de código abierto de la interfaz AT&T. Si está utilizando un Unix de código abierto como Linux o FreeBSD, su sistema casi seguro usa ncurses. Como la mayoría de las versiones comerciales actuales de Unix se basan en el código del Sistema V, todas las funciones descritas aquí probablemente estarán disponibles. Sin embargo, las versiones anteriores de curses llevadas por algunos Unix propietarios no pueden admitir todo.

The Windows version of Python doesn’t include the @ref{2c,,curses}
module.  A ported version called UniCurses@footnote{https://pypi.org/project/UniCurses/} is available.

@menu
* El módulo curses de Python:: 

@end menu

@node El módulo curses de Python,,,¿Qué es curses?
@anchor{howto/curses the-python-curses-module}@anchor{4e14}
@subsubsection El módulo curses de Python


The Python module is a fairly simple wrapper over the C functions provided by
curses; if you’re already familiar with curses programming in C, it’s really
easy to transfer that knowledge to Python.  The biggest difference is that the
Python interface makes things simpler by merging different C functions such as
@code{addstr()}, @code{mvaddstr()}, and @code{mvwaddstr()} into a single
@ref{2db8,,addstr()} method.  You’ll see this covered in more
detail later.

Este HOWTO es una introducción a la escritura de programas en modo texto con curses y Python. No intenta ser una guía completa de la API de curses; para eso, vea la sección de la guía de la biblioteca de Python sobre ncurses, y las páginas del manual de C para ncurses. Sin embargo, le dará las ideas básicas.

@node Iniciar y finalizar una aplicación de curses,Ventanas y pads,¿Qué es curses?,Programación de curses con Python
@anchor{howto/curses starting-and-ending-a-curses-application}@anchor{4e15}
@subsection Iniciar y finalizar una aplicación de curses


Before doing anything, curses must be initialized.  This is done by
calling the @ref{15a3,,initscr()} function, which will determine the
terminal type, send any required setup codes to the terminal, and
create various internal data structures.  If successful,
@code{initscr()} returns a window object representing the entire
screen; this is usually called @code{stdscr} after the name of the
corresponding C variable.

@example
import curses
stdscr = curses.initscr()
@end example

Por lo general, las aplicaciones de curses desactivan el eco automático de las teclas en la pantalla, para poder leer las teclas y solo mostrarlas bajo ciertas circunstancias. Esto requiere llamar a la función @ref{2de1,,noecho()} function.

@example
curses.noecho()
@end example

Las aplicaciones también tendrán que reaccionar a las teclas al instante, sin necesidad de presionar la tecla Intro; Esto se llama modo cbreak, en oposición al modo de entrada almacenado en memoria intermedia habitual.

@example
curses.cbreak()
@end example

Los terminales generalmente retornan teclas especiales, como las teclas del cursor o las teclas de navegación, como Re Pág e Inicio, como una secuencia de escape multibyte. Si bien puede escribir su aplicación para esperar tales secuencias y procesarlas en consecuencia, curses pueden hacerlo por usted, retornando un valor especial como @ref{2e5b,,curses.KEY_LEFT}. Para obtener que curses haga el trabajo, deberá habilitar el modo de teclado.

@example
stdscr.keypad(True)
@end example

Terminar una aplicación de curses es mucho más fácil que iniciar una. Tendrás que llamar a

@example
curses.nocbreak()
stdscr.keypad(False)
curses.echo()
@end example

para revertir la configuración de terminal amigable de curses. Llame luego a la función @ref{2dbb,,endwin()} para restaurar el terminal a su modo operativo original.

@example
curses.endwin()
@end example

Un problema común al depurar una aplicación curses es hacer que su terminal se estropee cuando la aplicación muere sin restaurar el terminal a su estado anterior. En Python, esto ocurre comúnmente cuando su código tiene errores y genera una excepción no detectada. Las teclas ya no se repiten en la pantalla cuando las escribe, por ejemplo, lo que dificulta el uso del shell.

En Python puede evitar estas complicaciones y facilitar la depuración importando la función @ref{b0d,,curses.wrapper()} y usándola así:

@example
from curses import wrapper

def main(stdscr):
    # Clear screen
    stdscr.clear()

    # This raises ZeroDivisionError when i == 10.
    for i in range(0, 11):
        v = i-10
        stdscr.addstr(i, 0, '10 divided by @{@} is @{@}'.format(v, 10/v))

    stdscr.refresh()
    stdscr.getkey()

wrapper(main)
@end example

The @ref{b0d,,wrapper()} function takes a callable object and does the
initializations described above, also initializing colors if color
support is present.  @code{wrapper()} then runs your provided callable.
Once the callable returns, @code{wrapper()} will restore the original
state of the terminal.  The callable is called inside a
@ref{789,,try}…@ref{2f6,,except} that catches exceptions, restores
the state of the terminal, and then re-raises the exception.  Therefore
your terminal won’t be left in a funny state on exception and you’ll be
able to read the exception’s message and traceback.

@node Ventanas y pads,Mostrando el texto,Iniciar y finalizar una aplicación de curses,Programación de curses con Python
@anchor{howto/curses windows-and-pads}@anchor{4e16}
@subsection Ventanas y pads


Las ventanas son la abstracción básica en curses. Un objeto de ventana representa un área rectangular de la pantalla y admite métodos para mostrar texto, borrarlo, permitir al usuario ingresar cadenas, etc.

El objeto @code{stdscr} retornado por la función @ref{15a3,,initscr()} es un objeto de ventana que cubre toda la pantalla. Es posible que muchos programas solo necesiten esta única ventana, pero es posible que desee dividir la pantalla en ventanas más pequeñas para volver a dibujarlas o borrarlas por separado. La función @ref{2ddf,,newwin()} crea una nueva ventana de un tamaño dado, retornando el nuevo objeto de ventana.

@example
begin_x = 20; begin_y = 7
height = 5; width = 40
win = curses.newwin(height, width, begin_y, begin_x)
@end example

Tenga en cuenta que el sistema de coordenadas utilizado en curses es inusual. Las coordenadas siempre se pasan en el orden `y,x', y la esquina superior izquierda de una ventana es la coordenada (0,0). Esto rompe la convención normal para manejar coordenadas donde la coordenada `x' es lo primero. Esta es una desafortunada diferencia de la mayoría de las otras aplicaciones informáticas, pero ha sido parte de curses desde que se escribió por primera vez, y ahora es demasiado tarde para cambiar las cosas.

Su aplicación puede determinar el tamaño de la pantalla utilizando las variables @ref{1711,,curses.LINES} y @ref{1712,,curses.COLS} para obtener los tamaños `y' y `x'. Las coordenadas legales se extenderán de @code{(0,0)} a @code{(curses.LINES - 1, curses.COLS - 1)}.

Cuando llama a un método para mostrar o borrar texto, el efecto no aparece inmediatamente en la pantalla. En su lugar, debe llamar al método @ref{2db9,,refresh()} de los objetos de ventana para actualizar la pantalla.

This is because curses was originally written with slow 300-baud
terminal connections in mind; with these terminals, minimizing the
time required to redraw the screen was very important.  Instead curses
accumulates changes to the screen and displays them in the most
efficient manner when you call @code{refresh()}.  For example, if your
program displays some text in a window and then clears the window,
there’s no need to send the original text because they’re never
visible.

In practice, explicitly telling curses to redraw a window doesn’t
really complicate programming with curses much. Most programs go into a flurry
of activity, and then pause waiting for a keypress or some other action on the
part of the user.  All you have to do is to be sure that the screen has been
redrawn before pausing to wait for user input, by first calling
@code{stdscr.refresh()} or the @code{refresh()} method of some other relevant
window.

Un pad es un caso especial de una ventana; puede ser más grande que la pantalla de visualización real, y solo se muestra una parte del pad a la vez. La creación de un pad requiere la altura y el ancho del pad, mientras que la actualización de un pad requiere dar las coordenadas del área en pantalla donde se mostrará una subsección del pad.

@example
pad = curses.newpad(100, 100)
# These loops fill the pad with letters; addch() is
# explained in the next section
for y in range(0, 99):
    for x in range(0, 99):
        pad.addch(y,x, ord('a') + (x*x+y*y) % 26)

# Displays a section of the pad in the middle of the screen.
# (0,0) : coordinate of upper-left corner of pad area to display.
# (5,5) : coordinate of upper-left corner of window area to be filled
#         with pad content.
# (20, 75) : coordinate of lower-right corner of window area to be
#          : filled with pad content.
pad.refresh( 0,0, 5,5, 20,75)
@end example

The @code{refresh()} call displays a section of the pad in the rectangle
extending from coordinate (5,5) to coordinate (20,75) on the screen; the upper
left corner of the displayed section is coordinate (0,0) on the pad.  Beyond
that difference, pads are exactly like ordinary windows and support the same
methods.

If you have multiple windows and pads on screen there is a more
efficient way to update the screen and prevent annoying screen flicker
as each part of the screen gets updated.  @code{refresh()} actually
does two things:


@enumerate 

@item 
Llama al método @ref{2db7,,noutrefresh()} de cada ventana para actualizar una estructura de datos subyacente que representa el estado deseado de la pantalla.

@item 
Llama a la función @ref{2db6,,doupdate()} para cambiar la pantalla física para que coincida con el estado deseado registrado en la estructura de datos.
@end enumerate

Instead you can call @code{noutrefresh()} on a number of windows to
update the data structure, and then call @code{doupdate()} to update
the screen.

@node Mostrando el texto,Input del usuario,Ventanas y pads,Programación de curses con Python
@anchor{howto/curses displaying-text}@anchor{4e17}
@subsection Mostrando el texto


From a C programmer’s point of view, curses may sometimes look like a
twisty maze of functions, all subtly different.  For example,
@code{addstr()} displays a string at the current cursor location in
the @code{stdscr} window, while @code{mvaddstr()} moves to a given y,x
coordinate first before displaying the string. @code{waddstr()} is just
like @code{addstr()}, but allows specifying a window to use instead of
using @code{stdscr} by default. @code{mvwaddstr()} allows specifying both
a window and a coordinate.

Afortunadamente, la interfaz de Python oculta todos estos detalles. @code{stdscr} es un objeto de ventana como cualquier otro, y métodos como @ref{2db8,,addstr()} aceptan múltiples formas de argumento. Por lo general, hay cuatro formas diferentes.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Formas

@tab

Descripción

@item

`str' o `ch'

@tab

Mostrar la cadena `str' o el carácter `ch' en la posición actual

@item

`str' o `ch', `attr'

@tab

Muestra la cadena `str' o el carácter `ch', utilizando el atributo `attr' en la posición actual

@item

`y', `x', `str' o `ch'

@tab

Moverse a la posición `y,x' dentro de la ventana, y mostrar `st' o `ch'

@item

`y', `x', `str' o `ch', `attr'

@tab

Muévase a la posición `y, x' dentro de la ventana y muestre `str' o `ch', usando el atributo `attr'

@end multitable


Los atributos permiten mostrar texto en formas resaltadas como negrita, subrayado, código inverso o en color. Se explicarán con más detalle en la siguiente subsección.

The @ref{2db8,,addstr()} method takes a Python string or
bytestring as the value to be displayed.  The contents of bytestrings
are sent to the terminal as-is.  Strings are encoded to bytes using
the value of the window’s @ref{1112,,encoding} attribute; this defaults to
the default system encoding as returned by @ref{1d3,,locale.getencoding()}.

Los métodos @ref{2dfa,,addch()} toman un carácter, que puede ser una cadena de longitud 1, una cadena de bytes de longitud 1 o un entero.

Se proporcionan constantes para los caracteres de extensión; estas constantes son enteros mayores que 255. Por ejemplo @ref{2ec8,,ACS_PLMINUS} es un símbolo +/-, y @ref{2e04,,ACS_ULCORNER} es la esquina superior izquierda de un cuadro (útil para dibujar bordes). También puede usar el carácter Unicode apropiado.

Windows recuerda dónde se dejó el cursor después de la última operación, por lo que si deja de lado las coordenadas `y, x', la cadena o el carácter se mostrarán donde se haya quedado la última operación. También puede mover el cursor con el método @code{move(y, x)}. Debido a que algunos terminales siempre muestran un cursor parpadeante, es posible que desee asegurarse de que el cursor esté ubicado en algún lugar donde no distraiga; Puede ser confuso tener el cursor parpadeando en alguna ubicación aparentemente aleatoria.

Si su aplicación no necesita un cursor parpadeante, puede llamar a @code{curs_set (False)} para hacerla invisible. Para compatibilidad con versiones anteriores de curses, hay una función @code{jeaveok (bool)} que es sinónimo de @ref{2db0,,curs_set()}. Cuando `bool' es verdadero, la biblioteca curses intentará suprimir el cursor parpadeante, y no tendrá que preocuparse por dejarlo en ubicaciones extrañas.

@menu
* Atributos y color:: 

@end menu

@node Atributos y color,,,Mostrando el texto
@anchor{howto/curses attributes-and-color}@anchor{4e18}
@subsubsection Atributos y color


Los caracteres se pueden mostrar de diferentes maneras. Las líneas de estado en una aplicación basada en texto se muestran comúnmente en video inverso, o un visor de texto puede necesitar resaltar ciertas palabras. curses admite esto al permitirle especificar un atributo para cada celda en la pantalla.

Un atributo es un entero, cada bit representa un atributo diferente. Puede intentar mostrar texto con múltiples conjuntos de bits de atributos, pero curses no garantizan que todas las combinaciones posibles estén disponibles, o que todas sean visualmente distintas. Eso depende de la capacidad del terminal que se utilice, por lo que es más seguro apegarse a los atributos más comúnmente disponibles, enumerados aquí.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Descripción

@item

@ref{2e47,,A_BLINK}

@tab

Texto parpadeante

@item

@ref{2e48,,A_BOLD}

@tab

Texto extra brillante o en negrita

@item

@ref{2e49,,A_DIM}

@tab

Texto medio brillante

@item

@ref{2dae,,A_REVERSE}

@tab

Texto de video inverso

@item

@ref{2dad,,A_STANDOUT}

@tab

El mejor modo de resaltado disponible

@item

@ref{2e4d,,A_UNDERLINE}

@tab

Texto subrayado

@end multitable


Entonces, para mostrar una línea de estado de video inverso en la línea superior de la pantalla, puede codificar:

@example
stdscr.addstr(0, 0, "Current mode: Typing mode",
              curses.A_REVERSE)
stdscr.refresh()
@end example

La biblioteca curses también admite color en los terminales que lo proporcionen. El terminal más común es probablemente la consola de Linux, seguido de `xterms' en color.

Para usar el color, debe llamar a la función @ref{2deb,,start_color()} poco después de llamar @ref{15a3,,initscr()}, para inicializar el conjunto de colores predeterminado (la función @ref{b0d,,curses.wrapper()} hace esto automáticamente). Una vez hecho esto, la función @ref{2dcf,,has_colors()} retorna TRUE si el terminal en uso realmente puede mostrar color. (Nota: curses usa el ‘color’ de la ortografía estadounidense, en lugar del ‘color’ de la ortografía canadiense/británica. Si está acostumbrado a la ortografía británica, tendrá que resignarse a escribir mal por el bien de estas funciones. )

La biblioteca curses mantiene un número finito de pares de colores, que contienen un color de primer plano (o texto) y un color de fondo. Puede obtener el valor del atributo correspondiente a un par de colores con la función @ref{2dac,,color_pair()}; esto puede ser operado bit a bit con otros atributos como @ref{2dae,,A_REVERSE}, pero nuevamente, no se garantiza que tales combinaciones funcionen en todos los terminales.

Un ejemplo, que muestra una línea de texto usando el par de colores 1

@example
stdscr.addstr("Pretty text", curses.color_pair(1))
stdscr.refresh()
@end example

Como dije antes, un par de colores consiste en un color de primer plano y de fondo. La función @code{init_pair (n, f, b)} cambia la definición del par de colores `n', a color de primer plano f y color de fondo b. El par de colores 0 está cableado a blanco sobre negro, y no se puede cambiar.

Los colores están numerados y @ref{2deb,,start_color()} inicializa 8 colores básicos cuando activa el modo de color. Son: 0:negro, 1:rojo, 2:verde, 3:amarillo, 4:azul, 5:magenta, 6:cian y 7:blanco. El módulo @ref{2c,,curses} define constantes con nombre para cada uno de estos colores: @ref{2eda,,curses.COLOR_BLACK}, @ref{2edf,,curses.COLOR_RED}, y así sucesivamente.

Pongamos todo esto juntos. Para cambiar el color 1 al texto rojo sobre un fondo blanco, debe llamar a:

@example
curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)
@end example

Cuando cambia un par de colores, cualquier texto que ya se muestre usando ese par de colores cambiará a los nuevos colores. También puede mostrar texto nuevo en este color con:

@example
stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))
@end example

Los terminales muy elegantes pueden cambiar las definiciones de los colores reales a un valor RGB dado. Esto le permite cambiar el color 1, que generalmente es rojo, a púrpura o azul o cualquier otro color que desee. Desafortunadamente, la consola de Linux no admite esto, por lo que no puedo probarlo y no puedo proporcionar ningún ejemplo. Puede verificar si su terminal puede hacer esto llamando a @ref{2da9,,can_change_color()}, que retorna @code{Verdadero} si la capacidad está ahí. Si tiene la suerte de tener un terminal tan talentoso, consulte las páginas de manual de su sistema para obtener más información.

@node Input del usuario,Para más información,Mostrando el texto,Programación de curses con Python
@anchor{howto/curses user-input}@anchor{4e19}
@subsection `Input' del usuario


The C curses library offers only very simple input mechanisms. Python’s
@ref{2c,,curses} module adds a basic text-input widget.  (Other libraries
such as Urwid@footnote{https://pypi.org/project/Urwid/} have more extensive collections of widgets.)

Hay dos métodos para obtener información desde una ventana:


@itemize *

@item 
@ref{2dc1,,getch()} actualiza la pantalla y luego espera a que el usuario presione una tecla, mostrando la tecla si @ref{2dba,,echo()} ha sido llamado anteriormente. Opcionalmente, puede especificar una coordenada a la que se debe mover el cursor antes de pausar.

@item 
@ref{2e18,,getkey()} hace lo mismo pero convierte el entero en una cadena. Los caracteres individuales se retornan como cadenas de 1 carácter, y las teclas especiales como las teclas de función retornan cadenas más largas que contienen un nombre de tecla como @code{KEY_UP} o @code{^ G}.
@end itemize

It’s possible to not wait for the user using the
@ref{2e2e,,nodelay()} window method. After @code{nodelay(True)},
@code{getch()} and @code{getkey()} for the window become
non-blocking. To signal that no input is ready, @code{getch()} returns
@code{curses.ERR} (a value of -1) and @code{getkey()} raises an exception.
There’s also a @ref{2dd3,,halfdelay()} function, which can be used to (in
effect) set a timer on each @code{getch()}; if no input becomes
available within a specified delay (measured in tenths of a second),
curses raises an exception.

The @code{getch()} method returns an integer; if it’s between 0 and 255, it
represents the ASCII code of the key pressed.  Values greater than 255 are
special keys such as Page Up, Home, or the cursor keys. You can compare the
value returned to constants such as @ref{2e6c,,curses.KEY_PPAGE},
@ref{2e5d,,curses.KEY_HOME}, or @ref{2e5b,,curses.KEY_LEFT}.  The main loop of
your program may look something like this:

@example
while True:
    c = stdscr.getch()
    if c == ord('p'):
        PrintDocument()
    elif c == ord('q'):
        break  # Exit the while loop
    elif c == curses.KEY_HOME:
        x = y = 0
@end example

El módulo @ref{2d,,curses.ascii} proporciona funciones de membresía de clase ASCII que toman argumentos de cadena de entero o de 1 carácter; Estos pueden ser útiles para escribir pruebas más legibles para dichos bucles. También proporciona funciones de conversión que toman argumentos enteros o de cadena de 1 carácter y retornen el mismo tipo. Por ejemplo, @ref{2f21,,curses.ascii.ctrl()} retorna el carácter de control correspondiente a su argumento.

También hay un método para recuperar una cadena completa, @ref{2e1b,,getstr()}. No se usa con mucha frecuencia, porque su funcionalidad es bastante limitada; Las únicas teclas de edición disponibles son la tecla de retroceso y la tecla Intro, que termina la cadena. Opcionalmente, puede limitarse a un número fijo de caracteres.

@example
curses.echo()            # Enable echoing of characters

# Get a 15-character string, with the cursor on the top line
s = stdscr.getstr(0,0, 15)
@end example

El módulo @ref{2f,,curses.textpad} proporciona un cuadro de texto que admite un conjunto de teclas tipo Emacs. Varios métodos de la clase @ref{2ee3,,Textbox} admiten la edición con validación de entrada y recopilan los resultados de edición con o sin espacios finales. Aquí hay un ejemplo:

@example
import curses
from curses.textpad import Textbox, rectangle

def main(stdscr):
    stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)")

    editwin = curses.newwin(5,30, 2,1)
    rectangle(stdscr, 1,0, 1+5+1, 1+30+1)
    stdscr.refresh()

    box = Textbox(editwin)

    # Let the user edit until Ctrl-G is struck.
    box.edit()

    # Get resulting contents
    message = box.gather()
@end example

Consulte la documentación de la biblioteca sobre @ref{2f,,curses.textpad} para más detalles.

@node Para más información,,Input del usuario,Programación de curses con Python
@anchor{howto/curses for-more-information}@anchor{4e1a}
@subsection Para más información


Este CÓMO no cubre algunos temas avanzados, como leer el contenido de la pantalla o capturar eventos del mouse desde una instancia de xterm, pero la página de la biblioteca de Python para el módulo @ref{2c,,curses} ahora está razonablemente completa. Deberías buscarlo posteriormente.

If you’re in doubt about the detailed behavior of the curses
functions, consult the manual pages for your curses implementation,
whether it’s ncurses or a proprietary Unix vendor’s.  The manual pages
will document any quirks, and provide complete lists of all the
functions, attributes, and @ref{2eb4,,ACS_*} characters available to
you.

Debido a que la API de curses es tan grande, algunas funciones no son compatibles con la interfaz de Python. A menudo, esto no se debe a que sean difíciles de implementar, sino a que nadie los ha necesitado todavía. Además, Python aún no admite la biblioteca de menús asociada con ncurses. Los parches que agregan soporte para estos serían bienvenidos; consulte la Guía del desarrollador de Python@footnote{https://devguide.python.org/} para obtener más información sobre cómo enviar parches a Python.


@itemize *

@item 
Escribir programas con NCURSES@footnote{https://invisible-island.net/ncurses/ncurses-intro.html}: un tutorial extenso para programadores en C.

@item 
La página web con el manual de ncurses@footnote{https://linux.die.net/man/3/ncurses}

@item 
Preguntas y respuestas frecuentes de ncurses@footnote{http://invisible-island.net/ncurses/ncurses.faq.html}

@item 
"Use curses… don’t swear"@footnote{https://www.youtube.com/watch?v=eN1eZtjLEnU}: video de una charla de PyCon 2013 sobre el control de terminales usando curses o Urwid.

@item 
"Console Applications with Urwid"@footnote{https://www.pyvideo.org/video/1568/console-applications-with-urwid}: video de una charla en PyCon CA 2012 que muestra algunas aplicaciones escritas usando Urwid.
@end itemize

@node Descriptor Guide,Debugging C API extensions and CPython Internals with GDB,Programación de curses con Python,Comos HOWTOs de Python
@anchor{howto/descriptor doc}@anchor{4e1b}@anchor{howto/descriptor descriptor-guide}@anchor{4e1c}@anchor{howto/descriptor descriptorhowto}@anchor{152c}
@section Descriptor Guide


@*Autor: 
Raymond Hettinger


@*Contacto: 
<python at rcn dot com>


Los @ref{1f70,,descriptores} permiten a objetos personalizar la búsqueda, almacenamiento y eliminación de atributos.

Esta guía tiene cuatro secciones principales:


@enumerate 

@item 
La guía introductoria da una visión general básica, moviéndose gentilmente por ejemplos simples, añadiendo una funcionalidad a la vez. Comienza acá si eres nuevo con los descriptores.

@item 
La segunda sección muestra un ejemplo completo y práctico de un descriptor. Si ya sabes lo básico comienza acá.

@item 
La tercera sección provee un tutorial más técnico que adentra en la mecánica detallada de cómo funcionan los descriptores. La mayoría de la gente no necesita este nivel de detalle.

@item 
La última sección tiene equivalentes en Python puro para descriptores incorporados que están escritos en C. Lee esta sección si tienes curiosidad de cómo las funciones se convierten en métodos vinculados, o sobre la implementación de herramientas comunes como @ref{2d2,,classmethod()}, @ref{22e,,staticmethod()}, @ref{2fd,,property()}, y @ref{680,,__slots__}.
@end enumerate

@menu
* Guía introductoria:: 
* Ejemplo completo práctico:: 
* Tutorial técnico:: 
* Equivalentes en Python puro:: 

@end menu

@node Guía introductoria,Ejemplo completo práctico,,Descriptor Guide
@anchor{howto/descriptor primer}@anchor{4e1d}
@subsection Guía introductoria


En esta guía introductoria comenzamos con el ejemplo más básico posible y luego vamos añadiendo nuevas funcionalidades una a una.

@menu
* Ejemplo simple; un descriptor que retorna una constante: Ejemplo simple un descriptor que retorna una constante. 
* Búsquedas dinámicas:: 
* Atributos gestionados:: 
* Nombres personalizados:: 
* Pensamientos finales:: 

@end menu

@node Ejemplo simple un descriptor que retorna una constante,Búsquedas dinámicas,,Guía introductoria
@anchor{howto/descriptor simple-example-a-descriptor-that-returns-a-constant}@anchor{4e1e}
@subsubsection Ejemplo simple: un descriptor que retorna una constante


La clase @code{Ten} es un descriptor cuyo método @code{__get__()} siempre retorna la constante @code{10}:

@example
class Ten:
    def __get__(self, obj, objtype=None):
        return 10
@end example

Para usar el descriptor, éste se debe almacenar como una variable de clase en otra clase:

@example
class A:
    x = 5                       # Regular class attribute
    y = Ten()                   # Descriptor instance
@end example

Una sesión interactiva muestra la diferencia entre un la búsqueda de atributo normal y la búsqueda a través del descriptor:

@example
>>> a = A()                     # Make an instance of class A
>>> a.x                         # Normal attribute lookup
5
>>> a.y                         # Descriptor lookup
10
@end example

En la búsqueda de atributo @code{a.x}, el operador punto encuentra @code{'x': 5} en el diccionario de la clase. En la búsqueda @code{a.y}, el operador punto encuentra una instancia de un descriptor, reconocible por su método @code{__get__}. Llamar a ese método retorna @code{10}.

Nota que el valor @code{10} no es almacenado ni en el diccionario de la clase ni en el diccionario de la instancia. En cambio, el valor @code{10} es calculado bajo demanda.

Este ejemplo muestra cómo funciona un descriptor simple, pero no es muy útil. Para recuperar constantes una búsqueda de atributos normal sería mejor.

En la próxima sección crearemos algo más útil, una búsqueda dinámica.

@node Búsquedas dinámicas,Atributos gestionados,Ejemplo simple un descriptor que retorna una constante,Guía introductoria
@anchor{howto/descriptor dynamic-lookups}@anchor{4e1f}
@subsubsection Búsquedas dinámicas


Descriptores interesantes típicamente ejecutan cálculos en vez de retornar constantes:

@example
import os

class DirectorySize:

    def __get__(self, obj, objtype=None):
        return len(os.listdir(obj.dirname))

class Directory:

    size = DirectorySize()              # Descriptor instance

    def __init__(self, dirname):
        self.dirname = dirname          # Regular instance attribute
@end example

Una sesión interactiva muestra que la búsqueda es dinámica — calcula respuestas diferentes y actualizadas en cada ocasión:

@example
>>> s = Directory('songs')
>>> g = Directory('games')
>>> s.size                              # The songs directory has twenty files
20
>>> g.size                              # The games directory has three files
3
>>> os.remove('games/chess')            # Delete a game
>>> g.size                              # File count is automatically updated
2
@end example

Además de mostrar cómo los descriptores puede ejecutar cálculos, este ejemplo también revela el propósitos de los parámetros de @code{__get__()}. El parámetro `self' es `size', una instancia de `DirectorySize'. El parámetro `obj' es `g' o `s', una instancia de `Directory'. Es el parámetro `obj' el que permite que al método @code{__get__()} saber el directorio objetivo. El parámetro `objtype' es una clase `Directory'.

@node Atributos gestionados,Nombres personalizados,Búsquedas dinámicas,Guía introductoria
@anchor{howto/descriptor managed-attributes}@anchor{4e20}
@subsubsection Atributos gestionados


Un uso popular de descriptores es la gestión de acceso a datos de una instancia. El descriptor se asigna a un atributo público en el diccionario de clase, mientras que los datos reales se guardan en atributos privados en el diccionario de instancia. Los métodos @code{__get__()} and @code{__set__()} del descriptor se activan cuando se accede al atributo público.

En el siguiente ejemplo, `age' es el atributo público y `_age' es el atributo privado. Cuando el atributo público es accedido, el descriptor registra la búsqueda o actualización:

@example
import logging

logging.basicConfig(level=logging.INFO)

class LoggedAgeAccess:

    def __get__(self, obj, objtype=None):
        value = obj._age
        logging.info('Accessing %r giving %r', 'age', value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', 'age', value)
        obj._age = value

class Person:

    age = LoggedAgeAccess()             # Descriptor instance

    def __init__(self, name, age):
        self.name = name                # Regular instance attribute
        self.age = age                  # Calls __set__()

    def birthday(self):
        self.age += 1                   # Calls both __get__() and __set__()
@end example

Una sesión interactiva muestra que todos los accesos al atributo gestionado `age' son registrados, pero que el atributo normal `name' no es registrado:

@c import logging, sys
@c logging.basicConfig(level=logging.INFO, stream=sys.stdout, force=True)

@example
>>> mary = Person('Mary M', 30)         # The initial age update is logged
INFO:root:Updating 'age' to 30
>>> dave = Person('David D', 40)
INFO:root:Updating 'age' to 40

>>> vars(mary)                          # The actual data is in a private attribute
@{'name': 'Mary M', '_age': 30@}
>>> vars(dave)
@{'name': 'David D', '_age': 40@}

>>> mary.age                            # Access the data and log the lookup
INFO:root:Accessing 'age' giving 30
30
>>> mary.birthday()                     # Updates are logged as well
INFO:root:Accessing 'age' giving 30
INFO:root:Updating 'age' to 31

>>> dave.name                           # Regular attribute lookup isn't logged
'David D'
>>> dave.age                            # Only the managed attribute is logged
INFO:root:Accessing 'age' giving 40
40
@end example

Un gran problema con este ejemplo es que el nombre privado `_age' está fijado en la clase `LoggedAgeAccess'. Esto significa que cada instancia puede sólo puede registrar un atributo, y que su nombre no se puede cambiar. En el siguiente ejemplo solucionaremos ese problema.

@node Nombres personalizados,Pensamientos finales,Atributos gestionados,Guía introductoria
@anchor{howto/descriptor customized-names}@anchor{4e21}
@subsubsection Nombres personalizados


Cuando una clase usa descriptores, puede informar a cada descriptor el nombre se usó para la variable.

En este ejemplo, la clase @code{Person} tiene dos instancias de descriptores, `name' y `age'. Cuando la clase @code{Person} se define, hace una retrollamada a @code{__set_name__()} en `LoggedAccess' para que se pueda registrar los nombres de los campos, dándole a cada descriptor su propio `public_name' y `private_name':

@example
import logging

logging.basicConfig(level=logging.INFO)

class LoggedAccess:

    def __set_name__(self, owner, name):
        self.public_name = name
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        value = getattr(obj, self.private_name)
        logging.info('Accessing %r giving %r', self.public_name, value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', self.public_name, value)
        setattr(obj, self.private_name, value)

class Person:

    name = LoggedAccess()                # First descriptor instance
    age = LoggedAccess()                 # Second descriptor instance

    def __init__(self, name, age):
        self.name = name                 # Calls the first descriptor
        self.age = age                   # Calls the second descriptor

    def birthday(self):
        self.age += 1
@end example

Una sesión interactiva muestra que la clase @code{Person} ha llamado a @code{__set_name__()} para que los nombres de los campos sean registrados. Aquí llamamos a @ref{1a49,,vars()} para ver el descriptor sin activarlos:

@example
>>> vars(vars(Person)['name'])
@{'public_name': 'name', 'private_name': '_name'@}
>>> vars(vars(Person)['age'])
@{'public_name': 'age', 'private_name': '_age'@}
@end example

La nueva clase ahora registrar accesos tanto a `name' como a `age':

@c import logging, sys
@c logging.basicConfig(level=logging.INFO, stream=sys.stdout, force=True)

@example
>>> pete = Person('Peter P', 10)
INFO:root:Updating 'name' to 'Peter P'
INFO:root:Updating 'age' to 10
>>> kate = Person('Catherine C', 20)
INFO:root:Updating 'name' to 'Catherine C'
INFO:root:Updating 'age' to 20
@end example

Las dos instancias de `Person' contienen sólo los nombres privados:

@example
>>> vars(pete)
@{'_name': 'Peter P', '_age': 10@}
>>> vars(kate)
@{'_name': 'Catherine C', '_age': 20@}
@end example

@node Pensamientos finales,,Nombres personalizados,Guía introductoria
@anchor{howto/descriptor closing-thoughts}@anchor{4e22}
@subsubsection Pensamientos finales


Llamamos un @ref{1f70,,descriptor} a cualquier objeto que define @code{__get__()}, @code{__set__()} o @code{__delete__()}.

Opcionalmente, los descriptores pueden tener un método @code{__set_name__()}. Éste sólo se usa en los casos en los que el descriptor necesita saber ya sea la clase donde fue creado, o el nombre de la variable de clase a la que fue asignado. (Este método, si está presente, es llamada incluso si la clase no es un descriptor.)

Los descriptores son invocados por el operador punto durante la búsqueda de atributos. Si un descriptor es accedido indirectamente con @code{vars(una_clase)[nombre_del_descriptor]}, la instancia del descriptor es retornada sin ser invocada.

Los descriptores sólo funcionan cuando se usan como variables de clase. Cuando son puestos en una instancia no tienen efecto.

La mayor motivación detrás de los descriptores es el proveer un gancho que permita a los objetos guardados en variables de clase controlar lo que ocurre al buscar un atributo.

Tradicionalmente, la clase que llama controla qué ocurre durante la búsqueda. Los descriptores invierten esta relación y permiten que los datos que están siendo buscados tengan algo qué decir al respecto.

Los descriptores se usan a través de todo el lenguaje. Es cómo funciones se convierten en métodos vinculados. Herramientas comunes como @ref{2d2,,classmethod()}, @ref{22e,,staticmethod()}, @ref{2fd,,property()}, y @ref{5e4,,functools.cached_property()} se implementan todas como descriptores.

@node Ejemplo completo práctico,Tutorial técnico,Guía introductoria,Descriptor Guide
@anchor{howto/descriptor complete-practical-example}@anchor{4e23}
@subsection Ejemplo completo práctico


En este ejemplo creamos una herramienta práctica y poderosa para encontrar errores de corrupción de datos que son notoriamente difíciles de encontrar.

@menu
* Clase validadora:: 
* Validadores personalizados:: 
* Aplicación práctica:: 

@end menu

@node Clase validadora,Validadores personalizados,,Ejemplo completo práctico
@anchor{howto/descriptor validator-class}@anchor{4e24}
@subsubsection Clase validadora


Un validador es un descriptor que da acceso a un atributo gestionado. Antes de almacenar cualquier dato, verifica que el nuevo valor cumple con varias restricciones de tipo y rango. Si esas restricciones no se cumplen, lanza una excepción para así prevenir corrupción de datos en su origen.

Esta clase @code{Validator} es una tanto una @ref{1224,,clase base abstracta} como un descriptor de un atributo gestionado:

@example
from abc import ABC, abstractmethod

class Validator(ABC):

    def __set_name__(self, owner, name):
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        return getattr(obj, self.private_name)

    def __set__(self, obj, value):
        self.validate(value)
        setattr(obj, self.private_name, value)

    @@abstractmethod
    def validate(self, value):
        pass
@end example

Validadores personalizados necesitan heredar de @code{Validator} y deben proveer un método @code{validate()} method para probar las restricciones que sean necesarias.

@node Validadores personalizados,Aplicación práctica,Clase validadora,Ejemplo completo práctico
@anchor{howto/descriptor custom-validators}@anchor{4e25}
@subsubsection Validadores personalizados


Acá hay tres utilidades de validación de datos prácticas:


@enumerate 

@item 
@code{OneOf} verifica que un valor está dentro de un grupo restringido de opciones.

@item 
@code{Number} verifica que un valor es @ref{1f0,,int} o @ref{153,,float}. Opcionalmente verifica que un valor está entre un mínimo y un máximo.

@item 
@code{String} verifica que un valor es un @ref{237,,str}. Opcionalmente valida que tenga un largo mínimo o máximo. Puede también validar un predicado@footnote{https://es.wikipedia.org/wiki/Predicado_(l%C3%B3gica)#L%C3%B3gica_matem%C3%A1tica} definido por el usuario.
@end enumerate

@example
class OneOf(Validator):

    def __init__(self, *options):
        self.options = set(options)

    def validate(self, value):
        if value not in self.options:
            raise ValueError(
                f'Expected @{value!r@} to be one of @{self.options!r@}'
            )

class Number(Validator):

    def __init__(self, minvalue=None, maxvalue=None):
        self.minvalue = minvalue
        self.maxvalue = maxvalue

    def validate(self, value):
        if not isinstance(value, (int, float)):
            raise TypeError(f'Expected @{value!r@} to be an int or float')
        if self.minvalue is not None and value < self.minvalue:
            raise ValueError(
                f'Expected @{value!r@} to be at least @{self.minvalue!r@}'
            )
        if self.maxvalue is not None and value > self.maxvalue:
            raise ValueError(
                f'Expected @{value!r@} to be no more than @{self.maxvalue!r@}'
            )

class String(Validator):

    def __init__(self, minsize=None, maxsize=None, predicate=None):
        self.minsize = minsize
        self.maxsize = maxsize
        self.predicate = predicate

    def validate(self, value):
        if not isinstance(value, str):
            raise TypeError(f'Expected @{value!r@} to be an str')
        if self.minsize is not None and len(value) < self.minsize:
            raise ValueError(
                f'Expected @{value!r@} to be no smaller than @{self.minsize!r@}'
            )
        if self.maxsize is not None and len(value) > self.maxsize:
            raise ValueError(
                f'Expected @{value!r@} to be no bigger than @{self.maxsize!r@}'
            )
        if self.predicate is not None and not self.predicate(value):
            raise ValueError(
                f'Expected @{self.predicate@} to be true for @{value!r@}'
            )
@end example

@node Aplicación práctica,,Validadores personalizados,Ejemplo completo práctico
@anchor{howto/descriptor practical-application}@anchor{4e26}
@subsubsection Aplicación práctica


Acá se muestra cómo se puede usar los validadores de datos en una clase real:

@example
class Component:

    name = String(minsize=3, maxsize=10, predicate=str.isupper)
    kind = OneOf('wood', 'metal', 'plastic')
    quantity = Number(minvalue=0)

    def __init__(self, name, kind, quantity):
        self.name = name
        self.kind = kind
        self.quantity = quantity
@end example

Los descriptores previenen que se creen instancias inválidas:

@example
>>> Component('Widget', 'metal', 5)      # Blocked: 'Widget' is not all uppercase
Traceback (most recent call last):
    ...
ValueError: Expected <method 'isupper' of 'str' objects> to be true for 'Widget'

>>> Component('WIDGET', 'metle', 5)      # Blocked: 'metle' is misspelled
Traceback (most recent call last):
    ...
ValueError: Expected 'metle' to be one of @{'metal', 'plastic', 'wood'@}

>>> Component('WIDGET', 'metal', -5)     # Blocked: -5 is negative
Traceback (most recent call last):
    ...
ValueError: Expected -5 to be at least 0

>>> Component('WIDGET', 'metal', 'V')    # Blocked: 'V' isn't a number
Traceback (most recent call last):
    ...
TypeError: Expected 'V' to be an int or float

>>> c = Component('WIDGET', 'metal', 5)  # Allowed:  The inputs are valid
@end example

@node Tutorial técnico,Equivalentes en Python puro,Ejemplo completo práctico,Descriptor Guide
@anchor{howto/descriptor technical-tutorial}@anchor{4e27}
@subsection Tutorial técnico


Lo que sigue es un tutorial más práctico sobre las mecánicas y detalles de cómo funcionan los descriptores.

@menu
* Resumen: Resumen<4>. 
* Definición e introducción:: 
* Protocolo de descriptores:: 
* Visión general de invocación de descriptores:: 
* Invocación desde una instancia:: 
* Invocación desde una clase:: 
* Invocación desde super:: 
* Resumen de la lógica de invocación:: 
* Notificación automática de nombre:: 
* Ejemplo de mapeos objeto-relacional (ORM): Ejemplo de mapeos objeto-relacional ORM. 

@end menu

@node Resumen<4>,Definición e introducción,,Tutorial técnico
@anchor{howto/descriptor abstract}@anchor{4e28}
@subsubsection Resumen


Define los descriptores, resume el protocolo, y muestra cómo los descriptores son llamados. Provee ejemplos mostrando cómo funcionan los mapeos objeto-relacional (`ORM').

Aprender acerca de los descriptores no sólo brinda acceso a un conjunto de herramientas mayor, sino que genera una comprensión más profunda de cómo funciona Python.

@node Definición e introducción,Protocolo de descriptores,Resumen<4>,Tutorial técnico
@anchor{howto/descriptor definition-and-introduction}@anchor{4e29}
@subsubsection Definición e introducción


En general, un descriptor es un valor atributo que tiene uno de los métodos del protocolo de descriptores. Estos métodos son @code{__get__()}, @code{__set__()}, y @code{__delete__()}. Si cualquiera de esos métodos se definen en un atributo, se dice que éste es un @ref{1f70,,descriptor}.

El comportamiento predeterminado para el acceso a los atributos es obtener, establecer o eliminar el atributo del diccionario de un objeto. Por ejemplo, @code{a.x} tiene una cadena de búsqueda que comienza con @code{a.__dict__['x']}, luego @code{type(a).__dict__['x']} y continúa a través del orden de resolución de métodos de @code{type(a)}. Si el valor buscado es un objeto que define uno de los métodos de descriptores, entonces Python puede anular el comportamiento predeterminado e invocar el método del descriptor en su lugar. El lugar donde esto ocurre en la cadena de precedencia depende de qué métodos de descriptores fueron definidos.

Descriptors are a powerful, general purpose protocol.  They are the mechanism
behind properties, methods, static methods, class methods, and
@ref{155,,super()}.  They are used throughout Python itself.  Descriptors
simplify the underlying C code and offer a flexible set of new tools for
everyday Python programs.

@node Protocolo de descriptores,Visión general de invocación de descriptores,Definición e introducción,Tutorial técnico
@anchor{howto/descriptor descriptor-protocol}@anchor{4e2a}
@subsubsection Protocolo de descriptores


@code{descr.__get__(self, obj, type=None)}

@code{descr.__set__(self, obj, value)}

@code{descr.__delete__(self, obj)}

Eso es todo lo que hay que hacer. Si se define cualquiera de estos métodos, el objeto se considera un descriptor y puede anular el comportamiento predeterminado al ser buscado como un atributo.

Si un objeto define @code{__set__()} o @code{__delete__()}, se considera un descriptor de datos. Los descriptores que solo definen @code{__get__()} se denominan descriptores de no-datos (normalmente se utilizan para métodos, pero son posibles otros usos).

Los descriptores de datos y de no-datos difieren en cómo se calculan las anulaciones con respecto a las entradas en el diccionario de una instancia. Si el diccionario de una instancia tiene una entrada con el mismo nombre que un descriptor de datos, el descriptor de datos tiene prioridad. Si el diccionario de una instancia tiene una entrada con el mismo nombre que un descriptor de no-datos, la entrada del diccionario tiene prioridad.

Para crear un descriptor de datos de sólo lectura, define tanto @code{__get__()} como @code{__set__()} donde @code{__set__()} lanza un @ref{441,,AttributeError} cuando es llamado. Definir el método @code{__set__()} de forma que lance una excepción genérica es suficiente para convertirlo en un descriptor de datos.

@node Visión general de invocación de descriptores,Invocación desde una instancia,Protocolo de descriptores,Tutorial técnico
@anchor{howto/descriptor overview-of-descriptor-invocation}@anchor{4e2b}
@subsubsection Visión general de invocación de descriptores


Un descriptor puede ser llamado directamente con @code{desc.__get__(obj)} o @code{desc.__get__(None, cls)}.

Pero es más común que un descriptor sea invocado automáticamente por la búsqueda de atributos.

The expression @code{obj.x} looks up the attribute @code{x} in the chain of
namespaces for @code{obj}.  If the search finds a descriptor outside of the
instance @ref{5fe,,__dict__}, its @ref{1527,,__get__()} method is
invoked according to the precedence rules listed below.

Los detalles de la invocación dependen de si @code{obj} es un objeto una clase, o una instancia de super.

@node Invocación desde una instancia,Invocación desde una clase,Visión general de invocación de descriptores,Tutorial técnico
@anchor{howto/descriptor invocation-from-an-instance}@anchor{4e2c}
@subsubsection Invocación desde una instancia


La búsqueda en instancias escanea a través de una cadena de nombres de espacio dando la más alta prioridad a descriptores de datos, seguidos por variables de instancia, luego descriptores de no-datos, luego variables de clase, y finalmente a @code{__getattr__()} si se provee.

Si se encuentra un descriptor para @code{a.x} entonces se invoca con @code{desc.__get__(a, type(a))}.

La lógica para una búsqueda con puntos se encuentra en @ref{c5a,,object.__getattribute__()}.  Acá hay un equivalente en Python puro:

@example
def find_name_in_mro(cls, name, default):
    "Emulate _PyType_Lookup() in Objects/typeobject.c"
    for base in cls.__mro__:
        if name in vars(base):
            return vars(base)[name]
    return default

def object_getattribute(obj, name):
    "Emulate PyObject_GenericGetAttr() in Objects/object.c"
    null = object()
    objtype = type(obj)
    cls_var = find_name_in_mro(objtype, name, null)
    descr_get = getattr(type(cls_var), '__get__', null)
    if descr_get is not null:
        if (hasattr(type(cls_var), '__set__')
            or hasattr(type(cls_var), '__delete__')):
            return descr_get(cls_var, obj, objtype)     # data descriptor
    if hasattr(obj, '__dict__') and name in vars(obj):
        return vars(obj)[name]                          # instance variable
    if descr_get is not null:
        return descr_get(cls_var, obj, objtype)         # non-data descriptor
    if cls_var is not null:
        return cls_var                                  # class variable
    raise AttributeError(name)
@end example

@c # Test the fidelity of object_getattribute() by comparing it with the
@c # normal object.__getattribute__().  The former will be accessed by
@c # square brackets and the latter by the dot operator.
@c 
@c class Object:
@c 
@c     def __getitem__(obj, name):
@c         try:
@c             return object_getattribute(obj, name)
@c         except AttributeError:
@c             if not hasattr(type(obj), '__getattr__'):
@c                 raise
@c         return type(obj).__getattr__(obj, name)             # __getattr__
@c 
@c class DualOperator(Object):
@c 
@c     x = 10
@c 
@c     def __init__(self, z):
@c         self.z = z
@c 
@c     @property
@c     def p2(self):
@c         return 2 * self.x
@c 
@c     @property
@c     def p3(self):
@c         return 3 * self.x
@c 
@c     def m5(self, y):
@c         return 5 * y
@c 
@c     def m7(self, y):
@c         return 7 * y
@c 
@c     def __getattr__(self, name):
@c         return ('getattr_hook', self, name)
@c 
@c class DualOperatorWithSlots:
@c 
@c     __getitem__ = Object.__getitem__
@c 
@c     __slots__ = ['z']
@c 
@c     x = 15
@c 
@c     def __init__(self, z):
@c         self.z = z
@c 
@c     @property
@c     def p2(self):
@c         return 2 * self.x
@c 
@c     def m5(self, y):
@c         return 5 * y
@c 
@c     def __getattr__(self, name):
@c         return ('getattr_hook', self, name)
@c 
@c class D1:
@c     def __get__(self, obj, objtype=None):
@c         return type(self), obj, objtype
@c 
@c class U1:
@c     x = D1()
@c 
@c class U2(U1):
@c     pass

@c >>> a = DualOperator(11)
@c >>> vars(a).update(p3 = '_p3', m7 = '_m7')
@c >>> a.x == a['x'] == 10
@c True
@c >>> a.z == a['z'] == 11
@c True
@c >>> a.p2 == a['p2'] == 20
@c True
@c >>> a.p3 == a['p3'] == 30
@c True
@c >>> a.m5(100) == a.m5(100) == 500
@c True
@c >>> a.m7 == a['m7'] == '_m7'
@c True
@c >>> a.g == a['g'] == ('getattr_hook', a, 'g')
@c True
@c 
@c >>> b = DualOperatorWithSlots(22)
@c >>> b.x == b['x'] == 15
@c True
@c >>> b.z == b['z'] == 22
@c True
@c >>> b.p2 == b['p2'] == 30
@c True
@c >>> b.m5(200) == b['m5'](200) == 1000
@c True
@c >>> b.g == b['g'] == ('getattr_hook', b, 'g')
@c True
@c 
@c >>> u2 = U2()
@c >>> object_getattribute(u2, 'x') == u2.x == (D1, u2, U2)
@c True

Nota, no hay un gancho @code{__getattr__()} en el código de @code{__getattribute__()} . Es por eso que llamar a @code{__getattribute__()} directamente o con @code{super().__getattribute__} evitará completamente a @code{__getattr__()}.

En cambio, es el operador punto y la función @ref{c59,,getattr()} los que son responsables de invocar @code{__getattr__()} cada vez que @code{__getattribute__()} lanza un @ref{441,,AttributeError}. Su lógica está encapsulada en una función auxiliar:

@example
def getattr_hook(obj, name):
    "Emulate slot_tp_getattr_hook() in Objects/typeobject.c"
    try:
        return obj.__getattribute__(name)
    except AttributeError:
        if not hasattr(type(obj), '__getattr__'):
            raise
    return type(obj).__getattr__(obj, name)             # __getattr__
@end example

@c >>> class ClassWithGetAttr:
@c ...     x = 123
@c ...     def __getattr__(self, attr):
@c ...         return attr.upper()
@c ...
@c >>> cw = ClassWithGetAttr()
@c >>> cw.y = 456
@c >>> getattr_hook(cw, 'x')
@c 123
@c >>> getattr_hook(cw, 'y')
@c 456
@c >>> getattr_hook(cw, 'z')
@c 'Z'
@c 
@c >>> class ClassWithoutGetAttr:
@c ...     x = 123
@c ...
@c >>> cwo = ClassWithoutGetAttr()
@c >>> cwo.y = 456
@c >>> getattr_hook(cwo, 'x')
@c 123
@c >>> getattr_hook(cwo, 'y')
@c 456
@c >>> getattr_hook(cwo, 'z')
@c Traceback (most recent call last):
@c     ...
@c AttributeError: 'ClassWithoutGetAttr' object has no attribute 'z'

@node Invocación desde una clase,Invocación desde super,Invocación desde una instancia,Tutorial técnico
@anchor{howto/descriptor invocation-from-a-class}@anchor{4e2d}
@subsubsection Invocación desde una clase


La lógica para una búsqueda con puntos tal como @code{A.x} se encuentra en @code{type.__getattribute__()}. Los pasos son similares a los de @ref{c5a,,object.__getattribute__()}, pero la búsqueda en el diccionario de instancia se reemplaza por una búsqueda a través del @ref{2188,,orden de resolución de métodos} de la clase.

Si se encuentra un descriptor, se invoca con @code{desc.__get__(None, A)}.

The full C implementation can be found in @code{type_getattro()} and
@code{_PyType_Lookup()} in Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/main/Objects/typeobject.c}.

@node Invocación desde super,Resumen de la lógica de invocación,Invocación desde una clase,Tutorial técnico
@anchor{howto/descriptor invocation-from-super}@anchor{4e2e}
@subsubsection Invocación desde super


The logic for super’s dotted lookup is in the @code{__getattribute__()} method for
object returned by @ref{155,,super()}.

Una búsqueda con puntos tal como @code{super(A, obj).m} busca @code{obj.__class__.__mro__} para la clase base @code{B} que sigue inmediatamente a @code{A} y luego retorna @code{B.__dict__['m'].__get__(obj, A)}. Si no es un descriptor, @code{m} se retorna sin cambiar.

The full C implementation can be found in @code{super_getattro()} in
Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/main/Objects/typeobject.c}.  A pure Python equivalent can be found in
Guido's Tutorial@footnote{https://www.python.org/download/releases/2.2.3/descrintro/#cooperation}.

@node Resumen de la lógica de invocación,Notificación automática de nombre,Invocación desde super,Tutorial técnico
@anchor{howto/descriptor summary-of-invocation-logic}@anchor{4e2f}
@subsubsection Resumen de la lógica de invocación


The mechanism for descriptors is embedded in the @code{__getattribute__()}
methods for @ref{b18,,object}, @ref{dcf,,type}, and @ref{155,,super()}.

Los puntos importantes a recordar son:


@itemize *

@item 
Los descriptores son invocados por el método @code{__getattribute__()}.

@item 
Las clases heredan esta maquinaria desde @ref{b18,,object}, @ref{dcf,,type}, o @ref{155,,super()}.

@item 
Redefinir @code{__getattribute__()} previene las llamadas automáticas a descriptores porque toda la lógica de descriptores está en ese método.

@item 
@ref{c5a,,object.__getattribute__()} y @code{type.__getattribute__()} realizan diferentes llamadas a @code{__get__()}. El primero incluye la instancia y puede incluir la clase. El segundo establece @code{None} como instancia, y siempre incluye la clase.

@item 
Los descriptores de datos siempre anulan los diccionarios de instancia.

@item 
Los descriptores de no-datos pueden ser reemplazados por los diccionarios de instancia.
@end itemize

@node Notificación automática de nombre,Ejemplo de mapeos objeto-relacional ORM,Resumen de la lógica de invocación,Tutorial técnico
@anchor{howto/descriptor automatic-name-notification}@anchor{4e30}
@subsubsection Notificación automática de nombre


A veces es deseable que un descriptor sepa qué nombre fue asignado a una variable de clase. Cuando una nueva clase es creada, la metaclase @ref{dcf,,type} escanea el diccionario de la nueva clase. Si alguna de las entradas es un descriptor, y si define @code{__set_name__()}, ese método se llama con dos argumentos. El argumento `owner' es la clase donde se usa el descriptor, y `name' es la variable de clase a la cual el descriptor se asigna.

The implementation details are in @code{type_new()} and
@code{set_names()} in Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/main/Objects/typeobject.c}.

Dado que la lógica de actualización está en @code{type.__new__()}, las notificaciones ocurren sólo al momento de crear la clase. Si se añade descriptores a la clase más tarde, @code{__set_name__()} tendrá que ser llamado manualmente.

@node Ejemplo de mapeos objeto-relacional ORM,,Notificación automática de nombre,Tutorial técnico
@anchor{howto/descriptor orm-example}@anchor{4e31}
@subsubsection Ejemplo de mapeos objeto-relacional (`ORM')


El siguiente código es un esqueleto simplificado que muestra cómo descriptores de datos pueden ser usados para implementar un mapeo objeto-relacional@footnote{https://es.wikipedia.org/wiki/Asignaci%C3%B3n_objeto-relacional}.

La idea esencial es que los datos se almacenan en una base de datos externa. Las instancias de Python sólo mantienen llaves a las tablas de la base de datos. Los descriptores se hacen cargo de las búsquedas o actualizaciones:

@example
class Field:

    def __set_name__(self, owner, name):
        self.fetch = f'SELECT @{name@} FROM @{owner.table@} WHERE @{owner.key@}=?;'
        self.store = f'UPDATE @{owner.table@} SET @{name@}=? WHERE @{owner.key@}=?;'

    def __get__(self, obj, objtype=None):
        return conn.execute(self.fetch, [obj.key]).fetchone()[0]

    def __set__(self, obj, value):
        conn.execute(self.store, [value, obj.key])
        conn.commit()
@end example

Podemos usar la clase @code{Field} para definir modelos@footnote{https://es.wikipedia.org/wiki/Modelo_de_base_de_datos} que describen el esquema para cada tabla en la base de datos:

@example
class Movie:
    table = 'Movies'                    # Table name
    key = 'title'                       # Primary key
    director = Field()
    year = Field()

    def __init__(self, key):
        self.key = key

class Song:
    table = 'Music'
    key = 'title'
    artist = Field()
    year = Field()
    genre = Field()

    def __init__(self, key):
        self.key = key
@end example

Para usar los modelos, primera conéctate a la base de datos:

@example
>>> import sqlite3
>>> conn = sqlite3.connect('entertainment.db')
@end example

Una sesión interactiva muestra cómo los datos son obtenidos desde la base de datos y cómo se pueden actualizar:

@c song_data = [
@c     ('Country Roads', 'John Denver', 1972),
@c     ('Me and Bobby McGee', 'Janice Joplin', 1971),
@c     ('Coal Miners Daughter', 'Loretta Lynn', 1970),
@c ]
@c 
@c movie_data = [
@c     ('Star Wars', 'George Lucas', 1977),
@c     ('Jaws', 'Steven Spielberg', 1975),
@c     ('Aliens', 'James Cameron', 1986),
@c ]
@c 
@c import sqlite3
@c 
@c conn = sqlite3.connect(':memory:')
@c conn.execute('CREATE TABLE Music (title text, artist text, year integer);')
@c conn.execute('CREATE INDEX MusicNdx ON Music (title);')
@c conn.executemany('INSERT INTO Music VALUES (?, ?, ?);', song_data)
@c conn.execute('CREATE TABLE Movies (title text, director text, year integer);')
@c conn.execute('CREATE INDEX MovieNdx ON Music (title);')
@c conn.executemany('INSERT INTO Movies VALUES (?, ?, ?);', movie_data)
@c conn.commit()

@example
>>> Movie('Star Wars').director
'George Lucas'
>>> jaws = Movie('Jaws')
>>> f'Released in @{jaws.year@} by @{jaws.director@}'
'Released in 1975 by Steven Spielberg'

>>> Song('Country Roads').artist
'John Denver'

>>> Movie('Star Wars').director = 'J.J. Abrams'
>>> Movie('Star Wars').director
'J.J. Abrams'
@end example

@c conn.close()

@node Equivalentes en Python puro,,Tutorial técnico,Descriptor Guide
@anchor{howto/descriptor pure-python-equivalents}@anchor{4e32}
@subsection Equivalentes en Python puro


El protocolo de descriptores es simple y ofrece posibilidades estimulantes. Varios casos de uso son tan comunes que han sido pre-empaquetados en herramientas incorporadas. Propiedades, métodos vinculados, métodos estáticos, métodos de clase y __slots__ están todos basados en el protocolo de descriptores.

@menu
* Propiedades:: 
* Funciones y métodos:: 
* Tipos de métodos:: 
* Métodos estáticos:: 
* Métodos de clase:: 
* Objetos miembros y __slots__:: 

@end menu

@node Propiedades,Funciones y métodos,,Equivalentes en Python puro
@anchor{howto/descriptor properties}@anchor{4e33}
@subsubsection Propiedades


Llamar a @ref{2fd,,property()} es una forma sucinta de construir un descriptor de datos que desencadena llamadas a funciones al acceder a un atributo. Su firma es:

@example
property(fget=None, fset=None, fdel=None, doc=None) -> property
@end example

La documentación muestra un uso típico para definir un atributo gestionado @code{x}:

@example
class C:
    def getx(self): return self.__x
    def setx(self, value): self.__x = value
    def delx(self): del self.__x
    x = property(getx, setx, delx, "I'm the 'x' property.")
@end example

@c >>> C.x.__doc__
@c "I'm the 'x' property."
@c >>> c.x = 2.71828
@c >>> c.x
@c 2.71828
@c >>> del c.x
@c >>> c.x
@c Traceback (most recent call last):
@c   ...
@c AttributeError: 'C' object has no attribute '_C__x'

To see how @ref{2fd,,property()} is implemented in terms of the descriptor protocol,
here is a pure Python equivalent that implements most of the core functionality:

@example
class Property:
    "Emulate PyProperty_Type() in Objects/descrobject.c"

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        if doc is None and fget is not None:
            doc = fget.__doc__
        self.__doc__ = doc

    def __set_name__(self, owner, name):
        self.__name__ = name

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError
        self.fdel(obj)

    def getter(self, fget):
        return type(self)(fget, self.fset, self.fdel, self.__doc__)

    def setter(self, fset):
        return type(self)(self.fget, fset, self.fdel, self.__doc__)

    def deleter(self, fdel):
        return type(self)(self.fget, self.fset, fdel, self.__doc__)
@end example

@c # Verify the Property() emulation
@c 
@c class CC:
@c     def getx(self):
@c         return self.__x
@c     def setx(self, value):
@c         self.__x = value
@c     def delx(self):
@c         del self.__x
@c     x = Property(getx, setx, delx, "I'm the 'x' property.")
@c     no_getter = Property(None, setx, delx, "I'm the 'x' property.")
@c     no_setter = Property(getx, None, delx, "I'm the 'x' property.")
@c     no_deleter = Property(getx, setx, None, "I'm the 'x' property.")
@c     no_doc = Property(getx, setx, delx, None)
@c 
@c 
@c # Now do it again but use the decorator style
@c 
@c class CCC:
@c     @Property
@c     def x(self):
@c         return self.__x
@c     @x.setter
@c     def x(self, value):
@c         self.__x = value
@c     @x.deleter
@c     def x(self):
@c         del self.__x

@c >>> cc = CC()
@c >>> hasattr(cc, 'x')
@c False
@c >>> cc.x = 33
@c >>> cc.x
@c 33
@c >>> del cc.x
@c >>> hasattr(cc, 'x')
@c False
@c 
@c >>> ccc = CCC()
@c >>> hasattr(ccc, 'x')
@c False
@c >>> ccc.x = 333
@c >>> ccc.x == 333
@c True
@c >>> del ccc.x
@c >>> hasattr(ccc, 'x')
@c False
@c 
@c >>> cc = CC()
@c >>> cc.x = 33
@c >>> try:
@c ...     cc.no_getter
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> try:
@c ...     cc.no_setter = 33
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> try:
@c ...     del cc.no_deleter
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> CC.no_doc.__doc__ is None
@c True

La función incorporada @ref{2fd,,property()} es de ayuda cuando una interfaz de usuario ha otorgado acceso a atributos y luego los cambios posteriores requieren la intervención de un método.

Por ejemplo, una clase de hoja de cálculo puede otorgar acceso al valor de una celda a través de @code{Cell('b10').value}. Las mejoras posteriores del programa requieren que la celda se vuelva a calcular en cada acceso; sin embargo, la programadora no quiere afectar al código de cliente existente que accede al atributo directamente. La solución es envolver el acceso al valor del atributo en un descriptor de datos propiedad:

@example
class Cell:
    ...

    @@property
    def value(self):
        "Recalculate the cell before returning value"
        self.recalc()
        return self._value
@end example

Tanto la función incorporada @ref{2fd,,property()} como nuestra equivalente @code{Property()} funcionarían en este ejemplo.

@node Funciones y métodos,Tipos de métodos,Propiedades,Equivalentes en Python puro
@anchor{howto/descriptor functions-and-methods}@anchor{4e34}
@subsubsection Funciones y métodos


Las características orientadas a objetos de Python se basan en un entorno basado en funciones. Usando descriptores de no-datos, ambas se combinan perfectamente.

Las funciones almacenadas en diccionarios de clase son convertidas en métodos cuando son invocadas. Los métodos sólo difieren de funciones regulares en que la instancia del objeto es antepuesta a los otros argumentos. Por convención, la instancia se llama `self', pero podría ser llamada `this' o cualquier otro nombre de variable.

Los métodos se pueden crear manualmente con @ref{1800,,types.MethodType}, lo que es aproximadamente equivalente a:

@example
class MethodType:
    "Emulate PyMethod_Type in Objects/classobject.c"

    def __init__(self, func, obj):
        self.__func__ = func
        self.__self__ = obj

    def __call__(self, *args, **kwargs):
        func = self.__func__
        obj = self.__self__
        return func(obj, *args, **kwargs)

    def __getattribute__(self, name):
        "Emulate method_getset() in Objects/classobject.c"
        if name == '__doc__':
            return self.__func__.__doc__
        return object.__getattribute__(self, name)

    def __getattr__(self, name):
        "Emulate method_getattro() in Objects/classobject.c"
        return getattr(self.__func__, name)

    def __get__(self, obj, objtype=None):
        "Emulate method_descr_get() in Objects/classobject.c"
        return self
@end example

Para soportar la creación automática de métodos, las funciones incluyen un método @code{__get__()} para vincular métodos durante el acceso a atributos. Esto significa que las funciones son descriptores de no-datos que retornan métodos vinculados durante la búsqueda con puntos desde una instancia. Así es como funciona:

@example
class Function:
    ...

    def __get__(self, obj, objtype=None):
        "Simulate func_descr_get() in Objects/funcobject.c"
        if obj is None:
            return self
        return MethodType(self, obj)
@end example

Ejecutar la siguiente clase en el intérprete muestra cómo funciona el descriptor de función en la práctica:

@example
class D:
    def f(self):
         return self

class D2:
    pass
@end example

@c >>> d = D()
@c >>> d2 = D2()
@c >>> d2.f = d.f.__get__(d2, D2)
@c >>> d2.f() is d
@c True

La función tiene un atributo de @ref{194a,,nombre calificado} para soportar introspección:

@example
>>> D.f.__qualname__
'D.f'
@end example

Accediendo a la función a través del diccionario de clase no invoca @code{__get__()}. En cambio, retorna el objeto función subyacente:

@example
>>> D.__dict__['f']
<function D.f at 0x00C45070>
@end example

Acceso con puntos desde una clase llama a @code{__get__()}, lo cual sólo retorna la función subyacente sin cambiar:

@example
>>> D.f
<function D.f at 0x00C45070>
@end example

El comportamiento interesante ocurre durante el accesos con puntos desde una instancia. Las búsquedas con punto llaman a @code{__get__()}, el cual retorna un objeto de método vinculado:

@example
>>> d = D()
>>> d.f
<bound method D.f of <__main__.D object at 0x00B18C90>>
@end example

Internamente, el método vinculado guarda la función subyacente y la instancia vinculada:

@example
>>> d.f.__func__
<function D.f at 0x00C45070>

>>> d.f.__self__
<__main__.D object at 0x00B18C90>
@end example

Si alguna vez te preguntaste de dónde viene `self' en métodos regulares, o de dónde viene `cls' en métodos de clase, ¡es acá!

@node Tipos de métodos,Métodos estáticos,Funciones y métodos,Equivalentes en Python puro
@anchor{howto/descriptor kinds-of-methods}@anchor{4e35}
@subsubsection Tipos de métodos


Los descriptores de no-datos proporcionan un mecanismo simple para variaciones de los patrones habituales para vincular funciones en métodos.

Para recapitular, las funciones tienen un método @code{__get__()} para que se puedan convertir en un método cuando se accede a ellas como atributos. El descriptor de no-datos transforma una llamada a @code{obj.f(*args)} en @code{f(obj, *args)}. Llamar a @code{cls.f(*args)} se convierte en @code{f(*args)}.

Este cuadro resume el enlace (`binding') y sus dos variantes más útiles:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

Transformación

@tab

Llamado desde un objeto

@tab

Llamado desde una clase

@item

función

@tab

f(obj, *args)

@tab

f(*args)

@item

método estático

@tab

f(*args)

@tab

f(*args)

@item

método de clase

@tab

f(type(obj), *args)

@tab

f(cls, *args)

@end multitable

@end quotation

@node Métodos estáticos,Métodos de clase,Tipos de métodos,Equivalentes en Python puro
@anchor{howto/descriptor static-methods}@anchor{4e36}
@subsubsection Métodos estáticos


Los métodos estáticos retornan la función subyacente sin cambios. Llamar a @code{c.f} o @code{C.f} es equivalente a una búsqueda directa en @code{object.__getattribute__(c, "f")} o en @code{object.__getattribute__(C, "f")}. Como resultado, la función se vuelve idénticamente accesible desde un objeto o una clase.

Buenos candidatos para ser métodos estáticos son los métodos que no hacen referencia a la variable @code{self}.

For instance, a statistics package may include a container class for
experimental data.  The class provides normal methods for computing the average,
mean, median, and other descriptive statistics that depend on the data. However,
there may be useful functions which are conceptually related but do not depend
on the data.  For instance, @code{erf(x)} is handy conversion routine that comes up
in statistical work but does not directly depend on a particular dataset.
It can be called either from an object or the class:  @code{s.erf(1.5) --> 0.9332}
or @code{Sample.erf(1.5) --> 0.9332}.

Dado que los métodos estáticos retornan la función subyacente sin cambios, las llamadas de ejemplo carecen de interés:

@example
class E:
    @@staticmethod
    def f(x):
        return x * 10
@end example

@example
>>> E.f(3)
30
>>> E().f(3)
30
@end example

Usando el protocolo de descriptores de no-datos, una versión pura de Python de @ref{22e,,staticmethod()} se vería así:

@example
import functools

class StaticMethod:
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, objtype=None):
        return self.f

    def __call__(self, *args, **kwds):
        return self.f(*args, **kwds)

    @@property
    def __annotations__(self):
        return self.f.__annotations__
@end example

The @ref{109e,,functools.update_wrapper()} call adds a @code{__wrapped__} attribute
that refers to the underlying function.  Also it carries forward
the attributes necessary to make the wrapper look like the wrapped
function, including @ref{133c,,__name__}, @ref{1efa,,__qualname__},
and @ref{1246,,__doc__}.

@c class E_sim:
@c     @StaticMethod
@c     def f(x: int) -> str:
@c         "Simple function example"
@c         return "!" * x
@c 
@c wrapped_ord = StaticMethod(ord)

@c >>> E_sim.f(3)
@c '!!!'
@c >>> E_sim().f(3)
@c '!!!'
@c 
@c >>> sm = vars(E_sim)['f']
@c >>> type(sm).__name__
@c 'StaticMethod'
@c >>> f = E_sim.f
@c >>> type(f).__name__
@c 'function'
@c >>> sm.__name__
@c 'f'
@c >>> f.__name__
@c 'f'
@c >>> sm.__qualname__
@c 'E_sim.f'
@c >>> f.__qualname__
@c 'E_sim.f'
@c >>> sm.__doc__
@c 'Simple function example'
@c >>> f.__doc__
@c 'Simple function example'
@c >>> sm.__annotations__
@c {'x': <class 'int'>, 'return': <class 'str'>}
@c >>> f.__annotations__
@c {'x': <class 'int'>, 'return': <class 'str'>}
@c >>> sm.__module__ == f.__module__
@c True
@c >>> sm(3)
@c '!!!'
@c >>> f(3)
@c '!!!'
@c 
@c >>> wrapped_ord('A')
@c 65
@c >>> wrapped_ord.__module__ == ord.__module__
@c True
@c >>> wrapped_ord.__wrapped__ == ord
@c True
@c >>> wrapped_ord.__name__ == ord.__name__
@c True
@c >>> wrapped_ord.__qualname__ == ord.__qualname__
@c True
@c >>> wrapped_ord.__doc__ == ord.__doc__
@c True

@node Métodos de clase,Objetos miembros y __slots__,Métodos estáticos,Equivalentes en Python puro
@anchor{howto/descriptor class-methods}@anchor{4e37}
@subsubsection Métodos de clase


A diferencia de los métodos estáticos, los métodos de clase anteponen la referencia de clase a la lista de argumentos antes de llamar a la función. Este formato es el mismo si quien llama es un objeto o una clase:

@example
class F:
    @@classmethod
    def f(cls, x):
        return cls.__name__, x
@end example

@example
>>> F.f(3)
('F', 3)
>>> F().f(3)
('F', 3)
@end example

Este comportamiento es útil siempre que la función solo necesite tener una referencia de clase y no necesita contar con los datos almacenados en una instancia específica. Un uso de los métodos de clase es crear constructores de clase alternativos. Por ejemplo, el método de clase @ref{18f,,dict.fromkeys()} crea un nuevo diccionario a partir de una lista de claves. El equivalente puro de Python es:

@example
class Dict(dict):
    @@classmethod
    def fromkeys(cls, iterable, value=None):
        "Emulate dict_fromkeys() in Objects/dictobject.c"
        d = cls()
        for key in iterable:
            d[key] = value
        return d
@end example

Ahora se puede construir un nuevo diccionario de claves únicas así:

@example
>>> d = Dict.fromkeys('abracadabra')
>>> type(d) is Dict
True
>>> d
@{'a': None, 'b': None, 'r': None, 'c': None, 'd': None@}
@end example

Usando el protocolo de descriptores de no-datos, una implementación pura en Python de @ref{2d2,,classmethod()} se vería así:

@example
import functools

class ClassMethod:
    "Emulate PyClassMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, cls=None):
        if cls is None:
            cls = type(obj)
        return MethodType(self.f, cls)
@end example

@c # Verify the emulation works
@c class T:
@c     @ClassMethod
@c     def cm(cls, x: int, y: str) -> tuple[str, int, str]:
@c         "Class method that returns a tuple"
@c         return (cls.__name__, x, y)

@c >>> T.cm(11, 22)
@c ('T', 11, 22)
@c 
@c # Also call it from an instance
@c >>> t = T()
@c >>> t.cm(11, 22)
@c ('T', 11, 22)
@c 
@c # Verify that T uses our emulation
@c >>> type(vars(T)['cm']).__name__
@c 'ClassMethod'
@c 
@c # Verify that update_wrapper() correctly copied attributes
@c >>> T.cm.__name__
@c 'cm'
@c >>> T.cm.__qualname__
@c 'T.cm'
@c >>> T.cm.__doc__
@c 'Class method that returns a tuple'
@c >>> T.cm.__annotations__
@c {'x': <class 'int'>, 'y': <class 'str'>, 'return': tuple[str, int, str]}
@c 
@c # Verify that __wrapped__ was added and works correctly
@c >>> f = vars(T)['cm'].__wrapped__
@c >>> type(f).__name__
@c 'function'
@c >>> f.__name__
@c 'cm'
@c >>> f(T, 11, 22)
@c ('T', 11, 22)

The @ref{109e,,functools.update_wrapper()} call in @code{ClassMethod} adds a
@code{__wrapped__} attribute that refers to the underlying function.  Also
it carries forward the attributes necessary to make the wrapper look
like the wrapped function: @ref{133c,,__name__},
@ref{1efa,,__qualname__}, @ref{1246,,__doc__},
and @ref{1245,,__annotations__}.

@node Objetos miembros y __slots__,,Métodos de clase,Equivalentes en Python puro
@anchor{howto/descriptor member-objects-and-slots}@anchor{4e38}
@subsubsection Objetos miembros y __slots__


Cuando una clase define @code{__slots__}, reemplaza los diccionarios de instancia por un arreglo de valores de ranura de largo fijo. Desde el punto de vista del usuario esto tiene varios efectos:

1. Provides immediate detection of bugs due to misspelled attribute
assignments.  Only attribute names specified in @code{__slots__} are allowed:

@example
class Vehicle:
    __slots__ = ('id_number', 'make', 'model')
@end example

@example
>>> auto = Vehicle()
>>> auto.id_nubmer = 'VYE483814LQEX'
Traceback (most recent call last):
    ...
AttributeError: 'Vehicle' object has no attribute 'id_nubmer'
@end example

2. Helps create immutable objects where descriptors manage access to private
attributes stored in @code{__slots__}:

@example
class Immutable:

    __slots__ = ('_dept', '_name')          # Replace the instance dictionary

    def __init__(self, dept, name):
        self._dept = dept                   # Store to private attribute
        self._name = name                   # Store to private attribute

    @@property                               # Read-only descriptor
    def dept(self):
        return self._dept

    @@property
    def name(self):                         # Read-only descriptor
        return self._name
@end example

@example
>>> mark = Immutable('Botany', 'Mark Watney')
>>> mark.dept
'Botany'
>>> mark.dept = 'Space Pirate'
Traceback (most recent call last):
    ...
AttributeError: property 'dept' of 'Immutable' object has no setter
>>> mark.location = 'Mars'
Traceback (most recent call last):
    ...
AttributeError: 'Immutable' object has no attribute 'location'
@end example

3. Saves memory.  On a 64-bit Linux build, an instance with two attributes
takes 48 bytes with @code{__slots__} and 152 bytes without.  This flyweight design pattern@footnote{https://en.wikipedia.org/wiki/Flyweight_pattern} likely only
matters when a large number of instances are going to be created.

4. Improves speed.  Reading instance variables is 35% faster with
@code{__slots__} (as measured with Python 3.10 on an Apple M1 processor).

5. Blocks tools like @ref{5e4,,functools.cached_property()} which require an
instance dictionary to function correctly:

@example
from functools import cached_property

class CP:
    __slots__ = ()                          # Eliminates the instance dict

    @@cached_property                        # Requires an instance dict
    def pi(self):
        return 4 * sum((-1.0)**n / (2.0*n + 1.0)
                       for n in reversed(range(100_000)))
@end example

@example
>>> CP().pi
Traceback (most recent call last):
  ...
TypeError: No '__dict__' attribute on 'CP' instance to cache 'pi' property.
@end example

No es posible crear una versión exacta de @code{__slots__} en Python puro porque requiere acceso directo a estructuras en C y control sobre asignación de memoria de objetos. Sin embargo podemos construir una simulación casi totalmente fiel donde la estructura real en C para las ranuras es emulada con una lista privada @code{_slotvalues}. Las lecturas y escrituras de esta estructura privada se manejan con descriptores miembros:

@example
null = object()

class Member:

    def __init__(self, name, clsname, offset):
        'Emulate PyMemberDef in Include/structmember.h'
        # Also see descr_new() in Objects/descrobject.c
        self.name = name
        self.clsname = clsname
        self.offset = offset

    def __get__(self, obj, objtype=None):
        'Emulate member_get() in Objects/descrobject.c'
        # Also see PyMember_GetOne() in Python/structmember.c
        if obj is None:
            return self
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        return value

    def __set__(self, obj, value):
        'Emulate member_set() in Objects/descrobject.c'
        obj._slotvalues[self.offset] = value

    def __delete__(self, obj):
        'Emulate member_delete() in Objects/descrobject.c'
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        obj._slotvalues[self.offset] = null

    def __repr__(self):
        'Emulate member_repr() in Objects/descrobject.c'
        return f'<Member @{self.name!r@} of @{self.clsname!r@}>'
@end example

El método @code{type.__new__()} se hace cargo de añadir objetos miembros a variables de clase:

@example
class Type(type):
    'Simulate how the type metaclass adds member objects for slots'

    def __new__(mcls, clsname, bases, mapping, **kwargs):
        'Emulate type_new() in Objects/typeobject.c'
        # type_new() calls PyTypeReady() which calls add_methods()
        slot_names = mapping.get('slot_names', [])
        for offset, name in enumerate(slot_names):
            mapping[name] = Member(name, clsname, offset)
        return type.__new__(mcls, clsname, bases, mapping, **kwargs)
@end example

El método @ref{624,,object.__new__()} se hace cargo de crear instancias que tienen ranuras en vez un diccionario de instancia. Acá hay una simulación aproximada en Python puro:

@example
class Object:
    'Simulate how object.__new__() allocates memory for __slots__'

    def __new__(cls, *args, **kwargs):
        'Emulate object_new() in Objects/typeobject.c'
        inst = super().__new__(cls)
        if hasattr(cls, 'slot_names'):
            empty_slots = [null] * len(cls.slot_names)
            object.__setattr__(inst, '_slotvalues', empty_slots)
        return inst

    def __setattr__(self, name, value):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'@{cls.__name__!r@} object has no attribute @{name!r@}'
            )
        super().__setattr__(name, value)

    def __delattr__(self, name):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'@{cls.__name__!r@} object has no attribute @{name!r@}'
            )
        super().__delattr__(name)
@end example

Para usar la simulación en una clase real, sólo hereda de @code{Object} y establece @ref{1f86,,metaclass} a @code{Type}:

@example
class H(Object, metaclass=Type):
    'Instance variables stored in slots'

    slot_names = ['x', 'y']

    def __init__(self, x, y):
        self.x = x
        self.y = y
@end example

En este punto, la metaclase ha cargado los objetos miembros para `x' e `y':

@example
>>> from pprint import pp
>>> pp(dict(vars(H)))
@{'__module__': '__main__',
 '__doc__': 'Instance variables stored in slots',
 'slot_names': ['x', 'y'],
 '__init__': <function H.__init__ at 0x7fb5d302f9d0>,
 'x': <Member 'x' of 'H'>,
 'y': <Member 'y' of 'H'>@}
@end example

@c # We test this separately because the preceding section is not
@c # doctestable due to the hex memory address for the __init__ function
@c >>> isinstance(vars(H)['x'], Member)
@c True
@c >>> isinstance(vars(H)['y'], Member)
@c True

Cuando se crean instancias, éstas tienen una lista @code{slot_values} donde se almacenan los atributos:

@example
>>> h = H(10, 20)
>>> vars(h)
@{'_slotvalues': [10, 20]@}
>>> h.x = 55
>>> vars(h)
@{'_slotvalues': [55, 20]@}
@end example

Atributos mal deletreados o no asignados lazarán una excepción:

@example
>>> h.xz
Traceback (most recent call last):
    ...
AttributeError: 'H' object has no attribute 'xz'
@end example

@c  # Examples for deleted attributes are not shown because this section
@c  # is already a bit lengthy.  We still test that code here.
@c  >>> del h.x
@c  >>> hasattr(h, 'x')
@c  False
@c 
@c  # Also test the code for uninitialized slots
@c  >>> class HU(Object, metaclass=Type):
@c  ...     slot_names = ['x', 'y']
@c  ...
@c  >>> hu = HU()
@c  >>> hasattr(hu, 'x')
@c  False
@c  >>> hasattr(hu, 'y')
@c  False

@node Debugging C API extensions and CPython Internals with GDB,HOWTO - Enum,Descriptor Guide,Comos HOWTOs de Python
@anchor{howto/gdb_helpers doc}@anchor{4e39}@anchor{howto/gdb_helpers debugging-c-api-extensions-and-cpython-internals-with-gdb}@anchor{4e3a}@anchor{howto/gdb_helpers gdb}@anchor{4e3b}
@section Debugging C API extensions and CPython Internals with GDB


This document explains how the Python GDB extension, @code{python-gdb.py}, can
be used with the GDB debugger to debug CPython extensions and the
CPython interpreter itself.

When debugging low-level problems such as crashes or deadlocks, a low-level
debugger, such as GDB, is useful to diagnose and correct the issue.
By default, GDB (or any of its front-ends) doesn’t support high-level
information specific to the CPython interpreter.

The @code{python-gdb.py} extension adds CPython interpreter information to GDB.
The extension helps introspect the stack of currently executing Python functions.
Given a Python object represented by a @ref{42d,,PyObject}* pointer,
the extension surfaces the type and value of the object.

Developers who are working on CPython extensions or tinkering with parts
of CPython that are written in C can use this document to learn how to use the
@code{python-gdb.py} extension with GDB.

@cartouche
@quotation Nota 
This document assumes that you are familiar with the basics of GDB and the
CPython C API. It consolidates guidance from the
devguide@footnote{https://devguide.python.org}  and the
Python wiki@footnote{https://wiki.python.org/moin/DebuggingWithGdb}.
@end quotation
@end cartouche

@menu
* Prerequisites:: 
* Using the Debug build and Development mode:: 
* Using the python-gdb extension:: 
* Use with GDB commands:: 

@end menu

@node Prerequisites,Using the Debug build and Development mode,,Debugging C API extensions and CPython Internals with GDB
@anchor{howto/gdb_helpers prerequisites}@anchor{4e3c}
@subsection Prerequisites


You need to have:


@itemize -

@item 
GDB 7 or later. (For earlier versions of GDB, see @code{Misc/gdbinit} in the
sources of Python 3.11 or earlier.)

@item 
GDB-compatible debugging information for Python and any extension you are
debugging.

@item 
The @code{python-gdb.py} extension.
@end itemize

The extension is built with Python, but might be distributed separately or
not at all. Below, we include tips for a few common systems as examples.
Note that even if the instructions match your system, they might be outdated.

@menu
* Setup with Python built from source:: 
* Setup for Python from a Linux distro:: 

@end menu

@node Setup with Python built from source,Setup for Python from a Linux distro,,Prerequisites
@anchor{howto/gdb_helpers setup-with-python-built-from-source}@anchor{4e3d}
@subsubsection Setup with Python built from source


When you build CPython from source, debugging information should be available,
and the build should add a @code{python-gdb.py} file to the root directory of
your repository.

To activate support, you must add the directory containing @code{python-gdb.py}
to GDB’s «auto-load-safe-path».
If you haven’t done this, recent versions of GDB will print out a warning
with instructions on how to do this.

@cartouche
@quotation Nota 
If you do not see instructions for your version of GDB, put this in your
configuration file (@code{~/.gdbinit} or @code{~/.config/gdb/gdbinit}):

@example
add-auto-load-safe-path /path/to/cpython
@end example

You can also add multiple paths, separated by @code{:}.
@end quotation
@end cartouche

@node Setup for Python from a Linux distro,,Setup with Python built from source,Prerequisites
@anchor{howto/gdb_helpers setup-for-python-from-a-linux-distro}@anchor{4e3e}
@subsubsection Setup for Python from a Linux distro


Most Linux systems provide debug information for the system Python
in a package called @code{python-debuginfo}, @code{python-dbg} or similar.
For example:


@itemize -

@item 
Fedora:

@quotation

@example
sudo dnf install gdb
sudo dnf debuginfo-install python3
@end example
@end quotation

@item 
Ubuntu:

@quotation

@example
sudo apt install gdb python3-dbg
@end example
@end quotation
@end itemize

On several recent Linux systems, GDB can download debugging symbols
automatically using `debuginfod'.
However, this will not install the @code{python-gdb.py} extension;
you generally do need to install the debug info package separately.

@node Using the Debug build and Development mode,Using the python-gdb extension,Prerequisites,Debugging C API extensions and CPython Internals with GDB
@anchor{howto/gdb_helpers using-the-debug-build-and-development-mode}@anchor{4e3f}
@subsection Using the Debug build and Development mode


For easier debugging, you might want to:


@itemize -

@item 
Use a @ref{357,,debug build} of Python. (When building from source,
use @code{configure --with-pydebug}. On Linux distros, install and run a package
like @code{python-debug} or @code{python-dbg}, if available.)

@item 
Use the runtime @ref{356,,development mode} (@code{-X dev}).
@end itemize

Both enable extra assertions and disable some optimizations.
Sometimes this hides the bug you are trying to find, but in most cases they
make the process easier.

@node Using the python-gdb extension,Use with GDB commands,Using the Debug build and Development mode,Debugging C API extensions and CPython Internals with GDB
@anchor{howto/gdb_helpers using-the-python-gdb-extension}@anchor{4e40}
@subsection Using the @code{python-gdb} extension


When the extension is loaded, it provides two main features:
pretty printers for Python values, and additional commands.

@menu
* Pretty-printers:: 
* py-list:: 
* py-up and py-down:: 
* py-bt:: 
* py-print:: 
* py-locals:: 

@end menu

@node Pretty-printers,py-list,,Using the python-gdb extension
@anchor{howto/gdb_helpers pretty-printers}@anchor{4e41}
@subsubsection Pretty-printers


This is what a GDB backtrace looks like (truncated) when this extension is
enabled:

@example
#0  0x000000000041a6b1 in PyObject_Malloc (nbytes=Cannot access memory at address 0x7fffff7fefe8
) at Objects/obmalloc.c:748
#1  0x000000000041b7c0 in _PyObject_DebugMallocApi (id=111 'o', nbytes=24) at Objects/obmalloc.c:1445
#2  0x000000000041b717 in _PyObject_DebugMalloc (nbytes=24) at Objects/obmalloc.c:1412
#3  0x000000000044060a in _PyUnicode_New (length=11) at Objects/unicodeobject.c:346
#4  0x00000000004466aa in PyUnicodeUCS2_DecodeUTF8Stateful (s=0x5c2b8d "__lltrace__", size=11, errors=0x0, consumed=
    0x0) at Objects/unicodeobject.c:2531
#5  0x0000000000446647 in PyUnicodeUCS2_DecodeUTF8 (s=0x5c2b8d "__lltrace__", size=11, errors=0x0)
    at Objects/unicodeobject.c:2495
#6  0x0000000000440d1b in PyUnicodeUCS2_FromStringAndSize (u=0x5c2b8d "__lltrace__", size=11)
    at Objects/unicodeobject.c:551
#7  0x0000000000440d94 in PyUnicodeUCS2_FromString (u=0x5c2b8d "__lltrace__") at Objects/unicodeobject.c:569
#8  0x0000000000584abd in PyDict_GetItemString (v=
    @{'Yuck': <type at remote 0xad4730>, '__builtins__': <module at remote 0x7ffff7fd5ee8>, '__file__': 'Lib/test/crashers/nasty_eq_vs_dict.py', '__package__': None, 'y': <Yuck(i=0) at remote 0xaacd80>, 'dict': @{0: 0, 1: 1, 2: 2, 3: 3@}, '__cached__': None, '__name__': '__main__', 'z': <Yuck(i=0) at remote 0xaace60>, '__doc__': None@}, key=
    0x5c2b8d "__lltrace__") at Objects/dictobject.c:2171
@end example

Notice how the dictionary argument to @code{PyDict_GetItemString} is displayed
as its @code{repr()}, rather than an opaque @code{PyObject *} pointer.

The extension works by supplying a custom printing routine for values of type
@code{PyObject *}.  If you need to access lower-level details of an object, then
cast the value to a pointer of the appropriate type.  For example:

@example
(gdb) p globals
$1 = @{'__builtins__': <module at remote 0x7ffff7fb1868>, '__name__':
'__main__', 'ctypes': <module at remote 0x7ffff7f14360>, '__doc__': None,
'__package__': None@}

(gdb) p *(PyDictObject*)globals
$2 = @{ob_refcnt = 3, ob_type = 0x3dbdf85820, ma_fill = 5, ma_used = 5,
ma_mask = 7, ma_table = 0x63d0f8, ma_lookup = 0x3dbdc7ea70
<lookdict_string>, ma_smalltable = @{@{me_hash = 7065186196740147912,
me_key = '__builtins__', me_value = <module at remote 0x7ffff7fb1868>@},
@{me_hash = -368181376027291943, me_key = '__name__',
me_value ='__main__'@}, @{me_hash = 0, me_key = 0x0, me_value = 0x0@},
@{me_hash = 0, me_key = 0x0, me_value = 0x0@},
@{me_hash = -9177857982131165996, me_key = 'ctypes',
me_value = <module at remote 0x7ffff7f14360>@},
@{me_hash = -8518757509529533123, me_key = '__doc__', me_value = None@},
@{me_hash = 0, me_key = 0x0, me_value = 0x0@}, @{
  me_hash = 6614918939584953775, me_key = '__package__', me_value = None@}@}@}
@end example

Note that the pretty-printers do not actually call @code{repr()}.
For basic types, they try to match its result closely.

An area that can be confusing is that the custom printer for some types look a
lot like GDB’s built-in printer for standard types.  For example, the
pretty-printer for a Python @code{int} (@ref{24b,,PyLongObject}*)
gives a representation that is not distinguishable from one of a
regular machine-level integer:

@example
(gdb) p some_machine_integer
$3 = 42

(gdb) p some_python_integer
$4 = 42
@end example

The internal structure can be revealed with a cast to @ref{24b,,PyLongObject}*:

@quotation

(gdb) p `(PyLongObject')some_python_integer
$5 = @{ob_base = @{ob_base = @{ob_refcnt = 8, ob_type = 0x3dad39f5e0@}, ob_size = 1@},
ob_digit = @{42@}@}
@end quotation

A similar confusion can arise with the @code{str} type, where the output looks a
lot like gdb’s built-in printer for @code{char *}:

@example
(gdb) p ptr_to_python_str
$6 = '__builtins__'
@end example

The pretty-printer for @code{str} instances defaults to using single-quotes (as
does Python’s @code{repr} for strings) whereas the standard printer for @code{char *}
values uses double-quotes and contains a hexadecimal address:

@example
(gdb) p ptr_to_char_star
$7 = 0x6d72c0 "hello world"
@end example

Again, the implementation details can be revealed with a cast to
@ref{82d,,PyUnicodeObject}*:

@example
(gdb) p *(PyUnicodeObject*)$6
$8 = @{ob_base = @{ob_refcnt = 33, ob_type = 0x3dad3a95a0@}, length = 12,
str = 0x7ffff2128500, hash = 7065186196740147912, state = 1, defenc = 0x0@}
@end example

@node py-list,py-up and py-down,Pretty-printers,Using the python-gdb extension
@anchor{howto/gdb_helpers py-list}@anchor{4e42}
@subsubsection @code{py-list}


@quotation

The extension adds a @code{py-list} command, which
lists the Python source code (if any) for the current frame in the selected
thread.  The current line is marked with a «>»:

@example
(gdb) py-list
 901        if options.profile:
 902            options.profile = False
 903            profile_me()
 904            return
 905
>906        u = UI()
 907        if not u.quit:
 908            try:
 909                gtk.main()
 910            except KeyboardInterrupt:
 911                # properly quit on a keyboard interrupt...
@end example

Use @code{py-list START} to list at a different line number within the Python
source, and @code{py-list START,END} to list a specific range of lines within
the Python source.
@end quotation

@node py-up and py-down,py-bt,py-list,Using the python-gdb extension
@anchor{howto/gdb_helpers py-up-and-py-down}@anchor{4e43}
@subsubsection @code{py-up} and @code{py-down}


@quotation

The @code{py-up} and @code{py-down} commands are analogous to GDB’s regular @code{up}
and @code{down} commands, but try to move at the level of CPython frames, rather
than C frames.

GDB is not always able to read the relevant frame information, depending on
the optimization level with which CPython was compiled. Internally, the
commands look for C frames that are executing the default frame evaluation
function (that is, the core bytecode interpreter loop within CPython) and
look up the value of the related @code{PyFrameObject *}.

They emit the frame number (at the C level) within the thread.

For example:

@example
(gdb) py-up
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/
gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
(gdb) py-up
#40 Frame 0x948e82c, for file /usr/lib/python2.6/site-packages/
gnome_sudoku/gnome_sudoku.py, line 22, in start_game(main=<module at remote 0xb771b7f4>)
    main.start_game()
(gdb) py-up
Unable to find an older python frame
@end example

so we’re at the top of the Python stack.

The frame numbers correspond to those displayed by GDB’s standard
@code{backtrace} command.
The command skips C frames which are not executing Python code.

Going back down:

@example
(gdb) py-down
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
(gdb) py-down
#34 (unable to read python frame information)
(gdb) py-down
#23 (unable to read python frame information)
(gdb) py-down
#19 (unable to read python frame information)
(gdb) py-down
#14 Frame 0x99262ac, for file /usr/lib/python2.6/site-packages/gnome_sudoku/game_selector.py, line 201, in run_swallowed_dialog (self=<NewOrSavedGameSelector(new_game_model=<gtk.ListStore at remote 0x98fab44>, puzzle=None, saved_games=[@{'gsd.auto_fills': 0, 'tracking': @{@}, 'trackers': @{@}, 'notes': [], 'saved_at': 1270084485, 'game': '7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 0 0 0 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5\n7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 1 8 3 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5', 'gsd.impossible_hints': 0, 'timer.__absolute_start_time__': <float at remote 0x984b474>, 'gsd.hints': 0, 'timer.active_time': <float at remote 0x984b494>, 'timer.total_time': <float at remote 0x984b464>@}], dialog=<gtk.Dialog at remote 0x98faaa4>, saved_game_model=<gtk.ListStore at remote 0x98fad24>, sudoku_maker=<SudokuMaker(terminated=False, played=[], batch_siz...(truncated)
            swallower.run_dialog(self.dialog)
(gdb) py-down
#11 Frame 0x9aead74, for file /usr/lib/python2.6/site-packages/gnome_sudoku/dialog_swallower.py, line 48, in run_dialog (self=<SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>, main_page=0) at remote 0x98fa6e4>, d=<gtk.Dialog at remote 0x98faaa4>)
            gtk.main()
(gdb) py-down
#8 (unable to read python frame information)
(gdb) py-down
Unable to find a newer python frame
@end example

and we’re at the bottom of the Python stack.

Note that in Python 3.12 and newer, the same C stack frame can be used for
multiple Python stack frames. This means that @code{py-up} and @code{py-down}
may move multiple Python frames at once. For example:

@example
(gdb) py-up
#6 Frame 0x7ffff7fb62b0, for file /tmp/rec.py, line 5, in recursive_function (n=0)
   time.sleep(5)
#6 Frame 0x7ffff7fb6240, for file /tmp/rec.py, line 7, in recursive_function (n=1)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb61d0, for file /tmp/rec.py, line 7, in recursive_function (n=2)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6160, for file /tmp/rec.py, line 7, in recursive_function (n=3)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb60f0, for file /tmp/rec.py, line 7, in recursive_function (n=4)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6080, for file /tmp/rec.py, line 7, in recursive_function (n=5)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6020, for file /tmp/rec.py, line 9, in <module> ()
   recursive_function(5)
(gdb) py-up
Unable to find an older python frame
@end example
@end quotation

@node py-bt,py-print,py-up and py-down,Using the python-gdb extension
@anchor{howto/gdb_helpers py-bt}@anchor{4e44}
@subsubsection @code{py-bt}


@quotation

The @code{py-bt} command attempts to display a Python-level backtrace of the
current thread.

For example:

@example
(gdb) py-bt
#8 (unable to read python frame information)
#11 Frame 0x9aead74, for file /usr/lib/python2.6/site-packages/gnome_sudoku/dialog_swallower.py, line 48, in run_dialog (self=<SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>, main_page=0) at remote 0x98fa6e4>, d=<gtk.Dialog at remote 0x98faaa4>)
            gtk.main()
#14 Frame 0x99262ac, for file /usr/lib/python2.6/site-packages/gnome_sudoku/game_selector.py, line 201, in run_swallowed_dialog (self=<NewOrSavedGameSelector(new_game_model=<gtk.ListStore at remote 0x98fab44>, puzzle=None, saved_games=[@{'gsd.auto_fills': 0, 'tracking': @{@}, 'trackers': @{@}, 'notes': [], 'saved_at': 1270084485, 'game': '7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 0 0 0 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5\n7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 1 8 3 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5', 'gsd.impossible_hints': 0, 'timer.__absolute_start_time__': <float at remote 0x984b474>, 'gsd.hints': 0, 'timer.active_time': <float at remote 0x984b494>, 'timer.total_time': <float at remote 0x984b464>@}], dialog=<gtk.Dialog at remote 0x98faaa4>, saved_game_model=<gtk.ListStore at remote 0x98fad24>, sudoku_maker=<SudokuMaker(terminated=False, played=[], batch_siz...(truncated)
            swallower.run_dialog(self.dialog)
#19 (unable to read python frame information)
#23 (unable to read python frame information)
#34 (unable to read python frame information)
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
#40 Frame 0x948e82c, for file /usr/lib/python2.6/site-packages/gnome_sudoku/gnome_sudoku.py, line 22, in start_game (main=<module at remote 0xb771b7f4>)
    main.start_game()
@end example

The frame numbers correspond to those displayed by GDB’s standard
@code{backtrace} command.
@end quotation

@node py-print,py-locals,py-bt,Using the python-gdb extension
@anchor{howto/gdb_helpers py-print}@anchor{4e45}
@subsubsection @code{py-print}


@quotation

The @code{py-print} command looks up a Python name and tries to print it.
It looks in locals within the current thread, then globals, then finally
builtins:

@example
(gdb) py-print self
local 'self' = <SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>,
main_page=0) at remote 0x98fa6e4>
(gdb) py-print __name__
global '__name__' = 'gnome_sudoku.dialog_swallower'
(gdb) py-print len
builtin 'len' = <built-in function len>
(gdb) py-print scarlet_pimpernel
'scarlet_pimpernel' not found
@end example

If the current C frame corresponds to multiple Python frames, @code{py-print}
only considers the first one.
@end quotation

@node py-locals,,py-print,Using the python-gdb extension
@anchor{howto/gdb_helpers py-locals}@anchor{4e46}
@subsubsection @code{py-locals}


@quotation

The @code{py-locals} command looks up all Python locals within the current
Python frame in the selected thread, and prints their representations:

@example
(gdb) py-locals
self = <SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>,
main_page=0) at remote 0x98fa6e4>
d = <gtk.Dialog at remote 0x98faaa4>
@end example

If the current C frame corresponds to multiple Python frames, locals from
all of them will be shown:

@example
(gdb) py-locals
Locals for recursive_function
n = 0
Locals for recursive_function
n = 1
Locals for recursive_function
n = 2
Locals for recursive_function
n = 3
Locals for recursive_function
n = 4
Locals for recursive_function
n = 5
Locals for <module>
@end example
@end quotation

@node Use with GDB commands,,Using the python-gdb extension,Debugging C API extensions and CPython Internals with GDB
@anchor{howto/gdb_helpers use-with-gdb-commands}@anchor{4e47}
@subsection Use with GDB commands


The extension commands complement GDB’s built-in commands.
For example, you can use a frame numbers shown by @code{py-bt} with the @code{frame}
command to go a specific frame within the selected thread, like this:

@example
(gdb) py-bt
(output snipped)
#68 Frame 0xaa4560, for file Lib/test/regrtest.py, line 1548, in <module> ()
        main()
(gdb) frame 68
#68 0x00000000004cd1e6 in PyEval_EvalFrameEx (f=Frame 0xaa4560, for file Lib/test/regrtest.py, line 1548, in <module> (), throwflag=0) at Python/ceval.c:2665
2665                            x = call_function(&sp, oparg);
(gdb) py-list
1543        # Run the tests in a context manager that temporary changes the CWD to a
1544        # temporary and writable directory. If it's not possible to create or
1545        # change the CWD, the original CWD will be used. The original CWD is
1546        # available from test_support.SAVEDCWD.
1547        with test_support.temp_cwd(TESTCWD, quiet=True):
>1548            main()
@end example

The @code{info threads} command will give you a list of the threads within the
process, and you can use the @code{thread} command to select a different one:

@example
(gdb) info threads
  105 Thread 0x7fffefa18710 (LWP 10260)  sem_wait () at ../nptl/sysdeps/unix/sysv/linux/x86_64/sem_wait.S:86
  104 Thread 0x7fffdf5fe710 (LWP 10259)  sem_wait () at ../nptl/sysdeps/unix/sysv/linux/x86_64/sem_wait.S:86
* 1 Thread 0x7ffff7fe2700 (LWP 10145)  0x00000038e46d73e3 in select () at ../sysdeps/unix/syscall-template.S:82
@end example

You can use @code{thread apply all COMMAND} or (@code{t a a COMMAND} for short) to run
a command on all threads.  With @code{py-bt}, this lets you see what every
thread is doing at the Python level:

@example
(gdb) t a a py-bt

Thread 105 (Thread 0x7fffefa18710 (LWP 10260)):
#5 Frame 0x7fffd00019d0, for file /home/david/coding/python-svn/Lib/threading.py, line 155, in _acquire_restore (self=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, count_owner=(1, 140737213728528), count=1, owner=140737213728528)
        self.__block.acquire()
#8 Frame 0x7fffac001640, for file /home/david/coding/python-svn/Lib/threading.py, line 269, in wait (self=<_Condition(_Condition__lock=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, acquire=<instancemethod at remote 0xd80260>, _is_owned=<instancemethod at remote 0xd80160>, _release_save=<instancemethod at remote 0xd803e0>, release=<instancemethod at remote 0xd802e0>, _acquire_restore=<instancemethod at remote 0xd7ee60>, _Verbose__verbose=False, _Condition__waiters=[]) at remote 0xd7fd10>, timeout=None, waiter=<thread.lock at remote 0x858a90>, saved_state=(1, 140737213728528))
            self._acquire_restore(saved_state)
#12 Frame 0x7fffb8001a10, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 348, in f ()
            cond.wait()
#16 Frame 0x7fffb8001c40, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 37, in task (tid=140737213728528)
                f()

Thread 104 (Thread 0x7fffdf5fe710 (LWP 10259)):
#5 Frame 0x7fffe4001580, for file /home/david/coding/python-svn/Lib/threading.py, line 155, in _acquire_restore (self=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, count_owner=(1, 140736940992272), count=1, owner=140736940992272)
        self.__block.acquire()
#8 Frame 0x7fffc8002090, for file /home/david/coding/python-svn/Lib/threading.py, line 269, in wait (self=<_Condition(_Condition__lock=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, acquire=<instancemethod at remote 0xd80260>, _is_owned=<instancemethod at remote 0xd80160>, _release_save=<instancemethod at remote 0xd803e0>, release=<instancemethod at remote 0xd802e0>, _acquire_restore=<instancemethod at remote 0xd7ee60>, _Verbose__verbose=False, _Condition__waiters=[]) at remote 0xd7fd10>, timeout=None, waiter=<thread.lock at remote 0x858860>, saved_state=(1, 140736940992272))
            self._acquire_restore(saved_state)
#12 Frame 0x7fffac001c90, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 348, in f ()
            cond.wait()
#16 Frame 0x7fffac0011c0, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 37, in task (tid=140736940992272)
                f()

Thread 1 (Thread 0x7ffff7fe2700 (LWP 10145)):
#5 Frame 0xcb5380, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 16, in _wait ()
    time.sleep(0.01)
#8 Frame 0x7fffd00024a0, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 378, in _check_notify (self=<ConditionTests(_testMethodName='test_notify', _resultForDoCleanups=<TestResult(_original_stdout=<cStringIO.StringO at remote 0xc191e0>, skipped=[], _mirrorOutput=False, testsRun=39, buffer=False, _original_stderr=<file at remote 0x7ffff7fc6340>, _stdout_buffer=<cStringIO.StringO at remote 0xc9c7f8>, _stderr_buffer=<cStringIO.StringO at remote 0xc9c790>, _moduleSetUpFailed=False, expectedFailures=[], errors=[], _previousTestClass=<type at remote 0x928310>, unexpectedSuccesses=[], failures=[], shouldStop=False, failfast=False) at remote 0xc185a0>, _threads=(0,), _cleanups=[], _type_equality_funcs=@{<type at remote 0x7eba00>: <instancemethod at remote 0xd750e0>, <type at remote 0x7e7820>: <instancemethod at remote 0xd75160>, <type at remote 0x7e30e0>: <instancemethod at remote 0xd75060>, <type at remote 0x7e7d20>: <instancemethod at remote 0xd751e0>, <type at remote 0x7f19e0...(truncated)
        _wait()
@end example

@node HOWTO - Enum,HOWTO - Programación funcional,Debugging C API extensions and CPython Internals with GDB,Comos HOWTOs de Python
@anchor{howto/enum doc}@anchor{4e48}@anchor{howto/enum enum-howto}@anchor{4e49}@anchor{howto/enum id1}@anchor{4e4a}
@section HOWTO - Enum

@anchor{howto/enum enum-basic-tutorial}@anchor{25ac}
An @ref{6d1,,Enum} is a set of symbolic names bound to unique values.  They are
similar to global variables, but they offer a more useful @ref{894,,repr()},
grouping, type-safety, and a few other features.

Son más útiles cuando tiene una variable que puede tomar uno de una selección limitada de valores. Por ejemplo, los días de la semana:

@example
>>> from enum import Enum
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
@end example

O quizás los colores primarios RGB:

@example
>>> from enum import Enum
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
@end example

Como puede ver, crear un @ref{6d1,,Enum} es tan simple como escribir una clase que herede del propio @ref{6d1,,Enum}.

@cartouche
@quotation Nota 
Caso de miembros de Enum

Dado que las enumeraciones se utilizan para representar constantes y para evitar problemas con conflictos de nombres entre los métodos/atributos de las clases mixin y los nombres de las enumeraciones, recomendamos encarecidamente utilizar nombres en MAYÚSCULAS para los miembros, y utilizaremos ese estilo en nuestros ejemplos.
@end quotation
@end cartouche

Dependiendo de la naturaleza de la enumeración, el valor de un miembro puede o no ser importante, pero de cualquier manera ese valor puede usarse para obtener el miembro correspondiente:

@example
>>> Weekday(3)
<Weekday.WEDNESDAY: 3>
@end example

Como puede ver, el @code{repr()} de un miembro muestra el nombre de enumeración, el nombre del miembro y el valor. El @code{str()} de un miembro muestra solo el nombre de enumeración y el nombre del miembro:

@example
>>> print(Weekday.THURSDAY)
Weekday.THURSDAY
@end example

El `type' de un miembro de la enumeración es la enumeración a la que pertenece:

@example
>>> type(Weekday.MONDAY)
<enum 'Weekday'>
>>> isinstance(Weekday.FRIDAY, Weekday)
True
@end example

Los miembros de enumeración tienen un atributo que contiene solo su @code{name}:

@example
>>> print(Weekday.TUESDAY.name)
TUESDAY
@end example

Asimismo, tienen un atributo para su @code{value}:

@example
>>> Weekday.WEDNESDAY.value
3
@end example

A diferencia de muchos lenguajes que tratan las enumeraciones únicamente como pares de nombre/valor, Python Enums puede tener un comportamiento agregado. Por ejemplo, @ref{330,,datetime.date} tiene dos métodos para retornar el día de la semana: @code{weekday()} y @code{isoweekday()}. La diferencia es que uno de ellos cuenta de 0 a 6 y el otro de 1 a 7. En lugar de hacer un seguimiento de eso nosotros mismos, podemos agregar un método a la enumeración @code{Weekday} para extraer el día de la instancia @code{date} y retornar el miembro de enumeración coincidente:

@example
@@classmethod
def from_date(cls, date):
    return cls(date.isoweekday())
@end example

La enumeración @code{Weekday} completa ahora se ve así:

@example
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
...     #
...     @@classmethod
...     def from_date(cls, date):
...         return cls(date.isoweekday())
@end example

¡Ahora podemos averiguar qué día de la semana es hoy! Observe:

@example
>>> from datetime import date
>>> Weekday.from_date(date.today())     
<Weekday.TUESDAY: 2>
@end example

Por supuesto, si estás leyendo esto en otro día, verás ese día en su lugar.

Esta enumeración @code{Weekday} es excelente si nuestra variable solo necesita un día, pero ¿y si necesitamos varios? Tal vez estamos escribiendo una función para trazar tareas durante una semana y no queremos usar un @ref{18e,,list}; podríamos usar un tipo diferente de @ref{6d1,,Enum}:

@example
>>> from enum import Flag
>>> class Weekday(Flag):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 4
...     THURSDAY = 8
...     FRIDAY = 16
...     SATURDAY = 32
...     SUNDAY = 64
@end example

Hemos cambiado dos cosas: somos heredados de @ref{6c4,,Flag} y los valores son todos potencia de 2.

Al igual que la enumeración @code{Weekday} original anterior, podemos tener una sola selección:

@example
>>> first_week_day = Weekday.MONDAY
>>> first_week_day
<Weekday.MONDAY: 1>
@end example

Pero @ref{6c4,,Flag} también nos permite combinar varios miembros en una sola variable:

@example
>>> weekend = Weekday.SATURDAY | Weekday.SUNDAY
>>> weekend
<Weekday.SATURDAY|SUNDAY: 96>
@end example

Incluso puede iterar sobre una variable @ref{6c4,,Flag}:

@example
>>> for day in weekend:
...     print(day)
Weekday.SATURDAY
Weekday.SUNDAY
@end example

Bien, preparemos algunas tareas:

@example
>>> chores_for_ethan = @{
...     'feed the cat': Weekday.MONDAY | Weekday.WEDNESDAY | Weekday.FRIDAY,
...     'do the dishes': Weekday.TUESDAY | Weekday.THURSDAY,
...     'answer SO questions': Weekday.SATURDAY,
...     @}
@end example

Y una función para mostrar las tareas de un día determinado:

@example
>>> def show_chores(chores, day):
...     for chore, days in chores.items():
...         if day in days:
...             print(chore)
...
>>> show_chores(chores_for_ethan, Weekday.SATURDAY)
answer SO questions
@end example

In cases where the actual values of the members do not matter, you can save
yourself some work and use @ref{d25,,auto()} for the values:

@example
>>> from enum import auto
>>> class Weekday(Flag):
...     MONDAY = auto()
...     TUESDAY = auto()
...     WEDNESDAY = auto()
...     THURSDAY = auto()
...     FRIDAY = auto()
...     SATURDAY = auto()
...     SUNDAY = auto()
...     WEEKEND = SATURDAY | SUNDAY
@end example

@menu
* Acceso programático a los miembros de la enumeración y sus atributos:: 
* Duplicar miembros y valores de enumeración:: 
* Garantizar valores de enumeración únicos:: 
* Uso de valores automáticos:: 
* Iteración: Iteración<2>. 
* Comparaciones: Comparaciones<3>. 
* Miembros permitidos y atributos de enumeraciones:: 
* Subclases de Enum restringidas:: 
* Soporte de Dataclass:: 
* Serialización (Pickling): Serialización Pickling. 
* API funcional: API funcional<2>. 
* Enumeraciones derivadas:: 
* Cuándo usar __new__() frente a __init__(): Cuándo usar __new__ frente a __init__. 
* ¿En qué se diferencian las Enumeraciones (Enums) y las Banderas (Flags)?: ¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?. 
* Recetario de Enumeraciones:: 
* Subclase EnumType:: 

@end menu

@node Acceso programático a los miembros de la enumeración y sus atributos,Duplicar miembros y valores de enumeración,,HOWTO - Enum
@anchor{howto/enum enum-advanced-tutorial}@anchor{25ad}@anchor{howto/enum programmatic-access-to-enumeration-members-and-their-attributes}@anchor{4e4b}
@subsection Acceso programático a los miembros de la enumeración y sus atributos


A veces es útil acceder a los miembros en las enumeraciones programáticamente (es decir, situaciones en las que @code{Color.RED} no funcionará porque no se conoce el color exacto en el momento de escribir el programa). @code{Enum} permite dicho acceso:

@example
>>> Color(1)
<Color.RED: 1>
>>> Color(3)
<Color.BLUE: 3>
@end example

Si desea acceder a los miembros de la enumeración por `name', use el acceso a elementos:

@example
>>> Color['RED']
<Color.RED: 1>
>>> Color['GREEN']
<Color.GREEN: 2>
@end example

Si tiene un miembro de enumeración y necesita su @code{name} o @code{value}:

@example
>>> member = Color.RED
>>> member.name
'RED'
>>> member.value
1
@end example

@node Duplicar miembros y valores de enumeración,Garantizar valores de enumeración únicos,Acceso programático a los miembros de la enumeración y sus atributos,HOWTO - Enum
@anchor{howto/enum duplicating-enum-members-and-values}@anchor{4e4c}
@subsection Duplicar miembros y valores de enumeración


Tener dos miembros de enumeración con el mismo nombre no es válido:

@example
>>> class Shape(Enum):
...     SQUARE = 2
...     SQUARE = 3
...
Traceback (most recent call last):
...
TypeError: 'SQUARE' already defined as 2
@end example

Sin embargo, un miembro de enumeración puede tener otros nombres asociados. Dadas dos entradas @code{A} y @code{B} con el mismo valor (y @code{A} definido primero), @code{B} es un alias para el miembro @code{A}. La búsqueda por valor del valor de @code{A} retornará el miembro @code{A}. La búsqueda por nombre de @code{A} retornará el miembro @code{A}. La búsqueda por nombre de @code{B} también retornará el miembro @code{A}:

@example
>>> class Shape(Enum):
...     SQUARE = 2
...     DIAMOND = 1
...     CIRCLE = 3
...     ALIAS_FOR_SQUARE = 2
...
>>> Shape.SQUARE
<Shape.SQUARE: 2>
>>> Shape.ALIAS_FOR_SQUARE
<Shape.SQUARE: 2>
>>> Shape(2)
<Shape.SQUARE: 2>
@end example

@cartouche
@quotation Nota 
No está permitido intentar crear un miembro con el mismo nombre que un atributo ya definido (otro miembro, un método, etc.) o intentar crear un atributo con el mismo nombre que un miembro.
@end quotation
@end cartouche

@node Garantizar valores de enumeración únicos,Uso de valores automáticos,Duplicar miembros y valores de enumeración,HOWTO - Enum
@anchor{howto/enum ensuring-unique-enumeration-values}@anchor{4e4d}
@subsection Garantizar valores de enumeración únicos


De forma predeterminada, las enumeraciones permiten múltiples nombres como alias para el mismo valor. Cuando no se desea este comportamiento, puede usar el decorador @ref{25b2,,unique()}:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Mistake(Enum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...     FOUR = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
@end example

@node Uso de valores automáticos,Iteración<2>,Garantizar valores de enumeración únicos,HOWTO - Enum
@anchor{howto/enum using-automatic-values}@anchor{4e4e}
@subsection Uso de valores automáticos


Si el valor exacto no es importante, puede usar @ref{d25,,auto}:

@example
>>> from enum import Enum, auto
>>> class Color(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> [member.value for member in Color]
[1, 2, 3]
@end example

Los valores son elegidos por @code{_generate_next_value_()}, que se pueden anular:

@example
>>> class AutoName(Enum):
...     @@staticmethod
...     def _generate_next_value_(name, start, count, last_values):
...         return name
...
>>> class Ordinal(AutoName):
...     NORTH = auto()
...     SOUTH = auto()
...     EAST = auto()
...     WEST = auto()
...
>>> [member.value for member in Ordinal]
['NORTH', 'SOUTH', 'EAST', 'WEST']
@end example

@cartouche
@quotation Nota 
El método @code{_generate_next_value_()} debe definirse antes que cualquier miembro.
@end quotation
@end cartouche

@node Iteración<2>,Comparaciones<3>,Uso de valores automáticos,HOWTO - Enum
@anchor{howto/enum iteration}@anchor{4e4f}
@subsection Iteración


Iterar sobre los miembros de una enumeración no proporciona los alias:

@example
>>> list(Shape)
[<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]
>>> list(Weekday)
[<Weekday.MONDAY: 1>, <Weekday.TUESDAY: 2>, <Weekday.WEDNESDAY: 4>, <Weekday.THURSDAY: 8>, <Weekday.FRIDAY: 16>, <Weekday.SATURDAY: 32>, <Weekday.SUNDAY: 64>]
@end example

Note que los alias @code{Shape.ALIAS_FOR_SQUARE} y @code{Weekday.WEEKEND} no se muestran.

El atributo especial @code{__members__} es una asignación ordenada de solo lectura de nombres a miembros. Incluye todos los nombres definidos en la enumeración, incluidos los alias:

@example
>>> for name, member in Shape.__members__.items():
...     name, member
...
('SQUARE', <Shape.SQUARE: 2>)
('DIAMOND', <Shape.DIAMOND: 1>)
('CIRCLE', <Shape.CIRCLE: 3>)
('ALIAS_FOR_SQUARE', <Shape.SQUARE: 2>)
@end example

El atributo @code{__members__} se puede utilizar para el acceso programático detallado a los miembros de la enumeración. Por ejemplo, encontrar todos los alias:

@example
>>> [name for name, member in Shape.__members__.items() if member.name != name]
['ALIAS_FOR_SQUARE']
@end example

@cartouche
@quotation Nota 
Los alias para las banderas incluyen valores con múltiples banderas establecidas, como @code{3}, y ningún conjunto de banderas, es decir, @code{0}.
@end quotation
@end cartouche

@node Comparaciones<3>,Miembros permitidos y atributos de enumeraciones,Iteración<2>,HOWTO - Enum
@anchor{howto/enum comparisons}@anchor{4e50}
@subsection Comparaciones


Los miembros de la enumeración se comparan por identidad:

@example
>>> Color.RED is Color.RED
True
>>> Color.RED is Color.BLUE
False
>>> Color.RED is not Color.BLUE
True
@end example

Las comparaciones ordenadas entre valores de enumeración son compatibles con `not'. Los miembros de la enumeración no son números enteros (pero consulte @ref{4e51,,IntEnum} a continuación):

@example
>>> Color.RED < Color.BLUE
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'Color' and 'Color'
@end example

Las comparaciones de igualdad se definen aunque:

@example
>>> Color.BLUE == Color.RED
False
>>> Color.BLUE != Color.RED
True
>>> Color.BLUE == Color.BLUE
True
@end example

Las comparaciones con valores que no son de enumeración siempre comparan no iguales (nuevamente, @ref{d66,,IntEnum} se diseñó explícitamente para comportarse de manera diferente, consulte a continuación):

@example
>>> Color.BLUE == 2
False
@end example

@cartouche
@quotation Advertencia 
Es posible recargar módulos; si un módulo recargado contiene enumeraciones, estas se crearán de nuevo y los nuevos miembros pueden no compararse como idénticos/iguales a los miembros originales.
@end quotation
@end cartouche

@node Miembros permitidos y atributos de enumeraciones,Subclases de Enum restringidas,Comparaciones<3>,HOWTO - Enum
@anchor{howto/enum allowed-members-and-attributes-of-enumerations}@anchor{4e52}
@subsection Miembros permitidos y atributos de enumeraciones


La mayoría de los ejemplos anteriores usan números enteros para los valores de enumeración. El uso de números enteros es corto y práctico (y proporcionado por defecto por el @ref{4e53,,Functional API}), pero no se aplica estrictamente. En la gran mayoría de los casos de uso, a uno no le importa cuál es el valor real de una enumeración. Pero si el valor `is' es importante, las enumeraciones pueden tener valores arbitrarios.

Las enumeraciones son clases de Python y pueden tener métodos y métodos especiales como de costumbre. Si tenemos esta enumeración:

@example
>>> class Mood(Enum):
...     FUNKY = 1
...     HAPPY = 3
...
...     def describe(self):
...         # self is the member here
...         return self.name, self.value
...
...     def __str__(self):
...         return 'my custom str! @{0@}'.format(self.value)
...
...     @@classmethod
...     def favorite_mood(cls):
...         # cls here is the enumeration
...         return cls.HAPPY
...
@end example

Después:

@example
>>> Mood.favorite_mood()
<Mood.HAPPY: 3>
>>> Mood.HAPPY.describe()
('HAPPY', 3)
>>> str(Mood.FUNKY)
'my custom str! 1'
@end example

Las reglas para lo que está permitido son las siguientes: los nombres que comienzan y terminan con un solo guión bajo están reservados por enumeración y no se pueden usar; todos los demás atributos definidos dentro de una enumeración se convertirán en miembros de esta enumeración, con la excepción de métodos especiales (@code{__str__()}, @code{__add__()}, etc.), descriptores (los métodos también son descriptores) y nombres de variables enumerados en @code{_ignore_}.

Nota:  si su enumeración define @code{__new__()} y/o @code{__init__()}, cualquier valor(es) dado(s) al miembro de la enumeración se pasará a esos métodos. Consulte @ref{4e54,,Planet} para ver un ejemplo.

@cartouche
@quotation Nota 
El método @code{__new__()}, si está definido, se usa durante la creación de los miembros de Enum; luego se reemplaza por @code{__new__()} de Enum, que se usa después de la creación de clases para buscar miembros existentes.  Consulte @ref{4e55,,Cuándo usar __new__() frente a __init__()} para obtener más detalles.
@end quotation
@end cartouche

@node Subclases de Enum restringidas,Soporte de Dataclass,Miembros permitidos y atributos de enumeraciones,HOWTO - Enum
@anchor{howto/enum restricted-enum-subclassing}@anchor{4e56}
@subsection Subclases de Enum restringidas


Una nueva clase @ref{6d1,,Enum} debe tener una clase de enumeración base, hasta un tipo de datos concreto y tantas clases mixtas basadas en @ref{b18,,object} como sea necesario.  El orden de estas clases base es:

@example
class EnumName([mix-in, ...,] [data-type,] base-enum):
    pass
@end example

Además, la subclasificación de una enumeración solo se permite si la enumeración no define ningún miembro. Así que esto está prohibido:

@example
>>> class MoreColor(Color):
...     PINK = 17
...
Traceback (most recent call last):
...
TypeError: <enum 'MoreColor'> cannot extend <enum 'Color'>
@end example

Pero esto está permitido:

@example
>>> class Foo(Enum):
...     def some_behavior(self):
...         pass
...
>>> class Bar(Foo):
...     HAPPY = 1
...     SAD = 2
...
@end example

Permitir la subclasificación de enumeraciones que definen miembros conduciría a una violación de algunas invariantes importantes de tipos e instancias. Por otro lado, tiene sentido permitir compartir algún comportamiento común entre un grupo de enumeraciones. (Consulte @ref{4e57,,OrderedEnum} para ver un ejemplo).

@node Soporte de Dataclass,Serialización Pickling,Subclases de Enum restringidas,HOWTO - Enum
@anchor{howto/enum dataclass-support}@anchor{4e58}@anchor{howto/enum enum-dataclass-support}@anchor{178c}
@subsection Soporte de Dataclass


Cuando se hereda de una @ref{32e,,dataclass}, el @ref{178d,,__repr__()} omite el nombre de la clase heredada.  Por ejemplo:

@example
>>> from dataclasses import dataclass, field
>>> @@dataclass
... class CreatureDataMixin:
...     size: str
...     legs: int
...     tail: bool = field(repr=False, default=True)
...
>>> class Creature(CreatureDataMixin, Enum):
...     BEETLE = 'small', 6
...     DOG = 'medium', 4
...
>>> Creature.DOG
<Creature.DOG: size='medium', legs=4>
@end example

Use the @ref{32e,,dataclass()} argument @code{repr=False}
to use the standard @ref{894,,repr()}.


Distinto en la versión 3.12: Solo se muestran los campos de la dataclass en el área de valores, no el nombre de la dataclass.


@cartouche
@quotation Nota 
Adding @ref{32e,,dataclass()} decorator to @ref{6d1,,Enum}
and its subclasses is not supported. It will not raise any errors,
but it will produce very strange results at runtime, such as members
being equal to each other:

@example
>>> @@dataclass               # don't do this: it does not make any sense
... class Color(Enum):
...    RED = 1
...    BLUE = 2
...
>>> Color.RED is Color.BLUE
False
>>> Color.RED == Color.BLUE  # problem is here: they should not be equal
True
@end example
@end quotation
@end cartouche

@node Serialización Pickling,API funcional<2>,Soporte de Dataclass,HOWTO - Enum
@anchor{howto/enum pickling}@anchor{4e59}
@subsection Serialización (Pickling)


Las enumeraciones se pueden serializar y deserializar:

@example
>>> from test.test_enum import Fruit
>>> from pickle import dumps, loads
>>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
True
@end example

Se aplican las restricciones habituales para el `pickling': las enumeraciones serializables deben definirse en el nivel superior de un módulo, ya que el decapado requiere que se puedan importar desde ese módulo.

@cartouche
@quotation Nota 
Con la versión 4 del protocolo pickle es posible deserializar fácilmente enumeraciones anidadas en otras clases.
@end quotation
@end cartouche

Es posible modificar la forma en que los miembros de la enumeración se serialicen / deserialicen definiendo @code{__reduce_ex__()} en la clase de enumeración.  El método predeterminado es por valor, pero las enumeraciones con valores complicados pueden querer utilizar por nombre:

@example
>>> import enum
>>> class MyEnum(enum.Enum):
...     __reduce_ex__ = enum.pickle_by_enum_name
@end example

@cartouche
@quotation Nota 
No se recomienda usar banderas por nombre , ya que los alias sin nombre no se desempaquetarán.
@end quotation
@end cartouche

@node API funcional<2>,Enumeraciones derivadas,Serialización Pickling,HOWTO - Enum
@anchor{howto/enum functional-api}@anchor{4e53}
@subsection API funcional


Se puede llamar a la clase @ref{6d1,,Enum}, que proporciona la siguiente API funcional:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
>>> Animal
<enum 'Animal'>
>>> Animal.ANT
<Animal.ANT: 1>
>>> list(Animal)
[<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]
@end example

La semántica de esta API se asemeja a @ref{32d,,namedtuple}. El primer argumento de la llamada a @ref{6d1,,Enum} es el nombre de la enumeración.

El segundo argumento es el `source' de nombres de miembros de enumeración. Puede ser una cadena de nombres separados por espacios en blanco, una secuencia de nombres, una secuencia de 2 tuplas con pares clave/valor o una asignación (por ejemplo, un diccionario) de nombres a valores. Las dos últimas opciones permiten asignar valores arbitrarios a las enumeraciones; los otros asignan automáticamente números enteros crecientes que comienzan con 1 (use el parámetro @code{start} para especificar un valor inicial diferente). Se retorna una nueva clase derivada de @ref{6d1,,Enum}. En otras palabras, la asignación anterior a @code{Animal} es equivalente a:

@example
>>> class Animal(Enum):
...     ANT = 1
...     BEE = 2
...     CAT = 3
...     DOG = 4
...
@end example

La razón por la que se toma por defecto @code{1} como el número inicial y no @code{0} es que @code{0} es @code{False} en un sentido booleano, pero por defecto todos los miembros de la enumeración se evalúan como @code{True}.

Deserializar las enumeraciones creadas con la API funcional puede ser complicado, ya que los detalles de implementación de la pila de marcos se usan para tratar de averiguar en qué módulo se está creando la enumeración (por ejemplo, fallará si usa una función de utilidad en un módulo separado, y también puede no trabajar en IronPython o Jython). La solución es especificar el nombre del módulo explícitamente de la siguiente manera:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)
@end example

@cartouche
@quotation Advertencia 
Si no se proporciona @code{module} y Enum no puede determinar de qué se trata, los nuevos miembros de Enum no serán seleccionables; para mantener los errores más cerca de la fuente, se desactivará el decapado.
@end quotation
@end cartouche

The new pickle protocol 4 also, in some circumstances, relies on
@ref{1f25,,__qualname__} being set to the location where pickle will be able
to find the class.  For example, if the class was made available in class
SomeData in the global scope:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')
@end example

La firma completa es:

@example
Enum(
    value='NewEnumName',
    names=<...>,
    *,
    module='...',
    qualname='...',
    type=<mixed-in class>,
    start=1,
    )
@end example


@itemize *

@item 
`value': What the new enum class will record as its name.

@item 
`names': The enum members.  This can be a whitespace- or comma-separated string
(values will start at 1 unless otherwise specified):

@example
'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'
@end example

o un iterador de nombres:

@example
['RED', 'GREEN', 'BLUE']
@end example

o un iterador de (nombre, valor) pares:

@example
[('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]
@end example

o un mapeo:

@example
@{'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42@}
@end example

@item 
`module': name of module where new enum class can be found.

@item 
`qualname': where in module new enum class can be found.

@item 
`type': type to mix in to new enum class.

@item 
`start': number to start counting at if only names are passed in.
@end itemize


Distinto en la versión 3.5: Se agregó el parámetro `start'.


@node Enumeraciones derivadas,Cuándo usar __new__ frente a __init__,API funcional<2>,HOWTO - Enum
@anchor{howto/enum derived-enumerations}@anchor{4e5a}
@subsection Enumeraciones derivadas


@menu
* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Bandera:: 
* Otros: Otros<2>. 

@end menu

@node IntEnum,StrEnum,,Enumeraciones derivadas
@anchor{howto/enum intenum}@anchor{4e51}
@subsubsection IntEnum


La primera variación de @ref{6d1,,Enum} que se proporciona también es una subclase de @ref{1f0,,int}. Los miembros de un @ref{d66,,IntEnum} se pueden comparar con números enteros; por extensión, las enumeraciones enteras de diferentes tipos también se pueden comparar entre sí:

@example
>>> from enum import IntEnum
>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Request(IntEnum):
...     POST = 1
...     GET = 2
...
>>> Shape == 1
False
>>> Shape.CIRCLE == 1
True
>>> Shape.CIRCLE == Request.POST
True
@end example

Sin embargo, aún no se pueden comparar con las enumeraciones @ref{6d1,,Enum} estándar:

@example
>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...
>>> Shape.CIRCLE == Color.RED
False
@end example

Los valores @ref{d66,,IntEnum} se comportan como números enteros en otras formas que esperaría:

@example
>>> int(Shape.CIRCLE)
1
>>> ['a', 'b', 'c'][Shape.CIRCLE]
'b'
>>> [i for i in range(Shape.SQUARE)]
[0, 1]
@end example

@node StrEnum,IntFlag,IntEnum,Enumeraciones derivadas
@anchor{howto/enum strenum}@anchor{4e5b}
@subsubsection StrEnum


La segunda variación de @ref{6d1,,Enum} que se proporciona también es una subclase de @ref{237,,str}. Los miembros de un @ref{6bb,,StrEnum} se pueden comparar con cadenas; por extensión, las enumeraciones de cadenas de diferentes tipos también se pueden comparar entre sí.


Added in version 3.11.


@node IntFlag,Bandera,StrEnum,Enumeraciones derivadas
@anchor{howto/enum intflag}@anchor{4e5c}
@subsubsection IntFlag


La siguiente variación de @ref{6d1,,Enum} proporcionada, @ref{22fd,,IntFlag}, también se basa en @ref{1f0,,int}. La diferencia es que los miembros @ref{22fd,,IntFlag} se pueden combinar usando los operadores bit a bit (&, |, ^, ~) y el resultado sigue siendo un miembro @ref{22fd,,IntFlag}, si es posible. Al igual que @ref{d66,,IntEnum}, los miembros @ref{22fd,,IntFlag} también son números enteros y se pueden utilizar siempre que se utilice un @ref{1f0,,int}.

@cartouche
@quotation Nota 
Cualquier operación en un miembro @ref{22fd,,IntFlag} además de las operaciones bit a bit perderá la pertenencia a @ref{22fd,,IntFlag}.

Las operaciones bit a bit que den como resultado valores @ref{22fd,,IntFlag} no válidos perderán la pertenencia a @ref{22fd,,IntFlag}. Ver @ref{6c5,,FlagBoundary} para más detalles.
@end quotation
@end cartouche


Added in version 3.6.



Distinto en la versión 3.11.


Ejemplo de clase @ref{22fd,,IntFlag}:

@example
>>> from enum import IntFlag
>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...
>>> Perm.R | Perm.W
<Perm.R|W: 6>
>>> Perm.R + Perm.W
6
>>> RW = Perm.R | Perm.W
>>> Perm.R in RW
True
@end example

También es posible nombrar las combinaciones:

@example
>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...     RWX = 7
...
>>> Perm.RWX
<Perm.RWX: 7>
>>> ~Perm.RWX
<Perm: 0>
>>> Perm(7)
<Perm.RWX: 7>
@end example

@cartouche
@quotation Nota 
Las combinaciones con nombre se consideran alias. Los alias no aparecen durante la iteración, pero se pueden devolver a partir de búsquedas por valor.
@end quotation
@end cartouche


Distinto en la versión 3.11.


Otra diferencia importante entre @ref{22fd,,IntFlag} y @ref{6d1,,Enum} es que si no se establecen banderas (el valor es 0), su evaluación booleana es @ref{bbf,,False}:

@example
>>> Perm.R & Perm.X
<Perm: 0>
>>> bool(Perm.R & Perm.X)
False
@end example

Debido a que los miembros @ref{22fd,,IntFlag} también son subclases de @ref{1f0,,int}, se pueden combinar con ellos (pero pueden perder la membresía @ref{22fd,,IntFlag}:

@example
>>> Perm.X | 4
<Perm.R|X: 5>

>>> Perm.X + 8
9
@end example

@cartouche
@quotation Nota 
El operador de negación, @code{~}, siempre retorna un miembro @ref{22fd,,IntFlag} con un valor positivo:

@example
>>> (~Perm.X).value == (Perm.R|Perm.W).value == 6
True
@end example
@end quotation
@end cartouche

Los miembros @ref{22fd,,IntFlag} también se pueden iterar sobre:

@example
>>> list(RW)
[<Perm.R: 4>, <Perm.W: 2>]
@end example


Added in version 3.11.


@node Bandera,Otros<2>,IntFlag,Enumeraciones derivadas
@anchor{howto/enum flag}@anchor{4e5d}
@subsubsection Bandera


La última variación es @ref{6c4,,Flag}. Al igual que @ref{22fd,,IntFlag}, los miembros de @ref{6c4,,Flag} se pueden combinar mediante los operadores bit a bit (&, |, ^, ~). A diferencia de @ref{22fd,,IntFlag}, no se pueden combinar ni comparar con ninguna otra enumeración @ref{6c4,,Flag} ni con @ref{1f0,,int}. Si bien es posible especificar los valores directamente, se recomienda usar @ref{d25,,auto} como valor y dejar que @ref{6c4,,Flag} seleccione un valor apropiado.


Added in version 3.6.


Al igual que @ref{22fd,,IntFlag}, si una combinación de miembros @ref{6c4,,Flag} da como resultado que no se establezcan indicadores, la evaluación booleana es @ref{bbf,,False}:

@example
>>> from enum import Flag, auto
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.RED & Color.GREEN
<Color: 0>
>>> bool(Color.RED & Color.GREEN)
False
@end example

Las banderas individuales deben tener valores que sean potencias de dos (1, 2, 4, 8, …), mientras que las combinaciones de banderas no:

@example
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...     WHITE = RED | BLUE | GREEN
...
>>> Color.WHITE
<Color.WHITE: 7>
@end example

Dar un nombre a la condición «sin banderas establecidas» no cambia su valor booleano:

@example
>>> class Color(Flag):
...     BLACK = 0
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.BLACK
<Color.BLACK: 0>
>>> bool(Color.BLACK)
False
@end example

Los miembros @ref{6c4,,Flag} también se pueden iterar sobre:

@example
>>> purple = Color.RED | Color.BLUE
>>> list(purple)
[<Color.RED: 1>, <Color.BLUE: 2>]
@end example


Added in version 3.11.


@cartouche
@quotation Nota 
Para la mayoría del código nuevo, se recomienda encarecidamente @ref{6d1,,Enum} y @ref{6c4,,Flag}, ya que @ref{d66,,IntEnum} y @ref{22fd,,IntFlag} rompen algunas promesas semánticas de una enumeración (al ser comparables con los números enteros y, por lo tanto, por la transitividad a otras enumeraciones no relacionadas). @ref{d66,,IntEnum} y @ref{22fd,,IntFlag} deben usarse solo en los casos en que @ref{6d1,,Enum} y @ref{6c4,,Flag} no sirvan; por ejemplo, cuando las constantes enteras se reemplazan con enumeraciones, o para la interoperabilidad con otros sistemas.
@end quotation
@end cartouche

@node Otros<2>,,Bandera,Enumeraciones derivadas
@anchor{howto/enum others}@anchor{4e5e}
@subsubsection Otros


Si bien @ref{d66,,IntEnum} es parte del módulo @ref{56,,enum}, sería muy simple de implementar de forma independiente:

@example
class IntEnum(int, ReprEnum):   # or Enum instead of ReprEnum
    pass
@end example

Esto demuestra cómo se pueden definir enumeraciones derivadas similares; por ejemplo, un @code{FloatEnum} que se mezcla en @ref{153,,float} en lugar de @ref{1f0,,int}.

Algunas reglas:


@enumerate 

@item 
When subclassing @ref{6d1,,Enum}, mix-in types must appear before the
@ref{6d1,,Enum} class itself in the sequence of bases, as in the @ref{d66,,IntEnum}
example above.

@item 
Los tipos mixtos deben ser subclasificables. Por ejemplo, @ref{513,,bool} y @ref{9d6,,range} no son subclasificables y generarán un error durante la creación de Enum si se usan como tipo de combinación.

@item 
Si bien @ref{6d1,,Enum} puede tener miembros de cualquier tipo, una vez que mezcle un tipo adicional, todos los miembros deben tener valores de ese tipo, p. @ref{1f0,,int} anterior. Esta restricción no se aplica a los complementos que solo agregan métodos y no especifican otro tipo.

@item 
Cuando se mezcla otro tipo de datos, el atributo @code{value} es `not the same' como el propio miembro de la enumeración, aunque es equivalente y se comparará igual.

@item 
Un @code{data type} es un mixin que define @code{__new__()}, o una @ref{32e,,dataclass}

@item 
Formato de estilo %: @code{%s} y @code{%r} llaman a @code{__str__()} y @code{__repr__()} de la clase @ref{6d1,,Enum} respectivamente; otros códigos (como @code{%i} o @code{%h} para IntEnum) tratan el miembro de enumeración como su tipo mixto.

@item 
@ref{a3b,,Formatted string literals}, @ref{6c2,,str.format()} y @ref{6c0,,format()} usarán el método @code{__str__()} de la enumeración.
@end enumerate

@cartouche
@quotation Nota 
Dado que @ref{d66,,IntEnum}, @ref{22fd,,IntFlag} y @ref{6bb,,StrEnum} están diseñados para ser reemplazos directos de constantes existentes, su método @code{__str__()} se ha restablecido al método @code{__str__()} de sus tipos de datos.
@end quotation
@end cartouche

@node Cuándo usar __new__ frente a __init__,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?,Enumeraciones derivadas,HOWTO - Enum
@anchor{howto/enum new-vs-init}@anchor{4e55}@anchor{howto/enum when-to-use-new-vs-init}@anchor{4e5f}
@subsection Cuándo usar @code{__new__()} frente a @code{__init__()}


@code{__new__()} debe usarse siempre que desee personalizar el valor real del miembro @ref{6d1,,Enum}. Cualquier otra modificación puede ir en @code{__new__()} o @code{__init__()}, siendo preferible @code{__init__()}.

Por ejemplo, si desea pasar varios elementos al constructor, pero solo desea que uno de ellos sea el valor:

@example
>>> class Coordinate(bytes, Enum):
...     """
...     Coordinate with binary codes that can be indexed by the int code.
...     """
...     def __new__(cls, value, label, unit):
...         obj = bytes.__new__(cls, [value])
...         obj._value_ = value
...         obj.label = label
...         obj.unit = unit
...         return obj
...     PX = (0, 'P.X', 'km')
...     PY = (1, 'P.Y', 'km')
...     VX = (2, 'V.X', 'km/s')
...     VY = (3, 'V.Y', 'km/s')
...

>>> print(Coordinate['PY'])
Coordinate.PY

>>> print(Coordinate(3))
Coordinate.VY
@end example

@cartouche
@quotation Advertencia 
`No' llame a @code{super().__new__()}, ya que encontrará el @code{__new__} de solo búsqueda; en su lugar, utilice directamente el tipo de datos.
@end quotation
@end cartouche

@menu
* Puntos más finos:: 

@end menu

@node Puntos más finos,,,Cuándo usar __new__ frente a __init__
@anchor{howto/enum finer-points}@anchor{4e60}
@subsubsection Puntos más finos


@menu
* Nombres __dunder__ admitidos:: 
* Nombres _sunder_ admitidos:: 
* _Private__names:: 
* Tipo de miembro Enum:: 
* Creación de miembros que se mezclan con otros tipos de datos:: 
* Valor booleano de clases y miembros Enum:: 
* Clases Enum con métodos:: 
* Combinación de miembros de Flag:: 
* Minuciosidades Flag y IntFlag:: 

@end menu

@node Nombres __dunder__ admitidos,Nombres _sunder_ admitidos,,Puntos más finos
@anchor{howto/enum supported-dunder-names}@anchor{4e61}
@subsubsection Nombres @code{__dunder__} admitidos


@code{__members__} es una asignación ordenada de solo lectura de elementos @code{member_name}:@code{member}. Solo está disponible en la clase.

@code{__new__()}, si se especifica, debe crear y devolver los miembros de enumeración; también es una muy buena idea configurar correctamente el @code{_value_} del miembro. Una vez que se crean todos los miembros, ya no se utiliza.

@node Nombres _sunder_ admitidos,_Private__names,Nombres __dunder__ admitidos,Puntos más finos
@anchor{howto/enum supported-sunder-names}@anchor{4e62}
@subsubsection Nombres @code{_sunder_} admitidos



@itemize -

@item 
@ref{25c3,,_name_} – name of the member

@item 
@ref{25c4,,_value_} – value of the member; can be set in @code{__new__}

@item 
@ref{25cb,,_missing_()} – a lookup function used when a value is not found;
may be overridden

@item 
@ref{25c6,,_ignore_} – a list of names, either as a @ref{18e,,list} or a
@ref{237,,str}, that will not be transformed into members, and will be removed
from the final class

@item 
@ref{25c8,,_generate_next_value_()} – used to get an appropriate value for
an enum member; may be overridden

@item 
@code{_add_alias_()} – adds a new name as an alias to an existing
member.

@item 
@code{_add_value_alias_()} – adds a new value as an alias to an
existing member.  See @ref{4e63,,MultiValueEnum} for an example.

@cartouche
@quotation Nota 
For standard @ref{6d1,,Enum} classes the next value chosen is the highest
value seen incremented by one.

For @ref{6c4,,Flag} classes the next value chosen will be the next highest
power-of-two.
@end quotation
@end cartouche


Distinto en la versión 3.13: Prior versions would use the last seen value instead of the highest value.

@end itemize


Added in version 3.6: @code{_missing_}, @code{_order_}, @code{_generate_next_value_}



Added in version 3.7: @code{_ignore_}



Added in version 3.13: @code{_add_alias_}, @code{_add_value_alias_}


Para ayudar a mantener sincronizado el código de Python 2/Python 3, se puede proporcionar un atributo @code{_order_}. Se comparará con el orden real de la enumeración y lanzará un error si los dos no coinciden:

@example
>>> class Color(Enum):
...     _order_ = 'RED GREEN BLUE'
...     RED = 1
...     BLUE = 3
...     GREEN = 2
...
Traceback (most recent call last):
...
TypeError: member order does not match _order_:
  ['RED', 'BLUE', 'GREEN']
  ['RED', 'GREEN', 'BLUE']
@end example

@cartouche
@quotation Nota 
En el código de Python 2, el atributo @code{_order_} es necesario ya que el orden de definición se pierde antes de que se pueda registrar.
@end quotation
@end cartouche

@node _Private__names,Tipo de miembro Enum,Nombres _sunder_ admitidos,Puntos más finos
@anchor{howto/enum private-names}@anchor{4e64}
@subsubsection _Private__names


@ref{1cc1,,Private names} no se convierten en miembros de enumeración, sino que siguen siendo atributos normales.


Distinto en la versión 3.11.


@node Tipo de miembro Enum,Creación de miembros que se mezclan con otros tipos de datos,_Private__names,Puntos más finos
@anchor{howto/enum enum-member-type}@anchor{4e65}
@subsubsection Tipo de miembro @code{Enum}


Los miembros de una enumeración son instancias de su clase de enumeración y se acceden normalmente como @code{EnumClass.member}.  En ciertas situaciones, como al escribir comportamiento personalizado para una enumeración, es útil poder acceder a un miembro directamente desde otro, y esto está soportado; sin embargo, para evitar conflictos de nombres entre los nombres de los miembros y los atributos/métodos de las clases mezcladas, se recomienda encarecidamente utilizar nombres en mayúsculas.


Distinto en la versión 3.5.


@node Creación de miembros que se mezclan con otros tipos de datos,Valor booleano de clases y miembros Enum,Tipo de miembro Enum,Puntos más finos
@anchor{howto/enum creating-members-that-are-mixed-with-other-data-types}@anchor{4e66}
@subsubsection Creación de miembros que se mezclan con otros tipos de datos


Al crear subclases de otros tipos de datos, como @ref{1f0,,int} o @ref{237,,str}, con un @ref{6d1,,Enum}, todos los valores después de @code{=} se pasan al constructor de ese tipo de datos. Por ejemplo:

@example
>>> class MyEnum(IntEnum):      # help(int) -> int(x, base=10) -> integer
...     example = '11', 16      # so x='11' and base=16
...
>>> MyEnum.example.value        # and hex(11) is...
17
@end example

@node Valor booleano de clases y miembros Enum,Clases Enum con métodos,Creación de miembros que se mezclan con otros tipos de datos,Puntos más finos
@anchor{howto/enum boolean-value-of-enum-classes-and-members}@anchor{4e67}
@subsubsection Valor booleano de clases y miembros @code{Enum}


Las clases de enumeración que se mezclan con tipos que no son @ref{6d1,,Enum} (como @ref{1f0,,int}, @ref{237,,str}, etc.) se evalúan de acuerdo con las reglas del tipo combinado; de lo contrario, todos los miembros se evalúan como @ref{c95,,True}. Para hacer que la evaluación booleana de su propia enumeración dependa del valor del miembro, agregue lo siguiente a su clase:

@example
def __bool__(self):
    return bool(self.value)
@end example

Las clases simples @ref{6d1,,Enum} siempre se evalúan como @ref{c95,,True}.

@node Clases Enum con métodos,Combinación de miembros de Flag,Valor booleano de clases y miembros Enum,Puntos más finos
@anchor{howto/enum enum-classes-with-methods}@anchor{4e68}
@subsubsection Clases @code{Enum} con métodos


Si le da a su subclase de enumeración métodos adicionales, como la clase @ref{4e54,,Planet} a continuación, esos métodos aparecerán en un @ref{6d3,,dir()} del miembro, pero no de la clase:

@example
>>> dir(Planet)                         
['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
>>> dir(Planet.EARTH)                   
['__class__', '__doc__', '__module__', 'mass', 'name', 'radius', 'surface_gravity', 'value']
@end example

@node Combinación de miembros de Flag,Minuciosidades Flag y IntFlag,Clases Enum con métodos,Puntos más finos
@anchor{howto/enum combining-members-of-flag}@anchor{4e69}
@subsubsection Combinación de miembros de @code{Flag}


La iteración sobre una combinación de miembros @ref{6c4,,Flag} solo devolverá los miembros que se componen de un solo bit:

@example
>>> class Color(Flag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...     MAGENTA = RED | BLUE
...     YELLOW = RED | GREEN
...     CYAN = GREEN | BLUE
...
>>> Color(3)  # named combination
<Color.YELLOW: 3>
>>> Color(7)      # not named combination
<Color.RED|GREEN|BLUE: 7>
@end example

@node Minuciosidades Flag y IntFlag,,Combinación de miembros de Flag,Puntos más finos
@anchor{howto/enum flag-and-intflag-minutia}@anchor{4e6a}
@subsubsection Minuciosidades @code{Flag} y @code{IntFlag}


Usando el siguiente fragmento para nuestros ejemplos:

@example
>>> class Color(IntFlag):
...     BLACK = 0
...     RED = 1
...     GREEN = 2
...     BLUE = 4
...     PURPLE = RED | BLUE
...     WHITE = RED | GREEN | BLUE
...
@end example

lo siguiente es cierto:


@itemize -

@item 
las banderas de un solo bit son canónicas

@item 
las banderas multibit y zero-bit son alias

@item 
solo se retornan banderas canónicas durante la iteración:

@example
>>> list(Color.WHITE)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

@item 
negar una bandera o un conjunto de banderas retorna una nueva bandera/conjunto de banderas con el valor entero positivo correspondiente:

@example
>>> Color.BLUE
<Color.BLUE: 4>

>>> ~Color.BLUE
<Color.RED|GREEN: 3>
@end example

@item 
los nombres de las pseudo-banderas se construyen a partir de los nombres de sus miembros:

@example
>>> (Color.RED | Color.GREEN).name
'RED|GREEN'

>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...
>>> (Perm.R & Perm.W).name is None  # effectively Perm(0)
True
@end example

@item 
las banderas de varios bits, también conocidas como alias, se pueden devolver desde las operaciones:

@example
>>> Color.RED | Color.BLUE
<Color.PURPLE: 5>

>>> Color(7)  # or Color(-1)
<Color.WHITE: 7>

>>> Color(0)
<Color.BLACK: 0>
@end example

@item 
comprobación de pertenencia / contención: las banderas de valor cero siempre se consideran contenidas:

@example
>>> Color.BLACK in Color.WHITE
True
@end example

de lo contrario, solo si todos los bits de una bandera están en la otra bandera, se devolverá True:

@example
>>> Color.PURPLE in Color.WHITE
True

>>> Color.GREEN in Color.PURPLE
False
@end example
@end itemize

Hay un nuevo mecanismo de límite que controla cómo se manejan los bits no válidos/fuera de rango: @code{STRICT}, @code{CONFORM}, @code{EJECT} y @code{KEEP}:


@itemize *

@item 
STRICT –> lanza una excepción cuando se presentan valores no válidos

@item 
CONFORM –> descarta cualquier bit inválido

@item 
EJECT -> pierde el estado de la bandera y se convierte en un int normal con el valor dado

@item 
KEEP –> mantener los bits adicionales


@itemize -

@item 
mantiene el estado de la bandera y bits adicionales

@item 
los bits adicionales no aparecen en la iteración

@item 
bits adicionales aparecen en repr() y str()
@end itemize
@end itemize

El valor predeterminado para Flag es @code{STRICT}, el valor predeterminado para @code{IntFlag} es @code{EJECT} y el valor predeterminado para @code{_convert_} es @code{KEEP} (consulte @code{ssl.Options} para ver un ejemplo de cuándo se necesita @code{KEEP}).

@node ¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?,Recetario de Enumeraciones,Cuándo usar __new__ frente a __init__,HOWTO - Enum
@anchor{howto/enum enum-class-differences}@anchor{25af}@anchor{howto/enum how-are-enums-and-flags-different}@anchor{4e6b}
@subsection ¿En qué se diferencian las Enumeraciones (Enums) y las Banderas (Flags)?


Las enumeraciones tienen una metaclase personalizada que afecta a muchos aspectos de las clases @ref{6d1,,Enum} derivadas y sus instancias (miembros).

@menu
* Clases de enumeración:: 
* Clases de Banderas:: 
* Miembros de enumeración (también conocidos como instancias): Miembros de enumeración también conocidos como instancias. 
* Miembros de Banderas:: 

@end menu

@node Clases de enumeración,Clases de Banderas,,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?
@anchor{howto/enum enum-classes}@anchor{4e6c}
@subsubsection Clases de enumeración


La metaclase @ref{6ba,,EnumType} es responsable de proporcionar @code{__contains__()}, @code{__dir__()}, @code{__iter__()} y otros métodos que permiten hacer cosas con una clase @ref{6d1,,Enum} que fallan en una clase típica, como @code{list(Color)} o @code{some_enum_var in Color}. @ref{6ba,,EnumType} es responsable de garantizar que varios otros métodos en la clase @ref{6d1,,Enum} final sean correctos (como @code{__new__()}, @code{__getnewargs__()}, @code{__str__()} y @code{__repr__()}).

@node Clases de Banderas,Miembros de enumeración también conocidos como instancias,Clases de enumeración,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?
@anchor{howto/enum flag-classes}@anchor{4e6d}
@subsubsection Clases de Banderas


Las banderas tienen una vista ampliada de la creación de alias: para ser canónico, el valor de una bandera debe ser un valor de potencia de dos y no un nombre duplicado.  Por lo tanto, además de la definición de alias de @ref{6d1,,Enum}, una bandera sin valor (también conocida como @code{0}) o con más de un valor de potencia de dos (por ejemplo, @code{3}) se considera un alias.

@node Miembros de enumeración también conocidos como instancias,Miembros de Banderas,Clases de Banderas,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?
@anchor{howto/enum enum-members-aka-instances}@anchor{4e6e}
@subsubsection Miembros de enumeración (también conocidos como instancias)


Lo más interesante de los miembros de la enumeración es que son únicos. @ref{6ba,,EnumType} los crea a todos mientras crea la propia clase de enumeración, y luego coloca un @code{__new__()} personalizado para garantizar que nunca se creen instancias nuevas al devolver solo las instancias de miembros existentes.

@node Miembros de Banderas,,Miembros de enumeración también conocidos como instancias,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?
@anchor{howto/enum flag-members}@anchor{4e6f}
@subsubsection Miembros de Banderas


Los miembros de las Banderas se pueden recorrer de la misma manera que la clase @ref{6c4,,Flag}, y solo se devolverán los miembros canónicos.  Por ejemplo:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

(Note que @code{BLACK}, @code{PURPLE}, y @code{WHITE} no se muestran.)

Invertir un miembro de la bandera devuelve el valor positivo correspondiente, en lugar de un valor negativo — por ejemplo:

@example
>>> ~Color.RED
<Color.GREEN|BLUE: 6>
@end example

Los miembros de las Banderas tienen una longitud que corresponde al número de valores de potencia de dos que contienen.  Por ejemplo:

@example
>>> len(Color.PURPLE)
2
@end example

@node Recetario de Enumeraciones,Subclase EnumType,¿En qué se diferencian las Enumeraciones Enums y las Banderas Flags ?,HOWTO - Enum
@anchor{howto/enum enum-cookbook}@anchor{25ae}@anchor{howto/enum id2}@anchor{4e70}
@subsection Recetario de Enumeraciones


Si bien se espera que @ref{6d1,,Enum}, @ref{d66,,IntEnum}, @ref{6bb,,StrEnum}, @ref{6c4,,Flag} y @ref{22fd,,IntFlag} cubran la mayoría de los casos de uso, no pueden cubrirlos todos. Aquí hay recetas para algunos tipos diferentes de enumeraciones que se pueden usar directamente o como ejemplos para crear las propias.

@menu
* Omitir valores:: 
* Enum ordenado:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planeta:: 
* Periodo de tiempo:: 

@end menu

@node Omitir valores,Enum ordenado,,Recetario de Enumeraciones
@anchor{howto/enum omitting-values}@anchor{4e71}
@subsubsection Omitir valores


En muchos casos de uso, a uno no le importa cuál es el valor real de una enumeración. Hay varias formas de definir este tipo de enumeración simple:


@itemize -

@item 
usar instancias de @ref{d25,,auto} para el valor

@item 
usar instancias de @ref{b18,,object} como valor

@item 
use una cadena descriptiva como el valor

@item 
use una tupla como valor y un @code{__new__()} personalizado para reemplazar la tupla con un valor @ref{1f0,,int}
@end itemize

El uso de cualquiera de estos métodos significa para el usuario que estos valores no son importantes y también permite agregar, eliminar o reordenar miembros sin tener que volver a numerar los miembros restantes.

@menu
* Usando auto:: 
* Usando object:: 
* Usar una cadena descriptiva:: 
* Usando un __new__() personalizado: Usando un __new__ personalizado. 

@end menu

@node Usando auto,Usando object,,Omitir valores
@anchor{howto/enum using-auto}@anchor{4e72}
@subsubsection Usando @code{auto}


El uso de @ref{d25,,auto} se vería así:

@example
>>> class Color(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.GREEN
<Color.GREEN: 3>
@end example

@node Usando object,Usar una cadena descriptiva,Usando auto,Omitir valores
@anchor{howto/enum using-object}@anchor{4e73}
@subsubsection Usando @code{object}


El uso de @ref{b18,,object} se vería así:

@example
>>> class Color(Enum):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...
>>> Color.GREEN                         
<Color.GREEN: <object object at 0x...>>
@end example

Este también es un buen ejemplo de por qué es posible que desee escribir su propio @code{__repr__()}:

@example
>>> class Color(Enum):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...     def __repr__(self):
...         return "<%s.%s>" % (self.__class__.__name__, self._name_)
...
>>> Color.GREEN
<Color.GREEN>
@end example

@node Usar una cadena descriptiva,Usando un __new__ personalizado,Usando object,Omitir valores
@anchor{howto/enum using-a-descriptive-string}@anchor{4e74}
@subsubsection Usar una cadena descriptiva


Usando una cadena como el valor se vería así:

@example
>>> class Color(Enum):
...     RED = 'stop'
...     GREEN = 'go'
...     BLUE = 'too fast!'
...
>>> Color.GREEN
<Color.GREEN: 'go'>
@end example

@node Usando un __new__ personalizado,,Usar una cadena descriptiva,Omitir valores
@anchor{howto/enum using-a-custom-new}@anchor{4e75}
@subsubsection Usando un @code{__new__()} personalizado


El uso de un @code{__new__()} de numeración automática se vería así:

@example
>>> class AutoNumber(Enum):
...     def __new__(cls):
...         value = len(cls.__members__) + 1
...         obj = object.__new__(cls)
...         obj._value_ = value
...         return obj
...
>>> class Color(AutoNumber):
...     RED = ()
...     GREEN = ()
...     BLUE = ()
...
>>> Color.GREEN
<Color.GREEN: 2>
@end example

Para hacer un @code{AutoNumber} de uso más general, agregue @code{*args} a la firma:

@example
>>> class AutoNumber(Enum):
...     def __new__(cls, *args):      # this is the only change from above
...         value = len(cls.__members__) + 1
...         obj = object.__new__(cls)
...         obj._value_ = value
...         return obj
...
@end example

Luego, cuando hereda de @code{AutoNumber}, puede escribir su propio @code{__init__} para manejar cualquier argumento adicional:

@example
>>> class Swatch(AutoNumber):
...     def __init__(self, pantone='unknown'):
...         self.pantone = pantone
...     AUBURN = '3497'
...     SEA_GREEN = '1246'
...     BLEACHED_CORAL = () # New color, no Pantone code yet!
...
>>> Swatch.SEA_GREEN
<Swatch.SEA_GREEN: 2>
>>> Swatch.SEA_GREEN.pantone
'1246'
>>> Swatch.BLEACHED_CORAL.pantone
'unknown'
@end example

@cartouche
@quotation Nota 
El método @code{__new__()}, si está definido, se usa durante la creación de los miembros de Enum; luego se reemplaza por @code{__new__()} de Enum, que se usa después de la creación de clases para buscar miembros existentes.
@end quotation
@end cartouche

@cartouche
@quotation Advertencia 
`No' llame a @code{super().__new__()}, ya que encontrará el @code{__new__} de solo búsqueda; en su lugar, utilice directamente el tipo de datos – por ejemplo:

@example
obj = int.__new__(cls, value)
@end example
@end quotation
@end cartouche

@node Enum ordenado,DuplicateFreeEnum,Omitir valores,Recetario de Enumeraciones
@anchor{howto/enum orderedenum}@anchor{4e57}
@subsubsection Enum ordenado


Una enumeración ordenada que no se basa en @ref{d66,,IntEnum} y, por lo tanto, mantiene las invariantes normales de @ref{6d1,,Enum} (como no ser comparable con otras enumeraciones):

@example
>>> class OrderedEnum(Enum):
...     def __ge__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value >= other.value
...         return NotImplemented
...     def __gt__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value > other.value
...         return NotImplemented
...     def __le__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value <= other.value
...         return NotImplemented
...     def __lt__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value < other.value
...         return NotImplemented
...
>>> class Grade(OrderedEnum):
...     A = 5
...     B = 4
...     C = 3
...     D = 2
...     F = 1
...
>>> Grade.C < Grade.A
True
@end example

@node DuplicateFreeEnum,MultiValueEnum,Enum ordenado,Recetario de Enumeraciones
@anchor{howto/enum duplicatefreeenum}@anchor{4e76}
@subsubsection DuplicateFreeEnum


Lanza un error si se encuentra un nombre de miembro duplicado en lugar de crear un alias:

@example
>>> class DuplicateFreeEnum(Enum):
...     def __init__(self, *args):
...         cls = self.__class__
...         if any(self.value == e.value for e in cls):
...             a = self.name
...             e = cls(self.value).name
...             raise ValueError(
...                 "aliases not allowed in DuplicateFreeEnum:  %r --> %r"
...                 % (a, e))
...
>>> class Color(DuplicateFreeEnum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
...     GRENE = 2
...
Traceback (most recent call last):
  ...
ValueError: aliases not allowed in DuplicateFreeEnum:  'GRENE' --> 'GREEN'
@end example

@cartouche
@quotation Nota 
Este es un ejemplo útil para subclasificar Enum para agregar o cambiar otros comportamientos, así como para no permitir alias. Si el único cambio deseado es prohibir los alias, se puede usar el decorador @ref{25b2,,unique()} en su lugar.
@end quotation
@end cartouche

@node MultiValueEnum,Planeta,DuplicateFreeEnum,Recetario de Enumeraciones
@anchor{howto/enum multivalueenum}@anchor{4e63}
@subsubsection MultiValueEnum


Supports having more than one value per member:

@example
>>> class MultiValueEnum(Enum):
...     def __new__(cls, value, *values):
...         self = object.__new__(cls)
...         self._value_ = value
...         for v in values:
...             self._add_value_alias_(v)
...         return self
...
>>> class DType(MultiValueEnum):
...     float32 = 'f', 8
...     double64 = 'd', 9
...
>>> DType('f')
<DType.float32: 'f'>
>>> DType(9)
<DType.double64: 'd'>
@end example

@node Planeta,Periodo de tiempo,MultiValueEnum,Recetario de Enumeraciones
@anchor{howto/enum planet}@anchor{4e54}
@subsubsection Planeta


Si se define @code{__new__()} o @code{__init__()}, el valor del miembro de enumeración se pasará a esos métodos:

@example
>>> class Planet(Enum):
...     MERCURY = (3.303e+23, 2.4397e6)
...     VENUS   = (4.869e+24, 6.0518e6)
...     EARTH   = (5.976e+24, 6.37814e6)
...     MARS    = (6.421e+23, 3.3972e6)
...     JUPITER = (1.9e+27,   7.1492e7)
...     SATURN  = (5.688e+26, 6.0268e7)
...     URANUS  = (8.686e+25, 2.5559e7)
...     NEPTUNE = (1.024e+26, 2.4746e7)
...     def __init__(self, mass, radius):
...         self.mass = mass       # in kilograms
...         self.radius = radius   # in meters
...     @@property
...     def surface_gravity(self):
...         # universal gravitational constant  (m3 kg-1 s-2)
...         G = 6.67300E-11
...         return G * self.mass / (self.radius * self.radius)
...
>>> Planet.EARTH.value
(5.976e+24, 6378140.0)
>>> Planet.EARTH.surface_gravity
9.802652743337129
@end example

@node Periodo de tiempo,,Planeta,Recetario de Enumeraciones
@anchor{howto/enum enum-time-period}@anchor{25c7}@anchor{howto/enum timeperiod}@anchor{4e77}
@subsubsection Periodo de tiempo


Un ejemplo para mostrar el atributo @code{_ignore_} en uso:

@example
>>> from datetime import timedelta
>>> class Period(timedelta, Enum):
...     "different lengths of time"
...     _ignore_ = 'Period i'
...     Period = vars()
...     for i in range(367):
...         Period['day_%d' % i] = i
...
>>> list(Period)[:2]
[<Period.day_0: datetime.timedelta(0)>, <Period.day_1: datetime.timedelta(days=1)>]
>>> list(Period)[-2:]
[<Period.day_365: datetime.timedelta(days=365)>, <Period.day_366: datetime.timedelta(days=366)>]
@end example

@node Subclase EnumType,,Recetario de Enumeraciones,HOWTO - Enum
@anchor{howto/enum enumtype-examples}@anchor{25b5}@anchor{howto/enum subclassing-enumtype}@anchor{4e78}
@subsection Subclase EnumType


Si bien la mayoría de las necesidades de enumeración se pueden satisfacer mediante la personalización de las subclases @ref{6d1,,Enum}, ya sea con decoradores de clase o funciones personalizadas, @ref{6ba,,EnumType} se puede dividir en subclases para proporcionar una experiencia de enumeración diferente.

@node HOWTO - Programación funcional,HOWTO hacer registros Logging,HOWTO - Enum,Comos HOWTOs de Python
@anchor{howto/functional doc}@anchor{4e79}@anchor{howto/functional functional-howto}@anchor{4e7a}@anchor{howto/functional functional-programming-howto}@anchor{4e7b}
@section HOWTO - Programación funcional


@*Autor: 
A. M. Kuchling


@*Publicación: 
0.32


En este documento, haremos un recorrido de las características de Python adecuadas para implementar programas en un estilo funcional. Después de una introducción de los conceptos de programación funcional, veremos las características del lenguaje como @ref{313,,iterador}es y @ref{10dd,,generador}es y módulos de librería relevantes como @ref{81,,itertools} y @ref{5f,,functools}.

@menu
* Introducción: Introducción<12>. 
* Iteradores: Iteradores<2>. 
* Expresiones generadoras y listas por comprensión:: 
* Generadores: Generadores<2>. 
* Funciones incorporadas: Funciones incorporadas<3>. 
* El módulo itertools:: 
* El módulo functools:: 
* Funciones pequeñas y la expresión lambda:: 
* Historia de revisiones y reconocimientos:: 
* Referencias: Referencias<2>. 

@end menu

@node Introducción<12>,Iteradores<2>,,HOWTO - Programación funcional
@anchor{howto/functional introduction}@anchor{4e7c}
@subsection Introducción


Esta sección explica el concepto básico de programación funcional; si solo está interesado en aprender acerca de las características del lenguaje Python, pase a la siguiente sección en @ref{4e7d,,iteradores}.

Los lenguajes de programación soportan la descomposición de problemas en muchas formas diferentes:


@itemize *

@item 
La mayoría de los lenguajes de programación son `procedimentales': los programas son listas de instrucciones que le dicen a la computadora qué hacer con la entrada del programa. C, Pascal e incluso las terminales Unix son lenguajes procedimentales.

@item 
En los lenguajes `declarativos', se escribe una especificación que describe el problema que se resolverá, y la implementación del lenguaje averigua como realizar el cálculo de forma eficiente. SQL es el lenguaje declarativo con el que probablemente esté más familiarizado; una consulta SQL describe el conjunto de datos que quiere recuperar, y el motor SQL decide si escanear tablas o usar índices, qué subcláusulas deben ejecutarse primero, etc.

@item 
Los programas `orientados a objetos' manipulan colecciones de objetos. Los objetos tienen estado interno y soportan métodos que consultan o modifican su estado interno de alguna manera. Smalltalk y Java son lenguajes orientados a objetos. C++ y Python son lenguajes que soportan la programación orientada a objetos, pero no fuerzan el uso de las características orientadas a objetos.

@item 
La programación `funcional' descompone un problema en un conjunto de funciones. Idealmente, las funciones solo reciben entradas y producen salidas, y no tienen ningún estado interno que afecte la salida producida para una entrada dada. Los lenguajes funcionales bien conocidos incluyen la familia ML (Standard ML, OCaml, y otras variantes) y Haskell.
@end itemize

Los diseñadores de algunos lenguajes de computadora eligen enfatizar en un enfoque particular para programar. Esto a menudo hace difícil escribir programas que usen un enfoque diferente. Otros lenguajes son lenguajes multiparadigma que soportan varios enfoques diferentes. Lisp, C++ y Python son multiparadigma; puede escribir programas o librerías que son en gran parte procedimentales, orientados a objetos o funcionales en todos estos lenguajes. En un programa grande, las diferentes secciones podrían escribirse usando diferentes enfoques; la GUI podría ser orientada a objetos mientras la lógica de procesamiento es procedimental o funcional, por ejemplo.

En un programa funcional, la entrada fluye a través de un conjunto de funciones. Cada función opera sobre su entrada y produce alguna salida. El estilo funcional desalienta las funciones con efectos secundarios que modifican el estado interno o hacen otros cambios que no son visibles en el valor de retorno de la función. Las funciones que no tienen ningún efecto secundario se llaman `puramente funcionales'. Evitar los efectos secundarios significa no usar estructuras de datos que se actualicen mientras se ejecuta un programa; cada salida de la función debe depender solo de su entrada.

Algunos lenguajes son demasiado estrictos y ni siquiera tienen declaraciones de asignación como @code{a=3} o @code{c = a + b}, pero es difícil evitar todos los efectos secundarios, como imprimir en pantalla o escribir en un archivo de disco. Otro ejemplo es llamar a las funciones @ref{ff4,,print()} o @ref{73e,,time.sleep()}, ninguna de las dos retorna un valor útil, ambas son llamadas solo por sus efectos secundarios de enviar texto a la pantalla o pausar la ejecución por un segundo.

Los programas de Python escritos en estilo funcional usualmente no irán al extremo de evitar todas las E/S o todas las asignaciones; en cambio, proveerán una interfaz aparentemente funcional pero internamente usará características no funcionales. Por ejemplo, la implementación de una función todavía usará asignaciones a variables locales, pero no modificará variables globales ni tendrá otros efectos secundarios.

La programación funcional se puede considerar lo opuesto a la programación orientada a objetos. Los objetos son pequeñas capsulas que contienen algún estado interno junto con una colección de llamadas a métodos que le permiten modificar este estado, y los programas consisten en realizar el conjunto correcto de cambios de estado. La programación funcional quiere evitar cambios de estado tanto como sea posible y trabaja con flujos de datos entre funciones. En Python podría combinar los dos enfoques para escribir funciones que reciban y retornen instancias que representen objetos en su aplicación (mensajes de e-mail, transacciones, etc.).

El diseño funcional puede parecer una restricción extraña bajo la cuál trabajar. ¿Por qué evitaría objetos y efectos secundarios? Hay ventajas teóricas y prácticas para el estilo funcional:


@itemize *

@item 
Demostrabilidad formal.

@item 
Modularidad.

@item 
Componibilidad.

@item 
Facilidad de depurar y probar.
@end itemize

@menu
* Demostrabilidad formal:: 
* Modularidad:: 
* Facilidad de depurar y probar:: 
* Componibilidad:: 

@end menu

@node Demostrabilidad formal,Modularidad,,Introducción<12>
@anchor{howto/functional formal-provability}@anchor{4e7e}
@subsubsection Demostrabilidad formal


Un beneficio teórico es que es más fácil construir una demostración matemática de que un programa funcional es correcto.

Por un largo tiempo los investigadores se han interesado en buscar formas de demostrar matemáticamente que los programas son correctos. Esto es diferente de probar un programa sobre numerosas entradas y concluir que su salida es usualmente correcta, o leer el código fuente de un programa y concluir que el código se ve bien; en lugar de eso el objetivo es una demostración rigurosa de que un programa produce el resultado correcto para todas las entradas posibles.

La técnica utilizada para demostrar que los programas son correctos es anotar `invariantes', propiedades de los datos de entrada y de las variables del programa que siempre son verdaderas. Por cada línea de código, debe mostrar que si las invariantes X e Y son verdaderas `antes' que la línea sea ejecutada, las invariantes ligeramente diferentes X” e Y” son verdaderas `después' que la línea se ejecutó. Esto continúa hasta que alcance el fin del programa, punto en el cuál las invariantes deben coincidir con las condiciones deseadas en la salida del programa.

La evitación de las asignaciones de la programación funcional surge porque las asignaciones son difíciles de manejar con esta técnica; las asignaciones pueden romper invariantes que eran verdaderas antes de la asignación sin producir nuevas invariantes que se puedan propagar hacia adelante.

Desafortunadamente, demostrar que los programas son correctos es en gran parte impráctico y no relevante al software de Python. Incluso los programas triviales requieren demostraciones que tienen varias páginas; la demostración de correctitud para un programa moderadamente complicado sería enorme, y pocos o ninguno de los programas que usa diariamente (el interprete de Python, su analizador XML, su navegador web) se podrían demostrar que son correctos. Aún si anotó o generó una demostración, entonces estaría la cuestión de verificar la demostración; quizás hay un error en ella, y equivocadamente cree que demostró que el programa es correcto.

@node Modularidad,Facilidad de depurar y probar,Demostrabilidad formal,Introducción<12>
@anchor{howto/functional modularity}@anchor{4e7f}
@subsubsection Modularidad


Un beneficio más práctico de la programación funcional es que fuerza a romper su problema en pequeñas piezas. Como resultado los programas son más modulares. Es más fácil especificar y escribir una función pequeña que hace una cosa que una función grande que realiza una transformación complicada. Las funciones pequeñas también son más fáciles de leer y comprobar si hay errores.

@node Facilidad de depurar y probar,Componibilidad,Modularidad,Introducción<12>
@anchor{howto/functional ease-of-debugging-and-testing}@anchor{4e80}
@subsubsection Facilidad de depurar y probar


Probar y depurar un programa en estilo funcional es más fácil.

La depuración se simplifica porque las funciones generalmente son pequeñas y claramente especificadas. Cuando un programa no funciona, cada función es un punto de interfaz donde puede comprobar si los datos son correctos. Puede ver las entradas y salidas intermedias para aislar rápidamente la función que es responsable de un error.

Las pruebas son más fáciles porque cada función es un sujeto potencial para una prueba unitaria. Las funciones no dependen de un estado del sistema que necesite ser replicado antes de correr una prueba; en lugar de eso solo tiene que sintetizar la entrada correcta y comprobar que la salida coincida con las expectativas.

@node Componibilidad,,Facilidad de depurar y probar,Introducción<12>
@anchor{howto/functional composability}@anchor{4e81}
@subsubsection Componibilidad


Mientras trabaja en un programa en estilo funcional, escribirá un número de funciones con diferentes entradas y salidas. Algunas de estas funciones inevitablemente estarán especializadas en una aplicación en particular, pero otras serán útiles en una amplia variedad de programas. Por ejemplo, una función que recibe la ruta de un directorio y retorna todos los archivos XML en el directorio, o una función que recibe el nombre de un archivo y retorna su contenido, se puede aplicar a muchas situaciones diferentes.

Con el tiempo formará una librería personal de utilidades. A menudo ensamblará nuevos programas organizando funciones existentes en una nueva configuración y escribiendo unas pocas funciones especializadas para la tarea actual.

@node Iteradores<2>,Expresiones generadoras y listas por comprensión,Introducción<12>,HOWTO - Programación funcional
@anchor{howto/functional functional-howto-iterators}@anchor{4e7d}@anchor{howto/functional iterators}@anchor{4e82}
@subsection Iteradores


Comenzaré viendo una característica del lenguaje Python que es una base importante para escribir programas en estilo funcional: iteradores.

Un iterador es un objeto que representa un flujo de datos; este objeto retorna los datos de a un elemento a la vez. Un iterador de Python debe soportar un método llamado @ref{1335,,__next__()} que no recibe argumentos y siempre retorna el siguiente elemento en el flujo. Si no hay más elementos en el flujo, @ref{1335,,__next__()} debe lanzar la excepción @ref{c82,,StopIteration}. Los iteradores no tienen que ser finitos; es perfectamente razonable escribir un iterador que produce un flujo de datos infinito.

La función incorporada @ref{86e,,iter()} recibe un objeto arbitrario e intenta retornar un iterador que retornará los contenidos o elementos del objeto, lanzando @ref{228,,TypeError} si el objeto no soporta iteración. Muchos tipos de datos integrados de Python soportan iteración, siendo los más comunes las listas y los diccionarios. Un objeto se llama @ref{1294,,iterable} si puede obtener un iterador para él.

Puede experimentar con la interfaz de iteración manualmente:

@example
>>> L = [1, 2, 3]
>>> it = iter(L)
>>> it  
<...iterator object at ...>
>>> it.__next__()  # same as next(it)
1
>>> next(it)
2
>>> next(it)
3
>>> next(it)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration
>>>
@end example

Python espera objetos iterables en muchos contextos diferentes, siendo el más importante la sentencia @ref{1eb,,for}. En la sentencia @code{for X in Y}, Y debe ser un iterador o algún objeto para el que @ref{86e,,iter()} puede crear un iterador. Estas dos sentencias son equivalentes:

@example
for i in iter(obj):
    print(i)

for i in obj:
    print(i)
@end example

Los iteradores se pueden materializar como listas o tuplas utilizando las funciones constructoras @ref{18e,,list()} o @ref{464,,tuple()}:

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> t = tuple(iterator)
>>> t
(1, 2, 3)
@end example

El desempaquetado de secuencias también soporta iteradores: si sabe que un iterador retornará N elementos, puede desempaquetarlos en una N-tupla:

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> a, b, c = iterator
>>> a, b, c
(1, 2, 3)
@end example

Las funciones incorporadas como @ref{f8c,,max()} y @ref{f8b,,min()} pueden recibir un solo iterador como argumento y retornarán el elemento más grande o más pequeño. Los operadores @code{"in"} y @code{"not in"} también soportan iteradores: @code{X in iterator} es verdadero si X se encuentra en el flujo que retornó el iterador. Se encontrará con problemas obvios si el iterador es infinito; @ref{f8c,,max()}, @ref{f8b,,min()} nunca retornarán, y si el elemento X nunca aparece en el flujo, los operadores @code{"in"} y @code{"not in"} tampoco retornarán.

Note que solo puede ir hacia adelante en un iterador; no hay forma de obtener el elemento anterior, reiniciar el iterador o hacer una copia de él. Los objetos iteradores opcionalmente pueden proveer estas capacidades adicionales, pero el protocolo del iterador solo especifica el método @ref{1335,,__next__()}. Por lo tanto las funciones pueden consumir toda la salida del iterador, y si necesita hacer algo diferente con el mismo flujo, tendrá que crear un nuevo iterador.

@menu
* Tipos de datos que soportan iteradores:: 

@end menu

@node Tipos de datos que soportan iteradores,,,Iteradores<2>
@anchor{howto/functional data-types-that-support-iterators}@anchor{4e83}
@subsubsection Tipos de datos que soportan iteradores


Ya hemos visto cómo las listas y tuplas soportan iteradores. De hecho, cualquier tipo de secuencia de Python, como cadenas de caracteres, automáticamente soportará la creación de un iterador.

Llamar a @ref{86e,,iter()} en un diccionario retornará un iterador que recorrerá sobre las claves del diccionario:

@example
>>> m = @{'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12@}
>>> for key in m:
...     print(key, m[key])
Jan 1
Feb 2
Mar 3
Apr 4
May 5
Jun 6
Jul 7
Aug 8
Sep 9
Oct 10
Nov 11
Dec 12
@end example

Note que a partir de Python 3.7, se garantiza que el orden de iteración del diccionario es el mismo que el orden de inserción. En versiones anteriores, el comportamiento no estaba especificado y podía variar entre implementaciones.

Aplicar @ref{86e,,iter()} a un diccionario siempre recorre sobre las claves, pero los diccionarios tienen métodos que retornan otros iteradores. Si quiere iterar sobre valores o pares clave/valor, puede explícitamente llamar a los métodos @ref{867,,values()} o @ref{868,,items()} para obtener un iterador apropiado.

El constructor @ref{190,,dict()} puede aceptar un iterador que retorna un flujo finito de tuplas @code{(key, value)}:

@example
>>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')]
>>> dict(iter(L))
@{'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'@}
@end example

Los archivos también soportan iteración llamando al método @ref{1cc4,,readline()} hasta que no haya más líneas en el archivo. Esto significa que puede leer cada línea de un archivo de esta forma:

@example
for line in file:
    # do something for each line
    ...
@end example

Los conjuntos pueden recibir sus contenidos de un iterable y le permiten iterar sobre los elementos del conjunto:

@example
>>> S = @{2, 3, 5, 7, 11, 13@}
>>> for i in S:
...     print(i)
2
3
5
7
11
13
@end example

@node Expresiones generadoras y listas por comprensión,Generadores<2>,Iteradores<2>,HOWTO - Programación funcional
@anchor{howto/functional generator-expressions-and-list-comprehensions}@anchor{4e84}
@subsection Expresiones generadoras y listas por comprensión


Dos operaciones comunes en la salida de un iterador son 1) realizar alguna operación para cada elemento, 2) elegir un subconjunto de elementos que reúnen alguna condición. Por ejemplo, dada una lista de cadena de caracteres, podría querer remover los espacios finales de cada línea o extraer todas las cadenas de caracteres que contienen una subcadena de caracteres dada.

Las listas por comprensión y las expresiones generadoras (forma abreviada: «listcomps» y «genexps») son una notación concisa para tales operaciones, prestadas del lenguaje de programación funcional Haskell (@indicateurl{https://www.haskell.org/}). Puede remover todos los espacios de un flujo de cadena de caracteres con el siguiente código:

@example
>>> line_list = ['  line 1\n', 'line 2  \n', ' \n', '@w{'}]

>>> # Generator expression -- returns iterator
>>> stripped_iter = (line.strip() for line in line_list)

>>> # List comprehension -- returns list
>>> stripped_list = [line.strip() for line in line_list]
@end example

Puede seleccionar solo ciertos elementos agregando una condición @code{"if"}:

@example
>>> stripped_list = [line.strip() for line in line_list
...                  if line != ""]
@end example

Con una lista por comprensión, obtiene una lista de Python; @code{stripped_list} es una lista que contiene las líneas resultantes, no un iterador. Las expresiones generadoras retornan un iterador que calcula los valores cuando es necesario, sin necesidad de materializar todos los valores a la vez. Esto significa que las listas por comprensión son inútiles si está trabajando con iteradores que retornan un flujo infinito o una gran cantidad de datos. En estas situaciones son preferibles las expresiones generadoras.

Las expresiones generadoras están rodeadas por paréntesis («()») y las listas por comprensión están rodeadas por corchetes («[]»). Las expresiones generadoras tienen la forma:

@example
( expression for expr in sequence1
             if condition1
             for expr2 in sequence2
             if condition2
             for expr3 in sequence3
             ...
             if condition3
             for exprN in sequenceN
             if conditionN )
@end example

Nuevamente, para una lista por comprensión solo los corchetes exteriores son diferentes (corchetes en lugar de paréntesis).

Los elementos de la salida generada serán valores sucesivos de @code{expression}. Las cláusulas @code{if} son todas opcionales; si está presente, @code{expression} es solo evaluado y añadido al resultado cuando @code{condition} es verdadero.

Las expresiones generadoras siempre se tienen que escribir dentro de paréntesis, pero los paréntesis que indican la llamada a una función también cuentan. Si quiere crear un iterador que se pase inmediatamente a una función puede escribir:

@example
obj_total = sum(obj.count for obj in list_all_objects())
@end example

Las cláusulas @code{for...in} contienen las secuencias sobre las que se itera. Las secuencias no tienen que tener la misma longitud, porque son iteradas de izquierda a derecha, `no' en paralelo. Por cada elemento en @code{sequence1}, se recorre @code{sequence2} desde el inicio. Luego se recorre @code{sequence3} por cada par de elementos resultante de @code{sequence1} y @code{sequence2}.

Para ponerlo en otra forma, una lista por comprensión o expresión generadora es equivalente al siguiente código Python:

@example
for expr1 in sequence1:
    if not (condition1):
        continue   # Skip this element
    for expr2 in sequence2:
        if not (condition2):
            continue   # Skip this element
        ...
        for exprN in sequenceN:
            if not (conditionN):
                continue   # Skip this element

            # Output the value of
            # the expression.
@end example

Esto significa que cuando hay múltiples cláusulas @code{for...in} pero no cláusulas @code{if}, la longitud de la salida resultante será igual al producto de las longitudes de todas las secuencias. Si tiene dos listas de longitud 3, la lista de salida tendrá 9 elementos:

@example
>>> seq1 = 'abc'
>>> seq2 = (1, 2, 3)
>>> [(x, y) for x in seq1 for y in seq2]  
[('a', 1), ('a', 2), ('a', 3),
 ('b', 1), ('b', 2), ('b', 3),
 ('c', 1), ('c', 2), ('c', 3)]
@end example

Para evitar introducir una ambigüedad en la gramática de Python, si @code{expression} está creando una tupla, debe estar rodeada de paréntesis. La primera lista por comprensión de abajo tiene un error de sintaxis, mientras que la segunda es correcta:

@example
# Syntax error
[x, y for x in seq1 for y in seq2]
# Correct
[(x, y) for x in seq1 for y in seq2]
@end example

@node Generadores<2>,Funciones incorporadas<3>,Expresiones generadoras y listas por comprensión,HOWTO - Programación funcional
@anchor{howto/functional generators}@anchor{4e85}
@subsection Generadores


Los generadores son una clase especial de funciones que simplifican la tarea de escribir iteradores. Las funciones regulares calculan un valor y lo retornan, pero los generadores retornan un iterador que retorna un flujo de valores.

Sin duda está relacionado con cómo funcionan las llamadas a funciones regulares en Python o C. Cuando llama a una función, esta obtiene su espacio de nombres privado donde se crean sus variables locales. Cuando la función alcanza una sentencia @code{return}, las variables locales son destruidas y el valor se retorna al llamador. Una llamada posterior a la misma función crea un nuevo espacio de nombres privado y un conjunto limpio de variables locales. Pero, ¿qué pasa si las variables locales no fueron desechadas en la salida de una función? ¿Qué pasa si más tarde podría reanudar la función desde donde quedó? Esto es lo que proveen los generadores; se pueden pensar como funciones que se reanudan.

Este es el ejemplo más simple de una función generadora:

@example
>>> def generate_ints(N):
...    for i in range(N):
...        yield i
@end example

Cualquier función que contiene una palabra clave @ref{a5f,,yield} es una función generadora; esto es detectado por el compilador @ref{2f2,,bytecode} de Python que compila la función de forma especial como resultado.

Cuando llama a una función generadora, no retorna un solo valor; en lugar de eso retorna un objeto generador que soporta el protocolo iterador. Al ejecutar la expresión @code{yield}, el generador produce el valor de @code{i}, de forma similar a una sentencia @code{return}. La gran diferencia entre una sentencia @code{yield} y un @code{return} es que al alcanzar un @code{yield} se suspende el estado de ejecución del generador y se preservan las variables locales. En la próxima llamada al método @ref{1ccc,,__next__()} del generador, la función reanudará la ejecución.

Este es un ejemplo de uso del generador @code{generate_ints()}:

@example
>>> gen = generate_ints(3)
>>> gen  
<generator object generate_ints at ...>
>>> next(gen)
0
>>> next(gen)
1
>>> next(gen)
2
>>> next(gen)
Traceback (most recent call last):
  File "stdin", line 1, in <module>
  File "stdin", line 2, in generate_ints
StopIteration
@end example

De igual forma podría escribir @code{for i in generate_ints(5)}, o @code{a, b, c = generate_ints(3)}.

Dentro de una función generadora, @code{return value} causa que se lance @code{StopIteration(value)} del método @ref{1ccc,,__next__()}. Una vez que esto pase, o que se alcance el final de la función, termina la procesión de valores y el generador no puede producir más valores.

Podría lograr el efecto de los generadores manualmente escribiendo su propia clase y guardando todas las variables locales del generador como variables de instancia. Por ejemplo, retornar una lista de enteros se podría hacer estableciendo @code{self.count} a 0, y teniendo el método @ref{1335,,__next__()} que incrementa @code{self.count} y lo retorna. Sin embargo, para un generador moderadamente complicado, escribir una clase correspondiente puede ser mucho más confuso.

El banco de pruebas incluido con la librería de Python, Lib/test/test_generators.py@footnote{https://github.com/python/cpython/tree/main/Lib/test/test_generators.py}, contiene un número de ejemplos más interesantes. Este es un generador que implementa un recorrido inorden de un árbol usando generadores recursivamente.

@example
# A recursive generator that generates Tree leaves in in-order.
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x

        yield t.label

        for x in inorder(t.right):
            yield x
@end example

Otros dos ejemplos en @code{test_generators.py} producen soluciones al problema de N-reinas (ubicar N reinas en un tablero de ajedrez de NxN de forma que ninguna reina amenace a otra) y el problema del caballo (encontrar una ruta que lleve a un caballo a cada cuadro de un tablero de ajedrez de NxN sin visitar ningún cuadro dos veces).

@menu
* Pasar valores a un generador:: 

@end menu

@node Pasar valores a un generador,,,Generadores<2>
@anchor{howto/functional passing-values-into-a-generator}@anchor{4e86}
@subsubsection Pasar valores a un generador


En Python 2.4 y anteriores, los generadores solo producían salida. Una vez que el código de un generador era invocado para crear un iterador, no había forma de pasar ninguna información nueva a la función cuando se reanuda su ejecución. Podría lograr esta habilidad haciendo que el generador mire una variable global o pasando en algún objeto mutable que el llamador luego modifica, pero estos enfoques son confusos.

En Python 2.5 hay una forma más simple de pasar valores a un generador. @ref{a5f,,yield} se convirtió en una expresión, retornando un valor que se puede asignar a una variable o sobre el que se puede operar:

@example
val = (yield i)
@end example

Recomiendo que `siempre' ponga paréntesis alrededor de una expresión @code{yield} cuando esté haciendo algo con el valor retornado, como en el ejemplo de arriba. Los paréntesis no siempre son necesarios, pero siempre es más fácil agregarlos en lugar de tener que recordar cuándo son necesarios.

(
@geindex Python Enhancement Proposals; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} explica las reglas exactas, que son que una expresión @code{yield} siempre debe estar entre paréntesis excepto cuando se encuentra en la expresión de primer nivel en el lado derecho de una asignación. Esto significa que puede escribir @code{val = yield i} pero tiene que usar paréntesis cuando hay una operación, como en @code{val = (yield i) + 12}.)

Los valores son enviados a un generador llamando a su método @ref{1fcd,,send(value)}. Este método reanuda el código del generador y la expresión @code{yield} retorna el valor especificado. Si se llama al método regular @ref{1ccc,,__next__()}, @code{yield} retorna @code{None}.

Este es un simple contador que incrementa por 1 y permite cambiar los valores del contador interno.

@example
def counter(maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # If value provided, change counter
        if val is not None:
            i = val
        else:
            i += 1
@end example

Y este es un ejemplo del cambio del contador:

@example
>>> it = counter(10)  
>>> next(it)  
0
>>> next(it)  
1
>>> it.send(8)  
8
>>> next(it)  
9
>>> next(it)  
Traceback (most recent call last):
  File "t.py", line 15, in <module>
    it.next()
StopIteration
@end example

Como @code{yield} a menudo retornará @code{None}, siempre debería comprobar este caso. No use simplemente su valor en expresiones a menos que esté seguro que el método @ref{1fcd,,send()} será el único método utilizado para reanudar su función generadora.

Además del método @ref{1fcd,,send()}, hay otros dos métodos para generadores:


@itemize *

@item 
@ref{59d,,throw(value)} is used to
raise an exception inside the generator; the exception is raised by the
@code{yield} expression where the generator’s execution is paused.

@item 
@ref{16fa,,close()} lanza una excepción @ref{1407,,GeneratorExit} dentro del generador para terminar la iteración. Al recibir esta excepción, el código del generador debe lanzar @ref{1407,,GeneratorExit} o @ref{c82,,StopIteration}; capturar la excepción y hacer cualquier otra cosa es ilegal y disparará un @ref{1e5,,RuntimeError}. @ref{16fa,,close()} también se llamará por el recolector de basura de Python cuando se recolecte el generador.

Si necesita ejecutar un código de limpieza cuando ocurre un @ref{1407,,GeneratorExit}, sugiero usar un @code{try: ... finally:} en lugar de capturar @ref{1407,,GeneratorExit}.
@end itemize

El efecto acumulativo de estos cambios es convertir a los generadores de productores de información unidireccionales en productores y consumidores.

Los generadores también se convierten en `corrutinas', una forma más generalizada de subrutinas. Las subrutinas inician en un punto y salen en otro punto (el inicio de la función, y la sentencia @code{return}), pero las corrutinas pueden iniciar, salir, y reanudarse en muchos puntos diferentes (las sentencias @code{yield}).

@node Funciones incorporadas<3>,El módulo itertools,Generadores<2>,HOWTO - Programación funcional
@anchor{howto/functional built-in-functions}@anchor{4e87}
@subsection Funciones incorporadas


Veamos con más detalle las funciones incorporadas usadas a menudo con iteradores.

Dos de las funciones incorporadas de Python, @ref{14c,,map()} y @ref{8fb,,filter()} duplican las características de las expresiones generadoras:


@table @asis

@item @ref{14c,,map(f@comma{} iterA@comma{} iterB@comma{} ...)} retorna un iterador sobre la secuencia

@code{f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ...}.

@example
>>> def upper(s):
...     return s.upper()
@end example

@example
>>> list(map(upper, ['sentence', 'fragment']))
['SENTENCE', 'FRAGMENT']
>>> [upper(s) for s in ['sentence', 'fragment']]
['SENTENCE', 'FRAGMENT']
@end example
@end table

Por supuesto puede lograr el mismo efecto con una lista por comprensión.

@ref{8fb,,filter(predicate@comma{} iter)} retorna un iterador sobre todos los elementos de la secuencia que reúnen cierta condición, y de forma similar está duplicado por las listas por comprensión. Un `predicado' es una función que retorna un valor de verdad de alguna condición; para usarlo con @ref{8fb,,filter()}, el predicado debe recibir un solo valor.

@example
>>> def is_even(x):
...     return (x % 2) == 0
@end example

@example
>>> list(filter(is_even, range(10)))
[0, 2, 4, 6, 8]
@end example

Esto también se puede escribir como una lista por comprensión:

@example
>>> list(x for x in range(10) if is_even(x))
[0, 2, 4, 6, 8]
@end example

@ref{14bb,,enumerate(iter@comma{} start=0)} enumera los elementos en el iterable retornando 2-tuplas que contienen la enumeración (desde `start') y cada elemento.

@example
>>> for item in enumerate(['subject', 'verb', 'object']):
...     print(item)
(0, 'subject')
(1, 'verb')
(2, 'object')
@end example

@ref{14bb,,enumerate()} a menudo se usa cuando se recorre una lista y se registran los índices en los que se reúnen una cierta condición:

@example
f = open('data.txt', 'r')
for i, line in enumerate(f):
    if line.strip() == '@w{'}:
        print('Blank line at line #%i' % i)
@end example

@ref{c56,,sorted(iterable@comma{} key=None@comma{} reverse=False)} reúne todos los elementos de un iterable en una lista, ordena la lista, y retorna el resultado ordenado. Los argumentos `key' y `reverse' se pasan a través del método @ref{c57,,sort()} de la lista construida.

@example
>>> import random
>>> # Generate 8 random numbers between [0, 10000)
>>> rand_list = random.sample(range(10000), 8)
>>> rand_list  
[769, 7953, 9828, 6431, 8442, 9878, 6213, 2207]
>>> sorted(rand_list)  
[769, 2207, 6213, 6431, 7953, 8442, 9828, 9878]
>>> sorted(rand_list, reverse=True)  
[9878, 9828, 8442, 7953, 6431, 6213, 2207, 769]
@end example

(Para un tratamiento más detallado del ordenamiento, ver @ref{2186,,Sorting Techniques}.)

Las funciones incorporadas @ref{1460,,any(iter)} y @ref{1461,,all(iter)} ven los valores de verdad de los contenidos de un iterable. @ref{1460,,any()} retorna @code{True} si algún elemento en el iterable es un valor verdadero, y @ref{1461,,all()} retorna @code{True} si todos los elementos son valores verdaderos:

@example
>>> any([0, 1, 0])
True
>>> any([0, 0, 0])
False
>>> any([1, 1, 1])
True
>>> all([0, 1, 0])
False
>>> all([0, 0, 0])
False
>>> all([1, 1, 1])
True
@end example

@ref{14d,,zip(iterA@comma{} iterB@comma{} ...)} toma un elemento de cada iterable y los retorna en una tupla:

@example
zip(['a', 'b', 'c'], (1, 2, 3)) =>
  ('a', 1), ('b', 2), ('c', 3)
@end example

Esto no construye una lista en memoria y consume todos los iteradores de entrada antes de ejecutar; en lugar de eso, las tuplas se construyen y retornan solo si son requeridas. (El término técnico para este comportamiento es evaluación perezosa@footnote{https://es.wikipedia.org/wiki/Evaluaci%C3%B3n_perezosa}.)

Se pretende que el iterador se use con iterables que tengan todos la misma longitud. Si los iterables son de diferentes longitudes, el flujo resultante tendrá la misma longitud que el iterable más corto.

@example
zip(['a', 'b'], (1, 2, 3)) =>
  ('a', 1), ('b', 2)
@end example

Sin embargo, debería evitar hacer esto, porque se puede tomar un elemento de los iteradores más largos y descartarlo. Esto significa que ya no puede seguir usando los iteradores porque corre el riesgo de saltarse un elemento descartado.

@node El módulo itertools,El módulo functools,Funciones incorporadas<3>,HOWTO - Programación funcional
@anchor{howto/functional the-itertools-module}@anchor{4e88}
@subsection El módulo itertools


The @ref{81,,itertools} module contains a number of commonly used iterators as well
as functions for combining several iterators.  This section will introduce the
module’s contents by showing small examples.

Las funciones del módulo caen en unas pocas clases generales:


@itemize *

@item 
Funciones que crean un nuevo iterador basado en un iterador existente.

@item 
Funciones para tratar los elementos de un iterador como argumentos de función.

@item 
Funciones para seleccionar porciones de la salida de un iterador.

@item 
Una función para agrupar la salida de un iterador.
@end itemize

@menu
* Crear nuevos iteradores:: 
* Aplicar funciones a los elementos:: 
* Seleccionar elementos:: 
* Funciones combinatorias:: 
* Agrupar elementos:: 

@end menu

@node Crear nuevos iteradores,Aplicar funciones a los elementos,,El módulo itertools
@anchor{howto/functional creating-new-iterators}@anchor{4e89}
@subsubsection Crear nuevos iteradores


@ref{12f0,,itertools.count(start@comma{} step)} retorna un flujo infinito de valores equiespaciados. Opcionalmente puede suministrar el número de inicio, que por defecto es 0, y el intervalo entre números, que por defecto es 1:

@example
itertools.count() =>
  0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
itertools.count(10) =>
  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...
itertools.count(10, 5) =>
  10, 15, 20, 25, 30, 35, 40, 45, 50, 55, ...
@end example

@ref{2720,,itertools.cycle(iter)} guarda una copia de los contenidos de un iterable provisto y retorna un nuevo iterador que retorna sus elementos del primero al último. El nuevo iterador repetirá estos elementos infinitamente.

@example
itertools.cycle([1, 2, 3, 4, 5]) =>
  1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...
@end example

@ref{2721,,itertools.repeat(elem@comma{} [n])} retorna el elemento provisto `n' veces, o retorna el elemento indefinidamente si no se provee `n'.

@example
itertools.repeat('abc') =>
  abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ...
itertools.repeat('abc', 5) =>
  abc, abc, abc, abc, abc
@end example

@ref{2187,,itertools.chain(iterA@comma{} iterB@comma{} ...)} recibe un número arbitrario de iterables como entrada, y retorna todos los elementos del primer iterador, luego todos los elementos del segundo, y así sucesivamente, hasta que hayan sido agotados todos los iterables.

@example
itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>
  a, b, c, 1, 2, 3
@end example

@ref{bd4,,itertools.islice(iter@comma{} [start]@comma{} stop@comma{} [step])} retorna un flujo que es un segmento del iterador. Con solo un argumento `stop', retornará los primeros `stop' elementos. Si suministra un índice de inicio, obtendrá los elementos `stop-start', y si suministra un valor para `step', los elementos se saltarán en consecuencia. A diferencia de la segmentación de listas y cadenas de caracteres de Python, no puede usar valores negativos para `start', `stop' o `step'.

@example
itertools.islice(range(10), 8) =>
  0, 1, 2, 3, 4, 5, 6, 7
itertools.islice(range(10), 2, 8) =>
  2, 3, 4, 5, 6, 7
itertools.islice(range(10), 2, 8, 2) =>
  2, 4, 6
@end example

@ref{2726,,itertools.tee(iter@comma{} [n])} replica un iterador; retorna `n' iteradores independientes que retornarán los contenidos del iterador fuente. Si no suministra un valor para `n', por defecto es 2. Replicar iteradores requiere guardar algunos de los contenidos del iterador fuente, esto puede consumir memoria significativa si el iterador es grande y uno de los nuevos iteradores se consume más que los otros.

@example
itertools.tee( itertools.count() ) =>
   iterA, iterB

where iterA ->
   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...

and   iterB ->
   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
@end example

@node Aplicar funciones a los elementos,Seleccionar elementos,Crear nuevos iteradores,El módulo itertools
@anchor{howto/functional calling-functions-on-elements}@anchor{4e8a}
@subsubsection Aplicar funciones a los elementos


El módulo @ref{9f,,operator} contiene un conjunto de funciones correspondientes a los operadores de Python. Algunos ejemplos son @ref{2749,,operator.add(a@comma{} b)} (suma dos valores), @ref{2739,,operator.ne(a@comma{} b)} (lo mismo que @code{a != b}) y @ref{eb8,,operator.attrgetter('id')} (retorna un invocable que obtiene el atributo @code{.id}).

@ref{1157,,itertools.starmap(func@comma{} iter)} asume que el iterable retornará un flujo de tuplas, y llama a `func' usando estas tuplas como los argumentos:

@example
itertools.starmap(os.path.join,
                  [('/bin', 'python'), ('/usr', 'bin', 'java'),
                   ('/usr', 'bin', 'perl'), ('/usr', 'bin', 'ruby')])
=>
  /bin/python, /usr/bin/java, /usr/bin/perl, /usr/bin/ruby
@end example

@node Seleccionar elementos,Funciones combinatorias,Aplicar funciones a los elementos,El módulo itertools
@anchor{howto/functional selecting-elements}@anchor{4e8b}
@subsubsection Seleccionar elementos


Otro grupo de funciones elige un subconjunto de elementos de un iterador basado en un predicado dado.

@ref{216e,,itertools.filterfalse(predicate@comma{} iter)} es el opuesto de @ref{8fb,,filter()}, retornando todos los elementos para los que el predicado retorna falso:

@example
itertools.filterfalse(is_even, itertools.count()) =>
  1, 3, 5, 7, 9, 11, 13, 15, ...
@end example

@ref{2725,,itertools.takewhile(predicate@comma{} iter)} retorna los elementos mientras el predicado retorne verdadero. Una vez que el predicado retorna falso, el iterador indicará el final de sus resultados.

@example
def less_than_10(x):
    return x < 10

itertools.takewhile(less_than_10, itertools.count()) =>
  0, 1, 2, 3, 4, 5, 6, 7, 8, 9

itertools.takewhile(is_even, itertools.count()) =>
  0
@end example

@ref{2723,,itertools.dropwhile(predicate@comma{} iter)} descarta los elementos mientras el predicado retorne verdadero, y luego retorna el resto de los resultados del iterable.

@example
itertools.dropwhile(less_than_10, itertools.count()) =>
  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...

itertools.dropwhile(is_even, itertools.count()) =>
  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...
@end example

@ref{12ef,,itertools.compress(data@comma{} selectors)} recibe dos iteradores y retorna solo aquellos elementos de `data' para los cuales el elemento correspondiente de `selectors' es verdadero, deteniéndose cuando alguno se termine:

@example
itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>
   1, 2, 5
@end example

@node Funciones combinatorias,Agrupar elementos,Seleccionar elementos,El módulo itertools
@anchor{howto/functional combinatoric-functions}@anchor{4e8c}
@subsubsection Funciones combinatorias


La función @ref{137a,,itertools.combinations(iterable@comma{} r)} retorna un iterador proporcionando todas las combinaciones de `r'-tuplas de los elementos contenidos en `iterable'.

@example
itertools.combinations([1, 2, 3, 4, 5], 2) =>
  (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 3), (2, 4), (2, 5),
  (3, 4), (3, 5),
  (4, 5)

itertools.combinations([1, 2, 3, 4, 5], 3) =>
  (1, 2, 3), (1, 2, 4), (1, 2, 5), (1, 3, 4), (1, 3, 5), (1, 4, 5),
  (2, 3, 4), (2, 3, 5), (2, 4, 5),
  (3, 4, 5)
@end example

Los elementos dentro de cada tupla permanecen en el mismo orden en el que `iterable' los retornó. Por ejemplo, el número 1 siempre está antes que 2, 3, 4 o 5 en los ejemplos de arriba. Una función similar, @ref{1923,,itertools.permutations(iterable@comma{} r=None)}, remueve esta restricción en el orden, retornando todas las disposiciones posibles de longitud `r':

@example
itertools.permutations([1, 2, 3, 4, 5], 2) =>
  (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 1), (2, 3), (2, 4), (2, 5),
  (3, 1), (3, 2), (3, 4), (3, 5),
  (4, 1), (4, 2), (4, 3), (4, 5),
  (5, 1), (5, 2), (5, 3), (5, 4)

itertools.permutations([1, 2, 3, 4, 5]) =>
  (1, 2, 3, 4, 5), (1, 2, 3, 5, 4), (1, 2, 4, 3, 5),
  ...
  (5, 4, 3, 2, 1)
@end example

Si no suministra un valor para `r' se usa la longitud del iterable, lo que significa que se permutan todos los elementos.

Note que estas funciones producen todas las combinaciones posibles por posición y no requieren que los contenidos de `iterable' sean únicos:

@example
itertools.permutations('aba', 3) =>
  ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'),
  ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a')
@end example

La tupla idéntica @code{('a', 'a', 'b')} aparece dos veces, pero las dos cadenas de caracteres “a” provienen de diferentes posiciones.

La función @ref{12ee,,itertools.combinations_with_replacement(iterable@comma{} r)} relaja una restricción diferente: los elementos se pueden repetir dentro de una misma tupla. Conceptualmente un elemento se elige para la primera posición de cada tupla y luego se reemplaza antes de que se elija el segundo elemento.

@example
itertools.combinations_with_replacement([1, 2, 3, 4, 5], 2) =>
  (1, 1), (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 2), (2, 3), (2, 4), (2, 5),
  (3, 3), (3, 4), (3, 5),
  (4, 4), (4, 5),
  (5, 5)
@end example

@node Agrupar elementos,,Funciones combinatorias,El módulo itertools
@anchor{howto/functional grouping-elements}@anchor{4e8d}
@subsubsection Agrupar elementos


La última función que trataré, @ref{2724,,itertools.groupby(iter@comma{} key_func=None)}, es la más complicada. @code{key_func(elem)} es una función que calcula un valor clave para cada elemento retornado por el iterable. Si no suministra una función de clave, la clave será simplemente el elemento mismo.

@ref{2724,,groupby()} reúne todos los elementos consecutivos del iterable subyacente que tienen el mismo valor clave, y retorna un flujo de 2-tuplas que contienen un valor clave y un iterador para los elementos con esa clave.

@example
city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'),
             ('Anchorage', 'AK'), ('Nome', 'AK'),
             ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'),
             ...
            ]

def get_state(city_state):
    return city_state[1]

itertools.groupby(city_list, get_state) =>
  ('AL', iterator-1),
  ('AK', iterator-2),
  ('AZ', iterator-3), ...

where
iterator-1 =>
  ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL')
iterator-2 =>
  ('Anchorage', 'AK'), ('Nome', 'AK')
iterator-3 =>
  ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ')
@end example

@ref{2724,,groupby()} asume que los contenidos del iterable subyacente ya se ordenó basado en la clave. Note que los iteradores retornados también usan el iterable subyacente, así que tiene que consumir los resultados de iterador-1 antes de solicitar iterador-2 y su clave correspondiente.

@node El módulo functools,Funciones pequeñas y la expresión lambda,El módulo itertools,HOWTO - Programación funcional
@anchor{howto/functional the-functools-module}@anchor{4e8e}
@subsection El módulo functools


The @ref{5f,,functools} module contains some higher-order functions.
A `higher-order function' takes one or more functions as input and returns a
new function.  The most useful tool in this module is the
@ref{17a,,functools.partial()} function.

Para programas escritos en un estilo funcional, a veces querrá construir variantes de funciones existentes que tienen algunos de los parámetros predefinidos. Considere una función de Python @code{f(a, b, c)}; puede querer crear una nueva función @code{g(b, c)} que sea equivalente a @code{f(1, b, c)}; está completando un valor para uno de los parámetros de @code{f()}. Esto se llama «aplicación parcial de funciones».

El constructor para @ref{17a,,partial()} recibe los argumentos @code{(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)}. El objeto resultante es invocable, por lo que puede invocar a @code{function} con los argumentos rellenados.

Aquí hay un ejemplo pequeño pero realista:

@example
import functools

def log(message, subsystem):
    """Write the contents of 'message' to the specified subsystem."""
    print('%s: %s' % (subsystem, message))
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')
@end example

@ref{17d,,functools.reduce(func@comma{} iter@comma{} [initial_value])} realiza acumulativamente una operación en todos los elementos del iterable y, por lo tanto, no se puede aplicar a infinitos iterables. `func' debe ser una función que recibe dos elementos y retorna un solo valor. @ref{17d,,functools.reduce()} recibe los primeros dos elementos A y B retornados por el iterador y calcula @code{func(A, B)}. Luego pide el tercer elemento, C, calcula @code{func(func(A, B), C)}, combina este resultado con el cuarto elemento retornado, y continua hasta que se agote el iterable. Si el iterable no retorna ningún valor, se lanza una excepción @ref{228,,TypeError}. Si se suministra el valor inicial, se usa como punto inicial y @code{func(initial_value, A)} es el primer cálculo.

@example
>>> import operator, functools
>>> functools.reduce(operator.concat, ['A', 'BB', 'C'])
'ABBC'
>>> functools.reduce(operator.concat, [])
Traceback (most recent call last):
  ...
TypeError: reduce() of empty sequence with no initial value
>>> functools.reduce(operator.mul, [1, 2, 3], 1)
6
>>> functools.reduce(operator.mul, [], 1)
1
@end example

Si usa @ref{2749,,operator.add()} con @ref{17d,,functools.reduce()}, sumará todos los elementos del iterable. Este caso es tan común que hay una función incorporada especial llamada @ref{515,,sum()} para calcularla:

@example
>>> import functools, operator
>>> functools.reduce(operator.add, [1, 2, 3, 4], 0)
10
>>> sum([1, 2, 3, 4])
10
>>> sum([])
0
@end example

Sin embargo, para muchos usos de @ref{17d,,functools.reduce()} puede ser mas claro simplemente escribir el ciclo @ref{1eb,,for}:

@example
import functools
# Instead of:
product = functools.reduce(operator.mul, [1, 2, 3], 1)

# You can write:
product = 1
for i in [1, 2, 3]:
    product *= i
@end example

A related function is @ref{a8f,,itertools.accumulate(iterable@comma{} func=operator.add)}.  It performs the same calculation, but instead of
returning only the final result, @ref{a8f,,accumulate()} returns an iterator
that also yields each partial result:

@example
itertools.accumulate([1, 2, 3, 4, 5]) =>
  1, 3, 6, 10, 15

itertools.accumulate([1, 2, 3, 4, 5], operator.mul) =>
  1, 2, 6, 24, 120
@end example

@menu
* El módulo operator:: 

@end menu

@node El módulo operator,,,El módulo functools
@anchor{howto/functional the-operator-module}@anchor{4e8f}
@subsubsection El módulo operator


El módulo @ref{9f,,operator} se mencionó anteriormente. Contiene un conjunto de funciones que corresponden a los operadores de Python. Estas funciones a menudo son útiles en código en estilo funcional porque le salvan de escribir funciones triviales que realizan una sola operación.

Algunas de las funciones en este módulo son:


@itemize *

@item 
Operaciones matemáticas: @code{add()}, @code{sub()}, @code{mul()}, @code{floordiv()}, @code{abs()}, …

@item 
Operaciones lógicas: @code{not_()}, @code{truth()}.

@item 
Operaciones bit a bit: @code{and_()}, @code{or_()}, @code{invert()}.

@item 
Comparaciones: @code{eq()}, @code{ne()}, @code{lt()}, @code{le()}, @code{gt()} y @code{ge()}.

@item 
Identidad de objeto: @code{is_()}, @code{is_not()}.
@end itemize

Consulte la documentación del módulo operator para una lista completa.

@node Funciones pequeñas y la expresión lambda,Historia de revisiones y reconocimientos,El módulo functools,HOWTO - Programación funcional
@anchor{howto/functional small-functions-and-the-lambda-expression}@anchor{4e90}
@subsection Funciones pequeñas y la expresión lambda


Cuando se escriben programas en estilo funcional, a menudo necesitará pequeñas funciones que actúen como predicados o que combinen elementos de alguna manera.

Si hay una función incorporada o un módulo de Python, no necesita definir una nueva función en absoluto:

@example
stripped_lines = [line.strip() for line in lines]
existing_files = filter(os.path.exists, file_list)
@end example

Si la función que necesita no existe, necesita escribirla. Una forma de escribir funciones pequeñas es usar la expresión @ref{1309,,lambda}. @code{lambda} recibe un número de parámetros y una expresión que combina estos parámetros, y crea una función anónima que retorna el valor de la expresión:

@example
adder = lambda x, y: x+y

print_assign = lambda name, value: name + '=' + str(value)
@end example

Una alternativa es simplemente usar la sentencia @code{def} y definir una función en la forma usual:

@example
def adder(x, y):
    return x + y

def print_assign(name, value):
    return name + '=' + str(value)
@end example

¿Qué alternativa es preferible? Esa es una pregunta de estilo; mi rumbo usual es evitar usar @code{lambda}.

Una razón para mi preferencia es que @code{lambda} es muy limitado en las funciones que puede definir. El resultado tiene que ser calculable como una sola expresión, que significa que no tiene comparaciones multivía @code{if... elif... else} o sentencias @code{try... except}. Si intenta hacer mucho en una sentencia @code{lambda}, terminará con una expresión demasiado complicada que es difícil de leer. Rápido, ¿qué hace el siguiente código?

@example
import functools
total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]
@end example

Puede averiguarlo, pero toma tiempo desenredar la expresión para averiguar que está pasando. Usar una corta sentencia @code{def} anidada hace las cosas un poco mejor:

@example
import functools
def combine(a, b):
    return 0, a[1] + b[1]

total = functools.reduce(combine, items)[1]
@end example

Pero lo mejor de todo sería si simplemente hubiese usado un ciclo @code{for}:

@example
total = 0
for a, b in items:
    total += b
@end example

O la función incorporada @ref{515,,sum()} y una expresión generadora:

@example
total = sum(b for a, b in items)
@end example

Muchos usos de @ref{17d,,functools.reduce()} son más claros cuando se escriben como ciclos @code{for}.

Fredrik Lundh una vez sugirió el siguiente conjunto de reglas para refactorizar los usos de @code{lambda}:


@enumerate 

@item 
Escribir una función lambda.

@item 
Escribir un comentario explicando qué demonios hace esa lambda.

@item 
Estudiar el comentario por un momento, y pensar en un nombre que capture la esencia del comentario.

@item 
Convertir la lambda a una sentencia def, usando ese nombre.

@item 
Remover el comentario.
@end enumerate

Me gustan mucho estas reglas, pero es libre de disentir acerca de si este estilo libre de lambda es mejor.

@node Historia de revisiones y reconocimientos,Referencias<2>,Funciones pequeñas y la expresión lambda,HOWTO - Programación funcional
@anchor{howto/functional revision-history-and-acknowledgements}@anchor{4e91}
@subsection Historia de revisiones y reconocimientos


Al autor le gustaría agradecer a las siguientes personar por ofrecer sugerencias, correcciones y asistencia con varios borradores de este articulo: Ian Bicking, Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell, Leandro Lameiro, Jussi Salmela, Collin Winter, Blake Winton.

Versión 0.1: publicada el 30 de junio de 2006.

Versión 0.11: publicada el 1 de julio de 2006. Errores tipográficos arreglados.

Versión 0.2: publicada el 10 de julio de 2006. Secciones genexp y listcomp unidas en una sola. Errores tipográficos arreglados.

Versión 0.21: Agregadas mas referencias sugeridas en la lista de correos tutor.

Versión 0.30: Agrega una sección sobre el módulo @code{functional} escrito por Collin Winter; agrega una sección corta sobre el módulo operator; y unas pocas otras ediciones.

@node Referencias<2>,,Historia de revisiones y reconocimientos,HOWTO - Programación funcional
@anchor{howto/functional references}@anchor{4e92}
@subsection Referencias


@menu
* Generales:: 
* Específicas de Python:: 
* Documentación de Python:: 

@end menu

@node Generales,Específicas de Python,,Referencias<2>
@anchor{howto/functional general}@anchor{4e93}
@subsubsection Generales


`Structure and Interpretation of Computer Programs', by Harold Abelson and
Gerald Jay Sussman with Julie Sussman.  The book can be found at
@indicateurl{https://mitpress.mit.edu/sicp}.  In this classic textbook of computer science,
chapters 2 and 3 discuss the use of sequences and streams to organize the data
flow inside a program.  The book uses Scheme for its examples, but many of the
design approaches described in these chapters are applicable to functional-style
Python code.

@indicateurl{https://www.defmacro.org/ramblings/fp.html}: A general introduction to functional
programming that uses Java examples and has a lengthy historical introduction.

@indicateurl{https://es.wikipedia.org/wiki/Programaci%C3%B3n_funcional}: Entrada general de Wikipedia que describe la programación funcional.

@indicateurl{https://es.wikipedia.org/wiki/Corrutina}: Entrada para corrutinas.

@indicateurl{https://en.wikipedia.org/wiki/Partial_application}: Entry for the concept of partial function application.

@indicateurl{https://es.wikipedia.org/wiki/Currificaci%C3%B3n}: Entrada para el concepto de currificación.

@node Específicas de Python,Documentación de Python,Generales,Referencias<2>
@anchor{howto/functional python-specific}@anchor{4e94}
@subsubsection Específicas de Python


@indicateurl{https://gnosis.cx/TPiP/}: The first chapter of David Mertz’s book
@cite{Text Processing in Python} discusses functional programming
for text processing, in the section titled «Utilizing Higher-Order Functions in
Text Processing».

Mertz también escribió una serie de artículos de 3 partes sobre programación funcional para el sitio DeveloperWorks de IBM; ver parte 1@footnote{https://developer.ibm.com/articles/l-prog/}, parte 2@footnote{https://developer.ibm.com/tutorials/l-prog2/}, y parte 3@footnote{https://developer.ibm.com/tutorials/l-prog3/},

@node Documentación de Python,,Específicas de Python,Referencias<2>
@anchor{howto/functional python-documentation}@anchor{4e95}
@subsubsection Documentación de Python


Documentación del módulo @ref{81,,itertools}.

Documentación del módulo @ref{5f,,functools}.

Documentación del módulo @ref{9f,,operator}.

@geindex Python Enhancement Proposals; PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/}: «Expresiones generadoras»

@geindex Python Enhancement Proposals; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/}: «Corrutinas a través de generadores mejorados» describe las características del nuevo generador en Python 2.5.

@c comment
@c 
@c Handy little function for printing part of an iterator -- used
@c while writing this document.
@c 
@c import itertools
@c def print_iter(it):
@c      slice = itertools.islice(it, 10)
@c      for elem in slice[:-1]:
@c          sys.stdout.write(str(elem))
@c          sys.stdout.write(', ')
@c     print(elem[-1])

@node HOWTO hacer registros Logging,Libro de recetas de Logging,HOWTO - Programación funcional,Comos HOWTOs de Python
@anchor{howto/logging doc}@anchor{4e96}@anchor{howto/logging id1}@anchor{4e97}@anchor{howto/logging logging-howto}@anchor{4e98}
@section HOWTO hacer registros (`Logging')


@*Autor: 
Vinay Sajip <vinay_sajip at red-dove dot com>

@anchor{howto/logging logging-basic-tutorial}@anchor{1262}
Esta página contiene información de tutorial. Para enlaces a información de referencia y una guía de registro, consulte @ref{4e99,,Otros recursos}.

@menu
* Tutorial básico de logging:: 
* Tutorial de registro avanzado:: 
* Niveles de registro:: 
* Gestores útiles:: 
* Excepciones lanzadas durante logging:: 
* Usando objetos arbitrarios como mensajes:: 
* Optimización:: 
* Otros recursos: Otros recursos<2>. 

@end menu

@node Tutorial básico de logging,Tutorial de registro avanzado,,HOWTO hacer registros Logging
@anchor{howto/logging basic-logging-tutorial}@anchor{4e9a}
@subsection Tutorial básico de `logging'


`Logging' es un medio de rastrear los eventos que ocurren cuando se ejecuta algún software. El desarrollador del software agrega llamadas de registro a su código para indicar que ciertos eventos han ocurrido. Un evento se describe mediante un mensaje descriptivo que puede contener opcionalmente datos variables (es decir, datos que son potencialmente diferentes para cada ocurrencia del evento). Los eventos también tienen una importancia que el desarrollador atribuye al evento; la importancia también puede llamarse el `nivel' o la `severidad'.

@menu
* Cuándo usar logging:: 
* Un simple ejemplo:: 
* Logging a un archivo:: 
* Registrar datos de variables:: 
* Cambiar el formato de los mensajes mostrados:: 
* Visualización de la fecha/hora en los mensajes:: 
* Próximos pasos:: 

@end menu

@node Cuándo usar logging,Un simple ejemplo,,Tutorial básico de logging
@anchor{howto/logging when-to-use-logging}@anchor{4e9b}
@subsubsection Cuándo usar `logging'


You can access logging functionality by creating a logger via @code{logger =
getLogger(__name__)}, and then calling the logger’s @ref{eaf,,debug()},
@ref{2cd1,,info()}, @ref{1709,,warning()}, @ref{2cd3,,error()} and
@ref{eae,,critical()} methods. To determine when to use logging, and to see
which logger methods to use when, see the table below. It states, for each of a
set of common tasks, the best tool to use for that task.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

La tarea que quieres realizar

@tab

La mejor herramienta para la tarea

@item

Mostrar salidas de la consola para el uso ordinario de un programa o guión (script) de línea de comandos

@tab

@ref{ff4,,print()}

@item

Reportar eventos que ocurren durante el funcionamiento normal de un programa (por ejemplo, para la supervisión del estado o la investigación de fallos)

@tab

A logger’s @ref{2cd1,,info()} (or
@ref{eaf,,debug()} method for very
detailed output for diagnostic
purposes)

@item

Emitir una advertencia con respecto a un evento de tiempo de ejecución en particular

@tab

@ref{155a,,warnings.warn()} en el código de la biblioteca si el problema es evitable y la aplicación cliente debe ser modificada para eliminar la advertencia

A logger’s @ref{1709,,warning()}
method if there is nothing the client
application can do about the
situation, but the event should still
be noted

@item

Reportar un error con respecto a un evento particular al tiempo de ejecución

@tab

Lanza una excepción

@item

Reporta la supresión de un error sin invocar una excepción (por ejemplo, el manejador de errores en un proceso de servidor de larga duración)

@tab

A logger’s @ref{2cd3,,error()},
@ref{ead,,exception()} or
@ref{eae,,critical()} method as
appropriate for the specific error
and application domain

@end multitable


The logger methods are named after the level or severity of the events
they are used to track. The standard levels and their applicability are
described below (in increasing order of severity):


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nivel

@tab

Cuando es usado

@item

@code{DEBUG}

@tab

Información detallada, típicamente de interés sólo durante el diagnóstico de problemas.

@item

@code{INFO}

@tab

Confirmación de que las cosas están funcionando como se esperaba.

@item

@code{WARNING}

@tab

Un indicio de que algo inesperado sucedió, o indicativo de algún problema en el futuro cercano (por ejemplo, «espacio de disco bajo»). El software sigue funcionando como se esperaba.

@item

@code{ERROR}

@tab

Debido a un problema más grave, el software no ha sido capaz de realizar alguna función.

@item

@code{CRITICAL}

@tab

Un grave error, que indica que el programa en sí mismo puede ser incapaz de seguir funcionando.

@end multitable


The default level is @code{WARNING}, which means that only events of this severity and higher
will be tracked, unless the logging package is configured to do otherwise.

Los eventos que se rastrean pueden ser manejados en diferentes maneras. La forma más simple de manejar los eventos rastreados es imprimirlos en la consola o terminal. Otra forma común es escribirlos en un archivo de disco.

@node Un simple ejemplo,Logging a un archivo,Cuándo usar logging,Tutorial básico de logging
@anchor{howto/logging a-simple-example}@anchor{4e9c}@anchor{howto/logging howto-minimal-example}@anchor{4e9d}
@subsubsection Un simple ejemplo


Un ejemplo muy simple es:

@example
import logging
logging.warning('Watch out!')  # will print a message to the console
logging.info('I told you so')  # will not print anything
@end example

Si escribes estas líneas en un script y lo ejecutas, verás:

@example
WARNING:root:Watch out!
@end example

printed out on the console. The @code{INFO} message doesn’t appear because the
default level is @code{WARNING}. The printed message includes the indication of the
level and the description of the event provided in the logging call, i.e.
“Watch out!”. The actual output can be formatted quite flexibly if you need
that; formatting options will also be explained later.

Notice that in this example, we use functions directly on the @code{logging}
module, like @code{logging.debug}, rather than creating a logger and calling
functions on it. These functions operation on the root logger, but can be useful
as they will call @ref{a92,,basicConfig()} for you if it has not been called yet, like in
this example.  In larger programs you’ll usually want to control the logging
configuration explicitly however - so for that reason as well as others, it’s
better to create loggers and call their methods.

@node Logging a un archivo,Registrar datos de variables,Un simple ejemplo,Tutorial básico de logging
@anchor{howto/logging logging-to-a-file}@anchor{4e9e}
@subsubsection Logging a un archivo


Una situación muy común es la de registrar archivos de log, así que veamos eso a continuación. Asegúrese de intentar lo siguiente en un intérprete de Python recién iniciado, y no sólo continúe de la sesión descrita anteriormente:

@example
import logging
logger = logging.getLogger(__name__)
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logger.debug('This message should go to the log file')
logger.info('So should this')
logger.warning('And this, too')
logger.error('And non-ASCII stuff, too, like Øresund and Malmö')
@end example


Distinto en la versión 3.9: Se agregó el argumento `encoding'. En versiones anteriores de Python, o si no se especifica, la codificación utilizada es el valor predeterminado utilizado por @ref{1be,,open()}. Aunque no se muestra en el ejemplo anterior, ahora también se puede pasar un argumento `errors', que determina cómo se manejan los errores de codificación. Para conocer los valores disponibles y los predeterminados, consulte la documentación de @ref{1be,,open()}.


Y ahora si abrimos el archivo y miramos lo que tenemos, deberíamos encontrar los mensajes de registro:

@example
DEBUG:__main__:This message should go to the log file
INFO:__main__:So should this
WARNING:__main__:And this, too
ERROR:__main__:And non-ASCII stuff, too, like Øresund and Malmö
@end example

Este ejemplo también muestra cómo se puede establecer el nivel de registro que actúa como umbral para el rastreo. En este caso, como establecimos el umbral en @code{DEBUG}, todos los mensajes fueron impresos.

Si quieres establecer el nivel de registro desde una opción de línea de comandos como:

@example
--log=INFO
@end example

y tienes el valor del parámetro pasado por @code{--log} en alguna variable `loglevel', puedes usar:

@example
getattr(logging, loglevel.upper())
@end example

para obtener el valor que pasarás a @ref{a92,,basicConfig()} mediante el argumento `level'. Puede que quieras comprobar un error por cualquier valor de entrada del usuario, quizás como en el siguiente ejemplo:

@example
# assuming loglevel is bound to the string value obtained from the
# command line argument. Convert to upper case to allow the user to
# specify --log=DEBUG or --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)
@end example

The call to @ref{a92,,basicConfig()} should come `before' any calls to a logger’s
methods such as @ref{eaf,,debug()}, @ref{2cd1,,info()}, etc. Otherwise,
that logging event may not be handled in the desired manner.

Si ejecutas el script anterior varias veces, los mensajes de las ejecuciones sucesivas se añaden al archivo `example.log'. Si quieres que cada ejecución se inicie de nuevo, sin recordar los mensajes de ejecuciones anteriores, puedes especificar el argumento `filemode', cambiando la llamada en el ejemplo anterior a:

@example
logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)
@end example

La impresión será la misma que antes, pero el archivo de registro ya no se adjunta, por lo que los mensajes de las ejecuciones anteriores se pierden.

@node Registrar datos de variables,Cambiar el formato de los mensajes mostrados,Logging a un archivo,Tutorial básico de logging
@anchor{howto/logging logging-variable-data}@anchor{4e9f}
@subsubsection Registrar datos de variables


Para registrar los datos de variables, utilice una cadena de formato para el mensaje de descripción del evento y añada los datos variables como argumentos. Por ejemplo:

@example
import logging
logging.warning('%s before you %s', 'Look', 'leap!')
@end example

se mostrará:

@example
WARNING:root:Look before you leap!
@end example

Como puede ver, la combinación de datos de variables en el mensaje de descripción del evento utiliza el antiguo estilo de formato de cadena con el signo de porcentaje (%). Esto se hace por razones de compatibilidad con versiones anteriores: el paquete de registro existe desde antes de las opciones de formato más nuevas como @ref{6c2,,str.format()} y @ref{728,,string.Template}. Estas opciones de formato más nuevas `son' soportadas, pero explorarlas está fuera del alcance de este tutorial: consulte @ref{2cf1,,Usar estilos de formato particulares en toda su aplicación} para obtener más información.

@node Cambiar el formato de los mensajes mostrados,Visualización de la fecha/hora en los mensajes,Registrar datos de variables,Tutorial básico de logging
@anchor{howto/logging changing-the-format-of-displayed-messages}@anchor{4ea0}
@subsubsection Cambiar el formato de los mensajes mostrados


Para cambiar el formato que se utiliza para visualizar los mensajes, es necesario especificar el formato que se desea utilizar:

@example
import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')
logging.info('So should this')
logging.warning('And this, too')
@end example

que se imprimirá:

@example
DEBUG:This message should appear on the console
INFO:So should this
WARNING:And this, too
@end example

Noten que la ‘root’ que aparecía en los ejemplos anteriores ha desaparecido. Para un conjunto completo de cosas que pueden aparecer en formato de cadenas, puede consultar la documentación de @ref{2cd0,,Atributos LogRecord}, pero para un uso sencillo, sólo necesita el `levelname' (gravedad), `message' (descripción del evento, incluyendo los datos variables) y tal vez mostrar cuándo ocurrió el evento. Esto se describe en la siguiente sección.

@node Visualización de la fecha/hora en los mensajes,Próximos pasos,Cambiar el formato de los mensajes mostrados,Tutorial básico de logging
@anchor{howto/logging displaying-the-date-time-in-messages}@anchor{4ea1}
@subsubsection Visualización de la fecha/hora en los mensajes


Para mostrar la fecha y la hora de un evento, usted colocaría “%(asctime)s” en su cadena de formato:

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s')
logging.warning('is when this event was logged.')
@end example

que debería imprimir algo como esto:

@example
2010-12-12 11:41:42,612 is when this event was logged.
@end example

El formato por defecto para la visualización de la fecha/hora (mostrado arriba) es como ISO8601 o 
@geindex RFC; RFC 3339
RFC 3339@footnote{https://datatracker.ietf.org/doc/html/rfc3339.html}. Si necesita más control sobre el formato de la fecha/hora, proporcione un argumento `datefmt' a @code{basicConfig}, como en este ejemplo:

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
logging.warning('is when this event was logged.')
@end example

que mostraría algo como esto:

@example
12/12/2010 11:46:36 AM is when this event was logged.
@end example

El formato del argumento `datefmt' es el mismo que el soportado por @ref{1256,,time.strftime()}.

@node Próximos pasos,,Visualización de la fecha/hora en los mensajes,Tutorial básico de logging
@anchor{howto/logging next-steps}@anchor{4ea2}
@subsubsection Próximos pasos


Eso concluye el tutorial básico. Debería ser suficiente para ponerte en marcha con el registro. Hay mucho más que el paquete de registro ofrece, pero para obtener lo mejor de él, tendrá que invertir un poco más de su tiempo en la lectura de las siguientes secciones. Si estás listo para eso, toma un poco de tu bebida favorita y sigue adelante.

Si sus necesidades de registro son sencillas, utilice los ejemplos previos para incorporar el registro en sus propios scripts, y si tiene problemas o no entiende algo, por favor publique una pregunta en el grupo Usenet de comp.lang.python (disponible en @indicateurl{https://groups.google.com/g/comp.lang.python}) y debería recibir ayuda antes de que transcurra demasiado tiempo.

¿Todavía esta aquí? Puedes seguir leyendo las siguientes secciones, que proporcionan un tutorial un poco más avanzado y profundo que el básico de arriba. Después de eso, puedes echar un vistazo al @ref{1264,,Libro de recetas de Logging}.

@node Tutorial de registro avanzado,Niveles de registro,Tutorial básico de logging,HOWTO hacer registros Logging
@anchor{howto/logging advanced-logging-tutorial}@anchor{4ea3}@anchor{howto/logging logging-advanced-tutorial}@anchor{1263}
@subsection Tutorial de registro avanzado


La biblioteca de logging adopta un enfoque modular y ofrece varias categorías de componentes: registradores, gestores, filtros y formateadores.


@itemize *

@item 
Los registradores exponen la interfaz que el código de la aplicación utiliza directamente.

@item 
Los gestores envían los registros de log (creados por los registradores) al destino apropiado.

@item 
Los filtros proporcionan una instalación de grano más fino para determinar qué registros de log se deben producir.

@item 
Los formatos especifican la disposición de los archivos de log en el resultado final.
@end itemize

La información de los eventos de registro se pasa entre los registradores, gestores, filtros y formateadores en una instancia @ref{1065,,LogRecord}.

El registro se realiza llamando a métodos en instancias de la clase @ref{bd7,,Logger} (de aquí en adelante llamada `loggers'). Cada instancia tiene un nombre, y se organizan conceptualmente en una jerarquía de espacios de nombres utilizando puntos (puntos) como separadores. Por ejemplo, un registrador llamado “scan” es el padre de los registradores “scan.text”, “scan.html” y “scan.pdf”. Los nombres de los registradores pueden ser cualquier cosa que se desee, e indican el área de una aplicación en la que se origina un mensaje registrado.

Una buena convención que se puede utilizar para nombrar a los registradores es utilizar un registrador a nivel de módulo, en cada módulo que utilice el registro, llamado de la siguiente manera:

@example
logger = logging.getLogger(__name__)
@end example

Esto significa que los nombres de los registradores rastrean la jerarquía de paquetes/módulos, y es intuitivamente obvio donde se registran los eventos sólo a partir del nombre del registrador.

La raíz de la jerarquía de los registradores se llama root `logger'. Ese es el registrador usado por las funciones @ref{2cd2,,debug()}, @ref{2cfc,,info()}, @ref{1f7,,warning()}, @ref{2d10,,error()} y @code{critícal()}, que sólo llaman al mismo método del registrador raíz. Las funciones y los métodos tienen las mismas firmas. El nombre del root `logger' se imprime como ‘root’ en la salida registrada.

Por supuesto, es posible registrar mensajes a diferentes destinos. El paquete incluye soporte para escribir mensajes de registro en archivos, ubicaciones HTTP GET/POST, correo electrónico a través de SMTP, sockets genéricos, colas o mecanismos de registro específicos del sistema operativo como syslog o el registro de eventos de Windows NT. Los destinos son servidos por clases `handler'. Puedes crear tu propia clase de destino de registro si tienes requisitos especiales que no se cumplen con ninguna de las clases de gestor incorporadas.

Por defecto, no se establece ningún destino para los mensajes de registro. Puede especificar un destino (como consola o archivo) usando @ref{a92,,basicConfig()} como en los ejemplos del tutorial. Si llama a las funciones @ref{2cd2,,debug()}, @ref{2cfc,,info()}, @ref{1f7,,warning()}, @ref{2d10,,error()} y @ref{2d11,,critical()}, ellas comprobarán si no hay ningún destino establecido; y si no hay ninguno establecido, establecerán un destino de la consola (@code{sys.stderr}) y un formato por defecto para el mensaje mostrado antes de delegar en el registrador root para hacer la salida real del mensaje.

El formato por defecto establecido por @ref{a92,,basicConfig()} para los mensajes es:

@example
severity:logger name:message
@end example

Puedes cambiar esto pasando una cadena de formato a @ref{a92,,basicConfig()} con el argumento de la palabra clave `format'. Para todas las opciones relativas a cómo se construye una cadena de formato, ver @ref{2cee,,Objetos formateadores}.

@menu
* Flujo de Registro:: 
* Registradores:: 
* Gestores:: 
* Formateadores:: 
* Configuración del registro:: 
* ¿Qué pasa si no se proporciona ninguna configuración:: 
* Configurando Logging para una biblioteca:: 

@end menu

@node Flujo de Registro,Registradores,,Tutorial de registro avanzado
@anchor{howto/logging logging-flow}@anchor{4ea4}
@subsubsection Flujo de Registro


En el siguiente diagrama se ilustra el flujo de información de los eventos de registro en los registradores y gestores.

@image{python-figures/logging_flow,,,,png}

@node Registradores,Gestores,Flujo de Registro,Tutorial de registro avanzado
@anchor{howto/logging loggers}@anchor{4ea5}
@subsubsection Registradores


Los objetos de @ref{bd7,,Logger} tienen un trabajo triple.  Primero, exponen varios métodos al código de la aplicación para que las aplicaciones puedan registrar mensajes en tiempo de ejecución. Segundo, los objetos `logger' determinan sobre qué mensajes de registro actuar en base de la severidad (la facilidad de filtrado por defecto) o los objetos de filtro.  Tercero, los objetos registradores pasan los mensajes de registro relevantes a todos los manejadores de registro interesados.

Los métodos más utilizados en los objetos de registro se dividen en dos categorías: configuración y envío de mensajes.

Estos son los métodos de configuración más comunes:


@itemize *

@item 
@ref{14cd,,Logger.setLevel()} especifica el mensaje de registro de menor gravedad que un registrador manejará, donde debug es el nivel de gravedad incorporado más bajo y `critical' es el de mayor gravedad incorporado.  Por ejemplo, si el nivel de severidad es INFO, el registrador sólo manejará los mensajes INFO, WARNING, ERROR y CRITICAL e ignorará los mensajes DEBUG.

@item 
@ref{2ccb,,Logger.addHandler()} y @ref{2ccc,,Logger.removeHandler()} agregan y quitan los objetos `handler' del objeto `logger'.  Los manejadores (`handlers') se tratan con más detalle en @ref{4ea6,,Gestores}.

@item 
@ref{2cd4,,Logger.addFilter()} y @ref{2cd5,,Logger.removeFilter()} agregan y quitan los objetos de filtro del objeto logger.  Los filtros se tratan con más detalle en @ref{2cf9,,Filtro de Objetos}.
@end itemize

No es necesario que siempre llames a estos métodos en cada registrador que crees. Vea los dos últimos párrafos de esta sección.

Con el objeto `logger' configurado, los siguientes métodos crean mensajes de log:


@itemize *

@item 
@ref{eaf,,Logger.debug()}, @ref{2cd1,,Logger.info()}, @ref{1709,,Logger.warning()}, @ref{2cd3,,Logger.error()}, y @ref{eae,,Logger.critical()} todos crean registros de registro con un mensaje y un nivel que corresponde a sus respectivos nombres de método. El mensaje es en realidad una cadena de formato, que puede contener la sintaxis estándar de sustitución de cadenas de @code{%s}, @code{%d}, @code{%f}, y así sucesivamente.  El resto de sus argumentos es una lista de objetos que se corresponden con los campos de sustitución del mensaje.  Con respecto a @code{**kwargs}, los métodos de registro sólo se preocupan por una palabra clave de @code{exc_info} y la usan para determinar si registran información de excepción.

@item 
@ref{ead,,Logger.exception()} crea un mensaje de registro similar a @ref{2cd3,,Logger.error()}.  La diferencia es que @ref{ead,,Logger.exception()} vuelca un rastro de pila junto con él.  Llama a este método sólo desde un manejador de excepciones.

@item 
@ref{eac,,Logger.log()} toma un nivel de log como argumento explícito.  Esto es un poco más verboso para el registro de mensajes que usar los métodos de conveniencia de nivel de registro listados arriba, pero así es como se registra en niveles de registro personalizados.
@end itemize

@ref{9f3,,getLogger()} retorna una referencia a una instancia de `logger' con el nombre especificado si se proporciona, o @code{root} si no.  Los nombres son estructuras jerárquicas separadas por períodos.  Múltiples llamadas a @ref{9f3,,getLogger()} con el mismo nombre retornarán una referencia al mismo objeto `logger'.  Los `loggers' que están más abajo en la lista jerárquica son hijos de los `loggers' que están más arriba en la lista. Por ejemplo, dado un `logger' con un nombre de @code{foo}, los `loggers' con nombres de @code{foo.bar}, @code{foo.bar.baz}, y @code{foo.bam} son todos descendientes de @code{foo}.

Los registradores tienen un concepto de `nivel efectivo'. Si un nivel no se establece explícitamente en un registrador, el nivel de su clase padre se utiliza en su lugar como su nivel efectivo. Si el padre no tiene un nivel explícito establecido, `su' padre es examinado, y así sucesivamente - se buscan todos los ancestros hasta que se encuentra un nivel explícitamente establecido. El registrador raíz siempre tiene un conjunto de niveles explícito (@code{Advertencia} por defecto). Cuando se decide si se procesa un evento, el nivel efectivo del registrador se utiliza para determinar si el evento se pasa a los manejadores del registrador.

Los `loggers' inferiores propagan mensajes hasta los gestores asociados con sus `loggers' ancestros. Debido a esto, no es necesario definir y configurar los manejadores para todos los registradores que utiliza una aplicación. Basta con configurar los manejadores para un registrador de nivel superior y crear registradores hijos según sea necesario. (Sin embargo, puedes desactivar la propagación estableciendo el atributo `propagate' de un `logger' en @code{False}.)

@node Gestores,Formateadores,Registradores,Tutorial de registro avanzado
@anchor{howto/logging handler-basic}@anchor{4ea6}@anchor{howto/logging handlers}@anchor{4ea7}
@subsubsection Gestores


Los objetos @ref{14d0,,Handler} son responsables de enviar los mensajes de registro apropiados (basados en la severidad de los mensajes de registro) al destino especificado por el handler. @ref{bd7,,Logger} los objetos pueden añadir cero o más objetos `handler' a sí mismos con un método @ref{2ccb,,addHandler()}.  Como escenario de ejemplo, una aplicación puede querer enviar todos los mensajes de registro a un archivo de registro, todos los mensajes de registro de error o superiores a stdout, y todos los mensajes de crítico a una dirección de correo electrónico. Este escenario requiere tres manejadores individuales donde cada manejador es responsable de enviar mensajes de una severidad específica a una ubicación específica.

La biblioteca estándar incluye bastantes tipos de `handler' (ver @ref{4ea8,,Gestores útiles}); los tutoriales usan principalmente @ref{1265,,StreamHandler} y @ref{18a7,,FileHandler} en sus ejemplos.

Hay muy pocos métodos en un manejador para que los desarrolladores de aplicaciones se preocupen.  Los únicos métodos de manejador que parecen relevantes para los desarrolladores de aplicaciones que utilizan los objetos de manejador incorporados (es decir, que no crean manejadores personalizados) son los siguientes métodos de configuración:


@itemize *

@item 
The @ref{2ce2,,setLevel()} method, just as in logger objects, specifies the
lowest severity that will be dispatched to the appropriate destination.  Why
are there two @ref{2ce2,,setLevel()} methods?  The level set in the logger
determines which severity of messages it will pass to its handlers.  The level
set in each handler determines which messages that handler will send on.

@item 
@ref{2ce3,,setFormatter()} selecciona un objeto `Formatter' para que este `handler' lo use.

@item 
@ref{2ce4,,addFilter()} y @ref{2ce5,,removeFilter()} respectivamente configuran y desconfiguran los objetos del filtro en los handlers.
@end itemize

El código de la aplicación no debe instanciar directamente y usar instancias de @ref{14d0,,Handler}.  En su lugar, la clase @ref{14d0,,Handler} es una clase base que define la interfaz que todos los `handlers' deben tener y establece algún comportamiento por defecto que las clases hijas pueden usar (o anular).

@node Formateadores,Configuración del registro,Gestores,Tutorial de registro avanzado
@anchor{howto/logging formatters}@anchor{4ea9}
@subsubsection Formateadores


Los objetos de formato configuran el orden final, la estructura y el contenido del mensaje de registro.  A diferencia de la clase base @ref{14d0,,logging.Handler}, el código de la aplicación puede instanciar clases de formateo, aunque probablemente podría subclasificar el formateo si su aplicación necesita un comportamiento especial.  El constructor toma tres argumentos opcionales – una cadena de formato de mensaje, una cadena de formato de fecha y un indicador de estilo.

@geindex __init__() (método de logging.logging.Formatter)
@anchor{howto/logging logging logging Formatter __init__}@anchor{4eaa}
@deffn {Método} logging.Formatter.__init__ (fmt=None, datefmt=None, style='%')
@end deffn

Si no hay una cadena de formato de mensaje, el valor predeterminado es utilizar el mensaje en bruto.  Si no hay una cadena de formato de fecha, el formato de fecha por defecto es:

@example
%Y-%m-%d %H:%M:%S
@end example

con los milisegundos insertados al final. El @code{style} es uno de @code{'%'}, @code{'@{'} o @code{'$'}. Si uno de estos no se especifica, entonces se usará @code{'%'}.

Si el @code{style} es @code{'%'}, la cadena del formato de mensaje utiliza @code{%(<dictionary key>)s} estilo de sustitución de cadena; las posibles llaves están documentadas en @ref{2cd0,,Atributos LogRecord}. Si el estilo es @code{'@{'}, se asume que la cadena del formato del mensaje es compatible con @ref{6c2,,str.format()} (usando argumentos de palabras clave), mientras que si el estilo es @code{'$'} entonces la cadena del formato del mensaje debe ajustarse a lo que se espera de @ref{1cf1,,string.Template.substitute()}.


Distinto en la versión 3.2: Añadió el parámetro @code{style}.


La siguiente cadena de formato de mensaje registrará la hora en un formato legible para los humanos, la gravedad del mensaje y el contenido del mensaje, en ese orden:

@example
'%(asctime)s - %(levelname)s - %(message)s'
@end example

Los formateadores utilizan una función configurable por el usuario para convertir la hora de creación de un registro en una tupla. Por defecto, se utiliza @ref{1539,,time.localtime()}; para cambiar esto para una instancia de formateador particular, establezca el atributo @code{converter} de la instancia a una función con la misma firma que @ref{1539,,time.localtime()} o @ref{122d,,time.gmtime()}. Para cambiarlo para todos los formateadores, por ejemplo si quieres que todas las horas de registro se muestren en GMT, establece el atributo @code{converter} en la clase `Formatter' (a @code{time.gmtime} para mostrar GMT).

@node Configuración del registro,¿Qué pasa si no se proporciona ninguna configuración,Formateadores,Tutorial de registro avanzado
@anchor{howto/logging configuring-logging}@anchor{4eab}
@subsubsection Configuración del registro


Los programadores pueden configurar el registro en tres maneras:


@enumerate 

@item 
Creando registradores, manejadores y formateadores explícitamente usando código Python que llama a los métodos de configuración listados arriba.

@item 
Creando un archivo de configuración de registro y leyéndolo usando la función @ref{bd9,,fileConfig()}.

@item 
Creando un diccionario de información de configuración y pasándolo a la función @ref{121e,,dictConfig()}.
@end enumerate

Para la documentación de referencia sobre las dos últimas opciones, vea @ref{1358,,Funciones de configuración}.  El siguiente ejemplo configura un `logger' muy simple, un manejador de consola, y un formateador simple usando código Python:

@example
import logging

# create logger
logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)

# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# create formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# add formatter to ch
ch.setFormatter(formatter)

# add ch to logger
logger.addHandler(ch)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

Ejecutar este módulo desde la línea de comandos produce la siguiente salida:

@example
$ python simple_logging_module.py
2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message
2005-03-19 15:10:26,620 - simple_example - INFO - info message
2005-03-19 15:10:26,695 - simple_example - WARNING - warn message
2005-03-19 15:10:26,697 - simple_example - ERROR - error message
2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message
@end example

El siguiente módulo de Python crea un registrador, manejador y formateador casi idéntico a los del ejemplo anterior, con la única diferencia de los nombres de los objetos:

@example
import logging
import logging.config

logging.config.fileConfig('logging.conf')

# create logger
logger = logging.getLogger('simpleExample')

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

Aquí está el archivo logging.conf:

@example
[loggers]
keys=root,simpleExample

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler

[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
@end example

La salida es casi idéntica a la del ejemplo basado en un archivo no configurado:

@example
$ python simple_logging_config.py
2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message
2005-03-19 15:38:55,979 - simpleExample - INFO - info message
2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message
2005-03-19 15:38:56,055 - simpleExample - ERROR - error message
2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message
@end example

Se puede ver que el enfoque del archivo de configuración tiene algunas ventajas sobre el enfoque del código Python, principalmente la separación de la configuración y el código y la capacidad de los no codificadores de modificar fácilmente las propiedades de registro.

@cartouche
@quotation Advertencia 
La función @code{fileConfig`()} toma un parámetro por defecto, @code{disable_existing_loggers}, que por defecto es @code{True} por razones de compatibilidad retroactiva. Esto puede ser o no lo que usted quiera, ya que causará que cualquier registrador no existente antes de la llamada @ref{bd9,,fileConfig()} sea desactivado a menos que ellos (o un ancestro) sean nombrados explícitamente en la configuración. Por favor, consulte la documentación de referencia para más información, y especifique @code{False} para este parámetro si lo desea.

El diccionario pasado a @ref{121e,,dictConfig()} también puede especificar un valor booleano con la tecla @code{disable_existing_loggers}, que si no se especifica explícitamente en el diccionario también se interpreta por defecto como @code{True}. Esto lleva al comportamiento de deshabilitación de los registradores descrito anteriormente, que puede no ser lo que usted desea - en cuyo caso, proporcione a la clave explícitamente un valor de @code{False}.
@end quotation
@end cartouche

Obsérvese que los nombres de clase a los que se hace referencia en los archivos de configuración deben ser relativos al módulo de registro, o bien valores absolutos que puedan resolverse mediante mecanismos de importación normales. Por lo tanto, puedes usar @ref{2d4e,,WatchedFileHandler} (relativo al módulo de registro) o @code{mypackage.mymodule.MyHandler} (para una clase definida en el paquete @code{mypackage} y el módulo @code{mymodule}, donde @code{mypackage} está disponible en la ruta de importación de Python).

En Python 3.2, se ha introducido un nuevo medio para configurar el registro, utilizando diccionarios para guardar la información de configuración. Esto proporciona un superconjunto de la funcionalidad del enfoque basado en archivos de configuración descrito anteriormente, y es el método de configuración recomendado para nuevas aplicaciones y despliegues. Dado que se utiliza un diccionario de Python para guardar información de configuración, y dado que se puede rellenar ese diccionario utilizando diferentes medios, se dispone de más opciones de configuración. Por ejemplo, puede utilizar un archivo de configuración en formato JSON o, si tiene acceso a la funcionalidad de procesamiento YAML, un archivo en formato YAML, para rellenar el diccionario de configuración. O, por supuesto, puedes construir el diccionario en código Python, recibirlo en forma encurtida sobre un zócalo, o usar cualquier enfoque que tenga sentido para tu aplicación.

Aquí hay un ejemplo de la misma configuración que arriba, en formato YAML para el nuevo enfoque basado en el diccionario:

@example
version: 1
formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
handlers:
  console:
    class: logging.StreamHandler
    level: DEBUG
    formatter: simple
    stream: ext://sys.stdout
loggers:
  simpleExample:
    level: DEBUG
    handlers: [console]
    propagate: no
root:
  level: DEBUG
  handlers: [console]
@end example

Para más información sobre el registro usando un diccionario, ver @ref{1358,,Funciones de configuración}.

@node ¿Qué pasa si no se proporciona ninguna configuración,Configurando Logging para una biblioteca,Configuración del registro,Tutorial de registro avanzado
@anchor{howto/logging what-happens-if-no-configuration-is-provided}@anchor{4eac}
@subsubsection ¿Qué pasa si no se proporciona ninguna configuración


If no logging configuration is provided, it is possible to have a situation
where a logging event needs to be output, but no handlers can be found to
output the event.

The event is output using a “handler of last resort”, stored in
@ref{1267,,lastResort}. This internal handler is not associated with any
logger, and acts like a @ref{1265,,StreamHandler} which writes the
event description message to the current value of @code{sys.stderr} (therefore
respecting any redirections which may be in effect). No formatting is
done on the message - just the bare event description message is printed.
The handler’s level is set to @code{WARNING}, so all events at this and
greater severities will be output.


Distinto en la versión 3.2: Para las versiones de Python anteriores a la 3.2, el comportamiento es el siguiente:


@itemize *

@item 
If @ref{1266,,raiseExceptions} is @code{False} (production mode), the event is
silently dropped.

@item 
If @ref{1266,,raiseExceptions} is @code{True} (development mode), a message
“No handlers could be found for logger X.Y.Z” is printed once.
@end itemize

To obtain the pre-3.2 behaviour,
@ref{1267,,lastResort} can be set to @code{None}.


@node Configurando Logging para una biblioteca,,¿Qué pasa si no se proporciona ninguna configuración,Tutorial de registro avanzado
@anchor{howto/logging configuring-logging-for-a-library}@anchor{4ead}@anchor{howto/logging library-config}@anchor{2d4b}
@subsubsection Configurando Logging para una biblioteca


Cuando se desarrolla una biblioteca que utiliza el registro, se debe tener cuidado de documentar la forma en que la biblioteca utiliza el registro, por ejemplo, los nombres de los registradores utilizados. También hay que tener en cuenta su configuración de registro. Si la aplicación que lo utiliza no usa el registro, y el código de la biblioteca hace llamadas de registro, entonces (como se describe en la sección anterior) los eventos de gravedad @code{WARNING} y mayores se imprimirán en @code{sys.stderr}. Esto se considera el mejor comportamiento por defecto.

Si por alguna razón usted `no' quiere que estos mensajes se impriman en ausencia de cualquier configuración de registro, puede adjuntar un manejador de no hacer nada al registrador de nivel superior de su biblioteca. Esto evita que el mensaje se imprima, ya que siempre se encontrará un manejador para los eventos de la biblioteca: simplemente no produce ninguna salida. Si el usuario de la biblioteca configura el registro para el uso de la aplicación, presumiblemente esa configuración añadirá algunos manejadores, y si los niveles están configurados adecuadamente, entonces las llamadas de registro realizadas en el código de la biblioteca enviarán una salida a esos manejadores, como es normal.

Un manejador de no hacer nada está incluido en el paquete de registro: @ref{12f1,,NullHandler} (desde Python 3.1). Una instancia de este manejador podría ser añadida al `logger' de nivel superior del espacio de nombres de registro usado por la biblioteca (`si' quieres evitar que los eventos de registro de tu biblioteca se envíen a @code{sys.stderr} en ausencia de la configuración de registro). Si todo el registro de una biblioteca `foo' se hace usando registradores con nombres que coincidan con “foo.x”, “foo.x.y”, etc. entonces el código:

@example
import logging
logging.getLogger('foo').addHandler(logging.NullHandler())
@end example

debería tener el efecto deseado. Si una organización produce varias bibliotecas, el nombre del registrador especificado puede ser ‘orgname.foo’ en lugar de sólo ‘foo’.

@cartouche
@quotation Nota 
Se recomienda encarecidamente que `no registre en el registrador raíz' en su biblioteca. En su lugar, utilice un registrador con un nombre único y fácilmente identificable, como el @code{__name__} para el paquete o módulo de nivel superior de su biblioteca. Al registrar en el registrador raíz, dificultará o será imposible para el desarrollador de la aplicación configurar la verbosidad o los handlers de registro de su biblioteca según sus preferencias.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se recomienda encarecidamente que `no añada ningún otro manejador que no sea' @ref{12f1,,NullHandler} `a los loggers de su biblioteca'. Esto se debe a que la configuración de los `handlers' es prerrogativa del desarrollador de aplicaciones que utiliza su biblioteca. El desarrollador de la aplicación conoce su público objetivo y qué manejadores son los más apropiados para su aplicación: si añades manejadores ‘bajo el capó’, podrías interferir en su capacidad de realizar pruebas unitarias y entregar registros que se ajusten a sus necesidades.
@end quotation
@end cartouche

@node Niveles de registro,Gestores útiles,Tutorial de registro avanzado,HOWTO hacer registros Logging
@anchor{howto/logging logging-levels}@anchor{4eae}
@subsection Niveles de registro


Los valores numéricos de los niveles de registro se indican en el siguiente cuadro. Éstos son de interés principalmente si se desea definir los propios niveles y se necesita que tengan valores específicos en relación con los niveles predefinidos. Si se define un nivel con el mismo valor numérico, éste sobrescribe el valor predefinido; el nombre predefinido se pierde.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nivel

@tab

Valor numérico

@item

@code{CRITICAL}

@tab

50

@item

@code{ERROR}

@tab

40

@item

@code{WARNING}

@tab

30

@item

@code{INFO}

@tab

20

@item

@code{DEBUG}

@tab

10

@item

@code{NOTSET}

@tab

0

@end multitable


Los niveles también pueden asociarse con los registradores, siendo establecidos por el desarrollador o mediante la carga de una configuración de registro guardada. Cuando se llama a un método de registro en un registrador, éste compara su propio nivel con el nivel asociado a la llamada del método. Si el nivel del registrador es superior al de la llamada al método, no se genera ningún mensaje de registro. Este es el mecanismo básico que controla la verbosidad de la salida del registro.

Los mensajes de registro se codifican como instancias de la clase @ref{1065,,logging.LogRecord}. Cuando un `logger' decide registrar realmente un evento, se crea una instancia @ref{1065,,LogRecord} a partir del mensaje de registro.

Los mensajes de registro están sujetos a un mecanismo de envío mediante el uso de `handlers', que son instancias de subclases de la clase @ref{14d0,,Handler}. Los gestores son responsables de asegurar que un mensaje registrado (en forma de @ref{1065,,LogRecord}) termine en una ubicación particular (o conjunto de ubicaciones) que sea útil para el público al que va dirigido ese mensaje (como usuarios finales, personal de asistencia técnica, administradores de sistemas, desarrolladores). Los manejadores pasan instancias @ref{1065,,LogRecord} destinadas a destinos particulares. Cada `logger' puede tener cero, uno o más manejadores asociados a él (a través del método @ref{2ccb,,addHandler()} de @ref{bd7,,Logger}). Además de los `handlers' directamente asociados a un `logger', todos los manejadores (`handlers') asociados a todos los ancestros del `logger' son llamados a enviar el mensaje (a menos que el flag `propagate' de un `logger' se establezca en un valor falso, en cuyo caso el paso a los `handlers' ancestrales se detiene).

Al igual que para los `logger', los gestores pueden tener niveles asociados a ellos. El nivel de un gestor actúa como un filtro de la misma manera que el nivel de un `logger'. Si un manejador (`handler') decide realmente enviar un evento, el método @ref{2cec,,emit()} se utiliza para enviar el mensaje a su destino. La mayoría de las subclases definidas por el usuario de @ref{14d0,,Handler} necesitarán anular este @ref{2cec,,emit()}.

@menu
* Niveles personalizados:: 

@end menu

@node Niveles personalizados,,,Niveles de registro
@anchor{howto/logging custom-levels}@anchor{2d15}@anchor{howto/logging id2}@anchor{4eaf}
@subsubsection Niveles personalizados


Definir sus propios niveles es posible, pero no debería ser necesario, ya que los niveles existentes se han elegido sobre la base de la experiencia práctica. Sin embargo, si usted está convencido de que necesita niveles personalizados, debe tener mucho cuidado al hacer esto, y es posiblemente `una muy mala idea definir niveles personalizados si está desarrollando una biblioteca'. Esto se debe a que si los autores de múltiples bibliotecas definen sus propios niveles personalizados, existe la posibilidad de que el resultado del registro de tales bibliotecas múltiples utilizadas conjuntamente sea difícil de controlar y/o interpretar para el desarrollador usuario, porque un valor numérico dado podría significar cosas diferentes para diferentes bibliotecas.

@node Gestores útiles,Excepciones lanzadas durante logging,Niveles de registro,HOWTO hacer registros Logging
@anchor{howto/logging id3}@anchor{4eb0}@anchor{howto/logging useful-handlers}@anchor{4ea8}
@subsection Gestores útiles


Además de la base @ref{14d0,,Handler} class, se proporcionan muchas subclases útiles:


@enumerate 

@item 
@ref{1265,,StreamHandler} instancias envían mensajes a los `streams' (objetos como de tipo archivo).

@item 
@ref{18a7,,FileHandler} instancias enviar mensajes a los archivos del disco.

@item 
@ref{2d52,,BaseRotatingHandler} es la clase base para los manejadores (`handlers') que rotan los archivos de registro en un punto determinado. No está pensada para ser instanciada directamente. En su lugar, utilice @ref{15d9,,RotatingFileHandler} o @ref{fe1,,TimedRotatingFileHandler}.

@item 
Las instancias de @ref{15d9,,RotatingFileHandler} envían mensajes a los archivos de disco, con soporte para el tamaño máximo de los archivos de registro y la rotación de los mismos.

@item 
Las instancias de @ref{fe1,,TimedRotatingFileHandler} envían mensajes a los archivos de disco, rotando el archivo de registro a ciertos intervalos de tiempo.

@item 
Las instancias de @ref{fe2,,SocketHandler} envían mensajes a los sockets TCP/IP. Desde la versión 3.4, los sockets de dominio Unix también están soportados.

@item 
Instancias de @ref{fe3,,DatagramHandler} envían mensajes a los sockets UDP. Desde la versión 3.4, los sockets de dominio Unix también están soportados.

@item 
Las instancias de @ref{2d7e,,SMTPHandler} envían mensajes a una dirección de correo electrónico designada.

@item 
Las instancias de @ref{6fd,,SysLogHandler} envían mensajes a un demonio del syslog de Unix, posiblemente en una máquina remota.

@item 
Las instancias de @ref{2d76,,NTEventLogHandler} envían mensajes a un registro de eventos de Windows NT/2000/XP.

@item 
Las instancias de @ref{2d32,,MemoryHandler} envían mensajes a un buffer en la memoria, que es limpiado cuando se cumplen ciertos criterios.

@item 
Las instancias de @ref{eb0,,HTTPHandler} envían mensajes a un servidor HTTP usando la semántica de «GET» o «POST».

@item 
Las instancias de @ref{2d4e,,WatchedFileHandler} ven el archivo al que están accediendo. Si el archivo cambia, se cierra y se vuelve a abrir usando el nombre del archivo. Este manejador sólo es útil en sistemas tipo Unix; Windows no soporta el mecanismo subyacente utilizado.

@item 
Las instancias de @ref{17de,,QueueHandler} envían mensajes a una cola, como los implementados en los módulos @ref{b6,,queue} or @ref{94,,multiprocessing}.

@item 
Las instancias de @ref{12f1,,NullHandler} no hacen nada con los mensajes de error. Son utilizadas por los desarrolladores de bibliotecas que desean utilizar el registro, pero quieren evitar el mensaje “No se pudo encontrar ningún controlador para el registrador `XXX'”, que puede mostrarse si el usuario de la biblioteca no ha configurado el registro. Consulte @ref{2d4b,,Configurando Logging para una biblioteca} para obtener más información.
@end enumerate


Added in version 3.1: La clase @ref{12f1,,NullHandler}.



Added in version 3.2: La @ref{17de,,QueueHandler} (La clase de gestores de Cola).


Las clases @ref{12f1,,NullHandler}, @ref{1265,,StreamHandler} y @ref{18a7,,FileHandler} están definidas en el paquete de registro del núcleo. Los otros manejadores se definen en un sub-módulo, @ref{89,,logging.handlers}. (También hay otro submódulo, @ref{88,,logging.config}, para la funcionalidad de configuración)

Los mensajes registrados se formatean para su presentación a través de instancias de la clase @ref{14d1,,Formatter}. Se inicializan con una cadena de formato adecuada para su uso con el operador % y un diccionario.

For formatting multiple messages in a batch, instances of
@ref{2cf5,,BufferingFormatter} can be used. In addition to the format
string (which is applied to each message in the batch), there is provision for
header and trailer format strings.

Cuando el filtrado basado en el nivel de `logger' o el nivel de manejador (`handler') no es suficiente, se pueden añadir instancias de @ref{1268,,Filter} tanto a @ref{bd7,,Logger} como a @ref{14d0,,Handler} instancias (a través de su método @ref{2ce4,,addFilter()}). Antes de decidir procesar un mensaje más adelante, tanto los `loggers' como los manejadores (`handlers') consultan todos sus filtros para obtener permiso. Si algún filtro retorna un valor falso, el mensaje no se procesa más.

La funcionalidad básica @code{Filtro} permite filtrar por un nombre de registro específico. Si se utiliza esta función, los mensajes enviados al registrador nombrado y a sus hijos se permiten a través del filtro, y todos los demás se eliminan.

@node Excepciones lanzadas durante logging,Usando objetos arbitrarios como mensajes,Gestores útiles,HOWTO hacer registros Logging
@anchor{howto/logging exceptions-raised-during-logging}@anchor{4eb1}@anchor{howto/logging logging-exceptions}@anchor{4eb2}
@subsection Excepciones lanzadas durante logging


El paquete de tala está diseñado para tragarse las excepciones que se producen durante la tala en la producción. Esto es así para que los errores que ocurren durante el manejo de los eventos de registro - como la mala configuración del registro, errores de red u otros errores similares - no causen que la aplicación que utiliza el registro termine prematuramente.

Las excepciones de @ref{dc7,,SystemExit} (Salida del sistema) y @ref{a63,,KeyboardInterrupt} (Interrupción del teclado) nunca se tragan. Otras excepciones que ocurren durante el método @ref{2cec,,emit()}  de una subclase @ref{14d0,,Handler} se pasan a su método @ref{2ceb,,handleError()} .

La implementación por defecto de @ref{2ceb,,handleError()} en @ref{14d0,,Handler} comprueba si una variable de nivel de módulo, @ref{1266,,raiseExceptions}, está establecida. Si se establece, se imprime una traza en @ref{9cc,,sys.stderr}. Si no se establece, se traga la excepción.

@cartouche
@quotation Nota 
El valor por defecto de @ref{1266,,raiseExceptions} (lanzar excepciones)  es @code{True}. Esto se debe a que durante el desarrollo, normalmente quieres ser notificado de cualquier excepción que ocurra. Se aconseja que establezca @ref{1266,,raiseExceptions} a @code{False} para el uso en producción.
@end quotation
@end cartouche

@node Usando objetos arbitrarios como mensajes,Optimización,Excepciones lanzadas durante logging,HOWTO hacer registros Logging
@anchor{howto/logging arbitrary-object-messages}@anchor{2d01}@anchor{howto/logging using-arbitrary-objects-as-messages}@anchor{4eb3}
@subsection Usando objetos arbitrarios como mensajes


En las secciones y ejemplos anteriores, se ha supuesto que el mensaje pasado al registrar el suceso es una cadena. Sin embargo, esta no es la única posibilidad. Se puede pasar un objeto arbitrario como mensaje, y su método @ref{6be,,__str__()} será llamado cuando el sistema de registro necesite convertirlo en una representación de cadena. De hecho, si quieres, puedes evitar computar una representación de cadena por completo - por ejemplo, el método @ref{fe2,,SocketHandler} emite un evento al `pickling' y enviarlo por el cable.

@node Optimización,Otros recursos<2>,Usando objetos arbitrarios como mensajes,HOWTO hacer registros Logging
@anchor{howto/logging optimization}@anchor{4eb4}
@subsection Optimización


El formato de los argumentos del mensaje se aplaza hasta que no se pueda evitar. Sin embargo, el cálculo de los argumentos pasados al método de registro también puede ser costoso, y puede que quieras evitar hacerlo si el registrador simplemente tirará tu evento. Para decidir qué hacer, puedes llamar al método @ref{135d,,isEnabledFor()} que toma un argumento de nivel y retorna true si el evento sería creado por el `Logger' para ese nivel de llamada. Puedes escribir código como este:

@example
if logger.isEnabledFor(logging.DEBUG):
    logger.debug('Message with %s, %s', expensive_func1(),
                                        expensive_func2())
@end example

so that if the logger’s threshold is set above @code{DEBUG}, the calls to
@code{expensive_func1} and @code{expensive_func2} are never made.

@cartouche
@quotation Nota 
En algunos casos, @ref{135d,,isEnabledFor()} puede ser en sí mismo más caro de lo que te gustaría (por ejemplo, para los `loggers' profundamente anidados donde un nivel explícito sólo se establece en lo alto de la jerarquía de `loggers'). En estos casos (o si quieres evitar llamar a un método en bucles estrechos), puedes guardar en caché el resultado de una llamada a @ref{135d,,isEnabledFor()} en una variable local o de instancia, y usarla en lugar de llamar al método cada vez. Tal valor en caché sólo necesitaría ser recalculado cuando la configuración de registro cambie dinámicamente mientras la aplicación se está ejecutando (lo cual no es tan común).
@end quotation
@end cartouche

Hay otras optimizaciones que pueden hacerse para aplicaciones específicas que necesitan un control más preciso sobre la información de registro que se recoge. Aquí hay una lista de cosas que puede hacer para evitar el procesamiento durante el registro que no necesita:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Lo que no quieres colectar

@tab

Cómo evitar coleccionarlo

@item

Información sobre dónde se hicieron las llamadas.

@tab

Establezca @code{logging._srcfile} en @code{None}. Esto evita llamar a @ref{781,,sys._getframe()}, que puede ayudar a acelerar su código en entornos como PyPy (que no puede acelerar el código que usa @ref{781,,sys._getframe()}).

@item

Información sobre código con hilos.

@tab

Establece @code{logging.logThreads} en @code{False}.

@item

ID del proceso actual (@ref{2b04,,os.getpid()})

@tab

Establece @code{logging.logProcesses} en @code{False}.

@item

Nombre del proceso actual cuando se usa @code{multiprocessing} para administrar múltiples procesos.

@tab

Establece @code{logging.logMultiprocessing} en @code{False}.

@item

Nombre actual de @ref{580,,asyncio.Task} cuando se utiliza @code{asyncio}.

@tab

Establece @code{logging.logAsyncioTasks} en @code{False}.

@end multitable


Observe también que el módulo de registro del núcleo sólo incluye los gestores básicos. Si no importas @ref{89,,logging.handlers} y @ref{88,,logging.config}, no ocuparán ninguna memoria.

@node Otros recursos<2>,,Optimización,HOWTO hacer registros Logging
@anchor{howto/logging other-resources}@anchor{4eb5}@anchor{howto/logging tutorial-ref-links}@anchor{4e99}
@subsection Otros recursos



@subsubheading Ver también



@table @asis

@item Módulo @ref{87,,logging}

Referencia API para el módulo de registro.

@item Módulo @ref{88,,logging.config}

API de configuración para el módulo de registro.

@item Módulo @ref{89,,logging.handlers}

Gestores útiles incluidos en el módulo de registro.
@end table

@ref{1264,,Un libro de recetas}


@node Libro de recetas de Logging,Expresiones regulares COMOS HOWTO,HOWTO hacer registros Logging,Comos HOWTOs de Python
@anchor{howto/logging-cookbook doc}@anchor{4eb6}@anchor{howto/logging-cookbook id1}@anchor{4eb7}@anchor{howto/logging-cookbook logging-cookbook}@anchor{1264}
@section Libro de recetas de Logging


@*Autor: 
Vinay Sajip <vinay_sajip at red-dove dot com>


Esta página contiene un número de recetas sobre `logging', que han sido útiles en el pasado. Para obtener enlaces al tutorial e información de referencia, consulte @ref{4eb8,,Otros recursos}.

@menu
* Usar logging en múltiples módulos:: 
* Logging desde múltiples hilos:: 
* Múltiples gestores y formateadores:: 
* Logging en múltiples destinos:: 
* Gestión personalizada de niveles:: 
* Ejemplo de servidor de configuración:: 
* Tratar con gestores que bloquean:: 
* Enviar y recibir eventos logging a través de una red:: 
* Agregar información contextual a su salida de logging:: 
* Uso de contextvars:: 
* Impartir información contextual en los gestores:: 
* Logging a un sólo archivo desde múltiples procesos:: 
* Usando rotación de archivos:: 
* Uso de estilos de formato alternativos:: 
* Personalización de LogRecord:: 
* Subclassing QueueHandler and QueueListener- a ZeroMQ example:: 
* Subclassing QueueHandler and QueueListener- a pynng example:: 
* Una configuración de ejemplo basada en diccionario:: 
* Usar un rotador y un nombre para personalizar el procesamiento de rotación de log:: 
* Un ejemplo de multiprocesamiento más elaborado:: 
* Insertar BOM en mensajes enviados a SysLogHandler:: 
* Implementar logging estructurado:: 
* Personalización de gestores con dictConfig(): Personalización de gestores con dictConfig. 
* Usar estilos de formato particulares en toda su aplicación:: 
* Configurar filtros con dictConfig(): Configurar filtros con dictConfig. 
* Formato de excepción personalizado:: 
* Mensajes de logging hablantes:: 
* Almacenamiento en búfer de mensajes de logging y su salida condicional:: 
* Enviando mensajes de logging al correo electrónico@comma{} con almacenamiento en búfer: Enviando mensajes de logging al correo electrónico con almacenamiento en búfer. 
* Formateo de horas usando UTC (GMT) a través de la configuración: Formateo de horas usando UTC GMT a través de la configuración. 
* Usar un administrador de contexto para logging selectivo:: 
* Una plantilla de inicio de aplicación CLI:: 
* Una GUI de Qt para logging:: 
* Logging en syslog con soporte RFC5424:: 
* Cómo tratar un logger como una salida stream:: 
* Patrones para evitar:: 
* Otros recursos: Otros recursos<3>. 

@end menu

@node Usar logging en múltiples módulos,Logging desde múltiples hilos,,Libro de recetas de Logging
@anchor{howto/logging-cookbook using-logging-in-multiple-modules}@anchor{4eb9}
@subsection Usar logging en múltiples módulos


Múltiples llamadas a @code{logging.getLogger('someLogger')} retornan una referencia al mismo objeto logger. Esto es cierto no solo dentro del mismo módulo, sino también en todos los módulos siempre que estén ejecutándose en el mismo proceso del intérprete de Python. Es válido para las referencias al mismo objeto. Además, el código de la aplicación puede definir y configurar un logger primario en un módulo y crear (pero no configurar) un logger secundario en un módulo separado, y todas las llamadas al secundario pasarán al principal. A continuación un módulo principal:

@example
import logging
import auxiliary_module

# create logger with 'spam_application'
logger = logging.getLogger('spam_application')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# add the handlers to the logger
logger.addHandler(fh)
logger.addHandler(ch)

logger.info('creating an instance of auxiliary_module.Auxiliary')
a = auxiliary_module.Auxiliary()
logger.info('created an instance of auxiliary_module.Auxiliary')
logger.info('calling auxiliary_module.Auxiliary.do_something')
a.do_something()
logger.info('finished auxiliary_module.Auxiliary.do_something')
logger.info('calling auxiliary_module.some_function()')
auxiliary_module.some_function()
logger.info('done with auxiliary_module.some_function()')
@end example

Y aquí un módulo auxiliar:

@example
import logging

# create logger
module_logger = logging.getLogger('spam_application.auxiliary')

class Auxiliary:
    def __init__(self):
        self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary')
        self.logger.info('creating an instance of Auxiliary')

    def do_something(self):
        self.logger.info('doing something')
        a = 1 + 1
        self.logger.info('done doing something')

def some_function():
    module_logger.info('received a call to "some_function"')
@end example

El resultado se ve así:

@example
2005-03-23 23:47:11,663 - spam_application - INFO -
   creating an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -
   creating an instance of Auxiliary
2005-03-23 23:47:11,665 - spam_application - INFO -
   created an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,668 - spam_application - INFO -
   calling auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -
   doing something
2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -
   done doing something
2005-03-23 23:47:11,670 - spam_application - INFO -
   finished auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,671 - spam_application - INFO -
   calling auxiliary_module.some_function()
2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -
   received a call to 'some_function'
2005-03-23 23:47:11,673 - spam_application - INFO -
   done with auxiliary_module.some_function()
@end example

@node Logging desde múltiples hilos,Múltiples gestores y formateadores,Usar logging en múltiples módulos,Libro de recetas de Logging
@anchor{howto/logging-cookbook logging-from-multiple-threads}@anchor{4eba}
@subsection Logging desde múltiples hilos


Realizar `logging' desde múltiples hilos (`threads') no requiere ningún esfuerzo especial. El siguiente ejemplo muestra el logging desde el hilo principal (inicial) y otro hilo:

@example
import logging
import threading
import time

def worker(arg):
    while not arg['stop']:
        logging.debug('Hi from myfunc')
        time.sleep(0.5)

def main():
    logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')
    info = @{'stop': False@}
    thread = threading.Thread(target=worker, args=(info,))
    thread.start()
    while True:
        try:
            logging.debug('Hello from main')
            time.sleep(0.75)
        except KeyboardInterrupt:
            info['stop'] = True
            break
    thread.join()

if __name__ == '__main__':
    main()
@end example

Cuando se ejecuta, el script debe imprimir algo como lo siguiente:

@example
   0 Thread-1 Hi from myfunc
   3 MainThread Hello from main
 505 Thread-1 Hi from myfunc
 755 MainThread Hello from main
1007 Thread-1 Hi from myfunc
1507 MainThread Hello from main
1508 Thread-1 Hi from myfunc
2010 Thread-1 Hi from myfunc
2258 MainThread Hello from main
2512 Thread-1 Hi from myfunc
3009 MainThread Hello from main
3013 Thread-1 Hi from myfunc
3515 Thread-1 Hi from myfunc
3761 MainThread Hello from main
4017 Thread-1 Hi from myfunc
4513 MainThread Hello from main
4518 Thread-1 Hi from myfunc
@end example

Esto muestra la salida de logging intercalada como cabría esperar. Por supuesto, este enfoque funciona para más hilos de lo que se muestran aquí.

@node Múltiples gestores y formateadores,Logging en múltiples destinos,Logging desde múltiples hilos,Libro de recetas de Logging
@anchor{howto/logging-cookbook multiple-handlers-and-formatters}@anchor{4ebb}
@subsection Múltiples gestores y formateadores


Los `loggers' son simples objetos Python. El método @ref{2ccb,,addHandler()} no tiene una cuota mínima o máxima para la cantidad de gestores (`handlers') que puede agregar. A veces será beneficioso para una aplicación registrar todos los mensajes de todas las prioridades en un archivo de texto mientras se registran simultáneamente los errores o más en la consola. Para configurar esto, simplemente configure los gestores apropiados. Las llamadas de logging en el código de la aplicación permanecerán sin cambios. Aquí hay una ligera modificación al ejemplo de configuración simple anterior basado en módulo:

@example
import logging

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# add the handlers to logger
logger.addHandler(ch)
logger.addHandler(fh)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

Tenga en cuenta que el código de la “aplicación” no se preocupa por los gestores múltiples. Todo lo que cambió fue la adición y configuración de un nuevo gestor llamado `fh'.

La capacidad de crear nuevos gestores con filtros de mayor o menor prioridad puede ser muy útil al escribir y probar una aplicación. En lugar de usar muchas declaraciones @code{print} para la depuración, use @code{logger.debug}: a diferencia de las declaraciones de impresión, que tendrá que eliminar o comentar más tarde, las declaraciones de `logger.debug' pueden permanecer intactas en el código fuente y permanecen inactivas hasta que las necesite nuevamente. En ese momento, el único cambio que debe realizar es modificar el nivel de prioridad del `logger' y/o gestor para depurar.

@node Logging en múltiples destinos,Gestión personalizada de niveles,Múltiples gestores y formateadores,Libro de recetas de Logging
@anchor{howto/logging-cookbook logging-to-multiple-destinations}@anchor{4ebc}@anchor{howto/logging-cookbook multiple-destinations}@anchor{4ebd}
@subsection Logging en múltiples destinos


Supongamos que desea que la consola y un archivo tengan diferentes formatos de mensaje y salida de log para diferentes situaciones. Por ejemplo, desea registrar mensajes con un nivel DEBUG y superiores en un archivo y enviar mensajes con nivel INFO y superior a la consola. Además, suponga que desea grabar una marca de tiempo en el archivo y no imprimirlo en la consola. Puede lograr este comportamiento haciendo lo siguiente:

@example
import logging

# set up logging to file - see previous section for more details
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                    datefmt='%m-%d %H:%M',
                    filename='/tmp/myapp.log',
                    filemode='w')
# define a Handler which writes INFO messages or higher to the sys.stderr
console = logging.StreamHandler()
console.setLevel(logging.INFO)
# set a format which is simpler for console use
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# tell the handler to use this format
console.setFormatter(formatter)
# add the handler to the root logger
logging.getLogger('@w{'}).addHandler(console)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')
@end example

Cuando ejecute esto, en la consola verá

@example
root        : INFO     Jackdaws love my big sphinx of quartz.
myapp.area1 : INFO     How quickly daft jumping zebras vex.
myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack.
myapp.area2 : ERROR    The five boxing wizards jump quickly.
@end example

y en el archivo verá algo como

@example
10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz.
10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim.
10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex.
10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack.
10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.
@end example

Como se puede ver, el mensaje DEBUG sólo se muestra en el archivo. Los otros mensajes se envían a los dos destinos.

Este ejemplo usa gestores de consola y archivos, pero puede usar cualquier número y combinación de los gestores que elija.

Tenga en cuenta que la elección anterior del nombre del archivo de registro @code{/tmp/myapp.log} implica el uso de una ubicación estándar para los archivos temporales en los sistemas POSIX. En Windows, es posible que tenga que elegir un nombre de directorio diferente para el registro - sólo asegúrese de que el directorio existe y que tiene los permisos para crear y actualizar archivos en él.

@node Gestión personalizada de niveles,Ejemplo de servidor de configuración,Logging en múltiples destinos,Libro de recetas de Logging
@anchor{howto/logging-cookbook custom-handling-of-levels}@anchor{4ebe}@anchor{howto/logging-cookbook custom-level-handling}@anchor{4ebf}
@subsection Gestión personalizada de niveles


A veces, es posible que desee hacer algo ligeramente diferente del manejo estándar de niveles, donde todos los niveles por encima de un umbral son procesados por un gestor. Para ello, es necesario utilizar filtros. Veamos un escenario en el que se desea organizar las cosas de la siguiente manera:


@itemize *

@item 
Enviar mensajes de gravedad @code{INFO} y @code{WARNING} a @code{sys.stdout}

@item 
Enviar mensajes de gravedad @code{ERROR} y superiores a @code{sys.stderr}

@item 
Envía los mensajes de gravedad @code{DEBUG} y superiores al archivo @code{app.log}
@end itemize

Supongamos que se configura el registro con el siguiente JSON:

@example
@{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": @{
        "simple": @{
            "format": "%(levelname)-8s - %(message)s"
        @}
    @},
    "handlers": @{
        "stdout": @{
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout"
        @},
        "stderr": @{
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        @},
        "file": @{
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        @}
    @},
    "root": @{
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    @}
@}
@end example

This configuration does `almost' what we want, except that @code{sys.stdout} would show messages
of severity @code{ERROR} and only events of this severity and higher will be tracked
as well as @code{INFO} and @code{WARNING} messages. To prevent this, we can set up a filter which
excludes those messages and add it to the relevant handler. This can be configured by
adding a @code{filters} section parallel to @code{formatters} and @code{handlers}:

@example
@{
    "filters": @{
        "warnings_and_below": @{
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        @}
    @}
@}
@end example

y cambiando la sección del gestor @code{stdout} para añadirlo:

@example
@{
    "stdout": @{
        "class": "logging.StreamHandler",
        "level": "INFO",
        "formatter": "simple",
        "stream": "ext://sys.stdout",
        "filters": ["warnings_and_below"]
    @}
@}
@end example

Un filtro no es más que una función, por lo que podemos definir el @code{filter_maker} (una función de fábrica) como sigue:

@example
def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter
@end example

Esto convierte el argumento de la cadena de caracteres pasada en un nivel numérico, y retorna una función que sólo retorna @code{True} si el nivel del registro pasado está en o por debajo del nivel especificado. Ten en cuenta que en este ejemplo se ha definido el @code{filter_maker} en un script de prueba @code{main.py} que se ejecuta desde la línea de comandos, por lo que su módulo será @code{__main__} - de ahí el @code{__main__.filter_maker} en la configuración del filtro. Tendrás que cambiar eso si lo defines en un módulo diferente.

Con el filtro añadido, podemos ejecutar @code{main.py}, que en su totalidad es:

@example
import json
import logging
import logging.config

CONFIG = '@w{'}'
@{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": @{
        "simple": @{
            "format": "%(levelname)-8s - %(message)s"
        @}
    @},
    "filters": @{
        "warnings_and_below": @{
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        @}
    @},
    "handlers": @{
        "stdout": @{
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout",
            "filters": ["warnings_and_below"]
        @},
        "stderr": @{
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        @},
        "file": @{
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        @}
    @},
    "root": @{
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    @}
@}
'@w{'}'

def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter

logging.config.dictConfig(json.loads(CONFIG))
logging.debug('A DEBUG message')
logging.info('An INFO message')
logging.warning('A WARNING message')
logging.error('An ERROR message')
logging.critical('A CRITICAL message')
@end example

Y después de ejecutarlo de esta manera:

@example
python main.py 2>stderr.log >stdout.log
@end example

Podemos ver que los resultados son los esperados:

@example
$ more *.log
::::::::::::::
app.log
::::::::::::::
DEBUG    - A DEBUG message
INFO     - An INFO message
WARNING  - A WARNING message
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stderr.log
::::::::::::::
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stdout.log
::::::::::::::
INFO     - An INFO message
WARNING  - A WARNING message
@end example

@node Ejemplo de servidor de configuración,Tratar con gestores que bloquean,Gestión personalizada de niveles,Libro de recetas de Logging
@anchor{howto/logging-cookbook configuration-server-example}@anchor{4ec0}
@subsection Ejemplo de servidor de configuración


Aquí hay un ejemplo de un módulo que usa el servidor de configuración logging:

@example
import logging
import logging.config
import time
import os

# read initial config file
logging.config.fileConfig('logging.conf')

# create and start listener on port 9999
t = logging.config.listen(9999)
t.start()

logger = logging.getLogger('simpleExample')

try:
    # loop through logging calls to see the difference
    # new configurations make, until Ctrl+C is pressed
    while True:
        logger.debug('debug message')
        logger.info('info message')
        logger.warning('warn message')
        logger.error('error message')
        logger.critical('critical message')
        time.sleep(5)
except KeyboardInterrupt:
    # cleanup
    logging.config.stopListening()
    t.join()
@end example

Y aquí hay un script que toma un nombre de archivo y envía ese archivo al servidor, precedido adecuadamente con la longitud codificada en binario, como la nueva configuración de logging:

@example
#!/usr/bin/env python
import socket, sys, struct

with open(sys.argv[1], 'rb') as f:
    data_to_send = f.read()

HOST = 'localhost'
PORT = 9999
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print('connecting...')
s.connect((HOST, PORT))
print('sending config...')
s.send(struct.pack('>L', len(data_to_send)))
s.send(data_to_send)
s.close()
print('complete')
@end example

@node Tratar con gestores que bloquean,Enviar y recibir eventos logging a través de una red,Ejemplo de servidor de configuración,Libro de recetas de Logging
@anchor{howto/logging-cookbook blocking-handlers}@anchor{333d}@anchor{howto/logging-cookbook dealing-with-handlers-that-block}@anchor{4ec1}
@subsection Tratar con gestores que bloquean


A veces tiene que hacer que sus gestores de registro hagan su trabajo sin bloquear el hilo desde el que está iniciando sesión. Esto es común en las aplicaciones web, aunque, por supuesto, también ocurre en otros escenarios.

Un responsable habitual que ejemplifica un comportamiento lento es la @ref{2d7e,,SMTPHandler}: el envío de correos electrónicos puede llevar mucho tiempo, por varias razones fuera del control del desarrollador (por ejemplo, una infraestructura de red o correo de bajo rendimiento). Pero casi cualquier controlador basado en red puede bloquear: incluso una operación @ref{fe2,,SocketHandler} puede estar haciendo a bajo nivel una consulta DNS  que es demasiado lenta (y esta consulta puede estar en el código de la biblioteca de socket, debajo de la capa de Python, y fuera de su control).

Una solución es utilizar un enfoque de dos partes. Para la primera parte, adjunte solo una @ref{17de,,QueueHandler} a los loggers que se acceden desde subprocesos críticos de rendimiento. Simplemente escriben en su cola, que puede dimensionarse a una capacidad lo suficientemente grande o inicializarse sin límite superior a su tamaño. La escritura en la cola generalmente se aceptará rápidamente, aunque es probable que deba atrapar la excepción @ref{30a2,,queue.Full} como precaución en su código. Si usted es un desarrollador de bibliotecas que tiene subprocesos críticos de rendimiento en su código, asegúrese de documentar esto (junto con una sugerencia de adjuntar solo @code{QueueHandlers} a sus loggers) para el beneficio de otros desarrolladores que usarán su código.

La segunda parte de la solución es @ref{eb1,,QueueListener}, que fue designado como la contraparte de @ref{17de,,QueueHandler}. Un @ref{eb1,,QueueListener} es muy simple: ha pasado una cola y algunos gestores, y activa un hilo interno que escucha su cola para `LogRecords' enviados desde @code{QueueHandlers} (o cualquier otra fuente de @code{LogRecords}, para el caso). Los @code{LogRecords} se eliminan de la cola y se pasan a los gestores para su procesamiento.

La ventaja de tener una clase separada @ref{eb1,,QueueListener} es que puede usar la misma instancia para dar servicio a múltiples @code{QueueHandlers}. Esto es más amigable con los recursos que, por ejemplo, tener versiones enhebradas de las clases de gestores existentes, que consumirían un hilo por gestor sin ningún beneficio particular.

Un ejemplo del uso de estas dos clases a continuación (se omiten `imports'):

@example
que = queue.Queue(-1)  # no limit on size
queue_handler = QueueHandler(que)
handler = logging.StreamHandler()
listener = QueueListener(que, handler)
root = logging.getLogger()
root.addHandler(queue_handler)
formatter = logging.Formatter('%(threadName)s: %(message)s')
handler.setFormatter(formatter)
listener.start()
# The log output will display the thread which generated
# the event (the main thread) rather than the internal
# thread which monitors the internal queue. This is what
# you want to happen.
root.warning('Look out!')
listener.stop()
@end example

que, cuando se ejecuta, producirá:

@example
MainThread: Look out!
@end example

@cartouche
@quotation Nota 
Aunque la discusión anterior no se refería específicamente al código asíncrono, sino más bien a los gestores de logging lentos, hay que tener en cuenta que cuando se realiza logging desde código asíncrono, los gestores de red e incluso de archivos podrían dar problemas (bloqueo del bucle de eventos) porque parte del logging se realiza desde los internos de @ref{b,,asyncio}. Podría ser mejor, si se utiliza cualquier código asíncrono en una aplicación, utilizar el enfoque anterior para el logging, de modo que cualquier código de bloqueo se ejecute sólo en el hilo @code{QueueListener}.
@end quotation
@end cartouche


Distinto en la versión 3.5: Antes de Python 3.5, @ref{eb1,,QueueListener} siempre pasaba cada mensaje recibido de la cola a cada controlador con el que se inicializaba. (Esto se debió a que se asumió que el filtrado de nivel se realizó en el otro lado, donde se llena la cola). A partir de 3.5, este comportamiento se puede cambiar pasando un argumento de palabra clave @code{respect_handler_level=True} al constructor del oyente . Cuando se hace esto, el oyente compara el nivel de cada mensaje con el nivel del controlador y solo pasa un mensaje a un controlador si es apropiado hacerlo.


@node Enviar y recibir eventos logging a través de una red,Agregar información contextual a su salida de logging,Tratar con gestores que bloquean,Libro de recetas de Logging
@anchor{howto/logging-cookbook network-logging}@anchor{4ec2}@anchor{howto/logging-cookbook sending-and-receiving-logging-events-across-a-network}@anchor{4ec3}
@subsection Enviar y recibir eventos logging a través de una red


Supongamos que desea enviar eventos de registro a través de una red y gestionarlos en el extremo receptor. Una forma sencilla de hacer esto es adjuntar una instancia de @ref{fe2,,SocketHandler} al registrador raíz en el extremo de envío:

@example
import logging, logging.handlers

rootLogger = logging.getLogger('@w{'})
rootLogger.setLevel(logging.DEBUG)
socketHandler = logging.handlers.SocketHandler('localhost',
                    logging.handlers.DEFAULT_TCP_LOGGING_PORT)
# don't bother with a formatter, since a socket handler sends the event as
# an unformatted pickle
rootLogger.addHandler(socketHandler)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')
@end example

En el extremo receptor, puede configurar un receptor usando el módulo @ref{cd,,socketserver}. Aquí hay un ejemplo básico de trabajo:

@example
import pickle
import logging
import logging.handlers
import socketserver
import struct


class LogRecordStreamHandler(socketserver.StreamRequestHandler):
    """Handler for a streaming logging request.

    This basically logs the record using whatever logging policy is
    configured locally.
    """

    def handle(self):
        """
        Handle multiple requests - each expected to be a 4-byte length,
        followed by the LogRecord in pickle format. Logs the record
        according to whatever policy is configured locally.
        """
        while True:
            chunk = self.connection.recv(4)
            if len(chunk) < 4:
                break
            slen = struct.unpack('>L', chunk)[0]
            chunk = self.connection.recv(slen)
            while len(chunk) < slen:
                chunk = chunk + self.connection.recv(slen - len(chunk))
            obj = self.unPickle(chunk)
            record = logging.makeLogRecord(obj)
            self.handleLogRecord(record)

    def unPickle(self, data):
        return pickle.loads(data)

    def handleLogRecord(self, record):
        # if a name is specified, we use the named logger rather than the one
        # implied by the record.
        if self.server.logname is not None:
            name = self.server.logname
        else:
            name = record.name
        logger = logging.getLogger(name)
        # N.B. EVERY record gets logged. This is because Logger.handle
        # is normally called AFTER logger-level filtering. If you want
        # to do filtering, do it at the client end to save wasting
        # cycles and network bandwidth!
        logger.handle(record)

class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
    """
    Simple TCP socket-based logging receiver suitable for testing.
    """

    allow_reuse_address = True

    def __init__(self, host='localhost',
                 port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
                 handler=LogRecordStreamHandler):
        socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
        self.abort = 0
        self.timeout = 1
        self.logname = None

    def serve_until_stopped(self):
        import select
        abort = 0
        while not abort:
            rd, wr, ex = select.select([self.socket.fileno()],
                                       [], [],
                                       self.timeout)
            if rd:
                self.handle_request()
            abort = self.abort

def main():
    logging.basicConfig(
        format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')
    tcpserver = LogRecordSocketReceiver()
    print('About to start TCP server...')
    tcpserver.serve_until_stopped()

if __name__ == '__main__':
    main()
@end example

Primero ejecuta el servidor, y luego el cliente. Del lado del cliente, nada se imprime en la consola; del lado del servidor, se debería ver algo como esto:

@example
About to start TCP server...
   59 root            INFO     Jackdaws love my big sphinx of quartz.
   59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.
   69 myapp.area1     INFO     How quickly daft jumping zebras vex.
   69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.
   69 myapp.area2     ERROR    The five boxing wizards jump quickly.
@end example

Note that there are some security issues with pickle in some scenarios. If
these affect you, you can use an alternative serialization scheme by overriding
the @ref{2d67,,makePickle()} method and implementing your
alternative there, as well as adapting the above script to use your alternative
serialization.

@menu
* Ejecutando un logging de socket oyente en producción:: 

@end menu

@node Ejecutando un logging de socket oyente en producción,,,Enviar y recibir eventos logging a través de una red
@anchor{howto/logging-cookbook running-a-logging-socket-listener-in-production}@anchor{4ec4}
@subsubsection Ejecutando un logging de socket oyente en producción


To run a logging listener in production, you may need to use a
process-management tool such as Supervisor@footnote{http://supervisord.org/}.
Here is a Gist@footnote{https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b}
which provides the bare-bones files to run the above functionality using
Supervisor. It consists of the following files:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

File

@tab

Purpose

@item

@code{prepare.sh}

@tab

A Bash script to prepare the environment for
testing

@item

@code{supervisor.conf}

@tab

The Supervisor configuration file, which has
entries for the listener and a multi-process web
application

@item

@code{ensure_app.sh}

@tab

A Bash script to ensure that Supervisor is running
with the above configuration

@item

@code{log_listener.py}

@tab

The socket listener program which receives log
events and records them to a file

@item

@code{main.py}

@tab

A simple web application which performs logging
via a socket connected to the listener

@item

@code{webapp.json}

@tab

A JSON configuration file for the web application

@item

@code{client.py}

@tab

A Python script to exercise the web application

@end multitable


The web application uses Gunicorn@footnote{https://gunicorn.org/}, which is a
popular web application server that starts multiple worker processes to handle
requests. This example setup shows how the workers can write to the same log file
without conflicting with one another — they all go through the socket listener.

To test these files, do the following in a POSIX environment:


@enumerate 

@item 
Download the Gist@footnote{https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b}
as a ZIP archive using the Download ZIP button.

@item 
Unzip the above files from the archive into a scratch directory.

@item 
In the scratch directory, run @code{bash prepare.sh} to get things ready.
This creates a @code{run} subdirectory to contain Supervisor-related and
log files, and a @code{venv} subdirectory to contain a virtual environment
into which @code{bottle}, @code{gunicorn} and @code{supervisor} are installed.

@item 
Run @code{bash ensure_app.sh} to ensure that Supervisor is running with
the above configuration.

@item 
Run @code{venv/bin/python client.py} to exercise the web application,
which will lead to records being written to the log.

@item 
Inspect the log files in the @code{run} subdirectory. You should see the
most recent log lines in files matching the pattern @code{app.log*}. They won’t be in
any particular order, since they have been handled concurrently by different
worker processes in a non-deterministic way.

@item 
You can shut down the listener and the web application by running
@code{venv/bin/supervisorctl -c supervisor.conf shutdown}.
@end enumerate

You may need to tweak the configuration files in the unlikely event that the
configured ports clash with something else in your test environment.

@node Agregar información contextual a su salida de logging,Uso de contextvars,Enviar y recibir eventos logging a través de una red,Libro de recetas de Logging
@anchor{howto/logging-cookbook adding-contextual-information-to-your-logging-output}@anchor{4ec5}@anchor{howto/logging-cookbook context-info}@anchor{2d08}
@subsection Agregar información contextual a su salida de logging


A veces, desea que la salida de logging contenga información contextual además de los parámetros pasados a la llamada del logging. Por ejemplo, en una aplicación en red, puede ser conveniente registrar información específica del cliente en el logging (por ejemplo, el nombre de usuario del cliente remoto o la dirección IP). Aunque puede usar el parámetro `extra' para lograr esto, no siempre es conveniente pasar la información de esta manera. Si bien puede resultar tentador crear instancias @ref{bd7,,Logger} por conexión, esta no es una buena idea porque estas instancias no se liberan de memoria vía el recolector de basura (`garbage collector'). Si bien esto no es un problema en la práctica, cuando el número de instancias de @ref{bd7,,Logger} depende del nivel de granularidad que desea usar para hacer el logging de una aplicación, podría ser difícil de administrar si el número de instancias @ref{bd7,,Logger} se vuelven efectivamente ilimitadas.

@menu
* Uso de LoggerAdapters para impartir información contextual:: 
* Usar filtros para impartir información contextual:: 

@end menu

@node Uso de LoggerAdapters para impartir información contextual,Usar filtros para impartir información contextual,,Agregar información contextual a su salida de logging
@anchor{howto/logging-cookbook using-loggeradapters-to-impart-contextual-information}@anchor{4ec6}
@subsubsection Uso de LoggerAdapters para impartir información contextual


Una manera fácil de pasar información contextual para que se genere junto con la información de eventos logging es usar la clase @ref{135c,,LoggerAdapter}. Esta clase está diseñada para parecerse a @ref{bd7,,Logger}, de modo que pueda llamar @ref{2cd2,,debug()}, @ref{2cfc,,info()}, @ref{1f7,,warning()}, @ref{2d10,,error()}, @code{excepción()}, @ref{2d11,,critical()} y @ref{2d12,,log()}. Estos métodos tienen las mismas signaturas que sus contrapartes en @ref{bd7,,Logger}, por lo que puede usar los dos tipos de instancias indistintamente.

Cuando creas una instancia de @ref{135c,,LoggerAdapter}, le pasas una instancia de @ref{bd7,,Logger} y un objeto similar a un dict que contiene tu información contextual. Cuando llamas a uno de los métodos de registro en una instancia de @ref{135c,,LoggerAdapter}, delega la llamada a la instancia subyacente de @ref{bd7,,Logger} pasada a su constructor, y se arregla para pasar la información contextual en la llamada delegada . Aquí hay un fragmento del código de @ref{135c,,LoggerAdapter}:

@example
def debug(self, msg, /, *args, **kwargs):
    """
    Delegate a debug call to the underlying logger, after adding
    contextual information from this adapter instance.
    """
    msg, kwargs = self.process(msg, kwargs)
    self.logger.debug(msg, *args, **kwargs)
@end example

El método @ref{2d09,,process()} de @ref{135c,,LoggerAdapter} es donde la información contextual se agrega a la salida del logging. Se pasa el mensaje y los argumentos de palabra clave de la llamada logging, y retorna versiones (potencialmente) modificadas de estos para usar en la llamada al logging subyacente. La implementación predeterminada de este método deja el mensaje solo, pero inserta una clave “extra” en el argumento de palabra clave cuyo valor es el objeto tipo dict pasado al constructor. Por supuesto, si ha pasado un argumento de palabra clave “extra” en la llamada al adaptador, se sobrescribirá silenciosamente.

La ventaja de usar “extra” es que los valores en el objeto dict se combinan en la instancia @ref{1065,,LogRecord} __dict__, lo que le permite usar cadenas personalizadas con sus instancias @ref{14d1,,Formatter} que conocen las claves del objeto dict. Si necesita un método diferente, por ejemplo, si desea anteponer o agregar la información contextual a la cadena del mensaje, solo necesita la subclase @ref{135c,,LoggerAdapter} y anular @ref{2d09,,process()} para hacer lo que necesita. Aquí hay un ejemplo simple:

@example
class CustomAdapter(logging.LoggerAdapter):
    """
    This example adapter expects the passed in dict-like object to have a
    'connid' key, whose value in brackets is prepended to the log message.
    """
    def process(self, msg, kwargs):
        return '[%s] %s' % (self.extra['connid'], msg), kwargs
@end example

que puede usar así:

@example
logger = logging.getLogger(__name__)
adapter = CustomAdapter(logger, @{'connid': some_conn_id@})
@end example

Luego, cualquier evento que registre en el adaptador tendrá el valor de @code{some_conn_id} antepuesto a los mensajes de logging.

@menu
* Usar objetos distintos a los diccionarios para transmitir información contextual:: 

@end menu

@node Usar objetos distintos a los diccionarios para transmitir información contextual,,,Uso de LoggerAdapters para impartir información contextual
@anchor{howto/logging-cookbook using-objects-other-than-dicts-to-pass-contextual-information}@anchor{4ec7}
@subsubsection Usar objetos distintos a los diccionarios para transmitir información contextual


No es necesario pasar un diccionario real a la @ref{135c,,LoggerAdapter} - puedes pasar una instancia de una clase que implemente @code{__getitem__} y @code{__iter__} de modo que parezca un diccionario para el logging. Esto es útil si quieres generar valores dinámicamente (mientras que los valores en un diccionario son constantes).

@node Usar filtros para impartir información contextual,,Uso de LoggerAdapters para impartir información contextual,Agregar información contextual a su salida de logging
@anchor{howto/logging-cookbook filters-contextual}@anchor{2cfd}@anchor{howto/logging-cookbook using-filters-to-impart-contextual-information}@anchor{4ec8}
@subsubsection Usar filtros para impartir información contextual


También puedes agregar información contextual a la salida del log utilizando un @ref{1268,,Filter} definido por el usuario. Las instancias de @code{Filter} pueden modificar los @code{LogRecords} que se les pasan, incluido el agregado de atributos adicionales que luego se pueden generar utilizando cadena de caracteres con el formato adecuado, o si es necesario, un @ref{14d1,,Formatter} personalizado.

Por ejemplo, en una aplicación web, la solicitud que se está procesando (o al menos, las partes interesantes de la misma) se pueden almacenar en una variable `threadlocal' (@ref{1773,,threading.local}) y luego se puede acceder a ella desde @code{Filter} para agregar información de la solicitud, - digamos, la dirección IP remota y el nombre de usuario-, al @code{LogRecord}, usando los nombres de atributo “ip” y “user” como en el ejemplo anterior de @code{LoggerAdapter}. En ese caso, se puede usar el mismo formato de cadena de caracteres para obtener un resultado similar al que se muestra arriba. Aquí hay un script de ejemplo:

@example
import logging
from random import choice

class ContextFilter(logging.Filter):
    """
    This is a filter which injects contextual information into the log.

    Rather than use actual contextual information, we just use random
    data in this demo.
    """

    USERS = ['jim', 'fred', 'sheila']
    IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']

    def filter(self, record):

        record.ip = choice(ContextFilter.IPS)
        record.user = choice(ContextFilter.USERS)
        return True

if __name__ == '__main__':
    levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s')
    a1 = logging.getLogger('a.b.c')
    a2 = logging.getLogger('d.e.f')

    f = ContextFilter()
    a1.addFilter(f)
    a2.addFilter(f)
    a1.debug('A debug message')
    a1.info('An info message with %s', 'some parameters')
    for x in range(10):
        lvl = choice(levels)
        lvlname = logging.getLevelName(lvl)
        a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')
@end example

que cuando se ejecuta, produce algo como:

@example
2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message
2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters
2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters
@end example

@node Uso de contextvars,Impartir información contextual en los gestores,Agregar información contextual a su salida de logging,Libro de recetas de Logging
@anchor{howto/logging-cookbook use-of-contextvars}@anchor{4ec9}
@subsection Uso de @code{contextvars}


Desde la versión 3.7 de Python, el módulo @ref{25,,contextvars} ha proporcionado almacenamiento local de contexto que funciona tanto para las necesidades de procesamiento de @ref{ed,,threading} como de @ref{b,,asyncio}. Este tipo de almacenamiento puede ser, por tanto, preferible a los hilos locales. El siguiente ejemplo muestra cómo, en un entorno multihilo, los logs pueden rellenarse con información contextual como, por ejemplo, los atributos de las peticiones gestionadas por las aplicaciones web.

A modo de ilustración, digamos que tienes diferentes aplicaciones web, cada una de ellas independiente de la otra, pero que se ejecutan en el mismo proceso de Python y utilizan una biblioteca común a todas ellas. ¿Cómo puede cada una de estas aplicaciones tener su propio registro, donde todos los mensajes de logging de la biblioteca (y otro código de procesamiento de solicitudes) se dirigen al archivo de registro de la aplicación apropiada, mientras se incluye en el registro información contextual adicional como la IP del cliente, el método de solicitud HTTP y el nombre de usuario del cliente?

Supongamos que la biblioteca se puede simular con el siguiente código:

@example
# webapplib.py
import logging
import time

logger = logging.getLogger(__name__)

def useful():
    # Just a representative event logged from the library
    logger.debug('Hello from webapplib!')
    # Just sleep for a bit so other threads get to run
    time.sleep(0.01)
@end example

Podemos simular las aplicaciones web múltiples mediante dos clases simples, @code{Request} y @code{WebApp}. Éstas simulan cómo funcionan las aplicaciones web reales con hilos, cada petición es manejada por un hilo:

@example
# main.py
import argparse
from contextvars import ContextVar
import logging
import os
from random import choice
import threading
import webapplib

logger = logging.getLogger(__name__)
root = logging.getLogger()
root.setLevel(logging.DEBUG)

class Request:
    """
    A simple dummy request class which just holds dummy HTTP request method,
    client IP address and client username
    """
    def __init__(self, method, ip, user):
        self.method = method
        self.ip = ip
        self.user = user

# A dummy set of requests which will be used in the simulation - we'll just pick
# from this list randomly. Note that all GET requests are from 192.168.2.XXX
# addresses, whereas POST requests are from 192.16.3.XXX addresses. Three users
# are represented in the sample requests.

REQUESTS = [
    Request('GET', '192.168.2.20', 'jim'),
    Request('POST', '192.168.3.20', 'fred'),
    Request('GET', '192.168.2.21', 'sheila'),
    Request('POST', '192.168.3.21', 'jim'),
    Request('GET', '192.168.2.22', 'fred'),
    Request('POST', '192.168.3.22', 'sheila'),
]

# Note that the format string includes references to request context information
# such as HTTP method, client IP and username

formatter = logging.Formatter('%(threadName)-11s %(appName)s %(name)-9s %(user)-6s %(ip)s %(method)-4s %(message)s')

# Create our context variables. These will be filled at the start of request
# processing, and used in the logging that happens during that processing

ctx_request = ContextVar('request')
ctx_appname = ContextVar('appname')

class InjectingFilter(logging.Filter):
    """
    A filter which injects context-specific information into logs and ensures
    that only information for a specific webapp is included in its log
    """
    def __init__(self, app):
        self.app = app

    def filter(self, record):
        request = ctx_request.get()
        record.method = request.method
        record.ip = request.ip
        record.user = request.user
        record.appName = appName = ctx_appname.get()
        return appName == self.app.name

class WebApp:
    """
    A dummy web application class which has its own handler and filter for a
    webapp-specific log.
    """
    def __init__(self, name):
        self.name = name
        handler = logging.FileHandler(name + '.log', 'w')
        f = InjectingFilter(self)
        handler.setFormatter(formatter)
        handler.addFilter(f)
        root.addHandler(handler)
        self.num_requests = 0

    def process_request(self, request):
        """
        This is the dummy method for processing a request. It's called on a
        different thread for every request. We store the context information into
        the context vars before doing anything else.
        """
        ctx_request.set(request)
        ctx_appname.set(self.name)
        self.num_requests += 1
        logger.debug('Request processing started')
        webapplib.useful()
        logger.debug('Request processing finished')

def main():
    fn = os.path.splitext(os.path.basename(__file__))[0]
    adhf = argparse.ArgumentDefaultsHelpFormatter
    ap = argparse.ArgumentParser(formatter_class=adhf, prog=fn,
                                 description='Simulate a couple of web '
                                             'applications handling some '
                                             'requests, showing how request '
                                             'context can be used to '
                                             'populate logs')
    aa = ap.add_argument
    aa('--count', '-c', type=int, default=100, help='How many requests to simulate')
    options = ap.parse_args()

    # Create the dummy webapps and put them in a list which we can use to select
    # from randomly
    app1 = WebApp('app1')
    app2 = WebApp('app2')
    apps = [app1, app2]
    threads = []
    # Add a common handler which will capture all events
    handler = logging.FileHandler('app.log', 'w')
    handler.setFormatter(formatter)
    root.addHandler(handler)

    # Generate calls to process requests
    for i in range(options.count):
        try:
            # Pick an app at random and a request for it to process
            app = choice(apps)
            request = choice(REQUESTS)
            # Process the request in its own thread
            t = threading.Thread(target=app.process_request, args=(request,))
            threads.append(t)
            t.start()
        except KeyboardInterrupt:
            break

    # Wait for the threads to terminate
    for t in threads:
        t.join()

    for app in apps:
        print('%s processed %s requests' % (app.name, app.num_requests))

if __name__ == '__main__':
    main()
@end example

Si ejecuta lo anterior, debería encontrar que aproximadamente la mitad de las peticiones van a @code{app1.log} y el resto a @code{app2.log}, y las todas las peticiones se registran en @code{app.log}. Cada registro específico de la aplicación web contendrá únicamente entradas de log para esa aplicación web, y la información de las peticiones se mostrará de forma consistente en el registro (es decir, la información de cada petición ficticia aparecerá siempre junta en una línea de log). Esto se ilustra con la siguiente salida del shell:

@example
~/logging-contextual-webapp$ python main.py
app1 processed 51 requests
app2 processed 49 requests
~/logging-contextual-webapp$ wc -l *.log
  153 app1.log
  147 app2.log
  300 app.log
  600 total
~/logging-contextual-webapp$ head -3 app1.log
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ head -3 app2.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
~/logging-contextual-webapp$ head app.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-2 (process_request) app2 webapplib jim    192.168.2.20 GET  Hello from webapplib!
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-4 (process_request) app2 __main__  fred   192.168.2.22 GET  Request processing started
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-4 (process_request) app2 webapplib fred   192.168.2.22 GET  Hello from webapplib!
Thread-6 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ grep app1 app1.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app2.log | wc -l
147
~/logging-contextual-webapp$ grep app1 app.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app.log | wc -l
147
@end example

@node Impartir información contextual en los gestores,Logging a un sólo archivo desde múltiples procesos,Uso de contextvars,Libro de recetas de Logging
@anchor{howto/logging-cookbook imparting-contextual-information-in-handlers}@anchor{4eca}
@subsection Impartir información contextual en los gestores


Cada @ref{14d0,,Handler} tiene su propia cadena de filtros. Si quieres añadir información contextual a una @ref{1065,,LogRecord} sin filtrarla a otros gestores, puedes utilizar un filtro que retorna una nueva @ref{1065,,LogRecord} en lugar de modificarlo in situ, como se muestra en el siguiente script:

@example
import copy
import logging

def filter(record: logging.LogRecord):
    record = copy.copy(record)
    record.user = 'jim'
    return record

if __name__ == '__main__':
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    handler = logging.StreamHandler()
    formatter = logging.Formatter('%(message)s from %(user)-8s')
    handler.setFormatter(formatter)
    handler.addFilter(filter)
    logger.addHandler(handler)

    logger.info('A log message')
@end example

@node Logging a un sólo archivo desde múltiples procesos,Usando rotación de archivos,Impartir información contextual en los gestores,Libro de recetas de Logging
@anchor{howto/logging-cookbook logging-to-a-single-file-from-multiple-processes}@anchor{4ecb}@anchor{howto/logging-cookbook multiple-processes}@anchor{4ecc}
@subsection Logging a un sólo archivo desde múltiples procesos


Aunque logging es seguro para hilos, y el logging a un solo archivo desde múltiples hilos en un solo proceso `es' compatible, el logging en un solo archivo desde `múltiples procesos' `no' es compatible, porque no existe una forma estándar de serializar el acceso a un solo archivo en múltiples procesos en Python. Si necesita hacer esto último, una forma de abordarlo es hacer que todos los procesos se registren en una @ref{fe2,,SocketHandler}, y tener un proceso separado que implemente un servidor de socket que lee del socket y los loggings para archivar. (Si lo prefiere, puede dedicar un hilo en uno de los procesos existentes para realizar esta función.) @ref{4ec2,,Esta sección} documenta este enfoque con más detalle e incluye un receptor socket que funciona que se puede utilizar como punto de partida para que se adapte a sus propias aplicaciones.

You could also write your own handler which uses the @ref{159b,,Lock}
class from the @ref{94,,multiprocessing} module to serialize access to the
file from your processes. The stdlib @ref{18a7,,FileHandler} and subclasses do
not make use of @ref{94,,multiprocessing}.

Alternativamente, puede usar una @code{Queue} y @ref{17de,,QueueHandler} para enviar todos los logging a uno de los procesos en su aplicación multi-proceso. El siguiente script de ejemplo demuestra cómo puede hacer esto; en el ejemplo, un proceso de escucha independiente escucha los eventos enviados por otros procesos y los registra de acuerdo con su propia configuración de logging. Aunque el ejemplo solo demuestra una forma de hacerlo (por ejemplo, es posible que desee utilizar un hilo de escucha en lugar de un proceso de escucha separado; la implementación sería análoga), permite configuraciones de logging completamente diferentes para el oyente y los otros procesos en su aplicación. Y se puede utilizar como base para el código que cumpla con sus propios requisitos específicos:

@example
# You'll need these imports in your own code
import logging
import logging.handlers
import multiprocessing

# Next two import lines for this demo only
from random import choice, random
import time

#
# Because you'll want to define the logging configurations for listener and workers, the
# listener and worker process functions take a configurer parameter which is a callable
# for configuring logging for that process. These functions are also passed the queue,
# which they use for communication.
#
# In practice, you can configure the listener however you want, but note that in this
# simple example, the listener does not apply level or filter logic to received records.
# In practice, you would probably want to do this logic in the worker processes, to avoid
# sending events which would be filtered out between processes.
#
# The size of the rotated files is made small so you can see the results easily.
def listener_configurer():
    root = logging.getLogger()
    h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)
    f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')
    h.setFormatter(f)
    root.addHandler(h)

# This is the listener process top-level loop: wait for logging events
# (LogRecords)on the queue and handle them, quit when you get a None for a
# LogRecord.
def listener_process(queue, configurer):
    configurer()
    while True:
        try:
            record = queue.get()
            if record is None:  # We send this as a sentinel to tell the listener to quit.
                break
            logger = logging.getLogger(record.name)
            logger.handle(record)  # No level or filter logic applied - just do it!
        except Exception:
            import sys, traceback
            print('Whoops! Problem:', file=sys.stderr)
            traceback.print_exc(file=sys.stderr)

# Arrays used for random selections in this demo

LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,
          logging.ERROR, logging.CRITICAL]

LOGGERS = ['a.b.c', 'd.e.f']

MESSAGES = [
    'Random message #1',
    'Random message #2',
    'Random message #3',
]

# The worker configuration is done at the start of the worker process run.
# Note that on Windows you can't rely on fork semantics, so each process
# will run the logging configuration code when it starts.
def worker_configurer(queue):
    h = logging.handlers.QueueHandler(queue)  # Just the one handler needed
    root = logging.getLogger()
    root.addHandler(h)
    # send all messages, for demo; no other level or filter logic applied.
    root.setLevel(logging.DEBUG)

# This is the worker process top-level loop, which just logs ten events with
# random intervening delays before terminating.
# The print messages are just so you know it's doing something!
def worker_process(queue, configurer):
    configurer(queue)
    name = multiprocessing.current_process().name
    print('Worker started: %s' % name)
    for i in range(10):
        time.sleep(random())
        logger = logging.getLogger(choice(LOGGERS))
        level = choice(LEVELS)
        message = choice(MESSAGES)
        logger.log(level, message)
    print('Worker finished: %s' % name)

# Here's where the demo gets orchestrated. Create the queue, create and start
# the listener, create ten workers and start them, wait for them to finish,
# then send a None to the queue to tell the listener to finish.
def main():
    queue = multiprocessing.Queue(-1)
    listener = multiprocessing.Process(target=listener_process,
                                       args=(queue, listener_configurer))
    listener.start()
    workers = []
    for i in range(10):
        worker = multiprocessing.Process(target=worker_process,
                                         args=(queue, worker_configurer))
        workers.append(worker)
        worker.start()
    for w in workers:
        w.join()
    queue.put_nowait(None)
    listener.join()

if __name__ == '__main__':
    main()
@end example

Una variante del script anterior mantiene el logging en el proceso principal, en un hilo separado:

@example
import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue
import random
import threading
import time

def logger_thread(q):
    while True:
        record = q.get()
        if record is None:
            break
        logger = logging.getLogger(record.name)
        logger.handle(record)


def worker_process(q):
    qh = logging.handlers.QueueHandler(q)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(qh)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)

if __name__ == '__main__':
    q = Queue()
    d = @{
        'version': 1,
        'formatters': @{
            'detailed': @{
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @}
        @},
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'level': 'INFO',
            @},
            'file': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed',
            @},
            'foofile': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed',
            @},
            'errors': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'level': 'ERROR',
                'formatter': 'detailed',
            @},
        @},
        'loggers': @{
            'foo': @{
                'handlers': ['foofile']
            @}
        @},
        'root': @{
            'level': 'DEBUG',
            'handlers': ['console', 'file', 'errors']
        @},
    @}
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))
        workers.append(wp)
        wp.start()
    logging.config.dictConfig(d)
    lp = threading.Thread(target=logger_thread, args=(q,))
    lp.start()
    # At this point, the main process could do some useful work of its own
    # Once it's done that, it can wait for the workers to terminate...
    for wp in workers:
        wp.join()
    # And now tell the logging thread to finish up, too
    q.put(None)
    lp.join()
@end example

Esta variante muestra cómo puede, por ejemplo, aplicar la configuración para logging particulares: el registrador @code{foo} tiene un gestor especial que almacena todos los eventos en el subsistema @code{foo} en un archivo @code{mplog-foo.log}. Esto será utilizado por la maquinaria de logging en el proceso principal (aunque los eventos logging se generen en los procesos de trabajo) para dirigir los mensajes a los destinos apropiados.

@menu
* Usando concurrent.futures.ProcessPoolExecutor: Usando concurrent futures ProcessPoolExecutor. 
* Despliegue de aplicaciones web con Gunicorn y uWSGI:: 

@end menu

@node Usando concurrent futures ProcessPoolExecutor,Despliegue de aplicaciones web con Gunicorn y uWSGI,,Logging a un sólo archivo desde múltiples procesos
@anchor{howto/logging-cookbook using-concurrent-futures-processpoolexecutor}@anchor{4ecd}
@subsubsection Usando concurrent.futures.ProcessPoolExecutor


Si desea utilizar @ref{163,,concurrent.futures.ProcessPoolExecutor} para iniciar sus procesos de trabajo, debe crear la cola de manera ligeramente diferente. En vez de

@example
queue = multiprocessing.Queue(-1)
@end example

debería usar

@example
queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above
@end example

y luego puede reemplazar la creación del trabajador de esto:

@example
workers = []
for i in range(10):
    worker = multiprocessing.Process(target=worker_process,
                                     args=(queue, worker_configurer))
    workers.append(worker)
    worker.start()
for w in workers:
    w.join()
@end example

a esto (recuerda el primer `import' @ref{22,,concurrent.futures}):

@example
with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:
    for i in range(10):
        executor.submit(worker_process, queue, worker_configurer)
@end example

@node Despliegue de aplicaciones web con Gunicorn y uWSGI,,Usando concurrent futures ProcessPoolExecutor,Logging a un sólo archivo desde múltiples procesos
@anchor{howto/logging-cookbook deploying-web-applications-using-gunicorn-and-uwsgi}@anchor{4ece}
@subsubsection Despliegue de aplicaciones web con Gunicorn y uWSGI


Cuando se despliegan aplicaciones web utilizando Gunicorn@footnote{https://gunicorn.org/} o uWSGI@footnote{https://uwsgi-docs.readthedocs.io/en/latest/} (o similares), se crean múltiples procesos de trabajo para gestionar las peticiones de los clientes. En estos entornos, evite crear gestores basados directamente en archivos en su aplicación web. En su lugar, utilice un @ref{fe2,,SocketHandler} para registrar desde la aplicación web al oyente en un proceso separado. Esto puede configurarse usando una herramienta de gestión de procesos como Supervisor - vea @ref{4ec4,,Running a logging socket listener in production} para más detalles.

@node Usando rotación de archivos,Uso de estilos de formato alternativos,Logging a un sólo archivo desde múltiples procesos,Libro de recetas de Logging
@anchor{howto/logging-cookbook using-file-rotation}@anchor{4ecf}
@subsection Usando rotación de archivos


@c (see <https://pymotw.com/3/logging/>)

Sometimes you want to let a log file grow to a certain size, then open a new
file and log to that. You may want to keep a certain number of these files, and
when that many files have been created, rotate the files so that the number of
files and the size of the files both remain bounded. For this usage pattern, the
logging package provides a @ref{15d9,,RotatingFileHandler}:

@example
import glob
import logging
import logging.handlers

LOG_FILENAME = 'logging_rotatingfile_example.out'

# Set up a specific logger with our desired output level
my_logger = logging.getLogger('MyLogger')
my_logger.setLevel(logging.DEBUG)

# Add the log message handler to the logger
handler = logging.handlers.RotatingFileHandler(
              LOG_FILENAME, maxBytes=20, backupCount=5)

my_logger.addHandler(handler)

# Log some messages
for i in range(20):
    my_logger.debug('i = %d' % i)

# See what files are created
logfiles = glob.glob('%s*' % LOG_FILENAME)

for filename in logfiles:
    print(filename)
@end example

El resultado debe ser 6 archivos separados, cada uno con parte del historial de log de la aplicación:

@example
logging_rotatingfile_example.out
logging_rotatingfile_example.out.1
logging_rotatingfile_example.out.2
logging_rotatingfile_example.out.3
logging_rotatingfile_example.out.4
logging_rotatingfile_example.out.5
@end example

El archivo más actual siempre es @code{logging_rotatingfile_example.out}, y cada vez que alcanza el límite de tamaño, se le cambia el nombre con el sufijo @code{.1}. Se cambia el nombre de cada uno de los archivos de respaldo existentes para incrementar el sufijo (@code{.1} se convierte en @code{.2}, etc.) y se borra el archivo @code{.6}.

Obviamente, este ejemplo establece la longitud del log demasiado pequeña como un ejemplo extremo. Se querrá establecer `maxBytes' en un valor apropiado.

@node Uso de estilos de formato alternativos,Personalización de LogRecord,Usando rotación de archivos,Libro de recetas de Logging
@anchor{howto/logging-cookbook format-styles}@anchor{4ed0}@anchor{howto/logging-cookbook use-of-alternative-formatting-styles}@anchor{4ed1}
@subsection Uso de estilos de formato alternativos


Cuando se agregó logging a la biblioteca estándar de Python, la única forma de formatear mensajes con contenido variable era usar el método de formateo %. Desde entonces, Python ha ganado dos nuevos enfoques de formato: @ref{728,,string.Template} (agregado en Python 2.4) y @ref{6c2,,str.format()} (agregado en Python 2.6).

Logging (a partir de la versión 3.2) proporciona un soporte mejorado para estos dos estilos de formato adicionales. La clase @ref{14d1,,Formatter} ha sido mejorada para tomar un parámetro de palabra clave adicional llamado @code{style}. El valor predeterminado es @code{'%'}, pero otros valores posibles son @code{'@{'} y @code{'$'}, que corresponden a los otros dos estilos de formato. La compatibilidad con versiones anteriores se mantiene de forma predeterminada (como era de esperar), pero al especificar explícitamente un parámetro de estilo, tiene la capacidad de especificar cadenas de formato que funcionan con @ref{6c2,,str.format()} o @ref{728,,string.Template}. Aquí hay una sesión de consola de ejemplo para mostrar las posibilidades:

@example
>>> import logging
>>> root = logging.getLogger()
>>> root.setLevel(logging.DEBUG)
>>> handler = logging.StreamHandler()
>>> bf = logging.Formatter('@{asctime@} @{name@} @{levelname:8s@} @{message@}',
...                        style='@{')
>>> handler.setFormatter(bf)
>>> root.addHandler(handler)
>>> logger = logging.getLogger('foo.bar')
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message
>>> df = logging.Formatter('$asctime $name $@{levelname@} $message',
...                        style='$')
>>> handler.setFormatter(df)
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message
>>>
@end example

Tenga en cuenta que el formato de logging para la salida final a los logs es completamente independiente de cómo se construye un mensaje de logging individual. Para eso todavía puede usar el formateo %, como se muestra aquí:

@example
>>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message')
2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message
>>>
@end example

Las llamadas de Logging (@code{logger.debug()}, @code{logger.info()}, etc.) solo toman parámetros posicionales para el mensaje de logging real en sí, los parámetros de palabras clave se usan solo para determinar opciones sobre cómo gestionar la llamada propiamente a Logging (por ejemplo, el parámetro de palabra clave @code{exc_info} para indicar que la información de rastreo debe registrarse, o el parámetro de palabra clave @code{extra} para indicar información contextual adicional que se agregará al log). Por lo tanto, no puede realizar llamadas de logging directamente usando la sintaxis @ref{6c2,,str.format()} o @ref{728,,string.Template}, porque internamente el paquete de logging usa formato % para fusionar la cadena de formato y los argumentos de las variables. No habría ningún cambio en esto mientras se conserva la compatibilidad con versiones anteriores, ya que todas las llamadas de logging que están en el código existente usarán cadenas de formato %.

Sin embargo, existe una forma en la que puede usar el formato @{@} - y $ - para construir sus mensajes de log individuales. Recuerde que para un mensaje puede usar un objeto arbitrario como una cadena de caracteres de formato de mensaje, y que el paquete logging llamará a @code{str()} en ese objeto para obtener la cadena de caracteres de formato real. Considere las siguientes dos clases:

@example
class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)
@end example

Cualquiera de estos puede usarse en lugar de una cadena de formato, para permitir que se use el formato @{@} - o $ - para construir la parte del «mensaje» real que aparece en la salida del log en lugar de «%(message)s» o «@{message@}» o «$message». Es un poco difícil de manejar usar los nombres de las clases siempre que quieras registrar algo, pero es bastante aceptable si usas un alias como __ (doble subrayado — no confundir con _, el subrayado simple usado como sinónimo/alias para @ref{14a6,,gettext.gettext()} o sus hermanos).

Las clases anteriores no están incluidas en Python, aunque son bastante fáciles de copiar y pegar en su propio código. Se pueden usar de la siguiente manera (asumiendo que están declaradas en un módulo llamado @code{wherever}):

@example
>>> from wherever import BraceMessage as __
>>> print(__('Message with @{0@} @{name@}', 2, name='placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: (@{point.x:.2f@}, @{point.y:.2f@})',
...       point=p))
Message with coordinates: (0.50, 0.50)
>>> from wherever import DollarMessage as __
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>
@end example

Si bien los ejemplos anteriores usan @code{print()} para mostrar cómo funciona el formateo, por supuesto usaría @code{logger.debug()} o similar para realmente registrar usando este enfoque.

One thing to note is that you pay no significant performance penalty with this
approach: the actual formatting happens not when you make the logging call, but
when (and if) the logged message is actually about to be output to a log by a
handler. So the only slightly unusual thing which might trip you up is that the
parentheses go around the format string and the arguments, not just the format
string. That’s because the __ notation is just syntax sugar for a constructor
call to one of the @code{@var{XXX}Message} classes.

Si lo prefiere, puede usar @ref{135c,,LoggerAdapter} para lograr un efecto similar al anterior, como en el siguiente ejemplo:

@example
import logging

class Message:
    def __init__(self, fmt, args):
        self.fmt = fmt
        self.args = args

    def __str__(self):
        return self.fmt.format(*self.args)

class StyleAdapter(logging.LoggerAdapter):
    def log(self, level, msg, /, *args, stacklevel=1, **kwargs):
        if self.isEnabledFor(level):
            msg, kwargs = self.process(msg, kwargs)
            self.logger.log(level, Message(msg, args), **kwargs,
                            stacklevel=stacklevel+1)

logger = StyleAdapter(logging.getLogger(__name__))

def main():
    logger.debug('Hello, @{@}', 'world!')

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG)
    main()
@end example

The above script should log the message @code{Hello, world!} when run with
Python 3.8 or later.

@node Personalización de LogRecord,Subclassing QueueHandler and QueueListener- a ZeroMQ example,Uso de estilos de formato alternativos,Libro de recetas de Logging
@anchor{howto/logging-cookbook custom-logrecord}@anchor{4ed2}@anchor{howto/logging-cookbook customizing-logrecord}@anchor{4ed3}
@subsection Personalización de @code{LogRecord}


Cada evento logging está representado por una instancia @ref{1065,,LogRecord}. Cuando se registra un evento y no se filtra por el nivel de un registrador, se crea @ref{1065,,LogRecord}, se llena con información sobre el evento y luego se pasa a los gestores de ese registrador (y sus antepasados, hasta (e incluyéndolo) el registrador donde se deshabilita una mayor propagación en la jerarquía). Antes de Python 3.2, solo había dos lugares donde se realizaba esta creación:


@itemize *

@item 
@ref{2cd9,,Logger.makeRecord()}, que se llama en el proceso normal de logging de un evento. Esto invoca @ref{1065,,LogRecord} directamente para crear una instancia.

@item 
@ref{2d00,,makeLogRecord()}, que se llama con un diccionario que contiene atributos que se agregarán al `LogRecord'. Esto se suele invocar cuando se ha recibido un diccionario adecuado a través de la red (por ejemplo, en forma de `pickle' a través de @ref{fe2,,SocketHandler}, o en formato JSON a través de @ref{eb0,,HTTPHandler}).
@end itemize

Por lo general, esto significa que si necesita hacer algo especial con @ref{1065,,LogRecord}, debe hacer una de las siguientes cosas.


@itemize *

@item 
Cree su propia subclase @ref{bd7,,Logger}, que anula @ref{2cd9,,Logger.makeRecord()}, y configúrelo usando @ref{2d0f,,setLoggerClass()} antes de que se creen instancias de los registradores que le interesan.

@item 
Agrega un @ref{1268,,Filter} a un registrador o gestor, que realiza la manipulación especial necesaria que necesita cuando se llama a su método @ref{2cfb,,filter()}.
@end itemize

El primer enfoque sería un poco difícil de manejar en el escenario en el que (digamos) varias bibliotecas diferentes quisieran hacer cosas diferentes. Cada uno intentaría establecer su propia subclase @ref{bd7,,Logger}, y el que hiciera esto último ganaría.

El segundo enfoque funciona razonablemente bien en muchos casos, pero no le permite, por ejemplo, usar una subclase especializada de @ref{1065,,LogRecord}. Los desarrolladores de bibliotecas pueden establecer un filtro adecuado en sus registradores, pero tendrían que recordar hacerlo cada vez que introduzcan un nuevo registrador (lo que harían simplemente agregando nuevos paquetes o módulos y haciendo

@example
logger = logging.getLogger(__name__)
@end example

a nivel de módulo). Probablemente sean demasiadas cosas en las que pensar. Los desarrolladores también podrían agregar el filtro a @ref{12f1,,NullHandler} adjunto a su registrador de nivel superior, pero esto no se invocaría si un desarrollador de aplicaciones adjuntara un controlador a un registrador de biblioteca de nivel inferior — así que la salida de ese gestor no reflejaría las intenciones del desarrollador de la biblioteca.

En Python 3.2 y posteriores, la creación de @ref{1065,,LogRecord} se realiza a través de una fábrica, que puede especificar. La fábrica es simplemente un invocable que puede configurar con @ref{2d04,,setLogRecordFactory()}, e interrogar con @ref{2d03,,getLogRecordFactory()}. La fábrica se invoca con la misma firma que el constructor @ref{1065,,LogRecord}, ya que @ref{1065,,LogRecord} es la configuración predeterminada de la fábrica.

Este enfoque permite que una fábrica personalizada controle todos los aspectos de la creación de `LogRecord'. Por ejemplo, podría devolver una subclase, o simplemente agregar algunos atributos adicionales al registro una vez creado, usando un patrón similar a este:

@example
old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)
@end example

Este patrón permite que diferentes bibliotecas encadenen fábricas juntas, y siempre que no sobrescriban los atributos de las demás o sobrescriban involuntariamente los atributos proporcionados como estándar, no debería haber sorpresas. Sin embargo, debe tenerse en cuenta que cada eslabón de la cadena agrega una sobrecarga de tiempo de ejecución a todas las operaciones de logging, y la técnica solo debe usarse cuando el uso de @ref{1268,,Filter} no proporciona el resultado deseado.

@node Subclassing QueueHandler and QueueListener- a ZeroMQ example,Subclassing QueueHandler and QueueListener- a pynng example,Personalización de LogRecord,Libro de recetas de Logging
@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-zeromq-example}@anchor{4ed4}@anchor{howto/logging-cookbook zeromq-handlers}@anchor{4ed5}
@subsection Subclassing QueueHandler and QueueListener- a ZeroMQ example


@menu
* Subclass QueueHandler:: 
* Subclass QueueListener:: 

@end menu

@node Subclass QueueHandler,Subclass QueueListener,,Subclassing QueueHandler and QueueListener- a ZeroMQ example
@anchor{howto/logging-cookbook subclass-queuehandler}@anchor{4ed6}
@subsubsection Subclass @code{QueueHandler}


Puede usar una subclase @ref{17de,,QueueHandler} para enviar mensajes a otros tipos de colas, por ejemplo, un socket de “publicación” ZeroMQ. En el siguiente ejemplo, el socket se crea por separado y se pasa al gestor (como su “cola”):

@example
import zmq   # using pyzmq, the Python binding for ZeroMQ
import json  # for serializing records portably

ctx = zmq.Context()
sock = zmq.Socket(ctx, zmq.PUB)  # or zmq.PUSH, or other suitable value
sock.bind('tcp://*:5556')        # or wherever

class ZeroMQSocketHandler(QueueHandler):
    def enqueue(self, record):
        self.queue.send_json(record.__dict__)


handler = ZeroMQSocketHandler(sock)
@end example

Por supuesto, hay otras formas de organizar esto, por ejemplo, pasando los datos que necesita el gestor para crear el socket:

@example
class ZeroMQSocketHandler(QueueHandler):
    def __init__(self, uri, socktype=zmq.PUB, ctx=None):
        self.ctx = ctx or zmq.Context()
        socket = zmq.Socket(self.ctx, socktype)
        socket.bind(uri)
        super().__init__(socket)

    def enqueue(self, record):
        self.queue.send_json(record.__dict__)

    def close(self):
        self.queue.close()
@end example

@node Subclass QueueListener,,Subclass QueueHandler,Subclassing QueueHandler and QueueListener- a ZeroMQ example
@anchor{howto/logging-cookbook subclass-queuelistener}@anchor{4ed7}
@subsubsection Subclass @code{QueueListener}


También puede subclasificar @ref{eb1,,QueueListener} para obtener mensajes de otros tipos de colas, por ejemplo, un socket de “suscripción” de ZeroMQ. Aquí tienes un ejemplo:

@example
class ZeroMQSocketListener(QueueListener):
    def __init__(self, uri, /, *handlers, **kwargs):
        self.ctx = kwargs.get('ctx') or zmq.Context()
        socket = zmq.Socket(self.ctx, zmq.SUB)
        socket.setsockopt_string(zmq.SUBSCRIBE, '@w{'})  # subscribe to everything
        socket.connect(uri)
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self):
        msg = self.queue.recv_json()
        return logging.makeLogRecord(msg)
@end example

@node Subclassing QueueHandler and QueueListener- a pynng example,Una configuración de ejemplo basada en diccionario,Subclassing QueueHandler and QueueListener- a ZeroMQ example,Libro de recetas de Logging
@anchor{howto/logging-cookbook pynng-handlers}@anchor{4ed8}@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-pynng-example}@anchor{4ed9}
@subsection Subclassing QueueHandler and QueueListener- a @code{pynng} example


In a similar way to the above section, we can implement a listener and handler
using pynng@footnote{https://pypi.org/project/pynng/}, which is a Python binding to
NNG@footnote{https://nng.nanomsg.org/}, billed as a spiritual successor to ZeroMQ.
The following snippets illustrate – you can test them in an environment which has
@code{pynng} installed. Just for variety, we present the listener first.

@menu
* Subclass QueueListener: Subclass QueueListener<2>. 
* Subclass QueueHandler: Subclass QueueHandler<2>. 

@end menu

@node Subclass QueueListener<2>,Subclass QueueHandler<2>,,Subclassing QueueHandler and QueueListener- a pynng example
@anchor{howto/logging-cookbook id3}@anchor{4eda}
@subsubsection Subclass @code{QueueListener}


@example
# listener.py
import json
import logging
import logging.handlers

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

interrupted = False

class NNGSocketListener(logging.handlers.QueueListener):

    def __init__(self, uri, /, *handlers, **kwargs):
        # Have a timeout for interruptability, and open a
        # subscriber socket
        socket = pynng.Sub0(listen=uri, recv_timeout=500)
        # The b'@w{'} subscription matches all topics
        topics = kwargs.pop('topics', None) or b'@w{'}
        socket.subscribe(topics)
        # We treat the socket as a queue
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self, block):
        data = None
        # Keep looping while not interrupted and no data received over the
        # socket
        while not interrupted:
            try:
                data = self.queue.recv(block=block)
                break
            except pynng.Timeout:
                pass
            except pynng.Closed:  # sometimes happens when you hit Ctrl-C
                break
        if data is None:
            return None
        # Get the logging event sent from a publisher
        event = json.loads(data.decode('utf-8'))
        return logging.makeLogRecord(event)

    def enqueue_sentinel(self):
        # Not used in this implementation, as the socket isn't really a
        # queue
        pass

logging.getLogger('pynng').propagate = False
listener = NNGSocketListener(DEFAULT_ADDR, logging.StreamHandler(), topics=b'@w{'})
listener.start()
print('Press Ctrl-C to stop.')
try:
    while True:
        pass
except KeyboardInterrupt:
    interrupted = True
finally:
    listener.stop()
@end example

@node Subclass QueueHandler<2>,,Subclass QueueListener<2>,Subclassing QueueHandler and QueueListener- a pynng example
@anchor{howto/logging-cookbook id4}@anchor{4edb}
@subsubsection Subclass @code{QueueHandler}


@example
# sender.py
import json
import logging
import logging.handlers
import time
import random

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

class NNGSocketHandler(logging.handlers.QueueHandler):

    def __init__(self, uri):
        socket = pynng.Pub0(dial=uri, send_timeout=500)
        super().__init__(socket)

    def enqueue(self, record):
        # Send the record as UTF-8 encoded JSON
        d = dict(record.__dict__)
        data = json.dumps(d)
        self.queue.send(data.encode('utf-8'))

    def close(self):
        self.queue.close()

logging.getLogger('pynng').propagate = False
handler = NNGSocketHandler(DEFAULT_ADDR)
# Make sure the process ID is in the output
logging.basicConfig(level=logging.DEBUG,
                    handlers=[logging.StreamHandler(), handler],
                    format='%(levelname)-8s %(name)10s %(process)6s %(message)s')
levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)
logger_names = ('myapp', 'myapp.lib1', 'myapp.lib2')
msgno = 1
while True:
    # Just randomly select some loggers and levels and log away
    level = random.choice(levels)
    logger = logging.getLogger(random.choice(logger_names))
    logger.log(level, 'Message no. %5d' % msgno)
    msgno += 1
    delay = random.random() * 2 + 0.5
    time.sleep(delay)
@end example

You can run the above two snippets in separate command shells. If we run the
listener in one shell and run the sender in two separate shells, we should see
something like the following. In the first sender shell:

@example
$ python sender.py
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
CRITICAL myapp.lib2    613 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
DEBUG         myapp    613 Message no.     6
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
(and so on)
@end example

In the second sender shell:

@example
$ python sender.py
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
DEBUG    myapp.lib1    657 Message no.     8
(and so on)
@end example

In the listener shell:

@example
$ python listener.py
Press Ctrl-C to stop.
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    613 Message no.     3
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
DEBUG         myapp    613 Message no.     6
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
DEBUG    myapp.lib1    657 Message no.     8
(and so on)
@end example

As you can see, the logging from the two sender processes is interleaved in the
listener’s output.

@node Una configuración de ejemplo basada en diccionario,Usar un rotador y un nombre para personalizar el procesamiento de rotación de log,Subclassing QueueHandler and QueueListener- a pynng example,Libro de recetas de Logging
@anchor{howto/logging-cookbook an-example-dictionary-based-configuration}@anchor{4edc}
@subsection Una configuración de ejemplo basada en diccionario


A continuación se muestra un ejemplo de un diccionario de configuración de logging, tomado de la documentación del proyecto Django@footnote{https://docs.djangoproject.com/en/1.9/topics/logging/#configuring-logging}. Este diccionario se pasa a @ref{121e,,dictConfig()} para poner en efecto la configuración:

@example
LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'verbose': @{
            'format': '@{levelname@} @{asctime@} @{module@} @{process:d@} @{thread:d@} @{message@}',
            'style': '@{',
        @},
        'simple': @{
            'format': '@{levelname@} @{message@}',
            'style': '@{',
        @},
    @},
    'filters': @{
        'special': @{
            '()': 'project.logging.SpecialFilter',
            'foo': 'bar',
        @},
    @},
    'handlers': @{
        'console': @{
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        @},
        'mail_admins': @{
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['special']
        @}
    @},
    'loggers': @{
        'django': @{
            'handlers': ['console'],
            'propagate': True,
        @},
        'django.request': @{
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        @},
        'myproject.custom': @{
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        @}
    @}
@}
@end example

Para obtener más información sobre esta configuración, puede ver la sección correspondiente@footnote{https://docs.djangoproject.com/en/1.9/topics/logging/#configuring-logging} de la documentación de Django.

@node Usar un rotador y un nombre para personalizar el procesamiento de rotación de log,Un ejemplo de multiprocesamiento más elaborado,Una configuración de ejemplo basada en diccionario,Libro de recetas de Logging
@anchor{howto/logging-cookbook cookbook-rotator-namer}@anchor{2d58}@anchor{howto/logging-cookbook using-a-rotator-and-namer-to-customize-log-rotation-processing}@anchor{4edd}
@subsection Usar un rotador y un nombre para personalizar el procesamiento de rotación de log


An example of how you can define a namer and rotator is given in the following
runnable script, which shows gzip compression of the log file:

@example
import gzip
import logging
import logging.handlers
import os
import shutil

def namer(name):
    return name + ".gz"

def rotator(source, dest):
    with open(source, 'rb') as f_in:
        with gzip.open(dest, 'wb') as f_out:
            shutil.copyfileobj(f_in, f_out)
    os.remove(source)


rh = logging.handlers.RotatingFileHandler('rotated.log', maxBytes=128, backupCount=5)
rh.rotator = rotator
rh.namer = namer

root = logging.getLogger()
root.setLevel(logging.INFO)
root.addHandler(rh)
f = logging.Formatter('%(asctime)s %(message)s')
rh.setFormatter(f)
for i in range(1000):
    root.info(f'Message no. @{i + 1@}')
@end example

After running this, you will see six new files, five of which are compressed:

@example
$ ls rotated.log*
rotated.log       rotated.log.2.gz  rotated.log.4.gz
rotated.log.1.gz  rotated.log.3.gz  rotated.log.5.gz
$ zcat rotated.log.1.gz
2023-01-20 02:28:17,767 Message no. 996
2023-01-20 02:28:17,767 Message no. 997
2023-01-20 02:28:17,767 Message no. 998
@end example

@node Un ejemplo de multiprocesamiento más elaborado,Insertar BOM en mensajes enviados a SysLogHandler,Usar un rotador y un nombre para personalizar el procesamiento de rotación de log,Libro de recetas de Logging
@anchor{howto/logging-cookbook a-more-elaborate-multiprocessing-example}@anchor{4ede}
@subsection Un ejemplo de multiprocesamiento más elaborado


El siguiente ejemplo de trabajo muestra cómo logging se puede usar con multiprocesamiento usando archivos de configuración. Las configuraciones son bastante simples, pero sirven para ilustrar cómo se podrían implementar las más complejas en un escenario real de multiprocesamiento.

En el ejemplo, el proceso principal genera un proceso de escucha y algunos procesos de trabajo. Cada uno de los procesos principales, el oyente y los trabajadores tienen tres configuraciones separadas (todos los trabajadores comparten la misma configuración). Podemos ver el registro en el proceso principal, cómo los trabajadores se registran en un QueueHandler y cómo el oyente implementa un QueueListener y una configuración de registro más compleja, y organiza el envío de eventos recibidos a través de la cola a los controladores especificados en la configuración. Tenga en cuenta que estas configuraciones son puramente ilustrativas, pero debería poder adaptar este ejemplo a su propio escenario.

Aquí está el script, el docstrings y los comentarios, esperemos, expliquen cómo funciona:

@example
import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue, Event, current_process
import os
import random
import time

class MyHandler:
    """
    A simple handler for logging events. It runs in the listener process and
    dispatches events to loggers based on the name in the received record,
    which then get dispatched, by the logging system, to the handlers
    configured for those loggers.
    """

    def handle(self, record):
        if record.name == "root":
            logger = logging.getLogger()
        else:
            logger = logging.getLogger(record.name)

        if logger.isEnabledFor(record.levelno):
            # The process name is transformed just to show that it's the listener
            # doing the logging to files and console
            record.processName = '%s (for %s)' % (current_process().name, record.processName)
            logger.handle(record)

def listener_process(q, stop_event, config):
    """
    This could be done in the main process, but is just done in a separate
    process for illustrative purposes.

    This initialises logging according to the specified configuration,
    starts the listener and waits for the main process to signal completion
    via the event. The listener is then stopped, and the process exits.
    """
    logging.config.dictConfig(config)
    listener = logging.handlers.QueueListener(q, MyHandler())
    listener.start()
    if os.name == 'posix':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    stop_event.wait()
    listener.stop()

def worker_process(config):
    """
    A number of these are spawned for the purpose of illustration. In
    practice, they could be a heterogeneous bunch of processes rather than
    ones which are identical to each other.

    This initialises logging according to the specified configuration,
    and logs a hundred messages with random levels to randomly selected
    loggers.

    A small sleep is added to allow other processes a chance to run. This
    is not strictly needed, but it mixes the output from the different
    processes a bit more than if it's left out.
    """
    logging.config.dictConfig(config)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    if os.name == 'posix':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)
        time.sleep(0.01)

def main():
    q = Queue()
    # The main process gets a simple configuration which prints to the console.
    config_initial = @{
        'version': 1,
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'level': 'INFO'
            @}
        @},
        'root': @{
            'handlers': ['console'],
            'level': 'DEBUG'
        @}
    @}
    # The worker process configuration is just a QueueHandler attached to the
    # root logger, which allows all messages to be sent to the queue.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a fork().
    config_worker = @{
        'version': 1,
        'disable_existing_loggers': True,
        'handlers': @{
            'queue': @{
                'class': 'logging.handlers.QueueHandler',
                'queue': q
            @}
        @},
        'root': @{
            'handlers': ['queue'],
            'level': 'DEBUG'
        @}
    @}
    # The listener process configuration shows that the full flexibility of
    # logging configuration is available to dispatch events to handlers however
    # you want.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a fork().
    config_listener = @{
        'version': 1,
        'disable_existing_loggers': True,
        'formatters': @{
            'detailed': @{
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @},
            'simple': @{
                'class': 'logging.Formatter',
                'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @}
        @},
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'formatter': 'simple',
                'level': 'INFO'
            @},
            'file': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed'
            @},
            'foofile': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed'
            @},
            'errors': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'formatter': 'detailed',
                'level': 'ERROR'
            @}
        @},
        'loggers': @{
            'foo': @{
                'handlers': ['foofile']
            @}
        @},
        'root': @{
            'handlers': ['console', 'file', 'errors'],
            'level': 'DEBUG'
        @}
    @}
    # Log some initial events, just to show that logging in the parent works
    # normally.
    logging.config.dictConfig(config_initial)
    logger = logging.getLogger('setup')
    logger.info('About to create workers ...')
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1),
                     args=(config_worker,))
        workers.append(wp)
        wp.start()
        logger.info('Started worker: %s', wp.name)
    logger.info('About to create listener ...')
    stop_event = Event()
    lp = Process(target=listener_process, name='listener',
                 args=(q, stop_event, config_listener))
    lp.start()
    logger.info('Started listener')
    # We now hang around for the workers to finish their work.
    for wp in workers:
        wp.join()
    # Workers all done, listening can now stop.
    # Logging in the parent still works normally.
    logger.info('Telling listener to stop ...')
    stop_event.set()
    lp.join()
    logger.info('All done.')

if __name__ == '__main__':
    main()
@end example

@node Insertar BOM en mensajes enviados a SysLogHandler,Implementar logging estructurado,Un ejemplo de multiprocesamiento más elaborado,Libro de recetas de Logging
@anchor{howto/logging-cookbook inserting-a-bom-into-messages-sent-to-a-sysloghandler}@anchor{4edf}
@subsection Insertar BOM en mensajes enviados a SysLogHandler


@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} requiere que se envíe un mensaje Unicode a un demonio syslog como un conjunto de bytes que tienen la siguiente estructura: un componente opcional ASCII puro, seguido de una marca de orden de bytes UTF-8 (BOM), seguida de Codificado en Unicode usando UTF-8. (Ver sección relevante de la especificación 
@geindex RFC; RFC 5424 Section 6
RFC 5424 Section 6@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html#section-6}.)

En Python 3.1, se agregó código a @ref{6fd,,SysLogHandler} para insertar BOM en el mensaje, pero desafortunadamente, se implementó incorrectamente, BOM aparece al principio del mensaje y, por lo tanto, no permite ningún componente ASCII puro para que aparezca antes.

Como este comportamiento no funciona, el código de inserción BOM incorrecto se elimina de Python 3.2.4 y versiones posteriores. Sin embargo, no se está reemplazando, y si desea producir mensajes compatibles con 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} que incluyan BOM, una secuencia opcional de ASCII puro antes y Unicode arbitrario después, codificados usando UTF-8; entonces necesita hacer lo siguiente:


@enumerate 

@item 
Adjunte una instancia de @ref{14d1,,Formatter} a su instancia @ref{6fd,,SysLogHandler}, con una cadena de caracteres de formato como:

@example
'ASCII section\ufeffUnicode section'
@end example

El punto de código Unicode U+ FEFF, cuando se codifica usando UTF-8, se codificará como una BOM UTF-8, la cadena de bytes @code{b'\xef\xbb\xbf'}.

@item 
Reemplace la sección ASCII con los marcadores de posición que desee, pero asegúrese de que los datos que aparecen allí después de la sustitución sean siempre ASCII (de esa manera, permanecerán sin cambios después de la codificación UTF-8).

@item 
Reemplace la sección Unicode con los marcadores de posición que desee; si los datos que aparecen allí después de la sustitución contienen caracteres fuera del rango ASCII, está bien: se codificarán usando UTF-8.
@end enumerate

El mensaje formateado `se' codificará utilizando la codificación UTF-8 por @code{SysLogHandler}. Si sigue las reglas anteriores, debería poder producir mensajes compatibles con 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html}. Si no lo hace, es posible que el logging no se queje, pero sus mensajes no serán compatibles con RFC 5424 y su demonio syslog puede quejarse.

@node Implementar logging estructurado,Personalización de gestores con dictConfig,Insertar BOM en mensajes enviados a SysLogHandler,Libro de recetas de Logging
@anchor{howto/logging-cookbook implementing-structured-logging}@anchor{4ee0}
@subsection Implementar logging estructurado


Aunque la mayoría de los mensajes de registro están destinados a ser leídos por humanos y, por lo tanto, no se pueden analizar fácilmente mediante una máquina, puede haber circunstancias en las que desee generar mensajes en un formato estructurado que `sea' capaz de ser analizado por un programa (sin necesidad de expresiones regulares complejas para analizar el mensaje de registro). Esto es sencillo de lograr utilizando el paquete de registro. Hay varias formas de lograr esto, pero el siguiente es un enfoque simple que usa JSON para serializar el evento de una manera analizable por máquina:

@example
import json
import logging

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        return '%s >>> %s' % (self.message, json.dumps(self.kwargs))

_ = StructuredMessage   # optional, to improve readability

logging.basicConfig(level=logging.INFO, format='%(message)s')
logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))
@end example

Si se ejecuta el script anterior, se imprime:

@example
message 1 >>> @{"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"@}
@end example

Tenga en cuenta que el orden de los elementos puede ser diferente según la versión de Python utilizada.

Si necesita un procesamiento más especializado, puede utilizar un codificador JSON personalizado, como en el siguiente ejemplo completo:

@example
import json
import logging


class Encoder(json.JSONEncoder):
    def default(self, o):
        if isinstance(o, set):
            return tuple(o)
        elif isinstance(o, str):
            return o.encode('unicode_escape').decode('ascii')
        return super().default(o)

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        s = Encoder().encode(self.kwargs)
        return '%s >>> %s' % (self.message, s)

_ = StructuredMessage   # optional, to improve readability

def main():
    logging.basicConfig(level=logging.INFO, format='%(message)s')
    logging.info(_('message 1', set_value=@{1, 2, 3@}, snowman='\u2603'))

if __name__ == '__main__':
    main()
@end example

Cuando se ejecuta el script anterior, se imprime:

@example
message 1 >>> @{"snowman": "\u2603", "set_value": [1, 2, 3]@}
@end example

Tenga en cuenta que el orden de los elementos puede ser diferente según la versión de Python utilizada.

@node Personalización de gestores con dictConfig,Usar estilos de formato particulares en toda su aplicación,Implementar logging estructurado,Libro de recetas de Logging
@anchor{howto/logging-cookbook custom-handlers}@anchor{4ee1}@anchor{howto/logging-cookbook customizing-handlers-with-dictconfig}@anchor{4ee2}
@subsection Personalización de gestores con @code{dictConfig()}


Hay ocasiones en las que desea personalizar los gestores de logging de formas particulares, y si usa @ref{121e,,dictConfig()} puede hacerlo sin subclases. Como ejemplo, considere que es posible que desee establecer la propiedad de un archivo de log. En POSIX, esto se hace fácilmente usando @ref{399,,shutil.chown()}, pero los gestores de archivos en stdlib no ofrecen soporte integrado. Puede personalizar la creación de gestores usando una función simple como:

@example
def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)
@end example

Luego puede especificar, en una configuración de logging pasada a @ref{121e,,dictConfig()}, que se cree un gestor de logging llamando a esta función:

@example
LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'default': @{
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        @},
    @},
    'handlers': @{
        'file':@{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        @},
    @},
    'root': @{
        'handlers': ['file'],
        'level': 'DEBUG',
    @},
@}
@end example

En este ejemplo, se establece la propiedad utilizando el usuario y el grupo @code{pulse}, solo con fines ilustrativos. Poniéndolo junto en un script de trabajo, @code{chowntest.py}:

@example
import logging, logging.config, os, shutil

def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)

LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'default': @{
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        @},
    @},
    'handlers': @{
        'file':@{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        @},
    @},
    'root': @{
        'handlers': ['file'],
        'level': 'DEBUG',
    @},
@}

logging.config.dictConfig(LOGGING)
logger = logging.getLogger('mylogger')
logger.debug('A debug message')
@end example

Para ejecutar esto, probablemente se necesite ejecutarlo como @code{root}:

@example
$ sudo python3.3 chowntest.py
$ cat chowntest.log
2013-11-05 09:34:51,128 DEBUG mylogger A debug message
$ ls -l chowntest.log
-rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log
@end example

Tenga en cuenta que este ejemplo usa Python 3.3 porque ahí es donde @ref{399,,shutil.chown()} aparece. Este enfoque debería funcionar con cualquier versión de Python que admita @ref{121e,,dictConfig()}, es decir, Python 2.7, 3.2 o posterior. Con las versiones anteriores a 3.3, necesitaría implementar el cambio de propiedad real usando, por ejemplo, @ref{1161,,os.chown()}.

En la práctica, la función de creación de gestores puede estar en un módulo de utilidad en algún lugar de su proyecto. En lugar de la línea en la configuración:

@example
'()': owned_file_handler,
@end example

podrías usar, por ejemplo,:

@example
'()': 'ext://project.util.owned_file_handler',
@end example

donde @code{project.util} se puede reemplazar con el nombre real del paquete donde reside la función. En el script de trabajo anterior, el uso de @code{'ext://__main__.owned_file_handler'} debería funcionar. Aquí, el invocable real se resuelve mediante @ref{121e,,dictConfig()} de la especificación @code{ext://}.

Por fortuna, este ejemplo también indica el camino hacia cómo podría implementar otros tipos de cambio de archivo, por ejemplo, configurando de la misma manera bits de permisos POSIX específicos, usando @ref{378,,os.chmod()}.

Por supuesto, el enfoque también podría extenderse a tipos de gestores distintos a @ref{18a7,,FileHandler} - por ejemplo, uno de los gestores de archivos rotativos, o un tipo diferente por completo.

@node Usar estilos de formato particulares en toda su aplicación,Configurar filtros con dictConfig,Personalización de gestores con dictConfig,Libro de recetas de Logging
@anchor{howto/logging-cookbook formatting-styles}@anchor{2cf1}@anchor{howto/logging-cookbook using-particular-formatting-styles-throughout-your-application}@anchor{4ee3}
@subsection Usar estilos de formato particulares en toda su aplicación


En Python 3.2, @ref{14d1,,Formatter} obtuvo un parámetro de palabra clave @code{estilo} que, aunque por defecto era @code{%} para compatibilidad con versiones anteriores, permitía la especificación de @code{@{} o @code{$} para permitir los enfoques de formato admitidos por @ref{6c2,,str.format()} y @ref{728,,string.Template}. Tenga en cuenta que esto rige el formato de los mensajes de logging para la salida final a los logging y es completamente ortogonal a cómo se construye un mensaje de logging individual.

Logging calls (@ref{eaf,,debug()}, @ref{2cd1,,info()} etc.) only take
positional parameters for the actual logging message itself, with keyword
parameters used only for determining options for how to handle the logging call
(e.g. the @code{exc_info} keyword parameter to indicate that traceback information
should be logged, or the @code{extra} keyword parameter to indicate additional
contextual information to be added to the log). So you cannot directly make
logging calls using @ref{6c2,,str.format()} or @ref{728,,string.Template} syntax,
because internally the logging package uses %-formatting to merge the format
string and the variable arguments. There would be no changing this while preserving
backward compatibility, since all logging calls which are out there in existing
code will be using %-format strings.

Ha habido sugerencias para asociar estilos de formato con `loggers' específicos, pero ese enfoque también tiene problemas de compatibilidad con versiones anteriores porque cualquier código existente podría estar usando un nombre de `logger' dado y usando formato %.

Para que logging funcione de manera interoperable entre cualquier biblioteca de terceros y su código, las decisiones sobre el formato deben tomarse a nivel de la llamada de logging individual. Esto abre un par de formas en las que se pueden acomodar estilos de formato alternativos.

@menu
* Uso de fábricas de LogRecord:: 
* Usar objetos de mensaje personalizados:: 

@end menu

@node Uso de fábricas de LogRecord,Usar objetos de mensaje personalizados,,Usar estilos de formato particulares en toda su aplicación
@anchor{howto/logging-cookbook using-logrecord-factories}@anchor{4ee4}
@subsubsection Uso de fábricas de LogRecord


En Python 3.2, junto con los cambios de @ref{14d1,,Formatter} mencionados anteriormente, el paquete logging ganó la capacidad de permitir a los usuarios establecer sus propias subclases @ref{1065,,LogRecord}, usando la función @ref{2d04,,setLogRecordFactory()}. Puede usar esto para configurar su propia subclase de @ref{1065,,LogRecord}, que hace lo correcto al anular el método @ref{2d02,,getMessage()}. La implementación de la clase base de este método es donde ocurre el formato @code{msg % args} y donde puede sustituir su formato alternativo; sin embargo, debe tener cuidado de admitir todos los estilos de formato y permitir formato % como predeterminado, para garantizar la interoperabilidad con otro código. También se debe tener cuidado de llamar a @code{str(self.msg)}, tal como lo hace la implementación base.

Consulte la documentación de referencia en @ref{2d04,,setLogRecordFactory()} y @ref{1065,,LogRecord} para obtener más información.

@node Usar objetos de mensaje personalizados,,Uso de fábricas de LogRecord,Usar estilos de formato particulares en toda su aplicación
@anchor{howto/logging-cookbook using-custom-message-objects}@anchor{4ee5}
@subsubsection Usar objetos de mensaje personalizados


Existe otra forma, quizás más sencilla, de usar el formato @{@} - y $ - para construir sus mensajes de log individuales. Al iniciar sesión, recuerde que puede usar cualquier objeto como una cadena de caracteres de formato de mensaje (@ref{2d01,,Usando objetos arbitrarios como mensajes}) que al iniciar sesión puede usar un objeto arbitrario como una cadena de formato de mensaje, y que el paquete de logging llamará @ref{237,,str()} en ese objeto para obtener el cadena de formato real. Considere las siguientes dos clases:

@example
class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)
@end example

Cualquiera de estos puede usarse en lugar de una cadena de formato, para permitir que se use el formato @{@} - o $ - para construir la parte del «mensaje» real que aparece en la salida del log formateado en lugar de “%(message)s” or “@{message@}” or “$message”. Si le resulta un poco difícil de manejar usar los nombres de las clases cada vez que desea registrar algo, puede hacerlo más tolerable si usa un alias como @code{M} o @code{_} para el mensaje (o quizás @code{__}, si está utilizando @code{_} para localización).

A continuación se dan ejemplos de este enfoque. En primer lugar, formatear con @ref{6c2,,str.format()}:

@example
>>> __ = BraceMessage
>>> print(__('Message with @{0@} @{1@}', 2, 'placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: (@{point.x:.2f@}, @{point.y:.2f@})', point=p))
Message with coordinates: (0.50, 0.50)
@end example

En segundo lugar, formatear con @ref{728,,string.Template}:

@example
>>> __ = DollarMessage
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>
@end example

One thing to note is that you pay no significant performance penalty with this
approach: the actual formatting happens not when you make the logging call, but
when (and if) the logged message is actually about to be output to a log by a
handler. So the only slightly unusual thing which might trip you up is that the
parentheses go around the format string and the arguments, not just the format
string. That’s because the __ notation is just syntax sugar for a constructor
call to one of the @code{@var{XXX}Message} classes shown above.

@node Configurar filtros con dictConfig,Formato de excepción personalizado,Usar estilos de formato particulares en toda su aplicación,Libro de recetas de Logging
@anchor{howto/logging-cookbook configuring-filters-with-dictconfig}@anchor{4ee6}@anchor{howto/logging-cookbook filters-dictconfig}@anchor{4ee7}
@subsection Configurar filtros con @code{dictConfig()}


`Puedes' configurar filtros usando @ref{121e,,dictConfig()}, aunque a primera vista es posible que no sea obvio cómo hacerlo (de ahí esta receta). Dado que @ref{1268,,Filter} es la única clase de filtro incluida en la biblioteca estándar, y es poco probable que satisfaga muchos requisitos (solo está allí como clase base), normalmente necesitarás definir tu propia subclase @ref{1268,,Filter} con un método @ref{2cfb,,filter()} sobreescrito. Para hacer esto, especifique la clave @code{()} en el diccionario de configuración para el filtro, especificando un invocable que se usará para crear el filtro (una clase es la más obvia, pero puede proporcionar cualquier invocable que retorne una instancia @ref{1268,,Filter}). Aquí hay un ejemplo completo:

@example
import logging
import logging.config
import sys

class MyFilter(logging.Filter):
    def __init__(self, param=None):
        self.param = param

    def filter(self, record):
        if self.param is None:
            allow = True
        else:
            allow = self.param not in record.msg
        if allow:
            record.msg = 'changed: ' + record.msg
        return allow

LOGGING = @{
    'version': 1,
    'filters': @{
        'myfilter': @{
            '()': MyFilter,
            'param': 'noshow',
        @}
    @},
    'handlers': @{
        'console': @{
            'class': 'logging.StreamHandler',
            'filters': ['myfilter']
        @}
    @},
    'root': @{
        'level': 'DEBUG',
        'handlers': ['console']
    @},
@}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.debug('hello')
    logging.debug('hello - noshow')
@end example

Este ejemplo muestra cómo puede pasar datos de configuración al invocable que construye la instancia, en forma de parámetros de palabras clave. Cuando se ejecuta, se imprimirá el script anterior:

@example
changed: hello
@end example

que muestra que el filtro está funcionando según lo configurado.

Un par de puntos adicionales a tener en cuenta:


@itemize *

@item 
Si no puede hacer referencia al invocable directamente en la configuración (por ejemplo, si vive en un módulo diferente y no puede importarlo directamente donde está el diccionario de configuración), puede usar el formulario @code{ext://...} como se describe en @ref{2d2f,,Acceso a objetos externos}. Por ejemplo, podría haber usado el texto @code{'ext://__main__.MyFilter'} en lugar de @code{MyFilter} en el ejemplo anterior.

@item 
Además de los filtros, esta técnica también se puede utilizar para configurar gestores y formateadores personalizados. Consultar @ref{2d23,,Objetos definidos por el usuario} para obtener más información sobre cómo logging admite el uso de objetos definidos por el usuario en su configuración, y ver arriba la otra receta @ref{4ee1,,Personalización de gestores con dictConfig()}.
@end itemize

@node Formato de excepción personalizado,Mensajes de logging hablantes,Configurar filtros con dictConfig,Libro de recetas de Logging
@anchor{howto/logging-cookbook custom-format-exception}@anchor{4ee8}@anchor{howto/logging-cookbook customized-exception-formatting}@anchor{4ee9}
@subsection Formato de excepción personalizado


Puede haber ocasiones en las que desee personalizar un formato de excepción; por el bien del argumento, digamos que desea exactamente una línea por evento registrado, incluso cuando la información de la excepción está presente. Puede hacer esto con una clase de formateador personalizada, como se muestra en el siguiente ejemplo:

@example
import logging

class OneLineExceptionFormatter(logging.Formatter):
    def formatException(self, exc_info):
        """
        Format an exception so that it prints on a single line.
        """
        result = super().formatException(exc_info)
        return repr(result)  # or format into one line however you want to

    def format(self, record):
        s = super().format(record)
        if record.exc_text:
            s = s.replace('\n', '@w{'}) + '|'
        return s

def configure_logging():
    fh = logging.FileHandler('output.txt', 'w')
    f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',
                                  '%d/%m/%Y %H:%M:%S')
    fh.setFormatter(f)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(fh)

def main():
    configure_logging()
    logging.info('Sample message')
    try:
        x = 1 / 0
    except ZeroDivisionError as e:
        logging.exception('ZeroDivisionError: %s', e)

if __name__ == '__main__':
    main()
@end example

Cuando se ejecuta, esto produce un archivo con exactamente dos líneas:

@example
28/01/2015 07:21:23|INFO|Sample message|
28/01/2015 07:21:23|ERROR|ZeroDivisionError: division by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: division by zero'|
@end example

Si bien el tratamiento anterior es simplista, señala el camino hacia cómo se puede formatear la información de excepción a su gusto. El módulo @ref{fe,,traceback} puede resultar útil para necesidades más especializadas.

@node Mensajes de logging hablantes,Almacenamiento en búfer de mensajes de logging y su salida condicional,Formato de excepción personalizado,Libro de recetas de Logging
@anchor{howto/logging-cookbook speaking-logging-messages}@anchor{4eea}@anchor{howto/logging-cookbook spoken-messages}@anchor{4eeb}
@subsection Mensajes de logging hablantes


Puede haber situaciones en las que sea deseable que los mensajes de logging se presenten en un formato audible en lugar de visible. Esto es fácil de hacer si tiene la funcionalidad de texto a voz (`TTS' por sus siglas en inglés) disponible en su sistema, incluso si no tiene un `binding' Python. La mayoría de los sistemas TTS tienen un programa de línea de comandos que puede ejecutar, y esto puede invocarse desde un gestor usando @ref{d6,,subprocess}. Aquí se asume que los programas de línea de comando TTS no esperarán interactuar con los usuarios o tardarán mucho en completarse, y que la frecuencia de los mensajes registrados no será tan alta como para inundar al usuario con mensajes, y que es aceptable que los mensajes se reproducen uno a la vez en lugar de todos al mismo tiempo. La implementación de ejemplo a continuación espera a que se pronuncie un mensaje antes de que se procese el siguiente, y esto puede hacer que otros gestores se mantengan esperando. Aquí hay un breve ejemplo que muestra el enfoque, que asume que el paquete TTS @code{espeak} está disponible:

@example
import logging
import subprocess
import sys

class TTSHandler(logging.Handler):
    def emit(self, record):
        msg = self.format(record)
        # Speak slowly in a female English voice
        cmd = ['espeak', '-s150', '-ven+f3', msg]
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
        # wait for the program to finish
        p.communicate()

def configure_logging():
    h = TTSHandler()
    root = logging.getLogger()
    root.addHandler(h)
    # the default formatter just returns the message
    root.setLevel(logging.DEBUG)

def main():
    logging.info('Hello')
    logging.debug('Goodbye')

if __name__ == '__main__':
    configure_logging()
    sys.exit(main())
@end example

Cuando se ejecute, este script debería decir «Hola» y luego «Adiós» con voz femenina.

El enfoque anterior puede, por supuesto, adaptarse a otros sistemas TTS e incluso a otros sistemas que pueden procesar mensajes a través de programas externos ejecutados desde una línea de comando.

@node Almacenamiento en búfer de mensajes de logging y su salida condicional,Enviando mensajes de logging al correo electrónico con almacenamiento en búfer,Mensajes de logging hablantes,Libro de recetas de Logging
@anchor{howto/logging-cookbook buffered-logging}@anchor{4eec}@anchor{howto/logging-cookbook buffering-logging-messages-and-outputting-them-conditionally}@anchor{4eed}
@subsection Almacenamiento en búfer de mensajes de logging y su salida condicional


Puede haber situaciones en las que desee registrar mensajes en un área temporal y solo mostrarlos si se produce una determinada condición. Por ejemplo, es posible que desee comenzar a registrar eventos de depuración en una función, y si la función se completa sin errores, no desea saturar el log con la información de depuración recopilada; pero si hay un error, desea toda la información de depuración información así como el error.

Aquí hay un ejemplo que muestra cómo puede hacer esto usando un decorador para sus funciones donde desea que el logging se comporte de esta manera. Hace uso de @ref{2d32,,logging.handlers.MemoryHandler}, que permite el almacenamiento en búfer de eventos registrados hasta que se produzca alguna condición, momento en el que los eventos almacenados en búfer se @code{flushed} y se pasan a otro gestor (el gestor @code{target}) para su procesamiento. De forma predeterminada, el @code{MemoryHandler} se vacía cuando su búfer se llena o se ve un evento cuyo nivel es mayor o igual a un umbral especificado. Puede usar esta receta con una subclase más especializada de @code{MemoryHandler} si desea un comportamiento de descarga personalizado.

El script de ejemplo tiene una función simple, @code{foo}, que recorre todos los niveles de logging, escribiendo en @code{sys.stderr} para decir en qué nivel está a punto de `loguear' y luego registrar un mensaje en ese nivel. Puede pasar un parámetro a @code{foo} que, si es verdadero, se registrará en los niveles ERROR y CRITICAL; de lo contrario, solo registrará en los niveles DEBUG, INFO y WARNING.

El script simplemente dispone decorar @code{foo} con un decorador que hará el logging condicional que se requiere. El decorador toma un registrador como parámetro y adjunta un gestor de memoria durante la duración de la llamada a la función decorada. El decorador se puede parametrizar adicionalmente utilizando un gestor `target', un nivel en el que debe producirse el vaciado y una capacidad para el búfer (número de registros almacenados en búfer). Estos están predeterminados a @ref{1265,,StreamHandler} que escribe en @code{sys.stderr}, @code{logging.ERROR} y @code{100} respectivamente.

Aquí está el script:

@example
import logging
from logging.handlers import MemoryHandler
import sys

logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())

def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):
    if target_handler is None:
        target_handler = logging.StreamHandler()
    if flush_level is None:
        flush_level = logging.ERROR
    if capacity is None:
        capacity = 100
    handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)

    def decorator(fn):
        def wrapper(*args, **kwargs):
            logger.addHandler(handler)
            try:
                return fn(*args, **kwargs)
            except Exception:
                logger.exception('call failed')
                raise
            finally:
                super(MemoryHandler, handler).flush()
                logger.removeHandler(handler)
        return wrapper

    return decorator

def write_line(s):
    sys.stderr.write('%s\n' % s)

def foo(fail=False):
    write_line('about to log at DEBUG ...')
    logger.debug('Actually logged at DEBUG')
    write_line('about to log at INFO ...')
    logger.info('Actually logged at INFO')
    write_line('about to log at WARNING ...')
    logger.warning('Actually logged at WARNING')
    if fail:
        write_line('about to log at ERROR ...')
        logger.error('Actually logged at ERROR')
        write_line('about to log at CRITICAL ...')
        logger.critical('Actually logged at CRITICAL')
    return fail

decorated_foo = log_if_errors(logger)(foo)

if __name__ == '__main__':
    logger.setLevel(logging.DEBUG)
    write_line('Calling undecorated foo with False')
    assert not foo(False)
    write_line('Calling undecorated foo with True')
    assert foo(True)
    write_line('Calling decorated foo with False')
    assert not decorated_foo(False)
    write_line('Calling decorated foo with True')
    assert decorated_foo(True)
@end example

Cuando se ejecuta este script, se debe observar el siguiente resultado:

@example
Calling undecorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling undecorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
about to log at CRITICAL ...
Calling decorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling decorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
Actually logged at DEBUG
Actually logged at INFO
Actually logged at WARNING
Actually logged at ERROR
about to log at CRITICAL ...
Actually logged at CRITICAL
@end example

Como puede ver, la salida real de logging solo ocurre cuando se registra un evento cuya gravedad es ERROR o mayor, pero en ese caso, también se registra cualquier evento anterior con una gravedad menor.

Por supuesto, puede utilizar las formas de decoración convencionales:

@example
@@log_if_errors(logger)
def foo(fail=False):
    ...
@end example

@node Enviando mensajes de logging al correo electrónico con almacenamiento en búfer,Formateo de horas usando UTC GMT a través de la configuración,Almacenamiento en búfer de mensajes de logging y su salida condicional,Libro de recetas de Logging
@anchor{howto/logging-cookbook buffered-smtp}@anchor{4eee}@anchor{howto/logging-cookbook sending-logging-messages-to-email-with-buffering}@anchor{4eef}
@subsection Enviando mensajes de logging al correo electrónico, con almacenamiento en búfer


Para ilustrar cómo puede enviar mensajes de logging por correo electrónico, de modo que se envíe un número determinado de mensajes, puede usar la subclase @ref{2d83,,BufferingHandler}. En el siguiente ejemplo, que puedes adaptar a tus necesidades específicas, se proporciona un sencillo arnés de pruebas que permite ejecutar el script con argumentos de línea de comandos especificando lo que normalmente necesitas para enviar cosas por SMTP. (Ejecute el script descargado con el argumento @code{-h} para ver los argumentos necesarios y opcionales).

@example
import logging
import logging.handlers
import smtplib

class BufferingSMTPHandler(logging.handlers.BufferingHandler):
    def __init__(self, mailhost, port, username, password, fromaddr, toaddrs,
                 subject, capacity):
        logging.handlers.BufferingHandler.__init__(self, capacity)
        self.mailhost = mailhost
        self.mailport = port
        self.username = username
        self.password = password
        self.fromaddr = fromaddr
        if isinstance(toaddrs, str):
            toaddrs = [toaddrs]
        self.toaddrs = toaddrs
        self.subject = subject
        self.setFormatter(logging.Formatter("%(asctime)s %(levelname)-5s %(message)s"))

    def flush(self):
        if len(self.buffer) > 0:
            try:
                smtp = smtplib.SMTP(self.mailhost, self.mailport)
                smtp.starttls()
                smtp.login(self.username, self.password)
                msg = "From: %s\r\nTo: %s\r\nSubject: %s\r\n\r\n" % (self.fromaddr, ','.join(self.toaddrs), self.subject)
                for record in self.buffer:
                    s = self.format(record)
                    msg = msg + s + "\r\n"
                smtp.sendmail(self.fromaddr, self.toaddrs, msg)
                smtp.quit()
            except Exception:
                if logging.raiseExceptions:
                    raise
            self.buffer = []

if __name__ == '__main__':
    import argparse

    ap = argparse.ArgumentParser()
    aa = ap.add_argument
    aa('host', metavar='HOST', help='SMTP server')
    aa('--port', '-p', type=int, default=587, help='SMTP port')
    aa('user', metavar='USER', help='SMTP username')
    aa('password', metavar='PASSWORD', help='SMTP password')
    aa('to', metavar='TO', help='Addressee for emails')
    aa('sender', metavar='SENDER', help='Sender email address')
    aa('--subject', '-s',
       default='Test Logging email from Python logging module (buffering)',
       help='Subject of email')
    options = ap.parse_args()
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)
    h = BufferingSMTPHandler(options.host, options.port, options.user,
                             options.password, options.sender,
                             options.to, options.subject, 10)
    logger.addHandler(h)
    for i in range(102):
        logger.info("Info index = %d", i)
    h.flush()
    h.close()
@end example

Si ejecuta este script y su servidor SMTP está correctamente configurado, debería ver que envía once correos electrónicos al destinatario que usted especifique. Los primeros diez correos electrónicos tendrán cada uno diez mensajes de log, y el undécimo tendrá dos mensajes. Eso hace 102 mensajes como se especifica en el script.

@node Formateo de horas usando UTC GMT a través de la configuración,Usar un administrador de contexto para logging selectivo,Enviando mensajes de logging al correo electrónico con almacenamiento en búfer,Libro de recetas de Logging
@anchor{howto/logging-cookbook formatting-times-using-utc-gmt-via-configuration}@anchor{4ef0}@anchor{howto/logging-cookbook utc-formatting}@anchor{4ef1}
@subsection Formateo de horas usando UTC (GMT) a través de la configuración


A veces desea formatear las horas usando UTC, lo que se puede hacer usando una clase como @code{UTCFormatter}, como se muestra a continuación:

@example
import logging
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime
@end example

y luego puede usar el @code{UTCFormatter} en su código en lugar de @ref{14d1,,Formatter}. Si desea hacer eso a través de la configuración, puede usar la API @ref{121e,,dictConfig()} con un enfoque ilustrado por el siguiente ejemplo completo:

@example
import logging
import logging.config
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime

LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'utc': @{
            '()': UTCFormatter,
            'format': '%(asctime)s %(message)s',
        @},
        'local': @{
            'format': '%(asctime)s %(message)s',
        @}
    @},
    'handlers': @{
        'console1': @{
            'class': 'logging.StreamHandler',
            'formatter': 'utc',
        @},
        'console2': @{
            'class': 'logging.StreamHandler',
            'formatter': 'local',
        @},
    @},
    'root': @{
        'handlers': ['console1', 'console2'],
   @}
@}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.warning('The local time is %s', time.asctime())
@end example

Cuando se ejecuta este script, debería imprimir algo como:

@example
2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015
2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015
@end example

mostrando cómo se formatea la hora como hora local y UTC, una para cada gestor.

@node Usar un administrador de contexto para logging selectivo,Una plantilla de inicio de aplicación CLI,Formateo de horas usando UTC GMT a través de la configuración,Libro de recetas de Logging
@anchor{howto/logging-cookbook context-manager}@anchor{4ef2}@anchor{howto/logging-cookbook using-a-context-manager-for-selective-logging}@anchor{4ef3}
@subsection Usar un administrador de contexto para logging selectivo


Hay ocasiones en las que sería útil cambiar temporalmente la configuración de logging y revertir esto después de hacer algo. Para ello, un administrador de contexto es la forma más obvia de guardar y restaurar el contexto de logging. Aquí hay un ejemplo simple de un administrador de contexto de este tipo, que le permite cambiar opcionalmente el nivel de logging y agregar un gestor de logging exclusivamente en el alcance del administrador de contexto:

@example
import logging
import sys

class LoggingContext:
    def __init__(self, logger, level=None, handler=None, close=True):
        self.logger = logger
        self.level = level
        self.handler = handler
        self.close = close

    def __enter__(self):
        if self.level is not None:
            self.old_level = self.logger.level
            self.logger.setLevel(self.level)
        if self.handler:
            self.logger.addHandler(self.handler)

    def __exit__(self, et, ev, tb):
        if self.level is not None:
            self.logger.setLevel(self.old_level)
        if self.handler:
            self.logger.removeHandler(self.handler)
        if self.handler and self.close:
            self.handler.close()
        # implicit return of None => don't swallow exceptions
@end example

Si especifica un valor de nivel, el nivel del registrador se establece en ese valor en el alcance del bloque `with' cubierto por el administrador de contexto. Si especifica un gestor, se agrega al registrador al entrar al bloque y se elimina al salir del bloque. También puede pedirle al administrador que cierre el gestor por usted al salir del bloque si ya no lo necesita.

Para ilustrar cómo funciona, podemos agregar el siguiente bloque de código al anterior:

@example
if __name__ == '__main__':
    logger = logging.getLogger('foo')
    logger.addHandler(logging.StreamHandler())
    logger.setLevel(logging.INFO)
    logger.info('1. This should appear just once on stderr.')
    logger.debug('2. This should not appear.')
    with LoggingContext(logger, level=logging.DEBUG):
        logger.debug('3. This should appear once on stderr.')
    logger.debug('4. This should not appear.')
    h = logging.StreamHandler(sys.stdout)
    with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):
        logger.debug('5. This should appear twice - once on stderr and once on stdout.')
    logger.info('6. This should appear just once on stderr.')
    logger.debug('7. This should not appear.')
@end example

Inicialmente configuramos el nivel del registrador en @code{INFO}, por lo que aparece el mensaje #1 y el mensaje #2 no. Luego cambiamos el nivel a @code{DEBUG} temporalmente en el siguiente bloque @code{with}, y aparece el mensaje #3. Una vez que se sale del bloque, el nivel del registrador se restaura a @code{INFO} y, por lo tanto, el mensaje #4 no aparece. En el siguiente bloque @code{with}, configuramos el nivel en @code{DEBUG} nuevamente, pero también agregamos un gestor que escribe en @code{sys.stdout}. Por lo tanto, el mensaje #5 aparece dos veces en la consola (una vez a través de @code{stderr} y una vez a través de @code{stdout}). Después de la finalización de la declaración @code{with}, se vuelve al estado anterior, por lo que aparece el mensaje #6 (como el mensaje #1) mientras que el mensaje #7 no (como el mensaje #2).

Si ejecutamos el script resultante, el resultado es el siguiente:

@example
$ python logctx.py
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.
@end example

Si lo ejecutamos de nuevo, pero dirigimos @code{stderr} a @code{/dev/null}, vemos lo siguiente, que es el único mensaje escrito en @code{stdout}:

@example
$ python logctx.py 2>/dev/null
5. This should appear twice - once on stderr and once on stdout.
@end example

Una vez más, pero canalizando @code{stdout} a @code{/dev/null}, obtenemos:

@example
$ python logctx.py >/dev/null
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.
@end example

En este caso, el mensaje #5 impreso en @code{stdout} no aparece, como se esperaba.

Por supuesto, el enfoque descrito aquí puede generalizarse, por ejemplo, para adjuntar filtros de logging temporalmente. Tenga en cuenta que el código anterior funciona tanto en Python 2 como en Python 3.

@node Una plantilla de inicio de aplicación CLI,Una GUI de Qt para logging,Usar un administrador de contexto para logging selectivo,Libro de recetas de Logging
@anchor{howto/logging-cookbook a-cli-application-starter-template}@anchor{4ef4}@anchor{howto/logging-cookbook starter-template}@anchor{4ef5}
@subsection Una plantilla de inicio de aplicación CLI


Aquí hay un ejemplo que muestra cómo puede:


@itemize *

@item 
Utilizar un nivel de logging basado en argumentos de la línea de comandos

@item 
Enviar a varios subcomandos en archivos separados, todos registrando en el mismo nivel de forma coherente

@item 
Utilizar una configuración mínima y sencilla
@end itemize

Supongamos que tenemos una aplicación de línea de comandos cuyo trabajo es detener, iniciar o reiniciar algunos servicios. Esto podría organizarse con fines ilustrativos como un archivo @code{app.py} que es el script principal de la aplicación, con comandos individuales implementados en @code{start.py}, @code{stop.py} y @code{restart.py}. Supongamos además que queremos controlar la verbosidad de la aplicación a través de un argumento de línea de comandos, por defecto en @code{logging.INFO}. Aquí hay una forma en que se podría escribir @code{app.py}:

@example
import argparse
import importlib
import logging
import os
import sys

def main(args=None):
    scriptname = os.path.basename(__file__)
    parser = argparse.ArgumentParser(scriptname)
    levels = ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
    parser.add_argument('--log-level', default='INFO', choices=levels)
    subparsers = parser.add_subparsers(dest='command',
                                       help='Available commands:')
    start_cmd = subparsers.add_parser('start', help='Start a service')
    start_cmd.add_argument('name', metavar='NAME',
                           help='Name of service to start')
    stop_cmd = subparsers.add_parser('stop',
                                     help='Stop one or more services')
    stop_cmd.add_argument('names', metavar='NAME', nargs='+',
                          help='Name of service to stop')
    restart_cmd = subparsers.add_parser('restart',
                                        help='Restart one or more services')
    restart_cmd.add_argument('names', metavar='NAME', nargs='+',
                             help='Name of service to restart')
    options = parser.parse_args()
    # the code to dispatch commands could all be in this file. For the purposes
    # of illustration only, we implement each command in a separate module.
    try:
        mod = importlib.import_module(options.command)
        cmd = getattr(mod, 'command')
    except (ImportError, AttributeError):
        print('Unable to find the code for command \'%s\'@w{'} % options.command)
        return 1
    # Could get fancy here and load configuration from file or dictionary
    logging.basicConfig(level=options.log_level,
                        format='%(levelname)s %(name)s %(message)s')
    cmd(options)

if __name__ == '__main__':
    sys.exit(main())
@end example

Y los comandos @code{start}, @code{stop} y @code{reiniciar} se pueden implementar en módulos separados, como para iniciar:

@example
# start.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    logger.debug('About to start %s', options.name)
    # actually do the command processing here ...
    logger.info('Started the \'%s\' service.', options.name)
@end example

y así para detener:

@example
# stop.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = '@w{'}
        services = '\'%s\'@w{'} % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'@w{'} % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to stop %s', services)
    # actually do the command processing here ...
    logger.info('Stopped the %s service%s.', services, plural)
@end example

y de manera similar para reiniciar:

@example
# restart.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = '@w{'}
        services = '\'%s\'@w{'} % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'@w{'} % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to restart %s', services)
    # actually do the command processing here ...
    logger.info('Restarted the %s service%s.', services, plural)
@end example

Si ejecutamos esta aplicación con el nivel de log predeterminado, obtenemos un resultado como este:

@example
$ python app.py start foo
INFO start Started the 'foo' service.

$ python app.py stop foo bar
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py restart foo bar baz
INFO restart Restarted the 'foo', 'bar' and 'baz' services.
@end example

La primera palabra es el nivel de logging y la segunda palabra es el nombre del módulo o paquete del lugar donde se registró el evento.

Si cambiamos el nivel de logging, podemos cambiar la información enviada al log. Por ejemplo, si queremos más información:

@example
$ python app.py --log-level DEBUG start foo
DEBUG start About to start foo
INFO start Started the 'foo' service.

$ python app.py --log-level DEBUG stop foo bar
DEBUG stop About to stop 'foo' and 'bar'
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py --log-level DEBUG restart foo bar baz
DEBUG restart About to restart 'foo', 'bar' and 'baz'
INFO restart Restarted the 'foo', 'bar' and 'baz' services.
@end example

Y si queremos menos:

@example
$ python app.py --log-level WARNING start foo
$ python app.py --log-level WARNING stop foo bar
$ python app.py --log-level WARNING restart foo bar baz
@end example

En este caso, los comandos no imprimen nada en la consola, ya que no registran nada en el nivel de @code{WARNING} o superior.

@node Una GUI de Qt para logging,Logging en syslog con soporte RFC5424,Una plantilla de inicio de aplicación CLI,Libro de recetas de Logging
@anchor{howto/logging-cookbook a-qt-gui-for-logging}@anchor{4ef6}@anchor{howto/logging-cookbook qt-gui}@anchor{4ef7}
@subsection Una GUI de Qt para logging


A question that comes up from time to time is about how to log to a GUI
application. The Qt@footnote{https://www.qt.io/} framework is a popular
cross-platform UI framework with Python bindings using PySide2@footnote{https://pypi.org/project/PySide2/}
or PyQt5@footnote{https://pypi.org/project/PyQt5/} libraries.

El siguiente ejemplo muestra cómo iniciar sesión en una GUI de Qt. Esto introduce una clase simple @code{QtHandler} que toma un invocable, que debería ser un slot en el hilo principal que realiza actualizaciones de la GUI. También se crea un hilo de trabajo para mostrar cómo puede iniciar sesión en la GUI tanto desde la propia interfaz de usuario (a través de un botón para el logging manual) como desde un hilo de trabajo que trabaja en segundo plano (aquí, simplemente registrando mensajes en niveles aleatorios con aleatorio breves retrasos intermedios).

El hilo `worker' se implementa usando la clase @code{QThread} de Qt en lugar del módulo @ref{ed,,threading}, ya que hay circunstancias en las que uno tiene que usar @code{QThread}, que ofrece una mejor integración con otros componentes @code{Qt}.

The code should work with recent releases of any of @code{PySide6}, @code{PyQt6},
@code{PySide2} or @code{PyQt5}. You should be able to adapt the approach to earlier
versions of Qt. Please refer to the comments in the code snippet for more
detailed information.

@example
import datetime
import logging
import random
import sys
import time

# Deal with minor differences between different Qt packages
try:
    from PySide6 import QtCore, QtGui, QtWidgets
    Signal = QtCore.Signal
    Slot = QtCore.Slot
except ImportError:
    try:
        from PyQt6 import QtCore, QtGui, QtWidgets
        Signal = QtCore.pyqtSignal
        Slot = QtCore.pyqtSlot
    except ImportError:
        try:
            from PySide2 import QtCore, QtGui, QtWidgets
            Signal = QtCore.Signal
            Slot = QtCore.Slot
        except ImportError:
            from PyQt5 import QtCore, QtGui, QtWidgets
            Signal = QtCore.pyqtSignal
            Slot = QtCore.pyqtSlot

logger = logging.getLogger(__name__)


#
# Signals need to be contained in a QObject or subclass in order to be correctly
# initialized.
#
class Signaller(QtCore.QObject):
    signal = Signal(str, logging.LogRecord)

#
# Output to a Qt GUI is only supposed to happen on the main thread. So, this
# handler is designed to take a slot function which is set up to run in the main
# thread. In this example, the function takes a string argument which is a
# formatted log message, and the log record which generated it. The formatted
# string is just a convenience - you could format a string for output any way
# you like in the slot function itself.
#
# You specify the slot function to do whatever GUI updates you want. The handler
# doesn't know or care about specific UI elements.
#
class QtHandler(logging.Handler):
    def __init__(self, slotfunc, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.signaller = Signaller()
        self.signaller.signal.connect(slotfunc)

    def emit(self, record):
        s = self.format(record)
        self.signaller.signal.emit(s, record)

#
# This example uses QThreads, which means that the threads at the Python level
# are named something like "Dummy-1". The function below gets the Qt name of the
# current thread.
#
def ctname():
    return QtCore.QThread.currentThread().objectName()


#
# Used to generate random levels for logging.
#
LEVELS = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)

#
# This worker class represents work that is done in a thread separate to the
# main thread. The way the thread is kicked off to do work is via a button press
# that connects to a slot in the worker.
#
# Because the default threadName value in the LogRecord isn't much use, we add
# a qThreadName which contains the QThread name as computed above, and pass that
# value in an "extra" dictionary which is used to update the LogRecord with the
# QThread name.
#
# This example worker just outputs messages sequentially, interspersed with
# random delays of the order of a few seconds.
#
class Worker(QtCore.QObject):
    @@Slot()
    def start(self):
        extra = @{'qThreadName': ctname() @}
        logger.debug('Started work', extra=extra)
        i = 1
        # Let the thread run until interrupted. This allows reasonably clean
        # thread termination.
        while not QtCore.QThread.currentThread().isInterruptionRequested():
            delay = 0.5 + random.random() * 2
            time.sleep(delay)
            try:
                if random.random() < 0.1:
                    raise ValueError('Exception raised: %d' % i)
                else:
                    level = random.choice(LEVELS)
                    logger.log(level, 'Message after delay of %3.1f: %d', delay, i, extra=extra)
            except ValueError as e:
                logger.exception('Failed: %s', e, extra=extra)
            i += 1

#
# Implement a simple UI for this cookbook example. This contains:
#
# * A read-only text edit window which holds formatted log messages
# * A button to start work and log stuff in a separate thread
# * A button to log something from the main thread
# * A button to clear the log window
#
class Window(QtWidgets.QWidget):

    COLORS = @{
        logging.DEBUG: 'black',
        logging.INFO: 'blue',
        logging.WARNING: 'orange',
        logging.ERROR: 'red',
        logging.CRITICAL: 'purple',
    @}

    def __init__(self, app):
        super().__init__()
        self.app = app
        self.textedit = te = QtWidgets.QPlainTextEdit(self)
        # Set whatever the default monospace font is for the platform
        f = QtGui.QFont('nosuchfont')
        if hasattr(f, 'Monospace'):
            f.setStyleHint(f.Monospace)
        else:
            f.setStyleHint(f.StyleHint.Monospace)  # for Qt6
        te.setFont(f)
        te.setReadOnly(True)
        PB = QtWidgets.QPushButton
        self.work_button = PB('Start background work', self)
        self.log_button = PB('Log a message at a random level', self)
        self.clear_button = PB('Clear log window', self)
        self.handler = h = QtHandler(self.update_status)
        # Remember to use qThreadName rather than threadName in the format string.
        fs = '%(asctime)s %(qThreadName)-12s %(levelname)-8s %(message)s'
        formatter = logging.Formatter(fs)
        h.setFormatter(formatter)
        logger.addHandler(h)
        # Set up to terminate the QThread when we exit
        app.aboutToQuit.connect(self.force_quit)

        # Lay out all the widgets
        layout = QtWidgets.QVBoxLayout(self)
        layout.addWidget(te)
        layout.addWidget(self.work_button)
        layout.addWidget(self.log_button)
        layout.addWidget(self.clear_button)
        self.setFixedSize(900, 400)

        # Connect the non-worker slots and signals
        self.log_button.clicked.connect(self.manual_update)
        self.clear_button.clicked.connect(self.clear_display)

        # Start a new worker thread and connect the slots for the worker
        self.start_thread()
        self.work_button.clicked.connect(self.worker.start)
        # Once started, the button should be disabled
        self.work_button.clicked.connect(lambda : self.work_button.setEnabled(False))

    def start_thread(self):
        self.worker = Worker()
        self.worker_thread = QtCore.QThread()
        self.worker.setObjectName('Worker')
        self.worker_thread.setObjectName('WorkerThread')  # for qThreadName
        self.worker.moveToThread(self.worker_thread)
        # This will start an event loop in the worker thread
        self.worker_thread.start()

    def kill_thread(self):
        # Just tell the worker to stop, then tell it to quit and wait for that
        # to happen
        self.worker_thread.requestInterruption()
        if self.worker_thread.isRunning():
            self.worker_thread.quit()
            self.worker_thread.wait()
        else:
            print('worker has already exited.')

    def force_quit(self):
        # For use when the window is closed
        if self.worker_thread.isRunning():
            self.kill_thread()

    # The functions below update the UI and run in the main thread because
    # that's where the slots are set up

    @@Slot(str, logging.LogRecord)
    def update_status(self, status, record):
        color = self.COLORS.get(record.levelno, 'black')
        s = '<pre><font color="%s">%s</font></pre>' % (color, status)
        self.textedit.appendHtml(s)

    @@Slot()
    def manual_update(self):
        # This function uses the formatted message passed in, but also uses
        # information from the record to format the message in an appropriate
        # color according to its severity (level).
        level = random.choice(LEVELS)
        extra = @{'qThreadName': ctname() @}
        logger.log(level, 'Manually logged!', extra=extra)

    @@Slot()
    def clear_display(self):
        self.textedit.clear()


def main():
    QtCore.QThread.currentThread().setObjectName('MainThread')
    logging.getLogger().setLevel(logging.DEBUG)
    app = QtWidgets.QApplication(sys.argv)
    example = Window(app)
    example.show()
    if hasattr(app, 'exec'):
        rc = app.exec()
    else:
        rc = app.exec_()
    sys.exit(rc)

if __name__=='__main__':
    main()
@end example

@node Logging en syslog con soporte RFC5424,Cómo tratar un logger como una salida stream,Una GUI de Qt para logging,Libro de recetas de Logging
@anchor{howto/logging-cookbook logging-to-syslog-with-rfc5424-support}@anchor{4ef8}
@subsection Logging en syslog con soporte RFC5424


Although 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} dates from 2009, most syslog servers are configured by default to
use the older 
@geindex RFC; RFC 3164
RFC 3164@footnote{https://datatracker.ietf.org/doc/html/rfc3164.html}, which hails from 2001. When @code{logging} was added to Python
in 2003, it supported the earlier (and only existing) protocol at the time. Since
RFC5424 came out, as there has not been widespread deployment of it in syslog
servers, the @ref{6fd,,SysLogHandler} functionality has not been
updated.

El RFC 5424 contiene algunas características útiles como el soporte para datos estructurados, y si necesitas poder registrar en un servidor syslog con soporte para ello, puedes hacerlo con una subclase `handler' que se parezca a esto:

@example
import datetime
import logging.handlers
import re
import socket
import time

class SysLogHandler5424(logging.handlers.SysLogHandler):

    tz_offset = re.compile(r'([+-]\d@{2@})(\d@{2@})$')
    escaped = re.compile(r'([\]"\\])')

    def __init__(self, *args, **kwargs):
        self.msgid = kwargs.pop('msgid', None)
        self.appname = kwargs.pop('appname', None)
        super().__init__(*args, **kwargs)

    def format(self, record):
        version = 1
        asctime = datetime.datetime.fromtimestamp(record.created).isoformat()
        m = self.tz_offset.match(time.strftime('%z'))
        has_offset = False
        if m and time.timezone:
            hrs, mins = m.groups()
            if int(hrs) or int(mins):
                has_offset = True
        if not has_offset:
            asctime += 'Z'
        else:
            asctime += f'@{hrs@}:@{mins@}'
        try:
            hostname = socket.gethostname()
        except Exception:
            hostname = '-'
        appname = self.appname or '-'
        procid = record.process
        msgid = '-'
        msg = super().format(record)
        sdata = '-'
        if hasattr(record, 'structured_data'):
            sd = record.structured_data
            # This should be a dict where the keys are SD-ID and the value is a
            # dict mapping PARAM-NAME to PARAM-VALUE (refer to the RFC for what these
            # mean)
            # There's no error checking here - it's purely for illustration, and you
            # can adapt this code for use in production environments
            parts = []

            def replacer(m):
                g = m.groups()
                return '\\' + g[0]

            for sdid, dv in sd.items():
                part = f'[@{sdid@}'
                for k, v in dv.items():
                    s = str(v)
                    s = self.escaped.sub(replacer, s)
                    part += f' @{k@}="@{s@}"'
                part += ']'
                parts.append(part)
            sdata = '@w{'}.join(parts)
        return f'@{version@} @{asctime@} @{hostname@} @{appname@} @{procid@} @{msgid@} @{sdata@} @{msg@}'
@end example

Tendrá que estar familiarizado con el RFC 5424 para entender completamente el código anterior, y puede ser que tenga necesidades ligeramente diferentes (por ejemplo, para la forma de pasar los datos estructurales al log). No obstante, lo anterior debería poder adaptarse a sus necesidades específicas. Con el gestor anterior, usted pasaría datos estructurados usando algo como esto:

@example
sd = @{
    'foo@@12345': @{'bar': 'baz', 'baz': 'bozz', 'fizz': r'buzz'@},
    'foo@@54321': @{'rab': 'baz', 'zab': 'bozz', 'zzif': r'buzz'@}
@}
extra = @{'structured_data': sd@}
i = 1
logger.debug('Message %d', i, extra=extra)
@end example

@node Cómo tratar un logger como una salida stream,Patrones para evitar,Logging en syslog con soporte RFC5424,Libro de recetas de Logging
@anchor{howto/logging-cookbook how-to-treat-a-logger-like-an-output-stream}@anchor{4ef9}
@subsection Cómo tratar un logger como una salida stream


A veces, necesitas interactuar con una API de terceros que espera un objeto tipo archivo para escribir, pero quieres dirigir la salida de la API a un logger. Puedes hacer esto usando una clase que envuelva un logger con una API tipo archivo. Aquí hay un pequeño script que ilustra tal clase:

@example
import logging

class LoggerWriter:
    def __init__(self, logger, level):
        self.logger = logger
        self.level = level

    def write(self, message):
        if message != '\n':  # avoid printing bare newlines, if you like
            self.logger.log(self.level, message)

    def flush(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation
        pass

    def close(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation. You might want
        # to set a flag so that later calls to write raise an exception
        pass

def main():
    logging.basicConfig(level=logging.DEBUG)
    logger = logging.getLogger('demo')
    info_fp = LoggerWriter(logger, logging.INFO)
    debug_fp = LoggerWriter(logger, logging.DEBUG)
    print('An INFO message', file=info_fp)
    print('A DEBUG message', file=debug_fp)

if __name__ == "__main__":
    main()
@end example

Cuando se ejecuta este script, se imprime

@example
INFO:demo:An INFO message
DEBUG:demo:A DEBUG message
@end example

También puedes usar @code{LoggerWriter} para redirigir @code{sys.stdout} y @code{sys.stderr} haciendo algo así:

@example
import sys

sys.stdout = LoggerWriter(logger, logging.INFO)
sys.stderr = LoggerWriter(logger, logging.WARNING)
@end example

Debería hacer esto `después' de configurar logging para sus necesidades. En el ejemplo anterior, la llamada @ref{a92,,basicConfig()} hace esto (utilizando el valor de @code{sys.stderr} `antes' de que sea sobrescrito por una instancia de @code{LoggerWriter}). Entonces, obtendrías este tipo de resultado:

@example
>>> print('Foo')
INFO:demo:Foo
>>> print('Bar', file=sys.stderr)
WARNING:demo:Bar
>>>
@end example

Por supuesto, los ejemplos anteriores muestran la salida según el formato utilizado por @ref{a92,,basicConfig()}, pero puede utilizar un formateador diferente cuando configure logging.

Ten en cuenta que con el esquema anterior, estás un poco a merced del buffering y de la secuencia de llamadas de escritura que estás interceptando. Por ejemplo, con la definición de @code{LoggerWriter} anterior, si tienes el fragmento

@example
sys.stderr = LoggerWriter(logger, logging.WARNING)
1 / 0
@end example

entonces la ejecución del script da como resultado

@example
WARNING:demo:Traceback (most recent call last):

WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 53, in <module>

WARNING:demo:
WARNING:demo:main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 49, in main

WARNING:demo:
WARNING:demo:1 / 0
WARNING:demo:ZeroDivisionError
WARNING:demo::
WARNING:demo:division by zero
@end example

As you can see, this output isn’t ideal. That’s because the underlying code
which writes to @code{sys.stderr} makes multiple writes, each of which results in a
separate logged line (for example, the last three lines above). To get around
this problem, you need to buffer things and only output log lines when newlines
are seen. Let’s use a slightly better implementation of @code{LoggerWriter}:

@example
class BufferingLoggerWriter(LoggerWriter):
    def __init__(self, logger, level):
        super().__init__(logger, level)
        self.buffer = '@w{'}

    def write(self, message):
        if '\n' not in message:
            self.buffer += message
        else:
            parts = message.split('\n')
            if self.buffer:
                s = self.buffer + parts.pop(0)
                self.logger.log(self.level, s)
            self.buffer = parts.pop()
            for part in parts:
                self.logger.log(self.level, part)
@end example

Esto sólo almacena cosas hasta que se ve una nueva línea, y luego registra las líneas completas. Con este enfoque, se obtiene una mejor salida:

@example
WARNING:demo:Traceback (most recent call last):
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 55, in <module>
WARNING:demo:    main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 52, in main
WARNING:demo:    1/0
WARNING:demo:ZeroDivisionError: division by zero
@end example

@c patterns-to-avoid:

@node Patrones para evitar,Otros recursos<3>,Cómo tratar un logger como una salida stream,Libro de recetas de Logging
@anchor{howto/logging-cookbook patterns-to-avoid}@anchor{4efa}
@subsection Patrones para evitar


Aunque las secciones anteriores han descrito formas de hacer las cosas que podría necesitar hacer o con las que tratar, vale la pena mencionar algunos patrones de uso que son `inútiles' y que, por lo tanto, deben evitarse en la mayoría de los casos. Las siguientes secciones no están en ningún orden en particular.

@menu
* Abrir el mismo archivo de registro varias veces:: 
* Usar registradores como atributos en una clase o pasarlos como parámetros:: 
* Adding handlers other than NullHandler to a logger in a library:: 
* Crear muchos registradores (loggers): Crear muchos registradores loggers. 

@end menu

@node Abrir el mismo archivo de registro varias veces,Usar registradores como atributos en una clase o pasarlos como parámetros,,Patrones para evitar
@anchor{howto/logging-cookbook opening-the-same-log-file-multiple-times}@anchor{4efb}
@subsubsection Abrir el mismo archivo de registro varias veces


En Windows, por lo general, no podrá abrir el mismo archivo varias veces, ya que esto lanzará un error de «otro proceso está usando el archivo». Sin embargo, en las plataformas POSIX no obtendrá ningún error si abre el mismo archivo varias veces. Esto podría hacerse accidentalmente, por ejemplo:


@itemize *

@item 
Agregar un controlador de archivos más de una vez que hace referencia al mismo archivo (por ejemplo, mediante un error de copiar/pegar/olvidar-cambiar).

@item 
Abrir dos archivos que se ven diferentes, ya que tienen diferentes nombres, pero son iguales porque uno es un enlace simbólico al otro.

@item 
Bifurcar un proceso, después del cual tanto el padre como el hijo tienen una referencia al mismo archivo. Esto podría ser mediante el uso del módulo @ref{94,,multiprocessing}, por ejemplo.
@end itemize

Abrir un archivo varias veces puede `parecer' que funciona la mayor parte del tiempo, pero puede dar lugar a una serie de problemas en la práctica:


@itemize *

@item 
La salida del registro se puede distorsionar porque varios subprocesos o procesos intentan escribir en el mismo archivo. Aunque el registro se protege de el uso simultáneo de la misma instancia de controlador por varios subprocesos, no existe tal protección si dos subprocesos diferentes intentan escrituras simultáneas utilizando dos instancias de controlador diferentes que apunten al mismo archivo.

@item 
Un intento de eliminar un archivo (por ejemplo, durante la rotación de archivos) falla silenciosamente, porque hay otra referencia que apunta a él. Esto puede generar confusión y una pérdida de tiempo de depuración: las entradas del registro terminan en lugares inesperados o se pierden por completo. O un archivo que debía ser movido permanece en su lugar, y crece en tamaño inesperadamente a pesar de que la rotación basada en el tamaño está supuestamente en su lugar.
@end itemize

Utilice las técnicas descritas en @ref{4ecc,,Logging a un sólo archivo desde múltiples procesos} para evitar estos problemas.

@node Usar registradores como atributos en una clase o pasarlos como parámetros,Adding handlers other than NullHandler to a logger in a library,Abrir el mismo archivo de registro varias veces,Patrones para evitar
@anchor{howto/logging-cookbook using-loggers-as-attributes-in-a-class-or-passing-them-as-parameters}@anchor{4efc}
@subsubsection Usar registradores como atributos en una clase o pasarlos como parámetros


Si bien puede haber casos inusuales en los que deba hacer esto, en general no tiene sentido porque los registradores son singletons. El código siempre puede acceder a una instancia de registrador dada por su nombre usando @code{logging.getLogger(name)}, por lo que pasar instancias y mantenerlas como atributos de instancia no tiene sentido. Tenga en cuenta que en otros lenguajes como Java y C#, los registradores suelen ser atributos de clase estáticos. Sin embargo, este patrón no tiene sentido en Python, donde el módulo (y no la clase) es la unidad de descomposición del software.

@node Adding handlers other than NullHandler to a logger in a library,Crear muchos registradores loggers,Usar registradores como atributos en una clase o pasarlos como parámetros,Patrones para evitar
@anchor{howto/logging-cookbook adding-handlers-other-than-nullhandler-to-a-logger-in-a-library}@anchor{4efd}
@subsubsection Adding handlers other than @code{NullHandler} to a logger in a library


La configuración del registro agregando controladores, formateadores y filtros es responsabilidad del desarrollador de la aplicación, no del desarrollador de la biblioteca. Si mantiene una biblioteca, asegúrese de no agregar controladores a ninguno de sus registradores que no sean una instancia @ref{12f1,,NullHandler}.

@node Crear muchos registradores loggers,,Adding handlers other than NullHandler to a logger in a library,Patrones para evitar
@anchor{howto/logging-cookbook creating-a-lot-of-loggers}@anchor{4efe}
@subsubsection Crear muchos registradores (`loggers')


Los registradores son singletons que nunca se liberan durante la ejecución de un script, por lo que la creación de muchos registradores consumirá memoria que luego no se puede liberar. En lugar de crear un registrador por ej. archivo procesado o conexión de red realizada, use los @ref{2d08,,mecanismos existentes} para pasar información contextual a sus registros y restringir los registradores creados a aquellos que describen áreas dentro de su aplicación (generalmente módulos, pero ocasionalmente un poco más detallado que eso).

@node Otros recursos<3>,,Patrones para evitar,Libro de recetas de Logging
@anchor{howto/logging-cookbook cookbook-ref-links}@anchor{4eb8}@anchor{howto/logging-cookbook other-resources}@anchor{4eff}
@subsection Otros recursos



@subsubheading Ver también



@table @asis

@item Módulo @ref{87,,logging}

Referencia de API para el módulo logging.

@item Módulo @ref{88,,logging.config}

API de configuración para el módulo logging.

@item Módulo @ref{89,,logging.handlers}

Gestores útiles incluidos con el módulo logging.
@end table

@ref{1262,,Tutorial Básico}

@ref{1263,,Tutorial Avanzado}


@node Expresiones regulares COMOS HOWTO,HOW TO - Programación con sockets,Libro de recetas de Logging,Comos HOWTOs de Python
@anchor{howto/regex doc}@anchor{4f00}@anchor{howto/regex regex-howto}@anchor{22ef}@anchor{howto/regex regular-expression-howto}@anchor{4f01}
@section Expresiones regulares COMOS (`HOWTO')


@*Autor: 
`A.M. Kuchling <amk@@amk.ca>'


@c TODO:
@c Document lookbehind assertions
@c Better way of displaying a RE, a string, and what it matches
@c Mention optional argument to match.groups()
@c Unicode (at least a reference)

@subsubheading Resumen



Este documento es un tutorial de introducción al uso de expresiones regulares en Python con el módulo @ref{b9,,re}. Proporciona una introducción más apacible que la sección correspondiente en la Referencia de la Biblioteca.

@menu
* Introducción: Introducción<13>. 
* Patrones simples:: 
* Usando expresiones regulares:: 
* Más poder de patrones:: 
* Modificando cadenas de caracteres:: 
* Problemas comunes:: 
* Feedback:: 

@end menu

@node Introducción<13>,Patrones simples,,Expresiones regulares COMOS HOWTO
@anchor{howto/regex introduction}@anchor{4f02}
@subsection Introducción


Las expresiones regulares (llamadas RE, o regex, o patrones de regex) son esencialmente en un lenguaje de programación diminuto y altamente especializado incrustado dentro de Python y disponible a través del módulo @ref{b9,,re}. Usando este pequeño lenguaje, especificas las reglas para el conjunto de cadenas de caracteres posibles que deseas hacer coincidir; este conjunto puede contener frases en inglés, o direcciones de correo electrónico, o comandos TeX, o cualquier cosa que desee. A continuación, puede hacer preguntas como «¿Coincide esta cadena con el patrón?» o «¿Hay alguna coincidencia con el patrón en alguna parte de esta cadena?». También puede utilizar RE para modificar una cadena de caracteres o dividirla de varias formas.

Los patrones de expresiones regulares se compilan en una serie de códigos de bytes que luego son ejecutados por un motor de coincidencia escrito en C. Para un uso avanzado, puede ser necesario prestar mucha atención a cómo el motor ejecutará una RE dado y escribir la RE en un de cierta manera para producir un código de bytes que se ejecute más rápido. La optimización no se trata en este documento, porque requiere que tenga un buen conocimiento de los componentes internos del motor de coincidencia.

El lenguaje de expresiones regulares es relativamente pequeño y restringido, por lo que no todas las posibles tareas de procesamiento de cadenas de caracteres se pueden realizar utilizando expresiones regulares. También hay tareas que `se pueden' hacer con expresiones regulares, pero las expresiones resultan ser muy complicadas. En estos casos, es mejor que escriba código Python para realizar el procesamiento; Si bien el código Python será más lento que una expresión regular elaborada, probablemente también será más comprensible.

@node Patrones simples,Usando expresiones regulares,Introducción<13>,Expresiones regulares COMOS HOWTO
@anchor{howto/regex simple-patterns}@anchor{4f03}
@subsection Patrones simples


Comenzaremos aprendiendo sobre las expresiones regulares más simples posibles. Dado que las expresiones regulares se utilizan para operar en cadenas de caracteres, comenzaremos con la tarea más común: hacer coincidir caracteres.

Para obtener una explicación detallada de la informática que subyace a las expresiones regulares (autómatas finitos deterministas y no deterministas), puede consultar casi cualquier libro de texto sobre la escritura de compiladores.

@menu
* Coincidencia de caracteres (Matching Characters): Coincidencia de caracteres Matching Characters. 
* Repitiendo cosas:: 

@end menu

@node Coincidencia de caracteres Matching Characters,Repitiendo cosas,,Patrones simples
@anchor{howto/regex matching-characters}@anchor{4f04}
@subsubsection Coincidencia de caracteres (`Matching Characters')


La mayoría de letras y caracteres simplemente coincidirán. Por ejemplo, la expresión regular @code{test} coincidirá exactamente con la cadena @code{test}. (Puede habilitar un modo que no distinga entre mayúsculas y minúsculas que permitiría que este RE coincida con @code{test} o @code{TEST} también; más sobre esto más adelante.)

Hay excepciones a esta regla; algunos caracteres son especiales `metacharacters', y no coinciden. En cambio, señalan que debe coincidir con algo fuera de lo común, o afectan otras partes de la RE repitiéndolos o cambiando su significado. Gran parte de este documento está dedicado a discutir varios metacaracteres y lo que hacen.

Aquí hay una lista completa de los metacaracteres; sus significados se discutirán en el resto de este COMO (`HOWTO').

@example
. ^ $ * + ? @{ @} [ ] \ | ( )
@end example

Los primeros metacaracteres que veremos son @code{[} and @code{]}. Se utilizan para especificar una clase de carácter, que es un conjunto de caracteres que desea hacer coincidir. Los caracteres se pueden enumerar individualmente, o se puede indicar un rango de caracteres dando dos caracteres y separándolos con un  @code{'-'}. Por ejemplo, @code{[abc]} coincidirá con cualquiera de los caracteres @code{a}, @code{b} o @code{c}; esto es lo mismo que @code{[a-c]}, que usa un rango para expresar el mismo conjunto de caracteres. Si quisiera hacer coincidir solo letras minúsculas, su RE sería @code{[a-c]}.

Los metacaracteres (excepto @code{\}) no están activos dentro de las clases.  Por ejemplo, @code{[akm$]} coincidirá con cualquiera de los caracteres @code{'a'}, @code{'k'}, @code{'m'}, o @code{'$'}; @code{'$'} suele ser un metacarácter, pero dentro de una clase de carácter se le quita su naturaleza especial.

Puede hacer coincidir los caracteres que no figuran en la clase mediante el conjunto `complementing'. Esto se indica mediante la inclusión de un @code{'^'} como primer carácter de la clase. Por ejemplo, @code{[^5]} coincidirá con cualquier carácter excepto con @code{'5'}. Si el símbolo de intercalación aparece en otra parte de una clase de caracter, no tiene un significado especial. Por ejemplo: @code{[5^]} coincidirá con un @code{'5'} o un @code{'^'}.

Quizás el metacarácter más importante es la barra invertida, @code{\}. Al igual que en los literales de cadena de Python, la barra invertida puede ir seguida de varios caracteres para señalar varias secuencias especiales. También se usa para escapar de todos los metacaracteres, de modo que aún pueda emparejarlos en patrones; por ejemplo, si necesita hacer coincidir un @code{[} o @code{\}, puede precederlos con una barra invertida para eliminar su significado especial: @code{\[} o @code{\\}.

Algunas de las secuencias especiales que comienzan con @code{'\'} representan conjuntos predefinidos de caracteres que a menudo son útiles, como el conjunto de dígitos, el conjunto de letras o el conjunto de cualquier cosa que no sea un espacio en blanco.

Tomemos un ejemplo: @code{\w} coincide con cualquier carácter alfanumérico. Si el patrón de expresiones regulares se expresa en bytes, esto es equivalente a la clase @code{[a-zA-Z0-9_]}. Si el patrón de expresiones regulares es una cadena de caracteres, @code{\w} coincidirá con todos los caracteres marcados como letras en la base de datos Unicode proporcionada por el módulo @ref{105,,unicodedata}. Puede usar la definición más restringida de @code{\w} en un patrón de cadena proporcionando el indicador @ref{6cd,,re.ASCII} al compilar la expresión regular.

La siguiente lista de secuencias especiales no está completa. Para obtener una lista completa de secuencias y definiciones de clases expandidas para patrones de cadenas Unicode, consulte la última parte de @ref{7c0,,Regular Expression Syntax} en la referencia de la biblioteca estándar. En general, las versiones Unicode coinciden con cualquier carácter que esté en la categoría apropiada en la base de datos Unicode.


@table @asis

@item @code{\d}

Coincide con cualquier dígito decimal; esto es equivalente a la clase @code{[0-9]}.

@item @code{\D}

Coincide con cualquier carácter que no sea un dígito; esto es equivalente a la clase @code{[^0-9]}.

@item @code{\s}

Coincide con cualquier carácter de espacio en blanco; esto es equivalente a la clase @code{[ \t\n\r\f\v]}.

@item @code{\S}

Coincide con cualquier carácter que no sea un espacio en blanco; esto es equivalente a la clase @code{[^ \t\n\r\f\v]}.

@item @code{\w}

Coincide con cualquier carácter alfanumérico; esto es equivalente a la clase @code{[a-zA-Z0-9_]}.

@item @code{\W}

Coincide con cualquier carácter no alfanumérico; esto es equivalente a la clase @code{[^a-zA-Z0-9_]}.
@end table

Estas secuencias se pueden incluir dentro de una clase de carácter. Por ejemplo, @code{[\s,.]} es una clase de carácter que coincidirá con cualquier carácter de espacio en blanco, o @code{','} o @code{'.'}.

El metacarácter final en esta sección es @code{.}. Coincide con cualquier cosa excepto un carácter de nueva línea, y hay un modo alternativo (@ref{22f0,,re.DOTALL}) donde coincidirá incluso con una nueva línea. @code{.} se usa a menudo cuando se desea hacer coincidir «cualquier carácter».

@node Repitiendo cosas,,Coincidencia de caracteres Matching Characters,Patrones simples
@anchor{howto/regex repeating-things}@anchor{4f05}
@subsubsection Repitiendo cosas


Ser capaz de hacer coincidir diferentes conjuntos de caracteres es lo primero que pueden hacer las expresiones regulares que ya no es posible con los métodos disponibles en cadenas de caracteres. Sin embargo, si esa fuera la única capacidad adicional de las expresiones regulares, no serían un gran avance. Otra capacidad es que puede especificar que partes de la RE deben repetirse un cierto número de veces.

El primer metacarácter para repetir cosas que veremos es @code{*}. @code{*} no coincide con el carácter literal @code{'*'}; en cambio, especifica que el carácter anterior puede coincidir cero o más veces, en lugar de exactamente una vez.

Por ejemplo, @code{ca*t} coincidirá con @code{'ct'} (0 @code{'a'} caracteres), @code{'cat'} (1 @code{'a'}), @code{'caaat'} (3 @code{'a'} caracteres), etc.

Las repeticiones como @code{*} son `greedy'; al repetir una RE, el motor de emparejamiento intentará repetirlo tantas veces como sea posible. Si las partes posteriores del patrón no coinciden, el motor de coincidencia hará una copia de seguridad y volverá a intentarlo con menos repeticiones.

Un ejemplo paso a paso hará que esto sea más obvio. Consideremos la expresión @code{a[bcd]*b}. Esto coincide con la letra @code{'a'}, cero o más letras de la clase @code{[bcd]}, y finalmente termina con una @code{'b'}. Ahora imagina hacer coincidir este RE con la cadena de caracteres @code{'abcbd'}.


@multitable {xxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Pasos

@tab

Coincidencias

@tab

Explicación

@item

1

@tab

@code{a}

@tab

La @code{a} en las RE coincide.

@item

2

@tab

@code{abcbd}

@tab

El motor coincide con @code{[bcd]*}, yendo tan lejos como puede, que es hasta el final de la cadena de caracteres.

@item

3

@tab

`Failure'

@tab

El motor intenta hacer coincidir @code{b}, pero la posición actual está al final de la cadena de caracteres, por lo que falla.

@item

4

@tab

@code{abcb}

@tab

Hace una copia de seguridad para que @code{[bcd]*} coincida con un carácter menos.

@item

5

@tab

`Failure'

@tab

Intente @code{b} de nuevo, pero la posición actual está en el último caracter, que es un @code{'d'}.

@item

6

@tab

@code{abc}

@tab

Haga una copia de seguridad de nuevo, de modo que @code{[bcd]*} solo coincida con @code{bc}.

@item

6

@tab

@code{abcb}

@tab

Intente @code{b} de nuevo. Esta vez, el carácter en la posición actual es @code{'b'}, por lo que tiene éxito.

@end multitable


Se ha alcanzado el final de la RE y ha coincidido con @code{'abcb'}. Esto demuestra cómo el motor de coincidencias llega tan lejos como puede al principio, y si no se encuentra ninguna coincidencia, retrocederá progresivamente y volverá a intentar de la RE una y otra vez. Hará una copia de seguridad hasta que haya probado cero coincidencias para @code{[bcd]*}, y si eso falla posteriormente, el motor concluirá que la cadena no coincide con la RE en absoluto.

Otro metacarácter que se repite es @code{+}, que coincide una o más veces. Preste especial atención a la diferencia entre @code{*} and @code{+}; coincide con `cero' o más veces, por lo que cualquier cosa que se repita puede no estar presente en absoluto, mientras que @code{+} requiere al menos `one' aparición. Para usar un ejemplo similar, @code{'cat'} (1 @code{'a'}), @code{'caaat'} (3 @code{'a'}s), pero no coincidirá con @code{'ct'}.

Hay otros dos operadores de repetición o cuantificadores.  El carácter de interrogación, @code{?}, coincide una vez o cero veces; puede pensar en ello como marcar algo como opcional.  Por ejemplo, @code{home-?brew} coincide con @code{'homebrew'} o @code{'home-brew'}.

El cuantificador más complicado es @code{@{m,n@}}, donde `m' y `n' son enteros decimales.  Este cuantificador significa que debe haber al menos `m' repeticiones y como máximo `n'.  Por ejemplo, @code{a/@{1,3@}b} coincidirá con @code{'a/b'}, @code{'a//b'}, y @code{'a///b'}.  No coincidirá con @code{'ab'}, que no tiene barras diagonales, ni con @code{'a////b'}, que tiene cuatro.

Puede omitir `m' o `n'; en ese caso, se asume un valor razonable para el valor faltante. Omitir `m' se interpreta como un límite inferior de 0, mientras que omitir `n' da como resultado un límite superior de infinito.

The simplest case @code{@{m@}} matches the preceding item exactly `m' times.
For example, @code{a/@{2@}b} will only match @code{'a//b'}.

Los lectores con una inclinación reduccionista pueden notar que los otros tres cuantificadores se pueden expresar todos utilizando esta notación.  @code{@{0,@}} es lo mismo que @code{*}, @code{@{1,@}} es equivalente a @code{+}, y @code{@{0,1@}} es lo mismo que @code{?}.  Es mejor usar @code{*}, @code{+}, o @code{?} cuando sea posible, simplemente porque son más cortos y más fáciles de leer.

@node Usando expresiones regulares,Más poder de patrones,Patrones simples,Expresiones regulares COMOS HOWTO
@anchor{howto/regex using-regular-expressions}@anchor{4f06}
@subsection Usando expresiones regulares


Ahora que hemos visto algunas expresiones regulares simples, ¿cómo las usamos realmente en Python? El módulo @ref{b9,,re} proporciona una interfaz para el motor de expresiones regulares, lo que le permite compilar RE en objetos y luego realizar coincidencias con ellos.

@menu
* Compilando expresiones regulares:: 
* La plaga de la barra invertida (The Backslash Plague): La plaga de la barra invertida The Backslash Plague. 
* Realizando coincidencias:: 
* Funciones a nivel de módulo: Funciones a nivel de módulo<2>. 
* Los flags de compilación:: 

@end menu

@node Compilando expresiones regulares,La plaga de la barra invertida The Backslash Plague,,Usando expresiones regulares
@anchor{howto/regex compiling-regular-expressions}@anchor{4f07}
@subsubsection Compilando expresiones regulares


Las expresiones regulares se compilan en objetos de patrón, que tienen métodos para diversas operaciones, como buscar coincidencias de patrones o realizar sustituciones de cadenas de caracteres.

@example
>>> import re
>>> p = re.compile('ab*')
>>> p
re.compile('ab*')
@end example

@ref{c5b,,re.compile()} también acepta un argumento opcional `flags', usado para habilitar varias características especiales y variaciones de sintaxis. Repasaremos las configuraciones disponibles más adelante, pero por ahora un solo ejemplo servirá:

@example
>>> p = re.compile('ab*', re.IGNORECASE)
@end example

La RE se pasa a @ref{c5b,,re.compile()} como una cadena de caracteres. Las RE se manejan como cadenas de caracteres porque las expresiones regulares no son parte del lenguaje central de Python y no se creó una sintaxis especial para expresarlas. (Hay aplicaciones que no necesitan RE en absoluto, por lo que no hay necesidad de aumentar la especificación del lenguaje incluyéndolas). En cambio, el módulo @ref{b9,,re} es simplemente un módulo de extensión C incluido en Python, al igual que los módulos @ref{cc,,socket} o @ref{132,,zlib}.

Poner RE en cadenas de caracteres mantiene el lenguaje Python más simple, pero tiene una desventaja que es el tema de la siguiente sección.

@node La plaga de la barra invertida The Backslash Plague,Realizando coincidencias,Compilando expresiones regulares,Usando expresiones regulares
@anchor{howto/regex id1}@anchor{4f08}@anchor{howto/regex the-backslash-plague}@anchor{4f09}
@subsubsection La plaga de la barra invertida (`The Backslash Plague')


Como se indicó anteriormente, las expresiones regulares usan el carácter de barra invertida (@code{'\'}) para indicar formas especiales o para permitir que se usen caracteres especiales sin invocar su significado especial. Esto entra en conflicto con el uso de Python del mismo carácter para el mismo propósito en cadenas literales.

Supongamos que desea escribir una RE que coincida con la cadena de caracteres @code{\section}, que podría encontrarse en un archivo LaTeX. Para averiguar qué escribir en el código del programa, comience con la cadena deseada para que coincida. A continuación, debe escapar de las barras invertidas y otros metacaracteres precediéndolos con una barra invertida, lo que da como resultado la cadena @code{\\section}. La cadena resultante que debe pasarse a @ref{c5b,,re.compile()} debe ser @code{\\section}. Sin embargo, para expresar esto como una cadena literal de Python, ambas barras invertidas deben escaparse `nuevamente'.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caracteres

@tab

Explicación

@item

@code{\section}

@tab

Cadena de texto que debe coincidir

@item

@code{\\section}

@tab

Barra invertida de escape para @ref{c5b,,re.compile()}

@item

@code{"\\\\section"}

@tab

Barra invertida de escape para un literal de cadena de caracteres

@end multitable


En resumen, para hacer coincidir una barra invertida literal, uno tiene que escribir @code{'\\\\'} como la cadena RE, porque la expresión regular debe ser @code{\\}, y cada barra invertida debe expresarse como @code{\\} dentro de un literal de cadena Python normal. En las RE que presentan barras invertidas repetidamente, esto genera muchas barras invertidas repetidas y dificulta la comprensión de las cadenas resultantes.

La solución es utilizar la notación de cadena de caracteres sin formato de Python para expresiones regulares; las barras invertidas no se manejan de ninguna manera especial en una cadena literal con el prefijo @code{'r'}, por lo que @code{r"\n"} es una cadena de dos caracteres que contiene @code{'\'} y @code{'n'}, mientras que @code{"\n"} es una cadena de un carácter que contiene una nueva línea. Las expresiones regulares a menudo se escribirán en código Python utilizando esta notación de cadena sin formato.

Además, las secuencias de escape especiales que son válidas en expresiones regulares, pero no válidas como literales de cadena de Python, ahora dan como resultado @ref{1da,,DeprecationWarning} y eventualmente se convertirán en @ref{150,,SyntaxError}, lo que significa que las secuencias no serán válidas. si no se utiliza la notación de cadena sin formato o el escape de las barras invertidas.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

Cadena de caracteres regulares

@tab

Cadena de caracteres crudas (`Raw string')

@item

@code{"ab*"}

@tab

@code{r"ab*"}

@item

@code{"\\\\section"}

@tab

@code{r"\\section"}

@item

@code{"\\w+\\s+\\1"}

@tab

@code{r"\w+\s+\1"}

@end multitable


@node Realizando coincidencias,Funciones a nivel de módulo<2>,La plaga de la barra invertida The Backslash Plague,Usando expresiones regulares
@anchor{howto/regex performing-matches}@anchor{4f0a}
@subsubsection Realizando coincidencias


Una vez que tiene un objeto que representa una expresión regular compilada, ¿qué hace con él? Los objetos de patrón tienen varios métodos y atributos. Aquí solo se cubrirán los más importantes; consulte los documentos @ref{b9,,re} para obtener una lista completa.


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/atributo

@tab

Objetivo

@item

@code{match()}

@tab

Determina si la RE coincide con el comienzo de la cadena de caracteres.

@item

@code{search()}

@tab

Escanea una cadena, buscando cualquier ubicación donde coincida este RE.

@item

@code{findall()}

@tab

Encuentra todas las subcadenas de caracteres donde coincide la RE y las retorna como una lista.

@item

@code{finditer()}

@tab

Encuentra todas las subcadenas donde la RE coincide y las retorna como un término iterado @ref{313,,iterator}.

@end multitable


@ref{2302,,match()} y @ref{2303,,search()} retornan @code{None} si la coincidencia no puede ser encontrada. Si tienen éxito, se retorna una instancia @ref{1006,,match object}, que contiene información sobre la coincidencia: dónde comienza y termina, la subcadena de caracteres con la que coincidió, y más.

Puedes aprender sobre esto experimentando de forma interactiva con el módulo @ref{b9,,re}.

Este CÓMO (`HOWTO') utiliza el intérprete estándar de Python para sus ejemplos. Primero, ejecute el intérprete de Python, importe el módulo @ref{b9,,re} y compile en RE:

@example
>>> import re
>>> p = re.compile('[a-z]+')
>>> p
re.compile('[a-z]+')
@end example

Ahora, puede intentar hacer coincidir varias cadenas con la RE @code{[a-z]+}. Una cadena de caracteres vacía no debería coincidir en absoluto, ya que @code{+} significa que “una o más repeticiones”. @ref{2302,,match()} debería retornar @code{None} en este caso, lo que hará que el intérprete no imprima ningún resultado. Puede imprimir explícitamente el resultado de @code{match()} para aclarar esto.

@example
>>> p.match("")
>>> print(p.match(""))
None
@end example

Ahora, intentémoslo en una cadena de caracteres que debería coincidir, como @code{tempo}.En este caso , @ref{2302,,match()} retornará un @ref{1006,,match object}, por lo que debe almacenar el resultado en una variable para su posterior uso.

@example
>>> m = p.match('tempo')
>>> m
<re.Match object; span=(0, 5), match='tempo'>
@end example

Ahora puede consultar @ref{1006,,match object} para obtener información sobre la cadena coincidente. Las instancias de objetos coincidentes también tienen varios métodos y atributos; los más importantes son:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/atributo

@tab

Objetivo

@item

@code{group()}

@tab

Retorna la cadena de caracteres que coincide con la RE

@item

@code{start()}

@tab

Retorna la posición de inicio de la coincidencia

@item

@code{end()}

@tab

Retorna la posición final de la coincidencia

@item

@code{span()}

@tab

Retorna una tupla que contiene (inicio, final) las posiciones de coincidencia

@end multitable


Probando estos métodos pronto aclarará sus significados:

@example
>>> m.group()
'tempo'
>>> m.start(), m.end()
(0, 5)
>>> m.span()
(0, 5)
@end example

@ref{2318,,group()} retorna la subcadena de caracteres que coincide con la RE. @ref{231c,,start()} y @ref{231d,,end()} retornan el índice inicial y final de la coincidencia. @ref{231e,,span()} retorna el índice inicial y final en una única tupla. Dado que el método @ref{2302,,match()} solo verifica si la RE coincide al comienzo de una cadena de caracteres, @code{start()} siempre será cero. Sin embargo, el método de patrones @ref{2303,,search()} escanea a través de la cadena de caracteres, por lo que es posible que la coincidencia no comience en cero en ese caso.

@example
>>> print(p.match('::: message'))
None
>>> m = p.search('::: message'); print(m)
<re.Match object; span=(4, 11), match='message'>
>>> m.group()
'message'
>>> m.span()
(4, 11)
@end example

En programas reales, el estilo más común es almacenar @ref{1006,,match object} en una variable, y luego verificar si era @code{None}. Esto generalmente se ve así:

@example
p = re.compile( ... )
m = p.match( 'string goes here' )
if m:
    print('Match found: ', m.group())
else:
    print('No match')
@end example

Dos métodos de patrón retornan todas las coincidencias de un patrón. @ref{230e,,findall()} retorna una lista de cadenas de caracteres coincidentes:

@example
>>> p = re.compile(r'\d+')
>>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping')
['12', '11', '10']
@end example

El prefijo @code{r}, que convierte al literal en una cadena de caracteres literal sin formato, es necesario en este ejemplo porque las secuencias de escape en un cadena de caracteres literal «cocinado» normal que no son reconocidas por Python, a diferencia de las expresiones regulares, ahora dan como resultado @ref{1da,,DeprecationWarning} y eventualmente se convertirá en @ref{150,,SyntaxError}. Ver @ref{4f09,,La plaga de la barra invertida (The Backslash Plague)}.

@ref{230e,,findall()} tiene que crear la lista completa antes de que pueda retornarse como resultado. El método @ref{230f,,finditer()} retorna una secuencia de @ref{1006,,match object} instancias como iterados @ref{313,,iterator}:

@example
>>> iterator = p.finditer('12 drummers drumming, 11 ... 10 ...')
>>> iterator  
<callable_iterator object at 0x...>
>>> for match in iterator:
...     print(match.span())
...
(0, 2)
(22, 24)
(29, 31)
@end example

@node Funciones a nivel de módulo<2>,Los flags de compilación,Realizando coincidencias,Usando expresiones regulares
@anchor{howto/regex module-level-functions}@anchor{4f0b}
@subsubsection Funciones a nivel de módulo


No es necesario crear un objeto patrón y llamar a sus métodos; el módulo @ref{b9,,re} también proporciona funciones de nivel superior llamadas @ref{129a,,match()} , @ref{1299,,search()} , @ref{10a6,,findall()} , @ref{3f2,,sub()}, y así sucesivamente. Estas funciones toman los mismos argumentos que el método de patrón correspondiente con la cadena de RE agregada como primer argumento, y aún así retornan una instancia de @code{None} o @ref{1006,,match object}.

@example
>>> print(re.match(r'From\s+', 'Fromage amk'))
None
>>> re.match(r'From\s+', 'From amk Thu May 14 19:12:10 1998')  
<re.Match object; span=(0, 5), match='From '>
@end example

Bajo el capó (`hood'), estas funciones simplemente crean un objeto patrón para usted y llaman al método apropiado en él. También almacenan el objeto compilado en un caché, por lo que las futuras llamadas que usen el mismo RE no necesitarán analizar el patrón una y otra vez.

¿Debería utilizar estas funciones a nivel de módulo o debería obtener el patrón y llamar a sus métodos usted mismo? Si está accediendo a una expresión regular dentro de un bucle, la compilación previa guardará algunas llamadas a funciones. Fuera de los bucles, no hay mucha diferencia gracias al caché interno.

@node Los flags de compilación,,Funciones a nivel de módulo<2>,Usando expresiones regulares
@anchor{howto/regex compilation-flags}@anchor{4f0c}
@subsubsection Los flags de compilación


Las flags de compilación le permiten modificar algunos aspectos de cómo funcionan las expresiones regulares. Las flags están disponibles en el módulo @ref{b9,,re} con dos nombres, un nombre largo como @ref{172c,,IGNORECASE} y una forma corta de una letra como @ref{22f4,,I}. (Si está familiarizado con los modificadores de patrones de Perl, las formas de una letra usan las mismas letras; la forma corta de @ref{2300,,re.VERBOSE} es @ref{22f9,,re.X}, por ejemplo).Se pueden especificar varios indicadores uniéndolos con `OR' bit a bit; @code{re.I | re.M} establece los flags @ref{22f4,,I} and @ref{22f6,,M}, por ejemplo.

Aquí hay una tabla de las flags disponibles, seguida de una explicación más detallada de cada una.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Flag

@tab

Significado

@item

@ref{6cd,,ASCII}, @ref{22f3,,A}

@tab

Hace que varios escapes como @code{\w}, @code{\b}, @code{\s} y @code{\d} coincidan solo en caracteres ASCII con la propiedad respectiva.

@item

@ref{22f0,,DOTALL}, @ref{22f7,,S}

@tab

Hace que @code{.} coincida con cualquier caracter, incluidas las nuevas líneas.

@item

@ref{172c,,IGNORECASE}, @ref{22f4,,I}

@tab

Hace coincidencias que no distingan entre mayúsculas y minúsculas.

@item

@ref{bf4,,LOCALE}, @ref{22f5,,L}

@tab

Hace una coincidencia con reconocimiento de configuración regional.

@item

@ref{22f1,,MULTILINE}, @ref{22f6,,M}

@tab

Coincidencia de varias líneas, que afecta a @code{^} y @code{$}.

@item

@ref{2300,,VERBOSE}, @ref{22f9,,X}
(for “extended”)

@tab

Habilite RE detallados, que se pueden organizar de manera más limpia y comprensible.

@end multitable



@deffn {Dato} re.I

@deffnx {Dato} re.IGNORECASE

Realiza una coincidencia que no distinga entre mayúsculas y minúsculas; la clase de caracteres y las cadenas de caracteres literales coincidirán con las letras ignorando las mayúsculas. Por ejemplo, @code{[A-Z]} también coincidirá con letras minúsculas. La coincidencia completa de Unicode también funciona a menos que se utilice la flag @ref{6cd,,ASCII} para deshabilitar las coincidencias que no sean ASCII. Cuando los patrones Unicode @code{[a-z]} o @code{[A-Z]} se utilizan en combinación con el indicador @ref{172c,,IGNORECASE} , coincidirán con las 52 letras ASCII y 4 letras adicionales no ASCII “İ” (U+0130, letra mayúscula latina I con un punto arriba), “ı” (U+0131, letra minúscula latina sin punto i),”ſ” (U+017F, letra minúscula latina larga s) y “K” (U+212A, signo de Kelvin). @code{Spam} coincidirá @code{'Spam'}, @code{'spam'}, @code{'spAM'}, o @code{'ſpam'} (este último solo coincide en modo Unicode). Estas minúsculas no tiene en cuenta la configuración regional actual; lo hará si también establece la flag @ref{bf4,,LOCALE} .
@end deffn


@deffn {Dato} re.L

@deffnx {Dato} re.LOCALE

Hace que @code{\w}, @code{\W}, @code{\b}, @code{\B} y la coincidencia que no distinga entre mayúsculas y minúsculas dependan de la configuración regional actual en lugar de la base de datos Unicode.

Las configuraciones regionales son una característica de la biblioteca C destinada a ayudar a escribir programas que tengan en cuenta las diferencias de idioma. Por ejemplo, si está procesando texto en francés codificado, querrá poder escribir @code{\w+} para que coincida con las palabras, pero @code{\w} solo coincide con la clase de caracteres @code{[A-Za-z]} en patrones de bytes; no coincidirá con los bytes correspondientes a @code{é} or @code{ç}. Si su sistema está configurado correctamente y se selecciona una configuración regional francesa, ciertas funciones de C le dirán al programa que el byte correspondiente a @code{é} también debe considerarse una letra. Establecer el indicador @ref{bf4,,LOCALE} al compilar una expresión regular hará que el objeto compilado resultante use estas funciones C para @code{\w}; esto es más lento, pero también permite que @code{\w+} coincida con las palabras en francés como era de esperar. Se desaconseja el uso de esta flag en Python 3 ya que el mecanismo de configuración regional es muy poco confiable, solo maneja una «cultura» a la vez y solo funciona con configuraciones regionales de 8 bits. La coincidencia Unicode ya está habilitada de forma predeterminada en Python 3 para patrones Unicode (str), y puede manejar diferentes configuraciones regionales/idiomas.
@end deffn


@deffn {Dato} re.M

@deffnx {Dato} re.MULTILINE

(@code{^} y @code{$} aún no se han explicado; se presentarán en la sección @ref{4f0d,,Más metacaracteres}.)

Por lo general, @code{^} coincide solo al principio de la cadena de caracteres, y @code{$} solo coincide con el final de la cadena de caracteres e inmediatamente antes del salto de línea (si existe) al final de la cadena de caracteres. Cuando se especifica esta bandera, @code{^} coincide al principio de la cadena y al comienzo de cada línea dentro de la cadena, inmediatamente después de cada nueva línea. De manera similar, el metacarácter @code{$} coincide al final de la cadena de caracteres y al final de cada línea (inmediatamente antes de cada nueva línea).
@end deffn


@deffn {Dato} re.S

@deffnx {Dato} re.DOTALL

Hace que el carácter especial @code{'.'} coincida con cualquier carácter, incluida una nueva línea; sin esta bandera, @code{'.'} coincidirá con cualquier cosa `except' una nueva línea.
@end deffn


@deffn {Dato} re.A

@deffnx {Dato} re.ASCII

Haga que @code{\w}, @code{\W}, @code{\b}, @code{\B}, @code{\s} y @code{\S} realicen una coincidencia solo en ASCII en lugar de una coincidencia Unicode completa. Esto solo es significativo para los patrones Unicode y se ignora para los patrones de bytes.
@end deffn


@deffn {Dato} re.X

@deffnx {Dato} re.VERBOSE

Esta flag le permite escribir expresiones regulares que son más legibles al otorgarle más flexibilidad en cómo puede formatearlas. Cuando se ha especificado esta flag, los espacios en blanco dentro de la cadena de caracteres de la RE se ignoran, excepto cuando el espacio en blanco está en una clase de caracteres o está precedido por una barra invertida sin escape; esto le permite organizar e indentar la RE más claramente. Esta flag también le permite poner comentarios dentro de una RE que serán ignorados por el motor (`engine'); los comentarios están marcados con un @code{'#'} que no está en una clase de carácter ni está precedido por una barra invertida sin escape.

Por ejemplo, aquí hay una RE que usa @ref{2300,,re.VERBOSE}; ¿Ves lo fácil que es leer?

@example
charref = re.compile(r"""
 &[#]                # Start of a numeric entity reference
 (
     0[0-7]+         # Octal form
   | [0-9]+          # Decimal form
   | x[0-9a-fA-F]+   # Hexadecimal form
 )
 ;                   # Trailing semicolon
""", re.VERBOSE)
@end example

Sin la configuración detallada, la RE se vería así:

@example
charref = re.compile("&#(0[0-7]+"
                     "|[0-9]+"
                     "|x[0-9a-fA-F]+);")
@end example

En el ejemplo anterior, la concatenación automática de cadenas de caracteres literales de Python se ha utilizado para dividir la RE en partes más pequeñas, pero aún es más difícil de entender que la versión que usa @ref{2300,,re.VERBOSE}.
@end deffn

@node Más poder de patrones,Modificando cadenas de caracteres,Usando expresiones regulares,Expresiones regulares COMOS HOWTO
@anchor{howto/regex more-pattern-power}@anchor{4f0e}
@subsection Más poder de patrones


Hasta ahora solo hemos cubierto una parte de las características de las expresiones regulares. En esta sección, cubriremos algunos metacaracteres nuevos y cómo usar grupos para recuperar partes del texto que coincidió.

@menu
* Más metacaracteres:: 
* Agrupando:: 
* Grupos con nombre y sin captura:: 
* Aserciones anticipadas:: 

@end menu

@node Más metacaracteres,Agrupando,,Más poder de patrones
@anchor{howto/regex id2}@anchor{4f0f}@anchor{howto/regex more-metacharacters}@anchor{4f0d}
@subsubsection Más metacaracteres


Hay algunos metacaracteres que aún no hemos cubierto. La mayoría de ellos se tratarán en esta sección.

Algunos de los metacaracteres restantes que se discutirán son `zero-width assertions'. No hacen que el motor avance a través de la cadena de caracteres; en cambio, no consumen caracteres en absoluto y simplemente tienen éxito o fracasan. Por ejemplo, @code{\b} es una flag de que la posición actual se encuentra en el límite de una palabra; la posición no cambia por la @code{\b} en absoluto. Esto significa que las aserciones de ancho cero nunca deben repetirse, porque si coinciden una vez en una ubicación determinada, obviamente pueden coincidir un número infinito de veces.


@table @asis

@item @code{|}

Alternancia, o el operador «or». Si `A' y `B' son expresiones regulares, @code{A|B} coincidirá con cualquier cadena de caracteres que coincida con `A' o `B'. @code{|} tiene una precedencia muy baja para que funcione razonablemente cuando está alternando cadenas de varios caracteres. @code{Crow|Servo} coincidirá con @code{'Crow'} o @code{'Servo'}, no @code{'Cro'}, un @code{'w'} o un @code{'S'}, y @code{'ervo'}.

Para hacer coincidir un literal @code{'|'}, use @code{\|}, o enciérrelo dentro de una clase de carácter, como en @code{[|]}.

@item @code{^}

Coincide con el comienzo de las líneas. A menos que se haya establecido la flag @ref{22f1,,MULTILINE} , esto solo coincidirá al principio de la cadena de caracteres. En modo @ref{22f1,,MULTILINE} , esto también coincide inmediatamente después de cada nueva línea dentro de la cadena.

Por ejemplo, si desea hacer coincidir la palabra @code{From} solo al principio de una línea, la RE que debe usar es @code{^From}.

@example
>>> print(re.search('^From', 'From Here to Eternity'))  
<re.Match object; span=(0, 4), match='From'>
>>> print(re.search('^From', 'Reciting From Memory'))
None
@end example

Para una coincidencia literal @code{'^'}, usar @code{\^}.

@item @code{$}

Coincide con el final de una línea, que se define como el final de la cadena o cualquier ubicación seguida de un carácter de nueva línea.

@example
>>> print(re.search('@}$', '@{block@}'))  
<re.Match object; span=(6, 7), match='@}'>
>>> print(re.search('@}$', '@{block@} '))
None
>>> print(re.search('@}$', '@{block@}\n'))  
<re.Match object; span=(6, 7), match='@}'>
@end example

Para hacer coincidir un literal @code{'$'}, usar @code{\$} o enciérrelo dentro de una clase de carácter, como en @code{[$]}.

@item @code{\A}

Coincide solo al comienzo de la cadena de caracteres. Cuando no está en el modo @ref{22f1,,MULTILINE},`@w{`}A`@w{`} y @code{^} son efectivamente lo mismo. En el modo @ref{22f1,,MULTILINE}, son diferentes: @code{\A} todavía coincide solo al principio de la cadena, pero @code{^} puede coincidir en cualquier ubicación dentro de la cadena de caracteres que sigue a un carácter de nueva línea.

@item @code{\Z}

Coincidencias solo al final de la cadena de caracteres.

@item @code{\b}

Límite de palabra. Esta es una aserción de ancho cero que coincide solo al principio o al final de una palabra. Una palabra se define como una secuencia de caracteres alfanuméricos, por lo que el final de una palabra se indica mediante un espacio en blanco o un carácter no alfanumérico.

El siguiente ejemplo coincide con @code{class} solo cuando es una palabra completa; no coincidirá cuando esté contenido dentro de otra palabra.

@example
>>> p = re.compile(r'\bclass\b')
>>> print(p.search('no class at all'))
<re.Match object; span=(3, 8), match='class'>
>>> print(p.search('the declassified algorithm'))
None
>>> print(p.search('one subclass is'))
None
@end example

Hay dos sutilezas que debe recordar al usar esta secuencia especial. Primero, esta es la peor colisión entre las cadenas literales de caracteres de Python y las secuencias de expresiones regulares. En las cadenas de caracteres literales de Python, @code{\b} es el carácter de retroceso (`backspace'), valor ASCII 8. Si no está utilizando cadenas de caracteres sin procesar, Python convertirá la @code{\b} en una linea de retroceso, y su RE no lo hará coincidir como lo espera. El siguiente ejemplo tiene el mismo aspecto que nuestra RE anterior, pero omite la @code{'r'} delante de la cadena de caracteres de RE.

@example
>>> p = re.compile('\bclass\b')
>>> print(p.search('no class at all'))
None
>>> print(p.search('\b' + 'class' + '\b'))
<re.Match object; span=(0, 7), match='\x08class\x08'>
@end example

En segundo lugar, dentro de una clase de caracteres, donde no hay uso para esta aserción, @code{\b} representa el carácter de retroceso, por compatibilidad con las cadenas de caracteres literales de Python.

@item @code{\B}

Otra flag de ancho cero, esto es lo opuesto a @code{\b}, solo coincide cuando la posición actual no está en el límite de una palabra.
@end table

@node Agrupando,Grupos con nombre y sin captura,Más metacaracteres,Más poder de patrones
@anchor{howto/regex grouping}@anchor{4f10}
@subsubsection Agrupando


Con frecuencia, necesita obtener más información que solo si la RE coincide o no. Las expresiones regulares se utilizan a menudo para diseccionar cadenas de caracteres escribiendo una RE dividido en varios subgrupos que coinciden con diferentes componentes de interés. Por ejemplo, una línea de encabezado RFC-822 se divide en un nombre de encabezado y un valor, separados por un @code{':'}, así:

@example
From: author@@example.com
User-Agent: Thunderbird 1.5.0.9 (X11/20061227)
MIME-Version: 1.0
To: editor@@example.com
@end example

Esto se puede manejar escribiendo una expresión regular que coincida con una línea de encabezado completa y que tenga un grupo que coincida con el nombre del encabezado y otro grupo que coincida con el valor del encabezado.

Los grupos se marcan con los metacaracteres @code{'('} y @code{')'}. @code{'('} y @code{')'} tienen prácticamente el mismo significado que en las expresiones matemáticas; agrupan las expresiones contenidas dentro de ellos, y puedes repetir el contenido de un grupo con un cuantificador, como @code{*}, @code{+}, @code{?}, o @code{@{m,n@}}.  Por ejemplo, @code{(ab)*} coincidirá con cero o más repeticiones de @code{ab}.

@example
>>> p = re.compile('(ab)*')
>>> print(p.match('ababababab').span())
(0, 10)
@end example

Los grupos indicados con @code{'('}, @code{')'} también capturan el índice inicial y final del texto que coinciden; esto se puede recuperar pasando un argumento a @ref{2318,,group()}, @ref{231c,,start()}, @ref{231d,,end()}, y @ref{231e,,span()}. Los grupos se numeran empezando por 0. El grupo 0 siempre está presente; es todo las RE, entonces todos los métodos @ref{1006,,match object} tienen el grupo 0 como argumento predeterminado. Más adelante veremos cómo expresar grupos que no capturan el espacio de texto que coinciden.

@example
>>> p = re.compile('(a)b')
>>> m = p.match('ab')
>>> m.group()
'ab'
>>> m.group(0)
'ab'
@end example

Los subgrupos están numerados de izquierda a derecha, de 1 en adelante. Los grupos se pueden anidar; para determinar el número, simplemente cuente los caracteres del paréntesis de apertura, de izquierda a derecha.

@example
>>> p = re.compile('(a(b)c)d')
>>> m = p.match('abcd')
>>> m.group(0)
'abcd'
>>> m.group(1)
'abc'
>>> m.group(2)
'b'
@end example

@ref{2318,,group()} se pueden pasar varios números de grupo a la vez, en cuyo caso retornará una tupla que contiene los valores correspondientes para esos grupos.

@example
>>> m.group(2,1,2)
('b', 'abc', 'b')
@end example

El método @ref{231a,,groups()} retorna una tupla que contiene las cadenas de caracteres de todos los subgrupos, desde 1 hasta la cantidad que haya.

@example
>>> m.groups()
('abc', 'b')
@end example

Las referencias inversas en un patrón le permiten especificar que el contenido de un grupo de captura anterior también debe encontrarse en la ubicación actual en la cadena. Por ejemplo,`@w{`}1`@w{`} tendrá éxito si el contenido exacto del grupo 1 se puede encontrar en la posición actual y falla en caso contrario. Recuerde que las cadenas de caracteres literales de Python también usan una barra invertida seguida de números para permitir la inclusión de caracteres arbitrarios en una cadena de caracteres, así que asegúrese de usar una cadena de caracteres sin procesar al incorporar referencias inversas en una RE.

Por ejemplo, la siguiente RE detecta palabras duplicadas en una cadena.

@example
>>> p = re.compile(r'\b(\w+)\s+\1\b')
>>> p.search('Paris in the the spring').group()
'the the'
@end example

Las referencias inversas como esta no suelen ser útiles para buscar a través de una cadena — hay pocos formatos de texto que repiten datos de esta manera — pero pronto descubrirá que son `muy' útiles al realizar sustituciones de cadenas de caracteres.

@node Grupos con nombre y sin captura,Aserciones anticipadas,Agrupando,Más poder de patrones
@anchor{howto/regex non-capturing-and-named-groups}@anchor{4f11}
@subsubsection Grupos con nombre y sin captura


Las RE elaboradas pueden utilizar muchos grupos, tanto para capturar subcadenas de caracteres de interés como para agrupar y estructurar la propia RE. En las RE complejas, resulta difícil realizar un seguimiento de los números de los grupos. Hay dos funciones que ayudan con este problema. Ambos usan una sintaxis común para las extensiones de expresiones regulares, así que veremos eso primero.

Perl 5 es bien conocido por sus poderosas adiciones a las expresiones regulares estándar. Para estas nuevas características, los desarrolladores de Perl no podían elegir nuevos metacaracteres de una sola pulsación de tecla o nuevas secuencias especiales que comienzan con @code{\} sin hacer que las expresiones regulares de Perl sean confusamente diferentes de las RE estándar. Si eligieran @code{&} como un nuevo metacarácter, por ejemplo, las expresiones antiguas supondrían que @code{&} era un carácter regular y no se habría escapado escribiendo @code{\&} o @code{[&]}.

La solución elegida por los desarrolladores de Perl fue utilizar @code{(?...)} como sintaxis de extensión. @code{?} inmediatamente después de un paréntesis había un error de sintaxis porque el @code{?} no tendría nada que repetir, por lo que esto no introdujo ningún problema de compatibilidad. Los caracteres inmediatamente después de @code{?} Indican qué extensión se está utilizando, por lo que @code{(?=foo)} es una cosa (una flag de anticipación positiva) y @code{(?:foo)} es otra cosa (un grupo de no captura que contiene la subexpresión @code{foo}).

Python admite varias de las extensiones de Perl y agrega una sintaxis de extensión a la sintaxis de extensión de Perl. Si el primer carácter después del signo de interrogación es una @code{P}, sabrá que es una extensión específica de Python.

Ahora que hemos visto la sintaxis de la extensión general, podemos volver a las características que simplifican el trabajo con grupos en RE complejos.

A veces querrá usar un grupo para denotar una parte de una expresión regular, pero no está interesado en recuperar el contenido del grupo. Puede hacer que este hecho sea explícito utilizando un grupo de no captura: @code{(?:...)}, donde puede reemplazar el @code{...} con cualquier otra expresión regular.

@example
>>> m = re.match("([abc])+", "abc")
>>> m.groups()
('c',)
>>> m = re.match("(?:[abc])+", "abc")
>>> m.groups()
()
@end example

Excepto por el hecho de que no puede recuperar el contenido de lo que coincide con el grupo, un grupo que no captura se comporta exactamente igual que un grupo que captura; puede poner cualquier cosa dentro de él, repetirlo con un metacarácter de repetición como @code{*} y anidarlo dentro de otros grupos (capturando o no capturando). @code{(?:...)} es particularmente útil cuando se modifica un patrón existente, ya que puede agregar nuevos grupos sin cambiar cómo se numeran todos los demás grupos. Cabe mencionar que no hay diferencia de rendimiento en la búsqueda entre grupos de captura y no captura; ninguna forma es más rápida que la otra.

Una característica más significativa son los grupos nombrados: en lugar de referirse a ellos por números, los grupos pueden ser referenciados por un nombre.

La sintaxis de un grupo con nombre es una de las extensiones específicas de Python: @code{(?P<name>...)}.  `name' es, obviamente, el nombre del grupo. Los grupos con nombre se comportan exactamente como los grupos de captura y, además, asocian un nombre con un grupo. Los métodos @ref{1006,,match object} que tratan con la captura de grupos aceptan enteros que se refieren al grupo por número o cadenas de caracteres que contienen el nombre del grupo deseado. Los grupos con nombre todavía reciben números, por lo que puede recuperar información sobre un grupo de dos maneras:

@example
>>> p = re.compile(r'(?P<word>\b\w+\b)')
>>> m = p.search( '(((( Lots of punctuation )))' )
>>> m.group('word')
'Lots'
>>> m.group(1)
'Lots'
@end example

Además, puede recuperar grupos nombrados como un diccionario con @ref{231b,,groupdict()}:

@example
>>> m = re.match(r'(?P<first>\w+) (?P<last>\w+)', 'Jane Doe')
>>> m.groupdict()
@{'first': 'Jane', 'last': 'Doe'@}
@end example

Los grupos nombrados son útiles porque le permiten usar nombres fáciles de recordar en lugar de tener que recordar números.  Aquí hay un ejemplo de una RE del módulo @ref{74,,imaplib}:

@example
InternalDate = re.compile(r'INTERNALDATE "'
        r'(?P<day>[ 123][0-9])-(?P<mon>[A-Z][a-z][a-z])-'
        r'(?P<year>[0-9][0-9][0-9][0-9])'
        r' (?P<hour>[0-9][0-9]):(?P<min>[0-9][0-9]):(?P<sec>[0-9][0-9])'
        r' (?P<zonen>[-+])(?P<zoneh>[0-9][0-9])(?P<zonem>[0-9][0-9])'
        r'"')
@end example

Obviamente, es mucho más fácil recuperar @code{m.group('zonem')}, en lugar de tener que recordar recuperar el grupo 9.

La sintaxis de las referencias inversas en una expresión como @code{(...)\1} se refiere al número del grupo. Naturalmente, existe una variante que usa el nombre del grupo en lugar del número. Esta es otra extensión de Python: @code{(?P=name)} indica que el contenido del grupo llamado `name' debe coincidir nuevamente en el punto actual. La expresión regular para encontrar palabras duplicadas, @code{\b(\w+)\s+\1\b} también se puede escribir como @code{\b(?P<word>\w+)\s+(?P=word)\b}:

@example
>>> p = re.compile(r'\b(?P<word>\w+)\s+(?P=word)\b')
>>> p.search('Paris in the the spring').group()
'the the'
@end example

@node Aserciones anticipadas,,Grupos con nombre y sin captura,Más poder de patrones
@anchor{howto/regex lookahead-assertions}@anchor{4f12}
@subsubsection Aserciones anticipadas


Otra aserción de ancho cero es la aserción de anticipación. Las afirmaciones anticipadas están disponibles tanto en forma positiva como negativa, y tienen este aspecto:


@table @asis

@item @code{(?=...)}

Aserción de anticipación positiva. Esto tiene éxito si la expresión regular contenida, representada aquí por @code{...}, coincide con éxito en la ubicación actual y falla en caso contrario. Pero, una vez que se ha probado la expresión contenida, el motor de comparación no avanza en absoluto; el resto del patrón se intenta justo donde comenzó la aserción.

@item @code{(?!...)}

Aserción de anticipación negativa. Esto es lo opuesto a la flag positiva; tiene éxito si la expresión contenida `no' coincide con la posición actual en la cadena.
@end table

Para que esto sea concreto, veamos un caso en el que una búsqueda anticipada es útil. Considere un patrón simple para hacer coincidir un nombre de archivo y dividirlo en un nombre base y una extensión, separados por un @code{.}. Por ejemplo, en @code{news.rc}, @code{news} es el nombre base y @code{rc} es la extensión del nombre del archivo.

El patrón para que coincida con esto es bastante simple:

@code{.*[.].*$}

Tenga en cuenta que el @code{.} Debe tratarse especialmente porque es un metacarácter, por lo que está dentro de una clase de carácter para coincidir solo con ese carácter específico. También observe el final @code{$}; esto se agrega para garantizar que todo el resto de la cadena deba incluirse en la extensión. Esta expresión regular coincide con @code{foo.bar} y @code{autoexec.bat} y @code{sendmail.cf} y @code{printers.conf}.

Ahora, considere complicar un poco el problema; ¿Qué sucede si desea hacer coincidir los nombres de archivo donde la extensión no es @code{bat}? Algunos intentos incorrectos:

@code{.*[.][^b].*$} El primer intento anterior intenta excluir @code{bat} requiriendo que el primer carácter de la extensión no sea una @code{b}. Esto está mal, porque el patrón tampoco coincide @code{foo.bar}.

@code{.*[.]([^b]..|.[^a].|..[^t])$}

La expresión se vuelve más desordenada cuando intenta parchear la primera solución requiriendo que coincida uno de los siguientes casos: el primer carácter de la extensión no es @code{b}; el segundo carácter no es @code{a}; o el tercer carácter no es @code{t}. Esto acepta @code{foo.bar} y rechaza @code{autoexec.bat}, pero requiere una extensión de tres letras y no acepta un nombre de archivo con una extensión de dos letras como @code{sendmail.cf}. Complicaremos el patrón nuevamente en un esfuerzo por arreglarlo.

@code{.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$}

En el tercer intento, la segunda y tercera letras se hacen opcionales para permitir extensiones coincidentes de menos de tres caracteres, como @code{sendmail.cf}.

El patrón se está volviendo realmente complicado ahora, lo que dificulta su lectura y comprensión. Peor aún, si el problema cambia y desea excluir tanto @code{bat} y @code{exe} como extensiones, el patrón se volvería aún más complicado y confuso.

Una mirada anticipada negativa atraviesa toda esta confusión:

@code{.*[.](?!bat$)[^.]*$} La búsqueda anticipada negativa significa: si la expresión @code{bat} no coincide en este punto, pruebe el resto del patrón; si @code{bat$} coincide, todo el patrón fallará. El @code{$} final es necesario para garantizar que se permita algo como @code{sample.batch}, donde la extensión solo comienza con @code{bat}. El @code{[^.]*} asegura que el patrón funcione cuando hay varios puntos en el nombre del archivo.

Ahora es fácil excluir otra extensión de nombre de archivo; simplemente agréguelo como una alternativa dentro de la aserción. El siguiente patrón excluye los nombres de archivo que terminan en @code{bat} o @code{exe}:

@code{.*[.](?!bat$|exe$)[^.]*$}

@node Modificando cadenas de caracteres,Problemas comunes,Más poder de patrones,Expresiones regulares COMOS HOWTO
@anchor{howto/regex modifying-strings}@anchor{4f13}
@subsection Modificando cadenas de caracteres


Hasta este punto, simplemente hemos realizado búsquedas en una cadena de caracteres estática. Las expresiones regulares también se utilizan comúnmente para modificar cadenas de varias formas, utilizando los siguientes métodos de patrón:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/atributo

@tab

Objetivo

@item

@code{split()}

@tab

Divida la cadena de caracteres en una lista, dividiéndola donde coincida la RE

@item

@code{sub()}

@tab

Encuentra todas las subcadenas de caracteres donde coincida la RE y las reemplaza con una cadena de caracteres diferente

@item

@code{subn()}

@tab

Hace lo mismo que @code{sub()}, pero retorna la nueva cadena de caracteres y el número de reemplazos

@end multitable


@menu
* Separando cadenas de caracteres:: 
* Búsqueda y reemplazo:: 

@end menu

@node Separando cadenas de caracteres,Búsqueda y reemplazo,,Modificando cadenas de caracteres
@anchor{howto/regex splitting-strings}@anchor{4f14}
@subsubsection Separando cadenas de caracteres


El método @ref{230d,,split()} de un patrón que divide una cadena de caracteres donde la RE coincide, retornando una lista de las piezas. Es similar al método de cadenas de caracteres @ref{f2b,,split()} pero proporciona mucha más generalidad en los delimitadores por los que puede dividir; cadena de caracteres @code{split()} solo admite la división por espacios en blanco o por una cadena fija. Como era de esperar, también hay una función a nivel de módulo @ref{3f1,,re.split()}.


@deffn {Método} .split (string[, maxsplit=0])

Dividir `string' por las coincidencias de la expresión regular. Si se utilizan paréntesis de captura en la RE, su contenido también se retornará como parte de la lista resultante. Si `maxsplit' es distinto de cero, se realizan como máximo divisiones `maxsplit' .
@end deffn

Puede limitar el número de divisiones realizadas, pasando un valor para `maxsplit'. Cuando `maxsplit' es distinto de cero, se realizarán como máximo `maxsplit' divisiones, y el resto de la cadena de caracteres se retorna como el elemento final de la lista. En el siguiente ejemplo, el delimitador es cualquier secuencia de caracteres no alfanuméricos.

@example
>>> p = re.compile(r'\W+')
>>> p.split('This is a test, short and sweet, of split().')
['This', 'is', 'a', 'test', 'short', 'and', 'sweet', 'of', 'split', '@w{'}]
>>> p.split('This is a test, short and sweet, of split().', 3)
['This', 'is', 'a', 'test, short and sweet, of split().']
@end example

A veces, no solo le interesa cuál es el texto entre delimitadores, sino que también necesita saber cuál era el delimitador. Si se utilizan paréntesis de captura en la RE, sus valores también se retornan como parte de la lista. Compare las siguientes llamadas:

@example
>>> p = re.compile(r'\W+')
>>> p2 = re.compile(r'(\W+)')
>>> p.split('This... is a test.')
['This', 'is', 'a', 'test', '@w{'}]
>>> p2.split('This... is a test.')
['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', '@w{'}]
@end example

La función de nivel de módulo @ref{3f1,,re.split()} agrega la RE que se usará como primer argumento, pero por lo demás es el mismo.

@example
>>> re.split(r'[\W]+', 'Words, words, words.')
['Words', 'words', 'words', '@w{'}]
>>> re.split(r'([\W]+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '@w{'}]
>>> re.split(r'[\W]+', 'Words, words, words.', 1)
['Words', 'words, words.']
@end example

@node Búsqueda y reemplazo,,Separando cadenas de caracteres,Modificando cadenas de caracteres
@anchor{howto/regex search-and-replace}@anchor{4f15}
@subsubsection Búsqueda y reemplazo


Otra tarea común es encontrar todas las coincidencias para un patrón y reemplazarlas con una cadena de caracteres diferente. El método @ref{2310,,sub()} toma un valor de reemplazo, que puede ser una cadena de caracteres o una función, y la cadena de caracteres a procesar.


@deffn {Método} .sub (replacement, string[, count=0])

Retorna la cadena de caracteres obtenida al reemplazar las apariciones no superpuestas del extremo izquierdo de la RE en `string' por el reemplazo `replacement'. Si no se encuentra el patrón, el `string' se retorna sin cambios.

El argumento opcional `count' es el número máximo de ocurrencias de patrones que se reemplazarán; `count' debe ser un número entero no negativo. El valor predeterminado de 0 significa reemplazar todas las ocurrencias.
@end deffn

Aquí hay un ejemplo simple del uso del método @ref{2310,,sub()}. Reemplaza los nombres de los colores con la palabra @code{colour}:

@example
>>> p = re.compile('(blue|white|red)')
>>> p.sub('colour', 'blue socks and red shoes')
'colour socks and colour shoes'
>>> p.sub('colour', 'blue socks and red shoes', count=1)
'colour socks and red shoes'
@end example

El método @ref{2311,,subn()} hace el mismo trabajo, pero retorna una tupla de 2 que contiene el nuevo valor de cadena de caracteres y el número de reemplazos que se realizaron:

@example
>>> p = re.compile('(blue|white|red)')
>>> p.subn('colour', 'blue socks and red shoes')
('colour socks and colour shoes', 2)
>>> p.subn('colour', 'no colours at all')
('no colours at all', 0)
@end example

Las coincidencias vacías se reemplazan solo cuando no son adyacentes a una coincidencia vacía anterior.

@example
>>> p = re.compile('x*')
>>> p.sub('-', 'abxd')
'-a-b--d-'
@end example

Si `replacement' es una cadena, se procesan los escapes de barra invertida que contenga. Es decir, @code{\n} se convierte en un solo carácter de nueva línea, @code{\r} se convierte en una REtorno de carro, y así sucesivamente. Los escapes desconocidos como @code{\&} se dejan en paz. Las referencias inversas, como @code{\6}, se reemplazan con la subcadena de caracteres que coincide con el grupo correspondiente a la RE. Esto le permite incorporar partes del texto original en la cadena de reemplazo resultante.

Este ejemplo hace coincidir la palabra @code{section} seguida de una cadena encerrada entre @code{@{}, @code{@}}, y cambia @code{section} a @code{subsection}:

@example
>>> p = re.compile('section@{ ( [^@}]* ) @}', re.VERBOSE)
>>> p.sub(r'subsection@{\1@}','section@{First@} section@{second@}')
'subsection@{First@} subsection@{second@}'
@end example

También hay una sintaxis para hacer referencia a grupos con nombre según lo definido por la sintaxis @code{(?P<name>…)}. @code{\g<name>} usará la subcadena de caracteres que coincide con el grupo llamado @code{name}, y @code{\g<number>} usa el número de grupo correspondiente. @code{\g<2>} es equivalente a @code{\2}, pero no es ambiguo en una cadena de reemplazo como @code{\g<2>0}.  (@code{\20} se interpretaría como una referencia al grupo 20, no como una referencia al grupo 2 seguido del carácter literal @code{'0'}.) Las siguientes sustituciones son todas equivalentes, pero use las tres variaciones de la cadena de reemplazo.

@example
>>> p = re.compile('section@{ (?P<name> [^@}]* ) @}', re.VERBOSE)
>>> p.sub(r'subsection@{\1@}','section@{First@}')
'subsection@{First@}'
>>> p.sub(r'subsection@{\g<1>@}','section@{First@}')
'subsection@{First@}'
>>> p.sub(r'subsection@{\g<name>@}','section@{First@}')
'subsection@{First@}'
@end example

`replacement' también puede ser una función, lo que le brinda aún más control. Si `replacement' es una función, la función se llama para cada ocurrencia no superpuesta de `pattern'. En cada llamada, a la función se le pasa un argumento @ref{1006,,match object} para la coincidencia y puede usar esta información para calcular la cadena de reemplazo deseada y retornarla.

En el siguiente ejemplo, la función de reemplazo traduce decimales a hexadecimales:

@example
>>> def hexrepl(match):
...     "Return the hex string for a decimal number"
...     value = int(match.group())
...     return hex(value)
...
>>> p = re.compile(r'\d+')
>>> p.sub(hexrepl, 'Call 65490 for printing, 49152 for user code.')
'Call 0xffd2 for printing, 0xc000 for user code.'
@end example

Cuando se usa la función `module-level' @ref{3f2,,re.sub()}, el patrón se pasa como primer argumento. El patrón puede proporcionarse como un objeto o como una cuerda; Si necesita especificar marcas de expresión regular, debe usar un objeto de patrón como primer parámetro o usar modificadores incrustados en la cadena de patrón, por ejemplo @code{sub("(?i)b+", "x", "bbbb BBBB")} retorna @code{'x x'}.

@node Problemas comunes,Feedback,Modificando cadenas de caracteres,Expresiones regulares COMOS HOWTO
@anchor{howto/regex common-problems}@anchor{4f16}
@subsection Problemas comunes


Las expresiones regulares son una herramienta poderosa para algunas aplicaciones, pero de alguna manera su comportamiento no es intuitivo y, a veces, no se comportan de la forma esperada. Esta sección señalará algunos de los errores más comunes.

@menu
* Uso de métodos de cadenas de caracteres:: 
* match() versus search(): match versus search. 
* Codiciosa versus no codiciosa (Greedy versus Non-Greedy): Codiciosa versus no codiciosa Greedy versus Non-Greedy. 
* Usando re.VERBOSE: Usando re VERBOSE. 

@end menu

@node Uso de métodos de cadenas de caracteres,match versus search,,Problemas comunes
@anchor{howto/regex use-string-methods}@anchor{4f17}
@subsubsection Uso de métodos de cadenas de caracteres


A veces, usar el módulo @ref{b9,,re} es un error. Si está haciendo coincidir una cadena de caracteres fija, o una clase de un solo caracter, y no está usando ninguna característica @ref{b9,,re} como la marca @ref{172c,,IGNORECASE}, entonces todo el poder de las expresiones regulares puede que no sea necesario. Las cadenas tienen varios métodos para realizar operaciones con cadenas fijas y, por lo general, son mucho más rápidas, porque la implementación es un único bucle C pequeño que se ha optimizado para este propósito, en lugar del motor de expresión regular más grande y generalizado.

Un ejemplo podría ser reemplazar una sola cadena fija por otra; por ejemplo, puede reemplazar @code{word} por @code{deed}. @ref{3f2,,re.sub()} parece la función a utilizar para esto, pero considere el método @ref{302,,replace()}. Tenga en cuenta que @code{replace()} también reemplazará @code{word} dentro de las palabras, convirtiendo @code{swordfish} en @code{sdeedfish}, pero la RE naíf @code{word} también lo habría hecho. (Para evitar realizar la sustitución en partes de palabras, el patrón tendría que ser @code{\bword\b}, para requerir que @code{word} tenga un límite de palabra en cada lado. Esto lleva el trabajo más allá de las habilidades de @code{replace()}.)

Otra tarea común es eliminar cada aparición de un solo carácter de una cadena o reemplazarlo con otro solo carácter. Puede hacer esto con algo como @code{re.sub('\n', ' ', S)}, pero @ref{21d1,,translate()} es capaz de realizar ambas tareas y será más rápido que cualquier expresión regular la operación puede ser.

En resumen, antes de pasar al módulo @ref{b9,,re}, considere si su problema puede resolverse con un método de cadena de caracteres más rápido y simple.

@node match versus search,Codiciosa versus no codiciosa Greedy versus Non-Greedy,Uso de métodos de cadenas de caracteres,Problemas comunes
@anchor{howto/regex match-versus-search}@anchor{4f18}
@subsubsection `match() versus search()'


La función @ref{129a,,match()} solo verifica si la RE coincide con el comienzo de la cadena de caracteres, mientras que @ref{1299,,search()} buscará una coincidencia en la cadena de caracteres. Es importante tener en cuenta esta distinción. Recuerde @code{match()} solo informará una coincidencia exitosa que comenzará en 0; si la coincidencia no comienza en cero, @code{match()} `no' lo informará.

@example
>>> print(re.match('super', 'superstition').span())
(0, 5)
>>> print(re.match('super', 'insuperable'))
None
@end example

Por otro lado, @ref{1299,,search()} escaneará hacia adelante a través de la cadena de caracteres, informando la primera coincidencia que encuentre.

@example
>>> print(re.search('super', 'superstition').span())
(0, 5)
>>> print(re.search('super', 'insuperable').span())
(2, 7)
@end example

A veces, tendrá la tentación de seguir usando @ref{129a,,re.match()}, y simplemente agregar @code{.*} al frente de su RE. Resista esta tentación y use @ref{1299,,re.search()} en su lugar. El compilador de expresiones regulares realiza un análisis de las RE para acelerar el proceso de búsqueda de coincidencias. Uno de esos análisis determina cuál debe ser el primer carácter de una coincidencia; por ejemplo, un patrón que comienza con @code{Crow} debe coincidir con una @code{'C'}.El análisis permite que el motor escanee rápidamente a través de la cadena en busca del carácter inicial, solo probando la coincidencia completa si se encuentra una @code{'C'}.

Agregar @code{.*} anula esta optimización, lo que requiere escanear hasta el final de la cadena y luego retroceder para encontrar una coincidencia para el resto de la RE. Utilice @ref{1299,,re.search()} en su lugar.

@node Codiciosa versus no codiciosa Greedy versus Non-Greedy,Usando re VERBOSE,match versus search,Problemas comunes
@anchor{howto/regex greedy-versus-non-greedy}@anchor{4f19}
@subsubsection Codiciosa versus no codiciosa (`Greedy versus Non-Greedy')


Al repetir una expresión regular, como en @code{a*}, la acción resultante es consumir la mayor cantidad posible del patrón. Este hecho suele molestarle cuando intenta hacer coincidir un par de delimitadores equilibrados, como los corchetes angulares que rodean una etiqueta HTML. El patrón ingenuo para hacer coincidir una sola etiqueta HTML no funciona debido a la naturaleza codiciosa de @code{.*}.

@example
>>> s = '<html><head><title>Title</title>'
>>> len(s)
32
>>> print(re.match('<.*>', s).span())
(0, 32)
>>> print(re.match('<.*>', s).group())
<html><head><title>Title</title>
@end example

La RE coincide con el @code{'<'} en @code{'<html>'}, y el @code{.*}  consume el resto de la cadena de caracteres. Sin embargo, aún queda más en la RE y el @code{>} no puede coincidir al final de la cadena de caracteres, por lo que el motor de la expresión regular tiene que retroceder carácter por carácter hasta que encuentre una coincidencia para el @code{>}. La coincidencia final se extiende desde el @code{'<'} en @code{'<html>'} al @code{'>'} en @code{'</title>'}, que no es lo que queremos.

En este caso, la solución es utilizar los cuantificadores no codiciosos @code{*?}, @code{+?}, @code{??}, o @code{@{m,n@}?}, que coinciden con la `menor' cantidad de texto posible.  En el ejemplo anterior, el @code{'>'} se prueba inmediatamente después de que el primer @code{'<'} coincida, y cuando falla, el motor avanza un carácter a la vez, volviendo a intentar el @code{'>'} en cada paso.  Esto produce el resultado correcto:

@example
>>> print(re.match('<.*?>', s).group())
<html>
@end example

(Tenga en cuenta que analizar HTML o XML con expresiones regulares es doloroso. Los patrones rápidos y sucios manejarán casos comunes, pero HTML y XML tienen casos especiales que romperán la expresión regular obvia; para cuando haya escrito una expresión regular que maneja todos los casos posibles, los patrones serán `muy' complicados. Utilice un módulo analizador HTML o XML para tales tareas.)

@node Usando re VERBOSE,,Codiciosa versus no codiciosa Greedy versus Non-Greedy,Problemas comunes
@anchor{howto/regex using-re-verbose}@anchor{4f1a}
@subsubsection Usando re.VERBOSE


Probablemente ya haya notado que las expresiones regulares son una notación muy compacta, pero no son muy legibles. Las RE de complejidad moderada pueden convertirse en largas colecciones de barras invertidas, paréntesis y metacarácteres, lo que dificulta su lectura y comprensión.

Para tales RE, especificar el flag @ref{2300,,re.VERBOSE} al compilar la expresión regular puede ser útil, porque le permite formatear la expresión regular con mayor claridad.

La flag @code{re.VERBOSE} tiene varios efectos. Los espacios en blanco en la expresión regular que `no están' dentro de una clase de caracteres se ignoran. Esto significa que una expresión como @code{dog | cat} es equivalente al menos legible @code{dog | cat}, pero @code{[a b]} seguirá coincidiendo con los caracteres @code{'a'}, @code{'b'} o un espacio. Además, también puede poner comentarios dentro de una RE; los comentarios se extienden desde un carácter @code{#} hasta la siguiente línea nueva. Cuando se usa con cadenas entre comillas triples, esto permite que las REs sean formateados de manera más ordenada:

@example
pat = re.compile(r"""
 \s*                 # Skip leading whitespace
 (?P<header>[^:]+)   # Header name
 \s* :               # Whitespace, and a colon
 (?P<value>.*?)      # The header's value -- *? used to
                     # lose the following trailing whitespace
 \s*$                # Trailing whitespace to end-of-line
""", re.VERBOSE)
@end example

Esto es mas legible que:

@example
pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
@end example

@node Feedback,,Problemas comunes,Expresiones regulares COMOS HOWTO
@anchor{howto/regex feedback}@anchor{4f1b}
@subsection Feedback


Las expresiones regulares son un tema complicado. ¿Le ayudó este documento a comprenderlas? ¿Hubo partes que no estaban claras o problemas que encontró que no se trataron aquí? Si es así, envíe sugerencias de mejora al autor.

El libro más completo sobre expresiones regulares es casi con certeza `Mastering Regular Expressions de Jeffrey Friedl', publicado por `O’Reilly'. Desafortunadamente, se concentra exclusivamente en los tipos de expresiones regulares de Perl y Java, y no contiene ningún material de Python, por lo que no será útil como referencia para la programación en Python. (La primera edición cubría el módulo @code{regex} de Python, ahora eliminado, que no le ayudará mucho.) Considere sacarlo de su biblioteca.

@node HOW TO - Programación con sockets,Sorting Techniques,Expresiones regulares COMOS HOWTO,Comos HOWTOs de Python
@anchor{howto/sockets doc}@anchor{4f1c}@anchor{howto/sockets socket-howto}@anchor{338d}@anchor{howto/sockets socket-programming-howto}@anchor{4f1d}
@section HOW TO - Programación con sockets


@*Autor: 
Gordon McMillan


@subsubheading Resumen



Los sockets son usados casi en todas partes pero son una de las tecnologías más incomprendidas. Esta es una descripción general de los sockets. No es realmente un tutorial, todavía tendrás trabajo para hacer que las cosas funcionen. No cubre los pequeños detalles (y hay muchos de ellos) pero espero que pueda dar suficiente información para comenzar a usarlos decentemente.

@menu
* Sockets:: 
* Creando un socket:: 
* Usando un socket:: 
* Desconectando:: 
* Sockets no bloqueantes:: 

@end menu

@node Sockets,Creando un socket,,HOW TO - Programación con sockets
@anchor{howto/sockets sockets}@anchor{4f1e}
@subsection Sockets


Solo voy a hablar de los sockets `INET' (como IPv4), pues solo ellos cubren el 99% del uso de los sockets. Y solo voy a hablar sobre los sockets `STREAM' (como TCP), a menos que realmente sepas lo que haces (y en ese caso esta guía no es para ti), tendrás mejor comportamiento y rendimiento con un socket `STREAM' que con cualquier otro. Voy a tratar de aclarar el misterio de que es un socket, además de algunas ideas sobre como trabajar con sockets bloqueantes y no bloqueantes. Pero voy a comenzar hablando de los sockets bloqueantes, necesitarás saber como funcionan antes de lidiar con los no bloqueantes.

Parte del problema para entenderlos es que «socket» puede significar un número de cosas ligeramente diferentes dependiendo del contexto. Entonces, primero vamos a hacer una distinción entre sockets «cliente» - un extremo de una conversación, y un socket «servidor», que es más como una central de teléfonos. La aplicación cliente (tu navegador, por ejemplo) usa sockets «cliente» exclusivamente; el servidor web con quien se está comunicando usa sockets «cliente» y «servidor».

@menu
* Historia:: 

@end menu

@node Historia,,,Sockets
@anchor{howto/sockets history}@anchor{4f1f}
@subsubsection Historia


De las varias formas de comunicación entre procesos (@abbr{IPC,Inter Process Communication}) los sockets son, por mucho, la más popular. En cualquier plataforma es probable que existan otras formas de IPC más rápidas, pero en comunicación multiplataforma los sockets son los únicos competidores.

Fueron inventados en Berkeley como parte del sabor BSD de Unix. Se propagaron como la pólvora con Internet. Con razón: la combinación de sockets con INET hace que hablar con máquinas arbitrarias de todo el mundo sea increíblemente fácil (al menos en comparación con otros esquemas).

@node Creando un socket,Usando un socket,Sockets,HOW TO - Programación con sockets
@anchor{howto/sockets creating-a-socket}@anchor{4f20}
@subsection Creando un socket


De manera general, cuando hiciste click en el enlace que te trajo a esta página tu navegador hizo algo como lo siguiente:

@example
# create an INET, STREAMing socket
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# now connect to the web server on port 80 - the normal http port
s.connect(("www.python.org", 80))
@end example

Cuando @code{connect} termina, el socket @code{s} puede ser usado en una petición para traer el texto de la página. El mismo socket leerá la respuesta y luego será destruido. Así es, destruido. Los sockets cliente son normalmente usados solo para un intercambio (o un pequeño numero se intercambios secuenciales).

Lo que sucede en el servidor web es un poco más complejo. Primero, el servidor web crea un «socket servidor»:

@example
# create an INET, STREAMing socket
serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# bind the socket to a public host, and a well-known port
serversocket.bind((socket.gethostname(), 80))
# become a server socket
serversocket.listen(5)
@end example

Un par de cosas que señalar: usamos @code{socket.gethostname()} para que el socket fuera visible al mundo exterior. Si hubiésemos usado @code{s.bind(('localhost', 80))} o @code{s.bind(('127.0.0.1', 80))} habríamos tenido un socket servidor pero solo habría sido visible en la misma máquina. @code{s.bind(('@w{'}, 80))} especifica que el socket es accesible desde cualquier dirección que tenga la máquina.

Algo más para señalar: los números de puerto bajos son normalmente reservados para servicios «conocidos» (HTTP, SNMP, etc.). Si estás probando los sockets usa un número grande (4 dígitos).

Finalmente, el argumento que se le pasa a @code{listen} le indica a la librería del socket que queremos poner en cola no más de 5 solicitudes de conexión (el máximo normal) antes de rechazar conexiones externas. Si el resto del código está escrito correctamente eso debería ser suficiente.

Ahora que tenemos un socket servidor escuchando en el puerto 80 ya podemos entrar al bucle principal del servidor web:

@example
while True:
    # accept connections from outside
    (clientsocket, address) = serversocket.accept()
    # now do something with the clientsocket
    # in this case, we'll pretend this is a threaded server
    ct = make_client_thread(clientsocket)
    ct.start()
@end example

Existen en realidad 3 maneras generales en las cuales este bucle puede funcionar - despachar un hilo para manejar @code{clientsocket}, crear un proceso nuevo para manejar @code{clientsocket} o reestructurar esta aplicación para usar sockets no bloqueantes y multiplexar entre nuestro «socket servidor» y cualquier @code{clientsocket} activo usando @code{select}. Más sobre esto después. Lo importante a entender ahora es: esto es `todo' lo que un «socket servidor hace». No manda ningún dato. No recibe ningún dato. Solo produce «sockets clientes». Cada @code{clientsocket} es creado en respuesta a algún otro «socket cliente» que hace @code{connect()} al host y al puerto al que estamos vinculados. Tan pronto como hemos credo ese @code{clientsocket} volvemos a escuchar por más conexiones. Los dos «clientes» son libres de «conversar» entre ellos - están usando algún puerto asignado dinámicamente que será reciclado cuando la conversación termine.

@menu
* IPC:: 

@end menu

@node IPC,,,Creando un socket
@anchor{howto/sockets ipc}@anchor{4f21}
@subsubsection IPC


Si necesitas conexiones IPC rápidas entre dos procesos en una misma máquina puedes revisar los `pipes' o la memoria compartida. Si decides usar sockets @code{AF_INET}, vincula el servidor con @code{"localhost"}. En la mayoría de las plataformas, esto tomará un atajo alrededor de algunas capas del código de red y será un poco más rápido.


@subsubheading Ver también


El módulo @ref{94,,multiprocessing} integra IPC multiplataforma en un API de alto nivel.


@node Usando un socket,Desconectando,Creando un socket,HOW TO - Programación con sockets
@anchor{howto/sockets using-a-socket}@anchor{4f22}
@subsection Usando un socket


Lo primero a señalar es que el «socket cliente» del navegador y el «socket cliente» del servidor web son bestias idénticas. Es decir, esta es una conversación `peer to peer'. O para decirlo de otra manera, `como diseñador, tendrás que decidir cuáles son las reglas de etiqueta para una conversación'. Normalmente, el socket que se conecta inicia la conversación, enviando una solicitud o tal vez un inicio de sesión. Pero esa es una decisión de diseño: no es una regla de los sockets.

Hay dos conjuntos de verbos que se usan para la comunicación. Puedes usar @code{send} y @code{recv} o puedes transformar tu socket cliente en algo similar a un archivo y usar @code{read} y @code{write}. Esta última es la forma en la que Java presenta sus sockets. No voy a hablar acerca de eso aquí, excepto para advertirte que necesitas usar @code{flush} en los sockets. Estos son archivos en buffer, y un error común es usar @code{write} para escribir algo y luego usar @code{read} para leer la respuesta. Sin usar @code{flush} en este caso, puedes terminar esperando la respuesta por siempre porque la petición estaría aún en el buffer de salida.

Ahora llegamos al principal problema de los sockets - @code{send} y @code{recv} operan en los buffers de red. Ellos no manejan necesariamente todos los bytes que se les entrega (o espera de ellos), porque su enfoque principal es manejar los buffers de red. En general, ellos retornan cuando los buffers de red asociados se han llenado (@code{send}) o vaciado (@code{recv}). Luego ellos dicen cuántos bytes manejaron. Es `tu' responsabilidad llamarlos nuevamente hasta que su mensaje haya sido tratado por completo.

Cuando @code{recv} retorna 0 bytes significa que el otro lado ha cerrado (o está en el proceso de cerrar) la conexión. No recibirás más datos de esta conexión. Nunca. Es posible que puedas mandar datos exitosamente. De eso voy a hablar más tarde.

Un protocolo como HTTP usa un socket para una sola transferencia. El cliente manda una petición, luego lee la respuesta. Eso es todo. El socket es descartado. Esto significa que un cliente puede detectar el final de la respuesta al recibir 0 bytes.

Pero si planeas reusar el socket para más transferencias, tienes que darte cuenta que `no hay' @abbr{EOT,End of Transfer} `en un socket.' Repito: si la llamada a @code{send} o @code{recv} de un socket retorna después de manejar 0 bytes, la conexión se ha interrumpido. Si la conexión `no' se ha interrumpido, puedes esperar un @code{recv} para siempre, porque el socket no te dirá cuando no hay más nada por leer (por ahora). Ahora, si piensas sobre eso un poco, te darás cuenta de una verdad fundamental de los sockets: `los mensajes deben ser de longitud fija' (ouch), `o ser delimitados' (ouch), `o indicar que tan largo son' (mucho mejor), `o terminar cerrando la conexión.' La elección es completamente tuya (pero hay algunas vías más correctas que otras).

Asumiendo que no quieres terminar la conexión, la solución más simple es un mensaje de longitud fija:

@example
class MySocket:
    """demonstration class only
      - coded for clarity, not efficiency
    """

    def __init__(self, sock=None):
        if sock is None:
            self.sock = socket.socket(
                            socket.AF_INET, socket.SOCK_STREAM)
        else:
            self.sock = sock

    def connect(self, host, port):
        self.sock.connect((host, port))

    def mysend(self, msg):
        totalsent = 0
        while totalsent < MSGLEN:
            sent = self.sock.send(msg[totalsent:])
            if sent == 0:
                raise RuntimeError("socket connection broken")
            totalsent = totalsent + sent

    def myreceive(self):
        chunks = []
        bytes_recd = 0
        while bytes_recd < MSGLEN:
            chunk = self.sock.recv(min(MSGLEN - bytes_recd, 2048))
            if chunk == b'@w{'}:
                raise RuntimeError("socket connection broken")
            chunks.append(chunk)
            bytes_recd = bytes_recd + len(chunk)
        return b'@w{'}.join(chunks)
@end example

El código de envío aquí es usable para prácticamente cualquier esquema de mensajería - en Python envías cadenas y usas @code{len()} para determinar su longitud (incluso si tiene caracteres @code{\0} incrustados). Es principalmente el código receptor el que se vuelve más complejo. (Y en C no es mucho peor, excepto que no puedes usar @code{strlen} si el mensaje tiene @code{\0} incrustados).

La mejora más fácil es hacer que el primer caracter del mensaje un indicador del tipo de mensaje y que el tipo determine la longitud. Ahora tienes dos @code{recv} - el primero para obtener (al menos) ese primer caracter para conocer la longitud, y el segundo en un bucle para obtener el resto. Si decides ir por el camino del delimitador, estarás recibiendo un fragmento de tamaño arbitrario (4096 o 8192 son a menudo buenas elecciones para tamaños de buffers de red) y escaneando lo que recibas en busca del delimitador.

Hay una complicación de la que estar consiente: si el protocolo conversacional permite mandar múltiples mensajes consecutivos (sin ningún tipo de respuesta), y pasas a @code{recv} un tamaño de fragmento arbitrario poder terminar leyendo el inicio de un próximo mensaje. Tendrás que dejarlo aparte y guardarlo hasta que sea necesario.

Prefijar el mensaje con su longitud (por ejemplo, 5 caracteres numéricos) se vuelve más complicado porque (créalo o no), puede que no recibas los 5 caracteres en una llamada a @code{recv}. Para proyectos pequeños te saldrás con la tuya; pero con altas cargas de red, tu código se romperá rápidamente a menos que uses dos @code{recv} en bucle - el primero para determinar la longitud, el segundo para obtener la parte del mensaje. Sucio. También será cuando descubras que @code{send} no siempre logra enviar todo de una sola vez. Y a pesar de haber leído esto eventualmente te va a morder!

Con interés de espacio, la construcción de tu carácter (y preservar mi posición competitiva), estas mejoras se dejan como un ejercicio para el lector. Pasemos a la limpieza.

@menu
* Datos binarios:: 

@end menu

@node Datos binarios,,,Usando un socket
@anchor{howto/sockets binary-data}@anchor{4f23}
@subsubsection Datos binarios


Es perfectamente posible enviar datos binarios a través de un socket. El principal problema es que no todas las máquinas utilizan los mismos formatos para datos binarios. Por ejemplo, orden de bytes de red@footnote{https://en.wikipedia.org/wiki/Endianness#Networking} es big-endian, con el byte más significativo primero, por lo que es un entero de 16 bits con el valor @code{1} serían los dos bytes hexadecimales @code{00 01}. Sin embargo, los procesadores más comunes (x86/AMD64, ARM, RISC-V) son little-endian, con el byte menos significativo primero; ese mismo @code{1} sería @code{01 00}.

Las bibliotecas de socket tienen llamadas para convertir enteros de 16 y 32 bits - @code{ntohl, htonl, ntohs, htons} donde «n» significa `network' (red) y «h» significa `host' (host), «s» significa `short' (corto) y «l» significa `long' (largo). Cuando el orden de la red es el orden del host, estos no hacen nada, pero cuando la máquina está invertida en bytes, intercambian los bytes de manera adecuada.

En estos días de máquinas de 64 bit, la representación ASCII de los datos binarios es con frecuencia más pequeña que la representación binaria. Esto es porque una sorprendente cantidad de veces, todos esos enteros tienen el valor 0, o tal vez 1. La cadena @code{"0"} tendría dos bytes, mientras un entero completo de 64 bit tendría 8. Por supuesto, esto no funciona bien con los mensajes de longitud fija. Decisiones, decisiones.

@node Desconectando,Sockets no bloqueantes,Usando un socket,HOW TO - Programación con sockets
@anchor{howto/sockets disconnecting}@anchor{4f24}
@subsection Desconectando


Estrictamente hablando, se supone que debes usar @code{shutdown} en un socket antes de cerrarlo con @code{close}. @code{shutdown} es un aviso para el socket en el otro lado. Dependiendo del argumento que se le pase, puede significar «No voy a mandar más datos, pero voy a escuchar» o «No estoy escuchando, adiós!». La mayoría de bibliotecas para sockets, sin embargo, están tan acostumbradas a que los programadores ignoren esta parte de la etiqueta que normalmente @code{close} es lo mismo que @code{shutdown(); close()}. Por tanto en la mayoría de las situaciones usar @code{shutdown} de manera explícita no es necesario.

Una forma de usar @code{shutdown} de manera efectiva es en un intercambio similar a `HTTP'. El cliente manda una petición y entonces hace un @code{shutdown(1)}. Esto le dice al servidor «El cliente terminó de enviar, pero todavía puede recibir». El servidor puede detectar «EOF» (Fin del Archivo) al recibir 0 bytes. Puede asumir que se completó la petición. El servidor envía una respuesta. Si el @code{send} termina satisfactoriamente entonces, en efecto, el cliente todavía estaba recibiendo.

Python lleva el apagado automático un paso más allá, y dice que cuando un socket es eliminado por el recolector de basura, automáticamente llama a @code{close} si es necesario. Pero confiar en esto es un mal hábito. Si tu socket simplemente desaparece sin llamar a @code{close}, el socket del otro lado puede colgarse indefinidamente, pensando que solo estas siendo lento. `Por favor' cierra los sockets cuando termines.

@menu
* Cuando los sockets mueren:: 

@end menu

@node Cuando los sockets mueren,,,Desconectando
@anchor{howto/sockets when-sockets-die}@anchor{4f25}
@subsubsection Cuando los sockets mueren


Probablemente lo peor de usar sockets bloqueantes es lo que pasa cuando el otro lado se apaga inesperadamente (sin llamar a @code{close}). Tu socket es probable que se cuelgue. TCP es un protocolo confiable, y va a esperar un largo, largo tiempo antes de rendirse con una conexión. Si estás usando hilos, todo el hilo está esencialmente muerto. No hay mucho que puedas hacer respecto a eso. A menos que no estés haciendo algo tonto, como mantener un bloqueo mientras se realiza una lectura bloqueante, el hilo realmente no estará consumiendo muchos recursos. `No' trates de matar el hilo - parte de la razón por la que los hilos son más eficientes que los procesos es que evitan la complicación asociada con el reciclaje automático de recursos. En otras palabras, si te las arreglas para matar el hilo, es muy probable que todo el proceso termine arruinado.

@node Sockets no bloqueantes,,Desconectando,HOW TO - Programación con sockets
@anchor{howto/sockets non-blocking-sockets}@anchor{4f26}
@subsection `Sockets' no bloqueantes


Si has entendido todo lo anterior, ya conoces la mayor parte de lo que necesitas saber sobre las mecánicas del uso de los sockets. Usarás las mismas llamadas, de la misma manera. Es solo eso, si lo haces correctamente, tu aplicación estará casi correcta.

En Python, usa @code{socket.setblocking(False)} para que no sea bloqueante. En C, es más complejo (por un lado, deberá elegir entre el sabor BSD @code{O_NONBLOCK} y el sabor POSIX casi indistinguible @code{O_NDELAY}, que es completamente diferente de @code{TCP_NODELAY}) , pero es exactamente la misma idea. Haz esto después de crear el socket, pero antes de usarlo. (En realidad, si estás loco, puedes cambiar de un lado a otro).

La principal diferencia mecánica es que @code{send}, @code{recv}, @code{connect} y @code{accept} pueden retornar sin haber hecho nada. Tu tienes (por supuesto) un número de elecciones. Puedes verificar el código de retorno y los códigos de error y en general volverte loco. Si no me crees pruébalo alguna vez. Tu aplicación crecerá grande, con errores y consumirá todo el CPU. Así que vamos a saltarnos las soluciones descerebradas y hacerlo correctamente.

Usando @code{select}.

En C, usar @code{select} es algo complejo. En Python es pan comido, pero está lo suficientemente cercano a la versión de C que si entiendes el @code{select} en Python tendrás pocos problemas con él el C:

@example
ready_to_read, ready_to_write, in_error = \
               select.select(
                  potential_readers,
                  potential_writers,
                  potential_errs,
                  timeout)
@end example

A @code{select} se le pasan tres listas: la primera contiene todos los sockets que puedes intentar leer; la segunda con todos los sockets que puedes intentar escribir, y la tercera (normalmente se deja vacía) todos los que quieras verificar los errores. Debes tener en cuenta que un socket puede ir en más de una lista. La llamada a @code{select} es bloqueante, pero puedes darle un tiempo de espera. Esto generalmente es una cosa sensata de hacer - dale un tiempo de espera largo (un minuto por ejemplo) a menos que tengas una buena razón para no hacerlo.

En el retorno tendrás tres listas. Estas contienen los sockets que son realmente legibles, escribibles y con error. Cada una de estas lista es un subconjunto (posiblemente vacío) de la lista correspondiente que pasaste.

Si un socket está en la lista retornada legible, puedes estar tan-seguro-como-podrías-estarlo-en-este-negocio que una llamada a @code{recv} en este socket va a retornar `algo'. La misma idea se aplica a la lista de escribibles. Serás capaz de mandar `algo'. Tal vez no todo lo que quieras, pero `algo' es mejor que nada. (Realmente, cualquier socket socket razonablemente saludable va a retornar como escribible - eso solo significa que el espacio de salida del buffer de red está disponible)

Si tienes un socket `servidor', ponlo en la lista de `potenciales legibles'. Se retorna en la lista de legibles, una llamada a @code{accept} va a funcionar (casi seguro). Se has creado un nuevo socket para llamar a @code{connect} para conectarte con otro, ponlo en la lista de `potenciales escribibles'. Si retorna en la lista de escribibles, tienes una buena oportunidad de que esté conectado.

Realmente, @code{select} puede ser útil incluso con sockets bloqueantes. Es una manera de determinar si vas a bloquear - el socket retorna como leíble cuando hay algo en el buffer. Sin embargo, esto aun no sirve de ayuda con el problema de determinar si el otro extremo terminó, o solo está ocupado con otra cosa.

`Alerta de portabilidad': En Unix, @code{select} funciona tanto con sockets como con archivos. No intentes esto en Windows. En Windows @code{select} funciona solo con sockets. También ten en cuenta que en C, muchas de las opciones más avanzadas de los sockets se hacen diferentes en Windows. De hecho, en Windows normalmente uso hilos (que funciona muy, muy bien) con los sockets.

@node Sorting Techniques,CÓMO HOWTO Unicode,HOW TO - Programación con sockets,Comos HOWTOs de Python
@anchor{howto/sorting doc}@anchor{4f27}@anchor{howto/sorting sorting-techniques}@anchor{4f28}@anchor{howto/sorting sortinghowto}@anchor{2186}
@section Sorting Techniques


@*Autor: 
Andrew Dalke and Raymond Hettinger


Las listas de Python tienen un método incorporado @ref{c57,,list.sort()} que modifica la lista in situ. También hay una función incorporada @ref{c56,,sorted()} que crea una nueva lista ordenada a partir de un iterable.

En este documento exploramos las distintas técnicas para ordenar datos usando Python.

@menu
* Conceptos básicos de ordenación:: 
* Funciones clave:: 
* Operator Module Functions and Partial Function Evaluation:: 
* Ascendente y descendente:: 
* Estabilidad de ordenamiento y ordenamientos complejos:: 
* Decorate-Sort-Undecorate:: 
* Funciones de comparación:: 
* Strategies For Unorderable Types and Values:: 
* Curiosidades:: 
* Partial Sorts:: 

@end menu

@node Conceptos básicos de ordenación,Funciones clave,,Sorting Techniques
@anchor{howto/sorting sorting-basics}@anchor{4f29}
@subsection Conceptos básicos de ordenación


Una clasificación ascendente simple es muy fácil: simplemente llame a la función @ref{c56,,sorted()}. Retorna una nueva lista ordenada:

@example
>>> sorted([5, 2, 3, 1, 4])
[1, 2, 3, 4, 5]
@end example

También puede usar el método @ref{c57,,list.sort()}. Modifica la lista in situ (y retorna @code{None} para evitar confusiones). Por lo general, es menos conveniente que @ref{c56,,sorted()}, pero si no necesita la lista original, es un poco más eficiente.

@example
>>> a = [5, 2, 3, 1, 4]
>>> a.sort()
>>> a
[1, 2, 3, 4, 5]
@end example

Otra diferencia es que el método @ref{c57,,list.sort()} solo aplica para las listas. En contraste, la función @ref{c56,,sorted()} acepta cualquier iterable.

@example
>>> sorted(@{1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'@})
[1, 2, 3, 4, 5]
@end example

@node Funciones clave,Operator Module Functions and Partial Function Evaluation,Conceptos básicos de ordenación,Sorting Techniques
@anchor{howto/sorting key-functions}@anchor{4f2a}
@subsection Funciones clave


The @ref{c57,,list.sort()} method and the functions @ref{c56,,sorted()},
@ref{f8b,,min()}, @ref{f8c,,max()}, @ref{252f,,heapq.nsmallest()}, and
@ref{252e,,heapq.nlargest()} have a `key' parameter to specify a function (or
other callable) to be called on each list element prior to making
comparisons.

For example, here’s a case-insensitive string comparison using
@ref{e5b,,str.casefold()}:

@example
>>> sorted("This is a test string from Andrew".split(), key=str.casefold)
['a', 'Andrew', 'from', 'is', 'string', 'test', 'This']
@end example

El valor del parámetro `key' debe ser una función (u otra invocable) que tome un solo argumento y retorne una clave para usar con fines de clasificación. Esta técnica es rápida porque la función de la tecla se llama exactamente una vez para cada registro de entrada.

Un uso frecuente es ordenar objetos complejos utilizando algunos de los índices del objeto como claves. Por ejemplo:

@example
>>> student_tuples = [
...     ('john', 'A', 15),
...     ('jane', 'B', 12),
...     ('dave', 'B', 10),
... ]
>>> sorted(student_tuples, key=lambda student: student[2])   # sort by age
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

La misma técnica funciona para objetos con atributos nombrados. Por ejemplo:

@example
>>> class Student:
...     def __init__(self, name, grade, age):
...         self.name = name
...         self.grade = grade
...         self.age = age
...     def __repr__(self):
...         return repr((self.name, self.grade, self.age))

>>> student_objects = [
...     Student('john', 'A', 15),
...     Student('jane', 'B', 12),
...     Student('dave', 'B', 10),
... ]
>>> sorted(student_objects, key=lambda student: student.age)   # sort by age
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

Objects with named attributes can be made by a regular class as shown
above, or they can be instances of @ref{32e,,dataclass} or
a @ref{6ef,,named tuple}.

@node Operator Module Functions and Partial Function Evaluation,Ascendente y descendente,Funciones clave,Sorting Techniques
@anchor{howto/sorting operator-module-functions-and-partial-function-evaluation}@anchor{4f2b}
@subsection Operator Module Functions and Partial Function Evaluation


The @ref{e8a,,key function} patterns shown above are very common, so Python provides
convenience functions to make accessor functions easier and faster. The
@ref{9f,,operator} module has @ref{af2,,itemgetter()},
@ref{eb8,,attrgetter()}, and a @ref{eb9,,methodcaller()} function.

Usando esas funciones, los ejemplos anteriores se vuelven más simples y rápidos:

@example
>>> from operator import itemgetter, attrgetter

>>> sorted(student_tuples, key=itemgetter(2))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

>>> sorted(student_objects, key=attrgetter('age'))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

Las funciones del módulo `operator' permiten múltiples niveles de clasificación. Por ejemplo, para ordenar por `grade' y luego por `age':

@example
>>> sorted(student_tuples, key=itemgetter(1,2))
[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]

>>> sorted(student_objects, key=attrgetter('grade', 'age'))
[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]
@end example

The @ref{5f,,functools} module provides another helpful tool for making
key-functions.  The @ref{17a,,partial()} function can reduce the
arity@footnote{https://en.wikipedia.org/wiki/Arity} of a multi-argument
function making it suitable for use as a key-function.

@example
>>> from functools import partial
>>> from unicodedata import normalize

>>> names = 'Zoë Åbjørn Núñez Élana Zeke Abe Nubia Eloise'.split()

>>> sorted(names, key=partial(normalize, 'NFD'))
['Abe', 'Åbjørn', 'Eloise', 'Élana', 'Nubia', 'Núñez', 'Zeke', 'Zoë']

>>> sorted(names, key=partial(normalize, 'NFC'))
['Abe', 'Eloise', 'Nubia', 'Núñez', 'Zeke', 'Zoë', 'Åbjørn', 'Élana']
@end example

@node Ascendente y descendente,Estabilidad de ordenamiento y ordenamientos complejos,Operator Module Functions and Partial Function Evaluation,Sorting Techniques
@anchor{howto/sorting ascending-and-descending}@anchor{4f2c}
@subsection Ascendente y descendente


Ambos @ref{c57,,list.sort()} y @ref{c56,,sorted()} aceptan un parámetro `reverse' con un valor booleano. Esto se usa para marcar tipos descendentes. Por ejemplo, para obtener los datos de los estudiantes en orden inverso de `edad':

@example
>>> sorted(student_tuples, key=itemgetter(2), reverse=True)
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]

>>> sorted(student_objects, key=attrgetter('age'), reverse=True)
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
@end example

@node Estabilidad de ordenamiento y ordenamientos complejos,Decorate-Sort-Undecorate,Ascendente y descendente,Sorting Techniques
@anchor{howto/sorting sort-stability-and-complex-sorts}@anchor{4f2d}
@subsection Estabilidad de ordenamiento y ordenamientos complejos


Se garantiza que las clasificaciones serán estables@footnote{https://es.wikipedia.org/wiki/Algoritmo_de_ordenamiento#Estabilidad}. Eso significa que cuando varios registros tienen la misma clave, se conserva su orden original.

@example
>>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
>>> sorted(data, key=itemgetter(0))
[('blue', 1), ('blue', 2), ('red', 1), ('red', 2)]
@end example

Observe cómo los dos registros para `blue' conservan su orden original de modo que se garantice que @code{('blue', 1)} preceda a @code{('blue', 2)}.

Esta maravillosa propiedad le permite construir ordenamientos complejos en varias etapas. Por ejemplo, para ordenar los datos de estudiantes en orden descendente por `grade' y luego ascendente por `age', ordene primero por `age' y luego por `grade':

@example
>>> s = sorted(student_objects, key=attrgetter('age'))     # sort on secondary key
>>> sorted(s, key=attrgetter('grade'), reverse=True)       # now sort on primary key, descending
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

Esto se puede encapsular en una función que tome una lista y tuplas (atributo, orden) para ordenarlas por múltiples pases.

@example
>>> def multisort(xs, specs):
...     for key, reverse in reversed(specs):
...         xs.sort(key=attrgetter(key), reverse=reverse)
...     return xs

>>> multisort(list(student_objects), (('grade', True), ('age', False)))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

El algoritmo Timsort@footnote{https://en.wikipedia.org/wiki/Timsort} utilizado en Python realiza múltiples ordenamientos de manera eficiente porque puede aprovechar cualquier orden ya presente en el conjunto de datos.

@node Decorate-Sort-Undecorate,Funciones de comparación,Estabilidad de ordenamiento y ordenamientos complejos,Sorting Techniques
@anchor{howto/sorting decorate-sort-undecorate}@anchor{4f2e}
@subsection Decorate-Sort-Undecorate


Este patrón de implementación, llamado DSU (por sus siglas en inglés `Decorate-Sort-Undecorate'), se realiza en tres pasos:


@itemize *

@item 
Primero, la lista inicial está «decorada» con nuevos valores que controlarán el orden en que se realizará el pedido.

@item 
En segundo lugar, se ordena la lista decorada.

@item 
Finalmente, los valores decorados se eliminan, creando una lista que contiene solo los valores iniciales en el nuevo orden.
@end itemize

Por ejemplo, para ordenar los datos de los estudiantes por `grade' utilizando el enfoque DSU:

@example
>>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)]
>>> decorated.sort()
>>> [student for grade, i, student in decorated]               # undecorate
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
@end example

Esta técnica funciona porque las tuplas se comparan en orden lexicográfico; se comparan los primeros objetos; si hay objetos idénticos, se compara el siguiente objeto, y así sucesivamente.

No es estrictamente necesario en todos los casos incluir el índice `i' en la lista decorada, pero incluirlo ofrece dos ventajas:


@itemize *

@item 
El orden es estable: si dos elementos tienen la misma clave, su orden se conservará en la lista ordenada.

@item 
Los elementos originales no tienen que ser comparables porque el orden de las tuplas decoradas estará determinado por, como máximo, los dos primeros elementos. Entonces, por ejemplo, la lista original podría contener números complejos que no se pueden ordenar directamente.
@end itemize

Otro nombre para esta técnica es Transformación Schwartziana@footnote{https://en.wikipedia.org/wiki/Schwartzian_transform}, después de que Randal L. Schwartz la popularizara entre los programadores de Perl.

Ahora que la clasificación de Python proporciona funciones clave, esta técnica ya no se usa con frecuencia.

@node Funciones de comparación,Strategies For Unorderable Types and Values,Decorate-Sort-Undecorate,Sorting Techniques
@anchor{howto/sorting comparison-functions}@anchor{4f2f}
@subsection Funciones de comparación


A diferencia de las funciones clave que devuelven un valor absoluto para la ordenación, una función de comparación calcula la ordenación relativa para dos entradas.

Por ejemplo, una escala de balance@footnote{https://upload.wikimedia.org/wikipedia/commons/1/17/Balance_à_tabac_1850.JPG} compara dos muestras dando un orden relativo: más ligero, igual o más pesado. Del mismo modo, una función de comparación como @code{cmp(a, b)} devolverá un valor negativo para menor que, cero si las entradas son iguales, o un valor positivo para mayor que.

Es habitual encontrar funciones de comparación al traducir algoritmos de otros lenguajes.  Además, algunas bibliotecas proporcionan funciones de comparación como parte de su API.  Por ejemplo, @ref{3c6a,,locale.strcoll()} es una función de comparación.

Para adaptarse a estas situaciones, Python proporciona @ref{1247,,functools.cmp_to_key} para envolver la función de comparación y hacerla utilizable como una función clave:

@example
sorted(words, key=cmp_to_key(strcoll))  # locale-aware sort order
@end example

@node Strategies For Unorderable Types and Values,Curiosidades,Funciones de comparación,Sorting Techniques
@anchor{howto/sorting strategies-for-unorderable-types-and-values}@anchor{4f30}
@subsection Strategies For Unorderable Types and Values


A number of type and value issues can arise when sorting.
Here are some strategies that can help:


@itemize *

@item 
Convert non-comparable input types to strings prior to sorting:
@end itemize

@example
>>> data = ['twelve', '11', 10]
>>> sorted(map(str, data))
['10', '11', 'twelve']
@end example

This is needed because most cross-type comparisons raise a
@ref{228,,TypeError}.


@itemize *

@item 
Remove special values prior to sorting:
@end itemize

@example
>>> from math import isnan
>>> from itertools import filterfalse
>>> data = [3.3, float('nan'), 1.1, 2.2]
>>> sorted(filterfalse(isnan, data))
[1.1, 2.2, 3.3]
@end example

This is needed because the IEEE-754 standard@footnote{https://en.wikipedia.org/wiki/IEEE_754} specifies that, «Every NaN
shall compare unordered with everything, including itself.»

Likewise, @code{None} can be stripped from datasets as well:

@example
>>> data = [3.3, None, 1.1, 2.2]
>>> sorted(x for x in data if x is not None)
[1.1, 2.2, 3.3]
@end example

This is needed because @code{None} is not comparable to other types.


@itemize *

@item 
Convert mapping types into sorted item lists before sorting:
@end itemize

@example
>>> data = [@{'a': 1@}, @{'b': 2@}]
>>> sorted(data, key=lambda d: sorted(d.items()))
[@{'a': 1@}, @{'b': 2@}]
@end example

This is needed because dict-to-dict comparisons raise a
@ref{228,,TypeError}.


@itemize *

@item 
Convert set types into sorted lists before sorting:
@end itemize

@example
>>> data = [@{'a', 'b', 'c'@}, @{'b', 'c', 'd'@}]
>>> sorted(map(sorted, data))
[['a', 'b', 'c'], ['b', 'c', 'd']]
@end example

This is needed because the elements contained in set types do not have a
deterministic order.  For example, @code{list(@{'a', 'b'@})} may produce
either @code{['a', 'b']} or @code{['b', 'a']}.

@node Curiosidades,Partial Sorts,Strategies For Unorderable Types and Values,Sorting Techniques
@anchor{howto/sorting odds-and-ends}@anchor{4f31}
@subsection Curiosidades



@itemize *

@item 
Para ordenar teniendo en cuenta la localización, utilice @ref{3c6c,,locale.strxfrm()} para una función clave o @ref{3c6a,,locale.strcoll()} para una función de comparación.  Esto es necesario porque la ordenación «alfabética» puede variar entre culturas aunque el alfabeto subyacente sea el mismo.

@item 
El parámetro `reverse' aún mantiene estabilidad de ordenamiento (de modo que los registros con claves iguales conservan el orden original). Curiosamente, ese efecto se puede simular sin el parámetro utilizando la función incorporada @ref{8fc,,reversed()} dos veces:

@example
>>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
>>> standard_way = sorted(data, key=itemgetter(0), reverse=True)
>>> double_reversed = list(reversed(sorted(reversed(data), key=itemgetter(0))))
>>> assert standard_way == double_reversed
>>> standard_way
[('red', 1), ('red', 2), ('blue', 1), ('blue', 2)]
@end example

@item 
The sort routines use @code{<} when making comparisons
between two objects. So, it is easy to add a standard sort order to a class by
defining an @ref{1372,,__lt__()} method:

@example
>>> Student.__lt__ = lambda self, other: self.age < other.age
>>> sorted(student_objects)
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

However, note that @code{<} can fall back to using @ref{1374,,__gt__()} if
@ref{1372,,__lt__()} is not implemented (see @ref{1372,,object.__lt__()}
for details on the mechanics).  To avoid surprises, 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}
recommends that all six comparison methods be implemented.
The @ref{fc2,,total_ordering()} decorator is provided to make that
task easier.

@item 
Las funciones clave no necesitan depender directamente de los objetos que se ordenan. Una función clave también puede acceder a recursos externos. Por ejemplo, si las calificaciones de los estudiantes se almacenan en un diccionario, se pueden usar para ordenar una lista separada de nombres de estudiantes:

@example
>>> students = ['dave', 'john', 'jane']
>>> newgrades = @{'john': 'F', 'jane':'A', 'dave': 'C'@}
>>> sorted(students, key=newgrades.__getitem__)
['jane', 'dave', 'john']
@end example
@end itemize

@node Partial Sorts,,Curiosidades,Sorting Techniques
@anchor{howto/sorting partial-sorts}@anchor{4f32}
@subsection Partial Sorts


Some applications require only some of the data to be ordered.  The standard
library provides several tools that do less work than a full sort:


@itemize *

@item 
@ref{f8b,,min()} and @ref{f8c,,max()} return the smallest and largest values,
respectively.  These functions make a single pass over the input data and
require almost no auxiliary memory.

@item 
@ref{252f,,heapq.nsmallest()} and @ref{252e,,heapq.nlargest()} return
the `n' smallest and largest values, respectively.  These functions
make a single pass over the data keeping only `n' elements in memory
at a time.  For values of `n' that are small relative to the number of
inputs, these functions make far fewer comparisons than a full sort.

@item 
@ref{14f8,,heapq.heappush()} and @ref{14f9,,heapq.heappop()} create and maintain a
partially sorted arrangement of data that keeps the smallest element
at position @code{0}.  These functions are suitable for implementing
priority queues which are commonly used for task scheduling.
@end itemize

@node CÓMO HOWTO Unicode,HOWTO - Cómo obtener recursos de Internet con el paquete urllib,Sorting Techniques,Comos HOWTOs de Python
@anchor{howto/unicode doc}@anchor{4f33}@anchor{howto/unicode id1}@anchor{4f34}@anchor{howto/unicode unicode-howto}@anchor{1310}
@section CÓMO (`HOWTO') Unicode


@*Lanzamiento: 
1.12


Este CÓMO (`HOWTO') debate el soporte de Python para la especificación Unicode para representar datos textuales, y explica varios problemas que comúnmente encuentra la gente cuando tratan de trabajar con Unicode.

@menu
* Introducción a Unicode:: 
* Soporte Unicode de Python:: 
* Leyendo y escribiendo datos Unicode:: 
* Agradecimientos: Agradecimientos<10>. 

@end menu

@node Introducción a Unicode,Soporte Unicode de Python,,CÓMO HOWTO Unicode
@anchor{howto/unicode introduction-to-unicode}@anchor{4f35}
@subsection Introducción a Unicode


@menu
* Definiciones:: 
* Codificaciones:: 
* Referencias: Referencias<3>. 

@end menu

@node Definiciones,Codificaciones,,Introducción a Unicode
@anchor{howto/unicode definitions}@anchor{4f36}
@subsubsection Definiciones


Los programas de hoy necesitan poder manejar una amplia variedad de caracteres. Las aplicaciones son a menudo internacionalizadas para mostrar mensajes y resultados en una variedad de idiomas seleccionables por el usuario; Es posible que el mismo programa necesite generar un mensaje de error en inglés, francés, japonés, hebreo o ruso. El contenido web se puede escribir en cualquiera de estos idiomas y también puede incluir una variedad de símbolos `emoji'. El tipo cadena de Python utiliza el estándar Unicode para representar caracteres, lo que permite a los programas de Python trabajar con todos estos caracteres posibles diferentes.

Unicode (@indicateurl{https://www.unicode.org/}) es una especificación que apunta a listar cada carácter usado por lenguajes humanos y darle a cada carácter su propio código único. La especificación Unicode es continuamente revisada y actualizada para añadir nuevos lenguajes y símbolos.

Un `carácter' es el componente mas pequeño posible de un texto.  “A”, “B”, “C”, etc., son todos diferentes caracteres. También lo son `“È”' e `“Í”'. Los caracteres varían dependiendo del lenguaje o del contexto en el que estás hablando. Por ejemplo, Existe un carácter para el «Número Uno Romano»,  “I”, que es distinto de la letra “I” mayúscula. Estos usualmente lucen igual, pero son dos caracteres diferentes que tienen distintos significados.

El estándar Unicode describe cómo se representan los caracteres mediante `puntos de código'. Un valor de punto de código es un número entero en el rango de 0 a 0x10FFFF (aproximadamente 1.1 millones de valores, el número real asignado@footnote{https://www.unicode.org/versions/latest/#Summary} es menor que eso). En el estándar y en este documento, un punto de código se escribe usando la notación @code{U+265E} para significar el carácter con valor @code{0x265e} (9,822 en decimal).

El estándar Unicode contiene muchas tablas que enumeran caracteres y sus puntos de código correspondientes:

@example
0061    'a'; LATIN SMALL LETTER A
0062    'b'; LATIN SMALL LETTER B
0063    'c'; LATIN SMALL LETTER C
...
007B    '@{'; LEFT CURLY BRACKET
...
2167    'Ⅷ'; ROMAN NUMERAL EIGHT
2168    'Ⅸ'; ROMAN NUMERAL NINE
...
265E    '♞'; BLACK CHESS KNIGHT
265F    '♟'; BLACK CHESS PAWN
...
1F600   '😀'; GRINNING FACE
1F609   '😉'; WINKING FACE
...
@end example

Estrictamente, estas definiciones implican que no tiene sentido decir “este es el carácter @code{U+265E}. @code{U+265E} es un punto de código, que representa algún carácter en particular; en este caso, representa el carácter “CABALLERO AJEDREZ NEGRO”, “♞”. En contextos informales, esta distinción entre puntos de código y caracteres a veces se olvidará.

Un carácter es representado en una pantalla o en papel por un conjunto de elementos gráficos llamado `glifo'. El glifo para una A mayúscula, por ejemplo, es dos trazos diagonales y uno horizontal, aunque los detalles exactos van a depender de la fuente utilizada. La mayoría del código de Python no necesita preocuparse por los glifos; averiguar el glifo correcto para mostrar es generalmente el trabajo de un kit de herramientas GUI o el renderizador de fuentes de una terminal.

@node Codificaciones,Referencias<3>,Definiciones,Introducción a Unicode
@anchor{howto/unicode encodings}@anchor{4f37}
@subsubsection Codificaciones


Para resumir la sección anterior: Una cadena Unicode es una secuencia de código de posiciones que son números desde 0 hasta @code{0x10FFFF} (1114111 decimal). Esta secuencia de código de posiciones necesita ser representada en memoria como un conjunto de `unidades de código',  y las `unidades de código' son mapeadas a bytes de 8 bits. Las reglas para traducir una cadena Unicode a una secuencia de bytes son llamadas `Codificación de carácter', o sólo una `codificación'.

La primera codificación en que podrías pensar es usar enteros de 32 bits como unidad de código, y luego usar la representación de la CPU de enteros de 32 bits. En esta representación, la cadena «Python» podría verse así:

@example
   P           y           t           h           o           n
0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00
   0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
@end example

Esta representación es sencilla pero utilizarla presenta una serie de problemas.


@enumerate 

@item 
No es portable; diferentes procesadores ordenan los bytes de manera diferente.

@item 
Es un desperdicio de espacio. En la mayoría de los textos, la mayoría de los códigos de posición son menos de 127, o menos de 255, por lo que una gran cantidad de espacio está ocupado por bytes @code{0x00}. La cadena anterior toma 24 bytes en comparación con los 6 bytes necesarios para una representación ASCII. El aumento en el uso de RAM no importa demasiado (las computadoras de escritorio tienen `gigabytes' de RAM, y las cadenas no suelen ser tan grandes), pero expandir nuestro uso del disco y el ancho de banda de la red en un factor de 4 es intolerable.

@item 
No es compatible con funciones existentes en C como @code{strlen()}, para eso se necesitaría una nueva familia de funciones de cadenas.
@end enumerate

Por lo tanto esta codificación no es muy utilizada, y la gente prefiere elegir codificaciones que son mas eficientes y convenientes, como UTF-8.

UTF-8 es una de las codificaciones mas utilizadas, y Python generalmente la usa de forma predeterminada. UTF significa `«Unicode Transformation Format»', y el «8» significa que se utilizan valores de 8 bits en la codificación. (También hay codificaciones UTF-16 y UTF-32, pero son menos frecuentes que UTF-8.) UTF-8 usa las siguientes reglas:


@enumerate 

@item 
Si el código de posición is < 128, es representado por el valor de byte correspondiente.

@item 
Si el código de posición es >= 128, se transforma en una secuencia de dos, tres, o cuatro bytes, donde cada byte de la secuencia está entre 128 y 255.
@end enumerate

UTF-8 tiene varias propiedades convenientes:


@enumerate 

@item 
Puede manejar cualquier punto de código Unicode.

@item 
Una cadena Unicode se convierte en una secuencia de bytes que contiene cero bytes incrustados solo donde representan el carácter nulo (U+0000). Esto significa que las cadenas UTF-8 pueden ser procesadas por funciones C como @code{strcpy()} y enviadas a través de protocolos que no pueden manejar cero bytes para nada más que marcadores de fin de cadena de caracteres.

@item 
Una cadena de texto ASCII es también texto UTF-8.

@item 
UTF-8 es bastante compacto; La mayoría de los caracteres comúnmente usados pueden ser representados con uno o dos bytes.

@item 
Si los bytes están corruptos o perdidos, es posible determinar el comienzo del próximo código de posición y re-sincronizar. También es poco probable que datos aleatorios de 8 bit se vean como UTF-8 válido.

@item 
UTF-8 es una codificación orientada a bytes. La codificación especifica que cada carácter está representado por una secuencia específica de uno o más bytes. Esto evita los problemas de ordenamiento de bytes que pueden ocurrir con codificaciones orientadas a números enteros y palabras, como UTF-16 y UTF-32, donde la secuencia de bytes varía según el hardware en el que se codificó la cadena.
@end enumerate

@node Referencias<3>,,Codificaciones,Introducción a Unicode
@anchor{howto/unicode references}@anchor{4f38}
@subsubsection Referencias


El sitio del Consorcio Unicode@footnote{https://www.unicode.org} tiene gráficos de caracteres, un glosario y versiones en PDF de la especificación Unicode. Esté preparado para una lectura difícil. Una cronología@footnote{https://www.unicode.org/history/} del origen y desarrollo de Unicode también está disponible en el sitio.

En el canal de `Youtube' `Computerphile', `Tom Scott' discute brevemente la historia de Unicode y UTF-8@footnote{https://www.youtube.com/watch?v=MijmeoH9LT4} (9 minutos 36 segundos).

To help understand the standard, Jukka Korpela has written an introductory guide@footnote{https://jkorpela.fi/unicode/guide.html} to reading the
Unicode character tables.

Otro buen articulo introductorio@footnote{https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character-sets-no-excuses/} fue escrito por `Joel Spolsky'. Si esta introducción no aclara las cosas para usted, debería tratar leyendo este articulo alternativo antes de continuar.

Artículos de `Wikipedia' son a menudo útiles. Mire los artículos para «codificación de caracteres@footnote{https://es.wikipedia.org/wiki/Codificaci%C3%B3n_de_caracteres}» y UTF-8@footnote{https://es.wikipedia.org/wiki/UTF-8}, por ejemplo.

@node Soporte Unicode de Python,Leyendo y escribiendo datos Unicode,Introducción a Unicode,CÓMO HOWTO Unicode
@anchor{howto/unicode python-s-unicode-support}@anchor{4f39}
@subsection Soporte Unicode de Python


Ahora que ya ha aprendido los rudimentos de Unicode, podemos mirar las características de Unicode de Python.

@menu
* El tipo cadena:: 
* Convirtiendo a Bytes:: 
* Literales Unicode en código fuente Python:: 
* Propiedades Unicode:: 
* Comparando cadenas:: 
* Expresiones regulares Unicode:: 
* Referencias: Referencias<4>. 

@end menu

@node El tipo cadena,Convirtiendo a Bytes,,Soporte Unicode de Python
@anchor{howto/unicode the-string-type}@anchor{4f3a}
@subsubsection El tipo cadena


Desde Python 3.0, el tipo @ref{237,,str} del lenguaje contiene caracteres Unicode, lo que significa que cualquier cadena creada usando @code{"unicode rocks!"}, @code{'unicode rocks!'}, o la sintaxis de cadena entre comillas triples es almacenado como Unicode.

La codificación predeterminada para el código fuente de Python es UTF-8, por lo que simplemente puede incluir un carácter Unicode en un literal de cadena de caracteres:

@example
try:
    with open('/tmp/input.txt', 'r') as f:
        ...
except OSError:
    # 'File not found' error message.
    print("Fichier non trouvé")
@end example

Nota al margen: Python 3 también soporta el uso de caracteres Unicode en identificadores:

@example
répertoire = "/tmp/records.log"
with open(répertoire, "w") as f:
    f.write("test\n")
@end example

Si no puede ingresar un carácter en particular en su editor o desea mantener el código fuente solo ASCII por alguna razón, también puede usar secuencias de escape en cadenas de caracteres literales. (Dependiendo de su sistema, es posible que vea el glifo delta de mayúsculas en lugar de un escape u):

@example
>>> "\N@{GREEK CAPITAL LETTER DELTA@}"  # Using the character name
'\u0394'
>>> "\u0394"                          # Using a 16-bit hex value
'\u0394'
>>> "\U00000394"                      # Using a 32-bit hex value
'\u0394'
@end example

Además, uno puede crear una cadena usando el método @ref{96d,,decode()} de la clase @ref{325,,bytes}. Este método recibe una `codificación' como argumento, como @code{UTF-8}, y opcionalmente un argumento `errores'.

El argumento `errores' especifica la respuesta cuando la cadena ingresada no puede ser convertida de acuerdo a las reglas de codificación. Los posibles valores para este argumento son @code{'strict'} (levanta una excepción @ref{aa5,,UnicodeDecodeError}), @code{'replace'} (use @code{U+FFFD}, @code{CARACTER DE REEMPLAZO}), @code{'ignore'} (solo deje el carácter fuera del resultado Unicode), o @code{'backslahsreplace'} (inserta una secuencia de escape @code{\xNN}). Los siguientes ejemplos muestran las diferencias

@example
>>> b'\x80abc'.decode("utf-8", "strict")  
Traceback (most recent call last):
    ...
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x80 in position 0:
  invalid start byte
>>> b'\x80abc'.decode("utf-8", "replace")
'\ufffdabc'
>>> b'\x80abc'.decode("utf-8", "backslashreplace")
'\\x80abc'
>>> b'\x80abc'.decode("utf-8", "ignore")
'abc'
@end example

Las codificaciones son especificadas como cadenas que contienen el nombre de la codificación. Python viene con cerca de 100 codificaciones diferentes; consulta la referencia de la biblioteca de Python en @ref{e3e,,Codificaciones estándar} para una lista. Algunas codificaciones tienen múltiples nombres; por ejemplo, @code{'latin-1'}, @code{'iso_8859_1'} y @code{'8859}” son sinónimos para la misma codificación.

Las cadenas de un solo carácter pueden ser creadas también con la función incorporada @ref{167d,,chr()}, que toma un entero y retorna una cadena Unicode de longitud 1 que contiene el correspondiente código de posición. La operación inversa es la función incorporada @ref{1eef,,ord()} que toma una cadena Unicode de un carácter y retorna el código de posición:

@example
>>> chr(57344)
'\ue000'
>>> ord('\ue000')
57344
@end example

@node Convirtiendo a Bytes,Literales Unicode en código fuente Python,El tipo cadena,Soporte Unicode de Python
@anchor{howto/unicode converting-to-bytes}@anchor{4f3b}
@subsubsection Convirtiendo a Bytes


El método opuesto a @ref{96d,,bytes.decode()} es @ref{96c,,str.encode()}, que retorna una representación de @ref{325,,bytes} de la cadena Unicode, codificada en la codificación solicitada.

El parámetro `errores' es el mismo que el parámetro del método @ref{96d,,decode()} pero soporta algunos manejadores mas.

El siguiente ejemplo muestra los diferentes resultados:

@example
>>> u = chr(40960) + 'abcd' + chr(1972)
>>> u.encode('utf-8')
b'\xea\x80\x80abcd\xde\xb4'
>>> u.encode('ascii')  
Traceback (most recent call last):
    ...
UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
  position 0: ordinal not in range(128)
>>> u.encode('ascii', 'ignore')
b'abcd'
>>> u.encode('ascii', 'replace')
b'?abcd?'
>>> u.encode('ascii', 'xmlcharrefreplace')
b'&#40960;abcd&#1972;'
>>> u.encode('ascii', 'backslashreplace')
b'\\ua000abcd\\u07b4'
>>> u.encode('ascii', 'namereplace')
b'\\N@{YI SYLLABLE IT@}abcd\\u07b4'
@end example

Las rutinas de bajo nivel para registrar y acceder a las codificaciones disponibles se encuentran en el módulo @ref{1c,,codecs}. La implementación de nuevas codificaciones también requiere comprender el módulo @ref{1c,,codecs}. Sin embargo, las funciones de codificación y decodificación retornadas por este módulo generalmente son de nivel más bajo de lo que es cómodo, y escribir nuevas codificaciones es una tarea especializada, por lo que el módulo no se cubrirá en este CÓMO.

@node Literales Unicode en código fuente Python,Propiedades Unicode,Convirtiendo a Bytes,Soporte Unicode de Python
@anchor{howto/unicode unicode-literals-in-python-source-code}@anchor{4f3c}
@subsubsection Literales Unicode en código fuente Python


En el código fuente de Python, se pueden escribir puntos de código Unicode específicos utilizando la secuencia de escape @code{\u}, que es seguida por cuatro dígitos hexadecimales que dan el punto de código. La secuencia de escape @code{\U} es similar, pero espera ocho dígitos hexadecimales, no cuatro:

@example
>>> s = "a\xac\u1234\u20ac\U00008000"
... #     ^^^^ two-digit hex escape
... #         ^^^^^^ four-digit Unicode escape
... #                     ^^^^^^^^^^ eight-digit Unicode escape
>>> [ord(c) for c in s]
[97, 172, 4660, 8364, 32768]
@end example

El uso de secuencias de escape para puntos de código superiores a 127 está bien en pequeñas dosis, pero se convierte en una molestia si está utilizando muchos caracteres acentuados, como lo haría en un programa con mensajes en francés o algún otro lenguaje que utilice acento. También puede ensamblar cadenas usando la función incorporada @ref{167d,,chr()}, pero esto es aún más tedioso.

Idealmente, desearía poder escribir literales en la codificación natural de su idioma. Luego, puede editar el código fuente de Python con su editor favorito, que mostrará los caracteres acentuados de forma natural y tendrá los caracteres correctos utilizados en tiempo de ejecución.

Python soporta la escritura de código fuente en UTF-8 de forma predeterminada, pero puede usar casi cualquier codificación si declara la codificación que está utilizando. Esto se hace mediante la inclusión de un comentario especial en la primera o segunda línea del archivo fuente:

@example
#!/usr/bin/env python
# -*- coding: latin-1 -*-

u = 'abcdé'
print(ord(u[-1]))
@end example

La sintaxis está inspirada en la notación de Emacs para especificar variables locales a un archivo. Emacs admite muchas variables diferentes, pero Python solo admite `“coding”'. Los símbolos @code{- * -} indican a Emacs que el comentario es especial; no tienen importancia para Python pero son una convención. Python busca @code{coding: name} o @code{coding=name} en el comentario.

Si no incluye dicho comentario, la codificación predeterminada utilizada será UTF-8 como ya se mencionó. Ver también 
@geindex Python Enhancement Proposals; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} para más información.

@node Propiedades Unicode,Comparando cadenas,Literales Unicode en código fuente Python,Soporte Unicode de Python
@anchor{howto/unicode unicode-properties}@anchor{4f3d}
@subsubsection Propiedades Unicode


La especificación Unicode incluye una base de datos de información sobre puntos de código. Para cada punto de código definido, la información incluye el nombre del carácter, su categoría, el valor numérico si corresponde (para caracteres que representan conceptos numéricos como los números romanos, fracciones como un tercio y cuatro quintos, etc.). También hay propiedades relacionadas con la visualización, como cómo usar el punto de código en texto bidireccional.

El siguiente programa muestra información sobre varios caracteres e imprime el valor numérico de un carácter en particular:

@example
import unicodedata

u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)

for i, c in enumerate(u):
    print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
    print(unicodedata.name(c))

# Get numeric value of second character
print(unicodedata.numeric(u[1]))
@end example

Cuando se ejecuta, este imprime:

@example
0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
1 0bf2 No TAMIL NUMBER ONE THOUSAND
2 0f84 Mn TIBETAN MARK HALANTA
3 1770 Lo TAGBANWA LETTER SA
4 33af So SQUARE RAD OVER S SQUARED
1000.0
@end example

Los códigos de categoría son abreviaturas que describen la naturaleza del personaje. Estos se agrupan en categorías como «Letra», «Número», «Puntuación» o «Símbolo», que a su vez se dividen en subcategorías. Para tomar los códigos de la salida anterior, @code{'Ll'} significa “Letra, minúscula “, @code{'No'} significa «Número, otro», @code{'Mn'} es «Marca, sin espacios» , y @code{'So'} es «Símbolo, otro». Consulte la sección Valores de categoría generales de la documentación de la base de datos de caracteres Unicode@footnote{https://www.unicode.org/reports/tr44/#General_Category_Values} para obtener una lista de códigos de categoría.

@node Comparando cadenas,Expresiones regulares Unicode,Propiedades Unicode,Soporte Unicode de Python
@anchor{howto/unicode comparing-strings}@anchor{4f3e}
@subsubsection Comparando cadenas


Unicode agrega algunas complicaciones a la comparación de cadenas, porque el mismo conjunto de caracteres puede representarse mediante diferentes secuencias de puntos de código. Por ejemplo, una letra como “ê” puede representarse como un único punto de código U+00EA, o como U+0065 U+0302, que es el punto de código para “e” seguido de un punto de código para “COMBINING CIRCUMFLEX ACCENT” . Estos producirán la misma salida cuando se impriman, pero uno es una cadena de longitud 1 y el otro es de longitud 2.

Una herramienta para una comparación que no distingue entre mayúsculas y minúsculas es el método @ref{e5b,,casefold()} que convierte una cadena en una forma que no distingue entre mayúsculas y minúsculas siguiendo un algoritmo descrito por el estándar Unicode. Este algoritmo tiene un manejo especial para caracteres como la letra Alemana “ß” (punto de código U+00DF), que se convierte en el par de letras minúsculas “ss”.

@example
>>> street = 'Gürzenichstraße'
>>> street.casefold()
'gürzenichstrasse'
@end example

A second tool is the @ref{105,,unicodedata} module’s
@ref{775,,normalize()} function that converts strings to one
of several normal forms, where letters followed by a combining character are
replaced with single characters.  @ref{775,,normalize()} can
be used to perform string comparisons that won’t falsely report
inequality if two strings use combining characters differently:

@example
import unicodedata

def compare_strs(s1, s2):
    def NFD(s):
        return unicodedata.normalize('NFD', s)

    return NFD(s1) == NFD(s2)

single_char = 'ê'
multiple_chars = '\N@{LATIN SMALL LETTER E@}\N@{COMBINING CIRCUMFLEX ACCENT@}'
print('length of first string=', len(single_char))
print('length of second string=', len(multiple_chars))
print(compare_strs(single_char, multiple_chars))
@end example

Cuando se ejecuta, esto genera:

@example
$ python compare-strs.py
length of first string= 1
length of second string= 2
True
@end example

El primer argumento para la función @ref{775,,normalize()} es una cadena que proporciona la forma de normalización deseada, que puede ser una de “NFC”, “NFKC”, “NFD” y “NFKD”.

El estándar Unicode también especifica cómo hacer comparaciones sin mayúsculas y minúsculas:

@example
import unicodedata

def compare_caseless(s1, s2):
    def NFD(s):
        return unicodedata.normalize('NFD', s)

    return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold())

# Example usage
single_char = 'ê'
multiple_chars = '\N@{LATIN CAPITAL LETTER E@}\N@{COMBINING CIRCUMFLEX ACCENT@}'

print(compare_caseless(single_char, multiple_chars))
@end example

This will print @code{True}.  (Why is @code{NFD()} invoked twice?  Because
there are a few characters that make @ref{e5b,,casefold()} return a
non-normalized string, so the result needs to be normalized again. See
section 3.13 of the Unicode Standard for a discussion and an example.)

@node Expresiones regulares Unicode,Referencias<4>,Comparando cadenas,Soporte Unicode de Python
@anchor{howto/unicode unicode-regular-expressions}@anchor{4f3f}
@subsubsection Expresiones regulares Unicode


Las expresiones regulares soportadas por el módulo @ref{b9,,re} se pueden proporcionar como bytes o cadenas. Algunas de las secuencias de caracteres especiales como @code{\d} y @code{\w} tienen diferentes significados dependiendo de si el patrón se suministra como bytes o una cadena. Por ejemplo, @code{\d} coincidirá con los caracteres @code{[0-9]} en bytes, pero en las cadenas coincidirá con cualquier carácter que esté en la categoría @code{'Nd'}.

La cadena en este ejemplo tiene el número 57 escrito en números tailandeses y árabes:

@example
import re
p = re.compile(r'\d+')

s = "Over \u0e55\u0e57 57 flavours"
m = p.search(s)
print(repr(m.group()))
@end example

Cuando se ejecuta, @code{\d+} coincidirá con los números tailandeses y los imprimirá. Si proporciona el indicador @ref{6cd,,re.ASCII} a @ref{c5b,,compile()}, @code{\d+} coincidirá con la subcadena «57» en su lugar.

Del mismo modo, @code{\w} coincide con una amplia variedad de caracteres Unicode pero solo @code{[a-zA-Z0-9_]} en bytes o si @ref{6cd,,re.ASCII} se suministra, y @code{\s} coincidirá con los caracteres de espacio en blanco Unicode o @code{[ \t\n\r\f\v]}.

@node Referencias<4>,,Expresiones regulares Unicode,Soporte Unicode de Python
@anchor{howto/unicode id2}@anchor{4f40}
@subsubsection Referencias


@c comment should these be mentioned earlier, e.g. at the start of the "introduction to Unicode" first section?

Algunas buenas discusiones alternativas sobre el soporte Unicode de Python son:


@itemize *

@item 
Processing Text Files in Python 3@footnote{https://python-notes.curiousefficiency.org/en/latest/python3/text_file_processing.html}, by Nick Coghlan.

@item 
Pragmatic Unicode@footnote{https://nedbatchelder.com/text/unipain.html}, una presentación de `Ned Batchelder' en PyCon 2012.
@end itemize

El tipo @ref{237,,str} se describe en la referencia de la biblioteca de Python en @ref{1c04,,Cadenas de caracteres — str}.

La documentación para el módulo @ref{105,,unicodedata}.

La documentación para el módulo @ref{1c,,codecs}.

`Marc-André Lemburg' hizo una presentación titulada "Python and Unicode" (diapositivas en PDF)@footnote{https://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf} en EuroPython 2002. Las diapositivas son una excelente descripción general del diseño de las características Unicode de Python 2 (donde el tipo de cadena Unicode se llama @code{unicode} y los literales comienzan con @code{u}).

@node Leyendo y escribiendo datos Unicode,Agradecimientos<10>,Soporte Unicode de Python,CÓMO HOWTO Unicode
@anchor{howto/unicode reading-and-writing-unicode-data}@anchor{4f41}
@subsection Leyendo y escribiendo datos Unicode


Una vez que haya escrito un código que funcione con datos Unicode, el siguiente problema es la entrada/salida. ¿Cómo obtiene cadenas Unicode en su programa y cómo convierte Unicode en una forma adecuada para almacenamiento o transmisión?

Es posible que no necesite hacer nada dependiendo de sus fuentes de entrada y destinos de salida; debe verificar si las bibliotecas utilizadas en su aplicación son compatibles con Unicode de forma nativa. Los analizadores XML a menudo retornan datos Unicode, por ejemplo. Muchas bases de datos relacionales también admiten columnas con valores Unicode y pueden retornar valores Unicode de una consulta SQL.

Los datos Unicode generalmente se convierten a una codificación particular antes de escribirse en el disco o enviarse a través de un socket. Es posible hacer todo el trabajo usted mismo: abra un archivo, lea un objeto de bytes de 8 bits y convierta los bytes con @code{bytes.decode(codificación)}. Sin embargo, no se recomienda el enfoque manual.

Un problema es la naturaleza de múltiples bytes de las codificaciones; Un carácter Unicode puede ser representado por varios bytes. Si desea leer el archivo en fragmentos de tamaño arbitrario (por ejemplo, 1024 o 4096 bytes), debe escribir un código de manejo de errores para detectar el caso en el que solo una parte de los bytes que codifican un solo carácter Unicode se leen al final de Un trozo. Una solución sería leer todo el archivo en la memoria y luego realizar la decodificación, pero eso le impide trabajar con archivos que son extremadamente grandes; si necesita leer un archivo de 2 GB, necesita 2 GB de RAM. (Más, realmente, ya que por al menos un momento necesitarías tener tanto la cadena codificada como su versión Unicode en la memoria).

La solución sería utilizar la interfaz de decodificación de bajo nivel para detectar el caso de secuencias de codificación parcial. El trabajo de implementar esto ya se ha realizado para usted: la función incorporada @ref{1be,,open()} puede retornar un objeto similar a un archivo que asume que el contenido del archivo está en una codificación especificada y acepta parámetros Unicode para métodos como @ref{1c8c,,read()} y @ref{1c7a,,write()}. Esto funciona a través de los parámetros `enconding' y `errors' de @ref{1be,,open()} que se interpretan como los de @ref{96c,,str.encode()} y @ref{96d,,bytes.decode()}.

Por lo tanto, leer Unicode de un archivo es simple:

@example
with open('unicode.txt', encoding='utf-8') as f:
    for line in f:
        print(repr(line))
@end example

También es posible abrir archivos en modo de actualización, lo que permite leer y escribir:

@example
with open('test', encoding='utf-8', mode='w+') as f:
    f.write('\u4500 blah blah blah\n')
    f.seek(0)
    print(repr(f.readline()[:1]))
@end example

El carácter Unicode @code{U+FEFF} se usa como marca de orden de bytes (BOM), y a menudo se escribe como el primer carácter de un archivo para ayudar a la auto detección del orden de bytes del archivo. Algunas codificaciones, como UTF-16, esperan que haya una BOM al comienzo de un archivo; cuando se utiliza dicha codificación, la BOM se escribirá automáticamente como el primer carácter y se descartará en silencio cuando se lea el archivo. Existen variantes de estas codificaciones, como “utf-16-le” y “utf-16-be” para codificaciones “little-endian” y “big-endian”, que especifican un orden de bytes particular y no omiten la BOM.

En algunas áreas, también es convencional usar una «BOM» al comienzo de los archivos codificados UTF-8; el nombre es engañoso ya que UTF-8 no depende del orden de bytes. La marca simplemente anuncia que el archivo está codificado en UTF-8. Para leer dichos archivos, use el códec “utf-8-sig” para omitir automáticamente la marca si está presente.

@menu
* Nombres de archivos Unicode:: 
* Consejos para escribir programas compatibles con Unicode:: 
* Referencias: Referencias<5>. 

@end menu

@node Nombres de archivos Unicode,Consejos para escribir programas compatibles con Unicode,,Leyendo y escribiendo datos Unicode
@anchor{howto/unicode unicode-filenames}@anchor{4f42}
@subsubsection Nombres de archivos Unicode


La mayoría de los sistemas operativos de uso común en la actualidad admiten nombres de archivo que contienen caracteres Unicode arbitrarios. Por lo general, esto se implementa convirtiendo la cadena Unicode en una codificación que varía según el sistema. Hoy Python está convergiendo en el uso de UTF-8: Python en MacOS ha usado UTF-8 para varias versiones, y Python 3.6 también ha cambiado a usar UTF-8 en Windows. En los sistemas Unix, solo habrá un @ref{5dd,,filesystem encoding}. si ha configurado las variables de entorno @code{LANG} o @code{LC_CTYPE}; si no lo ha hecho, la codificación predeterminada es nuevamente UTF-8.

La función @ref{ce1,,sys.getfilesystemencoding()} retorna la codificación para usar en su sistema actual, en caso de que desee realizar la codificación manualmente, pero no hay muchas razones para molestarse. Al abrir un archivo para leer o escribir, generalmente puede proporcionar la cadena Unicode como nombre de archivo, y se convertirá automáticamente a la codificación correcta para usted:

@example
filename = 'filename\u4500abc'
with open(filename, 'w') as f:
    f.write('blah\n')
@end example

Las funciones en el módulo @ref{a1,,os} como @ref{548,,os.stat()} también aceptarán nombres de archivo Unicode.

La función @ref{116c,,os.listdir()} retorna nombres de archivo, lo que plantea un problema: ¿debería devolver la versión Unicode de los nombres de archivo o debería devolver bytes que contienen las versiones codificadas? @ref{116c,,os.listdir()} puede hacer ambas cosas, dependiendo de si proporcionó la ruta del directorio como bytes o una cadena Unicode. Si pasa una cadena Unicode como ruta, los nombres de archivo se decodificarán utilizando la codificación del sistema de archivos y se devolverá una lista de cadenas Unicode, mientras que pasar una ruta de bytes devolverá los nombres de archivo como bytes. Por ejemplo, suponiendo que el @ref{5dd,,filesystem encoding} predeterminado es UTF-8, al ejecutar el siguiente programa:

@example
fn = 'filename\u4500abc'
f = open(fn, 'w')
f.close()

import os
print(os.listdir(b'.'))
print(os.listdir('.'))
@end example

producirá la siguiente salida:

@example
$ python listdir-test.py
[b'filename\xe4\x94\x80abc', ...]
['filename\u4500abc', ...]
@end example

La primera lista contiene nombres de archivos codificados con UTF-8, y la segunda lista contiene las versiones Unicode.

Tenga en cuenta que en la mayoría de las ocasiones, debe seguir usando Unicode con estas API. Las API de bytes solo deben usarse en sistemas donde pueden estar presentes nombres de archivo no codificables; eso es prácticamente solo sistemas Unix ahora.

@node Consejos para escribir programas compatibles con Unicode,Referencias<5>,Nombres de archivos Unicode,Leyendo y escribiendo datos Unicode
@anchor{howto/unicode tips-for-writing-unicode-aware-programs}@anchor{4f43}
@subsubsection Consejos para escribir programas compatibles con Unicode


Esta sección proporciona algunas sugerencias sobre cómo escribir software que maneje Unicode.

El consejo más importante es:

@quotation

El software solo debería funcionar con cadenas Unicode internamente, decodificando los datos de entrada lo antes posible y codificando la salida solo al final.
@end quotation

Si intenta escribir funciones de procesamiento que acepten cadenas Unicode y de bytes, encontrará que su programa es vulnerable a errores dondequiera que combine los dos tipos diferentes de cadenas. No hay codificación o decodificación automática: si hace, por ejemplo: @code{str+bytes}, un @ref{228,,TypeError} se generará.

Cuando se usan datos que provienen de un navegador web u otra fuente no confiable, una técnica común es verificar si hay caracteres ilegales en una cadena antes de usar la cadena en una línea de comando generada o almacenarla en una base de datos. Si está haciendo esto, tenga cuidado de verificar la cadena decodificada, no los datos de bytes codificados; Algunas codificaciones pueden tener propiedades interesantes, como no ser biyectivo o no ser totalmente compatible con ASCII. Esto es especialmente cierto si los datos de entrada también especifican la codificación, ya que el atacante puede elegir una forma inteligente de ocultar el texto malicioso en el flujo de bytes codificado.

@menu
* Conversión entre codificaciones de archivo:: 
* Archivos en una codificación desconocida:: 

@end menu

@node Conversión entre codificaciones de archivo,Archivos en una codificación desconocida,,Consejos para escribir programas compatibles con Unicode
@anchor{howto/unicode converting-between-file-encodings}@anchor{4f44}
@subsubsection Conversión entre codificaciones de archivo


La clase @ref{19fa,,StreamRecoder} puede convertir de forma transparente entre codificaciones, tomar una secuencia que retorna datos en la codificación 1 y comportarse como una secuencia que retorna datos en la codificación 2.

Por ejemplo, si tiene un archivo de entrada `f' que está en Latin-1, puede envolverlo con @ref{19fa,,StreamRecoder} para retornar bytes codificados en UTF-8:

@example
new_f = codecs.StreamRecoder(f,
    # en/decoder: used by read() to encode its results and
    # by write() to decode its input.
    codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'),

    # reader/writer: used to read and write to the stream.
    codecs.getreader('latin-1'), codecs.getwriter('latin-1') )
@end example

@node Archivos en una codificación desconocida,,Conversión entre codificaciones de archivo,Consejos para escribir programas compatibles con Unicode
@anchor{howto/unicode files-in-an-unknown-encoding}@anchor{4f45}
@subsubsection Archivos en una codificación desconocida


¿Qué puede hacer si necesita hacer un cambio en un archivo, pero no conoce la codificación del archivo? Si sabe que la codificación es compatible con ASCII y solo desea examinar o modificar las partes ASCII, puede abrir el archivo con el manejador de errores @code{surrogateescape}:

@example
with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f:
    data = f.read()

# make changes to the string 'data'

with open(fname + '.new', 'w',
          encoding="ascii", errors="surrogateescape") as f:
    f.write(data)
@end example

El manejador de errores @code{surrogateescape} decodificará los bytes que no sean ASCII como puntos de código en un rango especial que va desde U+DC80 a U+DCFF. Estos puntos de código volverán a convertirse en los mismos bytes cuando se use el controlador de error @code{subrogateescape} para codificar los datos y volver a escribirlos.

@node Referencias<5>,,Consejos para escribir programas compatibles con Unicode,Leyendo y escribiendo datos Unicode
@anchor{howto/unicode id3}@anchor{4f46}
@subsubsection Referencias


One section of Mastering Python 3 Input/Output@footnote{https://pyvideo.org/video/289/pycon-2010--mastering-python-3-i-o},
a PyCon 2010 talk by David Beazley, discusses text processing and binary data handling.

El PDF slides for Marc-André Lemburg's presentation "Writing Unicode-aware Applications in Python"@footnote{https://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf} discute cuestiones de codificaciones de caracteres, así como también cómo internacionalizar y localizar una aplicación. Estas diapositivas cubren solo Python 2.x.

The Guts of Unicode in Python@footnote{https://pyvideo.org/video/1768/the-guts-of-unicode-in-python}
is a PyCon 2013 talk by Benjamin Peterson that discusses the internal Unicode
representation in Python 3.3.

@node Agradecimientos<10>,,Leyendo y escribiendo datos Unicode,CÓMO HOWTO Unicode
@anchor{howto/unicode acknowledgements}@anchor{4f47}
@subsection Agradecimientos


El borrador inicial de este documento fue escrito por `Andrew Kuchling'. Desde entonces ha sido revisado por `Alexander Belopolsky, Georg Brandl, Andrew Kuchling y Ezio Melotti'.

293/5000
Gracias a las siguientes personas que notaron errores u ofrecieron sugerencias sobre este artículo: `Éric Araujo, Nicholas Bastin, Nick Coghlan, Marius Gedminas, Kent Johnson, Ken Krugler, Marc-André Lemburg, Martin von Löwis, Terry J. Reedy, Serhiy Storchaka , Eryk Sun, Chad Whitacre, Graham Wideman'.

@node HOWTO - Cómo obtener recursos de Internet con el paquete urllib,Introducción al modulo ipaddress,CÓMO HOWTO Unicode,Comos HOWTOs de Python
@anchor{howto/urllib2 doc}@anchor{4f48}@anchor{howto/urllib2 howto-fetch-internet-resources-using-the-urllib-package}@anchor{4f49}@anchor{howto/urllib2 urllib-howto}@anchor{3940}
@section HOWTO - Cómo obtener recursos de Internet con el paquete urllib


@*Autor: 
Michael Foord@footnote{https://agileabstractions.com/}


@menu
* Introducción: Introducción<14>. 
* Obtención de URLs:: 
* Gestión de excepciones:: 
* info y geturl:: 
* Objetos de Apertura (Openers) y Gestores (Handlers): Objetos de Apertura Openers y Gestores Handlers. 
* Autenticación básica:: 
* Proxies:: 
* Sockets y capas:: 
* Notas a pie de página:: 

@end menu

@node Introducción<14>,Obtención de URLs,,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 introduction}@anchor{4f4a}
@subsection Introducción


@subsubheading Related Articles



También puedes encontrar útil el siguiente artículo sobre la obtención de recursos web con Python:


@itemize *

@item 
Basic Authentication@footnote{http://www.voidspace.org.uk/python/articles/authentication.shtml}

@quotation

Un tutorial sobre `Autenticación Básica', con ejemplos en Python.
@end quotation
@end itemize

`urllib.request' es un módulo Python para acceder y utilizar recursos de internet identificados por URLs (`Uniform Resource Locators'). Ofrece una interfaz muy simple, a través de la función `urlopen'. Esta función es capaz de acceder a URLs usando una variedad de protocolos diferentes. También ofrece una interfaz un poco más compleja para manejar situaciones comunes - como la autenticación básica, cookies y proxies, entre otros. Estos son proporcionados por los llamados objetos de apertura y gestores.

urllib.request soporta la obtención de recursos identificados por URLs para muchos «esquemas de URL» (identificados por la cadena de texto ubicada antes del @code{":"} en el URL - por ejemplo @code{"ftp"} es el esquema de URL de @code{"ftp://python.org/"}) usando sus protocolos de red asociados (por ejemplo FTP, HTTP). Este tutorial se centra en el caso más común, HTTP.

Para situaciones sencillas `urlopen' es muy fácil de usar. Pero tan pronto como encuentres errores o casos no triviales al abrir URLs HTTP, necesitarás entender el Protocolo de Transferencia de Hipertexto. La referencia más completa y autorizada para HTTP es 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. Este es un documento técnico y no pretende ser fácil de leer. Este HOWTO tiene como objetivo ilustrar el uso de la `urllib', con suficientes detalles sobre HTTP para ayudarte a entenderlo. No pretende reemplazar los documentos @ref{10b,,urllib.request}, pero es complementario a ellos.

@node Obtención de URLs,Gestión de excepciones,Introducción<14>,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 fetching-urls}@anchor{4f4b}
@subsection Obtención de URLs


La forma más simple de usar urllib.request es la siguiente:

@example
import urllib.request
with urllib.request.urlopen('http://python.org/') as response:
   html = response.read()
@end example

Si deseas recuperar un recurso a partir de la URL y almacenarlo en una ubicación temporal, puede hacerlo a través de las funciones @ref{aee,,shutil.copyfileobj()} y @ref{56d,,tempfile.NamedTemporaryFile()}:

@example
import shutil
import tempfile
import urllib.request

with urllib.request.urlopen('http://python.org/') as response:
    with tempfile.NamedTemporaryFile(delete=False) as tmp_file:
        shutil.copyfileobj(response, tmp_file)

with open(tmp_file.name) as html:
    pass
@end example

Muchos usos de urllib serán así de sencillos (nótese que en lugar de una URL “http:” podríamos haber usado una URL que empezara por “ftp:”, “file:”, etc.).  Sin embargo, el propósito de este tutorial es explicar los casos más complicados, concentrándose en el HTTP.

HTTP se basa en peticiones y respuestas - el cliente hace peticiones y los servidores envían respuestas. urllib.request refleja esto con un objeto @code{Request} que representa la petición HTTP que estás haciendo. En su forma más simple se crea un objeto Request que especifica la URL que se quiere obtener. Llamar a @code{urlopen} con este objeto Request retorna un objeto respuesta para la URL solicitada. Esta respuesta es un objeto tipo archivo, lo que significa que puedes por ejemplo llamar a @code{.read()} en la respuesta:

@example
import urllib.request

req = urllib.request.Request('http://python.org/')
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

Tenga en cuenta que urllib.request utiliza la misma interfaz de Request para gestionar todos los esquemas de URL.  Por ejemplo, puedes hacer una petición FTP de la siguiente manera:

@example
req = urllib.request.Request('ftp://example.com/')
@end example

En el caso de HTTP, hay dos cosas adicionales que los objetos Request le permiten hacer: Primero, puede pasar datos para enviarlos al servidor. En segundo lugar, puede pasar información adicional («metadatos») `about' los datos o sobre la solicitud en sí, al servidor; esta información se envía como «encabezados» HTTP. Veamos cada uno de estos por turno.

@menu
* Datos:: 
* Encabezados (Headers): Encabezados Headers. 

@end menu

@node Datos,Encabezados Headers,,Obtención de URLs
@anchor{howto/urllib2 data}@anchor{4f4c}
@subsubsection Datos


A veces quieres enviar datos a una URL (a menudo la URL se referirá a un script CGI (Common Gateway Interface) u otra aplicación web). Con HTTP, esto se hace a menudo usando lo que se conoce como una petición `POST'. Esto es a menudo lo que su navegador hace cuando envías un formulario HTML que has rellenado en la web. No todos los POSTs tienen que provenir de formularios: puedes usar un POST para transmitir datos arbitrarios a tu propia aplicación. En el caso común de los formularios HTML, los datos tienen que ser codificados de forma estándar, y luego pasados al objeto Request como el argumento @code{data}. La codificación se hace usando una función de la biblioteca @code{urllib.parse`}.

@example
import urllib.parse
import urllib.request

url = 'http://www.someserver.com/cgi-bin/register.cgi'
values = @{'name' : 'Michael Foord',
          'location' : 'Northampton',
          'language' : 'Python' @}

data = urllib.parse.urlencode(values)
data = data.encode('ascii') # data should be bytes
req = urllib.request.Request(url, data)
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

Ten en cuenta que a veces se requieren otras codificaciones (por ejemplo, para la carga de archivos desde formularios HTML - ver HTML Specification@comma{} Form Submission@footnote{https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13} para más detalles).

Si no pasas el argumento @code{data}, urllib usa una petición `GET'. Una de las formas en la que las peticiones GET y POST difieren entre sí es que las peticiones POST a menudo tienen «efectos secundarios»: cambian el estado del sistema de alguna manera (por ejemplo, haciendo una petición al sitio para que un centenar de spam chatarra sea entregado a tu dirección).  Aunque el estándar HTTP deja claro que las solicitudes POST están `siempre' destinadas a causar efectos secundarios, y las solicitudes GET a `nunca' causar efectos secundarios, nada impide que una solicitud GET tenga efectos secundarios, ni que una solicitud POST no tenga efectos secundarios. Los datos también pueden ser pasados en una solicitud GET HTTP codificándolos en la propia URL.

Esto se hace de la siguiente manera:

@example
>>> import urllib.request
>>> import urllib.parse
>>> data = @{@}
>>> data['name'] = 'Somebody Here'
>>> data['location'] = 'Northampton'
>>> data['language'] = 'Python'
>>> url_values = urllib.parse.urlencode(data)
>>> print(url_values)  # The order may differ from below.  
name=Somebody+Here&language=Python&location=Northampton
>>> url = 'http://www.example.com/example.cgi'
>>> full_url = url + '?' + url_values
>>> data = urllib.request.urlopen(full_url)
@end example

Nota que la URL completa se crea añadiendo un @code{?} a la URL, seguido de los valores codificados.

@node Encabezados Headers,,Datos,Obtención de URLs
@anchor{howto/urllib2 headers}@anchor{4f4d}
@subsubsection Encabezados (Headers)


Discutiremos aquí un encabezado HTTP en particular, para ilustrar cómo agregar encabezados a su solicitud HTTP.

A algunos sitios web @footnote{
Google por ejemplo.
} no les gusta ser navegados por programas, o envían diferentes versiones a diferentes navegadores @footnote{
El rastreo de navegadores es una práctica muy mala para el diseño de sitios web - construir sitios usando estándares web es mucho más sensato. Desafortunadamente muchos sitios siguen enviando versiones diferentes a diferentes navegadores.
}. Por defecto urllib se identifica como @code{Python-urllib/x.y} (donde @code{x} y @code{y} son los números mayor y menor de la versión de Python, por ejemplo @code{Python-urllib/2.5}), lo que puede confundir el sitio, o simplemente no funcionar. La forma en que un navegador se identifica a sí mismo es a través del encabezado @code{User-Agent} @footnote{
El agente de usuario para MSIE 6 es `“Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)”'
}. Cuando creas un objeto Request puedes pasarle un diccionario de encabezados. El siguiente ejemplo hace la misma petición que arriba, pero se identifica como una versión de Internet Explorer @footnote{
Para detalles de más encabezados de peticiones HTTP, ver @uref{https://jkorpela.fi/http.html,Quick Reference to HTTP Headers}.
}.

@example
import urllib.parse
import urllib.request

url = 'http://www.someserver.com/cgi-bin/register.cgi'
user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)'
values = @{'name': 'Michael Foord',
          'location': 'Northampton',
          'language': 'Python' @}
headers = @{'User-Agent': user_agent@}

data = urllib.parse.urlencode(values)
data = data.encode('ascii')
req = urllib.request.Request(url, data, headers)
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

La respuesta también tiene dos métodos útiles. Ver la sección de @ref{4f4e,,info y geturl} que viene después de que echemos un vistazo a lo que pasa cuando las cosas van mal.

@node Gestión de excepciones,info y geturl,Obtención de URLs,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 handling-exceptions}@anchor{4f4f}
@subsection Gestión de excepciones


`urlopen' raises @ref{38cb,,URLError} when it cannot handle a response (though as
usual with Python APIs, built-in exceptions such as @ref{360,,ValueError},
@ref{228,,TypeError} etc. may also be raised).

@ref{105d,,HTTPError} is the subclass of @ref{38cb,,URLError} raised in the specific case of
HTTP URLs.

Las clases de excepción se exportan desde el módulo @ref{109,,urllib.error}.

@menu
* URLError:: 
* HTTPError:: 
* Resumiéndolo:: 

@end menu

@node URLError,HTTPError,,Gestión de excepciones
@anchor{howto/urllib2 urlerror}@anchor{4f50}
@subsubsection URLError


A menudo, URLError se genera porque no hay conexión de red (no se encuentra ruta al servidor especificado), o el servidor especificado no existe.  En este caso, la excepción generada tendrá un atributo «reason», que es una tupla que contiene un código de error y un mensaje de error de texto.

por ejemplo

@example
>>> req = urllib.request.Request('http://www.pretend_server.org')
>>> try: urllib.request.urlopen(req)
... except urllib.error.URLError as e:
...     print(e.reason)      
...
(4, 'getaddrinfo failed')
@end example

@node HTTPError,Resumiéndolo,URLError,Gestión de excepciones
@anchor{howto/urllib2 httperror}@anchor{4f51}
@subsubsection HTTPError


Every HTTP response from the server contains a numeric «status code». Sometimes
the status code indicates that the server is unable to fulfil the request. The
default handlers will handle some of these responses for you (for example, if
the response is a «redirection» that requests the client fetch the document from
a different URL, urllib will handle that for you). For those it can’t handle,
urlopen will raise an @ref{105d,,HTTPError}. Typical errors include “404” (page not
found), “403” (request forbidden), and “401” (authentication required).

Vea la sección 10 de 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} para una referencia sobre todos los códigos de error HTTP.

The @ref{105d,,HTTPError} instance raised will have an integer “code” attribute, which
corresponds to the error sent by the server.

@menu
* Códigos de error:: 

@end menu

@node Códigos de error,,,HTTPError
@anchor{howto/urllib2 error-codes}@anchor{4f52}
@subsubsection Códigos de error


Debido a que los gestores por defecto gestionan redirecciones (códigos en el rango de 300), y que los códigos en el rango de 100–299 indican éxito, normalmente sólo verás códigos de error en el rango de 400–599.

@ref{3969,,http.server.BaseHTTPRequestHandler.responses} es un diccionario útil de códigos de respuesta en el que se muestran todos los códigos de respuesta utilizados por 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. El diccionario se reproduce aquí por conveniencia

@example
# Table mapping response codes to messages; entries have the
# form @{code: (shortmessage, longmessage)@}.
responses = @{
    100: ('Continue', 'Request received, please continue'),
    101: ('Switching Protocols',
          'Switching to new protocol; obey Upgrade header'),

    200: ('OK', 'Request fulfilled, document follows'),
    201: ('Created', 'Document created, URL follows'),
    202: ('Accepted',
          'Request accepted, processing continues off-line'),
    203: ('Non-Authoritative Information', 'Request fulfilled from cache'),
    204: ('No Content', 'Request fulfilled, nothing follows'),
    205: ('Reset Content', 'Clear input form for further input.'),
    206: ('Partial Content', 'Partial content follows.'),

    300: ('Multiple Choices',
          'Object has several resources -- see URI list'),
    301: ('Moved Permanently', 'Object moved permanently -- see URI list'),
    302: ('Found', 'Object moved temporarily -- see URI list'),
    303: ('See Other', 'Object moved -- see Method and URL list'),
    304: ('Not Modified',
          'Document has not changed since given time'),
    305: ('Use Proxy',
          'You must use proxy specified in Location to access this '
          'resource.'),
    307: ('Temporary Redirect',
          'Object moved temporarily -- see URI list'),

    400: ('Bad Request',
          'Bad request syntax or unsupported method'),
    401: ('Unauthorized',
          'No permission -- see authorization schemes'),
    402: ('Payment Required',
          'No payment -- see charging schemes'),
    403: ('Forbidden',
          'Request forbidden -- authorization will not help'),
    404: ('Not Found', 'Nothing matches the given URI'),
    405: ('Method Not Allowed',
          'Specified method is invalid for this server.'),
    406: ('Not Acceptable', 'URI not available in preferred format.'),
    407: ('Proxy Authentication Required', 'You must authenticate with '
          'this proxy before proceeding.'),
    408: ('Request Timeout', 'Request timed out; try again later.'),
    409: ('Conflict', 'Request conflict.'),
    410: ('Gone',
          'URI no longer exists and has been permanently removed.'),
    411: ('Length Required', 'Client must specify Content-Length.'),
    412: ('Precondition Failed', 'Precondition in headers is false.'),
    413: ('Request Entity Too Large', 'Entity is too large.'),
    414: ('Request-URI Too Long', 'URI is too long.'),
    415: ('Unsupported Media Type', 'Entity body in unsupported format.'),
    416: ('Requested Range Not Satisfiable',
          'Cannot satisfy request range.'),
    417: ('Expectation Failed',
          'Expect condition could not be satisfied.'),

    500: ('Internal Server Error', 'Server got itself in trouble'),
    501: ('Not Implemented',
          'Server does not support this operation'),
    502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),
    503: ('Service Unavailable',
          'The server cannot process the request due to a high load'),
    504: ('Gateway Timeout',
          'The gateway server did not receive a timely response'),
    505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),
    @}
@end example

When an error is raised the server responds by returning an HTTP error code
`and' an error page. You can use the @ref{105d,,HTTPError} instance as a response on the
page returned. This means that as well as the code attribute, it also has read,
geturl, and info, methods as returned by the @code{urllib.response} module:

@example
>>> req = urllib.request.Request('http://www.python.org/fish.html')
>>> try:
...     urllib.request.urlopen(req)
... except urllib.error.HTTPError as e:
...     print(e.code)
...     print(e.read())  
...
404
b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
  ...
  <title>Page Not Found</title>\n
  ...
@end example

@node Resumiéndolo,,HTTPError,Gestión de excepciones
@anchor{howto/urllib2 wrapping-it-up}@anchor{4f53}
@subsubsection Resumiéndolo


So if you want to be prepared for @ref{105d,,HTTPError} `or' @ref{38cb,,URLError} there are two
basic approaches. I prefer the second approach.

@menu
* Número 1:: 
* Número 2:: 

@end menu

@node Número 1,Número 2,,Resumiéndolo
@anchor{howto/urllib2 number-1}@anchor{4f54}
@subsubsection Número 1


@example
from urllib.request import Request, urlopen
from urllib.error import URLError, HTTPError
req = Request(someurl)
try:
    response = urlopen(req)
except HTTPError as e:
    print('The server couldn\'t fulfill the request.')
    print('Error code: ', e.code)
except URLError as e:
    print('We failed to reach a server.')
    print('Reason: ', e.reason)
else:
    # everything is fine
@end example

@cartouche
@quotation Nota 
The @code{except HTTPError} `must' come first, otherwise @code{except URLError}
will `also' catch an @ref{105d,,HTTPError}.
@end quotation
@end cartouche

@node Número 2,,Número 1,Resumiéndolo
@anchor{howto/urllib2 number-2}@anchor{4f55}
@subsubsection Número 2


@example
from urllib.request import Request, urlopen
from urllib.error import URLError
req = Request(someurl)
try:
    response = urlopen(req)
except URLError as e:
    if hasattr(e, 'reason'):
        print('We failed to reach a server.')
        print('Reason: ', e.reason)
    elif hasattr(e, 'code'):
        print('The server couldn\'t fulfill the request.')
        print('Error code: ', e.code)
else:
    # everything is fine
@end example

@node info y geturl,Objetos de Apertura Openers y Gestores Handlers,Gestión de excepciones,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 info-and-geturl}@anchor{4f4e}
@subsection info y geturl


The response returned by urlopen (or the @ref{105d,,HTTPError} instance) has two
useful methods @code{info()} and @code{geturl()} and is defined in the module
@ref{10c,,urllib.response}.


@itemize *

@item 
`geturl' - retorna la verdadera URL de la página obtenida. Esto es útil porque @code{urlopen} (o el objeto de apertura utilizado) puede haber seguido una redirección. El URL de la página obtenida puede no ser el mismo que el URL solicitado.

@item 
`info' - retorna un objeto parecido a un diccionario que describe la página consultada, particularmente los encabezados enviados por el servidor. Actualmente es una instancia @ref{3980,,http.client.HTTPMessage}.
@end itemize

Los encabezados típicos incluyen “Content-length”, “Content-type” y así sucesivamente. Mira la Quick Reference to HTTP Headers@footnote{https://jkorpela.fi/http.html} para un listado útil de encabezados de HTTP con breves explicaciones de su significado y uso.

@node Objetos de Apertura Openers y Gestores Handlers,Autenticación básica,info y geturl,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 openers-and-handlers}@anchor{4f56}
@subsection Objetos de Apertura (Openers) y Gestores (Handlers)


Cuando obtienes una URL utilizas una apertura (una instancia de la quizás confusamente llamada @ref{38cc,,urllib.request.OpenerDirector}). Normalmente hemos estado usando la apertura por defecto - a través de @code{urlopen} - pero puedes crear aperturas personalizadas. Las aperturas utilizan manejadores. Todo el «trabajo pesado» lo hacen los manejadores. Cada manejador sabe cómo abrir URLs para un esquema de URL particular (http, ftp, etc.), o cómo manejar un aspecto de la apertura de URLs, por ejemplo redirecciones HTTP o cookies HTTP.

Desearás crear objetos de apertura si deseas consultar URLs con gestores específicos instalados, por ejemplo para obtener un objeto de apertura que gestione cookies, o para obtener un objeto de apertura que no gestione redireccionamientos.

Para crear un objeto de apertura, debes instanciar un @code{OpenerDirector}, y luego llamar @code{.add_handler(some_handler_instance)} repetidamente.

Alternativamente, puedes usar @code{build_opener}, que es una función conveniente para crear objetos de apertura con una sola llamada a la función.  @code{build_opener} añade varios gestores por defecto, pero proporciona una forma rápida de añadir más y/o sobrescribir los gestores por defecto.

Otros tipos de gestores que puedes querer permiten manejar proxies, autenticación, y otras situaciones comunes pero ligeramente especializadas.

@code{install_opener} puede ser usado para hacer que un objeto @code{opener} sea el objeto de apertura (global) por defecto. Esto significa que las llamadas a @code{urlopen} usarán el objeto de apertura que has instalado.

Los objetos de apertura tienen un método @code{open}, que puede ser llamado directamente para consultar urls de la misma manera que la función «urlopen»: no hay necesidad de llamar @code{install_opener}, excepto por conveniencia.

@node Autenticación básica,Proxies,Objetos de Apertura Openers y Gestores Handlers,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 id5}@anchor{4f57}
@subsection Autenticación básica


To illustrate creating and installing a handler we will use the
@code{HTTPBasicAuthHandler}. For a more detailed discussion of this subject –
including an explanation of how Basic Authentication works - see the Basic Authentication Tutorial@footnote{https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml}.

Cuando se requiere la autenticación, el servidor envía un encabezado (así como el código de error 401) solicitando la autenticación.  Esto especifica el esquema de autenticación y un “realm”. El encabezado tiene el siguiente aspecto: @code{WWW-Authenticate: SCHEME realm="REALM"}.

por ejemplo.

@example
WWW-Authenticate: Basic realm="cPanel Users"
@end example

El cliente debe entonces volver a intentar la solicitud con el nombre y la contraseña apropiados para el realm incluido como encabezamiento en la solicitud. Esto es “autenticación básica”. Para simplificar este proceso podemos crear una instancia de @code{HTTPBasicAuthHandler} y un objeto de apertura para usar este manejador.

El @code{HTTPBasicAuthHandler} utiliza un objeto llamado administrador de contraseñas para gestionar el mapeo de URLs y realms con contraseñas y nombres de usuario. Si sabes cuál es el realm (por el encabezado de autenticación enviado por el servidor), entonces puedes usar un @code{HTTPPasswordMgr}. Frecuentemente a uno no le importa cuál es el realm. En ese caso, es conveniente usar «HTTPPasswordMgrWithDefaultRealm». Esto te permite especificar un nombre de usuario y una contraseña por defecto para una URL. Esto será suministrado en caso de que no proporciones una combinación alternativa para un realm específico. Lo indicamos proporcionando @code{None} como el argumento del realm al método @code{add_password}.

La URL de primer nivel es la primera URL que requiere autenticación. Las URLs «más profundas» que la URL que pasas a .add_password() también coincidirán.

@example
# create a password manager
password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()

# Add the username and password.
# If we knew the realm, we could use it instead of None.
top_level_url = "http://example.com/foo/"
password_mgr.add_password(None, top_level_url, username, password)

handler = urllib.request.HTTPBasicAuthHandler(password_mgr)

# create "opener" (OpenerDirector instance)
opener = urllib.request.build_opener(handler)

# use the opener to fetch a URL
opener.open(a_url)

# Install the opener.
# Now all calls to urllib.request.urlopen use our opener.
urllib.request.install_opener(opener)
@end example

@cartouche
@quotation Nota 
In the above example we only supplied our @code{HTTPBasicAuthHandler} to
@code{build_opener}. By default openers have the handlers for normal situations
– @code{ProxyHandler} (if a proxy setting such as an @code{http_proxy}
environment variable is set), @code{UnknownHandler}, @code{HTTPHandler},
@code{HTTPDefaultErrorHandler}, @code{HTTPRedirectHandler}, @code{FTPHandler},
@code{FileHandler}, @code{DataHandler}, @code{HTTPErrorProcessor}.
@end quotation
@end cartouche

@code{top_level_url} es de hecho `o' una URL completa (incluyendo el componente del esquema “http:” y el nombre del host y opcionalmente el número de puerto) p.ej. @code{"http://example.com/"} `o' una «autoridad» (esto es, el nombre del host, incluyendo opcionalmente el número de puerto) por ejemplo @code{"example.com"} o @code{"example.com:8080"} (este último ejemplo incluye un número de puerto).  La autoridad, si está presente, NO debe contener el componente «userinfo» - por ejemplo @code{"joe:password@@example.com"} no es correcto.

@node Proxies,Sockets y capas,Autenticación básica,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 proxies}@anchor{4f58}
@subsection Proxies


`urllib' detectará automáticamente tu configuración de proxy y la utilizará. Esto es a través de @code{ProxyHandler}, que es parte de la cadena de gestores normales cuando se detecta un ajuste de proxy.  Normalmente esto es algo bueno, pero hay ocasiones en las que puede no ser útil @footnote{
En mi caso tengo que usar un proxy para acceder a internet en el trabajo. Si intentas consultar URLs de `localhost' a través de este proxy, las bloquea. IE está configurado para usar el proxy, que urllib recoge. Para poder probar los scripts con un servidor localhost, tengo que evitar que urllib use el proxy.
}. Una forma de hacerlo es configurar nuestro propio @code{ProxyHandler}, sin proxies definidos. Esto se hace usando pasos similares a la configuración de un gestor Basic Authentication@footnote{http://www.voidspace.org.uk/python/articles/authentication.shtml}:

@example
>>> proxy_support = urllib.request.ProxyHandler(@{@})
>>> opener = urllib.request.build_opener(proxy_support)
>>> urllib.request.install_opener(opener)
@end example

@cartouche
@quotation Nota 
Actualmente @code{urllib.request} `no' soporta la consulta de ubicaciones @code{https} a través de un proxy.  Sin embargo, esto puede ser habilitado extendiendo urllib.request como se muestra en la receta @footnote{
urllib opener for SSL proxy (CONNECT method): @uref{https://code.activestate.com/recipes/456195-urrlib2-opener-for-ssl-proxy-connect-method/,ASPN Cookbook Recipe}.
}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@code{HTTP_PROXY} será ignorado si se establece una variable @code{REQUEST_METHOD}; ver la documentación en @code{getproxies`()}.
@end quotation
@end cartouche

@node Sockets y capas,Notas a pie de página,Proxies,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 sockets-and-layers}@anchor{4f59}
@subsection Sockets y capas


El soporte de Python para obtener recursos de la web funciona en capas. urllib utiliza la biblioteca @ref{6f,,http.client}, que a su vez utiliza la biblioteca de sockets.

A partir de Python 2.3 se puede especificar cuánto tiempo debe esperar un socket para obtener una respuesta antes de que se agote el tiempo de espera. Esto puede ser útil en aplicaciones que tienen que consultar páginas web. Por defecto, el módulo socket no tiene `tiempo de espera' y puede colgarse. Actualmente, el tiempo de espera de la conexión no se expone en los niveles http.client o urllib.request. Sin embargo, puede establecerse el tiempo de espera por defecto de forma global para todas los sockets usando

@example
import socket
import urllib.request

# timeout in seconds
timeout = 10
socket.setdefaulttimeout(timeout)

# this call to urllib.request.urlopen now uses the default timeout
# we have set in the socket module
req = urllib.request.Request('http://www.voidspace.org.uk')
response = urllib.request.urlopen(req)
@end example


__________________________________________________________________


@node Notas a pie de página,,Sockets y capas,HOWTO - Cómo obtener recursos de Internet con el paquete urllib
@anchor{howto/urllib2 footnotes}@anchor{4f5a}
@subsection Notas a pie de página


Este documento fue examinado y revisado por John Lee.

@c import ipaddress

@node Introducción al modulo ipaddress,Instrumentación de CPython con DTrace y SystemTap,HOWTO - Cómo obtener recursos de Internet con el paquete urllib,Comos HOWTOs de Python
@anchor{howto/ipaddress doc}@anchor{4f5b}@anchor{howto/ipaddress an-introduction-to-the-ipaddress-module}@anchor{4f5c}@anchor{howto/ipaddress ipaddress-howto}@anchor{3b68}
@section Introducción al modulo `ipaddress'


@*autor: 
Peter Moody


@*autor: 
Nick Coghlan


@subsubheading Descripción



Este documento tiene como objetivo proporcionar una introducción apacible al módulo @ref{80,,ipaddress}. Está dirigido principalmente a los usuarios que no están familiarizados con la terminología IP de redes, pero también puede ser útil para los ingenieros de red que quieren una visión general de cómo @ref{80,,ipaddress} representa los conceptos de direccionamiento IP de red.

@menu
* Creando objetos Dirección/Red/Interfaz (Address/Network/Interface): Creando objetos Dirección/Red/Interfaz Address/Network/Interface. 
* Inspeccionando objetos Dirección/Red/Interfaz (Address/Network/Interface): Inspeccionando objetos Dirección/Red/Interfaz Address/Network/Interface. 
* Redes como listas de direcciones:: 
* Comparaciones: Comparaciones<4>. 
* Uso de direcciones IP con otros módulos:: 
* Obtener más detalles cuando se produce un error en la creación de instancias:: 

@end menu

@node Creando objetos Dirección/Red/Interfaz Address/Network/Interface,Inspeccionando objetos Dirección/Red/Interfaz Address/Network/Interface,,Introducción al modulo ipaddress
@anchor{howto/ipaddress creating-address-network-interface-objects}@anchor{4f5d}
@subsection Creando objetos Dirección/Red/Interfaz (`Address/Network/Interface')


Siendo @ref{80,,ipaddress} un módulo para inspeccionar y manipular direcciones IP, la primer cosa que usted querrá hacer es crear algunos objetos. Puede utilizar @ref{80,,ipaddress} para crear objetos a partir de cadenas de caracteres y enteros.

@menu
* Nota sobre versiones IP:: 
* Direcciones IP del Host:: 
* Definiendo redes:: 
* Interfaces de host:: 

@end menu

@node Nota sobre versiones IP,Direcciones IP del Host,,Creando objetos Dirección/Red/Interfaz Address/Network/Interface
@anchor{howto/ipaddress a-note-on-ip-versions}@anchor{4f5e}
@subsubsection Nota sobre versiones IP


Para los lectores que no están particularmente familiarizados con el direccionamiento IP, es importante saber que el Protocolo de Internet (IP) se encuentra actualmente en el proceso de pasar de la versión 4 del protocolo a la versión 6. Esta transición se produce en gran parte porque la versión 4 del protocolo no proporciona suficientes direcciones para satisfacer las necesidades de todo el mundo, especialmente dado el creciente número de dispositivos con conexiones directas a Internet.

Explicando los detalles de las diferencias entre las dos versiones del protocolo está más allá del alcance de esta introducción, pero los lectores deben al menos ser conscientes de que estas dos versiones existen, y a veces será necesario forzar el uso de una versión u otra.

@node Direcciones IP del Host,Definiendo redes,Nota sobre versiones IP,Creando objetos Dirección/Red/Interfaz Address/Network/Interface
@anchor{howto/ipaddress ip-host-addresses}@anchor{4f5f}
@subsubsection Direcciones IP del Host


Las direcciones, a menudo denominadas «direcciones de host» son la unidad más básica cuando se trabaja con direccionamiento IP. La forma más sencilla de crear direcciones es usar la función de fabrica @ref{3b6a,,ipaddress.ip_address()}, que determina automáticamente si se crea una dirección IPv4 o IPv6 en función del valor pasado:

@example
>>> ipaddress.ip_address('192.0.2.1')
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address('2001:DB8::1')
IPv6Address('2001:db8::1')
@end example

Las direcciones también se pueden crear directamente a partir de enteros. Los valores que caben dentro de 32 bits se asume que son direcciones IPv4:

@example
>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address(42540766411282592856903984951653826561)
IPv6Address('2001:db8::1')
@end example

Para forzar el uso de direcciones IPv4 o IPv6, las clases relevantes se pueden invocar directamente. Esto es particularmente útil para forzar la creación de direcciones IPv6 para enteros pequeños:

@example
>>> ipaddress.ip_address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv4Address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv6Address(1)
IPv6Address('::1')
@end example

@node Definiendo redes,Interfaces de host,Direcciones IP del Host,Creando objetos Dirección/Red/Interfaz Address/Network/Interface
@anchor{howto/ipaddress defining-networks}@anchor{4f60}
@subsubsection Definiendo redes


Las direcciones de host generalmente se agrupan en redes IP, por lo que @ref{80,,ipaddress} proporciona una forma de crear, inspeccionar y manipular definiciones de red. Los objetos de red IP se construyen a partir de cadenas que definen el rango de direcciones de host que forman parte de esa red. La forma más simple para esa información es un par de «dirección de red/prefijo de red», donde el prefijo define el número de bits iniciales que se comparan para determinar si una dirección es parte de la red y la dirección de red define el valor esperado de esos bits.

En cuanto a las direcciones, se proporciona una función de fábrica que determina automáticamente la versión IP correcta:

@example
>>> ipaddress.ip_network('192.0.2.0/24')
IPv4Network('192.0.2.0/24')
>>> ipaddress.ip_network('2001:db8::0/96')
IPv6Network('2001:db8::/96')
@end example

Los objetos de red no pueden tener ningún bit de host establecido. El efecto práctico de esto es que @code{192.0.2.1/24} no describe una red. Tales definiciones se conocen como objetos de interfaz ya que la notación `ip-on-a-network' se usa comúnmente para describir interfaces de red de un ordenador en una red determinada y se describen más adelante en la siguiente sección.

De forma predeterminada, al intentar crear un objeto de red con los bits de host establecidos, se lanzará un @ref{360,,ValueError}. Para solicitar que los bits adicionales se coaccionen a cero, el flag @code{strict=False} se puede pasar al constructor:

@example
>>> ipaddress.ip_network('192.0.2.1/24')
Traceback (most recent call last):
   ...
ValueError: 192.0.2.1/24 has host bits set
>>> ipaddress.ip_network('192.0.2.1/24', strict=False)
IPv4Network('192.0.2.0/24')
@end example

Si bien la forma de cadena de caracteres ofrece mucha más flexibilidad, las redes también se pueden definir con enteros, al igual que las direcciones de host. En este caso, se considera que la red contiene solo la dirección única identificada por el entero, por lo que el prefijo de red incluye toda la dirección de red:

@example
>>> ipaddress.ip_network(3221225984)
IPv4Network('192.0.2.0/32')
>>> ipaddress.ip_network(42540766411282592856903984951653826560)
IPv6Network('2001:db8::/128')
@end example

Al igual que con las direcciones, la creación de un tipo particular de red se puede forzar llamando directamente al constructor de clase en lugar de usar la función de fábrica.

@node Interfaces de host,,Definiendo redes,Creando objetos Dirección/Red/Interfaz Address/Network/Interface
@anchor{howto/ipaddress host-interfaces}@anchor{4f61}
@subsubsection Interfaces de host


Como se mencionó anteriormente, si necesita describir una dirección en una red en particular, ni la dirección ni las clases de red son suficientes. La notación como @code{192.0.2.1/24} es comúnmente utilizada por los ingenieros de red y las personas que escriben herramientas para cortafuegos y enrutadores como abreviatura de «el host @code{192.0.2.1} en la red @code{192.0.2.0/24}», En consecuencia, @ref{80,,ipaddress} proporciona un conjunto de clases híbridas que asocian una dirección con una red en particular. La interfaz para la creación es idéntica a la de definir objetos de red, excepto que la parte de dirección no está restringida a ser una dirección de red.

@example
>>> ipaddress.ip_interface('192.0.2.1/24')
IPv4Interface('192.0.2.1/24')
>>> ipaddress.ip_interface('2001:db8::1/96')
IPv6Interface('2001:db8::1/96')
@end example

Se aceptan entradas enteras (como con las redes), y el uso de una versión IP particular se puede forzar llamando directamente al constructor relevante.

@node Inspeccionando objetos Dirección/Red/Interfaz Address/Network/Interface,Redes como listas de direcciones,Creando objetos Dirección/Red/Interfaz Address/Network/Interface,Introducción al modulo ipaddress
@anchor{howto/ipaddress inspecting-address-network-interface-objects}@anchor{4f62}
@subsection Inspeccionando objetos Dirección/Red/Interfaz (`Address/Network/Interface')


Se ha tomado la molestia de crear un objeto `IPv(4|6)(Address|Network|Interface)', por lo que probablemente desee obtener información al respecto. @ref{80,,ipaddress} intenta hacer esto fácil e intuitivo.

Extrayendo la versión IP:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr6 = ipaddress.ip_address('2001:db8::1')
>>> addr6.version
6
>>> addr4.version
4
@end example

Obteniendo la red desde una interfaz:

@example
>>> host4 = ipaddress.ip_interface('192.0.2.1/24')
>>> host4.network
IPv4Network('192.0.2.0/24')
>>> host6 = ipaddress.ip_interface('2001:db8::1/96')
>>> host6.network
IPv6Network('2001:db8::/96')
@end example

Averiguando cuántas direcciones individuales hay en una red:

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.num_addresses
256
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.num_addresses
4294967296
@end example

Iterando a través de las direcciones «utilizables» en una red:

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> for x in net4.hosts():
...     print(x)  
192.0.2.1
192.0.2.2
192.0.2.3
192.0.2.4
...
192.0.2.252
192.0.2.253
192.0.2.254
@end example

Obteniendo la máscara de red (es decir, establecer bits correspondientes al prefijo de red) o la máscara de host (cualquier bits que no forme parte de la máscara de red):

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.netmask
IPv4Address('255.255.255.0')
>>> net4.hostmask
IPv4Address('0.0.0.255')
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.netmask
IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::')
>>> net6.hostmask
IPv6Address('::ffff:ffff')
@end example

Expandiendo o comprimiendo la dirección:

@example
>>> addr6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0001'
>>> addr6.compressed
'2001:db8::1'
>>> net6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0000/96'
>>> net6.compressed
'2001:db8::/96'
@end example

Si bien IPv4 no admite expansión o compresión, los objetos asociados aún proporcionan las propiedades relevantes para que el código neutral de la versión pueda garantizar fácilmente que se use la forma más concisa o detallada para las direcciones IPv6 mientras se maneja correctamente las direcciones IPv4.

@node Redes como listas de direcciones,Comparaciones<4>,Inspeccionando objetos Dirección/Red/Interfaz Address/Network/Interface,Introducción al modulo ipaddress
@anchor{howto/ipaddress networks-as-lists-of-addresses}@anchor{4f63}
@subsection Redes como listas de direcciones


A veces es útil tratar las redes como listas. Esto significa que es posible indexarlas de esta manera:

@example
>>> net4[1]
IPv4Address('192.0.2.1')
>>> net4[-1]
IPv4Address('192.0.2.255')
>>> net6[1]
IPv6Address('2001:db8::1')
>>> net6[-1]
IPv6Address('2001:db8::ffff:ffff')
@end example

También significa que los objetos de red se prestan a usar la sintaxis del test de lista de membresía como esta:

@example
if address in network:
    # do something
@end example

Las pruebas de contención se realizan de manera eficiente según el prefijo de red:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr4 in ipaddress.ip_network('192.0.2.0/24')
True
>>> addr4 in ipaddress.ip_network('192.0.3.0/24')
False
@end example

@node Comparaciones<4>,Uso de direcciones IP con otros módulos,Redes como listas de direcciones,Introducción al modulo ipaddress
@anchor{howto/ipaddress comparisons}@anchor{4f64}
@subsection Comparaciones


@ref{80,,ipaddress} proporciona algunas formas simples e intuitivas de comparar objetos, donde esto tiene sentido:

@example
>>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
True
@end example

Se genera una excepción @ref{228,,TypeError} si intenta comparar objetos de diferentes versiones o tipos diferentes.

@node Uso de direcciones IP con otros módulos,Obtener más detalles cuando se produce un error en la creación de instancias,Comparaciones<4>,Introducción al modulo ipaddress
@anchor{howto/ipaddress using-ip-addresses-with-other-modules}@anchor{4f65}
@subsection Uso de direcciones IP con otros módulos


Otros módulos que usan direcciones IP (como @ref{cc,,socket} ) generalmente no aceptarán directamente objetos de este módulo. En su lugar, deben ser forzados a un entero o una cadena que el otro módulo deberá aceptar:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> str(addr4)
'192.0.2.1'
>>> int(addr4)
3221225985
@end example

@node Obtener más detalles cuando se produce un error en la creación de instancias,,Uso de direcciones IP con otros módulos,Introducción al modulo ipaddress
@anchor{howto/ipaddress getting-more-detail-when-instance-creation-fails}@anchor{4f66}
@subsection Obtener más detalles cuando se produce un error en la creación de instancias


Al crear objetos de dirección/red/interfaz utilizando las funciones de fábrica independientes de la versión, cualquier error se informará como @ref{360,,ValueError} con un mensaje de error genérico que simplemente dice que el valor pasado no se reconoció como un objeto de ese tipo. La falta de un error específico se debe a que es necesario saber si `se supone' que el valor es IPv4 o IPv6 para poder proporcionar más detalles sobre por qué se ha rechazado.

Para admitir casos de uso en los que es útil tener acceso a este detalle adicional, los constructores de clase individuales en realidad lanza las subclases @ref{360,,ValueError} @ref{3b6f,,ipaddress.AddressValueError} y @ref{3b91,,ipaddress.NetmaskValueError} para indicar exactamente qué parte de la definición no se pudo analizar correctamente.

Los mensajes de error son significativamente más detallados cuando se usan los constructores de clase directamente. Por ejemplo:

@example
>>> ipaddress.ip_address("192.168.0.256")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address
>>> ipaddress.IPv4Address("192.168.0.256")
Traceback (most recent call last):
  ...
ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256'

>>> ipaddress.ip_network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network
>>> ipaddress.IPv4Network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ipaddress.NetmaskValueError: '64' is not a valid netmask
@end example

Sin embargo, ambas excepciones específicas del módulo tienen @ref{360,,ValueError} como su clase principal, por lo que si no le preocupa el tipo particular de error, aún puede escribir código como el siguiente:

@example
try:
    network = ipaddress.IPv4Network(address)
except ValueError:
    print('address/netmask is invalid for IPv4:', address)
@end example

@node Instrumentación de CPython con DTrace y SystemTap,Soporte de Python para el perfilador perf de Linux,Introducción al modulo ipaddress,Comos HOWTOs de Python
@anchor{howto/instrumentation doc}@anchor{4f67}@anchor{howto/instrumentation instrumentation}@anchor{cf4}@anchor{howto/instrumentation instrumenting-cpython-with-dtrace-and-systemtap}@anchor{4f68}
@section Instrumentación de CPython con DTrace y SystemTap


@*autor: 
David Malcolm


@*autor: 
Łukasz Langa


DTrace y SystemTap son herramientas de monitoreo, cada una de las cuales proporciona una forma de inspeccionar lo que están haciendo los procesos en un sistema informático. Ambos usan lenguajes específicos de dominio que permiten al usuario escribir scripts que:


@itemize -

@item 
filtrar qué procesos deben observarse

@item 
recopilar datos de los procesos de interés

@item 
generar reportes sobre los datos
@end itemize

A partir de Python 3.6, CPython se puede construir con «marcadores» incrustados, también conocidos como «sondas», que se pueden observar mediante un script de DTrace o SystemTap, lo que facilita la supervisión de lo que hacen los procesos de CPython en un sistema.

`Detalles de implementación de CPython:' Los marcadores de DTrace son detalles de implementación del intérprete CPython. No se ofrecen garantías sobre la compatibilidad de la sonda entre versiones de CPython. Los scripts de DTrace pueden dejar de funcionar o funcionar incorrectamente sin previo aviso al cambiar las versiones de CPython.

@menu
* Habilitando los marcadores estáticos:: 
* Sondas estáticas DTrace:: 
* Marcadores estáticos SystemTap:: 
* Marcadores estáticos disponibles:: 
* SystemTap Tapsets:: 
* Ejemplos: Ejemplos<37>. 

@end menu

@node Habilitando los marcadores estáticos,Sondas estáticas DTrace,,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation enabling-the-static-markers}@anchor{4f69}
@subsection Habilitando los marcadores estáticos


macOS viene con soporte integrado para DTrace. En Linux, para construir CPython con los marcadores incrustados para SystemTap, se deben instalar las herramientas de desarrollo de SystemTap.

En una máquina Linux, esto se puede hacer a través de:

@example
$ yum install systemtap-sdt-devel
@end example

o:

@example
$ sudo apt-get install systemtap-sdt-dev
@end example

CPython debe ser @ref{1dba,,configurado con la opción --with-dtrace}:

@example
checking for --with-dtrace... yes
@end example

En macOS, puede enumerar las sondas disponibles de DTrace ejecutando un proceso de Python en segundo plano y listando todas las sondas disponibles por el proveedor de Python:

@example
$ python3.6 -q &
$ sudo dtrace -l -P python$!  # or: dtrace -l -m python3.6

   ID   PROVIDER            MODULE                          FUNCTION NAME
29564 python18035        python3.6          _PyEval_EvalFrameDefault function-entry
29565 python18035        python3.6             dtrace_function_entry function-entry
29566 python18035        python3.6          _PyEval_EvalFrameDefault function-return
29567 python18035        python3.6            dtrace_function_return function-return
29568 python18035        python3.6                           collect gc-done
29569 python18035        python3.6                           collect gc-start
29570 python18035        python3.6          _PyEval_EvalFrameDefault line
29571 python18035        python3.6                 maybe_dtrace_line line
@end example

En Linux, puede verificar si los marcadores estáticos SystemTap están presentes en el binario construido al ver si contiene una sección «.note.stapsdt».

@example
$ readelf -S ./python | grep .note.stapsdt
[30] .note.stapsdt        NOTE         0000000000000000 00308d78
@end example

Si ha creado Python como una biblioteca compartida (con la opción de configuración @ref{8fa,,--enable-shared}), debe buscar en la biblioteca compartida. Por ejemplo:

@example
$ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
[29] .note.stapsdt        NOTE         0000000000000000 00365b68
@end example

Un lector de formato ELF suficientemente moderno puede imprimir los metadatos:

@example
$ readelf -n ./python

Displaying notes found at file offset 0x00000254 with length 0x00000020:
    Owner                 Data size          Description
    GNU                  0x00000010          NT_GNU_ABI_TAG (ABI version tag)
        OS: Linux, ABI: 2.6.32

Displaying notes found at file offset 0x00000274 with length 0x00000024:
    Owner                 Data size          Description
    GNU                  0x00000014          NT_GNU_BUILD_ID (unique build ID bitstring)
        Build ID: df924a2b08a7e89f6e11251d4602022977af2670

Displaying notes found at file offset 0x002d6c30 with length 0x00000144:
    Owner                 Data size          Description
    stapsdt              0x00000031          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__start
        Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6
        Arguments: -4@@%ebx
    stapsdt              0x00000030          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__done
        Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8
        Arguments: -8@@%rax
    stapsdt              0x00000045          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__entry
        Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8
        Arguments: 8@@%rbp 8@@%r12 -4@@%eax
    stapsdt              0x00000046          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__return
        Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea
        Arguments: 8@@%rbp 8@@%r12 -4@@%eax
@end example

The above metadata contains information for SystemTap describing how it
can patch strategically placed machine code instructions to enable the
tracing hooks used by a SystemTap script.

@node Sondas estáticas DTrace,Marcadores estáticos SystemTap,Habilitando los marcadores estáticos,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation static-dtrace-probes}@anchor{4f6a}
@subsection Sondas estáticas DTrace


El siguiente ejemplo de script DTrace se puede utilizar para mostrar la jerarquía de llamada/retorno de un script de Python, solo rastreando dentro de la invocación de una función llamada «start». En otras palabras, las llamadas a funciones durante la importación aparecerán en la lista:

@example
self int indent;

python$target:::function-entry
/copyinstr(arg1) == "start"/
@{
        self->trace = 1;
@}

python$target:::function-entry
/self->trace/
@{
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
        self->indent++;
@}

python$target:::function-return
/self->trace/
@{
        self->indent--;
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
@}

python$target:::function-return
/copyinstr(arg1) == "start"/
@{
        self->trace = 0;
@}
@end example

Se puede invocar así:

@example
$ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"
@end example

La salida se verá así:

@example
156641360502280  function-entry:call_stack.py:start:23
156641360518804  function-entry: call_stack.py:function_1:1
156641360532797  function-entry:  call_stack.py:function_3:9
156641360546807 function-return:  call_stack.py:function_3:10
156641360563367 function-return: call_stack.py:function_1:2
156641360578365  function-entry: call_stack.py:function_2:5
156641360591757  function-entry:  call_stack.py:function_1:1
156641360605556  function-entry:   call_stack.py:function_3:9
156641360617482 function-return:   call_stack.py:function_3:10
156641360629814 function-return:  call_stack.py:function_1:2
156641360642285 function-return: call_stack.py:function_2:6
156641360656770  function-entry: call_stack.py:function_3:9
156641360669707 function-return: call_stack.py:function_3:10
156641360687853  function-entry: call_stack.py:function_4:13
156641360700719 function-return: call_stack.py:function_4:14
156641360719640  function-entry: call_stack.py:function_5:18
156641360732567 function-return: call_stack.py:function_5:21
156641360747370 function-return:call_stack.py:start:28
@end example

@node Marcadores estáticos SystemTap,Marcadores estáticos disponibles,Sondas estáticas DTrace,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation static-systemtap-markers}@anchor{4f6b}
@subsection Marcadores estáticos SystemTap


La forma de bajo nivel para utilizar la integración de SystemTap es utilizar los marcadores estáticos directamente. Esto requiere que indique explícitamente el archivo binario que los contiene.

Por ejemplo, este script SystemTap se puede utilizar para mostrar la jerarquía de llamada/retorno de un script de Python:

@example
probe process("python").mark("function__entry") @{
     filename = user_string($arg1);
     funcname = user_string($arg2);
     lineno = $arg3;

     printf("%s => %s in %s:%d\\n",
            thread_indent(1), funcname, filename, lineno);
@}

probe process("python").mark("function__return") @{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;

    printf("%s <= %s in %s:%d\\n",
           thread_indent(-1), funcname, filename, lineno);
@}
@end example

Se puede invocar así:

@example
$ stap \
  show-call-hierarchy.stp \
  -c "./python test.py"
@end example

La salida se verá así:

@example
11408 python(8274):        => __contains__ in Lib/_abcoll.py:362
11414 python(8274):         => __getitem__ in Lib/os.py:425
11418 python(8274):          => encode in Lib/os.py:490
11424 python(8274):          <= encode in Lib/os.py:493
11428 python(8274):         <= __getitem__ in Lib/os.py:426
11433 python(8274):        <= __contains__ in Lib/_abcoll.py:366
@end example

donde las columnas son:


@itemize -

@item 
tiempo en microsegundos desde el inicio del script

@item 
nombre del ejecutable

@item 
PID de proceso
@end itemize

y el resto indica la jerarquía de llamada/retorno a medida que se ejecuta el script.

Para una compilación @ref{8fa,,--enable-shared} de CPython, los marcadores están contenidos dentro de la biblioteca compartida libpython, y la ruta de puntos de la sonda debe reflejar esto. Por ejemplo, esta línea del ejemplo anterior:

@example
probe process("python").mark("function__entry") @{
@end example

en su lugar debería leer:

@example
probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") @{
@end example

(asumiendo una @ref{357,,compilación de depuración} de CPython 3.6)

@node Marcadores estáticos disponibles,SystemTap Tapsets,Marcadores estáticos SystemTap,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation available-static-markers}@anchor{4f6c}
@subsection Marcadores estáticos disponibles



@deffn {Object} function__entry(str filename, str funcname, int lineno)

Este marcador indica que ha comenzado la ejecución de una función de Python. Solo se activa para funciones de Python puro (código de bytes).

El nombre del archivo, el nombre de la función y el número de línea se retornan al script de rastreo como argumentos posicionales, a los que se debe acceder usando @code{$arg1}, @code{$arg2}, @code{$arg3}:

@quotation


@itemize *

@item 
@code{$arg1} : @code{(const char *)} nombre del archivo, accesible usando @code{user_string($arg1)}

@item 
@code{$arg2} : @code{(const char *)} nombre de la función, accesible usando @code{user_string($arg2)}

@item 
@code{$arg3} : @code{int} número de linea
@end itemize
@end quotation
@end deffn


@deffn {Object} function__return(str filename, str funcname, int lineno)

This marker is the converse of @code{function__entry()}, and indicates that
execution of a Python function has ended (either via @code{return}, or via an
exception).  It is only triggered for pure-Python (bytecode) functions.

The arguments are the same as for @code{function__entry()}
@end deffn


@deffn {Object} line(str filename, str funcname, int lineno)

Este marcador indica que una línea de Python está a punto de ejecutarse. Es el equivalente al rastreo línea por línea con un generador de perfiles de Python. No se activa con las funciones de C.

The arguments are the same as for @code{function__entry()}.
@end deffn


@deffn {Object} gc__start(int generation)

Fires when the Python interpreter starts a garbage collection cycle.
@code{arg0} is the generation to scan, like @ref{acc,,gc.collect()}.
@end deffn


@deffn {Object} gc__done(long collected)

Se activa cuando el intérprete de Python finaliza un ciclo de recolección de basura. @code{arg0} es el número de objetos recopilados.
@end deffn


@deffn {Object} import__find__load__start(str modulename)

Se activa antes @ref{77,,importlib} e intenta encontrar y cargar el módulo. @code{arg0} es el nombre del módulo.


Added in version 3.7.

@end deffn


@deffn {Object} import__find__load__done(str modulename, int found)

Se activa después de que la función `find_and_load' de @ref{77,,importlib} es llamada. @code{arg0} es el nombre del módulo, @code{arg1} indica si el módulo se cargó correctamente.


Added in version 3.7.

@end deffn


@deffn {Object} audit(str event, void *tuple)

Se activa cuando se llama @ref{15af,,sys.audit()} o @ref{463,,PySys_Audit()}. @code{arg0} es el nombre del evento como cadena C, @code{arg1} es un puntero @ref{42d,,PyObject} a un objeto tupla.


Added in version 3.8.

@end deffn

@node SystemTap Tapsets,Ejemplos<37>,Marcadores estáticos disponibles,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation systemtap-tapsets}@anchor{4f6d}
@subsection SystemTap Tapsets


La forma de nivel superior de utilizar la integración de SystemTap es utilizar un «tapset»: el equivalente de SystemTap a una biblioteca, que oculta algunos de los detalles de bajo nivel de los marcadores estáticos.

A continuación un archivo de tapset, basado en una compilación no compartida de CPython:

@example
/*
   Provide a higher-level wrapping around the function__entry and
   function__return markers:
 \*/
probe python.function.entry = process("python").mark("function__entry")
@{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
@}
probe python.function.return = process("python").mark("function__return")
@{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
@}
@end example

Si este archivo está instalado en el directorio de tapset de SystemTap (por ejemplo, @code{/usr/share/systemtap/tapset}), estos puntos de sonda adicionales estarán disponibles:


@deffn {Object} python.function.entry(str filename, str funcname, int lineno, frameptr)

Este punto de sonda indica que ha comenzado la ejecución de una función de Python. Solo se activa para funciones de Python puro (código de bytes).
@end deffn


@deffn {Object} python.function.return(str filename, str funcname, int lineno, frameptr)

Este punto de prueba es el inverso de @code{python.function.return}, e indica que la ejecución de una función de Python ha finalizado (ya sea mediante @code{return} o mediante una excepción). Solo se activa para funciones de Python puro (código de bytes).
@end deffn

@node Ejemplos<37>,,SystemTap Tapsets,Instrumentación de CPython con DTrace y SystemTap
@anchor{howto/instrumentation examples}@anchor{4f6e}
@subsection Ejemplos


Este script de SystemTap utiliza el tapset anterior para implementar de manera más limpia el ejemplo de rastrear la jerarquía de llamadas a funciones de Python, sin necesidad de nombrar directamente los marcadores estáticos:

@example
probe python.function.entry
@{
  printf("%s => %s in %s:%d\n",
         thread_indent(1), funcname, filename, lineno);
@}

probe python.function.return
@{
  printf("%s <= %s in %s:%d\n",
         thread_indent(-1), funcname, filename, lineno);
@}
@end example

The following script uses the tapset above to provide a top-like view of all
running CPython code, showing the top 20 most frequently entered bytecode
frames, each second, across the whole system:

@example
global fn_calls;

probe python.function.entry
@{
    fn_calls[pid(), filename, funcname, lineno] += 1;
@}

probe timer.ms(1000) @{
    printf("\033[2J\033[1;1H") /* clear screen \*/
    printf("%6s %80s %6s %30s %6s\n",
           "PID", "FILENAME", "LINE", "FUNCTION", "CALLS")
    foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) @{
        printf("%6d %80s %6d %30s %6d\n",
            pid, filename, lineno, funcname,
            fn_calls[pid, filename, funcname, lineno]);
    @}
    delete fn_calls;
@}
@end example

@node Soporte de Python para el perfilador perf de Linux,Prácticas recomendadas para las anotaciones,Instrumentación de CPython con DTrace y SystemTap,Comos HOWTOs de Python
@anchor{howto/perf_profiling doc}@anchor{1743}@anchor{howto/perf_profiling perf-profiling}@anchor{2f8}@anchor{howto/perf_profiling python-support-for-the-linux-perf-profiler}@anchor{4f6f}
@section Soporte de Python para el perfilador @code{perf} de Linux


@*autor: 
Pablo Galindo


El perfilador perf de Linux@footnote{https://perf.wiki.kernel.org} es una herramienta muy poderosa que le permite crear perfiles y obtener información sobre el rendimiento de su aplicación. @code{perf} también tiene un ecosistema muy vibrante de herramientas que ayudan con el análisis de los datos que produce.

El principal problema con el uso del perfilador @code{perf} con aplicaciones Python es que @code{perf} sólo obtiene información sobre símbolos nativos, es decir, los nombres de funciones y procedimientos escritos en C. Esto significa que los nombres y nombres de archivos de las funciones de Python en su código no aparecerán en la salida de @code{perf}.

Desde Python 3.12, el intérprete puede ejecutarse en un modo especial que permite que las funciones de Python aparezcan en la salida del perfilador @code{perf}. Cuando este modo está habilitado, el intérprete interpondrá un pequeño fragmento de código compilado sobre la marcha antes de la ejecución de cada función de Python y enseñará a @code{perf} la relación entre este fragmento de código y la función de Python asociada usando @ref{4aac,,perf map files}.

@cartouche
@quotation Nota 
Actualmente, el soporte para el perfilador @code{perf} solo está disponible para Linux en arquitecturas seleccionadas. Verifique el resultado del paso de compilación @code{configure} o verifique el resultado de @code{python -m sysconfig | grep HAVE_PERF_TRAMPOLINE} para ver si su sistema es compatible.
@end quotation
@end cartouche

Por ejemplo, considere el siguiente script:

@example
def foo(n):
    result = 0
    for _ in range(n):
        result += 1
    return result

def bar(n):
    foo(n)

def baz(n):
    bar(n)

if __name__ == "__main__":
    baz(1000000)
@end example

Podemos ejecutar @code{perf} para obtener un registro de los seguimientos de la pila de CPU a 9999 hercios:

@example
$ perf record -F 9999 -g -o perf.data python my_script.py
@end example

Luego podemos usar @code{perf report} para analizar los datos:

@example
$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  ..........................................
#
    91.08%     0.00%             0  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --90.71%--__libc_start_main
                        Py_BytesMain
                        |
                        |--56.88%--pymain_run_python.constprop.0
                        |          |
                        |          |--56.13%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--55.02%--run_mod
                        |          |          |          |
                        |          |          |           --54.65%--PyEval_EvalCode
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     |
                        |          |          |                     |--51.67%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--11.52%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--2.97%--_PyObject_Malloc
...
@end example

As you can see, the Python functions are not shown in the output, only @code{_PyEval_EvalFrameDefault}
(the function that evaluates the Python bytecode) shows up. Unfortunately that’s not very useful because all Python
functions use the same C function to evaluate bytecode so we cannot know which Python function corresponds to which
bytecode-evaluating function.

En cambio, si ejecutamos el mismo experimento con el soporte @code{perf} habilitado obtenemos:

@example
$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  .....................................................................
#
    90.58%     0.36%             1  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --89.86%--__libc_start_main
                        Py_BytesMain
                        |
                        |--55.43%--pymain_run_python.constprop.0
                        |          |
                        |          |--54.71%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--53.62%--run_mod
                        |          |          |          |
                        |          |          |           --53.26%--PyEval_EvalCode
                        |          |          |                     py::<module>:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::baz:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::bar:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::foo:/src/script.py
                        |          |          |                     |
                        |          |          |                     |--51.81%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--13.77%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--3.26%--_PyObject_Malloc
@end example

@menu
* Cómo habilitar el soporte de creación de perfiles perf:: 
* Cómo obtener los mejores resultados:: 
* How to work without frame pointers:: 

@end menu

@node Cómo habilitar el soporte de creación de perfiles perf,Cómo obtener los mejores resultados,,Soporte de Python para el perfilador perf de Linux
@anchor{howto/perf_profiling how-to-enable-perf-profiling-support}@anchor{4f70}
@subsection Cómo habilitar el soporte de creación de perfiles @code{perf}


El soporte de creación de perfiles @code{perf} se puede habilitar desde el principio usando la variable de entorno 
@geindex PYTHONPERFSUPPORT
@geindex variables de entorno; PYTHONPERFSUPPORT
@ref{519,,PYTHONPERFSUPPORT} o la opción @ref{2e2,,-X perf}, o dinámicamente usando @ref{51a,,sys.activate_stack_trampoline()} y @ref{51b,,sys.deactivate_stack_trampoline()}.

Las funciones @code{sys} tienen prioridad sobre la opción @code{-X}, la opción @code{-X} tiene prioridad sobre la variable de entorno.

Ejemplo, usando la variable de entorno:

@example
$ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python script.py
$ perf report -g -i perf.data
@end example

Ejemplo, usando la opción @code{-X}:

@example
$ perf record -F 9999 -g -o perf.data python -X perf script.py
$ perf report -g -i perf.data
@end example

Ejemplo, usando las API @ref{d9,,sys} en el archivo @code{example.py}:

@example
import sys

sys.activate_stack_trampoline("perf")
do_profiled_stuff()
sys.deactivate_stack_trampoline()

non_profiled_stuff()
@end example

…entonces:

@example
$ perf record -F 9999 -g -o perf.data python ./example.py
$ perf report -g -i perf.data
@end example

@node Cómo obtener los mejores resultados,How to work without frame pointers,Cómo habilitar el soporte de creación de perfiles perf,Soporte de Python para el perfilador perf de Linux
@anchor{howto/perf_profiling how-to-obtain-the-best-results}@anchor{4f71}
@subsection Cómo obtener los mejores resultados


Para obtener mejores resultados, Python debe compilarse con @code{CFLAGS="-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer"} ya que esto permite a los perfiladores desenrollarse usando solo el puntero del marco y no en la información de depuración de DWARF. Esto se debe a que como el código que se interpone para permitir el soporte @code{perf} se genera dinámicamente, no tiene ninguna información de depuración DWARF disponible.

Puede verificar si su sistema ha sido compilado con este indicador ejecutando:

@example
$ python -m sysconfig | grep 'no-omit-frame-pointer'
@end example

Si no ve ningún resultado, significa que su intérprete no ha sido compilado con punteros de marco y, por lo tanto, es posible que no pueda mostrar funciones de Python en el resultado de @code{perf}.

@node How to work without frame pointers,,Cómo obtener los mejores resultados,Soporte de Python para el perfilador perf de Linux
@anchor{howto/perf_profiling how-to-work-without-frame-pointers}@anchor{4f72}
@subsection How to work without frame pointers


If you are working with a Python interpreter that has been compiled without
frame pointers, you can still use the @code{perf} profiler, but the overhead will be
a bit higher because Python needs to generate unwinding information for every
Python function call on the fly. Additionally, @code{perf} will take more time to
process the data because it will need to use the DWARF debugging information to
unwind the stack and this is a slow process.

To enable this mode, you can use the environment variable
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variables de entorno; PYTHON_PERF_JIT_SUPPORT
@ref{2f9,,PYTHON_PERF_JIT_SUPPORT} or the @ref{2e2,,-X perf_jit} option,
which will enable the JIT mode for the @code{perf} profiler.

@cartouche
@quotation Nota 
Due to a bug in the @code{perf} tool, only @code{perf} versions higher than v6.8
will work with the JIT mode.  The fix was also backported to the v6.7.2
version of the tool.

Note that when checking the version of the @code{perf} tool (which can be done
by running @code{perf version}) you must take into account that some distros
add some custom version numbers including a @code{-} character.  This means
that @code{perf 6.7-3} is not necessarily @code{perf 6.7.3}.
@end quotation
@end cartouche

When using the perf JIT mode, you need an extra step before you can run @code{perf
report}. You need to call the @code{perf inject} command to inject the JIT
information into the @code{perf.data} file.:

@example
$ perf record -F 9999 -g --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

or using the environment variable:

@example
$ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

@code{perf inject --jit} command will read @code{perf.data},
automatically pick up the perf dump file that Python creates (in
@code{/tmp/perf-$PID.dump}), and then create @code{perf.jit.data} which merges all the
JIT information together. It should also create a lot of @code{jitted-XXXX-N.so}
files in the current directory which are ELF images for all the JIT trampolines
that were created by Python.

@cartouche
@quotation Advertencia 
Notice that when using @code{--call-graph dwarf} the @code{perf} tool will take
snapshots of the stack of the process being profiled and save the
information in the @code{perf.data} file. By default the size of the stack dump
is 8192 bytes but the user can change the size by passing the size after
comma like @code{--call-graph dwarf,4096}. The size of the stack dump is
important because if the size is too small @code{perf} will not be able to
unwind the stack and the output will be incomplete. On the other hand, if
the size is too big, then @code{perf} won’t be able to sample the process as
frequently as it would like as the overhead will be higher.
@end quotation
@end cartouche

@node Prácticas recomendadas para las anotaciones,Aislamiento de módulos de extensión,Soporte de Python para el perfilador perf de Linux,Comos HOWTOs de Python
@anchor{howto/annotations doc}@anchor{4f73}@anchor{howto/annotations annotations-best-practices}@anchor{4f74}@anchor{howto/annotations annotations-howto}@anchor{870}
@section Prácticas recomendadas para las anotaciones


@*autor: 
Larry Hastings


@subsubheading Resumen



Este documento se designó para encapsular las prácticas recomendadas para trabajar con diccionarios de anotaciones. Si escribe código Python que examina @code{__annotations__} en objetos Python, recomendamos seguir las pautas que se describen a continuación.

El documento se organizó en 4 secciones: prácticas recomendadas para acceder a las anotaciones de un objeto en las versiones de Python 3.10 y posteriores, prácticas recomendadas para acceder a las anotaciones de un objeto en las versiones de Python 3.9 y anteriores, otras prácticas recomendadas para @code{__annotations__} que aplican a cualquier versión de Python y peculiaridades de @code{__annotations__}.

Tome en cuenta que este documento trabaja específicamente con @code{__annotations__}, no usarlo `para' anotaciones. Si está buscando información sobre cómo usar «anotaciones de tipado» en su código, consulte el módulo @ref{104,,typing}.

@menu
* Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.10 y posteriores: Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 10 y posteriores. 
* Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.9 y anteriores: Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 9 y anteriores. 
* Desencadenamiento manual de anotaciones en cadena:: 
* Prácticas recomendadas para __annotations__ en cualquier versión de Python:: 
* Peculiaridades de __annotations__:: 

@end menu

@node Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 10 y posteriores,Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 9 y anteriores,,Prácticas recomendadas para las anotaciones
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-10-and-newer}@anchor{4f75}
@subsection Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.10 y posteriores


Python 3.10 adds a new function to the standard library:
@ref{8aa,,inspect.get_annotations()}.  In Python versions 3.10
through 3.13, calling this function is the best practice for
accessing the annotations dict of any object that supports
annotations.  This function can also «un-stringize»
stringized annotations for you.

In Python 3.14, there is a new @ref{6,,annotationlib} module
with functionality for working with annotations. This
includes a @ref{147,,annotationlib.get_annotations()} function,
which supersedes @ref{8aa,,inspect.get_annotations()}.

Si por alguna razón @ref{8aa,,inspect.get_annotations()} no es viable para su caso de uso, puede acceder manualmente al miembro de datos @code{__annotations__}. La práctica recomendada para esto también cambió en Python 3.10: a partir de Python 3.10, se garantiza que @code{o.__annotations__} `siempre' opere en funciones, clases y módulos de Python. Si está seguro de que el objeto que está examinando es uno de los tres objetos `específicos', puede usar simplemente @code{o.__annotations__} para obtener el diccionario de anotaciones del objeto.

Sin embargo, otros tipos de llamadas – por ejemplo, invocables creados por @ref{17a,,functools.partial()} – pueden no tener definido un atributo @code{__annotations__}. Al acceder a @code{__annotations__} de un objeto posiblemente desconocido, la práctica recomendada de las versiones de Python 3.10 y posteriores es llamar @ref{c59,,getattr()} con tres argumentos, por ejemplo @code{getattr(o, '__annotations__', None)}.

Antes de Python 3.10, acceder a @code{__annotations__} en una clase que no define anotaciones pero que tiene una clase padre con anotaciones devolvería las anotaciones de la clase padre. En Python 3.10 y versiones posteriores, las anotaciones de la clase hija serán un diccionario vacío en su lugar.

@node Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 9 y anteriores,Desencadenamiento manual de anotaciones en cadena,Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 10 y posteriores,Prácticas recomendadas para las anotaciones
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-9-and-older}@anchor{4f76}
@subsection Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3.9 y anteriores


En versiones de Python 3.9 y anteriores, acceder al diccionario de anotaciones de un objeto es mucho más complicado que en versiones más recientes. El problema es un defecto de diseño en estas versiones anteriores de Python, específicamente relacionado con las anotaciones de clase.

La práctica recomendada para acceder al diccionario de anotaciones de otros objetos – funciones, otros invocables y módulos – es la misma que la de la 3.10, asumiendo que no está llamando @ref{8aa,,inspect.get_annotations()}: debe usar tres argumentos de @ref{c59,,getattr()} para acceder al atributo @code{__annotations__} del objeto.

Desafortunadamente, esta no es la mejor práctica para las clases. El problema es que, dado que @code{__annotations__} es opcional en las clases, y debido a que las clases pueden heredar atributos desde sus clases base, acceder al atributo @code{__annotations__} de una clase puede retornar por inadvertencia el diccionario de anotaciones de una `clase base.' Como ejemplo:

@example
class Base:
    a: int = 3
    b: str = 'abc'

class Derived(Base):
    pass

print(Derived.__annotations__)
@end example

Esto imprimirá el diccionario de anotaciones de @code{Base}, no de @code{Derived}.

Your code will have to have a separate code path if the object
you’re examining is a class (@code{isinstance(o, type)}).
In that case, best practice relies on an implementation detail
of Python 3.9 and before: if a class has annotations defined,
they are stored in the class’s @ref{ce5,,__dict__} dictionary.  Since
the class may or may not have annotations defined, best practice
is to call the @ref{2248,,get()} method on the class dict.

Para ponerlo todo junto, aquí hay un código de muestra que accede de forma segura al atributo @code{__annotations__} en un objeto arbitrario en las versiones de Python 3.9 y anteriores:

@example
if isinstance(o, type):
    ann = o.__dict__.get('__annotations__', None)
else:
    ann = getattr(o, '__annotations__', None)
@end example

Después de ejecutar este código, @code{ann} debería ser un diccionario o @code{None}. Recomendamos que vuelva a verificar el tipo de @code{ann} usando @ref{4ef,,isinstance()} antes de un examen más detenido.

Note that some exotic or malformed type objects may not have
a @ref{ce5,,__dict__} attribute, so for extra safety you may also wish
to use @ref{c59,,getattr()} to access @code{__dict__}.

@node Desencadenamiento manual de anotaciones en cadena,Prácticas recomendadas para __annotations__ en cualquier versión de Python,Acceder al diccionario de anotaciones de un objeto en las versiones de Python 3 9 y anteriores,Prácticas recomendadas para las anotaciones
@anchor{howto/annotations manually-un-stringizing-stringized-annotations}@anchor{4f77}
@subsection Desencadenamiento manual de anotaciones en cadena


En situaciones donde algunas anotaciones pueden estar «encadenadas», y desea evaluar esas cadenas de caracteres para producir los valores de Python que representan, lo mejor es llamar a @ref{8aa,,inspect.get_annotations()} para que haga este trabajo por usted.

Si está usando la versión de Python 3.9 o anterior, o si por alguna razón no puede usar @ref{8aa,,inspect.get_annotations()}, necesitará duplicar su lógica. Recomendamos que examine la implementación de @ref{8aa,,inspect.get_annotations()} en la versión actual de Python y siga un enfoque similar.

En pocas palabras, si desea evaluar una anotación en cadena en un objeto arbitrario @code{o}:


@itemize *

@item 
Si @code{o} es un módulo, use @code{o.__dict__} como @code{globals} cuando llame a @ref{2eb,,eval()}.

@item 
Si @code{o} es una clase, use @code{sys.modules[o.__module__].__dict__} como @code{globals} y @code{dict(vars(o))} como @code{locals} cuando llame a @ref{2eb,,eval()}.

@item 
Si @code{o} es un invocable envuelto usando @ref{109e,,functools.update_wrapper()}, @ref{fdd,,functools.wraps()} o @ref{17a,,functools.partial()}, lo desenvuelve iterativamente accediendo a @code{o.__wrapped__} o @code{o.func} según corresponda, hasta que haya encontrado la función raíz sin envolver.

@item 
If @code{o} is a callable (but not a class), use
@ref{133b,,o.__globals__} as the globals when calling
@ref{2eb,,eval()}.
@end itemize

Sin embargo, no todos los valores de cadena de caracteres usados como anotaciones se pueden convertir correctamente en valores de Python mediante @ref{2eb,,eval()}. Los valores de cadena de caracteres pueden contener, teóricamente, cualquier cadena de caracteres válida, y en la práctica, hay varios casos de uso válidos para anotaciones de tipo que requieren anotaciones con valores de cadena de caracteres que `no pueden' evaluarse específicamente. Por ejemplo:


@itemize *

@item 
@geindex Python Enhancement Proposals; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} introduce tipos de unión usando @code{|}, antes de que se agregara soporte para esto en Python 3.10.

@item 
Las definiciones que no son necesarias en tiempo de ejecución, sólo se importan cuando @ref{d7b,,typing.TYPE_CHECKING} es verdadero.
@end itemize

Si @ref{2eb,,eval()} intenta evaluar tales valores, fallará y lanzará una excepción. Por lo tanto, al diseñar una API de biblioteca que funcione con anotaciones, se recomienda sólo intentar evaluar valores de cadena de caracteres cuando la llamada lo solicite explícitamente.

@node Prácticas recomendadas para __annotations__ en cualquier versión de Python,Peculiaridades de __annotations__,Desencadenamiento manual de anotaciones en cadena,Prácticas recomendadas para las anotaciones
@anchor{howto/annotations best-practices-for-annotations-in-any-python-version}@anchor{4f78}
@subsection Prácticas recomendadas para @code{__annotations__} en cualquier versión de Python



@itemize *

@item 
Debe evitar asignar directamente al miembro @code{__annotations__} de objetos. Deje que Python administre la configuración @code{__annotations__}.

@item 
Si asigna directamente al miembro @code{__annotations__} de un objeto, siempre debe establecerlo en un objeto @code{dict}.

@item 
You should avoid accessing @code{__annotations__} directly on any object.
Instead, use @ref{147,,annotationlib.get_annotations()} (Python 3.14+)
or @ref{8aa,,inspect.get_annotations()} (Python 3.10+).

@item 
If you do directly access the @code{__annotations__} member
of an object, you should ensure that it’s a
dictionary before attempting to examine its contents.

@item 
Debe evitar modificar los diccionarios @code{__annotations__}.

@item 
Debe evitar eliminar el atributo @code{__annotations__} de un objeto.
@end itemize

@node Peculiaridades de __annotations__,,Prácticas recomendadas para __annotations__ en cualquier versión de Python,Prácticas recomendadas para las anotaciones
@anchor{howto/annotations annotations-quirks}@anchor{4f79}
@subsection Peculiaridades de @code{__annotations__}


En todas las versiones de Python 3, los objetos de función crean de forma diferida un diccionario de anotaciones si no hay anotaciones definidas en ese objeto. Puede eliminar el atributo @code{__annotations__} usando @code{del fn.__annotations__}, pero si luego accede a @code{fn.__annotations__}, el objeto creará un diccionario nuevo vacío que almacenará y retornará como sus anotaciones. Eliminar las anotaciones en una función antes de que haya creado su diccionario de anotaciones de forma diferida arrojará un @code{AttributeError}; el uso de dos veces seguidas de @code{del fn.__annotations__} garantiza que siempre arroje un @code{AttributeError}.

Todo en el párrafo anterior también se aplica a los objetos de clase y módulo en las versiones de Python 3.10 y posteriores.

En todas las versiones de Python 3, puede establecer @code{__annotations__} en un objeto de función en @code{None}. Sin embargo, al acceder después a las anotaciones en ese objeto usando @code{fn.__annotations__} se creará un diccionario vacío de forma diferida según el primer párrafo de esta sección. Esto `no' es cierto para módulos y clases, en cualquier versión de Python; esos objetos permiten establecer @code{__annotations__} en cualquier valor de Python, y conservarán cualquier valor que se establezca.

Si Python encadena sus anotaciones por usted (usando @code{from __future__ import annotations}), y especifica una cadena de caracteres como una anotación, la cadena de caracteres en sí se citará. En efecto, la anotación se cita `dos veces.' Por ejemplo:

@example
from __future__ import annotations
def foo(a: "str"): pass

print(foo.__annotations__)
@end example

Esto imprime @code{@{'a': "'str'"@}}. En realidad, esto no debería considerarse una «peculiaridad»; aquí se menciona simplemente porque podría sorprenderle.

If you use a class with a custom metaclass and access @code{__annotations__}
on the class, you may observe unexpected behavior; see
@geindex Python Enhancement Proposals; PEP 749#pep749-metaclasses
749@footnote{https://peps.python.org/pep-0749/#pep749-metaclasses} for some examples. You can avoid these
quirks by using @ref{147,,annotationlib.get_annotations()} on Python 3.14+ or
@ref{8aa,,inspect.get_annotations()} on Python 3.10+. On earlier versions of
Python, you can avoid these bugs by accessing the annotations from the
class’s @ref{ce5,,__dict__}
(e.g., @code{cls.__dict__.get('__annotations__', None)}).

@node Aislamiento de módulos de extensión,timer file descriptor HOWTO,Prácticas recomendadas para las anotaciones,Comos HOWTOs de Python
@anchor{howto/isolating-extensions doc}@anchor{4f7a}@anchor{howto/isolating-extensions isolating-extension-modules}@anchor{4f7b}@anchor{howto/isolating-extensions isolating-extensions-howto}@anchor{4c2c}
@section Aislamiento de módulos de extensión


@subsubheading Resumen



Tradicionalmente, el estado perteneciente a los módulos de extensión de Python se mantuvo en las variables C @code{static}, que tienen un alcance de todo el proceso. Este documento describe los problemas de dicho estado por proceso y muestra una forma más segura: el estado por módulo.

El documento también describe cómo cambiar al estado por módulo cuando sea posible. Esta transición implica asignar espacio para ese estado, cambiar potencialmente de tipos estáticos a tipos de montón y, quizás lo más importante, acceder al estado por módulo desde el código.

@menu
* ¿Quién debería leer esto?:: 
* Trasfondo:: 
* Cómo hacer que los módulos sean seguros con varios intérpretes:: 
* Tipos Heap: Tipos Heap<2>. 
* Problemas abiertos:: 

@end menu

@node ¿Quién debería leer esto?,Trasfondo,,Aislamiento de módulos de extensión
@anchor{howto/isolating-extensions who-should-read-this}@anchor{4f7c}
@subsection ¿Quién debería leer esto?


Esta guía está escrita para los mantenedores de extensiones @ref{1be3,,C-API} que deseen hacer que esa extensión sea más segura para usar en aplicaciones donde Python se usa como biblioteca.

@node Trasfondo,Cómo hacer que los módulos sean seguros con varios intérpretes,¿Quién debería leer esto?,Aislamiento de módulos de extensión
@anchor{howto/isolating-extensions background}@anchor{4f7d}
@subsection Trasfondo


Un intérprete (`interpreter') es el contexto en el que se ejecuta el código de Python. Contiene la configuración (p. ej., la ruta de importación) y el estado de tiempo de ejecución (p. ej., el conjunto de módulos importados).

Python admite la ejecución de varios intérpretes en un solo proceso. Hay dos casos en los que pensar, los usuarios pueden ejecutar intérpretes:


@itemize -

@item 
en secuencia, con varios ciclos @ref{4a15,,Py_InitializeEx()}/@ref{d9c,,Py_FinalizeEx()}, y

@item 
en paralelo, gestionando «subintérpretes» mediante @ref{17be,,Py_NewInterpreter()}/@ref{1867,,Py_EndInterpreter()}.
@end itemize

Ambos casos (y combinaciones de ellos) serían más útiles al incorporar Python dentro de una biblioteca. Las bibliotecas generalmente no deben hacer suposiciones sobre la aplicación que las usa, lo que incluye asumir un «intérprete principal de Python» en todo el proceso.

Históricamente, los módulos de extensión de Python no manejan bien este caso de uso. Muchos módulos de extensión (e incluso algunos módulos stdlib) usan el estado global `por-proceso', porque las variables C @code{static} son extremadamente fáciles de usar. Así, los datos que deberían ser específicos de un intérprete acaban siendo compartidos entre intérpretes. A menos que el desarrollador de la extensión tenga cuidado, es muy fácil introducir casos extremos que provocan bloqueos cuando un módulo se carga en más de un intérprete en el mismo proceso.

Desafortunadamente, el estado `por-intérprete' no es fácil de lograr. Los autores de extensiones tienden a no tener en cuenta múltiples intérpretes cuando desarrollan, y actualmente es engorroso probar el comportamiento.

@menu
* Ingrese al estado por módulo:: 
* Objetos módulos aislados:: 
* Casos extremos sorprendentes:: 

@end menu

@node Ingrese al estado por módulo,Objetos módulos aislados,,Trasfondo
@anchor{howto/isolating-extensions enter-per-module-state}@anchor{4f7e}
@subsubsection Ingrese al estado por módulo


Instead of focusing on per-interpreter state, Python’s C API is evolving
to better support the more granular `per-module' state.
This means that C-level data should be attached to a `module object'.
Each interpreter creates its own module object, keeping the data separate.
For testing the isolation, multiple module objects corresponding to a single
extension can even be loaded in a single interpreter.

El estado por módulo proporciona una manera fácil de pensar en la vida útil y la propiedad de los recursos: el módulo de extensión se inicializará cuando se cree un objeto de módulo y se limpiará cuando se libere. En este sentido, un módulo es como cualquier otro @ref{42d,,PyObject}*; no hay ganchos de «apagado del intérprete» para pensar u olvidar.

Tenga en cuenta que hay casos de uso para diferentes tipos de «globales»: por proceso, por intérprete, por subproceso o por estado de tarea. Con el estado por módulo como predeterminado, estos aún son posibles, pero debe tratarlos como casos excepcionales: si los necesita, debe brindarles atención y pruebas adicionales. (Tenga en cuenta que esta guía no los cubre).

@node Objetos módulos aislados,Casos extremos sorprendentes,Ingrese al estado por módulo,Trasfondo
@anchor{howto/isolating-extensions isolated-module-objects}@anchor{4f7f}
@subsubsection Objetos módulos aislados


El punto clave a tener en cuenta al desarrollar un módulo de extensión es que se pueden crear varios objetos de módulo a partir de una única biblioteca compartida. Por ejemplo:

@example
>>> import sys
>>> import binascii
>>> old_binascii = binascii
>>> del sys.modules['binascii']
>>> import binascii  # create a new module object
>>> old_binascii == binascii
False
@end example

Como regla general, los dos módulos deben ser completamente independientes. Todos los objetos y el estado específico del módulo deben encapsularse dentro del objeto del módulo, no compartirse con otros objetos del módulo y limpiarse cuando se desasigna el objeto del módulo. Dado que esto es solo una regla general, las excepciones son posibles (consulte @ref{4f80,,Managing Global State}), pero necesitarán más reflexión y atención en los casos extremos.

Si bien algunos módulos podrían funcionar con restricciones menos estrictas, los módulos aislados facilitan el establecimiento de expectativas y pautas claras que funcionan en una variedad de casos de uso.

@node Casos extremos sorprendentes,,Objetos módulos aislados,Trasfondo
@anchor{howto/isolating-extensions surprising-edge-cases}@anchor{4f81}
@subsubsection Casos extremos sorprendentes


Tenga en cuenta que los módulos aislados crean algunos casos extremos sorprendentes. En particular, cada objeto de módulo normalmente no compartirá sus clases y excepciones con otros módulos similares. Continuando con @ref{4f7f,,example above}, tenga en cuenta que @code{old_binascii.Error} y @code{binascii.Error} son objetos separados. En el código siguiente, se detecta la excepción `not':

@example
>>> old_binascii.Error == binascii.Error
False
>>> try:
...     old_binascii.unhexlify(b'qwertyuiop')
... except binascii.Error:
...     print('boo')
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
binascii.Error: Non-hexadecimal digit found
@end example

Esto se espera. Tenga en cuenta que los módulos de Python puro se comportan de la misma manera: es una parte de cómo funciona Python.

El objetivo es hacer que los módulos de extensión sean seguros en el nivel C, no hacer que los piratas informáticos se comporten de manera intuitiva. Mutar @code{sys.modules} «manualmente» cuenta como un hack.

@node Cómo hacer que los módulos sean seguros con varios intérpretes,Tipos Heap<2>,Trasfondo,Aislamiento de módulos de extensión
@anchor{howto/isolating-extensions making-modules-safe-with-multiple-interpreters}@anchor{4f82}
@subsection Cómo hacer que los módulos sean seguros con varios intérpretes


@menu
* Administrar el estado global:: 
* Administración del estado por módulo:: 
* Exclusión voluntaria; limitación a un objeto de módulo por proceso: Exclusión voluntaria limitación a un objeto de módulo por proceso. 
* Acceso al estado del módulo desde las funciones:: 

@end menu

@node Administrar el estado global,Administración del estado por módulo,,Cómo hacer que los módulos sean seguros con varios intérpretes
@anchor{howto/isolating-extensions managing-global-state}@anchor{4f80}
@subsubsection Administrar el estado global


A veces, el estado asociado con un módulo de Python no es específico de ese módulo, sino de todo el proceso (o algo más «más global» que un módulo). Por ejemplo:


@itemize -

@item 
El módulo @code{readline} gestiona `el' terminal.

@item 
Un módulo que se ejecuta en una placa de circuito quiere controlar `el' LED integrado.
@end itemize

En estos casos, el módulo Python debería proporcionar `acceso' al estado global, en lugar de `poseerlo'. Si es posible, escriba el módulo para que varias copias del mismo puedan acceder al estado de forma independiente (junto con otras bibliotecas, ya sea para Python u otros lenguajes). Si eso no es posible, considere el bloqueo explícito.

Si es necesario usar el estado global del proceso, la forma más sencilla de evitar problemas con varios intérpretes es evitar explícitamente que un módulo se cargue más de una vez por proceso; consulte @ref{4f83,,Opt-Out; Limiting to One Module Object per Process}.

@node Administración del estado por módulo,Exclusión voluntaria limitación a un objeto de módulo por proceso,Administrar el estado global,Cómo hacer que los módulos sean seguros con varios intérpretes
@anchor{howto/isolating-extensions managing-per-module-state}@anchor{4f84}
@subsubsection Administración del estado por módulo


Para usar el estado por módulo, use @ref{488d,,multi-phase extension module initialization}. Esto indica que su módulo admite múltiples intérpretes correctamente.

Establezca @code{PyModuleDef.m_size} en un número positivo para solicitar tantos bytes de almacenamiento local para el módulo. Por lo general, esto se establecerá en el tamaño de algún @code{struct} específico del módulo, que puede almacenar todo el estado de nivel C del módulo. En particular, es donde debe colocar los punteros a las clases (incluidas las excepciones, pero excluyendo los tipos estáticos) y configuraciones (por ejemplo, @ref{180d,,field_size_limit} de @code{csv}) que el código C necesita para funcionar.

@cartouche
@quotation Nota 
Otra opción es almacenar el estado en el @code{__dict__} del módulo, pero debe evitar fallas cuando los usuarios modifican @code{__dict__} desde el código de Python. Esto generalmente significa verificación de errores y tipos en el nivel C, que es fácil equivocarse y difícil de probar lo suficiente.

Sin embargo, si el estado del módulo no es necesario en el código C, almacenarlo solo en @code{__dict__} es una buena idea.
@end quotation
@end cartouche

Si el estado del módulo incluye punteros @code{PyObject}, el objeto del módulo debe contener referencias a esos objetos e implementar los enlaces de nivel de módulo @code{m_traverse}, @code{m_clear} y @code{m_free}. Estos funcionan como @code{tp_traverse}, @code{tp_clear} y @code{tp_free} de una clase. Agregarlos requerirá algo de trabajo y hará que el código sea más largo; este es el precio de los módulos que se pueden descargar limpiamente.

Un ejemplo de un módulo con estado por módulo está actualmente disponible como xxlimited@footnote{https://github.com/python/cpython/blob/master/Modules/xxlimited.c}; ejemplo de inicialización del módulo que se muestra en la parte inferior del archivo.

@node Exclusión voluntaria limitación a un objeto de módulo por proceso,Acceso al estado del módulo desde las funciones,Administración del estado por módulo,Cómo hacer que los módulos sean seguros con varios intérpretes
@anchor{howto/isolating-extensions opt-out-limiting-to-one-module-object-per-process}@anchor{4f83}
@subsubsection Exclusión voluntaria: limitación a un objeto de módulo por proceso


Un @code{PyModuleDef.m_size} no negativo indica que un módulo admite varios intérpretes correctamente. Si este aún no es el caso de su módulo, puede hacer que su módulo se pueda cargar explícitamente solo una vez por proceso. Por ejemplo:

@example
static int loaded = 0;

static int
exec_module(PyObject* module)
@{
    if (loaded) @{
        PyErr_SetString(PyExc_ImportError,
                        "cannot load module more than once per process");
        return -1;
    @}
    loaded = 1;
    // ... rest of initialization
@}
@end example

@node Acceso al estado del módulo desde las funciones,,Exclusión voluntaria limitación a un objeto de módulo por proceso,Cómo hacer que los módulos sean seguros con varios intérpretes
@anchor{howto/isolating-extensions module-state-access-from-functions}@anchor{4f85}
@subsubsection Acceso al estado del módulo desde las funciones


Acceder al estado desde funciones a nivel de módulo es sencillo. Las funciones obtienen el objeto del módulo como su primer argumento; para extraer el estado, puede usar @code{PyModule_GetState}:

@example
static PyObject *
func(PyObject *module, PyObject *args)
@{
    my_struct *state = (my_struct*)PyModule_GetState(module);
    if (state == NULL) @{
        return NULL;
    @}
    // ... rest of logic
@}
@end example

@cartouche
@quotation Nota 
@code{PyModule_GetState} puede retornar @code{NULL} sin establecer una excepción si no hay un estado de módulo, es decir, @code{PyModuleDef.m_size} era cero. En su propio módulo, tiene el control de @code{m_size}, por lo que es fácil de evitar.
@end quotation
@end cartouche

@node Tipos Heap<2>,Problemas abiertos,Cómo hacer que los módulos sean seguros con varios intérpretes,Aislamiento de módulos de extensión
@anchor{howto/isolating-extensions heap-types}@anchor{4f86}
@subsection Tipos Heap


Tradicionalmente, los tipos definidos en código C son `estáticos'; es decir, estructuras @code{static PyTypeObject} definidas directamente en el código e inicializadas mediante @code{PyType_Ready()}.

Tales tipos son necesariamente compartidos a lo largo del proceso. Compartirlos entre objetos de módulo requiere prestar atención a cualquier estado que posean o al que accedan. Para limitar los posibles problemas, los tipos estáticos son inmutables en el nivel de Python: por ejemplo, no puede configurar @code{str.myattribute = 123}.

`Detalles de implementación de CPython:' Compartir objetos verdaderamente inmutables entre intérpretes está bien, siempre que no proporcionen acceso a objetos mutables. Sin embargo, en CPython, cada objeto de Python tiene un detalle de implementación mutable: el recuento de referencias. Los cambios en el refcount están protegidos por el GIL. Por lo tanto, el código que comparte cualquier objeto de Python entre intérpretes depende implícitamente del GIL actual de todo el proceso de CPython.

Debido a que son inmutables y globales de proceso, los tipos estáticos no pueden acceder a «su» estado de módulo. Si algún método de este tipo requiere acceso al estado del módulo, el tipo debe convertirse a `tipo almacenado en memoria dinámica (heap)' o `tipo heap' para abreviar. Estos se corresponden más estrechamente con las clases creadas por la instrucción @code{class} de Python.

Para los módulos nuevos, usar tipos heap de forma predeterminada es una buena regla general.

@menu
* Cambio de tipos estáticos a tipos heap:: 
* Definición de tipos heap:: 
* Protocolo de recolección de basura:: 
* Acceso al estado del módulo desde las clases:: 
* Acceso al estado del módulo desde métodos regulares:: 
* Acceso al estado del módulo desde métodos de Slot@comma{} Getters y Setters: Acceso al estado del módulo desde métodos de Slot Getters y Setters. 
* Vida útil del estado del módulo:: 

@end menu

@node Cambio de tipos estáticos a tipos heap,Definición de tipos heap,,Tipos Heap<2>
@anchor{howto/isolating-extensions changing-static-types-to-heap-types}@anchor{4f87}
@subsubsection Cambio de tipos estáticos a tipos heap


Los tipos estáticos se pueden convertir en tipos heap, pero tenga en cuenta que la API de tipo heap no se diseñó para la conversión «sin pérdidas» de tipos estáticos, es decir, para crear un tipo que funcione exactamente como un tipo estático determinado. Por lo tanto, al reescribir la definición de clase en una nueva API, es probable que cambie sin querer algunos detalles (por ejemplo, capacidad de selección o espacios heredados). Siempre pruebe los detalles que son importantes para usted.

Tenga cuidado con los siguientes dos puntos en particular (pero tenga en cuenta que esta no es una lista completa):


@itemize *

@item 
Unlike static types, heap type objects are mutable by default.
Use the @ref{2a7,,Py_TPFLAGS_IMMUTABLETYPE} flag to prevent mutability.

@item 
Heap types inherit @ref{623,,tp_new} by default,
so it may become possible to instantiate them from Python code.
You can prevent this with the @ref{626,,Py_TPFLAGS_DISALLOW_INSTANTIATION} flag.
@end itemize

@node Definición de tipos heap,Protocolo de recolección de basura,Cambio de tipos estáticos a tipos heap,Tipos Heap<2>
@anchor{howto/isolating-extensions defining-heap-types}@anchor{4f88}
@subsubsection Definición de tipos heap


Los tipos heap se pueden crear completando una estructura @ref{1721,,PyType_Spec}, una descripción o «modelo» de una clase y llamando a @ref{5f4,,PyType_FromModuleAndSpec()} para construir un nuevo objeto de clase.

@cartouche
@quotation Nota 
Otras funciones, como @ref{621,,PyType_FromSpec()}, también pueden crear tipos heap, pero @ref{5f4,,PyType_FromModuleAndSpec()} asocia el módulo con la clase, lo que permite el acceso al estado del módulo desde los métodos.
@end quotation
@end cartouche

La clase generalmente debe almacenarse en `ambos', el estado del módulo (para acceso seguro desde C) y el @code{__dict__} del módulo (para acceso desde código Python).

@node Protocolo de recolección de basura,Acceso al estado del módulo desde las clases,Definición de tipos heap,Tipos Heap<2>
@anchor{howto/isolating-extensions garbage-collection-protocol}@anchor{4f89}
@subsubsection Protocolo de recolección de basura


Las instancias de tipos heap contienen una referencia a su tipo. Esto garantiza que el tipo no se destruya antes de que se destruyan todas sus instancias, pero puede generar ciclos de referencia que el recolector de elementos no utilizados debe interrumpir.

Para evitar pérdidas de memoria, las instancias de los tipos heap deben implementar el protocolo de recolección de elementos no utilizados. Es decir, los tipos heap deben:


@itemize -

@item 
Have the @ref{817,,Py_TPFLAGS_HAVE_GC} flag.

@item 
Define a traverse function using @code{Py_tp_traverse}, which
visits the type (e.g. using @code{Py_VISIT(Py_TYPE(self))}).
@end itemize

Please refer to the documentation of
@ref{817,,Py_TPFLAGS_HAVE_GC} and @ref{818,,tp_traverse}
for additional considerations.

The API for defining heap types grew organically, leaving it
somewhat awkward to use in its current state.
The following sections will guide you through common issues.

@menu
* tp_traverse in Python 3.8 and lower: tp_traverse in Python 3 8 and lower. 
* Delegating tp_traverse:: 
* Defining tp_dealloc:: 
* Not overriding tp_free:: 
* Avoiding PyObject_New:: 

@end menu

@node tp_traverse in Python 3 8 and lower,Delegating tp_traverse,,Protocolo de recolección de basura
@anchor{howto/isolating-extensions tp-traverse-in-python-3-8-and-lower}@anchor{4f8a}
@subsubsection @code{tp_traverse} in Python 3.8 and lower


The requirement to visit the type from @code{tp_traverse} was added in Python 3.9.
If you support Python 3.8 and lower, the traverse function must `not'
visit the type, so it must be more complicated:

@example
static int my_traverse(PyObject *self, visitproc visit, void *arg)
@{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
    return 0;
@}
@end example

Unfortunately, @ref{7f0,,Py_Version} was only added in Python 3.11.
As a replacement, use:


@itemize *

@item 
@ref{7f1,,PY_VERSION_HEX}, if not using the stable ABI, or

@item 
@ref{741,,sys.version_info} (via @ref{47b,,PySys_GetObject()} and
@ref{615,,PyArg_ParseTuple()}).
@end itemize

@node Delegating tp_traverse,Defining tp_dealloc,tp_traverse in Python 3 8 and lower,Protocolo de recolección de basura
@anchor{howto/isolating-extensions delegating-tp-traverse}@anchor{4f8b}
@subsubsection Delegating @code{tp_traverse}


If your traverse function delegates to the @ref{818,,tp_traverse}
of its base class (or another type), ensure that @code{Py_TYPE(self)} is visited
only once.
Note that only heap type are expected to visit the type in @code{tp_traverse}.

Por ejemplo, si su función poligonal incluye:

@example
base->tp_traverse(self, visit, arg)
@end example

…y @code{base} puede ser un tipo estático, entonces también debe incluir:

@example
if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
    // a heap type's tp_traverse already visited Py_TYPE(self)
@} else @{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
@}
@end example

It is not necessary to handle the type’s reference count in
@ref{623,,tp_new} and @ref{4872,,tp_clear}.

@node Defining tp_dealloc,Not overriding tp_free,Delegating tp_traverse,Protocolo de recolección de basura
@anchor{howto/isolating-extensions defining-tp-dealloc}@anchor{4f8c}
@subsubsection Defining @code{tp_dealloc}


If your type has a custom @ref{485f,,tp_dealloc} function,
it needs to:


@itemize -

@item 
call @ref{1547,,PyObject_GC_UnTrack()} before any fields are invalidated, and

@item 
decrement the reference count of the type.
@end itemize

To keep the type valid while @code{tp_free} is called, the type’s refcount needs
to be decremented `after' the instance is deallocated. For example:

@example
static void my_dealloc(PyObject *self)
@{
    PyObject_GC_UnTrack(self);
    ...
    PyTypeObject *type = Py_TYPE(self);
    type->tp_free(self);
    Py_DECREF(type);
@}
@end example

The default @code{tp_dealloc} function does this, so
if your type does `not' override
@code{tp_dealloc} you don’t need to add it.

@node Not overriding tp_free,Avoiding PyObject_New,Defining tp_dealloc,Protocolo de recolección de basura
@anchor{howto/isolating-extensions not-overriding-tp-free}@anchor{4f8d}
@subsubsection Not overriding @code{tp_free}


The @ref{4860,,tp_free} slot of a heap type must be set to
@ref{1545,,PyObject_GC_Del()}.
This is the default; do not override it.

@node Avoiding PyObject_New,,Not overriding tp_free,Protocolo de recolección de basura
@anchor{howto/isolating-extensions avoiding-pyobject-new}@anchor{4f8e}
@subsubsection Avoiding @code{PyObject_New}


GC-tracked objects need to be allocated using GC-aware functions.

If you use use @ref{a17,,PyObject_New()} or @ref{a18,,PyObject_NewVar()}:


@itemize -

@item 
Get and call type’s @ref{4861,,tp_alloc} slot, if possible.
That is, replace @code{TYPE *o = PyObject_New(TYPE, typeobj)} with:

@example
TYPE *o = typeobj->tp_alloc(typeobj, 0);
@end example

Replace @code{o = PyObject_NewVar(TYPE, typeobj, size)} with the same,
but use size instead of the 0.

@item 
If the above is not possible (e.g. inside a custom @code{tp_alloc}),
call @ref{b2d,,PyObject_GC_New()} or @ref{b2e,,PyObject_GC_NewVar()}:

@example
TYPE *o = PyObject_GC_New(TYPE, typeobj);

TYPE *o = PyObject_GC_NewVar(TYPE, typeobj, size);
@end example
@end itemize

@node Acceso al estado del módulo desde las clases,Acceso al estado del módulo desde métodos regulares,Protocolo de recolección de basura,Tipos Heap<2>
@anchor{howto/isolating-extensions module-state-access-from-classes}@anchor{4f8f}
@subsubsection Acceso al estado del módulo desde las clases


Si tiene un objeto de tipo definido con @ref{5f4,,PyType_FromModuleAndSpec()}, puede llamar a @ref{a00,,PyType_GetModule()} para obtener el módulo asociado y luego a @ref{a12,,PyModule_GetState()} para obtener el estado del módulo.

Para ahorrar un tedioso código repetitivo de manejo de errores, puede combinar estos dos pasos con @ref{a01,,PyType_GetModuleState()}, lo que da como resultado:

@example
my_struct *state = (my_struct*)PyType_GetModuleState(type);
if (state == NULL) @{
    return NULL;
@}
@end example

@node Acceso al estado del módulo desde métodos regulares,Acceso al estado del módulo desde métodos de Slot Getters y Setters,Acceso al estado del módulo desde las clases,Tipos Heap<2>
@anchor{howto/isolating-extensions module-state-access-from-regular-methods}@anchor{4f90}
@subsubsection Acceso al estado del módulo desde métodos regulares


Acceder al estado de nivel de módulo desde los métodos de una clase es algo más complicado, pero es posible gracias a la API introducida en Python 3.9. Para obtener el estado, primero debe obtener la `clase de definición' y luego obtener el estado del módulo.

El obstáculo más grande es obtener `la clase en la que se definió un método', o la «clase de definición» de ese método para abreviar. La clase de definición puede tener una referencia al módulo del que forma parte.

Do not confuse the defining class with @code{Py_TYPE(self)}. If the method
is called on a `subclass' of your type, @code{Py_TYPE(self)} will refer to
that subclass, which may be defined in different module than yours.

@cartouche
@quotation Nota 
El siguiente código de Python puede ilustrar el concepto. @code{Base.get_defining_class} retorna @code{Base} incluso si @code{type(self) == Sub}:

@example
class Base:
    def get_type_of_self(self):
        return type(self)

    def get_defining_class(self):
        return __class__

class Sub(Base):
    pass
@end example
@end quotation
@end cartouche

For a method to get its «defining class», it must use the
@ref{1698,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}
@ref{1517,,calling convention}
and the corresponding @ref{7fe,,PyCMethod} signature:

@example
PyObject *PyCMethod(
    PyObject *self,               // object the method was called on
    PyTypeObject *defining_class, // defining class
    PyObject *const *args,        // C array of arguments
    Py_ssize_t nargs,             // length of "args"
    PyObject *kwnames)            // NULL, or dict of keyword arguments
@end example

Una vez que tenga la clase de definición, llame a @ref{a01,,PyType_GetModuleState()} para obtener el estado de su módulo asociado.

Por ejemplo:

@example
static PyObject *
example_method(PyObject *self,
        PyTypeObject *defining_class,
        PyObject *const *args,
        Py_ssize_t nargs,
        PyObject *kwnames)
@{
    my_struct *state = (my_struct*)PyType_GetModuleState(defining_class);
    if (state == NULL) @{
        return NULL;
    @}
    ... // rest of logic
@}

PyDoc_STRVAR(example_method_doc, "...");

static PyMethodDef my_methods[] = @{
    @{"example_method",
      (PyCFunction)(void(*)(void))example_method,
      METH_METHOD|METH_FASTCALL|METH_KEYWORDS,
      example_method_doc@}
    @{NULL@},
@}
@end example

@node Acceso al estado del módulo desde métodos de Slot Getters y Setters,Vida útil del estado del módulo,Acceso al estado del módulo desde métodos regulares,Tipos Heap<2>
@anchor{howto/isolating-extensions module-state-access-from-slot-methods-getters-and-setters}@anchor{4f91}
@subsubsection Acceso al estado del módulo desde métodos de Slot, Getters y Setters


@cartouche
@quotation Nota 
Esto es nuevo en Python 3.11.

@c After adding to limited API:
@c 
@c If you use the :ref:`limited API <limited-c-api>`,
@c you must update ``Py_LIMITED_API`` to ``0x030b0000``, losing ABI
@c compatibility with earlier versions.
@end quotation
@end cartouche

Slot methods—the fast C equivalents for special methods, such as
@ref{4b22,,nb_add} for @ref{1f8c,,__add__} or
@ref{623,,tp_new} for initialization—have a very simple API that
doesn’t allow passing in the defining class, unlike with @ref{7fe,,PyCMethod}.
The same goes for getters and setters defined with
@ref{c40,,PyGetSetDef}.

Para acceder al estado del módulo en estos casos, utilice la función @ref{486,,PyType_GetModuleByDef()} y pase la definición del módulo. Una vez que tenga el módulo, llame a @ref{a12,,PyModule_GetState()} para obtener el estado:

@example
PyObject *module = PyType_GetModuleByDef(Py_TYPE(self), &module_def);
my_struct *state = (my_struct*)PyModule_GetState(module);
if (state == NULL) @{
    return NULL;
@}
@end example

@code{PyType_GetModuleByDef()} works by searching the
@ref{2188,,method resolution order} (i.e. all superclasses) for the first
superclass that has a corresponding module.

@cartouche
@quotation Nota 
In very exotic cases (inheritance chains spanning multiple modules
created from the same definition), @code{PyType_GetModuleByDef()} might not
return the module of the true defining class. However, it will always
return a module with the same definition, ensuring a compatible
C memory layout.
@end quotation
@end cartouche

@node Vida útil del estado del módulo,,Acceso al estado del módulo desde métodos de Slot Getters y Setters,Tipos Heap<2>
@anchor{howto/isolating-extensions lifetime-of-the-module-state}@anchor{4f92}
@subsubsection Vida útil del estado del módulo


Cuando un objeto de módulo se recolecta como basura, se libera su estado de módulo. Para cada puntero a (una parte de) el estado del módulo, debe tener una referencia al objeto del módulo.

Por lo general, esto no es un problema, porque los tipos creados con @ref{5f4,,PyType_FromModuleAndSpec()} y sus instancias contienen una referencia al módulo. Sin embargo, debe tener cuidado en el recuento de referencias cuando hace referencia al estado del módulo desde otros lugares, como devoluciones de llamada para bibliotecas externas.

@node Problemas abiertos,,Tipos Heap<2>,Aislamiento de módulos de extensión
@anchor{howto/isolating-extensions open-issues}@anchor{4f93}
@subsection Problemas abiertos


Varios problemas relacionados con el estado por módulo y los tipos heap todavía están abiertos.

Las discusiones sobre cómo mejorar la situación se llevan a cabo mejor en el capi-sig mailing list@footnote{https://mail.python.org/mailman3/lists/capi-sig.python.org/}.

@menu
* Alcance por clase:: 
* Conversión sin pérdidas a tipos heap:: 

@end menu

@node Alcance por clase,Conversión sin pérdidas a tipos heap,,Problemas abiertos
@anchor{howto/isolating-extensions per-class-scope}@anchor{4f94}
@subsubsection Alcance por clase


Actualmente (a partir de Python 3.11) no es posible adjuntar estado a `tipos' individuales sin depender de los detalles de implementación de CPython (que pueden cambiar en el futuro, tal vez, irónicamente, para permitir una solución adecuada para el alcance por clase).

@node Conversión sin pérdidas a tipos heap,,Alcance por clase,Problemas abiertos
@anchor{howto/isolating-extensions lossless-conversion-to-heap-types}@anchor{4f95}
@subsubsection Conversión sin pérdidas a tipos heap


La API de tipo heap no se diseñó para la conversión «sin pérdidas» de tipos estáticos; es decir, crear un tipo que funcione exactamente como un tipo estático determinado.

@node timer file descriptor HOWTO,The Python 2 3 Method Resolution Order,Aislamiento de módulos de extensión,Comos HOWTOs de Python
@anchor{howto/timerfd doc}@anchor{4f96}@anchor{howto/timerfd timer-file-descriptor-howto}@anchor{4f97}@anchor{howto/timerfd timerfd-howto}@anchor{4f98}
@section timer file descriptor HOWTO


@*Release: 
1.13


This HOWTO discusses Python’s support for the linux timer file descriptor.

@menu
* Examples: Examples<3>. 

@end menu

@node Examples<3>,,,timer file descriptor HOWTO
@anchor{howto/timerfd examples}@anchor{4f99}
@subsection Examples


The following example shows how to use a timer file descriptor
to execute a function twice a second:

@example
# Practical scripts should use really use a non-blocking timer,
# we use a blocking timer here for simplicity.
import os, time

# Create the timer file descriptor
fd = os.timerfd_create(time.CLOCK_REALTIME)

# Start the timer in 1 second, with an interval of half a second
os.timerfd_settime(fd, initial=1, interval=0.5)

try:
    # Process timer events four times.
    for _ in range(4):
        # read() will block until the timer expires
        _ = os.read(fd, 8)
        print("Timer expired")
finally:
    # Remember to close the timer file descriptor!
    os.close(fd)
@end example

To avoid the precision loss caused by the @ref{153,,float} type,
timer file descriptors allow specifying initial expiration and interval
in integer nanoseconds with @code{_ns} variants of the functions.

This example shows how @ref{1012,,epoll()} can be used with timer file
descriptors to wait until the file descriptor is ready for reading:

@example
import os, time, select, socket, sys

# Create an epoll object
ep = select.epoll()

# In this example, use loopback address to send "stop" command to the server.
#
# $ telnet 127.0.0.1 1234
# Trying 127.0.0.1...
# Connected to 127.0.0.1.
# Escape character is '^]'.
# stop
# Connection closed by foreign host.
#
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.bind(("127.0.0.1", 1234))
sock.setblocking(False)
sock.listen(1)
ep.register(sock, select.EPOLLIN)

# Create timer file descriptors in non-blocking mode.
num = 3
fds = []
for _ in range(num):
    fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
    fds.append(fd)
    # Register the timer file descriptor for read events
    ep.register(fd, select.EPOLLIN)

# Start the timer with os.timerfd_settime_ns() in nanoseconds.
# Timer 1 fires every 0.25 seconds; timer 2 every 0.5 seconds; etc
for i, fd in enumerate(fds, start=1):
    one_sec_in_nsec = 10**9
    i = i * one_sec_in_nsec
    os.timerfd_settime_ns(fd, initial=i//4, interval=i//4)

timeout = 3
try:
    conn = None
    is_active = True
    while is_active:
        # Wait for the timer to expire for 3 seconds.
        # epoll.poll() returns a list of (fd, event) pairs.
        # fd is a file descriptor.
        # sock and conn[=returned value of socket.accept()] are socket objects, not file descriptors.
        # So use sock.fileno() and conn.fileno() to get the file descriptors.
        events = ep.poll(timeout)

        # If more than one timer file descriptors are ready for reading at once,
        # epoll.poll() returns a list of (fd, event) pairs.
        #
        # In this example settings,
        #    1st timer fires every 0.25 seconds in 0.25 seconds. (0.25, 0.5, 0.75, 1.0, ...)
        #    2nd timer every 0.5 seconds in 0.5 seconds. (0.5, 1.0, 1.5, 2.0, ...)
        #    3rd timer every 0.75 seconds in 0.75 seconds. (0.75, 1.5, 2.25, 3.0, ...)
        #
        #    In 0.25 seconds, only 1st timer fires.
        #    In 0.5 seconds, 1st timer and 2nd timer fires at once.
        #    In 0.75 seconds, 1st timer and 3rd timer fires at once.
        #    In 1.5 seconds, 1st timer, 2nd timer and 3rd timer fires at once.
        #
        # If a timer file descriptor is signaled more than once since
        # the last os.read() call, os.read() returns the number of signaled
        # as host order of class bytes.
        print(f"Signaled events=@{events@}")
        for fd, event in events:
            if event & select.EPOLLIN:
                if fd == sock.fileno():
                    # Check if there is a connection request.
                    print(f"Accepting connection @{fd@}")
                    conn, addr = sock.accept()
                    conn.setblocking(False)
                    print(f"Accepted connection @{conn@} from @{addr@}")
                    ep.register(conn, select.EPOLLIN)
                elif conn and fd == conn.fileno():
                    # Check if there is data to read.
                    print(f"Reading data @{fd@}")
                    data = conn.recv(1024)
                    if data:
                        # You should catch UnicodeDecodeError exception for safety.
                        cmd = data.decode()
                        if cmd.startswith("stop"):
                            print(f"Stopping server")
                            is_active = False
                        else:
                            print(f"Unknown command: @{cmd@}")
                    else:
                        # No more data, close connection
                        print(f"Closing connection @{fd@}")
                        ep.unregister(conn)
                        conn.close()
                        conn = None
                elif fd in fds:
                    print(f"Reading timer @{fd@}")
                    count = int.from_bytes(os.read(fd, 8), byteorder=sys.byteorder)
                    print(f"Timer @{fds.index(fd) + 1@} expired @{count@} times")
                else:
                    print(f"Unknown file descriptor @{fd@}")
finally:
    for fd in fds:
        ep.unregister(fd)
        os.close(fd)
    ep.close()
@end example

This example shows how @ref{e26,,select()} can be used with timer file
descriptors to wait until the file descriptor is ready for reading:

@example
import os, time, select, socket, sys

# In this example, use loopback address to send "stop" command to the server.
#
# $ telnet 127.0.0.1 1234
# Trying 127.0.0.1...
# Connected to 127.0.0.1.
# Escape character is '^]'.
# stop
# Connection closed by foreign host.
#
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.bind(("127.0.0.1", 1234))
sock.setblocking(False)
sock.listen(1)

# Create timer file descriptors in non-blocking mode.
num = 3
fds = [os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
       for _ in range(num)]
select_fds = fds + [sock]

# Start the timers with os.timerfd_settime() in seconds.
# Timer 1 fires every 0.25 seconds; timer 2 every 0.5 seconds; etc
for i, fd in enumerate(fds, start=1):
   os.timerfd_settime(fd, initial=i/4, interval=i/4)

timeout = 3
try:
    conn = None
    is_active = True
    while is_active:
       # Wait for the timer to expire for 3 seconds.
       # select.select() returns a list of file descriptors or objects.
       rfd, wfd, xfd = select.select(select_fds, select_fds, select_fds, timeout)
       for fd in rfd:
           if fd == sock:
               # Check if there is a connection request.
               print(f"Accepting connection @{fd@}")
               conn, addr = sock.accept()
               conn.setblocking(False)
               print(f"Accepted connection @{conn@} from @{addr@}")
               select_fds.append(conn)
           elif conn and fd == conn:
               # Check if there is data to read.
               print(f"Reading data @{fd@}")
               data = conn.recv(1024)
               if data:
                   # You should catch UnicodeDecodeError exception for safety.
                   cmd = data.decode()
                   if cmd.startswith("stop"):
                       print(f"Stopping server")
                       is_active = False
                   else:
                       print(f"Unknown command: @{cmd@}")
               else:
                   # No more data, close connection
                   print(f"Closing connection @{fd@}")
                   select_fds.remove(conn)
                   conn.close()
                   conn = None
           elif fd in fds:
               print(f"Reading timer @{fd@}")
               count = int.from_bytes(os.read(fd, 8), byteorder=sys.byteorder)
               print(f"Timer @{fds.index(fd) + 1@} expired @{count@} times")
           else:
               print(f"Unknown file descriptor @{fd@}")
finally:
    for fd in fds:
       os.close(fd)
    sock.close()
    sock = None
@end example

@node The Python 2 3 Method Resolution Order,Python experimental support for free threading,timer file descriptor HOWTO,Comos HOWTOs de Python
@anchor{howto/mro doc}@anchor{4f9a}@anchor{howto/mro python-2-3-mro}@anchor{14e6}@anchor{howto/mro the-python-2-3-method-resolution-order}@anchor{4f9b}
@section The Python 2.3 Method Resolution Order


@cartouche
@quotation Nota 
This is a historical document, provided as an appendix to the official
documentation.
The Method Resolution Order discussed here was `introduced' in Python 2.3,
but it is still used in later versions – including Python 3.
@end quotation
@end cartouche

By Michele Simionato@footnote{https://www.phyast.pitt.edu/~micheles/}.

@*Abstract: 
`This document is intended for Python programmers who want to
understand the C3 Method Resolution Order used in Python 2.3.
Although it is not intended for newbies, it is quite pedagogical with
many worked out examples.  I am not aware of other publicly available
documents with the same scope, therefore it should be useful.'


Disclaimer:

@quotation

`I donate this document to the Python Software Foundation, under the
Python 2.3 license.  As usual in these circumstances, I warn the
reader that what follows' should `be correct, but I don’t give any
warranty.  Use it at your own risk and peril!'
@end quotation

Acknowledgments:

@quotation

`All the people of the Python mailing list who sent me their support.
Paul Foley who pointed out various imprecisions and made me to add the
part on local precedence ordering. David Goodger for help with the
formatting in reStructuredText. David Mertz for help with the editing.
Finally, Guido van Rossum who enthusiastically added this document to
the official Python 2.3 home-page.'
@end quotation

@menu
* The beginning:: 
* The C3 Method Resolution Order:: 
* Examples: Examples<4>. 
* Bad Method Resolution Orders:: 
* The end:: 
* Resources:: 

@end menu

@node The beginning,The C3 Method Resolution Order,,The Python 2 3 Method Resolution Order
@anchor{howto/mro the-beginning}@anchor{4f9c}
@subsection The beginning


@quotation

`Felix qui potuit rerum cognoscere causas' – Virgilius
@end quotation

Everything started with a post by Samuele Pedroni to the Python
development mailing list @footnote{
The thread on python-dev started by Samuele Pedroni:
@indicateurl{https://mail.python.org/pipermail/python-dev/2002-October/029035.html}
}.  In his post, Samuele showed that the
Python 2.2 method resolution order is not monotonic and he proposed to
replace it with the C3 method resolution order.  Guido agreed with his
arguments and therefore now Python 2.3 uses C3.  The C3 method itself
has nothing to do with Python, since it was invented by people working
on Dylan and it is described in a paper intended for lispers @footnote{
The paper `A Monotonic Superclass Linearization for Dylan':
@indicateurl{https://doi.org/10.1145/236337.236343}
}.  The
present paper gives a (hopefully) readable discussion of the C3
algorithm for Pythonistas who want to understand the reasons for the
change.

First of all, let me point out that what I am going to say only applies
to the `new style classes' introduced in Python 2.2:  `classic classes'
maintain their old method resolution order, depth first and then left to
right.  Therefore, there is no breaking of old code for classic classes;
and even if in principle there could be breaking of code for Python 2.2
new style classes, in practice the cases in which the C3 resolution
order differs from the Python 2.2 method resolution order are so rare
that no real breaking of code is expected.  Therefore:

@quotation

`Don’t be scared!'
@end quotation

Moreover, unless you make strong use of multiple inheritance and you
have non-trivial hierarchies, you don’t need to understand the C3
algorithm, and you can easily skip this paper.  On the other hand, if
you really want to know how multiple inheritance works, then this paper
is for you.  The good news is that things are not as complicated as you
might expect.

Let me begin with some basic definitions.


@enumerate 

@item 
Given a class C in a complicated multiple inheritance hierarchy, it
is a non-trivial task to specify the order in which methods are
overridden, i.e. to specify the order of the ancestors of C.

@item 
The list of the ancestors of a class C, including the class itself,
ordered from the nearest ancestor to the furthest, is called the
class precedence list or the `linearization' of C.

@item 
The `Method Resolution Order' (MRO) is the set of rules that
construct the linearization.  In the Python literature, the idiom
«the MRO of C» is also used as a synonymous for the linearization of
the class C.

@item 
For instance, in the case of single inheritance hierarchy, if C is a
subclass of C1, and C1 is a subclass of C2, then the linearization of
C is simply the list [C, C1 , C2].  However, with multiple
inheritance hierarchies, the construction of the linearization is
more cumbersome, since it is more difficult to construct a
linearization that respects `local precedence ordering' and
`monotonicity'.

@item 
I will discuss the local precedence ordering later, but I can give
the definition of monotonicity here.  A MRO is monotonic when the
following is true:  `if C1 precedes C2 in the linearization of C,
then C1 precedes C2 in the linearization of any subclass of C'.
Otherwise, the innocuous operation of deriving a new class could
change the resolution order of methods, potentially introducing very
subtle bugs.  Examples where this happens will be shown later.

@item 
Not all classes admit a linearization.  There are cases, in
complicated hierarchies, where it is not possible to derive a class
such that its linearization respects all the desired properties.
@end enumerate

Here I give an example of this situation. Consider the hierarchy

@example
>>> O = object
>>> class X(O): pass
>>> class Y(O): pass
>>> class A(X,Y): pass
>>> class B(Y,X): pass
@end example

which can be represented with the following inheritance graph, where I
have denoted with O the @code{object} class, which is the beginning of any
hierarchy for new style classes:

@quotation

@example
 -----------
|           |
|    O      |
|  /   \    |
 - X    Y  /
   |  / | /
   | /  |/
   A    B
   \   /
     ?
@end example
@end quotation

In this case, it is not possible to derive a new class C from A and B,
since X precedes Y in A, but Y precedes X in B, therefore the method
resolution order would be ambiguous in C.

Python 2.3 raises an exception in this situation (TypeError:  MRO
conflict among bases Y, X) forbidding the naive programmer from creating
ambiguous hierarchies.  Python 2.2 instead does not raise an exception,
but chooses an `ad hoc' ordering (CABXYO in this case).

@node The C3 Method Resolution Order,Examples<4>,The beginning,The Python 2 3 Method Resolution Order
@anchor{howto/mro the-c3-method-resolution-order}@anchor{4f9d}
@subsection The C3 Method Resolution Order


Let me introduce a few simple notations which will be useful for the
following discussion.  I will use the shortcut notation:

@example
C1 C2 ... CN
@end example

to indicate the list of classes [C1, C2, … , CN].

The `head' of the list is its first element:

@example
head = C1
@end example

whereas the `tail' is the rest of the list:

@example
tail = C2 ... CN.
@end example

I shall also use the notation:

@example
C + (C1 C2 ... CN) = C C1 C2 ... CN
@end example

to denote the sum of the lists [C] + [C1, C2, … ,CN].

Now I can explain how the MRO works in Python 2.3.

Consider a class C in a multiple inheritance hierarchy, with C
inheriting from the base classes B1, B2, …  , BN.  We want to
compute the linearization L[C] of the class C. The rule is the
following:

@quotation

`the linearization of C is the sum of C plus the merge of the
linearizations of the parents and the list of the parents.'
@end quotation

In symbolic notation:

@example
L[C(B1 ... BN)] = C + merge(L[B1] ... L[BN], B1 ... BN)
@end example

In particular, if C is the @code{object} class, which has no parents, the
linearization is trivial:

@example
L[object] = object.
@end example

However, in general one has to compute the merge according to the following
prescription:

@quotation

`take the head of the first list, i.e L[B1][0]; if this head is not in
the tail of any of the other lists, then add it to the linearization
of C and remove it from the lists in the merge, otherwise look at the
head of the next list and take it, if it is a good head.  Then repeat
the operation until all the class are removed or it is impossible to
find good heads.  In this case, it is impossible to construct the
merge, Python 2.3 will refuse to create the class C and will raise an
exception.'
@end quotation

This prescription ensures that the merge operation `preserves' the
ordering, if the ordering can be preserved.  On the other hand, if the
order cannot be preserved (as in the example of serious order
disagreement discussed above) then the merge cannot be computed.

The computation of the merge is trivial if C has only one parent
(single inheritance); in this case:

@example
L[C(B)] = C + merge(L[B],B) = C + L[B]
@end example

However, in the case of multiple inheritance things are more cumbersome
and I don’t expect you can understand the rule without a couple of
examples ;-)

@node Examples<4>,Bad Method Resolution Orders,The C3 Method Resolution Order,The Python 2 3 Method Resolution Order
@anchor{howto/mro examples}@anchor{4f9e}
@subsection Examples


First example. Consider the following hierarchy:

@example
>>> O = object
>>> class F(O): pass
>>> class E(O): pass
>>> class D(O): pass
>>> class C(D,F): pass
>>> class B(D,E): pass
>>> class A(B,C): pass
@end example

In this case the inheritance graph can be drawn as:

@quotation

@example
                          6
                         ---
Level 3                 | O |                  (more general)
                      /  ---  \
                     /    |    \                      |
                    /     |     \                     |
                   /      |      \                    |
                  ---    ---    ---                   |
Level 2        3 | D | 4| E |  | F | 5                |
                  ---    ---    ---                   |
                   \  \ _ /       |                   |
                    \    / \ _    |                   |
                     \  /      \  |                   |
                      ---      ---                    |
Level 1            1 | B |    | C | 2                 |
                      ---      ---                    |
                        \      /                      |
                         \    /                      \ /
                           ---
Level 0                 0 | A |                (more specialized)
                           ---
@end example
@end quotation

The linearizations of O,D,E and F are trivial:

@example
L[O] = O
L[D] = D O
L[E] = E O
L[F] = F O
@end example

The linearization of B can be computed as:

@example
L[B] = B + merge(DO, EO, DE)
@end example

We see that D is a good head, therefore we take it and we are reduced to
compute @code{merge(O,EO,E)}.  Now O is not a good head, since it is in the
tail of the sequence EO.  In this case the rule says that we have to
skip to the next sequence.  Then we see that E is a good head; we take
it and we are reduced to compute @code{merge(O,O)} which gives O. Therefore:

@example
L[B] =  B D E O
@end example

Using the same procedure one finds:

@example
L[C] = C + merge(DO,FO,DF)
     = C + D + merge(O,FO,F)
     = C + D + F + merge(O,O)
     = C D F O
@end example

Now we can compute:

@example
L[A] = A + merge(BDEO,CDFO,BC)
     = A + B + merge(DEO,CDFO,C)
     = A + B + C + merge(DEO,DFO)
     = A + B + C + D + merge(EO,FO)
     = A + B + C + D + E + merge(O,FO)
     = A + B + C + D + E + F + merge(O,O)
     = A B C D E F O
@end example

In this example, the linearization is ordered in a pretty nice way
according to the inheritance level, in the sense that lower levels (i.e.
more specialized classes) have higher precedence (see the inheritance
graph).  However, this is not the general case.

I leave as an exercise for the reader to compute the linearization for
my second example:

@example
>>> O = object
>>> class F(O): pass
>>> class E(O): pass
>>> class D(O): pass
>>> class C(D,F): pass
>>> class B(E,D): pass
>>> class A(B,C): pass
@end example

The only difference with the previous example is the change B(D,E) –>
B(E,D); however even such a little modification completely changes the
ordering of the hierarchy:

@quotation

@example
                           6
                          ---
Level 3                  | O |
                       /  ---  \
                      /    |    \
                     /     |     \
                    /      |      \
                  ---     ---    ---
Level 2        2 | E | 4 | D |  | F | 5
                  ---     ---    ---
                   \      / \     /
                    \    /   \   /
                     \  /     \ /
                      ---     ---
Level 1            1 | B |   | C | 3
                      ---     ---
                       \       /
                        \     /
                          ---
Level 0                0 | A |
                          ---
@end example
@end quotation

Notice that the class E, which is in the second level of the hierarchy,
precedes the class C, which is in the first level of the hierarchy, i.e.
E is more specialized than C, even if it is in a higher level.

A lazy programmer can obtain the MRO directly from Python 2.2, since in
this case it coincides with the Python 2.3 linearization.  It is enough
to invoke the @ref{1f2c,,mro()} method of class A:

@example
>>> A.mro()  
[<class 'A'>, <class 'B'>, <class 'E'>,
<class 'C'>, <class 'D'>, <class 'F'>,
<class 'object'>]
@end example

Finally, let me consider the example discussed in the first section,
involving a serious order disagreement.  In this case, it is
straightforward to compute the linearizations of O, X, Y, A and B:

@quotation

@example
L[O] = 0
L[X] = X O
L[Y] = Y O
L[A] = A X Y O
L[B] = B Y X O
@end example
@end quotation

However, it is impossible to compute the linearization for a class C
that inherits from A and B:

@example
L[C] = C + merge(AXYO, BYXO, AB)
     = C + A + merge(XYO, BYXO, B)
     = C + A + B + merge(XYO, YXO)
@end example

At this point we cannot merge the lists XYO and YXO, since X is in the
tail of YXO whereas Y is in the tail of XYO:  therefore there are no
good heads and the C3 algorithm stops.  Python 2.3 raises an error and
refuses to create the class C.

@node Bad Method Resolution Orders,The end,Examples<4>,The Python 2 3 Method Resolution Order
@anchor{howto/mro bad-method-resolution-orders}@anchor{4f9f}
@subsection Bad Method Resolution Orders


A MRO is `bad' when it breaks such fundamental properties as local
precedence ordering and monotonicity.  In this section, I will show
that both the MRO for classic classes and the MRO for new style classes
in Python 2.2 are bad.

It is easier to start with the local precedence ordering.  Consider the
following example:

@example
>>> F=type('Food',(),@{'remember2buy':'spam'@})
>>> E=type('Eggs',(F,),@{'remember2buy':'eggs'@})
>>> G=type('GoodFood',(F,E),@{@}) # under Python 2.3 this is an error!  
@end example

with inheritance diagram

@quotation

@example
             O
             |
(buy spam)   F
             | \
             | E   (buy eggs)
             | /
             G

      (buy eggs or spam ?)
@end example
@end quotation

We see that class G inherits from F and E, with F `before' E:  therefore
we would expect the attribute `G.remember2buy' to be inherited by
`F.rembermer2buy' and not by `E.remember2buy':  nevertheless Python 2.2
gives

@example
>>> G.remember2buy  
'eggs'
@end example

This is a breaking of local precedence ordering since the order in the
local precedence list, i.e. the list of the parents of G, is not
preserved in the Python 2.2 linearization of G:

@example
L[G,P22]= G E F object   # F *follows* E
@end example

One could argue that the reason why F follows E in the Python 2.2
linearization is that F is less specialized than E, since F is the
superclass of E; nevertheless the breaking of local precedence ordering
is quite non-intuitive and error prone.  This is particularly true since
it is a different from old style classes:

@example
>>> class F: remember2buy='spam'
>>> class E(F): remember2buy='eggs'
>>> class G(F,E): pass  
>>> G.remember2buy  
'spam'
@end example

In this case the MRO is GFEF and the local precedence ordering is
preserved.

As a general rule, hierarchies such as the previous one should be
avoided, since it is unclear if F should override E or vice-versa.
Python 2.3 solves the ambiguity by raising an exception in the creation
of class G, effectively stopping the programmer from generating
ambiguous hierarchies.  The reason for that is that the C3 algorithm
fails when the merge:

@example
merge(FO,EFO,FE)
@end example

cannot be computed, because F is in the tail of EFO and E is in the tail
of FE.

The real solution is to design a non-ambiguous hierarchy, i.e. to derive
G from E and F (the more specific first) and not from F and E; in this
case the MRO is GEF without any doubt.

@quotation

@example
           O
           |
           F (spam)
         / |
(eggs)   E |
         \ |
           G
             (eggs, no doubt)
@end example
@end quotation

Python 2.3 forces the programmer to write good hierarchies (or, at
least, less error-prone ones).

On a related note, let me point out that the Python 2.3 algorithm is
smart enough to recognize obvious mistakes, as the duplication of
classes in the list of parents:

@example
>>> class A(object): pass
>>> class C(A,A): pass # error
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
TypeError: duplicate base class A
@end example

Python 2.2 (both for classic classes and new style classes) in this
situation, would not raise any exception.

Finally, I would like to point out two lessons we have learned from this
example:


@enumerate 

@item 
despite the name, the MRO determines the resolution order of
attributes, not only of methods;

@item 
the default food for Pythonistas is spam !  (but you already knew
that ;-)
@end enumerate

Having discussed the issue of local precedence ordering, let me now
consider the issue of monotonicity.  My goal is to show that neither the
MRO for classic classes nor that for Python 2.2 new style classes is
monotonic.

To prove that the MRO for classic classes is non-monotonic is rather
trivial, it is enough to look at the diamond diagram:

@quotation

@example
   C
  / \
 /   \
A     B
 \   /
  \ /
   D
@end example
@end quotation

One easily discerns the inconsistency:

@example
L[B,P21] = B C        # B precedes C : B's methods win
L[D,P21] = D A C B C  # B follows C  : C's methods win!
@end example

On the other hand, there are no problems with the Python 2.2 and 2.3
MROs, they give both:

@example
L[D] = D A B C
@end example

Guido points out in his essay @footnote{
Guido van Rossum’s essay, `Unifying types and classes in Python 2.2':
@indicateurl{https://web.archive.org/web/20140210194412/http://www.python.org/download/releases/2.2.2/descrintro}
} that the classic MRO is not so bad in
practice, since one can typically avoids diamonds for classic classes.
But all new style classes inherit from @code{object}, therefore diamonds are
unavoidable and inconsistencies shows up in every multiple inheritance
graph.

The MRO of Python 2.2 makes breaking monotonicity difficult, but not
impossible.  The following example, originally provided by Samuele
Pedroni, shows that the MRO of Python 2.2 is non-monotonic:

@example
>>> class A(object): pass
>>> class B(object): pass
>>> class C(object): pass
>>> class D(object): pass
>>> class E(object): pass
>>> class K1(A,B,C): pass
>>> class K2(D,B,E): pass
>>> class K3(D,A):   pass
>>> class Z(K1,K2,K3): pass
@end example

Here are the linearizations according to the C3 MRO (the reader should
verify these linearizations as an exercise and draw the inheritance
diagram ;-)

@example
L[A] = A O
L[B] = B O
L[C] = C O
L[D] = D O
L[E] = E O
L[K1]= K1 A B C O
L[K2]= K2 D B E O
L[K3]= K3 D A O
L[Z] = Z K1 K2 K3 D A B C E O
@end example

Python 2.2 gives exactly the same linearizations for A, B, C, D, E, K1,
K2 and K3, but a different linearization for Z:

@example
L[Z,P22] = Z K1 K3 A K2 D B C E O
@end example

It is clear that this linearization is `wrong', since A comes before D
whereas in the linearization of K3 A comes `after' D. In other words, in
K3 methods derived by D override methods derived by A, but in Z, which
still is a subclass of K3, methods derived by A override methods derived
by D!  This is a violation of monotonicity.  Moreover, the Python 2.2
linearization of Z is also inconsistent with local precedence ordering,
since the local precedence list of the class Z is [K1, K2, K3] (K2
precedes K3), whereas in the linearization of Z K2 `follows' K3.  These
problems explain why the 2.2 rule has been dismissed in favor of the C3
rule.

@node The end,Resources,Bad Method Resolution Orders,The Python 2 3 Method Resolution Order
@anchor{howto/mro the-end}@anchor{4fa0}
@subsection The end


This section is for the impatient reader, who skipped all the previous
sections and jumped immediately to the end.  This section is for the
lazy programmer too, who didn’t want to exercise her/his brain.
Finally, it is for the programmer with some hubris, otherwise s/he would
not be reading a paper on the C3 method resolution order in multiple
inheritance hierarchies ;-) These three virtues taken all together (and
`not' separately) deserve a prize:  the prize is a short Python 2.2
script that allows you to compute the 2.3 MRO without risk to your
brain.  Simply change the last line to play with the various examples I
have discussed in this paper.:

@example
#<mro.py>

"""C3 algorithm by Samuele Pedroni (with readability enhanced by me)."""

class __metaclass__(type):
    "All classes are metamagically modified to be nicely printed"
    __repr__ = lambda cls: cls.__name__

class ex_2:
    "Serious order disagreement" #From Guido
    class O: pass
    class X(O): pass
    class Y(O): pass
    class A(X,Y): pass
    class B(Y,X): pass
    try:
        class Z(A,B): pass #creates Z(A,B) in Python 2.2
    except TypeError:
        pass # Z(A,B) cannot be created in Python 2.3

class ex_5:
    "My first example"
    class O: pass
    class F(O): pass
    class E(O): pass
    class D(O): pass
    class C(D,F): pass
    class B(D,E): pass
    class A(B,C): pass

class ex_6:
    "My second example"
    class O: pass
    class F(O): pass
    class E(O): pass
    class D(O): pass
    class C(D,F): pass
    class B(E,D): pass
    class A(B,C): pass

class ex_9:
    "Difference between Python 2.2 MRO and C3" #From Samuele
    class O: pass
    class A(O): pass
    class B(O): pass
    class C(O): pass
    class D(O): pass
    class E(O): pass
    class K1(A,B,C): pass
    class K2(D,B,E): pass
    class K3(D,A): pass
    class Z(K1,K2,K3): pass

def merge(seqs):
    print '\n\nCPL[%s]=%s' % (seqs[0][0],seqs),
    res = []; i=0
    while 1:
      nonemptyseqs=[seq for seq in seqs if seq]
      if not nonemptyseqs: return res
      i+=1; print '\n',i,'round: candidates...',
      for seq in nonemptyseqs: # find merge candidates among seq heads
          cand = seq[0]; print ' ',cand,
          nothead=[s for s in nonemptyseqs if cand in s[1:]]
          if nothead: cand=None #reject candidate
          else: break
      if not cand: raise "Inconsistent hierarchy"
      res.append(cand)
      for seq in nonemptyseqs: # remove cand
          if seq[0] == cand: del seq[0]

def mro(C):
    "Compute the class precedence list (mro) according to C3"
    return merge([[C]]+map(mro,C.__bases__)+[list(C.__bases__)])

def print_mro(C):
    print '\nMRO[%s]=%s' % (C,mro(C))
    print '\nP22 MRO[%s]=%s' % (C,C.mro())

print_mro(ex_9.Z)

#</mro.py>
@end example

That’s all folks,

@quotation

enjoy !
@end quotation

@node Resources,,The end,The Python 2 3 Method Resolution Order
@anchor{howto/mro resources}@anchor{4fa1}
@subsection Resources


@node Python experimental support for free threading,C API Extension Support for Free Threading,The Python 2 3 Method Resolution Order,Comos HOWTOs de Python
@anchor{howto/free-threading-python doc}@anchor{4fa2}@anchor{howto/free-threading-python freethreading-python-howto}@anchor{4fa3}@anchor{howto/free-threading-python python-experimental-support-for-free-threading}@anchor{4fa4}
@section Python experimental support for free threading


Starting with the 3.13 release, CPython has experimental support for a build of
Python called @ref{43ec,,free threading} where the @ref{2b5,,global interpreter lock}
(GIL) is disabled.  Free-threaded execution allows for full utilization of the
available processing power by running threads in parallel on available CPU cores.
While not all software will benefit from this automatically, programs
designed with threading in mind will run faster on multi-core hardware.

`The free-threaded mode is experimental' and work is ongoing to improve it:
expect some bugs and a substantial single-threaded performance hit.

This document describes the implications of free threading
for Python code.  See @ref{4fa5,,C API Extension Support for Free Threading} for information on
how to write C extensions that support the free-threaded build.


@subsubheading Ver también


@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} – Making the Global Interpreter Lock Optional in CPython for an
overall description of free-threaded Python.


@menu
* Installation:: 
* Identifying free-threaded Python:: 
* The global interpreter lock in free-threaded Python:: 
* Thread safety:: 
* Known limitations:: 

@end menu

@node Installation,Identifying free-threaded Python,,Python experimental support for free threading
@anchor{howto/free-threading-python installation}@anchor{4fa6}
@subsection Installation


Starting with Python 3.13, the official macOS and Windows installers
optionally support installing free-threaded Python binaries.  The installers
are available at @indicateurl{https://www.python.org/downloads/}.

For information on other platforms, see the Installing a Free-Threaded Python@footnote{https://py-free-threading.github.io/installing_cpython/}, a
community-maintained installation guide for installing free-threaded Python.

When building CPython from source, the @ref{2e0,,--disable-gil} configure option
should be used to build a free-threaded Python interpreter.

@node Identifying free-threaded Python,The global interpreter lock in free-threaded Python,Installation,Python experimental support for free threading
@anchor{howto/free-threading-python identifying-free-threaded-python}@anchor{4fa7}
@subsection Identifying free-threaded Python


To check if the current interpreter supports free-threading, @ref{2e3,,python -VV}
and @ref{2e4,,sys.version} contain «experimental free-threading build».
The new @ref{42ac,,sys._is_gil_enabled()} function can be used to check whether
the GIL is actually disabled in the running process.

The @code{sysconfig.get_config_var("Py_GIL_DISABLED")} configuration variable can
be used to determine whether the build supports free threading.  If the variable
is set to @code{1}, then the build supports free threading.  This is the recommended
mechanism for decisions related to the build configuration.

@node The global interpreter lock in free-threaded Python,Thread safety,Identifying free-threaded Python,Python experimental support for free threading
@anchor{howto/free-threading-python the-global-interpreter-lock-in-free-threaded-python}@anchor{4fa8}
@subsection The global interpreter lock in free-threaded Python


Free-threaded builds of CPython support optionally running with the GIL enabled
at runtime using the environment variable 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL} or
the command-line option @ref{2e2,,-X gil}.

The GIL may also automatically be enabled when importing a C-API extension
module that is not explicitly marked as supporting free threading.  A warning
will be printed in this case.

In addition to individual package documentation, the following websites track
the status of popular packages support for free threading:


@itemize *

@item 
@indicateurl{https://py-free-threading.github.io/tracking/}

@item 
@indicateurl{https://hugovk.github.io/free-threaded-wheels/}
@end itemize

@node Thread safety,Known limitations,The global interpreter lock in free-threaded Python,Python experimental support for free threading
@anchor{howto/free-threading-python thread-safety}@anchor{4fa9}
@subsection Thread safety


The free-threaded build of CPython aims to provide similar thread-safety
behavior at the Python level to the default GIL-enabled build.  Built-in
types like @ref{190,,dict}, @ref{18e,,list}, and @ref{67a,,set} use internal locks
to protect against concurrent modifications in ways that behave similarly to
the GIL.  However, Python has not historically guaranteed specific behavior for
concurrent modifications to these built-in types, so this should be treated
as a description of the current implementation, not a guarantee of current or
future behavior.

@cartouche
@quotation Nota 
It’s recommended to use the @ref{1682,,threading.Lock} or other synchronization
primitives instead of relying on the internal locks of built-in types, when
possible.
@end quotation
@end cartouche

@node Known limitations,,Thread safety,Python experimental support for free threading
@anchor{howto/free-threading-python known-limitations}@anchor{4faa}
@subsection Known limitations


This section describes known limitations of the free-threaded CPython build.

@menu
* Immortalization:: 
* Frame objects:: 
* Iterators:: 
* Single-threaded performance:: 

@end menu

@node Immortalization,Frame objects,,Known limitations
@anchor{howto/free-threading-python immortalization}@anchor{4fab}
@subsubsection Immortalization


The free-threaded build of the 3.13 release makes some objects @ref{429d,,immortal}.
Immortal objects are not deallocated and have reference counts that are
never modified.  This is done to avoid reference count contention that would
prevent efficient multi-threaded scaling.

An object will be made immortal when a new thread is started for the first time
after the main thread is running.  The following objects are immortalized:


@itemize *

@item 
@ref{3eb,,function} objects declared at the module level

@item 
@ref{1cc5,,method} descriptors

@item 
@ref{335,,code} objects

@item 
@ref{166a,,module} objects and their dictionaries

@item 
@ref{1f0d,,classes} (type objects)
@end itemize

Because immortal objects are never deallocated, applications that create many
objects of these types may see increased memory usage.  This is expected to be
addressed in the 3.14 release.

Additionally, numeric and string literals in the code as well as strings
returned by @ref{1343,,sys.intern()} are also immortalized.  This behavior is
expected to remain in the 3.14 free-threaded build.

@node Frame objects,Iterators,Immortalization,Known limitations
@anchor{howto/free-threading-python frame-objects}@anchor{4fac}
@subsubsection Frame objects


It is not safe to access @ref{780,,frame} objects from other
threads and doing so may cause your program to crash .  This means that
@ref{1472,,sys._current_frames()} is generally not safe to use in a free-threaded
build.  Functions like @ref{782,,inspect.currentframe()} and @ref{781,,sys._getframe()}
are generally safe as long as the resulting frame object is not passed to
another thread.

@node Iterators,Single-threaded performance,Frame objects,Known limitations
@anchor{howto/free-threading-python iterators}@anchor{4fad}
@subsubsection Iterators


Sharing the same iterator object between multiple threads is generally not
safe and threads may see duplicate or missing elements when iterating or crash
the interpreter.

@node Single-threaded performance,,Iterators,Known limitations
@anchor{howto/free-threading-python single-threaded-performance}@anchor{4fae}
@subsubsection Single-threaded performance


The free-threaded build has additional overhead when executing Python code
compared to the default GIL-enabled build.  In 3.13, this overhead is about
40% on the pyperformance@footnote{https://pyperformance.readthedocs.io/} suite.
Programs that spend most of their time in C extensions or I/O will see
less of an impact.  The largest impact is because the specializing adaptive
interpreter (
@geindex Python Enhancement Proposals; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/}) is disabled in the free-threaded build.  We expect
to re-enable it in a thread-safe way in the 3.14 release.  This overhead is
expected to be reduced in upcoming Python release.   We are aiming for an
overhead of 10% or less on the pyperformance suite compared to the default
GIL-enabled build.

@node C API Extension Support for Free Threading,,Python experimental support for free threading,Comos HOWTOs de Python
@anchor{howto/free-threading-extensions doc}@anchor{4faf}@anchor{howto/free-threading-extensions c-api-extension-support-for-free-threading}@anchor{4fb0}@anchor{howto/free-threading-extensions freethreading-extensions-howto}@anchor{4fa5}
@section C API Extension Support for Free Threading


Starting with the 3.13 release, CPython has experimental support for running
with the @ref{2b5,,global interpreter lock} (GIL) disabled in a configuration
called @ref{43ec,,free threading}.  This document describes how to adapt C API
extensions to support free threading.

@menu
* Identifying the Free-Threaded Build in C:: 
* Module Initialization:: 
* General API Guidelines:: 
* Borrowed References:: 
* Memory Allocation APIs:: 
* Thread State and GIL APIs:: 
* Protecting Internal Extension State:: 
* Building Extensions for the Free-Threaded Build:: 

@end menu

@node Identifying the Free-Threaded Build in C,Module Initialization,,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions identifying-the-free-threaded-build-in-c}@anchor{4fb1}
@subsection Identifying the Free-Threaded Build in C


The CPython C API exposes the @code{Py_GIL_DISABLED} macro: in the free-threaded
build it’s defined to @code{1}, and in the regular build it’s not defined.
You can use it to enable code that only runs under the free-threaded build:

@example
#ifdef Py_GIL_DISABLED
/* code that only runs in the free-threaded build */
#endif
@end example

@node Module Initialization,General API Guidelines,Identifying the Free-Threaded Build in C,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions module-initialization}@anchor{4fb2}
@subsection Module Initialization


Extension modules need to explicitly indicate that they support running with
the GIL disabled; otherwise importing the extension will raise a warning and
enable the GIL at runtime.

There are two ways to indicate that an extension module supports running with
the GIL disabled depending on whether the extension uses multi-phase or
single-phase initialization.

@menu
* Multi-Phase Initialization:: 
* Single-Phase Initialization:: 

@end menu

@node Multi-Phase Initialization,Single-Phase Initialization,,Module Initialization
@anchor{howto/free-threading-extensions multi-phase-initialization}@anchor{4fb3}
@subsubsection Multi-Phase Initialization


Extensions that use multi-phase initialization (i.e.,
@ref{495f,,PyModuleDef_Init()}) should add a @ref{2c4,,Py_mod_gil} slot in the
module definition.  If your extension supports older versions of CPython,
you should guard the slot with a @ref{7f1,,PY_VERSION_HEX} check.

@example
static struct PyModuleDef_Slot module_slots[] = @{
    ...
#if PY_VERSION_HEX >= 0x030D0000
    @{Py_mod_gil, Py_MOD_GIL_NOT_USED@},
#endif
    @{0, NULL@}
@};

static struct PyModuleDef moduledef = @{
    PyModuleDef_HEAD_INIT,
    .m_slots = module_slots,
    ...
@};
@end example

@node Single-Phase Initialization,,Multi-Phase Initialization,Module Initialization
@anchor{howto/free-threading-extensions single-phase-initialization}@anchor{4fb4}
@subsubsection Single-Phase Initialization


Extensions that use single-phase initialization (i.e.,
@ref{4835,,PyModule_Create()}) should call @ref{2e5,,PyUnstable_Module_SetGIL()} to
indicate that they support running with the GIL disabled.  The function is
only defined in the free-threaded build, so you should guard the call with
@code{#ifdef Py_GIL_DISABLED} to avoid compilation errors in the regular build.

@example
static struct PyModuleDef moduledef = @{
    PyModuleDef_HEAD_INIT,
    ...
@};

PyMODINIT_FUNC
PyInit_mymodule(void)
@{
    PyObject *m = PyModule_Create(&moduledef);
    if (m == NULL) @{
        return NULL;
    @}
#ifdef Py_GIL_DISABLED
    PyUnstable_Module_SetGIL(m, Py_MOD_GIL_NOT_USED);
#endif
    return m;
@}
@end example

@node General API Guidelines,Borrowed References,Module Initialization,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions general-api-guidelines}@anchor{4fb5}
@subsection General API Guidelines


Most of the C API is thread-safe, but there are some exceptions.


@itemize *

@item 
`Struct Fields': Accessing fields in Python C API objects or structs
directly is not thread-safe if the field may be concurrently modified.

@item 
`Macros': Accessor macros like @ref{48d4,,PyList_GET_ITEM} and
@ref{480,,PyList_SET_ITEM} do not perform any error checking or locking.
These macros are not thread-safe if the container object may be modified
concurrently.

@item 
`Borrowed References': C API functions that return
@ref{432,,borrowed references} may not be thread-safe if
the containing object is modified concurrently.  See the section on
@ref{4fb6,,borrowed references} for more information.
@end itemize

@menu
* Container Thread Safety:: 

@end menu

@node Container Thread Safety,,,General API Guidelines
@anchor{howto/free-threading-extensions container-thread-safety}@anchor{4fb7}
@subsubsection Container Thread Safety


Containers like @ref{4add,,PyListObject},
@ref{4a3,,PyDictObject}, and @ref{4bcc,,PySetObject} perform internal locking
in the free-threaded build.  For example, the @ref{4948,,PyList_Append()} will
lock the list before appending an item.

@menu
* PyDict_Next:: 

@end menu

@node PyDict_Next,,,Container Thread Safety
@anchor{howto/free-threading-extensions id1}@anchor{4fb8}@anchor{howto/free-threading-extensions pydict-next}@anchor{4fb9}
@subsubsection @code{PyDict_Next}


A notable exception is @ref{1626,,PyDict_Next()}, which does not lock the
dictionary.  You should use @ref{4bc4,,Py_BEGIN_CRITICAL_SECTION} to protect
the dictionary while iterating over it if the dictionary may be concurrently
modified:

@example
Py_BEGIN_CRITICAL_SECTION(dict);
PyObject *key, *value;
Py_ssize_t pos = 0;
while (PyDict_Next(dict, &pos, &key, &value)) @{
    ...
@}
Py_END_CRITICAL_SECTION();
@end example

@node Borrowed References,Memory Allocation APIs,General API Guidelines,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions borrowed-references}@anchor{4fba}
@subsection Borrowed References

@anchor{howto/free-threading-extensions id2}@anchor{4fb6}
Some C API functions return @ref{432,,borrowed references}.
These APIs are not thread-safe if the containing object is modified
concurrently.  For example, it’s not safe to use @ref{450,,PyList_GetItem()}
if the list may be modified concurrently.

The following table lists some borrowed reference APIs and their replacements
that return @ref{431,,strong references}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Borrowed reference API

@tab

Strong reference API

@item

@ref{450,,PyList_GetItem()}

@tab

@ref{44f,,PyList_GetItemRef()}

@item

@ref{479,,PyDict_GetItem()}

@tab

@ref{42e,,PyDict_GetItemRef()}

@item

@ref{430,,PyDict_GetItemWithError()}

@tab

@ref{42e,,PyDict_GetItemRef()}

@item

@ref{47a,,PyDict_GetItemString()}

@tab

@ref{42f,,PyDict_GetItemStringRef()}

@item

@ref{434,,PyDict_SetDefault()}

@tab

@ref{433,,PyDict_SetDefaultRef()}

@item

@ref{1626,,PyDict_Next()}

@tab

none (see @ref{4fb9,,PyDict_Next})

@item

@ref{274,,PyWeakref_GetObject()}

@tab

@ref{276,,PyWeakref_GetRef()}

@item

@ref{275,,PyWeakref_GET_OBJECT()}

@tab

@ref{276,,PyWeakref_GetRef()}

@item

@ref{44d,,PyImport_AddModule()}

@tab

@ref{44c,,PyImport_AddModuleRef()}

@end multitable


Not all APIs that return borrowed references are problematic.  For
example, @ref{4848,,PyTuple_GetItem()} is safe because tuples are immutable.
Similarly, not all uses of the above APIs are problematic.  For example,
@ref{479,,PyDict_GetItem()} is often used for parsing keyword argument
dictionaries in function calls; those keyword argument dictionaries are
effectively private (not accessible by other threads), so using borrowed
references in that context is safe.

Some of these functions were added in Python 3.13.  You can use the
pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat} package
to provide implementations of these functions for older Python versions.

@node Memory Allocation APIs,Thread State and GIL APIs,Borrowed References,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions free-threaded-memory-allocation}@anchor{4d3c}@anchor{howto/free-threading-extensions memory-allocation-apis}@anchor{4fbb}
@subsection Memory Allocation APIs


Python’s memory management C API provides functions in three different
@ref{4d37,,allocation domains}: «raw», «mem», and «object».
For thread-safety, the free-threaded build requires that only Python objects
are allocated using the object domain, and that all Python object are
allocated using that domain.  This differs from the prior Python versions,
where this was only a best practice and not a hard requirement.

@cartouche
@quotation Nota 
Search for uses of @ref{cf0,,PyObject_Malloc()} in your
extension and check that the allocated memory is used for Python objects.
Use @ref{cee,,PyMem_Malloc()} to allocate buffers instead of
@ref{cf0,,PyObject_Malloc()}.
@end quotation
@end cartouche

@node Thread State and GIL APIs,Protecting Internal Extension State,Memory Allocation APIs,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions thread-state-and-gil-apis}@anchor{4fbc}
@subsection Thread State and GIL APIs


Python provides a set of functions and macros to manage thread state and the
GIL, such as:


@itemize *

@item 
@ref{49e,,PyGILState_Ensure()} and @ref{49f,,PyGILState_Release()}

@item 
@ref{49b,,PyEval_SaveThread()} and @ref{49c,,PyEval_RestoreThread()}

@item 
@ref{484e,,Py_BEGIN_ALLOW_THREADS} and @ref{b1a,,Py_END_ALLOW_THREADS}
@end itemize

These functions should still be used in the free-threaded build to manage
thread state even when the @ref{2c5,,GIL} is disabled.  For example, if you
create a thread outside of Python, you must call @ref{49e,,PyGILState_Ensure()}
before calling into the Python API to ensure that the thread has a valid
Python thread state.

You should continue to call @ref{49b,,PyEval_SaveThread()} or
@ref{484e,,Py_BEGIN_ALLOW_THREADS} around blocking operations, such as I/O or
lock acquisitions, to allow other threads to run the
@ref{1922,,cyclic garbage collector}.

@node Protecting Internal Extension State,Building Extensions for the Free-Threaded Build,Thread State and GIL APIs,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions protecting-internal-extension-state}@anchor{4fbd}
@subsection Protecting Internal Extension State


Your extension may have internal state that was previously protected by the
GIL.  You may need to add locking to protect this state.  The approach will
depend on your extension, but some common patterns include:


@itemize *

@item 
`Caches': global caches are a common source of shared state.  Consider
using a lock to protect the cache or disabling it in the free-threaded build
if the cache is not critical for performance.

@item 
`Global State': global state may need to be protected by a lock or moved
to thread local storage. C11 and C++11 provide the @code{thread_local} or
@code{_Thread_local} for
thread-local storage@footnote{https://en.cppreference.com/w/c/language/storage_duration}.
@end itemize

@node Building Extensions for the Free-Threaded Build,,Protecting Internal Extension State,C API Extension Support for Free Threading
@anchor{howto/free-threading-extensions building-extensions-for-the-free-threaded-build}@anchor{4fbe}
@subsection Building Extensions for the Free-Threaded Build


C API extensions need to be built specifically for the free-threaded build.
The wheels, shared libraries, and binaries are indicated by a @code{t} suffix.


@itemize *

@item 
pypa/manylinux@footnote{https://github.com/pypa/manylinux} supports the
free-threaded build, with the @code{t} suffix, such as @code{python3.13t}.

@item 
pypa/cibuildwheel@footnote{https://github.com/pypa/cibuildwheel} supports the
free-threaded build if you set
CIBW_FREE_THREADED_SUPPORT@footnote{https://cibuildwheel.pypa.io/en/stable/options/#free-threaded-support}.
@end itemize

@menu
* Limited C API and Stable ABI:: 
* Windows: Windows<73>. 

@end menu

@node Limited C API and Stable ABI,Windows<73>,,Building Extensions for the Free-Threaded Build
@anchor{howto/free-threading-extensions limited-c-api-and-stable-abi}@anchor{4fbf}
@subsubsection Limited C API and Stable ABI


The free-threaded build does not currently support the
@ref{488,,Limited C API} or the stable ABI.  If you use
setuptools@footnote{https://setuptools.pypa.io/en/latest/setuptools.html} to build
your extension and currently set @code{py_limited_api=True} you can use
@code{py_limited_api=not sysconfig.get_config_var("Py_GIL_DISABLED")} to opt out
of the limited API when building with the free-threaded build.

@cartouche
@quotation Nota 
You will need to build separate wheels specifically for the free-threaded
build.  If you currently use the stable ABI, you can continue to build a
single wheel for multiple non-free-threaded Python versions.
@end quotation
@end cartouche

@node Windows<73>,,Limited C API and Stable ABI,Building Extensions for the Free-Threaded Build
@anchor{howto/free-threading-extensions windows}@anchor{4fc0}
@subsubsection Windows


Due to a limitation of the official Windows installer, you will need to
manually define @code{Py_GIL_DISABLED=1} when building extensions from source.


@subsubheading Ver también


Porting Extension Modules to Support Free-Threading@footnote{https://py-free-threading.github.io/porting/}:
A community-maintained porting guide for extension authors.


General:


@itemize *

@item 
@ref{870,,Prácticas recomendadas para las anotaciones}

@item 
@ref{2c5c,,Tutorial de argparse}

@item 
@ref{152c,,Descriptor Guide}

@item 
@ref{4e49,,HOWTO - Enum}

@item 
@ref{4e7a,,HOWTO - Programación funcional}

@item 
@ref{3b68,,Introducción al modulo ipaddress}

@item 
@ref{4e98,,HOWTO hacer registros (Logging)}

@item 
@ref{1264,,Libro de recetas de Logging}

@item 
@ref{22ef,,Expresiones regulares COMOS (HOWTO)}

@item 
@ref{2186,,Sorting Techniques}

@item 
@ref{1310,,CÓMO (HOWTO) Unicode}

@item 
@ref{3940,,HOWTO - Cómo obtener recursos de Internet con el paquete urllib}
@end itemize

Advanced development:


@itemize *

@item 
@ref{2da2,,Programación de curses con Python}

@item 
@ref{4fa3,,Python experimental support for free threading}

@item 
@ref{4fa5,,C API Extension Support for Free Threading}

@item 
@ref{4c2c,,Aislamiento de módulos de extensión}

@item 
@ref{14e6,,The Python 2.3 Method Resolution Order}

@item 
@ref{338d,,HOW TO - Programación con sockets}

@item 
@ref{4f98,,timer file descriptor HOWTO}

@item 
@ref{1348,,Portar módulos de extensión a Python 3}
@end itemize

Debugging and profiling:


@itemize *

@item 
@ref{4e3b,,Debugging C API extensions and CPython Internals with GDB}

@item 
@ref{cf4,,Instrumentación de CPython con DTrace y SystemTap}

@item 
@ref{2f8,,Soporte de Python para el perfilador perf de Linux}
@end itemize

@node Preguntas más frecuentes de Python,Deprecations,Comos HOWTOs de Python,Top
@anchor{faq/index doc}@anchor{4fc1}@anchor{faq/index faq-index}@anchor{1d0e}@anchor{faq/index python-frequently-asked-questions}@anchor{4fc2}
@chapter Preguntas más frecuentes de Python


@menu
* Preguntas frecuentes generales sobre Python:: 
* Preguntas frecuentes de programación:: 
* Preguntas frecuentes sobre diseño e historia:: 
* Preguntas frecuentes sobre bibliotecas y extensiones:: 
* Extendiendo/Embebiendo FAQ:: 
* Preguntas frecuentes sobre Python en Windows:: 
* Preguntas frecuentes sobre la Interfaz Gráfica de Usuario (GUI): Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI. 
* «¿Por qué está Python instalado en mi ordenador?» FAQ:: 

@end menu

@node Preguntas frecuentes generales sobre Python,Preguntas frecuentes de programación,,Preguntas más frecuentes de Python
@anchor{faq/general doc}@anchor{4fc3}@anchor{faq/general general-python-faq}@anchor{4fc4}
@section Preguntas frecuentes generales sobre Python



@menu
* Información general:: 
* Python en el mundo real:: 

@end menu

@node Información general,Python en el mundo real,,Preguntas frecuentes generales sobre Python
@anchor{faq/general general-information}@anchor{4fc5}
@subsection Información general


@menu
* ¿Qué es Python?:: 
* ¿Que es la Python Software Foundation?:: 
* ¿Hay restricciones de copyright sobre el uso de Python?:: 
* ¿Por qué se creó Python en primer lugar?:: 
* ¿Para qué es bueno Python?:: 
* ¿Cómo funciona el esquema numérico de versiones de Python?:: 
* ¿Cómo obtengo una copia del código fuente de Python?:: 
* ¿Cómo consigo documentación sobre Python?:: 
* Nunca he programado antes. ¿Hay un tutorial de Python?: Nunca he programado antes ¿Hay un tutorial de Python?. 
* ¿Hay un newsgroup o una lista de correo dedicada a Python?:: 
* ¿Cómo obtengo una versión de prueba beta de Python?:: 
* ¿Cómo envío un reporte de bug y parches para Python?:: 
* ¿Hay algún artículo publicado sobre Python que pueda referir?:: 
* ¿Hay libros sobre Python?:: 
* ¿En qué parte del mundo está ubicado www.python.org?: ¿En qué parte del mundo está ubicado www python org?. 
* ¿Por qué se llama Python?:: 
* ¿Debe gustarme «Monty Python’s Flying Circus»?:: 

@end menu

@node ¿Qué es Python?,¿Que es la Python Software Foundation?,,Información general
@anchor{faq/general what-is-python}@anchor{4fc6}
@subsubsection ¿Qué es Python?


Python es un lenguaje interpretado, interactivo y orientado a objetos. Incorpora módulos, excepciones, tipado dinámico, tipos de datos de muy alto nivel y clases. Python combina un poder destacado con una sintaxis muy clara. Tiene interfaces a muchas llamadas de sistema y bibliotecas, así como a varios sistemas de ventana, y es extensible en C o C++. También es usable como un lenguaje de extensión para aplicaciones que necesitan una interfaz programable. Por último, Python es portable: corre en muchas variantes de Unix, en Mac y en Windows 2000 y posteriores.

Para saber más, comienza con @ref{1be1,,El tutorial de Python}. La Beginner's Guide to Python@footnote{https://wiki.python.org/moin/BeginnersGuide} vincula a otros recursos y tutoriales introductorios para aprender Python.

@node ¿Que es la Python Software Foundation?,¿Hay restricciones de copyright sobre el uso de Python?,¿Qué es Python?,Información general
@anchor{faq/general what-is-the-python-software-foundation}@anchor{4fc7}
@subsubsection ¿Que es la `Python Software Foundation'?


La `Python Software Foundation' es una organización independiente sin fines de lucro que posee los derechos sobre Python desde la versión 2.1 en adelante. La misión de la PSF es hacer avanzar la tecnología `open source' relacionada al lenguaje de programación Python y publicitar su uso. El sitio web de la PSF es @indicateurl{https://www.python.org/psf/}.

Las donaciones a la PSF están exentas de impuestos en Estados Unidos. Si usas Python y lo encuentras útil, por favor contribuye a través de la página de donaciones de la PSF@footnote{https://www.python.org/psf/donations/}.

@node ¿Hay restricciones de copyright sobre el uso de Python?,¿Por qué se creó Python en primer lugar?,¿Que es la Python Software Foundation?,Información general
@anchor{faq/general are-there-copyright-restrictions-on-the-use-of-python}@anchor{4fc8}
@subsubsection ¿Hay restricciones de `copyright' sobre el uso de Python?


Puedes hacer cualquier cosa que quieras con el código fuente mientras mantengas y muestres los mensajes de derechos de autor en cualquier documentación sobre Python que produzcas. Si respetas las reglas de derechos de autor, está permitido usar Python para fines comerciales, vender copias de Python en forma de código fuente o binarios (modificados o no), o vender productos que incorporen Python de alguna manera. De cualquier manera nos gustaría saber de todos los usos comerciales de Python, por supuesto.

See the license page@footnote{https://docs.python.org/3/license.html} to find further
explanations and the full text of the PSF License.

El logo de Python tiene derechos comerciales (`trademarked') y en ciertos casos se requiere un permiso de uso. Consulta la Trademark Usage Policy@footnote{https://www.python.org/psf/trademarks/} para más información.

@node ¿Por qué se creó Python en primer lugar?,¿Para qué es bueno Python?,¿Hay restricciones de copyright sobre el uso de Python?,Información general
@anchor{faq/general why-was-python-created-in-the-first-place}@anchor{4fc9}
@subsubsection ¿Por qué se creó Python en primer lugar?


Aquí hay un `muy' breve resumen sobre qué fue lo que comenzó todo, escrita por Guido van Rossum:

@quotation

Tenía vasta experiencia implementando un lenguaje interpretado en el grupo ABC en CWI y trabajando con este grupo había aprendido mucho sobre diseño de lenguajes. Este es el origen de muchas características de Python, incluyendo el uso de sangría para el agrupamiento de sentencias y la inclusión de tipos de datos de muy alto nivel (aunque los detalles son todos diferentes en Python).

Tenía algunos resquemores sobre el lenguaje ABC pero también me gustaban muchas de sus características. Era imposible extenderlo (al lenguaje o sus implementaciones) para remediar mis quejas – de hecho, la ausencia de extensibilidad fue uno de los mayores problemas. Contaba con alguna experiencia usando Modula-2+ y conversé con los diseñadores de Modula-3 y leí su reporte. Modula-3 es el origen de la sintaxis y semántica que usé para las excepciones y otras características de Python.

Estaba trabajando en Grupo del sistema operativo distribuido Amoeba en CWI. Necesitábamos una mejor manera de hacer administración de sistemas que escribir programas en C o `scripts' de `Bourne shell', ya que Amoeba tenía sus propia interfaz de llamadas a sistema que no era fácilmente accesible desde `Bourne shell'. Mi experiencia con el manejo de errores de Amoeba me hizo muy consciente de la importancia de las excepciones como una característica de los lenguaje de programación.

Se me ocurrió que un lenguaje de scripts con una sintaxis como ABC pero con acceso a las llamadas al sistema Amoeba satisfaría la necesidad. Me di cuenta de que sería una tontería escribir un lenguaje específico para Amoeba, así que decidí que necesitaba un lenguaje que fuera generalmente extensible.

Durante las vacaciones de Navidad de 1989 tenía mucho tiempo libre, así que decidí hacer un intento. Durante el año siguiente, mientras seguía trabajando principalmente en él durante mi propio tiempo, Python se utilizó en el proyecto Amoeba con un éxito creciente, y los comentarios de mis colegas me hicieron agregar muchas mejoras iniciales.

En febrero de 1991, justo después de un año de desarrollo, decidí publicarlo en USENET. El resto está en el archivo @code{Misc/HISTORY}.
@end quotation

@node ¿Para qué es bueno Python?,¿Cómo funciona el esquema numérico de versiones de Python?,¿Por qué se creó Python en primer lugar?,Información general
@anchor{faq/general what-is-python-good-for}@anchor{4fca}
@subsubsection ¿Para qué es bueno Python?


Python es un lenguaje de programación de propósito general de alto nivel que se puede aplicar a muchas clases diferentes de problemas.

El lenguaje viene con una gran biblioteca estándar que cubre áreas como procesamiento de cadenas de caracteres (expresiones regulares, Unicode, cálculo de diferencias entre archivos), protocolos de Internet (HTTP, FTP, SMTP, XML-RPC, POP, IMAP), ingeniería de software. (pruebas unitarias, registro, análisis de rendimiento (`profiling'), análisis de código Python) e interfaces del sistema operativo (llamadas al sistema, sistemas de archivos, sockets TCP / IP). Mira la tabla de contenido de @ref{2b1,,La biblioteca estándar de Python} para tener una idea de lo que está disponible. También hay disponible una amplia variedad de extensiones de terceros. Consulta the Python Package Index@footnote{https://pypi.org} para encontrar paquetes de interés.

@node ¿Cómo funciona el esquema numérico de versiones de Python?,¿Cómo obtengo una copia del código fuente de Python?,¿Para qué es bueno Python?,Información general
@anchor{faq/general faq-version-numbering-scheme}@anchor{4fcb}@anchor{faq/general how-does-the-python-version-numbering-scheme-work}@anchor{4fcc}
@subsubsection ¿Cómo funciona el esquema numérico de versiones de Python?


Las versions de Python son numeradas «A.B.C» o «A.B»:


@itemize *

@item 
`A' es el número de version principal – sólo es incrementada en cambios realmente importantes en el lenguaje.

@item 
`B' es el número de versión menor – se incrementa para cambios menos trascendentales.

@item 
`C' es el número de versión micro – se incrementa para cada versión de corrección de errores.
@end itemize

Not all releases are bugfix releases.  In the run-up to a new feature release, a
series of development releases are made, denoted as alpha, beta, or release
candidate.  Alphas are early releases in which interfaces aren’t yet finalized;
it’s not unexpected to see an interface change between two alpha releases.
Betas are more stable, preserving existing interfaces but possibly adding new
modules, and release candidates are frozen, making no changes except as needed
to fix critical bugs.

Las versiones `alpha', `beta' o `release candidate' tienen un sufijo adicional:


@itemize *

@item 
El sufijo para una versión alfa es «aN» para un pequeño número `N'.

@item 
El sufijo para una versión beta es «bN» para un pequeño número `N'.

@item 
El sufijo para una versión `release candidate * es «rcN» para un pequeño número *N'.
@end itemize

En otras palabras, todas las versiones con la etiqueta `2.0aN' preceden a las versiones con la etiqueta `2.0bN', que preceden a las versiones con la etiqueta `2.0rcN', y `esas' preceden a la 2.0.

También puedes encontrar números de versión con un sufijo «+», por ejemplo «2.2+». Estas son versiones sin lanzar, construidas directamente desde el repositorio de desarrollo de CPython. En la práctica, luego de que un lanzamiento menor se realiza, la versión es incrementada a la siguiente versión menor, que se vuelve «a0», por ejemplo «2.4a0».

See the Developer's Guide@footnote{https://devguide.python.org/developer-workflow/development-cycle/}
for more information about the development cycle, and
@geindex Python Enhancement Proposals; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} to learn more about Python’s backward compatibility policy.  See also
the documentation for @ref{2e4,,sys.version}, @ref{42a7,,sys.hexversion}, and
@ref{741,,sys.version_info}.

@node ¿Cómo obtengo una copia del código fuente de Python?,¿Cómo consigo documentación sobre Python?,¿Cómo funciona el esquema numérico de versiones de Python?,Información general
@anchor{faq/general how-do-i-obtain-a-copy-of-the-python-source}@anchor{4fcd}
@subsubsection ¿Cómo obtengo una copia del código fuente de Python?


El código fuente de la versión más reciente de Python está siempre disponible desde python.org, en @indicateurl{https://www.python.org/downloads/}.  El código fuente en desarrollo más reciente se puede obtener en  @indicateurl{https://github.com/python/cpython/}.

La distribución de fuentes es un archivo tar comprimido con gzip que contiene el código C completo, documentación en formato Sphinx, los módulos de la biblioteca de Python, programas de ejemplo y varias piezas útiles de software libremente distribuibles. El código fuente compilará y se ejecutará sin problemas en la mayoría de las plataformas Unix.

Consulta Getting Started section of the Python Developer's Guide@footnote{https://devguide.python.org/setup/} para más información sobre cómo obtener el código fuente y compilarlo.

@node ¿Cómo consigo documentación sobre Python?,Nunca he programado antes ¿Hay un tutorial de Python?,¿Cómo obtengo una copia del código fuente de Python?,Información general
@anchor{faq/general how-do-i-get-documentation-on-python}@anchor{4fce}
@subsubsection ¿Cómo consigo documentación sobre Python?


La documentación estándar para la versión estable actual de Python está disponible en  @indicateurl{https://docs.python.org/3/}. También están disponibles versiones en PDF, texto plano y HTML descargable en  @indicateurl{https://docs.python.org/3/download.html}.

La documentación está escrita en reStructuredText y procesada con la herramienta de documentación Sphinx@footnote{https://www.sphinx-doc.org/}. Las fuentes reStructuredText de la documentación son parte de la distribución fuente de Python.

@node Nunca he programado antes ¿Hay un tutorial de Python?,¿Hay un newsgroup o una lista de correo dedicada a Python?,¿Cómo consigo documentación sobre Python?,Información general
@anchor{faq/general i-ve-never-programmed-before-is-there-a-python-tutorial}@anchor{4fcf}
@subsubsection Nunca he programado antes. ¿Hay un tutorial de Python?


Hay numerosos tutoriales y libros disponibles.  La documentación estándar incluye  @ref{1be1,,El tutorial de Python}.

Consulta the Beginner's Guide@footnote{https://wiki.python.org/moin/BeginnersGuide} para encontrar información para principiantes en Python, incluyendo una lista de tutoriales.

@node ¿Hay un newsgroup o una lista de correo dedicada a Python?,¿Cómo obtengo una versión de prueba beta de Python?,Nunca he programado antes ¿Hay un tutorial de Python?,Información general
@anchor{faq/general is-there-a-newsgroup-or-mailing-list-devoted-to-python}@anchor{4fd0}
@subsubsection ¿Hay un `newsgroup' o una lista de correo dedicada a Python?


Hay un grupo de noticias, @code{comp.lang.python}, y una lista de correo, python-list@footnote{https://mail.python.org/mailman/listinfo/python-list}. Tanto el grupo de noticias como la lista de correo están interconectadas entre sí – si puedes leer las noticias no es necesario que te suscribas a la lista de correo. @code{comp.lang.python} tiene mucho tráfico, recibiendo cientos de publicaciones cada día. y los lectores de Usenet suelen ser más capaces de hacer frente a este volumen.

Announcements of new software releases and events can be found in
comp.lang.python.announce, a low-traffic moderated list that receives about five
postings per day.  It’s available as the python-announce mailing list@footnote{https://mail.python.org/mailman3/lists/python-announce-list.python.org/}.

Más información sobre listas de correo o grupos de noticias puede hallarse en  @indicateurl{https://www.python.org/community/lists/}.

@node ¿Cómo obtengo una versión de prueba beta de Python?,¿Cómo envío un reporte de bug y parches para Python?,¿Hay un newsgroup o una lista de correo dedicada a Python?,Información general
@anchor{faq/general how-do-i-get-a-beta-test-version-of-python}@anchor{4fd1}
@subsubsection ¿Cómo obtengo una versión de prueba `beta' de Python?


Las versiones alpha y beta están disponibles desde  @indicateurl{https://www.python.org/downloads/}.  Todos los lanzamientos son anunciados en el grupo de noticias comp.lang.python y comp.lang.python.announce, así como también en la página principal de Python en @indicateurl{https://www.python.org/}; un `feed' RSS está disponible.

También puedes acceder a la versión en desarrollo de Python desde Git. Mira The Python Developer's Guide@footnote{https://devguide.python.org/} para los detalles.

@node ¿Cómo envío un reporte de bug y parches para Python?,¿Hay algún artículo publicado sobre Python que pueda referir?,¿Cómo obtengo una versión de prueba beta de Python?,Información general
@anchor{faq/general how-do-i-submit-bug-reports-and-patches-for-python}@anchor{4fd2}
@subsubsection ¿Cómo envío un reporte de `bug' y parches para Python?


Para reportar un `bug' o enviar un parche, usa el rastreador de problemas en @indicateurl{https://github.com/python/cpython/issues}.

Para más información sobre cómo se desarrolla Python, consulta the Python Developer's Guide@footnote{https://devguide.python.org/}.

@node ¿Hay algún artículo publicado sobre Python que pueda referir?,¿Hay libros sobre Python?,¿Cómo envío un reporte de bug y parches para Python?,Información general
@anchor{faq/general are-there-any-published-articles-about-python-that-i-can-reference}@anchor{4fd3}
@subsubsection ¿Hay algún artículo publicado sobre Python que pueda referir?


Lo más probable es que lo mejor sea citar a tu libro preferido sobre Python.

The very first article@footnote{https://ir.cwi.nl/pub/18204} about Python was
written in 1991 and is now quite outdated.

@quotation

Guido van Rossum y Jelke de Boer, «`Interactively Testing Remote Servers Using the Python Programming Language», CWI Quarterly, Volume 4, Issue 4 (Diembre de 1991), Amsterdam, pp 283–303'.
@end quotation

@node ¿Hay libros sobre Python?,¿En qué parte del mundo está ubicado www python org?,¿Hay algún artículo publicado sobre Python que pueda referir?,Información general
@anchor{faq/general are-there-any-books-on-python}@anchor{4fd4}
@subsubsection ¿Hay libros sobre Python?


Sí, hay muchos, y hay más siendo publicados. Mira la wiki de python.org en @indicateurl{https://wiki.python.org/moin/PythonBooks} para ver una lista.

También puedes buscar «Python» en las librerías en línea y excluir las que refieran a los Monty Python; o quizás buscar «Python» y «lenguaje».

@node ¿En qué parte del mundo está ubicado www python org?,¿Por qué se llama Python?,¿Hay libros sobre Python?,Información general
@anchor{faq/general where-in-the-world-is-www-python-org-located}@anchor{4fd5}
@subsubsection ¿En qué parte del mundo está ubicado www.python.org?


La infraestructura del proyecto Python está ubicada alrededor de todo el mundo y es gestionada por el `Python Infraestructure Team'. Detalles aquí@footnote{https://infra.psf.io}.

@node ¿Por qué se llama Python?,¿Debe gustarme «Monty Python’s Flying Circus»?,¿En qué parte del mundo está ubicado www python org?,Información general
@anchor{faq/general why-is-it-called-python}@anchor{4fd6}
@subsubsection ¿Por qué se llama Python?


Cuando comenzó a implementar Python, Guido van Rossum también estaba leyendo los guiones publicados de "Monty Python's Flying Circus"@footnote{https://es.wikipedia.org/wiki/Monty_Python}, una serie de comedia producida por la BBC de los 70”. Van Rossum pensó que necesitaba un nombre que fuera corto, único y ligeramente misterioso, entonces decidió llamar al lenguaje Python.

@node ¿Debe gustarme «Monty Python’s Flying Circus»?,,¿Por qué se llama Python?,Información general
@anchor{faq/general do-i-have-to-like-monty-python-s-flying-circus}@anchor{4fd7}
@subsubsection ¿Debe gustarme «Monty Python’s Flying Circus»?


No, pero ayuda. :)

@node Python en el mundo real,,Información general,Preguntas frecuentes generales sobre Python
@anchor{faq/general python-in-the-real-world}@anchor{4fd8}
@subsection Python en el mundo real


@menu
* ¿Cuán estable es Python?:: 
* ¿Cuánta gente usa Python?:: 
* ¿Hay proyectos significativos hechos con Python?:: 
* ¿Qué nuevos desarrollos se esperan para Python en el futuro?:: 
* ¿Es razonable proponer cambios incompatibles a Python?:: 
* ¿Python es un buen lenguaje para principiantes?:: 

@end menu

@node ¿Cuán estable es Python?,¿Cuánta gente usa Python?,,Python en el mundo real
@anchor{faq/general how-stable-is-python}@anchor{4fd9}
@subsubsection ¿Cuán estable es Python?


Very stable.  New, stable releases have been coming out roughly every 6 to 18
months since 1991, and this seems likely to continue.  As of version 3.9,
Python will have a new feature release every 12 months (
@geindex Python Enhancement Proposals; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/}).

The developers issue bugfix releases of older versions, so the stability of
existing releases gradually improves.  Bugfix releases, indicated by a third
component of the version number (e.g. 3.5.3, 3.6.2), are managed for stability;
only fixes for known problems are included in a bugfix release, and it’s
guaranteed that interfaces will remain the same throughout a series of bugfix
releases.

The latest stable releases can always be found on the Python download page@footnote{https://www.python.org/downloads/}.
Python 3.x is the recommended version and supported by most widely used libraries.
Python 2.x 
@geindex Python Enhancement Proposals; PEP 373
is not maintained anymore@footnote{https://peps.python.org/pep-0373/}.

@node ¿Cuánta gente usa Python?,¿Hay proyectos significativos hechos con Python?,¿Cuán estable es Python?,Python en el mundo real
@anchor{faq/general how-many-people-are-using-python}@anchor{4fda}
@subsubsection ¿Cuánta gente usa Python?


Probablemente hay decenas de miles de usuarios y usuarias, aunque es difícil obtener una cuenta exacta.

Python está disponible gratuitamente para ser descargado por lo que no existen cifras de ventas, a su vez se incluye en muchos sitios diferentes y está empaquetado en muchas distribuciones de Linux, por lo que las estadísticas de descarga tampoco cuentan toda la historia.

El grupo de noticias comp.lang.python es muy activo, pero no todos los usuarios de Python publican allí o incluso lo leen.

@node ¿Hay proyectos significativos hechos con Python?,¿Qué nuevos desarrollos se esperan para Python en el futuro?,¿Cuánta gente usa Python?,Python en el mundo real
@anchor{faq/general have-any-significant-projects-been-done-in-python}@anchor{4fdb}
@subsubsection ¿Hay proyectos significativos hechos con Python?


Mira @indicateurl{https://www.python.org/about/success} para una lista de proyecto que usan Python. Consultar las actas de conferencias de Python pasadas@footnote{https://www.python.org/community/workshops/} revelará contribuciones de diferentes empresas y organizaciones.

Proyectos en Python de alto perfil incluyen el gestor de listas de correo Mailman@footnote{https://www.list.org} y el servidor de aplicaciones Zope@footnote{https://www.zope.org}. Muchas distribuciones de Linux, más notoriamente Red Hat@footnote{https://www.redhat.com}, han escrito partes de sus instaladores y software de administración en Python. Entre las empresas que usan Python internamente se encuentran Google, Yahoo y Lucasfilm Ltd.

@node ¿Qué nuevos desarrollos se esperan para Python en el futuro?,¿Es razonable proponer cambios incompatibles a Python?,¿Hay proyectos significativos hechos con Python?,Python en el mundo real
@anchor{faq/general what-new-developments-are-expected-for-python-in-the-future}@anchor{4fdc}
@subsubsection ¿Qué nuevos desarrollos se esperan para Python en el futuro?


Consulta @indicateurl{https://peps.python.org/} para conocer las propuestas de mejora de Python (PEP). Los PEP son documentos de diseño que describen una nueva característica sugerida para Python, que proporciona una especificación técnica concisa y una justificación. Busca un PEP titulado «Python X.Y Release Schedule», donde X.Y es una versión que aún no se ha lanzado públicamente.

New development is discussed on the python-dev mailing list@footnote{https://mail.python.org/mailman3/lists/python-dev.python.org/}.

@node ¿Es razonable proponer cambios incompatibles a Python?,¿Python es un buen lenguaje para principiantes?,¿Qué nuevos desarrollos se esperan para Python en el futuro?,Python en el mundo real
@anchor{faq/general is-it-reasonable-to-propose-incompatible-changes-to-python}@anchor{4fdd}
@subsubsection ¿Es razonable proponer cambios incompatibles a Python?


En general no. Ya existen millones de líneas de código Python alrededor del mundo, por lo que cualquier cambio en el lenguaje que invalide más que una fracción muy pequeña de los programas existentes tiene que ser mal visto. Incluso si puedes proporcionar un programa de conversión, todavía existe el problema de actualizar toda la documentación; se han escrito muchos libros sobre Python y no queremos invalidarlos a todos de un plumazo.

Si una funcionalidad se debe cambiar,  es necesario proporcionar una ruta de actualización gradual.  
@geindex Python Enhancement Proposals; PEP 5
PEP 5@footnote{https://peps.python.org/pep-0005/} describe el procedimiento seguido para introducir cambios incompatibles con versiones anteriores para minimizar disrupciones a los usuarios y usuarias.

@node ¿Python es un buen lenguaje para principiantes?,,¿Es razonable proponer cambios incompatibles a Python?,Python en el mundo real
@anchor{faq/general is-python-a-good-language-for-beginning-programmers}@anchor{4fde}
@subsubsection ¿Python es un buen lenguaje para principiantes?


Sí.

Todavía es común hacer comenzar a estudiantes con lenguajes procedimentales de tipado estático como Pascal, C o un subconjunto de C++ o Java. Los y las estudiantes pueden verse favorecidos si aprenden Python como primer lenguaje. Python tiene una sintaxis simple y consistente y una gran biblioteca estándar. Y, más importante, usar Python en cursos introductorios de programación permite a los estudiantes concentrarse en lo importante de las habilidades de programación como la descomposición de problemas y el diseño de tipos de datos. Con Python los estudiantes pueden ser rápidamente introducidos a conceptos como bucles y procedimientos. Incluso puede trabajar con objetos definidos por el usuario en su primer curso.

Para estudiantes que nunca han programado antes, usar un lenguaje de tipado estático parece antinatural. Presenta complejidades adicionales que deben ser dominadas y ralentizan el ritmo del curso. Quienes están aprendiendo intentan pensar como la computadora, descomponer problemas, diseñar interfaces consistentes y encapsular datos. Si bien aprender a usar un lenguaje de tipado estático es importante en el largo plazo, no es necesariamente el mejor tema a tratar en un primer curso de programación.

Muchos otros aspectos de Python lo vuelven un buen primer lenguaje. Como Java, Python tiene una biblioteca estándar, de manera que los y las estudiantes pueden recibir, de manera temprana, consignas para realizar proyectos de programación que `hagan' algo. Estas consignas no están restringidas a las típicas calculadoras de cuatro operaciones o programas de balances contables. Al usar la biblioteca estándar, pueden ganar la satisfacción de trabajar en aplicaciones realistas mientras aprenden los fundamentos de la programación. Usar la biblioteca estándar también enseña a reusar código. Módulos de terceros, como PyGame, también ayudan a extender los alcances de los y las estudiantes.

El intérprete interactivo de Python les permite probar funcionalidades del lenguaje mientras programan. Pueden tener una ventana con el intérprete corriendo mientras escriben el código de su programa en otra. Si no recuerdan los métodos para una lista, pueden hacer algo así:

@example
>>> L = []
>>> dir(L) 
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__',
'__dir__', '__doc__', '__eq__', '__format__', '__ge__',
'__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__',
'__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__',
'__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__',
'__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__',
'__sizeof__', '__str__', '__subclasshook__', 'append', 'clear',
'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove',
'reverse', 'sort']
>>> [d for d in dir(L) if '__' not in d]
['append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

>>> help(L.append)
Help on built-in function append:

append(...)
    L.append(object) -> None -- append object to end

>>> L.append(1)
>>> L
[1]
@end example

Con el intérprete, la documentación nunca está lejos de los o las estudiantes mientras están programando.

También hay buenos IDE para Python. IDLE es un IDE multiplataforma para Python que está escrito en Python usando Tkinter. Los usuarios de Emacs estarán felices de saber que hay un muy buen modo de Python para Emacs. Todos estos entornos de programación proporcionan resaltado de sintaxis, indentación automática y acceso al intérprete interactivo durante la codificación. Consulta la wiki de Python@footnote{https://wiki.python.org/moin/PythonEditors} para obtener una lista completa de los entornos de edición de Python.

Si quieres discutir el uso de Python en la educación, quizás te interese unirte a la la lista de correo edu-sig@footnote{https://www.python.org/community/sigs/current/edu-sig}.

@node Preguntas frecuentes de programación,Preguntas frecuentes sobre diseño e historia,Preguntas frecuentes generales sobre Python,Preguntas más frecuentes de Python
@anchor{faq/programming doc}@anchor{4fdf}@anchor{faq/programming programming-faq}@anchor{4fe0}
@section Preguntas frecuentes de programación



@menu
* Preguntas generales:: 
* Núcleo del lenguaje:: 
* Números y cadenas:: 
* Rendimiento: Rendimiento<3>. 
* Secuencias (Tuplas/Listas): Secuencias Tuplas/Listas. 
* Objetos:: 
* Módulos: Módulos<5>. 

@end menu

@node Preguntas generales,Núcleo del lenguaje,,Preguntas frecuentes de programación
@anchor{faq/programming general-questions}@anchor{4fe1}
@subsection Preguntas generales


@menu
* ¿Existe un depurador a nivel de código fuente con puntos de interrupción@comma{} depuración paso a paso@comma{} etc?: ¿Existe un depurador a nivel de código fuente con puntos de interrupción depuración paso a paso etc?. 
* ¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?:: 
* ¿Cómo puedo crear un binario independiente a partir de un programa Python?:: 
* ¿Existen estándares de código o una guía de estilo para programas Python?:: 

@end menu

@node ¿Existe un depurador a nivel de código fuente con puntos de interrupción depuración paso a paso etc?,¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?,,Preguntas generales
@anchor{faq/programming is-there-a-source-code-level-debugger-with-breakpoints-single-stepping-etc}@anchor{4fe2}
@subsubsection ¿Existe un depurador a nivel de código fuente con puntos de interrupción, depuración paso a paso, etc?


Sí.

Debajo se describen algunos depuradores para Python y la función integrada @ref{1a6,,breakpoint()} te permite ejecutar alguno de ellos.

El módulo pdb es en depurador en modo consola simple pero conveniente para Python. Es parte de la biblioteca estándar de Python y está @ref{a5,,documentado en el manual de referencia de la biblioteca}. Puedes escribir tu propio depurador usando el código de pdb como ejemplo.

The IDLE interactive development environment, which is part of the standard
Python distribution (normally available as
Tools/scripts/idle3@footnote{https://github.com/python/cpython/blob/main/Tools/scripts/idle3}),
includes a graphical debugger.

PythonWin es un IDE Python que incluye un depurador con GUI basado en pdb. El depurador PythonWin colorea los puntos de interrupción y dispone de características geniales como la depuración de programas no modificados mediante PythonWin. PythonWin está disponible como parte del proyecto Las extensiones de Python para Windows@footnote{https://sourceforge.net/projects/pywin32/} y como parte de la distribución ActivePython@footnote{https://www.activestate.com/activepython}.

Eric@footnote{https://eric-ide.python-projects.org/} is an IDE built on PyQt
and the Scintilla editing component.

trepan3k@footnote{https://github.com/rocky/python3-trepan/} es un depurador similar a @cite{gdb}.

Visual Studio Code@footnote{https://code.visualstudio.com/} es un IDE con herramientas de depuración que se integra con software de control de versiones.

Existen varios IDEs comerciales para Python que incluyen depuradores gráficos. Entre ellos tenemos:


@itemize *

@item 
IDE Wing@footnote{https://wingware.com/}

@item 
IDE Komodo@footnote{https://www.activestate.com/products/komodo-ide/}

@item 
PyCharm@footnote{https://www.jetbrains.com/pycharm/}
@end itemize

@node ¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?,¿Cómo puedo crear un binario independiente a partir de un programa Python?,¿Existe un depurador a nivel de código fuente con puntos de interrupción depuración paso a paso etc?,Preguntas generales
@anchor{faq/programming are-there-tools-to-help-find-bugs-or-perform-static-analysis}@anchor{4fe3}
@subsubsection ¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?


Sí.

Pylint@footnote{https://pylint.pycqa.org/en/latest/index.html} and
Pyflakes@footnote{https://github.com/PyCQA/pyflakes} do basic checking that will
help you catch bugs sooner.

Static type checkers such as Mypy@footnote{https://mypy-lang.org/},
Pyre@footnote{https://pyre-check.org/}, and
Pytype@footnote{https://github.com/google/pytype} can check type hints in Python
source code.

@node ¿Cómo puedo crear un binario independiente a partir de un programa Python?,¿Existen estándares de código o una guía de estilo para programas Python?,¿Existe alguna herramienta que ayude a encontrar errores o realizar análisis estático?,Preguntas generales
@anchor{faq/programming faq-create-standalone-binary}@anchor{4fe4}@anchor{faq/programming how-can-i-create-a-stand-alone-binary-from-a-python-script}@anchor{4fe5}
@subsubsection ¿Cómo puedo crear un binario independiente a partir de un programa Python?


No necesitas tener la habilidad de compilar Python a código C si lo único que necesitas es un programa independiente que los usuarios puedan descargar y ejecutar sin necesidad de instalar primero una distribución Python. Existe una serie de herramientas que determinan el conjunto de módulos que necesita un programa y une estos módulos conjuntamente con un binario Python para generar un único ejecutable.

One is to use the freeze tool, which is included in the Python source tree as
Tools/freeze@footnote{https://github.com/python/cpython/tree/main/Tools/freeze}.
It converts Python byte code to C arrays; with a C compiler you can
embed all your modules into a new program, which is then linked with the
standard Python modules.

Funciona escaneando su fuente de forma recursiva en busca de declaraciones de importación (en ambas formas) y buscando los módulos en la ruta estándar de Python, así como en el directorio de la fuente (para los módulos incorporados).  Luego convierte el `bytecode' de los módulos escritos en Python en código C (inicializadores de arrays que pueden ser convertidos en objetos de código usando el módulo marshal) y crea un archivo de configuración a medida que sólo contiene aquellos módulos incorporados que se usan realmente en el programa.  A continuación, compila el código C generado y lo enlaza con el resto del intérprete de Python para formar un binario autónomo que actúa exactamente igual que su script.

Los siguientes paquetes pueden ayudar con la creación de ejecutables de consola y GUI:


@itemize *

@item 
Nuitka@footnote{https://nuitka.net/} (Multiplataforma)

@item 
PyInstaller@footnote{https://pyinstaller.org/} (Cross-platform)

@item 
PyOxidizer@footnote{https://pyoxidizer.readthedocs.io/en/stable/} (Multiplataforma)

@item 
cx_Freeze@footnote{https://marcelotduarte.github.io/cx_Freeze/} (Multiplataforma)

@item 
py2app@footnote{https://github.com/ronaldoussoren/py2app} (macOS solamente)

@item 
py2exe@footnote{https://www.py2exe.org/} (Windows only)
@end itemize

@node ¿Existen estándares de código o una guía de estilo para programas Python?,,¿Cómo puedo crear un binario independiente a partir de un programa Python?,Preguntas generales
@anchor{faq/programming are-there-coding-standards-or-a-style-guide-for-python-programs}@anchor{4fe6}
@subsubsection ¿Existen estándares de código o una guía de estilo para programas Python?


Sí. El estilo de código requerido para los módulos de la biblioteca estándar se encuentra documentado como 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}.

@node Núcleo del lenguaje,Números y cadenas,Preguntas generales,Preguntas frecuentes de programación
@anchor{faq/programming core-language}@anchor{4fe7}
@subsection Núcleo del lenguaje


@menu
* ¿Por qué obtengo un UnboundLocalError cuando la variable tiene un valor?:: 
* ¿Cuáles son las reglas para las variables locales y globales en Python?:: 
* ¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?:: 
* ¿Cómo puedo compartir variables globales entre módulos?:: 
* ¿Cuáles son las «buenas prácticas» para usar import en un módulo?:: 
* ¿Por qué los valores por defecto se comparten entre objetos?:: 
* ¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?:: 
* ¿Cuál es la diferencia entre argumentos y parámetros?:: 
* ¿Por qué cambiando la lista “y” cambia@comma{} también@comma{} la lista “x”?: ¿Por qué cambiando la lista “y” cambia también la lista “x”?. 
* ¿Cómo puedo escribir una función sin parámetros (invocación mediante referencia)?: ¿Cómo puedo escribir una función sin parámetros invocación mediante referencia ?. 
* ¿Cómo se puede hacer una función de orden superior en Python?:: 
* ¿Cómo copio un objeto en Python?:: 
* ¿Cómo puedo encontrar los métodos o atributos de un objeto?:: 
* ¿Cómo puede mi código descubrir el nombre de un objeto?:: 
* ¿Qué ocurre con la precedencia del operador coma?:: 
* ¿Existe un equivalente al operador ternario de C «?;»?: ¿Existe un equivalente al operador ternario de C «? »?. 
* ¿Es posible escribir expresiones en una línea de forma ofuscada en Python?:: 
* ¿Qué hace la barra (/) en medio de la lista de parámetros de una función?: ¿Qué hace la barra / en medio de la lista de parámetros de una función?. 

@end menu

@node ¿Por qué obtengo un UnboundLocalError cuando la variable tiene un valor?,¿Cuáles son las reglas para las variables locales y globales en Python?,,Núcleo del lenguaje
@anchor{faq/programming faq-unboundlocalerror}@anchor{1fde}@anchor{faq/programming why-am-i-getting-an-unboundlocalerror-when-the-variable-has-a-value}@anchor{4fe8}
@subsubsection ¿Por qué obtengo un `UnboundLocalError' cuando la variable tiene un valor?


It can be a surprise to get the @ref{1576,,UnboundLocalError} in previously working
code when it is modified by adding an assignment statement somewhere in
the body of a function.

Este código:

@example
>>> x = 10
>>> def bar():
...     print(x)
...
>>> bar()
10
@end example

funciona, pero este código:

@example
>>> x = 10
>>> def foo():
...     print(x)
...     x += 1
@end example

results in an @code{UnboundLocalError}:

@example
>>> foo()
Traceback (most recent call last):
  ...
UnboundLocalError: local variable 'x' referenced before assignment
@end example

Esto es debido a que cuando realizas una asignación a una variable en un  ámbito de aplicación, esa variable se convierte en local y enmascara cualquier variable llamada de forma similar en un ámbito de aplicación exterior. Desde la última declaración en foo asigna un nuevo valor a @code{x}, el compilador la reconoce como una variable local. Consecuentemente, cuando el @code{print(x)} más próximo intenta mostrar la variable local no inicializada se muestra un error.

En el ejemplo anterior puedes acceder al ámbito de aplicación exterior a la variable declarándola como global:

@example
>>> x = 10
>>> def foobar():
...     global x
...     print(x)
...     x += 1
...
>>> foobar()
10
@end example

Esta declaración explícita es necesaria de cara a recordarte que (a diferencia de la situación superficialmente análoga con las variables de clase e instancia) estás modificando el valor de la variable en un ámbito de aplicación más externo:

@example
>>> print(x)
11
@end example

Puedes hacer algo similar en un ámbito de aplicación anidado usando la palabra clave @ref{1313,,nonlocal}:

@example
>>> def foo():
...    x = 10
...    def bar():
...        nonlocal x
...        print(x)
...        x += 1
...    bar()
...    print(x)
...
>>> foo()
10
11
@end example

@node ¿Cuáles son las reglas para las variables locales y globales en Python?,¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?,¿Por qué obtengo un UnboundLocalError cuando la variable tiene un valor?,Núcleo del lenguaje
@anchor{faq/programming what-are-the-rules-for-local-and-global-variables-in-python}@anchor{4fe9}
@subsubsection ¿Cuáles son las reglas para las variables locales y globales en Python?


En Python, las variables que solo se encuentran referenciadas dentro de una función son globales implícitamente.  Si a una variable se le asigna un valor en cualquier lugar dentro del cuerpo de una función, se asumirá que es local a no ser que explícitamente se la declare como global.

Aunque, inicialmente, puede parecer sorprendente, un momento de consideración permite explicar esto.  Por una parte, requerir @ref{2f5,,global} para variables asignadas proporciona una barrera frente a efectos secundarios indeseados.  Por otra parte, si @code{global} es requerido para todas las referencias globales, deberás usar @code{global} en todo momento. Deberías declarar como global cualquier referencia a una función integrada o a un componente de un módulo importado. Este embrollo arruinaría la utilidad de la declaración «global» para identificar los efectos secundarios.

@node ¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?,¿Cómo puedo compartir variables globales entre módulos?,¿Cuáles son las reglas para las variables locales y globales en Python?,Núcleo del lenguaje
@anchor{faq/programming why-do-lambdas-defined-in-a-loop-with-different-values-all-return-the-same-result}@anchor{4fea}
@subsubsection ¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?


Considera que usas un bucle `for' para crear unas pocas funciones lambda (o, incluso, funciones normales), por ejemplo.:

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda: x**2)
@end example

Lo siguiente proporciona una lista que contiene 5 funciones lambda que calculan @code{x**2}. Esperarías que, cuando se les invoca, retornaran, respectivamente, @code{0}, @code{1}, @code{4}, @code{9} y @code{16}. Sin embargo, cuando lo ejecutes verás que todas devuelven @code{16}:

@example
>>> squares[2]()
16
>>> squares[4]()
16
@end example

Esto sucede porque @code{x} no es una función lambda local pero se encuentra definida en un ámbito de aplicación externo y se accede cuando la lambda es invocada — no cuando ha sido definida.  Al final del bucle, el valor de @code{x} es @code{4}, por tanto, ahora todas las funciones devuelven @code{4**2}, i.e. @code{16}. También puedes verificar esto mediante el cambio del valor de @code{x} y ver como los resultados de las lambdas cambian:

@example
>>> x = 8
>>> squares[2]()
64
@end example

De cara a evitar esto necesitas guardar los valores en variables locales a las funciones lambda de tal forma que no dependan del valor de la  @code{x} global:

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda n=x: n**2)
@end example

Aquí, @code{n=x} crea una nueva variable @code{n} local a la función lambda y ejecutada cuando la función lambda se define de tal forma que tiene el mismo valor que tenía @code{x} en ese punto en el bucle.  Esto significa que el valor de @code{n} será @code{0} en la primera función lambda, @code{1} en la segunda, @code{2} en la tercera y así sucesivamente. Por tanto, ahora cada lambda retornará el resultado correcto:

@example
>>> squares[2]()
4
>>> squares[4]()
16
@end example

Es de destacar que este comportamiento no es peculiar de las funciones lambda sino que aplica también a las funciones regulares.

@node ¿Cómo puedo compartir variables globales entre módulos?,¿Cuáles son las «buenas prácticas» para usar import en un módulo?,¿Por qué las funciones lambda definidas en un bucle con diferentes valores devuelven todas el mismo resultado?,Núcleo del lenguaje
@anchor{faq/programming how-do-i-share-global-variables-across-modules}@anchor{4feb}
@subsubsection ¿Cómo puedo compartir variables globales entre módulos?


La forma canónica de compartir información entre módulos dentro de un mismo programa sería creando un módulo especial (a menudo llamado config o cfg).  Simplemente importa el módulo config  en todos los módulos de tu aplicación; el módulo estará disponible como un nombre global.  Debido a que solo hay una instancia de cada módulo, cualquier cambio hecho en el objeto módulo se reflejará en todos los sitios.  Por ejemplo:

config.py:

@example
x = 0   # Default value of the 'x' configuration setting
@end example

mod.py:

@example
import config
config.x = 1
@end example

main.py:

@example
import config
import mod
print(config.x)
@end example

Note that using a module is also the basis for implementing the singleton design
pattern, for the same reason.

@node ¿Cuáles son las «buenas prácticas» para usar import en un módulo?,¿Por qué los valores por defecto se comparten entre objetos?,¿Cómo puedo compartir variables globales entre módulos?,Núcleo del lenguaje
@anchor{faq/programming what-are-the-best-practices-for-using-import-in-a-module}@anchor{4fec}
@subsubsection ¿Cuáles son las «buenas prácticas» para usar import en un módulo?


En general, no uses @code{from modulename import *}.  Haciendo eso embarulla el espacio de nombres del importador y hace que sea más difícil para los `linters' el detectar los nombres sin definir.

Importar los módulos en la parte inicial del fichero. Haciéndolo así  deja claro los módulos que son necesarios para tu código y evita preguntas sobre si el nombre del módulo se encuentra en el ámbito de la aplicación. Usar una importación por línea hace que sea sencillo añadir y eliminar módulos importados pero usar múltiples importaciones por línea usa menos espacio de pantalla.

Es una buena práctica si importas los módulos en el orden siguiente:


@enumerate 

@item 
standard library modules – e.g. @ref{d9,,sys}, @ref{a1,,os}, @ref{7,,argparse}, @ref{b9,,re}

@item 
third-party library modules (anything installed in Python’s site-packages
directory) – e.g. @code{dateutil}, @code{requests}, @code{PIL.Image}

@item 
locally developed modules
@end enumerate

Hay veces en que es necesario mover las importaciones a una función o clase para evitar problemas de importaciones circulares.  Gordon McMillan dice:

@quotation

No hay problema con las importaciones circulares cuando ambos módulos usan la forma de importación «import <module>».  Fallará cuando el segundo módulo quiera coger un nombre del primer módulo («from module import name») y la importación se encuentre en el nivel superior.  Esto sucede porque los nombres en el primero todavía no se encuentran disponibles debido a que el primer módulo se encuentra ocupado importando al segundo.
@end quotation

En este caso, si el segundo módulo se usa solamente desde una función, la importación se puede mover de forma sencilla dentro de la función. En el momento en que se invoca a la importación el primer módulo habrá terminado de inicializarse y el segundo módulo podrá hacer la importación.

También podría ser necesario mover importaciones fuera del nivel superior del código si alguno de loa módulos son específicos a la plataforma. En ese caso podría, incluso, no ser posible importar todos los módulos en la parte superior del fichero. Para esos casos, la importación correcta de los módulos en el código correspondiente específico de la plataforma es una buena opción.

Solo debes mover importaciones a un ámbito de aplicación local, como dentro de la definición de una función, si es necesario resolver problemas como una importación circular o al intentar reducir el tiempo de inicialización de un módulo. Esta técnica es especialmente útil si muchas de las importaciones no son necesarias dependiendo de cómo se ejecute el programa. También podrías mover importaciones a una función si los módulos solo se usan dentro de esa función. Nótese que la primera carga de un módulo puede ser costosa debido al tiempo necesario para la inicialización del módulo,pero la carga de un módulo múltiples veces está prácticamente libre de coste ya que solo es necesario hacer búsquedas en un diccionario. Incluso si el nombre del módulo ha salido del ámbito de aplicación el módulo se encuentre, probablemente, en @ref{1976,,sys.modules}.

@node ¿Por qué los valores por defecto se comparten entre objetos?,¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?,¿Cuáles son las «buenas prácticas» para usar import en un módulo?,Núcleo del lenguaje
@anchor{faq/programming why-are-default-values-shared-between-objects}@anchor{4fed}
@subsubsection ¿Por qué los valores por defecto se comparten entre objetos?


Este tipo de error golpea a menudo a programadores novatos. Considera esta función:

@example
def foo(mydict=@{@}):  # Danger: shared reference to one dict for all calls
    ... compute something ...
    mydict[key] = value
    return mydict
@end example

La primera vez que llamas a esta función, @code{mydict} solamente contiene un único elemento. La segunda vez, @code{mydict} contiene dos elementos debido a que cuando comienza la ejecución de @code{foo()}, @code{mydict} comienza conteniendo un elemento de partida.

A menudo se esperaría que una invocación a una función cree nuevos objetos para valores por defecto. Eso no es lo que realmente sucede. Los valores por defecto se crean exactamente una sola vez, cuando se define la función. Se se cambia el objeto, como el diccionario en este ejemplo, posteriores invocaciones a la función estarán referidas al objeto cambiado.

Por definición, los objetos inmutables como números, cadenas, tuplas y @code{None} están asegurados frente al cambio. Cambios en objetos mutables como diccionarios, listas e instancias de clase pueden llevar a confusión.

Debido a esta característica es una buena práctica de programación el no usar valores mutables como valores por defecto. En su lugar usa @code{None} como valor por defecto dentro de la función, comprueba si el parámetro es @code{None} y crea una nueva lista/un nuevo diccionario/cualquier otras cosa que necesites.  Por ejemplo, no escribas:

@example
def foo(mydict=@{@}):
    ...
@end example

pero:

@example
def foo(mydict=None):
    if mydict is None:
        mydict = @{@}  # create a new dict for local namespace
@end example

Esta característica puede ser útil. Cuando tienes una función que es muy costosa de ejecutar, una técnica común es `cachear' sus parámetros y el valor resultante de cada invocación a la función y retornar el valor `cacheado' si se solicita nuevamente el mismo valor.  A esto se le llama «memoizing» y se puede implementar de la siguiente forma:

@example
# Callers can only provide two parameters and optionally pass _cache by keyword
def expensive(arg1, arg2, *, _cache=@{@}):
    if (arg1, arg2) in _cache:
        return _cache[(arg1, arg2)]

    # Calculate the value
    result = ... expensive computation ...
    _cache[(arg1, arg2)] = result           # Store result in the cache
    return result
@end example

Podrías usar una variable global conteniendo un diccionario en lugar de un valor por defecto; es una cuestión de gustos.

@node ¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?,¿Cuál es la diferencia entre argumentos y parámetros?,¿Por qué los valores por defecto se comparten entre objetos?,Núcleo del lenguaje
@anchor{faq/programming how-can-i-pass-optional-or-keyword-parameters-from-one-function-to-another}@anchor{4fee}
@subsubsection ¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?


Recopila los argumentos usando los especificadores @code{*} y @code{**} en la lista de parámetros de la función; esto te proporciona los argumentos posicionales como una tupla y los argumentos con palabras clave como un diccionario.  Puedes, entonces, pasar estos argumentos cuando invoques a otra función usando @code{*} y @code{**}:

@example
def f(x, *args, **kwargs):
    ...
    kwargs['width'] = '14.3c'
    ...
    g(x, *args, **kwargs)
@end example

@geindex argument;difference from parameter
@geindex parameter;difference from argument

@node ¿Cuál es la diferencia entre argumentos y parámetros?,¿Por qué cambiando la lista “y” cambia también la lista “x”?,¿Cómo puedo pasar parámetros por palabra clave u opcionales de una función a otra?,Núcleo del lenguaje
@anchor{faq/programming faq-argument-vs-parameter}@anchor{4fef}@anchor{faq/programming what-is-the-difference-between-arguments-and-parameters}@anchor{4ff0}
@subsubsection ¿Cuál es la diferencia entre argumentos y parámetros?


@ref{1efc,,Parameters} are defined by the names that appear in a
function definition, whereas @ref{4f6,,arguments} are the values
actually passed to a function when calling it.  Parameters define what
@ref{1efc,,kind of arguments} a function can accept.  For
example, given the function definition:

@example
def func(foo, bar=None, **kwargs):
    pass
@end example

`foo', `bar' y `kwargs' son parámetros de @code{func}.  Sin embargo, cuando invocamos a @code{func}, por ejemplo:

@example
func(42, bar=314, extra=somevar)
@end example

los valores @code{42}, @code{314} y @code{somevar} son argumentos.

@node ¿Por qué cambiando la lista “y” cambia también la lista “x”?,¿Cómo puedo escribir una función sin parámetros invocación mediante referencia ?,¿Cuál es la diferencia entre argumentos y parámetros?,Núcleo del lenguaje
@anchor{faq/programming why-did-changing-list-y-also-change-list-x}@anchor{4ff1}
@subsubsection ¿Por qué cambiando la lista “y” cambia, también, la lista “x”?


Si escribes código como:

@example
>>> x = []
>>> y = x
>>> y.append(10)
>>> y
[10]
>>> x
[10]
@end example

te estarás preguntando porque añadir un elemento a @code{y} ha cambiado también a @code{x}.

Hay dos factores que provocan este resultado:


@enumerate 

@item 
Las variables son simplemente nombres que referencian a objetos.  Haciendo @code{y = x} no crea una copia de la lista – crea una nueva variable @code{y} que referencia al mismo objeto al que referencia @code{x} .  Esto significa que solo existe un objeto (la lista) y tanto @code{x} como @code{y} hacen referencia al mismo.

@item 
Las listas son @ref{1c08,,mutable}, lo que significa que puedes cambiar su contenido.
@end enumerate

After the call to @code{append()}, the content of the mutable object has
changed from @code{[]} to @code{[10]}.  Since both the variables refer to the same
object, using either name accesses the modified value @code{[10]}.

Si, por otra parte, asignamos un objeto inmutable a @code{x}:

@example
>>> x = 5  # ints are immutable
>>> y = x
>>> x = x + 1  # 5 can't be mutated, we are creating a new object here
>>> x
6
>>> y
5
@end example

podemos ver que @code{x} e @code{y} ya no son iguales.  Esto es debido a que los enteros son @ref{1c03,,immutable}, y cuando hacemos @code{x = x + 1} no estamos mutando el entero @code{5} incrementando su valor; en su lugar, estamos creando un nuevo objeto (el entero @code{6}) y se lo asignamos a @code{x} (esto es, cambiando el objeto al cual referencia @code{x}).  Después de esta asignación tenemos dos objetos (los enteros @code{6} y @code{5}) y dos variables que referencian a ellos (@code{x} ahora referencia a  @code{6} pero @code{y} todavía referencia a @code{5}).

Some operations (for example @code{y.append(10)} and @code{y.sort()}) mutate the
object, whereas superficially similar operations (for example @code{y = y + [10]}
and @ref{c56,,sorted(y)}) create a new object.  In general in Python (and in all cases
in the standard library) a method that mutates an object will return @code{None}
to help avoid getting the two types of operations confused.  So if you
mistakenly write @code{y.sort()} thinking it will give you a sorted copy of @code{y},
you’ll instead end up with @code{None}, which will likely cause your program to
generate an easily diagnosed error.

Sin embargo, existe una clase de operaciones en las cuales la misma operación tiene, a veces, distintos comportamientos con diferentes tipos:  los operadores de asignación aumentada.  Por ejemplo, @code{+=} muta listas pero no tuplas o enteros (@code{a_list += [1, 2, 3]} es equivalente a @code{a_list.extend([1, 2, 3])} y muta @code{a_list}, mientras que @code{some_tuple += (1, 2, 3)} y @code{some_int += 1} crea nuevos objetos).

En otras palabras:


@itemize *

@item 
Si tenemos un objeto mutable (@ref{18e,,list}, @ref{190,,dict}, @ref{67a,,set}, etc.), podemos usar algunas operaciones específicas para mutarlo y todas las variables que referencian al mismo verán el cambio reflejado.

@item 
Si tenemos un objeto inmutable (@ref{237,,str}, @ref{1f0,,int}, @ref{464,,tuple}, etc.), todas las variables que referencian al mismo verán siempre el mismo valor pero las operaciones que transforman ese valor en un nuevo valor siempre retornan un nuevo objeto.
@end itemize

Si deseas saber si dos variables referencian o no al mismo objeto puedes usar el operador @ref{1ee,,is} o la función incorporada @ref{1462,,id()}.

@node ¿Cómo puedo escribir una función sin parámetros invocación mediante referencia ?,¿Cómo se puede hacer una función de orden superior en Python?,¿Por qué cambiando la lista “y” cambia también la lista “x”?,Núcleo del lenguaje
@anchor{faq/programming how-do-i-write-a-function-with-output-parameters-call-by-reference}@anchor{4ff2}
@subsubsection ¿Cómo puedo escribir una función sin parámetros (invocación mediante referencia)?


Recuerda que los argumentos son pasados mediante asignación en Python.  Ya que las asignaciones simplemente crean referencias a objetos, no hay alias entre el nombre de un argumento en el invocador y el invocado y, por tanto, no hay invocación por referencia per se.  Puedes obtener el mismo efecto deseado de formas distintas.


@enumerate 

@item 
Mediante el retorno de una tupla de resultados:

@example
>>> def func1(a, b):
...     a = 'new-value'        # a and b are local names
...     b = b + 1              # assigned to new objects
...     return a, b            # return new values
...
>>> x, y = 'old-value', 99
>>> func1(x, y)
('new-value', 100)
@end example

Esta es, casi siempre, la solución más clara.

@item 
Mediante el uso de variables globales.  No es thread-safe y no se recomienda.

@item 
Pasando un objeto mutable (intercambiable en el mismo sitio):

@example
>>> def func2(a):
...     a[0] = 'new-value'     # 'a' references a mutable list
...     a[1] = a[1] + 1        # changes a shared object
...
>>> args = ['old-value', 99]
>>> func2(args)
>>> args
['new-value', 100]
@end example

@item 
Pasando un diccionario que muta:

@example
>>> def func3(args):
...     args['a'] = 'new-value'     # args is a mutable dictionary
...     args['b'] = args['b'] + 1   # change it in-place
...
>>> args = @{'a': 'old-value', 'b': 99@}
>>> func3(args)
>>> args
@{'a': 'new-value', 'b': 100@}
@end example

@item 
O empaquetar valores en una instancia de clase:

@example
>>> class Namespace:
...     def __init__(self, /, **args):
...         for key, value in args.items():
...             setattr(self, key, value)
...
>>> def func4(args):
...     args.a = 'new-value'        # args is a mutable Namespace
...     args.b = args.b + 1         # change object in-place
...
>>> args = Namespace(a='old-value', b=99)
>>> func4(args)
>>> vars(args)
@{'a': 'new-value', 'b': 100@}
@end example

Casi nunca existe una buena razón para hacer esto tan complicado.
@end enumerate

Tu mejor opción es retornar una tupla que contenga los múltiples resultados.

@node ¿Cómo se puede hacer una función de orden superior en Python?,¿Cómo copio un objeto en Python?,¿Cómo puedo escribir una función sin parámetros invocación mediante referencia ?,Núcleo del lenguaje
@anchor{faq/programming how-do-you-make-a-higher-order-function-in-python}@anchor{4ff3}
@subsubsection ¿Cómo se puede hacer una función de orden superior en Python?


Tienes dos opciones: puedes usar ámbitos de aplicación anidados o puedes usar objetos invocables. Por ejemplo, supón que querías definir @code{linear(a,b)} que devuelve una función @code{f(x)} que calcula el valor @code{a*x+b}.  Usar ámbitos de aplicación anidados:

@example
def linear(a, b):
    def result(x):
        return a * x + b
    return result
@end example

O usar un objeto invocable:

@example
class linear:

    def __init__(self, a, b):
        self.a, self.b = a, b

    def __call__(self, x):
        return self.a * x + self.b
@end example

En ambos casos,

@example
taxes = linear(0.3, 2)
@end example

nos da un objeto invocable donde @code{taxes(10e6) == 0.3 * 10e6 + 2}.

El enfoque del objeto invocable tiene la desventaja que es un ligeramente más lento y el resultado es un código levemente más largo.  Sin embargo, destacar que una colección de invocables pueden compartir su firma vía herencia:

@example
class exponential(linear):
    # __init__ inherited
    def __call__(self, x):
        return self.a * (x ** self.b)
@end example

Los objetos pueden encapsular el estado de varios métodos:

@example
class counter:

    value = 0

    def set(self, x):
        self.value = x

    def up(self):
        self.value = self.value + 1

    def down(self):
        self.value = self.value - 1

count = counter()
inc, dec, reset = count.up, count.down, count.set
@end example

Aquí @code{inc()}, @code{dec()} y @code{reset()} se comportan como funciones las cuales comparten la misma variable de conteo.

@node ¿Cómo copio un objeto en Python?,¿Cómo puedo encontrar los métodos o atributos de un objeto?,¿Cómo se puede hacer una función de orden superior en Python?,Núcleo del lenguaje
@anchor{faq/programming how-do-i-copy-an-object-in-python}@anchor{4ff4}
@subsubsection ¿Cómo copio un objeto en Python?


En general, prueba @ref{5d7,,copy.copy()} o @ref{bf6,,copy.deepcopy()} para el caso general. No todos los objetos se pueden copiar pero la mayoría sí que pueden copiarse.

Algunas objetos se pueden copiar de forma más sencilla. Los diccionarios disponen de un método @ref{c58,,copy()}:

@example
newdict = olddict.copy()
@end example

Las secuencias se pueden copiar usando un rebanado:

@example
new_l = l[:]
@end example

@node ¿Cómo puedo encontrar los métodos o atributos de un objeto?,¿Cómo puede mi código descubrir el nombre de un objeto?,¿Cómo copio un objeto en Python?,Núcleo del lenguaje
@anchor{faq/programming how-can-i-find-the-methods-or-attributes-of-an-object}@anchor{4ff5}
@subsubsection ¿Cómo puedo encontrar los métodos o atributos de un objeto?


For an instance @code{x} of a user-defined class, @ref{6d3,,dir(x)} returns an alphabetized
list of the names containing the instance attributes and methods and attributes
defined by its class.

@node ¿Cómo puede mi código descubrir el nombre de un objeto?,¿Qué ocurre con la precedencia del operador coma?,¿Cómo puedo encontrar los métodos o atributos de un objeto?,Núcleo del lenguaje
@anchor{faq/programming how-can-my-code-discover-the-name-of-an-object}@anchor{4ff6}
@subsubsection ¿Cómo puede mi código descubrir el nombre de un objeto?


Hablando de forma general no podrían puesto que los objetos no disponen, realmente, de un nombre. Esencialmente, las asignaciones relacionan un nombre con su valor; Lo mismo se cumple con las declaraciones @code{def} y @code{class} pero, en este caso, el valor es un invocable. Considera el siguiente código:

@example
>>> class A:
...     pass
...
>>> B = A
>>> a = B()
>>> b = a
>>> print(b)
<__main__.A object at 0x16D07CC>
>>> print(a)
<__main__.A object at 0x16D07CC>
@end example

Arguably the class has a name: even though it is bound to two names and invoked
through the name @code{B} the created instance is still reported as an instance of
class @code{A}.  However, it is impossible to say whether the instance’s name is @code{a} or
@code{b}, since both names are bound to the same value.

En términos generales, no debería ser necesario que tu código «conozca los nombres» de determinados valores. A menos que estés escribiendo deliberadamente programas introspectivos, esto suele ser una indicación de que un cambio de enfoque podría ser beneficioso.

En comp.lang.python, Fredrik Lundh proporcionó una vez una excelente analogía en respuesta a esta pregunta:

@quotation

De la misma forma que obtienes el nombre de ese gato que te has encontrado en tu porche el propio gato (objeto) no te puede indicar su nombre y, realmente, no importa – por tanto, la única forma de encontrar cómo se llama sería preguntando a todos los vecinos (espacios de nombres) si es su gato (objeto)…

…y no te sorprendas si encuentras que se le conoce mediante diferentes nombres o ¡nadie conoce su nombre!
@end quotation

@node ¿Qué ocurre con la precedencia del operador coma?,¿Existe un equivalente al operador ternario de C «? »?,¿Cómo puede mi código descubrir el nombre de un objeto?,Núcleo del lenguaje
@anchor{faq/programming what-s-up-with-the-comma-operator-s-precedence}@anchor{4ff7}
@subsubsection ¿Qué ocurre con la precedencia del operador coma?


La coma no es un operador en Python. Considera la sesión:

@example
>>> "a" in "b", "a"
(False, 'a')
@end example

Debido a que la coma no es un operador sino un  separador entre expresiones lo anterior se evalúe como se ha introducido:

@example
("a" in "b"), "a"
@end example

no:

@example
"a" in ("b", "a")
@end example

Lo mismo sucede con varios operadores de asignación (@code{=}, @code{+=}, etc).  No son realmente operadores sino delimitadores sintácticos en declaraciones de asignación.

@node ¿Existe un equivalente al operador ternario de C «? »?,¿Es posible escribir expresiones en una línea de forma ofuscada en Python?,¿Qué ocurre con la precedencia del operador coma?,Núcleo del lenguaje
@anchor{faq/programming is-there-an-equivalent-of-c-s-ternary-operator}@anchor{4ff8}
@subsubsection ¿Existe un equivalente al operador ternario de C «?:»?


Sí, existe. La sintaxis es como sigue:

@example
[on_true] if [expression] else [on_false]

x, y = 50, 25
small = x if x < y else y
@end example

Antes de que esta sintaxis se introdujera en Python 2.5 una expresión común fue el uso de operadores lógicos:

@example
[expression] and [on_true] or [on_false]
@end example

Sin embargo, esa expresión no es segura ya que puede retornar valores erróneos cuando `on_true' tiene un valor booleano falso.  Por tanto, siempre es mejor usar la forma @code{... if ... else ...}.

@node ¿Es posible escribir expresiones en una línea de forma ofuscada en Python?,¿Qué hace la barra / en medio de la lista de parámetros de una función?,¿Existe un equivalente al operador ternario de C «? »?,Núcleo del lenguaje
@anchor{faq/programming is-it-possible-to-write-obfuscated-one-liners-in-python}@anchor{4ff9}
@subsubsection ¿Es posible escribir expresiones en una línea de forma ofuscada en Python?


Yes.  Usually this is done by nesting @ref{1309,,lambda} within
@code{lambda}.  See the following three examples, slightly adapted from Ulf Bartelt:

@example
from functools import reduce

# Primes < 1000
print(list(filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0,
map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000)))))

# First 10 Fibonacci numbers
print(list(map(lambda x,f=lambda x,f:(f(x-1,f)+f(x-2,f)) if x>1 else 1:
f(x,f), range(10))))

# Mandelbrot set
print((lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+'\n'+y,map(lambda y,
Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM,
Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro,
i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y
>=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr(
64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy
))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24))
#    \___ ___/  \___ ___/  |   |   |__ lines on screen
#        V          V      |   |______ columns on screen
#        |          |      |__________ maximum of "iterations"
#        |          |_________________ range on y axis
#        |____________________________ range on x axis
@end example

¡No probéis esto en casa, personitas!

@node ¿Qué hace la barra / en medio de la lista de parámetros de una función?,,¿Es posible escribir expresiones en una línea de forma ofuscada en Python?,Núcleo del lenguaje
@anchor{faq/programming faq-positional-only-arguments}@anchor{217a}@anchor{faq/programming what-does-the-slash-in-the-parameter-list-of-a-function-mean}@anchor{4ffa}
@subsubsection ¿Qué hace la barra (/) en medio de la lista de parámetros de una función?


A slash in the argument list of a function denotes that the parameters prior to
it are positional-only.  Positional-only parameters are the ones without an
externally usable name.  Upon calling a function that accepts positional-only
parameters, arguments are mapped to parameters based solely on their position.
For example, @ref{a33,,divmod()} is a function that accepts positional-only
parameters. Its documentation looks like this:

@example
>>> help(divmod)
Help on built-in function divmod in module builtins:

divmod(x, y, /)
    Return the tuple (x//y, x%y).  Invariant: div*y + mod == x.
@end example

El `slash' al final de la lista de parámetros indica que los tres parámetros son únicamente posicionales. Por tanto, invocar a  @ref{a64,,pow()} con argumentos con palabra clave podría derivar en un error:

@example
>>> divmod(x=3, y=4)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: divmod() takes no keyword arguments
@end example

@node Números y cadenas,Rendimiento<3>,Núcleo del lenguaje,Preguntas frecuentes de programación
@anchor{faq/programming numbers-and-strings}@anchor{4ffb}
@subsection Números y cadenas


@menu
* ¿Cómo puedo especificar enteros hexadecimales y octales?:: 
* ¿Por qué -22 // 10 devuelve -3?:: 
* ¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?:: 
* ¿Cómo convierto una cadena a un número?:: 
* ¿Cómo puedo convertir un número a una cadena?:: 
* ¿Cómo puedo modificar una cadena in situ?:: 
* ¿Cómo puedo usar cadenas para invocar funciones/métodos?:: 
* ¿Existe un equivalente a chomp() en Perl para eliminar nuevas líneas al final de las cadenas?: ¿Existe un equivalente a chomp en Perl para eliminar nuevas líneas al final de las cadenas?. 
* ¿Existe un equivalente a scanf() o a sscanf() ?: ¿Existe un equivalente a scanf o a sscanf ?. 
* ¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?:: 
* Can I end a raw string with an odd number of backslashes?:: 

@end menu

@node ¿Cómo puedo especificar enteros hexadecimales y octales?,¿Por qué -22 // 10 devuelve -3?,,Números y cadenas
@anchor{faq/programming how-do-i-specify-hexadecimal-and-octal-integers}@anchor{4ffc}
@subsubsection ¿Cómo puedo especificar enteros hexadecimales y octales?


Para especificar un dígito octal, prefija el valor octal con un cero y una «o» en minúscula o mayúscula.  Por ejemplo, para definir la variable «a» con el valor octal «10» (8 en decimal), escribe:

@example
>>> a = 0o10
>>> a
8
@end example

Un hexadecimal es igual de simple.  Simplemente añade un cero y una «x», en minúscula o mayúscula, antes del número hexadecimal . Los dígitos hexadecimales se pueden especificar en minúsculas o mayúsculas.  Por ejemplo, en el intérprete de Python:

@example
>>> a = 0xa5
>>> a
165
>>> b = 0XB2
>>> b
178
@end example

@node ¿Por qué -22 // 10 devuelve -3?,¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?,¿Cómo puedo especificar enteros hexadecimales y octales?,Números y cadenas
@anchor{faq/programming why-does-22-10-return-3}@anchor{4ffd}
@subsubsection ¿Por qué -22 // 10 devuelve -3?


Es debido, principalmente al deseo que @code{i % j} tenga el mismo signo que @code{j}. Si quieres eso y, además, quieres:

@example
i == (i // j) * j + (i % j)
@end example

entonces la división entera a la baja debe retornar el valor base más bajo. C también requiere que esa identidad se mantenga de tal forma que cuando los compiladores truncan @code{i // j} necesitan que @code{i % j} tenga el mismo signo que @code{i}.

Existen unos pocos casos para @code{i % j} cuando @code{j} es negativo.  Cuando @code{j} es positivo, existen muchos casos y, virtualmente, en todos ellos es más útil para @code{i % j} que sea @code{>= 0}.  Si el reloj dice que ahora son las 10, ¿qué dijo hace 200 horas?  @code{-190 % 12 == 2} es útil; @code{-190 % 12 == -10} es un error listo para morderte.

@node ¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?,¿Cómo convierto una cadena a un número?,¿Por qué -22 // 10 devuelve -3?,Números y cadenas
@anchor{faq/programming how-do-i-get-int-literal-attribute-instead-of-syntaxerror}@anchor{4ffe}
@subsubsection ¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?


Trying to lookup an @code{int} literal attribute in the normal manner gives
a @ref{150,,SyntaxError} because the period is seen as a decimal point:

@example
>>> 1.__class__
  File "<stdin>", line 1
  1.__class__
   ^
SyntaxError: invalid decimal literal
@end example

La solución es separar el literal del punto con un espacio o un paréntesis.

@example
>>> 1 .__class__
<class 'int'>
>>> (1).__class__
<class 'int'>
@end example

@node ¿Cómo convierto una cadena a un número?,¿Cómo puedo convertir un número a una cadena?,¿Cómo puedo obtener un atributo int literal en lugar de SyntaxError?,Números y cadenas
@anchor{faq/programming how-do-i-convert-a-string-to-a-number}@anchor{4fff}
@subsubsection ¿Cómo convierto una cadena a un número?


For integers, use the built-in @ref{1f0,,int()} type constructor, e.g. @code{int('144')
== 144}.  Similarly, @ref{153,,float()} converts to a floating-point number,
e.g. @code{float('144') == 144.0}.

Por defecto, estas interpretan el número como decimal de tal forma que @code{int('0144') == 144} y @code{int('0x144')} lanzará @ref{360,,ValueError}. @code{int(string, base)} toma la base para convertirlo desde un segundo parámetro opcional, por tanto @code{int('0x144', 16) == 324}. Si la base se especifica como 0, el número se interpreta usando las reglas de Python’s rules: un prefijo “0o” indica octal y un prefijo “0x” indica un número hexadecimal.

No uses la función incorporada @ref{2eb,,eval()} si todo lo que necesitas es convertir cadenas a números.  @ref{2eb,,eval()} será considerablemente más lento y presenta riesgos de seguridad: cualquiera podría introducir una expresión Python que presentara efectos indeseados.  Por ejemplo, alguien podría pasar @code{__import__('os').system("rm -rf $HOME")} lo cual borraría el directorio home al completo.

@ref{2eb,,eval()} también tiene el efecto de interpretar números como expresiones Python , de tal forma que, por ejemplo, @code{eval('09')} dará un error de sintaxis porque Python no permite un “0” inicial en un número decimal (excepto “0”).

@node ¿Cómo puedo convertir un número a una cadena?,¿Cómo puedo modificar una cadena in situ?,¿Cómo convierto una cadena a un número?,Números y cadenas
@anchor{faq/programming how-do-i-convert-a-number-to-a-string}@anchor{5000}
@subsubsection ¿Cómo puedo convertir un número a una cadena?


To convert, e.g., the number @code{144} to the string @code{'144'}, use the built-in type
constructor @ref{237,,str()}.  If you want a hexadecimal or octal representation, use
the built-in functions @ref{1337,,hex()} or @ref{1336,,oct()}.  For fancy formatting, see
the @ref{a3b,,f-strings} and @ref{13f0,,Sintaxis de formateo de cadena} sections,
e.g. @code{"@{:04d@}".format(144)} yields
@code{'0144'} and @code{"@{:.3f@}".format(1.0/3.0)} yields @code{'0.333'}.

@node ¿Cómo puedo modificar una cadena in situ?,¿Cómo puedo usar cadenas para invocar funciones/métodos?,¿Cómo puedo convertir un número a una cadena?,Números y cadenas
@anchor{faq/programming how-do-i-modify-a-string-in-place}@anchor{5001}
@subsubsection ¿Cómo puedo modificar una cadena in situ?


No puedes debido a que las cadenas son inmutables.  En la mayoría de situaciones solo deberías crear una nueva cadena a partir de varias partes que quieras usar para crearla.  Sin embargo, si necesitas un objeto con la habilidad de modificar en el mismo lugar datos unicode prueba usando el objeto @ref{fa9,,io.StringIO} o el módulo @ref{8,,array}:

@example
>>> import io
>>> s = "Hello, world"
>>> sio = io.StringIO(s)
>>> sio.getvalue()
'Hello, world'
>>> sio.seek(7)
7
>>> sio.write("there!")
6
>>> sio.getvalue()
'Hello, there!'

>>> import array
>>> a = array.array('w', s)
>>> print(a)
array('w', 'Hello, world')
>>> a[0] = 'y'
>>> print(a)
array('w', 'yello, world')
>>> a.tounicode()
'yello, world'
@end example

@node ¿Cómo puedo usar cadenas para invocar funciones/métodos?,¿Existe un equivalente a chomp en Perl para eliminar nuevas líneas al final de las cadenas?,¿Cómo puedo modificar una cadena in situ?,Números y cadenas
@anchor{faq/programming how-do-i-use-strings-to-call-functions-methods}@anchor{5002}
@subsubsection ¿Cómo puedo usar cadenas para invocar funciones/métodos?


Existen varias técnicas.


@itemize *

@item 
Lo mejor sería usar un diccionario que mapee cadenas a funciones.  La principal ventaja de esta técnica es que las cadenas no necesitan ser iguales que los nombres de las funciones.  Esta es también la principal técnica que se usa para emular un constructo `case':

@example
def a():
    pass

def b():
    pass

dispatch = @{'go': a, 'stop': b@}  # Note lack of parens for funcs

dispatch[get_input()]()  # Note trailing parens to call function
@end example

@item 
Usa la función incorporada @ref{c59,,getattr()}:

@example
import foo
getattr(foo, 'bar')()
@end example

Nótese que @ref{c59,,getattr()} funciona en cualquier objeto, incluido clases, instancias de clases, módulos, etc.

Esto se usa en varios lugares de la biblioteca estándar, como esto:

@example
class Foo:
    def do_foo(self):
        ...

    def do_bar(self):
        ...

f = getattr(foo_instance, 'do_' + opname)
f()
@end example

@item 
Use @ref{2ae,,locals()} para resolver el nombre de la función:

@example
def myFunc():
    print("hello")

fname = "myFunc"

f = locals()[fname]
f()
@end example
@end itemize

@node ¿Existe un equivalente a chomp en Perl para eliminar nuevas líneas al final de las cadenas?,¿Existe un equivalente a scanf o a sscanf ?,¿Cómo puedo usar cadenas para invocar funciones/métodos?,Números y cadenas
@anchor{faq/programming is-there-an-equivalent-to-perl-s-chomp-for-removing-trailing-newlines-from-strings}@anchor{5003}
@subsubsection ¿Existe un equivalente a chomp() en Perl para eliminar nuevas líneas al final de las cadenas?


Puedes usar @code{S.rstrip("\r\n")} para eliminar todas las ocurrencias de cualquier terminación de línea desde el final de la cadena @code{S} sin eliminar el resto de espacios en blanco que le siguen. Si la cadena @code{S} representa más de una línea con varias líneas vacías al final, las terminaciones de línea para todas las líneas vacías se eliminarán:

@example
>>> lines = ("line 1 \r\n"
...          "\r\n"
...          "\r\n")
>>> lines.rstrip("\n\r")
'line 1 '
@end example

Ya que esto solo sería deseable, típicamente, cuando lees texto línea a línea, usar @code{S.rstrip()} de esta forma funcionaría bien.

@node ¿Existe un equivalente a scanf o a sscanf ?,¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?,¿Existe un equivalente a chomp en Perl para eliminar nuevas líneas al final de las cadenas?,Números y cadenas
@anchor{faq/programming is-there-a-scanf-or-sscanf-equivalent}@anchor{5004}
@subsubsection ¿Existe un equivalente a scanf() o a sscanf() ?


No de la misma forma.

For simple input parsing, the easiest approach is usually to split the line into
whitespace-delimited words using the @ref{f2b,,split()} method of string objects
and then convert decimal strings to numeric values using @ref{1f0,,int()} or
@ref{153,,float()}.  @code{split()} supports an optional «sep» parameter which is useful
if the line uses something other than whitespace as a separator.

For more complicated input parsing, regular expressions are more powerful
than C’s @code{sscanf} and better suited for the task.

@node ¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?,Can I end a raw string with an odd number of backslashes?,¿Existe un equivalente a scanf o a sscanf ?,Números y cadenas
@anchor{faq/programming what-does-unicodedecodeerror-or-unicodeencodeerror-error-mean}@anchor{5005}
@subsubsection ¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?


Ver @ref{1310,,CÓMO (HOWTO) Unicode}.

@node Can I end a raw string with an odd number of backslashes?,,¿Qué significa “UnicodeDecodeError” o “UnicodeEncodeError”?,Números y cadenas
@anchor{faq/programming can-i-end-a-raw-string-with-an-odd-number-of-backslashes}@anchor{5006}@anchor{faq/programming faq-programming-raw-string-backslash}@anchor{1c02}
@subsubsection Can I end a raw string with an odd number of backslashes?


A raw string ending with an odd number of backslashes will escape the string’s quote:

@example
>>> r'C:\this\will\not\work\'
  File "<stdin>", line 1
    r'C:\this\will\not\work\'
         ^
SyntaxError: unterminated string literal (detected at line 1)
@end example

There are several workarounds for this. One is to use regular strings and double
the backslashes:

@example
>>> 'C:\\this\\will\\work\\'
'C:\\this\\will\\work\\'
@end example

Another is to concatenate a regular string containing an escaped backslash to the
raw string:

@example
>>> r'C:\this\will\work' '\\'
'C:\\this\\will\\work\\'
@end example

It is also possible to use @ref{163f,,os.path.join()} to append a backslash on Windows:

@example
>>> os.path.join(r'C:\this\will\work', '@w{'})
'C:\\this\\will\\work\\'
@end example

Note that while a backslash will «escape» a quote for the purposes of
determining where the raw string ends, no escaping occurs when interpreting the
value of the raw string. That is, the backslash remains present in the value of
the raw string:

@example
>>> r'backslash\'preserved'
"backslash\\'preserved"
@end example

Also see the specification in the @ref{1ea4,,language reference}.

@node Rendimiento<3>,Secuencias Tuplas/Listas,Números y cadenas,Preguntas frecuentes de programación
@anchor{faq/programming performance}@anchor{5007}
@subsection Rendimiento


@menu
* Mi programa es muy lento. ¿Cómo puedo acelerarlo?: Mi programa es muy lento ¿Cómo puedo acelerarlo?. 
* ¿Cuál es la forma más eficiente de concatenar muchas cadenas conjuntamente?:: 

@end menu

@node Mi programa es muy lento ¿Cómo puedo acelerarlo?,¿Cuál es la forma más eficiente de concatenar muchas cadenas conjuntamente?,,Rendimiento<3>
@anchor{faq/programming my-program-is-too-slow-how-do-i-speed-it-up}@anchor{5008}
@subsubsection Mi programa es muy lento. ¿Cómo puedo acelerarlo?


Esa es una pregunta difícil, en general.  Primero, aquí tienes una lista de cosas a recordar antes de ir más allá:


@itemize *

@item 
Las características del rendimiento varían entre las distintas implementaciones de Python.  Estas preguntas frecuentes se enfocan en @ref{796,,CPython}.

@item 
El comportamiento puede variar entre distintos sistemas operativos, especialmente cuando se habla de tareas I/O o multi-tarea.

@item 
Siempre deberías encontrar las partes importantes en tu programa `antes' de intentar optimizar el código (ver el módulo @ref{af,,profile}).

@item 
Escribir programas de comparación del rendimiento te permitirá iterar rápidamente cuando te encuentres buscando mejoras (ver el módulo @ref{ef,,timeit}).

@item 
Es altamente recomendable disponer de una buena cobertura de código (a partir de pruebas unitarias o cualquier otra técnica) antes de introducir potenciales regresiones ocultas en sofisticadas optimizaciones.
@end itemize

Dicho lo anterior, existen muchos trucos para acelerar código Python.  Aquí tienes algunos principios generales que te permitirán llegar a alcanzar niveles de rendimiento aceptables:


@itemize *

@item 
El hacer más rápido tu algoritmo (o cambiarlo por alguno más rápido) puede provocar mayores beneficios que intentar unos pocos trucos de micro-optimización a través de todo tu código.

@item 
Utiliza las estructuras de datos correctas.  Estudia la documentación para los @ref{2196,,Tipos integrados} y el módulo @ref{1e,,collections}.

@item 
Cuando la biblioteca estándar proporciona una primitiva de hacer algo, esta supuestamente será (aunque no se garantiza) más rápida que cualquier otra alternativa que se te ocurra.  Esto es doblemente cierto si las primitivas han sido escritas en C, como los `builtins' y algunos tipos extendidos.  Por ejemplo, asegúrate de usar el método integrado @ref{c57,,list.sort()} o la función relacionada @ref{c56,,sorted()} para ordenar (y ver @ref{2186,,Sorting Techniques} para ver ejemplos de uso moderadamente avanzados).

@item 
Las abstracciones tienden a crear rodeos y fuerzan al intérprete a trabajar más.  Si el nivel de rodeos sobrepasa el trabajo útil realizado tu programa podría ser más lento.  Deberías evitar abstracciones excesivas, especialmente, en forma de pequeñas funciones o métodos (que también va en detrimento de la legibilidad).
@end itemize

If you have reached the limit of what pure Python can allow, there are tools
to take you further away.  For example, Cython@footnote{https://cython.org} can
compile a slightly modified version of Python code into a C extension, and
can be used on many different platforms.  Cython can take advantage of
compilation (and optional type annotations) to make your code significantly
faster than when interpreted.  If you are confident in your C programming
skills, you can also @ref{1be2,,write a C extension module}
yourself.


@subsubheading Ver también


La página de la wiki dedicada a trucos de rendimiento@footnote{https://wiki.python.org/moin/PythonSpeed/PerformanceTips}.


@node ¿Cuál es la forma más eficiente de concatenar muchas cadenas conjuntamente?,,Mi programa es muy lento ¿Cómo puedo acelerarlo?,Rendimiento<3>
@anchor{faq/programming efficient-string-concatenation}@anchor{5009}@anchor{faq/programming what-is-the-most-efficient-way-to-concatenate-many-strings-together}@anchor{500a}
@subsubsection ¿Cuál es la forma más eficiente de concatenar muchas cadenas conjuntamente?


Los objetos @ref{237,,str} y @ref{325,,bytes} son inmutables, por tanto, concatenar muchas cadenas en una sola es ineficiente debido a que cada concatenación crea un nuevo objeto. En el caso más general, el coste total en tiempo de ejecución es cuadrático en relación a la longitud de la cadena final.

Para acumular muchos objetos @ref{237,,str}, la forma recomendada sería colocarlos en una lista y llamar al método @ref{21b5,,str.join()} al final:

@example
chunks = []
for s in my_strings:
    chunks.append(s)
result = '@w{'}.join(chunks)
@end example

(otra forma que sería razonable en términos de eficiencia sería usar @ref{fa9,,io.StringIO})

Para acumular muchos objetos @ref{325,,bytes}, la forma recomendada sería extender un objeto @ref{5e0,,bytearray} usando el operador de concatenación   in situ (el operador @code{+=}):

@example
result = bytearray()
for b in my_bytes_objects:
    result += b
@end example

@node Secuencias Tuplas/Listas,Objetos,Rendimiento<3>,Preguntas frecuentes de programación
@anchor{faq/programming sequences-tuples-lists}@anchor{500b}
@subsection Secuencias (Tuplas/Listas)


@menu
* ¿Cómo convertir entre tuplas y listas?:: 
* ¿Qué es un índice negativo?:: 
* ¿Cómo puedo iterar sobre una secuencia en orden inverso?:: 
* ¿Cómo eliminar duplicados de una lista?:: 
* Cómo eliminar duplicados de una lista:: 
* ¿Cómo se puede hacer un array en Python?:: 
* ¿Cómo puedo crear una lista multidimensional?:: 
* How do I apply a method or function to a sequence of objects?:: 
* ¿Por qué hacer lo siguiente@comma{} a_tuple[i] += ['item']@comma{} lanza una excepción cuando la suma funciona?: ¿Por qué hacer lo siguiente a_tuple[i] += ['item'] lanza una excepción cuando la suma funciona?. 
* Quiero hacer una ordenación compleja; ¿Puedes hacer una transformada Schwartziana (Schwartzian Transform) en Python?: Quiero hacer una ordenación compleja ¿Puedes hacer una transformada Schwartziana Schwartzian Transform en Python?. 
* ¿Cómo puedo ordenar una lista a partir de valores de otra lista?:: 

@end menu

@node ¿Cómo convertir entre tuplas y listas?,¿Qué es un índice negativo?,,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-i-convert-between-tuples-and-lists}@anchor{500c}
@subsubsection ¿Cómo convertir entre tuplas y listas?


El constructor @code{tuple(seq)} convierte cualquier secuencia (en realidad, cualquier iterable) en una tupla con los mismos elementos y en el mismo orden.

Por ejemplo, @code{tuple([1, 2, 3])} lo convierte en @code{(1, 2, 3)} y @code{tuple('abc')} lo convierte en @code{('a', 'b', 'c')}.  Si el argumento es una tupla no creará una nueva copia y retornará el mismo objeto, por tanto, llamar a @ref{464,,tuple()} no tendrá mucho coste si no estás seguro si un objeto ya es una tupla.

El constructor @code{list(seq)} convierte cualquier secuencia o iterable en una lista con los mismos elementos y en el mismo orden.  Por ejemplo, @code{list((1, 2, 3))} lo convierte a @code{[1, 2, 3]} y @code{list('abc')} lo convierte a @code{['a', 'b', 'c']}.  Si el argumento es una lista, hará una copia como lo haría @code{seq[:]}.

@node ¿Qué es un índice negativo?,¿Cómo puedo iterar sobre una secuencia en orden inverso?,¿Cómo convertir entre tuplas y listas?,Secuencias Tuplas/Listas
@anchor{faq/programming what-s-a-negative-index}@anchor{500d}
@subsubsection ¿Qué es un índice negativo?


Las secuencias en Python están indexadas con números positivos y negativos.  Para los números positivos el  0 será el primer índice, el 1 el segundo y así en adelante.  Para los índices negativos el -1 el último índice, el -2 el penúltimo, etc.  Piensa en @code{seq[-n]} como si fuera @code{seq[len(seq)-n]}.

El uso de índices negativos puede ser muy conveniente.  Por ejemplo @code{S[:-1]} se usa para todo la cadena excepto para su último carácter, lo cual es útil para eliminar el salto de línea final de una cadena.

@node ¿Cómo puedo iterar sobre una secuencia en orden inverso?,¿Cómo eliminar duplicados de una lista?,¿Qué es un índice negativo?,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-i-iterate-over-a-sequence-in-reverse-order}@anchor{500e}
@subsubsection ¿Cómo puedo iterar sobre una secuencia en orden inverso?


Usa la función incorporada @ref{8fc,,reversed()}:

@example
for x in reversed(sequence):
    ...  # do something with x ...
@end example

Esto no transformará la secuencia original sino que creará una nueva copia en orden inverso por la que se puede iterar.

@node ¿Cómo eliminar duplicados de una lista?,Cómo eliminar duplicados de una lista,¿Cómo puedo iterar sobre una secuencia en orden inverso?,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-you-remove-duplicates-from-a-list}@anchor{500f}
@subsubsection ¿Cómo eliminar duplicados de una lista?


Puedes echar un vistazo al recetario de Python para ver una gran discusión mostrando muchas formas de hacer esto:

@quotation

@indicateurl{https://code.activestate.com/recipes/52560/}
@end quotation

Si no te preocupa que la lista se reordene la puedes ordenar y, después, y después escanearla desde el final borrando duplicados a medida que avanzas:

@example
if mylist:
    mylist.sort()
    last = mylist[-1]
    for i in range(len(mylist)-2, -1, -1):
        if last == mylist[i]:
            del mylist[i]
        else:
            last = mylist[i]
@end example

Si todos los elementos de la lista pueden ser usados como claves (por ejemplo son todos @ref{6b1,,hashable}) esto será, en general, más rápido

@example
mylist = list(set(mylist))
@end example

Esto convierte la lista en un conjunto eliminando, por tanto, los duplicados y, posteriormente, puedes volver a una lista.

@node Cómo eliminar duplicados de una lista,¿Cómo se puede hacer un array en Python?,¿Cómo eliminar duplicados de una lista?,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-you-remove-multiple-items-from-a-list}@anchor{5010}
@subsubsection Cómo eliminar duplicados de una lista


Al igual que con la eliminación de duplicados, una posibilidad es iterar explícitamente a la inversa con una condición de eliminación. Sin embargo, es más fácil y rápido utilizar el reemplazo de sectores con una iteración directa implícita o explícita. Aquí hay tres variaciones.:

@example
mylist[:] = filter(keep_function, mylist)
mylist[:] = (x for x in mylist if keep_condition)
mylist[:] = [x for x in mylist if keep_condition]
@end example

Esta comprensión de lista puede ser la más rápida.

@node ¿Cómo se puede hacer un array en Python?,¿Cómo puedo crear una lista multidimensional?,Cómo eliminar duplicados de una lista,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-you-make-an-array-in-python}@anchor{5011}
@subsubsection ¿Cómo se puede hacer un array en Python?


Usa una lista:

@example
["this", 1, "is", "an", "array"]
@end example

Las listas son equivalentes en complejidad temporal a arrays en C o Pascal; La principal diferencia es que una lista en Python puede contener objetos de diferentes tipos.

The @code{array} module also provides methods for creating arrays of fixed types
with compact representations, but they are slower to index than lists.  Also
note that NumPy@footnote{https://numpy.org/}
and other third party packages define array-like structures with
various characteristics as well.

To get Lisp-style linked lists, you can emulate `cons cells' using tuples:

@example
lisp_list = ("like",  ("this",  ("example", None) ) )
@end example

If mutability is desired, you could use lists instead of tuples.  Here the
analogue of a Lisp `car' is @code{lisp_list[0]} and the analogue of `cdr' is
@code{lisp_list[1]}.  Only do this if you’re sure you really need to, because it’s
usually a lot slower than using Python lists.

@node ¿Cómo puedo crear una lista multidimensional?,How do I apply a method or function to a sequence of objects?,¿Cómo se puede hacer un array en Python?,Secuencias Tuplas/Listas
@anchor{faq/programming faq-multidimensional-list}@anchor{21b4}@anchor{faq/programming how-do-i-create-a-multidimensional-list}@anchor{5012}
@subsubsection ¿Cómo puedo crear una lista multidimensional?


Seguramente hayas intentado crear un array multidimensional de la siguiente forma:

@example
>>> A = [[None] * 2] * 3
@end example

Esto parece correcto si lo muestras en pantalla:

@c A = [[None] * 2] * 3

@example
>>> A
[[None, None], [None, None], [None, None]]
@end example

Pero cuando asignas un valor, se muestra en múltiples sitios:

@c A = [[None] * 2] * 3

@example
>>> A[0][0] = 5
>>> A
[[5, None], [5, None], [5, None]]
@end example

La razón es que replicar una lista con @code{*} no crea copias, solo crea referencias a los objetos existentes.  El @code{*3} crea una lista conteniendo 3 referencias a la misma lista de longitud dos.  Cambios a una fila se mostrarán en todas las filas, lo cual, seguramente, no es lo que deseas.

El enfoque recomendado sería crear, primero, una lista de la longitud deseada y, después, rellenar cada elemento con una lista creada en ese momento:

@example
A = [None] * 3
for i in range(3):
    A[i] = [None] * 2
@end example

Esto genera una lista conteniendo 3 listas distintas de longitud dos.  También puedes usar una comprensión de lista:

@example
w, h = 2, 3
A = [[None] * w for i in range(h)]
@end example

Or, you can use an extension that provides a matrix datatype; NumPy@footnote{https://numpy.org/} is the best known.

@node How do I apply a method or function to a sequence of objects?,¿Por qué hacer lo siguiente a_tuple[i] += ['item'] lanza una excepción cuando la suma funciona?,¿Cómo puedo crear una lista multidimensional?,Secuencias Tuplas/Listas
@anchor{faq/programming how-do-i-apply-a-method-or-function-to-a-sequence-of-objects}@anchor{5013}
@subsubsection How do I apply a method or function to a sequence of objects?


To call a method or function and accumulate the return values is a list,
a @ref{76e,,list comprehension} is an elegant solution:

@example
result = [obj.method() for obj in mylist]

result = [function(obj) for obj in mylist]
@end example

To just run the method or function without saving the return values,
a plain @ref{1eb,,for} loop will suffice:

@example
for obj in mylist:
    obj.method()

for obj in mylist:
    function(obj)
@end example

@node ¿Por qué hacer lo siguiente a_tuple[i] += ['item'] lanza una excepción cuando la suma funciona?,Quiero hacer una ordenación compleja ¿Puedes hacer una transformada Schwartziana Schwartzian Transform en Python?,How do I apply a method or function to a sequence of objects?,Secuencias Tuplas/Listas
@anchor{faq/programming faq-augmented-assignment-tuple-error}@anchor{1fb4}@anchor{faq/programming why-does-a-tuple-i-item-raise-an-exception-when-the-addition-works}@anchor{5014}
@subsubsection ¿Por qué hacer lo siguiente, @code{a_tuple[i] += ['item']}, lanza una excepción cuando la suma funciona?


Esto es debido a la combinación del hecho de que un operador de asignación aumentada es un operador de `asignación' y a la diferencia entre objetos mutables e inmutable en Python.

Esta discusión aplica, en general, cuando los operadores de asignación aumentada se aplican a elementos de una tupla que apuntan a objetos mutables. Pero vamos a usar una @code{lista} y @code{+=} para el ejemplo.

Si escribes:

@example
>>> a_tuple = (1, 2)
>>> a_tuple[0] += 1
Traceback (most recent call last):
   ...
TypeError: 'tuple' object does not support item assignment
@end example

La razón por la que se produce la excepción debería ser evidente: @code{1} se añade al objeto @code{a_tuple[0]} que apunta a (@code{1}), creando el objeto resultante, @code{2}, pero cuando intentamos asignar el resultado del cálculo, @code{2}, al elemento @code{0} de la tupla, obtenemos un error debido a que no podemos cambiar el elemento al que apunta la tupla.

En realidad, lo que esta declaración de asignación aumentada está haciendo es, aproximadamente, lo siguiente:

@example
>>> result = a_tuple[0] + 1
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

Es la parte de asignación de la operación la que provoca el error, debido a que una tupla es inmutable.

Cuando escribes algo como lo siguiente:

@example
>>> a_tuple = (['foo'], 'bar')
>>> a_tuple[0] += ['item']
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

La excepción es un poco más sorprendente e, incluso, más sorprendente es el hecho que aunque hubo un error, la agregación funcionó:

@example
>>> a_tuple[0]
['foo', 'item']
@end example

To see why this happens, you need to know that (a) if an object implements an
@ref{1f8e,,__iadd__()} magic method, it gets called when the @code{+=} augmented
assignment
is executed, and its return value is what gets used in the assignment statement;
and (b) for lists, @code{__iadd__()} is equivalent to calling @code{extend()} on the list
and returning the list.  That’s why we say that for lists, @code{+=} is a
«shorthand» for @code{list.extend()}:

@example
>>> a_list = []
>>> a_list += [1]
>>> a_list
[1]
@end example

Esto es equivalente a

@example
>>> result = a_list.__iadd__([1])
>>> a_list = result
@end example

El objeto al que apunta a_list ha mutado y el puntero al objeto mutado es asignado de vuelta a @code{a_list}.  El resultado final de la asignación no es opción debido a que es un puntero al mismo objeto al que estaba apuntando @code{a_list}  pero la asignación sí que ocurre.

Por tanto, en nuestro ejemplo con tupla lo que está pasando es equivalente a:

@example
>>> result = a_tuple[0].__iadd__(['item'])
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

The @code{__iadd__()} succeeds, and thus the list is extended, but even though
@code{result} points to the same object that @code{a_tuple[0]} already points to,
that final assignment still results in an error, because tuples are immutable.

@node Quiero hacer una ordenación compleja ¿Puedes hacer una transformada Schwartziana Schwartzian Transform en Python?,¿Cómo puedo ordenar una lista a partir de valores de otra lista?,¿Por qué hacer lo siguiente a_tuple[i] += ['item'] lanza una excepción cuando la suma funciona?,Secuencias Tuplas/Listas
@anchor{faq/programming i-want-to-do-a-complicated-sort-can-you-do-a-schwartzian-transform-in-python}@anchor{5015}
@subsubsection Quiero hacer una ordenación compleja: ¿Puedes hacer una transformada Schwartziana (Schwartzian Transform) en Python?


La técnica, atribuida a Randal Schwartz, miembro de la comunidad Perl, ordena los elementos de una lista mediante una métrica que mapea cada elemento a su «valor orden». En Python, usa el argumento @code{key} par el método @ref{c57,,list.sort()}:

@example
Isorted = L[:]
Isorted.sort(key=lambda s: int(s[10:15]))
@end example

@node ¿Cómo puedo ordenar una lista a partir de valores de otra lista?,,Quiero hacer una ordenación compleja ¿Puedes hacer una transformada Schwartziana Schwartzian Transform en Python?,Secuencias Tuplas/Listas
@anchor{faq/programming how-can-i-sort-one-list-by-values-from-another-list}@anchor{5016}
@subsubsection ¿Cómo puedo ordenar una lista a partir de valores de otra lista?


Las puedes unir en un iterador de tuplas, ordena la lista resultando y después extrae el elemento que deseas.

@example
>>> list1 = ["what", "I'm", "sorting", "by"]
>>> list2 = ["something", "else", "to", "sort"]
>>> pairs = zip(list1, list2)
>>> pairs = sorted(pairs)
>>> pairs
[("I'm", 'else'), ('by', 'sort'), ('sorting', 'to'), ('what', 'something')]
>>> result = [x[1] for x in pairs]
>>> result
['else', 'sort', 'to', 'something']
@end example

@node Objetos,Módulos<5>,Secuencias Tuplas/Listas,Preguntas frecuentes de programación
@anchor{faq/programming objects}@anchor{5017}
@subsection Objetos


@menu
* ¿Qué es una clase?:: 
* ¿Qué es un método?:: 
* ¿Qué es self?:: 
* ¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?:: 
* ¿Qué es la delegación?:: 
* ¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?:: 
* ¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?:: 
* ¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?:: 
* ¿Como puedo sobrecargar constructores (o métodos) en Python?: ¿Como puedo sobrecargar constructores o métodos en Python?. 
* Intento usar __spam y obtengo un error sobre _SomeClassName__spam.: Intento usar __spam y obtengo un error sobre _SomeClassName__spam. 
* Mi clase define __del__ pero no se le invoca cuando borro el objeto.: Mi clase define __del__ pero no se le invoca cuando borro el objeto. 
* ¿Cómo puedo obtener una lista de todas las instancias de una clase dada?:: 
* ¿Por qué el resultado de id() no parece ser único?: ¿Por qué el resultado de id no parece ser único?. 
* ¿Cuándo puedo fiarme de pruebas de identidad con el operador is?:: 
* ¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?:: 
* ¿Cómo cacheo llamadas de método?:: 

@end menu

@node ¿Qué es una clase?,¿Qué es un método?,,Objetos
@anchor{faq/programming what-is-a-class}@anchor{5018}
@subsubsection ¿Qué es una clase?


Una clase es un tipo de objeto particular creado mediante la ejecución de la declaración class. Los objetos class se usan como plantillas para crear instancias de objetos que son tanto los datos (atributos) como el código (métodos) específicos para un tipo de dato.

Una clase puede estar basada en una o más clases diferentes, llamadas su(s) clase(s). Hereda los atributos y métodos de sus clases base. Esto permite que se pueda refinar un objeto modelo de forma sucesiva mediante herencia.  Puedes tener una clase genérica @code{Mailbox}  que proporciona métodos de acceso básico para un buzón de correo y subclases como @code{MboxMailbox}, @code{MaildirMailbox}, @code{OutlookMailbox} que gestionan distintos formatos específicos de buzón de correos.

@node ¿Qué es un método?,¿Qué es self?,¿Qué es una clase?,Objetos
@anchor{faq/programming what-is-a-method}@anchor{5019}
@subsubsection ¿Qué es un método?


Un método es una función de un objeto @code{x} que puedes llamar, normalmente, de la forma @code{x.name(arguments...)}.  Los métodos  se definen como funciones dentro de la definición de la clase:

@example
class C:
    def meth(self, arg):
        return arg * 2 + self.attribute
@end example

@node ¿Qué es self?,¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?,¿Qué es un método?,Objetos
@anchor{faq/programming what-is-self}@anchor{501a}
@subsubsection ¿Qué es self?


Self es, básicamente, un nombre que se usa de forma convencional como primer argumento de un método.  Un método definido como @code{meth(self, a, b, c)} se le llama como @code{x.meth(a, b, c)} para una instancia @code{x} de la clase es que se definió; el método invocado pensará que se le ha invocado como @code{meth(x, a, b, c)}.

Ver también @ref{501b,,¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?}.

@node ¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?,¿Qué es la delegación?,¿Qué es self?,Objetos
@anchor{faq/programming how-do-i-check-if-an-object-is-an-instance-of-a-given-class-or-of-a-subclass-of-it}@anchor{501c}
@subsubsection ¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?


Use the built-in function @ref{4ef,,isinstance(obj@comma{} cls)}.  You can
check if an object
is an instance of any of a number of classes by providing a tuple instead of a
single class, e.g. @code{isinstance(obj, (class1, class2, ...))}, and can also
check whether an object is one of Python’s built-in types, e.g.
@code{isinstance(obj, str)} or @code{isinstance(obj, (int, float, complex))}.

Note que @ref{4ef,,isinstance()} también verifica la herencia virtual de una @ref{1224,,abstract base class}. Entonces, la prueba retorna @cite{True} para una clase registrada incluso si no ha heredado directa o indirectamente de ella. Para verificar «herencia verdadera», escanea el @ref{3541,,MRO} de la clase:

@example
from collections.abc import Mapping

class P:
     pass

class C(P):
    pass

Mapping.register(P)
@end example

@example
>>> c = C()
>>> isinstance(c, C)        # direct
True
>>> isinstance(c, P)        # indirect
True
>>> isinstance(c, Mapping)  # virtual
True

# Actual inheritance chain
>>> type(c).__mro__
(<class 'C'>, <class 'P'>, <class 'object'>)

# Test for "true inheritance"
>>> Mapping in type(c).__mro__
False
@end example

Destacar que muchos programas no necesitan usar @ref{4ef,,isinstance()} de forma frecuente en clases definidas por el usuario.  Si estás desarrollando clases un mejor estilo orientado a objetos sería el de definir los métodos en las clases que encapsulan un comportamiento en particular en lugar de ir comprobando la clase del objeto e ir haciendo cosas en base a la clase que es.  Por ejemplo, si tienes una función que hace lo siguiente:

@example
def search(obj):
    if isinstance(obj, Mailbox):
        ...  # code to search a mailbox
    elif isinstance(obj, Document):
        ...  # code to search a document
    elif ...
@end example

Un enfoque más adecuado sería definir un método @code{search()} en todas las clases e invocarlo:

@example
class Mailbox:
    def search(self):
        ...  # code to search a mailbox

class Document:
    def search(self):
        ...  # code to search a document

obj.search()
@end example

@node ¿Qué es la delegación?,¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?,¿Cómo puedo comprobar si un objeto es una instancia de una clase dada o de una subclase de la misma?,Objetos
@anchor{faq/programming what-is-delegation}@anchor{501d}
@subsubsection ¿Qué es la delegación?


La delegación es una técnica orientada a objetos (también llamado un patrón de diseño). Digamos que tienes un objeto @code{x} y deseas cambiar el comportamiento de solo uno de sus métodos.  Puedes crear una nueva clase que proporciona una nueva implementación del método que te interesa cambiar y delega el resto de métodos al método correspondiente de @code{x}.

Los programadores Python pueden implementar la delegación de forma muy sencilla.  Por ejemplo, la siguiente clase implementa una clase que se comporta como un fichero pero convierte todos los datos escritos a mayúsculas:

@example
class UpperOut:

    def __init__(self, outfile):
        self._outfile = outfile

    def write(self, s):
        self._outfile.write(s.upper())

    def __getattr__(self, name):
        return getattr(self._outfile, name)
@end example

Here the @code{UpperOut} class redefines the @code{write()} method to convert the
argument string to uppercase before calling the underlying
@code{self._outfile.write()} method.  All other methods are delegated to the
underlying @code{self._outfile} object.  The delegation is accomplished via the
@ref{57a,,__getattr__()} method; consult @ref{1f63,,the language reference}
for more information about controlling attribute access.

Note that for more general cases delegation can get trickier. When attributes
must be set as well as retrieved, the class must define a @ref{1f2e,,__setattr__()}
method too, and it must do so carefully.  The basic implementation of
@code{__setattr__()} is roughly equivalent to the following:

@example
class X:
    ...
    def __setattr__(self, name, value):
        self.__dict__[name] = value
    ...
@end example

Many @ref{1f2e,,__setattr__()} implementations call @code{object.__setattr__()} to set
an attribute on self without causing infinite recursion:

@example
class X:
    def __setattr__(self, name, value):
        # Custom logic here...
        object.__setattr__(self, name, value)
@end example

Alternatively, it is possible to set attributes by inserting
entries into @ref{5fe,,self.__dict__} directly.

@node ¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?,¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?,¿Qué es la delegación?,Objetos
@anchor{faq/programming how-do-i-call-a-method-defined-in-a-base-class-from-a-derived-class-that-extends-it}@anchor{501e}
@subsubsection ¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?


Usa la función incorporada @ref{155,,super()}:

@example
class Derived(Base):
    def meth(self):
        super().meth()  # calls Base.meth
@end example

En el ejemplo, @ref{155,,super()} automáticamente determinará la instancia desde la cual ha sido llamada (el valor @code{self`}), busca el @ref{2188,,method resolution order} (MRO) con @code{type(self).__mro__}, y devuelve el siguiente en línea después de @code{Derived} en el MRO: @code{Base}.

@node ¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?,¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?,¿Cómo invoco a un método definido en una clase base desde una clase derivada que la extiende?,Objetos
@anchor{faq/programming how-can-i-organize-my-code-to-make-it-easier-to-change-the-base-class}@anchor{501f}
@subsubsection ¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?


Puede asignar la clase base a un alias y derivar del alias. Entonces todo lo que tiene que cambiar es el valor asignado al alias. Por cierto, este truco también es útil si desea decidir dinámicamente (por ejemplo, dependiendo de la disponibilidad de recursos) qué clase base usar. Ejemplo:

@example
class Base:
    ...

BaseAlias = Base

class Derived(BaseAlias):
    ...
@end example

@node ¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?,¿Como puedo sobrecargar constructores o métodos en Python?,¿Cómo puedo organizar mi código para hacer que sea más sencillo modificar la clase base?,Objetos
@anchor{faq/programming how-do-i-create-static-class-data-and-static-class-methods}@anchor{5020}
@subsubsection ¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?


Tanto los datos estáticos como los métodos estáticos (en el sentido de C++ o Java) están permitidos en Python.

Para datos estáticos simplemente define un atributo de clase.  Para asignar un nuevo valor al atributo debes usar de forma explícita el nombre de la clase en la asignación:

@example
class C:
    count = 0   # number of times C.__init__ called

    def __init__(self):
        C.count = C.count + 1

    def getcount(self):
        return C.count  # or return self.count
@end example

@code{c.count} también se refiere a @code{C.count} para cualquier @code{c} de tal forma que se cumpla @code{isinstance(c, C)}, a no ser que @code{c} sea sobreescrita por si misma o por alguna clase contenida en la búsqueda de clases base desde @code{c.__class__} hasta @code{C}.

Debes tener cuidado: dentro de un método de C, una asignación como @code{self.count = 42} creará una nueva instancia sin relación con la original que se llamará «count» en el propio diccionario de @code{self}.  El reunificar el nombre de datos estáticos de una clase debería llevar, siempre, a especificar la clase tanto si se produce desde dentro de un método como si no:

@example
C.count = 314
@end example

Los métodos estáticos son posibles:

@example
class C:
    @@staticmethod
    def static(arg1, arg2, arg3):
        # No 'self' parameter!
        ...
@end example

Sin embargo, una forma más directa de obtener el efecto de un método estático sería mediante una simple función a nivel de módulo:

@example
def getcount():
    return C.count
@end example

Si has estructurado tu código para definir una clase única (o una jerarquía de clases altamente relacionadas) por módulo, esto proporcionará la encapsulación deseada.

@node ¿Como puedo sobrecargar constructores o métodos en Python?,Intento usar __spam y obtengo un error sobre _SomeClassName__spam,¿Cómo puedo crear datos estáticos de clase y métodos estáticos de clase?,Objetos
@anchor{faq/programming how-can-i-overload-constructors-or-methods-in-python}@anchor{5021}
@subsubsection ¿Como puedo sobrecargar constructores (o métodos) en Python?


Esta respuesta es aplicable, en realidad, a todos los métodos pero la pregunta suele surgir primero en el contexto de los constructores.

En C++ deberías escribir

@example
class C @{
    C() @{ cout << "No arguments\n"; @}
    C(int i) @{ cout << "Argument is " << i << "\n"; @}
@}
@end example

En Python solo debes escribir un único constructor que tenga en cuenta todos los casos usando los argumentos por defecto.  Por ejemplo:

@example
class C:
    def __init__(self, i=None):
        if i is None:
            print("No arguments")
        else:
            print("Argument is", i)
@end example

Esto no es totalmente equivalente pero, en la práctica, es muy similar.

Podrías intentar, también una lista de argumentos de longitud variable, por ejemplo

@example
def __init__(self, *args):
    ...
@end example

El mismo enfoque funciona para todas las definiciones de métodos.

@node Intento usar __spam y obtengo un error sobre _SomeClassName__spam,Mi clase define __del__ pero no se le invoca cuando borro el objeto,¿Como puedo sobrecargar constructores o métodos en Python?,Objetos
@anchor{faq/programming i-try-to-use-spam-and-i-get-an-error-about-someclassname-spam}@anchor{5022}
@subsubsection Intento usar __spam y obtengo un error sobre _SomeClassName__spam.


Nombres de variable con doble guión prefijado se convierten, con una modificación de nombres, para proporcionar una forma simple pero efectiva de definir variables de clase privadas. Cualquier identificador de la forma @code{__spam} (como mínimo dos guiones bajos como prefijo, como máximo un guión bajo como sufijo) se reemplaza con @code{_classname__spam}, donde @code{classname} es el nombre de la clase eliminando cualquier guión bajo prefijado.

The identifier can be used unchanged within the class, but to access it outside
the class, the mangled name must be used:

@example
class A:
    def __one(self):
        return 1
    def two(self):
        return 2 * self.__one()

class B(A):
    def three(self):
        return 3 * self._A__one()

four = 4 * A()._A__one()
@end example

In particular, this does not guarantee privacy since an outside user can still
deliberately access the private attribute; many Python programmers never bother
to use private variable names at all.


@subsubheading Ver también


The @ref{1cc1,,private name mangling specifications}
for details and special cases.


@node Mi clase define __del__ pero no se le invoca cuando borro el objeto,¿Cómo puedo obtener una lista de todas las instancias de una clase dada?,Intento usar __spam y obtengo un error sobre _SomeClassName__spam,Objetos
@anchor{faq/programming my-class-defines-del-but-it-is-not-called-when-i-delete-the-object}@anchor{5023}
@subsubsection Mi clase define __del__ pero no se le invoca cuando borro el objeto.


Existen varias razones posibles para que suceda así.

The @ref{17ae,,del} statement does not necessarily call @ref{1f60,,__del__()} – it simply
decrements the object’s reference count, and if this reaches zero
@code{__del__()} is called.

If your data structures contain circular links (e.g. a tree where each child has
a parent reference and each parent has a list of children) the reference counts
will never go back to zero.  Once in a while Python runs an algorithm to detect
such cycles, but the garbage collector might run some time after the last
reference to your data structure vanishes, so your @code{__del__()} method may be
called at an inconvenient and random time. This is inconvenient if you’re trying
to reproduce a problem. Worse, the order in which object’s @code{__del__()}
methods are executed is arbitrary.  You can run @ref{acc,,gc.collect()} to force a
collection, but there `are' pathological cases where objects will never be
collected.

Despite the cycle collector, it’s still a good idea to define an explicit
@code{close()} method on objects to be called whenever you’re done with them.  The
@code{close()} method can then remove attributes that refer to subobjects.  Don’t
call @code{__del__()} directly – @code{__del__()} should call @code{close()} and
@code{close()} should make sure that it can be called more than once for the same
object.

Otra forma de evitar referencias cíclicas sería usando el módulo @ref{114,,weakref}, que permite apuntar hacia objetos sin incrementar su conteo de referencias. Las estructuras de datos en árbol, por ejemplo, deberían usar referencias débiles para las referencias del padre y hermanos (¡si es que las necesitan!).

@c XXX relevant for Python 3?
@c 
@c If the object has ever been a local variable in a function that caught an
@c expression in an except clause, chances are that a reference to the object
@c still exists in that function's stack frame as contained in the stack trace.
@c Normally, calling :func:`sys.exc_clear` will take care of this by clearing
@c the last recorded exception.

Finally, if your @code{__del__()} method raises an exception, a warning message
is printed to @ref{9cc,,sys.stderr}.

@node ¿Cómo puedo obtener una lista de todas las instancias de una clase dada?,¿Por qué el resultado de id no parece ser único?,Mi clase define __del__ pero no se le invoca cuando borro el objeto,Objetos
@anchor{faq/programming how-do-i-get-a-list-of-all-instances-of-a-given-class}@anchor{5024}
@subsubsection ¿Cómo puedo obtener una lista de todas las instancias de una clase dada?


Python no hace seguimiento de todas las instancias de una clase (o de los tipos incorporados). Puedes programar el constructor de una clase para que haga seguimiento de todas sus instancias manteniendo una lista de referencias débiles a cada instancia.

@node ¿Por qué el resultado de id no parece ser único?,¿Cuándo puedo fiarme de pruebas de identidad con el operador is?,¿Cómo puedo obtener una lista de todas las instancias de una clase dada?,Objetos
@anchor{faq/programming why-does-the-result-of-id-appear-to-be-not-unique}@anchor{5025}
@subsubsection ¿Por qué el resultado de @code{id()} no parece ser único?


La función incorporada @ref{1462,,id()} devuelve un entero que se garantiza que sea único durante la vida del objeto.  Debido a que en CPython esta es la dirección en memoria del objeto, sucede que, frecuentemente, después de que un objeto se elimina de la memoria el siguiente objeto recién creado se localiza en la misma posición en memoria.  Esto se puede ver ilustrado en este ejemplo:

@example
>>> id(1000) 
13901272
>>> id(2000) 
13901272
@end example

Las dos ids pertenecen a dos objetos “entero” diferentes que se crean antes y se eliminan inmediatamente después de la ejecución de la invocación a @code{id()}.  Para estar seguro que los objetos cuya id quieres examinar siguen vivos crea otra referencia al objeto:

@example
>>> a = 1000; b = 2000
>>> id(a) 
13901272
>>> id(b) 
13891296
@end example

@node ¿Cuándo puedo fiarme de pruebas de identidad con el operador is?,¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?,¿Por qué el resultado de id no parece ser único?,Objetos
@anchor{faq/programming when-can-i-rely-on-identity-tests-with-the-is-operator}@anchor{5026}
@subsubsection ¿Cuándo puedo fiarme de pruebas de identidad con el operador `is'?


El operador @code{is} verifica la identidad de un objeto. La prueba @code{a is b} es equivalente a @code{id(a) == id(b)}.

La propiedad más importante de una prueba de identidad es que un objeto siempre es idéntico a si mismo, @code{a is a} siempre devuelve @code{True}.  Las pruebas de identidad suelen ser más rápidas que pruebas de igualdad.  Y a diferencia de las pruebas de igualdad, las pruebas de identidad están garantizadas de devolver un booleano @code{True} o @code{False}.

Sin embargo, las pruebas de identidad `solo' pueden ser sustituidas por pruebas de igualdad cuando la identidad de objeto está asegurada.  Generalmente hay tres circunstancias en las que la identidad está garantizada:

1) Assignments create new names but do not change object identity.  After the
assignment @code{new = old}, it is guaranteed that @code{new is old}.

2) Putting an object in a container that stores object references does not
change object identity.  After the list assignment @code{s[0] = x}, it is
guaranteed that @code{s[0] is x}.

3) If an object is a singleton, it means that only one instance of that object
can exist.  After the assignments @code{a = None} and @code{b = None}, it is
guaranteed that @code{a is b} because @code{None} is a singleton.

En la mayoría de las demás circunstancias, no se recomiendan las pruebas de identidad y las pruebas de igualdad son preferidas.  En particular, las pruebas de identidad no deben ser usadas para verificar constantes como @ref{1f0,,int} y @ref{237,,str} que no están garantizadas a ser singletons:

@example
>>> a = 1000
>>> b = 500
>>> c = b + 500
>>> a is c
False

>>> a = 'Python'
>>> b = 'Py'
>>> c = b + 'thon'
>>> a is c
False
@end example

De la misma manera, nuevas instancias de contenedores mutables nunca son idénticas:

@example
>>> a = []
>>> b = []
>>> a is b
False
@end example

En la librería estándar de código, verás varios patrones comunes para usar correctamente pruebas de identidad:

1) As recommended by 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, an identity test is the preferred way to check
for @code{None}.  This reads like plain English in code and avoids confusion with
other objects that may have boolean values that evaluate to false.

2) Detecting optional arguments can be tricky when @code{None} is a valid input
value.  In those situations, you can create a singleton sentinel object
guaranteed to be distinct from other objects.  For example, here is how
to implement a method that behaves like @ref{437,,dict.pop()}:

@example
_sentinel = object()

def pop(self, key, default=_sentinel):
    if key in self:
        value = self[key]
        del self[key]
        return value
    if default is _sentinel:
        raise KeyError(key)
    return default
@end example

3) Container implementations sometimes need to augment equality tests with
identity tests.  This prevents the code from being confused by objects such as
@code{float('NaN')} that are not equal to themselves.

For example, here is the implementation of
@code{collections.abc.Sequence.__contains__()}:

@example
def __contains__(self, value):
    for v in self:
        if v is value or v == value:
            return True
    return False
@end example

@node ¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?,¿Cómo cacheo llamadas de método?,¿Cuándo puedo fiarme de pruebas de identidad con el operador is?,Objetos
@anchor{faq/programming how-can-a-subclass-control-what-data-is-stored-in-an-immutable-instance}@anchor{5027}
@subsubsection ¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?


When subclassing an immutable type, override the @ref{624,,__new__()} method
instead of the @ref{751,,__init__()} method.  The latter only runs `after' an
instance is created, which is too late to alter data in an immutable
instance.

Todas estas clases inmutables tienen una firma distinta que su clase padre:

@example
from datetime import date

class FirstOfMonthDate(date):
    "Always choose the first day of the month"
    def __new__(cls, year, month, day):
        return super().__new__(cls, year, month, 1)

class NamedInt(int):
    "Allow text names for some numbers"
    xlat = @{'zero': 0, 'one': 1, 'ten': 10@}
    def __new__(cls, value):
        value = cls.xlat.get(value, value)
        return super().__new__(cls, value)

class TitleStr(str):
    "Convert str to name suitable for a URL path"
    def __new__(cls, s):
        s = s.lower().replace(' ', '-')
        s = '@w{'}.join([c for c in s if c.isalnum() or c == '-'])
        return super().__new__(cls, s)
@end example

Las clases pueden ser utilizadas así:

@example
>>> FirstOfMonthDate(2012, 2, 14)
FirstOfMonthDate(2012, 2, 1)
>>> NamedInt('ten')
10
>>> NamedInt(20)
20
>>> TitleStr('Blog: Why Python Rocks')
'blog-why-python-rocks'
@end example

@node ¿Cómo cacheo llamadas de método?,,¿Cómo puede una subclase controlar qué datos se almacenan en una instancia inmutable?,Objetos
@anchor{faq/programming faq-cache-method-calls}@anchor{272d}@anchor{faq/programming how-do-i-cache-method-calls}@anchor{5028}
@subsubsection ¿Cómo cacheo llamadas de método?


Las dos herramientas principales para cachear métodos son @ref{5e4,,functools.cached_property()} y @ref{a81,,functools.lru_cache()}.  El primero guarda resultados a nivel de instancia y el último a nivel de clase.

La función `cached_property' sólo funciona con métodos que no acepten argumentos.  No crea una referencia a la instancia.  El resultado del método cacheado se mantendrá solo mientras que la instancia esté activa.

The advantage is that when an instance is no longer used, the cached
method result will be released right away.  The disadvantage is that if
instances accumulate, so too will the accumulated method results.  They
can grow without bound.

The `lru_cache' approach works with methods that have @ref{6b1,,hashable}
arguments.  It creates a reference to the instance unless special
efforts are made to pass in weak references.

La ventaja del algoritmo usado menos recientemente es que el cache está limitado por el `maxsize' especificado.  La desventaja es que las instancias se mantienen activas hasta que sean eliminadas del cache por edad o que el cache sea borrado.

Este ejemplo muestra las diversas técnicas:

@example
class Weather:
    "Lookup weather information on a government website"

    def __init__(self, station_id):
        self._station_id = station_id
        # The _station_id is private and immutable

    def current_temperature(self):
        "Latest hourly observation"
        # Do not cache this because old results
        # can be out of date.

    @@cached_property
    def location(self):
        "Return the longitude/latitude coordinates of the station"
        # Result only depends on the station_id

    @@lru_cache(maxsize=20)
    def historic_rainfall(self, date, units='mm'):
        "Rainfall on a given date"
        # Depends on the station_id, date, and units.
@end example

El ejemplo anterior asume que la `station_id' nunca cambia.  Si los atributos de la instancia relevante son mutables, el método de `cached_property' no puede funcionar porque no puede detectar cambios en los atributos.

To make the `lru_cache' approach work when the `station_id' is mutable,
the class needs to define the @ref{b85,,__eq__()} and @ref{b86,,__hash__()}
methods so that the cache can detect relevant attribute updates:

@example
class Weather:
    "Example with a mutable station identifier"

    def __init__(self, station_id):
        self.station_id = station_id

    def change_station(self, station_id):
        self.station_id = station_id

    def __eq__(self, other):
        return self.station_id == other.station_id

    def __hash__(self):
        return hash(self.station_id)

    @@lru_cache(maxsize=20)
    def historic_rainfall(self, date, units='cm'):
        'Rainfall on a given date'
        # Depends on the station_id, date, and units.
@end example

@node Módulos<5>,,Objetos,Preguntas frecuentes de programación
@anchor{faq/programming modules}@anchor{5029}
@subsection Módulos


@menu
* ¿Cómo creo un fichero .pyc?: ¿Cómo creo un fichero pyc?. 
* ¿Cómo puedo encontrar el nombre del módulo en uso?:: 
* ¿Cómo podría tener módulos que se importan mutuamente entre ellos?:: 
* __import__(“x.y.z”) devuelve <module “x”>; ¿cómo puedo obtener z?: __import__ “x y z” devuelve <module “x”>; ¿cómo puedo obtener z?. 
* Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto. ¿Por qué sucede esto?: Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto ¿Por qué sucede esto?. 

@end menu

@node ¿Cómo creo un fichero pyc?,¿Cómo puedo encontrar el nombre del módulo en uso?,,Módulos<5>
@anchor{faq/programming how-do-i-create-a-pyc-file}@anchor{502a}
@subsubsection ¿Cómo creo un fichero .pyc?


Cuando se importa un módulo por primera vez (o cuando el código fuente ha cambiado desde que el fichero compilado se creó) un fichero @code{.pyc} que contiene el código compilado se debería crear en la subcarpeta @code{__pycache__} del directorio que contiene al fichero @code{.py}.  El fichero @code{.pyc} tendrá un nombre que empezará con el mismo nombre que el del fichero  @code{.py} y terminará con @code{.pyc}, con un componente intermedio que dependerá del binario @code{python} en particular que lo creó.  (Ver 
@geindex Python Enhancement Proposals; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} para detalles.)

Una razón por la que no se cree un fichero @code{.pyc} podría ser debido a un problema de permisos del directorio que contiene al fichero fuente, lo que significa que el subdirectorio @code{__pycache__} no se puede crear. Esto puede suceder, por ejemplo, si desarrollas como un usuario pero lo ejecutas como otro, como si estuvieras probando en un servidor web.

Hasta que no definas la variable de entorno 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variables de entorno; PYTHONDONTWRITEBYTECODE
@ref{140e,,PYTHONDONTWRITEBYTECODE}, la creación de un fichero .pyc se hará automáticamente si importas un módulo y Python dispone de la habilidad (permisos, espacio libre, etc…) para crear un subdirectorio @code{__pycache__} y escribir un módulo compilado en ese subdirectorio.

La ejecución de un script principal Python no se considera una importación y no se crea el fichero @code{.pyc}.  Por ejemplo, Si tienes un módulo principal @code{foo.py} que importa a otro módulo @code{xyz.py}, cuando ejecutas @code{foo} (mediante un comando de la shell @code{python foo.py}), se creará un fichero @code{.pyc} para @code{xyz} porque @code{xyz} ha sido importado, pero no se creará un fichero @code{.pyc} para @code{foo} ya que @code{foo.py} no ha sido importado.

Si necesitas crear un fichero @code{.pyc} también para @code{foo} – es decir, crear un fichero @code{.pyc} para un módulo que no ha sido importado – puedes usar los módulos @ref{b3,,py_compile} y @ref{21,,compileall}.

El módulo @ref{b3,,py_compile} puede compilar manualmente cualquier módulo.  Una forma sería usando la función @code{compile()} de ese módulo de forma interactiva:

@example
>>> import py_compile
>>> py_compile.compile('foo.py')                 
@end example

Esto escribirá @code{.pyc} en el subdirectorio @code{__pycache__} en la misma localización en la que se encuentre @code{foo.py} (o, puedes sobreescribir ese comportamiento con el parámetro opcional @code{cfile}).

Puedes compilar automáticamente todos los ficheros en un directorio o directorios usando el módulo @ref{21,,compileall}.  Lo puedes hacer desde la línea de comandos ejecutando @code{compileall.py} y proporcionando una ruta al directorio que contiene los ficheros Python a compilar:

@example
python -m compileall .
@end example

@node ¿Cómo puedo encontrar el nombre del módulo en uso?,¿Cómo podría tener módulos que se importan mutuamente entre ellos?,¿Cómo creo un fichero pyc?,Módulos<5>
@anchor{faq/programming how-do-i-find-the-current-module-name}@anchor{502b}
@subsubsection ¿Cómo puedo encontrar el nombre del módulo en uso?


Un módulo puede encontrar su propio nombre mirando en la variable global predeterminada @code{__name__}.  Si tiene el valor @code{'__main__'}, el programa se está ejecutando como un script.  Muchos módulos que se usan, generalmente, importados en otro script proporcionan, además, una interfaz para la línea de comandos o para probarse a si mismos y solo ejecutan código después de comprobar @code{__name__}:

@example
def main():
    print('Running test...')
    ...

if __name__ == '__main__':
    main()
@end example

@node ¿Cómo podría tener módulos que se importan mutuamente entre ellos?,__import__ “x y z” devuelve <module “x”>; ¿cómo puedo obtener z?,¿Cómo puedo encontrar el nombre del módulo en uso?,Módulos<5>
@anchor{faq/programming how-can-i-have-modules-that-mutually-import-each-other}@anchor{502c}
@subsubsection ¿Cómo podría tener módulos que se importan mutuamente entre ellos?


Supón que tienes los siguientes módulos:

@code{foo.py}:

@example
from bar import bar_var
foo_var = 1
@end example

@code{bar.py}:

@example
from foo import foo_var
bar_var = 2
@end example

El problema es que el intérprete realizará los siguientes pasos:


@itemize *

@item 
main importa a @code{foo}

@item 
Se crean `globals' vacíos para foo

@item 
@code{foo} se compila y se comienza a ejecutar

@item 
@code{foo} importa a @code{bar}

@item 
Se crean `globals' vacíos para @code{bar}

@item 
@code{bar} se compila y se comienza a ejecutar

@item 
@code{bar} importa a @code{foo} (lo cual es un no-op ya que ya hay un módulo que se llama @code{foo})

@item 
El mecanismo de importado intenta leer @code{foo_var} de globales de @code{foo}, para establecer @code{bar.foo_var = foo.foo_var}
@end itemize

El último paso falla debido a que Python todavía no ha terminado de interpretar a @code{foo} y el diccionario de símbolos global para @code{foo} todavía se encuentra vacío.

Lo mismo ocurre cuando usas @code{import foo} y luego tratas de acceder a @code{foo.foo_var} en un código global.

Existen (al menos) tres posibles soluciones para este problema.

Guido van Rossum recomienda evitar todos los usos de @code{from <module> import ...}, y colocar todo el código dentro de funciones.  La inicialización de variables globales y variables de clase debería usar únicamente constantes o funciones incorporadas .  Esto significa que todo se referenciará como @code{<module>.<name>} desde un módulo importado.

Jim Roskind sugiere realizar los siguientes pasos en el siguiente orden en cada módulo:


@itemize *

@item 
exportar (`globals', funciones y clases que no necesitan clases bases importadas)

@item 
@code{import} declaraciones

@item 
código activo (incluyendo `globals' que han sido inicializados desde valores importados).
@end itemize

Van Rossum doesn’t like this approach much because the imports appear in a
strange place, but it does work.

Matthias Urlichs recomienda reestructurar tu código de tal forma que un import recursivo no sea necesario.

Estas soluciones no son mutuamente excluyentes.

@node __import__ “x y z” devuelve <module “x”>; ¿cómo puedo obtener z?,Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto ¿Por qué sucede esto?,¿Cómo podría tener módulos que se importan mutuamente entre ellos?,Módulos<5>
@anchor{faq/programming import-x-y-z-returns-module-x-how-do-i-get-z}@anchor{502d}
@subsubsection __import__(“x.y.z”) devuelve <module “x”>; ¿cómo puedo obtener z?


Considera, en su lugar, usa la función de conveniencia @ref{5bc,,import_module()} de @ref{77,,importlib}:

@example
z = importlib.import_module('x.y.z')
@end example

@node Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto ¿Por qué sucede esto?,,__import__ “x y z” devuelve <module “x”>; ¿cómo puedo obtener z?,Módulos<5>
@anchor{faq/programming when-i-edit-an-imported-module-and-reimport-it-the-changes-don-t-show-up-why-does-this-happen}@anchor{502e}
@subsubsection Cuando edito un módulo importado y lo reimporto los cambios no tienen efecto. ¿Por qué sucede esto?


Por razones de eficiencia además de por consistencia, Python solo lee el fichero del módulo la primera vez que el módulo se importa.  Si no lo hiciera así, un programa escrito en muchos módulos donde cada módulo importa al mismo módulo básico estaría analizando sintácticamente el mismo módulo básico muchas veces.  Para forzar una relectura de un módulo que ha sido modificado haz lo siguiente:

@example
import importlib
import modname
importlib.reload(modname)
@end example

Alerta: esta técnica no es 100% segura.  En particular, los módulos que contienen declaraciones como

@example
from modname import some_objects
@end example

continuarán funcionando con la versión antigua de los objetos importados.  Si el módulo contiene definiciones de clase, instancias de clase ya existentes `no' se actualizarán para usar la nueva definición de la clase.  Esto podría resultar en el comportamiento paradójico siguiente:

@example
>>> import importlib
>>> import cls
>>> c = cls.C()                # Create an instance of C
>>> importlib.reload(cls)
<module 'cls' from 'cls.py'>
>>> isinstance(c, cls.C)       # isinstance is false?!?
False
@end example

La naturaleza del problema se hace evidente si muestras la «identity» de los objetos clase:

@example
>>> hex(id(c.__class__))
'0x7352a0'
>>> hex(id(cls.C))
'0x4198d0'
@end example

@node Preguntas frecuentes sobre diseño e historia,Preguntas frecuentes sobre bibliotecas y extensiones,Preguntas frecuentes de programación,Preguntas más frecuentes de Python
@anchor{faq/design doc}@anchor{502f}@anchor{faq/design design-and-history-faq}@anchor{5030}
@section Preguntas frecuentes sobre diseño e historia



@menu
* ¿Por qué Python usa indentación para agrupar declaraciones?:: 
* ¿Por qué obtengo resultados extraños con operaciones aritméticas simples?:: 
* ¿Por qué los cálculos de punto flotante son tan inexactos?:: 
* ¿Por qué las cadenas de caracteres de Python son inmutables?:: 
* ¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?:: 
* ¿Por qué no puedo usar una tarea en una expresión?:: 
* ¿Por qué Python usa métodos para alguna funcionalidad (por ejemplo@comma{} list.index()) pero funciones para otra (por ejemplo@comma{} len(list))?: ¿Por qué Python usa métodos para alguna funcionalidad por ejemplo list index pero funciones para otra por ejemplo len list ?. 
* ¿Por qué join() es un método de cadena de caracteres en lugar de un método de lista o tupla?: ¿Por qué join es un método de cadena de caracteres en lugar de un método de lista o tupla?. 
* ¿Qué tan rápido van las excepciones?:: 
* ¿Por qué no hay un switch o una declaración case en Python?:: 
* ¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?:: 
* ¿Por qué las expresiones lambda no pueden contener sentencias?:: 
* ¿Se puede compilar Python en código máquina@comma{} C o algún otro lenguaje?: ¿Se puede compilar Python en código máquina C o algún otro lenguaje?. 
* ¿Cómo gestiona Python la memoria?:: 
* ¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?:: 
* ¿Por qué no se libera toda la memoria cuando sale CPython?:: 
* ¿Por qué hay tipos de datos separados de tuplas y listas?:: 
* ¿Cómo se implementan las listas en Python?:: 
* ¿Cómo se implementan los diccionarios en CPython?:: 
* ¿Por qué las claves del diccionario deben ser inmutables?:: 
* ¿Por qué list.sort() no retorna la lista ordenada?: ¿Por qué list sort no retorna la lista ordenada?. 
* ¿Cómo se especifica y aplica una especificación de interfaz en Python?:: 
* ¿Por qué no hay goto?:: 
* ¿Por qué las cadenas de caracteres sin formato (r-strings) no pueden terminar con una barra diagonal inversa?: ¿Por qué las cadenas de caracteres sin formato r-strings no pueden terminar con una barra diagonal inversa?. 
* ¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?:: 
* ¿Por qué los generadores no admiten la declaración with?:: 
* ¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?:: 
* ¿Por qué Python permite comas al final de las listas y tuplas?:: 

@end menu

@node ¿Por qué Python usa indentación para agrupar declaraciones?,¿Por qué obtengo resultados extraños con operaciones aritméticas simples?,,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-does-python-use-indentation-for-grouping-of-statements}@anchor{5031}
@subsection ¿Por qué Python usa indentación para agrupar declaraciones?


Guido van Rossum cree que usar indentación para agrupar es extremadamente elegante y contribuye mucho a la claridad del programa Python promedio. La mayoría de las personas aprenden a amar esta característica después de un tiempo.

Como no hay corchetes de inicio/fin, no puede haber un desacuerdo entre la agrupación percibida por el analizador y el lector humano. Ocasionalmente, los programadores de C encontrarán un fragmento de código como este:

@example
if (x <= y)
        x++;
        y--;
z++;
@end example

Solo se ejecuta la instrucción @code{x ++} si la condición es verdadera, pero la indentación lo lleva a creer lo contrario. Incluso los programadores experimentados de C a veces lo miran durante mucho tiempo preguntándose por qué @code{y} se está disminuyendo incluso para @code{x > y}.

Debido a que no hay corchetes de inicio/fin, Python es mucho menos propenso a conflictos de estilo de codificación. En C hay muchas formas diferentes de colocar llaves. Después de acostumbrarse a leer y escribir código usando un estilo en particular, es normal sentirse algo incómodo al leer (o tener que escribir) en uno diferente.

Muchos estilos de codificación colocan corchetes de inicio / fin en una línea por sí mismos. Esto hace que los programas sean considerablemente más largos y desperdicia un valioso espacio en la pantalla, lo que dificulta obtener una buena visión general de un programa. Idealmente, una función debería caber en una pantalla (por ejemplo, 20-30 líneas). 20 líneas de Python pueden hacer mucho más trabajo que 20 líneas de C. Esto no se debe únicamente a la falta de corchetes de inicio/fin – la falta de declaraciones y los tipos de datos de alto nivel también son responsables – sino también la indentación basada en la sintaxis ciertamente ayuda.

@node ¿Por qué obtengo resultados extraños con operaciones aritméticas simples?,¿Por qué los cálculos de punto flotante son tan inexactos?,¿Por qué Python usa indentación para agrupar declaraciones?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-am-i-getting-strange-results-with-simple-arithmetic-operations}@anchor{5032}
@subsection ¿Por qué obtengo resultados extraños con operaciones aritméticas simples?


Ver la siguiente pregunta.

@node ¿Por qué los cálculos de punto flotante son tan inexactos?,¿Por qué las cadenas de caracteres de Python son inmutables?,¿Por qué obtengo resultados extraños con operaciones aritméticas simples?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-are-floating-point-calculations-so-inaccurate}@anchor{5033}
@subsection ¿Por qué los cálculos de punto flotante son tan inexactos?


Los usuarios a menudo se sorprenden por resultados como este:

@example
>>> 1.2 - 1.0
0.19999999999999996
@end example

y creo que es un error en Python. No es. Esto tiene poco que ver con Python, y mucho más con la forma en que la plataforma subyacente maneja los números de punto flotante.

El tipo @ref{153,,float} en CPython usa una C @code{double} para el almacenamiento. Un valor del objeto @ref{153,,float} se almacena en coma flotante binaria con una precisión fija (típicamente 53 bits) y Python usa operaciones C, que a su vez dependen de la implementación de hardware en el procesador, para realizar operaciones de coma flotante. Esto significa que, en lo que respecta a las operaciones de punto flotante, Python se comporta como muchos lenguajes populares, incluidos C y Java.

Many numbers that can be written easily in decimal notation cannot be expressed
exactly in binary floating point.  For example, after:

@example
>>> x = 1.2
@end example

el valor almacenado para @code{x} es una aproximación (muy buena) al valor decimal @code{1.2}, pero no es exactamente igual a él. En una máquina típica, el valor real almacenado es:

@example
1.0011001100110011001100110011001100110011001100110011 (binary)
@end example

que es exactamente:

@example
1.1999999999999999555910790149937383830547332763671875 (decimal)
@end example

La precisión típica de 53 bits proporciona flotantes Python con 15–16 dígitos decimales de precisión.

For a fuller explanation, please see the @ref{1d17,,floating-point arithmetic} chapter in the Python tutorial.

@node ¿Por qué las cadenas de caracteres de Python son inmutables?,¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?,¿Por qué los cálculos de punto flotante son tan inexactos?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-are-python-strings-immutable}@anchor{5034}
@subsection ¿Por qué las cadenas de caracteres de Python son inmutables?


Hay varias ventajas.

Una es el rendimiento: saber que una cadena es inmutable significa que podemos asignarle espacio en el momento de la creación, y los requisitos de almacenamiento son fijos e inmutables. Esta es también una de las razones para la distinción entre tuplas y listas.

Otra ventaja es que las cadenas en Python se consideran tan «elementales» como los números. Ninguna cantidad de actividad cambiará el valor 8 a otra cosa, y en Python, ninguna cantidad de actividad cambiará la cadena «ocho» a otra cosa.

@node ¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?,¿Por qué no puedo usar una tarea en una expresión?,¿Por qué las cadenas de caracteres de Python son inmutables?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-must-self-be-used-explicitly-in-method-definitions-and-calls}@anchor{5035}@anchor{faq/design why-self}@anchor{501b}
@subsection ¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?


La idea fue tomada de Modula-3. Resulta ser muy útil, por una variedad de razones.

Primero, es más obvio que está utilizando un método o atributo de instancia en lugar de una variable local. Leer @code{self.x} o @code{self.meth()} deja absolutamente claro que se usa una variable de instancia o método incluso si no conoce la definición de clase de memoria. En C++, puede darse cuenta de la falta de una declaración de variable local (suponiendo que los globales son raros o fácilmente reconocibles) – pero en Python, no hay declaraciones de variables locales, por lo que debería buscar la definición de clase para estar seguro. Algunos estándares de codificación de C++ y Java requieren que los atributos de instancia tengan un prefijo @code{m_}, porque el ser explícito también es útil en esos lenguajes.

En segundo lugar, significa que no es necesaria una sintaxis especial si desea hacer referencia explícita o llamar al método desde una clase en particular. En C++, si desea usar un método de una clase base que se anula en una clase derivada, debe usar el operador @code{::} – en Python puede escribir @code{baseclass.methodname(self, <argument list>)}. Esto es particularmente útil para métodos @ref{751,,__init__()}, y en general en los casos en que un método de clase derivada quiere extender el método de clase base del mismo nombre y, por lo tanto, tiene que llamar al método de clase base de alguna manera.

Finalmente, para las variables de instancia se resuelve un problema sintáctico con la asignación: dado que las variables locales en Python son (¡por definición!) Aquellas variables a las que se asigna un valor en un cuerpo de función (y que no se declaran explícitamente como globales), tiene que haber una forma de decirle al intérprete que una asignación estaba destinada a asignar a una variable de instancia en lugar de a una variable local, y que preferiblemente debería ser sintáctica (por razones de eficiencia). C++ hace esto a través de declaraciones, pero Python no tiene declaraciones y sería una pena tener que presentarlas solo para este propósito. Usar el @code{self.var} explícito resuelve esto muy bien. Del mismo modo, para usar variables de instancia, tener que escribir @code{self.var} significa que las referencias a nombres no calificados dentro de un método no tienen que buscar en los directorios de la instancia. Para decirlo de otra manera, las variables locales y las variables de instancia viven en dos espacios de nombres diferentes, y debe decirle a Python qué espacio de nombres usar.

@node ¿Por qué no puedo usar una tarea en una expresión?,¿Por qué Python usa métodos para alguna funcionalidad por ejemplo list index pero funciones para otra por ejemplo len list ?,¿Por qué debe usarse “self” explícitamente en las definiciones y llamadas de métodos?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design id1}@anchor{5036}@anchor{faq/design why-can-t-i-use-an-assignment-in-an-expression}@anchor{1c58}
@subsection ¿Por qué no puedo usar una tarea en una expresión?


¡A partir de Python 3.8, se puede!

Asignación de expresiones usando el operador walrus @code{:=} asigna una variable en una expresión:

@example
while chunk := fp.read(200):
   print(chunk)
@end example

Ver 
@geindex Python Enhancement Proposals; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para más información.

@node ¿Por qué Python usa métodos para alguna funcionalidad por ejemplo list index pero funciones para otra por ejemplo len list ?,¿Por qué join es un método de cadena de caracteres en lugar de un método de lista o tupla?,¿Por qué no puedo usar una tarea en una expresión?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-does-python-use-methods-for-some-functionality-e-g-list-index-but-functions-for-other-e-g-len-list}@anchor{5037}
@subsection ¿Por qué Python usa métodos para alguna funcionalidad (por ejemplo, list.index()) pero funciones para otra (por ejemplo, len(list))?


Como dijo Guido:

@quotation

(a) Para algunas operaciones, la notación de prefijo solo se lee mejor que postfijo – las operaciones de prefijo (e ¡infijo!) tienen una larga tradición en matemáticas que le gustan las anotaciones donde las imágenes ayudan al matemático a pensar en un problema. Compare lo fácil con que reescribimos una fórmula como x*(a+b) en x*a + x*b con la torpeza de hacer lo mismo usando una notación OO sin procesar.

(b) Cuando leo un código que dice len(x), `sé' que está pidiendo la longitud de algo. Esto me dice dos cosas: el resultado es un número entero y el argumento es algún tipo de contenedor. Por el contrario, cuando leo x.len (), ya debo saber que x es algún tipo de contenedor que implementa una interfaz o hereda de una clase que tiene un estándar len(). Sea testigo de la confusión que ocasionalmente tenemos cuando una clase que no está implementando una asignación tiene un método get() o keys(), o algo que no es un archivo tiene un método write().


@center --- @indicateurl{https://mail.python.org/pipermail/python-3000/2006-November/004643.html}

@end quotation

@node ¿Por qué join es un método de cadena de caracteres en lugar de un método de lista o tupla?,¿Qué tan rápido van las excepciones?,¿Por qué Python usa métodos para alguna funcionalidad por ejemplo list index pero funciones para otra por ejemplo len list ?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-is-join-a-string-method-instead-of-a-list-or-tuple-method}@anchor{5038}
@subsection ¿Por qué join() es un método de cadena de caracteres en lugar de un método de lista o tupla?


Las cadenas de caracteres se volvieron mucho más parecidas a otros tipos estándar a partir de Python 1.6, cuando se agregaron métodos que brindan la misma funcionalidad que siempre ha estado disponible utilizando las funciones del módulo de cadenas. La mayoría de estos nuevos métodos han sido ampliamente aceptados, pero el que parece hacer que algunos programadores se sientan incómodos es:

@example
", ".join(['1', '2', '4', '8', '16'])
@end example

que da el resultado:

@example
"1, 2, 4, 8, 16"
@end example

Hay dos argumentos comunes en contra de este uso.

El primero corre a lo largo de las líneas de: «Se ve realmente feo el uso de un método de un literal de cadena (constante de cadena)», a lo que la respuesta es que sí, pero un literal de cadena es solo un valor fijo. Si se permiten los métodos en nombres vinculados a cadenas, no hay razón lógica para que no estén disponibles en literales.

La segunda objeción generalmente se presenta como: «Realmente estoy diciéndole a una secuencia que una a sus miembros junto con una constante de cadena». Lamentablemente, no lo estas haciendo. Por alguna razón, parece ser mucho menos difícil tener @ref{f2b,,split()} como método de cadena, ya que en ese caso es fácil ver que:

@example
"1, 2, 4, 8, 16".split(", ")
@end example

es una instrucción a un literal de cadena para retornar las subcadenas de caracteres delimitadas por el separador dado (o, por defecto, ejecuciones arbitrarias de espacio en blanco).

@ref{21b5,,join()} es un método de cadena de caracteres porque al usarlo le está diciendo a la cadena de separación que itere sobre una secuencia de cadenas y se inserte entre elementos adyacentes. Este método se puede usar con cualquier argumento que obedezca las reglas para los objetos de secuencia, incluidas las clases nuevas que pueda definir usted mismo. Existen métodos similares para bytes y objetos bytearray.

@node ¿Qué tan rápido van las excepciones?,¿Por qué no hay un switch o una declaración case en Python?,¿Por qué join es un método de cadena de caracteres en lugar de un método de lista o tupla?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design how-fast-are-exceptions}@anchor{5039}
@subsection ¿Qué tan rápido van las excepciones?


Un bloque @ref{789,,try}/@ref{2f6,,except} es extremadamente eficiente si no son lanzada excepciones. En realidad, capturar una excepción es costoso. En versiones de Python anteriores a la 2.0, era común usar este modismo:

@example
try:
    value = mydict[key]
except KeyError:
    mydict[key] = getvalue(key)
    value = mydict[key]
@end example

Esto solo tenía sentido cuando esperaba que el dict tuviera la clave casi todo el tiempo. Si ese no fuera el caso, lo codificó así:

@example
if key in mydict:
    value = mydict[key]
else:
    value = mydict[key] = getvalue(key)
@end example

Para este caso específico, también podría usar @code{value = dict.setdefault(key, getvalue(key))}, pero solo si la llamada @code{getvalue()} es lo suficientemente barata porque se evalúa en todos los casos.

@node ¿Por qué no hay un switch o una declaración case en Python?,¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?,¿Qué tan rápido van las excepciones?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-isn-t-there-a-switch-or-case-statement-in-python}@anchor{503a}
@subsection ¿Por qué no hay un `switch' o una declaración `case' en Python?


In general, structured switch statements execute one block of code
when an expression has a particular value or set of values.
Since Python 3.10 one can easily match literal values, or constants
within a namespace, with a @code{match ... case} statement.
An older alternative is a sequence of @code{if... elif... elif... else}.

Para los casos en los que necesita elegir entre una gran cantidad de posibilidades, puede crear un diccionario que asigne valores de casos a funciones para llamar. Por ejemplo:

@example
functions = @{'a': function_1,
             'b': function_2,
             'c': self.method_1@}

func = functions[value]
func()
@end example

Para invocar métodos en objetos, puede simplificar aún más utilizando @ref{c59,,getattr()} incorporado para recuperar métodos con un nombre particular:

@example
class MyVisitor:
    def visit_a(self):
        ...

    def dispatch(self, value):
        method_name = 'visit_' + str(value)
        method = getattr(self, method_name)
        method()
@end example

Se sugiere que utilice un prefijo para los nombres de los métodos, como @code{visit_} en este ejemplo. Sin dicho prefijo, si los valores provienen de una fuente no confiable, un atacante podría invocar cualquier método en su objeto.

Imitating switch with fallthrough, as with C’s switch-case-default,
is possible, much harder, and less needed.

@node ¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?,¿Por qué las expresiones lambda no pueden contener sentencias?,¿Por qué no hay un switch o una declaración case en Python?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design can-t-you-emulate-threads-in-the-interpreter-instead-of-relying-on-an-os-specific-thread-implementation}@anchor{503b}
@subsection ¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?


Respuesta 1: Desafortunadamente, el intérprete empuja al menos un marco de pila C para cada marco de pila de Python. Además, las extensiones pueden volver a llamar a Python en momentos casi aleatorios. Por lo tanto, una implementación completa de subprocesos requiere soporte de subprocesos para C.

Respuesta 2: Afortunadamente, existe Python sin pila@footnote{https://github.com/stackless-dev/stackless/wiki}, que tiene un bucle de intérprete completamente rediseñado que evita la pila C.

@node ¿Por qué las expresiones lambda no pueden contener sentencias?,¿Se puede compilar Python en código máquina C o algún otro lenguaje?,¿No puede emular hilos en el intérprete en lugar de confiar en una implementación de hilos específica del sistema operativo?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-can-t-lambda-expressions-contain-statements}@anchor{503c}
@subsection ¿Por qué las expresiones lambda no pueden contener sentencias?


Las expresiones lambda de Python no pueden contener declaraciones porque el marco sintáctico de Python no puede manejar declaraciones anidadas dentro de expresiones. Sin embargo, en Python, este no es un problema grave. A diferencia de las formas lambda en otros lenguajes, donde agregan funcionalidad, las lambdas de Python son solo una notación abreviada si eres demasiado vago para definir una función.

Las funciones ya son objetos de primera clase en Python, y pueden declararse en un ámbito local. Por lo tanto, la única ventaja de usar una lambda en lugar de una función definida localmente es que no es necesario inventar un nombre para la función – ¡pero eso es sólo una variable local a la que se asigna el objeto función (que es exactamente el mismo tipo de objeto que produce una expresión lambda)!

@node ¿Se puede compilar Python en código máquina C o algún otro lenguaje?,¿Cómo gestiona Python la memoria?,¿Por qué las expresiones lambda no pueden contener sentencias?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design can-python-be-compiled-to-machine-code-c-or-some-other-language}@anchor{503d}
@subsection ¿Se puede compilar Python en código máquina, C o algún otro lenguaje?


Cython@footnote{https://cython.org/} compiles a modified version of Python with
optional annotations into C extensions.  Nuitka@footnote{https://nuitka.net/} is
an up-and-coming compiler of Python into C++ code, aiming to support the full
Python language.

@node ¿Cómo gestiona Python la memoria?,¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?,¿Se puede compilar Python en código máquina C o algún otro lenguaje?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design how-does-python-manage-memory}@anchor{503e}
@subsection ¿Cómo gestiona Python la memoria?


Los detalles de la administración de memoria de Python dependen de la implementación. La implementación estándar de Python, @ref{796,,CPython}, utiliza el recuento de referencias para detectar objetos inaccesibles, y otro mecanismo para recopilar ciclos de referencia, ejecutando periódicamente un algoritmo de detección de ciclos que busca ciclos inaccesibles y elimina los objetos involucrados. El módulo @ref{60,,gc} proporciona funciones para realizar una recolección de basura, obtener estadísticas de depuración y ajustar los parámetros del recolector.

Other implementations (such as Jython@footnote{https://www.jython.org} or
PyPy@footnote{https://pypy.org}), however, can rely on a different mechanism
such as a full-blown garbage collector.  This difference can cause some
subtle porting problems if your Python code depends on the behavior of the
reference counting implementation.

En algunas implementaciones de Python, el siguiente código (que está bien en CPython) probablemente se quedará sin descriptores de archivo:

@example
for file in very_long_list_of_files:
    f = open(file)
    c = f.read(1)
@end example

De hecho, utilizando el esquema de conteo de referencias y destructor de CPython, cada nueva asignación a @code{f} cierra el archivo anterior. Sin embargo, con un GC tradicional, esos objetos de archivo solo se recopilarán (y cerrarán) a intervalos variables y posiblemente largos.

Si desea escribir código que funcione con cualquier implementación de Python, debe cerrar explícitamente el archivo o utilizar una declaración @ref{673,,with}; esto funcionará independientemente del esquema de administración de memoria:

@example
for file in very_long_list_of_files:
    with open(file) as f:
        c = f.read(1)
@end example

@node ¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?,¿Por qué no se libera toda la memoria cuando sale CPython?,¿Cómo gestiona Python la memoria?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-doesn-t-cpython-use-a-more-traditional-garbage-collection-scheme}@anchor{503f}
@subsection ¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?


Por un lado, esta no es una característica estándar de C y, por lo tanto, no es portátil. (Sí, sabemos acerca de la biblioteca Boehm GC. Tiene fragmentos de código de ensamblador para `la mayoría' de las plataformas comunes, no para todas ellas, y aunque es principalmente transparente, no es completamente transparente; se requieren parches para obtener Python para trabajar con eso)

El GC tradicional también se convierte en un problema cuando Python está integrado en otras aplicaciones. Mientras que en un Python independiente está bien reemplazar el estándar @code{malloc()} y @code{free()} con versiones proporcionadas por la biblioteca GC, una aplicación que incruste Python puede querer tener su `propio' sustituto de @code{malloc()} y @code{free()}, y puede no querer el de Python. En este momento, CPython funciona con todo lo que implementa @code{malloc()} y @code{free()} correctamente.

@node ¿Por qué no se libera toda la memoria cuando sale CPython?,¿Por qué hay tipos de datos separados de tuplas y listas?,¿Por qué CPython no utiliza un esquema de recolección de basura más tradicional?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-isn-t-all-memory-freed-when-cpython-exits}@anchor{5040}
@subsection ¿Por qué no se libera toda la memoria cuando sale CPython?


Los objetos a los que se hace referencia desde los espacios de nombres globales de los módulos de Python no siempre se desasignan cuando Python sale. Esto puede suceder si hay referencias circulares. También hay ciertos bits de memoria asignados por la biblioteca de C que son imposibles de liberar (por ejemplo, una herramienta como Purify se quejará de estos). Python es, sin embargo, agresivo sobre la limpieza de la memoria al salir e intenta destruir cada objeto.

Si desea forzar a Python a eliminar ciertas cosas en la desasignación, use el módulo @ref{d,,atexit} para ejecutar una función que obligará a esas eliminaciones.

@node ¿Por qué hay tipos de datos separados de tuplas y listas?,¿Cómo se implementan las listas en Python?,¿Por qué no se libera toda la memoria cuando sale CPython?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-are-there-separate-tuple-and-list-data-types}@anchor{5041}
@subsection ¿Por qué hay tipos de datos separados de tuplas y listas?


Las listas y las tuplas, si bien son similares en muchos aspectos, generalmente se usan de maneras fundamentalmente diferentes. Las tuplas pueden considerarse similares a los @code{records} de Pascal o a los @code{structs} de C; son pequeñas colecciones de datos relacionados que pueden ser de diferentes tipos que funcionan como un grupo. Por ejemplo, una coordenada cartesiana se representa adecuadamente como una tupla de dos o tres números.

Las listas, por otro lado, son más como matrices en otros lenguajes. Tienden a contener un número variable de objetos, todos los cuales tienen el mismo tipo y que se operan uno por uno. Por ejemplo, @ref{116c,,os.listdir('.')} retorna una lista de cadenas de caracteres que representan los archivos en el directorio actual. Las funciones que operan en esta salida generalmente no se romperían si agregara otro archivo o dos al directorio.

Las tuplas son inmutables, lo que significa que una vez que se ha creado una tupla, no puede reemplazar ninguno de sus elementos con un nuevo valor. Las listas son mutables, lo que significa que siempre puede cambiar los elementos de una lista. Solo los elementos inmutables se pueden usar como claves de diccionario y, por lo tanto, solo las tuplas y no las listas se pueden usar como claves.

@node ¿Cómo se implementan las listas en Python?,¿Cómo se implementan los diccionarios en CPython?,¿Por qué hay tipos de datos separados de tuplas y listas?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design how-are-lists-implemented-in-cpython}@anchor{5042}
@subsection ¿Cómo se implementan las listas en Python?


Las listas de CPython son realmente matrices de longitud variable, no listas enlazadas al estilo Lisp. La implementación utiliza una matriz contigua de referencias a otros objetos y mantiene un puntero a esta matriz y la longitud de la matriz en una estructura de encabezado de lista.

Esto hace que indexar una lista @code{a[i]} una operación cuyo costo es independiente del tamaño de la lista o del valor del índice.

Cuando se añaden o insertan elementos, la matriz de referencias cambia de tamaño. Se aplica cierta inteligencia para mejorar el rendimiento de la adición de elementos repetidamente; cuando la matriz debe crecer, se asigna un espacio extra para que las próximas veces no requieran un cambio de tamaño real.

@node ¿Cómo se implementan los diccionarios en CPython?,¿Por qué las claves del diccionario deben ser inmutables?,¿Cómo se implementan las listas en Python?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design how-are-dictionaries-implemented-in-cpython}@anchor{5043}
@subsection ¿Cómo se implementan los diccionarios en CPython?


Los diccionarios de CPython se implementan como tablas hash redimensionables. En comparación con los árboles B (`B-trees'), esto proporciona un mejor rendimiento para la búsqueda (la operación más común con diferencia) en la mayoría de las circunstancias, y la implementación es más simple.

Dictionaries work by computing a hash code for each key stored in the dictionary
using the @ref{68b,,hash()} built-in function.  The hash code varies widely depending
on the key and a per-process seed; for example, @code{'Python'} could hash to
@code{-539294296} while @code{'python'}, a string that differs by a single bit, could hash
to @code{1142331976}.  The hash code is then used to calculate a location in an
internal array where the value will be stored.  Assuming that you’re storing
keys that all have different hash values, this means that dictionaries take
constant time – `O'(1), in Big-O notation – to retrieve a key.

@node ¿Por qué las claves del diccionario deben ser inmutables?,¿Por qué list sort no retorna la lista ordenada?,¿Cómo se implementan los diccionarios en CPython?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-must-dictionary-keys-be-immutable}@anchor{5044}
@subsection ¿Por qué las claves del diccionario deben ser inmutables?


La implementación de la tabla hash de los diccionarios utiliza un valor hash calculado a partir del valor clave para encontrar la clave. Si la clave fuera un objeto mutable, su valor podría cambiar y, por lo tanto, su hash también podría cambiar. Pero dado que quien cambie el objeto clave no puede decir que se estaba utilizando como clave de diccionario, no puede mover la entrada en el diccionario. Luego, cuando intente buscar el mismo objeto en el diccionario, no se encontrará porque su valor hash es diferente. Si trató de buscar el valor anterior, tampoco lo encontraría, porque el valor del objeto que se encuentra en ese hash bin sería diferente.

Si desea un diccionario indexado con una lista, simplemente convierta la lista a una tupla primero; La función @code{tuple(L)} crea una tupla con las mismas entradas que la lista @code{L}. Las tuplas son inmutables y, por lo tanto, pueden usarse como claves de diccionario.

Algunas soluciones inaceptables que se han propuesto:


@itemize -

@item 
Listas de hash por su dirección (ID de objeto). Esto no funciona porque si construye una nueva lista con el mismo valor, no se encontrará; por ejemplo:

@example
mydict = @{[1, 2]: '12'@}
print(mydict[[1, 2]])
@end example

generaría una excepción @ref{438,,KeyError} porque la identificación del @code{[1, 2]} usado en la segunda línea difiere de la de la primera línea. En otras palabras, las claves del diccionario deben compararse usando @code{==}, no usando @ref{1ee,,is}.

@item 
Hacer una copia cuando use una lista como clave. Esto no funciona porque la lista, al ser un objeto mutable, podría contener una referencia a sí misma, y luego el código de copia se ejecutaría en un bucle infinito.

@item 
Permitir listas como claves pero decirle al usuario que no las modifique. Esto permitiría una clase de errores difíciles de rastrear en los programas cuando olvidó o modificó una lista por accidente. También invalida una invariante importante de diccionarios: cada valor en @code{d.keys()} se puede usar como una clave del diccionario.

@item 
Marcar las listas como de solo lectura una vez que se usan como clave de diccionario. El problema es que no solo el objeto de nivel superior puede cambiar su valor; podría usar una tupla que contiene una lista como clave. Ingresar cualquier cosa como clave en un diccionario requeriría marcar todos los objetos accesibles desde allí como de solo lectura – y nuevamente, los objetos autoreferenciados podrían causar un bucle infinito.
@end itemize

Hay un truco para evitar esto si lo necesita, pero úselo bajo su propio riesgo: Puede envolver una estructura mutable dentro de una instancia de clase que tenga tanto un método @ref{b85,,__eq__()} y un @ref{b86,,__hash__()}. Luego debe asegurarse de que el valor hash para todos los objetos de contenedor que residen en un diccionario (u otra estructura basada en hash) permanezca fijo mientras el objeto está en el diccionario (u otra estructura).

@example
class ListWrapper:
    def __init__(self, the_list):
        self.the_list = the_list

    def __eq__(self, other):
        return self.the_list == other.the_list

    def __hash__(self):
        l = self.the_list
        result = 98767 - len(l)*555
        for i, el in enumerate(l):
            try:
                result = result + (hash(el) % 9999999) * 1001 + i
            except Exception:
                result = (result % 7777777) + i * 333
        return result
@end example

Tenga en cuenta que el cálculo de hash se complica por la posibilidad de que algunos miembros de la lista sean inquebrantables y también por la posibilidad de desbordamiento aritmético.

Además, siempre debe darse el caso de que si @code{o1 == o2} (es decir, @code{o1.__eq__(o2) is True}), entonces @code{hash(o1) == hash(o2)} (es decir, @code{o1.__hash__() == o2.__hash__()}), independientemente de si el objeto está en un diccionario o no. Si no cumple con estas restricciones, los diccionarios y otras estructuras basadas en hash se comportarán mal.

En el caso de @code{ListWrapper}, siempre que el objeto contenedor esté en un diccionario, la lista contenida no debe cambiar para evitar anomalías. No haga esto a menos que esté preparado para pensar detenidamente sobre los requisitos y las consecuencias de no cumplirlos correctamente. Considérese advertido.

@node ¿Por qué list sort no retorna la lista ordenada?,¿Cómo se especifica y aplica una especificación de interfaz en Python?,¿Por qué las claves del diccionario deben ser inmutables?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-doesn-t-list-sort-return-the-sorted-list}@anchor{5045}
@subsection ¿Por qué list.sort() no retorna la lista ordenada?


En situaciones donde el rendimiento es importante, hacer una copia de la lista solo para ordenarlo sería un desperdicio. Por lo tanto, @ref{c57,,list.sort()} ordena la lista en su lugar. Para recordarle ese hecho, no retorna la lista ordenada. De esta manera, no se dejará engañar por sobreescribir accidentalmente una lista cuando necesite una copia ordenada, pero también deberá mantener la versión sin ordenar.

Si desea retornar una nueva lista, use la función incorporada @ref{c56,,sorted()} en su lugar. Esta función crea una nueva lista a partir de un iterativo proporcionado, la ordena y la retorna. Por ejemplo, a continuación se explica cómo iterar sobre las teclas de un diccionario en orden ordenado:

@example
for key in sorted(mydict):
    ...  # do whatever with mydict[key]...
@end example

@node ¿Cómo se especifica y aplica una especificación de interfaz en Python?,¿Por qué no hay goto?,¿Por qué list sort no retorna la lista ordenada?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design how-do-you-specify-and-enforce-an-interface-spec-in-python}@anchor{5046}
@subsection ¿Cómo se especifica y aplica una especificación de interfaz en Python?


Una especificación de interfaz para un módulo proporcionada por lenguajes como C++ y Java describe los prototipos para los métodos y funciones del módulo. Muchos sienten que la aplicación en tiempo de compilación de las especificaciones de la interfaz ayuda en la construcción de grandes programas.

Python 2.6 agrega un módulo @ref{4,,abc} que le permite definir clases base abstractas (ABC). Luego puede usar @ref{4ef,,isinstance()} y @ref{85a,,issubclass()} para verificar si una instancia o una clase implementa un ABC en particular. El módulo @ref{1f,,collections.abc} define un conjunto de ABC útiles como @ref{2253,,Iterable}, @ref{2255,,Container} y @ref{1123,,MutableMapping}.

Para Python, muchas de las ventajas de las especificaciones de interfaz se pueden obtener mediante una disciplina de prueba adecuada para los componentes.

Un buen conjunto de pruebas para un módulo puede proporcionar una prueba de regresión y servir como una especificación de interfaz de módulo y un conjunto de ejemplos. Muchos módulos de Python se pueden ejecutar como un script para proporcionar una simple «autocomprobación». Incluso los módulos que usan interfaces externas complejas a menudo se pueden probar de forma aislada utilizando emulaciones triviales de «stub» de la interfaz externa. Los módulos @ref{3b,,doctest} y @ref{106,,unittest} o marcos de prueba de terceros se pueden utilizar para construir conjuntos de pruebas exhaustivas que ejercitan cada línea de código en un módulo.

Una disciplina de prueba adecuada puede ayudar a construir grandes aplicaciones complejas en Python, así como tener especificaciones de interfaz. De hecho, puede ser mejor porque una especificación de interfaz no puede probar ciertas propiedades de un programa. Por ejemplo, se espera que el método @code{list.append()} agregue nuevos elementos al final de alguna lista interna; una especificación de interfaz no puede probar que su implementación @code{list.append()} realmente haga esto correctamente, pero es trivial verificar esta propiedad en un conjunto de pruebas.

Escribir conjuntos de pruebas es muy útil, y es posible que desee diseñar su código con miras a que sea fácilmente probado. Una técnica cada vez más popular, el desarrollo dirigido por pruebas, requiere escribir partes del conjunto de pruebas primero, antes de escribir el código real. Por supuesto, Python te permite ser descuidado y no escribir casos de prueba.

@node ¿Por qué no hay goto?,¿Por qué las cadenas de caracteres sin formato r-strings no pueden terminar con una barra diagonal inversa?,¿Cómo se especifica y aplica una especificación de interfaz en Python?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-is-there-no-goto}@anchor{5047}
@subsection ¿Por qué no hay goto?


En la década de 1970, la gente se dio cuenta de que el goto irrestricto podía generar un código «espagueti» desordenado que era difícil de entender y revisar. En un lenguaje de alto nivel, también es innecesario siempre que haya formas de bifurcar (en Python, con sentencias @ref{1ec,,if} y expresiones @ref{1ef,,or}, @ref{1e9,,and} e @ref{1ec,,if}/@ref{1ea,,else}) y bucle (con sentencia @ref{1611,,while} y @ref{1eb,,for}, que posiblemente contengan @ref{a5b,,continue} y @ref{b34,,break}).

También se pueden utilizar excepciones para proporcionar un «goto estructurado» que funcione incluso a través de llamadas a funciones.  Muchos creen que las excepciones pueden emular convenientemente todos los usos razonables de las construcciones @code{go} o @code{goto} de C, Fortran y otros lenguajes.  Por ejemplo:

@example
class label(Exception): pass  # declare a label

try:
    ...
    if condition: raise label()  # goto label
    ...
except label:  # where to goto
    pass
...
@end example

Esto no le permite saltar a la mitad de un bucle, pero eso es generalmente considerado un abuso de @code{goto} de todos modos. Utilizar con moderación.

@node ¿Por qué las cadenas de caracteres sin formato r-strings no pueden terminar con una barra diagonal inversa?,¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?,¿Por qué no hay goto?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-can-t-raw-strings-r-strings-end-with-a-backslash}@anchor{5048}
@subsection ¿Por qué las cadenas de caracteres sin formato (r-strings) no pueden terminar con una barra diagonal inversa?


Más precisamente, no pueden terminar con un número impar de barras invertidas: la barra invertida no emparejada al final escapa el carácter de comillas de cierre, dejando una cadena sin terminar.

Las cadenas de caracteres sin formato se diseñaron para facilitar la creación de entradas para procesadores (principalmente motores de expresión regular) que desean realizar su propio procesamiento de escape de barra invertida. Tales procesadores consideran que una barra invertida sin par es un error de todos modos, por lo que las cadenas de caracteres sin procesar no lo permiten. A cambio, le permiten pasar el carácter de comillas de cadena escapándolo con una barra invertida. Estas reglas funcionan bien cuando las cadenas de caracteres r (`r-strings') se usan para el propósito previsto.

Si está intentando construir nombres de ruta de Windows, tenga en cuenta que todas las llamadas al sistema de Windows también aceptan barras diagonales:

@example
f = open("/mydir/file.txt")  # works fine!
@end example

Si está tratando de construir una ruta para un comando de DOS, intente por ejemplo uno de los siguientes:

@example
dir = r"\this\is\my\dos\dir" "\\"
dir = r"\this\is\my\dos\dir\ "[:-1]
dir = "\\this\\is\\my\\dos\\dir\\"
@end example

@node ¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?,¿Por qué los generadores no admiten la declaración with?,¿Por qué las cadenas de caracteres sin formato r-strings no pueden terminar con una barra diagonal inversa?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-doesn-t-python-have-a-with-statement-for-attribute-assignments}@anchor{5049}
@subsection ¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?


Python tiene una sentencia @ref{673,,with} que envuelve la ejecución de un bloque, llamando al código en la entrada y salida del bloque. Algunos lenguajes tienen una construcción que se ve así:

@example
with obj:
    a = 1               # equivalent to obj.a = 1
    total = total + 1   # obj.total = obj.total + 1
@end example

En Python, tal construcción sería ambigua.

Otros lenguajes, como Object Pascal, Delphi y C ++, utilizan tipos estáticos, por lo que es posible saber, de manera inequívoca, a qué miembro se le está asignando. Este es el punto principal de la escritura estática: el compilador `siempre' conoce el alcance de cada variable en tiempo de compilación.

Python usa tipos dinámicos. Es imposible saber de antemano a qué atributo se hará referencia en tiempo de ejecución. Los atributos de los miembros pueden agregarse o eliminarse de los objetos sobre la marcha. Esto hace que sea imposible saber, a partir de una simple lectura, a qué atributo se hace referencia: ¿uno local, uno global o un atributo miembro?

Por ejemplo, tome el siguiente fragmento incompleto:

@example
def foo(a):
    with a:
        print(x)
@end example

El fragmento supone que @code{a} debe tener un atributo miembro llamado @code{x}. Sin embargo, no hay nada en Python que le diga esto al intérprete. ¿Qué debería suceder si @code{a} es, digamos, un número entero? Si hay una variable global llamada @code{x}, ¿se usará dentro del bloque @ref{673,,with}? Como puede ver, la naturaleza dinámica de Python hace que tales elecciones sean mucho más difíciles.

El principal beneficio de @ref{673,,with} y características de lenguaje similares (reducción del volumen del código) puede, sin embargo, lograr fácilmente en Python mediante la asignación. En vez de:

@example
function(args).mydict[index][index].a = 21
function(args).mydict[index][index].b = 42
function(args).mydict[index][index].c = 63
@end example

escribe esto:

@example
ref = function(args).mydict[index][index]
ref.a = 21
ref.b = 42
ref.c = 63
@end example

Esto también tiene el efecto secundario de aumentar la velocidad de ejecución porque los enlaces de nombres se resuelven en tiempo de ejecución en Python, y la segunda versión solo necesita realizar la resolución una vez.

Otras propuestas similares que introducían sintaxis para reducir aún más el volumen del código, como el uso de un “punto inicial”, han sido rechazadas en favor de la claridad (véase @indicateurl{https://mail.python.org/pipermail/python-ideas/2016-May/040070.html}).

@node ¿Por qué los generadores no admiten la declaración with?,¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?,¿Por qué Python no tiene una declaración «with» para las asignaciones de atributos?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-don-t-generators-support-the-with-statement}@anchor{504a}
@subsection ¿Por qué los generadores no admiten la declaración with?


Por razones técnicas, un generador utilizado directamente como gestor de contexto no funcionaría correctamente.  Cuando, como es más común, un generador se utiliza como un iterador ejecutado hasta su finalización, no es necesario cerrar.  Cuando lo esté, envuélvalo como @ref{2940,,contextlib.closing(generator)} en la sentencia @ref{673,,with}.

@node ¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?,¿Por qué Python permite comas al final de las listas y tuplas?,¿Por qué los generadores no admiten la declaración with?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-are-colons-required-for-the-if-while-def-class-statements}@anchor{504b}
@subsection ¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?


Los dos puntos se requieren principalmente para mejorar la legibilidad (uno de los resultados del lenguaje ABC experimental). Considera esto:

@example
if a == b
    print(a)
@end example

versus

@example
if a == b:
    print(a)
@end example

Observe cómo el segundo es un poco más fácil de leer. Observe más a fondo cómo los dos puntos establecen el ejemplo en esta respuesta de preguntas frecuentes; Es un uso estándar en inglés.

Otra razón menor es que los dos puntos facilitan a los editores con resaltado de sintaxis; pueden buscar dos puntos para decidir cuándo se debe aumentar la indentación en lugar de tener que hacer un análisis más elaborado del texto del programa.

@node ¿Por qué Python permite comas al final de las listas y tuplas?,,¿Por qué se requieren dos puntos para las declaraciones if/while/def/class?,Preguntas frecuentes sobre diseño e historia
@anchor{faq/design why-does-python-allow-commas-at-the-end-of-lists-and-tuples}@anchor{504c}
@subsection ¿Por qué Python permite comas al final de las listas y tuplas?


Python le permite agregar una coma final al final de las listas, tuplas y diccionarios:

@example
[1, 2, 3,]
('a', 'b', 'c',)
d = @{
    "A": [1, 5],
    "B": [6, 7],  # last trailing comma is optional but good style
@}
@end example

Hay varias razones para permitir esto.

Cuando tiene un valor literal para una lista, tupla o diccionario distribuido en varias líneas, es más fácil agregar más elementos porque no tiene que recordar agregar una coma a la línea anterior. Las líneas también se pueden reordenar sin crear un error de sintaxis.

La omisión accidental de la coma puede ocasionar errores difíciles de diagnosticar. Por ejemplo:

@example
x = [
  "fee",
  "fie"
  "foo",
  "fum"
]
@end example

Parece que esta lista tiene cuatro elementos, pero en realidad contiene tres: «fee», «fiefoo» y «fum». Agregar siempre la coma evita esta fuente de error.

Permitir la coma final también puede facilitar la generación de código programático.

@node Preguntas frecuentes sobre bibliotecas y extensiones,Extendiendo/Embebiendo FAQ,Preguntas frecuentes sobre diseño e historia,Preguntas más frecuentes de Python
@anchor{faq/library doc}@anchor{504d}@anchor{faq/library library-and-extension-faq}@anchor{504e}
@section Preguntas frecuentes sobre bibliotecas y extensiones



@menu
* Cuestiones generales sobre bibliotecas:: 
* Tareas comunes:: 
* Hilos:: 
* Entrada y salida: Entrada y salida<2>. 
* Programación de Redes/Internet:: 
* Bases de datos:: 
* Matemáticas y numérica:: 

@end menu

@node Cuestiones generales sobre bibliotecas,Tareas comunes,,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library general-library-questions}@anchor{504f}
@subsection Cuestiones generales sobre bibliotecas


@menu
* ¿Cómo encuentro un módulo o aplicación para ejecutar la tarea X?:: 
* ¿Dónde está el fichero fuente math.py (socket.py@comma{} regex.py@comma{} etc.)?: ¿Dónde está el fichero fuente math py socket py regex py etc ?. 
* ¿Cómo hago ejecutable un script Python en Unix?:: 
* ¿Hay un paquete curses/termcap para Python?:: 
* ¿Hay un equivalente en Python al onexit() de C?: ¿Hay un equivalente en Python al onexit de C?. 
* ¿Por qué no funcionan mis manejadores de señales?:: 

@end menu

@node ¿Cómo encuentro un módulo o aplicación para ejecutar la tarea X?,¿Dónde está el fichero fuente math py socket py regex py etc ?,,Cuestiones generales sobre bibliotecas
@anchor{faq/library how-do-i-find-a-module-or-application-to-perform-task-x}@anchor{5050}
@subsubsection ¿Cómo encuentro un módulo o aplicación para ejecutar la tarea X?


Vea la @ref{2b1,,referencia de bibliotecas} para comprobar si existe un módulo relevante en la biblioteca estándar. (Eventualmente aprenderá lo que hay en la biblioteca estándar y será capaz de saltarse este paso.)

Para paquetes de terceros, busque Python Package Index@footnote{https://pypi.org} o pruebe Google@footnote{https://www.google.com} u otro motor de búsqueda web. La búsqueda de «Python» más una palabra clave o dos para su tema de interés generalmente encontrará algo útil.

@node ¿Dónde está el fichero fuente math py socket py regex py etc ?,¿Cómo hago ejecutable un script Python en Unix?,¿Cómo encuentro un módulo o aplicación para ejecutar la tarea X?,Cuestiones generales sobre bibliotecas
@anchor{faq/library where-is-the-math-py-socket-py-regex-py-etc-source-file}@anchor{5051}
@subsubsection ¿Dónde está el fichero fuente `math.py' (`socket.py', `regex.py', etc.)?


Si no puede encontrar un fichero fuente para un módulo, puede ser un módulo incorporado o cargado dinámicamente implementado en C, C++ u otro lenguaje compilado. En este caso puede no disponer del fichero fuente o puede ser algo como @code{mathmodule.c}, en algún lugar de un directorio fuente C (fuera del Python `Path').

Hay (al menos) tres tipos de módulos en Python:


@enumerate 

@item 
módulos escritos en Python (.py);

@item 
módulos escritos en C y cargados dinámicamente (`.dll, .pyd, .so, .sl', etc.);

@item 
módulos escritos en C y enlazados con el intérprete; para obtener una lista de estos, escriba:

@example
import sys
print(sys.builtin_module_names)
@end example
@end enumerate

@node ¿Cómo hago ejecutable un script Python en Unix?,¿Hay un paquete curses/termcap para Python?,¿Dónde está el fichero fuente math py socket py regex py etc ?,Cuestiones generales sobre bibliotecas
@anchor{faq/library how-do-i-make-a-python-script-executable-on-unix}@anchor{5052}
@subsubsection ¿Cómo hago ejecutable un script Python en Unix?


Necesita hacer dos cosas: el modo del fichero del script debe ser ejecutable y la primera línea debe comenzar con @code{#!} seguido de la ruta al intérprete de Python.

Lo primero se hace ejecutando @code{chmod +x scriptfile} o bien @code{chmod 755 scriptfile}.

Lo segundo se puede hacer de distintas maneras. La manera más directa es escribir

@example
#!/usr/local/bin/python
@end example

en la primera línea de su fichero, usando la ruta donde está instalado el intérprete de Python en su plataforma.

Si quiere que el script sea independiente de donde se ubique el intérprete de Python, puede usar el programa @code{env}. Casi todas las variantes de Unix soportan lo siguiente, asumiendo que el intérprete de Python está en un directorio del 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} de usuario:

@example
#!/usr/bin/env python
@end example

`No' haga esto para scripts CGI. La variable 
@geindex PATH
@geindex variables de entorno; PATH
@code{PATH} para scripts CGI es mínima, así que necesita usar la ruta real absoluta al intérprete.

Ocasionalmente, un entorno de usuario está tan lleno que el programa @code{/usr/bin/env} falla; o bien no existe el programa env. En ese caso, puede intentar el siguiente truco (gracias a Alex Rezinsky):

@example
#! /bin/sh
""":"
exec python $0 $@{1+"$@@"@}
"""
@end example

Una pequeña desventaja es que esto define el `__doc__' del script. Sin embargo, puede arreglarlo añadiendo

@example
__doc__ = """...Whatever..."""
@end example

@node ¿Hay un paquete curses/termcap para Python?,¿Hay un equivalente en Python al onexit de C?,¿Cómo hago ejecutable un script Python en Unix?,Cuestiones generales sobre bibliotecas
@anchor{faq/library is-there-a-curses-termcap-package-for-python}@anchor{5053}
@subsubsection ¿Hay un paquete curses/termcap para Python?


@c XXX curses *is* built by default, isn't it?

Para variantes Unix: La distribución estándar de Python viene con un módulo curses en el subdirectorio Modules@footnote{https://github.com/python/cpython/tree/main/Modules}, aunque no está compilado por defecto. (Nótese que esto no está disponible en la distribución Windows — no hay módulo curses para Windows.)

El módulo @ref{2c,,curses} soporta características básicas de cursores así como muchas funciones adicionales de ncurses y cursores SYSV como color, soporte para conjuntos de caracteres alternativos, pads, y soporte para ratón. Esto significa que el módulo no es compatible con sistemas operativos que sólo tienen cursores BSD, pero no parece que ningún sistema operativo actualmente mantenido caiga dentro de esta categoría.

@node ¿Hay un equivalente en Python al onexit de C?,¿Por qué no funcionan mis manejadores de señales?,¿Hay un paquete curses/termcap para Python?,Cuestiones generales sobre bibliotecas
@anchor{faq/library is-there-an-equivalent-to-c-s-onexit-in-python}@anchor{5054}
@subsubsection ¿Hay un equivalente en Python al onexit() de C?


The @ref{d,,atexit} module provides a register function that is similar to C’s
@code{onexit()}.

@node ¿Por qué no funcionan mis manejadores de señales?,,¿Hay un equivalente en Python al onexit de C?,Cuestiones generales sobre bibliotecas
@anchor{faq/library why-don-t-my-signal-handlers-work}@anchor{5055}
@subsubsection ¿Por qué no funcionan mis manejadores de señales?


El problema más común es que el manejador de señales esté declarado con la lista incorrecta de argumentos. Se llama como

@example
handler(signum, frame)
@end example

así que debería declararse con dos argumentos:

@example
def handler(signum, frame):
    ...
@end example

@node Tareas comunes,Hilos,Cuestiones generales sobre bibliotecas,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library common-tasks}@anchor{5056}
@subsection Tareas comunes


@menu
* ¿Cómo pruebo un programa o un componente Python?:: 
* ¿Cómo creo documentación a partir de los docstrings?:: 
* ¿Cómo consigo presionar una única tecla cada vez?:: 

@end menu

@node ¿Cómo pruebo un programa o un componente Python?,¿Cómo creo documentación a partir de los docstrings?,,Tareas comunes
@anchor{faq/library how-do-i-test-a-python-program-or-component}@anchor{5057}
@subsubsection ¿Cómo pruebo un programa o un componente Python?


Python viene con dos `frameworks' de `testing'. El módulo @ref{3b,,doctest} encuentra ejemplos en los docstrings para un módulo y los ejecuta, comparando la salida con la salida esperada especificada en la cadena de documentación.

El módulo @ref{106,,unittest} es un `framework' de `testing' más agradable y modelado sobre los `frameworks' de `testing' de Java y Smalltalk.

Para hacer más fácil el `testing', debería usar un buen diseño modular en su programa. Su programa debería tener casi toda la funcionalidad encapsulada en funciones o en métodos de clases — y esto algunas veces tiene el efecto sorprendente y encantador de que su programa funcione más rápido (porque los accesos a las variables locales son más rápidas que los accesos a las variables globales). Además el programa debería evitar depender de la mutación de variables globales, ya que esto dificulta mucho más hacer el `testing'.

La «lógica global principal» de su programa puede ser tan simple como

@example
if __name__ == "__main__":
    main_logic()
@end example

al final del módulo principal de su programa.

Una vez que su programa esté organizado en una colección manejable de funciones y comportamientos de clases, usted debería escribir funciones de comprobación que ejerciten los comportamientos. Se puede asociar un conjunto de pruebas a cada módulo. Esto suena a mucho trabajo, pero gracias a que Python es tan conciso y flexible, se hace sorprendentemente fácil. Puede codificar de manera mucho más agradable y divertida escribiendo funciones de comprobación en paralelo con el «código de producción», ya que esto facilita encontrar antes errores e incluso fallos de diseño.

Los «módulos de soporte» que no tienen la intención de estar en el módulo principal de un programa pueden incluir un auto `test' del módulo.

@example
if __name__ == "__main__":
    self_test()
@end example

Incluso los programas que interactúan con interfaces externas complejas se pueden comprobar cuando las interfaces externas no están disponibles usando interfaces «simuladas» implementadas en Python.

@node ¿Cómo creo documentación a partir de los docstrings?,¿Cómo consigo presionar una única tecla cada vez?,¿Cómo pruebo un programa o un componente Python?,Tareas comunes
@anchor{faq/library how-do-i-create-documentation-from-doc-strings}@anchor{5058}
@subsubsection ¿Cómo creo documentación a partir de los docstrings?


El módulo @ref{b5,,pydoc} puede crear HTML desde los docstrings existentes en su código fuente Python. Una alternativa para crear documentación API estrictamente desde docstrings es epydoc@footnote{http://epydoc.sourceforge.net/}.  Sphinx@footnote{http://sphinx-doc.org} también puede incluir contenido docstring.

@node ¿Cómo consigo presionar una única tecla cada vez?,,¿Cómo creo documentación a partir de los docstrings?,Tareas comunes
@anchor{faq/library how-do-i-get-a-single-keypress-at-a-time}@anchor{5059}
@subsubsection ¿Cómo consigo presionar una única tecla cada vez?


Para variantes Unix hay varias soluciones. Lo más directo es hacerlo usando cursores, pero curses es un módulo bastante amplio para aprenderlo.

@c XXX this doesn't work out of the box, some IO expert needs to check why
@c 
@c Here's a solution without curses::
@c 
@c import termios, fcntl, sys, os
@c fd = sys.stdin.fileno()
@c 
@c oldterm = termios.tcgetattr(fd)
@c newattr = termios.tcgetattr(fd)
@c newattr[3] = newattr[3] & ~termios.ICANON & ~termios.ECHO
@c termios.tcsetattr(fd, termios.TCSANOW, newattr)
@c 
@c oldflags = fcntl.fcntl(fd, fcntl.F_GETFL)
@c fcntl.fcntl(fd, fcntl.F_SETFL, oldflags | os.O_NONBLOCK)
@c 
@c try:
@c     while True:
@c         try:
@c             c = sys.stdin.read(1)
@c             print("Got character", repr(c))
@c         except OSError:
@c             pass
@c finally:
@c     termios.tcsetattr(fd, termios.TCSAFLUSH, oldterm)
@c     fcntl.fcntl(fd, fcntl.F_SETFL, oldflags)
@c 
@c You need the :mod:`termios` and the :mod:`fcntl` module for any of this to
@c work, and I've only tried it on Linux, though it should work elsewhere.  In
@c this code, characters are read and printed one at a time.
@c 
@c :func:`termios.tcsetattr` turns off stdin's echoing and disables canonical
@c mode.  :func:`fcntl.fnctl` is used to obtain stdin's file descriptor flags
@c and modify them for non-blocking mode.  Since reading stdin when it is empty
@c results in an :exc:`OSError`, this error is caught and ignored.
@c 
@c .. versionchanged:: 3.3
@c    *sys.stdin.read* used to raise :exc:`IOError`. Starting from Python 3.3
@c    :exc:`IOError` is alias for :exc:`OSError`.

@node Hilos,Entrada y salida<2>,Tareas comunes,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library threads}@anchor{505a}
@subsection Hilos


@menu
* ¿Cómo programo usando hilos?:: 
* Ninguno de mis hilos parece funcionar; ¿por qué?: Ninguno de mis hilos parece funcionar ¿por qué?. 
* ¿Cómo puedo dividir trabajo entre un grupo de hilos?:: 
* ¿Qué tipos de mutación de valores globales son thread-safe?:: 
* ¿Podemos deshacernos del Global Interpreter Lock?:: 

@end menu

@node ¿Cómo programo usando hilos?,Ninguno de mis hilos parece funcionar ¿por qué?,,Hilos
@anchor{faq/library how-do-i-program-using-threads}@anchor{505b}
@subsubsection ¿Cómo programo usando hilos?


Asegúrese de usar el módulo @ref{ed,,threading} y no el módulo @ref{2,,_thread}. El módulo @ref{ed,,threading} construye abstracciones convenientes sobre las primitivas de bajo nivel proporcionadas por el módulo @ref{2,,_thread}.

@node Ninguno de mis hilos parece funcionar ¿por qué?,¿Cómo puedo dividir trabajo entre un grupo de hilos?,¿Cómo programo usando hilos?,Hilos
@anchor{faq/library none-of-my-threads-seem-to-run-why}@anchor{505c}
@subsubsection Ninguno de mis hilos parece funcionar: ¿por qué?


Tan pronto como el hilo principal termine, se matan todos los hilos. Su hilo principal está corriendo demasiado rápido, sin dar tiempo a los hilos para hacer algún trabajo.

Una solución sencilla es añadir un `sleep' al final del programa que sea suficientemente largo para que todos los hilos terminen:

@example
import threading, time

def thread_task(name, n):
    for i in range(n):
        print(name, i)

for i in range(10):
    T = threading.Thread(target=thread_task, args=(str(i), i))
    T.start()

time.sleep(10)  # <---------------------------!
@end example

Por ahora (en muchas plataformas) los hilos no corren en paralelo, sino que parece que corren secuencialmente, ¡uno a la vez! La razón es que el planificador de hilos del sistema operativo no inicia un nuevo hilo hasta que el hilo anterior está bloqueado.

Una solución sencilla es añadir un pequeño `sleep' al comienzo de la función run:

@example
def thread_task(name, n):
    time.sleep(0.001)  # <--------------------!
    for i in range(n):
        print(name, i)

for i in range(10):
    T = threading.Thread(target=thread_task, args=(str(i), i))
    T.start()

time.sleep(10)
@end example

En vez de intentar adivinar un valor de retardo adecuado para @ref{73e,,time.sleep()}, es mejor usar algún tipo de mecanismo de semáforo. Una idea es usar el módulo @ref{b6,,queue} para crear un objeto cola, permitiendo que cada hilo añada un `token' a la cola cuando termine, y permitiendo al hilo principal leer tantos tokens de la cola como hilos haya.

@node ¿Cómo puedo dividir trabajo entre un grupo de hilos?,¿Qué tipos de mutación de valores globales son thread-safe?,Ninguno de mis hilos parece funcionar ¿por qué?,Hilos
@anchor{faq/library how-do-i-parcel-out-work-among-a-bunch-of-worker-threads}@anchor{505d}
@subsubsection ¿Cómo puedo dividir trabajo entre un grupo de hilos?


La manera más fácil es usar el nuevo módulo @ref{22,,concurrent.futures}, especialmente el módulo @ref{7dd,,ThreadPoolExecutor}.

O, si quiere tener un control más preciso sobre el algoritmo de despacho, puede escribir su propia lógica manualmente. Use el módulo @ref{b6,,queue} para crear una cola que contenga una lista de trabajos. La clase @ref{13ee,,Queue} mantiene una lista de objetos y tiene un método @code{.put(obj)} que añade elementos a la cola y un método @code{.get()} que los retorna. Esta clase se encargará de los bloqueos necesarios para asegurar que cada trabajo se reparte exactamente una vez.

Aquí hay un ejemplo trivial:

@example
import threading, queue, time

# The worker thread gets jobs off the queue.  When the queue is empty, it
# assumes there will be no more work and exits.
# (Realistically workers will run until terminated.)
def worker():
    print('Running worker')
    time.sleep(0.1)
    while True:
        try:
            arg = q.get(block=False)
        except queue.Empty:
            print('Worker', threading.current_thread(), end=' ')
            print('queue empty')
            break
        else:
            print('Worker', threading.current_thread(), end=' ')
            print('running with argument', arg)
            time.sleep(0.5)

# Create queue
q = queue.Queue()

# Start a pool of 5 workers
for i in range(5):
    t = threading.Thread(target=worker, name='worker %i' % (i+1))
    t.start()

# Begin adding work to the queue
for i in range(50):
    q.put(i)

# Give threads time to run
print('Main thread sleeping')
time.sleep(5)
@end example

Cuando se ejecute, esto producirá la siguiente salida:

@example
Running worker
Running worker
Running worker
Running worker
Running worker
Main thread sleeping
Worker <Thread(worker 1, started 130283832797456)> running with argument 0
Worker <Thread(worker 2, started 130283824404752)> running with argument 1
Worker <Thread(worker 3, started 130283816012048)> running with argument 2
Worker <Thread(worker 4, started 130283807619344)> running with argument 3
Worker <Thread(worker 5, started 130283799226640)> running with argument 4
Worker <Thread(worker 1, started 130283832797456)> running with argument 5
...
@end example

Consulte la documentación del módulo para más detalles; la clase @ref{13ee,,Queue} proporciona una interfaz llena de características.

@node ¿Qué tipos de mutación de valores globales son thread-safe?,¿Podemos deshacernos del Global Interpreter Lock?,¿Cómo puedo dividir trabajo entre un grupo de hilos?,Hilos
@anchor{faq/library what-kinds-of-global-value-mutation-are-thread-safe}@anchor{505e}
@subsubsection ¿Qué tipos de mutación de valores globales son `thread-safe'?


Un @ref{2b5,,global interpreter lock} (GIL) se usa internamente para asegurar que sólo un hilo corre a la vez en la VM de Python. En general, Python ofrece cambiar entre hilos sólo en instrucciones bytecode; la frecuencia con la que cambia se puede fijar vía @ref{9dd,,sys.setswitchinterval()}. Cada instrucción bytecode y por lo tanto, toda la implementación de código C alcanzada por cada instrucción, es atómica desde el punto de vista de un programa Python.

En teoría, esto significa que un informe exacto requiere de un conocimiento exacto de la implementación en bytecode de la PVM. En la práctica, esto significa que las operaciones entre variables compartidas de tipos de datos `built-in' (enteros, listas, diccionarios, etc.) que «parecen atómicas» realmente lo son.

Por ejemplo, las siguientes operaciones son todas atómicas (L, L1, L2 son listas, D, D1, D2 son diccionarios, `x, y' son objetos, `i, j' son enteros):

@example
L.append(x)
L1.extend(L2)
x = L[i]
x = L.pop()
L1[i:j] = L2
L.sort()
x = y
x.field = y
D[x] = y
D1.update(D2)
D.keys()
@end example

Estas no lo son:

@example
i = i+1
L.append(L[-1])
L[i] = L[j]
D[x] = D[x] + 1
@end example

Operations that replace other objects may invoke those other objects”
@ref{1f60,,__del__()} method when their reference count reaches zero, and that can
affect things.  This is especially true for the mass updates to dictionaries and
lists.  When in doubt, use a mutex!

@node ¿Podemos deshacernos del Global Interpreter Lock?,,¿Qué tipos de mutación de valores globales son thread-safe?,Hilos
@anchor{faq/library can-t-we-get-rid-of-the-global-interpreter-lock}@anchor{505f}
@subsubsection ¿Podemos deshacernos del `Global Interpreter Lock'?


El @ref{2b5,,global interpreter lock} (GIL) se percibe a menudo como un obstáculo en el despliegue de Python sobre máquinas servidoras finales de múltiples procesadores, porque un programa Python multihilo efectivamente sólo usa una CPU, debido a la exigencia de que (casi) todo el código Python sólo puede correr mientras el GIL esté activado.

With the approval of 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} work is now underway to remove the GIL from the
CPython implementation of Python.  Initially it will be implemented as an
optional compiler flag when building the interpreter, and so separate
builds will be available with and without the GIL.  Long-term, the hope is
to settle on a single build, once the performance implications of removing the
GIL are fully understood.  Python 3.13 is likely to be the first release
containing this work, although it may not be completely functional in this
release.

The current work to remove the GIL is based on a
fork of Python 3.9 with the GIL removed@footnote{https://github.com/colesbury/nogil}
by Sam Gross.
Prior to that,
in the days of Python 1.5, Greg Stein actually implemented a comprehensive
patch set (the «free threading» patches) that removed the GIL and replaced it
with fine-grained locking.  Adam Olsen did a similar experiment
in his python-safethread@footnote{https://code.google.com/archive/p/python-safethread}
project.  Unfortunately, both of these earlier experiments exhibited a sharp
drop in single-thread
performance (at least 30% slower), due to the amount of fine-grained locking
necessary to compensate for the removal of the GIL.  The Python 3.9 fork
is the first attempt at removing the GIL with an acceptable performance
impact.

The presence of the GIL in current Python releases
doesn’t mean that you can’t make good use of Python on multi-CPU machines!
You just have to be creative with dividing the work up between multiple
`processes' rather than multiple `threads'.  The
@ref{163,,ProcessPoolExecutor} class in the new
@ref{22,,concurrent.futures} module provides an easy way of doing so; the
@ref{94,,multiprocessing} module provides a lower-level API in case you want
more control over dispatching of tasks.

El uso sensato de extensiones C también ayudará; si usa una extensión C para ejecutar una tarea que consume mucho tiempo, la extensión puede liberar al GIL mientras el hilo de ejecución esté en el código C y permite a otros hilos hacer trabajo. Algunos módulos de la biblioteca estándar tales como @ref{132,,zlib} y @ref{68,,hashlib} ya lo hacen.

An alternative approach to reducing the impact of the GIL is
to make the GIL a per-interpreter-state lock rather than truly global.
This was @ref{4e9,,first implemented in Python 3.12} and is
available in the C API. A Python interface to it is expected in Python 3.13.
The main limitation to it at the moment is likely to be 3rd party extension
modules, since these must be written with multiple interpreters in mind in
order to be usable, so many older extension modules will not be usable.

@node Entrada y salida<2>,Programación de Redes/Internet,Hilos,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library input-and-output}@anchor{5060}
@subsection Entrada y salida


@menu
* ¿Cómo borro un fichero? (Y otras preguntas sobre ficheros…): ¿Cómo borro un fichero? Y otras preguntas sobre ficheros…. 
* ¿Cómo copio un fichero?:: 
* ¿Cómo leo (o escribo) datos binarios?: ¿Cómo leo o escribo datos binarios?. 
* No consigo usar os.read() en un pipe creado con os.popen(); ¿por qué?: No consigo usar os read en un pipe creado con os popen ; ¿por qué?. 
* ¿Cómo accedo al puerto serial (RS232)?: ¿Cómo accedo al puerto serial RS232 ?. 
* ¿Por qué al cerrar sys.stdout (stdin@comma{} stderr) realmente no se cierran?: ¿Por qué al cerrar sys stdout stdin stderr realmente no se cierran?. 

@end menu

@node ¿Cómo borro un fichero? Y otras preguntas sobre ficheros…,¿Cómo copio un fichero?,,Entrada y salida<2>
@anchor{faq/library how-do-i-delete-a-file-and-other-file-questions}@anchor{5061}
@subsubsection ¿Cómo borro un fichero? (Y otras preguntas sobre ficheros…)


Use @code{os.remove(filename)} o @code{os.unlink(filename)}; para la documentación, vea el módulo @ref{a1,,os}. Las dos funciones son idénticas; @ref{1168,,unlink()} es simplemente el nombre de la llamada al sistema UNIX para esta función.

Para borrar un directorio, use @ref{1166,,os.rmdir()}; use @ref{37a,,os.mkdir()} para crear uno. @code{os.makedirs(path)} creará cualquier directorio intermedio que no exista en @code{path}. @code{os.removedirs(path)} borrará los directorios intermedios siempre y cuando estén vacíos; si quiere borrar un árbol de directorios completo y sus contenidos, use @ref{1f9,,shutil.rmtree()}.

Para renombrar un fichero, use @code{os.rename(old_path, new_path)}.

Para truncar un fichero, ábralo usando @code{f = open(filename, "rb+")}, y use @code{f.truncate(offset)}; el desplazamiento toma por defecto la posición actual de búsqueda. También existe @code{os.ftruncate(fd, offset)} para ficheros abiertos con @ref{e18,,os.open()},  donde `fd' es el descriptor del fichero (un entero pequeño).

El módulo @ref{c5,,shutil} también contiene distintas funciones para trabajar con ficheros incluyendo @ref{aea,,copyfile()}, @ref{abb,,copytree()} y @ref{1f9,,rmtree()}.

@node ¿Cómo copio un fichero?,¿Cómo leo o escribo datos binarios?,¿Cómo borro un fichero? Y otras preguntas sobre ficheros…,Entrada y salida<2>
@anchor{faq/library how-do-i-copy-a-file}@anchor{5062}
@subsubsection ¿Cómo copio un fichero?


El módulo @ref{c5,,shutil} contiene una función @ref{aea,,copyfile()}. Nótese que en volúmenes de Windows NTFS, no copia los flujos alternativos de datos (ADS)@footnote{https://es.wikipedia.org/wiki/Alternate_Data_Streams} ni las bifurcaciones de recursos (resource forks)@footnote{https://en.wikipedia.org/wiki/Resource_fork} en los volúmenes macOS HFS+, aunque ahora ambos rara vez son utilizados. Además tampoco copia los permisos ni metadatos de los archivos, pero si se usa @ref{aec,,shutil.copy2()} en su lugar, se preservará la mayor parte (aunque no todo).

@node ¿Cómo leo o escribo datos binarios?,No consigo usar os read en un pipe creado con os popen ; ¿por qué?,¿Cómo copio un fichero?,Entrada y salida<2>
@anchor{faq/library how-do-i-read-or-write-binary-data}@anchor{5063}
@subsubsection ¿Cómo leo (o escribo) datos binarios?


Para leer o escribir formatos binarios de datos complejos, es mejor usar el módulo @ref{d5,,struct}. Esto le permite tomar una cadena de texto que contiene datos binarios (normalmente números) y convertirla a objetos de Python; y viceversa.

Por ejemplo, el siguiente código lee de un fichero dos enteros de 2-bytes y uno de 4-bytes en formato `big-endian':

@example
import struct

with open(filename, "rb") as f:
    s = f.read(8)
    x, y, z = struct.unpack(">hhl", s)
@end example

El “>” en la cadena de formato fuerza los datos a `big-endian'; la letra “h” lee un «entero corto» (2 bytes), y “l” lee un «entero largo» (4 bytes) desde la cadena de texto.

Para datos que son más regulares (por ejemplo una lista homogénea de enteros o flotantes), puede también usar el módulo @ref{8,,array}.

@cartouche
@quotation Nota 
Para leer y escribir datos binarios, es obligatorio abrir el fichero en modo binario (aquí, pasando @code{"rb"} a @ref{1be,,open()}). Si, en cambio, usa @code{"r"} (por defecto), el fichero se abrirá en modo texto y @code{f.read()} retornará objetos @ref{237,,str} en vez de objetos @ref{325,,bytes}.
@end quotation
@end cartouche

@node No consigo usar os read en un pipe creado con os popen ; ¿por qué?,¿Cómo accedo al puerto serial RS232 ?,¿Cómo leo o escribo datos binarios?,Entrada y salida<2>
@anchor{faq/library i-can-t-seem-to-use-os-read-on-a-pipe-created-with-os-popen-why}@anchor{5064}
@subsubsection No consigo usar os.read() en un `pipe' creado con os.popen(); ¿por qué?


@ref{e1b,,os.read()} es una función de bajo nivel que recibe un descriptor de fichero, un entero pequeño representando el fichero abierto. @ref{1c5,,os.popen()} crea un objeto fichero de alto nivel, el mismo tipo que retorna la función `built-in' @ref{1be,,open()}. Así, para leer `n' bytes de un `pipe' `p' creado con @ref{1c5,,os.popen()}, necesita usar @code{p.read(n)}.

@node ¿Cómo accedo al puerto serial RS232 ?,¿Por qué al cerrar sys stdout stdin stderr realmente no se cierran?,No consigo usar os read en un pipe creado con os popen ; ¿por qué?,Entrada y salida<2>
@anchor{faq/library how-do-i-access-the-serial-rs232-port}@anchor{5065}
@subsubsection ¿Cómo accedo al puerto serial (RS232)?


Para Win32, OSX, Linux, BSD, Jython, IronPython:

@quotation

pyserial@footnote{https://pypi.org/project/pyserial/}
@end quotation

Para Unix, vea una publicación Usenet de Mitch Chapman:

@quotation

@indicateurl{https://groups.google.com/groups?selm=34A04430.CF9@@ohioee.com}
@end quotation

@node ¿Por qué al cerrar sys stdout stdin stderr realmente no se cierran?,,¿Cómo accedo al puerto serial RS232 ?,Entrada y salida<2>
@anchor{faq/library why-doesn-t-closing-sys-stdout-stdin-stderr-really-close-it}@anchor{5066}
@subsubsection ¿Por qué al cerrar sys.stdout (stdin, stderr) realmente no se cierran?


Los @ref{1230,,objetos de tipo fichero} en Python son una capa de abstracción de alto nivel sobre los descriptores de ficheros de bajo nivel de C.

Para la mayoría de objetos de tipo fichero que cree en Python vía la función `built-in' @ref{1be,,open()}, @code{f.close()} marca el objeto de tipo fichero Python como ya cerrado desde el punto de vista de Python, y también ordena el cierre del descriptor de fichero subyacente en C. Esto además ocurre automáticamente en el destructor de @code{f}, cuando @code{f} se convierte en basura.

Pero `stdin', `stdout' y `stderr' se tratan de manera especial en Python, debido a un estatus especial que también tienen en C. Ejecutando @code{sys.stdout.close()} marca el objeto fichero de nivel Python para ser cerrado, pero `no' cierra el descriptor de fichero asociado en C.

Para cerrar el descriptor de fichero subyacente en C para uno de estos tres casos, debería primero asegurarse de que eso es realmente lo que quiere hacer (por ejemplo, puede confundir módulos de extensión intentado hacer `I/O'). Si es así, use @ref{bfc,,os.close()}:

@example
os.close(stdin.fileno())
os.close(stdout.fileno())
os.close(stderr.fileno())
@end example

O puede usar las constantes numéricas 0, 1 y 2, respectivamente.

@node Programación de Redes/Internet,Bases de datos,Entrada y salida<2>,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library network-internet-programming}@anchor{5067}
@subsection Programación de Redes/Internet


@menu
* ¿Qué herramientas de Python existen para WWW?:: 
* ¿Qué modulo debería usar para generación de HTML?:: 
* ¿Cómo envío correo desde un script Python?:: 
* ¿Cómo evito el bloqueo en el método connect() de un socket?: ¿Cómo evito el bloqueo en el método connect de un socket?. 

@end menu

@node ¿Qué herramientas de Python existen para WWW?,¿Qué modulo debería usar para generación de HTML?,,Programación de Redes/Internet
@anchor{faq/library what-www-tools-are-there-for-python}@anchor{5068}
@subsubsection ¿Qué herramientas de Python existen para WWW?


Vea los capítulos titulados @ref{3879,,Protocolos y soporte de Internet} y @ref{3495,,Manejo de datos de internet} en el manual de referencia de bibliotecas. Python tiene muchos módulos que le ayudarán a construir sistemas web del lado del servidor y del lado del cliente.

@c XXX check if wiki page is still up to date

Paul Boddie mantiene un resumen de los `frameworks' disponibles en @indicateurl{https://wiki.python.org/moin/WebProgramming}.

@node ¿Qué modulo debería usar para generación de HTML?,¿Cómo envío correo desde un script Python?,¿Qué herramientas de Python existen para WWW?,Programación de Redes/Internet
@anchor{faq/library what-module-should-i-use-to-help-with-generating-html}@anchor{5069}
@subsubsection ¿Qué modulo debería usar para generación de HTML?


@c XXX add modern template languages

Puede encontrar una colección de enlaces útiles en la página wiki de programación web@footnote{https://wiki.python.org/moin/WebProgramming}.

@node ¿Cómo envío correo desde un script Python?,¿Cómo evito el bloqueo en el método connect de un socket?,¿Qué modulo debería usar para generación de HTML?,Programación de Redes/Internet
@anchor{faq/library how-do-i-send-mail-from-a-python-script}@anchor{506a}
@subsubsection ¿Cómo envío correo desde un script Python?


Use el módulo  @ref{ca,,smtplib} de la biblioteca estándar.

Aquí hay un remitente simple interactivo que lo usa. Este método trabajará en cualquier máquina que soporte un `listener SMTP'.

@example
import sys, smtplib

fromaddr = input("From: ")
toaddrs  = input("To: ").split(',')
print("Enter message, end with ^D:")
msg = '@w{'}
while True:
    line = sys.stdin.readline()
    if not line:
        break
    msg += line

# The actual mail send
server = smtplib.SMTP('localhost')
server.sendmail(fromaddr, toaddrs, msg)
server.quit()
@end example

Una alternativa sólo para UNIX es usar `sendmail'. La ubicación del programa `sendmail' varía entre sistemas; algunas veces está en @code{/usr/lib/sendmail}, otras veces en @code{/usr/sbin/sendmail}. El manual de `sendmail' le ayudará. Aquí hay un ejemplo de código:

@example
import os

SENDMAIL = "/usr/sbin/sendmail"  # sendmail location
p = os.popen("%s -t -i" % SENDMAIL, "w")
p.write("To: receiver@@example.com\n")
p.write("Subject: test\n")
p.write("\n")  # blank line separating headers from body
p.write("Some text\n")
p.write("some more text\n")
sts = p.close()
if sts != 0:
    print("Sendmail exit status", sts)
@end example

@node ¿Cómo evito el bloqueo en el método connect de un socket?,,¿Cómo envío correo desde un script Python?,Programación de Redes/Internet
@anchor{faq/library how-do-i-avoid-blocking-in-the-connect-method-of-a-socket}@anchor{506b}
@subsubsection ¿Cómo evito el bloqueo en el método `connect()' de un `socket'?


El módulo @ref{c1,,select} es mayoritariamente usado para ayudar con entrada/salida de sockets.

To prevent the TCP connect from blocking, you can set the socket to non-blocking
mode.  Then when you do the @ref{e29,,connect()},
you will either connect immediately
(unlikely) or get an exception that contains the error number as @code{.errno}.
@code{errno.EINPROGRESS} indicates that the connection is in progress, but hasn’t
finished yet.  Different OSes will return different values, so you’re going to
have to check what’s returned on your system.

You can use the @ref{1579,,connect_ex()} method
to avoid creating an exception.
It will just return the errno value.
To poll, you can call @ref{1579,,connect_ex()} again later
– @code{0} or @code{errno.EISCONN} indicate that you’re connected – or you can pass this
socket to @ref{e26,,select.select()} to check if it’s writable.

@cartouche
@quotation Nota 
The @ref{b,,asyncio} module provides a general purpose single-threaded and
concurrent asynchronous library, which can be used for writing non-blocking
network code.
The third-party Twisted@footnote{https://twisted.org/} library is
a popular and feature-rich alternative.
@end quotation
@end cartouche

@node Bases de datos,Matemáticas y numérica,Programación de Redes/Internet,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library databases}@anchor{506c}
@subsection Bases de datos


@menu
* ¿Hay paquetes para interfaces a bases de datos en Python?:: 
* ¿Cómo implementar objetos persistentes en Python?:: 

@end menu

@node ¿Hay paquetes para interfaces a bases de datos en Python?,¿Cómo implementar objetos persistentes en Python?,,Bases de datos
@anchor{faq/library are-there-any-interfaces-to-database-packages-in-python}@anchor{506d}
@subsubsection ¿Hay paquetes para interfaces a bases de datos en Python?


Sí.

Interfaces a `hashes' basados en disco tales como @ref{35,,DBM} y @ref{34,,GDBM} están también incluidas en Python estándar. También hay un módulo @ref{cf,,sqlite3}, que proporciona una base de datos relacional ligera basada en disco.

Está disponible el soporte para la mayoría de bases de datos relacionales. Vea la página wiki de Programación de Bases de datos@footnote{https://wiki.python.org/moin/DatabaseProgramming} para más detalles.

@node ¿Cómo implementar objetos persistentes en Python?,,¿Hay paquetes para interfaces a bases de datos en Python?,Bases de datos
@anchor{faq/library how-do-you-implement-persistent-objects-in-python}@anchor{506e}
@subsubsection ¿Cómo implementar objetos persistentes en Python?


El módulo de biblioteca @ref{a6,,pickle} soluciona esto de una forma muy general (aunque todavía no puede almacenar cosas como ficheros abiertos, sockets o ventanas), y el módulo de biblioteca @ref{c3,,shelve} usa `pickle' y `(g)dbm' para crear mapeos persistentes que contienen objetos arbitrarios Python.

@node Matemáticas y numérica,,Bases de datos,Preguntas frecuentes sobre bibliotecas y extensiones
@anchor{faq/library mathematics-and-numerics}@anchor{506f}
@subsection Matemáticas y numérica


@menu
* ¿Cómo genero números aleatorios en Python?:: 

@end menu

@node ¿Cómo genero números aleatorios en Python?,,,Matemáticas y numérica
@anchor{faq/library how-do-i-generate-random-numbers-in-python}@anchor{5070}
@subsubsection ¿Cómo genero números aleatorios en Python?


El módulo estándar @ref{b8,,random} implementa un generador de números aleatorios. El uso es simple:

@example
import random
random.random()
@end example

This returns a random floating-point number in the range [0, 1).

Hay también muchos otros generadores especializados en este módulo, tales como:


@itemize *

@item 
@code{randrange(a, b)} selecciona un entero en el rango [a, b).

@item 
@code{uniform(a, b)} chooses a floating-point number in the range [a, b).

@item 
@code{normalvariate(mean, sdev)} muestrea una distribución normal (`Gausiana').
@end itemize

Algunas funciones de alto nivel operan directamente sobre secuencias, tales como:


@itemize *

@item 
@code{choice(S)} selecciona un elemento aleatorio de una secuencia dada.

@item 
@code{shuffle(L)} reorganiza una lista in-situ, es decir, la permuta aleatoriamente.
@end itemize

También hay una clase @code{Random} que usted puede instanciar para crear múltiples generadores independientes de valores aleatorios.

@node Extendiendo/Embebiendo FAQ,Preguntas frecuentes sobre Python en Windows,Preguntas frecuentes sobre bibliotecas y extensiones,Preguntas más frecuentes de Python
@anchor{faq/extending doc}@anchor{5071}@anchor{faq/extending extending-embedding-faq}@anchor{5072}
@section Extendiendo/Embebiendo FAQ



@c XXX need review for Python 3.

@menu
* ¿Puedo crear mis propias funciones en C?:: 
* ¿Puedo crear mis propias funciones en C++?:: 
* Escribir en C es difícil; ¿no hay otra alternativa?:: 
* ¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?:: 
* ¿Cómo puedo evaluar una expresión arbitraria de Python desde C?:: 
* ¿Cómo extraigo valores C de un objeto Python?:: 
* ¿Cómo utilizo Py_BuildValue() para crear una tupla de un tamaño arbitrario?: ¿Cómo utilizo Py_BuildValue para crear una tupla de un tamaño arbitrario?. 
* ¿Cómo puedo llamar un método de un objeto desde C?:: 
* ¿Cómo obtengo la salida de PyErr_Print() (o cualquier cosa que se imprime a stdout/stderr)?: ¿Cómo obtengo la salida de PyErr_Print o cualquier cosa que se imprime a stdout/stderr ?. 
* ¿Cómo accedo al módulo escrito en Python desde C?:: 
* ¿Cómo hago una interface a objetos C++ desde Python?:: 
* He agregado un módulo usando el archivo de configuración y el make falla. ¿Porque?: He agregado un módulo usando el archivo de configuración y el make falla ¿Porque?. 
* ¿Cómo puedo depurar una extensión?:: 
* Quiero compilar un módulo Python en mi sistema Linux@comma{} pero me faltan algunos archivos . ¿Por qué?: Quiero compilar un módulo Python en mi sistema Linux pero me faltan algunos archivos ¿Por qué?. 
* ¿Cómo digo «entrada incompleta» desde «entrada inválida»?:: 
* ¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?:: 
* ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python (por ejemplo a través de la herencia)?: ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python por ejemplo a través de la herencia ?. 

@end menu

@node ¿Puedo crear mis propias funciones en C?,¿Puedo crear mis propias funciones en C++?,,Extendiendo/Embebiendo FAQ
@anchor{faq/extending can-i-create-my-own-functions-in-c}@anchor{5073}
@subsection ¿Puedo crear mis propias funciones en C?


Si, puedes crear módulos incorporados que contengan funciones, variables, excepciones y incluso nuevos tipos en C. Esto esta explicado en el documento @ref{1be2,,Ampliación e incrustación del intérprete de Python}.

La mayoría de los libros intermedios o avanzados de Python también tratan este tema.

@node ¿Puedo crear mis propias funciones en C++?,Escribir en C es difícil; ¿no hay otra alternativa?,¿Puedo crear mis propias funciones en C?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending id1}@anchor{5074}
@subsection ¿Puedo crear mis propias funciones en C++?


Si, utilizando las características de compatibilidad encontradas en C++. Coloca @code{extern "C" @{ ... @}} alrededor los archivos incluidos Python y pon @code{extern "C"} antes de cada función que será llamada por el interprete Python. Objetos globales o estáticos C++ con constructores no son una buena idea seguramente.

@node Escribir en C es difícil; ¿no hay otra alternativa?,¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?,¿Puedo crear mis propias funciones en C++?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending c-wrapper-software}@anchor{5075}@anchor{faq/extending writing-c-is-hard-are-there-any-alternatives}@anchor{5076}
@subsection Escribir en C es difícil; ¿no hay otra alternativa?


Hay un número de alternativas a escribir tus propias extensiones C, dependiendo en que estés tratando de hacer.

@c XXX make sure these all work

Cython@footnote{https://cython.org} and its relative Pyrex@footnote{https://www.csse.canterbury.ac.nz/greg.ewing/python/Pyrex/} are compilers
that accept a slightly modified form of Python and generate the corresponding
C code.  Cython and Pyrex make it possible to write an extension without having
to learn Python’s C API.

If you need to interface to some C or C++ library for which no Python extension
currently exists, you can try wrapping the library’s data types and functions
with a tool such as SWIG@footnote{https://www.swig.org}.  SIP@footnote{https://github.com/Python-SIP/sip}, CXX@footnote{https://cxx.sourceforge.net/} Boost@footnote{https://www.boost.org/libs/python/doc/index.html}, or Weave@footnote{https://github.com/scipy/weave} are also
alternatives for wrapping C++ libraries.

@node ¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?,¿Cómo puedo evaluar una expresión arbitraria de Python desde C?,Escribir en C es difícil; ¿no hay otra alternativa?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-can-i-execute-arbitrary-python-statements-from-c}@anchor{5077}
@subsection ¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?


La función de más alto nivel para hacer esto es @ref{489a,,PyRun_SimpleString()} que toma un solo argumento de cadena de caracteres para ser ejecutado en el contexto del módulo @code{__main__} y retorna @code{0} si tiene éxito y @code{-1} cuando ocurre una excepción (incluyendo @ref{150,,SyntaxError}). Si quieres mas control, usa @ref{19e4,,PyRun_String()}; mira la fuente para @ref{489a,,PyRun_SimpleString()} en @code{Python/pythonrun.c}.

@node ¿Cómo puedo evaluar una expresión arbitraria de Python desde C?,¿Cómo extraigo valores C de un objeto Python?,¿Cómo puedo ejecutar declaraciones arbitrarias de Python desde C?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-can-i-evaluate-an-arbitrary-python-expression-from-c}@anchor{5078}
@subsection ¿Cómo puedo evaluar una expresión arbitraria de Python desde C?


Llama a la función @ref{19e4,,PyRun_String()} de la pregunta anterior con el símbolo de comienzo @ref{4a3b,,Py_eval_input}; analiza una expresión, evalúa y retorna su valor.

@node ¿Cómo extraigo valores C de un objeto Python?,¿Cómo utilizo Py_BuildValue para crear una tupla de un tamaño arbitrario?,¿Cómo puedo evaluar una expresión arbitraria de Python desde C?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-extract-c-values-from-a-python-object}@anchor{5079}
@subsection ¿Cómo extraigo valores C de un objeto Python?


That depends on the object’s type.  If it’s a tuple, @ref{49ca,,PyTuple_Size()}
returns its length and @ref{4848,,PyTuple_GetItem()} returns the item at a specified
index.  Lists have similar functions, @ref{1459,,PyList_Size()} and
@ref{450,,PyList_GetItem()}.

For bytes, @ref{48e8,,PyBytes_Size()} returns its length and
@ref{48e2,,PyBytes_AsStringAndSize()} provides a pointer to its value and its
length.  Note that Python bytes objects may contain null bytes so C’s
@code{strlen()} should not be used.

Para testear el tipo de un objeto, primero debes estar seguro que no es @code{NULL}, y luego usa @ref{13f4,,PyBytes_Check()}, @ref{4bab,,PyTuple_Check()}, @ref{4bbb,,PyList_Check()}, etc.

También hay una API de alto nivel para objetos Python que son provistos por la supuestamente llamada interfaz “abstracta” – lee @code{Include/abstract.h} para mas detalles. Permite realizar una interfaz con cualquier tipo de secuencia Python usando llamadas como @ref{49ab,,PySequence_Length()}, @ref{1a5a,,PySequence_GetItem()}, etc. así como otros protocolos útiles como números (@ref{92b,,PyNumber_Index()} et al.) y mapeos en las `PyMapping APIs'.

@node ¿Cómo utilizo Py_BuildValue para crear una tupla de un tamaño arbitrario?,¿Cómo puedo llamar un método de un objeto desde C?,¿Cómo extraigo valores C de un objeto Python?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length}@anchor{507a}
@subsection ¿Cómo utilizo Py_BuildValue() para crear una tupla de un tamaño arbitrario?


No puedes hacerlo. Utiliza a cambio @ref{49c9,,PyTuple_Pack()}.

@node ¿Cómo puedo llamar un método de un objeto desde C?,¿Cómo obtengo la salida de PyErr_Print o cualquier cosa que se imprime a stdout/stderr ?,¿Cómo utilizo Py_BuildValue para crear una tupla de un tamaño arbitrario?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-call-an-object-s-method-from-c}@anchor{507b}
@subsection ¿Cómo puedo llamar un método de un objeto desde C?


Se puede utilizar la función @ref{492,,PyObject_CallMethod()} para llamar a un método arbitrario de un objeto. Los parámetros son el objeto, el nombre del método a llamar, una cadena de caracteres de formato como las usadas con  @ref{940,,Py_BuildValue()}, y los valores de argumento

@example
PyObject *
PyObject_CallMethod(PyObject *object, const char *method_name,
                    const char *arg_format, ...);
@end example

Esto funciona para cualquier objeto que tenga métodos – sean estos incorporados o definidos por el usuario. Eres responsable si eventualmente usas @ref{613,,Py_DECREF()} en el valor de retorno.

Para llamar, por ejemplo, un método «seek» de un objeto archivo con argumentos 10, 0 (considerando que puntero del objeto archivo es «f»):

@example
res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);
if (res == NULL) @{
        ... an exception occurred ...
@}
else @{
        Py_DECREF(res);
@}
@end example

Note que debido a @ref{483d,,PyObject_CallObject()} `siempre' necesita una tupla para la lista de argumento, para llamar una función sin argumentos, deberás pasar «()» para el formato, y para llamar a una función con un solo argumento, encierra el argumento entre paréntesis, por ejemplo «(i)».

@node ¿Cómo obtengo la salida de PyErr_Print o cualquier cosa que se imprime a stdout/stderr ?,¿Cómo accedo al módulo escrito en Python desde C?,¿Cómo puedo llamar un método de un objeto desde C?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr}@anchor{507c}
@subsection ¿Cómo obtengo la salida de PyErr_Print() (o cualquier cosa que se imprime a stdout/stderr)?


En código Python, define un objeto que soporta el método @code{write()}. Asigna este objeto a @ref{b61,,sys.stdout} y @ref{9cc,,sys.stderr}. Llama a print_error, o solo permite que el mecanismo estándar de rastreo funcione. Luego, la salida se hará cuando invoques @code{write()}.

La manera mas fácil de hacer esto es usar la clase @ref{fa9,,io.StringIO}:

@example
>>> import io, sys
>>> sys.stdout = io.StringIO()
>>> print('foo')
>>> print('hello world!')
>>> sys.stderr.write(sys.stdout.getvalue())
foo
hello world!
@end example

Un objeto personalizado para hacer lo mismo se vería así:

@example
>>> import io, sys
>>> class StdoutCatcher(io.TextIOBase):
...     def __init__(self):
...         self.data = []
...     def write(self, stuff):
...         self.data.append(stuff)
...
>>> import sys
>>> sys.stdout = StdoutCatcher()
>>> print('foo')
>>> print('hello world!')
>>> sys.stderr.write('@w{'}.join(sys.stdout.data))
foo
hello world!
@end example

@node ¿Cómo accedo al módulo escrito en Python desde C?,¿Cómo hago una interface a objetos C++ desde Python?,¿Cómo obtengo la salida de PyErr_Print o cualquier cosa que se imprime a stdout/stderr ?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-access-a-module-written-in-python-from-c}@anchor{507d}
@subsection ¿Cómo accedo al módulo escrito en Python desde C?


Puedes obtener un puntero al módulo objeto de esta manera:

@example
module = PyImport_ImportModule("<modulename>");
@end example

Si el módulo todavía no se importó, (por ejemplo aún no esta presente en @ref{1976,,sys.modules}), esto inicializa el módulo, de otra forma simplemente retorna el valor de @code{sys.modules["<modulename>"]}. Nota que no entra el módulo a ningún espacio de nombres (`namespace') –solo asegura que fue inicializado y guardado en @ref{1976,,sys.modules}.

Puedes acceder luego a los atributos del módulo (por ejemplo a cualquier nombre definido en el módulo) de esta forma:

@example
attr = PyObject_GetAttrString(module, "<attrname>");
@end example

También funciona llamar a @ref{1624,,PyObject_SetAttrString()} para asignar a variables en el módulo.

@node ¿Cómo hago una interface a objetos C++ desde Python?,He agregado un módulo usando el archivo de configuración y el make falla ¿Porque?,¿Cómo accedo al módulo escrito en Python desde C?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-interface-to-c-objects-from-python}@anchor{507e}
@subsection ¿Cómo hago una interface a objetos C++ desde Python?


Dependiendo de lo que necesites, hay varias maneras de hacerlo. Para hacerlo manualmente empieza por leer @ref{1be2,,the «Extending and Embedding» document}.Fíjate que para el sistema de tiempo de ejecución Python, no hay una gran diferencia entre C y C++, por lo que la estrategia de construir un nuevo tipo Python alrededor de una estructura de C de tipo puntero, también funcionará para objetos C++.

Para bibliotecas C++, mira @ref{5075,,Escribir en C es difícil; ¿no hay otra alternativa?}.

@node He agregado un módulo usando el archivo de configuración y el make falla ¿Porque?,¿Cómo puedo depurar una extensión?,¿Cómo hago una interface a objetos C++ desde Python?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending i-added-a-module-using-the-setup-file-and-the-make-fails-why}@anchor{507f}
@subsection He agregado un módulo usando el archivo de configuración y el `make' falla. ¿Porque?


La configuración debe terminar en una nueva linea, si esta no está, entonces el proceso `build' falla. (reparar esto requiere algún truco de linea de comandos que puede ser no muy prolijo, y seguramente el error es tan pequeño que no valdrá el esfuerzo.)

@node ¿Cómo puedo depurar una extensión?,Quiero compilar un módulo Python en mi sistema Linux pero me faltan algunos archivos ¿Por qué?,He agregado un módulo usando el archivo de configuración y el make falla ¿Porque?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-debug-an-extension}@anchor{5080}
@subsection ¿Cómo puedo depurar una extensión?


Cuando se usa GDB con extensiones cargadas de forma dinámica, puedes configurar un punto de verificación (`breakpoint') en tu extensión hasta que esta se cargue.

En tu archivo @code{.gdbinit} (o interactivamente), agrega el comando:

@example
br _PyImport_LoadDynamicModule
@end example

Luego, cuando corras GDB:

@example
$ gdb /local/bin/python
gdb) run myscript.py
gdb) continue # repeat until your extension is loaded
gdb) finish   # so that your extension is loaded
gdb) br myfunction.c:50
gdb) continue
@end example

@node Quiero compilar un módulo Python en mi sistema Linux pero me faltan algunos archivos ¿Por qué?,¿Cómo digo «entrada incompleta» desde «entrada inválida»?,¿Cómo puedo depurar una extensión?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why}@anchor{5081}
@subsection Quiero compilar un módulo Python en mi sistema Linux, pero me faltan algunos archivos . ¿Por qué?


Most packaged versions of Python omit some files
required for compiling Python extensions.

For Red Hat, install the python3-devel RPM to get the necessary files.

For Debian, run @code{apt-get install python3-dev}.

@node ¿Cómo digo «entrada incompleta» desde «entrada inválida»?,¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?,Quiero compilar un módulo Python en mi sistema Linux pero me faltan algunos archivos ¿Por qué?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-tell-incomplete-input-from-invalid-input}@anchor{5082}
@subsection ¿Cómo digo «entrada incompleta» desde «entrada inválida»?


A veces quieres emular el comportamiento del interprete interactivo de Python, que te da una continuación del `prompt' cuando la entrada esta incompleta (por ejemplo si comenzaste tu instrucción «if» o no cerraste un paréntesis o triples comillas), pero te da un mensaje de error de sintaxis inmediatamente cuando la entrada es invalida.

En Python puedes usar el módulo @ref{1d,,codeop}, que aproxima el comportamiento del analizador gramatical (`parser') . IDLE usa esto, por ejemplo.

La manera mas fácil de hacerlo en C es llamar a @ref{4a42,,PyRun_InteractiveLoop()} (quizá en un hilo separado) y dejar que el interprete Python gestione la entrada por ti. Puedes también configurar @ref{62a,,PyOS_ReadlineFunctionPointer()} para apuntar a tu función de entrada personalizada.

@node ¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?,¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python por ejemplo a través de la herencia ?,¿Cómo digo «entrada incompleta» desde «entrada inválida»?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual}@anchor{5083}
@subsection ¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?


Para cargar dinámicamente módulos de extensión g++, debes recompilar Python, hacer un nuevo `link' usando g++ (cambia LINKCC en el Python Modules Makefile) y enlaza `link' tu extensión usando g++ (por ejemplo @code{g++ -shared -o mymodule.so mymodule.o}).

@node ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python por ejemplo a través de la herencia ?,,¿Cómo encuentro símbolos g++ __builtin_new o __pure_virtual?,Extendiendo/Embebiendo FAQ
@anchor{faq/extending can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance}@anchor{5084}
@subsection ¿Puedo crear una clase objeto con algunos métodos implementado en C y otros en Python (por ejemplo a través de la herencia)?


Si, puedes heredar de clases integradas como @ref{1f0,,int}, @ref{18e,,list}, @ref{190,,dict}, etc.

The Boost Python Library (BPL, @indicateurl{https://www.boost.org/libs/python/doc/index.html})
provides a way of doing this from C++ (i.e. you can inherit from an extension
class written in C++ using the BPL).

@node Preguntas frecuentes sobre Python en Windows,Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI,Extendiendo/Embebiendo FAQ,Preguntas más frecuentes de Python
@anchor{faq/windows doc}@anchor{5085}@anchor{faq/windows python-on-windows-faq}@anchor{5086}@anchor{faq/windows windows-faq}@anchor{5087}
@section Preguntas frecuentes sobre Python en Windows



@c XXX need review for Python 3.
@c XXX need review for Windows Vista/Seven?

@menu
* ¿Cómo ejecutar un programa Python en Windows?:: 
* ¿Cómo hacer que los scripts de Python sean ejecutables?:: 
* ¿Por qué Python tarda en comenzar?:: 
* ¿Cómo hacer un ejecutable a partir de un script de Python?:: 
* ¿Es un archivo *.pyd lo mismo que una DLL?: ¿Es un archivo * pyd lo mismo que una DLL?. 
* ¿Cómo puedo integrar Python en una aplicación de Windows?:: 
* ¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?:: 
* ¿Cómo verifico una pulsación de tecla sin bloquearla?:: 
* ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0.dll no encontrado?: ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0 dll no encontrado?. 

@end menu

@node ¿Cómo ejecutar un programa Python en Windows?,¿Cómo hacer que los scripts de Python sean ejecutables?,,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows faq-run-program-under-windows}@anchor{5088}@anchor{faq/windows how-do-i-run-a-python-program-under-windows}@anchor{5089}
@subsection ¿Cómo ejecutar un programa Python en Windows?


No es necesariamente una pregunta simple. Si ya está familiarizado con el lanzamiento de programas desde la línea de comandos de Windows, todo parecerá obvio; de lo contrario, es posible que necesite un poco más de orientación.

A menos que esté utilizando algún tipo de entorno de desarrollo, terminará escribiendo comandos de Windows en lo que se denomina «DOS» o «símbolo del sistema de Windows». En general, puede abrir dicha ventana desde su barra de búsqueda buscando `cmd'. Debería poder reconocer cuándo inició dicha ventana porque verá un símbolo del sistema de Windows, que en general se ve así:

@example
C:\>
@end example

La letra puede ser diferente y puede haber otras cosas seguidas, por lo que también puede verse así:

@example
D:\YourName\Projects\Python>
@end example

dependiendo de la configuración de su computadora y de lo que haya hecho recientemente con ella. Una vez que haya abierto esta ventana, está en camino de iniciar los programas de Python.

Tenga en cuenta que sus scripts de Python deben ser procesados por otro programa llamado «intérprete» de Python. El intérprete lee su script, lo compila en `bytecode' y ejecuta el `bytecode' para ejecutar su programa. Entonces, ¿cómo le das tu código Python al intérprete?

Primero, debe asegurarse de que la ventana del símbolo del sistema reconoce la palabra «python» como una instrucción para iniciar el intérprete. Si abrió un símbolo del sistema, escriba el comando @code{py} y luego presione la tecla Enter:

@example
C:\Users\YourName> py
@end example

Debería ver algo como esto:

@example
Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:04:45) [MSC v.1900 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>
@end example

Has comenzado el intérprete en su «modo interactivo». Esto significa que puede ingresar declaraciones o expresiones de Python de forma interactiva para ejecutarlas. Esta es una de las características más poderosas de Python. Puede verificar esto ingresando algunos comandos de su elección y ver los resultado:

@example
>>> print("Hello")
Hello
>>> "Hello" * 3
'HelloHelloHello'
@end example

Muchas personas usan el modo interactivo como una calculadora práctica pero altamente programable. Cuando desee finalizar su sesión interactiva de Python, llame a la función @ref{2191,,exit()} o mantenga presionada la tecla @code{Ctrl} mientras ingresa una @code{Z}, luego presione la tecla «@code{Enter}» para regresar a su símbolo del sistema de Windows.

Es posible que haya notado una nueva entrada en su menú Inicio, como Inicio ‣ Programas ‣ Python 3.x ‣ Python (línea de comando) que hace que vea el mensaje @code{>>>} en una nueva ventana. Si es así, la ventana desaparecerá cuando llame a la función @ref{2191,,exit()} o presione la combinación @code{Ctrl-Z}; Windows ejecuta un comando «python» en la ventana y lo cierra cuando cierra el intérprete.

Ahora que sabemos que se reconoce el comando @code{py}, puede darle su script Python. Debe proporcionar la ruta absoluta o relativa de la secuencia de comandos de Python. Digamos que su script Python se encuentra en su escritorio y se llama @code{hello.py}, y su símbolo del sistema está abierto en su directorio de inicio, por lo que verá algo como:

@example
C:\Users\YourName>
@end example

Entonces, le pedirá al comando @code{py} que le dé su script a Python escribiendo @code{py} seguido de la ruta de su script:

@example
C:\Users\YourName> py Desktop\hello.py
hello
@end example

@node ¿Cómo hacer que los scripts de Python sean ejecutables?,¿Por qué Python tarda en comenzar?,¿Cómo ejecutar un programa Python en Windows?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-do-i-make-python-scripts-executable}@anchor{508a}
@subsection ¿Cómo hacer que los scripts de Python sean ejecutables?


En Windows, el instalador de Python asocia la extensión `.py' con un tipo de archivo `(Python.File)' y un comando que inicia el intérprete (@code{D:\Archivos de programa\Python\python.exe "%1" %*}) . Esto es suficiente para poder ejecutar scripts de Python desde la línea de comandos ingresando “foo.py”. Si desea poder ejecutar los scripts simplemente escribiendo “foo” sin la extensión, debe agregar .py a la variable del entorno PATHEXT.

@node ¿Por qué Python tarda en comenzar?,¿Cómo hacer un ejecutable a partir de un script de Python?,¿Cómo hacer que los scripts de Python sean ejecutables?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows why-does-python-sometimes-take-so-long-to-start}@anchor{508b}
@subsection ¿Por qué Python tarda en comenzar?


Normalmente en Windows, Python se inicia muy rápidamente, pero a veces los informes de error indican que Python de repente comienza a tardar mucho tiempo en iniciarse. Es aún más desconcertante porque Python funcionará correctamente con otros Windows configurados de manera idéntica.

El problema puede provenir de un antivirus mal configurado. Se sabe que algunos antivirus duplican el tiempo de arranque cuando se configuran para verificar todas las lecturas del sistema de archivos. Intente verificar si los antivirus de las dos máquinas están configurados correctamente de manera idéntica. `McAfee' es especialmente problemático cuando se configura para verificar todas las lecturas del sistema de archivos.

@node ¿Cómo hacer un ejecutable a partir de un script de Python?,¿Es un archivo * pyd lo mismo que una DLL?,¿Por qué Python tarda en comenzar?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-do-i-make-an-executable-from-a-python-script}@anchor{508c}
@subsection ¿Cómo hacer un ejecutable a partir de un script de Python?


Vea @ref{4fe4,,¿Cómo puedo crear un binario independiente a partir de un programa Python?} para una lista de herramientas que pueden ser usadas para crear ejecutables.

@node ¿Es un archivo * pyd lo mismo que una DLL?,¿Cómo puedo integrar Python en una aplicación de Windows?,¿Cómo hacer un ejecutable a partir de un script de Python?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows is-a-pyd-file-the-same-as-a-dll}@anchor{508d}
@subsection ¿Es un archivo @code{*.pyd} lo mismo que una DLL?


Sí, los archivos `.pyd' son archivos dll, pero hay algunas diferencias. Si tiene una DLL llamada @code{foo.pyd}, debe tener una función @code{PyInit_foo()}. Luego puede escribir en Python «import foo» y Python buscará el archivo `foo.pyd' (así como `foo.py' y `foo.pyc'); si lo encuentra, intentará llamar a @code{PyInit_foo()} para inicializarlo. No vincules tu .exe con `foo.lib' porque en este caso Windows necesitará la DLL.

Tenga en cuenta que la ruta de búsqueda para `foo.pyd' es PYTHONPATH, es diferente de la que usa Windows para buscar `foo.dll'. Además, `foo.pyd' no necesita estar presente para que su programa se ejecute, mientras que si ha vinculado su programa con una dll, esto es necesario. Por supuesto, `foo.pyd' es necesario si escribes @code{import foo}. En una DLL, el enlace se declara en el código fuente con @code{__declspec(dllexport)}. En un `.pyd', la conexión se define en una lista de funciones disponibles.

@node ¿Cómo puedo integrar Python en una aplicación de Windows?,¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?,¿Es un archivo * pyd lo mismo que una DLL?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-can-i-embed-python-into-a-windows-application}@anchor{508e}
@subsection ¿Cómo puedo integrar Python en una aplicación de Windows?


La integración del intérprete de Python en una aplicación de Windows se puede resumir de la siguiente manera:


@enumerate 

@item 
Do `not' build Python into your .exe file directly.  On Windows, Python must
be a DLL to handle importing modules that are themselves DLL’s.  (This is the
first key undocumented fact.)  Instead, link to @code{python`NN'.dll}; it is
typically installed in @code{C:\Windows\System}.  `NN' is the Python version, a
number such as «33» for Python 3.3.

Puede vincular a Python de dos maneras diferentes. Un enlace en tiempo de carga significa apuntar al archivo @code{python`NN'.lib}, mientras que un enlace en tiempo de ejecución significa apuntar al archivo @code{python`NN'.dll}. (Nota general: el archivo @code{python`NN'.lib} es la llamada «lib de importación» correspondiente para el archivo @code{python`NN'.dll}. Simplemente define enlaces simbólicos para el enlazador).

El enlace en tiempo real simplifica enormemente las opciones de enlace; Todo sucede en el momento de la ejecución. Su código debe cargar el archivo @code{python`NN'.dll} utilizando la rutina de Windows @code{LoadLibraryEx()}. El código también debe usar rutinas de acceso y datos en el archivo @code{python`NN'.dll} (es decir, las API C de Python) usando punteros obtenidos por la rutina de Windows @code{GetProcAddress()}. Las macros pueden hacer que el uso de estos punteros sea transparente para cualquier código C que llame a rutinas en la API C de Python.

@c XXX what about static linking?

@item 
If you use SWIG, it is easy to create a Python «extension module» that will
make the app’s data and methods available to Python.  SWIG will handle just
about all the grungy details for you.  The result is C code that you link
`into' your .exe file (!)  You do `not' have to create a DLL file, and this
also simplifies linking.

@item 
`SWIG' creará una función de inicialización (función en C) cuyo nombre depende del nombre del complemento. Por ejemplo, si el nombre del módulo es leo, la función `init' se llamará `initleo()'. Si está utilizando clases `shadow SWIG', como debería, la función `init' se llamará `initleoc()'. Esto inicializa una clase auxiliar invisible utilizada por la clase `shadow'.

¡La razón por la que puede vincular el código C en el paso 2 en su archivo .exe es que llamar a la función de inicialización es equivalente a importar el módulo a Python! (Este es el segundo hecho clave indocumentado).

@item 
En resumen, puede usar el siguiente código para inicializar el intérprete de Python con su complemento.

@example
#include <Python.h>
...
Py_Initialize();  // Initialize Python.
initmyAppc();  // Initialize (import) the helper class.
PyRun_SimpleString("import myApp");  // Import the shadow class.
@end example

@item 
Hay dos problemas con la API de Python C que aparecerán si utiliza un compilador que no sea `MSVC', el compilador utilizado para construir `pythonNN.dll'.

Problem 1: The so-called «Very High Level» functions that take @code{FILE *}
arguments will not work in a multi-compiler environment because each
compiler’s notion of a @code{struct FILE} will be different.  From an implementation
standpoint these are very low level functions.

Problema 2: `SWIG' genera el siguiente código al generar contenedores para cancelar las funciones:

@example
Py_INCREF(Py_None);
_resultobj = Py_None;
return _resultobj;
@end example

Por desgracia, `Py_None' es una macro que se desarrolla con referencia a una estructura de datos compleja llamada `_Py_NoneStruct' dentro de `pythonNN.dll'. Nuevamente, este código fallará en un entorno de múltiples compiladores. Reemplace este código con:

@example
return Py_BuildValue("");
@end example

Es posible utilizar el comando `SWIG' @code{%typemap} para realizar el cambio automáticamente, aunque no he logrado que funcione (soy un principiante con `SWIG').

@item 
Usar una secuencia de comandos de shell Python para crear una ventana de intérprete de Python desde su aplicación de Windows no es una buena idea; la ventana resultante será independiente del sistema de ventanas de su aplicación. Usted (o la clase `wxPythonWindow') debería crear una ventana de intérprete «nativa». Es fácil conectar esta ventana al intérprete de Python. Puede redirigir la entrada/salida de Python a cualquier objeto que admita lectura y escritura, por lo que todo lo que necesita es un objeto de Python (definido en su complemento) que contenga los métodos de `read()' y `write()'.
@end enumerate

@node ¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?,¿Cómo verifico una pulsación de tecla sin bloquearla?,¿Cómo puedo integrar Python en una aplicación de Windows?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-do-i-keep-editors-from-inserting-tabs-into-my-python-source}@anchor{508f}
@subsection ¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?


Las preguntas frecuentes no recomiendan el uso de pestañas y la guía de estilo de Python, 
@geindex Python Enhancement Proposals; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, recomienda el uso de 4 espacios para distribuir el código de Python. Este es también el modo predeterminado de Emacs con Python.

Sea cual sea su editor, mezclar pestañas y espacios es una mala idea. `MSVC' no es diferente en este aspecto, y se puede configurar fácilmente para usar espacios: vaya a Tools ‣ Options ‣ Tabs, y para el tipo de archivo «Default», debe establecer «Tab size» and «Indent size» en 4, luego seleccione Insertar espacios.

Python lanzará los errores @ref{841,,IndentationError} o @ref{5e6,,TabError} si una combinación de tabulación y sangría es problemática al comienzo de la línea. También puede usar el módulo @ref{dd,,tabnanny} para detectar estos errores.

@node ¿Cómo verifico una pulsación de tecla sin bloquearla?,¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0 dll no encontrado?,¿Cómo puedo evitar que mi editor inserte pestañas en mi archivo fuente de Python?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-do-i-check-for-a-keypress-without-blocking}@anchor{5090}
@subsection ¿Cómo verifico una pulsación de tecla sin bloquearla?


Use el módulo @ref{93,,msvcrt}. Es una extensión estándar específica de Windows, que define una función @code{kbhit()} que verifica si se ha presionado una tecla, y @code{getch()} que recupera el carácter sin mostrarlo.

@node ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0 dll no encontrado?,,¿Cómo verifico una pulsación de tecla sin bloquearla?,Preguntas frecuentes sobre Python en Windows
@anchor{faq/windows how-do-i-solve-the-missing-api-ms-win-crt-runtime-l1-1-0-dll-error}@anchor{5091}
@subsection ¿Cómo resuelvo el error de api-ms-win-crt-runtime-l1-1-0.dll no encontrado?


Esto puede ocurrir en Python 3.5 y posteriores usando Windows 8.1 o anteriores sin que todas las actualizaciones hayan sido instaladas. Primero asegúrese que su sistema operativo sea compatible y esté actualizado, y si eso no resuelve el problema, visite la Página de soporte de Microsoft@footnote{https://support.microsoft.com/en-us/help/3118401/} para obtener orientación sobre como instalar manualmente la actualización de C Runtime.

@node Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI,«¿Por qué está Python instalado en mi ordenador?» FAQ,Preguntas frecuentes sobre Python en Windows,Preguntas más frecuentes de Python
@anchor{faq/gui doc}@anchor{5092}@anchor{faq/gui graphic-user-interface-faq}@anchor{5093}
@section Preguntas frecuentes sobre la Interfaz Gráfica de Usuario (`GUI')



@c XXX need review for Python 3.

@menu
* Preguntas generales de la GUI:: 
* ¿Qué conjuntos de herramientas de GUI existen para Python?:: 
* Preguntas de Tkinter:: 

@end menu

@node Preguntas generales de la GUI,¿Qué conjuntos de herramientas de GUI existen para Python?,,Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI
@anchor{faq/gui general-gui-questions}@anchor{5094}
@subsection Preguntas generales de la GUI


@node ¿Qué conjuntos de herramientas de GUI existen para Python?,Preguntas de Tkinter,Preguntas generales de la GUI,Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI
@anchor{faq/gui what-gui-toolkits-exist-for-python}@anchor{5095}
@subsection ¿Qué conjuntos de herramientas de GUI existen para Python?


Los empaquetados estándar de Python incluyen una interfaz orientada a objetos para el conjunto de widgets de Tcl/Tk, llamada @ref{3d65,,tkinter}. Esta es probablemente la más fácil de instalar (ya que viene incluida con la mayoría de distribuciones binarias@footnote{https://www.python.org/downloads/} de Python) y usar. Para obtener más información sobre Tk, incluyendo referencias a la fuente, ver la Página de inicio Tcl/Tk@footnote{https://www.tcl.tk}. Tcl/Tk es totalmente portable a macOS, Windows y plataformas Unix.

Dependiendo de a que plataforma(s) estés apuntando, hay también múltiples alternativas. Una lista de conjuntos de herramientas multiplataforma@footnote{https://wiki.python.org/moin/GuiProgramming#Cross-Platform_Frameworks} y de plataforma específica@footnote{https://wiki.python.org/moin/GuiProgramming#Platform-specific_Frameworks} puede ser encontrada en la wiki de Python.

@node Preguntas de Tkinter,,¿Qué conjuntos de herramientas de GUI existen para Python?,Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI
@anchor{faq/gui tkinter-questions}@anchor{5096}
@subsection Preguntas de Tkinter


@menu
* ¿Cómo congelo las aplicaciones de Tkinter?:: 
* ¿Puedo tener eventos Tk manejados mientras espero por I/O?:: 
* No puedo hacer que los atajos de teclado funcionen en Tkinter; ¿por qué?: No puedo hacer que los atajos de teclado funcionen en Tkinter ¿por qué?. 

@end menu

@node ¿Cómo congelo las aplicaciones de Tkinter?,¿Puedo tener eventos Tk manejados mientras espero por I/O?,,Preguntas de Tkinter
@anchor{faq/gui how-do-i-freeze-tkinter-applications}@anchor{5097}
@subsubsection ¿Cómo congelo las aplicaciones de Tkinter?


Freeze es una herramienta para crear aplicaciones independientes. Al congelar aplicaciones Tkinter, las aplicaciones no serán realmente independientes, ya que la aplicación seguirá necesitando las bibliotecas Tcl y Tk.

One solution is to ship the application with the Tcl and Tk libraries, and point
to them at run-time using the @code{TCL_LIBRARY} and @code{TK_LIBRARY}
environment variables.

Various third-party freeze libraries such as py2exe and cx_Freeze have
handling for Tkinter applications built-in.

@node ¿Puedo tener eventos Tk manejados mientras espero por I/O?,No puedo hacer que los atajos de teclado funcionen en Tkinter ¿por qué?,¿Cómo congelo las aplicaciones de Tkinter?,Preguntas de Tkinter
@anchor{faq/gui can-i-have-tk-events-handled-while-waiting-for-i-o}@anchor{5098}
@subsubsection ¿Puedo tener eventos Tk manejados mientras espero por `I/O'?


On platforms other than Windows, yes, and you don’t even
need threads!  But you’ll have to restructure your I/O
code a bit.  Tk has the equivalent of Xt’s @code{XtAddInput()} call, which allows you
to register a callback function which will be called from the Tk mainloop when
I/O is possible on a file descriptor.  See @ref{3d82,,Gestor de archivos}.

@node No puedo hacer que los atajos de teclado funcionen en Tkinter ¿por qué?,,¿Puedo tener eventos Tk manejados mientras espero por I/O?,Preguntas de Tkinter
@anchor{faq/gui i-can-t-get-key-bindings-to-work-in-tkinter-why}@anchor{5099}
@subsubsection No puedo hacer que los atajos de teclado funcionen en Tkinter: ¿por qué?


An often-heard complaint is that event handlers @ref{3d7d,,bound}
to events with the @code{bind()} method
don’t get handled even when the appropriate key is pressed.

La causa más común es que el widget al que se aplica el atajo no tiene enfoque de teclado. Consulte la documentación de Tk para el comando de `focus'. Por lo general, un `widget' recibe el foco del teclado haciendo clic en él (pero no para las etiquetas; consulte la opción `takefocus').

@node «¿Por qué está Python instalado en mi ordenador?» FAQ,,Preguntas frecuentes sobre la Interfaz Gráfica de Usuario GUI,Preguntas más frecuentes de Python
@anchor{faq/installed doc}@anchor{509a}@anchor{faq/installed why-is-python-installed-on-my-computer-faq}@anchor{509b}
@section «¿Por qué está Python instalado en mi ordenador?» FAQ


@menu
* ¿Qué es Python?: ¿Qué es Python?<2>. 
* ¿Por qué Python está instalado en mi máquina?:: 
* ¿Puedo eliminar Python?:: 

@end menu

@node ¿Qué es Python?<2>,¿Por qué Python está instalado en mi máquina?,,«¿Por qué está Python instalado en mi ordenador?» FAQ
@anchor{faq/installed what-is-python}@anchor{509c}
@subsection ¿Qué es Python?


Python es un lenguaje de programación.  Se usa para muchas aplicaciones diferentes. Se utiliza en algunas escuelas secundarias y universidades como un lenguaje de programación introductorio porque Python es fácil de aprender, pero también es utilizado por desarrolladores de software profesionales en lugares como Google, NASA, y Lucasfilm Ltd.

Si desea aprender más sobre Python, comience con la Guía del principiante de Python@footnote{https://wiki.python.org/moin/BeginnersGuide}.

@node ¿Por qué Python está instalado en mi máquina?,¿Puedo eliminar Python?,¿Qué es Python?<2>,«¿Por qué está Python instalado en mi ordenador?» FAQ
@anchor{faq/installed why-is-python-installed-on-my-machine}@anchor{509d}
@subsection ¿Por qué Python está instalado en mi máquina?


Si encuentras Python instalado en tu sistema pero no recuerdas haberlo instalado, hay varias maneras posibles en las que podría haber llegado ahí.


@itemize *

@item 
Tal vez otro usuario de la computadora quiso aprender a programar y la instaló.

@item 
Una aplicación de terceros instalada en la máquina podría haber sido escrita en Python e incluir una instalación de Python.  Hay muchas aplicaciones de este tipo, desde programas GUI hasta servidores de red y scripts administrativos.

@item 
Algunas máquinas Windows también tienen Python instalado.  Al momento de escribir este artículo, sabemos que las computadoras de Hewlett-Packard y Compaq incluyen Python.  Aparentemente algunas de las herramientas administrativas de HP/Compaq están escritas en Python.

@item 
Muchos sistemas operativos compatibles con Unix, como macOS y algunas distribuciones de Linux, tienen Python instalado de forma predeterminada; está incluido en la instalación básica.
@end itemize

@node ¿Puedo eliminar Python?,,¿Por qué Python está instalado en mi máquina?,«¿Por qué está Python instalado en mi ordenador?» FAQ
@anchor{faq/installed can-i-delete-python}@anchor{509e}
@subsection ¿Puedo eliminar Python?


Eso depende de dónde vino Python.

Si alguien lo instaló deliberadamente, puede quitarlo sin dañar nada.  En Windows, utilice el icono Agregar o quitar programas en el Panel de control.

Si Python fue instalado por una aplicación de terceros, también puede eliminarlo, pero esa aplicación ya no funcionará.  Deberías usar el desinstalador de esa aplicación en lugar de eliminar Python directamente.

Si Python vino con su sistema operativo, no se recomienda quitarlo.  Si lo eliminas, las herramientas escritas en Python ya no funcionarán, y algunas de ellas pueden ser importantes para ti.  Reinstalar todo el sistema sería entonces necesario para arreglar las cosas de nuevo.

@node Deprecations,Glosario,Preguntas más frecuentes de Python,Top
@anchor{deprecations/index doc}@anchor{509f}@anchor{deprecations/index deprecations}@anchor{50a0}
@chapter Deprecations


@menu
* Pending removal in Python 3.15: Pending removal in Python 3 15<7>. 
* Pending removal in Python 3.16: Pending removal in Python 3 16<4>. 
* Pending removal in future versions: Pending removal in future versions<7>. 
* C API deprecations:: 

@end menu

@node Pending removal in Python 3 15<7>,Pending removal in Python 3 16<4>,,Deprecations
@anchor{deprecations/index pending-removal-in-python-3-15}@anchor{50a1}
@section Pending removal in Python 3.15



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1cb,,__cached__} on a module while
failing to set @ref{1cc,,__spec__.cached}
is deprecated. In Python 3.15, @code{__cached__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
Setting @ref{1cd,,__package__} on a module while
failing to set @ref{1ce,,__spec__.parent}
is deprecated. In Python 3.15, @code{__package__} will cease to be set or
take into consideration by the import system or standard library. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2b,,ctypes}:


@itemize *

@item 
The undocumented @code{ctypes.SetPointerType()} function
has been deprecated since Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
The obsolete and rarely used @ref{1cf,,CGIHTTPRequestHandler}
has been deprecated since Python 3.13.
No direct replacement exists.
`Anything' is better than CGI to interface
a web server with a request handler.

@item 
The @code{--cgi} flag to the @code{python -m http.server}
command-line interface has been deprecated since Python 3.13.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
The @ref{1d0,,getdefaultlocale()} function
has been deprecated since Python 3.11.
Its removal was originally planned for Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}),
but has been postponed to Python 3.15.
Use @ref{1d1,,getlocale()}, @ref{1d2,,setlocale()},
and @ref{1d3,,getencoding()} instead.
(Contributed by Hugo van Kemenade in gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{1d4,,PurePath.is_reserved()}
has been deprecated since Python 3.13.
Use @ref{1d5,,os.path.isreserved()} to detect reserved paths on Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{1d6,,java_ver()} has been deprecated since Python 3.13.
This function is only useful for Jython support, has a confusing API,
and is largely untested.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{1d7,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the  Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{1d8,,types.CodeType}: Accessing @ref{1d9,,co_lnotab} was
deprecated in 
@geindex Python Enhancement Proposals; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}
since 3.10 and was planned to be removed in 3.12,
but it only got a proper @ref{1da,,DeprecationWarning} in 3.12.
May be removed in 3.15.
(Contributed by Nikita Sobolev in gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
The undocumented keyword argument syntax for creating
@ref{1db,,NamedTuple} classes
(for example, @code{Point = NamedTuple("Point", x=int, y=int)})
has been deprecated since Python 3.13.
Use the class-based syntax or the functional syntax instead.

@item 
The @ref{1dc,,typing.no_type_check_decorator()} decorator function
has been deprecated since Python 3.13.
After eight years in the @ref{104,,typing} module,
it has yet to be supported by any major type checker.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
The @ref{1dd,,getmark()}, @code{setmark()},
and @ref{1de,,getmarkers()} methods of
the @ref{1df,,Wave_read} and @ref{1e0,,Wave_write} classes
have been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in Python 3 16<4>,Pending removal in future versions<7>,Pending removal in Python 3 15<7>,Deprecations
@anchor{deprecations/index pending-removal-in-python-3-16}@anchor{50a2}
@section Pending removal in Python 3.16



@itemize *

@item 
The import system:


@itemize *

@item 
Setting @ref{1e2,,__loader__} on a module while
failing to set @ref{1e3,,__spec__.loader}
is deprecated. In Python 3.16, @code{__loader__} will cease to be set or
taken into consideration by the import system or the standard library.
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
The @code{'u'} format code (@code{wchar_t})
has been deprecated in documentation since Python 3.3
and at runtime since Python 3.13.
Use the @code{'w'} format code (@ref{1e4,,Py_UCS4})
for Unicode characters instead.
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} is deprecated
and will be removed in Python 3.16,
use @ref{1c3,,inspect.iscoroutinefunction()} instead.
(Contributed by Jiahao Li and Kumar Aditya in gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
Bitwise inversion on boolean types, @code{~True} or @code{~False}
has been deprecated since Python 3.12,
as it produces surprising and unintuitive results (@code{-2} and @code{-1}).
Use @code{not x} instead for the logical negation of a Boolean.
In the rare case that you need the bitwise inversion of
the underlying integer, convert to @code{int} explicitly (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
The @code{ExecError} exception
has been deprecated since Python 3.14.
It has not been used by any function in @code{shutil} since Python 3.4,
and is now an alias of @ref{1e5,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
The @ref{1c7,,Class.get_methods} method
has been deprecated since Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
The @ref{1e6,,_enablelegacywindowsfsencoding()} function
has been deprecated since Python 3.13.
Use the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variables de entorno; PYTHONLEGACYWINDOWSFSENCODING
@ref{1e7,,PYTHONLEGACYWINDOWSFSENCODING} environment variable instead.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
The undocumented and unused @code{TarFile.tarfile} attribute
has been deprecated since Python 3.13.
@end itemize
@end itemize

@node Pending removal in future versions<7>,C API deprecations,Pending removal in Python 3 16<4>,Deprecations
@anchor{deprecations/index pending-removal-in-future-versions}@anchor{50a3}
@section Pending removal in future versions


The following APIs will be removed in the future,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
Nesting argument groups and nesting mutually exclusive
groups are deprecated.

@item 
Passing the undocumented keyword argument `prefix_chars' to
@ref{1c1,,add_argument_group()} is now
deprecated.

@item 
The @ref{1c2,,argparse.FileType} type converter is deprecated.
@end itemize

@item 
@ref{8,,array}’s @code{'u'} format code (gh-57281@footnote{https://github.com/python/cpython/issues/57281})

@item 
@ref{13,,builtins}:


@itemize *

@item 
@code{bool(NotImplemented)}.

@item 
Generators: @code{throw(type, exc, tb)} and @code{athrow(type, exc, tb)}
signature is deprecated: use @code{throw(exc)} and @code{athrow(exc)} instead,
the single argument signature.

@item 
Currently Python accepts numeric literals immediately followed by keywords,
for example @code{0in x}, @code{1or x}, @code{0if 1else 2}.  It allows confusing and
ambiguous expressions like @code{[0x1for x in y]} (which can be interpreted as
@code{[0x1 for x in y]} or @code{[0x1f or x in y]}).  A syntax warning is raised
if the numeric literal is immediately followed by one of keywords
@ref{1e9,,and}, @ref{1ea,,else}, @ref{1eb,,for}, @ref{1ec,,if},
@ref{1ed,,in}, @ref{1ee,,is} and @ref{1ef,,or}.  In a future release it
will be changed to a syntax error. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Support for @code{__index__()} and @code{__int__()} method returning non-int type:
these methods will be required to return an instance of a strict subclass of
@ref{1f0,,int}.

@item 
Support for @code{__float__()} method returning a strict subclass of
@ref{153,,float}: these methods will be required to return an instance of
@ref{153,,float}.

@item 
Support for @code{__complex__()} method returning a strict subclass of
@ref{154,,complex}: these methods will be required to return an instance of
@ref{154,,complex}.

@item 
Delegation of @code{int()} to @code{__trunc__()} method.

@item 
Passing a complex number as the `real' or `imag' argument in the
@ref{154,,complex()} constructor is now deprecated; it should only be passed
as a single positional argument.
(Contributed by Serhiy Storchaka in gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} and @code{calendar.February} constants are
deprecated and replaced by @ref{1f1,,calendar.JANUARY} and
@ref{1f2,,calendar.FEBRUARY}.
(Contributed by Prince Roshan in gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1d9,,codeobject.co_lnotab}: use the @ref{1f3,,codeobject.co_lines()} method
instead.

@item 
@ref{31,,datetime}:


@itemize *

@item 
@ref{1f4,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{1f5,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: Plural value must be an integer.

@item 
@ref{77,,importlib}:


@itemize *

@item 
@code{load_module()} method: use @code{exec_module()} instead.

@item 
@ref{1f6,,cache_from_source()} `debug_override' parameter is
deprecated: use the `optimization' parameter instead.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} tuple interface.

@item 
Implicit @code{None} on return values.
@end itemize

@item 
@ref{87,,logging}: the @code{warn()} method has been deprecated
since Python 3.3, use @ref{1f7,,warning()} instead.

@item 
@ref{8b,,mailbox}: Use of StringIO input and text mode is deprecated, use
BytesIO and binary mode instead.

@item 
@ref{a1,,os}: Calling @ref{1f8,,os.register_at_fork()} in multi-threaded process.

@item 
@code{pydoc.ErrorDuringImport}: A tuple value for `exc_info' parameter is
deprecated, use an exception instance.

@item 
@ref{b9,,re}: More strict rules are now applied for numerical group references
and group names in regular expressions.  Only sequence of ASCII digits is now
accepted as a numerical reference.  The group name in bytes patterns and
replacement strings can now only contain ASCII letters and digits and
underscore.
(Contributed by Serhiy Storchaka in gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
@code{sre_compile}, @code{sre_constants} and @code{sre_parse} modules.

@item 
@ref{c5,,shutil}: @ref{1f9,,rmtree()}”s `onerror' parameter is deprecated in
Python 3.12; use the `onexc' parameter instead.

@item 
@ref{d0,,ssl} options and protocols:


@itemize *

@item 
@ref{1fa,,ssl.SSLContext} without protocol argument is deprecated.

@item 
@ref{1fa,,ssl.SSLContext}: @ref{1fb,,set_npn_protocols()} and
@code{selected_npn_protocol()} are deprecated: use ALPN
instead.

@item 
@code{ssl.OP_NO_SSL*} options

@item 
@code{ssl.OP_NO_TLS*} options

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{1fc,,sysconfig.is_python_build()} `check_home' parameter is deprecated and
ignored.

@item 
@ref{ed,,threading} methods:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{1fd,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{1fe,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{1ff,,threading.Thread.setDaemon()}:
use @ref{200,,threading.Thread.daemon} attribute.

@item 
@code{threading.Thread.getName()}, @ref{201,,threading.Thread.setName()}:
use @ref{202,,threading.Thread.name} attribute.

@item 
@code{threading.currentThread()}: use @ref{203,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{204,,threading.active_count()}.
@end itemize

@item 
@ref{205,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{206,,unittest.IsolatedAsyncioTestCase}: it is deprecated to return a value
that is not @code{None} from a test case.

@item 
@ref{10a,,urllib.parse} deprecated functions: @ref{207,,urlparse()} instead


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{10b,,urllib.request}: @ref{208,,URLopener} and
@ref{209,,FancyURLopener} style of invoking requests is
deprecated. Use newer @ref{20a,,urlopen()} functions and methods.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} should not do partial
writes.

@item 
@ref{125,,xml.etree.ElementTree}: Testing the truth value of an
@ref{20b,,Element} is deprecated. In a future release it
will always return @code{True}. Prefer explicit @code{len(elem)} or
@code{elem is not None} tests instead.

@item 
@ref{20c,,zipimport.zipimporter.load_module()} is deprecated:
use @ref{20d,,exec_module()} instead.
@end itemize

@node C API deprecations,,Pending removal in future versions<7>,Deprecations
@anchor{deprecations/index c-api-deprecations}@anchor{50a4}
@section C API deprecations


@menu
* Pending removal in Python 3.15: Pending removal in Python 3 15<8>. 
* Pending removal in future versions: Pending removal in future versions<8>. 

@end menu

@node Pending removal in Python 3 15<8>,Pending removal in future versions<8>,,C API deprecations
@anchor{deprecations/index id1}@anchor{50a5}
@subsection Pending removal in Python 3.15



@itemize *

@item 
The bundled copy of @code{libmpdecimal}.

@item 
The @ref{272,,PyImport_ImportModuleNoBlock()}:
Use @ref{273,,PyImport_ImportModule()} instead.

@item 
@ref{274,,PyWeakref_GetObject()} and @ref{275,,PyWeakref_GET_OBJECT()}:
Use @ref{276,,PyWeakref_GetRef()} instead.

@item 
@ref{277,,Py_UNICODE} type and the @code{Py_UNICODE_WIDE} macro:
Use @code{wchar_t} instead.

@item 
Python initialization functions:


@itemize *

@item 
@ref{278,,PySys_ResetWarnOptions()}:
Clear @ref{279,,sys.warnoptions} and @code{warnings.filters} instead.

@item 
@ref{27a,,Py_GetExecPrefix()}:
Get @ref{27b,,sys.base_exec_prefix} and @ref{27c,,sys.exec_prefix} instead.

@item 
@ref{27d,,Py_GetPath()}:
Get @ref{27e,,sys.path} instead.

@item 
@ref{27f,,Py_GetPrefix()}:
Get @ref{280,,sys.base_prefix} and @ref{281,,sys.prefix} instead.

@item 
@ref{282,,Py_GetProgramFullPath()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{284,,Py_GetProgramName()}:
Get @ref{283,,sys.executable} instead.

@item 
@ref{285,,Py_GetPythonHome()}:
Get @ref{286,,PyConfig.home}
or the 
@geindex PYTHONHOME
@geindex variables de entorno; PYTHONHOME
@ref{287,,PYTHONHOME} environment variable instead.
@end itemize
@end itemize

@node Pending removal in future versions<8>,,Pending removal in Python 3 15<8>,C API deprecations
@anchor{deprecations/index id2}@anchor{50a6}
@subsection Pending removal in future versions


The following APIs are deprecated and will be removed,
although there is currently no date scheduled for their removal.


@itemize *

@item 
@ref{289,,Py_TPFLAGS_HAVE_FINALIZE}:
Unneeded since Python 3.8.

@item 
@ref{28a,,PyErr_Fetch()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28c,,PyErr_NormalizeException()}:
Use @ref{28b,,PyErr_GetRaisedException()} instead.

@item 
@ref{28d,,PyErr_Restore()}:
Use @ref{28e,,PyErr_SetRaisedException()} instead.

@item 
@ref{28f,,PyModule_GetFilename()}:
Use @ref{290,,PyModule_GetFilenameObject()} instead.

@item 
@ref{291,,PyOS_AfterFork()}:
Use @ref{292,,PyOS_AfterFork_Child()} instead.

@item 
@ref{293,,PySlice_GetIndicesEx()}:
Use @ref{294,,PySlice_Unpack()} and @ref{295,,PySlice_AdjustIndices()} instead.

@item 
@code{PyUnicode_AsDecodedObject()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsDecodedUnicode()}:
Use @ref{296,,PyCodec_Decode()} instead.

@item 
@code{PyUnicode_AsEncodedObject()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@code{PyUnicode_AsEncodedUnicode()}:
Use @ref{297,,PyCodec_Encode()} instead.

@item 
@ref{298,,PyUnicode_READY()}:
Unneeded since Python 3.12

@item 
@code{PyErr_Display()}:
Use @ref{299,,PyErr_DisplayException()} instead.

@item 
@code{_PyErr_ChainExceptions()}:
Use @code{_PyErr_ChainExceptions1()} instead.

@item 
@code{PyBytesObject.ob_shash} member:
call @ref{29a,,PyObject_Hash()} instead.

@item 
@code{PyDictObject.ma_version_tag} member.

@item 
Thread Local Storage (TLS) API:


@itemize *

@item 
@ref{29b,,PyThread_create_key()}:
Use @ref{29c,,PyThread_tss_alloc()} instead.

@item 
@ref{29d,,PyThread_delete_key()}:
Use @ref{29e,,PyThread_tss_free()} instead.

@item 
@ref{29f,,PyThread_set_key_value()}:
Use @ref{2a0,,PyThread_tss_set()} instead.

@item 
@ref{2a1,,PyThread_get_key_value()}:
Use @ref{2a2,,PyThread_tss_get()} instead.

@item 
@ref{2a3,,PyThread_delete_key_value()}:
Use @ref{2a4,,PyThread_tss_delete()} instead.

@item 
@ref{2a5,,PyThread_ReInitTLS()}:
Unneeded since Python 3.7.
@end itemize
@end itemize

@node Glosario,Acerca de estos documentos,Deprecations,Top
@anchor{glossary doc}@anchor{50a7}@anchor{glossary glossary}@anchor{1be4}@anchor{glossary id1}@anchor{50a8}
@chapter Glosario


@c if you add new entries, keep the alphabetical sorting!


@table @asis
@anchor{glossary term-0}@anchor{2d8}
@geindex >>>

@item @code{>>>}

The default Python prompt of the @ref{2d5,,interactive} shell.  Often
seen for code examples which can be executed interactively in the
interpreter.
@anchor{glossary term-}@anchor{2d9}
@geindex ...

@item @code{...}

Puede referirse a:


@itemize *

@item 
The default Python prompt of the @ref{2d5,,interactive} shell when entering the
code for an indented code block, when within a pair of matching left and
right delimiters (parentheses, square brackets, curly braces or triple
quotes), or after specifying a decorator.

@item 
La constante incorporada @ref{218d,,Ellipsis}.
@end itemize
@anchor{glossary term-abstract-base-class}@anchor{1224}
@geindex clase base abstracta

@item clase base abstracta

Las clases base abstractas (ABC, por sus siglas en inglés @cite{Abstract Base Class}) complementan al @ref{50a9,,duck-typing} brindando un forma de definir interfaces con técnicas como @ref{579,,hasattr()} que serían confusas o sutilmente erróneas (por ejemplo con @ref{1f65,,magic methods}). Las ABC introduce subclases virtuales, las cuales son clases que no heredan desde una clase pero aún así son reconocidas por @ref{4ef,,isinstance()} y @ref{85a,,issubclass()}; vea la documentación del módulo @ref{4,,abc}. Python viene con muchas ABC incorporadas para las estructuras de datos( en el módulo @ref{1f,,collections.abc}), números (en el módulo @ref{9e,,numbers} ) , flujos de datos (en el módulo @ref{7f,,io} ) , buscadores y cargadores de importaciones (en el módulo @ref{78,,importlib.abc} ) . Puede crear sus propios ABCs con el módulo @ref{4,,abc}.
@anchor{glossary term-annotate-function}@anchor{141}
@geindex annotate function

@item annotate function

A function that can be called to retrieve the @ref{140,,annotations}
of an object. This function is accessible as the @ref{161a,,__annotate__}
attribute of functions, classes, and modules. Annotate functions are a
subset of @ref{3eb1,,evaluate functions}.
@anchor{glossary term-annotation}@anchor{140}
@geindex anotación

@item anotación

Una etiqueta asociada a una variable, atributo de clase, parámetro de función o valor de retorno, usado por convención como un @ref{1f81,,type hint}.

Annotations of local variables cannot be accessed at runtime, but
annotations of global variables, class attributes, and functions
can be retrieved by calling @ref{147,,annotationlib.get_annotations()}
on modules, classes, and functions, respectively.

See @ref{ddb,,variable annotation}, @ref{1c3e,,function annotation}, 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/},
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, and 
@geindex Python Enhancement Proposals; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}, which describe this functionality.
Also see @ref{870,,Prácticas recomendadas para las anotaciones}
for best practices on working with annotations.
@anchor{glossary term-argument}@anchor{4f6}
@geindex argumento

@item argumento

Un valor pasado a una @ref{2054,,function} (o @ref{50aa,,method}) cuando se llama a la función. Hay dos clases de argumentos:


@itemize *

@item 
`argumento nombrado': es un argumento precedido por un identificador (por ejemplo, @code{nombre=}) en una llamada a una función o pasado como valor en un diccionario precedido por @code{**}. Por ejemplo @code{3} y @code{5} son argumentos nombrados en las llamadas a @ref{154,,complex()}:

@example
complex(real=3, imag=5)
complex(**@{'real': 3, 'imag': 5@})
@end example

@item 
`argumento posicional' son aquellos que no son nombrados. Los argumentos posicionales deben aparecer al principio de una lista de argumentos o ser pasados como elementos de un @ref{1294,,iterable} precedido por @code{*}. Por ejemplo, @code{3} y @code{5} son argumentos posicionales en las siguientes llamadas:

@example
complex(3, 5)
complex(*(3, 5))
@end example
@end itemize

Los argumentos son asignados a las variables locales en el cuerpo de la función. Vea en la sección @ref{e02,,Invocaciones} las reglas que rigen estas asignaciones. Sintácticamente, cualquier expresión puede ser usada para representar un argumento; el valor evaluado es asignado a la variable local.

Vea también el @ref{1efc,,parameter} en el glosario, la pregunta frecuente @ref{4fef,,la diferencia entre argumentos y parámetros}, y 
@geindex Python Enhancement Proposals; PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}.
@anchor{glossary term-asynchronous-context-manager}@anchor{678}
@geindex administrador asincrónico de contexto

@item administrador asincrónico de contexto

Un objeto que controla el entorno visible en un sentencia @ref{676,,async with} al definir los métodos @ref{1fd1,,__aenter__()} y @ref{1636,,__aexit__()}.  Introducido por 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-asynchronous-generator}@anchor{2039}
@geindex generador asincrónico

@item generador asincrónico

Una función que retorna un @ref{429f,,asynchronous generator iterator}. Es similar a una función corrutina definida con @ref{672,,async def} excepto que contiene expresiones @ref{a5f,,yield} para producir series de variables usadas en un ciclo @ref{b36,,async for}.

Usualmente se refiere a una función generadora asincrónica, pero puede referirse a un `iterador generador asincrónico' en ciertos contextos. En aquellos casos en los que el significado no está claro, usar los términos completos evita la ambigüedad.

Una función generadora asincrónica puede contener expresiones @ref{14e,,await} así como sentencias @ref{b36,,async for}, y @ref{676,,async with}.
@anchor{glossary term-asynchronous-generator-iterator}@anchor{429f}
@geindex iterador generador asincrónico

@item iterador generador asincrónico

Un objeto creado por una función @ref{2039,,asynchronous generator}.

Este es un @ref{312,,asynchronous iterator} el cual cuando es llamado usa el método @ref{1f09,,__anext__()} retornando un objeto a la espera (`awaitable') el cual ejecutará el cuerpo de la función generadora asincrónica hasta la siguiente expresión @ref{a5f,,yield}.

Cada @ref{a5f,,yield} suspende temporalmente el procesamiento, recordando el estado local de ejecución (incluyendo a las variables locales y las sentencias @cite{try} pendientes). Cuando el `iterador del generador asincrónico' vuelve efectivamente con otro objeto a la espera (`awaitable') retornado por el método @ref{1f09,,__anext__()}, retoma donde lo dejó. Vea 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} y 
@geindex Python Enhancement Proposals; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}.
@anchor{glossary term-asynchronous-iterable}@anchor{dfd}
@geindex iterable asincrónico

@item iterable asincrónico

Un objeto, que puede ser usado en una sentencia @ref{b36,,async for}. Debe retornar un @ref{312,,asynchronous iterator} de su método @ref{c83,,__aiter__()}. Introducido por 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-asynchronous-iterator}@anchor{312}
@geindex iterador asincrónico

@item iterador asincrónico

Un objeto que implementa los métodos @ref{c83,,__aiter__()} y @ref{1f09,,__anext__()}. @ref{1f09,,__anext__()} debe retornar un objeto @ref{314,,awaitable}. @ref{b36,,async for} resuelve los esperables retornados por un método de iterador asincrónico @ref{1f09,,__anext__()} hasta que lanza una excepción @ref{1a34,,StopAsyncIteration}. Introducido por 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-attribute}@anchor{249d}
@geindex atributo

@item atributo

Un valor asociado a un objeto al que se suele hacer referencia por su nombre utilizando expresiones punteadas. Por ejemplo, si un objeto `o' tiene un atributo `a' se referenciaría como `o.a'.

Es posible dar a un objeto un atributo cuyo nombre no sea un identificador definido por @ref{1e94,,Identificadores y palabras clave}, por ejemplo usando @ref{215f,,setattr()}, si el objeto lo permite. Dicho atributo no será accesible utilizando una expresión con puntos, y en su lugar deberá ser recuperado con @ref{c59,,getattr()}.
@anchor{glossary term-awaitable}@anchor{314}
@geindex a la espera

@item a la espera

Un objeto que puede utilizarse en una expresión @ref{14e,,await}.  Puede ser una @ref{53a,,corutina} o un objeto con un método @ref{1fc8,,__await__()}. Véase también 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-BDFL}@anchor{50ab}
@geindex BDFL

@item BDFL

Sigla de `Benevolent Dictator For Life', benevolente dictador vitalicio, es decir Guido van Rossum@footnote{https://gvanrossum.github.io/}, el creador de Python.
@anchor{glossary term-binary-file}@anchor{1c8e}
@geindex archivo binario

@item archivo binario

A @ref{1230,,file object} able to read and write
@ref{db4,,bytes-like objects}.
Examples of binary files are files opened in binary mode (@code{'rb'},
@code{'wb'} or @code{'rb+'}), @ref{5df,,sys.stdin.buffer},
@ref{b61,,sys.stdout.buffer}, and instances of
@ref{f25,,io.BytesIO} and @ref{4d8,,gzip.GzipFile}.

Vea también @ref{1c8d,,text file} para un objeto archivo capaz de leer y escribir objetos @ref{237,,str}.
@anchor{glossary term-borrowed-reference}@anchor{432}
@geindex referencia prestada

@item referencia prestada

En la API C de Python, una referencia prestada es una referencia a un objeto, donde el código usando el objeto no posee la referencia. Se convierte en un puntero colgante si se destruye el objeto. Por ejemplo, una recolección de basura puede eliminar el último @ref{431,,strong reference} del objeto y así destruirlo.

Se recomienda llamar a @ref{612,,Py_INCREF()} en la @ref{432,,referencia prestada} para convertirla en una @ref{431,,referencia fuerte} in situ, excepto cuando el objeto no se puede destruir antes del último uso de la referencia prestada. La función @ref{932,,Py_NewRef()} se puede utilizar para crear una nueva @ref{431,,referencia fuerte}.
@anchor{glossary term-bytes-like-object}@anchor{db4}
@geindex objetos tipo binarios

@item objetos tipo binarios

Un objeto que soporta @ref{48a,,Protocolo búfer}  y puede exportar un búfer C-@ref{222d,,contiguous}. Esto incluye todas los objetos @ref{325,,bytes}, @ref{5e0,,bytearray}, y @ref{308,,array.array}, así como muchos objetos comunes @ref{156,,memoryview}. Los objetos tipo binarios pueden ser usados para varias operaciones que usan datos binarios; éstas incluyen compresión, salvar a archivos binarios, y enviarlos a través de un socket.

Algunas operaciones necesitan que los datos binarios sean mutables. La documentación frecuentemente se refiere a éstos como «objetos tipo binario de lectura y escritura». Ejemplos de objetos de búfer mutables incluyen a @ref{5e0,,bytearray} y @ref{156,,memoryview} de la @ref{5e0,,bytearray}. Otras operaciones que requieren datos binarios almacenados en objetos inmutables («objetos tipo binario de sólo lectura»); ejemplos de éstos incluyen @ref{325,,bytes} y @ref{156,,memoryview} del objeto @ref{325,,bytes}.
@anchor{glossary term-bytecode}@anchor{2f2}
@geindex bytecode

@item bytecode

El código fuente Python es compilado en `bytecode', la representación interna de un programa python en el intérprete CPython. El `bytecode' también es guardado en caché en los archivos @cite{.pyc} de tal forma que ejecutar el mismo archivo es más fácil la segunda vez (la recompilación desde el código fuente a `bytecode' puede ser evitada). Este «lenguaje intermedio» deberá corren en una @ref{3443,,virtual machine} que ejecute el código de máquina correspondiente a cada `bytecode'. Note que los `bytecodes' no tienen como requisito trabajar en las diversas máquina virtuales de Python, ni de ser estable entre versiones Python.

Una lista de las instrucciones en `bytecode' está disponible en la documentación de @ref{653,,el módulo dis}.
@anchor{glossary term-callable}@anchor{28ea}
@geindex callable

@item callable

Un callable es un objeto que puede ser llamado, posiblemente con un conjunto de argumentos (véase @ref{4f6,,argument}), con la siguiente sintaxis:

@example
callable(argument1, argument2, argumentN)
@end example

Una @ref{2054,,function}, y por extensión un @ref{50aa,,method}, es un callable. Una instancia de una clase que implementa el método @ref{5fb,,__call__()} también es un callable.
@anchor{glossary term-callback}@anchor{290d}
@geindex retrollamada

@item retrollamada

Una función de subrutina que se pasa como un argumento para ejecutarse en algún momento en el futuro.
@anchor{glossary term-class}@anchor{193b}
@geindex clase

@item clase

Una plantilla para crear objetos definidos por el usuario. Las definiciones de clase normalmente contienen definiciones de métodos que operan una instancia de la clase.
@anchor{glossary term-class-variable}@anchor{50ac}
@geindex variable de clase

@item variable de clase

Una variable definida en una clase y prevista para ser modificada sólo a nivel de clase (es decir, no en una instancia de la clase).
@anchor{glossary term-closure-variable}@anchor{1f40}
@geindex closure variable

@item closure variable

A @ref{1fdb,,free variable} referenced from a @ref{1f3f,,nested scope} that is defined in an outer
scope rather than being resolved at runtime from the globals or builtin namespaces.
May be explicitly defined with the @ref{1313,,nonlocal} keyword to allow write access,
or implicitly defined if the variable is only being read.

For example, in the @code{inner} function in the following code, both @code{x} and @code{print} are
@ref{1fdb,,free variables}, but only @code{x} is a `closure variable':

@example
def outer():
    x = 0
    def inner():
        nonlocal x
        x += 1
        print(x)
    return inner
@end example

Due to the @ref{1ef8,,codeobject.co_freevars} attribute (which, despite its name, only
includes the names of closure variables rather than listing all referenced free
variables), the more general @ref{1fdb,,free variable} term is sometimes used even
when the intended meaning is to refer specifically to closure variables.
@anchor{glossary term-complex-number}@anchor{50ad}
@geindex número complejo

@item número complejo

Una extensión del sistema familiar de número reales en el cual los números son expresados como la suma de una parte real y una parte imaginaria.  Los números imaginarios son múltiplos de la unidad imaginaria (la raíz cuadrada de @code{-1}), usualmente escrita como @code{i} en matemáticas o @code{j} en ingeniería.  Python tiene soporte incorporado para números complejos, los cuales son escritos con la notación mencionada al final.; la parte imaginaria es escrita con un sufijo @code{j}, por ejemplo, @code{3+1j}.  Para tener acceso a los equivalentes complejos del módulo @ref{8e,,math} module, use @ref{19,,cmath}.  El uso de números complejos es matemática bastante avanzada.  Si no le parecen necesarios, puede ignorarlos sin inconvenientes.
@anchor{glossary term-context}@anchor{1601}
@geindex context

@item context

This term has different meanings depending on where and how it is used.
Some common meanings:


@itemize *

@item 
The temporary state or environment established by a @ref{675,,context manager} via a @ref{673,,with} statement.

@item 
The collection of key­value bindings associated with a particular
@ref{15a0,,contextvars.Context} object and accessed via
@ref{31a0,,ContextVar} objects.  Also see @ref{50ae,,context variable}.

@item 
A @ref{15a0,,contextvars.Context} object.  Also see @ref{1602,,current context}.
@end itemize
@anchor{glossary term-context-management-protocol}@anchor{1603}
@geindex context management protocol

@item context management protocol

The @ref{669,,__enter__()} and @ref{1367,,__exit__()} methods called
by the @ref{673,,with} statement.  See 
@geindex Python Enhancement Proposals; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.
@anchor{glossary term-context-manager}@anchor{675}
@geindex administrador de contextos

@item administrador de contextos

An object which implements the @ref{1603,,context management protocol} and
controls the environment seen in a @ref{673,,with} statement.  See
@geindex Python Enhancement Proposals; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.
@anchor{glossary term-context-variable}@anchor{50ae}
@geindex variable de contexto

@item variable de contexto

A variable whose value depends on which context is the @ref{1602,,current context}.  Values are accessed via @ref{31a0,,contextvars.ContextVar}
objects.  Context variables are primarily used to isolate state between
concurrent asynchronous tasks.
@anchor{glossary term-contiguous}@anchor{222d}
@geindex contiguo

@item contiguo

@geindex C-contiguous
@geindex Fortran contiguous

Un búfer es considerado contiguo con precisión si es `C-contiguo' o `Fortran contiguo'. Los búferes cero dimensionales con C y Fortran contiguos. En los arreglos unidimensionales, los ítems deben ser dispuestos en memoria uno siguiente al otro, ordenados por índices que comienzan en cero. En arreglos unidimensionales C-contiguos, el último índice varía más velozmente en el orden de las direcciones de memoria. Sin embargo, en arreglos Fortran contiguos, el primer índice vería más rápidamente.
@anchor{glossary term-coroutine}@anchor{53a}
@geindex corrutina

@item corrutina

Las corrutinas son una forma más generalizadas de las subrutinas. A las subrutinas se ingresa por un punto y se sale por otro punto. Las corrutinas pueden se iniciadas, finalizadas y reanudadas en muchos puntos diferentes. Pueden ser implementadas con la sentencia @ref{672,,async def}. Vea además 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-coroutine-function}@anchor{dfc}
@geindex función corrutina

@item función corrutina

Un función que retorna un objeto  @ref{53a,,coroutine} . Una función corrutina puede ser definida con la sentencia @ref{672,,async def}, y puede contener las palabras claves @ref{14e,,await}, @ref{b36,,async for}, y @ref{676,,async with}. Las mismas son introducidas en 
@geindex Python Enhancement Proposals; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-CPython}@anchor{796}
@geindex CPython

@item CPython

La implementación canónica del lenguaje de programación Python, como se distribuye en python.org@footnote{https://www.python.org}. El término «CPython» es usado cuando es necesario distinguir esta implementación de otras como `Jython' o `IronPython'.
@anchor{glossary term-current-context}@anchor{1602}
@geindex current context

@item current context

The @ref{1601,,context} (@ref{15a0,,contextvars.Context} object) that is
currently used by @ref{31a0,,ContextVar} objects to access (get
or set) the values of @ref{50ae,,context variables}.  Each
thread has its own current context.  Frameworks for executing asynchronous
tasks (see @ref{b,,asyncio}) associate each task with a context which
becomes the current context whenever the task starts or resumes execution.
@anchor{glossary term-decorator}@anchor{7cd}
@geindex decorador

@item decorador

Una función que retorna otra función, usualmente aplicada como una función de transformación empleando la sintaxis @code{@@envoltorio}. Ejemplos comunes de decoradores son  @ref{2d2,,classmethod()} y @ref{22e,,staticmethod()}.

La sintaxis del decorador es meramente azúcar sintáctico, las definiciones de las siguientes dos funciones son semánticamente equivalentes:

@example
def f(arg):
    ...
f = staticmethod(f)

@@staticmethod
def f(arg):
    ...
@end example

El mismo concepto existe para clases, pero son menos usadas. Vea la documentación de @ref{1c3d,,function definitions} y @ref{133f,,class definitions} para mayor detalle sobre decoradores.
@anchor{glossary term-descriptor}@anchor{1f70}
@geindex descriptor

@item descriptor

Any object which defines the methods @ref{1527,,__get__()},
@ref{1f69,,__set__()}, or @ref{15eb,,__delete__()}.
When a class attribute is a descriptor, its special
binding behavior is triggered upon attribute lookup.  Normally, using
`a.b' to get, set or delete an attribute looks up the object named `b' in
the class dictionary for `a', but if `b' is a descriptor, the respective
descriptor method gets called.  Understanding descriptors is a key to a
deep understanding of Python because they are the basis for many features
including functions, methods, properties, class methods, static methods,
and reference to super classes.

Para obtener más información sobre los métodos de los descriptores, consulte @ref{cd7,,Implementando descriptores} o @ref{152c,,Guía práctica de uso de los descriptores}.
@anchor{glossary term-dictionary}@anchor{1f8b}
@geindex diccionario

@item diccionario

An associative array, where arbitrary keys are mapped to values.  The
keys can be any object with @ref{b86,,__hash__()} and
@ref{b85,,__eq__()} methods.
Called a hash in Perl.
@anchor{glossary term-dictionary-comprehension}@anchor{50af}
@geindex comprensión de diccionarios

@item comprensión de diccionarios

Una forma compacta de procesar todos o parte de los elementos en un iterable y retornar un diccionario con los resultados. @code{results = @{n: n ** 2 for n in range(10)@}} genera un diccionario que contiene la clave @code{n} asignada al valor @code{n ** 2}. Ver @ref{671,,Despliegues para listas@comma{} conjuntos y diccionarios}.
@anchor{glossary term-dictionary-view}@anchor{2519}
@geindex vista de diccionario

@item vista de diccionario

Los objetos retornados por los métodos  @ref{866,,dict.keys()}, @ref{867,,dict.values()}, y @ref{868,,dict.items()} son llamados vistas de diccionarios. Proveen una vista dinámica de las entradas de un diccionario, lo que significa que cuando el diccionario cambia, la vista refleja éstos cambios. Para forzar a la vista de diccionario a convertirse en una lista completa, use @code{list(dictview)}.  Vea @ref{2249,,Objetos tipos vista de diccionario}.
@anchor{glossary term-docstring}@anchor{2126}
@geindex docstring

@item docstring

A string literal which appears as the first expression in a class,
function or module.  While ignored when the suite is executed, it is
recognized by the compiler and put into the @ref{9bb,,__doc__} attribute
of the enclosing class, function or module.  Since it is available via
introspection, it is the canonical place for documentation of the
object.
@anchor{glossary term-duck-typing}@anchor{50a9}
@geindex tipado de pato

@item tipado de pato

Un estilo de programación que no revisa el tipo del objeto para determinar si tiene la interfaz correcta; en vez de ello, el método o atributo es simplemente llamado o usado («Si se ve como un pato y grazna como un pato, debe ser un pato»).  Enfatizando las interfaces en vez de hacerlo con los tipos específicos, un código bien diseñado pues tener mayor flexibilidad permitiendo la sustitución polimórfica.  El tipado de pato `duck-typing' evita usar pruebas llamando a @ref{dcf,,type()} o @ref{4ef,,isinstance()}.  (Nota: si embargo, el tipado de pato puede ser complementado con @ref{1224,,abstract base classes}. En su lugar, generalmente pregunta con @ref{579,,hasattr()} o @ref{2b7f,,EAFP}.
@anchor{glossary term-EAFP}@anchor{2b7f}
@geindex EAFP

@item EAFP

Del inglés `Easier to ask for forgiveness than permission', es más fácil pedir perdón que pedir permiso.  Este estilo de codificación común en Python asume la existencia de claves o atributos válidos y atrapa las excepciones si esta suposición resulta falsa.  Este estilo rápido y limpio está caracterizado por muchas sentencias @ref{789,,try} y @ref{2f6,,except}.  Esta técnica contrasta con estilo @ref{50b0,,LBYL} usual en otros lenguajes como C.
@anchor{glossary term-evaluate-function}@anchor{3eb1}
@geindex evaluate function

@item evaluate function

A function that can be called to evaluate a lazily evaluated attribute
of an object, such as the value of type aliases created with the @ref{4e6,,type}
statement.
@anchor{glossary term-expression}@anchor{1f85}
@geindex expresión

@item expresión

Una construcción sintáctica que puede ser evaluada, hasta dar un valor.  En otras palabras, una expresión es una acumulación de elementos de expresión tales como literales, nombres, accesos a atributos, operadores o llamadas a funciones, todos ellos retornando valor.  A diferencia de otros lenguajes, no toda la sintaxis del lenguaje son expresiones. También hay @ref{2777,,statement}s que no pueden ser usadas como expresiones, como la @ref{1611,,while}.  Las asignaciones también son sentencias, no expresiones.
@anchor{glossary term-extension-module}@anchor{44b3}
@geindex módulo de extensión

@item módulo de extensión

Un módulo escrito en C o C++, usando la API para C de Python para interactuar con el núcleo y el código del usuario.
@anchor{glossary term-f-string}@anchor{4e4}
@geindex f-string

@item f-string

Son llamadas `f-strings' las cadenas literales que usan el prefijo @code{'f'} o @code{'F'}, que es una abreviatura para  @ref{a3b,,formatted string literals}.  Vea también 
@geindex Python Enhancement Proposals; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/}.
@anchor{glossary term-file-object}@anchor{1230}
@geindex objeto archivo

@item objeto archivo

An object exposing a file-oriented API (with methods such as
@code{read()} or @code{write()}) to an underlying resource.  Depending
on the way it was created, a file object can mediate access to a real
on-disk file or to another type of storage or communication device
(for example standard input/output, in-memory buffers, sockets, pipes,
etc.).  File objects are also called `file-like objects' or
`streams'.

Existen tres categorías de objetos archivo: crudos `raw' @ref{1c8e,,archivos binarios}, con búfer @ref{1c8e,,archivos binarios} y @ref{1c8d,,archivos de texto}.  Sus interfaces son definidas en el módulo @ref{7f,,io}.  La forma canónica de crear objetos archivo es usando la función @ref{1be,,open()}.
@anchor{glossary term-file-like-object}@anchor{2586}
@geindex objetos tipo archivo

@item objetos tipo archivo

Un sinónimo de @ref{1230,,file object}.
@anchor{glossary term-filesystem-encoding-and-error-handler}@anchor{5dd}
@geindex codificación del sistema de archivos y manejador de errores

@item codificación del sistema de archivos y manejador de errores

Controlador de errores y codificación utilizado por Python para decodificar bytes del sistema operativo y codificar Unicode en el sistema operativo.

La codificación del sistema de archivos debe garantizar la decodificación exitosa de todos los bytes por debajo de 128. Si la codificación del sistema de archivos no proporciona esta garantía, las funciones de API pueden lanzar @ref{130f,,UnicodeError}.

Las funciones @ref{ce1,,sys.getfilesystemencoding()} y @ref{d6d,,sys.getfilesystemencodeerrors()} se pueden utilizar para obtener la codificación del sistema de archivos y el controlador de errores.

La @ref{5dd,,codificación del sistema de archivos y el manejador de errores} se configuran al inicio de Python mediante la función @ref{829,,PyConfig_Read()}: consulte los miembros @ref{4c9,,filesystem_encoding} y @ref{4ca,,filesystem_errors} de @ref{499,,PyConfig}.

Vea también @ref{39b,,locale encoding}.
@anchor{glossary term-finder}@anchor{1f1c}
@geindex buscador

@item buscador

Un objeto que trata de encontrar el @ref{16b8,,loader} para el módulo que está siendo importado.

There are two types of finder: @ref{10ec,,meta path finders} for use with @ref{db2,,sys.meta_path}, and @ref{10ed,,path entry finders} for use with @ref{10a0,,sys.path_hooks}.

See @ref{1ff3,,Buscadores y cargadores} and @ref{77,,importlib} for much more detail.
@anchor{glossary term-floor-division}@anchor{9d7}
@geindex división entera a la baja

@item división entera a la baja

Una división matemática que se redondea hacia el entero menor más cercano.  El operador de la división entera a la baja es @code{//}.  Por ejemplo, la expresión @code{11 // 4} evalúa @code{2} a diferencia del @code{2.75} retornado por la verdadera división de números flotantes.  Note que @code{(-11) // 4} es @code{-3} porque es @code{-2.75} redondeado `para abajo'. Ver 
@geindex Python Enhancement Proposals; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}.
@anchor{glossary term-free-threading}@anchor{43ec}
@geindex free threading

@item free threading

A threading model where multiple threads can run Python bytecode
simultaneously within the same interpreter.  This is in contrast to
the @ref{2b5,,global interpreter lock} which allows only one thread to
execute Python bytecode at a time.  See 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.
@anchor{glossary term-free-variable}@anchor{1fdb}
@geindex free variable

@item free variable

Formally, as defined in the @ref{1fd8,,language execution model}, a free
variable is any variable used in a namespace which is not a local variable in that
namespace. See @ref{1f40,,closure variable} for an example.
Pragmatically, due to the name of the @ref{1ef8,,codeobject.co_freevars} attribute,
the term is also sometimes used as a synonym for @ref{1f40,,closure variable}.
@anchor{glossary term-function}@anchor{2054}
@geindex función

@item función

Una serie de sentencias que retornan un valor al que las llama.  También se le puede pasar cero o más @ref{4f6,,argumentos} los cuales pueden ser usados en la ejecución de la misma. Vea también @ref{1efc,,parameter}, @ref{50aa,,method}, y la sección @ref{1c3d,,Definiciones de funciones}.
@anchor{glossary term-function-annotation}@anchor{1c3e}
@geindex anotación de función

@item anotación de función

Una @ref{140,,annotation} del parámetro de una función o un valor de retorno.

Las anotaciones de funciones son usadas frecuentemente para @ref{1f81,,indicadores de tipo}, por ejemplo, se espera que una función tome dos argumentos de clase @ref{1f0,,int}  y también se espera que retorne dos valores @ref{1f0,,int}:

@example
def sum_two_numbers(a: int, b: int) -> int:
   return a + b
@end example

La sintaxis de las anotaciones de funciones son explicadas en la sección @ref{1c3d,,Definiciones de funciones}.

Consulte @ref{ddb,,variable annotation} y 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, que describen esta funcionalidad. Consulte también @ref{870,,Prácticas recomendadas para las anotaciones} para conocer las mejores prácticas sobre cómo trabajar con anotaciones.
@anchor{glossary term-__future__}@anchor{e33}
@geindex __future__

@item __future__

Un @ref{2f4,,future statement}, @code{from __future__ import <feature>}, indica al compilador que compile el módulo actual utilizando una sintaxis o semántica que se convertirá en estándar en una versión futura de Python. El módulo @ref{0,,__future__} documenta los posibles valores de `feature'. Al importar este módulo y evaluar sus variables, puede ver cuándo se agregó por primera vez una nueva característica al lenguaje y cuándo se convertirá (o se convirtió) en la predeterminada:

@example
>>> import __future__
>>> __future__.division
_Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
@end example
@anchor{glossary term-garbage-collection}@anchor{1922}
@geindex recolección de basura

@item recolección de basura

El proceso de liberar la memoria de lo que ya no está en uso.  Python realiza recolección de basura (`garbage collection') llevando la cuenta de las referencias, y el recogedor de basura cíclico es capaz de detectar y romper las referencias cíclicas.  El recogedor de basura puede ser controlado mediante el módulo @ref{60,,gc} .

@geindex generador
@anchor{glossary term-generator}@anchor{10dd}
@geindex generador

@item generador

Una función que retorna un @ref{c66,,generator iterator}.  Luce como una función normal excepto que contiene la expresión @ref{a5f,,yield} para producir series de valores utilizables en un bucle `for' o que pueden ser obtenidas una por una con la función @ref{86f,,next()}.

Usualmente se refiere a una función generadora, pero puede referirse a un `iterador generador' en ciertos contextos.  En aquellos casos en los que el significado no está claro, usar los términos completos  evita la ambigüedad.
@anchor{glossary term-generator-iterator}@anchor{c66}
@geindex iterador generador

@item iterador generador

Un objeto creado por una función @ref{10dd,,generator}.

Cada @ref{a5f,,yield} suspende temporalmente el procesamiento, recordando el estado de ejecución local (incluyendo las variables locales y las sentencias `try' pendientes).  Cuando el «iterador generado» vuelve, retoma donde ha dejado, a diferencia de lo que ocurre con las funciones que comienzan nuevamente con cada invocación.

@geindex expresión generadora
@anchor{glossary term-generator-expression}@anchor{50b1}
@geindex expresión generadora

@item expresión generadora

An @ref{1f85,,expression} that returns an @ref{313,,iterator}.  It looks like a normal expression
followed by a @code{for} clause defining a loop variable, range,
and an optional @code{if} clause.  The combined expression
generates values for an enclosing function:

@example
>>> sum(i*i for i in range(10))         # sum of squares 0, 1, 4, ... 81
285
@end example
@anchor{glossary term-generic-function}@anchor{a83}
@geindex función genérica

@item función genérica

Una función compuesta de muchas funciones que implementan la misma operación para diferentes tipos. Qué implementación deberá ser usada durante la llamada a la misma es determinado por el algoritmo de despacho.

Vea también la entrada de glosario @ref{a84,,single dispatch}, el decorador @ref{6da,,functools.singledispatch()}, y 
@geindex Python Enhancement Proposals; PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/}.
@anchor{glossary term-generic-type}@anchor{157}
@geindex tipos genéricos

@item tipos genéricos

Un @ref{193c,,type} que se puede parametrizar; normalmente un @ref{1f8a,,container class} como @ref{18e,,list} o @ref{190,,dict}. Usado para @ref{1f81,,type hints} y @ref{140,,annotations}.

Para más detalles, véase @ref{753,,generic alias types}, 
@geindex Python Enhancement Proposals; PEP 483
PEP 483@footnote{https://peps.python.org/pep-0483/}, 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, 
@geindex Python Enhancement Proposals; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}, y el módulo @ref{104,,typing}.
@anchor{glossary term-GIL}@anchor{2c5}
@geindex GIL

@item GIL

Vea @ref{2b5,,global interpreter lock}.
@anchor{glossary term-global-interpreter-lock}@anchor{2b5}
@geindex bloqueo global del intérprete

@item bloqueo global del intérprete

Mecanismo empleado por el intérprete @ref{796,,CPython} para asegurar que sólo un hilo ejecute el  @ref{2f2,,bytecode} Python por vez. Esto simplifica la implementación de CPython haciendo que el modelo de objetos (incluyendo algunos críticos como @ref{190,,dict}) están implícitamente a salvo de acceso concurrente.  Bloqueando el intérprete completo se simplifica hacerlo multi-hilos, a costa de mucho del paralelismo ofrecido por las máquinas con múltiples procesadores.

Sin embargo, algunos módulos de extensión, tanto estándar como de terceros, están diseñados para liberar el GIL cuando se realizan tareas computacionalmente intensivas como la compresión o el `hashing'.  Además, el GIL siempre es liberado cuando se hace entrada/salida.

As of Python 3.13, the GIL can be disabled using the @ref{2e0,,--disable-gil}
build configuration. After building Python with this option, code must be
run with @ref{2e2,,-X gil=0} or after setting the 
@geindex PYTHON_GIL
@geindex variables de entorno; PYTHON_GIL
@ref{2e1,,PYTHON_GIL=0}
environment variable. This feature enables improved performance for
multi-threaded applications and makes it easier to use multi-core CPUs
efficiently. For more details, see 
@geindex Python Enhancement Proposals; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.
@anchor{glossary term-hash-based-pyc}@anchor{50b2}
@geindex hash-based pyc

@item hash-based pyc

Un archivo cache de `bytecode' que usa el `hash' en vez de usar el tiempo de la última modificación del archivo fuente correspondiente para determinar su validez. Vea @ref{68c,,Invalidación del código de bytes en caché}.
@anchor{glossary term-hashable}@anchor{6b1}
@geindex hashable

@item hashable

An object is `hashable' if it has a hash value which never changes during
its lifetime (it needs a @ref{b86,,__hash__()} method), and can be
compared to other objects (it needs an @ref{b85,,__eq__()} method).
Hashable objects which
compare equal must have the same hash value.

Ser `hashable' hace a un objeto utilizable como clave de un diccionario y miembro de un set, porque éstas estructuras de datos usan los valores de hash internamente.

La mayoría de los objetos inmutables incorporados en Python son `hashables'; los contenedores mutables (como las listas o los diccionarios) no lo son; los contenedores inmutables (como tuplas y conjuntos `frozensets') son `hashables' si sus elementos son `hashables' .  Los objetos que son instancias de clases definidas por el usuario son `hashables' por defecto.  Todos se comparan como desiguales (excepto consigo mismos), y su valor de hash está derivado de su función @ref{1462,,id()}.
@anchor{glossary term-IDLE}@anchor{50b3}
@geindex IDLE

@item IDLE

Un Entorno Integrado de Desarrollo y Aprendizaje para Python. @ref{1091,,IDLE} es un editor básico y un entorno de intérprete que se incluye con la distribución estándar de Python.
@anchor{glossary term-immortal}@anchor{429d}
@geindex immortal

@item immortal

`Immortal objects' are a CPython implementation detail introduced
in 
@geindex Python Enhancement Proposals; PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}.

If an object is immortal, its @ref{4859,,reference count} is never modified,
and therefore it is never deallocated while the interpreter is running.
For example, @ref{c95,,True} and @ref{716,,None} are immortal in CPython.
@anchor{glossary term-immutable}@anchor{1c03}
@geindex inmutable

@item inmutable

Un objeto con un valor fijo.  Los objetos inmutables son números, cadenas y tuplas.  Éstos objetos no pueden ser alterados.  Un nuevo objeto debe ser creado si un valor diferente ha de ser guardado.  Juegan un rol importante en lugares donde es necesario un valor de hash constante, por ejemplo como claves de un diccionario.
@anchor{glossary term-import-path}@anchor{1ff6}
@geindex ruta de importación

@item ruta de importación

Una lista de las ubicaciones (o @ref{2004,,entradas de ruta}) que son revisadas por @ref{1ff9,,path based finder} al importar módulos. Durante la importación, ésta lista de localizaciones usualmente viene de @ref{27e,,sys.path}, pero para los subpaquetes también puede incluir al atributo @code{__path__} del paquete padre.
@anchor{glossary term-importing}@anchor{1fea}
@geindex importar

@item importar

El proceso mediante el cual el código Python dentro de un módulo se hace alcanzable desde otro código Python en otro módulo.
@anchor{glossary term-importer}@anchor{1ff5}
@geindex importador

@item importador

Un objeto que buscan y lee un módulo; un objeto que es tanto @ref{1f1c,,finder} como @ref{16b8,,loader}.
@anchor{glossary term-interactive}@anchor{2d5}
@geindex interactivo

@item interactivo

Python has an interactive interpreter which means you can enter
statements and expressions at the interpreter prompt, immediately
execute them and see their results.  Just launch @code{python} with no
arguments (possibly by selecting it from your computer’s main
menu). It is a very powerful way to test out new ideas or inspect
modules and packages (remember @code{help(x)}). For more on interactive
mode, see @ref{2db,,Modo interactivo}.
@anchor{glossary term-interpreted}@anchor{50b4}
@geindex interpretado

@item interpretado

Python es un lenguaje interpretado, a diferencia de uno compilado, a pesar de que la distinción puede ser difusa debido al compilador a `bytecode'.  Esto significa que los archivos fuente pueden ser corridos directamente, sin crear explícitamente un ejecutable que es corrido luego. Los lenguajes interpretados típicamente tienen ciclos de desarrollo y depuración más cortos que los compilados, sin embargo sus programas suelen correr más lentamente.  Vea también  @ref{2d5,,interactive}.
@anchor{glossary term-interpreter-shutdown}@anchor{2bb}
@geindex apagado del intérprete

@item apagado del intérprete

Cuando se le solicita apagarse, el intérprete Python ingresa a un fase especial en la cual gradualmente libera todos los recursos reservados, como módulos y varias estructuras internas críticas.  También hace varias llamadas al @ref{1922,,recolector de basura}.  Esto puede disparar la ejecución de código de destructores definidos por el usuario o `weakref callbacks'. El código ejecutado durante la fase de apagado puede encontrar varias excepciones debido a que los recursos que necesita pueden no funcionar más (ejemplos comunes son los módulos de bibliotecas o los artefactos de advertencias `warnings machinery')

La principal razón para el apagado del intérpreter es que el módulo @code{__main__} o el script que estaba corriendo termine su ejecución.
@anchor{glossary term-iterable}@anchor{1294}
@geindex iterable

@item iterable

An object capable of returning its members one at a time. Examples of
iterables include all sequence types (such as @ref{18e,,list}, @ref{237,,str},
and @ref{464,,tuple}) and some non-sequence types like @ref{190,,dict},
@ref{1230,,file objects}, and objects of any classes you define
with an @ref{1ccb,,__iter__()} method or with a
@ref{3d8,,__getitem__()} method
that implements @ref{597,,sequence} semantics.

Iterables can be
used in a @ref{1eb,,for} loop and in many other places where a sequence is
needed (@ref{14d,,zip()}, @ref{14c,,map()}, …).  When an iterable object is passed
as an argument to the built-in function @ref{86e,,iter()}, it returns an
iterator for the object.  This iterator is good for one pass over the set
of values.  When using iterables, it is usually not necessary to call
@ref{86e,,iter()} or deal with iterator objects yourself.  The @ref{1eb,,for}
statement does that automatically for you, creating a temporary unnamed
variable to hold the iterator for the duration of the loop.  See also
@ref{313,,iterator}, @ref{597,,sequence}, and @ref{10dd,,generator}.
@anchor{glossary term-iterator}@anchor{313}
@geindex iterador

@item iterador

An object representing a stream of data.  Repeated calls to the iterator’s
@ref{1335,,__next__()} method (or passing it to the built-in function
@ref{86f,,next()}) return successive items in the stream.  When no more data
are available a @ref{c82,,StopIteration} exception is raised instead.  At this
point, the iterator object is exhausted and any further calls to its
@code{__next__()} method just raise @ref{c82,,StopIteration} again.  Iterators
are required to have an @ref{1ccb,,__iter__()} method that returns the iterator
object itself so every iterator is also iterable and may be used in most
places where other iterables are accepted.  One notable exception is code
which attempts multiple iteration passes.  A container object (such as a
@ref{18e,,list}) produces a fresh new iterator each time you pass it to the
@ref{86e,,iter()} function or use it in a @ref{1eb,,for} loop.  Attempting this
with an iterator will just return the same exhausted iterator object used
in the previous iteration pass, making it appear like an empty container.

Puede encontrar más información en @ref{217b,,Tipos de iteradores}.

`Detalles de implementación de CPython:' CPython does not consistently apply the requirement that an iterator
define @ref{1ccb,,__iter__()}.
And also please note that the free-threading CPython does not guarantee
the thread-safety of iterator operations.
@anchor{glossary term-key-function}@anchor{e8a}
@geindex función clave

@item función clave

Una función clave o una función de colación es un invocable que retorna un valor usado para el ordenamiento o clasificación.  Por ejemplo, @ref{3c6c,,locale.strxfrm()} es usada para producir claves de ordenamiento que se adaptan a las convenciones específicas de ordenamiento de un `locale'.

Cierta cantidad de herramientas de Python aceptan funciones clave para controlar como los elementos son ordenados o agrupados. Incluyendo a  @ref{f8b,,min()}, @ref{f8c,,max()}, @ref{c56,,sorted()}, @ref{c57,,list.sort()}, @ref{e89,,heapq.merge()}, @ref{252f,,heapq.nsmallest()}, @ref{252e,,heapq.nlargest()}, y @ref{2724,,itertools.groupby()}.

Hay varias formas de crear una función clave.  Por ejemplo, el método @ref{17f4,,str.lower()} puede servir como función clave para ordenamientos que no distingan mayúsculas de minúsculas.  Como alternativa, una función clave puede ser realizada con una expresión @ref{1309,,lambda} como @code{lambda r: (r[0], r[2])}.  Además, @ref{eb8,,operator.attrgetter()}, @ref{af2,,operator.itemgetter()} y @ref{eb9,,operator.methodcaller()} son tres constructores de funciones clave.  Consulte @ref{2186,,Sorting HOW TO} para ver ejemplos de cómo crear y utilizar funciones clave.
@anchor{glossary term-keyword-argument}@anchor{d99}
@geindex argumento nombrado

@item argumento nombrado

Vea @ref{4f6,,argument}.
@anchor{glossary term-lambda}@anchor{272f}
@geindex lambda

@item lambda

Una función anónima de una línea consistente en un sola @ref{1f85,,expression} que es evaluada cuando la función es llamada.  La sintaxis para crear una función lambda es @code{lambda [parameters]: expression}
@anchor{glossary term-LBYL}@anchor{50b0}
@geindex LBYL

@item LBYL

Del inglés `Look before you leap', «mira antes de saltar».  Es un estilo de codificación que prueba explícitamente las condiciones previas antes de hacer llamadas o búsquedas.  Este estilo contrasta con la manera @ref{2b7f,,EAFP} y está caracterizado por la presencia de muchas sentencias @ref{1ec,,if}.

En entornos multi-hilos, el método LBYL tiene el riesgo de introducir condiciones de carrera entre los hilos que están «mirando» y los que están «saltando».  Por ejemplo, el código, @code{if key in mapping: return mapping[key]}  puede fallar si otro hilo remueve `key' de `mapping' después del test, pero antes de retornar el valor.  Este problema puede ser resuelto usando bloqueos o empleando el método EAFP.
@anchor{glossary term-list}@anchor{50b5}
@geindex lista

@item lista

A built-in Python @ref{597,,sequence}.  Despite its name it is more akin
to an array in other languages than to a linked list since access to
elements is `O'(1).
@anchor{glossary term-list-comprehension}@anchor{76e}
@geindex comprensión de listas

@item comprensión de listas

Una forma compacta de procesar todos o parte de los elementos en una secuencia y retornar una lista como resultado.  @code{result = ['@{:#04x@}'.format(x) for x in range(256) if x % 2 == 0]} genera una lista de cadenas conteniendo números hexadecimales (0x..) entre 0 y 255. La cláusula @ref{1ec,,if} es opcional.  Si es omitida, todos los elementos en @code{range(256)} son procesados.
@anchor{glossary term-loader}@anchor{16b8}
@geindex cargador

@item cargador

An object that loads a module. It must define a method named
@code{load_module()}. A loader is typically returned by a
@ref{1f1c,,finder}. See also:


@itemize *

@item 
@ref{1ff3,,Buscadores y cargadores}

@item 
@ref{f48,,importlib.abc.Loader}

@item 
@geindex Python Enhancement Proposals; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}
@end itemize
@anchor{glossary term-locale-encoding}@anchor{39b}
@geindex codificación de la configuración regional

@item codificación de la configuración regional

En Unix, es la codificación de la configuración regional LC_CTYPE. Se puede configurar con @ref{1d2,,locale.setlocale(locale.LC_CTYPE@comma{} new_locale)}.

En Windows, es la página de códigos ANSI (por ejemplo, @code{"cp1252"}).

En Android y VxWorks, Python utiliza @code{"utf-8"} como codificación regional.

@ref{1d3,,locale.getencoding()} can be used to get the locale encoding.

Vea también @ref{5dd,,filesystem encoding and error handler}.
@anchor{glossary term-magic-method}@anchor{4021}
@geindex método mágico

@item método mágico

@geindex magic;método

Una manera informal de llamar a un @ref{18b4,,special method}.
@anchor{glossary term-mapping}@anchor{1229}
@geindex mapeado

@item mapeado

Un objeto contenedor que permite recupero de claves arbitrarias y que implementa los métodos especificados en la @ref{961,,collections.abc.Mapping} o @ref{1123,,collections.abc.MutableMapping} @ref{90f,,abstract base classes}.  Por ejemplo, @ref{190,,dict}, @ref{122a,,collections.defaultdict}, @ref{67c,,collections.OrderedDict} y @ref{110e,,collections.Counter}.
@anchor{glossary term-meta-path-finder}@anchor{10ec}
@geindex meta buscadores de ruta

@item meta buscadores de ruta

Un @ref{1f1c,,finder} retornado por una búsqueda de @ref{db2,,sys.meta_path}.  Los meta buscadores de ruta están relacionados a @ref{10ed,,buscadores de entradas de rutas}, pero son algo diferente.

Vea en @ref{905,,importlib.abc.MetaPathFinder} los métodos que los meta buscadores de ruta implementan.
@anchor{glossary term-metaclass}@anchor{1f86}
@geindex metaclase

@item metaclase

La clase de una clase.  Las definiciones de clases crean nombres de clase, un diccionario de clase, y una lista de clases base.  Las metaclases son responsables de tomar estos tres argumentos y crear la clase.  La mayoría de los objetos de un lenguaje de programación orientado a objetos provienen de una implementación por defecto.  Lo que hace a Python especial que es posible crear metaclases a medida.  La mayoría de los usuario nunca necesitarán esta herramienta, pero cuando la necesidad surge, las metaclases pueden brindar soluciones poderosas y elegantes.  Han sido usadas para `loggear' acceso de atributos, agregar seguridad a hilos, rastrear la creación de objetos, implementar `singletons', y muchas otras tareas.

Más información hallará en @ref{1f73,,Metaclases}.
@anchor{glossary term-method}@anchor{50aa}
@geindex método

@item método

Una función que es definida dentro del cuerpo de una clase.  Si es llamada como un atributo de una instancia de otra clase, el método tomará el objeto instanciado como su primer @ref{4f6,,argument} (el cual es usualmente denominado @cite{self}). Vea @ref{2054,,function} y @ref{1f3f,,nested scope}.
@anchor{glossary term-method-resolution-order}@anchor{2188}
@geindex orden de resolución de métodos

@item orden de resolución de métodos

Method Resolution Order is the order in which base classes are searched
for a member during lookup. See @ref{14e6,,The Python 2.3 Method Resolution Order} for details of the
algorithm used by the Python interpreter since the 2.3 release.
@anchor{glossary term-module}@anchor{166a}
@geindex módulo

@item módulo

Un objeto que sirve como unidad de organización del código Python.  Los módulos tienen espacios de nombres conteniendo objetos Python arbitrarios.  Los módulos son cargados en Python por el proceso de @ref{1fea,,importing}.

Vea también @ref{185,,package}.
@anchor{glossary term-module-spec}@anchor{1f15}
@geindex especificador de módulo

@item especificador de módulo

Un espacio de nombres que contiene la información relacionada a la importación usada al leer un módulo.  Una instancia de  @ref{1e69,,importlib.machinery.ModuleSpec}.

See also @ref{1f18,,Module specs}.
@anchor{glossary term-MRO}@anchor{3541}
@geindex MRO

@item MRO

Vea @ref{2188,,method resolution order}.
@anchor{glossary term-mutable}@anchor{1c08}
@geindex mutable

@item mutable

Los objetos mutables pueden cambiar su valor pero mantener su @ref{1462,,id()}.  Vea también @ref{1c03,,immutable}.
@anchor{glossary term-named-tuple}@anchor{6ef}
@geindex tupla nombrada

@item tupla nombrada

La denominación «tupla nombrada» se aplica a cualquier tipo o clase que hereda de una tupla y cuyos elementos indexables son también accesibles usando atributos nombrados. Este tipo o clase puede tener además otras capacidades.

Varios tipos incorporados son tuplas nombradas, incluyendo los valores retornados por @ref{1539,,time.localtime()} y @ref{548,,os.stat()}.  Otro ejemplo es @ref{19f4,,sys.float_info}:

@example
>>> sys.float_info[1]                   # indexed access
1024
>>> sys.float_info.max_exp              # named field access
1024
>>> isinstance(sys.float_info, tuple)   # kind of tuple
True
@end example

Some named tuples are built-in types (such as the above examples).
Alternatively, a named tuple can be created from a regular class
definition that inherits from @ref{464,,tuple} and that defines named
fields.  Such a class can be written by hand, or it can be created by
inheriting @ref{1db,,typing.NamedTuple}, or with the factory function
@ref{32d,,collections.namedtuple()}.  The latter techniques also add some
extra methods that may not be found in hand-written or built-in named
tuples.
@anchor{glossary term-namespace}@anchor{1c5e}
@geindex espacio de nombres

@item espacio de nombres

El lugar donde la variable es almacenada.  Los espacios de nombres son implementados como diccionarios.  Hay espacio de nombre local, global, e incorporado así como espacios de nombres anidados en objetos (en métodos).  Los espacios de nombres soportan modularidad previniendo conflictos de nombramiento.  Por ejemplo, las funciones @ref{1be,,builtins.open} y @ref{e18,,os.open()} se distinguen por su espacio de nombres.  Los espacios de nombres también ayuda a la legibilidad y mantenibilidad dejando claro qué módulo implementa una función.  Por ejemplo, escribiendo @ref{12e1,,random.seed()} o @ref{bd4,,itertools.islice()} queda claro que éstas funciones están implementadas en los módulos @ref{b8,,random} y @ref{81,,itertools}, respectivamente.
@anchor{glossary term-namespace-package}@anchor{1b8}
@geindex paquete de espacios de nombres

@item paquete de espacios de nombres

Un 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} @ref{185,,package} que sirve sólo para contener subpaquetes.  Los paquetes de espacios de nombres pueden no tener representación física, y específicamente se diferencian de los @ref{1fee,,regular package} porque no tienen un archivo @code{__init__.py}.

Vea también @ref{166a,,module}.
@anchor{glossary term-nested-scope}@anchor{1f3f}
@geindex alcances anidados

@item alcances anidados

La habilidad de referirse a una variable dentro de una definición encerrada.  Por ejemplo, una función definida dentro de otra función puede referir a variables en la función externa.  Note que los alcances anidados por defecto sólo funcionan para referencia y no para asignación.  Las variables locales leen y escriben sólo en el alcance más interno.  De manera semejante, las variables globales pueden leer y escribir en el espacio de nombres global.  Con @ref{1313,,nonlocal} se puede escribir en alcances exteriores.
@anchor{glossary term-new-style-class}@anchor{2884}
@geindex clase de nuevo estilo

@item clase de nuevo estilo

Old name for the flavor of classes now used for all class objects.  In
earlier Python versions, only new-style classes could use Python’s newer,
versatile features like @ref{152a,,__slots__}, descriptors,
properties, @ref{c5a,,__getattribute__()}, class methods, and static
methods.
@anchor{glossary term-object}@anchor{50b6}
@geindex objeto

@item objeto

Cualquier dato con estado (atributo o valor) y comportamiento definido (métodos).  También es la más básica clase base para cualquier @ref{2884,,new-style class}.
@anchor{glossary term-optimized-scope}@anchor{2e9}
@geindex optimized scope

@item optimized scope

A scope where target local variable names are reliably known to the
compiler when the code is compiled, allowing optimization of read and
write access to these names. The local namespaces for functions,
generators, coroutines, comprehensions, and generator expressions are
optimized in this fashion. Note: most interpreter optimizations are
applied to all scopes, only those relying on a known set of local
and nonlocal variable names are restricted to optimized scopes.
@anchor{glossary term-package}@anchor{185}
@geindex paquete

@item paquete

Un @ref{166a,,module} Python que puede contener submódulos o recursivamente, subpaquetes.  Técnicamente, un paquete es un módulo Python con un atributo @code{__path__}.

Vea también @ref{1fee,,regular package} y @ref{1b8,,namespace package}.
@anchor{glossary term-parameter}@anchor{1efc}
@geindex parámetro

@item parámetro

Una entidad nombrada en una definición de una @ref{2054,,function} (o método) que especifica un @ref{4f6,,argument} (o en algunos casos, varios argumentos) que la función puede aceptar.  Existen cinco tipos de argumentos:


@itemize *

@item 
`posicional o nombrado': especifica un argumento que puede ser pasado tanto como @ref{4f6,,posicional} o como @ref{4f6,,nombrado}.  Este es el tipo por defecto de parámetro, como `foo' y `bar' en el siguiente ejemplo:

@example
def func(foo, bar=None): ...
@end example
@end itemize
@anchor{glossary positional-only-parameter}@anchor{b12}

@itemize *

@item 
`sólo posicional': especifica un argumento que puede ser pasado sólo por posición.  Los parámetros sólo posicionales pueden ser definidos incluyendo un carácter @code{/} en la lista de parámetros de la función después de ellos, como `posonly1' y `posonly2' en el ejemplo que sigue:

@example
def func(posonly1, posonly2, /, positional_or_keyword): ...
@end example
@end itemize
@anchor{glossary keyword-only-parameter}@anchor{3f4}

@itemize *

@item 
`sólo nombrado': especifica un argumento que sólo puede ser pasado por nombre.  Los parámetros sólo por nombre pueden ser definidos incluyendo un parámetro posicional de una sola variable o un simple @code{*`} antes de ellos en la lista de parámetros en la definición de la función, como `kw_only1' y `kw_only2' en el ejemplo siguiente:

@example
def func(arg, *, kw_only1, kw_only2): ...
@end example

@item 
`variable posicional': especifica una secuencia arbitraria de argumentos posicionales que pueden ser brindados (además de cualquier argumento posicional aceptado por otros parámetros).  Este parámetro puede ser definido anteponiendo al nombre del parámetro @code{*}, como a `args' en el siguiente ejemplo:

@example
def func(*args, **kwargs): ...
@end example

@item 
`variable nombrado': especifica que arbitrariamente muchos argumentos nombrados pueden ser brindados (además de cualquier argumento nombrado ya aceptado por cualquier otro parámetro).  Este parámetro puede ser definido anteponiendo al nombre del parámetro con @code{**}, como `kwargs' en el ejemplo precedente.
@end itemize

Los parámetros puede especificar tanto argumentos opcionales como requeridos, así como valores por defecto para algunos argumentos opcionales.

Vea también el glosario de @ref{4f6,,argument}, la pregunta respondida en @ref{4fef,,la diferencia entre argumentos y parámetros}, la clase @ref{333,,inspect.Parameter}, la sección @ref{1c3d,,Definiciones de funciones} , y 
@geindex Python Enhancement Proposals; PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}.
@anchor{glossary term-path-entry}@anchor{2004}
@geindex entrada de ruta

@item entrada de ruta

Una ubicación única en el @ref{1ff6,,import path} que el @ref{1ff9,,path based finder} consulta para encontrar los módulos a importar.
@anchor{glossary term-path-entry-finder}@anchor{10ed}
@geindex buscador de entradas de ruta

@item buscador de entradas de ruta

Un @ref{1f1c,,finder} retornado por un invocable en @ref{10a0,,sys.path_hooks} (esto es, un @ref{2006,,path entry hook}) que sabe cómo localizar módulos dada una @ref{2004,,path entry}.

Vea en @ref{906,,importlib.abc.PathEntryFinder} los métodos que los buscadores de entradas de ruta implementan.
@anchor{glossary term-path-entry-hook}@anchor{2006}
@geindex gancho a entrada de ruta

@item gancho a entrada de ruta

A callable on the @ref{10a0,,sys.path_hooks} list which returns a @ref{10ed,,path entry finder} if it knows how to find modules on a specific @ref{2004,,path entry}.
@anchor{glossary term-path-based-finder}@anchor{1ff9}
@geindex buscador basado en ruta

@item buscador basado en ruta

Uno de los @ref{10ec,,meta buscadores de ruta} por defecto que busca un @ref{1ff6,,import path} para los módulos.
@anchor{glossary term-path-like-object}@anchor{3f0}
@geindex objeto tipo ruta

@item objeto tipo ruta

Un objeto que representa una ruta del sistema de archivos. Un objeto tipo ruta puede ser tanto una @ref{237,,str} como un @ref{325,,bytes} representando una ruta, o un objeto que implementa el protocolo @ref{cd9,,os.PathLike}. Un objeto que soporta el protocolo  @ref{cd9,,os.PathLike} puede ser convertido a ruta del sistema de archivo de clase @ref{237,,str} o @ref{325,,bytes} usando la función @ref{cdb,,os.fspath()}; @ref{cdc,,os.fsdecode()} @ref{cdd,,os.fsencode()} pueden emplearse para garantizar que retorne respectivamente @ref{237,,str} o @ref{325,,bytes}. Introducido por 
@geindex Python Enhancement Proposals; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}.
@anchor{glossary term-PEP}@anchor{50b7}
@geindex PEP

@item PEP

Propuesta de mejora de Python, del inglés `Python Enhancement Proposal'. Un PEP es un documento de diseño que brinda información a la comunidad Python, o describe una nueva capacidad para Python, sus procesos o entorno. Los PEPs deberían dar una especificación técnica concisa y una fundamentación para las capacidades propuestas.

Los PEPs tienen como propósito ser los mecanismos primarios para proponer nuevas y mayores capacidad, para recoger la opinión de la comunidad sobre un tema, y para documentar las decisiones de diseño que se han hecho en Python. El autor del PEP es el responsable de lograr consenso con la comunidad y documentar las opiniones disidentes.

Vea 
@geindex Python Enhancement Proposals; PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/}.
@anchor{glossary term-portion}@anchor{1ff0}
@geindex porción

@item porción

Un conjunto de archivos en un único directorio (posiblemente guardo en un archivo comprimido `zip') que contribuye a un espacio de nombres de paquete, como está definido en 
@geindex Python Enhancement Proposals; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}.
@anchor{glossary term-positional-argument}@anchor{d9a}
@geindex argumento posicional

@item argumento posicional

Vea @ref{4f6,,argument}.
@anchor{glossary term-provisional-API}@anchor{b8e}
@geindex API provisional

@item API provisional

Una API provisoria es aquella que deliberadamente fue excluida de las garantías de compatibilidad hacia atrás de la biblioteca estándar.  Aunque no se esperan cambios fundamentales en dichas interfaces, como están marcadas como provisionales, los cambios incompatibles hacia atrás (incluso remover la misma interfaz) podrían ocurrir si los desarrolladores principales lo estiman.  Estos cambios no se hacen gratuitamente – solo ocurrirán si fallas fundamentales y serias son descubiertas que no fueron vistas antes de la inclusión de la API.

Incluso para APIs provisorias, los cambios incompatibles hacia atrás son vistos como una «solución de último recurso» - se intentará todo para encontrar una solución compatible hacia atrás para los problemas identificados.

Este proceso permite que la biblioteca estándar continúe evolucionando con el tiempo, sin bloquearse por errores de diseño problemáticos por períodos extensos de tiempo. Vea 
@geindex Python Enhancement Proposals; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para más detalles.
@anchor{glossary term-provisional-package}@anchor{10bd}
@geindex paquete provisorio

@item paquete provisorio

Vea @ref{b8e,,provisional API}.
@anchor{glossary term-Python-3000}@anchor{50b8}
@geindex Python 3000

@item Python 3000

Apodo para la fecha de lanzamiento de Python 3.x (acuñada en un tiempo cuando llegar a la versión 3 era algo distante en el futuro.)  También se lo abrevió como `Py3k'.
@anchor{glossary term-Pythonic}@anchor{50b9}
@geindex Pythónico

@item Pythónico

Una idea o pieza de código que sigue ajustadamente la convenciones idiomáticas comunes del lenguaje Python, en vez de implementar código usando conceptos comunes a otros lenguajes.  Por ejemplo, una convención común en Python es hacer bucles sobre todos los elementos de un iterable con la sentencia @ref{1eb,,for}.  Muchos otros lenguajes no tienen este tipo de construcción, así que los que no están familiarizados con Python podrían usar contadores numéricos:

@example
for i in range(len(food)):
    print(food[i])
@end example

En contraste, un método Pythónico más limpio:

@example
for piece in food:
    print(piece)
@end example
@anchor{glossary term-qualified-name}@anchor{194a}
@geindex nombre calificado

@item nombre calificado

Un nombre con puntos mostrando la ruta desde el alcance global del módulo a la clase, función o método definido en dicho módulo, como se define en 
@geindex Python Enhancement Proposals; PEP 3155
PEP 3155@footnote{https://peps.python.org/pep-3155/}.  Para las funciones o clases de más alto nivel, el nombre calificado es el igual al nombre del objeto:

@example
>>> class C:
...     class D:
...         def meth(self):
...             pass
...
>>> C.__qualname__
'C'
>>> C.D.__qualname__
'C.D'
>>> C.D.meth.__qualname__
'C.D.meth'
@end example

Cuando es usado para referirse a los módulos, `nombre completamente calificado' significa la ruta con puntos completo al módulo, incluyendo cualquier paquete padre, por ejemplo, @code{email.mime.text}:

@example
>>> import email.mime.text
>>> email.mime.text.__name__
'email.mime.text'
@end example
@anchor{glossary term-reference-count}@anchor{4859}
@geindex contador de referencias

@item contador de referencias

The number of references to an object.  When the reference count of an
object drops to zero, it is deallocated.  Some objects are
@ref{429d,,immortal} and have reference counts that are never modified, and
therefore the objects are never deallocated.  Reference counting is
generally not visible to Python code, but it is a key element of the
@ref{796,,CPython} implementation.  Programmers can call the
@ref{429c,,sys.getrefcount()} function to return the
reference count for a particular object.
@anchor{glossary term-regular-package}@anchor{1fee}
@geindex paquete regular

@item paquete regular

Un  @ref{185,,package} tradicional, como aquellos con un directorio conteniendo el archivo @code{__init__.py}.

Vea también @ref{1b8,,namespace package}.
@anchor{glossary term-REPL}@anchor{2d6}
@geindex REPL

@item REPL

An acronym for the «read–eval–print loop», another name for the
@ref{2d5,,interactive} interpreter shell.
@anchor{glossary term-__slots__}@anchor{680}
@geindex __slots__

@item __slots__

Es una declaración dentro de una clase que ahorra memoria predeclarando espacio para las atributos de la instancia y eliminando diccionarios de la instancia.  Aunque es popular, esta técnica es algo dificultosa de lograr correctamente y es mejor reservarla para los casos raros en los que existen grandes cantidades de instancias en aplicaciones con uso crítico de memoria.
@anchor{glossary term-sequence}@anchor{597}
@geindex secuencia

@item secuencia

An @ref{1294,,iterable} which supports efficient element access using integer
indices via the @ref{3d8,,__getitem__()} special method and defines a
@ref{1f62,,__len__()} method that returns the length of the sequence.
Some built-in sequence types are @ref{18e,,list}, @ref{237,,str},
@ref{464,,tuple}, and @ref{325,,bytes}. Note that @ref{190,,dict} also
supports @ref{3d8,,__getitem__()} and @code{__len__()}, but is considered a
mapping rather than a sequence because the lookups use arbitrary
@ref{6b1,,hashable} keys rather than integers.

The @ref{1231,,collections.abc.Sequence} abstract base class
defines a much richer interface that goes beyond just
@ref{3d8,,__getitem__()} and @ref{1f62,,__len__()}, adding
@code{count()}, @code{index()}, @ref{1f5d,,__contains__()}, and
@ref{1f5c,,__reversed__()}. Types that implement this expanded
interface can be registered explicitly using
@ref{1105,,register()}. For more documentation on sequence
methods generally, see
@ref{21b3,,Common Sequence Operations}.
@anchor{glossary term-set-comprehension}@anchor{50ba}
@geindex comprensión de conjuntos

@item comprensión de conjuntos

Una forma compacta de procesar todos o parte de los elementos en un iterable y retornar un conjunto con los resultados. @code{results = @{c for c in 'abracadabra' if c not in 'abc'@}} genera el conjunto de cadenas @code{@{'r', 'd'@}}. Ver @ref{671,,Despliegues para listas@comma{} conjuntos y diccionarios}.
@anchor{glossary term-single-dispatch}@anchor{a84}
@geindex despacho único

@item despacho único

Una forma de despacho de una @ref{a83,,generic function} donde la implementación es elegida a partir del tipo de un sólo argumento.
@anchor{glossary term-slice}@anchor{2185}
@geindex rebanada

@item rebanada

Un objeto que contiene una porción de una @ref{597,,sequence}.  Una rebanada es creada usando la notación de suscripto, @code{[]} con dos puntos entre los números cuando se ponen varios, como en @code{nombre_variable[1:3:5]}.  La notación con corchete (suscrito) usa internamente objetos @ref{514,,slice}.
@anchor{glossary term-soft-deprecated}@anchor{1c4}
@geindex soft deprecated

@item soft deprecated

A soft deprecated API should not be used in new code,
but it is safe for already existing code to use it.
The API remains documented and tested, but will not be enhanced further.

Soft deprecation, unlike normal deprecation, does not plan on removing the API
and will not emit warnings.

See PEP 387: Soft Deprecation@footnote{https://peps.python.org/pep-0387/#soft-deprecation}.
@anchor{glossary term-special-method}@anchor{18b4}
@geindex método especial

@item método especial

@geindex special;método

Un método que es llamado implícitamente por Python cuando ejecuta ciertas operaciones en un tipo, como la adición.  Estos métodos tienen nombres que comienzan y terminan con doble barra baja.  Los métodos especiales están documentados en @ref{cf6,,Nombres especiales de método}.
@anchor{glossary term-statement}@anchor{2777}
@geindex sentencia

@item sentencia

Una sentencia es parte de un conjunto (un «bloque» de código).  Una sentencia tanto es una @ref{1f85,,expression}  como alguna de las varias sintaxis usando una palabra clave, como @ref{1ec,,if}, @ref{1611,,while} o @ref{1eb,,for}.
@anchor{glossary term-static-type-checker}@anchor{3c4}
@geindex static type checker

@item static type checker

An external tool that reads Python code and analyzes it, looking for
issues such as incorrect types. See also @ref{1f81,,type hints}
and the @ref{104,,typing} module.
@anchor{glossary term-strong-reference}@anchor{431}
@geindex referencia fuerte

@item referencia fuerte

En la API de C de Python, una referencia fuerte es una referencia a un objeto que es propiedad del código que mantiene la referencia.  La referencia fuerte se toma llamando a @ref{612,,Py_INCREF()} cuando se crea la referencia y se libera con @ref{613,,Py_DECREF()} cuando se elimina la referencia.

La función @ref{932,,Py_NewRef()} se puede utilizar para crear una referencia fuerte a un objeto. Por lo general, se debe llamar a la función @ref{613,,Py_DECREF()} en la referencia fuerte antes de salir del alcance de la referencia fuerte, para evitar filtrar una referencia.

Consulte también @ref{432,,borrowed reference}.
@anchor{glossary term-text-encoding}@anchor{2180}
@geindex codificación de texto

@item codificación de texto

Una cadena de caracteres en Python es una secuencia de puntos de código Unicode (en el rango @code{U+0000}–@code{U+10FFFF}). Para almacenar o transferir una cadena de caracteres, es necesario serializarla como una secuencia de bytes.

La serialización de una cadena de caracteres en una secuencia de bytes se conoce como «codificación», y la recreación de la cadena de caracteres a partir de la secuencia de bytes se conoce como «decodificación».

Existe una gran variedad de serializaciones de texto @ref{e3e,,codecs}, que se denominan colectivamente «codificaciones de texto».
@anchor{glossary term-text-file}@anchor{1c8d}
@geindex archivo de texto

@item archivo de texto

Un @ref{1230,,file object} capaz de leer y escribir objetos @ref{237,,str}. Frecuentemente, un archivo de texto también accede a un flujo de datos binario y maneja automáticamente el @ref{2180,,text encoding}. Ejemplos de archivos de texto que son abiertos en modo texto (@code{'r'} o @code{'w'}), @ref{5df,,sys.stdin}, @ref{b61,,sys.stdout}, y las instancias de @ref{fa9,,io.StringIO}.

Vea también @ref{1c8e,,binary file} por objeto de archivos capaces de leer y escribir @ref{db4,,objeto tipo binario}.
@anchor{glossary term-triple-quoted-string}@anchor{50bb}
@geindex cadena con triple comilla

@item cadena con triple comilla

Una cadena que está enmarcada por tres instancias de comillas (») o apostrofes (“).  Aunque no brindan ninguna funcionalidad que no está disponible usando cadenas con comillas simple, son útiles por varias razones.  Permiten incluir comillas simples o dobles sin escapar dentro de las cadenas y pueden abarcar múltiples líneas sin el uso de caracteres de continuación, haciéndolas particularmente útiles para escribir docstrings.
@anchor{glossary term-type}@anchor{193c}
@geindex tipo

@item tipo

The type of a Python object determines what kind of object it is; every
object has a type.  An object’s type is accessible as its
@ref{14e9,,__class__} attribute or can be retrieved with
@code{type(obj)}.
@anchor{glossary term-type-alias}@anchor{4e7}
@geindex alias de tipos

@item alias de tipos

Un sinónimo para un tipo, creado al asignar un tipo a un identificador.

Los alias de tipos son útiles para simplificar los @ref{1f81,,indicadores de tipo}. Por ejemplo:

@example
def remove_gray_shades(
        colors: list[tuple[int, int, int]]) -> list[tuple[int, int, int]]:
    pass
@end example

podría ser más legible así:

@example
Color = tuple[int, int, int]

def remove_gray_shades(colors: list[Color]) -> list[Color]:
    pass
@end example

Vea @ref{104,,typing} y 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, que describen esta funcionalidad.
@anchor{glossary term-type-hint}@anchor{1f81}
@geindex indicador de tipo

@item indicador de tipo

Una  @ref{140,,annotation} que especifica el tipo esperado para una variable, un atributo de clase, un parámetro para una función o un valor de retorno.

Type hints are optional and are not enforced by Python but
they are useful to @ref{3c4,,static type checkers}.
They can also aid IDEs with code completion and refactoring.

Los indicadores de tipo de las variables globales, atributos de clase, y funciones, no de variables locales, pueden ser accedidos usando @ref{752,,typing.get_type_hints()}.

Vea @ref{104,,typing} y 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, que describen esta funcionalidad.
@anchor{glossary term-universal-newlines}@anchor{dc1}
@geindex saltos de líneas universales

@item saltos de líneas universales

Una manera de interpretar flujos de texto en la cual son reconocidos como finales de línea todas siguientes formas: la convención de Unix para fin de línea @code{'\n'}, la convención de Windows @code{'\r\n'}, y la vieja convención de Macintosh @code{'\r'}.  Vea 
@geindex Python Enhancement Proposals; PEP 278
PEP 278@footnote{https://peps.python.org/pep-0278/} y 
@geindex Python Enhancement Proposals; PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/}, además de @ref{221b,,bytes.splitlines()} para usos adicionales.
@anchor{glossary term-variable-annotation}@anchor{ddb}
@geindex anotación de variable

@item anotación de variable

Una @ref{140,,annotation} de una variable o un atributo de clase.

Cuando se anota una variable o un atributo de clase, la asignación es opcional:

@example
class C:
    field: 'annotation'
@end example

Las anotaciones de variables son frecuentemente usadas para @ref{1f81,,type hints}: por ejemplo, se espera que esta variable tenga valores de clase @ref{1f0,,int}:

@example
count: int = 0
@end example

La sintaxis de la anotación de variables está explicada en la sección @ref{20a3,,Declaraciones de asignación anotadas}.

Consulte @ref{1c3e,,function annotation}, 
@geindex Python Enhancement Proposals; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} y 
@geindex Python Enhancement Proposals; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, que describen esta funcionalidad. Consulte también @ref{870,,Prácticas recomendadas para las anotaciones} para conocer las mejores prácticas sobre cómo trabajar con anotaciones.
@anchor{glossary term-virtual-environment}@anchor{1d08}
@geindex entorno virtual

@item entorno virtual

Un entorno cooperativamente aislado de ejecución que permite a los usuarios de Python y a las aplicaciones instalar y actualizar paquetes de distribución de Python sin interferir con el comportamiento de otras aplicaciones de Python en el mismo sistema.

Vea también @ref{111,,venv}.
@anchor{glossary term-virtual-machine}@anchor{3443}
@geindex máquina virtual

@item máquina virtual

Una computadora definida enteramente por software.  La máquina virtual de Python ejecuta el @ref{2f2,,bytecode} generado por el compilador de `bytecode'.
@anchor{glossary term-Zen-of-Python}@anchor{50bc}
@geindex Zen de Python

@item Zen de Python

Un listado de los principios de diseño y la filosofía de Python que son útiles para entender y usar el lenguaje.  El listado puede encontrarse ingresando  «@code{import this}» en la consola interactiva.
@end table

@node Acerca de estos documentos,Lidiar con errores,Glosario,Top
@anchor{about doc}@anchor{50bd}@anchor{about about-these-documents}@anchor{50be}
@chapter Acerca de estos documentos


Estos documentos son generados por reStructuredText@footnote{https://docutils.sourceforge.io/rst.html} desarrollado por Sphinx@footnote{https://www.sphinx-doc.org/}, un procesador de documentos específicamente escrito para la documentación de Python.

@c In the online version of these documents, you can submit comments and suggest
@c changes directly on the documentation pages.

El desarrollo de la documentación y su cadena de herramientas es un esfuerzo enteramente voluntario, al igual que Python. Si tu quieres contribuir, por favor revisa la página @ref{48a9,,Lidiar con errores} para más información de cómo hacerlo. Los nuevos voluntarios son siempre bienvenidos!

Agradecemos a:


@itemize *

@item 
Fred L. Drake, Jr., el creador original de la documentación del conjunto de herramientas de Python y escritor de gran parte del contenido;

@item 
el proyecto Docutils@footnote{https://docutils.sourceforge.io/} para creación de reStructuredText y la suite Docutils;

@item 
Fredrik Lundh por su proyecto Referencia Alternativa de Python del que Sphinx obtuvo muchas buenas ideas.
@end itemize

@menu
* Contribuidores de la documentación de Python:: 

@end menu

@node Contribuidores de la documentación de Python,,,Acerca de estos documentos
@anchor{about contributors-to-the-python-documentation}@anchor{50bf}
@section Contribuidores de la documentación de Python


Muchas personas han contribuido para el lenguaje de Python, la librería estándar de Python, y la documentación de Python. Revisa Misc/ACKS@footnote{https://github.com/python/cpython/tree/main/Misc/ACKS} la distribución de Python para una lista parcial de contribuidores.

Es solamente con la aportación y contribuciones de la comunidad de Python que Python tiene tan fantástica documentación –  Muchas gracias!

@node Lidiar con errores,Derechos de autor,Acerca de estos documentos,Top
@anchor{bugs doc}@anchor{50c0}@anchor{bugs dealing-with-bugs}@anchor{50c1}@anchor{bugs reporting-bugs}@anchor{48a9}
@chapter Lidiar con errores


Python es un lenguaje de programación maduro que ha establecido una reputación de estabilidad.  Con el fin de mantener esta reputación, a los desarrolladores les gustaría conocer cualquier anomalía que encuentre en Python.

A veces puede ser más rápido corregir errores y añadir parches a Python, ya que agiliza el proceso e involucra a menos personas. Aprenda a @ref{50c2,,contribuir}.

@menu
* Documentación de errores:: 
* Utilizar el issue tracker de Python:: 
* Para empezar a contribuir en Python:: 

@end menu

@node Documentación de errores,Utilizar el issue tracker de Python,,Lidiar con errores
@anchor{bugs documentation-bugs}@anchor{50c3}
@section Documentación de errores


If you find a bug in this documentation or would like to propose an improvement,
please submit a bug report on the @ref{3a7,,issue tracker}.  If you
have a suggestion on how to fix it, include that as well.

También puede abrir una discusión en nuestro foro de Documentación de Discourse@footnote{https://discuss.python.org/c/documentation/26}.

If you find a bug in the theme (HTML / CSS / JavaScript) of the
documentation, please submit a bug report on the python-doc-theme issue tracker@footnote{https://github.com/python/python-docs-theme}.


@subsubheading Ver también



@table @asis

@item @ref{50c3,,Documentación de errores}

Una lista de errores (`bugs') que ha sido enviada al issue tracker (sistema de seguimiento de incidentes) de Python.

@item Seguimiento de incidencias@footnote{https://devguide.python.org/tracker/}

Resumen general del proceso necesario para reportar una mejora en el tracker.

@item Ayudar con la documentación@footnote{https://devguide.python.org/docquality/#helping-with-documentation}

Guía detallada para gente interesada en contribuir a la documentación de Python.

@item Documentation Translations@footnote{https://devguide.python.org/documentation/translating/}

Una lista de páginas de GitHub para la traducción de documentación y sus contactos principales.
@end table


@node Utilizar el issue tracker de Python,Para empezar a contribuir en Python,Documentación de errores,Lidiar con errores
@anchor{bugs using-the-python-issue-tracker}@anchor{50c4}@anchor{bugs using-the-tracker}@anchor{3a7}
@section Utilizar el issue tracker de Python


Los informes de incidencias de Python deben enviarse a través del gestor de incidencias de GitHub (@indicateurl{https://github.com/python/cpython/issues}). El gestor de incidencias de GitHub ofrece un formulario web que permite introducir la información pertinente y enviarla a los desarrolladores.

El primer paso para completar un informe es determinar si el problema ya ha sido descrito previamente.  La ventaja de hacer esto, aparte de ahorrar tiempo a los desarrolladores, es que te permite aprender qué cambios se han realizado para repararlo; puede que el problema se haya reparado para la siguiente versión, o que sea necesaria información adicional (en ese caso, ¡te invitamos a incluirla si puedes!). Para hacerlo, busca en la base de datos de errores usando la zona de búsqueda al principio de esta página.

Si el problema del que informa no está ya en la lista, inicie sesión en GitHub. Si aún no tienes una cuenta en GitHub, crea una nueva a través del enlace «Regístrate». No es posible enviar un informe de error de forma anónima.

Ahora que has iniciado sesión, puedes enviar un informe de error. Haz clic en el botón «New issue» de la barra superior para notificar un nuevo informe de error.

El formulario de envío tiene dos campos: «Title» y «Comment».

En el campo «Title», introduzca una descripción `muy' breve del problema; menos de diez palabras es suficiente.

En el campo «Comment», describe el problema con detalle, incluyendo qué esperabas que ocurriera y que ha sucedido en realidad. Asegúrate de incluir si cualquier módulo de extensión está involucrado, y qué plataformas de hardware y software estás usando (incluyendo las versiones correspondientes).

Cada informe de error será asignado a un desarrollador que determinará qué es necesario hacer para corregir el problema. Recibirás una actualización cada vez que se tome una medida al respecto.


@subsubheading Ver también



@table @asis

@item Cómo informar de errores de manera efectiva@footnote{https://www.chiark.greenend.org.uk/~sgtatham/bugs.html}

Artículo que detalla cómo crear un informe de errores útil. Describe qué tipo de información es útil y por qué lo es.

@item Bug Writing Guidelines@footnote{https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html}

Información sobre cómo escribir un buen informe de errores. Parte de esta información es específica al proyecto Mozilla, pero en general describe buenas prácticas.
@end table


@node Para empezar a contribuir en Python,,Utilizar el issue tracker de Python,Lidiar con errores
@anchor{bugs contributing-to-python}@anchor{50c2}@anchor{bugs getting-started-contributing-to-python-yourself}@anchor{50c5}
@section Para empezar a contribuir en Python


Más allá de informar de los errores que puedas encontrar, te damos la bienvenida a enviar parches para corregirlos.  Puedes encontrar más información en cómo empezar parcheando Python  en la Python Developer's Guide@footnote{https://devguide.python.org/}. Si tienes preguntas, el core-mentorship mailing list@footnote{https://mail.python.org/mailman3/lists/core-mentorship.python.org/} es un agradable lugar para obtener respuestas a cualquiera y a todas las preguntas pertenecientes al proceso de corrección de problemas en Python.

@node Derechos de autor,Historia y Licencia,Lidiar con errores,Top
@anchor{copyright doc}@anchor{50c6}@anchor{copyright copyright}@anchor{50c7}
@chapter Derechos de autor


Python y esta documentación es:

Copyright © 2001 Python Software Foundation. All rights reserved.

Derechos de autor © 2000 BeOpen.com. Todos los derechos reservados.

Derechos de autor © 1995-2000 Corporation for National Research Initiatives. Todos los derechos reservados.

Derechos de autor © 1991-1995 Stichting Mathematisch Centrum.  Todos los derechos reservados.


__________________________________________________________________


Consulte @ref{50c8,,Historia y Licencia} para obtener información completa sobre licencias y permisos.

@node Historia y Licencia,Índice de Módulos Python,Derechos de autor,Top
@anchor{license doc}@anchor{50c9}@anchor{license history-and-license}@anchor{50c8}@anchor{license id1}@anchor{50ca}
@chapter Historia y Licencia


@menu
* Historia del software:: 
* Términos y condiciones para acceder o usar Python:: 
* Licencias y reconocimientos para software incorporado:: 

@end menu

@node Historia del software,Términos y condiciones para acceder o usar Python,,Historia y Licencia
@anchor{license history-of-the-software}@anchor{50cb}
@section Historia del software


Python fue creado a principios de la década de 1990 por Guido van Rossum en Stichting Mathematisch Centrum (CWI, ver @indicateurl{https://www.cwi.nl/}) en los Países Bajos como sucesor de un idioma llamado ABC. Guido sigue siendo el autor principal de Python, aunque incluye muchas contribuciones de otros.

En 1995, Guido continuó su trabajo en Python en la Corporation for National Research Initiatives (CNRI, consulte @indicateurl{https://www.cnri.reston.va.us/}) en Reston, Virginia, donde lanzó varias versiones del software.

En mayo de 2000, Guido y el equipo de desarrollo central de Python se trasladaron a BeOpen.com para formar el equipo de BeOpen PythonLabs. En octubre del mismo año, el equipo de PythonLabs se trasladó a Digital Creations (ahora Zope Corporation; consulte @indicateurl{https://www.zope.org/}). En 2001, se formó la Python Software Foundation (PSF, consulte @indicateurl{https://www.python.org/psf/}), una organización sin fines de lucro creada específicamente para poseer la propiedad intelectual relacionada con Python. Zope Corporation es miembro patrocinador del PSF.

Todas las versiones de Python son de código abierto (consulte @indicateurl{https://opensource.org/} para conocer la definición de código abierto). Históricamente, la mayoría de las versiones de Python, pero no todas, también han sido compatibles con GPL; la siguiente tabla resume las distintas versiones.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} 
@headitem

Lanzamiento

@tab

Derivado de

@tab

Año

@tab

Dueño/a

@tab

¿compatible con GPL?

@item

0.9.0 hasta 1.2

@tab

n/a

@tab

1991-1995

@tab

CWI

@tab

sí

@item

1.3 hasta 1.5.2

@tab

1.2

@tab

1995-1999

@tab

CNRI

@tab

sí

@item

1.6

@tab

1.5.2

@tab

2000

@tab

CNRI

@tab

no

@item

2.0

@tab

1.6

@tab

2000

@tab

BeOpen.com

@tab

no

@item

1.6.1

@tab

1.6

@tab

2001

@tab

CNRI

@tab

no

@item

2.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

no

@item

2.0.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

sí

@item

2.1.1

@tab

2.1+2.0.1

@tab

2001

@tab

PSF

@tab

sí

@item

2.1.2

@tab

2.1.1

@tab

2002

@tab

PSF

@tab

sí

@item

2.1.3

@tab

2.1.2

@tab

2002

@tab

PSF

@tab

sí

@item

2.2 y superior

@tab

2.1.1

@tab

2001-ahora

@tab

PSF

@tab

sí

@end multitable


@cartouche
@quotation Nota 
Compatible con GPL no significa que estemos distribuyendo Python bajo la GPL. Todas las licencias de Python, a diferencia de la GPL, le permiten distribuir una versión modificada sin que los cambios sean de código abierto. Las licencias compatibles con GPL permiten combinar Python con otro software que se publica bajo la GPL; los otros no lo hacen.
@end quotation
@end cartouche

Gracias a los muchos voluntarios externos que han trabajado bajo la dirección de Guido para hacer posibles estos lanzamientos.

@node Términos y condiciones para acceder o usar Python,Licencias y reconocimientos para software incorporado,Historia del software,Historia y Licencia
@anchor{license terms-and-conditions-for-accessing-or-otherwise-using-python}@anchor{50cc}
@section Términos y condiciones para acceder o usar Python


El software y la documentación de Python están sujetos a @ref{50cd,,Acuerdo de licencia de PSF}.

A partir de Python 3.8.6, los ejemplos, recetas y otros códigos de la documentación tienen licencia doble según el Acuerdo de licencia de PSF y la @ref{50ce,,Licencia BSD de cláusula cero}.

Parte del software incorporado en Python está bajo diferentes licencias. Las licencias se enumeran con el código correspondiente a esa licencia. Consulte @ref{50cf,,Licencias y reconocimientos para software incorporado} para obtener una lista incompleta de estas licencias.

@menu
* ACUERDO DE LICENCIA DE PSF PARA PYTHON | lanzamiento |:: 
* ACUERDO DE LICENCIA DE BEOPEN.COM PARA PYTHON 2.0: ACUERDO DE LICENCIA DE BEOPEN COM PARA PYTHON 2 0. 
* ACUERDO DE LICENCIA CNRI PARA PYTHON 1.6.1: ACUERDO DE LICENCIA CNRI PARA PYTHON 1 6 1. 
* ACUERDO DE LICENCIA CWI PARA PYTHON 0.9.0 HASTA 1.2: ACUERDO DE LICENCIA CWI PARA PYTHON 0 9 0 HASTA 1 2. 
* LICENCIA BSD DE CLÁUSULA CERO PARA CÓDIGO EN EL PYTHON | lanzamiento | DOCUMENTACIÓN:: 

@end menu

@node ACUERDO DE LICENCIA DE PSF PARA PYTHON | lanzamiento |,ACUERDO DE LICENCIA DE BEOPEN COM PARA PYTHON 2 0,,Términos y condiciones para acceder o usar Python
@anchor{license psf-license}@anchor{50cd}@anchor{license psf-license-agreement-for-python-release}@anchor{50d0}
@subsection ACUERDO DE LICENCIA DE PSF PARA PYTHON | lanzamiento |


@example
1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
   the Individual or Organization ("Licensee") accessing and otherwise using Python
   3.14.0a1 software in source or binary form and its associated documentation.

2. Subject to the terms and conditions of this License Agreement, PSF hereby
   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
   analyze, test, perform and/or display publicly, prepare derivative works,
   distribute, and otherwise use Python 3.14.0a1 alone or in any derivative
   version, provided, however, that PSF's License Agreement and PSF's notice of
   copyright, i.e., "Copyright © 2001 Python Software Foundation; All Rights
   Reserved" are retained in Python 3.14.0a1 alone or in any derivative version
   prepared by Licensee.

3. In the event Licensee prepares a derivative work that is based on or
   incorporates Python 3.14.0a1 or any part thereof, and wants to make the
   derivative work available to others as provided herein, then Licensee hereby
   agrees to include in any such work a brief summary of the changes made to Python
   3.14.0a1.

4. PSF is making Python 3.14.0a1 available to Licensee on an "AS IS" basis.
   PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
   EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
   USE OF PYTHON 3.14.0a1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 3.14.0a1
   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 3.14.0a1, OR ANY DERIVATIVE
   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

7. Nothing in this License Agreement shall be deemed to create any relationship
   of agency, partnership, or joint venture between PSF and Licensee.  This License
   Agreement does not grant permission to use PSF trademarks or trade name in a
   trademark sense to endorse or promote products or services of Licensee, or any
   third party.

8. By copying, installing or otherwise using Python 3.14.0a1, Licensee agrees
   to be bound by the terms and conditions of this License Agreement.
@end example

@node ACUERDO DE LICENCIA DE BEOPEN COM PARA PYTHON 2 0,ACUERDO DE LICENCIA CNRI PARA PYTHON 1 6 1,ACUERDO DE LICENCIA DE PSF PARA PYTHON | lanzamiento |,Términos y condiciones para acceder o usar Python
@anchor{license beopen-com-license-agreement-for-python-2-0}@anchor{50d1}
@subsection ACUERDO DE LICENCIA DE BEOPEN.COM PARA PYTHON 2.0


ACUERDO DE LICENCIA DE CÓDIGO ABIERTO DE BEOPEN PYTHON VERSIÓN 1

@example
1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office at
   160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization
   ("Licensee") accessing and otherwise using this software in source or binary
   form and its associated documentation ("the Software").

2. Subject to the terms and conditions of this BeOpen Python License Agreement,
   BeOpen hereby grants Licensee a non-exclusive, royalty-free, world-wide license
   to reproduce, analyze, test, perform and/or display publicly, prepare derivative
   works, distribute, and otherwise use the Software alone or in any derivative
   version, provided, however, that the BeOpen Python License is retained in the
   Software, alone or in any derivative version prepared by Licensee.

3. BeOpen is making the Software available to Licensee on an "AS IS" basis.
   BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
   EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
   USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR
   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING,
   MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF
   ADVISED OF THE POSSIBILITY THEREOF.

5. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

6. This License Agreement shall be governed by and interpreted in all respects
   by the law of the State of California, excluding conflict of law provisions.
   Nothing in this License Agreement shall be deemed to create any relationship of
   agency, partnership, or joint venture between BeOpen and Licensee.  This License
   Agreement does not grant permission to use BeOpen trademarks or trade names in a
   trademark sense to endorse or promote products or services of Licensee, or any
   third party.  As an exception, the "BeOpen Python" logos available at
   @indicateurl{http://www.pythonlabs.com/logos.html} may be used according to the permissions
   granted on that web page.

7. By copying, installing or otherwise using the software, Licensee agrees to be
   bound by the terms and conditions of this License Agreement.
@end example

@node ACUERDO DE LICENCIA CNRI PARA PYTHON 1 6 1,ACUERDO DE LICENCIA CWI PARA PYTHON 0 9 0 HASTA 1 2,ACUERDO DE LICENCIA DE BEOPEN COM PARA PYTHON 2 0,Términos y condiciones para acceder o usar Python
@anchor{license cnri-license-agreement-for-python-1-6-1}@anchor{50d2}
@subsection ACUERDO DE LICENCIA CNRI PARA PYTHON 1.6.1


@example
1. This LICENSE AGREEMENT is between the Corporation for National Research
   Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191
   ("CNRI"), and the Individual or Organization ("Licensee") accessing and
   otherwise using Python 1.6.1 software in source or binary form and its
   associated documentation.

2. Subject to the terms and conditions of this License Agreement, CNRI hereby
   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
   analyze, test, perform and/or display publicly, prepare derivative works,
   distribute, and otherwise use Python 1.6.1 alone or in any derivative version,
   provided, however, that CNRI's License Agreement and CNRI's notice of copyright,
   i.e., "Copyright © 1995-2001 Corporation for National Research Initiatives; All
   Rights Reserved" are retained in Python 1.6.1 alone or in any derivative version
   prepared by Licensee.  Alternately, in lieu of CNRI's License Agreement,
   Licensee may substitute the following text (omitting the quotes): "Python 1.6.1
   is made available subject to the terms and conditions in CNRI's License
   Agreement.  This Agreement together with Python 1.6.1 may be located on the
   internet using the following unique, persistent identifier (known as a handle):
   1895.22/1013.  This Agreement may also be obtained from a proxy server on the
   internet using the following URL: @indicateurl{http://hdl.handle.net/1895.22/1013}."

3. In the event Licensee prepares a derivative work that is based on or
   incorporates Python 1.6.1 or any part thereof, and wants to make the derivative
   work available to others as provided herein, then Licensee hereby agrees to
   include in any such work a brief summary of the changes made to Python 1.6.1.

4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" basis.  CNRI
   MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF EXAMPLE,
   BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY
   OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF
   PYTHON 1.6.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 1.6.1 FOR
   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, OR ANY DERIVATIVE
   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

7. This License Agreement shall be governed by the federal intellectual property
   law of the United States, including without limitation the federal copyright
   law, and, to the extent such U.S. federal law does not apply, by the law of the
   Commonwealth of Virginia, excluding Virginia's conflict of law provisions.
   Notwithstanding the foregoing, with regard to derivative works based on Python
   1.6.1 that incorporate non-separable material that was previously distributed
   under the GNU General Public License (GPL), the law of the Commonwealth of
   Virginia shall govern this License Agreement only as to issues arising under or
   with respect to Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in
   this License Agreement shall be deemed to create any relationship of agency,
   partnership, or joint venture between CNRI and Licensee.  This License Agreement
   does not grant permission to use CNRI trademarks or trade name in a trademark
   sense to endorse or promote products or services of Licensee, or any third
   party.

8. By clicking on the "ACCEPT" button where indicated, or by copying, installing
   or otherwise using Python 1.6.1, Licensee agrees to be bound by the terms and
   conditions of this License Agreement.
@end example

@node ACUERDO DE LICENCIA CWI PARA PYTHON 0 9 0 HASTA 1 2,LICENCIA BSD DE CLÁUSULA CERO PARA CÓDIGO EN EL PYTHON | lanzamiento | DOCUMENTACIÓN,ACUERDO DE LICENCIA CNRI PARA PYTHON 1 6 1,Términos y condiciones para acceder o usar Python
@anchor{license cwi-license-agreement-for-python-0-9-0-through-1-2}@anchor{50d3}
@subsection ACUERDO DE LICENCIA CWI PARA PYTHON 0.9.0 HASTA 1.2


@example
Copyright © 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The
Netherlands.  All rights reserved.

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided that
the above copyright notice appear in all copies and that both that copyright
notice and this permission notice appear in supporting documentation, and that
the name of Stichting Mathematisch Centrum or CWI not be used in advertising or
publicity pertaining to distribution of the software without specific, written
prior permission.

STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT
OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
@end example

@node LICENCIA BSD DE CLÁUSULA CERO PARA CÓDIGO EN EL PYTHON | lanzamiento | DOCUMENTACIÓN,,ACUERDO DE LICENCIA CWI PARA PYTHON 0 9 0 HASTA 1 2,Términos y condiciones para acceder o usar Python
@anchor{license bsd0}@anchor{50ce}@anchor{license zero-clause-bsd-license-for-code-in-the-python-release-documentation}@anchor{50d4}
@subsection LICENCIA BSD DE CLÁUSULA CERO PARA CÓDIGO EN EL PYTHON | lanzamiento | DOCUMENTACIÓN


@example
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
@end example

@node Licencias y reconocimientos para software incorporado,,Términos y condiciones para acceder o usar Python,Historia y Licencia
@anchor{license licenses-and-acknowledgements-for-incorporated-software}@anchor{50d5}@anchor{license otherlicenses}@anchor{50cf}
@section Licencias y reconocimientos para software incorporado


Esta sección es una lista incompleta, pero creciente, de licencias y reconocimientos para software de terceros incorporado en la distribución de Python.

@menu
* Mersenne Twister:: 
* Sockets: Sockets<2>. 
* Servicios de socket asincrónicos:: 
* Gestión de cookies:: 
* Seguimiento de ejecución:: 
* funciones UUencode y UUdecode:: 
* Llamadas a procedimientos remotos XML:: 
* test_epoll:: 
* Seleccionar kqueue:: 
* SipHash24:: 
* strtod y dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<3>. 
* cfuhash:: 
* libmpdec:: 
* Conjunto de pruebas W3C C14N:: 
* mimalloc:: 
* asyncio: asyncio<12>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 

@end menu

@node Mersenne Twister,Sockets<2>,,Licencias y reconocimientos para software incorporado
@anchor{license mersenne-twister}@anchor{50d6}
@subsection Mersenne Twister


La extensión C @code{_random} subyacente al módulo @ref{b8,,random} incluye código basado en una descarga de @indicateurl{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html}. Los siguientes son los comentarios textuales del código original:

@example
A C-program for MT19937, with initialization improved 2002/1/26.
Coded by Takuji Nishimura and Makoto Matsumoto.

Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).

Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

 3. The names of its contributors may not be used to endorse or promote
    products derived from this software without specific prior written
    permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Any feedback is very welcome.
http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
email: m-mat @@ math.sci.hiroshima-u.ac.jp (remove space)
@end example

@node Sockets<2>,Servicios de socket asincrónicos,Mersenne Twister,Licencias y reconocimientos para software incorporado
@anchor{license sockets}@anchor{50d7}
@subsection Sockets


El módulo @ref{cc,,socket} usa las funciones, @code{getaddrinfo()}, y @code{getnameinfo()}, que están codificadas en archivos fuente separados del Proyecto WIDE, @indicateurl{http://www.wide.ad.jp} /.

@example
Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of the project nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS `@w{`}AS IS'@w{'} AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node Servicios de socket asincrónicos,Gestión de cookies,Sockets<2>,Licencias y reconocimientos para software incorporado
@anchor{license asynchronous-socket-services}@anchor{50d8}
@subsection Servicios de socket asincrónicos


Los módulos @code{test.support.asynchat} y @code{test.support.asyncore} contienen el siguiente aviso:

@example
Copyright 1996 by Sam Rushing

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and
its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all
copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of Sam
Rushing not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior
permission.

SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
@end example

@node Gestión de cookies,Seguimiento de ejecución,Servicios de socket asincrónicos,Licencias y reconocimientos para software incorporado
@anchor{license cookie-management}@anchor{50d9}
@subsection Gestión de cookies


El módulo @ref{71,,http.cookies} contiene el siguiente aviso:

@example
Copyright 2000 by Timothy O'Malley <timo@@alum.mit.edu>

               All Rights Reserved

Permission to use, copy, modify, and distribute this software
and its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all
copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
Timothy O'Malley  not be used in advertising or publicity
pertaining to distribution of the software without specific, written
prior permission.

Timothy O'Malley DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS, IN NO EVENT SHALL Timothy O'Malley BE LIABLE FOR
ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
@end example

@node Seguimiento de ejecución,funciones UUencode y UUdecode,Gestión de cookies,Licencias y reconocimientos para software incorporado
@anchor{license execution-tracing}@anchor{50da}
@subsection Seguimiento de ejecución


El módulo @ref{fd,,trace} contiene el siguiente aviso:

@example
portions copyright 2001, Autonomous Zones Industries, Inc., all rights...
err...  reserved and offered to the public under the terms of the
Python 2.2 license.
Author: Zooko O'Whielacronx
http://zooko.com/
mailto:zooko@@zooko.com

Copyright 2000, Mojam Media, Inc., all rights reserved.
Author: Skip Montanaro

Copyright 1999, Bioreason, Inc., all rights reserved.
Author: Andrew Dalke

Copyright 1995-1997, Automatrix, Inc., all rights reserved.
Author: Skip Montanaro

Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved.


Permission to use, copy, modify, and distribute this Python software and
its associated documentation for any purpose without fee is hereby
granted, provided that the above copyright notice appears in all copies,
and that both that copyright notice and this permission notice appear in
supporting documentation, and that the name of neither Automatrix,
Bioreason or Mojam Media be used in advertising or publicity pertaining to
distribution of the software without specific, written prior permission.
@end example

@node funciones UUencode y UUdecode,Llamadas a procedimientos remotos XML,Seguimiento de ejecución,Licencias y reconocimientos para software incorporado
@anchor{license uuencode-and-uudecode-functions}@anchor{50db}
@subsection funciones UUencode y UUdecode


The @code{uu} codec contains the following notice:

@example
Copyright 1994 by Lance Ellinghouse
Cathedral City, California Republic, United States of America.
                       All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Lance Ellinghouse
not be used in advertising or publicity pertaining to distribution
of the software without specific, written prior permission.
LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Modified by Jack Jansen, CWI, July 1995:
- Use binascii module to do the actual line-by-line conversion
  between ascii and binary. This results in a 1000-fold speedup. The C
  version is still 5 times faster, though.
- Arguments more compliant with Python standard
@end example

@node Llamadas a procedimientos remotos XML,test_epoll,funciones UUencode y UUdecode,Licencias y reconocimientos para software incorporado
@anchor{license xml-remote-procedure-calls}@anchor{50dc}
@subsection Llamadas a procedimientos remotos XML


El módulo @ref{12d,,xmlrpc.client} contiene el siguiente aviso:

@example
    The XML-RPC client interface is

Copyright (c) 1999-2002 by Secret Labs AB
Copyright (c) 1999-2002 by Fredrik Lundh

By obtaining, using, and/or copying this software and/or its
associated documentation, you agree that you have read, understood,
and will comply with the following terms and conditions:

Permission to use, copy, modify, and distribute this software and
its associated documentation for any purpose and without fee is
hereby granted, provided that the above copyright notice appears in
all copies, and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
Secret Labs AB or the author not be used in advertising or publicity
pertaining to distribution of the software without specific, written
prior permission.

SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
OF THIS SOFTWARE.
@end example

@node test_epoll,Seleccionar kqueue,Llamadas a procedimientos remotos XML,Licencias y reconocimientos para software incorporado
@anchor{license test-epoll}@anchor{50dd}
@subsection test_epoll


El módulo @code{test.test_epoll} contiene el siguiente aviso:

@example
Copyright (c) 2001-2006 Twisted Matrix Laboratories.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node Seleccionar kqueue,SipHash24,test_epoll,Licencias y reconocimientos para software incorporado
@anchor{license select-kqueue}@anchor{50de}
@subsection Seleccionar kqueue


El módulo @ref{c1,,select} contiene el siguiente aviso para la interfaz kqueue:

@example
Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS `@w{`}AS IS'@w{'} AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node SipHash24,strtod y dtoa,Seleccionar kqueue,Licencias y reconocimientos para software incorporado
@anchor{license siphash24}@anchor{50df}
@subsection SipHash24


El archivo @code{Python/pyhash.c} contiene la implementación de Marek Majkowski del algoritmo SipHash24 de Dan Bernstein. Contiene la siguiente nota:

@example
<MIT License>
Copyright (c) 2013  Marek Majkowski <marek@@popcount.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</MIT License>

Original location:
   https://github.com/majek/csiphash/

Solution inspired by code from:
   Samuel Neves (supercop/crypto_auth/siphash24/little)
   djb (supercop/crypto_auth/siphash24/little2)
   Jean-Philippe Aumasson (https://131002.net/siphash/siphash24.c)
@end example

@node strtod y dtoa,OpenSSL<2>,SipHash24,Licencias y reconocimientos para software incorporado
@anchor{license strtod-and-dtoa}@anchor{50e0}
@subsection strtod y dtoa


El archivo @code{Python/dtoa.c}, que proporciona las funciones de C dtoa y strtod para la conversión de dobles C hacia y desde cadenas de caracteres, se deriva del archivo del mismo nombre por David M. Gay, actualmente disponible en @indicateurl{https://web.archive.org/web/20220517033456/http://www.netlib.org/fp/dtoa.c}. El archivo original, recuperado el 16 de marzo de 2009, contiene el siguiente aviso de licencia y derechos de autor:

@example
/****************************************************************
 *
 * The author of this software is David M. Gay.
 *
 * Copyright (c) 1991, 2000, 2001 by Lucent Technologies.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose without fee is hereby granted, provided that this entire notice
 * is included in all copies of any software which is or includes a copy
 * or modification of this software and in all copies of the supporting
 * documentation for such software.
 *
 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
 * WARRANTY.  IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
 * OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
 *
 ***************************************************************/
@end example

@node OpenSSL<2>,expat,strtod y dtoa,Licencias y reconocimientos para software incorporado
@anchor{license openssl}@anchor{50e1}
@subsection OpenSSL


The modules @ref{68,,hashlib}, @ref{ad,,posix} and @ref{d0,,ssl} use
the OpenSSL library for added performance if made available by the
operating system. Additionally, the Windows and macOS installers for
Python may include a copy of the OpenSSL libraries, so we include a copy
of the OpenSSL license here. For the OpenSSL 3.0 release,
and later releases derived from that, the Apache License v2 applies:

@example
                              Apache License
                        Version 2.0, January 2004
                     https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
@end example

@node expat,libffi,OpenSSL<2>,Licencias y reconocimientos para software incorporado
@anchor{license expat}@anchor{50e2}
@subsection expat


La extensión @ref{126,,pyexpat} se construye usando una copia incluida de las fuentes de expatriados a menos que la construcción esté configurada @code{--with-system-expat}:

@example
Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
                               and Clark Cooper

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node libffi,zlib<3>,expat,Licencias y reconocimientos para software incorporado
@anchor{license libffi}@anchor{50e3}
@subsection libffi


La extensión C @code{_ctypes} subyacente al módulo @ref{2b,,ctypes} se construye usando una copia incluida de las fuentes de libffi a menos que la construcción esté configurada @code{--with-system-libffi}:

@example
Copyright (c) 1996-2008  Red Hat, Inc and others.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
`@w{`}Software'@w{'}), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED `@w{`}AS IS'@w{'}, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
@end example

@node zlib<3>,cfuhash,libffi,Licencias y reconocimientos para software incorporado
@anchor{license zlib}@anchor{50e4}
@subsection zlib


La extensión @ref{132,,zlib} se crea utilizando una copia incluida de las fuentes de zlib si la versión de zlib encontrada en el sistema es demasiado antigua para ser utilizada para la compilación:

@example
Copyright (C) 1995-2011 Jean-loup Gailly and Mark Adler

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
   claim that you wrote the original software. If you use this software
   in a product, an acknowledgment in the product documentation would be
   appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.

Jean-loup Gailly        Mark Adler
jloup@@gzip.org          madler@@alumni.caltech.edu
@end example

@node cfuhash,libmpdec,zlib<3>,Licencias y reconocimientos para software incorporado
@anchor{license cfuhash}@anchor{50e5}
@subsection cfuhash


La implementación de la tabla hash utilizada por @ref{ff,,tracemalloc} se basa en el proyecto cfuhash:

@example
Copyright (c) 2005 Don Owens
All rights reserved.

This code is released under the BSD license:

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

  * Neither the name of the author nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node libmpdec,Conjunto de pruebas W3C C14N,cfuhash,Licencias y reconocimientos para software incorporado
@anchor{license libmpdec}@anchor{50e6}
@subsection libmpdec


La extension C @code{_decimal} subyacente al módulo @ref{37,,decimal} se construye usando una copia incluida de la biblioteca libmpdec a menos que la construcción esté configurada @code{--with-system-libmpdec}:

@example
Copyright (c) 2008-2020 Stefan Krah. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node Conjunto de pruebas W3C C14N,mimalloc,libmpdec,Licencias y reconocimientos para software incorporado
@anchor{license w3c-c14n-test-suite}@anchor{50e7}
@subsection Conjunto de pruebas W3C C14N


El conjunto de pruebas C14N 2.0 en el paquete @ref{e2,,test} (@code{Lib/test/xmltestdata/c14n-20/}) se recuperó del sitio web de W3C en @indicateurl{https://www.w3.org/TR/xml-c14n2-testcases/} y se distribuye bajo la licencia BSD de 3 cláusulas:

@example
Copyright (c) 2013 W3C(R) (MIT, ERCIM, Keio, Beihang),
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of works must retain the original copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the original copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
* Neither the name of the W3C nor the names of its contributors may be
  used to endorse or promote products derived from this work without
  specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node mimalloc,asyncio<12>,Conjunto de pruebas W3C C14N,Licencias y reconocimientos para software incorporado
@anchor{license mimalloc}@anchor{50e8}@anchor{license mimalloc-license}@anchor{4d1}
@subsection mimalloc


MIT License:

@example
Copyright (c) 2018-2021 Microsoft Corporation, Daan Leijen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@end example

@node asyncio<12>,Global Unbounded Sequences GUS,mimalloc,Licencias y reconocimientos para software incorporado
@anchor{license asyncio}@anchor{50e9}
@subsection asyncio


Parts of the @ref{b,,asyncio} module are incorporated from
uvloop 0.16@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0},
which is distributed under the MIT license:

@example
Copyright (c) 2015-2021 MagicStack Inc.  http://magic.io

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node Global Unbounded Sequences GUS,,asyncio<12>,Licencias y reconocimientos para software incorporado
@anchor{license global-unbounded-sequences-gus}@anchor{50ea}
@subsection Global Unbounded Sequences (GUS)


The file @code{Python/qsbr.c} is adapted from FreeBSD’s «Global Unbounded
Sequences» safe memory reclamation scheme in
subr_smr.c@footnote{https://github.com/freebsd/freebsd-src/blob/main/sys/kern/subr_smr.c}.
The file is distributed under the 2-Clause BSD License:

@example
Copyright (c) 2019,2020 Jeffrey Roberson <jeff@@FreeBSD.org>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice unmodified, this list of conditions, and the following
   disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR `@w{`}AS IS'@w{'} AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node Índice de Módulos Python,Índice,Historia y Licencia,Top
@unnumbered Índice de Módulos Python


@menu
* __future__: 0. Future statement definitions
* __main__: 1. The environment where top-level code is run. Covers
                        command-line interfaces@comma{} import-time
                        behavior@comma{} and `@w{`}__name__ ==
                        '__main__'`@w{`}.
* _thread: 2. Low-level threading API.
* _tkinter: 3. A binary module that contains the low-level interface
                        to Tcl/Tk.
* abc: 4. Abstract base classes according to :pep:`3119`.
* aifc: 5. Removed in 3.13.
* annotationlib: 6. Functionality for introspecting annotations
* argparse: 7. Command-line option and argument parsing library.
* array: 8. Space efficient arrays of uniformly typed numeric
                        values.
* ast: 9. Abstract Syntax Tree classes and manipulation.
* asynchat: a. Removed in 3.12.
* asyncio: b. Asynchronous I/O.
* asyncore: c. Removed in 3.12.
* atexit: d. Register and execute cleanup functions.
* audioop: e. Removed in 3.13.
* base64: f. RFC 4648: Base16@comma{} Base32@comma{} Base64 Data
                        Encodings; Base85 and Ascii85
* bdb: 10. Debugger framework.
* binascii: 11. Tools for converting between binary and various ASCII-
                        encoded binary representations.
* bisect: 12. Array bisection algorithms for binary searching.
* builtins: 13. The module that provides the built-in namespace.
* bz2: 14. Interfaces for bzip2 compression and decompression.
* calendar: 15. Functions for working with calendars@comma{} including
                        some emulation of the Unix cal program.
* cgi: 16. Removed in 3.13.
* cgitb: 17. Removed in 3.13.
* chunk: 18. Removed in 3.13.
* cmath: 19. Mathematical functions for complex numbers.
* cmd: 1a. Build line-oriented command interpreters.
* code: 1b. Facilities to implement read-eval-print loops.
* codecs: 1c. Encode and decode data and streams.
* codeop: 1d. Compile (possibly incomplete) Python code.
* collections: 1e. Container datatypes
* collections.abc: 1f. Abstract base classes for containers
* colorsys: 20. Conversion functions between RGB and other color
                        systems.
* compileall: 21. Tools for byte-compiling all Python source files in a
                        directory tree.
* concurrent.futures: 22. Execute computations concurrently using threads or
                        processes.
* configparser: 23. Configuration file parser.
* contextlib: 24. Utilities for with-statement contexts.
* contextvars: 25. Context Variables
* copy: 26. Shallow and deep copy operations.
* copyreg: 27. Register pickle support functions.
* cProfile: 28. 
* crypt: 29. Removed in 3.13.
* csv: 2a. Write and read tabular data to and from delimited
                        files.
* ctypes: 2b. A foreign function library for Python.
* curses: 2c. An interface to the curses library@comma{} providing
                        portable terminal handling.
* curses.ascii: 2d. Constants and set-membership functions for ASCII
                        characters.
* curses.panel: 2e. A panel stack extension that adds depth to curses
                        windows.
* curses.textpad: 2f. Emacs-like input editing in a curses window.
* dataclasses: 30. Generate special methods on user-defined classes.
* datetime: 31. Basic date and time types.
* dbm: 32. Interfaces to various Unix "database" formats.
* dbm.dumb: 33. Portable implementation of the simple DBM interface.
* dbm.gnu: 34. GNU database manager
* dbm.ndbm: 35. The New Database Manager
* dbm.sqlite3: 36. SQLite backend for dbm
* decimal: 37. Implementation of the General Decimal Arithmetic
                        Specification.
* difflib: 38. Helpers for computing differences between objects.
* dis: 39. Disassembler for Python bytecode.
* distutils: 3a. Removed in 3.12.
* doctest: 3b. Test pieces of code within docstrings.
* email: 3c. Package supporting the parsing@comma{}
                        manipulating@comma{} and generating email messages.
* email.charset: 3d. Character Sets
* email.contentmanager: 3e. Storing and Retrieving Content from MIME Parts
* email.encoders: 3f. Encoders for email message payloads.
* email.errors: 40. The exception classes used by the email package.
* email.generator: 41. Generate flat text email messages from a message
                        structure.
* email.header: 42. Representing non-ASCII headers
* email.headerregistry: 43. Automatic Parsing of headers based on the field name
* email.iterators: 44. Iterate over a message object tree.
* email.message: 45. The base class representing email messages.
* email.mime: 46. Build MIME messages.
* email.mime.application: 47. 
* email.mime.audio: 48. 
* email.mime.base: 49. 
* email.mime.image: 4a. 
* email.mime.message: 4b. 
* email.mime.multipart: 4c. 
* email.mime.nonmultipart: 4d. 
* email.mime.text: 4e. 
* email.parser: 4f. Parse flat text email messages to produce a message
                        object structure.
* email.policy: 50. Controlling the parsing and generating of messages
* email.utils: 51. Miscellaneous email package utilities.
* encodings.idna: 52. Internationalized Domain Names implementation
* encodings.mbcs: 53. Windows ANSI codepage
* encodings.utf_8_sig: 54. UTF-8 codec with BOM signature
* ensurepip: 55. Bootstrapping the "pip" installer into an existing
                        Python installation or virtual environment.
* enum: 56. Implementation of an enumeration class.
* errno: 57. Standard errno system symbols.
* faulthandler: 58. Dump the Python traceback.
* fcntl: 59. The fcntl() and ioctl() system calls.
* filecmp: 5a. Compare files efficiently.
* fileinput: 5b. Loop over standard input or a list of files.
* fnmatch: 5c. Unix shell style filename pattern matching.
* fractions: 5d. Rational numbers.
* ftplib: 5e. FTP protocol client (requires sockets).
* functools: 5f. Higher-order functions and operations on callable
                        objects.
* gc: 60. Interface to the cycle-detecting garbage collector.
* getopt: 61. Portable parser for command line options; support both
                        short and long option names.
* getpass: 62. Portable reading of passwords and retrieval of the
                        userid.
* gettext: 63. Multilingual internationalization services.
* glob: 64. Unix shell style pathname pattern expansion.
* graphlib: 65. Functionality to operate with graph-like structures
* grp: 66. The group database (getgrnam() and friends).
* gzip: 67. Interfaces for gzip compression and decompression
                        using file objects.
* hashlib: 68. Secure hash and message digest algorithms.
* heapq: 69. Heap queue algorithm (a.k.a. priority queue).
* hmac: 6a. Keyed-Hashing for Message Authentication (HMAC)
                        implementation
* html: 6b. Helpers for manipulating HTML.
* html.entities: 6c. Definitions of HTML general entities.
* html.parser: 6d. A simple parser that can handle HTML and XHTML.
* http: 6e. HTTP status codes and messages
* http.client: 6f. HTTP and HTTPS protocol client (requires sockets).
* http.cookiejar: 70. Classes for automatic handling of HTTP cookies.
* http.cookies: 71. Support for HTTP state management (cookies).
* http.server: 72. HTTP server and request handlers.
* idlelib: 73. Implementation package for the IDLE shell/editor.
* imaplib: 74. IMAP4 protocol client (requires sockets).
* imghdr: 75. Removed in 3.13.
* imp: 76. Removed in 3.12.
* importlib: 77. The implementation of the import machinery.
* importlib.abc: 78. Abstract base classes related to import
* importlib.machinery: 79. Importers and path hooks
* importlib.metadata: 7a. Accessing package metadata
* importlib.resources: 7b. Package resource reading@comma{} opening@comma{} and
                        access
* importlib.resources.abc: 7c. Abstract base classes for resources
* importlib.util: 7d. Utility code for importers
* inspect: 7e. Extract information and source code from live objects.
* io: 7f. Core tools for working with streams.
* ipaddress: 80. IPv4/IPv6 manipulation library.
* itertools: 81. Functions creating iterators for efficient looping.
* json: 82. Encode and decode the JSON format.
* json.tool: 83. A command-line interface to validate and pretty-print
                        JSON.
* keyword: 84. Test whether a string is a keyword in Python.
* linecache: 85. Provides random access to individual lines from text
                        files.
* locale: 86. Internationalization services.
* logging: 87. Flexible event logging system for applications.
* logging.config: 88. Configuration of the logging module.
* logging.handlers: 89. Handlers for the logging module.
* lzma: 8a. A Python wrapper for the liblzma compression library.
* mailbox: 8b. Manipulate mailboxes in various formats
* mailcap: 8c. Removed in 3.13.
* marshal: 8d. Convert Python objects to streams of bytes and back
                        (with different constraints).
* math: 8e. Mathematical functions (sin() etc.).
* mimetypes: 8f. Mapping of filename extensions to MIME types.
* mmap: 90. Interface to memory-mapped files for Unix and Windows.
* modulefinder: 91. Find modules used by a script.
* msilib: 92. Removed in 3.13.
* msvcrt: 93. Miscellaneous useful routines from the MS VC++
                        runtime.
* multiprocessing: 94. Process-based parallelism.
* multiprocessing.connection: 95. API for dealing with sockets.
* multiprocessing.dummy: 96. Dumb wrapper around threading.
* multiprocessing.managers: 97. Share data between process with shared objects.
* multiprocessing.pool: 98. Create pools of processes.
* multiprocessing.shared_memory: 99. Provides shared memory for direct access
                                 across processes.
* multiprocessing.sharedctypes: 9a. Allocate ctypes objects from shared memory.
* netrc: 9b. Loading of .netrc files.
* nis: 9c. Removed in 3.13.
* nntplib: 9d. Removed in 3.13.
* numbers: 9e. Numeric abstract base classes (Complex@comma{}
                        Real@comma{} Integral@comma{} etc.).
* operator: 9f. Functions corresponding to the standard operators.
* optparse: a0. Command-line option parsing library.
* os: a1. Miscellaneous operating system interfaces.
* os.path: a2. Operations on pathnames.
* ossaudiodev: a3. Removed in 3.13.
* pathlib: a4. Object-oriented filesystem paths
* pdb: a5. The Python debugger for interactive interpreters.
* pickle: a6. Convert Python objects to streams of bytes and back.
* pickletools: a7. Contains extensive comments about the pickle protocols
                        and pickle-machine opcodes@comma{} as well as some
                        useful functions.
* pipes: a8. Removed in 3.13.
* pkgutil: a9. Utilities for the import system.
* platform: aa. Retrieves as much platform identifying data as
                        possible.
* plistlib: ab. Generate and parse Apple plist files.
* poplib: ac. POP3 protocol client (requires sockets).
* posix: ad. The most common POSIX system calls (normally used via
                        module os).
* pprint: ae. Data pretty printer.
* profile: af. Python source profiler.
* pstats: b0. Statistics object for use with the profiler.
* pty: b1. Pseudo-Terminal Handling for Unix.
* pwd: b2. The password database (getpwnam() and friends).
* py_compile: b3. Generate byte-code files from Python source files.
* pyclbr: b4. Supports information extraction for a Python module
                        browser.
* pydoc: b5. Documentation generator and online help system.
* queue: b6. A synchronized queue class.
* quopri: b7. Encode and decode files using the MIME quoted-
                        printable encoding.
* random: b8. Generate pseudo-random numbers with various common
                        distributions.
* re: b9. Regular expression operations.
* readline: ba. GNU readline support for Python.
* reprlib: bb. Alternate repr() implementation with size limits.
* resource: bc. An interface to provide resource usage information on
                        the current process.
* rlcompleter: bd. Python identifier completion@comma{} suitable for the
                        GNU readline library.
* runpy: be. Locate and run Python modules without importing them
                        first.
* sched: bf. General purpose event scheduler.
* secrets: c0. Generate secure random numbers for managing secrets.
* select: c1. Wait for I/O completion on multiple streams.
* selectors: c2. High-level I/O multiplexing.
* shelve: c3. Python object persistence.
* shlex: c4. Simple lexical analysis for Unix shell-like languages.
* shutil: c5. High-level file operations@comma{} including copying.
* signal: c6. Set handlers for asynchronous events.
* site: c7. Module responsible for site-specific configuration.
* sitecustomize: c8. 
* smtpd: c9. Removed in 3.12.
* smtplib: ca. SMTP protocol client (requires sockets).
* sndhdr: cb. Removed in 3.13.
* socket: cc. Low-level networking interface.
* socketserver: cd. A framework for network servers.
* spwd: ce. Removed in 3.13.
* sqlite3: cf. A DB-API 2.0 implementation using SQLite 3.x.
* ssl: d0. TLS/SSL wrapper for socket objects
* stat: d1. Utilities for interpreting the results of
                        os.stat()@comma{} os.lstat() and os.fstat().
* statistics: d2. Mathematical statistics functions
* string: d3. Common string operations.
* stringprep: d4. String preparation@comma{} as per RFC 3453
* struct: d5. Interpret bytes as packed binary data.
* subprocess: d6. Subprocess management.
* sunau: d7. Removed in 3.13.
* symtable: d8. Interface to the compiler's internal symbol tables.
* sys: d9. Access system-specific parameters and functions.
* sys.monitoring: da. Access and control event monitoring
* sysconfig: db. Python's configuration information
* syslog: dc. An interface to the Unix syslog library routines.
* tabnanny: dd. Tool for detecting white space related problems in
                        Python source files in a directory tree.
* tarfile: de. Read and write tar-format archive files.
* telnetlib: df. Removed in 3.13.
* tempfile: e0. Generate temporary files and directories.
* termios: e1. POSIX style tty control.
* test: e2. Regression tests package containing the testing suite
                        for Python.
* test.regrtest: e3. Drives the regression test suite.
* test.support: e4. Support for Python's regression test suite.
* test.support.bytecode_helper: e5. Support tools for testing correct bytecode
                                generation.
* test.support.import_helper: e6. Support for import tests.
* test.support.os_helper: e7. Support for os tests.
* test.support.script_helper: e8. Support for Python's script execution tests.
* test.support.socket_helper: e9. Support for socket tests.
* test.support.threading_helper: ea. Support for threading tests.
* test.support.warnings_helper: eb. Support for warnings tests.
* textwrap: ec. Text wrapping and filling
* threading: ed. Thread-based parallelism.
* time: ee. Time access and conversions.
* timeit: ef. Measure the execution time of small code snippets.
* tkinter: f0. Interface to Tcl/Tk for graphical user interfaces
* tkinter.colorchooser: f1. Color choosing dialog
* tkinter.commondialog: f2. Tkinter base class for dialogs
* tkinter.dnd: f3. Tkinter drag-and-drop interface
* tkinter.filedialog: f4. Dialog classes for file selection
* tkinter.font: f5. Tkinter font-wrapping class
* tkinter.messagebox: f6. Various types of alert dialogs
* tkinter.scrolledtext: f7. Text widget with a vertical scroll bar.
* tkinter.simpledialog: f8. Simple dialog windows
* tkinter.ttk: f9. Tk themed widget set
* token: fa. Constants representing terminal nodes of the parse
                        tree.
* tokenize: fb. Lexical scanner for Python source code.
* tomllib: fc. Parse TOML files.
* trace: fd. Trace or track Python statement execution.
* traceback: fe. Print or retrieve a stack traceback.
* tracemalloc: ff. Trace memory allocations.
* tty: 100. Utility functions that perform common terminal control
                        operations.
* turtle: 101. An educational framework for simple graphics
                        applications
* turtledemo: 102. A viewer for example turtle scripts
* types: 103. Names for built-in types.
* typing: 104. Support for type hints (see :pep:`484`).
* unicodedata: 105. Access the Unicode Database.
* unittest: 106. Unit testing framework for Python.
* unittest.mock: 107. Mock object library.
* urllib: 108. 
* urllib.error: 109. Exception classes raised by urllib.request.
* urllib.parse: 10a. Parse URLs into or assemble them from components.
* urllib.request: 10b. Extensible library for opening URLs.
* urllib.response: 10c. Response classes used by urllib.
* urllib.robotparser: 10d. Load a robots.txt file and answer questions about
                        fetchability of other URLs.
* usercustomize: 10e. 
* uu: 10f. Removed in 3.13.
* uuid: 110. UUID objects (universally unique identifiers)
                        according to RFC 9562
* venv: 111. Creation of virtual environments.
* warnings: 112. Issue warning messages and control their disposition.
* wave: 113. Provide an interface to the WAV sound format.
* weakref: 114. Support for weak references and weak dictionaries.
* webbrowser: 115. Easy-to-use controller for web browsers.
* winreg: 116. Routines and objects for manipulating the Windows
                        registry.
* winsound: 117. Access to the sound-playing machinery for Windows.
* wsgiref: 118. WSGI Utilities and Reference Implementation.
* wsgiref.handlers: 119. WSGI server/gateway base classes.
* wsgiref.headers: 11a. WSGI response header tools.
* wsgiref.simple_server: 11b. A simple WSGI HTTP server.
* wsgiref.types: 11c. WSGI types for static type checking
* wsgiref.util: 11d. WSGI environment utilities.
* wsgiref.validate: 11e. WSGI conformance checker.
* xdrlib: 11f. Removed in 3.13.
* xml: 120. Package containing XML processing modules
* xml.dom: 121. Document Object Model API for Python.
* xml.dom.minidom: 122. Minimal Document Object Model (DOM) implementation.
* xml.dom.pulldom: 123. Support for building partial DOM trees from SAX
                        events.
* xml.etree.ElementInclude: 124. 
* xml.etree.ElementTree: 125. Implementation of the ElementTree API.
* xml.parsers.expat: 126. An interface to the Expat non-validating XML parser.
* xml.parsers.expat.errors: 127. 
* xml.parsers.expat.model: 128. 
* xml.sax: 129. Package containing SAX2 base classes and convenience
                        functions.
* xml.sax.handler: 12a. Base classes for SAX event handlers.
* xml.sax.saxutils: 12b. Convenience functions and classes for use with SAX.
* xml.sax.xmlreader: 12c. Interface which SAX-compliant XML parsers must
                        implement.
* xmlrpc.client: 12d. XML-RPC client access.
* xmlrpc.server: 12e. Basic XML-RPC server implementations.
* zipapp: 12f. Manage executable Python zip archives
* zipfile: 130. Read and write ZIP-format archive files.
* zipimport: 131. Support for importing Python modules from ZIP
                        archives.
* zlib: 132. Low-level interface to compression and decompression
                        routines compatible with gzip.
* zoneinfo: 133. IANA time zone support
@end menu


@node Índice,,Índice de Módulos Python,Top
@unnumbered Índice


@printindex ge

@anchor{4111}@w{                              }
@anchor{library/_thread start_new_thread}@w{                              }
@anchor{410a}@w{                              }
@anchor{4108}@w{                              }
@anchor{4107}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_1}@w{                              }
@anchor{library/time audit_event_time_sleep_0}@w{                              }
@anchor{4104}@w{                              }
@anchor{library/asyncio audit_event_cpython_run_stdin_0}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_file_0}@w{                              }
@anchor{4109}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_0}@w{                              }

@c %**end of body
@bye
